{"source":"T24_API_Documentation.html","baseUrl":"https://t24api.ohb.co.om/irf-provider-container","totals":{"categories":38,"services":758,"endpoints":11062,"byMethod":{"GET":5418,"POST":2816,"DELETE":350,"PUT":2478}},"categories":[{"name":"Holdings","serviceCount":263,"endpointCount":5755,"services":[{"key":"Holdings-us-safedeposits-service-v1.0.0","title":"US Model Bank - Safe deposit box","version":"v1.0.0","description":"API to retrieve Safe deposit box information like Ownership, rent, due amounts, caution deposit, box status, visit information, etc","endpointCount":1,"endpoints":[{"method":"GET","path":"/holdings/us/safeDeposits/{accountId}/safeDepositBoxOverview","fullPath":"/api/v1.0.0/holdings/us/safeDeposits/{accountId}/safeDepositBoxOverview","operationId":"getUsSafeDepositBoxOverview","name":"Safe Deposit Box Overview","summary":"API to retrieve Safe deposit box information like Ownership, rent, due amounts, caution deposit, box status, visit information, etc,.","tags":[],"parameters":[{"name":"accountId","in":"path","type":"string","required":true,"description":"Identifier of the account. Often referred to as the account number, yet for consistency this is always referred to as accountId. Accepts both IBAN & BBAN"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from t24 on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"The identifier of the underlying Entity/Company/Branch."}],"requestBodyExample":null,"responses":{"200":"UsSafeDepositBoxOverviewResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}}]},{"key":"holdings-CashflowDetails-api-v1.0.0","title":"Cashflow Details of IFRS Contract","version":"v1.0.0","description":"Retrieves CashflowDetails of contracts","endpointCount":1,"endpoints":[{"method":"GET","path":"/holdings/cashflows/{cashflowId}","fullPath":"/api/v1.0.0/holdings/cashflows/{cashflowId}","operationId":"getEbCashflowDetails","name":"Holds the cashflow movements for the complete lifecycle of a contract under IFRS, FASB regulations and APR(annual percentage rate) calculations. ","summary":"Retrieves CashflowDetails of contracts","tags":[],"parameters":[{"name":"cashflowId","in":"path","type":"string","required":true,"description":"Identifier of the contract's cashflow. This will be the same as the identifier of the contract. "},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"EbCashflowDetailsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}}]},{"key":"holdings-accounts-arrangements-v1.0.0","title":"Account Arrangements","version":"v1.0.0","description":"API to create and manage various types of accounts such as Current, Savings, business, Islamic, Non-resident and Minor accounts","endpointCount":7,"endpoints":[{"method":"POST","path":"/holdings/accounts/currentAccounts","fullPath":"/api/v1.0.0/holdings/accounts/currentAccounts","operationId":"createCurrentAccount","name":"Create a Current Account ","summary":"Create a Current Account","tags":[],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":""},{"name":"companyId","in":"header","type":"string","required":false,"description":"The identifier of the company, following the format CCGGGLLLL, where: CC is the country code, GGG is Company Group Code and LLLL is the Local Code. Country Code must be a valid countryCode, Company Gr"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"partyIds":[{}],"partyRoles":[{}],"agentCustomerIds":[{}],"agentArrangementIds":[{}],"agentRoles":[{}],"arrangmentId":"string","productId":"string","activityId":"string","currency":"string","productVariation":"string","pricingSelection":"string","pricingPlan":"string","rewardsArrangementId":"string","tradeDate":"string","arrangementEffectiveDate":"string"}},"responses":{"200":"createCurrentAccountResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"POST","path":"/holdings/accounts/corporateAccounts","fullPath":"/api/v1.0.0/holdings/accounts/corporateAccounts","operationId":"createCorporateAccount","name":"Create a Corporate Current Account","summary":"Create a Corporate Current Account","tags":[],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":""},{"name":"companyId","in":"header","type":"string","required":false,"description":"The identifier of the company, following the format CCGGGLLLL, where: CC is the country code, GGG is Company Group Code and LLLL is the Local Code. Country Code must be a valid countryCode, Company Gr"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"partyIds":[{}],"partyRoles":[{}],"agentCustomerIds":[{}],"agentArrangementIds":[{}],"agentRoles":[{}],"arrangmentId":"string","productId":"string","activityId":"string","currency":"string","productVariation":"string","pricingSelection":"string","pricingPlan":"string","rewardsArrangementId":"string","tradeDate":"string","arrangementEffectiveDate":"string"}},"responses":{"200":"createCorporateAccountResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"POST","path":"/holdings/accounts/mudarabaSavingAccount","fullPath":"/api/v1.0.0/holdings/accounts/mudarabaSavingAccount","operationId":"createMudarabaSavingAccount","name":"Create a Mudaraba Savings Account","summary":"Create a Mudaraba Savings Account","tags":[],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":""},{"name":"companyId","in":"header","type":"string","required":false,"description":"The identifier of the company, following the format CCGGGLLLL, where: CC is the country code, GGG is Company Group Code and LLLL is the Local Code. Country Code must be a valid countryCode, Company Gr"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"partyIds":[{}],"partyRoles":[{}],"agentCustomerIds":[{}],"agentArrangementIds":[{}],"agentRoles":[{}],"arrangmentId":"string","productId":"string","activityId":"string","currency":"string","productVariation":"string","pricingSelection":"string","pricingPlan":"string","rewardsArrangementId":"string","tradeDate":"string","arrangementEffectiveDate":"string"}},"responses":{"200":"createMudarabaSavingAccountResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"POST","path":"/holdings/accounts/savingsAccounts","fullPath":"/api/v1.0.0/holdings/accounts/savingsAccounts","operationId":"createSavingAccount","name":"Create a Savings Account","summary":"Create a Savings Account","tags":[],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":""},{"name":"companyId","in":"header","type":"string","required":false,"description":"The identifier of the company, following the format CCGGGLLLL, where: CC is the country code, GGG is Company Group Code and LLLL is the Local Code. Country Code must be a valid countryCode, Company Gr"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"partyIds":[{}],"partyRoles":[{}],"agentCustomerIds":[{}],"agentArrangementIds":[{}],"agentRoles":[{}],"arrangmentId":"string","productId":"string","activityId":"string","currency":"string","productVariation":"string","pricingSelection":"string","pricingPlan":"string","rewardsArrangementId":"string","tradeDate":"string","arrangementEffectiveDate":"string"}},"responses":{"200":"createSavingAccountResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"POST","path":"/holdings/accounts/minorAccounts","fullPath":"/api/v1.0.0/holdings/accounts/minorAccounts","operationId":"createMinorAccount","name":"Create a Minor Savings Account","summary":"Create a Minor Savings Account","tags":[],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":""},{"name":"companyId","in":"header","type":"string","required":false,"description":"The identifier of the company, following the format CCGGGLLLL, where: CC is the country code, GGG is Company Group Code and LLLL is the Local Code. Country Code must be a valid countryCode, Company Gr"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"partyIds":[{}],"partyRoles":[{}],"agentCustomerIds":[{}],"agentArrangementIds":[{}],"agentRoles":[{}],"arrangmentId":"string","productId":"string","activityId":"string","currency":"string","productVariation":"string","pricingSelection":"string","pricingPlan":"string","rewardsArrangementId":"string","tradeDate":"string","arrangementEffectiveDate":"string"}},"responses":{"200":"createMinorAccountResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"POST","path":"/holdings/accounts/nonResidentAccounts","fullPath":"/api/v1.0.0/holdings/accounts/nonResidentAccounts","operationId":"createNonResidentAccount","name":"Creates a Non Resident Savings Account","summary":"Creates a Non Resident Savings Account","tags":[],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":""},{"name":"companyId","in":"header","type":"string","required":false,"description":"The identifier of the company, following the format CCGGGLLLL, where: CC is the country code, GGG is Company Group Code and LLLL is the Local Code. Country Code must be a valid countryCode, Company Gr"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"partyIds":[{}],"partyRoles":[{}],"agentCustomerIds":[{}],"agentArrangementIds":[{}],"agentRoles":[{}],"arrangmentId":"string","productId":"string","activityId":"string","currency":"string","productVariation":"string","pricingSelection":"string","pricingPlan":"string","rewardsArrangementId":"string","tradeDate":"string","arrangementEffectiveDate":"string"}},"responses":{"200":"createNonResidentAccountResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"DELETE","path":"/holdings/accounts/{activityId}/reverseAccounts","fullPath":"/api/v1.0.0/holdings/accounts/{activityId}/reverseAccounts","operationId":"reverseAccounts","name":"Reverse or Delete a Current Account","summary":"Reverse or Delete a Current Account","tags":[],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":""},{"name":"companyId","in":"header","type":"string","required":false,"description":"The identifier of the company, following the format CCGGGLLLL, where: CC is the country code, GGG is Company Group Code and LLLL is the Local Code. Country Code must be a valid countryCode, Company Gr"},{"name":"activityId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":null,"responses":{"200":"reverseAccountsResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}}]},{"key":"holdings-accounts-arrangements-v2.0.0","title":"Account Arrangements","version":"v2.0.0","description":"The Arrangement Architecture is a Temenos Transact Framework to create and manage  various products such as Loans, Deposits, Accounts, etc. It provides a modular business component-based architecture, whereby users can create their Products by using the components provided by Temenos and these compo","endpointCount":11,"endpoints":[{"method":"POST","path":"/holdings/accounts/currentAccounts","fullPath":"/api/v2.0.0/holdings/accounts/currentAccounts","operationId":"createCurrentAccounts","name":"This can be used to create a current account and the payload should include customer identifier, customer role,  account currency, etc.","summary":"Create a Current Account","tags":[],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"parties":[{}],"activityId":"string","effectiveDate":"string","productId":"string","currencyId":"string","simulationId":"string","balance":{"alternateIds":{},"accountType":{},"accountName":{},"accountId":{},"portfolioId":{},"anniversary":{},"customerReference":{}}}},"responses":{"200":"createCurrentAccountsResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"POST","path":"/holdings/accounts/corporateAccounts","fullPath":"/api/v2.0.0/holdings/accounts/corporateAccounts","operationId":"createCorporateAccount","name":"This can be used to create a corporate current account and the payload should include customer identifier, customer role,  account currency, etc.  The customer should be a valid corporate customer.","summary":"Create a Corporate Current Account","tags":[],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"partyIds":[{}],"partyRoles":[{}],"agentCustomerIds":[{}],"agentArrangementIds":[{}],"agentRoles":[{}],"arrangmentId":"string","productId":"string","activityId":"string","currency":"string","productVariation":"string","pricingSelection":"string","pricingPlan":"string","rewardsArrangementId":"string","tradeDate":"string","arrangementEffectiveDate":"string"}},"responses":{"200":"createCorporateAccountResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"POST","path":"/holdings/accounts/mudarabaSavingAccount","fullPath":"/api/v2.0.0/holdings/accounts/mudarabaSavingAccount","operationId":"createMudarabaSavingAccount","name":"This can be used to create a mudarba savings account and the payload should include customer identifier, customer role,  account currency, etc.","summary":"Create a Mudaraba Savings Account","tags":[],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"partyIds":[{}],"partyRoles":[{}],"agentCustomerIds":[{}],"agentArrangementIds":[{}],"agentRoles":[{}],"arrangmentId":"string","productId":"string","activityId":"string","currency":"string","productVariation":"string","pricingSelection":"string","pricingPlan":"string","rewardsArrangementId":"string","tradeDate":"string","arrangementEffectiveDate":"string"}},"responses":{"200":"createMudarabaSavingAccountResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"POST","path":"/holdings/accounts/savingsAccounts","fullPath":"/api/v2.0.0/holdings/accounts/savingsAccounts","operationId":"createSavingAccount","name":"This can be used to create a  savings account and the payload should include customer identifier, customer role,  account currency, etc.","summary":"Create a Savings Account","tags":[],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"partyIds":[{}],"partyRoles":[{}],"agentCustomerIds":[{}],"agentArrangementIds":[{}],"agentRoles":[{}],"arrangmentId":"string","productId":"string","activityId":"string","currency":"string","productVariation":"string","pricingSelection":"string","pricingPlan":"string","rewardsArrangementId":"string","tradeDate":"string","arrangementEffectiveDate":"string"}},"responses":{"200":"createSavingAccountResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"POST","path":"/holdings/accounts/minorAccounts","fullPath":"/api/v2.0.0/holdings/accounts/minorAccounts","operationId":"createMinorAccount","name":"This can be used to create a minor savings account (age below 18 years) and the payload should include customer identifier, customer role,  account currency, etc.","summary":"Create a Minor Savings Account","tags":[],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"partyIds":[{}],"partyRoles":[{}],"agentCustomerIds":[{}],"agentArrangementIds":[{}],"agentRoles":[{}],"arrangmentId":"string","productId":"string","activityId":"string","currency":"string","productVariation":"string","pricingSelection":"string","pricingPlan":"string","rewardsArrangementId":"string","tradeDate":"string","arrangementEffectiveDate":"string"}},"responses":{"200":"createMinorAccountResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"POST","path":"/holdings/accounts/nonResidentAccounts","fullPath":"/api/v2.0.0/holdings/accounts/nonResidentAccounts","operationId":"createNonResidentAccount","name":"This can be used to create a non-resident savings account and the payload should include customer identifier, customer role,  account currency, etc.","summary":"Creates a Non Resident Savings Account","tags":[],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"partyIds":[{}],"partyRoles":[{}],"agentCustomerIds":[{}],"agentArrangementIds":[{}],"agentRoles":[{}],"arrangmentId":"string","productId":"string","activityId":"string","currency":"string","productVariation":"string","pricingSelection":"string","pricingPlan":"string","rewardsArrangementId":"string","tradeDate":"string","arrangementEffectiveDate":"string"}},"responses":{"200":"createNonResidentAccountResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"DELETE","path":"/holdings/accounts/{activityId}/reverseAccounts","fullPath":"/api/v2.0.0/holdings/accounts/{activityId}/reverseAccounts","operationId":"reverseAccounts","name":"Reverse or Delete a Current Account-This API is deprecated and going forward the following URL has to be used.URL:/holdings/arrangementActivityId/{activityId}","summary":"Reverse or Delete a Current Account","tags":[],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"activityId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":null,"responses":{"200":"reverseAccountsResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"GET","path":"/holdings/accounts/{arrangementId}/accountDetails","fullPath":"/api/v2.0.0/holdings/accounts/{arrangementId}/accountDetails","operationId":"getArrangementDetails","name":"Retrieves the Details of an Account-This API is deprecated and going forward the following URL has to be used.URL:/holdings/arrangements/{arrangementId}","summary":"Retrieves the Details of an Account","tags":[],"parameters":[{"name":"arrangementId","in":"path","type":"string","required":true,"description":"Indicates an unique identifier of an account"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"ArrangementDetailsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/accounts/{accountId}/statements/dates","fullPath":"/api/v2.0.0/holdings/accounts/{accountId}/statements/dates","operationId":"getPastStatements","name":"Retrieves the previously generated statement Details for the given account such as statement date, frequency, detailed statement and lead or participant account","summary":"Retrieves the previously generated statement details for the given account","tags":["RETAIL"],"parameters":[{"name":"accountId","in":"path","type":"string","required":true,"description":"Identifier of the account. Often referred to as the account number, yet for consistency this is always referred to as accountId. Accepts both IBAN & BBAN"},{"name":"customer","in":"query","type":"string","required":false,"description":"Contains the customer identifier to fetch list of consent arrangements for the customer or customer identifier of the debtor account. This will be populated once the SCA(Strong Customer Authentication"},{"name":"carrierAddressId","in":"query","type":"string","required":false,"description":"Specifies the Carrier by which the message was received"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"PastStatementsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/accounts/{accountId}/statements/forwardEntries","fullPath":"/api/v2.0.0/holdings/accounts/{accountId}/statements/forwardEntries","operationId":"getForwardEntries","name":"Retrieves the details of future transaction entries such as statement reference, value date, booking date, transaction reference, transaction code and amount","summary":"Retrieves the details of future transaction entries","tags":["RETAIL"],"parameters":[{"name":"accountId","in":"path","type":"string","required":true,"description":"Identifier of the account. Often referred to as the account number, yet for consistency this is always referred to as accountId. Accepts both IBAN & BBAN"},{"name":"valueDate","in":"query","type":"string","required":false,"description":"Indicates the value date on which the underlying accounting entry is to be given value (for interest purposes)"},{"name":"longPositionSign","in":"query","type":"string","required":false,"description":"Polarity (sign) used to denote buy position balance.  "},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"ForwardEntriesResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/accounts/{accountId}/statements","fullPath":"/api/v2.0.0/holdings/accounts/{accountId}/statements","operationId":"getAccountStatement","name":"Retrieves the statement details of the transactions for the given account such as booking date, value date, transaction reference, transaction code, debit or credit amount, closing balance based on the given dates(from date and to date).If dates are not given, retrieves the last 1M transactions.If from date alone is given, retrieves the transactions from given date to today.If end date alone is given, retrieves the last 1M transactions prior to the given end date.If period is given, retrieves th","summary":"Retrieves the statement details for the given account","tags":["RETAIL"],"parameters":[{"name":"accountId","in":"path","type":"string","required":true,"description":"Identifier of the account. Often referred to as the account number, yet for consistency this is always referred to as accountId. Accepts both IBAN & BBAN"},{"name":"fromDate","in":"query","type":"string","required":false,"description":"Indicates the business date from when the balance reservation event is active."},{"name":"toDate","in":"query","type":"string","required":false,"description":"Indicates the business date until when the balance reservation event is active."},{"name":"transactionReference","in":"query","type":"string","required":false,"description":"Contains the identifier for the transaction in the core system"},{"name":"period","in":"query","type":"string","required":false,"description":"Indicates spread of time buckets.Ex: 3M,6M,9M,10Y etc."},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"AccountStatementResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}}]},{"key":"holdings-accounts-arrangements-v2.1.0","title":"Account Arrangements","version":"v2.1.0","description":"The Arrangement Architecture is a Temenos Transact Framework to create and manage  various products such as Loans, Deposits, Accounts, etc. It provides a modular business component-based architecture, whereby users can create their Products by using the components provided by Temenos and these compo","endpointCount":17,"endpoints":[{"method":"POST","path":"/holdings/accounts/currentAccounts","fullPath":"/api/v2.1.0/holdings/accounts/currentAccounts","operationId":"createCurrentAccounts","name":"This can be used to create a current account and the payload should include customer identifier, customer role,  account currency, etc.","summary":"Create a Current Account","tags":[],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"parties":[{}],"activityId":"string","effectiveDate":"string","productId":"string","currencyId":"string","simulationId":"string","balance":[{}]}},"responses":{"200":"createCurrentAccountsResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"POST","path":"/holdings/accounts/corporateAccounts","fullPath":"/api/v2.1.0/holdings/accounts/corporateAccounts","operationId":"createCorporateAccount","name":"This can be used to create a corporate current account and the payload should include customer identifier, customer role,  account currency, etc.  The customer should be a valid corporate customer.","summary":"Create a Corporate Current Account","tags":[],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"partyIds":[{}],"partyRoles":[{}],"agentCustomerIds":[{}],"agentArrangementIds":[{}],"agentRoles":[{}],"arrangmentId":"string","productId":"string","activityId":"string","currency":"string","productVariation":"string","pricingSelection":"string","pricingPlan":"string","rewardsArrangementId":"string","tradeDate":"string","arrangementEffectiveDate":"string"}},"responses":{"200":"createCorporateAccountResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"POST","path":"/holdings/accounts/mudarabaSavingAccount","fullPath":"/api/v2.1.0/holdings/accounts/mudarabaSavingAccount","operationId":"createMudarabaSavingAccount","name":"This can be used to create a mudarba savings account and the payload should include customer identifier, customer role,  account currency, etc.","summary":"Create a Mudaraba Savings Account","tags":[],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"partyIds":[{}],"partyRoles":[{}],"agentCustomerIds":[{}],"agentArrangementIds":[{}],"agentRoles":[{}],"arrangmentId":"string","productId":"string","activityId":"string","currency":"string","productVariation":"string","pricingSelection":"string","pricingPlan":"string","rewardsArrangementId":"string","tradeDate":"string","arrangementEffectiveDate":"string"}},"responses":{"200":"createMudarabaSavingAccountResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"POST","path":"/holdings/accounts/savingsAccounts","fullPath":"/api/v2.1.0/holdings/accounts/savingsAccounts","operationId":"createSavingAccount","name":"This can be used to create a  savings account and the payload should include customer identifier, customer role,  account currency, etc.","summary":"Create a Savings Account","tags":[],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"partyIds":[{}],"partyRoles":[{}],"agentCustomerIds":[{}],"agentArrangementIds":[{}],"agentRoles":[{}],"arrangmentId":"string","productId":"string","activityId":"string","currency":"string","productVariation":"string","pricingSelection":"string","pricingPlan":"string","rewardsArrangementId":"string","tradeDate":"string","arrangementEffectiveDate":"string"}},"responses":{"200":"createSavingAccountResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"POST","path":"/holdings/accounts/minorAccounts","fullPath":"/api/v2.1.0/holdings/accounts/minorAccounts","operationId":"createMinorAccount","name":"This can be used to create a minor savings account (age below 18 years) and the payload should include customer identifier, customer role,  account currency, etc.","summary":"Create a Minor Savings Account","tags":[],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"partyIds":[{}],"partyRoles":[{}],"agentCustomerIds":[{}],"agentArrangementIds":[{}],"agentRoles":[{}],"arrangmentId":"string","productId":"string","activityId":"string","currency":"string","productVariation":"string","pricingSelection":"string","pricingPlan":"string","rewardsArrangementId":"string","tradeDate":"string","arrangementEffectiveDate":"string"}},"responses":{"200":"createMinorAccountResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"POST","path":"/holdings/accounts/nonResidentAccounts","fullPath":"/api/v2.1.0/holdings/accounts/nonResidentAccounts","operationId":"createNonResidentAccount","name":"This can be used to create a non-resident savings account and the payload should include customer identifier, customer role,  account currency, etc.","summary":"Creates a Non Resident Savings Account","tags":[],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"partyIds":[{}],"partyRoles":[{}],"agentCustomerIds":[{}],"agentArrangementIds":[{}],"agentRoles":[{}],"arrangmentId":"string","productId":"string","activityId":"string","currency":"string","productVariation":"string","pricingSelection":"string","pricingPlan":"string","rewardsArrangementId":"string","tradeDate":"string","arrangementEffectiveDate":"string"}},"responses":{"200":"createNonResidentAccountResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"DELETE","path":"/holdings/accounts/{activityId}/reverseAccounts","fullPath":"/api/v2.1.0/holdings/accounts/{activityId}/reverseAccounts","operationId":"reverseAccounts","name":"Reverse or Delete a Current Account-This API is deprecated and going forward the following URL has to be used.URL:/holdings/arrangementActivityId/{activityId}","summary":"Reverse or Delete a Current Account","tags":[],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"activityId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":null,"responses":{"200":"reverseAccountsResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"GET","path":"/holdings/accounts/{arrangementId}/accountDetails","fullPath":"/api/v2.1.0/holdings/accounts/{arrangementId}/accountDetails","operationId":"getArrangementDetails","name":"Retrieves the Details of an Account-This API is deprecated and going forward the following URL has to be used.URL:/holdings/arrangements/{arrangementId}","summary":"Retrieves the Details of an Account","tags":[],"parameters":[{"name":"arrangementId","in":"path","type":"string","required":true,"description":"Indicates an unique identifier of an account"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"ArrangementDetailsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/accounts/{accountId}/statements/dates","fullPath":"/api/v2.1.0/holdings/accounts/{accountId}/statements/dates","operationId":"getPastStatements","name":"Retrieves the previously generated statement Details for the given account such as statement date, frequency, detailed statement and lead or participant account","summary":"Retrieves the previously generated statement details for the given account","tags":["RETAIL"],"parameters":[{"name":"accountId","in":"path","type":"string","required":true,"description":"Identifier of the account. Often referred to as the account number, yet for consistency this is always referred to as accountId. Accepts both IBAN & BBAN"},{"name":"customer","in":"query","type":"string","required":false,"description":"Contains the customer identifier to fetch list of consent arrangements for the customer or customer identifier of the debtor account. This will be populated once the SCA(Strong Customer Authentication"},{"name":"carrierAddressId","in":"query","type":"string","required":false,"description":"Specifies the Carrier by which the message was received"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"PastStatementsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/accounts/{accountId}/statements/forwardEntries","fullPath":"/api/v2.1.0/holdings/accounts/{accountId}/statements/forwardEntries","operationId":"getForwardEntries","name":"Retrieves the details of future transaction entries such as statement reference, value date, booking date, transaction reference, transaction code and amount","summary":"Retrieves the details of future transaction entries","tags":["RETAIL"],"parameters":[{"name":"accountId","in":"path","type":"string","required":true,"description":"Identifier of the account. Often referred to as the account number, yet for consistency this is always referred to as accountId. Accepts both IBAN & BBAN"},{"name":"valueDate","in":"query","type":"string","required":false,"description":"Indicates the value date on which the underlying accounting entry is to be given value (for interest purposes)"},{"name":"longPositionSign","in":"query","type":"string","required":false,"description":"Polarity (sign) used to denote buy position balance.  "},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"ForwardEntriesResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/accounts/{accountId}/statements","fullPath":"/api/v2.1.0/holdings/accounts/{accountId}/statements","operationId":"getAccountStatement","name":"Retrieves the statement details of the transactions for the given account such as booking date, value date, transaction reference, transaction code, debit or credit amount, closing balance based on the given dates(from date and to date).If dates are not given, retrieves the last 1M transactions.If from date alone is given, retrieves the transactions from given date to today.If end date alone is given, retrieves the last 1M transactions prior to the given end date.If period is given, retrieves th","summary":"Retrieves the statement details for the given account","tags":["RETAIL"],"parameters":[{"name":"accountId","in":"path","type":"string","required":true,"description":"Identifier of the account. Often referred to as the account number, yet for consistency this is always referred to as accountId. Accepts both IBAN & BBAN"},{"name":"fromDate","in":"query","type":"string","required":false,"description":"Indicates the business date from when the balance reservation event is active."},{"name":"toDate","in":"query","type":"string","required":false,"description":"Indicates the business date until when the balance reservation event is active."},{"name":"transactionReference","in":"query","type":"string","required":false,"description":"Contains the identifier for the transaction in the core system"},{"name":"period","in":"query","type":"string","required":false,"description":"Indicates spread of time buckets.Ex: 3M,6M,9M,10Y etc."},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"AccountStatementResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"PUT","path":"/holdings/accounts/savingsAccounts/{savingsAccountId}/payoffCalculations","fullPath":"/api/v2.1.0/holdings/accounts/savingsAccounts/{savingsAccountId}/payoffCalculations","operationId":"calculatePayoffSavingsAccounts","name":"Calculate the payoff amount for the savings account which includes the outstanding amounts and also amounts such as account balances, interest, and charge amounts","summary":"Calculate the outstanding amount to close the savings account","tags":[],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"savingsAccountId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"closureNotes":[{}],"activityId":"string","automaticRun":"string","simulationRunReference":"string","effectiveDate":"2024-01-01","currencyId":"string","transactionAmount":0.0,"closureReason":"string","settlement":[{}],"payoff":[{}]}},"responses":{"200":"calculatePayoffSavingsAccountsResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"PUT","path":"/holdings/accounts/savingsAccounts/{savingsAccountId}/payoffs","fullPath":"/api/v2.1.0/holdings/accounts/savingsAccounts/{savingsAccountId}/payoffs","operationId":"settlePayoffSavingsAccounts","name":"Perform the settlement of payoff amount for the savings account by providing the transaction amount, currency and also settlement instructions","summary":"Perform the settlement of payoff amount for the savings account","tags":[],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"savingsAccountId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"currencyId":"string","effectiveDate":"2024-01-01","activityId":"string","transactionAmount":0.0,"contractId":"string","systemId":"string","externalEventStatus":"string","settlement":[{}]}},"responses":{"200":"settlePayoffSavingsAccountsResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"PUT","path":"/holdings/accounts/currentAccounts/{currentAccountId}/payoffCalculations","fullPath":"/api/v2.1.0/holdings/accounts/currentAccounts/{currentAccountId}/payoffCalculations","operationId":"calculatePayoffCurrentAccounts","name":"Calcualte the payoff amount for the current account which includes the outstanding amounts and also amounts such as account balances, interest, and charge amounts","summary":"Calculate the outstanding amount to close the current account","tags":[],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"currentAccountId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"closureNotes":[{}],"activityId":"string","automaticRun":"string","simulationRunReference":"string","effectiveDate":"2024-01-01","currencyId":"string","transactionAmount":0.0,"closureReason":"string","settlement":[{}],"payoff":[{}]}},"responses":{"200":"calculatePayoffCurrentAccountsResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"PUT","path":"/holdings/accounts/currentAccounts/{currentAccountId}/payoffs","fullPath":"/api/v2.1.0/holdings/accounts/currentAccounts/{currentAccountId}/payoffs","operationId":"settlePayoffCurrentAccounts","name":"Perform the settlement of payoff amount for the current account by providing the transaction amount, currency and also settlement instructions","summary":"Perform the settlement of payoff amount for the current account","tags":[],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"currentAccountId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"currencyId":"string","effectiveDate":"2024-01-01","activityId":"string","transactionAmount":0.0,"contractId":"string","systemId":"string","externalEventStatus":"string","settlement":[{}]}},"responses":{"200":"settlePayoffCurrentAccountsResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"PUT","path":"/holdings/accounts/currentAccounts/{currentAccountId}/accountClosures","fullPath":"/api/v2.1.0/holdings/accounts/currentAccounts/{currentAccountId}/accountClosures","operationId":"closeCurrentAccounts","name":"Perform the closure of the current account after settlement of payoff amount. The account moves to closed status based on the closure conditions defined in the system","summary":"Perform the closure of the current account after settlement of payoff amount","tags":[],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"currentAccountId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"currencyId":"string","effectiveDate":"2024-01-01","activityId":"string","transactionAmount":0.0,"contractId":"string","systemId":"string","externalEventStatus":"string"}},"responses":{"200":"closeCurrentAccountsResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"PUT","path":"/holdings/accounts/savingsAccounts/{savingsAccountId}/accountClosures","fullPath":"/api/v2.1.0/holdings/accounts/savingsAccounts/{savingsAccountId}/accountClosures","operationId":"closeSavingsAccounts","name":"Perform the closure of the savings account after settlement of payoff amount. The account moves to closed status based on the closure conditions defined in the system","summary":"Perform the closure of the savings account after settlement of payoff amount","tags":[],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"savingsAccountId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"currencyId":"string","effectiveDate":"2024-01-01","activityId":"string","transactionAmount":0.0,"contractId":"string","systemId":"string","externalEventStatus":"string"}},"responses":{"200":"closeSavingsAccountsResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}}]},{"key":"holdings-accounts-arrangements-v3.0.0","title":"Account Arrangements","version":"v3.0.0","description":"The Arrangement Architecture is a Temenos Transact Framework to create and manage  various products such as Loans, Deposits, Accounts, etc. It provides a modular business component-based architecture, whereby users can create their Products by using the components provided by Temenos and these compo","endpointCount":19,"endpoints":[{"method":"POST","path":"/holdings/accounts/currentAccounts","fullPath":"/api/v3.0.0/holdings/accounts/currentAccounts","operationId":"createCurrentAccounts","name":"This can be used to create a current account and the payload should include customer identifier, customer role,  account currency, etc.","summary":"Create a current account","tags":[],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"parties":[{}],"activityId":"string","effectiveDate":"string","productId":"string","currencyId":"string","simulationId":"string","balance":[{}]}},"responses":{"200":"createCurrentAccountsResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"POST","path":"/holdings/accounts/corporateAccounts","fullPath":"/api/v3.0.0/holdings/accounts/corporateAccounts","operationId":"createCorporateAccount","name":"This can be used to create a corporate current account and the payload should include customer identifier, customer role,  account currency, etc.  The customer should be a valid corporate customer.","summary":"Create a corporate current account","tags":[],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"partyIds":[{}],"partyRoles":[{}],"agentCustomerIds":[{}],"agentArrangementIds":[{}],"agentRoles":[{}],"arrangmentId":"string","productId":"string","activityId":"string","currency":"string","productVariation":"string","pricingSelection":"string","pricingPlan":"string","rewardsArrangementId":"string","tradeDate":"string","arrangementEffectiveDate":"string"}},"responses":{"200":"createCorporateAccountResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"POST","path":"/holdings/accounts/mudarabaSavingAccount","fullPath":"/api/v3.0.0/holdings/accounts/mudarabaSavingAccount","operationId":"createMudarabaSavingAccount","name":"This can be used to create a mudarba savings account and the payload should include customer identifier, customer role,  account currency, etc.","summary":"Create a mudaraba savings account","tags":[],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"partyIds":[{}],"partyRoles":[{}],"agentCustomerIds":[{}],"agentArrangementIds":[{}],"agentRoles":[{}],"arrangmentId":"string","productId":"string","activityId":"string","currency":"string","productVariation":"string","pricingSelection":"string","pricingPlan":"string","rewardsArrangementId":"string","tradeDate":"string","arrangementEffectiveDate":"string"}},"responses":{"200":"createMudarabaSavingAccountResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"POST","path":"/holdings/accounts/savingsAccounts","fullPath":"/api/v3.0.0/holdings/accounts/savingsAccounts","operationId":"createSavingAccount","name":"This can be used to create a  savings account and the payload should include customer identifier, customer role,  account currency, etc.","summary":"Create a savings account","tags":[],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"partyIds":[{}],"partyRoles":[{}],"agentCustomerIds":[{}],"agentArrangementIds":[{}],"agentRoles":[{}],"arrangmentId":"string","productId":"string","activityId":"string","currency":"string","productVariation":"string","pricingSelection":"string","pricingPlan":"string","rewardsArrangementId":"string","tradeDate":"string","arrangementEffectiveDate":"string"}},"responses":{"200":"createSavingAccountResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"POST","path":"/holdings/accounts/minorAccounts","fullPath":"/api/v3.0.0/holdings/accounts/minorAccounts","operationId":"createMinorAccount","name":"This can be used to create a minor savings account (age below 18 years) and the payload should include customer identifier, customer role,  account currency, etc.","summary":"Create a minor savings account","tags":[],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"partyIds":[{}],"partyRoles":[{}],"agentCustomerIds":[{}],"agentArrangementIds":[{}],"agentRoles":[{}],"arrangmentId":"string","productId":"string","activityId":"string","currency":"string","productVariation":"string","pricingSelection":"string","pricingPlan":"string","rewardsArrangementId":"string","tradeDate":"string","arrangementEffectiveDate":"string"}},"responses":{"200":"createMinorAccountResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"POST","path":"/holdings/accounts/nonResidentAccounts","fullPath":"/api/v3.0.0/holdings/accounts/nonResidentAccounts","operationId":"createNonResidentAccount","name":"This can be used to create a non-resident savings account and the payload should include customer identifier, customer role,  account currency, etc.","summary":"Creates a non resident savings account","tags":[],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"partyIds":[{}],"partyRoles":[{}],"agentCustomerIds":[{}],"agentArrangementIds":[{}],"agentRoles":[{}],"arrangmentId":"string","productId":"string","activityId":"string","currency":"string","productVariation":"string","pricingSelection":"string","pricingPlan":"string","rewardsArrangementId":"string","tradeDate":"string","arrangementEffectiveDate":"string"}},"responses":{"200":"createNonResidentAccountResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"DELETE","path":"/holdings/accounts/{activityId}/reverseAccounts","fullPath":"/api/v3.0.0/holdings/accounts/{activityId}/reverseAccounts","operationId":"reverseAccounts","name":"Reverse or Delete a Current Account-This API is deprecated and going forward the following URL has to be used.URL:/holdings/arrangementActivityId/{activityId}","summary":"Reverse or Delete a Current Account","tags":[],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"activityId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":null,"responses":{"200":"reverseAccountsResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"GET","path":"/holdings/accounts/{arrangementId}/accountDetails","fullPath":"/api/v3.0.0/holdings/accounts/{arrangementId}/accountDetails","operationId":"getArrangementDetails","name":"Retrieves the Details of an Account-This API is deprecated and going forward the following URL has to be used.URL:/holdings/arrangements/{arrangementId}","summary":"Retrieves the Details of an Account","tags":[],"parameters":[{"name":"arrangementId","in":"path","type":"string","required":true,"description":"Indicates an unique identifier of an account"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"ArrangementDetailsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/accounts/{accountId}/statements/dates","fullPath":"/api/v3.0.0/holdings/accounts/{accountId}/statements/dates","operationId":"getPastStatements","name":"Retrieves the previously generated statement details for the given account such as statement date, frequency, detailed statement and lead or participant account","summary":"Retrieves the previously generated statement details for the given account","tags":["RETAIL"],"parameters":[{"name":"accountId","in":"path","type":"string","required":true,"description":"Identifier of the account. Often referred to as the account number, yet for consistency this is always referred to as accountId. Accepts both IBAN & BBAN"},{"name":"customer","in":"query","type":"string","required":false,"description":"Contains the customer identifier to fetch list of consent arrangements for the customer or customer identifier of the debtor account. This will be populated once the SCA(Strong Customer Authentication"},{"name":"carrierAddressId","in":"query","type":"string","required":false,"description":"Specifies the Carrier by which the message was received"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"PastStatementsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/accounts/{accountId}/statements/forwardEntries","fullPath":"/api/v3.0.0/holdings/accounts/{accountId}/statements/forwardEntries","operationId":"getForwardEntries","name":"Retrieves the details of future transaction entries such as statement reference, value date, booking date, transaction reference, transaction code and amount","summary":"Retrieves the details of future transaction entries","tags":["RETAIL"],"parameters":[{"name":"accountId","in":"path","type":"string","required":true,"description":"Identifier of the account. Often referred to as the account number, yet for consistency this is always referred to as accountId. Accepts both IBAN & BBAN"},{"name":"valueDate","in":"query","type":"string","required":false,"description":"Indicates the value date on which the underlying accounting entry is to be given value (for interest purposes)"},{"name":"longPositionSign","in":"query","type":"string","required":false,"description":"Polarity (sign) used to denote buy position balance.  "},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"ForwardEntriesResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/accounts/{accountId}/statements","fullPath":"/api/v3.0.0/holdings/accounts/{accountId}/statements","operationId":"getAccountStatement","name":"Retrieves the statement details of the transactions for the given account such as booking date, value date, transaction reference, transaction code, debit or credit amount, closing balance based on the given dates(from date and to date).If dates are not given, retrieves the last 1M transactions.If from date alone is given, retrieves the transactions from given date to today.If end date alone is given, retrieves the last 1M transactions prior to the given end date.If period is given, retrieves th","summary":"Retrieves the statement details for the given account","tags":["RETAIL"],"parameters":[{"name":"accountId","in":"path","type":"string","required":true,"description":"Identifier of the account. Often referred to as the account number, yet for consistency this is always referred to as accountId. Accepts both IBAN & BBAN"},{"name":"fromDate","in":"query","type":"string","required":false,"description":"Indicates the business date from when the balance reservation event is active."},{"name":"toDate","in":"query","type":"string","required":false,"description":"Indicates the business date until when the balance reservation event is active."},{"name":"transactionReference","in":"query","type":"string","required":false,"description":"Contains the identifier for the transaction in the core system"},{"name":"period","in":"query","type":"string","required":false,"description":"Indicates spread of time buckets.Ex: 3M,6M,9M,10Y etc."},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"AccountStatementResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"PUT","path":"/holdings/accounts/savingsAccounts/{savingsAccountId}/payoffCalculations","fullPath":"/api/v3.0.0/holdings/accounts/savingsAccounts/{savingsAccountId}/payoffCalculations","operationId":"calculatePayoffSavingsAccounts","name":"Calculate the payoff amount for the savings account which includes the outstanding amounts and also amounts such as account balances, interest, and charge amounts","summary":"Calculate the outstanding amount to close the savings account","tags":[],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"savingsAccountId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"closureNotes":[{}],"activityId":"string","automaticRun":"string","simulationRunReference":"string","effectiveDate":"2024-01-01","currencyId":"string","transactionAmount":0.0,"closureReason":"string","settlement":[{}],"payoff":[{}]}},"responses":{"200":"calculatePayoffSavingsAccountsResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"PUT","path":"/holdings/accounts/savingsAccounts/{savingsAccountId}/payoffs","fullPath":"/api/v3.0.0/holdings/accounts/savingsAccounts/{savingsAccountId}/payoffs","operationId":"settlePayoffSavingsAccounts","name":"Perform the settlement of payoff amount for the savings account by providing the transaction amount, currency and also settlement instructions","summary":"Perform the settlement of payoff amount for the savings account","tags":[],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"savingsAccountId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"currencyId":"string","effectiveDate":"2024-01-01","activityId":"string","transactionAmount":0.0,"contractId":"string","systemId":"string","externalEventStatus":"string","settlement":[{}]}},"responses":{"200":"settlePayoffSavingsAccountsResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"PUT","path":"/holdings/accounts/currentAccounts/{currentAccountId}/payoffCalculations","fullPath":"/api/v3.0.0/holdings/accounts/currentAccounts/{currentAccountId}/payoffCalculations","operationId":"calculatePayoffCurrentAccounts","name":"Calcualte the payoff amount for the current account which includes the outstanding amounts and also amounts such as account balances, interest, and charge amounts","summary":"Calculate the outstanding amount to close the current account","tags":[],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"currentAccountId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"closureNotes":[{}],"activityId":"string","automaticRun":"string","simulationRunReference":"string","effectiveDate":"2024-01-01","currencyId":"string","transactionAmount":0.0,"closureReason":"string","settlement":[{}],"payoff":[{}]}},"responses":{"200":"calculatePayoffCurrentAccountsResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"PUT","path":"/holdings/accounts/currentAccounts/{currentAccountId}/payoffs","fullPath":"/api/v3.0.0/holdings/accounts/currentAccounts/{currentAccountId}/payoffs","operationId":"settlePayoffCurrentAccounts","name":"Perform the settlement of payoff amount for the current account by providing the transaction amount, currency and also settlement instructions","summary":"Perform the settlement of payoff amount for the current account","tags":[],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"currentAccountId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"currencyId":"string","effectiveDate":"2024-01-01","activityId":"string","transactionAmount":0.0,"contractId":"string","systemId":"string","externalEventStatus":"string","settlement":[{}]}},"responses":{"200":"settlePayoffCurrentAccountsResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"PUT","path":"/holdings/accounts/currentAccounts/{currentAccountId}/accountClosures","fullPath":"/api/v3.0.0/holdings/accounts/currentAccounts/{currentAccountId}/accountClosures","operationId":"closeCurrentAccounts","name":"Perform the closure of the current account after settlement of payoff amount. The account moves to closed status based on the closure conditions defined in the system","summary":"Perform the closure of the current account after settlement of payoff amount","tags":[],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"currentAccountId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"currencyId":"string","effectiveDate":"2024-01-01","activityId":"string","transactionAmount":0.0,"contractId":"string","systemId":"string","externalEventStatus":"string"}},"responses":{"200":"closeCurrentAccountsResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"PUT","path":"/holdings/accounts/savingsAccounts/{savingsAccountId}/accountClosures","fullPath":"/api/v3.0.0/holdings/accounts/savingsAccounts/{savingsAccountId}/accountClosures","operationId":"closeSavingsAccounts","name":"Perform the closure of the savings account after settlement of payoff amount. The account moves to closed status based on the closure conditions defined in the system","summary":"Perform the closure of the savings account after settlement of payoff amount","tags":[],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"savingsAccountId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"currencyId":"string","effectiveDate":"2024-01-01","activityId":"string","transactionAmount":0.0,"contractId":"string","systemId":"string","externalEventStatus":"string"}},"responses":{"200":"closeSavingsAccountsResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"POST","path":"/holdings/accounts/simulations","fullPath":"/api/v3.0.0/holdings/accounts/simulations","operationId":"createAccountSimulation","name":"This can be used to create a simulation for account product and the payload should include customer identifier, account currency, etc.","summary":"Create simulation for account products","tags":["RETAIL"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"customerIds":[{}],"properties":[{}],"overrides":[{}],"productId":"string","masterArrangementId":"string","roleName":"string","currencyId":"string","effectiveDate":"2024-01-01","activityId":"string","transactionAmount":0.0,"reason":"string","automaticRun":"string","simulationRunReference":"string","synchronous":"string","balance":[{}]}},"responses":{"200":"createAccountSimulationResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"PUT","path":"/holdings/accounts/simulations/{simulationId}","fullPath":"/api/v3.0.0/holdings/accounts/simulations/{simulationId}","operationId":"updateAccountSimulation","name":"This can be used to amend a simulation for account product and the payload should include customer identifier, account currency, etc.","summary":"Amend simulation for account products","tags":["RETAIL"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"simulationId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"customerIds":[{}],"properties":[{}],"overrides":[{}],"productId":"string","masterArrangementId":"string","roleName":"string","currencyId":"string","effectiveDate":"2024-01-01","activityId":"string","transactionAmount":0.0,"reason":"string","automaticRun":"string","simulationRunReference":"string","synchronous":"string","balance":[{}]}},"responses":{"200":"updateAccountSimulationResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}}]},{"key":"holdings-accounts-arrangements-v4.0.0","title":"Account Arrangements","version":"v4.0.0","description":"The Arrangement Architecture is a Temenos Transact Framework to create and manage  various products such as Loans, Deposits, Accounts, etc. It provides a modular business component-based architecture, whereby users can create their Products by using the components provided by Temenos and these compo","endpointCount":20,"endpoints":[{"method":"POST","path":"/holdings/accounts/currentAccounts","fullPath":"/api/v4.0.0/holdings/accounts/currentAccounts","operationId":"createCurrentAccounts","name":"This can be used to create a current account and the payload should include customer identifier, customer role,  account currency, etc.","summary":"Create a current account","tags":[],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"parties":[{}],"activityId":"string","effectiveDate":"string","productId":"string","currencyId":"string","simulationId":"string","balance":[{}]}},"responses":{"200":"createCurrentAccountsResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"POST","path":"/holdings/accounts/corporateAccounts","fullPath":"/api/v4.0.0/holdings/accounts/corporateAccounts","operationId":"createCorporateAccount","name":"This can be used to create a corporate current account and the payload should include customer identifier, customer role,  account currency, etc.  The customer should be a valid corporate customer.","summary":"Create a corporate current account","tags":[],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"partyIds":[{}],"partyRoles":[{}],"agentCustomerIds":[{}],"agentArrangementIds":[{}],"agentRoles":[{}],"arrangmentId":"string","productId":"string","activityId":"string","currency":"string","productVariation":"string","pricingSelection":"string","pricingPlan":"string","rewardsArrangementId":"string","tradeDate":"string","arrangementEffectiveDate":"string"}},"responses":{"200":"createCorporateAccountResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"POST","path":"/holdings/accounts/mudarabaSavingAccount","fullPath":"/api/v4.0.0/holdings/accounts/mudarabaSavingAccount","operationId":"createMudarabaSavingAccount","name":"This can be used to create a mudarba savings account and the payload should include customer identifier, customer role,  account currency, etc.","summary":"Create a mudaraba savings account","tags":[],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"partyIds":[{}],"partyRoles":[{}],"agentCustomerIds":[{}],"agentArrangementIds":[{}],"agentRoles":[{}],"arrangmentId":"string","productId":"string","activityId":"string","currency":"string","productVariation":"string","pricingSelection":"string","pricingPlan":"string","rewardsArrangementId":"string","tradeDate":"string","arrangementEffectiveDate":"string"}},"responses":{"200":"createMudarabaSavingAccountResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"POST","path":"/holdings/accounts/savingsAccounts","fullPath":"/api/v4.0.0/holdings/accounts/savingsAccounts","operationId":"createSavingAccount","name":"This can be used to create a  savings account and the payload should include customer identifier, customer role,  account currency, etc.","summary":"Create a savings account","tags":[],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"partyIds":[{}],"partyRoles":[{}],"agentCustomerIds":[{}],"agentArrangementIds":[{}],"agentRoles":[{}],"arrangmentId":"string","productId":"string","activityId":"string","currency":"string","productVariation":"string","pricingSelection":"string","pricingPlan":"string","rewardsArrangementId":"string","tradeDate":"string","arrangementEffectiveDate":"string"}},"responses":{"200":"createSavingAccountResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"POST","path":"/holdings/accounts/minorAccounts","fullPath":"/api/v4.0.0/holdings/accounts/minorAccounts","operationId":"createMinorAccount","name":"This can be used to create a minor savings account (age below 18 years) and the payload should include customer identifier, customer role,  account currency, etc.","summary":"Create a minor savings account","tags":[],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"partyIds":[{}],"partyRoles":[{}],"agentCustomerIds":[{}],"agentArrangementIds":[{}],"agentRoles":[{}],"arrangmentId":"string","productId":"string","activityId":"string","currency":"string","productVariation":"string","pricingSelection":"string","pricingPlan":"string","rewardsArrangementId":"string","tradeDate":"string","arrangementEffectiveDate":"string"}},"responses":{"200":"createMinorAccountResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"POST","path":"/holdings/accounts/nonResidentAccounts","fullPath":"/api/v4.0.0/holdings/accounts/nonResidentAccounts","operationId":"createNonResidentAccount","name":"This can be used to create a non-resident savings account and the payload should include customer identifier, customer role,  account currency, etc.","summary":"Creates a non resident savings account","tags":[],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"partyIds":[{}],"partyRoles":[{}],"agentCustomerIds":[{}],"agentArrangementIds":[{}],"agentRoles":[{}],"arrangmentId":"string","productId":"string","activityId":"string","currency":"string","productVariation":"string","pricingSelection":"string","pricingPlan":"string","rewardsArrangementId":"string","tradeDate":"string","arrangementEffectiveDate":"string"}},"responses":{"200":"createNonResidentAccountResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"DELETE","path":"/holdings/accounts/{activityId}/reverseAccounts","fullPath":"/api/v4.0.0/holdings/accounts/{activityId}/reverseAccounts","operationId":"reverseAccounts","name":"Reverse or Delete a Current Account-This API is deprecated and going forward the following URL has to be used.URL:/holdings/arrangementActivityId/{activityId}","summary":"Reverse or Delete a Current Account","tags":[],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"activityId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":null,"responses":{"200":"reverseAccountsResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"GET","path":"/holdings/accounts/{arrangementId}/accountDetails","fullPath":"/api/v4.0.0/holdings/accounts/{arrangementId}/accountDetails","operationId":"getArrangementDetails","name":"Retrieves the Details of an Account-This API is deprecated and going forward the following URL has to be used.URL:/holdings/arrangements/{arrangementId}","summary":"Retrieves the Details of an Account","tags":[],"parameters":[{"name":"arrangementId","in":"path","type":"string","required":true,"description":"Indicates an unique identifier of an account"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"ArrangementDetailsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/accounts/{accountId}/statements/dates","fullPath":"/api/v4.0.0/holdings/accounts/{accountId}/statements/dates","operationId":"getPastStatements","name":"Retrieves the previously generated statement details for the given account such as statement date, frequency, detailed statement and lead or participant account","summary":"Retrieves the previously generated statement details for the given account","tags":["RETAIL"],"parameters":[{"name":"accountId","in":"path","type":"string","required":true,"description":"Identifier of the account. Often referred to as the account number, yet for consistency this is always referred to as accountId. Accepts both IBAN & BBAN"},{"name":"customer","in":"query","type":"string","required":false,"description":"Contains the customer identifier to fetch list of consent arrangements for the customer or customer identifier of the debtor account. This will be populated once the SCA(Strong Customer Authentication"},{"name":"carrierAddressId","in":"query","type":"string","required":false,"description":"Specifies the Carrier by which the message was received"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"PastStatementsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/accounts/{accountId}/statements/forwardEntries","fullPath":"/api/v4.0.0/holdings/accounts/{accountId}/statements/forwardEntries","operationId":"getForwardEntries","name":"Retrieves the details of future transaction entries such as statement reference, value date, booking date, transaction reference, transaction code and amount","summary":"Retrieves the details of future transaction entries","tags":["RETAIL"],"parameters":[{"name":"accountId","in":"path","type":"string","required":true,"description":"Identifier of the account. Often referred to as the account number, yet for consistency this is always referred to as accountId. Accepts both IBAN & BBAN"},{"name":"valueDate","in":"query","type":"string","required":false,"description":"Indicates the value date on which the underlying accounting entry is to be given value (for interest purposes)"},{"name":"longPositionSign","in":"query","type":"string","required":false,"description":"Polarity (sign) used to denote buy position balance.  "},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"ForwardEntriesResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/accounts/{accountId}/statements","fullPath":"/api/v4.0.0/holdings/accounts/{accountId}/statements","operationId":"getAccountStatement","name":"Retrieves the statement details of the transactions for the given account such as booking date, value date, transaction reference, transaction code, debit or credit amount, closing balance based on the given dates(from date and to date).If dates are not given, retrieves the last 1M transactions.If from date alone is given, retrieves the transactions from given date to today.If end date alone is given, retrieves the last 1M transactions prior to the given end date.If period is given, retrieves th","summary":"Retrieves the statement details for the given account","tags":["RETAIL"],"parameters":[{"name":"accountId","in":"path","type":"string","required":true,"description":"Identifier of the account. Often referred to as the account number, yet for consistency this is always referred to as accountId. Accepts both IBAN & BBAN"},{"name":"fromDate","in":"query","type":"string","required":false,"description":"Indicates the business date from when the balance reservation event is active."},{"name":"toDate","in":"query","type":"string","required":false,"description":"Indicates the business date until when the balance reservation event is active."},{"name":"transactionReference","in":"query","type":"string","required":false,"description":"Contains the identifier for the transaction in the core system"},{"name":"period","in":"query","type":"string","required":false,"description":"Indicates spread of time buckets.Ex: 3M,6M,9M,10Y etc."},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"AccountStatementResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"PUT","path":"/holdings/accounts/savingsAccounts/{savingsAccountId}/payoffCalculations","fullPath":"/api/v4.0.0/holdings/accounts/savingsAccounts/{savingsAccountId}/payoffCalculations","operationId":"calculatePayoffSavingsAccounts","name":"Calculate the payoff amount for the savings account which includes the outstanding amounts and also amounts such as account balances, interest, and charge amounts","summary":"Calculate the outstanding amount to close the savings account","tags":[],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"savingsAccountId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"closureNotes":[{}],"activityId":"string","automaticRun":"string","simulationRunReference":"string","effectiveDate":"2024-01-01","currencyId":"string","transactionAmount":0.0,"closureReason":"string","settlement":[{}],"payoff":[{}]}},"responses":{"200":"calculatePayoffSavingsAccountsResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"PUT","path":"/holdings/accounts/savingsAccounts/{savingsAccountId}/payoffs","fullPath":"/api/v4.0.0/holdings/accounts/savingsAccounts/{savingsAccountId}/payoffs","operationId":"settlePayoffSavingsAccounts","name":"Perform the settlement of payoff amount for the savings account by providing the transaction amount, currency and also settlement instructions","summary":"Perform the settlement of payoff amount for the savings account","tags":[],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"savingsAccountId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"currencyId":"string","effectiveDate":"2024-01-01","activityId":"string","transactionAmount":0.0,"contractId":"string","systemId":"string","externalEventStatus":"string","settlement":[{}]}},"responses":{"200":"settlePayoffSavingsAccountsResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"PUT","path":"/holdings/accounts/currentAccounts/{currentAccountId}/payoffCalculations","fullPath":"/api/v4.0.0/holdings/accounts/currentAccounts/{currentAccountId}/payoffCalculations","operationId":"calculatePayoffCurrentAccounts","name":"Calcualte the payoff amount for the current account which includes the outstanding amounts and also amounts such as account balances, interest, and charge amounts","summary":"Calculate the outstanding amount to close the current account","tags":[],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"currentAccountId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"closureNotes":[{}],"activityId":"string","automaticRun":"string","simulationRunReference":"string","effectiveDate":"2024-01-01","currencyId":"string","transactionAmount":0.0,"closureReason":"string","settlement":[{}],"payoff":[{}]}},"responses":{"200":"calculatePayoffCurrentAccountsResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"PUT","path":"/holdings/accounts/currentAccounts/{currentAccountId}/payoffs","fullPath":"/api/v4.0.0/holdings/accounts/currentAccounts/{currentAccountId}/payoffs","operationId":"settlePayoffCurrentAccounts","name":"Perform the settlement of payoff amount for the current account by providing the transaction amount, currency and also settlement instructions","summary":"Perform the settlement of payoff amount for the current account","tags":[],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"currentAccountId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"currencyId":"string","effectiveDate":"2024-01-01","activityId":"string","transactionAmount":0.0,"contractId":"string","systemId":"string","externalEventStatus":"string","settlement":[{}]}},"responses":{"200":"settlePayoffCurrentAccountsResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"PUT","path":"/holdings/accounts/currentAccounts/{currentAccountId}/accountClosures","fullPath":"/api/v4.0.0/holdings/accounts/currentAccounts/{currentAccountId}/accountClosures","operationId":"closeCurrentAccounts","name":"Perform the closure of the current account after settlement of payoff amount. The account moves to closed status based on the closure conditions defined in the system","summary":"Perform the closure of the current account after settlement of payoff amount","tags":[],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"currentAccountId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"currencyId":"string","effectiveDate":"2024-01-01","activityId":"string","transactionAmount":0.0,"contractId":"string","systemId":"string","externalEventStatus":"string"}},"responses":{"200":"closeCurrentAccountsResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"PUT","path":"/holdings/accounts/savingsAccounts/{savingsAccountId}/accountClosures","fullPath":"/api/v4.0.0/holdings/accounts/savingsAccounts/{savingsAccountId}/accountClosures","operationId":"closeSavingsAccounts","name":"Perform the closure of the savings account after settlement of payoff amount. The account moves to closed status based on the closure conditions defined in the system","summary":"Perform the closure of the savings account after settlement of payoff amount","tags":[],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"savingsAccountId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"currencyId":"string","effectiveDate":"2024-01-01","activityId":"string","transactionAmount":0.0,"contractId":"string","systemId":"string","externalEventStatus":"string"}},"responses":{"200":"closeSavingsAccountsResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"POST","path":"/holdings/accounts/simulations","fullPath":"/api/v4.0.0/holdings/accounts/simulations","operationId":"createAccountSimulation","name":"This can be used to create a simulation for account product and the payload should include customer identifier, account currency, etc.","summary":"Create simulation for account products","tags":["RETAIL"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"customerIds":[{}],"properties":[{}],"overrides":[{}],"productId":"string","masterArrangementId":"string","roleName":"string","currencyId":"string","effectiveDate":"2024-01-01","activityId":"string","transactionAmount":0.0,"reason":"string","automaticRun":"string","simulationRunReference":"string","synchronous":"string","balance":[{}]}},"responses":{"200":"createAccountSimulationResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"PUT","path":"/holdings/accounts/simulations/{simulationId}","fullPath":"/api/v4.0.0/holdings/accounts/simulations/{simulationId}","operationId":"updateAccountSimulation","name":"This can be used to amend a simulation for account product and the payload should include customer identifier, account currency, etc.","summary":"Amend simulation for account products","tags":["RETAIL"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"simulationId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"customerIds":[{}],"properties":[{}],"overrides":[{}],"productId":"string","masterArrangementId":"string","roleName":"string","currencyId":"string","effectiveDate":"2024-01-01","activityId":"string","transactionAmount":0.0,"reason":"string","automaticRun":"string","simulationRunReference":"string","synchronous":"string","balance":[{}]}},"responses":{"200":"updateAccountSimulationResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"GET","path":"/holdings/accounts/{accountId}","fullPath":"/api/v4.0.0/holdings/accounts/{accountId}","operationId":"getAccountDetails","name":"Retrieves the account specific information for internet banking users","summary":"Retrieves account details","tags":[],"parameters":[{"name":"accountId","in":"path","type":"string","required":true,"description":"Identifier of the account. Often referred to as the account number, yet for consistency this is always referred to as accountId. Accepts both IBAN & BBAN"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"AccountDetailsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}}]},{"key":"holdings-accounts-arrangements-v4.1.0","title":"Account Arrangements","version":"v4.1.0","description":"The arrangement architecture is a Temenos Transact Framework to create and manage  various products such as loans, deposits, accounts, etc. It provides a modular business component-based architecture, whereby users can create their products by using the components provided by Temenos and these compo","endpointCount":21,"endpoints":[{"method":"POST","path":"/holdings/accounts/businessAccount","fullPath":"/api/v4.1.0/holdings/accounts/businessAccount","operationId":"createBusinessAccount","name":"Creates a business banking account for a single customer or more than one customer(like a joint account relationship) with the customer identifier, customer role, account currency details","summary":"Creates a business banking account for a single or joint customer","tags":["RETAIL"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"customerIds":[{}],"properties":[{}],"overrides":[{}],"productId":"string","masterArrangementId":"string","roleName":"string","currencyId":"string","effectiveDate":"2024-01-01","activityId":"string","transactionAmount":0.0,"reason":"string","simulationRunReference":"string","channel":"string","branch":"string","lineOfBusiness":"string"}},"responses":{"200":"createBusinessAccountResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"POST","path":"/holdings/accounts/currentAccounts","fullPath":"/api/v4.1.0/holdings/accounts/currentAccounts","operationId":"createCurrentAccounts","name":"Creates a current account and the payload should include customer identifier, customer role,  account currency, etc.","summary":"Create a current account","tags":[],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"parties":[{}],"activityId":"string","effectiveDate":"string","productId":"string","currencyId":"string","simulationId":"string","balance":[{}]}},"responses":{"200":"createCurrentAccountsResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"POST","path":"/holdings/accounts/corporateAccounts","fullPath":"/api/v4.1.0/holdings/accounts/corporateAccounts","operationId":"createCorporateAccount","name":"Creates a corporate current account and the payload should include customer identifier, customer role,  account currency, etc.  The customer should be a valid corporate customer.","summary":"Create a corporate current account","tags":[],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"partyIds":[{}],"partyRoles":[{}],"agentCustomerIds":[{}],"agentArrangementIds":[{}],"agentRoles":[{}],"arrangmentId":"string","productId":"string","activityId":"string","currency":"string","productVariation":"string","pricingSelection":"string","pricingPlan":"string","rewardsArrangementId":"string","tradeDate":"string","arrangementEffectiveDate":"string"}},"responses":{"200":"createCorporateAccountResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"POST","path":"/holdings/accounts/mudarabaSavingAccount","fullPath":"/api/v4.1.0/holdings/accounts/mudarabaSavingAccount","operationId":"createMudarabaSavingAccount","name":"Creates a mudaraba savings account and the payload should include customer identifier, customer role,  account currency, etc.","summary":"Create a mudaraba savings account","tags":[],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"partyIds":[{}],"partyRoles":[{}],"agentCustomerIds":[{}],"agentArrangementIds":[{}],"agentRoles":[{}],"arrangmentId":"string","productId":"string","activityId":"string","currency":"string","productVariation":"string","pricingSelection":"string","pricingPlan":"string","rewardsArrangementId":"string","tradeDate":"string","arrangementEffectiveDate":"string"}},"responses":{"200":"createMudarabaSavingAccountResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"POST","path":"/holdings/accounts/savingsAccounts","fullPath":"/api/v4.1.0/holdings/accounts/savingsAccounts","operationId":"createSavingAccount","name":"Creates a savings account and the payload should include customer identifier, customer role,  account currency, etc.","summary":"Create a savings account","tags":[],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"partyIds":[{}],"partyRoles":[{}],"agentCustomerIds":[{}],"agentArrangementIds":[{}],"agentRoles":[{}],"arrangmentId":"string","productId":"string","activityId":"string","currency":"string","productVariation":"string","pricingSelection":"string","pricingPlan":"string","rewardsArrangementId":"string","tradeDate":"string","arrangementEffectiveDate":"string"}},"responses":{"200":"createSavingAccountResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"POST","path":"/holdings/accounts/minorAccounts","fullPath":"/api/v4.1.0/holdings/accounts/minorAccounts","operationId":"createMinorAccount","name":"Creates a minor savings account (age below 18 years) and the payload should include customer identifier, customer role,  account currency, etc.","summary":"Create a minor savings account","tags":[],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"partyIds":[{}],"partyRoles":[{}],"agentCustomerIds":[{}],"agentArrangementIds":[{}],"agentRoles":[{}],"arrangmentId":"string","productId":"string","activityId":"string","currency":"string","productVariation":"string","pricingSelection":"string","pricingPlan":"string","rewardsArrangementId":"string","tradeDate":"string","arrangementEffectiveDate":"string"}},"responses":{"200":"createMinorAccountResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"POST","path":"/holdings/accounts/nonResidentAccounts","fullPath":"/api/v4.1.0/holdings/accounts/nonResidentAccounts","operationId":"createNonResidentAccount","name":"Creates a non-resident savings account and the payload should include customer identifier, customer role,  account currency, etc.","summary":"Creates a non resident savings account","tags":[],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"partyIds":[{}],"partyRoles":[{}],"agentCustomerIds":[{}],"agentArrangementIds":[{}],"agentRoles":[{}],"arrangmentId":"string","productId":"string","activityId":"string","currency":"string","productVariation":"string","pricingSelection":"string","pricingPlan":"string","rewardsArrangementId":"string","tradeDate":"string","arrangementEffectiveDate":"string"}},"responses":{"200":"createNonResidentAccountResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"DELETE","path":"/holdings/accounts/{activityId}/reverseAccounts","fullPath":"/api/v4.1.0/holdings/accounts/{activityId}/reverseAccounts","operationId":"reverseAccounts","name":"Reverse or Delete a Current Account-This API is deprecated and going forward the following URL has to be used.URL:/holdings/arrangementActivityId/{activityId}","summary":"Reverse or Delete a Current Account","tags":[],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"activityId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":null,"responses":{"200":"reverseAccountsResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"GET","path":"/holdings/accounts/{arrangementId}/accountDetails","fullPath":"/api/v4.1.0/holdings/accounts/{arrangementId}/accountDetails","operationId":"getArrangementDetails","name":"Retrieves the Details of an Account-This API is deprecated and going forward the following URL has to be used.URL:/holdings/arrangements/{arrangementId}","summary":"Retrieves the Details of an Account","tags":[],"parameters":[{"name":"arrangementId","in":"path","type":"string","required":true,"description":"Indicates an unique identifier of an account"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"ArrangementDetailsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/accounts/{accountId}/statements/dates","fullPath":"/api/v4.1.0/holdings/accounts/{accountId}/statements/dates","operationId":"getPastStatements","name":"Retrieves the previously generated statement details for the given account such as statement date, frequency, detailed statement and lead or participant account","summary":"Retrieves the previously generated statement details for the given account","tags":["RETAIL"],"parameters":[{"name":"accountId","in":"path","type":"string","required":true,"description":"Identifier of the account. Often referred to as the account number, yet for consistency this is always referred to as accountId. Accepts both IBAN & BBAN"},{"name":"customer","in":"query","type":"string","required":false,"description":"Contains the customer identifier to fetch list of consent arrangements for the customer or customer identifier of the debtor account. This will be populated once the SCA(Strong Customer Authentication"},{"name":"carrierAddressId","in":"query","type":"string","required":false,"description":"Specifies the Carrier by which the message was received"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"PastStatementsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/accounts/{accountId}/statements/forwardEntries","fullPath":"/api/v4.1.0/holdings/accounts/{accountId}/statements/forwardEntries","operationId":"getForwardEntries","name":"Retrieves the details of future transaction entries such as statement reference, value date, booking date, transaction reference, transaction code and amount","summary":"Retrieves the details of future transaction entries","tags":["RETAIL"],"parameters":[{"name":"accountId","in":"path","type":"string","required":true,"description":"Identifier of the account. Often referred to as the account number, yet for consistency this is always referred to as accountId. Accepts both IBAN & BBAN"},{"name":"valueDate","in":"query","type":"string","required":false,"description":"Indicates the value date on which the underlying accounting entry is to be given value (for interest purposes)"},{"name":"longPositionSign","in":"query","type":"string","required":false,"description":"Polarity (sign) used to denote buy position balance.  "},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"ForwardEntriesResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/accounts/{accountId}/statements","fullPath":"/api/v4.1.0/holdings/accounts/{accountId}/statements","operationId":"getAccountStatement","name":"Retrieves the statement details of the transactions for the given account such as booking date, value date, transaction reference, transaction code, debit or credit amount, closing balance based on the given dates(from date and to date).If dates are not given, retrieves the last 1 month transactions.If start date alone is given, retrieves the transactions from given date to today.If end date alone is given, retrieves the last 1 month transactions prior to the given end date.If period is given, r","summary":"Retrieves the statement details for the given account","tags":["RETAIL"],"parameters":[{"name":"accountId","in":"path","type":"string","required":true,"description":"Identifier of the account. Often referred to as the account number, yet for consistency this is always referred to as accountId. Accepts both IBAN & BBAN"},{"name":"fromDate","in":"query","type":"string","required":false,"description":"Indicates the business date from when the balance reservation event is active."},{"name":"toDate","in":"query","type":"string","required":false,"description":"Indicates the business date until when the balance reservation event is active."},{"name":"transactionReference","in":"query","type":"string","required":false,"description":"Contains the identifier for the transaction in the core system"},{"name":"period","in":"query","type":"string","required":false,"description":"Indicates spread of time buckets.Ex: 3M,6M,9M,10Y etc."},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"AccountStatementResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"PUT","path":"/holdings/accounts/savingsAccounts/{savingsAccountId}/payoffCalculations","fullPath":"/api/v4.1.0/holdings/accounts/savingsAccounts/{savingsAccountId}/payoffCalculations","operationId":"calculatePayoffSavingsAccounts","name":"Calculate the payoff amount for the savings account which includes the outstanding amounts and also amounts such as account balances, interest, and charge amounts","summary":"Calculate the outstanding amount to close the savings account","tags":[],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"savingsAccountId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"closureNotes":[{}],"activityId":"string","automaticRun":"string","simulationRunReference":"string","effectiveDate":"2024-01-01","currencyId":"string","transactionAmount":0.0,"closureReason":"string","settlement":[{}],"payoff":[{}]}},"responses":{"200":"calculatePayoffSavingsAccountsResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"PUT","path":"/holdings/accounts/savingsAccounts/{savingsAccountId}/payoffs","fullPath":"/api/v4.1.0/holdings/accounts/savingsAccounts/{savingsAccountId}/payoffs","operationId":"settlePayoffSavingsAccounts","name":"Perform the settlement of payoff amount for the savings account by providing the transaction amount, currency and also settlement instructions","summary":"Perform the settlement of payoff amount for the savings account","tags":[],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"savingsAccountId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"currencyId":"string","effectiveDate":"2024-01-01","activityId":"string","transactionAmount":0.0,"contractId":"string","systemId":"string","externalEventStatus":"string","settlement":[{}]}},"responses":{"200":"settlePayoffSavingsAccountsResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"PUT","path":"/holdings/accounts/currentAccounts/{currentAccountId}/payoffCalculations","fullPath":"/api/v4.1.0/holdings/accounts/currentAccounts/{currentAccountId}/payoffCalculations","operationId":"calculatePayoffCurrentAccounts","name":"Calculate the payoff amount for the current account which includes the outstanding amounts and also amounts such as account balances, interest, and charge amounts","summary":"Calculate the outstanding amount to close the current account","tags":[],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"currentAccountId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"closureNotes":[{}],"activityId":"string","automaticRun":"string","simulationRunReference":"string","effectiveDate":"2024-01-01","currencyId":"string","transactionAmount":0.0,"closureReason":"string","settlement":[{}],"payoff":[{}]}},"responses":{"200":"calculatePayoffCurrentAccountsResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"PUT","path":"/holdings/accounts/currentAccounts/{currentAccountId}/payoffs","fullPath":"/api/v4.1.0/holdings/accounts/currentAccounts/{currentAccountId}/payoffs","operationId":"settlePayoffCurrentAccounts","name":"Perform the settlement of payoff amount for the current account by providing the transaction amount, currency and also settlement instructions","summary":"Perform the settlement of payoff amount for the current account","tags":[],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"currentAccountId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"currencyId":"string","effectiveDate":"2024-01-01","activityId":"string","transactionAmount":0.0,"contractId":"string","systemId":"string","externalEventStatus":"string","settlement":[{}]}},"responses":{"200":"settlePayoffCurrentAccountsResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"PUT","path":"/holdings/accounts/currentAccounts/{currentAccountId}/accountClosures","fullPath":"/api/v4.1.0/holdings/accounts/currentAccounts/{currentAccountId}/accountClosures","operationId":"closeCurrentAccounts","name":"Perform the closure of the current account after settlement of payoff amount. The account moves to closed status based on the closure conditions defined in the system","summary":"Perform the closure of the current account after settlement of payoff amount","tags":[],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"currentAccountId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"currencyId":"string","effectiveDate":"2024-01-01","activityId":"string","transactionAmount":0.0,"contractId":"string","systemId":"string","externalEventStatus":"string"}},"responses":{"200":"closeCurrentAccountsResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"PUT","path":"/holdings/accounts/savingsAccounts/{savingsAccountId}/accountClosures","fullPath":"/api/v4.1.0/holdings/accounts/savingsAccounts/{savingsAccountId}/accountClosures","operationId":"closeSavingsAccounts","name":"Perform the closure of the savings account after settlement of payoff amount. The account moves to closed status based on the closure conditions defined in the system","summary":"Perform the closure of the savings account after settlement of payoff amount","tags":[],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"savingsAccountId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"currencyId":"string","effectiveDate":"2024-01-01","activityId":"string","transactionAmount":0.0,"contractId":"string","systemId":"string","externalEventStatus":"string"}},"responses":{"200":"closeSavingsAccountsResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"POST","path":"/holdings/accounts/simulations","fullPath":"/api/v4.1.0/holdings/accounts/simulations","operationId":"createAccountSimulation","name":"Creates a simulation for account product and the payload should include customer identifier, account currency, etc.","summary":"Create simulation for account products","tags":["RETAIL"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"customerIds":[{}],"properties":[{}],"overrides":[{}],"productId":"string","masterArrangementId":"string","roleName":"string","currencyId":"string","effectiveDate":"2024-01-01","activityId":"string","transactionAmount":0.0,"reason":"string","automaticRun":"string","simulationRunReference":"string","synchronous":"string","balance":[{}]}},"responses":{"200":"createAccountSimulationResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"PUT","path":"/holdings/accounts/simulations/{simulationId}","fullPath":"/api/v4.1.0/holdings/accounts/simulations/{simulationId}","operationId":"updateAccountSimulation","name":"Updates a simulation for account product and the payload should include customer identifier, account currency, etc.","summary":"Amend simulation for account products","tags":["RETAIL"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"simulationId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"customerIds":[{}],"properties":[{}],"overrides":[{}],"productId":"string","masterArrangementId":"string","roleName":"string","currencyId":"string","effectiveDate":"2024-01-01","activityId":"string","transactionAmount":0.0,"reason":"string","automaticRun":"string","simulationRunReference":"string","synchronous":"string","balance":[{}]}},"responses":{"200":"updateAccountSimulationResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"GET","path":"/holdings/accounts/{accountId}","fullPath":"/api/v4.1.0/holdings/accounts/{accountId}","operationId":"getAccountDetails","name":"Retrieves the account specific information for internet banking users","summary":"Retrieves account details","tags":[],"parameters":[{"name":"accountId","in":"path","type":"string","required":true,"description":"Identifier of the account. Often referred to as the account number, yet for consistency this is always referred to as accountId. Accepts both IBAN & BBAN"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"AccountDetailsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}}]},{"key":"holdings-accounts-arrangements-v5.0.0","title":"Account Arrangements","version":"v5.0.0","description":"The Arrangement Architecture is a Temenos Transact Framework to create and manage  various products such as Loans, Deposits, Accounts, etc. It provides a modular business component-based architecture, whereby users can create their Products by using the components provided by Temenos and these compo","endpointCount":21,"endpoints":[{"method":"POST","path":"/holdings/accounts/currentAccounts","fullPath":"/api/v5.0.0/holdings/accounts/currentAccounts","operationId":"createCurrentAccounts","name":"This can be used to create a current account and the payload should include customer identifier, customer role,  account currency, etc.","summary":"Create a current account","tags":[],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"parties":[{}],"activityId":"string","effectiveDate":"string","productId":"string","currencyId":"string","simulationId":"string","balance":[{}]}},"responses":{"200":"createCurrentAccountsResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"POST","path":"/holdings/accounts/corporateAccounts","fullPath":"/api/v5.0.0/holdings/accounts/corporateAccounts","operationId":"createCorporateAccount","name":"This can be used to create a corporate current account and the payload should include customer identifier, customer role,  account currency, etc.  The customer should be a valid corporate customer.","summary":"Create a corporate current account","tags":[],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"partyIds":[{}],"partyRoles":[{}],"agentCustomerIds":[{}],"agentArrangementIds":[{}],"agentRoles":[{}],"arrangmentId":"string","productId":"string","activityId":"string","currency":"string","productVariation":"string","pricingSelection":"string","pricingPlan":"string","rewardsArrangementId":"string","tradeDate":"string","arrangementEffectiveDate":"string"}},"responses":{"200":"createCorporateAccountResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"POST","path":"/holdings/accounts/mudarabaSavingAccount","fullPath":"/api/v5.0.0/holdings/accounts/mudarabaSavingAccount","operationId":"createMudarabaSavingAccount","name":"This can be used to create a mudarba savings account and the payload should include customer identifier, customer role,  account currency, etc.","summary":"Create a mudaraba savings account","tags":[],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"partyIds":[{}],"partyRoles":[{}],"agentCustomerIds":[{}],"agentArrangementIds":[{}],"agentRoles":[{}],"arrangmentId":"string","productId":"string","activityId":"string","currency":"string","productVariation":"string","pricingSelection":"string","pricingPlan":"string","rewardsArrangementId":"string","tradeDate":"string","arrangementEffectiveDate":"string"}},"responses":{"200":"createMudarabaSavingAccountResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"POST","path":"/holdings/accounts/savingsAccounts","fullPath":"/api/v5.0.0/holdings/accounts/savingsAccounts","operationId":"createSavingAccount","name":"This can be used to create a  savings account and the payload should include customer identifier, customer role,  account currency, etc.","summary":"Create a savings account","tags":[],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"partyIds":[{}],"partyRoles":[{}],"agentCustomerIds":[{}],"agentArrangementIds":[{}],"agentRoles":[{}],"arrangmentId":"string","productId":"string","activityId":"string","currency":"string","productVariation":"string","pricingSelection":"string","pricingPlan":"string","rewardsArrangementId":"string","tradeDate":"string","arrangementEffectiveDate":"string"}},"responses":{"200":"createSavingAccountResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"POST","path":"/holdings/accounts/minorAccounts","fullPath":"/api/v5.0.0/holdings/accounts/minorAccounts","operationId":"createMinorAccount","name":"This can be used to create a minor savings account (age below 18 years) and the payload should include customer identifier, customer role,  account currency, etc.","summary":"Create a minor savings account","tags":[],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"partyIds":[{}],"partyRoles":[{}],"agentCustomerIds":[{}],"agentArrangementIds":[{}],"agentRoles":[{}],"arrangmentId":"string","productId":"string","activityId":"string","currency":"string","productVariation":"string","pricingSelection":"string","pricingPlan":"string","rewardsArrangementId":"string","tradeDate":"string","arrangementEffectiveDate":"string"}},"responses":{"200":"createMinorAccountResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"POST","path":"/holdings/accounts/nonResidentAccounts","fullPath":"/api/v5.0.0/holdings/accounts/nonResidentAccounts","operationId":"createNonResidentAccount","name":"This can be used to create a non-resident savings account and the payload should include customer identifier, customer role,  account currency, etc.","summary":"Creates a non resident savings account","tags":[],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"partyIds":[{}],"partyRoles":[{}],"agentCustomerIds":[{}],"agentArrangementIds":[{}],"agentRoles":[{}],"arrangmentId":"string","productId":"string","activityId":"string","currency":"string","productVariation":"string","pricingSelection":"string","pricingPlan":"string","rewardsArrangementId":"string","tradeDate":"string","arrangementEffectiveDate":"string"}},"responses":{"200":"createNonResidentAccountResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"DELETE","path":"/holdings/accounts/{activityId}/reverseAccounts","fullPath":"/api/v5.0.0/holdings/accounts/{activityId}/reverseAccounts","operationId":"reverseAccounts","name":"Reverse or Delete a Current Account-This API is deprecated and going forward the following URL has to be used.URL:/holdings/arrangementActivityId/{activityId}","summary":"Reverse or Delete a Current Account","tags":[],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"activityId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":null,"responses":{"200":"reverseAccountsResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"GET","path":"/holdings/accounts/{arrangementId}/accountDetails","fullPath":"/api/v5.0.0/holdings/accounts/{arrangementId}/accountDetails","operationId":"getArrangementDetails","name":"Retrieves the Details of an Account-This API is deprecated and going forward the following URL has to be used.URL:/holdings/arrangements/{arrangementId}","summary":"Retrieves the Details of an Account","tags":[],"parameters":[{"name":"arrangementId","in":"path","type":"string","required":true,"description":"Indicates an unique identifier of an account"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"ArrangementDetailsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/accounts/{accountId}/statements/dates","fullPath":"/api/v5.0.0/holdings/accounts/{accountId}/statements/dates","operationId":"getPastStatements","name":"Retrieves the previously generated statement details for the given account such as statement date, frequency, detailed statement and lead or participant account","summary":"Retrieves the previously generated statement details for the given account","tags":["RETAIL"],"parameters":[{"name":"accountId","in":"path","type":"string","required":true,"description":"Identifier of the account. Often referred to as the account number, yet for consistency this is always referred to as accountId. Accepts both IBAN & BBAN"},{"name":"customer","in":"query","type":"string","required":false,"description":"Contains the customer identifier to fetch list of consent arrangements for the customer or customer identifier of the debtor account. This will be populated once the SCA(Strong Customer Authentication"},{"name":"carrierAddressId","in":"query","type":"string","required":false,"description":"Specifies the Carrier by which the message was received"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"PastStatementsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/accounts/{accountId}/statements/forwardEntries","fullPath":"/api/v5.0.0/holdings/accounts/{accountId}/statements/forwardEntries","operationId":"getForwardEntries","name":"Retrieves the details of future transaction entries such as statement reference, value date, booking date, transaction reference, transaction code and amount","summary":"Retrieves the details of future transaction entries","tags":["RETAIL"],"parameters":[{"name":"accountId","in":"path","type":"string","required":true,"description":"Identifier of the account. Often referred to as the account number, yet for consistency this is always referred to as accountId. Accepts both IBAN & BBAN"},{"name":"valueDate","in":"query","type":"string","required":false,"description":"Indicates the value date on which the underlying accounting entry is to be given value (for interest purposes)"},{"name":"longPositionSign","in":"query","type":"string","required":false,"description":"Polarity (sign) used to denote buy position balance.  "},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"ForwardEntriesResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/accounts/{accountId}/statements","fullPath":"/api/v5.0.0/holdings/accounts/{accountId}/statements","operationId":"getAccountStatement","name":"Retrieves the statement details of the transactions for the given account such as booking date, value date, transaction reference, transaction code, debit or credit amount, closing balance based on the given dates(from date and to date).If dates are not given, retrieves the last 1M transactions.If from date alone is given, retrieves the transactions from given date to today.If end date alone is given, retrieves the last 1M transactions prior to the given end date.If period is given, retrieves th","summary":"Retrieves the statement details for the given account","tags":["RETAIL"],"parameters":[{"name":"accountId","in":"path","type":"string","required":true,"description":"Identifier of the account. Often referred to as the account number, yet for consistency this is always referred to as accountId. Accepts both IBAN & BBAN"},{"name":"fromDate","in":"query","type":"string","required":false,"description":"Indicates the business date from when the balance reservation event is active."},{"name":"toDate","in":"query","type":"string","required":false,"description":"Indicates the business date until when the balance reservation event is active."},{"name":"transactionReference","in":"query","type":"string","required":false,"description":"Contains the identifier for the transaction in the core system"},{"name":"period","in":"query","type":"string","required":false,"description":"Indicates spread of time buckets.Ex: 3M,6M,9M,10Y etc."},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"AccountStatementResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"PUT","path":"/holdings/accounts/savingsAccounts/{savingsAccountId}/payoffCalculations","fullPath":"/api/v5.0.0/holdings/accounts/savingsAccounts/{savingsAccountId}/payoffCalculations","operationId":"calculatePayoffSavingsAccounts","name":"Calculate the payoff amount for the savings account which includes the outstanding amounts and also amounts such as account balances, interest, and charge amounts","summary":"Calculate the outstanding amount to close the savings account","tags":[],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"savingsAccountId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"closureNotes":[{}],"activityId":"string","automaticRun":"string","simulationRunReference":"string","effectiveDate":"2024-01-01","currencyId":"string","transactionAmount":0.0,"closureReason":"string","settlement":[{}],"payoff":[{}]}},"responses":{"200":"calculatePayoffSavingsAccountsResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"PUT","path":"/holdings/accounts/savingsAccounts/{savingsAccountId}/payoffs","fullPath":"/api/v5.0.0/holdings/accounts/savingsAccounts/{savingsAccountId}/payoffs","operationId":"settlePayoffSavingsAccounts","name":"Perform the settlement of payoff amount for the savings account by providing the transaction amount, currency and also settlement instructions","summary":"Perform the settlement of payoff amount for the savings account","tags":[],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"savingsAccountId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"currencyId":"string","effectiveDate":"2024-01-01","activityId":"string","transactionAmount":0.0,"contractId":"string","systemId":"string","externalEventStatus":"string","settlement":[{}]}},"responses":{"200":"settlePayoffSavingsAccountsResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"PUT","path":"/holdings/accounts/currentAccounts/{currentAccountId}/payoffCalculations","fullPath":"/api/v5.0.0/holdings/accounts/currentAccounts/{currentAccountId}/payoffCalculations","operationId":"calculatePayoffCurrentAccounts","name":"Calcualte the payoff amount for the current account which includes the outstanding amounts and also amounts such as account balances, interest, and charge amounts","summary":"Calculate the outstanding amount to close the current account","tags":[],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"currentAccountId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"closureNotes":[{}],"activityId":"string","automaticRun":"string","simulationRunReference":"string","effectiveDate":"2024-01-01","currencyId":"string","transactionAmount":0.0,"closureReason":"string","settlement":[{}],"payoff":[{}]}},"responses":{"200":"calculatePayoffCurrentAccountsResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"PUT","path":"/holdings/accounts/currentAccounts/{currentAccountId}/payoffs","fullPath":"/api/v5.0.0/holdings/accounts/currentAccounts/{currentAccountId}/payoffs","operationId":"settlePayoffCurrentAccounts","name":"Perform the settlement of payoff amount for the current account by providing the transaction amount, currency and also settlement instructions","summary":"Perform the settlement of payoff amount for the current account","tags":[],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"currentAccountId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"currencyId":"string","effectiveDate":"2024-01-01","activityId":"string","transactionAmount":0.0,"contractId":"string","systemId":"string","externalEventStatus":"string","settlement":[{}]}},"responses":{"200":"settlePayoffCurrentAccountsResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"PUT","path":"/holdings/accounts/currentAccounts/{currentAccountId}/accountClosures","fullPath":"/api/v5.0.0/holdings/accounts/currentAccounts/{currentAccountId}/accountClosures","operationId":"closeCurrentAccounts","name":"Perform the closure of the current account after settlement of payoff amount. The account moves to closed status based on the closure conditions defined in the system","summary":"Perform the closure of the current account after settlement of payoff amount","tags":[],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"currentAccountId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"currencyId":"string","effectiveDate":"2024-01-01","activityId":"string","transactionAmount":0.0,"contractId":"string","systemId":"string","externalEventStatus":"string"}},"responses":{"200":"closeCurrentAccountsResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"PUT","path":"/holdings/accounts/savingsAccounts/{savingsAccountId}/accountClosures","fullPath":"/api/v5.0.0/holdings/accounts/savingsAccounts/{savingsAccountId}/accountClosures","operationId":"closeSavingsAccounts","name":"Perform the closure of the savings account after settlement of payoff amount. The account moves to closed status based on the closure conditions defined in the system","summary":"Perform the closure of the savings account after settlement of payoff amount","tags":[],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"savingsAccountId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"currencyId":"string","effectiveDate":"2024-01-01","activityId":"string","transactionAmount":0.0,"contractId":"string","systemId":"string","externalEventStatus":"string"}},"responses":{"200":"closeSavingsAccountsResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"POST","path":"/holdings/accounts/simulations","fullPath":"/api/v5.0.0/holdings/accounts/simulations","operationId":"createAccountSimulation","name":"This can be used to create a simulation for account product and the payload should include customer identifier, account currency, etc.","summary":"Create simulation for account products","tags":["RETAIL"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"customerIds":[{}],"properties":[{}],"overrides":[{}],"productId":"string","masterArrangementId":"string","roleName":"string","currencyId":"string","effectiveDate":"2024-01-01","activityId":"string","transactionAmount":0.0,"reason":"string","automaticRun":"string","simulationRunReference":"string","synchronous":"string","balance":[{}]}},"responses":{"200":"createAccountSimulationResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"PUT","path":"/holdings/accounts/simulations/{simulationId}","fullPath":"/api/v5.0.0/holdings/accounts/simulations/{simulationId}","operationId":"updateAccountSimulation","name":"This can be used to amend a simulation for account product and the payload should include customer identifier, account currency, etc.","summary":"Amend simulation for account products","tags":["RETAIL"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"simulationId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"customerIds":[{}],"properties":[{}],"overrides":[{}],"productId":"string","masterArrangementId":"string","roleName":"string","currencyId":"string","effectiveDate":"2024-01-01","activityId":"string","transactionAmount":0.0,"reason":"string","automaticRun":"string","simulationRunReference":"string","synchronous":"string","balance":[{}]}},"responses":{"200":"updateAccountSimulationResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"GET","path":"/holdings/accounts/{accountId}","fullPath":"/api/v5.0.0/holdings/accounts/{accountId}","operationId":"getAccountDetails","name":"Retrieves the account specific information for internet banking users","summary":"Retrieves account details","tags":[],"parameters":[{"name":"accountId","in":"path","type":"string","required":true,"description":"Identifier of the account. Often referred to as the account number, yet for consistency this is always referred to as accountId. Accepts both IBAN & BBAN"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"AccountDetailsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"POST","path":"/holdings/accounts","fullPath":"/api/v5.0.0/holdings/accounts","operationId":"createAccount","name":"This can be used to create an account product and the payload should include customer identifier, account currency, etc.","summary":"Create account products","tags":["RETAIL"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"partyIds":[{}],"partyRoles":[{}],"agentCustomerIds":[{}],"agentArrangementIds":[{}],"agentRoles":[{}],"arrangmentId":"string","productId":"string","activityId":"string","currency":"string","productVariation":"string","pricingSelection":"string","pricingPlan":"string","rewardsArrangementId":"string","tradeDate":"string","arrangementEffectiveDate":"string"}},"responses":{"200":"createSavingsAccountResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}}]},{"key":"holdings-accounts-arrangements-v5.1.0","title":"Account Arrangements","version":"v5.1.0","description":"The Arrangement Architecture is a Temenos Transact Framework to create and manage  various products such as Loans, Deposits, Accounts, etc. It provides a modular business component-based architecture, whereby users can create their Products by using the components provided by Temenos and these compo","endpointCount":22,"endpoints":[{"method":"POST","path":"/holdings/accounts","fullPath":"/api/v5.1.0/holdings/accounts","operationId":"createSavingsAccount","name":"Create an account product with the details such as customer identifier, account currency, etc.","summary":"Create account products","tags":["RETAIL"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"partyIds":[{}],"partyRoles":[{}],"agentCustomerIds":[{}],"agentArrangementIds":[{}],"agentRoles":[{}],"arrangmentId":"string","productId":"string","activityId":"string","currency":"string","productVariation":"string","pricingSelection":"string","pricingPlan":"string","rewardsArrangementId":"string","tradeDate":"string","arrangementEffectiveDate":"string"}},"responses":{"200":"createSavingsAccountResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"POST","path":"/holdings/accounts/currentAccounts","fullPath":"/api/v5.1.0/holdings/accounts/currentAccounts","operationId":"createCurrentAccounts","name":"Creates a current account with the details such as customer identifier, customer role,  account currency, etc.","summary":"Create a current account","tags":[],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"parties":[{}],"productId":"string","activityId":"string","currencyId":"string","effectiveDate":"string","branch":"string","extensions":{},"balance":[{}]}},"responses":{"200":"createCurrentAccountsResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"POST","path":"/holdings/accounts/corporateAccounts","fullPath":"/api/v5.1.0/holdings/accounts/corporateAccounts","operationId":"createCorporateAccount","name":"Creates a corporate current account with the details such as customer identifier, customer role,  account currency, etc.  The customer should be a valid corporate customer.","summary":"Create a corporate current account","tags":[],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"partyIds":[{}],"partyRoles":[{}],"agentCustomerIds":[{}],"agentArrangementIds":[{}],"agentRoles":[{}],"arrangmentId":"string","productId":"string","activityId":"string","currency":"string","productVariation":"string","pricingSelection":"string","pricingPlan":"string","rewardsArrangementId":"string","tradeDate":"string","arrangementEffectiveDate":"string"}},"responses":{"200":"createCorporateAccountResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"POST","path":"/holdings/accounts/mudarabaSavingAccount","fullPath":"/api/v5.1.0/holdings/accounts/mudarabaSavingAccount","operationId":"createMudarabaSavingAccount","name":"Creates a mudarba savings account with the details such as customer identifier, customer role,  account currency, etc.","summary":"Create a mudaraba savings account","tags":[],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"partyIds":[{}],"partyRoles":[{}],"agentCustomerIds":[{}],"agentArrangementIds":[{}],"agentRoles":[{}],"arrangmentId":"string","productId":"string","activityId":"string","currency":"string","productVariation":"string","pricingSelection":"string","pricingPlan":"string","rewardsArrangementId":"string","tradeDate":"string","arrangementEffectiveDate":"string"}},"responses":{"200":"createMudarabaSavingAccountResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"POST","path":"/holdings/accounts/savingsAccounts","fullPath":"/api/v5.1.0/holdings/accounts/savingsAccounts","operationId":"createSavingAccount","name":"Creates a savings account with the details such as customer identifier, customer role,  account currency, etc.","summary":"Create a savings account","tags":[],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"partyIds":[{}],"partyRoles":[{}],"agentCustomerIds":[{}],"agentArrangementIds":[{}],"agentRoles":[{}],"arrangmentId":"string","productId":"string","activityId":"string","currency":"string","productVariation":"string","pricingSelection":"string","pricingPlan":"string","rewardsArrangementId":"string","tradeDate":"string","arrangementEffectiveDate":"string"}},"responses":{"200":"createSavingAccountResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"POST","path":"/holdings/accounts/minorAccounts","fullPath":"/api/v5.1.0/holdings/accounts/minorAccounts","operationId":"createMinorAccount","name":"Creates a minor savings account (age below 18 years) with the details such as customer identifier, customer role,  account currency, etc.","summary":"Create a minor savings account","tags":[],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"partyIds":[{}],"partyRoles":[{}],"agentCustomerIds":[{}],"agentArrangementIds":[{}],"agentRoles":[{}],"arrangmentId":"string","productId":"string","activityId":"string","currency":"string","productVariation":"string","pricingSelection":"string","pricingPlan":"string","rewardsArrangementId":"string","tradeDate":"string","arrangementEffectiveDate":"string"}},"responses":{"200":"createMinorAccountResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"POST","path":"/holdings/accounts/nonResidentAccounts","fullPath":"/api/v5.1.0/holdings/accounts/nonResidentAccounts","operationId":"createNonResidentAccount","name":"Creates a non-resident savings account with the details such as customer identifier, customer role,  account currency, etc.","summary":"Creates a non resident savings account","tags":[],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"partyIds":[{}],"partyRoles":[{}],"agentCustomerIds":[{}],"agentArrangementIds":[{}],"agentRoles":[{}],"arrangmentId":"string","productId":"string","activityId":"string","currency":"string","productVariation":"string","pricingSelection":"string","pricingPlan":"string","rewardsArrangementId":"string","tradeDate":"string","arrangementEffectiveDate":"string"}},"responses":{"200":"createNonResidentAccountResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"DELETE","path":"/holdings/accounts/{activityId}/reverseAccounts","fullPath":"/api/v5.1.0/holdings/accounts/{activityId}/reverseAccounts","operationId":"reverseAccounts","name":"Reverse or delete a current account-This API is deprecated and going forward the following URL has to be used.URL:/holdings/arrangementActivityId/{activityId}","summary":"Reverse or delete a current account","tags":[],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"activityId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":null,"responses":{"200":"reverseAccountsResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"GET","path":"/holdings/accounts/{arrangementId}/accountDetails","fullPath":"/api/v5.1.0/holdings/accounts/{arrangementId}/accountDetails","operationId":"getArrangementDetails","name":"Retrieves the details of an account-This API is deprecated and going forward the following URL has to be used.URL:/holdings/arrangements/{arrangementId}","summary":"Retrieves the details of an account","tags":[],"parameters":[{"name":"arrangementId","in":"path","type":"string","required":true,"description":"Indicates an unique identifier of an account"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"ArrangementDetailsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/accounts/{accountId}/statements/dates","fullPath":"/api/v5.1.0/holdings/accounts/{accountId}/statements/dates","operationId":"getPastStatements","name":"Retrieves the previously generated statement details for the given account such as statement date, frequency, detailed statement and lead or participant account","summary":"Retrieves the previously generated statement details for the given account","tags":["RETAIL"],"parameters":[{"name":"accountId","in":"path","type":"string","required":true,"description":"Identifier of the account. Often referred to as the account number, yet for consistency this is always referred to as accountId. Accepts both IBAN & BBAN"},{"name":"customer","in":"query","type":"string","required":false,"description":"Contains the customer identifier to fetch list of consent arrangements for the customer or customer identifier of the debtor account. This will be populated once the SCA(Strong Customer Authentication"},{"name":"carrierAddressId","in":"query","type":"string","required":false,"description":"Specifies the Carrier by which the message was received"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"PastStatementsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/accounts/{accountId}/statements/forwardEntries","fullPath":"/api/v5.1.0/holdings/accounts/{accountId}/statements/forwardEntries","operationId":"getForwardEntries","name":"Retrieves the details of future transaction entries such as statement reference, value date, booking date, transaction reference, transaction code and amount","summary":"Retrieves the details of future transaction entries","tags":["RETAIL"],"parameters":[{"name":"accountId","in":"path","type":"string","required":true,"description":"Identifier of the account. Often referred to as the account number, yet for consistency this is always referred to as accountId. Accepts both IBAN & BBAN"},{"name":"valueDate","in":"query","type":"string","required":false,"description":"Indicates the value date on which the underlying accounting entry is to be given value (for interest purposes)"},{"name":"longPositionSign","in":"query","type":"string","required":false,"description":"Polarity (sign) used to denote buy position balance.  "},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"ForwardEntriesResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/accounts/{accountId}/statements","fullPath":"/api/v5.1.0/holdings/accounts/{accountId}/statements","operationId":"getAccountStatement","name":"Retrieves the statement details of the transactions for the given account such as booking date, value date, transaction reference, transaction code, debit or credit amount, closing balance based on the given dates(from date and to date).If dates are not given, retrieves the last 1M transactions.If from date alone is given, retrieves the transactions from given date to today.If end date alone is given, retrieves the last 1M transactions prior to the given end date.If period is given, retrieves th","summary":"Retrieves the statement details for the given account","tags":["RETAIL"],"parameters":[{"name":"accountId","in":"path","type":"string","required":true,"description":"Identifier of the account. Often referred to as the account number, yet for consistency this is always referred to as accountId. Accepts both IBAN & BBAN"},{"name":"fromDate","in":"query","type":"string","required":false,"description":"Indicates the business date from when the balance reservation event is active."},{"name":"toDate","in":"query","type":"string","required":false,"description":"Indicates the business date until when the balance reservation event is active."},{"name":"transactionReference","in":"query","type":"string","required":false,"description":"Contains the identifier for the transaction in the core system"},{"name":"period","in":"query","type":"string","required":false,"description":"Indicates spread of time buckets.Ex: 3M,6M,9M,10Y etc."},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"AccountStatementResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"PUT","path":"/holdings/accounts/savingsAccounts/{savingsAccountId}/payoffCalculations","fullPath":"/api/v5.1.0/holdings/accounts/savingsAccounts/{savingsAccountId}/payoffCalculations","operationId":"calculatePayoffSavingsAccounts","name":"Calculate the payoff amount for the savings account which includes the outstanding amounts and also amounts such as account balances, interest, and charge amounts","summary":"Calculate the outstanding amount to close the savings account","tags":[],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"savingsAccountId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"closureNotes":[{}],"activityId":"string","automaticRun":"string","simulationRunReference":"string","effectiveDate":"2024-01-01","currencyId":"string","transactionAmount":0.0,"closureReason":"string","extensions":{},"settlement":[{}],"payoff":[{}]}},"responses":{"200":"calculatePayoffSavingsAccountsResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"PUT","path":"/holdings/accounts/savingsAccounts/{savingsAccountId}/payoffs","fullPath":"/api/v5.1.0/holdings/accounts/savingsAccounts/{savingsAccountId}/payoffs","operationId":"settlePayoffSavingsAccounts","name":"Perform the settlement of payoff amount for the savings account by providing the transaction amount, currency and also settlement instructions","summary":"Perform the settlement of payoff amount for the savings account","tags":[],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"savingsAccountId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"currencyId":"string","effectiveDate":"2024-01-01","activityId":"string","transactionAmount":0.0,"contractId":"string","systemId":"string","externalEventStatus":"string","extensions":{},"settlement":[{}]}},"responses":{"200":"settlePayoffSavingsAccountsResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"PUT","path":"/holdings/accounts/currentAccounts/{currentAccountId}/payoffCalculations","fullPath":"/api/v5.1.0/holdings/accounts/currentAccounts/{currentAccountId}/payoffCalculations","operationId":"calculatePayoffCurrentAccounts","name":"Calcualte the payoff amount for the current account which includes the outstanding amounts and also amounts such as account balances, interest, and charge amounts","summary":"Calculate the outstanding amount to close the current account","tags":[],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"currentAccountId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"closureNotes":[{}],"activityId":"string","automaticRun":"string","simulationRunReference":"string","effectiveDate":"2024-01-01","currencyId":"string","transactionAmount":0.0,"closureReason":"string","extensions":{},"settlement":[{}],"payoff":[{}]}},"responses":{"200":"calculatePayoffCurrentAccountsResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"PUT","path":"/holdings/accounts/currentAccounts/{currentAccountId}/payoffs","fullPath":"/api/v5.1.0/holdings/accounts/currentAccounts/{currentAccountId}/payoffs","operationId":"settlePayoffCurrentAccounts","name":"Perform the settlement of payoff amount for the current account by providing the transaction amount, currency and also settlement instructions","summary":"Perform the settlement of payoff amount for the current account","tags":[],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"currentAccountId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"currencyId":"string","effectiveDate":"2024-01-01","activityId":"string","transactionAmount":0.0,"contractId":"string","systemId":"string","externalEventStatus":"string","extensions":{},"settlement":[{}]}},"responses":{"200":"settlePayoffCurrentAccountsResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"PUT","path":"/holdings/accounts/currentAccounts/{currentAccountId}/accountClosures","fullPath":"/api/v5.1.0/holdings/accounts/currentAccounts/{currentAccountId}/accountClosures","operationId":"closeCurrentAccounts","name":"Perform the closure of the current account after settlement of payoff amount. The account moves to closed status based on the closure conditions defined in the system","summary":"Perform the closure of the current account after settlement of payoff amount","tags":[],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"currentAccountId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"currencyId":"string","effectiveDate":"2024-01-01","activityId":"string","transactionAmount":0.0,"contractId":"string","systemId":"string","externalEventStatus":"string","extensions":{}}},"responses":{"200":"closeCurrentAccountsResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"PUT","path":"/holdings/accounts/savingsAccounts/{savingsAccountId}/accountClosures","fullPath":"/api/v5.1.0/holdings/accounts/savingsAccounts/{savingsAccountId}/accountClosures","operationId":"closeSavingsAccounts","name":"Perform the closure of the savings account after settlement of payoff amount. The account moves to closed status based on the closure conditions defined in the system","summary":"Perform the closure of the savings account after settlement of payoff amount","tags":[],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"savingsAccountId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"currencyId":"string","effectiveDate":"2024-01-01","activityId":"string","transactionAmount":0.0,"contractId":"string","systemId":"string","externalEventStatus":"string","extensions":{}}},"responses":{"200":"closeSavingsAccountsResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"POST","path":"/holdings/accounts/simulations","fullPath":"/api/v5.1.0/holdings/accounts/simulations","operationId":"createAccountSimulation","name":"Creates a simulation for account product with the details such as customer identifier, account currency, etc.","summary":"Create simulation for account products","tags":["RETAIL"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"customerIds":[{}],"properties":[{}],"overrides":[{}],"productId":"string","masterArrangementId":"string","roleName":"string","currencyId":"string","effectiveDate":"2024-01-01","activityId":"string","transactionAmount":0.0,"reason":"string","automaticRun":"string","simulationRunReference":"string","synchronous":"string","extensions":{}}},"responses":{"200":"createAccountSimulationResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"GET","path":"/holdings/accounts/{accountId}","fullPath":"/api/v5.1.0/holdings/accounts/{accountId}","operationId":"getAccountDetails","name":"Retrieves the account specific information for internet banking users","summary":"Retrieves account details","tags":[],"parameters":[{"name":"accountId","in":"path","type":"string","required":true,"description":"Identifier of the account. Often referred to as the account number, yet for consistency this is always referred to as accountId. Accepts both IBAN & BBAN"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"AccountDetailsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"PUT","path":"/holdings/accounts/simulations/{simulationId}","fullPath":"/api/v5.1.0/holdings/accounts/simulations/{simulationId}","operationId":"updateAccountSimulation","name":"Amend a simulation for account product with the details such as customer identifier, account currency, etc.","summary":"Amend simulation for account products","tags":["RETAIL"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"simulationId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"customerIds":[{}],"properties":[{}],"overrides":[{}],"productId":"string","masterArrangementId":"string","roleName":"string","currencyId":"string","effectiveDate":"2024-01-01","activityId":"string","transactionAmount":0.0,"reason":"string","simulationRunReference":"string","extensions":{}}},"responses":{"200":"updateAccountSimulationResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"PUT","path":"/holdings/accounts/arrangements/{arrangementId}/activities","fullPath":"/api/v5.1.0/holdings/accounts/arrangements/{arrangementId}/activities","operationId":"createAccountsArrangements","name":"Update an accounts arrangement","summary":"Update an accounts arrangement","tags":["RETAIL"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"arrangementId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"customerIds":[{}],"properties":[{}],"overrides":[{}],"productId":"string","masterArrangementId":"string","roleName":"string","currencyId":"string","effectiveDate":"2024-01-01","activityId":"string","transactionAmount":0.0,"reason":"string","simulationRunReference":"string","channel":"string","branch":"string","lineOfBusiness":"string"}},"responses":{"200":"createAccountsArrangementsResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}}]},{"key":"holdings-accounts-arrangements-v6.0.0","title":"Account Arrangements","version":"v6.0.0","description":"The Arrangement Architecture is a Temenos Transact Framework to create and manage  various products such as loans, deposits, accounts, etc. It provides a modular business component-based architecture, whereby users can create their products by using the components provided by Temenos and these compo","endpointCount":25,"endpoints":[{"method":"POST","path":"/holdings/accounts","fullPath":"/api/v6.0.0/holdings/accounts","operationId":"createSavingsAccount","name":"Create an account product with the details such as customer identifier, account currency, etc.","summary":"Create account products","tags":["RETAIL"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"partyIds":[{}],"partyRoles":[{}],"agentCustomerIds":[{}],"agentArrangementIds":[{}],"agentRoles":[{}],"arrangmentId":"string","productId":"string","activityId":"string","currency":"string","productVariation":"string","pricingSelection":"string","pricingPlan":"string","rewardsArrangementId":"string","tradeDate":"string","arrangementEffectiveDate":"string"}},"responses":{"200":"createSavingsAccountResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"POST","path":"/holdings/accounts/currentAccounts","fullPath":"/api/v6.0.0/holdings/accounts/currentAccounts","operationId":"createCurrentAccounts","name":"Creates a current account with the details such as customer identifier, customer role,  account currency, etc.","summary":"Create a current account","tags":["RETAIL"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"parties":[{}],"productId":"string","activityId":"string","currencyId":"string","effectiveDate":"string","branch":"string","extensions":{},"balance":[{}]}},"responses":{"200":"createCurrentAccountsResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"POST","path":"/holdings/accounts/corporateAccounts","fullPath":"/api/v6.0.0/holdings/accounts/corporateAccounts","operationId":"createCorporateAccount","name":"Creates a corporate current account with the details such as customer identifier, customer role,  account currency, etc.  The customer should be a valid corporate customer.","summary":"Create a corporate current account","tags":["RETAIL"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"partyIds":[{}],"partyRoles":[{}],"agentCustomerIds":[{}],"agentArrangementIds":[{}],"agentRoles":[{}],"arrangmentId":"string","productId":"string","activityId":"string","currency":"string","productVariation":"string","pricingSelection":"string","pricingPlan":"string","rewardsArrangementId":"string","tradeDate":"string","arrangementEffectiveDate":"string"}},"responses":{"200":"createCorporateAccountResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"POST","path":"/holdings/accounts/mudarabaSavingAccount","fullPath":"/api/v6.0.0/holdings/accounts/mudarabaSavingAccount","operationId":"createMudarabaSavingAccount","name":"Creates a mudarba savings account with the details such as customer identifier, customer role,  account currency, etc.","summary":"Create a mudaraba savings account","tags":["ISLAMIC BANKING","RETAIL"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"partyIds":[{}],"partyRoles":[{}],"agentCustomerIds":[{}],"agentArrangementIds":[{}],"agentRoles":[{}],"arrangmentId":"string","productId":"string","activityId":"string","currency":"string","productVariation":"string","pricingSelection":"string","pricingPlan":"string","rewardsArrangementId":"string","tradeDate":"string","arrangementEffectiveDate":"string"}},"responses":{"200":"createMudarabaSavingAccountResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"POST","path":"/holdings/accounts/savingsAccounts","fullPath":"/api/v6.0.0/holdings/accounts/savingsAccounts","operationId":"createSavingAccount","name":"Creates a savings account with the details such as customer identifier, customer role,  account currency, etc.","summary":"Create a savings account","tags":["OTHERS"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"partyIds":[{}],"partyRoles":[{}],"agentCustomerIds":[{}],"agentArrangementIds":[{}],"agentRoles":[{}],"arrangmentId":"string","productId":"string","activityId":"string","currency":"string","productVariation":"string","pricingSelection":"string","pricingPlan":"string","rewardsArrangementId":"string","tradeDate":"string","arrangementEffectiveDate":"string"}},"responses":{"200":"createSavingAccountResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"POST","path":"/holdings/accounts/minorAccounts","fullPath":"/api/v6.0.0/holdings/accounts/minorAccounts","operationId":"createMinorAccount","name":"Creates a minor savings account (age below 18 years) with the details such as customer identifier, customer role,  account currency, etc.","summary":"Create a minor savings account","tags":["OTHERS"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"partyIds":[{}],"partyRoles":[{}],"agentCustomerIds":[{}],"agentArrangementIds":[{}],"agentRoles":[{}],"arrangmentId":"string","productId":"string","activityId":"string","currency":"string","productVariation":"string","pricingSelection":"string","pricingPlan":"string","rewardsArrangementId":"string","tradeDate":"string","arrangementEffectiveDate":"string"}},"responses":{"200":"createMinorAccountResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"POST","path":"/holdings/accounts/nonResidentAccounts","fullPath":"/api/v6.0.0/holdings/accounts/nonResidentAccounts","operationId":"createNonResidentAccount","name":"Creates a non-resident savings account with the details such as customer identifier, customer role,  account currency, etc.","summary":"Creates a non resident savings account","tags":["OTHERS"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"partyIds":[{}],"partyRoles":[{}],"agentCustomerIds":[{}],"agentArrangementIds":[{}],"agentRoles":[{}],"arrangmentId":"string","productId":"string","activityId":"string","currency":"string","productVariation":"string","pricingSelection":"string","pricingPlan":"string","rewardsArrangementId":"string","tradeDate":"string","arrangementEffectiveDate":"string"}},"responses":{"200":"createNonResidentAccountResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"DELETE","path":"/holdings/accounts/{activityId}/reverseAccounts","fullPath":"/api/v6.0.0/holdings/accounts/{activityId}/reverseAccounts","operationId":"reverseAccounts","name":"Reverse or delete a current account-This API is deprecated and going forward the following URL has to be used.URL:/holdings/arrangementActivityId/{activityId}","summary":"Reverse or delete a current account","tags":["OTHERS"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"activityId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":null,"responses":{"200":"reverseAccountsResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"GET","path":"/holdings/accounts/{arrangementId}/accountDetails","fullPath":"/api/v6.0.0/holdings/accounts/{arrangementId}/accountDetails","operationId":"getArrangementDetails","name":"Retrieves the details of an account-This API is deprecated and going forward the following URL has to be used.URL:/holdings/arrangements/{arrangementId}","summary":"Retrieves the details of an account","tags":["OTHERS"],"parameters":[{"name":"arrangementId","in":"path","type":"string","required":true,"description":"Indicates an unique identifier of an account"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"ArrangementDetailsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/accounts/{accountId}/statements/dates","fullPath":"/api/v6.0.0/holdings/accounts/{accountId}/statements/dates","operationId":"getPastStatements","name":"Retrieves the previously generated statement details for the given account such as statement date, frequency, detailed statement and lead or participant account","summary":"Retrieves the previously generated statement details for the given account","tags":["RETAIL"],"parameters":[{"name":"accountId","in":"path","type":"string","required":true,"description":"Identifier of the account. Often referred to as the account number, yet for consistency this is always referred to as accountId. Accepts both IBAN & BBAN"},{"name":"customer","in":"query","type":"string","required":false,"description":"Contains the customer identifier to fetch list of consent arrangements for the customer or customer identifier of the debtor account. This will be populated once the SCA(Strong Customer Authentication"},{"name":"carrierAddressId","in":"query","type":"string","required":false,"description":"Specifies the Carrier by which the message was received"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"PastStatementsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/accounts/{accountId}/statements/forwardEntries","fullPath":"/api/v6.0.0/holdings/accounts/{accountId}/statements/forwardEntries","operationId":"getForwardEntries","name":"Retrieves the details of future transaction entries such as statement reference, value date, booking date, transaction reference, transaction code and amount","summary":"Retrieves the details of future transaction entries","tags":["RETAIL"],"parameters":[{"name":"accountId","in":"path","type":"string","required":true,"description":"Identifier of the account. Often referred to as the account number, yet for consistency this is always referred to as accountId. Accepts both IBAN & BBAN"},{"name":"valueDate","in":"query","type":"string","required":false,"description":"Indicates the value date on which the underlying accounting entry is to be given value (for interest purposes)"},{"name":"longPositionSign","in":"query","type":"string","required":false,"description":"Polarity (sign) used to denote buy position balance.  "},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"ForwardEntriesResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/accounts/{accountId}/statements","fullPath":"/api/v6.0.0/holdings/accounts/{accountId}/statements","operationId":"getAccountStatement","name":"Retrieves the statement details of the transactions for the given account such as booking date, value date, transaction reference, transaction code, debit or credit amount, closing balance based on the given dates(from date and to date).If dates are not given, retrieves the last 1M transactions.If from date alone is given, retrieves the transactions from given date to today.If end date alone is given, retrieves the last 1M transactions prior to the given end date.If period is given, retrieves th","summary":"Retrieves the statement details for the given account","tags":["RETAIL"],"parameters":[{"name":"accountId","in":"path","type":"string","required":true,"description":"Identifier of the account. Often referred to as the account number, yet for consistency this is always referred to as accountId. Accepts both IBAN & BBAN"},{"name":"fromDate","in":"query","type":"string","required":false,"description":"Indicates the business date from when the balance reservation event is active."},{"name":"toDate","in":"query","type":"string","required":false,"description":"Indicates the business date until when the balance reservation event is active."},{"name":"transactionReference","in":"query","type":"string","required":false,"description":"Contains the identifier for the transaction in the core system"},{"name":"period","in":"query","type":"string","required":false,"description":"Indicates spread of time buckets.Ex: 3M,6M,9M,10Y etc."},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"AccountStatementResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"PUT","path":"/holdings/accounts/savingsAccounts/{savingsAccountId}/payoffCalculations","fullPath":"/api/v6.0.0/holdings/accounts/savingsAccounts/{savingsAccountId}/payoffCalculations","operationId":"calculatePayoffSavingsAccounts","name":"Calculate the payoff amount for the savings account which includes the outstanding amounts and also amounts such as account balances, interest, and charge amounts","summary":"Calculate the outstanding amount to close the savings account","tags":["OTHERS"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"savingsAccountId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"parties":[{}],"productId":"string","activityId":"string","currencyId":"string","effectiveDate":"string","branch":"string","extensions":{},"settlement":[{}],"payoff":[{}]}},"responses":{"200":"calculatePayoffSavingsAccountsResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"PUT","path":"/holdings/accounts/savingsAccounts/{savingsAccountId}/payoffs","fullPath":"/api/v6.0.0/holdings/accounts/savingsAccounts/{savingsAccountId}/payoffs","operationId":"settlePayoffSavingsAccounts","name":"Perform the settlement of payoff amount for the savings account by providing the transaction amount, currency and also settlement instructions","summary":"Perform the settlement of payoff amount for the savings account","tags":["OTHERS"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"savingsAccountId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"currencyId":"string","effectiveDate":"2024-01-01","activityId":"string","transactionAmount":0.0,"contractId":"string","systemId":"string","externalEventStatus":"string","extensions":{},"settlement":[{}]}},"responses":{"200":"settlePayoffSavingsAccountsResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"PUT","path":"/holdings/accounts/currentAccounts/{currentAccountId}/payoffCalculations","fullPath":"/api/v6.0.0/holdings/accounts/currentAccounts/{currentAccountId}/payoffCalculations","operationId":"calculatePayoffCurrentAccounts","name":"Calcualte the payoff amount for the current account which includes the outstanding amounts and also amounts such as account balances, interest, and charge amounts","summary":"Calculate the outstanding amount to close the current account","tags":["OTHERS"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"currentAccountId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"parties":[{}],"productId":"string","activityId":"string","currencyId":"string","effectiveDate":"string","branch":"string","extensions":{},"settlement":[{}],"payoff":[{}]}},"responses":{"200":"calculatePayoffCurrentAccountsResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"PUT","path":"/holdings/accounts/currentAccounts/{currentAccountId}/payoffs","fullPath":"/api/v6.0.0/holdings/accounts/currentAccounts/{currentAccountId}/payoffs","operationId":"settlePayoffCurrentAccounts","name":"Perform the settlement of payoff amount for the current account by providing the transaction amount, currency and also settlement instructions","summary":"Perform the settlement of payoff amount for the current account","tags":["OTHERS"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"currentAccountId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"currencyId":"string","effectiveDate":"2024-01-01","activityId":"string","transactionAmount":0.0,"contractId":"string","systemId":"string","externalEventStatus":"string","extensions":{},"settlement":[{}]}},"responses":{"200":"settlePayoffCurrentAccountsResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"PUT","path":"/holdings/accounts/currentAccounts/{currentAccountId}/accountClosures","fullPath":"/api/v6.0.0/holdings/accounts/currentAccounts/{currentAccountId}/accountClosures","operationId":"closeCurrentAccounts","name":"Perform the closure of the current account after settlement of payoff amount. The account moves to closed status based on the closure conditions defined in the system","summary":"Perform the closure of the current account after settlement of payoff amount","tags":["OTHERS"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"currentAccountId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"currencyId":"string","effectiveDate":"2024-01-01","activityId":"string","transactionAmount":0.0,"contractId":"string","systemId":"string","externalEventStatus":"string","extensions":{}}},"responses":{"200":"closeCurrentAccountsResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"PUT","path":"/holdings/accounts/savingsAccounts/{savingsAccountId}/accountClosures","fullPath":"/api/v6.0.0/holdings/accounts/savingsAccounts/{savingsAccountId}/accountClosures","operationId":"closeSavingsAccounts","name":"Perform the closure of the savings account after settlement of payoff amount. The account moves to closed status based on the closure conditions defined in the system","summary":"Perform the closure of the savings account after settlement of payoff amount","tags":["OTHERS"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"savingsAccountId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"currencyId":"string","effectiveDate":"2024-01-01","activityId":"string","transactionAmount":0.0,"contractId":"string","systemId":"string","externalEventStatus":"string","extensions":{}}},"responses":{"200":"closeSavingsAccountsResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"POST","path":"/holdings/accounts/simulations","fullPath":"/api/v6.0.0/holdings/accounts/simulations","operationId":"createAccountSimulation","name":"Creates a simulation for account product with the details such as customer identifier, account currency, etc.","summary":"Create simulation for account products","tags":["RETAIL"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"customerIds":[{}],"properties":[{}],"overrides":[{}],"productId":"string","masterArrangementId":"string","roleName":"string","currencyId":"string","effectiveDate":"2024-01-01","activityId":"string","transactionAmount":0.0,"reason":"string","simulationRunReference":"string","extensions":{},"balance":[{}]}},"responses":{"200":"createAccountSimulationResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"GET","path":"/holdings/accounts/{accountId}","fullPath":"/api/v6.0.0/holdings/accounts/{accountId}","operationId":"getAccountDetails","name":"Retrieves the account specific information for internet banking users","summary":"Retrieves account details","tags":["OTHERS"],"parameters":[{"name":"accountId","in":"path","type":"string","required":true,"description":"Identifier of the account. Often referred to as the account number, yet for consistency this is always referred to as accountId. Accepts both IBAN & BBAN"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"AccountDetailsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"PUT","path":"/holdings/accounts/simulations/{simulationId}","fullPath":"/api/v6.0.0/holdings/accounts/simulations/{simulationId}","operationId":"updateAccountSimulation","name":"Amend a simulation for account product with the details such as customer identifier, account currency, etc.","summary":"Amend simulation for account products","tags":["RETAIL"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"simulationId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"customerIds":[{}],"properties":[{}],"overrides":[{}],"productId":"string","masterArrangementId":"string","roleName":"string","currencyId":"string","effectiveDate":"2024-01-01","activityId":"string","transactionAmount":0.0,"reason":"string","simulationRunReference":"string","extensions":{}}},"responses":{"200":"updateAccountSimulationResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"PUT","path":"/holdings/accounts/arrangements/{arrangementId}/activities","fullPath":"/api/v6.0.0/holdings/accounts/arrangements/{arrangementId}/activities","operationId":"createAccountsArrangements","name":"Update an accounts arrangement","summary":"Update an accounts arrangement","tags":["RETAIL"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"arrangementId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"customerIds":[{}],"properties":[{}],"overrides":[{}],"productId":"string","masterArrangementId":"string","roleName":"string","currencyId":"string","effectiveDate":"2024-01-01","activityId":"string","transactionAmount":0.0,"reason":"string","simulationRunReference":"string","channel":"string","branch":"string","lineOfBusiness":"string"}},"responses":{"200":"createAccountsArrangementsResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"PUT","path":"/holdings/accounts/{accountId}/interests","fullPath":"/api/v6.0.0/holdings/accounts/{accountId}/interests","operationId":"updateAccountInterestCondition","name":"Update the debit interest conditions of the account such as interest rate, tier details, margin amount etc.","summary":"Update the debit interest conditions of an account","tags":["RETAIL"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"accountId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"partyIds":[{}],"partyRoles":[{}],"agentCustomerIds":[{}],"agentArrangementIds":[{}],"agentRoles":[{}],"arrangmentId":"string","productId":"string","activityId":"string","currency":"string","productVariation":"string","pricingSelection":"string","pricingPlan":"string","rewardsArrangementId":"string","tradeDate":"string","arrangementEffectiveDate":"string"}},"responses":{"200":"updateAccountInterestConditionResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"GET","path":"/holdings/accounts/{accountId}/facilities","fullPath":"/api/v6.0.0/holdings/accounts/{accountId}/facilities","operationId":"getAccountfacilities","name":"Retrieves the service availability for an account like block, unblock of cheque,card,sweep etc.,","summary":"Retrieves the service availability for an account","tags":["RETAIL"],"parameters":[{"name":"accountId","in":"path","type":"string","required":true,"description":"Identifier of the account. Often referred to as the account number, yet for consistency this is always referred to as accountId. Accepts both IBAN & BBAN"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"AccountfacilitiesResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"PUT","path":"/holdings/accounts/{accountId}/facilities","fullPath":"/api/v6.0.0/holdings/accounts/{accountId}/facilities","operationId":"updateAccountfacilities","name":"Update the service availability for an account like block.unblock of cheque,card,sweep etc.,","summary":"Update the service availability for an account","tags":["RETAIL"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"accountId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"partyIds":[{}],"partyRoles":[{}],"agentCustomerIds":[{}],"agentArrangementIds":[{}],"agentRoles":[{}],"arrangmentId":"string","productId":"string","activityId":"string","currency":"string","productVariation":"string","pricingSelection":"string","pricingPlan":"string","rewardsArrangementId":"string","tradeDate":"string","arrangementEffectiveDate":"string"}},"responses":{"200":"updateAccountfacilitiesResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}}]},{"key":"holdings-accounts-arrangements-v6.1.0","title":"Account Arrangements","version":"v6.1.0","description":"The Arrangement Architecture is a Temenos Transact Framework to create and manage  various products such as loans, deposits, accounts, etc. It provides a modular business component-based architecture, whereby users can create their products by using the components provided by Temenos and these compo","endpointCount":26,"endpoints":[{"method":"POST","path":"/holdings/accounts","fullPath":"/api/v6.1.0/holdings/accounts","operationId":"createSavingsAccount","name":"Create an account product with the details such as customer identifier, account currency, etc.","summary":"Create account products","tags":["RETAIL"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"partyIds":[{}],"partyRoles":[{}],"agentCustomerIds":[{}],"agentArrangementIds":[{}],"agentRoles":[{}],"arrangmentId":"string","productId":"string","activityId":"string","currency":"string","productVariation":"string","pricingSelection":"string","pricingPlan":"string","rewardsArrangementId":"string","tradeDate":"string","arrangementEffectiveDate":"string"}},"responses":{"200":"createSavingsAccountResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"POST","path":"/holdings/accounts/currentAccounts","fullPath":"/api/v6.1.0/holdings/accounts/currentAccounts","operationId":"createCurrentAccounts","name":"Creates a current account with the details such as customer identifier, customer role,  account currency, etc.","summary":"Create a current account","tags":["RETAIL"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"parties":[{}],"productId":"string","activityId":"string","currencyId":"string","effectiveDate":"string","branch":"string","extensions":{},"balance":[{}]}},"responses":{"200":"createCurrentAccountsResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"POST","path":"/holdings/accounts/corporateAccounts","fullPath":"/api/v6.1.0/holdings/accounts/corporateAccounts","operationId":"createCorporateAccount","name":"Creates a corporate current account with the details such as customer identifier, customer role,  account currency, etc.  The customer should be a valid corporate customer.","summary":"Create a corporate current account","tags":["RETAIL"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"partyIds":[{}],"partyRoles":[{}],"agentCustomerIds":[{}],"agentArrangementIds":[{}],"agentRoles":[{}],"arrangmentId":"string","productId":"string","activityId":"string","currency":"string","productVariation":"string","pricingSelection":"string","pricingPlan":"string","rewardsArrangementId":"string","tradeDate":"string","arrangementEffectiveDate":"string"}},"responses":{"200":"createCorporateAccountResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"POST","path":"/holdings/accounts/mudarabaSavingAccount","fullPath":"/api/v6.1.0/holdings/accounts/mudarabaSavingAccount","operationId":"createMudarabaSavingAccount","name":"Creates a mudarba savings account with the details such as customer identifier, customer role,  account currency, etc.","summary":"Create a mudaraba savings account","tags":["ISLAMIC BANKING","RETAIL"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"partyIds":[{}],"partyRoles":[{}],"agentCustomerIds":[{}],"agentArrangementIds":[{}],"agentRoles":[{}],"arrangmentId":"string","productId":"string","activityId":"string","currency":"string","productVariation":"string","pricingSelection":"string","pricingPlan":"string","rewardsArrangementId":"string","tradeDate":"string","arrangementEffectiveDate":"string"}},"responses":{"200":"createMudarabaSavingAccountResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"POST","path":"/holdings/accounts/savingsAccounts","fullPath":"/api/v6.1.0/holdings/accounts/savingsAccounts","operationId":"createSavingAccount","name":"Creates a savings account with the details such as customer identifier, customer role,  account currency, etc.","summary":"Create a savings account","tags":["OTHERS"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"partyIds":[{}],"partyRoles":[{}],"agentCustomerIds":[{}],"agentArrangementIds":[{}],"agentRoles":[{}],"arrangmentId":"string","productId":"string","activityId":"string","currency":"string","productVariation":"string","pricingSelection":"string","pricingPlan":"string","rewardsArrangementId":"string","tradeDate":"string","arrangementEffectiveDate":"string"}},"responses":{"200":"createSavingAccountResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"POST","path":"/holdings/accounts/minorAccounts","fullPath":"/api/v6.1.0/holdings/accounts/minorAccounts","operationId":"createMinorAccount","name":"Creates a minor savings account (age below 18 years) with the details such as customer identifier, customer role,  account currency, etc.","summary":"Create a minor savings account","tags":["OTHERS"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"partyIds":[{}],"partyRoles":[{}],"agentCustomerIds":[{}],"agentArrangementIds":[{}],"agentRoles":[{}],"arrangmentId":"string","productId":"string","activityId":"string","currency":"string","productVariation":"string","pricingSelection":"string","pricingPlan":"string","rewardsArrangementId":"string","tradeDate":"string","arrangementEffectiveDate":"string"}},"responses":{"200":"createMinorAccountResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"POST","path":"/holdings/accounts/nonResidentAccounts","fullPath":"/api/v6.1.0/holdings/accounts/nonResidentAccounts","operationId":"createNonResidentAccount","name":"Creates a non-resident savings account with the details such as customer identifier, customer role,  account currency, etc.","summary":"Creates a non resident savings account","tags":["OTHERS"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"partyIds":[{}],"partyRoles":[{}],"agentCustomerIds":[{}],"agentArrangementIds":[{}],"agentRoles":[{}],"arrangmentId":"string","productId":"string","activityId":"string","currency":"string","productVariation":"string","pricingSelection":"string","pricingPlan":"string","rewardsArrangementId":"string","tradeDate":"string","arrangementEffectiveDate":"string"}},"responses":{"200":"createNonResidentAccountResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"DELETE","path":"/holdings/accounts/{activityId}/reverseAccounts","fullPath":"/api/v6.1.0/holdings/accounts/{activityId}/reverseAccounts","operationId":"reverseAccounts","name":"Reverse or delete a current account-This API is deprecated and going forward the following URL has to be used.URL:/holdings/arrangementActivityId/{activityId}","summary":"Reverse or delete a current account","tags":["OTHERS"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"activityId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":null,"responses":{"200":"reverseAccountsResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"GET","path":"/holdings/accounts/{arrangementId}/accountDetails","fullPath":"/api/v6.1.0/holdings/accounts/{arrangementId}/accountDetails","operationId":"getAccountArrangementDetails","name":"Retrieves the details of an account-This API is deprecated and going forward the following URL has to be used.URL:/holdings/arrangements/{arrangementId}","summary":"Retrieves the details of an account","tags":["OTHERS"],"parameters":[{"name":"arrangementId","in":"path","type":"string","required":true,"description":"Indicates an unique identifier of an account"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"AccountArrangementDetailsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/accounts/{accountId}/statements/dates","fullPath":"/api/v6.1.0/holdings/accounts/{accountId}/statements/dates","operationId":"getPastStatements","name":"Retrieves the previously generated statement details for the given account such as statement date, frequency, detailed statement and lead or participant account","summary":"Retrieves the previously generated statement details for the given account","tags":["RETAIL"],"parameters":[{"name":"accountId","in":"path","type":"string","required":true,"description":"Identifier of the account. Often referred to as the account number, yet for consistency this is always referred to as accountId. Accepts both IBAN & BBAN"},{"name":"customer","in":"query","type":"string","required":false,"description":"Contains the customer identifier to fetch list of consent arrangements for the customer or customer identifier of the debtor account. This will be populated once the SCA(Strong Customer Authentication"},{"name":"carrierAddressId","in":"query","type":"string","required":false,"description":"Specifies the Carrier by which the message was received"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"PastStatementsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/accounts/{accountId}/statements/forwardEntries","fullPath":"/api/v6.1.0/holdings/accounts/{accountId}/statements/forwardEntries","operationId":"getForwardEntries","name":"Retrieves the details of future transaction entries such as statement reference, value date, booking date, transaction reference, transaction code and amount","summary":"Retrieves the details of future transaction entries","tags":["RETAIL"],"parameters":[{"name":"accountId","in":"path","type":"string","required":true,"description":"Identifier of the account. Often referred to as the account number, yet for consistency this is always referred to as accountId. Accepts both IBAN & BBAN"},{"name":"valueDate","in":"query","type":"string","required":false,"description":"Indicates the value date on which the underlying accounting entry is to be given value (for interest purposes)"},{"name":"longPositionSign","in":"query","type":"string","required":false,"description":"Polarity (sign) used to denote buy position balance.  "},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"ForwardEntriesResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/accounts/{accountId}/statements","fullPath":"/api/v6.1.0/holdings/accounts/{accountId}/statements","operationId":"getAccountStatement","name":"Retrieves the statement details of the transactions for the given account such as booking date, value date, transaction reference, transaction code, debit or credit amount, closing balance based on the given dates(from date and to date).If dates are not given, retrieves the last 1M transactions.If from date alone is given, retrieves the transactions from given date to today.If end date alone is given, retrieves the last 1M transactions prior to the given end date.If period is given, retrieves th","summary":"Retrieves the statement details for the given account","tags":["RETAIL"],"parameters":[{"name":"accountId","in":"path","type":"string","required":true,"description":"Identifier of the account. Often referred to as the account number, yet for consistency this is always referred to as accountId. Accepts both IBAN & BBAN"},{"name":"fromDate","in":"query","type":"string","required":false,"description":"Indicates the business date from when the balance reservation event is active."},{"name":"toDate","in":"query","type":"string","required":false,"description":"Indicates the business date until when the balance reservation event is active."},{"name":"transactionReference","in":"query","type":"string","required":false,"description":"Contains the identifier for the transaction in the core system"},{"name":"period","in":"query","type":"string","required":false,"description":"Indicates spread of time buckets.Ex: 3M,6M,9M,10Y etc."},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"AccountStatementResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"PUT","path":"/holdings/accounts/savingsAccounts/{savingsAccountId}/payoffCalculations","fullPath":"/api/v6.1.0/holdings/accounts/savingsAccounts/{savingsAccountId}/payoffCalculations","operationId":"calculatePayoffSavingsAccounts","name":"Calculate the payoff amount for the savings account which includes the outstanding amounts and also amounts such as account balances, interest, and charge amounts","summary":"Calculate the outstanding amount to close the savings account","tags":["OTHERS"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"savingsAccountId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"customerIds":[{}],"properties":[{}],"overrides":[{}],"productId":"string","masterArrangementId":"string","roleName":"string","currencyId":"string","effectiveDate":"2024-01-01","activityId":"string","transactionAmount":0.0,"reason":"string","automaticRun":"string","simulationRunReference":"string","synchronous":"string","extensions":{}}},"responses":{"200":"calculatePayoffSavingsAccountsResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"PUT","path":"/holdings/accounts/savingsAccounts/{savingsAccountId}/payoffs","fullPath":"/api/v6.1.0/holdings/accounts/savingsAccounts/{savingsAccountId}/payoffs","operationId":"settlePayoffSavingsAccounts","name":"Perform the settlement of payoff amount for the savings account by providing the transaction amount, currency and also settlement instructions","summary":"Perform the settlement of payoff amount for the savings account","tags":["OTHERS"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"savingsAccountId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"currencyId":"string","effectiveDate":"2024-01-01","activityId":"string","transactionAmount":0.0,"contractId":"string","systemId":"string","externalEventStatus":"string","extensions":{},"settlement":[{}]}},"responses":{"200":"settlePayoffSavingsAccountsResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"PUT","path":"/holdings/accounts/currentAccounts/{currentAccountId}/payoffCalculations","fullPath":"/api/v6.1.0/holdings/accounts/currentAccounts/{currentAccountId}/payoffCalculations","operationId":"calculatePayoffCurrentAccounts","name":"Calculate the payoff amount for the current account which includes the outstanding amounts and also amounts such as account balances, interest, and charge amounts","summary":"Calculate the outstanding amount to close the current account","tags":["OTHERS"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"currentAccountId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"customerIds":[{}],"properties":[{}],"overrides":[{}],"productId":"string","masterArrangementId":"string","roleName":"string","currencyId":"string","effectiveDate":"2024-01-01","activityId":"string","transactionAmount":0.0,"reason":"string","automaticRun":"string","simulationRunReference":"string","synchronous":"string","extensions":{}}},"responses":{"200":"calculatePayoffCurrentAccountsResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"PUT","path":"/holdings/accounts/currentAccounts/{currentAccountId}/payoffs","fullPath":"/api/v6.1.0/holdings/accounts/currentAccounts/{currentAccountId}/payoffs","operationId":"settlePayoffCurrentAccounts","name":"Perform the settlement of payoff amount for the current account by providing the transaction amount, currency and also settlement instructions","summary":"Perform the settlement of payoff amount for the current account","tags":["OTHERS"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"currentAccountId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"currencyId":"string","effectiveDate":"2024-01-01","activityId":"string","transactionAmount":0.0,"contractId":"string","systemId":"string","externalEventStatus":"string","extensions":{},"settlement":[{}]}},"responses":{"200":"settlePayoffCurrentAccountsResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"PUT","path":"/holdings/accounts/currentAccounts/{currentAccountId}/accountClosures","fullPath":"/api/v6.1.0/holdings/accounts/currentAccounts/{currentAccountId}/accountClosures","operationId":"closeCurrentAccounts","name":"Perform the closure of the current account after settlement of payoff amount. The account moves to closed status based on the closure conditions defined in the system","summary":"Perform the closure of the current account after settlement of payoff amount","tags":["OTHERS"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"currentAccountId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"currencyId":"string","effectiveDate":"2024-01-01","activityId":"string","transactionAmount":0.0,"contractId":"string","systemId":"string","externalEventStatus":"string","extensions":{}}},"responses":{"200":"closeCurrentAccountsResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"PUT","path":"/holdings/accounts/savingsAccounts/{savingsAccountId}/accountClosures","fullPath":"/api/v6.1.0/holdings/accounts/savingsAccounts/{savingsAccountId}/accountClosures","operationId":"closeSavingsAccounts","name":"Perform the closure of the savings account after settlement of payoff amount. The account moves to closed status based on the closure conditions defined in the system","summary":"Perform the closure of the savings account after settlement of payoff amount","tags":["OTHERS"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"savingsAccountId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"currencyId":"string","effectiveDate":"2024-01-01","activityId":"string","transactionAmount":0.0,"contractId":"string","systemId":"string","externalEventStatus":"string","extensions":{}}},"responses":{"200":"closeSavingsAccountsResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"POST","path":"/holdings/accounts/simulations","fullPath":"/api/v6.1.0/holdings/accounts/simulations","operationId":"createAccountSimulation","name":"Creates a simulation for account product with the details such as customer identifier, account currency, etc.","summary":"Create simulation for account products","tags":["RETAIL"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"customerIds":[{}],"properties":[{}],"overrides":[{}],"productId":"string","masterArrangementId":"string","roleName":"string","currencyId":"string","effectiveDate":"2024-01-01","activityId":"string","transactionAmount":0.0,"reason":"string","automaticRun":"string","simulationRunReference":"string","synchronous":"string","extensions":{}}},"responses":{"200":"createAccountSimulationResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"GET","path":"/holdings/accounts/{accountId}","fullPath":"/api/v6.1.0/holdings/accounts/{accountId}","operationId":"getAccountDetails","name":"Retrieves the account specific information for internet banking users","summary":"Retrieves account details","tags":["OTHERS"],"parameters":[{"name":"accountId","in":"path","type":"string","required":true,"description":"Identifier of the account. Often referred to as the account number, yet for consistency this is always referred to as accountId. Accepts both IBAN & BBAN"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"AccountDetailsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"PUT","path":"/holdings/accounts/simulations/{simulationId}","fullPath":"/api/v6.1.0/holdings/accounts/simulations/{simulationId}","operationId":"updateAccountSimulation","name":"Amend a simulation for account product with the details such as customer identifier, account currency, etc.","summary":"Amend simulation for account products","tags":["RETAIL"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"simulationId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"customerIds":[{}],"properties":[{}],"overrides":[{}],"productId":"string","masterArrangementId":"string","roleName":"string","currencyId":"string","effectiveDate":"2024-01-01","activityId":"string","transactionAmount":0.0,"reason":"string","automaticRun":"string","simulationRunReference":"string","synchronous":"string","extensions":{}}},"responses":{"200":"updateAccountSimulationResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"PUT","path":"/holdings/accounts/arrangements/{arrangementId}/activities","fullPath":"/api/v6.1.0/holdings/accounts/arrangements/{arrangementId}/activities","operationId":"createAccountsArrangements","name":"Update an accounts arrangement","summary":"Update an accounts arrangement","tags":["RETAIL"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"arrangementId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"customerIds":[{}],"properties":[{}],"overrides":[{}],"productId":"string","masterArrangementId":"string","roleName":"string","currencyId":"string","effectiveDate":"2024-01-01","activityId":"string","transactionAmount":0.0,"reason":"string","simulationRunReference":"string","channel":"string","branch":"string","lineOfBusiness":"string"}},"responses":{"200":"createAccountsArrangementsResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"PUT","path":"/holdings/accounts/{accountId}/interests","fullPath":"/api/v6.1.0/holdings/accounts/{accountId}/interests","operationId":"updateAccountInterestCondition","name":"Update the debit interest conditions of the account such as interest rate, tier details, margin amount etc.","summary":"Update the debit interest conditions of an account","tags":["RETAIL"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"accountId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"partyIds":[{}],"partyRoles":[{}],"agentCustomerIds":[{}],"agentArrangementIds":[{}],"agentRoles":[{}],"arrangmentId":"string","productId":"string","activityId":"string","currency":"string","productVariation":"string","pricingSelection":"string","pricingPlan":"string","rewardsArrangementId":"string","tradeDate":"string","arrangementEffectiveDate":"string"}},"responses":{"200":"updateAccountInterestConditionResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"GET","path":"/holdings/accounts/{accountId}/facilities","fullPath":"/api/v6.1.0/holdings/accounts/{accountId}/facilities","operationId":"getAccountfacilities","name":"Retrieves the service availability for an account like block or unblock of cheque,card,sweep etc.,","summary":"Retrieves the service availability for an account","tags":["RETAIL"],"parameters":[{"name":"accountId","in":"path","type":"string","required":true,"description":"Identifier of the account. Often referred to as the account number, yet for consistency this is always referred to as accountId. Accepts both IBAN & BBAN"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"AccountfacilitiesResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"PUT","path":"/holdings/accounts/{accountId}/facilities","fullPath":"/api/v6.1.0/holdings/accounts/{accountId}/facilities","operationId":"updateAccountfacilities","name":"Update the service availability for an account like block or unblock of cheque,card,sweep etc.,","summary":"Update the service availability for an account","tags":["RETAIL"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"accountId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"partyIds":[{}],"partyRoles":[{}],"agentCustomerIds":[{}],"agentArrangementIds":[{}],"agentRoles":[{}],"arrangmentId":"string","productId":"string","activityId":"string","currency":"string","productVariation":"string","pricingSelection":"string","pricingPlan":"string","rewardsArrangementId":"string","tradeDate":"string","arrangementEffectiveDate":"string"}},"responses":{"200":"updateAccountfacilitiesResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"POST","path":"/holdings/accounts/businessAccount","fullPath":"/api/v6.1.0/holdings/accounts/businessAccount","operationId":"createBusinessAccount","name":"Creates a business banking account for a single customer or more than one customer(like a joint account relationship) with the customer identifier, customer role, account currency details","summary":"Creates a business banking account for a single or joint customer","tags":["RETAIL"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"customerIds":[{}],"properties":[{}],"overrides":[{}],"productId":"string","masterArrangementId":"string","roleName":"string","currencyId":"string","effectiveDate":"2024-01-01","activityId":"string","transactionAmount":0.0,"reason":"string","simulationRunReference":"string","channel":"string","branch":"string","lineOfBusiness":"string"}},"responses":{"200":"createBusinessAccountResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}}]},{"key":"holdings-accounts-service-v1.0.0","title":"Account management","version":"v1.0.0","description":"API to manage Account related services, for retrieving Balances, Transaction details, Card details, Emergency Blocks, Funds Diversion & Account Closures","endpointCount":16,"endpoints":[{"method":"GET","path":"/holdings/accounts/accountClosure/{accountId}","fullPath":"/api/v1.0.0/holdings/accounts/accountClosure/{accountId}","operationId":"getAccountClosure","name":"Retrieves the Account Closure Information of the Account such as Closure Date and Reason, Mode of Closure, Balances on the date of Closing and Pending Charges","summary":"Retrieves the Account Closure Information","tags":[],"parameters":[{"name":"accountId","in":"path","type":"string","required":true,"description":"Identifier of the account. Often referred to as the account number, yet for consistency this is always referred to as accountId. Accepts both IBAN & BBAN"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"The identifier of the underlying Entity/Company/Branch."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"AccountClosureResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/holdings/accounts/accountClosure/{accountId}","fullPath":"/api/v1.0.0/holdings/accounts/accountClosure/{accountId}","operationId":"updateAccountClosure","name":"Updates Account Closure Information for the specific Account such as Closure Date and Reason, Mode of Closure & Closing Charges","summary":"Updates Account Closure Information","tags":[],"parameters":[{"name":"accountId","in":"path","type":"string","required":true,"description":"Identifier of the account. Often referred to as the account number, yet for consistency this is always referred to as accountId. Accepts both IBAN & BBAN"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"The identifier of the underlying Entity/Company/Branch."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"accountCurrency":"string","closureDate":"2024-01-01T00:00:00Z","creditAccount":"string","capitaliseInterest":"string","chargeType":"string","chargeAmount":0.0,"closeMode":"string","ftId":"string","closureReason":"string","closureNotes":"string","onlineLedgerBalance":0.0,"onlineClearedBalance":0.0,"balancePayable":0.0,"totalCreditInterest":"string","totalDebitInterest":"string"}},"responses":{"200":"AccountClosureResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/holdings/accounts","fullPath":"/api/v1.0.0/holdings/accounts","operationId":"getAccounts","name":"Retrieves the Currency, Balances, Limit details and Arrangement details of an account","summary":"Retrieves list of Account details","tags":[],"parameters":[{"name":"accountId","in":"query","type":"string","required":false,"description":"Identifier of the account. Often referred to as the account number, yet for consistency this is always referred to as accountId. Accepts both IBAN & BBAN"},{"name":"customerId","in":"query","type":"string","required":false,"description":"Identifier of the customer"},{"name":"productId","in":"query","type":"string","required":false,"description":"Contains the unique identifier of the product, e.g. the product id of the arrangement account."},{"name":"currencyId","in":"query","type":"string","required":false,"description":"Identifier of the currency. This is the 3-letter ISO 4217 code of the currency."},{"name":"limitReference","in":"query","type":"string","required":false,"description":"Identifies the credit limit reference for the underlying account."},{"name":"arrangementId","in":"query","type":"string","required":false,"description":"Indicates an unique identifier of an account"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from t24 on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"The identifier of the underlying Entity/Company/Branch."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"AccountsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/accounts/{accountId}/transactions","fullPath":"/api/v1.0.0/holdings/accounts/{accountId}/transactions","operationId":"getAccountTransactions","name":"Retrieves the Transaction details of the Account such as Transaction references, Opening & Closing Balances, date of Transaction and Amount based on the range of date of specified","summary":"Retrieves Account transaction details","tags":[],"parameters":[{"name":"accountId","in":"path","type":"string","required":true,"description":"Identifier of the account. Often referred to as the account number, yet for consistency this is always referred to as accountId. Accepts both IBAN & BBAN"},{"name":"bookingDate","in":"query","type":"string","required":false,"description":"Business date on which the accounting entry was generated."},{"name":"processingDate","in":"query","type":"string","required":false,"description":"The date when payment instruction is processed in system."},{"name":"valueDate","in":"query","type":"string","required":false,"description":"Indicates the value date on which the underlying accounting entry is to be given value (for interest purposes)"},{"name":"description","in":"query","type":"string","required":false,"description":"Contains the description of purpose of the payment."},{"name":"reversalMarker","in":"query","type":"string","required":false,"description":"Denotes the flag which is set whenever any credit or reversal debit entries with future exposure dates are processed"},{"name":"includeSubAcct","in":"query","type":"string","required":false,"description":"Denotes the flag which needs to be set in order to allow the automatic creation of sub-accounts and the automatic distribution of transactions over sub-accounts"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from t24 on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"The identifier of the underlying Entity/Company/Branch."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"AccountTransactionsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/accounts/{accountId}/cards","fullPath":"/api/v1.0.0/holdings/accounts/{accountId}/cards","operationId":"getAccountCards","name":"Retrieves the Card details of the Account such as Card Number, Card Type & Status of the Card","summary":"Retrieves available Card details","tags":[],"parameters":[{"name":"accountId","in":"path","type":"string","required":true,"description":"Identifier of the account. Often referred to as the account number, yet for consistency this is always referred to as accountId. Accepts both IBAN & BBAN"},{"name":"cardIssueId","in":"query","type":"string","required":false,"description":"The identifier of the issued card formatted as cardType '.' cardNumber. E.g. VISA.1234567887654321 GC.1111222233334444 AB21.1111111122222222"},{"name":"issueDate","in":"query","type":"string","required":false,"description":"The date the item was issued."},{"name":"expiryDate","in":"query","type":"string","required":false,"description":"The date an agreement such as an arrangement, product, credit facility or limit is due to expire"},{"name":"cardStatus","in":"query","type":"string","required":false,"description":"Current status of the Card and following are the possible statuses are  - CARD.ISSUED - CARD.RETURNED - CARD.SCRAP - CARD.CANCEL - NOT.ACTIVATED - NOT.RECEIVED - ACTIVE - BLOCKED - EXPIRED"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from t24 on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"The identifier of the underlying Entity/Company/Branch."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"AccountCardsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/accounts/balances","fullPath":"/api/v1.0.0/holdings/accounts/balances","operationId":"getAccountBalanceToday","name":"Retrieves various types of balances such as Cleared, Online, Locked & Usabale Balance of the Account","summary":"Retrieves list of Account balances","tags":[],"parameters":[{"name":"accountId","in":"query","type":"string","required":false,"description":"Identifier of the account. Often referred to as the account number, yet for consistency this is always referred to as accountId. Accepts both IBAN & BBAN"},{"name":"customerId","in":"query","type":"string","required":false,"description":"Identifier of the customer"},{"name":"productId","in":"query","type":"string","required":false,"description":"Contains the unique identifier of the product, e.g. the product id of the arrangement account."},{"name":"currencyId","in":"query","type":"string","required":false,"description":"Identifier of the currency. This is the 3-letter ISO 4217 code of the currency."},{"name":"limitReferenceId","in":"query","type":"string","required":false,"description":"Limit reference identifier for the limit order."},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from t24 on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"The identifier of the underlying Entity/Company/Branch."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"AccountBalanceTodayResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/accounts/{accountId}/balanceMovements/{bookingDate}","fullPath":"/api/v1.0.0/holdings/accounts/{accountId}/balanceMovements/{bookingDate}","operationId":"getAccountBalanceMovement","name":"Retrieves the credit, debit and gross balance movements for an Account for the requested booking date","summary":"Retrieves balances movements of Account","tags":[],"parameters":[{"name":"accountId","in":"path","type":"string","required":true,"description":"Identifier of the account. Often referred to as the account number, yet for consistency this is always referred to as accountId. Accepts both IBAN & BBAN"},{"name":"bookingDate","in":"path","type":"string","required":true,"description":"Business date on which the accounting entry was generated."},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from t24 on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"The identifier of the underlying Entity/Company/Branch."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"AccountBalanceMovementResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"PUT","path":"/holdings/accounts/{accountId}/emergencyBlockStatus","fullPath":"/api/v1.0.0/holdings/accounts/{accountId}/emergencyBlockStatus","operationId":"updateAccountEmergencyBlock","name":"Updates emergency block status & reason for the account","summary":"Update Emergency block in Account","tags":[],"parameters":[{"name":"accountId","in":"path","type":"string","required":true,"description":"Identifier of the account. Often referred to as the account number, yet for consistency this is always referred to as accountId. Accepts both IBAN & BBAN"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"The identifier of the underlying Entity/Company/Branch."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"emergencyBlock":"string","emergencyReason":"string"}},"responses":{"200":"AccountEmergencyBlockResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/holdings/accounts/{accountId}/fundsAuthorisationStatus","fullPath":"/api/v1.0.0/holdings/accounts/{accountId}/fundsAuthorisationStatus","operationId":"updateAccountFundsAuthStatus","name":"Update the funds authorisation status for the account, for example SYNC or ERROR","summary":"Update Funds Authorisation status","tags":[],"parameters":[{"name":"accountId","in":"path","type":"string","required":true,"description":""},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"The identifier of the underlying Entity/Company/Branch."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"faStatus":"string"}},"responses":{"200":"AccountFundsAuthStatusResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"POST","path":"/holdings/accounts/{parameterId}/fundsDiversion","fullPath":"/api/v1.0.0/holdings/accounts/{parameterId}/fundsDiversion","operationId":"createFundsDiversion","name":"Allows creation of funds diversion conditions for a company to manage the behavior of booking funds against any account in the company that has the auto pay account defined","summary":"Creates conditions for funds diversion","tags":[],"parameters":[{"name":"parameterId","in":"path","type":"string","required":true,"description":"Identifies the record key of a Parameter table,that acts as a key to access the information specific to them. This holds system or a company as its value."},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"The identifier of the underlying Entity/Company/Branch."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"transactionCodes":[{}],"defaultFundsDiversion":"string"}},"responses":{"200":"FundsDiversionResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/holdings/accounts/{parameterId}/fundsDiversion","fullPath":"/api/v1.0.0/holdings/accounts/{parameterId}/fundsDiversion","operationId":"updateFundsDiversion","name":"Updates the funds diversion conditions for a company to manage the behavior of booking funds against any account in the company that has the auto pay account defined","summary":"Updates funds diversion parameter","tags":[],"parameters":[{"name":"parameterId","in":"path","type":"string","required":true,"description":"Identifies the record key of a Parameter table,that acts as a key to access the information specific to them. This holds system or a company as its value."},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"The identifier of the underlying Entity/Company/Branch."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"transactionCodes":[{}],"defaultFundsDiversion":"string"}},"responses":{"200":"FundsDiversionResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/holdings/nostros/forwardBalances","fullPath":"/api/v1.0.0/holdings/nostros/forwardBalances","operationId":"getNostroForwardBalances","name":"Retrieves forward balances of nostro accounts considering the transaction effective dates.","summary":"Retrieves consolidated nostro account balances","tags":[],"parameters":[{"name":"valueDate","in":"query","type":"string","required":true,"description":"Indicates the value date on which the underlying accounting entry is to be given value (for interest purposes)"},{"name":"accountId","in":"query","type":"string","required":false,"description":"Identifier of the account. Often referred to as the account number, yet for consistency this is always referred to as accountId. Accepts both IBAN & BBAN"},{"name":"longPositionSign","in":"query","type":"string","required":false,"description":"Polarity (sign) used to denote buy position balance.  "},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from t24 on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"The identifier of the underlying Entity/Company/Branch."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"NostroForwardBalancesResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/nostros/currencyBalances/{currencyId}/accounts","fullPath":"/api/v1.0.0/holdings/nostros/currencyBalances/{currencyId}/accounts","operationId":"getNostroBalances","name":"Retrieves the date wise balances of the Nostro Accounts that falls under a specific Currency","summary":"Retrieves nostro balances for a Specific Currency Accounts","tags":[],"parameters":[{"name":"currencyId","in":"path","type":"string","required":true,"description":"Identifier of the currency. This is the 3-letter ISO 4217 code of the currency."},{"name":"nostroId","in":"query","type":"string","required":false,"description":"Nostro account id"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from t24 on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"The identifier of the underlying Entity/Company/Branch."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"NostroBalancesResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/nostros/currencyBalances/{currencyId}","fullPath":"/api/v1.0.0/holdings/nostros/currencyBalances/{currencyId}","operationId":"getNostroCurrencyPositions","name":"Retrieves consolidated balances of the nostro accounts in a given currency from the current date to the next five days.","summary":"Retrieves consolidated nostro account balances for a specific currency","tags":[],"parameters":[{"name":"currencyId","in":"path","type":"string","required":true,"description":"Identifier of the currency. This is the 3-letter ISO 4217 code of the currency."},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from t24 on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"The identifier of the underlying Entity/Company/Branch."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"NostroCurrencyPositionsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/nostros/positions/{currencyId}","fullPath":"/api/v1.0.0/holdings/nostros/positions/{currencyId}","operationId":"getNostroPositions","name":"Retrieves nostro account balances for a given currency from the current date to the next five days.Provides nostro-to-nostro account transfer facility within the same currency.","summary":"Retrieves consolidated nostro account Positions of Currency","tags":[],"parameters":[{"name":"currencyId","in":"path","type":"string","required":true,"description":"Identifier of the currency. This is the 3-letter ISO 4217 code of the currency."},{"name":"longPositionSign","in":"query","type":"string","required":false,"description":"Polarity (sign) used to denote buy position balance.  "},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from t24 on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"The identifier of the underlying Entity/Company/Branch."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"NostroPositionsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/accounts/lists","fullPath":"/api/v1.0.0/holdings/accounts/lists","operationId":"getAccountList","name":"Retrieves the List of Accounts Basic Information such as Account Name, Customer, Currency, Category and Balance","summary":"Retrieves the List of Accounts Basic Information","tags":[],"parameters":[{"name":"accountId","in":"query","type":"string","required":false,"description":"Identifier of the account. Often referred to as the account number, yet for consistency this is always referred to as accountId. Accepts both IBAN & BBAN"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from t24 on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"The identifier of the underlying Entity/Company/Branch."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"AccountListResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}}]},{"key":"holdings-accounts-service-v1.1.0","title":"Holdings Accounts APIs Deprecated","version":"v1.1.0","description":"Retrieves balances, cards and transaction information on accounts ","endpointCount":2,"endpoints":[{"method":"GET","path":"/holdings/accounts/{accountId}","fullPath":"/api/v1.1.0/holdings/accounts/{accountId}","operationId":"getAccountDetails","name":"Retrieves the overall details of account for a specific customer - Deprecated. Use holdings-accounts-service-v4.0.0 instead","summary":"Retrieves the details of account","tags":[],"parameters":[{"name":"accountId","in":"path","type":"string","required":true,"description":""},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"AccountDetailsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/loans/{loanId}","fullPath":"/api/v1.1.0/holdings/loans/{loanId}","operationId":"getLoanDetails","name":"Retrieves the overall details of loan account for a specific customer - Deprecated. Use holdings-loans-service-v2.0.0 instead","summary":"Retrieves the details of loan account","tags":[],"parameters":[{"name":"loanId","in":"path","type":"string","required":true,"description":""},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"LoanDetailsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}}]},{"key":"holdings-accounts-service-v2.0.0","title":"Account management","version":"v2.0.0","description":"API to manage Account related services, for retrieving Balances, Transaction details, Card details, Emergency Blocks, Funds Diversion & Account Closures","endpointCount":22,"endpoints":[{"method":"GET","path":"/holdings/accounts/accountClosure/{accountId}","fullPath":"/api/v2.0.0/holdings/accounts/accountClosure/{accountId}","operationId":"getAccountClosure","name":"Retrieves the Account Closure Information of the Account such as Closure Date and Reason, Mode of Closure, Balances on the date of Closing and Pending Charges","summary":"Retrieves the Account Closure Information","tags":[],"parameters":[{"name":"accountId","in":"path","type":"string","required":true,"description":"Identifier of the account. Often referred to as the account number, yet for consistency this is always referred to as accountId. Accepts both IBAN & BBAN"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"The identifier of the underlying Entity/Company/Branch."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"AccountClosureResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/holdings/accounts/accountClosure/{accountId}","fullPath":"/api/v2.0.0/holdings/accounts/accountClosure/{accountId}","operationId":"updateAccountClosure","name":"Updates Account Closure Information for the specific Account such as Closure Date and Reason, Mode of Closure & Closing Charges","summary":"Updates Account Closure Information","tags":[],"parameters":[{"name":"accountId","in":"path","type":"string","required":true,"description":"Identifier of the account. Often referred to as the account number, yet for consistency this is always referred to as accountId. Accepts both IBAN & BBAN"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"The identifier of the underlying Entity/Company/Branch."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"accountCurrency":"string","closureDate":"2024-01-01T00:00:00Z","creditAccount":"string","capitaliseInterest":"string","chargeType":"string","chargeAmount":0.0,"closeMode":"string","ftId":"string","closureReason":"string","closureNotes":"string","onlineLedgerBalance":0.0,"onlineClearedBalance":0.0,"balancePayable":0.0,"totalCreditInterest":"string","totalDebitInterest":"string"}},"responses":{"200":"AccountClosureResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/holdings/accounts","fullPath":"/api/v2.0.0/holdings/accounts","operationId":"getAccounts","name":"Retrieves the Currency, Balances, Limit details and Arrangement details of an account","summary":"Retrieves list of Account details","tags":[],"parameters":[{"name":"accountId","in":"query","type":"string","required":false,"description":"Identifier of the account. Often referred to as the account number, yet for consistency this is always referred to as accountId. Accepts both IBAN & BBAN"},{"name":"customerId","in":"query","type":"string","required":false,"description":"Identifier of the customer"},{"name":"productId","in":"query","type":"string","required":false,"description":"Contains the unique identifier of the product, e.g. the product id of the arrangement account."},{"name":"currencyId","in":"query","type":"string","required":false,"description":"Identifier of the currency. This is the 3-letter ISO 4217 code of the currency."},{"name":"limitReference","in":"query","type":"string","required":false,"description":"Identifies the credit limit reference for the underlying account."},{"name":"arrangementId","in":"query","type":"string","required":false,"description":"Indicates an unique identifier of an account"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from t24 on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"The identifier of the underlying Entity/Company/Branch."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"AccountsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/accounts/{accountId}/transactions","fullPath":"/api/v2.0.0/holdings/accounts/{accountId}/transactions","operationId":"getAccountTransactions","name":"Retrieves the Transaction details of the Account such as Transaction references, Opening & Closing Balances, date of Transaction and Amount based on the range of date of specified","summary":"Retrieves Account transaction details","tags":[],"parameters":[{"name":"accountId","in":"path","type":"string","required":true,"description":"Identifier of the account. Often referred to as the account number, yet for consistency this is always referred to as accountId. Accepts both IBAN & BBAN"},{"name":"bookingDate","in":"query","type":"string","required":false,"description":"Business date on which the accounting entry was generated."},{"name":"processingDate","in":"query","type":"string","required":false,"description":"The date when payment instruction is processed in system."},{"name":"valueDate","in":"query","type":"string","required":false,"description":"Indicates the value date on which the underlying accounting entry is to be given value (for interest purposes)"},{"name":"description","in":"query","type":"string","required":false,"description":"Contains the description of purpose of the payment."},{"name":"reversalMarker","in":"query","type":"string","required":false,"description":"Denotes the flag which is set whenever any credit or reversal debit entries with future exposure dates are processed"},{"name":"includeSubAcct","in":"query","type":"string","required":false,"description":"Denotes the flag which needs to be set in order to allow the automatic creation of sub-accounts and the automatic distribution of transactions over sub-accounts"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from t24 on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"The identifier of the underlying Entity/Company/Branch."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"AccountTransactionsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/accounts/{accountId}/cards","fullPath":"/api/v2.0.0/holdings/accounts/{accountId}/cards","operationId":"getAccountCards","name":"Retrieves the Card details of the Account such as Card Number, Card Type & Status of the Card","summary":"Retrieves available Card details","tags":[],"parameters":[{"name":"accountId","in":"path","type":"string","required":true,"description":"Identifier of the account. Often referred to as the account number, yet for consistency this is always referred to as accountId. Accepts both IBAN & BBAN"},{"name":"cardIssueId","in":"query","type":"string","required":false,"description":"The identifier of the issued card formatted as cardType '.' cardNumber. E.g. VISA.1234567887654321 GC.1111222233334444 AB21.1111111122222222"},{"name":"issueDate","in":"query","type":"string","required":false,"description":"The date the item was issued."},{"name":"expiryDate","in":"query","type":"string","required":false,"description":"The date an agreement such as an arrangement, product, credit facility or limit is due to expire"},{"name":"cardStatus","in":"query","type":"string","required":false,"description":"Current status of the Card and following are the possible statuses are  - CARD.ISSUED - CARD.RETURNED - CARD.SCRAP - CARD.CANCEL - NOT.ACTIVATED - NOT.RECEIVED - ACTIVE - BLOCKED - EXPIRED"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from t24 on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"The identifier of the underlying Entity/Company/Branch."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"AccountCardsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/accounts/balances","fullPath":"/api/v2.0.0/holdings/accounts/balances","operationId":"getAccountBalanceToday","name":"Retrieves various types of balances such as Cleared, Online, Locked & Usabale Balance of the Account","summary":"Retrieves list of Account balances","tags":[],"parameters":[{"name":"accountId","in":"query","type":"string","required":false,"description":"Identifier of the account. Often referred to as the account number, yet for consistency this is always referred to as accountId. Accepts both IBAN & BBAN"},{"name":"customerId","in":"query","type":"string","required":false,"description":"Identifier of the customer"},{"name":"productId","in":"query","type":"string","required":false,"description":"Contains the unique identifier of the product, e.g. the product id of the arrangement account."},{"name":"currencyId","in":"query","type":"string","required":false,"description":"Identifier of the currency. This is the 3-letter ISO 4217 code of the currency."},{"name":"limitReferenceId","in":"query","type":"string","required":false,"description":"Limit reference identifier for the limit order."},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from t24 on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"The identifier of the underlying Entity/Company/Branch."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"AccountBalanceTodayResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/accounts/{accountId}/balanceMovements/{bookingDate}","fullPath":"/api/v2.0.0/holdings/accounts/{accountId}/balanceMovements/{bookingDate}","operationId":"getAccountBalanceMovement","name":"Retrieves the credit, debit and gross balance movements for an Account for the requested booking date","summary":"Retrieves balances movements of Account","tags":[],"parameters":[{"name":"accountId","in":"path","type":"string","required":true,"description":"Identifier of the account. Often referred to as the account number, yet for consistency this is always referred to as accountId. Accepts both IBAN & BBAN"},{"name":"bookingDate","in":"path","type":"string","required":true,"description":"Business date on which the accounting entry was generated."},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from t24 on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"The identifier of the underlying Entity/Company/Branch."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"AccountBalanceMovementResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"PUT","path":"/holdings/accounts/{accountId}/emergencyBlockStatus","fullPath":"/api/v2.0.0/holdings/accounts/{accountId}/emergencyBlockStatus","operationId":"updateAccountEmergencyBlock","name":"Updates emergency block status & reason for the account","summary":"Update Emergency block in Account","tags":[],"parameters":[{"name":"accountId","in":"path","type":"string","required":true,"description":"Identifier of the account. Often referred to as the account number, yet for consistency this is always referred to as accountId. Accepts both IBAN & BBAN"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"The identifier of the underlying Entity/Company/Branch."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"emergencyBlock":"string","emergencyReason":"string"}},"responses":{"200":"AccountEmergencyBlockResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/holdings/accounts/{accountId}/fundsAuthorisationStatus","fullPath":"/api/v2.0.0/holdings/accounts/{accountId}/fundsAuthorisationStatus","operationId":"updateAccountFundsAuthStatus","name":"Update the funds authorisation status for the account, for example SYNC or ERROR","summary":"Update Funds Authorisation status","tags":[],"parameters":[{"name":"accountId","in":"path","type":"string","required":true,"description":""},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"The identifier of the underlying Entity/Company/Branch."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"faStatus":"string"}},"responses":{"200":"AccountFundsAuthStatusResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"POST","path":"/holdings/accounts/{parameterId}/fundsDiversion","fullPath":"/api/v2.0.0/holdings/accounts/{parameterId}/fundsDiversion","operationId":"createFundsDiversion","name":"Allows creation of funds diversion conditions for a company to manage the behavior of booking funds against any account in the company that has the auto pay account defined","summary":"Creates conditions for funds diversion","tags":[],"parameters":[{"name":"parameterId","in":"path","type":"string","required":true,"description":"Identifies the record key of a Parameter table,that acts as a key to access the information specific to them. This holds system or a company as its value."},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"The identifier of the underlying Entity/Company/Branch."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"transactionCodes":[{}],"defaultFundsDiversion":"string"}},"responses":{"200":"FundsDiversionResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/holdings/accounts/{parameterId}/fundsDiversion","fullPath":"/api/v2.0.0/holdings/accounts/{parameterId}/fundsDiversion","operationId":"updateFundsDiversion","name":"Updates the funds diversion conditions for a company to manage the behavior of booking funds against any account in the company that has the auto pay account defined","summary":"Updates funds diversion parameter","tags":[],"parameters":[{"name":"parameterId","in":"path","type":"string","required":true,"description":"Identifies the record key of a Parameter table,that acts as a key to access the information specific to them. This holds system or a company as its value."},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"The identifier of the underlying Entity/Company/Branch."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"transactionCodes":[{}],"defaultFundsDiversion":"string"}},"responses":{"200":"FundsDiversionResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/holdings/nostros/forwardBalances","fullPath":"/api/v2.0.0/holdings/nostros/forwardBalances","operationId":"getNostroForwardBalances","name":"Retrieves forward balances of nostro accounts considering the transaction effective dates.","summary":"Retrieves consolidated nostro account balances","tags":[],"parameters":[{"name":"valueDate","in":"query","type":"string","required":true,"description":"Indicates the value date on which the underlying accounting entry is to be given value (for interest purposes)"},{"name":"accountId","in":"query","type":"string","required":false,"description":"Identifier of the account. Often referred to as the account number, yet for consistency this is always referred to as accountId. Accepts both IBAN & BBAN"},{"name":"longPositionSign","in":"query","type":"string","required":false,"description":"Polarity (sign) used to denote buy position balance.  "},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from t24 on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"The identifier of the underlying Entity/Company/Branch."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"NostroForwardBalancesResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/nostros/currencyBalances/{currencyId}/accounts","fullPath":"/api/v2.0.0/holdings/nostros/currencyBalances/{currencyId}/accounts","operationId":"getNostroBalances","name":"Retrieves the date wise balances of the Nostro Accounts that falls under a specific Currency","summary":"Retrieves nostro balances for a Specific Currency Accounts","tags":[],"parameters":[{"name":"currencyId","in":"path","type":"string","required":true,"description":"Identifier of the currency. This is the 3-letter ISO 4217 code of the currency."},{"name":"nostroId","in":"query","type":"string","required":false,"description":"Nostro account id"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from t24 on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"The identifier of the underlying Entity/Company/Branch."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"NostroBalancesResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/nostros/currencyBalances/{currencyId}","fullPath":"/api/v2.0.0/holdings/nostros/currencyBalances/{currencyId}","operationId":"getNostroCurrencyPositions","name":"Retrieves consolidated balances of the nostro accounts in a given currency from the current date to the next five days.","summary":"Retrieves consolidated nostro account balances for a specific currency","tags":[],"parameters":[{"name":"currencyId","in":"path","type":"string","required":true,"description":"Identifier of the currency. This is the 3-letter ISO 4217 code of the currency."},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from t24 on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"The identifier of the underlying Entity/Company/Branch."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"NostroCurrencyPositionsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/nostros/positions/{currencyId}","fullPath":"/api/v2.0.0/holdings/nostros/positions/{currencyId}","operationId":"getNostroPositions","name":"Retrieves nostro account balances for a given currency from the current date to the next five days.Provides nostro-to-nostro account transfer facility within the same currency.","summary":"Retrieves consolidated nostro account Positions of Currency","tags":[],"parameters":[{"name":"currencyId","in":"path","type":"string","required":true,"description":"Identifier of the currency. This is the 3-letter ISO 4217 code of the currency."},{"name":"longPositionSign","in":"query","type":"string","required":false,"description":"Polarity (sign) used to denote buy position balance.  "},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from t24 on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"The identifier of the underlying Entity/Company/Branch."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"NostroPositionsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/accounts/lists","fullPath":"/api/v2.0.0/holdings/accounts/lists","operationId":"getAccountList","name":"Retrieves the List of Accounts Basic Information such as Account Name, Customer, Currency, Category and Balance","summary":"Retrieves the List of Accounts Basic Information","tags":[],"parameters":[{"name":"accountId","in":"query","type":"string","required":false,"description":"Identifier of the account. Often referred to as the account number, yet for consistency this is always referred to as accountId. Accepts both IBAN & BBAN"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from t24 on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"The identifier of the underlying Entity/Company/Branch."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"AccountListResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/accounts/reservedFunds","fullPath":"/api/v2.0.0/holdings/accounts/reservedFunds","operationId":"getReservedFunds","name":"Retrieves the list of reserved funds ","summary":"Retrieves the list of reserved funds ","tags":[],"parameters":[{"name":"accountId","in":"query","type":"string","required":false,"description":"Identifier of the account. Often referred to as the account number, yet for consistency this is always referred to as accountId. Accepts both IBAN & BBAN"},{"name":"eventId","in":"query","type":"string","required":false,"description":"Event identifier"},{"name":"lockReason","in":"query","type":"string","required":false,"description":"Indicates the simple description for the balance reservation event."},{"name":"fromDate","in":"query","type":"string","required":false,"description":"Indicates the business date from when the balance reservation event is active."},{"name":"toDate","in":"query","type":"string","required":false,"description":"Indicates the business date until when the balance reservation event is active."},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from t24 on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"The identifier of the underlying Entity/Company/Branch."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"ReservedFundsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/accounts/{accountId}","fullPath":"/api/v2.0.0/holdings/accounts/{accountId}","operationId":"getAccountDetails","name":"Retrieves the account specific information for Internet Banking Users","summary":"Retrieves account details","tags":[],"parameters":[{"name":"accountId","in":"path","type":"string","required":true,"description":"Identifier of the account. Often referred to as the account number, yet for consistency this is always referred to as accountId. Accepts both IBAN & BBAN"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from t24 on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"The identifier of the underlying Entity/Company/Branch."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"AccountDetailsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/accounts/proxyIdentifiers","fullPath":"/api/v2.0.0/holdings/accounts/proxyIdentifiers","operationId":"getActiveProxyIdentifier","name":"Retrieve active records from Proxy directory for a given customer number/account number/proxy type and proxy identifier","summary":"API to check proxy Registration Status","tags":[],"parameters":[{"name":"customerId","in":"query","type":"string","required":false,"description":"Identifier of the customer"},{"name":"alternateAccountId","in":"query","type":"string","required":false,"description":"Alternate identification for an account"},{"name":"proxyType","in":"query","type":"string","required":false,"description":"Type of proxy created for account"},{"name":"proxyIdentifier","in":"query","type":"string","required":false,"description":"A proxy identifier to be linked to an account based on the proxy type provided eg. Mobile number, email id and tax id"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from t24 on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"The identifier of the underlying Entity/Company/Branch."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"ActiveProxyIdentifierResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"POST","path":"/holdings/accounts/proxyIdentifiers","fullPath":"/api/v2.0.0/holdings/accounts/proxyIdentifiers","operationId":"createProxyIdentifier","name":"Create a  new record in Proxy directory to Register the supplied Proxy Identifiers","summary":"API to register proxy identifier","tags":[],"parameters":[{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"The identifier of the underlying Entity/Company/Branch."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"customerId":"string","accountId":"string","alternateAccountId":"string","proxyType":"string","proxyIdentifier":"string","proxyStatus":"string","proxyScheme":"string","proxyRole":"string"}},"responses":{"200":"ProxyIdentifierResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/holdings/accounts/proxyIdentifiers/{proxyIdentifierId}","fullPath":"/api/v2.0.0/holdings/accounts/proxyIdentifiers/{proxyIdentifierId}","operationId":"updateProxyIdentifier","name":"Update the existing proxy directory to De-Register a Proxy Identifiers","summary":"API to De-register proxy identifier","tags":[],"parameters":[{"name":"proxyIdentifierId","in":"path","type":"string","required":true,"description":""},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"The identifier of the underlying Entity/Company/Branch."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"customerId":"string","accountId":"string","alternateAccountId":"string","proxyType":"string","proxyIdentifier":"string","proxyStatus":"string","proxyScheme":"string","proxyRole":"string"}},"responses":{"200":"ProxyIdentifierResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/holdings/accounts/{accountId}/{accountCompany}/{paymentCurrency}/{accountSwitch}/payments","fullPath":"/api/v2.0.0/holdings/accounts/{accountId}/{accountCompany}/{paymentCurrency}/{accountSwitch}/payments","operationId":"getAccountPaymentDetails","name":"Retrieves the account information that are required for processing or validating an account involved in a payment transaction. Provides the information such as account name, customer number, account type, account currency, IBAN, account switch details, account status (ACTIVE or INACTIVE) and account closure details.","summary":"Retrieves account details required for payment processing","tags":[],"parameters":[{"name":"accountId","in":"path","type":"string","required":true,"description":"Identifier of the account. Often referred to as the account number, yet for consistency this is always referred to as accountId. Accepts both IBAN & BBAN"},{"name":"accountCompany","in":"path","type":"string","required":true,"description":"Company of the account to be created"},{"name":"paymentCurrency","in":"path","type":"string","required":true,"description":"This field holds the transaction currency or currency in which payment is initiated. "},{"name":"accountSwitch","in":"path","type":"string","required":true,"description":"Indicates if availability of account switch details should be checked."},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from t24 on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"The identifier of the underlying Entity/Company/Branch."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"AccountPaymentDetailsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}}]},{"key":"holdings-accounts-service-v3.0.0","title":"Account management","version":"v3.0.0","description":"API to manage Account related services, for retrieving Balances, Transaction details, Card details, Emergency Blocks, Funds Diversion & Account Closures","endpointCount":25,"endpoints":[{"method":"GET","path":"/holdings/accounts/accountClosure/{accountId}","fullPath":"/api/v3.0.0/holdings/accounts/accountClosure/{accountId}","operationId":"getAccountClosure","name":"Retrieves the Account Closure Information of the Account such as Closure Date and Reason, Mode of Closure, Balances on the date of Closing and Pending Charges","summary":"Retrieves the Account Closure Information","tags":[],"parameters":[{"name":"accountId","in":"path","type":"string","required":true,"description":"Identifier of the account. Often referred to as the account number, yet for consistency this is always referred to as accountId. Accepts both IBAN & BBAN"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"AccountClosureResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/holdings/accounts/accountClosure/{accountId}","fullPath":"/api/v3.0.0/holdings/accounts/accountClosure/{accountId}","operationId":"updateAccountClosure","name":"Updates Account Closure Information for the specific Account such as Closure Date and Reason, Mode of Closure & Closing Charges","summary":"Updates Account Closure Information","tags":[],"parameters":[{"name":"accountId","in":"path","type":"string","required":true,"description":"Identifier of the account. Often referred to as the account number, yet for consistency this is always referred to as accountId. Accepts both IBAN & BBAN"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"accountCurrency":"string","closureDate":"2024-01-01T00:00:00Z","creditAccount":"string","capitaliseInterest":"string","chargeType":"string","chargeAmount":0.0,"closeMode":"string","ftId":"string","closureReason":"string","closureNotes":"string","onlineLedgerBalance":0.0,"onlineClearedBalance":0.0,"balancePayable":0.0,"totalCreditInterest":"string","totalDebitInterest":"string"}},"responses":{"200":"AccountClosureResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/holdings/accounts/{accountId}/transactions","fullPath":"/api/v3.0.0/holdings/accounts/{accountId}/transactions","operationId":"getAccountTransactions","name":"Retrieves the Transaction details of the Account such as Transaction references, Opening & Closing Balances, date of Transaction and Amount based on the range of date of specified","summary":"Retrieves Account transaction details","tags":[],"parameters":[{"name":"accountId","in":"path","type":"string","required":true,"description":"Identifier of the account. Often referred to as the account number, yet for consistency this is always referred to as accountId. Accepts both IBAN & BBAN"},{"name":"bookingDate","in":"query","type":"string","required":false,"description":"Business date on which the accounting entry was generated."},{"name":"processingDate","in":"query","type":"string","required":false,"description":"The date when payment instruction is processed in system."},{"name":"valueDate","in":"query","type":"string","required":false,"description":"Indicates the value date on which the underlying accounting entry is to be given value (for interest purposes)"},{"name":"description","in":"query","type":"string","required":false,"description":"Contains the description of purpose of the payment."},{"name":"reversalMarker","in":"query","type":"string","required":false,"description":"Denotes the flag which is set whenever any credit or reversal debit entries with future exposure dates are processed"},{"name":"includeSubAcct","in":"query","type":"string","required":false,"description":"Denotes the flag which needs to be set in order to allow the automatic creation of sub-accounts and the automatic distribution of transactions over sub-accounts"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from t24 on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"AccountTransactionsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/accounts/{accountId}/cards","fullPath":"/api/v3.0.0/holdings/accounts/{accountId}/cards","operationId":"getAccountCards","name":"Retrieves the Card details of the Account such as Card Number, Card Type & Status of the Card","summary":"Retrieves available Card details","tags":[],"parameters":[{"name":"accountId","in":"path","type":"string","required":true,"description":"Identifier of the account. Often referred to as the account number, yet for consistency this is always referred to as accountId. Accepts both IBAN & BBAN"},{"name":"cardIssueId","in":"query","type":"string","required":false,"description":"The identifier of the issued card formatted as cardType '.' cardNumber. E.g. VISA.1234567887654321 GC.1111222233334444 AB21.1111111122222222"},{"name":"issueDate","in":"query","type":"string","required":false,"description":"The date the item was issued."},{"name":"expiryDate","in":"query","type":"string","required":false,"description":"The date an agreement such as an arrangement, product, credit facility or limit is due to expire"},{"name":"cardStatus","in":"query","type":"string","required":false,"description":"Current status of the Card and following are the possible statuses are  - CARD.ISSUED - CARD.RETURNED - CARD.SCRAP - CARD.CANCEL - NOT.ACTIVATED - NOT.RECEIVED - ACTIVE - BLOCKED - EXPIRED"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from t24 on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"AccountCardsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/accounts/balances","fullPath":"/api/v3.0.0/holdings/accounts/balances","operationId":"getAccountBalanceToday","name":"Retrieves various types of balances such as Cleared, Online, Locked & Usabale Balance of the Account","summary":"Retrieves list of Account balances","tags":[],"parameters":[{"name":"accountId","in":"query","type":"string","required":false,"description":"Identifier of the account. Often referred to as the account number, yet for consistency this is always referred to as accountId. Accepts both IBAN & BBAN"},{"name":"customerId","in":"query","type":"string","required":false,"description":"Identifier of the customer"},{"name":"productId","in":"query","type":"string","required":false,"description":"Contains the unique identifier of the product, e.g. the product id of the arrangement account."},{"name":"currencyId","in":"query","type":"string","required":false,"description":"Identifier of the currency. This is the 3-letter ISO 4217 code of the currency."},{"name":"limitReferenceId","in":"query","type":"string","required":false,"description":"Limit reference identifier for the limit order."},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from t24 on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"AccountBalanceTodayResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/accounts/{accountId}/balanceMovements/{bookingDate}","fullPath":"/api/v3.0.0/holdings/accounts/{accountId}/balanceMovements/{bookingDate}","operationId":"getAccountBalanceMovement","name":"Retrieves the credit, debit and gross balance movements for an Account for the requested booking date","summary":"Retrieves balances movements of Account","tags":[],"parameters":[{"name":"accountId","in":"path","type":"string","required":true,"description":"Identifier of the account. Often referred to as the account number, yet for consistency this is always referred to as accountId. Accepts both IBAN & BBAN"},{"name":"bookingDate","in":"path","type":"string","required":true,"description":"Business date on which the accounting entry was generated."},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from t24 on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"AccountBalanceMovementResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/accounts/{accountId}/emergencyBlocks/status","fullPath":"/api/v3.0.0/holdings/accounts/{accountId}/emergencyBlocks/status","operationId":"getAccountEmergencyBlock","name":"Retrieve emergency block status and reason for a given Account. This information will be used to assert the actual block status of an account in microservice","summary":"Retrieve emergency block information for an account","tags":[],"parameters":[{"name":"accountId","in":"path","type":"string","required":true,"description":"Identifier of the account. Often referred to as the account number, yet for consistency this is always referred to as accountId. Accepts both IBAN & BBAN"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from t24 on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"AccountEmergencyBlockResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"PUT","path":"/holdings/accounts/{accountId}/emergencyBlocks/status","fullPath":"/api/v3.0.0/holdings/accounts/{accountId}/emergencyBlocks/status","operationId":"updateAccountEmergencyBlock","name":"Updates emergency block status & reason for the account","summary":"Update Emergency block in Account","tags":[],"parameters":[{"name":"accountId","in":"path","type":"string","required":true,"description":"Identifier of the account. Often referred to as the account number, yet for consistency this is always referred to as accountId. Accepts both IBAN & BBAN"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"emergencyBlock":"string","emergencyReason":"string"}},"responses":{"200":"AccountEmergencyBlockResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/holdings/accounts/{accountId}/fundsAuthorisation/status","fullPath":"/api/v3.0.0/holdings/accounts/{accountId}/fundsAuthorisation/status","operationId":"getAccountFundsAuthStatus","name":"Retrieve the Funds Authorisation status from ACCOUNT","summary":"Retrieve Account Funds Authorisation status","tags":[],"parameters":[{"name":"accountId","in":"path","type":"string","required":true,"description":"Identifier of the account. Often referred to as the account number, yet for consistency this is always referred to as accountId. Accepts both IBAN & BBAN"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from t24 on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"AccountFundsAuthStatusResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"PUT","path":"/holdings/accounts/{accountId}/fundsAuthorisation/status","fullPath":"/api/v3.0.0/holdings/accounts/{accountId}/fundsAuthorisation/status","operationId":"updateAccountFundsAuthStatus","name":"Update the funds authorisation status for the account, for example SYNC or ERROR","summary":"Update Account Funds Authorisation status","tags":[],"parameters":[{"name":"accountId","in":"path","type":"string","required":true,"description":""},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"faStatus":"string"}},"responses":{"200":"AccountFundsAuthStatusResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"POST","path":"/holdings/accounts/{parameterId}/fundsDiversion","fullPath":"/api/v3.0.0/holdings/accounts/{parameterId}/fundsDiversion","operationId":"createFundsDiversion","name":"Allows creation of funds diversion conditions for a company to manage the behavior of booking funds against any account in the company that has the auto pay account defined","summary":"Creates conditions for funds diversion","tags":[],"parameters":[{"name":"parameterId","in":"path","type":"string","required":true,"description":"Identifies the record key of a Parameter table,that acts as a key to access the information specific to them. This holds system or a company as its value."},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"transactionCodes":[{}],"defaultFundsDiversion":"string"}},"responses":{"200":"FundsDiversionResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/holdings/accounts/{parameterId}/fundsDiversion","fullPath":"/api/v3.0.0/holdings/accounts/{parameterId}/fundsDiversion","operationId":"updateFundsDiversion","name":"Updates the funds diversion conditions for a company to manage the behavior of booking funds against any account in the company that has the auto pay account defined","summary":"Updates funds diversion parameter","tags":[],"parameters":[{"name":"parameterId","in":"path","type":"string","required":true,"description":"Identifies the record key of a Parameter table,that acts as a key to access the information specific to them. This holds system or a company as its value."},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"transactionCodes":[{}],"defaultFundsDiversion":"string"}},"responses":{"200":"FundsDiversionResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/holdings/nostros/forwardBalances","fullPath":"/api/v3.0.0/holdings/nostros/forwardBalances","operationId":"getNostroForwardBalances","name":"Retrieves forward balances of nostro accounts considering the transaction effective dates.","summary":"Retrieves consolidated nostro account balances","tags":[],"parameters":[{"name":"valueDate","in":"query","type":"string","required":true,"description":"Indicates the value date on which the underlying accounting entry is to be given value (for interest purposes)"},{"name":"accountId","in":"query","type":"string","required":false,"description":"Identifier of the account. Often referred to as the account number, yet for consistency this is always referred to as accountId. Accepts both IBAN & BBAN"},{"name":"longPositionSign","in":"query","type":"string","required":false,"description":"Polarity (sign) used to denote buy position balance.  "},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from t24 on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"NostroForwardBalancesResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/nostros/currencyBalances/{currencyId}/accounts","fullPath":"/api/v3.0.0/holdings/nostros/currencyBalances/{currencyId}/accounts","operationId":"getNostroBalances","name":"Retrieves the date wise balances of the Nostro Accounts that falls under a specific Currency","summary":"Retrieves nostro balances for a Specific Currency Accounts","tags":[],"parameters":[{"name":"currencyId","in":"path","type":"string","required":true,"description":"Identifier of the currency. This is the 3-letter ISO 4217 code of the currency."},{"name":"nostroId","in":"query","type":"string","required":false,"description":"Nostro account id"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from t24 on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"NostroBalancesResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/nostros/currencyBalances/{currencyId}","fullPath":"/api/v3.0.0/holdings/nostros/currencyBalances/{currencyId}","operationId":"getNostroCurrencyPositions","name":"Retrieves consolidated balances of the nostro accounts in a given currency from the current date to the next five days.","summary":"Retrieves consolidated nostro account balances for a specific currency","tags":[],"parameters":[{"name":"currencyId","in":"path","type":"string","required":true,"description":"Identifier of the currency. This is the 3-letter ISO 4217 code of the currency."},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from t24 on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"NostroCurrencyPositionsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/nostros/positions/{currencyId}","fullPath":"/api/v3.0.0/holdings/nostros/positions/{currencyId}","operationId":"getNostroPositions","name":"Retrieves nostro account balances for a given currency from the current date to the next five days.Provides nostro-to-nostro account transfer facility within the same currency.","summary":"Retrieves consolidated nostro account Positions of Currency","tags":[],"parameters":[{"name":"currencyId","in":"path","type":"string","required":true,"description":"Identifier of the currency. This is the 3-letter ISO 4217 code of the currency."},{"name":"longPositionSign","in":"query","type":"string","required":false,"description":"Polarity (sign) used to denote buy position balance.  "},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from t24 on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"NostroPositionsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/accounts/lists","fullPath":"/api/v3.0.0/holdings/accounts/lists","operationId":"getAccountList","name":" Use \"/holdings/accounts\"","summary":"Retrieves the List of Accounts Basic Information","tags":[],"parameters":[{"name":"accountId","in":"query","type":"string","required":false,"description":"Identifier of the account. Often referred to as the account number, yet for consistency this is always referred to as accountId. Accepts both IBAN & BBAN"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from t24 on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"AccountListResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/accounts/reservedFunds","fullPath":"/api/v3.0.0/holdings/accounts/reservedFunds","operationId":"getReservedFunds","name":"Retrieves the list of reserved funds ","summary":"Retrieves the list of reserved funds ","tags":[],"parameters":[{"name":"accountId","in":"query","type":"string","required":false,"description":"Identifier of the account. Often referred to as the account number, yet for consistency this is always referred to as accountId. Accepts both IBAN & BBAN"},{"name":"eventId","in":"query","type":"string","required":false,"description":"Event identifier"},{"name":"lockReason","in":"query","type":"string","required":false,"description":"Indicates the simple description for the balance reservation event."},{"name":"fromDate","in":"query","type":"string","required":false,"description":"Indicates the business date from when the balance reservation event is active."},{"name":"toDate","in":"query","type":"string","required":false,"description":"Indicates the business date until when the balance reservation event is active."},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from t24 on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"ReservedFundsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/accounts/{accountId}","fullPath":"/api/v3.0.0/holdings/accounts/{accountId}","operationId":"getAccountDetails","name":"Retrieves the account specific information for Internet Banking Users","summary":"Retrieves account details","tags":[],"parameters":[{"name":"accountId","in":"path","type":"string","required":true,"description":"Identifier of the account. Often referred to as the account number, yet for consistency this is always referred to as accountId. Accepts both IBAN & BBAN"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from t24 on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"AccountDetailsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/accounts/proxyIdentifiers","fullPath":"/api/v3.0.0/holdings/accounts/proxyIdentifiers","operationId":"getActiveProxyIdentifier","name":"Retrieve active records from Proxy directory for a given customer number/account number/proxy type and proxy identifier","summary":"API to check proxy Registration Status","tags":[],"parameters":[{"name":"customerId","in":"query","type":"string","required":false,"description":"Identifier of the customer"},{"name":"alternateAccountId","in":"query","type":"string","required":false,"description":"Alternate identification for an account"},{"name":"proxyType","in":"query","type":"string","required":false,"description":"Type of proxy created for account"},{"name":"proxyIdentifier","in":"query","type":"string","required":false,"description":"A proxy identifier to be linked to an account based on the proxy type provided eg. Mobile number, email id and tax id"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from t24 on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"ActiveProxyIdentifierResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"POST","path":"/holdings/accounts/proxyIdentifiers","fullPath":"/api/v3.0.0/holdings/accounts/proxyIdentifiers","operationId":"createProxyIdentifier","name":"Create a  new record in Proxy directory to Register the supplied Proxy Identifiers","summary":"API to register proxy identifier","tags":[],"parameters":[{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"customerId":"string","accountId":"string","alternateAccountId":"string","proxyType":"string","proxyIdentifier":"string","proxyStatus":"string","proxyScheme":"string","proxyRole":"string"}},"responses":{"200":"ProxyIdentifierResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/holdings/accounts/proxyIdentifiers/{proxyIdentifierId}","fullPath":"/api/v3.0.0/holdings/accounts/proxyIdentifiers/{proxyIdentifierId}","operationId":"updateProxyIdentifier","name":"Update the existing proxy directory to De-Register a Proxy Identifiers","summary":"API to De-register proxy identifier","tags":[],"parameters":[{"name":"proxyIdentifierId","in":"path","type":"string","required":true,"description":""},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"customerId":"string","accountId":"string","alternateAccountId":"string","proxyType":"string","proxyIdentifier":"string","proxyStatus":"string","proxyScheme":"string","proxyRole":"string"}},"responses":{"200":"ProxyIdentifierResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/holdings/accounts/{accountId}/{accountCompany}/{paymentCurrency}/{accountSwitch}/{beneficialCustomer}/payments","fullPath":"/api/v3.0.0/holdings/accounts/{accountId}/{accountCompany}/{paymentCurrency}/{accountSwitch}/{beneficialCustomer}/payments","operationId":"getAccountPaymentDetails","name":"Retrieves the account information that are required for processing or validating an account involved in a payment transaction. Provides the information such as account name, customer number, account type, account currency, IBAN, account switch details, account status (ACTIVE or INACTIVE) and account closure details.","summary":"Retrieves account details required for payment processing","tags":[],"parameters":[{"name":"accountId","in":"path","type":"string","required":true,"description":"Identifier of the account. Often referred to as the account number, yet for consistency this is always referred to as accountId. Accepts both IBAN & BBAN"},{"name":"accountCompany","in":"path","type":"string","required":true,"description":"Company of the account to be created"},{"name":"paymentCurrency","in":"path","type":"string","required":true,"description":"This field holds the transaction currency or currency in which payment is initiated. "},{"name":"accountSwitch","in":"path","type":"string","required":true,"description":"Indicates if availability of account switch details should be checked."},{"name":"beneficialCustomer","in":"path","type":"string","required":true,"description":"Indicates if beneficial owners of the account are to be retrieved"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from t24 on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"AccountPaymentDetailsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/accounts","fullPath":"/api/v3.0.0/holdings/accounts","operationId":"getAccounts","name":"Retrieves the Currency, Balances, Limit details and Arrangement details of an account","summary":"Retrieves list of Account details","tags":[],"parameters":[{"name":"accountId","in":"query","type":"string","required":false,"description":"Identifier of the account. Often referred to as the account number, yet for consistency this is always referred to as accountId. Accepts both IBAN & BBAN"},{"name":"customerId","in":"query","type":"string","required":false,"description":"Identifier of the customer"},{"name":"productId","in":"query","type":"string","required":false,"description":"Contains the unique identifier of the product, e.g. the product id of the arrangement account."},{"name":"currencyId","in":"query","type":"string","required":false,"description":"Identifier of the currency. This is the 3-letter ISO 4217 code of the currency."},{"name":"limitReference","in":"query","type":"string","required":false,"description":"Identifies the credit limit reference for the underlying account."},{"name":"arrangementId","in":"query","type":"string","required":false,"description":"Indicates an unique identifier of an account"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from t24 on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"AccountsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/accounts/{contractBalanceId}/contractBalances","fullPath":"/api/v3.0.0/holdings/accounts/{contractBalanceId}/contractBalances","operationId":"getContractBalances","name":"Retrieves the contract balances of accounts or contracts with details such as contract currency, balance types , credit and debit movements and opening and closing balance of the balance types","summary":"Retrieves Contract Balances of Accounts","tags":[],"parameters":[{"name":"contractBalanceId","in":"path","type":"string","required":true,"description":"Unique Identifier of Contract Balances"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from t24 on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"ContractBalancesResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}}]},{"key":"holdings-accounts-service-v4.0.0","title":"Account management","version":"v4.0.0","description":"API to manage Account related services, for retrieving Balances, Transaction details, Card details, Emergency Blocks, Funds Diversion & Account Closures","endpointCount":25,"endpoints":[{"method":"GET","path":"/holdings/accounts/accountClosure/{accountId}","fullPath":"/api/v4.0.0/holdings/accounts/accountClosure/{accountId}","operationId":"getAccountClosure","name":"Retrieves the Account Closure Information of the Account such as Closure Date and Reason, Mode of Closure, Balances on the date of Closing and Pending Charges","summary":"Retrieves the Account Closure Information","tags":[],"parameters":[{"name":"accountId","in":"path","type":"string","required":true,"description":"Identifier of the account. Often referred to as the account number, yet for consistency this is always referred to as accountId. Accepts both IBAN & BBAN"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"AccountClosureResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/holdings/accounts/accountClosure/{accountId}","fullPath":"/api/v4.0.0/holdings/accounts/accountClosure/{accountId}","operationId":"updateAccountClosure","name":"Updates Account Closure Information for the specific Account such as Closure Date and Reason, Mode of Closure & Closing Charges","summary":"Updates Account Closure Information","tags":[],"parameters":[{"name":"accountId","in":"path","type":"string","required":true,"description":"Identifier of the account. Often referred to as the account number, yet for consistency this is always referred to as accountId. Accepts both IBAN & BBAN"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"accountCurrency":"string","closureDate":"2024-01-01T00:00:00Z","creditAccount":"string","capitaliseInterest":"string","chargeType":"string","chargeAmount":0.0,"closeMode":"string","ftId":"string","closureReason":"string","closureNotes":"string","onlineLedgerBalance":0.0,"onlineClearedBalance":0.0,"balancePayable":0.0,"totalCreditInterest":"string","totalDebitInterest":"string"}},"responses":{"200":"AccountClosureResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/holdings/accounts/{accountId}/transactions","fullPath":"/api/v4.0.0/holdings/accounts/{accountId}/transactions","operationId":"getAccountTransactions","name":"Retrieves the Transaction details of the Account such as Transaction references, Opening & Closing Balances, date of Transaction and Amount based on the range of date of specified","summary":"Retrieves Account transaction details","tags":[],"parameters":[{"name":"accountId","in":"path","type":"string","required":true,"description":"Identifier of the account. Often referred to as the account number, yet for consistency this is always referred to as accountId. Accepts both IBAN & BBAN"},{"name":"bookingDate","in":"query","type":"string","required":false,"description":"Business date on which the accounting entry was generated."},{"name":"processingDate","in":"query","type":"string","required":false,"description":"The date when payment instruction is processed in system."},{"name":"valueDate","in":"query","type":"string","required":false,"description":"Indicates the value date on which the underlying accounting entry is to be given value (for interest purposes)"},{"name":"description","in":"query","type":"string","required":false,"description":"Contains the description of purpose of the payment."},{"name":"reversalMarker","in":"query","type":"string","required":false,"description":"Denotes the flag which is set whenever any credit or reversal debit entries with future exposure dates are processed"},{"name":"includeSubAcct","in":"query","type":"string","required":false,"description":"Denotes the flag which needs to be set in order to allow the automatic creation of sub-accounts and the automatic distribution of transactions over sub-accounts"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"AccountTransactionsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/accounts/{accountId}/cards","fullPath":"/api/v4.0.0/holdings/accounts/{accountId}/cards","operationId":"getAccountCards","name":"Retrieves the Card details of the Account such as Card Number, Card Type & Status of the Card","summary":"Retrieves available Card details","tags":[],"parameters":[{"name":"accountId","in":"path","type":"string","required":true,"description":"Identifier of the account. Often referred to as the account number, yet for consistency this is always referred to as accountId. Accepts both IBAN & BBAN"},{"name":"cardIssueId","in":"query","type":"string","required":false,"description":"The identifier of the issued card formatted as cardType '.' cardNumber. E.g. VISA.1234567887654321 GC.1111222233334444 AB21.1111111122222222"},{"name":"issueDate","in":"query","type":"string","required":false,"description":"The date the item was issued."},{"name":"expiryDate","in":"query","type":"string","required":false,"description":"The date an agreement such as an arrangement, product, credit facility or limit is due to expire"},{"name":"cardStatus","in":"query","type":"string","required":false,"description":"Current status of the Card and following are the possible statuses are  - CARD.ISSUED - CARD.RETURNED - CARD.SCRAP - CARD.CANCEL - NOT.ACTIVATED - NOT.RECEIVED - ACTIVE - BLOCKED - EXPIRED"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"AccountCardsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/accounts/balances","fullPath":"/api/v4.0.0/holdings/accounts/balances","operationId":"getAccountBalanceToday","name":"Retrieves various types of balances such as Cleared, Online, Locked & Usabale Balance of the Account","summary":"Retrieves list of Account balances","tags":[],"parameters":[{"name":"accountId","in":"query","type":"string","required":false,"description":"Identifier of the account. Often referred to as the account number, yet for consistency this is always referred to as accountId. Accepts both IBAN & BBAN"},{"name":"customerId","in":"query","type":"string","required":false,"description":"Identifier of the customer"},{"name":"productId","in":"query","type":"string","required":false,"description":"Contains the unique identifier of the product, e.g. the product id of the arrangement account."},{"name":"currencyId","in":"query","type":"string","required":false,"description":"Identifier of the currency. This is the 3-letter ISO 4217 code of the currency."},{"name":"limitReferenceId","in":"query","type":"string","required":false,"description":"Limit reference identifier for the limit order."},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"AccountBalanceTodayResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/accounts/{accountId}/balanceMovements/{bookingDate}","fullPath":"/api/v4.0.0/holdings/accounts/{accountId}/balanceMovements/{bookingDate}","operationId":"getAccountBalanceMovement","name":"Retrieves the credit, debit and gross balance movements for an Account for the requested booking date","summary":"Retrieves balances movements of Account","tags":[],"parameters":[{"name":"accountId","in":"path","type":"string","required":true,"description":"Identifier of the account. Often referred to as the account number, yet for consistency this is always referred to as accountId. Accepts both IBAN & BBAN"},{"name":"bookingDate","in":"path","type":"string","required":true,"description":"Business date on which the accounting entry was generated."},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"AccountBalanceMovementResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/accounts/{accountId}/emergencyBlocks/status","fullPath":"/api/v4.0.0/holdings/accounts/{accountId}/emergencyBlocks/status","operationId":"getAccountEmergencyBlock","name":"Retrieve emergency block status and reason for a given Account. This information will be used to assert the actual block status of an account in microservice","summary":"Retrieve emergency block information for an account","tags":[],"parameters":[{"name":"accountId","in":"path","type":"string","required":true,"description":"Identifier of the account. Often referred to as the account number, yet for consistency this is always referred to as accountId. Accepts both IBAN & BBAN"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"AccountEmergencyBlockResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"PUT","path":"/holdings/accounts/{accountId}/emergencyBlocks/status","fullPath":"/api/v4.0.0/holdings/accounts/{accountId}/emergencyBlocks/status","operationId":"updateAccountEmergencyBlock","name":"Updates emergency block status & reason for the account","summary":"Update Emergency block in Account","tags":[],"parameters":[{"name":"accountId","in":"path","type":"string","required":true,"description":"Identifier of the account. Often referred to as the account number, yet for consistency this is always referred to as accountId. Accepts both IBAN & BBAN"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"emergencyBlock":"string","emergencyReason":"string"}},"responses":{"200":"AccountEmergencyBlockResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/holdings/accounts/{accountId}/fundsAuthorisation/status","fullPath":"/api/v4.0.0/holdings/accounts/{accountId}/fundsAuthorisation/status","operationId":"getAccountFundsAuthStatus","name":"Retrieve the Funds Authorisation status from ACCOUNT","summary":"Retrieve Account Funds Authorisation status","tags":[],"parameters":[{"name":"accountId","in":"path","type":"string","required":true,"description":"Identifier of the account. Often referred to as the account number, yet for consistency this is always referred to as accountId. Accepts both IBAN & BBAN"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"AccountFundsAuthStatusResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"PUT","path":"/holdings/accounts/{accountId}/fundsAuthorisation/status","fullPath":"/api/v4.0.0/holdings/accounts/{accountId}/fundsAuthorisation/status","operationId":"updateAccountFundsAuthStatus","name":"Update the funds authorisation status for the account, for example SYNC or ERROR","summary":"Update Account Funds Authorisation status","tags":[],"parameters":[{"name":"accountId","in":"path","type":"string","required":true,"description":""},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"faStatus":"string"}},"responses":{"200":"AccountFundsAuthStatusResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"POST","path":"/holdings/accounts/settings/{settingId}/fundsDiversion","fullPath":"/api/v4.0.0/holdings/accounts/settings/{settingId}/fundsDiversion","operationId":"createFundsDiversion","name":"Allows creation of funds diversion conditions for a company to manage the behavior of booking funds against any account in the company that has the auto pay account defined","summary":"Creates conditions for funds diversion","tags":[],"parameters":[{"name":"settingId","in":"path","type":"string","required":true,"description":"Contains the particular parameter record setting identifier."},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"transactionCodes":[{}],"defaultFundsDiversion":"string"}},"responses":{"200":"FundsDiversionResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/holdings/accounts/settings/{settingId}/fundsDiversion","fullPath":"/api/v4.0.0/holdings/accounts/settings/{settingId}/fundsDiversion","operationId":"updateFundsDiversion","name":"Updates the funds diversion conditions for a company to manage the behavior of booking funds against any account in the company that has the auto pay account defined","summary":"Updates funds diversion parameter","tags":[],"parameters":[{"name":"settingId","in":"path","type":"string","required":true,"description":"Contains the particular parameter record setting identifier."},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"transactionCodes":[{}],"defaultFundsDiversion":"string"}},"responses":{"200":"FundsDiversionResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/holdings/nostros/forwardBalances","fullPath":"/api/v4.0.0/holdings/nostros/forwardBalances","operationId":"getNostroForwardBalances","name":"Retrieves forward balances of nostro accounts considering the transaction effective dates.","summary":"Retrieves consolidated nostro account balances","tags":[],"parameters":[{"name":"valueDate","in":"query","type":"string","required":true,"description":"Indicates the value date on which the underlying accounting entry is to be given value (for interest purposes)"},{"name":"accountId","in":"query","type":"string","required":false,"description":"Identifier of the account. Often referred to as the account number, yet for consistency this is always referred to as accountId. Accepts both IBAN & BBAN"},{"name":"longPositionSign","in":"query","type":"string","required":false,"description":"Polarity (sign) used to denote buy position balance.  "},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"NostroForwardBalancesResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/nostros/currencyBalances/{currencyId}/accounts","fullPath":"/api/v4.0.0/holdings/nostros/currencyBalances/{currencyId}/accounts","operationId":"getNostroBalances","name":"Retrieves the date wise balances of the Nostro Accounts that falls under a specific Currency","summary":"Retrieves nostro balances for a Specific Currency Accounts","tags":[],"parameters":[{"name":"currencyId","in":"path","type":"string","required":true,"description":"Identifier of the currency. This is the 3-letter ISO 4217 code of the currency."},{"name":"nostroId","in":"query","type":"string","required":false,"description":"Nostro account id"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"NostroBalancesResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/nostros/currencyBalances/{currencyId}","fullPath":"/api/v4.0.0/holdings/nostros/currencyBalances/{currencyId}","operationId":"getNostroCurrencyPositions","name":"Retrieves consolidated balances of the nostro accounts in a given currency from the current date to the next five days.","summary":"Retrieves consolidated nostro account balances for a specific currency","tags":[],"parameters":[{"name":"currencyId","in":"path","type":"string","required":true,"description":"Identifier of the currency. This is the 3-letter ISO 4217 code of the currency."},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"NostroCurrencyPositionsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/nostros/positions/{currencyId}","fullPath":"/api/v4.0.0/holdings/nostros/positions/{currencyId}","operationId":"getNostroPositions","name":"Retrieves nostro account balances for a given currency from the current date to the next five days.Provides nostro-to-nostro account transfer facility within the same currency.","summary":"Retrieves consolidated nostro account Positions of Currency","tags":[],"parameters":[{"name":"currencyId","in":"path","type":"string","required":true,"description":"Identifier of the currency. This is the 3-letter ISO 4217 code of the currency."},{"name":"longPositionSign","in":"query","type":"string","required":false,"description":"Polarity (sign) used to denote buy position balance.  "},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"NostroPositionsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/accounts/reservedFunds","fullPath":"/api/v4.0.0/holdings/accounts/reservedFunds","operationId":"getReservedFunds","name":"Retrieves the list of reserved funds ","summary":"Retrieves the list of reserved funds ","tags":[],"parameters":[{"name":"accountId","in":"query","type":"string","required":false,"description":"Identifier of the account. Often referred to as the account number, yet for consistency this is always referred to as accountId. Accepts both IBAN & BBAN"},{"name":"eventId","in":"query","type":"string","required":false,"description":"Event identifier"},{"name":"lockReason","in":"query","type":"string","required":false,"description":"Indicates the simple description for the balance reservation event."},{"name":"fromDate","in":"query","type":"string","required":false,"description":"Indicates the business date from when the balance reservation event is active."},{"name":"toDate","in":"query","type":"string","required":false,"description":"Indicates the business date until when the balance reservation event is active."},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"ReservedFundsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/accounts/{accountId}","fullPath":"/api/v4.0.0/holdings/accounts/{accountId}","operationId":"getAccountDetails","name":"Retrieves the account specific information for Internet Banking Users","summary":"Retrieves account details","tags":[],"parameters":[{"name":"accountId","in":"path","type":"string","required":true,"description":"Identifier of the account. Often referred to as the account number, yet for consistency this is always referred to as accountId. Accepts both IBAN & BBAN"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"AccountDetailsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/accounts/proxyIdentifiers","fullPath":"/api/v4.0.0/holdings/accounts/proxyIdentifiers","operationId":"getActiveProxyIdentifier","name":"Retrieve active records from Proxy directory for a given customer number/account number/proxy type and proxy identifier","summary":"API to check proxy Registration Status","tags":[],"parameters":[{"name":"customerId","in":"query","type":"string","required":false,"description":"Identifier of the customer"},{"name":"alternateAccountId","in":"query","type":"string","required":false,"description":"Alternate identification for an account"},{"name":"proxyType","in":"query","type":"string","required":false,"description":"Type of proxy created for account"},{"name":"proxyIdentifier","in":"query","type":"string","required":false,"description":"A proxy identifier to be linked to an account based on the proxy type provided eg. Mobile number, email id and tax id"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"ActiveProxyIdentifierResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"POST","path":"/holdings/accounts/proxyIdentifiers","fullPath":"/api/v4.0.0/holdings/accounts/proxyIdentifiers","operationId":"createProxyIdentifier","name":"Create a  new record in Proxy directory to Register the supplied Proxy Identifiers","summary":"API to register proxy identifier","tags":[],"parameters":[{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"customerId":"string","accountId":"string","alternateAccountId":"string","proxyType":"string","proxyIdentifier":"string","proxyStatus":"string","proxyScheme":"string","proxyRole":"string"}},"responses":{"200":"ProxyIdentifierResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/holdings/accounts/proxyIdentifiers/{proxyIdentifierId}","fullPath":"/api/v4.0.0/holdings/accounts/proxyIdentifiers/{proxyIdentifierId}","operationId":"updateProxyIdentifier","name":"Update the existing proxy directory to De-Register a Proxy Identifiers","summary":"API to De-register proxy identifier","tags":[],"parameters":[{"name":"proxyIdentifierId","in":"path","type":"string","required":true,"description":""},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"customerId":"string","accountId":"string","alternateAccountId":"string","proxyType":"string","proxyIdentifier":"string","proxyStatus":"string","proxyScheme":"string","proxyRole":"string"}},"responses":{"200":"ProxyIdentifierResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/holdings/accounts/{accountId}/{accountCompany}/{paymentCurrency}/{accountSwitch}/{beneficialCustomer}/payments","fullPath":"/api/v4.0.0/holdings/accounts/{accountId}/{accountCompany}/{paymentCurrency}/{accountSwitch}/{beneficialCustomer}/payments","operationId":"getAccountPaymentDetails","name":"Retrieves the account information that are required for processing or validating an account involved in a payment transaction. Provides the information such as account name, customer number, account type, account currency, IBAN, account switch details, account status (ACTIVE or INACTIVE) and account closure details.","summary":"Retrieves account details required for payment processing","tags":[],"parameters":[{"name":"accountId","in":"path","type":"string","required":true,"description":"Identifier of the account. Often referred to as the account number, yet for consistency this is always referred to as accountId. Accepts both IBAN & BBAN"},{"name":"accountCompany","in":"path","type":"string","required":true,"description":"Company of the account to be created"},{"name":"paymentCurrency","in":"path","type":"string","required":true,"description":"This field holds the transaction currency or currency in which payment is initiated. "},{"name":"accountSwitch","in":"path","type":"string","required":true,"description":"Indicates if availability of account switch details should be checked."},{"name":"beneficialCustomer","in":"path","type":"string","required":true,"description":"Indicates if beneficial owners of the account are to be retrieved"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"AccountPaymentDetailsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/accounts","fullPath":"/api/v4.0.0/holdings/accounts","operationId":"getAccounts","name":"Retrieves the Currency, Balances, Limit details and Arrangement details of an account","summary":"Retrieves list of Account details","tags":[],"parameters":[{"name":"accountId","in":"query","type":"string","required":false,"description":"Identifier of the account. Often referred to as the account number, yet for consistency this is always referred to as accountId. Accepts both IBAN & BBAN"},{"name":"customerId","in":"query","type":"string","required":false,"description":"Identifier of the customer"},{"name":"productId","in":"query","type":"string","required":false,"description":"Contains the unique identifier of the product, e.g. the product id of the arrangement account."},{"name":"currencyId","in":"query","type":"string","required":false,"description":"Identifier of the currency. This is the 3-letter ISO 4217 code of the currency."},{"name":"limitReference","in":"query","type":"string","required":false,"description":"Identifies the credit limit reference for the underlying account."},{"name":"arrangementId","in":"query","type":"string","required":false,"description":"Indicates an unique identifier of an account"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"AccountsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/accounts/{contractBalanceId}/contractBalances","fullPath":"/api/v4.0.0/holdings/accounts/{contractBalanceId}/contractBalances","operationId":"getContractBalances","name":"Retrieves the contract balances of accounts or contracts with details such as contract currency, balance types , credit and debit movements and opening and closing balance of the balance types","summary":"Retrieves Contract Balances of Accounts","tags":[],"parameters":[{"name":"contractBalanceId","in":"path","type":"string","required":true,"description":"Unique Identifier of Contract Balances"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"ContractBalancesResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"PUT","path":"/holdings/accounts/{accountId}/synchronizationError","fullPath":"/api/v4.0.0/holdings/accounts/{accountId}/synchronizationError","operationId":"updateSynchronizationError","name":"Updates error occurred during Synchronization of account.","summary":"Synchronization error update.","tags":[],"parameters":[{"name":"accountId","in":"path","type":"string","required":true,"description":"Identifier of the account. Often referred to as the account number, yet for consistency this is always referred to as accountId. Accepts both IBAN & BBAN"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"emergencyBlockError":"string"}},"responses":{"200":"SynchronizationErrorResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}}]},{"key":"holdings-accounts-service-v4.1.0","title":"Account management","version":"v4.1.0","description":"API to manage account related services such as retrieving balances, transaction and card details, emergency blocks, funds diversion, reservations, proxy identifiers and account closures. In addition, it provides functionality to support the capability to switch accounts from the current system to an","endpointCount":27,"endpoints":[{"method":"GET","path":"/holdings/accounts/accountClosure/{accountId}","fullPath":"/api/v4.1.0/holdings/accounts/accountClosure/{accountId}","operationId":"getAccountClosure","name":"Retrieves the account closure information of the account such as closure date and reason, mode of closure, balances on the date of closing and pending charges","summary":"Retrieves the account closure information","tags":[],"parameters":[{"name":"accountId","in":"path","type":"string","required":true,"description":"Identifier of the account. Often referred to as the account number, yet for consistency this is always referred to as accountId. Accepts both IBAN & BBAN"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"AccountClosureResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/holdings/accounts/accountClosure/{accountId}","fullPath":"/api/v4.1.0/holdings/accounts/accountClosure/{accountId}","operationId":"updateAccountClosure","name":"Updates account closure information for the specific account such as closure date and reason, mode of closure and closing charges","summary":"Updates account closure information","tags":[],"parameters":[{"name":"accountId","in":"path","type":"string","required":true,"description":"Identifier of the account. Often referred to as the account number, yet for consistency this is always referred to as accountId. Accepts both IBAN & BBAN"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"accountCurrency":"string","closureDate":"2024-01-01T00:00:00Z","creditAccount":"string","capitaliseInterest":"string","chargeType":"string","chargeAmount":0.0,"closeMode":"string","ftId":"string","closureReason":"string","closureNotes":"string","onlineLedgerBalance":0.0,"onlineClearedBalance":0.0,"balancePayable":0.0,"totalCreditInterest":"string","totalDebitInterest":"string"}},"responses":{"200":"AccountClosureResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/holdings/accounts/{accountId}/transactions","fullPath":"/api/v4.1.0/holdings/accounts/{accountId}/transactions","operationId":"getAccountTransactions","name":"Retrieves the transaction details of the account such as transaction references, opening and closing balances, date of transaction and amount based on the range of date of specified","summary":"Retrieves account transaction details","tags":[],"parameters":[{"name":"accountId","in":"path","type":"string","required":true,"description":"Identifier of the account. Often referred to as the account number, yet for consistency this is always referred to as accountId. Accepts both IBAN & BBAN"},{"name":"bookingDate","in":"query","type":"string","required":false,"description":"Business date on which the accounting entry was generated."},{"name":"processingDate","in":"query","type":"string","required":false,"description":"The date when payment instruction is processed in system."},{"name":"valueDate","in":"query","type":"string","required":false,"description":"Indicates the value date on which the underlying accounting entry is to be given value (for interest purposes)"},{"name":"description","in":"query","type":"string","required":false,"description":"Contains the description of purpose of the payment."},{"name":"reversalMarker","in":"query","type":"string","required":false,"description":"Denotes the flag which is set whenever any credit or reversal debit entries with future exposure dates are processed"},{"name":"includeSubAcct","in":"query","type":"string","required":false,"description":"Denotes the flag which needs to be set in order to allow the automatic creation of sub-accounts and the automatic distribution of transactions over sub-accounts"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"AccountTransactionsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/accounts/{accountId}/cards","fullPath":"/api/v4.1.0/holdings/accounts/{accountId}/cards","operationId":"getAccountCards","name":"Retrieves the card details of the account such as card number, card type and status of the card","summary":"Retrieves available card details","tags":[],"parameters":[{"name":"accountId","in":"path","type":"string","required":true,"description":"Identifier of the account. Often referred to as the account number, yet for consistency this is always referred to as accountId. Accepts both IBAN & BBAN"},{"name":"cardIssueId","in":"query","type":"string","required":false,"description":"The identifier of the issued card formatted as cardType '.' cardNumber. E.g. VISA.1234567887654321 GC.1111222233334444 AB21.1111111122222222"},{"name":"issueDate","in":"query","type":"string","required":false,"description":"The date the item was issued."},{"name":"expiryDate","in":"query","type":"string","required":false,"description":"The date an agreement such as an arrangement, product, credit facility or limit is due to expire"},{"name":"cardStatus","in":"query","type":"string","required":false,"description":"Current status of the Card and following are the possible statuses are  - CARD.ISSUED - CARD.RETURNED - CARD.SCRAP - CARD.CANCEL - NOT.ACTIVATED - NOT.RECEIVED - ACTIVE - BLOCKED - EXPIRED"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"AccountCardsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/accounts/balances","fullPath":"/api/v4.1.0/holdings/accounts/balances","operationId":"getAccountBalanceToday","name":"Retrieves various types of balances such as cleared, online, locked and usable balance of the account","summary":"Retrieves list of account balances","tags":[],"parameters":[{"name":"accountId","in":"query","type":"string","required":false,"description":"Identifier of the account. Often referred to as the account number, yet for consistency this is always referred to as accountId. Accepts both IBAN & BBAN"},{"name":"customerId","in":"query","type":"string","required":false,"description":"Identifier of the customer"},{"name":"productId","in":"query","type":"string","required":false,"description":"Contains the unique identifier of the product, e.g. the product id of the arrangement account."},{"name":"currencyId","in":"query","type":"string","required":false,"description":"Identifier of the currency. This is the 3-letter ISO 4217 code of the currency."},{"name":"limitReferenceId","in":"query","type":"string","required":false,"description":"Limit reference identifier for the limit order."},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"AccountBalanceTodayResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/accounts/{accountId}/balanceMovements/{bookingDate}","fullPath":"/api/v4.1.0/holdings/accounts/{accountId}/balanceMovements/{bookingDate}","operationId":"getAccountBalanceMovement","name":"Retrieves the credit, debit and gross balance movements for an account for the requested booking date","summary":"Retrieves balances movements of account","tags":[],"parameters":[{"name":"accountId","in":"path","type":"string","required":true,"description":"Identifier of the account. Often referred to as the account number, yet for consistency this is always referred to as accountId. Accepts both IBAN & BBAN"},{"name":"bookingDate","in":"path","type":"string","required":true,"description":"Business date on which the accounting entry was generated."},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"AccountBalanceMovementResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/accounts/{accountId}/emergencyBlocks/status","fullPath":"/api/v4.1.0/holdings/accounts/{accountId}/emergencyBlocks/status","operationId":"getAccountEmergencyBlock","name":"Retrieve emergency block status and reason for a given account. This information will be used to assert the actual block status of an account in microservice","summary":"Retrieve emergency block information for an account","tags":[],"parameters":[{"name":"accountId","in":"path","type":"string","required":true,"description":"Identifier of the account. Often referred to as the account number, yet for consistency this is always referred to as accountId. Accepts both IBAN & BBAN"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"AccountEmergencyBlockResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"PUT","path":"/holdings/accounts/{accountId}/emergencyBlocks/status","fullPath":"/api/v4.1.0/holdings/accounts/{accountId}/emergencyBlocks/status","operationId":"updateAccountEmergencyBlock","name":"Updates emergency block status and reason for the account","summary":"Update emergency block in account","tags":[],"parameters":[{"name":"accountId","in":"path","type":"string","required":true,"description":"Identifier of the account. Often referred to as the account number, yet for consistency this is always referred to as accountId. Accepts both IBAN & BBAN"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"emergencyBlock":"string","emergencyReason":"string"}},"responses":{"200":"AccountEmergencyBlockResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/holdings/accounts/{accountId}/fundsAuthorisation/status","fullPath":"/api/v4.1.0/holdings/accounts/{accountId}/fundsAuthorisation/status","operationId":"getAccountFundsAuthStatus","name":"Retrieve the funds authorisation status from account","summary":"Retrieve account funds authorisation status","tags":[],"parameters":[{"name":"accountId","in":"path","type":"string","required":true,"description":"Identifier of the account. Often referred to as the account number, yet for consistency this is always referred to as accountId. Accepts both IBAN & BBAN"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"AccountFundsAuthStatusResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"PUT","path":"/holdings/accounts/{accountId}/fundsAuthorisation/status","fullPath":"/api/v4.1.0/holdings/accounts/{accountId}/fundsAuthorisation/status","operationId":"updateAccountFundsAuthStatus","name":"Update the funds authorisation status for the account, for example SYNC or ERROR","summary":"Update account funds authorisation status","tags":[],"parameters":[{"name":"accountId","in":"path","type":"string","required":true,"description":""},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"faStatus":"string"}},"responses":{"200":"AccountFundsAuthStatusResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"POST","path":"/holdings/accounts/settings/{settingId}/fundsDiversion","fullPath":"/api/v4.1.0/holdings/accounts/settings/{settingId}/fundsDiversion","operationId":"createFundsDiversion","name":"Allows creation of funds diversion conditions for a company to manage the behavior of booking funds against any account in the company that has the auto pay account defined","summary":"Creates conditions for funds diversion","tags":[],"parameters":[{"name":"settingId","in":"path","type":"string","required":true,"description":"Contains the particular parameter record setting identifier."},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"transactionCodes":[{}],"defaultFundsDiversion":"string"}},"responses":{"200":"FundsDiversionResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/holdings/accounts/settings/{settingId}/fundsDiversion","fullPath":"/api/v4.1.0/holdings/accounts/settings/{settingId}/fundsDiversion","operationId":"updateFundsDiversion","name":"Updates the funds diversion conditions for a company to manage the behavior of booking funds against any account in the company that has the auto pay account defined","summary":"Updates funds diversion parameter","tags":[],"parameters":[{"name":"settingId","in":"path","type":"string","required":true,"description":"Contains the particular parameter record setting identifier."},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"transactionCodes":[{}],"defaultFundsDiversion":"string"}},"responses":{"200":"FundsDiversionResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/holdings/nostros/forwardBalances","fullPath":"/api/v4.1.0/holdings/nostros/forwardBalances","operationId":"getNostroForwardBalances","name":"Retrieves forward balances of nostro accounts considering the transaction effective dates.","summary":"Retrieves consolidated nostro account balances","tags":[],"parameters":[{"name":"valueDate","in":"query","type":"string","required":true,"description":"Indicates the value date on which the underlying accounting entry is to be given value (for interest purposes)"},{"name":"accountId","in":"query","type":"string","required":false,"description":"Identifier of the account. Often referred to as the account number, yet for consistency this is always referred to as accountId. Accepts both IBAN & BBAN"},{"name":"longPositionSign","in":"query","type":"string","required":false,"description":"Polarity (sign) used to denote buy position balance.  "},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"NostroForwardBalancesResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/nostros/currencyBalances/{currencyId}/accounts","fullPath":"/api/v4.1.0/holdings/nostros/currencyBalances/{currencyId}/accounts","operationId":"getNostroBalances","name":"Retrieves the date wise balances of the nostro accounts that falls under a specific currency","summary":"Retrieves nostro account balances for a specific currency","tags":[],"parameters":[{"name":"currencyId","in":"path","type":"string","required":true,"description":"Identifier of the currency. This is the 3-letter ISO 4217 code of the currency."},{"name":"nostroId","in":"query","type":"string","required":false,"description":"Nostro account id"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"NostroBalancesResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/nostros/currencyBalances/{currencyId}","fullPath":"/api/v4.1.0/holdings/nostros/currencyBalances/{currencyId}","operationId":"getNostroCurrencyPositions","name":"Retrieves consolidated balances of the nostro accounts in a given currency from the current date to the next five days.","summary":"Retrieves consolidated nostro account balances for a specific currency","tags":[],"parameters":[{"name":"currencyId","in":"path","type":"string","required":true,"description":"Identifier of the currency. This is the 3-letter ISO 4217 code of the currency."},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"NostroCurrencyPositionsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/nostros/positions/{currencyId}","fullPath":"/api/v4.1.0/holdings/nostros/positions/{currencyId}","operationId":"getNostroPositions","name":"Retrieves nostro account balances for a given currency from the current date to the next five days.","summary":"Retrieves consolidated nostro account positions for the currency","tags":[],"parameters":[{"name":"currencyId","in":"path","type":"string","required":true,"description":"Identifier of the currency. This is the 3-letter ISO 4217 code of the currency."},{"name":"longPositionSign","in":"query","type":"string","required":false,"description":"Polarity (sign) used to denote buy position balance.  "},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"NostroPositionsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/accounts/reservedFunds","fullPath":"/api/v4.1.0/holdings/accounts/reservedFunds","operationId":"getReservedFunds","name":"Retrieves the reserved funds details such as reason, amount and period of reservation of the account","summary":"Retrieves the list of reserved funds","tags":[],"parameters":[{"name":"accountId","in":"query","type":"string","required":false,"description":"Identifier of the account. Often referred to as the account number, yet for consistency this is always referred to as accountId. Accepts both IBAN & BBAN"},{"name":"eventId","in":"query","type":"string","required":false,"description":"Event identifier"},{"name":"lockReason","in":"query","type":"string","required":false,"description":"Indicates the simple description for the balance reservation event."},{"name":"fromDate","in":"query","type":"string","required":false,"description":"Indicates the business date from when the balance reservation event is active."},{"name":"toDate","in":"query","type":"string","required":false,"description":"Indicates the business date until when the balance reservation event is active."},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"ReservedFundsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/accounts/{accountId}","fullPath":"/api/v4.1.0/holdings/accounts/{accountId}","operationId":"getAccountDetails","name":"Retrieves the arrangement account details such as account balances, allowed, advised and outstanding limit balances, interest types and values with the corresponding mode, frequency and value of payments","summary":"Retrieves arrangement account details","tags":[],"parameters":[{"name":"accountId","in":"path","type":"string","required":true,"description":"Identifier of the account. Often referred to as the account number, yet for consistency this is always referred to as accountId. Accepts both IBAN & BBAN"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"AccountDetailsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/accounts/proxyIdentifiers","fullPath":"/api/v4.1.0/holdings/accounts/proxyIdentifiers","operationId":"getActiveProxyIdentifier","name":"Retrieve active records from proxy directory for a given customer number or account number or proxy type and proxy identifier","summary":"Retrieve proxy registration status","tags":[],"parameters":[{"name":"customerId","in":"query","type":"string","required":false,"description":"Identifier of the customer"},{"name":"alternateAccountId","in":"query","type":"string","required":false,"description":"Alternate identification for an account"},{"name":"proxyType","in":"query","type":"string","required":false,"description":"Type of proxy created for account"},{"name":"proxyIdentifier","in":"query","type":"string","required":false,"description":"A proxy identifier to be linked to an account based on the proxy type provided eg. Mobile number, email id and tax id"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"ActiveProxyIdentifierResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"POST","path":"/holdings/accounts/proxyIdentifiers","fullPath":"/api/v4.1.0/holdings/accounts/proxyIdentifiers","operationId":"createProxyIdentifier","name":"Create a new record in proxy directory to register the supplied proxy identifiers, proxy type and scheme for a customer and account","summary":"Register the proxy identifier for the account","tags":[],"parameters":[{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"customerId":"string","accountId":"string","alternateAccountId":"string","proxyType":"string","proxyIdentifier":"string","proxyStatus":"string","proxyScheme":"string","proxyRole":"string"}},"responses":{"200":"ProxyIdentifierResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/holdings/accounts/proxyIdentifiers/{proxyIdentifierId}","fullPath":"/api/v4.1.0/holdings/accounts/proxyIdentifiers/{proxyIdentifierId}","operationId":"updateProxyIdentifier","name":"Update the specific proxy identifier to de-register the registered account or customer from the proxy directory","summary":"Update proxy directory for account to de-register the proxy identifier","tags":[],"parameters":[{"name":"proxyIdentifierId","in":"path","type":"string","required":true,"description":""},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"customerId":"string","accountId":"string","alternateAccountId":"string","proxyType":"string","proxyIdentifier":"string","proxyStatus":"string","proxyScheme":"string","proxyRole":"string"}},"responses":{"200":"ProxyIdentifierResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/holdings/accounts/{accountId}/{accountCompany}/{paymentCurrency}/{accountSwitch}/{beneficialCustomer}/payments","fullPath":"/api/v4.1.0/holdings/accounts/{accountId}/{accountCompany}/{paymentCurrency}/{accountSwitch}/{beneficialCustomer}/payments","operationId":"getAccountPaymentDetails","name":"Retrieves the account information that are required for processing or validating an account involved in a payment transaction. Provides the information such as account name, customer number, account type, account currency, IBAN, account switch details, account status (ACTIVE or INACTIVE) and account closure details.","summary":"Retrieves account details required for payment processing","tags":[],"parameters":[{"name":"accountId","in":"path","type":"string","required":true,"description":"Identifier of the account. Often referred to as the account number, yet for consistency this is always referred to as accountId. Accepts both IBAN & BBAN"},{"name":"accountCompany","in":"path","type":"string","required":true,"description":"Company of the account to be created"},{"name":"paymentCurrency","in":"path","type":"string","required":true,"description":"This field holds the transaction currency or currency in which payment is initiated. "},{"name":"accountSwitch","in":"path","type":"string","required":true,"description":"Indicates if availability of account switch details should be checked."},{"name":"beneficialCustomer","in":"path","type":"string","required":true,"description":"Indicates if beneficial owners of the account are to be retrieved"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"AccountPaymentDetailsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/accounts","fullPath":"/api/v4.1.0/holdings/accounts","operationId":"getAccounts","name":"Retrieves the currency, balances, limit details and arrangement details of an account","summary":"Retrieves list of account details","tags":[],"parameters":[{"name":"accountId","in":"query","type":"string","required":false,"description":"Identifier of the account. Often referred to as the account number, yet for consistency this is always referred to as accountId. Accepts both IBAN & BBAN"},{"name":"customerId","in":"query","type":"string","required":false,"description":"Identifier of the customer"},{"name":"productId","in":"query","type":"string","required":false,"description":"Contains the unique identifier of the product, e.g. the product id of the arrangement account."},{"name":"currencyId","in":"query","type":"string","required":false,"description":"Identifier of the currency. This is the 3-letter ISO 4217 code of the currency."},{"name":"limitReference","in":"query","type":"string","required":false,"description":"Identifies the credit limit reference for the underlying account."},{"name":"arrangementId","in":"query","type":"string","required":false,"description":"Indicates an unique identifier of an account"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"AccountsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/accounts/{contractBalanceId}/contractBalances","fullPath":"/api/v4.1.0/holdings/accounts/{contractBalanceId}/contractBalances","operationId":"getContractBalances","name":"Retrieves the contract balances of accounts or contracts with details such as contract currency, balance types, credit and debit movements and opening and closing balance of the respective balance types","summary":"Retrieves contract balances of accounts","tags":[],"parameters":[{"name":"contractBalanceId","in":"path","type":"string","required":true,"description":"Unique Identifier of Contract Balances"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"ContractBalancesResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"PUT","path":"/holdings/accounts/{accountId}/synchronizationError","fullPath":"/api/v4.1.0/holdings/accounts/{accountId}/synchronizationError","operationId":"updateSynchronizationError","name":"Updates error status during synchronization of the account between transact and funds authorisation microservice","summary":"Update synchronization error status","tags":[],"parameters":[{"name":"accountId","in":"path","type":"string","required":true,"description":"Identifier of the account. Often referred to as the account number, yet for consistency this is always referred to as accountId. Accepts both IBAN & BBAN"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"emergencyBlockError":"string"}},"responses":{"200":"SynchronizationErrorResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/holdings/accounts/{accountId}/accountSwitches/expiringSwitches","fullPath":"/api/v4.1.0/holdings/accounts/{accountId}/accountSwitches/expiringSwitches","operationId":"getExpiringAccountSwitches","name":"Retrieves the details of the expiring account switches for generating alerts such as the bank identifier code, alert date and accountId of expiring switch instruction etc.","summary":"Retrieves the details of the expiring switches for generating alerts","tags":[],"parameters":[{"name":"accountId","in":"path","type":"string","required":true,"description":"The identifier of the account. Often referred to as the account number, yet for consistency this is always referred to as accountId.Accepts both IBAN & BBAN"},{"name":"alertStatus","in":"query","type":"string","required":false,"description":"Contains status of the Alert. Possible values are Pending, Sent"},{"name":"alertDate","in":"query","type":"string","required":false,"description":"Indicates the date in which an alert to be raised."},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from t24 on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":""},{"name":"companyId","in":"header","type":"string","required":false,"description":"The identifier of the underlying Entity/Company/Branch."},{"name":"deviceId","in":"header","type":"string","required":false,"description":""},{"name":"userRole","in":"header","type":"string","required":false,"description":""},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"ExpiringAccountSwitchesResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/accounts/{accountId}/accountSwitches","fullPath":"/api/v4.1.0/holdings/accounts/{accountId}/accountSwitches","operationId":"getAccountSwitchDetails","name":"Retrieves details from the account switch directory for the specific account such as the expiry date, status of the switch instruction, effective date of the switch, bank identifier code and IBAN (International Bank Account Number ) etc.","summary":"Retrieves details of the account switch requests","tags":[],"parameters":[{"name":"accountId","in":"path","type":"string","required":true,"description":"The identifier of the account. Often referred to as the account number, yet for consistency this is always referred to as accountId.Accepts both IBAN & BBAN"},{"name":"requestDate","in":"query","type":"string","required":false,"description":"Date on which the client's request to be classified as professional has been received."},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from t24 on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":""},{"name":"companyId","in":"header","type":"string","required":false,"description":"The identifier of the underlying Entity/Company/Branch."},{"name":"deviceId","in":"header","type":"string","required":false,"description":""},{"name":"userRole","in":"header","type":"string","required":false,"description":""},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"AccountSwitchDetailsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}}]},{"key":"holdings-accounts-service-v4.10.0","title":"Account management","version":"v4.10.0","description":"API to manage account related services such as retrieving balances, transaction and card details, emergency blocks, funds diversion, reservations, proxy identifiers and account closures. In addition, it provides functionality to support the capability to switch accounts from the current system to an","endpointCount":70,"endpoints":[{"method":"PUT","path":"/holdings/accounts/{accountId}/products","fullPath":"/api/v4.10.0/holdings/accounts/{accountId}/products","operationId":"updateAccountProduct","name":"Change account from one product to another such as changing savings account to current account","summary":"Change of contract from one account product to another","tags":["RETAIL"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"accountId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"effectiveDate":"2024-01-01","productId":"string","extensions":{},"balance":[{}]}},"responses":{"200":"updateAccountProductResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"PUT","path":"/holdings/accounts/{accountId}/limits","fullPath":"/api/v4.10.0/holdings/accounts/{accountId}/limits","operationId":"updateAccountLimit","name":"Update the limit conditions of the account with the secondary limit amount and other limit details","summary":"Update the limit conditions of the account","tags":["RETAIL"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"accountId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"parties":[{}],"activityId":"string","effectiveDate":"string","productId":"string","currencyId":"string","simulationId":"string","extensions":{},"limit":[{}]}},"responses":{"200":"updateAccountLimitResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"PUT","path":"/holdings/accounts/{accountId}/interestConditions","fullPath":"/api/v4.10.0/holdings/accounts/{accountId}/interestConditions","operationId":"updateAccountInterestConditions","name":"Update the interest conditions of the account such as interest rate, tier details, margin amount etc.","summary":"Update the interest conditions of the account","tags":["RETAIL"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"accountId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"effectiveDate":"2024-01-01","channel":"string","extensions":{},"crinterest":[{}]}},"responses":{"200":"updateAccountInterestConditionsResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"PUT","path":"/holdings/accounts/{accountId}/dormancyStatus/{status}","fullPath":"/api/v4.10.0/holdings/accounts/{accountId}/dormancyStatus/{status}","operationId":"updateAccountDormancyStatus","name":"Deactivates the savings account and moves it to given dormancy status.","summary":"Deactivates the savings account to given status","tags":["RETAIL"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"accountId","in":"path","type":"string","required":true,"description":""},{"name":"status","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"effectiveDate":"2024-01-01","productId":"string","extensions":{}}},"responses":{"200":"updateAccountDormancyStatusResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"PUT","path":"/holdings/accounts/{accountId}/channels","fullPath":"/api/v4.10.0/holdings/accounts/{accountId}/channels","operationId":"updateAccountChannel","name":"Updates the channel of the account","summary":"Change of channel for the account","tags":["RETAIL"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"accountId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"effectiveDate":"2024-01-01","channel":"string","extensions":{}}},"responses":{"200":"updateAccountChannelResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"POST","path":"/holdings/accounts/migrations","fullPath":"/api/v4.10.0/holdings/accounts/migrations","operationId":"initiateAccountMigration","name":"Migration of a legacy system account contract to the given account product by providing the original contract date, account name, statement, payment frequency and start date, etc. ","summary":"Migration of legacy system account contract to the given account product","tags":["RETAIL"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"partyIds":[{}],"originationReference":[{}],"effectiveDate":"2024-01-01","productId":"string","currency":"string","branch":"string","channel":"string","lineOfBusiness":"string","originalContractDate":"2024-01-01","extensions":{},"limit":[{}],"balance":[{}],"customer":[{}],"crinterest":[{}],"schedule":[{}]}},"responses":{"200":"initiateAccountMigrationResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"PUT","path":"/holdings/accounts/{accountId}/migrations/balances","fullPath":"/api/v4.10.0/holdings/accounts/{accountId}/migrations/balances","operationId":"updateAccountBalanceMigration","name":"Captures the balance details of the account such as balance type, due amount etc. This is used to migrate the balances of a legacy contract which is migrated from other system & update the balance details","summary":"Captures outstanding balance details of a contract migrated from legacy system","tags":["RETAIL"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"accountId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"productId":"string","drawdownDate":"2024-01-01","extensions":{},"balanceMaintenance":[{}]}},"responses":{"200":"updateAccountBalanceMigrationResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"PUT","path":"/holdings/accounts/{accountId}/renegotiations","fullPath":"/api/v4.10.0/holdings/accounts/{accountId}/renegotiations","operationId":"updateAccountConditions","name":"Perform the renegotiation of the account contract details such as payment frequency, payment start date, interest rate, statement frequency and settlement details, etc.","summary":"Renegotiation of the account contract details","tags":["RETAIL"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"accountId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"effectiveDate":"2024-01-01","productId":"string","extensions":{},"limit":[{}],"balance":[{}],"customer":[{}],"crinterest":[{}],"schedule":[{}],"settlement":[{}],"statement":[{}]}},"responses":{"200":"updateAccountConditionsResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"PUT","path":"/holdings/accounts/{accountId}/dormancyStatus/reactivations","fullPath":"/api/v4.10.0/holdings/accounts/{accountId}/dormancyStatus/reactivations","operationId":"updateAccountDormancyReactivation","name":"Reset the dormant account to active status manually","summary":"Reset the account dormancy status","tags":["RETAIL"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"accountId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"effectiveDate":"2024-01-01","productId":"string","extensions":{}}},"responses":{"200":"updateAccountDormancyReactivationResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"PUT","path":"/holdings/accounts/{accountId}/withdrawalNotices","fullPath":"/api/v4.10.0/holdings/accounts/{accountId}/withdrawalNotices","operationId":"createAccountWithdrawalNotice","name":"Notifies the withdrawal of amount from account by providing the withdrawal date and amount etc. This is applicable only for notice type of accounts.","summary":"Notifies the withdrawal amount from account","tags":["RETAIL"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"accountId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"effectiveDate":"2024-01-01","productId":"string","extensions":{},"noticeWithdrawal":[{}]}},"responses":{"200":"createAccountWithdrawalNoticeResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"PUT","path":"/holdings/accounts/{accountId}/customers","fullPath":"/api/v4.10.0/holdings/accounts/{accountId}/customers","operationId":"updateAccountCustomer","name":"Update the customer details of the account such as add or remove the joint customers, tax liability percentange, limit liability percentage of the joint customers","summary":"Update customers for the given account","tags":["RETAIL"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"accountId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"partyIds":[{}],"effectiveDate":"2024-01-01","extensions":{},"customer":[{}]}},"responses":{"200":"updateAccountCustomerResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"PUT","path":"/holdings/accounts/{accountId}/credits","fullPath":"/api/v4.10.0/holdings/accounts/{accountId}/credits","operationId":"updateAccountCredit","name":"Perform credit transactions in an account, providing the credit amount and the currency in which to be credited","summary":"Perform credit transaction in an account.","tags":["RETAIL"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"accountId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"currencyId":"string","effectiveDate":"2024-01-01","activityId":"string","transactionAmount":0.0,"contractId":"string","systemId":"string","externalEventStatus":"string","extensions":{}}},"responses":{"200":"updateAccountCreditResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"PUT","path":"/holdings/accounts/{accountId}/debits","fullPath":"/api/v4.10.0/holdings/accounts/{accountId}/debits","operationId":"updateAccountDebit","name":"Perform debit transactions in an account by providing debit amount and currency in which to be debited","summary":"Perform debit transactions in an account","tags":["RETAIL"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"accountId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"currencyId":"string","effectiveDate":"2024-01-01","activityId":"string","transactionAmount":0.0,"contractId":"string","systemId":"string","externalEventStatus":"string","extensions":{}}},"responses":{"200":"updateAccountDebitResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"PUT","path":"/holdings/accounts/{accountId}/adjustments","fullPath":"/api/v4.10.0/holdings/accounts/{accountId}/adjustments","operationId":"updateAccountAdjustment","name":"Performs backdated adjustment and re-accrual for the given savings account.  This is used when interest adjustment is required due to backdated rate change or transaction.","summary":"Performs backdated adjustment and re-accrual for the given savings account ","tags":["RETAIL"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"accountId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"currencyId":"string","effectiveDate":"2024-01-01","activityId":"string","transactionAmount":0.0,"contractId":"string","systemId":"string","externalEventStatus":"string","extensions":{}}},"responses":{"200":"updateAccountAdjustmentResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"PUT","path":"/holdings/accounts/{accountId}/lineofBusiness","fullPath":"/api/v4.10.0/holdings/accounts/{accountId}/lineofBusiness","operationId":"updateAccountLob","name":"Updates the type of line of business of the account","summary":"Change of line of business for the account","tags":["RETAIL"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"accountId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"effectiveDate":"2024-01-01","lineOfBusiness":"string","extensions":{}}},"responses":{"200":"updateAccountLobResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"GET","path":"/holdings/accounts/{accountId}/dormancyConditions","fullPath":"/api/v4.10.0/holdings/accounts/{accountId}/dormancyConditions","operationId":"getAccountDormancyDetails","name":"Retrieves the dormancy setup details for the account such as dormancy period, status etc","summary":"Retrieves the account dormancy conditions","tags":["RETAIL"],"parameters":[{"name":"accountId","in":"path","type":"string","required":true,"description":"Identifier of the account. Often referred to as the account number, yet for consistency this is always referred to as accountId. Accepts both IBAN & BBAN"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"AccountDormancyDetailsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/accounts/{accountId}/transactions","fullPath":"/api/v4.10.0/holdings/accounts/{accountId}/transactions","operationId":"getAccountTransactions","name":"Retrieves account transaction details such as transaction type, amount, transaction reference, credit or debit indicator, booking and effective date of transaction","summary":"Retrieves account transaction details","tags":["RETAIL"],"parameters":[{"name":"accountId","in":"path","type":"string","required":true,"description":"Identifier of the account. Often referred to as the account number, yet for consistency this is always referred to as accountId. Accepts both IBAN & BBAN"},{"name":"fromDate","in":"query","type":"string","required":false,"description":"Indicates the business date from when the balance reservation event is active."},{"name":"toDate","in":"query","type":"string","required":false,"description":"Indicates the business date until when the balance reservation event is active."},{"name":"transactionReference","in":"query","type":"string","required":false,"description":"Contains the identifier for the transaction in the core system"},{"name":"period","in":"query","type":"string","required":false,"description":"Indicates spread of time buckets.Ex: 3M,6M,9M,10Y etc."},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"AccountTransactionsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/accounts/accountsDetails","fullPath":"/api/v4.10.0/holdings/accounts/accountsDetails","operationId":"getAccountInfo","name":"Retrieves the currency, balances, limit details and arrangement details of the account","summary":"Retrieves list of account basic details","tags":["RETAIL"],"parameters":[{"name":"customer","in":"query","type":"string","required":false,"description":"Contains the customer identifier to fetch list of consent arrangements for the customer or customer identifier of the debtor account. This will be populated once the SCA(Strong Customer Authentication"},{"name":"arrangementId","in":"query","type":"string","required":false,"description":"Indicates an unique identifier of an account"},{"name":"currency","in":"query","type":"string","required":false,"description":"Identifies the currency. E.g. USD, GBP etc"},{"name":"companyCode","in":"query","type":"string","required":false,"description":"The identifier of the underlying Entity/Company/Branch."},{"name":"productId","in":"query","type":"string","required":false,"description":"Contains the unique identifier of the product, e.g. the product id of the arrangement account."},{"name":"status","in":"query","type":"string","required":false,"description":"Contains status of the data rights request.Allowed values are INITIATED, INPROGESS, EXTENDED, COMPLETED, REJECTED."},{"name":"accountId","in":"query","type":"string","required":false,"description":"Identifier of the account. Often referred to as the account number, yet for consistency this is always referred to as accountId. Accepts both IBAN & BBAN"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"AccountInfoResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/accounts/{accountId}/statements","fullPath":"/api/v4.10.0/holdings/accounts/{accountId}/statements","operationId":"getAccountStatementDetails","name":"Retrieves the statement frequency of an account","summary":"Retrieves the statement frequency of an account","tags":["RETAIL"],"parameters":[{"name":"accountId","in":"path","type":"string","required":true,"description":"Identifier of the account. Often referred to as the account number, yet for consistency this is always referred to as accountId. Accepts both IBAN & BBAN"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"AccountStatementDetailsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"PUT","path":"/holdings/accounts/{accountId}/statements","fullPath":"/api/v4.10.0/holdings/accounts/{accountId}/statements","operationId":"updateAccountStatement","name":"Update the statement frequency of an account.","summary":"Update the statement frequency of an account","tags":["RETAIL"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"productId":"string","drawdownDate":"2024-01-01","extensions":{},"statement":[{}]}},"responses":{"200":"updateAccountStatementResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"PUT","path":"/holdings/accounts/{accountId}/migrations/bills","fullPath":"/api/v4.10.0/holdings/accounts/{accountId}/migrations/bills","operationId":"updateAccountBillMigration","name":"Captures the bill information of the account such as bill id, property names, bill amount etc. This is used to migrate the bills of a legacy contract which is migrated from other system & update the bill details","summary":"Captures the bill information of the account such as bill id, property names, bill amount etc. This is used to migrate the bills of a legacy contract which is migrated from other system & update the bill details","tags":["RETAIL"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"accountId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"productId":"string","drawdownDate":"2024-01-01","extensions":{},"balanceMaintenance":[{}]}},"responses":{"200":"updateAccountBillMigrationResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"PUT","path":"/holdings/accounts/{accountId}/branches","fullPath":"/api/v4.10.0/holdings/accounts/{accountId}/branches","operationId":"updateAccountBranch","name":"Updates the branch of an account","summary":"Updates the branch of an account","tags":["RETAIL"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"accountId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"effectiveDate":"2024-01-01","branch":"string","extensions":{}}},"responses":{"200":"updateAccountBranchResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"PUT","path":"/holdings/accounts/{accountId}/settlements","fullPath":"/api/v4.10.0/holdings/accounts/{accountId}/settlements","operationId":"updateAccountSettlement","name":"Update the settlement conditions of the account such as payin account, payin percentage, payin amount, payout account, payout percentage, payout amount, etc","summary":"Update the settlement conditions of the account such as payin account, payin percentage, payin amount, payout account, payout percentage, payout amount, etc","tags":["RETAIL"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"accountId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"productId":"string","drawdownDate":"2024-01-01","extensions":{},"settlement":[{}]}},"responses":{"200":"updateAccountSettlementResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"PUT","path":"/holdings/accounts/{accountId}/accounts","fullPath":"/api/v4.10.0/holdings/accounts/{accountId}/accounts","operationId":"updateAccount","name":"Update the account details to block or unblock the account by setting the posting restriction and to change the nick name of the account","summary":"Update the account's details","tags":["RETAIL"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"accountId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"productId":"string","drawdownDate":"2024-01-01","extensions":{},"balance":[{}]}},"responses":{"200":"updateAccountResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"PUT","path":"/holdings/accounts/{accountId}/schedules","fullPath":"/api/v4.10.0/holdings/accounts/{accountId}/schedules","operationId":"updateAccountSchedule","name":"Update the payment schedule condition such as payment method from capitalise to pay, payment frequency from monthly to quarterly etc., on an account","summary":"Update payment schedule for the given account","tags":["RETAIL"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"accountId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"productId":"string","drawdownDate":"2024-01-01","extensions":{},"schedule":[{}]}},"responses":{"200":"updateAccountScheduleResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"GET","path":"/holdings/accounts/accountClosures/{accountId}","fullPath":"/api/v4.10.0/holdings/accounts/accountClosures/{accountId}","operationId":"getAccountClosure","name":"Retrieves the account closure information of the account such as closure date and reason, mode of closure, balances on the date of closing and pending charges","summary":"Retrieves the account closure information","tags":["OTHERS"],"parameters":[{"name":"accountId","in":"path","type":"string","required":true,"description":"Identifier of the account. Often referred to as the account number, yet for consistency this is always referred to as accountId. Accepts both IBAN & BBAN"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"AccountClosureResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/holdings/accounts/accountClosures/{accountId}","fullPath":"/api/v4.10.0/holdings/accounts/accountClosures/{accountId}","operationId":"updateAccountClosure","name":"Updates account closure information for the specific account such as closure date and reason, mode of closure and closing charges","summary":"Updates account closure information","tags":["OTHERS"],"parameters":[{"name":"accountId","in":"path","type":"string","required":true,"description":"Identifier of the account. Often referred to as the account number, yet for consistency this is always referred to as accountId. Accepts both IBAN & BBAN"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"accountCurrency":"string","closureDate":"2024-01-01T00:00:00Z","creditAccount":"string","capitaliseInterest":"string","chargeType":"string","chargeAmount":0.0,"closeMode":"string","ftId":"string","closureReason":"string","closureNotes":"string","onlineLedgerBalance":0.0,"onlineClearedBalance":0.0,"balancePayable":0.0,"totalCreditInterest":"string","totalDebitInterest":"string"}},"responses":{"200":"AccountClosureResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/holdings/accounts/{accountId}/cards","fullPath":"/api/v4.10.0/holdings/accounts/{accountId}/cards","operationId":"getAccountCards","name":"Retrieves the card details of the account such as card number, card type and status of the card","summary":"Retrieves available card details","tags":["OTHERS"],"parameters":[{"name":"accountId","in":"path","type":"string","required":true,"description":"Identifier of the account. Often referred to as the account number, yet for consistency this is always referred to as accountId. Accepts both IBAN & BBAN"},{"name":"cardIssueId","in":"query","type":"string","required":false,"description":"The identifier of the issued card formatted as cardType '.' cardNumber. E.g. VISA.1234567887654321 GC.1111222233334444 AB21.1111111122222222"},{"name":"issueDate","in":"query","type":"string","required":false,"description":"The date the item was issued."},{"name":"expiryDate","in":"query","type":"string","required":false,"description":"This indicates the  date  on which the offer or privilege terminates for the event."},{"name":"cardStatus","in":"query","type":"string","required":false,"description":"Current status of the Card and following are the possible statuses are  - CARD.ISSUED - CARD.RETURNED - CARD.SCRAP - CARD.CANCEL - NOT.ACTIVATED - NOT.RECEIVED - ACTIVE - BLOCKED - EXPIRED"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"AccountCardsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/accounts/balances","fullPath":"/api/v4.10.0/holdings/accounts/balances","operationId":"getAccountBalanceToday","name":"Retrieves various types of balances such as cleared, online, locked and usable balance of the account","summary":"Retrieves list of account balances","tags":["OTHERS"],"parameters":[{"name":"accountId","in":"query","type":"string","required":false,"description":"Identifier of the account. Often referred to as the account number, yet for consistency this is always referred to as accountId. Accepts both IBAN & BBAN"},{"name":"customerId","in":"query","type":"string","required":false,"description":"Identifier of the customer"},{"name":"productId","in":"query","type":"string","required":false,"description":"Contains the unique identifier of the product, e.g. the product id of the arrangement account."},{"name":"currencyId","in":"query","type":"string","required":false,"description":"Identifier of the currency. This is the 3-letter ISO 4217 code of the currency."},{"name":"limitReferenceId","in":"query","type":"string","required":false,"description":"Limit reference identifier for the limit order."},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"AccountBalanceTodayResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/accounts/{accountId}/balanceMovements/{bookingDate}","fullPath":"/api/v4.10.0/holdings/accounts/{accountId}/balanceMovements/{bookingDate}","operationId":"getAccountBalanceMovement","name":"Retrieves the credit, debit and gross balance movements for an account for the requested booking date","summary":"Retrieves balances movements of account","tags":["OTHERS"],"parameters":[{"name":"accountId","in":"path","type":"string","required":true,"description":"Identifier of the account. Often referred to as the account number, yet for consistency this is always referred to as accountId. Accepts both IBAN & BBAN"},{"name":"bookingDate","in":"path","type":"string","required":true,"description":"Business date on which the accounting entry was generated."},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"AccountBalanceMovementResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/accounts/{accountId}/emergencyBlocks/status","fullPath":"/api/v4.10.0/holdings/accounts/{accountId}/emergencyBlocks/status","operationId":"getAccountEmergencyBlock","name":"Retrieve emergency block status and reason for a given account. This information will be used to assert the actual block status of an account in microservice","summary":"Retrieve emergency block information for an account","tags":["OTHERS"],"parameters":[{"name":"accountId","in":"path","type":"string","required":true,"description":"Identifier of the account. Often referred to as the account number, yet for consistency this is always referred to as accountId. Accepts both IBAN & BBAN"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"AccountEmergencyBlockResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"PUT","path":"/holdings/accounts/{accountId}/emergencyBlocks/status","fullPath":"/api/v4.10.0/holdings/accounts/{accountId}/emergencyBlocks/status","operationId":"updateAccountEmergencyBlock","name":"Updates emergency block status and reason for block of the account","summary":"Update emergency block in account","tags":["OTHERS"],"parameters":[{"name":"accountId","in":"path","type":"string","required":true,"description":""},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"emergencyBlock":"string","emergencyReason":"string","extensions":{}}},"responses":{"200":"AccountEmergencyBlockResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/holdings/accounts/{accountId}/fundsAuthorisation/status","fullPath":"/api/v4.10.0/holdings/accounts/{accountId}/fundsAuthorisation/status","operationId":"getAccountFundsAuthStatus","name":"Retrieve the funds authorisation status of the account","summary":"Retrieve account funds authorisation status","tags":["OTHERS"],"parameters":[{"name":"accountId","in":"path","type":"string","required":true,"description":"Identifier of the account. Often referred to as the account number, yet for consistency this is always referred to as accountId. Accepts both IBAN & BBAN"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"AccountFundsAuthStatusResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"PUT","path":"/holdings/accounts/{accountId}/fundsAuthorisation/status","fullPath":"/api/v4.10.0/holdings/accounts/{accountId}/fundsAuthorisation/status","operationId":"updateAccountFundsAuthStatus","name":"Update the funds authorisation status for the account, for example SYNC or ERROR","summary":"Update account funds authorisation status","tags":["OTHERS"],"parameters":[{"name":"accountId","in":"path","type":"string","required":true,"description":""},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"faStatus":"string","extensions":{}}},"responses":{"200":"AccountFundsAuthStatusResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"POST","path":"/holdings/accounts/settings/{settingId}/fundsDiversion","fullPath":"/api/v4.10.0/holdings/accounts/settings/{settingId}/fundsDiversion","operationId":"createFundsDiversion","name":"Allows creation of funds diversion conditions for a company to manage the behavior of booking funds against any account in the company that has the auto pay account defined","summary":"Creates conditions for funds diversion","tags":["OTHERS"],"parameters":[{"name":"settingId","in":"path","type":"string","required":true,"description":"Contains the particular parameter record setting identifier."},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"transactionCodes":[{}],"defaultFundsDiversion":"string","extensions":{}}},"responses":{"200":"FundsDiversionResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/holdings/accounts/settings/{settingId}/fundsDiversion","fullPath":"/api/v4.10.0/holdings/accounts/settings/{settingId}/fundsDiversion","operationId":"updateFundsDiversion","name":"Updates the funds diversion conditions for a company to manage the behavior of booking funds against any account in the company that has the auto pay account defined","summary":"Updates funds diversion parameter","tags":["OTHERS"],"parameters":[{"name":"settingId","in":"path","type":"string","required":true,"description":"Contains the particular parameter record setting identifier."},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"transactionCodes":[{}],"defaultFundsDiversion":"string","extensions":{}}},"responses":{"200":"FundsDiversionResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/holdings/nostros/forwardBalances","fullPath":"/api/v4.10.0/holdings/nostros/forwardBalances","operationId":"getNostroForwardBalances","name":"Retrieves forward balances of nostro accounts considering the transaction effective dates.","summary":"Retrieves consolidated nostro account balances","tags":["OTHERS"],"parameters":[{"name":"valueDate","in":"query","type":"string","required":false,"description":"Indicates the value date on which the underlying accounting entry is to be given value (for interest purposes)"},{"name":"accountId","in":"query","type":"string","required":true,"description":"Identifier of the account. Often referred to as the account number, yet for consistency this is always referred to as accountId. Accepts both IBAN & BBAN"},{"name":"longPositionSign","in":"query","type":"string","required":false,"description":"Polarity (sign) used to denote buy position balance.  "},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"NostroForwardBalancesResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/nostros/currencyBalances/{currencyId}/accounts","fullPath":"/api/v4.10.0/holdings/nostros/currencyBalances/{currencyId}/accounts","operationId":"getNostroBalances","name":"Retrieves the date wise balances of the nostro accounts that falls under a specific currency","summary":"Retrieves nostro account balances for a specific currency","tags":["OTHERS"],"parameters":[{"name":"currencyId","in":"path","type":"string","required":true,"description":"Identifier of the currency. This is the 3-letter ISO 4217 code of the currency."},{"name":"nostroId","in":"query","type":"string","required":false,"description":"Nostro account id"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"NostroBalancesResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/nostros/currencyBalances/{currencyId}","fullPath":"/api/v4.10.0/holdings/nostros/currencyBalances/{currencyId}","operationId":"getNostroCurrencyPositions","name":"Retrieves consolidated balances of the nostro accounts in a given currency from the current date to the next five days.","summary":"Retrieves consolidated nostro account balances for a specific currency","tags":["OTHERS"],"parameters":[{"name":"currencyId","in":"path","type":"string","required":true,"description":"Identifier of the currency. This is the 3-letter ISO 4217 code of the currency."},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"NostroCurrencyPositionsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/accounts/{accountId}","fullPath":"/api/v4.10.0/holdings/accounts/{accountId}","operationId":"getAccountDetails","name":"Retrieves the arrangement account details such as account balances, allowed, advised and outstanding limit balances, interest types and values with the corresponding mode, frequency and value of payments","summary":"Retrieves arrangement account details","tags":["OTHERS"],"parameters":[{"name":"accountId","in":"path","type":"string","required":true,"description":"Identifier of the account. Often referred to as the account number, yet for consistency this is always referred to as accountId. Accepts both IBAN & BBAN"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"AccountDetailsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/accounts/proxyIdentifiers","fullPath":"/api/v4.10.0/holdings/accounts/proxyIdentifiers","operationId":"getActiveProxyIdentifier","name":"Retrieve proxy registration status from proxy directory for a given customer number or account number or proxy type and proxy identifier","summary":"Retrieve proxy registration status","tags":["OTHERS"],"parameters":[{"name":"customerId","in":"query","type":"string","required":false,"description":"Identifier of the customer"},{"name":"alternateAccountId","in":"query","type":"string","required":false,"description":"Contains the Uniform Banking Code of the arrangement"},{"name":"proxyType","in":"query","type":"string","required":false,"description":"Type of proxy created for account"},{"name":"proxyIdentifier","in":"query","type":"string","required":false,"description":"A proxy identifier to be linked to an account based on the proxy type provided eg. Mobile number, email id and tax id"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"ActiveProxyIdentifierResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"POST","path":"/holdings/accounts/proxyIdentifiers","fullPath":"/api/v4.10.0/holdings/accounts/proxyIdentifiers","operationId":"createProxyIdentifier","name":"Register the proxy identifier with details of proxy type and scheme for a customer and account","summary":"Register the proxy identifier for the account","tags":["OTHERS"],"parameters":[{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"customerId":"string","accountId":"string","alternateAccountId":"string","proxyType":"string","proxyIdentifier":"string","proxyStatus":"string","proxyScheme":"string","proxyRole":"string","extensions":{}}},"responses":{"200":"ProxyIdentifierResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/holdings/accounts/proxyIdentifiers/{proxyIdentifierId}","fullPath":"/api/v4.10.0/holdings/accounts/proxyIdentifiers/{proxyIdentifierId}","operationId":"updateProxyIdentifier","name":"Update the specific proxy identifier to de-register the registered account or customer from the proxy directory","summary":"Update proxy directory for account to de-register the proxy identifier","tags":["OTHERS"],"parameters":[{"name":"proxyIdentifierId","in":"path","type":"string","required":true,"description":""},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"customerId":"string","accountId":"string","alternateAccountId":"string","proxyType":"string","proxyIdentifier":"string","proxyStatus":"string","proxyScheme":"string","proxyRole":"string","extensions":{}}},"responses":{"200":"ProxyIdentifierResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/holdings/accounts/{accountId}/{accountCompany}/{paymentCurrency}/{accountSwitch}/{beneficialCustomer}/payments","fullPath":"/api/v4.10.0/holdings/accounts/{accountId}/{accountCompany}/{paymentCurrency}/{accountSwitch}/{beneficialCustomer}/payments","operationId":"getAccountPaymentDetails","name":"Retrieves the account information that are required for processing or validating an account involved in a payment transaction. Provides the information such as account name, customer number, account type, account currency, IBAN, account switch details, account status (ACTIVE or INACTIVE) and account closure details.","summary":"Retrieves account details required for payment processing","tags":["OTHERS"],"parameters":[{"name":"accountId","in":"path","type":"string","required":true,"description":"Identifier of the account. Often referred to as the account number, yet for consistency this is always referred to as accountId. Accepts both IBAN & BBAN"},{"name":"accountCompany","in":"path","type":"string","required":true,"description":"Company of the account to be created"},{"name":"paymentCurrency","in":"path","type":"string","required":true,"description":"This field holds the transaction currency or currency in which payment is initiated. "},{"name":"accountSwitch","in":"path","type":"string","required":true,"description":"Indicates if availability of account switch details should be checked."},{"name":"beneficialCustomer","in":"path","type":"string","required":true,"description":"Indicates if beneficial owners of the account are to be retrieved"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"AccountPaymentDetailsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/accounts","fullPath":"/api/v4.10.0/holdings/accounts","operationId":"getAccounts","name":"Retrieves the currency, balances, limit details and arrangement details of the account","summary":"Retrieves list of account basic details","tags":["OTHERS"],"parameters":[{"name":"accountId","in":"query","type":"string","required":false,"description":"Identifier of the account. Often referred to as the account number, yet for consistency this is always referred to as accountId. Accepts both IBAN & BBAN"},{"name":"customerId","in":"query","type":"string","required":false,"description":"Identifier of the customer"},{"name":"productId","in":"query","type":"string","required":false,"description":"Contains the unique identifier of the product, e.g. the product id of the arrangement account."},{"name":"currencyId","in":"query","type":"string","required":false,"description":"Identifier of the currency. This is the 3-letter ISO 4217 code of the currency."},{"name":"currencyIdSAID","in":"query","type":"string","required":false,"description":"Indicates the criteria for the sounds like operation on the currency"},{"name":"limitReference","in":"query","type":"string","required":false,"description":"Identifies the credit limit reference for the underlying account."},{"name":"arrangementId","in":"query","type":"string","required":false,"description":"Indicates an unique identifier of an account"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"AccountsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/accounts/{contractBalanceId}/contractBalances","fullPath":"/api/v4.10.0/holdings/accounts/{contractBalanceId}/contractBalances","operationId":"getContractBalances","name":"Retrieves the contract balances of accounts or contracts with details such as contract currency, balance types, credit and debit movements and opening and closing balance of the respective balance types","summary":"Retrieves contract balances of accounts","tags":["OTHERS"],"parameters":[{"name":"contractBalanceId","in":"path","type":"string","required":true,"description":"Unique Identifier of Contract Balances"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"ContractBalancesResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"PUT","path":"/holdings/accounts/{accountId}/synchronizationError","fullPath":"/api/v4.10.0/holdings/accounts/{accountId}/synchronizationError","operationId":"updateSynchronizationError","name":"Updates error status during synchronization of the account between Transact and Funds authorization microservice.","summary":"Update synchronization error status","tags":["OTHERS"],"parameters":[{"name":"accountId","in":"path","type":"string","required":true,"description":"Identifier of the account. Often referred to as the account number, yet for consistency this is always referred to as accountId. Accepts both IBAN & BBAN"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"emergencyBlockError":"string","extensions":{}}},"responses":{"200":"SynchronizationErrorResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/holdings/accounts/{accountId}/accountSwitches/expiringSwitches","fullPath":"/api/v4.10.0/holdings/accounts/{accountId}/accountSwitches/expiringSwitches","operationId":"getExpiringAccountSwitches","name":"Retrieves the details of the expiring account switches for generating alerts such as the bank identifier code, alert date and account id of expiring switch instruction etc.","summary":"Retrieves the details of the expiring switches for generating alerts","tags":["OTHERS"],"parameters":[{"name":"accountId","in":"path","type":"string","required":true,"description":"Identifier of the account. Often referred to as the account number, yet for consistency this is always referred to as accountId. Accepts both IBAN & BBAN"},{"name":"alertStatus","in":"query","type":"string","required":false,"description":"Contains status of the Alert to be raised for switching instruction. Possible values are Pending, Sent."},{"name":"alertDate","in":"query","type":"string","required":false,"description":"Indicates the date in which an alert to be raised for a switching instruction."},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"ExpiringAccountSwitchesResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/accounts/{accountId}/accountSwitches","fullPath":"/api/v4.10.0/holdings/accounts/{accountId}/accountSwitches","operationId":"getAccountSwitchDetails","name":"Retrieves details from the account switch directory for the specific account such as the expiry date, status of the switch instruction, effective date of the switch, bank identifier code and IBAN (International Bank Account Number ) etc.","summary":"Retrieves details of the account switch requests","tags":["OTHERS"],"parameters":[{"name":"accountId","in":"path","type":"string","required":true,"description":"Identifier of the account. Often referred to as the account number, yet for consistency this is always referred to as accountId. Accepts both IBAN & BBAN"},{"name":"requestDate","in":"query","type":"string","required":false,"description":"Date on which the client's request to be classified as professional has been received."},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"AccountSwitchDetailsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"PUT","path":"/holdings/accounts/{accountId}/accountSwitches","fullPath":"/api/v4.10.0/holdings/accounts/{accountId}/accountSwitches","operationId":"updateAccountSwitchDetails","name":"Updates alert status based on the original IBAN. Used by external systems handling alert generation to mark the status from pending to sent","summary":"Updates alert status from pending to be sent for corresponding switch instructions.","tags":["OTHERS"],"parameters":[{"name":"accountId","in":"path","type":"string","required":true,"description":"Identifier of the account. Often referred to as the account number, yet for consistency this is always referred to as accountId. Accepts both IBAN & BBAN"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"accountId":"string","switchIBAN":"string","switchAccountId":"string","switchBic":"string","switchClearingCode":"string","requestDate":"string","status":"string","cancelInstruction":"string","cancelDate":"string","expiryDate":"string","IBAN":"string","bicId":"string","effectiveDate":"string","alertDate":"string","alertStatus":"string"}},"responses":{"200":"AccountSwitchDetailsResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/holdings/accounts/{accountId}/accountSwitches/payments","fullPath":"/api/v4.10.0/holdings/accounts/{accountId}/accountSwitches/payments","operationId":"getAccountSwitchPaymentDetails","name":"Retrieves information of the rerouted payments from the payment transaction exit point.","summary":"Retrieves rerouted payment information.","tags":["OTHERS"],"parameters":[{"name":"accountId","in":"path","type":"string","required":true,"description":"Identifier of the account. Often referred to as the account number, yet for consistency this is always referred to as accountId. Accepts both IBAN & BBAN"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"AccountSwitchPaymentDetailsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"PUT","path":"/holdings/accounts/accountClosures/{accountId}/approvals","fullPath":"/api/v4.10.0/holdings/accounts/accountClosures/{accountId}/approvals","operationId":"approveAccountClosure","name":"Approves account closure information to allow closing of an account which is no longer in use","summary":"Approves account closure information","tags":["OTHERS"],"parameters":[{"name":"accountId","in":"path","type":"string","required":true,"description":"Identifier of the account. Often referred to as the account number, yet for consistency this is always referred to as accountId. Accepts both IBAN & BBAN"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"AccountClosureResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/holdings/accounts/reservedFunds","fullPath":"/api/v4.10.0/holdings/accounts/reservedFunds","operationId":"getReservedFunds","name":"Retrieves the reserved funds details such as reason, amount and period of reservation of the account","summary":"Retrieves the list of reserved funds ","tags":["OTHERS"],"parameters":[{"name":"accountId","in":"query","type":"string","required":false,"description":"Identifier of the account. Often referred to as the account number, yet for consistency this is always referred to as accountId. Accepts both IBAN & BBAN"},{"name":"lockedEventReference","in":"query","type":"string","required":false,"description":"Captures the AC.LOCKED.EVENTS id if in case the funds is available and reserved."},{"name":"lockReason","in":"query","type":"string","required":false,"description":"Indicates the simple description for the balance reservation event."},{"name":"fromDate","in":"query","type":"string","required":false,"description":"Indicates the business date from when the balance reservation event is active."},{"name":"toDate","in":"query","type":"string","required":false,"description":"Indicates the business date until when the balance reservation event is active."},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"ReservedFundsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"POST","path":"/holdings/accounts/reservedFunds","fullPath":"/api/v4.10.0/holdings/accounts/reservedFunds","operationId":"createFundsReservation","name":"Creates a funds reservation with details such as account number, block or reserve amount, period of hold transaction, reason for holding. Funds reservations are created to block or reserve funds which restricts any debit movements affecting the account balance below the blocked amount for the specified period on an account.","summary":"Creates a credit or debit funds reservation to block the funds in an account","tags":["OTHERS"],"parameters":[{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"accountId":"string","lockReason":"string","fromDate":"2024-01-01","toDate":"2024-01-01","lockedAmount":"string","transactionReference":"string","transactionRetry":"string","systemId":"string","additionalDetail":"string","alternateKey":"string","reservationTypeId":"string","accountLink":"string","action":"string","creditDebitIndicator":"string","reservationIndicator":"string"}},"responses":{"200":"FundsReservationResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/holdings/accounts/reservedFunds/{lockedEventReference}","fullPath":"/api/v4.10.0/holdings/accounts/reservedFunds/{lockedEventReference}","operationId":"updateFundsReservation","name":"Update funds reservation with details such as account number, block or reserve amount, period of hold transaction, reason for holding. Funds reservations are created to block or reserve funds which restricts any debit movements affecting the account balance below the blocked amount for the specified period on an account.","summary":"Update the credit or debit funds reservation to block the funds in an account","tags":["OTHERS"],"parameters":[{"name":"lockedEventReference","in":"path","type":"string","required":true,"description":"Captures the AC.LOCKED.EVENTS id if in case the funds is available and reserved."},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"accountId":"string","lockReason":"string","fromDate":"2024-01-01","toDate":"2024-01-01","lockedAmount":"string","transactionReference":"string","transactionRetry":"string","systemId":"string","additionalDetail":"string","alternateKey":"string","reservationTypeId":"string","accountLink":"string","action":"string","creditDebitIndicator":"string","reservationIndicator":"string"}},"responses":{"200":"FundsReservationResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"DELETE","path":"/holdings/accounts/reservedFunds/{lockedEventReference}","fullPath":"/api/v4.10.0/holdings/accounts/reservedFunds/{lockedEventReference}","operationId":"cancelFundsReservation","name":"Cancels the funds reservation of an account. Funds reservations are created to block or reserve funds which restricts any debit movements affecting the account balance below the blocked amount for the specified period on an account. On removal of the funds reservations, the blocked or reserved amount is now available for usage.","summary":"Cancels the credit or debit funds reservation to unblock the funds in an account","tags":["OTHERS"],"parameters":[{"name":"lockedEventReference","in":"path","type":"string","required":true,"description":"Captures the AC.LOCKED.EVENTS id if in case the funds is available and reserved."},{"name":"payload","in":"body","type":"object","required":false,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}}},"responses":{"200":"FundsReservationResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/holdings/nostros/positions/{currencyId}","fullPath":"/api/v4.10.0/holdings/nostros/positions/{currencyId}","operationId":"getNostroPositions","name":"Retrieves nostro account balances for a given currency from the current date to the next five days.","summary":"Retrieves consolidated nostro account positions for the currency","tags":["OTHERS"],"parameters":[{"name":"currencyId","in":"path","type":"string","required":true,"description":"Identifier of the currency. This is the 3-letter ISO 4217 code of the currency."},{"name":"longPositionSign","in":"query","type":"string","required":false,"description":"Polarity (sign) used to denote buy position balance.  "},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"NostroPositionsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/accounts/{accountId}/transactionRetries/cancellations","fullPath":"/api/v4.10.0/holdings/accounts/{accountId}/transactionRetries/cancellations","operationId":"getTransactionRetryCancellations","name":"Retrieves the cancellation request applied on a single transaction retry or multiple transaction retries pertaining to an account with information such as transaction retry id, transaction retry change type and transaction retry change value.","summary":"Retrieves the cancellation request applied on a single transaction retry or multiple transaction retries pertaining to an account.","tags":["OTHERS"],"parameters":[{"name":"accountId","in":"path","type":"string","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"TransactionRetryCancellationsResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"POST","path":"/holdings/accounts/{accountId}/transactionRetries/cancellations","fullPath":"/api/v4.10.0/holdings/accounts/{accountId}/transactionRetries/cancellations","operationId":"createTransactionRetryCancellations","name":"Creates a cancellation request for a single transaction retry or multiple transaction retries pertaining to an account. The request will terminate the transaction from further retry.","summary":"Creates a cancellation request for a single transaction retry or multiple transaction retries pertaining to an account.","tags":["OTHERS"],"parameters":[{"name":"accountId","in":"path","type":"string","required":true,"description":"Identifier of the account. Often referred to as the account number, yet for consistency this is always referred to as accountId. Accepts both IBAN & BBAN"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"transactionRetryIds":[{}],"extensions":{}}},"responses":{"200":"TransactionRetryCancellationsResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/holdings/accounts/{accountId}/transactionRetries/pendings","fullPath":"/api/v4.10.0/holdings/accounts/{accountId}/transactionRetries/pendings","operationId":"getPendingTransactionRetries","name":"Retrieves various details from pending transaction retries pertaining to an account, such as retry start date, retry end date, retry frequency, retry amount, number of possible retries, total number of retries attempted, details of latest retry attempted and information of successful retry. Transaction Retries - bank transfer transactions transition through various payment statuses and in some cases a payment may move to a status from which users are unable to complete their payment. Example: In","summary":"Retrieves the pending transaction retries pertaining to an account","tags":["OTHERS"],"parameters":[{"name":"accountId","in":"path","type":"string","required":true,"description":"Identifier of the account. Often referred to as the account number, yet for consistency this is always referred to as accountId. Accepts both IBAN & BBAN"},{"name":"transactionRetryId","in":"query","type":"string","required":false,"description":"Indicates the transaction retry identifier"},{"name":"numberOfTransactionRetries","in":"query","type":"string","required":false,"description":"Indicates the number of times the transaction has to be retried."},{"name":"transactionRetryStartDate","in":"query","type":"string","required":false,"description":"Indicates the date when the transaction retry has started."},{"name":"transactionRetryEndDate","in":"query","type":"string","required":false,"description":"Indicates the date till when the transaction has to be retried."},{"name":"nextTransactionRetryDate","in":"query","type":"string","required":false,"description":"Indicates the date when transaction has to be retried next."},{"name":"transactionType","in":"query","type":"string","required":false,"description":"Identifies the transaction type applicable to the transaction being processed, i.e. outward or inward payment. For example: ACPX, OTPX etc."},{"name":"contractId","in":"query","type":"string","required":false,"description":"Indicates the unique identifier of the transaction or contract which initiated the activity"},{"name":"productGroupId","in":"query","type":"string","required":false,"description":"The group, as defined by the institution, that the product belongs to."},{"name":"productId","in":"query","type":"string","required":false,"description":"Contains the unique identifier of the product, e.g. the product id of the arrangement account."},{"name":"arrangementId","in":"query","type":"string","required":false,"description":"Indicates an unique identifier of an account"},{"name":"transactionRetryStatus","in":"query","type":"string","required":false,"description":"Indicates the transaction retry status. Possible values are: NEW - Indicates transaction is captured for retry and transaction retry is yet to be processed, CURRENT - Transaction is currently being re"},{"name":"retrySettlementStatus","in":"query","type":"string","required":false,"description":"Indicates the transaction settlement status. Possible values are: PENDING - Indicates that the transaction is yet to be settled through retry, SETTLED - Indicates that the transaction is fully settled"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"PendingTransactionRetriesResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"PUT","path":"/holdings/accounts/{accountId}/withdrawalNotices/cancellations","fullPath":"/api/v4.10.0/holdings/accounts/{accountId}/withdrawalNotices/cancellations","operationId":"cancelAccountWithdrawalNotice","name":"Cancels the notification of withdrawal of amount from account.","summary":"Cancels the notification of withdrawal of amount from account","tags":["RETAIL"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"accountId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"effectiveDate":"2024-01-01","productId":"string","extensions":{},"noticeWithdrawal":[{}]}},"responses":{"200":"cancelAccountWithdrawalNoticeResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"PUT","path":"/holdings/accounts/{accountId}/withdrawalNotices/noticeUpdates","fullPath":"/api/v4.10.0/holdings/accounts/{accountId}/withdrawalNotices/noticeUpdates","operationId":"updateAccountWithdrawalNotice","name":"Updates the notice of withdrawal of amount from  account by providing the withdrawal date, bill reference and amount etc. This is applicable only for notice type of accounts.","summary":"Updates the notice of withdrawal of amount from account","tags":["RETAIL"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"accountId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"effectiveDate":"2024-01-01","productId":"string","extensions":{},"noticeWithdrawal":[{}]}},"responses":{"200":"updateAccountWithdrawalNoticeResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"PUT","path":"/holdings/accounts/{accountId}/payouts","fullPath":"/api/v4.10.0/holdings/accounts/{accountId}/payouts","operationId":"initiateAccountPayout","name":"Performs payout of the given account amount such as charges, tax etc","summary":"Perform payout of an account","tags":["RETAIL"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"accountId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"currencyId":"string","effectiveDate":"2024-01-01","activityId":"string","transactionAmount":0.0,"contractId":"string","systemId":"string","externalEventStatus":"string","extensions":{}}},"responses":{"200":"initiateAccountPayoutResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"PUT","path":"/holdings/accounts/{accountId}/repayments","fullPath":"/api/v4.10.0/holdings/accounts/{accountId}/repayments","operationId":"initiateAccountPayin","name":"Repays the account amount such as charges, tax etc","summary":"Perform repayment of the given account","tags":["RETAIL"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"accountId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"currencyId":"string","effectiveDate":"2024-01-01","activityId":"string","transactionAmount":0.0,"contractId":"string","systemId":"string","externalEventStatus":"string","extensions":{}}},"responses":{"200":"initiateAccountPayinResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"GET","path":"/holdings/accounts/nostroAccounts","fullPath":"/api/v4.10.0/holdings/accounts/nostroAccounts","operationId":"getNostroAccounts","name":"Retrieves the currency, balance and category details of the nostro account","summary":"Retrieves list of nostro account details","tags":["OTHERS"],"parameters":[{"name":"accountId","in":"query","type":"string","required":false,"description":"Identifier of the account. Often referred to as the account number, yet for consistency this is always referred to as accountId. Accepts both IBAN & BBAN"},{"name":"customerId","in":"query","type":"string","required":false,"description":"Identifier of the customer"},{"name":"productId","in":"query","type":"string","required":false,"description":"Contains the unique identifier of the product, e.g. the product id of the arrangement account."},{"name":"currencyId","in":"query","type":"string","required":false,"description":"Identifier of the currency. This is the 3-letter ISO 4217 code of the currency."},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"NostroAccountsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"POST","path":"/holdings/accounts/nostroAccounts","fullPath":"/api/v4.10.0/holdings/accounts/nostroAccounts","operationId":"createNostroAccount","name":"Create nostro account with mandatory details such as customer, currency, account title, account officer, short title, reconcile account. A nostro account is the shadow or mirror account of the vostro account maintained by the correspondent bank. The nostro account is opened with the correspondent bank as the customer.","summary":"Create nostro account","tags":["OTHERS"],"parameters":[{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"otherOfficers":[{}],"postingRestrictIds":[{}],"alternateAccountTypes":[{}],"alternateAccountIds":[{}],"jointHolderIds":[{}],"jointRelationCodes":[{}],"additionalDetails":[{}],"customerId":"string","accountTitle":"string","accountTitle2":"string","shortTitle":"string","mnemonic":"string","positionType":"string","currencyId":"string","accountOfficer":"string"}},"responses":{"200":"NostroAccountResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"POST","path":"/holdings/accounts/internalAccounts/{accountId}","fullPath":"/api/v4.10.0/holdings/accounts/internalAccounts/{accountId}","operationId":"createInternalAccount","name":"Create bank internal account with mandatory details such as account title, short title, mnemonic, account officer. The internal accounts are created and maintained for bank's internal operations such as interbranch, intercompany transactions.","summary":"Create bank internal account","tags":["OTHERS"],"parameters":[{"name":"accountId","in":"path","type":"string","required":true,"description":"Identifier of the account. Often referred to as the account number, yet for consistency this is always referred to as accountId. Accepts both IBAN & BBAN"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"otherOfficers":[{}],"postingRestrictIds":[{}],"alternateAcctDetails":[{}],"categoryId":"string","accountTitle":"string","accountTitle2":"string","shortTitle":"string","mnemonic":"string","positionType":"string","accountOfficer":"string","highVolumeTransaction":"string","openingDate":"string","extensions":{}}},"responses":{"200":"InternalAccountResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/holdings/accounts/internalAccounts/{accountId}","fullPath":"/api/v4.10.0/holdings/accounts/internalAccounts/{accountId}","operationId":"updateInternalAccount","name":"Update bank internal account with details such as short title, account officer, account title, high volume transaction flag, alternate account id, posting restriction. The internal accounts are created and maintained for bank's internal operations such as interbranch, intercompany transactions.","summary":"Update bank internal account","tags":["OTHERS"],"parameters":[{"name":"accountId","in":"path","type":"string","required":true,"description":"Identifier of the account. Often referred to as the account number, yet for consistency this is always referred to as accountId. Accepts both IBAN & BBAN"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"otherOfficers":[{}],"postingRestrictIds":[{}],"alternateAcctDetails":[{}],"accountTitle":"string","accountTitle2":"string","shortTitle":"string","mnemonic":"string","accountOfficer":"string","highVolumeTransaction":"string","extensions":{}}},"responses":{"200":"InternalAccountResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/holdings/accounts/nostroAccounts/{accountId}","fullPath":"/api/v4.10.0/holdings/accounts/nostroAccounts/{accountId}","operationId":"updateNostroAccount","name":"Update nostro account with details such as reconciliation tolerance amount, our actual account number, short title, account officer, account title, high volume transaction flag, posting restriction. A nostro account is the shadow or mirror account of the vostro account maintained by the correspondent bank. The nostro account is opened with the correspondent bank as the customer.","summary":"Update Nostro account","tags":["OTHERS"],"parameters":[{"name":"accountId","in":"path","type":"string","required":true,"description":"Identifier of the account. Often referred to as the account number, yet for consistency this is always referred to as accountId. Accepts both IBAN & BBAN"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"otherOfficers":[{}],"postingRestrictIds":[{}],"alternateAccountTypes":[{}],"alternateAccountIds":[{}],"jointHolderIds":[{}],"jointRelationCodes":[{}],"additionalDetails":[{}],"accountTitle":"string","accountTitle2":"string","shortTitle":"string","mnemonic":"string","accountOfficer":"string","ownNostro":"string","reconciliationToleranceAmount":"string","highVolumeTransaction":"string"}},"responses":{"200":"NostroAccountResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/holdings/accounts/internalAccounts","fullPath":"/api/v4.10.0/holdings/accounts/internalAccounts","operationId":"getInternalAccounts","name":"Retrieves the currency, balance and category details of the internal account","summary":"Retrieves list of internal account details","tags":["OTHERS"],"parameters":[{"name":"accountId","in":"query","type":"string","required":false,"description":"Identifier of the account. Often referred to as the account number, yet for consistency this is always referred to as accountId. Accepts both IBAN & BBAN"},{"name":"productId","in":"query","type":"string","required":false,"description":"Contains the unique identifier of the product, e.g. the product id of the arrangement account."},{"name":"currencyId","in":"query","type":"string","required":false,"description":"Identifier of the currency. This is the 3-letter ISO 4217 code of the currency."},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"InternalAccountsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}}]},{"key":"holdings-accounts-service-v4.11.0","title":"Account management","version":"v4.11.0","description":"API to manage account related services such as retrieving balances, transaction and card details, emergency blocks, funds diversion, reservations, proxy identifiers and account closures. In addition, it provides functionality to support the capability to switch accounts from the current system to an","endpointCount":70,"endpoints":[{"method":"PUT","path":"/holdings/accounts/{accountId}/products","fullPath":"/api/v4.11.0/holdings/accounts/{accountId}/products","operationId":"updateAccountProduct","name":"Change account from one product to another such as changing savings account to current account","summary":"Change of contract from one account product to another","tags":["RETAIL"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"accountId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"effectiveDate":"2024-01-01","productId":"string","extensions":{},"balance":[{}]}},"responses":{"200":"updateAccountProductResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"PUT","path":"/holdings/accounts/{accountId}/limits","fullPath":"/api/v4.11.0/holdings/accounts/{accountId}/limits","operationId":"updateAccountLimit","name":"Update the limit conditions of the account with the secondary limit amount and other limit details","summary":"Update the limit conditions of the account","tags":["RETAIL"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"accountId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"parties":[{}],"activityId":"string","effectiveDate":"string","productId":"string","currencyId":"string","simulationId":"string","extensions":{},"limit":[{}]}},"responses":{"200":"updateAccountLimitResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"PUT","path":"/holdings/accounts/{accountId}/interestConditions","fullPath":"/api/v4.11.0/holdings/accounts/{accountId}/interestConditions","operationId":"updateAccountInterestConditions","name":"Update the interest conditions of the account such as interest rate, tier details, margin amount etc.","summary":"Update the interest conditions of the account","tags":["RETAIL"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"accountId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"effectiveDate":"2024-01-01","channel":"string","extensions":{},"crinterest":[{}]}},"responses":{"200":"updateAccountInterestConditionsResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"PUT","path":"/holdings/accounts/{accountId}/dormancyStatus/{status}","fullPath":"/api/v4.11.0/holdings/accounts/{accountId}/dormancyStatus/{status}","operationId":"updateAccountDormancyStatus","name":"Deactivates the savings account and moves it to given dormancy status.","summary":"Deactivates the savings account to given status","tags":["RETAIL"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"accountId","in":"path","type":"string","required":true,"description":""},{"name":"status","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"effectiveDate":"2024-01-01","productId":"string","extensions":{}}},"responses":{"200":"updateAccountDormancyStatusResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"PUT","path":"/holdings/accounts/{accountId}/channels","fullPath":"/api/v4.11.0/holdings/accounts/{accountId}/channels","operationId":"updateAccountChannel","name":"Updates the channel of the account","summary":"Change of channel for the account","tags":["RETAIL"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"accountId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"effectiveDate":"2024-01-01","channel":"string","extensions":{}}},"responses":{"200":"updateAccountChannelResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"POST","path":"/holdings/accounts/migrations","fullPath":"/api/v4.11.0/holdings/accounts/migrations","operationId":"initiateAccountMigration","name":"Migration of a legacy system account contract to the given account product by providing the original contract date, account name, statement, payment frequency and start date, etc. ","summary":"Migration of legacy system account contract to the given account product","tags":["RETAIL"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"partyIds":[{}],"originationReference":[{}],"effectiveDate":"2024-01-01","productId":"string","currency":"string","branch":"string","channel":"string","lineOfBusiness":"string","originalContractDate":"2024-01-01","extensions":{},"limit":[{}],"balance":[{}],"customer":[{}],"crinterest":[{}],"schedule":[{}]}},"responses":{"200":"initiateAccountMigrationResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"PUT","path":"/holdings/accounts/{accountId}/migrations/balances","fullPath":"/api/v4.11.0/holdings/accounts/{accountId}/migrations/balances","operationId":"updateAccountBalanceMigration","name":"Captures the balance details of the account such as balance type, due amount etc. This is used to migrate the balances of a legacy contract which is migrated from other system & update the balance details","summary":"Captures outstanding balance details of a contract migrated from legacy system","tags":["RETAIL"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"accountId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"productId":"string","drawdownDate":"2024-01-01","extensions":{},"balanceMaintenance":[{}]}},"responses":{"200":"updateAccountBalanceMigrationResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"PUT","path":"/holdings/accounts/{accountId}/renegotiations","fullPath":"/api/v4.11.0/holdings/accounts/{accountId}/renegotiations","operationId":"updateAccountConditions","name":"Perform the renegotiation of the account contract details such as payment frequency, payment start date, interest rate, statement frequency and settlement details, etc.","summary":"Renegotiation of the account contract details","tags":["RETAIL"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"accountId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"effectiveDate":"2024-01-01","productId":"string","extensions":{},"limit":[{}],"balance":[{}],"customer":[{}],"crinterest":[{}],"schedule":[{}],"settlement":[{}],"statement":[{}]}},"responses":{"200":"updateAccountConditionsResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"PUT","path":"/holdings/accounts/{accountId}/dormancyStatus/reactivations","fullPath":"/api/v4.11.0/holdings/accounts/{accountId}/dormancyStatus/reactivations","operationId":"updateAccountDormancyReactivation","name":"Reset the dormant account to active status manually","summary":"Reset the account dormancy status","tags":["RETAIL"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"accountId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"effectiveDate":"2024-01-01","productId":"string","extensions":{}}},"responses":{"200":"updateAccountDormancyReactivationResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"PUT","path":"/holdings/accounts/{accountId}/withdrawalNotices","fullPath":"/api/v4.11.0/holdings/accounts/{accountId}/withdrawalNotices","operationId":"createAccountWithdrawalNotice","name":"Notifies the withdrawal of amount from account by providing the withdrawal date and amount etc. This is applicable only for notice type of accounts.","summary":"Notifies the withdrawal amount from account","tags":["RETAIL"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"accountId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"effectiveDate":"2024-01-01","productId":"string","extensions":{},"noticeWithdrawal":[{}]}},"responses":{"200":"createAccountWithdrawalNoticeResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"PUT","path":"/holdings/accounts/{accountId}/customers","fullPath":"/api/v4.11.0/holdings/accounts/{accountId}/customers","operationId":"updateAccountCustomer","name":"Update the customer details of the account such as add or remove the joint customers, tax liability percentange, limit liability percentage of the joint customers","summary":"Update customers for the given account","tags":["RETAIL"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"accountId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"partyIds":[{}],"effectiveDate":"2024-01-01","extensions":{},"customer":[{}]}},"responses":{"200":"updateAccountCustomerResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"PUT","path":"/holdings/accounts/{accountId}/credits","fullPath":"/api/v4.11.0/holdings/accounts/{accountId}/credits","operationId":"updateAccountCredit","name":"Perform credit transactions in an account, providing the credit amount and the currency in which to be credited","summary":"Perform credit transaction in an account.","tags":["RETAIL"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"accountId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"currencyId":"string","effectiveDate":"2024-01-01","activityId":"string","transactionAmount":0.0,"contractId":"string","systemId":"string","externalEventStatus":"string","extensions":{}}},"responses":{"200":"updateAccountCreditResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"PUT","path":"/holdings/accounts/{accountId}/debits","fullPath":"/api/v4.11.0/holdings/accounts/{accountId}/debits","operationId":"updateAccountDebit","name":"Perform debit transactions in an account by providing debit amount and currency in which to be debited","summary":"Perform debit transactions in an account","tags":["RETAIL"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"accountId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"currencyId":"string","effectiveDate":"2024-01-01","activityId":"string","transactionAmount":0.0,"contractId":"string","systemId":"string","externalEventStatus":"string","extensions":{}}},"responses":{"200":"updateAccountDebitResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"PUT","path":"/holdings/accounts/{accountId}/adjustments","fullPath":"/api/v4.11.0/holdings/accounts/{accountId}/adjustments","operationId":"updateAccountAdjustment","name":"Performs backdated adjustment and re-accrual for the given savings account.  This is used when interest adjustment is required due to backdated rate change or transaction.","summary":"Performs backdated adjustment and re-accrual for the given savings account ","tags":["RETAIL"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"accountId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"currencyId":"string","effectiveDate":"2024-01-01","activityId":"string","transactionAmount":0.0,"contractId":"string","systemId":"string","externalEventStatus":"string","extensions":{}}},"responses":{"200":"updateAccountAdjustmentResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"PUT","path":"/holdings/accounts/{accountId}/lineofBusiness","fullPath":"/api/v4.11.0/holdings/accounts/{accountId}/lineofBusiness","operationId":"updateAccountLob","name":"Updates the type of line of business of the account","summary":"Change of line of business for the account","tags":["RETAIL"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"accountId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"effectiveDate":"2024-01-01","lineOfBusiness":"string","extensions":{}}},"responses":{"200":"updateAccountLobResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"GET","path":"/holdings/accounts/{accountId}/dormancyConditions","fullPath":"/api/v4.11.0/holdings/accounts/{accountId}/dormancyConditions","operationId":"getAccountDormancyDetails","name":"Retrieves the dormancy setup details for the account such as dormancy period, status etc","summary":"Retrieves the account dormancy conditions","tags":["RETAIL"],"parameters":[{"name":"accountId","in":"path","type":"string","required":true,"description":"Identifier of the account. Often referred to as the account number, yet for consistency this is always referred to as accountId. Accepts both IBAN & BBAN"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"AccountDormancyDetailsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/accounts/{accountId}/transactions","fullPath":"/api/v4.11.0/holdings/accounts/{accountId}/transactions","operationId":"getAccountTransactions","name":"Retrieves account transaction details such as transaction type, amount, transaction reference, credit or debit indicator, booking and effective date of transaction","summary":"Retrieves account transaction details","tags":["RETAIL"],"parameters":[{"name":"accountId","in":"path","type":"string","required":true,"description":"Identifier of the account. Often referred to as the account number, yet for consistency this is always referred to as accountId. Accepts both IBAN & BBAN"},{"name":"fromDate","in":"query","type":"string","required":false,"description":"Indicates the business date from when the balance reservation event is active."},{"name":"toDate","in":"query","type":"string","required":false,"description":"Indicates the business date until when the balance reservation event is active."},{"name":"transactionReference","in":"query","type":"string","required":false,"description":"Contains the identifier for the transaction in the core system"},{"name":"period","in":"query","type":"string","required":false,"description":"Indicates spread of time buckets.Ex: 3M,6M,9M,10Y etc."},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"AccountTransactionsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/accounts/accountsDetails","fullPath":"/api/v4.11.0/holdings/accounts/accountsDetails","operationId":"getAccountInfo","name":"Retrieves the currency, balances, limit details and arrangement details of the account","summary":"Retrieves list of account basic details","tags":["RETAIL"],"parameters":[{"name":"customer","in":"query","type":"string","required":false,"description":"Contains the customer identifier to fetch list of consent arrangements for the customer or customer identifier of the debtor account. This will be populated once the SCA(Strong Customer Authentication"},{"name":"arrangementId","in":"query","type":"string","required":false,"description":"Indicates an unique identifier of an account"},{"name":"currency","in":"query","type":"string","required":false,"description":"Identifies the currency. E.g. USD, GBP etc"},{"name":"companyCode","in":"query","type":"string","required":false,"description":"The identifier of the underlying Entity/Company/Branch."},{"name":"productId","in":"query","type":"string","required":false,"description":"Contains the unique identifier of the product, e.g. the product id of the arrangement account."},{"name":"status","in":"query","type":"string","required":false,"description":"Contains status of the data rights request.Allowed values are INITIATED, INPROGESS, EXTENDED, COMPLETED, REJECTED."},{"name":"accountId","in":"query","type":"string","required":false,"description":"Identifier of the account. Often referred to as the account number, yet for consistency this is always referred to as accountId. Accepts both IBAN & BBAN"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"AccountInfoResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/accounts/{accountId}/statements","fullPath":"/api/v4.11.0/holdings/accounts/{accountId}/statements","operationId":"getAccountStatementDetails","name":"Retrieves the statement frequency of an account","summary":"Retrieves the statement frequency of an account","tags":["RETAIL"],"parameters":[{"name":"accountId","in":"path","type":"string","required":true,"description":"Identifier of the account. Often referred to as the account number, yet for consistency this is always referred to as accountId. Accepts both IBAN & BBAN"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"AccountStatementDetailsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"PUT","path":"/holdings/accounts/{accountId}/statements","fullPath":"/api/v4.11.0/holdings/accounts/{accountId}/statements","operationId":"updateAccountStatement","name":"Update the statement frequency of an account.","summary":"Update the statement frequency of an account","tags":["RETAIL"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"productId":"string","drawdownDate":"2024-01-01","extensions":{},"statement":[{}]}},"responses":{"200":"updateAccountStatementResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"PUT","path":"/holdings/accounts/{accountId}/migrations/bills","fullPath":"/api/v4.11.0/holdings/accounts/{accountId}/migrations/bills","operationId":"updateAccountBillMigration","name":"Captures the bill information of the account such as bill id, property names, bill amount etc. This is used to migrate the bills of a legacy contract which is migrated from other system & update the bill details","summary":"Captures the bill information of the account such as bill id, property names, bill amount etc. This is used to migrate the bills of a legacy contract which is migrated from other system & update the bill details","tags":["RETAIL"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"accountId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"productId":"string","drawdownDate":"2024-01-01","extensions":{},"balanceMaintenance":[{}]}},"responses":{"200":"updateAccountBillMigrationResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"PUT","path":"/holdings/accounts/{accountId}/branches","fullPath":"/api/v4.11.0/holdings/accounts/{accountId}/branches","operationId":"updateAccountBranch","name":"Updates the branch of an account","summary":"Updates the branch of an account","tags":["RETAIL"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"accountId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"effectiveDate":"2024-01-01","branch":"string","extensions":{}}},"responses":{"200":"updateAccountBranchResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"PUT","path":"/holdings/accounts/{accountId}/settlements","fullPath":"/api/v4.11.0/holdings/accounts/{accountId}/settlements","operationId":"updateAccountSettlement","name":"Update the settlement conditions of the account such as payin account, payin percentage, payin amount, payout account, payout percentage, payout amount, etc","summary":"Update the settlement conditions of the account such as payin account, payin percentage, payin amount, payout account, payout percentage, payout amount, etc","tags":["RETAIL"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"accountId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"productId":"string","drawdownDate":"2024-01-01","extensions":{},"settlement":[{}]}},"responses":{"200":"updateAccountSettlementResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"PUT","path":"/holdings/accounts/{accountId}/accounts","fullPath":"/api/v4.11.0/holdings/accounts/{accountId}/accounts","operationId":"updateAccount","name":"Update the account details to block or unblock the account by setting the posting restriction and to change the nick name of the account","summary":"Update the account's details","tags":["RETAIL"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"accountId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"productId":"string","drawdownDate":"2024-01-01","extensions":{},"balance":[{}]}},"responses":{"200":"updateAccountResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"PUT","path":"/holdings/accounts/{accountId}/schedules","fullPath":"/api/v4.11.0/holdings/accounts/{accountId}/schedules","operationId":"updateAccountSchedule","name":"Update the payment schedule condition such as payment method from capitalise to pay, payment frequency from monthly to quarterly etc., on an account","summary":"Update payment schedule for the given account","tags":["RETAIL"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"accountId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"productId":"string","drawdownDate":"2024-01-01","extensions":{},"schedule":[{}]}},"responses":{"200":"updateAccountScheduleResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"GET","path":"/holdings/accounts/accountClosures/{accountId}","fullPath":"/api/v4.11.0/holdings/accounts/accountClosures/{accountId}","operationId":"getAccountClosure","name":"Retrieves the account closure information of the account such as closure date and reason, mode of closure, balances on the date of closing and pending charges","summary":"Retrieves the account closure information","tags":["OTHERS"],"parameters":[{"name":"accountId","in":"path","type":"string","required":true,"description":"Identifier of the account. Often referred to as the account number, yet for consistency this is always referred to as accountId. Accepts both IBAN & BBAN"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"AccountClosureResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/holdings/accounts/accountClosures/{accountId}","fullPath":"/api/v4.11.0/holdings/accounts/accountClosures/{accountId}","operationId":"updateAccountClosure","name":"Updates account closure information for the specific account such as closure date and reason, mode of closure and closing charges","summary":"Updates account closure information","tags":["OTHERS"],"parameters":[{"name":"accountId","in":"path","type":"string","required":true,"description":"Identifier of the account. Often referred to as the account number, yet for consistency this is always referred to as accountId. Accepts both IBAN & BBAN"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"accountCurrency":"string","closureDate":"2024-01-01T00:00:00Z","creditAccount":"string","capitaliseInterest":"string","chargeType":"string","chargeAmount":0.0,"closeMode":"string","ftId":"string","closureReason":"string","closureNotes":"string","onlineLedgerBalance":0.0,"onlineClearedBalance":0.0,"balancePayable":0.0,"totalCreditInterest":"string","totalDebitInterest":"string"}},"responses":{"200":"AccountClosureResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/holdings/accounts/{accountId}/cards","fullPath":"/api/v4.11.0/holdings/accounts/{accountId}/cards","operationId":"getAccountCards","name":"Retrieves the card details of the account such as card number, card type and status of the card","summary":"Retrieves available card details","tags":["OTHERS"],"parameters":[{"name":"accountId","in":"path","type":"string","required":true,"description":"Identifier of the account. Often referred to as the account number, yet for consistency this is always referred to as accountId. Accepts both IBAN & BBAN"},{"name":"cardIssueId","in":"query","type":"string","required":false,"description":"The identifier of the issued card formatted as cardType '.' cardNumber. E.g. VISA.1234567887654321 GC.1111222233334444 AB21.1111111122222222"},{"name":"issueDate","in":"query","type":"string","required":false,"description":"The date the item was issued."},{"name":"expiryDate","in":"query","type":"string","required":false,"description":"This indicates the  date  on which the offer or privilege terminates for the event."},{"name":"cardStatus","in":"query","type":"string","required":false,"description":"Current status of the Card and following are the possible statuses are  - CARD.ISSUED - CARD.RETURNED - CARD.SCRAP - CARD.CANCEL - NOT.ACTIVATED - NOT.RECEIVED - ACTIVE - BLOCKED - EXPIRED"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"AccountCardsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/accounts/balances","fullPath":"/api/v4.11.0/holdings/accounts/balances","operationId":"getAccountBalanceToday","name":"Retrieves various types of balances such as cleared, online, locked and usable balance of the account","summary":"Retrieves list of account balances","tags":["OTHERS"],"parameters":[{"name":"accountId","in":"query","type":"string","required":false,"description":"Identifier of the account. Often referred to as the account number, yet for consistency this is always referred to as accountId. Accepts both IBAN & BBAN"},{"name":"customerId","in":"query","type":"string","required":false,"description":"Identifier of the customer"},{"name":"productId","in":"query","type":"string","required":false,"description":"Contains the unique identifier of the product, e.g. the product id of the arrangement account."},{"name":"currencyId","in":"query","type":"string","required":false,"description":"Identifier of the currency. This is the 3-letter ISO 4217 code of the currency."},{"name":"limitReferenceId","in":"query","type":"string","required":false,"description":"Limit reference identifier for the limit order."},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"AccountBalanceTodayResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/accounts/{accountId}/balanceMovements/{bookingDate}","fullPath":"/api/v4.11.0/holdings/accounts/{accountId}/balanceMovements/{bookingDate}","operationId":"getAccountBalanceMovement","name":"Retrieves the credit, debit and gross balance movements for an account for the requested booking date","summary":"Retrieves balances movements of account","tags":["OTHERS"],"parameters":[{"name":"accountId","in":"path","type":"string","required":true,"description":"Identifier of the account. Often referred to as the account number, yet for consistency this is always referred to as accountId. Accepts both IBAN & BBAN"},{"name":"bookingDate","in":"path","type":"string","required":true,"description":"Business date on which the accounting entry was generated."},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"AccountBalanceMovementResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/accounts/{accountId}/emergencyBlocks/status","fullPath":"/api/v4.11.0/holdings/accounts/{accountId}/emergencyBlocks/status","operationId":"getAccountEmergencyBlock","name":"Retrieve emergency block status and reason for a given account. This information will be used to assert the actual block status of an account in microservice","summary":"Retrieve emergency block information for an account","tags":["OTHERS"],"parameters":[{"name":"accountId","in":"path","type":"string","required":true,"description":"Identifier of the account. Often referred to as the account number, yet for consistency this is always referred to as accountId. Accepts both IBAN & BBAN"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"AccountEmergencyBlockResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"PUT","path":"/holdings/accounts/{accountId}/emergencyBlocks/status","fullPath":"/api/v4.11.0/holdings/accounts/{accountId}/emergencyBlocks/status","operationId":"updateAccountEmergencyBlock","name":"Updates emergency block status and reason for block of the account","summary":"Update emergency block in account","tags":["OTHERS"],"parameters":[{"name":"accountId","in":"path","type":"string","required":true,"description":""},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"emergencyBlock":"string","emergencyReason":"string","extensions":{}}},"responses":{"200":"AccountEmergencyBlockResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/holdings/accounts/{accountId}/fundsAuthorisations/status","fullPath":"/api/v4.11.0/holdings/accounts/{accountId}/fundsAuthorisations/status","operationId":"getAccountFundsAuthStatus","name":"Retrieve the funds authorisation status of the account","summary":"Retrieve account funds authorisation status","tags":["OTHERS"],"parameters":[{"name":"accountId","in":"path","type":"string","required":true,"description":"Identifier of the account. Often referred to as the account number, yet for consistency this is always referred to as accountId. Accepts both IBAN & BBAN"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"AccountFundsAuthStatusResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"PUT","path":"/holdings/accounts/{accountId}/fundsAuthorisations/status","fullPath":"/api/v4.11.0/holdings/accounts/{accountId}/fundsAuthorisations/status","operationId":"updateAccountFundsAuthStatus","name":"Update the funds authorisation status for the account, for example SYNC or ERROR","summary":"Update account funds authorisation status","tags":["OTHERS"],"parameters":[{"name":"accountId","in":"path","type":"string","required":true,"description":""},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"faStatus":"string","extensions":{}}},"responses":{"200":"AccountFundsAuthStatusResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"POST","path":"/holdings/accounts/settings/{settingId}/fundsDiversion","fullPath":"/api/v4.11.0/holdings/accounts/settings/{settingId}/fundsDiversion","operationId":"createFundsDiversion","name":"Allows creation of funds diversion conditions for a company to manage the behavior of booking funds against any account in the company that has the auto pay account defined","summary":"Creates conditions for funds diversion","tags":["OTHERS"],"parameters":[{"name":"settingId","in":"path","type":"string","required":true,"description":"Contains the particular parameter record setting identifier."},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"transactionCodes":[{}],"defaultFundsDiversion":"string","extensions":{}}},"responses":{"200":"FundsDiversionResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/holdings/accounts/settings/{settingId}/fundsDiversion","fullPath":"/api/v4.11.0/holdings/accounts/settings/{settingId}/fundsDiversion","operationId":"updateFundsDiversion","name":"Updates the funds diversion conditions for a company to manage the behavior of booking funds against any account in the company that has the auto pay account defined","summary":"Updates funds diversion parameter","tags":["OTHERS"],"parameters":[{"name":"settingId","in":"path","type":"string","required":true,"description":"Contains the particular parameter record setting identifier."},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"transactionCodes":[{}],"defaultFundsDiversion":"string","extensions":{}}},"responses":{"200":"FundsDiversionResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/holdings/nostros/forwardBalances","fullPath":"/api/v4.11.0/holdings/nostros/forwardBalances","operationId":"getNostroForwardBalances","name":"Retrieves forward balances of nostro accounts considering the transaction effective dates.","summary":"Retrieves consolidated nostro account balances","tags":["OTHERS"],"parameters":[{"name":"valueDate","in":"query","type":"string","required":false,"description":"Indicates the value date on which the underlying accounting entry is to be given value (for interest purposes)"},{"name":"accountId","in":"query","type":"string","required":true,"description":"Identifier of the account. Often referred to as the account number, yet for consistency this is always referred to as accountId. Accepts both IBAN & BBAN"},{"name":"longPositionSign","in":"query","type":"string","required":false,"description":"Polarity (sign) used to denote buy position balance.  "},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"NostroForwardBalancesResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/nostros/currencyBalances/{currencyId}/accounts","fullPath":"/api/v4.11.0/holdings/nostros/currencyBalances/{currencyId}/accounts","operationId":"getNostroBalances","name":"Retrieves the date wise balances of the nostro accounts that falls under a specific currency","summary":"Retrieves nostro account balances for a specific currency","tags":["OTHERS"],"parameters":[{"name":"currencyId","in":"path","type":"string","required":true,"description":"Identifier of the currency. This is the 3-letter ISO 4217 code of the currency."},{"name":"nostroId","in":"query","type":"string","required":false,"description":"Nostro account id"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"NostroBalancesResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/nostros/currencyBalances/{currencyId}","fullPath":"/api/v4.11.0/holdings/nostros/currencyBalances/{currencyId}","operationId":"getNostroCurrencyPositions","name":"Retrieves consolidated balances of the nostro accounts in a given currency from the current date to the next five days.","summary":"Retrieves consolidated nostro account balances for a specific currency","tags":["OTHERS"],"parameters":[{"name":"currencyId","in":"path","type":"string","required":true,"description":"Identifier of the currency. This is the 3-letter ISO 4217 code of the currency."},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"NostroCurrencyPositionsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/accounts/{accountId}","fullPath":"/api/v4.11.0/holdings/accounts/{accountId}","operationId":"getAccountDetails","name":"Retrieves the arrangement account details such as account balances, allowed, advised and outstanding limit balances, interest types and values with the corresponding mode, frequency and value of payments","summary":"Retrieves arrangement account details","tags":["OTHERS"],"parameters":[{"name":"accountId","in":"path","type":"string","required":true,"description":"Identifier of the account. Often referred to as the account number, yet for consistency this is always referred to as accountId. Accepts both IBAN & BBAN"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"AccountDetailsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/accounts/proxyIdentifiers","fullPath":"/api/v4.11.0/holdings/accounts/proxyIdentifiers","operationId":"getActiveProxyIdentifier","name":"Retrieve proxy registration status from proxy directory for a given customer number or account number or proxy type and proxy identifier","summary":"Retrieve proxy registration status","tags":["OTHERS"],"parameters":[{"name":"customerId","in":"query","type":"string","required":false,"description":"Identifier of the customer"},{"name":"alternateAccountId","in":"query","type":"string","required":false,"description":"Contains the Uniform Banking Code of the arrangement"},{"name":"proxyType","in":"query","type":"string","required":false,"description":"Type of proxy created for account"},{"name":"proxyIdentifier","in":"query","type":"string","required":false,"description":"A proxy identifier to be linked to an account based on the proxy type provided eg. Mobile number, email id and tax id"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"ActiveProxyIdentifierResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"POST","path":"/holdings/accounts/proxyIdentifiers","fullPath":"/api/v4.11.0/holdings/accounts/proxyIdentifiers","operationId":"createProxyIdentifier","name":"Register the proxy identifier with details of proxy type and scheme for a customer and account","summary":"Register the proxy identifier for the account","tags":["OTHERS"],"parameters":[{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"customerId":"string","accountId":"string","alternateAccountId":"string","proxyType":"string","proxyIdentifier":"string","proxyStatus":"string","proxyScheme":"string","proxyRole":"string","extensions":{}}},"responses":{"200":"ProxyIdentifierResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/holdings/accounts/proxyIdentifiers/{proxyIdentifierId}","fullPath":"/api/v4.11.0/holdings/accounts/proxyIdentifiers/{proxyIdentifierId}","operationId":"updateProxyIdentifier","name":"Update the specific proxy identifier to de-register the registered account or customer from the proxy directory","summary":"Update proxy directory for account to de-register the proxy identifier","tags":["OTHERS"],"parameters":[{"name":"proxyIdentifierId","in":"path","type":"string","required":true,"description":""},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"customerId":"string","accountId":"string","alternateAccountId":"string","proxyType":"string","proxyIdentifier":"string","proxyStatus":"string","proxyScheme":"string","proxyRole":"string","extensions":{}}},"responses":{"200":"ProxyIdentifierResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/holdings/accounts/{accountId}/{accountCompany}/{paymentCurrency}/{accountSwitch}/{beneficialCustomer}/payments","fullPath":"/api/v4.11.0/holdings/accounts/{accountId}/{accountCompany}/{paymentCurrency}/{accountSwitch}/{beneficialCustomer}/payments","operationId":"getAccountPaymentDetails","name":"Retrieves the account information that are required for processing or validating an account involved in a payment transaction. Provides the information such as account name, customer number, account type, account currency, IBAN, account switch details, account status (ACTIVE or INACTIVE) and account closure details.","summary":"Retrieves account details required for payment processing","tags":["OTHERS"],"parameters":[{"name":"accountId","in":"path","type":"string","required":true,"description":"Identifier of the account. Often referred to as the account number, yet for consistency this is always referred to as accountId. Accepts both IBAN & BBAN"},{"name":"accountCompany","in":"path","type":"string","required":true,"description":"Company of the account to be created"},{"name":"paymentCurrency","in":"path","type":"string","required":true,"description":"This field holds the transaction currency or currency in which payment is initiated. "},{"name":"accountSwitch","in":"path","type":"string","required":true,"description":"Indicates if availability of account switch details should be checked."},{"name":"beneficialCustomer","in":"path","type":"string","required":true,"description":"Indicates if beneficial owners of the account are to be retrieved"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"AccountPaymentDetailsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/accounts/{contractBalanceId}/contractBalances","fullPath":"/api/v4.11.0/holdings/accounts/{contractBalanceId}/contractBalances","operationId":"getContractBalances","name":"Retrieves the contract balances of accounts or contracts with details such as contract currency, balance types, credit and debit movements and opening and closing balance of the respective balance types","summary":"Retrieves contract balances of accounts","tags":["OTHERS"],"parameters":[{"name":"contractBalanceId","in":"path","type":"string","required":true,"description":"Unique Identifier of Contract Balances"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"ContractBalancesResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"PUT","path":"/holdings/accounts/{accountId}/synchronizationError","fullPath":"/api/v4.11.0/holdings/accounts/{accountId}/synchronizationError","operationId":"updateSynchronizationError","name":"Updates error status during synchronization of the account between Transact and Funds authorization microservice.","summary":"Update synchronization error status","tags":["OTHERS"],"parameters":[{"name":"accountId","in":"path","type":"string","required":true,"description":"Identifier of the account. Often referred to as the account number, yet for consistency this is always referred to as accountId. Accepts both IBAN & BBAN"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"emergencyBlockError":"string","extensions":{}}},"responses":{"200":"SynchronizationErrorResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/holdings/accounts/{accountId}/accountSwitches/expiringSwitches","fullPath":"/api/v4.11.0/holdings/accounts/{accountId}/accountSwitches/expiringSwitches","operationId":"getExpiringAccountSwitches","name":"Retrieves the details of the expiring account switches for generating alerts such as the bank identifier code, alert date and account id of expiring switch instruction etc.","summary":"Retrieves the details of the expiring switches for generating alerts","tags":["OTHERS"],"parameters":[{"name":"accountId","in":"path","type":"string","required":true,"description":"Identifier of the account. Often referred to as the account number, yet for consistency this is always referred to as accountId. Accepts both IBAN & BBAN"},{"name":"alertStatus","in":"query","type":"string","required":false,"description":"Contains status of the Alert to be raised for switching instruction. Possible values are Pending, Sent."},{"name":"alertDate","in":"query","type":"string","required":false,"description":"Indicates the date in which an alert to be raised for a switching instruction."},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"ExpiringAccountSwitchesResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/accounts/{accountId}/accountSwitches","fullPath":"/api/v4.11.0/holdings/accounts/{accountId}/accountSwitches","operationId":"getAccountSwitchDetails","name":"Retrieves details from the account switch directory for the specific account such as the expiry date, status of the switch instruction, effective date of the switch, bank identifier code and IBAN (International Bank Account Number ) etc.","summary":"Retrieves details of the account switch requests","tags":["OTHERS"],"parameters":[{"name":"accountId","in":"path","type":"string","required":true,"description":"Identifier of the account. Often referred to as the account number, yet for consistency this is always referred to as accountId. Accepts both IBAN & BBAN"},{"name":"requestDate","in":"query","type":"string","required":false,"description":"Date on which the client's request to be classified as professional has been received."},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"AccountSwitchDetailsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"PUT","path":"/holdings/accounts/{accountId}/accountSwitches","fullPath":"/api/v4.11.0/holdings/accounts/{accountId}/accountSwitches","operationId":"updateAccountSwitchDetails","name":"Updates alert status based on the original IBAN. Used by external systems handling alert generation to mark the status from pending to sent","summary":"Updates alert status from pending to be sent for corresponding switch instructions.","tags":["OTHERS"],"parameters":[{"name":"accountId","in":"path","type":"string","required":true,"description":"Identifier of the account. Often referred to as the account number, yet for consistency this is always referred to as accountId. Accepts both IBAN & BBAN"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"accountId":"string","switchIBAN":"string","switchAccountId":"string","switchBic":"string","switchClearingCode":"string","requestDate":"string","status":"string","cancelInstruction":"string","cancelDate":"string","expiryDate":"string","IBAN":"string","bicId":"string","effectiveDate":"string","alertDate":"string","alertStatus":"string"}},"responses":{"200":"AccountSwitchDetailsResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/holdings/accounts/{accountId}/accountSwitches/payments","fullPath":"/api/v4.11.0/holdings/accounts/{accountId}/accountSwitches/payments","operationId":"getAccountSwitchPaymentDetails","name":"Retrieves information of the rerouted payments from the payment transaction exit point.","summary":"Retrieves rerouted payment information.","tags":["OTHERS"],"parameters":[{"name":"accountId","in":"path","type":"string","required":true,"description":"Identifier of the account. Often referred to as the account number, yet for consistency this is always referred to as accountId. Accepts both IBAN & BBAN"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"AccountSwitchPaymentDetailsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"PUT","path":"/holdings/accounts/accountClosures/{accountId}/approvals","fullPath":"/api/v4.11.0/holdings/accounts/accountClosures/{accountId}/approvals","operationId":"approveAccountClosure","name":"Approves account closure information to allow closing of an account which is no longer in use","summary":"Approves account closure information","tags":["OTHERS"],"parameters":[{"name":"accountId","in":"path","type":"string","required":true,"description":"Identifier of the account. Often referred to as the account number, yet for consistency this is always referred to as accountId. Accepts both IBAN & BBAN"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"AccountClosureResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/holdings/accounts/reservedFunds","fullPath":"/api/v4.11.0/holdings/accounts/reservedFunds","operationId":"getReservedFunds","name":"Retrieves the reserved funds details such as reason, amount and period of reservation of the account","summary":"Retrieves the list of reserved funds ","tags":["OTHERS"],"parameters":[{"name":"accountId","in":"query","type":"string","required":false,"description":"Identifier of the account. Often referred to as the account number, yet for consistency this is always referred to as accountId. Accepts both IBAN & BBAN"},{"name":"lockedEventReference","in":"query","type":"string","required":false,"description":"Captures the AC.LOCKED.EVENTS id if in case the funds is available and reserved."},{"name":"lockReason","in":"query","type":"string","required":false,"description":"Indicates the simple description for the balance reservation event."},{"name":"fromDate","in":"query","type":"string","required":false,"description":"Indicates the business date from when the balance reservation event is active."},{"name":"toDate","in":"query","type":"string","required":false,"description":"Indicates the business date until when the balance reservation event is active."},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"ReservedFundsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"POST","path":"/holdings/accounts/reservedFunds","fullPath":"/api/v4.11.0/holdings/accounts/reservedFunds","operationId":"createFundsReservation","name":"Creates a funds reservation with details such as account number, block or reserve amount, period of hold transaction, reason for holding. Funds reservations are created to block or reserve funds which restricts any debit movements affecting the account balance below the blocked amount for the specified period on an account.","summary":"Creates a credit or debit funds reservation to block the funds in an account","tags":["OTHERS"],"parameters":[{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"accountId":"string","lockReason":"string","fromDate":"2024-01-01","toDate":"2024-01-01","lockedAmount":"string","transactionReference":"string","transactionRetry":"string","systemId":"string","additionalDetail":"string","alternateKey":"string","reservationTypeId":"string","accountLink":"string","action":"string","creditDebitIndicator":"string","reservationIndicator":"string"}},"responses":{"200":"FundsReservationResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/holdings/accounts/reservedFunds/{lockedEventReference}","fullPath":"/api/v4.11.0/holdings/accounts/reservedFunds/{lockedEventReference}","operationId":"updateFundsReservation","name":"Update funds reservation with details such as account number, block or reserve amount, period of hold transaction, reason for holding. Funds reservations are created to block or reserve funds which restricts any debit movements affecting the account balance below the blocked amount for the specified period on an account.","summary":"Update the credit or debit funds reservation to block the funds in an account","tags":["OTHERS"],"parameters":[{"name":"lockedEventReference","in":"path","type":"string","required":true,"description":"Captures the AC.LOCKED.EVENTS id if in case the funds is available and reserved."},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"accountId":"string","lockReason":"string","fromDate":"2024-01-01","toDate":"2024-01-01","lockedAmount":"string","transactionReference":"string","transactionRetry":"string","systemId":"string","additionalDetail":"string","alternateKey":"string","reservationTypeId":"string","accountLink":"string","action":"string","creditDebitIndicator":"string","reservationIndicator":"string"}},"responses":{"200":"FundsReservationResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"DELETE","path":"/holdings/accounts/reservedFunds/{lockedEventReference}","fullPath":"/api/v4.11.0/holdings/accounts/reservedFunds/{lockedEventReference}","operationId":"cancelFundsReservation","name":"Cancels the funds reservation of an account. Funds reservations are created to block or reserve funds which restricts any debit movements affecting the account balance below the blocked amount for the specified period on an account. On removal of the funds reservations, the blocked or reserved amount is now available for usage.","summary":"Cancels the credit or debit funds reservation to unblock the funds in an account","tags":["OTHERS"],"parameters":[{"name":"lockedEventReference","in":"path","type":"string","required":true,"description":"Captures the AC.LOCKED.EVENTS id if in case the funds is available and reserved."},{"name":"payload","in":"body","type":"object","required":false,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}}},"responses":{"200":"FundsReservationResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/holdings/nostros/positions/{currencyId}","fullPath":"/api/v4.11.0/holdings/nostros/positions/{currencyId}","operationId":"getNostroPositions","name":"Retrieves nostro account balances for a given currency from the current date to the next five days.","summary":"Retrieves consolidated nostro account positions for the currency","tags":["OTHERS"],"parameters":[{"name":"currencyId","in":"path","type":"string","required":true,"description":"Identifier of the currency. This is the 3-letter ISO 4217 code of the currency."},{"name":"longPositionSign","in":"query","type":"string","required":false,"description":"Polarity (sign) used to denote buy position balance.  "},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"NostroPositionsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/accounts/{accountId}/transactionRetries/cancellations","fullPath":"/api/v4.11.0/holdings/accounts/{accountId}/transactionRetries/cancellations","operationId":"getTransactionRetryCancellations","name":"Retrieves the cancellation request applied on a single transaction retry or multiple transaction retries pertaining to an account with information such as transaction retry id, transaction retry change type and transaction retry change value.","summary":"Retrieves the cancellation request applied on a single transaction retry or multiple transaction retries pertaining to an account.","tags":["OTHERS"],"parameters":[{"name":"accountId","in":"path","type":"string","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"TransactionRetryCancellationsResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"POST","path":"/holdings/accounts/{accountId}/transactionRetries/cancellations","fullPath":"/api/v4.11.0/holdings/accounts/{accountId}/transactionRetries/cancellations","operationId":"createTransactionRetryCancellations","name":"Creates a cancellation request for a single transaction retry or multiple transaction retries pertaining to an account. The request will terminate the transaction from further retry.","summary":"Creates a cancellation request for a single transaction retry or multiple transaction retries pertaining to an account.","tags":["OTHERS"],"parameters":[{"name":"accountId","in":"path","type":"string","required":true,"description":"Identifier of the account. Often referred to as the account number, yet for consistency this is always referred to as accountId. Accepts both IBAN & BBAN"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"transactionRetryIds":[{}],"extensions":{}}},"responses":{"200":"TransactionRetryCancellationsResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/holdings/accounts/{accountId}/transactionRetries/pendings","fullPath":"/api/v4.11.0/holdings/accounts/{accountId}/transactionRetries/pendings","operationId":"getPendingTransactionRetries","name":"Retrieves various details from pending transaction retries pertaining to an account, such as retry start date, retry end date, retry frequency, retry amount, number of possible retries, total number of retries attempted, details of latest retry attempted and information of successful retry. Transaction Retries - bank transfer transactions transition through various payment statuses and in some cases a payment may move to a status from which users are unable to complete their payment. Example: In","summary":"Retrieves the pending transaction retries pertaining to an account","tags":["OTHERS"],"parameters":[{"name":"accountId","in":"path","type":"string","required":true,"description":"Identifier of the account. Often referred to as the account number, yet for consistency this is always referred to as accountId. Accepts both IBAN & BBAN"},{"name":"transactionRetryId","in":"query","type":"string","required":false,"description":"Indicates the transaction retry identifier"},{"name":"numberOfTransactionRetries","in":"query","type":"string","required":false,"description":"Indicates the number of times the transaction has to be retried."},{"name":"transactionRetryStartDate","in":"query","type":"string","required":false,"description":"Indicates the date when the transaction retry has started."},{"name":"transactionRetryEndDate","in":"query","type":"string","required":false,"description":"Indicates the date till when the transaction has to be retried."},{"name":"nextTransactionRetryDate","in":"query","type":"string","required":false,"description":"Indicates the date when transaction has to be retried next."},{"name":"transactionType","in":"query","type":"string","required":false,"description":"Identifies the transaction type applicable to the transaction being processed, i.e. outward or inward payment. For example: ACPX, OTPX etc."},{"name":"contractId","in":"query","type":"string","required":false,"description":"Indicates the unique identifier of the transaction or contract which initiated the activity"},{"name":"productGroupId","in":"query","type":"string","required":false,"description":"The group, as defined by the institution, that the product belongs to."},{"name":"productId","in":"query","type":"string","required":false,"description":"Contains the unique identifier of the product, e.g. the product id of the arrangement account."},{"name":"arrangementId","in":"query","type":"string","required":false,"description":"Indicates an unique identifier of an account"},{"name":"transactionRetryStatus","in":"query","type":"string","required":false,"description":"Indicates the transaction retry status. Possible values are: NEW - Indicates transaction is captured for retry and transaction retry is yet to be processed, CURRENT - Transaction is currently being re"},{"name":"retrySettlementStatus","in":"query","type":"string","required":false,"description":"Indicates the transaction settlement status. Possible values are: PENDING - Indicates that the transaction is yet to be settled through retry, SETTLED - Indicates that the transaction is fully settled"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"PendingTransactionRetriesResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"PUT","path":"/holdings/accounts/{accountId}/withdrawalNotices/cancellations","fullPath":"/api/v4.11.0/holdings/accounts/{accountId}/withdrawalNotices/cancellations","operationId":"cancelAccountWithdrawalNotice","name":"Cancels the notification of withdrawal of amount from account.","summary":"Cancels the notification of withdrawal of amount from account","tags":["RETAIL"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"accountId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"effectiveDate":"2024-01-01","productId":"string","extensions":{},"noticeWithdrawal":[{}]}},"responses":{"200":"cancelAccountWithdrawalNoticeResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"PUT","path":"/holdings/accounts/{accountId}/withdrawalNotices/noticeUpdates","fullPath":"/api/v4.11.0/holdings/accounts/{accountId}/withdrawalNotices/noticeUpdates","operationId":"updateAccountWithdrawalNotice","name":"Updates the notice of withdrawal of amount from  account by providing the withdrawal date, bill reference and amount etc. This is applicable only for notice type of accounts.","summary":"Updates the notice of withdrawal of amount from account","tags":["RETAIL"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"accountId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"effectiveDate":"2024-01-01","productId":"string","extensions":{},"noticeWithdrawal":[{}]}},"responses":{"200":"updateAccountWithdrawalNoticeResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"PUT","path":"/holdings/accounts/{accountId}/payouts","fullPath":"/api/v4.11.0/holdings/accounts/{accountId}/payouts","operationId":"initiateAccountPayout","name":"Performs payout of the given account amount such as charges, tax etc","summary":"Perform payout of an account","tags":["RETAIL"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"accountId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"currencyId":"string","effectiveDate":"2024-01-01","activityId":"string","transactionAmount":0.0,"contractId":"string","systemId":"string","externalEventStatus":"string","extensions":{}}},"responses":{"200":"initiateAccountPayoutResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"PUT","path":"/holdings/accounts/{accountId}/repayments","fullPath":"/api/v4.11.0/holdings/accounts/{accountId}/repayments","operationId":"initiateAccountPayin","name":"Repays the account amount such as charges, tax etc","summary":"Perform repayment of the given account","tags":["RETAIL"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"accountId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"currencyId":"string","effectiveDate":"2024-01-01","activityId":"string","transactionAmount":0.0,"contractId":"string","systemId":"string","externalEventStatus":"string","extensions":{}}},"responses":{"200":"initiateAccountPayinResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"GET","path":"/holdings/accounts/nostroAccounts","fullPath":"/api/v4.11.0/holdings/accounts/nostroAccounts","operationId":"getNostroAccounts","name":"Retrieves the currency, balance and category details of the nostro account","summary":"Retrieves list of nostro account details","tags":["OTHERS"],"parameters":[{"name":"accountId","in":"query","type":"string","required":false,"description":"Identifier of the account. Often referred to as the account number, yet for consistency this is always referred to as accountId. Accepts both IBAN & BBAN"},{"name":"customerId","in":"query","type":"string","required":false,"description":"Identifier of the customer"},{"name":"productId","in":"query","type":"string","required":false,"description":"Contains the unique identifier of the product, e.g. the product id of the arrangement account."},{"name":"currencyId","in":"query","type":"string","required":false,"description":"Identifier of the currency. This is the 3-letter ISO 4217 code of the currency."},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"NostroAccountsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"POST","path":"/holdings/accounts/nostroAccounts","fullPath":"/api/v4.11.0/holdings/accounts/nostroAccounts","operationId":"createNostroAccount","name":"Create nostro account with mandatory details such as customer, currency, account title, account officer, short title, reconcile account. A nostro account is the shadow or mirror account of the vostro account maintained by the correspondent bank. The nostro account is opened with the correspondent bank as the customer.","summary":"Create nostro account","tags":["OTHERS"],"parameters":[{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"otherOfficers":[{}],"postingRestrictIds":[{}],"alternateAccountTypes":[{}],"alternateAccountIds":[{}],"jointHolderIds":[{}],"jointRelationCodes":[{}],"additionalDetails":[{}],"customerId":"string","accountTitle":"string","accountTitle2":"string","shortTitle":"string","mnemonic":"string","positionType":"string","currencyId":"string","accountOfficer":"string"}},"responses":{"200":"NostroAccountResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"POST","path":"/holdings/accounts/internalAccounts/{accountId}","fullPath":"/api/v4.11.0/holdings/accounts/internalAccounts/{accountId}","operationId":"createInternalAccount","name":"Create bank internal account with mandatory details such as account title, short title, mnemonic, account officer. The internal accounts are created and maintained for bank's internal operations such as interbranch, intercompany transactions.","summary":"Create bank internal account","tags":["OTHERS"],"parameters":[{"name":"accountId","in":"path","type":"string","required":true,"description":"Identifier of the account. Often referred to as the account number, yet for consistency this is always referred to as accountId. Accepts both IBAN & BBAN"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"otherOfficers":[{}],"postingRestrictIds":[{}],"alternateAcctDetails":[{}],"categoryId":"string","accountTitle":"string","accountTitle2":"string","shortTitle":"string","mnemonic":"string","positionType":"string","accountOfficer":"string","highVolumeTransaction":"string","openingDate":"string","extensions":{}}},"responses":{"200":"InternalAccountResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/holdings/accounts/internalAccounts/{accountId}","fullPath":"/api/v4.11.0/holdings/accounts/internalAccounts/{accountId}","operationId":"updateInternalAccount","name":"Update bank internal account with details such as short title, account officer, account title, high volume transaction flag, alternate account id, posting restriction. The internal accounts are created and maintained for bank's internal operations such as interbranch, intercompany transactions.","summary":"Update bank internal account","tags":["OTHERS"],"parameters":[{"name":"accountId","in":"path","type":"string","required":true,"description":"Identifier of the account. Often referred to as the account number, yet for consistency this is always referred to as accountId. Accepts both IBAN & BBAN"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"otherOfficers":[{}],"postingRestrictIds":[{}],"alternateAcctDetails":[{}],"accountTitle":"string","accountTitle2":"string","shortTitle":"string","mnemonic":"string","accountOfficer":"string","highVolumeTransaction":"string","extensions":{}}},"responses":{"200":"InternalAccountResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/holdings/accounts/nostroAccounts/{accountId}","fullPath":"/api/v4.11.0/holdings/accounts/nostroAccounts/{accountId}","operationId":"updateNostroAccount","name":"Update nostro account with details such as reconciliation tolerance amount, our actual account number, short title, account officer, account title, high volume transaction flag, posting restriction. A nostro account is the shadow or mirror account of the vostro account maintained by the correspondent bank. The nostro account is opened with the correspondent bank as the customer.","summary":"Update Nostro account","tags":["OTHERS"],"parameters":[{"name":"accountId","in":"path","type":"string","required":true,"description":"Identifier of the account. Often referred to as the account number, yet for consistency this is always referred to as accountId. Accepts both IBAN & BBAN"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"otherOfficers":[{}],"postingRestrictIds":[{}],"alternateAccountTypes":[{}],"alternateAccountIds":[{}],"jointHolderIds":[{}],"jointRelationCodes":[{}],"additionalDetails":[{}],"accountTitle":"string","accountTitle2":"string","shortTitle":"string","mnemonic":"string","accountOfficer":"string","ownNostro":"string","reconciliationToleranceAmount":"string","highVolumeTransaction":"string"}},"responses":{"200":"NostroAccountResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/holdings/accounts/internalAccounts","fullPath":"/api/v4.11.0/holdings/accounts/internalAccounts","operationId":"getInternalAccounts","name":"Retrieves the currency, balance and category details of the internal account","summary":"Retrieves list of internal account details","tags":["OTHERS"],"parameters":[{"name":"accountId","in":"query","type":"string","required":false,"description":"Identifier of the account. Often referred to as the account number, yet for consistency this is always referred to as accountId. Accepts both IBAN & BBAN"},{"name":"productId","in":"query","type":"string","required":false,"description":"Contains the unique identifier of the product, e.g. the product id of the arrangement account."},{"name":"currencyId","in":"query","type":"string","required":false,"description":"Identifier of the currency. This is the 3-letter ISO 4217 code of the currency."},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"InternalAccountsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/accounts","fullPath":"/api/v4.11.0/holdings/accounts","operationId":"getAccounts","name":"Retrieves the currency, balances, limit details and arrangement details of the account","summary":"Retrieves list of account basic details","tags":["OTHERS"],"parameters":[{"name":"accountId","in":"query","type":"string","required":false,"description":"Identifier of the account. Often referred to as the account number, yet for consistency this is always referred to as accountId. Accepts both IBAN & BBAN"},{"name":"customerId","in":"query","type":"string","required":false,"description":"Identifier of the customer"},{"name":"productId","in":"query","type":"string","required":false,"description":"Contains the unique identifier of the product, e.g. the product id of the arrangement account."},{"name":"currencyId","in":"query","type":"string","required":false,"description":"Identifier of the currency. This is the 3-letter ISO 4217 code of the currency."},{"name":"currencyIdSAID","in":"query","type":"string","required":false,"description":"Indicates the criteria for the sounds like operation on the currency"},{"name":"limitReference","in":"query","type":"string","required":false,"description":"Identifies the credit limit reference for the underlying account."},{"name":"arrangementId","in":"query","type":"string","required":false,"description":"Indicates an unique identifier of an account"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"AccountsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}}]},{"key":"holdings-accounts-service-v4.12.0","title":"Account management","version":"v4.12.0","description":"API to manage account related services such as retrieving balances, transaction and card details, emergency blocks, funds diversion, reservations, proxy identifiers and account closures. In addition, it provides functionality to support the capability to switch accounts from the current system to an","endpointCount":71,"endpoints":[{"method":"PUT","path":"/holdings/accounts/{accountId}/products","fullPath":"/api/v4.12.0/holdings/accounts/{accountId}/products","operationId":"updateAccountProduct","name":"Change account from one product to another such as changing savings account to current account","summary":"Change of contract from one account product to another","tags":["RETAIL"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"accountId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"effectiveDate":"2024-01-01","productId":"string","extensions":{},"balance":[{}]}},"responses":{"200":"updateAccountProductResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"PUT","path":"/holdings/accounts/{accountId}/limits","fullPath":"/api/v4.12.0/holdings/accounts/{accountId}/limits","operationId":"updateAccountLimit","name":"Update the limit conditions of the account with the secondary limit amount and other limit details","summary":"Update the limit conditions of the account","tags":["RETAIL"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"accountId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"parties":[{}],"activityId":"string","effectiveDate":"string","productId":"string","currencyId":"string","simulationId":"string","extensions":{},"limit":[{}]}},"responses":{"200":"updateAccountLimitResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"PUT","path":"/holdings/accounts/{accountId}/interestConditions","fullPath":"/api/v4.12.0/holdings/accounts/{accountId}/interestConditions","operationId":"updateAccountInterestConditions","name":"Update the interest conditions of the account such as interest rate, tier details, margin amount etc.","summary":"Update the interest conditions of the account","tags":["RETAIL"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"accountId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"effectiveDate":"2024-01-01","channel":"string","extensions":{},"crinterest":[{}]}},"responses":{"200":"updateAccountInterestConditionsResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"PUT","path":"/holdings/accounts/{accountId}/dormancyStatus/{status}","fullPath":"/api/v4.12.0/holdings/accounts/{accountId}/dormancyStatus/{status}","operationId":"updateAccountDormancyStatus","name":"Deactivates the savings account and moves it to given dormancy status.","summary":"Deactivates the savings account to given status","tags":["RETAIL"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"accountId","in":"path","type":"string","required":true,"description":""},{"name":"status","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"effectiveDate":"2024-01-01","productId":"string","extensions":{}}},"responses":{"200":"updateAccountDormancyStatusResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"PUT","path":"/holdings/accounts/{accountId}/channels","fullPath":"/api/v4.12.0/holdings/accounts/{accountId}/channels","operationId":"updateAccountChannel","name":"Updates the channel of the account","summary":"Change of channel for the account","tags":["RETAIL"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"accountId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"effectiveDate":"2024-01-01","channel":"string","extensions":{}}},"responses":{"200":"updateAccountChannelResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"POST","path":"/holdings/accounts/migrations","fullPath":"/api/v4.12.0/holdings/accounts/migrations","operationId":"initiateAccountMigration","name":"Migration of a legacy system account contract to the given account product by providing the original contract date, account name, statement, payment frequency and start date, etc. ","summary":"Migration of legacy system account contract to the given account product","tags":["RETAIL"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"partyIds":[{}],"originationReference":[{}],"effectiveDate":"2024-01-01","productId":"string","currency":"string","branch":"string","channel":"string","lineOfBusiness":"string","originalContractDate":"2024-01-01","extensions":{},"limit":[{}],"balance":[{}],"customer":[{}],"crinterest":[{}],"schedule":[{}]}},"responses":{"200":"initiateAccountMigrationResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"PUT","path":"/holdings/accounts/{accountId}/migrations/balances","fullPath":"/api/v4.12.0/holdings/accounts/{accountId}/migrations/balances","operationId":"updateAccountBalanceMigration","name":"Captures the balance details of the account such as balance type, due amount etc. This is used to migrate the balances of a legacy contract which is migrated from other system & update the balance details","summary":"Captures outstanding balance details of a contract migrated from legacy system","tags":["RETAIL"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"accountId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"productId":"string","drawdownDate":"2024-01-01","extensions":{},"balanceMaintenance":[{}]}},"responses":{"200":"updateAccountBalanceMigrationResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"PUT","path":"/holdings/accounts/{accountId}/renegotiations","fullPath":"/api/v4.12.0/holdings/accounts/{accountId}/renegotiations","operationId":"updateAccountConditions","name":"Perform the renegotiation of the account contract details such as payment frequency, payment start date, interest rate, statement frequency and settlement details, etc.","summary":"Renegotiation of the account contract details","tags":["RETAIL"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"accountId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"effectiveDate":"2024-01-01","productId":"string","extensions":{},"limit":[{}],"balance":[{}],"customer":[{}],"crinterest":[{}],"schedule":[{}],"settlement":[{}],"statement":[{}]}},"responses":{"200":"updateAccountConditionsResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"PUT","path":"/holdings/accounts/{accountId}/dormancyStatus/reactivations","fullPath":"/api/v4.12.0/holdings/accounts/{accountId}/dormancyStatus/reactivations","operationId":"updateAccountDormancyReactivation","name":"Reset the dormant account to active status manually","summary":"Reset the account dormancy status","tags":["RETAIL"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"accountId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"effectiveDate":"2024-01-01","productId":"string","extensions":{}}},"responses":{"200":"updateAccountDormancyReactivationResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"PUT","path":"/holdings/accounts/{accountId}/withdrawalNotices","fullPath":"/api/v4.12.0/holdings/accounts/{accountId}/withdrawalNotices","operationId":"createAccountWithdrawalNotice","name":"Notifies the withdrawal of amount from account by providing the withdrawal date and amount etc. This is applicable only for notice type of accounts.","summary":"Notifies the withdrawal amount from account","tags":["RETAIL"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"accountId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"effectiveDate":"2024-01-01","productId":"string","extensions":{},"noticeWithdrawal":[{}]}},"responses":{"200":"createAccountWithdrawalNoticeResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"PUT","path":"/holdings/accounts/{accountId}/customers","fullPath":"/api/v4.12.0/holdings/accounts/{accountId}/customers","operationId":"updateAccountCustomer","name":"Update the customer details of the account such as add or remove the joint customers, tax liability percentange, limit liability percentage of the joint customers","summary":"Update customers for the given account","tags":["RETAIL"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"accountId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"partyIds":[{}],"effectiveDate":"2024-01-01","extensions":{},"customer":[{}]}},"responses":{"200":"updateAccountCustomerResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"PUT","path":"/holdings/accounts/{accountId}/credits","fullPath":"/api/v4.12.0/holdings/accounts/{accountId}/credits","operationId":"updateAccountCredit","name":"Perform credit transactions in an account, providing the credit amount and the currency in which to be credited","summary":"Perform credit transaction in an account.","tags":["RETAIL"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"accountId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"currencyId":"string","effectiveDate":"2024-01-01","activityId":"string","transactionAmount":0.0,"contractId":"string","systemId":"string","externalEventStatus":"string","extensions":{}}},"responses":{"200":"updateAccountCreditResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"PUT","path":"/holdings/accounts/{accountId}/debits","fullPath":"/api/v4.12.0/holdings/accounts/{accountId}/debits","operationId":"updateAccountDebit","name":"Perform debit transactions in an account by providing debit amount and currency in which to be debited","summary":"Perform debit transactions in an account","tags":["RETAIL"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"accountId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"currencyId":"string","effectiveDate":"2024-01-01","activityId":"string","transactionAmount":0.0,"contractId":"string","systemId":"string","externalEventStatus":"string","extensions":{}}},"responses":{"200":"updateAccountDebitResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"PUT","path":"/holdings/accounts/{accountId}/adjustments","fullPath":"/api/v4.12.0/holdings/accounts/{accountId}/adjustments","operationId":"updateAccountAdjustment","name":"Performs backdated adjustment and re-accrual for the given savings account.  This is used when interest adjustment is required due to backdated rate change or transaction.","summary":"Performs backdated adjustment and re-accrual for the given savings account ","tags":["RETAIL"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"accountId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"currencyId":"string","effectiveDate":"2024-01-01","activityId":"string","transactionAmount":0.0,"contractId":"string","systemId":"string","externalEventStatus":"string","extensions":{}}},"responses":{"200":"updateAccountAdjustmentResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"PUT","path":"/holdings/accounts/{accountId}/lineofBusiness","fullPath":"/api/v4.12.0/holdings/accounts/{accountId}/lineofBusiness","operationId":"updateAccountLob","name":"Updates the type of line of business of the account","summary":"Change of line of business for the account","tags":["RETAIL"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"accountId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"effectiveDate":"2024-01-01","lineOfBusiness":"string","extensions":{}}},"responses":{"200":"updateAccountLobResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"GET","path":"/holdings/accounts/{accountId}/dormancyConditions","fullPath":"/api/v4.12.0/holdings/accounts/{accountId}/dormancyConditions","operationId":"getAccountDormancyDetails","name":"Retrieves the dormancy setup details for the account such as dormancy period, status etc","summary":"Retrieves the account dormancy conditions","tags":["RETAIL"],"parameters":[{"name":"accountId","in":"path","type":"string","required":true,"description":"Identifier of the account. Often referred to as the account number, yet for consistency this is always referred to as accountId. Accepts both IBAN & BBAN"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"AccountDormancyDetailsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/accounts/{accountId}/transactions","fullPath":"/api/v4.12.0/holdings/accounts/{accountId}/transactions","operationId":"getAccountTransactions","name":"Retrieves account transaction details such as transaction type, amount, transaction reference, credit or debit indicator, booking and effective date of transaction","summary":"Retrieves account transaction details","tags":["RETAIL"],"parameters":[{"name":"accountId","in":"path","type":"string","required":true,"description":"Identifier of the account. Often referred to as the account number, yet for consistency this is always referred to as accountId. Accepts both IBAN & BBAN"},{"name":"fromDate","in":"query","type":"string","required":false,"description":"Indicates the business date from when the balance reservation event is active."},{"name":"toDate","in":"query","type":"string","required":false,"description":"Indicates the business date until when the balance reservation event is active."},{"name":"transactionReference","in":"query","type":"string","required":false,"description":"Contains the identifier for the transaction in the core system"},{"name":"period","in":"query","type":"string","required":false,"description":"Indicates spread of time buckets.Ex: 3M,6M,9M,10Y etc."},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"AccountTransactionsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/accounts/accountsDetails","fullPath":"/api/v4.12.0/holdings/accounts/accountsDetails","operationId":"getAccountInfo","name":"Retrieves the currency, balances, limit details and arrangement details of the account","summary":"Retrieves list of account basic details","tags":["RETAIL"],"parameters":[{"name":"customer","in":"query","type":"string","required":false,"description":"Contains the customer identifier to fetch list of consent arrangements for the customer or customer identifier of the debtor account. This will be populated once the SCA(Strong Customer Authentication"},{"name":"arrangementId","in":"query","type":"string","required":false,"description":"Indicates an unique identifier of an account"},{"name":"currency","in":"query","type":"string","required":false,"description":"Identifies the currency. E.g. USD, GBP etc"},{"name":"companyCode","in":"query","type":"string","required":false,"description":"The identifier of the underlying Entity/Company/Branch."},{"name":"productId","in":"query","type":"string","required":false,"description":"Contains the unique identifier of the product, e.g. the product id of the arrangement account."},{"name":"status","in":"query","type":"string","required":false,"description":"Contains status of the data rights request.Allowed values are INITIATED, INPROGESS, EXTENDED, COMPLETED, REJECTED."},{"name":"accountId","in":"query","type":"string","required":false,"description":"Identifier of the account. Often referred to as the account number, yet for consistency this is always referred to as accountId. Accepts both IBAN & BBAN"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"AccountInfoResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/accounts/{accountId}/statements","fullPath":"/api/v4.12.0/holdings/accounts/{accountId}/statements","operationId":"getAccountStatementDetails","name":"Retrieves the statement frequency of an account","summary":"Retrieves the statement frequency of an account","tags":["RETAIL"],"parameters":[{"name":"accountId","in":"path","type":"string","required":true,"description":"Identifier of the account. Often referred to as the account number, yet for consistency this is always referred to as accountId. Accepts both IBAN & BBAN"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"AccountStatementDetailsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"PUT","path":"/holdings/accounts/{accountId}/statements","fullPath":"/api/v4.12.0/holdings/accounts/{accountId}/statements","operationId":"updateAccountStatement","name":"Update the statement frequency of an account.","summary":"Update the statement frequency of an account","tags":["RETAIL"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"productId":"string","drawdownDate":"2024-01-01","extensions":{},"statement":[{}]}},"responses":{"200":"updateAccountStatementResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"PUT","path":"/holdings/accounts/{accountId}/migrations/bills","fullPath":"/api/v4.12.0/holdings/accounts/{accountId}/migrations/bills","operationId":"updateAccountBillMigration","name":"Captures the bill information of the account such as bill id, property names, bill amount etc. This is used to migrate the bills of a legacy contract which is migrated from other system & update the bill details","summary":"Captures the bill information of the account such as bill id, property names, bill amount etc. This is used to migrate the bills of a legacy contract which is migrated from other system & update the bill details","tags":["RETAIL"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"accountId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"productId":"string","drawdownDate":"2024-01-01","extensions":{},"balanceMaintenance":[{}]}},"responses":{"200":"updateAccountBillMigrationResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"PUT","path":"/holdings/accounts/{accountId}/branches","fullPath":"/api/v4.12.0/holdings/accounts/{accountId}/branches","operationId":"updateAccountBranch","name":"Updates the branch of an account","summary":"Updates the branch of an account","tags":["RETAIL"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"accountId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"effectiveDate":"2024-01-01","branch":"string","extensions":{}}},"responses":{"200":"updateAccountBranchResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"PUT","path":"/holdings/accounts/{accountId}/settlements","fullPath":"/api/v4.12.0/holdings/accounts/{accountId}/settlements","operationId":"updateAccountSettlement","name":"Update the settlement conditions of the account such as payin account, payin percentage, payin amount, payout account, payout percentage, payout amount, etc","summary":"Update the settlement conditions of the account such as payin account, payin percentage, payin amount, payout account, payout percentage, payout amount, etc","tags":["RETAIL"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"accountId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"productId":"string","drawdownDate":"2024-01-01","extensions":{},"settlement":[{}]}},"responses":{"200":"updateAccountSettlementResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"PUT","path":"/holdings/accounts/{accountId}/accounts","fullPath":"/api/v4.12.0/holdings/accounts/{accountId}/accounts","operationId":"updateAccount","name":"Update the account details to block or unblock the account by setting the posting restriction and to change the nick name of the account","summary":"Update the account's details","tags":["RETAIL"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"accountId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"productId":"string","drawdownDate":"2024-01-01","extensions":{},"balance":[{}]}},"responses":{"200":"updateAccountResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"PUT","path":"/holdings/accounts/{accountId}/schedules","fullPath":"/api/v4.12.0/holdings/accounts/{accountId}/schedules","operationId":"updateAccountSchedule","name":"Update the payment schedule condition such as payment method from capitalise to pay, payment frequency from monthly to quarterly etc., on an account","summary":"Update payment schedule for the given account","tags":["RETAIL"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"accountId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"productId":"string","drawdownDate":"2024-01-01","extensions":{},"schedule":[{}]}},"responses":{"200":"updateAccountScheduleResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"GET","path":"/holdings/accounts/accountClosures/{accountId}","fullPath":"/api/v4.12.0/holdings/accounts/accountClosures/{accountId}","operationId":"getAccountClosure","name":"Retrieves the account closure information of the account such as closure date and reason, mode of closure, balances on the date of closing and pending charges","summary":"Retrieves the account closure information","tags":["OTHERS"],"parameters":[{"name":"accountId","in":"path","type":"string","required":true,"description":"Identifier of the account. Often referred to as the account number, yet for consistency this is always referred to as accountId. Accepts both IBAN & BBAN"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"AccountClosureResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/holdings/accounts/accountClosures/{accountId}","fullPath":"/api/v4.12.0/holdings/accounts/accountClosures/{accountId}","operationId":"updateAccountClosure","name":"Updates account closure information for the specific account such as closure date and reason, mode of closure and closing charges","summary":"Updates account closure information","tags":["OTHERS"],"parameters":[{"name":"accountId","in":"path","type":"string","required":true,"description":"Identifier of the account. Often referred to as the account number, yet for consistency this is always referred to as accountId. Accepts both IBAN & BBAN"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"accountCurrency":"string","closureDate":"2024-01-01T00:00:00Z","creditAccount":"string","capitaliseInterest":"string","chargeType":"string","chargeAmount":0.0,"closeMode":"string","ftId":"string","closureReason":"string","closureNotes":"string","onlineLedgerBalance":0.0,"onlineClearedBalance":0.0,"balancePayable":0.0,"totalCreditInterest":"string","totalDebitInterest":"string"}},"responses":{"200":"AccountClosureResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/holdings/accounts/{accountId}/cards","fullPath":"/api/v4.12.0/holdings/accounts/{accountId}/cards","operationId":"getAccountCards","name":"Retrieves the card details of the account such as card number, card type and status of the card","summary":"Retrieves available card details","tags":["OTHERS"],"parameters":[{"name":"accountId","in":"path","type":"string","required":true,"description":"Identifier of the account. Often referred to as the account number, yet for consistency this is always referred to as accountId. Accepts both IBAN & BBAN"},{"name":"cardIssueId","in":"query","type":"string","required":false,"description":"The identifier of the issued card formatted as cardType '.' cardNumber. E.g. VISA.1234567887654321 GC.1111222233334444 AB21.1111111122222222"},{"name":"issueDate","in":"query","type":"string","required":false,"description":"The date the item was issued."},{"name":"expiryDate","in":"query","type":"string","required":false,"description":"This indicates the  date  on which the offer or privilege terminates for the event."},{"name":"cardStatus","in":"query","type":"string","required":false,"description":"Current status of the Card and following are the possible statuses are  - CARD.ISSUED - CARD.RETURNED - CARD.SCRAP - CARD.CANCEL - NOT.ACTIVATED - NOT.RECEIVED - ACTIVE - BLOCKED - EXPIRED"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"AccountCardsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/accounts/balances","fullPath":"/api/v4.12.0/holdings/accounts/balances","operationId":"getAccountBalanceToday","name":"Retrieves various types of balances such as cleared, online, locked and usable balance of the account","summary":"Retrieves list of account balances","tags":["OTHERS"],"parameters":[{"name":"accountId","in":"query","type":"string","required":false,"description":"Identifier of the account. Often referred to as the account number, yet for consistency this is always referred to as accountId. Accepts both IBAN & BBAN"},{"name":"customerId","in":"query","type":"string","required":false,"description":"Identifier of the customer"},{"name":"productId","in":"query","type":"string","required":false,"description":"Contains the unique identifier of the product, e.g. the product id of the arrangement account."},{"name":"currencyId","in":"query","type":"string","required":false,"description":"Identifier of the currency. This is the 3-letter ISO 4217 code of the currency."},{"name":"limitReferenceId","in":"query","type":"string","required":false,"description":"Limit reference identifier for the limit order."},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"AccountBalanceTodayResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/accounts/{accountId}/balanceMovements/{bookingDate}","fullPath":"/api/v4.12.0/holdings/accounts/{accountId}/balanceMovements/{bookingDate}","operationId":"getAccountBalanceMovement","name":"Retrieves the credit, debit and gross balance movements for an account for the requested booking date","summary":"Retrieves balances movements of account","tags":["OTHERS"],"parameters":[{"name":"accountId","in":"path","type":"string","required":true,"description":"Identifier of the account. Often referred to as the account number, yet for consistency this is always referred to as accountId. Accepts both IBAN & BBAN"},{"name":"bookingDate","in":"path","type":"string","required":true,"description":"Business date on which the accounting entry was generated."},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"AccountBalanceMovementResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/accounts/{accountId}/emergencyBlocks/status","fullPath":"/api/v4.12.0/holdings/accounts/{accountId}/emergencyBlocks/status","operationId":"getAccountEmergencyBlock","name":"Retrieve emergency block status and reason for a given account. This information will be used to assert the actual block status of an account in microservice","summary":"Retrieve emergency block information for an account","tags":["OTHERS"],"parameters":[{"name":"accountId","in":"path","type":"string","required":true,"description":"Identifier of the account. Often referred to as the account number, yet for consistency this is always referred to as accountId. Accepts both IBAN & BBAN"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"AccountEmergencyBlockResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"PUT","path":"/holdings/accounts/{accountId}/emergencyBlocks/status","fullPath":"/api/v4.12.0/holdings/accounts/{accountId}/emergencyBlocks/status","operationId":"updateAccountEmergencyBlock","name":"Updates emergency block status and reason for block of the account","summary":"Update emergency block in account","tags":["OTHERS"],"parameters":[{"name":"accountId","in":"path","type":"string","required":true,"description":""},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"emergencyBlock":"string","emergencyReason":"string","extensions":{}}},"responses":{"200":"AccountEmergencyBlockResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/holdings/accounts/{accountId}/fundsAuthorisations/status","fullPath":"/api/v4.12.0/holdings/accounts/{accountId}/fundsAuthorisations/status","operationId":"getAccountFundsAuthStatus","name":"Retrieve the funds authorisation status of the account","summary":"Retrieve account funds authorisation status","tags":["OTHERS"],"parameters":[{"name":"accountId","in":"path","type":"string","required":true,"description":"Identifier of the account. Often referred to as the account number, yet for consistency this is always referred to as accountId. Accepts both IBAN & BBAN"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"AccountFundsAuthStatusResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"PUT","path":"/holdings/accounts/{accountId}/fundsAuthorisations/status","fullPath":"/api/v4.12.0/holdings/accounts/{accountId}/fundsAuthorisations/status","operationId":"updateAccountFundsAuthStatus","name":"Update the funds authorisation status for the account, for example SYNC or ERROR","summary":"Update account funds authorisation status","tags":["OTHERS"],"parameters":[{"name":"accountId","in":"path","type":"string","required":true,"description":""},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"faStatus":"string","extensions":{}}},"responses":{"200":"AccountFundsAuthStatusResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"POST","path":"/holdings/accounts/settings/{settingId}/fundsDiversion","fullPath":"/api/v4.12.0/holdings/accounts/settings/{settingId}/fundsDiversion","operationId":"createFundsDiversion","name":"Allows creation of funds diversion conditions for a company to manage the behavior of booking funds against any account in the company that has the auto pay account defined","summary":"Creates conditions for funds diversion","tags":["OTHERS"],"parameters":[{"name":"settingId","in":"path","type":"string","required":true,"description":"Contains the particular parameter record setting identifier."},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"transactionCodes":[{}],"defaultFundsDiversion":"string","extensions":{}}},"responses":{"200":"FundsDiversionResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/holdings/accounts/settings/{settingId}/fundsDiversion","fullPath":"/api/v4.12.0/holdings/accounts/settings/{settingId}/fundsDiversion","operationId":"updateFundsDiversion","name":"Updates the funds diversion conditions for a company to manage the behavior of booking funds against any account in the company that has the auto pay account defined","summary":"Updates funds diversion parameter","tags":["OTHERS"],"parameters":[{"name":"settingId","in":"path","type":"string","required":true,"description":"Contains the particular parameter record setting identifier."},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"transactionCodes":[{}],"defaultFundsDiversion":"string","extensions":{}}},"responses":{"200":"FundsDiversionResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/holdings/nostros/forwardBalances","fullPath":"/api/v4.12.0/holdings/nostros/forwardBalances","operationId":"getNostroForwardBalances","name":"Retrieves forward balances of nostro accounts considering the transaction effective dates.","summary":"Retrieves consolidated nostro account balances","tags":["OTHERS"],"parameters":[{"name":"valueDate","in":"query","type":"string","required":false,"description":"Indicates the value date on which the underlying accounting entry is to be given value (for interest purposes)"},{"name":"accountId","in":"query","type":"string","required":true,"description":"Identifier of the account. Often referred to as the account number, yet for consistency this is always referred to as accountId. Accepts both IBAN & BBAN"},{"name":"longPositionSign","in":"query","type":"string","required":false,"description":"Polarity (sign) used to denote buy position balance.  "},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"NostroForwardBalancesResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/nostros/currencyBalances/{currencyId}/accounts","fullPath":"/api/v4.12.0/holdings/nostros/currencyBalances/{currencyId}/accounts","operationId":"getNostroBalances","name":"Retrieves the date wise balances of the nostro accounts that falls under a specific currency","summary":"Retrieves nostro account balances for a specific currency","tags":["OTHERS"],"parameters":[{"name":"currencyId","in":"path","type":"string","required":true,"description":"Identifier of the currency. This is the 3-letter ISO 4217 code of the currency."},{"name":"nostroId","in":"query","type":"string","required":false,"description":"Nostro account id"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"NostroBalancesResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/nostros/currencyBalances/{currencyId}","fullPath":"/api/v4.12.0/holdings/nostros/currencyBalances/{currencyId}","operationId":"getNostroCurrencyPositions","name":"Retrieves consolidated balances of the nostro accounts in a given currency from the current date to the next five days.","summary":"Retrieves consolidated nostro account balances for a specific currency","tags":["OTHERS"],"parameters":[{"name":"currencyId","in":"path","type":"string","required":true,"description":"Identifier of the currency. This is the 3-letter ISO 4217 code of the currency."},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"NostroCurrencyPositionsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/accounts/{accountId}","fullPath":"/api/v4.12.0/holdings/accounts/{accountId}","operationId":"getAccountDetails","name":"Retrieves the arrangement account details such as account balances, allowed, advised and outstanding limit balances, interest types and values with the corresponding mode, frequency and value of payments","summary":"Retrieves arrangement account details","tags":["OTHERS"],"parameters":[{"name":"accountId","in":"path","type":"string","required":true,"description":"Identifier of the account. Often referred to as the account number, yet for consistency this is always referred to as accountId. Accepts both IBAN & BBAN"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"AccountDetailsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/accounts/proxyIdentifiers","fullPath":"/api/v4.12.0/holdings/accounts/proxyIdentifiers","operationId":"getActiveProxyIdentifier","name":"Retrieve proxy registration status from proxy directory for a given customer number or account number or proxy type and proxy identifier","summary":"Retrieve proxy registration status","tags":["OTHERS"],"parameters":[{"name":"customerId","in":"query","type":"string","required":false,"description":"Identifier of the customer"},{"name":"alternateAccountId","in":"query","type":"string","required":false,"description":"Contains the Uniform Banking Code of the arrangement"},{"name":"proxyType","in":"query","type":"string","required":false,"description":"Type of proxy created for account"},{"name":"proxyIdentifier","in":"query","type":"string","required":false,"description":"A proxy identifier to be linked to an account based on the proxy type provided eg. Mobile number, email id and tax id"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"ActiveProxyIdentifierResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"POST","path":"/holdings/accounts/proxyIdentifiers","fullPath":"/api/v4.12.0/holdings/accounts/proxyIdentifiers","operationId":"createProxyIdentifier","name":"Register the proxy identifier with details of proxy type and scheme for a customer and account","summary":"Register the proxy identifier for the account","tags":["OTHERS"],"parameters":[{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"customerId":"string","accountId":"string","alternateAccountId":"string","proxyType":"string","proxyIdentifier":"string","proxyStatus":"string","proxyScheme":"string","proxyRole":"string","extensions":{}}},"responses":{"200":"ProxyIdentifierResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/holdings/accounts/proxyIdentifiers/{proxyIdentifierId}","fullPath":"/api/v4.12.0/holdings/accounts/proxyIdentifiers/{proxyIdentifierId}","operationId":"updateProxyIdentifier","name":"Update the specific proxy identifier to de-register the registered account or customer from the proxy directory","summary":"Update proxy directory for account to de-register the proxy identifier","tags":["OTHERS"],"parameters":[{"name":"proxyIdentifierId","in":"path","type":"string","required":true,"description":""},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"customerId":"string","accountId":"string","alternateAccountId":"string","proxyType":"string","proxyIdentifier":"string","proxyStatus":"string","proxyScheme":"string","proxyRole":"string","extensions":{}}},"responses":{"200":"ProxyIdentifierResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/holdings/accounts/{accountId}/{accountCompany}/{paymentCurrency}/{accountSwitch}/{beneficialCustomer}/payments","fullPath":"/api/v4.12.0/holdings/accounts/{accountId}/{accountCompany}/{paymentCurrency}/{accountSwitch}/{beneficialCustomer}/payments","operationId":"getAccountPaymentDetails","name":"Retrieves the account information that are required for processing or validating an account involved in a payment transaction. Provides the information such as account name, customer number, account type, account currency, IBAN, account switch details, account status (ACTIVE or INACTIVE) and account closure details.","summary":"Retrieves account details required for payment processing","tags":["OTHERS"],"parameters":[{"name":"accountId","in":"path","type":"string","required":true,"description":"Identifier of the account. Often referred to as the account number, yet for consistency this is always referred to as accountId. Accepts both IBAN & BBAN"},{"name":"accountCompany","in":"path","type":"string","required":true,"description":"Company of the account to be created"},{"name":"paymentCurrency","in":"path","type":"string","required":true,"description":"This field holds the transaction currency or currency in which payment is initiated. "},{"name":"accountSwitch","in":"path","type":"string","required":true,"description":"Indicates if availability of account switch details should be checked."},{"name":"beneficialCustomer","in":"path","type":"string","required":true,"description":"Indicates if beneficial owners of the account are to be retrieved"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"AccountPaymentDetailsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/accounts/{contractBalanceId}/contractBalances","fullPath":"/api/v4.12.0/holdings/accounts/{contractBalanceId}/contractBalances","operationId":"getContractBalances","name":"Retrieves the contract balances of accounts or contracts with details such as contract currency, balance types, credit and debit movements and opening and closing balance of the respective balance types","summary":"Retrieves contract balances of accounts","tags":["OTHERS"],"parameters":[{"name":"contractBalanceId","in":"path","type":"string","required":true,"description":"Unique Identifier of Contract Balances"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"ContractBalancesResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"PUT","path":"/holdings/accounts/{accountId}/synchronizationErrors","fullPath":"/api/v4.12.0/holdings/accounts/{accountId}/synchronizationErrors","operationId":"updateSynchronizationError","name":"Updates error status during synchronization of the account between Transact and Funds authorization microservice.","summary":"Update synchronization error status","tags":["OTHERS"],"parameters":[{"name":"accountId","in":"path","type":"string","required":true,"description":"Identifier of the account. Often referred to as the account number, yet for consistency this is always referred to as accountId. Accepts both IBAN & BBAN"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"emergencyBlockError":"string","extensions":{}}},"responses":{"200":"SynchronizationErrorResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/holdings/accounts/{accountId}/accountSwitches/expiringSwitches","fullPath":"/api/v4.12.0/holdings/accounts/{accountId}/accountSwitches/expiringSwitches","operationId":"getExpiringAccountSwitches","name":"Retrieves the details of the expiring account switches for generating alerts such as the bank identifier code, alert date and account id of expiring switch instruction etc.","summary":"Retrieves the details of the expiring switches for generating alerts","tags":["OTHERS"],"parameters":[{"name":"accountId","in":"path","type":"string","required":true,"description":"Identifier of the account. Often referred to as the account number, yet for consistency this is always referred to as accountId. Accepts both IBAN & BBAN"},{"name":"alertStatus","in":"query","type":"string","required":false,"description":"Contains status of the Alert to be raised for switching instruction. Possible values are Pending, Sent."},{"name":"alertDate","in":"query","type":"string","required":false,"description":"Indicates the date in which an alert to be raised for a switching instruction."},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"ExpiringAccountSwitchesResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/accounts/{accountId}/accountSwitches","fullPath":"/api/v4.12.0/holdings/accounts/{accountId}/accountSwitches","operationId":"getAccountSwitchDetails","name":"Retrieves details from the account switch directory for the specific account such as the expiry date, status of the switch instruction, effective date of the switch, bank identifier code and IBAN (International Bank Account Number ) etc.","summary":"Retrieves details of the account switch requests","tags":["OTHERS"],"parameters":[{"name":"accountId","in":"path","type":"string","required":true,"description":"Identifier of the account. Often referred to as the account number, yet for consistency this is always referred to as accountId. Accepts both IBAN & BBAN"},{"name":"requestDate","in":"query","type":"string","required":false,"description":"Date on which the client's request to be classified as professional has been received."},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"AccountSwitchDetailsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"PUT","path":"/holdings/accounts/{accountId}/accountSwitches","fullPath":"/api/v4.12.0/holdings/accounts/{accountId}/accountSwitches","operationId":"updateAccountSwitchDetails","name":"Updates alert status based on the original IBAN. Used by external systems handling alert generation to mark the status from pending to sent","summary":"Updates alert status from pending to be sent for corresponding switch instructions.","tags":["OTHERS"],"parameters":[{"name":"accountId","in":"path","type":"string","required":true,"description":"Identifier of the account. Often referred to as the account number, yet for consistency this is always referred to as accountId. Accepts both IBAN & BBAN"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"accountId":"string","switchIBAN":"string","switchAccountId":"string","switchBic":"string","switchClearingCode":"string","requestDate":"string","status":"string","cancelInstruction":"string","cancelDate":"string","expiryDate":"string","IBAN":"string","bicId":"string","effectiveDate":"string","alertDate":"string","alertStatus":"string"}},"responses":{"200":"AccountSwitchDetailsResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/holdings/accounts/{accountId}/accountSwitches/payments","fullPath":"/api/v4.12.0/holdings/accounts/{accountId}/accountSwitches/payments","operationId":"getAccountSwitchPaymentDetails","name":"Retrieves information of the rerouted payments from the payment transaction exit point.","summary":"Retrieves rerouted payment information.","tags":["OTHERS"],"parameters":[{"name":"accountId","in":"path","type":"string","required":true,"description":"Identifier of the account. Often referred to as the account number, yet for consistency this is always referred to as accountId. Accepts both IBAN & BBAN"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"AccountSwitchPaymentDetailsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"PUT","path":"/holdings/accounts/accountClosures/{accountId}/approvals","fullPath":"/api/v4.12.0/holdings/accounts/accountClosures/{accountId}/approvals","operationId":"approveAccountClosure","name":"Approves account closure information to allow closing of an account which is no longer in use","summary":"Approves account closure information","tags":["OTHERS"],"parameters":[{"name":"accountId","in":"path","type":"string","required":true,"description":"Identifier of the account. Often referred to as the account number, yet for consistency this is always referred to as accountId. Accepts both IBAN & BBAN"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"AccountClosureResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/holdings/accounts/reservedFunds","fullPath":"/api/v4.12.0/holdings/accounts/reservedFunds","operationId":"getReservedFunds","name":"Retrieves the reserved funds details such as reason, amount and period of reservation of the account","summary":"Retrieves the list of reserved funds ","tags":["OTHERS"],"parameters":[{"name":"accountId","in":"query","type":"string","required":false,"description":"Identifier of the account. Often referred to as the account number, yet for consistency this is always referred to as accountId. Accepts both IBAN & BBAN"},{"name":"lockedEventReference","in":"query","type":"string","required":false,"description":"Captures the AC.LOCKED.EVENTS id if in case the funds is available and reserved."},{"name":"lockReason","in":"query","type":"string","required":false,"description":"Indicates the simple description for the balance reservation event."},{"name":"fromDate","in":"query","type":"string","required":false,"description":"Indicates the business date from when the balance reservation event is active."},{"name":"toDate","in":"query","type":"string","required":false,"description":"Indicates the business date until when the balance reservation event is active."},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"ReservedFundsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"POST","path":"/holdings/accounts/reservedFunds","fullPath":"/api/v4.12.0/holdings/accounts/reservedFunds","operationId":"createFundsReservation","name":"Creates a funds reservation with details such as account number, block or reserve amount, period of hold transaction, reason for holding. Funds reservations are created to block or reserve funds which restricts any debit movements affecting the account balance below the blocked amount for the specified period on an account.","summary":"Creates a credit or debit funds reservation to block the funds in an account","tags":["OTHERS"],"parameters":[{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"accountId":"string","lockReason":"string","fromDate":"2024-01-01","toDate":"2024-01-01","lockedAmount":"string","transactionReference":"string","transactionRetry":"string","systemId":"string","additionalDetail":"string","alternateKey":"string","reservationTypeId":"string","accountLink":"string","action":"string","creditDebitIndicator":"string","reservationIndicator":"string"}},"responses":{"200":"FundsReservationResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/holdings/accounts/reservedFunds/{lockedEventReference}","fullPath":"/api/v4.12.0/holdings/accounts/reservedFunds/{lockedEventReference}","operationId":"updateFundsReservation","name":"Update funds reservation with details such as account number, block or reserve amount, period of hold transaction, reason for holding. Funds reservations are created to block or reserve funds which restricts any debit movements affecting the account balance below the blocked amount for the specified period on an account.","summary":"Update the credit or debit funds reservation to block the funds in an account","tags":["OTHERS"],"parameters":[{"name":"lockedEventReference","in":"path","type":"string","required":true,"description":"Captures the AC.LOCKED.EVENTS id if in case the funds is available and reserved."},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"accountId":"string","lockReason":"string","fromDate":"2024-01-01","toDate":"2024-01-01","lockedAmount":"string","transactionReference":"string","transactionRetry":"string","systemId":"string","additionalDetail":"string","alternateKey":"string","reservationTypeId":"string","accountLink":"string","action":"string","creditDebitIndicator":"string","reservationIndicator":"string"}},"responses":{"200":"FundsReservationResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"DELETE","path":"/holdings/accounts/reservedFunds/{lockedEventReference}","fullPath":"/api/v4.12.0/holdings/accounts/reservedFunds/{lockedEventReference}","operationId":"cancelFundsReservation","name":"Cancels the funds reservation of an account. Funds reservations are created to block or reserve funds which restricts any debit movements affecting the account balance below the blocked amount for the specified period on an account. On removal of the funds reservations, the blocked or reserved amount is now available for usage.","summary":"Cancels the credit or debit funds reservation to unblock the funds in an account","tags":["OTHERS"],"parameters":[{"name":"lockedEventReference","in":"path","type":"string","required":true,"description":"Captures the AC.LOCKED.EVENTS id if in case the funds is available and reserved."},{"name":"payload","in":"body","type":"object","required":false,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}}},"responses":{"200":"FundsReservationResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/holdings/nostros/positions/{currencyId}","fullPath":"/api/v4.12.0/holdings/nostros/positions/{currencyId}","operationId":"getNostroPositions","name":"Retrieves nostro account balances for a given currency from the current date to the next five days.","summary":"Retrieves consolidated nostro account positions for the currency","tags":["OTHERS"],"parameters":[{"name":"currencyId","in":"path","type":"string","required":true,"description":"Identifier of the currency. This is the 3-letter ISO 4217 code of the currency."},{"name":"longPositionSign","in":"query","type":"string","required":false,"description":"Polarity (sign) used to denote buy position balance.  "},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"NostroPositionsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/accounts/{accountId}/transactionRetries/cancellations","fullPath":"/api/v4.12.0/holdings/accounts/{accountId}/transactionRetries/cancellations","operationId":"getTransactionRetryCancellations","name":"Retrieves the cancellation request applied on a single transaction retry or multiple transaction retries pertaining to an account with information such as transaction retry id, transaction retry change type and transaction retry change value.","summary":"Retrieves the cancellation request applied on a single transaction retry or multiple transaction retries pertaining to an account.","tags":["OTHERS"],"parameters":[{"name":"accountId","in":"path","type":"string","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"TransactionRetryCancellationsResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"POST","path":"/holdings/accounts/{accountId}/transactionRetries/cancellations","fullPath":"/api/v4.12.0/holdings/accounts/{accountId}/transactionRetries/cancellations","operationId":"createTransactionRetryCancellations","name":"Creates a cancellation request for a single transaction retry or multiple transaction retries pertaining to an account. The request will terminate the transaction from further retry.","summary":"Creates a cancellation request for a single transaction retry or multiple transaction retries pertaining to an account.","tags":["OTHERS"],"parameters":[{"name":"accountId","in":"path","type":"string","required":true,"description":"Identifier of the account. Often referred to as the account number, yet for consistency this is always referred to as accountId. Accepts both IBAN & BBAN"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"transactionRetryIds":[{}],"extensions":{}}},"responses":{"200":"TransactionRetryCancellationsResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/holdings/accounts/{accountId}/transactionRetries/pendings","fullPath":"/api/v4.12.0/holdings/accounts/{accountId}/transactionRetries/pendings","operationId":"getPendingTransactionRetries","name":"Retrieves various details from pending transaction retries pertaining to an account, such as retry start date, retry end date, retry frequency, retry amount, number of possible retries, total number of retries attempted, details of latest retry attempted and information of successful retry. Transaction Retries - bank transfer transactions transition through various payment statuses and in some cases a payment may move to a status from which users are unable to complete their payment. Example: In","summary":"Retrieves the pending transaction retries pertaining to an account","tags":["OTHERS"],"parameters":[{"name":"accountId","in":"path","type":"string","required":true,"description":"Identifier of the account. Often referred to as the account number, yet for consistency this is always referred to as accountId. Accepts both IBAN & BBAN"},{"name":"transactionRetryId","in":"query","type":"string","required":false,"description":"Indicates the transaction retry identifier"},{"name":"numberOfTransactionRetries","in":"query","type":"string","required":false,"description":"Indicates the number of times the transaction has to be retried."},{"name":"transactionRetryStartDate","in":"query","type":"string","required":false,"description":"Indicates the date when the transaction retry has started."},{"name":"transactionRetryEndDate","in":"query","type":"string","required":false,"description":"Indicates the date till when the transaction has to be retried."},{"name":"nextTransactionRetryDate","in":"query","type":"string","required":false,"description":"Indicates the date when transaction has to be retried next."},{"name":"transactionType","in":"query","type":"string","required":false,"description":"Identifies the transaction type applicable to the transaction being processed, i.e. outward or inward payment. For example: ACPX, OTPX etc."},{"name":"contractId","in":"query","type":"string","required":false,"description":"Indicates the unique identifier of the transaction or contract which initiated the activity"},{"name":"productGroupId","in":"query","type":"string","required":false,"description":"The group, as defined by the institution, that the product belongs to."},{"name":"productId","in":"query","type":"string","required":false,"description":"Contains the unique identifier of the product, e.g. the product id of the arrangement account."},{"name":"arrangementId","in":"query","type":"string","required":false,"description":"Indicates an unique identifier of an account"},{"name":"transactionRetryStatus","in":"query","type":"string","required":false,"description":"Indicates the transaction retry status. Possible values are: NEW - Indicates transaction is captured for retry and transaction retry is yet to be processed, CURRENT - Transaction is currently being re"},{"name":"retrySettlementStatus","in":"query","type":"string","required":false,"description":"Indicates the transaction settlement status. Possible values are: PENDING - Indicates that the transaction is yet to be settled through retry, SETTLED - Indicates that the transaction is fully settled"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"PendingTransactionRetriesResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"PUT","path":"/holdings/accounts/{accountId}/withdrawalNotices/cancellations","fullPath":"/api/v4.12.0/holdings/accounts/{accountId}/withdrawalNotices/cancellations","operationId":"cancelAccountWithdrawalNotice","name":"Cancels the notification of withdrawal of amount from account.","summary":"Cancels the notification of withdrawal of amount from account","tags":["RETAIL"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"accountId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"effectiveDate":"2024-01-01","productId":"string","extensions":{},"noticeWithdrawal":[{}]}},"responses":{"200":"cancelAccountWithdrawalNoticeResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"PUT","path":"/holdings/accounts/{accountId}/withdrawalNotices/noticeUpdates","fullPath":"/api/v4.12.0/holdings/accounts/{accountId}/withdrawalNotices/noticeUpdates","operationId":"updateAccountWithdrawalNotice","name":"Updates the notice of withdrawal of amount from  account by providing the withdrawal date, bill reference and amount etc. This is applicable only for notice type of accounts.","summary":"Updates the notice of withdrawal of amount from account","tags":["RETAIL"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"accountId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"effectiveDate":"2024-01-01","productId":"string","extensions":{},"noticeWithdrawal":[{}]}},"responses":{"200":"updateAccountWithdrawalNoticeResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"PUT","path":"/holdings/accounts/{accountId}/payouts","fullPath":"/api/v4.12.0/holdings/accounts/{accountId}/payouts","operationId":"initiateAccountPayout","name":"Performs payout of the given account amount such as charges, tax etc","summary":"Perform payout of an account","tags":["RETAIL"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"accountId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"currencyId":"string","effectiveDate":"2024-01-01","activityId":"string","transactionAmount":0.0,"contractId":"string","systemId":"string","externalEventStatus":"string","extensions":{}}},"responses":{"200":"initiateAccountPayoutResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"PUT","path":"/holdings/accounts/{accountId}/repayments","fullPath":"/api/v4.12.0/holdings/accounts/{accountId}/repayments","operationId":"initiateAccountPayin","name":"Repays the account amount such as charges, tax etc","summary":"Perform repayment of the given account","tags":["RETAIL"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"accountId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"currencyId":"string","effectiveDate":"2024-01-01","activityId":"string","transactionAmount":0.0,"contractId":"string","systemId":"string","externalEventStatus":"string","extensions":{}}},"responses":{"200":"initiateAccountPayinResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"GET","path":"/holdings/accounts/nostroAccounts","fullPath":"/api/v4.12.0/holdings/accounts/nostroAccounts","operationId":"getNostroAccounts","name":"Retrieves the currency, balance and category details of the nostro account","summary":"Retrieves list of nostro account details","tags":["OTHERS"],"parameters":[{"name":"accountId","in":"query","type":"string","required":false,"description":"Identifier of the account. Often referred to as the account number, yet for consistency this is always referred to as accountId. Accepts both IBAN & BBAN"},{"name":"customerId","in":"query","type":"string","required":false,"description":"Identifier of the customer"},{"name":"productId","in":"query","type":"string","required":false,"description":"Contains the unique identifier of the product, e.g. the product id of the arrangement account."},{"name":"currencyId","in":"query","type":"string","required":false,"description":"Identifier of the currency. This is the 3-letter ISO 4217 code of the currency."},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"NostroAccountsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"POST","path":"/holdings/accounts/nostroAccounts","fullPath":"/api/v4.12.0/holdings/accounts/nostroAccounts","operationId":"createNostroAccount","name":"Create nostro account with mandatory details such as customer, currency, account title, account officer, short title, reconcile account. A nostro account is the shadow or mirror account of the vostro account maintained by the correspondent bank. The nostro account is opened with the correspondent bank as the customer.","summary":"Create nostro account","tags":["OTHERS"],"parameters":[{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"otherOfficers":[{}],"postingRestrictIds":[{}],"alternateAccountTypes":[{}],"alternateAccountIds":[{}],"jointHolderIds":[{}],"jointRelationCodes":[{}],"additionalDetails":[{}],"customerId":"string","accountTitle":"string","accountTitle2":"string","shortTitle":"string","mnemonic":"string","positionType":"string","currencyId":"string","accountOfficer":"string"}},"responses":{"200":"NostroAccountResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"POST","path":"/holdings/accounts/internalAccounts/{accountId}","fullPath":"/api/v4.12.0/holdings/accounts/internalAccounts/{accountId}","operationId":"createInternalAccount","name":"Create bank internal account with mandatory details such as account title, short title, mnemonic, account officer. The internal accounts are created and maintained for bank's internal operations such as interbranch, intercompany transactions.","summary":"Create bank internal account","tags":["OTHERS"],"parameters":[{"name":"accountId","in":"path","type":"string","required":true,"description":"Identifier of the account. Often referred to as the account number, yet for consistency this is always referred to as accountId. Accepts both IBAN & BBAN"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"otherOfficers":[{}],"postingRestrictIds":[{}],"alternateAcctDetails":[{}],"categoryId":"string","accountTitle":"string","accountTitle2":"string","shortTitle":"string","mnemonic":"string","positionType":"string","accountOfficer":"string","highVolumeTransaction":"string","openingDate":"string","extensions":{}}},"responses":{"200":"InternalAccountResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/holdings/accounts/internalAccounts/{accountId}","fullPath":"/api/v4.12.0/holdings/accounts/internalAccounts/{accountId}","operationId":"updateInternalAccount","name":"Update bank internal account with details such as short title, account officer, account title, high volume transaction flag, alternate account id, posting restriction. The internal accounts are created and maintained for bank's internal operations such as interbranch, intercompany transactions.","summary":"Update bank internal account","tags":["OTHERS"],"parameters":[{"name":"accountId","in":"path","type":"string","required":true,"description":"Identifier of the account. Often referred to as the account number, yet for consistency this is always referred to as accountId. Accepts both IBAN & BBAN"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"otherOfficers":[{}],"postingRestrictIds":[{}],"alternateAcctDetails":[{}],"accountTitle":"string","accountTitle2":"string","shortTitle":"string","mnemonic":"string","accountOfficer":"string","highVolumeTransaction":"string","extensions":{}}},"responses":{"200":"InternalAccountResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/holdings/accounts/nostroAccounts/{accountId}","fullPath":"/api/v4.12.0/holdings/accounts/nostroAccounts/{accountId}","operationId":"updateNostroAccount","name":"Update nostro account with details such as reconciliation tolerance amount, our actual account number, short title, account officer, account title, high volume transaction flag, posting restriction. A nostro account is the shadow or mirror account of the vostro account maintained by the correspondent bank. The nostro account is opened with the correspondent bank as the customer.","summary":"Update Nostro account","tags":["OTHERS"],"parameters":[{"name":"accountId","in":"path","type":"string","required":true,"description":"Identifier of the account. Often referred to as the account number, yet for consistency this is always referred to as accountId. Accepts both IBAN & BBAN"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"otherOfficers":[{}],"postingRestrictIds":[{}],"alternateAccountTypes":[{}],"alternateAccountIds":[{}],"jointHolderIds":[{}],"jointRelationCodes":[{}],"additionalDetails":[{}],"accountTitle":"string","accountTitle2":"string","shortTitle":"string","mnemonic":"string","accountOfficer":"string","ownNostro":"string","reconciliationToleranceAmount":"string","highVolumeTransaction":"string"}},"responses":{"200":"NostroAccountResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/holdings/accounts/internalAccounts","fullPath":"/api/v4.12.0/holdings/accounts/internalAccounts","operationId":"getInternalAccounts","name":"Retrieves the currency, balance and category details of the internal account","summary":"Retrieves list of internal account details","tags":["OTHERS"],"parameters":[{"name":"accountId","in":"query","type":"string","required":false,"description":"Identifier of the account. Often referred to as the account number, yet for consistency this is always referred to as accountId. Accepts both IBAN & BBAN"},{"name":"productId","in":"query","type":"string","required":false,"description":"Contains the unique identifier of the product, e.g. the product id of the arrangement account."},{"name":"currencyId","in":"query","type":"string","required":false,"description":"Identifier of the currency. This is the 3-letter ISO 4217 code of the currency."},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"InternalAccountsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/accounts","fullPath":"/api/v4.12.0/holdings/accounts","operationId":"getAccounts","name":"Retrieves the currency, balances, limit details and arrangement details of the account","summary":"Retrieves list of account basic details","tags":["OTHERS"],"parameters":[{"name":"accountId","in":"query","type":"string","required":false,"description":"Identifier of the account. Often referred to as the account number, yet for consistency this is always referred to as accountId. Accepts both IBAN & BBAN"},{"name":"customerId","in":"query","type":"string","required":false,"description":"Identifier of the customer"},{"name":"productId","in":"query","type":"string","required":false,"description":"Contains the unique identifier of the product, e.g. the product id of the arrangement account."},{"name":"currencyId","in":"query","type":"string","required":false,"description":"Identifier of the currency. This is the 3-letter ISO 4217 code of the currency."},{"name":"currencyIdSAID","in":"query","type":"string","required":false,"description":"Indicates the criteria for the sounds like operation on the currency"},{"name":"limitReference","in":"query","type":"string","required":false,"description":"Identifies the credit limit reference for the underlying account."},{"name":"arrangementId","in":"query","type":"string","required":false,"description":"Indicates an unique identifier of an account"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"AccountsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/accounts/{companyAccountId}/balances","fullPath":"/api/v4.12.0/holdings/accounts/{companyAccountId}/balances","operationId":"getAccountBalanceTypes","name":"Retrieves the balance ,balance type for the account and company provided.","summary":"Retrieves the account funds and balance types.","tags":["RETAIL"],"parameters":[{"name":"companyAccountId","in":"path","type":"string","required":true,"description":"Indicates the company code and account id seperated by '-'.Example : US0010001-10995"},{"name":"virtualBalances","in":"query","type":"string","required":false,"description":"Contains the virtual balance of the collateral"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"AccountBalanceTypesResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}}]},{"key":"holdings-accounts-service-v4.13.0","title":"Account management","version":"v4.13.0","description":"API to manage account related services such as retrieving balances, transaction and card details, emergency blocks, funds diversion, reservations, proxy identifiers and account closures. In addition, it provides functionality to support the capability to switch accounts from the current system to an","endpointCount":72,"endpoints":[{"method":"PUT","path":"/holdings/accounts/{accountId}/products","fullPath":"/api/v4.13.0/holdings/accounts/{accountId}/products","operationId":"updateAccountProduct","name":"Change account from one product to another such as changing savings account to current account","summary":"Change of contract from one account product to another","tags":["RETAIL"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"accountId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"effectiveDate":"2024-01-01","productId":"string","extensions":{},"balance":[{}]}},"responses":{"200":"updateAccountProductResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"PUT","path":"/holdings/accounts/{accountId}/limits","fullPath":"/api/v4.13.0/holdings/accounts/{accountId}/limits","operationId":"updateAccountLimit","name":"Update the limit conditions of the account with the secondary limit amount and other limit details","summary":"Update the limit conditions of the account","tags":["RETAIL"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"accountId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"effectiveDate":"2024-01-01","productId":"string","extensions":{},"limit":[{}]}},"responses":{"200":"updateAccountLimitResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"PUT","path":"/holdings/accounts/{accountId}/interestConditions","fullPath":"/api/v4.13.0/holdings/accounts/{accountId}/interestConditions","operationId":"updateAccountInterestConditions","name":"Update the interest conditions of the account such as interest rate, tier details, margin amount etc.","summary":"Update the interest conditions of the account","tags":["RETAIL"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"accountId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"effectiveDate":"2024-01-01","channel":"string","extensions":{},"crinterest":[{}]}},"responses":{"200":"updateAccountInterestConditionsResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"PUT","path":"/holdings/accounts/{accountId}/dormancyStatus/{status}","fullPath":"/api/v4.13.0/holdings/accounts/{accountId}/dormancyStatus/{status}","operationId":"updateAccountDormancyStatus","name":"Deactivates the savings account and moves it to given dormancy status.","summary":"Deactivates the savings account to given status","tags":["RETAIL"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"accountId","in":"path","type":"string","required":true,"description":""},{"name":"status","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"effectiveDate":"2024-01-01","productId":"string","extensions":{}}},"responses":{"200":"updateAccountDormancyStatusResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"PUT","path":"/holdings/accounts/{accountId}/channels","fullPath":"/api/v4.13.0/holdings/accounts/{accountId}/channels","operationId":"updateAccountChannel","name":"Updates the channel of the account","summary":"Change of channel for the account","tags":["RETAIL"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"accountId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"effectiveDate":"2024-01-01","channel":"string","extensions":{}}},"responses":{"200":"updateAccountChannelResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"POST","path":"/holdings/accounts/migrations","fullPath":"/api/v4.13.0/holdings/accounts/migrations","operationId":"initiateAccountMigration","name":"Migration of a legacy system account contract to the given account product by providing the original contract date, account name, statement, payment frequency and start date, etc. ","summary":"Migration of legacy system account contract to the given account product","tags":["RETAIL"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"partyIds":[{}],"originationReference":[{}],"effectiveDate":"2024-01-01","productId":"string","currency":"string","branch":"string","channel":"string","lineOfBusiness":"string","originalContractDate":"2024-01-01","extensions":{},"limit":[{}],"balance":[{}],"customer":[{}],"crinterest":[{}],"schedule":[{}]}},"responses":{"200":"initiateAccountMigrationResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"PUT","path":"/holdings/accounts/{accountId}/migrations/balances","fullPath":"/api/v4.13.0/holdings/accounts/{accountId}/migrations/balances","operationId":"updateAccountBalanceMigration","name":"Captures the balance details of the account such as balance type, due amount etc. This is used to migrate the balances of a legacy contract which is migrated from other system & update the balance details","summary":"Captures outstanding balance details of a contract migrated from legacy system","tags":["RETAIL"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"accountId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"productId":"string","drawdownDate":"2024-01-01","extensions":{},"balanceMaintenance":[{}]}},"responses":{"200":"updateAccountBalanceMigrationResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"PUT","path":"/holdings/accounts/{accountId}/renegotiations","fullPath":"/api/v4.13.0/holdings/accounts/{accountId}/renegotiations","operationId":"updateAccountConditions","name":"Perform the renegotiation of the account contract details such as payment frequency, payment start date, interest rate, statement frequency and settlement details, etc.","summary":"Renegotiation of the account contract details","tags":["RETAIL"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"accountId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"effectiveDate":"2024-01-01","productId":"string","extensions":{},"limit":[{}],"balance":[{}],"customer":[{}],"crinterest":[{}],"schedule":[{}],"settlement":[{}],"statement":[{}]}},"responses":{"200":"updateAccountConditionsResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"PUT","path":"/holdings/accounts/{accountId}/dormancyStatus/reactivations","fullPath":"/api/v4.13.0/holdings/accounts/{accountId}/dormancyStatus/reactivations","operationId":"updateAccountDormancyReactivation","name":"Reset the dormant account to active status manually","summary":"Reset the account dormancy status","tags":["RETAIL"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"accountId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"effectiveDate":"2024-01-01","productId":"string","extensions":{}}},"responses":{"200":"updateAccountDormancyReactivationResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"PUT","path":"/holdings/accounts/{accountId}/withdrawalNotices","fullPath":"/api/v4.13.0/holdings/accounts/{accountId}/withdrawalNotices","operationId":"createAccountWithdrawalNotice","name":"Notifies the withdrawal of amount from account by providing the withdrawal date and amount etc. This is applicable only for notice type of accounts.","summary":"Notifies the withdrawal amount from account","tags":["RETAIL"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"accountId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"effectiveDate":"2024-01-01","productId":"string","extensions":{},"noticeWithdrawal":[{}]}},"responses":{"200":"createAccountWithdrawalNoticeResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"PUT","path":"/holdings/accounts/{accountId}/customers","fullPath":"/api/v4.13.0/holdings/accounts/{accountId}/customers","operationId":"updateAccountCustomer","name":"Update the customer details of the account such as add or remove the joint customers, tax liability percentange, limit liability percentage of the joint customers","summary":"Update customers for the given account","tags":["RETAIL"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"accountId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"partyIds":[{}],"effectiveDate":"2024-01-01","extensions":{},"customer":[{}]}},"responses":{"200":"updateAccountCustomerResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"PUT","path":"/holdings/accounts/{accountId}/credits","fullPath":"/api/v4.13.0/holdings/accounts/{accountId}/credits","operationId":"updateAccountCredit","name":"Perform credit transactions in an account, providing the credit amount and the currency in which to be credited","summary":"Perform credit transaction in an account.","tags":["RETAIL"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"accountId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"currencyId":"string","effectiveDate":"2024-01-01","activityId":"string","transactionAmount":0.0,"contractId":"string","systemId":"string","externalEventStatus":"string","extensions":{}}},"responses":{"200":"updateAccountCreditResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"PUT","path":"/holdings/accounts/{accountId}/debits","fullPath":"/api/v4.13.0/holdings/accounts/{accountId}/debits","operationId":"updateAccountDebit","name":"Perform debit transactions in an account by providing debit amount and currency in which to be debited","summary":"Perform debit transactions in an account","tags":["RETAIL"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"accountId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"currencyId":"string","effectiveDate":"2024-01-01","activityId":"string","transactionAmount":0.0,"contractId":"string","systemId":"string","externalEventStatus":"string","extensions":{}}},"responses":{"200":"updateAccountDebitResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"PUT","path":"/holdings/accounts/{accountId}/adjustments","fullPath":"/api/v4.13.0/holdings/accounts/{accountId}/adjustments","operationId":"updateAccountAdjustment","name":"Performs backdated adjustment and re-accrual for the given savings account.  This is used when interest adjustment is required due to backdated rate change or transaction.","summary":"Performs backdated adjustment and re-accrual for the given savings account ","tags":["RETAIL"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"accountId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"currencyId":"string","effectiveDate":"2024-01-01","activityId":"string","transactionAmount":0.0,"contractId":"string","systemId":"string","externalEventStatus":"string","extensions":{}}},"responses":{"200":"updateAccountAdjustmentResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"PUT","path":"/holdings/accounts/{accountId}/lineofBusiness","fullPath":"/api/v4.13.0/holdings/accounts/{accountId}/lineofBusiness","operationId":"updateAccountLob","name":"Updates the type of line of business of the account","summary":"Change of line of business for the account","tags":["RETAIL"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"accountId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"effectiveDate":"2024-01-01","lineOfBusiness":"string","extensions":{}}},"responses":{"200":"updateAccountLobResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"GET","path":"/holdings/accounts/{accountId}/dormancyConditions","fullPath":"/api/v4.13.0/holdings/accounts/{accountId}/dormancyConditions","operationId":"getAccountDormancyDetails","name":"Retrieves the dormancy setup details for the account such as dormancy period, status etc","summary":"Retrieves the account dormancy conditions","tags":["RETAIL"],"parameters":[{"name":"accountId","in":"path","type":"string","required":true,"description":"Identifier of the account. Often referred to as the account number, yet for consistency this is always referred to as accountId. Accepts both IBAN & BBAN"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"AccountDormancyDetailsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/accounts/{accountId}/transactions","fullPath":"/api/v4.13.0/holdings/accounts/{accountId}/transactions","operationId":"getAccountTransactions","name":"Retrieves account transaction details such as transaction type, amount, transaction reference, credit or debit indicator, booking and effective date of transaction","summary":"Retrieves account transaction details","tags":["RETAIL"],"parameters":[{"name":"accountId","in":"path","type":"string","required":true,"description":"Identifier of the account. Often referred to as the account number, yet for consistency this is always referred to as accountId. Accepts both IBAN & BBAN"},{"name":"fromDate","in":"query","type":"string","required":false,"description":"Indicates the business date from when the balance reservation event is active."},{"name":"toDate","in":"query","type":"string","required":false,"description":"Indicates the business date until when the balance reservation event is active."},{"name":"transactionReference","in":"query","type":"string","required":false,"description":"Contains the identifier for the transaction in the core system"},{"name":"period","in":"query","type":"string","required":false,"description":"Indicates spread of time buckets.Ex: 3M,6M,9M,10Y etc."},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"AccountTransactionsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/accounts/accountsDetails","fullPath":"/api/v4.13.0/holdings/accounts/accountsDetails","operationId":"getAccountInfo","name":"Retrieves the currency, balances, limit details and arrangement details of the account","summary":"Retrieves list of account basic details","tags":["RETAIL"],"parameters":[{"name":"customer","in":"query","type":"string","required":false,"description":"Contains the customer identifier to fetch list of consent arrangements for the customer or customer identifier of the debtor account. This will be populated once the SCA(Strong Customer Authentication"},{"name":"arrangementId","in":"query","type":"string","required":false,"description":"Indicates an unique identifier of an account"},{"name":"currency","in":"query","type":"string","required":false,"description":"Identifies the currency. E.g. USD, GBP etc"},{"name":"companyCode","in":"query","type":"string","required":false,"description":"The identifier of the underlying Entity/Company/Branch."},{"name":"productId","in":"query","type":"string","required":false,"description":"Contains the unique identifier of the product, e.g. the product id of the arrangement account."},{"name":"status","in":"query","type":"string","required":false,"description":"Contains status of the data rights request.Allowed values are INITIATED, INPROGESS, EXTENDED, COMPLETED, REJECTED."},{"name":"accountId","in":"query","type":"string","required":false,"description":"Identifier of the account. Often referred to as the account number, yet for consistency this is always referred to as accountId. Accepts both IBAN & BBAN"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"AccountInfoResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/accounts/{accountId}/statements","fullPath":"/api/v4.13.0/holdings/accounts/{accountId}/statements","operationId":"getAccountStatementDetails","name":"Retrieves the statement frequency of an account","summary":"Retrieves the statement frequency of an account","tags":["RETAIL"],"parameters":[{"name":"accountId","in":"path","type":"string","required":true,"description":"Identifier of the account. Often referred to as the account number, yet for consistency this is always referred to as accountId. Accepts both IBAN & BBAN"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"AccountStatementDetailsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"PUT","path":"/holdings/accounts/{accountId}/statements","fullPath":"/api/v4.13.0/holdings/accounts/{accountId}/statements","operationId":"updateAccountStatement","name":"Update the statement frequency of an account.","summary":"Update the statement frequency of an account","tags":["RETAIL"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"productId":"string","drawdownDate":"2024-01-01","extensions":{},"statement":[{}]}},"responses":{"200":"updateAccountStatementResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"PUT","path":"/holdings/accounts/{accountId}/migrations/bills","fullPath":"/api/v4.13.0/holdings/accounts/{accountId}/migrations/bills","operationId":"updateAccountBillMigration","name":"Captures the bill information of the account such as bill id, property names, bill amount etc. This is used to migrate the bills of a legacy contract which is migrated from other system & update the bill details","summary":"Captures the bill information of the account such as bill id, property names, bill amount etc. This is used to migrate the bills of a legacy contract which is migrated from other system & update the bill details","tags":["RETAIL"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"accountId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"productId":"string","drawdownDate":"2024-01-01","extensions":{},"balanceMaintenance":[{}]}},"responses":{"200":"updateAccountBillMigrationResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"PUT","path":"/holdings/accounts/{accountId}/branches","fullPath":"/api/v4.13.0/holdings/accounts/{accountId}/branches","operationId":"updateAccountBranch","name":"Updates the branch of an account","summary":"Updates the branch of an account","tags":["RETAIL"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"accountId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"effectiveDate":"2024-01-01","branch":"string","extensions":{}}},"responses":{"200":"updateAccountBranchResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"PUT","path":"/holdings/accounts/{accountId}/settlements","fullPath":"/api/v4.13.0/holdings/accounts/{accountId}/settlements","operationId":"updateAccountSettlement","name":"Update the settlement conditions of the account such as payin account, payin percentage, payin amount, payout account, payout percentage, payout amount, etc","summary":"Update the settlement conditions of the account such as payin account, payin percentage, payin amount, payout account, payout percentage, payout amount, etc","tags":["RETAIL"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"accountId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"productId":"string","drawdownDate":"2024-01-01","extensions":{},"settlement":[{}]}},"responses":{"200":"updateAccountSettlementResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"PUT","path":"/holdings/accounts/{accountId}/accounts","fullPath":"/api/v4.13.0/holdings/accounts/{accountId}/accounts","operationId":"updateAccount","name":"Update the account details to block or unblock the account by setting the posting restriction and to change the nick name of the account","summary":"Update the account's details","tags":["RETAIL"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"accountId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"productId":"string","drawdownDate":"2024-01-01","extensions":{},"balance":[{}]}},"responses":{"200":"updateAccountResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"PUT","path":"/holdings/accounts/{accountId}/schedules","fullPath":"/api/v4.13.0/holdings/accounts/{accountId}/schedules","operationId":"updateAccountSchedule","name":"Update the payment schedule condition such as payment method from capitalise to pay, payment frequency from monthly to quarterly etc., on an account","summary":"Update payment schedule for the given account","tags":["RETAIL"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"accountId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"productId":"string","drawdownDate":"2024-01-01","extensions":{},"schedule":[{}]}},"responses":{"200":"updateAccountScheduleResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"GET","path":"/holdings/accounts/accountClosures/{accountId}","fullPath":"/api/v4.13.0/holdings/accounts/accountClosures/{accountId}","operationId":"getAccountClosure","name":"Retrieves the account closure information of the account such as closure date and reason, mode of closure, balances on the date of closing and pending charges","summary":"Retrieves the account closure information","tags":["OTHERS"],"parameters":[{"name":"accountId","in":"path","type":"string","required":true,"description":"Identifier of the account. Often referred to as the account number, yet for consistency this is always referred to as accountId. Accepts both IBAN & BBAN"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"AccountClosureResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/holdings/accounts/accountClosures/{accountId}","fullPath":"/api/v4.13.0/holdings/accounts/accountClosures/{accountId}","operationId":"updateAccountClosure","name":"Updates account closure information for the specific account such as closure date and reason, mode of closure and closing charges","summary":"Updates account closure information","tags":["OTHERS"],"parameters":[{"name":"accountId","in":"path","type":"string","required":true,"description":"Identifier of the account. Often referred to as the account number, yet for consistency this is always referred to as accountId. Accepts both IBAN & BBAN"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"accountCurrency":"string","closureDate":"2024-01-01T00:00:00Z","creditAccount":"string","capitaliseInterest":"string","chargeType":"string","chargeAmount":0.0,"closeMode":"string","ftId":"string","closureReason":"string","closureNotes":"string","onlineLedgerBalance":0.0,"onlineClearedBalance":0.0,"balancePayable":0.0,"totalCreditInterest":"string","totalDebitInterest":"string"}},"responses":{"200":"AccountClosureResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/holdings/accounts/{accountId}/cards","fullPath":"/api/v4.13.0/holdings/accounts/{accountId}/cards","operationId":"getAccountCards","name":"Retrieves the card details of the account such as card number, card type and status of the card","summary":"Retrieves available card details","tags":["OTHERS"],"parameters":[{"name":"accountId","in":"path","type":"string","required":true,"description":"Identifier of the account. Often referred to as the account number, yet for consistency this is always referred to as accountId. Accepts both IBAN & BBAN"},{"name":"cardIssueId","in":"query","type":"string","required":false,"description":"The identifier of the issued card formatted as cardType '.' cardNumber. E.g. VISA.1234567887654321 GC.1111222233334444 AB21.1111111122222222"},{"name":"issueDate","in":"query","type":"string","required":false,"description":"The date the item was issued."},{"name":"expiryDate","in":"query","type":"string","required":false,"description":"This indicates the  date  on which the offer or privilege terminates for the event."},{"name":"cardStatus","in":"query","type":"string","required":false,"description":"Current status of the Card and following are the possible statuses are  - CARD.ISSUED - CARD.RETURNED - CARD.SCRAP - CARD.CANCEL - NOT.ACTIVATED - NOT.RECEIVED - ACTIVE - BLOCKED - EXPIRED"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"AccountCardsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/accounts/balances","fullPath":"/api/v4.13.0/holdings/accounts/balances","operationId":"getAccountBalanceToday","name":"Retrieves various types of balances such as cleared, online, locked and usable balance of the account","summary":"Retrieves list of account balances","tags":["OTHERS"],"parameters":[{"name":"accountId","in":"query","type":"string","required":false,"description":"Identifier of the account. Often referred to as the account number, yet for consistency this is always referred to as accountId. Accepts both IBAN & BBAN"},{"name":"customerId","in":"query","type":"string","required":false,"description":"Identifier of the customer"},{"name":"productId","in":"query","type":"string","required":false,"description":"Contains the unique identifier of the product, e.g. the product id of the arrangement account."},{"name":"currencyId","in":"query","type":"string","required":false,"description":"Identifier of the currency. This is the 3-letter ISO 4217 code of the currency."},{"name":"limitReferenceId","in":"query","type":"string","required":false,"description":"Limit reference identifier for the limit order."},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"AccountBalanceTodayResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/accounts/{accountId}/balanceMovements/{bookingDate}","fullPath":"/api/v4.13.0/holdings/accounts/{accountId}/balanceMovements/{bookingDate}","operationId":"getAccountBalanceMovement","name":"Retrieves the credit, debit and gross balance movements for an account for the requested booking date","summary":"Retrieves balances movements of account","tags":["OTHERS"],"parameters":[{"name":"accountId","in":"path","type":"string","required":true,"description":"Identifier of the account. Often referred to as the account number, yet for consistency this is always referred to as accountId. Accepts both IBAN & BBAN"},{"name":"bookingDate","in":"path","type":"string","required":true,"description":"Business date on which the accounting entry was generated."},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"AccountBalanceMovementResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/accounts/{accountId}/emergencyBlocks/status","fullPath":"/api/v4.13.0/holdings/accounts/{accountId}/emergencyBlocks/status","operationId":"getAccountEmergencyBlock","name":"Retrieve emergency block status and reason for a given account. This information will be used to assert the actual block status of an account in microservice","summary":"Retrieve emergency block information for an account","tags":["OTHERS"],"parameters":[{"name":"accountId","in":"path","type":"string","required":true,"description":"Identifier of the account. Often referred to as the account number, yet for consistency this is always referred to as accountId. Accepts both IBAN & BBAN"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"AccountEmergencyBlockResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"PUT","path":"/holdings/accounts/{accountId}/emergencyBlocks/status","fullPath":"/api/v4.13.0/holdings/accounts/{accountId}/emergencyBlocks/status","operationId":"updateAccountEmergencyBlock","name":"Updates emergency block status and reason for block of the account","summary":"Update emergency block in account","tags":["OTHERS"],"parameters":[{"name":"accountId","in":"path","type":"string","required":true,"description":""},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"emergencyBlock":"string","emergencyReason":"string","extensions":{}}},"responses":{"200":"AccountEmergencyBlockResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/holdings/accounts/{accountId}/fundsAuthorisations/status","fullPath":"/api/v4.13.0/holdings/accounts/{accountId}/fundsAuthorisations/status","operationId":"getAccountFundsAuthStatus","name":"Retrieve the funds authorisation status of the account","summary":"Retrieve account funds authorisation status","tags":["OTHERS"],"parameters":[{"name":"accountId","in":"path","type":"string","required":true,"description":"Identifier of the account. Often referred to as the account number, yet for consistency this is always referred to as accountId. Accepts both IBAN & BBAN"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"AccountFundsAuthStatusResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"PUT","path":"/holdings/accounts/{accountId}/fundsAuthorisations/status","fullPath":"/api/v4.13.0/holdings/accounts/{accountId}/fundsAuthorisations/status","operationId":"updateAccountFundsAuthStatus","name":"Update the funds authorisation status for the account, for example SYNC or ERROR","summary":"Update account funds authorisation status","tags":["OTHERS"],"parameters":[{"name":"accountId","in":"path","type":"string","required":true,"description":""},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"faStatus":"string","extensions":{}}},"responses":{"200":"AccountFundsAuthStatusResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"POST","path":"/holdings/accounts/settings/{settingId}/fundsDiversion","fullPath":"/api/v4.13.0/holdings/accounts/settings/{settingId}/fundsDiversion","operationId":"createFundsDiversion","name":"Allows creation of funds diversion conditions for a company to manage the behavior of booking funds against any account in the company that has the auto pay account defined","summary":"Creates conditions for funds diversion","tags":["OTHERS"],"parameters":[{"name":"settingId","in":"path","type":"string","required":true,"description":"Contains the particular parameter record setting identifier."},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"transactionCodes":[{}],"defaultFundsDiversion":"string","extensions":{}}},"responses":{"200":"FundsDiversionResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/holdings/accounts/settings/{settingId}/fundsDiversion","fullPath":"/api/v4.13.0/holdings/accounts/settings/{settingId}/fundsDiversion","operationId":"updateFundsDiversion","name":"Updates the funds diversion conditions for a company to manage the behavior of booking funds against any account in the company that has the auto pay account defined","summary":"Updates funds diversion parameter","tags":["OTHERS"],"parameters":[{"name":"settingId","in":"path","type":"string","required":true,"description":"Contains the particular parameter record setting identifier."},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"transactionCodes":[{}],"defaultFundsDiversion":"string","extensions":{}}},"responses":{"200":"FundsDiversionResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/holdings/nostros/forwardBalances","fullPath":"/api/v4.13.0/holdings/nostros/forwardBalances","operationId":"getNostroForwardBalances","name":"Retrieves forward balances of nostro accounts considering the transaction effective dates.","summary":"Retrieves consolidated nostro account balances","tags":["OTHERS"],"parameters":[{"name":"valueDate","in":"query","type":"string","required":false,"description":"Indicates the value date on which the underlying accounting entry is to be given value (for interest purposes)"},{"name":"accountId","in":"query","type":"string","required":true,"description":"Identifier of the account. Often referred to as the account number, yet for consistency this is always referred to as accountId. Accepts both IBAN & BBAN"},{"name":"longPositionSign","in":"query","type":"string","required":false,"description":"Polarity (sign) used to denote buy position balance.  "},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"NostroForwardBalancesResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/nostros/currencyBalances/{currencyId}/accounts","fullPath":"/api/v4.13.0/holdings/nostros/currencyBalances/{currencyId}/accounts","operationId":"getNostroBalances","name":"Retrieves the date wise balances of the nostro accounts that falls under a specific currency","summary":"Retrieves nostro account balances for a specific currency","tags":["OTHERS"],"parameters":[{"name":"currencyId","in":"path","type":"string","required":true,"description":"Identifier of the currency. This is the 3-letter ISO 4217 code of the currency."},{"name":"nostroId","in":"query","type":"string","required":false,"description":"Nostro account id"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"NostroBalancesResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/nostros/currencyBalances/{currencyId}","fullPath":"/api/v4.13.0/holdings/nostros/currencyBalances/{currencyId}","operationId":"getNostroCurrencyPositions","name":"Retrieves consolidated balances of the nostro accounts in a given currency from the current date to the next five days.","summary":"Retrieves consolidated nostro account balances for a specific currency","tags":["OTHERS"],"parameters":[{"name":"currencyId","in":"path","type":"string","required":true,"description":"Identifier of the currency. This is the 3-letter ISO 4217 code of the currency."},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"NostroCurrencyPositionsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/accounts/{accountId}","fullPath":"/api/v4.13.0/holdings/accounts/{accountId}","operationId":"getAccountDetails","name":"Retrieves the arrangement account details such as account balances, allowed, advised and outstanding limit balances, interest types and values with the corresponding mode, frequency and value of payments","summary":"Retrieves arrangement account details","tags":["OTHERS"],"parameters":[{"name":"accountId","in":"path","type":"string","required":true,"description":"Identifier of the account. Often referred to as the account number, yet for consistency this is always referred to as accountId. Accepts both IBAN & BBAN"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"AccountDetailsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"POST","path":"/holdings/accounts/{accountId}","fullPath":"/api/v4.13.0/holdings/accounts/{accountId}","operationId":"createCustomerAccount","name":"Create a customer account with mandatory details such as account title, short title, mnemonic, account officer.","summary":"Create account for registered customer","tags":["OTHERS"],"parameters":[{"name":"accountId","in":"path","type":"string","required":true,"description":"Identifier of the account. Often referred to as the account number, yet for consistency this is always referred to as accountId. Accepts both IBAN & BBAN"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"customerId":"string","currency":"string","mnemonic":"string","accountName":"string","category":"string","customerName":"string","openingDate":"string","extensions":{}}},"responses":{"200":"CustomerAccountResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/holdings/accounts/proxyIdentifiers","fullPath":"/api/v4.13.0/holdings/accounts/proxyIdentifiers","operationId":"getActiveProxyIdentifier","name":"Retrieve proxy registration status from proxy directory for a given customer number or account number or proxy type and proxy identifier","summary":"Retrieve proxy registration status","tags":["OTHERS"],"parameters":[{"name":"customerId","in":"query","type":"string","required":false,"description":"Identifier of the customer"},{"name":"alternateAccountId","in":"query","type":"string","required":false,"description":"Contains the Uniform Banking Code of the arrangement"},{"name":"proxyType","in":"query","type":"string","required":false,"description":"Type of proxy created for account"},{"name":"proxyIdentifier","in":"query","type":"string","required":false,"description":"A proxy identifier to be linked to an account based on the proxy type provided eg. Mobile number, email id and tax id"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"ActiveProxyIdentifierResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"POST","path":"/holdings/accounts/proxyIdentifiers","fullPath":"/api/v4.13.0/holdings/accounts/proxyIdentifiers","operationId":"createProxyIdentifier","name":"Register the proxy identifier with details of proxy type and scheme for a customer and account","summary":"Register the proxy identifier for the account","tags":["OTHERS"],"parameters":[{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"customerId":"string","accountId":"string","alternateAccountId":"string","proxyType":"string","proxyIdentifier":"string","proxyStatus":"string","proxyScheme":"string","proxyRole":"string","extensions":{}}},"responses":{"200":"ProxyIdentifierResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/holdings/accounts/proxyIdentifiers/{proxyIdentifierId}","fullPath":"/api/v4.13.0/holdings/accounts/proxyIdentifiers/{proxyIdentifierId}","operationId":"updateProxyIdentifier","name":"Update the specific proxy identifier to de-register the registered account or customer from the proxy directory","summary":"Update proxy directory for account to de-register the proxy identifier","tags":["OTHERS"],"parameters":[{"name":"proxyIdentifierId","in":"path","type":"string","required":true,"description":""},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"customerId":"string","accountId":"string","alternateAccountId":"string","proxyType":"string","proxyIdentifier":"string","proxyStatus":"string","proxyScheme":"string","proxyRole":"string","extensions":{}}},"responses":{"200":"ProxyIdentifierResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/holdings/accounts/{accountId}/{accountCompany}/{paymentCurrency}/{accountSwitch}/{beneficialCustomer}/payments","fullPath":"/api/v4.13.0/holdings/accounts/{accountId}/{accountCompany}/{paymentCurrency}/{accountSwitch}/{beneficialCustomer}/payments","operationId":"getAccountPaymentDetails","name":"Retrieves the account information that are required for processing or validating an account involved in a payment transaction. Provides the information such as account name, customer number, account type, account currency, IBAN, account switch details, account status (ACTIVE or INACTIVE) and account closure details.","summary":"Retrieves account details required for payment processing","tags":["OTHERS"],"parameters":[{"name":"accountId","in":"path","type":"string","required":true,"description":"Identifier of the account. Often referred to as the account number, yet for consistency this is always referred to as accountId. Accepts both IBAN & BBAN"},{"name":"accountCompany","in":"path","type":"string","required":true,"description":"Company of the account to be created"},{"name":"paymentCurrency","in":"path","type":"string","required":true,"description":"This field holds the transaction currency or currency in which payment is initiated. "},{"name":"accountSwitch","in":"path","type":"string","required":true,"description":"Indicates if availability of account switch details should be checked."},{"name":"beneficialCustomer","in":"path","type":"string","required":true,"description":"Indicates if beneficial owners of the account are to be retrieved"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"AccountPaymentDetailsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/accounts/{contractBalanceId}/contractBalances","fullPath":"/api/v4.13.0/holdings/accounts/{contractBalanceId}/contractBalances","operationId":"getContractBalances","name":"Retrieves the contract balances of accounts or contracts with details such as contract currency, balance types, credit and debit movements and opening and closing balance of the respective balance types","summary":"Retrieves contract balances of accounts","tags":["OTHERS"],"parameters":[{"name":"contractBalanceId","in":"path","type":"string","required":true,"description":"Unique Identifier of Contract Balances"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"ContractBalancesResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"PUT","path":"/holdings/accounts/{accountId}/synchronizationErrors","fullPath":"/api/v4.13.0/holdings/accounts/{accountId}/synchronizationErrors","operationId":"updateSynchronizationError","name":"Updates error status during synchronization of the account between Transact and Funds authorization microservice.","summary":"Update synchronization error status","tags":["OTHERS"],"parameters":[{"name":"accountId","in":"path","type":"string","required":true,"description":"Identifier of the account. Often referred to as the account number, yet for consistency this is always referred to as accountId. Accepts both IBAN & BBAN"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"emergencyBlockError":"string","extensions":{}}},"responses":{"200":"SynchronizationErrorResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/holdings/accounts/{accountId}/accountSwitches/expiringSwitches","fullPath":"/api/v4.13.0/holdings/accounts/{accountId}/accountSwitches/expiringSwitches","operationId":"getExpiringAccountSwitches","name":"Retrieves the details of the expiring account switches for generating alerts such as the bank identifier code, alert date and account id of expiring switch instruction etc.","summary":"Retrieves the details of the expiring switches for generating alerts","tags":["OTHERS"],"parameters":[{"name":"accountId","in":"path","type":"string","required":true,"description":"Identifier of the account. Often referred to as the account number, yet for consistency this is always referred to as accountId. Accepts both IBAN & BBAN"},{"name":"alertStatus","in":"query","type":"string","required":false,"description":"Contains status of the Alert to be raised for switching instruction. Possible values are Pending, Sent."},{"name":"alertDate","in":"query","type":"string","required":false,"description":"Indicates the date in which an alert to be raised for a switching instruction."},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"ExpiringAccountSwitchesResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/accounts/{accountId}/accountSwitches","fullPath":"/api/v4.13.0/holdings/accounts/{accountId}/accountSwitches","operationId":"getAccountSwitchDetails","name":"Retrieves details from the account switch directory for the specific account such as the expiry date, status of the switch instruction, effective date of the switch, bank identifier code and IBAN (International Bank Account Number ) etc.","summary":"Retrieves details of the account switch requests","tags":["OTHERS"],"parameters":[{"name":"accountId","in":"path","type":"string","required":true,"description":"Identifier of the account. Often referred to as the account number, yet for consistency this is always referred to as accountId. Accepts both IBAN & BBAN"},{"name":"requestDate","in":"query","type":"string","required":false,"description":"Date on which the client's request to be classified as professional has been received."},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"AccountSwitchDetailsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"PUT","path":"/holdings/accounts/{accountId}/accountSwitches","fullPath":"/api/v4.13.0/holdings/accounts/{accountId}/accountSwitches","operationId":"updateAccountSwitchDetails","name":"Updates alert status based on the original IBAN. Used by external systems handling alert generation to mark the status from pending to sent","summary":"Updates alert status from pending to be sent for corresponding switch instructions.","tags":["OTHERS"],"parameters":[{"name":"accountId","in":"path","type":"string","required":true,"description":"Identifier of the account. Often referred to as the account number, yet for consistency this is always referred to as accountId. Accepts both IBAN & BBAN"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"accountId":"string","switchIBAN":"string","switchAccountId":"string","switchBic":"string","switchClearingCode":"string","requestDate":"string","status":"string","cancelInstruction":"string","cancelDate":"string","expiryDate":"string","IBAN":"string","bicId":"string","effectiveDate":"string","alertDate":"string","alertStatus":"string"}},"responses":{"200":"AccountSwitchDetailsResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/holdings/accounts/{accountId}/accountSwitches/payments","fullPath":"/api/v4.13.0/holdings/accounts/{accountId}/accountSwitches/payments","operationId":"getAccountSwitchPaymentDetails","name":"Retrieves information of the rerouted payments from the payment transaction exit point.","summary":"Retrieves rerouted payment information.","tags":["OTHERS"],"parameters":[{"name":"accountId","in":"path","type":"string","required":true,"description":"Identifier of the account. Often referred to as the account number, yet for consistency this is always referred to as accountId. Accepts both IBAN & BBAN"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"AccountSwitchPaymentDetailsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"PUT","path":"/holdings/accounts/accountClosures/{accountId}/approvals","fullPath":"/api/v4.13.0/holdings/accounts/accountClosures/{accountId}/approvals","operationId":"approveAccountClosure","name":"Approves account closure information to allow closing of an account which is no longer in use","summary":"Approves account closure information","tags":["OTHERS"],"parameters":[{"name":"accountId","in":"path","type":"string","required":true,"description":"Identifier of the account. Often referred to as the account number, yet for consistency this is always referred to as accountId. Accepts both IBAN & BBAN"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"AccountClosureResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/holdings/accounts/reservedFunds","fullPath":"/api/v4.13.0/holdings/accounts/reservedFunds","operationId":"getReservedFunds","name":"Retrieves the reserved funds details such as reason, amount and period of reservation of the account","summary":"Retrieves the list of reserved funds ","tags":["OTHERS"],"parameters":[{"name":"accountId","in":"query","type":"string","required":false,"description":"Identifier of the account. Often referred to as the account number, yet for consistency this is always referred to as accountId. Accepts both IBAN & BBAN"},{"name":"lockedEventReference","in":"query","type":"string","required":false,"description":"Captures the AC.LOCKED.EVENTS id if in case the funds is available and reserved."},{"name":"lockReason","in":"query","type":"string","required":false,"description":"Indicates the simple description for the balance reservation event."},{"name":"fromDate","in":"query","type":"string","required":false,"description":"Indicates the business date from when the balance reservation event is active."},{"name":"toDate","in":"query","type":"string","required":false,"description":"Indicates the business date until when the balance reservation event is active."},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"ReservedFundsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"POST","path":"/holdings/accounts/reservedFunds","fullPath":"/api/v4.13.0/holdings/accounts/reservedFunds","operationId":"createFundsReservation","name":"Creates a funds reservation with details such as account number, block or reserve amount, period of hold transaction, reason for holding. Funds reservations are created to block or reserve funds which restricts any debit movements affecting the account balance below the blocked amount for the specified period on an account.","summary":"Creates a credit or debit funds reservation to block the funds in an account","tags":["OTHERS"],"parameters":[{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"accountId":"string","lockReason":"string","fromDate":"2024-01-01","toDate":"2024-01-01","lockedAmount":"string","transactionReference":"string","transactionRetry":"string","systemId":"string","additionalDetail":"string","alternateKey":"string","reservationTypeId":"string","accountLink":"string","action":"string","creditDebitIndicator":"string","reservationIndicator":"string"}},"responses":{"200":"FundsReservationResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/holdings/accounts/reservedFunds/{lockedEventReference}","fullPath":"/api/v4.13.0/holdings/accounts/reservedFunds/{lockedEventReference}","operationId":"updateFundsReservation","name":"Update funds reservation with details such as account number, block or reserve amount, period of hold transaction, reason for holding. Funds reservations are created to block or reserve funds which restricts any debit movements affecting the account balance below the blocked amount for the specified period on an account.","summary":"Update the credit or debit funds reservation to block the funds in an account","tags":["OTHERS"],"parameters":[{"name":"lockedEventReference","in":"path","type":"string","required":true,"description":"Captures the AC.LOCKED.EVENTS id if in case the funds is available and reserved."},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"accountId":"string","lockReason":"string","fromDate":"2024-01-01","toDate":"2024-01-01","lockedAmount":"string","transactionReference":"string","transactionRetry":"string","systemId":"string","additionalDetail":"string","alternateKey":"string","reservationTypeId":"string","accountLink":"string","action":"string","creditDebitIndicator":"string","reservationIndicator":"string"}},"responses":{"200":"FundsReservationResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"DELETE","path":"/holdings/accounts/reservedFunds/{lockedEventReference}","fullPath":"/api/v4.13.0/holdings/accounts/reservedFunds/{lockedEventReference}","operationId":"cancelFundsReservation","name":"Cancels the funds reservation of an account. Funds reservations are created to block or reserve funds which restricts any debit movements affecting the account balance below the blocked amount for the specified period on an account. On removal of the funds reservations, the blocked or reserved amount is now available for usage.","summary":"Cancels the credit or debit funds reservation to unblock the funds in an account","tags":["OTHERS"],"parameters":[{"name":"lockedEventReference","in":"path","type":"string","required":true,"description":"Captures the AC.LOCKED.EVENTS id if in case the funds is available and reserved."},{"name":"payload","in":"body","type":"object","required":false,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}}},"responses":{"200":"FundsReservationResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/holdings/nostros/positions/{currencyId}","fullPath":"/api/v4.13.0/holdings/nostros/positions/{currencyId}","operationId":"getNostroPositions","name":"Retrieves nostro account balances for a given currency from the current date to the next five days.","summary":"Retrieves consolidated nostro account positions for the currency","tags":["OTHERS"],"parameters":[{"name":"currencyId","in":"path","type":"string","required":true,"description":"Identifier of the currency. This is the 3-letter ISO 4217 code of the currency."},{"name":"longPositionSign","in":"query","type":"string","required":false,"description":"Polarity (sign) used to denote buy position balance.  "},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"NostroPositionsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/accounts/{accountId}/transactionRetries/cancellations","fullPath":"/api/v4.13.0/holdings/accounts/{accountId}/transactionRetries/cancellations","operationId":"getTransactionRetryCancellations","name":"Retrieves the cancellation request applied on a single transaction retry or multiple transaction retries pertaining to an account with information such as transaction retry id, transaction retry change type and transaction retry change value.","summary":"Retrieves the cancellation request applied on a single transaction retry or multiple transaction retries pertaining to an account.","tags":["OTHERS"],"parameters":[{"name":"accountId","in":"path","type":"string","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"TransactionRetryCancellationsResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"POST","path":"/holdings/accounts/{accountId}/transactionRetries/cancellations","fullPath":"/api/v4.13.0/holdings/accounts/{accountId}/transactionRetries/cancellations","operationId":"createTransactionRetryCancellations","name":"Creates a cancellation request for a single transaction retry or multiple transaction retries pertaining to an account. The request will terminate the transaction from further retry.","summary":"Creates a cancellation request for a single transaction retry or multiple transaction retries pertaining to an account.","tags":["OTHERS"],"parameters":[{"name":"accountId","in":"path","type":"string","required":true,"description":"Identifier of the account. Often referred to as the account number, yet for consistency this is always referred to as accountId. Accepts both IBAN & BBAN"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"transactionRetryIds":[{}],"extensions":{}}},"responses":{"200":"TransactionRetryCancellationsResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/holdings/accounts/{accountId}/transactionRetries/pendings","fullPath":"/api/v4.13.0/holdings/accounts/{accountId}/transactionRetries/pendings","operationId":"getPendingTransactionRetries","name":"Retrieves various details from pending transaction retries pertaining to an account, such as retry start date, retry end date, retry frequency, retry amount, number of possible retries, total number of retries attempted, details of latest retry attempted and information of successful retry. Transaction Retries - bank transfer transactions transition through various payment statuses and in some cases a payment may move to a status from which users are unable to complete their payment. Example: In","summary":"Retrieves the pending transaction retries pertaining to an account","tags":["OTHERS"],"parameters":[{"name":"accountId","in":"path","type":"string","required":true,"description":"Identifier of the account. Often referred to as the account number, yet for consistency this is always referred to as accountId. Accepts both IBAN & BBAN"},{"name":"transactionRetryId","in":"query","type":"string","required":false,"description":"Indicates the transaction retry identifier"},{"name":"numberOfTransactionRetries","in":"query","type":"string","required":false,"description":"Indicates the number of times the transaction has to be retried."},{"name":"transactionRetryStartDate","in":"query","type":"string","required":false,"description":"Indicates the date when the transaction retry has started."},{"name":"transactionRetryEndDate","in":"query","type":"string","required":false,"description":"Indicates the date till when the transaction has to be retried."},{"name":"nextTransactionRetryDate","in":"query","type":"string","required":false,"description":"Indicates the date when transaction has to be retried next."},{"name":"transactionType","in":"query","type":"string","required":false,"description":"Identifies the transaction type applicable to the transaction being processed, i.e. outward or inward payment. For example: ACPX, OTPX etc."},{"name":"contractId","in":"query","type":"string","required":false,"description":"Indicates the unique identifier of the transaction or contract which initiated the activity"},{"name":"productGroupId","in":"query","type":"string","required":false,"description":"The group, as defined by the institution, that the product belongs to."},{"name":"productId","in":"query","type":"string","required":false,"description":"Contains the unique identifier of the product, e.g. the product id of the arrangement account."},{"name":"arrangementId","in":"query","type":"string","required":false,"description":"Indicates an unique identifier of an account"},{"name":"transactionRetryStatus","in":"query","type":"string","required":false,"description":"Indicates the transaction retry status. Possible values are: NEW - Indicates transaction is captured for retry and transaction retry is yet to be processed, CURRENT - Transaction is currently being re"},{"name":"retrySettlementStatus","in":"query","type":"string","required":false,"description":"Indicates the transaction settlement status. Possible values are: PENDING - Indicates that the transaction is yet to be settled through retry, SETTLED - Indicates that the transaction is fully settled"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"PendingTransactionRetriesResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"PUT","path":"/holdings/accounts/{accountId}/withdrawalNotices/cancellations","fullPath":"/api/v4.13.0/holdings/accounts/{accountId}/withdrawalNotices/cancellations","operationId":"cancelAccountWithdrawalNotice","name":"Cancels the notification of withdrawal of amount from account.","summary":"Cancels the notification of withdrawal of amount from account","tags":["RETAIL"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"accountId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"effectiveDate":"2024-01-01","productId":"string","extensions":{},"noticeWithdrawal":[{}]}},"responses":{"200":"cancelAccountWithdrawalNoticeResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"PUT","path":"/holdings/accounts/{accountId}/withdrawalNotices/noticeUpdates","fullPath":"/api/v4.13.0/holdings/accounts/{accountId}/withdrawalNotices/noticeUpdates","operationId":"updateAccountWithdrawalNotice","name":"Updates the notice of withdrawal of amount from  account by providing the withdrawal date, bill reference and amount etc. This is applicable only for notice type of accounts.","summary":"Updates the notice of withdrawal of amount from account","tags":["RETAIL"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"accountId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"effectiveDate":"2024-01-01","productId":"string","extensions":{},"noticeWithdrawal":[{}]}},"responses":{"200":"updateAccountWithdrawalNoticeResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"PUT","path":"/holdings/accounts/{accountId}/payouts","fullPath":"/api/v4.13.0/holdings/accounts/{accountId}/payouts","operationId":"initiateAccountPayout","name":"Performs payout of the given account amount such as charges, tax etc","summary":"Perform payout of an account","tags":["RETAIL"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"accountId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"currencyId":"string","effectiveDate":"2024-01-01","activityId":"string","transactionAmount":0.0,"contractId":"string","systemId":"string","externalEventStatus":"string","extensions":{}}},"responses":{"200":"initiateAccountPayoutResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"PUT","path":"/holdings/accounts/{accountId}/repayments","fullPath":"/api/v4.13.0/holdings/accounts/{accountId}/repayments","operationId":"initiateAccountPayin","name":"Repays the account amount such as charges, tax etc","summary":"Perform repayment of the given account","tags":["RETAIL"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"accountId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"currencyId":"string","effectiveDate":"2024-01-01","activityId":"string","transactionAmount":0.0,"contractId":"string","systemId":"string","externalEventStatus":"string","extensions":{}}},"responses":{"200":"initiateAccountPayinResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"GET","path":"/holdings/accounts/nostroAccounts","fullPath":"/api/v4.13.0/holdings/accounts/nostroAccounts","operationId":"getNostroAccounts","name":"Retrieves the currency, balance and category details of the nostro account","summary":"Retrieves list of nostro account details","tags":["OTHERS"],"parameters":[{"name":"accountId","in":"query","type":"string","required":false,"description":"Identifier of the account. Often referred to as the account number, yet for consistency this is always referred to as accountId. Accepts both IBAN & BBAN"},{"name":"customerId","in":"query","type":"string","required":false,"description":"Identifier of the customer"},{"name":"productId","in":"query","type":"string","required":false,"description":"Contains the unique identifier of the product, e.g. the product id of the arrangement account."},{"name":"currencyId","in":"query","type":"string","required":false,"description":"Identifier of the currency. This is the 3-letter ISO 4217 code of the currency."},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"NostroAccountsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"POST","path":"/holdings/accounts/nostroAccounts","fullPath":"/api/v4.13.0/holdings/accounts/nostroAccounts","operationId":"createNostroAccount","name":"Create nostro account with mandatory details such as customer, currency, account title, account officer, short title, reconcile account. A nostro account is the shadow or mirror account of the vostro account maintained by the correspondent bank. The nostro account is opened with the correspondent bank as the customer.","summary":"Create nostro account","tags":["OTHERS"],"parameters":[{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"otherOfficers":[{}],"postingRestrictIds":[{}],"alternateAccountTypes":[{}],"alternateAccountIds":[{}],"jointHolderIds":[{}],"jointRelationCodes":[{}],"additionalDetails":[{}],"customerId":"string","accountTitle":"string","accountTitle2":"string","shortTitle":"string","mnemonic":"string","positionType":"string","currencyId":"string","accountOfficer":"string"}},"responses":{"200":"NostroAccountResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"POST","path":"/holdings/accounts/internalAccounts/{accountId}","fullPath":"/api/v4.13.0/holdings/accounts/internalAccounts/{accountId}","operationId":"createInternalAccount","name":"Create bank internal account with mandatory details such as account title, short title, mnemonic, account officer. The internal accounts are created and maintained for bank's internal operations such as interbranch, intercompany transactions.","summary":"Create bank internal account","tags":["OTHERS"],"parameters":[{"name":"accountId","in":"path","type":"string","required":true,"description":"Identifier of the account. Often referred to as the account number, yet for consistency this is always referred to as accountId. Accepts both IBAN & BBAN"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"otherOfficers":[{}],"postingRestrictIds":[{}],"alternateAcctDetails":[{}],"categoryId":"string","accountTitle":"string","accountTitle2":"string","shortTitle":"string","mnemonic":"string","positionType":"string","accountOfficer":"string","highVolumeTransaction":"string","openingDate":"string","extensions":{}}},"responses":{"200":"InternalAccountResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/holdings/accounts/internalAccounts/{accountId}","fullPath":"/api/v4.13.0/holdings/accounts/internalAccounts/{accountId}","operationId":"updateInternalAccount","name":"Update bank internal account with details such as short title, account officer, account title, high volume transaction flag, alternate account id, posting restriction. The internal accounts are created and maintained for bank's internal operations such as interbranch, intercompany transactions.","summary":"Update bank internal account","tags":["OTHERS"],"parameters":[{"name":"accountId","in":"path","type":"string","required":true,"description":"Identifier of the account. Often referred to as the account number, yet for consistency this is always referred to as accountId. Accepts both IBAN & BBAN"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"otherOfficers":[{}],"postingRestrictIds":[{}],"alternateAcctDetails":[{}],"accountTitle":"string","accountTitle2":"string","shortTitle":"string","mnemonic":"string","accountOfficer":"string","highVolumeTransaction":"string","extensions":{}}},"responses":{"200":"InternalAccountResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/holdings/accounts/nostroAccounts/{accountId}","fullPath":"/api/v4.13.0/holdings/accounts/nostroAccounts/{accountId}","operationId":"updateNostroAccount","name":"Update nostro account with details such as reconciliation tolerance amount, our actual account number, short title, account officer, account title, high volume transaction flag, posting restriction. A nostro account is the shadow or mirror account of the vostro account maintained by the correspondent bank. The nostro account is opened with the correspondent bank as the customer.","summary":"Update Nostro account","tags":["OTHERS"],"parameters":[{"name":"accountId","in":"path","type":"string","required":true,"description":"Identifier of the account. Often referred to as the account number, yet for consistency this is always referred to as accountId. Accepts both IBAN & BBAN"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"otherOfficers":[{}],"postingRestrictIds":[{}],"alternateAccountTypes":[{}],"alternateAccountIds":[{}],"jointHolderIds":[{}],"jointRelationCodes":[{}],"additionalDetails":[{}],"accountTitle":"string","accountTitle2":"string","shortTitle":"string","mnemonic":"string","accountOfficer":"string","ownNostro":"string","reconciliationToleranceAmount":"string","highVolumeTransaction":"string"}},"responses":{"200":"NostroAccountResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/holdings/accounts/internalAccounts","fullPath":"/api/v4.13.0/holdings/accounts/internalAccounts","operationId":"getInternalAccounts","name":"Retrieves the currency, balance and category details of the internal account","summary":"Retrieves list of internal account details","tags":["OTHERS"],"parameters":[{"name":"accountId","in":"query","type":"string","required":false,"description":"Identifier of the account. Often referred to as the account number, yet for consistency this is always referred to as accountId. Accepts both IBAN & BBAN"},{"name":"productId","in":"query","type":"string","required":false,"description":"Contains the unique identifier of the product, e.g. the product id of the arrangement account."},{"name":"currencyId","in":"query","type":"string","required":false,"description":"Identifier of the currency. This is the 3-letter ISO 4217 code of the currency."},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"InternalAccountsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/accounts","fullPath":"/api/v4.13.0/holdings/accounts","operationId":"getAccounts","name":"Retrieves the currency, balances, limit details and arrangement details of the account","summary":"Retrieves list of account basic details","tags":["OTHERS"],"parameters":[{"name":"accountId","in":"query","type":"string","required":false,"description":"Identifier of the account. Often referred to as the account number, yet for consistency this is always referred to as accountId. Accepts both IBAN & BBAN"},{"name":"customerId","in":"query","type":"string","required":false,"description":"Identifier of the customer"},{"name":"productId","in":"query","type":"string","required":false,"description":"Contains the unique identifier of the product, e.g. the product id of the arrangement account."},{"name":"currencyId","in":"query","type":"string","required":false,"description":"Identifier of the currency. This is the 3-letter ISO 4217 code of the currency."},{"name":"currencyIdSAID","in":"query","type":"string","required":false,"description":"Indicates the criteria for the sounds like operation on the currency"},{"name":"limitReference","in":"query","type":"string","required":false,"description":"Identifies the credit limit reference for the underlying account."},{"name":"arrangementId","in":"query","type":"string","required":false,"description":"Indicates an unique identifier of an account"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"AccountsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/accounts/{companyAccountId}/balances","fullPath":"/api/v4.13.0/holdings/accounts/{companyAccountId}/balances","operationId":"getAccountBalanceTypes","name":"Retrieves the balance ,balance type for the account and company provided.","summary":"Retrieves the account funds and balance types.","tags":["RETAIL"],"parameters":[{"name":"companyAccountId","in":"path","type":"string","required":true,"description":"Indicates the company code and account id seperated by '-'.Example : US0010001-10995"},{"name":"virtualBalances","in":"query","type":"string","required":false,"description":"Contains the virtual balance of the collateral"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"AccountBalanceTypesResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}}]},{"key":"holdings-accounts-service-v4.14.0","title":"Account management","version":"v4.14.0","description":"API to manage account related services such as retrieving balances, transaction and card details, emergency blocks, funds diversion, reservations, proxy identifiers and account closures. In addition, it provides functionality to support the capability to switch accounts from the current system to an","endpointCount":72,"endpoints":[{"method":"PUT","path":"/holdings/accounts/{accountId}/products","fullPath":"/api/v4.14.0/holdings/accounts/{accountId}/products","operationId":"updateAccountProduct","name":"Change account from one product to another such as changing savings account to current account","summary":"Change of contract from one account product to another","tags":["RETAIL"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"accountId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"effectiveDate":"2024-01-01","productId":"string","extensions":{},"balance":[{}]}},"responses":{"200":"updateAccountProductResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"PUT","path":"/holdings/accounts/{accountId}/limits","fullPath":"/api/v4.14.0/holdings/accounts/{accountId}/limits","operationId":"updateAccountLimit","name":"Update the limit conditions of the account with the secondary limit amount and other limit details","summary":"Update the limit conditions of the account","tags":["RETAIL"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"accountId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"effectiveDate":"2024-01-01","productId":"string","extensions":{},"limit":[{}]}},"responses":{"200":"updateAccountLimitResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"PUT","path":"/holdings/accounts/{accountId}/interestConditions","fullPath":"/api/v4.14.0/holdings/accounts/{accountId}/interestConditions","operationId":"updateAccountInterestConditions","name":"Update the interest conditions of the account such as interest rate, tier details, margin amount etc.","summary":"Update the interest conditions of the account","tags":["RETAIL"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"accountId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"effectiveDate":"2024-01-01","channel":"string","extensions":{},"crinterest":[{}]}},"responses":{"200":"updateAccountInterestConditionsResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"PUT","path":"/holdings/accounts/{accountId}/dormancyStatus/{status}","fullPath":"/api/v4.14.0/holdings/accounts/{accountId}/dormancyStatus/{status}","operationId":"updateAccountDormancyStatus","name":"Deactivates the savings account and moves it to given dormancy status.","summary":"Deactivates the savings account to given status","tags":["RETAIL"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"accountId","in":"path","type":"string","required":true,"description":""},{"name":"status","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"effectiveDate":"2024-01-01","productId":"string","extensions":{}}},"responses":{"200":"updateAccountDormancyStatusResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"PUT","path":"/holdings/accounts/{accountId}/channels","fullPath":"/api/v4.14.0/holdings/accounts/{accountId}/channels","operationId":"updateAccountChannel","name":"Updates the channel of the account","summary":"Change of channel for the account","tags":["RETAIL"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"accountId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"effectiveDate":"2024-01-01","channel":"string","extensions":{}}},"responses":{"200":"updateAccountChannelResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"POST","path":"/holdings/accounts/migrations","fullPath":"/api/v4.14.0/holdings/accounts/migrations","operationId":"initiateAccountMigration","name":"Migration of a legacy system account contract to the given account product by providing the original contract date, account name, statement, payment frequency and start date, etc. ","summary":"Migration of legacy system account contract to the given account product","tags":["RETAIL"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"partyIds":[{}],"originationReference":[{}],"effectiveDate":"2024-01-01","productId":"string","currency":"string","branch":"string","channel":"string","lineOfBusiness":"string","originalContractDate":"2024-01-01","extensions":{},"limit":[{}],"balance":[{}],"customer":[{}],"crinterest":[{}],"schedule":[{}]}},"responses":{"200":"initiateAccountMigrationResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"PUT","path":"/holdings/accounts/{accountId}/migrations/balances","fullPath":"/api/v4.14.0/holdings/accounts/{accountId}/migrations/balances","operationId":"updateAccountBalanceMigration","name":"Captures the balance details of the account such as balance type, due amount etc. This is used to migrate the balances of a legacy contract which is migrated from other system & update the balance details","summary":"Captures outstanding balance details of a contract migrated from legacy system","tags":["RETAIL"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"accountId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"productId":"string","effectiveDate":"2024-01-01","extensions":{},"balanceMaintenance":[{}]}},"responses":{"200":"updateAccountBalanceMigrationResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"PUT","path":"/holdings/accounts/{accountId}/renegotiations","fullPath":"/api/v4.14.0/holdings/accounts/{accountId}/renegotiations","operationId":"updateAccountConditions","name":"Perform the renegotiation of the account contract details such as payment frequency, payment start date, interest rate, statement frequency and settlement details, etc.","summary":"Renegotiation of the account contract details","tags":["RETAIL"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"accountId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"effectiveDate":"2024-01-01","productId":"string","extensions":{},"limit":[{}],"balance":[{}],"customer":[{}],"crinterest":[{}],"schedule":[{}],"settlement":[{}],"statement":[{}]}},"responses":{"200":"updateAccountConditionsResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"PUT","path":"/holdings/accounts/{accountId}/dormancyStatus/reactivations","fullPath":"/api/v4.14.0/holdings/accounts/{accountId}/dormancyStatus/reactivations","operationId":"updateAccountDormancyReactivation","name":"Reset the dormant account to active status manually","summary":"Reset the account dormancy status","tags":["RETAIL"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"accountId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"effectiveDate":"2024-01-01","productId":"string","extensions":{}}},"responses":{"200":"updateAccountDormancyReactivationResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"PUT","path":"/holdings/accounts/{accountId}/withdrawalNotices","fullPath":"/api/v4.14.0/holdings/accounts/{accountId}/withdrawalNotices","operationId":"createAccountWithdrawalNotice","name":"Notifies the withdrawal of amount from account by providing the withdrawal date and amount etc. This is applicable only for notice type of accounts.","summary":"Notifies the withdrawal amount from account","tags":["RETAIL"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"accountId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"effectiveDate":"2024-01-01","productId":"string","extensions":{},"noticeWithdrawal":[{}]}},"responses":{"200":"createAccountWithdrawalNoticeResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"PUT","path":"/holdings/accounts/{accountId}/customers","fullPath":"/api/v4.14.0/holdings/accounts/{accountId}/customers","operationId":"updateAccountCustomer","name":"Update the customer details of the account such as add or remove the joint customers, tax liability percentange, limit liability percentage of the joint customers","summary":"Update customers for the given account","tags":["RETAIL"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"accountId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"partyIds":[{}],"effectiveDate":"2024-01-01","extensions":{},"customer":[{}]}},"responses":{"200":"updateAccountCustomerResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"PUT","path":"/holdings/accounts/{accountId}/credits","fullPath":"/api/v4.14.0/holdings/accounts/{accountId}/credits","operationId":"updateAccountCredit","name":"Perform credit transactions in an account, providing the credit amount and the currency in which to be credited","summary":"Perform credit transaction in an account.","tags":["RETAIL"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"accountId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"currencyId":"string","effectiveDate":"2024-01-01","activityId":"string","transactionAmount":0.0,"contractId":"string","systemId":"string","externalEventStatus":"string","extensions":{}}},"responses":{"200":"updateAccountCreditResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"PUT","path":"/holdings/accounts/{accountId}/debits","fullPath":"/api/v4.14.0/holdings/accounts/{accountId}/debits","operationId":"updateAccountDebit","name":"Perform debit transactions in an account by providing debit amount and currency in which to be debited","summary":"Perform debit transactions in an account","tags":["RETAIL"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"accountId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"currencyId":"string","effectiveDate":"2024-01-01","activityId":"string","transactionAmount":0.0,"contractId":"string","systemId":"string","externalEventStatus":"string","extensions":{}}},"responses":{"200":"updateAccountDebitResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"PUT","path":"/holdings/accounts/{accountId}/adjustments","fullPath":"/api/v4.14.0/holdings/accounts/{accountId}/adjustments","operationId":"updateAccountAdjustment","name":"Performs backdated adjustment and re-accrual for the given savings account.  This is used when interest adjustment is required due to backdated rate change or transaction.","summary":"Performs backdated adjustment and re-accrual for the given savings account ","tags":["RETAIL"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"accountId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"currencyId":"string","effectiveDate":"2024-01-01","activityId":"string","transactionAmount":0.0,"contractId":"string","systemId":"string","externalEventStatus":"string","extensions":{}}},"responses":{"200":"updateAccountAdjustmentResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"PUT","path":"/holdings/accounts/{accountId}/lineofBusiness","fullPath":"/api/v4.14.0/holdings/accounts/{accountId}/lineofBusiness","operationId":"updateAccountLob","name":"Updates the type of line of business of the account","summary":"Change of line of business for the account","tags":["RETAIL"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"accountId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"effectiveDate":"2024-01-01","lineOfBusiness":"string","extensions":{}}},"responses":{"200":"updateAccountLobResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"GET","path":"/holdings/accounts/{accountId}/dormancyConditions","fullPath":"/api/v4.14.0/holdings/accounts/{accountId}/dormancyConditions","operationId":"getAccountDormancyDetails","name":"Retrieves the dormancy setup details for the account such as dormancy period, status etc","summary":"Retrieves the account dormancy conditions","tags":["RETAIL"],"parameters":[{"name":"accountId","in":"path","type":"string","required":true,"description":"Identifier of the account. Often referred to as the account number, yet for consistency this is always referred to as accountId. Accepts both IBAN & BBAN"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"AccountDormancyDetailsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/accounts/{accountId}/transactions","fullPath":"/api/v4.14.0/holdings/accounts/{accountId}/transactions","operationId":"getAccountTransactions","name":"Retrieves account transaction details such as transaction type, amount, transaction reference, credit or debit indicator, booking and effective date of transaction","summary":"Retrieves account transaction details","tags":["RETAIL"],"parameters":[{"name":"accountId","in":"path","type":"string","required":true,"description":"Identifier of the account. Often referred to as the account number, yet for consistency this is always referred to as accountId. Accepts both IBAN & BBAN"},{"name":"fromDate","in":"query","type":"string","required":false,"description":"Indicates the business date from when the balance reservation event is active."},{"name":"toDate","in":"query","type":"string","required":false,"description":"Indicates the business date until when the balance reservation event is active."},{"name":"transactionReference","in":"query","type":"string","required":false,"description":"Contains the identifier for the transaction in the core system"},{"name":"period","in":"query","type":"string","required":false,"description":"Indicates spread of time buckets.Ex: 3M,6M,9M,10Y etc."},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"AccountTransactionsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/accounts/accountsDetails","fullPath":"/api/v4.14.0/holdings/accounts/accountsDetails","operationId":"getAccountInfo","name":"Retrieves the currency, balances, limit details and arrangement details of the account","summary":"Retrieves list of account basic details","tags":["RETAIL"],"parameters":[{"name":"customer","in":"query","type":"string","required":false,"description":"Contains the customer identifier to fetch list of consent arrangements for the customer or customer identifier of the debtor account. This will be populated once the SCA(Strong Customer Authentication"},{"name":"arrangementId","in":"query","type":"string","required":false,"description":"Indicates an unique identifier of an account"},{"name":"currency","in":"query","type":"string","required":false,"description":"Identifies the currency. E.g. USD, GBP etc"},{"name":"companyCode","in":"query","type":"string","required":false,"description":"The identifier of the underlying Entity/Company/Branch."},{"name":"productId","in":"query","type":"string","required":false,"description":"Contains the unique identifier of the product, e.g. the product id of the arrangement account."},{"name":"status","in":"query","type":"string","required":false,"description":"Contains status of the data rights request.Allowed values are INITIATED, INPROGESS, EXTENDED, COMPLETED, REJECTED."},{"name":"accountId","in":"query","type":"string","required":false,"description":"Identifier of the account. Often referred to as the account number, yet for consistency this is always referred to as accountId. Accepts both IBAN & BBAN"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"AccountInfoResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/accounts/{accountId}/statements","fullPath":"/api/v4.14.0/holdings/accounts/{accountId}/statements","operationId":"getAccountStatementDetails","name":"Retrieves the statement frequency of an account","summary":"Retrieves the statement frequency of an account","tags":["RETAIL"],"parameters":[{"name":"accountId","in":"path","type":"string","required":true,"description":"Identifier of the account. Often referred to as the account number, yet for consistency this is always referred to as accountId. Accepts both IBAN & BBAN"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"AccountStatementDetailsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"PUT","path":"/holdings/accounts/{accountId}/statements","fullPath":"/api/v4.14.0/holdings/accounts/{accountId}/statements","operationId":"updateAccountStatement","name":"Update the statement frequency of an account.","summary":"Update the statement frequency of an account","tags":["RETAIL"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"productId":"string","effectiveDate":"2024-01-01","extensions":{},"statement":[{}]}},"responses":{"200":"updateAccountStatementResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"PUT","path":"/holdings/accounts/{accountId}/migrations/bills","fullPath":"/api/v4.14.0/holdings/accounts/{accountId}/migrations/bills","operationId":"updateAccountBillMigration","name":"Captures the bill information of the account such as bill id, property names, bill amount etc. This is used to migrate the bills of a legacy contract which is migrated from other system & update the bill details","summary":"Captures the bill information of the account such as bill id, property names, bill amount etc. This is used to migrate the bills of a legacy contract which is migrated from other system & update the bill details","tags":["RETAIL"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"accountId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"productId":"string","effectiveDate":"2024-01-01","extensions":{},"balanceMaintenance":[{}]}},"responses":{"200":"updateAccountBillMigrationResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"PUT","path":"/holdings/accounts/{accountId}/branches","fullPath":"/api/v4.14.0/holdings/accounts/{accountId}/branches","operationId":"updateAccountBranch","name":"Updates the branch of an account","summary":"Updates the branch of an account","tags":["RETAIL"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"accountId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"effectiveDate":"2024-01-01","branch":"string","extensions":{}}},"responses":{"200":"updateAccountBranchResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"PUT","path":"/holdings/accounts/{accountId}/settlements","fullPath":"/api/v4.14.0/holdings/accounts/{accountId}/settlements","operationId":"updateAccountSettlement","name":"Update the settlement conditions of the account such as payin account, payin percentage, payin amount, payout account, payout percentage, payout amount, etc","summary":"Update the settlement conditions of the account such as payin account, payin percentage, payin amount, payout account, payout percentage, payout amount, etc","tags":["RETAIL"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"accountId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"productId":"string","effectiveDate":"2024-01-01","extensions":{},"settlement":[{}]}},"responses":{"200":"updateAccountSettlementResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"PUT","path":"/holdings/accounts/{accountId}/accounts","fullPath":"/api/v4.14.0/holdings/accounts/{accountId}/accounts","operationId":"updateAccount","name":"Update the account details to block or unblock the account by setting the posting restriction and to change the nick name of the account","summary":"Update the account's details","tags":["RETAIL"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"accountId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"productId":"string","effectiveDate":"2024-01-01","extensions":{},"balance":[{}]}},"responses":{"200":"updateAccountResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"PUT","path":"/holdings/accounts/{accountId}/schedules","fullPath":"/api/v4.14.0/holdings/accounts/{accountId}/schedules","operationId":"updateAccountSchedule","name":"Update the payment schedule condition such as payment method from capitalise to pay, payment frequency from monthly to quarterly etc., on an account","summary":"Update payment schedule for the given account","tags":["RETAIL"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"accountId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"productId":"string","effectiveDate":"2024-01-01","extensions":{},"schedule":[{}]}},"responses":{"200":"updateAccountScheduleResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"GET","path":"/holdings/accounts/accountClosures/{accountId}","fullPath":"/api/v4.14.0/holdings/accounts/accountClosures/{accountId}","operationId":"getAccountClosure","name":"Retrieves the account closure information of the account such as closure date and reason, mode of closure, balances on the date of closing and pending charges","summary":"Retrieves the account closure information","tags":["OTHERS"],"parameters":[{"name":"accountId","in":"path","type":"string","required":true,"description":"Identifier of the account. Often referred to as the account number, yet for consistency this is always referred to as accountId. Accepts both IBAN & BBAN"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"AccountClosureResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/holdings/accounts/accountClosures/{accountId}","fullPath":"/api/v4.14.0/holdings/accounts/accountClosures/{accountId}","operationId":"updateAccountClosure","name":"Updates account closure information for the specific account such as closure date and reason, mode of closure and closing charges","summary":"Updates account closure information","tags":["OTHERS"],"parameters":[{"name":"accountId","in":"path","type":"string","required":true,"description":"Identifier of the account. Often referred to as the account number, yet for consistency this is always referred to as accountId. Accepts both IBAN & BBAN"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"accountCurrency":"string","closureDate":"2024-01-01T00:00:00Z","creditAccount":"string","capitaliseInterest":"string","chargeType":"string","chargeAmount":0.0,"closeMode":"string","ftId":"string","closureReason":"string","closureNotes":"string","onlineLedgerBalance":0.0,"onlineClearedBalance":0.0,"balancePayable":0.0,"totalCreditInterest":"string","totalDebitInterest":"string"}},"responses":{"200":"AccountClosureResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/holdings/accounts/{accountId}/cards","fullPath":"/api/v4.14.0/holdings/accounts/{accountId}/cards","operationId":"getAccountCards","name":"Retrieves the card details of the account such as card number, card type and status of the card","summary":"Retrieves available card details","tags":["OTHERS"],"parameters":[{"name":"accountId","in":"path","type":"string","required":true,"description":"Identifier of the account. Often referred to as the account number, yet for consistency this is always referred to as accountId. Accepts both IBAN & BBAN"},{"name":"cardIssueId","in":"query","type":"string","required":false,"description":"The identifier of the issued card formatted as cardType '.' cardNumber. E.g. VISA.1234567887654321 GC.1111222233334444 AB21.1111111122222222"},{"name":"issueDate","in":"query","type":"string","required":false,"description":"The date the item was issued."},{"name":"expiryDate","in":"query","type":"string","required":false,"description":"This indicates the  date  on which the offer or privilege terminates for the event."},{"name":"cardStatus","in":"query","type":"string","required":false,"description":"Current status of the Card and following are the possible statuses are  - CARD.ISSUED - CARD.RETURNED - CARD.SCRAP - CARD.CANCEL - NOT.ACTIVATED - NOT.RECEIVED - ACTIVE - BLOCKED - EXPIRED"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"AccountCardsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/accounts/balances","fullPath":"/api/v4.14.0/holdings/accounts/balances","operationId":"getAccountBalanceToday","name":"Retrieves various types of balances such as cleared, online, locked and usable balance of the account","summary":"Retrieves list of account balances","tags":["OTHERS"],"parameters":[{"name":"accountId","in":"query","type":"string","required":false,"description":"Identifier of the account. Often referred to as the account number, yet for consistency this is always referred to as accountId. Accepts both IBAN & BBAN"},{"name":"customerId","in":"query","type":"string","required":false,"description":"Identifier of the customer"},{"name":"productId","in":"query","type":"string","required":false,"description":"Contains the unique identifier of the product, e.g. the product id of the arrangement account."},{"name":"currencyId","in":"query","type":"string","required":false,"description":"Identifier of the currency. This is the 3-letter ISO 4217 code of the currency."},{"name":"limitReferenceId","in":"query","type":"string","required":false,"description":"Limit reference identifier for the limit order."},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"AccountBalanceTodayResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/accounts/{accountId}/balanceMovements/{bookingDate}","fullPath":"/api/v4.14.0/holdings/accounts/{accountId}/balanceMovements/{bookingDate}","operationId":"getAccountBalanceMovement","name":"Retrieves the credit, debit and gross balance movements for an account for the requested booking date","summary":"Retrieves balances movements of account","tags":["OTHERS"],"parameters":[{"name":"accountId","in":"path","type":"string","required":true,"description":"Identifier of the account. Often referred to as the account number, yet for consistency this is always referred to as accountId. Accepts both IBAN & BBAN"},{"name":"bookingDate","in":"path","type":"string","required":true,"description":"Business date on which the accounting entry was generated."},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"AccountBalanceMovementResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/accounts/{accountId}/emergencyBlocks/status","fullPath":"/api/v4.14.0/holdings/accounts/{accountId}/emergencyBlocks/status","operationId":"getAccountEmergencyBlock","name":"Retrieve emergency block status and reason for a given account. This information will be used to assert the actual block status of an account in microservice","summary":"Retrieve emergency block information for an account","tags":["OTHERS"],"parameters":[{"name":"accountId","in":"path","type":"string","required":true,"description":"Identifier of the account. Often referred to as the account number, yet for consistency this is always referred to as accountId. Accepts both IBAN & BBAN"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"AccountEmergencyBlockResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"PUT","path":"/holdings/accounts/{accountId}/emergencyBlocks/status","fullPath":"/api/v4.14.0/holdings/accounts/{accountId}/emergencyBlocks/status","operationId":"updateAccountEmergencyBlock","name":"Updates emergency block status and reason for block of the account","summary":"Update emergency block in account","tags":["OTHERS"],"parameters":[{"name":"accountId","in":"path","type":"string","required":true,"description":""},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"emergencyBlock":"string","emergencyReason":"string","extensions":{}}},"responses":{"200":"AccountEmergencyBlockResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/holdings/accounts/{accountId}/fundsAuthorisations/status","fullPath":"/api/v4.14.0/holdings/accounts/{accountId}/fundsAuthorisations/status","operationId":"getAccountFundsAuthStatus","name":"Retrieve the funds authorisation status of the account","summary":"Retrieve account funds authorisation status","tags":["OTHERS"],"parameters":[{"name":"accountId","in":"path","type":"string","required":true,"description":"Identifier of the account. Often referred to as the account number, yet for consistency this is always referred to as accountId. Accepts both IBAN & BBAN"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"AccountFundsAuthStatusResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"PUT","path":"/holdings/accounts/{accountId}/fundsAuthorisations/status","fullPath":"/api/v4.14.0/holdings/accounts/{accountId}/fundsAuthorisations/status","operationId":"updateAccountFundsAuthStatus","name":"Update the funds authorisation status for the account, for example SYNC or ERROR","summary":"Update account funds authorisation status","tags":["OTHERS"],"parameters":[{"name":"accountId","in":"path","type":"string","required":true,"description":""},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"faStatus":"string","extensions":{}}},"responses":{"200":"AccountFundsAuthStatusResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"POST","path":"/holdings/accounts/settings/{settingId}/fundsDiversion","fullPath":"/api/v4.14.0/holdings/accounts/settings/{settingId}/fundsDiversion","operationId":"createFundsDiversion","name":"Allows creation of funds diversion conditions for a company to manage the behavior of booking funds against any account in the company that has the auto pay account defined","summary":"Creates conditions for funds diversion","tags":["OTHERS"],"parameters":[{"name":"settingId","in":"path","type":"string","required":true,"description":"Contains the particular parameter record setting identifier."},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"transactionCodes":[{}],"defaultFundsDiversion":"string","extensions":{}}},"responses":{"200":"FundsDiversionResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/holdings/accounts/settings/{settingId}/fundsDiversion","fullPath":"/api/v4.14.0/holdings/accounts/settings/{settingId}/fundsDiversion","operationId":"updateFundsDiversion","name":"Updates the funds diversion conditions for a company to manage the behavior of booking funds against any account in the company that has the auto pay account defined","summary":"Updates funds diversion parameter","tags":["OTHERS"],"parameters":[{"name":"settingId","in":"path","type":"string","required":true,"description":"Contains the particular parameter record setting identifier."},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"transactionCodes":[{}],"defaultFundsDiversion":"string","extensions":{}}},"responses":{"200":"FundsDiversionResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/holdings/nostros/forwardBalances","fullPath":"/api/v4.14.0/holdings/nostros/forwardBalances","operationId":"getNostroForwardBalances","name":"Retrieves forward balances of nostro accounts considering the transaction effective dates.","summary":"Retrieves consolidated nostro account balances","tags":["OTHERS"],"parameters":[{"name":"valueDate","in":"query","type":"string","required":false,"description":"Indicates the value date on which the underlying accounting entry is to be given value (for interest purposes)"},{"name":"accountId","in":"query","type":"string","required":true,"description":"Identifier of the account. Often referred to as the account number, yet for consistency this is always referred to as accountId. Accepts both IBAN & BBAN"},{"name":"longPositionSign","in":"query","type":"string","required":false,"description":"Polarity (sign) used to denote buy position balance.  "},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"NostroForwardBalancesResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/nostros/currencyBalances/{currencyId}/accounts","fullPath":"/api/v4.14.0/holdings/nostros/currencyBalances/{currencyId}/accounts","operationId":"getNostroBalances","name":"Retrieves the date wise balances of the nostro accounts that falls under a specific currency","summary":"Retrieves nostro account balances for a specific currency","tags":["OTHERS"],"parameters":[{"name":"currencyId","in":"path","type":"string","required":true,"description":"Identifier of the currency. This is the 3-letter ISO 4217 code of the currency."},{"name":"nostroId","in":"query","type":"string","required":false,"description":"Nostro account id"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"NostroBalancesResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/nostros/currencyBalances/{currencyId}","fullPath":"/api/v4.14.0/holdings/nostros/currencyBalances/{currencyId}","operationId":"getNostroCurrencyPositions","name":"Retrieves consolidated balances of the nostro accounts in a given currency from the current date to the next five days.","summary":"Retrieves consolidated nostro account balances for a specific currency","tags":["OTHERS"],"parameters":[{"name":"currencyId","in":"path","type":"string","required":true,"description":"Identifier of the currency. This is the 3-letter ISO 4217 code of the currency."},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"NostroCurrencyPositionsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/accounts/{accountId}","fullPath":"/api/v4.14.0/holdings/accounts/{accountId}","operationId":"getAccountDetails","name":"Retrieves the arrangement account details such as account balances, allowed, advised and outstanding limit balances, interest types and values with the corresponding mode, frequency and value of payments","summary":"Retrieves arrangement account details","tags":["OTHERS"],"parameters":[{"name":"accountId","in":"path","type":"string","required":true,"description":"Identifier of the account. Often referred to as the account number, yet for consistency this is always referred to as accountId. Accepts both IBAN & BBAN"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"AccountDetailsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"POST","path":"/holdings/accounts/{accountId}","fullPath":"/api/v4.14.0/holdings/accounts/{accountId}","operationId":"createCustomerAccount","name":"Create a customer account with mandatory details such as account title, short title, mnemonic, account officer.","summary":"Create account for registered customer","tags":["OTHERS"],"parameters":[{"name":"accountId","in":"path","type":"string","required":true,"description":"Identifier of the account. Often referred to as the account number, yet for consistency this is always referred to as accountId. Accepts both IBAN & BBAN"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"customerId":"string","currency":"string","mnemonic":"string","accountName":"string","category":"string","customerName":"string","openingDate":"string","extensions":{}}},"responses":{"200":"CustomerAccountResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/holdings/accounts/proxyIdentifiers","fullPath":"/api/v4.14.0/holdings/accounts/proxyIdentifiers","operationId":"getActiveProxyIdentifier","name":"Retrieve proxy registration status from proxy directory for a given customer number or account number or proxy type and proxy identifier","summary":"Retrieve proxy registration status","tags":["OTHERS"],"parameters":[{"name":"customerId","in":"query","type":"string","required":false,"description":"Identifier of the customer"},{"name":"alternateAccountId","in":"query","type":"string","required":false,"description":"Contains the Uniform Banking Code of the arrangement"},{"name":"proxyType","in":"query","type":"string","required":false,"description":"Type of proxy created for account"},{"name":"proxyIdentifier","in":"query","type":"string","required":false,"description":"A proxy identifier to be linked to an account based on the proxy type provided eg. Mobile number, email id and tax id"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"ActiveProxyIdentifierResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"POST","path":"/holdings/accounts/proxyIdentifiers","fullPath":"/api/v4.14.0/holdings/accounts/proxyIdentifiers","operationId":"createProxyIdentifier","name":"Register the proxy identifier with details of proxy type and scheme for a customer and account","summary":"Register the proxy identifier for the account","tags":["OTHERS"],"parameters":[{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"customerId":"string","accountId":"string","alternateAccountId":"string","proxyType":"string","proxyIdentifier":"string","proxyStatus":"string","proxyScheme":"string","proxyRole":"string","extensions":{}}},"responses":{"200":"ProxyIdentifierResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/holdings/accounts/proxyIdentifiers/{proxyIdentifierId}","fullPath":"/api/v4.14.0/holdings/accounts/proxyIdentifiers/{proxyIdentifierId}","operationId":"updateProxyIdentifier","name":"Update the specific proxy identifier to de-register the registered account or customer from the proxy directory","summary":"Update proxy directory for account to de-register the proxy identifier","tags":["OTHERS"],"parameters":[{"name":"proxyIdentifierId","in":"path","type":"string","required":true,"description":""},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"customerId":"string","accountId":"string","alternateAccountId":"string","proxyType":"string","proxyIdentifier":"string","proxyStatus":"string","proxyScheme":"string","proxyRole":"string","extensions":{}}},"responses":{"200":"ProxyIdentifierResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/holdings/accounts/{accountId}/{accountCompany}/{paymentCurrency}/{accountSwitch}/{beneficialCustomer}/payments","fullPath":"/api/v4.14.0/holdings/accounts/{accountId}/{accountCompany}/{paymentCurrency}/{accountSwitch}/{beneficialCustomer}/payments","operationId":"getAccountPaymentDetails","name":"Retrieves the account information that are required for processing or validating an account involved in a payment transaction. Provides the information such as account name, customer number, account type, account currency, IBAN, account switch details, account status (ACTIVE or INACTIVE) and account closure details.","summary":"Retrieves account details required for payment processing","tags":["OTHERS"],"parameters":[{"name":"accountId","in":"path","type":"string","required":true,"description":"Identifier of the account. Often referred to as the account number, yet for consistency this is always referred to as accountId. Accepts both IBAN & BBAN"},{"name":"accountCompany","in":"path","type":"string","required":true,"description":"Company of the account to be created"},{"name":"paymentCurrency","in":"path","type":"string","required":true,"description":"This field holds the transaction currency or currency in which payment is initiated. "},{"name":"accountSwitch","in":"path","type":"string","required":true,"description":"Indicates if availability of account switch details should be checked."},{"name":"beneficialCustomer","in":"path","type":"string","required":true,"description":"Indicates if beneficial owners of the account are to be retrieved"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"AccountPaymentDetailsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/accounts/{contractBalanceId}/contractBalances","fullPath":"/api/v4.14.0/holdings/accounts/{contractBalanceId}/contractBalances","operationId":"getContractBalances","name":"Retrieves the contract balances of accounts or contracts with details such as contract currency, balance types, credit and debit movements and opening and closing balance of the respective balance types","summary":"Retrieves contract balances of accounts","tags":["OTHERS"],"parameters":[{"name":"contractBalanceId","in":"path","type":"string","required":true,"description":"Unique Identifier of Contract Balances"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"ContractBalancesResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"PUT","path":"/holdings/accounts/{accountId}/synchronizationErrors","fullPath":"/api/v4.14.0/holdings/accounts/{accountId}/synchronizationErrors","operationId":"updateSynchronizationError","name":"Updates error status during synchronization of the account between Transact and Funds authorization microservice.","summary":"Update synchronization error status","tags":["OTHERS"],"parameters":[{"name":"accountId","in":"path","type":"string","required":true,"description":"Identifier of the account. Often referred to as the account number, yet for consistency this is always referred to as accountId. Accepts both IBAN & BBAN"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"emergencyBlockError":"string","extensions":{}}},"responses":{"200":"SynchronizationErrorResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/holdings/accounts/{accountId}/accountSwitches/expiringSwitches","fullPath":"/api/v4.14.0/holdings/accounts/{accountId}/accountSwitches/expiringSwitches","operationId":"getExpiringAccountSwitches","name":"Retrieves the details of the expiring account switches for generating alerts such as the bank identifier code, alert date and account id of expiring switch instruction etc.","summary":"Retrieves the details of the expiring switches for generating alerts","tags":["OTHERS"],"parameters":[{"name":"accountId","in":"path","type":"string","required":true,"description":"Identifier of the account. Often referred to as the account number, yet for consistency this is always referred to as accountId. Accepts both IBAN & BBAN"},{"name":"alertStatus","in":"query","type":"string","required":false,"description":"Contains status of the Alert to be raised for switching instruction. Possible values are Pending, Sent."},{"name":"alertDate","in":"query","type":"string","required":false,"description":"Indicates the date in which an alert to be raised for a switching instruction."},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"ExpiringAccountSwitchesResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/accounts/{accountId}/accountSwitches","fullPath":"/api/v4.14.0/holdings/accounts/{accountId}/accountSwitches","operationId":"getAccountSwitchDetails","name":"Retrieves details from the account switch directory for the specific account such as the expiry date, status of the switch instruction, effective date of the switch, bank identifier code and IBAN (International Bank Account Number ) etc.","summary":"Retrieves details of the account switch requests","tags":["OTHERS"],"parameters":[{"name":"accountId","in":"path","type":"string","required":true,"description":"Identifier of the account. Often referred to as the account number, yet for consistency this is always referred to as accountId. Accepts both IBAN & BBAN"},{"name":"requestDate","in":"query","type":"string","required":false,"description":"Date on which the client's request to be classified as professional has been received."},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"AccountSwitchDetailsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"PUT","path":"/holdings/accounts/{accountId}/accountSwitches","fullPath":"/api/v4.14.0/holdings/accounts/{accountId}/accountSwitches","operationId":"updateAccountSwitchDetails","name":"Updates alert status based on the original IBAN. Used by external systems handling alert generation to mark the status from pending to sent","summary":"Updates alert status from pending to be sent for corresponding switch instructions.","tags":["OTHERS"],"parameters":[{"name":"accountId","in":"path","type":"string","required":true,"description":"Identifier of the account. Often referred to as the account number, yet for consistency this is always referred to as accountId. Accepts both IBAN & BBAN"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"accountId":"string","switchIBAN":"string","switchAccountId":"string","switchBic":"string","switchClearingCode":"string","requestDate":"string","status":"string","cancelInstruction":"string","cancelDate":"string","expiryDate":"string","IBAN":"string","bicId":"string","effectiveDate":"string","alertDate":"string","alertStatus":"string"}},"responses":{"200":"AccountSwitchDetailsResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/holdings/accounts/{accountId}/accountSwitches/payments","fullPath":"/api/v4.14.0/holdings/accounts/{accountId}/accountSwitches/payments","operationId":"getAccountSwitchPaymentDetails","name":"Retrieves information of the rerouted payments from the payment transaction exit point.","summary":"Retrieves rerouted payment information.","tags":["OTHERS"],"parameters":[{"name":"accountId","in":"path","type":"string","required":true,"description":"Identifier of the account. Often referred to as the account number, yet for consistency this is always referred to as accountId. Accepts both IBAN & BBAN"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"AccountSwitchPaymentDetailsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"PUT","path":"/holdings/accounts/accountClosures/{accountId}/approvals","fullPath":"/api/v4.14.0/holdings/accounts/accountClosures/{accountId}/approvals","operationId":"approveAccountClosure","name":"Approves account closure information to allow closing of an account which is no longer in use","summary":"Approves account closure information","tags":["OTHERS"],"parameters":[{"name":"accountId","in":"path","type":"string","required":true,"description":"Identifier of the account. Often referred to as the account number, yet for consistency this is always referred to as accountId. Accepts both IBAN & BBAN"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"AccountClosureResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/holdings/accounts/reservedFunds","fullPath":"/api/v4.14.0/holdings/accounts/reservedFunds","operationId":"getReservedFunds","name":"Retrieves the reserved funds details such as reason, amount and period of reservation of the account","summary":"Retrieves the list of reserved funds ","tags":["OTHERS"],"parameters":[{"name":"accountId","in":"query","type":"string","required":false,"description":"Identifier of the account. Often referred to as the account number, yet for consistency this is always referred to as accountId. Accepts both IBAN & BBAN"},{"name":"lockedEventReference","in":"query","type":"string","required":false,"description":"Captures the AC.LOCKED.EVENTS id if in case the funds is available and reserved."},{"name":"lockReason","in":"query","type":"string","required":false,"description":"Indicates the simple description for the balance reservation event."},{"name":"fromDate","in":"query","type":"string","required":false,"description":"Indicates the business date from when the balance reservation event is active."},{"name":"toDate","in":"query","type":"string","required":false,"description":"Indicates the business date until when the balance reservation event is active."},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"ReservedFundsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"POST","path":"/holdings/accounts/reservedFunds","fullPath":"/api/v4.14.0/holdings/accounts/reservedFunds","operationId":"createFundsReservation","name":"Creates a funds reservation with details such as account number, block or reserve amount, period of hold transaction, reason for holding. Funds reservations are created to block or reserve funds which restricts any debit movements affecting the account balance below the blocked amount for the specified period on an account.","summary":"Creates a credit or debit funds reservation to block the funds in an account","tags":["OTHERS"],"parameters":[{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"accountId":"string","lockReason":"string","fromDate":"2024-01-01","toDate":"2024-01-01","lockedAmount":"string","transactionReference":"string","transactionRetry":"string","systemId":"string","additionalDetail":"string","alternateKey":"string","reservationTypeId":"string","accountLink":"string","action":"string","creditDebitIndicator":"string","reservationIndicator":"string"}},"responses":{"200":"FundsReservationResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/holdings/accounts/reservedFunds/{lockedEventReference}","fullPath":"/api/v4.14.0/holdings/accounts/reservedFunds/{lockedEventReference}","operationId":"updateFundsReservation","name":"Update funds reservation with details such as account number, block or reserve amount, period of hold transaction, reason for holding. Funds reservations are created to block or reserve funds which restricts any debit movements affecting the account balance below the blocked amount for the specified period on an account.","summary":"Update the credit or debit funds reservation to block the funds in an account","tags":["OTHERS"],"parameters":[{"name":"lockedEventReference","in":"path","type":"string","required":true,"description":"Captures the AC.LOCKED.EVENTS id if in case the funds is available and reserved."},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"accountId":"string","lockReason":"string","fromDate":"2024-01-01","toDate":"2024-01-01","lockedAmount":"string","transactionReference":"string","transactionRetry":"string","systemId":"string","additionalDetail":"string","alternateKey":"string","reservationTypeId":"string","accountLink":"string","action":"string","creditDebitIndicator":"string","reservationIndicator":"string"}},"responses":{"200":"FundsReservationResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"DELETE","path":"/holdings/accounts/reservedFunds/{lockedEventReference}","fullPath":"/api/v4.14.0/holdings/accounts/reservedFunds/{lockedEventReference}","operationId":"cancelFundsReservation","name":"Cancels the funds reservation of an account. Funds reservations are created to block or reserve funds which restricts any debit movements affecting the account balance below the blocked amount for the specified period on an account. On removal of the funds reservations, the blocked or reserved amount is now available for usage.","summary":"Cancels the credit or debit funds reservation to unblock the funds in an account","tags":["OTHERS"],"parameters":[{"name":"lockedEventReference","in":"path","type":"string","required":true,"description":"Captures the AC.LOCKED.EVENTS id if in case the funds is available and reserved."},{"name":"payload","in":"body","type":"object","required":false,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}}},"responses":{"200":"FundsReservationResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/holdings/nostros/positions/{currencyId}","fullPath":"/api/v4.14.0/holdings/nostros/positions/{currencyId}","operationId":"getNostroPositions","name":"Retrieves nostro account balances for a given currency from the current date to the next five days.","summary":"Retrieves consolidated nostro account positions for the currency","tags":["OTHERS"],"parameters":[{"name":"currencyId","in":"path","type":"string","required":true,"description":"Identifier of the currency. This is the 3-letter ISO 4217 code of the currency."},{"name":"longPositionSign","in":"query","type":"string","required":false,"description":"Polarity (sign) used to denote buy position balance.  "},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"NostroPositionsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/accounts/{accountId}/transactionRetries/cancellations","fullPath":"/api/v4.14.0/holdings/accounts/{accountId}/transactionRetries/cancellations","operationId":"getTransactionRetryCancellations","name":"Retrieves the cancellation request applied on a single transaction retry or multiple transaction retries pertaining to an account with information such as transaction retry id, transaction retry change type and transaction retry change value.","summary":"Retrieves the cancellation request applied on a single transaction retry or multiple transaction retries pertaining to an account.","tags":["OTHERS"],"parameters":[{"name":"accountId","in":"path","type":"string","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"TransactionRetryCancellationsResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"POST","path":"/holdings/accounts/{accountId}/transactionRetries/cancellations","fullPath":"/api/v4.14.0/holdings/accounts/{accountId}/transactionRetries/cancellations","operationId":"createTransactionRetryCancellations","name":"Creates a cancellation request for a single transaction retry or multiple transaction retries pertaining to an account. The request will terminate the transaction from further retry.","summary":"Creates a cancellation request for a single transaction retry or multiple transaction retries pertaining to an account.","tags":["OTHERS"],"parameters":[{"name":"accountId","in":"path","type":"string","required":true,"description":"Identifier of the account. Often referred to as the account number, yet for consistency this is always referred to as accountId. Accepts both IBAN & BBAN"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"transactionRetryIds":[{}],"extensions":{}}},"responses":{"200":"TransactionRetryCancellationsResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/holdings/accounts/{accountId}/transactionRetries/pendings","fullPath":"/api/v4.14.0/holdings/accounts/{accountId}/transactionRetries/pendings","operationId":"getPendingTransactionRetries","name":"Retrieves various details from pending transaction retries pertaining to an account, such as retry start date, retry end date, retry frequency, retry amount, number of possible retries, total number of retries attempted, details of latest retry attempted and information of successful retry. Transaction Retries - bank transfer transactions transition through various payment statuses and in some cases a payment may move to a status from which users are unable to complete their payment. Example: In","summary":"Retrieves the pending transaction retries pertaining to an account","tags":["OTHERS"],"parameters":[{"name":"accountId","in":"path","type":"string","required":true,"description":"Identifier of the account. Often referred to as the account number, yet for consistency this is always referred to as accountId. Accepts both IBAN & BBAN"},{"name":"transactionRetryId","in":"query","type":"string","required":false,"description":"Indicates the transaction retry identifier"},{"name":"numberOfTransactionRetries","in":"query","type":"string","required":false,"description":"Indicates the number of times the transaction has to be retried."},{"name":"transactionRetryStartDate","in":"query","type":"string","required":false,"description":"Indicates the date when the transaction retry has started."},{"name":"transactionRetryEndDate","in":"query","type":"string","required":false,"description":"Indicates the date till when the transaction has to be retried."},{"name":"nextTransactionRetryDate","in":"query","type":"string","required":false,"description":"Indicates the date when transaction has to be retried next."},{"name":"transactionType","in":"query","type":"string","required":false,"description":"Identifies the transaction type applicable to the transaction being processed, i.e. outward or inward payment. For example: ACPX, OTPX etc."},{"name":"contractId","in":"query","type":"string","required":false,"description":"Indicates the unique identifier of the transaction or contract which initiated the activity"},{"name":"productGroupId","in":"query","type":"string","required":false,"description":"The group, as defined by the institution, that the product belongs to."},{"name":"productId","in":"query","type":"string","required":false,"description":"Contains the unique identifier of the product, e.g. the product id of the arrangement account."},{"name":"arrangementId","in":"query","type":"string","required":false,"description":"Indicates an unique identifier of an account"},{"name":"transactionRetryStatus","in":"query","type":"string","required":false,"description":"Indicates the transaction retry status. Possible values are: NEW - Indicates transaction is captured for retry and transaction retry is yet to be processed, CURRENT - Transaction is currently being re"},{"name":"retrySettlementStatus","in":"query","type":"string","required":false,"description":"Indicates the transaction settlement status. Possible values are: PENDING - Indicates that the transaction is yet to be settled through retry, SETTLED - Indicates that the transaction is fully settled"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"PendingTransactionRetriesResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"PUT","path":"/holdings/accounts/{accountId}/withdrawalNotices/cancellations","fullPath":"/api/v4.14.0/holdings/accounts/{accountId}/withdrawalNotices/cancellations","operationId":"cancelAccountWithdrawalNotice","name":"Cancels the notification of withdrawal of amount from account.","summary":"Cancels the notification of withdrawal of amount from account","tags":["RETAIL"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"accountId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"effectiveDate":"2024-01-01","productId":"string","extensions":{},"noticeWithdrawal":[{}]}},"responses":{"200":"cancelAccountWithdrawalNoticeResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"PUT","path":"/holdings/accounts/{accountId}/withdrawalNotices/noticeUpdates","fullPath":"/api/v4.14.0/holdings/accounts/{accountId}/withdrawalNotices/noticeUpdates","operationId":"updateAccountWithdrawalNotice","name":"Updates the notice of withdrawal of amount from  account by providing the withdrawal date, bill reference and amount etc. This is applicable only for notice type of accounts.","summary":"Updates the notice of withdrawal of amount from account","tags":["RETAIL"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"accountId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"effectiveDate":"2024-01-01","productId":"string","extensions":{},"noticeWithdrawal":[{}]}},"responses":{"200":"updateAccountWithdrawalNoticeResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"PUT","path":"/holdings/accounts/{accountId}/payouts","fullPath":"/api/v4.14.0/holdings/accounts/{accountId}/payouts","operationId":"initiateAccountPayout","name":"Performs payout of the given account amount such as charges, tax etc","summary":"Perform payout of an account","tags":["RETAIL"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"accountId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"currencyId":"string","effectiveDate":"2024-01-01","activityId":"string","transactionAmount":0.0,"contractId":"string","systemId":"string","externalEventStatus":"string","extensions":{}}},"responses":{"200":"initiateAccountPayoutResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"PUT","path":"/holdings/accounts/{accountId}/repayments","fullPath":"/api/v4.14.0/holdings/accounts/{accountId}/repayments","operationId":"initiateAccountPayin","name":"Repays the account amount such as charges, tax etc","summary":"Perform repayment of the given account","tags":["RETAIL"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"accountId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"currencyId":"string","effectiveDate":"2024-01-01","activityId":"string","transactionAmount":0.0,"contractId":"string","systemId":"string","externalEventStatus":"string","extensions":{}}},"responses":{"200":"initiateAccountPayinResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"GET","path":"/holdings/accounts/nostroAccounts","fullPath":"/api/v4.14.0/holdings/accounts/nostroAccounts","operationId":"getNostroAccounts","name":"Retrieves the currency, balance and category details of the nostro account","summary":"Retrieves list of nostro account details","tags":["OTHERS"],"parameters":[{"name":"accountId","in":"query","type":"string","required":false,"description":"Identifier of the account. Often referred to as the account number, yet for consistency this is always referred to as accountId. Accepts both IBAN & BBAN"},{"name":"customerId","in":"query","type":"string","required":false,"description":"Identifier of the customer"},{"name":"productId","in":"query","type":"string","required":false,"description":"Contains the unique identifier of the product, e.g. the product id of the arrangement account."},{"name":"currencyId","in":"query","type":"string","required":false,"description":"Identifier of the currency. This is the 3-letter ISO 4217 code of the currency."},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"NostroAccountsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"POST","path":"/holdings/accounts/nostroAccounts","fullPath":"/api/v4.14.0/holdings/accounts/nostroAccounts","operationId":"createNostroAccount","name":"Create nostro account with mandatory details such as customer, currency, account title, account officer, short title, reconcile account. A nostro account is the shadow or mirror account of the vostro account maintained by the correspondent bank. The nostro account is opened with the correspondent bank as the customer.","summary":"Create nostro account","tags":["OTHERS"],"parameters":[{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"otherOfficers":[{}],"postingRestrictIds":[{}],"alternateAccountTypes":[{}],"alternateAccountIds":[{}],"jointHolderIds":[{}],"jointRelationCodes":[{}],"additionalDetails":[{}],"customerId":"string","accountTitle":"string","accountTitle2":"string","shortTitle":"string","mnemonic":"string","positionType":"string","currencyId":"string","accountOfficer":"string"}},"responses":{"200":"NostroAccountResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"POST","path":"/holdings/accounts/internalAccounts/{accountId}","fullPath":"/api/v4.14.0/holdings/accounts/internalAccounts/{accountId}","operationId":"createInternalAccount","name":"Create bank internal account with mandatory details such as account title, short title, mnemonic, account officer. The internal accounts are created and maintained for bank's internal operations such as interbranch, intercompany transactions.","summary":"Create bank internal account","tags":["OTHERS"],"parameters":[{"name":"accountId","in":"path","type":"string","required":true,"description":"Identifier of the account. Often referred to as the account number, yet for consistency this is always referred to as accountId. Accepts both IBAN & BBAN"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"otherOfficers":[{}],"postingRestrictIds":[{}],"alternateAcctDetails":[{}],"categoryId":"string","accountTitle":"string","accountTitle2":"string","shortTitle":"string","mnemonic":"string","positionType":"string","accountOfficer":"string","highVolumeTransaction":"string","openingDate":"string","extensions":{}}},"responses":{"200":"InternalAccountResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/holdings/accounts/internalAccounts/{accountId}","fullPath":"/api/v4.14.0/holdings/accounts/internalAccounts/{accountId}","operationId":"updateInternalAccount","name":"Update bank internal account with details such as short title, account officer, account title, high volume transaction flag, alternate account id, posting restriction. The internal accounts are created and maintained for bank's internal operations such as interbranch, intercompany transactions.","summary":"Update bank internal account","tags":["OTHERS"],"parameters":[{"name":"accountId","in":"path","type":"string","required":true,"description":"Identifier of the account. Often referred to as the account number, yet for consistency this is always referred to as accountId. Accepts both IBAN & BBAN"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"otherOfficers":[{}],"postingRestrictIds":[{}],"alternateAcctDetails":[{}],"accountTitle":"string","accountTitle2":"string","shortTitle":"string","mnemonic":"string","accountOfficer":"string","highVolumeTransaction":"string","extensions":{}}},"responses":{"200":"InternalAccountResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/holdings/accounts/nostroAccounts/{accountId}","fullPath":"/api/v4.14.0/holdings/accounts/nostroAccounts/{accountId}","operationId":"updateNostroAccount","name":"Update nostro account with details such as reconciliation tolerance amount, our actual account number, short title, account officer, account title, high volume transaction flag, posting restriction. A nostro account is the shadow or mirror account of the vostro account maintained by the correspondent bank. The nostro account is opened with the correspondent bank as the customer.","summary":"Update Nostro account","tags":["OTHERS"],"parameters":[{"name":"accountId","in":"path","type":"string","required":true,"description":"Identifier of the account. Often referred to as the account number, yet for consistency this is always referred to as accountId. Accepts both IBAN & BBAN"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"otherOfficers":[{}],"postingRestrictIds":[{}],"alternateAccountTypes":[{}],"alternateAccountIds":[{}],"jointHolderIds":[{}],"jointRelationCodes":[{}],"additionalDetails":[{}],"accountTitle":"string","accountTitle2":"string","shortTitle":"string","mnemonic":"string","accountOfficer":"string","ownNostro":"string","reconciliationToleranceAmount":"string","highVolumeTransaction":"string"}},"responses":{"200":"NostroAccountResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/holdings/accounts/internalAccounts","fullPath":"/api/v4.14.0/holdings/accounts/internalAccounts","operationId":"getInternalAccounts","name":"Retrieves the currency, balance and category details of the internal account","summary":"Retrieves list of internal account details","tags":["OTHERS"],"parameters":[{"name":"accountId","in":"query","type":"string","required":false,"description":"Identifier of the account. Often referred to as the account number, yet for consistency this is always referred to as accountId. Accepts both IBAN & BBAN"},{"name":"productId","in":"query","type":"string","required":false,"description":"Contains the unique identifier of the product, e.g. the product id of the arrangement account."},{"name":"currencyId","in":"query","type":"string","required":false,"description":"Identifier of the currency. This is the 3-letter ISO 4217 code of the currency."},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"InternalAccountsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/accounts","fullPath":"/api/v4.14.0/holdings/accounts","operationId":"getAccounts","name":"Retrieves the currency, balances, limit details and arrangement details of the account","summary":"Retrieves list of account basic details","tags":["OTHERS"],"parameters":[{"name":"accountId","in":"query","type":"string","required":false,"description":"Identifier of the account. Often referred to as the account number, yet for consistency this is always referred to as accountId. Accepts both IBAN & BBAN"},{"name":"customerId","in":"query","type":"string","required":false,"description":"Identifier of the customer"},{"name":"productId","in":"query","type":"string","required":false,"description":"Contains the unique identifier of the product, e.g. the product id of the arrangement account."},{"name":"currencyId","in":"query","type":"string","required":false,"description":"Identifier of the currency. This is the 3-letter ISO 4217 code of the currency."},{"name":"currencyIdSAID","in":"query","type":"string","required":false,"description":"Indicates the criteria for the sounds like operation on the currency"},{"name":"limitReference","in":"query","type":"string","required":false,"description":"Identifies the credit limit reference for the underlying account."},{"name":"arrangementId","in":"query","type":"string","required":false,"description":"Indicates an unique identifier of an account"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"AccountsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/accounts/{companyAccountId}/balances","fullPath":"/api/v4.14.0/holdings/accounts/{companyAccountId}/balances","operationId":"getAccountBalanceTypes","name":"Retrieves the balance ,balance type for the account and company provided.","summary":"Retrieves the account funds and balance types.","tags":["RETAIL"],"parameters":[{"name":"companyAccountId","in":"path","type":"string","required":true,"description":"Indicates the company code and account id seperated by '-'.Example : US0010001-10995"},{"name":"virtualBalances","in":"query","type":"string","required":false,"description":"Contains the virtual balance of the collateral"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"AccountBalanceTypesResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}}]},{"key":"holdings-accounts-service-v4.2.0","title":"Account management","version":"v4.2.0","description":"API to manage account related services such as retrieving balances, transaction and card details, emergency blocks, funds diversion, reservations, proxy identifiers and account closures. In addition, it provides functionality to support the capability to switch accounts from the current system to an","endpointCount":29,"endpoints":[{"method":"GET","path":"/holdings/accounts/accountClosure/{accountId}","fullPath":"/api/v4.2.0/holdings/accounts/accountClosure/{accountId}","operationId":"getAccountClosure","name":"Retrieves the account closure information of the account such as closure date and reason, mode of closure, balances on the date of closing and pending charges","summary":"Retrieves the account closure information","tags":[],"parameters":[{"name":"accountId","in":"path","type":"string","required":true,"description":"Identifier of the account. Often referred to as the account number, yet for consistency this is always referred to as accountId. Accepts both IBAN & BBAN"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"AccountClosureResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/holdings/accounts/accountClosure/{accountId}","fullPath":"/api/v4.2.0/holdings/accounts/accountClosure/{accountId}","operationId":"updateAccountClosure","name":"Updates account closure information for the specific account such as closure date and reason, mode of closure and closing charges","summary":"Updates account closure information","tags":[],"parameters":[{"name":"accountId","in":"path","type":"string","required":true,"description":"Identifier of the account. Often referred to as the account number, yet for consistency this is always referred to as accountId. Accepts both IBAN & BBAN"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"accountCurrency":"string","closureDate":"2024-01-01T00:00:00Z","creditAccount":"string","capitaliseInterest":"string","chargeType":"string","chargeAmount":0.0,"closeMode":"string","ftId":"string","closureReason":"string","closureNotes":"string","onlineLedgerBalance":0.0,"onlineClearedBalance":0.0,"balancePayable":0.0,"totalCreditInterest":"string","totalDebitInterest":"string"}},"responses":{"200":"AccountClosureResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/holdings/accounts/{accountId}/transactions","fullPath":"/api/v4.2.0/holdings/accounts/{accountId}/transactions","operationId":"getAccountTransactions","name":"Retrieves account transaction details such as transaction type, amount, transaction reference, credit or debit indicator, booking and effective date of transaction","summary":"Retrieves account transaction details","tags":[],"parameters":[{"name":"accountId","in":"path","type":"string","required":true,"description":"Identifier of the account. Often referred to as the account number, yet for consistency this is always referred to as account id. Accepts both IBAN & BBAN"},{"name":"bookingDate","in":"query","type":"string","required":false,"description":"Business date on which the accounting entry was generated."},{"name":"processingDate","in":"query","type":"string","required":false,"description":"The date when payment instruction is processed in system."},{"name":"valueDate","in":"query","type":"string","required":false,"description":"Indicates the value date on which the underlying accounting entry is to be given value (for interest purposes)"},{"name":"description","in":"query","type":"string","required":false,"description":"Contains the description of purpose of the payment."},{"name":"reversalMarker","in":"query","type":"string","required":false,"description":"Denotes the flag which is set whenever any credit or reversal debit entries with future exposure dates are processed"},{"name":"includeSubAcct","in":"query","type":"string","required":false,"description":"Denotes the flag which needs to be set in order to allow the automatic creation of sub-accounts and the automatic distribution of transactions over sub-accounts"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"AccountTransactionsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/accounts/{accountId}/cards","fullPath":"/api/v4.2.0/holdings/accounts/{accountId}/cards","operationId":"getAccountCards","name":"Retrieves the card details of the account such as card number, card type and status of the card","summary":"Retrieves available card details","tags":[],"parameters":[{"name":"accountId","in":"path","type":"string","required":true,"description":"Identifier of the account. Often referred to as the account number, yet for consistency this is always referred to as accountId. Accepts both IBAN & BBAN"},{"name":"cardIssueId","in":"query","type":"string","required":false,"description":"The identifier of the issued card formatted as cardType '.' cardNumber. E.g. VISA.1234567887654321 GC.1111222233334444 AB21.1111111122222222"},{"name":"issueDate","in":"query","type":"string","required":false,"description":"The date the item was issued."},{"name":"expiryDate","in":"query","type":"string","required":false,"description":"The date an agreement such as an arrangement, product, credit facility or limit is due to expire"},{"name":"cardStatus","in":"query","type":"string","required":false,"description":"Current status of the Card and following are the possible statuses are  - CARD.ISSUED - CARD.RETURNED - CARD.SCRAP - CARD.CANCEL - NOT.ACTIVATED - NOT.RECEIVED - ACTIVE - BLOCKED - EXPIRED"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"AccountCardsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/accounts/balances","fullPath":"/api/v4.2.0/holdings/accounts/balances","operationId":"getAccountBalanceToday","name":"Retrieves various types of balances such as cleared, online, locked and usable balance of the account","summary":"Retrieves list of account balances","tags":[],"parameters":[{"name":"accountId","in":"query","type":"string","required":false,"description":"Identifier of the account. Often referred to as the account number, yet for consistency this is always referred to as accountId. Accepts both IBAN & BBAN"},{"name":"customerId","in":"query","type":"string","required":false,"description":"Identifier of the customer"},{"name":"productId","in":"query","type":"string","required":false,"description":"Contains the unique identifier of the product, e.g. the product id of the arrangement account."},{"name":"currencyId","in":"query","type":"string","required":false,"description":"Identifier of the currency. This is the 3-letter ISO 4217 code of the currency."},{"name":"limitReferenceId","in":"query","type":"string","required":false,"description":"Limit reference identifier for the limit order."},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"AccountBalanceTodayResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/accounts/{accountId}/balanceMovements/{bookingDate}","fullPath":"/api/v4.2.0/holdings/accounts/{accountId}/balanceMovements/{bookingDate}","operationId":"getAccountBalanceMovement","name":"Retrieves the credit, debit and gross balance movements for an account for the requested booking date","summary":"Retrieves balances movements of account","tags":[],"parameters":[{"name":"accountId","in":"path","type":"string","required":true,"description":"Identifier of the account. Often referred to as the account number, yet for consistency this is always referred to as accountId. Accepts both IBAN & BBAN"},{"name":"bookingDate","in":"path","type":"string","required":true,"description":"Business date on which the accounting entry was generated."},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"AccountBalanceMovementResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/accounts/{accountId}/emergencyBlocks/status","fullPath":"/api/v4.2.0/holdings/accounts/{accountId}/emergencyBlocks/status","operationId":"getAccountEmergencyBlock","name":"Retrieve emergency block status and reason for a given account. This information will be used to assert the actual block status of an account in microservice","summary":"Retrieve emergency block information for an account","tags":[],"parameters":[{"name":"accountId","in":"path","type":"string","required":true,"description":"Identifier of the account. Often referred to as the account number, yet for consistency this is always referred to as accountId. Accepts both IBAN & BBAN"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"AccountEmergencyBlockResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"PUT","path":"/holdings/accounts/{accountId}/emergencyBlocks/status","fullPath":"/api/v4.2.0/holdings/accounts/{accountId}/emergencyBlocks/status","operationId":"updateAccountEmergencyBlock","name":"Updates emergency block status and reason for the account","summary":"Update emergency block in account","tags":[],"parameters":[{"name":"accountId","in":"path","type":"string","required":true,"description":"Identifier of the account. Often referred to as the account number, yet for consistency this is always referred to as accountId. Accepts both IBAN & BBAN"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"emergencyBlock":"string","emergencyReason":"string"}},"responses":{"200":"AccountEmergencyBlockResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/holdings/accounts/{accountId}/fundsAuthorisation/status","fullPath":"/api/v4.2.0/holdings/accounts/{accountId}/fundsAuthorisation/status","operationId":"getAccountFundsAuthStatus","name":"Retrieve the funds authorisation status from account","summary":"Retrieve account funds authorisation status","tags":[],"parameters":[{"name":"accountId","in":"path","type":"string","required":true,"description":"Identifier of the account. Often referred to as the account number, yet for consistency this is always referred to as accountId. Accepts both IBAN & BBAN"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"AccountFundsAuthStatusResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"PUT","path":"/holdings/accounts/{accountId}/fundsAuthorisation/status","fullPath":"/api/v4.2.0/holdings/accounts/{accountId}/fundsAuthorisation/status","operationId":"updateAccountFundsAuthStatus","name":"Update the funds authorisation status for the account, for example SYNC or ERROR","summary":"Update account funds authorisation status","tags":[],"parameters":[{"name":"accountId","in":"path","type":"string","required":true,"description":""},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"faStatus":"string"}},"responses":{"200":"AccountFundsAuthStatusResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"POST","path":"/holdings/accounts/settings/{settingId}/fundsDiversion","fullPath":"/api/v4.2.0/holdings/accounts/settings/{settingId}/fundsDiversion","operationId":"createFundsDiversion","name":"Allows creation of funds diversion conditions for a company to manage the behavior of booking funds against any account in the company that has the auto pay account defined","summary":"Creates conditions for funds diversion","tags":[],"parameters":[{"name":"settingId","in":"path","type":"string","required":true,"description":"Contains the particular parameter record setting identifier."},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"transactionCodes":[{}],"defaultFundsDiversion":"string"}},"responses":{"200":"FundsDiversionResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/holdings/accounts/settings/{settingId}/fundsDiversion","fullPath":"/api/v4.2.0/holdings/accounts/settings/{settingId}/fundsDiversion","operationId":"updateFundsDiversion","name":"Updates the funds diversion conditions for a company to manage the behavior of booking funds against any account in the company that has the auto pay account defined","summary":"Updates funds diversion parameter","tags":[],"parameters":[{"name":"settingId","in":"path","type":"string","required":true,"description":"Contains the particular parameter record setting identifier."},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"transactionCodes":[{}],"defaultFundsDiversion":"string"}},"responses":{"200":"FundsDiversionResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/holdings/nostros/forwardBalances","fullPath":"/api/v4.2.0/holdings/nostros/forwardBalances","operationId":"getNostroForwardBalances","name":"Retrieves forward balances of nostro accounts considering the transaction effective dates.","summary":"Retrieves consolidated nostro account balances","tags":[],"parameters":[{"name":"valueDate","in":"query","type":"string","required":true,"description":"Indicates the value date on which the underlying accounting entry is to be given value (for interest purposes)"},{"name":"accountId","in":"query","type":"string","required":false,"description":"Identifier of the account. Often referred to as the account number, yet for consistency this is always referred to as accountId. Accepts both IBAN & BBAN"},{"name":"longPositionSign","in":"query","type":"string","required":false,"description":"Polarity (sign) used to denote buy position balance.  "},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"NostroForwardBalancesResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/nostros/currencyBalances/{currencyId}/accounts","fullPath":"/api/v4.2.0/holdings/nostros/currencyBalances/{currencyId}/accounts","operationId":"getNostroBalances","name":"Retrieves the date wise balances of the nostro accounts that falls under a specific currency","summary":"Retrieves nostro account balances for a specific currency","tags":[],"parameters":[{"name":"currencyId","in":"path","type":"string","required":true,"description":"Identifier of the currency. This is the 3-letter ISO 4217 code of the currency."},{"name":"nostroId","in":"query","type":"string","required":false,"description":"Nostro account id"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"NostroBalancesResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/nostros/currencyBalances/{currencyId}","fullPath":"/api/v4.2.0/holdings/nostros/currencyBalances/{currencyId}","operationId":"getNostroCurrencyPositions","name":"Retrieves consolidated balances of the nostro accounts in a given currency from the current date to the next five days.","summary":"Retrieves consolidated nostro account balances for a specific currency","tags":[],"parameters":[{"name":"currencyId","in":"path","type":"string","required":true,"description":"Identifier of the currency. This is the 3-letter ISO 4217 code of the currency."},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"NostroCurrencyPositionsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/nostros/positions/{currencyId}","fullPath":"/api/v4.2.0/holdings/nostros/positions/{currencyId}","operationId":"getNostroPositions","name":"Retrieves nostro account balances for a given currency from the current date to the next five days.","summary":"Retrieves consolidated nostro account positions for the currency","tags":[],"parameters":[{"name":"currencyId","in":"path","type":"string","required":true,"description":"Identifier of the currency. This is the 3-letter ISO 4217 code of the currency."},{"name":"longPositionSign","in":"query","type":"string","required":false,"description":"Polarity (sign) used to denote buy position balance.  "},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"NostroPositionsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/accounts/reservedFunds","fullPath":"/api/v4.2.0/holdings/accounts/reservedFunds","operationId":"getReservedFunds","name":"Retrieves the reserved funds details such as reason, amount and period of reservation of the account","summary":"Retrieves the list of reserved funds","tags":[],"parameters":[{"name":"accountId","in":"query","type":"string","required":false,"description":"Identifier of the account. Often referred to as the account number, yet for consistency this is always referred to as accountId. Accepts both IBAN & BBAN"},{"name":"eventId","in":"query","type":"string","required":false,"description":"Event identifier"},{"name":"lockReason","in":"query","type":"string","required":false,"description":"Indicates the simple description for the balance reservation event."},{"name":"fromDate","in":"query","type":"string","required":false,"description":"Indicates the business date from when the balance reservation event is active."},{"name":"toDate","in":"query","type":"string","required":false,"description":"Indicates the business date until when the balance reservation event is active."},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"ReservedFundsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/accounts/{accountId}","fullPath":"/api/v4.2.0/holdings/accounts/{accountId}","operationId":"getAccountDetails","name":"Retrieves the arrangement account details such as account balances, allowed, advised and outstanding limit balances, interest types and values with the corresponding mode, frequency and value of payments","summary":"Retrieves arrangement account details","tags":[],"parameters":[{"name":"accountId","in":"path","type":"string","required":true,"description":"Identifier of the account. Often referred to as the account number, yet for consistency this is always referred to as accountId. Accepts both IBAN & BBAN"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"AccountDetailsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/accounts/proxyIdentifiers","fullPath":"/api/v4.2.0/holdings/accounts/proxyIdentifiers","operationId":"getActiveProxyIdentifier","name":"Retrieve active records from proxy directory for a given customer number or account number or proxy type and proxy identifier","summary":"Retrieve proxy registration status","tags":[],"parameters":[{"name":"customerId","in":"query","type":"string","required":false,"description":"Identifier of the customer"},{"name":"alternateAccountId","in":"query","type":"string","required":false,"description":"Alternate identification for an account"},{"name":"proxyType","in":"query","type":"string","required":false,"description":"Type of proxy created for account"},{"name":"proxyIdentifier","in":"query","type":"string","required":false,"description":"A proxy identifier to be linked to an account based on the proxy type provided eg. Mobile number, email id and tax id"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"ActiveProxyIdentifierResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"POST","path":"/holdings/accounts/proxyIdentifiers","fullPath":"/api/v4.2.0/holdings/accounts/proxyIdentifiers","operationId":"createProxyIdentifier","name":"Create a new record in proxy directory to register the supplied proxy identifiers, proxy type and scheme for a customer and account","summary":"Register the proxy identifier for the account","tags":[],"parameters":[{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"customerId":"string","accountId":"string","alternateAccountId":"string","proxyType":"string","proxyIdentifier":"string","proxyStatus":"string","proxyScheme":"string","proxyRole":"string"}},"responses":{"200":"ProxyIdentifierResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/holdings/accounts/proxyIdentifiers/{proxyIdentifierId}","fullPath":"/api/v4.2.0/holdings/accounts/proxyIdentifiers/{proxyIdentifierId}","operationId":"updateProxyIdentifier","name":"Update the specific proxy identifier to de-register the registered account or customer from the proxy directory","summary":"Update proxy directory for account to de-register the proxy identifier","tags":[],"parameters":[{"name":"proxyIdentifierId","in":"path","type":"string","required":true,"description":""},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"customerId":"string","accountId":"string","alternateAccountId":"string","proxyType":"string","proxyIdentifier":"string","proxyStatus":"string","proxyScheme":"string","proxyRole":"string"}},"responses":{"200":"ProxyIdentifierResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/holdings/accounts/{accountId}/{accountCompany}/{paymentCurrency}/{accountSwitch}/{beneficialCustomer}/payments","fullPath":"/api/v4.2.0/holdings/accounts/{accountId}/{accountCompany}/{paymentCurrency}/{accountSwitch}/{beneficialCustomer}/payments","operationId":"getAccountPaymentDetails","name":"Retrieves the account information that are required for processing or validating an account involved in a payment transaction. Provides the information such as account name, customer number, account type, account currency, IBAN, account switch details, account status (ACTIVE or INACTIVE) and account closure details.","summary":"Retrieves account details required for payment processing","tags":[],"parameters":[{"name":"accountId","in":"path","type":"string","required":true,"description":"Identifier of the account. Often referred to as the account number, yet for consistency this is always referred to as accountId. Accepts both IBAN & BBAN"},{"name":"accountCompany","in":"path","type":"string","required":true,"description":"Company of the account to be created"},{"name":"paymentCurrency","in":"path","type":"string","required":true,"description":"This field holds the transaction currency or currency in which payment is initiated. "},{"name":"accountSwitch","in":"path","type":"string","required":true,"description":"Indicates if availability of account switch details should be checked."},{"name":"beneficialCustomer","in":"path","type":"string","required":true,"description":"Indicates if beneficial owners of the account are to be retrieved"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"AccountPaymentDetailsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/accounts","fullPath":"/api/v4.2.0/holdings/accounts","operationId":"getAccounts","name":"Retrieves the currency, balances, limit details and arrangement details of an account","summary":"Retrieves list of account details","tags":[],"parameters":[{"name":"accountId","in":"query","type":"string","required":false,"description":"Identifier of the account. Often referred to as the account number, yet for consistency this is always referred to as accountId. Accepts both IBAN & BBAN"},{"name":"customerId","in":"query","type":"string","required":false,"description":"Identifier of the customer"},{"name":"productId","in":"query","type":"string","required":false,"description":"Contains the unique identifier of the product, e.g. the product id of the arrangement account."},{"name":"currencyId","in":"query","type":"string","required":false,"description":"Identifier of the currency. This is the 3-letter ISO 4217 code of the currency."},{"name":"limitReference","in":"query","type":"string","required":false,"description":"Identifies the credit limit reference for the underlying account."},{"name":"arrangementId","in":"query","type":"string","required":false,"description":"Indicates an unique identifier of an account"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"AccountsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/accounts/{contractBalanceId}/contractBalances","fullPath":"/api/v4.2.0/holdings/accounts/{contractBalanceId}/contractBalances","operationId":"getContractBalances","name":"Retrieves the contract balances of accounts or contracts with details such as contract currency, balance types, credit and debit movements and opening and closing balance of the respective balance types","summary":"Retrieves contract balances of accounts","tags":[],"parameters":[{"name":"contractBalanceId","in":"path","type":"string","required":true,"description":"Unique Identifier of Contract Balances"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"ContractBalancesResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"PUT","path":"/holdings/accounts/{accountId}/synchronizationError","fullPath":"/api/v4.2.0/holdings/accounts/{accountId}/synchronizationError","operationId":"updateSynchronizationError","name":"Updates error status during synchronization of the account between transact and funds authorisation microservice","summary":"Update synchronization error status","tags":[],"parameters":[{"name":"accountId","in":"path","type":"string","required":true,"description":"Identifier of the account. Often referred to as the account number, yet for consistency this is always referred to as accountId. Accepts both IBAN & BBAN"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"emergencyBlockError":"string"}},"responses":{"200":"SynchronizationErrorResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/holdings/accounts/{accountId}/accountSwitches/expiringSwitches","fullPath":"/api/v4.2.0/holdings/accounts/{accountId}/accountSwitches/expiringSwitches","operationId":"getExpiringAccountSwitches","name":"Retrieves the details of the expiring account switches for generating alerts such as the bank identifier code, alert date and account id of expiring switch instruction etc.","summary":"Retrieves the details of the expiring switches for generating alerts","tags":[],"parameters":[{"name":"accountId","in":"path","type":"string","required":true,"description":"The identifier of the account. Often referred to as the account number, yet for consistency this is always referred to as account id.Accepts both IBAN & BBAN"},{"name":"alertStatus","in":"query","type":"string","required":false,"description":"Contains status of the Alert. Possible values are Pending, Sent"},{"name":"alertDate","in":"query","type":"string","required":false,"description":"Indicates the date in which an alert to be raised."},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from t24 on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":""},{"name":"companyId","in":"header","type":"string","required":false,"description":"The identifier of the underlying Entity/Company/Branch."},{"name":"deviceId","in":"header","type":"string","required":false,"description":""},{"name":"userRole","in":"header","type":"string","required":false,"description":""},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"ExpiringAccountSwitchesResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/accounts/{accountId}/accountSwitches","fullPath":"/api/v4.2.0/holdings/accounts/{accountId}/accountSwitches","operationId":"getAccountSwitchDetails","name":"Retrieves details from the account switch directory for the specific account such as the expiry date, status of the switch instruction, effective date of the switch, bank identifier code and IBAN (International Bank Account Number ) etc.","summary":"Retrieves details of the account switch requests","tags":[],"parameters":[{"name":"accountId","in":"path","type":"string","required":true,"description":"The identifier of the account. Often referred to as the account number, yet for consistency this is always referred to as accountId.Accepts both IBAN & BBAN"},{"name":"requestDate","in":"query","type":"string","required":false,"description":"Date on which the client's request to be classified as professional has been received."},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from t24 on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":""},{"name":"companyId","in":"header","type":"string","required":false,"description":"The identifier of the underlying Entity/Company/Branch."},{"name":"deviceId","in":"header","type":"string","required":false,"description":""},{"name":"userRole","in":"header","type":"string","required":false,"description":""},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"AccountSwitchDetailsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"PUT","path":"/holdings/accounts/{accountId}/accountSwitches","fullPath":"/api/v4.2.0/holdings/accounts/{accountId}/accountSwitches","operationId":"updateAccountSwitchDetails","name":"Updates alert status based on the original IBAN. Used by external systems handling alert generation to mark the status from pending to sent","summary":"Updates alert status from pending to sent for corresponding switch instructions.","tags":[],"parameters":[{"name":"accountId","in":"path","type":"string","required":true,"description":"The identifier of the account. Often referred to as the account number, yet for consistency this is always referred to as accountId.Accepts both IBAN & BBAN"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":""},{"name":"companyId","in":"header","type":"string","required":false,"description":"The identifier of the underlying Entity/Company/Branch."},{"name":"deviceId","in":"header","type":"string","required":false,"description":""},{"name":"userRole","in":"header","type":"string","required":false,"description":""}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"accountId":"string","switchIBAN":"string","switchAccountId":"string","switchBic":"string","switchClearingCode":"string","requestDate":"string","status":"string","cancelInstruction":"string","cancelDate":"string","expiryDate":"string","IBAN":"string","bicId":"string","effectiveDate":"string","alertDate":"string","alertStatus":"string"}},"responses":{"200":"AccountSwitchDetailsResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/holdings/accounts/{accountId}/accountSwitches/payments","fullPath":"/api/v4.2.0/holdings/accounts/{accountId}/accountSwitches/payments","operationId":"getAccountSwitchPaymentDetails","name":"Retrieves information of the re-routed payments from the payment transaction exit point.","summary":"Retrieves rerouted payment information.","tags":[],"parameters":[{"name":"accountId","in":"path","type":"string","required":true,"description":"The identifier of the account. Often referred to as the account number, yet for consistency this is always referred to as accountId.Accepts both IBAN & BBAN"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from t24 on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":""},{"name":"companyId","in":"header","type":"string","required":false,"description":"The identifier of the underlying Entity/Company/Branch."},{"name":"deviceId","in":"header","type":"string","required":false,"description":""},{"name":"userRole","in":"header","type":"string","required":false,"description":""},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"AccountSwitchPaymentDetailsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}}]},{"key":"holdings-accounts-service-v4.3.0","title":"Account management","version":"v4.3.0","description":"API to manage account related services such as retrieving balances, transaction and card details, emergency blocks, funds diversion, reservations, proxy identifiers and account closures. In addition, it provides functionality to support the capability to switch accounts from the current system to an","endpointCount":30,"endpoints":[{"method":"GET","path":"/holdings/accounts/accountClosures/{accountId}","fullPath":"/api/v4.3.0/holdings/accounts/accountClosures/{accountId}","operationId":"getAccountClosure","name":"Retrieves the account closure information of the account such as closure date and reason, mode of closure, balances on the date of closing and pending charges","summary":"Retrieves the account closure information","tags":[],"parameters":[{"name":"accountId","in":"path","type":"string","required":true,"description":"Identifier of the account. Often referred to as the account number, yet for consistency this is always referred to as accountId. Accepts both IBAN & BBAN"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"AccountClosureResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/holdings/accounts/accountClosures/{accountId}","fullPath":"/api/v4.3.0/holdings/accounts/accountClosures/{accountId}","operationId":"updateAccountClosure","name":"Updates account closure information for the specific account such as closure date and reason, mode of closure and closing charges","summary":"Updates account closure information","tags":[],"parameters":[{"name":"accountId","in":"path","type":"string","required":true,"description":"Identifier of the account. Often referred to as the account number, yet for consistency this is always referred to as accountId. Accepts both IBAN & BBAN"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"accountCurrency":"string","closureDate":"2024-01-01T00:00:00Z","creditAccount":"string","capitaliseInterest":"string","chargeType":"string","chargeAmount":0.0,"closeMode":"string","ftId":"string","closureReason":"string","closureNotes":"string","onlineLedgerBalance":0.0,"onlineClearedBalance":0.0,"balancePayable":0.0,"totalCreditInterest":"string","totalDebitInterest":"string"}},"responses":{"200":"AccountClosureResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/holdings/accounts/{accountId}/transactions","fullPath":"/api/v4.3.0/holdings/accounts/{accountId}/transactions","operationId":"getAccountTransactions","name":"Retrieves account transaction details such as transaction type, amount, transaction reference, credit or debit indicator, booking and effective date of transaction","summary":"Retrieves account transaction details","tags":[],"parameters":[{"name":"accountId","in":"path","type":"string","required":true,"description":"Identifier of the account. Often referred to as the account number, yet for consistency this is always referred to as account id. Accepts both IBAN & BBAN"},{"name":"bookingDate","in":"query","type":"string","required":false,"description":"Business date on which the accounting entry was generated."},{"name":"processingDate","in":"query","type":"string","required":false,"description":"The date when payment instruction is processed in system."},{"name":"valueDate","in":"query","type":"string","required":false,"description":"Indicates the value date on which the underlying accounting entry is to be given value (for interest purposes)"},{"name":"description","in":"query","type":"string","required":false,"description":"Contains the description of purpose of the payment."},{"name":"reversalMarker","in":"query","type":"string","required":false,"description":"Denotes the flag which is set whenever any credit or reversal debit entries with future exposure dates are processed"},{"name":"includeSubAcct","in":"query","type":"string","required":false,"description":"Denotes the flag which needs to be set in order to allow the automatic creation of sub-accounts and the automatic distribution of transactions over sub-accounts"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"AccountTransactionsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/accounts/{accountId}/cards","fullPath":"/api/v4.3.0/holdings/accounts/{accountId}/cards","operationId":"getAccountCards","name":"Retrieves the card details of the account such as card number, card type and status of the card","summary":"Retrieves available card details","tags":[],"parameters":[{"name":"accountId","in":"path","type":"string","required":true,"description":"Identifier of the account. Often referred to as the account number, yet for consistency this is always referred to as accountId. Accepts both IBAN & BBAN"},{"name":"cardIssueId","in":"query","type":"string","required":false,"description":"The identifier of the issued card formatted as cardType '.' cardNumber. E.g. VISA.1234567887654321 GC.1111222233334444 AB21.1111111122222222"},{"name":"issueDate","in":"query","type":"string","required":false,"description":"The date the item was issued."},{"name":"expiryDate","in":"query","type":"string","required":false,"description":"The date an agreement such as an arrangement, product, credit facility or limit is due to expire"},{"name":"cardStatus","in":"query","type":"string","required":false,"description":"Current status of the Card and following are the possible statuses are  - CARD.ISSUED - CARD.RETURNED - CARD.SCRAP - CARD.CANCEL - NOT.ACTIVATED - NOT.RECEIVED - ACTIVE - BLOCKED - EXPIRED"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"AccountCardsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/accounts/balances","fullPath":"/api/v4.3.0/holdings/accounts/balances","operationId":"getAccountBalanceToday","name":"Retrieves various types of balances such as cleared, online, locked and usable balance of the account","summary":"Retrieves list of account balances","tags":[],"parameters":[{"name":"accountId","in":"query","type":"string","required":false,"description":"Identifier of the account. Often referred to as the account number, yet for consistency this is always referred to as accountId. Accepts both IBAN & BBAN"},{"name":"customerId","in":"query","type":"string","required":false,"description":"Identifier of the customer"},{"name":"productId","in":"query","type":"string","required":false,"description":"Contains the unique identifier of the product, e.g. the product id of the arrangement account."},{"name":"currencyId","in":"query","type":"string","required":false,"description":"Identifier of the currency. This is the 3-letter ISO 4217 code of the currency."},{"name":"limitReferenceId","in":"query","type":"string","required":false,"description":"Limit reference identifier for the limit order."},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"AccountBalanceTodayResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/accounts/{accountId}/balanceMovements/{bookingDate}","fullPath":"/api/v4.3.0/holdings/accounts/{accountId}/balanceMovements/{bookingDate}","operationId":"getAccountBalanceMovement","name":"Retrieves the credit, debit and gross balance movements for an account for the requested booking date","summary":"Retrieves balances movements of account","tags":[],"parameters":[{"name":"accountId","in":"path","type":"string","required":true,"description":"Identifier of the account. Often referred to as the account number, yet for consistency this is always referred to as accountId. Accepts both IBAN & BBAN"},{"name":"bookingDate","in":"path","type":"string","required":true,"description":"Business date on which the accounting entry was generated."},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"AccountBalanceMovementResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/accounts/{accountId}/emergencyBlocks/status","fullPath":"/api/v4.3.0/holdings/accounts/{accountId}/emergencyBlocks/status","operationId":"getAccountEmergencyBlock","name":"Retrieve emergency block status and reason for a given account. This information will be used to assert the actual block status of an account in microservice","summary":"Retrieve emergency block information for an account","tags":[],"parameters":[{"name":"accountId","in":"path","type":"string","required":true,"description":"Identifier of the account. Often referred to as the account number, yet for consistency this is always referred to as accountId. Accepts both IBAN & BBAN"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"AccountEmergencyBlockResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"PUT","path":"/holdings/accounts/{accountId}/emergencyBlocks/status","fullPath":"/api/v4.3.0/holdings/accounts/{accountId}/emergencyBlocks/status","operationId":"updateAccountEmergencyBlock","name":"Updates emergency block status and reason for the account","summary":"Update emergency block in account","tags":[],"parameters":[{"name":"accountId","in":"path","type":"string","required":true,"description":"Identifier of the account. Often referred to as the account number, yet for consistency this is always referred to as accountId. Accepts both IBAN & BBAN"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"emergencyBlock":"string","emergencyReason":"string"}},"responses":{"200":"AccountEmergencyBlockResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/holdings/accounts/{accountId}/fundsAuthorisation/status","fullPath":"/api/v4.3.0/holdings/accounts/{accountId}/fundsAuthorisation/status","operationId":"getAccountFundsAuthStatus","name":"Retrieve the funds authorisation status from account","summary":"Retrieve account funds authorisation status","tags":[],"parameters":[{"name":"accountId","in":"path","type":"string","required":true,"description":"Identifier of the account. Often referred to as the account number, yet for consistency this is always referred to as accountId. Accepts both IBAN & BBAN"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"AccountFundsAuthStatusResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"PUT","path":"/holdings/accounts/{accountId}/fundsAuthorisation/status","fullPath":"/api/v4.3.0/holdings/accounts/{accountId}/fundsAuthorisation/status","operationId":"updateAccountFundsAuthStatus","name":"Update the funds authorisation status for the account, for example SYNC or ERROR","summary":"Update account funds authorisation status","tags":[],"parameters":[{"name":"accountId","in":"path","type":"string","required":true,"description":""},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"faStatus":"string"}},"responses":{"200":"AccountFundsAuthStatusResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"POST","path":"/holdings/accounts/settings/{settingId}/fundsDiversion","fullPath":"/api/v4.3.0/holdings/accounts/settings/{settingId}/fundsDiversion","operationId":"createFundsDiversion","name":"Allows creation of funds diversion conditions for a company to manage the behavior of booking funds against any account in the company that has the auto pay account defined","summary":"Creates conditions for funds diversion","tags":[],"parameters":[{"name":"settingId","in":"path","type":"string","required":true,"description":"Contains the particular parameter record setting identifier."},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"transactionCodes":[{}],"defaultFundsDiversion":"string"}},"responses":{"200":"FundsDiversionResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/holdings/accounts/settings/{settingId}/fundsDiversion","fullPath":"/api/v4.3.0/holdings/accounts/settings/{settingId}/fundsDiversion","operationId":"updateFundsDiversion","name":"Updates the funds diversion conditions for a company to manage the behavior of booking funds against any account in the company that has the auto pay account defined","summary":"Updates funds diversion parameter","tags":[],"parameters":[{"name":"settingId","in":"path","type":"string","required":true,"description":"Contains the particular parameter record setting identifier."},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"transactionCodes":[{}],"defaultFundsDiversion":"string"}},"responses":{"200":"FundsDiversionResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/holdings/nostros/forwardBalances","fullPath":"/api/v4.3.0/holdings/nostros/forwardBalances","operationId":"getNostroForwardBalances","name":"Retrieves forward balances of nostro accounts considering the transaction effective dates.","summary":"Retrieves consolidated nostro account balances","tags":[],"parameters":[{"name":"valueDate","in":"query","type":"string","required":true,"description":"Indicates the value date on which the underlying accounting entry is to be given value (for interest purposes)"},{"name":"accountId","in":"query","type":"string","required":false,"description":"Identifier of the account. Often referred to as the account number, yet for consistency this is always referred to as accountId. Accepts both IBAN & BBAN"},{"name":"longPositionSign","in":"query","type":"string","required":false,"description":"Polarity (sign) used to denote buy position balance.  "},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"NostroForwardBalancesResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/nostros/currencyBalances/{currencyId}/accounts","fullPath":"/api/v4.3.0/holdings/nostros/currencyBalances/{currencyId}/accounts","operationId":"getNostroBalances","name":"Retrieves the date wise balances of the nostro accounts that falls under a specific currency","summary":"Retrieves nostro account balances for a specific currency","tags":[],"parameters":[{"name":"currencyId","in":"path","type":"string","required":true,"description":"Identifier of the currency. This is the 3-letter ISO 4217 code of the currency."},{"name":"nostroId","in":"query","type":"string","required":false,"description":"Nostro account id"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"NostroBalancesResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/nostros/currencyBalances/{currencyId}","fullPath":"/api/v4.3.0/holdings/nostros/currencyBalances/{currencyId}","operationId":"getNostroCurrencyPositions","name":"Retrieves consolidated balances of the nostro accounts in a given currency from the current date to the next five days.","summary":"Retrieves consolidated nostro account balances for a specific currency","tags":[],"parameters":[{"name":"currencyId","in":"path","type":"string","required":true,"description":"Identifier of the currency. This is the 3-letter ISO 4217 code of the currency."},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"NostroCurrencyPositionsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/nostros/positions/{currencyId}","fullPath":"/api/v4.3.0/holdings/nostros/positions/{currencyId}","operationId":"getNostroPositions","name":"Retrieves nostro account balances for a given currency from the current date to the next five days.","summary":"Retrieves consolidated nostro account positions for the currency","tags":[],"parameters":[{"name":"currencyId","in":"path","type":"string","required":true,"description":"Identifier of the currency. This is the 3-letter ISO 4217 code of the currency."},{"name":"longPositionSign","in":"query","type":"string","required":false,"description":"Polarity (sign) used to denote buy position balance.  "},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"NostroPositionsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/accounts/reservedFunds","fullPath":"/api/v4.3.0/holdings/accounts/reservedFunds","operationId":"getReservedFunds","name":"Retrieves the reserved funds details such as reason, amount and period of reservation of the account","summary":"Retrieves the list of reserved funds","tags":[],"parameters":[{"name":"accountId","in":"query","type":"string","required":false,"description":"Identifier of the account. Often referred to as the account number, yet for consistency this is always referred to as accountId. Accepts both IBAN & BBAN"},{"name":"eventId","in":"query","type":"string","required":false,"description":"Event identifier"},{"name":"lockReason","in":"query","type":"string","required":false,"description":"Indicates the simple description for the balance reservation event."},{"name":"fromDate","in":"query","type":"string","required":false,"description":"Indicates the business date from when the balance reservation event is active."},{"name":"toDate","in":"query","type":"string","required":false,"description":"Indicates the business date until when the balance reservation event is active."},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"ReservedFundsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/accounts/{accountId}","fullPath":"/api/v4.3.0/holdings/accounts/{accountId}","operationId":"getAccountDetails","name":"Retrieves the arrangement account details such as account balances, allowed, advised and outstanding limit balances, interest types and values with the corresponding mode, frequency and value of payments","summary":"Retrieves arrangement account details","tags":[],"parameters":[{"name":"accountId","in":"path","type":"string","required":true,"description":"Identifier of the account. Often referred to as the account number, yet for consistency this is always referred to as accountId. Accepts both IBAN & BBAN"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"AccountDetailsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/accounts/proxyIdentifiers","fullPath":"/api/v4.3.0/holdings/accounts/proxyIdentifiers","operationId":"getActiveProxyIdentifier","name":"Retrieve active records from proxy directory for a given customer number or account number or proxy type and proxy identifier","summary":"Retrieve proxy registration status","tags":[],"parameters":[{"name":"customerId","in":"query","type":"string","required":false,"description":"Identifier of the customer"},{"name":"alternateAccountId","in":"query","type":"string","required":false,"description":"Alternate identification for an account"},{"name":"proxyType","in":"query","type":"string","required":false,"description":"Type of proxy created for account"},{"name":"proxyIdentifier","in":"query","type":"string","required":false,"description":"A proxy identifier to be linked to an account based on the proxy type provided eg. Mobile number, email id and tax id"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"ActiveProxyIdentifierResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"POST","path":"/holdings/accounts/proxyIdentifiers","fullPath":"/api/v4.3.0/holdings/accounts/proxyIdentifiers","operationId":"createProxyIdentifier","name":"Create a new record in proxy directory to register the supplied proxy identifiers, proxy type and scheme for a customer and account","summary":"Register the proxy identifier for the account","tags":[],"parameters":[{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"customerId":"string","accountId":"string","alternateAccountId":"string","proxyType":"string","proxyIdentifier":"string","proxyStatus":"string","proxyScheme":"string","proxyRole":"string"}},"responses":{"200":"ProxyIdentifierResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/holdings/accounts/proxyIdentifiers/{proxyIdentifierId}","fullPath":"/api/v4.3.0/holdings/accounts/proxyIdentifiers/{proxyIdentifierId}","operationId":"updateProxyIdentifier","name":"Update the specific proxy identifier to de-register the registered account or customer from the proxy directory","summary":"Update proxy directory for account to de-register the proxy identifier","tags":[],"parameters":[{"name":"proxyIdentifierId","in":"path","type":"string","required":true,"description":""},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"customerId":"string","accountId":"string","alternateAccountId":"string","proxyType":"string","proxyIdentifier":"string","proxyStatus":"string","proxyScheme":"string","proxyRole":"string"}},"responses":{"200":"ProxyIdentifierResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/holdings/accounts/{accountId}/{accountCompany}/{paymentCurrency}/{accountSwitch}/{beneficialCustomer}/payments","fullPath":"/api/v4.3.0/holdings/accounts/{accountId}/{accountCompany}/{paymentCurrency}/{accountSwitch}/{beneficialCustomer}/payments","operationId":"getAccountPaymentDetails","name":"Retrieves the account information that are required for processing or validating an account involved in a payment transaction. Provides the information such as account name, customer number, account type, account currency, IBAN, account switch details, account status (ACTIVE or INACTIVE) and account closure details.","summary":"Retrieves account details required for payment processing","tags":[],"parameters":[{"name":"accountId","in":"path","type":"string","required":true,"description":"Identifier of the account. Often referred to as the account number, yet for consistency this is always referred to as accountId. Accepts both IBAN & BBAN"},{"name":"accountCompany","in":"path","type":"string","required":true,"description":"Company of the account to be created"},{"name":"paymentCurrency","in":"path","type":"string","required":true,"description":"This field holds the transaction currency or currency in which payment is initiated. "},{"name":"accountSwitch","in":"path","type":"string","required":true,"description":"Indicates if availability of account switch details should be checked."},{"name":"beneficialCustomer","in":"path","type":"string","required":true,"description":"Indicates if beneficial owners of the account are to be retrieved"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"AccountPaymentDetailsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/accounts","fullPath":"/api/v4.3.0/holdings/accounts","operationId":"getAccounts","name":"Retrieves the currency, balances, limit details and arrangement details of an account","summary":"Retrieves list of account details","tags":[],"parameters":[{"name":"accountId","in":"query","type":"string","required":false,"description":"Identifier of the account. Often referred to as the account number, yet for consistency this is always referred to as accountId. Accepts both IBAN & BBAN"},{"name":"customerId","in":"query","type":"string","required":false,"description":"Identifier of the customer"},{"name":"productId","in":"query","type":"string","required":false,"description":"Contains the unique identifier of the product, e.g. the product id of the arrangement account."},{"name":"currencyId","in":"query","type":"string","required":false,"description":"Identifier of the currency. This is the 3-letter ISO 4217 code of the currency."},{"name":"limitReference","in":"query","type":"string","required":false,"description":"Identifies the credit limit reference for the underlying account."},{"name":"arrangementId","in":"query","type":"string","required":false,"description":"Indicates an unique identifier of an account"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"AccountsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/accounts/{contractBalanceId}/contractBalances","fullPath":"/api/v4.3.0/holdings/accounts/{contractBalanceId}/contractBalances","operationId":"getContractBalances","name":"Retrieves the contract balances of accounts or contracts with details such as contract currency, balance types, credit and debit movements and opening and closing balance of the respective balance types","summary":"Retrieves contract balances of accounts","tags":[],"parameters":[{"name":"contractBalanceId","in":"path","type":"string","required":true,"description":"Unique Identifier of Contract Balances"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"ContractBalancesResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"PUT","path":"/holdings/accounts/{accountId}/synchronizationError","fullPath":"/api/v4.3.0/holdings/accounts/{accountId}/synchronizationError","operationId":"updateSynchronizationError","name":"Updates error status during synchronization of the account between transact and funds authorisation microservice","summary":"Update synchronization error status","tags":[],"parameters":[{"name":"accountId","in":"path","type":"string","required":true,"description":"Identifier of the account. Often referred to as the account number, yet for consistency this is always referred to as accountId. Accepts both IBAN & BBAN"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"emergencyBlockError":"string"}},"responses":{"200":"SynchronizationErrorResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/holdings/accounts/{accountId}/accountSwitches/expiringSwitches","fullPath":"/api/v4.3.0/holdings/accounts/{accountId}/accountSwitches/expiringSwitches","operationId":"getExpiringAccountSwitches","name":"Retrieves the details of the expiring account switches for generating alerts such as the bank identifier code, alert date and account id of expiring switch instruction etc.","summary":"Retrieves the details of the expiring switches for generating alerts","tags":[],"parameters":[{"name":"accountId","in":"path","type":"string","required":true,"description":"The identifier of the account. Often referred to as the account number, yet for consistency this is always referred to as account id.Accepts both IBAN & BBAN"},{"name":"alertStatus","in":"query","type":"string","required":false,"description":"Contains status of the Alert. Possible values are Pending, Sent"},{"name":"alertDate","in":"query","type":"string","required":false,"description":"Indicates the date in which an alert to be raised."},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from t24 on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":""},{"name":"companyId","in":"header","type":"string","required":false,"description":"The identifier of the underlying Entity/Company/Branch."},{"name":"deviceId","in":"header","type":"string","required":false,"description":""},{"name":"userRole","in":"header","type":"string","required":false,"description":""},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"ExpiringAccountSwitchesResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/accounts/{accountId}/accountSwitches","fullPath":"/api/v4.3.0/holdings/accounts/{accountId}/accountSwitches","operationId":"getAccountSwitchDetails","name":"Retrieves details from the account switch directory for the specific account such as the expiry date, status of the switch instruction, effective date of the switch, bank identifier code and IBAN (International Bank Account Number ) etc.","summary":"Retrieves details of the account switch requests","tags":[],"parameters":[{"name":"accountId","in":"path","type":"string","required":true,"description":"The identifier of the account. Often referred to as the account number, yet for consistency this is always referred to as accountId.Accepts both IBAN & BBAN"},{"name":"requestDate","in":"query","type":"string","required":false,"description":"Date on which the client's request to be classified as professional has been received."},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from t24 on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":""},{"name":"companyId","in":"header","type":"string","required":false,"description":"The identifier of the underlying Entity/Company/Branch."},{"name":"deviceId","in":"header","type":"string","required":false,"description":""},{"name":"userRole","in":"header","type":"string","required":false,"description":""},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"AccountSwitchDetailsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"PUT","path":"/holdings/accounts/{accountId}/accountSwitches","fullPath":"/api/v4.3.0/holdings/accounts/{accountId}/accountSwitches","operationId":"updateAccountSwitchDetails","name":"Updates alert status based on the original IBAN. Used by external systems handling alert generation to mark the status from pending to sent","summary":"Updates alert status from pending to sent for corresponding switch instructions.","tags":[],"parameters":[{"name":"accountId","in":"path","type":"string","required":true,"description":"The identifier of the account. Often referred to as the account number, yet for consistency this is always referred to as accountId.Accepts both IBAN & BBAN"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":""},{"name":"companyId","in":"header","type":"string","required":false,"description":"The identifier of the underlying Entity/Company/Branch."},{"name":"deviceId","in":"header","type":"string","required":false,"description":""},{"name":"userRole","in":"header","type":"string","required":false,"description":""}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"accountId":"string","switchIBAN":"string","switchAccountId":"string","switchBic":"string","switchClearingCode":"string","requestDate":"string","status":"string","cancelInstruction":"string","cancelDate":"string","expiryDate":"string","IBAN":"string","bicId":"string","effectiveDate":"string","alertDate":"string","alertStatus":"string"}},"responses":{"200":"AccountSwitchDetailsResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/holdings/accounts/{accountId}/accountSwitches/payments","fullPath":"/api/v4.3.0/holdings/accounts/{accountId}/accountSwitches/payments","operationId":"getAccountSwitchPaymentDetails","name":"Retrieves information of the re-routed payments from the payment transaction exit point.","summary":"Retrieves rerouted payment information.","tags":[],"parameters":[{"name":"accountId","in":"path","type":"string","required":true,"description":"The identifier of the account. Often referred to as the account number, yet for consistency this is always referred to as accountId.Accepts both IBAN & BBAN"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from t24 on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":""},{"name":"companyId","in":"header","type":"string","required":false,"description":"The identifier of the underlying Entity/Company/Branch."},{"name":"deviceId","in":"header","type":"string","required":false,"description":""},{"name":"userRole","in":"header","type":"string","required":false,"description":""},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"AccountSwitchPaymentDetailsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"PUT","path":"/holdings/accounts/accountClosures/{accountId}/approvals","fullPath":"/api/v4.3.0/holdings/accounts/accountClosures/{accountId}/approvals","operationId":"approveAccountClosure","name":"Approves account closure information to allow closing of an account which is no longer in use","summary":"Approves account closure information","tags":[],"parameters":[{"name":"accountId","in":"path","type":"string","required":true,"description":"Identifier of the account. Often referred to as the account number, yet for consistency this is always referred to as accountId. Accepts both IBAN & BBAN"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"AccountClosureResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}}]},{"key":"holdings-accounts-service-v4.4.0","title":"Account management","version":"v4.4.0","description":"API to manage account related services such as retrieving balances, transaction and card details, emergency blocks, funds diversion, reservations, proxy identifiers and account closures. In addition, it provides functionality to support the capability to switch accounts from the current system to an","endpointCount":30,"endpoints":[{"method":"GET","path":"/holdings/accounts/accountClosures/{accountId}","fullPath":"/api/v4.4.0/holdings/accounts/accountClosures/{accountId}","operationId":"getAccountClosure","name":"Retrieves the account closure information of the account such as closure date and reason, mode of closure, balances on the date of closing and pending charges","summary":"Retrieves the account closure information","tags":[],"parameters":[{"name":"accountId","in":"path","type":"string","required":true,"description":"Identifier of the account. Often referred to as the account number, yet for consistency this is always referred to as accountId. Accepts both IBAN & BBAN"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"AccountClosureResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/holdings/accounts/accountClosures/{accountId}","fullPath":"/api/v4.4.0/holdings/accounts/accountClosures/{accountId}","operationId":"updateAccountClosure","name":"Updates account closure information for the specific account such as closure date and reason, mode of closure and closing charges","summary":"Updates account closure information","tags":[],"parameters":[{"name":"accountId","in":"path","type":"string","required":true,"description":"Identifier of the account. Often referred to as the account number, yet for consistency this is always referred to as accountId. Accepts both IBAN & BBAN"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"accountCurrency":"string","closureDate":"2024-01-01T00:00:00Z","creditAccount":"string","capitaliseInterest":"string","chargeType":"string","chargeAmount":0.0,"closeMode":"string","ftId":"string","closureReason":"string","closureNotes":"string","onlineLedgerBalance":0.0,"onlineClearedBalance":0.0,"balancePayable":0.0,"totalCreditInterest":"string","totalDebitInterest":"string"}},"responses":{"200":"AccountClosureResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/holdings/accounts/{accountId}/transactions","fullPath":"/api/v4.4.0/holdings/accounts/{accountId}/transactions","operationId":"getAccountTransactions","name":"Retrieves account transaction details such as transaction type, amount, transaction reference, credit or debit indicator, booking and effective date of transaction","summary":"Retrieves account transaction details","tags":[],"parameters":[{"name":"accountId","in":"path","type":"string","required":true,"description":"Identifier of the account. Often referred to as the account number, yet for consistency this is always referred to as account id. Accepts both IBAN & BBAN"},{"name":"bookingDate","in":"query","type":"string","required":false,"description":"Business date on which the accounting entry was generated."},{"name":"processingDate","in":"query","type":"string","required":false,"description":"The date when payment instruction is processed in system."},{"name":"valueDate","in":"query","type":"string","required":false,"description":"Indicates the value date on which the underlying accounting entry is to be given value (for interest purposes)"},{"name":"description","in":"query","type":"string","required":false,"description":"Contains the description of purpose of the payment."},{"name":"reversalMarker","in":"query","type":"string","required":false,"description":"Denotes the flag which is set whenever any credit or reversal debit entries with future exposure dates are processed"},{"name":"includeSubAcct","in":"query","type":"string","required":false,"description":"Denotes the flag which needs to be set in order to allow the automatic creation of sub-accounts and the automatic distribution of transactions over sub-accounts"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"AccountTransactionsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/accounts/{accountId}/cards","fullPath":"/api/v4.4.0/holdings/accounts/{accountId}/cards","operationId":"getAccountCards","name":"Retrieves the card details of the account such as card number, card type and status of the card","summary":"Retrieves available card details","tags":[],"parameters":[{"name":"accountId","in":"path","type":"string","required":true,"description":"Identifier of the account. Often referred to as the account number, yet for consistency this is always referred to as accountId. Accepts both IBAN & BBAN"},{"name":"cardIssueId","in":"query","type":"string","required":false,"description":"The identifier of the issued card formatted as cardType '.' cardNumber. E.g. VISA.1234567887654321 GC.1111222233334444 AB21.1111111122222222"},{"name":"issueDate","in":"query","type":"string","required":false,"description":"The date the item was issued."},{"name":"expiryDate","in":"query","type":"string","required":false,"description":"The date an agreement such as an arrangement, product, credit facility or limit is due to expire"},{"name":"cardStatus","in":"query","type":"string","required":false,"description":"Current status of the Card and following are the possible statuses are  - CARD.ISSUED - CARD.RETURNED - CARD.SCRAP - CARD.CANCEL - NOT.ACTIVATED - NOT.RECEIVED - ACTIVE - BLOCKED - EXPIRED"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"AccountCardsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/accounts/balances","fullPath":"/api/v4.4.0/holdings/accounts/balances","operationId":"getAccountBalanceToday","name":"Retrieves various types of balances such as cleared, online, locked and usable balance of the account","summary":"Retrieves list of account balances","tags":[],"parameters":[{"name":"accountId","in":"query","type":"string","required":false,"description":"Identifier of the account. Often referred to as the account number, yet for consistency this is always referred to as accountId. Accepts both IBAN & BBAN"},{"name":"customerId","in":"query","type":"string","required":false,"description":"Identifier of the customer"},{"name":"productId","in":"query","type":"string","required":false,"description":"Contains the unique identifier of the product, e.g. the product id of the arrangement account."},{"name":"currencyId","in":"query","type":"string","required":false,"description":"Identifier of the currency. This is the 3-letter ISO 4217 code of the currency."},{"name":"limitReferenceId","in":"query","type":"string","required":false,"description":"Limit reference identifier for the limit order."},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"AccountBalanceTodayResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/accounts/{accountId}/balanceMovements/{bookingDate}","fullPath":"/api/v4.4.0/holdings/accounts/{accountId}/balanceMovements/{bookingDate}","operationId":"getAccountBalanceMovement","name":"Retrieves the credit, debit and gross balance movements for an account for the requested booking date","summary":"Retrieves balances movements of account","tags":[],"parameters":[{"name":"accountId","in":"path","type":"string","required":true,"description":"Identifier of the account. Often referred to as the account number, yet for consistency this is always referred to as accountId. Accepts both IBAN & BBAN"},{"name":"bookingDate","in":"path","type":"string","required":true,"description":"Business date on which the accounting entry was generated."},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"AccountBalanceMovementResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/accounts/{accountId}/emergencyBlocks/status","fullPath":"/api/v4.4.0/holdings/accounts/{accountId}/emergencyBlocks/status","operationId":"getAccountEmergencyBlock","name":"Retrieve emergency block status and reason for a given account. This information will be used to assert the actual block status of an account in microservice","summary":"Retrieve emergency block information for an account","tags":[],"parameters":[{"name":"accountId","in":"path","type":"string","required":true,"description":"Identifier of the account. Often referred to as the account number, yet for consistency this is always referred to as accountId. Accepts both IBAN & BBAN"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"AccountEmergencyBlockResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"PUT","path":"/holdings/accounts/{accountId}/emergencyBlocks/status","fullPath":"/api/v4.4.0/holdings/accounts/{accountId}/emergencyBlocks/status","operationId":"updateAccountEmergencyBlock","name":"Updates emergency block status and reason for the account","summary":"Update emergency block in account","tags":[],"parameters":[{"name":"accountId","in":"path","type":"string","required":true,"description":"Identifier of the account. Often referred to as the account number, yet for consistency this is always referred to as accountId. Accepts both IBAN & BBAN"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"emergencyBlock":"string","emergencyReason":"string"}},"responses":{"200":"AccountEmergencyBlockResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/holdings/accounts/{accountId}/fundsAuthorisation/status","fullPath":"/api/v4.4.0/holdings/accounts/{accountId}/fundsAuthorisation/status","operationId":"getAccountFundsAuthStatus","name":"Retrieve the funds authorisation status from account","summary":"Retrieve account funds authorisation status","tags":[],"parameters":[{"name":"accountId","in":"path","type":"string","required":true,"description":"Identifier of the account. Often referred to as the account number, yet for consistency this is always referred to as accountId. Accepts both IBAN & BBAN"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"AccountFundsAuthStatusResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"PUT","path":"/holdings/accounts/{accountId}/fundsAuthorisation/status","fullPath":"/api/v4.4.0/holdings/accounts/{accountId}/fundsAuthorisation/status","operationId":"updateAccountFundsAuthStatus","name":"Update the funds authorisation status for the account, for example SYNC or ERROR","summary":"Update account funds authorisation status","tags":[],"parameters":[{"name":"accountId","in":"path","type":"string","required":true,"description":""},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"faStatus":"string"}},"responses":{"200":"AccountFundsAuthStatusResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"POST","path":"/holdings/accounts/settings/{settingId}/fundsDiversion","fullPath":"/api/v4.4.0/holdings/accounts/settings/{settingId}/fundsDiversion","operationId":"createFundsDiversion","name":"Allows creation of funds diversion conditions for a company to manage the behavior of booking funds against any account in the company that has the auto pay account defined","summary":"Creates conditions for funds diversion","tags":[],"parameters":[{"name":"settingId","in":"path","type":"string","required":true,"description":"Contains the particular parameter record setting identifier."},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"transactionCodes":[{}],"defaultFundsDiversion":"string"}},"responses":{"200":"FundsDiversionResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/holdings/accounts/settings/{settingId}/fundsDiversion","fullPath":"/api/v4.4.0/holdings/accounts/settings/{settingId}/fundsDiversion","operationId":"updateFundsDiversion","name":"Updates the funds diversion conditions for a company to manage the behavior of booking funds against any account in the company that has the auto pay account defined","summary":"Updates funds diversion parameter","tags":[],"parameters":[{"name":"settingId","in":"path","type":"string","required":true,"description":"Contains the particular parameter record setting identifier."},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"transactionCodes":[{}],"defaultFundsDiversion":"string"}},"responses":{"200":"FundsDiversionResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/holdings/nostros/forwardBalances","fullPath":"/api/v4.4.0/holdings/nostros/forwardBalances","operationId":"getNostroForwardBalances","name":"Retrieves forward balances of nostro accounts considering the transaction effective dates.","summary":"Retrieves consolidated nostro account balances","tags":[],"parameters":[{"name":"valueDate","in":"query","type":"string","required":true,"description":"Indicates the value date on which the underlying accounting entry is to be given value (for interest purposes)"},{"name":"accountId","in":"query","type":"string","required":false,"description":"Identifier of the account. Often referred to as the account number, yet for consistency this is always referred to as accountId. Accepts both IBAN & BBAN"},{"name":"longPositionSign","in":"query","type":"string","required":false,"description":"Polarity (sign) used to denote buy position balance.  "},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"NostroForwardBalancesResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/nostros/currencyBalances/{currencyId}/accounts","fullPath":"/api/v4.4.0/holdings/nostros/currencyBalances/{currencyId}/accounts","operationId":"getNostroBalances","name":"Retrieves the date wise balances of the nostro accounts that falls under a specific currency","summary":"Retrieves nostro account balances for a specific currency","tags":[],"parameters":[{"name":"currencyId","in":"path","type":"string","required":true,"description":"Identifier of the currency. This is the 3-letter ISO 4217 code of the currency."},{"name":"nostroId","in":"query","type":"string","required":false,"description":"Nostro account id"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"NostroBalancesResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/nostros/currencyBalances/{currencyId}","fullPath":"/api/v4.4.0/holdings/nostros/currencyBalances/{currencyId}","operationId":"getNostroCurrencyPositions","name":"Retrieves consolidated balances of the nostro accounts in a given currency from the current date to the next five days.","summary":"Retrieves consolidated nostro account balances for a specific currency","tags":[],"parameters":[{"name":"currencyId","in":"path","type":"string","required":true,"description":"Identifier of the currency. This is the 3-letter ISO 4217 code of the currency."},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"NostroCurrencyPositionsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/nostros/positions/{currencyId}","fullPath":"/api/v4.4.0/holdings/nostros/positions/{currencyId}","operationId":"getNostroPositions","name":"Retrieves nostro account balances for a given currency from the current date to the next five days.","summary":"Retrieves consolidated nostro account positions for the currency","tags":[],"parameters":[{"name":"currencyId","in":"path","type":"string","required":true,"description":"Identifier of the currency. This is the 3-letter ISO 4217 code of the currency."},{"name":"longPositionSign","in":"query","type":"string","required":false,"description":"Polarity (sign) used to denote buy position balance.  "},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"NostroPositionsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/accounts/reservedFunds","fullPath":"/api/v4.4.0/holdings/accounts/reservedFunds","operationId":"getReservedFunds","name":"Retrieves the reserved funds details such as reason, amount and period of reservation of the account","summary":"Retrieves the list of reserved funds","tags":[],"parameters":[{"name":"accountId","in":"query","type":"string","required":false,"description":"Identifier of the account. Often referred to as the account number, yet for consistency this is always referred to as accountId. Accepts both IBAN & BBAN"},{"name":"eventId","in":"query","type":"string","required":false,"description":"Event identifier"},{"name":"lockReason","in":"query","type":"string","required":false,"description":"Indicates the simple description for the balance reservation event."},{"name":"fromDate","in":"query","type":"string","required":false,"description":"Indicates the business date from when the balance reservation event is active."},{"name":"toDate","in":"query","type":"string","required":false,"description":"Indicates the business date until when the balance reservation event is active."},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"ReservedFundsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/accounts/{accountId}","fullPath":"/api/v4.4.0/holdings/accounts/{accountId}","operationId":"getAccountDetails","name":"Retrieves the arrangement account details such as account balances, allowed, advised and outstanding limit balances, interest types and values with the corresponding mode, frequency and value of payments","summary":"Retrieves arrangement account details","tags":[],"parameters":[{"name":"accountId","in":"path","type":"string","required":true,"description":"Identifier of the account. Often referred to as the account number, yet for consistency this is always referred to as accountId. Accepts both IBAN & BBAN"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"AccountDetailsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/accounts/proxyIdentifiers","fullPath":"/api/v4.4.0/holdings/accounts/proxyIdentifiers","operationId":"getActiveProxyIdentifier","name":"Retrieve active records from proxy directory for a given customer number or account number or proxy type and proxy identifier","summary":"Retrieve proxy registration status","tags":[],"parameters":[{"name":"customerId","in":"query","type":"string","required":false,"description":"Identifier of the customer"},{"name":"alternateAccountId","in":"query","type":"string","required":false,"description":"Alternate identification for an account"},{"name":"proxyType","in":"query","type":"string","required":false,"description":"Type of proxy created for account"},{"name":"proxyIdentifier","in":"query","type":"string","required":false,"description":"A proxy identifier to be linked to an account based on the proxy type provided eg. Mobile number, email id and tax id"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"ActiveProxyIdentifierResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"POST","path":"/holdings/accounts/proxyIdentifiers","fullPath":"/api/v4.4.0/holdings/accounts/proxyIdentifiers","operationId":"createProxyIdentifier","name":"Create a new record in proxy directory to register the supplied proxy identifiers, proxy type and scheme for a customer and account","summary":"Register the proxy identifier for the account","tags":[],"parameters":[{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"customerId":"string","accountId":"string","alternateAccountId":"string","proxyType":"string","proxyIdentifier":"string","proxyStatus":"string","proxyScheme":"string","proxyRole":"string"}},"responses":{"200":"ProxyIdentifierResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/holdings/accounts/proxyIdentifiers/{proxyIdentifierId}","fullPath":"/api/v4.4.0/holdings/accounts/proxyIdentifiers/{proxyIdentifierId}","operationId":"updateProxyIdentifier","name":"Update the specific proxy identifier to de-register the registered account or customer from the proxy directory","summary":"Update proxy directory for account to de-register the proxy identifier","tags":[],"parameters":[{"name":"proxyIdentifierId","in":"path","type":"string","required":true,"description":""},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"customerId":"string","accountId":"string","alternateAccountId":"string","proxyType":"string","proxyIdentifier":"string","proxyStatus":"string","proxyScheme":"string","proxyRole":"string"}},"responses":{"200":"ProxyIdentifierResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/holdings/accounts/{accountId}/{accountCompany}/{paymentCurrency}/{accountSwitch}/{beneficialCustomer}/payments","fullPath":"/api/v4.4.0/holdings/accounts/{accountId}/{accountCompany}/{paymentCurrency}/{accountSwitch}/{beneficialCustomer}/payments","operationId":"getAccountPaymentDetails","name":"Retrieves the account information that are required for processing or validating an account involved in a payment transaction. Provides the information such as account name, customer number, account type, account currency, IBAN, account switch details, account status (ACTIVE or INACTIVE) and account closure details.","summary":"Retrieves account details required for payment processing","tags":[],"parameters":[{"name":"accountId","in":"path","type":"string","required":true,"description":"Identifier of the account. Often referred to as the account number, yet for consistency this is always referred to as accountId. Accepts both IBAN & BBAN"},{"name":"accountCompany","in":"path","type":"string","required":true,"description":"Company of the account to be created"},{"name":"paymentCurrency","in":"path","type":"string","required":true,"description":"This field holds the transaction currency or currency in which payment is initiated. "},{"name":"accountSwitch","in":"path","type":"string","required":true,"description":"Indicates if availability of account switch details should be checked."},{"name":"beneficialCustomer","in":"path","type":"string","required":true,"description":"Indicates if beneficial owners of the account are to be retrieved"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"AccountPaymentDetailsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/accounts","fullPath":"/api/v4.4.0/holdings/accounts","operationId":"getAccounts","name":"Retrieves the currency, balances, limit details and arrangement details of an account","summary":"Retrieves list of account details","tags":[],"parameters":[{"name":"accountId","in":"query","type":"string","required":false,"description":"Identifier of the account. Often referred to as the account number, yet for consistency this is always referred to as accountId. Accepts both IBAN & BBAN"},{"name":"customerId","in":"query","type":"string","required":false,"description":"Identifier of the customer"},{"name":"productId","in":"query","type":"string","required":false,"description":"Contains the unique identifier of the product, e.g. the product id of the arrangement account."},{"name":"currencyId","in":"query","type":"string","required":false,"description":"Identifier of the currency. This is the 3-letter ISO 4217 code of the currency."},{"name":"currencyIdSAID","in":"query","type":"string","required":false,"description":"Indicates the criteria for the sounds like operation on the currency"},{"name":"limitReference","in":"query","type":"string","required":false,"description":"Identifies the credit limit reference for the underlying account."},{"name":"arrangementId","in":"query","type":"string","required":false,"description":"Indicates an unique identifier of an account"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"AccountsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/accounts/{contractBalanceId}/contractBalances","fullPath":"/api/v4.4.0/holdings/accounts/{contractBalanceId}/contractBalances","operationId":"getContractBalances","name":"Retrieves the contract balances of accounts or contracts with details such as contract currency, balance types, credit and debit movements and opening and closing balance of the respective balance types","summary":"Retrieves contract balances of accounts","tags":[],"parameters":[{"name":"contractBalanceId","in":"path","type":"string","required":true,"description":"Unique Identifier of Contract Balances"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"ContractBalancesResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"PUT","path":"/holdings/accounts/{accountId}/synchronizationError","fullPath":"/api/v4.4.0/holdings/accounts/{accountId}/synchronizationError","operationId":"updateSynchronizationError","name":"Updates error status during synchronization of the account between transact and funds authorisation microservice","summary":"Update synchronization error status","tags":[],"parameters":[{"name":"accountId","in":"path","type":"string","required":true,"description":"Identifier of the account. Often referred to as the account number, yet for consistency this is always referred to as accountId. Accepts both IBAN & BBAN"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"emergencyBlockError":"string"}},"responses":{"200":"SynchronizationErrorResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/holdings/accounts/{accountId}/accountSwitches/expiringSwitches","fullPath":"/api/v4.4.0/holdings/accounts/{accountId}/accountSwitches/expiringSwitches","operationId":"getExpiringAccountSwitches","name":"Retrieves the details of the expiring account switches for generating alerts such as the bank identifier code, alert date and account id of expiring switch instruction etc.","summary":"Retrieves the details of the expiring switches for generating alerts","tags":[],"parameters":[{"name":"accountId","in":"path","type":"string","required":true,"description":"The identifier of the account. Often referred to as the account number, yet for consistency this is always referred to as account id.Accepts both IBAN & BBAN"},{"name":"alertStatus","in":"query","type":"string","required":false,"description":"Contains status of the Alert. Possible values are Pending, Sent"},{"name":"alertDate","in":"query","type":"string","required":false,"description":"Indicates the date in which an alert to be raised."},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from t24 on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"The identifier of the underlying Entity/Company/Branch."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"ExpiringAccountSwitchesResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/accounts/{accountId}/accountSwitches","fullPath":"/api/v4.4.0/holdings/accounts/{accountId}/accountSwitches","operationId":"getAccountSwitchDetails","name":"Retrieves details from the account switch directory for the specific account such as the expiry date, status of the switch instruction, effective date of the switch, bank identifier code and IBAN (International Bank Account Number ) etc.","summary":"Retrieves details of the account switch requests","tags":[],"parameters":[{"name":"accountId","in":"path","type":"string","required":true,"description":"The identifier of the account. Often referred to as the account number, yet for consistency this is always referred to as accountId.Accepts both IBAN & BBAN"},{"name":"requestDate","in":"query","type":"string","required":false,"description":"Date on which the client's request to be classified as professional has been received."},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from t24 on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"The identifier of the underlying Entity/Company/Branch."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"AccountSwitchDetailsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"PUT","path":"/holdings/accounts/{accountId}/accountSwitches","fullPath":"/api/v4.4.0/holdings/accounts/{accountId}/accountSwitches","operationId":"updateAccountSwitchDetails","name":"Updates alert status based on the original IBAN. Used by external systems handling alert generation to mark the status from pending to sent","summary":"Updates alert status from pending to sent for corresponding switch instructions.","tags":[],"parameters":[{"name":"accountId","in":"path","type":"string","required":true,"description":"The identifier of the account. Often referred to as the account number, yet for consistency this is always referred to as accountId.Accepts both IBAN & BBAN"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"The identifier of the underlying Entity/Company/Branch."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"accountId":"string","switchIBAN":"string","switchAccountId":"string","switchBic":"string","switchClearingCode":"string","requestDate":"string","status":"string","cancelInstruction":"string","cancelDate":"string","expiryDate":"string","IBAN":"string","bicId":"string","effectiveDate":"string","alertDate":"string","alertStatus":"string"}},"responses":{"200":"AccountSwitchDetailsResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/holdings/accounts/{accountId}/accountSwitches/payments","fullPath":"/api/v4.4.0/holdings/accounts/{accountId}/accountSwitches/payments","operationId":"getAccountSwitchPaymentDetails","name":"Retrieves information of the re-routed payments from the payment transaction exit point.","summary":"Retrieves rerouted payment information.","tags":[],"parameters":[{"name":"accountId","in":"path","type":"string","required":true,"description":"The identifier of the account. Often referred to as the account number, yet for consistency this is always referred to as accountId.Accepts both IBAN & BBAN"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from t24 on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"The identifier of the underlying Entity/Company/Branch."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"AccountSwitchPaymentDetailsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"PUT","path":"/holdings/accounts/accountClosures/{accountId}/approvals","fullPath":"/api/v4.4.0/holdings/accounts/accountClosures/{accountId}/approvals","operationId":"approveAccountClosure","name":"Approves account closure information to allow closing of an account which is no longer in use","summary":"Approves account closure information","tags":[],"parameters":[{"name":"accountId","in":"path","type":"string","required":true,"description":"Identifier of the account. Often referred to as the account number, yet for consistency this is always referred to as accountId. Accepts both IBAN & BBAN"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"AccountClosureResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}}]},{"key":"holdings-accounts-service-v4.5.0","title":"Account management","version":"v4.5.0","description":"API to manage account related services such as retrieving balances, transaction and card details, emergency blocks, funds diversion, reservations, proxy identifiers and account closures. In addition, it provides functionality to support the capability to switch accounts from the current system to an","endpointCount":33,"endpoints":[{"method":"GET","path":"/holdings/accounts/accountClosures/{accountId}","fullPath":"/api/v4.5.0/holdings/accounts/accountClosures/{accountId}","operationId":"getAccountClosure","name":"Retrieves the account closure information of the account such as closure date and reason, mode of closure, balances on the date of closing and pending charges","summary":"Retrieves the account closure information","tags":[],"parameters":[{"name":"accountId","in":"path","type":"string","required":true,"description":"Identifier of the account. Often referred to as the account number, yet for consistency this is always referred to as accountId. Accepts both IBAN & BBAN"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"AccountClosureResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/holdings/accounts/accountClosures/{accountId}","fullPath":"/api/v4.5.0/holdings/accounts/accountClosures/{accountId}","operationId":"updateAccountClosure","name":"Updates account closure information for the specific account such as closure date and reason, mode of closure and closing charges","summary":"Updates account closure information","tags":[],"parameters":[{"name":"accountId","in":"path","type":"string","required":true,"description":"Identifier of the account. Often referred to as the account number, yet for consistency this is always referred to as accountId. Accepts both IBAN & BBAN"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"accountCurrency":"string","closureDate":"2024-01-01T00:00:00Z","creditAccount":"string","capitaliseInterest":"string","chargeType":"string","chargeAmount":0.0,"closeMode":"string","ftId":"string","closureReason":"string","closureNotes":"string","onlineLedgerBalance":0.0,"onlineClearedBalance":0.0,"balancePayable":0.0,"totalCreditInterest":"string","totalDebitInterest":"string"}},"responses":{"200":"AccountClosureResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/holdings/accounts/{accountId}/transactions","fullPath":"/api/v4.5.0/holdings/accounts/{accountId}/transactions","operationId":"getAccountTransactions","name":"Retrieves account transaction details such as transaction type, amount, transaction reference, credit or debit indicator, booking and effective date of transaction","summary":"Retrieves account transaction details","tags":[],"parameters":[{"name":"accountId","in":"path","type":"string","required":true,"description":"Identifier of the account. Often referred to as the account number, yet for consistency this is always referred to as account id. Accepts both IBAN & BBAN"},{"name":"bookingDate","in":"query","type":"string","required":false,"description":"Business date on which the accounting entry was generated."},{"name":"processingDate","in":"query","type":"string","required":false,"description":"The date when payment instruction is processed in system."},{"name":"valueDate","in":"query","type":"string","required":false,"description":"Indicates the value date on which the underlying accounting entry is to be given value (for interest purposes)"},{"name":"description","in":"query","type":"string","required":false,"description":"Contains the description of purpose of the payment."},{"name":"reversalMarker","in":"query","type":"string","required":false,"description":"Denotes the flag which is set whenever any credit or reversal debit entries with future exposure dates are processed"},{"name":"includeSubAcct","in":"query","type":"string","required":false,"description":"Denotes the flag which needs to be set in order to allow the automatic creation of sub-accounts and the automatic distribution of transactions over sub-accounts"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"AccountTransactionsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/accounts/{accountId}/cards","fullPath":"/api/v4.5.0/holdings/accounts/{accountId}/cards","operationId":"getAccountCards","name":"Retrieves the card details of the account such as card number, card type and status of the card","summary":"Retrieves available card details","tags":[],"parameters":[{"name":"accountId","in":"path","type":"string","required":true,"description":"Identifier of the account. Often referred to as the account number, yet for consistency this is always referred to as accountId. Accepts both IBAN & BBAN"},{"name":"cardIssueId","in":"query","type":"string","required":false,"description":"The identifier of the issued card formatted as cardType '.' cardNumber. E.g. VISA.1234567887654321 GC.1111222233334444 AB21.1111111122222222"},{"name":"issueDate","in":"query","type":"string","required":false,"description":"The date the item was issued."},{"name":"expiryDate","in":"query","type":"string","required":false,"description":"The date an agreement such as an arrangement, product, credit facility or limit is due to expire"},{"name":"cardStatus","in":"query","type":"string","required":false,"description":"Current status of the Card and following are the possible statuses are  - CARD.ISSUED - CARD.RETURNED - CARD.SCRAP - CARD.CANCEL - NOT.ACTIVATED - NOT.RECEIVED - ACTIVE - BLOCKED - EXPIRED"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"AccountCardsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/accounts/balances","fullPath":"/api/v4.5.0/holdings/accounts/balances","operationId":"getAccountBalanceToday","name":"Retrieves various types of balances such as cleared, online, locked and usable balance of the account","summary":"Retrieves list of account balances","tags":[],"parameters":[{"name":"accountId","in":"query","type":"string","required":false,"description":"Identifier of the account. Often referred to as the account number, yet for consistency this is always referred to as accountId. Accepts both IBAN & BBAN"},{"name":"customerId","in":"query","type":"string","required":false,"description":"Identifier of the customer"},{"name":"productId","in":"query","type":"string","required":false,"description":"Contains the unique identifier of the product, e.g. the product id of the arrangement account."},{"name":"currencyId","in":"query","type":"string","required":false,"description":"Identifier of the currency. This is the 3-letter ISO 4217 code of the currency."},{"name":"limitReferenceId","in":"query","type":"string","required":false,"description":"Limit reference identifier for the limit order."},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"AccountBalanceTodayResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/accounts/{accountId}/balanceMovements/{bookingDate}","fullPath":"/api/v4.5.0/holdings/accounts/{accountId}/balanceMovements/{bookingDate}","operationId":"getAccountBalanceMovement","name":"Retrieves the credit, debit and gross balance movements for an account for the requested booking date","summary":"Retrieves balances movements of account","tags":[],"parameters":[{"name":"accountId","in":"path","type":"string","required":true,"description":"Identifier of the account. Often referred to as the account number, yet for consistency this is always referred to as accountId. Accepts both IBAN & BBAN"},{"name":"bookingDate","in":"path","type":"string","required":true,"description":"Business date on which the accounting entry was generated."},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"AccountBalanceMovementResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/accounts/{accountId}/emergencyBlocks/status","fullPath":"/api/v4.5.0/holdings/accounts/{accountId}/emergencyBlocks/status","operationId":"getAccountEmergencyBlock","name":"Retrieve emergency block status and reason for a given account. This information will be used to assert the actual block status of an account in microservice","summary":"Retrieve emergency block information for an account","tags":[],"parameters":[{"name":"accountId","in":"path","type":"string","required":true,"description":"Identifier of the account. Often referred to as the account number, yet for consistency this is always referred to as accountId. Accepts both IBAN & BBAN"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"AccountEmergencyBlockResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"PUT","path":"/holdings/accounts/{accountId}/emergencyBlocks/status","fullPath":"/api/v4.5.0/holdings/accounts/{accountId}/emergencyBlocks/status","operationId":"updateAccountEmergencyBlock","name":"Updates emergency block status and reason for the account","summary":"Update emergency block in account","tags":[],"parameters":[{"name":"accountId","in":"path","type":"string","required":true,"description":"Identifier of the account. Often referred to as the account number, yet for consistency this is always referred to as accountId. Accepts both IBAN & BBAN"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"emergencyBlock":"string","emergencyReason":"string","extensionData":{}}},"responses":{"200":"AccountEmergencyBlockResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/holdings/accounts/{accountId}/fundsAuthorisation/status","fullPath":"/api/v4.5.0/holdings/accounts/{accountId}/fundsAuthorisation/status","operationId":"getAccountFundsAuthStatus","name":"Retrieve the funds authorisation status from account","summary":"Retrieve account funds authorisation status","tags":[],"parameters":[{"name":"accountId","in":"path","type":"string","required":true,"description":"Identifier of the account. Often referred to as the account number, yet for consistency this is always referred to as accountId. Accepts both IBAN & BBAN"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"AccountFundsAuthStatusResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"PUT","path":"/holdings/accounts/{accountId}/fundsAuthorisation/status","fullPath":"/api/v4.5.0/holdings/accounts/{accountId}/fundsAuthorisation/status","operationId":"updateAccountFundsAuthStatus","name":"Update the funds authorisation status for the account, for example SYNC or ERROR","summary":"Update account funds authorisation status","tags":[],"parameters":[{"name":"accountId","in":"path","type":"string","required":true,"description":""},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"faStatus":"string","extensionData":{}}},"responses":{"200":"AccountFundsAuthStatusResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"POST","path":"/holdings/accounts/settings/{settingId}/fundsDiversion","fullPath":"/api/v4.5.0/holdings/accounts/settings/{settingId}/fundsDiversion","operationId":"createFundsDiversion","name":"Allows creation of funds diversion conditions for a company to manage the behavior of booking funds against any account in the company that has the auto pay account defined","summary":"Creates conditions for funds diversion","tags":[],"parameters":[{"name":"settingId","in":"path","type":"string","required":true,"description":"Contains the particular parameter record setting identifier."},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"transactionCodes":[{}],"defaultFundsDiversion":"string","extensionData":{}}},"responses":{"200":"FundsDiversionResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/holdings/accounts/settings/{settingId}/fundsDiversion","fullPath":"/api/v4.5.0/holdings/accounts/settings/{settingId}/fundsDiversion","operationId":"updateFundsDiversion","name":"Updates the funds diversion conditions for a company to manage the behavior of booking funds against any account in the company that has the auto pay account defined","summary":"Updates funds diversion parameter","tags":[],"parameters":[{"name":"settingId","in":"path","type":"string","required":true,"description":"Contains the particular parameter record setting identifier."},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"transactionCodes":[{}],"defaultFundsDiversion":"string","extensionData":{}}},"responses":{"200":"FundsDiversionResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/holdings/nostros/forwardBalances","fullPath":"/api/v4.5.0/holdings/nostros/forwardBalances","operationId":"getNostroForwardBalances","name":"Retrieves forward balances of nostro accounts considering the transaction effective dates.","summary":"Retrieves consolidated nostro account balances","tags":[],"parameters":[{"name":"valueDate","in":"query","type":"string","required":true,"description":"Indicates the value date on which the underlying accounting entry is to be given value (for interest purposes)"},{"name":"accountId","in":"query","type":"string","required":false,"description":"Identifier of the account. Often referred to as the account number, yet for consistency this is always referred to as accountId. Accepts both IBAN & BBAN"},{"name":"longPositionSign","in":"query","type":"string","required":false,"description":"Polarity (sign) used to denote buy position balance.  "},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"NostroForwardBalancesResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/nostros/currencyBalances/{currencyId}/accounts","fullPath":"/api/v4.5.0/holdings/nostros/currencyBalances/{currencyId}/accounts","operationId":"getNostroBalances","name":"Retrieves the date wise balances of the nostro accounts that falls under a specific currency","summary":"Retrieves nostro account balances for a specific currency","tags":[],"parameters":[{"name":"currencyId","in":"path","type":"string","required":true,"description":"Identifier of the currency. This is the 3-letter ISO 4217 code of the currency."},{"name":"nostroId","in":"query","type":"string","required":false,"description":"Nostro account id"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"NostroBalancesResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/nostros/currencyBalances/{currencyId}","fullPath":"/api/v4.5.0/holdings/nostros/currencyBalances/{currencyId}","operationId":"getNostroCurrencyPositions","name":"Retrieves consolidated balances of the nostro accounts in a given currency from the current date to the next five days.","summary":"Retrieves consolidated nostro account balances for a specific currency","tags":[],"parameters":[{"name":"currencyId","in":"path","type":"string","required":true,"description":"Identifier of the currency. This is the 3-letter ISO 4217 code of the currency."},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"NostroCurrencyPositionsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/nostros/positions/{currencyId}","fullPath":"/api/v4.5.0/holdings/nostros/positions/{currencyId}","operationId":"getNostroPositions","name":"Retrieves nostro account balances for a given currency from the current date to the next five days.","summary":"Retrieves consolidated nostro account positions for the currency","tags":[],"parameters":[{"name":"currencyId","in":"path","type":"string","required":true,"description":"Identifier of the currency. This is the 3-letter ISO 4217 code of the currency."},{"name":"longPositionSign","in":"query","type":"string","required":false,"description":"Polarity (sign) used to denote buy position balance.  "},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"NostroPositionsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/accounts/{accountId}","fullPath":"/api/v4.5.0/holdings/accounts/{accountId}","operationId":"getAccountDetails","name":"Retrieves the arrangement account details such as account balances, allowed, advised and outstanding limit balances, interest types and values with the corresponding mode, frequency and value of payments","summary":"Retrieves arrangement account details","tags":[],"parameters":[{"name":"accountId","in":"path","type":"string","required":true,"description":"Identifier of the account. Often referred to as the account number, yet for consistency this is always referred to as accountId. Accepts both IBAN & BBAN"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"AccountDetailsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/accounts/proxyIdentifiers","fullPath":"/api/v4.5.0/holdings/accounts/proxyIdentifiers","operationId":"getActiveProxyIdentifier","name":"Retrieve active records from proxy directory for a given customer number or account number or proxy type and proxy identifier","summary":"Retrieve proxy registration status","tags":[],"parameters":[{"name":"customerId","in":"query","type":"string","required":false,"description":"Identifier of the customer"},{"name":"alternateAccountId","in":"query","type":"string","required":false,"description":"Alternate identification for an account"},{"name":"proxyType","in":"query","type":"string","required":false,"description":"Type of proxy created for account"},{"name":"proxyIdentifier","in":"query","type":"string","required":false,"description":"A proxy identifier to be linked to an account based on the proxy type provided eg. Mobile number, email id and tax id"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"ActiveProxyIdentifierResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"POST","path":"/holdings/accounts/proxyIdentifiers","fullPath":"/api/v4.5.0/holdings/accounts/proxyIdentifiers","operationId":"createProxyIdentifier","name":"Create a new record in proxy directory to register the supplied proxy identifiers, proxy type and scheme for a customer and account","summary":"Register the proxy identifier for the account","tags":[],"parameters":[{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"customerId":"string","accountId":"string","alternateAccountId":"string","proxyType":"string","proxyIdentifier":"string","proxyStatus":"string","proxyScheme":"string","proxyRole":"string","extensionData":{}}},"responses":{"200":"ProxyIdentifierResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/holdings/accounts/proxyIdentifiers/{proxyIdentifierId}","fullPath":"/api/v4.5.0/holdings/accounts/proxyIdentifiers/{proxyIdentifierId}","operationId":"updateProxyIdentifier","name":"Update the specific proxy identifier to de-register the registered account or customer from the proxy directory","summary":"Update proxy directory for account to de-register the proxy identifier","tags":[],"parameters":[{"name":"proxyIdentifierId","in":"path","type":"string","required":true,"description":""},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"customerId":"string","accountId":"string","alternateAccountId":"string","proxyType":"string","proxyIdentifier":"string","proxyStatus":"string","proxyScheme":"string","proxyRole":"string","extensionData":{}}},"responses":{"200":"ProxyIdentifierResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/holdings/accounts/{accountId}/{accountCompany}/{paymentCurrency}/{accountSwitch}/{beneficialCustomer}/payments","fullPath":"/api/v4.5.0/holdings/accounts/{accountId}/{accountCompany}/{paymentCurrency}/{accountSwitch}/{beneficialCustomer}/payments","operationId":"getAccountPaymentDetails","name":"Retrieves the account information that are required for processing or validating an account involved in a payment transaction. Provides the information such as account name, customer number, account type, account currency, IBAN, account switch details, account status (ACTIVE or INACTIVE) and account closure details.","summary":"Retrieves account details required for payment processing","tags":[],"parameters":[{"name":"accountId","in":"path","type":"string","required":true,"description":"Identifier of the account. Often referred to as the account number, yet for consistency this is always referred to as accountId. Accepts both IBAN & BBAN"},{"name":"accountCompany","in":"path","type":"string","required":true,"description":"Company of the account to be created"},{"name":"paymentCurrency","in":"path","type":"string","required":true,"description":"This field holds the transaction currency or currency in which payment is initiated. "},{"name":"accountSwitch","in":"path","type":"string","required":true,"description":"Indicates if availability of account switch details should be checked."},{"name":"beneficialCustomer","in":"path","type":"string","required":true,"description":"Indicates if beneficial owners of the account are to be retrieved"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"AccountPaymentDetailsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/accounts","fullPath":"/api/v4.5.0/holdings/accounts","operationId":"getAccounts","name":"Retrieves the currency, balances, limit details and arrangement details of an account","summary":"Retrieves list of account details","tags":[],"parameters":[{"name":"accountId","in":"query","type":"string","required":false,"description":"Identifier of the account. Often referred to as the account number, yet for consistency this is always referred to as accountId. Accepts both IBAN & BBAN"},{"name":"customerId","in":"query","type":"string","required":false,"description":"Identifier of the customer"},{"name":"productId","in":"query","type":"string","required":false,"description":"Contains the unique identifier of the product, e.g. the product id of the arrangement account."},{"name":"currencyId","in":"query","type":"string","required":false,"description":"Identifier of the currency. This is the 3-letter ISO 4217 code of the currency."},{"name":"currencyIdSAID","in":"query","type":"string","required":false,"description":"Indicates the criteria for the sounds like operation on the currency"},{"name":"limitReference","in":"query","type":"string","required":false,"description":"Identifies the credit limit reference for the underlying account."},{"name":"arrangementId","in":"query","type":"string","required":false,"description":"Indicates an unique identifier of an account"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"AccountsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/accounts/{contractBalanceId}/contractBalances","fullPath":"/api/v4.5.0/holdings/accounts/{contractBalanceId}/contractBalances","operationId":"getContractBalances","name":"Retrieves the contract balances of accounts or contracts with details such as contract currency, balance types, credit and debit movements and opening and closing balance of the respective balance types","summary":"Retrieves contract balances of accounts","tags":[],"parameters":[{"name":"contractBalanceId","in":"path","type":"string","required":true,"description":"Unique Identifier of Contract Balances"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"ContractBalancesResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"PUT","path":"/holdings/accounts/{accountId}/synchronizationError","fullPath":"/api/v4.5.0/holdings/accounts/{accountId}/synchronizationError","operationId":"updateSynchronizationError","name":"Updates error status during synchronization of the account between Transact and funds authorisation microservice","summary":"Update synchronization error status","tags":[],"parameters":[{"name":"accountId","in":"path","type":"string","required":true,"description":"Identifier of the account. Often referred to as the account number, yet for consistency this is always referred to as accountId. Accepts both IBAN & BBAN"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"emergencyBlockError":"string","extensionData":{}}},"responses":{"200":"SynchronizationErrorResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/holdings/accounts/{accountId}/accountSwitches/expiringSwitches","fullPath":"/api/v4.5.0/holdings/accounts/{accountId}/accountSwitches/expiringSwitches","operationId":"getExpiringAccountSwitches","name":"Retrieves the details of the expiring account switches for generating alerts such as the bank identifier code, alert date and account id of expiring switch instruction etc.","summary":"Retrieves the details of the expiring switches for generating alerts","tags":[],"parameters":[{"name":"accountId","in":"path","type":"string","required":true,"description":"The identifier of the account. Often referred to as the account number, yet for consistency this is always referred to as account id.Accepts both IBAN & BBAN"},{"name":"alertStatus","in":"query","type":"string","required":false,"description":"Contains status of the Alert. Possible values are Pending, Sent"},{"name":"alertDate","in":"query","type":"string","required":false,"description":"Indicates the date in which an alert to be raised."},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"The identifier of the underlying Entity/Company/Branch."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"ExpiringAccountSwitchesResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/accounts/{accountId}/accountSwitches","fullPath":"/api/v4.5.0/holdings/accounts/{accountId}/accountSwitches","operationId":"getAccountSwitchDetails","name":"Retrieves details from the account switch directory for the specific account such as the expiry date, status of the switch instruction, effective date of the switch, bank identifier code and IBAN (International Bank Account Number ) etc.","summary":"Retrieves details of the account switch requests","tags":[],"parameters":[{"name":"accountId","in":"path","type":"string","required":true,"description":"The identifier of the account. Often referred to as the account number, yet for consistency this is always referred to as accountId.Accepts both IBAN & BBAN"},{"name":"requestDate","in":"query","type":"string","required":false,"description":"Date on which the client's request to be classified as professional has been received."},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"The identifier of the underlying Entity/Company/Branch."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"AccountSwitchDetailsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"PUT","path":"/holdings/accounts/{accountId}/accountSwitches","fullPath":"/api/v4.5.0/holdings/accounts/{accountId}/accountSwitches","operationId":"updateAccountSwitchDetails","name":"Updates alert status based on the original IBAN. Used by external systems handling alert generation to mark the status from pending to sent","summary":"Updates alert status from pending to sent for corresponding switch instructions.","tags":[],"parameters":[{"name":"accountId","in":"path","type":"string","required":true,"description":"The identifier of the account. Often referred to as the account number, yet for consistency this is always referred to as accountId.Accepts both IBAN & BBAN"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"The identifier of the underlying Entity/Company/Branch."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"accountId":"string","switchIBAN":"string","switchAccountId":"string","switchBic":"string","switchClearingCode":"string","requestDate":"string","status":"string","cancelInstruction":"string","cancelDate":"string","expiryDate":"string","IBAN":"string","bicId":"string","effectiveDate":"string","alertDate":"string","alertStatus":"string"}},"responses":{"200":"AccountSwitchDetailsResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/holdings/accounts/accountClosures/{accountId}/approvals","fullPath":"/api/v4.5.0/holdings/accounts/accountClosures/{accountId}/approvals","operationId":"approveAccountClosure","name":"Approves account closure information to allow closing of an account which is no longer in use","summary":"Approves account closure information","tags":[],"parameters":[{"name":"accountId","in":"path","type":"string","required":true,"description":"Identifier of the account. Often referred to as the account number, yet for consistency this is always referred to as accountId. Accepts both IBAN & BBAN"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"AccountClosureResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/holdings/accounts/reservedFunds","fullPath":"/api/v4.5.0/holdings/accounts/reservedFunds","operationId":"getReservedFunds","name":"Retrieves the reserved funds details such as reason, amount and period of reservation of the account","summary":"Retrieves the list of reserved funds ","tags":[],"parameters":[{"name":"accountId","in":"query","type":"string","required":false,"description":"Identifier of the account. Often referred to as the account number, yet for consistency this is always referred to as accountId. Accepts both IBAN & BBAN"},{"name":"lockedEventReference","in":"query","type":"string","required":false,"description":"Captures the AC.LOCKED.EVENTS id if in case the funds is available and reserved."},{"name":"lockReason","in":"query","type":"string","required":false,"description":"Indicates the simple description for the balance reservation event."},{"name":"fromDate","in":"query","type":"string","required":false,"description":"Indicates the business date from when the balance reservation event is active."},{"name":"toDate","in":"query","type":"string","required":false,"description":"Indicates the business date until when the balance reservation event is active."},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"ReservedFundsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"POST","path":"/holdings/accounts/reservedFunds","fullPath":"/api/v4.5.0/holdings/accounts/reservedFunds","operationId":"createFundsReservation","name":"Creates a funds reservation with details such as account number, block or reserve amount, period of hold transaction, reason for holding. Funds reservations are created to block or reserve funds which restricts any debit movements affecting the account balance below the blocked amount for the specified period on an account.","summary":"Creates a credit or debit funds reservation to block the funds in an account","tags":[],"parameters":[{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"accountId":"string","lockReason":"string","fromDate":"2024-01-01","toDate":"2024-01-01","lockedAmount":"string","transactionReference":"string","transactionRetry":"string","systemId":"string","additionalDetail":"string","alternateKey":"string","reservationTypeId":"string","accountLink":"string","action":"string","creditDebitIndicator":"string","reservationIndicator":"string"}},"responses":{"200":"FundsReservationResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/holdings/accounts/reservedFunds/{lockedEventReference}","fullPath":"/api/v4.5.0/holdings/accounts/reservedFunds/{lockedEventReference}","operationId":"updateFundsReservation","name":"Update funds reservation with details such as account number, block or reserve amount, period of hold transaction, reason for holding. Funds reservations are created to block or reserve funds which restricts any debit movements affecting the account balance below the blocked amount for the specified period on an account.","summary":"Update the credit or debit funds reservation to block the funds in an account","tags":[],"parameters":[{"name":"lockedEventReference","in":"path","type":"string","required":true,"description":"Captures the AC.LOCKED.EVENTS id if in case the funds is available and reserved."},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"accountId":"string","lockReason":"string","fromDate":"2024-01-01","toDate":"2024-01-01","lockedAmount":"string","transactionReference":"string","transactionRetry":"string","systemId":"string","additionalDetail":"string","alternateKey":"string","reservationTypeId":"string","accountLink":"string","action":"string","creditDebitIndicator":"string","reservationIndicator":"string"}},"responses":{"200":"FundsReservationResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"DELETE","path":"/holdings/accounts/reservedFunds/{lockedEventReference}","fullPath":"/api/v4.5.0/holdings/accounts/reservedFunds/{lockedEventReference}","operationId":"cancelFundsReservation","name":"Cancels the funds reservation of an account. Funds reservations are created to block or reserve funds which restricts any debit movements affecting the account balance below the blocked amount for the specified period on an account. On removal of the funds reservations, the blocked or reserved amount is now available for usage.","summary":"Cancels the credit or debit funds reservation to unblock the funds in an account","tags":[],"parameters":[{"name":"lockedEventReference","in":"path","type":"string","required":true,"description":"Captures the AC.LOCKED.EVENTS id if in case the funds is available and reserved."},{"name":"payload","in":"body","type":"object","required":false,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}}},"responses":{"200":"FundsReservationResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/holdings/accounts/{accountId}/accountSwitches/payments","fullPath":"/api/v4.5.0/holdings/accounts/{accountId}/accountSwitches/payments","operationId":"getAccountSwitchPaymentDetails","name":"Retrieves information of the re-routed payments from the payment transaction exit point.","summary":"Retrieves rerouted payment information.","tags":[],"parameters":[{"name":"accountId","in":"path","type":"string","required":true,"description":"Identifier of the account. Often referred to as the account number, yet for consistency this is always referred to as accountId. Accepts both IBAN & BBAN"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"AccountSwitchPaymentDetailsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}}]},{"key":"holdings-accounts-service-v4.6.0","title":"Account management","version":"v4.6.0","description":"API to manage account related services such as retrieving balances, transaction and card details, emergency blocks, funds diversion, reservations, proxy identifiers and account closures. In addition, it provides functionality to support the capability to switch accounts from the current system to an","endpointCount":39,"endpoints":[{"method":"GET","path":"/holdings/accounts/accountClosures/{accountId}","fullPath":"/api/v4.6.0/holdings/accounts/accountClosures/{accountId}","operationId":"getAccountClosure","name":"Retrieves the account closure information of the account such as closure date and reason, mode of closure, balances on the date of closing and pending charges","summary":"Retrieves the account closure information","tags":[],"parameters":[{"name":"accountId","in":"path","type":"string","required":true,"description":"Identifier of the account. Often referred to as the account number, yet for consistency this is always referred to as account Id. Accepts both IBAN & BBAN"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"AccountClosureResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/holdings/accounts/accountClosures/{accountId}","fullPath":"/api/v4.6.0/holdings/accounts/accountClosures/{accountId}","operationId":"updateAccountClosure","name":"Updates account closure information for the specific account such as closure date and reason, mode of closure and closing charges","summary":"Updates account closure information","tags":[],"parameters":[{"name":"accountId","in":"path","type":"string","required":true,"description":"Identifier of the account. Often referred to as the account number, yet for consistency this is always referred to as accountId. Accepts both IBAN & BBAN"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"accountCurrency":"string","closureDate":"2024-01-01T00:00:00Z","creditAccount":"string","capitaliseInterest":"string","chargeType":"string","chargeAmount":0.0,"closeMode":"string","ftId":"string","closureReason":"string","closureNotes":"string","onlineLedgerBalance":0.0,"onlineClearedBalance":0.0,"balancePayable":0.0,"totalCreditInterest":"string","totalDebitInterest":"string"}},"responses":{"200":"AccountClosureResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/holdings/accounts/{accountId}/transactions","fullPath":"/api/v4.6.0/holdings/accounts/{accountId}/transactions","operationId":"getAccountTransactions","name":"Retrieves account transaction details such as transaction type, amount, transaction reference, credit or debit indicator, booking and effective date of transaction","summary":"Retrieves account transaction details","tags":[],"parameters":[{"name":"accountId","in":"path","type":"string","required":true,"description":"Identifier of the account. Often referred to as the account number, yet for consistency this is always referred to as accountId. Accepts both IBAN & BBAN"},{"name":"bookingDate","in":"query","type":"string","required":false,"description":"Business date on which the accounting entry was generated."},{"name":"processingDate","in":"query","type":"string","required":false,"description":"The date when payment instruction is processed in system."},{"name":"valueDate","in":"query","type":"string","required":false,"description":"Indicates the value date on which the underlying accounting entry is to be given value (for interest purposes)"},{"name":"description","in":"query","type":"string","required":false,"description":"Contains the description of purpose of the payment."},{"name":"reversalMarker","in":"query","type":"string","required":false,"description":"Denotes the flag which is set whenever any credit or reversal debit entries with future exposure dates are processed"},{"name":"includeSubAcct","in":"query","type":"string","required":false,"description":"Denotes the flag which needs to be set in order to allow the automatic creation of sub-accounts and the automatic distribution of transactions over sub-accounts"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"AccountTransactionsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/accounts/{accountId}/cards","fullPath":"/api/v4.6.0/holdings/accounts/{accountId}/cards","operationId":"getAccountCards","name":"Retrieves the card details of the account such as card number, card type and status of the card","summary":"Retrieves available card details","tags":[],"parameters":[{"name":"accountId","in":"path","type":"string","required":true,"description":"Identifier of the account. Often referred to as the account number, yet for consistency this is always referred to as accountId. Accepts both IBAN & BBAN"},{"name":"cardIssueId","in":"query","type":"string","required":false,"description":"The identifier of the issued card formatted as cardType '.' cardNumber. E.g. VISA.1234567887654321 GC.1111222233334444 AB21.1111111122222222"},{"name":"issueDate","in":"query","type":"string","required":false,"description":"The date the item was issued."},{"name":"expiryDate","in":"query","type":"string","required":false,"description":"The date an agreement such as an arrangement, product, credit facility or limit is due to expire"},{"name":"cardStatus","in":"query","type":"string","required":false,"description":"Current status of the Card and following are the possible statuses are  - CARD.ISSUED - CARD.RETURNED - CARD.SCRAP - CARD.CANCEL - NOT.ACTIVATED - NOT.RECEIVED - ACTIVE - BLOCKED - EXPIRED"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"AccountCardsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/accounts/balances","fullPath":"/api/v4.6.0/holdings/accounts/balances","operationId":"getAccountBalanceToday","name":"Retrieves various types of balances such as cleared, online, locked and usable balance of the account","summary":"Retrieves list of account balances","tags":[],"parameters":[{"name":"accountId","in":"query","type":"string","required":false,"description":"Identifier of the account. Often referred to as the account number, yet for consistency this is always referred to as accountId. Accepts both IBAN & BBAN"},{"name":"customerId","in":"query","type":"string","required":false,"description":"Identifier of the customer"},{"name":"productId","in":"query","type":"string","required":false,"description":"Contains the unique identifier of the product, e.g. the product id of the arrangement account."},{"name":"currencyId","in":"query","type":"string","required":false,"description":"Identifier of the currency. This is the 3-letter ISO 4217 code of the currency."},{"name":"limitReferenceId","in":"query","type":"string","required":false,"description":"Limit reference identifier for the limit order."},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"AccountBalanceTodayResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/accounts/{accountId}/balanceMovements/{bookingDate}","fullPath":"/api/v4.6.0/holdings/accounts/{accountId}/balanceMovements/{bookingDate}","operationId":"getAccountBalanceMovement","name":"Retrieves the credit, debit and gross balance movements for an account for the requested booking date","summary":"Retrieves balances movements of account","tags":[],"parameters":[{"name":"accountId","in":"path","type":"string","required":true,"description":"Identifier of the account. Often referred to as the account number, yet for consistency this is always referred to as accountId. Accepts both IBAN & BBAN"},{"name":"bookingDate","in":"path","type":"string","required":true,"description":"Business date on which the accounting entry was generated."},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"AccountBalanceMovementResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/accounts/{accountId}/emergencyBlocks/status","fullPath":"/api/v4.6.0/holdings/accounts/{accountId}/emergencyBlocks/status","operationId":"getAccountEmergencyBlock","name":"Retrieve emergency block status and reason for a given account. This information will be used to assert the actual block status of an account in microservice","summary":"Retrieve emergency block information for an account","tags":[],"parameters":[{"name":"accountId","in":"path","type":"string","required":true,"description":"Identifier of the account. Often referred to as the account number, yet for consistency this is always referred to as accountId. Accepts both IBAN & BBAN"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"AccountEmergencyBlockResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"PUT","path":"/holdings/accounts/{accountId}/emergencyBlocks/status","fullPath":"/api/v4.6.0/holdings/accounts/{accountId}/emergencyBlocks/status","operationId":"updateAccountEmergencyBlock","name":"Updates emergency block status and reason for block of the account","summary":"Update emergency block in account","tags":[],"parameters":[{"name":"accountId","in":"path","type":"string","required":true,"description":""},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"emergencyBlock":"string","emergencyReason":"string","extensionData":{}}},"responses":{"200":"AccountEmergencyBlockResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/holdings/accounts/{accountId}/fundsAuthorisation/status","fullPath":"/api/v4.6.0/holdings/accounts/{accountId}/fundsAuthorisation/status","operationId":"getAccountFundsAuthStatus","name":"Retrieve the funds authorisation status of the account","summary":"Retrieve account funds authorisation status","tags":[],"parameters":[{"name":"accountId","in":"path","type":"string","required":true,"description":"Identifier of the account. Often referred to as the account number, yet for consistency this is always referred to as accountId. Accepts both IBAN & BBAN"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"AccountFundsAuthStatusResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"PUT","path":"/holdings/accounts/{accountId}/fundsAuthorisation/status","fullPath":"/api/v4.6.0/holdings/accounts/{accountId}/fundsAuthorisation/status","operationId":"updateAccountFundsAuthStatus","name":"Update the funds authorisation status for the account, for example SYNC or ERROR","summary":"Update account funds authorisation status","tags":[],"parameters":[{"name":"accountId","in":"path","type":"string","required":true,"description":""},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"faStatus":"string","extensionData":{}}},"responses":{"200":"AccountFundsAuthStatusResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"POST","path":"/holdings/accounts/settings/{settingId}/fundsDiversion","fullPath":"/api/v4.6.0/holdings/accounts/settings/{settingId}/fundsDiversion","operationId":"createFundsDiversion","name":"Allows creation of funds diversion conditions for a company to manage the behavior of booking funds against any account in the company that has the auto pay account defined","summary":"Creates conditions for funds diversion","tags":[],"parameters":[{"name":"settingId","in":"path","type":"string","required":true,"description":"Contains the particular parameter record setting identifier."},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"transactionCodes":[{}],"defaultFundsDiversion":"string","extensionData":{}}},"responses":{"200":"FundsDiversionResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/holdings/accounts/settings/{settingId}/fundsDiversion","fullPath":"/api/v4.6.0/holdings/accounts/settings/{settingId}/fundsDiversion","operationId":"updateFundsDiversion","name":"Updates the funds diversion conditions for a company to manage the behavior of booking funds against any account in the company that has the auto pay account defined","summary":"Updates funds diversion parameter","tags":[],"parameters":[{"name":"settingId","in":"path","type":"string","required":true,"description":"Contains the particular parameter record setting identifier."},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"transactionCodes":[{}],"defaultFundsDiversion":"string","extensionData":{}}},"responses":{"200":"FundsDiversionResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/holdings/nostros/forwardBalances","fullPath":"/api/v4.6.0/holdings/nostros/forwardBalances","operationId":"getNostroForwardBalances","name":"Retrieves forward balances of nostro accounts considering the transaction effective dates.","summary":"Retrieves consolidated nostro account balances","tags":[],"parameters":[{"name":"valueDate","in":"query","type":"string","required":false,"description":"Indicates the value date on which the underlying accounting entry is to be given value (for interest purposes)"},{"name":"accountId","in":"query","type":"string","required":true,"description":"Identifier of the account. Often referred to as the account number, yet for consistency this is always referred to as accountId. Accepts both IBAN & BBAN"},{"name":"longPositionSign","in":"query","type":"string","required":false,"description":"Polarity (sign) used to denote buy position balance.  "},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"NostroForwardBalancesResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/nostros/currencyBalances/{currencyId}/accounts","fullPath":"/api/v4.6.0/holdings/nostros/currencyBalances/{currencyId}/accounts","operationId":"getNostroBalances","name":"Retrieves the date wise balances of the nostro accounts that falls under a specific currency","summary":"Retrieves nostro account balances for a specific currency","tags":[],"parameters":[{"name":"currencyId","in":"path","type":"string","required":true,"description":"Identifier of the currency. This is the 3-letter ISO 4217 code of the currency."},{"name":"nostroId","in":"query","type":"string","required":false,"description":"Nostro account id"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"NostroBalancesResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/nostros/currencyBalances/{currencyId}","fullPath":"/api/v4.6.0/holdings/nostros/currencyBalances/{currencyId}","operationId":"getNostroCurrencyPositions","name":"Retrieves consolidated balances of the nostro accounts in a given currency from the current date to the next five days.","summary":"Retrieves consolidated nostro account balances for a specific currency","tags":[],"parameters":[{"name":"currencyId","in":"path","type":"string","required":true,"description":"Identifier of the currency. This is the 3-letter ISO 4217 code of the currency."},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"NostroCurrencyPositionsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/nostros/positions/{currencyId}","fullPath":"/api/v4.6.0/holdings/nostros/positions/{currencyId}","operationId":"getNostroPositions","name":"Retrieves nostro account balances for a given currency from the current date to the next five days.","summary":"Retrieves consolidated nostro account positions for the currency","tags":[],"parameters":[{"name":"currencyId","in":"path","type":"string","required":true,"description":"Identifier of the currency. This is the 3-letter ISO 4217 code of the currency."},{"name":"longPositionSign","in":"query","type":"string","required":false,"description":"Polarity (sign) used to denote buy position balance.  "},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"NostroPositionsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/accounts/{accountId}","fullPath":"/api/v4.6.0/holdings/accounts/{accountId}","operationId":"getAccountDetails","name":"Retrieves the arrangement account details such as account balances, allowed, advised and outstanding limit balances, interest types and values with the corresponding mode, frequency and value of payments","summary":"Retrieves arrangement account details","tags":[],"parameters":[{"name":"accountId","in":"path","type":"string","required":true,"description":"Identifier of the account. Often referred to as the account number, yet for consistency this is always referred to as accountId. Accepts both IBAN & BBAN"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"AccountDetailsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/accounts/proxyIdentifiers","fullPath":"/api/v4.6.0/holdings/accounts/proxyIdentifiers","operationId":"getActiveProxyIdentifier","name":"Retrieve active records from proxy directory for a given customer number or account number or proxy type and proxy identifier","summary":"Retrieve proxy registration status","tags":[],"parameters":[{"name":"customerId","in":"query","type":"string","required":false,"description":"Identifier of the customer"},{"name":"alternateAccountId","in":"query","type":"string","required":false,"description":"Contains the Uniform Banking Code of the arrangement"},{"name":"proxyType","in":"query","type":"string","required":false,"description":"Type of proxy created for account"},{"name":"proxyIdentifier","in":"query","type":"string","required":false,"description":"A proxy identifier to be linked to an account based on the proxy type provided eg. Mobile number, email id and tax id"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"ActiveProxyIdentifierResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"POST","path":"/holdings/accounts/proxyIdentifiers","fullPath":"/api/v4.6.0/holdings/accounts/proxyIdentifiers","operationId":"createProxyIdentifier","name":"Create a new record in proxy directory to register the supplied proxy identifiers, proxy type and scheme for a customer and account","summary":"Register the proxy identifier for the account","tags":[],"parameters":[{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"customerId":"string","accountId":"string","alternateAccountId":"string","proxyType":"string","proxyIdentifier":"string","proxyStatus":"string","proxyScheme":"string","proxyRole":"string","extensionData":{}}},"responses":{"200":"ProxyIdentifierResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/holdings/accounts/proxyIdentifiers/{proxyIdentifierId}","fullPath":"/api/v4.6.0/holdings/accounts/proxyIdentifiers/{proxyIdentifierId}","operationId":"updateProxyIdentifier","name":"Update the specific proxy identifier to de-register the registered account or customer from the proxy directory","summary":"Update proxy directory for account to de-register the proxy identifier","tags":[],"parameters":[{"name":"proxyIdentifierId","in":"path","type":"string","required":true,"description":""},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"customerId":"string","accountId":"string","alternateAccountId":"string","proxyType":"string","proxyIdentifier":"string","proxyStatus":"string","proxyScheme":"string","proxyRole":"string","extensionData":{}}},"responses":{"200":"ProxyIdentifierResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/holdings/accounts/{accountId}/{accountCompany}/{paymentCurrency}/{accountSwitch}/{beneficialCustomer}/payments","fullPath":"/api/v4.6.0/holdings/accounts/{accountId}/{accountCompany}/{paymentCurrency}/{accountSwitch}/{beneficialCustomer}/payments","operationId":"getAccountPaymentDetails","name":"Retrieves the account information that are required for processing or validating an account involved in a payment transaction. Provides the information such as account name, customer number, account type, account currency, IBAN, account switch details, account status (ACTIVE or INACTIVE) and account closure details.","summary":"Retrieves account details required for payment processing","tags":[],"parameters":[{"name":"accountId","in":"path","type":"string","required":true,"description":"Identifier of the account. Often referred to as the account number, yet for consistency this is always referred to as accountId. Accepts both IBAN & BBAN"},{"name":"accountCompany","in":"path","type":"string","required":true,"description":"Company of the account to be created"},{"name":"paymentCurrency","in":"path","type":"string","required":true,"description":"This field holds the transaction currency or currency in which payment is initiated. "},{"name":"accountSwitch","in":"path","type":"string","required":true,"description":"Indicates if availability of account switch details should be checked."},{"name":"beneficialCustomer","in":"path","type":"string","required":true,"description":"Indicates if beneficial owners of the account are to be retrieved"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"AccountPaymentDetailsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/accounts","fullPath":"/api/v4.6.0/holdings/accounts","operationId":"getAccounts","name":"Retrieves the currency, balances, limit details and arrangement details of the account","summary":"Retrieves list of account basic details","tags":[],"parameters":[{"name":"accountId","in":"query","type":"string","required":false,"description":"Identifier of the account. Often referred to as the account number, yet for consistency this is always referred to as accountId. Accepts both IBAN & BBAN"},{"name":"customerId","in":"query","type":"string","required":false,"description":"Identifier of the customer"},{"name":"productId","in":"query","type":"string","required":false,"description":"Contains the unique identifier of the product, e.g. the product id of the arrangement account."},{"name":"currencyId","in":"query","type":"string","required":false,"description":"Identifier of the currency. This is the 3-letter ISO 4217 code of the currency."},{"name":"currencyIdSAID","in":"query","type":"string","required":false,"description":"Indicates the criteria for the sounds like operation on the currency"},{"name":"limitReference","in":"query","type":"string","required":false,"description":"Identifies the credit limit reference for the underlying account."},{"name":"arrangementId","in":"query","type":"string","required":false,"description":"Indicates an unique identifier of an account"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"AccountsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/accounts/{contractBalanceId}/contractBalances","fullPath":"/api/v4.6.0/holdings/accounts/{contractBalanceId}/contractBalances","operationId":"getContractBalances","name":"Retrieves the contract balances of accounts or contracts with details such as contract currency, balance types, credit and debit movements and opening and closing balance of the respective balance types","summary":"Retrieves contract balances of accounts","tags":[],"parameters":[{"name":"contractBalanceId","in":"path","type":"string","required":true,"description":"Unique Identifier of Contract Balances"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"ContractBalancesResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"PUT","path":"/holdings/accounts/{accountId}/synchronizationError","fullPath":"/api/v4.6.0/holdings/accounts/{accountId}/synchronizationError","operationId":"updateSynchronizationError","name":"Updates error status during synchronization of the account between Transact and Funds authorization microservice","summary":"Update synchronization error status","tags":[],"parameters":[{"name":"accountId","in":"path","type":"string","required":true,"description":"Identifier of the account. Often referred to as the account number, yet for consistency this is always referred to as accountId. Accepts both IBAN & BBAN"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"emergencyBlockError":"string","extensionData":{}}},"responses":{"200":"SynchronizationErrorResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/holdings/accounts/{accountId}/accountSwitches/expiringSwitches","fullPath":"/api/v4.6.0/holdings/accounts/{accountId}/accountSwitches/expiringSwitches","operationId":"getExpiringAccountSwitches","name":"Retrieves the details of the expiring account switches for generating alerts such as the bank identifier code, alert date and account Id of expiring switch instruction etc.","summary":"Retrieves the details of the expiring switches for generating alerts","tags":[],"parameters":[{"name":"accountId","in":"path","type":"string","required":true,"description":"Identifier of the account. Often referred to as the account number, yet for consistency this is always referred to as accountId. Accepts both IBAN & BBAN"},{"name":"alertStatus","in":"query","type":"string","required":false,"description":"Contains status of the Alert to be raised for switching instruction. Possible values are Pending, Sent."},{"name":"alertDate","in":"query","type":"string","required":false,"description":"Indicates the date in which an alert to be raised for a switching instruction."},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"ExpiringAccountSwitchesResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/accounts/{accountId}/accountSwitches","fullPath":"/api/v4.6.0/holdings/accounts/{accountId}/accountSwitches","operationId":"getAccountSwitchDetails","name":"Retrieves details from the account switch directory for the specific account such as the expiry date, status of the switch instruction, effective date of the switch, bank identifier code and IBAN (International Bank Account Number ) etc.","summary":"Retrieves details of the account switch requests","tags":[],"parameters":[{"name":"accountId","in":"path","type":"string","required":true,"description":"Identifier of the account. Often referred to as the account number, yet for consistency this is always referred to as accountId. Accepts both IBAN & BBAN"},{"name":"requestDate","in":"query","type":"string","required":false,"description":"Date on which the client's request to be classified as professional has been received."},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"AccountSwitchDetailsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"PUT","path":"/holdings/accounts/{accountId}/accountSwitches","fullPath":"/api/v4.6.0/holdings/accounts/{accountId}/accountSwitches","operationId":"updateAccountSwitchDetails","name":"Updates alert status based on the original IBAN. Used by external systems handling alert generation to mark the status from pending to sent","summary":"Updates alert status from pending to sent for corresponding switch instructions.","tags":[],"parameters":[{"name":"accountId","in":"path","type":"string","required":true,"description":"Identifier of the account. Often referred to as the account number, yet for consistency this is always referred to as accountId. Accepts both IBAN & BBAN"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"accountId":"string","switchIBAN":"string","switchAccountId":"string","switchBic":"string","switchClearingCode":"string","requestDate":"string","status":"string","cancelInstruction":"string","cancelDate":"string","expiryDate":"string","IBAN":"string","bicId":"string","effectiveDate":"string","alertDate":"string","alertStatus":"string"}},"responses":{"200":"AccountSwitchDetailsResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/holdings/accounts/{accountId}/accountSwitches/payments","fullPath":"/api/v4.6.0/holdings/accounts/{accountId}/accountSwitches/payments","operationId":"getAccountSwitchPaymentDetails","name":"Retrieves information of the re-routed payments from the payment transaction exit point.","summary":"Retrieves rerouted payment information.","tags":[],"parameters":[{"name":"accountId","in":"path","type":"string","required":true,"description":"Identifier of the account. Often referred to as the account number, yet for consistency this is always referred to as accountId. Accepts both IBAN & BBAN"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"AccountSwitchPaymentDetailsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"PUT","path":"/holdings/accounts/accountClosures/{accountId}/approvals","fullPath":"/api/v4.6.0/holdings/accounts/accountClosures/{accountId}/approvals","operationId":"approveAccountClosure","name":"Approves account closure information to allow closing of an account which is no longer in use","summary":"Approves account closure information","tags":[],"parameters":[{"name":"accountId","in":"path","type":"string","required":true,"description":"Identifier of the account. Often referred to as the account number, yet for consistency this is always referred to as accountId. Accepts both IBAN & BBAN"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"AccountClosureResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/holdings/accounts/reservedFunds","fullPath":"/api/v4.6.0/holdings/accounts/reservedFunds","operationId":"getReservedFunds","name":"Retrieves the reserved funds details such as reason, amount and period of reservation of the account","summary":"Retrieves the list of reserved funds ","tags":[],"parameters":[{"name":"accountId","in":"query","type":"string","required":false,"description":"Identifier of the account. Often referred to as the account number, yet for consistency this is always referred to as accountId. Accepts both IBAN & BBAN"},{"name":"lockedEventReference","in":"query","type":"string","required":false,"description":"Captures the AC.LOCKED.EVENTS id if in case the funds is available and reserved."},{"name":"lockReason","in":"query","type":"string","required":false,"description":"Indicates the simple description for the balance reservation event."},{"name":"fromDate","in":"query","type":"string","required":false,"description":"Indicates the business date from when the balance reservation event is active."},{"name":"toDate","in":"query","type":"string","required":false,"description":"Indicates the business date until when the balance reservation event is active."},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"ReservedFundsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"POST","path":"/holdings/accounts/reservedFunds","fullPath":"/api/v4.6.0/holdings/accounts/reservedFunds","operationId":"createFundsReservation","name":"Creates a funds reservation with details such as account number, block or reserve amount, period of hold transaction, reason for holding. Funds reservations are created to block or reserve funds which restricts any debit movements affecting the account balance below the blocked amount for the specified period on an account.","summary":"Creates a credit or debit funds reservation to block the funds in an account","tags":[],"parameters":[{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"accountId":"string","lockReason":"string","fromDate":"2024-01-01","toDate":"2024-01-01","lockedAmount":"string","transactionReference":"string","transactionRetry":"string","systemId":"string","additionalDetail":"string","alternateKey":"string","reservationTypeId":"string","accountLink":"string","action":"string","creditDebitIndicator":"string","reservationIndicator":"string"}},"responses":{"200":"FundsReservationResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/holdings/accounts/reservedFunds/{lockedEventReference}","fullPath":"/api/v4.6.0/holdings/accounts/reservedFunds/{lockedEventReference}","operationId":"updateFundsReservation","name":"Update funds reservation with details such as account number, block or reserve amount, period of hold transaction, reason for holding. Funds reservations are created to block or reserve funds which restricts any debit movements affecting the account balance below the blocked amount for the specified period on an account.","summary":"Update the credit or debit funds reservation to block the funds in an account","tags":[],"parameters":[{"name":"lockedEventReference","in":"path","type":"string","required":true,"description":"Captures the AC.LOCKED.EVENTS id if in case the funds is available and reserved."},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"accountId":"string","lockReason":"string","fromDate":"2024-01-01","toDate":"2024-01-01","lockedAmount":"string","transactionReference":"string","transactionRetry":"string","systemId":"string","additionalDetail":"string","alternateKey":"string","reservationTypeId":"string","accountLink":"string","action":"string","creditDebitIndicator":"string","reservationIndicator":"string"}},"responses":{"200":"FundsReservationResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"DELETE","path":"/holdings/accounts/reservedFunds/{lockedEventReference}","fullPath":"/api/v4.6.0/holdings/accounts/reservedFunds/{lockedEventReference}","operationId":"cancelFundsReservation","name":"Cancels the funds reservation of an account. Funds reservations are created to block or reserve funds which restricts any debit movements affecting the account balance below the blocked amount for the specified period on an account. On removal of the funds reservations, the blocked or reserved amount is now available for usage.","summary":"Cancels the credit or debit funds reservation to unblock the funds in an account","tags":[],"parameters":[{"name":"lockedEventReference","in":"path","type":"string","required":true,"description":"Captures the AC.LOCKED.EVENTS id if in case the funds is available and reserved."},{"name":"payload","in":"body","type":"object","required":false,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}}},"responses":{"200":"FundsReservationResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"POST","path":"/holdings/accounts/internalAccounts/{accountId}","fullPath":"/api/v4.6.0/holdings/accounts/internalAccounts/{accountId}","operationId":"createInternalAccount","name":"Create bank internal account with mandatory details such as account title, short title, mnemonic, account officer. The internal accounts are created and maintained for bank's internal operations such as interbranch, intercompany transactions.","summary":"Create bank internal account","tags":[],"parameters":[{"name":"accountId","in":"path","type":"string","required":true,"description":"Identifier of the account. Often referred to as the account number, yet for consistency this is always referred to as accountId. Accepts both IBAN & BBAN"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"otherOfficers":[{}],"postingRestrictIds":[{}],"alternateAcctDetails":[{}],"categoryId":"string","accountTitle":"string","accountTitle2":"string","shortTitle":"string","mnemonic":"string","positionType":"string","accountOfficer":"string","highVolumeTransaction":"string","extensionData":{}}},"responses":{"200":"InternalAccountResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/holdings/accounts/internalAccounts/{accountId}","fullPath":"/api/v4.6.0/holdings/accounts/internalAccounts/{accountId}","operationId":"updateInternalAccount","name":"Update bank internal account with details such as short title, account officer, account title, high volume transaction flag, alternate account id, posting restriction. The internal accounts are created and maintained for bank's internal operations such as interbranch, intercompany transactions. ","summary":"Update bank internal account","tags":[],"parameters":[{"name":"accountId","in":"path","type":"string","required":true,"description":"Identifier of the account. Often referred to as the account number, yet for consistency this is always referred to as accountId. Accepts both IBAN & BBAN"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"otherOfficers":[{}],"postingRestrictIds":[{}],"alternateAcctDetails":[{}],"categoryId":"string","accountTitle":"string","accountTitle2":"string","shortTitle":"string","mnemonic":"string","accountOfficer":"string","highVolumeTransaction":"string","extensionData":{}}},"responses":{"200":"InternalAccountResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/holdings/accounts/nostroAccounts","fullPath":"/api/v4.6.0/holdings/accounts/nostroAccounts","operationId":"getNostroAccounts","name":"Retrieves the currency, balance and category details of the nostro account","summary":"Retrieves list of nostro account details","tags":[],"parameters":[{"name":"accountId","in":"query","type":"string","required":false,"description":"Identifier of the account. Often referred to as the account number, yet for consistency this is always referred to as accountId. Accepts both IBAN & BBAN"},{"name":"customerId","in":"query","type":"string","required":false,"description":"Identifier of the customer"},{"name":"productId","in":"query","type":"string","required":false,"description":"Contains the unique identifier of the product, e.g. the product id of the arrangement account."},{"name":"currencyId","in":"query","type":"string","required":false,"description":"Identifier of the currency. This is the 3-letter ISO 4217 code of the currency."},{"name":"limitReference","in":"query","type":"string","required":false,"description":"Identifies the credit limit reference for the underlying account."},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"NostroAccountsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"POST","path":"/holdings/accounts/nostroAccounts","fullPath":"/api/v4.6.0/holdings/accounts/nostroAccounts","operationId":"createNostroAccount","name":"Create nostro account with mandatory details such as customer, currency, account title, account officer, short title, reconcile account. A nostro account is the shadow or mirror account of the vostro account maintained by the correspondent bank. The nostro account is opened with the correspondent bank as the customer.","summary":"Create nostro account","tags":[],"parameters":[{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"otherOfficers":[{}],"postingRestrictIds":[{}],"customerId":"string","accountTitle":"string","accountTitle2":"string","shortTitle":"string","mnemonic":"string","positionType":"string","currencyId":"string","accountOfficer":"string","reconcileNostroAccount":"string","ownNostro":"string","reconciliationToleranceAmount":"string","highVolumeTransaction":"string","extensionData":{}}},"responses":{"200":"NostroAccountResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/holdings/accounts/internalAccounts","fullPath":"/api/v4.6.0/holdings/accounts/internalAccounts","operationId":"getInternalAccounts","name":"Retrieves the currency, balance and category details of the internal account","summary":"Retrieves list of internal account details","tags":[],"parameters":[{"name":"accountId","in":"query","type":"string","required":false,"description":"Identifier of the account. Often referred to as the account number, yet for consistency this is always referred to as accountId. Accepts both IBAN & BBAN"},{"name":"productId","in":"query","type":"string","required":false,"description":"Contains the unique identifier of the product, e.g. the product id of the arrangement account."},{"name":"currencyId","in":"query","type":"string","required":false,"description":"Identifier of the currency. This is the 3-letter ISO 4217 code of the currency."},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"InternalAccountsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"PUT","path":"/holdings/accounts/nostroAccounts/{accountId}","fullPath":"/api/v4.6.0/holdings/accounts/nostroAccounts/{accountId}","operationId":"updateNostroAccount","name":"Update nostro account with details such as reconciliation tolerance amount, our actual account number, short title, account officer, account title, high volume transaction flag, posting restriction. A nostro account is the shadow or mirror account of the vostro account maintained by the correspondent bank. The nostro account is opened with the correspondent bank as the customer.","summary":"Update Nostro account","tags":[],"parameters":[{"name":"accountId","in":"path","type":"string","required":true,"description":"Identifier of the account. Often referred to as the account number, yet for consistency this is always referred to as accountId. Accepts both IBAN & BBAN"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"otherOfficers":[{}],"postingRestrictIds":[{}],"customerId":"string","accountTitle":"string","accountTitle2":"string","shortTitle":"string","mnemonic":"string","accountOfficer":"string","ownNostro":"string","reconciliationToleranceAmount":"string","highVolumeTransaction":"string","extensionData":{}}},"responses":{"200":"NostroAccountResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}}]},{"key":"holdings-accounts-service-v4.7.0","title":"Account management","version":"v4.7.0","description":"API to manage account related services such as retrieving balances, transaction and card details, emergency blocks, funds diversion, reservations, proxy identifiers and account closures. In addition, it provides functionality to support the capability to switch accounts from the current system to an","endpointCount":39,"endpoints":[{"method":"GET","path":"/holdings/accounts/accountClosures/{accountId}","fullPath":"/api/v4.7.0/holdings/accounts/accountClosures/{accountId}","operationId":"getAccountClosure","name":"Retrieves the account closure information of the account such as closure date and reason, mode of closure, balances on the date of closing and pending charges","summary":"Retrieves the account closure information","tags":[],"parameters":[{"name":"accountId","in":"path","type":"string","required":true,"description":"Identifier of the account. Often referred to as the account number, yet for consistency this is always referred to as account id. Accepts both IBAN & BBAN"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"AccountClosureResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/holdings/accounts/accountClosures/{accountId}","fullPath":"/api/v4.7.0/holdings/accounts/accountClosures/{accountId}","operationId":"updateAccountClosure","name":"Updates account closure information for the specific account such as closure date and reason, mode of closure and closing charges","summary":"Updates account closure information","tags":[],"parameters":[{"name":"accountId","in":"path","type":"string","required":true,"description":"Identifier of the account. Often referred to as the account number, yet for consistency this is always referred to as account id. Accepts both IBAN & BBAN"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"accountCurrency":"string","closureDate":"2024-01-01T00:00:00Z","creditAccount":"string","capitaliseInterest":"string","chargeType":"string","chargeAmount":0.0,"closeMode":"string","ftId":"string","closureReason":"string","closureNotes":"string","onlineLedgerBalance":0.0,"onlineClearedBalance":0.0,"balancePayable":0.0,"totalCreditInterest":"string","totalDebitInterest":"string"}},"responses":{"200":"AccountClosureResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/holdings/accounts/{accountId}/transactions","fullPath":"/api/v4.7.0/holdings/accounts/{accountId}/transactions","operationId":"getAccountTransactions","name":"Retrieves account transaction details such as transaction type, amount, transaction reference, credit or debit indicator, booking and effective date of transaction","summary":"Retrieves account transaction details","tags":[],"parameters":[{"name":"accountId","in":"path","type":"string","required":true,"description":"Identifier of the account. Often referred to as the account number, yet for consistency this is always referred to as account id. Accepts both IBAN & BBAN"},{"name":"bookingDate","in":"query","type":"string","required":false,"description":"Business date on which the accounting entry was generated."},{"name":"processingDate","in":"query","type":"string","required":false,"description":"The date when payment instruction is processed in system."},{"name":"valueDate","in":"query","type":"string","required":false,"description":"Indicates the value date on which the underlying accounting entry is to be given value (for interest purposes)"},{"name":"description","in":"query","type":"string","required":false,"description":"Contains the description of purpose of the payment."},{"name":"reversalMarker","in":"query","type":"string","required":false,"description":"Denotes the flag which is set whenever any credit or reversal debit entries with future exposure dates are processed"},{"name":"includeSubAcct","in":"query","type":"string","required":false,"description":"Denotes the flag which needs to be set in order to allow the automatic creation of sub-accounts and the automatic distribution of transactions over sub-accounts"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"AccountTransactionsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/accounts/{accountId}/cards","fullPath":"/api/v4.7.0/holdings/accounts/{accountId}/cards","operationId":"getAccountCards","name":"Retrieves the card details of the account such as card number, card type and status of the card","summary":"Retrieves available card details","tags":[],"parameters":[{"name":"accountId","in":"path","type":"string","required":true,"description":"Identifier of the account. Often referred to as the account number, yet for consistency this is always referred to as account id. Accepts both IBAN & BBAN"},{"name":"cardIssueId","in":"query","type":"string","required":false,"description":"The identifier of the issued card formatted as cardType '.' cardNumber. E.g. VISA.1234567887654321 GC.1111222233334444 AB21.1111111122222222"},{"name":"issueDate","in":"query","type":"string","required":false,"description":"The date the item was issued."},{"name":"expiryDate","in":"query","type":"string","required":false,"description":"The date an agreement such as an arrangement, product, credit facility or limit is due to expire"},{"name":"cardStatus","in":"query","type":"string","required":false,"description":"Current status of the Card and following are the possible statuses are  - CARD.ISSUED - CARD.RETURNED - CARD.SCRAP - CARD.CANCEL - NOT.ACTIVATED - NOT.RECEIVED - ACTIVE - BLOCKED - EXPIRED"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"AccountCardsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/accounts/balances","fullPath":"/api/v4.7.0/holdings/accounts/balances","operationId":"getAccountBalanceToday","name":"Retrieves various types of balances such as cleared, online, locked and usable balance of the account","summary":"Retrieves list of account balances","tags":[],"parameters":[{"name":"accountId","in":"query","type":"string","required":false,"description":"Identifier of the account. Often referred to as the account number, yet for consistency this is always referred to as account id. Accepts both IBAN & BBAN"},{"name":"customerId","in":"query","type":"string","required":false,"description":"Identifier of the customer"},{"name":"productId","in":"query","type":"string","required":false,"description":"Contains the unique identifier of the product, e.g. the product id of the arrangement account."},{"name":"currencyId","in":"query","type":"string","required":false,"description":"Identifier of the currency. This is the 3-letter ISO 4217 code of the currency."},{"name":"limitReferenceId","in":"query","type":"string","required":false,"description":"Limit reference identifier for the limit order."},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"AccountBalanceTodayResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/accounts/{accountId}/balanceMovements/{bookingDate}","fullPath":"/api/v4.7.0/holdings/accounts/{accountId}/balanceMovements/{bookingDate}","operationId":"getAccountBalanceMovement","name":"Retrieves the credit, debit and gross balance movements for an account for the requested booking date","summary":"Retrieves balances movements of account","tags":[],"parameters":[{"name":"accountId","in":"path","type":"string","required":true,"description":"Identifier of the account. Often referred to as the account number, yet for consistency this is always referred to as account id. Accepts both IBAN & BBAN"},{"name":"bookingDate","in":"path","type":"string","required":true,"description":"Business date on which the accounting entry was generated."},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"AccountBalanceMovementResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/accounts/{accountId}/emergencyBlocks/status","fullPath":"/api/v4.7.0/holdings/accounts/{accountId}/emergencyBlocks/status","operationId":"getAccountEmergencyBlock","name":"Retrieve emergency block status and reason for a given account. This information will be used to assert the actual block status of an account in microservice","summary":"Retrieve emergency block information for an account","tags":[],"parameters":[{"name":"accountId","in":"path","type":"string","required":true,"description":"Identifier of the account. Often referred to as the account number, yet for consistency this is always referred to as account id. Accepts both IBAN & BBAN"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"AccountEmergencyBlockResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"PUT","path":"/holdings/accounts/{accountId}/emergencyBlocks/status","fullPath":"/api/v4.7.0/holdings/accounts/{accountId}/emergencyBlocks/status","operationId":"updateAccountEmergencyBlock","name":"Updates emergency block status and reason for block of the account","summary":"Update emergency block in account","tags":[],"parameters":[{"name":"accountId","in":"path","type":"string","required":true,"description":""},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"emergencyBlock":"string","emergencyReason":"string","extensionData":{}}},"responses":{"200":"AccountEmergencyBlockResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/holdings/accounts/{accountId}/fundsAuthorisation/status","fullPath":"/api/v4.7.0/holdings/accounts/{accountId}/fundsAuthorisation/status","operationId":"getAccountFundsAuthStatus","name":"Retrieve the funds authorisation status of the account","summary":"Retrieve account funds authorisation status","tags":[],"parameters":[{"name":"accountId","in":"path","type":"string","required":true,"description":"Identifier of the account. Often referred to as the account number, yet for consistency this is always referred to as account id. Accepts both IBAN & BBAN"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"AccountFundsAuthStatusResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"PUT","path":"/holdings/accounts/{accountId}/fundsAuthorisation/status","fullPath":"/api/v4.7.0/holdings/accounts/{accountId}/fundsAuthorisation/status","operationId":"updateAccountFundsAuthStatus","name":"Update the funds authorisation status for the account, for example SYNC or ERROR","summary":"Update account funds authorisation status","tags":[],"parameters":[{"name":"accountId","in":"path","type":"string","required":true,"description":""},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"faStatus":"string","extensionData":{}}},"responses":{"200":"AccountFundsAuthStatusResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"POST","path":"/holdings/accounts/settings/{settingId}/fundsDiversion","fullPath":"/api/v4.7.0/holdings/accounts/settings/{settingId}/fundsDiversion","operationId":"createFundsDiversion","name":"Allows creation of funds diversion conditions for a company to manage the behavior of booking funds against any account in the company that has the auto pay account defined","summary":"Creates conditions for funds diversion","tags":[],"parameters":[{"name":"settingId","in":"path","type":"string","required":true,"description":"Contains the particular parameter record setting identifier."},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"transactionCodes":[{}],"defaultFundsDiversion":"string","extensionData":{}}},"responses":{"200":"FundsDiversionResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/holdings/accounts/settings/{settingId}/fundsDiversion","fullPath":"/api/v4.7.0/holdings/accounts/settings/{settingId}/fundsDiversion","operationId":"updateFundsDiversion","name":"Updates the funds diversion conditions for a company to manage the behavior of booking funds against any account in the company that has the auto pay account defined","summary":"Updates funds diversion parameter","tags":[],"parameters":[{"name":"settingId","in":"path","type":"string","required":true,"description":"Contains the particular parameter record setting identifier."},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"transactionCodes":[{}],"defaultFundsDiversion":"string","extensionData":{}}},"responses":{"200":"FundsDiversionResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/holdings/nostros/forwardBalances","fullPath":"/api/v4.7.0/holdings/nostros/forwardBalances","operationId":"getNostroForwardBalances","name":"Retrieves forward balances of nostro accounts considering the transaction effective dates.","summary":"Retrieves consolidated nostro account balances","tags":[],"parameters":[{"name":"valueDate","in":"query","type":"string","required":false,"description":"Indicates the value date on which the underlying accounting entry is to be given value (for interest purposes)"},{"name":"accountId","in":"query","type":"string","required":true,"description":"Identifier of the account. Often referred to as the account number, yet for consistency this is always referred to as account id. Accepts both IBAN & BBAN"},{"name":"longPositionSign","in":"query","type":"string","required":false,"description":"Polarity (sign) used to denote buy position balance.  "},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"NostroForwardBalancesResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/nostros/currencyBalances/{currencyId}/accounts","fullPath":"/api/v4.7.0/holdings/nostros/currencyBalances/{currencyId}/accounts","operationId":"getNostroBalances","name":"Retrieves the date wise balances of the nostro accounts that falls under a specific currency","summary":"Retrieves nostro account balances for a specific currency","tags":[],"parameters":[{"name":"currencyId","in":"path","type":"string","required":true,"description":"Identifier of the currency. This is the 3-letter ISO 4217 code of the currency."},{"name":"nostroId","in":"query","type":"string","required":false,"description":"Nostro account id"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"NostroBalancesResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/nostros/currencyBalances/{currencyId}","fullPath":"/api/v4.7.0/holdings/nostros/currencyBalances/{currencyId}","operationId":"getNostroCurrencyPositions","name":"Retrieves consolidated balances of the nostro accounts in a given currency from the current date to the next five days.","summary":"Retrieves consolidated nostro account balances for a specific currency","tags":[],"parameters":[{"name":"currencyId","in":"path","type":"string","required":true,"description":"Identifier of the currency. This is the 3-letter ISO 4217 code of the currency."},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"NostroCurrencyPositionsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/accounts/{accountId}","fullPath":"/api/v4.7.0/holdings/accounts/{accountId}","operationId":"getAccountDetails","name":"Retrieves the arrangement account details such as account balances, allowed, advised and outstanding limit balances, interest types and values with the corresponding mode, frequency and value of payments","summary":"Retrieves arrangement account details","tags":[],"parameters":[{"name":"accountId","in":"path","type":"string","required":true,"description":"Identifier of the account. Often referred to as the account number, yet for consistency this is always referred to as account id. Accepts both IBAN & BBAN"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"AccountDetailsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/accounts/proxyIdentifiers","fullPath":"/api/v4.7.0/holdings/accounts/proxyIdentifiers","operationId":"getActiveProxyIdentifier","name":"Retrieve active records from proxy directory for a given customer number or account number or proxy type and proxy identifier","summary":"Retrieve proxy registration status","tags":[],"parameters":[{"name":"customerId","in":"query","type":"string","required":false,"description":"Identifier of the customer"},{"name":"alternateAccountId","in":"query","type":"string","required":false,"description":"Contains the Uniform Banking Code of the arrangement"},{"name":"proxyType","in":"query","type":"string","required":false,"description":"Type of proxy created for account"},{"name":"proxyIdentifier","in":"query","type":"string","required":false,"description":"A proxy identifier to be linked to an account based on the proxy type provided eg. Mobile number, email id and tax id"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"ActiveProxyIdentifierResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"POST","path":"/holdings/accounts/proxyIdentifiers","fullPath":"/api/v4.7.0/holdings/accounts/proxyIdentifiers","operationId":"createProxyIdentifier","name":"Create a new record in proxy directory to register the supplied proxy identifiers, proxy type and scheme for a customer and account","summary":"Register the proxy identifier for the account","tags":[],"parameters":[{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"customerId":"string","accountId":"string","alternateAccountId":"string","proxyType":"string","proxyIdentifier":"string","proxyStatus":"string","proxyScheme":"string","proxyRole":"string","extensionData":{}}},"responses":{"200":"ProxyIdentifierResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/holdings/accounts/proxyIdentifiers/{proxyIdentifierId}","fullPath":"/api/v4.7.0/holdings/accounts/proxyIdentifiers/{proxyIdentifierId}","operationId":"updateProxyIdentifier","name":"Update the specific proxy identifier to de-register the registered account or customer from the proxy directory","summary":"Update proxy directory for account to de-register the proxy identifier","tags":[],"parameters":[{"name":"proxyIdentifierId","in":"path","type":"string","required":true,"description":""},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"customerId":"string","accountId":"string","alternateAccountId":"string","proxyType":"string","proxyIdentifier":"string","proxyStatus":"string","proxyScheme":"string","proxyRole":"string","extensionData":{}}},"responses":{"200":"ProxyIdentifierResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/holdings/accounts/{accountId}/{accountCompany}/{paymentCurrency}/{accountSwitch}/{beneficialCustomer}/payments","fullPath":"/api/v4.7.0/holdings/accounts/{accountId}/{accountCompany}/{paymentCurrency}/{accountSwitch}/{beneficialCustomer}/payments","operationId":"getAccountPaymentDetails","name":"Retrieves the account information that are required for processing or validating an account involved in a payment transaction. Provides the information such as account name, customer number, account type, account currency, IBAN, account switch details, account status (ACTIVE or INACTIVE) and account closure details.","summary":"Retrieves account details required for payment processing","tags":[],"parameters":[{"name":"accountId","in":"path","type":"string","required":true,"description":"Identifier of the account. Often referred to as the account number, yet for consistency this is always referred to as account id. Accepts both IBAN & BBAN"},{"name":"accountCompany","in":"path","type":"string","required":true,"description":"Company of the account to be created"},{"name":"paymentCurrency","in":"path","type":"string","required":true,"description":"This field holds the transaction currency or currency in which payment is initiated. "},{"name":"accountSwitch","in":"path","type":"string","required":true,"description":"Indicates if availability of account switch details should be checked."},{"name":"beneficialCustomer","in":"path","type":"string","required":true,"description":"Indicates if beneficial owners of the account are to be retrieved"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"AccountPaymentDetailsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/accounts","fullPath":"/api/v4.7.0/holdings/accounts","operationId":"getAccounts","name":"Retrieves the currency, balances, limit details and arrangement details of the account","summary":"Retrieves list of account basic details","tags":[],"parameters":[{"name":"accountId","in":"query","type":"string","required":false,"description":"Identifier of the account. Often referred to as the account number, yet for consistency this is always referred to as account id. Accepts both IBAN & BBAN"},{"name":"customerId","in":"query","type":"string","required":false,"description":"Identifier of the customer"},{"name":"productId","in":"query","type":"string","required":false,"description":"Contains the unique identifier of the product, e.g. the product id of the arrangement account."},{"name":"currencyId","in":"query","type":"string","required":false,"description":"Identifier of the currency. This is the 3-letter ISO 4217 code of the currency."},{"name":"currencyIdSAID","in":"query","type":"string","required":false,"description":"Indicates the criteria for the sounds like operation on the currency"},{"name":"limitReference","in":"query","type":"string","required":false,"description":"Identifies the credit limit reference for the underlying account."},{"name":"arrangementId","in":"query","type":"string","required":false,"description":"Indicates an unique identifier of an account"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"AccountsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/accounts/{contractBalanceId}/contractBalances","fullPath":"/api/v4.7.0/holdings/accounts/{contractBalanceId}/contractBalances","operationId":"getContractBalances","name":"Retrieves the contract balances of accounts or contracts with details such as contract currency, balance types, credit and debit movements and opening and closing balance of the respective balance types","summary":"Retrieves contract balances of accounts","tags":[],"parameters":[{"name":"contractBalanceId","in":"path","type":"string","required":true,"description":"Unique Identifier of Contract Balances"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"ContractBalancesResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"PUT","path":"/holdings/accounts/{accountId}/synchronizationError","fullPath":"/api/v4.7.0/holdings/accounts/{accountId}/synchronizationError","operationId":"updateSynchronizationError","name":"Updates error status during synchronization of the account between Transact and Funds authorization microservice.","summary":"Update synchronization error status","tags":[],"parameters":[{"name":"accountId","in":"path","type":"string","required":true,"description":"Identifier of the account. Often referred to as the account number, yet for consistency this is always referred to as account id. Accepts both IBAN & BBAN"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"emergencyBlockError":"string","extensionData":{}}},"responses":{"200":"SynchronizationErrorResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/holdings/accounts/{accountId}/accountSwitches/expiringSwitches","fullPath":"/api/v4.7.0/holdings/accounts/{accountId}/accountSwitches/expiringSwitches","operationId":"getExpiringAccountSwitches","name":"Retrieves the details of the expiring account switches for generating alerts such as the bank identifier code, alert date and account id of expiring switch instruction etc.","summary":"Retrieves the details of the expiring switches for generating alerts","tags":[],"parameters":[{"name":"accountId","in":"path","type":"string","required":true,"description":"Identifier of the account. Often referred to as the account number, yet for consistency this is always referred to as account id. Accepts both IBAN & BBAN"},{"name":"alertStatus","in":"query","type":"string","required":false,"description":"Contains status of the Alert to be raised for switching instruction. Possible values are Pending, Sent."},{"name":"alertDate","in":"query","type":"string","required":false,"description":"Indicates the date in which an alert to be raised for a switching instruction."},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"ExpiringAccountSwitchesResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/accounts/{accountId}/accountSwitches","fullPath":"/api/v4.7.0/holdings/accounts/{accountId}/accountSwitches","operationId":"getAccountSwitchDetails","name":"Retrieves details from the account switch directory for the specific account such as the expiry date, status of the switch instruction, effective date of the switch, bank identifier code and IBAN (International Bank Account Number ) etc.","summary":"Retrieves details of the account switch requests","tags":[],"parameters":[{"name":"accountId","in":"path","type":"string","required":true,"description":"Identifier of the account. Often referred to as the account number, yet for consistency this is always referred to as account id. Accepts both IBAN & BBAN"},{"name":"requestDate","in":"query","type":"string","required":false,"description":"Date on which the client's request to be classified as professional has been received."},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"AccountSwitchDetailsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"PUT","path":"/holdings/accounts/{accountId}/accountSwitches","fullPath":"/api/v4.7.0/holdings/accounts/{accountId}/accountSwitches","operationId":"updateAccountSwitchDetails","name":"Updates alert status based on the original IBAN. Used by external systems handling alert generation to mark the status from pending to sent","summary":"Updates alert status from pending to sent for corresponding switch instructions.","tags":[],"parameters":[{"name":"accountId","in":"path","type":"string","required":true,"description":"Identifier of the account. Often referred to as the account number, yet for consistency this is always referred to as account id. Accepts both IBAN & BBAN"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"accountId":"string","switchIBAN":"string","switchAccountId":"string","switchBic":"string","switchClearingCode":"string","requestDate":"string","status":"string","cancelInstruction":"string","cancelDate":"string","expiryDate":"string","IBAN":"string","bicId":"string","effectiveDate":"string","alertDate":"string","alertStatus":"string"}},"responses":{"200":"AccountSwitchDetailsResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/holdings/accounts/{accountId}/accountSwitches/payments","fullPath":"/api/v4.7.0/holdings/accounts/{accountId}/accountSwitches/payments","operationId":"getAccountSwitchPaymentDetails","name":"Retrieves information of the re-routed payments from the payment transaction exit point.","summary":"Retrieves rerouted payment information.","tags":[],"parameters":[{"name":"accountId","in":"path","type":"string","required":true,"description":"Identifier of the account. Often referred to as the account number, yet for consistency this is always referred to as account id. Accepts both IBAN & BBAN"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"AccountSwitchPaymentDetailsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"PUT","path":"/holdings/accounts/accountClosures/{accountId}/approvals","fullPath":"/api/v4.7.0/holdings/accounts/accountClosures/{accountId}/approvals","operationId":"approveAccountClosure","name":"Approves account closure information to allow closing of an account which is no longer in use","summary":"Approves account closure information","tags":[],"parameters":[{"name":"accountId","in":"path","type":"string","required":true,"description":"Identifier of the account. Often referred to as the account number, yet for consistency this is always referred to as account id. Accepts both IBAN & BBAN"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"AccountClosureResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/holdings/accounts/reservedFunds","fullPath":"/api/v4.7.0/holdings/accounts/reservedFunds","operationId":"getReservedFunds","name":"Retrieves the reserved funds details such as reason, amount and period of reservation of the account","summary":"Retrieves the list of reserved funds ","tags":[],"parameters":[{"name":"accountId","in":"query","type":"string","required":false,"description":"Identifier of the account. Often referred to as the account number, yet for consistency this is always referred to as account id. Accepts both IBAN & BBAN"},{"name":"lockedEventReference","in":"query","type":"string","required":false,"description":"Captures the AC.LOCKED.EVENTS id if in case the funds is available and reserved."},{"name":"lockReason","in":"query","type":"string","required":false,"description":"Indicates the simple description for the balance reservation event."},{"name":"fromDate","in":"query","type":"string","required":false,"description":"Indicates the business date from when the balance reservation event is active."},{"name":"toDate","in":"query","type":"string","required":false,"description":"Indicates the business date until when the balance reservation event is active."},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"ReservedFundsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"POST","path":"/holdings/accounts/reservedFunds","fullPath":"/api/v4.7.0/holdings/accounts/reservedFunds","operationId":"createFundsReservation","name":"Creates a funds reservation with details such as account number, block or reserve amount, period of hold transaction, reason for holding. Funds reservations are created to block or reserve funds which restricts any debit movements affecting the account balance below the blocked amount for the specified period on an account.","summary":"Creates a credit or debit funds reservation to block the funds in an account","tags":[],"parameters":[{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"accountId":"string","lockReason":"string","fromDate":"2024-01-01","toDate":"2024-01-01","lockedAmount":"string","transactionReference":"string","transactionRetry":"string","systemId":"string","additionalDetail":"string","alternateKey":"string","reservationTypeId":"string","accountLink":"string","action":"string","creditDebitIndicator":"string","reservationIndicator":"string"}},"responses":{"200":"FundsReservationResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/holdings/accounts/reservedFunds/{lockedEventReference}","fullPath":"/api/v4.7.0/holdings/accounts/reservedFunds/{lockedEventReference}","operationId":"updateFundsReservation","name":"Update funds reservation with details such as account number, block or reserve amount, period of hold transaction, reason for holding. Funds reservations are created to block or reserve funds which restricts any debit movements affecting the account balance below the blocked amount for the specified period on an account.","summary":"Update the credit or debit funds reservation to block the funds in an account","tags":[],"parameters":[{"name":"lockedEventReference","in":"path","type":"string","required":true,"description":"Captures the AC.LOCKED.EVENTS id if in case the funds is available and reserved."},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"accountId":"string","lockReason":"string","fromDate":"2024-01-01","toDate":"2024-01-01","lockedAmount":"string","transactionReference":"string","transactionRetry":"string","systemId":"string","additionalDetail":"string","alternateKey":"string","reservationTypeId":"string","accountLink":"string","action":"string","creditDebitIndicator":"string","reservationIndicator":"string"}},"responses":{"200":"FundsReservationResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"DELETE","path":"/holdings/accounts/reservedFunds/{lockedEventReference}","fullPath":"/api/v4.7.0/holdings/accounts/reservedFunds/{lockedEventReference}","operationId":"cancelFundsReservation","name":"Cancels the funds reservation of an account. Funds reservations are created to block or reserve funds which restricts any debit movements affecting the account balance below the blocked amount for the specified period on an account. On removal of the funds reservations, the blocked or reserved amount is now available for usage.","summary":"Cancels the credit or debit funds reservation to unblock the funds in an account","tags":[],"parameters":[{"name":"lockedEventReference","in":"path","type":"string","required":true,"description":"Captures the AC.LOCKED.EVENTS id if in case the funds is available and reserved."},{"name":"payload","in":"body","type":"object","required":false,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}}},"responses":{"200":"FundsReservationResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"POST","path":"/holdings/accounts/internalAccounts/{accountId}","fullPath":"/api/v4.7.0/holdings/accounts/internalAccounts/{accountId}","operationId":"createInternalAccount","name":"Create bank internal account with mandatory details such as account title, short title, mnemonic, account officer. The internal accounts are created and maintained for bank's internal operations such as interbranch, intercompany transactions.","summary":"Create bank internal account","tags":[],"parameters":[{"name":"accountId","in":"path","type":"string","required":true,"description":"Identifier of the account. Often referred to as the account number, yet for consistency this is always referred to as account id. Accepts both IBAN & BBAN"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"otherOfficers":[{}],"postingRestrictIds":[{}],"alternateAcctDetails":[{}],"categoryId":"string","accountTitle":"string","accountTitle2":"string","shortTitle":"string","mnemonic":"string","positionType":"string","accountOfficer":"string","highVolumeTransaction":"string","extensionData":{}}},"responses":{"200":"InternalAccountResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/holdings/accounts/internalAccounts/{accountId}","fullPath":"/api/v4.7.0/holdings/accounts/internalAccounts/{accountId}","operationId":"updateInternalAccount","name":"Update bank internal account with details such as short title, account officer, account title, high volume transaction flag, alternate account id, posting restriction. The internal accounts are created and maintained for bank's internal operations such as interbranch, intercompany transactions. ","summary":"Update bank internal account","tags":[],"parameters":[{"name":"accountId","in":"path","type":"string","required":true,"description":"Identifier of the account. Often referred to as the account number, yet for consistency this is always referred to as account id. Accepts both IBAN & BBAN"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"otherOfficers":[{}],"postingRestrictIds":[{}],"alternateAcctDetails":[{}],"categoryId":"string","accountTitle":"string","accountTitle2":"string","shortTitle":"string","mnemonic":"string","accountOfficer":"string","highVolumeTransaction":"string","extensionData":{}}},"responses":{"200":"InternalAccountResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/holdings/accounts/nostroAccounts","fullPath":"/api/v4.7.0/holdings/accounts/nostroAccounts","operationId":"getNostroAccounts","name":"Retrieves the currency, balance and category details of the nostro account","summary":"Retrieves list of nostro account details","tags":[],"parameters":[{"name":"accountId","in":"query","type":"string","required":false,"description":"Identifier of the account. Often referred to as the account number, yet for consistency this is always referred to as account id. Accepts both IBAN & BBAN"},{"name":"customerId","in":"query","type":"string","required":false,"description":"Identifier of the customer"},{"name":"productId","in":"query","type":"string","required":false,"description":"Contains the unique identifier of the product, e.g. the product id of the arrangement account."},{"name":"currencyId","in":"query","type":"string","required":false,"description":"Identifier of the currency. This is the 3-letter ISO 4217 code of the currency."},{"name":"limitReference","in":"query","type":"string","required":false,"description":"Identifies the credit limit reference for the underlying account."},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"NostroAccountsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"POST","path":"/holdings/accounts/nostroAccounts","fullPath":"/api/v4.7.0/holdings/accounts/nostroAccounts","operationId":"createNostroAccount","name":"Create nostro account with mandatory details such as customer, currency, account title, account officer, short title, reconcile account. A nostro account is the shadow or mirror account of the vostro account maintained by the correspondent bank. The nostro account is opened with the correspondent bank as the customer.","summary":"Create nostro account","tags":[],"parameters":[{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"otherOfficers":[{}],"postingRestrictIds":[{}],"customerId":"string","accountTitle":"string","accountTitle2":"string","shortTitle":"string","mnemonic":"string","positionType":"string","currencyId":"string","accountOfficer":"string","reconcileNostroAccount":"string","ownNostro":"string","reconciliationToleranceAmount":"string","highVolumeTransaction":"string","extensionData":{}}},"responses":{"200":"NostroAccountResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/holdings/accounts/internalAccounts","fullPath":"/api/v4.7.0/holdings/accounts/internalAccounts","operationId":"getInternalAccounts","name":"Retrieves the currency, balance and category details of the internal account","summary":"Retrieves list of internal account details","tags":[],"parameters":[{"name":"accountId","in":"query","type":"string","required":false,"description":"Identifier of the account. Often referred to as the account number, yet for consistency this is always referred to as account id. Accepts both IBAN & BBAN"},{"name":"productId","in":"query","type":"string","required":false,"description":"Contains the unique identifier of the product, e.g. the product id of the arrangement account."},{"name":"currencyId","in":"query","type":"string","required":false,"description":"Identifier of the currency. This is the 3-letter ISO 4217 code of the currency."},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"InternalAccountsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"PUT","path":"/holdings/accounts/nostroAccounts/{accountId}","fullPath":"/api/v4.7.0/holdings/accounts/nostroAccounts/{accountId}","operationId":"updateNostroAccount","name":"Update nostro account with details such as reconciliation tolerance amount, our actual account number, short title, account officer, account title, high volume transaction flag, posting restriction. A nostro account is the shadow or mirror account of the vostro account maintained by the correspondent bank. The nostro account is opened with the correspondent bank as the customer.","summary":"Update Nostro account","tags":[],"parameters":[{"name":"accountId","in":"path","type":"string","required":true,"description":"Identifier of the account. Often referred to as the account number, yet for consistency this is always referred to as account id. Accepts both IBAN & BBAN"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"otherOfficers":[{}],"postingRestrictIds":[{}],"customerId":"string","accountTitle":"string","accountTitle2":"string","shortTitle":"string","mnemonic":"string","accountOfficer":"string","ownNostro":"string","reconciliationToleranceAmount":"string","highVolumeTransaction":"string","extensionData":{}}},"responses":{"200":"NostroAccountResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/holdings/nostros/positions/{currencyId}","fullPath":"/api/v4.7.0/holdings/nostros/positions/{currencyId}","operationId":"getNostroPositions","name":"Retrieves nostro account balances for a given currency from the current date to the next five days.","summary":"Retrieves consolidated nostro account positions for the currency","tags":[],"parameters":[{"name":"currencyId","in":"path","type":"string","required":true,"description":"Identifier of the currency. This is the 3-letter ISO 4217 code of the currency."},{"name":"longPositionSign","in":"query","type":"string","required":false,"description":"Polarity (sign) used to denote buy position balance.  "},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"NostroPositionsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}}]},{"key":"holdings-accounts-service-v4.8.0","title":"Account management","version":"v4.8.0","description":"API to manage account related services such as retrieving balances, transaction and card details, emergency blocks, funds diversion, reservations, proxy identifiers and account closures. In addition, it provides functionality to support the capability to switch accounts from the current system to an","endpointCount":42,"endpoints":[{"method":"GET","path":"/holdings/accounts/accountClosures/{accountId}","fullPath":"/api/v4.8.0/holdings/accounts/accountClosures/{accountId}","operationId":"getAccountClosure","name":"Retrieves the account closure information of the account such as closure date and reason, mode of closure, balances on the date of closing and pending charges","summary":"Retrieves the account closure information","tags":[],"parameters":[{"name":"accountId","in":"path","type":"string","required":true,"description":"Identifier of the account. Often referred to as the account number, yet for consistency this is always referred to as account id. Accepts both IBAN & BBAN"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"AccountClosureResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/holdings/accounts/accountClosures/{accountId}","fullPath":"/api/v4.8.0/holdings/accounts/accountClosures/{accountId}","operationId":"updateAccountClosure","name":"Updates account closure information for the specific account such as closure date and reason, mode of closure and closing charges","summary":"Updates account closure information","tags":[],"parameters":[{"name":"accountId","in":"path","type":"string","required":true,"description":"Identifier of the account. Often referred to as the account number, yet for consistency this is always referred to as account id. Accepts both IBAN & BBAN"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"accountCurrency":"string","closureDate":"2024-01-01T00:00:00Z","creditAccount":"string","capitaliseInterest":"string","chargeType":"string","chargeAmount":0.0,"closeMode":"string","ftId":"string","closureReason":"string","closureNotes":"string","onlineLedgerBalance":0.0,"onlineClearedBalance":0.0,"balancePayable":0.0,"totalCreditInterest":"string","totalDebitInterest":"string"}},"responses":{"200":"AccountClosureResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/holdings/accounts/{accountId}/transactions","fullPath":"/api/v4.8.0/holdings/accounts/{accountId}/transactions","operationId":"getAccountTransactions","name":"Retrieves account transaction details such as transaction type, amount, transaction reference, credit or debit indicator, booking and effective date of transaction","summary":"Retrieves account transaction details","tags":[],"parameters":[{"name":"accountId","in":"path","type":"string","required":true,"description":"Identifier of the account. Often referred to as the account number, yet for consistency this is always referred to as account id. Accepts both IBAN & BBAN"},{"name":"bookingDate","in":"query","type":"string","required":false,"description":"Business date on which the accounting entry was generated."},{"name":"processingDate","in":"query","type":"string","required":false,"description":"The date when payment instruction is processed in system."},{"name":"valueDate","in":"query","type":"string","required":false,"description":"Indicates the value date on which the underlying accounting entry is to be given value (for interest purposes)"},{"name":"description","in":"query","type":"string","required":false,"description":"Contains the description of purpose of the payment."},{"name":"reversalMarker","in":"query","type":"string","required":false,"description":"Denotes the flag which is set whenever any credit or reversal debit entries with future exposure dates are processed"},{"name":"includeSubAcct","in":"query","type":"string","required":false,"description":"Denotes the flag which needs to be set in order to allow the automatic creation of sub-accounts and the automatic distribution of transactions over sub-accounts"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"AccountTransactionsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/accounts/{accountId}/cards","fullPath":"/api/v4.8.0/holdings/accounts/{accountId}/cards","operationId":"getAccountCards","name":"Retrieves the card details of the account such as card number, card type and status of the card","summary":"Retrieves available card details","tags":[],"parameters":[{"name":"accountId","in":"path","type":"string","required":true,"description":"Identifier of the account. Often referred to as the account number, yet for consistency this is always referred to as account id. Accepts both IBAN & BBAN"},{"name":"cardIssueId","in":"query","type":"string","required":false,"description":"The identifier of the issued card formatted as cardType '.' cardNumber. E.g. VISA.1234567887654321 GC.1111222233334444 AB21.1111111122222222"},{"name":"issueDate","in":"query","type":"string","required":false,"description":"The date the item was issued."},{"name":"expiryDate","in":"query","type":"string","required":false,"description":"The date an agreement such as an arrangement, product, credit facility or limit is due to expire"},{"name":"cardStatus","in":"query","type":"string","required":false,"description":"Current status of the Card and following are the possible statuses are  - CARD.ISSUED - CARD.RETURNED - CARD.SCRAP - CARD.CANCEL - NOT.ACTIVATED - NOT.RECEIVED - ACTIVE - BLOCKED - EXPIRED"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"AccountCardsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/accounts/balances","fullPath":"/api/v4.8.0/holdings/accounts/balances","operationId":"getAccountBalanceToday","name":"Retrieves various types of balances such as cleared, online, locked and usable balance of the account","summary":"Retrieves list of account balances","tags":[],"parameters":[{"name":"accountId","in":"query","type":"string","required":false,"description":"Identifier of the account. Often referred to as the account number, yet for consistency this is always referred to as account id. Accepts both IBAN & BBAN"},{"name":"customerId","in":"query","type":"string","required":false,"description":"Identifier of the customer"},{"name":"productId","in":"query","type":"string","required":false,"description":"Contains the unique identifier of the product, e.g. the product id of the arrangement account."},{"name":"currencyId","in":"query","type":"string","required":false,"description":"Identifier of the currency. This is the 3-letter ISO 4217 code of the currency."},{"name":"limitReferenceId","in":"query","type":"string","required":false,"description":"Limit reference identifier for the limit order."},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"AccountBalanceTodayResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/accounts/{accountId}/balanceMovements/{bookingDate}","fullPath":"/api/v4.8.0/holdings/accounts/{accountId}/balanceMovements/{bookingDate}","operationId":"getAccountBalanceMovement","name":"Retrieves the credit, debit and gross balance movements for an account for the requested booking date","summary":"Retrieves balances movements of account","tags":[],"parameters":[{"name":"accountId","in":"path","type":"string","required":true,"description":"Identifier of the account. Often referred to as the account number, yet for consistency this is always referred to as account id. Accepts both IBAN & BBAN"},{"name":"bookingDate","in":"path","type":"string","required":true,"description":"Business date on which the accounting entry was generated."},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"AccountBalanceMovementResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/accounts/{accountId}/emergencyBlocks/status","fullPath":"/api/v4.8.0/holdings/accounts/{accountId}/emergencyBlocks/status","operationId":"getAccountEmergencyBlock","name":"Retrieve emergency block status and reason for a given account. This information will be used to assert the actual block status of an account in microservice","summary":"Retrieve emergency block information for an account","tags":[],"parameters":[{"name":"accountId","in":"path","type":"string","required":true,"description":"Identifier of the account. Often referred to as the account number, yet for consistency this is always referred to as account id. Accepts both IBAN & BBAN"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"AccountEmergencyBlockResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"PUT","path":"/holdings/accounts/{accountId}/emergencyBlocks/status","fullPath":"/api/v4.8.0/holdings/accounts/{accountId}/emergencyBlocks/status","operationId":"updateAccountEmergencyBlock","name":"Updates emergency block status and reason for block of the account","summary":"Update emergency block in account","tags":[],"parameters":[{"name":"accountId","in":"path","type":"string","required":true,"description":""},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"emergencyBlock":"string","emergencyReason":"string","extensions":{}}},"responses":{"200":"AccountEmergencyBlockResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/holdings/accounts/{accountId}/fundsAuthorisation/status","fullPath":"/api/v4.8.0/holdings/accounts/{accountId}/fundsAuthorisation/status","operationId":"getAccountFundsAuthStatus","name":"Retrieve the funds authorisation status of the account","summary":"Retrieve account funds authorisation status","tags":[],"parameters":[{"name":"accountId","in":"path","type":"string","required":true,"description":"Identifier of the account. Often referred to as the account number, yet for consistency this is always referred to as account id. Accepts both IBAN & BBAN"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"AccountFundsAuthStatusResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"PUT","path":"/holdings/accounts/{accountId}/fundsAuthorisation/status","fullPath":"/api/v4.8.0/holdings/accounts/{accountId}/fundsAuthorisation/status","operationId":"updateAccountFundsAuthStatus","name":"Update the funds authorisation status for the account, for example SYNC or ERROR","summary":"Update account funds authorisation status","tags":[],"parameters":[{"name":"accountId","in":"path","type":"string","required":true,"description":""},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"faStatus":"string","extensions":{}}},"responses":{"200":"AccountFundsAuthStatusResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"POST","path":"/holdings/accounts/settings/{settingId}/fundsDiversion","fullPath":"/api/v4.8.0/holdings/accounts/settings/{settingId}/fundsDiversion","operationId":"createFundsDiversion","name":"Allows creation of funds diversion conditions for a company to manage the behavior of booking funds against any account in the company that has the auto pay account defined","summary":"Creates conditions for funds diversion","tags":[],"parameters":[{"name":"settingId","in":"path","type":"string","required":true,"description":"Contains the particular parameter record setting identifier."},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"transactionCodes":[{}],"defaultFundsDiversion":"string","extensions":{}}},"responses":{"200":"FundsDiversionResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/holdings/accounts/settings/{settingId}/fundsDiversion","fullPath":"/api/v4.8.0/holdings/accounts/settings/{settingId}/fundsDiversion","operationId":"updateFundsDiversion","name":"Updates the funds diversion conditions for a company to manage the behavior of booking funds against any account in the company that has the auto pay account defined","summary":"Updates funds diversion parameter","tags":[],"parameters":[{"name":"settingId","in":"path","type":"string","required":true,"description":"Contains the particular parameter record setting identifier."},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"transactionCodes":[{}],"defaultFundsDiversion":"string","extensions":{}}},"responses":{"200":"FundsDiversionResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/holdings/nostros/forwardBalances","fullPath":"/api/v4.8.0/holdings/nostros/forwardBalances","operationId":"getNostroForwardBalances","name":"Retrieves forward balances of nostro accounts considering the transaction effective dates.","summary":"Retrieves consolidated nostro account balances","tags":[],"parameters":[{"name":"valueDate","in":"query","type":"string","required":false,"description":"Indicates the value date on which the underlying accounting entry is to be given value (for interest purposes)"},{"name":"accountId","in":"query","type":"string","required":true,"description":"Identifier of the account. Often referred to as the account number, yet for consistency this is always referred to as account id. Accepts both IBAN & BBAN"},{"name":"longPositionSign","in":"query","type":"string","required":false,"description":"Polarity (sign) used to denote buy position balance.  "},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"NostroForwardBalancesResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/nostros/currencyBalances/{currencyId}/accounts","fullPath":"/api/v4.8.0/holdings/nostros/currencyBalances/{currencyId}/accounts","operationId":"getNostroBalances","name":"Retrieves the date wise balances of the nostro accounts that falls under a specific currency","summary":"Retrieves nostro account balances for a specific currency","tags":[],"parameters":[{"name":"currencyId","in":"path","type":"string","required":true,"description":"Identifier of the currency. This is the 3-letter ISO 4217 code of the currency."},{"name":"nostroId","in":"query","type":"string","required":false,"description":"Nostro account id"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"NostroBalancesResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/nostros/currencyBalances/{currencyId}","fullPath":"/api/v4.8.0/holdings/nostros/currencyBalances/{currencyId}","operationId":"getNostroCurrencyPositions","name":"Retrieves consolidated balances of the nostro accounts in a given currency from the current date to the next five days.","summary":"Retrieves consolidated nostro account balances for a specific currency","tags":[],"parameters":[{"name":"currencyId","in":"path","type":"string","required":true,"description":"Identifier of the currency. This is the 3-letter ISO 4217 code of the currency."},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"NostroCurrencyPositionsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/accounts/{accountId}","fullPath":"/api/v4.8.0/holdings/accounts/{accountId}","operationId":"getAccountDetails","name":"Retrieves the arrangement account details such as account balances, allowed, advised and outstanding limit balances, interest types and values with the corresponding mode, frequency and value of payments","summary":"Retrieves arrangement account details","tags":[],"parameters":[{"name":"accountId","in":"path","type":"string","required":true,"description":"Identifier of the account. Often referred to as the account number, yet for consistency this is always referred to as account id. Accepts both IBAN & BBAN"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"AccountDetailsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/accounts/proxyIdentifiers","fullPath":"/api/v4.8.0/holdings/accounts/proxyIdentifiers","operationId":"getActiveProxyIdentifier","name":"Retrieve active records from proxy directory for a given customer number or account number or proxy type and proxy identifier","summary":"Retrieve proxy registration status","tags":[],"parameters":[{"name":"customerId","in":"query","type":"string","required":false,"description":"Identifier of the customer"},{"name":"alternateAccountId","in":"query","type":"string","required":false,"description":"Contains the Uniform Banking Code of the arrangement"},{"name":"proxyType","in":"query","type":"string","required":false,"description":"Type of proxy created for account"},{"name":"proxyIdentifier","in":"query","type":"string","required":false,"description":"A proxy identifier to be linked to an account based on the proxy type provided eg. Mobile number, email id and tax id"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"ActiveProxyIdentifierResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"POST","path":"/holdings/accounts/proxyIdentifiers","fullPath":"/api/v4.8.0/holdings/accounts/proxyIdentifiers","operationId":"createProxyIdentifier","name":"Create a new record in proxy directory to register the supplied proxy identifiers, proxy type and scheme for a customer and account","summary":"Register the proxy identifier for the account","tags":[],"parameters":[{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"customerId":"string","accountId":"string","alternateAccountId":"string","proxyType":"string","proxyIdentifier":"string","proxyStatus":"string","proxyScheme":"string","proxyRole":"string","extensions":{}}},"responses":{"200":"ProxyIdentifierResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/holdings/accounts/proxyIdentifiers/{proxyIdentifierId}","fullPath":"/api/v4.8.0/holdings/accounts/proxyIdentifiers/{proxyIdentifierId}","operationId":"updateProxyIdentifier","name":"Update the specific proxy identifier to de-register the registered account or customer from the proxy directory","summary":"Update proxy directory for account to de-register the proxy identifier","tags":[],"parameters":[{"name":"proxyIdentifierId","in":"path","type":"string","required":true,"description":""},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"customerId":"string","accountId":"string","alternateAccountId":"string","proxyType":"string","proxyIdentifier":"string","proxyStatus":"string","proxyScheme":"string","proxyRole":"string","extensions":{}}},"responses":{"200":"ProxyIdentifierResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/holdings/accounts/{accountId}/{accountCompany}/{paymentCurrency}/{accountSwitch}/{beneficialCustomer}/payments","fullPath":"/api/v4.8.0/holdings/accounts/{accountId}/{accountCompany}/{paymentCurrency}/{accountSwitch}/{beneficialCustomer}/payments","operationId":"getAccountPaymentDetails","name":"Retrieves the account information that are required for processing or validating an account involved in a payment transaction. Provides the information such as account name, customer number, account type, account currency, IBAN, account switch details, account status (ACTIVE or INACTIVE) and account closure details.","summary":"Retrieves account details required for payment processing","tags":[],"parameters":[{"name":"accountId","in":"path","type":"string","required":true,"description":"Identifier of the account. Often referred to as the account number, yet for consistency this is always referred to as account id. Accepts both IBAN & BBAN"},{"name":"accountCompany","in":"path","type":"string","required":true,"description":"Company of the account to be created"},{"name":"paymentCurrency","in":"path","type":"string","required":true,"description":"This field holds the transaction currency or currency in which payment is initiated. "},{"name":"accountSwitch","in":"path","type":"string","required":true,"description":"Indicates if availability of account switch details should be checked."},{"name":"beneficialCustomer","in":"path","type":"string","required":true,"description":"Indicates if beneficial owners of the account are to be retrieved"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"AccountPaymentDetailsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/accounts","fullPath":"/api/v4.8.0/holdings/accounts","operationId":"getAccounts","name":"Retrieves the currency, balances, limit details and arrangement details of the account","summary":"Retrieves list of account basic details","tags":[],"parameters":[{"name":"accountId","in":"query","type":"string","required":false,"description":"Identifier of the account. Often referred to as the account number, yet for consistency this is always referred to as account id. Accepts both IBAN & BBAN"},{"name":"customerId","in":"query","type":"string","required":false,"description":"Identifier of the customer"},{"name":"productId","in":"query","type":"string","required":false,"description":"Contains the unique identifier of the product, e.g. the product id of the arrangement account."},{"name":"currencyId","in":"query","type":"string","required":false,"description":"Identifier of the currency. This is the 3-letter ISO 4217 code of the currency."},{"name":"currencyIdSAID","in":"query","type":"string","required":false,"description":"Indicates the criteria for the sounds like operation on the currency"},{"name":"limitReference","in":"query","type":"string","required":false,"description":"Identifies the credit limit reference for the underlying account."},{"name":"arrangementId","in":"query","type":"string","required":false,"description":"Indicates an unique identifier of an account"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"AccountsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/accounts/{contractBalanceId}/contractBalances","fullPath":"/api/v4.8.0/holdings/accounts/{contractBalanceId}/contractBalances","operationId":"getContractBalances","name":"Retrieves the contract balances of accounts or contracts with details such as contract currency, balance types, credit and debit movements and opening and closing balance of the respective balance types","summary":"Retrieves contract balances of accounts","tags":[],"parameters":[{"name":"contractBalanceId","in":"path","type":"string","required":true,"description":"Unique Identifier of Contract Balances"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"ContractBalancesResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"PUT","path":"/holdings/accounts/{accountId}/synchronizationError","fullPath":"/api/v4.8.0/holdings/accounts/{accountId}/synchronizationError","operationId":"updateSynchronizationError","name":"Updates error status during synchronization of the account between Transact and Funds authorization microservice.","summary":"Update synchronization error status","tags":[],"parameters":[{"name":"accountId","in":"path","type":"string","required":true,"description":"Identifier of the account. Often referred to as the account number, yet for consistency this is always referred to as account id. Accepts both IBAN & BBAN"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"emergencyBlockError":"string","extensions":{}}},"responses":{"200":"SynchronizationErrorResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/holdings/accounts/{accountId}/accountSwitches/expiringSwitches","fullPath":"/api/v4.8.0/holdings/accounts/{accountId}/accountSwitches/expiringSwitches","operationId":"getExpiringAccountSwitches","name":"Retrieves the details of the expiring account switches for generating alerts such as the bank identifier code, alert date and account id of expiring switch instruction etc.","summary":"Retrieves the details of the expiring switches for generating alerts","tags":[],"parameters":[{"name":"accountId","in":"path","type":"string","required":true,"description":"Identifier of the account. Often referred to as the account number, yet for consistency this is always referred to as account id. Accepts both IBAN & BBAN"},{"name":"alertStatus","in":"query","type":"string","required":false,"description":"Contains status of the Alert to be raised for switching instruction. Possible values are Pending, Sent."},{"name":"alertDate","in":"query","type":"string","required":false,"description":"Indicates the date in which an alert to be raised for a switching instruction."},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"ExpiringAccountSwitchesResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/accounts/{accountId}/accountSwitches","fullPath":"/api/v4.8.0/holdings/accounts/{accountId}/accountSwitches","operationId":"getAccountSwitchDetails","name":"Retrieves details from the account switch directory for the specific account such as the expiry date, status of the switch instruction, effective date of the switch, bank identifier code and IBAN (International Bank Account Number ) etc.","summary":"Retrieves details of the account switch requests","tags":[],"parameters":[{"name":"accountId","in":"path","type":"string","required":true,"description":"Identifier of the account. Often referred to as the account number, yet for consistency this is always referred to as account id. Accepts both IBAN & BBAN"},{"name":"requestDate","in":"query","type":"string","required":false,"description":"Date on which the client's request to be classified as professional has been received."},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"AccountSwitchDetailsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"PUT","path":"/holdings/accounts/{accountId}/accountSwitches","fullPath":"/api/v4.8.0/holdings/accounts/{accountId}/accountSwitches","operationId":"updateAccountSwitchDetails","name":"Updates alert status based on the original IBAN. Used by external systems handling alert generation to mark the status from pending to sent","summary":"Updates alert status from pending to sent for corresponding switch instructions.","tags":[],"parameters":[{"name":"accountId","in":"path","type":"string","required":true,"description":"Identifier of the account. Often referred to as the account number, yet for consistency this is always referred to as account id. Accepts both IBAN & BBAN"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"accountId":"string","switchIBAN":"string","switchAccountId":"string","switchBic":"string","switchClearingCode":"string","requestDate":"string","status":"string","cancelInstruction":"string","cancelDate":"string","expiryDate":"string","IBAN":"string","bicId":"string","effectiveDate":"string","alertDate":"string","alertStatus":"string"}},"responses":{"200":"AccountSwitchDetailsResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/holdings/accounts/{accountId}/accountSwitches/payments","fullPath":"/api/v4.8.0/holdings/accounts/{accountId}/accountSwitches/payments","operationId":"getAccountSwitchPaymentDetails","name":"Retrieves information of the re-routed payments from the payment transaction exit point.","summary":"Retrieves rerouted payment information.","tags":[],"parameters":[{"name":"accountId","in":"path","type":"string","required":true,"description":"Identifier of the account. Often referred to as the account number, yet for consistency this is always referred to as account id. Accepts both IBAN & BBAN"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"AccountSwitchPaymentDetailsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"PUT","path":"/holdings/accounts/accountClosures/{accountId}/approvals","fullPath":"/api/v4.8.0/holdings/accounts/accountClosures/{accountId}/approvals","operationId":"approveAccountClosure","name":"Approves account closure information to allow closing of an account which is no longer in use","summary":"Approves account closure information","tags":[],"parameters":[{"name":"accountId","in":"path","type":"string","required":true,"description":"Identifier of the account. Often referred to as the account number, yet for consistency this is always referred to as account id. Accepts both IBAN & BBAN"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"AccountClosureResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/holdings/accounts/reservedFunds","fullPath":"/api/v4.8.0/holdings/accounts/reservedFunds","operationId":"getReservedFunds","name":"Retrieves the reserved funds details such as reason, amount and period of reservation of the account","summary":"Retrieves the list of reserved funds ","tags":[],"parameters":[{"name":"accountId","in":"query","type":"string","required":false,"description":"Identifier of the account. Often referred to as the account number, yet for consistency this is always referred to as account id. Accepts both IBAN & BBAN"},{"name":"lockedEventReference","in":"query","type":"string","required":false,"description":"Captures the AC.LOCKED.EVENTS id if in case the funds is available and reserved."},{"name":"lockReason","in":"query","type":"string","required":false,"description":"Indicates the simple description for the balance reservation event."},{"name":"fromDate","in":"query","type":"string","required":false,"description":"Indicates the business date from when the balance reservation event is active."},{"name":"toDate","in":"query","type":"string","required":false,"description":"Indicates the business date until when the balance reservation event is active."},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"ReservedFundsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"POST","path":"/holdings/accounts/reservedFunds","fullPath":"/api/v4.8.0/holdings/accounts/reservedFunds","operationId":"createFundsReservation","name":"Creates a funds reservation with details such as account number, block or reserve amount, period of hold transaction, reason for holding. Funds reservations are created to block or reserve funds which restricts any debit movements affecting the account balance below the blocked amount for the specified period on an account.","summary":"Creates a credit or debit funds reservation to block the funds in an account","tags":[],"parameters":[{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"accountId":"string","lockReason":"string","fromDate":"2024-01-01","toDate":"2024-01-01","lockedAmount":"string","transactionReference":"string","transactionRetry":"string","systemId":"string","additionalDetail":"string","alternateKey":"string","reservationTypeId":"string","accountLink":"string","action":"string","creditDebitIndicator":"string","reservationIndicator":"string"}},"responses":{"200":"FundsReservationResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/holdings/accounts/reservedFunds/{lockedEventReference}","fullPath":"/api/v4.8.0/holdings/accounts/reservedFunds/{lockedEventReference}","operationId":"updateFundsReservation","name":"Update funds reservation with details such as account number, block or reserve amount, period of hold transaction, reason for holding. Funds reservations are created to block or reserve funds which restricts any debit movements affecting the account balance below the blocked amount for the specified period on an account.","summary":"Update the credit or debit funds reservation to block the funds in an account","tags":[],"parameters":[{"name":"lockedEventReference","in":"path","type":"string","required":true,"description":"Captures the AC.LOCKED.EVENTS id if in case the funds is available and reserved."},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"accountId":"string","lockReason":"string","fromDate":"2024-01-01","toDate":"2024-01-01","lockedAmount":"string","transactionReference":"string","transactionRetry":"string","systemId":"string","additionalDetail":"string","alternateKey":"string","reservationTypeId":"string","accountLink":"string","action":"string","creditDebitIndicator":"string","reservationIndicator":"string"}},"responses":{"200":"FundsReservationResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"DELETE","path":"/holdings/accounts/reservedFunds/{lockedEventReference}","fullPath":"/api/v4.8.0/holdings/accounts/reservedFunds/{lockedEventReference}","operationId":"cancelFundsReservation","name":"Cancels the funds reservation of an account. Funds reservations are created to block or reserve funds which restricts any debit movements affecting the account balance below the blocked amount for the specified period on an account. On removal of the funds reservations, the blocked or reserved amount is now available for usage.","summary":"Cancels the credit or debit funds reservation to unblock the funds in an account","tags":[],"parameters":[{"name":"lockedEventReference","in":"path","type":"string","required":true,"description":"Captures the AC.LOCKED.EVENTS id if in case the funds is available and reserved."},{"name":"payload","in":"body","type":"object","required":false,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}}},"responses":{"200":"FundsReservationResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"POST","path":"/holdings/accounts/internalAccounts/{accountId}","fullPath":"/api/v4.8.0/holdings/accounts/internalAccounts/{accountId}","operationId":"createInternalAccount","name":"Create bank internal account with mandatory details such as account title, short title, mnemonic, account officer. The internal accounts are created and maintained for bank's internal operations such as interbranch, intercompany transactions.","summary":"Create bank internal account","tags":[],"parameters":[{"name":"accountId","in":"path","type":"string","required":true,"description":"Identifier of the account. Often referred to as the account number, yet for consistency this is always referred to as account id. Accepts both IBAN & BBAN"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"otherOfficers":[{}],"postingRestrictIds":[{}],"alternateAcctDetails":[{}],"categoryId":"string","accountTitle":"string","accountTitle2":"string","shortTitle":"string","mnemonic":"string","positionType":"string","accountOfficer":"string","highVolumeTransaction":"string","extensions":{}}},"responses":{"200":"InternalAccountResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/holdings/accounts/internalAccounts/{accountId}","fullPath":"/api/v4.8.0/holdings/accounts/internalAccounts/{accountId}","operationId":"updateInternalAccount","name":"Update bank internal account with details such as short title, account officer, account title, high volume transaction flag, alternate account id, posting restriction. The internal accounts are created and maintained for bank's internal operations such as interbranch, intercompany transactions. ","summary":"Update bank internal account","tags":[],"parameters":[{"name":"accountId","in":"path","type":"string","required":true,"description":"Identifier of the account. Often referred to as the account number, yet for consistency this is always referred to as account id. Accepts both IBAN & BBAN"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"otherOfficers":[{}],"postingRestrictIds":[{}],"alternateAcctDetails":[{}],"categoryId":"string","accountTitle":"string","accountTitle2":"string","shortTitle":"string","mnemonic":"string","accountOfficer":"string","highVolumeTransaction":"string","extensions":{}}},"responses":{"200":"InternalAccountResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/holdings/accounts/nostroAccounts","fullPath":"/api/v4.8.0/holdings/accounts/nostroAccounts","operationId":"getNostroAccounts","name":"Retrieves the currency, balance and category details of the nostro account","summary":"Retrieves list of nostro account details","tags":[],"parameters":[{"name":"accountId","in":"query","type":"string","required":false,"description":"Identifier of the account. Often referred to as the account number, yet for consistency this is always referred to as account id. Accepts both IBAN & BBAN"},{"name":"customerId","in":"query","type":"string","required":false,"description":"Identifier of the customer"},{"name":"productId","in":"query","type":"string","required":false,"description":"Contains the unique identifier of the product, e.g. the product id of the arrangement account."},{"name":"currencyId","in":"query","type":"string","required":false,"description":"Identifier of the currency. This is the 3-letter ISO 4217 code of the currency."},{"name":"limitReference","in":"query","type":"string","required":false,"description":"Identifies the credit limit reference for the underlying account."},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"NostroAccountsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"POST","path":"/holdings/accounts/nostroAccounts","fullPath":"/api/v4.8.0/holdings/accounts/nostroAccounts","operationId":"createNostroAccount","name":"Create nostro account with mandatory details such as customer, currency, account title, account officer, short title, reconcile account. A nostro account is the shadow or mirror account of the vostro account maintained by the correspondent bank. The nostro account is opened with the correspondent bank as the customer.","summary":"Create nostro account","tags":[],"parameters":[{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"otherOfficers":[{}],"postingRestrictIds":[{}],"customerId":"string","accountTitle":"string","accountTitle2":"string","shortTitle":"string","mnemonic":"string","positionType":"string","currencyId":"string","accountOfficer":"string","reconcileNostroAccount":"string","ownNostro":"string","reconciliationToleranceAmount":"string","highVolumeTransaction":"string","extensions":{}}},"responses":{"200":"NostroAccountResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/holdings/accounts/internalAccounts","fullPath":"/api/v4.8.0/holdings/accounts/internalAccounts","operationId":"getInternalAccounts","name":"Retrieves the currency, balance and category details of the internal account","summary":"Retrieves list of internal account details","tags":[],"parameters":[{"name":"accountId","in":"query","type":"string","required":false,"description":"Identifier of the account. Often referred to as the account number, yet for consistency this is always referred to as account id. Accepts both IBAN & BBAN"},{"name":"productId","in":"query","type":"string","required":false,"description":"Contains the unique identifier of the product, e.g. the product id of the arrangement account."},{"name":"currencyId","in":"query","type":"string","required":false,"description":"Identifier of the currency. This is the 3-letter ISO 4217 code of the currency."},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"InternalAccountsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"PUT","path":"/holdings/accounts/nostroAccounts/{accountId}","fullPath":"/api/v4.8.0/holdings/accounts/nostroAccounts/{accountId}","operationId":"updateNostroAccount","name":"Update nostro account with details such as reconciliation tolerance amount, our actual account number, short title, account officer, account title, high volume transaction flag, posting restriction. A nostro account is the shadow or mirror account of the vostro account maintained by the correspondent bank. The nostro account is opened with the correspondent bank as the customer.","summary":"Update Nostro account","tags":[],"parameters":[{"name":"accountId","in":"path","type":"string","required":true,"description":"Identifier of the account. Often referred to as the account number, yet for consistency this is always referred to as account id. Accepts both IBAN & BBAN"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"otherOfficers":[{}],"postingRestrictIds":[{}],"customerId":"string","accountTitle":"string","accountTitle2":"string","shortTitle":"string","mnemonic":"string","accountOfficer":"string","ownNostro":"string","reconciliationToleranceAmount":"string","highVolumeTransaction":"string","extensions":{}}},"responses":{"200":"NostroAccountResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/holdings/nostros/positions/{currencyId}","fullPath":"/api/v4.8.0/holdings/nostros/positions/{currencyId}","operationId":"getNostroPositions","name":"Retrieves nostro account balances for a given currency from the current date to the next five days.","summary":"Retrieves consolidated nostro account positions for the currency","tags":[],"parameters":[{"name":"currencyId","in":"path","type":"string","required":true,"description":"Identifier of the currency. This is the 3-letter ISO 4217 code of the currency."},{"name":"longPositionSign","in":"query","type":"string","required":false,"description":"Polarity (sign) used to denote buy position balance.  "},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"NostroPositionsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/accounts/{accountId}/transactionRetries/cancellations","fullPath":"/api/v4.8.0/holdings/accounts/{accountId}/transactionRetries/cancellations","operationId":"getTransactionRetryCancellations","name":"Retrieves the cancellation request applied on a single transaction retry or multiple transaction retries pertaining to an account with information such as transaction retry id, transaction retry change type and transaction retry change value.","summary":"Retrieves the cancellation request applied on a single transaction retry or multiple transaction retries pertaining to an account.","tags":[],"parameters":[{"name":"accountId","in":"path","type":"string","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"TransactionRetryCancellationsResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"POST","path":"/holdings/accounts/{accountId}/transactionRetries/cancellations","fullPath":"/api/v4.8.0/holdings/accounts/{accountId}/transactionRetries/cancellations","operationId":"createTransactionRetryCancellations","name":"Creates a cancellation request for a single transaction retry or multiple transaction retries pertaining to an account. The request will terminate the transaction from further retry.","summary":"Creates a cancellation request for a single transaction retry or multiple transaction retries pertaining to an account.","tags":[],"parameters":[{"name":"accountId","in":"path","type":"string","required":true,"description":"Identifier of the account. Often referred to as the account number, yet for consistency this is always referred to as account id. Accepts both IBAN & BBAN"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"transactionRetryIds":[{}],"extensions":{}}},"responses":{"200":"TransactionRetryCancellationsResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/holdings/accounts/{accountId}/transactionRetries/pendings","fullPath":"/api/v4.8.0/holdings/accounts/{accountId}/transactionRetries/pendings","operationId":"getPendingTransactionRetries","name":"Retrieves various details from pending transaction retries pertaining to an account, such as retry start date, retry end date, retry frequency, retry amount, number of possible retries, total number of retries attempted, details of latest retry attempted and information of successful retry. Transaction Retries - Bank Transfer transactions transition through various payment statuses and in some cases a payment may move to a status from which users are unable to complete their payment. Example: In","summary":"Retrieves the pending transaction retries pertaining to an account","tags":[],"parameters":[{"name":"accountId","in":"path","type":"string","required":true,"description":"Identifier of the account. Often referred to as the account number, yet for consistency this is always referred to as account id. Accepts both IBAN & BBAN"},{"name":"transactionRetryId","in":"query","type":"string","required":false,"description":"Indicates the transaction retry identifier"},{"name":"numberOfTransactionRetries","in":"query","type":"string","required":false,"description":"Indicates the number of times the transaction has to be retried."},{"name":"transactionRetryStartDate","in":"query","type":"string","required":false,"description":"Indicates the date when the transaction retry has started."},{"name":"transactionRetryEndDate","in":"query","type":"string","required":false,"description":"Indicates the date till when the transaction has to be retried."},{"name":"nextTransactionRetryDate","in":"query","type":"string","required":false,"description":"Indicates the date when transaction has to be retried next."},{"name":"transactionType","in":"query","type":"string","required":false,"description":"Identifies the transaction type applicable to the transaction being processed, i.e. outward or inward payment. For example: ACPX, OTPX etc."},{"name":"contractId","in":"query","type":"string","required":false,"description":"Indicates the unique identifier of the transaction or contract which initiated the activity"},{"name":"productGroupId","in":"query","type":"string","required":false,"description":"The group, as defined by the institution, that the product belongs to."},{"name":"productId","in":"query","type":"string","required":false,"description":"Contains the unique identifier of the product, e.g. the product id of the arrangement account."},{"name":"arrangementId","in":"query","type":"string","required":false,"description":"Indicates an unique identifier of an account"},{"name":"transactionRetryStatus","in":"query","type":"string","required":false,"description":"Indicates the transaction retry status. Possible values are: NEW - Indicates transaction is captured for retry and transaction retry is yet to be processed, CURRENT - Transaction is currently being re"},{"name":"retrySettlementStatus","in":"query","type":"string","required":false,"description":"Indicates the transaction settlement status. Possible values are: PENDING - Indicates that the transaction is yet to be settled through retry, SETTLED - Indicates that the transaction is fully settled"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"PendingTransactionRetriesResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}}]},{"key":"holdings-accounts-service-v4.9.0","title":"Account management","version":"v4.9.0","description":"API to manage account related services such as retrieving balances, transaction and card details, emergency blocks, funds diversion, reservations, proxy identifiers and account closures. In addition, it provides functionality to support the capability to switch accounts from the current system to an","endpointCount":70,"endpoints":[{"method":"GET","path":"/holdings/accounts/{accountId}/dormancyConditions","fullPath":"/api/v4.9.0/holdings/accounts/{accountId}/dormancyConditions","operationId":"getAccountDormancyDetails","name":"Retrieves the dormancy setup details for the account such as dormancy period, status etc","summary":"Retrieves the account dormancy conditions","tags":["RETAIL"],"parameters":[{"name":"accountId","in":"path","type":"string","required":true,"description":"Identifier of the account. Often referred to as the account number, yet for consistency this is always referred to as accountId. Accepts both IBAN & BBAN"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"AccountDormancyDetailsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/accounts/{accountId}/transactions","fullPath":"/api/v4.9.0/holdings/accounts/{accountId}/transactions","operationId":"getAccountTransactions","name":"Retrieves account transaction details such as transaction type, amount, transaction reference, credit or debit indicator, booking and effective date of transaction","summary":"Retrieves account transaction details","tags":[],"parameters":[{"name":"accountId","in":"path","type":"string","required":true,"description":"Identifier of the account. Often referred to as the account number, yet for consistency this is always referred to as account id. Accepts both IBAN & BBAN"},{"name":"bookingDate","in":"query","type":"string","required":false,"description":"Business date on which the accounting entry was generated."},{"name":"processingDate","in":"query","type":"string","required":false,"description":"The date when payment instruction is processed in system."},{"name":"valueDate","in":"query","type":"string","required":false,"description":"Indicates the value date on which the underlying accounting entry is to be given value (for interest purposes)"},{"name":"description","in":"query","type":"string","required":false,"description":"Contains the description of purpose of the payment."},{"name":"reversalMarker","in":"query","type":"string","required":false,"description":"Denotes the flag which is set whenever any credit or reversal debit entries with future exposure dates are processed"},{"name":"includeSubAcct","in":"query","type":"string","required":false,"description":"Denotes the flag which needs to be set in order to allow the automatic creation of sub-accounts and the automatic distribution of transactions over sub-accounts"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"AccountTransactionsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/accounts/accountsDetails","fullPath":"/api/v4.9.0/holdings/accounts/accountsDetails","operationId":"getAccountInfo","name":"Retrieves the currency, balances, limit details and arrangement details of the account","summary":"Retrieves list of account basic details","tags":["RETAIL"],"parameters":[{"name":"customer","in":"query","type":"string","required":false,"description":"Contains the customer identifier to fetch list of consent arrangements for the customer or customer identifier of the debtor account. This will be populated once the SCA(Strong Customer Authentication"},{"name":"arrangementId","in":"query","type":"string","required":false,"description":"Indicates an unique identifier of an account"},{"name":"currency","in":"query","type":"string","required":false,"description":"Identifies the currency. E.g. USD, GBP etc"},{"name":"companyCode","in":"query","type":"string","required":false,"description":"The identifier of the underlying Entity/Company/Branch."},{"name":"productId","in":"query","type":"string","required":false,"description":"Contains the unique identifier of the product, e.g. the product id of the arrangement account."},{"name":"status","in":"query","type":"string","required":false,"description":"Contains status of the data rights request.Allowed values are INITIATED, INPROGESS, EXTENDED, COMPLETED, REJECTED."},{"name":"accountId","in":"query","type":"string","required":false,"description":"Identifier of the account. Often referred to as the account number, yet for consistency this is always referred to as accountId. Accepts both IBAN & BBAN"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"AccountDetailsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"PUT","path":"/holdings/accounts/{accountId}/schedules","fullPath":"/api/v4.9.0/holdings/accounts/{accountId}/schedules","operationId":"updateAccountSchedule","name":"Update the payment schedule condition such as payment method from capitalise to pay, payment frequency from monthly to quarterly etc., on a account","summary":"Update payment schedule for the given account","tags":["RETAIL"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"accountId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"productId":"string","drawdownDate":"2024-01-01","extensions":{},"schedule":[{}]}},"responses":{"200":"updateAccountScheduleResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"PUT","path":"/holdings/accounts/{accountId}/statements","fullPath":"/api/v4.9.0/holdings/accounts/{accountId}/statements","operationId":"updateAccountStatement","name":"Update the statement frequency of an account.","summary":"Update the statement frequency an account","tags":["RETAIL"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"accountId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"productId":"string","drawdownDate":"2024-01-01","extensions":{},"statement":[{}]}},"responses":{"200":"updateAccountStatementResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"GET","path":"/holdings/accounts/{accountId}/statements","fullPath":"/api/v4.9.0/holdings/accounts/{accountId}/statements","operationId":"getAccountStatementDetails","name":"Retrieves the statement frequency of an account","summary":"Retrieves the statement frequency of an account","tags":["RETAIL"],"parameters":[{"name":"accountId","in":"path","type":"string","required":true,"description":"Identifier of the account. Often referred to as the account number, yet for consistency this is always referred to as accountId. Accepts both IBAN & BBAN"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"AccountStatementDetailsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"PUT","path":"/holdings/accounts/{accountId}/renegotiations","fullPath":"/api/v4.9.0/holdings/accounts/{accountId}/renegotiations","operationId":"updateAccountConditions","name":"Perform the renegotiation of the account contract details such as payment frequency, payment start date, interest rate, statement frequency and settlement details, etc.","summary":"Renegotiation of the account contract details","tags":["RETAIL"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"accountId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"effectiveDate":"2024-01-01","productId":"string","extensions":{},"limit":[{}],"balance":[{}],"customer":[{}],"crinterest":[{}],"schedule":[{}],"settlement":[{}],"statement":[{}]}},"responses":{"200":"updateAccountConditionsResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"PUT","path":"/holdings/accounts/{accountId}/withdrawalNotices/noticeUpdates","fullPath":"/api/v4.9.0/holdings/accounts/{accountId}/withdrawalNotices/noticeUpdates","operationId":"updateAccountWithdrawalNotice","name":"Updates the notice of withdrawal of amount from  account by providing the withdrawal date, bill reference and amount etc. This is applicable only for notice type of accounts.","summary":"Updates the notice of withdrawal of amount from account","tags":["RETAIL"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"accountId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"parties":[{}],"activityId":"string","effectiveDate":"string","productId":"string","currencyId":"string","simulationId":"string","extensions":{},"noticeWithdrawal":[{}]}},"responses":{"200":"updateAccountWithdrawalNoticeResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"PUT","path":"/holdings/accounts/{accountId}/withdrawalNotices/cancellations","fullPath":"/api/v4.9.0/holdings/accounts/{accountId}/withdrawalNotices/cancellations","operationId":"cancelAccountWithdrawalNotice","name":"cancels the notification of withdrawal of amount from account.","summary":"Cancels the notification of withdrawal of amount from account","tags":["RETAIL"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"accountId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"parties":[{}],"activityId":"string","effectiveDate":"string","productId":"string","currencyId":"string","simulationId":"string","extensions":{},"noticeWithdrawal":[{}]}},"responses":{"200":"cancelAccountWithdrawalNoticeResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"PUT","path":"/holdings/accounts/{accountId}/payouts","fullPath":"/api/v4.9.0/holdings/accounts/{accountId}/payouts","operationId":"initiateAccountPayout","name":"Performs payout of the given account amount such as charges, tax etc","summary":"Performs payout of an account","tags":["RETAIL"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"accountId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"currencyId":"string","effectiveDate":"2024-01-01","activityId":"string","transactionAmount":0.0,"contractId":"string","systemId":"string","externalEventStatus":"string","extensions":{}}},"responses":{"200":"initiateAccountPayoutResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"PUT","path":"/holdings/accounts/{accountId}/repayments","fullPath":"/api/v4.9.0/holdings/accounts/{accountId}/repayments","operationId":"initiateAccountPayin","name":"Repays the account amount such as charges, tax etc","summary":"Repayment of the given account amount","tags":["RETAIL"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"accountId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"currencyId":"string","effectiveDate":"2024-01-01","activityId":"string","transactionAmount":0.0,"contractId":"string","systemId":"string","externalEventStatus":"string","extensions":{}}},"responses":{"200":"initiateAccountPayinResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"PUT","path":"/holdings/accounts/{accountId}/customers","fullPath":"/api/v4.9.0/holdings/accounts/{accountId}/customers","operationId":"updateAccountCustomer","name":"Update the customer details of the account such as add or remove the joint customers, tax liability percentange, limit liability percentage of the joint customers","summary":"Update customers for the given account","tags":["RETAIL"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"accountId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"partyIds":[{}],"effectiveDate":"2024-01-01","extensions":{},"customer":[{}]}},"responses":{"200":"updateSavingsAccountCustomerResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"PUT","path":"/holdings/accounts/{accountId}/migrations/bills","fullPath":"/api/v4.9.0/holdings/accounts/{accountId}/migrations/bills","operationId":"updateAccountBillMigration","name":"Captures the bill information of the account such as bill id, property names, bill amount etc. This is used to migrate the bills of a legacy contract which is migrated from other system & update the bill details","summary":"Captures the bill information of the account such as bill id, property names, bill amount etc. This is used to migrate the bills of a legacy contract which is migrated from other system & update the bill details","tags":["RETAIL"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"accountId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"productId":"string","drawdownDate":"2024-01-01","extensions":{},"balanceMaintenance":[{}]}},"responses":{"200":"updateAccountBillMigrationResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"PUT","path":"/holdings/accounts/{accountId}/branches","fullPath":"/api/v4.9.0/holdings/accounts/{accountId}/branches","operationId":"updateAccountBranch","name":"Updates the branch of an account","summary":"Updates the branch of an account","tags":["RETAIL"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"accountId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"effectiveDate":"2024-01-01","branch":"string","extensions":{}}},"responses":{"200":"updateAccountBranchResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"PUT","path":"/holdings/accounts/{accountId}/settlements","fullPath":"/api/v4.9.0/holdings/accounts/{accountId}/settlements","operationId":"updateAccountSettlement","name":"Update the settlement conditions of the account such as payin account, payin percentage, payin amount, payout account, payout percentage, payout amount, etc","summary":"Update the settlement conditions of the account such as payin account, payin percentage, payin amount, payout account, payout percentage, payout amount, etc","tags":["RETAIL"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"accountId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"productId":"string","drawdownDate":"2024-01-01","extensions":{},"settlement":[{}]}},"responses":{"200":"updateAccountSettlementResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"GET","path":"/holdings/accounts/accountClosures/{accountId}","fullPath":"/api/v4.9.0/holdings/accounts/accountClosures/{accountId}","operationId":"getAccountClosure","name":"Retrieves the account closure information of the account such as closure date and reason, mode of closure, balances on the date of closing and pending charges","summary":"Retrieves the account closure information","tags":[],"parameters":[{"name":"accountId","in":"path","type":"string","required":true,"description":"Identifier of the account. Often referred to as the account number, yet for consistency this is always referred to as account id. Accepts both IBAN & BBAN"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"AccountClosureResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/holdings/accounts/accountClosures/{accountId}","fullPath":"/api/v4.9.0/holdings/accounts/accountClosures/{accountId}","operationId":"updateAccountClosure","name":"Updates account closure information for the specific account such as closure date and reason, mode of closure and closing charges","summary":"Updates account closure information","tags":[],"parameters":[{"name":"accountId","in":"path","type":"string","required":true,"description":"Identifier of the account. Often referred to as the account number, yet for consistency this is always referred to as account id. Accepts both IBAN & BBAN"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"accountCurrency":"string","closureDate":"2024-01-01T00:00:00Z","creditAccount":"string","capitaliseInterest":"string","chargeType":"string","chargeAmount":0.0,"closeMode":"string","ftId":"string","closureReason":"string","closureNotes":"string","onlineLedgerBalance":0.0,"onlineClearedBalance":0.0,"balancePayable":0.0,"totalCreditInterest":"string","totalDebitInterest":"string"}},"responses":{"200":"AccountClosureResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/holdings/accounts/{accountId}/cards","fullPath":"/api/v4.9.0/holdings/accounts/{accountId}/cards","operationId":"getAccountCards","name":"Retrieves the card details of the account such as card number, card type and status of the card","summary":"Retrieves available card details","tags":[],"parameters":[{"name":"accountId","in":"path","type":"string","required":true,"description":"Identifier of the account. Often referred to as the account number, yet for consistency this is always referred to as account id. Accepts both IBAN & BBAN"},{"name":"cardIssueId","in":"query","type":"string","required":false,"description":"The identifier of the issued card formatted as cardType '.' cardNumber. E.g. VISA.1234567887654321 GC.1111222233334444 AB21.1111111122222222"},{"name":"issueDate","in":"query","type":"string","required":false,"description":"The date the item was issued."},{"name":"expiryDate","in":"query","type":"string","required":false,"description":"The date an agreement such as an arrangement, product, credit facility or limit is due to expire"},{"name":"cardStatus","in":"query","type":"string","required":false,"description":"Current status of the Card and following are the possible statuses are  - CARD.ISSUED - CARD.RETURNED - CARD.SCRAP - CARD.CANCEL - NOT.ACTIVATED - NOT.RECEIVED - ACTIVE - BLOCKED - EXPIRED"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"AccountCardsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/accounts/balances","fullPath":"/api/v4.9.0/holdings/accounts/balances","operationId":"getAccountBalanceToday","name":"Retrieves various types of balances such as cleared, online, locked and usable balance of the account","summary":"Retrieves list of account balances","tags":[],"parameters":[{"name":"accountId","in":"query","type":"string","required":false,"description":"Identifier of the account. Often referred to as the account number, yet for consistency this is always referred to as account id. Accepts both IBAN & BBAN"},{"name":"customerId","in":"query","type":"string","required":false,"description":"Identifier of the customer"},{"name":"productId","in":"query","type":"string","required":false,"description":"Contains the unique identifier of the product, e.g. the product id of the arrangement account."},{"name":"currencyId","in":"query","type":"string","required":false,"description":"Identifier of the currency. This is the 3-letter ISO 4217 code of the currency."},{"name":"limitReferenceId","in":"query","type":"string","required":false,"description":"Limit reference identifier for the limit order."},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"AccountBalanceTodayResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/accounts/{accountId}/balanceMovements/{bookingDate}","fullPath":"/api/v4.9.0/holdings/accounts/{accountId}/balanceMovements/{bookingDate}","operationId":"getAccountBalanceMovement","name":"Retrieves the credit, debit and gross balance movements for an account for the requested booking date","summary":"Retrieves balances movements of account","tags":[],"parameters":[{"name":"accountId","in":"path","type":"string","required":true,"description":"Identifier of the account. Often referred to as the account number, yet for consistency this is always referred to as account id. Accepts both IBAN & BBAN"},{"name":"bookingDate","in":"path","type":"string","required":true,"description":"Business date on which the accounting entry was generated."},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"AccountBalanceMovementResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/accounts/{accountId}/emergencyBlocks/status","fullPath":"/api/v4.9.0/holdings/accounts/{accountId}/emergencyBlocks/status","operationId":"getAccountEmergencyBlock","name":"Retrieve emergency block status and reason for a given account. This information will be used to assert the actual block status of an account in microservice","summary":"Retrieve emergency block information for an account","tags":[],"parameters":[{"name":"accountId","in":"path","type":"string","required":true,"description":"Identifier of the account. Often referred to as the account number, yet for consistency this is always referred to as account id. Accepts both IBAN & BBAN"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"AccountEmergencyBlockResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"PUT","path":"/holdings/accounts/{accountId}/emergencyBlocks/status","fullPath":"/api/v4.9.0/holdings/accounts/{accountId}/emergencyBlocks/status","operationId":"updateAccountEmergencyBlock","name":"Updates emergency block status and reason for block of the account","summary":"Update emergency block in account","tags":[],"parameters":[{"name":"accountId","in":"path","type":"string","required":true,"description":""},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"emergencyBlock":"string","emergencyReason":"string","extensions":{}}},"responses":{"200":"AccountEmergencyBlockResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/holdings/accounts/{accountId}/fundsAuthorisation/status","fullPath":"/api/v4.9.0/holdings/accounts/{accountId}/fundsAuthorisation/status","operationId":"getAccountFundsAuthStatus","name":"Retrieve the funds authorisation status of the account","summary":"Retrieve account funds authorisation status","tags":[],"parameters":[{"name":"accountId","in":"path","type":"string","required":true,"description":"Identifier of the account. Often referred to as the account number, yet for consistency this is always referred to as account id. Accepts both IBAN & BBAN"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"AccountFundsAuthStatusResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"PUT","path":"/holdings/accounts/{accountId}/fundsAuthorisation/status","fullPath":"/api/v4.9.0/holdings/accounts/{accountId}/fundsAuthorisation/status","operationId":"updateAccountFundsAuthStatus","name":"Update the funds authorisation status for the account, for example SYNC or ERROR","summary":"Update account funds authorisation status","tags":[],"parameters":[{"name":"accountId","in":"path","type":"string","required":true,"description":""},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"faStatus":"string","extensions":{}}},"responses":{"200":"AccountFundsAuthStatusResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"POST","path":"/holdings/accounts/settings/{settingId}/fundsDiversion","fullPath":"/api/v4.9.0/holdings/accounts/settings/{settingId}/fundsDiversion","operationId":"createFundsDiversion","name":"Allows creation of funds diversion conditions for a company to manage the behavior of booking funds against any account in the company that has the auto pay account defined","summary":"Creates conditions for funds diversion","tags":[],"parameters":[{"name":"settingId","in":"path","type":"string","required":true,"description":"Contains the particular parameter record setting identifier."},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"transactionCodes":[{}],"defaultFundsDiversion":"string","extensions":{}}},"responses":{"200":"FundsDiversionResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/holdings/accounts/settings/{settingId}/fundsDiversion","fullPath":"/api/v4.9.0/holdings/accounts/settings/{settingId}/fundsDiversion","operationId":"updateFundsDiversion","name":"Updates the funds diversion conditions for a company to manage the behavior of booking funds against any account in the company that has the auto pay account defined","summary":"Updates funds diversion parameter","tags":[],"parameters":[{"name":"settingId","in":"path","type":"string","required":true,"description":"Contains the particular parameter record setting identifier."},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"transactionCodes":[{}],"defaultFundsDiversion":"string","extensions":{}}},"responses":{"200":"FundsDiversionResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/holdings/nostros/forwardBalances","fullPath":"/api/v4.9.0/holdings/nostros/forwardBalances","operationId":"getNostroForwardBalances","name":"Retrieves forward balances of nostro accounts considering the transaction effective dates.","summary":"Retrieves consolidated nostro account balances","tags":[],"parameters":[{"name":"valueDate","in":"query","type":"string","required":false,"description":"Indicates the value date on which the underlying accounting entry is to be given value (for interest purposes)"},{"name":"accountId","in":"query","type":"string","required":true,"description":"Identifier of the account. Often referred to as the account number, yet for consistency this is always referred to as account id. Accepts both IBAN & BBAN"},{"name":"longPositionSign","in":"query","type":"string","required":false,"description":"Polarity (sign) used to denote buy position balance.  "},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"NostroForwardBalancesResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/nostros/currencyBalances/{currencyId}/accounts","fullPath":"/api/v4.9.0/holdings/nostros/currencyBalances/{currencyId}/accounts","operationId":"getNostroBalances","name":"Retrieves the date wise balances of the nostro accounts that falls under a specific currency","summary":"Retrieves nostro account balances for a specific currency","tags":[],"parameters":[{"name":"currencyId","in":"path","type":"string","required":true,"description":"Identifier of the currency. This is the 3-letter ISO 4217 code of the currency."},{"name":"nostroId","in":"query","type":"string","required":false,"description":"Nostro account id"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"NostroBalancesResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/nostros/currencyBalances/{currencyId}","fullPath":"/api/v4.9.0/holdings/nostros/currencyBalances/{currencyId}","operationId":"getNostroCurrencyPositions","name":"Retrieves consolidated balances of the nostro accounts in a given currency from the current date to the next five days.","summary":"Retrieves consolidated nostro account balances for a specific currency","tags":[],"parameters":[{"name":"currencyId","in":"path","type":"string","required":true,"description":"Identifier of the currency. This is the 3-letter ISO 4217 code of the currency."},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"NostroCurrencyPositionsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/accounts/{accountId}","fullPath":"/api/v4.9.0/holdings/accounts/{accountId}","operationId":"getAccountDetails","name":"Retrieves the arrangement account details such as account balances, allowed, advised and outstanding limit balances, interest types and values with the corresponding mode, frequency and value of payments","summary":"Retrieves arrangement account details","tags":[],"parameters":[{"name":"accountId","in":"path","type":"string","required":true,"description":"Identifier of the account. Often referred to as the account number, yet for consistency this is always referred to as account id. Accepts both IBAN & BBAN"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"AccountDetailsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/accounts/proxyIdentifiers","fullPath":"/api/v4.9.0/holdings/accounts/proxyIdentifiers","operationId":"getActiveProxyIdentifier","name":"Retrieve active records from proxy directory for a given customer number or account number or proxy type and proxy identifier","summary":"Retrieve proxy registration status","tags":[],"parameters":[{"name":"customerId","in":"query","type":"string","required":false,"description":"Identifier of the customer"},{"name":"alternateAccountId","in":"query","type":"string","required":false,"description":"Contains the Uniform Banking Code of the arrangement"},{"name":"proxyType","in":"query","type":"string","required":false,"description":"Type of proxy created for account"},{"name":"proxyIdentifier","in":"query","type":"string","required":false,"description":"A proxy identifier to be linked to an account based on the proxy type provided eg. Mobile number, email id and tax id"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"ActiveProxyIdentifierResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"POST","path":"/holdings/accounts/proxyIdentifiers","fullPath":"/api/v4.9.0/holdings/accounts/proxyIdentifiers","operationId":"createProxyIdentifier","name":"Create a new record in proxy directory to register the supplied proxy identifiers, proxy type and scheme for a customer and account","summary":"Register the proxy identifier for the account","tags":[],"parameters":[{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"customerId":"string","accountId":"string","alternateAccountId":"string","proxyType":"string","proxyIdentifier":"string","proxyStatus":"string","proxyScheme":"string","proxyRole":"string","extensions":{}}},"responses":{"200":"ProxyIdentifierResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/holdings/accounts/proxyIdentifiers/{proxyIdentifierId}","fullPath":"/api/v4.9.0/holdings/accounts/proxyIdentifiers/{proxyIdentifierId}","operationId":"updateProxyIdentifier","name":"Update the specific proxy identifier to de-register the registered account or customer from the proxy directory","summary":"Update proxy directory for account to de-register the proxy identifier","tags":[],"parameters":[{"name":"proxyIdentifierId","in":"path","type":"string","required":true,"description":""},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"customerId":"string","accountId":"string","alternateAccountId":"string","proxyType":"string","proxyIdentifier":"string","proxyStatus":"string","proxyScheme":"string","proxyRole":"string","extensions":{}}},"responses":{"200":"ProxyIdentifierResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/holdings/accounts/{accountId}/{accountCompany}/{paymentCurrency}/{accountSwitch}/{beneficialCustomer}/payments","fullPath":"/api/v4.9.0/holdings/accounts/{accountId}/{accountCompany}/{paymentCurrency}/{accountSwitch}/{beneficialCustomer}/payments","operationId":"getAccountPaymentDetails","name":"Retrieves the account information that are required for processing or validating an account involved in a payment transaction. Provides the information such as account name, customer number, account type, account currency, IBAN, account switch details, account status (ACTIVE or INACTIVE) and account closure details.","summary":"Retrieves account details required for payment processing","tags":[],"parameters":[{"name":"accountId","in":"path","type":"string","required":true,"description":"Identifier of the account. Often referred to as the account number, yet for consistency this is always referred to as account id. Accepts both IBAN & BBAN"},{"name":"accountCompany","in":"path","type":"string","required":true,"description":"Company of the account to be created"},{"name":"paymentCurrency","in":"path","type":"string","required":true,"description":"This field holds the transaction currency or currency in which payment is initiated. "},{"name":"accountSwitch","in":"path","type":"string","required":true,"description":"Indicates if availability of account switch details should be checked."},{"name":"beneficialCustomer","in":"path","type":"string","required":true,"description":"Indicates if beneficial owners of the account are to be retrieved"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"AccountPaymentDetailsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/accounts/{contractBalanceId}/contractBalances","fullPath":"/api/v4.9.0/holdings/accounts/{contractBalanceId}/contractBalances","operationId":"getContractBalances","name":"Retrieves the contract balances of accounts or contracts with details such as contract currency, balance types, credit and debit movements and opening and closing balance of the respective balance types","summary":"Retrieves contract balances of accounts","tags":[],"parameters":[{"name":"contractBalanceId","in":"path","type":"string","required":true,"description":"Unique Identifier of Contract Balances"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"ContractBalancesResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"PUT","path":"/holdings/accounts/{accountId}/synchronizationError","fullPath":"/api/v4.9.0/holdings/accounts/{accountId}/synchronizationError","operationId":"updateSynchronizationError","name":"Updates error status during synchronization of the account between Transact and Funds authorization microservice.","summary":"Update synchronization error status","tags":[],"parameters":[{"name":"accountId","in":"path","type":"string","required":true,"description":"Identifier of the account. Often referred to as the account number, yet for consistency this is always referred to as account id. Accepts both IBAN & BBAN"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"emergencyBlockError":"string","extensions":{}}},"responses":{"200":"SynchronizationErrorResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/holdings/accounts/{accountId}/accountSwitches/expiringSwitches","fullPath":"/api/v4.9.0/holdings/accounts/{accountId}/accountSwitches/expiringSwitches","operationId":"getExpiringAccountSwitches","name":"Retrieves the details of the expiring account switches for generating alerts such as the bank identifier code, alert date and account id of expiring switch instruction etc.","summary":"Retrieves the details of the expiring switches for generating alerts","tags":[],"parameters":[{"name":"accountId","in":"path","type":"string","required":true,"description":"Identifier of the account. Often referred to as the account number, yet for consistency this is always referred to as account id. Accepts both IBAN & BBAN"},{"name":"alertStatus","in":"query","type":"string","required":false,"description":"Contains status of the Alert to be raised for switching instruction. Possible values are Pending, Sent."},{"name":"alertDate","in":"query","type":"string","required":false,"description":"Indicates the date in which an alert to be raised for a switching instruction."},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"ExpiringAccountSwitchesResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/accounts/{accountId}/accountSwitches","fullPath":"/api/v4.9.0/holdings/accounts/{accountId}/accountSwitches","operationId":"getAccountSwitchDetails","name":"Retrieves details from the account switch directory for the specific account such as the expiry date, status of the switch instruction, effective date of the switch, bank identifier code and IBAN (International Bank Account Number ) etc.","summary":"Retrieves details of the account switch requests","tags":[],"parameters":[{"name":"accountId","in":"path","type":"string","required":true,"description":"Identifier of the account. Often referred to as the account number, yet for consistency this is always referred to as account id. Accepts both IBAN & BBAN"},{"name":"requestDate","in":"query","type":"string","required":false,"description":"Date on which the client's request to be classified as professional has been received."},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"AccountSwitchDetailsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"PUT","path":"/holdings/accounts/{accountId}/accountSwitches","fullPath":"/api/v4.9.0/holdings/accounts/{accountId}/accountSwitches","operationId":"updateAccountSwitchDetails","name":"Updates alert status based on the original IBAN. Used by external systems handling alert generation to mark the status from pending to sent","summary":"Updates alert status from pending to sent for corresponding switch instructions.","tags":[],"parameters":[{"name":"accountId","in":"path","type":"string","required":true,"description":"Identifier of the account. Often referred to as the account number, yet for consistency this is always referred to as account id. Accepts both IBAN & BBAN"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"accountId":"string","switchIBAN":"string","switchAccountId":"string","switchBic":"string","switchClearingCode":"string","requestDate":"string","status":"string","cancelInstruction":"string","cancelDate":"string","expiryDate":"string","IBAN":"string","bicId":"string","effectiveDate":"string","alertDate":"string","alertStatus":"string"}},"responses":{"200":"AccountSwitchDetailsResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/holdings/accounts/{accountId}/accountSwitches/payments","fullPath":"/api/v4.9.0/holdings/accounts/{accountId}/accountSwitches/payments","operationId":"getAccountSwitchPaymentDetails","name":"Retrieves information of the re-routed payments from the payment transaction exit point.","summary":"Retrieves rerouted payment information.","tags":[],"parameters":[{"name":"accountId","in":"path","type":"string","required":true,"description":"Identifier of the account. Often referred to as the account number, yet for consistency this is always referred to as account id. Accepts both IBAN & BBAN"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"AccountSwitchPaymentDetailsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"PUT","path":"/holdings/accounts/accountClosures/{accountId}/approvals","fullPath":"/api/v4.9.0/holdings/accounts/accountClosures/{accountId}/approvals","operationId":"approveAccountClosure","name":"Approves account closure information to allow closing of an account which is no longer in use","summary":"Approves account closure information","tags":[],"parameters":[{"name":"accountId","in":"path","type":"string","required":true,"description":"Identifier of the account. Often referred to as the account number, yet for consistency this is always referred to as account id. Accepts both IBAN & BBAN"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"AccountClosureResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/holdings/accounts/reservedFunds","fullPath":"/api/v4.9.0/holdings/accounts/reservedFunds","operationId":"getReservedFunds","name":"Retrieves the reserved funds details such as reason, amount and period of reservation of the account","summary":"Retrieves the list of reserved funds ","tags":[],"parameters":[{"name":"accountId","in":"query","type":"string","required":false,"description":"Identifier of the account. Often referred to as the account number, yet for consistency this is always referred to as account id. Accepts both IBAN & BBAN"},{"name":"lockedEventReference","in":"query","type":"string","required":false,"description":"Captures the AC.LOCKED.EVENTS id if in case the funds is available and reserved."},{"name":"lockReason","in":"query","type":"string","required":false,"description":"Indicates the simple description for the balance reservation event."},{"name":"fromDate","in":"query","type":"string","required":false,"description":"Indicates the business date from when the balance reservation event is active."},{"name":"toDate","in":"query","type":"string","required":false,"description":"Indicates the business date until when the balance reservation event is active."},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"ReservedFundsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"POST","path":"/holdings/accounts/reservedFunds","fullPath":"/api/v4.9.0/holdings/accounts/reservedFunds","operationId":"createFundsReservation","name":"Creates a funds reservation with details such as account number, block or reserve amount, period of hold transaction, reason for holding. Funds reservations are created to block or reserve funds which restricts any debit movements affecting the account balance below the blocked amount for the specified period on an account.","summary":"Creates a credit or debit funds reservation to block the funds in an account","tags":[],"parameters":[{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"accountId":"string","lockReason":"string","fromDate":"2024-01-01","toDate":"2024-01-01","lockedAmount":"string","transactionReference":"string","transactionRetry":"string","systemId":"string","additionalDetail":"string","alternateKey":"string","reservationTypeId":"string","accountLink":"string","action":"string","creditDebitIndicator":"string","reservationIndicator":"string"}},"responses":{"200":"FundsReservationResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/holdings/accounts/reservedFunds/{lockedEventReference}","fullPath":"/api/v4.9.0/holdings/accounts/reservedFunds/{lockedEventReference}","operationId":"updateFundsReservation","name":"Update funds reservation with details such as account number, block or reserve amount, period of hold transaction, reason for holding. Funds reservations are created to block or reserve funds which restricts any debit movements affecting the account balance below the blocked amount for the specified period on an account.","summary":"Update the credit or debit funds reservation to block the funds in an account","tags":[],"parameters":[{"name":"lockedEventReference","in":"path","type":"string","required":true,"description":"Captures the AC.LOCKED.EVENTS id if in case the funds is available and reserved."},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"accountId":"string","lockReason":"string","fromDate":"2024-01-01","toDate":"2024-01-01","lockedAmount":"string","transactionReference":"string","transactionRetry":"string","systemId":"string","additionalDetail":"string","alternateKey":"string","reservationTypeId":"string","accountLink":"string","action":"string","creditDebitIndicator":"string","reservationIndicator":"string"}},"responses":{"200":"FundsReservationResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"DELETE","path":"/holdings/accounts/reservedFunds/{lockedEventReference}","fullPath":"/api/v4.9.0/holdings/accounts/reservedFunds/{lockedEventReference}","operationId":"cancelFundsReservation","name":"Cancels the funds reservation of an account. Funds reservations are created to block or reserve funds which restricts any debit movements affecting the account balance below the blocked amount for the specified period on an account. On removal of the funds reservations, the blocked or reserved amount is now available for usage.","summary":"Cancels the credit or debit funds reservation to unblock the funds in an account","tags":[],"parameters":[{"name":"lockedEventReference","in":"path","type":"string","required":true,"description":"Captures the AC.LOCKED.EVENTS id if in case the funds is available and reserved."},{"name":"payload","in":"body","type":"object","required":false,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}}},"responses":{"200":"FundsReservationResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"POST","path":"/holdings/accounts/internalAccounts/{accountId}","fullPath":"/api/v4.9.0/holdings/accounts/internalAccounts/{accountId}","operationId":"createInternalAccount","name":"Create bank internal account with mandatory details such as account title, short title, mnemonic, account officer. The internal accounts are created and maintained for bank's internal operations such as interbranch, intercompany transactions.","summary":"Create bank internal account","tags":[],"parameters":[{"name":"accountId","in":"path","type":"string","required":true,"description":"Identifier of the account. Often referred to as the account number, yet for consistency this is always referred to as account id. Accepts both IBAN & BBAN"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"otherOfficers":[{}],"postingRestrictIds":[{}],"alternateAcctDetails":[{}],"categoryId":"string","accountTitle":"string","accountTitle2":"string","shortTitle":"string","mnemonic":"string","positionType":"string","accountOfficer":"string","highVolumeTransaction":"string","extensions":{}}},"responses":{"200":"InternalAccountResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/holdings/accounts/internalAccounts/{accountId}","fullPath":"/api/v4.9.0/holdings/accounts/internalAccounts/{accountId}","operationId":"updateInternalAccount","name":"Update bank internal account with details such as short title, account officer, account title, high volume transaction flag, alternate account id, posting restriction. The internal accounts are created and maintained for bank's internal operations such as interbranch, intercompany transactions. ","summary":"Update bank internal account","tags":[],"parameters":[{"name":"accountId","in":"path","type":"string","required":true,"description":"Identifier of the account. Often referred to as the account number, yet for consistency this is always referred to as account id. Accepts both IBAN & BBAN"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"otherOfficers":[{}],"postingRestrictIds":[{}],"alternateAcctDetails":[{}],"categoryId":"string","accountTitle":"string","accountTitle2":"string","shortTitle":"string","mnemonic":"string","accountOfficer":"string","highVolumeTransaction":"string","extensions":{}}},"responses":{"200":"InternalAccountResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/holdings/accounts/nostroAccounts","fullPath":"/api/v4.9.0/holdings/accounts/nostroAccounts","operationId":"getNostroAccounts","name":"Retrieves the currency, balance and category details of the nostro account","summary":"Retrieves list of nostro account details","tags":[],"parameters":[{"name":"accountId","in":"query","type":"string","required":false,"description":"Identifier of the account. Often referred to as the account number, yet for consistency this is always referred to as account id. Accepts both IBAN & BBAN"},{"name":"customerId","in":"query","type":"string","required":false,"description":"Identifier of the customer"},{"name":"productId","in":"query","type":"string","required":false,"description":"Contains the unique identifier of the product, e.g. the product id of the arrangement account."},{"name":"currencyId","in":"query","type":"string","required":false,"description":"Identifier of the currency. This is the 3-letter ISO 4217 code of the currency."},{"name":"limitReference","in":"query","type":"string","required":false,"description":"Identifies the credit limit reference for the underlying account."},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"NostroAccountsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"POST","path":"/holdings/accounts/nostroAccounts","fullPath":"/api/v4.9.0/holdings/accounts/nostroAccounts","operationId":"createNostroAccount","name":"Create nostro account with mandatory details such as customer, currency, account title, account officer, short title, reconcile account. A nostro account is the shadow or mirror account of the vostro account maintained by the correspondent bank. The nostro account is opened with the correspondent bank as the customer.","summary":"Create nostro account","tags":[],"parameters":[{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"otherOfficers":[{}],"postingRestrictIds":[{}],"customerId":"string","accountTitle":"string","accountTitle2":"string","shortTitle":"string","mnemonic":"string","positionType":"string","currencyId":"string","accountOfficer":"string","reconcileNostroAccount":"string","ownNostro":"string","reconciliationToleranceAmount":"string","highVolumeTransaction":"string","extensions":{}}},"responses":{"200":"NostroAccountResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/holdings/accounts/internalAccounts","fullPath":"/api/v4.9.0/holdings/accounts/internalAccounts","operationId":"getInternalAccounts","name":"Retrieves the currency, balance and category details of the internal account","summary":"Retrieves list of internal account details","tags":[],"parameters":[{"name":"accountId","in":"query","type":"string","required":false,"description":"Identifier of the account. Often referred to as the account number, yet for consistency this is always referred to as account id. Accepts both IBAN & BBAN"},{"name":"productId","in":"query","type":"string","required":false,"description":"Contains the unique identifier of the product, e.g. the product id of the arrangement account."},{"name":"currencyId","in":"query","type":"string","required":false,"description":"Identifier of the currency. This is the 3-letter ISO 4217 code of the currency."},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"InternalAccountsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"PUT","path":"/holdings/accounts/nostroAccounts/{accountId}","fullPath":"/api/v4.9.0/holdings/accounts/nostroAccounts/{accountId}","operationId":"updateNostroAccount","name":"Update nostro account with details such as reconciliation tolerance amount, our actual account number, short title, account officer, account title, high volume transaction flag, posting restriction. A nostro account is the shadow or mirror account of the vostro account maintained by the correspondent bank. The nostro account is opened with the correspondent bank as the customer.","summary":"Update Nostro account","tags":[],"parameters":[{"name":"accountId","in":"path","type":"string","required":true,"description":"Identifier of the account. Often referred to as the account number, yet for consistency this is always referred to as account id. Accepts both IBAN & BBAN"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"otherOfficers":[{}],"postingRestrictIds":[{}],"customerId":"string","accountTitle":"string","accountTitle2":"string","shortTitle":"string","mnemonic":"string","accountOfficer":"string","ownNostro":"string","reconciliationToleranceAmount":"string","highVolumeTransaction":"string","extensions":{}}},"responses":{"200":"NostroAccountResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/holdings/nostros/positions/{currencyId}","fullPath":"/api/v4.9.0/holdings/nostros/positions/{currencyId}","operationId":"getNostroPositions","name":"Retrieves nostro account balances for a given currency from the current date to the next five days.","summary":"Retrieves consolidated nostro account positions for the currency","tags":[],"parameters":[{"name":"currencyId","in":"path","type":"string","required":true,"description":"Identifier of the currency. This is the 3-letter ISO 4217 code of the currency."},{"name":"longPositionSign","in":"query","type":"string","required":false,"description":"Polarity (sign) used to denote buy position balance.  "},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"NostroPositionsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/accounts/{accountId}/transactionRetries/cancellations","fullPath":"/api/v4.9.0/holdings/accounts/{accountId}/transactionRetries/cancellations","operationId":"getTransactionRetryCancellations","name":"Retrieves the cancellation request applied on a single transaction retry or multiple transaction retries pertaining to an account with information such as transaction retry id, transaction retry change type and transaction retry change value.","summary":"Retrieves the cancellation request applied on a single transaction retry or multiple transaction retries pertaining to an account.","tags":[],"parameters":[{"name":"accountId","in":"path","type":"string","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"TransactionRetryCancellationsResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"POST","path":"/holdings/accounts/{accountId}/transactionRetries/cancellations","fullPath":"/api/v4.9.0/holdings/accounts/{accountId}/transactionRetries/cancellations","operationId":"createTransactionRetryCancellations","name":"Creates a cancellation request for a single transaction retry or multiple transaction retries pertaining to an account. The request will terminate the transaction from further retry.","summary":"Creates a cancellation request for a single transaction retry or multiple transaction retries pertaining to an account.","tags":[],"parameters":[{"name":"accountId","in":"path","type":"string","required":true,"description":"Identifier of the account. Often referred to as the account number, yet for consistency this is always referred to as account id. Accepts both IBAN & BBAN"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"transactionRetryIds":[{}],"extensions":{}}},"responses":{"200":"TransactionRetryCancellationsResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/holdings/accounts/{accountId}/transactionRetries/pendings","fullPath":"/api/v4.9.0/holdings/accounts/{accountId}/transactionRetries/pendings","operationId":"getPendingTransactionRetries","name":"Retrieves various details from pending transaction retries pertaining to an account, such as retry start date, retry end date, retry frequency, retry amount, number of possible retries, total number of retries attempted, details of latest retry attempted and information of successful retry. Transaction Retries - Bank Transfer transactions transition through various payment statuses and in some cases a payment may move to a status from which users are unable to complete their payment. Example: In","summary":"Retrieves the pending transaction retries pertaining to an account","tags":[],"parameters":[{"name":"accountId","in":"path","type":"string","required":true,"description":"Identifier of the account. Often referred to as the account number, yet for consistency this is always referred to as account id. Accepts both IBAN & BBAN"},{"name":"transactionRetryId","in":"query","type":"string","required":false,"description":"Indicates the transaction retry identifier"},{"name":"numberOfTransactionRetries","in":"query","type":"string","required":false,"description":"Indicates the number of times the transaction has to be retried."},{"name":"transactionRetryStartDate","in":"query","type":"string","required":false,"description":"Indicates the date when the transaction retry has started."},{"name":"transactionRetryEndDate","in":"query","type":"string","required":false,"description":"Indicates the date till when the transaction has to be retried."},{"name":"nextTransactionRetryDate","in":"query","type":"string","required":false,"description":"Indicates the date when transaction has to be retried next."},{"name":"transactionType","in":"query","type":"string","required":false,"description":"Identifies the transaction type applicable to the transaction being processed, i.e. outward or inward payment. For example: ACPX, OTPX etc."},{"name":"contractId","in":"query","type":"string","required":false,"description":"Indicates the unique identifier of the transaction or contract which initiated the activity"},{"name":"productGroupId","in":"query","type":"string","required":false,"description":"The group, as defined by the institution, that the product belongs to."},{"name":"productId","in":"query","type":"string","required":false,"description":"Contains the unique identifier of the product, e.g. the product id of the arrangement account."},{"name":"arrangementId","in":"query","type":"string","required":false,"description":"Indicates an unique identifier of an account"},{"name":"transactionRetryStatus","in":"query","type":"string","required":false,"description":"Indicates the transaction retry status. Possible values are: NEW - Indicates transaction is captured for retry and transaction retry is yet to be processed, CURRENT - Transaction is currently being re"},{"name":"retrySettlementStatus","in":"query","type":"string","required":false,"description":"Indicates the transaction settlement status. Possible values are: PENDING - Indicates that the transaction is yet to be settled through retry, SETTLED - Indicates that the transaction is fully settled"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"PendingTransactionRetriesResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"PUT","path":"/holdings/accounts/{accountId}/accounts","fullPath":"/api/v4.9.0/holdings/accounts/{accountId}/accounts","operationId":"updateAccount","name":"Update the account details to block or unblock the account by setting the posting restriction and to change the nick name of the account","summary":"Update the account's details","tags":["RETAIL"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"accountId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"productId":"string","drawdownDate":"2024-01-01","extensions":{},"balance":[{}]}},"responses":{"200":"updateAccountResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"PUT","path":"/holdings/accounts/{accountId}/dormancyStatus/reactivations","fullPath":"/api/v4.9.0/holdings/accounts/{accountId}/dormancyStatus/reactivations","operationId":"updateAccountDormancyReactivation","name":"Reset the dormant account to active status manually","summary":"Reset the account dormancy status","tags":["RETAIL"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"accountId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"effectiveDate":"2024-01-01","productId":"string","extensions":{}}},"responses":{"200":"updateAccountDormancyReactivationResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"PUT","path":"/holdings/accounts/{accountId}/withdrawalNotices","fullPath":"/api/v4.9.0/holdings/accounts/{accountId}/withdrawalNotices","operationId":"createAccountWithdrawalNotice","name":"Notifies the withdrawal of amount from account by providing the withdrawal date and amount etc. This is applicable only for notice type of accounts.","summary":"Notifies the Withdrawal amount from account","tags":["RETAIL"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"accountId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"parties":[{}],"activityId":"string","effectiveDate":"string","productId":"string","currencyId":"string","simulationId":"string","extensions":{},"noticeWithdrawal":[{}]}},"responses":{"200":"createAccountWithdrawalNoticeResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"PUT","path":"/holdings/accounts/{accountId}/migrations/balances","fullPath":"/api/v4.9.0/holdings/accounts/{accountId}/migrations/balances","operationId":"","name":"Captures the balance details of the account such as balance type, due amount etc. This is used to migrate the balances of a legacy contract which is migrated from other system & update the balance details","summary":"Captures outstanding balance details of of a contract migrated from legacy system","tags":["RETAIL"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"accountId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":null,"responses":{"200":"","default":"","400":"","500":""}},{"method":"PUT","path":"/holdings/accounts/{accountId}/credits","fullPath":"/api/v4.9.0/holdings/accounts/{accountId}/credits","operationId":"updateAccountCredit","name":"Perform credit transactions in an account, providing the credit amount and the currency in which to be credited","summary":"Perform credit transaction in an account.","tags":["RETAIL"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"accountId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"currencyId":"string","effectiveDate":"2024-01-01","activityId":"string","transactionAmount":0.0,"contractId":"string","systemId":"string","externalEventStatus":"string","extensions":{}}},"responses":{"200":"updateAccountCreditResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"PUT","path":"/holdings/accounts/{accountId}/debits","fullPath":"/api/v4.9.0/holdings/accounts/{accountId}/debits","operationId":"updateAccountDebit","name":"Perform debit transactions in an account by providing debit amount and currency in which to be debited","summary":"Perform debit transactions in an account","tags":["RETAIL"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"accountId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"currencyId":"string","effectiveDate":"2024-01-01","activityId":"string","transactionAmount":0.0,"contractId":"string","systemId":"string","externalEventStatus":"string","extensions":{}}},"responses":{"200":"updateAccountDebitResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"PUT","path":"/holdings/accounts/{accountId}/adjustments","fullPath":"/api/v4.9.0/holdings/accounts/{accountId}/adjustments","operationId":"updateAccountAdjustment","name":"Performs backdated adjustment and re-acrrual for the given savings account.  This is used when interest adjustment is required due to backdated rate change or transaction.","summary":"Performs backdated adjustment and re-acrrual for the given savings account ","tags":["RETAIL"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"accountId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"currencyId":"string","effectiveDate":"2024-01-01","activityId":"string","transactionAmount":0.0,"contractId":"string","systemId":"string","externalEventStatus":"string","extensions":{}}},"responses":{"200":"updateAccountAdjustmentResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"PUT","path":"/holdings/accounts/{accountId}/products","fullPath":"/api/v4.9.0/holdings/accounts/{accountId}/products","operationId":"updateAccountProduct","name":"Change the arrangement from one product to another in the same product group","summary":"Change account from one product to another","tags":["RETAIL"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"accountId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"effectiveDate":"2024-01-01","productId":"string","extensions":{},"balance":[{}]}},"responses":{"200":"updateAccountProductResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"PUT","path":"/holdings/accounts/{accountId}/dormancyStatus/{status}","fullPath":"/api/v4.9.0/holdings/accounts/{accountId}/dormancyStatus/{status}","operationId":"updateAccountDormancyStatus","name":"Update the active accounts to inoperative/dormancy status","summary":"De-activates the saccount to given status","tags":["RETAIL"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"accountId","in":"path","type":"string","required":true,"description":""},{"name":"status","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"effectiveDate":"2024-01-01","productId":"string","extensions":{}}},"responses":{"200":"updateAccountDormancyStatusResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"POST","path":"/holdings/accounts/migrations","fullPath":"/api/v4.9.0/holdings/accounts/migrations","operationId":"initiateAccountMigration","name":"Migration of a legacy system account contract to the given account product by providing the original contract date, account name, statement, payment frequency and start date, etc.\u00c2\u00a0","summary":"Migration of legacy system account contract to the given account product","tags":["RETAIL"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"parties":[{}],"activityId":"string","effectiveDate":"string","productId":"string","currencyId":"string","simulationId":"string","extensions":{},"limit":[{}],"balance":[{}],"customer":[{}],"crinterest":[{}],"schedule":[{}],"settlement":[{}],"statement":[{}]}},"responses":{"200":"initiateAccountMigrationResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"PUT","path":"/holdings/accounts/{accountId}/limits","fullPath":"/api/v4.9.0/holdings/accounts/{accountId}/limits","operationId":"updateAccountLimit","name":"Update the limit of an account","summary":"Update the limit of an account","tags":["RETAIL"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"accountId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"parties":[{}],"activityId":"string","effectiveDate":"string","productId":"string","currencyId":"string","simulationId":"string","extensions":{},"limit":[{}]}},"responses":{"200":"updateAccountLimitResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"PUT","path":"/holdings/accounts/{accountId}/channels","fullPath":"/api/v4.9.0/holdings/accounts/{accountId}/channels","operationId":"updateAccountChannel","name":"Updates the channel of the account","summary":"Change of channel for the account","tags":["RETAIL"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"accountId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"effectiveDate":"2024-01-01","channel":"string","extensions":{}}},"responses":{"200":"updateAccountChannelResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"PUT","path":"/holdings/accounts/{accountId}/interestConditions","fullPath":"/api/v4.9.0/holdings/accounts/{accountId}/interestConditions","operationId":"updateAccountInterestConditions","name":"Update the interest on an account","summary":"Update the interest on an account","tags":["RETAIL"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"accountId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"effectiveDate":"2024-01-01","channel":"string","extensions":{},"crinterest":[{}]}},"responses":{"200":"updateAccountInterestConditionsResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"PUT","path":"/holdings/accounts/{accountId}/lineofBusiness","fullPath":"/api/v4.9.0/holdings/accounts/{accountId}/lineofBusiness","operationId":"updateAccountLob","name":"Updates the type of line of business of the account","summary":"Change of line of business for the account","tags":["RETAIL"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"accountId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"effectiveDate":"2024-01-01","lineOfBusiness":"string","extensions":{}}},"responses":{"200":"updateAccountLobResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"PUT","path":"/holdings/accounts/{accountId}/{status}","fullPath":"/api/v4.9.0/holdings/accounts/{accountId}/{status}","operationId":"updateAccountDormancyStatus","name":"De-activates the savings account and moves it to given dormancy status.","summary":"De-activates the savings account to given status","tags":["RETAIL"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"accountId","in":"path","type":"string","required":true,"description":""},{"name":"status","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"effectiveDate":"2024-01-01","productId":"string","extensions":{}}},"responses":{"200":"updateAccountDormancyStatusResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}}]},{"key":"holdings-alerts-service-v1.0.0","title":"Manage Arrangement Account alerts","version":"v1.0.0","description":"Retrieves alert details for accounts","endpointCount":4,"endpoints":[{"method":"GET","path":"/holdings/arrangements/{arrangementId}/alertRequests","fullPath":"/api/v1.0.0/holdings/arrangements/{arrangementId}/alertRequests","operationId":"getSubscribedAlerts","name":"Retrieves subscribed alerts details","summary":"Retrieves the subscribed alerts details for an arrangement","tags":[],"parameters":[{"name":"arrangementId","in":"path","type":"string","required":true,"description":"Indicates an unique identifier of an account"},{"name":"customerId","in":"query","type":"string","required":false,"description":"Identifier of the customer"},{"name":"subscribe","in":"query","type":"string","required":false,"description":"Enables an alert service"},{"name":"alertRequestId","in":"query","type":"string","required":false,"description":"The unique identifier of the alert request."},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from t24 on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"SubscribedAlertsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"PUT","path":"/holdings/arrangements/alertRequests/{alertRequestId}","fullPath":"/api/v1.0.0/holdings/arrangements/alertRequests/{alertRequestId}","operationId":"updateAlertSubscription","name":"Update alert subscription details","summary":"Updates the alert subscription details for online banking user","tags":[],"parameters":[{"name":"alertRequestId","in":"path","type":"string","required":true,"description":"The unique identifier of the alert request."},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"fields":[{}],"eventId":"string","contractReference":"string","customerId":"string","subscribe":"string"}},"responses":{"200":"AlertSubscriptionResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"POST","path":"/holdings/arrangements/alertRequests","fullPath":"/api/v1.0.0/holdings/arrangements/alertRequests","operationId":"createAlertSubscription","name":"Creates alert subscription","summary":"Initiate an alert request for online banking user","tags":[],"parameters":[{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"fields":[{}],"eventId":"string","contractReference":"string","customerId":"string","subscribe":"string"}},"responses":{"200":"AlertSubscriptionResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/holdings/accounts/{accountId}/alertEvents","fullPath":"/api/v1.0.0/holdings/accounts/{accountId}/alertEvents","operationId":"getEligibleEvents","name":"Retrieves eligible alerts for the account","summary":"Retrieves the eligible alerts available for the account","tags":[],"parameters":[{"name":"accountId","in":"path","type":"string","required":true,"description":"Identifier of the account. Often referred to as the account number, yet for consistency this is always referred to as accountId. Accepts both IBAN & BBAN"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from t24 on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"EligibleEventsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}}]},{"key":"holdings-alerts-service-v1.1.0","title":"Manage Arrangement Account alerts","version":"v1.1.0","description":"Retrieves alert details for accounts","endpointCount":5,"endpoints":[{"method":"GET","path":"/holdings/arrangements/{arrangementId}/alertRequests","fullPath":"/api/v1.1.0/holdings/arrangements/{arrangementId}/alertRequests","operationId":"getSubscribedAlerts","name":"Retrieves subscribed alerts details","summary":"Retrieves the subscribed alerts details for an arrangement","tags":[],"parameters":[{"name":"arrangementId","in":"path","type":"string","required":true,"description":"Indicates an unique identifier of an account"},{"name":"customerId","in":"query","type":"string","required":false,"description":"Identifier of the customer"},{"name":"subscribe","in":"query","type":"string","required":false,"description":"Enables an alert service"},{"name":"alertRequestId","in":"query","type":"string","required":false,"description":"The unique identifier of the alert request."},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from t24 on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"SubscribedAlertsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/accounts/{accountId}/alertEvents","fullPath":"/api/v1.1.0/holdings/accounts/{accountId}/alertEvents","operationId":"getEligibleEvents","name":"Retrieves eligible alerts for the account","summary":"Retrieves the eligible alerts available for the account","tags":[],"parameters":[{"name":"accountId","in":"path","type":"string","required":true,"description":"Identifier of the account. Often referred to as the account number, yet for consistency this is always referred to as accountId. Accepts both IBAN & BBAN"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from t24 on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"EligibleEventsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/arrangements/alertRequests/externalSubscriptions","fullPath":"/api/v1.1.0/holdings/arrangements/alertRequests/externalSubscriptions","operationId":"getExternalSubscribersAlertRequests","name":"Retrieves alert request details for external subscriptions such as the external customer identifier, contract reference and external user identifier.","summary":"Retrieves alert requests for external subscriptions.","tags":[],"parameters":[{"name":"eventId","in":"query","type":"string","required":false,"description":"Event identifier"},{"name":"contractReference","in":"query","type":"string","required":false,"description":"Contains the contract reference"},{"name":"customerId","in":"query","type":"string","required":false,"description":"Identifier of the customer"},{"name":"externalUserId","in":"query","type":"string","required":false,"description":"Contains the external user identifier for which the consent is created."},{"name":"externalCustomerId","in":"query","type":"string","required":false,"description":"Identifier of the external customer"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from t24 on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"ExternalSubscribersAlertRequestsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"POST","path":"/holdings/arrangements/alertRequests","fullPath":"/api/v1.1.0/holdings/arrangements/alertRequests","operationId":"createAlertSubscription","name":"Initiate an alert request or external subscription.","summary":"Creates alert for external subscription.","tags":[],"parameters":[{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"accountOfficers":[{}],"fields":[{}],"eventId":"string","contractReference":"string","customerId":"string","subscribe":"string","externalUserId":"string","externalCustomerId":"string"}},"responses":{"200":"AlertSubscriptionResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/holdings/arrangements/alertRequests/{alertRequestId}","fullPath":"/api/v1.1.0/holdings/arrangements/alertRequests/{alertRequestId}","operationId":"updateAlertSubscription","name":"Update alert subscription details","summary":"Updates the alert subscription details for online banking user","tags":[],"parameters":[{"name":"alertRequestId","in":"path","type":"string","required":true,"description":"The unique identifier of the alert request."},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"accountOfficers":[{}],"fields":[{}],"eventId":"string","contractReference":"string","customerId":"string","subscribe":"string","externalUserId":"string","externalCustomerId":"string"}},"responses":{"200":"AlertSubscriptionResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}}]},{"key":"holdings-arrangements-activities-v1.0.0","title":"Arrangement Activities","version":"v1.0.0","description":"API to retrieve the activity details of an arrangement account","endpointCount":9,"endpoints":[{"method":"GET","path":"/holdings/logs/{arrangementId}/activities","fullPath":"/api/v1.0.0/holdings/logs/{arrangementId}/activities","operationId":"getArrangementActivityLog","name":"Retrieves the activity log of an account","summary":"Retrieves the activity log of an account","tags":[],"parameters":[{"name":"arrangementId","in":"path","type":"string","required":true,"description":"Indicates an unique identifier of an account"},{"name":"simulation","in":"query","type":"string","required":false,"description":"What if scenario reference"},{"name":"startDate","in":"query","type":"string","required":false,"description":"Contains the date on which the transaction or payment gets initiated."},{"name":"endDate","in":"query","type":"string","required":false,"description":"Indicates the date till which the transaction history requested. If 20120101 is the start date and 20120201 is the end date, all transactions that are booked between January 1 to February 1 2012 are r"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from t24 on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"The identifier of the underlying Entity/Company/Branch."}],"requestBodyExample":null,"responses":{"200":"ArrangementActivityLogResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/logs/{arrangementId}/financialActivities","fullPath":"/api/v1.0.0/holdings/logs/{arrangementId}/financialActivities","operationId":"getFinancialActivities","name":"Retrieves the Financial Activity Log of an account","summary":"Retrieves the Financial Activity Log of an account","tags":[],"parameters":[{"name":"arrangementId","in":"path","type":"string","required":true,"description":"Indicates an unique identifier of an account"},{"name":"simulationReference","in":"query","type":"string","required":false,"description":"Indicates the Reference ID for simulation activity"},{"name":"startDate","in":"query","type":"string","required":false,"description":"Contains the date on which the transaction or payment gets initiated."},{"name":"endDate","in":"query","type":"string","required":false,"description":"Indicates the date till which the transaction history requested. If 20120101 is the start date and 20120201 is the end date, all transactions that are booked between January 1 to February 1 2012 are r"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from t24 on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"The identifier of the underlying Entity/Company/Branch."}],"requestBodyExample":null,"responses":{"200":"FinancialActivitiesResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/logs/{arrangementId}/userActivities","fullPath":"/api/v1.0.0/holdings/logs/{arrangementId}/userActivities","operationId":"getUserActivities","name":"Lists the User related activity logs of an account","summary":"Lists the User related activity logs of an account","tags":[],"parameters":[{"name":"arrangementId","in":"path","type":"string","required":true,"description":"Indicates an unique identifier of an account"},{"name":"simulationReference","in":"query","type":"string","required":false,"description":"Indicates the Reference ID for simulation activity"},{"name":"startDate","in":"query","type":"string","required":false,"description":"Contains the date on which the transaction or payment gets initiated."},{"name":"endDate","in":"query","type":"string","required":false,"description":"Indicates the date till which the transaction history requested. If 20120101 is the start date and 20120201 is the end date, all transactions that are booked between January 1 to February 1 2012 are r"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from t24 on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"The identifier of the underlying Entity/Company/Branch."}],"requestBodyExample":null,"responses":{"200":"UserActivitiesResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/logs/{arrangementId}/systemActivities","fullPath":"/api/v1.0.0/holdings/logs/{arrangementId}/systemActivities","operationId":"getSystemActivities","name":"Retrieves the System activities of an account","summary":"Retrieves the System activities of an account","tags":[],"parameters":[{"name":"arrangementId","in":"path","type":"string","required":true,"description":"Indicates an unique identifier of an account"},{"name":"simulationReference","in":"query","type":"string","required":false,"description":"Indicates the Reference ID for simulation activity"},{"name":"startDate","in":"query","type":"string","required":false,"description":"Contains the date on which the transaction or payment gets initiated."},{"name":"endDate","in":"query","type":"string","required":false,"description":"Indicates the date till which the transaction history requested. If 20120101 is the start date and 20120201 is the end date, all transactions that are booked between January 1 to February 1 2012 are r"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from t24 on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"The identifier of the underlying Entity/Company/Branch."}],"requestBodyExample":null,"responses":{"200":"SystemActivitiesResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/logs/{arrangementId}/holdActivities","fullPath":"/api/v1.0.0/holdings/logs/{arrangementId}/holdActivities","operationId":"getHoldActivities","name":"Retrieves the log of an activity in hold of an account","summary":"Retrieves the log of an activity in hold of an account","tags":[],"parameters":[{"name":"arrangementId","in":"path","type":"string","required":true,"description":"Indicates an unique identifier of an account"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from t24 on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"The identifier of the underlying Entity/Company/Branch."}],"requestBodyExample":null,"responses":{"200":"HoldActivitiesResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/logs/{arrangementId}/archievedActivities","fullPath":"/api/v1.0.0/holdings/logs/{arrangementId}/archievedActivities","operationId":"getArchievedActivities","name":"Retrieves the archieved activity log of an account","summary":"Retrieves the archieved activity log of an account","tags":[],"parameters":[{"name":"arrangementId","in":"path","type":"string","required":true,"description":"Indicates an unique identifier of an account"},{"name":"simulationReference","in":"query","type":"string","required":false,"description":"Indicates the Reference ID for simulation activity"},{"name":"startDate","in":"query","type":"string","required":false,"description":"Contains the date on which the transaction or payment gets initiated."},{"name":"endDate","in":"query","type":"string","required":false,"description":"Indicates the date till which the transaction history requested. If 20120101 is the start date and 20120201 is the end date, all transactions that are booked between January 1 to February 1 2012 are r"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from t24 on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"The identifier of the underlying Entity/Company/Branch."}],"requestBodyExample":null,"responses":{"200":"ArchievedActivitiesResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/accounts/{accountId}/transactionLog","fullPath":"/api/v1.0.0/holdings/accounts/{accountId}/transactionLog","operationId":"getAccountSummary","name":"Retrieves the transaction list for a given Account Number","summary":"Retrieves the transaction list for a given Account Number","tags":[],"parameters":[{"name":"accountId","in":"path","type":"string","required":true,"description":"The identifier of the account. Often referred to as the account number, yet for consistency this is always referred to as accountId."},{"name":"startDate","in":"query","type":"string","required":false,"description":"The start date"},{"name":"endDate","in":"query","type":"string","required":false,"description":"The date an agreement or contract ceases - the opposite of start date"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from t24 on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":""},{"name":"companyId","in":"header","type":"string","required":false,"description":"The identifier of the company, following the format CCGGGLLLL, where: CC is the country code, GGG is Company Group Code and LLLL is the Local Code. Country Code must be a valid countryCode, Company Gr"}],"requestBodyExample":null,"responses":{"200":"AccountSummaryResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/accounts/{arrangementId}/activities","fullPath":"/api/v1.0.0/holdings/accounts/{arrangementId}/activities","operationId":"getArrangementActivities","name":"Retrieves the list of activities applicable for an arrangement account","summary":"Retrieves the list of activities applicable for an arrangement account","tags":[],"parameters":[{"name":"arrangementId","in":"path","type":"string","required":true,"description":"The unique identifiier of an arrangement contract. The format of the ID is YYDDDXXXXX prefixed with AA. YYDDD is the year and date of input in julian date format, XXXXX - is a random generated string."},{"name":"activityId","in":"query","type":"string","required":false,"description":"The identifier of the activity"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from t24 on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":""},{"name":"companyId","in":"header","type":"string","required":false,"description":"The identifier of the company, following the format CCGGGLLLL, where: CC is the country code, GGG is Company Group Code and LLLL is the Local Code. Country Code must be a valid countryCode, Company Gr"}],"requestBodyExample":null,"responses":{"200":"ArrangementActivitiesResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/accounts/unapprovedAAActivites","fullPath":"/api/v1.0.0/holdings/accounts/unapprovedAAActivites","operationId":"getUnauthorisedAAA","name":"Retrieves the list of unauthorised activities of an account","summary":"Retrieves the list of unauthorised activities of an account","tags":[],"parameters":[{"name":"customerId","in":"query","type":"string","required":false,"description":"The identifier of the customer"},{"name":"activity","in":"query","type":"string","required":false,"description":""},{"name":"arrangementId","in":"query","type":"string","required":false,"description":"The unique identifiier of an arrangement contract. The format of the ID is YYDDDXXXXX prefixed with AA. YYDDD is the year and date of input in julian date format, XXXXX - is a random generated string."},{"name":"product","in":"query","type":"string","required":false,"description":""},{"name":"currency","in":"query","type":"string","required":false,"description":""},{"name":"contractId","in":"query","type":"string","required":false,"description":"The identifier of the contract"},{"name":"transactionAmount","in":"query","type":"string","required":false,"description":"The transaction amount"},{"name":"transactionAmountLocalCurrency","in":"query","type":"string","required":false,"description":""},{"name":"applicationId","in":"query","type":"string","required":false,"description":"The identifier of the application"},{"name":"inputter","in":"query","type":"string","required":false,"description":"This shows the user who entered the transaction"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from t24 on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":""},{"name":"companyId","in":"header","type":"string","required":false,"description":"The identifier of the company, following the format CCGGGLLLL, where: CC is the country code, GGG is Company Group Code and LLLL is the Local Code. Country Code must be a valid countryCode, Company Gr"}],"requestBodyExample":null,"responses":{"200":"UnauthorisedAAAResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}}]},{"key":"holdings-arrangements-activities-v1.0.1","title":"Arrangement Activities","version":"v1.0.1","description":"API to retrieve the activity details of an arrangement account","endpointCount":9,"endpoints":[{"method":"GET","path":"/holdings/logs/{arrangementId}/activities","fullPath":"/api/v1.0.1/holdings/logs/{arrangementId}/activities","operationId":"getArrangementActivityLog","name":"Retrieves the activity log of an account-This API is deprecated and going forward the following URL has to be used.URL:/holdings/arrangements/{arrangementId}/activities","summary":"Retrieves the activity log of an account","tags":[],"parameters":[{"name":"arrangementId","in":"path","type":"string","required":true,"description":"Indicates an unique identifier of an account"},{"name":"simulation","in":"query","type":"string","required":false,"description":"What if scenario reference"},{"name":"startDate","in":"query","type":"string","required":false,"description":"Contains the date on which the transaction or payment gets initiated."},{"name":"endDate","in":"query","type":"string","required":false,"description":"Indicates the date till which the transaction history requested. If 20120101 is the start date and 20120201 is the end date, all transactions that are booked between January 1 to February 1 2012 are r"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"ArrangementActivityLogResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/logs/{arrangementId}/financialActivities","fullPath":"/api/v1.0.1/holdings/logs/{arrangementId}/financialActivities","operationId":"getFinancialActivities","name":"Retrieves the Financial Activity Log of an account-This API is deprecated and going forward the following URL has to be used.URL:/holdings/arrangements/{arrangementId}/financialActivities","summary":"Retrieves the Financial Activity Log of an account","tags":[],"parameters":[{"name":"arrangementId","in":"path","type":"string","required":true,"description":"Indicates an unique identifier of an account"},{"name":"simulationReference","in":"query","type":"string","required":false,"description":"Indicates the Reference ID for simulation activity"},{"name":"startDate","in":"query","type":"string","required":false,"description":"Contains the date on which the transaction or payment gets initiated."},{"name":"endDate","in":"query","type":"string","required":false,"description":"Indicates the date till which the transaction history requested. If 20120101 is the start date and 20120201 is the end date, all transactions that are booked between January 1 to February 1 2012 are r"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"FinancialActivitiesResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/logs/{arrangementId}/userActivities","fullPath":"/api/v1.0.1/holdings/logs/{arrangementId}/userActivities","operationId":"getUserActivities","name":"Lists the User related activity logs of an account-This API is deprecated and going forward the following URL has to be used.URL:/holdings/arrangements/{arrangementId}/userActivities","summary":"Lists the User related activity logs of an account","tags":[],"parameters":[{"name":"arrangementId","in":"path","type":"string","required":true,"description":"Indicates an unique identifier of an account"},{"name":"simulationReference","in":"query","type":"string","required":false,"description":"Indicates the Reference ID for simulation activity"},{"name":"startDate","in":"query","type":"string","required":false,"description":"Contains the date on which the transaction or payment gets initiated."},{"name":"endDate","in":"query","type":"string","required":false,"description":"Indicates the date till which the transaction history requested. If 20120101 is the start date and 20120201 is the end date, all transactions that are booked between January 1 to February 1 2012 are r"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"UserActivitiesResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/logs/{arrangementId}/systemActivities","fullPath":"/api/v1.0.1/holdings/logs/{arrangementId}/systemActivities","operationId":"getSystemActivities","name":"Retrieves the System activities of an account-This API is deprecated and going forward the following URL has to be used.URL:/holdings/arrangements/{arrangementId}/systemActivities","summary":"Retrieves the System activities of an account","tags":[],"parameters":[{"name":"arrangementId","in":"path","type":"string","required":true,"description":"Indicates an unique identifier of an account"},{"name":"simulationReference","in":"query","type":"string","required":false,"description":"Indicates the Reference ID for simulation activity"},{"name":"startDate","in":"query","type":"string","required":false,"description":"Contains the date on which the transaction or payment gets initiated."},{"name":"endDate","in":"query","type":"string","required":false,"description":"Indicates the date till which the transaction history requested. If 20120101 is the start date and 20120201 is the end date, all transactions that are booked between January 1 to February 1 2012 are r"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"SystemActivitiesResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/logs/{arrangementId}/holdActivities","fullPath":"/api/v1.0.1/holdings/logs/{arrangementId}/holdActivities","operationId":"getHoldActivities","name":"Retrieves the log of an activity in hold of an account-This API is deprecated and going forward the following URL has to be used.URL:/holdings/arrangements/{arrangementId}/holdActivities","summary":"Retrieves the log of an activity in hold of an account","tags":[],"parameters":[{"name":"arrangementId","in":"path","type":"string","required":true,"description":"Indicates an unique identifier of an account"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"HoldActivitiesResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/logs/{arrangementId}/archievedActivities","fullPath":"/api/v1.0.1/holdings/logs/{arrangementId}/archievedActivities","operationId":"getArchievedActivities","name":"Retrieves the archived activity log of an account-This API is deprecated and going forward the following URL has to be used.URL:/holdings/arrangements/{arrangementId}/archievedActivities","summary":"Retrieves the archived activity log of an account","tags":[],"parameters":[{"name":"arrangementId","in":"path","type":"string","required":true,"description":"Indicates an unique identifier of an account"},{"name":"simulationReference","in":"query","type":"string","required":false,"description":"Indicates the Reference ID for simulation activity"},{"name":"startDate","in":"query","type":"string","required":false,"description":"Contains the date on which the transaction or payment gets initiated."},{"name":"endDate","in":"query","type":"string","required":false,"description":"Indicates the date till which the transaction history requested. If 20120101 is the start date and 20120201 is the end date, all transactions that are booked between January 1 to February 1 2012 are r"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"ArchievedActivitiesResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/accounts/{accountId}/transactionLog","fullPath":"/api/v1.0.1/holdings/accounts/{accountId}/transactionLog","operationId":"getAccountSummary","name":"Retrieves the transaction list for a given Account Number-This API is deprecated and going forward the following URL has to be used.URL:/holdings/arrangements/{arrangementId}/transactions","summary":"Retrieves the transaction list for a given Account Number","tags":[],"parameters":[{"name":"accountId","in":"path","type":"string","required":true,"description":"Identifier of the account. Often referred to as the account number, yet for consistency this is always referred to as accountId. Accepts both IBAN & BBAN"},{"name":"startDate","in":"query","type":"string","required":false,"description":"Contains the date on which the transaction or payment gets initiated."},{"name":"endDate","in":"query","type":"string","required":false,"description":"Indicates the date till which the transaction history requested. If 20120101 is the start date and 20120201 is the end date, all transactions that are booked between January 1 to February 1 2012 are r"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"AccountSummaryResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/accounts/{arrangementId}/activities","fullPath":"/api/v1.0.1/holdings/accounts/{arrangementId}/activities","operationId":"getArrangementActivities","name":"Retrieves the list of activities applicable for an arrangement account-This API is deprecated and going forward the following URL has to be used.URL:/holdings/arrangements/{arrangementId}/eligibileActivities","summary":"Retrieves the list of activities applicable for an arrangement account","tags":[],"parameters":[{"name":"arrangementId","in":"path","type":"string","required":true,"description":"Indicates an unique identifier of an account"},{"name":"activityId","in":"query","type":"string","required":false,"description":"Id of the activity, e.g. ACCOUNTS-CAPITALISE-ACCHARGE*CARDISSUEFEE"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"ArrangementActivitiesResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/accounts/unapprovedAAActivites","fullPath":"/api/v1.0.1/holdings/accounts/unapprovedAAActivites","operationId":"getUnauthorisedAAA","name":"Retrieves the list of unauthorised activities of an account.-This API is deprecated and going forward the following URL has to be used.URL:/holdings/arrangements/unapprovedArrangementActivites","summary":"Retrieves the list of unauthorised activities of an account","tags":[],"parameters":[{"name":"customerId","in":"query","type":"string","required":false,"description":"Identifier of the customer"},{"name":"activity","in":"query","type":"string","required":false,"description":"Defines the activity to be processed against the Arrangement. The activity may be a user activity or a system generated activity."},{"name":"arrangementId","in":"query","type":"string","required":false,"description":"Indicates an unique identifier of an account"},{"name":"product","in":"query","type":"string","required":false,"description":"Specifies the list of products licensed for the institution. This will be used to set the products field in the SPF (System Parameter) table and the master company. The products in the company can onl"},{"name":"currency","in":"query","type":"string","required":false,"description":"Identifies the currency. E.g. USD, GBP etc"},{"name":"contractId","in":"query","type":"string","required":false,"description":"Indicates the unique identifier of the transaction or contract which initiated the activity"},{"name":"transactionAmount","in":"query","type":"string","required":false,"description":"Contains the transaction amount. This is based on the currency, either local or foreign currency"},{"name":"transactionAmountLocalCurrency","in":"query","type":"string","required":false,"description":"Indicates the transaction amount in local currency"},{"name":"applicationId","in":"query","type":"string","required":false,"description":"Contains the application id of the service that has crashed due to error."},{"name":"inputter","in":"query","type":"string","required":false,"description":"The user identifier who input the transaction"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"UnauthorisedAAAResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}}]},{"key":"holdings-arrangements-balances-service-v1.0.0","title":"Account arrangement balances","version":"v1.0.0","description":"API to retrieve the balance details for the account arrangements","endpointCount":1,"endpoints":[{"method":"GET","path":"/holdings/arrangements/{arrangementId}/balances","fullPath":"/api/v1.0.0/holdings/arrangements/{arrangementId}/balances","operationId":"getArrangementBalances","name":"This API is deprecated","summary":"","tags":[],"parameters":[{"name":"arrangementId","in":"path","type":"string","required":true,"description":""},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from t24 on every enquiry request."},{"name":"credentials","in":"query","type":"string","required":false,"description":""},{"name":"companyId","in":"query","type":"string","required":false,"description":""}],"requestBodyExample":null,"responses":{"200":"getArrangementBalancesResponse","default":"getArrangementBalancesErrorResponse"}}]},{"key":"holdings-arrangements-productlines-v1.0.0","title":"List of Arrangements for a Product Line","version":"v1.0.0","description":"Manage and retrieves the list of arrangement for a given product line","endpointCount":16,"endpoints":[{"method":"GET","path":"/holdings/productLine/{productLine}/unApprovedDeposits","fullPath":"/api/v1.0.0/v1.0.0/holdings/productLine/{productLine}/unApprovedDeposits","operationId":"getUnapprovedArrangementsDeposits","name":"Retrieves the list of unapproved accounts for the given accounts product","summary":"Retrieves the list of unapproved accounts for the given accounts product","tags":[],"parameters":[{"name":"productLine","in":"path","type":"string","required":true,"description":""},{"name":"customerId","in":"query","type":"string","required":false,"description":"Identifier of the customer"},{"name":"arrangementId","in":"query","type":"string","required":false,"description":"Indicates an unique identifier of an account"},{"name":"productGroupId","in":"query","type":"string","required":false,"description":"The group, as defined by the institution, that the product belongs to."},{"name":"productId","in":"query","type":"string","required":false,"description":"Contains the unique identifier of the product, e.g. the product id of the arrangement account."},{"name":"currency","in":"query","type":"string","required":false,"description":"Identifies the currency. E.g. USD, GBP etc"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"UnapprovedArrangementsDepositsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/productLine/{productLine}/unApprovedLoans","fullPath":"/api/v1.0.0/v1.0.0/holdings/productLine/{productLine}/unApprovedLoans","operationId":"getUnapprovedArrangementsLoans","name":"Retrieves the list of unapproved accounts for the given loan product","summary":"Retrieves the list of unapproved accounts for the given loan product","tags":[],"parameters":[{"name":"productLine","in":"path","type":"string","required":true,"description":""},{"name":"customerId","in":"query","type":"string","required":false,"description":"Identifier of the customer"},{"name":"arrangementId","in":"query","type":"string","required":false,"description":"Indicates an unique identifier of an account"},{"name":"productGroupId","in":"query","type":"string","required":false,"description":"The group, as defined by the institution, that the product belongs to."},{"name":"productId","in":"query","type":"string","required":false,"description":"Contains the unique identifier of the product, e.g. the product id of the arrangement account."},{"name":"currency","in":"query","type":"string","required":false,"description":"Identifies the currency. E.g. USD, GBP etc"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"UnapprovedArrangementsLoansResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/productLine/{productLine}/unApprovedAccounts","fullPath":"/api/v1.0.0/v1.0.0/holdings/productLine/{productLine}/unApprovedAccounts","operationId":"getUnapprovedArrangementsAccounts","name":"Retrieves the list of unapproved accounts for the given account product","summary":"Retrieves the list of unapproved accounts for the given account product","tags":[],"parameters":[{"name":"productLine","in":"path","type":"string","required":true,"description":"The top level product line, which the product is ultimately attached to. May be a Temenos-defined product line such as ACCOUNTS, AGENT, BUNDLE, CONSENT, DEPOSITS, LENDING, REWARDS, etc. or one defined"},{"name":"customerId","in":"query","type":"string","required":false,"description":"Identifier of the customer"},{"name":"arrangementId","in":"query","type":"string","required":false,"description":"Indicates an unique identifier of an account"},{"name":"productGroupId","in":"query","type":"string","required":false,"description":"The group, as defined by the institution, that the product belongs to."},{"name":"currency","in":"query","type":"string","required":false,"description":"Identifies the currency. E.g. USD, GBP etc"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"UnapprovedArrangementsAccountsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/productLine/{productLine}/pendingAccounts","fullPath":"/api/v1.0.0/v1.0.0/holdings/productLine/{productLine}/pendingAccounts","operationId":"getAAPendingArrangementAccounts","name":"Retrieves the list of accounts in hold status for the given accounts product","summary":"Retrieves the list of accounts in hold status for the given accounts product","tags":[],"parameters":[{"name":"productLine","in":"path","type":"string","required":true,"description":""},{"name":"customerId","in":"query","type":"string","required":false,"description":"Identifier of the customer"},{"name":"arrangementId","in":"query","type":"string","required":false,"description":"Indicates an unique identifier of an account"},{"name":"productId","in":"query","type":"string","required":false,"description":"Contains the unique identifier of the product, e.g. the product id of the arrangement account."},{"name":"currency","in":"query","type":"string","required":false,"description":"Identifies the currency. E.g. USD, GBP etc"},{"name":"activityId","in":"query","type":"string","required":false,"description":"Id of the activity, e.g. ACCOUNTS-CAPITALISE-ACCHARGE*CARDISSUEFEE"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"AAPendingArrangementAccountsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/productLine/{productLine}/pendingDeposits","fullPath":"/api/v1.0.0/v1.0.0/holdings/productLine/{productLine}/pendingDeposits","operationId":"getAAPendingArrangementDeposits","name":"Retrieves the list of accounts in hold status for the given deposit product","summary":"Retrieves the list of accounts in hold status for the given deposit product","tags":[],"parameters":[{"name":"productLine","in":"path","type":"string","required":true,"description":""},{"name":"customerId","in":"query","type":"string","required":false,"description":"Identifier of the customer"},{"name":"arrangementId","in":"query","type":"string","required":false,"description":"Indicates an unique identifier of an account"},{"name":"productId","in":"query","type":"string","required":false,"description":"Contains the unique identifier of the product, e.g. the product id of the arrangement account."},{"name":"currency","in":"query","type":"string","required":false,"description":"Identifies the currency. E.g. USD, GBP etc"},{"name":"activityId","in":"query","type":"string","required":false,"description":"Id of the activity, e.g. ACCOUNTS-CAPITALISE-ACCHARGE*CARDISSUEFEE"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"AAPendingArrangementDepositsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/productLine/{productLine}/pendingLoans","fullPath":"/api/v1.0.0/v1.0.0/holdings/productLine/{productLine}/pendingLoans","operationId":"getAAPendingArrangementLoans","name":"Retrieves the list of accounts in hold status for the given lending product","summary":"Retrieves the list of accounts in hold status for the given lending product","tags":[],"parameters":[{"name":"productLine","in":"path","type":"string","required":true,"description":""},{"name":"customerId","in":"query","type":"string","required":false,"description":"Identifier of the customer"},{"name":"arrangementId","in":"query","type":"string","required":false,"description":"Indicates an unique identifier of an account"},{"name":"productId","in":"query","type":"string","required":false,"description":"Contains the unique identifier of the product, e.g. the product id of the arrangement account."},{"name":"currency","in":"query","type":"string","required":false,"description":"Identifies the currency. E.g. USD, GBP etc"},{"name":"activityId","in":"query","type":"string","required":false,"description":"Id of the activity, e.g. ACCOUNTS-CAPITALISE-ACCHARGE*CARDISSUEFEE"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"AAPendingArrangementLoansResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/productLine/{productLine}/approvedAccounts","fullPath":"/api/v1.0.0/v1.0.0/holdings/productLine/{productLine}/approvedAccounts","operationId":"getApprovedAccounts","name":"Retrieves the list of approved accounts created from the accounts products","summary":"Retrieves the list of approved accounts created from the accounts products","tags":[],"parameters":[{"name":"productLine","in":"path","type":"string","required":true,"description":"The top level product line, which the product is ultimately attached to. May be a Temenos-defined product line such as ACCOUNTS, AGENT, BUNDLE, CONSENT, DEPOSITS, LENDING, REWARDS, etc. or one defined"},{"name":"customerId","in":"query","type":"string","required":false,"description":"Identifier of the customer"},{"name":"arrangementId","in":"query","type":"string","required":false,"description":"Indicates an unique identifier of an account"},{"name":"productGroup","in":"query","type":"string","required":false,"description":"Indicates a group under which the products exists"},{"name":"product","in":"query","type":"string","required":false,"description":"Contains the name of the product"},{"name":"currency","in":"query","type":"string","required":false,"description":"Identifies the currency. E.g. USD, GBP etc"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"ApprovedAccountsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/productLine/{productLine}/approvedDeposits","fullPath":"/api/v1.0.0/v1.0.0/holdings/productLine/{productLine}/approvedDeposits","operationId":"getApprovedDeposits","name":"Retrieves the list of approved accounts created from the deposits products","summary":"Retrieves the list of approved accounts created from the deposits products","tags":[],"parameters":[{"name":"productLine","in":"path","type":"string","required":true,"description":""},{"name":"customerId","in":"query","type":"string","required":false,"description":"Identifier of the customer"},{"name":"arrangementId","in":"query","type":"string","required":false,"description":"Indicates an unique identifier of an account"},{"name":"productGroup","in":"query","type":"string","required":false,"description":"Indicates a group under which the products exists"},{"name":"product","in":"query","type":"string","required":false,"description":"Contains the name of the product"},{"name":"currency","in":"query","type":"string","required":false,"description":"Identifies the currency. E.g. USD, GBP etc"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"ApprovedDepositsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/productLine/{productLine}/approvedLoans","fullPath":"/api/v1.0.0/v1.0.0/holdings/productLine/{productLine}/approvedLoans","operationId":"getApprovedLoans","name":"Retrieves the list of approved accounts created from the loan products","summary":"Retrieves the list of approved accounts created from the loan products","tags":[],"parameters":[{"name":"productLine","in":"path","type":"string","required":true,"description":"The top level product line, which the product is ultimately attached to. May be a Temenos-defined product line such as ACCOUNTS, AGENT, BUNDLE, CONSENT, DEPOSITS, LENDING, REWARDS, etc. or one defined"},{"name":"customerId","in":"query","type":"string","required":false,"description":"Identifier of the customer"},{"name":"arrangementId","in":"query","type":"string","required":false,"description":"Indicates an unique identifier of an account"},{"name":"productGroup","in":"query","type":"string","required":false,"description":"Indicates a group under which the products exists"},{"name":"product","in":"query","type":"string","required":false,"description":"Contains the name of the product"},{"name":"currency","in":"query","type":"string","required":false,"description":"Identifies the currency. E.g. USD, GBP etc"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"ApprovedLoansResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/productLine/{productLine}/closedAccounts","fullPath":"/api/v1.0.0/v1.0.0/holdings/productLine/{productLine}/closedAccounts","operationId":"getClosedMaturedAccounts","name":"Retrieves the list of closed or matured accounts for a given accounts product line","summary":"Retrieves the list of closed or matured accounts for a given accounts product line","tags":[],"parameters":[{"name":"productLine","in":"path","type":"string","required":true,"description":""},{"name":"customerId","in":"query","type":"string","required":false,"description":"Identifier of the customer"},{"name":"arrangementId","in":"query","type":"string","required":false,"description":"Indicates an unique identifier of an account"},{"name":"productGroup","in":"query","type":"string","required":false,"description":"Indicates a group under which the products exists"},{"name":"product","in":"query","type":"string","required":false,"description":"Contains the name of the product"},{"name":"currency","in":"query","type":"string","required":false,"description":"Identifies the currency. E.g. USD, GBP etc"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"ClosedMaturedAccountsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/productLine/{productLine}/closedDeposits","fullPath":"/api/v1.0.0/v1.0.0/holdings/productLine/{productLine}/closedDeposits","operationId":"getClosedMaturedDeposits","name":"Retrieves the list of closed or matured accounts for a given deposit product line","summary":"Retrieves the list of closed or matured accounts for a given deposit product line","tags":[],"parameters":[{"name":"productLine","in":"path","type":"string","required":true,"description":""},{"name":"customerId","in":"query","type":"string","required":false,"description":"Identifier of the customer"},{"name":"arrangementId","in":"query","type":"string","required":false,"description":"Indicates an unique identifier of an account"},{"name":"productGroup","in":"query","type":"string","required":false,"description":"Indicates a group under which the products exists"},{"name":"product","in":"query","type":"string","required":false,"description":"Contains the name of the product"},{"name":"currency","in":"query","type":"string","required":false,"description":"Identifies the currency. E.g. USD, GBP etc"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"ClosedMaturedDepositsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/productLine/{productLine}/closedLoans","fullPath":"/api/v1.0.0/v1.0.0/holdings/productLine/{productLine}/closedLoans","operationId":"getClosedMaturedLending","name":"Retrieves the list of closed or matured accounts for a given lending product line","summary":"Retrieves the list of closed or matured accounts for a given lending product line","tags":[],"parameters":[{"name":"productLine","in":"path","type":"string","required":true,"description":""},{"name":"customerId","in":"query","type":"string","required":false,"description":"Identifier of the customer"},{"name":"arrangementId","in":"query","type":"string","required":false,"description":"Indicates an unique identifier of an account"},{"name":"productGroup","in":"query","type":"string","required":false,"description":"Indicates a group under which the products exists"},{"name":"product","in":"query","type":"string","required":false,"description":"Contains the name of the product"},{"name":"currency","in":"query","type":"string","required":false,"description":"Identifies the currency. E.g. USD, GBP etc"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"ClosedMaturedLendingResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/productLine/{productLine}/offerAccounts","fullPath":"/api/v1.0.0/v1.0.0/holdings/productLine/{productLine}/offerAccounts","operationId":"getSimulatedAccounts","name":"Retrieves the list of simulated accounts created under the given accounts product line","summary":"Retrieves the list of simulated accounts created under the given accounts product line","tags":[],"parameters":[{"name":"productLine","in":"path","type":"string","required":true,"description":""},{"name":"owner","in":"query","type":"string","required":false,"description":"User who defines the Campaign"},{"name":"arrangementId","in":"query","type":"string","required":false,"description":"Indicates an unique identifier of an account"},{"name":"currency","in":"query","type":"string","required":false,"description":"Identifies the currency. E.g. USD, GBP etc"},{"name":"offerReference","in":"query","type":"string","required":false,"description":"Indicates the unique id of a simulated activity/transaction"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"SimulatedAccountsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/productLine/{productLine}/offerDeposits","fullPath":"/api/v1.0.0/v1.0.0/holdings/productLine/{productLine}/offerDeposits","operationId":"getSimulatedDeposits","name":"Retrieves the list of simulated accounts created under the given deposit product line","summary":"Retrieves the list of simulated accounts created under the given deposit product line","tags":[],"parameters":[{"name":"productLine","in":"path","type":"string","required":true,"description":""},{"name":"arrangementId","in":"query","type":"string","required":false,"description":"Indicates an unique identifier of an account"},{"name":"owner","in":"query","type":"string","required":false,"description":"User who defines the Campaign"},{"name":"currency","in":"query","type":"string","required":false,"description":"Identifies the currency. E.g. USD, GBP etc"},{"name":"offerReference","in":"query","type":"string","required":false,"description":"Indicates the unique id of a simulated activity/transaction"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"SimulatedDepositsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/productLine/{productLine}/offerLoans","fullPath":"/api/v1.0.0/v1.0.0/holdings/productLine/{productLine}/offerLoans","operationId":"getSimulatedLending","name":"Retrieves the list of simulated accounts created under the given lending product line","summary":"Retrieves the list of simulated accounts created under the given lending product line","tags":[],"parameters":[{"name":"productLine","in":"path","type":"string","required":true,"description":""},{"name":"arrangementId","in":"query","type":"string","required":false,"description":"Indicates an unique identifier of an account"},{"name":"owner","in":"query","type":"string","required":false,"description":"User who defines the Campaign"},{"name":"currency","in":"query","type":"string","required":false,"description":"Identifies the currency. E.g. USD, GBP etc"},{"name":"offerReference","in":"query","type":"string","required":false,"description":"Indicates the unique id of a simulated activity/transaction"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"SimulatedLendingResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/productLine/{productLineId}/approvedArrangements","fullPath":"/api/v1.0.0/v1.0.0/holdings/productLine/{productLineId}/approvedArrangements","operationId":"getApprovedArrangements","name":"Retrieve the list of approved arrangements","summary":"Retrieve the list of approved arrangements","tags":[],"parameters":[{"name":"productLineId","in":"path","type":"string","required":true,"description":""},{"name":"customerId","in":"query","type":"string","required":false,"description":"Identifier of the customer"},{"name":"arrangementId","in":"query","type":"string","required":false,"description":"Indicates an unique identifier of an account"},{"name":"productLine","in":"query","type":"string","required":false,"description":"The top level product line, which the product is ultimately attached to. May be a Temenos-defined product line such as ACCOUNTS, AGENT, BUNDLE, CONSENT, DEPOSITS, LENDING, REWARDS, etc. or one defined"},{"name":"productGroup","in":"query","type":"string","required":false,"description":"Indicates a group under which the products exists"},{"name":"product","in":"query","type":"string","required":false,"description":"Contains the name of the product"},{"name":"currency","in":"query","type":"string","required":false,"description":"Identifies the currency. E.g. USD, GBP etc"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"ApprovedArrangementsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}}]},{"key":"holdings-arrangements-v1.0.0","title":"Arrangement details","version":"v1.0.0","description":"API to retrieve the details of arrangement conditions such as charge, interest, limits, overdue, payment schedule, agent, alerts, and commitment. This API also allows to retrieve the pricing evaluation details, product qualification details, delivery messages, payment order, events and repayment sch","endpointCount":29,"endpoints":[{"method":"GET","path":"/holdings/accounts/{arrangementId}/chargeDetails","fullPath":"/api/v1.0.0/holdings/accounts/{arrangementId}/chargeDetails","operationId":"getChargeDetails","name":"Retrieves the Charge details of an account-This API is deprecated and going forward the following URL has to be used.URL:/holdings/arrangements/{arrangementId}/charges","summary":"Retrieves the Charge details of an account","tags":[],"parameters":[{"name":"arrangementId","in":"path","type":"string","required":true,"description":"Indicates an unique identifier of an account"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"ChargeDetailsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/accounts/{arrangementId}/interestDetails","fullPath":"/api/v1.0.0/holdings/accounts/{arrangementId}/interestDetails","operationId":"getInterestDetails","name":"Retrieves the Interest Condition of an account-This API is deprecated and going forward the following URL has to be used.URL:/holdings/arrangements/{arrangementId}/interestRates","summary":"Retrieves the Interest Condition of an account","tags":[],"parameters":[{"name":"arrangementId","in":"path","type":"string","required":true,"description":"Indicates an unique identifier of an account"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"InterestDetailsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/arrangements/{arrangementId}/limits","fullPath":"/api/v1.0.0/holdings/arrangements/{arrangementId}/limits","operationId":"getLimitDetails","name":"Retrieves the Limit Details of an Arrangement Account","summary":"Retrieves the Limit Details of an Arrangement Account","tags":[],"parameters":[{"name":"arrangementId","in":"path","type":"string","required":true,"description":"Indicates an unique identifier of an account"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"LimitDetailsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/accounts/overdueStatistics","fullPath":"/api/v1.0.0/holdings/accounts/overdueStatistics","operationId":"getOverdueStatistics","name":"Retrieves the Overdue details of an account","summary":"Retrieves the Overdue details of an account","tags":[],"parameters":[{"name":"overdueReference","in":"query","type":"string","required":false,"description":"Indicates the overdue reference"},{"name":"overdueReference_ct","in":"query","type":"string","required":false,"description":"Indicates the criteria for the contains operation on the overdue reference"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"OverdueStatisticsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/accounts/{arrangementId}/scheduleDetails","fullPath":"/api/v1.0.0/holdings/accounts/{arrangementId}/scheduleDetails","operationId":"getScheduleDetails","name":"Retrieves the Payment Schedule Details of an account-This API is deprecated and going forward the following URL has to be used.URL:/holdings/arrangements/{arrangementId}/scheduleDefinitions","summary":"Retrieves the Payment Schedule Details of an account","tags":[],"parameters":[{"name":"arrangementId","in":"path","type":"string","required":true,"description":"Indicates an unique identifier of an account"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"ScheduleDetailsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/accounts/{arrangementId}/repaymentDetails","fullPath":"/api/v1.0.0/holdings/accounts/{arrangementId}/repaymentDetails","operationId":"getRepaymentDetails","name":"Retrieves the Repayment details of an account based on the payment schedule-This API is deprecated and going forward the following URL has to be used.URL:/holdings/arrangements/{arrangementId}/repayments","summary":"Retrieves the Repayment details of an account based on the payment schedule","tags":[],"parameters":[{"name":"arrangementId","in":"path","type":"string","required":true,"description":"Indicates an unique identifier of an account"},{"name":"simulationReference","in":"query","type":"string","required":false,"description":"Indicates the Reference ID for simulation activity"},{"name":"dueDate","in":"query","type":"string","required":false,"description":"Identifies the date on which the activity is due."},{"name":"includeExternalFees","in":"query","type":"string","required":false,"description":"Indicates if external fee is included"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"RepaymentDetailsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/agents/{arrangementId}/agentdetails","fullPath":"/api/v1.0.0/holdings/agents/{arrangementId}/agentdetails","operationId":"getAgentDetails","name":"Retrieves the Agent Details of an account-This API is deprecated and going forward the following URL has to be used.URL:/holdings/arrangements/{arrangementId}/agents","summary":"Retrieves the Agent Details of an account","tags":[],"parameters":[{"name":"arrangementId","in":"path","type":"string","required":true,"description":"Indicates an unique identifier of an account"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"AgentDetailsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/accounts/{accountNumber}/activeAlerts","fullPath":"/api/v1.0.0/holdings/accounts/{accountNumber}/activeAlerts","operationId":"getActiveAlerts","name":"Retrieves the details of active alerts for a given account number","summary":"Retrieves the details of active alerts for a given account number","tags":[],"parameters":[{"name":"accountNumber","in":"path","type":"string","required":true,"description":"Identifier of the account. Often referred to as the account number, yet for consistency this is always referred to as accountId. Accepts both IBAN & BBAN"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"ActiveAlertsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/accounts/{accountNumber}/historyAlerts","fullPath":"/api/v1.0.0/holdings/accounts/{accountNumber}/historyAlerts","operationId":"getHistoryAlerts","name":"Retrieves the details of history alerts for a given account number","summary":"Retrieves the details of history alerts for a given account number","tags":[],"parameters":[{"name":"accountNumber","in":"path","type":"string","required":true,"description":"Identifier of the account. Often referred to as the account number, yet for consistency this is always referred to as accountId. Accepts both IBAN & BBAN"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"HistoryAlertsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/accounts/{arrangementId}/aprRateDetails","fullPath":"/api/v1.0.0/holdings/accounts/{arrangementId}/aprRateDetails","operationId":"getAprDetails","name":"Retrieves the Annual Percentage Rate of an account - This API is deprecated and going forward the following URL has to be used.URL:/holdings/arrangements/{arrangementId}/annualPercentageRates","summary":"Retrieves the Annual Percentage Rate of an account","tags":[],"parameters":[{"name":"arrangementId","in":"path","type":"string","required":true,"description":"Indicates an unique identifier of an account"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"AprDetailsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/arrangements/{arrangementId}/paymentSchedules","fullPath":"/api/v1.0.0/holdings/arrangements/{arrangementId}/paymentSchedules","operationId":"getPaymentSchedule","name":"Retrieves the Payment schedule of an arrangement account","summary":"Retrieves the Payment schedule of an arrangement account","tags":[],"parameters":[{"name":"arrangementId","in":"path","type":"string","required":true,"description":"Indicates an unique identifier of an account"},{"name":"dateFrom","in":"query","type":"string","required":false,"description":"Start date of the loan"},{"name":"dateTo","in":"query","type":"string","required":false,"description":"End date of the loan"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"PaymentScheduleResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/arrangements/{arrangementId}/holidayLimit","fullPath":"/api/v1.0.0/holdings/arrangements/{arrangementId}/holidayLimit","operationId":"getHolidayLimit","name":"Retrieves the details of Payment Holiday Limit Amount","summary":"Retrieves the details of Payment Holiday Limit Amount","tags":[],"parameters":[{"name":"arrangementId","in":"path","type":"string","required":true,"description":"Indicates an unique identifier of an account"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"HolidayLimitResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/accounts/{arrangementId}/commitmentDetails","fullPath":"/api/v1.0.0/holdings/accounts/{arrangementId}/commitmentDetails","operationId":"getCommitmentDetails","name":"Retrieves the Commitment Details of an Account.-This API is deprecated and going forward the following URL has to be used.URL:/holdings/arrangements/{arrangementId}/commitments","summary":"Retrieves the Commitment Details of an Account","tags":[],"parameters":[{"name":"arrangementId","in":"path","type":"string","required":true,"description":"Indicates an unique identifier of an account"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"CommitmentDetailsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/accounts/{arrangementId}/qualifierDetails","fullPath":"/api/v1.0.0/holdings/accounts/{arrangementId}/qualifierDetails","operationId":"getProductQualifierDetails","name":"Retrieves the Product Qualifier details of an account-This API is deprecated and going forward the following URL has to be used.URL:/holdings/arrangements/{arrangementId}/qualifiers","summary":"Retrieves the Product Qualifier details of an account","tags":[],"parameters":[{"name":"arrangementId","in":"path","type":"string","required":true,"description":"Indicates an unique identifier of an account"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"ProductQualifierDetailsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/accounts/{arrangementId}/evaluationDetails","fullPath":"/api/v1.0.0/holdings/accounts/{arrangementId}/evaluationDetails","operationId":"getEvaluationDetails","name":"Retrieves the Pricing Evaluation details of an accountRetrieves the Pricing Evaluation details of an account-This API is deprecated and going forward the following URL has to be used.URL:/holdings/arrangements/{arrangementId}/evaluations","summary":"Retrieves the Pricing Evaluation details of an account","tags":[],"parameters":[{"name":"arrangementId","in":"path","type":"string","required":true,"description":"Indicates an unique identifier of an account"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"EvaluationDetailsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/accounts/{arrangementId}/dates","fullPath":"/api/v1.0.0/holdings/accounts/{arrangementId}/dates","operationId":"getArrangementDates","name":"Retrieves the key dates of an account","summary":"Retrieves the key dates of an account","tags":[],"parameters":[{"name":"arrangementId","in":"path","type":"string","required":true,"description":"Indicates an unique identifier of an account"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"ArrangementDatesResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/arrangements/interestDetailsCurrent/{arrangementId}","fullPath":"/api/v1.0.0/holdings/arrangements/interestDetailsCurrent/{arrangementId}","operationId":"getInterestDetailsCurrent","name":"Retrieves the interest accrued for the current period of an account-This API is deprecated and going forward the following URL has to be used.URL:/holdings/arrangements/{arrangementId}/interestAccruals","summary":"Retrieves the interest accrued for the current period of an account","tags":[],"parameters":[{"name":"arrangementId","in":"path","type":"string","required":true,"description":"Indicates an unique identifier of an account"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"InterestDetailsCurrentResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/arrangements/interestDetailsPrevious/{arrangementId}","fullPath":"/api/v1.0.0/holdings/arrangements/interestDetailsPrevious/{arrangementId}","operationId":"getInterestDetailsPrevious","name":"Retrieve the past period's interest accruals-This API is deprecated and going forward the following URL has to be used.URL:/holdings/arrangements/{arrangementId}/historicInterestAccruals","summary":"Retrieve the past period's interest accruals","tags":[],"parameters":[{"name":"arrangementId","in":"path","type":"string","required":true,"description":"Indicates an unique identifier of an account"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"InterestDetailsPreviousResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/arrangements/interestDetailsYearToDate/{arrangementId}","fullPath":"/api/v1.0.0/holdings/arrangements/interestDetailsYearToDate/{arrangementId}","operationId":"getInterestDetailsYearToDate","name":"Retrieves the interest accruals of the Previous year-This API is deprecated and going forward the following URL has to be used.URL:/holdings/arrangements/{arrangementId}/yearToDateInterests","summary":"Retrieves the interest accruals of the Previous year","tags":[],"parameters":[{"name":"arrangementId","in":"path","type":"string","required":true,"description":"Indicates an unique identifier of an account"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"InterestDetailsYearToDateResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/accounts/{arrangementId}/messages","fullPath":"/api/v1.0.0/holdings/accounts/{arrangementId}/messages","operationId":"getDeliveryMessages","name":"Retrieves the details of delivery messages for a given arrangement Id","summary":"Retrieves the details of delivery messages for a given arrangement Id","tags":[],"parameters":[{"name":"arrangementId","in":"path","type":"string","required":true,"description":"Indicates an unique identifier of an account"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"DeliveryMessagesResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/accounts/{arrangementId}/historyMessages","fullPath":"/api/v1.0.0/holdings/accounts/{arrangementId}/historyMessages","operationId":"getDeliveryMessagesHistory","name":"Retrieves the details of history delivery messages for a given arrangement Id","summary":"Retrieves the details of history delivery messages for a given arrangement Id","tags":[],"parameters":[{"name":"arrangementId","in":"path","type":"string","required":true,"description":"Indicates an unique identifier of an account"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"DeliveryMessagesHistoryResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/paymentOrder/{creditAccountId}/paymentOrderPayments","fullPath":"/api/v1.0.0/holdings/paymentOrder/{creditAccountId}/paymentOrderPayments","operationId":"getPaymentOrderReceipts","name":"Retrieves the details of Payment Order receipts for a given account number-This API is deprecated as this a Payments API","summary":"Retrieves the details of Payment Order receipts for a given account number","tags":[],"parameters":[{"name":"creditAccountId","in":"path","type":"string","required":true,"description":"Credit account identifier of the payment or transaction"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"PaymentOrderReceiptsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/paymentOrder/{debitAccountId}/paymentOrderPayments","fullPath":"/api/v1.0.0/holdings/paymentOrder/{debitAccountId}/paymentOrderPayments","operationId":"getPaymentOrderPayments","name":"Retrieves the details of Payment Order payments for a given account number-This API is deprecated as this is a Payments API","summary":"Retrieves the details of Payment Order payments for a given account number","tags":[],"parameters":[{"name":"debitAccountId","in":"path","type":"string","required":true,"description":"Indicates the debit account number of the payment or transaction."},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"PaymentOrderPaymentsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/arrangements/{arrangementId}/stmtEntries","fullPath":"/api/v1.0.0/holdings/arrangements/{arrangementId}/stmtEntries","operationId":"getStmtEntries","name":"Retrieves the Statement entries of an arrangement account","summary":"Retrieves the Statement entries of an arrangement account","tags":[],"parameters":[{"name":"arrangementId","in":"path","type":"string","required":true,"description":"Indicates an unique identifier of an account"},{"name":"valueDate","in":"query","type":"string","required":false,"description":"Indicates the value date on which the underlying accounting entry is to be given value (for interest purposes)"},{"name":"stmtFlag","in":"query","type":"string","required":false,"description":"Indicates the statement flag"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"StmtEntriesResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/arrangements/{arrangementId}/dataEvents","fullPath":"/api/v1.0.0/holdings/arrangements/{arrangementId}/dataEvents","operationId":"getArrangementPropertyConditions","name":"Retrives and updates the property conditions to the data events","summary":"Retrives the property conditions","tags":[],"parameters":[{"name":"arrangementId","in":"path","type":"string","required":true,"description":"Indicates an unique identifier of an account"},{"name":"status","in":"query","type":"string","required":false,"description":"Contains status of the data rights request.Allowed values are INITIATED, INPROGESS, EXTENDED, COMPLETED, REJECTED."},{"name":"arrangementActivityId","in":"query","type":"string","required":false,"description":"The unique identifier of an arrangement activity"},{"name":"effectiveDate","in":"query","type":"string","required":false,"description":"Contains the identifier for the transaction date. Dates are expected in \u00e2\u20ac\u02dcYYYYMMDD\u00e2\u20ac\u2122 format"},{"name":"property","in":"query","type":"string","required":false,"description":"Id of the product property"},{"name":"dataEvent","in":"query","type":"string","required":false,"description":"Indicates the data event flag"},{"name":"ofsSource","in":"query","type":"string","required":false,"description":"Indicates the source of the ofs"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"ArrangementPropertyConditionsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/arrangements/{arrangementId}/schedules","fullPath":"/api/v1.0.0/holdings/arrangements/{arrangementId}/schedules","operationId":"getSchedulesFull","name":"Retrieves the Repayment Schedule details for an arrangement","summary":"Retrieves the Repayment Schedule details for an arrangement","tags":[],"parameters":[{"name":"arrangementId","in":"path","type":"string","required":true,"description":"Indicates an unique identifier of an account"},{"name":"simulationReference","in":"query","type":"string","required":false,"description":"Indicates the Reference ID for simulation activity"},{"name":"dateFrom","in":"query","type":"string","required":false,"description":"Start date of the loan"},{"name":"dateTo","in":"query","type":"string","required":false,"description":"End date of the loan"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"SchedulesFullResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/arrangements/{arrangementActivityId}/simulations","fullPath":"/api/v1.0.0/holdings/arrangements/{arrangementActivityId}/simulations","operationId":"getSimulationReference","name":"Retrieves the Simulation Reference for the given Arrangement Activity Id -This API is deprecated and going forward the following URL has to be used.URL:/holdings/arrangements/{arrangementActivityId}/simulationReferences","summary":"Retrieves the Simulation Reference for the given Arrangement Activity Id","tags":[],"parameters":[{"name":"arrangementActivityId","in":"path","type":"string","required":true,"description":"The unique identifier of an arrangement activity"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"SimulationReferenceResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/arrangement/{arrangementId}/alerts","fullPath":"/api/v1.0.0/holdings/arrangement/{arrangementId}/alerts","operationId":"getArrangementAlerts","name":"Retrieves the List of Alerts applicable for an arrangement","summary":"Retrieves the List of Alerts applicable for an arrangement","tags":[],"parameters":[{"name":"arrangementId","in":"path","type":"string","required":true,"description":"Indicates an unique identifier of an account"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"ArrangementAlertsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/simulation/{arrangementId}/simulationDetails","fullPath":"/api/v1.0.0/holdings/simulation/{arrangementId}/simulationDetails","operationId":"getSimulationDetails","name":"Retrieves the Simulated activity details of an account-This API is deprecated and going forward the following URL has to be used.URL:/holdings/arrangements/{arrangementId}/simulations","summary":"Retrieves the Simulated activity details of an account","tags":[],"parameters":[{"name":"arrangementId","in":"path","type":"string","required":true,"description":"Indicates an unique identifier of an account"},{"name":"simulationCaptureReferenceId","in":"query","type":"string","required":false,"description":"Indicates the Reference Id for the simulation activity"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"SimulationDetailsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}}]},{"key":"holdings-arrangements-v3.0.0","title":"Arrangement details","version":"v3.0.0","description":"API to retrieve the details of arrangement conditions such as charge, interest, limits, overdue, payment schedule, agent, alerts, and commitment. This API also allows to retrieve the pricing evaluation details, product qualification details, delivery messages, payment order, events and repayment sch","endpointCount":52,"endpoints":[{"method":"GET","path":"/holdings/arrangements/{arrangementId}/charges","fullPath":"/api/v3.0.0/holdings/arrangements/{arrangementId}/charges","operationId":"getChargeDetails","name":"Retrieves the Charge details of an account","summary":"Retrieves the Charge details of an account","tags":[],"parameters":[{"name":"arrangementId","in":"path","type":"string","required":true,"description":"Indicates an unique identifier of an account"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"ChargeDetailsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/arrangements/{arrangementId}/interestRates","fullPath":"/api/v3.0.0/holdings/arrangements/{arrangementId}/interestRates","operationId":"getInterestDetails","name":"Retrieves the Interest Condition of an account","summary":"Retrieves the Interest Condition of an account","tags":[],"parameters":[{"name":"arrangementId","in":"path","type":"string","required":true,"description":"Indicates an unique identifier of an account"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"InterestDetailsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/arrangements/{arrangementId}/limits","fullPath":"/api/v3.0.0/holdings/arrangements/{arrangementId}/limits","operationId":"getLimitDetails","name":"Retrieves the Limit Details of an Arrangement Account","summary":"Retrieves the Limit Details of an Arrangement Account","tags":[],"parameters":[{"name":"arrangementId","in":"path","type":"string","required":true,"description":"Indicates an unique identifier of an account"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"LimitDetailsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/accounts/overdueStatistics","fullPath":"/api/v3.0.0/holdings/accounts/overdueStatistics","operationId":"getOverdueStatistics","name":"Retrieves the Overdue details of an account","summary":"Retrieves the Overdue details of an account","tags":[],"parameters":[{"name":"overdueReference","in":"query","type":"string","required":false,"description":"Indicates the overdue reference"},{"name":"overdueReference_ct","in":"query","type":"string","required":false,"description":"Indicates the criteria for the contains operation on the overdue reference"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"OverdueStatisticsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/arrangements/{arrangementId}/scheduleDefinitions","fullPath":"/api/v3.0.0/holdings/arrangements/{arrangementId}/scheduleDefinitions","operationId":"getScheduleDetails","name":"Retrieves the Payment Schedule Details of an account","summary":"Retrieves the Payment Schedule Details of an account","tags":[],"parameters":[{"name":"arrangementId","in":"path","type":"string","required":true,"description":"Indicates an unique identifier of an account"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"ScheduleDetailsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/arrangements/{arrangementId}/repayments","fullPath":"/api/v3.0.0/holdings/arrangements/{arrangementId}/repayments","operationId":"getRepaymentDetails","name":"Retrieves the Repayment details of an account based on the payment schedule","summary":"Retrieves the Repayment details of an account based on the payment schedule","tags":[],"parameters":[{"name":"arrangementId","in":"path","type":"string","required":true,"description":"Indicates an unique identifier of an account"},{"name":"simulationReference","in":"query","type":"string","required":false,"description":"Indicates the Reference ID for simulation activity"},{"name":"dueDate","in":"query","type":"string","required":false,"description":"Identifies the date on which the activity is due."},{"name":"includeExternalFees","in":"query","type":"string","required":false,"description":"Indicates if external fee is included"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"RepaymentDetailsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/arrangements/{arrangementId}/agents","fullPath":"/api/v3.0.0/holdings/arrangements/{arrangementId}/agents","operationId":"getAgentDetails","name":"Retrieves the Agent Details of an account","summary":"Retrieves the Agent Details of an account","tags":[],"parameters":[{"name":"arrangementId","in":"path","type":"string","required":true,"description":"Indicates an unique identifier of an account"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"AgentDetailsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/accounts/{accountNumber}/activeAlerts","fullPath":"/api/v3.0.0/holdings/accounts/{accountNumber}/activeAlerts","operationId":"getActiveAlerts","name":"Retrieves the details of active alerts for a given account number","summary":"Retrieves the details of active alerts for a given account number","tags":[],"parameters":[{"name":"accountNumber","in":"path","type":"string","required":true,"description":"Identifier of the account. Often referred to as the account number, yet for consistency this is always referred to as accountId. Accepts both IBAN & BBAN"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"ActiveAlertsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/accounts/{accountNumber}/historyAlerts","fullPath":"/api/v3.0.0/holdings/accounts/{accountNumber}/historyAlerts","operationId":"getHistoryAlerts","name":"Retrieves the details of history alerts for a given account number","summary":"Retrieves the details of history alerts for a given account number","tags":[],"parameters":[{"name":"accountNumber","in":"path","type":"string","required":true,"description":"Identifier of the account. Often referred to as the account number, yet for consistency this is always referred to as accountId. Accepts both IBAN & BBAN"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"HistoryAlertsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/arrangements/{arrangementId}/annualPercentageRates","fullPath":"/api/v3.0.0/holdings/arrangements/{arrangementId}/annualPercentageRates","operationId":"getAprDetails","name":"Retrieves the Annual Percentage Rate of an account","summary":"Retrieves the Annual Percentage Rate of an account","tags":[],"parameters":[{"name":"arrangementId","in":"path","type":"string","required":true,"description":"Indicates an unique identifier of an account"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"AprDetailsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/arrangements/{arrangementId}/paymentSchedules","fullPath":"/api/v3.0.0/holdings/arrangements/{arrangementId}/paymentSchedules","operationId":"getPaymentSchedule","name":"Retrieves the Payment schedule of an arrangement account","summary":"Retrieves the Payment schedule of an arrangement account","tags":[],"parameters":[{"name":"arrangementId","in":"path","type":"string","required":true,"description":"Indicates an unique identifier of an account"},{"name":"dateFrom","in":"query","type":"string","required":false,"description":"Start date of the loan"},{"name":"dateTo","in":"query","type":"string","required":false,"description":"End date of the loan"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"PaymentScheduleResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/arrangements/{arrangementId}/holidayLimit","fullPath":"/api/v3.0.0/holdings/arrangements/{arrangementId}/holidayLimit","operationId":"getHolidayLimit","name":"Retrieves the details of Payment Holiday Limit Amount","summary":"Retrieves the details of Payment Holiday Limit Amount","tags":[],"parameters":[{"name":"arrangementId","in":"path","type":"string","required":true,"description":"Indicates an unique identifier of an account"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"HolidayLimitResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/arrangements/{arrangementId}/commitments","fullPath":"/api/v3.0.0/holdings/arrangements/{arrangementId}/commitments","operationId":"getCommitmentDetails","name":"Retrieves the Commitment Details of an Account","summary":"Retrieves the Commitment Details of an Account","tags":[],"parameters":[{"name":"arrangementId","in":"path","type":"string","required":true,"description":"Indicates an unique identifier of an account"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"CommitmentDetailsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/arrangements/{arrangementId}/qualifiers","fullPath":"/api/v3.0.0/holdings/arrangements/{arrangementId}/qualifiers","operationId":"getProductQualifierDetails","name":"Retrieves the Product Qualifier details of an account","summary":"Retrieves the Product Qualifier details of an account","tags":[],"parameters":[{"name":"arrangementId","in":"path","type":"string","required":true,"description":"Indicates an unique identifier of an account"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"ProductQualifierDetailsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/arrangements/{arrangementId}/evaluations","fullPath":"/api/v3.0.0/holdings/arrangements/{arrangementId}/evaluations","operationId":"getEvaluationDetails","name":"Retrieves the Pricing Evaluation details of an account.Retrieves the Pricing Evaluation details of an account","summary":"Retrieves the Pricing Evaluation details of an account","tags":[],"parameters":[{"name":"arrangementId","in":"path","type":"string","required":true,"description":"Indicates an unique identifier of an account"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"EvaluationDetailsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/accounts/{arrangementId}/dates","fullPath":"/api/v3.0.0/holdings/accounts/{arrangementId}/dates","operationId":"getArrangementDates","name":"Retrieves the key dates of an account","summary":"Retrieves the key dates of an account","tags":[],"parameters":[{"name":"arrangementId","in":"path","type":"string","required":true,"description":"Indicates an unique identifier of an account"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"ArrangementDatesResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/arrangements/{arrangementId}/interestAccruals","fullPath":"/api/v3.0.0/holdings/arrangements/{arrangementId}/interestAccruals","operationId":"getInterestDetailsCurrent","name":"Retrieves the interest accrued for the current period of an account","summary":"Retrieves the interest accrued for the current period of an account","tags":[],"parameters":[{"name":"arrangementId","in":"path","type":"string","required":true,"description":"Indicates an unique identifier of an account"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"InterestDetailsCurrentResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/arrangements/{arrangementId}/historicInterestAccruals","fullPath":"/api/v3.0.0/holdings/arrangements/{arrangementId}/historicInterestAccruals","operationId":"getInterestDetailsPrevious","name":"Retrieve the past period's interest accruals","summary":"Retrieve the past period's interest accruals","tags":[],"parameters":[{"name":"arrangementId","in":"path","type":"string","required":true,"description":"Indicates an unique identifier of an account"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"InterestDetailsPreviousResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/arrangements/{arrangementId}/yearToDateInterestAccruals","fullPath":"/api/v3.0.0/holdings/arrangements/{arrangementId}/yearToDateInterestAccruals","operationId":"getInterestDetailsYearToDate","name":"Retrieves the interest accruals of the Previous year","summary":"Retrieves the interest accruals of the Previous year","tags":[],"parameters":[{"name":"arrangementId","in":"path","type":"string","required":true,"description":"Indicates an unique identifier of an account"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"InterestDetailsYearToDateResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/accounts/{arrangementId}/messages","fullPath":"/api/v3.0.0/holdings/accounts/{arrangementId}/messages","operationId":"getDeliveryMessages","name":"Retrieves the details of delivery messages for a given arrangement Id","summary":"Retrieves the details of delivery messages for a given arrangement Id","tags":[],"parameters":[{"name":"arrangementId","in":"path","type":"string","required":true,"description":"Indicates an unique identifier of an account"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"DeliveryMessagesResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/accounts/{arrangementId}/historyMessages","fullPath":"/api/v3.0.0/holdings/accounts/{arrangementId}/historyMessages","operationId":"getDeliveryMessagesHistory","name":"Retrieves the details of history delivery messages for a given arrangement Id","summary":"Retrieves the details of history delivery messages for a given arrangement Id","tags":[],"parameters":[{"name":"arrangementId","in":"path","type":"string","required":true,"description":"Indicates an unique identifier of an account"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"DeliveryMessagesHistoryResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/arrangements/{arrangementId}/stmtEntries","fullPath":"/api/v3.0.0/holdings/arrangements/{arrangementId}/stmtEntries","operationId":"getStmtEntries","name":"Retrieves the Statement entries of an arrangement account","summary":"Retrieves the Statement entries of an arrangement account","tags":[],"parameters":[{"name":"arrangementId","in":"path","type":"string","required":true,"description":"Indicates an unique identifier of an account"},{"name":"valueDate","in":"query","type":"string","required":false,"description":"Indicates the value date on which the underlying accounting entry is to be given value (for interest purposes)"},{"name":"stmtFlag","in":"query","type":"string","required":false,"description":"Indicates the statement flag"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"StmtEntriesResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/arrangements/{arrangementId}/dataEvents","fullPath":"/api/v3.0.0/holdings/arrangements/{arrangementId}/dataEvents","operationId":"getArrangementPropertyConditions","name":"Retrieves and updates the property conditions to the data events","summary":"Retrieves the property conditions","tags":[],"parameters":[{"name":"arrangementId","in":"path","type":"string","required":true,"description":"Indicates an unique identifier of an account"},{"name":"status","in":"query","type":"string","required":false,"description":"Contains status of the data rights request.Allowed values are INITIATED, INPROGESS, EXTENDED, COMPLETED, REJECTED."},{"name":"arrangementActivityId","in":"query","type":"string","required":false,"description":"The unique identifier of an arrangement activity"},{"name":"effectiveDate","in":"query","type":"string","required":false,"description":"Contains the identifier for the transaction date. Dates are expected in \u00e2\u20ac\u02dcYYYYMMDD\u00e2\u20ac\u2122 format"},{"name":"property","in":"query","type":"string","required":false,"description":"Id of the product property"},{"name":"dataEvent","in":"query","type":"string","required":false,"description":"Indicates the data event flag"},{"name":"ofsSource","in":"query","type":"string","required":false,"description":"Indicates the source of the ofs"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"ArrangementPropertyConditionsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/arrangements/{arrangementId}/schedules","fullPath":"/api/v3.0.0/holdings/arrangements/{arrangementId}/schedules","operationId":"getSchedulesFull","name":"Retrieves the Repayment Schedule details for an arrangement","summary":"Retrieves the Repayment Schedule details for an arrangement","tags":[],"parameters":[{"name":"arrangementId","in":"path","type":"string","required":true,"description":"Indicates an unique identifier of an account"},{"name":"simulationReference","in":"query","type":"string","required":false,"description":"Indicates the Reference ID for simulation activity"},{"name":"dateFrom","in":"query","type":"string","required":false,"description":"Start date of the loan"},{"name":"dateTo","in":"query","type":"string","required":false,"description":"End date of the loan"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"SchedulesFullResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/arrangements/{arrangementActivityId}/simulationReferences","fullPath":"/api/v3.0.0/holdings/arrangements/{arrangementActivityId}/simulationReferences","operationId":"getSimulationReference","name":"Retrieves the Simulation Reference for the given Arrangement Activity Id","summary":"Retrieves the Simulation Reference for the given Arrangement Activity Id","tags":[],"parameters":[{"name":"arrangementActivityId","in":"path","type":"string","required":true,"description":"The unique identifier of an arrangement activity"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"SimulationReferenceResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/arrangement/{arrangementId}/alerts","fullPath":"/api/v3.0.0/holdings/arrangement/{arrangementId}/alerts","operationId":"getArrangementAlerts","name":"Retrieves the List of Alerts applicable for an arrangement","summary":"Retrieves the List of Alerts applicable for an arrangement","tags":[],"parameters":[{"name":"arrangementId","in":"path","type":"string","required":true,"description":"Indicates an unique identifier of an account"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"ArrangementAlertsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/arrangements/{arrangementId}/simulations","fullPath":"/api/v3.0.0/holdings/arrangements/{arrangementId}/simulations","operationId":"getSimulationDetails","name":"Retrieves the Simulated activity details of an account","summary":"Retrieves the Simulated activity details of an account","tags":[],"parameters":[{"name":"arrangementId","in":"path","type":"string","required":true,"description":"Indicates an unique identifier of an account"},{"name":"simulationCaptureReferenceId","in":"query","type":"string","required":false,"description":"Indicates the Reference Id for the simulation activity"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"SimulationDetailsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/customers/{customerId}/arrangements","fullPath":"/api/v3.0.0/holdings/customers/{customerId}/arrangements","operationId":"getCustomerArrangementDetails","name":"Retrieves the list of Arrangement Ids for a givenCustomer","summary":"Retrieves the list of Arrangement Ids for a given Customer","tags":[],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"Identifier of the customer"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"CustomerArrangementDetailsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/arrangements/{arrangementId}/chargeOffBalances","fullPath":"/api/v3.0.0/holdings/arrangements/{arrangementId}/chargeOffBalances","operationId":"getChargeOffDetails","name":"Retrieves the Charge Off balances of an arrangement account","summary":"Retrieves the Charge Off balances of an arrangement account","tags":[],"parameters":[{"name":"arrangementId","in":"path","type":"string","required":true,"description":"Indicates an unique identifier of an account"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"ChargeOffDetailsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/arrangements/{arrangementId}/consolidatedBalances","fullPath":"/api/v3.0.0/holdings/arrangements/{arrangementId}/consolidatedBalances","operationId":"getVirtualBalances","name":"Retrieves the virtual balances for a balance type of an account","summary":"Retrieves the virtual balances for a balance type of an account","tags":[],"parameters":[{"name":"arrangementId","in":"path","type":"string","required":true,"description":"Indicates an unique identifier of an account"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"VirtualBalancesResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/arrangements/{arrangementId}/activities","fullPath":"/api/v3.0.0/holdings/arrangements/{arrangementId}/activities","operationId":"getArrangementActivityLog","name":"Retrieves the activity log of an account","summary":"Retrieves the activity log of an account","tags":[],"parameters":[{"name":"arrangementId","in":"path","type":"string","required":true,"description":"Indicates an unique identifier of an account"},{"name":"simulation","in":"query","type":"string","required":false,"description":"What if scenario reference"},{"name":"startDate","in":"query","type":"string","required":false,"description":"Contains the date on which the transaction or payment gets initiated."},{"name":"endDate","in":"query","type":"string","required":false,"description":"Indicates the date till which the transaction history requested. If 20120101 is the start date and 20120201 is the end date, all transactions that are booked between January 1 to February 1 2012 are r"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"ArrangementActivityLogResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/arrangements/{arrangementId}/financialActivities","fullPath":"/api/v3.0.0/holdings/arrangements/{arrangementId}/financialActivities","operationId":"getFinancialActivities","name":"Retrieves the Financial Activity Log of an account","summary":"Retrieves the Financial Activity Log of an account","tags":[],"parameters":[{"name":"arrangementId","in":"path","type":"string","required":true,"description":"Indicates an unique identifier of an account"},{"name":"simulationReference","in":"query","type":"string","required":false,"description":"Indicates the Reference ID for simulation activity"},{"name":"startDate","in":"query","type":"string","required":false,"description":"Contains the date on which the transaction or payment gets initiated."},{"name":"endDate","in":"query","type":"string","required":false,"description":"Indicates the date till which the transaction history requested. If 20120101 is the start date and 20120201 is the end date, all transactions that are booked between January 1 to February 1 2012 are r"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"FinancialActivitiesResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/arrangements/{arrangementId}/userActivities","fullPath":"/api/v3.0.0/holdings/arrangements/{arrangementId}/userActivities","operationId":"getUserActivities","name":"Lists the User related activity logs of an account","summary":"Lists the User related activity logs of an account","tags":[],"parameters":[{"name":"arrangementId","in":"path","type":"string","required":true,"description":"Indicates an unique identifier of an account"},{"name":"simulationReference","in":"query","type":"string","required":false,"description":"Indicates the Reference ID for simulation activity"},{"name":"startDate","in":"query","type":"string","required":false,"description":"Contains the date on which the transaction or payment gets initiated."},{"name":"endDate","in":"query","type":"string","required":false,"description":"Indicates the date till which the transaction history requested. If 20120101 is the start date and 20120201 is the end date, all transactions that are booked between January 1 to February 1 2012 are r"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"UserActivitiesResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/arrangements/{arrangementId}/systemActivities","fullPath":"/api/v3.0.0/holdings/arrangements/{arrangementId}/systemActivities","operationId":"getSystemActivities","name":"Retrieves the System activities of an account","summary":"Retrieves the System activities of an account","tags":[],"parameters":[{"name":"arrangementId","in":"path","type":"string","required":true,"description":"Indicates an unique identifier of an account"},{"name":"simulationReference","in":"query","type":"string","required":false,"description":"Indicates the Reference ID for simulation activity"},{"name":"startDate","in":"query","type":"string","required":false,"description":"Contains the date on which the transaction or payment gets initiated."},{"name":"endDate","in":"query","type":"string","required":false,"description":"Indicates the date till which the transaction history requested. If 20120101 is the start date and 20120201 is the end date, all transactions that are booked between January 1 to February 1 2012 are r"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"SystemActivitiesResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/arrangements/{arrangementId}/holdActivities","fullPath":"/api/v3.0.0/holdings/arrangements/{arrangementId}/holdActivities","operationId":"getHoldActivities","name":"Retrieves the log of an activity in hold of an account","summary":"Retrieves the log of an activity in hold of an account","tags":[],"parameters":[{"name":"arrangementId","in":"path","type":"string","required":true,"description":"Indicates an unique identifier of an account"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"HoldActivitiesResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/arrangements/{arrangementId}/archievedActivities","fullPath":"/api/v3.0.0/holdings/arrangements/{arrangementId}/archievedActivities","operationId":"getArchievedActivities","name":"Retrieves the archived activity log of an account","summary":"Retrieves the archived activity log of an account","tags":[],"parameters":[{"name":"arrangementId","in":"path","type":"string","required":true,"description":"Indicates an unique identifier of an account"},{"name":"simulationReference","in":"query","type":"string","required":false,"description":"Indicates the Reference ID for simulation activity"},{"name":"startDate","in":"query","type":"string","required":false,"description":"Contains the date on which the transaction or payment gets initiated."},{"name":"endDate","in":"query","type":"string","required":false,"description":"Indicates the date till which the transaction history requested. If 20120101 is the start date and 20120201 is the end date, all transactions that are booked between January 1 to February 1 2012 are r"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"ArchievedActivitiesResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/arrangements/{arrangementId}/transactions","fullPath":"/api/v3.0.0/holdings/arrangements/{arrangementId}/transactions","operationId":"getAccountSummary","name":"Retrieves the transaction list for a given Account Number","summary":"Retrieves the transaction list for a given Account Number","tags":[],"parameters":[{"name":"arrangementId","in":"path","type":"string","required":true,"description":"Indicates an unique identifier of an account"},{"name":"startDate","in":"query","type":"string","required":false,"description":"Contains the date on which the transaction or payment gets initiated."},{"name":"endDate","in":"query","type":"string","required":false,"description":"Indicates the date till which the transaction history requested. If 20120101 is the start date and 20120201 is the end date, all transactions that are booked between January 1 to February 1 2012 are r"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"AccountSummaryResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/arrangements/{arrangementId}/eligibileActivities","fullPath":"/api/v3.0.0/holdings/arrangements/{arrangementId}/eligibileActivities","operationId":"getArrangementActivities","name":"Retrieves the list of activities applicable for an arrangement account","summary":"Retrieves the list of activities applicable for an arrangement account","tags":[],"parameters":[{"name":"arrangementId","in":"path","type":"string","required":true,"description":"Indicates an unique identifier of an account"},{"name":"activityId","in":"query","type":"string","required":false,"description":"Id of the activity, e.g. ACCOUNTS-CAPITALISE-ACCHARGE*CARDISSUEFEE"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"ArrangementActivitiesResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/arrangements/unapprovedArrangementActivites","fullPath":"/api/v3.0.0/holdings/arrangements/unapprovedArrangementActivites","operationId":"getUnauthorisedAAA","name":"Retrieves the list of unauthorised activities of an account","summary":"Retrieves the list of unauthorised activities of an account","tags":[],"parameters":[{"name":"customerId","in":"query","type":"string","required":false,"description":"Identifier of the customer"},{"name":"activity","in":"query","type":"string","required":false,"description":"Defines the activity to be processed against the Arrangement. The activity may be a user activity or a system generated activity."},{"name":"arrangementId","in":"query","type":"string","required":false,"description":"Indicates an unique identifier of an account"},{"name":"product","in":"query","type":"string","required":false,"description":"Indicates an id or name of a product"},{"name":"currency","in":"query","type":"string","required":false,"description":"Identifies the currency. E.g. USD, GBP etc"},{"name":"contractId","in":"query","type":"string","required":false,"description":"Indicates the unique identifier of the transaction or contract which initiated the activity"},{"name":"transactionAmount","in":"query","type":"string","required":false,"description":"Contains the transaction amount. This is based on the currency, either local or foreign currency"},{"name":"transactionAmountLocalCurrency","in":"query","type":"string","required":false,"description":"Indicates the transaction amount in local currency"},{"name":"applicationId","in":"query","type":"string","required":false,"description":"Contains the application id of the service that has crashed due to error."},{"name":"inputter","in":"query","type":"string","required":false,"description":"The user identifier who input the transaction"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"UnauthorisedAAAResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/arrangements/{arrangementId}/bundles","fullPath":"/api/v3.0.0/holdings/arrangements/{arrangementId}/bundles","operationId":"getLinktArrDetails","name":"Retrieves the Link Arrangement Details of an account","summary":"Retrieves the Link Arrangement Details of an account","tags":[],"parameters":[{"name":"arrangementId","in":"path","type":"string","required":true,"description":"Indicates an unique identifier of an account"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"LinktArrDetailsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/arrangements/{arrangementId}/documents","fullPath":"/api/v3.0.0/holdings/arrangements/{arrangementId}/documents","operationId":"getTransactionDocuments","name":"Retrieves the transaction document details of a given arrangement account","summary":"Retrieves the transaction document details of a given arrangement account","tags":[],"parameters":[{"name":"arrangementId","in":"path","type":"string","required":true,"description":"Indicates an unique identifier of an account"},{"name":"transactionReference","in":"query","type":"string","required":false,"description":"Contains the identifier for the transaction in the core system"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"TransactionDocumentsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/arrangements/{arrangementId}/balances","fullPath":"/api/v3.0.0/holdings/arrangements/{arrangementId}/balances","operationId":"getArrangementBalances","name":"Retrieves the balance details for a given arrangement","summary":"Retrieves the working ,ledger and cleared balances for an arrangement","tags":[],"parameters":[{"name":"arrangementId","in":"path","type":"string","required":true,"description":""},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"getArrangementBalancesResponse","default":"getArrangementBalancesErrorResponse"}},{"method":"DELETE","path":"/holdings/arrangementActivityId/{activityId}","fullPath":"/api/v3.0.0/holdings/arrangementActivityId/{activityId}","operationId":"reverseAccounts","name":"Deletes an arrangement on which no transactions are  posted","summary":"Deletes an arrangement on which no transactions are  posted","tags":[],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"activityId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":null,"responses":{"200":"reverseAccountsResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"GET","path":"/holdings/arrangements/{arrangementId}","fullPath":"/api/v3.0.0/holdings/arrangements/{arrangementId}","operationId":"getArrangementDetails","name":"Retrieves the details of an arrangement","summary":"Retrieves the details of the given arrangement such as arrangement id,account id,customer details,product details ,arrangement start date and arrangement status","tags":[],"parameters":[{"name":"arrangementId","in":"path","type":"string","required":true,"description":"Indicates an unique identifier of an account"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"ArrangementDetailsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/arrangements/{arrangementId}/bills","fullPath":"/api/v3.0.0/holdings/arrangements/{arrangementId}/bills","operationId":"getAllBills","name":"Retrieves the details of all the types of bills","summary":"Retrieves the details of all the types of bills","tags":[],"parameters":[{"name":"arrangementId","in":"path","type":"string","required":true,"description":"Indicates an unique identifier of an account"},{"name":"fileVersion","in":"query","type":"string","required":false,"description":"Indicates if the file is of type simulation or live"},{"name":"simulationReference","in":"query","type":"string","required":false,"description":"Indicates the Reference ID for simulation activity"},{"name":"paymentDate","in":"query","type":"string","required":false,"description":"The date on which a payment is due"},{"name":"deferDate","in":"query","type":"string","required":false,"description":"Date that the payment has been deferred to"},{"name":"billedAmount","in":"query","type":"string","required":false,"description":"Indicates the bill amount"},{"name":"outstandingAmount","in":"query","type":"string","required":false,"description":"Contains the aggregate outstanding principal amount thereof after giving effect to any borrowings and prepayments or repayments of Committed Loans"},{"name":"delinquentAmount","in":"query","type":"string","required":false,"description":"Indicates the bill amount during the ageing status(Bill which crossed the due date)"},{"name":"property","in":"query","type":"string","required":false,"description":"Id of the product property"},{"name":"billStatus","in":"query","type":"string","required":false,"description":"Indicates the status of a bill(Issued,Due,Ageing,Settled)"},{"name":"settlementStatus","in":"query","type":"string","required":false,"description":"Defines the status of the settlement for the incoming MT548 swift message.The values allowed are: Waiting : pending to receive settlement status update meaning pending to receive MT548 swift message, "},{"name":"agingStatus","in":"query","type":"string","required":false,"description":"Indicates the ageing status of a bill"},{"name":"settled","in":"query","type":"string","required":false,"description":"Flag to indicate whether a bill is settled or not"},{"name":"paymentType","in":"query","type":"string","required":false,"description":"Indicates if the payment is Customer (C) type or Bank (B) type"},{"name":"billDate","in":"query","type":"string","required":false,"description":"Indicates a date on which a bill has been raised"},{"name":"billType","in":"query","type":"string","required":false,"description":"The type of payment obligation generated"},{"name":"paymentMethod","in":"query","type":"string","required":false,"description":"Method chosen to make the payment"},{"name":"infoPayType","in":"query","type":"string","required":false,"description":"Indicates a bill which is raised when a loan is paid off"},{"name":"advancePayment","in":"query","type":"string","required":false,"description":"Indicates whether advance payment made is set on an account"},{"name":"paymentIndicator","in":"query","type":"string","required":false,"description":"Indicates whether its a credit/debit type of bill"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"AllBillsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/arrangements/{arrangementId}/outstandingBills","fullPath":"/api/v3.0.0/holdings/arrangements/{arrangementId}/outstandingBills","operationId":"getOutstandingBills","name":"Retrieves the Outstanding amount to be paid for an account","summary":"Retrieves the Outstanding amount to be paid for an account","tags":[],"parameters":[{"name":"arrangementId","in":"path","type":"string","required":true,"description":"Indicates an unique identifier of an account"},{"name":"fileVersion","in":"query","type":"string","required":false,"description":"Indicates if the file is of type simulation or live"},{"name":"simulationReference","in":"query","type":"string","required":false,"description":"Indicates the Reference ID for simulation activity"},{"name":"paymentDate","in":"query","type":"string","required":false,"description":"The date on which a payment is due"},{"name":"deferDate","in":"query","type":"string","required":false,"description":"Date that the payment has been deferred to"},{"name":"billedAmount","in":"query","type":"string","required":false,"description":"Indicates the bill amount"},{"name":"outstandingAmount","in":"query","type":"string","required":false,"description":"Contains the aggregate outstanding principal amount thereof after giving effect to any borrowings and prepayments or repayments of Committed Loans"},{"name":"delinquentAmount","in":"query","type":"string","required":false,"description":"Indicates the bill amount during the ageing status(Bill which crossed the due date)"},{"name":"property","in":"query","type":"string","required":false,"description":"Id of the product property"},{"name":"billStatus","in":"query","type":"string","required":false,"description":"Indicates the status of a bill(Issued,Due,Ageing,Settled)"},{"name":"settlementStatus","in":"query","type":"string","required":false,"description":"Defines the status of the settlement for the incoming MT548 swift message.The values allowed are: Waiting : pending to receive settlement status update meaning pending to receive MT548 swift message, "},{"name":"agingStatus","in":"query","type":"string","required":false,"description":"Indicates the ageing status of a bill"},{"name":"settled","in":"query","type":"string","required":false,"description":"Flag to indicate whether a bill is settled or not"},{"name":"paymentType","in":"query","type":"string","required":false,"description":"Indicates if the payment is Customer (C) type or Bank (B) type"},{"name":"billDate","in":"query","type":"string","required":false,"description":"Indicates a date on which a bill has been raised"},{"name":"billType","in":"query","type":"string","required":false,"description":"The type of payment obligation generated"},{"name":"paymentMethod","in":"query","type":"string","required":false,"description":"Method chosen to make the payment"},{"name":"infoPayType","in":"query","type":"string","required":false,"description":"Indicates a bill which is raised when a loan is paid off"},{"name":"advancePayment","in":"query","type":"string","required":false,"description":"Indicates whether advance payment made is set on an account"},{"name":"paymentIndicator","in":"query","type":"string","required":false,"description":"Indicates whether its a credit/debit type of bill"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"OutstandingBillsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/arrangements/{arrangementId}/deferredBills","fullPath":"/api/v3.0.0/holdings/arrangements/{arrangementId}/deferredBills","operationId":"getDeferredBills","name":"Retrieves the details of the deferred bills","summary":"Retrieves the details of the deferred bills","tags":[],"parameters":[{"name":"arrangementId","in":"path","type":"string","required":true,"description":"Indicates an unique identifier of an account"},{"name":"fileVersion","in":"query","type":"string","required":false,"description":"Indicates if the file is of type simulation or live"},{"name":"simulationReference","in":"query","type":"string","required":false,"description":"Indicates the Reference ID for simulation activity"},{"name":"paymentDate","in":"query","type":"string","required":false,"description":"The date on which a payment is due"},{"name":"deferDate","in":"query","type":"string","required":false,"description":"Date that the payment has been deferred to"},{"name":"billedAmount","in":"query","type":"string","required":false,"description":"Indicates the bill amount"},{"name":"outstandingAmount","in":"query","type":"string","required":false,"description":"Contains the aggregate outstanding principal amount thereof after giving effect to any borrowings and prepayments or repayments of Committed Loans"},{"name":"delinquentAmount","in":"query","type":"string","required":false,"description":"Indicates the bill amount during the ageing status(Bill which crossed the due date)"},{"name":"property","in":"query","type":"string","required":false,"description":"Id of the product property"},{"name":"billStatus","in":"query","type":"string","required":false,"description":"Indicates the status of a bill(Issued,Due,Ageing,Settled)"},{"name":"settlementStatus","in":"query","type":"string","required":false,"description":"Defines the status of the settlement for the incoming MT548 swift message.The values allowed are: Waiting : pending to receive settlement status update meaning pending to receive MT548 swift message, "},{"name":"agingStatus","in":"query","type":"string","required":false,"description":"Indicates the ageing status of a bill"},{"name":"paymentType","in":"query","type":"string","required":false,"description":"Indicates if the payment is Customer (C) type or Bank (B) type"},{"name":"billDate","in":"query","type":"string","required":false,"description":"Indicates a date on which a bill has been raised"},{"name":"billType","in":"query","type":"string","required":false,"description":"The type of payment obligation generated"},{"name":"paymentMethod","in":"query","type":"string","required":false,"description":"Method chosen to make the payment"},{"name":"infoPayType","in":"query","type":"string","required":false,"description":"Indicates a bill which is raised when a loan is paid off"},{"name":"advancePayment","in":"query","type":"string","required":false,"description":"Indicates whether advance payment made is set on an account"},{"name":"paymentIndicator","in":"query","type":"string","required":false,"description":"Indicates whether its a credit/debit type of bill"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"DeferredBillsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/arrangements/{arrangementId}/externalBills","fullPath":"/api/v3.0.0/holdings/arrangements/{arrangementId}/externalBills","operationId":"getExternalBills","name":"Retrieves the details of the external type of bills","summary":"Retrieves the details of the external type of bills","tags":[],"parameters":[{"name":"arrangementId","in":"path","type":"string","required":true,"description":"Indicates an unique identifier of an account"},{"name":"simulationReference","in":"query","type":"string","required":false,"description":"Indicates the Reference ID for simulation activity"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"ExternalBillsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/arrangements/{arrangementId}/advanceBills","fullPath":"/api/v3.0.0/holdings/arrangements/{arrangementId}/advanceBills","operationId":"getAdvanceBills","name":"Retrieves the details of the Advance bills","summary":"Retrieves the details of the Advance bills","tags":[],"parameters":[{"name":"arrangementId","in":"path","type":"string","required":true,"description":"Indicates an unique identifier of an account"},{"name":"billStatus","in":"query","type":"string","required":false,"description":"Indicates the status of a bill(Issued,Due,Ageing,Settled)"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"AdvanceBillsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/arrangements/{arrangementId}/writeOffBills","fullPath":"/api/v3.0.0/holdings/arrangements/{arrangementId}/writeOffBills","operationId":"getWriteoffBills","name":"Retrieves the details of the write off bills","summary":"Retrieves the details of the write off bills","tags":[],"parameters":[{"name":"arrangementId","in":"path","type":"string","required":true,"description":"Indicates an unique identifier of an account"},{"name":"billStatus","in":"query","type":"string","required":false,"description":"Indicates the status of a bill(Issued,Due,Ageing,Settled)"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"WriteoffBillsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/arrangements/{arrangementId}/payOffBills","fullPath":"/api/v3.0.0/holdings/arrangements/{arrangementId}/payOffBills","operationId":"getPayoffDetails","name":"Retrieves the Payoff Details of an account","summary":"Retrieves the Payoff Details of an account","tags":[],"parameters":[{"name":"arrangementId","in":"path","type":"string","required":true,"description":"Indicates an unique identifier of an account"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"PayoffDetailsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/arrangements/writeOff/{arrangementId}/activities","fullPath":"/api/v3.0.0/holdings/arrangements/writeOff/{arrangementId}/activities","operationId":"getWriteOffActivitiesDetails","name":"Retrieves the details of write off bills based on activities","summary":"Retrieves the details of write off bills based on activities","tags":[],"parameters":[{"name":"arrangementId","in":"path","type":"string","required":true,"description":"Indicates an unique identifier of an account"},{"name":"fileVersion","in":"query","type":"string","required":false,"description":"Indicates if the file is of type simulation or live"},{"name":"simulationReference","in":"query","type":"string","required":false,"description":"Indicates the Reference ID for simulation activity"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"WriteOffActivitiesDetailsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}}]},{"key":"holdings-arrangements-v3.1.0","title":"Arrangement details","version":"v3.1.0","description":"API to retrieve the details of arrangement conditions such as charge, interest, limits, overdue, payment schedule, agent, alerts, and commitment. This API also allows to retrieve the pricing evaluation details, product qualification details, delivery messages, payment order, events and repayment sch","endpointCount":55,"endpoints":[{"method":"GET","path":"/holdings/arrangements/{arrangementId}/charges","fullPath":"/api/v3.1.0/holdings/arrangements/{arrangementId}/charges","operationId":"getChargeDetails","name":"Retrieves the Charge details of an account","summary":"Retrieves the Charge details of an account","tags":[],"parameters":[{"name":"arrangementId","in":"path","type":"string","required":true,"description":"Indicates an unique identifier of an account"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"ChargeDetailsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/arrangements/{arrangementId}/interestRates","fullPath":"/api/v3.1.0/holdings/arrangements/{arrangementId}/interestRates","operationId":"getInterestDetails","name":"Retrieves the Interest Condition of an account","summary":"Retrieves the Interest Condition of an account","tags":[],"parameters":[{"name":"arrangementId","in":"path","type":"string","required":true,"description":"Indicates an unique identifier of an account"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"InterestDetailsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/arrangements/{arrangementId}/limits","fullPath":"/api/v3.1.0/holdings/arrangements/{arrangementId}/limits","operationId":"getLimitDetails","name":"Retrieves the Limit Details of an Arrangement Account","summary":"Retrieves the Limit Details of an Arrangement Account","tags":[],"parameters":[{"name":"arrangementId","in":"path","type":"string","required":true,"description":"Indicates an unique identifier of an account"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"LimitDetailsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/accounts/overdueStatistics","fullPath":"/api/v3.1.0/holdings/accounts/overdueStatistics","operationId":"getOverdueStatistics","name":"Retrieves the Overdue details of an account","summary":"Retrieves the Overdue details of an account","tags":[],"parameters":[{"name":"overdueReference","in":"query","type":"string","required":false,"description":"Indicates the overdue reference"},{"name":"overdueReference_ct","in":"query","type":"string","required":false,"description":"Indicates the criteria for the contains operation on the overdue reference"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"OverdueStatisticsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/arrangements/{arrangementId}/scheduleDefinitions","fullPath":"/api/v3.1.0/holdings/arrangements/{arrangementId}/scheduleDefinitions","operationId":"getScheduleDetails","name":"Retrieves the Payment Schedule Details of an account","summary":"Retrieves the Payment Schedule Details of an account","tags":[],"parameters":[{"name":"arrangementId","in":"path","type":"string","required":true,"description":"Indicates an unique identifier of an account"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"ScheduleDetailsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/arrangements/{arrangementId}/repayments","fullPath":"/api/v3.1.0/holdings/arrangements/{arrangementId}/repayments","operationId":"getRepaymentDetails","name":"Retrieves the Repayment details of an account based on the payment schedule","summary":"Retrieves the Repayment details of an account based on the payment schedule","tags":[],"parameters":[{"name":"arrangementId","in":"path","type":"string","required":true,"description":"Indicates an unique identifier of an account"},{"name":"simulationReference","in":"query","type":"string","required":false,"description":"Indicates the reference id for simulation activity"},{"name":"dueDate","in":"query","type":"string","required":false,"description":"Identifies the date on which the activity is due."},{"name":"includeExternalFees","in":"query","type":"string","required":false,"description":"Indicates if external fee is included"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"RepaymentDetailsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/arrangements/{arrangementId}/agents","fullPath":"/api/v3.1.0/holdings/arrangements/{arrangementId}/agents","operationId":"getAgentDetails","name":"Retrieves the Agent Details of an account","summary":"Retrieves the Agent Details of an account","tags":[],"parameters":[{"name":"arrangementId","in":"path","type":"string","required":true,"description":"Indicates an unique identifier of an account"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"AgentDetailsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/accounts/{accountNumber}/activeAlerts","fullPath":"/api/v3.1.0/holdings/accounts/{accountNumber}/activeAlerts","operationId":"getActiveAlerts","name":"Retrieves the details of active alerts for a given account number","summary":"Retrieves the details of active alerts for a given account number","tags":[],"parameters":[{"name":"accountNumber","in":"path","type":"string","required":true,"description":"Identifier of the account. Often referred to as the account number, yet for consistency this is always referred to as accountId. Accepts both IBAN & BBAN"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"ActiveAlertsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/accounts/{accountNumber}/historyAlerts","fullPath":"/api/v3.1.0/holdings/accounts/{accountNumber}/historyAlerts","operationId":"getHistoryAlerts","name":"Retrieves the details of history alerts for a given account number","summary":"Retrieves the details of history alerts for a given account number","tags":[],"parameters":[{"name":"accountNumber","in":"path","type":"string","required":true,"description":"Identifier of the account. Often referred to as the account number, yet for consistency this is always referred to as accountId. Accepts both IBAN & BBAN"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"HistoryAlertsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/arrangements/{arrangementId}/annualPercentageRates","fullPath":"/api/v3.1.0/holdings/arrangements/{arrangementId}/annualPercentageRates","operationId":"getAprDetails","name":"Retrieves the Annual Percentage Rate of an account","summary":"Retrieves the Annual Percentage Rate of an account","tags":[],"parameters":[{"name":"arrangementId","in":"path","type":"string","required":true,"description":"Indicates an unique identifier of an account"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"AprDetailsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/arrangements/{arrangementId}/paymentSchedules","fullPath":"/api/v3.1.0/holdings/arrangements/{arrangementId}/paymentSchedules","operationId":"getPaymentSchedule","name":"Retrieves the Payment schedule of an arrangement account","summary":"Retrieves the Payment schedule of an arrangement account","tags":[],"parameters":[{"name":"arrangementId","in":"path","type":"string","required":true,"description":"Indicates an unique identifier of an account"},{"name":"dateFrom","in":"query","type":"string","required":false,"description":"Start date of the loan"},{"name":"dateTo","in":"query","type":"string","required":false,"description":"End date of the loan"},{"name":"simulationReference","in":"query","type":"string","required":false,"description":"Indicates the reference id for simulation activity"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"PaymentScheduleResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/arrangements/{arrangementId}/holidayLimit","fullPath":"/api/v3.1.0/holdings/arrangements/{arrangementId}/holidayLimit","operationId":"getHolidayLimit","name":"Retrieves the details of Payment Holiday Limit Amount","summary":"Retrieves the details of Payment Holiday Limit Amount","tags":[],"parameters":[{"name":"arrangementId","in":"path","type":"string","required":true,"description":"Indicates an unique identifier of an account"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"HolidayLimitResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/arrangements/{arrangementId}/commitments","fullPath":"/api/v3.1.0/holdings/arrangements/{arrangementId}/commitments","operationId":"getCommitmentDetails","name":"Retrieves the Commitment Details of an Account","summary":"Retrieves the Commitment Details of an Account","tags":[],"parameters":[{"name":"arrangementId","in":"path","type":"string","required":true,"description":"Indicates an unique identifier of an account"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"CommitmentDetailsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/arrangements/{arrangementId}/qualifiers","fullPath":"/api/v3.1.0/holdings/arrangements/{arrangementId}/qualifiers","operationId":"getProductQualifierDetails","name":"Retrieves the Product Qualifier details of an account","summary":"Retrieves the Product Qualifier details of an account","tags":[],"parameters":[{"name":"arrangementId","in":"path","type":"string","required":true,"description":"Indicates an unique identifier of an account"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"ProductQualifierDetailsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/arrangements/{arrangementId}/evaluations","fullPath":"/api/v3.1.0/holdings/arrangements/{arrangementId}/evaluations","operationId":"getEvaluationDetails","name":"Retrieves the Pricing Evaluation details of an account.Retrieves the Pricing Evaluation details of an account","summary":"Retrieves the Pricing Evaluation details of an account","tags":[],"parameters":[{"name":"arrangementId","in":"path","type":"string","required":true,"description":"Indicates an unique identifier of an account"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"EvaluationDetailsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/accounts/{arrangementId}/dates","fullPath":"/api/v3.1.0/holdings/accounts/{arrangementId}/dates","operationId":"getArrangementDates","name":"Retrieves the key dates of an account","summary":"Retrieves the key dates of an account","tags":[],"parameters":[{"name":"arrangementId","in":"path","type":"string","required":true,"description":"Indicates an unique identifier of an account"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"ArrangementDatesResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/arrangements/{arrangementId}/interestAccruals","fullPath":"/api/v3.1.0/holdings/arrangements/{arrangementId}/interestAccruals","operationId":"getInterestDetailsCurrent","name":"Retrieves the interest accrued for the current period of an account","summary":"Retrieves the interest accrued for the current period of an account","tags":[],"parameters":[{"name":"arrangementId","in":"path","type":"string","required":true,"description":"Indicates an unique identifier of an account"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"InterestDetailsCurrentResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/arrangements/{arrangementId}/historicInterestAccruals","fullPath":"/api/v3.1.0/holdings/arrangements/{arrangementId}/historicInterestAccruals","operationId":"getInterestDetailsPrevious","name":"Retrieve the past period's interest accruals","summary":"Retrieve the past period's interest accruals","tags":[],"parameters":[{"name":"arrangementId","in":"path","type":"string","required":true,"description":"Indicates an unique identifier of an account"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"InterestDetailsPreviousResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/arrangements/{arrangementId}/yearToDateInterestAccruals","fullPath":"/api/v3.1.0/holdings/arrangements/{arrangementId}/yearToDateInterestAccruals","operationId":"getInterestDetailsYearToDate","name":"Retrieves the interest accruals of the Previous year","summary":"Retrieves the interest accruals of the Previous year","tags":[],"parameters":[{"name":"arrangementId","in":"path","type":"string","required":true,"description":"Indicates an unique identifier of an account"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"InterestDetailsYearToDateResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/accounts/{arrangementId}/messages","fullPath":"/api/v3.1.0/holdings/accounts/{arrangementId}/messages","operationId":"getDeliveryMessages","name":"Retrieves the details of delivery messages for a given arrangement Id","summary":"Retrieves the details of delivery messages for a given arrangement Id","tags":[],"parameters":[{"name":"arrangementId","in":"path","type":"string","required":true,"description":"Indicates an unique identifier of an account"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"DeliveryMessagesResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/accounts/{arrangementId}/historyMessages","fullPath":"/api/v3.1.0/holdings/accounts/{arrangementId}/historyMessages","operationId":"getDeliveryMessagesHistory","name":"Retrieves the details of history delivery messages for a given arrangement Id","summary":"Retrieves the details of history delivery messages for a given arrangement Id","tags":[],"parameters":[{"name":"arrangementId","in":"path","type":"string","required":true,"description":"Indicates an unique identifier of an account"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"DeliveryMessagesHistoryResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/arrangements/{arrangementId}/stmtEntries","fullPath":"/api/v3.1.0/holdings/arrangements/{arrangementId}/stmtEntries","operationId":"getStmtEntries","name":"Retrieves the Statement entries of an arrangement account","summary":"Retrieves the Statement entries of an arrangement account","tags":[],"parameters":[{"name":"arrangementId","in":"path","type":"string","required":true,"description":"Indicates an unique identifier of an account"},{"name":"valueDate","in":"query","type":"string","required":false,"description":"Indicates the value date on which the underlying accounting entry is to be given value (for interest purposes)"},{"name":"stmtFlag","in":"query","type":"string","required":false,"description":"Indicates the statement flag"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"StmtEntriesResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/arrangements/{arrangementId}/dataEvents","fullPath":"/api/v3.1.0/holdings/arrangements/{arrangementId}/dataEvents","operationId":"getArrangementPropertyConditions","name":"Retrieves and updates the property conditions to the data events","summary":"Retrieves the property conditions","tags":[],"parameters":[{"name":"arrangementId","in":"path","type":"string","required":true,"description":"Indicates an unique identifier of an account"},{"name":"status","in":"query","type":"string","required":false,"description":"Contains status of the data rights request.Allowed values are INITIATED, INPROGESS, EXTENDED, COMPLETED, REJECTED."},{"name":"arrangementActivityId","in":"query","type":"string","required":false,"description":"Contains the arrangement activity reference identifier"},{"name":"effectiveDate","in":"query","type":"string","required":false,"description":"Contains the identifier for the transaction date. Dates are expected in \u00e2\u20ac\u02dcYYYYMMDD\u00e2\u20ac\u2122 format"},{"name":"property","in":"query","type":"string","required":false,"description":"Id of the product property"},{"name":"dataEvent","in":"query","type":"string","required":false,"description":"Indicates the data event flag"},{"name":"ofsSource","in":"query","type":"string","required":false,"description":"Indicates the source of the OFS"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"ArrangementPropertyConditionsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/arrangements/{arrangementId}/schedules","fullPath":"/api/v3.1.0/holdings/arrangements/{arrangementId}/schedules","operationId":"getSchedulesFull","name":"Retrieves the Repayment Schedule details for an arrangement","summary":"Retrieves the Repayment Schedule details for an arrangement","tags":[],"parameters":[{"name":"arrangementId","in":"path","type":"string","required":true,"description":"Indicates an unique identifier of an account"},{"name":"simulationReference","in":"query","type":"string","required":false,"description":"Indicates the reference id for simulation activity"},{"name":"dateFrom","in":"query","type":"string","required":false,"description":"Start date of the loan"},{"name":"dateTo","in":"query","type":"string","required":false,"description":"End date of the loan"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"SchedulesFullResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/arrangements/{arrangementActivityId}/simulationReferences","fullPath":"/api/v3.1.0/holdings/arrangements/{arrangementActivityId}/simulationReferences","operationId":"getSimulationReference","name":"Retrieves the Simulation Reference for the given Arrangement Activity Id","summary":"Retrieves the Simulation Reference for the given Arrangement Activity Id","tags":[],"parameters":[{"name":"arrangementActivityId","in":"path","type":"string","required":true,"description":"Contains the arrangement activity reference identifier"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"SimulationReferenceResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/arrangement/{arrangementId}/alerts","fullPath":"/api/v3.1.0/holdings/arrangement/{arrangementId}/alerts","operationId":"getArrangementAlerts","name":"Retrieves the List of Alerts applicable for an arrangement","summary":"Retrieves the List of Alerts applicable for an arrangement","tags":[],"parameters":[{"name":"arrangementId","in":"path","type":"string","required":true,"description":"Indicates an unique identifier of an account"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"ArrangementAlertsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/arrangements/{arrangementId}/simulations","fullPath":"/api/v3.1.0/holdings/arrangements/{arrangementId}/simulations","operationId":"getSimulationDetails","name":"Retrieves the Simulated activity details of an account","summary":"Retrieves the Simulated activity details of an account","tags":[],"parameters":[{"name":"arrangementId","in":"path","type":"string","required":true,"description":"Indicates an unique identifier of an account"},{"name":"simulationCaptureReferenceId","in":"query","type":"string","required":false,"description":"Indicates the Reference Id for the simulation activity"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"SimulationDetailsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/customers/{customerId}/arrangements","fullPath":"/api/v3.1.0/holdings/customers/{customerId}/arrangements","operationId":"getCustomerArrangementDetails","name":"Retrieves the list of Arrangement Ids for a givenCustomer","summary":"Retrieves the list of Arrangement Ids for a given Customer","tags":[],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"Identifier of the customer"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"CustomerArrangementDetailsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/arrangements/{arrangementId}/chargeOffBalances","fullPath":"/api/v3.1.0/holdings/arrangements/{arrangementId}/chargeOffBalances","operationId":"getChargeOffDetails","name":"Retrieves the Charge Off balances of an arrangement account","summary":"Retrieves the Charge Off balances of an arrangement account","tags":[],"parameters":[{"name":"arrangementId","in":"path","type":"string","required":true,"description":"Indicates an unique identifier of an account"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"ChargeOffDetailsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/arrangements/{arrangementId}/consolidatedBalances","fullPath":"/api/v3.1.0/holdings/arrangements/{arrangementId}/consolidatedBalances","operationId":"getVirtualBalances","name":"Retrieves the virtual balances for a balance type of an account","summary":"Retrieves the virtual balances for a balance type of an account","tags":[],"parameters":[{"name":"arrangementId","in":"path","type":"string","required":true,"description":"Indicates an unique identifier of an account"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"VirtualBalancesResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/arrangements/{arrangementId}/activities","fullPath":"/api/v3.1.0/holdings/arrangements/{arrangementId}/activities","operationId":"getArrangementActivityLog","name":"Retrieves the activity log of an account","summary":"Retrieves the activity log of an account","tags":[],"parameters":[{"name":"arrangementId","in":"path","type":"string","required":true,"description":"Indicates an unique identifier of an account"},{"name":"simulation","in":"query","type":"string","required":false,"description":"What if scenario reference"},{"name":"startDate","in":"query","type":"string","required":false,"description":"Contains the date on which the transaction or payment gets initiated."},{"name":"endDate","in":"query","type":"string","required":false,"description":"Indicates the date till which the transaction history requested. If 20120101 is the start date and 20120201 is the end date, all transactions that are booked between January 1 to February 1 2012 are r"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"ArrangementActivityLogResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/arrangements/{arrangementId}/financialActivities","fullPath":"/api/v3.1.0/holdings/arrangements/{arrangementId}/financialActivities","operationId":"getFinancialActivities","name":"Retrieves the Financial Activity Log of an account","summary":"Retrieves the Financial Activity Log of an account","tags":[],"parameters":[{"name":"arrangementId","in":"path","type":"string","required":true,"description":"Indicates an unique identifier of an account"},{"name":"simulationReference","in":"query","type":"string","required":false,"description":"Indicates the reference id for simulation activity"},{"name":"startDate","in":"query","type":"string","required":false,"description":"Contains the date on which the transaction or payment gets initiated."},{"name":"endDate","in":"query","type":"string","required":false,"description":"Indicates the date till which the transaction history requested. If 20120101 is the start date and 20120201 is the end date, all transactions that are booked between January 1 to February 1 2012 are r"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"FinancialActivitiesResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/arrangements/{arrangementId}/userActivities","fullPath":"/api/v3.1.0/holdings/arrangements/{arrangementId}/userActivities","operationId":"getUserActivities","name":"Lists the User related activity logs of an account","summary":"Lists the User related activity logs of an account","tags":[],"parameters":[{"name":"arrangementId","in":"path","type":"string","required":true,"description":"Indicates an unique identifier of an account"},{"name":"simulationReference","in":"query","type":"string","required":false,"description":"Indicates the reference id for simulation activity"},{"name":"startDate","in":"query","type":"string","required":false,"description":"Contains the date on which the transaction or payment gets initiated."},{"name":"endDate","in":"query","type":"string","required":false,"description":"Indicates the date till which the transaction history requested. If 20120101 is the start date and 20120201 is the end date, all transactions that are booked between January 1 to February 1 2012 are r"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"UserActivitiesResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/arrangements/{arrangementId}/systemActivities","fullPath":"/api/v3.1.0/holdings/arrangements/{arrangementId}/systemActivities","operationId":"getSystemActivities","name":"Retrieves the System activities of an account","summary":"Retrieves the System activities of an account","tags":[],"parameters":[{"name":"arrangementId","in":"path","type":"string","required":true,"description":"Indicates an unique identifier of an account"},{"name":"simulationReference","in":"query","type":"string","required":false,"description":"Indicates the reference id for simulation activity"},{"name":"startDate","in":"query","type":"string","required":false,"description":"Contains the date on which the transaction or payment gets initiated."},{"name":"endDate","in":"query","type":"string","required":false,"description":"Indicates the date till which the transaction history requested. If 20120101 is the start date and 20120201 is the end date, all transactions that are booked between January 1 to February 1 2012 are r"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"SystemActivitiesResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/arrangements/{arrangementId}/holdActivities","fullPath":"/api/v3.1.0/holdings/arrangements/{arrangementId}/holdActivities","operationId":"getHoldActivities","name":"Retrieves the log of an activity in hold of an account","summary":"Retrieves the log of an activity in hold of an account","tags":[],"parameters":[{"name":"arrangementId","in":"path","type":"string","required":true,"description":"Indicates an unique identifier of an account"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"HoldActivitiesResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/arrangements/{arrangementId}/archievedActivities","fullPath":"/api/v3.1.0/holdings/arrangements/{arrangementId}/archievedActivities","operationId":"getArchievedActivities","name":"Retrieves the archived activity log of an account","summary":"Retrieves the archived activity log of an account","tags":[],"parameters":[{"name":"arrangementId","in":"path","type":"string","required":true,"description":"Indicates an unique identifier of an account"},{"name":"simulationReference","in":"query","type":"string","required":false,"description":"Indicates the reference id for simulation activity"},{"name":"startDate","in":"query","type":"string","required":false,"description":"Contains the date on which the transaction or payment gets initiated."},{"name":"endDate","in":"query","type":"string","required":false,"description":"Indicates the date till which the transaction history requested. If 20120101 is the start date and 20120201 is the end date, all transactions that are booked between January 1 to February 1 2012 are r"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"ArchievedActivitiesResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/arrangements/{arrangementId}/transactions","fullPath":"/api/v3.1.0/holdings/arrangements/{arrangementId}/transactions","operationId":"getAccountSummary","name":"Retrieves the transaction list for a given Account Number","summary":"Retrieves the transaction list for a given Account Number","tags":[],"parameters":[{"name":"arrangementId","in":"path","type":"string","required":true,"description":"Indicates an unique identifier of an account"},{"name":"startDate","in":"query","type":"string","required":false,"description":"Contains the date on which the transaction or payment gets initiated."},{"name":"endDate","in":"query","type":"string","required":false,"description":"Indicates the date till which the transaction history requested. If 20120101 is the start date and 20120201 is the end date, all transactions that are booked between January 1 to February 1 2012 are r"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"AccountSummaryResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/arrangements/{arrangementId}/eligibileActivities","fullPath":"/api/v3.1.0/holdings/arrangements/{arrangementId}/eligibileActivities","operationId":"getArrangementActivities","name":"Retrieves the list of activities applicable for an arrangement account","summary":"Retrieves the list of activities applicable for an arrangement account","tags":[],"parameters":[{"name":"arrangementId","in":"path","type":"string","required":true,"description":"Indicates an unique identifier of an account"},{"name":"activityId","in":"query","type":"string","required":false,"description":"Id of the activity, e.g. ACCOUNTS-CAPITALISE-ACCHARGE*CARDISSUEFEE"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"ArrangementActivitiesResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/arrangements/unapprovedArrangementActivites","fullPath":"/api/v3.1.0/holdings/arrangements/unapprovedArrangementActivites","operationId":"getUnauthorisedAAA","name":"Retrieves the list of unauthorised activities of an account","summary":"Retrieves the list of unauthorised activities of an account","tags":[],"parameters":[{"name":"customerId","in":"query","type":"string","required":false,"description":"Identifier of the customer"},{"name":"activity","in":"query","type":"string","required":false,"description":"Defines the activity to be processed against the Arrangement. The activity may be a user activity or a system generated activity."},{"name":"arrangementId","in":"query","type":"string","required":false,"description":"Indicates an unique identifier of an account"},{"name":"product","in":"query","type":"string","required":false,"description":"Contains the name of the product"},{"name":"currency","in":"query","type":"string","required":false,"description":"Identifies the currency. E.g. USD, GBP etc"},{"name":"contractId","in":"query","type":"string","required":false,"description":"Indicates the unique identifier of the transaction or contract which initiated the activity"},{"name":"transactionAmount","in":"query","type":"string","required":false,"description":"Contains the transaction amount. This is based on the currency, either local or foreign currency"},{"name":"transactionAmountLocalCurrency","in":"query","type":"string","required":false,"description":"Indicates the transaction amount in local currency"},{"name":"applicationId","in":"query","type":"string","required":false,"description":"Contains the application id of the service that has crashed due to error."},{"name":"inputter","in":"query","type":"string","required":false,"description":"The user identifier who input the transaction"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"UnauthorisedAAAResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/arrangements/{arrangementId}/bundles","fullPath":"/api/v3.1.0/holdings/arrangements/{arrangementId}/bundles","operationId":"getLinktArrDetails","name":"Retrieves the Link Arrangement Details of an account","summary":"Retrieves the Link Arrangement Details of an account","tags":[],"parameters":[{"name":"arrangementId","in":"path","type":"string","required":true,"description":"Indicates an unique identifier of an account"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"LinktArrDetailsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/arrangements/{arrangementId}/documents","fullPath":"/api/v3.1.0/holdings/arrangements/{arrangementId}/documents","operationId":"getTransactionDocuments","name":"Retrieves the transaction document details of a given arrangement account","summary":"Retrieves the transaction document details of a given arrangement account","tags":[],"parameters":[{"name":"arrangementId","in":"path","type":"string","required":true,"description":"Indicates an unique identifier of an account"},{"name":"transactionReference","in":"query","type":"string","required":false,"description":"Contains the identifier for the transaction in the core system"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"TransactionDocumentsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/arrangements/{arrangementId}/balances","fullPath":"/api/v3.1.0/holdings/arrangements/{arrangementId}/balances","operationId":"getArrangementBalances","name":"Retrieves the balance details for a given arrangement","summary":"Retrieves the working ,ledger and cleared balances for an arrangement","tags":[],"parameters":[{"name":"arrangementId","in":"path","type":"string","required":true,"description":""},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"getArrangementBalancesResponse","default":"getArrangementBalancesErrorResponse"}},{"method":"DELETE","path":"/holdings/arrangementActivityId/{activityId}","fullPath":"/api/v3.1.0/holdings/arrangementActivityId/{activityId}","operationId":"reverseAccounts","name":"Deletes an arrangement on which no transactions are  posted","summary":"Deletes an arrangement on which no transactions are  posted","tags":[],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"activityId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":null,"responses":{"200":"reverseAccountsResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"GET","path":"/holdings/arrangements/{arrangementId}","fullPath":"/api/v3.1.0/holdings/arrangements/{arrangementId}","operationId":"getArrangementDetails","name":"Retrieves the details of an arrangement","summary":"Retrieves the details of the given arrangement such as arrangement id,account id,customer details,product details ,arrangement start date and arrangement status","tags":[],"parameters":[{"name":"arrangementId","in":"path","type":"string","required":true,"description":"Indicates an unique identifier of an account"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"ArrangementDetailsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/arrangements/{arrangementId}/bills","fullPath":"/api/v3.1.0/holdings/arrangements/{arrangementId}/bills","operationId":"getAllBills","name":"Retrieves the details of all the types of bills","summary":"Retrieves the details of all the types of bills","tags":[],"parameters":[{"name":"arrangementId","in":"path","type":"string","required":true,"description":"Indicates an unique identifier of an account"},{"name":"fileVersion","in":"query","type":"string","required":false,"description":"Indicates if the file is of type simulation or live"},{"name":"simulationReference","in":"query","type":"string","required":false,"description":"Indicates the reference id for simulation activity"},{"name":"paymentDate","in":"query","type":"string","required":false,"description":"The date on which a payment is due"},{"name":"deferDate","in":"query","type":"string","required":false,"description":"Date that the payment has been deferred to"},{"name":"billedAmount","in":"query","type":"string","required":false,"description":"Indicates the bill amount"},{"name":"outstandingAmount","in":"query","type":"string","required":false,"description":"Contains the aggregate outstanding principal amount thereof after giving effect to any borrowings and prepayments or repayments of Committed Loans"},{"name":"delinquentAmount","in":"query","type":"string","required":false,"description":"Indicates the bill amount during the ageing status(Bill which crossed the due date)"},{"name":"property","in":"query","type":"string","required":false,"description":"Id of the product property"},{"name":"billStatus","in":"query","type":"string","required":false,"description":"Indicates the status of a bill(Issued,Due,Ageing,Settled)"},{"name":"settlementStatus","in":"query","type":"string","required":false,"description":"Defines the status of the settlement for the incoming MT548 swift message.The values allowed are: Waiting : pending to receive settlement status update meaning pending to receive MT548 swift message, "},{"name":"agingStatus","in":"query","type":"string","required":false,"description":"Indicates the ageing status of a bill"},{"name":"settled","in":"query","type":"string","required":false,"description":"Flag to indicate whether a bill is settled or not"},{"name":"paymentType","in":"query","type":"string","required":false,"description":"Indicates if the payment is Customer (C) type or Bank (B) type"},{"name":"billDate","in":"query","type":"string","required":false,"description":"Indicates a date on which a bill has been raised"},{"name":"billType","in":"query","type":"string","required":false,"description":"The type of payment obligation generated"},{"name":"paymentMethod","in":"query","type":"string","required":false,"description":"Method chosen to make the payment"},{"name":"infoPayType","in":"query","type":"string","required":false,"description":"Indicates a bill which is raised when a loan is paid off"},{"name":"advancePayment","in":"query","type":"string","required":false,"description":"Indicates whether advance payment made is set on an account"},{"name":"paymentIndicator","in":"query","type":"string","required":false,"description":"Indicates whether its a credit/debit type of bill"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"AllBillsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/arrangements/{arrangementId}/outstandingBills","fullPath":"/api/v3.1.0/holdings/arrangements/{arrangementId}/outstandingBills","operationId":"getOutstandingBills","name":"Retrieves the Outstanding amount to be paid for an account","summary":"Retrieves the Outstanding amount to be paid for an account","tags":[],"parameters":[{"name":"arrangementId","in":"path","type":"string","required":true,"description":"Indicates an unique identifier of an account"},{"name":"fileVersion","in":"query","type":"string","required":false,"description":"Indicates if the file is of type simulation or live"},{"name":"simulationReference","in":"query","type":"string","required":false,"description":"Indicates the reference id for simulation activity"},{"name":"paymentDate","in":"query","type":"string","required":false,"description":"The date on which a payment is due"},{"name":"deferDate","in":"query","type":"string","required":false,"description":"Date that the payment has been deferred to"},{"name":"billedAmount","in":"query","type":"string","required":false,"description":"Indicates the bill amount"},{"name":"outstandingAmount","in":"query","type":"string","required":false,"description":"Contains the aggregate outstanding principal amount thereof after giving effect to any borrowings and prepayments or repayments of Committed Loans"},{"name":"delinquentAmount","in":"query","type":"string","required":false,"description":"Indicates the bill amount during the ageing status(Bill which crossed the due date)"},{"name":"property","in":"query","type":"string","required":false,"description":"Id of the product property"},{"name":"billStatus","in":"query","type":"string","required":false,"description":"Indicates the status of a bill(Issued,Due,Ageing,Settled)"},{"name":"settlementStatus","in":"query","type":"string","required":false,"description":"Defines the status of the settlement for the incoming MT548 swift message.The values allowed are: Waiting : pending to receive settlement status update meaning pending to receive MT548 swift message, "},{"name":"agingStatus","in":"query","type":"string","required":false,"description":"Indicates the ageing status of a bill"},{"name":"settled","in":"query","type":"string","required":false,"description":"Flag to indicate whether a bill is settled or not"},{"name":"paymentType","in":"query","type":"string","required":false,"description":"Indicates if the payment is Customer (C) type or Bank (B) type"},{"name":"billDate","in":"query","type":"string","required":false,"description":"Indicates a date on which a bill has been raised"},{"name":"billType","in":"query","type":"string","required":false,"description":"The type of payment obligation generated"},{"name":"paymentMethod","in":"query","type":"string","required":false,"description":"Method chosen to make the payment"},{"name":"infoPayType","in":"query","type":"string","required":false,"description":"Indicates a bill which is raised when a loan is paid off"},{"name":"advancePayment","in":"query","type":"string","required":false,"description":"Indicates whether advance payment made is set on an account"},{"name":"paymentIndicator","in":"query","type":"string","required":false,"description":"Indicates whether its a credit/debit type of bill"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"OutstandingBillsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/arrangements/{arrangementId}/deferredBills","fullPath":"/api/v3.1.0/holdings/arrangements/{arrangementId}/deferredBills","operationId":"getDeferredBills","name":"Retrieves the details of the deferred bills","summary":"Retrieves the details of the deferred bills","tags":[],"parameters":[{"name":"arrangementId","in":"path","type":"string","required":true,"description":"Indicates an unique identifier of an account"},{"name":"fileVersion","in":"query","type":"string","required":false,"description":"Indicates if the file is of type simulation or live"},{"name":"simulationReference","in":"query","type":"string","required":false,"description":"Indicates the reference id for simulation activity"},{"name":"paymentDate","in":"query","type":"string","required":false,"description":"The date on which a payment is due"},{"name":"deferDate","in":"query","type":"string","required":false,"description":"Date that the payment has been deferred to"},{"name":"billedAmount","in":"query","type":"string","required":false,"description":"Indicates the bill amount"},{"name":"outstandingAmount","in":"query","type":"string","required":false,"description":"Contains the aggregate outstanding principal amount thereof after giving effect to any borrowings and prepayments or repayments of Committed Loans"},{"name":"delinquentAmount","in":"query","type":"string","required":false,"description":"Indicates the bill amount during the ageing status(Bill which crossed the due date)"},{"name":"property","in":"query","type":"string","required":false,"description":"Id of the product property"},{"name":"billStatus","in":"query","type":"string","required":false,"description":"Indicates the status of a bill(Issued,Due,Ageing,Settled)"},{"name":"settlementStatus","in":"query","type":"string","required":false,"description":"Defines the status of the settlement for the incoming MT548 swift message.The values allowed are: Waiting : pending to receive settlement status update meaning pending to receive MT548 swift message, "},{"name":"agingStatus","in":"query","type":"string","required":false,"description":"Indicates the ageing status of a bill"},{"name":"paymentType","in":"query","type":"string","required":false,"description":"Indicates if the payment is Customer (C) type or Bank (B) type"},{"name":"billDate","in":"query","type":"string","required":false,"description":"Indicates a date on which a bill has been raised"},{"name":"billType","in":"query","type":"string","required":false,"description":"The type of payment obligation generated"},{"name":"paymentMethod","in":"query","type":"string","required":false,"description":"Method chosen to make the payment"},{"name":"infoPayType","in":"query","type":"string","required":false,"description":"Indicates a bill which is raised when a loan is paid off"},{"name":"advancePayment","in":"query","type":"string","required":false,"description":"Indicates whether advance payment made is set on an account"},{"name":"paymentIndicator","in":"query","type":"string","required":false,"description":"Indicates whether its a credit/debit type of bill"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"DeferredBillsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/arrangements/{arrangementId}/externalBills","fullPath":"/api/v3.1.0/holdings/arrangements/{arrangementId}/externalBills","operationId":"getExternalBills","name":"Retrieves the details of the external type of bills","summary":"Retrieves the details of the external type of bills","tags":[],"parameters":[{"name":"arrangementId","in":"path","type":"string","required":true,"description":"Indicates an unique identifier of an account"},{"name":"simulationReference","in":"query","type":"string","required":false,"description":"Indicates the reference id for simulation activity"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"ExternalBillsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/arrangements/{arrangementId}/advanceBills","fullPath":"/api/v3.1.0/holdings/arrangements/{arrangementId}/advanceBills","operationId":"getAdvanceBills","name":"Retrieves the details of the Advance bills","summary":"Retrieves the details of the Advance bills","tags":[],"parameters":[{"name":"arrangementId","in":"path","type":"string","required":true,"description":"Indicates an unique identifier of an account"},{"name":"billStatus","in":"query","type":"string","required":false,"description":"Indicates the status of a bill(Issued,Due,Ageing,Settled)"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"AdvanceBillsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/arrangements/{arrangementId}/writeOffBills","fullPath":"/api/v3.1.0/holdings/arrangements/{arrangementId}/writeOffBills","operationId":"getWriteoffBills","name":"Retrieves the details of the write off bills","summary":"Retrieves the details of the write off bills","tags":[],"parameters":[{"name":"arrangementId","in":"path","type":"string","required":true,"description":"Indicates an unique identifier of an account"},{"name":"billStatus","in":"query","type":"string","required":false,"description":"Indicates the status of a bill(Issued,Due,Ageing,Settled)"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"WriteoffBillsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/arrangements/{arrangementId}/payOffBills","fullPath":"/api/v3.1.0/holdings/arrangements/{arrangementId}/payOffBills","operationId":"getPayoffDetails","name":"Retrieves the Payoff Details of an account","summary":"Retrieves the Payoff Details of an account","tags":[],"parameters":[{"name":"arrangementId","in":"path","type":"string","required":true,"description":"Indicates an unique identifier of an account"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"PayoffDetailsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/arrangements/writeOff/{arrangementId}/activities","fullPath":"/api/v3.1.0/holdings/arrangements/writeOff/{arrangementId}/activities","operationId":"getWriteOffActivitiesDetails","name":"Retrieves the details of write off bills based on activities","summary":"Retrieves the details of write off bills based on activities","tags":[],"parameters":[{"name":"arrangementId","in":"path","type":"string","required":true,"description":"Indicates an unique identifier of an account"},{"name":"fileVersion","in":"query","type":"string","required":false,"description":"Indicates if the file is of type simulation or live"},{"name":"simulationReference","in":"query","type":"string","required":false,"description":"Indicates the reference id for simulation activity"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"WriteOffActivitiesDetailsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/arrangements/{arrangementId}/settlements","fullPath":"/api/v3.1.0/holdings/arrangements/{arrangementId}/settlements","operationId":"getSettlementDetails","name":"Retrieves the settlement details for the given arrangement such as payment type, payin account, payin percentage, payin amount, payout account, payout percentage, payout amount, etc","summary":"Retrieves settlement details for the given arrangement","tags":["RETAIL"],"parameters":[{"name":"arrangementId","in":"path","type":"string","required":true,"description":"Indicates an unique identifier of an account"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"SettlementDetailsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/arrangements/{arrangementId}/paymentHolidays","fullPath":"/api/v3.1.0/holdings/arrangements/{arrangementId}/paymentHolidays","operationId":"getPaymentHoliday","name":"Retrieves payment holiday details for the given arrangement such as payment type, holiday date, original payment amount and new payment amount","summary":"Retrieves payment holiday details for the given arrangement","tags":["RETAIL"],"parameters":[{"name":"arrangementId","in":"path","type":"string","required":true,"description":"Indicates an unique identifier of an account"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"PaymentHolidayResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/arrangements/{arrangementId}/customers","fullPath":"/api/v3.1.0/holdings/arrangements/{arrangementId}/customers","operationId":"getCustomerDetail","name":"Retrieves all the customer details for the given arrangement such as customer id, customer name, customer role and their beneficiary type","summary":"Retrieves the customer details for the given arrangement","tags":["RETAIL"],"parameters":[{"name":"arrangementId","in":"path","type":"string","required":true,"description":"Indicates an unique identifier of an account"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"CustomerDetailResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}}]},{"key":"holdings-arrangements-v3.2.0","title":"Arrangement details","version":"v3.2.0","description":"API to retrieve the details of arrangement conditions such as charge, interest, limits, overdue, payment schedule, agent, alerts, and commitment. This API also allows to retrieve the pricing evaluation details, product qualification details, delivery messages, payment order, events and repayment sch","endpointCount":56,"endpoints":[{"method":"GET","path":"/holdings/arrangements/{arrangementId}/charges","fullPath":"/api/v3.2.0/holdings/arrangements/{arrangementId}/charges","operationId":"getChargeDetails","name":"Retrieves the charge details of an account","summary":"Retrieves the charge details of an account","tags":[],"parameters":[{"name":"arrangementId","in":"path","type":"string","required":true,"description":"Indicates an unique identifier of an account"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"ChargeDetailsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/arrangements/{arrangementId}/interestRates","fullPath":"/api/v3.2.0/holdings/arrangements/{arrangementId}/interestRates","operationId":"getInterestDetails","name":"Retrieves the interest condition of an account","summary":"Retrieves the interest condition of an account","tags":[],"parameters":[{"name":"arrangementId","in":"path","type":"string","required":true,"description":"Indicates an unique identifier of an account"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"InterestDetailsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/arrangements/{arrangementId}/limits","fullPath":"/api/v3.2.0/holdings/arrangements/{arrangementId}/limits","operationId":"getLimitDetails","name":"Retrieves the limit details of an arrangement account","summary":"Retrieves the limit details of an arrangement account","tags":[],"parameters":[{"name":"arrangementId","in":"path","type":"string","required":true,"description":"Indicates an unique identifier of an account"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"LimitDetailsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/accounts/overdueStatistics","fullPath":"/api/v3.2.0/holdings/accounts/overdueStatistics","operationId":"getOverdueStatistics","name":"Retrieves the overdue details of an account","summary":"Retrieves the overdue details of an account","tags":[],"parameters":[{"name":"overdueReference","in":"query","type":"string","required":true,"description":"Indicates the overdue reference"},{"name":"overdueReference_ct","in":"query","type":"string","required":true,"description":"Indicates the criteria for the contains operation on the overdue reference"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"OverdueStatisticsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/arrangements/{arrangementId}/scheduleDefinitions","fullPath":"/api/v3.2.0/holdings/arrangements/{arrangementId}/scheduleDefinitions","operationId":"getScheduleDetails","name":"Retrieves the payment schedule details of an account","summary":"Retrieves the payment schedule details of an account","tags":[],"parameters":[{"name":"arrangementId","in":"path","type":"string","required":true,"description":"Indicates an unique identifier of an account"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"ScheduleDetailsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/arrangements/{arrangementId}/repayments","fullPath":"/api/v3.2.0/holdings/arrangements/{arrangementId}/repayments","operationId":"getRepaymentDetails","name":"Retrieves the repayment details of an account based on the payment schedule","summary":"Retrieves the repayment details of an account based on the payment schedule","tags":[],"parameters":[{"name":"arrangementId","in":"path","type":"string","required":true,"description":"Indicates an unique identifier of an account"},{"name":"simulationReference","in":"query","type":"string","required":false,"description":"Indicates the reference id for simulation activity"},{"name":"dueDate","in":"query","type":"string","required":false,"description":"Identifies the date on which the activity is due."},{"name":"includeExternalFees","in":"query","type":"string","required":false,"description":"Indicates if external fee is included"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"RepaymentDetailsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/arrangements/{arrangementId}/agents","fullPath":"/api/v3.2.0/holdings/arrangements/{arrangementId}/agents","operationId":"getAgentDetails","name":"Retrieves the agent details of an account","summary":"Retrieves the agent details of an account","tags":[],"parameters":[{"name":"arrangementId","in":"path","type":"string","required":true,"description":"Indicates an unique identifier of an account"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"AgentDetailsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/accounts/{accountNumber}/activeAlerts","fullPath":"/api/v3.2.0/holdings/accounts/{accountNumber}/activeAlerts","operationId":"getActiveAlerts","name":"Retrieves the details of active alerts for a given account number","summary":"Retrieves the details of active alerts for a given account number","tags":[],"parameters":[{"name":"accountNumber","in":"path","type":"string","required":true,"description":"Identifier of the account. Often referred to as the account number, yet for consistency this is always referred to as accountId. Accepts both IBAN & BBAN"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"ActiveAlertsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/accounts/{accountNumber}/historyAlerts","fullPath":"/api/v3.2.0/holdings/accounts/{accountNumber}/historyAlerts","operationId":"getHistoryAlerts","name":"Retrieves the details of history alerts for a given account number","summary":"Retrieves the details of history alerts for a given account number","tags":[],"parameters":[{"name":"accountNumber","in":"path","type":"string","required":true,"description":"Identifier of the account. Often referred to as the account number, yet for consistency this is always referred to as accountId. Accepts both IBAN & BBAN"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"HistoryAlertsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/arrangements/{arrangementId}/annualPercentageRates","fullPath":"/api/v3.2.0/holdings/arrangements/{arrangementId}/annualPercentageRates","operationId":"getAprDetails","name":"Retrieves the annual percentage rate of an account","summary":"Retrieves the annual percentage rate of an account","tags":[],"parameters":[{"name":"arrangementId","in":"path","type":"string","required":true,"description":"Indicates an unique identifier of an account"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"AprDetailsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/arrangements/{arrangementId}/paymentSchedules","fullPath":"/api/v3.2.0/holdings/arrangements/{arrangementId}/paymentSchedules","operationId":"getPaymentSchedule","name":"Retrieves the payment schedule of an arrangement account","summary":"Retrieves the payment schedule of an arrangement account","tags":[],"parameters":[{"name":"arrangementId","in":"path","type":"string","required":true,"description":"Indicates an unique identifier of an account"},{"name":"dateFrom","in":"query","type":"string","required":false,"description":"Start date of the loan"},{"name":"dateTo","in":"query","type":"string","required":false,"description":"End date of the loan"},{"name":"simulationReference","in":"query","type":"string","required":false,"description":"Indicates the reference id for simulation activity"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"PaymentScheduleResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/arrangements/{arrangementId}/holidayLimit","fullPath":"/api/v3.2.0/holdings/arrangements/{arrangementId}/holidayLimit","operationId":"getHolidayLimit","name":"Retrieves the details of payment holiday limit amount","summary":"Retrieves the details of payment holiday limit amount","tags":[],"parameters":[{"name":"arrangementId","in":"path","type":"string","required":true,"description":"Indicates an unique identifier of an account"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"HolidayLimitResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/arrangements/{arrangementId}/commitments","fullPath":"/api/v3.2.0/holdings/arrangements/{arrangementId}/commitments","operationId":"getCommitmentDetails","name":"Retrieves the commitment details of an account","summary":"Retrieves the commitment details of an account","tags":[],"parameters":[{"name":"arrangementId","in":"path","type":"string","required":true,"description":"Indicates an unique identifier of an account"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"CommitmentDetailsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/arrangements/{arrangementId}/qualifiers","fullPath":"/api/v3.2.0/holdings/arrangements/{arrangementId}/qualifiers","operationId":"getProductQualifierDetails","name":"Retrieves the product qualifier details of an account","summary":"Retrieves the product qualifier details of an account","tags":[],"parameters":[{"name":"arrangementId","in":"path","type":"string","required":true,"description":"Indicates an unique identifier of an account"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"ProductQualifierDetailsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/arrangements/{arrangementId}/evaluations","fullPath":"/api/v3.2.0/holdings/arrangements/{arrangementId}/evaluations","operationId":"getEvaluationDetails","name":"Retrieves the pricing evaluation details of an account.","summary":"Retrieves the pricing evaluation details of an account","tags":[],"parameters":[{"name":"arrangementId","in":"path","type":"string","required":true,"description":"Indicates an unique identifier of an account"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"EvaluationDetailsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/accounts/{arrangementId}/dates","fullPath":"/api/v3.2.0/holdings/accounts/{arrangementId}/dates","operationId":"getArrangementDates","name":"Retrieves the key dates of an account","summary":"Retrieves the key dates of an account","tags":[],"parameters":[{"name":"arrangementId","in":"path","type":"string","required":true,"description":"Indicates an unique identifier of an account"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"ArrangementDatesResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/arrangements/{arrangementId}/interestAccruals","fullPath":"/api/v3.2.0/holdings/arrangements/{arrangementId}/interestAccruals","operationId":"getInterestDetailsCurrent","name":"Retrieves the interest accrued for the current period of an account","summary":"Retrieves the interest accrued for the current period of an account","tags":[],"parameters":[{"name":"arrangementId","in":"path","type":"string","required":true,"description":"Indicates an unique identifier of an account"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"InterestDetailsCurrentResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/arrangements/{arrangementId}/historicInterestAccruals","fullPath":"/api/v3.2.0/holdings/arrangements/{arrangementId}/historicInterestAccruals","operationId":"getInterestDetailsPrevious","name":"Retrieve the past period's interest accruals","summary":"Retrieve the past period's interest accruals","tags":[],"parameters":[{"name":"arrangementId","in":"path","type":"string","required":true,"description":"Indicates an unique identifier of an account"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"InterestDetailsPreviousResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/arrangements/{arrangementId}/yearToDateInterestAccruals","fullPath":"/api/v3.2.0/holdings/arrangements/{arrangementId}/yearToDateInterestAccruals","operationId":"getInterestDetailsYearToDate","name":"Retrieves the interest accruals of the previous year","summary":"Retrieves the interest accruals of the previous year","tags":[],"parameters":[{"name":"arrangementId","in":"path","type":"string","required":true,"description":"Indicates an unique identifier of an account"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"InterestDetailsYearToDateResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/accounts/{arrangementId}/messages","fullPath":"/api/v3.2.0/holdings/accounts/{arrangementId}/messages","operationId":"getDeliveryMessages","name":"Retrieves the details of delivery messages for a given arrangement Id","summary":"Retrieves the details of delivery messages for a given arrangement Id","tags":[],"parameters":[{"name":"arrangementId","in":"path","type":"string","required":true,"description":"Indicates an unique identifier of an account"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"DeliveryMessagesResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/accounts/{arrangementId}/historyMessages","fullPath":"/api/v3.2.0/holdings/accounts/{arrangementId}/historyMessages","operationId":"getDeliveryMessagesHistory","name":"Retrieves the details of history delivery messages for a given arrangement Id","summary":"Retrieves the details of history delivery messages for a given arrangement Id","tags":[],"parameters":[{"name":"arrangementId","in":"path","type":"string","required":true,"description":"Indicates an unique identifier of an account"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"DeliveryMessagesHistoryResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/arrangements/{arrangementId}/stmtEntries","fullPath":"/api/v3.2.0/holdings/arrangements/{arrangementId}/stmtEntries","operationId":"getStmtEntries","name":"Retrieves the statement entries of an arrangement account","summary":"Retrieves the statement entries of an arrangement account","tags":[],"parameters":[{"name":"arrangementId","in":"path","type":"string","required":true,"description":"Indicates an unique identifier of an account"},{"name":"valueDate","in":"query","type":"string","required":false,"description":"Indicates the value date on which the underlying accounting entry is to be given value (for interest purposes)"},{"name":"stmtFlag","in":"query","type":"string","required":false,"description":"Indicates the statement flag"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"StmtEntriesResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/arrangements/{arrangementId}/dataEvents","fullPath":"/api/v3.2.0/holdings/arrangements/{arrangementId}/dataEvents","operationId":"getArrangementPropertyConditions","name":"Retrieves the property conditions to the data events","summary":"Retrieves the property conditions","tags":[],"parameters":[{"name":"arrangementId","in":"path","type":"string","required":true,"description":"Indicates an unique identifier of an account"},{"name":"status","in":"query","type":"string","required":true,"description":"Contains status of the data rights request.Allowed values are INITIATED, INPROGESS, EXTENDED, COMPLETED, REJECTED."},{"name":"arrangementActivityId","in":"query","type":"string","required":false,"description":"Contains the arrangement activity reference identifier"},{"name":"effectiveDate","in":"query","type":"string","required":false,"description":"Contains the identifier for the transaction date. Dates are expected in \u00e2\u20ac\u02dcYYYYMMDD\u00e2\u20ac\u2122 format"},{"name":"property","in":"query","type":"string","required":false,"description":"Id of the product property"},{"name":"dataEvent","in":"query","type":"string","required":false,"description":"Indicates the data event flag"},{"name":"ofsSource","in":"query","type":"string","required":false,"description":"Indicates the source of the OFS"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"ArrangementPropertyConditionsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/arrangements/{arrangementId}/schedules","fullPath":"/api/v3.2.0/holdings/arrangements/{arrangementId}/schedules","operationId":"getSchedulesFull","name":"Retrieves the repayment schedule details for an arrangement","summary":"Retrieves the repayment schedule details for an arrangement","tags":[],"parameters":[{"name":"arrangementId","in":"path","type":"string","required":true,"description":"Indicates an unique identifier of an account"},{"name":"simulationReference","in":"query","type":"string","required":false,"description":"Indicates the reference id for simulation activity"},{"name":"dateFrom","in":"query","type":"string","required":false,"description":"Start date of the loan"},{"name":"dateTo","in":"query","type":"string","required":false,"description":"End date of the loan"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"SchedulesFullResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/arrangements/{arrangementActivityId}/simulationReferences","fullPath":"/api/v3.2.0/holdings/arrangements/{arrangementActivityId}/simulationReferences","operationId":"getSimulationReference","name":"Retrieves the simulation reference for the given arrangement activity id","summary":"Retrieves the simulation reference for the given arrangement activity id","tags":[],"parameters":[{"name":"arrangementActivityId","in":"path","type":"string","required":true,"description":"Contains the arrangement activity reference identifier"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"SimulationReferenceResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/arrangement/{arrangementId}/alerts","fullPath":"/api/v3.2.0/holdings/arrangement/{arrangementId}/alerts","operationId":"getArrangementAlerts","name":"Retrieves the list of alerts applicable for an arrangement","summary":"Retrieves the list of alerts applicable for an arrangement","tags":[],"parameters":[{"name":"arrangementId","in":"path","type":"string","required":true,"description":"Indicates an unique identifier of an account"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"ArrangementAlertsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/arrangements/{arrangementId}/simulations","fullPath":"/api/v3.2.0/holdings/arrangements/{arrangementId}/simulations","operationId":"getSimulationDetails","name":"Retrieves the simulated activity details of an account","summary":"Retrieves the simulated activity details of an account","tags":[],"parameters":[{"name":"arrangementId","in":"path","type":"string","required":true,"description":"Indicates an unique identifier of an account"},{"name":"simulationCaptureReferenceId","in":"query","type":"string","required":false,"description":"Indicates the Reference Id for the simulation activity"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"SimulationDetailsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/customers/{customerId}/arrangements","fullPath":"/api/v3.2.0/holdings/customers/{customerId}/arrangements","operationId":"getCustomerArrangementDetails","name":"Retrieves the list of arrangement ids for a given customer","summary":"Retrieves the list of arrangement ids for a given customer","tags":[],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"Identifier of the customer"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"CustomerArrangementDetailsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/arrangements/{arrangementId}/chargeOffBalances","fullPath":"/api/v3.2.0/holdings/arrangements/{arrangementId}/chargeOffBalances","operationId":"getChargeOffDetails","name":"Retrieves the charge off balances of an arrangement account","summary":"Retrieves the charge off balances of an arrangement account","tags":[],"parameters":[{"name":"arrangementId","in":"path","type":"string","required":true,"description":"Indicates an unique identifier of an account"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"ChargeOffDetailsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/arrangements/{arrangementId}/consolidatedBalances","fullPath":"/api/v3.2.0/holdings/arrangements/{arrangementId}/consolidatedBalances","operationId":"getVirtualBalances","name":"Retrieves the virtual balances for a balance type of an account","summary":"Retrieves the virtual balances for a balance type of an account","tags":[],"parameters":[{"name":"arrangementId","in":"path","type":"string","required":true,"description":"Indicates an unique identifier of an account"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"VirtualBalancesResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/arrangements/{arrangementId}/activities","fullPath":"/api/v3.2.0/holdings/arrangements/{arrangementId}/activities","operationId":"getArrangementActivityLog","name":"Retrieves the activity log of an account","summary":"Retrieves the activity log of an account","tags":[],"parameters":[{"name":"arrangementId","in":"path","type":"string","required":true,"description":"Indicates an unique identifier of an account"},{"name":"simulation","in":"query","type":"string","required":false,"description":"What if scenario reference"},{"name":"startDate","in":"query","type":"string","required":false,"description":"Contains the date on which the transaction or payment gets initiated."},{"name":"endDate","in":"query","type":"string","required":false,"description":"Indicates the date till which the transaction history requested. If 20120101 is the start date and 20120201 is the end date, all transactions that are booked between January 1 to February 1 2012 are r"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"ArrangementActivityLogResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/arrangements/{arrangementId}/financialActivities","fullPath":"/api/v3.2.0/holdings/arrangements/{arrangementId}/financialActivities","operationId":"getFinancialActivities","name":"Retrieves the financial activity log of an account","summary":"Retrieves the financial activity log of an account","tags":[],"parameters":[{"name":"arrangementId","in":"path","type":"string","required":true,"description":"Indicates an unique identifier of an account"},{"name":"simulationReference","in":"query","type":"string","required":false,"description":"Indicates the reference id for simulation activity"},{"name":"startDate","in":"query","type":"string","required":false,"description":"Contains the date on which the transaction or payment gets initiated."},{"name":"endDate","in":"query","type":"string","required":false,"description":"Indicates the date till which the transaction history requested. If 20120101 is the start date and 20120201 is the end date, all transactions that are booked between January 1 to February 1 2012 are r"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"FinancialActivitiesResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/arrangements/{arrangementId}/userActivities","fullPath":"/api/v3.2.0/holdings/arrangements/{arrangementId}/userActivities","operationId":"getUserActivities","name":"Lists the user related activity logs of an account","summary":"Lists the user related activity logs of an account","tags":[],"parameters":[{"name":"arrangementId","in":"path","type":"string","required":true,"description":"Indicates an unique identifier of an account"},{"name":"simulationReference","in":"query","type":"string","required":false,"description":"Indicates the reference id for simulation activity"},{"name":"startDate","in":"query","type":"string","required":false,"description":"Contains the date on which the transaction or payment gets initiated."},{"name":"endDate","in":"query","type":"string","required":false,"description":"Indicates the date till which the transaction history requested. If 20120101 is the start date and 20120201 is the end date, all transactions that are booked between January 1 to February 1 2012 are r"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"UserActivitiesResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/arrangements/{arrangementId}/systemActivities","fullPath":"/api/v3.2.0/holdings/arrangements/{arrangementId}/systemActivities","operationId":"getSystemActivities","name":"Retrieves the system activities of an account","summary":"Retrieves the system activities of an account","tags":[],"parameters":[{"name":"arrangementId","in":"path","type":"string","required":true,"description":"Indicates an unique identifier of an account"},{"name":"simulationReference","in":"query","type":"string","required":false,"description":"Indicates the reference id for simulation activity"},{"name":"startDate","in":"query","type":"string","required":false,"description":"Contains the date on which the transaction or payment gets initiated."},{"name":"endDate","in":"query","type":"string","required":false,"description":"Indicates the date till which the transaction history requested. If 20120101 is the start date and 20120201 is the end date, all transactions that are booked between January 1 to February 1 2012 are r"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"SystemActivitiesResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/arrangements/{arrangementId}/holdActivities","fullPath":"/api/v3.2.0/holdings/arrangements/{arrangementId}/holdActivities","operationId":"getHoldActivities","name":"Retrieves the log of an activity in hold of an account","summary":"Retrieves the log of an activity in hold of an account","tags":[],"parameters":[{"name":"arrangementId","in":"path","type":"string","required":true,"description":"Indicates an unique identifier of an account"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"HoldActivitiesResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/arrangements/{arrangementId}/archievedActivities","fullPath":"/api/v3.2.0/holdings/arrangements/{arrangementId}/archievedActivities","operationId":"getArchievedActivities","name":"Retrieves the archived activity log of an account","summary":"Retrieves the archived activity log of an account","tags":[],"parameters":[{"name":"arrangementId","in":"path","type":"string","required":true,"description":"Indicates an unique identifier of an account"},{"name":"simulationReference","in":"query","type":"string","required":false,"description":"Indicates the reference id for simulation activity"},{"name":"startDate","in":"query","type":"string","required":false,"description":"Contains the date on which the transaction or payment gets initiated."},{"name":"endDate","in":"query","type":"string","required":false,"description":"Indicates the date till which the transaction history requested. If 20120101 is the start date and 20120201 is the end date, all transactions that are booked between January 1 to February 1 2012 are r"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"ArchievedActivitiesResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/arrangements/{arrangementId}/transactions","fullPath":"/api/v3.2.0/holdings/arrangements/{arrangementId}/transactions","operationId":"getAccountSummary","name":"Retrieves the transaction list for a given account number","summary":"Retrieves the transaction list for a given account number","tags":[],"parameters":[{"name":"arrangementId","in":"path","type":"string","required":true,"description":"Indicates an unique identifier of an account"},{"name":"startDate","in":"query","type":"string","required":false,"description":"Contains the date on which the transaction or payment gets initiated."},{"name":"endDate","in":"query","type":"string","required":false,"description":"Indicates the date till which the transaction history requested. If 20120101 is the start date and 20120201 is the end date, all transactions that are booked between January 1 to February 1 2012 are r"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"AccountSummaryResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/arrangements/{arrangementId}/eligibileActivities","fullPath":"/api/v3.2.0/holdings/arrangements/{arrangementId}/eligibileActivities","operationId":"getArrangementActivities","name":"Retrieves the list of activities applicable for an arrangement account","summary":"Retrieves the list of activities applicable for an arrangement account","tags":[],"parameters":[{"name":"arrangementId","in":"path","type":"string","required":true,"description":"Indicates an unique identifier of an account"},{"name":"activityId","in":"query","type":"string","required":false,"description":"Id of the activity, e.g. ACCOUNTS-CAPITALISE-ACCHARGE*CARDISSUEFEE"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"ArrangementActivitiesResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/arrangements/unapprovedArrangementActivites","fullPath":"/api/v3.2.0/holdings/arrangements/unapprovedArrangementActivites","operationId":"getUnauthorisedAAA","name":"Retrieves the list of unauthorised activities of an account","summary":"Retrieves the list of unauthorised activities of an account","tags":[],"parameters":[{"name":"customerId","in":"query","type":"string","required":false,"description":"Identifier of the customer"},{"name":"activity","in":"query","type":"string","required":false,"description":"Defines the activity to be processed against the Arrangement. The activity may be a user activity or a system generated activity."},{"name":"arrangementId","in":"query","type":"string","required":false,"description":"Indicates an unique identifier of an account"},{"name":"product","in":"query","type":"string","required":false,"description":"Contains the name of the product"},{"name":"currency","in":"query","type":"string","required":false,"description":"Identifies the currency. E.g. USD, GBP etc"},{"name":"contractId","in":"query","type":"string","required":false,"description":"Indicates the unique identifier of the transaction or contract which initiated the activity"},{"name":"transactionAmount","in":"query","type":"string","required":false,"description":"Contains the transaction amount. This is based on the currency, either local or foreign currency"},{"name":"transactionAmountLocalCurrency","in":"query","type":"string","required":false,"description":"Indicates the transaction amount in local currency"},{"name":"applicationId","in":"query","type":"string","required":false,"description":"Contains the application id of the service that has crashed due to error."},{"name":"inputter","in":"query","type":"string","required":false,"description":"The user identifier who input the transaction"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"UnauthorisedAAAResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/arrangements/{arrangementId}/bundles","fullPath":"/api/v3.2.0/holdings/arrangements/{arrangementId}/bundles","operationId":"getLinktArrDetails","name":"Retrieves the link arrangement details of an account","summary":"Retrieves the link arrangement details of an account","tags":[],"parameters":[{"name":"arrangementId","in":"path","type":"string","required":true,"description":"Indicates an unique identifier of an account"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"LinktArrDetailsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/arrangements/{arrangementId}/documents","fullPath":"/api/v3.2.0/holdings/arrangements/{arrangementId}/documents","operationId":"getTransactionDocuments","name":"Retrieves the transaction document details of a given arrangement account","summary":"Retrieves the transaction document details of a given arrangement account","tags":[],"parameters":[{"name":"arrangementId","in":"path","type":"string","required":true,"description":"Indicates an unique identifier of an account"},{"name":"transactionReference","in":"query","type":"string","required":false,"description":"Contains the identifier for the transaction in the core system"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"TransactionDocumentsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/arrangements/{arrangementId}/balances","fullPath":"/api/v3.2.0/holdings/arrangements/{arrangementId}/balances","operationId":"getArrangementBalances","name":"Retrieves the balance details for a given arrangement","summary":"Retrieves the working ,ledger and cleared balances for an arrangement","tags":[],"parameters":[{"name":"arrangementId","in":"path","type":"string","required":true,"description":""},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"ArrangementBalancesResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"DELETE","path":"/holdings/arrangementActivityId/{activityId}","fullPath":"/api/v3.2.0/holdings/arrangementActivityId/{activityId}","operationId":"reverseAccounts","name":"Deletes an arrangement on which no transactions are  posted","summary":"Deletes an arrangement on which no transactions are  posted","tags":[],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"activityId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":null,"responses":{"200":"reverseAccountsResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"GET","path":"/holdings/arrangements/{arrangementId}","fullPath":"/api/v3.2.0/holdings/arrangements/{arrangementId}","operationId":"getArrangementDetails","name":"Retrieves the details of the given arrangement such as arrangement id,account id,customer details,product details ,arrangement start date and arrangement status","summary":"Retrieves the details of an arrangement","tags":[],"parameters":[{"name":"arrangementId","in":"path","type":"string","required":true,"description":"Indicates an unique identifier of an account"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"ArrangementDetailsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/arrangements/{arrangementId}/bills","fullPath":"/api/v3.2.0/holdings/arrangements/{arrangementId}/bills","operationId":"getAllBills","name":"Retrieves the details of all the types of bills","summary":"Retrieves the details of all the types of bills","tags":[],"parameters":[{"name":"arrangementId","in":"path","type":"string","required":true,"description":"Indicates an unique identifier of an account"},{"name":"fileVersion","in":"query","type":"string","required":false,"description":"Indicates if the file is of type simulation or live"},{"name":"simulationReference","in":"query","type":"string","required":false,"description":"Indicates the reference id for simulation activity"},{"name":"paymentDate","in":"query","type":"string","required":false,"description":"Contains the date in which the payment will be sent out.\u00c2\u00a0Date in the format YYYYMMDD. E.g. 20191231"},{"name":"deferDate","in":"query","type":"string","required":false,"description":"Date that the payment has been deferred to"},{"name":"billedAmount","in":"query","type":"string","required":false,"description":"Indicates the bill amount"},{"name":"outstandingAmount","in":"query","type":"string","required":false,"description":"Contains the aggregate outstanding principal amount thereof after giving effect to any borrowings and prepayments or repayments of Committed Loans"},{"name":"delinquentAmount","in":"query","type":"string","required":false,"description":"Indicates the bill amount during the ageing status(Bill which crossed the due date)"},{"name":"property","in":"query","type":"string","required":false,"description":"Id of the product property"},{"name":"billStatus","in":"query","type":"string","required":false,"description":"Indicates the status of a bill(Issued,Due,Ageing,Settled)"},{"name":"settlementStatus","in":"query","type":"string","required":false,"description":"Defines the status of the settlement for the incoming MT548 swift message.The values allowed are: Waiting : pending to receive settlement status update meaning pending to receive MT548 swift message, "},{"name":"agingStatus","in":"query","type":"string","required":false,"description":"Indicates the ageing status of a bill"},{"name":"settled","in":"query","type":"string","required":false,"description":"Flag to indicate whether a bill is settled or not"},{"name":"paymentType","in":"query","type":"string","required":false,"description":"Indicates if the payment is Customer (C) type or Bank (B) type"},{"name":"billDate","in":"query","type":"string","required":false,"description":"Indicates a date on which a bill has been raised"},{"name":"billType","in":"query","type":"string","required":false,"description":"The type of payment obligation generated"},{"name":"paymentMethod","in":"query","type":"string","required":false,"description":"Method chosen to make the payment"},{"name":"infoPayType","in":"query","type":"string","required":false,"description":"Indicates a bill which is raised when a loan is paid off"},{"name":"advancePayment","in":"query","type":"string","required":false,"description":"Indicates whether advance payment made is set on an account"},{"name":"paymentIndicator","in":"query","type":"string","required":false,"description":"Indicates whether its a credit/debit type of bill"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"AllBillsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/arrangements/{arrangementId}/outstandingBills","fullPath":"/api/v3.2.0/holdings/arrangements/{arrangementId}/outstandingBills","operationId":"getOutstandingBills","name":"Retrieves the outstanding amount to be paid for an account","summary":"Retrieves the outstanding amount to be paid for an account","tags":[],"parameters":[{"name":"arrangementId","in":"path","type":"string","required":true,"description":"Indicates an unique identifier of an account"},{"name":"fileVersion","in":"query","type":"string","required":false,"description":"Indicates if the file is of type simulation or live"},{"name":"simulationReference","in":"query","type":"string","required":false,"description":"Indicates the reference id for simulation activity"},{"name":"paymentDate","in":"query","type":"string","required":false,"description":"Contains the date in which the payment will be sent out.\u00c2\u00a0Date in the format YYYYMMDD. E.g. 20191231"},{"name":"deferDate","in":"query","type":"string","required":false,"description":"Date that the payment has been deferred to"},{"name":"billedAmount","in":"query","type":"string","required":false,"description":"Indicates the bill amount"},{"name":"outstandingAmount","in":"query","type":"string","required":false,"description":"Contains the aggregate outstanding principal amount thereof after giving effect to any borrowings and prepayments or repayments of Committed Loans"},{"name":"delinquentAmount","in":"query","type":"string","required":false,"description":"Indicates the bill amount during the ageing status(Bill which crossed the due date)"},{"name":"property","in":"query","type":"string","required":false,"description":"Id of the product property"},{"name":"billStatus","in":"query","type":"string","required":false,"description":"Indicates the status of a bill(Issued,Due,Ageing,Settled)"},{"name":"settlementStatus","in":"query","type":"string","required":false,"description":"Defines the status of the settlement for the incoming MT548 swift message.The values allowed are: Waiting : pending to receive settlement status update meaning pending to receive MT548 swift message, "},{"name":"agingStatus","in":"query","type":"string","required":false,"description":"Indicates the ageing status of a bill"},{"name":"settled","in":"query","type":"string","required":false,"description":"Flag to indicate whether a bill is settled or not"},{"name":"paymentType","in":"query","type":"string","required":false,"description":"Indicates if the payment is Customer (C) type or Bank (B) type"},{"name":"billDate","in":"query","type":"string","required":false,"description":"Indicates a date on which a bill has been raised"},{"name":"billType","in":"query","type":"string","required":false,"description":"The type of payment obligation generated"},{"name":"paymentMethod","in":"query","type":"string","required":false,"description":"Method chosen to make the payment"},{"name":"infoPayType","in":"query","type":"string","required":false,"description":"Indicates a bill which is raised when a loan is paid off"},{"name":"advancePayment","in":"query","type":"string","required":false,"description":"Indicates whether advance payment made is set on an account"},{"name":"paymentIndicator","in":"query","type":"string","required":false,"description":"Indicates whether its a credit/debit type of bill"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"OutstandingBillsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/arrangements/{arrangementId}/deferredBills","fullPath":"/api/v3.2.0/holdings/arrangements/{arrangementId}/deferredBills","operationId":"getDeferredBills","name":"Retrieves the details of the deferred bills","summary":"Retrieves the details of the deferred bills","tags":[],"parameters":[{"name":"arrangementId","in":"path","type":"string","required":true,"description":"Indicates an unique identifier of an account"},{"name":"fileVersion","in":"query","type":"string","required":false,"description":"Indicates if the file is of type simulation or live"},{"name":"simulationReference","in":"query","type":"string","required":false,"description":"Indicates the reference id for simulation activity"},{"name":"paymentDate","in":"query","type":"string","required":false,"description":"Contains the date in which the payment will be sent out.\u00c2\u00a0Date in the format YYYYMMDD. E.g. 20191231"},{"name":"deferDate","in":"query","type":"string","required":false,"description":"Date that the payment has been deferred to"},{"name":"billedAmount","in":"query","type":"string","required":false,"description":"Indicates the bill amount"},{"name":"outstandingAmount","in":"query","type":"string","required":false,"description":"Contains the aggregate outstanding principal amount thereof after giving effect to any borrowings and prepayments or repayments of Committed Loans"},{"name":"delinquentAmount","in":"query","type":"string","required":false,"description":"Indicates the bill amount during the ageing status(Bill which crossed the due date)"},{"name":"property","in":"query","type":"string","required":false,"description":"Id of the product property"},{"name":"billStatus","in":"query","type":"string","required":false,"description":"Indicates the status of a bill(Issued,Due,Ageing,Settled)"},{"name":"settlementStatus","in":"query","type":"string","required":false,"description":"Defines the status of the settlement for the incoming MT548 swift message.The values allowed are: Waiting : pending to receive settlement status update meaning pending to receive MT548 swift message, "},{"name":"agingStatus","in":"query","type":"string","required":false,"description":"Indicates the ageing status of a bill"},{"name":"paymentType","in":"query","type":"string","required":false,"description":"Indicates if the payment is Customer (C) type or Bank (B) type"},{"name":"billDate","in":"query","type":"string","required":false,"description":"Indicates a date on which a bill has been raised"},{"name":"billType","in":"query","type":"string","required":false,"description":"The type of payment obligation generated"},{"name":"paymentMethod","in":"query","type":"string","required":false,"description":"Method chosen to make the payment"},{"name":"infoPayType","in":"query","type":"string","required":false,"description":"Indicates a bill which is raised when a loan is paid off"},{"name":"advancePayment","in":"query","type":"string","required":false,"description":"Indicates whether advance payment made is set on an account"},{"name":"paymentIndicator","in":"query","type":"string","required":false,"description":"Indicates whether its a credit/debit type of bill"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"DeferredBillsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/arrangements/{arrangementId}/externalBills","fullPath":"/api/v3.2.0/holdings/arrangements/{arrangementId}/externalBills","operationId":"getExternalBills","name":"Retrieves the details of the external type of bills","summary":"Retrieves the details of the external type of bills","tags":[],"parameters":[{"name":"arrangementId","in":"path","type":"string","required":true,"description":"Indicates an unique identifier of an account"},{"name":"simulationReference","in":"query","type":"string","required":false,"description":"Indicates the reference id for simulation activity"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"ExternalBillsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/arrangements/{arrangementId}/advanceBills","fullPath":"/api/v3.2.0/holdings/arrangements/{arrangementId}/advanceBills","operationId":"getAdvanceBills","name":"Retrieves the details of the advance bills","summary":"Retrieves the details of the advance bills","tags":[],"parameters":[{"name":"arrangementId","in":"path","type":"string","required":true,"description":"Indicates an unique identifier of an account"},{"name":"billStatus","in":"query","type":"string","required":false,"description":"Indicates the status of a bill(Issued,Due,Ageing,Settled)"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"AdvanceBillsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/arrangements/{arrangementId}/writeOffBills","fullPath":"/api/v3.2.0/holdings/arrangements/{arrangementId}/writeOffBills","operationId":"getWriteoffBills","name":"Retrieves the details of the write off bills","summary":"Retrieves the details of the write off bills","tags":[],"parameters":[{"name":"arrangementId","in":"path","type":"string","required":true,"description":"Indicates an unique identifier of an account"},{"name":"billStatus","in":"query","type":"string","required":true,"description":"Indicates the status of a bill(Issued,Due,Ageing,Settled)"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"WriteoffBillsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/arrangements/{arrangementId}/payOffBills","fullPath":"/api/v3.2.0/holdings/arrangements/{arrangementId}/payOffBills","operationId":"getPayoffDetails","name":"Retrieves the payoff details of an account","summary":"Retrieves the payoff details of an account","tags":[],"parameters":[{"name":"arrangementId","in":"path","type":"string","required":true,"description":"Indicates an unique identifier of an account"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"PayoffDetailsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/arrangements/writeOff/{arrangementId}/activities","fullPath":"/api/v3.2.0/holdings/arrangements/writeOff/{arrangementId}/activities","operationId":"getWriteOffActivitiesDetails","name":"Retrieves the details of write off bills based on activities","summary":"Retrieves the details of write off bills based on activities","tags":[],"parameters":[{"name":"arrangementId","in":"path","type":"string","required":true,"description":"Indicates an unique identifier of an account"},{"name":"fileVersion","in":"query","type":"string","required":false,"description":"Indicates if the file is of type simulation or live"},{"name":"simulationReference","in":"query","type":"string","required":false,"description":"Indicates the reference id for simulation activity"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"WriteOffActivitiesDetailsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/arrangements/{arrangementId}/settlements","fullPath":"/api/v3.2.0/holdings/arrangements/{arrangementId}/settlements","operationId":"getSettlementDetails","name":"Retrieves the settlement details for the given arrangement such as payment type, payin account, payin percentage, payin amount, payout account, payout percentage, payout amount, etc","summary":"Retrieves settlement details for the given arrangement","tags":["RETAIL"],"parameters":[{"name":"arrangementId","in":"path","type":"string","required":true,"description":"Indicates an unique identifier of an account"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"SettlementDetailsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/arrangements/{arrangementId}/paymentHolidays","fullPath":"/api/v3.2.0/holdings/arrangements/{arrangementId}/paymentHolidays","operationId":"getPaymentHoliday","name":"Retrieves payment holiday details for the given arrangement such as payment type, holiday date, original payment amount and new payment amount","summary":"Retrieves payment holiday details for the given arrangement","tags":["RETAIL"],"parameters":[{"name":"arrangementId","in":"path","type":"string","required":true,"description":"Indicates an unique identifier of an account"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"PaymentHolidayResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/arrangements/{arrangementId}/customers","fullPath":"/api/v3.2.0/holdings/arrangements/{arrangementId}/customers","operationId":"getCustomerDetail","name":"Retrieves all the customer details for the given arrangement such as customer id, customer name, customer role and their beneficiary type","summary":"Retrieves the customer details for the given arrangement","tags":["RETAIL"],"parameters":[{"name":"arrangementId","in":"path","type":"string","required":true,"description":"Indicates an unique identifier of an account"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"CustomerDetailResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/arrangements/simulations/{simulationId}/schedules","fullPath":"/api/v3.2.0/holdings/arrangements/simulations/{simulationId}/schedules","operationId":"getSchedulesSim","name":"Retrieves the repayment schedule details for an arrangement with simulation reference number","summary":"Retrieves the repayment schedule details for an arrangement with simulation reference number","tags":["RETAIL"],"parameters":[{"name":"simulationId","in":"path","type":"string","required":true,"description":"Indicates the Id generated during the simulation of an activity"},{"name":"arrangementId","in":"query","type":"string","required":false,"description":"Indicates an unique identifier of an account"},{"name":"dateFrom","in":"query","type":"string","required":false,"description":"Start date of the loan"},{"name":"dateTo","in":"query","type":"string","required":false,"description":"End date of the loan"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"SchedulesSimResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}}]},{"key":"holdings-arrangements-v4.0.0","title":"Arrangement details","version":"v4.0.0","description":"API to retrieve the details of arrangement conditions such as charge, interest, limits, overdue, payment schedule, agent, alerts, and commitment. This API also allows to retrieve the pricing evaluation details, product qualification details, delivery messages, payment order, events and repayment sch","endpointCount":58,"endpoints":[{"method":"GET","path":"/holdings/arrangements/{arrangementId}/charges","fullPath":"/api/v4.0.0/holdings/arrangements/{arrangementId}/charges","operationId":"getChargeDetails","name":"Retrieves the charge details of an account","summary":"Retrieves the charge details of an account","tags":[],"parameters":[{"name":"arrangementId","in":"path","type":"string","required":true,"description":"Indicates an unique identifier of an account"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"ChargeDetailsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/arrangements/{arrangementId}/interestRates","fullPath":"/api/v4.0.0/holdings/arrangements/{arrangementId}/interestRates","operationId":"getInterestDetails","name":"Retrieves the interest condition of an account","summary":"Retrieves the interest condition of an account","tags":[],"parameters":[{"name":"arrangementId","in":"path","type":"string","required":true,"description":"Indicates an unique identifier of an account"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"InterestDetailsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/arrangements/{arrangementId}/limits","fullPath":"/api/v4.0.0/holdings/arrangements/{arrangementId}/limits","operationId":"getLimitDetails","name":"Retrieves the limit details of an arrangement account","summary":"Retrieves the limit details of an arrangement account","tags":[],"parameters":[{"name":"arrangementId","in":"path","type":"string","required":true,"description":"Indicates an unique identifier of an account"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"LimitDetailsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/accounts/overdueStatistics","fullPath":"/api/v4.0.0/holdings/accounts/overdueStatistics","operationId":"getOverdueStatistics","name":"Retrieves the overdue details of an account","summary":"Retrieves the overdue details of an account","tags":[],"parameters":[{"name":"overdueReference","in":"query","type":"string","required":true,"description":"Indicates the overdue reference"},{"name":"overdueReference_ct","in":"query","type":"string","required":true,"description":"Indicates the criteria for the contains operation on the overdue reference"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"OverdueStatisticsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/arrangements/{arrangementId}/scheduleDefinitions","fullPath":"/api/v4.0.0/holdings/arrangements/{arrangementId}/scheduleDefinitions","operationId":"getScheduleDetails","name":"Retrieves the payment schedule details of an account","summary":"Retrieves the payment schedule details of an account","tags":[],"parameters":[{"name":"arrangementId","in":"path","type":"string","required":true,"description":"Indicates an unique identifier of an account"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"ScheduleDetailsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/arrangements/{arrangementId}/repayments","fullPath":"/api/v4.0.0/holdings/arrangements/{arrangementId}/repayments","operationId":"getRepaymentDetails","name":"Retrieves the repayment details of an account based on the payment schedule","summary":"Retrieves the repayment details of an account based on the payment schedule","tags":[],"parameters":[{"name":"arrangementId","in":"path","type":"string","required":true,"description":"Indicates an unique identifier of an account"},{"name":"simulationReference","in":"query","type":"string","required":false,"description":"Indicates the reference id for simulation activity"},{"name":"dueDate","in":"query","type":"string","required":false,"description":"Identifies the date on which the activity is due."},{"name":"includeExternalFees","in":"query","type":"string","required":false,"description":"Indicates if external fee is included"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"RepaymentDetailsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/arrangements/{arrangementId}/agents","fullPath":"/api/v4.0.0/holdings/arrangements/{arrangementId}/agents","operationId":"getAgentDetails","name":"Retrieves the agent details of an account","summary":"Retrieves the agent details of an account","tags":[],"parameters":[{"name":"arrangementId","in":"path","type":"string","required":true,"description":"Indicates an unique identifier of an account"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"AgentDetailsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/accounts/{accountNumber}/activeAlerts","fullPath":"/api/v4.0.0/holdings/accounts/{accountNumber}/activeAlerts","operationId":"getActiveAlerts","name":"Retrieves the details of active alerts for a given account number","summary":"Retrieves the details of active alerts for a given account number","tags":[],"parameters":[{"name":"accountNumber","in":"path","type":"string","required":true,"description":"Identifier of the account. Often referred to as the account number, yet for consistency this is always referred to as accountId. Accepts both IBAN & BBAN"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"ActiveAlertsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/accounts/{accountNumber}/historyAlerts","fullPath":"/api/v4.0.0/holdings/accounts/{accountNumber}/historyAlerts","operationId":"getHistoryAlerts","name":"Retrieves the details of history alerts for a given account number","summary":"Retrieves the details of history alerts for a given account number","tags":[],"parameters":[{"name":"accountNumber","in":"path","type":"string","required":true,"description":"Identifier of the account. Often referred to as the account number, yet for consistency this is always referred to as accountId. Accepts both IBAN & BBAN"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"HistoryAlertsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/arrangements/{arrangementId}/annualPercentageRates","fullPath":"/api/v4.0.0/holdings/arrangements/{arrangementId}/annualPercentageRates","operationId":"getAprDetails","name":"Retrieves the annual percentage rate of an account","summary":"Retrieves the annual percentage rate of an account","tags":[],"parameters":[{"name":"arrangementId","in":"path","type":"string","required":true,"description":"Indicates an unique identifier of an account"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"AprDetailsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/arrangements/{arrangementId}/paymentSchedules","fullPath":"/api/v4.0.0/holdings/arrangements/{arrangementId}/paymentSchedules","operationId":"getPaymentSchedule","name":"Retrieves the payment schedule of an arrangement account","summary":"Retrieves the payment schedule of an arrangement account","tags":[],"parameters":[{"name":"arrangementId","in":"path","type":"string","required":true,"description":"Indicates an unique identifier of an account"},{"name":"dateFrom","in":"query","type":"string","required":false,"description":"Start date of the loan"},{"name":"dateTo","in":"query","type":"string","required":false,"description":"End date of the loan"},{"name":"simulationReference","in":"query","type":"string","required":false,"description":"Indicates the reference id for simulation activity"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"PaymentScheduleResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/arrangements/{arrangementId}/holidayLimit","fullPath":"/api/v4.0.0/holdings/arrangements/{arrangementId}/holidayLimit","operationId":"getHolidayLimit","name":"Retrieves the details of payment holiday limit amount","summary":"Retrieves the details of payment holiday limit amount","tags":[],"parameters":[{"name":"arrangementId","in":"path","type":"string","required":true,"description":"Indicates an unique identifier of an account"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"HolidayLimitResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/arrangements/{arrangementId}/commitments","fullPath":"/api/v4.0.0/holdings/arrangements/{arrangementId}/commitments","operationId":"getCommitmentDetails","name":"Retrieves the commitment details of an account","summary":"Retrieves the commitment details of an account","tags":[],"parameters":[{"name":"arrangementId","in":"path","type":"string","required":true,"description":"Indicates an unique identifier of an account"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"CommitmentDetailsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/arrangements/{arrangementId}/qualifiers","fullPath":"/api/v4.0.0/holdings/arrangements/{arrangementId}/qualifiers","operationId":"getProductQualifierDetails","name":"Retrieves the product qualifier details of an account","summary":"Retrieves the product qualifier details of an account","tags":[],"parameters":[{"name":"arrangementId","in":"path","type":"string","required":true,"description":"Indicates an unique identifier of an account"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"ProductQualifierDetailsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/arrangements/{arrangementId}/evaluations","fullPath":"/api/v4.0.0/holdings/arrangements/{arrangementId}/evaluations","operationId":"getEvaluationDetails","name":"Retrieves the pricing evaluation details of an account.","summary":"Retrieves the pricing evaluation details of an account","tags":[],"parameters":[{"name":"arrangementId","in":"path","type":"string","required":true,"description":"Indicates an unique identifier of an account"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"EvaluationDetailsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/accounts/{arrangementId}/dates","fullPath":"/api/v4.0.0/holdings/accounts/{arrangementId}/dates","operationId":"getArrangementDates","name":"Retrieves the key dates of an account","summary":"Retrieves the key dates of an account","tags":[],"parameters":[{"name":"arrangementId","in":"path","type":"string","required":true,"description":"Indicates an unique identifier of an account"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"ArrangementDatesResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/arrangements/{arrangementId}/interestAccruals","fullPath":"/api/v4.0.0/holdings/arrangements/{arrangementId}/interestAccruals","operationId":"getInterestDetailsCurrent","name":"Retrieves the interest accrued for the current period of an account","summary":"Retrieves the interest accrued for the current period of an account","tags":[],"parameters":[{"name":"arrangementId","in":"path","type":"string","required":true,"description":"Indicates an unique identifier of an account"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"InterestDetailsCurrentResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/arrangements/{arrangementId}/historicInterestAccruals","fullPath":"/api/v4.0.0/holdings/arrangements/{arrangementId}/historicInterestAccruals","operationId":"getInterestDetailsPrevious","name":"Retrieve the past period's interest accruals","summary":"Retrieve the past period's interest accruals","tags":[],"parameters":[{"name":"arrangementId","in":"path","type":"string","required":true,"description":"Indicates an unique identifier of an account"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"InterestDetailsPreviousResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/arrangements/{arrangementId}/yearToDateInterestAccruals","fullPath":"/api/v4.0.0/holdings/arrangements/{arrangementId}/yearToDateInterestAccruals","operationId":"getInterestDetailsYearToDate","name":"Retrieves the interest accruals of the previous year","summary":"Retrieves the interest accruals of the previous year","tags":[],"parameters":[{"name":"arrangementId","in":"path","type":"string","required":true,"description":"Indicates an unique identifier of an account"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"InterestDetailsYearToDateResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/accounts/{arrangementId}/messages","fullPath":"/api/v4.0.0/holdings/accounts/{arrangementId}/messages","operationId":"getDeliveryMessages","name":"Retrieves the details of delivery messages for a given arrangement Id","summary":"Retrieves the details of delivery messages for a given arrangement Id","tags":[],"parameters":[{"name":"arrangementId","in":"path","type":"string","required":true,"description":"Indicates an unique identifier of an account"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"DeliveryMessagesResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/accounts/{arrangementId}/historyMessages","fullPath":"/api/v4.0.0/holdings/accounts/{arrangementId}/historyMessages","operationId":"getDeliveryMessagesHistory","name":"Retrieves the details of history delivery messages for a given arrangement Id","summary":"Retrieves the details of history delivery messages for a given arrangement Id","tags":[],"parameters":[{"name":"arrangementId","in":"path","type":"string","required":true,"description":"Indicates an unique identifier of an account"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"DeliveryMessagesHistoryResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/arrangements/{arrangementId}/stmtEntries","fullPath":"/api/v4.0.0/holdings/arrangements/{arrangementId}/stmtEntries","operationId":"getStmtEntries","name":"Retrieves the statement entries of an arrangement account","summary":"Retrieves the statement entries of an arrangement account","tags":[],"parameters":[{"name":"arrangementId","in":"path","type":"string","required":true,"description":"Indicates an unique identifier of an account"},{"name":"valueDate","in":"query","type":"string","required":false,"description":"Indicates the value date on which the underlying accounting entry is to be given value (for interest purposes)"},{"name":"stmtFlag","in":"query","type":"string","required":false,"description":""},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"StmtEntriesResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/arrangements/{arrangementId}/dataEvents","fullPath":"/api/v4.0.0/holdings/arrangements/{arrangementId}/dataEvents","operationId":"getArrangementPropertyConditions","name":"Retrieves the property conditions to the data events","summary":"Retrieves the property conditions","tags":[],"parameters":[{"name":"arrangementId","in":"path","type":"string","required":true,"description":"Indicates an unique identifier of an account"},{"name":"status","in":"query","type":"string","required":true,"description":"Contains status of the data rights request.Allowed values are INITIATED, INPROGESS, EXTENDED, COMPLETED, REJECTED."},{"name":"arrangementActivityId","in":"query","type":"string","required":false,"description":"Contains the arrangement activity reference identifier"},{"name":"effectiveDate","in":"query","type":"string","required":false,"description":"Contains the identifier for the transaction date. Dates are expected in \u00e2\u20ac\u02dcYYYYMMDD\u00e2\u20ac\u2122 format"},{"name":"property","in":"query","type":"string","required":false,"description":"Id of the product property"},{"name":"dataEvent","in":"query","type":"string","required":false,"description":"Indicates the data event flag"},{"name":"ofsSource","in":"query","type":"string","required":false,"description":"Indicates the source of the OFS"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"ArrangementPropertyConditionsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/arrangements/{arrangementId}/schedules","fullPath":"/api/v4.0.0/holdings/arrangements/{arrangementId}/schedules","operationId":"getSchedulesFull","name":"Retrieves the repayment schedule details for an arrangement","summary":"Retrieves the repayment schedule details for an arrangement","tags":[],"parameters":[{"name":"arrangementId","in":"path","type":"string","required":true,"description":"Indicates an unique identifier of an account"},{"name":"simulationReference","in":"query","type":"string","required":false,"description":"Indicates the reference id for simulation activity"},{"name":"dateFrom","in":"query","type":"string","required":false,"description":"Start date of the loan"},{"name":"dateTo","in":"query","type":"string","required":false,"description":"End date of the loan"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"SchedulesFullResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/arrangements/{arrangementActivityId}/simulationReferences","fullPath":"/api/v4.0.0/holdings/arrangements/{arrangementActivityId}/simulationReferences","operationId":"getSimulationReference","name":"Retrieves the simulation reference for the given arrangement activity id","summary":"Retrieves the simulation reference for the given arrangement activity id","tags":[],"parameters":[{"name":"arrangementActivityId","in":"path","type":"string","required":true,"description":"Contains the arrangement activity reference identifier"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"SimulationReferenceResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/arrangement/{arrangementId}/alerts","fullPath":"/api/v4.0.0/holdings/arrangement/{arrangementId}/alerts","operationId":"getArrangementAlerts","name":"Retrieves the list of alerts applicable for an arrangement","summary":"Retrieves the list of alerts applicable for an arrangement","tags":[],"parameters":[{"name":"arrangementId","in":"path","type":"string","required":true,"description":"Indicates an unique identifier of an account"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"ArrangementAlertsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/arrangements/{arrangementId}/simulations","fullPath":"/api/v4.0.0/holdings/arrangements/{arrangementId}/simulations","operationId":"getSimulationDetails","name":"Retrieves the simulated activity details of an account","summary":"Retrieves the simulated activity details of an account","tags":[],"parameters":[{"name":"arrangementId","in":"path","type":"string","required":true,"description":"Indicates an unique identifier of an account"},{"name":"simulationCaptureReferenceId","in":"query","type":"string","required":false,"description":"Indicates the Reference Id for the simulation activity"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"SimulationDetailsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/customers/{customerId}/arrangements","fullPath":"/api/v4.0.0/holdings/customers/{customerId}/arrangements","operationId":"getCustomerArrangementDetails","name":"Retrieves the list of arrangement ids for a given customer","summary":"Retrieves the list of arrangement ids for a given customer","tags":[],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"Identifier of the customer"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"CustomerArrangementDetailsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/arrangements/{arrangementId}/chargeOffBalances","fullPath":"/api/v4.0.0/holdings/arrangements/{arrangementId}/chargeOffBalances","operationId":"getChargeOffDetails","name":"Retrieves the charge off balances of an arrangement account","summary":"Retrieves the charge off balances of an arrangement account","tags":[],"parameters":[{"name":"arrangementId","in":"path","type":"string","required":true,"description":"Indicates an unique identifier of an account"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"ChargeOffDetailsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/arrangements/{arrangementId}/consolidatedBalances","fullPath":"/api/v4.0.0/holdings/arrangements/{arrangementId}/consolidatedBalances","operationId":"getVirtualBalances","name":"Retrieves the virtual balances for a balance type of an account","summary":"Retrieves the virtual balances for a balance type of an account","tags":[],"parameters":[{"name":"arrangementId","in":"path","type":"string","required":true,"description":"Indicates an unique identifier of an account"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"VirtualBalancesResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/arrangements/{arrangementId}/activities","fullPath":"/api/v4.0.0/holdings/arrangements/{arrangementId}/activities","operationId":"getArrangementActivityLog","name":"Retrieves the activity log of an account","summary":"Retrieves the activity log of an account","tags":[],"parameters":[{"name":"arrangementId","in":"path","type":"string","required":true,"description":"Indicates an unique identifier of an account"},{"name":"simulation","in":"query","type":"string","required":false,"description":"What if scenario reference"},{"name":"startDate","in":"query","type":"string","required":false,"description":"Contains the date on which the transaction or payment gets initiated."},{"name":"endDate","in":"query","type":"string","required":false,"description":"Indicates the date till which the transaction history requested. If 20120101 is the start date and 20120201 is the end date, all transactions that are booked between January 1 to February 1 2012 are r"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"ArrangementActivityLogResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/arrangements/{arrangementId}/financialActivities","fullPath":"/api/v4.0.0/holdings/arrangements/{arrangementId}/financialActivities","operationId":"getFinancialActivities","name":"Retrieves the financial activity log of an account","summary":"Retrieves the financial activity log of an account","tags":[],"parameters":[{"name":"arrangementId","in":"path","type":"string","required":true,"description":"Indicates an unique identifier of an account"},{"name":"simulationReference","in":"query","type":"string","required":false,"description":"Indicates the reference id for simulation activity"},{"name":"startDate","in":"query","type":"string","required":false,"description":"Contains the date on which the transaction or payment gets initiated."},{"name":"endDate","in":"query","type":"string","required":false,"description":"Indicates the date till which the transaction history requested. If 20120101 is the start date and 20120201 is the end date, all transactions that are booked between January 1 to February 1 2012 are r"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"FinancialActivitiesResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/arrangements/{arrangementId}/userActivities","fullPath":"/api/v4.0.0/holdings/arrangements/{arrangementId}/userActivities","operationId":"getUserActivities","name":"Lists the user related activity logs of an account","summary":"Lists the user related activity logs of an account","tags":[],"parameters":[{"name":"arrangementId","in":"path","type":"string","required":true,"description":"Indicates an unique identifier of an account"},{"name":"simulationReference","in":"query","type":"string","required":false,"description":"Indicates the reference id for simulation activity"},{"name":"startDate","in":"query","type":"string","required":false,"description":"Contains the date on which the transaction or payment gets initiated."},{"name":"endDate","in":"query","type":"string","required":false,"description":"Indicates the date till which the transaction history requested. If 20120101 is the start date and 20120201 is the end date, all transactions that are booked between January 1 to February 1 2012 are r"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"UserActivitiesResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/arrangements/{arrangementId}/systemActivities","fullPath":"/api/v4.0.0/holdings/arrangements/{arrangementId}/systemActivities","operationId":"getSystemActivities","name":"Retrieves the system activities of an account","summary":"Retrieves the system activities of an account","tags":[],"parameters":[{"name":"arrangementId","in":"path","type":"string","required":true,"description":"Indicates an unique identifier of an account"},{"name":"simulationReference","in":"query","type":"string","required":false,"description":"Indicates the reference id for simulation activity"},{"name":"startDate","in":"query","type":"string","required":false,"description":"Contains the date on which the transaction or payment gets initiated."},{"name":"endDate","in":"query","type":"string","required":false,"description":"Indicates the date till which the transaction history requested. If 20120101 is the start date and 20120201 is the end date, all transactions that are booked between January 1 to February 1 2012 are r"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"SystemActivitiesResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/arrangements/{arrangementId}/holdActivities","fullPath":"/api/v4.0.0/holdings/arrangements/{arrangementId}/holdActivities","operationId":"getHoldActivities","name":"Retrieves the log of an activity in hold of an account","summary":"Retrieves the log of an activity in hold of an account","tags":[],"parameters":[{"name":"arrangementId","in":"path","type":"string","required":true,"description":"Indicates an unique identifier of an account"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"HoldActivitiesResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/arrangements/{arrangementId}/archievedActivities","fullPath":"/api/v4.0.0/holdings/arrangements/{arrangementId}/archievedActivities","operationId":"getArchievedActivities","name":"Retrieves the archived activity log of an account","summary":"Retrieves the archived activity log of an account","tags":[],"parameters":[{"name":"arrangementId","in":"path","type":"string","required":true,"description":"Indicates an unique identifier of an account"},{"name":"simulationReference","in":"query","type":"string","required":false,"description":"Indicates the reference id for simulation activity"},{"name":"startDate","in":"query","type":"string","required":false,"description":"Contains the date on which the transaction or payment gets initiated."},{"name":"endDate","in":"query","type":"string","required":false,"description":"Indicates the date till which the transaction history requested. If 20120101 is the start date and 20120201 is the end date, all transactions that are booked between January 1 to February 1 2012 are r"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"ArchievedActivitiesResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/arrangements/{arrangementId}/transactions","fullPath":"/api/v4.0.0/holdings/arrangements/{arrangementId}/transactions","operationId":"getAccountSummary","name":"Retrieves the transaction list for a given account number","summary":"Retrieves the transaction list for a given account number","tags":[],"parameters":[{"name":"arrangementId","in":"path","type":"string","required":true,"description":"Indicates an unique identifier of an account"},{"name":"startDate","in":"query","type":"string","required":false,"description":"Contains the date on which the transaction or payment gets initiated."},{"name":"endDate","in":"query","type":"string","required":false,"description":"Indicates the date till which the transaction history requested. If 20120101 is the start date and 20120201 is the end date, all transactions that are booked between January 1 to February 1 2012 are r"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"AccountSummaryResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/arrangements/{arrangementId}/eligibileActivities","fullPath":"/api/v4.0.0/holdings/arrangements/{arrangementId}/eligibileActivities","operationId":"getArrangementActivities","name":"Retrieves the list of activities applicable for an arrangement account","summary":"Retrieves the list of activities applicable for an arrangement account","tags":[],"parameters":[{"name":"arrangementId","in":"path","type":"string","required":true,"description":"Indicates an unique identifier of an account"},{"name":"activityId","in":"query","type":"string","required":false,"description":"Id of the activity, e.g. ACCOUNTS-CAPITALISE-ACCHARGE*CARDISSUEFEE"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"ArrangementActivitiesResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/arrangements/unapprovedArrangementActivites","fullPath":"/api/v4.0.0/holdings/arrangements/unapprovedArrangementActivites","operationId":"getUnauthorisedAAA","name":"Retrieves the list of unauthorised activities of an account","summary":"Retrieves the list of unauthorised activities of an account","tags":[],"parameters":[{"name":"customerId","in":"query","type":"string","required":false,"description":"Identifier of the customer"},{"name":"activity","in":"query","type":"string","required":false,"description":"Defines the activity to be processed against the Arrangement. The activity may be a user activity or a system generated activity."},{"name":"arrangementId","in":"query","type":"string","required":false,"description":"Indicates an unique identifier of an account"},{"name":"product","in":"query","type":"string","required":false,"description":"Contains the name of the product"},{"name":"currency","in":"query","type":"string","required":false,"description":"Identifies the currency. E.g. USD, GBP etc"},{"name":"contractId","in":"query","type":"string","required":false,"description":"Indicates the unique identifier of the transaction or contract which initiated the activity"},{"name":"transactionAmount","in":"query","type":"string","required":false,"description":"Contains the transaction amount. This is based on the currency, either local or foreign currency"},{"name":"transactionAmountLocalCurrency","in":"query","type":"string","required":false,"description":"Indicates the transaction amount in local currency"},{"name":"applicationId","in":"query","type":"string","required":false,"description":"Contains the application id of the service that has crashed due to error."},{"name":"inputter","in":"query","type":"string","required":false,"description":"The user identifier who input the transaction"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"UnauthorisedAAAResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/arrangements/{arrangementId}/bundles","fullPath":"/api/v4.0.0/holdings/arrangements/{arrangementId}/bundles","operationId":"getLinktArrDetails","name":"Retrieves the link arrangement details of an account","summary":"Retrieves the link arrangement details of an account","tags":[],"parameters":[{"name":"arrangementId","in":"path","type":"string","required":true,"description":"Indicates an unique identifier of an account"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"LinktArrDetailsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/arrangements/{arrangementId}/documents","fullPath":"/api/v4.0.0/holdings/arrangements/{arrangementId}/documents","operationId":"getTransactionDocuments","name":"Retrieves the transaction document details of a given arrangement account","summary":"Retrieves the transaction document details of a given arrangement account","tags":[],"parameters":[{"name":"arrangementId","in":"path","type":"string","required":true,"description":"Indicates an unique identifier of an account"},{"name":"transactionReference","in":"query","type":"string","required":false,"description":"Contains the identifier for the transaction in the core system"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"TransactionDocumentsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/arrangements/{arrangementId}/balances","fullPath":"/api/v4.0.0/holdings/arrangements/{arrangementId}/balances","operationId":"getArrangementBalances","name":"Retrieves the balance details for a given arrangement","summary":"Retrieves the working ,ledger and cleared balances for an arrangement","tags":[],"parameters":[{"name":"arrangementId","in":"path","type":"string","required":true,"description":""},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"ArrangementBalancesResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"DELETE","path":"/holdings/arrangementActivityId/{activityId}","fullPath":"/api/v4.0.0/holdings/arrangementActivityId/{activityId}","operationId":"reverseAccounts","name":"Deletes an arrangement on which no transactions are  posted","summary":"Deletes an arrangement on which no transactions are  posted","tags":[],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"activityId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":null,"responses":{"200":"reverseAccountsResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"GET","path":"/holdings/arrangements/{arrangementId}","fullPath":"/api/v4.0.0/holdings/arrangements/{arrangementId}","operationId":"getArrangementDetails","name":"Retrieves the details of the given arrangement such as arrangement id,account id,customer details,product details ,arrangement start date and arrangement status","summary":"Retrieves the details of an arrangement","tags":[],"parameters":[{"name":"arrangementId","in":"path","type":"string","required":true,"description":"Indicates an unique identifier of an account"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"ArrangementDetailsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/arrangements/{arrangementId}/bills","fullPath":"/api/v4.0.0/holdings/arrangements/{arrangementId}/bills","operationId":"getAllBills","name":"Retrieves the details of all the types of bills","summary":"Retrieves the details of all the types of bills","tags":[],"parameters":[{"name":"arrangementId","in":"path","type":"string","required":true,"description":"Indicates an unique identifier of an account"},{"name":"fileVersion","in":"query","type":"string","required":false,"description":"Indicates if the file is of type simulation or live"},{"name":"simulationReference","in":"query","type":"string","required":false,"description":"Indicates the reference id for simulation activity"},{"name":"paymentDate","in":"query","type":"string","required":false,"description":"Contains the date in which the payment will be sent out.\u00c2\u00a0Date in the format YYYYMMDD. E.g. 20191231"},{"name":"deferDate","in":"query","type":"string","required":false,"description":"Date that the payment has been deferred to"},{"name":"billedAmount","in":"query","type":"string","required":false,"description":"Indicates the bill amount"},{"name":"outstandingAmount","in":"query","type":"string","required":false,"description":"Contains the aggregate outstanding principal amount thereof after giving effect to any borrowings and prepayments or repayments of Committed Loans"},{"name":"delinquentAmount","in":"query","type":"string","required":false,"description":"Indicates the bill amount during the ageing status(Bill which crossed the due date)"},{"name":"property","in":"query","type":"string","required":false,"description":"Id of the product property"},{"name":"billStatus","in":"query","type":"string","required":false,"description":"Indicates the status of a bill(Issued,Due,Ageing,Settled)"},{"name":"settlementStatus","in":"query","type":"string","required":false,"description":"Defines the status of the settlement for the incoming MT548 swift message.The values allowed are: Waiting : pending to receive settlement status update meaning pending to receive MT548 swift message, "},{"name":"agingStatus","in":"query","type":"string","required":false,"description":"Indicates the ageing status of a bill"},{"name":"settled","in":"query","type":"string","required":false,"description":"Flag to indicate whether a bill is settled or not"},{"name":"paymentType","in":"query","type":"string","required":false,"description":"Indicates if the payment is Customer (C) type or Bank (B) type"},{"name":"billDate","in":"query","type":"string","required":false,"description":"Indicates a date on which a bill has been raised"},{"name":"billType","in":"query","type":"string","required":false,"description":"The type of payment obligation generated"},{"name":"paymentMethod","in":"query","type":"string","required":false,"description":"Method chosen to make the payment"},{"name":"infoPayType","in":"query","type":"string","required":false,"description":"Indicates a bill which is raised when a loan is paid off"},{"name":"advancePayment","in":"query","type":"string","required":false,"description":"Indicates whether advance payment made is set on an account"},{"name":"paymentIndicator","in":"query","type":"string","required":false,"description":"Indicates whether its a credit/debit type of bill"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"AllBillsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/arrangements/{arrangementId}/outstandingBills","fullPath":"/api/v4.0.0/holdings/arrangements/{arrangementId}/outstandingBills","operationId":"getOutstandingBills","name":"Retrieves the outstanding amount to be paid for an account","summary":"Retrieves the outstanding amount to be paid for an account","tags":[],"parameters":[{"name":"arrangementId","in":"path","type":"string","required":true,"description":"Indicates an unique identifier of an account"},{"name":"fileVersion","in":"query","type":"string","required":false,"description":"Indicates if the file is of type simulation or live"},{"name":"simulationReference","in":"query","type":"string","required":false,"description":"Indicates the reference id for simulation activity"},{"name":"paymentDate","in":"query","type":"string","required":false,"description":"Contains the date in which the payment will be sent out.\u00c2\u00a0Date in the format YYYYMMDD. E.g. 20191231"},{"name":"deferDate","in":"query","type":"string","required":false,"description":"Date that the payment has been deferred to"},{"name":"billedAmount","in":"query","type":"string","required":false,"description":"Indicates the bill amount"},{"name":"outstandingAmount","in":"query","type":"string","required":false,"description":"Contains the aggregate outstanding principal amount thereof after giving effect to any borrowings and prepayments or repayments of Committed Loans"},{"name":"delinquentAmount","in":"query","type":"string","required":false,"description":"Indicates the bill amount during the ageing status(Bill which crossed the due date)"},{"name":"property","in":"query","type":"string","required":false,"description":"Id of the product property"},{"name":"billStatus","in":"query","type":"string","required":false,"description":"Indicates the status of a bill(Issued,Due,Ageing,Settled)"},{"name":"settlementStatus","in":"query","type":"string","required":false,"description":"Defines the status of the settlement for the incoming MT548 swift message.The values allowed are: Waiting : pending to receive settlement status update meaning pending to receive MT548 swift message, "},{"name":"agingStatus","in":"query","type":"string","required":false,"description":"Indicates the ageing status of a bill"},{"name":"settled","in":"query","type":"string","required":false,"description":"Flag to indicate whether a bill is settled or not"},{"name":"paymentType","in":"query","type":"string","required":false,"description":"Indicates if the payment is Customer (C) type or Bank (B) type"},{"name":"billDate","in":"query","type":"string","required":false,"description":"Indicates a date on which a bill has been raised"},{"name":"billType","in":"query","type":"string","required":false,"description":"The type of payment obligation generated"},{"name":"paymentMethod","in":"query","type":"string","required":false,"description":"Method chosen to make the payment"},{"name":"infoPayType","in":"query","type":"string","required":false,"description":"Indicates a bill which is raised when a loan is paid off"},{"name":"advancePayment","in":"query","type":"string","required":false,"description":"Indicates whether advance payment made is set on an account"},{"name":"paymentIndicator","in":"query","type":"string","required":false,"description":"Indicates whether its a credit/debit type of bill"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"OutstandingBillsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/arrangements/{arrangementId}/deferredBills","fullPath":"/api/v4.0.0/holdings/arrangements/{arrangementId}/deferredBills","operationId":"getDeferredBills","name":"Retrieves the details of the deferred bills","summary":"Retrieves the details of the deferred bills","tags":[],"parameters":[{"name":"arrangementId","in":"path","type":"string","required":true,"description":"Indicates an unique identifier of an account"},{"name":"fileVersion","in":"query","type":"string","required":false,"description":"Indicates if the file is of type simulation or live"},{"name":"simulationReference","in":"query","type":"string","required":false,"description":"Indicates the reference id for simulation activity"},{"name":"paymentDate","in":"query","type":"string","required":false,"description":"Contains the date in which the payment will be sent out.\u00c2\u00a0Date in the format YYYYMMDD. E.g. 20191231"},{"name":"deferDate","in":"query","type":"string","required":false,"description":"Date that the payment has been deferred to"},{"name":"billedAmount","in":"query","type":"string","required":false,"description":"Indicates the bill amount"},{"name":"outstandingAmount","in":"query","type":"string","required":false,"description":"Contains the aggregate outstanding principal amount thereof after giving effect to any borrowings and prepayments or repayments of Committed Loans"},{"name":"delinquentAmount","in":"query","type":"string","required":false,"description":"Indicates the bill amount during the ageing status(Bill which crossed the due date)"},{"name":"property","in":"query","type":"string","required":false,"description":"Id of the product property"},{"name":"billStatus","in":"query","type":"string","required":false,"description":"Indicates the status of a bill(Issued,Due,Ageing,Settled)"},{"name":"settlementStatus","in":"query","type":"string","required":false,"description":"Defines the status of the settlement for the incoming MT548 swift message.The values allowed are: Waiting : pending to receive settlement status update meaning pending to receive MT548 swift message, "},{"name":"agingStatus","in":"query","type":"string","required":false,"description":"Indicates the ageing status of a bill"},{"name":"paymentType","in":"query","type":"string","required":false,"description":"Indicates if the payment is Customer (C) type or Bank (B) type"},{"name":"billDate","in":"query","type":"string","required":false,"description":"Indicates a date on which a bill has been raised"},{"name":"billType","in":"query","type":"string","required":false,"description":"The type of payment obligation generated"},{"name":"paymentMethod","in":"query","type":"string","required":false,"description":"Method chosen to make the payment"},{"name":"infoPayType","in":"query","type":"string","required":false,"description":"Indicates a bill which is raised when a loan is paid off"},{"name":"advancePayment","in":"query","type":"string","required":false,"description":"Indicates whether advance payment made is set on an account"},{"name":"paymentIndicator","in":"query","type":"string","required":false,"description":"Indicates whether its a credit/debit type of bill"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"DeferredBillsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/arrangements/{arrangementId}/externalBills","fullPath":"/api/v4.0.0/holdings/arrangements/{arrangementId}/externalBills","operationId":"getExternalBills","name":"Retrieves the details of the external type of bills","summary":"Retrieves the details of the external type of bills","tags":[],"parameters":[{"name":"arrangementId","in":"path","type":"string","required":true,"description":"Indicates an unique identifier of an account"},{"name":"simulationReference","in":"query","type":"string","required":false,"description":"Indicates the reference id for simulation activity"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"ExternalBillsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/arrangements/{arrangementId}/advanceBills","fullPath":"/api/v4.0.0/holdings/arrangements/{arrangementId}/advanceBills","operationId":"getAdvanceBills","name":"Retrieves the details of the advance bills","summary":"Retrieves the details of the advance bills","tags":[],"parameters":[{"name":"arrangementId","in":"path","type":"string","required":true,"description":"Indicates an unique identifier of an account"},{"name":"billStatus","in":"query","type":"string","required":false,"description":"Indicates the status of a bill(Issued,Due,Ageing,Settled)"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"AdvanceBillsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/arrangements/{arrangementId}/writeOffBills","fullPath":"/api/v4.0.0/holdings/arrangements/{arrangementId}/writeOffBills","operationId":"getWriteoffBills","name":"Retrieves the details of the write off bills","summary":"Retrieves the details of the write off bills","tags":[],"parameters":[{"name":"arrangementId","in":"path","type":"string","required":true,"description":"Indicates an unique identifier of an account"},{"name":"billStatus","in":"query","type":"string","required":true,"description":"Indicates the status of a bill(Issued,Due,Ageing,Settled)"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"WriteoffBillsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/arrangements/{arrangementId}/payOffBills","fullPath":"/api/v4.0.0/holdings/arrangements/{arrangementId}/payOffBills","operationId":"getPayoffDetails","name":"Retrieves the payoff details of an account","summary":"Retrieves the payoff details of an account","tags":[],"parameters":[{"name":"arrangementId","in":"path","type":"string","required":true,"description":"Indicates an unique identifier of an account"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"PayoffDetailsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/arrangements/writeOff/{arrangementId}/activities","fullPath":"/api/v4.0.0/holdings/arrangements/writeOff/{arrangementId}/activities","operationId":"getWriteOffActivitiesDetails","name":"Retrieves the details of write off bills based on activities","summary":"Retrieves the details of write off bills based on activities","tags":[],"parameters":[{"name":"arrangementId","in":"path","type":"string","required":true,"description":"Indicates an unique identifier of an account"},{"name":"fileVersion","in":"query","type":"string","required":false,"description":"Indicates if the file is of type simulation or live"},{"name":"simulationReference","in":"query","type":"string","required":false,"description":"Indicates the reference id for simulation activity"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"WriteOffActivitiesDetailsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/arrangements/{arrangementId}/settlements","fullPath":"/api/v4.0.0/holdings/arrangements/{arrangementId}/settlements","operationId":"getSettlementDetails","name":"Retrieves the settlement details for the given arrangement such as payment type, payin account, payin percentage, payin amount, payout account, payout percentage, payout amount, etc","summary":"Retrieves settlement details for the given arrangement","tags":["RETAIL"],"parameters":[{"name":"arrangementId","in":"path","type":"string","required":true,"description":"Indicates an unique identifier of an account"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"SettlementDetailsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/arrangements/{arrangementId}/paymentHolidays","fullPath":"/api/v4.0.0/holdings/arrangements/{arrangementId}/paymentHolidays","operationId":"getPaymentHoliday","name":"Retrieves payment holiday details for the given arrangement such as payment type, holiday date, original payment amount and new payment amount","summary":"Retrieves payment holiday details for the given arrangement","tags":["RETAIL"],"parameters":[{"name":"arrangementId","in":"path","type":"string","required":true,"description":"Indicates an unique identifier of an account"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"PaymentHolidayResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/arrangements/{arrangementId}/customers","fullPath":"/api/v4.0.0/holdings/arrangements/{arrangementId}/customers","operationId":"getCustomerDetail","name":"Retrieves all the customer details for the given arrangement such as customer id, customer name, customer role and their beneficiary type","summary":"Retrieves the customer details for the given arrangement","tags":["RETAIL"],"parameters":[{"name":"arrangementId","in":"path","type":"string","required":true,"description":"Indicates an unique identifier of an account"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"CustomerDetailResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/arrangements/simulations/{simulationId}/schedules","fullPath":"/api/v4.0.0/holdings/arrangements/simulations/{simulationId}/schedules","operationId":"getSchedulesSim","name":"Retrieves the repayment schedule details for an arrangement with simulation reference number","summary":"Retrieves the repayment schedule details for an arrangement with simulation reference number","tags":["RETAIL"],"parameters":[{"name":"simulationId","in":"path","type":"string","required":true,"description":"Indicates the Id generated during the simulation of an activity"},{"name":"arrangementId","in":"query","type":"string","required":false,"description":"Indicates an unique identifier of an account"},{"name":"dateFrom","in":"query","type":"string","required":false,"description":"Start date of the loan"},{"name":"dateTo","in":"query","type":"string","required":false,"description":"End date of the loan"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"SchedulesSimResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/transactions","fullPath":"/api/v4.0.0/holdings/transactions","operationId":"getArrangementTransactionsList","name":"Retrieves the details of account transaction","summary":"Retrieves account transaction","tags":[],"parameters":[{"name":"accountId","in":"query","type":"string","required":false,"description":"Identifier of the account. Often referred to as the account number, yet for consistency this is always referred to as accountId. Accepts both IBAN & BBAN"},{"name":"customerId","in":"query","type":"string","required":false,"description":"Identifier of the customer"},{"name":"listType","in":"query","type":"string","required":true,"description":"Indicates the transaction search type"},{"name":"transactionCount","in":"query","type":"string","required":false,"description":"Indicates the total number of transactions"},{"name":"payType","in":"query","type":"string","required":false,"description":"Indicates the identifier of payment types for  letter of credit."},{"name":"dateFrom","in":"query","type":"string","required":false,"description":"Start date of the loan"},{"name":"dateTo","in":"query","type":"string","required":false,"description":"End date of the loan"},{"name":"minimumAmount","in":"query","type":"string","required":false,"description":"The minimum account balance required."},{"name":"maximumAmount","in":"query","type":"string","required":false,"description":"The maximum account balance allowed."},{"name":"displayName","in":"query","type":"string","required":false,"description":"Contains the name used for display or enrichment purposes"},{"name":"transactionCode","in":"query","type":"string","required":false,"description":"Identifies the system internal transaction code applicable to the transaction"},{"name":"entryReference","in":"query","type":"string","required":false,"description":"It is the transaction reference. This is the identifier of the transaction on Temenos Core Banking system."},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"ArrangementTransactionsListResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/customers","fullPath":"/api/v4.0.0/holdings/customers","operationId":"getArrangementHoldings","name":"Retrieves the list of customer holdings details, such as arrangement accounts, loans and deposits.","summary":"Retrieves the list of product(Current/Saving/Loan/Deposit) details","tags":[],"parameters":[{"name":"customerId","in":"query","type":"string","required":false,"description":"Identifier of the customer"},{"name":"holdingsType","in":"query","type":"string","required":false,"description":"Contains the types of customer holdings"},{"name":"holdingsId","in":"query","type":"string","required":false,"description":"Contains the identifier specific to the holding details of the customer"},{"name":"getPreferredHoldings","in":"query","type":"string","required":false,"description":"Flag to fetch the preferred holding details (JWT required)"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"ArrangementHoldingsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}}]},{"key":"holdings-arrangements-v4.1.0","title":"Arrangement details","version":"v4.1.0","description":"API to retrieve the details of arrangement conditions such as charge, interest, limits, overdue, payment schedule, agent, alerts, and commitment. This API also allows to retrieve the pricing evaluation details, product qualification details, delivery messages, payment order, events and repayment sch","endpointCount":58,"endpoints":[{"method":"GET","path":"/holdings/arrangements/{arrangementId}/charges","fullPath":"/api/v4.1.0/holdings/arrangements/{arrangementId}/charges","operationId":"getChargeDetails","name":"Retrieves the charge details of an account","summary":"Retrieves the charge details of an account","tags":[],"parameters":[{"name":"arrangementId","in":"path","type":"string","required":true,"description":"Indicates an unique identifier of an account"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"ChargeDetailsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/arrangements/{arrangementId}/interestRates","fullPath":"/api/v4.1.0/holdings/arrangements/{arrangementId}/interestRates","operationId":"getInterestDetails","name":"Retrieves the interest condition of an account","summary":"Retrieves the interest condition of an account","tags":[],"parameters":[{"name":"arrangementId","in":"path","type":"string","required":true,"description":"Indicates an unique identifier of an account"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"InterestDetailsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/arrangements/{arrangementId}/limits","fullPath":"/api/v4.1.0/holdings/arrangements/{arrangementId}/limits","operationId":"getLimitDetails","name":"Retrieves the limit details of an arrangement account","summary":"Retrieves the limit details of an arrangement account","tags":[],"parameters":[{"name":"arrangementId","in":"path","type":"string","required":true,"description":"Indicates an unique identifier of an account"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"LimitDetailsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/accounts/overdueStatistics","fullPath":"/api/v4.1.0/holdings/accounts/overdueStatistics","operationId":"getOverdueStatistics","name":"Retrieves the overdue details of an account","summary":"Retrieves the overdue details of an account","tags":[],"parameters":[{"name":"overdueReference","in":"query","type":"string","required":true,"description":"Indicates the overdue reference"},{"name":"overdueReference_ct","in":"query","type":"string","required":true,"description":"Indicates the criteria for the contains operation on the overdue reference"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"OverdueStatisticsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/arrangements/{arrangementId}/scheduleDefinitions","fullPath":"/api/v4.1.0/holdings/arrangements/{arrangementId}/scheduleDefinitions","operationId":"getScheduleDetails","name":"Retrieves the payment schedule details of an account","summary":"Retrieves the payment schedule details of an account","tags":[],"parameters":[{"name":"arrangementId","in":"path","type":"string","required":true,"description":"Indicates an unique identifier of an account"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"ScheduleDetailsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/arrangements/{arrangementId}/repayments","fullPath":"/api/v4.1.0/holdings/arrangements/{arrangementId}/repayments","operationId":"getRepaymentDetails","name":"Retrieves the repayment details of an account based on the payment schedule","summary":"Retrieves the repayment details of an account based on the payment schedule","tags":[],"parameters":[{"name":"arrangementId","in":"path","type":"string","required":true,"description":"Indicates an unique identifier of an account"},{"name":"simulationReference","in":"query","type":"string","required":false,"description":"Indicates the reference id for simulation activity"},{"name":"dueDate","in":"query","type":"string","required":false,"description":"Identifies the date on which the activity is due."},{"name":"includeExternalFees","in":"query","type":"string","required":false,"description":"Indicates if external fee is included"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"RepaymentDetailsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/arrangements/{arrangementId}/agents","fullPath":"/api/v4.1.0/holdings/arrangements/{arrangementId}/agents","operationId":"getAgentDetails","name":"Retrieves the agent details of an account","summary":"Retrieves the agent details of an account","tags":[],"parameters":[{"name":"arrangementId","in":"path","type":"string","required":true,"description":"Indicates an unique identifier of an account"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"AgentDetailsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/accounts/{accountNumber}/activeAlerts","fullPath":"/api/v4.1.0/holdings/accounts/{accountNumber}/activeAlerts","operationId":"getActiveAlerts","name":"Retrieves the details of active alerts for a given account number","summary":"Retrieves the details of active alerts for a given account number","tags":[],"parameters":[{"name":"accountNumber","in":"path","type":"string","required":true,"description":"Identifier of the account. Often referred to as the account number, yet for consistency this is always referred to as accountId. Accepts both IBAN & BBAN"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"ActiveAlertsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/accounts/{accountNumber}/historyAlerts","fullPath":"/api/v4.1.0/holdings/accounts/{accountNumber}/historyAlerts","operationId":"getHistoryAlerts","name":"Retrieves the details of history alerts for a given account number","summary":"Retrieves the details of history alerts for a given account number","tags":[],"parameters":[{"name":"accountNumber","in":"path","type":"string","required":true,"description":"Identifier of the account. Often referred to as the account number, yet for consistency this is always referred to as accountId. Accepts both IBAN & BBAN"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"HistoryAlertsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/arrangements/{arrangementId}/annualPercentageRates","fullPath":"/api/v4.1.0/holdings/arrangements/{arrangementId}/annualPercentageRates","operationId":"getAprDetails","name":"Retrieves the annual percentage rate of an account","summary":"Retrieves the annual percentage rate of an account","tags":[],"parameters":[{"name":"arrangementId","in":"path","type":"string","required":true,"description":"Indicates an unique identifier of an account"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"AprDetailsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/arrangements/{arrangementId}/holidayLimit","fullPath":"/api/v4.1.0/holdings/arrangements/{arrangementId}/holidayLimit","operationId":"getHolidayLimit","name":"Retrieves the details of payment holiday limit amount","summary":"Retrieves the details of payment holiday limit amount","tags":[],"parameters":[{"name":"arrangementId","in":"path","type":"string","required":true,"description":"Indicates an unique identifier of an account"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"HolidayLimitResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/arrangements/{arrangementId}/commitments","fullPath":"/api/v4.1.0/holdings/arrangements/{arrangementId}/commitments","operationId":"getCommitmentDetails","name":"Retrieves the commitment details of an account","summary":"Retrieves the commitment details of an account","tags":[],"parameters":[{"name":"arrangementId","in":"path","type":"string","required":true,"description":"Indicates an unique identifier of an account"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"CommitmentDetailsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/arrangements/{arrangementId}/qualifiers","fullPath":"/api/v4.1.0/holdings/arrangements/{arrangementId}/qualifiers","operationId":"getProductQualifierDetails","name":"Retrieves the product qualifier details of an account","summary":"Retrieves the product qualifier details of an account","tags":[],"parameters":[{"name":"arrangementId","in":"path","type":"string","required":true,"description":"Indicates an unique identifier of an account"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"ProductQualifierDetailsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/arrangements/{arrangementId}/evaluations","fullPath":"/api/v4.1.0/holdings/arrangements/{arrangementId}/evaluations","operationId":"getEvaluationDetails","name":"Retrieves the pricing evaluation details of an account.","summary":"Retrieves the pricing evaluation details of an account","tags":[],"parameters":[{"name":"arrangementId","in":"path","type":"string","required":true,"description":"Indicates an unique identifier of an account"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"EvaluationDetailsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/accounts/{arrangementId}/dates","fullPath":"/api/v4.1.0/holdings/accounts/{arrangementId}/dates","operationId":"getArrangementDates","name":"Retrieves the key dates of an account","summary":"Retrieves the key dates of an account","tags":[],"parameters":[{"name":"arrangementId","in":"path","type":"string","required":true,"description":"Indicates an unique identifier of an account"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"ArrangementDatesResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/arrangements/{arrangementId}/interestAccruals","fullPath":"/api/v4.1.0/holdings/arrangements/{arrangementId}/interestAccruals","operationId":"getInterestDetailsCurrent","name":"Retrieves the interest accrued for the current period of an account","summary":"Retrieves the interest accrued for the current period of an account","tags":[],"parameters":[{"name":"arrangementId","in":"path","type":"string","required":true,"description":"Indicates an unique identifier of an account"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"InterestDetailsCurrentResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/arrangements/{arrangementId}/historicInterestAccruals","fullPath":"/api/v4.1.0/holdings/arrangements/{arrangementId}/historicInterestAccruals","operationId":"getInterestDetailsPrevious","name":"Retrieve the past period's interest accruals","summary":"Retrieve the past period's interest accruals","tags":[],"parameters":[{"name":"arrangementId","in":"path","type":"string","required":true,"description":"Indicates an unique identifier of an account"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"InterestDetailsPreviousResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/arrangements/{arrangementId}/yearToDateInterestAccruals","fullPath":"/api/v4.1.0/holdings/arrangements/{arrangementId}/yearToDateInterestAccruals","operationId":"getInterestDetailsYearToDate","name":"Retrieves the interest accruals of the previous year","summary":"Retrieves the interest accruals of the previous year","tags":[],"parameters":[{"name":"arrangementId","in":"path","type":"string","required":true,"description":"Indicates an unique identifier of an account"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"InterestDetailsYearToDateResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/accounts/{arrangementId}/messages","fullPath":"/api/v4.1.0/holdings/accounts/{arrangementId}/messages","operationId":"getDeliveryMessages","name":"Retrieves the details of delivery messages for a given arrangement Id","summary":"Retrieves the details of delivery messages for a given arrangement Id","tags":[],"parameters":[{"name":"arrangementId","in":"path","type":"string","required":true,"description":"Indicates an unique identifier of an account"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"DeliveryMessagesResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/accounts/{arrangementId}/historyMessages","fullPath":"/api/v4.1.0/holdings/accounts/{arrangementId}/historyMessages","operationId":"getDeliveryMessagesHistory","name":"Retrieves the details of history delivery messages for a given arrangement Id","summary":"Retrieves the details of history delivery messages for a given arrangement Id","tags":[],"parameters":[{"name":"arrangementId","in":"path","type":"string","required":true,"description":"Indicates an unique identifier of an account"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"DeliveryMessagesHistoryResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/arrangements/{arrangementId}/stmtEntries","fullPath":"/api/v4.1.0/holdings/arrangements/{arrangementId}/stmtEntries","operationId":"getStmtEntries","name":"Retrieves the statement entries of an arrangement account","summary":"Retrieves the statement entries of an arrangement account","tags":[],"parameters":[{"name":"arrangementId","in":"path","type":"string","required":true,"description":"Indicates an unique identifier of an account"},{"name":"valueDate","in":"query","type":"string","required":false,"description":"Indicates the value date on which the underlying accounting entry is to be given value (for interest purposes)"},{"name":"stmtFlag","in":"query","type":"string","required":false,"description":""},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"StmtEntriesResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/arrangements/{arrangementId}/dataEvents","fullPath":"/api/v4.1.0/holdings/arrangements/{arrangementId}/dataEvents","operationId":"getArrangementPropertyConditions","name":"Retrieves the property conditions to the data events","summary":"Retrieves the property conditions","tags":[],"parameters":[{"name":"arrangementId","in":"path","type":"string","required":true,"description":"Indicates an unique identifier of an account"},{"name":"status","in":"query","type":"string","required":true,"description":"Contains status of the data rights request.Allowed values are INITIATED, INPROGESS, EXTENDED, COMPLETED, REJECTED."},{"name":"arrangementActivityId","in":"query","type":"string","required":false,"description":"Contains the arrangement activity reference identifier"},{"name":"effectiveDate","in":"query","type":"string","required":false,"description":"Contains the identifier for the transaction date. Dates are expected in \u00e2\u20ac\u02dcYYYYMMDD\u00e2\u20ac\u2122 format"},{"name":"property","in":"query","type":"string","required":false,"description":"Id of the product property"},{"name":"dataEvent","in":"query","type":"string","required":false,"description":"Indicates the data event flag"},{"name":"ofsSource","in":"query","type":"string","required":false,"description":"Indicates the source of the OFS"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"ArrangementPropertyConditionsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/arrangements/{arrangementId}/schedules","fullPath":"/api/v4.1.0/holdings/arrangements/{arrangementId}/schedules","operationId":"getSchedulesFull","name":"Retrieves the repayment schedule details for an arrangement","summary":"Retrieves the repayment schedule details for an arrangement","tags":[],"parameters":[{"name":"arrangementId","in":"path","type":"string","required":true,"description":"Indicates an unique identifier of an account"},{"name":"simulationReference","in":"query","type":"string","required":false,"description":"Indicates the reference id for simulation activity"},{"name":"dateFrom","in":"query","type":"string","required":false,"description":"Start date of the loan"},{"name":"dateTo","in":"query","type":"string","required":false,"description":"End date of the loan"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"SchedulesFullResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/arrangements/{arrangementActivityId}/simulationReferences","fullPath":"/api/v4.1.0/holdings/arrangements/{arrangementActivityId}/simulationReferences","operationId":"getSimulationReference","name":"Retrieves the simulation reference for the given arrangement activity id","summary":"Retrieves the simulation reference for the given arrangement activity id","tags":[],"parameters":[{"name":"arrangementActivityId","in":"path","type":"string","required":true,"description":"Contains the arrangement activity reference identifier"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"SimulationReferenceResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/arrangement/{arrangementId}/alerts","fullPath":"/api/v4.1.0/holdings/arrangement/{arrangementId}/alerts","operationId":"getArrangementAlerts","name":"Retrieves the list of alerts applicable for an arrangement","summary":"Retrieves the list of alerts applicable for an arrangement","tags":[],"parameters":[{"name":"arrangementId","in":"path","type":"string","required":true,"description":"Indicates an unique identifier of an account"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"ArrangementAlertsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/arrangements/{arrangementId}/simulations","fullPath":"/api/v4.1.0/holdings/arrangements/{arrangementId}/simulations","operationId":"getSimulationDetails","name":"Retrieves the simulated activity details of an account","summary":"Retrieves the simulated activity details of an account","tags":[],"parameters":[{"name":"arrangementId","in":"path","type":"string","required":true,"description":"Indicates an unique identifier of an account"},{"name":"simulationCaptureReferenceId","in":"query","type":"string","required":false,"description":"Indicates the Reference Id for the simulation activity"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"SimulationDetailsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/customers/{customerId}/arrangements","fullPath":"/api/v4.1.0/holdings/customers/{customerId}/arrangements","operationId":"getCustomerArrangementDetails","name":"Retrieves the list of arrangement ids for a given customer","summary":"Retrieves the list of arrangement ids for a given customer","tags":[],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"Identifier of the customer"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"CustomerArrangementDetailsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/arrangements/{arrangementId}/chargeOffBalances","fullPath":"/api/v4.1.0/holdings/arrangements/{arrangementId}/chargeOffBalances","operationId":"getChargeOffDetails","name":"Retrieves the charge off balances of an arrangement account","summary":"Retrieves the charge off balances of an arrangement account","tags":[],"parameters":[{"name":"arrangementId","in":"path","type":"string","required":true,"description":"Indicates an unique identifier of an account"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"ChargeOffDetailsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/arrangements/{arrangementId}/consolidatedBalances","fullPath":"/api/v4.1.0/holdings/arrangements/{arrangementId}/consolidatedBalances","operationId":"getVirtualBalances","name":"Retrieves the virtual balances for a balance type of an account","summary":"Retrieves the virtual balances for a balance type of an account","tags":[],"parameters":[{"name":"arrangementId","in":"path","type":"string","required":true,"description":"Indicates an unique identifier of an account"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"VirtualBalancesResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/arrangements/{arrangementId}/activities","fullPath":"/api/v4.1.0/holdings/arrangements/{arrangementId}/activities","operationId":"getArrangementActivityLog","name":"Retrieves the activity log of an account","summary":"Retrieves the activity log of an account","tags":[],"parameters":[{"name":"arrangementId","in":"path","type":"string","required":true,"description":"Indicates an unique identifier of an account"},{"name":"simulation","in":"query","type":"string","required":false,"description":"What if scenario reference"},{"name":"startDate","in":"query","type":"string","required":false,"description":"Contains the date on which the transaction or payment gets initiated."},{"name":"endDate","in":"query","type":"string","required":false,"description":"Indicates the date till which the transaction history requested. If 20120101 is the start date and 20120201 is the end date, all transactions that are booked between January 1 to February 1 2012 are r"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"ArrangementActivityLogResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/arrangements/{arrangementId}/financialActivities","fullPath":"/api/v4.1.0/holdings/arrangements/{arrangementId}/financialActivities","operationId":"getFinancialActivities","name":"Retrieves the financial activity log of an account","summary":"Retrieves the financial activity log of an account","tags":[],"parameters":[{"name":"arrangementId","in":"path","type":"string","required":true,"description":"Indicates an unique identifier of an account"},{"name":"simulationReference","in":"query","type":"string","required":false,"description":"Indicates the reference id for simulation activity"},{"name":"startDate","in":"query","type":"string","required":false,"description":"Contains the date on which the transaction or payment gets initiated."},{"name":"endDate","in":"query","type":"string","required":false,"description":"Indicates the date till which the transaction history requested. If 20120101 is the start date and 20120201 is the end date, all transactions that are booked between January 1 to February 1 2012 are r"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"FinancialActivitiesResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/arrangements/{arrangementId}/userActivities","fullPath":"/api/v4.1.0/holdings/arrangements/{arrangementId}/userActivities","operationId":"getUserActivities","name":"Lists the user related activity logs of an account","summary":"Lists the user related activity logs of an account","tags":[],"parameters":[{"name":"arrangementId","in":"path","type":"string","required":true,"description":"Indicates an unique identifier of an account"},{"name":"simulationReference","in":"query","type":"string","required":false,"description":"Indicates the reference id for simulation activity"},{"name":"startDate","in":"query","type":"string","required":false,"description":"Contains the date on which the transaction or payment gets initiated."},{"name":"endDate","in":"query","type":"string","required":false,"description":"Indicates the date till which the transaction history requested. If 20120101 is the start date and 20120201 is the end date, all transactions that are booked between January 1 to February 1 2012 are r"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"UserActivitiesResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/arrangements/{arrangementId}/systemActivities","fullPath":"/api/v4.1.0/holdings/arrangements/{arrangementId}/systemActivities","operationId":"getSystemActivities","name":"Retrieves the system activities of an account","summary":"Retrieves the system activities of an account","tags":[],"parameters":[{"name":"arrangementId","in":"path","type":"string","required":true,"description":"Indicates an unique identifier of an account"},{"name":"simulationReference","in":"query","type":"string","required":false,"description":"Indicates the reference id for simulation activity"},{"name":"startDate","in":"query","type":"string","required":false,"description":"Contains the date on which the transaction or payment gets initiated."},{"name":"endDate","in":"query","type":"string","required":false,"description":"Indicates the date till which the transaction history requested. If 20120101 is the start date and 20120201 is the end date, all transactions that are booked between January 1 to February 1 2012 are r"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"SystemActivitiesResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/arrangements/{arrangementId}/holdActivities","fullPath":"/api/v4.1.0/holdings/arrangements/{arrangementId}/holdActivities","operationId":"getHoldActivities","name":"Retrieves the log of an activity in hold of an account","summary":"Retrieves the log of an activity in hold of an account","tags":[],"parameters":[{"name":"arrangementId","in":"path","type":"string","required":true,"description":"Indicates an unique identifier of an account"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"HoldActivitiesResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/arrangements/{arrangementId}/archievedActivities","fullPath":"/api/v4.1.0/holdings/arrangements/{arrangementId}/archievedActivities","operationId":"getArchievedActivities","name":"Retrieves the archived activity log of an account","summary":"Retrieves the archived activity log of an account","tags":[],"parameters":[{"name":"arrangementId","in":"path","type":"string","required":true,"description":"Indicates an unique identifier of an account"},{"name":"simulationReference","in":"query","type":"string","required":false,"description":"Indicates the reference id for simulation activity"},{"name":"startDate","in":"query","type":"string","required":false,"description":"Contains the date on which the transaction or payment gets initiated."},{"name":"endDate","in":"query","type":"string","required":false,"description":"Indicates the date till which the transaction history requested. If 20120101 is the start date and 20120201 is the end date, all transactions that are booked between January 1 to February 1 2012 are r"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"ArchievedActivitiesResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/arrangements/{arrangementId}/transactions","fullPath":"/api/v4.1.0/holdings/arrangements/{arrangementId}/transactions","operationId":"getAccountSummary","name":"Retrieves the transaction list for a given account number","summary":"Retrieves the transaction list for a given account number","tags":[],"parameters":[{"name":"arrangementId","in":"path","type":"string","required":true,"description":"Indicates an unique identifier of an account"},{"name":"startDate","in":"query","type":"string","required":false,"description":"Contains the date on which the transaction or payment gets initiated."},{"name":"endDate","in":"query","type":"string","required":false,"description":"Indicates the date till which the transaction history requested. If 20120101 is the start date and 20120201 is the end date, all transactions that are booked between January 1 to February 1 2012 are r"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"AccountSummaryResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/arrangements/{arrangementId}/eligibileActivities","fullPath":"/api/v4.1.0/holdings/arrangements/{arrangementId}/eligibileActivities","operationId":"getArrangementActivities","name":"Retrieves the list of activities applicable for an arrangement account","summary":"Retrieves the list of activities applicable for an arrangement account","tags":[],"parameters":[{"name":"arrangementId","in":"path","type":"string","required":true,"description":"Indicates an unique identifier of an account"},{"name":"activityId","in":"query","type":"string","required":false,"description":"Id of the activity, e.g. ACCOUNTS-CAPITALISE-ACCHARGE*CARDISSUEFEE"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"ArrangementActivitiesResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/arrangements/unapprovedArrangementActivites","fullPath":"/api/v4.1.0/holdings/arrangements/unapprovedArrangementActivites","operationId":"getUnauthorisedAAA","name":"Retrieves the list of unauthorised activities of an account","summary":"Retrieves the list of unauthorised activities of an account","tags":[],"parameters":[{"name":"customerId","in":"query","type":"string","required":false,"description":"Identifier of the customer"},{"name":"activity","in":"query","type":"string","required":false,"description":"Defines the activity to be processed against the Arrangement. The activity may be a user activity or a system generated activity."},{"name":"arrangementId","in":"query","type":"string","required":false,"description":"Indicates an unique identifier of an account"},{"name":"product","in":"query","type":"string","required":false,"description":"Contains the name of the product"},{"name":"currency","in":"query","type":"string","required":false,"description":"Identifies the currency. E.g. USD, GBP etc"},{"name":"contractId","in":"query","type":"string","required":false,"description":"Indicates the unique identifier of the transaction or contract which initiated the activity"},{"name":"transactionAmount","in":"query","type":"string","required":false,"description":"Contains the transaction amount. This is based on the currency, either local or foreign currency"},{"name":"transactionAmountLocalCurrency","in":"query","type":"string","required":false,"description":"Indicates the transaction amount in local currency"},{"name":"applicationId","in":"query","type":"string","required":false,"description":"Contains the application id of the service that has crashed due to error."},{"name":"inputter","in":"query","type":"string","required":false,"description":"The user identifier who input the transaction"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"UnauthorisedAAAResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/arrangements/{arrangementId}/bundles","fullPath":"/api/v4.1.0/holdings/arrangements/{arrangementId}/bundles","operationId":"getLinktArrDetails","name":"Retrieves the link arrangement details of an account","summary":"Retrieves the link arrangement details of an account","tags":[],"parameters":[{"name":"arrangementId","in":"path","type":"string","required":true,"description":"Indicates an unique identifier of an account"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"LinktArrDetailsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/arrangements/{arrangementId}/documents","fullPath":"/api/v4.1.0/holdings/arrangements/{arrangementId}/documents","operationId":"getTransactionDocuments","name":"Retrieves the transaction document details of a given arrangement account","summary":"Retrieves the transaction document details of a given arrangement account","tags":[],"parameters":[{"name":"arrangementId","in":"path","type":"string","required":true,"description":"Indicates an unique identifier of an account"},{"name":"transactionReference","in":"query","type":"string","required":false,"description":"Contains the identifier for the transaction in the core system"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"TransactionDocumentsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/arrangements/{arrangementId}/balances","fullPath":"/api/v4.1.0/holdings/arrangements/{arrangementId}/balances","operationId":"getArrangementBalances","name":"Retrieves the balance details for a given arrangement","summary":"Retrieves the working ,ledger and cleared balances for an arrangement","tags":[],"parameters":[{"name":"arrangementId","in":"path","type":"string","required":true,"description":""},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"ArrangementBalancesResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"DELETE","path":"/holdings/arrangementActivityId/{activityId}","fullPath":"/api/v4.1.0/holdings/arrangementActivityId/{activityId}","operationId":"reverseAccounts","name":"Deletes an arrangement on which no transactions are  posted","summary":"Deletes an arrangement on which no transactions are  posted","tags":[],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"activityId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":null,"responses":{"200":"reverseAccountsResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"GET","path":"/holdings/arrangements/{arrangementId}","fullPath":"/api/v4.1.0/holdings/arrangements/{arrangementId}","operationId":"getArrangementDetails","name":"Retrieves the details of the given arrangement such as arrangement id,account id,customer details,product details ,arrangement start date and arrangement status","summary":"Retrieves the details of an arrangement","tags":[],"parameters":[{"name":"arrangementId","in":"path","type":"string","required":true,"description":"Indicates an unique identifier of an account"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"ArrangementDetailsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/arrangements/{arrangementId}/bills","fullPath":"/api/v4.1.0/holdings/arrangements/{arrangementId}/bills","operationId":"getAllBills","name":"Retrieves the details of all the types of bills","summary":"Retrieves the details of all the types of bills","tags":[],"parameters":[{"name":"arrangementId","in":"path","type":"string","required":true,"description":"Indicates an unique identifier of an account"},{"name":"fileVersion","in":"query","type":"string","required":false,"description":"Indicates if the file is of type simulation or live"},{"name":"simulationReference","in":"query","type":"string","required":false,"description":"Indicates the reference id for simulation activity"},{"name":"paymentDate","in":"query","type":"string","required":false,"description":"Contains the date in which the payment will be sent out.\u00c2\u00a0Date in the format YYYYMMDD. E.g. 20191231"},{"name":"deferDate","in":"query","type":"string","required":false,"description":"Date that the payment has been deferred to"},{"name":"billedAmount","in":"query","type":"string","required":false,"description":"Indicates the bill amount"},{"name":"outstandingAmount","in":"query","type":"string","required":false,"description":"Contains the aggregate outstanding principal amount thereof after giving effect to any borrowings and prepayments or repayments of Committed Loans"},{"name":"delinquentAmount","in":"query","type":"string","required":false,"description":"Indicates the bill amount during the ageing status(Bill which crossed the due date)"},{"name":"property","in":"query","type":"string","required":false,"description":"Id of the product property"},{"name":"billStatus","in":"query","type":"string","required":false,"description":"Indicates the status of a bill(Issued,Due,Ageing,Settled)"},{"name":"settlementStatus","in":"query","type":"string","required":false,"description":"Defines the status of the settlement for the incoming MT548 swift message.The values allowed are: Waiting : pending to receive settlement status update meaning pending to receive MT548 swift message, "},{"name":"agingStatus","in":"query","type":"string","required":false,"description":"Indicates the ageing status of a bill"},{"name":"settled","in":"query","type":"string","required":false,"description":"Flag to indicate whether a bill is settled or not"},{"name":"paymentType","in":"query","type":"string","required":false,"description":"Indicates if the payment is Customer (C) type or Bank (B) type"},{"name":"billDate","in":"query","type":"string","required":false,"description":"Indicates a date on which a bill has been raised"},{"name":"billType","in":"query","type":"string","required":false,"description":"The type of payment obligation generated"},{"name":"paymentMethod","in":"query","type":"string","required":false,"description":"Method chosen to make the payment"},{"name":"infoPayType","in":"query","type":"string","required":false,"description":"Indicates a bill which is raised when a loan is paid off"},{"name":"advancePayment","in":"query","type":"string","required":false,"description":"Indicates whether advance payment made is set on an account"},{"name":"paymentIndicator","in":"query","type":"string","required":false,"description":"Indicates whether its a credit/debit type of bill"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"AllBillsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/arrangements/{arrangementId}/outstandingBills","fullPath":"/api/v4.1.0/holdings/arrangements/{arrangementId}/outstandingBills","operationId":"getOutstandingBills","name":"Retrieves the outstanding amount to be paid for an account","summary":"Retrieves the outstanding amount to be paid for an account","tags":[],"parameters":[{"name":"arrangementId","in":"path","type":"string","required":true,"description":"Indicates an unique identifier of an account"},{"name":"fileVersion","in":"query","type":"string","required":false,"description":"Indicates if the file is of type simulation or live"},{"name":"simulationReference","in":"query","type":"string","required":false,"description":"Indicates the reference id for simulation activity"},{"name":"paymentDate","in":"query","type":"string","required":false,"description":"Contains the date in which the payment will be sent out.\u00c2\u00a0Date in the format YYYYMMDD. E.g. 20191231"},{"name":"deferDate","in":"query","type":"string","required":false,"description":"Date that the payment has been deferred to"},{"name":"billedAmount","in":"query","type":"string","required":false,"description":"Indicates the bill amount"},{"name":"outstandingAmount","in":"query","type":"string","required":false,"description":"Contains the aggregate outstanding principal amount thereof after giving effect to any borrowings and prepayments or repayments of Committed Loans"},{"name":"delinquentAmount","in":"query","type":"string","required":false,"description":"Indicates the bill amount during the ageing status(Bill which crossed the due date)"},{"name":"property","in":"query","type":"string","required":false,"description":"Id of the product property"},{"name":"billStatus","in":"query","type":"string","required":false,"description":"Indicates the status of a bill(Issued,Due,Ageing,Settled)"},{"name":"settlementStatus","in":"query","type":"string","required":false,"description":"Defines the status of the settlement for the incoming MT548 swift message.The values allowed are: Waiting : pending to receive settlement status update meaning pending to receive MT548 swift message, "},{"name":"agingStatus","in":"query","type":"string","required":false,"description":"Indicates the ageing status of a bill"},{"name":"settled","in":"query","type":"string","required":false,"description":"Flag to indicate whether a bill is settled or not"},{"name":"paymentType","in":"query","type":"string","required":false,"description":"Indicates if the payment is Customer (C) type or Bank (B) type"},{"name":"billDate","in":"query","type":"string","required":false,"description":"Indicates a date on which a bill has been raised"},{"name":"billType","in":"query","type":"string","required":false,"description":"The type of payment obligation generated"},{"name":"paymentMethod","in":"query","type":"string","required":false,"description":"Method chosen to make the payment"},{"name":"infoPayType","in":"query","type":"string","required":false,"description":"Indicates a bill which is raised when a loan is paid off"},{"name":"advancePayment","in":"query","type":"string","required":false,"description":"Indicates whether advance payment made is set on an account"},{"name":"paymentIndicator","in":"query","type":"string","required":false,"description":"Indicates whether its a credit/debit type of bill"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"OutstandingBillsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/arrangements/{arrangementId}/deferredBills","fullPath":"/api/v4.1.0/holdings/arrangements/{arrangementId}/deferredBills","operationId":"getDeferredBills","name":"Retrieves the details of the deferred bills","summary":"Retrieves the details of the deferred bills","tags":[],"parameters":[{"name":"arrangementId","in":"path","type":"string","required":true,"description":"Indicates an unique identifier of an account"},{"name":"fileVersion","in":"query","type":"string","required":false,"description":"Indicates if the file is of type simulation or live"},{"name":"simulationReference","in":"query","type":"string","required":false,"description":"Indicates the reference id for simulation activity"},{"name":"paymentDate","in":"query","type":"string","required":false,"description":"Contains the date in which the payment will be sent out.\u00c2\u00a0Date in the format YYYYMMDD. E.g. 20191231"},{"name":"deferDate","in":"query","type":"string","required":false,"description":"Date that the payment has been deferred to"},{"name":"billedAmount","in":"query","type":"string","required":false,"description":"Indicates the bill amount"},{"name":"outstandingAmount","in":"query","type":"string","required":false,"description":"Contains the aggregate outstanding principal amount thereof after giving effect to any borrowings and prepayments or repayments of Committed Loans"},{"name":"delinquentAmount","in":"query","type":"string","required":false,"description":"Indicates the bill amount during the ageing status(Bill which crossed the due date)"},{"name":"property","in":"query","type":"string","required":false,"description":"Id of the product property"},{"name":"billStatus","in":"query","type":"string","required":false,"description":"Indicates the status of a bill(Issued,Due,Ageing,Settled)"},{"name":"settlementStatus","in":"query","type":"string","required":false,"description":"Defines the status of the settlement for the incoming MT548 swift message.The values allowed are: Waiting : pending to receive settlement status update meaning pending to receive MT548 swift message, "},{"name":"agingStatus","in":"query","type":"string","required":false,"description":"Indicates the ageing status of a bill"},{"name":"paymentType","in":"query","type":"string","required":false,"description":"Indicates if the payment is Customer (C) type or Bank (B) type"},{"name":"billDate","in":"query","type":"string","required":false,"description":"Indicates a date on which a bill has been raised"},{"name":"billType","in":"query","type":"string","required":false,"description":"The type of payment obligation generated"},{"name":"paymentMethod","in":"query","type":"string","required":false,"description":"Method chosen to make the payment"},{"name":"infoPayType","in":"query","type":"string","required":false,"description":"Indicates a bill which is raised when a loan is paid off"},{"name":"advancePayment","in":"query","type":"string","required":false,"description":"Indicates whether advance payment made is set on an account"},{"name":"paymentIndicator","in":"query","type":"string","required":false,"description":"Indicates whether its a credit/debit type of bill"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"DeferredBillsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/arrangements/{arrangementId}/externalBills","fullPath":"/api/v4.1.0/holdings/arrangements/{arrangementId}/externalBills","operationId":"getExternalBills","name":"Retrieves the details of the external type of bills","summary":"Retrieves the details of the external type of bills","tags":[],"parameters":[{"name":"arrangementId","in":"path","type":"string","required":true,"description":"Indicates an unique identifier of an account"},{"name":"simulationReference","in":"query","type":"string","required":false,"description":"Indicates the reference id for simulation activity"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"ExternalBillsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/arrangements/{arrangementId}/advanceBills","fullPath":"/api/v4.1.0/holdings/arrangements/{arrangementId}/advanceBills","operationId":"getAdvanceBills","name":"Retrieves the details of the advance bills","summary":"Retrieves the details of the advance bills","tags":[],"parameters":[{"name":"arrangementId","in":"path","type":"string","required":true,"description":"Indicates an unique identifier of an account"},{"name":"billStatus","in":"query","type":"string","required":false,"description":"Indicates the status of a bill(Issued,Due,Ageing,Settled)"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"AdvanceBillsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/arrangements/{arrangementId}/writeOffBills","fullPath":"/api/v4.1.0/holdings/arrangements/{arrangementId}/writeOffBills","operationId":"getWriteoffBills","name":"Retrieves the details of the write off bills","summary":"Retrieves the details of the write off bills","tags":[],"parameters":[{"name":"arrangementId","in":"path","type":"string","required":true,"description":"Indicates an unique identifier of an account"},{"name":"billStatus","in":"query","type":"string","required":true,"description":"Indicates the status of a bill(Issued,Due,Ageing,Settled)"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"WriteoffBillsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/arrangements/{arrangementId}/payOffBills","fullPath":"/api/v4.1.0/holdings/arrangements/{arrangementId}/payOffBills","operationId":"getPayoffDetails","name":"Retrieves the payoff details of an account","summary":"Retrieves the payoff details of an account","tags":[],"parameters":[{"name":"arrangementId","in":"path","type":"string","required":true,"description":"Indicates an unique identifier of an account"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"PayoffDetailsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/arrangements/writeOff/{arrangementId}/activities","fullPath":"/api/v4.1.0/holdings/arrangements/writeOff/{arrangementId}/activities","operationId":"getWriteOffActivitiesDetails","name":"Retrieves the details of write off bills based on activities","summary":"Retrieves the details of write off bills based on activities","tags":[],"parameters":[{"name":"arrangementId","in":"path","type":"string","required":true,"description":"Indicates an unique identifier of an account"},{"name":"fileVersion","in":"query","type":"string","required":false,"description":"Indicates if the file is of type simulation or live"},{"name":"simulationReference","in":"query","type":"string","required":false,"description":"Indicates the reference id for simulation activity"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"WriteOffActivitiesDetailsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/arrangements/{arrangementId}/settlements","fullPath":"/api/v4.1.0/holdings/arrangements/{arrangementId}/settlements","operationId":"getSettlementDetails","name":"Retrieves the settlement details for the given arrangement such as payment type, payin account, payin percentage, payin amount, payout account, payout percentage, payout amount, etc","summary":"Retrieves settlement details for the given arrangement","tags":["RETAIL"],"parameters":[{"name":"arrangementId","in":"path","type":"string","required":true,"description":"Indicates an unique identifier of an account"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"SettlementDetailsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/arrangements/{arrangementId}/paymentHolidays","fullPath":"/api/v4.1.0/holdings/arrangements/{arrangementId}/paymentHolidays","operationId":"getPaymentHoliday","name":"Retrieves payment holiday details for the given arrangement such as payment type, holiday date, original payment amount and new payment amount","summary":"Retrieves payment holiday details for the given arrangement","tags":["RETAIL"],"parameters":[{"name":"arrangementId","in":"path","type":"string","required":true,"description":"Indicates an unique identifier of an account"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"PaymentHolidayResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/arrangements/{arrangementId}/customers","fullPath":"/api/v4.1.0/holdings/arrangements/{arrangementId}/customers","operationId":"getCustomerDetail","name":"Retrieves all the customer details for the given arrangement such as customer id, customer name, customer role and their beneficiary type","summary":"Retrieves the customer details for the given arrangement","tags":["RETAIL"],"parameters":[{"name":"arrangementId","in":"path","type":"string","required":true,"description":"Indicates an unique identifier of an account"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"CustomerDetailResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/arrangements/simulations/{simulationId}/schedules","fullPath":"/api/v4.1.0/holdings/arrangements/simulations/{simulationId}/schedules","operationId":"getSchedulesSim","name":"Retrieves the repayment schedule details for an arrangement with simulation reference number","summary":"Retrieves the repayment schedule details for an arrangement with simulation reference number","tags":["RETAIL"],"parameters":[{"name":"simulationId","in":"path","type":"string","required":true,"description":"Indicates the Id generated during the simulation of an activity"},{"name":"arrangementId","in":"query","type":"string","required":false,"description":"Indicates an unique identifier of an account"},{"name":"dateFrom","in":"query","type":"string","required":false,"description":"Start date of the loan"},{"name":"dateTo","in":"query","type":"string","required":false,"description":"End date of the loan"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"SchedulesSimResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/transactions","fullPath":"/api/v4.1.0/holdings/transactions","operationId":"getArrangementTransactionsList","name":"Retrieves the details of account transaction","summary":"Retrieves account transaction","tags":[],"parameters":[{"name":"accountId","in":"query","type":"string","required":false,"description":"Identifier of the account. Often referred to as the account number, yet for consistency this is always referred to as accountId. Accepts both IBAN & BBAN"},{"name":"customerId","in":"query","type":"string","required":false,"description":"Identifier of the customer"},{"name":"listType","in":"query","type":"string","required":true,"description":"Indicates the transaction search type"},{"name":"transactionCount","in":"query","type":"string","required":false,"description":"Indicates the total number of transactions"},{"name":"payType","in":"query","type":"string","required":false,"description":"Indicates the identifier of payment types for  letter of credit."},{"name":"dateFrom","in":"query","type":"string","required":false,"description":"Start date of the loan"},{"name":"dateTo","in":"query","type":"string","required":false,"description":"End date of the loan"},{"name":"minimumAmount","in":"query","type":"string","required":false,"description":"The minimum account balance required."},{"name":"maximumAmount","in":"query","type":"string","required":false,"description":"The maximum account balance allowed."},{"name":"displayName","in":"query","type":"string","required":false,"description":"Contains the name used for display or enrichment purposes"},{"name":"transactionCode","in":"query","type":"string","required":false,"description":"Identifies the system internal transaction code applicable to the transaction"},{"name":"entryReference","in":"query","type":"string","required":false,"description":"It is the transaction reference. This is the identifier of the transaction on Temenos Core Banking system."},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"ArrangementTransactionsListResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/customers","fullPath":"/api/v4.1.0/holdings/customers","operationId":"getArrangementHoldings","name":"Retrieves the list of customer holdings details, such as arrangement accounts, loans and deposits.","summary":"Retrieves the list of product(Current/Saving/Loan/Deposit) details","tags":[],"parameters":[{"name":"customerId","in":"query","type":"string","required":false,"description":"Identifier of the customer"},{"name":"holdingsType","in":"query","type":"string","required":false,"description":"Contains the types of customer holdings"},{"name":"holdingsId","in":"query","type":"string","required":false,"description":"Contains the identifier specific to the holding details of the customer"},{"name":"getPreferredHoldings","in":"query","type":"string","required":false,"description":"Flag to fetch the preferred holding details (JWT required)"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"ArrangementHoldingsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/arrangements/{arrangementId}/paymentSchedules","fullPath":"/api/v4.1.0/holdings/arrangements/{arrangementId}/paymentSchedules","operationId":"getPaymentSchedule","name":"Retrieves the payment schedule of an arrangement account","summary":"Retrieves the payment schedule of an arrangement account","tags":[],"parameters":[{"name":"arrangementId","in":"path","type":"string","required":true,"description":"Indicates an unique identifier of an account"},{"name":"dateFrom","in":"query","type":"string","required":false,"description":"Start date of the loan"},{"name":"dateTo","in":"query","type":"string","required":false,"description":"End date of the loan"},{"name":"simulationReference","in":"query","type":"string","required":false,"description":"Indicates the reference id for simulation activity"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"PaymentScheduleResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}}]},{"key":"holdings-arrangements-v4.2.0","title":"Arrangement details","version":"v4.2.0","description":"API to retrieve the details of arrangement conditions such as charge, interest, limits, overdue, payment schedule, agent, alerts, and commitment. This API also allows to retrieve the pricing evaluation details, product qualification details, delivery messages, payment order, events and repayment sch","endpointCount":59,"endpoints":[{"method":"GET","path":"/holdings/arrangements/{arrangementId}/charges","fullPath":"/api/v4.2.0/holdings/arrangements/{arrangementId}/charges","operationId":"getChargeDetails","name":"Retrieves the charge details of an account","summary":"Retrieves the charge details of an account","tags":[],"parameters":[{"name":"arrangementId","in":"path","type":"string","required":true,"description":"Indicates an unique identifier of an account"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"ChargeDetailsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/arrangements/{arrangementId}/interestRates","fullPath":"/api/v4.2.0/holdings/arrangements/{arrangementId}/interestRates","operationId":"getInterestDetails","name":"Retrieves the interest condition of an account","summary":"Retrieves the interest condition of an account","tags":[],"parameters":[{"name":"arrangementId","in":"path","type":"string","required":true,"description":"Indicates an unique identifier of an account"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"InterestDetailsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/arrangements/{arrangementId}/limits","fullPath":"/api/v4.2.0/holdings/arrangements/{arrangementId}/limits","operationId":"getLimitDetails","name":"Retrieves the limit details of an arrangement account","summary":"Retrieves the limit details of an arrangement account","tags":[],"parameters":[{"name":"arrangementId","in":"path","type":"string","required":true,"description":"Indicates an unique identifier of an account"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"LimitDetailsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/accounts/overdueStatistics","fullPath":"/api/v4.2.0/holdings/accounts/overdueStatistics","operationId":"getOverdueStatistics","name":"Retrieves the overdue details of an account","summary":"Retrieves the overdue details of an account","tags":[],"parameters":[{"name":"overdueReference","in":"query","type":"string","required":true,"description":"Indicates the overdue reference"},{"name":"overdueReference_ct","in":"query","type":"string","required":true,"description":"Indicates the criteria for the contains operation on the overdue reference"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"OverdueStatisticsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/arrangements/{arrangementId}/scheduleDefinitions","fullPath":"/api/v4.2.0/holdings/arrangements/{arrangementId}/scheduleDefinitions","operationId":"getScheduleDetails","name":"Retrieves the payment schedule details of an account","summary":"Retrieves the payment schedule details of an account","tags":[],"parameters":[{"name":"arrangementId","in":"path","type":"string","required":true,"description":"Indicates an unique identifier of an account"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"ScheduleDetailsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/arrangements/{arrangementId}/repayments","fullPath":"/api/v4.2.0/holdings/arrangements/{arrangementId}/repayments","operationId":"getRepaymentDetails","name":"Retrieves the repayment details of an account based on the payment schedule","summary":"Retrieves the repayment details of an account based on the payment schedule","tags":[],"parameters":[{"name":"arrangementId","in":"path","type":"string","required":true,"description":"Indicates an unique identifier of an account"},{"name":"simulationReference","in":"query","type":"string","required":false,"description":"Indicates the reference id for simulation activity"},{"name":"dueDate","in":"query","type":"string","required":false,"description":"Identifies the date on which the activity is due."},{"name":"includeExternalFees","in":"query","type":"string","required":false,"description":"Indicates if external fee is included"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"RepaymentDetailsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/arrangements/{arrangementId}/agents","fullPath":"/api/v4.2.0/holdings/arrangements/{arrangementId}/agents","operationId":"getAgentDetails","name":"Retrieves the agent details of an account","summary":"Retrieves the agent details of an account","tags":[],"parameters":[{"name":"arrangementId","in":"path","type":"string","required":true,"description":"Indicates an unique identifier of an account"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"AgentDetailsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/accounts/{accountNumber}/activeAlerts","fullPath":"/api/v4.2.0/holdings/accounts/{accountNumber}/activeAlerts","operationId":"getActiveAlerts","name":"Retrieves the details of active alerts for a given account number","summary":"Retrieves the details of active alerts for a given account number","tags":[],"parameters":[{"name":"accountNumber","in":"path","type":"string","required":true,"description":"Identifier of the account. Often referred to as the account number, yet for consistency this is always referred to as accountId. Accepts both IBAN & BBAN"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"ActiveAlertsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/accounts/{accountNumber}/historyAlerts","fullPath":"/api/v4.2.0/holdings/accounts/{accountNumber}/historyAlerts","operationId":"getHistoryAlerts","name":"Retrieves the details of history alerts for a given account number","summary":"Retrieves the details of history alerts for a given account number","tags":[],"parameters":[{"name":"accountNumber","in":"path","type":"string","required":true,"description":"Identifier of the account. Often referred to as the account number, yet for consistency this is always referred to as accountId. Accepts both IBAN & BBAN"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"HistoryAlertsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/arrangements/{arrangementId}/annualPercentageRates","fullPath":"/api/v4.2.0/holdings/arrangements/{arrangementId}/annualPercentageRates","operationId":"getAprDetails","name":"Retrieves the annual percentage rate of an account","summary":"Retrieves the annual percentage rate of an account","tags":[],"parameters":[{"name":"arrangementId","in":"path","type":"string","required":true,"description":"Indicates an unique identifier of an account"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"AprDetailsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/arrangements/{arrangementId}/holidayLimit","fullPath":"/api/v4.2.0/holdings/arrangements/{arrangementId}/holidayLimit","operationId":"getHolidayLimit","name":"Retrieves the details of payment holiday limit amount","summary":"Retrieves the details of payment holiday limit amount","tags":[],"parameters":[{"name":"arrangementId","in":"path","type":"string","required":true,"description":"Indicates an unique identifier of an account"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"HolidayLimitResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/arrangements/{arrangementId}/commitments","fullPath":"/api/v4.2.0/holdings/arrangements/{arrangementId}/commitments","operationId":"getCommitmentDetails","name":"Retrieves the commitment details of an account","summary":"Retrieves the commitment details of an account","tags":[],"parameters":[{"name":"arrangementId","in":"path","type":"string","required":true,"description":"Indicates an unique identifier of an account"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"CommitmentDetailsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/arrangements/{arrangementId}/qualifiers","fullPath":"/api/v4.2.0/holdings/arrangements/{arrangementId}/qualifiers","operationId":"getProductQualifierDetails","name":"Retrieves the product qualifier details of an account","summary":"Retrieves the product qualifier details of an account","tags":[],"parameters":[{"name":"arrangementId","in":"path","type":"string","required":true,"description":"Indicates an unique identifier of an account"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"ProductQualifierDetailsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/arrangements/{arrangementId}/evaluations","fullPath":"/api/v4.2.0/holdings/arrangements/{arrangementId}/evaluations","operationId":"getEvaluationDetails","name":"Retrieves the pricing evaluation details of an account.","summary":"Retrieves the pricing evaluation details of an account","tags":[],"parameters":[{"name":"arrangementId","in":"path","type":"string","required":true,"description":"Indicates an unique identifier of an account"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"EvaluationDetailsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/accounts/{arrangementId}/dates","fullPath":"/api/v4.2.0/holdings/accounts/{arrangementId}/dates","operationId":"getArrangementDates","name":"Retrieves the key dates of an account","summary":"Retrieves the key dates of an account","tags":[],"parameters":[{"name":"arrangementId","in":"path","type":"string","required":true,"description":"Indicates an unique identifier of an account"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"ArrangementDatesResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/arrangements/{arrangementId}/interestAccruals","fullPath":"/api/v4.2.0/holdings/arrangements/{arrangementId}/interestAccruals","operationId":"getInterestDetailsCurrent","name":"Retrieves the interest accrued for the current period of an account","summary":"Retrieves the interest accrued for the current period of an account","tags":[],"parameters":[{"name":"arrangementId","in":"path","type":"string","required":true,"description":"Indicates an unique identifier of an account"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"InterestDetailsCurrentResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/arrangements/{arrangementId}/historicInterestAccruals","fullPath":"/api/v4.2.0/holdings/arrangements/{arrangementId}/historicInterestAccruals","operationId":"getInterestDetailsPrevious","name":"Retrieve the past period's interest accruals","summary":"Retrieve the past period's interest accruals","tags":[],"parameters":[{"name":"arrangementId","in":"path","type":"string","required":true,"description":"Indicates an unique identifier of an account"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"InterestDetailsPreviousResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/arrangements/{arrangementId}/yearToDateInterestAccruals","fullPath":"/api/v4.2.0/holdings/arrangements/{arrangementId}/yearToDateInterestAccruals","operationId":"getInterestDetailsYearToDate","name":"Retrieves the interest accruals of the previous year","summary":"Retrieves the interest accruals of the previous year","tags":[],"parameters":[{"name":"arrangementId","in":"path","type":"string","required":true,"description":"Indicates an unique identifier of an account"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"InterestDetailsYearToDateResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/accounts/{arrangementId}/messages","fullPath":"/api/v4.2.0/holdings/accounts/{arrangementId}/messages","operationId":"getDeliveryMessages","name":"Retrieves the details of delivery messages for a given arrangement Id","summary":"Retrieves the details of delivery messages for a given arrangement Id","tags":[],"parameters":[{"name":"arrangementId","in":"path","type":"string","required":true,"description":"Indicates an unique identifier of an account"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"DeliveryMessagesResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/accounts/{arrangementId}/historyMessages","fullPath":"/api/v4.2.0/holdings/accounts/{arrangementId}/historyMessages","operationId":"getDeliveryMessagesHistory","name":"Retrieves the details of history delivery messages for a given arrangement Id","summary":"Retrieves the details of history delivery messages for a given arrangement Id","tags":[],"parameters":[{"name":"arrangementId","in":"path","type":"string","required":true,"description":"Indicates an unique identifier of an account"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"DeliveryMessagesHistoryResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/arrangements/{arrangementId}/stmtEntries","fullPath":"/api/v4.2.0/holdings/arrangements/{arrangementId}/stmtEntries","operationId":"getStmtEntries","name":"Retrieves the statement entries of an arrangement account","summary":"Retrieves the statement entries of an arrangement account","tags":[],"parameters":[{"name":"arrangementId","in":"path","type":"string","required":true,"description":"Indicates an unique identifier of an account"},{"name":"valueDate","in":"query","type":"string","required":false,"description":"Indicates the value date on which the underlying accounting entry is to be given value (for interest purposes)"},{"name":"stmtFlag","in":"query","type":"string","required":false,"description":""},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"StmtEntriesResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/arrangements/{arrangementId}/dataEvents","fullPath":"/api/v4.2.0/holdings/arrangements/{arrangementId}/dataEvents","operationId":"getArrangementPropertyConditions","name":"Retrieves the property conditions to the data events","summary":"Retrieves the property conditions","tags":[],"parameters":[{"name":"arrangementId","in":"path","type":"string","required":true,"description":"Indicates an unique identifier of an account"},{"name":"status","in":"query","type":"string","required":true,"description":"Contains status of the data rights request.Allowed values are INITIATED, INPROGESS, EXTENDED, COMPLETED, REJECTED."},{"name":"arrangementActivityId","in":"query","type":"string","required":false,"description":"Contains the arrangement activity reference identifier"},{"name":"effectiveDate","in":"query","type":"string","required":false,"description":"Contains the identifier for the transaction date. Dates are expected in \u00e2\u20ac\u02dcYYYYMMDD\u00e2\u20ac\u2122 format"},{"name":"property","in":"query","type":"string","required":false,"description":"Id of the product property"},{"name":"dataEvent","in":"query","type":"string","required":false,"description":"Indicates the data event flag"},{"name":"ofsSource","in":"query","type":"string","required":false,"description":"Indicates the source of the OFS"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"ArrangementPropertyConditionsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/arrangements/{arrangementId}/schedules","fullPath":"/api/v4.2.0/holdings/arrangements/{arrangementId}/schedules","operationId":"getSchedulesFull","name":"Retrieves the repayment schedule details for an arrangement","summary":"Retrieves the repayment schedule details for an arrangement","tags":[],"parameters":[{"name":"arrangementId","in":"path","type":"string","required":true,"description":"Indicates an unique identifier of an account"},{"name":"simulationReference","in":"query","type":"string","required":false,"description":"Indicates the reference id for simulation activity"},{"name":"dateFrom","in":"query","type":"string","required":false,"description":"Start date of the loan"},{"name":"dateTo","in":"query","type":"string","required":false,"description":"End date of the loan"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"SchedulesFullResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/arrangements/{arrangementActivityId}/simulationReferences","fullPath":"/api/v4.2.0/holdings/arrangements/{arrangementActivityId}/simulationReferences","operationId":"getSimulationReference","name":"Retrieves the simulation reference for the given arrangement activity id","summary":"Retrieves the simulation reference for the given arrangement activity id","tags":[],"parameters":[{"name":"arrangementActivityId","in":"path","type":"string","required":true,"description":"Contains the arrangement activity reference identifier"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"SimulationReferenceResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/arrangement/{arrangementId}/alerts","fullPath":"/api/v4.2.0/holdings/arrangement/{arrangementId}/alerts","operationId":"getArrangementAlerts","name":"Retrieves the list of alerts applicable for an arrangement","summary":"Retrieves the list of alerts applicable for an arrangement","tags":[],"parameters":[{"name":"arrangementId","in":"path","type":"string","required":true,"description":"Indicates an unique identifier of an account"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"ArrangementAlertsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/arrangements/{arrangementId}/simulations","fullPath":"/api/v4.2.0/holdings/arrangements/{arrangementId}/simulations","operationId":"getSimulationDetails","name":"Retrieves the simulated activity details of an account","summary":"Retrieves the simulated activity details of an account","tags":[],"parameters":[{"name":"arrangementId","in":"path","type":"string","required":true,"description":"Indicates an unique identifier of an account"},{"name":"simulationCaptureReferenceId","in":"query","type":"string","required":false,"description":"Indicates the Reference Id for the simulation activity"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"SimulationDetailsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/customers/{customerId}/arrangements","fullPath":"/api/v4.2.0/holdings/customers/{customerId}/arrangements","operationId":"getCustomerArrangementDetails","name":"Retrieves the list of arrangement ids for a given customer","summary":"Retrieves the list of arrangement ids for a given customer","tags":[],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"Identifier of the customer"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"CustomerArrangementDetailsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/arrangements/{arrangementId}/chargeOffBalances","fullPath":"/api/v4.2.0/holdings/arrangements/{arrangementId}/chargeOffBalances","operationId":"getChargeOffDetails","name":"Retrieves the charge off balances of an arrangement account","summary":"Retrieves the charge off balances of an arrangement account","tags":[],"parameters":[{"name":"arrangementId","in":"path","type":"string","required":true,"description":"Indicates an unique identifier of an account"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"ChargeOffDetailsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/arrangements/{arrangementId}/consolidatedBalances","fullPath":"/api/v4.2.0/holdings/arrangements/{arrangementId}/consolidatedBalances","operationId":"getVirtualBalances","name":"Retrieves the virtual balances for a balance type of an account","summary":"Retrieves the virtual balances for a balance type of an account","tags":[],"parameters":[{"name":"arrangementId","in":"path","type":"string","required":true,"description":"Indicates an unique identifier of an account"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"VirtualBalancesResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/arrangements/{arrangementId}/activities","fullPath":"/api/v4.2.0/holdings/arrangements/{arrangementId}/activities","operationId":"getArrangementActivityLog","name":"Retrieves the activity log of an account","summary":"Retrieves the activity log of an account","tags":[],"parameters":[{"name":"arrangementId","in":"path","type":"string","required":true,"description":"Indicates an unique identifier of an account"},{"name":"simulation","in":"query","type":"string","required":false,"description":"What if scenario reference"},{"name":"startDate","in":"query","type":"string","required":false,"description":"Contains the date on which the transaction or payment gets initiated."},{"name":"endDate","in":"query","type":"string","required":false,"description":"Indicates the date till which the transaction history requested. If 20120101 is the start date and 20120201 is the end date, all transactions that are booked between January 1 to February 1 2012 are r"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"ArrangementActivityLogResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/arrangements/{arrangementId}/financialActivities","fullPath":"/api/v4.2.0/holdings/arrangements/{arrangementId}/financialActivities","operationId":"getFinancialActivities","name":"Retrieves the financial activity log of an account","summary":"Retrieves the financial activity log of an account","tags":[],"parameters":[{"name":"arrangementId","in":"path","type":"string","required":true,"description":"Indicates an unique identifier of an account"},{"name":"simulationReference","in":"query","type":"string","required":false,"description":"Indicates the reference id for simulation activity"},{"name":"startDate","in":"query","type":"string","required":false,"description":"Contains the date on which the transaction or payment gets initiated."},{"name":"endDate","in":"query","type":"string","required":false,"description":"Indicates the date till which the transaction history requested. If 20120101 is the start date and 20120201 is the end date, all transactions that are booked between January 1 to February 1 2012 are r"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"FinancialActivitiesResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/arrangements/{arrangementId}/userActivities","fullPath":"/api/v4.2.0/holdings/arrangements/{arrangementId}/userActivities","operationId":"getUserActivities","name":"Lists the user related activity logs of an account","summary":"Lists the user related activity logs of an account","tags":[],"parameters":[{"name":"arrangementId","in":"path","type":"string","required":true,"description":"Indicates an unique identifier of an account"},{"name":"simulationReference","in":"query","type":"string","required":false,"description":"Indicates the reference id for simulation activity"},{"name":"startDate","in":"query","type":"string","required":false,"description":"Contains the date on which the transaction or payment gets initiated."},{"name":"endDate","in":"query","type":"string","required":false,"description":"Indicates the date till which the transaction history requested. If 20120101 is the start date and 20120201 is the end date, all transactions that are booked between January 1 to February 1 2012 are r"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"UserActivitiesResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/arrangements/{arrangementId}/systemActivities","fullPath":"/api/v4.2.0/holdings/arrangements/{arrangementId}/systemActivities","operationId":"getSystemActivities","name":"Retrieves the system activities of an account","summary":"Retrieves the system activities of an account","tags":[],"parameters":[{"name":"arrangementId","in":"path","type":"string","required":true,"description":"Indicates an unique identifier of an account"},{"name":"simulationReference","in":"query","type":"string","required":false,"description":"Indicates the reference id for simulation activity"},{"name":"startDate","in":"query","type":"string","required":false,"description":"Contains the date on which the transaction or payment gets initiated."},{"name":"endDate","in":"query","type":"string","required":false,"description":"Indicates the date till which the transaction history requested. If 20120101 is the start date and 20120201 is the end date, all transactions that are booked between January 1 to February 1 2012 are r"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"SystemActivitiesResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/arrangements/{arrangementId}/holdActivities","fullPath":"/api/v4.2.0/holdings/arrangements/{arrangementId}/holdActivities","operationId":"getHoldActivities","name":"Retrieves the log of an activity in hold of an account","summary":"Retrieves the log of an activity in hold of an account","tags":[],"parameters":[{"name":"arrangementId","in":"path","type":"string","required":true,"description":"Indicates an unique identifier of an account"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"HoldActivitiesResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/arrangements/{arrangementId}/archievedActivities","fullPath":"/api/v4.2.0/holdings/arrangements/{arrangementId}/archievedActivities","operationId":"getArchievedActivities","name":"Retrieves the archived activity log of an account","summary":"Retrieves the archived activity log of an account","tags":[],"parameters":[{"name":"arrangementId","in":"path","type":"string","required":true,"description":"Indicates an unique identifier of an account"},{"name":"simulationReference","in":"query","type":"string","required":false,"description":"Indicates the reference id for simulation activity"},{"name":"startDate","in":"query","type":"string","required":false,"description":"Contains the date on which the transaction or payment gets initiated."},{"name":"endDate","in":"query","type":"string","required":false,"description":"Indicates the date till which the transaction history requested. If 20120101 is the start date and 20120201 is the end date, all transactions that are booked between January 1 to February 1 2012 are r"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"ArchievedActivitiesResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/arrangements/{arrangementId}/transactions","fullPath":"/api/v4.2.0/holdings/arrangements/{arrangementId}/transactions","operationId":"getAccountSummary","name":"Retrieves the transaction list for a given account number","summary":"Retrieves the transaction list for a given account number","tags":[],"parameters":[{"name":"arrangementId","in":"path","type":"string","required":true,"description":"Indicates an unique identifier of an account"},{"name":"startDate","in":"query","type":"string","required":false,"description":"Contains the date on which the transaction or payment gets initiated."},{"name":"endDate","in":"query","type":"string","required":false,"description":"Indicates the date till which the transaction history requested. If 20120101 is the start date and 20120201 is the end date, all transactions that are booked between January 1 to February 1 2012 are r"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"AccountSummaryResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/arrangements/{arrangementId}/eligibileActivities","fullPath":"/api/v4.2.0/holdings/arrangements/{arrangementId}/eligibileActivities","operationId":"getArrangementActivities","name":"Retrieves the list of activities applicable for an arrangement account","summary":"Retrieves the list of activities applicable for an arrangement account","tags":[],"parameters":[{"name":"arrangementId","in":"path","type":"string","required":true,"description":"Indicates an unique identifier of an account"},{"name":"activityId","in":"query","type":"string","required":false,"description":"Id of the activity, e.g. ACCOUNTS-CAPITALISE-ACCHARGE*CARDISSUEFEE"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"ArrangementActivitiesResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/arrangements/unapprovedArrangementActivites","fullPath":"/api/v4.2.0/holdings/arrangements/unapprovedArrangementActivites","operationId":"getUnauthorisedAAA","name":"Retrieves the list of unauthorised activities of an account","summary":"Retrieves the list of unauthorised activities of an account","tags":[],"parameters":[{"name":"customerId","in":"query","type":"string","required":false,"description":"Identifier of the customer"},{"name":"activity","in":"query","type":"string","required":false,"description":"Defines the activity to be processed against the Arrangement. The activity may be a user activity or a system generated activity."},{"name":"arrangementId","in":"query","type":"string","required":false,"description":"Indicates an unique identifier of an account"},{"name":"product","in":"query","type":"string","required":false,"description":"Contains the name of the product"},{"name":"currency","in":"query","type":"string","required":false,"description":"Identifies the currency. E.g. USD, GBP etc"},{"name":"contractId","in":"query","type":"string","required":false,"description":"Indicates the unique identifier of the transaction or contract which initiated the activity"},{"name":"transactionAmount","in":"query","type":"string","required":false,"description":"Contains the transaction amount. This is based on the currency, either local or foreign currency"},{"name":"transactionAmountLocalCurrency","in":"query","type":"string","required":false,"description":"Indicates the transaction amount in local currency"},{"name":"applicationId","in":"query","type":"string","required":false,"description":"Contains the application id of the service that has crashed due to error."},{"name":"inputter","in":"query","type":"string","required":false,"description":"The user identifier who input the transaction"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"UnauthorisedAAAResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/arrangements/{arrangementId}/bundles","fullPath":"/api/v4.2.0/holdings/arrangements/{arrangementId}/bundles","operationId":"getLinktArrDetails","name":"Retrieves the link arrangement details of an account","summary":"Retrieves the link arrangement details of an account","tags":[],"parameters":[{"name":"arrangementId","in":"path","type":"string","required":true,"description":"Indicates an unique identifier of an account"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"LinktArrDetailsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/arrangements/{arrangementId}/documents","fullPath":"/api/v4.2.0/holdings/arrangements/{arrangementId}/documents","operationId":"getTransactionDocuments","name":"Retrieves the transaction document details of a given arrangement account","summary":"Retrieves the transaction document details of a given arrangement account","tags":[],"parameters":[{"name":"arrangementId","in":"path","type":"string","required":true,"description":"Indicates an unique identifier of an account"},{"name":"transactionReference","in":"query","type":"string","required":false,"description":"Contains the identifier for the transaction in the core system"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"TransactionDocumentsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/arrangements/{arrangementId}/balances","fullPath":"/api/v4.2.0/holdings/arrangements/{arrangementId}/balances","operationId":"getArrangementBalances","name":"Retrieves the balance details for a given arrangement","summary":"Retrieves the working ,ledger and cleared balances for an arrangement","tags":[],"parameters":[{"name":"arrangementId","in":"path","type":"string","required":true,"description":""},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"ArrangementBalancesResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"DELETE","path":"/holdings/arrangementActivityId/{activityId}","fullPath":"/api/v4.2.0/holdings/arrangementActivityId/{activityId}","operationId":"reverseAccounts","name":"Deletes an arrangement on which no transactions are  posted","summary":"Deletes an arrangement on which no transactions are  posted","tags":[],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"activityId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":null,"responses":{"200":"reverseAccountsResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"GET","path":"/holdings/arrangements/{arrangementId}","fullPath":"/api/v4.2.0/holdings/arrangements/{arrangementId}","operationId":"getArrangementDetails","name":"Retrieves the details of the given arrangement such as arrangement id,account id,customer details,product details ,arrangement start date and arrangement status","summary":"Retrieves the details of an arrangement","tags":[],"parameters":[{"name":"arrangementId","in":"path","type":"string","required":true,"description":"Indicates an unique identifier of an account"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"ArrangementDetailsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/arrangements/{arrangementId}/bills","fullPath":"/api/v4.2.0/holdings/arrangements/{arrangementId}/bills","operationId":"getAllBills","name":"Retrieves the details of all the types of bills","summary":"Retrieves the details of all the types of bills","tags":[],"parameters":[{"name":"arrangementId","in":"path","type":"string","required":true,"description":"Indicates an unique identifier of an account"},{"name":"fileVersion","in":"query","type":"string","required":false,"description":"Indicates if the file is of type simulation or live"},{"name":"simulationReference","in":"query","type":"string","required":false,"description":"Indicates the reference id for simulation activity"},{"name":"paymentDate","in":"query","type":"string","required":false,"description":"Contains the date in which the payment will be sent out.\u00c2\u00a0Date in the format YYYYMMDD. E.g. 20191231"},{"name":"deferDate","in":"query","type":"string","required":false,"description":"Date that the payment has been deferred to"},{"name":"billedAmount","in":"query","type":"string","required":false,"description":"Indicates the bill amount"},{"name":"outstandingAmount","in":"query","type":"string","required":false,"description":"Contains the aggregate outstanding principal amount thereof after giving effect to any borrowings and prepayments or repayments of Committed Loans"},{"name":"delinquentAmount","in":"query","type":"string","required":false,"description":"Indicates the bill amount during the ageing status(Bill which crossed the due date)"},{"name":"property","in":"query","type":"string","required":false,"description":"Id of the product property"},{"name":"billStatus","in":"query","type":"string","required":false,"description":"Indicates the status of a bill(Issued,Due,Ageing,Settled)"},{"name":"settlementStatus","in":"query","type":"string","required":false,"description":"Defines the status of the settlement for the incoming MT548 swift message.The values allowed are: Waiting : pending to receive settlement status update meaning pending to receive MT548 swift message, "},{"name":"agingStatus","in":"query","type":"string","required":false,"description":"Indicates the ageing status of a bill"},{"name":"settled","in":"query","type":"string","required":false,"description":"Flag to indicate whether a bill is settled or not"},{"name":"paymentType","in":"query","type":"string","required":false,"description":"Indicates if the payment is Customer (C) type or Bank (B) type"},{"name":"billDate","in":"query","type":"string","required":false,"description":"Indicates a date on which a bill has been raised"},{"name":"billType","in":"query","type":"string","required":false,"description":"The type of payment obligation generated"},{"name":"paymentMethod","in":"query","type":"string","required":false,"description":"Method chosen to make the payment"},{"name":"infoPayType","in":"query","type":"string","required":false,"description":"Indicates a bill which is raised when a loan is paid off"},{"name":"advancePayment","in":"query","type":"string","required":false,"description":"Indicates whether advance payment made is set on an account"},{"name":"paymentIndicator","in":"query","type":"string","required":false,"description":"Indicates whether its a credit/debit type of bill"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"AllBillsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/arrangements/{arrangementId}/outstandingBills","fullPath":"/api/v4.2.0/holdings/arrangements/{arrangementId}/outstandingBills","operationId":"getOutstandingBills","name":"Retrieves the outstanding amount to be paid for an account","summary":"Retrieves the outstanding amount to be paid for an account","tags":[],"parameters":[{"name":"arrangementId","in":"path","type":"string","required":true,"description":"Indicates an unique identifier of an account"},{"name":"fileVersion","in":"query","type":"string","required":false,"description":"Indicates if the file is of type simulation or live"},{"name":"simulationReference","in":"query","type":"string","required":false,"description":"Indicates the reference id for simulation activity"},{"name":"paymentDate","in":"query","type":"string","required":false,"description":"Contains the date in which the payment will be sent out.\u00c2\u00a0Date in the format YYYYMMDD. E.g. 20191231"},{"name":"deferDate","in":"query","type":"string","required":false,"description":"Date that the payment has been deferred to"},{"name":"billedAmount","in":"query","type":"string","required":false,"description":"Indicates the bill amount"},{"name":"outstandingAmount","in":"query","type":"string","required":false,"description":"Contains the aggregate outstanding principal amount thereof after giving effect to any borrowings and prepayments or repayments of Committed Loans"},{"name":"delinquentAmount","in":"query","type":"string","required":false,"description":"Indicates the bill amount during the ageing status(Bill which crossed the due date)"},{"name":"property","in":"query","type":"string","required":false,"description":"Id of the product property"},{"name":"billStatus","in":"query","type":"string","required":false,"description":"Indicates the status of a bill(Issued,Due,Ageing,Settled)"},{"name":"settlementStatus","in":"query","type":"string","required":false,"description":"Defines the status of the settlement for the incoming MT548 swift message.The values allowed are: Waiting : pending to receive settlement status update meaning pending to receive MT548 swift message, "},{"name":"agingStatus","in":"query","type":"string","required":false,"description":"Indicates the ageing status of a bill"},{"name":"settled","in":"query","type":"string","required":false,"description":"Flag to indicate whether a bill is settled or not"},{"name":"paymentType","in":"query","type":"string","required":false,"description":"Indicates if the payment is Customer (C) type or Bank (B) type"},{"name":"billDate","in":"query","type":"string","required":false,"description":"Indicates a date on which a bill has been raised"},{"name":"billType","in":"query","type":"string","required":false,"description":"The type of payment obligation generated"},{"name":"paymentMethod","in":"query","type":"string","required":false,"description":"Method chosen to make the payment"},{"name":"infoPayType","in":"query","type":"string","required":false,"description":"Indicates a bill which is raised when a loan is paid off"},{"name":"advancePayment","in":"query","type":"string","required":false,"description":"Indicates whether advance payment made is set on an account"},{"name":"paymentIndicator","in":"query","type":"string","required":false,"description":"Indicates whether its a credit/debit type of bill"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"OutstandingBillsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/arrangements/{arrangementId}/deferredBills","fullPath":"/api/v4.2.0/holdings/arrangements/{arrangementId}/deferredBills","operationId":"getDeferredBills","name":"Retrieves the details of the deferred bills","summary":"Retrieves the details of the deferred bills","tags":[],"parameters":[{"name":"arrangementId","in":"path","type":"string","required":true,"description":"Indicates an unique identifier of an account"},{"name":"fileVersion","in":"query","type":"string","required":false,"description":"Indicates if the file is of type simulation or live"},{"name":"simulationReference","in":"query","type":"string","required":false,"description":"Indicates the reference id for simulation activity"},{"name":"paymentDate","in":"query","type":"string","required":false,"description":"Contains the date in which the payment will be sent out.\u00c2\u00a0Date in the format YYYYMMDD. E.g. 20191231"},{"name":"deferDate","in":"query","type":"string","required":false,"description":"Date that the payment has been deferred to"},{"name":"billedAmount","in":"query","type":"string","required":false,"description":"Indicates the bill amount"},{"name":"outstandingAmount","in":"query","type":"string","required":false,"description":"Contains the aggregate outstanding principal amount thereof after giving effect to any borrowings and prepayments or repayments of Committed Loans"},{"name":"delinquentAmount","in":"query","type":"string","required":false,"description":"Indicates the bill amount during the ageing status(Bill which crossed the due date)"},{"name":"property","in":"query","type":"string","required":false,"description":"Id of the product property"},{"name":"billStatus","in":"query","type":"string","required":false,"description":"Indicates the status of a bill(Issued,Due,Ageing,Settled)"},{"name":"settlementStatus","in":"query","type":"string","required":false,"description":"Defines the status of the settlement for the incoming MT548 swift message.The values allowed are: Waiting : pending to receive settlement status update meaning pending to receive MT548 swift message, "},{"name":"agingStatus","in":"query","type":"string","required":false,"description":"Indicates the ageing status of a bill"},{"name":"paymentType","in":"query","type":"string","required":false,"description":"Indicates if the payment is Customer (C) type or Bank (B) type"},{"name":"billDate","in":"query","type":"string","required":false,"description":"Indicates a date on which a bill has been raised"},{"name":"billType","in":"query","type":"string","required":false,"description":"The type of payment obligation generated"},{"name":"paymentMethod","in":"query","type":"string","required":false,"description":"Method chosen to make the payment"},{"name":"infoPayType","in":"query","type":"string","required":false,"description":"Indicates a bill which is raised when a loan is paid off"},{"name":"advancePayment","in":"query","type":"string","required":false,"description":"Indicates whether advance payment made is set on an account"},{"name":"paymentIndicator","in":"query","type":"string","required":false,"description":"Indicates whether its a credit/debit type of bill"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"DeferredBillsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/arrangements/{arrangementId}/externalBills","fullPath":"/api/v4.2.0/holdings/arrangements/{arrangementId}/externalBills","operationId":"getExternalBills","name":"Retrieves the details of the external type of bills","summary":"Retrieves the details of the external type of bills","tags":[],"parameters":[{"name":"arrangementId","in":"path","type":"string","required":true,"description":"Indicates an unique identifier of an account"},{"name":"simulationReference","in":"query","type":"string","required":false,"description":"Indicates the reference id for simulation activity"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"ExternalBillsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/arrangements/{arrangementId}/advanceBills","fullPath":"/api/v4.2.0/holdings/arrangements/{arrangementId}/advanceBills","operationId":"getAdvanceBills","name":"Retrieves the details of the advance bills","summary":"Retrieves the details of the advance bills","tags":[],"parameters":[{"name":"arrangementId","in":"path","type":"string","required":true,"description":"Indicates an unique identifier of an account"},{"name":"billStatus","in":"query","type":"string","required":false,"description":"Indicates the status of a bill(Issued,Due,Ageing,Settled)"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"AdvanceBillsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/arrangements/{arrangementId}/writeOffBills","fullPath":"/api/v4.2.0/holdings/arrangements/{arrangementId}/writeOffBills","operationId":"getWriteoffBills","name":"Retrieves the details of the write off bills","summary":"Retrieves the details of the write off bills","tags":[],"parameters":[{"name":"arrangementId","in":"path","type":"string","required":true,"description":"Indicates an unique identifier of an account"},{"name":"billStatus","in":"query","type":"string","required":true,"description":"Indicates the status of a bill(Issued,Due,Ageing,Settled)"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"WriteoffBillsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/arrangements/{arrangementId}/payOffBills","fullPath":"/api/v4.2.0/holdings/arrangements/{arrangementId}/payOffBills","operationId":"getPayoffDetails","name":"Retrieves the payoff details of an account","summary":"Retrieves the payoff details of an account","tags":[],"parameters":[{"name":"arrangementId","in":"path","type":"string","required":true,"description":"Indicates an unique identifier of an account"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"PayoffDetailsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/arrangements/writeOff/{arrangementId}/activities","fullPath":"/api/v4.2.0/holdings/arrangements/writeOff/{arrangementId}/activities","operationId":"getWriteOffActivitiesDetails","name":"Retrieves the details of write off bills based on activities","summary":"Retrieves the details of write off bills based on activities","tags":[],"parameters":[{"name":"arrangementId","in":"path","type":"string","required":true,"description":"Indicates an unique identifier of an account"},{"name":"fileVersion","in":"query","type":"string","required":false,"description":"Indicates if the file is of type simulation or live"},{"name":"simulationReference","in":"query","type":"string","required":false,"description":"Indicates the reference id for simulation activity"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"WriteOffActivitiesDetailsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/arrangements/{arrangementId}/settlements","fullPath":"/api/v4.2.0/holdings/arrangements/{arrangementId}/settlements","operationId":"getSettlementDetails","name":"Retrieves the settlement details for the given arrangement such as payment type, payin account, payin percentage, payin amount, payout account, payout percentage, payout amount, etc","summary":"Retrieves settlement details for the given arrangement","tags":["RETAIL"],"parameters":[{"name":"arrangementId","in":"path","type":"string","required":true,"description":"Indicates an unique identifier of an account"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"SettlementDetailsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/arrangements/{arrangementId}/paymentHolidays","fullPath":"/api/v4.2.0/holdings/arrangements/{arrangementId}/paymentHolidays","operationId":"getPaymentHoliday","name":"Retrieves payment holiday details for the given arrangement such as payment type, holiday date, original payment amount and new payment amount","summary":"Retrieves payment holiday details for the given arrangement","tags":["RETAIL"],"parameters":[{"name":"arrangementId","in":"path","type":"string","required":true,"description":"Indicates an unique identifier of an account"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"PaymentHolidayResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/arrangements/{arrangementId}/customers","fullPath":"/api/v4.2.0/holdings/arrangements/{arrangementId}/customers","operationId":"getCustomerDetail","name":"Retrieves all the customer details for the given arrangement such as customer id, customer name, customer role and their beneficiary type","summary":"Retrieves the customer details for the given arrangement","tags":["RETAIL"],"parameters":[{"name":"arrangementId","in":"path","type":"string","required":true,"description":"Indicates an unique identifier of an account"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"CustomerDetailResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/arrangements/simulations/{simulationId}/schedules","fullPath":"/api/v4.2.0/holdings/arrangements/simulations/{simulationId}/schedules","operationId":"getSchedulesSim","name":"Retrieves the repayment schedule details for an arrangement with simulation reference number","summary":"Retrieves the repayment schedule details for an arrangement with simulation reference number","tags":["RETAIL"],"parameters":[{"name":"simulationId","in":"path","type":"string","required":true,"description":"Indicates the Id generated during the simulation of an activity"},{"name":"arrangementId","in":"query","type":"string","required":false,"description":"Indicates an unique identifier of an account"},{"name":"dateFrom","in":"query","type":"string","required":false,"description":"Start date of the loan"},{"name":"dateTo","in":"query","type":"string","required":false,"description":"End date of the loan"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"SchedulesSimResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/transactions","fullPath":"/api/v4.2.0/holdings/transactions","operationId":"getArrangementTransactionsList","name":"Retrieves the details of account transaction","summary":"Retrieves account transaction","tags":[],"parameters":[{"name":"accountId","in":"query","type":"string","required":false,"description":"Identifier of the account. Often referred to as the account number, yet for consistency this is always referred to as accountId. Accepts both IBAN & BBAN"},{"name":"customerId","in":"query","type":"string","required":false,"description":"Identifier of the customer"},{"name":"listType","in":"query","type":"string","required":true,"description":"Indicates the transaction search type"},{"name":"transactionCount","in":"query","type":"string","required":false,"description":"Indicates the total number of transactions"},{"name":"payType","in":"query","type":"string","required":false,"description":"Indicates the identifier of payment types for  letter of credit."},{"name":"dateFrom","in":"query","type":"string","required":false,"description":"Start date of the loan"},{"name":"dateTo","in":"query","type":"string","required":false,"description":"End date of the loan"},{"name":"minimumAmount","in":"query","type":"string","required":false,"description":"The minimum account balance required."},{"name":"maximumAmount","in":"query","type":"string","required":false,"description":"The maximum account balance allowed."},{"name":"displayName","in":"query","type":"string","required":false,"description":"Contains the name used for display or enrichment purposes"},{"name":"transactionCode","in":"query","type":"string","required":false,"description":"Identifies the system internal transaction code applicable to the transaction"},{"name":"entryReference","in":"query","type":"string","required":false,"description":"It is the transaction reference. This is the identifier of the transaction on Temenos Core Banking system."},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"ArrangementTransactionsListResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/customers","fullPath":"/api/v4.2.0/holdings/customers","operationId":"getArrangementHoldings","name":"Retrieves the list of customer holdings details, such as arrangement accounts, loans and deposits.","summary":"Retrieves the list of product(Current/Saving/Loan/Deposit) details","tags":[],"parameters":[{"name":"customerId","in":"query","type":"string","required":false,"description":"Identifier of the customer"},{"name":"holdingsType","in":"query","type":"string","required":false,"description":"Contains the types of customer holdings"},{"name":"holdingsId","in":"query","type":"string","required":false,"description":"Contains the identifier specific to the holding details of the customer"},{"name":"getPreferredHoldings","in":"query","type":"string","required":false,"description":"Flag to fetch the preferred holding details (JWT required)"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"ArrangementHoldingsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/arrangements/{arrangementId}/paymentSchedules","fullPath":"/api/v4.2.0/holdings/arrangements/{arrangementId}/paymentSchedules","operationId":"getPaymentSchedule","name":"Retrieves the payment schedule of an arrangement account","summary":"Retrieves the payment schedule of an arrangement account","tags":[],"parameters":[{"name":"arrangementId","in":"path","type":"string","required":true,"description":"Indicates an unique identifier of an account"},{"name":"dateFrom","in":"query","type":"string","required":false,"description":"Start date of the loan"},{"name":"dateTo","in":"query","type":"string","required":false,"description":"End date of the loan"},{"name":"simulationReference","in":"query","type":"string","required":false,"description":"Indicates the reference id for simulation activity"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"PaymentScheduleResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/arrangements/{arrangementId}/schedules/dates","fullPath":"/api/v4.2.0/holdings/arrangements/{arrangementId}/schedules/dates","operationId":"getScheduleTypeDetails","name":"Retrieves business start and end dates for each payment type defined in payment schedule condition","summary":"Retrieves business start and end dates for each payment type","tags":["RETAIL"],"parameters":[{"name":"arrangementId","in":"path","type":"string","required":true,"description":"Indicates an unique identifier of an account"},{"name":"simulationReference","in":"query","type":"string","required":false,"description":"Indicates the reference id for simulation activity"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"ScheduleTypeDetailsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}}]},{"key":"holdings-arrangements-v4.3.0","title":"Arrangement details","version":"v4.3.0","description":"API to retrieve the details of arrangement conditions such as charge, interest, limits, overdue, payment schedule, agent, alerts, and commitment. This API also allows to retrieve the pricing evaluation details, product qualification details, delivery messages, payment order, events and repayment sch","endpointCount":62,"endpoints":[{"method":"GET","path":"/holdings/arrangements/{arrangementid}/customers","fullPath":"/api/v1.0.0/holdings/arrangements/{arrangementid}/customers","operationId":"getCustomerDetail","name":"Retrieves all the customer details for the given arrangement such as customer id, customer name, customer role, their beneficiary type, limitAllocactionPercentage, glAllocationPercentage and taxLiabilityPercentage","summary":"Retrieves the customer details for the given arrangement","tags":["RETAIL"],"parameters":[{"name":"arrangementid","in":"path","type":"string","required":true,"description":""},{"name":"arrangementId","in":"query","type":"string","required":true,"description":"Indicates an unique identifier of an account"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"CustomerDetailResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse","default":"QueryErrorResponse"}},{"method":"GET","path":"/holdings/arrangements/{arrangementId}/totalDueAmount","fullPath":"/api/v1.0.0/holdings/arrangements/{arrangementId}/totalDueAmount","operationId":"getTotalAmountDueSummary","name":"Retrieves the summary of Total Amount Due for a given Arrangement id","summary":"Retrieves the summary of Total Amount Due for a given Arrangement id","tags":["RETAIL"],"parameters":[{"name":"arrangementId","in":"path","type":"string","required":true,"description":"Indicates an unique identifier of an account"},{"name":"balanceType","in":"query","type":"string","required":false,"description":"Type of balance (e.g. current balance, credit interest accrued, deferred commission, etc.) as defined in the institution's accounting schemas."},{"name":"displayZeroBals","in":"query","type":"string","required":false,"description":""},{"name":"simulationReference","in":"query","type":"string","required":false,"description":"Indicates the reference id for simulation activity"},{"name":"startDate","in":"query","type":"string","required":false,"description":"Contains the date on which the transaction or payment gets initiated."},{"name":"endDate","in":"query","type":"string","required":false,"description":"Indicates the date till which the transaction history requested. If 20120101 is the start date and 20120201 is the end date, all transactions that are booked between January 1 to February 1 2012 are r"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"TotalAmountDueSummaryResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse","default":"QueryErrorResponse"}},{"method":"GET","path":"/holdings/arrangements/{arrangementId}/charges","fullPath":"/api/v1.0.0/holdings/arrangements/{arrangementId}/charges","operationId":"getChargeDetails","name":"Retrieves the charge details of an account","summary":"Retrieves the charge details of an account","tags":[],"parameters":[{"name":"arrangementId","in":"path","type":"string","required":true,"description":"Indicates an unique identifier of an account"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"ChargeDetailsResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse","default":"QueryErrorResponse"}},{"method":"GET","path":"/holdings/arrangements/{arrangementId}/scheduleDefinitions","fullPath":"/api/v1.0.0/holdings/arrangements/{arrangementId}/scheduleDefinitions","operationId":"getScheduleDetails","name":"Retrieves the payment schedule details of an account","summary":"Retrieves the payment schedule details of an account","tags":[],"parameters":[{"name":"arrangementId","in":"path","type":"string","required":true,"description":"Indicates an unique identifier of an account"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"ScheduleDetailsResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse","default":"QueryErrorResponse"}},{"method":"GET","path":"/holdings/arrangements/{arrangementId}","fullPath":"/api/v1.0.0/holdings/arrangements/{arrangementId}","operationId":"getArrangementDetails","name":"Retrieves the details of the given arrangement such as arrangement id,account id,customer details,product details ,arrangement start date and arrangement status","summary":"Retrieves the details of an arrangement","tags":[],"parameters":[{"name":"arrangementId","in":"path","type":"string","required":true,"description":"Indicates an unique identifier of an account"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"ArrangementDetailsResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse","default":"QueryErrorResponse"}},{"method":"GET","path":"/holdings/arrangements/{arrangementId}/payoffBills","fullPath":"/api/v1.0.0/holdings/arrangements/{arrangementId}/payoffBills","operationId":"getPayoffDetails","name":"Retrieves the payoff details of an account","summary":"Retrieves the payoff details of an account","tags":["RETAIL"],"parameters":[{"name":"arrangementId","in":"path","type":"string","required":true,"description":"Identifier of the account. Often referred to as the account number, yet for consistency this is always referred to as accountId. Accepts both IBAN & BBAN"},{"name":"simulationReference","in":"query","type":"string","required":false,"description":"Indicates the reference id for simulation activity"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"","default":"","400":"","500":""}},{"method":"GET","path":"/holdings/arrangements/activities/{arrangementActivityId}/status","fullPath":"/api/v1.0.0/holdings/arrangements/activities/{arrangementActivityId}/status","operationId":"getExternalEventStatus","name":"Retrieves the status of the given activity ","summary":"Retrieves the status of the given activity ","tags":["RETAIL"],"parameters":[{"name":"arrangementActivityId","in":"path","type":"string","required":true,"description":"Contains the arrangement activity reference identifier"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"","default":"","400":"","500":""}},{"method":"GET","path":"/holdings/arrangements/{arrangementId}/interestRates","fullPath":"/api/v1.0.0/holdings/arrangements/{arrangementId}/interestRates","operationId":"getInterestDetails","name":"Retrieves the interest condition of an account","summary":"Retrieves the interest condition of an account","tags":[],"parameters":[{"name":"arrangementId","in":"path","type":"string","required":true,"description":"Indicates an unique identifier of an account"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"InterestDetailsResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse","default":"QueryErrorResponse"}},{"method":"GET","path":"/holdings/arrangements/{arrangementId}/limits","fullPath":"/api/v1.0.0/holdings/arrangements/{arrangementId}/limits","operationId":"getLimitDetails","name":"Retrieves the limit details of an arrangement account","summary":"Retrieves the limit details of an arrangement account","tags":[],"parameters":[{"name":"arrangementId","in":"path","type":"string","required":true,"description":"Indicates an unique identifier of an account"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"LimitDetailsResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse","default":"QueryErrorResponse"}},{"method":"GET","path":"/holdings/accounts/overdueStatistics","fullPath":"/api/v1.0.0/holdings/accounts/overdueStatistics","operationId":"getOverdueStatistics","name":"Retrieves the overdue details of an account","summary":"Retrieves the overdue details of an account","tags":[],"parameters":[{"name":"overdueReference","in":"query","type":"string","required":true,"description":"Indicates the overdue reference"},{"name":"overdueReference_ct","in":"query","type":"string","required":true,"description":"Indicates the criteria for the contains operation on the overdue reference"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"OverdueStatisticsResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse","default":"QueryErrorResponse"}},{"method":"GET","path":"/holdings/arrangements/{arrangementId}/repayments","fullPath":"/api/v1.0.0/holdings/arrangements/{arrangementId}/repayments","operationId":"getRepaymentDetails","name":"Retrieves the repayment details of an account based on the payment schedule","summary":"Retrieves the repayment details of an account based on the payment schedule","tags":[],"parameters":[{"name":"arrangementId","in":"path","type":"string","required":true,"description":"Indicates an unique identifier of an account"},{"name":"simulationReference","in":"query","type":"string","required":false,"description":"Indicates the reference id for simulation activity"},{"name":"dueDate","in":"query","type":"string","required":false,"description":"Identifies the date on which the activity is due."},{"name":"includeExternalFees","in":"query","type":"string","required":false,"description":"Indicates if external fee is included"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"RepaymentDetailsResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse","default":"QueryErrorResponse"}},{"method":"GET","path":"/holdings/arrangements/{arrangementId}/agents","fullPath":"/api/v1.0.0/holdings/arrangements/{arrangementId}/agents","operationId":"getAgentDetails","name":"Retrieves the agent details of an account","summary":"Retrieves the agent details of an account","tags":[],"parameters":[{"name":"arrangementId","in":"path","type":"string","required":true,"description":"Indicates an unique identifier of an account"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"AgentDetailsResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse","default":"QueryErrorResponse"}},{"method":"GET","path":"/holdings/accounts/{accountNumber}/activeAlerts","fullPath":"/api/v1.0.0/holdings/accounts/{accountNumber}/activeAlerts","operationId":"getActiveAlerts","name":"Retrieves the details of active alerts for a given account number","summary":"Retrieves the details of active alerts for a given account number","tags":[],"parameters":[{"name":"accountNumber","in":"path","type":"string","required":true,"description":"Identifier of the account. Often referred to as the account number, yet for consistency this is always referred to as accountId. Accepts both IBAN & BBAN"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"ActiveAlertsResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse","default":"QueryErrorResponse"}},{"method":"GET","path":"/holdings/accounts/{accountNumber}/historyAlerts","fullPath":"/api/v1.0.0/holdings/accounts/{accountNumber}/historyAlerts","operationId":"getHistoryAlerts","name":"Retrieves the details of history alerts for a given account number","summary":"Retrieves the details of history alerts for a given account number","tags":[],"parameters":[{"name":"accountNumber","in":"path","type":"string","required":true,"description":"Identifier of the account. Often referred to as the account number, yet for consistency this is always referred to as accountId. Accepts both IBAN & BBAN"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"HistoryAlertsResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse","default":"QueryErrorResponse"}},{"method":"GET","path":"/holdings/arrangements/{arrangementId}/annualPercentageRates","fullPath":"/api/v1.0.0/holdings/arrangements/{arrangementId}/annualPercentageRates","operationId":"getAprDetails","name":"Retrieves the annual percentage rate of an account","summary":"Retrieves the annual percentage rate of an account","tags":[],"parameters":[{"name":"arrangementId","in":"path","type":"string","required":true,"description":"Indicates an unique identifier of an account"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"AprDetailsResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse","default":"QueryErrorResponse"}},{"method":"GET","path":"/holdings/arrangements/{arrangementId}/holidayLimit","fullPath":"/api/v1.0.0/holdings/arrangements/{arrangementId}/holidayLimit","operationId":"getHolidayLimit","name":"Retrieves the details of payment holiday limit amount","summary":"Retrieves the details of payment holiday limit amount","tags":[],"parameters":[{"name":"arrangementId","in":"path","type":"string","required":true,"description":"Indicates an unique identifier of an account"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"HolidayLimitResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse","default":"QueryErrorResponse"}},{"method":"GET","path":"/holdings/arrangements/{arrangementId}/commitments","fullPath":"/api/v1.0.0/holdings/arrangements/{arrangementId}/commitments","operationId":"getCommitmentDetails","name":"Retrieves the commitment details of an account","summary":"Retrieves the commitment details of an account","tags":[],"parameters":[{"name":"arrangementId","in":"path","type":"string","required":true,"description":"Indicates an unique identifier of an account"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"CommitmentDetailsResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse","default":"QueryErrorResponse"}},{"method":"GET","path":"/holdings/arrangements/{arrangementId}/qualifiers","fullPath":"/api/v1.0.0/holdings/arrangements/{arrangementId}/qualifiers","operationId":"getProductQualifierDetails","name":"Retrieves the product qualifier details of an account","summary":"Retrieves the product qualifier details of an account","tags":[],"parameters":[{"name":"arrangementId","in":"path","type":"string","required":true,"description":"Indicates an unique identifier of an account"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"ProductQualifierDetailsResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse","default":"QueryErrorResponse"}},{"method":"GET","path":"/holdings/arrangements/{arrangementId}/evaluations","fullPath":"/api/v1.0.0/holdings/arrangements/{arrangementId}/evaluations","operationId":"getEvaluationDetails","name":"Retrieves the pricing evaluation details of an account.","summary":"Retrieves the pricing evaluation details of an account","tags":[],"parameters":[{"name":"arrangementId","in":"path","type":"string","required":true,"description":"Indicates an unique identifier of an account"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"EvaluationDetailsResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse","default":"QueryErrorResponse"}},{"method":"GET","path":"/holdings/accounts/{arrangementId}/dates","fullPath":"/api/v1.0.0/holdings/accounts/{arrangementId}/dates","operationId":"getArrangementDates","name":"Retrieves the key dates of an account","summary":"Retrieves the key dates of an account","tags":[],"parameters":[{"name":"arrangementId","in":"path","type":"string","required":true,"description":"Indicates an unique identifier of an account"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"ArrangementDatesResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse","default":"QueryErrorResponse"}},{"method":"GET","path":"/holdings/arrangements/{arrangementId}/interestAccruals","fullPath":"/api/v1.0.0/holdings/arrangements/{arrangementId}/interestAccruals","operationId":"getInterestDetailsCurrent","name":"Retrieves the interest accrued for the current period of an account","summary":"Retrieves the interest accrued for the current period of an account","tags":[],"parameters":[{"name":"arrangementId","in":"path","type":"string","required":true,"description":"Indicates an unique identifier of an account"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"InterestDetailsCurrentResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse","default":"QueryErrorResponse"}},{"method":"GET","path":"/holdings/arrangements/{arrangementId}/historicInterestAccruals","fullPath":"/api/v1.0.0/holdings/arrangements/{arrangementId}/historicInterestAccruals","operationId":"getInterestDetailsPrevious","name":"Retrieve the past period's interest accruals","summary":"Retrieve the past period's interest accruals","tags":[],"parameters":[{"name":"arrangementId","in":"path","type":"string","required":true,"description":"Indicates an unique identifier of an account"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"InterestDetailsPreviousResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse","default":"QueryErrorResponse"}},{"method":"GET","path":"/holdings/arrangements/{arrangementId}/yearToDateInterestAccruals","fullPath":"/api/v1.0.0/holdings/arrangements/{arrangementId}/yearToDateInterestAccruals","operationId":"getInterestDetailsYearToDate","name":"Retrieves the interest accruals of the previous year","summary":"Retrieves the interest accruals of the previous year","tags":[],"parameters":[{"name":"arrangementId","in":"path","type":"string","required":true,"description":"Indicates an unique identifier of an account"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"InterestDetailsYearToDateResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse","default":"QueryErrorResponse"}},{"method":"GET","path":"/holdings/accounts/{arrangementId}/messages","fullPath":"/api/v1.0.0/holdings/accounts/{arrangementId}/messages","operationId":"getDeliveryMessages","name":"Retrieves the details of delivery messages for a given arrangement Id","summary":"Retrieves the details of delivery messages for a given arrangement Id","tags":[],"parameters":[{"name":"arrangementId","in":"path","type":"string","required":true,"description":"Indicates an unique identifier of an account"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"DeliveryMessagesResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse","default":"QueryErrorResponse"}},{"method":"GET","path":"/holdings/accounts/{arrangementId}/historyMessages","fullPath":"/api/v1.0.0/holdings/accounts/{arrangementId}/historyMessages","operationId":"getDeliveryMessagesHistory","name":"Retrieves the details of history delivery messages for a given arrangement Id","summary":"Retrieves the details of history delivery messages for a given arrangement Id","tags":[],"parameters":[{"name":"arrangementId","in":"path","type":"string","required":true,"description":"Indicates an unique identifier of an account"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"DeliveryMessagesHistoryResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse","default":"QueryErrorResponse"}},{"method":"GET","path":"/holdings/arrangements/{arrangementId}/stmtEntries","fullPath":"/api/v1.0.0/holdings/arrangements/{arrangementId}/stmtEntries","operationId":"getStmtEntries","name":"Retrieves the statement entries of an arrangement account","summary":"Retrieves the statement entries of an arrangement account","tags":[],"parameters":[{"name":"arrangementId","in":"path","type":"string","required":true,"description":"Indicates an unique identifier of an account"},{"name":"valueDate","in":"query","type":"string","required":false,"description":"Indicates the value date on which the underlying accounting entry is to be given value (for interest purposes)"},{"name":"stmtFlag","in":"query","type":"string","required":false,"description":""},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"StmtEntriesResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse","default":"QueryErrorResponse"}},{"method":"GET","path":"/holdings/arrangements/{arrangementId}/dataEvents","fullPath":"/api/v1.0.0/holdings/arrangements/{arrangementId}/dataEvents","operationId":"getArrangementPropertyConditions","name":"Retrieves the property conditions to the data events","summary":"Retrieves the property conditions","tags":[],"parameters":[{"name":"arrangementId","in":"path","type":"string","required":true,"description":"Indicates an unique identifier of an account"},{"name":"status","in":"query","type":"string","required":true,"description":"Contains status of the data rights request.Allowed values are INITIATED, INPROGESS, EXTENDED, COMPLETED, REJECTED."},{"name":"arrangementActivityId","in":"query","type":"string","required":false,"description":"Contains the arrangement activity reference identifier"},{"name":"effectiveDate","in":"query","type":"string","required":false,"description":"Contains the identifier for the transaction date. Dates are expected in \u00e2\u20ac\u02dcYYYYMMDD\u00e2\u20ac\u2122 format"},{"name":"property","in":"query","type":"string","required":false,"description":"Id of the product property"},{"name":"dataEvent","in":"query","type":"string","required":false,"description":"Indicates the data event flag"},{"name":"ofsSource","in":"query","type":"string","required":false,"description":"Indicates the source of the OFS"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"ArrangementPropertyConditionsResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse","default":"QueryErrorResponse"}},{"method":"GET","path":"/holdings/arrangements/{arrangementId}/schedules","fullPath":"/api/v1.0.0/holdings/arrangements/{arrangementId}/schedules","operationId":"getSchedulesFull","name":"Retrieves the repayment schedule details for an arrangement","summary":"Retrieves the repayment schedule details for an arrangement","tags":[],"parameters":[{"name":"arrangementId","in":"path","type":"string","required":true,"description":"Indicates an unique identifier of an account"},{"name":"simulationReference","in":"query","type":"string","required":false,"description":"Indicates the reference id for simulation activity"},{"name":"dateFrom","in":"query","type":"string","required":false,"description":"Start date of the loan"},{"name":"dateTo","in":"query","type":"string","required":false,"description":"End date of the loan"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"SchedulesFullResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse","default":"QueryErrorResponse"}},{"method":"GET","path":"/holdings/arrangements/{arrangementActivityId}/simulationReferences","fullPath":"/api/v1.0.0/holdings/arrangements/{arrangementActivityId}/simulationReferences","operationId":"getSimulationReference","name":"Retrieves the simulation reference for the given arrangement activity id","summary":"Retrieves the simulation reference for the given arrangement activity id","tags":[],"parameters":[{"name":"arrangementActivityId","in":"path","type":"string","required":true,"description":"Contains the arrangement activity reference identifier"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"SimulationReferenceResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse","default":"QueryErrorResponse"}},{"method":"GET","path":"/holdings/arrangement/{arrangementId}/alerts","fullPath":"/api/v1.0.0/holdings/arrangement/{arrangementId}/alerts","operationId":"getArrangementAlerts","name":"Retrieves the list of alerts applicable for an arrangement","summary":"Retrieves the list of alerts applicable for an arrangement","tags":[],"parameters":[{"name":"arrangementId","in":"path","type":"string","required":true,"description":"Indicates an unique identifier of an account"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"ArrangementAlertsResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse","default":"QueryErrorResponse"}},{"method":"GET","path":"/holdings/arrangements/{arrangementId}/simulations","fullPath":"/api/v1.0.0/holdings/arrangements/{arrangementId}/simulations","operationId":"getSimulationDetails","name":"Retrieves the simulated activity details of an account","summary":"Retrieves the simulated activity details of an account","tags":[],"parameters":[{"name":"arrangementId","in":"path","type":"string","required":true,"description":"Indicates an unique identifier of an account"},{"name":"simulationCaptureReferenceId","in":"query","type":"string","required":false,"description":"Indicates the Reference Id for the simulation activity"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"SimulationDetailsResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse","default":"QueryErrorResponse"}},{"method":"GET","path":"/holdings/customers/{customerId}/arrangements","fullPath":"/api/v1.0.0/holdings/customers/{customerId}/arrangements","operationId":"getCustomerArrangementDetails","name":"Retrieves the list of arrangement ids for a given customer","summary":"Retrieves the list of arrangement ids for a given customer","tags":[],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"Identifier of the customer"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"CustomerArrangementDetailsResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse","default":"QueryErrorResponse"}},{"method":"GET","path":"/holdings/arrangements/{arrangementId}/chargeOffBalances","fullPath":"/api/v1.0.0/holdings/arrangements/{arrangementId}/chargeOffBalances","operationId":"getChargeOffDetails","name":"Retrieves the charge off balances of an arrangement account","summary":"Retrieves the charge off balances of an arrangement account","tags":[],"parameters":[{"name":"arrangementId","in":"path","type":"string","required":true,"description":"Indicates an unique identifier of an account"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"ChargeOffDetailsResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse","default":"QueryErrorResponse"}},{"method":"GET","path":"/holdings/arrangements/{arrangementId}/consolidatedBalances","fullPath":"/api/v1.0.0/holdings/arrangements/{arrangementId}/consolidatedBalances","operationId":"getVirtualBalances","name":"Retrieves the virtual balances for a balance type of an account","summary":"Retrieves the virtual balances for a balance type of an account","tags":[],"parameters":[{"name":"arrangementId","in":"path","type":"string","required":true,"description":"Indicates an unique identifier of an account"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"VirtualBalancesResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse","default":"QueryErrorResponse"}},{"method":"GET","path":"/holdings/arrangements/{arrangementId}/activities","fullPath":"/api/v1.0.0/holdings/arrangements/{arrangementId}/activities","operationId":"getArrangementActivityLog","name":"Retrieves the activity log of an account","summary":"Retrieves the activity log of an account","tags":[],"parameters":[{"name":"arrangementId","in":"path","type":"string","required":true,"description":"Indicates an unique identifier of an account"},{"name":"simulation","in":"query","type":"string","required":false,"description":"What if scenario reference"},{"name":"startDate","in":"query","type":"string","required":false,"description":"Contains the date on which the transaction or payment gets initiated."},{"name":"endDate","in":"query","type":"string","required":false,"description":"Indicates the date till which the transaction history requested. If 20120101 is the start date and 20120201 is the end date, all transactions that are booked between January 1 to February 1 2012 are r"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"ArrangementActivityLogResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse","default":"QueryErrorResponse"}},{"method":"GET","path":"/holdings/arrangements/{arrangementId}/financialActivities","fullPath":"/api/v1.0.0/holdings/arrangements/{arrangementId}/financialActivities","operationId":"getFinancialActivities","name":"Retrieves the financial activity log of an account","summary":"Retrieves the financial activity log of an account","tags":[],"parameters":[{"name":"arrangementId","in":"path","type":"string","required":true,"description":"Indicates an unique identifier of an account"},{"name":"simulationReference","in":"query","type":"string","required":false,"description":"Indicates the reference id for simulation activity"},{"name":"startDate","in":"query","type":"string","required":false,"description":"Contains the date on which the transaction or payment gets initiated."},{"name":"endDate","in":"query","type":"string","required":false,"description":"Indicates the date till which the transaction history requested. If 20120101 is the start date and 20120201 is the end date, all transactions that are booked between January 1 to February 1 2012 are r"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"FinancialActivitiesResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse","default":"QueryErrorResponse"}},{"method":"GET","path":"/holdings/arrangements/{arrangementId}/userActivities","fullPath":"/api/v1.0.0/holdings/arrangements/{arrangementId}/userActivities","operationId":"getUserActivities","name":"Lists the user related activity logs of an account","summary":"Lists the user related activity logs of an account","tags":[],"parameters":[{"name":"arrangementId","in":"path","type":"string","required":true,"description":"Indicates an unique identifier of an account"},{"name":"simulationReference","in":"query","type":"string","required":false,"description":"Indicates the reference id for simulation activity"},{"name":"startDate","in":"query","type":"string","required":false,"description":"Contains the date on which the transaction or payment gets initiated."},{"name":"endDate","in":"query","type":"string","required":false,"description":"Indicates the date till which the transaction history requested. If 20120101 is the start date and 20120201 is the end date, all transactions that are booked between January 1 to February 1 2012 are r"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"UserActivitiesResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse","default":"QueryErrorResponse"}},{"method":"GET","path":"/holdings/arrangements/{arrangementId}/systemActivities","fullPath":"/api/v1.0.0/holdings/arrangements/{arrangementId}/systemActivities","operationId":"getSystemActivities","name":"Retrieves the system activities of an account","summary":"Retrieves the system activities of an account","tags":[],"parameters":[{"name":"arrangementId","in":"path","type":"string","required":true,"description":"Indicates an unique identifier of an account"},{"name":"simulationReference","in":"query","type":"string","required":false,"description":"Indicates the reference id for simulation activity"},{"name":"startDate","in":"query","type":"string","required":false,"description":"Contains the date on which the transaction or payment gets initiated."},{"name":"endDate","in":"query","type":"string","required":false,"description":"Indicates the date till which the transaction history requested. If 20120101 is the start date and 20120201 is the end date, all transactions that are booked between January 1 to February 1 2012 are r"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"SystemActivitiesResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse","default":"QueryErrorResponse"}},{"method":"GET","path":"/holdings/arrangements/{arrangementId}/holdActivities","fullPath":"/api/v1.0.0/holdings/arrangements/{arrangementId}/holdActivities","operationId":"getHoldActivities","name":"Retrieves the log of an activity in hold of an account","summary":"Retrieves the log of an activity in hold of an account","tags":[],"parameters":[{"name":"arrangementId","in":"path","type":"string","required":true,"description":"Indicates an unique identifier of an account"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"HoldActivitiesResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse","default":"QueryErrorResponse"}},{"method":"GET","path":"/holdings/arrangements/{arrangementId}/archievedActivities","fullPath":"/api/v1.0.0/holdings/arrangements/{arrangementId}/archievedActivities","operationId":"getArchievedActivities","name":"Retrieves the archived activity log of an account","summary":"Retrieves the archived activity log of an account","tags":[],"parameters":[{"name":"arrangementId","in":"path","type":"string","required":true,"description":"Indicates an unique identifier of an account"},{"name":"simulationReference","in":"query","type":"string","required":false,"description":"Indicates the reference id for simulation activity"},{"name":"startDate","in":"query","type":"string","required":false,"description":"Contains the date on which the transaction or payment gets initiated."},{"name":"endDate","in":"query","type":"string","required":false,"description":"Indicates the date till which the transaction history requested. If 20120101 is the start date and 20120201 is the end date, all transactions that are booked between January 1 to February 1 2012 are r"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"ArchievedActivitiesResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse","default":"QueryErrorResponse"}},{"method":"GET","path":"/holdings/arrangements/{arrangementId}/transactions","fullPath":"/api/v1.0.0/holdings/arrangements/{arrangementId}/transactions","operationId":"getAccountSummary","name":"Retrieves the transaction list for a given account number","summary":"Retrieves the transaction list for a given account number","tags":[],"parameters":[{"name":"arrangementId","in":"path","type":"string","required":true,"description":"Indicates an unique identifier of an account"},{"name":"startDate","in":"query","type":"string","required":false,"description":"Contains the date on which the transaction or payment gets initiated."},{"name":"endDate","in":"query","type":"string","required":false,"description":"Indicates the date till which the transaction history requested. If 20120101 is the start date and 20120201 is the end date, all transactions that are booked between January 1 to February 1 2012 are r"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"AccountSummaryResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse","default":"QueryErrorResponse"}},{"method":"GET","path":"/holdings/arrangements/{arrangementId}/eligibileActivities","fullPath":"/api/v1.0.0/holdings/arrangements/{arrangementId}/eligibileActivities","operationId":"getArrangementActivities","name":"Retrieves the list of activities applicable for an arrangement account","summary":"Retrieves the list of activities applicable for an arrangement account","tags":[],"parameters":[{"name":"arrangementId","in":"path","type":"string","required":true,"description":"Indicates an unique identifier of an account"},{"name":"activityId","in":"query","type":"string","required":false,"description":"Id of the activity, e.g. ACCOUNTS-CAPITALISE-ACCHARGE*CARDISSUEFEE"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"ArrangementActivitiesResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse","default":"QueryErrorResponse"}},{"method":"GET","path":"/holdings/arrangements/unapprovedArrangementActivites","fullPath":"/api/v1.0.0/holdings/arrangements/unapprovedArrangementActivites","operationId":"getUnauthorisedAAA","name":"Retrieves the list of unauthorised activities of an account","summary":"Retrieves the list of unauthorised activities of an account","tags":[],"parameters":[{"name":"customerId","in":"query","type":"string","required":false,"description":"Identifier of the customer"},{"name":"activity","in":"query","type":"string","required":false,"description":"Defines the activity to be processed against the Arrangement. The activity may be a user activity or a system generated activity."},{"name":"arrangementId","in":"query","type":"string","required":false,"description":"Indicates an unique identifier of an account"},{"name":"product","in":"query","type":"string","required":false,"description":"Contains the name of the product"},{"name":"currency","in":"query","type":"string","required":false,"description":"Identifies the currency. E.g. USD, GBP etc"},{"name":"contractId","in":"query","type":"string","required":false,"description":"Indicates the unique identifier of the transaction or contract which initiated the activity"},{"name":"transactionAmount","in":"query","type":"string","required":false,"description":"Contains the transaction amount. This is based on the currency, either local or foreign currency"},{"name":"transactionAmountLocalCurrency","in":"query","type":"string","required":false,"description":"Indicates the transaction amount in local currency"},{"name":"applicationId","in":"query","type":"string","required":false,"description":"Contains the application id of the service that has crashed due to error."},{"name":"inputter","in":"query","type":"string","required":false,"description":"The user identifier who input the transaction"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"UnauthorisedAAAResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse","default":"QueryErrorResponse"}},{"method":"GET","path":"/holdings/arrangements/{arrangementId}/bundles","fullPath":"/api/v1.0.0/holdings/arrangements/{arrangementId}/bundles","operationId":"getLinktArrDetails","name":"Retrieves the link arrangement details of an account","summary":"Retrieves the link arrangement details of an account","tags":[],"parameters":[{"name":"arrangementId","in":"path","type":"string","required":true,"description":"Indicates an unique identifier of an account"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"LinktArrDetailsResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse","default":"QueryErrorResponse"}},{"method":"GET","path":"/holdings/arrangements/{arrangementId}/documents","fullPath":"/api/v1.0.0/holdings/arrangements/{arrangementId}/documents","operationId":"getTransactionDocuments","name":"Retrieves the transaction document details of a given arrangement account","summary":"Retrieves the transaction document details of a given arrangement account","tags":[],"parameters":[{"name":"arrangementId","in":"path","type":"string","required":true,"description":"Indicates an unique identifier of an account"},{"name":"transactionReference","in":"query","type":"string","required":false,"description":"Contains the identifier for the transaction in the core system"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"TransactionDocumentsResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse","default":"QueryErrorResponse"}},{"method":"GET","path":"/holdings/arrangements/{arrangementId}/balances","fullPath":"/api/v1.0.0/holdings/arrangements/{arrangementId}/balances","operationId":"getArrangementBalances","name":"Retrieves the balance details for a given arrangement","summary":"Retrieves the working ,ledger and cleared balances for an arrangement","tags":[],"parameters":[{"name":"arrangementId","in":"path","type":"string","required":true,"description":""},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"ArrangementBalancesResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse","default":"QueryErrorResponse"}},{"method":"DELETE","path":"/holdings/arrangementActivityId/{activityId}","fullPath":"/api/v1.0.0/holdings/arrangementActivityId/{activityId}","operationId":"reverseAccounts","name":"Deletes an arrangement on which no transactions are  posted","summary":"Deletes an arrangement on which no transactions are  posted","tags":[],"parameters":[{"name":"activityId","in":"path","type":"string","required":true,"description":""},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"reverseAccountsResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse","default":"ArrangementErrorResponse"}},{"method":"GET","path":"/holdings/arrangements/{arrangementId}/bills","fullPath":"/api/v1.0.0/holdings/arrangements/{arrangementId}/bills","operationId":"getAllBills","name":"Retrieves the details of all the types of bills","summary":"Retrieves the details of all the types of bills","tags":[],"parameters":[{"name":"arrangementId","in":"path","type":"string","required":true,"description":"Indicates an unique identifier of an account"},{"name":"fileVersion","in":"query","type":"string","required":false,"description":"Indicates if the file is of type simulation or live"},{"name":"simulationReference","in":"query","type":"string","required":false,"description":"Indicates the reference id for simulation activity"},{"name":"paymentDate","in":"query","type":"string","required":false,"description":"Contains the date in which the payment will be sent out.\u00c2\u00a0Date in the format YYYYMMDD. E.g. 20191231"},{"name":"deferDate","in":"query","type":"string","required":false,"description":"Date that the payment has been deferred to"},{"name":"billedAmount","in":"query","type":"string","required":false,"description":"Indicates the bill amount"},{"name":"outstandingAmount","in":"query","type":"string","required":false,"description":"Contains the aggregate outstanding principal amount thereof after giving effect to any borrowings and prepayments or repayments of Committed Loans"},{"name":"delinquentAmount","in":"query","type":"string","required":false,"description":"Indicates the bill amount during the ageing status(Bill which crossed the due date)"},{"name":"property","in":"query","type":"string","required":false,"description":"Id of the product property"},{"name":"billStatus","in":"query","type":"string","required":false,"description":"Indicates the status of a bill(Issued,Due,Ageing,Settled)"},{"name":"settlementStatus","in":"query","type":"string","required":false,"description":"Defines the status of the settlement for the incoming MT548 swift message.The values allowed are: Waiting : pending to receive settlement status update meaning pending to receive MT548 swift message, "},{"name":"agingStatus","in":"query","type":"string","required":false,"description":"Indicates the ageing status of a bill"},{"name":"settled","in":"query","type":"string","required":false,"description":"Flag to indicate whether a bill is settled or not"},{"name":"paymentType","in":"query","type":"string","required":false,"description":"Indicates if the payment is Customer (C) type or Bank (B) type"},{"name":"billDate","in":"query","type":"string","required":false,"description":"Indicates a date on which a bill has been raised"},{"name":"billType","in":"query","type":"string","required":false,"description":"The type of payment obligation generated"},{"name":"paymentMethod","in":"query","type":"string","required":false,"description":"Method chosen to make the payment"},{"name":"infoPayType","in":"query","type":"string","required":false,"description":"Indicates a bill which is raised when a loan is paid off"},{"name":"advancePayment","in":"query","type":"string","required":false,"description":"Indicates whether advance payment made is set on an account"},{"name":"paymentIndicator","in":"query","type":"string","required":false,"description":"Indicates whether its a credit/debit type of bill"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"AllBillsResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse","default":"QueryErrorResponse"}},{"method":"GET","path":"/holdings/arrangements/{arrangementId}/outstandingBills","fullPath":"/api/v1.0.0/holdings/arrangements/{arrangementId}/outstandingBills","operationId":"getOutstandingBills","name":"Retrieves the outstanding amount to be paid for an account","summary":"Retrieves the outstanding amount to be paid for an account","tags":[],"parameters":[{"name":"arrangementId","in":"path","type":"string","required":true,"description":"Indicates an unique identifier of an account"},{"name":"fileVersion","in":"query","type":"string","required":false,"description":"Indicates if the file is of type simulation or live"},{"name":"simulationReference","in":"query","type":"string","required":false,"description":"Indicates the reference id for simulation activity"},{"name":"paymentDate","in":"query","type":"string","required":false,"description":"Contains the date in which the payment will be sent out.\u00c2\u00a0Date in the format YYYYMMDD. E.g. 20191231"},{"name":"deferDate","in":"query","type":"string","required":false,"description":"Date that the payment has been deferred to"},{"name":"billedAmount","in":"query","type":"string","required":false,"description":"Indicates the bill amount"},{"name":"outstandingAmount","in":"query","type":"string","required":false,"description":"Contains the aggregate outstanding principal amount thereof after giving effect to any borrowings and prepayments or repayments of Committed Loans"},{"name":"delinquentAmount","in":"query","type":"string","required":false,"description":"Indicates the bill amount during the ageing status(Bill which crossed the due date)"},{"name":"property","in":"query","type":"string","required":false,"description":"Id of the product property"},{"name":"billStatus","in":"query","type":"string","required":false,"description":"Indicates the status of a bill(Issued,Due,Ageing,Settled)"},{"name":"settlementStatus","in":"query","type":"string","required":false,"description":"Defines the status of the settlement for the incoming MT548 swift message.The values allowed are: Waiting : pending to receive settlement status update meaning pending to receive MT548 swift message, "},{"name":"agingStatus","in":"query","type":"string","required":false,"description":"Indicates the ageing status of a bill"},{"name":"settled","in":"query","type":"string","required":false,"description":"Flag to indicate whether a bill is settled or not"},{"name":"paymentType","in":"query","type":"string","required":false,"description":"Indicates if the payment is Customer (C) type or Bank (B) type"},{"name":"billDate","in":"query","type":"string","required":false,"description":"Indicates a date on which a bill has been raised"},{"name":"billType","in":"query","type":"string","required":false,"description":"The type of payment obligation generated"},{"name":"paymentMethod","in":"query","type":"string","required":false,"description":"Method chosen to make the payment"},{"name":"infoPayType","in":"query","type":"string","required":false,"description":"Indicates a bill which is raised when a loan is paid off"},{"name":"advancePayment","in":"query","type":"string","required":false,"description":"Indicates whether advance payment made is set on an account"},{"name":"paymentIndicator","in":"query","type":"string","required":false,"description":"Indicates whether its a credit/debit type of bill"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"OutstandingBillsResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse","default":"QueryErrorResponse"}},{"method":"GET","path":"/holdings/arrangements/{arrangementId}/deferredBills","fullPath":"/api/v1.0.0/holdings/arrangements/{arrangementId}/deferredBills","operationId":"getDeferredBills","name":"Retrieves the details of the deferred bills","summary":"Retrieves the details of the deferred bills","tags":[],"parameters":[{"name":"arrangementId","in":"path","type":"string","required":true,"description":"Indicates an unique identifier of an account"},{"name":"fileVersion","in":"query","type":"string","required":false,"description":"Indicates if the file is of type simulation or live"},{"name":"simulationReference","in":"query","type":"string","required":false,"description":"Indicates the reference id for simulation activity"},{"name":"paymentDate","in":"query","type":"string","required":false,"description":"Contains the date in which the payment will be sent out.\u00c2\u00a0Date in the format YYYYMMDD. E.g. 20191231"},{"name":"deferDate","in":"query","type":"string","required":false,"description":"Date that the payment has been deferred to"},{"name":"billedAmount","in":"query","type":"string","required":false,"description":"Indicates the bill amount"},{"name":"outstandingAmount","in":"query","type":"string","required":false,"description":"Contains the aggregate outstanding principal amount thereof after giving effect to any borrowings and prepayments or repayments of Committed Loans"},{"name":"delinquentAmount","in":"query","type":"string","required":false,"description":"Indicates the bill amount during the ageing status(Bill which crossed the due date)"},{"name":"property","in":"query","type":"string","required":false,"description":"Id of the product property"},{"name":"billStatus","in":"query","type":"string","required":false,"description":"Indicates the status of a bill(Issued,Due,Ageing,Settled)"},{"name":"settlementStatus","in":"query","type":"string","required":false,"description":"Defines the status of the settlement for the incoming MT548 swift message.The values allowed are: Waiting : pending to receive settlement status update meaning pending to receive MT548 swift message, "},{"name":"agingStatus","in":"query","type":"string","required":false,"description":"Indicates the ageing status of a bill"},{"name":"paymentType","in":"query","type":"string","required":false,"description":"Indicates if the payment is Customer (C) type or Bank (B) type"},{"name":"billDate","in":"query","type":"string","required":false,"description":"Indicates a date on which a bill has been raised"},{"name":"billType","in":"query","type":"string","required":false,"description":"The type of payment obligation generated"},{"name":"paymentMethod","in":"query","type":"string","required":false,"description":"Method chosen to make the payment"},{"name":"infoPayType","in":"query","type":"string","required":false,"description":"Indicates a bill which is raised when a loan is paid off"},{"name":"advancePayment","in":"query","type":"string","required":false,"description":"Indicates whether advance payment made is set on an account"},{"name":"paymentIndicator","in":"query","type":"string","required":false,"description":"Indicates whether its a credit/debit type of bill"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"DeferredBillsResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse","default":"QueryErrorResponse"}},{"method":"GET","path":"/holdings/arrangements/{arrangementId}/externalBills","fullPath":"/api/v1.0.0/holdings/arrangements/{arrangementId}/externalBills","operationId":"getExternalBills","name":"Retrieves the details of the external type of bills","summary":"Retrieves the details of the external type of bills","tags":[],"parameters":[{"name":"arrangementId","in":"path","type":"string","required":true,"description":"Indicates an unique identifier of an account"},{"name":"simulationReference","in":"query","type":"string","required":false,"description":"Indicates the reference id for simulation activity"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"ExternalBillsResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse","default":"QueryErrorResponse"}},{"method":"GET","path":"/holdings/arrangements/{arrangementId}/advanceBills","fullPath":"/api/v1.0.0/holdings/arrangements/{arrangementId}/advanceBills","operationId":"getAdvanceBills","name":"Retrieves the details of the advance bills","summary":"Retrieves the details of the advance bills","tags":[],"parameters":[{"name":"arrangementId","in":"path","type":"string","required":true,"description":"Indicates an unique identifier of an account"},{"name":"billStatus","in":"query","type":"string","required":false,"description":"Indicates the status of a bill(Issued,Due,Ageing,Settled)"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"AdvanceBillsResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse","default":"QueryErrorResponse"}},{"method":"GET","path":"/holdings/arrangements/{arrangementId}/writeOffBills","fullPath":"/api/v1.0.0/holdings/arrangements/{arrangementId}/writeOffBills","operationId":"getWriteoffBills","name":"Retrieves the details of the write off bills","summary":"Retrieves the details of the write off bills","tags":[],"parameters":[{"name":"arrangementId","in":"path","type":"string","required":true,"description":"Indicates an unique identifier of an account"},{"name":"billStatus","in":"query","type":"string","required":true,"description":"Indicates the status of a bill(Issued,Due,Ageing,Settled)"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"WriteoffBillsResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse","default":"QueryErrorResponse"}},{"method":"GET","path":"/holdings/arrangements/writeOff/{arrangementId}/activities","fullPath":"/api/v1.0.0/holdings/arrangements/writeOff/{arrangementId}/activities","operationId":"getWriteOffActivitiesDetails","name":"Retrieves the details of write off bills based on activities","summary":"Retrieves the details of write off bills based on activities","tags":[],"parameters":[{"name":"arrangementId","in":"path","type":"string","required":true,"description":"Indicates an unique identifier of an account"},{"name":"fileVersion","in":"query","type":"string","required":false,"description":"Indicates if the file is of type simulation or live"},{"name":"simulationReference","in":"query","type":"string","required":false,"description":"Indicates the reference id for simulation activity"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"WriteOffActivitiesDetailsResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse","default":"QueryErrorResponse"}},{"method":"GET","path":"/holdings/arrangements/{arrangementId}/settlements","fullPath":"/api/v1.0.0/holdings/arrangements/{arrangementId}/settlements","operationId":"getSettlementDetails","name":"Retrieves the settlement details for the given arrangement such as payment type, payin account, payin percentage, payin amount, payout account, payout percentage, payout amount, etc","summary":"Retrieves settlement details for the given arrangement","tags":["RETAIL"],"parameters":[{"name":"arrangementId","in":"path","type":"string","required":true,"description":"Indicates an unique identifier of an account"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"SettlementDetailsResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse","default":"QueryErrorResponse"}},{"method":"GET","path":"/holdings/arrangements/{arrangementId}/paymentHolidays","fullPath":"/api/v1.0.0/holdings/arrangements/{arrangementId}/paymentHolidays","operationId":"getPaymentHoliday","name":"Retrieves payment holiday details for the given arrangement such as payment type, holiday date, original payment amount and new payment amount","summary":"Retrieves payment holiday details for the given arrangement","tags":["RETAIL"],"parameters":[{"name":"arrangementId","in":"path","type":"string","required":true,"description":"Indicates an unique identifier of an account"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"PaymentHolidayResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse","default":"QueryErrorResponse"}},{"method":"GET","path":"/holdings/arrangements/simulations/{simulationId}/schedules","fullPath":"/api/v1.0.0/holdings/arrangements/simulations/{simulationId}/schedules","operationId":"getSchedulesSim","name":"Retrieves the repayment schedule details for an arrangement with simulation reference number","summary":"Retrieves the repayment schedule details for an arrangement with simulation reference number","tags":["RETAIL"],"parameters":[{"name":"simulationId","in":"path","type":"string","required":true,"description":"Indicates the Id generated during the simulation of an activity"},{"name":"arrangementId","in":"query","type":"string","required":false,"description":"Indicates an unique identifier of an account"},{"name":"dateFrom","in":"query","type":"string","required":false,"description":"Start date of the loan"},{"name":"dateTo","in":"query","type":"string","required":false,"description":"End date of the loan"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"SchedulesSimResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse","default":"QueryErrorResponse"}},{"method":"GET","path":"/holdings/transactions","fullPath":"/api/v1.0.0/holdings/transactions","operationId":"getArrangementTransactionsList","name":"Retrieves the details of account transaction","summary":"Retrieves account transaction","tags":[],"parameters":[{"name":"accountId","in":"query","type":"string","required":false,"description":"Identifier of the account. Often referred to as the account number, yet for consistency this is always referred to as accountId. Accepts both IBAN & BBAN"},{"name":"customerId","in":"query","type":"string","required":false,"description":"Identifier of the customer"},{"name":"listType","in":"query","type":"string","required":true,"description":"Indicates the transaction search type"},{"name":"transactionCount","in":"query","type":"string","required":false,"description":"Indicates the total number of transactions"},{"name":"payType","in":"query","type":"string","required":false,"description":"Indicates the identifier of payment types for  letter of credit."},{"name":"dateFrom","in":"query","type":"string","required":false,"description":"Start date of the loan"},{"name":"dateTo","in":"query","type":"string","required":false,"description":"End date of the loan"},{"name":"minimumAmount","in":"query","type":"string","required":false,"description":"The minimum account balance required."},{"name":"maximumAmount","in":"query","type":"string","required":false,"description":"The maximum account balance allowed."},{"name":"displayName","in":"query","type":"string","required":false,"description":"Contains the name used for display or enrichment purposes"},{"name":"transactionCode","in":"query","type":"string","required":false,"description":"Identifies the system internal transaction code applicable to the transaction"},{"name":"entryReference","in":"query","type":"string","required":false,"description":"It is the transaction reference. This is the identifier of the transaction on Temenos Core Banking system."},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"ArrangementTransactionsListResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse","default":"QueryErrorResponse"}},{"method":"GET","path":"/holdings/customers","fullPath":"/api/v1.0.0/holdings/customers","operationId":"getArrangementHoldings","name":"Retrieves the list of customer holdings details, such as arrangement accounts, loans and deposits.","summary":"Retrieves the list of product(Current/Saving/Loan/Deposit) details","tags":[],"parameters":[{"name":"customerId","in":"query","type":"string","required":false,"description":"Identifier of the customer"},{"name":"holdingsType","in":"query","type":"string","required":false,"description":"Contains the types of customer holdings"},{"name":"holdingsId","in":"query","type":"string","required":false,"description":"Contains the identifier specific to the holding details of the customer"},{"name":"getPreferredHoldings","in":"query","type":"string","required":false,"description":"Flag to fetch the preferred holding details (JWT required)"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"ArrangementHoldingsResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse","default":"QueryErrorResponse"}},{"method":"GET","path":"/holdings/arrangements/{arrangementId}/paymentSchedules","fullPath":"/api/v1.0.0/holdings/arrangements/{arrangementId}/paymentSchedules","operationId":"getPaymentSchedule","name":"Retrieves the payment schedule of an arrangement account","summary":"Retrieves the payment schedule of an arrangement account","tags":[],"parameters":[{"name":"arrangementId","in":"path","type":"string","required":true,"description":"Indicates an unique identifier of an account"},{"name":"dateFrom","in":"query","type":"string","required":false,"description":"Start date of the loan"},{"name":"dateTo","in":"query","type":"string","required":false,"description":"End date of the loan"},{"name":"simulationReference","in":"query","type":"string","required":false,"description":"Indicates the reference id for simulation activity"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"PaymentScheduleResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse","default":"QueryErrorResponse"}},{"method":"GET","path":"/holdings/arrangements/{arrangementId}/schedules/dates","fullPath":"/api/v1.0.0/holdings/arrangements/{arrangementId}/schedules/dates","operationId":"getScheduleTypeDetails","name":"Retrieves business start and end dates for each payment type defined in payment schedule condition","summary":"Retrieves business start and end dates for each payment type","tags":["RETAIL"],"parameters":[{"name":"arrangementId","in":"path","type":"string","required":true,"description":"Indicates an unique identifier of an account"},{"name":"simulationReference","in":"query","type":"string","required":false,"description":"Indicates the reference id for simulation activity"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"ScheduleTypeDetailsResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse","default":"QueryErrorResponse"}},{"method":"GET","path":"/holdings/arrangements/{arrangementId}/noticebills","fullPath":"/api/v1.0.0/holdings/arrangements/{arrangementId}/noticebills","operationId":"getNoticeBills","name":"Retrieves the details of notice bills","summary":"Retrieves the details of notice bills","tags":["RETAIL"],"parameters":[{"name":"arrangementId","in":"path","type":"string","required":true,"description":"Indicates an unique identifier of an account"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"NoticeBillsResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse","default":"QueryErrorResponse"}}]},{"key":"holdings-arrangements-v4.4.0","title":"Arrangement details","version":"v4.4.0","description":"API to retrieve the details of arrangement conditions such as charge, interest, limits, overdue, payment schedule, agent, alerts, and commitment. This API also allows to retrieve the pricing evaluation details, product qualification details, delivery messages, payment order, events and repayment sch","endpointCount":63,"endpoints":[{"method":"GET","path":"/holdings/arrangements/{arrangementid}/customers","fullPath":"/api/v1.0.0/holdings/arrangements/{arrangementid}/customers","operationId":"getCustomerDetail","name":"Retrieves all the customer details for the given arrangement such as customer id, customer name, customer role, their beneficiary type, limitAllocactionPercentage, glAllocationPercentage and taxLiabilityPercentage","summary":"Retrieves the customer details for the given arrangement","tags":["RETAIL"],"parameters":[{"name":"arrangementid","in":"path","type":"string","required":true,"description":""},{"name":"arrangementId","in":"query","type":"string","required":true,"description":"Indicates an unique identifier of an account"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"CustomerDetailResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse","default":"QueryErrorResponse"}},{"method":"GET","path":"/holdings/arrangements/{arrangementId}/statements","fullPath":"/api/v1.0.0/holdings/arrangements/{arrangementId}/statements","operationId":"getAccountStatementDetails","name":"Fetch the statement condition details of the term deposits such as statement frequency, statement mode etc.,","summary":"Fetch the statement condition details of the term deposits such as statement frequency, statement mode etc.,","tags":["RETAIL"],"parameters":[{"name":"arrangementId","in":"path","type":"string","required":true,"description":"Indicates an unique identifier of an account"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"AccountStatementDetailsResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse","default":"QueryErrorResponse"}},{"method":"GET","path":"/holdings/arrangements/{arrangementId}/totalDueAmount","fullPath":"/api/v1.0.0/holdings/arrangements/{arrangementId}/totalDueAmount","operationId":"getTotalAmountDueSummary","name":"Retrieves the summary of total amount due for a given arrangement id","summary":"Retrieves the summary of total amount due for a given arrangement id","tags":["RETAIL"],"parameters":[{"name":"arrangementId","in":"path","type":"string","required":true,"description":"Indicates an unique identifier of an account"},{"name":"balanceType","in":"query","type":"string","required":false,"description":"Type of balance (e.g. current balance, credit interest accrued, deferred commission, etc.) as defined in the institution's accounting schemas."},{"name":"displayZeroBals","in":"query","type":"string","required":false,"description":""},{"name":"simulationReference","in":"query","type":"string","required":false,"description":"Indicates the reference id for simulation activity"},{"name":"startDate","in":"query","type":"string","required":false,"description":"Contains the date on which the transaction or payment gets initiated."},{"name":"endDate","in":"query","type":"string","required":false,"description":"Indicates the date till which the transaction history requested. If 20120101 is the start date and 20120201 is the end date, all transactions that are booked between January 1 to February 1 2012 are r"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"TotalAmountDueSummaryResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse","default":"QueryErrorResponse"}},{"method":"GET","path":"/holdings/arrangements/{arrangementId}/charges","fullPath":"/api/v1.0.0/holdings/arrangements/{arrangementId}/charges","operationId":"getChargeDetails","name":"Retrieves the charge details of an account","summary":"Retrieves the charge details of an account","tags":[],"parameters":[{"name":"arrangementId","in":"path","type":"string","required":true,"description":"Indicates an unique identifier of an account"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"ChargeDetailsResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse","default":"QueryErrorResponse"}},{"method":"GET","path":"/holdings/arrangements/{arrangementId}/scheduleDefinitions","fullPath":"/api/v1.0.0/holdings/arrangements/{arrangementId}/scheduleDefinitions","operationId":"getScheduleDetails","name":"Retrieves the payment schedule details of an account","summary":"Retrieves the payment schedule details of an account","tags":[],"parameters":[{"name":"arrangementId","in":"path","type":"string","required":true,"description":"Indicates an unique identifier of an account"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"ScheduleDetailsResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse","default":"QueryErrorResponse"}},{"method":"GET","path":"/holdings/arrangements/{arrangementId}","fullPath":"/api/v1.0.0/holdings/arrangements/{arrangementId}","operationId":"getArrangementDetails","name":"Retrieves the details of the given arrangement such as arrangement id,account id,customer details,product details ,arrangement start date and arrangement status","summary":"Retrieves the details of an arrangement","tags":[],"parameters":[{"name":"arrangementId","in":"path","type":"string","required":true,"description":"Indicates an unique identifier of an account"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"ArrangementDetailsResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse","default":"QueryErrorResponse"}},{"method":"GET","path":"/holdings/arrangements/{arrangementId}/payoffBills","fullPath":"/api/v1.0.0/holdings/arrangements/{arrangementId}/payoffBills","operationId":"getPayoffDetails","name":"Retrieves the payoff details of an account","summary":"Retrieves the payoff details of an account","tags":["RETAIL"],"parameters":[{"name":"arrangementId","in":"path","type":"string","required":true,"description":"Identifier of the account. Often referred to as the account number, yet for consistency this is always referred to as accountId. Accepts both IBAN & BBAN"},{"name":"simulationReference","in":"query","type":"string","required":false,"description":"Indicates the reference id for simulation activity"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"","default":"","400":"","500":""}},{"method":"GET","path":"/holdings/arrangements/activities/{arrangementActivityId}/status","fullPath":"/api/v1.0.0/holdings/arrangements/activities/{arrangementActivityId}/status","operationId":"getExternalEventStatus","name":"Retrieves the status of the given activity ","summary":"Retrieves the status of the given activity ","tags":["RETAIL"],"parameters":[{"name":"arrangementActivityId","in":"path","type":"string","required":true,"description":"Contains the arrangement activity reference identifier"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"","default":"","400":"","500":""}},{"method":"GET","path":"/holdings/arrangements/{arrangementId}/interestRates","fullPath":"/api/v1.0.0/holdings/arrangements/{arrangementId}/interestRates","operationId":"getInterestDetails","name":"Retrieves the interest condition of an account","summary":"Retrieves the interest condition of an account","tags":[],"parameters":[{"name":"arrangementId","in":"path","type":"string","required":true,"description":"Indicates an unique identifier of an account"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"InterestDetailsResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse","default":"QueryErrorResponse"}},{"method":"GET","path":"/holdings/arrangements/{arrangementId}/limits","fullPath":"/api/v1.0.0/holdings/arrangements/{arrangementId}/limits","operationId":"getLimitDetails","name":"Retrieves the limit details of an arrangement account","summary":"Retrieves the limit details of an arrangement account","tags":[],"parameters":[{"name":"arrangementId","in":"path","type":"string","required":true,"description":"Indicates an unique identifier of an account"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"LimitDetailsResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse","default":"QueryErrorResponse"}},{"method":"GET","path":"/holdings/accounts/overdueStatistics","fullPath":"/api/v1.0.0/holdings/accounts/overdueStatistics","operationId":"getOverdueStatistics","name":"Retrieves the overdue details of an account","summary":"Retrieves the overdue details of an account","tags":[],"parameters":[{"name":"overdueReference","in":"query","type":"string","required":true,"description":"Indicates the overdue reference"},{"name":"overdueReference_ct","in":"query","type":"string","required":true,"description":"Indicates the criteria for the contains operation on the overdue reference"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"OverdueStatisticsResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse","default":"QueryErrorResponse"}},{"method":"GET","path":"/holdings/arrangements/{arrangementId}/repayments","fullPath":"/api/v1.0.0/holdings/arrangements/{arrangementId}/repayments","operationId":"getRepaymentDetails","name":"Retrieves the repayment details of an account based on the payment schedule","summary":"Retrieves the repayment details of an account based on the payment schedule","tags":[],"parameters":[{"name":"arrangementId","in":"path","type":"string","required":true,"description":"Indicates an unique identifier of an account"},{"name":"simulationReference","in":"query","type":"string","required":false,"description":"Indicates the reference id for simulation activity"},{"name":"dueDate","in":"query","type":"string","required":false,"description":"Identifies the date on which the activity is due."},{"name":"includeExternalFees","in":"query","type":"string","required":false,"description":"Indicates if external fee is included"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"RepaymentDetailsResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse","default":"QueryErrorResponse"}},{"method":"GET","path":"/holdings/arrangements/{arrangementId}/agents","fullPath":"/api/v1.0.0/holdings/arrangements/{arrangementId}/agents","operationId":"getAgentDetails","name":"Retrieves the agent details of an account","summary":"Retrieves the agent details of an account","tags":[],"parameters":[{"name":"arrangementId","in":"path","type":"string","required":true,"description":"Indicates an unique identifier of an account"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"AgentDetailsResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse","default":"QueryErrorResponse"}},{"method":"GET","path":"/holdings/accounts/{accountNumber}/activeAlerts","fullPath":"/api/v1.0.0/holdings/accounts/{accountNumber}/activeAlerts","operationId":"getActiveAlerts","name":"Retrieves the details of active alerts for a given account number","summary":"Retrieves the details of active alerts for a given account number","tags":[],"parameters":[{"name":"accountNumber","in":"path","type":"string","required":true,"description":"Identifier of the account. Often referred to as the account number, yet for consistency this is always referred to as accountId. Accepts both IBAN & BBAN"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"ActiveAlertsResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse","default":"QueryErrorResponse"}},{"method":"GET","path":"/holdings/accounts/{accountNumber}/historyAlerts","fullPath":"/api/v1.0.0/holdings/accounts/{accountNumber}/historyAlerts","operationId":"getHistoryAlerts","name":"Retrieves the details of history alerts for a given account number","summary":"Retrieves the details of history alerts for a given account number","tags":[],"parameters":[{"name":"accountNumber","in":"path","type":"string","required":true,"description":"Identifier of the account. Often referred to as the account number, yet for consistency this is always referred to as accountId. Accepts both IBAN & BBAN"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"HistoryAlertsResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse","default":"QueryErrorResponse"}},{"method":"GET","path":"/holdings/arrangements/{arrangementId}/annualPercentageRates","fullPath":"/api/v1.0.0/holdings/arrangements/{arrangementId}/annualPercentageRates","operationId":"getAprDetails","name":"Retrieves the annual percentage rate of an account","summary":"Retrieves the annual percentage rate of an account","tags":[],"parameters":[{"name":"arrangementId","in":"path","type":"string","required":true,"description":"Indicates an unique identifier of an account"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"AprDetailsResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse","default":"QueryErrorResponse"}},{"method":"GET","path":"/holdings/arrangements/{arrangementId}/holidayLimit","fullPath":"/api/v1.0.0/holdings/arrangements/{arrangementId}/holidayLimit","operationId":"getHolidayLimit","name":"Retrieves the details of payment holiday limit amount","summary":"Retrieves the details of payment holiday limit amount","tags":[],"parameters":[{"name":"arrangementId","in":"path","type":"string","required":true,"description":"Indicates an unique identifier of an account"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"HolidayLimitResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse","default":"QueryErrorResponse"}},{"method":"GET","path":"/holdings/arrangements/{arrangementId}/commitments","fullPath":"/api/v1.0.0/holdings/arrangements/{arrangementId}/commitments","operationId":"getCommitmentDetails","name":"Retrieves the commitment details of an account","summary":"Retrieves the commitment details of an account","tags":[],"parameters":[{"name":"arrangementId","in":"path","type":"string","required":true,"description":"Indicates an unique identifier of an account"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"CommitmentDetailsResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse","default":"QueryErrorResponse"}},{"method":"GET","path":"/holdings/arrangements/{arrangementId}/qualifiers","fullPath":"/api/v1.0.0/holdings/arrangements/{arrangementId}/qualifiers","operationId":"getProductQualifierDetails","name":"Retrieves the product qualifier details of an account","summary":"Retrieves the product qualifier details of an account","tags":[],"parameters":[{"name":"arrangementId","in":"path","type":"string","required":true,"description":"Indicates an unique identifier of an account"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"ProductQualifierDetailsResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse","default":"QueryErrorResponse"}},{"method":"GET","path":"/holdings/arrangements/{arrangementId}/evaluations","fullPath":"/api/v1.0.0/holdings/arrangements/{arrangementId}/evaluations","operationId":"getEvaluationDetails","name":"Retrieves the pricing evaluation details of an account.","summary":"Retrieves the pricing evaluation details of an account","tags":[],"parameters":[{"name":"arrangementId","in":"path","type":"string","required":true,"description":"Indicates an unique identifier of an account"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"EvaluationDetailsResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse","default":"QueryErrorResponse"}},{"method":"GET","path":"/holdings/accounts/{arrangementId}/dates","fullPath":"/api/v1.0.0/holdings/accounts/{arrangementId}/dates","operationId":"getArrangementDates","name":"Retrieves the key dates of an account","summary":"Retrieves the key dates of an account","tags":[],"parameters":[{"name":"arrangementId","in":"path","type":"string","required":true,"description":"Indicates an unique identifier of an account"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"ArrangementDatesResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse","default":"QueryErrorResponse"}},{"method":"GET","path":"/holdings/arrangements/{arrangementId}/interestAccruals","fullPath":"/api/v1.0.0/holdings/arrangements/{arrangementId}/interestAccruals","operationId":"getInterestDetailsCurrent","name":"Retrieves the interest accrued for the current period of an account","summary":"Retrieves the interest accrued for the current period of an account","tags":[],"parameters":[{"name":"arrangementId","in":"path","type":"string","required":true,"description":"Indicates an unique identifier of an account"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"InterestDetailsCurrentResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse","default":"QueryErrorResponse"}},{"method":"GET","path":"/holdings/arrangements/{arrangementId}/historicInterestAccruals","fullPath":"/api/v1.0.0/holdings/arrangements/{arrangementId}/historicInterestAccruals","operationId":"getInterestDetailsPrevious","name":"Retrieve the past period's interest accruals","summary":"Retrieve the past period's interest accruals","tags":[],"parameters":[{"name":"arrangementId","in":"path","type":"string","required":true,"description":"Indicates an unique identifier of an account"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"InterestDetailsPreviousResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse","default":"QueryErrorResponse"}},{"method":"GET","path":"/holdings/arrangements/{arrangementId}/yearToDateInterestAccruals","fullPath":"/api/v1.0.0/holdings/arrangements/{arrangementId}/yearToDateInterestAccruals","operationId":"getInterestDetailsYearToDate","name":"Retrieves the interest accruals of the previous year","summary":"Retrieves the interest accruals of the previous year","tags":[],"parameters":[{"name":"arrangementId","in":"path","type":"string","required":true,"description":"Indicates an unique identifier of an account"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"InterestDetailsYearToDateResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse","default":"QueryErrorResponse"}},{"method":"GET","path":"/holdings/accounts/{arrangementId}/messages","fullPath":"/api/v1.0.0/holdings/accounts/{arrangementId}/messages","operationId":"getDeliveryMessages","name":"Retrieves the details of delivery messages for a given arrangement id","summary":"Retrieves the details of delivery messages for a given arrangement id","tags":[],"parameters":[{"name":"arrangementId","in":"path","type":"string","required":true,"description":"Indicates an unique identifier of an account"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"DeliveryMessagesResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse","default":"QueryErrorResponse"}},{"method":"GET","path":"/holdings/accounts/{arrangementId}/historyMessages","fullPath":"/api/v1.0.0/holdings/accounts/{arrangementId}/historyMessages","operationId":"getDeliveryMessagesHistory","name":"Retrieves the details of history delivery messages for a given arrangement id","summary":"Retrieves the details of history delivery messages for a given arrangement id","tags":[],"parameters":[{"name":"arrangementId","in":"path","type":"string","required":true,"description":"Indicates an unique identifier of an account"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"DeliveryMessagesHistoryResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse","default":"QueryErrorResponse"}},{"method":"GET","path":"/holdings/arrangements/{arrangementId}/stmtEntries","fullPath":"/api/v1.0.0/holdings/arrangements/{arrangementId}/stmtEntries","operationId":"getStmtEntries","name":"Retrieves the statement entries of an arrangement account","summary":"Retrieves the statement entries of an arrangement account","tags":[],"parameters":[{"name":"arrangementId","in":"path","type":"string","required":true,"description":"Indicates an unique identifier of an account"},{"name":"valueDate","in":"query","type":"string","required":false,"description":"Indicates the value date on which the underlying accounting entry is to be given value (for interest purposes)"},{"name":"stmtFlag","in":"query","type":"string","required":false,"description":""},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"StmtEntriesResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse","default":"QueryErrorResponse"}},{"method":"GET","path":"/holdings/arrangements/{arrangementId}/dataEvents","fullPath":"/api/v1.0.0/holdings/arrangements/{arrangementId}/dataEvents","operationId":"getArrangementPropertyConditions","name":"Retrieves the property conditions to the data events","summary":"Retrieves the property conditions","tags":[],"parameters":[{"name":"arrangementId","in":"path","type":"string","required":true,"description":"Indicates an unique identifier of an account"},{"name":"status","in":"query","type":"string","required":true,"description":"Contains status of the data rights request.Allowed values are INITIATED, INPROGESS, EXTENDED, COMPLETED, REJECTED."},{"name":"arrangementActivityId","in":"query","type":"string","required":false,"description":"Contains the arrangement activity reference identifier"},{"name":"effectiveDate","in":"query","type":"string","required":false,"description":"Contains the identifier for the transaction date. Dates are expected in \u00e2\u20ac\u02dcYYYYMMDD\u00e2\u20ac\u2122 format"},{"name":"property","in":"query","type":"string","required":false,"description":"Id of the product property"},{"name":"dataEvent","in":"query","type":"string","required":false,"description":"Indicates the data event flag"},{"name":"ofsSource","in":"query","type":"string","required":false,"description":"Indicates the source of the OFS"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"ArrangementPropertyConditionsResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse","default":"QueryErrorResponse"}},{"method":"GET","path":"/holdings/arrangements/{arrangementId}/schedules","fullPath":"/api/v1.0.0/holdings/arrangements/{arrangementId}/schedules","operationId":"getSchedulesFull","name":"Retrieves the repayment schedule details for an arrangement","summary":"Retrieves the repayment schedule details for an arrangement","tags":[],"parameters":[{"name":"arrangementId","in":"path","type":"string","required":true,"description":"Indicates an unique identifier of an account"},{"name":"simulationReference","in":"query","type":"string","required":false,"description":"Indicates the reference id for simulation activity"},{"name":"dateFrom","in":"query","type":"string","required":false,"description":"Start date of the loan"},{"name":"dateTo","in":"query","type":"string","required":false,"description":"End date of the loan"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"SchedulesFullResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse","default":"QueryErrorResponse"}},{"method":"GET","path":"/holdings/arrangements/{arrangementActivityId}/simulationReferences","fullPath":"/api/v1.0.0/holdings/arrangements/{arrangementActivityId}/simulationReferences","operationId":"getSimulationReference","name":"Retrieves the simulation reference for the given arrangement activity id","summary":"Retrieves the simulation reference for the given arrangement activity id","tags":[],"parameters":[{"name":"arrangementActivityId","in":"path","type":"string","required":true,"description":"Contains the arrangement activity reference identifier"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"SimulationReferenceResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse","default":"QueryErrorResponse"}},{"method":"GET","path":"/holdings/arrangement/{arrangementId}/alerts","fullPath":"/api/v1.0.0/holdings/arrangement/{arrangementId}/alerts","operationId":"getArrangementAlerts","name":"Retrieves the list of alerts applicable for an arrangement","summary":"Retrieves the list of alerts applicable for an arrangement","tags":[],"parameters":[{"name":"arrangementId","in":"path","type":"string","required":true,"description":"Indicates an unique identifier of an account"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"ArrangementAlertsResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse","default":"QueryErrorResponse"}},{"method":"GET","path":"/holdings/arrangements/{arrangementId}/simulations","fullPath":"/api/v1.0.0/holdings/arrangements/{arrangementId}/simulations","operationId":"getSimulationDetails","name":"Retrieves the simulated activity details of an account","summary":"Retrieves the simulated activity details of an account","tags":[],"parameters":[{"name":"arrangementId","in":"path","type":"string","required":true,"description":"Indicates an unique identifier of an account"},{"name":"simulationCaptureReferenceId","in":"query","type":"string","required":false,"description":"Indicates the Reference Id for the simulation activity"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"SimulationDetailsResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse","default":"QueryErrorResponse"}},{"method":"GET","path":"/holdings/customers/{customerId}/arrangements","fullPath":"/api/v1.0.0/holdings/customers/{customerId}/arrangements","operationId":"getCustomerArrangementDetails","name":"Retrieves the list of arrangement ids for a given customer","summary":"Retrieves the list of arrangement ids for a given customer","tags":[],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"Identifier of the customer"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"CustomerArrangementDetailsResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse","default":"QueryErrorResponse"}},{"method":"GET","path":"/holdings/arrangements/{arrangementId}/chargeOffBalances","fullPath":"/api/v1.0.0/holdings/arrangements/{arrangementId}/chargeOffBalances","operationId":"getChargeOffDetails","name":"Retrieves the charge off balances of an arrangement account","summary":"Retrieves the charge off balances of an arrangement account","tags":[],"parameters":[{"name":"arrangementId","in":"path","type":"string","required":true,"description":"Indicates an unique identifier of an account"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"ChargeOffDetailsResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse","default":"QueryErrorResponse"}},{"method":"GET","path":"/holdings/arrangements/{arrangementId}/consolidatedBalances","fullPath":"/api/v1.0.0/holdings/arrangements/{arrangementId}/consolidatedBalances","operationId":"getVirtualBalances","name":"Retrieves the virtual balances for a balance type of an account","summary":"Retrieves the virtual balances for a balance type of an account","tags":[],"parameters":[{"name":"arrangementId","in":"path","type":"string","required":true,"description":"Indicates an unique identifier of an account"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"VirtualBalancesResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse","default":"QueryErrorResponse"}},{"method":"GET","path":"/holdings/arrangements/{arrangementId}/activities","fullPath":"/api/v1.0.0/holdings/arrangements/{arrangementId}/activities","operationId":"getArrangementActivityLog","name":"Retrieves the activity log of an account","summary":"Retrieves the activity log of an account","tags":[],"parameters":[{"name":"arrangementId","in":"path","type":"string","required":true,"description":"Indicates an unique identifier of an account"},{"name":"simulation","in":"query","type":"string","required":false,"description":"What if scenario reference"},{"name":"startDate","in":"query","type":"string","required":false,"description":"Contains the date on which the transaction or payment gets initiated."},{"name":"endDate","in":"query","type":"string","required":false,"description":"Indicates the date till which the transaction history requested. If 20120101 is the start date and 20120201 is the end date, all transactions that are booked between January 1 to February 1 2012 are r"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"ArrangementActivityLogResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse","default":"QueryErrorResponse"}},{"method":"GET","path":"/holdings/arrangements/{arrangementId}/financialActivities","fullPath":"/api/v1.0.0/holdings/arrangements/{arrangementId}/financialActivities","operationId":"getFinancialActivities","name":"Retrieves the financial activity log of an account","summary":"Retrieves the financial activity log of an account","tags":[],"parameters":[{"name":"arrangementId","in":"path","type":"string","required":true,"description":"Indicates an unique identifier of an account"},{"name":"simulationReference","in":"query","type":"string","required":false,"description":"Indicates the reference id for simulation activity"},{"name":"startDate","in":"query","type":"string","required":false,"description":"Contains the date on which the transaction or payment gets initiated."},{"name":"endDate","in":"query","type":"string","required":false,"description":"Indicates the date till which the transaction history requested. If 20120101 is the start date and 20120201 is the end date, all transactions that are booked between January 1 to February 1 2012 are r"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"FinancialActivitiesResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse","default":"QueryErrorResponse"}},{"method":"GET","path":"/holdings/arrangements/{arrangementId}/userActivities","fullPath":"/api/v1.0.0/holdings/arrangements/{arrangementId}/userActivities","operationId":"getUserActivities","name":"Lists the user related activity logs of an account","summary":"Lists the user related activity logs of an account","tags":[],"parameters":[{"name":"arrangementId","in":"path","type":"string","required":true,"description":"Indicates an unique identifier of an account"},{"name":"simulationReference","in":"query","type":"string","required":false,"description":"Indicates the reference id for simulation activity"},{"name":"startDate","in":"query","type":"string","required":false,"description":"Contains the date on which the transaction or payment gets initiated."},{"name":"endDate","in":"query","type":"string","required":false,"description":"Indicates the date till which the transaction history requested. If 20120101 is the start date and 20120201 is the end date, all transactions that are booked between January 1 to February 1 2012 are r"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"UserActivitiesResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse","default":"QueryErrorResponse"}},{"method":"GET","path":"/holdings/arrangements/{arrangementId}/systemActivities","fullPath":"/api/v1.0.0/holdings/arrangements/{arrangementId}/systemActivities","operationId":"getSystemActivities","name":"Retrieves the system activities of an account","summary":"Retrieves the system activities of an account","tags":[],"parameters":[{"name":"arrangementId","in":"path","type":"string","required":true,"description":"Indicates an unique identifier of an account"},{"name":"simulationReference","in":"query","type":"string","required":false,"description":"Indicates the reference id for simulation activity"},{"name":"startDate","in":"query","type":"string","required":false,"description":"Contains the date on which the transaction or payment gets initiated."},{"name":"endDate","in":"query","type":"string","required":false,"description":"Indicates the date till which the transaction history requested. If 20120101 is the start date and 20120201 is the end date, all transactions that are booked between January 1 to February 1 2012 are r"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"SystemActivitiesResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse","default":"QueryErrorResponse"}},{"method":"GET","path":"/holdings/arrangements/{arrangementId}/holdActivities","fullPath":"/api/v1.0.0/holdings/arrangements/{arrangementId}/holdActivities","operationId":"getHoldActivities","name":"Retrieves the log of an activity in hold of an account","summary":"Retrieves the log of an activity in hold of an account","tags":[],"parameters":[{"name":"arrangementId","in":"path","type":"string","required":true,"description":"Indicates an unique identifier of an account"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"HoldActivitiesResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse","default":"QueryErrorResponse"}},{"method":"GET","path":"/holdings/arrangements/{arrangementId}/archievedActivities","fullPath":"/api/v1.0.0/holdings/arrangements/{arrangementId}/archievedActivities","operationId":"getArchievedActivities","name":"Retrieves the archived activity log of an account","summary":"Retrieves the archived activity log of an account","tags":[],"parameters":[{"name":"arrangementId","in":"path","type":"string","required":true,"description":"Indicates an unique identifier of an account"},{"name":"simulationReference","in":"query","type":"string","required":false,"description":"Indicates the reference id for simulation activity"},{"name":"startDate","in":"query","type":"string","required":false,"description":"Contains the date on which the transaction or payment gets initiated."},{"name":"endDate","in":"query","type":"string","required":false,"description":"Indicates the date till which the transaction history requested. If 20120101 is the start date and 20120201 is the end date, all transactions that are booked between January 1 to February 1 2012 are r"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"ArchievedActivitiesResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse","default":"QueryErrorResponse"}},{"method":"GET","path":"/holdings/arrangements/{arrangementId}/transactions","fullPath":"/api/v1.0.0/holdings/arrangements/{arrangementId}/transactions","operationId":"getAccountSummary","name":"Retrieves the transaction list for a given account number","summary":"Retrieves the transaction list for a given account number","tags":[],"parameters":[{"name":"arrangementId","in":"path","type":"string","required":true,"description":"Indicates an unique identifier of an account"},{"name":"startDate","in":"query","type":"string","required":false,"description":"Contains the date on which the transaction or payment gets initiated."},{"name":"endDate","in":"query","type":"string","required":false,"description":"Indicates the date till which the transaction history requested. If 20120101 is the start date and 20120201 is the end date, all transactions that are booked between January 1 to February 1 2012 are r"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"AccountSummaryResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse","default":"QueryErrorResponse"}},{"method":"GET","path":"/holdings/arrangements/{arrangementId}/eligibileActivities","fullPath":"/api/v1.0.0/holdings/arrangements/{arrangementId}/eligibileActivities","operationId":"getArrangementActivities","name":"Retrieves the list of activities applicable for an arrangement account","summary":"Retrieves the list of activities applicable for an arrangement account","tags":[],"parameters":[{"name":"arrangementId","in":"path","type":"string","required":true,"description":"Indicates an unique identifier of an account"},{"name":"activityId","in":"query","type":"string","required":false,"description":"Id of the activity, e.g. ACCOUNTS-CAPITALISE-ACCHARGE*CARDISSUEFEE"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"ArrangementActivitiesResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse","default":"QueryErrorResponse"}},{"method":"GET","path":"/holdings/arrangements/unapprovedArrangementActivites","fullPath":"/api/v1.0.0/holdings/arrangements/unapprovedArrangementActivites","operationId":"getUnauthorisedAAA","name":"Retrieves the list of unauthorised activities of an account","summary":"Retrieves the list of unauthorised activities of an account","tags":[],"parameters":[{"name":"customerId","in":"query","type":"string","required":false,"description":"Identifier of the customer"},{"name":"activity","in":"query","type":"string","required":false,"description":"Defines the activity to be processed against the Arrangement. The activity may be a user activity or a system generated activity."},{"name":"arrangementId","in":"query","type":"string","required":false,"description":"Indicates an unique identifier of an account"},{"name":"product","in":"query","type":"string","required":false,"description":"Contains the name of the product"},{"name":"currency","in":"query","type":"string","required":false,"description":"Identifies the currency. E.g. USD, GBP etc"},{"name":"contractId","in":"query","type":"string","required":false,"description":"Indicates the unique identifier of the transaction or contract which initiated the activity"},{"name":"transactionAmount","in":"query","type":"string","required":false,"description":"Contains the transaction amount. This is based on the currency, either local or foreign currency"},{"name":"transactionAmountLocalCurrency","in":"query","type":"string","required":false,"description":"Indicates the transaction amount in local currency"},{"name":"applicationId","in":"query","type":"string","required":false,"description":"Contains the application id of the service that has crashed due to error."},{"name":"inputter","in":"query","type":"string","required":false,"description":"The user identifier who input the transaction"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"UnauthorisedAAAResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse","default":"QueryErrorResponse"}},{"method":"GET","path":"/holdings/arrangements/{arrangementId}/bundles","fullPath":"/api/v1.0.0/holdings/arrangements/{arrangementId}/bundles","operationId":"getLinktArrDetails","name":"Retrieves the link arrangement details of an account","summary":"Retrieves the link arrangement details of an account","tags":[],"parameters":[{"name":"arrangementId","in":"path","type":"string","required":true,"description":"Indicates an unique identifier of an account"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"LinktArrDetailsResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse","default":"QueryErrorResponse"}},{"method":"GET","path":"/holdings/arrangements/{arrangementId}/documents","fullPath":"/api/v1.0.0/holdings/arrangements/{arrangementId}/documents","operationId":"getTransactionDocuments","name":"Retrieves the transaction document details of a given arrangement account","summary":"Retrieves the transaction document details of a given arrangement account","tags":[],"parameters":[{"name":"arrangementId","in":"path","type":"string","required":true,"description":"Indicates an unique identifier of an account"},{"name":"transactionReference","in":"query","type":"string","required":false,"description":"Contains the identifier for the transaction in the core system"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"TransactionDocumentsResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse","default":"QueryErrorResponse"}},{"method":"GET","path":"/holdings/arrangements/{arrangementId}/balances","fullPath":"/api/v1.0.0/holdings/arrangements/{arrangementId}/balances","operationId":"getArrangementBalances","name":"Retrieves the balance details for a given arrangement","summary":"Retrieves the working ,ledger and cleared balances for an arrangement","tags":[],"parameters":[{"name":"arrangementId","in":"path","type":"string","required":true,"description":""},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"ArrangementBalancesResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse","default":"QueryErrorResponse"}},{"method":"DELETE","path":"/holdings/arrangementActivityId/{activityId}","fullPath":"/api/v1.0.0/holdings/arrangementActivityId/{activityId}","operationId":"reverseAccounts","name":"Deletes an arrangement on which no transactions are  posted","summary":"Deletes an arrangement on which no transactions are  posted","tags":[],"parameters":[{"name":"activityId","in":"path","type":"string","required":true,"description":""},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"reverseAccountsResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse","default":"ArrangementErrorResponse"}},{"method":"GET","path":"/holdings/arrangements/{arrangementId}/bills","fullPath":"/api/v1.0.0/holdings/arrangements/{arrangementId}/bills","operationId":"getAllBills","name":"Retrieves the details of all the types of bills","summary":"Retrieves the details of all the types of bills","tags":[],"parameters":[{"name":"arrangementId","in":"path","type":"string","required":true,"description":"Indicates an unique identifier of an account"},{"name":"fileVersion","in":"query","type":"string","required":false,"description":"Indicates if the file is of type simulation or live"},{"name":"simulationReference","in":"query","type":"string","required":false,"description":"Indicates the reference id for simulation activity"},{"name":"paymentDate","in":"query","type":"string","required":false,"description":"Contains the date in which the payment will be sent out. Date in the format YYYYMMDD. E.g. 20191231"},{"name":"deferDate","in":"query","type":"string","required":false,"description":"Date that the payment has been deferred to"},{"name":"billedAmount","in":"query","type":"string","required":false,"description":"Indicates the bill amount"},{"name":"outstandingAmount","in":"query","type":"string","required":false,"description":"Contains the aggregate outstanding principal amount thereof after giving effect to any borrowings and prepayments or repayments of Committed Loans"},{"name":"delinquentAmount","in":"query","type":"string","required":false,"description":"Indicates the bill amount during the ageing status(Bill which crossed the due date)"},{"name":"property","in":"query","type":"string","required":false,"description":"Id of the product property"},{"name":"billStatus","in":"query","type":"string","required":false,"description":"Indicates the status of a bill(Issued,Due,Ageing,Settled)"},{"name":"settlementStatus","in":"query","type":"string","required":false,"description":"Defines the status of the settlement for the incoming MT548 swift message.The values allowed are: Waiting : pending to receive settlement status update meaning pending to receive MT548 swift message, "},{"name":"agingStatus","in":"query","type":"string","required":false,"description":"Indicates the ageing status of a bill"},{"name":"settled","in":"query","type":"string","required":false,"description":"Flag to indicate whether a bill is settled or not"},{"name":"paymentType","in":"query","type":"string","required":false,"description":"Indicates if the payment is Customer (C) type or Bank (B) type"},{"name":"billDate","in":"query","type":"string","required":false,"description":"Indicates a date on which a bill has been raised"},{"name":"billType","in":"query","type":"string","required":false,"description":"The type of payment obligation generated"},{"name":"paymentMethod","in":"query","type":"string","required":false,"description":"Method chosen to make the payment"},{"name":"infoPayType","in":"query","type":"string","required":false,"description":"Indicates a bill which is raised when a loan is paid off"},{"name":"advancePayment","in":"query","type":"string","required":false,"description":"Indicates whether advance payment made is set on an account"},{"name":"paymentIndicator","in":"query","type":"string","required":false,"description":"Indicates whether its a credit/debit type of bill"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"AllBillsResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse","default":"QueryErrorResponse"}},{"method":"GET","path":"/holdings/arrangements/{arrangementId}/outstandingBills","fullPath":"/api/v1.0.0/holdings/arrangements/{arrangementId}/outstandingBills","operationId":"getOutstandingBills","name":"Retrieves the outstanding amount to be paid for an account","summary":"Retrieves the outstanding amount to be paid for an account","tags":[],"parameters":[{"name":"arrangementId","in":"path","type":"string","required":true,"description":"Indicates an unique identifier of an account"},{"name":"fileVersion","in":"query","type":"string","required":false,"description":"Indicates if the file is of type simulation or live"},{"name":"simulationReference","in":"query","type":"string","required":false,"description":"Indicates the reference id for simulation activity"},{"name":"paymentDate","in":"query","type":"string","required":false,"description":"Contains the date in which the payment will be sent out. Date in the format YYYYMMDD. E.g. 20191231"},{"name":"deferDate","in":"query","type":"string","required":false,"description":"Date that the payment has been deferred to"},{"name":"billedAmount","in":"query","type":"string","required":false,"description":"Indicates the bill amount"},{"name":"outstandingAmount","in":"query","type":"string","required":false,"description":"Contains the aggregate outstanding principal amount thereof after giving effect to any borrowings and prepayments or repayments of Committed Loans"},{"name":"delinquentAmount","in":"query","type":"string","required":false,"description":"Indicates the bill amount during the ageing status(Bill which crossed the due date)"},{"name":"property","in":"query","type":"string","required":false,"description":"Id of the product property"},{"name":"billStatus","in":"query","type":"string","required":false,"description":"Indicates the status of a bill(Issued,Due,Ageing,Settled)"},{"name":"settlementStatus","in":"query","type":"string","required":false,"description":"Defines the status of the settlement for the incoming MT548 swift message.The values allowed are: Waiting : pending to receive settlement status update meaning pending to receive MT548 swift message, "},{"name":"agingStatus","in":"query","type":"string","required":false,"description":"Indicates the ageing status of a bill"},{"name":"settled","in":"query","type":"string","required":false,"description":"Flag to indicate whether a bill is settled or not"},{"name":"paymentType","in":"query","type":"string","required":false,"description":"Indicates if the payment is Customer (C) type or Bank (B) type"},{"name":"billDate","in":"query","type":"string","required":false,"description":"Indicates a date on which a bill has been raised"},{"name":"billType","in":"query","type":"string","required":false,"description":"The type of payment obligation generated"},{"name":"paymentMethod","in":"query","type":"string","required":false,"description":"Method chosen to make the payment"},{"name":"infoPayType","in":"query","type":"string","required":false,"description":"Indicates a bill which is raised when a loan is paid off"},{"name":"advancePayment","in":"query","type":"string","required":false,"description":"Indicates whether advance payment made is set on an account"},{"name":"paymentIndicator","in":"query","type":"string","required":false,"description":"Indicates whether its a credit/debit type of bill"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"OutstandingBillsResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse","default":"QueryErrorResponse"}},{"method":"GET","path":"/holdings/arrangements/{arrangementId}/deferredBills","fullPath":"/api/v1.0.0/holdings/arrangements/{arrangementId}/deferredBills","operationId":"getDeferredBills","name":"Retrieves the details of the deferred bills","summary":"Retrieves the details of the deferred bills","tags":[],"parameters":[{"name":"arrangementId","in":"path","type":"string","required":true,"description":"Indicates an unique identifier of an account"},{"name":"fileVersion","in":"query","type":"string","required":false,"description":"Indicates if the file is of type simulation or live"},{"name":"simulationReference","in":"query","type":"string","required":false,"description":"Indicates the reference id for simulation activity"},{"name":"paymentDate","in":"query","type":"string","required":false,"description":"Contains the date in which the payment will be sent out. Date in the format YYYYMMDD. E.g. 20191231"},{"name":"deferDate","in":"query","type":"string","required":false,"description":"Date that the payment has been deferred to"},{"name":"billedAmount","in":"query","type":"string","required":false,"description":"Indicates the bill amount"},{"name":"outstandingAmount","in":"query","type":"string","required":false,"description":"Contains the aggregate outstanding principal amount thereof after giving effect to any borrowings and prepayments or repayments of Committed Loans"},{"name":"delinquentAmount","in":"query","type":"string","required":false,"description":"Indicates the bill amount during the ageing status(Bill which crossed the due date)"},{"name":"property","in":"query","type":"string","required":false,"description":"Id of the product property"},{"name":"billStatus","in":"query","type":"string","required":false,"description":"Indicates the status of a bill(Issued,Due,Ageing,Settled)"},{"name":"settlementStatus","in":"query","type":"string","required":false,"description":"Defines the status of the settlement for the incoming MT548 swift message.The values allowed are: Waiting : pending to receive settlement status update meaning pending to receive MT548 swift message, "},{"name":"agingStatus","in":"query","type":"string","required":false,"description":"Indicates the ageing status of a bill"},{"name":"paymentType","in":"query","type":"string","required":false,"description":"Indicates if the payment is Customer (C) type or Bank (B) type"},{"name":"billDate","in":"query","type":"string","required":false,"description":"Indicates a date on which a bill has been raised"},{"name":"billType","in":"query","type":"string","required":false,"description":"The type of payment obligation generated"},{"name":"paymentMethod","in":"query","type":"string","required":false,"description":"Method chosen to make the payment"},{"name":"infoPayType","in":"query","type":"string","required":false,"description":"Indicates a bill which is raised when a loan is paid off"},{"name":"advancePayment","in":"query","type":"string","required":false,"description":"Indicates whether advance payment made is set on an account"},{"name":"paymentIndicator","in":"query","type":"string","required":false,"description":"Indicates whether its a credit/debit type of bill"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"DeferredBillsResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse","default":"QueryErrorResponse"}},{"method":"GET","path":"/holdings/arrangements/{arrangementId}/externalBills","fullPath":"/api/v1.0.0/holdings/arrangements/{arrangementId}/externalBills","operationId":"getExternalBills","name":"Retrieves the details of the external type of bills","summary":"Retrieves the details of the external type of bills","tags":[],"parameters":[{"name":"arrangementId","in":"path","type":"string","required":true,"description":"Indicates an unique identifier of an account"},{"name":"simulationReference","in":"query","type":"string","required":false,"description":"Indicates the reference id for simulation activity"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"ExternalBillsResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse","default":"QueryErrorResponse"}},{"method":"GET","path":"/holdings/arrangements/{arrangementId}/advanceBills","fullPath":"/api/v1.0.0/holdings/arrangements/{arrangementId}/advanceBills","operationId":"getAdvanceBills","name":"Retrieves the details of the advance bills","summary":"Retrieves the details of the advance bills","tags":[],"parameters":[{"name":"arrangementId","in":"path","type":"string","required":true,"description":"Indicates an unique identifier of an account"},{"name":"billStatus","in":"query","type":"string","required":false,"description":"Indicates the status of a bill(Issued,Due,Ageing,Settled)"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"AdvanceBillsResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse","default":"QueryErrorResponse"}},{"method":"GET","path":"/holdings/arrangements/{arrangementId}/writeOffBills","fullPath":"/api/v1.0.0/holdings/arrangements/{arrangementId}/writeOffBills","operationId":"getWriteoffBills","name":"Retrieves the details of the write off bills","summary":"Retrieves the details of the write off bills","tags":[],"parameters":[{"name":"arrangementId","in":"path","type":"string","required":true,"description":"Indicates an unique identifier of an account"},{"name":"billStatus","in":"query","type":"string","required":true,"description":"Indicates the status of a bill(Issued,Due,Ageing,Settled)"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"WriteoffBillsResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse","default":"QueryErrorResponse"}},{"method":"GET","path":"/holdings/arrangements/writeOff/{arrangementId}/activities","fullPath":"/api/v1.0.0/holdings/arrangements/writeOff/{arrangementId}/activities","operationId":"getWriteOffActivitiesDetails","name":"Retrieves the details of write off bills based on activities","summary":"Retrieves the details of write off bills based on activities","tags":[],"parameters":[{"name":"arrangementId","in":"path","type":"string","required":true,"description":"Indicates an unique identifier of an account"},{"name":"fileVersion","in":"query","type":"string","required":false,"description":"Indicates if the file is of type simulation or live"},{"name":"simulationReference","in":"query","type":"string","required":false,"description":"Indicates the reference id for simulation activity"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"WriteOffActivitiesDetailsResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse","default":"QueryErrorResponse"}},{"method":"GET","path":"/holdings/arrangements/{arrangementId}/settlements","fullPath":"/api/v1.0.0/holdings/arrangements/{arrangementId}/settlements","operationId":"getSettlementDetails","name":"Retrieves the settlement details for the given arrangement such as payment type, payin account, payin percentage, payin amount, payout account, payout percentage, payout amount, etc","summary":"Retrieves settlement details for the given arrangement","tags":["RETAIL"],"parameters":[{"name":"arrangementId","in":"path","type":"string","required":true,"description":"Indicates an unique identifier of an account"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"SettlementDetailsResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse","default":"QueryErrorResponse"}},{"method":"GET","path":"/holdings/arrangements/{arrangementId}/paymentHolidays","fullPath":"/api/v1.0.0/holdings/arrangements/{arrangementId}/paymentHolidays","operationId":"getPaymentHoliday","name":"Retrieves payment holiday details for the given arrangement such as payment type, holiday date, original payment amount and new payment amount","summary":"Retrieves payment holiday details for the given arrangement","tags":["RETAIL"],"parameters":[{"name":"arrangementId","in":"path","type":"string","required":true,"description":"Indicates an unique identifier of an account"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"PaymentHolidayResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse","default":"QueryErrorResponse"}},{"method":"GET","path":"/holdings/arrangements/simulations/{simulationId}/schedules","fullPath":"/api/v1.0.0/holdings/arrangements/simulations/{simulationId}/schedules","operationId":"getSchedulesSim","name":"Retrieves the repayment schedule details for an arrangement with simulation reference number","summary":"Retrieves the repayment schedule details for an arrangement with simulation reference number","tags":["RETAIL"],"parameters":[{"name":"simulationId","in":"path","type":"string","required":true,"description":"Indicates the Id generated during the simulation of an activity"},{"name":"arrangementId","in":"query","type":"string","required":false,"description":"Indicates an unique identifier of an account"},{"name":"dateFrom","in":"query","type":"string","required":false,"description":"Start date of the loan"},{"name":"dateTo","in":"query","type":"string","required":false,"description":"End date of the loan"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"SchedulesSimResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse","default":"QueryErrorResponse"}},{"method":"GET","path":"/holdings/transactions","fullPath":"/api/v1.0.0/holdings/transactions","operationId":"getArrangementTransactionsList","name":"Retrieves the details of account transaction","summary":"Retrieves account transaction","tags":[],"parameters":[{"name":"accountId","in":"query","type":"string","required":false,"description":"Identifier of the account. Often referred to as the account number, yet for consistency this is always referred to as accountId. Accepts both IBAN & BBAN"},{"name":"customerId","in":"query","type":"string","required":false,"description":"Identifier of the customer"},{"name":"listType","in":"query","type":"string","required":true,"description":"Indicates the transaction search type"},{"name":"transactionCount","in":"query","type":"string","required":false,"description":"Indicates the total number of transactions"},{"name":"payType","in":"query","type":"string","required":false,"description":"Indicates the identifier of payment types for  letter of credit."},{"name":"dateFrom","in":"query","type":"string","required":false,"description":"Start date of the loan"},{"name":"dateTo","in":"query","type":"string","required":false,"description":"End date of the loan"},{"name":"minimumAmount","in":"query","type":"string","required":false,"description":"The minimum account balance required."},{"name":"maximumAmount","in":"query","type":"string","required":false,"description":"The maximum account balance allowed."},{"name":"displayName","in":"query","type":"string","required":false,"description":"Contains the name used for display or enrichment purposes"},{"name":"transactionCode","in":"query","type":"string","required":false,"description":"Identifies the system internal transaction code applicable to the transaction"},{"name":"entryReference","in":"query","type":"string","required":false,"description":"It is the transaction reference. This is the identifier of the transaction on Temenos Core Banking system."},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"ArrangementTransactionsListResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse","default":"QueryErrorResponse"}},{"method":"GET","path":"/holdings/customers","fullPath":"/api/v1.0.0/holdings/customers","operationId":"getArrangementHoldings","name":"Retrieves the list of customer holdings details, such as arrangement accounts, loans and deposits.","summary":"Retrieves the list of product(current/saving/loan/deposit) details","tags":[],"parameters":[{"name":"customerId","in":"query","type":"string","required":false,"description":"Identifier of the customer"},{"name":"holdingsType","in":"query","type":"string","required":false,"description":"Contains the types of customer holdings"},{"name":"holdingsId","in":"query","type":"string","required":false,"description":"Contains the identifier specific to the holding details of the customer"},{"name":"getPreferredHoldings","in":"query","type":"string","required":false,"description":"Flag to fetch the preferred holding details (JWT required)"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"ArrangementHoldingsResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse","default":"QueryErrorResponse"}},{"method":"GET","path":"/holdings/arrangements/{arrangementId}/paymentSchedules","fullPath":"/api/v1.0.0/holdings/arrangements/{arrangementId}/paymentSchedules","operationId":"getPaymentSchedule","name":"Retrieves the payment schedule of an arrangement account","summary":"Retrieves the payment schedule of an arrangement account","tags":[],"parameters":[{"name":"arrangementId","in":"path","type":"string","required":true,"description":"Indicates an unique identifier of an account"},{"name":"dateFrom","in":"query","type":"string","required":false,"description":"Start date of the loan"},{"name":"dateTo","in":"query","type":"string","required":false,"description":"End date of the loan"},{"name":"simulationReference","in":"query","type":"string","required":false,"description":"Indicates the reference id for simulation activity"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"PaymentScheduleResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse","default":"QueryErrorResponse"}},{"method":"GET","path":"/holdings/arrangements/{arrangementId}/schedules/dates","fullPath":"/api/v1.0.0/holdings/arrangements/{arrangementId}/schedules/dates","operationId":"getScheduleTypeDetails","name":"Retrieves business start and end dates for each payment type defined in payment schedule condition","summary":"Retrieves business start and end dates for each payment type","tags":["RETAIL"],"parameters":[{"name":"arrangementId","in":"path","type":"string","required":true,"description":"Indicates an unique identifier of an account"},{"name":"simulationReference","in":"query","type":"string","required":false,"description":"Indicates the reference id for simulation activity"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"ScheduleTypeDetailsResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse","default":"QueryErrorResponse"}},{"method":"GET","path":"/holdings/arrangements/{arrangementId}/noticebills","fullPath":"/api/v1.0.0/holdings/arrangements/{arrangementId}/noticebills","operationId":"getNoticeBills","name":"Retrieves the details of notice bills","summary":"Retrieves the details of notice bills","tags":["RETAIL"],"parameters":[{"name":"arrangementId","in":"path","type":"string","required":true,"description":"Indicates an unique identifier of an account"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"NoticeBillsResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse","default":"QueryErrorResponse"}}]},{"key":"holdings-arrangements-v5.0.0","title":"Arrangement details","version":"v5.0.0","description":"API to retrieve the details of arrangement conditions such as charge, interest, limits, overdue, payment schedule, agent, alerts, and commitment. This API also allows to retrieve the pricing evaluation details, product qualification details, delivery messages, payment order, events and repayment sch","endpointCount":64,"endpoints":[{"method":"GET","path":"/holdings/arrangements/activities/{arrangementActivityId}/status","fullPath":"/api/v5.0.0/holdings/arrangements/activities/{arrangementActivityId}/status","operationId":"getExternalEventStatus","name":"Retrieves the status of the given activity ","summary":"Retrieves the status of the given activity ","tags":["RETAIL"],"parameters":[{"name":"arrangementActivityId","in":"path","type":"string","required":true,"description":"Contains the arrangement activity reference identifier"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"ExternalEventStatusResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/arrangements/{arrangementId}/noticebills","fullPath":"/api/v5.0.0/holdings/arrangements/{arrangementId}/noticebills","operationId":"getNoticeBills","name":"Retrieves the details of notice bills","summary":"Retrieves the details of notice bills","tags":["RETAIL"],"parameters":[{"name":"arrangementId","in":"path","type":"string","required":true,"description":"Indicates an unique identifier of an account"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"NoticeBillsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/arrangements/{arrangementId}/totalDueAmount","fullPath":"/api/v5.0.0/holdings/arrangements/{arrangementId}/totalDueAmount","operationId":"getTotalAmountDueSummary","name":"Retrieves the summary of total amount due for a given arrangement id","summary":"Retrieves the summary of total amount due for a given arrangement id","tags":["RETAIL"],"parameters":[{"name":"arrangementId","in":"path","type":"string","required":true,"description":"Indicates an unique identifier of an account"},{"name":"balanceType","in":"query","type":"string","required":false,"description":"Type of balance (e.g. current balance, credit interest accrued, deferred commission, etc.) as defined in the institution's accounting schemas."},{"name":"displayZeroBals","in":"query","type":"string","required":false,"description":""},{"name":"simulationReference","in":"query","type":"string","required":false,"description":"Indicates the reference id for simulation activity"},{"name":"startDate","in":"query","type":"string","required":false,"description":"Contains the date on which the transaction or payment gets initiated."},{"name":"endDate","in":"query","type":"string","required":false,"description":"Indicates the date till which the transaction history requested. If 20120101 is the start date and 20120201 is the end date, all transactions that are booked between January 1 to February 1 2012 are r"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"TotalAmountDueSummaryResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/arrangements/{arrangementId}/charges","fullPath":"/api/v5.0.0/holdings/arrangements/{arrangementId}/charges","operationId":"getChargeDetails","name":"Retrieves the charge details of an account","summary":"Retrieves the charge details of an account","tags":[],"parameters":[{"name":"arrangementId","in":"path","type":"string","required":true,"description":"Indicates an unique identifier of an account"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"ChargeDetailsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/arrangements/{arrangementId}/interestRates","fullPath":"/api/v5.0.0/holdings/arrangements/{arrangementId}/interestRates","operationId":"getInterestDetails","name":"Retrieves the interest condition of an account","summary":"Retrieves the interest condition of an account","tags":[],"parameters":[{"name":"arrangementId","in":"path","type":"string","required":true,"description":"Indicates an unique identifier of an account"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"InterestDetailsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/arrangements/{arrangementId}/limits","fullPath":"/api/v5.0.0/holdings/arrangements/{arrangementId}/limits","operationId":"getLimitDetails","name":"Retrieves the limit details of an arrangement account","summary":"Retrieves the limit details of an arrangement account","tags":[],"parameters":[{"name":"arrangementId","in":"path","type":"string","required":true,"description":"Indicates an unique identifier of an account"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"LimitDetailsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/accounts/overdueStatistics","fullPath":"/api/v5.0.0/holdings/accounts/overdueStatistics","operationId":"getOverdueStatistics","name":"Retrieves the overdue details of an account","summary":"Retrieves the overdue details of an account","tags":[],"parameters":[{"name":"overdueReference","in":"query","type":"string","required":true,"description":"Indicates the overdue reference"},{"name":"overdueReference_ct","in":"query","type":"string","required":true,"description":"Indicates the criteria for the contains operation on the overdue reference"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"OverdueStatisticsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/arrangements/{arrangementId}/scheduleDefinitions","fullPath":"/api/v5.0.0/holdings/arrangements/{arrangementId}/scheduleDefinitions","operationId":"getScheduleDetails","name":"Retrieves the payment schedule details of an account","summary":"Retrieves the payment schedule details of an account","tags":[],"parameters":[{"name":"arrangementId","in":"path","type":"string","required":true,"description":"Indicates an unique identifier of an account"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"ScheduleDetailsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/arrangements/{arrangementId}/repayments","fullPath":"/api/v5.0.0/holdings/arrangements/{arrangementId}/repayments","operationId":"getRepaymentDetails","name":"Retrieves the repayment details of an account based on the payment schedule","summary":"Retrieves the repayment details of an account based on the payment schedule","tags":[],"parameters":[{"name":"arrangementId","in":"path","type":"string","required":true,"description":"Indicates an unique identifier of an account"},{"name":"simulationReference","in":"query","type":"string","required":false,"description":"Indicates the reference id for simulation activity"},{"name":"dueDate","in":"query","type":"string","required":false,"description":"Identifies the date on which the activity is due."},{"name":"includeExternalFees","in":"query","type":"string","required":false,"description":"Indicates if external fee is included"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"RepaymentDetailsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/arrangements/{arrangementId}/agents","fullPath":"/api/v5.0.0/holdings/arrangements/{arrangementId}/agents","operationId":"getAgentDetails","name":"Retrieves the agent details of an account","summary":"Retrieves the agent details of an account","tags":[],"parameters":[{"name":"arrangementId","in":"path","type":"string","required":true,"description":"Indicates an unique identifier of an account"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"AgentDetailsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/accounts/{accountNumber}/activeAlerts","fullPath":"/api/v5.0.0/holdings/accounts/{accountNumber}/activeAlerts","operationId":"getActiveAlerts","name":"Retrieves the details of active alerts for a given account number","summary":"Retrieves the details of active alerts for a given account number","tags":[],"parameters":[{"name":"accountNumber","in":"path","type":"string","required":true,"description":"Identifier of the account. Often referred to as the account number, yet for consistency this is always referred to as accountId. Accepts both IBAN & BBAN"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"ActiveAlertsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/accounts/{accountNumber}/historyAlerts","fullPath":"/api/v5.0.0/holdings/accounts/{accountNumber}/historyAlerts","operationId":"getHistoryAlerts","name":"Retrieves the details of history alerts for a given account number","summary":"Retrieves the details of history alerts for a given account number","tags":[],"parameters":[{"name":"accountNumber","in":"path","type":"string","required":true,"description":"Identifier of the account. Often referred to as the account number, yet for consistency this is always referred to as accountId. Accepts both IBAN & BBAN"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"HistoryAlertsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/arrangements/{arrangementId}/annualPercentageRates","fullPath":"/api/v5.0.0/holdings/arrangements/{arrangementId}/annualPercentageRates","operationId":"getAprDetails","name":"Retrieves the annual percentage rate of an account","summary":"Retrieves the annual percentage rate of an account","tags":[],"parameters":[{"name":"arrangementId","in":"path","type":"string","required":true,"description":"Indicates an unique identifier of an account"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"AprDetailsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/arrangements/{arrangementId}/holidayLimit","fullPath":"/api/v5.0.0/holdings/arrangements/{arrangementId}/holidayLimit","operationId":"getHolidayLimit","name":"Retrieves the details of payment holiday limit amount","summary":"Retrieves the details of payment holiday limit amount","tags":[],"parameters":[{"name":"arrangementId","in":"path","type":"string","required":true,"description":"Indicates an unique identifier of an account"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"HolidayLimitResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/arrangements/{arrangementId}/commitments","fullPath":"/api/v5.0.0/holdings/arrangements/{arrangementId}/commitments","operationId":"getCommitmentDetails","name":"Retrieves the commitment details of an account","summary":"Retrieves the commitment details of an account","tags":[],"parameters":[{"name":"arrangementId","in":"path","type":"string","required":true,"description":"Indicates an unique identifier of an account"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"CommitmentDetailsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/arrangements/{arrangementId}/qualifiers","fullPath":"/api/v5.0.0/holdings/arrangements/{arrangementId}/qualifiers","operationId":"getProductQualifierDetails","name":"Retrieves the product qualifier details of an account","summary":"Retrieves the product qualifier details of an account","tags":[],"parameters":[{"name":"arrangementId","in":"path","type":"string","required":true,"description":"Indicates an unique identifier of an account"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"ProductQualifierDetailsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/arrangements/{arrangementId}/evaluations","fullPath":"/api/v5.0.0/holdings/arrangements/{arrangementId}/evaluations","operationId":"getEvaluationDetails","name":"Retrieves the pricing evaluation details of an account.","summary":"Retrieves the pricing evaluation details of an account","tags":[],"parameters":[{"name":"arrangementId","in":"path","type":"string","required":true,"description":"Indicates an unique identifier of an account"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"EvaluationDetailsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/accounts/{arrangementId}/dates","fullPath":"/api/v5.0.0/holdings/accounts/{arrangementId}/dates","operationId":"getArrangementDates","name":"Retrieves the key dates of an account","summary":"Retrieves the key dates of an account","tags":[],"parameters":[{"name":"arrangementId","in":"path","type":"string","required":true,"description":"Indicates an unique identifier of an account"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"ArrangementDatesResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/arrangements/{arrangementId}/interestAccruals","fullPath":"/api/v5.0.0/holdings/arrangements/{arrangementId}/interestAccruals","operationId":"getInterestDetailsCurrent","name":"Retrieves the interest accrued for the current period of an account","summary":"Retrieves the interest accrued for the current period of an account","tags":[],"parameters":[{"name":"arrangementId","in":"path","type":"string","required":true,"description":"Indicates an unique identifier of an account"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"InterestDetailsCurrentResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/arrangements/{arrangementId}/historicInterestAccruals","fullPath":"/api/v5.0.0/holdings/arrangements/{arrangementId}/historicInterestAccruals","operationId":"getInterestDetailsPrevious","name":"Retrieve the past period's interest accruals","summary":"Retrieve the past period's interest accruals","tags":[],"parameters":[{"name":"arrangementId","in":"path","type":"string","required":true,"description":"Indicates an unique identifier of an account"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"InterestDetailsPreviousResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/arrangements/{arrangementId}/yearToDateInterestAccruals","fullPath":"/api/v5.0.0/holdings/arrangements/{arrangementId}/yearToDateInterestAccruals","operationId":"getInterestDetailsYearToDate","name":"Retrieves the interest accruals of the previous year","summary":"Retrieves the interest accruals of the previous year","tags":[],"parameters":[{"name":"arrangementId","in":"path","type":"string","required":true,"description":"Indicates an unique identifier of an account"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"InterestDetailsYearToDateResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/accounts/{arrangementId}/messages","fullPath":"/api/v5.0.0/holdings/accounts/{arrangementId}/messages","operationId":"getDeliveryMessages","name":"Retrieves the details of delivery messages for a given arrangement id","summary":"Retrieves the details of delivery messages for a given arrangement id","tags":[],"parameters":[{"name":"arrangementId","in":"path","type":"string","required":true,"description":"Indicates an unique identifier of an account"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"DeliveryMessagesResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/accounts/{arrangementId}/historyMessages","fullPath":"/api/v5.0.0/holdings/accounts/{arrangementId}/historyMessages","operationId":"getDeliveryMessagesHistory","name":"Retrieves the details of history delivery messages for a given arrangement id","summary":"Retrieves the details of history delivery messages for a given arrangement id","tags":[],"parameters":[{"name":"arrangementId","in":"path","type":"string","required":true,"description":"Indicates an unique identifier of an account"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"DeliveryMessagesHistoryResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/arrangements/{arrangementId}/stmtEntries","fullPath":"/api/v5.0.0/holdings/arrangements/{arrangementId}/stmtEntries","operationId":"getStmtEntries","name":"Retrieves the statement entries of an arrangement account","summary":"Retrieves the statement entries of an arrangement account","tags":[],"parameters":[{"name":"arrangementId","in":"path","type":"string","required":true,"description":"Indicates an unique identifier of an account"},{"name":"valueDate","in":"query","type":"string","required":false,"description":"Indicates the value date on which the underlying accounting entry is to be given value (for interest purposes)"},{"name":"stmtFlag","in":"query","type":"string","required":false,"description":""},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"StmtEntriesResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/arrangements/{arrangementId}/dataEvents","fullPath":"/api/v5.0.0/holdings/arrangements/{arrangementId}/dataEvents","operationId":"getArrangementPropertyConditions","name":"Retrieves the property conditions to the data events","summary":"Retrieves the property conditions","tags":[],"parameters":[{"name":"arrangementId","in":"path","type":"string","required":true,"description":"Indicates an unique identifier of an account"},{"name":"status","in":"query","type":"string","required":true,"description":"Contains status of the data rights request.Allowed values are INITIATED, INPROGESS, EXTENDED, COMPLETED, REJECTED."},{"name":"arrangementActivityId","in":"query","type":"string","required":false,"description":"Contains the arrangement activity reference identifier"},{"name":"effectiveDate","in":"query","type":"string","required":false,"description":"Contains the identifier for the transaction date. Dates are expected in \u00e2\u20ac\u02dcYYYYMMDD\u00e2\u20ac\u2122 format"},{"name":"property","in":"query","type":"string","required":false,"description":"Id of the product property"},{"name":"dataEvent","in":"query","type":"string","required":false,"description":"Indicates the data event flag"},{"name":"ofsSource","in":"query","type":"string","required":false,"description":"Indicates the source of the OFS"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"ArrangementPropertyConditionsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/arrangements/{arrangementId}/schedules","fullPath":"/api/v5.0.0/holdings/arrangements/{arrangementId}/schedules","operationId":"getSchedulesFull","name":"Retrieves the repayment schedule details for an arrangement","summary":"Retrieves the repayment schedule details for an arrangement","tags":[],"parameters":[{"name":"arrangementId","in":"path","type":"string","required":true,"description":"Indicates an unique identifier of an account"},{"name":"simulationReference","in":"query","type":"string","required":false,"description":"Indicates the reference id for simulation activity"},{"name":"dateFrom","in":"query","type":"string","required":false,"description":"Start date of the loan"},{"name":"dateTo","in":"query","type":"string","required":false,"description":"End date of the loan"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"SchedulesFullResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/arrangements/{arrangementActivityId}/simulationReferences","fullPath":"/api/v5.0.0/holdings/arrangements/{arrangementActivityId}/simulationReferences","operationId":"getSimulationReference","name":"Retrieves the simulation reference for the given arrangement activity id","summary":"Retrieves the simulation reference for the given arrangement activity id","tags":[],"parameters":[{"name":"arrangementActivityId","in":"path","type":"string","required":true,"description":"Contains the arrangement activity reference identifier"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"SimulationReferenceResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/arrangement/{arrangementId}/alerts","fullPath":"/api/v5.0.0/holdings/arrangement/{arrangementId}/alerts","operationId":"getArrangementAlerts","name":"Retrieves the list of alerts applicable for an arrangement","summary":"Retrieves the list of alerts applicable for an arrangement","tags":[],"parameters":[{"name":"arrangementId","in":"path","type":"string","required":true,"description":"Indicates an unique identifier of an account"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"ArrangementAlertsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/arrangements/{arrangementId}/simulations","fullPath":"/api/v5.0.0/holdings/arrangements/{arrangementId}/simulations","operationId":"getSimulationDetails","name":"Retrieves the simulated activity details of an account","summary":"Retrieves the simulated activity details of an account","tags":[],"parameters":[{"name":"arrangementId","in":"path","type":"string","required":true,"description":"Indicates an unique identifier of an account"},{"name":"simulationCaptureReferenceId","in":"query","type":"string","required":false,"description":"Indicates the Reference Id for the simulation activity"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"SimulationDetailsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"POST","path":"/holdings/arrangements/{arrangementId}/simulations","fullPath":"/api/v5.0.0/holdings/arrangements/{arrangementId}/simulations","operationId":"createPayoffSimulation","name":"Create simulation for an arrangement","summary":"Create simulation for an arrangement","tags":["RETAIL"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"partyIds":[{}],"properties":[{}],"contextNames":[{}],"arrangement":"string","currency":"string","productId":"string","activity":"string","effectiveDate":"string","transactionAmount":0.0,"transactionReference":"string","branch":"string","channel":"string","companyCode":"string","originalTransactionAmount":"string","lineOfBusiness":"string"}},"responses":{"200":"createPayoffSimulationResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"GET","path":"/holdings/customers/{customerId}/arrangements","fullPath":"/api/v5.0.0/holdings/customers/{customerId}/arrangements","operationId":"getCustomerArrangementDetails","name":"Retrieves the list of arrangement ids for a given customer","summary":"Retrieves the list of arrangement ids for a given customer","tags":[],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"Identifier of the customer"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"CustomerArrangementDetailsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/arrangements/{arrangementId}/chargeOffBalances","fullPath":"/api/v5.0.0/holdings/arrangements/{arrangementId}/chargeOffBalances","operationId":"getChargeOffDetails","name":"Retrieves the charge off balances of an arrangement account","summary":"Retrieves the charge off balances of an arrangement account","tags":[],"parameters":[{"name":"arrangementId","in":"path","type":"string","required":true,"description":"Indicates an unique identifier of an account"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"ChargeOffDetailsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/arrangements/{arrangementId}/consolidatedBalances","fullPath":"/api/v5.0.0/holdings/arrangements/{arrangementId}/consolidatedBalances","operationId":"getVirtualBalances","name":"Retrieves the virtual balances for a balance type of an account","summary":"Retrieves the virtual balances for a balance type of an account","tags":[],"parameters":[{"name":"arrangementId","in":"path","type":"string","required":true,"description":"Indicates an unique identifier of an account"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"VirtualBalancesResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/arrangements/{arrangementId}/activities","fullPath":"/api/v5.0.0/holdings/arrangements/{arrangementId}/activities","operationId":"getArrangementActivityLog","name":"Retrieves the activity log of an account","summary":"Retrieves the activity log of an account","tags":[],"parameters":[{"name":"arrangementId","in":"path","type":"string","required":true,"description":"Indicates an unique identifier of an account"},{"name":"simulation","in":"query","type":"string","required":false,"description":"What if scenario reference"},{"name":"startDate","in":"query","type":"string","required":false,"description":"Contains the date on which the transaction or payment gets initiated."},{"name":"endDate","in":"query","type":"string","required":false,"description":"Indicates the date till which the transaction history requested. If 20120101 is the start date and 20120201 is the end date, all transactions that are booked between January 1 to February 1 2012 are r"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"ArrangementActivityLogResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/arrangements/{arrangementId}/financialActivities","fullPath":"/api/v5.0.0/holdings/arrangements/{arrangementId}/financialActivities","operationId":"getFinancialActivities","name":"Retrieves the financial activity log of an account","summary":"Retrieves the financial activity log of an account","tags":[],"parameters":[{"name":"arrangementId","in":"path","type":"string","required":true,"description":"Indicates an unique identifier of an account"},{"name":"simulationReference","in":"query","type":"string","required":false,"description":"Indicates the reference id for simulation activity"},{"name":"startDate","in":"query","type":"string","required":false,"description":"Contains the date on which the transaction or payment gets initiated."},{"name":"endDate","in":"query","type":"string","required":false,"description":"Indicates the date till which the transaction history requested. If 20120101 is the start date and 20120201 is the end date, all transactions that are booked between January 1 to February 1 2012 are r"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"FinancialActivitiesResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/arrangements/{arrangementId}/userActivities","fullPath":"/api/v5.0.0/holdings/arrangements/{arrangementId}/userActivities","operationId":"getUserActivities","name":"Lists the user related activity logs of an account","summary":"Lists the user related activity logs of an account","tags":[],"parameters":[{"name":"arrangementId","in":"path","type":"string","required":true,"description":"Indicates an unique identifier of an account"},{"name":"simulationReference","in":"query","type":"string","required":false,"description":"Indicates the reference id for simulation activity"},{"name":"startDate","in":"query","type":"string","required":false,"description":"Contains the date on which the transaction or payment gets initiated."},{"name":"endDate","in":"query","type":"string","required":false,"description":"Indicates the date till which the transaction history requested. If 20120101 is the start date and 20120201 is the end date, all transactions that are booked between January 1 to February 1 2012 are r"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"UserActivitiesResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/arrangements/{arrangementId}/systemActivities","fullPath":"/api/v5.0.0/holdings/arrangements/{arrangementId}/systemActivities","operationId":"getSystemActivities","name":"Retrieves the system activities of an account","summary":"Retrieves the system activities of an account","tags":[],"parameters":[{"name":"arrangementId","in":"path","type":"string","required":true,"description":"Indicates an unique identifier of an account"},{"name":"simulationReference","in":"query","type":"string","required":false,"description":"Indicates the reference id for simulation activity"},{"name":"startDate","in":"query","type":"string","required":false,"description":"Contains the date on which the transaction or payment gets initiated."},{"name":"endDate","in":"query","type":"string","required":false,"description":"Indicates the date till which the transaction history requested. If 20120101 is the start date and 20120201 is the end date, all transactions that are booked between January 1 to February 1 2012 are r"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"SystemActivitiesResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/arrangements/{arrangementId}/holdActivities","fullPath":"/api/v5.0.0/holdings/arrangements/{arrangementId}/holdActivities","operationId":"getHoldActivities","name":"Retrieves the log of an activity in hold of an account","summary":"Retrieves the log of an activity in hold of an account","tags":[],"parameters":[{"name":"arrangementId","in":"path","type":"string","required":true,"description":"Indicates an unique identifier of an account"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"HoldActivitiesResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/arrangements/{arrangementId}/archievedActivities","fullPath":"/api/v5.0.0/holdings/arrangements/{arrangementId}/archievedActivities","operationId":"getArchievedActivities","name":"Retrieves the archived activity log of an account","summary":"Retrieves the archived activity log of an account","tags":[],"parameters":[{"name":"arrangementId","in":"path","type":"string","required":true,"description":"Indicates an unique identifier of an account"},{"name":"simulationReference","in":"query","type":"string","required":false,"description":"Indicates the reference id for simulation activity"},{"name":"startDate","in":"query","type":"string","required":false,"description":"Contains the date on which the transaction or payment gets initiated."},{"name":"endDate","in":"query","type":"string","required":false,"description":"Indicates the date till which the transaction history requested. If 20120101 is the start date and 20120201 is the end date, all transactions that are booked between January 1 to February 1 2012 are r"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"ArchievedActivitiesResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/arrangements/{arrangementId}/transactions","fullPath":"/api/v5.0.0/holdings/arrangements/{arrangementId}/transactions","operationId":"getAccountSummary","name":"Retrieves the transaction list for a given account number","summary":"Retrieves the transaction list for a given account number","tags":[],"parameters":[{"name":"arrangementId","in":"path","type":"string","required":true,"description":"Indicates an unique identifier of an account"},{"name":"startDate","in":"query","type":"string","required":false,"description":"Contains the date on which the transaction or payment gets initiated."},{"name":"endDate","in":"query","type":"string","required":false,"description":"Indicates the date till which the transaction history requested. If 20120101 is the start date and 20120201 is the end date, all transactions that are booked between January 1 to February 1 2012 are r"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"AccountSummaryResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/arrangements/{arrangementId}/eligibileActivities","fullPath":"/api/v5.0.0/holdings/arrangements/{arrangementId}/eligibileActivities","operationId":"getArrangementActivities","name":"Retrieves the list of activities applicable for an arrangement account","summary":"Retrieves the list of activities applicable for an arrangement account","tags":[],"parameters":[{"name":"arrangementId","in":"path","type":"string","required":true,"description":"Indicates an unique identifier of an account"},{"name":"activityId","in":"query","type":"string","required":false,"description":"Id of the activity, e.g. ACCOUNTS-CAPITALISE-ACCHARGE*CARDISSUEFEE"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"ArrangementActivitiesResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/arrangements/unapprovedArrangementActivites","fullPath":"/api/v5.0.0/holdings/arrangements/unapprovedArrangementActivites","operationId":"getUnauthorisedAAA","name":"Retrieves the list of unauthorised activities of an account","summary":"Retrieves the list of unauthorised activities of an account","tags":[],"parameters":[{"name":"customerId","in":"query","type":"string","required":false,"description":"Identifier of the customer"},{"name":"activity","in":"query","type":"string","required":false,"description":"Defines the activity to be processed against the Arrangement. The activity may be a user activity or a system generated activity."},{"name":"arrangementId","in":"query","type":"string","required":false,"description":"Indicates an unique identifier of an account"},{"name":"product","in":"query","type":"string","required":false,"description":"Contains the name of the product"},{"name":"currency","in":"query","type":"string","required":false,"description":"Identifies the currency. E.g. USD, GBP etc"},{"name":"contractId","in":"query","type":"string","required":false,"description":"Indicates the unique identifier of the transaction or contract which initiated the activity"},{"name":"transactionAmount","in":"query","type":"string","required":false,"description":"Contains the transaction amount. This is based on the currency, either local or foreign currency"},{"name":"transactionAmountLocalCurrency","in":"query","type":"string","required":false,"description":"Indicates the transaction amount in local currency"},{"name":"applicationId","in":"query","type":"string","required":false,"description":"Contains the application id of the service that has crashed due to error."},{"name":"inputter","in":"query","type":"string","required":false,"description":"The user identifier who input the transaction"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"UnauthorisedAAAResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/arrangements/{arrangementId}/bundles","fullPath":"/api/v5.0.0/holdings/arrangements/{arrangementId}/bundles","operationId":"getLinktArrDetails","name":"Retrieves the link arrangement details of an account","summary":"Retrieves the link arrangement details of an account","tags":[],"parameters":[{"name":"arrangementId","in":"path","type":"string","required":true,"description":"Indicates an unique identifier of an account"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"LinktArrDetailsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/arrangements/{arrangementId}/documents","fullPath":"/api/v5.0.0/holdings/arrangements/{arrangementId}/documents","operationId":"getTransactionDocuments","name":"Retrieves the transaction document details of a given arrangement account","summary":"Retrieves the transaction document details of a given arrangement account","tags":[],"parameters":[{"name":"arrangementId","in":"path","type":"string","required":true,"description":"Indicates an unique identifier of an account"},{"name":"transactionReference","in":"query","type":"string","required":false,"description":"Contains the identifier for the transaction in the core system"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"TransactionDocumentsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/arrangements/{arrangementId}/balances","fullPath":"/api/v5.0.0/holdings/arrangements/{arrangementId}/balances","operationId":"getArrangementBalances","name":"Retrieves the balance details for a given arrangement","summary":"Retrieves the working ,ledger and cleared balances for an arrangement","tags":[],"parameters":[{"name":"arrangementId","in":"path","type":"string","required":true,"description":""},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"ArrangementBalancesResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"DELETE","path":"/holdings/arrangementActivityId/{activityId}","fullPath":"/api/v5.0.0/holdings/arrangementActivityId/{activityId}","operationId":"reverseAccounts","name":"Deletes an arrangement on which no transactions are  posted","summary":"Deletes an arrangement on which no transactions are  posted","tags":[],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"activityId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":null,"responses":{"200":"reverseAccountsResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"GET","path":"/holdings/arrangements/{arrangementId}","fullPath":"/api/v5.0.0/holdings/arrangements/{arrangementId}","operationId":"getArrangementDetails","name":"Retrieves the details of the given arrangement such as arrangement id,account id,customer details,product details ,arrangement start date and arrangement status","summary":"Retrieves the details of an arrangement","tags":[],"parameters":[{"name":"arrangementId","in":"path","type":"string","required":true,"description":"Indicates an unique identifier of an account"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"ArrangementDetailsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/arrangements/{arrangementId}/bills","fullPath":"/api/v5.0.0/holdings/arrangements/{arrangementId}/bills","operationId":"getAllBills","name":"Retrieves the details of all the types of bills","summary":"Retrieves the details of all the types of bills","tags":[],"parameters":[{"name":"arrangementId","in":"path","type":"string","required":true,"description":"Indicates an unique identifier of an account"},{"name":"fileVersion","in":"query","type":"string","required":false,"description":"Indicates if the file is of type simulation or live"},{"name":"simulationReference","in":"query","type":"string","required":false,"description":"Indicates the reference id for simulation activity"},{"name":"paymentDate","in":"query","type":"string","required":false,"description":"Contains the date in which the payment will be sent out. Date in the format YYYYMMDD. E.g. 20191231"},{"name":"deferDate","in":"query","type":"string","required":false,"description":"Date that the payment has been deferred to"},{"name":"billedAmount","in":"query","type":"string","required":false,"description":"Indicates the bill amount"},{"name":"outstandingAmount","in":"query","type":"string","required":false,"description":"Contains the aggregate outstanding principal amount thereof after giving effect to any borrowings and prepayments or repayments of Committed Loans"},{"name":"delinquentAmount","in":"query","type":"string","required":false,"description":"Indicates the bill amount during the ageing status(Bill which crossed the due date)"},{"name":"property","in":"query","type":"string","required":false,"description":"Id of the product property"},{"name":"billStatus","in":"query","type":"string","required":false,"description":"Indicates the status of a bill(Issued,Due,Ageing,Settled)"},{"name":"settlementStatus","in":"query","type":"string","required":false,"description":"Defines the status of the settlement for the incoming MT548 swift message.The values allowed are: Waiting : pending to receive settlement status update meaning pending to receive MT548 swift message, "},{"name":"agingStatus","in":"query","type":"string","required":false,"description":"Indicates the ageing status of a bill"},{"name":"settled","in":"query","type":"string","required":false,"description":"Identifies settled transaction"},{"name":"paymentType","in":"query","type":"string","required":false,"description":"Indicates if the payment is Customer (C) type or Bank (B) type"},{"name":"billDate","in":"query","type":"string","required":false,"description":"Indicates a date on which a bill has been raised"},{"name":"billType","in":"query","type":"string","required":false,"description":"The type of payment obligation generated"},{"name":"paymentMethod","in":"query","type":"string","required":false,"description":"Method chosen to make the payment"},{"name":"infoPayType","in":"query","type":"string","required":false,"description":"Indicates a bill which is raised when a loan is paid off"},{"name":"advancePayment","in":"query","type":"string","required":false,"description":"Indicates whether advance payment made is set on an account"},{"name":"paymentIndicator","in":"query","type":"string","required":false,"description":"Indicates whether its a credit/debit type of bill"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"AllBillsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/arrangements/{arrangementId}/outstandingBills","fullPath":"/api/v5.0.0/holdings/arrangements/{arrangementId}/outstandingBills","operationId":"getOutstandingBills","name":"Retrieves the outstanding amount to be paid for an account","summary":"Retrieves the outstanding amount to be paid for an account","tags":[],"parameters":[{"name":"arrangementId","in":"path","type":"string","required":true,"description":"Indicates an unique identifier of an account"},{"name":"fileVersion","in":"query","type":"string","required":false,"description":"Indicates if the file is of type simulation or live"},{"name":"simulationReference","in":"query","type":"string","required":false,"description":"Indicates the reference id for simulation activity"},{"name":"paymentDate","in":"query","type":"string","required":false,"description":"Contains the date in which the payment will be sent out. Date in the format YYYYMMDD. E.g. 20191231"},{"name":"deferDate","in":"query","type":"string","required":false,"description":"Date that the payment has been deferred to"},{"name":"billedAmount","in":"query","type":"string","required":false,"description":"Indicates the bill amount"},{"name":"outstandingAmount","in":"query","type":"string","required":false,"description":"Contains the aggregate outstanding principal amount thereof after giving effect to any borrowings and prepayments or repayments of Committed Loans"},{"name":"delinquentAmount","in":"query","type":"string","required":false,"description":"Indicates the bill amount during the ageing status(Bill which crossed the due date)"},{"name":"property","in":"query","type":"string","required":false,"description":"Id of the product property"},{"name":"billStatus","in":"query","type":"string","required":false,"description":"Indicates the status of a bill(Issued,Due,Ageing,Settled)"},{"name":"settlementStatus","in":"query","type":"string","required":false,"description":"Defines the status of the settlement for the incoming MT548 swift message.The values allowed are: Waiting : pending to receive settlement status update meaning pending to receive MT548 swift message, "},{"name":"agingStatus","in":"query","type":"string","required":false,"description":"Indicates the ageing status of a bill"},{"name":"settled","in":"query","type":"string","required":false,"description":"Identifies settled transaction"},{"name":"paymentType","in":"query","type":"string","required":false,"description":"Indicates if the payment is Customer (C) type or Bank (B) type"},{"name":"billDate","in":"query","type":"string","required":false,"description":"Indicates a date on which a bill has been raised"},{"name":"billType","in":"query","type":"string","required":false,"description":"The type of payment obligation generated"},{"name":"paymentMethod","in":"query","type":"string","required":false,"description":"Method chosen to make the payment"},{"name":"infoPayType","in":"query","type":"string","required":false,"description":"Indicates a bill which is raised when a loan is paid off"},{"name":"advancePayment","in":"query","type":"string","required":false,"description":"Indicates whether advance payment made is set on an account"},{"name":"paymentIndicator","in":"query","type":"string","required":false,"description":"Indicates whether its a credit/debit type of bill"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"OutstandingBillsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/arrangements/{arrangementId}/deferredBills","fullPath":"/api/v5.0.0/holdings/arrangements/{arrangementId}/deferredBills","operationId":"getDeferredBills","name":"Retrieves the details of the deferred bills","summary":"Retrieves the details of the deferred bills","tags":[],"parameters":[{"name":"arrangementId","in":"path","type":"string","required":true,"description":"Indicates an unique identifier of an account"},{"name":"fileVersion","in":"query","type":"string","required":false,"description":"Indicates if the file is of type simulation or live"},{"name":"simulationReference","in":"query","type":"string","required":false,"description":"Indicates the reference id for simulation activity"},{"name":"paymentDate","in":"query","type":"string","required":false,"description":"Contains the date in which the payment will be sent out. Date in the format YYYYMMDD. E.g. 20191231"},{"name":"deferDate","in":"query","type":"string","required":false,"description":"Date that the payment has been deferred to"},{"name":"billedAmount","in":"query","type":"string","required":false,"description":"Indicates the bill amount"},{"name":"outstandingAmount","in":"query","type":"string","required":false,"description":"Contains the aggregate outstanding principal amount thereof after giving effect to any borrowings and prepayments or repayments of Committed Loans"},{"name":"delinquentAmount","in":"query","type":"string","required":false,"description":"Indicates the bill amount during the ageing status(Bill which crossed the due date)"},{"name":"property","in":"query","type":"string","required":false,"description":"Id of the product property"},{"name":"billStatus","in":"query","type":"string","required":false,"description":"Indicates the status of a bill(Issued,Due,Ageing,Settled)"},{"name":"settlementStatus","in":"query","type":"string","required":false,"description":"Defines the status of the settlement for the incoming MT548 swift message.The values allowed are: Waiting : pending to receive settlement status update meaning pending to receive MT548 swift message, "},{"name":"agingStatus","in":"query","type":"string","required":false,"description":"Indicates the ageing status of a bill"},{"name":"paymentType","in":"query","type":"string","required":false,"description":"Indicates if the payment is Customer (C) type or Bank (B) type"},{"name":"billDate","in":"query","type":"string","required":false,"description":"Indicates a date on which a bill has been raised"},{"name":"billType","in":"query","type":"string","required":false,"description":"The type of payment obligation generated"},{"name":"paymentMethod","in":"query","type":"string","required":false,"description":"Method chosen to make the payment"},{"name":"infoPayType","in":"query","type":"string","required":false,"description":"Indicates a bill which is raised when a loan is paid off"},{"name":"advancePayment","in":"query","type":"string","required":false,"description":"Indicates whether advance payment made is set on an account"},{"name":"paymentIndicator","in":"query","type":"string","required":false,"description":"Indicates whether its a credit/debit type of bill"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"DeferredBillsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/arrangements/{arrangementId}/externalBills","fullPath":"/api/v5.0.0/holdings/arrangements/{arrangementId}/externalBills","operationId":"getExternalBills","name":"Retrieves the details of the external type of bills","summary":"Retrieves the details of the external type of bills","tags":[],"parameters":[{"name":"arrangementId","in":"path","type":"string","required":true,"description":"Indicates an unique identifier of an account"},{"name":"simulationReference","in":"query","type":"string","required":false,"description":"Indicates the reference id for simulation activity"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"ExternalBillsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/arrangements/{arrangementId}/advanceBills","fullPath":"/api/v5.0.0/holdings/arrangements/{arrangementId}/advanceBills","operationId":"getAdvanceBills","name":"Retrieves the details of the advance bills","summary":"Retrieves the details of the advance bills","tags":[],"parameters":[{"name":"arrangementId","in":"path","type":"string","required":true,"description":"Indicates an unique identifier of an account"},{"name":"billStatus","in":"query","type":"string","required":false,"description":"Indicates the status of a bill(Issued,Due,Ageing,Settled)"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"AdvanceBillsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/arrangements/{arrangementId}/writeOffBills","fullPath":"/api/v5.0.0/holdings/arrangements/{arrangementId}/writeOffBills","operationId":"getWriteoffBills","name":"Retrieves the details of the write off bills","summary":"Retrieves the details of the write off bills","tags":[],"parameters":[{"name":"arrangementId","in":"path","type":"string","required":true,"description":"Indicates an unique identifier of an account"},{"name":"billStatus","in":"query","type":"string","required":true,"description":"Indicates the status of a bill(Issued,Due,Ageing,Settled)"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"WriteoffBillsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/arrangements/{arrangementId}/payOffBills","fullPath":"/api/v5.0.0/holdings/arrangements/{arrangementId}/payOffBills","operationId":"getPayoffDetails","name":"Retrieves the payoff details of an account","summary":"Retrieves the payoff details of an account","tags":[],"parameters":[{"name":"arrangementId","in":"path","type":"string","required":true,"description":"Indicates an unique identifier of an account"},{"name":"simulationReference","in":"query","type":"string","required":false,"description":"Indicates the reference id for simulation activity"},{"name":"adjustProperty","in":"query","type":"string","required":false,"description":"Indicates the interest or account or charge properties for which balances are to be captured or adjusted."},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"PayoffDetailsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/arrangements/writeOff/{arrangementId}/activities","fullPath":"/api/v5.0.0/holdings/arrangements/writeOff/{arrangementId}/activities","operationId":"getWriteOffActivitiesDetails","name":"Retrieves the details of write off bills based on activities","summary":"Retrieves the details of write off bills based on activities","tags":[],"parameters":[{"name":"arrangementId","in":"path","type":"string","required":true,"description":"Indicates an unique identifier of an account"},{"name":"fileVersion","in":"query","type":"string","required":false,"description":"Indicates if the file is of type simulation or live"},{"name":"simulationReference","in":"query","type":"string","required":false,"description":"Indicates the reference id for simulation activity"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"WriteOffActivitiesDetailsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/arrangements/{arrangementId}/settlements","fullPath":"/api/v5.0.0/holdings/arrangements/{arrangementId}/settlements","operationId":"getSettlementDetails","name":"Retrieves the settlement details for the given arrangement such as payment type, payin account, payin percentage, payin amount, payout account, payout percentage, payout amount, etc","summary":"Retrieves settlement details for the given arrangement","tags":["RETAIL"],"parameters":[{"name":"arrangementId","in":"path","type":"string","required":true,"description":"Indicates an unique identifier of an account"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"SettlementDetailsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/arrangements/{arrangementId}/paymentHolidays","fullPath":"/api/v5.0.0/holdings/arrangements/{arrangementId}/paymentHolidays","operationId":"getPaymentHoliday","name":"Retrieves payment holiday details for the given arrangement such as payment type, holiday date, original payment amount and new payment amount","summary":"Retrieves payment holiday details for the given arrangement","tags":["RETAIL"],"parameters":[{"name":"arrangementId","in":"path","type":"string","required":true,"description":"Indicates an unique identifier of an account"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"PaymentHolidayResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/arrangements/simulations/{simulationId}/schedules","fullPath":"/api/v5.0.0/holdings/arrangements/simulations/{simulationId}/schedules","operationId":"getSchedulesSim","name":"Retrieves the repayment schedule details for an arrangement with simulation reference number","summary":"Retrieves the repayment schedule details for an arrangement with simulation reference number","tags":["RETAIL"],"parameters":[{"name":"simulationId","in":"path","type":"string","required":true,"description":"Indicates the Id generated during the simulation of an activity"},{"name":"arrangementId","in":"query","type":"string","required":false,"description":"Indicates an unique identifier of an account"},{"name":"dateFrom","in":"query","type":"string","required":false,"description":"Start date of the loan"},{"name":"dateTo","in":"query","type":"string","required":false,"description":"End date of the loan"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"SchedulesSimResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/transactions","fullPath":"/api/v5.0.0/holdings/transactions","operationId":"getArrangementTransactionsList","name":"Retrieves the details of account transaction","summary":"Retrieves account transaction","tags":[],"parameters":[{"name":"accountId","in":"query","type":"string","required":false,"description":"Identifier of the account. Often referred to as the account number, yet for consistency this is always referred to as accountId. Accepts both IBAN & BBAN"},{"name":"customerId","in":"query","type":"string","required":false,"description":"Identifier of the customer"},{"name":"listType","in":"query","type":"string","required":true,"description":"Indicates the transaction search type"},{"name":"transactionCount","in":"query","type":"string","required":false,"description":"Indicates the total number of transactions"},{"name":"payType","in":"query","type":"string","required":false,"description":"Indicates the identifier of payment types for  letter of credit."},{"name":"dateFrom","in":"query","type":"string","required":false,"description":"Start date of the loan"},{"name":"dateTo","in":"query","type":"string","required":false,"description":"End date of the loan"},{"name":"minimumAmount","in":"query","type":"string","required":false,"description":"The minimum account balance required."},{"name":"maximumAmount","in":"query","type":"string","required":false,"description":"The maximum account balance allowed."},{"name":"displayName","in":"query","type":"string","required":false,"description":"Contains the name used for display or enrichment purposes"},{"name":"transactionCode","in":"query","type":"string","required":false,"description":"Identifies the system internal transaction code applicable to the transaction"},{"name":"entryReference","in":"query","type":"string","required":false,"description":"It is the transaction reference. This is the identifier of the transaction on Temenos Core Banking system."},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"ArrangementTransactionsListResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/customers","fullPath":"/api/v5.0.0/holdings/customers","operationId":"getArrangementHoldings","name":"Retrieves the list of customer holdings details, such as arrangement accounts, loans and deposits.","summary":"Retrieves the list of product(Current/Saving/Loan/Deposit) details","tags":[],"parameters":[{"name":"customerId","in":"query","type":"string","required":false,"description":"Identifier of the customer"},{"name":"holdingsType","in":"query","type":"string","required":false,"description":"Contains the types of customer holdings"},{"name":"holdingsId","in":"query","type":"string","required":false,"description":"Contains the identifier specific to the holding details of the customer"},{"name":"getPreferredHoldings","in":"query","type":"string","required":false,"description":"Flag to fetch the preferred holding details (JWT required)"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"ArrangementHoldingsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/arrangements/{arrangementId}/paymentSchedules","fullPath":"/api/v5.0.0/holdings/arrangements/{arrangementId}/paymentSchedules","operationId":"getPaymentSchedule","name":"Retrieves the payment schedule of an arrangement account","summary":"Retrieves the payment schedule of an arrangement account","tags":[],"parameters":[{"name":"arrangementId","in":"path","type":"string","required":true,"description":"Indicates an unique identifier of an account"},{"name":"dateFrom","in":"query","type":"string","required":false,"description":"Start date of the loan"},{"name":"dateTo","in":"query","type":"string","required":false,"description":"End date of the loan"},{"name":"simulationReference","in":"query","type":"string","required":false,"description":"Indicates the reference id for simulation activity"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"PaymentScheduleResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/arrangements/{arrangementId}/schedules/dates","fullPath":"/api/v5.0.0/holdings/arrangements/{arrangementId}/schedules/dates","operationId":"getScheduleTypeDetails","name":"Retrieves business start and end dates for each payment type defined in payment schedule condition","summary":"Retrieves business start and end dates for each payment type","tags":["RETAIL"],"parameters":[{"name":"arrangementId","in":"path","type":"string","required":true,"description":"Indicates an unique identifier of an account"},{"name":"simulationReference","in":"query","type":"string","required":false,"description":"Indicates the reference id for simulation activity"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"ScheduleTypeDetailsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"PUT","path":"/holdings/arrangements/simulations/{simulationRunReference}","fullPath":"/api/v5.0.0/holdings/arrangements/simulations/{simulationRunReference}","operationId":"amendSimulationRunner","name":"Amend the simulation runner by inserting the given simulation capture id","summary":"Amend the simulation runner","tags":["RETAIL"],"parameters":[{"name":"simulationRunReference","in":"path","type":"string","required":true,"description":"Indicates the runner Reference ID for simulation activity"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"captureIds":[{}],"execution":"string","arrangementId":"string","extensions":{}}},"responses":{"200":"SimulationRunnerResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/holdings/arrangements/{arrangementid}/customers","fullPath":"/api/v5.0.0/holdings/arrangements/{arrangementid}/customers","operationId":"getCustomerDetail","name":"Retrieves all the customer details for the given arrangement such as customer id, customer name, customer role, their beneficiary type, limit allocation percentage, GL allocation percentage and tax liability percentage.","summary":"Retrieves the customer details for the given arrangement","tags":["RETAIL"],"parameters":[{"name":"arrangementid","in":"path","type":"string","required":true,"description":""},{"name":"arrangementId","in":"query","type":"string","required":true,"description":"Indicates an unique identifier of an account"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"CustomerDetailResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}}]},{"key":"holdings-assetfinance-service-v1.0.0","title":"assetFinance","version":"v1.0.0","description":"API's to create and manage asset finance agreement for SME customers","endpointCount":11,"endpoints":[{"method":"POST","path":"/holdings/assetFinance/operatingLeases","fullPath":"/api/v1.0.0/holdings/assetFinance/operatingLeases","operationId":"createOperatingLeaseAgreement","name":"Creation of operating lease agreement  with details of currency, finance amount, tenor and settlement instructions.","summary":"Creates an operating lease agreement.","tags":["RETAIL"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"party":[{}],"agreementId":"string","currency":"string","branchId":"string","lineOfBusinessId":"string","channelId":"string","dealDate":"2024-01-01","effectiveDate":"2024-01-01","activity":"string","productId":"string","extensions":{},"leaseprincipal":[{}],"customer":[{}],"leaseint":[{}],"leasepenalty":[{}]}},"responses":{"200":"createOperatingLeaseAgreementResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"POST","path":"/holdings/assetFinance/hirePurchases","fullPath":"/api/v1.0.0/holdings/assetFinance/hirePurchases","operationId":"createHirePurchaseAgreement","name":"Creation of hire purchase agreement  with details of currency, finance amount, tenor and settlement instructions.","summary":"Creates a hire purchase agreement.","tags":["RETAIL"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"party":[{}],"agreementId":"string","currency":"string","branchId":"string","lineOfBusinessId":"string","channelId":"string","dealDate":"2024-01-01","effectiveDate":"2024-01-01","activity":"string","productId":"string","extensions":{},"leaseprincipal":[{}],"customer":[{}],"leaseint":[{}],"leasepenalty":[{}]}},"responses":{"200":"createHirePurchaseAgreementResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"POST","path":"/holdings/assetFinance/financeLeases","fullPath":"/api/v1.0.0/holdings/assetFinance/financeLeases","operationId":"createFinanceLeaseAgreement","name":"Creation of finance lease agreement  with details of currency, finance amount, tenor and settlement instructions","summary":"Creates a finance lease agreement.","tags":["RETAIL"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"party":[{}],"agreementId":"string","currency":"string","branchId":"string","lineOfBusinessId":"string","channelId":"string","dealDate":"2024-01-01","effectiveDate":"2024-01-01","activity":"string","productId":"string","extensions":{},"leaseprincipal":[{}],"customer":[{}],"leaseint":[{}],"leasepenalty":[{}]}},"responses":{"200":"createFinanceLeaseAgreementResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"POST","path":"/holdings/assetFinance/agreements/{agreementId}/activations","fullPath":"/api/v1.0.0/holdings/assetFinance/agreements/{agreementId}/activations","operationId":"activateAgreement","name":"Activation of an asset finance agreement. This action marks that the asset is delivered to the lessee and the contract terms are initiated.","summary":"Activates of an asset finance agreement.","tags":["RETAIL"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"agreementId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"agreementId":"string","effectiveDate":"2024-01-01","activity":"string","extensions":{}}},"responses":{"200":"activateAgreementResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"POST","path":"/holdings/assetFinance/agreements/{agreementId}/cancellations","fullPath":"/api/v1.0.0/holdings/assetFinance/agreements/{agreementId}/cancellations","operationId":"cancelAgreement","name":"Cancellation of an asset finance agreement. The lessor/lessee can cancel the agreement before the agreed date of activation.","summary":"Cancels an asset finance agreement.","tags":["RETAIL"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"agreementId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"agreementId":"string","effectiveDate":"2024-01-01","activity":"string","extensions":{}}},"responses":{"200":"cancelAgreementResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"POST","path":"/holdings/assetFinance/agreements/{agreementId}/parties","fullPath":"/api/v1.0.0/holdings/assetFinance/agreements/{agreementId}/parties","operationId":"updateParties","name":"Change the parties involved in the asset finance agreement. The parties, simply are the customers acting as a lessee, guarantor or joint lessee.","summary":"Change asset finance agreement parties.","tags":["RETAIL"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"agreementId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"agreementId":"string","effectiveDate":"2024-01-01","activity":"string","extensions":{},"customer":[{}]}},"responses":{"200":"updatePartiesResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"POST","path":"/holdings/assetFinance/agreements/{agreementId}/settlementInstructions","fullPath":"/api/v1.0.0/holdings/assetFinance/agreements/{agreementId}/settlementInstructions","operationId":"updateSettlement","name":"Update the settlement instructions of the customer in order to transact with the asset finance agreement.","summary":"Change standard settlement instructions.","tags":["RETAIL"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"agreementId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"agreementId":"string","effectiveDate":"2024-01-01","activity":"string","extensions":{},"settlement":[{}]}},"responses":{"200":"updateSettlementResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"POST","path":"/holdings/assetFinance/agreements/{agreementId}/officers","fullPath":"/api/v1.0.0/holdings/assetFinance/agreements/{agreementId}/officers","operationId":"updateOfficers","name":"Change the relationship/account officers who is dealing with the lessee's agreement.","summary":"Change officers assigned to the asset finance agreement.","tags":["RETAIL"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"agreementId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"agreementId":"string","effectiveDate":"2024-01-01","activity":"string","extensions":{},"officers":[{}]}},"responses":{"200":"updateOfficersResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"GET","path":"/holdings/assetFinance/agreements/{agreementId}","fullPath":"/api/v1.0.0/holdings/assetFinance/agreements/{agreementId}","operationId":"getBasicAgreementDetails","name":"Retrieve the basic details of an asset finance agreement such as account id, title, asset reference, maturity date, payment amount  and status.","summary":"Retrieve the asset finance agreement details","tags":["RETAIL"],"parameters":[{"name":"agreementId","in":"path","type":"string","required":true,"description":"Specifies the unique identifier of an asset finance arrangement."},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"BasicAgreementDetailsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/assetFinance/customers/{customerId}/agreements","fullPath":"/api/v1.0.0/holdings/assetFinance/customers/{customerId}/agreements","operationId":"getAgreements","name":"Retrieve all the asset finance agreements of a customer.","summary":"Retrieve all the asset finance agreements of a customer.","tags":["RETAIL"],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"Identifier of the customer"},{"name":"agreementId","in":"query","type":"string","required":false,"description":"Specifies the unique identifier of an asset finance arrangement."},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"AgreementsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/assetFinance/agreements/{agreementId}/payments/{scheduleOption}","fullPath":"/api/v1.0.0/holdings/assetFinance/agreements/{agreementId}/payments/{scheduleOption}","operationId":"getRepaymentSchedule","name":"Retrieve the repayment schedule of the asset finance agreement like payments and payment dates. The options for Keyword - FULL, NEXT. FULL retrieves the full repayment schedule. NEXT retrieves the next payment schedule.","summary":"Retrieve the repayment schedule of the asset finance agreement like payments and payment dates.","tags":["RETAIL"],"parameters":[{"name":"agreementId","in":"path","type":"string","required":true,"description":"Specifies the unique identifier of an asset finance arrangement."},{"name":"scheduleOption","in":"path","type":"string","required":true,"description":"Specifies if the the next or full schedule to be displayed. The available options are FULL, NEXT. FULL retrieves the full repayment schedule. NEXT retrieves the next payment schedule."},{"name":"dateFrom","in":"query","type":"string","required":false,"description":"Start date of the loan"},{"name":"dateTo","in":"query","type":"string","required":false,"description":"End date of the loan"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"RepaymentScheduleResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}}]},{"key":"holdings-assetfinance-service-v1.1.0","title":"assetFinance","version":"v1.1.0","description":"API's to create and manage asset finance agreement for SME customers","endpointCount":12,"endpoints":[{"method":"POST","path":"/holdings/assetFinance/operatingLeases","fullPath":"/api/v1.1.0/holdings/assetFinance/operatingLeases","operationId":"createOperatingLeaseAgreement","name":"Creation of operating lease agreement  with details of currency, finance amount, tenor and settlement instructions.","summary":"Creates an operating lease agreement.","tags":["RETAIL"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"party":[{}],"agreementId":"string","currency":"string","branchId":"string","lineOfBusinessId":"string","channelId":"string","dealDate":"2024-01-01","effectiveDate":"2024-01-01","activity":"string","productId":"string","extensions":{},"leaseprincipal":[{}],"customer":[{}],"leaseint":[{}],"leasepenalty":[{}]}},"responses":{"200":"createOperatingLeaseAgreementResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"POST","path":"/holdings/assetFinance/hirePurchases","fullPath":"/api/v1.1.0/holdings/assetFinance/hirePurchases","operationId":"createHirePurchaseAgreement","name":"Creation of hire purchase agreement  with details of currency, finance amount, tenor and settlement instructions.","summary":"Creates a hire purchase agreement.","tags":["RETAIL"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"party":[{}],"agreementId":"string","currency":"string","branchId":"string","lineOfBusinessId":"string","channelId":"string","dealDate":"2024-01-01","effectiveDate":"2024-01-01","activity":"string","productId":"string","extensions":{},"leaseprincipal":[{}],"customer":[{}],"leaseint":[{}],"leasepenalty":[{}]}},"responses":{"200":"createHirePurchaseAgreementResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"POST","path":"/holdings/assetFinance/financeLeases","fullPath":"/api/v1.1.0/holdings/assetFinance/financeLeases","operationId":"createFinanceLeaseAgreement","name":"Creation of finance lease agreement  with details of currency, finance amount, tenor and settlement instructions","summary":"Creates a finance lease agreement.","tags":["RETAIL"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"party":[{}],"agreementId":"string","currency":"string","branchId":"string","lineOfBusinessId":"string","channelId":"string","dealDate":"2024-01-01","effectiveDate":"2024-01-01","activity":"string","productId":"string","extensions":{},"leaseprincipal":[{}],"customer":[{}],"leaseint":[{}],"leasepenalty":[{}]}},"responses":{"200":"createFinanceLeaseAgreementResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"POST","path":"/holdings/assetFinance/agreements/{agreementId}/activations","fullPath":"/api/v1.1.0/holdings/assetFinance/agreements/{agreementId}/activations","operationId":"activateAgreement","name":"Activation of an asset finance agreement. This action marks that the asset is delivered to the lessee and the contract terms are initiated.","summary":"Activates an asset finance agreement.","tags":["RETAIL"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"agreementId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"agreementId":"string","effectiveDate":"2024-01-01","activity":"string","extensions":{}}},"responses":{"200":"activateAgreementResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"POST","path":"/holdings/assetFinance/agreements/{agreementId}/cancellations","fullPath":"/api/v1.1.0/holdings/assetFinance/agreements/{agreementId}/cancellations","operationId":"cancelAgreement","name":"Cancellation of an asset finance agreement. The lessor/lessee can cancel the agreement before the agreed date of activation.","summary":"Cancels an asset finance agreement.","tags":["RETAIL"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"agreementId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"agreementId":"string","effectiveDate":"2024-01-01","activity":"string","extensions":{}}},"responses":{"200":"cancelAgreementResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"POST","path":"/holdings/assetFinance/agreements/{agreementId}/parties","fullPath":"/api/v1.1.0/holdings/assetFinance/agreements/{agreementId}/parties","operationId":"updateParties","name":"Change the parties involved in the asset finance agreement. The parties, simply are the customers acting as a lessee, guarantor or joint lessee.","summary":"Change asset finance agreement parties.","tags":["RETAIL"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"agreementId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"agreementId":"string","effectiveDate":"2024-01-01","activity":"string","extensions":{},"customer":[{}]}},"responses":{"200":"updatePartiesResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"POST","path":"/holdings/assetFinance/agreements/{agreementId}/settlementInstructions","fullPath":"/api/v1.1.0/holdings/assetFinance/agreements/{agreementId}/settlementInstructions","operationId":"updateSettlement","name":"Update the settlement instructions of the customer in order to transact with the asset finance agreement.","summary":"Change standard settlement instructions.","tags":["RETAIL"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"agreementId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"agreementId":"string","effectiveDate":"2024-01-01","activity":"string","extensions":{},"settlement":[{}]}},"responses":{"200":"updateSettlementResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"POST","path":"/holdings/assetFinance/agreements/{agreementId}/officers","fullPath":"/api/v1.1.0/holdings/assetFinance/agreements/{agreementId}/officers","operationId":"updateOfficers","name":"Change the relationship/account officers who is dealing with the lessee's agreement.","summary":"Change officers assigned to the asset finance agreement.","tags":["RETAIL"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"agreementId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"agreementId":"string","effectiveDate":"2024-01-01","activity":"string","extensions":{},"officers":[{}]}},"responses":{"200":"updateOfficersResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"GET","path":"/holdings/assetFinance/agreements/{agreementId}","fullPath":"/api/v1.1.0/holdings/assetFinance/agreements/{agreementId}","operationId":"getBasicAgreementDetails","name":"Retrieve the basic details of an asset finance agreement such as account id, title, asset reference, maturity date, payment amount  and status.","summary":"Retrieve the asset finance agreement details","tags":["RETAIL"],"parameters":[{"name":"agreementId","in":"path","type":"string","required":true,"description":"Specifies the unique identifier of an asset finance arrangement."},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"BasicAgreementDetailsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/assetFinance/customers/{customerId}/agreements","fullPath":"/api/v1.1.0/holdings/assetFinance/customers/{customerId}/agreements","operationId":"getAgreements","name":"Retrieve all the asset finance agreements of a customer.","summary":"Retrieve all the asset finance agreements of a customer.","tags":["RETAIL"],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"Identifier of the customer"},{"name":"agreementId","in":"query","type":"string","required":false,"description":"Specifies the unique identifier of an asset finance arrangement."},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"AgreementsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"POST","path":"/holdings/assetFinance/agreements/{agreementId}/repayments/outstandingBills","fullPath":"/api/v1.1.0/holdings/assetFinance/agreements/{agreementId}/repayments/outstandingBills","operationId":"initiateOutstandingBillsRepayment","name":"Repayment of outstanding bills of an asset finance agreement which are due for payment.","summary":"Performs repayment of outstanding invoices.","tags":["RETAIL"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"agreementId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"agreementId":"string","effectiveDate":"2024-01-01","activity":"string","transactionAmount":"string","currency":"string","extensions":{},"settlement":[{}]}},"responses":{"200":"initiateOutstandingBillsRepaymentResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"GET","path":"/holdings/assetFinance/agreements/{agreementId}/payments/{scheduleOption}","fullPath":"/api/v1.1.0/holdings/assetFinance/agreements/{agreementId}/payments/{scheduleOption}","operationId":"getRepaymentSchedule","name":"Retrieve the repayment schedule of the asset finance agreement like payments and payment dates. The options for Keyword - FULL, NEXT. FULL retrieves the full repayment schedule. NEXT retrieves the next payment schedule.","summary":"Retrieve the repayment schedule of the asset finance agreement like payments and payment dates.","tags":["RETAIL"],"parameters":[{"name":"agreementId","in":"path","type":"string","required":true,"description":"Specifies the unique identifier of an asset finance arrangement."},{"name":"scheduleOption","in":"path","type":"string","required":true,"description":"Specifies if the the next or full schedule to be displayed. The available options are FULL, NEXT. FULL retrieves the full repayment schedule. NEXT retrieves the next payment schedule."},{"name":"dateFrom","in":"query","type":"string","required":false,"description":"Start date of the loan"},{"name":"dateTo","in":"query","type":"string","required":false,"description":"End date of the loan"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"RepaymentScheduleResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}}]},{"key":"holdings-bundles-v1.0.0","title":"bundle Creation","version":"v1.0.0","description":"Create and manage bundle accounts","endpointCount":1,"endpoints":[{"method":"POST","path":"/holdings/bundles","fullPath":"/api/v1.0.0/holdings/bundles","operationId":"createBundleAccounts","name":" Create a product bundle with linking of one or more related accounts.Bundling of the accounts are for operational and financial benefits for the holder like charge waive off, interest offset etc. Bundle creation involves defining donor account, recipient account and master account for a given customer.","summary":"Create a product bundle with linking of one or more related accounts","tags":["RETAIL"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"customerIds":[{}],"properties":[{}],"overrides":[{}],"productId":"string","masterArrangementId":"string","roleName":"string","currencyId":"string","effectiveDate":"2024-01-01","activityId":"string","transactionAmount":0.0,"reason":"string","simulationRunReference":"string","channel":"string","branch":"string","extensions":{}}},"responses":{"200":"createBundleAccountsResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}}]},{"key":"holdings-ca-account-service-v1.0.0","title":"Account Management","version":"v1.0.0","description":"Retrieve the details of accounts associated to the card along with product information. Card id is required as a mandatory information while channel id is an optional to retrieve the account details.","endpointCount":2,"endpoints":[{"method":"GET","path":"/holdings/ca/customers/{customerId}/accounts","fullPath":"/api/v1.0.0/holdings/ca/customers/{customerId}/accounts","operationId":"getCaAccountSummary","name":"Retrieve the details of accounts associated to the card along with product information based on customer Id.","summary":"Retrieve the details of accounts associated to the customer","tags":["RETAIL"],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"Identifier of the customer"},{"name":"cardId","in":"query","type":"string","required":false,"description":"Contains the card identification number which consists of card type and unique card number. example MEMC-12345678."},{"name":"currencyId","in":"query","type":"string","required":false,"description":"Identifier of the currency. This is the 3-letter ISO 4217 code of the currency."},{"name":"accountId","in":"query","type":"string","required":false,"description":"Identifier of the account. Often referred to as the account number, yet for consistency this is always referred to as accountId. Accepts both IBAN & BBAN"},{"name":"productId","in":"query","type":"string","required":false,"description":"Contains the unique identifier of the product, e.g. the product id of the arrangement account."},{"name":"channelId","in":"query","type":"string","required":false,"description":"Id of the (digital) channel"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"CaAccountSummaryResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/ca/cards/{cardId}/accounts","fullPath":"/api/v1.0.0/holdings/ca/cards/{cardId}/accounts","operationId":"getCaCardAccountSummary","name":"Retrieve the details of accounts associated to the card along with product information based on card number.","summary":"Retrieve the details of accounts associated to the card","tags":["RETAIL"],"parameters":[{"name":"cardId","in":"path","type":"string","required":true,"description":"Contains the card identification number which consists of card type and unique card number. example MEMC-12345678."},{"name":"currencyId","in":"query","type":"string","required":false,"description":"Identifier of the currency. This is the 3-letter ISO 4217 code of the currency."},{"name":"accountId","in":"query","type":"string","required":false,"description":"Identifier of the account. Often referred to as the account number, yet for consistency this is always referred to as accountId. Accepts both IBAN & BBAN"},{"name":"productId","in":"query","type":"string","required":false,"description":"Contains the unique identifier of the product, e.g. the product id of the arrangement account."},{"name":"customerId","in":"query","type":"string","required":false,"description":"Identifier of the customer"},{"name":"channelId","in":"query","type":"string","required":false,"description":"Id of the (digital) channel"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"CaCardAccountSummaryResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}}]},{"key":"holdings-ca-account-service-v2.0.0","title":"Account Management","version":"v2.0.0","description":"API to retrieve the details of the accounts associated to the card/customer and cheque payment details","endpointCount":6,"endpoints":[{"method":"GET","path":"/holdings/ca/customers/{customerId}/accounts","fullPath":"/api/v2.0.0/holdings/ca/customers/{customerId}/accounts","operationId":"getCaAccountSummary","name":"Retrieve the details of accounts associated to the card along with product information based on customer Id.","summary":"Retrieve the details of accounts associated to the customer","tags":["RETAIL"],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"Identifier of the customer"},{"name":"cardId","in":"query","type":"string","required":false,"description":"Contains the card identification number which consists of card type and unique card number. example MEMC-12345678."},{"name":"currencyId","in":"query","type":"string","required":false,"description":"Identifier of the currency. This is the 3-letter ISO 4217 code of the currency."},{"name":"accountId","in":"query","type":"string","required":false,"description":"Identifier of the account. Often referred to as the account number, yet for consistency this is always referred to as accountId. Accepts both IBAN & BBAN"},{"name":"productId","in":"query","type":"string","required":false,"description":"Contains the unique identifier of the product, e.g. the product id of the arrangement account."},{"name":"channelId","in":"query","type":"string","required":false,"description":"Id of the (digital) channel"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"CaAccountSummaryResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/ca/cards/{cardId}/accounts","fullPath":"/api/v2.0.0/holdings/ca/cards/{cardId}/accounts","operationId":"getCaCardAccountSummary","name":"Retrieve the details of accounts associated to the card along with product information based on card number.","summary":"Retrieve the details of accounts associated to the card","tags":["RETAIL"],"parameters":[{"name":"cardId","in":"path","type":"string","required":true,"description":"Contains the card identification number which consists of card type and unique card number. example MEMC-12345678."},{"name":"currencyId","in":"query","type":"string","required":false,"description":"Identifier of the currency. This is the 3-letter ISO 4217 code of the currency."},{"name":"accountId","in":"query","type":"string","required":false,"description":"Identifier of the account. Often referred to as the account number, yet for consistency this is always referred to as accountId. Accepts both IBAN & BBAN"},{"name":"productId","in":"query","type":"string","required":false,"description":"Contains the unique identifier of the product, e.g. the product id of the arrangement account."},{"name":"customerId","in":"query","type":"string","required":false,"description":"Identifier of the customer"},{"name":"channelId","in":"query","type":"string","required":false,"description":"Id of the (digital) channel"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"CaCardAccountSummaryResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/ca/accounts/{accountId}/cheques","fullPath":"/api/v2.0.0/holdings/ca/accounts/{accountId}/cheques","operationId":"getCaChequePaymentDetails","name":"Retrieve the cheque details such as cheque amount, cheque date, cheque number for a particular member's account number. Mandatory selection is account number and optional selection is amount","summary":"Retrieve the cheque payment details","tags":["RETAIL"],"parameters":[{"name":"accountId","in":"path","type":"string","required":true,"description":"Identifier of the account. Often referred to as the account number, yet for consistency this is always referred to as accountId. Accepts both IBAN & BBAN"},{"name":"chequeAmount","in":"query","type":"string","required":false,"description":"Amount of the cheque"},{"name":"fromDate","in":"query","type":"string","required":false,"description":"Indicates the business date from when the balance reservation event is active."},{"name":"toDate","in":"query","type":"string","required":false,"description":"Indicates the business date until when the balance reservation event is active."},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"CaChequePaymentDetailsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/ca/accounts/{accountId}","fullPath":"/api/v2.0.0/holdings/ca/accounts/{accountId}","operationId":"getCaAccountDetails","name":"Retrieves the static and financial details of the demand account such as interest, currency, balance, etc","summary":"Retrieves the product information of demand account","tags":["RETAIL"],"parameters":[{"name":"accountId","in":"path","type":"string","required":true,"description":"Identifier of the account. Often referred to as the account number, yet for consistency this is always referred to as accountId. Accepts both IBAN & BBAN"},{"name":"customerId","in":"query","type":"string","required":false,"description":"Identifier of the customer"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"CaAccountDetailsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/ca/customers/accounts/{accountId}","fullPath":"/api/v2.0.0/holdings/ca/customers/accounts/{accountId}","operationId":"getCaAccountSummaryByAccount","name":"Retrieve the details of account along with product information based on account id","summary":"Retrieve the details of account","tags":["RETAIL"],"parameters":[{"name":"accountId","in":"path","type":"string","required":true,"description":"Identifier of the account. Often referred to as the account number, yet for consistency this is always referred to as accountId. Accepts both IBAN & BBAN"},{"name":"cardId","in":"query","type":"string","required":false,"description":"Contains the card identification number which consists of card type and unique card number. example MEMC-12345678."},{"name":"currencyId","in":"query","type":"string","required":false,"description":"Identifier of the currency. This is the 3-letter ISO 4217 code of the currency."},{"name":"productId","in":"query","type":"string","required":false,"description":"Contains the unique identifier of the product, e.g. the product id of the arrangement account."},{"name":"customerId","in":"query","type":"string","required":false,"description":"Identifier of the customer"},{"name":"channelId","in":"query","type":"string","required":false,"description":"Id of the (digital) channel"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"CaAccountSummaryByAccountResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/ca/accounts/{accountId}/statements/{fromDate}/{toDate}","fullPath":"/api/v2.0.0/holdings/ca/accounts/{accountId}/statements/{fromDate}/{toDate}","operationId":"getCaAccountStatement","name":"Retrieve the statements for the given account with specified date range through online banking","summary":"Retrieve the statements for the given account with specified date range through online banking","tags":["RETAIL"],"parameters":[{"name":"accountId","in":"path","type":"string","required":true,"description":"Identifier of the account. Often referred to as the account number, yet for consistency this is always referred to as accountId. Accepts both IBAN & BBAN"},{"name":"fromDate","in":"path","type":"string","required":true,"description":"Indicates the business date from when the balance reservation event is active."},{"name":"toDate","in":"path","type":"string","required":true,"description":"Indicates the business date until when the balance reservation event is active."},{"name":"retrievalOption","in":"query","type":"string","required":true,"description":"Indicates whether the transactions in the statement to be sorted from oldest(D) or latest(L). Possible values are L or D "},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"CaAccountStatementResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}}]},{"key":"holdings-ca-account-service-v4.0.0","title":"Account Management","version":"v4.0.0","description":"API to create/update accounts,to retrieve the details of the accounts associated to the card/customer and cheque payment details","endpointCount":8,"endpoints":[{"method":"GET","path":"/holdings/ca/accounts/{accountId}/cheques","fullPath":"/api/v4.0.0/holdings/ca/accounts/{accountId}/cheques","operationId":"getCaChequePaymentDetails","name":"Retrieve the cheque details such as cheque amount, cheque date, cheque number for a particular member's account number. Mandatory selection is account number and optional selection is amount","summary":"Retrieve the cheque payment details","tags":["RETAIL"],"parameters":[{"name":"accountId","in":"path","type":"string","required":true,"description":"Identifier of the account. Often referred to as the account number, yet for consistency this is always referred to as accountId. Accepts both IBAN & BBAN"},{"name":"chequeAmount","in":"query","type":"string","required":false,"description":"Amount of the cheque"},{"name":"fromDate","in":"query","type":"string","required":false,"description":"Indicates the business date from when the balance reservation event is active."},{"name":"toDate","in":"query","type":"string","required":false,"description":"Indicates the business date until when the balance reservation event is active."},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"CaChequePaymentDetailsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/ca/accounts/{accountId}/statements/{fromDate}/{toDate}","fullPath":"/api/v4.0.0/holdings/ca/accounts/{accountId}/statements/{fromDate}/{toDate}","operationId":"getCaAccountStatement","name":"Retrieve the statements for the given account with specified date range through online banking","summary":"Retrieve the statements for the given account with specified date range through online banking","tags":["RETAIL"],"parameters":[{"name":"accountId","in":"path","type":"string","required":true,"description":"Identifier of the account. Often referred to as the account number, yet for consistency this is always referred to as accountId. Accepts both IBAN & BBAN"},{"name":"fromDate","in":"path","type":"string","required":true,"description":"Indicates the business date from when the balance reservation event is active."},{"name":"toDate","in":"path","type":"string","required":true,"description":"Indicates the business date until when the balance reservation event is active."},{"name":"retrievalOption","in":"query","type":"string","required":true,"description":"Indicates whether the transactions in the statement to be sorted from oldest(D) or latest(L). Possible values are L or D "},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"CaAccountStatementResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"POST","path":"/holdings/ca/accounts/","fullPath":"/api/v4.0.0/holdings/ca/accounts/","operationId":"createCaAaAccount","name":"API to Create new accounts such as savings account, current account, demand account, etc","summary":"Create a new account from API","tags":["RETAIL"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"properties":[{}],"overrides":[{}],"reasons":[{}],"partyIds":[{}],"partyRoles":[{}],"agentCustomerIds":[{}],"agentArrangementIds":[{}],"agentRoles":[{}],"masterArrangementId":"string","roleName":"string","transactionAmount":"string","simulationRunReference":"string","productId":"string","activityId":"string","currency":"string"}},"responses":{"200":"createCaAaAccountResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"GET","path":"/holdings/ca/accounts/{accountId}","fullPath":"/api/v4.0.0/holdings/ca/accounts/{accountId}","operationId":"getCaAccountDetails","name":"Retrieves the static and financial details of the demand account such as interest, currency, balance, etc","summary":"Retrieves the product information of demand account","tags":["RETAIL"],"parameters":[{"name":"accountId","in":"path","type":"string","required":true,"description":"Identifier of the account. Often referred to as the account number, yet for consistency this is always referred to as accountId. Accepts both IBAN & BBAN"},{"name":"customerId","in":"query","type":"string","required":false,"description":"Identifier of the customer"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"CaAccountDetailsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"PUT","path":"/holdings/ca/accounts/{accountId}","fullPath":"/api/v4.0.0/holdings/ca/accounts/{accountId}","operationId":"updateCaAccount","name":"Update information for given account such as rename of demand, savings and registered accounts","summary":"Update information for given account","tags":["RETAIL"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"accountId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"properties":[{}],"overrides":[{}],"reasons":[{}],"partyIds":[{}],"partyRoles":[{}],"agentCustomerIds":[{}],"agentArrangementIds":[{}],"agentRoles":[{}],"masterArrangementId":"string","roleName":"string","transactionAmount":"string","simulationRunReference":"string","productId":"string","activityId":"string","currency":"string"}},"responses":{"200":"updateCaAccountResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"GET","path":"/holdings/ca/customers/{customerId}/accounts","fullPath":"/api/v4.0.0/holdings/ca/customers/{customerId}/accounts","operationId":"getCaAccountSummary","name":"Retrieve the details of accounts associated to the card along with product information based on customer Id.","summary":"Retrieve the details of accounts associated to the customer","tags":["RETAIL"],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"Identifier of the customer"},{"name":"cardId","in":"query","type":"string","required":false,"description":"Contains the card identification number which consists of card type and unique card number. example MEMC-12345678."},{"name":"currencyId","in":"query","type":"string","required":false,"description":"Identifier of the currency. This is the 3-letter ISO 4217 code of the currency."},{"name":"accountId","in":"query","type":"string","required":false,"description":"Identifier of the account. Often referred to as the account number, yet for consistency this is always referred to as accountId. Accepts both IBAN & BBAN"},{"name":"productId","in":"query","type":"string","required":false,"description":"Contains the unique identifier of the product, e.g. the product id of the arrangement account."},{"name":"channelId","in":"query","type":"string","required":false,"description":"Id of the (digital) channel"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"CaAccountSummaryResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/ca/cards/{cardId}/accounts","fullPath":"/api/v4.0.0/holdings/ca/cards/{cardId}/accounts","operationId":"getCaCardAccountSummary","name":"Retrieve the details of accounts associated to the card along with product information based on card number.","summary":"Retrieve the details of accounts associated to the card","tags":["RETAIL"],"parameters":[{"name":"cardId","in":"path","type":"string","required":true,"description":"Contains the card identification number which consists of card type and unique card number. example MEMC-12345678."},{"name":"currencyId","in":"query","type":"string","required":false,"description":"Identifier of the currency. This is the 3-letter ISO 4217 code of the currency."},{"name":"accountId","in":"query","type":"string","required":false,"description":"Identifier of the account. Often referred to as the account number, yet for consistency this is always referred to as accountId. Accepts both IBAN & BBAN"},{"name":"productId","in":"query","type":"string","required":false,"description":"Contains the unique identifier of the product, e.g. the product id of the arrangement account."},{"name":"customerId","in":"query","type":"string","required":false,"description":"Identifier of the customer"},{"name":"channelId","in":"query","type":"string","required":false,"description":"Id of the (digital) channel"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"CaCardAccountSummaryResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/ca/customers/accounts/{accountId}","fullPath":"/api/v4.0.0/holdings/ca/customers/accounts/{accountId}","operationId":"getCaAccountSummaryByAccount","name":"Retrieve the details of account along with product information based on account id","summary":"Retrieve the details of account","tags":["RETAIL"],"parameters":[{"name":"accountId","in":"path","type":"string","required":true,"description":"Identifier of the account. Often referred to as the account number, yet for consistency this is always referred to as accountId. Accepts both IBAN & BBAN"},{"name":"cardId","in":"query","type":"string","required":false,"description":"Contains the card identification number which consists of card type and unique card number. example MEMC-12345678."},{"name":"currencyId","in":"query","type":"string","required":false,"description":"Identifier of the currency. This is the 3-letter ISO 4217 code of the currency."},{"name":"productId","in":"query","type":"string","required":false,"description":"Contains the unique identifier of the product, e.g. the product id of the arrangement account."},{"name":"customerId","in":"query","type":"string","required":false,"description":"Identifier of the customer"},{"name":"channelId","in":"query","type":"string","required":false,"description":"Id of the (digital) channel"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"CaAccountSummaryByAccountResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}}]},{"key":"holdings-ca-card-service-v1.0.0","title":"Card management","version":"v1.0.0","description":"API to manage card order, card issuance/reissuance, cards details, update pin window details, retrieve card details and cancel card.","endpointCount":10,"endpoints":[{"method":"PUT","path":"/holdings/ca/cards/{cardIssueId}/cancellations","fullPath":"/api/v1.0.0/holdings/ca/cards/{cardIssueId}/cancellations","operationId":"cancelCaCard","name":"Perform card cancellation/terminate and update the card status accordingly","summary":"Perform card cancellation","tags":["RETAIL"],"parameters":[{"name":"cardIssueId","in":"path","type":"string","required":true,"description":"The identifier of the issued card formatted as cardType '.' cardNumber. E.g. VISA.1234567887654321 GC.1111222233334444 AB21.1111111122222222"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"businessAccessCustomers":[{}],"channels":[{}],"accountIds":[{}],"customerCompany":"string","companyName":"string","cardFormat":"string","signatory":"string","priority":"string","ruleSignatoryGroup":"string","ruleSignatoryGroupMandatory":"string","holderName":"string","description":"string","adviceId":"string","adviceType":"string","address":"string"}},"responses":{"200":"CaCardResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/holdings/ca/cards/cardIssuances/{cardIssueId}/replacements","fullPath":"/api/v1.0.0/holdings/ca/cards/cardIssuances/{cardIssueId}/replacements","operationId":"updateCaCardReplacement","name":"Perform card replacement and update the card status and other details","summary":"Perform card replacement","tags":["RETAIL"],"parameters":[{"name":"cardIssueId","in":"path","type":"string","required":true,"description":"The identifier of the issued card formatted as cardType '.' cardNumber. E.g. VISA.1234567887654321 GC.1111222233334444 AB21.1111111122222222"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"channels":[{}],"accountIds":[{}],"customerCompany":"string","companyName":"string","customer":"string","membershipId":"string","signatory":"string","priority":"string","ruleSignatoryGroup":"string","ruleSignatoryGroupMandatory":"string","holderName":"string","description":"string","adviceId":"string","adviceType":"string","address":"string"}},"responses":{"200":"CaCardReplacementResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/holdings/ca/cards/","fullPath":"/api/v1.0.0/holdings/ca/cards/","operationId":"getCaCardDetails","name":"Retrieve the card details ","summary":"Retrieve the card details such as card status, issue date, expiry date, list of accounts based on account number, customer number, card number, issue date, expriy date and sin number. ","tags":["RETAIL"],"parameters":[{"name":"customer","in":"query","type":"string","required":false,"description":"Contains the customer identifier to fetch list of consent arrangements for the customer or customer identifier of the debtor account. This will be populated once the SCA(Strong Customer Authentication"},{"name":"accountId","in":"query","type":"string","required":false,"description":"Identifier of the account. Often referred to as the account number, yet for consistency this is always referred to as accountId. Accepts both IBAN & BBAN"},{"name":"cardIssueId","in":"query","type":"string","required":false,"description":"The identifier of the issued card formatted as cardType '.' cardNumber. E.g. VISA.1234567887654321 GC.1111222233334444 AB21.1111111122222222"},{"name":"issueDate","in":"query","type":"string","required":false,"description":"The date the item was issued."},{"name":"expiryDate","in":"query","type":"string","required":false,"description":"This indicates the  date  on which the offer or privilege terminates for the event."},{"name":"cardStatus","in":"query","type":"string","required":false,"description":"Current status of the Card and following are the possible statuses are  - CARD.ISSUED - CARD.RETURNED - CARD.SCRAP - CARD.CANCEL - NOT.ACTIVATED - NOT.RECEIVED - ACTIVE - BLOCKED - EXPIRED"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"CaCardDetailsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"POST","path":"/holdings/ca/cards/cardIssuances/{cardIssueId}","fullPath":"/api/v1.0.0/holdings/ca/cards/cardIssuances/{cardIssueId}","operationId":"createCaCardIssuance","name":"Create card issue request with details such as linking, delinking of accounts, card status, expiry date, etc","summary":"Create card issue request","tags":["RETAIL"],"parameters":[{"name":"cardIssueId","in":"path","type":"string","required":true,"description":"The identifier of the issued card formatted as cardType '.' cardNumber. E.g. VISA.1234567887654321 GC.1111222233334444 AB21.1111111122222222"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"channels":[{}],"accountDescription":[{}],"accountIds":[{}],"customerCompany":"string","companyName":"string","customer":"string","membershipId":"string","customerName":"string","expiryDate":"2024-01-01","cardFormat":"string","signatory":"string","priority":"string","ruleSignatoryGroup":"string","ruleSignatoryGroupMandatory":"string","holderName":"string"}},"responses":{"200":"CaCardIssuanceResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/holdings/ca/cards/cardIssuances/{cardIssueId}","fullPath":"/api/v1.0.0/holdings/ca/cards/cardIssuances/{cardIssueId}","operationId":"updateCaCardIssuance","name":"Update card details such as linking, delinking of accounts, card status, expiry date, etc","summary":"Update card details","tags":["RETAIL"],"parameters":[{"name":"cardIssueId","in":"path","type":"string","required":true,"description":"The identifier of the issued card formatted as cardType '.' cardNumber. E.g. VISA.1234567887654321 GC.1111222233334444 AB21.1111111122222222"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"channels":[{}],"accountDescription":[{}],"accountIds":[{}],"customerCompany":"string","companyName":"string","customer":"string","membershipId":"string","customerName":"string","expiryDate":"2024-01-01","cardFormat":"string","signatory":"string","priority":"string","ruleSignatoryGroup":"string","ruleSignatoryGroupMandatory":"string","holderName":"string"}},"responses":{"200":"CaCardIssuanceResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"POST","path":"/holdings/ca/cards/cardIssuances/{cardIssueId}/pinSettingTimelines","fullPath":"/api/v1.0.0/holdings/ca/cards/cardIssuances/{cardIssueId}/pinSettingTimelines","operationId":"createCaCardPinTimeline","name":"Create card PIN resetting timeline details such as date, time and expiry","summary":"Open PIN window details of the card","tags":["RETAIL"],"parameters":[{"name":"cardIssueId","in":"path","type":"string","required":true,"description":"The identifier of the issued card formatted as cardType '.' cardNumber. E.g. VISA.1234567887654321 GC.1111222233334444 AB21.1111111122222222"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"channels":[{}],"overrides":[{}],"localExpiryTime":"2024-01-01T00:00:00Z","windowExpiryTime":"2024-01-01T00:00:00Z","expiryTime":"2024-01-01T00:00:00Z","preExpiryTime":"2024-01-01T00:00:00Z","message":"string","dateTime":"2024-01-01T00:00:00Z","Notes":"string","extensions":{}}},"responses":{"200":"CaCardPinTimelineResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/holdings/ca/cards/debitCardOrders/{cardOrderId}","fullPath":"/api/v1.0.0/holdings/ca/cards/debitCardOrders/{cardOrderId}","operationId":"getCaCardOrder","name":"Retrieve card ordered details such as card type, date, time, etc","summary":"Retrieve card ordered details","tags":["RETAIL"],"parameters":[{"name":"cardOrderId","in":"path","type":"string","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"CaCardOrderResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"POST","path":"/holdings/ca/cards/debitCardOrders/{cardOrderId}","fullPath":"/api/v1.0.0/holdings/ca/cards/debitCardOrders/{cardOrderId}","operationId":"createCaCardOrder","name":"Create a request for ordering of debit cards such as personal cards, business cards, etc","summary":"Create a request for ordering debit cards","tags":["RETAIL"],"parameters":[{"name":"cardOrderId","in":"path","type":"string","required":true,"description":"Contains the reference number of the card ordered"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"orders":[{}],"overrides":[{}],"customerId":"string","accountId":"string","orderQuantity":"string","minimumQuantity":"string","availableQuantity":"string","reorderQuantity":"string","totalOrder":"string","totalReceived":"string","name":"string","address":"string","companyId":"string","extensions":{}}},"responses":{"200":"CaCardOrderResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/holdings/ca/cards/cardAccessControls/{cardAccessControlId}","fullPath":"/api/v1.0.0/holdings/ca/cards/cardAccessControls/{cardAccessControlId}","operationId":"getCaCardAccessDetails","name":"Retrieve the access details of the card such as access flag, limit details etc based on card access id","summary":"Retrieve the access details of the card","tags":["RETAIL"],"parameters":[{"name":"cardAccessControlId","in":"path","type":"string","required":true,"description":"Contains the card access reference"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"CaCardAccessDetailsResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/holdings/ca/cards/cardAccessControls/{cardAccessControlId}","fullPath":"/api/v1.0.0/holdings/ca/cards/cardAccessControls/{cardAccessControlId}","operationId":"updateCaCardAccessDetails","name":"Update access details of the card such as limit details, access details, transaction details etc based on card access id ","summary":"Update access details of the card","tags":["RETAIL"],"parameters":[{"name":"cardAccessControlId","in":"path","type":"string","required":true,"description":"Contains the card access reference"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"interface":[{}],"holdDays":[{}],"onlineUpdates":[{}],"withdrawDetails":[{}],"cardDetails":[{}],"lastAtmDetails":[{}],"lastPosDetails":[{}],"lastMdiDetails":[{}],"lastIvrDetails":[{}],"ebizAccess":[{}],"defaultAccess":[{}],"overrides":[{}],"cardStatus":"string","dateSent":"2024-01-01","fromHostMessageDate":"2024-01-01"}},"responses":{"200":"CaCardAccessDetailsResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}}]},{"key":"holdings-ca-channelManagement-service-v3.0.0","title":"Channel Management","version":"v3.0.0","description":"API to retrieve the online messages, delinquency messages associated to a card/customer/account and list of signatories associated to an account. For lower release, refer to the holdings-ca-onlineBanking-service API group.","endpointCount":3,"endpoints":[{"method":"GET","path":"/holdings/ca/cards/{cardId}/messages","fullPath":"/api/v3.0.0/holdings/ca/cards/{cardId}/messages","operationId":"getCaCardMessages","name":"Retrieve the details of delinquent or financial reminder for the account associated to card through online banking","summary":"Retrieve the details of delinquent or financial reminder for the account associated to card","tags":["RETAIL"],"parameters":[{"name":"cardId","in":"path","type":"string","required":true,"description":"Contains the card identification number which consists of card type and unique card number. example MEMC-12345678."},{"name":"customerId","in":"query","type":"string","required":false,"description":"Identifier of the customer"},{"name":"accountId","in":"query","type":"string","required":false,"description":"Identifier of the account. Often referred to as the account number, yet for consistency this is always referred to as accountId. Accepts both IBAN & BBAN"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"CaCardMessagesResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/ca/customers/{customerId}/messages","fullPath":"/api/v3.0.0/holdings/ca/customers/{customerId}/messages","operationId":"getCaCustomerMessages","name":"Retrieve the details of delinquent or financial reminder for the account associated to customer through online banking","summary":"Retrieve the details of delinquent or financial reminder for the account associated to customer","tags":["RETAIL"],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"Identifier of the customer"},{"name":"cardId","in":"query","type":"string","required":false,"description":"Contains the card identification number which consists of card type and unique card number. example MEMC-12345678."},{"name":"accountId","in":"query","type":"string","required":false,"description":"Identifier of the account. Often referred to as the account number, yet for consistency this is always referred to as accountId. Accepts both IBAN & BBAN"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"CaCustomerMessagesResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/ca/accounts/{accountId}/signatories","fullPath":"/api/v3.0.0/holdings/ca/accounts/{accountId}/signatories","operationId":"getCaAccountSignatories","name":"Retrieve the details of signer information for business accounts through online banking","summary":"Retrieve the details of signer information for business accounts.","tags":["RETAIL"],"parameters":[{"name":"accountId","in":"path","type":"string","required":true,"description":"Identifier of the account. Often referred to as the account number, yet for consistency this is always referred to as accountId. Accepts both IBAN & BBAN"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"CaAccountSignatoriesResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}}]},{"key":"holdings-ca-channelManagement-service-v3.1.0","title":"Channel Management","version":"v3.1.0","description":"API to retrieve the online messages, delinquency messages associated to a card/customer/account, retrieves the list of members associated to a card and retrieves the list of signatories associated to an account.","endpointCount":5,"endpoints":[{"method":"GET","path":"/holdings/ca/cards/{cardId}/messages","fullPath":"/api/v3.1.0/holdings/ca/cards/{cardId}/messages","operationId":"getCaCardMessages","name":"Retrieve the details of delinquent or financial reminder for the account associated to the card through online banking","summary":"Retrieve the details of delinquent or financial reminder for the account associated to the card","tags":["RETAIL"],"parameters":[{"name":"cardId","in":"path","type":"string","required":true,"description":"Contains the card identification number which consists of card type and unique card number. example MEMC-12345678."},{"name":"customerId","in":"query","type":"string","required":false,"description":"Identifier of the customer"},{"name":"accountId","in":"query","type":"string","required":false,"description":"Identifier of the account. Often referred to as the account number, yet for consistency this is always referred to as accountId. Accepts both IBAN & BBAN"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"CaCardMessagesResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/ca/customers/{customerId}/messages","fullPath":"/api/v3.1.0/holdings/ca/customers/{customerId}/messages","operationId":"getCaCustomerMessages","name":"Retrieve the details of delinquent or financial reminder for the account associated to the customer through online banking","summary":"Retrieve the details of delinquent or financial reminder for the account associated to the customer","tags":["RETAIL"],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"Identifier of the customer"},{"name":"cardId","in":"query","type":"string","required":false,"description":"Contains the card identification number which consists of card type and unique card number. example MEMC-12345678."},{"name":"accountId","in":"query","type":"string","required":false,"description":"Identifier of the account. Often referred to as the account number, yet for consistency this is always referred to as accountId. Accepts both IBAN & BBAN"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"CaCustomerMessagesResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/ca/accounts/{accountId}/signatories","fullPath":"/api/v3.1.0/holdings/ca/accounts/{accountId}/signatories","operationId":"getCaAccountSignatories","name":"Retrieve the details of signer information for the business account through online banking","summary":"Retrieve the details of signer information for the business account.","tags":["RETAIL"],"parameters":[{"name":"accountId","in":"path","type":"string","required":true,"description":"Identifier of the account. Often referred to as the account number, yet for consistency this is always referred to as accountId. Accepts both IBAN & BBAN"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"CaAccountSignatoriesResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/ca/account/{accountId}/messages","fullPath":"/api/v3.1.0/holdings/ca/account/{accountId}/messages","operationId":"getCaAccountMessages","name":"Retrieve the details of delinquent or financial reminder for the account through online banking","summary":"Retrieve the details of delinquent or financial reminder for the account","tags":["RETAIL"],"parameters":[{"name":"accountId","in":"path","type":"string","required":true,"description":"Identifier of the account. Often referred to as the account number, yet for consistency this is always referred to as accountId. Accepts both IBAN & BBAN"},{"name":"customerId","in":"query","type":"string","required":false,"description":"Identifier of the customer"},{"name":"cardId","in":"query","type":"string","required":false,"description":"Contains the card identification number which consists of card type and unique card number. example MEMC-12345678."},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"CaAccountMessagesResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/ca/cards/{cardId}/customers","fullPath":"/api/v3.1.0/holdings/ca/cards/{cardId}/customers","operationId":"getCaCardCustomers","name":"Retrieves the list of members associated with a card through online banking or telephone banking","summary":"Retrieves the list of members associated with a card","tags":["RETAIL"],"parameters":[{"name":"cardId","in":"path","type":"string","required":true,"description":""},{"name":"CardId","in":"query","type":"string","required":true,"description":"Contains the card identification number which consists of card type and unique card number. example MEMC-12345678."},{"name":"channel","in":"query","type":"string","required":false,"description":"Contains the channel in which the activity was performed. If pricing is not determined based on channel, then this is not significant"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"CaCardCustomersResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}}]},{"key":"holdings-ca-collateral-service-v1.0.0","title":"Collateral management","version":"v1.0.0","description":"Canadian region API's to create, update and retrieve the details of collateral submitted by a customer, its value(s), allocations, etc","endpointCount":6,"endpoints":[{"method":"POST","path":"/holdings/ca/customers/collaterals/{collateralId}","fullPath":"/api/v1.0.0/holdings/ca/customers/collaterals/{collateralId}","operationId":"createCaCollateral","name":"Creates customer collateral with details such as collateral name, type, subtype, currency, amount and collateral item","summary":"Create collateral details","tags":["RETAIL"],"parameters":[{"name":"collateralId","in":"path","type":"string","required":true,"description":"The identifier of the collateral item"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"legalAddress":[{}],"owners":[{}],"additionalDetails":[{}],"dates":[{}],"propertyName":[{}],"priorCharges":[{}],"customers":[{}],"collateralNames":[{}],"purchaseAmount":0.0,"multiPurposeMortgageNumber":"string","originationReference":"string","productType":"string","nominalRate":"string","ratio":"string","grossDebtServiceRate":0.0}},"responses":{"200":"CaCollateralResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/holdings/ca/customers/collaterals/{collateralId}","fullPath":"/api/v1.0.0/holdings/ca/customers/collaterals/{collateralId}","operationId":"updateCaCollateral","name":"Update  customer collateral with details such as collateral name, type, subtype, currency, amount and collateral item","summary":"Update collateral details","tags":["RETAIL"],"parameters":[{"name":"collateralId","in":"path","type":"string","required":true,"description":"The identifier of the collateral item"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"legalAddress":[{}],"owners":[{}],"additionalDetails":[{}],"dates":[{}],"propertyName":[{}],"priorCharges":[{}],"customers":[{}],"collateralNames":[{}],"purchaseAmount":0.0,"multiPurposeMortgageNumber":"string","originationReference":"string","productType":"string","nominalRate":"string","ratio":"string","grossDebtServiceRate":0.0}},"responses":{"200":"CaCollateralResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"POST","path":"/holdings/ca/customers/collaterals/collateralAllocations/{collateralAllocationId}","fullPath":"/api/v1.0.0/holdings/ca/customers/collaterals/collateralAllocations/{collateralAllocationId}","operationId":"createCaCollateralAllocation","name":"Create collateral allocation details such as expiry date, limit reference, allocation percentage, etc","summary":"Create collateral allocation details","tags":["RETAIL"],"parameters":[{"name":"collateralAllocationId","in":"path","type":"string","required":true,"description":"Identifier of collateral allocation contract"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"mpmCustomer":[{}],"collateralOwners":[{}],"LimitAllocationDetails":[{}],"collateralIds":[{}],"notes":[{}],"multiPurposeMortgageNumber":"string","limitAmount":0.0,"externalReference":"string","unsettledCredit":"string","internalReference":"string","institutionName":"string","relation":"string","sequenceNumber":"string","insuranceInstitutionNumber":"string","allowMpm":"string"}},"responses":{"200":"CaCollateralAllocationResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/holdings/ca/customers/collaterals/collateralAllocations/{collateralAllocationId}","fullPath":"/api/v1.0.0/holdings/ca/customers/collaterals/collateralAllocations/{collateralAllocationId}","operationId":"updateCaCollateralAllocation","name":"Update collateral allocation details such as expiry date, limit reference, allocation percentage, etc","summary":"Update collateral allocation details","tags":["RETAIL"],"parameters":[{"name":"collateralAllocationId","in":"path","type":"string","required":true,"description":"Identifier of collateral allocation contract"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"mpmCustomer":[{}],"collateralOwners":[{}],"LimitAllocationDetails":[{}],"collateralIds":[{}],"notes":[{}],"multiPurposeMortgageNumber":"string","limitAmount":0.0,"externalReference":"string","unsettledCredit":"string","internalReference":"string","institutionName":"string","relation":"string","sequenceNumber":"string","insuranceInstitutionNumber":"string","allowMpm":"string"}},"responses":{"200":"CaCollateralAllocationResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/holdings/ca/customers/collaterals","fullPath":"/api/v1.0.0/holdings/ca/customers/collaterals","operationId":"getCaCollateralDetails","name":"Retrieves customer collaterals with details such as collateral name, type, subtype, currency, amount and collateral item.","summary":"Retrieves customer collateral details","tags":["RETAIL"],"parameters":[{"name":"customerId","in":"query","type":"string","required":false,"description":"Identifier of the customer"},{"name":"collateralCodeId","in":"query","type":"string","required":false,"description":"Identifier of the collateral type"},{"name":"collateralTypeId","in":"query","type":"string","required":false,"description":"Collateral classification Id defined in the system."},{"name":"collateralStatus","in":"query","type":"string","required":false,"description":"Indicates the status of the collateral allocation or collateral. It can be one of the following values: CUR - Current, FWD - Forward , LIQ - Liquidated or MAT - Matured."},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"CaCollateralDetailsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/ca/customers/collaterals/collateralAllocations","fullPath":"/api/v1.0.0/holdings/ca/customers/collaterals/collateralAllocations","operationId":"getCaCollateralAllocations","name":"Retrieve collateral allocations details such as limit reference, allocation percentage, collateral name, type, etc","summary":"Retrieve collateral allocations details","tags":["RETAIL"],"parameters":[{"name":"collateralAllocationId","in":"query","type":"string","required":false,"description":"Identifier of collateral allocation contract"},{"name":"customerId","in":"query","type":"string","required":false,"description":"Identifier of the customer"},{"name":"exposureReference","in":"query","type":"string","required":false,"description":"Contains the reference of the credit line or contract that is to be covered by the collateral"},{"name":"collateralId","in":"query","type":"string","required":false,"description":"The identifier of the collateral item"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"CaCollateralAllocationsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}}]},{"key":"holdings-ca-collateral-service-v1.1.0","title":"Collateral management","version":"v1.1.0","description":"Canadian region API's to create, update and retrieve the details of collateral submitted by a customer, its value(s), allocations, etc","endpointCount":6,"endpoints":[{"method":"POST","path":"/holdings/ca/customers/collaterals/{collateralId}","fullPath":"/api/v1.1.0/holdings/ca/customers/collaterals/{collateralId}","operationId":"createCaCollateral","name":"Creates customer collateral with details such as collateral name, type, subtype, currency, amount and collateral item","summary":"Create collateral details","tags":["RETAIL"],"parameters":[{"name":"collateralId","in":"path","type":"string","required":true,"description":"The identifier of the collateral item"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"legalAddress":[{}],"owners":[{}],"additionalDetails":[{}],"dates":[{}],"propertyName":[{}],"priorCharges":[{}],"customers":[{}],"collateralNames":[{}],"purchaseAmount":0.0,"multiPurposeMortgageNumber":"string","originationReference":"string","productType":"string","nominalRate":"string","ratio":"string","grossDebtServiceRate":0.0}},"responses":{"200":"CaCollateralResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/holdings/ca/customers/collaterals/{collateralId}","fullPath":"/api/v1.1.0/holdings/ca/customers/collaterals/{collateralId}","operationId":"updateCaCollateral","name":"Update  customer collateral with details such as collateral name, type, subtype, currency, amount and collateral item","summary":"Update collateral details","tags":["RETAIL"],"parameters":[{"name":"collateralId","in":"path","type":"string","required":true,"description":"The identifier of the collateral item"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"legalAddress":[{}],"owners":[{}],"additionalDetails":[{}],"dates":[{}],"propertyName":[{}],"priorCharges":[{}],"customers":[{}],"collateralNames":[{}],"purchaseAmount":0.0,"multiPurposeMortgageNumber":"string","originationReference":"string","productType":"string","nominalRate":"string","ratio":"string","grossDebtServiceRate":0.0}},"responses":{"200":"CaCollateralResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/holdings/ca/customers/collaterals/collateralAllocations","fullPath":"/api/v1.1.0/holdings/ca/customers/collaterals/collateralAllocations","operationId":"getCaCollateralAllocations","name":"Retrieve collateral allocations details such as limit reference, allocation percentage, collateral name, type, etc","summary":"Retrieve collateral allocations details","tags":["RETAIL"],"parameters":[{"name":"collateralAllocationId","in":"query","type":"string","required":false,"description":"Identifier of collateral allocation contract"},{"name":"customerId","in":"query","type":"string","required":false,"description":"Identifier of the customer"},{"name":"exposureReference","in":"query","type":"string","required":false,"description":"Contains the reference of the credit line or contract that is to be covered by the collateral"},{"name":"collateralId","in":"query","type":"string","required":false,"description":"The identifier of the collateral item"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"CaCollateralAllocationsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/ca/customers/collaterals","fullPath":"/api/v1.1.0/holdings/ca/customers/collaterals","operationId":"getCaCollateralDetails","name":"Retrieves customer collaterals with details such as collateral name, type, subtype, currency, amount and collateral item.","summary":"Retrieves customer collateral details","tags":["RETAIL"],"parameters":[{"name":"customerId","in":"query","type":"string","required":false,"description":"Identifier of the customer"},{"name":"collateralRightId","in":"query","type":"string","required":false,"description":"The identifier of the Collateral Right item"},{"name":"collateralCodeId","in":"query","type":"string","required":false,"description":"Identifier of the collateral type"},{"name":"collateralTypeId","in":"query","type":"string","required":false,"description":"Collateral classification Id defined in the system."},{"name":"collateralStatus","in":"query","type":"string","required":false,"description":"Indicates the status of the collateral allocation or collateral. It can be one of the following values: CUR - Current, FWD - Forward , LIQ - Liquidated or MAT - Matured."},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"CaCollateralDetailsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"POST","path":"/holdings/ca/customers/collaterals/collateralAllocations/{collateralAllocationId}","fullPath":"/api/v1.1.0/holdings/ca/customers/collaterals/collateralAllocations/{collateralAllocationId}","operationId":"createCaCollateralAllocation","name":"Create collateral allocation details such as expiry date, limit reference, allocation percentage, etc","summary":"Create collateral allocation details","tags":["RETAIL"],"parameters":[{"name":"collateralAllocationId","in":"path","type":"string","required":true,"description":"Identifier of collateral allocation contract"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"mpmCustomer":[{}],"collateralOwners":[{}],"LimitAllocationDetails":[{}],"collateralIds":[{}],"notes":[{}],"multiPurposeMortgageNumber":"string","limitAmount":0.0,"externalReference":"string","unsettledCredit":"string","internalReference":"string","institutionName":"string","relation":"string","sequenceNumber":"string","insuranceInstitutionNumber":"string","allowMultiPurposeMortgage":"string"}},"responses":{"200":"CaCollateralAllocationResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/holdings/ca/customers/collaterals/collateralAllocations/{collateralAllocationId}","fullPath":"/api/v1.1.0/holdings/ca/customers/collaterals/collateralAllocations/{collateralAllocationId}","operationId":"updateCaCollateralAllocation","name":"Update collateral allocation details such as expiry date, limit reference, allocation percentage, etc","summary":"Update collateral allocation details","tags":["RETAIL"],"parameters":[{"name":"collateralAllocationId","in":"path","type":"string","required":true,"description":"Identifier of collateral allocation contract"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"mpmCustomer":[{}],"collateralOwners":[{}],"LimitAllocationDetails":[{}],"collateralIds":[{}],"notes":[{}],"multiPurposeMortgageNumber":"string","limitAmount":0.0,"externalReference":"string","unsettledCredit":"string","internalReference":"string","institutionName":"string","relation":"string","sequenceNumber":"string","insuranceInstitutionNumber":"string","allowMultiPurposeMortgage":"string"}},"responses":{"200":"CaCollateralAllocationResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}}]},{"key":"holdings-ca-deposit-service-v1.0.0","title":"Deposit Management","version":"v1.0.0","description":"API to manage the deposit products","endpointCount":1,"endpoints":[{"method":"GET","path":"/holdings/ca/deposits/{depositId}","fullPath":"/api/v1.0.0/holdings/ca/deposits/{depositId}","operationId":"getCaDepositDetails","name":"Retrieves the deposit account details such as balance, interest rate, interest property, curency, etc","summary":"Retrieves the details of the deposit account","tags":["RETAIL"],"parameters":[{"name":"depositId","in":"path","type":"string","required":true,"description":"Indicates the Id of the deposit account"},{"name":"customerId","in":"query","type":"string","required":false,"description":"Identifier of the customer"},{"name":"arrangementId","in":"query","type":"string","required":false,"description":"Indicates an unique identifier of an account"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"CaDepositDetailsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}}]},{"key":"holdings-ca-deposit-service-v4.0.0","title":"Deposit Management","version":"v4.0.0","description":"API to manage the deposit products","endpointCount":3,"endpoints":[{"method":"POST","path":"/holdings/ca/deposits","fullPath":"/api/v4.0.0/holdings/ca/deposits","operationId":"createCaDeposit","name":"API to Create/update new deposit such as short term deposits, long term deposits, registered deposits, etc","summary":"API to Create new deposit","tags":["RETAIL"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"properties":[{}],"overrides":[{}],"reasons":[{}],"partyIds":[{}],"partyRoles":[{}],"agentCustomerIds":[{}],"agentArrangementIds":[{}],"agentRoles":[{}],"masterArrangementId":"string","roleName":"string","transactionAmount":"string","simulationRunReference":"string","productId":"string","activityId":"string","currency":"string"}},"responses":{"200":"createCaDepositResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"GET","path":"/holdings/ca/deposits/{depositId}","fullPath":"/api/v4.0.0/holdings/ca/deposits/{depositId}","operationId":"getCaDepositDetails","name":"Retrieves the deposit account details such as balance, interest rate, interest property, curency, etc","summary":"Retrieves the details of the deposit account","tags":["RETAIL"],"parameters":[{"name":"depositId","in":"path","type":"string","required":true,"description":""},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"CaDepositDetailsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"PUT","path":"/holdings/ca/deposits/{depositId}","fullPath":"/api/v4.0.0/holdings/ca/deposits/{depositId}","operationId":"updateCaDeposit","name":"Update information for given deposit such as rename of term and registered term","summary":"Update information for given deposit","tags":["RETAIL"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"depositId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"properties":[{}],"overrides":[{}],"reasons":[{}],"partyIds":[{}],"partyRoles":[{}],"agentCustomerIds":[{}],"agentArrangementIds":[{}],"agentRoles":[{}],"masterArrangementId":"string","roleName":"string","transactionAmount":"string","simulationRunReference":"string","productId":"string","activityId":"string","currency":"string"}},"responses":{"200":"updateCaDepositResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}}]},{"key":"holdings-ca-loans-service-v1.0.0","title":"Loan Management","version":"v1.0.0","description":"API to retrieve the loan details such as currency, account balances and restrictions","endpointCount":1,"endpoints":[{"method":"GET","path":"/holdings/ca/loans/{loanId}","fullPath":"/api/v1.0.0/holdings/ca/loans/{loanId}","operationId":"getCaLoanDetails","name":"Retrieve the details of the loan such as currency term ,interest rate,etc based on the given account number","summary":"API to retrieve account details for loan product","tags":["RETAIL"],"parameters":[{"name":"loanId","in":"path","type":"string","required":true,"description":"Denotes the arrangement id of the loan"},{"name":"customerId","in":"query","type":"string","required":false,"description":"Identifier of the customer"},{"name":"arrangementId","in":"query","type":"string","required":false,"description":"Indicates an unique identifier of an account"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"CaLoanDetailsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}}]},{"key":"holdings-ca-loans-service-v4.0.0","title":"Loan Management","version":"v4.0.0","description":"API to create, update and retrieve the loan details such as currency, account balances and restrictions","endpointCount":3,"endpoints":[{"method":"POST","path":"/holdings/ca/loans","fullPath":"/api/v4.0.0/holdings/ca/loans","operationId":"createCaLoans","name":"API to Create new loans from such as personal loans, housing loans, business loans, etc","summary":"API to Create new loans","tags":["RETAIL"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"properties":[{}],"overrides":[{}],"reasons":[{}],"partyIds":[{}],"partyRoles":[{}],"agentCustomerIds":[{}],"agentArrangementIds":[{}],"agentRoles":[{}],"masterArrangementId":"string","roleName":"string","transactionAmount":"string","simulationRunReference":"string","productId":"string","activityId":"string","currency":"string"}},"responses":{"200":"createCaLoansResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"GET","path":"/holdings/ca/loans/{loanId}","fullPath":"/api/v4.0.0/holdings/ca/loans/{loanId}","operationId":"getCaLoanDetails","name":"Retrieve the details of the loan such as currency term ,interest rate,etc based on the given account number","summary":"API to retrieve account details for loan product","tags":["RETAIL"],"parameters":[{"name":"loanId","in":"path","type":"string","required":true,"description":""},{"name":"accountId","in":"query","type":"string","required":false,"description":"Identifier of the account. Often referred to as the account number, yet for consistency this is always referred to as accountId. Accepts both IBAN & BBAN"},{"name":"customerId","in":"query","type":"string","required":false,"description":"Identifier of the customer"},{"name":"arrangementId","in":"query","type":"string","required":false,"description":"Indicates an unique identifier of an account"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"CaLoanDetailsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"PUT","path":"/holdings/ca/loans/{loanId}","fullPath":"/api/v4.0.0/holdings/ca/loans/{loanId}","operationId":"updateCaLoan","name":"Update loan details for a given loan id such as rename of lending accounts, interest rate, schedule, etc","summary":"Update loan details for a given loan id","tags":["RETAIL"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"loanId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"properties":[{}],"overrides":[{}],"reasons":[{}],"partyIds":[{}],"partyRoles":[{}],"agentCustomerIds":[{}],"agentArrangementIds":[{}],"agentRoles":[{}],"masterArrangementId":"string","roleName":"string","transactionAmount":"string","simulationRunReference":"string","productId":"string","activityId":"string","currency":"string"}},"responses":{"200":"updateCaLoanResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}}]},{"key":"holdings-ca-onlineBanking-service-v1.0.0","title":"OnlineBanking","version":"v1.0.0","description":"API to perform the online banking functionalities such as, a. Listing accounts that the customer can access using online banking. b. Account balances c. Account and portfolio details like interest rate, etc. c. Financial reminder/delinquent messages associated to the accounts, such as loan repayment","endpointCount":2,"endpoints":[{"method":"POST","path":"/holdings/ca/accounts","fullPath":"/api/v1.0.0/holdings/ca/accounts","operationId":"createCaAccount","name":"Create new account from online banking such as savings account, current account, demand account, etc","summary":"Create new account from online banking","tags":["RETAIL"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"customerIds":[{}],"properties":[{}],"overrides":[{}],"productId":"string","masterArrangementId":"string","roleName":"string","currencyId":"string","effectiveDate":"2024-01-01","activityId":"string","transactionAmount":0.0,"reason":"string","simulationRunReference":"string","extensions":{},"limit":[{}],"xira":[{}]}},"responses":{"200":"createCaAccountResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"PUT","path":"/holdings/ca/accounts","fullPath":"/api/v1.0.0/holdings/ca/accounts","operationId":"updateCaAccount","name":"Update information for given account such as rename of demand, savings and registered accounts","summary":"Update information for given account","tags":["RETAIL"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"customerIds":[{}],"properties":[{}],"overrides":[{}],"productId":"string","masterArrangementId":"string","roleName":"string","currencyId":"string","effectiveDate":"2024-01-01","activityId":"string","transactionAmount":0.0,"reason":"string","simulationRunReference":"string","extensions":{},"limit":[{}],"xira":[{}]}},"responses":{"200":"updateCaAccountResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}}]},{"key":"holdings-ca-onlineBanking-service-v1.1.0","title":"OnlineBanking","version":"v1.1.0","description":"API to perform the online banking functionalities such as, a. Listing accounts that the customer can access using online banking. b. Account balances c. Account and portfolio details like interest rate, etc. c. Financial reminder/delinquent messages associated to the accounts, such as loan repayment","endpointCount":2,"endpoints":[{"method":"POST","path":"/holdings/ca/accounts","fullPath":"/api/v1.1.0/holdings/ca/accounts","operationId":"createCaAccount","name":"Create new account from online banking such as savings account, current account, demand account, etc","summary":"Create new account from online banking","tags":["RETAIL"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"customerIds":[{}],"properties":[{}],"overrides":[{}],"productId":"string","masterArrangementId":"string","roleName":"string","currencyId":"string","effectiveDate":"2024-01-01","activityId":"string","transactionAmount":0.0,"reason":"string","simulationRunReference":"string","extensions":{},"limit":[{}],"xira":[{}]}},"responses":{"200":"createCaAccountResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"PUT","path":"/holdings/ca/accounts","fullPath":"/api/v1.1.0/holdings/ca/accounts","operationId":"updateCaAccount","name":"Update information for given account such as rename of demand, savings and registered accounts","summary":"Update information for given account","tags":["RETAIL"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"customerIds":[{}],"properties":[{}],"overrides":[{}],"productId":"string","masterArrangementId":"string","roleName":"string","currencyId":"string","effectiveDate":"2024-01-01","activityId":"string","transactionAmount":0.0,"reason":"string","simulationRunReference":"string","extensions":{},"limit":[{}],"xira":[{}]}},"responses":{"200":"updateCaAccountResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}}]},{"key":"holdings-ca-onlineBanking-service-v2.0.0","title":"OnlineBanking","version":"v2.0.0","description":"API to perform the online banking functionalities such as, a. Listing accounts that the customer can access using online banking. b. Account balances c. Account and portfolio details like interest rate, etc. d. Financial reminder/delinquent messages associated to the accounts, such as loan repayment","endpointCount":7,"endpoints":[{"method":"POST","path":"/holdings/ca/accounts","fullPath":"/api/v2.0.0/holdings/ca/accounts","operationId":"createCaAaAccount","name":"Create new account from online banking such as savings account, current account, demand account, etc","summary":"Create new account from online banking","tags":["RETAIL"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"customerIds":[{}],"properties":[{}],"overrides":[{}],"productId":"string","masterArrangementId":"string","roleName":"string","currencyId":"string","effectiveDate":"2024-01-01","activityId":"string","transactionAmount":0.0,"reason":"string","simulationRunReference":"string","extensions":{},"limit":[{}],"xira":[{}]}},"responses":{"200":"createCaAaAccountResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"PUT","path":"/holdings/ca/accounts","fullPath":"/api/v2.0.0/holdings/ca/accounts","operationId":"updateCaAccount","name":"Update information for given account such as rename of demand, savings and registered accounts","summary":"Update information for given account","tags":["RETAIL"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"customerIds":[{}],"properties":[{}],"overrides":[{}],"productId":"string","masterArrangementId":"string","roleName":"string","currencyId":"string","effectiveDate":"2024-01-01","activityId":"string","transactionAmount":0.0,"reason":"string","simulationRunReference":"string","extensions":{},"limit":[{}],"xira":[{}]}},"responses":{"200":"updateCaAccountResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"POST","path":"/holdings/ca/deposits","fullPath":"/api/v2.0.0/holdings/ca/deposits","operationId":"createCaDeposit","name":"Create new deposit from online banking such as short tem deposits, long term deposits, registered deposits, etc","summary":"Create new deposit from online banking","tags":["RETAIL"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"partyIds":[{}],"partyRoles":[{}],"agentCustomerIds":[{}],"agentArrangementIds":[{}],"agentRoles":[{}],"arrangmentId":"string","productId":"string","activityId":"string","currency":"string","productVariation":"string","pricingSelection":"string","pricingPlan":"string","rewardsArrangementId":"string","tradeDate":"string","arrangementEffectiveDate":"string"}},"responses":{"200":"createCaDepositResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"PUT","path":"/holdings/ca/deposits","fullPath":"/api/v2.0.0/holdings/ca/deposits","operationId":"updateCaDeposit","name":"Create new deposit from online banking such as short tem deposits, long term deposits, registered deposits, etc","summary":"Create new deposit from online banking","tags":["RETAIL"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"partyIds":[{}],"partyRoles":[{}],"agentCustomerIds":[{}],"agentArrangementIds":[{}],"agentRoles":[{}],"arrangmentId":"string","productId":"string","activityId":"string","currency":"string","productVariation":"string","pricingSelection":"string","pricingPlan":"string","rewardsArrangementId":"string","tradeDate":"string","arrangementEffectiveDate":"string"}},"responses":{"200":"updateCaDepositResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"GET","path":"/holdings/ca/cards/{cardId}/messages","fullPath":"/api/v2.0.0/holdings/ca/cards/{cardId}/messages","operationId":"getCaCardMessages","name":"Retrieve the details of delinquent or financial reminder for the account associated to card through online banking","summary":"Retrieve the details of delinquent or financial reminder for the account associated to card","tags":["RETAIL"],"parameters":[{"name":"cardId","in":"path","type":"string","required":true,"description":"Contains the card identification number which consists of card type and unique card number. example MEMC-12345678."},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"CaCardMessagesResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/ca/customers/{customerId}/messages","fullPath":"/api/v2.0.0/holdings/ca/customers/{customerId}/messages","operationId":"getCaCustomerMessages","name":"Retrieve the details of delinquent or financial reminder for the account associated to customer through online banking","summary":"Retrieve the details of delinquent or financial reminder for the account associated to customer","tags":["RETAIL"],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"Identifier of the customer"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"CaCustomerMessagesResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/ca/accounts/{accountId}/signatories","fullPath":"/api/v2.0.0/holdings/ca/accounts/{accountId}/signatories","operationId":"getCaAccountSignatories","name":"Retrieve the details of signer information for business accounts through online banking","summary":"Retrieve the details of signer information for business accounts.","tags":["RETAIL"],"parameters":[{"name":"accountId","in":"path","type":"string","required":true,"description":"Identifier of the account. Often referred to as the account number, yet for consistency this is always referred to as accountId. Accepts both IBAN & BBAN"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"CaAccountSignatoriesResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}}]},{"key":"holdings-ca-onlineBanking-service-v3.0.0","title":"OnlineBanking","version":"v3.0.0","description":"API to perform creation and updation of accounts, deposits and loan products.","endpointCount":6,"endpoints":[{"method":"POST","path":"/holdings/ca/accounts","fullPath":"/api/v3.0.0/holdings/ca/accounts","operationId":"createCaAaAccount","name":"Create new account from online banking such as savings account, current account, demand account, etc","summary":"Create new account from online banking","tags":["RETAIL"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"customerIds":[{}],"properties":[{}],"overrides":[{}],"productId":"string","masterArrangementId":"string","roleName":"string","currencyId":"string","effectiveDate":"2024-01-01","activityId":"string","transactionAmount":0.0,"reason":"string","simulationRunReference":"string","extensions":{},"limit":[{}],"xira":[{}]}},"responses":{"200":"createCaAaAccountResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"PUT","path":"/holdings/ca/accounts","fullPath":"/api/v3.0.0/holdings/ca/accounts","operationId":"updateCaAccount","name":"Update information for given account such as rename of demand, savings and registered accounts","summary":"Update information for given account","tags":["RETAIL"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"customerIds":[{}],"properties":[{}],"overrides":[{}],"productId":"string","masterArrangementId":"string","roleName":"string","currencyId":"string","effectiveDate":"2024-01-01","activityId":"string","transactionAmount":0.0,"reason":"string","simulationRunReference":"string","extensions":{},"limit":[{}],"xira":[{}]}},"responses":{"200":"updateCaAccountResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"POST","path":"/holdings/ca/deposits","fullPath":"/api/v3.0.0/holdings/ca/deposits","operationId":"createCaDeposit","name":"Create new deposit from online banking such as short tem deposits, long term deposits, registered deposits, etc","summary":"Create new deposit from online banking","tags":["RETAIL"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"partyIds":[{}],"partyRoles":[{}],"agentCustomerIds":[{}],"agentArrangementIds":[{}],"agentRoles":[{}],"arrangmentId":"string","productId":"string","activityId":"string","currency":"string","productVariation":"string","pricingSelection":"string","pricingPlan":"string","rewardsArrangementId":"string","tradeDate":"string","arrangementEffectiveDate":"string"}},"responses":{"200":"createCaDepositResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"PUT","path":"/holdings/ca/deposits","fullPath":"/api/v3.0.0/holdings/ca/deposits","operationId":"updateCaDeposit","name":"Update information for given deposit such as rename of term and registered term","summary":"Update information for given deposit","tags":["RETAIL"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"partyIds":[{}],"partyRoles":[{}],"agentCustomerIds":[{}],"agentArrangementIds":[{}],"agentRoles":[{}],"arrangmentId":"string","productId":"string","activityId":"string","currency":"string","productVariation":"string","pricingSelection":"string","pricingPlan":"string","rewardsArrangementId":"string","tradeDate":"string","arrangementEffectiveDate":"string"}},"responses":{"200":"updateCaDepositResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"POST","path":"/holdings/ca/loans","fullPath":"/api/v3.0.0/holdings/ca/loans","operationId":"createCaLoans","name":"Create new loans from online banking such as personal loans, housing loans, business loans, etc","summary":"Create new loans from online banking","tags":["RETAIL"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"partyIds":[{}],"partyRoles":[{}],"agentCustomerIds":[{}],"agentArrangementIds":[{}],"agentRoles":[{}],"arrangmentId":"string","productId":"string","activityId":"string","currency":"string","productVariation":"string","pricingSelection":"string","pricingPlan":"string","rewardsArrangementId":"string","tradeDate":"string","arrangementEffectiveDate":"string"}},"responses":{"200":"createCaLoansResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"PUT","path":"/holdings/ca/loans/{loanId}","fullPath":"/api/v3.0.0/holdings/ca/loans/{loanId}","operationId":"updateCaLoan","name":"Update loan details for a given loan id such as rename of lending accounts, interest rate, schedule, etc","summary":"Update loan details for a given loan id","tags":["RETAIL"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"loanId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"partyIds":[{}],"partyRoles":[{}],"agentCustomerIds":[{}],"agentArrangementIds":[{}],"agentRoles":[{}],"arrangmentId":"string","productId":"string","activityId":"string","currency":"string","productVariation":"string","pricingSelection":"string","pricingPlan":"string","rewardsArrangementId":"string","tradeDate":"string","arrangementEffectiveDate":"string"}},"responses":{"200":"updateCaLoanResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}}]},{"key":"holdings-ca-onlineBanking-service-v3.1.0","title":"OnlineBanking","version":"v3.1.0","description":"API to perform creation and updation of accounts, deposits and loan products.","endpointCount":6,"endpoints":[{"method":"POST","path":"/holdings/ca/accounts","fullPath":"/api/v3.1.0/holdings/ca/accounts","operationId":"createCaAaAccount","name":"Create new account from online banking such as savings account, current account, demand account, etc","summary":"Create new account from online banking","tags":["RETAIL"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"customerIds":[{}],"properties":[{}],"overrides":[{}],"productId":"string","masterArrangementId":"string","roleName":"string","currencyId":"string","effectiveDate":"2024-01-01","activityId":"string","transactionAmount":0.0,"reason":"string","simulationRunReference":"string","extensions":{},"limit":[{}],"xira":[{}]}},"responses":{"200":"createCaAaAccountResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"PUT","path":"/holdings/ca/accounts","fullPath":"/api/v3.1.0/holdings/ca/accounts","operationId":"updateCaAccount","name":"Update information for given account such as rename of demand, savings and registered accounts","summary":"Update information for given account","tags":["RETAIL"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"customerIds":[{}],"properties":[{}],"overrides":[{}],"productId":"string","masterArrangementId":"string","roleName":"string","currencyId":"string","effectiveDate":"2024-01-01","activityId":"string","transactionAmount":0.0,"reason":"string","simulationRunReference":"string","extensions":{},"limit":[{}],"xira":[{}]}},"responses":{"200":"updateCaAccountResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"POST","path":"/holdings/ca/deposits","fullPath":"/api/v3.1.0/holdings/ca/deposits","operationId":"createCaDeposit","name":"Create new deposit from online banking such as short term deposits, long term deposits, registered deposits, etc","summary":"Create new deposit from online banking","tags":["RETAIL"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"partyIds":[{}],"partyRoles":[{}],"agentCustomerIds":[{}],"agentArrangementIds":[{}],"agentRoles":[{}],"arrangmentId":"string","productId":"string","activityId":"string","currency":"string","productVariation":"string","pricingSelection":"string","pricingPlan":"string","rewardsArrangementId":"string","tradeDate":"string","arrangementEffectiveDate":"string"}},"responses":{"200":"createCaDepositResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"PUT","path":"/holdings/ca/deposits","fullPath":"/api/v3.1.0/holdings/ca/deposits","operationId":"updateCaDeposit","name":"Update information for given deposit such as rename of term and registered term","summary":"Update information for given deposit","tags":["RETAIL"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"partyIds":[{}],"partyRoles":[{}],"agentCustomerIds":[{}],"agentArrangementIds":[{}],"agentRoles":[{}],"arrangmentId":"string","productId":"string","activityId":"string","currency":"string","productVariation":"string","pricingSelection":"string","pricingPlan":"string","rewardsArrangementId":"string","tradeDate":"string","arrangementEffectiveDate":"string"}},"responses":{"200":"updateCaDepositResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"POST","path":"/holdings/ca/loans","fullPath":"/api/v3.1.0/holdings/ca/loans","operationId":"createCaLoans","name":"Create new loans from online banking such as personal loans, housing loans, business loans, etc","summary":"Create new loans from online banking","tags":["RETAIL"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"partyIds":[{}],"partyRoles":[{}],"agentCustomerIds":[{}],"agentArrangementIds":[{}],"agentRoles":[{}],"arrangmentId":"string","productId":"string","activityId":"string","currency":"string","productVariation":"string","pricingSelection":"string","pricingPlan":"string","rewardsArrangementId":"string","tradeDate":"string","arrangementEffectiveDate":"string"}},"responses":{"200":"createCaLoansResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"PUT","path":"/holdings/ca/loans/{loanId}","fullPath":"/api/v3.1.0/holdings/ca/loans/{loanId}","operationId":"updateCaLoan","name":"Update loan details for a given loan id such as rename of lending accounts, interest rate, schedule, etc","summary":"Update loan details for a given loan id","tags":["RETAIL"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"loanId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"partyIds":[{}],"partyRoles":[{}],"agentCustomerIds":[{}],"agentArrangementIds":[{}],"agentRoles":[{}],"arrangmentId":"string","productId":"string","activityId":"string","currency":"string","productVariation":"string","pricingSelection":"string","pricingPlan":"string","rewardsArrangementId":"string","tradeDate":"string","arrangementEffectiveDate":"string"}},"responses":{"200":"updateCaLoanResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}}]},{"key":"holdings-ca-regsiteredPlans-service-v1.0.0","title":"Registered Plans","version":"v1.0.0","description":"APIs to create, update, simulate and retrieve the registered plan products such as RRSP, RRIF, TFSA, etc","endpointCount":5,"endpoints":[{"method":"GET","path":"/holdings/ca/portfolios/{portfolioId}","fullPath":"/api/v1.0.0/holdings/ca/portfolios/{portfolioId}","operationId":"getCaPortfolioDetails","name":"Retrieve the details of the registered plan products such as plan type, plan group, plan id, plan value, settlement account, etc based on portfolio id.","summary":"Retrieve the details of the registered plan products","tags":["RETAIL"],"parameters":[{"name":"portfolioId","in":"path","type":"string","required":true,"description":"Id of the portfolio or security account"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"CaPortfolioDetailsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"POST","path":"/holdings/ca/registeredPlans/accounts","fullPath":"/api/v1.0.0/holdings/ca/registeredPlans/accounts","operationId":"createCaRegisteredAccounts","name":"Create new registered account from online banking such as rrsp regular, rrsp spousal, etc","summary":"Create new registered account from online banking","tags":["RETAIL"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"partyIds":[{}],"partyRoles":[{}],"agentCustomerIds":[{}],"agentArrangementIds":[{}],"agentRoles":[{}],"arrangmentId":"string","productId":"string","activityId":"string","currency":"string","productVariation":"string","pricingSelection":"string","pricingPlan":"string","rewardsArrangementId":"string","tradeDate":"string","arrangementEffectiveDate":"string"}},"responses":{"200":"createCaRegisteredAccountsResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"PUT","path":"/holdings/ca/registeredPlans/accounts/{accountid}","fullPath":"/api/v1.0.0/holdings/ca/registeredPlans/accounts/{accountid}","operationId":"updateCaRegisteredAccounts","name":"Update registered account from online banking such as rrsp regular, rrsp spousal, etc","summary":"Update registered account from online banking","tags":["RETAIL"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"accountid","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"partyIds":[{}],"partyRoles":[{}],"agentCustomerIds":[{}],"agentArrangementIds":[{}],"agentRoles":[{}],"arrangmentId":"string","productId":"string","activityId":"string","currency":"string","productVariation":"string","pricingSelection":"string","pricingPlan":"string","rewardsArrangementId":"string","tradeDate":"string","arrangementEffectiveDate":"string"}},"responses":{"200":"updateCaRegisteredAccountsResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"POST","path":"/holdings/ca/registeredPlans/deposits","fullPath":"/api/v1.0.0/holdings/ca/registeredPlans/deposits","operationId":"createCaRegisteredDeposits","name":"Create new registered deposit from online banking such as rrsp regular, rrsp spousal, etc","summary":"Create new registered deposit from online banking","tags":["RETAIL"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"partyIds":[{}],"partyRoles":[{}],"agentCustomerIds":[{}],"agentArrangementIds":[{}],"agentRoles":[{}],"arrangmentId":"string","productId":"string","activityId":"string","currency":"string","productVariation":"string","pricingSelection":"string","pricingPlan":"string","rewardsArrangementId":"string","tradeDate":"string","arrangementEffectiveDate":"string"}},"responses":{"200":"createCaRegisteredDepositsResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"PUT","path":"/holdings/ca/registeredPlans/deposits/{depositId}","fullPath":"/api/v1.0.0/holdings/ca/registeredPlans/deposits/{depositId}","operationId":"updateCaRegisteredDeposits","name":"Update registered deposit from online banking such as rrsp regular, rrsp spousal, etc","summary":"Update registered deposit from online banking","tags":["RETAIL"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"depositId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"partyIds":[{}],"partyRoles":[{}],"agentCustomerIds":[{}],"agentArrangementIds":[{}],"agentRoles":[{}],"arrangmentId":"string","productId":"string","activityId":"string","currency":"string","productVariation":"string","pricingSelection":"string","pricingPlan":"string","rewardsArrangementId":"string","tradeDate":"string","arrangementEffectiveDate":"string"}},"responses":{"200":"updateCaRegisteredDepositsResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}}]},{"key":"holdings-ca-regsiteredPlans-service-v1.1.0","title":"Registered Plans","version":"v1.1.0","description":"APIs to create, update, simulate and retrieve the registered plan products such as RRSP, RRIF, TFSA, etc","endpointCount":6,"endpoints":[{"method":"POST","path":"/holdings/ca/registeredPlans/accounts","fullPath":"/api/v1.1.0/holdings/ca/registeredPlans/accounts","operationId":"createCaRegisteredAccounts","name":"Create new registered account from online banking such as rrsp regular, rrsp spousal, etc","summary":"Create new registered account from online banking","tags":["RETAIL"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"partyIds":[{}],"partyRoles":[{}],"agentCustomerIds":[{}],"agentArrangementIds":[{}],"agentRoles":[{}],"arrangmentId":"string","productId":"string","activityId":"string","currency":"string","productVariation":"string","pricingSelection":"string","pricingPlan":"string","rewardsArrangementId":"string","tradeDate":"string","arrangementEffectiveDate":"string"}},"responses":{"200":"createCaRegisteredAccountsResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"PUT","path":"/holdings/ca/registeredPlans/accounts/{accountid}","fullPath":"/api/v1.1.0/holdings/ca/registeredPlans/accounts/{accountid}","operationId":"updateCaRegisteredAccounts","name":"Update registered account from online banking such as rrsp regular, rrsp spousal, etc","summary":"Update registered account from online banking","tags":["RETAIL"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"accountid","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"partyIds":[{}],"partyRoles":[{}],"agentCustomerIds":[{}],"agentArrangementIds":[{}],"agentRoles":[{}],"arrangmentId":"string","productId":"string","activityId":"string","currency":"string","productVariation":"string","pricingSelection":"string","pricingPlan":"string","rewardsArrangementId":"string","tradeDate":"string","arrangementEffectiveDate":"string"}},"responses":{"200":"updateCaRegisteredAccountsResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"POST","path":"/holdings/ca/registeredPlans/deposits","fullPath":"/api/v1.1.0/holdings/ca/registeredPlans/deposits","operationId":"createCaRegisteredDeposits","name":"Create new registered deposit from online banking such as rrsp regular, rrsp spousal, etc","summary":"Create new registered deposit from online banking","tags":["RETAIL"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"partyIds":[{}],"partyRoles":[{}],"agentCustomerIds":[{}],"agentArrangementIds":[{}],"agentRoles":[{}],"arrangmentId":"string","productId":"string","activityId":"string","currency":"string","productVariation":"string","pricingSelection":"string","pricingPlan":"string","rewardsArrangementId":"string","tradeDate":"string","arrangementEffectiveDate":"string"}},"responses":{"200":"createCaRegisteredDepositsResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"PUT","path":"/holdings/ca/registeredPlans/deposits/{depositId}","fullPath":"/api/v1.1.0/holdings/ca/registeredPlans/deposits/{depositId}","operationId":"updateCaRegisteredDeposits","name":"Update registered deposit from online banking such as rrsp regular, rrsp spousal, etc","summary":"Update registered deposit from online banking","tags":["RETAIL"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"depositId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"partyIds":[{}],"partyRoles":[{}],"agentCustomerIds":[{}],"agentArrangementIds":[{}],"agentRoles":[{}],"arrangmentId":"string","productId":"string","activityId":"string","currency":"string","productVariation":"string","pricingSelection":"string","pricingPlan":"string","rewardsArrangementId":"string","tradeDate":"string","arrangementEffectiveDate":"string"}},"responses":{"200":"updateCaRegisteredDepositsResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"GET","path":"/holdings/ca/portfolios/{portfolioId}","fullPath":"/api/v1.1.0/holdings/ca/portfolios/{portfolioId}","operationId":"getCaPortfolioDetails","name":"Retrieve the details of the registered plan products such as plan type, plan group, plan id, plan value, settlement account, etc based on portfolio id.","summary":"Retrieve the details of the registered plan products","tags":["RETAIL"],"parameters":[{"name":"portfolioId","in":"path","type":"string","required":true,"description":"Id of the portfolio or security account"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"CaPortfolioDetailsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/ca/registeredPlans/{portfolioId}/{taxYear}/transactions","fullPath":"/api/v1.1.0/holdings/ca/registeredPlans/{portfolioId}/{taxYear}/transactions","operationId":"getCaRegisteredPlansTransactions","name":"Reterive the details of the contribution and withdrawal towards registered plan account such as amount, ccy, value date, etc based on plan id","summary":"Reterive the details of the contribution and withdrawal towards registered plan account","tags":["RETAIL"],"parameters":[{"name":"portfolioId","in":"path","type":"string","required":true,"description":"Id of the portfolio or security account"},{"name":"taxYear","in":"path","type":"string","required":true,"description":"Contains the current tax year for the specific entity."},{"name":"debitCreditIndicator","in":"query","type":"string","required":false,"description":"Indicator flag which is set whenever a debit or a credit transaction happens in the account"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"CaRegisteredPlansTransactionsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}}]},{"key":"holdings-ca-regsiteredPlans-service-v1.2.0","title":"Registered Plans","version":"v1.2.0","description":"APIs to create, update, simulate and retrieve the registered plan products such as RRSP, RRIF, TFSA, etc","endpointCount":6,"endpoints":[{"method":"POST","path":"/holdings/ca/registeredPlans/accounts","fullPath":"/api/v1.2.0/holdings/ca/registeredPlans/accounts","operationId":"createCaRegisteredAccounts","name":"Create new registered account from online banking such as rrsp regular, rrsp spousal, etc","summary":"Create new registered account from online banking","tags":["RETAIL"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"partyIds":[{}],"partyRoles":[{}],"agentCustomerIds":[{}],"agentArrangementIds":[{}],"agentRoles":[{}],"arrangmentId":"string","productId":"string","activityId":"string","currency":"string","productVariation":"string","pricingSelection":"string","pricingPlan":"string","rewardsArrangementId":"string","tradeDate":"string","arrangementEffectiveDate":"string"}},"responses":{"200":"createCaRegisteredAccountsResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"PUT","path":"/holdings/ca/registeredPlans/accounts/{accountid}","fullPath":"/api/v1.2.0/holdings/ca/registeredPlans/accounts/{accountid}","operationId":"updateCaRegisteredAccounts","name":"Update registered account from online banking such as rrsp regular, rrsp spousal, etc","summary":"Update registered account from online banking","tags":["RETAIL"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"accountid","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"partyIds":[{}],"partyRoles":[{}],"agentCustomerIds":[{}],"agentArrangementIds":[{}],"agentRoles":[{}],"arrangmentId":"string","productId":"string","activityId":"string","currency":"string","productVariation":"string","pricingSelection":"string","pricingPlan":"string","rewardsArrangementId":"string","tradeDate":"string","arrangementEffectiveDate":"string"}},"responses":{"200":"updateCaRegisteredAccountsResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"POST","path":"/holdings/ca/registeredPlans/deposits","fullPath":"/api/v1.2.0/holdings/ca/registeredPlans/deposits","operationId":"createCaRegisteredDeposits","name":"Create new registered deposit from online banking such as rrsp regular, rrsp spousal, etc","summary":"Create new registered deposit from online banking","tags":["RETAIL"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"partyIds":[{}],"partyRoles":[{}],"agentCustomerIds":[{}],"agentArrangementIds":[{}],"agentRoles":[{}],"arrangmentId":"string","productId":"string","activityId":"string","currency":"string","productVariation":"string","pricingSelection":"string","pricingPlan":"string","rewardsArrangementId":"string","tradeDate":"string","arrangementEffectiveDate":"string"}},"responses":{"200":"createCaRegisteredDepositsResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"PUT","path":"/holdings/ca/registeredPlans/deposits/{depositId}","fullPath":"/api/v1.2.0/holdings/ca/registeredPlans/deposits/{depositId}","operationId":"updateCaRegisteredDeposits","name":"Update registered deposit from online banking such as rrsp regular, rrsp spousal, etc","summary":"Update registered deposit from online banking","tags":["RETAIL"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"depositId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"partyIds":[{}],"partyRoles":[{}],"agentCustomerIds":[{}],"agentArrangementIds":[{}],"agentRoles":[{}],"arrangmentId":"string","productId":"string","activityId":"string","currency":"string","productVariation":"string","pricingSelection":"string","pricingPlan":"string","rewardsArrangementId":"string","tradeDate":"string","arrangementEffectiveDate":"string"}},"responses":{"200":"updateCaRegisteredDepositsResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"GET","path":"/holdings/ca/portfolios/{portfolioId}","fullPath":"/api/v1.2.0/holdings/ca/portfolios/{portfolioId}","operationId":"getCaPortfolioDetails","name":"Retrieve the details of the registered plan products such as plan type, plan group, plan id, plan value, settlement account, etc based on portfolio id.","summary":"Retrieve the details of the registered plan products","tags":["RETAIL"],"parameters":[{"name":"portfolioId","in":"path","type":"string","required":true,"description":"Id of the portfolio or security account"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"CaPortfolioDetailsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/ca/registeredPlans/{portfolioId}/{taxYear}/transactions","fullPath":"/api/v1.2.0/holdings/ca/registeredPlans/{portfolioId}/{taxYear}/transactions","operationId":"getCaRegisteredPlansTransactions","name":"Reterive the details of the contribution and withdrawal towards registered plan account such as amount, ccy, value date, etc based on plan id","summary":"Reterive the details of the contribution and withdrawal towards registered plan account","tags":["RETAIL"],"parameters":[{"name":"portfolioId","in":"path","type":"string","required":true,"description":"Id of the portfolio or security account"},{"name":"taxYear","in":"path","type":"string","required":true,"description":"Contains the current tax year for the specific entity."},{"name":"debitCreditIndicator","in":"query","type":"string","required":false,"description":"Indicator flag which is set whenever a debit or a credit transaction happens in the account"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"CaRegisteredPlansTransactionsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}}]},{"key":"holdings-ca-simulationManagement-service-v1.0.0","title":"SimulationManagement","version":"v1.0.0","description":"API to create and update simulation for accounts, deposits, loans and registered plan products.","endpointCount":10,"endpoints":[{"method":"POST","path":"/holdings/ca/loans/simulations","fullPath":"/api/v1.0.0/holdings/ca/loans/simulations","operationId":"simulateCaLoan","name":"Simulate new loans from online banking to derive interest rates, term, schedule, etc","summary":"Simulate new loans from online banking","tags":["RETAIL"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"partyIds":[{}],"partyRoles":[{}],"agentCustomerIds":[{}],"agentArrangementIds":[{}],"agentRoles":[{}],"arrangmentId":"string","productId":"string","activityId":"string","currency":"string","productVariation":"string","pricingSelection":"string","pricingPlan":"string","rewardsArrangementId":"string","tradeDate":"string","arrangementEffectiveDate":"string"}},"responses":{"200":"simulateCaLoanResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"POST","path":"/holdings/ca/accounts/simulations","fullPath":"/api/v1.0.0/holdings/ca/accounts/simulations","operationId":"simulateCaAccounts","name":"Simulate new accounts from online banking to derive interest rates,charges,etc","summary":"Simulate new accounts from online banking","tags":["RETAIL"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"customerIds":[{}],"properties":[{}],"overrides":[{}],"productId":"string","masterArrangementId":"string","roleName":"string","currencyId":"string","effectiveDate":"2024-01-01","activityId":"string","transactionAmount":0.0,"reason":"string","automaticRun":"string","simulationRunReference":"string","synchronous":"string","extensions":{}}},"responses":{"200":"simulateCaAccountsResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"POST","path":"/holdings/ca/deposits/simulations","fullPath":"/api/v1.0.0/holdings/ca/deposits/simulations","operationId":"simulateCaDeposits","name":"Simulate new deposit from online banking such as short tem deposits, long term deposits, registered deposits, etc","summary":"Simulate new deposit from online banking","tags":["RETAIL"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"partyIds":[{}],"partyRoles":[{}],"agentCustomerIds":[{}],"agentArrangementIds":[{}],"agentRoles":[{}],"arrangmentId":"string","productId":"string","activityId":"string","currency":"string","productVariation":"string","pricingSelection":"string","pricingPlan":"string","rewardsArrangementId":"string","tradeDate":"string","arrangementEffectiveDate":"string"}},"responses":{"200":"simulateCaDepositsResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"POST","path":"/holdings/ca/registeredPlans/accounts/simulations","fullPath":"/api/v1.0.0/holdings/ca/registeredPlans/accounts/simulations","operationId":"simulateCaRegisteredAccounts","name":"Validate/simulate registered account from online banking for rrsp regular, rrsp spousal, etc","summary":"Validate/simulate registered account from online banking","tags":["RETAIL"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"partyIds":[{}],"partyRoles":[{}],"agentCustomerIds":[{}],"agentArrangementIds":[{}],"agentRoles":[{}],"arrangmentId":"string","productId":"string","activityId":"string","currency":"string","productVariation":"string","pricingSelection":"string","pricingPlan":"string","rewardsArrangementId":"string","tradeDate":"string","arrangementEffectiveDate":"string"}},"responses":{"200":"simulateCaRegisteredAccountsResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"POST","path":"/holdings/ca/registeredPlans/deposits/simulations","fullPath":"/api/v1.0.0/holdings/ca/registeredPlans/deposits/simulations","operationId":"simulateCaRegisteredDeposits","name":"Validate/simulate registered deposit from online banking for rrsp regular, rrsp spousal, etc","summary":"Validate/simulate registered deposit from online banking","tags":["RETAIL"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"partyIds":[{}],"partyRoles":[{}],"agentCustomerIds":[{}],"agentArrangementIds":[{}],"agentRoles":[{}],"arrangmentId":"string","productId":"string","activityId":"string","currency":"string","productVariation":"string","pricingSelection":"string","pricingPlan":"string","rewardsArrangementId":"string","tradeDate":"string","arrangementEffectiveDate":"string"}},"responses":{"200":"simulateCaRegisteredDepositsResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"PUT","path":"/holdings/ca/loans/simulations/{simulationRunReference}","fullPath":"/api/v1.0.0/holdings/ca/loans/simulations/{simulationRunReference}","operationId":"updateSimulateCaLoan","name":"Update simulation for new loans from online banking to derive interest rates, term, schedule, etc","summary":"Update simulation for new loans","tags":["RETAIL"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"simulationRunReference","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"partyIds":[{}],"partyRoles":[{}],"agentCustomerIds":[{}],"agentArrangementIds":[{}],"agentRoles":[{}],"arrangmentId":"string","productId":"string","activityId":"string","currency":"string","productVariation":"string","pricingSelection":"string","pricingPlan":"string","rewardsArrangementId":"string","tradeDate":"string","arrangementEffectiveDate":"string"}},"responses":{"200":"updateSimulateCaLoanResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"PUT","path":"/holdings/ca/accounts/simulations/{simulationRunReference}","fullPath":"/api/v1.0.0/holdings/ca/accounts/simulations/{simulationRunReference}","operationId":"updateSimulateCaAccounts","name":"Update simulation for new accounts from online banking to derive interest rates, charges,etc","summary":"Update simulation for new accounts","tags":["RETAIL"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"simulationRunReference","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"customerIds":[{}],"properties":[{}],"overrides":[{}],"productId":"string","masterArrangementId":"string","roleName":"string","currencyId":"string","effectiveDate":"2024-01-01","activityId":"string","transactionAmount":0.0,"reason":"string","automaticRun":"string","simulationRunReference":"string","synchronous":"string","extensions":{}}},"responses":{"200":"updateSimulateCaAccountsResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"PUT","path":"/holdings/ca/deposits/simulations/{simulationRunReference}","fullPath":"/api/v1.0.0/holdings/ca/deposits/simulations/{simulationRunReference}","operationId":"updateCaDepositSimulation","name":"Update simulation for deposit from online banking such as short term deposits, long term deposits, registered deposits, etc","summary":"Update simulation for deposit","tags":["RETAIL"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"simulationRunReference","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"partyIds":[{}],"partyRoles":[{}],"agentCustomerIds":[{}],"agentArrangementIds":[{}],"agentRoles":[{}],"arrangmentId":"string","productId":"string","activityId":"string","currency":"string","productVariation":"string","pricingSelection":"string","pricingPlan":"string","rewardsArrangementId":"string","tradeDate":"string","arrangementEffectiveDate":"string"}},"responses":{"200":"updateCaDepositSimulationResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"PUT","path":"/holdings/ca/registeredPlans/accounts/simulation/{simulationRunReference}","fullPath":"/api/v1.0.0/holdings/ca/registeredPlans/accounts/simulation/{simulationRunReference}","operationId":"updateSimulateCaRegisteredAccounts","name":"Update simulation for registered account from online banking for rrsp regular, rrsp spousal, etc","summary":"Update simulation for registered account","tags":["RETAIL"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"simulationRunReference","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"partyIds":[{}],"partyRoles":[{}],"agentCustomerIds":[{}],"agentArrangementIds":[{}],"agentRoles":[{}],"arrangmentId":"string","productId":"string","activityId":"string","currency":"string","productVariation":"string","pricingSelection":"string","pricingPlan":"string","rewardsArrangementId":"string","tradeDate":"string","arrangementEffectiveDate":"string"}},"responses":{"200":"updateSimulateCaRegisteredAccountsResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"PUT","path":"/holdings/ca/registeredPlans/deposits/simulation/{simulationRunReference}","fullPath":"/api/v1.0.0/holdings/ca/registeredPlans/deposits/simulation/{simulationRunReference}","operationId":"updateSimulateCaRegisteredDeposits","name":"Update simulation for registered deposit from online banking for rrsp regular, rrsp spousal, etc","summary":"Update simulation for registered deposit","tags":["RETAIL"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"simulationRunReference","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"partyIds":[{}],"partyRoles":[{}],"agentCustomerIds":[{}],"agentArrangementIds":[{}],"agentRoles":[{}],"arrangmentId":"string","productId":"string","activityId":"string","currency":"string","productVariation":"string","pricingSelection":"string","pricingPlan":"string","rewardsArrangementId":"string","tradeDate":"string","arrangementEffectiveDate":"string"}},"responses":{"200":"updateSimulateCaRegisteredDepositsResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}}]},{"key":"holdings-ca-simulationManagement-service-v2.0.0","title":"Simulation Management","version":"v2.0.0","description":"API to create and update simulation for accounts, deposits, loans and registered plan products.","endpointCount":10,"endpoints":[{"method":"POST","path":"/holdings/ca/loans/simulations","fullPath":"/api/v2.0.0/holdings/ca/loans/simulations","operationId":"simulateCaLoan","name":"Simulate new loans from online banking to derive interest rates, term, schedule, etc","summary":"Simulate new loans from online banking","tags":["RETAIL"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"properties":[{}],"overrides":[{}],"reasons":[{}],"partyIds":[{}],"partyRoles":[{}],"agentCustomerIds":[{}],"agentArrangementIds":[{}],"agentRoles":[{}],"masterArrangementId":"string","roleName":"string","transactionAmount":"string","simulationRunReference":"string","productId":"string","activityId":"string","currency":"string"}},"responses":{"200":"simulateCaLoanResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"POST","path":"/holdings/ca/accounts/simulations","fullPath":"/api/v2.0.0/holdings/ca/accounts/simulations","operationId":"simulateCaAccounts","name":"Simulate new accounts from online banking to derive interest rates,charges,etc","summary":"Simulate new accounts from online banking","tags":["RETAIL"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"properties":[{}],"overrides":[{}],"reasons":[{}],"partyIds":[{}],"partyRoles":[{}],"agentCustomerIds":[{}],"agentArrangementIds":[{}],"agentRoles":[{}],"masterArrangementId":"string","roleName":"string","transactionAmount":"string","simulationRunReference":"string","productId":"string","activityId":"string","currency":"string"}},"responses":{"200":"simulateCaAccountsResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"POST","path":"/holdings/ca/deposits/simulations","fullPath":"/api/v2.0.0/holdings/ca/deposits/simulations","operationId":"simulateCaDeposits","name":"Simulate new deposit from online banking such as short tem deposits, long term deposits, registered deposits, etc","summary":"Simulate new deposit from online banking","tags":["RETAIL"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"properties":[{}],"overrides":[{}],"reasons":[{}],"partyIds":[{}],"partyRoles":[{}],"agentCustomerIds":[{}],"agentArrangementIds":[{}],"agentRoles":[{}],"masterArrangementId":"string","roleName":"string","transactionAmount":"string","simulationRunReference":"string","productId":"string","activityId":"string","currency":"string"}},"responses":{"200":"simulateCaDepositsResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"POST","path":"/holdings/ca/registeredPlans/accounts/simulations","fullPath":"/api/v2.0.0/holdings/ca/registeredPlans/accounts/simulations","operationId":"simulateCaRegisteredAccounts","name":"Validate/simulate registered account from online banking for rrsp regular, rrsp spousal, etc","summary":"Validate/simulate registered account from online banking","tags":["RETAIL"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"properties":[{}],"overrides":[{}],"reasons":[{}],"partyIds":[{}],"partyRoles":[{}],"agentCustomerIds":[{}],"agentArrangementIds":[{}],"agentRoles":[{}],"masterArrangementId":"string","roleName":"string","transactionAmount":"string","simulationRunReference":"string","productId":"string","activityId":"string","currency":"string"}},"responses":{"200":"simulateCaRegisteredAccountsResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"POST","path":"/holdings/ca/registeredPlans/deposits/simulations","fullPath":"/api/v2.0.0/holdings/ca/registeredPlans/deposits/simulations","operationId":"simulateCaRegisteredDeposits","name":"Validate/simulate registered deposit from online banking for rrsp regular, rrsp spousal, etc","summary":"Validate/simulate registered deposit from online banking","tags":["RETAIL"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"properties":[{}],"overrides":[{}],"reasons":[{}],"partyIds":[{}],"partyRoles":[{}],"agentCustomerIds":[{}],"agentArrangementIds":[{}],"agentRoles":[{}],"masterArrangementId":"string","roleName":"string","transactionAmount":"string","simulationRunReference":"string","productId":"string","activityId":"string","currency":"string"}},"responses":{"200":"simulateCaRegisteredDepositsResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"PUT","path":"/holdings/ca/loans/simulations/{simulationRunReference}","fullPath":"/api/v2.0.0/holdings/ca/loans/simulations/{simulationRunReference}","operationId":"updateSimulateCaLoan","name":"Update simulation for new loans from online banking to derive interest rates, term, schedule, etc","summary":"Update simulation for new loans","tags":["RETAIL"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"simulationRunReference","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"properties":[{}],"overrides":[{}],"reasons":[{}],"partyIds":[{}],"partyRoles":[{}],"agentCustomerIds":[{}],"agentArrangementIds":[{}],"agentRoles":[{}],"masterArrangementId":"string","roleName":"string","transactionAmount":"string","simulationRunReference":"string","productId":"string","activityId":"string","currency":"string"}},"responses":{"200":"updateSimulateCaLoanResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"PUT","path":"/holdings/ca/accounts/simulations/{simulationRunReference}","fullPath":"/api/v2.0.0/holdings/ca/accounts/simulations/{simulationRunReference}","operationId":"updateSimulateCaAccounts","name":"Update simulation for new accounts from online banking to derive interest rates, charges,etc","summary":"Update simulation for new accounts","tags":["RETAIL"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"simulationRunReference","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"properties":[{}],"overrides":[{}],"reasons":[{}],"partyIds":[{}],"partyRoles":[{}],"agentCustomerIds":[{}],"agentArrangementIds":[{}],"agentRoles":[{}],"masterArrangementId":"string","roleName":"string","transactionAmount":"string","simulationRunReference":"string","productId":"string","activityId":"string","currency":"string"}},"responses":{"200":"updateSimulateCaAccountsResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"PUT","path":"/holdings/ca/deposits/simulations/{simulationRunReference}","fullPath":"/api/v2.0.0/holdings/ca/deposits/simulations/{simulationRunReference}","operationId":"updateCaDepositSimulation","name":"Update simulation for deposit from online banking such as short term deposits, long term deposits, registered deposits, etc","summary":"Update simulation for deposit","tags":["RETAIL"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"simulationRunReference","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"properties":[{}],"overrides":[{}],"reasons":[{}],"partyIds":[{}],"partyRoles":[{}],"agentCustomerIds":[{}],"agentArrangementIds":[{}],"agentRoles":[{}],"masterArrangementId":"string","roleName":"string","transactionAmount":"string","simulationRunReference":"string","productId":"string","activityId":"string","currency":"string"}},"responses":{"200":"updateCaDepositSimulationResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"PUT","path":"/holdings/ca/registeredPlans/accounts/simulations/{simulationRunReference}","fullPath":"/api/v2.0.0/holdings/ca/registeredPlans/accounts/simulations/{simulationRunReference}","operationId":"updateSimulateCaRegisteredAccounts","name":"Update simulation for registered account from online banking for rrsp regular, rrsp spousal, etc","summary":"Update simulation for registered account","tags":["RETAIL"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"simulationRunReference","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"properties":[{}],"overrides":[{}],"reasons":[{}],"partyIds":[{}],"partyRoles":[{}],"agentCustomerIds":[{}],"agentArrangementIds":[{}],"agentRoles":[{}],"masterArrangementId":"string","roleName":"string","transactionAmount":"string","simulationRunReference":"string","productId":"string","activityId":"string","currency":"string"}},"responses":{"200":"updateSimulateCaRegisteredAccountsResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"PUT","path":"/holdings/ca/registeredPlans/deposits/simulations/{simulationRunReference}","fullPath":"/api/v2.0.0/holdings/ca/registeredPlans/deposits/simulations/{simulationRunReference}","operationId":"updateSimulateCaRegisteredDeposits","name":"Update simulation for registered deposit from online banking for rrsp regular, rrsp spousal, etc","summary":"Update simulation for registered deposit","tags":["RETAIL"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"simulationRunReference","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"properties":[{}],"overrides":[{}],"reasons":[{}],"partyIds":[{}],"partyRoles":[{}],"agentCustomerIds":[{}],"agentArrangementIds":[{}],"agentRoles":[{}],"masterArrangementId":"string","roleName":"string","transactionAmount":"string","simulationRunReference":"string","productId":"string","activityId":"string","currency":"string"}},"responses":{"200":"updateSimulateCaRegisteredDepositsResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}}]},{"key":"holdings-cards-service-v1.0.0","title":"Account Cards","version":"v1.0.0","description":"API to create, update and manage various types of Cards Issued to the Account","endpointCount":4,"endpoints":[{"method":"GET","path":"/holdings/cards","fullPath":"/api/v1.0.0/holdings/cards","operationId":"getCardIssues","name":"Retrieves the Card details of the Account such as Card Number, Card Type, Issue Date, Cancellation Date & Status of the Card","summary":"Retrieves issued cards details of an account","tags":[],"parameters":[{"name":"cardIssueId","in":"query","type":"string","required":false,"description":"The identifier of the issued card formatted as cardType '.' cardNumber. E.g. VISA.1234567887654321 GC.1111222233334444 AB21.1111111122222222"},{"name":"accountId","in":"query","type":"string","required":false,"description":"Identifier of the account. Often referred to as the account number, yet for consistency this is always referred to as accountId. Accepts both IBAN & BBAN"},{"name":"issueDate","in":"query","type":"string","required":false,"description":"The date the item was issued."},{"name":"expiryDate","in":"query","type":"string","required":false,"description":"The date an agreement such as an arrangement, product, credit facility or limit is due to expire"},{"name":"cardStatus","in":"query","type":"string","required":false,"description":"Current status of the Card and following are the possible statuses are  - CARD.ISSUED - CARD.RETURNED - CARD.SCRAP - CARD.CANCEL - NOT.ACTIVATED - NOT.RECEIVED - ACTIVE - BLOCKED - EXPIRED"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from t24 on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"The identifier of the underlying Entity/Company/Branch."}],"requestBodyExample":null,"responses":{"200":"CardIssuesResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"POST","path":"/holdings/cards/{cardIssueId}","fullPath":"/api/v1.0.0/holdings/cards/{cardIssueId}","operationId":"createCardIssue","name":"Create Card issue request with details such as Card Status, Issue Date, Pin Issue Date, Cancellation Date & Reason","summary":"Creates Card issue request for an account","tags":[],"parameters":[{"name":"cardIssueId","in":"path","type":"string","required":true,"description":"The identifier of the issued card formatted as cardType '.' cardNumber. E.g. VISA.1234567887654321 GC.1111222233334444 AB21.1111111122222222"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"The identifier of the underlying Entity/Company/Branch."}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"accountIds":[{}],"cardNames":[{}],"notes":[{}],"cardStatus":"string","currencyId":"string","issueDate":"2024-01-01","expiryDate":"2024-01-01","pinIssueDate":"2024-01-01","cancellationDate":"2024-01-01","cancellationReason":"string"}},"responses":{"200":"CardIssueResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/holdings/cards/{cardIssueId}","fullPath":"/api/v1.0.0/holdings/cards/{cardIssueId}","operationId":"updateCardIssue","name":"Update Card issue request with Card Status, Issue Date, Pin Issue Date, Cancellation Date & Reason","summary":"Updates Card status of an account","tags":[],"parameters":[{"name":"cardIssueId","in":"path","type":"string","required":true,"description":"The identifier of the issued card formatted as cardType '.' cardNumber. E.g. VISA.1234567887654321 GC.1111222233334444 AB21.1111111122222222"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"The identifier of the underlying Entity/Company/Branch."}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"accountIds":[{}],"cardNames":[{}],"notes":[{}],"cardStatus":"string","currencyId":"string","issueDate":"2024-01-01","expiryDate":"2024-01-01","pinIssueDate":"2024-01-01","cancellationDate":"2024-01-01","cancellationReason":"string"}},"responses":{"200":"CardIssueResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"DELETE","path":"/holdings/cards/{cardIssueId}","fullPath":"/api/v1.0.0/holdings/cards/{cardIssueId}","operationId":"deleteCardIssue","name":"Delete or revoke the card issue request for an Account","summary":"Removes a issued card for an account","tags":[],"parameters":[{"name":"cardIssueId","in":"path","type":"string","required":true,"description":"The identifier of the issued card formatted as cardType '.' cardNumber. E.g. VISA.1234567887654321 GC.1111222233334444 AB21.1111111122222222"},{"name":"payload","in":"body","type":"object","required":false,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"The identifier of the underlying Entity/Company/Branch."}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}}},"responses":{"200":"CardIssueResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}}]},{"key":"holdings-cards-service-v2.0.0","title":"Account Cards","version":"v2.0.0","description":"API to create, update and manage various types of cards issued to the account","endpointCount":4,"endpoints":[{"method":"POST","path":"/holdings/cards/{cardIssueId}","fullPath":"/api/v2.0.0/holdings/cards/{cardIssueId}","operationId":"createCardIssue","name":"Create card issue request with details such as card status, issue date, pin issue date and charges","summary":"Creates card issue request for an account","tags":[],"parameters":[{"name":"cardIssueId","in":"path","type":"string","required":true,"description":"The identifier of the issued card formatted as cardType '.' cardNumber. E.g. VISA.1234567887654321 GC.1111222233334444 AB21.1111111122222222"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"accountIds":[{}],"cardNames":[{}],"notes":[{}],"cardStatus":"string","currencyId":"string","issueDate":"2024-01-01","expiryDate":"2024-01-01","pinIssueDate":"2024-01-01","cancellationDate":"2024-01-01","cancellationReason":"string","customerId":"string","cardDisplayNumber":"string","charge":"string","chargeDate":"string"}},"responses":{"200":"CardIssueResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/holdings/cards/{cardIssueId}","fullPath":"/api/v2.0.0/holdings/cards/{cardIssueId}","operationId":"updateCardIssue","name":"Update card issue request with card status, issue date, pin issue date, cancellation date & reason","summary":"Updates card issue request of an account","tags":[],"parameters":[{"name":"cardIssueId","in":"path","type":"string","required":true,"description":"The identifier of the issued card formatted as cardType '.' cardNumber. E.g. VISA.1234567887654321 GC.1111222233334444 AB21.1111111122222222"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"accountIds":[{}],"cardNames":[{}],"notes":[{}],"cardStatus":"string","currencyId":"string","issueDate":"2024-01-01","expiryDate":"2024-01-01","pinIssueDate":"2024-01-01","cancellationDate":"2024-01-01","cancellationReason":"string","customerId":"string","cardDisplayNumber":"string","charge":"string","chargeDate":"string"}},"responses":{"200":"CardIssueResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"DELETE","path":"/holdings/cards/{cardIssueId}","fullPath":"/api/v2.0.0/holdings/cards/{cardIssueId}","operationId":"deleteCardIssue","name":"Delete or revoke the card issue request for an account","summary":"Removes an issued card for an account","tags":[],"parameters":[{"name":"cardIssueId","in":"path","type":"string","required":true,"description":"The identifier of the issued card formatted as cardType '.' cardNumber. E.g. VISA.1234567887654321 GC.1111222233334444 AB21.1111111122222222"},{"name":"payload","in":"body","type":"object","required":false,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}}},"responses":{"200":"CardIssueResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/holdings/cards","fullPath":"/api/v2.0.0/holdings/cards","operationId":"getCardIssues","name":"Retrieves the card details of the account such as card number, card type, issue date, cancellation date, reason & status of the card","summary":"Retrieves issued cards details of an account","tags":[],"parameters":[{"name":"cardIssueId","in":"query","type":"string","required":false,"description":"The identifier of the issued card formatted as cardType '.' cardNumber. E.g. VISA.1234567887654321 GC.1111222233334444 AB21.1111111122222222"},{"name":"accountId","in":"query","type":"string","required":false,"description":"Identifier of the account. Often referred to as the account number, yet for consistency this is always referred to as accountId. Accepts both IBAN & BBAN"},{"name":"issueDate","in":"query","type":"string","required":false,"description":"The date the item was issued."},{"name":"expiryDate","in":"query","type":"string","required":false,"description":"The date an agreement such as an arrangement, product, credit facility or limit is due to expire"},{"name":"cardStatus","in":"query","type":"string","required":false,"description":"Current status of the Card and following are the possible statuses are  - CARD.ISSUED - CARD.RETURNED - CARD.SCRAP - CARD.CANCEL - NOT.ACTIVATED - NOT.RECEIVED - ACTIVE - BLOCKED - EXPIRED"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"CardIssuesResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}}]},{"key":"holdings-cashManagement-service-v1.0.0","title":"Cash Management Holdings","version":"v1.0.0","description":"Cash management API","endpointCount":21,"endpoints":[{"method":"POST","path":"/holdings/cashManagement/sweepGroups/{sweepGroupId}","fullPath":"/api/v1.0.0/holdings/cashManagement/sweepGroups/{sweepGroupId}","operationId":"createVirtualAccountsSweepGroup","name":"Creates the basic details of a group for a sweep. A group is a collection of accounts that are linked for cash pooling purposes.","summary":"Creates the basic details of a group for a sweep. A group is a collection of accounts that are linked for cash pooling purposes.","tags":["CORPORATE"],"parameters":[{"name":"sweepGroupId","in":"path","type":"string","required":true,"description":"Identifier of the sweep group"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"description":"string","intraDay":"string","subGroup":"string","mainGroupId":"Main Group ID","mainMaster":"string","currency":"string","sequencing":"string","balanceTypeBalance":"string","floatTransfer":"Select Yes for Float Transfer","rulePriority":"string","exchangeRateType":"string","exchangeRateSpread":"string","sweepChargeCode":"string","suspensionStartDate":"string","suspensionEndDate":"string"}},"responses":{"200":"VirtualAccountsSweepGroupResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"POST","path":"/holdings/cashManagement/transactionAccounts/forexPricings","fullPath":"/api/v1.0.0/holdings/cashManagement/transactionAccounts/forexPricings","operationId":"createTransactionAccountForexPricing","name":"Internal Foreign Exchange allows the corporate customer to perform cross-currency movements without affecting the bank currency positions.","summary":"Creation of  forex pricing for transaction account.","tags":["CORPORATE"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"arrangementCustomerIds":[{}],"pricingPlan":[{}],"arrangementEffectiveDate":"string","productId":"string","activityId":"string","extensions":{},"internalFx":[{}]}},"responses":{"200":"createTransactionAccountForexPricingResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"PUT","path":"/holdings/cashManagement/bundles/{bundleId}/closures","fullPath":"/api/v1.0.0/holdings/cashManagement/bundles/{bundleId}/closures","operationId":"deleteBundle","name":"Closes the bundle or cashpool.","summary":"Closure of bundle","tags":["CORPORATE"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"bundleId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"arrangementCustomerIds":[{}],"pricingPlan":[{}],"arrangementEffectiveDate":"string","productId":"string","activityId":"string","extensions":{}}},"responses":{"200":"deleteBundleResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"PUT","path":"/holdings/cashManagement/bundles/{bundleId}/goLiveDates","fullPath":"/api/v1.0.0/holdings/cashManagement/bundles/{bundleId}/goLiveDates","operationId":"updateBundleGoliveDate","name":"Updates golive date for the master arrangement. This is the date from which the master arrangement will become effective.","summary":"Updates golive date for the master arrangement.","tags":["CORPORATE"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"bundleId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"arrangementCustomerIds":[{}],"pricingPlan":[{}],"arrangementEffectiveDate":"string","productId":"string","activityId":"string","extensions":{},"productBundle":[{}]}},"responses":{"200":"updateBundleGoliveDateResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"PUT","path":"/holdings/cashManagement/bundles/{bundleId}/prelimStructure","fullPath":"/api/v1.0.0/holdings/cashManagement/bundles/{bundleId}/prelimStructure","operationId":"updateVirtualAccountDraftStructure","name":"Updates the bundle arrangement status from draft to pending live with all the accounts created.","summary":"Moves draft structure to preliminary structure","tags":["CORPORATE"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"bundleId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"arrangementCustomerIds":[{}],"pricingPlan":[{}],"arrangementEffectiveDate":"string","productId":"string","activityId":"string","extensions":{},"bundlehierarchy":[{}]}},"responses":{"200":"updateVirtualAccountDraftStructureResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"PUT","path":"/holdings/cashManagement/transactionAccounts/{transactionAccountId}/preliminaryStructures","fullPath":"/api/v1.0.0/holdings/cashManagement/transactionAccounts/{transactionAccountId}/preliminaryStructures","operationId":"updatePreliminaryVirtualAccounts","name":"Updates new accounts to the preliminary or modify the existing accounts from the preliminary structure.","summary":"Updates new or modify existing accounts","tags":["CORPORATE"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"transactionAccountId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"arrangementCustomerIds":[{}],"pricingPlan":[{}],"arrangementEffectiveDate":"string","productId":"string","activityId":"string","extensions":{},"bundlehierarchy":[{}]}},"responses":{"200":"updatePreliminaryVirtualAccountsResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"PUT","path":"/holdings/cashManagement/summaryAccounts/{summaryAccountId}/penaltyInterestConditions","fullPath":"/api/v1.0.0/holdings/cashManagement/summaryAccounts/{summaryAccountId}/penaltyInterestConditions","operationId":"updateSummaryAccountPenaltyInterestCondition","name":"Updates the penalty interest conditions on summary accounts","summary":"Updates the penalty interest conditions on summary accounts","tags":["CORPORATE"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"summaryAccountId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"arrangementCustomerIds":[{}],"pricingPlan":[{}],"arrangementEffectiveDate":"string","productId":"string","activityId":"string","extensions":{},"penalint":[{}]}},"responses":{"200":"updateSummaryAccountPenaltyInterestConditionResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"PUT","path":"/holdings/cashManagement/transactionAccounts/{transactionAccountId}/settlementInstructions","fullPath":"/api/v1.0.0/holdings/cashManagement/transactionAccounts/{transactionAccountId}/settlementInstructions","operationId":"updateVirtualAccountSettlementInstructions","name":"Updates settlement instructions on trading account","summary":"Updates settlement instructions on trading account","tags":["CORPORATE"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"transactionAccountId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"arrangementCustomerIds":[{}],"pricingPlan":[{}],"arrangementEffectiveDate":"string","productId":"string","activityId":"string","extensions":{},"settlement":[{}]}},"responses":{"200":"updateVirtualAccountSettlementInstructionsResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"PUT","path":"/holdings/cashManagement/summaryAccounts/{summaryAccountId}/settlementInstructions","fullPath":"/api/v1.0.0/holdings/cashManagement/summaryAccounts/{summaryAccountId}/settlementInstructions","operationId":"updateSummaryAccountSettlementInstructions","name":"Updates settlement instructions on summary accounts","summary":"Updates settlement instructions on summary accounts","tags":["CORPORATE"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"summaryAccountId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"arrangementCustomerIds":[{}],"pricingPlan":[{}],"arrangementEffectiveDate":"string","productId":"string","activityId":"string","extensions":{},"settlement":[{}]}},"responses":{"200":"updateSummaryAccountSettlementInstructionsResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"PUT","path":"/holdings/cashManagement/transactionAccounts/{transactionAccountId}/secondaryLimits","fullPath":"/api/v1.0.0/holdings/cashManagement/transactionAccounts/{transactionAccountId}/secondaryLimits","operationId":"updateVirtualAccountSecondaryLimits","name":"Updates the secondary limit for virtual accounts. This helps in monitoring the availability and utilisation of limits.","summary":"Updates secondary limit on virtual accounts","tags":["CORPORATE"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"transactionAccountId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"arrangementCustomerIds":[{}],"pricingPlan":[{}],"arrangementEffectiveDate":"string","productId":"string","activityId":"string","extensions":{},"limit":[{}]}},"responses":{"200":"updateVirtualAccountSecondaryLimitsResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"PUT","path":"/holdings/cashManagement/summaryAccounts/{summaryAccountId}/secondaryLimits","fullPath":"/api/v1.0.0/holdings/cashManagement/summaryAccounts/{summaryAccountId}/secondaryLimits","operationId":"updateSummaryAccountSecondaryLimits","name":"Updates the secondary limit for summary accounts. This helps in monitoring the availability and utilisation of limits.","summary":"Updates secondary limit for summary accounts","tags":["CORPORATE"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"summaryAccountId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"arrangementCustomerIds":[{}],"pricingPlan":[{}],"arrangementEffectiveDate":"string","productId":"string","activityId":"string","extensions":{},"limit":[{}]}},"responses":{"200":"updateSummaryAccountSecondaryLimitsResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"PUT","path":"/holdings/cashManagement/summaryAccounts/{summaryAccountId}/schedules","fullPath":"/api/v1.0.0/holdings/cashManagement/summaryAccounts/{summaryAccountId}/schedules","operationId":"updateSummaryAccountPaymentSchedule","name":"Updates payment schedule on summary account","summary":"Updates payment schedule on summary accounts","tags":["CORPORATE"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"summaryAccountId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"arrangementCustomerIds":[{}],"pricingPlan":[{}],"arrangementEffectiveDate":"string","productId":"string","activityId":"string","extensions":{},"inhSchedule":[{}]}},"responses":{"200":"updateSummaryAccountPaymentScheduleResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"PUT","path":"/holdings/cashManagement/transactionAccounts/{transactionAccountId}/postingRestrictions/revocations","fullPath":"/api/v1.0.0/holdings/cashManagement/transactionAccounts/{transactionAccountId}/postingRestrictions/revocations","operationId":"updateVirtualAccountPostingRestrictionRevocation","name":"Unblocks a particular virtual account and transactions can be initiated post the defined blocked end date.","summary":"Unblocks the virtual account.","tags":["CORPORATE"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"transactionAccountId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"arrangementCustomerIds":[{}],"pricingPlan":[{}],"arrangementEffectiveDate":"string","productId":"string","activityId":"string","extensions":{},"balance":[{}]}},"responses":{"200":"updateVirtualAccountPostingRestrictionRevocationResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"PUT","path":"/holdings/cashManagement/summaryAccounts/{summaryAccountId}/postingRestrictions/revocations","fullPath":"/api/v1.0.0/holdings/cashManagement/summaryAccounts/{summaryAccountId}/postingRestrictions/revocations","operationId":"updateSummaryAccountPostingRestrictionRevocation","name":"Unblocks a particular summary account and transactions can be initiated post the defined blocked end date.","summary":"Unblocks the summary account.","tags":["CORPORATE"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"summaryAccountId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"arrangementCustomerIds":[{}],"pricingPlan":[{}],"arrangementEffectiveDate":"string","productId":"string","activityId":"string","extensions":{},"summary":[{}]}},"responses":{"200":"updateSummaryAccountPostingRestrictionRevocationResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"PUT","path":"/holdings/cashManagement/bundles/{bundleId}/schedules","fullPath":"/api/v1.0.0/holdings/cashManagement/bundles/{bundleId}/schedules","operationId":"updateBundlePaymentSchedule","name":"Updates payment schedule on a bundle in live structure.","summary":"Updates payment schedule on a bundle","tags":["CORPORATE"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"bundleId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"arrangementCustomerIds":[{}],"pricingPlan":[{}],"arrangementEffectiveDate":"string","productId":"string","activityId":"string","extensions":{},"schedule":[{}]}},"responses":{"200":"updateBundlePaymentScheduleResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"PUT","path":"/holdings/cashManagement/bundles/{bundleId}/masterAccounts/forexPricings","fullPath":"/api/v1.0.0/holdings/cashManagement/bundles/{bundleId}/masterAccounts/forexPricings","operationId":"updateForexToMasterAccount","name":"Updates forex pricing to master account","summary":"Updates forex pricing to master account","tags":["CORPORATE"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"bundleId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"arrangementCustomerIds":[{}],"pricingPlan":[{}],"arrangementEffectiveDate":"string","productId":"string","activityId":"string","extensions":{}}},"responses":{"200":"updateForexToMasterAccountResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"GET","path":"/holdings/cashManagement/accounts/{accountId}/summary","fullPath":"/api/v1.0.0/holdings/cashManagement/accounts/{accountId}/summary","operationId":"getSummaryAccountDetails","name":"Retrieve the arrangement details of a bundle, summary accounts, currency summary accounts and virtual accounts.","summary":"Retrieve the arrangement details of a bundle, summary accounts, currency summary accounts and virtual accounts.","tags":["CORPORATE"],"parameters":[{"name":"accountId","in":"path","type":"string","required":true,"description":"Identifier of the account. Often referred to as the account number, yet for consistency this is always referred to as accountId. Accepts both IBAN & BBAN"},{"name":"arrangementId","in":"query","type":"string","required":false,"description":"Indicates an unique identifier of an account"},{"name":"customer","in":"query","type":"string","required":false,"description":"Contains the customer identifier to fetch list of consent arrangements for the customer or customer identifier of the debtor account. This will be populated once the SCA(Strong Customer Authentication"},{"name":"customerRole","in":"query","type":"string","required":false,"description":"Indicates role of a customer for an arrangement."},{"name":"currency","in":"query","type":"string","required":false,"description":"Identifies the currency. E.g. USD, GBP etc"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"SummaryAccountDetailsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/cashManagement/transactionAccounts/{transactionAccountId}/interestDetailsCurrent","fullPath":"/api/v1.0.0/holdings/cashManagement/transactionAccounts/{transactionAccountId}/interestDetailsCurrent","operationId":"getCurrentPeriodAccruedInterestDetails","name":"Retrieve the accrued interest details of virtual accounts for the current period.","summary":"Retrieve the accrued interest details of virtual accounts for the current period.","tags":["CORPORATE"],"parameters":[{"name":"transactionAccountId","in":"path","type":"string","required":true,"description":"This field forms part of an associated multi-value set to specify the details of an Account during one of Restructure events"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"CurrentPeriodAccruedInterestDetailsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/cashManagement/transactionAccounts/{transactionAccountId}/interestDetailsPrevious","fullPath":"/api/v1.0.0/holdings/cashManagement/transactionAccounts/{transactionAccountId}/interestDetailsPrevious","operationId":"getPreviousPeriodInterestDetails","name":"Retrieve the interest details of virtual accounts for the previous period.","summary":"Retrieve the interest details of virtual accounts for the previous period.","tags":["CORPORATE"],"parameters":[{"name":"transactionAccountId","in":"path","type":"string","required":true,"description":"This field forms part of an associated multi-value set to specify the details of an Account during one of Restructure events"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"PreviousPeriodInterestDetailsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/cashManagement/transactionAccounts/{transactionAccountId}/interestDetailsYearToDate","fullPath":"/api/v1.0.0/holdings/cashManagement/transactionAccounts/{transactionAccountId}/interestDetailsYearToDate","operationId":"getTotalInterestDetails","name":"Retrieve the total interest details of virtual accounts.","summary":"Retrieve the total interest details of virtual accounts.","tags":["CORPORATE"],"parameters":[{"name":"transactionAccountId","in":"path","type":"string","required":true,"description":"This field forms part of an associated multi-value set to specify the details of an Account during one of Restructure events"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"TotalInterestDetailsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/cashManagement/bundles/{bundleId}/forexPricings","fullPath":"/api/v1.0.0/holdings/cashManagement/bundles/{bundleId}/forexPricings","operationId":"getBundleForexDetails","name":"Retrieve the internal forex details of a bundle","summary":"Retrieve the internal forex details of a bundle","tags":["CORPORATE"],"parameters":[{"name":"bundleId","in":"path","type":"string","required":true,"description":"Indicates an arrangement reference which acts as a master for the sub arrangements being created"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"BundleForexDetailsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}}]},{"key":"holdings-cashManagement-service-v2.0.0","title":"Cash Management Holdings","version":"v2.0.0","description":"Cash API Management","endpointCount":24,"endpoints":[{"method":"POST","path":"/holdings/cashManagement/sweepGroups/{sweepGroupId}","fullPath":"/api/v2.0.0/holdings/cashManagement/sweepGroups/{sweepGroupId}","operationId":"createVirtualAccountsSweepGroup","name":"Creates the basic details of a group for a sweep. A group is a collection of accounts that are linked for cash pooling purposes.","summary":"Creates the basic details of a group for a sweep. A group is a collection of accounts that are linked for cash pooling purposes.","tags":["CORPORATE"],"parameters":[{"name":"sweepGroupId","in":"path","type":"string","required":true,"description":"Identifier of the sweep group"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"description":"string","intraDay":"string","subGroup":"string","mainGroupId":"Main Group ID","mainMaster":"string","currency":"string","sequencing":"string","balanceTypeBalance":"string","floatTransfer":"Select Yes for Float Transfer","rulePriority":"string","exchangeRateType":"string","exchangeRateSpread":"string","sweepChargeCode":"string","suspensionStartDate":"string","suspensionEndDate":"string"}},"responses":{"200":"VirtualAccountsSweepGroupResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"POST","path":"/holdings/cashManagement/transactionAccounts/forexPricings","fullPath":"/api/v2.0.0/holdings/cashManagement/transactionAccounts/forexPricings","operationId":"createTransactionAccountForexPricing","name":"Internal foreign exchange allows the corporate customer to perform cross-currency movements without affecting the bank currency positions.","summary":"Creation of  forex pricing for transaction account.","tags":["CORPORATE"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"arrangementCustomerIds":[{}],"pricingPlan":[{}],"arrangementEffectiveDate":"string","productId":"string","activityId":"string","extensions":{},"internalFx":[{}]}},"responses":{"200":"createTransactionAccountForexPricingResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"PUT","path":"/holdings/cashManagement/bundles/{bundleId}/closures","fullPath":"/api/v2.0.0/holdings/cashManagement/bundles/{bundleId}/closures","operationId":"deleteBundle","name":"Closes the bundle or cashpool.","summary":"Closure of bundle","tags":["CORPORATE"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"bundleId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"arrangementCustomerIds":[{}],"pricingPlan":[{}],"arrangementEffectiveDate":"string","productId":"string","activityId":"string","extensions":{}}},"responses":{"200":"deleteBundleResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"PUT","path":"/holdings/cashManagement/bundles/{bundleId}/goLiveDates","fullPath":"/api/v2.0.0/holdings/cashManagement/bundles/{bundleId}/goLiveDates","operationId":"updateBundleGoliveDate","name":"Updates golive date for the master arrangement. This is the date from which the master arrangement will become effective.","summary":"Updates golive date for the master arrangement.","tags":["CORPORATE"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"bundleId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"arrangementCustomerIds":[{}],"pricingPlan":[{}],"arrangementEffectiveDate":"string","productId":"string","activityId":"string","extensions":{},"productBundle":[{}]}},"responses":{"200":"updateBundleGoliveDateResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"PUT","path":"/holdings/cashManagement/bundles/{bundleId}/prelimStructure","fullPath":"/api/v2.0.0/holdings/cashManagement/bundles/{bundleId}/prelimStructure","operationId":"updateVirtualAccountDraftStructure","name":"Updates the bundle arrangement status from draft to pending live with all the accounts created.","summary":"Moves draft structure to preliminary structure","tags":["CORPORATE"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"bundleId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"arrangementCustomerIds":[{}],"pricingPlan":[{}],"arrangementEffectiveDate":"string","productId":"string","activityId":"string","extensions":{},"productBundle":[{}],"bundlehierarchy":[{}]}},"responses":{"200":"updateVirtualAccountDraftStructureResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"PUT","path":"/holdings/cashManagement/transactionAccounts/{transactionAccountId}/preliminaryStructures","fullPath":"/api/v2.0.0/holdings/cashManagement/transactionAccounts/{transactionAccountId}/preliminaryStructures","operationId":"updatePreliminaryVirtualAccounts","name":"Updates new accounts to the preliminary or modify the existing accounts from the preliminary structure.","summary":"Updates new or modify existing accounts","tags":["CORPORATE"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"transactionAccountId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"arrangementCustomerIds":[{}],"pricingPlan":[{}],"arrangementEffectiveDate":"string","productId":"string","activityId":"string","extensions":{},"bundlehierarchy":[{}]}},"responses":{"200":"updatePreliminaryVirtualAccountsResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"PUT","path":"/holdings/cashManagement/summaryAccounts/{summaryAccountId}/penaltyInterestConditions","fullPath":"/api/v2.0.0/holdings/cashManagement/summaryAccounts/{summaryAccountId}/penaltyInterestConditions","operationId":"updateSummaryAccountPenaltyInterestCondition","name":"Updates the penalty interest conditions on summary accounts","summary":"Updates the penalty interest conditions on summary accounts","tags":["CORPORATE"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"summaryAccountId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"arrangementCustomerIds":[{}],"pricingPlan":[{}],"arrangementEffectiveDate":"string","productId":"string","activityId":"string","extensions":{},"penalint":[{}]}},"responses":{"200":"updateSummaryAccountPenaltyInterestConditionResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"PUT","path":"/holdings/cashManagement/transactionAccounts/{transactionAccountId}/settlementInstructions","fullPath":"/api/v2.0.0/holdings/cashManagement/transactionAccounts/{transactionAccountId}/settlementInstructions","operationId":"updateVirtualAccountSettlementInstructions","name":"Updates settlement instructions on trading account","summary":"Updates settlement instructions on trading account","tags":["CORPORATE"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"transactionAccountId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"arrangementCustomerIds":[{}],"pricingPlan":[{}],"arrangementEffectiveDate":"string","productId":"string","activityId":"string","extensions":{},"settlement":[{}]}},"responses":{"200":"updateVirtualAccountSettlementInstructionsResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"PUT","path":"/holdings/cashManagement/summaryAccounts/{summaryAccountId}/settlementInstructions","fullPath":"/api/v2.0.0/holdings/cashManagement/summaryAccounts/{summaryAccountId}/settlementInstructions","operationId":"updateSummaryAccountSettlementInstructions","name":"Updates settlement instructions on summary accounts","summary":"Updates settlement instructions on summary accounts","tags":["CORPORATE"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"summaryAccountId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"arrangementCustomerIds":[{}],"pricingPlan":[{}],"arrangementEffectiveDate":"string","productId":"string","activityId":"string","extensions":{},"settlement":[{}]}},"responses":{"200":"updateSummaryAccountSettlementInstructionsResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"PUT","path":"/holdings/cashManagement/transactionAccounts/{transactionAccountId}/secondaryLimits","fullPath":"/api/v2.0.0/holdings/cashManagement/transactionAccounts/{transactionAccountId}/secondaryLimits","operationId":"updateVirtualAccountSecondaryLimits","name":"Updates the secondary limit for virtual accounts. This helps in monitoring the availability and utilisation of limits.","summary":"Updates secondary limit on virtual accounts","tags":["CORPORATE"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"transactionAccountId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"arrangementCustomerIds":[{}],"pricingPlan":[{}],"arrangementEffectiveDate":"string","productId":"string","activityId":"string","extensions":{},"limit":[{}]}},"responses":{"200":"updateVirtualAccountSecondaryLimitsResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"PUT","path":"/holdings/cashManagement/summaryAccounts/{summaryAccountId}/secondaryLimits","fullPath":"/api/v2.0.0/holdings/cashManagement/summaryAccounts/{summaryAccountId}/secondaryLimits","operationId":"updateSummaryAccountSecondaryLimits","name":"Updates the secondary limit for summary accounts. This helps in monitoring the availability and utilisation of limits.","summary":"Updates secondary limit for summary accounts","tags":["CORPORATE"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"summaryAccountId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"arrangementCustomerIds":[{}],"pricingPlan":[{}],"arrangementEffectiveDate":"string","productId":"string","activityId":"string","extensions":{},"limit":[{}]}},"responses":{"200":"updateSummaryAccountSecondaryLimitsResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"PUT","path":"/holdings/cashManagement/summaryAccounts/{summaryAccountId}/schedules","fullPath":"/api/v2.0.0/holdings/cashManagement/summaryAccounts/{summaryAccountId}/schedules","operationId":"updateSummaryAccountPaymentSchedule","name":"Updates payment schedule on summary account","summary":"Updates payment schedule on summary accounts","tags":["CORPORATE"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"summaryAccountId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"arrangementCustomerIds":[{}],"pricingPlan":[{}],"arrangementEffectiveDate":"string","productId":"string","activityId":"string","extensions":{},"inhSchedule":[{}]}},"responses":{"200":"updateSummaryAccountPaymentScheduleResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"PUT","path":"/holdings/cashManagement/transactionAccounts/{transactionAccountId}/postingRestrictions/revocations","fullPath":"/api/v2.0.0/holdings/cashManagement/transactionAccounts/{transactionAccountId}/postingRestrictions/revocations","operationId":"updateVirtualAccountPostingRestrictionRevocation","name":"Unblocks a particular virtual account and transactions can be initiated post the defined blocked end date.","summary":"Unblocks the virtual account.","tags":["CORPORATE"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"transactionAccountId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"arrangementCustomerIds":[{}],"pricingPlan":[{}],"arrangementEffectiveDate":"string","productId":"string","activityId":"string","extensions":{},"balance":[{}]}},"responses":{"200":"updateVirtualAccountPostingRestrictionRevocationResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"PUT","path":"/holdings/cashManagement/summaryAccounts/{summaryAccountId}/postingRestrictions/revocations","fullPath":"/api/v2.0.0/holdings/cashManagement/summaryAccounts/{summaryAccountId}/postingRestrictions/revocations","operationId":"updateSummaryAccountPostingRestrictionRevocation","name":"Unblocks a particular summary account and transactions can be initiated post the defined blocked end date.","summary":"Unblocks the summary account.","tags":["CORPORATE"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"summaryAccountId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"arrangementCustomerIds":[{}],"pricingPlan":[{}],"arrangementEffectiveDate":"string","productId":"string","activityId":"string","extensions":{},"summary":[{}]}},"responses":{"200":"updateSummaryAccountPostingRestrictionRevocationResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"PUT","path":"/holdings/cashManagement/bundles/{bundleId}/schedules","fullPath":"/api/v2.0.0/holdings/cashManagement/bundles/{bundleId}/schedules","operationId":"updateBundlePaymentSchedule","name":"Updates payment schedule on a bundle in live structure.","summary":"Updates payment schedule on a bundle","tags":["CORPORATE"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"bundleId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"arrangementCustomerIds":[{}],"pricingPlan":[{}],"arrangementEffectiveDate":"string","productId":"string","activityId":"string","extensions":{},"schedule":[{}]}},"responses":{"200":"updateBundlePaymentScheduleResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"PUT","path":"/holdings/cashManagement/bundles/{bundleId}/masterAccounts/forexPricings","fullPath":"/api/v2.0.0/holdings/cashManagement/bundles/{bundleId}/masterAccounts/forexPricings","operationId":"updateForexToMasterAccount","name":"Updates forex pricing to master account","summary":"Updates forex pricing to master account","tags":["CORPORATE"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"bundleId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"arrangementCustomerIds":[{}],"pricingPlan":[{}],"arrangementEffectiveDate":"string","productId":"string","activityId":"string","extensions":{}}},"responses":{"200":"updateForexToMasterAccountResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"GET","path":"/holdings/cashManagement/accounts/{accountId}/summary","fullPath":"/api/v2.0.0/holdings/cashManagement/accounts/{accountId}/summary","operationId":"getSummaryAccountDetails","name":"Retrieve the arrangement details of a bundle, summary accounts, currency summary accounts and virtual accounts.","summary":"Retrieve the arrangement details of a bundle, summary accounts, currency summary accounts and virtual accounts.","tags":["CORPORATE"],"parameters":[{"name":"accountId","in":"path","type":"string","required":true,"description":"Identifier of the account. Often referred to as the account number, yet for consistency this is always referred to as accountId. Accepts both IBAN & BBAN"},{"name":"arrangementId","in":"query","type":"string","required":false,"description":"Indicates an unique identifier of an account"},{"name":"customer","in":"query","type":"string","required":false,"description":"Contains the customer identifier to fetch list of consent arrangements for the customer or customer identifier of the debtor account. This will be populated once the SCA(Strong Customer Authentication"},{"name":"customerRole","in":"query","type":"string","required":false,"description":"Indicates role of a customer for an arrangement."},{"name":"currency","in":"query","type":"string","required":false,"description":"Identifies the currency. E.g. USD, GBP etc"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"SummaryAccountDetailsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/cashManagement/transactionAccounts/{transactionAccountId}/interestDetailsCurrent","fullPath":"/api/v2.0.0/holdings/cashManagement/transactionAccounts/{transactionAccountId}/interestDetailsCurrent","operationId":"getCurrentPeriodAccruedInterestDetails","name":"Retrieve the accrued interest details of virtual accounts for the current period.","summary":"Retrieve the accrued interest details of virtual accounts for the current period.","tags":["CORPORATE"],"parameters":[{"name":"transactionAccountId","in":"path","type":"string","required":true,"description":"Indicates the secondary limit for virtual accounts. This helps in monitoring the availability and utilisation of limits."},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"CurrentPeriodAccruedInterestDetailsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/cashManagement/transactionAccounts/{transactionAccountId}/interestDetailsPrevious","fullPath":"/api/v2.0.0/holdings/cashManagement/transactionAccounts/{transactionAccountId}/interestDetailsPrevious","operationId":"getPreviousPeriodInterestDetails","name":"Retrieve the interest details of virtual accounts for the previous period.","summary":"Retrieve the interest details of virtual accounts for the previous period.","tags":["CORPORATE"],"parameters":[{"name":"transactionAccountId","in":"path","type":"string","required":true,"description":"Indicates the secondary limit for virtual accounts. This helps in monitoring the availability and utilisation of limits."},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"PreviousPeriodInterestDetailsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/cashManagement/transactionAccounts/{transactionAccountId}/interestDetailsYearToDate","fullPath":"/api/v2.0.0/holdings/cashManagement/transactionAccounts/{transactionAccountId}/interestDetailsYearToDate","operationId":"getTotalInterestDetails","name":"Retrieve the total interest details of virtual accounts.","summary":"Retrieve the total interest details of virtual accounts.","tags":["CORPORATE"],"parameters":[{"name":"transactionAccountId","in":"path","type":"string","required":true,"description":"Indicates the secondary limit for virtual accounts. This helps in monitoring the availability and utilisation of limits."},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"TotalInterestDetailsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/cashManagement/bundles/{bundleId}/forexPricings","fullPath":"/api/v2.0.0/holdings/cashManagement/bundles/{bundleId}/forexPricings","operationId":"getBundleForexDetails","name":"Retrieve the internal forex details of a bundle","summary":"Retrieve the internal forex details of a bundle","tags":["CORPORATE"],"parameters":[{"name":"bundleId","in":"path","type":"string","required":true,"description":"Indicates an arrangement reference which acts as a master for the sub arrangements being created"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"BundleForexDetailsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"PUT","path":"/holdings/cashManagement/sweepGroups/{sweepGroupId}/amendments","fullPath":"/api/v2.0.0/holdings/cashManagement/sweepGroups/{sweepGroupId}/amendments","operationId":"updateVirtualAccountSweepGroup","name":"Amends the basic details of a group for a sweep. A group is a collection of accounts that are linked for cash pooling purposes.","summary":"Amend cash pool grouping","tags":["CORPORATE"],"parameters":[{"name":"sweepGroupId","in":"path","type":"string","required":true,"description":"Identifier of the sweep group"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"description":"string","intraDay":"string","subGroup":"string","mainGroupId":"Main Group ID","mainMaster":"string","currency":"string","sequencing":"string","balanceTypeBalance":"string","floatTransfer":"Select Yes for Float Transfer","rulePriority":"string","exchangeRateType":"string","exchangeRateSpread":"string","sweepChargeCode":"string","suspensionStartDate":"string","suspensionEndDate":"string"}},"responses":{"200":"VirtualAccountSweepGroupResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/holdings/cashManagement/sweepGroups/sweeps","fullPath":"/api/v2.0.0/holdings/cashManagement/sweepGroups/sweeps","operationId":"getCashpoolGroupDetails","name":"Retrieves the cashpool group details of the virtual accounts.","summary":"Retrieves the cashpool group details of the virtual accounts.","tags":["CORPORATE"],"parameters":[{"name":"groupName","in":"query","type":"string","required":false,"description":"The name that is displayed for the group"},{"name":"mainMaster","in":"query","type":"string","required":false,"description":"Specifies the master account to which the sweep rules are defined."},{"name":"currency","in":"query","type":"string","required":false,"description":"Identifies the currency. E.g. USD, GBP etc"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"CashpoolGroupDetailsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"PUT","path":"/holdings/cashManagement/bundles/{bundleId}/restructures","fullPath":"/api/v2.0.0/holdings/cashManagement/bundles/{bundleId}/restructures","operationId":"updateVirtualAccountPool","name":"Structural changes of virtual accounts in live status - for example, removing one virtual account from a sweep group to another sweep group triggered by the bank user","summary":"Updates pool change in virtual accounts","tags":["CORPORATE"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"bundleId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"arrangementCustomerIds":[{}],"pricingPlan":[{}],"arrangementEffectiveDate":"string","productId":"string","activityId":"string","extensions":{},"bundlehierarchy":[{}]}},"responses":{"200":"updateVirtualAccountPoolResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}}]},{"key":"holdings-cashManagement-service-v3.0.0","title":"Cash Management Holdings","version":"v3.0.0","description":"Cash Management API","endpointCount":25,"endpoints":[{"method":"POST","path":"/holdings/cashManagement/transactionAccounts/forexPricings","fullPath":"/api/v3.0.0/holdings/cashManagement/transactionAccounts/forexPricings","operationId":"createTransactionAccountForexPricing","name":"Internal foreign exchange allows the corporate customer to perform cross-currency movements without affecting the bank currency positions.","summary":"Creation of  forex pricing for transaction account.","tags":["CORPORATE"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"arrangementCustomerIds":[{}],"pricingPlan":[{}],"arrangementEffectiveDate":"string","productId":"string","activityId":"string","extensions":{}}},"responses":{"200":"createTransactionAccountForexPricingResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"PUT","path":"/holdings/cashManagement/bundles/{bundleId}/closures","fullPath":"/api/v3.0.0/holdings/cashManagement/bundles/{bundleId}/closures","operationId":"deleteBundle","name":"Closes the bundle or cashpool.","summary":"Closure of bundle","tags":["CORPORATE"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"bundleId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"arrangementCustomerIds":[{}],"pricingPlan":[{}],"arrangementEffectiveDate":"string","productId":"string","activityId":"string","extensions":{},"propertyControl":[{}]}},"responses":{"200":"deleteBundleResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"PUT","path":"/holdings/cashManagement/bundles/{bundleId}/goLiveDates","fullPath":"/api/v3.0.0/holdings/cashManagement/bundles/{bundleId}/goLiveDates","operationId":"updateBundleGoliveDate","name":"Updates golive date for the master arrangement. This is the date from which the master arrangement will become effective.","summary":"Updates golive date for the master arrangement.","tags":["CORPORATE"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"bundleId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"arrangementCustomerIds":[{}],"pricingPlan":[{}],"arrangementEffectiveDate":"string","productId":"string","activityId":"string","extensions":{},"productBundle":[{}]}},"responses":{"200":"updateBundleGoliveDateResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"PUT","path":"/holdings/cashManagement/bundles/{bundleId}/prelimStructure","fullPath":"/api/v3.0.0/holdings/cashManagement/bundles/{bundleId}/prelimStructure","operationId":"updateVirtualAccountDraftStructure","name":"Updates the bundle arrangement status from draft to pending live with all the accounts created.","summary":"Moves draft structure to preliminary structure","tags":["CORPORATE"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"bundleId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"arrangementCustomerIds":[{}],"pricingPlan":[{}],"arrangementEffectiveDate":"string","productId":"string","activityId":"string","extensions":{},"productBundle":[{}],"bundlehierarchy":[{}]}},"responses":{"200":"updateVirtualAccountDraftStructureResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"PUT","path":"/holdings/cashManagement/transactionAccounts/{transactionAccountId}/preliminaryStructures","fullPath":"/api/v3.0.0/holdings/cashManagement/transactionAccounts/{transactionAccountId}/preliminaryStructures","operationId":"updatePreliminaryVirtualAccounts","name":"Updates new accounts to the preliminary or modify the existing accounts from the preliminary structure.","summary":"Updates new or modify existing accounts","tags":["CORPORATE"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"transactionAccountId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"arrangementCustomerIds":[{}],"pricingPlan":[{}],"arrangementEffectiveDate":"string","productId":"string","activityId":"string","extensions":{},"bundlehierarchy":[{}]}},"responses":{"200":"updatePreliminaryVirtualAccountsResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"PUT","path":"/holdings/cashManagement/summaryAccounts/{summaryAccountId}/penaltyInterestConditions","fullPath":"/api/v3.0.0/holdings/cashManagement/summaryAccounts/{summaryAccountId}/penaltyInterestConditions","operationId":"updateSummaryAccountPenaltyInterestCondition","name":"Updates the penalty interest conditions on summary accounts","summary":"Updates the penalty interest conditions on summary accounts","tags":["CORPORATE"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"summaryAccountId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"arrangementCustomerIds":[{}],"pricingPlan":[{}],"arrangementEffectiveDate":"string","productId":"string","activityId":"string","extensions":{},"crinterest":[{}],"drinterest":[{}],"penalint":[{}],"bundleinterest":[{}],"infcrinterest":[{}],"infdrinterest":[{}],"inhcrinterest":[{}],"inhdrinterest":[{}],"inhpenalint":[{}]}},"responses":{"200":"updateSummaryAccountPenaltyInterestConditionResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"PUT","path":"/holdings/cashManagement/transactionAccounts/{transactionAccountId}/settlementInstructions","fullPath":"/api/v3.0.0/holdings/cashManagement/transactionAccounts/{transactionAccountId}/settlementInstructions","operationId":"updateVirtualAccountSettlementInstructions","name":"Updates settlement instructions on trading account","summary":"Updates settlement instructions on trading account","tags":["CORPORATE"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"transactionAccountId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"arrangementCustomerIds":[{}],"pricingPlan":[{}],"arrangementEffectiveDate":"string","productId":"string","activityId":"string","extensions":{},"settlement":[{}]}},"responses":{"200":"updateVirtualAccountSettlementInstructionsResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"PUT","path":"/holdings/cashManagement/summaryAccounts/{summaryAccountId}/settlementInstructions","fullPath":"/api/v3.0.0/holdings/cashManagement/summaryAccounts/{summaryAccountId}/settlementInstructions","operationId":"updateSummaryAccountSettlementInstructions","name":"Updates settlement instructions on summary accounts","summary":"Updates settlement instructions on summary accounts","tags":["CORPORATE"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"summaryAccountId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"arrangementCustomerIds":[{}],"pricingPlan":[{}],"arrangementEffectiveDate":"string","productId":"string","activityId":"string","extensions":{},"settlement":[{}]}},"responses":{"200":"updateSummaryAccountSettlementInstructionsResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"PUT","path":"/holdings/cashManagement/transactionAccounts/{transactionAccountId}/secondaryLimits","fullPath":"/api/v3.0.0/holdings/cashManagement/transactionAccounts/{transactionAccountId}/secondaryLimits","operationId":"updateVirtualAccountSecondaryLimits","name":"Updates the secondary limit for virtual accounts. This helps in monitoring the availability and utilisation of limits.","summary":"Updates secondary limit on virtual accounts","tags":["CORPORATE"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"transactionAccountId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"arrangementCustomerIds":[{}],"pricingPlan":[{}],"arrangementEffectiveDate":"string","productId":"string","activityId":"string","extensions":{},"limit":[{}]}},"responses":{"200":"updateVirtualAccountSecondaryLimitsResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"PUT","path":"/holdings/cashManagement/summaryAccounts/{summaryAccountId}/secondaryLimits","fullPath":"/api/v3.0.0/holdings/cashManagement/summaryAccounts/{summaryAccountId}/secondaryLimits","operationId":"updateSummaryAccountSecondaryLimits","name":"Updates the secondary limit for summary accounts. This helps in monitoring the availability and utilisation of limits.","summary":"Updates secondary limit for summary accounts","tags":["CORPORATE"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"summaryAccountId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"arrangementCustomerIds":[{}],"pricingPlan":[{}],"arrangementEffectiveDate":"string","productId":"string","activityId":"string","extensions":{},"limit":[{}]}},"responses":{"200":"updateSummaryAccountSecondaryLimitsResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"PUT","path":"/holdings/cashManagement/summaryAccounts/{summaryAccountId}/schedules","fullPath":"/api/v3.0.0/holdings/cashManagement/summaryAccounts/{summaryAccountId}/schedules","operationId":"updateSummaryAccountPaymentSchedule","name":"Updates payment schedule on summary account","summary":"Updates payment schedule on summary accounts","tags":["CORPORATE"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"summaryAccountId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"arrangementCustomerIds":[{}],"pricingPlan":[{}],"arrangementEffectiveDate":"string","productId":"string","activityId":"string","extensions":{},"schedule":[{}],"inhSchedule":[{}]}},"responses":{"200":"updateSummaryAccountPaymentScheduleResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"PUT","path":"/holdings/cashManagement/transactionAccounts/{transactionAccountId}/postingRestrictions/revocations","fullPath":"/api/v3.0.0/holdings/cashManagement/transactionAccounts/{transactionAccountId}/postingRestrictions/revocations","operationId":"updateVirtualAccountPostingRestrictionRevocation","name":"Unblocks a particular virtual account and transactions can be initiated post the defined blocked end date.","summary":"Unblocks the virtual account.","tags":["CORPORATE"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"transactionAccountId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"arrangementCustomerIds":[{}],"pricingPlan":[{}],"arrangementEffectiveDate":"string","productId":"string","activityId":"string","extensions":{},"balance":[{}]}},"responses":{"200":"updateVirtualAccountPostingRestrictionRevocationResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"PUT","path":"/holdings/cashManagement/summaryAccounts/{summaryAccountId}/postingRestrictions/revocations","fullPath":"/api/v3.0.0/holdings/cashManagement/summaryAccounts/{summaryAccountId}/postingRestrictions/revocations","operationId":"updateSummaryAccountPostingRestrictionRevocation","name":"Unblocks a particular summary account and transactions can be initiated post the defined blocked end date.","summary":"Unblocks the summary account.","tags":["CORPORATE"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"summaryAccountId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"arrangementCustomerIds":[{}],"pricingPlan":[{}],"arrangementEffectiveDate":"string","productId":"string","activityId":"string","extensions":{},"summary":[{}]}},"responses":{"200":"updateSummaryAccountPostingRestrictionRevocationResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"PUT","path":"/holdings/cashManagement/bundles/{bundleId}/schedules","fullPath":"/api/v3.0.0/holdings/cashManagement/bundles/{bundleId}/schedules","operationId":"updateBundlePaymentSchedule","name":"Updates payment schedule on a bundle in live structure.","summary":"Updates payment schedule on a bundle","tags":["CORPORATE"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"bundleId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"arrangementCustomerIds":[{}],"pricingPlan":[{}],"arrangementEffectiveDate":"string","productId":"string","activityId":"string","extensions":{},"schedule":[{}],"inhSchedule":[{}]}},"responses":{"200":"updateBundlePaymentScheduleResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"PUT","path":"/holdings/cashManagement/bundles/{bundleId}/masterAccounts/forexPricings","fullPath":"/api/v3.0.0/holdings/cashManagement/bundles/{bundleId}/masterAccounts/forexPricings","operationId":"updateForexToMasterAccount","name":"Updates forex pricing to master account","summary":"Updates forex pricing to master account","tags":["CORPORATE"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"bundleId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"arrangementCustomerIds":[{}],"pricingPlan":[{}],"arrangementEffectiveDate":"string","productId":"string","activityId":"string","extensions":{}}},"responses":{"200":"updateForexToMasterAccountResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"GET","path":"/holdings/cashManagement/accounts/{accountId}/summary","fullPath":"/api/v3.0.0/holdings/cashManagement/accounts/{accountId}/summary","operationId":"getSummaryAccountDetails","name":"Retrieve the arrangement details of a bundle, summary accounts, currency summary accounts and virtual accounts.","summary":"Retrieve the arrangement details of a bundle, summary accounts, currency summary accounts and virtual accounts.","tags":["CORPORATE"],"parameters":[{"name":"accountId","in":"path","type":"string","required":true,"description":"Identifier of the account. Often referred to as the account number, yet for consistency this is always referred to as accountId. Accepts both IBAN & BBAN"},{"name":"arrangementId","in":"query","type":"string","required":false,"description":"Indicates an unique identifier of an account"},{"name":"customer","in":"query","type":"string","required":false,"description":"Contains the customer identifier to fetch list of consent arrangements for the customer or customer identifier of the debtor account. This will be populated once the SCA(Strong Customer Authentication"},{"name":"customerRole","in":"query","type":"string","required":false,"description":"Indicates role of a customer for an arrangement."},{"name":"currency","in":"query","type":"string","required":false,"description":"Identifies the currency. E.g. USD, GBP etc"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"SummaryAccountDetailsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/cashManagement/transactionAccounts/{transactionAccountId}/interestDetailsCurrent","fullPath":"/api/v3.0.0/holdings/cashManagement/transactionAccounts/{transactionAccountId}/interestDetailsCurrent","operationId":"getCurrentPeriodAccruedInterestDetails","name":"Retrieve the accrued interest details of virtual accounts for the current period.","summary":"Retrieve the accrued interest details of virtual accounts for the current period.","tags":["CORPORATE"],"parameters":[{"name":"transactionAccountId","in":"path","type":"string","required":true,"description":"Indicates the secondary limit for virtual accounts. This helps in monitoring the availability and utilisation of limits."},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"CurrentPeriodAccruedInterestDetailsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/cashManagement/transactionAccounts/{transactionAccountId}/interestDetailsPrevious","fullPath":"/api/v3.0.0/holdings/cashManagement/transactionAccounts/{transactionAccountId}/interestDetailsPrevious","operationId":"getPreviousPeriodInterestDetails","name":"Retrieve the interest details of virtual accounts for the previous period.","summary":"Retrieve the interest details of virtual accounts for the previous period.","tags":["CORPORATE"],"parameters":[{"name":"transactionAccountId","in":"path","type":"string","required":true,"description":"Indicates the secondary limit for virtual accounts. This helps in monitoring the availability and utilisation of limits."},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"PreviousPeriodInterestDetailsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/cashManagement/transactionAccounts/{transactionAccountId}/interestDetailsYearToDate","fullPath":"/api/v3.0.0/holdings/cashManagement/transactionAccounts/{transactionAccountId}/interestDetailsYearToDate","operationId":"getTotalInterestDetails","name":"Retrieve the total interest details of virtual accounts.","summary":"Retrieve the total interest details of virtual accounts.","tags":["CORPORATE"],"parameters":[{"name":"transactionAccountId","in":"path","type":"string","required":true,"description":"Indicates the secondary limit for virtual accounts. This helps in monitoring the availability and utilisation of limits."},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"TotalInterestDetailsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/cashManagement/bundles/{bundleId}/forexPricings","fullPath":"/api/v3.0.0/holdings/cashManagement/bundles/{bundleId}/forexPricings","operationId":"getBundleForexDetails","name":"Retrieve the internal forex details of a bundle","summary":"Retrieve the internal forex details of a bundle","tags":["CORPORATE"],"parameters":[{"name":"bundleId","in":"path","type":"string","required":true,"description":"Indicates an arrangement reference which acts as a master for the sub arrangements being created"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"BundleForexDetailsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/cashManagement/sweepGroups/sweeps","fullPath":"/api/v3.0.0/holdings/cashManagement/sweepGroups/sweeps","operationId":"getCashpoolGroupDetails","name":"Retrieves the cashpool group details of the virtual accounts.","summary":"Retrieves the cashpool group details of the virtual accounts.","tags":["CORPORATE"],"parameters":[{"name":"groupName","in":"query","type":"string","required":false,"description":"The name that is displayed for the group"},{"name":"mainMaster","in":"query","type":"string","required":false,"description":"Specifies the master account to which the sweep rules are defined."},{"name":"currency","in":"query","type":"string","required":false,"description":"Identifies the currency. E.g. USD, GBP etc"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"CashpoolGroupDetailsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"PUT","path":"/holdings/cashManagement/bundles/{bundleId}/restructures","fullPath":"/api/v3.0.0/holdings/cashManagement/bundles/{bundleId}/restructures","operationId":"updateVirtualAccountPool","name":"Structural changes of virtual accounts in live status - for example, removing one virtual account from a sweep group to another sweep group triggered by the bank user","summary":"Updates pool change in virtual accounts","tags":["CORPORATE"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"bundleId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"arrangementCustomerIds":[{}],"pricingPlan":[{}],"arrangementEffectiveDate":"string","productId":"string","activityId":"string","extensions":{},"bundlehierarchy":[{}]}},"responses":{"200":"updateVirtualAccountPoolResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"POST","path":"/holdings/cashManagement/sweepGroups/{sweepGroupId}","fullPath":"/api/v3.0.0/holdings/cashManagement/sweepGroups/{sweepGroupId}","operationId":"createVirtualAccountsSweepGroup","name":"Creates the basic details of a group for a sweep. A group is a collection of accounts that are linked for cash pooling purposes","summary":"Creates the basic details of a group for a sweep","tags":["CORPORATE"],"parameters":[{"name":"sweepGroupId","in":"path","type":"string","required":true,"description":"Identifier of the sweep group"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"description":"string","intraDay":"string","subGroup":"Indicates Group Defined as Sub group in Main Group","mainGroupId":"Main Group ID","mainMaster":"string","currency":"string","sequencing":"string","balanceTypeBalance":"string","sweepReserveCondition":"string","floatTransfer":"Select Yes for Float Transfer","rulePriority":"string","exchangeRateType":"string","exchangeRateSpread":"string","sweepChargeCode":"string","suspensionStartDate":"string"}},"responses":{"200":"VirtualAccountsSweepGroupResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/holdings/cashManagement/sweepGroups/{sweepGroupId}/amendments","fullPath":"/api/v3.0.0/holdings/cashManagement/sweepGroups/{sweepGroupId}/amendments","operationId":"updateVirtualAccountsSweepGroup","name":"Amends the basic details of a group for a sweep. A group is a collection of accounts that are linked for cash pooling purposes.","summary":"Amend cash pool grouping","tags":["CORPORATE"],"parameters":[{"name":"sweepGroupId","in":"path","type":"string","required":true,"description":"Identifier of the sweep group"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"description":"string","intraDay":"string","subGroup":"Indicates Group Defined as Sub group in Main Group","mainGroupId":"Main Group ID","mainMaster":"string","currency":"string","sequencing":"string","balanceTypeBalance":"string","sweepReserveCondition":"string","floatTransfer":"Select Yes for Float Transfer","rulePriority":"string","exchangeRateType":"string","exchangeRateSpread":"string","sweepChargeCode":"string","suspensionStartDate":"string"}},"responses":{"200":"VirtualAccountsSweepGroupResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"POST","path":"/holdings/sweeps/sweepConditions/{sweepConditionsId}","fullPath":"/api/v3.0.0/holdings/sweeps/sweepConditions/{sweepConditionsId}","operationId":"createSweepConditions","name":"Creates sweep conditions for the sweep types. Sweep conditions captures the boundary conditions and limitations to be applied before executing the sweeps from Demand Deposit Accounts(DDA) to investment / LoC products or sweep from investment / LoC products to DDAs.","summary":"Creates sweep conditions for the sweep types","tags":["CORPORATE"],"parameters":[{"name":"sweepConditionsId","in":"path","type":"string","required":true,"description":""},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"sweepTypes":[{}],"description":"string","shortDescription":"string","amountInUnits":"string","extensions":{}}},"responses":{"200":"SweepConditionsResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}}]},{"key":"holdings-cashmanagement-bundles-v1.0.0","title":"Cash Management Bundle Arrangements","version":"v1.0.0","description":"API to retrieve the cash management bundle arrangements and associated details such as bundle balances, bundle hierarchy, status events, etc","endpointCount":12,"endpoints":[{"method":"GET","path":"/holdings/accounts/{arrangementId}/bundleDetails","fullPath":"/api/v1.0.0/holdings/accounts/{arrangementId}/bundleDetails","operationId":"getLinktArrDetails","name":"Retrieves the Link Arrangement Details of an account-This API is deprecated and going forward the following URL has to be used.URL:/holdings/arrangements/{arrangementId}/bundles","summary":"Retrieves the Link Arrangement Details of an account","tags":[],"parameters":[{"name":"arrangementId","in":"path","type":"string","required":true,"description":"Indicates an unique identifier of an account"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"LinktArrDetailsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/cashManagement/bundles/{bundleId}/exceptions","fullPath":"/api/v1.0.0/holdings/cashManagement/bundles/{bundleId}/exceptions","operationId":"getCashPoolExceptionLog","name":"List of account Exceptional in Bundle Hierarchy","summary":"List of account Exceptional in Bundle Hierarchy","tags":[],"parameters":[{"name":"bundleId","in":"path","type":"string","required":true,"description":"Indicates an arrangement reference which acts as a master for the sub arrangements being created"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"CashPoolExceptionLogResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/cashManagement/bundles/{bundleId}/accounts","fullPath":"/api/v1.0.0/holdings/cashManagement/bundles/{bundleId}/accounts","operationId":"getBundleAccounts","name":"Retrieves the account details of a Bundle arrangement","summary":"Retrieves the account details of a Bundle arrangement","tags":[],"parameters":[{"name":"bundleId","in":"path","type":"string","required":true,"description":"Indicates an arrangement reference which acts as a master for the sub arrangements being created"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"BundleAccountsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/cashManagement/bundles/{bundleId}/status","fullPath":"/api/v1.0.0/holdings/cashManagement/bundles/{bundleId}/status","operationId":"getBundleHistoryDetails","name":"Retrieves the History of Bundle hierarchy","summary":"Retrieves the History of Bundle hierarchy","tags":[],"parameters":[{"name":"bundleId","in":"path","type":"string","required":true,"description":"Indicates an arrangement reference which acts as a master for the sub arrangements being created"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"BundleHistoryDetailsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/cashManagement/customers/{customerId}/bundles","fullPath":"/api/v1.0.0/holdings/cashManagement/customers/{customerId}/bundles","operationId":"getBundleArrangements","name":"To list the bundle arrangement details and status, events, Go-live dates, etc","summary":"To list the bundle arrangement details and status, events, Go-live dates, etc","tags":[],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"Identifier of the customer"},{"name":"arrangementId","in":"query","type":"string","required":false,"description":"Indicates an unique identifier of an account"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"BundleArrangementsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/cashManagement/bundles/{bundleId}/balances","fullPath":"/api/v1.0.0/holdings/cashManagement/bundles/{bundleId}/balances","operationId":"getBundleBalances","name":"Retrieves the balances of Master/Bundle Arrangement","summary":"Retrieves the balances of Master/Bundle Arrangement","tags":[],"parameters":[{"name":"bundleId","in":"path","type":"string","required":true,"description":"Indicates an arrangement reference which acts as a master for the sub arrangements being created"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"BundleBalancesResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/cashManagement/customers/{customerId}/accounts","fullPath":"/api/v1.0.0/holdings/cashManagement/customers/{customerId}/accounts","operationId":"getCustomerBundleAccounts","name":"Retrieves the List of Bundle arrangements of a customer","summary":"Retrieves the List of Bundle arrangements of a customer","tags":[],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"Identifier of the customer"},{"name":"companyCode","in":"query","type":"string","required":false,"description":"The identifier of the underlying Entity/Company/Branch."},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"CustomerBundleAccountsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/cashManagement/{customerId}/bundles/drafts","fullPath":"/api/v1.0.0/holdings/cashManagement/{customerId}/bundles/drafts","operationId":"getDraftArrangements","name":"Retrieves the List of Draft Bundles available for a Customer","summary":"Retrieves the List of Draft Bundles available for a Customer","tags":[],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"Identifier of the customer"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"DraftArrangementsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/cashManagement/{bundleId}/bundles/draftDetails","fullPath":"/api/v1.0.0/holdings/cashManagement/{bundleId}/bundles/draftDetails","operationId":"getDraftBundleList","name":"Retrieves the details of the Draft Bundle Account-This API is deprecated and going forward the following URL has to be used.URL:/holdings/cashManagement/bundles/{bundleId}/drafts","summary":"Retrieves the details of the Draft Bundle Account","tags":[],"parameters":[{"name":"bundleId","in":"path","type":"string","required":true,"description":"Indicates an arrangement reference which acts as a master for the sub arrangements being created"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"DraftBundleListResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/cashManagement/bundles/{bundleId}/currentAccounts","fullPath":"/api/v1.0.0/holdings/cashManagement/bundles/{bundleId}/currentAccounts","operationId":"getNonBalanceNettingAccounts","name":"To list all the standalone account in relation with the Bundle arrangement customer.List of Non-BN Account list","summary":"To list all the standalone account in relation with the Bundle arrangement customer.List of Non-BN Account list","tags":[],"parameters":[{"name":"bundleId","in":"path","type":"string","required":true,"description":"Indicates an arrangement reference which acts as a master for the sub arrangements being created"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"NonBalanceNettingAccountsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/cashManagement/accounts/{accountId}/balances","fullPath":"/api/v1.0.0/holdings/cashManagement/accounts/{accountId}/balances","operationId":"getBundleAccountBalances","name":"Retrieves the balances of a TR Account","summary":"Retrieves the balances of a TR Account","tags":[],"parameters":[{"name":"accountId","in":"path","type":"string","required":true,"description":"Identifier of the account. Often referred to as the account number, yet for consistency this is always referred to as accountId. Accepts both IBAN & BBAN"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"BundleAccountBalancesResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/cashManagement/bundles/{bundleId}/currencies/{currencyId}/balances","fullPath":"/api/v1.0.0/holdings/cashManagement/bundles/{bundleId}/currencies/{currencyId}/balances","operationId":"getBalanceInPreferredCurrency","name":"Simulated Balances","summary":"Balances in preferred currency","tags":[],"parameters":[{"name":"bundleId","in":"path","type":"string","required":true,"description":"Indicates an arrangement reference which acts as a master for the sub arrangements being created"},{"name":"currencyId","in":"path","type":"string","required":true,"description":"Identifier of the currency. This is the 3-letter ISO 4217 code of the currency."},{"name":"bundleArrangement","in":"query","type":"string","required":false,"description":""},{"name":"simulatedCurrency","in":"query","type":"string","required":false,"description":""},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"BalanceInPreferredCurrencyResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}}]},{"key":"holdings-cashmanagement-bundles-v2.0.0","title":"Cash management Bundle arrangement details","version":"v2.0.0","description":"API to retrieve the cash management bundle arrangements and associated details such as bundle balances, bundle hierarchy, status events, etc","endpointCount":11,"endpoints":[{"method":"GET","path":"/holdings/cashManagement/bundles/{bundleId}/exceptions","fullPath":"/api/v2.0.0/holdings/cashManagement/bundles/{bundleId}/exceptions","operationId":"getCashPoolExceptionLog","name":"List of account Exceptional in Bundle Hierarchy","summary":"List of account Exceptional in Bundle Hierarchy","tags":[],"parameters":[{"name":"bundleId","in":"path","type":"string","required":true,"description":"Indicates an arrangement reference which acts as a master for the sub arrangements being created"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"CashPoolExceptionLogResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/cashManagement/bundles/{bundleId}/accounts","fullPath":"/api/v2.0.0/holdings/cashManagement/bundles/{bundleId}/accounts","operationId":"getBundleAccounts","name":"Retrieves the account details of a Bundle arrangement","summary":"Retrieves the account details of a Bundle arrangement","tags":[],"parameters":[{"name":"bundleId","in":"path","type":"string","required":true,"description":"Indicates an arrangement reference which acts as a master for the sub arrangements being created"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"BundleAccountsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/cashManagement/bundles/{bundleId}/status","fullPath":"/api/v2.0.0/holdings/cashManagement/bundles/{bundleId}/status","operationId":"getBundleHistoryDetails","name":"Retrieves the History of Bundle hierarchy","summary":"Retrieves the History of Bundle hierarchy","tags":[],"parameters":[{"name":"bundleId","in":"path","type":"string","required":true,"description":"Indicates an arrangement reference which acts as a master for the sub arrangements being created"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"BundleHistoryDetailsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/cashManagement/customers/{customerId}/bundles","fullPath":"/api/v2.0.0/holdings/cashManagement/customers/{customerId}/bundles","operationId":"getBundleArrangements","name":"To list the bundle arrangement details and status, events, Go-live dates, etc","summary":"To list the bundle arrangement details and status, events, Go-live dates, etc","tags":[],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"Identifier of the customer"},{"name":"arrangementId","in":"query","type":"string","required":false,"description":"Indicates an unique identifier of an account"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"BundleArrangementsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/cashManagement/bundles/{bundleId}/balances","fullPath":"/api/v2.0.0/holdings/cashManagement/bundles/{bundleId}/balances","operationId":"getBundleBalances","name":"Retrieves the balances of Master/Bundle Arrangement","summary":"Retrieves the balances of Master/Bundle Arrangement","tags":[],"parameters":[{"name":"bundleId","in":"path","type":"string","required":true,"description":"Indicates an arrangement reference which acts as a master for the sub arrangements being created"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"BundleBalancesResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/cashManagement/customers/{customerId}/accounts","fullPath":"/api/v2.0.0/holdings/cashManagement/customers/{customerId}/accounts","operationId":"getCustomerBundleAccounts","name":"Retrieves the List of Bundle arrangements of a customer","summary":"Retrieves the List of Bundle arrangements of a customer","tags":[],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"Identifier of the customer"},{"name":"companyCode","in":"query","type":"string","required":false,"description":"The identifier of the underlying Entity/Company/Branch."},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"CustomerBundleAccountsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/cashManagement/{customerId}/bundles/drafts","fullPath":"/api/v2.0.0/holdings/cashManagement/{customerId}/bundles/drafts","operationId":"getDraftArrangements","name":"Retrieves the List of Draft Bundles available for a Customer","summary":"Retrieves the List of Draft Bundles available for a Customer","tags":[],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"Identifier of the customer"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"DraftArrangementsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/cashManagement/bundles/{bundleId}/drafts","fullPath":"/api/v2.0.0/holdings/cashManagement/bundles/{bundleId}/drafts","operationId":"getDraftBundleList","name":"Retrieves the details of the Draft Bundle Account","summary":"Retrieves the details of the Draft Bundle Account","tags":[],"parameters":[{"name":"bundleId","in":"path","type":"string","required":true,"description":"Indicates an arrangement reference which acts as a master for the sub arrangements being created"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"DraftBundleListResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/cashManagement/bundles/{bundleId}/currentAccounts","fullPath":"/api/v2.0.0/holdings/cashManagement/bundles/{bundleId}/currentAccounts","operationId":"getNonBalanceNettingAccounts","name":"To list all the standalone account in relation with the Bundle arrangement customer.List of Non-BN Account list","summary":"To list all the standalone account in relation with the Bundle arrangement customer.List of Non-BN Account list","tags":[],"parameters":[{"name":"bundleId","in":"path","type":"string","required":true,"description":"Indicates an arrangement reference which acts as a master for the sub arrangements being created"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"NonBalanceNettingAccountsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/cashManagement/accounts/{accountId}/balances","fullPath":"/api/v2.0.0/holdings/cashManagement/accounts/{accountId}/balances","operationId":"getBundleAccountBalances","name":"Retrieves the balances of a TR Account","summary":"Retrieves the balances of a TR Account","tags":[],"parameters":[{"name":"accountId","in":"path","type":"string","required":true,"description":"Identifier of the account. Often referred to as the account number, yet for consistency this is always referred to as accountId. Accepts both IBAN & BBAN"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"BundleAccountBalancesResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/cashManagement/bundles/{bundleId}/currencies/{currencyId}/balances","fullPath":"/api/v2.0.0/holdings/cashManagement/bundles/{bundleId}/currencies/{currencyId}/balances","operationId":"getBalanceInPreferredCurrency","name":"Simulated Balances","summary":"Balances in preferred currency","tags":[],"parameters":[{"name":"bundleId","in":"path","type":"string","required":true,"description":"Indicates an arrangement reference which acts as a master for the sub arrangements being created"},{"name":"currencyId","in":"path","type":"string","required":true,"description":"Identifier of the currency. This is the 3-letter ISO 4217 code of the currency."},{"name":"bundleArrangement","in":"query","type":"string","required":false,"description":""},{"name":"simulatedCurrency","in":"query","type":"string","required":false,"description":""},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"BalanceInPreferredCurrencyResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}}]},{"key":"holdings-chargeAmount-v1.0.0","title":"Retrieves the Charge Amount","version":"v1.0.0","description":"Retrieves the Charge Amount for the given Charge Property","endpointCount":1,"endpoints":[{"method":"POST","path":"/holdings/deposits/redeemCharge/{arrangementId}","fullPath":"/api/v1.0.0/holdings/deposits/redeemCharge/{arrangementId}","operationId":"getRedeemChargeAmount","name":"Retrieves the Charge Amount for the given Charge Property-This API is deprecated as this is a Wealth Suite API","summary":"Retrieves the Charge Amount for the given Charge Property","tags":[],"parameters":[{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"arrangementId","in":"path","type":"string","required":true,"description":""},{"name":"chargeProperty","in":"query","type":"string","required":false,"description":""},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":""},{"name":"companyId","in":"header","type":"string","required":false,"description":""}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"closureNotes":[{}],"activityId":"string","automaticRun":"string","simulationRunReference":"string","effectiveDate":"2024-01-01","currencyId":"string","transactionAmount":0.0,"closureReason":"string","settlement":{"payinSettlement1":{},"ddMandateRef11":{},"payinAccount11":{},"payinBeneficiary11":{},"payinPercentage11":{},"payinAmount11":{},"payoutSettlement1":{},"payoutAccount11":{},"payoutBeneficiary11":{},"payoutPercentage11":{},"payoutAmount11":{},"paymentType11":{},"payinPoProduct11":{},"payinActivity11":{},"payinAcDbRule1":{}}}},"responses":{"200":"ChargeAmountResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse","default":"QueryErrorResponse"}}]},{"key":"holdings-cheques-service-v1.0.0","title":"Holdings Cheques APIs","version":"v1.0.0","description":"Get and management of Holdings Cheques","endpointCount":5,"endpoints":[{"method":"POST","path":"/holdings/chequeIssues/{chequeIssueId}","fullPath":"/api/v1.0.0/holdings/chequeIssues/{chequeIssueId}","operationId":"createChequeIssue","name":"Issue a new cheque","summary":"Initiate a new cheque book request for an account","tags":[],"parameters":[{"name":"chequeIssueId","in":"path","type":"string","required":true,"description":"Contains the identifier of the issued cheque"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":""},{"name":"companyId","in":"header","type":"string","required":false,"description":""}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"chargeDetails":[{}],"notes":[{}],"chequeStatus":"string","issueDate":"2024-01-01","numberIssued":"string","stockRegister":"string","seriesId":"string","chequeNumberStart":"string","charges":"string"}},"responses":{"200":"ChequeIssueResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/holdings/chequeIssues/{chequeIssueId}","fullPath":"/api/v1.0.0/holdings/chequeIssues/{chequeIssueId}","operationId":"updateChequeIssue","name":"Update issued cheque details","summary":"Update an existing cheque book for an account","tags":[],"parameters":[{"name":"chequeIssueId","in":"path","type":"string","required":true,"description":"Contains the identifier of the issued cheque"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":""},{"name":"companyId","in":"header","type":"string","required":false,"description":""}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"chargeDetails":[{}],"notes":[{}],"chequeStatus":"string","issueDate":"2024-01-01","numberIssued":"string","stockRegister":"string","seriesId":"string","chequeNumberStart":"string","charges":"string"}},"responses":{"200":"ChequeIssueResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"DELETE","path":"/holdings/chequeIssues/{chequeIssueId}","fullPath":"/api/v1.0.0/holdings/chequeIssues/{chequeIssueId}","operationId":"deleteChequeIssue","name":"Delete the issued cheque","summary":"Remove an existing cheque book for the selected account","tags":[],"parameters":[{"name":"chequeIssueId","in":"path","type":"string","required":true,"description":"Contains the identifier of the issued cheque"},{"name":"payload","in":"body","type":"object","required":false,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":""},{"name":"companyId","in":"header","type":"string","required":false,"description":""}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}}},"responses":{"200":"ChequeIssueResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/holdings/chequeIssues","fullPath":"/api/v1.0.0/holdings/chequeIssues","operationId":"getChequeIssues","name":"Retrieves the issued cheques list","summary":"Retrieves the Cheques Issued details for the selected account","tags":[],"parameters":[{"name":"chequeIssueId","in":"query","type":"string","required":false,"description":"Contains the identifier of the issued cheque"},{"name":"accountId","in":"query","type":"string","required":false,"description":"Identifier of the account. Often referred to as the account number, yet for consistency this is always referred to as accountId. Accepts both IBAN & BBAN"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from t24 on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":""},{"name":"companyId","in":"header","type":"string","required":false,"description":""}],"requestBodyExample":null,"responses":{"200":"ChequeIssuesResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/cheques","fullPath":"/api/v1.0.0/holdings/cheques","operationId":"getCheques","name":"Retrieves the Cheques details","summary":"Retrieves the Cheques details for the selected account","tags":[],"parameters":[{"name":"chequeId","in":"query","type":"string","required":false,"description":"Internal cheque id, formed as chequeType.accountId.chequeOrDraftNumber"},{"name":"accountId","in":"query","type":"string","required":false,"description":"Identifier of the account. Often referred to as the account number, yet for consistency this is always referred to as accountId. Accepts both IBAN & BBAN"},{"name":"chequeRange","in":"query","type":"string","required":false,"description":"Identifies the range of cheques"},{"name":"payeeName","in":"query","type":"string","required":false,"description":"Specifies the name of the payee"},{"name":"amount","in":"query","type":"string","required":false,"description":"This is the payment amount"},{"name":"amountRange","in":"query","type":"string","required":false,"description":"Specifies the amount range of the cheques"},{"name":"amountFrom","in":"query","type":"string","required":false,"description":"Specifies the Amount From which the Payment Stop instruction is effective."},{"name":"amountFromRange","in":"query","type":"string","required":false,"description":"Specifies the amount from range of the cheques"},{"name":"amountTo","in":"query","type":"string","required":false,"description":"Specifies the Amount up To which the Payment Stop instruction is effective."},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from t24 on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":""},{"name":"companyId","in":"header","type":"string","required":false,"description":""}],"requestBodyExample":null,"responses":{"200":"ChequesResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}}]},{"key":"holdings-collaterals-service-v1.0.0","title":"Management of Customer Collaterals","version":"v1.0.0","description":"API to create and manage the details of collateral submitted by a customer, its value(s) and to optionally link it directly to a customer's supporting deals and can classify them under different collateral types and sub types offered by the system","endpointCount":3,"endpoints":[{"method":"POST","path":"/holdings/customers/collaterals","fullPath":"/api/v1.0.0/holdings/customers/collaterals","operationId":"createCustomerCollaterals","name":"Creates customer collateral with details such as collateral name, type, subtype, currency, amount and collateral item","summary":"Create customer collaterals","tags":[],"parameters":[{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"The identifier of the underlying Entity/Company/Branch."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"collateralNames":[{}],"collateralCodeId":0.0,"collateralTypeId":0.0,"currency":"string","collateralItem":"string","collateralMarketValue":0.0,"collateralValue":0.0,"customerId":0.0}},"responses":{"200":"CustomerCollateralsResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/holdings/customers/collaterals/{collateralId}","fullPath":"/api/v1.0.0/holdings/customers/collaterals/{collateralId}","operationId":"updateCustomerCollaterals","name":"Updates customer collateral with details such as collateral name, type, subtype, currency, amount and collateral item","summary":"Update customer collaterals","tags":[],"parameters":[{"name":"collateralId","in":"path","type":"string","required":true,"description":"The identifier of the collateral item"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"The identifier of the underlying Entity/Company/Branch."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"collateralNames":[{}],"collateralCodeId":0.0,"collateralTypeId":0.0,"currency":"string","collateralItem":"string","collateralMarketValue":0.0,"collateralValue":0.0,"customerId":0.0}},"responses":{"200":"CustomerCollateralsResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/holdings/customers/{customerId}/collaterals","fullPath":"/api/v1.0.0/holdings/customers/{customerId}/collaterals","operationId":"getCustomerCollaterals","name":"Retrieves customer collaterals with details such as collateral name, type, subtype, currency, amount and collateral item. Optional collateral status can be set with CUR - current/active, FWD - future dated, LIQ - liquidated, EXP - expired to get the corresponding collateral details","summary":"Retrieves customer collaterals","tags":[],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"Identifier of the customer"},{"name":"collateralCodeId","in":"query","type":"string","required":false,"description":"The identifier of the collateral type"},{"name":"collateralTypeId","in":"query","type":"string","required":false,"description":"Collateral classification Id defined in the system."},{"name":"collateralStatus","in":"query","type":"string","required":false,"description":"Indicates the status of the collateral. Possible values are CUR, LIQ, FWD, EXC"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from t24 on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"The identifier of the underlying Entity/Company/Branch."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"CustomerCollateralsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}}]},{"key":"holdings-collaterals-service-v1.1.0","title":"Management of Customer Collaterals","version":"v1.1.0","description":"API to create and manage the details of collateral submitted by a customer, its value(s) and to optionally link it directly to a customer's supporting deals and can classify them under different collateral types and sub types offered by the system","endpointCount":9,"endpoints":[{"method":"POST","path":"/holdings/customers/collaterals","fullPath":"/api/v1.0.0/holdings/customers/collaterals","operationId":"createCustomerCollaterals","name":"Creates customer collateral with details such as collateral name, type, subtype, currency, amount and collateral item","summary":"Create customer collaterals","tags":[],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"","default":"","400":"","500":""}},{"method":"PUT","path":"/holdings/customers/collaterals/{collateralId}","fullPath":"/api/v1.0.0/holdings/customers/collaterals/{collateralId}","operationId":"updateCustomerCollaterals","name":"Updates customer collateral with details such as collateral name, type, subtype, currency, amount and collateral item","summary":"Update customer collaterals","tags":[],"parameters":[{"name":"collateralId","in":"path","type":"string","required":true,"description":"The identifier of the collateral item"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"","default":"","400":"","500":""}},{"method":"GET","path":"/holdings/customers/{customerId}/collaterals","fullPath":"/api/v1.0.0/holdings/customers/{customerId}/collaterals","operationId":"getCustomerCollaterals","name":"Retrieves customer collaterals with details such as collateral name, type, subtype, currency, amount and collateral item. Optional collateral status can be set with CUR - current/active, FWD - future dated, LIQ - liquidated, EXP - expired to get the corresponding collateral details","summary":"Retrieves customer collaterals","tags":[],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"Identifier of the customer"},{"name":"collateralCodeId","in":"query","type":"string","required":false,"description":"Identifier of the collateral type"},{"name":"collateralTypeId","in":"query","type":"string","required":false,"description":"Collateral classification Id defined in the system."},{"name":"collateralStatus","in":"query","type":"string","required":false,"description":"Indicates the status of the collateral allocation or collateral. It can be one of the following values: CUR - Current, FWD - Forward , LIQ - Liquidated or MAT - Matured."},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"","default":"","400":"","500":""}},{"method":"GET","path":"/holdings/customers/collaterals/collateralAllocations","fullPath":"/api/v1.0.0/holdings/customers/collaterals/collateralAllocations","operationId":"getCollateralAllocation","name":"Retrieve the details of the collateral allocation such as collateral type, allocation amount,  percentage covered, validity and contracts against which customer collateral has been pledged.","summary":"Retrieve the customer collateral allocation.","tags":[],"parameters":[{"name":"collateralAllocationId","in":"query","type":"string","required":false,"description":"Contains the identifier of the customer collateral allocation."},{"name":"customerId","in":"query","type":"string","required":false,"description":"Identifier of the customer"},{"name":"exposureReference","in":"query","type":"string","required":false,"description":"Contains the reference of the credit line or contract that is to be covered by the collateral"},{"name":"collateralId","in":"query","type":"string","required":false,"description":"The identifier of the collateral item"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"","default":"","400":"","500":""}},{"method":"POST","path":"/holdings/customers/collaterals/collateralAllocations","fullPath":"/api/v1.0.0/holdings/customers/collaterals/collateralAllocations","operationId":"createCollateralAllocation","name":"Create the customer collateral allocation with details such as the collateral type, allocation amount,  percentage covered, validity and contracts against which customer collateral has been pledged.","summary":"Create the collateral allocation for the customer.","tags":[],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"","default":"","400":"","500":""}},{"method":"GET","path":"/holdings/customers/collaterals/propertyRegisters","fullPath":"/api/v1.0.0/holdings/customers/collaterals/propertyRegisters","operationId":"getCollateralPropertyRegister","name":"Retrieve register of customer's immovabale property with details such as property type, owner, address, market value, currency of asset value and collateral to which the property has been linked.","summary":"Retrieve register of customer's property.","tags":[],"parameters":[{"name":"propertyRegisterId","in":"query","type":"string","required":false,"description":"Contains the identifier of the asset or property register"},{"name":"collateralOwner","in":"query","type":"string","required":false,"description":"Contains the owner of the collateral item or the asset property"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"","default":"","400":"","500":""}},{"method":"POST","path":"/holdings/customers/collaterals/propertyRegisters","fullPath":"/api/v1.0.0/holdings/customers/collaterals/propertyRegisters","operationId":"createCollateralPropertyRegister","name":"Create register of customer's immovabale property with details such as property type, owner, address, market value and currency of asset value.","summary":"Create register of customer's property.","tags":[],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"","default":"","400":"","500":""}},{"method":"PUT","path":"/holdings/customers/collaterals/collateralAllocations/{collateralAllocationId}","fullPath":"/api/v1.0.0/holdings/customers/collaterals/collateralAllocations/{collateralAllocationId}","operationId":"updateCollateralAllocation","name":"Update the customer collateral allocation with details such as collateral type, allocation amount,  percentage covered, validity and contracts against which customer collateral has been pledged.","summary":"Update the collateral allocation for the customer.","tags":[],"parameters":[{"name":"collateralAllocationId","in":"path","type":"string","required":true,"description":""},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"","default":"","400":"","500":""}},{"method":"PUT","path":"/holdings/customers/collaterals/propertyRegisters/{propertyRegisterId}","fullPath":"/api/v1.0.0/holdings/customers/collaterals/propertyRegisters/{propertyRegisterId}","operationId":"updateCollateralPropertyRegister","name":"Update register of customer's immovabale property with details such as property type, owner, address, market value and currency of asset value.","summary":"Update register of customer's property.","tags":[],"parameters":[{"name":"propertyRegisterId","in":"path","type":"string","required":true,"description":""},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"","default":"","400":"","500":""}}]},{"key":"holdings-combinedSchedules-service-v1.0.0","title":"Retrieves the details of a facility arrangement account","version":"v1.0.0","description":"Retrieves the details of a facility arrangement account-deprecated","endpointCount":3,"endpoints":[{"method":"GET","path":"/holdings/facilities/{facilityId}/combinedSchedules","fullPath":"/api/v1.0.0/holdings/facilities/{facilityId}/combinedSchedules","operationId":"getCombinedSchedules","name":"Retrieves the payment schedule of facility and its drawings-deprecated. The new URL is: api/v1.0.0/holdings/creditAgreements/facilities/{facilityId}/combinedSchedules","summary":"Retrieves the payment schedule of facility and its drawings","tags":[],"parameters":[{"name":"facilityId","in":"path","type":"string","required":true,"description":"Unique identifier (contract number) of the facility"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"CombinedSchedulesResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/facilities/{facilityId}/installments/{txnAmount}","fullPath":"/api/v1.0.0/holdings/facilities/{facilityId}/installments/{txnAmount}","operationId":"getFacilityInstallments","name":"Retrieves the interest rates, installment dates, installment amounts, total payment amounts and cash back applicable for the installment products under the facility arrangement account-deprecated","summary":"Retrieves the interest rates, installment dates, installment amounts, total payment amounts and cash back applicable for the installment products under the facility arrangement account-deprecated","tags":[],"parameters":[{"name":"facilityId","in":"path","type":"string","required":true,"description":"Unique identifier (contract number) of the facility"},{"name":"txnAmount","in":"path","type":"string","required":true,"description":"Indicates the transaction amount"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"FacilityInstallmentsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/facilities/purchases","fullPath":"/api/v1.0.0/holdings/facilities/purchases","operationId":"getPosTxnDetails","name":"Retrieves the Recent Purchase summary-deprecated","summary":"Retrieves the Recent Purchase summary-deprecated","tags":[],"parameters":[{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"PosTxnDetailsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}}]},{"key":"holdings-contract-ifrs-v1.0.0","title":"IFRS Contract Default Probability","version":"v1.0.0","description":"Update probability of default (the probability that the asset will default) and loss given default (the loss percentage given that when the asset will default) at contract level to calculate the expected credit loss based on their stages under IFRS 9 impairment model.","endpointCount":1,"endpoints":[{"method":"PUT","path":"/holdings/arrangements/{arrangementId}/ifrs/lossProbabilities","fullPath":"/api/v1.0.0/holdings/arrangements/{arrangementId}/ifrs/lossProbabilities","operationId":"updateContractLossProbability","name":"Update probability of default(PD) and loss given default(LGD) at the contract level to calculate the expected credit loss (ECL) provisioning in IFRS 9 Impairment Model","summary":"Update probability of default and loss given default on contract","tags":[],"parameters":[{"name":"arrangementId","in":"path","type":"string","required":true,"description":"Indicates an unique identifier of an account"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"probabilityOfDefaults":[{}],"lossGivenDefault":"string"}},"responses":{"200":"ContractLossProbabilityResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}}]},{"key":"holdings-createDrawdowns-service-v1.0.0","title":"createDrawdowns","version":"v1.0.0","description":"Creates drawdowns under facility","endpointCount":1,"endpoints":[{"method":"POST","path":"/holdings/facilities/drawdowns","fullPath":"/api/v1.0.0/holdings/facilities/drawdowns","operationId":"createDrawdowns","name":"Creates drawdowns under facility","summary":"Creates drawdowns under facility","tags":[],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":""},{"name":"companyId","in":"header","type":"string","required":false,"description":""}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"customers":[{}],"arrangmentId":"string","currency":"string","facilityId":"string","effectiveDate":"string","activity":"string","commitment":{"amount":{},"term":{}},"settlement":{"payInAccounts":{},"payOutAccounts":{}}}},"responses":{"200":"createDrawdownsResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}}]},{"key":"holdings-createDrawdowns-service-v2.0.0","title":"createDrawdowns","version":"v2.0.0","description":"Creates drawdowns under facility","endpointCount":2,"endpoints":[{"method":"POST","path":"/holdings/facilities/drawdowns","fullPath":"/api/v1.0.0/holdings/facilities/drawdowns","operationId":"createFacilityDrawdown","name":"Create drawdown under the facility.","summary":"Create drawdown under the facility.","tags":[],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"","400":"","500":"","default":""}},{"method":"POST","path":"/holdings/facilities/drawdowns/schedules","fullPath":"/api/v1.0.0/holdings/facilities/drawdowns/schedules","operationId":"createFacilityDrawdownSchedules","name":"Create a loan arrangement for the given principal amount, term, payment frequency and interest rates. It also retrieves the details of payment schedules for the created contract","summary":"Create a loan arrangement and retrieve the payment schedule details","tags":[],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"","400":"","500":"","default":""}}]},{"key":"holdings-createFacilities-service-v1.0.0","title":"createFacilities","version":"v1.0.0","description":"Creates retail/corporate facilities","endpointCount":1,"endpoints":[{"method":"POST","path":"/holdings/facilities","fullPath":"/api/v1.0.0/holdings/facilities","operationId":"createFacilities","name":"Creates retail/corporate facilities","summary":"Creates retail/corporate facilities","tags":[],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":""},{"name":"companyId","in":"header","type":"string","required":false,"description":""}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"customers":[{}],"arrangmentId":"string","productId":"string","currency":"string","effectiveDate":"2024-01-01","activity":"string","settlement":{"payInAccounts":{},"payOutAccounts":{}},"commitment":{"amount":{},"term":{}},"drawingRules":{"allowedCustomers":{},"allowedProductGroups":{},"allowedProducts":{},"customer":{},"requiredCustomer":{},"subArrangementProduct":{}},"limit":{"limitReference":{},"limitSerial":{}}}},"responses":{"200":"createFacilitiesResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}}]},{"key":"holdings-createFacilities-service-v2.0.0","title":"create and manage facilities","version":"v2.0.0","description":"Creates and manage retail facilities","endpointCount":3,"endpoints":[{"method":"POST","path":"/holdings/facilities","fullPath":"/api/v1.0.0/holdings/facilities","operationId":"createFacilities","name":"Creates retail facilities","summary":"Creates retail facilities","tags":[],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"","default":"","400":"","500":""}},{"method":"GET","path":"/holdings/facilities/{facilityId}","fullPath":"/api/v1.0.0/holdings/facilities/{facilityId}","operationId":"getFacilityDetails","name":"Retrieve the details of the facility arrangement.","summary":"Retrieve the details of the facility arrangement.","tags":[],"parameters":[{"name":"facilityId","in":"path","type":"string","required":true,"description":"Unique identifier (contract number) of the facility"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"","default":"","400":"","500":""}},{"method":"GET","path":"/holdings/facilities/{facilityId}/drawings","fullPath":"/api/v1.0.0/holdings/facilities/{facilityId}/drawings","operationId":"getFacilityDrawingDetails","name":"Retrieve the drawings details of the drawing arrangement under the facility.","summary":"Retrieve the drawings details of the drawing arrangement under the facility.","tags":[],"parameters":[{"name":"facilityId","in":"path","type":"string","required":true,"description":"Unique identifier (contract number) of the facility."},{"name":"productGroup","in":"query","type":"string","required":false,"description":"Indicates a group under which the products exists"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"","default":"","400":"","500":""}}]},{"key":"holdings-createFacilities-service-v3.0.0","title":"create and manage facilities","version":"v3.0.0","description":"Creates and manage retail facilities","endpointCount":3,"endpoints":[{"method":"POST","path":"/holdings/facilities","fullPath":"/api/v3.0.0/holdings/facilities","operationId":"createFacilities","name":"Creates retail facilities","summary":"Creates retail facilities","tags":[],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"customers":[{}],"productId":"string","currency":"string","facilityId":"string","offerDate":"2024-01-01","drawdownDate":"2024-01-01","activity":"string","pricingSelection":"string","pricingPlan":"string","rewardsArrangementId":"string","extensions":{},"limit":[{}],"settlement":[{}],"facommitment":[{}]}},"responses":{"200":"createFacilitiesResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"GET","path":"/holdings/facilities/{facilityId}","fullPath":"/api/v3.0.0/holdings/facilities/{facilityId}","operationId":"getFacilityDetails","name":"Retrieve the details of the facility.","summary":"Retrieve the details of the facility.","tags":[],"parameters":[{"name":"facilityId","in":"path","type":"string","required":true,"description":"Unique identifier (contract number) of the facility"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"FacilityDetailsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/facilities/{facilityId}/drawings","fullPath":"/api/v3.0.0/holdings/facilities/{facilityId}/drawings","operationId":"getFacilityDrawingDetails","name":"Retrieve the drawings details under the facility.","summary":"Retrieve the drawings details under the facility.","tags":[],"parameters":[{"name":"facilityId","in":"path","type":"string","required":true,"description":"Unique identifier (contract number) of the facility"},{"name":"productGroup","in":"query","type":"string","required":false,"description":"Indicates a group under which the products exists"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"FacilityDrawingDetailsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}}]},{"key":"holdings-createNonDeliverableForwards-service-v1.0.0","title":"Treasury non deliverable forwards","version":"v1.0.0","description":"API to retrieve the fixing date of a non-deliverable forward contract based on the contract details supplied.","endpointCount":1,"endpoints":[{"method":"POST","path":"/holdings/nonDeliverableForwards","fullPath":"/api/v1.0.0/v1.0.0/holdings/nonDeliverableForwards","operationId":"createNonDeliverableForwards","name":"","summary":"","tags":[],"parameters":[{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"The identifier of the underlying Entity/Company/Branch."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"NDFType":"string","counterparty":"string","portfolioId":"string","buyOrSell":"string","dealCurrency":"string","settlementCurrency":"string","dealAmount":0.0,"notionalSettlementAmount":0.0,"valueDate":"string","dealDate":"2024-01-01","notionalRate":"string","settlementRateSource":"string","fixedDate":"2024-01-01"}},"responses":{"200":"NonDeliverableForwardsResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}}]},{"key":"holdings-createNonDeliverableForwards-service-v2.0.0","title":"Treasury non deliverable forwards","version":"v2.0.0","description":"API to create and amend non-deliverable forward contract based on the contract details supplied.It also facilitates to update the rate (fix) of a non-deliverable forward contract.","endpointCount":4,"endpoints":[{"method":"POST","path":"/holdings/nonDeliverableForwards","fullPath":"/api/v2.0.0/v2.0.0/holdings/nonDeliverableForwards","operationId":"createNonDeliverableForwards","name":"Create non-deliverable forward for the required customer for a chosen type, settlement currency, deal currency, deal amount, value date and rate source.","summary":"Create non-deliverable forward","tags":[],"parameters":[{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"NDFType":"string","counterparty":"string","portfolioId":"string","buyOrSell":"string","dealCurrency":"string","settlementCurrency":"string","dealAmount":"string","notionalSettlementAmount":"string","valueDate":"string","dealDate":"string","notionalRate":"string","settlementRateSource":"string","fixedDate":"string","treasuryCustomer":"string","treasuryRate":"string"}},"responses":{"200":"NonDeliverableForwardsResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/holdings/nonDeliverableForwards/{transactionid}","fullPath":"/api/v2.0.0/v2.0.0/holdings/nonDeliverableForwards/{transactionid}","operationId":"updateNonDeliverableForwards","name":"Amend an existing non-deliverable forward contract","summary":"Amend an existing non-deliverable forward contract","tags":[],"parameters":[{"name":"transactionid","in":"path","type":"string","required":true,"description":""},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"NDFType":"string","counterparty":"string","portfolioId":"string","buyOrSell":"string","dealCurrency":"string","settlementCurrency":"string","dealAmount":"string","notionalSettlementAmount":"string","valueDate":"string","dealDate":"string","notionalRate":"string","settlementRateSource":"string","fixedDate":"string","treasuryCustomer":"string","treasuryRate":"string"}},"responses":{"200":"NonDeliverableForwardsResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"DELETE","path":"/holdings/nonDeliverableForwards/{transactionid}","fullPath":"/api/v2.0.0/v2.0.0/holdings/nonDeliverableForwards/{transactionid}","operationId":"deleteNonDeliverableForwards","name":"Delete an existing non-deliverable forward contract","summary":"Delete an existing non-deliverable forward contract","tags":[],"parameters":[{"name":"transactionid","in":"path","type":"string","required":true,"description":""},{"name":"payload","in":"body","type":"object","required":false,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}}},"responses":{"200":"NonDeliverableForwardsResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/holdings/nonDeliverableForwards/{transactionid}/rates","fullPath":"/api/v2.0.0/v2.0.0/holdings/nonDeliverableForwards/{transactionid}/rates","operationId":"updateNonDeliverableForwardsRate","name":"Fix the currency exchange rates for the non-deliverable forward contract","summary":"Fix the non-deliverable forward contract","tags":[],"parameters":[{"name":"transactionid","in":"path","type":"string","required":true,"description":""},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"fixedDate":"string","settlementDate":"string","fixedRate":"string","settlementInterestRate":"string","extensions":{}}},"responses":{"200":"NonDeliverableForwardsRateResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}}]},{"key":"holdings-creditAgreements-api-service-v1.0.0","title":"Corporate Credit Agreements","version":"v1.0.0","description":"API for the creation and management of credit agreements for Corporate customers. The types of credit agreements are Single Level Facility, Credit Agreement with Multiple Facilities, Club Loans with Agency and Syndicated Loans.","endpointCount":14,"endpoints":[{"method":"POST","path":"/holdings/creditAgreements/deals/offers","fullPath":"/api/v1.0.0/holdings/creditAgreements/deals/offers","operationId":"createDealOffer","name":"Creates new offer Deal for the required customer when the Mandatory input details are provided. Offer Deal creates a draft contract and allow the users to negotiate multiple times. Offer Deal is a draft contract and will not affect the Balance sheet of the bank.","summary":"Creates an offer for a deal contract","tags":[],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"customers":[{}],"productId":"string","currency":"string","effectiveDate":"2024-01-01","activity":"string","settlement":[{}],"facilityRules":[{}],"dacommitment":[{}],"limit":[{}]}},"responses":{"200":"createDealOfferResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"POST","path":"/holdings/creditAgreements/facilities/offers","fullPath":"/api/v1.0.0/holdings/creditAgreements/facilities/offers","operationId":"createFacilityOffer","name":"Creates a new offer Facility for the required customer when at least the Mandatory input is provided. Offer Facility creates a draft contract and allow the users to negotiate multiple times. Offer facility is a draft contract and will not affect the Balance sheet of the bank.","summary":"Creates an offer for a facility contract","tags":[],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"customers":[{}],"productId":"string","currency":"string","dealId":"string","effectiveDate":"2024-01-01","activity":"string","settlement":[{}],"facilityRules":[{}],"facommitment":[{}],"limit":[{}]}},"responses":{"200":"createFacilityOfferResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"POST","path":"/holdings/creditAgreements/deals/offers/cancellations","fullPath":"/api/v1.0.0/holdings/creditAgreements/deals/offers/cancellations","operationId":"deleteDealOffer","name":"Deletes a new offer for the required deal contract when at least the Mandatory input is provided. Deal offer is a draft contract, which allow the user to delete the contract online and deal offer contract will not affect the balance sheet of the bank.","summary":"Deletes an offer for a deal contract","tags":[],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"productId":"string","effectiveDate":"2024-01-01"}},"responses":{"200":"deleteDealOfferResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"POST","path":"/holdings/creditAgreements/facilities/offers/cancellations","fullPath":"/api/v1.0.0/holdings/creditAgreements/facilities/offers/cancellations","operationId":"deleteFacilityOffer","name":"Deletes a new offer for the required facility contract when at least the Mandatory input is provided. Facility offer is a draft contract, which allow the user to delete the contract online and facility offer contract will not affect the balance sheet of the bank.","summary":"Deletes an offer for a facility contract","tags":[],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"productId":"string","effectiveDate":"2024-01-01"}},"responses":{"200":"deleteFacilityOfferResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"POST","path":"/holdings/creditAgreements/deals/offers/acceptances","fullPath":"/api/v1.0.0/holdings/creditAgreements/deals/offers/acceptances","operationId":"acceptDealOffer","name":"On executing acceptance, the contract is changed from Offer to live Deal for the required customer when at least the Mandatory input is provided. Process will check all the required mandatory inputs and prompt an error message when mandatory details are not provided. Once the accept deal offer is processed further offer negotiation is not allowed.","summary":"Accept the deal offer and the execute the contract to live","tags":[],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"productId":"string","effectiveDate":"2024-01-01","settlement":[{}],"facilityRules":[{}],"dacommitment":[{}],"limit":[{}]}},"responses":{"200":"acceptDealOfferResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"POST","path":"/holdings/creditAgreements/facilities/offers/acceptances","fullPath":"/api/v1.0.0/holdings/creditAgreements/facilities/offers/acceptances","operationId":"acceptFacilityOffer","name":"On executing acceptance, the contract is changed from Offer to live Facility for the required customer when at least the Mandatory input is provided. Process will check all the required mandatory inputs and prompt an error message when mandatory details are not provided. Once the accept deal offer is processed further offer negotiation is not allowed.","summary":"Accept the facility offer and the execute the contract to live","tags":[],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"productId":"string","effectiveDate":"2024-01-01","settlement":[{}],"facilityRules":[{}],"facommitment":[{}],"limit":[{}]}},"responses":{"200":"acceptFacilityOfferResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"POST","path":"/holdings/creditAgreements/drawdowns/offers","fullPath":"/api/v1.0.0/holdings/creditAgreements/drawdowns/offers","operationId":"createDrawdownOffer","name":"Creates a new drawdown offer for the required customer. ","summary":"Creates a new drawdown offer for the required customer. ","tags":[],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"customers":[{}],"productId":"string","currency":"string","facilityId":"string","offerDate":"2024-01-01","drawdownDate":"2024-01-01","activity":"string","dwcommitment":[{}],"settlement":[{}]}},"responses":{"200":"createDrawdownOfferResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"POST","path":"/holdings/creditAgreements/drawdowns/offers/negotiations","fullPath":"/api/v1.0.0/holdings/creditAgreements/drawdowns/offers/negotiations","operationId":"createOfferDrawdownRenegotiation","name":"Renegotiate the offer drawdown for the required customer.","summary":"Renegotiate the offer drawdown for the required customer.","tags":[],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"productId":"string","drawdownDate":"2024-01-01","dwcommitment":[{}],"settlement":[{}]}},"responses":{"200":"createOfferDrawdownRenegotiationResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"POST","path":"/holdings/creditAgreements/drawdowns/offers/cancellations","fullPath":"/api/v1.0.0/holdings/creditAgreements/drawdowns/offers/cancellations","operationId":"deleteDrawdownOffer","name":"Cancellation of offer drawdown for the required customer.","summary":"Cancellation of offer drawdown for the required customer.","tags":[],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"productId":"string","drawdownDate":"2024-01-01"}},"responses":{"200":"deleteDrawdownOfferResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"POST","path":"/holdings/creditAgreements/drawdowns/offers/acceptances","fullPath":"/api/v1.0.0/holdings/creditAgreements/drawdowns/offers/acceptances","operationId":"acceptOfferDrawdown","name":"Convert an offer drawdown to a live drawdown for the required customer.","summary":"Convert an offer drawdown to a live drawdown for the required customer.","tags":[],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"productId":"string","drawdownDate":"2024-01-01","dwcommitment":[{}],"settlement":[{}]}},"responses":{"200":"acceptOfferDrawdownResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"GET","path":"/holdings/creditAgreements/facilities/{facilityId}/drawingProducts","fullPath":"/api/v1.0.0/holdings/creditAgreements/facilities/{facilityId}/drawingProducts","operationId":"getFacilityDrawingProducts","name":"Retrieves the available drawing products under the facility ","summary":"Retrieves the available drawing products under the facility ","tags":[],"parameters":[{"name":"facilityId","in":"path","type":"string","required":true,"description":"Unique identifier (contract number) of the facility"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from t24 on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"FacilityDrawingProductsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/creditAgreements/facilities/{facilityId}/combinedSchedules","fullPath":"/api/v1.0.0/holdings/creditAgreements/facilities/{facilityId}/combinedSchedules","operationId":"getCombinedSchedules","name":"Retrieves the payment schedule of facility and its drawings","summary":"Retrieves the payment schedule of facility and its drawings","tags":[],"parameters":[{"name":"facilityId","in":"path","type":"string","required":true,"description":"Unique identifier (contract number) of the facility"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from t24 on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"CombinedSchedulesResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"POST","path":"/holdings/creditAgreements/facilities","fullPath":"/api/v1.0.0/holdings/creditAgreements/facilities","operationId":"createFacilities","name":"Creates corporate facilities","summary":"Creates corporate facilities","tags":[],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"customers":[{}],"arrangmentId":"string","productId":"string","currency":"string","effectiveDate":"2024-01-01","activity":"string","settlement":[{}],"facilityRules":[{}],"facommitment":[{}],"limit":[{}]}},"responses":{"200":"createFacilitiesResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"POST","path":"/holdings/creditAgreements/drawdowns","fullPath":"/api/v1.0.0/holdings/creditAgreements/drawdowns","operationId":"createDrawdowns","name":"Creates drawdowns under facility","summary":"Creates drawdowns under facility","tags":[],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"customers":[{}],"arrangmentId":"string","currency":"string","facilityId":"string","effectiveDate":"string","activity":"string","productId":"string","dwcommitment":[{}],"settlement":[{}]}},"responses":{"200":"createDrawdownsResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}}]},{"key":"holdings-creditAgreements-api-service-v2.0.0","title":"Corporate Credit Agreements","version":"v2.0.0","description":"API for the creation and management of credit agreements for Corporate customers. The types of credit agreements are Single Level Facility, Credit Agreement with Multiple Facilities, Club Loans with Agency and Syndicated Loans.","endpointCount":14,"endpoints":[{"method":"POST","path":"/holdings/creditAgreements/deals/offers","fullPath":"/api/v2.0.0/holdings/creditAgreements/deals/offers","operationId":"createDealOffer","name":"Creates new offer Deal for the required customer when the Mandatory input details are provided. Offer Deal creates a draft contract and allow the users to negotiate multiple times. Offer Deal is a draft contract and will not affect the Balance sheet of the bank.","summary":"Creates an offer for a deal contract","tags":[],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"customers":[{}],"productId":"string","currency":"string","effectiveDate":"2024-01-01","activity":"string","settlement":[{}],"facilityRules":[{}],"dacommitment":[{}],"limit":[{}]}},"responses":{"200":"createDealOfferResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"POST","path":"/holdings/creditAgreements/facilities/offers","fullPath":"/api/v2.0.0/holdings/creditAgreements/facilities/offers","operationId":"createFacilityOffer","name":"Creates a new offer Facility for the required customer when at least the Mandatory input is provided. Offer Facility creates a draft contract and allow the users to negotiate multiple times. Offer facility is a draft contract and will not affect the Balance sheet of the bank.","summary":"Creates an offer for a facility contract","tags":[],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"customers":[{}],"productId":"string","currency":"string","dealId":"string","effectiveDate":"2024-01-01","activity":"string","settlement":[{}],"facilityRules":[{}],"facommitment":[{}],"limit":[{}]}},"responses":{"200":"createFacilityOfferResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"POST","path":"/holdings/creditAgreements/deals/offers/cancellations","fullPath":"/api/v2.0.0/holdings/creditAgreements/deals/offers/cancellations","operationId":"deleteDealOffer","name":"Deletes a new offer for the required deal contract when at least the Mandatory input is provided. Deal offer is a draft contract, which allow the user to delete the contract online and deal offer contract will not affect the balance sheet of the bank.","summary":"Deletes an offer for a deal contract","tags":[],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"productId":"string","effectiveDate":"2024-01-01"}},"responses":{"200":"deleteDealOfferResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"POST","path":"/holdings/creditAgreements/facilities/offers/cancellations","fullPath":"/api/v2.0.0/holdings/creditAgreements/facilities/offers/cancellations","operationId":"deleteFacilityOffer","name":"Deletes a new offer for the required facility contract when at least the Mandatory input is provided. Facility offer is a draft contract, which allow the user to delete the contract online and facility offer contract will not affect the balance sheet of the bank.","summary":"Deletes an offer for a facility contract","tags":[],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"productId":"string","effectiveDate":"2024-01-01"}},"responses":{"200":"deleteFacilityOfferResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"POST","path":"/holdings/creditAgreements/deals/offers/acceptances","fullPath":"/api/v2.0.0/holdings/creditAgreements/deals/offers/acceptances","operationId":"acceptDealOffer","name":"On executing acceptance, the contract is changed from Offer to live Deal for the required customer when at least the Mandatory input is provided. Process will check all the required mandatory inputs and prompt an error message when mandatory details are not provided. Once the accept deal offer is processed further offer negotiation is not allowed.","summary":"Accept the deal offer and execute the contract to live","tags":[],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"productId":"string","effectiveDate":"2024-01-01","settlement":[{}],"facilityRules":[{}],"dacommitment":[{}],"limit":[{}]}},"responses":{"200":"acceptDealOfferResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"POST","path":"/holdings/creditAgreements/facilities/offers/acceptances","fullPath":"/api/v2.0.0/holdings/creditAgreements/facilities/offers/acceptances","operationId":"acceptFacilityOffer","name":"On executing acceptance, the contract is changed from Offer to live Facility for the required customer when at least the Mandatory input is provided. Process will check all the required mandatory inputs and prompt an error message when mandatory details are not provided. Once the accept deal offer is processed further offer negotiation is not allowed.","summary":"Accept the facility offer and the execute the contract to live","tags":[],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"productId":"string","effectiveDate":"2024-01-01","settlement":[{}],"facilityRules":[{}],"facommitment":[{}],"limit":[{}]}},"responses":{"200":"acceptFacilityOfferResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"POST","path":"/holdings/creditAgreements/drawdowns/offers","fullPath":"/api/v2.0.0/holdings/creditAgreements/drawdowns/offers","operationId":"createDrawdownOffer","name":"Creates a new drawdown offer for the required customer. ","summary":"Creates a new drawdown offer for the required customer. ","tags":[],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"customers":[{}],"productId":"string","currency":"string","facilityId":"string","offerDate":"2024-01-01","drawdownDate":"2024-01-01","activity":"string","dwcommitment":[{}],"settlement":[{}]}},"responses":{"200":"createDrawdownOfferResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"POST","path":"/holdings/creditAgreements/drawdowns/offers/negotiations","fullPath":"/api/v2.0.0/holdings/creditAgreements/drawdowns/offers/negotiations","operationId":"createOfferDrawdownRenegotiation","name":"Renegotiate the offer drawdown for the required customer.","summary":"Renegotiate the offer drawdown for the required customer.","tags":[],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"productId":"string","drawdownDate":"2024-01-01","settlement":[{}]}},"responses":{"200":"createOfferDrawdownRenegotiationResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"POST","path":"/holdings/creditAgreements/drawdowns/offers/cancellations","fullPath":"/api/v2.0.0/holdings/creditAgreements/drawdowns/offers/cancellations","operationId":"deleteDrawdownOffer","name":"Cancellation of offer drawdown for the required customer.","summary":"Cancellation of offer drawdown for the required customer.","tags":[],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"productId":"string","drawdownDate":"2024-01-01"}},"responses":{"200":"deleteDrawdownOfferResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"POST","path":"/holdings/creditAgreements/drawdowns/offers/acceptances","fullPath":"/api/v2.0.0/holdings/creditAgreements/drawdowns/offers/acceptances","operationId":"acceptOfferDrawdown","name":"Convert an offer drawdown to a live drawdown for the required customer.","summary":"Convert an offer drawdown to a live drawdown for the required customer.","tags":[],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"productId":"string","drawdownDate":"2024-01-01","dwcommitment":[{}],"settlement":[{}]}},"responses":{"200":"acceptOfferDrawdownResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"GET","path":"/holdings/creditAgreements/facilities/{facilityId}/drawingProducts","fullPath":"/api/v2.0.0/holdings/creditAgreements/facilities/{facilityId}/drawingProducts","operationId":"getFacilityDrawingProducts","name":"Retrieves the available drawing products under the facility ","summary":"Retrieves the available drawing products under the facility ","tags":[],"parameters":[{"name":"facilityId","in":"path","type":"string","required":true,"description":"Unique identifier (contract number) of the facility"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from t24 on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"FacilityDrawingProductsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/creditAgreements/facilities/{facilityId}/combinedSchedules","fullPath":"/api/v2.0.0/holdings/creditAgreements/facilities/{facilityId}/combinedSchedules","operationId":"getCombinedSchedules","name":"Retrieves the payment schedule of facility and its drawings","summary":"Retrieves the payment schedule of facility and its drawings","tags":[],"parameters":[{"name":"facilityId","in":"path","type":"string","required":true,"description":"Unique identifier (contract number) of the facility"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from t24 on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"CombinedSchedulesResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"POST","path":"/holdings/creditAgreements/facilities","fullPath":"/api/v2.0.0/holdings/creditAgreements/facilities","operationId":"createFacilities","name":"Creates corporate facilities","summary":"Creates corporate facilities","tags":[],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"customers":[{}],"productId":"string","currency":"string","effectiveDate":"2024-01-01","settlement":[{}],"facilityRules":[{}],"facommitment":[{}],"limit":[{}]}},"responses":{"200":"createFacilitiesResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"POST","path":"/holdings/creditAgreements/drawdowns","fullPath":"/api/v2.0.0/holdings/creditAgreements/drawdowns","operationId":"createDrawdowns","name":"Creates drawdowns under facility","summary":"Creates drawdowns under facility","tags":[],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"customers":[{}],"arrangmentId":"string","currency":"string","facilityId":"string","effectiveDate":"string","activity":"string","productId":"string","dwcommitment":[{}],"settlement":[{}]}},"responses":{"200":"createDrawdownsResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}}]},{"key":"holdings-creditAgreements-api-service-v2.1.0","title":"Corporate Credit Agreements","version":"v2.1.0","description":"API for the creation and management of credit agreements for Corporate customers. The types of credit agreements are Single Level Facility, Credit Agreement with Multiple Facilities, Club Loans with Agency and Syndicated Loans.","endpointCount":19,"endpoints":[{"method":"POST","path":"/holdings/creditAgreements/deals/offers","fullPath":"/api/v2.1.0/holdings/creditAgreements/deals/offers","operationId":"createDealOffer","name":"Creates new offer Deal for the required customer when the Mandatory input details are provided. Offer Deal creates a draft contract and allow the users to negotiate multiple times. Offer Deal is a draft contract and will not affect the Balance sheet of the bank.","summary":"Creates an offer for a deal contract","tags":[],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"customers":[{}],"productId":"string","currency":"string","effectiveDate":"2024-01-01","activity":"string","settlement":[{}],"facilityRules":[{}],"dacommitment":[{}],"limit":[{}]}},"responses":{"200":"createDealOfferResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"POST","path":"/holdings/creditAgreements/facilities/offers","fullPath":"/api/v2.1.0/holdings/creditAgreements/facilities/offers","operationId":"createFacilityOffer","name":"Creates a new offer Facility for the required customer when at least the Mandatory input is provided. Offer Facility creates a draft contract and allow the users to negotiate multiple times. Offer facility is a draft contract and will not affect the Balance sheet of the bank.","summary":"Creates an offer for a facility contract","tags":[],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"customers":[{}],"productId":"string","currency":"string","dealId":"string","effectiveDate":"2024-01-01","activity":"string","settlement":[{}],"facilityRules":[{}],"facommitment":[{}],"limit":[{}]}},"responses":{"200":"createFacilityOfferResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"POST","path":"/holdings/creditAgreements/deals/offers/cancellations","fullPath":"/api/v2.1.0/holdings/creditAgreements/deals/offers/cancellations","operationId":"deleteDealOffer","name":"Deletes a new offer for the required deal contract when at least the Mandatory input is provided. Deal offer is a draft contract, which allow the user to delete the contract online and deal offer contract will not affect the balance sheet of the bank.","summary":"Deletes an offer for a deal contract","tags":[],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"productId":"string","effectiveDate":"2024-01-01"}},"responses":{"200":"deleteDealOfferResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"POST","path":"/holdings/creditAgreements/facilities/offers/cancellations","fullPath":"/api/v2.1.0/holdings/creditAgreements/facilities/offers/cancellations","operationId":"deleteFacilityOffer","name":"Deletes a new offer for the required facility contract when at least the Mandatory input is provided. Facility offer is a draft contract, which allow the user to delete the contract online and facility offer contract will not affect the balance sheet of the bank.","summary":"Deletes an offer for a facility contract","tags":[],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"productId":"string","effectiveDate":"2024-01-01"}},"responses":{"200":"deleteFacilityOfferResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"POST","path":"/holdings/creditAgreements/deals/offers/acceptances","fullPath":"/api/v2.1.0/holdings/creditAgreements/deals/offers/acceptances","operationId":"acceptDealOffer","name":"On executing acceptance, the contract is changed from Offer to live Deal for the required customer when at least the Mandatory input is provided. Process will check all the required mandatory inputs and prompt an error message when mandatory details are not provided. Once the accept deal offer is processed further offer negotiation is not allowed.","summary":"Accept the deal offer and execute the contract to live","tags":[],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"productId":"string","effectiveDate":"2024-01-01","settlement":[{}],"facilityRules":[{}],"dacommitment":[{}],"limit":[{}]}},"responses":{"200":"acceptDealOfferResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"POST","path":"/holdings/creditAgreements/facilities/offers/acceptances","fullPath":"/api/v2.1.0/holdings/creditAgreements/facilities/offers/acceptances","operationId":"acceptFacilityOffer","name":"On executing acceptance, the contract is changed from Offer to live Facility for the required customer when at least the Mandatory input is provided. Process will check all the required mandatory inputs and prompt an error message when mandatory details are not provided. Once the accept deal offer is processed further offer negotiation is not allowed.","summary":"Accept the facility offer and the execute the contract to live","tags":[],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"productId":"string","effectiveDate":"2024-01-01","settlement":[{}],"facilityRules":[{}],"facommitment":[{}],"limit":[{}]}},"responses":{"200":"acceptFacilityOfferResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"POST","path":"/holdings/creditAgreements/drawdowns/offers","fullPath":"/api/v2.1.0/holdings/creditAgreements/drawdowns/offers","operationId":"createDrawdownOffer","name":"Creates a new drawdown offer for the required customer. ","summary":"Creates a new drawdown offer for the required customer. ","tags":[],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"customers":[{}],"productId":"string","currency":"string","facilityId":"string","offerDate":"2024-01-01","drawdownDate":"2024-01-01","activity":"string","dwcommitment":[{}],"settlement":[{}]}},"responses":{"200":"createDrawdownOfferResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"POST","path":"/holdings/creditAgreements/drawdowns/offers/negotiations","fullPath":"/api/v2.1.0/holdings/creditAgreements/drawdowns/offers/negotiations","operationId":"createOfferDrawdownRenegotiation","name":"Renegotiate the offer drawdown for the required customer.","summary":"Renegotiate the offer drawdown for the required customer.","tags":[],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"productId":"string","drawdownDate":"2024-01-01","settlement":[{}]}},"responses":{"200":"createOfferDrawdownRenegotiationResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"POST","path":"/holdings/creditAgreements/drawdowns/offers/cancellations","fullPath":"/api/v2.1.0/holdings/creditAgreements/drawdowns/offers/cancellations","operationId":"deleteDrawdownOffer","name":"Cancellation of offer drawdown for the required customer.","summary":"Cancellation of offer drawdown for the required customer.","tags":[],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"productId":"string","drawdownDate":"2024-01-01"}},"responses":{"200":"deleteDrawdownOfferResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"POST","path":"/holdings/creditAgreements/drawdowns/offers/acceptances","fullPath":"/api/v2.1.0/holdings/creditAgreements/drawdowns/offers/acceptances","operationId":"acceptOfferDrawdown","name":"Convert an offer drawdown to a live drawdown for the required customer.","summary":"Convert an offer drawdown to a live drawdown for the required customer.","tags":[],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"productId":"string","drawdownDate":"2024-01-01","dwcommitment":[{}],"settlement":[{}]}},"responses":{"200":"acceptOfferDrawdownResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"GET","path":"/holdings/creditAgreements/facilities/{facilityId}/drawingProducts","fullPath":"/api/v2.1.0/holdings/creditAgreements/facilities/{facilityId}/drawingProducts","operationId":"getFacilityDrawingProducts","name":"Retrieves the available drawing products under the facility ","summary":"Retrieves the available drawing products under the facility ","tags":[],"parameters":[{"name":"facilityId","in":"path","type":"string","required":true,"description":"Unique identifier (contract number) of the facility"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from t24 on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"FacilityDrawingProductsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/creditAgreements/facilities/{facilityId}/combinedSchedules","fullPath":"/api/v2.1.0/holdings/creditAgreements/facilities/{facilityId}/combinedSchedules","operationId":"getCombinedSchedules","name":"Retrieves the payment schedule of facility and its drawings","summary":"Retrieves the payment schedule of facility and its drawings","tags":[],"parameters":[{"name":"facilityId","in":"path","type":"string","required":true,"description":"Unique identifier (contract number) of the facility"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from t24 on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"CombinedSchedulesResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"POST","path":"/holdings/creditAgreements/facilities","fullPath":"/api/v2.1.0/holdings/creditAgreements/facilities","operationId":"createFacilities","name":"Creates corporate facilities","summary":"Creates corporate facilities","tags":[],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"customers":[{}],"productId":"string","currency":"string","effectiveDate":"2024-01-01","settlement":[{}],"facilityRules":[{}],"facommitment":[{}],"limit":[{}]}},"responses":{"200":"createFacilitiesResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"POST","path":"/holdings/creditAgreements/drawdowns","fullPath":"/api/v2.1.0/holdings/creditAgreements/drawdowns","operationId":"createDrawdowns","name":"Creates drawdowns under facility","summary":"Creates drawdowns under facility","tags":[],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"customers":[{}],"arrangmentId":"string","currency":"string","facilityId":"string","effectiveDate":"string","activity":"string","productId":"string","dwcommitment":[{}],"settlement":[{}]}},"responses":{"200":"createDrawdownsResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"GET","path":"/holdings/creditAgreements/facilities/{facilityId}/drawingRules","fullPath":"/api/v2.1.0/holdings/creditAgreements/facilities/{facilityId}/drawingRules","operationId":"getFacilityDrawingRules","name":"Retrieves the allowed Customers, Currencies and Products for a new drawing under the facility","summary":"Retrieves the allowed Customers, Currencies and Products for a new drawing under the facility","tags":[],"parameters":[{"name":"facilityId","in":"path","type":"string","required":true,"description":"Unique identifier (contract number) of the facility"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from t24 on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"FacilityDrawingRulesResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/creditAgreements/facilities/{facilityId}/drawings","fullPath":"/api/v2.1.0/holdings/creditAgreements/facilities/{facilityId}/drawings","operationId":"getDrawingsUnderFacility","name":"Retrieves the drawings under a Facility","summary":"Retrieves the drawings under a Facility","tags":[],"parameters":[{"name":"facilityId","in":"path","type":"string","required":true,"description":"Unique identifier (contract number) of the facility"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from t24 on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"DrawingsUnderFacilityResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/creditAgreements/facilities/drawings/{drawingId}/parentFacilities","fullPath":"/api/v2.1.0/holdings/creditAgreements/facilities/drawings/{drawingId}/parentFacilities","operationId":"getDrawingFacility","name":"Retrieves the parent facility for a drawing","summary":"Retrieves the parent facility for a drawing","tags":[],"parameters":[{"name":"drawingId","in":"path","type":"string","required":true,"description":"Identifier of drawings application under the Letter of Credit system that is used to effect the transfer of funds and the acceptance of documents under Letters of Credit and Documentary Collection tra"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from t24 on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"DrawingFacilityResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/creditAgreements/facilities/{facilityId}/commitmentSchedules","fullPath":"/api/v2.1.0/holdings/creditAgreements/facilities/{facilityId}/commitmentSchedules","operationId":"getFacilityCommitmentSchedule","name":"Retrieves the commitment schedule of a facility","summary":"Retrieves the commitment schedule of a facility","tags":[],"parameters":[{"name":"facilityId","in":"path","type":"string","required":true,"description":"Unique identifier (contract number) of the facility"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from t24 on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"FacilityCommitmentScheduleResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/creditAgreements/facilities/{facilityId}/parentDeals","fullPath":"/api/v2.1.0/holdings/creditAgreements/facilities/{facilityId}/parentDeals","operationId":"getFacilityDeal","name":"Retrieves the parent deal for a facility","summary":"Retrieves the parent deal for a facility","tags":[],"parameters":[{"name":"facilityId","in":"path","type":"string","required":true,"description":"Unique identifier (contract number) of the facility"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from t24 on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"FacilityDealResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}}]},{"key":"holdings-creditAgreements-api-service-v2.2.0","title":"Corporate Credit Agreements","version":"v2.2.0","description":"API for the creation and management of credit agreements for Corporate customers. The types of credit agreements are Single Level Facility, Credit Agreement with Multiple Facilities, Club Loans with Agency and Syndicated Loans.","endpointCount":21,"endpoints":[{"method":"POST","path":"/holdings/creditAgreements/deals/offers","fullPath":"/api/v2.2.0/holdings/creditAgreements/deals/offers","operationId":"createDealOffer","name":"Creates new offer Deal for the required customer when the Mandatory input details are provided. Offer Deal creates a draft contract and allow the users to negotiate multiple times. Offer Deal is a draft contract and will not affect the Balance sheet of the bank.","summary":"Creates an offer for a deal contract","tags":[],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"customers":[{}],"productId":"string","currency":"string","effectiveDate":"2024-01-01","activity":"string","settlement":[{}],"facilityRules":[{}],"dacommitment":[{}],"limit":[{}]}},"responses":{"200":"createDealOfferResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"POST","path":"/holdings/creditAgreements/facilities/offers","fullPath":"/api/v2.2.0/holdings/creditAgreements/facilities/offers","operationId":"createFacilityOffer","name":"Creates a new offer Facility for the required customer when at least the Mandatory input is provided. Offer Facility creates a draft contract and allow the users to negotiate multiple times. Offer facility is a draft contract and will not affect the Balance sheet of the bank.","summary":"Creates an offer for a facility contract","tags":[],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"customers":[{}],"productId":"string","currency":"string","dealId":"string","effectiveDate":"2024-01-01","activity":"string","settlement":[{}],"facilityRules":[{}],"facommitment":[{}],"limit":[{}]}},"responses":{"200":"createFacilityOfferResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"POST","path":"/holdings/creditAgreements/deals/offers/cancellations","fullPath":"/api/v2.2.0/holdings/creditAgreements/deals/offers/cancellations","operationId":"deleteDealOffer","name":"Deletes a new offer for the required deal contract when at least the Mandatory input is provided. Deal offer is a draft contract, which allow the user to delete the contract online and deal offer contract will not affect the balance sheet of the bank.","summary":"Deletes an offer for a deal contract","tags":[],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"productId":"string","effectiveDate":"2024-01-01"}},"responses":{"200":"deleteDealOfferResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"POST","path":"/holdings/creditAgreements/facilities/offers/cancellations","fullPath":"/api/v2.2.0/holdings/creditAgreements/facilities/offers/cancellations","operationId":"deleteFacilityOffer","name":"Deletes a new offer for the required facility contract when at least the Mandatory input is provided. Facility offer is a draft contract, which allow the user to delete the contract online and facility offer contract will not affect the balance sheet of the bank.","summary":"Deletes an offer for a facility contract","tags":[],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"productId":"string","effectiveDate":"2024-01-01"}},"responses":{"200":"deleteFacilityOfferResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"POST","path":"/holdings/creditAgreements/deals/offers/acceptances","fullPath":"/api/v2.2.0/holdings/creditAgreements/deals/offers/acceptances","operationId":"acceptDealOffer","name":"On executing acceptance, the contract is changed from Offer to live Deal for the required customer when at least the Mandatory input is provided. Process will check all the required mandatory inputs and prompt an error message when mandatory details are not provided. Once the accept deal offer is processed further offer negotiation is not allowed.","summary":"Accept the deal offer and execute the contract to live","tags":[],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"productId":"string","effectiveDate":"2024-01-01","settlement":[{}],"facilityRules":[{}],"dacommitment":[{}],"limit":[{}]}},"responses":{"200":"acceptDealOfferResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"POST","path":"/holdings/creditAgreements/facilities/offers/acceptances","fullPath":"/api/v2.2.0/holdings/creditAgreements/facilities/offers/acceptances","operationId":"acceptFacilityOffer","name":"On executing acceptance, the contract is changed from Offer to live Facility for the required customer when at least the Mandatory input is provided. Process will check all the required mandatory inputs and prompt an error message when mandatory details are not provided. Once the accept deal offer is processed further offer negotiation is not allowed.","summary":"Accept the facility offer and the execute the contract to live","tags":[],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"productId":"string","effectiveDate":"2024-01-01","settlement":[{}],"facilityRules":[{}],"facommitment":[{}],"limit":[{}]}},"responses":{"200":"acceptFacilityOfferResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"POST","path":"/holdings/creditAgreements/drawdowns/offers","fullPath":"/api/v2.2.0/holdings/creditAgreements/drawdowns/offers","operationId":"createDrawdownOffer","name":"Creates a new drawdown offer for the required customer. ","summary":"Creates a new drawdown offer for the required customer. ","tags":[],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"customers":[{}],"productId":"string","currency":"string","facilityId":"string","offerDate":"2024-01-01","drawdownDate":"2024-01-01","activity":"string","dwcommitment":[{}],"settlement":[{}]}},"responses":{"200":"createDrawdownOfferResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"POST","path":"/holdings/creditAgreements/drawdowns/offers/negotiations","fullPath":"/api/v2.2.0/holdings/creditAgreements/drawdowns/offers/negotiations","operationId":"createOfferDrawdownRenegotiation","name":"Renegotiate the offer drawdown for the required customer.","summary":"Renegotiate the offer drawdown for the required customer.","tags":[],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"productId":"string","drawdownDate":"2024-01-01","settlement":[{}]}},"responses":{"200":"createOfferDrawdownRenegotiationResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"POST","path":"/holdings/creditAgreements/drawdowns/offers/cancellations","fullPath":"/api/v2.2.0/holdings/creditAgreements/drawdowns/offers/cancellations","operationId":"deleteDrawdownOffer","name":"Cancellation of offer drawdown for the required customer.","summary":"Cancellation of offer drawdown for the required customer.","tags":[],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"productId":"string","drawdownDate":"2024-01-01"}},"responses":{"200":"deleteDrawdownOfferResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"POST","path":"/holdings/creditAgreements/drawdowns/offers/acceptances","fullPath":"/api/v2.2.0/holdings/creditAgreements/drawdowns/offers/acceptances","operationId":"acceptOfferDrawdown","name":"Convert an offer drawdown to a live drawdown for the required customer.","summary":"Convert an offer drawdown to a live drawdown for the required customer.","tags":[],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"productId":"string","drawdownDate":"2024-01-01","dwcommitment":[{}],"settlement":[{}]}},"responses":{"200":"acceptOfferDrawdownResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"GET","path":"/holdings/creditAgreements/facilities/{facilityId}/drawingProducts","fullPath":"/api/v2.2.0/holdings/creditAgreements/facilities/{facilityId}/drawingProducts","operationId":"getFacilityDrawingProducts","name":"Retrieves the available drawing products under the facility ","summary":"Retrieves the available drawing products under the facility ","tags":[],"parameters":[{"name":"facilityId","in":"path","type":"string","required":true,"description":"Unique identifier (contract number) of the facility"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from t24 on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"FacilityDrawingProductsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/creditAgreements/facilities/{facilityId}/combinedSchedules","fullPath":"/api/v2.2.0/holdings/creditAgreements/facilities/{facilityId}/combinedSchedules","operationId":"getCombinedSchedules","name":"Retrieves the payment schedule of facility and its drawings","summary":"Retrieves the payment schedule of facility and its drawings","tags":[],"parameters":[{"name":"facilityId","in":"path","type":"string","required":true,"description":"Unique identifier (contract number) of the facility"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from t24 on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"CombinedSchedulesResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"POST","path":"/holdings/creditAgreements/facilities","fullPath":"/api/v2.2.0/holdings/creditAgreements/facilities","operationId":"createFacilities","name":"Creates corporate facilities","summary":"Creates corporate facilities","tags":[],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"customers":[{}],"productId":"string","currency":"string","effectiveDate":"2024-01-01","settlement":[{}],"facilityRules":[{}],"facommitment":[{}],"limit":[{}]}},"responses":{"200":"createFacilitiesResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"POST","path":"/holdings/creditAgreements/drawdowns","fullPath":"/api/v2.2.0/holdings/creditAgreements/drawdowns","operationId":"createDrawdowns","name":"Creates drawdowns under facility","summary":"Creates drawdowns under facility","tags":[],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"customers":[{}],"arrangmentId":"string","currency":"string","facilityId":"string","effectiveDate":"string","activity":"string","productId":"string","dwcommitment":[{}],"settlement":[{}]}},"responses":{"200":"createDrawdownsResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"GET","path":"/holdings/creditAgreements/facilities/{facilityId}/drawingRules","fullPath":"/api/v2.2.0/holdings/creditAgreements/facilities/{facilityId}/drawingRules","operationId":"getFacilityDrawingRules","name":"Retrieves the allowed Customers, Currencies and Products for a new drawing under the facility","summary":"Retrieves the allowed Customers, Currencies and Products for a new drawing under the facility","tags":[],"parameters":[{"name":"facilityId","in":"path","type":"string","required":true,"description":"Unique identifier (contract number) of the facility"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from t24 on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"FacilityDrawingRulesResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/creditAgreements/facilities/{facilityId}/drawings","fullPath":"/api/v2.2.0/holdings/creditAgreements/facilities/{facilityId}/drawings","operationId":"getDrawingsUnderFacility","name":"Retrieves the drawings under a Facility","summary":"Retrieves the drawings under a Facility","tags":[],"parameters":[{"name":"facilityId","in":"path","type":"string","required":true,"description":"Unique identifier (contract number) of the facility"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from t24 on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"DrawingsUnderFacilityResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/creditAgreements/facilities/drawings/{drawingId}/parentFacilities","fullPath":"/api/v2.2.0/holdings/creditAgreements/facilities/drawings/{drawingId}/parentFacilities","operationId":"getDrawingFacility","name":"Retrieves the parent facility for a drawing","summary":"Retrieves the parent facility for a drawing","tags":[],"parameters":[{"name":"drawingId","in":"path","type":"string","required":true,"description":"Identifier of drawings application under the Letter of Credit system that is used to effect the transfer of funds and the acceptance of documents under Letters of Credit and Documentary Collection tra"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from t24 on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"DrawingFacilityResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/creditAgreements/facilities/{facilityId}/commitmentSchedules","fullPath":"/api/v2.2.0/holdings/creditAgreements/facilities/{facilityId}/commitmentSchedules","operationId":"getFacilityCommitmentSchedule","name":"Retrieves the commitment schedule of a facility","summary":"Retrieves the commitment schedule of a facility","tags":[],"parameters":[{"name":"facilityId","in":"path","type":"string","required":true,"description":"Unique identifier (contract number) of the facility"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from t24 on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"FacilityCommitmentScheduleResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/creditAgreements/facilities/{facilityId}/parentDeals","fullPath":"/api/v2.2.0/holdings/creditAgreements/facilities/{facilityId}/parentDeals","operationId":"getFacilityDeal","name":"Retrieves the parent deal for a facility","summary":"Retrieves the parent deal for a facility","tags":[],"parameters":[{"name":"facilityId","in":"path","type":"string","required":true,"description":"Unique identifier (contract number) of the facility"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from t24 on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"FacilityDealResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/creditAgreements/facilities/{facilityId}/balances","fullPath":"/api/v2.2.0/holdings/creditAgreements/facilities/{facilityId}/balances","operationId":"getFacilityFinancialSummary","name":"Retrieves the financial summary for a facility arrangement","summary":"Retrieves the financial summary for a facility arrangement","tags":[],"parameters":[{"name":"facilityId","in":"path","type":"string","required":true,"description":"Unique identifier (contract number) of the facility"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from t24 on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"FacilityFinancialSummaryResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/creditAgreements/facilities/{facilityId}/consolidatedBalances","fullPath":"/api/v2.2.0/holdings/creditAgreements/facilities/{facilityId}/consolidatedBalances","operationId":"getFacilityConsolidatedBalances","name":"Retrieves the consolidated balances for a facility arrangement","summary":"Retrieves the consolidated balances for a facility arrangement","tags":[],"parameters":[{"name":"facilityId","in":"path","type":"string","required":true,"description":"Unique identifier (contract number) of the facility"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from t24 on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"FacilityConsolidatedBalancesResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}}]},{"key":"holdings-creditAgreements-api-service-v2.3.0","title":"Corporate Credit Agreements","version":"v2.3.0","description":"API for the creation and management of credit agreements for Corporate customers. The types of credit agreements are Single Level Facility, Credit Agreement with Multiple Facilities, Club Loans with Agency and Syndicated Loans.","endpointCount":23,"endpoints":[{"method":"POST","path":"/holdings/creditAgreements/deals/offers","fullPath":"/api/v2.3.0/holdings/creditAgreements/deals/offers","operationId":"createDealOffer","name":"Creates new offer Deal for the required customer when the Mandatory input details are provided. Offer Deal creates a draft contract and allow the users to negotiate multiple times. Offer Deal is a draft contract and will not affect the Balance sheet of the bank.","summary":"Creates an offer for a deal contract","tags":[],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"customers":[{}],"productId":"string","currency":"string","effectiveDate":"2024-01-01","activity":"string","settlement":[{}],"facilityRules":[{}],"dacommitment":[{}],"limit":[{}]}},"responses":{"200":"createDealOfferResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"POST","path":"/holdings/creditAgreements/facilities/offers","fullPath":"/api/v2.3.0/holdings/creditAgreements/facilities/offers","operationId":"createFacilityOffer","name":"Creates a new offer Facility for the required customer when at least the Mandatory input is provided. Offer Facility creates a draft contract and allow the users to negotiate multiple times. Offer facility is a draft contract and will not affect the Balance sheet of the bank.","summary":"Creates an offer for a facility contract","tags":[],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"customers":[{}],"productId":"string","currency":"string","dealId":"string","effectiveDate":"2024-01-01","activity":"string","settlement":[{}],"facilityRules":[{}],"facommitment":[{}],"limit":[{}]}},"responses":{"200":"createFacilityOfferResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"POST","path":"/holdings/creditAgreements/deals/offers/cancellations","fullPath":"/api/v2.3.0/holdings/creditAgreements/deals/offers/cancellations","operationId":"deleteDealOffer","name":"Deletes a new offer for the required deal contract when at least the Mandatory input is provided. Deal offer is a draft contract, which allow the user to delete the contract online and deal offer contract will not affect the balance sheet of the bank.","summary":"Deletes an offer for a deal contract","tags":[],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"productId":"string","effectiveDate":"2024-01-01"}},"responses":{"200":"deleteDealOfferResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"POST","path":"/holdings/creditAgreements/facilities/offers/cancellations","fullPath":"/api/v2.3.0/holdings/creditAgreements/facilities/offers/cancellations","operationId":"deleteFacilityOffer","name":"Deletes a new offer for the required facility contract when at least the Mandatory input is provided. Facility offer is a draft contract, which allow the user to delete the contract online and facility offer contract will not affect the balance sheet of the bank.","summary":"Deletes an offer for a facility contract","tags":[],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"productId":"string","effectiveDate":"2024-01-01"}},"responses":{"200":"deleteFacilityOfferResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"POST","path":"/holdings/creditAgreements/deals/offers/acceptances","fullPath":"/api/v2.3.0/holdings/creditAgreements/deals/offers/acceptances","operationId":"acceptDealOffer","name":"On executing acceptance, the contract is changed from Offer to live Deal for the required customer when at least the Mandatory input is provided. Process will check all the required mandatory inputs and prompt an error message when mandatory details are not provided. Once the accept deal offer is processed further offer negotiation is not allowed.","summary":"Accept the deal offer and execute the contract to live","tags":[],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"productId":"string","effectiveDate":"2024-01-01","settlement":[{}],"facilityRules":[{}],"dacommitment":[{}],"limit":[{}]}},"responses":{"200":"acceptDealOfferResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"POST","path":"/holdings/creditAgreements/facilities/offers/acceptances","fullPath":"/api/v2.3.0/holdings/creditAgreements/facilities/offers/acceptances","operationId":"acceptFacilityOffer","name":"On executing acceptance, the contract is changed from Offer to live Facility for the required customer when at least the Mandatory input is provided. Process will check all the required mandatory inputs and prompt an error message when mandatory details are not provided. Once the accept deal offer is processed further offer negotiation is not allowed.","summary":"Accept the facility offer and the execute the contract to live","tags":[],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"productId":"string","effectiveDate":"2024-01-01","settlement":[{}],"facilityRules":[{}],"facommitment":[{}],"limit":[{}]}},"responses":{"200":"acceptFacilityOfferResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"POST","path":"/holdings/creditAgreements/drawdowns/offers","fullPath":"/api/v2.3.0/holdings/creditAgreements/drawdowns/offers","operationId":"createDrawdownOffer","name":"Creates a new drawdown offer for the required customer. ","summary":"Creates a new drawdown offer for the required customer. ","tags":[],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"customers":[{}],"productId":"string","currency":"string","facilityId":"string","offerDate":"2024-01-01","drawdownDate":"2024-01-01","activity":"string","dwcommitment":[{}],"settlement":[{}]}},"responses":{"200":"createDrawdownOfferResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"POST","path":"/holdings/creditAgreements/drawdowns/offers/negotiations","fullPath":"/api/v2.3.0/holdings/creditAgreements/drawdowns/offers/negotiations","operationId":"createOfferDrawdownRenegotiation","name":"Renegotiate the offer drawdown for the required customer.","summary":"Renegotiate the offer drawdown for the required customer.","tags":[],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"productId":"string","drawdownDate":"2024-01-01","settlement":[{}]}},"responses":{"200":"createOfferDrawdownRenegotiationResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"POST","path":"/holdings/creditAgreements/drawdowns/offers/cancellations","fullPath":"/api/v2.3.0/holdings/creditAgreements/drawdowns/offers/cancellations","operationId":"deleteDrawdownOffer","name":"Cancellation of offer drawdown for the required customer.","summary":"Cancellation of offer drawdown for the required customer.","tags":[],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"productId":"string","drawdownDate":"2024-01-01"}},"responses":{"200":"deleteDrawdownOfferResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"POST","path":"/holdings/creditAgreements/drawdowns/offers/acceptances","fullPath":"/api/v2.3.0/holdings/creditAgreements/drawdowns/offers/acceptances","operationId":"acceptOfferDrawdown","name":"Convert an offer drawdown to a live drawdown for the required customer.","summary":"Convert an offer drawdown to a live drawdown for the required customer.","tags":[],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"productId":"string","drawdownDate":"2024-01-01","dwcommitment":[{}],"settlement":[{}]}},"responses":{"200":"acceptOfferDrawdownResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"GET","path":"/holdings/creditAgreements/facilities/{facilityId}/drawingProducts","fullPath":"/api/v2.3.0/holdings/creditAgreements/facilities/{facilityId}/drawingProducts","operationId":"getFacilityDrawingProducts","name":"Retrieves the available drawing products under the facility ","summary":"Retrieves the available drawing products under the facility ","tags":[],"parameters":[{"name":"facilityId","in":"path","type":"string","required":true,"description":"Unique identifier (contract number) of the facility"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from t24 on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"FacilityDrawingProductsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/creditAgreements/facilities/{facilityId}/combinedSchedules","fullPath":"/api/v2.3.0/holdings/creditAgreements/facilities/{facilityId}/combinedSchedules","operationId":"getCombinedSchedules","name":"Retrieves the payment schedule of facility and its drawings","summary":"Retrieves the payment schedule of facility and its drawings","tags":[],"parameters":[{"name":"facilityId","in":"path","type":"string","required":true,"description":"Unique identifier (contract number) of the facility"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from t24 on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"CombinedSchedulesResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"POST","path":"/holdings/creditAgreements/facilities","fullPath":"/api/v2.3.0/holdings/creditAgreements/facilities","operationId":"createFacilities","name":"Creates corporate facilities","summary":"Creates corporate facilities","tags":[],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"customers":[{}],"productId":"string","currency":"string","effectiveDate":"2024-01-01","settlement":[{}],"facilityRules":[{}],"facommitment":[{}],"limit":[{}]}},"responses":{"200":"createFacilitiesResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"POST","path":"/holdings/creditAgreements/drawdowns","fullPath":"/api/v2.3.0/holdings/creditAgreements/drawdowns","operationId":"createDrawdowns","name":"Creates drawdowns under facility","summary":"Creates drawdowns under facility","tags":[],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"customers":[{}],"arrangmentId":"string","currency":"string","facilityId":"string","effectiveDate":"string","activity":"string","productId":"string","dwcommitment":[{}],"settlement":[{}]}},"responses":{"200":"createDrawdownsResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"GET","path":"/holdings/creditAgreements/facilities/{facilityId}/drawingRules","fullPath":"/api/v2.3.0/holdings/creditAgreements/facilities/{facilityId}/drawingRules","operationId":"getFacilityDrawingRules","name":"Retrieves the allowed Customers, Currencies and Products for a new drawing under the facility","summary":"Retrieves the allowed Customers, Currencies and Products for a new drawing under the facility","tags":[],"parameters":[{"name":"facilityId","in":"path","type":"string","required":true,"description":"Unique identifier (contract number) of the facility"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from t24 on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"FacilityDrawingRulesResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/creditAgreements/facilities/{facilityId}/drawings","fullPath":"/api/v2.3.0/holdings/creditAgreements/facilities/{facilityId}/drawings","operationId":"getDrawingsUnderFacility","name":"Retrieves the drawings under a Facility","summary":"Retrieves the drawings under a Facility","tags":[],"parameters":[{"name":"facilityId","in":"path","type":"string","required":true,"description":"Unique identifier (contract number) of the facility"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from t24 on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"DrawingsUnderFacilityResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/creditAgreements/facilities/drawings/{drawingId}/parentFacilities","fullPath":"/api/v2.3.0/holdings/creditAgreements/facilities/drawings/{drawingId}/parentFacilities","operationId":"getDrawingFacility","name":"Retrieves the parent facility for a drawing","summary":"Retrieves the parent facility for a drawing","tags":[],"parameters":[{"name":"drawingId","in":"path","type":"string","required":true,"description":"Identifier of drawings application under the Letter of Credit system that is used to effect the transfer of funds and the acceptance of documents under Letters of Credit and Documentary Collection tra"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from t24 on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"DrawingFacilityResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/creditAgreements/facilities/{facilityId}/commitmentSchedules","fullPath":"/api/v2.3.0/holdings/creditAgreements/facilities/{facilityId}/commitmentSchedules","operationId":"getFacilityCommitmentSchedule","name":"Retrieves the commitment schedule of a facility","summary":"Retrieves the commitment schedule of a facility","tags":[],"parameters":[{"name":"facilityId","in":"path","type":"string","required":true,"description":"Unique identifier (contract number) of the facility"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from t24 on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"FacilityCommitmentScheduleResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/creditAgreements/facilities/{facilityId}/parentDeals","fullPath":"/api/v2.3.0/holdings/creditAgreements/facilities/{facilityId}/parentDeals","operationId":"getFacilityDeal","name":"Retrieves the parent deal for a facility","summary":"Retrieves the parent deal for a facility","tags":[],"parameters":[{"name":"facilityId","in":"path","type":"string","required":true,"description":"Unique identifier (contract number) of the facility"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from t24 on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"FacilityDealResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/creditAgreements/facilities/{facilityId}/balances","fullPath":"/api/v2.3.0/holdings/creditAgreements/facilities/{facilityId}/balances","operationId":"getFacilityFinancialSummary","name":"Retrieves the financial summary for a facility arrangement","summary":"Retrieves the financial summary for a facility arrangement","tags":[],"parameters":[{"name":"facilityId","in":"path","type":"string","required":true,"description":"Unique identifier (contract number) of the facility"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from t24 on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"FacilityFinancialSummaryResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/creditAgreements/facilities/{facilityId}/consolidatedBalances","fullPath":"/api/v2.3.0/holdings/creditAgreements/facilities/{facilityId}/consolidatedBalances","operationId":"getFacilityConsolidatedBalances","name":"Retrieves the consolidated balances for a facility arrangement","summary":"Retrieves the consolidated balances for a facility arrangement","tags":[],"parameters":[{"name":"facilityId","in":"path","type":"string","required":true,"description":"Unique identifier (contract number) of the facility"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from t24 on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"FacilityConsolidatedBalancesResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"POST","path":"/holdings/creditAgreements/facilities/directDebits","fullPath":"/api/v2.3.0/holdings/creditAgreements/facilities/directDebits","operationId":"createFacilityDirectDebitLink","name":"Links a Direct Debit to an existing Facility","summary":"Links a DD to a Facility","tags":[],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"customers":[{}],"arrangement":"string","productId":"string","currency":"string","effectiveDate":"2024-01-01","settlement":[{}]}},"responses":{"200":"createFacilityDirectDebitLinkResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"POST","path":"/holdings/creditAgreements/facilities/drawings/directDebits","fullPath":"/api/v2.3.0/holdings/creditAgreements/facilities/drawings/directDebits","operationId":"createDrawingDirectDebitLink","name":"Link the Direct Debit to an existing drawing under a facility","summary":"Links a DD to a Drawing","tags":[],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"customers":[{}],"arrangement":"string","currency":"string","facilityId":"string","effectiveDate":"string","productId":"string","settlement":[{}]}},"responses":{"200":"createDrawingDirectDebitLinkResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}}]},{"key":"holdings-creditAgreements-api-service-v2.4.0","title":"Corporate Credit Agreements","version":"v2.4.0","description":"API for the creation and management of credit agreements for Corporate customers. The types of credit agreements are Single Level Facility, Credit Agreement with Multiple Facilities, Club Loans with Agency and Syndicated Loans.","endpointCount":25,"endpoints":[{"method":"POST","path":"/holdings/creditAgreements/deals/offers","fullPath":"/api/v2.4.0/holdings/creditAgreements/deals/offers","operationId":"createDealOffer","name":"Creates new offer deal for the required customer when the mandatory input details are provided. Offer Deal creates a draft contract and allow the users to negotiate multiple times. Offer Deal is a draft contract and will not affect the Balance sheet of the bank.","summary":"Creates an offer for a deal contract","tags":[],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"customers":[{}],"productId":"string","currency":"string","effectiveDate":"2024-01-01","activity":"string","settlement":[{}],"facilityRules":[{}],"dacommitment":[{}],"limit":[{}]}},"responses":{"200":"createDealOfferResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"POST","path":"/holdings/creditAgreements/facilities/offers","fullPath":"/api/v2.4.0/holdings/creditAgreements/facilities/offers","operationId":"createFacilityOffer","name":"Creates a new offer Facility for the required customer when at least the mandatory input is provided. Offer Facility creates a draft contract and allow the users to negotiate multiple times. Offer facility is a draft contract and will not affect the Balance sheet of the bank.","summary":"Creates an offer for a facility contract","tags":[],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"customers":[{}],"productId":"string","currency":"string","dealId":"string","effectiveDate":"2024-01-01","activity":"string","settlement":[{}],"facilityRules":[{}],"facommitment":[{}],"limit":[{}]}},"responses":{"200":"createFacilityOfferResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"POST","path":"/holdings/creditAgreements/deals/offers/cancellations","fullPath":"/api/v2.4.0/holdings/creditAgreements/deals/offers/cancellations","operationId":"deleteDealOffer","name":"Deletes a new offer for the required deal contract when at least the mandatory input is provided. Deal offer is a draft contract, which allow the user to delete the contract online and deal offer contract will not affect the balance sheet of the bank.","summary":"Deletes an offer for a deal contract","tags":[],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"productId":"string","effectiveDate":"2024-01-01"}},"responses":{"200":"deleteDealOfferResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"POST","path":"/holdings/creditAgreements/facilities/offers/cancellations","fullPath":"/api/v2.4.0/holdings/creditAgreements/facilities/offers/cancellations","operationId":"deleteFacilityOffer","name":"Deletes a new offer for the required facility contract when at least the mandatory input is provided. Facility offer is a draft contract, which allow the user to delete the contract online and facility offer contract will not affect the balance sheet of the bank.","summary":"Deletes an offer for a facility contract","tags":[],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"productId":"string","effectiveDate":"2024-01-01"}},"responses":{"200":"deleteFacilityOfferResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"POST","path":"/holdings/creditAgreements/deals/offers/acceptances","fullPath":"/api/v2.4.0/holdings/creditAgreements/deals/offers/acceptances","operationId":"acceptDealOffer","name":"On executing acceptance, the contract is changed from Offer to live deal for the required customer when at least the mandatory input is provided. Process will check all the required mandatory inputs and prompt an error message when mandatory details are not provided. Once the accept deal offer is processed further offer negotiation is not allowed.","summary":"Accept the deal offer and execute the contract to live","tags":[],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"productId":"string","effectiveDate":"2024-01-01","settlement":[{}],"facilityRules":[{}],"dacommitment":[{}],"limit":[{}]}},"responses":{"200":"acceptDealOfferResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"POST","path":"/holdings/creditAgreements/facilities/offers/acceptances","fullPath":"/api/v2.4.0/holdings/creditAgreements/facilities/offers/acceptances","operationId":"acceptFacilityOffer","name":"On executing acceptance, the contract is changed from Offer to live Facility for the required customer when at least the mandatory input is provided. Process will check all the required mandatory inputs and prompt an error message when mandatory details are not provided. Once the accept deal offer is processed further offer negotiation is not allowed.","summary":"Accept the facility offer and the execute the contract to live","tags":[],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"productId":"string","effectiveDate":"2024-01-01","settlement":[{}],"facilityRules":[{}],"facommitment":[{}],"limit":[{}]}},"responses":{"200":"acceptFacilityOfferResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"POST","path":"/holdings/creditAgreements/drawdowns/offers","fullPath":"/api/v2.4.0/holdings/creditAgreements/drawdowns/offers","operationId":"createDrawdownOffer","name":"Creates a new drawdown offer for the required customer. ","summary":"Creates a new drawdown offer for the required customer. ","tags":[],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"customers":[{}],"productId":"string","currency":"string","facilityId":"string","offerDate":"2024-01-01","drawdownDate":"2024-01-01","activity":"string","dwcommitment":[{}],"settlement":[{}]}},"responses":{"200":"createDrawdownOfferResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"POST","path":"/holdings/creditAgreements/drawdowns/offers/negotiations","fullPath":"/api/v2.4.0/holdings/creditAgreements/drawdowns/offers/negotiations","operationId":"createOfferDrawdownRenegotiation","name":"Renegotiate the offer drawdown for the required customer.","summary":"Renegotiate the offer drawdown for the required customer.","tags":[],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"productId":"string","drawdownDate":"2024-01-01","settlement":[{}]}},"responses":{"200":"createOfferDrawdownRenegotiationResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"POST","path":"/holdings/creditAgreements/drawdowns/offers/cancellations","fullPath":"/api/v2.4.0/holdings/creditAgreements/drawdowns/offers/cancellations","operationId":"deleteDrawdownOffer","name":"Cancellation of offer drawdown for the required customer.","summary":"Cancellation of offer drawdown for the required customer.","tags":[],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"productId":"string","drawdownDate":"2024-01-01"}},"responses":{"200":"deleteDrawdownOfferResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"POST","path":"/holdings/creditAgreements/drawdowns/offers/acceptances","fullPath":"/api/v2.4.0/holdings/creditAgreements/drawdowns/offers/acceptances","operationId":"acceptOfferDrawdown","name":"Convert an offer drawdown to a live drawdown for the required customer.","summary":"Convert an offer drawdown to a live drawdown for the required customer.","tags":[],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"productId":"string","drawdownDate":"2024-01-01","dwcommitment":[{}],"settlement":[{}]}},"responses":{"200":"acceptOfferDrawdownResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"GET","path":"/holdings/creditAgreements/facilities/{facilityId}/drawingProducts","fullPath":"/api/v2.4.0/holdings/creditAgreements/facilities/{facilityId}/drawingProducts","operationId":"getFacilityDrawingProducts","name":"Retrieves the available drawing products under the facility ","summary":"Retrieves the available drawing products under the facility ","tags":[],"parameters":[{"name":"facilityId","in":"path","type":"string","required":true,"description":"Unique identifier (contract number) of the facility"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"FacilityDrawingProductsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/creditAgreements/facilities/{facilityId}/combinedSchedules","fullPath":"/api/v2.4.0/holdings/creditAgreements/facilities/{facilityId}/combinedSchedules","operationId":"getCombinedSchedules","name":"Retrieves the payment schedule of facility and its drawings","summary":"Retrieves the payment schedule of facility and its drawings","tags":[],"parameters":[{"name":"facilityId","in":"path","type":"string","required":true,"description":"Unique identifier (contract number) of the facility"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"CombinedSchedulesResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"POST","path":"/holdings/creditAgreements/facilities","fullPath":"/api/v2.4.0/holdings/creditAgreements/facilities","operationId":"createFacilities","name":"Creates corporate facilities","summary":"Creates corporate facilities","tags":[],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"customers":[{}],"productId":"string","currency":"string","effectiveDate":"2024-01-01","settlement":[{}],"facilityRules":[{}],"facommitment":[{}],"limit":[{}]}},"responses":{"200":"createFacilitiesResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"POST","path":"/holdings/creditAgreements/drawdowns","fullPath":"/api/v2.4.0/holdings/creditAgreements/drawdowns","operationId":"createDrawdowns","name":"Creates drawdowns under facility","summary":"Creates drawdowns under facility","tags":[],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"customers":[{}],"arrangmentId":"string","currency":"string","facilityId":"string","effectiveDate":"string","activity":"string","productId":"string","dwcommitment":[{}],"settlement":[{}]}},"responses":{"200":"createDrawdownsResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"GET","path":"/holdings/creditAgreements/facilities/{facilityId}/drawingRules","fullPath":"/api/v2.4.0/holdings/creditAgreements/facilities/{facilityId}/drawingRules","operationId":"getFacilityDrawingRules","name":"Retrieves the allowed customers, currencies and products for a new drawing under the facility","summary":"Retrieves the allowed customers, currencies and products for a new drawing under the facility","tags":[],"parameters":[{"name":"facilityId","in":"path","type":"string","required":true,"description":""},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"FacilityDrawingRulesResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/creditAgreements/facilities/{facilityId}/drawings","fullPath":"/api/v2.4.0/holdings/creditAgreements/facilities/{facilityId}/drawings","operationId":"getDrawingsUnderFacility","name":"Retrieves the drawings under a Facility","summary":"Retrieves the drawings under a Facility","tags":[],"parameters":[{"name":"facilityId","in":"path","type":"string","required":true,"description":""},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"DrawingsUnderFacilityResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/creditAgreements/facilities/drawings/{drawingId}/parentFacilities","fullPath":"/api/v2.4.0/holdings/creditAgreements/facilities/drawings/{drawingId}/parentFacilities","operationId":"getDrawingFacility","name":"Retrieves the parent facility for a drawing","summary":"Retrieves the parent facility for a drawing","tags":[],"parameters":[{"name":"drawingId","in":"path","type":"string","required":true,"description":""},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"DrawingFacilityResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/creditAgreements/facilities/{facilityId}/commitmentSchedules","fullPath":"/api/v2.4.0/holdings/creditAgreements/facilities/{facilityId}/commitmentSchedules","operationId":"getFacilityCommitmentSchedule","name":"Retrieves the commitment schedule of a facility","summary":"Retrieves the commitment schedule of a facility","tags":[],"parameters":[{"name":"facilityId","in":"path","type":"string","required":true,"description":""},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"FacilityCommitmentScheduleResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/creditAgreements/facilities/{facilityId}/parentDeals","fullPath":"/api/v2.4.0/holdings/creditAgreements/facilities/{facilityId}/parentDeals","operationId":"getFacilityDeal","name":"Retrieves the parent deal for a facility","summary":"Retrieves the parent deal for a facility","tags":[],"parameters":[{"name":"facilityId","in":"path","type":"string","required":true,"description":""},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"FacilityDealResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/creditAgreements/facilities/{facilityId}/balances","fullPath":"/api/v2.4.0/holdings/creditAgreements/facilities/{facilityId}/balances","operationId":"getFacilityFinancialSummary","name":"Retrieves the financial summary for a facility arrangement","summary":"Retrieves the financial summary for a facility arrangement","tags":[],"parameters":[{"name":"facilityId","in":"path","type":"string","required":true,"description":""},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"FacilityFinancialSummaryResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/creditAgreements/facilities/{facilityId}/consolidatedBalances","fullPath":"/api/v2.4.0/holdings/creditAgreements/facilities/{facilityId}/consolidatedBalances","operationId":"getFacilityConsolidatedBalances","name":"Retrieves the consolidated balances for a facility arrangement","summary":"Retrieves the consolidated balances for a facility arrangement","tags":[],"parameters":[{"name":"facilityId","in":"path","type":"string","required":true,"description":""},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"FacilityConsolidatedBalancesResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"POST","path":"/holdings/creditAgreements/facilities/directDebits","fullPath":"/api/v2.4.0/holdings/creditAgreements/facilities/directDebits","operationId":"createFacilityDirectDebitLink","name":"Links a Direct Debit to an existing Facility","summary":"Links a DD to a Facility","tags":[],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"parties":[{}],"activityId":"string","effectiveDate":"string","productId":"string","currencyId":"string","simulationId":"string"}},"responses":{"200":"createFacilityDirectDebitLinkResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"POST","path":"/holdings/creditAgreements/facilities/drawings/directDebits","fullPath":"/api/v2.4.0/holdings/creditAgreements/facilities/drawings/directDebits","operationId":"createDrawingDirectDebitLink","name":"Link the Direct Debit to an existing drawing under a facility","summary":"Links a DD to a Drawing","tags":[],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"parties":[{}],"activityId":"string","effectiveDate":"string","productId":"string","currencyId":"string","simulationId":"string"}},"responses":{"200":"createDrawingDirectDebitLinkResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"POST","path":"/holdings/creditAgreements/facilities/rollovers/offers","fullPath":"/api/v2.4.0/holdings/creditAgreements/facilities/rollovers/offers","operationId":"createFacilityRolloverOffer","name":"Create rollover process from the facility where the rollover could be a Split rollover, Merge rollover or a one to one rollover. Split also called as one to many will rollover an old loan and create multiple new offer loans. Merge also called as many to one will rollover multiple old loans simultaneously and create a single new offer loan. Rollover also called as one to one will simply rollover an old loan and create a new offer loan","summary":"Create rollover offer from facility","tags":[],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"arrangement":"string","rolloverDate":"string","splitsMerges":[{}]}},"responses":{"200":"createFacilityRolloverOfferResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"POST","path":"/holdings/creditAgreements/drawdowns/rollovers/offers","fullPath":"/api/v2.4.0/holdings/creditAgreements/drawdowns/rollovers/offers","operationId":"createDrawdownRolloverOffer","name":"Create rollover process from the drawdown where the rollover could be a Split rollover, Merge rollover or a one to one rollover. Split also called as one to many will rollover an old loan and create multiple new offer loans. Merge also called as many to one will rollover multiple old loans simultaneously and create a single new offer loan. Rollover also called as one to one will simply rollover an old loan and create a new offer loan","summary":"Create rollover offer from drawdown","tags":[],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"arrangement":"string","rolloverDate":"string","splitsMerges":[{}]}},"responses":{"200":"createDrawdownRolloverOfferResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}}]},{"key":"holdings-creditAgreements-api-service-v3.0.0","title":"Corporate Credit Agreements","version":"v3.0.0","description":"API for the creation and management of credit agreements for Corporate customers. The types of credit agreements are Single Level Facility, Credit Agreement with Multiple Facilities, Club Loans with Agency and Syndicated Loans.","endpointCount":25,"endpoints":[{"method":"POST","path":"/holdings/creditAgreements/deals/offers","fullPath":"/api/v3.0.0/holdings/creditAgreements/deals/offers","operationId":"createDealOffer","name":"Creates new offer Deal for the required customer when the mandatory input details are provided. Offer Deal creates a draft contract and allows the users to negotiate multiple times. Offer Deal is a draft contract and will not affect the Balance sheet of the bank.","summary":"Creates an offer for a deal contract","tags":[],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"customers":[{}],"productId":"string","currency":"string","effectiveDate":"2024-01-01","activity":"string","settlement":[{}],"facilityRules":[{}],"dacommitment":[{}],"adminfee":[{}],"upfrontfee":[{}],"limit":[{}]}},"responses":{"200":"createDealOfferResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"POST","path":"/holdings/creditAgreements/facilities/offers","fullPath":"/api/v3.0.0/holdings/creditAgreements/facilities/offers","operationId":"createFacilityOffer","name":"Creates a new offer Facility for the required customer when at least the mandatory input is provided. Offer Facility creates a draft contract and allow the users to negotiate multiple times. Offer facility is a draft contract and will not affect the Balance sheet of the bank.","summary":"Creates an offer for a facility contract","tags":[],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"customers":[{}],"productId":"string","currency":"string","dealId":"string","effectiveDate":"2024-01-01","activity":"string","settlement":[{}],"drawingRules":[{}],"facommitment":[{}],"upfrontfee":[{}],"coordinationfee":[{}],"limit":[{}]}},"responses":{"200":"createFacilityOfferResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"POST","path":"/holdings/creditAgreements/deals/offers/cancellations","fullPath":"/api/v3.0.0/holdings/creditAgreements/deals/offers/cancellations","operationId":"deleteDealOffer","name":"Deletes a new offer for the required deal contract when at least the mandatory input is provided. Deal offer is a draft contract, which allow the user to delete the contract online and deal offer contract will not affect the balance sheet of the bank.","summary":"Deletes an offer for a deal contract","tags":[],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"productId":"string","effectiveDate":"2024-01-01"}},"responses":{"200":"deleteDealOfferResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"POST","path":"/holdings/creditAgreements/facilities/offers/cancellations","fullPath":"/api/v3.0.0/holdings/creditAgreements/facilities/offers/cancellations","operationId":"deleteFacilityOffer","name":"Deletes a new offer for the required facility contract when at least the mandatory input is provided. Facility offer is a draft contract, which allow the user to delete the contract online and facility offer contract will not affect the balance sheet of the bank.","summary":"Deletes an offer for a facility contract","tags":[],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"productId":"string","effectiveDate":"2024-01-01"}},"responses":{"200":"deleteFacilityOfferResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"POST","path":"/holdings/creditAgreements/deals/offers/acceptances","fullPath":"/api/v3.0.0/holdings/creditAgreements/deals/offers/acceptances","operationId":"acceptDealOffer","name":"On executing acceptance, the contract is changed from Offer to live deal for the required customer when at least the mandatory input is provided. Process will check all the required mandatory inputs and prompt an error message when mandatory details are not provided. Once the accept deal offer is processed further offer negotiation is not allowed.","summary":"Accept the deal offer and execute the contract to live","tags":[],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"productId":"string","effectiveDate":"2024-01-01","settlement":[{}],"facilityRules":[{}],"dacommitment":[{}],"adminfee":[{}],"upfrontfee":[{}],"limit":[{}]}},"responses":{"200":"acceptDealOfferResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"POST","path":"/holdings/creditAgreements/facilities/offers/acceptances","fullPath":"/api/v3.0.0/holdings/creditAgreements/facilities/offers/acceptances","operationId":"acceptFacilityOffer","name":"On executing acceptance, the contract is changed from Offer to live Facility for the required customer when at least the mandatory input is provided. Process will check all the required mandatory inputs and prompt an error message when mandatory details are not provided. Once the accept deal offer is processed further offer negotiation is not allowed.","summary":"Accept the facility offer and execute the contract to live","tags":[],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"productId":"string","effectiveDate":"2024-01-01","settlement":[{}],"drawingRules":[{}],"facommitment":[{}],"upfrontfee":[{}],"coordinationfee":[{}],"limit":[{}]}},"responses":{"200":"acceptFacilityOfferResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"POST","path":"/holdings/creditAgreements/drawdowns/offers","fullPath":"/api/v3.0.0/holdings/creditAgreements/drawdowns/offers","operationId":"createDrawdownOffer","name":"Creates a new drawdown offer for the required customer. ","summary":"Creates a new drawdown offer for the required customer. ","tags":[],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"customers":[{}],"productId":"string","currency":"string","facilityId":"string","offerDate":"2024-01-01","drawdownDate":"2024-01-01","activity":"string","maintenancefee":[{}],"dwcommitment":[{}],"settlement":[{}]}},"responses":{"200":"createDrawdownOfferResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"POST","path":"/holdings/creditAgreements/drawdowns/offers/negotiations","fullPath":"/api/v3.0.0/holdings/creditAgreements/drawdowns/offers/negotiations","operationId":"createOfferDrawdownRenegotiation","name":"Renegotiate the offer drawdown for the required customer.","summary":"Renegotiate the offer drawdown for the required customer.","tags":[],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"productId":"string","drawdownDate":"2024-01-01","maintenancefee":[{}],"settlement":[{}]}},"responses":{"200":"createOfferDrawdownRenegotiationResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"POST","path":"/holdings/creditAgreements/drawdowns/offers/cancellations","fullPath":"/api/v3.0.0/holdings/creditAgreements/drawdowns/offers/cancellations","operationId":"deleteDrawdownOffer","name":"Cancellation of offer drawdown for the required customer.","summary":"Cancellation of offer drawdown for the required customer.","tags":[],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"productId":"string","drawdownDate":"2024-01-01"}},"responses":{"200":"deleteDrawdownOfferResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"POST","path":"/holdings/creditAgreements/drawdowns/offers/acceptances","fullPath":"/api/v3.0.0/holdings/creditAgreements/drawdowns/offers/acceptances","operationId":"acceptOfferDrawdown","name":"Convert an offer drawdown to a live drawdown for the required customer.","summary":"Convert an offer drawdown to a live drawdown for the required customer.","tags":[],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"productId":"string","drawdownDate":"2024-01-01","maintenancefee":[{}],"dwcommitment":[{}],"settlement":[{}]}},"responses":{"200":"acceptOfferDrawdownResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"GET","path":"/holdings/creditAgreements/facilities/{facilityId}/drawingProducts","fullPath":"/api/v3.0.0/holdings/creditAgreements/facilities/{facilityId}/drawingProducts","operationId":"getFacilityDrawingProducts","name":"Retrieves the available drawing products under the facility ","summary":"Retrieves the available drawing products under the facility ","tags":[],"parameters":[{"name":"facilityId","in":"path","type":"string","required":true,"description":"Unique identifier (contract number) of the facility"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"FacilityDrawingProductsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/creditAgreements/facilities/{facilityId}/combinedSchedules","fullPath":"/api/v3.0.0/holdings/creditAgreements/facilities/{facilityId}/combinedSchedules","operationId":"getCombinedSchedules","name":"Retrieves the payment schedule of facility and its drawings","summary":"Retrieves the payment schedule of facility and its drawings","tags":[],"parameters":[{"name":"facilityId","in":"path","type":"string","required":true,"description":"Unique identifier (contract number) of the facility"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"CombinedSchedulesResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"POST","path":"/holdings/creditAgreements/facilities","fullPath":"/api/v3.0.0/holdings/creditAgreements/facilities","operationId":"createFacilities","name":"Creates corporate facilities","summary":"Creates corporate facilities","tags":[],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"customers":[{}],"productId":"string","currency":"string","effectiveDate":"2024-01-01","settlement":[{}],"drawingRules":[{}],"facommitment":[{}],"upfrontfee":[{}],"coordinationfee":[{}],"limit":[{}]}},"responses":{"200":"createFacilitiesResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"POST","path":"/holdings/creditAgreements/drawdowns","fullPath":"/api/v3.0.0/holdings/creditAgreements/drawdowns","operationId":"createDrawdowns","name":"Creates drawdowns under facility","summary":"Creates drawdowns under facility","tags":[],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"customers":[{}],"arrangmentId":"string","currency":"string","facilityId":"string","effectiveDate":"string","activity":"string","productId":"string","escrow":[{}],"dwcommitment":[{}],"settlement":[{}]}},"responses":{"200":"createDrawdownsResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"GET","path":"/holdings/creditAgreements/facilities/{facilityId}/drawingRules","fullPath":"/api/v3.0.0/holdings/creditAgreements/facilities/{facilityId}/drawingRules","operationId":"getFacilityDrawingRules","name":"Retrieves the allowed customers, currencies and products for a new drawing under the facility","summary":"Retrieves the allowed customers, currencies and products for a new drawing under the facility","tags":[],"parameters":[{"name":"facilityId","in":"path","type":"string","required":true,"description":""},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"FacilityDrawingRulesResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/creditAgreements/facilities/{facilityId}/drawings","fullPath":"/api/v3.0.0/holdings/creditAgreements/facilities/{facilityId}/drawings","operationId":"getDrawingsUnderFacility","name":"Retrieves the drawings under a facility","summary":"Retrieves the drawings under a facility","tags":[],"parameters":[{"name":"facilityId","in":"path","type":"string","required":true,"description":""},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"DrawingsUnderFacilityResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/creditAgreements/facilities/drawings/{drawingId}/parentFacilities","fullPath":"/api/v3.0.0/holdings/creditAgreements/facilities/drawings/{drawingId}/parentFacilities","operationId":"getDrawingFacility","name":"Retrieves the parent facility for a drawing","summary":"Retrieves the parent facility for a drawing","tags":[],"parameters":[{"name":"drawingId","in":"path","type":"string","required":true,"description":""},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"DrawingFacilityResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/creditAgreements/facilities/{facilityId}/commitmentSchedules","fullPath":"/api/v3.0.0/holdings/creditAgreements/facilities/{facilityId}/commitmentSchedules","operationId":"getFacilityCommitmentSchedule","name":"Retrieves the commitment schedule of a facility","summary":"Retrieves the commitment schedule of a facility","tags":[],"parameters":[{"name":"facilityId","in":"path","type":"string","required":true,"description":""},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"FacilityCommitmentScheduleResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/creditAgreements/facilities/{facilityId}/parentDeals","fullPath":"/api/v3.0.0/holdings/creditAgreements/facilities/{facilityId}/parentDeals","operationId":"getFacilityDeal","name":"Retrieves the parent deal for a facility","summary":"Retrieves the parent deal for a facility","tags":[],"parameters":[{"name":"facilityId","in":"path","type":"string","required":true,"description":""},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"FacilityDealResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/creditAgreements/facilities/{facilityId}/balances","fullPath":"/api/v3.0.0/holdings/creditAgreements/facilities/{facilityId}/balances","operationId":"getFacilityFinancialSummary","name":"Retrieves the financial summary for a facility arrangement","summary":"Retrieves the financial summary for a facility arrangement","tags":[],"parameters":[{"name":"facilityId","in":"path","type":"string","required":true,"description":""},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"FacilityFinancialSummaryResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/creditAgreements/facilities/{facilityId}/consolidatedBalances","fullPath":"/api/v3.0.0/holdings/creditAgreements/facilities/{facilityId}/consolidatedBalances","operationId":"getFacilityConsolidatedBalances","name":"Retrieves the consolidated balances for a facility arrangement","summary":"Retrieves the consolidated balances for a facility arrangement","tags":[],"parameters":[{"name":"facilityId","in":"path","type":"string","required":true,"description":""},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"FacilityConsolidatedBalancesResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"POST","path":"/holdings/creditAgreements/facilities/directDebits","fullPath":"/api/v3.0.0/holdings/creditAgreements/facilities/directDebits","operationId":"createFacilityDirectDebitLink","name":"Links a direct debit to an existing facility","summary":"Links a direct debit to a facility","tags":[],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"customers":[{}],"arrangement":"string","productId":"string","currency":"string","effectiveDate":"2024-01-01"}},"responses":{"200":"createFacilityDirectDebitLinkResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"POST","path":"/holdings/creditAgreements/facilities/drawings/directDebits","fullPath":"/api/v3.0.0/holdings/creditAgreements/facilities/drawings/directDebits","operationId":"createDrawingDirectDebitLink","name":"Link the direct debit to an existing drawing under a facility","summary":"Links a direct debit to a drawing","tags":[],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"customers":[{}],"arrangement":"string","currency":"string","facilityId":"string","effectiveDate":"string","productId":"string","settlement":[{}]}},"responses":{"200":"createDrawingDirectDebitLinkResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"POST","path":"/holdings/creditAgreements/facilities/rollovers/offers","fullPath":"/api/v3.0.0/holdings/creditAgreements/facilities/rollovers/offers","operationId":"createFacilityRolloverOffer","name":"Create rollover process from the facility where the rollover could be a Split rollover, Merge rollover or a one to one rollover. Split also called as one to many will rollover an old loan and create multiple new offer loans. Merge also called as many to one will rollover multiple old loans simultaneously and create a single new offer loan. Rollover also called as one to one will simply rollover an old loan and create a new offer loan","summary":"Create rollover offer from facility","tags":[],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"arrangement":"string","rolloverDate":"string","splitsMerges":[{}]}},"responses":{"200":"createFacilityRolloverOfferResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"POST","path":"/holdings/creditAgreements/drawdowns/rollovers/offers","fullPath":"/api/v3.0.0/holdings/creditAgreements/drawdowns/rollovers/offers","operationId":"createDrawdownRolloverOffer","name":"Create rollover process from the drawdown where the rollover could be a Split rollover, Merge rollover or a one to one rollover. Split also called as one to many will rollover an old loan and create multiple new offer loans. Merge also called as many to one will rollover multiple old loans simultaneously and create a single new offer loan. Rollover also called as one to one will simply rollover an old loan and create a new offer loan","summary":"Create rollover offer from drawdown","tags":[],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"arrangement":"string","rolloverDate":"string","splitsMerges":[{}]}},"responses":{"200":"createDrawdownRolloverOfferResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}}]},{"key":"holdings-creditAgreements-api-service-v3.1.0","title":"Corporate Credit Agreements","version":"v3.1.0","description":"API for the creation and management of credit agreements for Corporate customers. The types of credit agreements are Single Level Facility, Credit Agreement with Multiple Facilities, Club Loans with Agency and Syndicated Loans.","endpointCount":27,"endpoints":[{"method":"POST","path":"/holdings/creditAgreements/deals/offers","fullPath":"/api/v3.1.0/holdings/creditAgreements/deals/offers","operationId":"createDealOffer","name":"Creates new offer Deal for the required customer when the mandatory input details are provided. Offer Deal creates a draft contract and allows the users to negotiate multiple times. Offer Deal is a draft contract and will not affect the Balance sheet of the bank.","summary":"Creates an offer for a deal contract","tags":[],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"customers":[{}],"productId":"string","currency":"string","effectiveDate":"2024-01-01","activity":"string","settlement":[{}],"facilityRules":[{}],"dacommitment":[{}],"adminfee":[{}],"upfrontfee":[{}],"limit":[{}]}},"responses":{"200":"createDealOfferResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"POST","path":"/holdings/creditAgreements/facilities/offers","fullPath":"/api/v3.1.0/holdings/creditAgreements/facilities/offers","operationId":"createFacilityOffer","name":"Creates a new offer Facility for the required customer when at least the mandatory input is provided. Offer Facility creates a draft contract and allow the users to negotiate multiple times. Offer facility is a draft contract and will not affect the Balance sheet of the bank.","summary":"Creates an offer for a facility contract","tags":[],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"customers":[{}],"productId":"string","currency":"string","dealId":"string","effectiveDate":"2024-01-01","activity":"string","settlement":[{}],"facommitment":[{}],"upfrontfee":[{}],"coordinationfee":[{}],"limit":[{}]}},"responses":{"200":"createFacilityOfferResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"POST","path":"/holdings/creditAgreements/deals/offers/cancellations","fullPath":"/api/v3.1.0/holdings/creditAgreements/deals/offers/cancellations","operationId":"deleteDealOffer","name":"Deletes a new offer for the required deal contract when at least the mandatory input is provided. Deal offer is a draft contract, which allow the user to delete the contract online and deal offer contract will not affect the balance sheet of the bank.","summary":"Deletes an offer for a deal contract","tags":[],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"productId":"string","effectiveDate":"2024-01-01"}},"responses":{"200":"deleteDealOfferResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"POST","path":"/holdings/creditAgreements/facilities/offers/cancellations","fullPath":"/api/v3.1.0/holdings/creditAgreements/facilities/offers/cancellations","operationId":"deleteFacilityOffer","name":"Deletes a new offer for the required facility contract when at least the mandatory input is provided. Facility offer is a draft contract, which allow the user to delete the contract online and facility offer contract will not affect the balance sheet of the bank.","summary":"Deletes an offer for a facility contract","tags":[],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"productId":"string","effectiveDate":"2024-01-01"}},"responses":{"200":"deleteFacilityOfferResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"POST","path":"/holdings/creditAgreements/deals/offers/acceptances","fullPath":"/api/v3.1.0/holdings/creditAgreements/deals/offers/acceptances","operationId":"acceptDealOffer","name":"On executing acceptance, the contract is changed from Offer to live deal for the required customer when at least the mandatory input is provided. Process will check all the required mandatory inputs and prompt an error message when mandatory details are not provided. Once the accept deal offer is processed further offer negotiation is not allowed.","summary":"Accept the deal offer and execute the contract to live","tags":[],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"productId":"string","effectiveDate":"2024-01-01","settlement":[{}],"facilityRules":[{}],"dacommitment":[{}],"adminfee":[{}],"upfrontfee":[{}],"limit":[{}]}},"responses":{"200":"acceptDealOfferResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"POST","path":"/holdings/creditAgreements/facilities/offers/acceptances","fullPath":"/api/v3.1.0/holdings/creditAgreements/facilities/offers/acceptances","operationId":"acceptFacilityOffer","name":"On executing acceptance, the contract is changed from Offer to live Facility for the required customer when at least the mandatory input is provided. Process will check all the required mandatory inputs and prompt an error message when mandatory details are not provided. Once the accept deal offer is processed further offer negotiation is not allowed.","summary":"Accept the facility offer and execute the contract to live","tags":[],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"productId":"string","effectiveDate":"2024-01-01","settlement":[{}],"facommitment":[{}],"upfrontfee":[{}],"coordinationfee":[{}],"limit":[{}]}},"responses":{"200":"acceptFacilityOfferResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"POST","path":"/holdings/creditAgreements/drawdowns/offers","fullPath":"/api/v3.1.0/holdings/creditAgreements/drawdowns/offers","operationId":"createDrawdownOffer","name":"Creates a new drawdown offer for the required customer. ","summary":"Creates a new drawdown offer for the required customer. ","tags":[],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"customers":[{}],"productId":"string","currency":"string","facilityId":"string","offerDate":"2024-01-01","drawdownDate":"2024-01-01","activity":"string","maintenancefee":[{}],"dwcommitment":[{}],"settlement":[{}]}},"responses":{"200":"createDrawdownOfferResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"POST","path":"/holdings/creditAgreements/drawdowns/offers/negotiations","fullPath":"/api/v3.1.0/holdings/creditAgreements/drawdowns/offers/negotiations","operationId":"createOfferDrawdownRenegotiation","name":"Renegotiate the offer drawdown for the required customer.","summary":"Renegotiate the offer drawdown for the required customer.","tags":[],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"productId":"string","drawdownDate":"2024-01-01","maintenancefee":[{}],"settlement":[{}]}},"responses":{"200":"createOfferDrawdownRenegotiationResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"POST","path":"/holdings/creditAgreements/drawdowns/offers/cancellations","fullPath":"/api/v3.1.0/holdings/creditAgreements/drawdowns/offers/cancellations","operationId":"deleteDrawdownOffer","name":"Cancellation of offer drawdown for the required customer.","summary":"Cancellation of offer drawdown for the required customer.","tags":[],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"productId":"string","drawdownDate":"2024-01-01"}},"responses":{"200":"deleteDrawdownOfferResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"POST","path":"/holdings/creditAgreements/drawdowns/offers/acceptances","fullPath":"/api/v3.1.0/holdings/creditAgreements/drawdowns/offers/acceptances","operationId":"acceptOfferDrawdown","name":"Convert an offer drawdown to a live drawdown for the required customer.","summary":"Convert an offer drawdown to a live drawdown for the required customer.","tags":[],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"productId":"string","drawdownDate":"2024-01-01","maintenancefee":[{}],"dwcommitment":[{}],"settlement":[{}]}},"responses":{"200":"acceptOfferDrawdownResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"GET","path":"/holdings/creditAgreements/facilities/{facilityId}/drawingProducts","fullPath":"/api/v3.1.0/holdings/creditAgreements/facilities/{facilityId}/drawingProducts","operationId":"getFacilityDrawingProducts","name":"Retrieves the available drawing products under the facility ","summary":"Retrieves the available drawing products under the facility ","tags":[],"parameters":[{"name":"facilityId","in":"path","type":"string","required":true,"description":"Unique identifier (contract number) of the facility"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"FacilityDrawingProductsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/creditAgreements/facilities/{facilityId}/combinedSchedules","fullPath":"/api/v3.1.0/holdings/creditAgreements/facilities/{facilityId}/combinedSchedules","operationId":"getCombinedSchedules","name":"Retrieves the payment schedule of facility and its drawings","summary":"Retrieves the payment schedule of facility and its drawings","tags":[],"parameters":[{"name":"facilityId","in":"path","type":"string","required":true,"description":"Unique identifier (contract number) of the facility"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"CombinedSchedulesResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"POST","path":"/holdings/creditAgreements/facilities","fullPath":"/api/v3.1.0/holdings/creditAgreements/facilities","operationId":"createFacilities","name":"Creates corporate facilities","summary":"Creates corporate facilities","tags":[],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"customers":[{}],"productId":"string","currency":"string","effectiveDate":"2024-01-01","settlement":[{}],"facommitment":[{}],"upfrontfee":[{}],"coordinationfee":[{}],"limit":[{}]}},"responses":{"200":"createFacilitiesResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"POST","path":"/holdings/creditAgreements/drawdowns","fullPath":"/api/v3.1.0/holdings/creditAgreements/drawdowns","operationId":"createDrawdowns","name":"Creates drawdowns under facility","summary":"Creates drawdowns under facility","tags":[],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"customers":[{}],"arrangmentId":"string","currency":"string","facilityId":"string","effectiveDate":"string","activity":"string","productId":"string","escrow":[{}],"dwcommitment":[{}],"settlement":[{}]}},"responses":{"200":"createDrawdownsResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"GET","path":"/holdings/creditAgreements/facilities/{facilityId}/drawingRules","fullPath":"/api/v3.1.0/holdings/creditAgreements/facilities/{facilityId}/drawingRules","operationId":"getFacilityDrawingRules","name":"Retrieves the allowed customers, currencies and products for a new drawing under the facility","summary":"Retrieves the allowed customers, currencies and products for a new drawing under the facility","tags":[],"parameters":[{"name":"facilityId","in":"path","type":"string","required":true,"description":""},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"FacilityDrawingRulesResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/creditAgreements/facilities/{facilityId}/drawings","fullPath":"/api/v3.1.0/holdings/creditAgreements/facilities/{facilityId}/drawings","operationId":"getDrawingsUnderFacility","name":"Retrieves the drawings under a facility","summary":"Retrieves the drawings under a facility","tags":[],"parameters":[{"name":"facilityId","in":"path","type":"string","required":true,"description":""},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"DrawingsUnderFacilityResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/creditAgreements/facilities/drawings/{drawingId}/parentFacilities","fullPath":"/api/v3.1.0/holdings/creditAgreements/facilities/drawings/{drawingId}/parentFacilities","operationId":"getDrawingFacility","name":"Retrieves the parent facility for a drawing","summary":"Retrieves the parent facility for a drawing","tags":[],"parameters":[{"name":"drawingId","in":"path","type":"string","required":true,"description":""},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"DrawingFacilityResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/creditAgreements/facilities/{facilityId}/commitmentSchedules","fullPath":"/api/v3.1.0/holdings/creditAgreements/facilities/{facilityId}/commitmentSchedules","operationId":"getFacilityCommitmentSchedule","name":"Retrieves the commitment schedule of a facility","summary":"Retrieves the commitment schedule of a facility","tags":[],"parameters":[{"name":"facilityId","in":"path","type":"string","required":true,"description":""},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"FacilityCommitmentScheduleResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/creditAgreements/facilities/{facilityId}/parentDeals","fullPath":"/api/v3.1.0/holdings/creditAgreements/facilities/{facilityId}/parentDeals","operationId":"getFacilityDeal","name":"Retrieves the parent deal for a facility","summary":"Retrieves the parent deal for a facility","tags":[],"parameters":[{"name":"facilityId","in":"path","type":"string","required":true,"description":""},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"FacilityDealResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/creditAgreements/facilities/{facilityId}/balances","fullPath":"/api/v3.1.0/holdings/creditAgreements/facilities/{facilityId}/balances","operationId":"getFacilityFinancialSummary","name":"Retrieves the financial summary for a facility arrangement","summary":"Retrieves the financial summary for a facility arrangement","tags":[],"parameters":[{"name":"facilityId","in":"path","type":"string","required":true,"description":""},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"FacilityFinancialSummaryResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/creditAgreements/facilities/{facilityId}/consolidatedBalances","fullPath":"/api/v3.1.0/holdings/creditAgreements/facilities/{facilityId}/consolidatedBalances","operationId":"getFacilityConsolidatedBalances","name":"Retrieves the consolidated balances for a facility arrangement","summary":"Retrieves the consolidated balances for a facility arrangement","tags":[],"parameters":[{"name":"facilityId","in":"path","type":"string","required":true,"description":""},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"FacilityConsolidatedBalancesResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"POST","path":"/holdings/creditAgreements/facilities/directDebits","fullPath":"/api/v3.1.0/holdings/creditAgreements/facilities/directDebits","operationId":"createFacilityDirectDebitLink","name":"Links a direct debit to an existing facility","summary":"Links a direct debit to a facility","tags":[],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"customers":[{}],"arrangement":"string","productId":"string","currency":"string","effectiveDate":"2024-01-01"}},"responses":{"200":"createFacilityDirectDebitLinkResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"POST","path":"/holdings/creditAgreements/facilities/drawings/directDebits","fullPath":"/api/v3.1.0/holdings/creditAgreements/facilities/drawings/directDebits","operationId":"createDrawingDirectDebitLink","name":"Link the direct debit to an existing drawing under a facility","summary":"Links a direct debit to a drawing","tags":[],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"customers":[{}],"arrangement":"string","currency":"string","facilityId":"string","effectiveDate":"string","productId":"string","settlement":[{}]}},"responses":{"200":"createDrawingDirectDebitLinkResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"POST","path":"/holdings/creditAgreements/facilities/rollovers/offers","fullPath":"/api/v3.1.0/holdings/creditAgreements/facilities/rollovers/offers","operationId":"createFacilityRolloverOffer","name":"Create rollover process from the facility where the rollover could be a Split rollover, Merge rollover or a one to one rollover. Split also called as one to many will rollover an old loan and create multiple new offer loans. Merge also called as many to one will rollover multiple old loans simultaneously and create a single new offer loan. Rollover also called as one to one will simply rollover an old loan and create a new offer loan","summary":"Create rollover offer from facility","tags":[],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"arrangement":"string","rolloverDate":"string","splitsMerges":[{}]}},"responses":{"200":"createFacilityRolloverOfferResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"POST","path":"/holdings/creditAgreements/drawdowns/rollovers/offers","fullPath":"/api/v3.1.0/holdings/creditAgreements/drawdowns/rollovers/offers","operationId":"createDrawdownRolloverOffer","name":"Create rollover process from the drawdown where the rollover could be a Split rollover, Merge rollover or a one to one rollover. Split also called as one to many will rollover an old loan and create multiple new offer loans. Merge also called as many to one will rollover multiple old loans simultaneously and create a single new offer loan. Rollover also called as one to one will simply rollover an old loan and create a new offer loan","summary":"Create rollover offer from drawdown","tags":[],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"arrangement":"string","rolloverDate":"string","splitsMerges":[{}]}},"responses":{"200":"createDrawdownRolloverOfferResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"POST","path":"/holdings/creditAgreements/facilities/commitmentIncreases/{arrangementId}","fullPath":"/api/v3.1.0/holdings/creditAgreements/facilities/commitmentIncreases/{arrangementId}","operationId":"updateFacilityCommitmentIncrease","name":"Increase the facility amount to facilitate further drawdowns","summary":"Increase facility amount","tags":[],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"arrangementId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"productId":"string","effectiveDate":"2024-01-01","facommitment":[{}]}},"responses":{"200":"updateFacilityCommitmentIncreaseResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"POST","path":"/holdings/creditAgreements/facilities/commitmentTerms/{arrangementId}","fullPath":"/api/v3.1.0/holdings/creditAgreements/facilities/commitmentTerms/{arrangementId}","operationId":"updateFacilityCommitmentTerms","name":"Updates facility tenure by increasing or decreasing the term, in addition it allows the amendment of the availability schedule of the contract.","summary":"Update facility maturity date and availability","tags":[],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"arrangementId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"productId":"string","effectiveDate":"2024-01-01","facommitment":[{}]}},"responses":{"200":"updateFacilityCommitmentTermsResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}}]},{"key":"holdings-creditAgreements-api-service-v3.2.0","title":"Corporate Credit Agreements","version":"v3.2.0","description":"API for the creation and management of credit agreements for Corporate customers. The types of credit agreements are Single Level Facility, Credit Agreement with Multiple Facilities, Club Loans with Agency and Syndicated Loans.","endpointCount":28,"endpoints":[{"method":"POST","path":"/holdings/creditAgreements/deals/offers","fullPath":"/api/v3.2.0/holdings/creditAgreements/deals/offers","operationId":"createDealOffer","name":"Creates new offer Deal for the required customer when the mandatory input details are provided. Offer Deal creates a draft contract and allows the users to negotiate multiple times. Offer Deal is a draft contract and will not affect the Balance sheet of the bank.","summary":"Creates an offer for a deal contract","tags":[],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"customers":[{}],"productId":"string","currency":"string","effectiveDate":"2024-01-01","activity":"string","settlement":[{}],"facilityRules":[{}],"dacommitment":[{}],"adminfee":[{}],"upfrontfee":[{}],"limit":[{}]}},"responses":{"200":"createDealOfferResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"POST","path":"/holdings/creditAgreements/facilities/offers","fullPath":"/api/v3.2.0/holdings/creditAgreements/facilities/offers","operationId":"createFacilityOffer","name":"Creates a new offer Facility for the required customer when at least the mandatory input is provided. Offer Facility creates a draft contract and allow the users to negotiate multiple times. Offer facility is a draft contract and will not affect the Balance sheet of the bank.","summary":"Creates an offer for a facility contract","tags":[],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"customers":[{}],"productId":"string","currency":"string","dealId":"string","effectiveDate":"2024-01-01","activity":"string","settlement":[{}],"facommitment":[{}],"upfrontfee":[{}],"coordinationfee":[{}],"limit":[{}]}},"responses":{"200":"createFacilityOfferResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"POST","path":"/holdings/creditAgreements/deals/offers/cancellations","fullPath":"/api/v3.2.0/holdings/creditAgreements/deals/offers/cancellations","operationId":"deleteDealOffer","name":"Deletes a new offer for the required deal contract when at least the mandatory input is provided. Deal offer is a draft contract, which allow the user to delete the contract online and deal offer contract will not affect the balance sheet of the bank.","summary":"Deletes an offer for a deal contract","tags":[],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"productId":"string","effectiveDate":"2024-01-01"}},"responses":{"200":"deleteDealOfferResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"POST","path":"/holdings/creditAgreements/facilities/offers/cancellations","fullPath":"/api/v3.2.0/holdings/creditAgreements/facilities/offers/cancellations","operationId":"deleteFacilityOffer","name":"Deletes a new offer for the required facility contract when at least the mandatory input is provided. Facility offer is a draft contract, which allow the user to delete the contract online and facility offer contract will not affect the balance sheet of the bank.","summary":"Deletes an offer for a facility contract","tags":[],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"productId":"string","effectiveDate":"2024-01-01"}},"responses":{"200":"deleteFacilityOfferResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"POST","path":"/holdings/creditAgreements/deals/offers/acceptances","fullPath":"/api/v3.2.0/holdings/creditAgreements/deals/offers/acceptances","operationId":"acceptDealOffer","name":"On executing acceptance, the contract is changed from Offer to live deal for the required customer when at least the mandatory input is provided. Process will check all the required mandatory inputs and prompt an error message when mandatory details are not provided. Once the accept deal offer is processed further offer negotiation is not allowed.","summary":"Accept the deal offer and execute the contract to live","tags":[],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"productId":"string","effectiveDate":"2024-01-01","settlement":[{}],"facilityRules":[{}],"dacommitment":[{}],"adminfee":[{}],"upfrontfee":[{}],"limit":[{}]}},"responses":{"200":"acceptDealOfferResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"POST","path":"/holdings/creditAgreements/facilities/offers/acceptances","fullPath":"/api/v3.2.0/holdings/creditAgreements/facilities/offers/acceptances","operationId":"acceptFacilityOffer","name":"On executing acceptance, the contract is changed from Offer to live Facility for the required customer when at least the mandatory input is provided. Process will check all the required mandatory inputs and prompt an error message when mandatory details are not provided. Once the accept deal offer is processed further offer negotiation is not allowed.","summary":"Accept the facility offer and execute the contract to live","tags":[],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"productId":"string","effectiveDate":"2024-01-01","settlement":[{}],"facommitment":[{}],"upfrontfee":[{}],"coordinationfee":[{}],"limit":[{}]}},"responses":{"200":"acceptFacilityOfferResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"POST","path":"/holdings/creditAgreements/drawdowns/offers","fullPath":"/api/v3.2.0/holdings/creditAgreements/drawdowns/offers","operationId":"createDrawdownOffer","name":"Creates a new drawdown offer for the required customer. ","summary":"Creates a new drawdown offer for the required customer. ","tags":[],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"customers":[{}],"productId":"string","currency":"string","facilityId":"string","offerDate":"2024-01-01","drawdownDate":"2024-01-01","activity":"string","maintenancefee":[{}],"dwcommitment":[{}],"settlement":[{}]}},"responses":{"200":"createDrawdownOfferResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"POST","path":"/holdings/creditAgreements/drawdowns/offers/negotiations","fullPath":"/api/v3.2.0/holdings/creditAgreements/drawdowns/offers/negotiations","operationId":"createOfferDrawdownRenegotiation","name":"Renegotiate the offer drawdown for the required customer.","summary":"Renegotiate the offer drawdown for the required customer.","tags":[],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"productId":"string","drawdownDate":"2024-01-01","maintenancefee":[{}],"settlement":[{}]}},"responses":{"200":"createOfferDrawdownRenegotiationResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"POST","path":"/holdings/creditAgreements/drawdowns/offers/cancellations","fullPath":"/api/v3.2.0/holdings/creditAgreements/drawdowns/offers/cancellations","operationId":"deleteDrawdownOffer","name":"Cancellation of offer drawdown for the required customer.","summary":"Cancellation of offer drawdown for the required customer.","tags":[],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"productId":"string","drawdownDate":"2024-01-01"}},"responses":{"200":"deleteDrawdownOfferResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"POST","path":"/holdings/creditAgreements/drawdowns/offers/acceptances","fullPath":"/api/v3.2.0/holdings/creditAgreements/drawdowns/offers/acceptances","operationId":"acceptOfferDrawdown","name":"Convert an offer drawdown to a live drawdown for the required customer.","summary":"Convert an offer drawdown to a live drawdown for the required customer.","tags":[],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"productId":"string","drawdownDate":"2024-01-01","maintenancefee":[{}],"dwcommitment":[{}],"settlement":[{}]}},"responses":{"200":"acceptOfferDrawdownResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"GET","path":"/holdings/creditAgreements/facilities/{facilityId}/drawingProducts","fullPath":"/api/v3.2.0/holdings/creditAgreements/facilities/{facilityId}/drawingProducts","operationId":"getFacilityDrawingProducts","name":"Retrieves the available drawing products under the facility ","summary":"Retrieves the available drawing products under the facility ","tags":[],"parameters":[{"name":"facilityId","in":"path","type":"string","required":true,"description":"Unique identifier (contract number) of the facility"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"FacilityDrawingProductsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/creditAgreements/facilities/{facilityId}/combinedSchedules","fullPath":"/api/v3.2.0/holdings/creditAgreements/facilities/{facilityId}/combinedSchedules","operationId":"getCombinedSchedules","name":"Retrieves the payment schedule of facility and its drawings","summary":"Retrieves the payment schedule of facility and its drawings","tags":[],"parameters":[{"name":"facilityId","in":"path","type":"string","required":true,"description":"Unique identifier (contract number) of the facility"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"CombinedSchedulesResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"POST","path":"/holdings/creditAgreements/facilities","fullPath":"/api/v3.2.0/holdings/creditAgreements/facilities","operationId":"createFacilities","name":"Creates corporate facilities","summary":"Creates corporate facilities","tags":[],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"customers":[{}],"productId":"string","currency":"string","effectiveDate":"2024-01-01","settlement":[{}],"facommitment":[{}],"upfrontfee":[{}],"coordinationfee":[{}],"limit":[{}]}},"responses":{"200":"createFacilitiesResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"POST","path":"/holdings/creditAgreements/drawdowns","fullPath":"/api/v3.2.0/holdings/creditAgreements/drawdowns","operationId":"createDrawdowns","name":"Creates drawdowns under facility","summary":"Creates drawdowns under facility","tags":[],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"customers":[{}],"arrangmentId":"string","currency":"string","facilityId":"string","effectiveDate":"string","activity":"string","productId":"string","escrow":[{}],"dwcommitment":[{}],"settlement":[{}]}},"responses":{"200":"createDrawdownsResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"GET","path":"/holdings/creditAgreements/facilities/{facilityId}/drawingRules","fullPath":"/api/v3.2.0/holdings/creditAgreements/facilities/{facilityId}/drawingRules","operationId":"getFacilityDrawingRules","name":"Retrieves the allowed customers, currencies and products for a new drawing under the facility","summary":"Retrieves the allowed customers, currencies and products for a new drawing under the facility","tags":[],"parameters":[{"name":"facilityId","in":"path","type":"string","required":true,"description":""},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"FacilityDrawingRulesResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/creditAgreements/facilities/{facilityId}/drawings","fullPath":"/api/v3.2.0/holdings/creditAgreements/facilities/{facilityId}/drawings","operationId":"getDrawingsUnderFacility","name":"Retrieves the drawings under a facility","summary":"Retrieves the drawings under a facility","tags":[],"parameters":[{"name":"facilityId","in":"path","type":"string","required":true,"description":""},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"DrawingsUnderFacilityResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/creditAgreements/facilities/drawings/{drawingId}/parentFacilities","fullPath":"/api/v3.2.0/holdings/creditAgreements/facilities/drawings/{drawingId}/parentFacilities","operationId":"getDrawingFacility","name":"Retrieves the parent facility for a drawing","summary":"Retrieves the parent facility for a drawing","tags":[],"parameters":[{"name":"drawingId","in":"path","type":"string","required":true,"description":""},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"DrawingFacilityResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/creditAgreements/facilities/{facilityId}/commitmentSchedules","fullPath":"/api/v3.2.0/holdings/creditAgreements/facilities/{facilityId}/commitmentSchedules","operationId":"getFacilityCommitmentSchedule","name":"Retrieves the commitment schedule of a facility","summary":"Retrieves the commitment schedule of a facility","tags":[],"parameters":[{"name":"facilityId","in":"path","type":"string","required":true,"description":""},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"FacilityCommitmentScheduleResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/creditAgreements/facilities/{facilityId}/parentDeals","fullPath":"/api/v3.2.0/holdings/creditAgreements/facilities/{facilityId}/parentDeals","operationId":"getFacilityDeal","name":"Retrieves the parent deal for a facility","summary":"Retrieves the parent deal for a facility","tags":[],"parameters":[{"name":"facilityId","in":"path","type":"string","required":true,"description":""},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"FacilityDealResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/creditAgreements/facilities/{facilityId}/balances","fullPath":"/api/v3.2.0/holdings/creditAgreements/facilities/{facilityId}/balances","operationId":"getFacilityFinancialSummary","name":"Retrieves the financial summary for a facility arrangement","summary":"Retrieves the financial summary for a facility arrangement","tags":[],"parameters":[{"name":"facilityId","in":"path","type":"string","required":true,"description":""},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"FacilityFinancialSummaryResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/creditAgreements/facilities/{facilityId}/consolidatedBalances","fullPath":"/api/v3.2.0/holdings/creditAgreements/facilities/{facilityId}/consolidatedBalances","operationId":"getFacilityConsolidatedBalances","name":"Retrieves the consolidated balances for a facility arrangement","summary":"Retrieves the consolidated balances for a facility arrangement","tags":[],"parameters":[{"name":"facilityId","in":"path","type":"string","required":true,"description":""},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"FacilityConsolidatedBalancesResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"POST","path":"/holdings/creditAgreements/facilities/directDebits","fullPath":"/api/v3.2.0/holdings/creditAgreements/facilities/directDebits","operationId":"createFacilityDirectDebitLink","name":"Links a direct debit to an existing facility","summary":"Links a direct debit to a facility","tags":[],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"customers":[{}],"arrangement":"string","productId":"string","currency":"string","effectiveDate":"2024-01-01"}},"responses":{"200":"createFacilityDirectDebitLinkResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"POST","path":"/holdings/creditAgreements/facilities/drawings/directDebits","fullPath":"/api/v3.2.0/holdings/creditAgreements/facilities/drawings/directDebits","operationId":"createDrawingDirectDebitLink","name":"Link the direct debit to an existing drawing under a facility","summary":"Links a direct debit to a drawing","tags":[],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"customers":[{}],"arrangement":"string","currency":"string","facilityId":"string","effectiveDate":"string","productId":"string","settlement":[{}]}},"responses":{"200":"createDrawingDirectDebitLinkResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"POST","path":"/holdings/creditAgreements/facilities/rollovers/offers","fullPath":"/api/v3.2.0/holdings/creditAgreements/facilities/rollovers/offers","operationId":"createFacilityRolloverOffer","name":"Create rollover process from the facility where the rollover could be a Split rollover, Merge rollover or a one to one rollover. Split also called as one to many will rollover an old loan and create multiple new offer loans. Merge also called as many to one will rollover multiple old loans simultaneously and create a single new offer loan. Rollover also called as one to one will simply rollover an old loan and create a new offer loan","summary":"Create rollover offer from facility","tags":[],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"arrangement":"string","rolloverDate":"string","splitsMerges":[{}]}},"responses":{"200":"createFacilityRolloverOfferResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"POST","path":"/holdings/creditAgreements/drawdowns/rollovers/offers","fullPath":"/api/v3.2.0/holdings/creditAgreements/drawdowns/rollovers/offers","operationId":"createDrawdownRolloverOffer","name":"Create rollover process from the drawdown where the rollover could be a Split rollover, Merge rollover or a one to one rollover. Split also called as one to many will rollover an old loan and create multiple new offer loans. Merge also called as many to one will rollover multiple old loans simultaneously and create a single new offer loan. Rollover also called as one to one will simply rollover an old loan and create a new offer loan","summary":"Create rollover offer from drawdown","tags":[],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"arrangement":"string","rolloverDate":"string","splitsMerges":[{}]}},"responses":{"200":"createDrawdownRolloverOfferResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"POST","path":"/holdings/creditAgreements/facilities/commitmentIncreases/{arrangementId}","fullPath":"/api/v3.2.0/holdings/creditAgreements/facilities/commitmentIncreases/{arrangementId}","operationId":"updateFacilityCommitmentIncrease","name":"Increase the facility amount to facilitate further drawdowns","summary":"Increase facility amount","tags":[],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"arrangementId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"productId":"string","effectiveDate":"2024-01-01","facommitment":[{}]}},"responses":{"200":"updateFacilityCommitmentIncreaseResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"POST","path":"/holdings/creditAgreements/facilities/commitmentTerms/{arrangementId}","fullPath":"/api/v3.2.0/holdings/creditAgreements/facilities/commitmentTerms/{arrangementId}","operationId":"updateFacilityCommitmentTerms","name":"Updates facility tenure by increasing or decreasing the term, in addition it allows the amendment of the availability schedule of the contract.","summary":"Update facility maturity date and availability","tags":[],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"arrangementId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"productId":"string","effectiveDate":"2024-01-01","facommitment":[{}]}},"responses":{"200":"updateFacilityCommitmentTermsResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"GET","path":"/holdings/customers/{customerId}/creditAgreements/exposures","fullPath":"/api/v3.2.0/holdings/customers/{customerId}/creditAgreements/exposures","operationId":"getCustomerExposure","name":"Retrieves the customer exposure such as the facility number, type of facility, maturity date and various amounts of the facilities/standalone loans.","summary":"Retrieves the customer exposure for facilities and loans","tags":[],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"Identifier of the customer"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"CustomerExposureResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}}]},{"key":"holdings-creditAgreements-api-service-v4.0.0","title":"Corporate Credit Agreements","version":"v4.0.0","description":"API for the creation and management of credit agreements for Corporate customers. The types of credit agreements are Single Level Facility, Credit Agreement with Multiple Facilities, Club Loans with Agency and Syndicated Loans.","endpointCount":31,"endpoints":[{"method":"POST","path":"/holdings/creditAgreements/deals/offers","fullPath":"/api/v4.0.0/holdings/creditAgreements/deals/offers","operationId":"createDealOffer","name":"Creates new offer Deal for the required customer when the mandatory input details are provided. Offer Deal creates a draft contract and allows the users to negotiate multiple times. Offer Deal is a draft contract and will not affect the Balance sheet of the bank.","summary":"Creates an offer for a deal contract","tags":[],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"customers":[{}],"productId":"string","currency":"string","effectiveDate":"2024-01-01","activity":"string","settlement":[{}],"facilityRules":[{}],"dacommitment":[{}],"adminfee":[{}],"coordinationfee":[{}],"upfrontfee":[{}],"limit":[{}]}},"responses":{"200":"createDealOfferResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"POST","path":"/holdings/creditAgreements/facilities/offers","fullPath":"/api/v4.0.0/holdings/creditAgreements/facilities/offers","operationId":"createFacilityOffer","name":"Creates a new offer Facility for the required customer when at least the mandatory input is provided. Offer Facility creates a draft contract and allow the users to negotiate multiple times. Offer facility is a draft contract and will not affect the Balance sheet of the bank.","summary":"Creates an offer for a facility contract","tags":[],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"customers":[{}],"productId":"string","currency":"string","dealId":"string","effectiveDate":"2024-01-01","activity":"string","settlement":[{}],"facommitment":[{}],"upfrontfee":[{}],"coordinationfee":[{}],"limit":[{}]}},"responses":{"200":"createFacilityOfferResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"POST","path":"/holdings/creditAgreements/deals/offers/cancellations/{arrangementId}","fullPath":"/api/v4.0.0/holdings/creditAgreements/deals/offers/cancellations/{arrangementId}","operationId":"deleteDealOffer","name":"Deletes a new offer for the required deal contract when at least the mandatory input is provided. Deal offer is a draft contract, which allow the user to delete the contract online and deal offer contract will not affect the balance sheet of the bank.","summary":"Deletes an offer for a deal contract","tags":[],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"arrangementId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"productId":"string","effectiveDate":"2024-01-01"}},"responses":{"200":"deleteDealOfferResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"POST","path":"/holdings/creditAgreements/facilities/offers/cancellations/{arrangementId}","fullPath":"/api/v4.0.0/holdings/creditAgreements/facilities/offers/cancellations/{arrangementId}","operationId":"deleteFacilityOffer","name":"Deletes a new offer for the required facility contract when at least the mandatory input is provided. Facility offer is a draft contract, which allow the user to delete the contract online and facility offer contract will not affect the balance sheet of the bank.","summary":"Deletes an offer for a facility contract","tags":[],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"arrangementId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"productId":"string","effectiveDate":"2024-01-01"}},"responses":{"200":"deleteFacilityOfferResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"POST","path":"/holdings/creditAgreements/deals/offers/acceptances/{arrangementId}","fullPath":"/api/v4.0.0/holdings/creditAgreements/deals/offers/acceptances/{arrangementId}","operationId":"acceptDealOffer","name":"On executing acceptance, the contract is changed from Offer to live deal for the required customer when at least the mandatory input is provided. Process will check all the required mandatory inputs and prompt an error message when mandatory details are not provided. Once the accept deal offer is processed further offer negotiation is not allowed.","summary":"Accept the deal offer and execute the contract to live","tags":[],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"arrangementId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"productId":"string","effectiveDate":"2024-01-01","settlement":[{}],"facilityRules":[{}],"dacommitment":[{}],"adminfee":[{}],"coordinationfee":[{}],"upfrontfee":[{}],"limit":[{}]}},"responses":{"200":"acceptDealOfferResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"POST","path":"/holdings/creditAgreements/facilities/offers/acceptances/{arrangementId}","fullPath":"/api/v4.0.0/holdings/creditAgreements/facilities/offers/acceptances/{arrangementId}","operationId":"acceptFacilityOffer","name":"On executing acceptance, the contract is changed from Offer to live Facility for the required customer when at least the mandatory input is provided. Process will check all the required mandatory inputs and prompt an error message when mandatory details are not provided. Once the accept deal offer is processed further offer negotiation is not allowed.","summary":"Accept the facility offer and execute the contract to live","tags":[],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"arrangementId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"productId":"string","effectiveDate":"2024-01-01","settlement":[{}],"facommitment":[{}],"upfrontfee":[{}],"coordinationfee":[{}],"limit":[{}]}},"responses":{"200":"acceptFacilityOfferResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"POST","path":"/holdings/creditAgreements/drawdowns/offers","fullPath":"/api/v4.0.0/holdings/creditAgreements/drawdowns/offers","operationId":"createDrawdownOffer","name":"Creates a new drawdown offer for the required customer. ","summary":"Creates a new drawdown offer for the required customer. ","tags":[],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"customers":[{}],"productId":"string","currency":"string","facilityId":"string","offerDate":"2024-01-01","drawdownDate":"2024-01-01","activity":"string","maintenancefee":[{}],"dwcommitment":[{}],"settlement":[{}]}},"responses":{"200":"createDrawdownOfferResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"POST","path":"/holdings/creditAgreements/drawdowns/offers/negotiations","fullPath":"/api/v4.0.0/holdings/creditAgreements/drawdowns/offers/negotiations","operationId":"createOfferDrawdownRenegotiation","name":"Renegotiate the offer drawdown for the required customer.","summary":"Renegotiate the offer drawdown for the required customer.","tags":[],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"productId":"string","drawdownDate":"2024-01-01","maintenancefee":[{}],"settlement":[{}]}},"responses":{"200":"createOfferDrawdownRenegotiationResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"POST","path":"/holdings/creditAgreements/drawdowns/offers/cancellations","fullPath":"/api/v4.0.0/holdings/creditAgreements/drawdowns/offers/cancellations","operationId":"deleteDrawdownOffer","name":"Cancellation of offer drawdown for the required customer.","summary":"Cancellation of offer drawdown for the required customer.","tags":[],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"productId":"string","drawdownDate":"2024-01-01"}},"responses":{"200":"deleteDrawdownOfferResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"POST","path":"/holdings/creditAgreements/drawdowns/offers/acceptances","fullPath":"/api/v4.0.0/holdings/creditAgreements/drawdowns/offers/acceptances","operationId":"acceptOfferDrawdown","name":"Convert an offer drawdown to a live drawdown for the required customer.","summary":"Convert an offer drawdown to a live drawdown for the required customer.","tags":[],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"productId":"string","drawdownDate":"2024-01-01","maintenancefee":[{}],"dwcommitment":[{}],"settlement":[{}]}},"responses":{"200":"acceptOfferDrawdownResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"GET","path":"/holdings/creditAgreements/facilities/{facilityId}/drawingProducts","fullPath":"/api/v4.0.0/holdings/creditAgreements/facilities/{facilityId}/drawingProducts","operationId":"getFacilityDrawingProducts","name":"Retrieves the available drawing products under the facility ","summary":"Retrieves the available drawing products under the facility ","tags":[],"parameters":[{"name":"facilityId","in":"path","type":"string","required":true,"description":"Unique identifier (contract number) of the facility"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"FacilityDrawingProductsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/creditAgreements/facilities/{facilityId}/combinedSchedules","fullPath":"/api/v4.0.0/holdings/creditAgreements/facilities/{facilityId}/combinedSchedules","operationId":"getCombinedSchedules","name":"Retrieves the payment schedule of facility and its drawings","summary":"Retrieves the payment schedule of facility and its drawings","tags":[],"parameters":[{"name":"facilityId","in":"path","type":"string","required":true,"description":"Unique identifier (contract number) of the facility"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"CombinedSchedulesResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"POST","path":"/holdings/creditAgreements/facilities","fullPath":"/api/v4.0.0/holdings/creditAgreements/facilities","operationId":"createFacilities","name":"Creates corporate facilities","summary":"Creates corporate facilities","tags":[],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"customers":[{}],"productId":"string","currency":"string","effectiveDate":"2024-01-01","settlement":[{}],"facommitment":[{}],"upfrontfee":[{}],"coordinationfee":[{}],"limit":[{}]}},"responses":{"200":"createFacilitiesResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"POST","path":"/holdings/creditAgreements/drawdowns","fullPath":"/api/v4.0.0/holdings/creditAgreements/drawdowns","operationId":"createDrawdowns","name":"Creates drawdowns under facility","summary":"Creates drawdowns under facility","tags":[],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"customers":[{}],"arrangmentId":"string","currency":"string","facilityId":"string","effectiveDate":"string","activity":"string","productId":"string","escrow":[{}],"dwcommitment":[{}],"settlement":[{}]}},"responses":{"200":"createDrawdownsResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"GET","path":"/holdings/creditAgreements/facilities/{facilityId}/drawingRules","fullPath":"/api/v4.0.0/holdings/creditAgreements/facilities/{facilityId}/drawingRules","operationId":"getFacilityDrawingRules","name":"Retrieves the allowed customers, currencies and products for a new drawing under the facility","summary":"Retrieves the allowed customers, currencies and products for a new drawing under the facility","tags":[],"parameters":[{"name":"facilityId","in":"path","type":"string","required":true,"description":""},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"FacilityDrawingRulesResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/creditAgreements/facilities/{facilityId}/drawings","fullPath":"/api/v4.0.0/holdings/creditAgreements/facilities/{facilityId}/drawings","operationId":"getDrawingsUnderFacility","name":"Retrieves the drawings under a facility","summary":"Retrieves the drawings under a facility","tags":[],"parameters":[{"name":"facilityId","in":"path","type":"string","required":true,"description":""},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"DrawingsUnderFacilityResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/creditAgreements/facilities/drawings/{drawingId}/parentFacilities","fullPath":"/api/v4.0.0/holdings/creditAgreements/facilities/drawings/{drawingId}/parentFacilities","operationId":"getDrawingFacility","name":"Retrieves the parent facility for a drawing","summary":"Retrieves the parent facility for a drawing","tags":[],"parameters":[{"name":"drawingId","in":"path","type":"string","required":true,"description":""},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"DrawingFacilityResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/creditAgreements/facilities/{facilityId}/commitmentSchedules","fullPath":"/api/v4.0.0/holdings/creditAgreements/facilities/{facilityId}/commitmentSchedules","operationId":"getFacilityCommitmentSchedule","name":"Retrieves the commitment schedule of a facility","summary":"Retrieves the commitment schedule of a facility","tags":[],"parameters":[{"name":"facilityId","in":"path","type":"string","required":true,"description":""},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"FacilityCommitmentScheduleResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/creditAgreements/facilities/{facilityId}/parentDeals","fullPath":"/api/v4.0.0/holdings/creditAgreements/facilities/{facilityId}/parentDeals","operationId":"getFacilityDeal","name":"Retrieves the parent deal for a facility","summary":"Retrieves the parent deal for a facility","tags":[],"parameters":[{"name":"facilityId","in":"path","type":"string","required":true,"description":""},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"FacilityDealResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/creditAgreements/facilities/{facilityId}/balances","fullPath":"/api/v4.0.0/holdings/creditAgreements/facilities/{facilityId}/balances","operationId":"getFacilityFinancialSummary","name":"Retrieves the financial summary for a facility arrangement","summary":"Retrieves the financial summary for a facility arrangement","tags":[],"parameters":[{"name":"facilityId","in":"path","type":"string","required":true,"description":""},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"FacilityFinancialSummaryResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/creditAgreements/facilities/{facilityId}/consolidatedBalances","fullPath":"/api/v4.0.0/holdings/creditAgreements/facilities/{facilityId}/consolidatedBalances","operationId":"getFacilityConsolidatedBalances","name":"Retrieves the consolidated balances for a facility arrangement","summary":"Retrieves the consolidated balances for a facility arrangement","tags":[],"parameters":[{"name":"facilityId","in":"path","type":"string","required":true,"description":""},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"FacilityConsolidatedBalancesResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"POST","path":"/holdings/creditAgreements/facilities/directDebits","fullPath":"/api/v4.0.0/holdings/creditAgreements/facilities/directDebits","operationId":"createFacilityDirectDebitLink","name":"Links a direct debit to an existing facility","summary":"Links a direct debit to a facility","tags":[],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"customers":[{}],"arrangement":"string","productId":"string","currency":"string","effectiveDate":"2024-01-01"}},"responses":{"200":"createFacilityDirectDebitLinkResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"POST","path":"/holdings/creditAgreements/facilities/drawings/directDebits","fullPath":"/api/v4.0.0/holdings/creditAgreements/facilities/drawings/directDebits","operationId":"createDrawingDirectDebitLink","name":"Link the direct debit to an existing drawing under a facility","summary":"Links a direct debit to a drawing","tags":[],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"customers":[{}],"arrangement":"string","currency":"string","facilityId":"string","effectiveDate":"string","productId":"string","settlement":[{}]}},"responses":{"200":"createDrawingDirectDebitLinkResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"POST","path":"/holdings/creditAgreements/facilities/rollovers/offers","fullPath":"/api/v4.0.0/holdings/creditAgreements/facilities/rollovers/offers","operationId":"createFacilityRolloverOffer","name":"Create rollover process from the facility where the rollover could be a Split rollover, Merge rollover or a one to one rollover. Split also called as one to many will rollover an old loan and create multiple new offer loans. Merge also called as many to one will rollover multiple old loans simultaneously and create a single new offer loan. Rollover also called as one to one will simply rollover an old loan and create a new offer loan","summary":"Create rollover offer from facility","tags":[],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"arrangement":"string","rolloverDate":"string","splitsMerges":[{}]}},"responses":{"200":"createFacilityRolloverOfferResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"POST","path":"/holdings/creditAgreements/drawdowns/rollovers/offers","fullPath":"/api/v4.0.0/holdings/creditAgreements/drawdowns/rollovers/offers","operationId":"createDrawdownRolloverOffer","name":"Create rollover process from the drawdown where the rollover could be a Split rollover, Merge rollover or a one to one rollover. Split also called as one to many will rollover an old loan and create multiple new offer loans. Merge also called as many to one will rollover multiple old loans simultaneously and create a single new offer loan. Rollover also called as one to one will simply rollover an old loan and create a new offer loan","summary":"Create rollover offer from drawdown","tags":[],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"arrangement":"string","rolloverDate":"string","splitsMerges":[{}]}},"responses":{"200":"createDrawdownRolloverOfferResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"POST","path":"/holdings/creditAgreements/facilities/commitmentIncreases/{arrangementId}","fullPath":"/api/v4.0.0/holdings/creditAgreements/facilities/commitmentIncreases/{arrangementId}","operationId":"updateFacilityCommitmentIncrease","name":"Increase the facility amount to facilitate further drawdowns","summary":"Increase facility amount","tags":[],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"arrangementId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"productId":"string","effectiveDate":"2024-01-01","facommitment":[{}]}},"responses":{"200":"updateFacilityCommitmentIncreaseResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"POST","path":"/holdings/creditAgreements/facilities/commitmentTerms/{arrangementId}","fullPath":"/api/v4.0.0/holdings/creditAgreements/facilities/commitmentTerms/{arrangementId}","operationId":"updateFacilityCommitmentTerms","name":"Updates facility tenure by increasing or decreasing the term, in addition it allows the amendment of the availability schedule of the contract.","summary":"Update facility maturity date and availability","tags":[],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"arrangementId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"productId":"string","effectiveDate":"2024-01-01","facommitment":[{}]}},"responses":{"200":"updateFacilityCommitmentTermsResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"GET","path":"/holdings/customers/{customerId}/creditAgreements/exposure","fullPath":"/api/v4.0.0/holdings/customers/{customerId}/creditAgreements/exposure","operationId":"getCustomerExposure","name":"Retrieves the customer exposure such as the facility number, type of facility, maturity date and various amounts of the facilities/standalone loans.","summary":"Retrieves the customer exposure for facilities and loans","tags":[],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"Identifier of the customer"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"CustomerExposureResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/customers/{customerId}/creditAgreements/drawings","fullPath":"/api/v4.0.0/holdings/customers/{customerId}/creditAgreements/drawings","operationId":"getCustomerDrawings","name":"Retrieves the details such as the drawing id, account number, short description of the loan, customer name and loan status for a customer.","summary":"Retrieves the drawing details for a customer.","tags":[],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"Identifier of the customer"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"CustomerDrawingsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/customers/{customerId}/creditAgreements/facilities","fullPath":"/api/v4.0.0/holdings/customers/{customerId}/creditAgreements/facilities","operationId":"getCustomerFacilities","name":"Retrieves the details such as the facility id, account number, short description of the facility, customer name and facility status for a customer.","summary":"Retrieves the facility details for a customer.","tags":[],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"Identifier of the customer"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"CustomerFacilitiesResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/customers/{customerId}/creditAgreements/deals","fullPath":"/api/v4.0.0/holdings/customers/{customerId}/creditAgreements/deals","operationId":"getCustomerDeals","name":"Retrieves the details such as the deal id, account number, short description of the facility, customer name and deal status for a customer.","summary":"Retrieves the deal details for a customer.","tags":[],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"Identifier of the customer"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"CustomerDealsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}}]},{"key":"holdings-creditAgreements-api-service-v4.2.0","title":"Corporate Credit Agreements","version":"v4.2.0","description":"API for the creation and management of credit agreements for Corporate customers. The types of credit agreements are Single Level Facility, Credit Agreement with Multiple Facilities, Club Loans with Agency and Syndicated Loans.","endpointCount":38,"endpoints":[{"method":"POST","path":"/holdings/creditAgreements/deals/offers","fullPath":"/api/v4.2.0/holdings/creditAgreements/deals/offers","operationId":"createDealOffer","name":"Creates new offer Deal for the required customer when the mandatory input details are provided. Offer Deal creates a draft contract and allows the users to negotiate multiple times. Offer Deal is a draft contract and will not affect the Balance sheet of the bank.","summary":"Creates an offer for a deal contract","tags":[],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"customers":[{}],"productId":"string","currency":"string","effectiveDate":"2024-01-01","activity":"string","settlement":[{}],"facilityRules":[{}],"dacommitment":[{}],"adminfee":[{}],"coordinationfee":[{}],"upfrontfee":[{}],"limit":[{}]}},"responses":{"200":"createDealOfferResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"POST","path":"/holdings/creditAgreements/facilities/offers","fullPath":"/api/v4.2.0/holdings/creditAgreements/facilities/offers","operationId":"createFacilityOffer","name":"Creates a new offer Facility for the required customer when at least the mandatory input is provided. Offer Facility creates a draft contract and allow the users to negotiate multiple times. Offer facility is a draft contract and will not affect the Balance sheet of the bank.","summary":"Creates an offer for a facility contract","tags":[],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"customers":[{}],"productId":"string","currency":"string","dealId":"string","effectiveDate":"2024-01-01","activity":"string","settlement":[{}],"facommitment":[{}],"upfrontfee":[{}],"coordinationfee":[{}],"limit":[{}]}},"responses":{"200":"createFacilityOfferResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"POST","path":"/holdings/creditAgreements/deals/offers/cancellations/{arrangementId}","fullPath":"/api/v4.2.0/holdings/creditAgreements/deals/offers/cancellations/{arrangementId}","operationId":"deleteDealOffer","name":"Deletes a new offer for the required deal contract when at least the mandatory input is provided. Deal offer is a draft contract, which allow the user to delete the contract online and deal offer contract will not affect the balance sheet of the bank.","summary":"Deletes an offer for a deal contract","tags":[],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"arrangementId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"productId":"string","effectiveDate":"2024-01-01"}},"responses":{"200":"deleteDealOfferResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"POST","path":"/holdings/creditAgreements/facilities/offers/cancellations/{arrangementId}","fullPath":"/api/v4.2.0/holdings/creditAgreements/facilities/offers/cancellations/{arrangementId}","operationId":"deleteFacilityOffer","name":"Deletes a new offer for the required facility contract when at least the mandatory input is provided. Facility offer is a draft contract, which allow the user to delete the contract online and facility offer contract will not affect the balance sheet of the bank.","summary":"Deletes an offer for a facility contract","tags":[],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"arrangementId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"productId":"string","effectiveDate":"2024-01-01"}},"responses":{"200":"deleteFacilityOfferResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"POST","path":"/holdings/creditAgreements/deals/offers/acceptances/{arrangementId}","fullPath":"/api/v4.2.0/holdings/creditAgreements/deals/offers/acceptances/{arrangementId}","operationId":"acceptDealOffer","name":"On executing acceptance, the contract is changed from Offer to live deal for the required customer when at least the mandatory input is provided. Process will check all the required mandatory inputs and prompt an error message when mandatory details are not provided. Once the accept deal offer is processed further offer negotiation is not allowed.","summary":"Accept the deal offer and execute the contract to live","tags":[],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"arrangementId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"productId":"string","effectiveDate":"2024-01-01","settlement":[{}],"facilityRules":[{}],"dacommitment":[{}],"adminfee":[{}],"coordinationfee":[{}],"upfrontfee":[{}],"limit":[{}]}},"responses":{"200":"acceptDealOfferResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"POST","path":"/holdings/creditAgreements/facilities/offers/acceptances/{arrangementId}","fullPath":"/api/v4.2.0/holdings/creditAgreements/facilities/offers/acceptances/{arrangementId}","operationId":"acceptFacilityOffer","name":"On executing acceptance, the contract is changed from Offer to live Facility for the required customer when at least the mandatory input is provided. Process will check all the required mandatory inputs and prompt an error message when mandatory details are not provided. Once the accept deal offer is processed further offer negotiation is not allowed.","summary":"Accept the facility offer and execute the contract to live","tags":[],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"arrangementId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"productId":"string","effectiveDate":"2024-01-01","settlement":[{}],"facommitment":[{}],"upfrontfee":[{}],"coordinationfee":[{}],"limit":[{}]}},"responses":{"200":"acceptFacilityOfferResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"POST","path":"/holdings/creditAgreements/drawdowns/offers","fullPath":"/api/v4.2.0/holdings/creditAgreements/drawdowns/offers","operationId":"createDrawdownOffer","name":"Creates a new drawdown offer for the required customer. ","summary":"Creates a new drawdown offer for the required customer. ","tags":[],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"customers":[{}],"productId":"string","currency":"string","facilityId":"string","offerDate":"2024-01-01","drawdownDate":"2024-01-01","activity":"string","maintenancefee":[{}],"dwcommitment":[{}],"settlement":[{}]}},"responses":{"200":"createDrawdownOfferResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"POST","path":"/holdings/creditAgreements/drawdowns/offers/negotiations","fullPath":"/api/v4.2.0/holdings/creditAgreements/drawdowns/offers/negotiations","operationId":"createOfferDrawdownRenegotiation","name":"Renegotiate the offer drawdown for the required customer.","summary":"Renegotiate the offer drawdown for the required customer.","tags":[],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"productId":"string","drawdownDate":"2024-01-01","maintenancefee":[{}],"settlement":[{}]}},"responses":{"200":"createOfferDrawdownRenegotiationResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"POST","path":"/holdings/creditAgreements/drawdowns/offers/cancellations","fullPath":"/api/v4.2.0/holdings/creditAgreements/drawdowns/offers/cancellations","operationId":"deleteDrawdownOffer","name":"Cancellation of offer drawdown for the required customer.","summary":"Cancellation of offer drawdown for the required customer.","tags":[],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"productId":"string","drawdownDate":"2024-01-01"}},"responses":{"200":"deleteDrawdownOfferResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"POST","path":"/holdings/creditAgreements/drawdowns/offers/acceptances","fullPath":"/api/v4.2.0/holdings/creditAgreements/drawdowns/offers/acceptances","operationId":"acceptOfferDrawdown","name":"Convert an offer drawdown to a live drawdown for the required customer.","summary":"Convert an offer drawdown to a live drawdown for the required customer.","tags":[],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"productId":"string","drawdownDate":"2024-01-01","maintenancefee":[{}],"dwcommitment":[{}],"settlement":[{}]}},"responses":{"200":"acceptOfferDrawdownResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"GET","path":"/holdings/creditAgreements/facilities/{facilityId}/drawingProducts","fullPath":"/api/v4.2.0/holdings/creditAgreements/facilities/{facilityId}/drawingProducts","operationId":"getFacilityDrawingProducts","name":"Retrieves the available drawing products under the facility ","summary":"Retrieves the available drawing products under the facility ","tags":[],"parameters":[{"name":"facilityId","in":"path","type":"string","required":true,"description":"Unique identifier (contract number) of the facility"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"FacilityDrawingProductsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/creditAgreements/facilities/{facilityId}/combinedSchedules","fullPath":"/api/v4.2.0/holdings/creditAgreements/facilities/{facilityId}/combinedSchedules","operationId":"getCombinedSchedules","name":"Retrieves the payment schedule of facility and its drawings","summary":"Retrieves the payment schedule of facility and its drawings","tags":[],"parameters":[{"name":"facilityId","in":"path","type":"string","required":true,"description":"Unique identifier (contract number) of the facility"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"CombinedSchedulesResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"POST","path":"/holdings/creditAgreements/facilities","fullPath":"/api/v4.2.0/holdings/creditAgreements/facilities","operationId":"createFacilities","name":"Creates corporate facilities","summary":"Creates corporate facilities","tags":[],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"customers":[{}],"productId":"string","currency":"string","effectiveDate":"2024-01-01","settlement":[{}],"facommitment":[{}],"upfrontfee":[{}],"coordinationfee":[{}],"limit":[{}]}},"responses":{"200":"createFacilitiesResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"POST","path":"/holdings/creditAgreements/drawdowns","fullPath":"/api/v4.2.0/holdings/creditAgreements/drawdowns","operationId":"createDrawdowns","name":"Creates drawdowns under facility","summary":"Creates drawdowns under facility","tags":[],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"customers":[{}],"arrangmentId":"string","currency":"string","facilityId":"string","effectiveDate":"string","activity":"string","productId":"string","escrow":[{}],"dwcommitment":[{}],"settlement":[{}]}},"responses":{"200":"createDrawdownsResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"GET","path":"/holdings/creditAgreements/facilities/{facilityId}/drawingRules","fullPath":"/api/v4.2.0/holdings/creditAgreements/facilities/{facilityId}/drawingRules","operationId":"getFacilityDrawingRules","name":"Retrieves the allowed customers, currencies and products for a new drawing under the facility","summary":"Retrieves the allowed customers, currencies and products for a new drawing under the facility","tags":[],"parameters":[{"name":"facilityId","in":"path","type":"string","required":true,"description":""},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"FacilityDrawingRulesResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/creditAgreements/facilities/{facilityId}/drawings","fullPath":"/api/v4.2.0/holdings/creditAgreements/facilities/{facilityId}/drawings","operationId":"getDrawingsUnderFacility","name":"Retrieves the drawings under a facility","summary":"Retrieves the drawings under a facility","tags":[],"parameters":[{"name":"facilityId","in":"path","type":"string","required":true,"description":""},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"DrawingsUnderFacilityResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/creditAgreements/facilities/drawings/{drawingId}/parentFacilities","fullPath":"/api/v4.2.0/holdings/creditAgreements/facilities/drawings/{drawingId}/parentFacilities","operationId":"getDrawingFacility","name":"Retrieves the parent facility for a drawing","summary":"Retrieves the parent facility for a drawing","tags":[],"parameters":[{"name":"drawingId","in":"path","type":"string","required":true,"description":""},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"DrawingFacilityResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/creditAgreements/facilities/{facilityId}/commitmentSchedules","fullPath":"/api/v4.2.0/holdings/creditAgreements/facilities/{facilityId}/commitmentSchedules","operationId":"getFacilityCommitmentSchedule","name":"Retrieves the commitment schedule of a facility","summary":"Retrieves the commitment schedule of a facility","tags":[],"parameters":[{"name":"facilityId","in":"path","type":"string","required":true,"description":""},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"FacilityCommitmentScheduleResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/creditAgreements/facilities/{facilityId}/parentDeals","fullPath":"/api/v4.2.0/holdings/creditAgreements/facilities/{facilityId}/parentDeals","operationId":"getFacilityDeal","name":"Retrieves the parent deal for a facility","summary":"Retrieves the parent deal for a facility","tags":[],"parameters":[{"name":"facilityId","in":"path","type":"string","required":true,"description":""},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"FacilityDealResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/creditAgreements/facilities/{facilityId}/balances","fullPath":"/api/v4.2.0/holdings/creditAgreements/facilities/{facilityId}/balances","operationId":"getFacilityFinancialSummary","name":"Retrieves the financial summary for a facility arrangement","summary":"Retrieves the financial summary for a facility arrangement","tags":[],"parameters":[{"name":"facilityId","in":"path","type":"string","required":true,"description":""},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"FacilityFinancialSummaryResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/creditAgreements/facilities/{facilityId}/consolidatedBalances","fullPath":"/api/v4.2.0/holdings/creditAgreements/facilities/{facilityId}/consolidatedBalances","operationId":"getFacilityConsolidatedBalances","name":"Retrieves the consolidated balances for a facility arrangement","summary":"Retrieves the consolidated balances for a facility arrangement","tags":[],"parameters":[{"name":"facilityId","in":"path","type":"string","required":true,"description":""},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"FacilityConsolidatedBalancesResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"POST","path":"/holdings/creditAgreements/facilities/directDebits","fullPath":"/api/v4.2.0/holdings/creditAgreements/facilities/directDebits","operationId":"createFacilityDirectDebitLink","name":"Links a direct debit to an existing facility","summary":"Links a direct debit to a facility","tags":[],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"customers":[{}],"arrangement":"string","productId":"string","currency":"string","effectiveDate":"2024-01-01"}},"responses":{"200":"createFacilityDirectDebitLinkResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"POST","path":"/holdings/creditAgreements/facilities/drawings/directDebits","fullPath":"/api/v4.2.0/holdings/creditAgreements/facilities/drawings/directDebits","operationId":"createDrawingDirectDebitLink","name":"Link the direct debit to an existing drawing under a facility","summary":"Links a direct debit to a drawing","tags":[],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"customers":[{}],"arrangement":"string","currency":"string","facilityId":"string","effectiveDate":"string","productId":"string","settlement":[{}]}},"responses":{"200":"createDrawingDirectDebitLinkResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"POST","path":"/holdings/creditAgreements/facilities/rollovers/offers","fullPath":"/api/v4.2.0/holdings/creditAgreements/facilities/rollovers/offers","operationId":"createFacilityRolloverOffer","name":"Create rollover process from the facility where the rollover could be a Split rollover, Merge rollover or a one to one rollover. Split also called as one to many will rollover an old loan and create multiple new offer loans. Merge also called as many to one will rollover multiple old loans simultaneously and create a single new offer loan. Rollover also called as one to one will simply rollover an old loan and create a new offer loan","summary":"Create rollover offer from facility","tags":[],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"arrangement":"string","rolloverDate":"string","splitsMerges":[{}]}},"responses":{"200":"createFacilityRolloverOfferResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"POST","path":"/holdings/creditAgreements/drawdowns/rollovers/offers","fullPath":"/api/v4.2.0/holdings/creditAgreements/drawdowns/rollovers/offers","operationId":"createDrawdownRolloverOffer","name":"Create rollover process from the drawdown where the rollover could be a Split rollover, Merge rollover or a one to one rollover. Split also called as one to many will rollover an old loan and create multiple new offer loans. Merge also called as many to one will rollover multiple old loans simultaneously and create a single new offer loan. Rollover also called as one to one will simply rollover an old loan and create a new offer loan","summary":"Create rollover offer from drawdown","tags":[],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"arrangement":"string","rolloverDate":"string","splitsMerges":[{}]}},"responses":{"200":"createDrawdownRolloverOfferResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"POST","path":"/holdings/creditAgreements/facilities/commitmentIncreases/{arrangementId}","fullPath":"/api/v4.2.0/holdings/creditAgreements/facilities/commitmentIncreases/{arrangementId}","operationId":"updateFacilityCommitmentIncrease","name":"Increase the facility amount to facilitate further drawdowns","summary":"Increase facility amount","tags":[],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"arrangementId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"productId":"string","effectiveDate":"2024-01-01","facommitment":[{}]}},"responses":{"200":"updateFacilityCommitmentIncreaseResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"POST","path":"/holdings/creditAgreements/facilities/commitmentTerms/{arrangementId}","fullPath":"/api/v4.2.0/holdings/creditAgreements/facilities/commitmentTerms/{arrangementId}","operationId":"updateFacilityCommitmentTerms","name":"Updates facility tenure by increasing or decreasing the term, in addition it allows the amendment of the availability schedule of the contract.","summary":"Update facility maturity date and availability","tags":[],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"arrangementId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"productId":"string","effectiveDate":"2024-01-01","facommitment":[{}]}},"responses":{"200":"updateFacilityCommitmentTermsResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"GET","path":"/holdings/customers/{customerId}/creditAgreements/exposure","fullPath":"/api/v4.2.0/holdings/customers/{customerId}/creditAgreements/exposure","operationId":"getCustomerExposure","name":"Retrieves the customer exposure such as the facility number, type of facility, maturity date and various amounts of the facilities/standalone loans.","summary":"Retrieves the customer exposure for facilities and loans","tags":[],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"Identifier of the customer"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"CustomerExposureResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/customers/{customerId}/creditAgreements/drawings","fullPath":"/api/v4.2.0/holdings/customers/{customerId}/creditAgreements/drawings","operationId":"getCustomerDrawings","name":"Retrieves the details such as the drawing id, account number, short description of the loan, customer name and loan status for a customer. ","summary":"Retrieves the drawing details for a customer.","tags":[],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"Identifier of the customer"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"CustomerDrawingsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/customers/{customerId}/creditAgreements/facilities","fullPath":"/api/v4.2.0/holdings/customers/{customerId}/creditAgreements/facilities","operationId":"getCustomerFacilities","name":"Retrieves the details such as the facility id, account number, short description of the facility, customer name and facility status for a customer.","summary":"Retrieves the facility details for a customer.","tags":[],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"Identifier of the customer"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"CustomerFacilitiesResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/customers/{customerId}/creditAgreements/deals","fullPath":"/api/v4.2.0/holdings/customers/{customerId}/creditAgreements/deals","operationId":"getCustomerDeals","name":"Retrieves the details such as the deal id, account number, short description of the facility, customer name and deal status for a customer.","summary":"Retrieves the deal details for a customer.","tags":[],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"Identifier of the customer"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"CustomerDealsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/creditAgreements/deals/{dealId}/facilities","fullPath":"/api/v4.2.0/holdings/creditAgreements/deals/{dealId}/facilities","operationId":"getFacilitiesUnderDeal","name":"Retrieves the details such as facility id, title, currency, status and commitment amount for all the facilities under a deal.","summary":"Retrieves the details of facilities under a deal.","tags":[],"parameters":[{"name":"dealId","in":"path","type":"string","required":true,"description":"Unique identifier (contract number) of the corporate deals"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"FacilitiesUnderDealResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/creditAgreements/productCatalogues","fullPath":"/api/v4.2.0/holdings/creditAgreements/productCatalogues","operationId":"getCreditAgreementsProductCatalogue","name":"Retrieves the list of available products for credit agreements.","summary":"Retrieves the credit agreements product catalogue.","tags":[],"parameters":[{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"CreditAgreementsProductCatalogueResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/creditAgreements/drawings/{drawingId}/pendingActivities","fullPath":"/api/v4.2.0/holdings/creditAgreements/drawings/{drawingId}/pendingActivities","operationId":"getPendingActivities","name":"Retrieves the details such as rollover date, rollover status etc of pending drawdowns and rollovers for a drawing.","summary":"Retrieves the details of pending drawdowns and rollovers for a drawing.","tags":[],"parameters":[{"name":"drawingId","in":"path","type":"string","required":true,"description":"Identifier of drawings application under the Letter of Credit system that is used to effect the transfer of funds and the acceptance of documents under Letters of Credit and Documentary Collection tra"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"PendingActivitiesResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/creditAgreements/drawings/expiries","fullPath":"/api/v4.2.0/holdings/creditAgreements/drawings/expiries","operationId":"getLoansExpiring","name":"Retrieves the drawings expiring in the next 7 days.","summary":"Retrieves expiring drawings.","tags":[],"parameters":[{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"LoansExpiringResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/creditAgreements/facilities/expiries","fullPath":"/api/v4.2.0/holdings/creditAgreements/facilities/expiries","operationId":"getFacilitiesExpiring","name":"Retrieves the facilities expiring in the next 7 days","summary":"Retrieves expiring facilities","tags":[],"parameters":[{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"FacilitiesExpiringResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/creditAgreements/drawings/{drawingId}/balances","fullPath":"/api/v4.2.0/holdings/creditAgreements/drawings/{drawingId}/balances","operationId":"getDrawingBalances","name":"Retrieves the balance details such as commitment balances, utilized balances.","summary":"Retrieves drawing balances","tags":[],"parameters":[{"name":"drawingId","in":"path","type":"string","required":true,"description":"Identifier of drawings application under the Letter of Credit system that is used to effect the transfer of funds and the acceptance of documents under Letters of Credit and Documentary Collection tra"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"DrawingBalancesResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/creditAgreements/drawings/{drawingId}/OverdueBalances","fullPath":"/api/v4.2.0/holdings/creditAgreements/drawings/{drawingId}/OverdueBalances","operationId":"getDrawingOverdueBalances","name":"Retrieves the past dues and overdues for a drawing","summary":"Retrieves drawing overdue balances","tags":[],"parameters":[{"name":"drawingId","in":"path","type":"string","required":true,"description":"Identifier of drawings application under the Letter of Credit system that is used to effect the transfer of funds and the acceptance of documents under Letters of Credit and Documentary Collection tra"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"DrawingOverdueBalancesResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}}]},{"key":"holdings-creditAgreements-api-service-v4.3.0","title":"Corporate Credit Agreements","version":"v4.3.0","description":"API for the creation and management of credit agreements for Corporate customers. The types of credit agreements are Single Level Facility, Credit Agreement with Multiple Facilities, Club Loans with Agency and Syndicated Loans.","endpointCount":45,"endpoints":[{"method":"POST","path":"/holdings/creditAgreements/deals/offers","fullPath":"/api/v4.3.0/holdings/creditAgreements/deals/offers","operationId":"createDealOffer","name":"Creates new offer Deal for the required customer when the mandatory input details are provided. Offer Deal creates a draft contract and allows the users to negotiate multiple times. Offer Deal is a draft contract and will not affect the Balance sheet of the bank.","summary":"Creates an offer for a deal contract","tags":[],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"customers":[{}],"productId":"string","currency":"string","effectiveDate":"2024-01-01","activity":"string","extensionData":{},"settlement":[{}],"facilityRules":[{}],"dacommitment":[{}],"adminfee":[{}],"coordinationfee":[{}],"upfrontfee":[{}],"limit":[{}]}},"responses":{"200":"createDealOfferResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"POST","path":"/holdings/creditAgreements/facilities/offers","fullPath":"/api/v4.3.0/holdings/creditAgreements/facilities/offers","operationId":"createFacilityOffer","name":"Creates a new offer Facility for the required customer when at least the mandatory input is provided. Offer Facility creates a draft contract and allow the users to negotiate multiple times. Offer facility is a draft contract and will not affect the Balance sheet of the bank.","summary":"Creates an offer for a facility contract","tags":[],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"customers":[{}],"productId":"string","currency":"string","dealId":"string","effectiveDate":"2024-01-01","activity":"string","extensionData":{},"settlement":[{}],"facommitment":[{}],"upfrontfee":[{}],"coordinationfee":[{}],"limit":[{}]}},"responses":{"200":"createFacilityOfferResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"POST","path":"/holdings/creditAgreements/deals/offers/cancellations/{arrangementId}","fullPath":"/api/v4.3.0/holdings/creditAgreements/deals/offers/cancellations/{arrangementId}","operationId":"deleteDealOffer","name":"Deletes a new offer for the required deal contract when at least the mandatory input is provided. Deal offer is a draft contract, which allow the user to delete the contract online and deal offer contract will not affect the balance sheet of the bank.","summary":"Deletes an offer for a deal contract","tags":[],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"arrangementId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"productId":"string","effectiveDate":"2024-01-01","extensionData":{}}},"responses":{"200":"deleteDealOfferResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"POST","path":"/holdings/creditAgreements/facilities/offers/cancellations/{arrangementId}","fullPath":"/api/v4.3.0/holdings/creditAgreements/facilities/offers/cancellations/{arrangementId}","operationId":"deleteFacilityOffer","name":"Deletes a new offer for the required facility contract when at least the mandatory input is provided. Facility offer is a draft contract, which allow the user to delete the contract online and facility offer contract will not affect the balance sheet of the bank.","summary":"Deletes an offer for a facility contract","tags":[],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"arrangementId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"productId":"string","effectiveDate":"2024-01-01","extensionData":{}}},"responses":{"200":"deleteFacilityOfferResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"POST","path":"/holdings/creditAgreements/deals/offers/acceptances/{arrangementId}","fullPath":"/api/v4.3.0/holdings/creditAgreements/deals/offers/acceptances/{arrangementId}","operationId":"acceptDealOffer","name":"On executing acceptance, the contract is changed from Offer to live deal for the required customer when at least the mandatory input is provided. Process will check all the required mandatory inputs and prompt an error message when mandatory details are not provided. Once the accept deal offer is processed further offer negotiation is not allowed.","summary":"Accept the deal offer and execute the contract to live","tags":[],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"arrangementId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"productId":"string","effectiveDate":"2024-01-01","extensionData":{},"settlement":[{}],"facilityRules":[{}],"dacommitment":[{}],"adminfee":[{}],"coordinationfee":[{}],"upfrontfee":[{}],"limit":[{}]}},"responses":{"200":"acceptDealOfferResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"POST","path":"/holdings/creditAgreements/facilities/offers/acceptances/{arrangementId}","fullPath":"/api/v4.3.0/holdings/creditAgreements/facilities/offers/acceptances/{arrangementId}","operationId":"acceptFacilityOffer","name":"On executing acceptance, the contract is changed from Offer to live Facility for the required customer when at least the mandatory input is provided. Process will check all the required mandatory inputs and prompt an error message when mandatory details are not provided. Once the accept deal offer is processed further offer negotiation is not allowed.","summary":"Accept the facility offer and execute the contract to live","tags":[],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"arrangementId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"productId":"string","effectiveDate":"2024-01-01","extensionData":{},"settlement":[{}],"facommitment":[{}],"upfrontfee":[{}],"coordinationfee":[{}],"limit":[{}]}},"responses":{"200":"acceptFacilityOfferResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"POST","path":"/holdings/creditAgreements/drawdowns/offers","fullPath":"/api/v4.3.0/holdings/creditAgreements/drawdowns/offers","operationId":"createDrawdownOffer","name":"Creates a new drawdown offer for the required customer. ","summary":"Creates a new drawdown offer for the required customer. ","tags":[],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"customers":[{}],"productId":"string","currency":"string","facilityId":"string","offerDate":"2024-01-01","drawdownDate":"2024-01-01","activity":"string","extensionData":{},"maintenancefee":[{}],"dwcommitment":[{}],"settlement":[{}]}},"responses":{"200":"createDrawdownOfferResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"POST","path":"/holdings/creditAgreements/drawdowns/offers/negotiations","fullPath":"/api/v4.3.0/holdings/creditAgreements/drawdowns/offers/negotiations","operationId":"createOfferDrawdownRenegotiation","name":"Renegotiate the offer drawdown for the required customer.","summary":"Renegotiate the offer drawdown for the required customer.","tags":[],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"productId":"string","drawdownDate":"2024-01-01","extensionData":{},"maintenancefee":[{}],"settlement":[{}]}},"responses":{"200":"createOfferDrawdownRenegotiationResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"POST","path":"/holdings/creditAgreements/drawdowns/offers/cancellations","fullPath":"/api/v4.3.0/holdings/creditAgreements/drawdowns/offers/cancellations","operationId":"deleteDrawdownOffer","name":"Cancellation of offer drawdown for the required customer.","summary":"Cancellation of offer drawdown for the required customer.","tags":[],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"productId":"string","drawdownDate":"2024-01-01","extensionData":{}}},"responses":{"200":"deleteDrawdownOfferResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"POST","path":"/holdings/creditAgreements/drawdowns/offers/acceptances","fullPath":"/api/v4.3.0/holdings/creditAgreements/drawdowns/offers/acceptances","operationId":"acceptOfferDrawdown","name":"Convert an offer drawdown to a live drawdown for the required customer.","summary":"Convert an offer drawdown to a live drawdown for the required customer.","tags":[],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"productId":"string","drawdownDate":"2024-01-01","extensionData":{},"maintenancefee":[{}],"dwcommitment":[{}],"settlement":[{}]}},"responses":{"200":"acceptOfferDrawdownResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"GET","path":"/holdings/creditAgreements/facilities/{facilityId}/drawingProducts","fullPath":"/api/v4.3.0/holdings/creditAgreements/facilities/{facilityId}/drawingProducts","operationId":"getFacilityDrawingProducts","name":"Retrieves the available drawing products under the facility ","summary":"Retrieves the available drawing products under the facility ","tags":[],"parameters":[{"name":"facilityId","in":"path","type":"string","required":true,"description":"Unique identifier (contract number) of the facility"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"FacilityDrawingProductsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/creditAgreements/facilities/{facilityId}/combinedSchedules","fullPath":"/api/v4.3.0/holdings/creditAgreements/facilities/{facilityId}/combinedSchedules","operationId":"getCombinedSchedules","name":"Retrieves the payment schedule of facility and its drawings","summary":"Retrieves the payment schedule of facility and its drawings","tags":[],"parameters":[{"name":"facilityId","in":"path","type":"string","required":true,"description":"Unique identifier (contract number) of the facility"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"CombinedSchedulesResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"POST","path":"/holdings/creditAgreements/facilities","fullPath":"/api/v4.3.0/holdings/creditAgreements/facilities","operationId":"createFacilities","name":"Creates corporate facilities","summary":"Creates corporate facilities","tags":[],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"customers":[{}],"productId":"string","currency":"string","effectiveDate":"2024-01-01","extensionData":{},"settlement":[{}],"facommitment":[{}],"upfrontfee":[{}],"coordinationfee":[{}],"limit":[{}]}},"responses":{"200":"createFacilitiesResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"POST","path":"/holdings/creditAgreements/drawdowns","fullPath":"/api/v4.3.0/holdings/creditAgreements/drawdowns","operationId":"createDrawdowns","name":"Creates drawdowns under facility","summary":"Creates drawdowns under facility","tags":[],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"customers":[{}],"arrangmentId":"string","currency":"string","facilityId":"string","effectiveDate":"string","activity":"string","productId":"string","extensionData":{},"escrow":[{}],"dwcommitment":[{}],"settlement":[{}]}},"responses":{"200":"createDrawdownsResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"GET","path":"/holdings/creditAgreements/facilities/{facilityId}/drawingRules","fullPath":"/api/v4.3.0/holdings/creditAgreements/facilities/{facilityId}/drawingRules","operationId":"getFacilityDrawingRules","name":"Retrieves the allowed customers, currencies and products for a new drawing under the facility","summary":"Retrieves the allowed customers, currencies and products for a new drawing under the facility","tags":[],"parameters":[{"name":"facilityId","in":"path","type":"string","required":true,"description":""},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"FacilityDrawingRulesResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/creditAgreements/facilities/{facilityId}/drawings","fullPath":"/api/v4.3.0/holdings/creditAgreements/facilities/{facilityId}/drawings","operationId":"getDrawingsUnderFacility","name":"Retrieves the drawings under a facility","summary":"Retrieves the drawings under a facility","tags":[],"parameters":[{"name":"facilityId","in":"path","type":"string","required":true,"description":""},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"DrawingsUnderFacilityResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/creditAgreements/facilities/drawings/{drawingId}/parentFacilities","fullPath":"/api/v4.3.0/holdings/creditAgreements/facilities/drawings/{drawingId}/parentFacilities","operationId":"getDrawingFacility","name":"Retrieves the parent facility for a drawing","summary":"Retrieves the parent facility for a drawing","tags":[],"parameters":[{"name":"drawingId","in":"path","type":"string","required":true,"description":""},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"DrawingFacilityResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/creditAgreements/facilities/{facilityId}/commitmentSchedules","fullPath":"/api/v4.3.0/holdings/creditAgreements/facilities/{facilityId}/commitmentSchedules","operationId":"getFacilityCommitmentSchedule","name":"Retrieves the commitment schedule of a facility","summary":"Retrieves the commitment schedule of a facility","tags":[],"parameters":[{"name":"facilityId","in":"path","type":"string","required":true,"description":""},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"FacilityCommitmentScheduleResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/creditAgreements/facilities/{facilityId}/parentDeals","fullPath":"/api/v4.3.0/holdings/creditAgreements/facilities/{facilityId}/parentDeals","operationId":"getFacilityDeal","name":"Retrieves the parent deal for a facility","summary":"Retrieves the parent deal for a facility","tags":[],"parameters":[{"name":"facilityId","in":"path","type":"string","required":true,"description":""},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"FacilityDealResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/creditAgreements/facilities/{facilityId}/balances","fullPath":"/api/v4.3.0/holdings/creditAgreements/facilities/{facilityId}/balances","operationId":"getFacilityFinancialSummary","name":"Retrieves the financial summary for a facility arrangement","summary":"Retrieves the financial summary for a facility arrangement","tags":[],"parameters":[{"name":"facilityId","in":"path","type":"string","required":true,"description":""},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"FacilityFinancialSummaryResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/creditAgreements/facilities/{facilityId}/consolidatedBalances","fullPath":"/api/v4.3.0/holdings/creditAgreements/facilities/{facilityId}/consolidatedBalances","operationId":"getFacilityConsolidatedBalances","name":"Retrieves the consolidated balances for a facility arrangement","summary":"Retrieves the consolidated balances for a facility arrangement","tags":[],"parameters":[{"name":"facilityId","in":"path","type":"string","required":true,"description":""},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"FacilityConsolidatedBalancesResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"POST","path":"/holdings/creditAgreements/facilities/directDebits","fullPath":"/api/v4.3.0/holdings/creditAgreements/facilities/directDebits","operationId":"createFacilityDirectDebitLink","name":"Links a direct debit to an existing facility","summary":"Links a direct debit to a facility","tags":[],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"customers":[{}],"arrangement":"string","productId":"string","currency":"string","effectiveDate":"2024-01-01","extensionData":{},"settlement":[{}]}},"responses":{"200":"createFacilityDirectDebitLinkResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"POST","path":"/holdings/creditAgreements/facilities/drawings/directDebits","fullPath":"/api/v4.3.0/holdings/creditAgreements/facilities/drawings/directDebits","operationId":"createDrawingDirectDebitLink","name":"Link the direct debit to an existing drawing under a facility","summary":"Links a direct debit to a drawing","tags":[],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"customers":[{}],"arrangement":"string","currency":"string","facilityId":"string","effectiveDate":"string","productId":"string","extensionData":{},"settlement":[{}]}},"responses":{"200":"createDrawingDirectDebitLinkResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"POST","path":"/holdings/creditAgreements/facilities/rollovers/offers","fullPath":"/api/v4.3.0/holdings/creditAgreements/facilities/rollovers/offers","operationId":"createFacilityRolloverOffer","name":"Create rollover process from the facility where the rollover could be a Split rollover, Merge rollover or a one to one rollover. Split also called as one to many will rollover an old loan and create multiple new offer loans. Merge also called as many to one will rollover multiple old loans simultaneously and create a single new offer loan. Rollover also called as one to one will simply rollover an old loan and create a new offer loan","summary":"Create rollover offer from facility","tags":[],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"arrangement":"string","rolloverDate":"string","extensionData":{},"splitsMerges":[{}]}},"responses":{"200":"createFacilityRolloverOfferResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"POST","path":"/holdings/creditAgreements/drawdowns/rollovers/offers","fullPath":"/api/v4.3.0/holdings/creditAgreements/drawdowns/rollovers/offers","operationId":"createDrawdownRolloverOffer","name":"Create rollover process from the drawdown where the rollover could be a Split rollover, Merge rollover or a one to one rollover. Split also called as one to many will rollover an old loan and create multiple new offer loans. Merge also called as many to one will rollover multiple old loans simultaneously and create a single new offer loan. Rollover also called as one to one will simply rollover an old loan and create a new offer loan","summary":"Create rollover offer from drawdown","tags":[],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"arrangement":"string","rolloverDate":"string","extensionData":{},"splitsMerges":[{}]}},"responses":{"200":"createDrawdownRolloverOfferResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"POST","path":"/holdings/creditAgreements/facilities/commitmentIncreases/{arrangementId}","fullPath":"/api/v4.3.0/holdings/creditAgreements/facilities/commitmentIncreases/{arrangementId}","operationId":"updateFacilityCommitmentIncrease","name":"Increase the facility amount to facilitate further drawdowns","summary":"Increase facility amount","tags":[],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"arrangementId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"productId":"string","effectiveDate":"2024-01-01","extensionData":{},"facommitment":[{}]}},"responses":{"200":"updateFacilityCommitmentIncreaseResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"POST","path":"/holdings/creditAgreements/facilities/commitmentTerms/{arrangementId}","fullPath":"/api/v4.3.0/holdings/creditAgreements/facilities/commitmentTerms/{arrangementId}","operationId":"updateFacilityCommitmentTerms","name":"Updates facility tenure by increasing or decreasing the term, in addition it allows the amendment of the availability schedule of the contract.","summary":"Update facility maturity date and availability","tags":[],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"arrangementId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"productId":"string","effectiveDate":"2024-01-01","extensionData":{},"facommitment":[{}]}},"responses":{"200":"updateFacilityCommitmentTermsResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"GET","path":"/holdings/customers/{customerId}/creditAgreements/exposure","fullPath":"/api/v4.3.0/holdings/customers/{customerId}/creditAgreements/exposure","operationId":"getCustomerExposure","name":"Retrieves the customer exposure such as the facility number, type of facility, maturity date and various amounts of the facilities/standalone loans.","summary":"Retrieves the customer exposure for facilities and loans","tags":[],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"Identifier of the customer"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"CustomerExposureResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/customers/{customerId}/creditAgreements/drawings","fullPath":"/api/v4.3.0/holdings/customers/{customerId}/creditAgreements/drawings","operationId":"getCustomerDrawings","name":"Retrieves the details such as the drawing id, account number, short description of the loan, customer name and loan status for a customer. ","summary":"Retrieves the drawing details for a customer.","tags":[],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"Identifier of the customer"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"CustomerDrawingsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/customers/{customerId}/creditAgreements/facilities","fullPath":"/api/v4.3.0/holdings/customers/{customerId}/creditAgreements/facilities","operationId":"getCustomerFacilities","name":"Retrieves the details such as the facility id, account number, short description of the facility, customer name and facility status for a customer.","summary":"Retrieves the facility details for a customer.","tags":[],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"Identifier of the customer"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"CustomerFacilitiesResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/customers/{customerId}/creditAgreements/deals","fullPath":"/api/v4.3.0/holdings/customers/{customerId}/creditAgreements/deals","operationId":"getCustomerDeals","name":"Retrieves the details such as the deal id, account number, short description of the facility, customer name and deal status for a customer.","summary":"Retrieves the deal details for a customer.","tags":[],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"Identifier of the customer"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"CustomerDealsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/creditAgreements/deals/{dealId}/facilities","fullPath":"/api/v4.3.0/holdings/creditAgreements/deals/{dealId}/facilities","operationId":"getFacilitiesUnderDeal","name":"Retrieves the details such as facility id, title, currency, status and commitment amount for all the facilities under a deal.","summary":"Retrieves the details of facilities under a deal.","tags":[],"parameters":[{"name":"dealId","in":"path","type":"string","required":true,"description":"Unique identifier (contract number) of the corporate deals"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"FacilitiesUnderDealResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/creditAgreements/productCatalogues","fullPath":"/api/v4.3.0/holdings/creditAgreements/productCatalogues","operationId":"getCreditAgreementsProductCatalogue","name":"Retrieves the list of available products for credit agreements.","summary":"Retrieves the credit agreements product catalogue.","tags":[],"parameters":[{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"CreditAgreementsProductCatalogueResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/creditAgreements/drawings/{drawingId}/pendingActivities","fullPath":"/api/v4.3.0/holdings/creditAgreements/drawings/{drawingId}/pendingActivities","operationId":"getPendingActivities","name":"Retrieves the details such as rollover date, rollover status etc of pending drawdowns and rollovers for a drawing.","summary":"Retrieves the details of pending drawdowns and rollovers for a drawing.","tags":[],"parameters":[{"name":"drawingId","in":"path","type":"string","required":true,"description":"Identifier of drawings application under the Letter of Credit system that is used to effect the transfer of funds and the acceptance of documents under Letters of Credit and Documentary Collection tra"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"PendingActivitiesResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/creditAgreements/drawings/expiries","fullPath":"/api/v4.3.0/holdings/creditAgreements/drawings/expiries","operationId":"getLoansExpiring","name":"Retrieves the drawings expiring in the next 7 days.","summary":"Retrieves expiring drawings.","tags":[],"parameters":[{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"LoansExpiringResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/creditAgreements/facilities/expiries","fullPath":"/api/v4.3.0/holdings/creditAgreements/facilities/expiries","operationId":"getFacilitiesExpiring","name":"Retrieves the facilities expiring in the next 7 days","summary":"Retrieves expiring facilities","tags":[],"parameters":[{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"FacilitiesExpiringResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/creditAgreements/drawings/{drawingId}/balances","fullPath":"/api/v4.3.0/holdings/creditAgreements/drawings/{drawingId}/balances","operationId":"getDrawingBalances","name":"Retrieves the balance details such as commitment balances, utilized balances.","summary":"Retrieves drawing balances","tags":[],"parameters":[{"name":"drawingId","in":"path","type":"string","required":true,"description":"Identifier of drawings application under the Letter of Credit system that is used to effect the transfer of funds and the acceptance of documents under Letters of Credit and Documentary Collection tra"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"DrawingBalancesResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/creditAgreements/drawings/{drawingId}/OverdueBalances","fullPath":"/api/v4.3.0/holdings/creditAgreements/drawings/{drawingId}/OverdueBalances","operationId":"getDrawingOverdueBalances","name":"Retrieves the past dues and overdues for a drawing","summary":"Retrieves drawing overdue balances","tags":[],"parameters":[{"name":"drawingId","in":"path","type":"string","required":true,"description":"Identifier of drawings application under the Letter of Credit system that is used to effect the transfer of funds and the acceptance of documents under Letters of Credit and Documentary Collection tra"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"DrawingOverdueBalancesResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"POST","path":"/holdings/creditAgreements/facilities/clubFacilities","fullPath":"/api/v4.3.0/holdings/creditAgreements/facilities/clubFacilities","operationId":"createClubFacilities","name":"Creates a club facility with facility details along with the details of participating lenders","summary":"Creates a club facility","tags":[],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"customers":[{}],"productId":"string","currency":"string","effectiveDate":"2024-01-01","extensionData":{},"account":[{}],"settlement":[{}],"facommitment":[{}],"upfrontfee":[{}],"coordinationfee":[{}],"limit":[{}],"participant":[{}],"riskparticipant":[{}]}},"responses":{"200":"createClubFacilitiesResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"POST","path":"/holdings/creditAgreements/facilities/drawings/clubDrawings","fullPath":"/api/v4.3.0/holdings/creditAgreements/facilities/drawings/clubDrawings","operationId":"createClubDrawings","name":"Creates a club drawing arrangement with drawdown details along with the details of participating lenders","summary":"Creates a club drawing","tags":[],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"customers":[{}],"arrangmentId":"string","currency":"string","facilityId":"string","effectiveDate":"string","activity":"string","productId":"string","extensionData":{},"account":[{}],"escrow":[{}],"dwcommitment":[{}],"settlement":[{}],"participant":[{}],"riskparticipant":[{}]}},"responses":{"200":"createClubDrawingsResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"GET","path":"/holdings/creditAgreements/facilities/drawings/{drawingId}/participants","fullPath":"/api/v4.3.0/holdings/creditAgreements/facilities/drawings/{drawingId}/participants","operationId":"getClubDrawingParticipants","name":"Retrieves the participation details of the lending arrangement for a customer. This will be used to view the agent bank and the participant details and the share amounts when an arrangement id is passed as an input.","summary":"Retrieves the participant details","tags":[],"parameters":[{"name":"drawingId","in":"path","type":"string","required":true,"description":"Identifier of drawings application under the Letter of Credit system that is used to effect the transfer of funds and the acceptance of documents under Letters of Credit and Documentary Collection tra"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"ClubDrawingParticipantsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"POST","path":"/holdings/creditAgreements/facilities/{facilityId}/fundedShareTransfers","fullPath":"/api/v4.3.0/holdings/creditAgreements/facilities/{facilityId}/fundedShareTransfers","operationId":"createFacilityFundedShareTransfer","name":"Creates a funded share transfer for a facility when participant details are passed. Share of a funding participant is transferred to another funding participant in a club facility  and underlying drawings","summary":"Creates a funded share transfer for a facility","tags":[],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"facilityId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"productId":"string","effectiveDate":"2024-01-01","extensionData":{},"shareTransfer":[{}]}},"responses":{"200":"createFacilityFundedShareTransferResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"POST","path":"/holdings/creditAgreements/facilities/drawings/{drawingId}/fundedShareTransfers","fullPath":"/api/v4.3.0/holdings/creditAgreements/facilities/drawings/{drawingId}/fundedShareTransfers","operationId":"createDrawingFundedShareTransfer","name":"Creates a funded share transfer for a drawing under a facility when participant details are passed. Share of a funding participant is transferred to another funding participant in a standalone club loan","summary":"Creates a funded share transfer for a drawing","tags":[],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"drawingId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"productId":"string","effectiveDate":"2024-01-01","extensionData":{},"shareTransfer":[{}]}},"responses":{"200":"createDrawingFundedShareTransferResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"POST","path":"/holdings/creditAgreements/facilities/{facilityId}/riskShareTransfers","fullPath":"/api/v4.3.0/holdings/creditAgreements/facilities/{facilityId}/riskShareTransfers","operationId":"createFacilityRiskShareTransfer","name":"Creates a risk share transfer for a facility when participant details are passed. The risk of the own bank in a facility is mitigated by selling a portion risk to another financial institution","summary":"Creates a risk share transfer for a facility","tags":[],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"facilityId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"productId":"string","effectiveDate":"2024-01-01","extensionData":{},"shareTransfer":[{}]}},"responses":{"200":"createFacilityRiskShareTransferResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"POST","path":"/holdings/creditAgreements/facilities/drawings/{drawingId}/riskShareTransfers","fullPath":"/api/v4.3.0/holdings/creditAgreements/facilities/drawings/{drawingId}/riskShareTransfers","operationId":"createDrawingRiskShareTransfer","name":"Creates a risk share transfer for a drawing under a facility when participant details are passed. The risk of the own bank in a loan is mitigated by selling  a portion risk to another financial institution","summary":"Creates a risk share transfer for a drawing","tags":[],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"drawingId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"productId":"string","effectiveDate":"2024-01-01","extensionData":{},"shareTransfer":[{}]}},"responses":{"200":"createDrawingRiskShareTransferResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}}]},{"key":"holdings-creditAgreements-api-service-v4.4.0","title":"Corporate Credit Agreements","version":"v4.4.0","description":"API for the creation and management of credit agreements for Corporate customers. The types of credit agreements are Single Level Facility, Credit Agreement with Multiple Facilities, Club Loans with Agency and Syndicated Loans.","endpointCount":48,"endpoints":[{"method":"POST","path":"/holdings/creditAgreements/deals/offers","fullPath":"/api/v4.4.0/holdings/creditAgreements/deals/offers","operationId":"createDealOffer","name":"Creates new offer deal for the required customer when the mandatory input details are provided. Offer deal creates a draft contract and allows the users to negotiate multiple times. Offer deal is a draft contract and will not affect the balance sheet of the bank.","summary":"Creates an offer for a deal contract","tags":[],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"customers":[{}],"productId":"string","currency":"string","effectiveDate":"2024-01-01","activity":"string","extensionData":{},"settlement":[{}],"facilityRules":[{}],"dacommitment":[{}],"adminfee":[{}],"coordinationfee":[{}],"upfrontfee":[{}],"limit":[{}]}},"responses":{"200":"createDealOfferResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"POST","path":"/holdings/creditAgreements/facilities/offers","fullPath":"/api/v4.4.0/holdings/creditAgreements/facilities/offers","operationId":"createFacilityOffer","name":"Creates a new offer facility for the required customer when at least the mandatory input is provided. Offer facility creates a draft contract and allow the users to negotiate multiple times. Offer facility is a draft contract and will not affect the balance sheet of the bank.","summary":"Creates an offer for a facility contract","tags":[],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"customers":[{}],"productId":"string","currency":"string","dealId":"string","effectiveDate":"2024-01-01","activity":"string","extensionData":{},"settlement":[{}],"facommitment":[{}],"upfrontfee":[{}],"coordinationfee":[{}],"limit":[{}]}},"responses":{"200":"createFacilityOfferResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"POST","path":"/holdings/creditAgreements/deals/offers/cancellations/{arrangementId}","fullPath":"/api/v4.4.0/holdings/creditAgreements/deals/offers/cancellations/{arrangementId}","operationId":"deleteDealOffer","name":"Deletes a new offer for the required deal contract when at least the mandatory input is provided. Deal offer is a draft contract, which allow the user to delete the contract online and deal offer contract will not affect the balance sheet of the bank.","summary":"Deletes an offer for a deal contract","tags":[],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"arrangementId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"productId":"string","effectiveDate":"2024-01-01","extensionData":{}}},"responses":{"200":"deleteDealOfferResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"POST","path":"/holdings/creditAgreements/facilities/offers/cancellations/{arrangementId}","fullPath":"/api/v4.4.0/holdings/creditAgreements/facilities/offers/cancellations/{arrangementId}","operationId":"deleteFacilityOffer","name":"Deletes a new offer for the required facility contract when at least the mandatory input is provided. Facility offer is a draft contract, which allow the user to delete the contract online and facility offer contract will not affect the balance sheet of the bank.","summary":"Deletes an offer for a facility contract","tags":[],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"arrangementId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"productId":"string","effectiveDate":"2024-01-01","extensionData":{}}},"responses":{"200":"deleteFacilityOfferResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"POST","path":"/holdings/creditAgreements/deals/offers/acceptances/{arrangementId}","fullPath":"/api/v4.4.0/holdings/creditAgreements/deals/offers/acceptances/{arrangementId}","operationId":"acceptDealOffer","name":"On executing acceptance, the contract is changed from offer to live deal for the required customer when at least the mandatory input is provided. Process will check all the required mandatory inputs and prompt an error message when mandatory details are not provided. Once the accept deal offer is processed further offer negotiation is not allowed.","summary":"Accept the deal offer and execute the contract to live","tags":[],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"arrangementId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"productId":"string","effectiveDate":"2024-01-01","extensionData":{},"settlement":[{}],"facilityRules":[{}],"dacommitment":[{}],"adminfee":[{}],"coordinationfee":[{}],"upfrontfee":[{}],"limit":[{}]}},"responses":{"200":"acceptDealOfferResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"POST","path":"/holdings/creditAgreements/facilities/offers/acceptances/{arrangementId}","fullPath":"/api/v4.4.0/holdings/creditAgreements/facilities/offers/acceptances/{arrangementId}","operationId":"acceptFacilityOffer","name":"On executing acceptance, the contract is changed from offer to live facility for the required customer when at least the mandatory input is provided. Process will check all the required mandatory inputs and prompt an error message when mandatory details are not provided. Once the accept deal offer is processed further offer negotiation is not allowed.","summary":"Accept the facility offer and execute the contract to live","tags":[],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"arrangementId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"productId":"string","effectiveDate":"2024-01-01","extensionData":{},"settlement":[{}],"facommitment":[{}],"upfrontfee":[{}],"coordinationfee":[{}],"limit":[{}]}},"responses":{"200":"acceptFacilityOfferResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"POST","path":"/holdings/creditAgreements/drawdowns/offers","fullPath":"/api/v4.4.0/holdings/creditAgreements/drawdowns/offers","operationId":"createDrawdownOffer","name":"Creates a new drawdown offer for the required customer. ","summary":"Creates a new drawdown offer for the required customer. ","tags":[],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"customers":[{}],"productId":"string","currency":"string","facilityId":"string","offerDate":"2024-01-01","drawdownDate":"2024-01-01","activity":"string","extensionData":{},"maintenancefee":[{}],"dwcommitment":[{}],"settlement":[{}]}},"responses":{"200":"createDrawdownOfferResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"POST","path":"/holdings/creditAgreements/drawdowns/offers/negotiations","fullPath":"/api/v4.4.0/holdings/creditAgreements/drawdowns/offers/negotiations","operationId":"createOfferDrawdownRenegotiation","name":"Renegotiate the offer drawdown for the required customer.","summary":"Renegotiate the offer drawdown for the required customer.","tags":[],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"productId":"string","drawdownDate":"2024-01-01","extensionData":{},"maintenancefee":[{}],"settlement":[{}]}},"responses":{"200":"createOfferDrawdownRenegotiationResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"POST","path":"/holdings/creditAgreements/drawdowns/offers/cancellations","fullPath":"/api/v4.4.0/holdings/creditAgreements/drawdowns/offers/cancellations","operationId":"deleteDrawdownOffer","name":"Cancellation of offer drawdown for the required customer.","summary":"Cancellation of offer drawdown for the required customer.","tags":[],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"productId":"string","drawdownDate":"2024-01-01","extensionData":{}}},"responses":{"200":"deleteDrawdownOfferResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"POST","path":"/holdings/creditAgreements/drawdowns/offers/acceptances","fullPath":"/api/v4.4.0/holdings/creditAgreements/drawdowns/offers/acceptances","operationId":"acceptOfferDrawdown","name":"Convert an offer drawdown to a live drawdown for the required customer.","summary":"Convert an offer drawdown to a live drawdown for the required customer.","tags":[],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"productId":"string","drawdownDate":"2024-01-01","extensionData":{},"maintenancefee":[{}],"dwcommitment":[{}],"settlement":[{}]}},"responses":{"200":"acceptOfferDrawdownResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"GET","path":"/holdings/creditAgreements/facilities/{facilityId}/drawingProducts","fullPath":"/api/v4.4.0/holdings/creditAgreements/facilities/{facilityId}/drawingProducts","operationId":"getFacilityDrawingProducts","name":"Retrieves the available drawing products under the facility ","summary":"Retrieves the available drawing products under the facility ","tags":[],"parameters":[{"name":"facilityId","in":"path","type":"string","required":true,"description":"Unique identifier (contract number) of the facility"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"FacilityDrawingProductsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/creditAgreements/facilities/{facilityId}/combinedSchedules","fullPath":"/api/v4.4.0/holdings/creditAgreements/facilities/{facilityId}/combinedSchedules","operationId":"getCombinedSchedules","name":"Retrieves the payment schedule of facility and its drawings","summary":"Retrieves the payment schedule of facility and its drawings","tags":[],"parameters":[{"name":"facilityId","in":"path","type":"string","required":true,"description":"Unique identifier (contract number) of the facility"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"CombinedSchedulesResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"POST","path":"/holdings/creditAgreements/facilities","fullPath":"/api/v4.4.0/holdings/creditAgreements/facilities","operationId":"createFacilities","name":"Creates corporate facilities","summary":"Creates corporate facilities","tags":[],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"customers":[{}],"productId":"string","currency":"string","effectiveDate":"2024-01-01","extensionData":{},"settlement":[{}],"facommitment":[{}],"upfrontfee":[{}],"coordinationfee":[{}],"limit":[{}]}},"responses":{"200":"createFacilitiesResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"POST","path":"/holdings/creditAgreements/drawdowns","fullPath":"/api/v4.4.0/holdings/creditAgreements/drawdowns","operationId":"createDrawdowns","name":"Creates drawdowns under facility","summary":"Creates drawdowns under facility","tags":[],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"customers":[{}],"arrangmentId":"string","currency":"string","facilityId":"string","effectiveDate":"string","activity":"string","productId":"string","extensionData":{},"escrow":[{}],"dwcommitment":[{}],"settlement":[{}]}},"responses":{"200":"createDrawdownsResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"GET","path":"/holdings/creditAgreements/facilities/{facilityId}/drawingRules","fullPath":"/api/v4.4.0/holdings/creditAgreements/facilities/{facilityId}/drawingRules","operationId":"getFacilityDrawingRules","name":"Retrieves the allowed customers, currencies and products for a new drawing under the facility","summary":"Retrieves the allowed customers, currencies and products for a new drawing under the facility","tags":[],"parameters":[{"name":"facilityId","in":"path","type":"string","required":true,"description":"Unique identifier (contract number) of the facility"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"FacilityDrawingRulesResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/creditAgreements/facilities/{facilityId}/drawings","fullPath":"/api/v4.4.0/holdings/creditAgreements/facilities/{facilityId}/drawings","operationId":"getDrawingsUnderFacility","name":"Retrieves the drawings under a facility","summary":"Retrieves the drawings under a facility","tags":[],"parameters":[{"name":"facilityId","in":"path","type":"string","required":true,"description":"Unique identifier (contract number) of the facility"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"DrawingsUnderFacilityResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/creditAgreements/facilities/drawings/{drawingId}/parentFacilities","fullPath":"/api/v4.4.0/holdings/creditAgreements/facilities/drawings/{drawingId}/parentFacilities","operationId":"getDrawingFacility","name":"Retrieves the parent facility for a drawing","summary":"Retrieves the parent facility for a drawing","tags":[],"parameters":[{"name":"drawingId","in":"path","type":"string","required":true,"description":"Identifier of drawings application under the Letter of Credit system that is used to effect the transfer of funds and the acceptance of documents under Letters of Credit and Documentary Collection tra"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"DrawingFacilityResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/creditAgreements/facilities/{facilityId}/commitmentSchedules","fullPath":"/api/v4.4.0/holdings/creditAgreements/facilities/{facilityId}/commitmentSchedules","operationId":"getFacilityCommitmentSchedule","name":"Retrieves the commitment schedule of a facility","summary":"Retrieves the commitment schedule of a facility","tags":[],"parameters":[{"name":"facilityId","in":"path","type":"string","required":true,"description":"Unique identifier (contract number) of the facility"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"FacilityCommitmentScheduleResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/creditAgreements/facilities/{facilityId}/parentDeals","fullPath":"/api/v4.4.0/holdings/creditAgreements/facilities/{facilityId}/parentDeals","operationId":"getFacilityDeal","name":"Retrieves the parent deal for a facility","summary":"Retrieves the parent deal for a facility","tags":[],"parameters":[{"name":"facilityId","in":"path","type":"string","required":true,"description":"Unique identifier (contract number) of the facility"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"FacilityDealResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/creditAgreements/facilities/{facilityId}/balances","fullPath":"/api/v4.4.0/holdings/creditAgreements/facilities/{facilityId}/balances","operationId":"getFacilityFinancialSummary","name":"Retrieves the financial summary for a facility arrangement","summary":"Retrieves the financial summary for a facility arrangement","tags":[],"parameters":[{"name":"facilityId","in":"path","type":"string","required":true,"description":"Unique identifier (contract number) of the facility"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"FacilityFinancialSummaryResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/creditAgreements/facilities/{facilityId}/consolidatedBalances","fullPath":"/api/v4.4.0/holdings/creditAgreements/facilities/{facilityId}/consolidatedBalances","operationId":"getFacilityConsolidatedBalances","name":"Retrieves the consolidated balances for a facility arrangement","summary":"Retrieves the consolidated balances for a facility arrangement","tags":[],"parameters":[{"name":"facilityId","in":"path","type":"string","required":true,"description":"Unique identifier (contract number) of the facility"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"FacilityConsolidatedBalancesResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"POST","path":"/holdings/creditAgreements/facilities/directDebits","fullPath":"/api/v4.4.0/holdings/creditAgreements/facilities/directDebits","operationId":"createFacilityDirectDebitLink","name":"Links a direct debit to an existing facility","summary":"Links a direct debit to a facility","tags":[],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"customers":[{}],"arrangement":"string","productId":"string","currency":"string","effectiveDate":"2024-01-01","extensionData":{},"settlement":[{}]}},"responses":{"200":"createFacilityDirectDebitLinkResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"POST","path":"/holdings/creditAgreements/facilities/drawings/directDebits","fullPath":"/api/v4.4.0/holdings/creditAgreements/facilities/drawings/directDebits","operationId":"createDrawingDirectDebitLink","name":"Link the direct debit to an existing drawing under a facility","summary":"Links a direct debit to a drawing","tags":[],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"customers":[{}],"arrangement":"string","currency":"string","facilityId":"string","effectiveDate":"string","productId":"string","extensionData":{},"settlement":[{}]}},"responses":{"200":"createDrawingDirectDebitLinkResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"POST","path":"/holdings/creditAgreements/facilities/rollovers/offers","fullPath":"/api/v4.4.0/holdings/creditAgreements/facilities/rollovers/offers","operationId":"createFacilityRolloverOffer","name":"Create rollover process from the facility where the rollover could be a split rollover, merge rollover or a one to one rollover. Split also called as one to many will rollover an old loan and create multiple new offer loans. Merge also called as many to one will rollover multiple old loans simultaneously and create a single new offer loan. Rollover also called as one to one will simply rollover an old loan and create a new offer loan","summary":"Create rollover offer from facility","tags":[],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"arrangement":"string","rolloverDate":"string","extensionData":{},"splitsMerges":[{}]}},"responses":{"200":"createFacilityRolloverOfferResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"POST","path":"/holdings/creditAgreements/drawdowns/rollovers/offers","fullPath":"/api/v4.4.0/holdings/creditAgreements/drawdowns/rollovers/offers","operationId":"createDrawdownRolloverOffer","name":"Create rollover process from the drawdown where the rollover could be a split rollover, merge rollover or a one to one rollover. Split also called as one to many will rollover an old loan and create multiple new offer loans. Merge also called as many to one will rollover multiple old loans simultaneously and create a single new offer loan. Rollover also called as one to one will simply rollover an old loan and create a new offer loan","summary":"Create rollover offer from drawdown","tags":[],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"arrangement":"string","rolloverDate":"string","extensionData":{},"splitsMerges":[{}]}},"responses":{"200":"createDrawdownRolloverOfferResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"POST","path":"/holdings/creditAgreements/facilities/commitmentIncreases/{arrangementId}","fullPath":"/api/v4.4.0/holdings/creditAgreements/facilities/commitmentIncreases/{arrangementId}","operationId":"updateFacilityCommitmentIncrease","name":"Increase the facility amount to facilitate further drawdowns","summary":"Increase facility amount","tags":[],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"arrangementId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"productId":"string","effectiveDate":"2024-01-01","extensionData":{},"facommitment":[{}]}},"responses":{"200":"updateFacilityCommitmentIncreaseResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"POST","path":"/holdings/creditAgreements/facilities/commitmentTerms/{arrangementId}","fullPath":"/api/v4.4.0/holdings/creditAgreements/facilities/commitmentTerms/{arrangementId}","operationId":"updateFacilityCommitmentTerms","name":"Updates facility tenure by increasing or decreasing the term, in addition it allows the amendment of the availability schedule of the contract.","summary":"Update facility maturity date and availability","tags":[],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"arrangementId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"productId":"string","effectiveDate":"2024-01-01","extensionData":{},"facommitment":[{}]}},"responses":{"200":"updateFacilityCommitmentTermsResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"GET","path":"/holdings/customers/{customerId}/creditAgreements/exposure","fullPath":"/api/v4.4.0/holdings/customers/{customerId}/creditAgreements/exposure","operationId":"getCustomerExposure","name":"Retrieves the customer exposure such as the facility number, type of facility, maturity date and various amounts of the facilities/standalone loans.","summary":"Retrieves the customer exposure for facilities and loans","tags":[],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"Identifier of the customer"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"CustomerExposureResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/customers/{customerId}/creditAgreements/drawings","fullPath":"/api/v4.4.0/holdings/customers/{customerId}/creditAgreements/drawings","operationId":"getCustomerDrawings","name":"Retrieves the details such as the drawing id, account number, short description of the loan, customer name and loan status for a customer. ","summary":"Retrieves the drawing details for a customer.","tags":[],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"Identifier of the customer"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"CustomerDrawingsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/customers/{customerId}/creditAgreements/facilities","fullPath":"/api/v4.4.0/holdings/customers/{customerId}/creditAgreements/facilities","operationId":"getCustomerFacilities","name":"Retrieves the details such as the facility id, account number, short description of the facility, customer name and facility status for a customer.","summary":"Retrieves the facility details for a customer.","tags":[],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"Identifier of the customer"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"CustomerFacilitiesResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/customers/{customerId}/creditAgreements/deals","fullPath":"/api/v4.4.0/holdings/customers/{customerId}/creditAgreements/deals","operationId":"getCustomerDeals","name":"Retrieves the details such as the deal id, account number, short description of the facility, customer name and deal status for a customer.","summary":"Retrieves the deal details for a customer.","tags":[],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"Identifier of the customer"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"CustomerDealsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/creditAgreements/deals/{dealId}/facilities","fullPath":"/api/v4.4.0/holdings/creditAgreements/deals/{dealId}/facilities","operationId":"getFacilitiesUnderDeal","name":"Retrieves the details such as facility id, title, currency, status and commitment amount for all the facilities under a deal.","summary":"Retrieves the details of facilities under a deal.","tags":[],"parameters":[{"name":"dealId","in":"path","type":"string","required":true,"description":"Unique identifier (contract number) of the corporate deals"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"FacilitiesUnderDealResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/creditAgreements/productCatalogues","fullPath":"/api/v4.4.0/holdings/creditAgreements/productCatalogues","operationId":"getCreditAgreementsProductCatalogue","name":"Retrieves the list of available products for credit agreements.","summary":"Retrieves the credit agreements product catalogue.","tags":[],"parameters":[{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"CreditAgreementsProductCatalogueResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/creditAgreements/drawings/{drawingId}/pendingActivities","fullPath":"/api/v4.4.0/holdings/creditAgreements/drawings/{drawingId}/pendingActivities","operationId":"getPendingActivities","name":"Retrieves the details such as rollover date, rollover status etc of pending drawdowns and rollovers for a drawing.","summary":"Retrieves the details of pending drawdowns and rollovers for a drawing.","tags":[],"parameters":[{"name":"drawingId","in":"path","type":"string","required":true,"description":"Identifier of drawings application under the Letter of Credit system that is used to effect the transfer of funds and the acceptance of documents under Letters of Credit and Documentary Collection tra"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"PendingActivitiesResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/creditAgreements/drawings/expiries","fullPath":"/api/v4.4.0/holdings/creditAgreements/drawings/expiries","operationId":"getLoansExpiring","name":"Retrieves the drawings expiring in the next 7 days.","summary":"Retrieves expiring drawings.","tags":[],"parameters":[{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"LoansExpiringResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/creditAgreements/facilities/expiries","fullPath":"/api/v4.4.0/holdings/creditAgreements/facilities/expiries","operationId":"getFacilitiesExpiring","name":"Retrieves the facilities expiring in the next 7 days","summary":"Retrieves expiring facilities","tags":[],"parameters":[{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"FacilitiesExpiringResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/creditAgreements/drawings/{drawingId}/balances","fullPath":"/api/v4.4.0/holdings/creditAgreements/drawings/{drawingId}/balances","operationId":"getDrawingBalances","name":"Retrieves the balance details such as commitment balances, utilized balances.","summary":"Retrieves drawing balances","tags":[],"parameters":[{"name":"drawingId","in":"path","type":"string","required":true,"description":"Identifier of drawings application under the Letter of Credit system that is used to effect the transfer of funds and the acceptance of documents under Letters of Credit and Documentary Collection tra"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"DrawingBalancesResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/creditAgreements/drawings/{drawingId}/OverdueBalances","fullPath":"/api/v4.4.0/holdings/creditAgreements/drawings/{drawingId}/OverdueBalances","operationId":"getDrawingOverdueBalances","name":"Retrieves the past dues and overdues for a drawing","summary":"Retrieves drawing overdue balances","tags":[],"parameters":[{"name":"drawingId","in":"path","type":"string","required":true,"description":"Identifier of drawings application under the Letter of Credit system that is used to effect the transfer of funds and the acceptance of documents under Letters of Credit and Documentary Collection tra"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"DrawingOverdueBalancesResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"POST","path":"/holdings/creditAgreements/facilities/clubFacilities","fullPath":"/api/v4.4.0/holdings/creditAgreements/facilities/clubFacilities","operationId":"createClubFacilities","name":"Creates a club facility with facility details along with the details of participating lenders","summary":"Creates a club facility","tags":[],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"customers":[{}],"productId":"string","currency":"string","effectiveDate":"2024-01-01","extensionData":{},"account":[{}],"settlement":[{}],"facommitment":[{}],"upfrontfee":[{}],"coordinationfee":[{}],"limit":[{}],"participant":[{}],"riskparticipant":[{}]}},"responses":{"200":"createClubFacilitiesResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"POST","path":"/holdings/creditAgreements/facilities/drawings/clubDrawings","fullPath":"/api/v4.4.0/holdings/creditAgreements/facilities/drawings/clubDrawings","operationId":"createClubDrawings","name":"Creates a club drawing arrangement with drawdown details along with the details of participating lenders","summary":"Creates a club drawing","tags":[],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"customers":[{}],"arrangmentId":"string","currency":"string","facilityId":"string","effectiveDate":"string","activity":"string","productId":"string","extensionData":{},"account":[{}],"escrow":[{}],"dwcommitment":[{}],"settlement":[{}],"participant":[{}],"riskparticipant":[{}]}},"responses":{"200":"createClubDrawingsResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"GET","path":"/holdings/creditAgreements/facilities/drawings/{drawingId}/participants","fullPath":"/api/v4.4.0/holdings/creditAgreements/facilities/drawings/{drawingId}/participants","operationId":"getClubDrawingParticipants","name":"Retrieves the participation details of the lending arrangement for a customer. This will be used to view the agent bank and the participant details and the share amounts when an arrangement id is passed as an input.","summary":"Retrieves the participant details","tags":[],"parameters":[{"name":"drawingId","in":"path","type":"string","required":true,"description":"Identifier of drawings application under the Letter of Credit system that is used to effect the transfer of funds and the acceptance of documents under Letters of Credit and Documentary Collection tra"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"ClubDrawingParticipantsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"POST","path":"/holdings/creditAgreements/facilities/{facilityId}/fundedShareTransfers","fullPath":"/api/v4.4.0/holdings/creditAgreements/facilities/{facilityId}/fundedShareTransfers","operationId":"createFacilityFundedShareTransfer","name":"Creates a funded share transfer for a facility when participant details are passed. Share of a funding participant is transferred to another funding participant in a club facility and underlying drawings","summary":"Creates a funded share transfer for a facility","tags":[],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"facilityId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"productId":"string","effectiveDate":"2024-01-01","extensionData":{},"shareTransfer":[{}]}},"responses":{"200":"createFacilityFundedShareTransferResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"POST","path":"/holdings/creditAgreements/facilities/drawings/{drawingId}/fundedShareTransfers","fullPath":"/api/v4.4.0/holdings/creditAgreements/facilities/drawings/{drawingId}/fundedShareTransfers","operationId":"createDrawingFundedShareTransfer","name":"Creates a funded share transfer for a drawing under a facility when participant details are passed. Share of a funding participant is transferred to another funding participant in a standalone club loan","summary":"Creates a funded share transfer for a drawing","tags":[],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"drawingId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"productId":"string","effectiveDate":"2024-01-01","extensionData":{},"shareTransfer":[{}]}},"responses":{"200":"createDrawingFundedShareTransferResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"POST","path":"/holdings/creditAgreements/facilities/{facilityId}/riskShareTransfers","fullPath":"/api/v4.4.0/holdings/creditAgreements/facilities/{facilityId}/riskShareTransfers","operationId":"createFacilityRiskShareTransfer","name":"Creates a risk share transfer for a facility when participant details are passed. The risk of the own bank in a facility is mitigated by selling a portion risk to another financial institution","summary":"Creates a risk share transfer for a facility","tags":[],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"facilityId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"productId":"string","effectiveDate":"2024-01-01","extensionData":{},"shareTransfer":[{}]}},"responses":{"200":"createFacilityRiskShareTransferResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"POST","path":"/holdings/creditAgreements/facilities/drawings/{drawingId}/riskShareTransfers","fullPath":"/api/v4.4.0/holdings/creditAgreements/facilities/drawings/{drawingId}/riskShareTransfers","operationId":"createDrawingRiskShareTransfer","name":"Creates a risk share transfer for a drawing under a facility when participant details are passed. The risk of the own bank in a loan is mitigated by selling a portion risk to another financial institution","summary":"Creates a risk share transfer for a drawing","tags":[],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"drawingId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"productId":"string","effectiveDate":"2024-01-01","extensionData":{},"shareTransfer":[{}]}},"responses":{"200":"createDrawingRiskShareTransferResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"POST","path":"/holdings/creditAgreements/guarantees/{guaranteeId}/guaranteeIncreases","fullPath":"/api/v4.4.0/holdings/creditAgreements/guarantees/{guaranteeId}/guaranteeIncreases","operationId":"updateGuaranteeCommitmentIncrease","name":"Increase the commitment amount of the guarantee that the financial institution has issued on behalf of the applicant","summary":"Increase the commitment amount of the guarantee","tags":[],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"guaranteeId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"productId":"string","effectiveDate":"2024-01-01","extensionData":{},"gteecommitment":[{}]}},"responses":{"200":"updateGuaranteeCommitmentIncreaseResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"POST","path":"/holdings/creditAgreements/guarantees/{guaranteeId}/guaranteeDecreases","fullPath":"/api/v4.4.0/holdings/creditAgreements/guarantees/{guaranteeId}/guaranteeDecreases","operationId":"updateGuaranteeCommitmentDecrease","name":"Decrease the commitment amount of the guarantee that the financial institution has issued on behalf of the applicant","summary":"Decrease the commitment amount of the guarantee","tags":[],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"guaranteeId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"productId":"string","effectiveDate":"2024-01-01","extensionData":{},"gteecommitment":[{}]}},"responses":{"200":"updateGuaranteeCommitmentDecreaseResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"POST","path":"/holdings/creditAgreements/guarantees","fullPath":"/api/v4.4.0/holdings/creditAgreements/guarantees","operationId":"createCreditAgreementGuarantee","name":"Register the issuance of a new guarantee undertaking on behalf of the applicant when all the basic details relevant to the undertaking are passed","summary":"Register the issuance of a guarantee","tags":[],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"customers":[{}],"productId":"string","currency":"string","effectiveDate":"2024-01-01","facilityId":"string","extensionData":{},"gteecommitment":[{}],"newarrfee":[{}],"settlement":[{}],"termsConditions":[{}]}},"responses":{"200":"createCreditAgreementGuaranteeResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}}]},{"key":"holdings-creditAgreements-api-service-v4.5.0","title":"Corporate Credit Agreements","version":"v4.5.0","description":"API for the creation and management of credit agreements for Corporate customers. The types of credit agreements are Single Level Facility, Credit Agreement with Multiple Facilities, Club Loans with Agency and Syndicated Loans.","endpointCount":50,"endpoints":[{"method":"POST","path":"/holdings/creditAgreements/deals/offers","fullPath":"/api/v4.5.0/holdings/creditAgreements/deals/offers","operationId":"createDealOffer","name":"Creates new offer deal for the required customer when the mandatory input details are provided. Offer deal creates a draft contract and allows the users to negotiate multiple times. Offer deal is a draft contract and will not affect the balance sheet of the bank.","summary":"Creates an offer for a deal contract","tags":[],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"customers":[{}],"productId":"string","currency":"string","effectiveDate":"2024-01-01","activity":"string","extensions":{},"settlement":[{}],"facilityRules":[{}],"dacommitment":[{}],"adminfee":[{}],"coordinationfee":[{}],"upfrontfee":[{}],"limit":[{}]}},"responses":{"200":"createDealOfferResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"POST","path":"/holdings/creditAgreements/facilities/offers","fullPath":"/api/v4.5.0/holdings/creditAgreements/facilities/offers","operationId":"createFacilityOffer","name":"Creates a new offer facility for the required customer when at least the mandatory input is provided. Offer facility creates a draft contract and allow the users to negotiate multiple times. Offer facility is a draft contract and will not affect the balance sheet of the bank.","summary":"Creates an offer for a facility contract","tags":[],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"customers":[{}],"productId":"string","currency":"string","dealId":"string","effectiveDate":"2024-01-01","activity":"string","extensions":{},"settlement":[{}],"facommitment":[{}],"upfrontfee":[{}],"coordinationfee":[{}],"limit":[{}]}},"responses":{"200":"createFacilityOfferResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"POST","path":"/holdings/creditAgreements/deals/offers/cancellations/{arrangementId}","fullPath":"/api/v4.5.0/holdings/creditAgreements/deals/offers/cancellations/{arrangementId}","operationId":"deleteDealOffer","name":"Deletes a new offer for the required deal contract when at least the mandatory input is provided. Deal offer is a draft contract, which allow the user to delete the contract online and deal offer contract will not affect the balance sheet of the bank.","summary":"Deletes an offer for a deal contract","tags":[],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"arrangementId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"productId":"string","effectiveDate":"2024-01-01","extensions":{}}},"responses":{"200":"deleteDealOfferResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"POST","path":"/holdings/creditAgreements/facilities/offers/cancellations/{arrangementId}","fullPath":"/api/v4.5.0/holdings/creditAgreements/facilities/offers/cancellations/{arrangementId}","operationId":"deleteFacilityOffer","name":"Deletes a new offer for the required facility contract when at least the mandatory input is provided. Facility offer is a draft contract, which allow the user to delete the contract online and facility offer contract will not affect the balance sheet of the bank.","summary":"Deletes an offer for a facility contract","tags":[],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"arrangementId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"productId":"string","effectiveDate":"2024-01-01","extensions":{}}},"responses":{"200":"deleteFacilityOfferResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"POST","path":"/holdings/creditAgreements/deals/offers/acceptances/{arrangementId}","fullPath":"/api/v4.5.0/holdings/creditAgreements/deals/offers/acceptances/{arrangementId}","operationId":"acceptDealOffer","name":"On executing acceptance, the contract is changed from offer to live deal for the required customer when at least the mandatory input is provided. Process will check all the required mandatory inputs and prompt an error message when mandatory details are not provided. Once the accept deal offer is processed further offer negotiation is not allowed.","summary":"Accept the deal offer and execute the contract to live","tags":[],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"arrangementId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"productId":"string","effectiveDate":"2024-01-01","extensions":{},"settlement":[{}],"facilityRules":[{}],"dacommitment":[{}],"adminfee":[{}],"coordinationfee":[{}],"upfrontfee":[{}],"limit":[{}]}},"responses":{"200":"acceptDealOfferResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"POST","path":"/holdings/creditAgreements/facilities/offers/acceptances/{arrangementId}","fullPath":"/api/v4.5.0/holdings/creditAgreements/facilities/offers/acceptances/{arrangementId}","operationId":"acceptFacilityOffer","name":"On executing acceptance, the contract is changed from offer to live facility for the required customer when at least the mandatory input is provided. Process will check all the required mandatory inputs and prompt an error message when mandatory details are not provided. Once the accept deal offer is processed further offer negotiation is not allowed.","summary":"Accept the facility offer and execute the contract to live","tags":[],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"arrangementId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"productId":"string","effectiveDate":"2024-01-01","extensions":{},"settlement":[{}],"facommitment":[{}],"upfrontfee":[{}],"coordinationfee":[{}],"limit":[{}]}},"responses":{"200":"acceptFacilityOfferResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"POST","path":"/holdings/creditAgreements/drawdowns/offers","fullPath":"/api/v4.5.0/holdings/creditAgreements/drawdowns/offers","operationId":"createDrawdownOffer","name":"Creates a new drawdown offer for the required customer. ","summary":"Creates a new drawdown offer for the required customer. ","tags":[],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"customers":[{}],"productId":"string","currency":"string","facilityId":"string","offerDate":"2024-01-01","drawdownDate":"2024-01-01","activity":"string","extensions":{},"maintenancefee":[{}],"dwcommitment":[{}],"settlement":[{}]}},"responses":{"200":"createDrawdownOfferResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"POST","path":"/holdings/creditAgreements/drawdowns/offers/negotiations","fullPath":"/api/v4.5.0/holdings/creditAgreements/drawdowns/offers/negotiations","operationId":"createOfferDrawdownRenegotiation","name":"Renegotiate the offer drawdown for the required customer.","summary":"Renegotiate the offer drawdown for the required customer.","tags":[],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"productId":"string","drawdownDate":"2024-01-01","extensions":{},"maintenancefee":[{}],"settlement":[{}]}},"responses":{"200":"createOfferDrawdownRenegotiationResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"POST","path":"/holdings/creditAgreements/drawdowns/offers/cancellations","fullPath":"/api/v4.5.0/holdings/creditAgreements/drawdowns/offers/cancellations","operationId":"deleteDrawdownOffer","name":"Cancellation of offer drawdown for the required customer.","summary":"Cancellation of offer drawdown for the required customer.","tags":[],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"productId":"string","drawdownDate":"2024-01-01","extensions":{}}},"responses":{"200":"deleteDrawdownOfferResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"POST","path":"/holdings/creditAgreements/drawdowns/offers/acceptances","fullPath":"/api/v4.5.0/holdings/creditAgreements/drawdowns/offers/acceptances","operationId":"acceptOfferDrawdown","name":"Convert an offer drawdown to a live drawdown for the required customer.","summary":"Convert an offer drawdown to a live drawdown for the required customer.","tags":[],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"productId":"string","drawdownDate":"2024-01-01","extensions":{},"maintenancefee":[{}],"dwcommitment":[{}],"settlement":[{}]}},"responses":{"200":"acceptOfferDrawdownResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"GET","path":"/holdings/creditAgreements/facilities/{facilityId}/drawingProducts","fullPath":"/api/v4.5.0/holdings/creditAgreements/facilities/{facilityId}/drawingProducts","operationId":"getFacilityDrawingProducts","name":"Retrieves the available drawing products under the facility ","summary":"Retrieves the available drawing products under the facility ","tags":[],"parameters":[{"name":"facilityId","in":"path","type":"string","required":true,"description":"Unique identifier (contract number) of the facility"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"FacilityDrawingProductsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/creditAgreements/facilities/{facilityId}/combinedSchedules","fullPath":"/api/v4.5.0/holdings/creditAgreements/facilities/{facilityId}/combinedSchedules","operationId":"getCombinedSchedules","name":"Retrieves the payment schedule of facility and its drawings","summary":"Retrieves the payment schedule of facility and its drawings","tags":[],"parameters":[{"name":"facilityId","in":"path","type":"string","required":true,"description":"Unique identifier (contract number) of the facility"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"CombinedSchedulesResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"POST","path":"/holdings/creditAgreements/facilities","fullPath":"/api/v4.5.0/holdings/creditAgreements/facilities","operationId":"createFacilities","name":"Creates corporate facilities","summary":"Creates corporate facilities","tags":[],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"customers":[{}],"productId":"string","currency":"string","effectiveDate":"2024-01-01","extensions":{},"settlement":[{}],"facommitment":[{}],"upfrontfee":[{}],"coordinationfee":[{}],"limit":[{}]}},"responses":{"200":"createFacilitiesResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"POST","path":"/holdings/creditAgreements/drawdowns","fullPath":"/api/v4.5.0/holdings/creditAgreements/drawdowns","operationId":"createDrawdowns","name":"Creates drawdowns under facility","summary":"Creates drawdowns under facility","tags":[],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"customers":[{}],"arrangmentId":"string","currency":"string","facilityId":"string","effectiveDate":"string","activity":"string","productId":"string","extensions":{},"escrow":[{}],"dwcommitment":[{}],"settlement":[{}]}},"responses":{"200":"createDrawdownsResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"GET","path":"/holdings/creditAgreements/facilities/{facilityId}/drawingRules","fullPath":"/api/v4.5.0/holdings/creditAgreements/facilities/{facilityId}/drawingRules","operationId":"getFacilityDrawingRules","name":"Retrieves the allowed customers, currencies and products for a new drawing under the facility","summary":"Retrieves the allowed customers, currencies and products for a new drawing under the facility","tags":[],"parameters":[{"name":"facilityId","in":"path","type":"string","required":true,"description":"Unique identifier (contract number) of the facility"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"FacilityDrawingRulesResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/creditAgreements/facilities/{facilityId}/drawings","fullPath":"/api/v4.5.0/holdings/creditAgreements/facilities/{facilityId}/drawings","operationId":"getDrawingsUnderFacility","name":"Retrieves the drawings under a facility","summary":"Retrieves the drawings under a facility","tags":[],"parameters":[{"name":"facilityId","in":"path","type":"string","required":true,"description":"Unique identifier (contract number) of the facility"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"DrawingsUnderFacilityResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/creditAgreements/facilities/drawings/{drawingId}/parentFacilities","fullPath":"/api/v4.5.0/holdings/creditAgreements/facilities/drawings/{drawingId}/parentFacilities","operationId":"getDrawingFacility","name":"Retrieves the parent facility for a drawing","summary":"Retrieves the parent facility for a drawing","tags":[],"parameters":[{"name":"drawingId","in":"path","type":"string","required":true,"description":"Identifier of drawings application under the Letter of Credit system that is used to effect the transfer of funds and the acceptance of documents under Letters of Credit and Documentary Collection tra"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"DrawingFacilityResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/creditAgreements/facilities/{facilityId}/commitmentSchedules","fullPath":"/api/v4.5.0/holdings/creditAgreements/facilities/{facilityId}/commitmentSchedules","operationId":"getFacilityCommitmentSchedule","name":"Retrieves the commitment schedule of a facility","summary":"Retrieves the commitment schedule of a facility","tags":[],"parameters":[{"name":"facilityId","in":"path","type":"string","required":true,"description":"Unique identifier (contract number) of the facility"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"FacilityCommitmentScheduleResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/creditAgreements/facilities/{facilityId}/parentDeals","fullPath":"/api/v4.5.0/holdings/creditAgreements/facilities/{facilityId}/parentDeals","operationId":"getFacilityDeal","name":"Retrieves the parent deal for a facility","summary":"Retrieves the parent deal for a facility","tags":[],"parameters":[{"name":"facilityId","in":"path","type":"string","required":true,"description":"Unique identifier (contract number) of the facility"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"FacilityDealResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/creditAgreements/facilities/{facilityId}/balances","fullPath":"/api/v4.5.0/holdings/creditAgreements/facilities/{facilityId}/balances","operationId":"getFacilityFinancialSummary","name":"Retrieves the financial summary for a facility arrangement","summary":"Retrieves the financial summary for a facility arrangement","tags":[],"parameters":[{"name":"facilityId","in":"path","type":"string","required":true,"description":"Unique identifier (contract number) of the facility"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"FacilityFinancialSummaryResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/creditAgreements/facilities/{facilityId}/consolidatedBalances","fullPath":"/api/v4.5.0/holdings/creditAgreements/facilities/{facilityId}/consolidatedBalances","operationId":"getFacilityConsolidatedBalances","name":"Retrieves the consolidated balances for a facility arrangement","summary":"Retrieves the consolidated balances for a facility arrangement","tags":[],"parameters":[{"name":"facilityId","in":"path","type":"string","required":true,"description":"Unique identifier (contract number) of the facility"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"FacilityConsolidatedBalancesResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"POST","path":"/holdings/creditAgreements/facilities/directDebits","fullPath":"/api/v4.5.0/holdings/creditAgreements/facilities/directDebits","operationId":"createFacilityDirectDebitLink","name":"Links a direct debit to an existing facility","summary":"Links a direct debit to a facility","tags":[],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"customers":[{}],"arrangement":"string","productId":"string","currency":"string","effectiveDate":"2024-01-01","extensions":{},"settlement":[{}]}},"responses":{"200":"createFacilityDirectDebitLinkResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"POST","path":"/holdings/creditAgreements/facilities/drawings/directDebits","fullPath":"/api/v4.5.0/holdings/creditAgreements/facilities/drawings/directDebits","operationId":"createDrawingDirectDebitLink","name":"Link the direct debit to an existing drawing under a facility","summary":"Links a direct debit to a drawing","tags":[],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"customers":[{}],"arrangement":"string","currency":"string","facilityId":"string","effectiveDate":"string","productId":"string","extensions":{},"settlement":[{}]}},"responses":{"200":"createDrawingDirectDebitLinkResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"POST","path":"/holdings/creditAgreements/facilities/rollovers/offers","fullPath":"/api/v4.5.0/holdings/creditAgreements/facilities/rollovers/offers","operationId":"createFacilityRolloverOffer","name":"Create rollover process from the facility where the rollover could be a split rollover, merge rollover or a one to one rollover. Split also called as one to many will rollover an old loan and create multiple new offer loans. Merge also called as many to one will rollover multiple old loans simultaneously and create a single new offer loan. Rollover also called as one to one will simply rollover an old loan and create a new offer loan","summary":"Create rollover offer from facility","tags":[],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"arrangement":"string","rolloverDate":"string","extensions":{},"splitsMerges":[{}]}},"responses":{"200":"createFacilityRolloverOfferResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"POST","path":"/holdings/creditAgreements/drawdowns/rollovers/offers","fullPath":"/api/v4.5.0/holdings/creditAgreements/drawdowns/rollovers/offers","operationId":"createDrawdownRolloverOffer","name":"Create rollover process from the drawdown where the rollover could be a split rollover, merge rollover or a one to one rollover. Split also called as one to many will rollover an old loan and create multiple new offer loans. Merge also called as many to one will rollover multiple old loans simultaneously and create a single new offer loan. Rollover also called as one to one will simply rollover an old loan and create a new offer loan","summary":"Create rollover offer from drawdown","tags":[],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"arrangement":"string","rolloverDate":"string","extensions":{},"splitsMerges":[{}]}},"responses":{"200":"createDrawdownRolloverOfferResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"POST","path":"/holdings/creditAgreements/facilities/commitmentIncreases/{arrangementId}","fullPath":"/api/v4.5.0/holdings/creditAgreements/facilities/commitmentIncreases/{arrangementId}","operationId":"updateFacilityCommitmentIncrease","name":"Increase the facility amount to facilitate further drawdowns","summary":"Increase facility amount","tags":[],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"arrangementId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"productId":"string","effectiveDate":"2024-01-01","extensions":{},"facommitment":[{}]}},"responses":{"200":"updateFacilityCommitmentIncreaseResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"POST","path":"/holdings/creditAgreements/facilities/commitmentTerms/{arrangementId}","fullPath":"/api/v4.5.0/holdings/creditAgreements/facilities/commitmentTerms/{arrangementId}","operationId":"updateFacilityCommitmentTerms","name":"Updates facility tenure by increasing or decreasing the term, in addition it allows the amendment of the availability schedule of the contract.","summary":"Update facility maturity date and availability","tags":[],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"arrangementId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"productId":"string","effectiveDate":"2024-01-01","extensions":{},"facommitment":[{}]}},"responses":{"200":"updateFacilityCommitmentTermsResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"GET","path":"/holdings/customers/{customerId}/creditAgreements/exposure","fullPath":"/api/v4.5.0/holdings/customers/{customerId}/creditAgreements/exposure","operationId":"getCustomerExposure","name":"Retrieves the customer exposure such as the facility number, type of facility, maturity date and various amounts of the facilities/standalone loans.","summary":"Retrieves the customer exposure for facilities and loans","tags":[],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"Identifier of the customer"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"CustomerExposureResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/customers/{customerId}/creditAgreements/drawings","fullPath":"/api/v4.5.0/holdings/customers/{customerId}/creditAgreements/drawings","operationId":"getCustomerDrawings","name":"Retrieves the details such as the drawing id, account number, short description of the loan, customer name and loan status for a customer. ","summary":"Retrieves the drawing details for a customer.","tags":[],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"Identifier of the customer"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"CustomerDrawingsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/customers/{customerId}/creditAgreements/facilities","fullPath":"/api/v4.5.0/holdings/customers/{customerId}/creditAgreements/facilities","operationId":"getCustomerFacilities","name":"Retrieves the details such as the facility id, account number, short description of the facility, customer name and facility status for a customer.","summary":"Retrieves the facility details for a customer.","tags":[],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"Identifier of the customer"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"CustomerFacilitiesResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/customers/{customerId}/creditAgreements/deals","fullPath":"/api/v4.5.0/holdings/customers/{customerId}/creditAgreements/deals","operationId":"getCustomerDeals","name":"Retrieves the details such as the deal id, account number, short description of the facility, customer name and deal status for a customer.","summary":"Retrieves the deal details for a customer.","tags":[],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"Identifier of the customer"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"CustomerDealsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/creditAgreements/deals/{dealId}/facilities","fullPath":"/api/v4.5.0/holdings/creditAgreements/deals/{dealId}/facilities","operationId":"getFacilitiesUnderDeal","name":"Retrieves the details such as facility id, title, currency, status and commitment amount for all the facilities under a deal.","summary":"Retrieves the details of facilities under a deal.","tags":[],"parameters":[{"name":"dealId","in":"path","type":"string","required":true,"description":"Unique identifier (contract number) of the corporate deals"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"FacilitiesUnderDealResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/creditAgreements/productCatalogues","fullPath":"/api/v4.5.0/holdings/creditAgreements/productCatalogues","operationId":"getCreditAgreementsProductCatalogue","name":"Retrieves the list of available products for credit agreements.","summary":"Retrieves the credit agreements product catalogue.","tags":[],"parameters":[{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"CreditAgreementsProductCatalogueResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/creditAgreements/drawings/{drawingId}/pendingActivities","fullPath":"/api/v4.5.0/holdings/creditAgreements/drawings/{drawingId}/pendingActivities","operationId":"getPendingActivities","name":"Retrieves the details such as rollover date, rollover status etc of pending drawdowns and rollovers for a drawing.","summary":"Retrieves the details of pending drawdowns and rollovers for a drawing.","tags":[],"parameters":[{"name":"drawingId","in":"path","type":"string","required":true,"description":"Identifier of drawings application under the Letter of Credit system that is used to effect the transfer of funds and the acceptance of documents under Letters of Credit and Documentary Collection tra"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"PendingActivitiesResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/creditAgreements/drawings/expiries","fullPath":"/api/v4.5.0/holdings/creditAgreements/drawings/expiries","operationId":"getLoansExpiring","name":"Retrieves the drawings expiring in the next 7 days.","summary":"Retrieves expiring drawings.","tags":[],"parameters":[{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"LoansExpiringResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/creditAgreements/facilities/expiries","fullPath":"/api/v4.5.0/holdings/creditAgreements/facilities/expiries","operationId":"getFacilitiesExpiring","name":"Retrieves the facilities expiring in the next 7 days","summary":"Retrieves expiring facilities","tags":[],"parameters":[{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"FacilitiesExpiringResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/creditAgreements/drawings/{drawingId}/balances","fullPath":"/api/v4.5.0/holdings/creditAgreements/drawings/{drawingId}/balances","operationId":"getDrawingBalances","name":"Retrieves the balance details such as commitment balances, utilized balances.","summary":"Retrieves drawing balances","tags":[],"parameters":[{"name":"drawingId","in":"path","type":"string","required":true,"description":"Identifier of drawings application under the Letter of Credit system that is used to effect the transfer of funds and the acceptance of documents under Letters of Credit and Documentary Collection tra"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"DrawingBalancesResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/creditAgreements/drawings/{drawingId}/OverdueBalances","fullPath":"/api/v4.5.0/holdings/creditAgreements/drawings/{drawingId}/OverdueBalances","operationId":"getDrawingOverdueBalances","name":"Retrieves the past dues and overdues for a drawing","summary":"Retrieves drawing overdue balances","tags":[],"parameters":[{"name":"drawingId","in":"path","type":"string","required":true,"description":"Identifier of drawings application under the Letter of Credit system that is used to effect the transfer of funds and the acceptance of documents under Letters of Credit and Documentary Collection tra"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"DrawingOverdueBalancesResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"POST","path":"/holdings/creditAgreements/facilities/clubFacilities","fullPath":"/api/v4.5.0/holdings/creditAgreements/facilities/clubFacilities","operationId":"createClubFacilities","name":"Creates a club facility with facility details along with the details of participating lenders","summary":"Creates a club facility","tags":[],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"customers":[{}],"productId":"string","currency":"string","effectiveDate":"2024-01-01","extensions":{},"account":[{}],"settlement":[{}],"facommitment":[{}],"upfrontfee":[{}],"coordinationfee":[{}],"limit":[{}],"participant":[{}],"riskparticipant":[{}]}},"responses":{"200":"createClubFacilitiesResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"POST","path":"/holdings/creditAgreements/facilities/drawings/clubDrawings","fullPath":"/api/v4.5.0/holdings/creditAgreements/facilities/drawings/clubDrawings","operationId":"createClubDrawings","name":"Creates a club drawing arrangement with drawdown details along with the details of participating lenders","summary":"Creates a club drawing","tags":[],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"customers":[{}],"arrangmentId":"string","currency":"string","facilityId":"string","effectiveDate":"string","activity":"string","productId":"string","extensions":{},"account":[{}],"escrow":[{}],"dwcommitment":[{}],"settlement":[{}],"participant":[{}],"riskparticipant":[{}]}},"responses":{"200":"createClubDrawingsResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"GET","path":"/holdings/creditAgreements/facilities/drawings/{drawingId}/participants","fullPath":"/api/v4.5.0/holdings/creditAgreements/facilities/drawings/{drawingId}/participants","operationId":"getClubDrawingParticipants","name":"Retrieves the participation details of the lending arrangement for a customer. This will be used to view the agent bank and the participant details and the share amounts when an arrangement id is passed as an input.","summary":"Retrieves the participant details","tags":[],"parameters":[{"name":"drawingId","in":"path","type":"string","required":true,"description":"Identifier of drawings application under the Letter of Credit system that is used to effect the transfer of funds and the acceptance of documents under Letters of Credit and Documentary Collection tra"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"ClubDrawingParticipantsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"POST","path":"/holdings/creditAgreements/facilities/{facilityId}/fundedShareTransfers","fullPath":"/api/v4.5.0/holdings/creditAgreements/facilities/{facilityId}/fundedShareTransfers","operationId":"createFacilityFundedShareTransfer","name":"Creates a funded share transfer for a facility when participant details are passed. Share of a funding participant is transferred to another funding participant in a club facility and underlying drawings","summary":"Creates a funded share transfer for a facility","tags":[],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"facilityId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"productId":"string","effectiveDate":"2024-01-01","extensions":{},"shareTransfer":[{}]}},"responses":{"200":"createFacilityFundedShareTransferResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"POST","path":"/holdings/creditAgreements/facilities/drawings/{drawingId}/fundedShareTransfers","fullPath":"/api/v4.5.0/holdings/creditAgreements/facilities/drawings/{drawingId}/fundedShareTransfers","operationId":"createDrawingFundedShareTransfer","name":"Creates a funded share transfer for a drawing under a facility when participant details are passed. Share of a funding participant is transferred to another funding participant in a standalone club loan","summary":"Creates a funded share transfer for a drawing","tags":[],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"drawingId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"productId":"string","effectiveDate":"2024-01-01","extensions":{},"shareTransfer":[{}]}},"responses":{"200":"createDrawingFundedShareTransferResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"POST","path":"/holdings/creditAgreements/facilities/{facilityId}/riskShareTransfers","fullPath":"/api/v4.5.0/holdings/creditAgreements/facilities/{facilityId}/riskShareTransfers","operationId":"createFacilityRiskShareTransfer","name":"Creates a risk share transfer for a facility when participant details are passed. The risk of the own bank in a facility is mitigated by selling a portion risk to another financial institution","summary":"Creates a risk share transfer for a facility","tags":[],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"facilityId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"productId":"string","effectiveDate":"2024-01-01","extensions":{},"shareTransfer":[{}]}},"responses":{"200":"createFacilityRiskShareTransferResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"POST","path":"/holdings/creditAgreements/facilities/drawings/{drawingId}/riskShareTransfers","fullPath":"/api/v4.5.0/holdings/creditAgreements/facilities/drawings/{drawingId}/riskShareTransfers","operationId":"createDrawingRiskShareTransfer","name":"Creates a risk share transfer for a drawing under a facility when participant details are passed. The risk of the own bank in a loan is mitigated by selling a portion risk to another financial institution","summary":"Creates a risk share transfer for a drawing","tags":[],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"drawingId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"productId":"string","effectiveDate":"2024-01-01","extensions":{},"shareTransfer":[{}]}},"responses":{"200":"createDrawingRiskShareTransferResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"POST","path":"/holdings/creditAgreements/guarantees/{guaranteeId}/guaranteeIncreases","fullPath":"/api/v4.5.0/holdings/creditAgreements/guarantees/{guaranteeId}/guaranteeIncreases","operationId":"updateGuaranteeCommitmentIncrease","name":"Increase the commitment amount of the guarantee that the financial institution has issued on behalf of the applicant","summary":"Increase the commitment amount of the guarantee","tags":[],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"guaranteeId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"productId":"string","effectiveDate":"2024-01-01","extensions":{},"gteecommitment":[{}]}},"responses":{"200":"updateGuaranteeCommitmentIncreaseResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"POST","path":"/holdings/creditAgreements/guarantees/{guaranteeId}/guaranteeDecreases","fullPath":"/api/v4.5.0/holdings/creditAgreements/guarantees/{guaranteeId}/guaranteeDecreases","operationId":"updateGuaranteeCommitmentDecrease","name":"Decrease the commitment amount of the guarantee that the financial institution has issued on behalf of the applicant","summary":"Decrease the commitment amount of the guarantee","tags":[],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"guaranteeId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"productId":"string","effectiveDate":"2024-01-01","extensions":{},"gteecommitment":[{}]}},"responses":{"200":"updateGuaranteeCommitmentDecreaseResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"POST","path":"/holdings/creditAgreements/guarantees","fullPath":"/api/v4.5.0/holdings/creditAgreements/guarantees","operationId":"createCreditAgreementGuarantee","name":"Register the issuance of a new guarantee undertaking on behalf of the applicant when all the basic details relevant to the undertaking are passed","summary":"Register the issuance of a guarantee","tags":[],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"customers":[{}],"productId":"string","currency":"string","effectiveDate":"2024-01-01","facilityId":"string","extensions":{},"gteecommitment":[{}],"newarrfee":[{}],"settlement":[{}],"termsConditions":[{}]}},"responses":{"200":"createCreditAgreementGuaranteeResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"POST","path":"/holdings/creditAgreements/guarantees/clubGuarantees","fullPath":"/api/v4.5.0/holdings/creditAgreements/guarantees/clubGuarantees","operationId":"createClubGuarantee","name":"Create a club guarantee with guarantee details along with the details of participating lenders","summary":"Create a club guarantee","tags":[],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"customers":[{}],"productId":"string","currency":"string","effectiveDate":"2024-01-01","facilityId":"string","extensions":{},"account":[{}],"gteecommitment":[{}],"newarrfee":[{}],"settlement":[{}],"termsConditions":[{}],"participant":[{}]}},"responses":{"200":"createClubGuaranteeResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"POST","path":"/holdings/creditAgreements/guarantees/{guaranteeId}/cancellations","fullPath":"/api/v4.5.0/holdings/creditAgreements/guarantees/{guaranteeId}/cancellations","operationId":"cancelCorporateGuarantee","name":"Cancel a guarantee arrangement before its expiry date. All the accrued fees are made-due for collection and the bank is discharged of its liability.","summary":"Cancel a guarantee arrangement before the expiry date.","tags":[],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"guaranteeId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"productId":"string","effectiveDate":"2024-01-01","extensions":{},"settlement":[{}]}},"responses":{"200":"cancelCorporateGuaranteeResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}}]},{"key":"holdings-creditAgreements-api-service-v5.0.0","title":"Corporate Credit Agreements","version":"v5.0.0","description":"API for the creation and management of credit agreements for Corporate customers. The types of credit agreements are Single Level Facility, Credit Agreement with Multiple Facilities, Club Loans with Agency and Syndicated Loans.","endpointCount":51,"endpoints":[{"method":"POST","path":"/holdings/creditAgreements/deals/offers","fullPath":"/api/v5.0.0/holdings/creditAgreements/deals/offers","operationId":"createDealOffer","name":"Creates new offer deal for the required customer when the mandatory input details are provided. Offer deal creates a draft contract and allows the users to negotiate multiple times. Offer deal is a draft contract and will not affect the balance sheet of the bank.","summary":"Creates an offer for a deal contract","tags":[],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"customers":[{}],"productId":"string","currency":"string","effectiveDate":"2024-01-01","activity":"string","extensions":{},"settlement":[{}],"facilityRules":[{}],"dacommitment":[{}],"adminfee":[{}],"coordinationfee":[{}],"upfrontfee":[{}],"limit":[{}]}},"responses":{"200":"createDealOfferResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"POST","path":"/holdings/creditAgreements/facilities/offers","fullPath":"/api/v5.0.0/holdings/creditAgreements/facilities/offers","operationId":"createFacilityOffer","name":"Creates a new offer facility for the required customer when at least the mandatory input is provided. Offer facility creates a draft contract and allow the users to negotiate multiple times. Offer facility is a draft contract and will not affect the balance sheet of the bank.","summary":"Creates an offer for a facility contract","tags":[],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"customers":[{}],"productId":"string","currency":"string","dealId":"string","effectiveDate":"2024-01-01","activity":"string","extensions":{},"settlement":[{}],"facommitment":[{}],"upfrontfee":[{}],"coordinationfee":[{}],"limit":[{}]}},"responses":{"200":"createFacilityOfferResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"POST","path":"/holdings/creditAgreements/deals/offers/cancellations/{arrangementId}","fullPath":"/api/v5.0.0/holdings/creditAgreements/deals/offers/cancellations/{arrangementId}","operationId":"deleteDealOffer","name":"Deletes a new offer for the required deal contract when at least the mandatory input is provided. Deal offer is a draft contract, which allow the user to delete the contract online and deal offer contract will not affect the balance sheet of the bank.","summary":"Deletes an offer for a deal contract","tags":[],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"arrangementId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"productId":"string","effectiveDate":"2024-01-01","extensions":{}}},"responses":{"200":"deleteDealOfferResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"POST","path":"/holdings/creditAgreements/facilities/offers/cancellations/{arrangementId}","fullPath":"/api/v5.0.0/holdings/creditAgreements/facilities/offers/cancellations/{arrangementId}","operationId":"deleteFacilityOffer","name":"Deletes a new offer for the required facility contract when at least the mandatory input is provided. Facility offer is a draft contract, which allow the user to delete the contract online and facility offer contract will not affect the balance sheet of the bank.","summary":"Deletes an offer for a facility contract","tags":[],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"arrangementId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"productId":"string","effectiveDate":"2024-01-01","extensions":{}}},"responses":{"200":"deleteFacilityOfferResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"POST","path":"/holdings/creditAgreements/deals/offers/acceptances/{arrangementId}","fullPath":"/api/v5.0.0/holdings/creditAgreements/deals/offers/acceptances/{arrangementId}","operationId":"acceptDealOffer","name":"On executing acceptance, the contract is changed from offer to live deal for the required customer when at least the mandatory input is provided. Process will check all the required mandatory inputs and prompt an error message when mandatory details are not provided. Once the accept deal offer is processed further offer negotiation is not allowed.","summary":"Accept the deal offer and execute the contract to live","tags":[],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"arrangementId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"productId":"string","effectiveDate":"2024-01-01","extensions":{},"settlement":[{}],"facilityRules":[{}],"dacommitment":[{}],"adminfee":[{}],"coordinationfee":[{}],"upfrontfee":[{}],"limit":[{}]}},"responses":{"200":"acceptDealOfferResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"POST","path":"/holdings/creditAgreements/facilities/offers/acceptances/{arrangementId}","fullPath":"/api/v5.0.0/holdings/creditAgreements/facilities/offers/acceptances/{arrangementId}","operationId":"acceptFacilityOffer","name":"On executing acceptance, the contract is changed from offer to live facility for the required customer when at least the mandatory input is provided. Process will check all the required mandatory inputs and prompt an error message when mandatory details are not provided. Once the accept deal offer is processed further offer negotiation is not allowed.","summary":"Accept the facility offer and execute the contract to live","tags":[],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"arrangementId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"productId":"string","effectiveDate":"2024-01-01","extensions":{},"settlement":[{}],"facommitment":[{}],"upfrontfee":[{}],"coordinationfee":[{}],"limit":[{}]}},"responses":{"200":"acceptFacilityOfferResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"POST","path":"/holdings/creditAgreements/drawdowns/offers","fullPath":"/api/v5.0.0/holdings/creditAgreements/drawdowns/offers","operationId":"createDrawdownOffer","name":"Creates a new drawdown offer for the required customer. ","summary":"Creates a new drawdown offer for the required customer. ","tags":[],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"customers":[{}],"productId":"string","currency":"string","facilityId":"string","offerDate":"2024-01-01","drawdownDate":"2024-01-01","activity":"string","extensions":{},"maintenancefee":[{}],"dwcommitment":[{}],"settlement":[{}]}},"responses":{"200":"createDrawdownOfferResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"POST","path":"/holdings/creditAgreements/drawdowns/offers/negotiations","fullPath":"/api/v5.0.0/holdings/creditAgreements/drawdowns/offers/negotiations","operationId":"createOfferDrawdownRenegotiation","name":"Renegotiate the offer drawdown for the required customer.","summary":"Renegotiate the offer drawdown for the required customer.","tags":[],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"productId":"string","drawdownDate":"2024-01-01","extensions":{},"maintenancefee":[{}],"settlement":[{}]}},"responses":{"200":"createOfferDrawdownRenegotiationResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"POST","path":"/holdings/creditAgreements/drawdowns/offers/cancellations","fullPath":"/api/v5.0.0/holdings/creditAgreements/drawdowns/offers/cancellations","operationId":"deleteDrawdownOffer","name":"Cancellation of offer drawdown for the required customer.","summary":"Cancellation of offer drawdown for the required customer.","tags":[],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"productId":"string","drawdownDate":"2024-01-01","extensions":{}}},"responses":{"200":"deleteDrawdownOfferResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"POST","path":"/holdings/creditAgreements/drawdowns/offers/acceptances","fullPath":"/api/v5.0.0/holdings/creditAgreements/drawdowns/offers/acceptances","operationId":"acceptOfferDrawdown","name":"Convert an offer drawdown to a live drawdown for the required customer.","summary":"Convert an offer drawdown to a live drawdown for the required customer.","tags":[],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"productId":"string","drawdownDate":"2024-01-01","extensions":{},"maintenancefee":[{}],"dwcommitment":[{}],"settlement":[{}]}},"responses":{"200":"acceptOfferDrawdownResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"GET","path":"/holdings/creditAgreements/facilities/{facilityId}/drawingProducts","fullPath":"/api/v5.0.0/holdings/creditAgreements/facilities/{facilityId}/drawingProducts","operationId":"getFacilityDrawingProducts","name":"Retrieves the available drawing products under the facility ","summary":"Retrieves the available drawing products under the facility ","tags":[],"parameters":[{"name":"facilityId","in":"path","type":"string","required":true,"description":"Unique identifier (contract number) of the facility"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"FacilityDrawingProductsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/creditAgreements/facilities/{facilityId}/combinedSchedules","fullPath":"/api/v5.0.0/holdings/creditAgreements/facilities/{facilityId}/combinedSchedules","operationId":"getCombinedSchedules","name":"Retrieves the payment schedule of facility and its drawings","summary":"Retrieves the payment schedule of facility and its drawings","tags":[],"parameters":[{"name":"facilityId","in":"path","type":"string","required":true,"description":"Unique identifier (contract number) of the facility"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"CombinedSchedulesResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"POST","path":"/holdings/creditAgreements/facilities","fullPath":"/api/v5.0.0/holdings/creditAgreements/facilities","operationId":"createFacilities","name":"Creates corporate facilities","summary":"Creates corporate facilities","tags":[],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"customers":[{}],"productId":"string","currency":"string","effectiveDate":"2024-01-01","dealId":"string","extensions":{},"settlement":[{}],"facommitment":[{}],"upfrontfee":[{}],"coordinationfee":[{}],"limit":[{}]}},"responses":{"200":"createFacilitiesResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"POST","path":"/holdings/creditAgreements/drawdowns","fullPath":"/api/v5.0.0/holdings/creditAgreements/drawdowns","operationId":"createDrawdowns","name":"Creates drawdowns under facility","summary":"Creates drawdowns under facility","tags":[],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"customers":[{}],"arrangmentId":"string","currency":"string","facilityId":"string","effectiveDate":"string","activity":"string","productId":"string","extensions":{},"escrow":[{}],"dwcommitment":[{}],"settlement":[{}]}},"responses":{"200":"createDrawdownsResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"GET","path":"/holdings/creditAgreements/facilities/{facilityId}/drawingRules","fullPath":"/api/v5.0.0/holdings/creditAgreements/facilities/{facilityId}/drawingRules","operationId":"getFacilityDrawingRules","name":"Retrieves the allowed customers, currencies and products for a new drawing under the facility","summary":"Retrieves the allowed customers, currencies and products for a new drawing under the facility","tags":[],"parameters":[{"name":"facilityId","in":"path","type":"string","required":true,"description":"Unique identifier (contract number) of the facility"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"FacilityDrawingRulesResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/creditAgreements/facilities/{facilityId}/drawings","fullPath":"/api/v5.0.0/holdings/creditAgreements/facilities/{facilityId}/drawings","operationId":"getDrawingsUnderFacility","name":"Retrieves the drawings under a facility","summary":"Retrieves the drawings under a facility","tags":[],"parameters":[{"name":"facilityId","in":"path","type":"string","required":true,"description":"Unique identifier (contract number) of the facility"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"DrawingsUnderFacilityResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/creditAgreements/facilities/drawings/{drawingId}/parentFacilities","fullPath":"/api/v5.0.0/holdings/creditAgreements/facilities/drawings/{drawingId}/parentFacilities","operationId":"getDrawingFacility","name":"Retrieves the parent facility for a drawing","summary":"Retrieves the parent facility for a drawing","tags":[],"parameters":[{"name":"drawingId","in":"path","type":"string","required":true,"description":"Identifier of drawings application under the Letter of Credit system that is used to effect the transfer of funds and the acceptance of documents under Letters of Credit and Documentary Collection tra"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"DrawingFacilityResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/creditAgreements/facilities/{facilityId}/commitmentSchedules","fullPath":"/api/v5.0.0/holdings/creditAgreements/facilities/{facilityId}/commitmentSchedules","operationId":"getFacilityCommitmentSchedule","name":"Retrieves the commitment schedule of a facility","summary":"Retrieves the commitment schedule of a facility","tags":[],"parameters":[{"name":"facilityId","in":"path","type":"string","required":true,"description":"Unique identifier (contract number) of the facility"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"FacilityCommitmentScheduleResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/creditAgreements/facilities/{facilityId}/parentDeals","fullPath":"/api/v5.0.0/holdings/creditAgreements/facilities/{facilityId}/parentDeals","operationId":"getFacilityDeal","name":"Retrieves the parent deal for a facility","summary":"Retrieves the parent deal for a facility","tags":[],"parameters":[{"name":"facilityId","in":"path","type":"string","required":true,"description":"Unique identifier (contract number) of the facility"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"FacilityDealResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/creditAgreements/facilities/{facilityId}/balances","fullPath":"/api/v5.0.0/holdings/creditAgreements/facilities/{facilityId}/balances","operationId":"getFacilityFinancialSummary","name":"Retrieves the financial summary for a facility arrangement","summary":"Retrieves the financial summary for a facility arrangement","tags":[],"parameters":[{"name":"facilityId","in":"path","type":"string","required":true,"description":"Unique identifier (contract number) of the facility"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"FacilityFinancialSummaryResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/creditAgreements/facilities/{facilityId}/consolidatedBalances","fullPath":"/api/v5.0.0/holdings/creditAgreements/facilities/{facilityId}/consolidatedBalances","operationId":"getFacilityConsolidatedBalances","name":"Retrieves the consolidated balances for a facility arrangement","summary":"Retrieves the consolidated balances for a facility arrangement","tags":[],"parameters":[{"name":"facilityId","in":"path","type":"string","required":true,"description":"Unique identifier (contract number) of the facility"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"FacilityConsolidatedBalancesResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"POST","path":"/holdings/creditAgreements/facilities/directDebits","fullPath":"/api/v5.0.0/holdings/creditAgreements/facilities/directDebits","operationId":"createFacilityDirectDebitLink","name":"Links a direct debit to an existing facility","summary":"Links a direct debit to a facility","tags":[],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"customers":[{}],"arrangement":"string","productId":"string","currency":"string","effectiveDate":"2024-01-01","extensions":{},"settlement":[{}]}},"responses":{"200":"createFacilityDirectDebitLinkResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"POST","path":"/holdings/creditAgreements/facilities/drawings/directDebits","fullPath":"/api/v5.0.0/holdings/creditAgreements/facilities/drawings/directDebits","operationId":"createDrawingDirectDebitLink","name":"Link the direct debit to an existing drawing under a facility","summary":"Links a direct debit to a drawing","tags":[],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"customers":[{}],"arrangement":"string","currency":"string","facilityId":"string","effectiveDate":"string","productId":"string","extensions":{},"settlement":[{}]}},"responses":{"200":"createDrawingDirectDebitLinkResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"POST","path":"/holdings/creditAgreements/facilities/rollovers/offers","fullPath":"/api/v5.0.0/holdings/creditAgreements/facilities/rollovers/offers","operationId":"createFacilityRolloverOffer","name":"Create rollover process from the facility where the rollover could be a split rollover, merge rollover or a one to one rollover. Split also called as one to many will rollover an old loan and create multiple new offer loans. Merge also called as many to one will rollover multiple old loans simultaneously and create a single new offer loan. Rollover also called as one to one will simply rollover an old loan and create a new offer loan","summary":"Create rollover offer from facility","tags":[],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"arrangement":"string","rolloverDate":"string","extensions":{},"splitsMerges":[{}]}},"responses":{"200":"createFacilityRolloverOfferResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"POST","path":"/holdings/creditAgreements/drawdowns/rollovers/offers","fullPath":"/api/v5.0.0/holdings/creditAgreements/drawdowns/rollovers/offers","operationId":"createDrawdownRolloverOffer","name":"Create rollover process from the drawdown where the rollover could be a split rollover, merge rollover or a one to one rollover. Split also called as one to many will rollover an old loan and create multiple new offer loans. Merge also called as many to one will rollover multiple old loans simultaneously and create a single new offer loan. Rollover also called as one to one will simply rollover an old loan and create a new offer loan","summary":"Create rollover offer from drawdown","tags":[],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"arrangement":"string","rolloverDate":"string","extensions":{},"splitsMerges":[{}]}},"responses":{"200":"createDrawdownRolloverOfferResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"POST","path":"/holdings/creditAgreements/facilities/commitmentIncreases/{arrangementId}","fullPath":"/api/v5.0.0/holdings/creditAgreements/facilities/commitmentIncreases/{arrangementId}","operationId":"updateFacilityCommitmentIncrease","name":"Increase the facility amount to facilitate further drawdowns","summary":"Increase facility amount","tags":[],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"arrangementId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"productId":"string","effectiveDate":"2024-01-01","extensions":{},"facommitment":[{}]}},"responses":{"200":"updateFacilityCommitmentIncreaseResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"POST","path":"/holdings/creditAgreements/facilities/commitmentTerms/{arrangementId}","fullPath":"/api/v5.0.0/holdings/creditAgreements/facilities/commitmentTerms/{arrangementId}","operationId":"updateFacilityCommitmentTerms","name":"Updates facility tenure by increasing or decreasing the term, in addition it allows the amendment of the availability schedule of the contract.","summary":"Update facility maturity date and availability","tags":[],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"arrangementId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"productId":"string","effectiveDate":"2024-01-01","extensions":{},"facommitment":[{}]}},"responses":{"200":"updateFacilityCommitmentTermsResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"GET","path":"/holdings/customers/{customerId}/creditAgreements/exposure","fullPath":"/api/v5.0.0/holdings/customers/{customerId}/creditAgreements/exposure","operationId":"getCustomerExposure","name":"Retrieves the customer exposure such as the facility number, type of facility, maturity date and various amounts of the facilities/standalone loans.","summary":"Retrieves the customer exposure for facilities and loans","tags":[],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"Identifier of the customer"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"CustomerExposureResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/customers/{customerId}/creditAgreements/drawings","fullPath":"/api/v5.0.0/holdings/customers/{customerId}/creditAgreements/drawings","operationId":"getCustomerDrawings","name":"Retrieves the details such as the drawing id, account number, short description of the loan, customer name and loan status for a customer. ","summary":"Retrieves the drawing details for a customer.","tags":[],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"Identifier of the customer"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"CustomerDrawingsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/customers/{customerId}/creditAgreements/facilities","fullPath":"/api/v5.0.0/holdings/customers/{customerId}/creditAgreements/facilities","operationId":"getCustomerFacilities","name":"Retrieves the details such as the facility id, account number, short description of the facility, customer name and facility status for a customer.","summary":"Retrieves the facility details for a customer.","tags":[],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"Identifier of the customer"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"CustomerFacilitiesResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/customers/{customerId}/creditAgreements/deals","fullPath":"/api/v5.0.0/holdings/customers/{customerId}/creditAgreements/deals","operationId":"getCustomerDeals","name":"Retrieves the details such as the deal id, account number, short description of the facility, customer name and deal status for a customer.","summary":"Retrieves the deal details for a customer.","tags":[],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"Identifier of the customer"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"CustomerDealsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/creditAgreements/deals/{dealId}/facilities","fullPath":"/api/v5.0.0/holdings/creditAgreements/deals/{dealId}/facilities","operationId":"getFacilitiesUnderDeal","name":"Retrieves the details such as facility id, title, currency, status and commitment amount for all the facilities under a deal.","summary":"Retrieves the details of facilities under a deal.","tags":[],"parameters":[{"name":"dealId","in":"path","type":"string","required":true,"description":"Unique identifier (contract number) of the corporate deals"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"FacilitiesUnderDealResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/creditAgreements/productCatalogues","fullPath":"/api/v5.0.0/holdings/creditAgreements/productCatalogues","operationId":"getCreditAgreementsProductCatalogue","name":"Retrieves the list of available products for credit agreements.","summary":"Retrieves the credit agreements product catalogue.","tags":[],"parameters":[{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"CreditAgreementsProductCatalogueResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/creditAgreements/drawings/{drawingId}/pendingActivities","fullPath":"/api/v5.0.0/holdings/creditAgreements/drawings/{drawingId}/pendingActivities","operationId":"getPendingActivities","name":"Retrieves the details such as rollover date, rollover status etc of pending drawdowns and rollovers for a drawing.","summary":"Retrieves the details of pending drawdowns and rollovers for a drawing.","tags":[],"parameters":[{"name":"drawingId","in":"path","type":"string","required":true,"description":"Identifier of drawings application under the Letter of Credit system that is used to effect the transfer of funds and the acceptance of documents under Letters of Credit and Documentary Collection tra"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"PendingActivitiesResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/creditAgreements/drawings/expiries","fullPath":"/api/v5.0.0/holdings/creditAgreements/drawings/expiries","operationId":"getLoansExpiring","name":"Retrieves the drawings expiring in the next 7 days.","summary":"Retrieves expiring drawings.","tags":[],"parameters":[{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"LoansExpiringResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/creditAgreements/facilities/expiries","fullPath":"/api/v5.0.0/holdings/creditAgreements/facilities/expiries","operationId":"getFacilitiesExpiring","name":"Retrieves the facilities expiring in the next 7 days","summary":"Retrieves expiring facilities","tags":[],"parameters":[{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"FacilitiesExpiringResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/creditAgreements/drawings/{drawingId}/balances","fullPath":"/api/v5.0.0/holdings/creditAgreements/drawings/{drawingId}/balances","operationId":"getDrawingBalances","name":"Retrieves the balance details such as commitment balances, utilized balances.","summary":"Retrieves drawing balances","tags":[],"parameters":[{"name":"drawingId","in":"path","type":"string","required":true,"description":"Identifier of drawings application under the Letter of Credit system that is used to effect the transfer of funds and the acceptance of documents under Letters of Credit and Documentary Collection tra"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"DrawingBalancesResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/creditAgreements/drawings/{drawingId}/OverdueBalances","fullPath":"/api/v5.0.0/holdings/creditAgreements/drawings/{drawingId}/OverdueBalances","operationId":"getDrawingOverdueBalances","name":"Retrieves the past dues and overdues for a drawing","summary":"Retrieves drawing overdue balances","tags":[],"parameters":[{"name":"drawingId","in":"path","type":"string","required":true,"description":"Identifier of drawings application under the Letter of Credit system that is used to effect the transfer of funds and the acceptance of documents under Letters of Credit and Documentary Collection tra"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"DrawingOverdueBalancesResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"POST","path":"/holdings/creditAgreements/facilities/clubFacilities","fullPath":"/api/v5.0.0/holdings/creditAgreements/facilities/clubFacilities","operationId":"createClubFacilities","name":"Creates a club facility with facility details along with the details of participating lenders","summary":"Creates a club facility","tags":[],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"customers":[{}],"productId":"string","currency":"string","effectiveDate":"2024-01-01","extensions":{},"account":[{}],"settlement":[{}],"facommitment":[{}],"upfrontfee":[{}],"coordinationfee":[{}],"limit":[{}],"participant":[{}],"riskparticipant":[{}]}},"responses":{"200":"createClubFacilitiesResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"POST","path":"/holdings/creditAgreements/facilities/drawings/clubDrawings","fullPath":"/api/v5.0.0/holdings/creditAgreements/facilities/drawings/clubDrawings","operationId":"createClubDrawings","name":"Creates a club drawing arrangement with drawdown details along with the details of participating lenders","summary":"Creates a club drawing","tags":[],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"customers":[{}],"arrangmentId":"string","currency":"string","facilityId":"string","effectiveDate":"string","activity":"string","productId":"string","extensions":{},"account":[{}],"escrow":[{}],"dwcommitment":[{}],"settlement":[{}],"participant":[{}],"riskparticipant":[{}]}},"responses":{"200":"createClubDrawingsResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"GET","path":"/holdings/creditAgreements/facilities/drawings/{drawingId}/participants","fullPath":"/api/v5.0.0/holdings/creditAgreements/facilities/drawings/{drawingId}/participants","operationId":"getClubDrawingParticipants","name":"Retrieves the participation details of the lending arrangement for a customer. This will be used to view the agent bank and the participant details and the share amounts when an arrangement id is passed as an input.","summary":"Retrieves the participant details","tags":[],"parameters":[{"name":"drawingId","in":"path","type":"string","required":true,"description":"Identifier of drawings application under the Letter of Credit system that is used to effect the transfer of funds and the acceptance of documents under Letters of Credit and Documentary Collection tra"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"ClubDrawingParticipantsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"POST","path":"/holdings/creditAgreements/facilities/{facilityId}/fundedShareTransfers","fullPath":"/api/v5.0.0/holdings/creditAgreements/facilities/{facilityId}/fundedShareTransfers","operationId":"createFacilityFundedShareTransfer","name":"Creates a funded share transfer for a facility when participant details are passed. Share of a funding participant is transferred to another funding participant in a club facility and underlying drawings","summary":"Creates a funded share transfer for a facility","tags":[],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"facilityId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"productId":"string","effectiveDate":"2024-01-01","extensions":{},"shareTransfer":[{}]}},"responses":{"200":"createFacilityFundedShareTransferResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"POST","path":"/holdings/creditAgreements/facilities/drawings/{drawingId}/fundedShareTransfers","fullPath":"/api/v5.0.0/holdings/creditAgreements/facilities/drawings/{drawingId}/fundedShareTransfers","operationId":"createDrawingFundedShareTransfer","name":"Creates a funded share transfer for a drawing under a facility when participant details are passed. Share of a funding participant is transferred to another funding participant in a standalone club loan","summary":"Creates a funded share transfer for a drawing","tags":[],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"drawingId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"productId":"string","effectiveDate":"2024-01-01","extensions":{},"shareTransfer":[{}]}},"responses":{"200":"createDrawingFundedShareTransferResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"POST","path":"/holdings/creditAgreements/facilities/{facilityId}/riskShareTransfers","fullPath":"/api/v5.0.0/holdings/creditAgreements/facilities/{facilityId}/riskShareTransfers","operationId":"createFacilityRiskShareTransfer","name":"Creates a risk share transfer for a facility when participant details are passed. The risk of the own bank in a facility is mitigated by selling a portion risk to another financial institution","summary":"Creates a risk share transfer for a facility","tags":[],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"facilityId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"productId":"string","effectiveDate":"2024-01-01","extensions":{},"shareTransfer":[{}]}},"responses":{"200":"createFacilityRiskShareTransferResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"POST","path":"/holdings/creditAgreements/facilities/drawings/{drawingId}/riskShareTransfers","fullPath":"/api/v5.0.0/holdings/creditAgreements/facilities/drawings/{drawingId}/riskShareTransfers","operationId":"createDrawingRiskShareTransfer","name":"Creates a risk share transfer for a drawing under a facility when participant details are passed. The risk of the own bank in a loan is mitigated by selling a portion risk to another financial institution","summary":"Creates a risk share transfer for a drawing","tags":[],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"drawingId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"productId":"string","effectiveDate":"2024-01-01","extensions":{},"shareTransfer":[{}]}},"responses":{"200":"createDrawingRiskShareTransferResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"POST","path":"/holdings/creditAgreements/guarantees/{guaranteeId}/guaranteeIncreases","fullPath":"/api/v5.0.0/holdings/creditAgreements/guarantees/{guaranteeId}/guaranteeIncreases","operationId":"updateGuaranteeCommitmentIncrease","name":"Increase the commitment amount of the guarantee that the financial institution has issued on behalf of the applicant","summary":"Increase the commitment amount of the guarantee","tags":[],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"guaranteeId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"productId":"string","effectiveDate":"2024-01-01","extensions":{},"gteecommitment":[{}]}},"responses":{"200":"updateGuaranteeCommitmentIncreaseResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"POST","path":"/holdings/creditAgreements/guarantees/{guaranteeId}/guaranteeDecreases","fullPath":"/api/v5.0.0/holdings/creditAgreements/guarantees/{guaranteeId}/guaranteeDecreases","operationId":"updateGuaranteeCommitmentDecrease","name":"Decrease the commitment amount of the guarantee that the financial institution has issued on behalf of the applicant","summary":"Decrease the commitment amount of the guarantee","tags":[],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"guaranteeId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"productId":"string","effectiveDate":"2024-01-01","extensions":{},"gteecommitment":[{}]}},"responses":{"200":"updateGuaranteeCommitmentDecreaseResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"POST","path":"/holdings/creditAgreements/guarantees","fullPath":"/api/v5.0.0/holdings/creditAgreements/guarantees","operationId":"createCreditAgreementGuarantee","name":"Register the issuance of a new guarantee undertaking on behalf of the applicant when all the basic details relevant to the undertaking are passed","summary":"Register the issuance of a guarantee","tags":[],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"customers":[{}],"productId":"string","currency":"string","effectiveDate":"2024-01-01","facilityId":"string","extensions":{},"gteecommitment":[{}],"newarrfee":[{}],"settlement":[{}],"termsConditions":[{}]}},"responses":{"200":"createCreditAgreementGuaranteeResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"POST","path":"/holdings/creditAgreements/guarantees/clubGuarantees","fullPath":"/api/v5.0.0/holdings/creditAgreements/guarantees/clubGuarantees","operationId":"createClubGuarantee","name":"Create a club guarantee with guarantee details along with the details of participating lenders","summary":"Create a club guarantee","tags":[],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"customers":[{}],"productId":"string","currency":"string","effectiveDate":"2024-01-01","facilityId":"string","extensions":{},"account":[{}],"gteecommitment":[{}],"newarrfee":[{}],"settlement":[{}],"termsConditions":[{}],"participant":[{}]}},"responses":{"200":"createClubGuaranteeResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"POST","path":"/holdings/creditAgreements/guarantees/{guaranteeId}/cancellations","fullPath":"/api/v5.0.0/holdings/creditAgreements/guarantees/{guaranteeId}/cancellations","operationId":"cancelCorporateGuarantee","name":"Cancel a guarantee arrangement before its expiry date. All the accrued fees are made-due for collection and the bank is discharged of its liability.","summary":"Cancel a guarantee arrangement before the expiry date.","tags":[],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"guaranteeId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"productId":"string","effectiveDate":"2024-01-01","extensions":{},"settlement":[{}]}},"responses":{"200":"cancelCorporateGuaranteeResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"POST","path":"/holdings/creditAgreements/deals","fullPath":"/api/v5.0.0/holdings/creditAgreements/deals","operationId":"createDeals","name":"Creates a new deal for the customer with the details like product, term and amount . Corporate Deal is a credit agreement between two parties- the lender and the borrower, who agree to certain terms and conditions along with their rights and obligations","summary":"Creates Corporate Deals","tags":[],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"customers":[{}],"productId":"string","currency":"string","effectiveDate":"2024-01-01","extensions":{},"settlement":[{}],"facilityRules":[{}],"dacommitment":[{}],"adminfee":[{}],"coordinationfee":[{}],"upfrontfee":[{}],"limit":[{}]}},"responses":{"200":"createDealsResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}}]},{"key":"holdings-creditAgreements-api-service-v6.0.0","title":"Corporate Credit Agreements","version":"v6.0.0","description":"API for the creation and management of credit agreements for corporate customers. The types of credit agreements are single level facility, credit agreement with multiple facilities, club loans with agency and syndicated loans.","endpointCount":56,"endpoints":[{"method":"POST","path":"/holdings/creditAgreements/deals/offers","fullPath":"/api/v6.0.0/holdings/creditAgreements/deals/offers","operationId":"createDealOffer","name":"Creates new offer deal for the required customer when the mandatory input details are provided. Offer deal creates a draft contract and allows the users to negotiate multiple times. Offer deal is a draft contract and will not affect the balance sheet of the bank.","summary":"Creates an offer for a deal contract","tags":[],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"customers":[{}],"productId":"string","currency":"string","effectiveDate":"2024-01-01","activity":"string","extensions":{},"settlement":[{}],"facilityRules":[{}],"dacommitment":[{}],"adminfee":[{}],"coordinationfee":[{}],"upfrontfee":[{}],"limit":[{}]}},"responses":{"200":"createDealOfferResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"POST","path":"/holdings/creditAgreements/facilities/offers","fullPath":"/api/v6.0.0/holdings/creditAgreements/facilities/offers","operationId":"createFacilityOffer","name":"Creates a new offer facility for the required customer when at least the mandatory input is provided. Offer facility creates a draft contract and allow the users to negotiate multiple times. Offer facility is a draft contract and will not affect the balance sheet of the bank.","summary":"Creates an offer for a facility contract","tags":[],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"customers":[{}],"productId":"string","currency":"string","dealId":"string","effectiveDate":"2024-01-01","activity":"string","extensions":{},"settlement":[{}],"facommitment":[{}],"upfrontfee":[{}],"coordinationfee":[{}],"limit":[{}]}},"responses":{"200":"createFacilityOfferResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"POST","path":"/holdings/creditAgreements/deals/offers/cancellations/{arrangementId}","fullPath":"/api/v6.0.0/holdings/creditAgreements/deals/offers/cancellations/{arrangementId}","operationId":"deleteDealOffer","name":"Deletes a new offer for the required deal contract when at least the mandatory input is provided. Deal offer is a draft contract, which allow the user to delete the contract online and deal offer contract will not affect the balance sheet of the bank.","summary":"Deletes an offer for a deal contract","tags":[],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"arrangementId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"productId":"string","effectiveDate":"2024-01-01","extensions":{}}},"responses":{"200":"deleteDealOfferResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"POST","path":"/holdings/creditAgreements/facilities/offers/cancellations/{arrangementId}","fullPath":"/api/v6.0.0/holdings/creditAgreements/facilities/offers/cancellations/{arrangementId}","operationId":"deleteFacilityOffer","name":"Deletes a new offer for the required facility contract when at least the mandatory input is provided. Facility offer is a draft contract, which allow the user to delete the contract online and facility offer contract will not affect the balance sheet of the bank.","summary":"Deletes an offer for a facility contract","tags":[],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"arrangementId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"productId":"string","effectiveDate":"2024-01-01","extensions":{}}},"responses":{"200":"deleteFacilityOfferResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"POST","path":"/holdings/creditAgreements/deals/offers/acceptances/{arrangementId}","fullPath":"/api/v6.0.0/holdings/creditAgreements/deals/offers/acceptances/{arrangementId}","operationId":"acceptDealOffer","name":"On executing acceptance, the contract is changed from offer to live deal for the required customer when at least the mandatory input is provided. Process will check all the required mandatory inputs and prompt an error message when mandatory details are not provided. Once the accept deal offer is processed further offer negotiation is not allowed.","summary":"Accept the deal offer and execute the contract to live","tags":[],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"arrangementId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"productId":"string","effectiveDate":"2024-01-01","extensions":{},"settlement":[{}],"facilityRules":[{}],"dacommitment":[{}],"adminfee":[{}],"coordinationfee":[{}],"upfrontfee":[{}],"limit":[{}]}},"responses":{"200":"acceptDealOfferResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"POST","path":"/holdings/creditAgreements/facilities/offers/acceptances/{arrangementId}","fullPath":"/api/v6.0.0/holdings/creditAgreements/facilities/offers/acceptances/{arrangementId}","operationId":"acceptFacilityOffer","name":"On executing acceptance, the contract is changed from offer to live facility for the required customer when at least the mandatory input is provided. Process will check all the required mandatory inputs and prompt an error message when mandatory details are not provided. Once the accept deal offer is processed further offer negotiation is not allowed.","summary":"Accept the facility offer and execute the contract to live","tags":[],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"arrangementId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"productId":"string","effectiveDate":"2024-01-01","extensions":{},"settlement":[{}],"facommitment":[{}],"upfrontfee":[{}],"coordinationfee":[{}],"limit":[{}]}},"responses":{"200":"acceptFacilityOfferResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"POST","path":"/holdings/creditAgreements/drawdowns/offers","fullPath":"/api/v6.0.0/holdings/creditAgreements/drawdowns/offers","operationId":"createDrawdownOffer","name":"Creates a new drawdown offer for the required customer. ","summary":"Creates a new drawdown offer for the required customer. ","tags":[],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"customers":[{}],"productId":"string","currency":"string","facilityId":"string","offerDate":"2024-01-01","drawdownDate":"2024-01-01","activity":"string","extensions":{},"maintenancefee":[{}],"dwcommitment":[{}],"settlement":[{}]}},"responses":{"200":"createDrawdownOfferResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"POST","path":"/holdings/creditAgreements/drawdowns/offers/negotiations","fullPath":"/api/v6.0.0/holdings/creditAgreements/drawdowns/offers/negotiations","operationId":"createOfferDrawdownRenegotiation","name":"Renegotiate the offer drawdown for the required customer.","summary":"Renegotiate the offer drawdown for the required customer.","tags":[],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"productId":"string","drawdownDate":"2024-01-01","extensions":{},"maintenancefee":[{}],"settlement":[{}]}},"responses":{"200":"createOfferDrawdownRenegotiationResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"POST","path":"/holdings/creditAgreements/drawdowns/offers/cancellations","fullPath":"/api/v6.0.0/holdings/creditAgreements/drawdowns/offers/cancellations","operationId":"deleteDrawdownOffer","name":"Cancellation of offer drawdown for the required customer.","summary":"Cancellation of offer drawdown for the required customer.","tags":[],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"productId":"string","drawdownDate":"2024-01-01","extensions":{}}},"responses":{"200":"deleteDrawdownOfferResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"POST","path":"/holdings/creditAgreements/drawdowns/offers/acceptances","fullPath":"/api/v6.0.0/holdings/creditAgreements/drawdowns/offers/acceptances","operationId":"acceptOfferDrawdown","name":"Convert an offer drawdown to a live drawdown for the required customer.","summary":"Convert an offer drawdown to a live drawdown for the required customer.","tags":[],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"productId":"string","drawdownDate":"2024-01-01","extensions":{},"maintenancefee":[{}],"dwcommitment":[{}],"settlement":[{}]}},"responses":{"200":"acceptOfferDrawdownResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"GET","path":"/holdings/creditAgreements/facilities/{facilityId}/drawingProducts","fullPath":"/api/v6.0.0/holdings/creditAgreements/facilities/{facilityId}/drawingProducts","operationId":"getFacilityDrawingProducts","name":"Retrieves the available drawing products under the facility ","summary":"Retrieves the available drawing products under the facility ","tags":[],"parameters":[{"name":"facilityId","in":"path","type":"string","required":true,"description":"Unique identifier (contract number) of the facility"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"FacilityDrawingProductsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/creditAgreements/facilities/{facilityId}/combinedSchedules","fullPath":"/api/v6.0.0/holdings/creditAgreements/facilities/{facilityId}/combinedSchedules","operationId":"getCombinedSchedules","name":"Retrieves the payment schedule of facility and its drawings","summary":"Retrieves the payment schedule of facility and its drawings","tags":[],"parameters":[{"name":"facilityId","in":"path","type":"string","required":true,"description":"Unique identifier (contract number) of the facility"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"CombinedSchedulesResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"POST","path":"/holdings/creditAgreements/facilities","fullPath":"/api/v6.0.0/holdings/creditAgreements/facilities","operationId":"createFacilities","name":"Creates corporate facilities","summary":"Creates corporate facilities","tags":[],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"customers":[{}],"productId":"string","currency":"string","effectiveDate":"2024-01-01","dealId":"string","extensions":{},"settlement":[{}],"facommitment":[{}],"upfrontfee":[{}],"coordinationfee":[{}],"limit":[{}]}},"responses":{"200":"createFacilitiesResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"POST","path":"/holdings/creditAgreements/drawdowns","fullPath":"/api/v6.0.0/holdings/creditAgreements/drawdowns","operationId":"createDrawdowns","name":"Creates drawdowns under facility","summary":"Creates drawdowns under facility","tags":[],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"customers":[{}],"arrangmentId":"string","currency":"string","facilityId":"string","effectiveDate":"string","activity":"string","productId":"string","extensions":{},"escrow":[{}],"dwcommitment":[{}],"settlement":[{}]}},"responses":{"200":"createDrawdownsResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"GET","path":"/holdings/creditAgreements/facilities/{facilityId}/drawingRules","fullPath":"/api/v6.0.0/holdings/creditAgreements/facilities/{facilityId}/drawingRules","operationId":"getFacilityDrawingRules","name":"Retrieves the allowed customers, currencies and products for a new drawing under the facility","summary":"Retrieves the allowed customers, currencies and products for a new drawing under the facility","tags":[],"parameters":[{"name":"facilityId","in":"path","type":"string","required":true,"description":"Unique identifier (contract number) of the facility"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"FacilityDrawingRulesResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/creditAgreements/facilities/{facilityId}/drawings","fullPath":"/api/v6.0.0/holdings/creditAgreements/facilities/{facilityId}/drawings","operationId":"getDrawingsUnderFacility","name":"Retrieves the drawings under a facility","summary":"Retrieves the drawings under a facility","tags":[],"parameters":[{"name":"facilityId","in":"path","type":"string","required":true,"description":"Unique identifier (contract number) of the facility"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"DrawingsUnderFacilityResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/creditAgreements/facilities/drawings/{drawingId}/parentFacilities","fullPath":"/api/v6.0.0/holdings/creditAgreements/facilities/drawings/{drawingId}/parentFacilities","operationId":"getDrawingFacility","name":"Retrieves the parent facility for a drawing","summary":"Retrieves the parent facility for a drawing","tags":[],"parameters":[{"name":"drawingId","in":"path","type":"string","required":true,"description":"Identifier of drawings application under the Letter of Credit system that is used to effect the transfer of funds and the acceptance of documents under Letters of Credit and Documentary Collection tra"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"DrawingFacilityResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/creditAgreements/facilities/{facilityId}/commitmentSchedules","fullPath":"/api/v6.0.0/holdings/creditAgreements/facilities/{facilityId}/commitmentSchedules","operationId":"getFacilityCommitmentSchedule","name":"Retrieves the commitment schedule of a facility","summary":"Retrieves the commitment schedule of a facility","tags":[],"parameters":[{"name":"facilityId","in":"path","type":"string","required":true,"description":"Unique identifier (contract number) of the facility"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"FacilityCommitmentScheduleResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/creditAgreements/facilities/{facilityId}/parentDeals","fullPath":"/api/v6.0.0/holdings/creditAgreements/facilities/{facilityId}/parentDeals","operationId":"getFacilityDeal","name":"Retrieves the parent deal for a facility","summary":"Retrieves the parent deal for a facility","tags":[],"parameters":[{"name":"facilityId","in":"path","type":"string","required":true,"description":"Unique identifier (contract number) of the facility"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"FacilityDealResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/creditAgreements/facilities/{facilityId}/balances","fullPath":"/api/v6.0.0/holdings/creditAgreements/facilities/{facilityId}/balances","operationId":"getFacilityFinancialSummary","name":"Retrieves the financial summary for a facility arrangement","summary":"Retrieves the financial summary for a facility arrangement","tags":[],"parameters":[{"name":"facilityId","in":"path","type":"string","required":true,"description":"Unique identifier (contract number) of the facility"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"FacilityFinancialSummaryResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/creditAgreements/facilities/{facilityId}/consolidatedBalances","fullPath":"/api/v6.0.0/holdings/creditAgreements/facilities/{facilityId}/consolidatedBalances","operationId":"getFacilityConsolidatedBalances","name":"Retrieves the consolidated balances for a facility arrangement","summary":"Retrieves the consolidated balances for a facility arrangement","tags":[],"parameters":[{"name":"facilityId","in":"path","type":"string","required":true,"description":"Unique identifier (contract number) of the facility"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"FacilityConsolidatedBalancesResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"POST","path":"/holdings/creditAgreements/facilities/directDebits","fullPath":"/api/v6.0.0/holdings/creditAgreements/facilities/directDebits","operationId":"createFacilityDirectDebitLink","name":"Links a direct debit to an existing facility","summary":"Links a direct debit to a facility","tags":[],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"customers":[{}],"arrangement":"string","productId":"string","currency":"string","effectiveDate":"2024-01-01","extensions":{},"settlement":[{}]}},"responses":{"200":"createFacilityDirectDebitLinkResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"POST","path":"/holdings/creditAgreements/facilities/drawings/directDebits","fullPath":"/api/v6.0.0/holdings/creditAgreements/facilities/drawings/directDebits","operationId":"createDrawingDirectDebitLink","name":"Link the direct debit to an existing drawing under a facility","summary":"Links a direct debit to a drawing","tags":[],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"customers":[{}],"arrangement":"string","currency":"string","facilityId":"string","effectiveDate":"string","productId":"string","extensions":{},"settlement":[{}]}},"responses":{"200":"createDrawingDirectDebitLinkResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"POST","path":"/holdings/creditAgreements/facilities/rollovers/offers","fullPath":"/api/v6.0.0/holdings/creditAgreements/facilities/rollovers/offers","operationId":"createFacilityRolloverOffer","name":"Create rollover process from the facility where the rollover could be a split rollover, merge rollover or a one to one rollover. Split also called as one to many will rollover an old loan and create multiple new offer loans. Merge also called as many to one will rollover multiple old loans simultaneously and create a single new offer loan. Rollover also called as one to one will simply rollover an old loan and create a new offer loan","summary":"Create rollover offer from facility","tags":[],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"arrangement":"string","rolloverDate":"string","extensions":{},"splitsMerges":[{}]}},"responses":{"200":"createFacilityRolloverOfferResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"POST","path":"/holdings/creditAgreements/drawdowns/rollovers/offers","fullPath":"/api/v6.0.0/holdings/creditAgreements/drawdowns/rollovers/offers","operationId":"createDrawdownRolloverOffer","name":"Create rollover process from the drawdown where the rollover could be a split rollover, merge rollover or a one to one rollover. Split also called as one to many will rollover an old loan and create multiple new offer loans. Merge also called as many to one will rollover multiple old loans simultaneously and create a single new offer loan. Rollover also called as one to one will simply rollover an old loan and create a new offer loan","summary":"Create rollover offer from drawdown","tags":[],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"arrangement":"string","rolloverDate":"string","extensions":{},"splitsMerges":[{}]}},"responses":{"200":"createDrawdownRolloverOfferResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"POST","path":"/holdings/creditAgreements/facilities/commitmentIncreases/{arrangementId}","fullPath":"/api/v6.0.0/holdings/creditAgreements/facilities/commitmentIncreases/{arrangementId}","operationId":"updateFacilityCommitmentIncrease","name":"Increase the facility amount to facilitate further drawdowns","summary":"Increase facility amount","tags":[],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"arrangementId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"productId":"string","effectiveDate":"2024-01-01","extensions":{},"facommitment":[{}]}},"responses":{"200":"updateFacilityCommitmentIncreaseResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"POST","path":"/holdings/creditAgreements/facilities/commitmentTerms/{arrangementId}","fullPath":"/api/v6.0.0/holdings/creditAgreements/facilities/commitmentTerms/{arrangementId}","operationId":"updateFacilityCommitmentTerms","name":"Updates facility tenure by increasing or decreasing the term, in addition it allows the amendment of the availability schedule of the contract.","summary":"Update facility maturity date and availability","tags":[],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"arrangementId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"productId":"string","effectiveDate":"2024-01-01","extensions":{},"facommitment":[{}]}},"responses":{"200":"updateFacilityCommitmentTermsResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"GET","path":"/holdings/customers/{customerId}/creditAgreements/exposure","fullPath":"/api/v6.0.0/holdings/customers/{customerId}/creditAgreements/exposure","operationId":"getCustomerExposure","name":"Retrieves the customer exposure such as the facility number, type of facility, maturity date and various amounts of the facilities/standalone loans.","summary":"Retrieves the customer exposure for facilities and loans","tags":[],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"Identifier of the customer"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"CustomerExposureResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/customers/{customerId}/creditAgreements/drawings","fullPath":"/api/v6.0.0/holdings/customers/{customerId}/creditAgreements/drawings","operationId":"getCustomerDrawings","name":"Retrieves the details such as the drawing id, account number, short description of the loan, customer name and loan status for a customer. ","summary":"Retrieves the drawing details for a customer.","tags":[],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"Identifier of the customer"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"CustomerDrawingsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/customers/{customerId}/creditAgreements/facilities","fullPath":"/api/v6.0.0/holdings/customers/{customerId}/creditAgreements/facilities","operationId":"getCustomerFacilities","name":"Retrieves the details such as the facility id, account number, short description of the facility, customer name and facility status for a customer.","summary":"Retrieves the facility details for a customer.","tags":[],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"Identifier of the customer"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"CustomerFacilitiesResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/customers/{customerId}/creditAgreements/deals","fullPath":"/api/v6.0.0/holdings/customers/{customerId}/creditAgreements/deals","operationId":"getCustomerDeals","name":"Retrieves the details such as the deal id, account number, short description of the facility, customer name and deal status for a customer.","summary":"Retrieves the deal details for a customer.","tags":[],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"Identifier of the customer"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"CustomerDealsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/creditAgreements/deals/{dealId}/facilities","fullPath":"/api/v6.0.0/holdings/creditAgreements/deals/{dealId}/facilities","operationId":"getFacilitiesUnderDeal","name":"Retrieves the details such as facility id, title, currency, status and commitment amount for all the facilities under a deal.","summary":"Retrieves the details of facilities under a deal.","tags":[],"parameters":[{"name":"dealId","in":"path","type":"string","required":true,"description":"Unique identifier (contract number) of the corporate deals"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"FacilitiesUnderDealResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/creditAgreements/productCatalogues","fullPath":"/api/v6.0.0/holdings/creditAgreements/productCatalogues","operationId":"getCreditAgreementsProductCatalogue","name":"Retrieves the list of available products for credit agreements.","summary":"Retrieves the credit agreements product catalogue.","tags":[],"parameters":[{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"CreditAgreementsProductCatalogueResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/creditAgreements/drawings/{drawingId}/pendingActivities","fullPath":"/api/v6.0.0/holdings/creditAgreements/drawings/{drawingId}/pendingActivities","operationId":"getPendingActivities","name":"Retrieves the details such as rollover date, rollover status etc of pending drawdowns and rollovers for a drawing.","summary":"Retrieves the details of pending drawdowns and rollovers for a drawing.","tags":[],"parameters":[{"name":"drawingId","in":"path","type":"string","required":true,"description":"Identifier of drawings application under the Letter of Credit system that is used to effect the transfer of funds and the acceptance of documents under Letters of Credit and Documentary Collection tra"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"PendingActivitiesResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/creditAgreements/drawings/expiries","fullPath":"/api/v6.0.0/holdings/creditAgreements/drawings/expiries","operationId":"getLoansExpiring","name":"Retrieves the drawings expiring in the next 7 days.","summary":"Retrieves expiring drawings.","tags":[],"parameters":[{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"LoansExpiringResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/creditAgreements/facilities/expiries","fullPath":"/api/v6.0.0/holdings/creditAgreements/facilities/expiries","operationId":"getFacilitiesExpiring","name":"Retrieves the facilities expiring in the next 7 days","summary":"Retrieves expiring facilities","tags":[],"parameters":[{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"FacilitiesExpiringResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/creditAgreements/drawings/{drawingId}/balances","fullPath":"/api/v6.0.0/holdings/creditAgreements/drawings/{drawingId}/balances","operationId":"getDrawingBalances","name":"Retrieves the balance details such as commitment balances, utilized balances.","summary":"Retrieves drawing balances","tags":[],"parameters":[{"name":"drawingId","in":"path","type":"string","required":true,"description":"Identifier of drawings application under the Letter of Credit system that is used to effect the transfer of funds and the acceptance of documents under Letters of Credit and Documentary Collection tra"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"DrawingBalancesResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/creditAgreements/drawings/{drawingId}/OverdueBalances","fullPath":"/api/v6.0.0/holdings/creditAgreements/drawings/{drawingId}/OverdueBalances","operationId":"getDrawingOverdueBalances","name":"Retrieves the past dues and overdues for a drawing","summary":"Retrieves drawing overdue balances","tags":[],"parameters":[{"name":"drawingId","in":"path","type":"string","required":true,"description":"Identifier of drawings application under the Letter of Credit system that is used to effect the transfer of funds and the acceptance of documents under Letters of Credit and Documentary Collection tra"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"DrawingOverdueBalancesResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"POST","path":"/holdings/creditAgreements/facilities/clubFacilities","fullPath":"/api/v6.0.0/holdings/creditAgreements/facilities/clubFacilities","operationId":"createClubFacilities","name":"Creates a club facility with facility details along with the details of participating lenders","summary":"Creates a club facility","tags":[],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"customers":[{}],"productId":"string","currency":"string","effectiveDate":"2024-01-01","extensions":{},"account":[{}],"settlement":[{}],"facommitment":[{}],"upfrontfee":[{}],"coordinationfee":[{}],"limit":[{}],"participant":[{}],"riskparticipant":[{}]}},"responses":{"200":"createClubFacilitiesResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"POST","path":"/holdings/creditAgreements/facilities/drawings/clubDrawings","fullPath":"/api/v6.0.0/holdings/creditAgreements/facilities/drawings/clubDrawings","operationId":"createClubDrawings","name":"Creates a club drawing arrangement with drawdown details along with the details of participating lenders","summary":"Creates a club drawing","tags":[],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"customers":[{}],"arrangmentId":"string","currency":"string","facilityId":"string","effectiveDate":"string","activity":"string","productId":"string","extensions":{},"account":[{}],"escrow":[{}],"dwcommitment":[{}],"settlement":[{}],"participant":[{}],"riskparticipant":[{}]}},"responses":{"200":"createClubDrawingsResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"GET","path":"/holdings/creditAgreements/facilities/drawings/{drawingId}/participants","fullPath":"/api/v6.0.0/holdings/creditAgreements/facilities/drawings/{drawingId}/participants","operationId":"getClubDrawingParticipants","name":"Retrieves the participation details of the lending arrangement for a customer. This will be used to view the agent bank and the participant details and the share amounts when an arrangement id is passed as an input.","summary":"Retrieves the participant details","tags":[],"parameters":[{"name":"drawingId","in":"path","type":"string","required":true,"description":"Identifier of drawings application under the Letter of Credit system that is used to effect the transfer of funds and the acceptance of documents under Letters of Credit and Documentary Collection tra"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"ClubDrawingParticipantsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"POST","path":"/holdings/creditAgreements/facilities/{facilityId}/fundedShareTransfers","fullPath":"/api/v6.0.0/holdings/creditAgreements/facilities/{facilityId}/fundedShareTransfers","operationId":"createFacilityFundedShareTransfer","name":"Creates a funded share transfer for a facility when participant details are passed. Share of a funding participant is transferred to another funding participant in a club facility and underlying drawings","summary":"Creates a funded share transfer for a facility","tags":[],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"facilityId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"productId":"string","effectiveDate":"2024-01-01","extensions":{},"shareTransfer":[{}]}},"responses":{"200":"createFacilityFundedShareTransferResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"POST","path":"/holdings/creditAgreements/facilities/drawings/{drawingId}/fundedShareTransfers","fullPath":"/api/v6.0.0/holdings/creditAgreements/facilities/drawings/{drawingId}/fundedShareTransfers","operationId":"createDrawingFundedShareTransfer","name":"Creates a funded share transfer for a drawing under a facility when participant details are passed. Share of a funding participant is transferred to another funding participant in a standalone club loan","summary":"Creates a funded share transfer for a drawing","tags":[],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"drawingId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"productId":"string","effectiveDate":"2024-01-01","extensions":{},"shareTransfer":[{}]}},"responses":{"200":"createDrawingFundedShareTransferResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"POST","path":"/holdings/creditAgreements/facilities/{facilityId}/riskShareTransfers","fullPath":"/api/v6.0.0/holdings/creditAgreements/facilities/{facilityId}/riskShareTransfers","operationId":"createFacilityRiskShareTransfer","name":"Creates a risk share transfer for a facility when participant details are passed. The risk of the own bank in a facility is mitigated by selling a portion risk to another financial institution","summary":"Creates a risk share transfer for a facility","tags":[],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"facilityId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"productId":"string","effectiveDate":"2024-01-01","extensions":{},"shareTransfer":[{}]}},"responses":{"200":"createFacilityRiskShareTransferResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"POST","path":"/holdings/creditAgreements/facilities/drawings/{drawingId}/riskShareTransfers","fullPath":"/api/v6.0.0/holdings/creditAgreements/facilities/drawings/{drawingId}/riskShareTransfers","operationId":"createDrawingRiskShareTransfer","name":"Creates a risk share transfer for a drawing under a facility when participant details are passed. The risk of the own bank in a loan is mitigated by selling a portion risk to another financial institution","summary":"Creates a risk share transfer for a drawing","tags":[],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"drawingId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"productId":"string","effectiveDate":"2024-01-01","extensions":{},"shareTransfer":[{}]}},"responses":{"200":"createDrawingRiskShareTransferResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"POST","path":"/holdings/creditAgreements/guarantees/{guaranteeId}/guaranteeIncreases","fullPath":"/api/v6.0.0/holdings/creditAgreements/guarantees/{guaranteeId}/guaranteeIncreases","operationId":"updateGuaranteeCommitmentIncrease","name":"Increase the commitment amount of the guarantee that the financial institution has issued on behalf of the applicant","summary":"Increase the commitment amount of the guarantee","tags":[],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"guaranteeId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"productId":"string","effectiveDate":"2024-01-01","extensions":{},"gteecommitment":[{}]}},"responses":{"200":"updateGuaranteeCommitmentIncreaseResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"POST","path":"/holdings/creditAgreements/guarantees/{guaranteeId}/guaranteeDecreases","fullPath":"/api/v6.0.0/holdings/creditAgreements/guarantees/{guaranteeId}/guaranteeDecreases","operationId":"updateGuaranteeCommitmentDecrease","name":"Decrease the commitment amount of the guarantee that the financial institution has issued on behalf of the applicant","summary":"Decrease the commitment amount of the guarantee","tags":[],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"guaranteeId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"productId":"string","effectiveDate":"2024-01-01","extensions":{},"gteecommitment":[{}]}},"responses":{"200":"updateGuaranteeCommitmentDecreaseResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"POST","path":"/holdings/creditAgreements/guarantees","fullPath":"/api/v6.0.0/holdings/creditAgreements/guarantees","operationId":"createCreditAgreementGuarantee","name":"Register the issuance of a new guarantee undertaking on behalf of the applicant when all the basic details relevant to the undertaking are passed","summary":"Register the issuance of a guarantee","tags":[],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"customers":[{}],"productId":"string","currency":"string","effectiveDate":"2024-01-01","facilityId":"string","extensions":{},"gteecommitment":[{}],"newarrfee":[{}],"settlement":[{}],"termsConditions":[{}]}},"responses":{"200":"createCreditAgreementGuaranteeResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"POST","path":"/holdings/creditAgreements/guarantees/clubGuarantees","fullPath":"/api/v6.0.0/holdings/creditAgreements/guarantees/clubGuarantees","operationId":"createClubGuarantee","name":"Create a club guarantee with guarantee details along with the details of participating lenders","summary":"Create a club guarantee","tags":[],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"customers":[{}],"productId":"string","currency":"string","effectiveDate":"2024-01-01","facilityId":"string","extensions":{},"account":[{}],"gteecommitment":[{}],"newarrfee":[{}],"settlement":[{}],"termsConditions":[{}],"participant":[{}]}},"responses":{"200":"createClubGuaranteeResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"POST","path":"/holdings/creditAgreements/guarantees/{guaranteeId}/cancellations","fullPath":"/api/v6.0.0/holdings/creditAgreements/guarantees/{guaranteeId}/cancellations","operationId":"cancelCorporateGuarantee","name":"Cancel a guarantee arrangement before its expiry date. All the accrued fees are made-due for collection and the bank is discharged of its liability.","summary":"Cancel a guarantee arrangement before the expiry date.","tags":[],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"guaranteeId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"productId":"string","effectiveDate":"2024-01-01","extensions":{},"settlement":[{}]}},"responses":{"200":"cancelCorporateGuaranteeResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"POST","path":"/holdings/creditAgreements/deals","fullPath":"/api/v6.0.0/holdings/creditAgreements/deals","operationId":"createDeals","name":"Creates a new deal for the customer with the details like product, term and amount . Corporate Deal is a credit agreement between two parties- the lender and the borrower, who agree to certain terms and conditions along with their rights and obligations","summary":"Creates Corporate Deals","tags":[],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"customers":[{}],"productId":"string","currency":"string","effectiveDate":"2024-01-01","extensions":{},"settlement":[{}],"facilityRules":[{}],"dacommitment":[{}],"adminfee":[{}],"coordinationfee":[{}],"upfrontfee":[{}],"limit":[{}]}},"responses":{"200":"createDealsResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"PUT","path":"/holdings/creditAgreements/{creditAgreementId}/commitmentTerms","fullPath":"/api/v6.0.0/holdings/creditAgreements/{creditAgreementId}/commitmentTerms","operationId":"updateFacilityTerm","name":"Decrease/Increase the maturity period of the facility","summary":"Decrease/ Increase the maturity period of the credit agreement(facility)","tags":["RETAIL"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"creditAgreementId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"effectiveDate":"2024-01-01","activityId":"string","externalEventStatus":"string","extensions":{},"agentCommission":[{}],"schedule":[{}],"feeschedule":[{}],"facommitment":[{}]}},"responses":{"200":"updateFacilityTermResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"PUT","path":"/holdings/creditAgreements/{creditAgreementId}/cancelFacility","fullPath":"/api/v6.0.0/holdings/creditAgreements/{creditAgreementId}/cancelFacility","operationId":"cancelFacility","name":"Perform the full credit agreement (facility) cancellation","summary":"Cancel the facility for buy now pay later service","tags":["RETAIL"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"creditAgreementId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"effectiveDate":"2024-01-01","activityId":"string","externalEventStatus":"string","extensions":{},"account":[{}]}},"responses":{"200":"cancelFacilityResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"POST","path":"/holdings/creditAgreements/buyNowPayLater/facilities","fullPath":"/api/v6.0.0/holdings/creditAgreements/buyNowPayLater/facilities","operationId":"createFacility","name":"Creates corporate facilities","summary":"Creates corporate facilities","tags":["RETAIL"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"customers":[{}],"productId":"string","currency":"string","effectiveDate":"2024-01-01","dealId":"string","extensions":{},"settlement":[{}],"facommitment":[{}],"upfrontfee":[{}],"coordinationfee":[{}],"limit":[{}]}},"responses":{"200":"createFacilityResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"PUT","path":"/holdings/creditAgreements/{creditAgreementId}/commitmentIncreases","fullPath":"/api/v6.0.0/holdings/creditAgreements/{creditAgreementId}/commitmentIncreases","operationId":"updateFacilityTopupAmount","name":"Increase the commitment amount of the credit agreement (facility) with the incremental amount","summary":"Increase the commitment amount of the facility","tags":["RETAIL"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"creditAgreementId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"effectiveDate":"2024-01-01","activityId":"string","externalEventStatus":"string","extensions":{},"facommitment":[{}]}},"responses":{"200":"updateFacilityTopupAmountResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"PUT","path":"/holdings/creditAgreements/{creditAgreementId}/commitmentDecreases","fullPath":"/api/v6.0.0/holdings/creditAgreements/{creditAgreementId}/commitmentDecreases","operationId":"updateFacilityDecreaseAmount","name":"Decrease the commitment amount of the credit agreement (facility) by the specified amount","summary":"Decrease the commitment amount of the facility","tags":["RETAIL"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"creditAgreementId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"effectiveDate":"2024-01-01","activityId":"string","externalEventStatus":"string","extensions":{},"facommitment":[{}]}},"responses":{"200":"updateFacilityDecreaseAmountResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}}]},{"key":"holdings-creditAgreements-api-service-v7.0.0","title":"Corporate Credit Agreements","version":"v7.0.0","description":"API for the creation and management of credit agreements for corporate customers. The types of credit agreements are single level facility, credit agreement with multiple facilities, club loans with agency and syndicated loans","endpointCount":64,"endpoints":[{"method":"POST","path":"/holdings/creditAgreements/deals/offers","fullPath":"/api/v7.0.0/holdings/creditAgreements/deals/offers","operationId":"createDealOffer","name":"Creates new offer deal for the required customer when the mandatory input details are provided. Offer deal creates a draft contract and allows the users to negotiate multiple times. Offer deal is a draft contract and will not affect the balance sheet of the bank.","summary":"Creates an offer for a deal contract","tags":["CORPORATE"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"customers":[{}],"productId":"string","currency":"string","effectiveDate":"2024-01-01","activity":"string","extensions":{},"facilityRules":[{}],"dacommitment":[{}],"adminfee":[{}],"coordinationfee":[{}],"upfrontfee":[{}],"limit":[{}]}},"responses":{"200":"createDealOfferResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"POST","path":"/holdings/creditAgreements/facilities/offers","fullPath":"/api/v7.0.0/holdings/creditAgreements/facilities/offers","operationId":"createFacilityOffer","name":"Creates a new offer facility for the required customer when at least the mandatory input is provided. Offer facility creates a draft contract and allow the users to negotiate multiple times. Offer facility is a draft contract and will not affect the balance sheet of the bank.","summary":"Creates an offer for a facility contract","tags":["CORPORATE"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"customers":[{}],"productId":"string","currency":"string","dealId":"string","effectiveDate":"2024-01-01","activity":"string","extensions":{},"settlement":[{}],"facommitment":[{}],"upfrontfee":[{}],"coordinationfee":[{}],"limit":[{}]}},"responses":{"200":"createFacilityOfferResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"POST","path":"/holdings/creditAgreements/deals/offers/cancellations/{arrangementId}","fullPath":"/api/v7.0.0/holdings/creditAgreements/deals/offers/cancellations/{arrangementId}","operationId":"deleteDealOffer","name":"Deletes a new offer for the required deal contract when at least the mandatory input is provided. Deal offer is a draft contract, which allow the user to delete the contract online and deal offer contract will not affect the balance sheet of the bank.","summary":"Deletes an offer for a deal contract","tags":["CORPORATE"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"arrangementId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"productId":"string","effectiveDate":"2024-01-01","extensions":{}}},"responses":{"200":"deleteDealOfferResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"POST","path":"/holdings/creditAgreements/facilities/offers/cancellations/{arrangementId}","fullPath":"/api/v7.0.0/holdings/creditAgreements/facilities/offers/cancellations/{arrangementId}","operationId":"deleteFacilityOffer","name":"Deletes a new offer for the required facility contract when at least the mandatory input is provided. Facility offer is a draft contract, which allow the user to delete the contract online and facility offer contract will not affect the balance sheet of the bank.","summary":"Deletes an offer for a facility contract","tags":["CORPORATE"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"arrangementId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"productId":"string","effectiveDate":"2024-01-01","extensions":{}}},"responses":{"200":"deleteFacilityOfferResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"POST","path":"/holdings/creditAgreements/deals/offers/acceptances/{arrangementId}","fullPath":"/api/v7.0.0/holdings/creditAgreements/deals/offers/acceptances/{arrangementId}","operationId":"acceptDealOffer","name":"On executing acceptance, the contract is changed from offer to live deal for the required customer when at least the mandatory input is provided. Process will check all the required mandatory inputs and prompt an error message when mandatory details are not provided. Once the accept deal offer is processed further offer negotiation is not allowed.","summary":"Accept the deal offer and execute the contract to live","tags":["CORPORATE"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"arrangementId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"productId":"string","effectiveDate":"2024-01-01","extensions":{},"settlement":[{}],"facilityRules":[{}],"dacommitment":[{}],"adminfee":[{}],"coordinationfee":[{}],"upfrontfee":[{}],"limit":[{}]}},"responses":{"200":"acceptDealOfferResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"POST","path":"/holdings/creditAgreements/facilities/offers/acceptances/{arrangementId}","fullPath":"/api/v7.0.0/holdings/creditAgreements/facilities/offers/acceptances/{arrangementId}","operationId":"acceptFacilityOffer","name":"On executing acceptance, the contract is changed from offer to live facility for the required customer when at least the mandatory input is provided. Process will check all the required mandatory inputs and prompt an error message when mandatory details are not provided. Once the accept deal offer is processed further offer negotiation is not allowed.","summary":"Accept the facility offer and execute the contract to live","tags":["CORPORATE"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"arrangementId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"productId":"string","effectiveDate":"2024-01-01","extensions":{},"settlement":[{}],"facommitment":[{}],"upfrontfee":[{}],"coordinationfee":[{}],"limit":[{}]}},"responses":{"200":"acceptFacilityOfferResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"POST","path":"/holdings/creditAgreements/drawdowns/offers","fullPath":"/api/v7.0.0/holdings/creditAgreements/drawdowns/offers","operationId":"createDrawdownOffer","name":"Creates a new drawdown offer for the required customer. ","summary":"Creates a new drawdown offer for the required customer. ","tags":["CORPORATE"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"customers":[{}],"productId":"string","currency":"string","facilityId":"string","offerDate":"2024-01-01","drawdownDate":"2024-01-01","activity":"string","extensions":{},"maintenancefee":[{}],"dwcommitment":[{}],"settlement":[{}]}},"responses":{"200":"createDrawdownOfferResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"POST","path":"/holdings/creditAgreements/drawdowns/offers/negotiations","fullPath":"/api/v7.0.0/holdings/creditAgreements/drawdowns/offers/negotiations","operationId":"createOfferDrawdownRenegotiation","name":"Renegotiate the offer drawdown for the required customer.","summary":"Renegotiate the offer drawdown for the required customer.","tags":["CORPORATE"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"productId":"string","drawdownDate":"2024-01-01","extensions":{},"maintenancefee":[{}],"settlement":[{}]}},"responses":{"200":"createOfferDrawdownRenegotiationResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"POST","path":"/holdings/creditAgreements/drawdowns/offers/cancellations","fullPath":"/api/v7.0.0/holdings/creditAgreements/drawdowns/offers/cancellations","operationId":"deleteDrawdownOffer","name":"Cancellation of offer drawdown for the required customer.","summary":"Cancellation of offer drawdown for the required customer.","tags":["CORPORATE"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"productId":"string","drawdownDate":"2024-01-01","extensions":{}}},"responses":{"200":"deleteDrawdownOfferResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"POST","path":"/holdings/creditAgreements/drawdowns/offers/acceptances","fullPath":"/api/v7.0.0/holdings/creditAgreements/drawdowns/offers/acceptances","operationId":"acceptOfferDrawdown","name":"Convert an offer drawdown to a live drawdown for the required customer.","summary":"Convert an offer drawdown to a live drawdown for the required customer.","tags":["CORPORATE"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"productId":"string","drawdownDate":"2024-01-01","extensions":{},"maintenancefee":[{}],"dwcommitment":[{}],"settlement":[{}]}},"responses":{"200":"acceptOfferDrawdownResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"GET","path":"/holdings/creditAgreements/facilities/{facilityId}/drawingProducts","fullPath":"/api/v7.0.0/holdings/creditAgreements/facilities/{facilityId}/drawingProducts","operationId":"getFacilityDrawingProducts","name":"Retrieves the available drawing products under the facility ","summary":"Retrieves the available drawing products under the facility ","tags":["CORPORATE"],"parameters":[{"name":"facilityId","in":"path","type":"string","required":true,"description":"Unique identifier (contract number) of the facility"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"FacilityDrawingProductsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/creditAgreements/facilities/{facilityId}/combinedSchedules","fullPath":"/api/v7.0.0/holdings/creditAgreements/facilities/{facilityId}/combinedSchedules","operationId":"getCombinedSchedules","name":"Retrieves the payment schedule of facility and its drawings","summary":"Retrieves the payment schedule of facility and its drawings","tags":["CORPORATE"],"parameters":[{"name":"facilityId","in":"path","type":"string","required":true,"description":"Unique identifier (contract number) of the facility"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"CombinedSchedulesResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"POST","path":"/holdings/creditAgreements/facilities","fullPath":"/api/v7.0.0/holdings/creditAgreements/facilities","operationId":"createFacilities","name":"Creates corporate facilities","summary":"Creates corporate facilities","tags":["CORPORATE"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"customers":[{}],"productId":"string","currency":"string","effectiveDate":"2024-01-01","dealId":"string","extensions":{},"settlement":[{}],"facommitment":[{}],"upfrontfee":[{}],"coordinationfee":[{}],"limit":[{}]}},"responses":{"200":"createFacilitiesResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"POST","path":"/holdings/creditAgreements/drawdowns","fullPath":"/api/v7.0.0/holdings/creditAgreements/drawdowns","operationId":"createDrawdowns","name":"Creates drawdowns under facility","summary":"Creates drawdowns under facility","tags":["CORPORATE"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"customers":[{}],"arrangmentId":"string","currency":"string","facilityId":"string","effectiveDate":"string","activity":"string","productId":"string","extensions":{},"escrow":[{}],"dwcommitment":[{}],"settlement":[{}]}},"responses":{"200":"createDrawdownsResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"GET","path":"/holdings/creditAgreements/facilities/{facilityId}/drawingRules","fullPath":"/api/v7.0.0/holdings/creditAgreements/facilities/{facilityId}/drawingRules","operationId":"getFacilityDrawingRules","name":"Retrieves the allowed customers, currencies and products for a new drawing under the facility","summary":"Retrieves the allowed customers, currencies and products for a new drawing under the facility","tags":["CORPORATE"],"parameters":[{"name":"facilityId","in":"path","type":"string","required":true,"description":"Unique identifier (contract number) of the facility"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"FacilityDrawingRulesResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/creditAgreements/facilities/{facilityId}/drawings","fullPath":"/api/v7.0.0/holdings/creditAgreements/facilities/{facilityId}/drawings","operationId":"getDrawingsUnderFacility","name":"Retrieves the drawings under a facility","summary":"Retrieves the drawings under a facility","tags":["CORPORATE"],"parameters":[{"name":"facilityId","in":"path","type":"string","required":true,"description":"Unique identifier (contract number) of the facility"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"DrawingsUnderFacilityResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/creditAgreements/facilities/drawings/{drawingId}/parentFacilities","fullPath":"/api/v7.0.0/holdings/creditAgreements/facilities/drawings/{drawingId}/parentFacilities","operationId":"getDrawingFacility","name":"Retrieves the parent facility for a drawing","summary":"Retrieves the parent facility for a drawing","tags":["CORPORATE"],"parameters":[{"name":"drawingId","in":"path","type":"string","required":true,"description":"Identifier of drawings application under the Letter of Credit system that is used to effect the transfer of funds and the acceptance of documents under Letters of Credit and Documentary Collection tra"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"DrawingFacilityResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/creditAgreements/facilities/{facilityId}/commitmentSchedules","fullPath":"/api/v7.0.0/holdings/creditAgreements/facilities/{facilityId}/commitmentSchedules","operationId":"getFacilityCommitmentSchedule","name":"Retrieves the commitment schedule of a facility","summary":"Retrieves the commitment schedule of a facility","tags":["CORPORATE"],"parameters":[{"name":"facilityId","in":"path","type":"string","required":true,"description":"Unique identifier (contract number) of the facility"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"FacilityCommitmentScheduleResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/creditAgreements/facilities/{facilityId}/parentDeals","fullPath":"/api/v7.0.0/holdings/creditAgreements/facilities/{facilityId}/parentDeals","operationId":"getFacilityDeal","name":"Retrieves the parent deal for a facility","summary":"Retrieves the parent deal for a facility","tags":["CORPORATE"],"parameters":[{"name":"facilityId","in":"path","type":"string","required":true,"description":"Unique identifier (contract number) of the facility"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"FacilityDealResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/creditAgreements/facilities/{facilityId}/balances","fullPath":"/api/v7.0.0/holdings/creditAgreements/facilities/{facilityId}/balances","operationId":"getFacilityFinancialSummary","name":"Retrieves the financial summary for a facility arrangement","summary":"Retrieves the financial summary for a facility arrangement","tags":["CORPORATE"],"parameters":[{"name":"facilityId","in":"path","type":"string","required":true,"description":"Unique identifier (contract number) of the facility"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"FacilityFinancialSummaryResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/creditAgreements/facilities/{facilityId}/consolidatedBalances","fullPath":"/api/v7.0.0/holdings/creditAgreements/facilities/{facilityId}/consolidatedBalances","operationId":"getFacilityConsolidatedBalances","name":"Retrieves the consolidated balances for a facility arrangement","summary":"Retrieves the consolidated balances for a facility arrangement","tags":["CORPORATE"],"parameters":[{"name":"facilityId","in":"path","type":"string","required":true,"description":"Unique identifier (contract number) of the facility"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"FacilityConsolidatedBalancesResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"POST","path":"/holdings/creditAgreements/facilities/directDebits","fullPath":"/api/v7.0.0/holdings/creditAgreements/facilities/directDebits","operationId":"createFacilityDirectDebitLink","name":"Links a direct debit to an existing facility","summary":"Links a direct debit to a facility","tags":["CORPORATE"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"customers":[{}],"arrangement":"string","productId":"string","currency":"string","effectiveDate":"2024-01-01","extensions":{},"settlement":[{}]}},"responses":{"200":"createFacilityDirectDebitLinkResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"POST","path":"/holdings/creditAgreements/facilities/drawings/directDebits","fullPath":"/api/v7.0.0/holdings/creditAgreements/facilities/drawings/directDebits","operationId":"createDrawingDirectDebitLink","name":"Link the direct debit to an existing drawing under a facility","summary":"Links a direct debit to a drawing","tags":["CORPORATE"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"customers":[{}],"arrangement":"string","currency":"string","facilityId":"string","effectiveDate":"string","productId":"string","extensions":{},"settlement":[{}]}},"responses":{"200":"createDrawingDirectDebitLinkResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"POST","path":"/holdings/creditAgreements/facilities/rollovers/offers","fullPath":"/api/v7.0.0/holdings/creditAgreements/facilities/rollovers/offers","operationId":"createFacilityRolloverOffer","name":"Create rollover process from the facility where the rollover could be a split rollover, merge rollover or a one to one rollover. Split also called as one to many will rollover an old loan and create multiple new offer loans. Merge also called as many to one will rollover multiple old loans simultaneously and create a single new offer loan. Rollover also called as one to one will simply rollover an old loan and create a new offer loan","summary":"Create rollover offer from facility","tags":["CORPORATE"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"arrangement":"string","rolloverDate":"string","productId":"string","extensions":{},"splitsMerges":[{}]}},"responses":{"200":"createFacilityRolloverOfferResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"POST","path":"/holdings/creditAgreements/drawdowns/rollovers/offers","fullPath":"/api/v7.0.0/holdings/creditAgreements/drawdowns/rollovers/offers","operationId":"createDrawdownRolloverOffer","name":"Create rollover process from the drawdown where the rollover could be a split rollover, merge rollover or a one to one rollover. Split also called as one to many will rollover an old loan and create multiple new offer loans. Merge also called as many to one will rollover multiple old loans simultaneously and create a single new offer loan. Rollover also called as one to one will simply rollover an old loan and create a new offer loan","summary":"Create rollover offer from drawdown","tags":["CORPORATE"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"arrangement":"string","rolloverDate":"string","productId":"string","extensions":{},"splitsMerges":[{}]}},"responses":{"200":"createDrawdownRolloverOfferResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"POST","path":"/holdings/creditAgreements/facilities/commitmentIncreases/{arrangementId}","fullPath":"/api/v7.0.0/holdings/creditAgreements/facilities/commitmentIncreases/{arrangementId}","operationId":"updateFacilityCommitmentIncrease","name":"Increase the facility amount to facilitate further drawdowns","summary":"Increase facility amount","tags":["CORPORATE"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"arrangementId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"productId":"string","effectiveDate":"2024-01-01","extensions":{},"facommitment":[{}]}},"responses":{"200":"updateFacilityCommitmentIncreaseResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"POST","path":"/holdings/creditAgreements/facilities/commitmentTerms/{arrangementId}","fullPath":"/api/v7.0.0/holdings/creditAgreements/facilities/commitmentTerms/{arrangementId}","operationId":"updateFacilityCommitmentTerms","name":"Updates facility tenure by increasing or decreasing the term, in addition it allows the amendment of the availability schedule of the contract.","summary":"Update facility maturity date and availability","tags":["CORPORATE"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"arrangementId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"productId":"string","effectiveDate":"2024-01-01","extensions":{},"facommitment":[{}]}},"responses":{"200":"updateFacilityCommitmentTermsResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"GET","path":"/holdings/customers/{customerId}/creditAgreements/exposures","fullPath":"/api/v7.0.0/holdings/customers/{customerId}/creditAgreements/exposures","operationId":"getCustomerExposure","name":"Retrieves the customer exposure such as the facility number, type of facility, maturity date and various amounts of the facilities/standalone loans.","summary":"Retrieves the customer exposure for facilities and loans","tags":["CORPORATE"],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"Identifier of the customer"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"CustomerExposureResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/customers/{customerId}/creditAgreements/drawings","fullPath":"/api/v7.0.0/holdings/customers/{customerId}/creditAgreements/drawings","operationId":"getCustomerDrawings","name":"Retrieves the details such as the drawing id, account number, short description of the loan, customer name and loan status for a customer. ","summary":"Retrieves the drawing details for a customer.","tags":["CORPORATE"],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"Identifier of the customer"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"CustomerDrawingsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/customers/{customerId}/creditAgreements/facilities","fullPath":"/api/v7.0.0/holdings/customers/{customerId}/creditAgreements/facilities","operationId":"getCustomerFacilities","name":"Retrieves the details such as the facility id, account number, short description of the facility, customer name and facility status for a customer.","summary":"Retrieves the facility details for a customer.","tags":["CORPORATE"],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"Identifier of the customer"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"CustomerFacilitiesResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/customers/{customerId}/creditAgreements/deals","fullPath":"/api/v7.0.0/holdings/customers/{customerId}/creditAgreements/deals","operationId":"getCustomerDeals","name":"Retrieves the details such as the deal id, account number, short description of the facility, customer name and deal status for a customer.","summary":"Retrieves the deal details for a customer.","tags":["CORPORATE"],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"Identifier of the customer"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"CustomerDealsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/creditAgreements/deals/{dealId}/facilities","fullPath":"/api/v7.0.0/holdings/creditAgreements/deals/{dealId}/facilities","operationId":"getFacilitiesUnderDeal","name":"Retrieves the details such as facility id, title, currency, status and commitment amount for all the facilities under a deal.","summary":"Retrieves the details of facilities under a deal.","tags":["CORPORATE"],"parameters":[{"name":"dealId","in":"path","type":"string","required":true,"description":"Unique identifier (contract number) of the corporate deals"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"FacilitiesUnderDealResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/creditAgreements/productCatalogues","fullPath":"/api/v7.0.0/holdings/creditAgreements/productCatalogues","operationId":"getCreditAgreementsProductCatalogue","name":"Retrieves the list of available products for credit agreements.","summary":"Retrieves the credit agreements product catalogue.","tags":["CORPORATE"],"parameters":[{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"CreditAgreementsProductCatalogueResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/creditAgreements/drawings/{drawingId}/pendingActivities","fullPath":"/api/v7.0.0/holdings/creditAgreements/drawings/{drawingId}/pendingActivities","operationId":"getPendingActivities","name":"Retrieves the details such as rollover date, rollover status etc of pending drawdowns and rollovers for a drawing.","summary":"Retrieves the details of pending drawdowns and rollovers for a drawing.","tags":["CORPORATE"],"parameters":[{"name":"drawingId","in":"path","type":"string","required":true,"description":"Identifier of drawings application under the Letter of Credit system that is used to effect the transfer of funds and the acceptance of documents under Letters of Credit and Documentary Collection tra"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"PendingActivitiesResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/creditAgreements/drawings/expiries","fullPath":"/api/v7.0.0/holdings/creditAgreements/drawings/expiries","operationId":"getLoansExpiring","name":"Retrieves the drawings expiring in the next 7 days.","summary":"Retrieves expiring drawings.","tags":["CORPORATE"],"parameters":[{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"LoansExpiringResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/creditAgreements/facilities/expiries","fullPath":"/api/v7.0.0/holdings/creditAgreements/facilities/expiries","operationId":"getFacilitiesExpiring","name":"Retrieves the facilities expiring in the next 7 days","summary":"Retrieves expiring facilities","tags":["CORPORATE"],"parameters":[{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"FacilitiesExpiringResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/creditAgreements/drawings/{drawingId}/balances","fullPath":"/api/v7.0.0/holdings/creditAgreements/drawings/{drawingId}/balances","operationId":"getDrawingBalances","name":"Retrieves the balance details such as commitment balances, utilized balances.","summary":"Retrieves drawing balances","tags":["CORPORATE"],"parameters":[{"name":"drawingId","in":"path","type":"string","required":true,"description":"Identifier of drawings application under the Letter of Credit system that is used to effect the transfer of funds and the acceptance of documents under Letters of Credit and Documentary Collection tra"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"DrawingBalancesResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/creditAgreements/drawings/{drawingId}/OverdueBalances","fullPath":"/api/v7.0.0/holdings/creditAgreements/drawings/{drawingId}/OverdueBalances","operationId":"getDrawingOverdueBalances","name":"Retrieves the past dues and overdues for a drawing","summary":"Retrieves drawing overdue balances","tags":["CORPORATE"],"parameters":[{"name":"drawingId","in":"path","type":"string","required":true,"description":"Identifier of drawings application under the Letter of Credit system that is used to effect the transfer of funds and the acceptance of documents under Letters of Credit and Documentary Collection tra"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"DrawingOverdueBalancesResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/creditAgreements/facilities/clubFacilities","fullPath":"/api/v7.0.0/holdings/creditAgreements/facilities/clubFacilities","operationId":"getClubFacilities","name":"Retrieves club facilities, drawings and deal","summary":"Retrieves club facilities, drawings and deal","tags":["CORPORATE"],"parameters":[{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"ClubFacilitiesResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"POST","path":"/holdings/creditAgreements/facilities/clubFacilities","fullPath":"/api/v7.0.0/holdings/creditAgreements/facilities/clubFacilities","operationId":"createClubFacilities","name":"Creates a club facility with facility details along with the details of participating lenders","summary":"Creates a club facility","tags":["CORPORATE"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"customers":[{}],"productId":"string","currency":"string","effectiveDate":"2024-01-01","extensions":{},"account":[{}],"settlement":[{}],"facommitment":[{}],"upfrontfee":[{}],"coordinationfee":[{}],"limit":[{}],"participant":[{}],"riskparticipant":[{}]}},"responses":{"200":"createClubFacilitiesResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"POST","path":"/holdings/creditAgreements/facilities/drawings/clubDrawings","fullPath":"/api/v7.0.0/holdings/creditAgreements/facilities/drawings/clubDrawings","operationId":"createClubDrawings","name":"Creates a club drawing arrangement with drawdown details along with the details of participating lenders","summary":"Creates a club drawing","tags":["CORPORATE"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"customers":[{}],"arrangmentId":"string","currency":"string","facilityId":"string","effectiveDate":"string","activity":"string","productId":"string","extensions":{},"account":[{}],"escrow":[{}],"dwcommitment":[{}],"settlement":[{}],"participant":[{}],"riskparticipant":[{}]}},"responses":{"200":"createClubDrawingsResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"GET","path":"/holdings/creditAgreements/facilities/drawings/{drawingId}/participants","fullPath":"/api/v7.0.0/holdings/creditAgreements/facilities/drawings/{drawingId}/participants","operationId":"getClubDrawingParticipants","name":"Retrieves the participation details of the lending arrangement for a customer. This will be used to view the agent bank and the participant details and the share amounts when an arrangement id is passed as an input.","summary":"Retrieves the participant details","tags":["CORPORATE"],"parameters":[{"name":"drawingId","in":"path","type":"string","required":true,"description":"Identifier of drawings application under the Letter of Credit system that is used to effect the transfer of funds and the acceptance of documents under Letters of Credit and Documentary Collection tra"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"ClubDrawingParticipantsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"POST","path":"/holdings/creditAgreements/facilities/{facilityId}/fundedShareTransfers","fullPath":"/api/v7.0.0/holdings/creditAgreements/facilities/{facilityId}/fundedShareTransfers","operationId":"createFacilityFundedShareTransfer","name":"Creates a funded share transfer for a facility when participant details are passed. Share of a funding participant is transferred to another funding participant in a club facility and underlying drawings","summary":"Creates a funded share transfer for a facility","tags":["CORPORATE"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"facilityId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"productId":"string","effectiveDate":"2024-01-01","extensions":{},"shareTransfer":[{}]}},"responses":{"200":"createFacilityFundedShareTransferResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"POST","path":"/holdings/creditAgreements/facilities/drawings/{drawingId}/fundedShareTransfers","fullPath":"/api/v7.0.0/holdings/creditAgreements/facilities/drawings/{drawingId}/fundedShareTransfers","operationId":"createDrawingFundedShareTransfer","name":"Creates a funded share transfer for a drawing under a facility when participant details are passed. Share of a funding participant is transferred to another funding participant in a standalone club loan","summary":"Creates a funded share transfer for a drawing","tags":["CORPORATE"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"drawingId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"productId":"string","effectiveDate":"2024-01-01","extensions":{},"shareTransfer":[{}]}},"responses":{"200":"createDrawingFundedShareTransferResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"POST","path":"/holdings/creditAgreements/facilities/{facilityId}/riskShareTransfers","fullPath":"/api/v7.0.0/holdings/creditAgreements/facilities/{facilityId}/riskShareTransfers","operationId":"createFacilityRiskShareTransfer","name":"Creates a risk share transfer for a facility when participant details are passed. The risk of the own bank in a facility is mitigated by selling a portion risk to another financial institution","summary":"Creates a risk share transfer for a facility","tags":["CORPORATE"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"facilityId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"productId":"string","effectiveDate":"2024-01-01","extensions":{},"shareTransfer":[{}]}},"responses":{"200":"createFacilityRiskShareTransferResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"POST","path":"/holdings/creditAgreements/facilities/drawings/{drawingId}/riskShareTransfers","fullPath":"/api/v7.0.0/holdings/creditAgreements/facilities/drawings/{drawingId}/riskShareTransfers","operationId":"createDrawingRiskShareTransfer","name":"Creates a risk share transfer for a drawing under a facility when participant details are passed. The risk of the own bank in a loan is mitigated by selling a portion risk to another financial institution","summary":"Creates a risk share transfer for a drawing","tags":["CORPORATE"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"drawingId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"productId":"string","effectiveDate":"2024-01-01","extensions":{},"shareTransfer":[{}]}},"responses":{"200":"createDrawingRiskShareTransferResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"POST","path":"/holdings/creditAgreements/guarantees/{guaranteeId}/guaranteeIncreases","fullPath":"/api/v7.0.0/holdings/creditAgreements/guarantees/{guaranteeId}/guaranteeIncreases","operationId":"updateGuaranteeCommitmentIncrease","name":"Increase the commitment amount of the guarantee that the financial institution has issued on behalf of the applicant","summary":"Increase the commitment amount of the guarantee","tags":["CORPORATE"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"guaranteeId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"productId":"string","effectiveDate":"2024-01-01","extensions":{},"gteecommitment":[{}]}},"responses":{"200":"updateGuaranteeCommitmentIncreaseResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"POST","path":"/holdings/creditAgreements/guarantees/{guaranteeId}/guaranteeDecreases","fullPath":"/api/v7.0.0/holdings/creditAgreements/guarantees/{guaranteeId}/guaranteeDecreases","operationId":"updateGuaranteeCommitmentDecrease","name":"Decrease the commitment amount of the guarantee that the financial institution has issued on behalf of the applicant","summary":"Decrease the commitment amount of the guarantee","tags":["CORPORATE"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"guaranteeId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"productId":"string","effectiveDate":"2024-01-01","extensions":{},"gteecommitment":[{}]}},"responses":{"200":"updateGuaranteeCommitmentDecreaseResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"POST","path":"/holdings/creditAgreements/guarantees","fullPath":"/api/v7.0.0/holdings/creditAgreements/guarantees","operationId":"createCreditAgreementGuarantee","name":"Register the issuance of a new guarantee undertaking on behalf of the applicant when all the basic details relevant to the undertaking are passed","summary":"Register the issuance of a guarantee","tags":["CORPORATE"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"customers":[{}],"productId":"string","currency":"string","effectiveDate":"2024-01-01","facilityId":"string","extensions":{},"gteecommitment":[{}],"newarrfee":[{}],"settlement":[{}],"termsConditions":[{}]}},"responses":{"200":"createCreditAgreementGuaranteeResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"POST","path":"/holdings/creditAgreements/guarantees/clubGuarantees","fullPath":"/api/v7.0.0/holdings/creditAgreements/guarantees/clubGuarantees","operationId":"createClubGuarantee","name":"Create a club guarantee with guarantee details along with the details of participating lenders","summary":"Create a club guarantee","tags":["CORPORATE"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"customers":[{}],"productId":"string","currency":"string","effectiveDate":"2024-01-01","facilityId":"string","extensions":{},"account":[{}],"gteecommitment":[{}],"newarrfee":[{}],"settlement":[{}],"termsConditions":[{}],"participant":[{}]}},"responses":{"200":"createClubGuaranteeResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"POST","path":"/holdings/creditAgreements/guarantees/{guaranteeId}/cancellations","fullPath":"/api/v7.0.0/holdings/creditAgreements/guarantees/{guaranteeId}/cancellations","operationId":"cancelCorporateGuarantee","name":"Cancel a guarantee arrangement before its expiry date. All the accrued fees are made-due for collection and the bank is discharged of its liability.","summary":"Cancel a guarantee arrangement before the expiry date.","tags":["CORPORATE"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"guaranteeId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"productId":"string","effectiveDate":"2024-01-01","extensions":{},"settlement":[{}]}},"responses":{"200":"cancelCorporateGuaranteeResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"POST","path":"/holdings/creditAgreements/deals","fullPath":"/api/v7.0.0/holdings/creditAgreements/deals","operationId":"createDeals","name":"Create a new deal for the customer with the details like product, term and amount . Corporate deal is a credit agreement between two parties- the lender and the borrower, who agree to certain terms and conditions along with their rights and obligations","summary":"Creates corporate deal","tags":["CORPORATE"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"customers":[{}],"productId":"string","currency":"string","effectiveDate":"2024-01-01","extensions":{},"settlement":[{}],"facilityRules":[{}],"dacommitment":[{}],"adminfee":[{}],"coordinationfee":[{}],"upfrontfee":[{}],"limit":[{}]}},"responses":{"200":"createDealsResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"POST","path":"/holdings/creditAgreements/loanTrades/trades","fullPath":"/api/v7.0.0/holdings/creditAgreements/loanTrades/trades","operationId":"createTrade","name":"Create a trade for a syndicated loan as initially agreed upon between counterparties.","summary":"Create a trade for a syndicated loan.","tags":["CORPORATE"],"parameters":[{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"counterPartyDetails":[{}],"dealCustomerDetails":[{}],"dealAdditionalInfo":[{}],"ssi":[{}],"ownBankDetails":[{}],"agentBankDetails":[{}],"consentDetails":[{}],"chargeDetails":[{}],"tradeAccountDetails":[{}],"tradeActivity":"string","alternateId":"string","tradeProduct":"string","tradeDate":"string","tradeCurrency":"string","transferType":"string"}},"responses":{"200":"TradeResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"POST","path":"/holdings/creditAgreements/loanTrades/{loanTradeId}/confirmationTrade","fullPath":"/api/v7.0.0/holdings/creditAgreements/loanTrades/{loanTradeId}/confirmationTrade","operationId":"acceptTrade","name":"Confirm the trade when all the parties involved agreed the terms and conditions of the trade.","summary":"Confirm the trade","tags":["CORPORATE"],"parameters":[{"name":"loanTradeId","in":"path","type":"string","required":true,"description":""},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"dealCustomerDetails":[{}],"dealAdditionalinfos":[{}],"dealReference":"string","dealTitle":"string","currency":"string","globalAmount":"string","startDate":"string","agentBank":"string","agentId":"string","agentName":"string","extensions":{}}},"responses":{"200":"TradeResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"POST","path":"/holdings/creditAgreements/loanTrades/{loanTradeId}","fullPath":"/api/v7.0.0/holdings/creditAgreements/loanTrades/{loanTradeId}","operationId":"updateTrade","name":"Update additional details in trade record.","summary":"Update trade details","tags":["CORPORATE"],"parameters":[{"name":"loanTradeId","in":"path","type":"string","required":true,"description":""},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"dealCustomerDetails":[{}],"dealAdditionalInfo":[{}],"ssi":[{}],"ownBankDetails":[{}],"agentBankDetails":[{}],"chargeDetails":[{}],"tradeAccountDetails":[{}],"alternateId":"string","transferType":"string","expectedSettlementDate":"string","tradeNotes":"string","businessDayCentre":"string","dealReference":"string","dealTitle":"string","currency":"string"}},"responses":{"200":"TradeResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"POST","path":"/holdings/creditAgreements/loanTrades/{loanTradeId}/consents","fullPath":"/api/v7.0.0/holdings/creditAgreements/loanTrades/{loanTradeId}/consents","operationId":"updateConsent","name":"Update borrower consent for trade","summary":"Update consent status if borrower has agreed or rejected trade.","tags":["CORPORATE"],"parameters":[{"name":"loanTradeId","in":"path","type":"string","required":true,"description":""},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"consentDetails":[{}],"chargeDetails":[{}],"tradeStatus":"string","extensions":{}}},"responses":{"200":"ConsentResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"POST","path":"/holdings/creditAgreements/loanTrades/{loanTradeId}/commitments","fullPath":"/api/v7.0.0/holdings/creditAgreements/loanTrades/{loanTradeId}/commitments","operationId":"updateCommitment","name":"Update the trade due to changes in commitment amount being traded.","summary":"Update commitment details","tags":["CORPORATE"],"parameters":[{"name":"loanTradeId","in":"path","type":"string","required":true,"description":""},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"chargeDetails":[{}],"tradeAccountDetails":[{}],"amount":"string","expectedSettlementDate":"string","actualSettlementDate":"string","tradePrice":"string","settlementMethod":"string","allowNetback":"string","allowBoCR":"string","extensions":{}}},"responses":{"200":"CommitmentResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"POST","path":"/holdings/creditAgreements/loanTrades/{loanTradeId}/acceptances","fullPath":"/api/v7.0.0/holdings/creditAgreements/loanTrades/{loanTradeId}/acceptances","operationId":"approveTrade","name":"Finalize the trade to verify all necessary details are available.","summary":"Finalize the trade to issue pricing letter.","tags":["CORPORATE"],"parameters":[{"name":"loanTradeId","in":"path","type":"string","required":true,"description":""},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"dealCustomerDetails":[{}],"dealAdditionalInfo":[{}],"ssi":[{}],"ownBankDetails":[{}],"agentBankDetails":[{}],"tradeNotes":"string","dealReference":"string","dealTitle":"string","currency":"string","globalAmount":"string","startDate":"string","agentBank":"string","agentId":"string","agentName":"string","extensions":{}}},"responses":{"200":"TradeResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"POST","path":"/holdings/creditAgreements/loanTrades/{loanTradeId}/messages","fullPath":"/api/v7.0.0/holdings/creditAgreements/loanTrades/{loanTradeId}/messages","operationId":"showPricingLetter","name":"Issue pricing letter to the counter party for a final settlement amount.","summary":"Issue pricing letter to counterparty.","tags":["CORPORATE"],"parameters":[{"name":"loanTradeId","in":"path","type":"string","required":true,"description":""},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"extensions":{}}},"responses":{"200":"PricingLetterResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"POST","path":"/holdings/creditAgreements/loanTrades/{loanTradeId}/settlements","fullPath":"/api/v7.0.0/holdings/creditAgreements/loanTrades/{loanTradeId}/settlements","operationId":"calculateTrade","name":"Settle the trade in bank books.","summary":"Settle trade.","tags":["CORPORATE"],"parameters":[{"name":"loanTradeId","in":"path","type":"string","required":true,"description":""},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"issuePricing":"string","tradeNotes":"string","extensions":{}}},"responses":{"200":"TradeResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"POST","path":"/holdings/creditAgreements/loanTrades/{loanTradeId}/cancellations","fullPath":"/api/v7.0.0/holdings/creditAgreements/loanTrades/{loanTradeId}/cancellations","operationId":"cancelTrade","name":"Cancel the trade in bank books.","summary":"Cancel trade.","tags":["CORPORATE"],"parameters":[{"name":"loanTradeId","in":"path","type":"string","required":true,"description":""},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"tradeNotes":"string","extensions":{}}},"responses":{"200":"TradeResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/holdings/creditAgreements/loanTrades/{loanTradeId}/charges","fullPath":"/api/v7.0.0/holdings/creditAgreements/loanTrades/{loanTradeId}/charges","operationId":"getCharges","name":"View all the charge details for a given trade.","summary":"View charges.","tags":["CORPORATE"],"parameters":[{"name":"loanTradeId","in":"path","type":"string","required":true,"description":""},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"ChargesResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"PUT","path":"/holdings/creditAgreements/loanTrades/{loanTradeId}/charges","fullPath":"/api/v7.0.0/holdings/creditAgreements/loanTrades/{loanTradeId}/charges","operationId":"updateCharges","name":"Amend charges already authorized in the trade","summary":"Amend charges.","tags":["CORPORATE"],"parameters":[{"name":"loanTradeId","in":"path","type":"string","required":true,"description":""},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"chargeDetails":[{}],"extensions":{}}},"responses":{"200":"ChargesResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/holdings/creditAgreements/loanTrades/products","fullPath":"/api/v7.0.0/holdings/creditAgreements/loanTrades/products","operationId":"getTradeProducts","name":"View all the trade products","summary":"View trade products","tags":["CORPORATE"],"parameters":[{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"TradeProductsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}}]},{"key":"holdings-creditAgreements-api-service-v7.1.0","title":"Corporate Credit Agreements","version":"v7.1.0","description":"API for the creation and management of credit agreements for corporate customers. The types of credit agreements are single level facility, credit agreement with multiple facilities, club loans with agency and syndicated loans","endpointCount":70,"endpoints":[{"method":"POST","path":"/holdings/creditAgreements/deals/offers","fullPath":"/api/v7.1.0/holdings/creditAgreements/deals/offers","operationId":"createDealOffer","name":"Creates new offer deal for the required customer when the mandatory input details are provided. Offer deal creates a draft contract and allows the users to negotiate multiple times. Offer deal is a draft contract and will not affect the balance sheet of the bank.","summary":"Creates an offer for a deal contract","tags":["CORPORATE"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"customers":[{}],"productId":"string","currency":"string","effectiveDate":"2024-01-01","activity":"string","extensions":{},"facilityRules":[{}],"dacommitment":[{}],"adminfee":[{}],"coordinationfee":[{}],"upfrontfee":[{}],"limit":[{}]}},"responses":{"200":"createDealOfferResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"POST","path":"/holdings/creditAgreements/facilities/offers","fullPath":"/api/v7.1.0/holdings/creditAgreements/facilities/offers","operationId":"createFacilityOffer","name":"Creates a new offer facility for the required customer when at least the mandatory input is provided. Offer facility creates a draft contract and allow the users to negotiate multiple times. Offer facility is a draft contract and will not affect the balance sheet of the bank.","summary":"Creates an offer for a facility contract","tags":["CORPORATE"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"customers":[{}],"productId":"string","currency":"string","dealId":"string","effectiveDate":"2024-01-01","activity":"string","extensions":{},"settlement":[{}],"facommitment":[{}],"upfrontfee":[{}],"coordinationfee":[{}],"limit":[{}]}},"responses":{"200":"createFacilityOfferResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"POST","path":"/holdings/creditAgreements/deals/offers/cancellations/{arrangementId}","fullPath":"/api/v7.1.0/holdings/creditAgreements/deals/offers/cancellations/{arrangementId}","operationId":"deleteDealOffer","name":"Deletes a new offer for the required deal contract when at least the mandatory input is provided. Deal offer is a draft contract, which allow the user to delete the contract online and deal offer contract will not affect the balance sheet of the bank.","summary":"Deletes an offer for a deal contract","tags":["CORPORATE"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"arrangementId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"productId":"string","effectiveDate":"2024-01-01","extensions":{}}},"responses":{"200":"deleteDealOfferResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"POST","path":"/holdings/creditAgreements/facilities/offers/cancellations/{arrangementId}","fullPath":"/api/v7.1.0/holdings/creditAgreements/facilities/offers/cancellations/{arrangementId}","operationId":"deleteFacilityOffer","name":"Deletes a new offer for the required facility contract when at least the mandatory input is provided. Facility offer is a draft contract, which allow the user to delete the contract online and facility offer contract will not affect the balance sheet of the bank.","summary":"Deletes an offer for a facility contract","tags":["CORPORATE"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"arrangementId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"productId":"string","effectiveDate":"2024-01-01","extensions":{}}},"responses":{"200":"deleteFacilityOfferResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"POST","path":"/holdings/creditAgreements/deals/offers/acceptances/{arrangementId}","fullPath":"/api/v7.1.0/holdings/creditAgreements/deals/offers/acceptances/{arrangementId}","operationId":"acceptDealOffer","name":"On executing acceptance, the contract is changed from offer to live deal for the required customer when at least the mandatory input is provided. Process will check all the required mandatory inputs and prompt an error message when mandatory details are not provided. Once the accept deal offer is processed further offer negotiation is not allowed.","summary":"Accept the deal offer and execute the contract to live","tags":["CORPORATE"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"arrangementId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"productId":"string","effectiveDate":"2024-01-01","extensions":{},"settlement":[{}],"facilityRules":[{}],"dacommitment":[{}],"adminfee":[{}],"coordinationfee":[{}],"upfrontfee":[{}],"limit":[{}]}},"responses":{"200":"acceptDealOfferResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"POST","path":"/holdings/creditAgreements/facilities/offers/acceptances/{arrangementId}","fullPath":"/api/v7.1.0/holdings/creditAgreements/facilities/offers/acceptances/{arrangementId}","operationId":"acceptFacilityOffer","name":"On executing acceptance, the contract is changed from offer to live facility for the required customer when at least the mandatory input is provided. Process will check all the required mandatory inputs and prompt an error message when mandatory details are not provided. Once the accept deal offer is processed further offer negotiation is not allowed.","summary":"Accept the facility offer and execute the contract to live","tags":["CORPORATE"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"arrangementId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"productId":"string","effectiveDate":"2024-01-01","extensions":{},"settlement":[{}],"facommitment":[{}],"upfrontfee":[{}],"coordinationfee":[{}],"limit":[{}]}},"responses":{"200":"acceptFacilityOfferResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"POST","path":"/holdings/creditAgreements/drawdowns/offers","fullPath":"/api/v7.1.0/holdings/creditAgreements/drawdowns/offers","operationId":"createDrawdownOffer","name":"Creates a new drawdown offer for the required customer. ","summary":"Creates a new drawdown offer for the required customer. ","tags":["CORPORATE"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"customers":[{}],"productId":"string","currency":"string","facilityId":"string","offerDate":"2024-01-01","drawdownDate":"2024-01-01","activity":"string","extensions":{},"maintenancefee":[{}],"dwcommitment":[{}],"settlement":[{}]}},"responses":{"200":"createDrawdownOfferResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"POST","path":"/holdings/creditAgreements/drawdowns/offers/negotiations","fullPath":"/api/v7.1.0/holdings/creditAgreements/drawdowns/offers/negotiations","operationId":"createOfferDrawdownRenegotiation","name":"Renegotiate the offer drawdown for the required customer.","summary":"Renegotiate the offer drawdown for the required customer.","tags":["CORPORATE"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"productId":"string","drawdownDate":"2024-01-01","extensions":{},"maintenancefee":[{}],"settlement":[{}]}},"responses":{"200":"createOfferDrawdownRenegotiationResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"POST","path":"/holdings/creditAgreements/drawdowns/offers/cancellations","fullPath":"/api/v7.1.0/holdings/creditAgreements/drawdowns/offers/cancellations","operationId":"deleteDrawdownOffer","name":"Cancellation of offer drawdown for the required customer.","summary":"Cancellation of offer drawdown for the required customer.","tags":["CORPORATE"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"productId":"string","drawdownDate":"2024-01-01","extensions":{}}},"responses":{"200":"deleteDrawdownOfferResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"POST","path":"/holdings/creditAgreements/drawdowns/offers/acceptances","fullPath":"/api/v7.1.0/holdings/creditAgreements/drawdowns/offers/acceptances","operationId":"acceptOfferDrawdown","name":"Convert an offer drawdown to a live drawdown for the required customer.","summary":"Convert an offer drawdown to a live drawdown for the required customer.","tags":["CORPORATE"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"productId":"string","drawdownDate":"2024-01-01","extensions":{},"maintenancefee":[{}],"dwcommitment":[{}],"settlement":[{}]}},"responses":{"200":"acceptOfferDrawdownResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"GET","path":"/holdings/creditAgreements/facilities/{facilityId}/drawingProducts","fullPath":"/api/v7.1.0/holdings/creditAgreements/facilities/{facilityId}/drawingProducts","operationId":"getFacilityDrawingProducts","name":"Retrieves the available drawing products under the facility ","summary":"Retrieves the available drawing products under the facility ","tags":["CORPORATE"],"parameters":[{"name":"facilityId","in":"path","type":"string","required":true,"description":"Unique identifier (contract number) of the facility"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"FacilityDrawingProductsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/creditAgreements/facilities/{facilityId}/combinedSchedules","fullPath":"/api/v7.1.0/holdings/creditAgreements/facilities/{facilityId}/combinedSchedules","operationId":"getCombinedSchedules","name":"Retrieves the payment schedule of facility and its drawings","summary":"Retrieves the payment schedule of facility and its drawings","tags":["CORPORATE"],"parameters":[{"name":"facilityId","in":"path","type":"string","required":true,"description":"Unique identifier (contract number) of the facility"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"CombinedSchedulesResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"POST","path":"/holdings/creditAgreements/facilities","fullPath":"/api/v7.1.0/holdings/creditAgreements/facilities","operationId":"createFacilities","name":"Creates corporate facilities","summary":"Creates corporate facilities","tags":["CORPORATE"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"customers":[{}],"productId":"string","currency":"string","effectiveDate":"2024-01-01","dealId":"string","extensions":{},"settlement":[{}],"facommitment":[{}],"upfrontfee":[{}],"coordinationfee":[{}],"limit":[{}]}},"responses":{"200":"createFacilitiesResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"POST","path":"/holdings/creditAgreements/drawdowns","fullPath":"/api/v7.1.0/holdings/creditAgreements/drawdowns","operationId":"createDrawdowns","name":"Creates drawdowns under facility","summary":"Creates drawdowns under facility","tags":["CORPORATE"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"customers":[{}],"arrangmentId":"string","currency":"string","facilityId":"string","effectiveDate":"string","activity":"string","productId":"string","extensions":{},"escrow":[{}],"dwcommitment":[{}],"settlement":[{}]}},"responses":{"200":"createDrawdownsResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"GET","path":"/holdings/creditAgreements/facilities/{facilityId}/drawingRules","fullPath":"/api/v7.1.0/holdings/creditAgreements/facilities/{facilityId}/drawingRules","operationId":"getFacilityDrawingRules","name":"Retrieves the allowed customers, currencies and products for a new drawing under the facility","summary":"Retrieves the allowed customers, currencies and products for a new drawing under the facility","tags":["CORPORATE"],"parameters":[{"name":"facilityId","in":"path","type":"string","required":true,"description":"Unique identifier (contract number) of the facility"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"FacilityDrawingRulesResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/creditAgreements/facilities/{facilityId}/drawings","fullPath":"/api/v7.1.0/holdings/creditAgreements/facilities/{facilityId}/drawings","operationId":"getDrawingsUnderFacility","name":"Retrieves the drawings under a facility","summary":"Retrieves the drawings under a facility","tags":["CORPORATE"],"parameters":[{"name":"facilityId","in":"path","type":"string","required":true,"description":"Unique identifier (contract number) of the facility"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"DrawingsUnderFacilityResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/creditAgreements/facilities/drawings/{drawingId}/parentFacilities","fullPath":"/api/v7.1.0/holdings/creditAgreements/facilities/drawings/{drawingId}/parentFacilities","operationId":"getDrawingFacility","name":"Retrieves the parent facility for a drawing","summary":"Retrieves the parent facility for a drawing","tags":["CORPORATE"],"parameters":[{"name":"drawingId","in":"path","type":"string","required":true,"description":"Identifier of drawings application under the Letter of Credit system that is used to effect the transfer of funds and the acceptance of documents under Letters of Credit and Documentary Collection tra"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"DrawingFacilityResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/creditAgreements/facilities/{facilityId}/commitmentSchedules","fullPath":"/api/v7.1.0/holdings/creditAgreements/facilities/{facilityId}/commitmentSchedules","operationId":"getFacilityCommitmentSchedule","name":"Retrieves the commitment schedule of a facility","summary":"Retrieves the commitment schedule of a facility","tags":["CORPORATE"],"parameters":[{"name":"facilityId","in":"path","type":"string","required":true,"description":"Unique identifier (contract number) of the facility"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"FacilityCommitmentScheduleResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/creditAgreements/facilities/{facilityId}/parentDeals","fullPath":"/api/v7.1.0/holdings/creditAgreements/facilities/{facilityId}/parentDeals","operationId":"getFacilityDeal","name":"Retrieves the parent deal for a facility","summary":"Retrieves the parent deal for a facility","tags":["CORPORATE"],"parameters":[{"name":"facilityId","in":"path","type":"string","required":true,"description":"Unique identifier (contract number) of the facility"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"FacilityDealResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/creditAgreements/facilities/{facilityId}/balances","fullPath":"/api/v7.1.0/holdings/creditAgreements/facilities/{facilityId}/balances","operationId":"getFacilityFinancialSummary","name":"Retrieves the financial summary for a facility arrangement","summary":"Retrieves the financial summary for a facility arrangement","tags":["CORPORATE"],"parameters":[{"name":"facilityId","in":"path","type":"string","required":true,"description":"Unique identifier (contract number) of the facility"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"FacilityFinancialSummaryResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/creditAgreements/facilities/{facilityId}/consolidatedBalances","fullPath":"/api/v7.1.0/holdings/creditAgreements/facilities/{facilityId}/consolidatedBalances","operationId":"getFacilityConsolidatedBalances","name":"Retrieves the consolidated balances for a facility arrangement","summary":"Retrieves the consolidated balances for a facility arrangement","tags":["CORPORATE"],"parameters":[{"name":"facilityId","in":"path","type":"string","required":true,"description":"Unique identifier (contract number) of the facility"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"FacilityConsolidatedBalancesResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"POST","path":"/holdings/creditAgreements/facilities/directDebits","fullPath":"/api/v7.1.0/holdings/creditAgreements/facilities/directDebits","operationId":"createFacilityDirectDebitLink","name":"Links a direct debit to an existing facility","summary":"Links a direct debit to a facility","tags":["CORPORATE"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"customers":[{}],"arrangement":"string","productId":"string","currency":"string","effectiveDate":"2024-01-01","extensions":{},"settlement":[{}]}},"responses":{"200":"createFacilityDirectDebitLinkResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"POST","path":"/holdings/creditAgreements/facilities/drawings/directDebits","fullPath":"/api/v7.1.0/holdings/creditAgreements/facilities/drawings/directDebits","operationId":"createDrawingDirectDebitLink","name":"Link the direct debit to an existing drawing under a facility","summary":"Links a direct debit to a drawing","tags":["CORPORATE"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"customers":[{}],"arrangement":"string","currency":"string","facilityId":"string","effectiveDate":"string","productId":"string","extensions":{},"settlement":[{}]}},"responses":{"200":"createDrawingDirectDebitLinkResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"POST","path":"/holdings/creditAgreements/facilities/rollovers/offers","fullPath":"/api/v7.1.0/holdings/creditAgreements/facilities/rollovers/offers","operationId":"createFacilityRolloverOffer","name":"Create rollover process from the facility where the rollover could be a split rollover, merge rollover or a one to one rollover. Split also called as one to many will rollover an old loan and create multiple new offer loans. Merge also called as many to one will rollover multiple old loans simultaneously and create a single new offer loan. Rollover also called as one to one will simply rollover an old loan and create a new offer loan","summary":"Create rollover offer from facility","tags":["CORPORATE"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"arrangement":"string","rolloverDate":"string","productId":"string","extensions":{},"splitsMerges":[{}]}},"responses":{"200":"createFacilityRolloverOfferResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"POST","path":"/holdings/creditAgreements/drawdowns/rollovers/offers","fullPath":"/api/v7.1.0/holdings/creditAgreements/drawdowns/rollovers/offers","operationId":"createDrawdownRolloverOffer","name":"Create rollover process from the drawdown where the rollover could be a split rollover, merge rollover or a one to one rollover. Split also called as one to many will rollover an old loan and create multiple new offer loans. Merge also called as many to one will rollover multiple old loans simultaneously and create a single new offer loan. Rollover also called as one to one will simply rollover an old loan and create a new offer loan","summary":"Create rollover offer from drawdown","tags":["CORPORATE"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"arrangement":"string","rolloverDate":"string","productId":"string","extensions":{},"splitsMerges":[{}]}},"responses":{"200":"createDrawdownRolloverOfferResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"POST","path":"/holdings/creditAgreements/facilities/commitmentIncreases/{arrangementId}","fullPath":"/api/v7.1.0/holdings/creditAgreements/facilities/commitmentIncreases/{arrangementId}","operationId":"updateFacilityCommitmentIncrease","name":"Increase the facility amount to facilitate further drawdowns","summary":"Increase facility amount","tags":["CORPORATE"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"arrangementId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"productId":"string","effectiveDate":"2024-01-01","extensions":{},"facommitment":[{}]}},"responses":{"200":"updateFacilityCommitmentIncreaseResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"POST","path":"/holdings/creditAgreements/facilities/commitmentTerms/{arrangementId}","fullPath":"/api/v7.1.0/holdings/creditAgreements/facilities/commitmentTerms/{arrangementId}","operationId":"updateFacilityCommitmentTerms","name":"Updates facility tenure by increasing or decreasing the term, in addition it allows the amendment of the availability schedule of the contract.","summary":"Update facility maturity date and availability","tags":["CORPORATE"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"arrangementId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"productId":"string","effectiveDate":"2024-01-01","extensions":{},"facommitment":[{}]}},"responses":{"200":"updateFacilityCommitmentTermsResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"GET","path":"/holdings/customers/{customerId}/creditAgreements/exposures","fullPath":"/api/v7.1.0/holdings/customers/{customerId}/creditAgreements/exposures","operationId":"getCustomerExposure","name":"Retrieves the customer exposure such as the facility number, type of facility, maturity date and various amounts of the facilities/standalone loans.","summary":"Retrieves the customer exposure for facilities and loans","tags":["CORPORATE"],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"Identifier of the customer"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"CustomerExposureResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/customers/{customerId}/creditAgreements/drawings","fullPath":"/api/v7.1.0/holdings/customers/{customerId}/creditAgreements/drawings","operationId":"getCustomerDrawings","name":"Retrieves the details such as the drawing id, account number, short description of the loan, customer name and loan status for a customer. ","summary":"Retrieves the drawing details for a customer.","tags":["CORPORATE"],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"Identifier of the customer"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"CustomerDrawingsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/customers/{customerId}/creditAgreements/facilities","fullPath":"/api/v7.1.0/holdings/customers/{customerId}/creditAgreements/facilities","operationId":"getCustomerFacilities","name":"Retrieves the details such as the facility id, account number, short description of the facility, customer name and facility status for a customer.","summary":"Retrieves the facility details for a customer.","tags":["CORPORATE"],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"Identifier of the customer"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"CustomerFacilitiesResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/customers/{customerId}/creditAgreements/deals","fullPath":"/api/v7.1.0/holdings/customers/{customerId}/creditAgreements/deals","operationId":"getCustomerDeals","name":"Retrieves the details such as the deal id, account number, short description of the facility, customer name and deal status for a customer.","summary":"Retrieves the deal details for a customer.","tags":["CORPORATE"],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"Identifier of the customer"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"CustomerDealsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/creditAgreements/deals/{dealId}/facilities","fullPath":"/api/v7.1.0/holdings/creditAgreements/deals/{dealId}/facilities","operationId":"getFacilitiesUnderDeal","name":"Retrieves the details such as facility id, title, currency, status and commitment amount for all the facilities under a deal.","summary":"Retrieves the details of facilities under a deal.","tags":["CORPORATE"],"parameters":[{"name":"dealId","in":"path","type":"string","required":true,"description":"Unique identifier (contract number) of the corporate deals"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"FacilitiesUnderDealResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/creditAgreements/productCatalogues","fullPath":"/api/v7.1.0/holdings/creditAgreements/productCatalogues","operationId":"getCreditAgreementsProductCatalogue","name":"Retrieves the list of available products for credit agreements.","summary":"Retrieves the credit agreements product catalogue.","tags":["CORPORATE"],"parameters":[{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"CreditAgreementsProductCatalogueResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/creditAgreements/drawings/{drawingId}/pendingActivities","fullPath":"/api/v7.1.0/holdings/creditAgreements/drawings/{drawingId}/pendingActivities","operationId":"getPendingActivities","name":"Retrieves the details such as rollover date, rollover status etc of pending drawdowns and rollovers for a drawing.","summary":"Retrieves the details of pending drawdowns and rollovers for a drawing.","tags":["CORPORATE"],"parameters":[{"name":"drawingId","in":"path","type":"string","required":true,"description":"Identifier of drawings application under the Letter of Credit system that is used to effect the transfer of funds and the acceptance of documents under Letters of Credit and Documentary Collection tra"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"PendingActivitiesResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/creditAgreements/drawings/expiries","fullPath":"/api/v7.1.0/holdings/creditAgreements/drawings/expiries","operationId":"getLoansExpiring","name":"Retrieves the drawings expiring in the next 7 days.","summary":"Retrieves expiring drawings.","tags":["CORPORATE"],"parameters":[{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"LoansExpiringResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/creditAgreements/facilities/expiries","fullPath":"/api/v7.1.0/holdings/creditAgreements/facilities/expiries","operationId":"getFacilitiesExpiring","name":"Retrieves the facilities expiring in the next 7 days","summary":"Retrieves expiring facilities","tags":["CORPORATE"],"parameters":[{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"FacilitiesExpiringResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/creditAgreements/drawings/{drawingId}/balances","fullPath":"/api/v7.1.0/holdings/creditAgreements/drawings/{drawingId}/balances","operationId":"getDrawingBalances","name":"Retrieves the balance details such as commitment balances, utilized balances.","summary":"Retrieves drawing balances","tags":["CORPORATE"],"parameters":[{"name":"drawingId","in":"path","type":"string","required":true,"description":"Identifier of drawings application under the Letter of Credit system that is used to effect the transfer of funds and the acceptance of documents under Letters of Credit and Documentary Collection tra"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"DrawingBalancesResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/creditAgreements/drawings/{drawingId}/OverdueBalances","fullPath":"/api/v7.1.0/holdings/creditAgreements/drawings/{drawingId}/OverdueBalances","operationId":"getDrawingOverdueBalances","name":"Retrieves the past dues and overdues for a drawing","summary":"Retrieves drawing overdue balances","tags":["CORPORATE"],"parameters":[{"name":"drawingId","in":"path","type":"string","required":true,"description":"Identifier of drawings application under the Letter of Credit system that is used to effect the transfer of funds and the acceptance of documents under Letters of Credit and Documentary Collection tra"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"DrawingOverdueBalancesResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/creditAgreements/facilities/clubFacilities","fullPath":"/api/v7.1.0/holdings/creditAgreements/facilities/clubFacilities","operationId":"getClubFacilities","name":"Retrieves club facilities, drawings and deal","summary":"Retrieves club facilities, drawings and deal","tags":["CORPORATE"],"parameters":[{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"ClubFacilitiesResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"POST","path":"/holdings/creditAgreements/facilities/clubFacilities","fullPath":"/api/v7.1.0/holdings/creditAgreements/facilities/clubFacilities","operationId":"createClubFacilities","name":"Creates a club facility with facility details along with the details of participating lenders","summary":"Creates a club facility","tags":["CORPORATE"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"customers":[{}],"productId":"string","currency":"string","effectiveDate":"2024-01-01","extensions":{},"account":[{}],"settlement":[{}],"facommitment":[{}],"upfrontfee":[{}],"coordinationfee":[{}],"limit":[{}],"participant":[{}],"riskparticipant":[{}]}},"responses":{"200":"createClubFacilitiesResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"POST","path":"/holdings/creditAgreements/facilities/drawings/clubDrawings","fullPath":"/api/v7.1.0/holdings/creditAgreements/facilities/drawings/clubDrawings","operationId":"createClubDrawings","name":"Creates a club drawing arrangement with drawdown details along with the details of participating lenders","summary":"Creates a club drawing","tags":["CORPORATE"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"customers":[{}],"arrangmentId":"string","currency":"string","facilityId":"string","effectiveDate":"string","activity":"string","productId":"string","extensions":{},"account":[{}],"escrow":[{}],"dwcommitment":[{}],"settlement":[{}],"participant":[{}],"riskparticipant":[{}]}},"responses":{"200":"createClubDrawingsResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"GET","path":"/holdings/creditAgreements/facilities/drawings/{drawingId}/participants","fullPath":"/api/v7.1.0/holdings/creditAgreements/facilities/drawings/{drawingId}/participants","operationId":"getClubDrawingParticipants","name":"Retrieves the participation details of the lending arrangement for a customer. This will be used to view the agent bank and the participant details and the share amounts when an arrangement id is passed as an input.","summary":"Retrieves the participant details","tags":["CORPORATE"],"parameters":[{"name":"drawingId","in":"path","type":"string","required":true,"description":"Identifier of drawings application under the Letter of Credit system that is used to effect the transfer of funds and the acceptance of documents under Letters of Credit and Documentary Collection tra"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"ClubDrawingParticipantsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"POST","path":"/holdings/creditAgreements/facilities/{facilityId}/fundedShareTransfers","fullPath":"/api/v7.1.0/holdings/creditAgreements/facilities/{facilityId}/fundedShareTransfers","operationId":"createFacilityFundedShareTransfer","name":"Creates a funded share transfer for a facility when participant details are passed. Share of a funding participant is transferred to another funding participant in a club facility and underlying drawings","summary":"Creates a funded share transfer for a facility","tags":["CORPORATE"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"facilityId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"productId":"string","effectiveDate":"2024-01-01","extensions":{},"shareTransfer":[{}]}},"responses":{"200":"createFacilityFundedShareTransferResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"POST","path":"/holdings/creditAgreements/facilities/drawings/{drawingId}/fundedShareTransfers","fullPath":"/api/v7.1.0/holdings/creditAgreements/facilities/drawings/{drawingId}/fundedShareTransfers","operationId":"createDrawingFundedShareTransfer","name":"Creates a funded share transfer for a drawing under a facility when participant details are passed. Share of a funding participant is transferred to another funding participant in a standalone club loan","summary":"Creates a funded share transfer for a drawing","tags":["CORPORATE"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"drawingId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"productId":"string","effectiveDate":"2024-01-01","extensions":{},"shareTransfer":[{}]}},"responses":{"200":"createDrawingFundedShareTransferResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"POST","path":"/holdings/creditAgreements/facilities/{facilityId}/riskShareTransfers","fullPath":"/api/v7.1.0/holdings/creditAgreements/facilities/{facilityId}/riskShareTransfers","operationId":"createFacilityRiskShareTransfer","name":"Creates a risk share transfer for a facility when participant details are passed. The risk of the own bank in a facility is mitigated by selling a portion risk to another financial institution","summary":"Creates a risk share transfer for a facility","tags":["CORPORATE"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"facilityId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"productId":"string","effectiveDate":"2024-01-01","extensions":{},"shareTransfer":[{}]}},"responses":{"200":"createFacilityRiskShareTransferResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"POST","path":"/holdings/creditAgreements/facilities/drawings/{drawingId}/riskShareTransfers","fullPath":"/api/v7.1.0/holdings/creditAgreements/facilities/drawings/{drawingId}/riskShareTransfers","operationId":"createDrawingRiskShareTransfer","name":"Creates a risk share transfer for a drawing under a facility when participant details are passed. The risk of the own bank in a loan is mitigated by selling a portion risk to another financial institution","summary":"Creates a risk share transfer for a drawing","tags":["CORPORATE"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"drawingId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"productId":"string","effectiveDate":"2024-01-01","extensions":{},"shareTransfer":[{}]}},"responses":{"200":"createDrawingRiskShareTransferResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"POST","path":"/holdings/creditAgreements/guarantees/{guaranteeId}/guaranteeIncreases","fullPath":"/api/v7.1.0/holdings/creditAgreements/guarantees/{guaranteeId}/guaranteeIncreases","operationId":"updateGuaranteeCommitmentIncrease","name":"Increase the commitment amount of the guarantee that the financial institution has issued on behalf of the applicant","summary":"Increase the commitment amount of the guarantee","tags":["CORPORATE"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"guaranteeId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"productId":"string","effectiveDate":"2024-01-01","extensions":{},"gteecommitment":[{}]}},"responses":{"200":"updateGuaranteeCommitmentIncreaseResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"POST","path":"/holdings/creditAgreements/guarantees/{guaranteeId}/guaranteeDecreases","fullPath":"/api/v7.1.0/holdings/creditAgreements/guarantees/{guaranteeId}/guaranteeDecreases","operationId":"updateGuaranteeCommitmentDecrease","name":"Decrease the commitment amount of the guarantee that the financial institution has issued on behalf of the applicant","summary":"Decrease the commitment amount of the guarantee","tags":["CORPORATE"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"guaranteeId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"productId":"string","effectiveDate":"2024-01-01","extensions":{},"gteecommitment":[{}]}},"responses":{"200":"updateGuaranteeCommitmentDecreaseResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"POST","path":"/holdings/creditAgreements/guarantees","fullPath":"/api/v7.1.0/holdings/creditAgreements/guarantees","operationId":"createCreditAgreementGuarantee","name":"Register the issuance of a new guarantee undertaking on behalf of the applicant when all the basic details relevant to the undertaking are passed","summary":"Register the issuance of a guarantee","tags":["CORPORATE"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"customers":[{}],"productId":"string","currency":"string","effectiveDate":"2024-01-01","facilityId":"string","extensions":{},"gteecommitment":[{}],"newarrfee":[{}],"settlement":[{}],"termsConditions":[{}]}},"responses":{"200":"createCreditAgreementGuaranteeResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"POST","path":"/holdings/creditAgreements/guarantees/clubGuarantees","fullPath":"/api/v7.1.0/holdings/creditAgreements/guarantees/clubGuarantees","operationId":"createClubGuarantee","name":"Create a club guarantee with guarantee details along with the details of participating lenders","summary":"Create a club guarantee","tags":["CORPORATE"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"customers":[{}],"productId":"string","currency":"string","effectiveDate":"2024-01-01","facilityId":"string","extensions":{},"account":[{}],"gteecommitment":[{}],"newarrfee":[{}],"settlement":[{}],"termsConditions":[{}],"participant":[{}]}},"responses":{"200":"createClubGuaranteeResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"POST","path":"/holdings/creditAgreements/guarantees/{guaranteeId}/cancellations","fullPath":"/api/v7.1.0/holdings/creditAgreements/guarantees/{guaranteeId}/cancellations","operationId":"cancelCorporateGuarantee","name":"Cancel a guarantee arrangement before its expiry date. All the accrued fees are made-due for collection and the bank is discharged of its liability.","summary":"Cancel a guarantee arrangement before the expiry date.","tags":["CORPORATE"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"guaranteeId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"productId":"string","effectiveDate":"2024-01-01","extensions":{},"settlement":[{}]}},"responses":{"200":"cancelCorporateGuaranteeResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"POST","path":"/holdings/creditAgreements/deals","fullPath":"/api/v7.1.0/holdings/creditAgreements/deals","operationId":"createDeals","name":"Create a new deal for the customer with the details like product, term and amount . Corporate deal is a credit agreement between two parties- the lender and the borrower, who agree to certain terms and conditions along with their rights and obligations","summary":"Creates corporate deal","tags":["CORPORATE"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"customers":[{}],"productId":"string","currency":"string","effectiveDate":"2024-01-01","extensions":{},"settlement":[{}],"facilityRules":[{}],"dacommitment":[{}],"adminfee":[{}],"coordinationfee":[{}],"upfrontfee":[{}],"limit":[{}]}},"responses":{"200":"createDealsResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"POST","path":"/holdings/creditAgreements/loanTrades/trades","fullPath":"/api/v7.1.0/holdings/creditAgreements/loanTrades/trades","operationId":"createTrade","name":"Create a trade for a syndicated loan as initially agreed upon between counterparties.","summary":"Create a trade for a syndicated loan.","tags":["CORPORATE"],"parameters":[{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"counterPartyDetails":[{}],"dealCustomerDetails":[{}],"dealAdditionalInfo":[{}],"ssi":[{}],"ownBankDetails":[{}],"agentBankDetails":[{}],"consentDetails":[{}],"chargeDetails":[{}],"tradeAccountDetails":[{}],"tradeActivity":"string","alternateId":"string","tradeProduct":"string","tradeDate":"string","tradeCurrency":"string","transferType":"string"}},"responses":{"200":"TradeResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"POST","path":"/holdings/creditAgreements/loanTrades/{loanTradeId}/confirmationTrade","fullPath":"/api/v7.1.0/holdings/creditAgreements/loanTrades/{loanTradeId}/confirmationTrade","operationId":"acceptTrade","name":"Confirm the trade when all the parties involved agreed the terms and conditions of the trade.","summary":"Confirm the trade","tags":["CORPORATE"],"parameters":[{"name":"loanTradeId","in":"path","type":"string","required":true,"description":""},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"dealCustomerDetails":[{}],"dealAdditionalinfos":[{}],"dealReference":"string","dealTitle":"string","currency":"string","globalAmount":"string","startDate":"string","agentBank":"string","agentId":"string","agentName":"string","extensions":{}}},"responses":{"200":"TradeResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"POST","path":"/holdings/creditAgreements/loanTrades/{loanTradeId}","fullPath":"/api/v7.1.0/holdings/creditAgreements/loanTrades/{loanTradeId}","operationId":"updateTrade","name":"Update additional details in trade record.","summary":"Update trade details","tags":["CORPORATE"],"parameters":[{"name":"loanTradeId","in":"path","type":"string","required":true,"description":""},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"dealCustomerDetails":[{}],"dealAdditionalInfo":[{}],"ssi":[{}],"ownBankDetails":[{}],"agentBankDetails":[{}],"chargeDetails":[{}],"tradeAccountDetails":[{}],"alternateId":"string","transferType":"string","expectedSettlementDate":"string","tradeNotes":"string","businessDayCentre":"string","dealReference":"string","dealTitle":"string","currency":"string"}},"responses":{"200":"TradeResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"POST","path":"/holdings/creditAgreements/loanTrades/{loanTradeId}/consents","fullPath":"/api/v7.1.0/holdings/creditAgreements/loanTrades/{loanTradeId}/consents","operationId":"updateConsent","name":"Update borrower consent for trade","summary":"Update consent status if borrower has agreed or rejected trade.","tags":["CORPORATE"],"parameters":[{"name":"loanTradeId","in":"path","type":"string","required":true,"description":""},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"consentDetails":[{}],"chargeDetails":[{}],"tradeStatus":"string","extensions":{}}},"responses":{"200":"ConsentResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"POST","path":"/holdings/creditAgreements/loanTrades/{loanTradeId}/commitments","fullPath":"/api/v7.1.0/holdings/creditAgreements/loanTrades/{loanTradeId}/commitments","operationId":"updateCommitment","name":"Update the trade due to changes in commitment amount being traded.","summary":"Update commitment details","tags":["CORPORATE"],"parameters":[{"name":"loanTradeId","in":"path","type":"string","required":true,"description":""},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"chargeDetails":[{}],"tradeAccountDetails":[{}],"amount":"string","expectedSettlementDate":"string","actualSettlementDate":"string","tradePrice":"string","settlementMethod":"string","allowNetback":"string","allowBoCR":"string","extensions":{}}},"responses":{"200":"CommitmentResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"POST","path":"/holdings/creditAgreements/loanTrades/{loanTradeId}/acceptances","fullPath":"/api/v7.1.0/holdings/creditAgreements/loanTrades/{loanTradeId}/acceptances","operationId":"approveTrade","name":"Finalize the trade to verify all necessary details are available.","summary":"Finalize the trade to issue pricing letter.","tags":["CORPORATE"],"parameters":[{"name":"loanTradeId","in":"path","type":"string","required":true,"description":""},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"dealCustomerDetails":[{}],"dealAdditionalInfo":[{}],"ssi":[{}],"ownBankDetails":[{}],"agentBankDetails":[{}],"tradeNotes":"string","dealReference":"string","dealTitle":"string","currency":"string","globalAmount":"string","startDate":"string","agentBank":"string","agentId":"string","agentName":"string","extensions":{}}},"responses":{"200":"TradeResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"POST","path":"/holdings/creditAgreements/loanTrades/{loanTradeId}/messages","fullPath":"/api/v7.1.0/holdings/creditAgreements/loanTrades/{loanTradeId}/messages","operationId":"showPricingLetter","name":"Issue pricing letter to the counter party for a final settlement amount.","summary":"Issue pricing letter to counterparty.","tags":["CORPORATE"],"parameters":[{"name":"loanTradeId","in":"path","type":"string","required":true,"description":""},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"extensions":{}}},"responses":{"200":"PricingLetterResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"POST","path":"/holdings/creditAgreements/loanTrades/{loanTradeId}/settlements","fullPath":"/api/v7.1.0/holdings/creditAgreements/loanTrades/{loanTradeId}/settlements","operationId":"calculateTrade","name":"Settle the trade in bank books.","summary":"Settle trade.","tags":["CORPORATE"],"parameters":[{"name":"loanTradeId","in":"path","type":"string","required":true,"description":""},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"issuePricing":"string","tradeNotes":"string","extensions":{}}},"responses":{"200":"TradeResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"POST","path":"/holdings/creditAgreements/loanTrades/{loanTradeId}/cancellations","fullPath":"/api/v7.1.0/holdings/creditAgreements/loanTrades/{loanTradeId}/cancellations","operationId":"cancelTrade","name":"Cancel the trade in bank books.","summary":"Cancel trade.","tags":["CORPORATE"],"parameters":[{"name":"loanTradeId","in":"path","type":"string","required":true,"description":""},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"tradeNotes":"string","extensions":{}}},"responses":{"200":"TradeResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/holdings/creditAgreements/loanTrades/{loanTradeId}/charges","fullPath":"/api/v7.1.0/holdings/creditAgreements/loanTrades/{loanTradeId}/charges","operationId":"getCharges","name":"View all the charge details for a given trade.","summary":"View charges.","tags":["CORPORATE"],"parameters":[{"name":"loanTradeId","in":"path","type":"string","required":true,"description":""},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"ChargesResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"PUT","path":"/holdings/creditAgreements/loanTrades/{loanTradeId}/charges","fullPath":"/api/v7.1.0/holdings/creditAgreements/loanTrades/{loanTradeId}/charges","operationId":"updateCharges","name":"Amend charges already authorized in the trade","summary":"Amend charges.","tags":["CORPORATE"],"parameters":[{"name":"loanTradeId","in":"path","type":"string","required":true,"description":""},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"chargeDetails":[{}],"extensions":{}}},"responses":{"200":"ChargesResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/holdings/creditAgreements/loanTrades/products","fullPath":"/api/v7.1.0/holdings/creditAgreements/loanTrades/products","operationId":"getTradeProducts","name":"View all the trade products","summary":"View trade products","tags":["CORPORATE"],"parameters":[{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"TradeProductsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"PUT","path":"/holdings/creditAgreements/facilities/{facilityId}/coordinationFees","fullPath":"/api/v7.1.0/holdings/creditAgreements/facilities/{facilityId}/coordinationFees","operationId":"updateFacilityCoordinationFees","name":"Updating coordination fees to pay the fee to its participants in facility","summary":"Updating coordination fees to pay the fee to its participants in facility","tags":["CORPORATE"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"facilityId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"productId":"string","effectiveDate":"2024-01-01","extensions":{},"coordinationfee":[{}]}},"responses":{"200":"updateFacilityCoordinationFeesResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"PUT","path":"/holdings/creditAgreements/facilities/{facilityId}/upfrontFees","fullPath":"/api/v7.1.0/holdings/creditAgreements/facilities/{facilityId}/upfrontFees","operationId":"updateFacilityUpfrontFees","name":"Updating the upfront fee which is collect one time by bank","summary":"Updating the upfront fee which is collect one time by bank","tags":["CORPORATE"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"facilityId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"productId":"string","effectiveDate":"2024-01-01","extensions":{},"upfrontfee":[{}]}},"responses":{"200":"updateFacilityUpfrontFeesResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"PUT","path":"/holdings/creditAgreements/facilities/{facilityId}/drawdowns/rules","fullPath":"/api/v7.1.0/holdings/creditAgreements/facilities/{facilityId}/drawdowns/rules","operationId":"UpdateFacilityDrawingRules","name":"Initiating drawing rules to restrict customer, currency and products for drawdown under facility level.","summary":"Initiating drawing rules to restrict customer, currency and products for drawdown under facility level.","tags":["CORPORATE"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"facilityId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"productId":"string","effectiveDate":"2024-01-01","extensions":{},"drawingRules":[{}]}},"responses":{"200":"UpdateFacilityDrawingRulesResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"PUT","path":"/holdings/creditAgreements/facilities/{facilityId}/drawdowns/conditions","fullPath":"/api/v7.1.0/holdings/creditAgreements/facilities/{facilityId}/drawdowns/conditions","operationId":"updateFacilityDrawingConditions","name":"Initiating drawing condition to restrict customer, currency and products for drawdown with overrides.","summary":"Initiating drawing condition to restrict customer, currency and products for drawdown with overrides.","tags":["CORPORATE"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"facilityId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"productId":"string","effectiveDate":"2024-01-01","extensions":{},"drawingConditions":[{}]}},"responses":{"200":"updateFacilityDrawingConditionsResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"PUT","path":"/holdings/creditAgreements/deals/{dealId}/commitmentIncreases","fullPath":"/api/v7.1.0/holdings/creditAgreements/deals/{dealId}/commitmentIncreases","operationId":"createDealCommitmentIncreases","name":"Increase the commitment amount of the existing deal arrangement.","summary":"Increase the commitment amount of the existing deal arrangement.","tags":["CORPORATE"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"dealId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"effectiveDate":"2024-01-01","activityId":"string","externalEventStatus":"string","extensions":{},"dacommitment":[{}]}},"responses":{"200":"createDealCommitmentIncreasesResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"PUT","path":"/holdings/creditAgreements/deals/{dealId}/commitmentDecreases","fullPath":"/api/v7.1.0/holdings/creditAgreements/deals/{dealId}/commitmentDecreases","operationId":"createDealCommitmentDecreases","name":"The commitment amount of the existing deal arrangement can be decreased","summary":"The commitment amount of the existing deal arrangement can be decreased","tags":["CORPORATE"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"dealId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"effectiveDate":"2024-01-01","activityId":"string","externalEventStatus":"string","extensions":{},"dacommitment":[{}]}},"responses":{"200":"createDealCommitmentDecreasesResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}}]},{"key":"holdings-creditAgreements-api-service-v7.2.0","title":"Corporate Credit Agreements","version":"v7.2.0","description":"API for the creation and management of credit agreements for corporate customers. The types of credit agreements are single level facility, credit agreement with multiple facilities, club loans with agency and syndicated loans","endpointCount":72,"endpoints":[{"method":"POST","path":"/holdings/creditAgreements/deals/offers","fullPath":"/api/v7.2.0/holdings/creditAgreements/deals/offers","operationId":"createDealOffer","name":"Creates new offer deal for the required customer when the mandatory input details are provided. Offer deal creates a draft contract and allows the users to negotiate multiple times. Offer deal is a draft contract and will not affect the balance sheet of the bank.","summary":"Creates an offer for a deal contract","tags":["CORPORATE"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"customers":[{}],"productId":"string","currency":"string","effectiveDate":"2024-01-01","activity":"string","extensions":{},"facilityRules":[{}],"dacommitment":[{}],"adminfee":[{}],"coordinationfee":[{}],"upfrontfee":[{}],"limit":[{}]}},"responses":{"200":"createDealOfferResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"POST","path":"/holdings/creditAgreements/facilities/offers","fullPath":"/api/v7.2.0/holdings/creditAgreements/facilities/offers","operationId":"createFacilityOffer","name":"Creates a new offer facility for the required customer when at least the mandatory input is provided. Offer facility creates a draft contract and allow the users to negotiate multiple times. Offer facility is a draft contract and will not affect the balance sheet of the bank.","summary":"Creates an offer for a facility contract","tags":["CORPORATE"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"customers":[{}],"productId":"string","currency":"string","dealId":"string","effectiveDate":"2024-01-01","activity":"string","extensions":{},"settlement":[{}],"facommitment":[{}],"upfrontfee":[{}],"coordinationfee":[{}],"limit":[{}]}},"responses":{"200":"createFacilityOfferResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"POST","path":"/holdings/creditAgreements/deals/offers/cancellations/{arrangementId}","fullPath":"/api/v7.2.0/holdings/creditAgreements/deals/offers/cancellations/{arrangementId}","operationId":"deleteDealOffer","name":"Deletes a new offer for the required deal contract when at least the mandatory input is provided. Deal offer is a draft contract, which allow the user to delete the contract online and deal offer contract will not affect the balance sheet of the bank.","summary":"Deletes an offer for a deal contract","tags":["CORPORATE"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"arrangementId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"productId":"string","effectiveDate":"2024-01-01","extensions":{}}},"responses":{"200":"deleteDealOfferResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"POST","path":"/holdings/creditAgreements/facilities/offers/cancellations/{arrangementId}","fullPath":"/api/v7.2.0/holdings/creditAgreements/facilities/offers/cancellations/{arrangementId}","operationId":"deleteFacilityOffer","name":"Deletes a new offer for the required facility contract when at least the mandatory input is provided. Facility offer is a draft contract, which allow the user to delete the contract online and facility offer contract will not affect the balance sheet of the bank.","summary":"Deletes an offer for a facility contract","tags":["CORPORATE"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"arrangementId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"productId":"string","effectiveDate":"2024-01-01","extensions":{}}},"responses":{"200":"deleteFacilityOfferResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"POST","path":"/holdings/creditAgreements/deals/offers/acceptances/{arrangementId}","fullPath":"/api/v7.2.0/holdings/creditAgreements/deals/offers/acceptances/{arrangementId}","operationId":"acceptDealOffer","name":"On executing acceptance, the contract is changed from offer to live deal for the required customer when at least the mandatory input is provided. Process will check all the required mandatory inputs and prompt an error message when mandatory details are not provided. Once the accept deal offer is processed further offer negotiation is not allowed.","summary":"Accept the deal offer and execute the contract to live","tags":["CORPORATE"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"arrangementId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"productId":"string","effectiveDate":"2024-01-01","extensions":{},"settlement":[{}],"facilityRules":[{}],"dacommitment":[{}],"adminfee":[{}],"coordinationfee":[{}],"upfrontfee":[{}],"limit":[{}]}},"responses":{"200":"acceptDealOfferResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"POST","path":"/holdings/creditAgreements/facilities/offers/acceptances/{arrangementId}","fullPath":"/api/v7.2.0/holdings/creditAgreements/facilities/offers/acceptances/{arrangementId}","operationId":"acceptFacilityOffer","name":"On executing acceptance, the contract is changed from offer to live facility for the required customer when at least the mandatory input is provided. Process will check all the required mandatory inputs and prompt an error message when mandatory details are not provided. Once the accept deal offer is processed further offer negotiation is not allowed.","summary":"Accept the facility offer and execute the contract to live","tags":["CORPORATE"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"arrangementId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"productId":"string","effectiveDate":"2024-01-01","extensions":{},"settlement":[{}],"facommitment":[{}],"upfrontfee":[{}],"coordinationfee":[{}],"limit":[{}]}},"responses":{"200":"acceptFacilityOfferResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"POST","path":"/holdings/creditAgreements/drawdowns/offers","fullPath":"/api/v7.2.0/holdings/creditAgreements/drawdowns/offers","operationId":"createDrawdownOffer","name":"Creates a new drawdown offer for the required customer. ","summary":"Creates a new drawdown offer for the required customer. ","tags":["CORPORATE"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"customers":[{}],"productId":"string","currency":"string","facilityId":"string","offerDate":"2024-01-01","drawdownDate":"2024-01-01","activity":"string","extensions":{},"maintenancefee":[{}],"dwcommitment":[{}],"settlement":[{}]}},"responses":{"200":"createDrawdownOfferResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"POST","path":"/holdings/creditAgreements/drawdowns/offers/negotiations","fullPath":"/api/v7.2.0/holdings/creditAgreements/drawdowns/offers/negotiations","operationId":"createOfferDrawdownRenegotiation","name":"Renegotiate the offer drawdown for the required customer.","summary":"Renegotiate the offer drawdown for the required customer.","tags":["CORPORATE"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"productId":"string","drawdownDate":"2024-01-01","extensions":{},"maintenancefee":[{}],"settlement":[{}]}},"responses":{"200":"createOfferDrawdownRenegotiationResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"POST","path":"/holdings/creditAgreements/drawdowns/offers/cancellations","fullPath":"/api/v7.2.0/holdings/creditAgreements/drawdowns/offers/cancellations","operationId":"deleteDrawdownOffer","name":"Cancellation of offer drawdown for the required customer.","summary":"Cancellation of offer drawdown for the required customer.","tags":["CORPORATE"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"productId":"string","drawdownDate":"2024-01-01","extensions":{}}},"responses":{"200":"deleteDrawdownOfferResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"POST","path":"/holdings/creditAgreements/drawdowns/offers/acceptances","fullPath":"/api/v7.2.0/holdings/creditAgreements/drawdowns/offers/acceptances","operationId":"acceptOfferDrawdown","name":"Convert an offer drawdown to a live drawdown for the required customer.","summary":"Convert an offer drawdown to a live drawdown for the required customer.","tags":["CORPORATE"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"productId":"string","drawdownDate":"2024-01-01","extensions":{},"maintenancefee":[{}],"dwcommitment":[{}],"settlement":[{}]}},"responses":{"200":"acceptOfferDrawdownResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"GET","path":"/holdings/creditAgreements/facilities/{facilityId}/drawingProducts","fullPath":"/api/v7.2.0/holdings/creditAgreements/facilities/{facilityId}/drawingProducts","operationId":"getFacilityDrawingProducts","name":"Retrieves the available drawing products under the facility ","summary":"Retrieves the available drawing products under the facility ","tags":["CORPORATE"],"parameters":[{"name":"facilityId","in":"path","type":"string","required":true,"description":"Unique identifier (contract number) of the facility"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"FacilityDrawingProductsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/creditAgreements/facilities/{facilityId}/combinedSchedules","fullPath":"/api/v7.2.0/holdings/creditAgreements/facilities/{facilityId}/combinedSchedules","operationId":"getCombinedSchedules","name":"Retrieves the payment schedule of facility and its drawings","summary":"Retrieves the payment schedule of facility and its drawings","tags":["CORPORATE"],"parameters":[{"name":"facilityId","in":"path","type":"string","required":true,"description":"Unique identifier (contract number) of the facility"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"CombinedSchedulesResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"POST","path":"/holdings/creditAgreements/facilities","fullPath":"/api/v7.2.0/holdings/creditAgreements/facilities","operationId":"createFacilities","name":"Creates corporate facilities","summary":"Creates corporate facilities","tags":["CORPORATE"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"customers":[{}],"productId":"string","currency":"string","effectiveDate":"2024-01-01","dealId":"string","extensions":{},"settlement":[{}],"facommitment":[{}],"upfrontfee":[{}],"coordinationfee":[{}],"limit":[{}]}},"responses":{"200":"createFacilitiesResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"POST","path":"/holdings/creditAgreements/drawdowns","fullPath":"/api/v7.2.0/holdings/creditAgreements/drawdowns","operationId":"createDrawdowns","name":"Creates drawdowns under facility","summary":"Creates drawdowns under facility","tags":["CORPORATE"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"customers":[{}],"arrangmentId":"string","currency":"string","facilityId":"string","effectiveDate":"string","activity":"string","productId":"string","extensions":{},"escrow":[{}],"dwcommitment":[{}],"settlement":[{}]}},"responses":{"200":"createDrawdownsResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"GET","path":"/holdings/creditAgreements/facilities/{facilityId}/drawingRules","fullPath":"/api/v7.2.0/holdings/creditAgreements/facilities/{facilityId}/drawingRules","operationId":"getFacilityDrawingRules","name":"Retrieves the allowed customers, currencies and products for a new drawing under the facility","summary":"Retrieves the allowed customers, currencies and products for a new drawing under the facility","tags":["CORPORATE"],"parameters":[{"name":"facilityId","in":"path","type":"string","required":true,"description":"Unique identifier (contract number) of the facility"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"FacilityDrawingRulesResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/creditAgreements/facilities/{facilityId}/drawings","fullPath":"/api/v7.2.0/holdings/creditAgreements/facilities/{facilityId}/drawings","operationId":"getDrawingsUnderFacility","name":"Retrieves the drawings under a facility","summary":"Retrieves the drawings under a facility","tags":["CORPORATE"],"parameters":[{"name":"facilityId","in":"path","type":"string","required":true,"description":"Unique identifier (contract number) of the facility"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"DrawingsUnderFacilityResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/creditAgreements/facilities/drawings/{drawingId}/parentFacilities","fullPath":"/api/v7.2.0/holdings/creditAgreements/facilities/drawings/{drawingId}/parentFacilities","operationId":"getDrawingFacility","name":"Retrieves the parent facility for a drawing","summary":"Retrieves the parent facility for a drawing","tags":["CORPORATE"],"parameters":[{"name":"drawingId","in":"path","type":"string","required":true,"description":"Identifier of drawings application under the Letter of Credit system that is used to effect the transfer of funds and the acceptance of documents under Letters of Credit and Documentary Collection tra"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"DrawingFacilityResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/creditAgreements/facilities/{facilityId}/commitmentSchedules","fullPath":"/api/v7.2.0/holdings/creditAgreements/facilities/{facilityId}/commitmentSchedules","operationId":"getFacilityCommitmentSchedule","name":"Retrieves the commitment schedule of a facility","summary":"Retrieves the commitment schedule of a facility","tags":["CORPORATE"],"parameters":[{"name":"facilityId","in":"path","type":"string","required":true,"description":"Unique identifier (contract number) of the facility"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"FacilityCommitmentScheduleResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/creditAgreements/facilities/{facilityId}/parentDeals","fullPath":"/api/v7.2.0/holdings/creditAgreements/facilities/{facilityId}/parentDeals","operationId":"getFacilityDeal","name":"Retrieves the parent deal for a facility","summary":"Retrieves the parent deal for a facility","tags":["CORPORATE"],"parameters":[{"name":"facilityId","in":"path","type":"string","required":true,"description":"Unique identifier (contract number) of the facility"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"FacilityDealResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/creditAgreements/facilities/{facilityId}/balances","fullPath":"/api/v7.2.0/holdings/creditAgreements/facilities/{facilityId}/balances","operationId":"getFacilityFinancialSummary","name":"Retrieves the financial summary for a facility arrangement","summary":"Retrieves the financial summary for a facility arrangement","tags":["CORPORATE"],"parameters":[{"name":"facilityId","in":"path","type":"string","required":true,"description":"Unique identifier (contract number) of the facility"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"FacilityFinancialSummaryResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/creditAgreements/facilities/{facilityId}/consolidatedBalances","fullPath":"/api/v7.2.0/holdings/creditAgreements/facilities/{facilityId}/consolidatedBalances","operationId":"getFacilityConsolidatedBalances","name":"Retrieves the consolidated balances for a facility arrangement","summary":"Retrieves the consolidated balances for a facility arrangement","tags":["CORPORATE"],"parameters":[{"name":"facilityId","in":"path","type":"string","required":true,"description":"Unique identifier (contract number) of the facility"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"FacilityConsolidatedBalancesResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"POST","path":"/holdings/creditAgreements/facilities/directDebits","fullPath":"/api/v7.2.0/holdings/creditAgreements/facilities/directDebits","operationId":"createFacilityDirectDebitLink","name":"Links a direct debit to an existing facility","summary":"Links a direct debit to a facility","tags":["CORPORATE"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"customers":[{}],"arrangement":"string","productId":"string","currency":"string","effectiveDate":"2024-01-01","extensions":{},"settlement":[{}]}},"responses":{"200":"createFacilityDirectDebitLinkResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"POST","path":"/holdings/creditAgreements/facilities/drawings/directDebits","fullPath":"/api/v7.2.0/holdings/creditAgreements/facilities/drawings/directDebits","operationId":"createDrawingDirectDebitLink","name":"Link the direct debit to an existing drawing under a facility","summary":"Links a direct debit to a drawing","tags":["CORPORATE"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"customers":[{}],"arrangement":"string","currency":"string","facilityId":"string","effectiveDate":"string","productId":"string","extensions":{},"settlement":[{}]}},"responses":{"200":"createDrawingDirectDebitLinkResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"POST","path":"/holdings/creditAgreements/facilities/rollovers/offers","fullPath":"/api/v7.2.0/holdings/creditAgreements/facilities/rollovers/offers","operationId":"createFacilityRolloverOffer","name":"Create rollover process from the facility where the rollover could be a split rollover, merge rollover or a one to one rollover. Split also called as one to many will rollover an old loan and create multiple new offer loans. Merge also called as many to one will rollover multiple old loans simultaneously and create a single new offer loan. Rollover also called as one to one will simply rollover an old loan and create a new offer loan","summary":"Create rollover offer from facility","tags":["CORPORATE"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"arrangement":"string","rolloverDate":"string","productId":"string","extensions":{},"splitsMerges":[{}]}},"responses":{"200":"createFacilityRolloverOfferResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"POST","path":"/holdings/creditAgreements/drawdowns/rollovers/offers","fullPath":"/api/v7.2.0/holdings/creditAgreements/drawdowns/rollovers/offers","operationId":"createDrawdownRolloverOffer","name":"Create rollover process from the drawdown where the rollover could be a split rollover, merge rollover or a one to one rollover. Split also called as one to many will rollover an old loan and create multiple new offer loans. Merge also called as many to one will rollover multiple old loans simultaneously and create a single new offer loan. Rollover also called as one to one will simply rollover an old loan and create a new offer loan","summary":"Create rollover offer from drawdown","tags":["CORPORATE"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"arrangement":"string","rolloverDate":"string","productId":"string","extensions":{},"splitsMerges":[{}]}},"responses":{"200":"createDrawdownRolloverOfferResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"POST","path":"/holdings/creditAgreements/facilities/commitmentIncreases/{arrangementId}","fullPath":"/api/v7.2.0/holdings/creditAgreements/facilities/commitmentIncreases/{arrangementId}","operationId":"updateFacilityCommitmentIncrease","name":"Increase the facility amount to facilitate further drawdowns","summary":"Increase facility amount","tags":["CORPORATE"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"arrangementId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"productId":"string","effectiveDate":"2024-01-01","extensions":{},"facommitment":[{}]}},"responses":{"200":"updateFacilityCommitmentIncreaseResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"POST","path":"/holdings/creditAgreements/facilities/commitmentTerms/{arrangementId}","fullPath":"/api/v7.2.0/holdings/creditAgreements/facilities/commitmentTerms/{arrangementId}","operationId":"updateFacilityCommitmentTerms","name":"Updates facility tenure by increasing or decreasing the term, in addition it allows the amendment of the availability schedule of the contract.","summary":"Update facility maturity date and availability","tags":["CORPORATE"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"arrangementId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"productId":"string","effectiveDate":"2024-01-01","extensions":{},"facommitment":[{}]}},"responses":{"200":"updateFacilityCommitmentTermsResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"GET","path":"/holdings/customers/{customerId}/creditAgreements/exposures","fullPath":"/api/v7.2.0/holdings/customers/{customerId}/creditAgreements/exposures","operationId":"getCustomerExposure","name":"Retrieves the customer exposure such as the facility number, type of facility, maturity date and various amounts of the facilities/standalone loans.","summary":"Retrieves the customer exposure for facilities and loans","tags":["CORPORATE"],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"Identifier of the customer"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"CustomerExposureResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/customers/{customerId}/creditAgreements/drawings","fullPath":"/api/v7.2.0/holdings/customers/{customerId}/creditAgreements/drawings","operationId":"getCustomerDrawings","name":"Retrieves the details such as the drawing id, account number, short description of the loan, customer name and loan status for a customer. ","summary":"Retrieves the drawing details for a customer.","tags":["CORPORATE"],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"Identifier of the customer"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"CustomerDrawingsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/customers/{customerId}/creditAgreements/facilities","fullPath":"/api/v7.2.0/holdings/customers/{customerId}/creditAgreements/facilities","operationId":"getCustomerFacilities","name":"Retrieves the details such as the facility id, account number, short description of the facility, customer name and facility status for a customer.","summary":"Retrieves the facility details for a customer.","tags":["CORPORATE"],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"Identifier of the customer"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"CustomerFacilitiesResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/customers/{customerId}/creditAgreements/deals","fullPath":"/api/v7.2.0/holdings/customers/{customerId}/creditAgreements/deals","operationId":"getCustomerDeals","name":"Retrieves the details such as the deal id, account number, short description of the facility, customer name and deal status for a customer.","summary":"Retrieves the deal details for a customer.","tags":["CORPORATE"],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"Identifier of the customer"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"CustomerDealsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/creditAgreements/deals/{dealId}/facilities","fullPath":"/api/v7.2.0/holdings/creditAgreements/deals/{dealId}/facilities","operationId":"getFacilitiesUnderDeal","name":"Retrieves the details such as facility id, title, currency, status and commitment amount for all the facilities under a deal.","summary":"Retrieves the details of facilities under a deal.","tags":["CORPORATE"],"parameters":[{"name":"dealId","in":"path","type":"string","required":true,"description":"Unique identifier (contract number) of the corporate deals"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"FacilitiesUnderDealResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/creditAgreements/productCatalogues","fullPath":"/api/v7.2.0/holdings/creditAgreements/productCatalogues","operationId":"getCreditAgreementsProductCatalogue","name":"Retrieves the list of available products for credit agreements.","summary":"Retrieves the credit agreements product catalogue.","tags":["CORPORATE"],"parameters":[{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"CreditAgreementsProductCatalogueResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/creditAgreements/drawings/{drawingId}/pendingActivities","fullPath":"/api/v7.2.0/holdings/creditAgreements/drawings/{drawingId}/pendingActivities","operationId":"getPendingActivities","name":"Retrieves the details such as rollover date, rollover status etc of pending drawdowns and rollovers for a drawing.","summary":"Retrieves the details of pending drawdowns and rollovers for a drawing.","tags":["CORPORATE"],"parameters":[{"name":"drawingId","in":"path","type":"string","required":true,"description":"Identifier of drawings application under the Letter of Credit system that is used to effect the transfer of funds and the acceptance of documents under Letters of Credit and Documentary Collection tra"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"PendingActivitiesResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/creditAgreements/drawings/expiries","fullPath":"/api/v7.2.0/holdings/creditAgreements/drawings/expiries","operationId":"getLoansExpiring","name":"Retrieves the drawings expiring in the next 7 days.","summary":"Retrieves expiring drawings.","tags":["CORPORATE"],"parameters":[{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"LoansExpiringResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/creditAgreements/facilities/expiries","fullPath":"/api/v7.2.0/holdings/creditAgreements/facilities/expiries","operationId":"getFacilitiesExpiring","name":"Retrieves the facilities expiring in the next 7 days","summary":"Retrieves expiring facilities","tags":["CORPORATE"],"parameters":[{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"FacilitiesExpiringResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/creditAgreements/drawings/{drawingId}/balances","fullPath":"/api/v7.2.0/holdings/creditAgreements/drawings/{drawingId}/balances","operationId":"getDrawingBalances","name":"Retrieves the balance details such as commitment balances, utilized balances.","summary":"Retrieves drawing balances","tags":["CORPORATE"],"parameters":[{"name":"drawingId","in":"path","type":"string","required":true,"description":"Identifier of drawings application under the Letter of Credit system that is used to effect the transfer of funds and the acceptance of documents under Letters of Credit and Documentary Collection tra"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"DrawingBalancesResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/creditAgreements/drawings/{drawingId}/OverdueBalances","fullPath":"/api/v7.2.0/holdings/creditAgreements/drawings/{drawingId}/OverdueBalances","operationId":"getDrawingOverdueBalances","name":"Retrieves the past dues and overdues for a drawing","summary":"Retrieves drawing overdue balances","tags":["CORPORATE"],"parameters":[{"name":"drawingId","in":"path","type":"string","required":true,"description":"Identifier of drawings application under the Letter of Credit system that is used to effect the transfer of funds and the acceptance of documents under Letters of Credit and Documentary Collection tra"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"DrawingOverdueBalancesResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/creditAgreements/facilities/clubFacilities","fullPath":"/api/v7.2.0/holdings/creditAgreements/facilities/clubFacilities","operationId":"getClubFacilities","name":"Retrieves club facilities, drawings and deal","summary":"Retrieves club facilities, drawings and deal","tags":["CORPORATE"],"parameters":[{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"ClubFacilitiesResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"POST","path":"/holdings/creditAgreements/facilities/clubFacilities","fullPath":"/api/v7.2.0/holdings/creditAgreements/facilities/clubFacilities","operationId":"createClubFacilities","name":"Creates a club facility with facility details along with the details of participating lenders","summary":"Creates a club facility","tags":["CORPORATE"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"customers":[{}],"productId":"string","currency":"string","effectiveDate":"2024-01-01","extensions":{},"account":[{}],"settlement":[{}],"facommitment":[{}],"upfrontfee":[{}],"coordinationfee":[{}],"limit":[{}],"participant":[{}],"riskparticipant":[{}]}},"responses":{"200":"createClubFacilitiesResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"POST","path":"/holdings/creditAgreements/facilities/drawings/clubDrawings","fullPath":"/api/v7.2.0/holdings/creditAgreements/facilities/drawings/clubDrawings","operationId":"createClubDrawings","name":"Creates a club drawing arrangement with drawdown details along with the details of participating lenders","summary":"Creates a club drawing","tags":["CORPORATE"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"customers":[{}],"arrangmentId":"string","currency":"string","facilityId":"string","effectiveDate":"string","activity":"string","productId":"string","extensions":{},"account":[{}],"escrow":[{}],"dwcommitment":[{}],"settlement":[{}],"participant":[{}],"riskparticipant":[{}]}},"responses":{"200":"createClubDrawingsResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"GET","path":"/holdings/creditAgreements/facilities/drawings/{drawingId}/participants","fullPath":"/api/v7.2.0/holdings/creditAgreements/facilities/drawings/{drawingId}/participants","operationId":"getClubDrawingParticipants","name":"Retrieves the participation details of the lending arrangement for a customer. This will be used to view the agent bank and the participant details and the share amounts when an arrangement id is passed as an input.","summary":"Retrieves the participant details","tags":["CORPORATE"],"parameters":[{"name":"drawingId","in":"path","type":"string","required":true,"description":"Identifier of drawings application under the Letter of Credit system that is used to effect the transfer of funds and the acceptance of documents under Letters of Credit and Documentary Collection tra"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"ClubDrawingParticipantsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"POST","path":"/holdings/creditAgreements/facilities/{facilityId}/fundedShareTransfers","fullPath":"/api/v7.2.0/holdings/creditAgreements/facilities/{facilityId}/fundedShareTransfers","operationId":"createFacilityFundedShareTransfer","name":"Creates a funded share transfer for a facility when participant details are passed. Share of a funding participant is transferred to another funding participant in a club facility and underlying drawings","summary":"Creates a funded share transfer for a facility","tags":["CORPORATE"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"facilityId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"productId":"string","effectiveDate":"2024-01-01","extensions":{},"shareTransfer":[{}]}},"responses":{"200":"createFacilityFundedShareTransferResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"POST","path":"/holdings/creditAgreements/facilities/drawings/{drawingId}/fundedShareTransfers","fullPath":"/api/v7.2.0/holdings/creditAgreements/facilities/drawings/{drawingId}/fundedShareTransfers","operationId":"createDrawingFundedShareTransfer","name":"Creates a funded share transfer for a drawing under a facility when participant details are passed. Share of a funding participant is transferred to another funding participant in a standalone club loan","summary":"Creates a funded share transfer for a drawing","tags":["CORPORATE"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"drawingId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"productId":"string","effectiveDate":"2024-01-01","extensions":{},"shareTransfer":[{}]}},"responses":{"200":"createDrawingFundedShareTransferResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"POST","path":"/holdings/creditAgreements/facilities/{facilityId}/riskShareTransfers","fullPath":"/api/v7.2.0/holdings/creditAgreements/facilities/{facilityId}/riskShareTransfers","operationId":"createFacilityRiskShareTransfer","name":"Creates a risk share transfer for a facility when participant details are passed. The risk of the own bank in a facility is mitigated by selling a portion risk to another financial institution","summary":"Creates a risk share transfer for a facility","tags":["CORPORATE"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"facilityId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"productId":"string","effectiveDate":"2024-01-01","extensions":{},"shareTransfer":[{}]}},"responses":{"200":"createFacilityRiskShareTransferResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"POST","path":"/holdings/creditAgreements/facilities/drawings/{drawingId}/riskShareTransfers","fullPath":"/api/v7.2.0/holdings/creditAgreements/facilities/drawings/{drawingId}/riskShareTransfers","operationId":"createDrawingRiskShareTransfer","name":"Creates a risk share transfer for a drawing under a facility when participant details are passed. The risk of the own bank in a loan is mitigated by selling a portion risk to another financial institution","summary":"Creates a risk share transfer for a drawing","tags":["CORPORATE"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"drawingId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"productId":"string","effectiveDate":"2024-01-01","extensions":{},"shareTransfer":[{}]}},"responses":{"200":"createDrawingRiskShareTransferResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"POST","path":"/holdings/creditAgreements/guarantees/{guaranteeId}/guaranteeIncreases","fullPath":"/api/v7.2.0/holdings/creditAgreements/guarantees/{guaranteeId}/guaranteeIncreases","operationId":"updateGuaranteeCommitmentIncrease","name":"Increase the commitment amount of the guarantee that the financial institution has issued on behalf of the applicant","summary":"Increase the commitment amount of the guarantee","tags":["CORPORATE"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"guaranteeId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"productId":"string","effectiveDate":"2024-01-01","extensions":{},"gteecommitment":[{}]}},"responses":{"200":"updateGuaranteeCommitmentIncreaseResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"POST","path":"/holdings/creditAgreements/guarantees/{guaranteeId}/guaranteeDecreases","fullPath":"/api/v7.2.0/holdings/creditAgreements/guarantees/{guaranteeId}/guaranteeDecreases","operationId":"updateGuaranteeCommitmentDecrease","name":"Decrease the commitment amount of the guarantee that the financial institution has issued on behalf of the applicant","summary":"Decrease the commitment amount of the guarantee","tags":["CORPORATE"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"guaranteeId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"productId":"string","effectiveDate":"2024-01-01","extensions":{},"gteecommitment":[{}]}},"responses":{"200":"updateGuaranteeCommitmentDecreaseResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"POST","path":"/holdings/creditAgreements/guarantees","fullPath":"/api/v7.2.0/holdings/creditAgreements/guarantees","operationId":"createCreditAgreementGuarantee","name":"Register the issuance of a new guarantee undertaking on behalf of the applicant when all the basic details relevant to the undertaking are passed","summary":"Register the issuance of a guarantee","tags":["CORPORATE"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"customers":[{}],"productId":"string","currency":"string","effectiveDate":"2024-01-01","facilityId":"string","extensions":{},"gteecommitment":[{}],"newarrfee":[{}],"settlement":[{}],"termsConditions":[{}]}},"responses":{"200":"createCreditAgreementGuaranteeResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"POST","path":"/holdings/creditAgreements/guarantees/clubGuarantees","fullPath":"/api/v7.2.0/holdings/creditAgreements/guarantees/clubGuarantees","operationId":"createClubGuarantee","name":"Create a club guarantee with guarantee details along with the details of participating lenders","summary":"Create a club guarantee","tags":["CORPORATE"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"customers":[{}],"productId":"string","currency":"string","effectiveDate":"2024-01-01","facilityId":"string","extensions":{},"account":[{}],"gteecommitment":[{}],"newarrfee":[{}],"settlement":[{}],"termsConditions":[{}],"participant":[{}]}},"responses":{"200":"createClubGuaranteeResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"POST","path":"/holdings/creditAgreements/guarantees/{guaranteeId}/cancellations","fullPath":"/api/v7.2.0/holdings/creditAgreements/guarantees/{guaranteeId}/cancellations","operationId":"cancelCorporateGuarantee","name":"Cancel a guarantee arrangement before its expiry date. All the accrued fees are made-due for collection and the bank is discharged of its liability.","summary":"Cancel a guarantee arrangement before the expiry date.","tags":["CORPORATE"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"guaranteeId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"productId":"string","effectiveDate":"2024-01-01","extensions":{},"settlement":[{}]}},"responses":{"200":"cancelCorporateGuaranteeResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"POST","path":"/holdings/creditAgreements/deals","fullPath":"/api/v7.2.0/holdings/creditAgreements/deals","operationId":"createDeals","name":"Create a new deal for the customer with the details like product, term and amount . Corporate deal is a credit agreement between two parties- the lender and the borrower, who agree to certain terms and conditions along with their rights and obligations","summary":"Creates corporate deal","tags":["CORPORATE"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"customers":[{}],"productId":"string","currency":"string","effectiveDate":"2024-01-01","extensions":{},"settlement":[{}],"facilityRules":[{}],"dacommitment":[{}],"adminfee":[{}],"coordinationfee":[{}],"upfrontfee":[{}],"limit":[{}]}},"responses":{"200":"createDealsResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"POST","path":"/holdings/creditAgreements/loanTrades/trades","fullPath":"/api/v7.2.0/holdings/creditAgreements/loanTrades/trades","operationId":"createTrade","name":"Create a trade for a syndicated loan as initially agreed upon between counterparties.","summary":"Create a trade for a syndicated loan.","tags":["CORPORATE"],"parameters":[{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"counterPartyDetails":[{}],"dealCustomerDetails":[{}],"dealAdditionalInfo":[{}],"ssi":[{}],"ownBankDetails":[{}],"agentBankDetails":[{}],"consentDetails":[{}],"chargeDetails":[{}],"tradeAccountDetails":[{}],"tradeActivity":"string","alternateId":"string","tradeProduct":"string","tradeDate":"string","tradeCurrency":"string","transferType":"string"}},"responses":{"200":"TradeResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"POST","path":"/holdings/creditAgreements/loanTrades/{loanTradeId}/confirmationTrade","fullPath":"/api/v7.2.0/holdings/creditAgreements/loanTrades/{loanTradeId}/confirmationTrade","operationId":"acceptTrade","name":"Confirm the trade when all the parties involved agreed the terms and conditions of the trade.","summary":"Confirm the trade","tags":["CORPORATE"],"parameters":[{"name":"loanTradeId","in":"path","type":"string","required":true,"description":""},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"dealCustomerDetails":[{}],"dealAdditionalinfos":[{}],"dealReference":"string","dealTitle":"string","currency":"string","globalAmount":"string","startDate":"string","agentBank":"string","agentId":"string","agentName":"string","extensions":{}}},"responses":{"200":"TradeResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"POST","path":"/holdings/creditAgreements/loanTrades/{loanTradeId}","fullPath":"/api/v7.2.0/holdings/creditAgreements/loanTrades/{loanTradeId}","operationId":"updateTrade","name":"Update additional details in trade.","summary":"Update trade details","tags":["CORPORATE"],"parameters":[{"name":"loanTradeId","in":"path","type":"string","required":true,"description":""},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"dealCustomerDetails":[{}],"dealAdditionalInfo":[{}],"ssi":[{}],"ownBankDetails":[{}],"agentBankDetails":[{}],"chargeDetails":[{}],"tradeAccountDetails":[{}],"alternateId":"string","transferType":"string","expectedSettlementDate":"string","tradeNotes":"string","businessDayCentre":"string","dealReference":"string","dealTitle":"string","currency":"string"}},"responses":{"200":"TradeResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"POST","path":"/holdings/creditAgreements/loanTrades/{loanTradeId}/consents","fullPath":"/api/v7.2.0/holdings/creditAgreements/loanTrades/{loanTradeId}/consents","operationId":"updateConsent","name":"Update borrower consent for trade","summary":"Update consent status if borrower has agreed or rejected trade.","tags":["CORPORATE"],"parameters":[{"name":"loanTradeId","in":"path","type":"string","required":true,"description":""},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"consentDetails":[{}],"chargeDetails":[{}],"tradeStatus":"string","extensions":{}}},"responses":{"200":"ConsentResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"POST","path":"/holdings/creditAgreements/loanTrades/{loanTradeId}/commitments","fullPath":"/api/v7.2.0/holdings/creditAgreements/loanTrades/{loanTradeId}/commitments","operationId":"updateCommitment","name":"Update the trade due to changes in commitment amount being traded.","summary":"Update commitment details","tags":["CORPORATE"],"parameters":[{"name":"loanTradeId","in":"path","type":"string","required":true,"description":""},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"chargeDetails":[{}],"tradeAccountDetails":[{}],"amount":"string","expectedSettlementDate":"string","actualSettlementDate":"string","tradePrice":"string","settlementMethod":"string","allowNetback":"string","allowBoCR":"string","extensions":{}}},"responses":{"200":"CommitmentResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"POST","path":"/holdings/creditAgreements/loanTrades/{loanTradeId}/acceptances","fullPath":"/api/v7.2.0/holdings/creditAgreements/loanTrades/{loanTradeId}/acceptances","operationId":"approveTrade","name":"Finalize the trade to verify all necessary details are available.","summary":"Finalize the trade to issue pricing letter.","tags":["CORPORATE"],"parameters":[{"name":"loanTradeId","in":"path","type":"string","required":true,"description":""},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"dealCustomerDetails":[{}],"dealAdditionalInfo":[{}],"ssi":[{}],"ownBankDetails":[{}],"agentBankDetails":[{}],"tradeNotes":"string","dealReference":"string","dealTitle":"string","currency":"string","globalAmount":"string","startDate":"string","agentBank":"string","agentId":"string","agentName":"string","extensions":{}}},"responses":{"200":"TradeResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"POST","path":"/holdings/creditAgreements/loanTrades/{loanTradeId}/messages","fullPath":"/api/v7.2.0/holdings/creditAgreements/loanTrades/{loanTradeId}/messages","operationId":"showPricingLetter","name":"Issue pricing letter to the counter party for a final settlement amount.","summary":"Issue pricing letter to counterparty.","tags":["CORPORATE"],"parameters":[{"name":"loanTradeId","in":"path","type":"string","required":true,"description":""},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"extensions":{}}},"responses":{"200":"PricingLetterResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"POST","path":"/holdings/creditAgreements/loanTrades/{loanTradeId}/settlements","fullPath":"/api/v7.2.0/holdings/creditAgreements/loanTrades/{loanTradeId}/settlements","operationId":"calculateTrade","name":"Settle the trade in bank books.","summary":"Settle trade.","tags":["CORPORATE"],"parameters":[{"name":"loanTradeId","in":"path","type":"string","required":true,"description":""},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"issuePricing":"string","tradeNotes":"string","extensions":{}}},"responses":{"200":"TradeResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"POST","path":"/holdings/creditAgreements/loanTrades/{loanTradeId}/cancellations","fullPath":"/api/v7.2.0/holdings/creditAgreements/loanTrades/{loanTradeId}/cancellations","operationId":"cancelTrade","name":"Cancel the trade in bank books.","summary":"Cancel trade.","tags":["CORPORATE"],"parameters":[{"name":"loanTradeId","in":"path","type":"string","required":true,"description":""},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"tradeNotes":"string","extensions":{}}},"responses":{"200":"TradeResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/holdings/creditAgreements/loanTrades/{loanTradeId}/charges","fullPath":"/api/v7.2.0/holdings/creditAgreements/loanTrades/{loanTradeId}/charges","operationId":"getCharges","name":"View all the charge details for a given trade.","summary":"View charges.","tags":["CORPORATE"],"parameters":[{"name":"loanTradeId","in":"path","type":"string","required":true,"description":""},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"ChargesResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"PUT","path":"/holdings/creditAgreements/loanTrades/{loanTradeId}/charges","fullPath":"/api/v7.2.0/holdings/creditAgreements/loanTrades/{loanTradeId}/charges","operationId":"updateCharges","name":"Amend charges already authorized in the trade","summary":"Amend charges.","tags":["CORPORATE"],"parameters":[{"name":"loanTradeId","in":"path","type":"string","required":true,"description":""},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"chargeDetails":[{}],"extensions":{}}},"responses":{"200":"ChargesResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/holdings/creditAgreements/loanTrades/products","fullPath":"/api/v7.2.0/holdings/creditAgreements/loanTrades/products","operationId":"getTradeProducts","name":"View all the trade products","summary":"View trade products","tags":["CORPORATE"],"parameters":[{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"TradeProductsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"PUT","path":"/holdings/creditAgreements/facilities/{facilityId}/coordinationFees","fullPath":"/api/v7.2.0/holdings/creditAgreements/facilities/{facilityId}/coordinationFees","operationId":"updateFacilityCoordinationFees","name":"Updating coordination fees to pay the fee to its participants in facility","summary":"Updating coordination fees to pay the fee to its participants in facility","tags":["CORPORATE"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"facilityId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"productId":"string","effectiveDate":"2024-01-01","extensions":{},"coordinationfee":[{}]}},"responses":{"200":"updateFacilityCoordinationFeesResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"PUT","path":"/holdings/creditAgreements/facilities/{facilityId}/upfrontFees","fullPath":"/api/v7.2.0/holdings/creditAgreements/facilities/{facilityId}/upfrontFees","operationId":"updateFacilityUpfrontFees","name":"Updating the upfront fee which is collect one time by bank","summary":"Updating the upfront fee which is collect one time by bank","tags":["CORPORATE"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"facilityId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"productId":"string","effectiveDate":"2024-01-01","extensions":{},"upfrontfee":[{}]}},"responses":{"200":"updateFacilityUpfrontFeesResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"PUT","path":"/holdings/creditAgreements/facilities/{facilityId}/drawdowns/rules","fullPath":"/api/v7.2.0/holdings/creditAgreements/facilities/{facilityId}/drawdowns/rules","operationId":"UpdateFacilityDrawingRules","name":"Initiating drawing rules to restrict customer, currency and products for drawdown under facility level.","summary":"Initiating drawing rules to restrict customer, currency and products for drawdown under facility level.","tags":["CORPORATE"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"facilityId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"productId":"string","effectiveDate":"2024-01-01","extensions":{},"drawingRules":[{}]}},"responses":{"200":"UpdateFacilityDrawingRulesResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"PUT","path":"/holdings/creditAgreements/facilities/{facilityId}/drawdowns/conditions","fullPath":"/api/v7.2.0/holdings/creditAgreements/facilities/{facilityId}/drawdowns/conditions","operationId":"updateFacilityDrawingConditions","name":"Initiating drawing condition to restrict customer, currency and products for drawdown with overrides.","summary":"Initiating drawing condition to restrict customer, currency and products for drawdown with overrides.","tags":["CORPORATE"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"facilityId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"productId":"string","effectiveDate":"2024-01-01","extensions":{},"drawingConditions":[{}]}},"responses":{"200":"updateFacilityDrawingConditionsResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"PUT","path":"/holdings/creditAgreements/deals/{dealId}/commitmentIncreases","fullPath":"/api/v7.2.0/holdings/creditAgreements/deals/{dealId}/commitmentIncreases","operationId":"createDealCommitmentIncreases","name":"Increase the commitment amount of the existing deal arrangement.","summary":"Increase the commitment amount of the existing deal arrangement.","tags":["CORPORATE"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"dealId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"effectiveDate":"2024-01-01","activityId":"string","externalEventStatus":"string","extensions":{},"dacommitment":[{}]}},"responses":{"200":"createDealCommitmentIncreasesResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"PUT","path":"/holdings/creditAgreements/deals/{dealId}/commitmentDecreases","fullPath":"/api/v7.2.0/holdings/creditAgreements/deals/{dealId}/commitmentDecreases","operationId":"createDealCommitmentDecreases","name":"The commitment amount of the existing deal arrangement can be decreased","summary":"The commitment amount of the existing deal arrangement can be decreased","tags":["CORPORATE"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"dealId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"effectiveDate":"2024-01-01","activityId":"string","externalEventStatus":"string","extensions":{},"dacommitment":[{}]}},"responses":{"200":"createDealCommitmentDecreasesResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"PUT","path":"/holdings/creditAgreements/deals/{dealId}/blockcommitmentandTerm","fullPath":"/api/v7.2.0/holdings/creditAgreements/deals/{dealId}/blockcommitmentandTerm","operationId":"UpdateBlockcommitmentandTerm","name":"Block the commitment and term of the existing deal arrangement.","summary":"Block the commitment and term of the existing deal arrangement.","tags":["CORPORATE"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"dealId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"parties":[{}],"activityId":"string","effectiveDate":"string","productId":"string","currencyId":"string","simulationId":"string","extensions":{}}},"responses":{"200":"UpdateBlockcommitmentandTermResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"PUT","path":"/holdings/creditAgreements/deals/{dealId}/unblockCommitmentTerm","fullPath":"/api/v7.2.0/holdings/creditAgreements/deals/{dealId}/unblockCommitmentTerm","operationId":"UpdateUnblockcommitmentandTerm","name":"Unblock the commitment and term of the existing deal arrangement.","summary":"Unblock the commitment and term of the existing deal arrangement.","tags":["CORPORATE"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"dealId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"parties":[{}],"activityId":"string","effectiveDate":"string","productId":"string","currencyId":"string","simulationId":"string","extensions":{}}},"responses":{"200":"UpdateUnblockcommitmentandTermResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}}]},{"key":"holdings-creditAgreements-api-service-v7.3.0","title":"Corporate Credit Agreements","version":"v7.3.0","description":"API for the creation and management of credit agreements for corporate customers. The types of credit agreements are single level facility, credit agreement with multiple facilities, club loans with agency and syndicated loans","endpointCount":75,"endpoints":[{"method":"POST","path":"/holdings/creditAgreements/deals/offers","fullPath":"/api/v7.3.0/holdings/creditAgreements/deals/offers","operationId":"createDealOffer","name":"Creates new offer deal for the required customer when the mandatory input details are provided. Offer deal creates a draft contract and allows the users to negotiate multiple times. Offer deal is a draft contract and will not affect the balance sheet of the bank.","summary":"Creates an offer for a deal contract","tags":["CORPORATE"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"customers":[{}],"productId":"string","currency":"string","effectiveDate":"2024-01-01","activity":"string","extensions":{},"facilityRules":[{}],"dacommitment":[{}],"adminfee":[{}],"coordinationfee":[{}],"upfrontfee":[{}],"limit":[{}]}},"responses":{"200":"createDealOfferResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"POST","path":"/holdings/creditAgreements/facilities/offers","fullPath":"/api/v7.3.0/holdings/creditAgreements/facilities/offers","operationId":"createFacilityOffer","name":"Creates a new offer facility for the required customer when at least the mandatory input is provided. Offer facility creates a draft contract and allow the users to negotiate multiple times. Offer facility is a draft contract and will not affect the balance sheet of the bank.","summary":"Creates an offer for a facility contract","tags":["CORPORATE"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"customers":[{}],"productId":"string","currency":"string","dealId":"string","effectiveDate":"2024-01-01","activity":"string","extensions":{},"settlement":[{}],"facommitment":[{}],"upfrontfee":[{}],"coordinationfee":[{}],"limit":[{}]}},"responses":{"200":"createFacilityOfferResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"POST","path":"/holdings/creditAgreements/deals/offers/cancellations/{arrangementId}","fullPath":"/api/v7.3.0/holdings/creditAgreements/deals/offers/cancellations/{arrangementId}","operationId":"deleteDealOffer","name":"Deletes a new offer for the required deal contract when at least the mandatory input is provided. Deal offer is a draft contract, which allow the user to delete the contract online and deal offer contract will not affect the balance sheet of the bank.","summary":"Deletes an offer for a deal contract","tags":["CORPORATE"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"arrangementId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"productId":"string","effectiveDate":"2024-01-01","extensions":{}}},"responses":{"200":"deleteDealOfferResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"POST","path":"/holdings/creditAgreements/facilities/offers/cancellations/{arrangementId}","fullPath":"/api/v7.3.0/holdings/creditAgreements/facilities/offers/cancellations/{arrangementId}","operationId":"deleteFacilityOffer","name":"Deletes a new offer for the required facility contract when at least the mandatory input is provided. Facility offer is a draft contract, which allow the user to delete the contract online and facility offer contract will not affect the balance sheet of the bank.","summary":"Deletes an offer for a facility contract","tags":["CORPORATE"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"arrangementId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"productId":"string","effectiveDate":"2024-01-01","extensions":{}}},"responses":{"200":"deleteFacilityOfferResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"POST","path":"/holdings/creditAgreements/deals/offers/acceptances/{arrangementId}","fullPath":"/api/v7.3.0/holdings/creditAgreements/deals/offers/acceptances/{arrangementId}","operationId":"acceptDealOffer","name":"On executing acceptance, the contract is changed from offer to live deal for the required customer when at least the mandatory input is provided. Process will check all the required mandatory inputs and prompt an error message when mandatory details are not provided. Once the accept deal offer is processed further offer negotiation is not allowed.","summary":"Accept the deal offer and execute the contract to live","tags":["CORPORATE"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"arrangementId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"productId":"string","effectiveDate":"2024-01-01","extensions":{},"settlement":[{}],"facilityRules":[{}],"dacommitment":[{}],"adminfee":[{}],"coordinationfee":[{}],"upfrontfee":[{}],"limit":[{}]}},"responses":{"200":"acceptDealOfferResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"POST","path":"/holdings/creditAgreements/facilities/offers/acceptances/{arrangementId}","fullPath":"/api/v7.3.0/holdings/creditAgreements/facilities/offers/acceptances/{arrangementId}","operationId":"acceptFacilityOffer","name":"On executing acceptance, the contract is changed from offer to live facility for the required customer when at least the mandatory input is provided. Process will check all the required mandatory inputs and prompt an error message when mandatory details are not provided. Once the accept deal offer is processed further offer negotiation is not allowed.","summary":"Accept the facility offer and execute the contract to live","tags":["CORPORATE"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"arrangementId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"productId":"string","effectiveDate":"2024-01-01","extensions":{},"settlement":[{}],"facommitment":[{}],"upfrontfee":[{}],"coordinationfee":[{}],"limit":[{}]}},"responses":{"200":"acceptFacilityOfferResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"POST","path":"/holdings/creditAgreements/drawdowns/offers","fullPath":"/api/v7.3.0/holdings/creditAgreements/drawdowns/offers","operationId":"createDrawdownOffer","name":"Creates a new drawdown offer for the required customer. ","summary":"Creates a new drawdown offer for the required customer. ","tags":["CORPORATE"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"customers":[{}],"productId":"string","currency":"string","facilityId":"string","offerDate":"2024-01-01","drawdownDate":"2024-01-01","activity":"string","extensions":{},"maintenancefee":[{}],"dwcommitment":[{}],"settlement":[{}]}},"responses":{"200":"createDrawdownOfferResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"POST","path":"/holdings/creditAgreements/drawdowns/offers/negotiations","fullPath":"/api/v7.3.0/holdings/creditAgreements/drawdowns/offers/negotiations","operationId":"createOfferDrawdownRenegotiation","name":"Renegotiate the offer drawdown for the required customer.","summary":"Renegotiate the offer drawdown for the required customer.","tags":["CORPORATE"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"productId":"string","drawdownDate":"2024-01-01","extensions":{},"maintenancefee":[{}],"settlement":[{}]}},"responses":{"200":"createOfferDrawdownRenegotiationResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"POST","path":"/holdings/creditAgreements/drawdowns/offers/cancellations","fullPath":"/api/v7.3.0/holdings/creditAgreements/drawdowns/offers/cancellations","operationId":"deleteDrawdownOffer","name":"Cancellation of offer drawdown for the required customer.","summary":"Cancellation of offer drawdown for the required customer.","tags":["CORPORATE"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"productId":"string","drawdownDate":"2024-01-01","extensions":{}}},"responses":{"200":"deleteDrawdownOfferResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"POST","path":"/holdings/creditAgreements/drawdowns/offers/acceptances","fullPath":"/api/v7.3.0/holdings/creditAgreements/drawdowns/offers/acceptances","operationId":"acceptOfferDrawdown","name":"Convert an offer drawdown to a live drawdown for the required customer.","summary":"Convert an offer drawdown to a live drawdown for the required customer.","tags":["CORPORATE"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"productId":"string","drawdownDate":"2024-01-01","extensions":{},"maintenancefee":[{}],"dwcommitment":[{}],"settlement":[{}]}},"responses":{"200":"acceptOfferDrawdownResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"GET","path":"/holdings/creditAgreements/facilities/{facilityId}/drawingProducts","fullPath":"/api/v7.3.0/holdings/creditAgreements/facilities/{facilityId}/drawingProducts","operationId":"getFacilityDrawingProducts","name":"Retrieves the available drawing products under the facility ","summary":"Retrieves the available drawing products under the facility ","tags":["CORPORATE"],"parameters":[{"name":"facilityId","in":"path","type":"string","required":true,"description":"Unique identifier (contract number) of the facility"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"FacilityDrawingProductsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/creditAgreements/facilities/{facilityId}/combinedSchedules","fullPath":"/api/v7.3.0/holdings/creditAgreements/facilities/{facilityId}/combinedSchedules","operationId":"getCombinedSchedules","name":"Retrieves the payment schedule of facility and its drawings","summary":"Retrieves the payment schedule of facility and its drawings","tags":["CORPORATE"],"parameters":[{"name":"facilityId","in":"path","type":"string","required":true,"description":"Unique identifier (contract number) of the facility"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"CombinedSchedulesResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"POST","path":"/holdings/creditAgreements/facilities","fullPath":"/api/v7.3.0/holdings/creditAgreements/facilities","operationId":"createFacilities","name":"Creates corporate facilities","summary":"Creates corporate facilities","tags":["CORPORATE"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"customers":[{}],"productId":"string","currency":"string","effectiveDate":"2024-01-01","dealId":"string","extensions":{},"settlement":[{}],"facommitment":[{}],"upfrontfee":[{}],"coordinationfee":[{}],"limit":[{}]}},"responses":{"200":"createFacilitiesResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"POST","path":"/holdings/creditAgreements/drawdowns","fullPath":"/api/v7.3.0/holdings/creditAgreements/drawdowns","operationId":"createDrawdowns","name":"Creates drawdowns under facility","summary":"Creates drawdowns under facility","tags":["CORPORATE"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"customers":[{}],"arrangmentId":"string","currency":"string","facilityId":"string","effectiveDate":"string","activity":"string","productId":"string","extensions":{},"escrow":[{}],"dwcommitment":[{}],"settlement":[{}]}},"responses":{"200":"createDrawdownsResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"GET","path":"/holdings/creditAgreements/facilities/{facilityId}/drawingRules","fullPath":"/api/v7.3.0/holdings/creditAgreements/facilities/{facilityId}/drawingRules","operationId":"getFacilityDrawingRules","name":"Retrieves the allowed customers, currencies and products for a new drawing under the facility","summary":"Retrieves the allowed customers, currencies and products for a new drawing under the facility","tags":["CORPORATE"],"parameters":[{"name":"facilityId","in":"path","type":"string","required":true,"description":"Unique identifier (contract number) of the facility"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"FacilityDrawingRulesResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/creditAgreements/facilities/{facilityId}/drawings","fullPath":"/api/v7.3.0/holdings/creditAgreements/facilities/{facilityId}/drawings","operationId":"getDrawingsUnderFacility","name":"Retrieves the drawings under a facility","summary":"Retrieves the drawings under a facility","tags":["CORPORATE"],"parameters":[{"name":"facilityId","in":"path","type":"string","required":true,"description":"Unique identifier (contract number) of the facility"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"DrawingsUnderFacilityResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/creditAgreements/facilities/drawings/{drawingId}/parentFacilities","fullPath":"/api/v7.3.0/holdings/creditAgreements/facilities/drawings/{drawingId}/parentFacilities","operationId":"getDrawingFacility","name":"Retrieves the parent facility for a drawing","summary":"Retrieves the parent facility for a drawing","tags":["CORPORATE"],"parameters":[{"name":"drawingId","in":"path","type":"string","required":true,"description":"Identifier of drawings application under the Letter of Credit system that is used to effect the transfer of funds and the acceptance of documents under Letters of Credit and Documentary Collection tra"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"DrawingFacilityResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/creditAgreements/facilities/{facilityId}/commitmentSchedules","fullPath":"/api/v7.3.0/holdings/creditAgreements/facilities/{facilityId}/commitmentSchedules","operationId":"getFacilityCommitmentSchedule","name":"Retrieves the commitment schedule of a facility","summary":"Retrieves the commitment schedule of a facility","tags":["CORPORATE"],"parameters":[{"name":"facilityId","in":"path","type":"string","required":true,"description":"Unique identifier (contract number) of the facility"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"FacilityCommitmentScheduleResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/creditAgreements/facilities/{facilityId}/parentDeals","fullPath":"/api/v7.3.0/holdings/creditAgreements/facilities/{facilityId}/parentDeals","operationId":"getFacilityDeal","name":"Retrieves the parent deal for a facility","summary":"Retrieves the parent deal for a facility","tags":["CORPORATE"],"parameters":[{"name":"facilityId","in":"path","type":"string","required":true,"description":"Unique identifier (contract number) of the facility"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"FacilityDealResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/creditAgreements/facilities/{facilityId}/balances","fullPath":"/api/v7.3.0/holdings/creditAgreements/facilities/{facilityId}/balances","operationId":"getFacilityFinancialSummary","name":"Retrieves the financial summary for a facility arrangement","summary":"Retrieves the financial summary for a facility arrangement","tags":["CORPORATE"],"parameters":[{"name":"facilityId","in":"path","type":"string","required":true,"description":"Unique identifier (contract number) of the facility"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"FacilityFinancialSummaryResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/creditAgreements/facilities/{facilityId}/consolidatedBalances","fullPath":"/api/v7.3.0/holdings/creditAgreements/facilities/{facilityId}/consolidatedBalances","operationId":"getFacilityConsolidatedBalances","name":"Retrieves the consolidated balances for a facility arrangement","summary":"Retrieves the consolidated balances for a facility arrangement","tags":["CORPORATE"],"parameters":[{"name":"facilityId","in":"path","type":"string","required":true,"description":"Unique identifier (contract number) of the facility"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"FacilityConsolidatedBalancesResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"POST","path":"/holdings/creditAgreements/facilities/directDebits","fullPath":"/api/v7.3.0/holdings/creditAgreements/facilities/directDebits","operationId":"createFacilityDirectDebitLink","name":"Links a direct debit to an existing facility","summary":"Links a direct debit to a facility","tags":["CORPORATE"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"customers":[{}],"arrangement":"string","productId":"string","currency":"string","effectiveDate":"2024-01-01","extensions":{},"settlement":[{}]}},"responses":{"200":"createFacilityDirectDebitLinkResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"POST","path":"/holdings/creditAgreements/facilities/drawings/directDebits","fullPath":"/api/v7.3.0/holdings/creditAgreements/facilities/drawings/directDebits","operationId":"createDrawingDirectDebitLink","name":"Link the direct debit to an existing drawing under a facility","summary":"Links a direct debit to a drawing","tags":["CORPORATE"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"customers":[{}],"arrangement":"string","currency":"string","facilityId":"string","effectiveDate":"string","productId":"string","extensions":{},"settlement":[{}]}},"responses":{"200":"createDrawingDirectDebitLinkResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"POST","path":"/holdings/creditAgreements/facilities/rollovers/offers","fullPath":"/api/v7.3.0/holdings/creditAgreements/facilities/rollovers/offers","operationId":"createFacilityRolloverOffer","name":"Create rollover process from the facility where the rollover could be a split rollover, merge rollover or a one to one rollover. Split also called as one to many will rollover an old loan and create multiple new offer loans. Merge also called as many to one will rollover multiple old loans simultaneously and create a single new offer loan. Rollover also called as one to one will simply rollover an old loan and create a new offer loan","summary":"Create rollover offer from facility","tags":["CORPORATE"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"arrangement":"string","rolloverDate":"string","productId":"string","extensions":{},"splitsMerges":[{}]}},"responses":{"200":"createFacilityRolloverOfferResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"POST","path":"/holdings/creditAgreements/drawdowns/rollovers/offers","fullPath":"/api/v7.3.0/holdings/creditAgreements/drawdowns/rollovers/offers","operationId":"createDrawdownRolloverOffer","name":"Create rollover process from the drawdown where the rollover could be a split rollover, merge rollover or a one to one rollover. Split also called as one to many will rollover an old loan and create multiple new offer loans. Merge also called as many to one will rollover multiple old loans simultaneously and create a single new offer loan. Rollover also called as one to one will simply rollover an old loan and create a new offer loan","summary":"Create rollover offer from drawdown","tags":["CORPORATE"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"arrangement":"string","rolloverDate":"string","productId":"string","extensions":{},"splitsMerges":[{}]}},"responses":{"200":"createDrawdownRolloverOfferResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"POST","path":"/holdings/creditAgreements/facilities/commitmentIncreases/{arrangementId}","fullPath":"/api/v7.3.0/holdings/creditAgreements/facilities/commitmentIncreases/{arrangementId}","operationId":"updateFacilityCommitmentIncrease","name":"Increase the facility amount to facilitate further drawdowns","summary":"Increase facility amount","tags":["CORPORATE"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"arrangementId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"productId":"string","effectiveDate":"2024-01-01","extensions":{},"facommitment":[{}]}},"responses":{"200":"updateFacilityCommitmentIncreaseResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"POST","path":"/holdings/creditAgreements/facilities/commitmentTerms/{arrangementId}","fullPath":"/api/v7.3.0/holdings/creditAgreements/facilities/commitmentTerms/{arrangementId}","operationId":"updateFacilityCommitmentTerms","name":"Updates facility tenure by increasing or decreasing the term, in addition it allows the amendment of the availability schedule of the contract.","summary":"Update facility maturity date and availability","tags":["CORPORATE"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"arrangementId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"productId":"string","effectiveDate":"2024-01-01","extensions":{},"facommitment":[{}]}},"responses":{"200":"updateFacilityCommitmentTermsResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"GET","path":"/holdings/customers/{customerId}/creditAgreements/exposures","fullPath":"/api/v7.3.0/holdings/customers/{customerId}/creditAgreements/exposures","operationId":"getCustomerExposure","name":"Retrieves the customer exposure such as the facility number, type of facility, maturity date and various amounts of the facilities/standalone loans.","summary":"Retrieves the customer exposure for facilities and loans","tags":["CORPORATE"],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"Identifier of the customer"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"CustomerExposureResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/customers/{customerId}/creditAgreements/drawings","fullPath":"/api/v7.3.0/holdings/customers/{customerId}/creditAgreements/drawings","operationId":"getCustomerDrawings","name":"Retrieves the details such as the drawing id, account number, short description of the loan, customer name and loan status for a customer. ","summary":"Retrieves the drawing details for a customer.","tags":["CORPORATE"],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"Identifier of the customer"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"CustomerDrawingsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/customers/{customerId}/creditAgreements/facilities","fullPath":"/api/v7.3.0/holdings/customers/{customerId}/creditAgreements/facilities","operationId":"getCustomerFacilities","name":"Retrieves the details such as the facility id, account number, short description of the facility, customer name and facility status for a customer.","summary":"Retrieves the facility details for a customer.","tags":["CORPORATE"],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"Identifier of the customer"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"CustomerFacilitiesResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/customers/{customerId}/creditAgreements/deals","fullPath":"/api/v7.3.0/holdings/customers/{customerId}/creditAgreements/deals","operationId":"getCustomerDeals","name":"Retrieves the details such as the deal id, account number, short description of the facility, customer name and deal status for a customer.","summary":"Retrieves the deal details for a customer.","tags":["CORPORATE"],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"Identifier of the customer"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"CustomerDealsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/creditAgreements/deals/{dealId}/facilities","fullPath":"/api/v7.3.0/holdings/creditAgreements/deals/{dealId}/facilities","operationId":"getFacilitiesUnderDeal","name":"Retrieves the details such as facility id, title, currency, status and commitment amount for all the facilities under a deal.","summary":"Retrieves the details of facilities under a deal.","tags":["CORPORATE"],"parameters":[{"name":"dealId","in":"path","type":"string","required":true,"description":"Unique identifier (contract number) of the corporate deals"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"FacilitiesUnderDealResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/creditAgreements/productCatalogues","fullPath":"/api/v7.3.0/holdings/creditAgreements/productCatalogues","operationId":"getCreditAgreementsProductCatalogue","name":"Retrieves the list of available products for credit agreements.","summary":"Retrieves the credit agreements product catalogue.","tags":["CORPORATE"],"parameters":[{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"CreditAgreementsProductCatalogueResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/creditAgreements/drawings/{drawingId}/pendingActivities","fullPath":"/api/v7.3.0/holdings/creditAgreements/drawings/{drawingId}/pendingActivities","operationId":"getPendingActivities","name":"Retrieves the details such as rollover date, rollover status etc of pending drawdowns and rollovers for a drawing.","summary":"Retrieves the details of pending drawdowns and rollovers for a drawing.","tags":["CORPORATE"],"parameters":[{"name":"drawingId","in":"path","type":"string","required":true,"description":"Identifier of drawings application under the Letter of Credit system that is used to effect the transfer of funds and the acceptance of documents under Letters of Credit and Documentary Collection tra"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"PendingActivitiesResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/creditAgreements/drawings/expiries","fullPath":"/api/v7.3.0/holdings/creditAgreements/drawings/expiries","operationId":"getLoansExpiring","name":"Retrieves the drawings expiring in the next 7 days.","summary":"Retrieves expiring drawings.","tags":["CORPORATE"],"parameters":[{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"LoansExpiringResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/creditAgreements/facilities/expiries","fullPath":"/api/v7.3.0/holdings/creditAgreements/facilities/expiries","operationId":"getFacilitiesExpiring","name":"Retrieves the facilities expiring in the next 7 days","summary":"Retrieves expiring facilities","tags":["CORPORATE"],"parameters":[{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"FacilitiesExpiringResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/creditAgreements/drawings/{drawingId}/balances","fullPath":"/api/v7.3.0/holdings/creditAgreements/drawings/{drawingId}/balances","operationId":"getDrawingBalances","name":"Retrieves the balance details such as commitment balances, utilized balances.","summary":"Retrieves drawing balances","tags":["CORPORATE"],"parameters":[{"name":"drawingId","in":"path","type":"string","required":true,"description":"Identifier of drawings application under the Letter of Credit system that is used to effect the transfer of funds and the acceptance of documents under Letters of Credit and Documentary Collection tra"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"DrawingBalancesResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/creditAgreements/drawings/{drawingId}/OverdueBalances","fullPath":"/api/v7.3.0/holdings/creditAgreements/drawings/{drawingId}/OverdueBalances","operationId":"getDrawingOverdueBalances","name":"Retrieves the past dues and overdues for a drawing","summary":"Retrieves drawing overdue balances","tags":["CORPORATE"],"parameters":[{"name":"drawingId","in":"path","type":"string","required":true,"description":"Identifier of drawings application under the Letter of Credit system that is used to effect the transfer of funds and the acceptance of documents under Letters of Credit and Documentary Collection tra"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"DrawingOverdueBalancesResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/creditAgreements/facilities/clubFacilities","fullPath":"/api/v7.3.0/holdings/creditAgreements/facilities/clubFacilities","operationId":"getClubFacilities","name":"Retrieves club facilities, drawings and deal","summary":"Retrieves club facilities, drawings and deal","tags":["CORPORATE"],"parameters":[{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"ClubFacilitiesResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"POST","path":"/holdings/creditAgreements/facilities/clubFacilities","fullPath":"/api/v7.3.0/holdings/creditAgreements/facilities/clubFacilities","operationId":"createClubFacilities","name":"Creates a club facility with facility details along with the details of participating lenders","summary":"Creates a club facility","tags":["CORPORATE"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"customers":[{}],"productId":"string","currency":"string","effectiveDate":"2024-01-01","extensions":{},"account":[{}],"settlement":[{}],"facommitment":[{}],"upfrontfee":[{}],"coordinationfee":[{}],"limit":[{}],"participant":[{}],"riskparticipant":[{}]}},"responses":{"200":"createClubFacilitiesResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"POST","path":"/holdings/creditAgreements/facilities/drawings/clubDrawings","fullPath":"/api/v7.3.0/holdings/creditAgreements/facilities/drawings/clubDrawings","operationId":"createClubDrawings","name":"Creates a club drawing arrangement with drawdown details along with the details of participating lenders","summary":"Creates a club drawing","tags":["CORPORATE"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"customers":[{}],"arrangmentId":"string","currency":"string","facilityId":"string","effectiveDate":"string","activity":"string","productId":"string","extensions":{},"account":[{}],"escrow":[{}],"dwcommitment":[{}],"settlement":[{}],"participant":[{}],"riskparticipant":[{}]}},"responses":{"200":"createClubDrawingsResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"GET","path":"/holdings/creditAgreements/facilities/drawings/{drawingId}/participants","fullPath":"/api/v7.3.0/holdings/creditAgreements/facilities/drawings/{drawingId}/participants","operationId":"getClubDrawingParticipants","name":"Retrieves the participation details of the lending arrangement for a customer. This will be used to view the agent bank and the participant details and the share amounts when an arrangement id is passed as an input.","summary":"Retrieves the participant details","tags":["CORPORATE"],"parameters":[{"name":"drawingId","in":"path","type":"string","required":true,"description":"Identifier of drawings application under the Letter of Credit system that is used to effect the transfer of funds and the acceptance of documents under Letters of Credit and Documentary Collection tra"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"ClubDrawingParticipantsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"POST","path":"/holdings/creditAgreements/facilities/{facilityId}/fundedShareTransfers","fullPath":"/api/v7.3.0/holdings/creditAgreements/facilities/{facilityId}/fundedShareTransfers","operationId":"createFacilityFundedShareTransfer","name":"Creates a funded share transfer for a facility when participant details are passed. Share of a funding participant is transferred to another funding participant in a club facility and underlying drawings","summary":"Creates a funded share transfer for a facility","tags":["CORPORATE"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"facilityId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"productId":"string","effectiveDate":"2024-01-01","extensions":{},"shareTransfer":[{}]}},"responses":{"200":"createFacilityFundedShareTransferResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"POST","path":"/holdings/creditAgreements/facilities/drawings/{drawingId}/fundedShareTransfers","fullPath":"/api/v7.3.0/holdings/creditAgreements/facilities/drawings/{drawingId}/fundedShareTransfers","operationId":"createDrawingFundedShareTransfer","name":"Creates a funded share transfer for a drawing under a facility when participant details are passed. Share of a funding participant is transferred to another funding participant in a standalone club loan","summary":"Creates a funded share transfer for a drawing","tags":["CORPORATE"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"drawingId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"productId":"string","effectiveDate":"2024-01-01","extensions":{},"shareTransfer":[{}]}},"responses":{"200":"createDrawingFundedShareTransferResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"POST","path":"/holdings/creditAgreements/facilities/{facilityId}/riskShareTransfers","fullPath":"/api/v7.3.0/holdings/creditAgreements/facilities/{facilityId}/riskShareTransfers","operationId":"createFacilityRiskShareTransfer","name":"Creates a risk share transfer for a facility when participant details are passed. The risk of the own bank in a facility is mitigated by selling a portion risk to another financial institution","summary":"Creates a risk share transfer for a facility","tags":["CORPORATE"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"facilityId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"productId":"string","effectiveDate":"2024-01-01","extensions":{},"shareTransfer":[{}]}},"responses":{"200":"createFacilityRiskShareTransferResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"POST","path":"/holdings/creditAgreements/facilities/drawings/{drawingId}/riskShareTransfers","fullPath":"/api/v7.3.0/holdings/creditAgreements/facilities/drawings/{drawingId}/riskShareTransfers","operationId":"createDrawingRiskShareTransfer","name":"Creates a risk share transfer for a drawing under a facility when participant details are passed. The risk of the own bank in a loan is mitigated by selling a portion risk to another financial institution","summary":"Creates a risk share transfer for a drawing","tags":["CORPORATE"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"drawingId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"productId":"string","effectiveDate":"2024-01-01","extensions":{},"shareTransfer":[{}]}},"responses":{"200":"createDrawingRiskShareTransferResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"POST","path":"/holdings/creditAgreements/guarantees/{guaranteeId}/guaranteeIncreases","fullPath":"/api/v7.3.0/holdings/creditAgreements/guarantees/{guaranteeId}/guaranteeIncreases","operationId":"updateGuaranteeCommitmentIncrease","name":"Increase the commitment amount of the guarantee that the financial institution has issued on behalf of the applicant","summary":"Increase the commitment amount of the guarantee","tags":["CORPORATE"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"guaranteeId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"productId":"string","effectiveDate":"2024-01-01","extensions":{},"gteecommitment":[{}]}},"responses":{"200":"updateGuaranteeCommitmentIncreaseResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"POST","path":"/holdings/creditAgreements/guarantees/{guaranteeId}/guaranteeDecreases","fullPath":"/api/v7.3.0/holdings/creditAgreements/guarantees/{guaranteeId}/guaranteeDecreases","operationId":"updateGuaranteeCommitmentDecrease","name":"Decrease the commitment amount of the guarantee that the financial institution has issued on behalf of the applicant","summary":"Decrease the commitment amount of the guarantee","tags":["CORPORATE"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"guaranteeId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"productId":"string","effectiveDate":"2024-01-01","extensions":{},"gteecommitment":[{}]}},"responses":{"200":"updateGuaranteeCommitmentDecreaseResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"POST","path":"/holdings/creditAgreements/guarantees","fullPath":"/api/v7.3.0/holdings/creditAgreements/guarantees","operationId":"createCreditAgreementGuarantee","name":"Register the issuance of a new guarantee undertaking on behalf of the applicant when all the basic details relevant to the undertaking are passed","summary":"Register the issuance of a guarantee","tags":["CORPORATE"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"customers":[{}],"productId":"string","currency":"string","effectiveDate":"2024-01-01","facilityId":"string","extensions":{},"gteecommitment":[{}],"newarrfee":[{}],"settlement":[{}],"termsConditions":[{}]}},"responses":{"200":"createCreditAgreementGuaranteeResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"POST","path":"/holdings/creditAgreements/guarantees/clubGuarantees","fullPath":"/api/v7.3.0/holdings/creditAgreements/guarantees/clubGuarantees","operationId":"createClubGuarantee","name":"Create a club guarantee with guarantee details along with the details of participating lenders","summary":"Create a club guarantee","tags":["CORPORATE"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"customers":[{}],"productId":"string","currency":"string","effectiveDate":"2024-01-01","facilityId":"string","extensions":{},"account":[{}],"gteecommitment":[{}],"newarrfee":[{}],"settlement":[{}],"termsConditions":[{}],"participant":[{}]}},"responses":{"200":"createClubGuaranteeResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"POST","path":"/holdings/creditAgreements/guarantees/{guaranteeId}/cancellations","fullPath":"/api/v7.3.0/holdings/creditAgreements/guarantees/{guaranteeId}/cancellations","operationId":"cancelCorporateGuarantee","name":"Cancel a guarantee arrangement before its expiry date. All the accrued fees are made-due for collection and the bank is discharged of its liability.","summary":"Cancel a guarantee arrangement before the expiry date.","tags":["CORPORATE"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"guaranteeId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"productId":"string","effectiveDate":"2024-01-01","extensions":{},"settlement":[{}]}},"responses":{"200":"cancelCorporateGuaranteeResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"POST","path":"/holdings/creditAgreements/deals","fullPath":"/api/v7.3.0/holdings/creditAgreements/deals","operationId":"createDeals","name":"Create a new deal for the customer with the details like product, term and amount . Corporate deal is a credit agreement between two parties- the lender and the borrower, who agree to certain terms and conditions along with their rights and obligations","summary":"Creates corporate deal","tags":["CORPORATE"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"customers":[{}],"productId":"string","currency":"string","effectiveDate":"2024-01-01","extensions":{},"settlement":[{}],"facilityRules":[{}],"dacommitment":[{}],"adminfee":[{}],"coordinationfee":[{}],"upfrontfee":[{}],"limit":[{}]}},"responses":{"200":"createDealsResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"POST","path":"/holdings/creditAgreements/loanTrades/trades","fullPath":"/api/v7.3.0/holdings/creditAgreements/loanTrades/trades","operationId":"createTrade","name":"Create a trade for a syndicated loan as initially agreed upon between counterparties.","summary":"Create a trade for a syndicated loan.","tags":["CORPORATE"],"parameters":[{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"counterPartyDetails":[{}],"dealCustomerDetails":[{}],"dealAdditionalInfo":[{}],"ssi":[{}],"ownBankDetails":[{}],"agentBankDetails":[{}],"consentDetails":[{}],"chargeDetails":[{}],"tradeAccountDetails":[{}],"tradeActivity":"string","alternateId":"string","tradeProduct":"string","tradeDate":"string","tradeCurrency":"string","transferType":"string"}},"responses":{"200":"TradeResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"POST","path":"/holdings/creditAgreements/loanTrades/{loanTradeId}/confirmationTrade","fullPath":"/api/v7.3.0/holdings/creditAgreements/loanTrades/{loanTradeId}/confirmationTrade","operationId":"acceptTrade","name":"Confirm the trade when all the parties involved agreed the terms and conditions of the trade.","summary":"Confirm the trade","tags":["CORPORATE"],"parameters":[{"name":"loanTradeId","in":"path","type":"string","required":true,"description":""},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"dealCustomerDetails":[{}],"dealAdditionalinfos":[{}],"dealReference":"string","dealTitle":"string","currency":"string","globalAmount":"string","startDate":"string","agentBank":"string","agentId":"string","agentName":"string","extensions":{}}},"responses":{"200":"TradeResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"POST","path":"/holdings/creditAgreements/loanTrades/{loanTradeId}","fullPath":"/api/v7.3.0/holdings/creditAgreements/loanTrades/{loanTradeId}","operationId":"updateTrade","name":"Update additional details in trade.","summary":"Update trade details","tags":["CORPORATE"],"parameters":[{"name":"loanTradeId","in":"path","type":"string","required":true,"description":""},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"dealCustomerDetails":[{}],"dealAdditionalInfo":[{}],"ssi":[{}],"ownBankDetails":[{}],"agentBankDetails":[{}],"chargeDetails":[{}],"tradeAccountDetails":[{}],"alternateId":"string","transferType":"string","expectedSettlementDate":"string","tradeNotes":"string","businessDayCentre":"string","dealReference":"string","dealTitle":"string","currency":"string"}},"responses":{"200":"TradeResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"POST","path":"/holdings/creditAgreements/loanTrades/{loanTradeId}/consents","fullPath":"/api/v7.3.0/holdings/creditAgreements/loanTrades/{loanTradeId}/consents","operationId":"updateConsent","name":"Update borrower consent for trade","summary":"Update consent status if borrower has agreed or rejected trade.","tags":["CORPORATE"],"parameters":[{"name":"loanTradeId","in":"path","type":"string","required":true,"description":""},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"consentDetails":[{}],"chargeDetails":[{}],"tradeStatus":"string","extensions":{}}},"responses":{"200":"ConsentResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"POST","path":"/holdings/creditAgreements/loanTrades/{loanTradeId}/commitments","fullPath":"/api/v7.3.0/holdings/creditAgreements/loanTrades/{loanTradeId}/commitments","operationId":"updateCommitment","name":"Update the trade due to changes in commitment amount being traded.","summary":"Update commitment details","tags":["CORPORATE"],"parameters":[{"name":"loanTradeId","in":"path","type":"string","required":true,"description":""},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"chargeDetails":[{}],"tradeAccountDetails":[{}],"amount":"string","expectedSettlementDate":"string","actualSettlementDate":"string","tradePrice":"string","settlementMethod":"string","allowNetback":"string","allowBoCR":"string","extensions":{}}},"responses":{"200":"CommitmentResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"POST","path":"/holdings/creditAgreements/loanTrades/{loanTradeId}/acceptances","fullPath":"/api/v7.3.0/holdings/creditAgreements/loanTrades/{loanTradeId}/acceptances","operationId":"approveTrade","name":"Finalize the trade to verify all necessary details are available.","summary":"Finalize the trade to issue pricing letter.","tags":["CORPORATE"],"parameters":[{"name":"loanTradeId","in":"path","type":"string","required":true,"description":""},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"dealCustomerDetails":[{}],"dealAdditionalInfo":[{}],"ssi":[{}],"ownBankDetails":[{}],"agentBankDetails":[{}],"tradeNotes":"string","dealReference":"string","dealTitle":"string","currency":"string","globalAmount":"string","startDate":"string","agentBank":"string","agentId":"string","agentName":"string","extensions":{}}},"responses":{"200":"TradeResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"POST","path":"/holdings/creditAgreements/loanTrades/{loanTradeId}/messages","fullPath":"/api/v7.3.0/holdings/creditAgreements/loanTrades/{loanTradeId}/messages","operationId":"showPricingLetter","name":"Issue pricing letter to the counter party for a final settlement amount.","summary":"Issue pricing letter to counterparty.","tags":["CORPORATE"],"parameters":[{"name":"loanTradeId","in":"path","type":"string","required":true,"description":""},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"extensions":{}}},"responses":{"200":"PricingLetterResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"POST","path":"/holdings/creditAgreements/loanTrades/{loanTradeId}/settlements","fullPath":"/api/v7.3.0/holdings/creditAgreements/loanTrades/{loanTradeId}/settlements","operationId":"calculateTrade","name":"Settle the trade in bank books.","summary":"Settle trade.","tags":["CORPORATE"],"parameters":[{"name":"loanTradeId","in":"path","type":"string","required":true,"description":""},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"issuePricing":"string","tradeNotes":"string","extensions":{}}},"responses":{"200":"TradeResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"POST","path":"/holdings/creditAgreements/loanTrades/{loanTradeId}/cancellations","fullPath":"/api/v7.3.0/holdings/creditAgreements/loanTrades/{loanTradeId}/cancellations","operationId":"cancelTrade","name":"Cancel the trade in bank books.","summary":"Cancel trade.","tags":["CORPORATE"],"parameters":[{"name":"loanTradeId","in":"path","type":"string","required":true,"description":""},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"tradeNotes":"string","extensions":{}}},"responses":{"200":"TradeResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/holdings/creditAgreements/loanTrades/{loanTradeId}/charges","fullPath":"/api/v7.3.0/holdings/creditAgreements/loanTrades/{loanTradeId}/charges","operationId":"getCharges","name":"View all the charge details for a given trade.","summary":"View charges.","tags":["CORPORATE"],"parameters":[{"name":"loanTradeId","in":"path","type":"string","required":true,"description":""},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"ChargesResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"PUT","path":"/holdings/creditAgreements/loanTrades/{loanTradeId}/charges","fullPath":"/api/v7.3.0/holdings/creditAgreements/loanTrades/{loanTradeId}/charges","operationId":"updateCharges","name":"Amend charges already authorized in the trade","summary":"Amend charges.","tags":["CORPORATE"],"parameters":[{"name":"loanTradeId","in":"path","type":"string","required":true,"description":""},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"chargeDetails":[{}],"extensions":{}}},"responses":{"200":"ChargesResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/holdings/creditAgreements/loanTrades/products","fullPath":"/api/v7.3.0/holdings/creditAgreements/loanTrades/products","operationId":"getTradeProducts","name":"View all the trade products","summary":"View trade products","tags":["CORPORATE"],"parameters":[{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"TradeProductsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"PUT","path":"/holdings/creditAgreements/facilities/{facilityId}/coordinationFees","fullPath":"/api/v7.3.0/holdings/creditAgreements/facilities/{facilityId}/coordinationFees","operationId":"updateFacilityCoordinationFees","name":"Updating coordination fees to pay the fee to its participants in facility","summary":"Updating coordination fees to pay the fee to its participants in facility","tags":["CORPORATE"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"facilityId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"productId":"string","effectiveDate":"2024-01-01","extensions":{},"coordinationfee":[{}]}},"responses":{"200":"updateFacilityCoordinationFeesResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"PUT","path":"/holdings/creditAgreements/facilities/{facilityId}/upfrontFees","fullPath":"/api/v7.3.0/holdings/creditAgreements/facilities/{facilityId}/upfrontFees","operationId":"updateFacilityUpfrontFees","name":"Updating the upfront fee which is collect one time by bank","summary":"Updating the upfront fee which is collect one time by bank","tags":["CORPORATE"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"facilityId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"productId":"string","effectiveDate":"2024-01-01","extensions":{},"upfrontfee":[{}]}},"responses":{"200":"updateFacilityUpfrontFeesResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"PUT","path":"/holdings/creditAgreements/facilities/{facilityId}/drawdowns/rules","fullPath":"/api/v7.3.0/holdings/creditAgreements/facilities/{facilityId}/drawdowns/rules","operationId":"UpdateFacilityDrawingRules","name":"Initiating drawing rules to restrict customer, currency and products for drawdown under facility level.","summary":"Initiating drawing rules to restrict customer, currency and products for drawdown under facility level.","tags":["CORPORATE"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"facilityId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"productId":"string","effectiveDate":"2024-01-01","extensions":{},"drawingRules":[{}]}},"responses":{"200":"UpdateFacilityDrawingRulesResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"PUT","path":"/holdings/creditAgreements/facilities/{facilityId}/drawdowns/conditions","fullPath":"/api/v7.3.0/holdings/creditAgreements/facilities/{facilityId}/drawdowns/conditions","operationId":"updateFacilityDrawingConditions","name":"Initiating drawing condition to restrict customer, currency and products for drawdown with overrides.","summary":"Initiating drawing condition to restrict customer, currency and products for drawdown with overrides.","tags":["CORPORATE"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"facilityId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"productId":"string","effectiveDate":"2024-01-01","extensions":{},"drawingConditions":[{}]}},"responses":{"200":"updateFacilityDrawingConditionsResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"PUT","path":"/holdings/creditAgreements/deals/{dealId}/commitmentIncreases","fullPath":"/api/v7.3.0/holdings/creditAgreements/deals/{dealId}/commitmentIncreases","operationId":"createDealCommitmentIncreases","name":"Increase the commitment amount of the existing deal arrangement.","summary":"Increase the commitment amount of the existing deal arrangement.","tags":["CORPORATE"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"dealId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"effectiveDate":"2024-01-01","activityId":"string","externalEventStatus":"string","extensions":{},"dacommitment":[{}]}},"responses":{"200":"createDealCommitmentIncreasesResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"PUT","path":"/holdings/creditAgreements/deals/{dealId}/commitmentDecreases","fullPath":"/api/v7.3.0/holdings/creditAgreements/deals/{dealId}/commitmentDecreases","operationId":"createDealCommitmentDecreases","name":"The commitment amount of the existing deal arrangement can be decreased","summary":"The commitment amount of the existing deal arrangement can be decreased","tags":["CORPORATE"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"dealId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"effectiveDate":"2024-01-01","activityId":"string","externalEventStatus":"string","extensions":{},"dacommitment":[{}]}},"responses":{"200":"createDealCommitmentDecreasesResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"PUT","path":"/holdings/creditAgreements/deals/{dealId}/blockcommitmentandTerm","fullPath":"/api/v7.3.0/holdings/creditAgreements/deals/{dealId}/blockcommitmentandTerm","operationId":"UpdateBlockcommitmentandTerm","name":"Block the commitment and term of the existing deal arrangement.","summary":"Block the commitment and term of the existing deal arrangement.","tags":["CORPORATE"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"dealId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"parties":[{}],"activityId":"string","effectiveDate":"string","productId":"string","currencyId":"string","simulationId":"string","extensions":{}}},"responses":{"200":"UpdateBlockcommitmentandTermResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"PUT","path":"/holdings/creditAgreements/deals/{dealId}/unblockCommitmentTerm","fullPath":"/api/v7.3.0/holdings/creditAgreements/deals/{dealId}/unblockCommitmentTerm","operationId":"UpdateUnblockcommitmentandTerm","name":"Unblock the commitment and term of the existing deal arrangement.","summary":"Unblock the commitment and term of the existing deal arrangement.","tags":["CORPORATE"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"dealId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"parties":[{}],"activityId":"string","effectiveDate":"string","productId":"string","currencyId":"string","simulationId":"string","extensions":{}}},"responses":{"200":"UpdateUnblockcommitmentandTermResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"PUT","path":"/holdings/creditAgreements/deals/{dealId}/commitmentTerms","fullPath":"/api/v7.3.0/holdings/creditAgreements/deals/{dealId}/commitmentTerms","operationId":"updateDealCommitmentTerms","name":"Update tenure by increasing or decreasing the term in deal level","summary":"Update tenure by increasing or decreasing the term in deal level","tags":["CORPORATE"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"dealId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"productId":"string","effectiveDate":"2024-01-01","extensions":{},"dacommitment":[{}]}},"responses":{"200":"updateDealCommitmentTermsResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"PUT","path":"/holdings/creditAgreements/drawings/{drawingsId}/rolloverType","fullPath":"/api/v7.3.0/holdings/creditAgreements/drawings/{drawingsId}/rolloverType","operationId":"createDrawingsRollovers","name":"Splits/Merge/Rollover in Drawings level","summary":"Splits/Merge/Rollover a drawings into many drawings","tags":["CORPORATE"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"drawingsId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"parties":[{}],"activityId":"string","effectiveDate":"string","productId":"string","currencyId":"string","simulationId":"string","extensions":{},"splitsMerges":[{}]}},"responses":{"200":"createDrawingsRolloversResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"PUT","path":"/holdings/creditAgreements/facilities/{facilityId}/drawdowns/subLimits","fullPath":"/api/v7.3.0/holdings/creditAgreements/facilities/{facilityId}/drawdowns/subLimits","operationId":"updateSubLimits","name":"Update sub limits based on the risk criterion","summary":"Update sub limits based on the risk criterion","tags":["CORPORATE"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"facilityId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"productId":"string","effectiveDate":"2024-01-01","extensions":{},"sublimits":[{}]}},"responses":{"200":"updateSubLimitsResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}}]},{"key":"holdings-creditAgreements-api-service-v7.4.0","title":"Corporate Credit Agreements","version":"v7.4.0","description":"API for the creation and management of credit agreements for corporate customers. The types of credit agreements are single level facility, credit agreement with multiple facilities, club loans with agency and syndicated loans","endpointCount":83,"endpoints":[{"method":"POST","path":"/holdings/creditAgreements/deals/offers","fullPath":"/api/v7.4.0/holdings/creditAgreements/deals/offers","operationId":"createDealOffer","name":"Creates new offer deal for the required customer when the mandatory input details are provided. Offer deal creates a draft contract and allows the users to negotiate multiple times. Offer deal is a draft contract and will not affect the balance sheet of the bank.","summary":"Creates an offer for a deal contract","tags":["CORPORATE"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"customers":[{}],"productId":"string","currency":"string","effectiveDate":"2024-01-01","activity":"string","extensions":{},"facilityRules":[{}],"dacommitment":[{}],"adminfee":[{}],"coordinationfee":[{}],"upfrontfee":[{}],"limit":[{}]}},"responses":{"200":"createDealOfferResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"POST","path":"/holdings/creditAgreements/facilities/offers","fullPath":"/api/v7.4.0/holdings/creditAgreements/facilities/offers","operationId":"createFacilityOffer","name":"Creates a new offer facility for the required customer when at least the mandatory input is provided. Offer facility creates a draft contract and allow the users to negotiate multiple times. Offer facility is a draft contract and will not affect the balance sheet of the bank.","summary":"Creates an offer for a facility contract","tags":["CORPORATE"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"customers":[{}],"productId":"string","currency":"string","dealId":"string","effectiveDate":"2024-01-01","activity":"string","extensions":{},"settlement":[{}],"facommitment":[{}],"upfrontfee":[{}],"coordinationfee":[{}],"limit":[{}]}},"responses":{"200":"createFacilityOfferResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"POST","path":"/holdings/creditAgreements/deals/offers/cancellations/{arrangementId}","fullPath":"/api/v7.4.0/holdings/creditAgreements/deals/offers/cancellations/{arrangementId}","operationId":"deleteDealOffer","name":"Deletes a new offer for the required deal contract when at least the mandatory input is provided. Deal offer is a draft contract, which allow the user to delete the contract online and deal offer contract will not affect the balance sheet of the bank.","summary":"Deletes an offer for a deal contract","tags":["CORPORATE"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"arrangementId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"productId":"string","effectiveDate":"2024-01-01","extensions":{}}},"responses":{"200":"deleteDealOfferResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"POST","path":"/holdings/creditAgreements/facilities/offers/cancellations/{arrangementId}","fullPath":"/api/v7.4.0/holdings/creditAgreements/facilities/offers/cancellations/{arrangementId}","operationId":"deleteFacilityOffer","name":"Deletes a new offer for the required facility contract when at least the mandatory input is provided. Facility offer is a draft contract, which allow the user to delete the contract online and facility offer contract will not affect the balance sheet of the bank.","summary":"Deletes an offer for a facility contract","tags":["CORPORATE"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"arrangementId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"productId":"string","effectiveDate":"2024-01-01","extensions":{}}},"responses":{"200":"deleteFacilityOfferResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"POST","path":"/holdings/creditAgreements/deals/offers/acceptances/{arrangementId}","fullPath":"/api/v7.4.0/holdings/creditAgreements/deals/offers/acceptances/{arrangementId}","operationId":"acceptDealOffer","name":"On executing acceptance, the contract is changed from offer to live deal for the required customer when at least the mandatory input is provided. Process will check all the required mandatory inputs and prompt an error message when mandatory details are not provided. Once the accept deal offer is processed further offer negotiation is not allowed.","summary":"Accept the deal offer and execute the contract to live","tags":["CORPORATE"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"arrangementId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"productId":"string","effectiveDate":"2024-01-01","extensions":{},"settlement":[{}],"facilityRules":[{}],"dacommitment":[{}],"adminfee":[{}],"coordinationfee":[{}],"upfrontfee":[{}],"limit":[{}]}},"responses":{"200":"acceptDealOfferResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"POST","path":"/holdings/creditAgreements/facilities/offers/acceptances/{arrangementId}","fullPath":"/api/v7.4.0/holdings/creditAgreements/facilities/offers/acceptances/{arrangementId}","operationId":"acceptFacilityOffer","name":"On executing acceptance, the contract is changed from offer to live facility for the required customer when at least the mandatory input is provided. Process will check all the required mandatory inputs and prompt an error message when mandatory details are not provided. Once the accept deal offer is processed further offer negotiation is not allowed.","summary":"Accept the facility offer and execute the contract to live","tags":["CORPORATE"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"arrangementId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"productId":"string","effectiveDate":"2024-01-01","extensions":{},"settlement":[{}],"facommitment":[{}],"upfrontfee":[{}],"coordinationfee":[{}],"limit":[{}]}},"responses":{"200":"acceptFacilityOfferResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"POST","path":"/holdings/creditAgreements/drawdowns/offers","fullPath":"/api/v7.4.0/holdings/creditAgreements/drawdowns/offers","operationId":"createDrawdownOffer","name":"Creates a new drawdown offer for the required customer. ","summary":"Creates a new drawdown offer for the required customer. ","tags":["CORPORATE"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"customers":[{}],"productId":"string","currency":"string","facilityId":"string","offerDate":"2024-01-01","drawdownDate":"2024-01-01","activity":"string","extensions":{},"maintenancefee":[{}],"dwcommitment":[{}],"settlement":[{}]}},"responses":{"200":"createDrawdownOfferResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"POST","path":"/holdings/creditAgreements/drawdowns/offers/negotiations","fullPath":"/api/v7.4.0/holdings/creditAgreements/drawdowns/offers/negotiations","operationId":"createOfferDrawdownRenegotiation","name":"Renegotiate the offer drawdown for the required customer.","summary":"Renegotiate the offer drawdown for the required customer.","tags":["CORPORATE"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"productId":"string","drawdownDate":"2024-01-01","extensions":{},"maintenancefee":[{}],"settlement":[{}]}},"responses":{"200":"createOfferDrawdownRenegotiationResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"POST","path":"/holdings/creditAgreements/drawdowns/offers/cancellations","fullPath":"/api/v7.4.0/holdings/creditAgreements/drawdowns/offers/cancellations","operationId":"deleteDrawdownOffer","name":"Cancellation of offer drawdown for the required customer.","summary":"Cancellation of offer drawdown for the required customer.","tags":["CORPORATE"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"productId":"string","drawdownDate":"2024-01-01","extensions":{}}},"responses":{"200":"deleteDrawdownOfferResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"POST","path":"/holdings/creditAgreements/drawdowns/offers/acceptances","fullPath":"/api/v7.4.0/holdings/creditAgreements/drawdowns/offers/acceptances","operationId":"acceptOfferDrawdown","name":"Convert an offer drawdown to a live drawdown for the required customer.","summary":"Convert an offer drawdown to a live drawdown for the required customer.","tags":["CORPORATE"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"productId":"string","drawdownDate":"2024-01-01","extensions":{},"maintenancefee":[{}],"dwcommitment":[{}],"settlement":[{}]}},"responses":{"200":"acceptOfferDrawdownResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"GET","path":"/holdings/creditAgreements/facilities/{facilityId}/drawingProducts","fullPath":"/api/v7.4.0/holdings/creditAgreements/facilities/{facilityId}/drawingProducts","operationId":"getFacilityDrawingProducts","name":"Retrieves the available drawing products under the facility ","summary":"Retrieves the available drawing products under the facility ","tags":["CORPORATE"],"parameters":[{"name":"facilityId","in":"path","type":"string","required":true,"description":"Unique identifier (contract number) of the facility"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"FacilityDrawingProductsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/creditAgreements/facilities/{facilityId}/combinedSchedules","fullPath":"/api/v7.4.0/holdings/creditAgreements/facilities/{facilityId}/combinedSchedules","operationId":"getCombinedSchedules","name":"Retrieves the payment schedule of facility and its drawings","summary":"Retrieves the payment schedule of facility and its drawings","tags":["CORPORATE"],"parameters":[{"name":"facilityId","in":"path","type":"string","required":true,"description":"Unique identifier (contract number) of the facility"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"CombinedSchedulesResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"POST","path":"/holdings/creditAgreements/facilities","fullPath":"/api/v7.4.0/holdings/creditAgreements/facilities","operationId":"createFacilities","name":"Creates corporate facilities","summary":"Creates corporate facilities","tags":["CORPORATE"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"customers":[{}],"productId":"string","currency":"string","effectiveDate":"2024-01-01","dealId":"string","extensions":{},"settlement":[{}],"facommitment":[{}],"upfrontfee":[{}],"coordinationfee":[{}],"limit":[{}]}},"responses":{"200":"createFacilitiesResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"POST","path":"/holdings/creditAgreements/drawdowns","fullPath":"/api/v7.4.0/holdings/creditAgreements/drawdowns","operationId":"createDrawdowns","name":"Creates drawdowns under facility","summary":"Creates drawdowns under facility","tags":["CORPORATE"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"customers":[{}],"arrangmentId":"string","currency":"string","facilityId":"string","effectiveDate":"string","activity":"string","productId":"string","extensions":{},"escrow":[{}],"dwcommitment":[{}],"settlement":[{}]}},"responses":{"200":"createDrawdownsResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"GET","path":"/holdings/creditAgreements/facilities/{facilityId}/drawingRules","fullPath":"/api/v7.4.0/holdings/creditAgreements/facilities/{facilityId}/drawingRules","operationId":"getFacilityDrawingRules","name":"Retrieves the allowed customers, currencies and products for a new drawing under the facility","summary":"Retrieves the allowed customers, currencies and products for a new drawing under the facility","tags":["CORPORATE"],"parameters":[{"name":"facilityId","in":"path","type":"string","required":true,"description":"Unique identifier (contract number) of the facility"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"FacilityDrawingRulesResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/creditAgreements/facilities/{facilityId}/drawings","fullPath":"/api/v7.4.0/holdings/creditAgreements/facilities/{facilityId}/drawings","operationId":"getDrawingsUnderFacility","name":"Retrieves the drawings under a facility","summary":"Retrieves the drawings under a facility","tags":["CORPORATE"],"parameters":[{"name":"facilityId","in":"path","type":"string","required":true,"description":"Unique identifier (contract number) of the facility"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"DrawingsUnderFacilityResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/creditAgreements/facilities/drawings/{drawingId}/parentFacilities","fullPath":"/api/v7.4.0/holdings/creditAgreements/facilities/drawings/{drawingId}/parentFacilities","operationId":"getDrawingFacility","name":"Retrieves the parent facility for a drawing","summary":"Retrieves the parent facility for a drawing","tags":["CORPORATE"],"parameters":[{"name":"drawingId","in":"path","type":"string","required":true,"description":"Identifier of drawings application under the Letter of Credit system that is used to effect the transfer of funds and the acceptance of documents under Letters of Credit and Documentary Collection tra"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"DrawingFacilityResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/creditAgreements/facilities/{facilityId}/commitmentSchedules","fullPath":"/api/v7.4.0/holdings/creditAgreements/facilities/{facilityId}/commitmentSchedules","operationId":"getFacilityCommitmentSchedule","name":"Retrieves the commitment schedule of a facility","summary":"Retrieves the commitment schedule of a facility","tags":["CORPORATE"],"parameters":[{"name":"facilityId","in":"path","type":"string","required":true,"description":"Unique identifier (contract number) of the facility"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"FacilityCommitmentScheduleResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/creditAgreements/facilities/{facilityId}/parentDeals","fullPath":"/api/v7.4.0/holdings/creditAgreements/facilities/{facilityId}/parentDeals","operationId":"getFacilityDeal","name":"Retrieves the parent deal for a facility","summary":"Retrieves the parent deal for a facility","tags":["CORPORATE"],"parameters":[{"name":"facilityId","in":"path","type":"string","required":true,"description":"Unique identifier (contract number) of the facility"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"FacilityDealResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/creditAgreements/facilities/{facilityId}/balances","fullPath":"/api/v7.4.0/holdings/creditAgreements/facilities/{facilityId}/balances","operationId":"getFacilityFinancialSummary","name":"Retrieves the financial summary for a facility arrangement","summary":"Retrieves the financial summary for a facility arrangement","tags":["CORPORATE"],"parameters":[{"name":"facilityId","in":"path","type":"string","required":true,"description":"Unique identifier (contract number) of the facility"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"FacilityFinancialSummaryResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/creditAgreements/facilities/{facilityId}/consolidatedBalances","fullPath":"/api/v7.4.0/holdings/creditAgreements/facilities/{facilityId}/consolidatedBalances","operationId":"getFacilityConsolidatedBalances","name":"Retrieves the consolidated balances for a facility arrangement","summary":"Retrieves the consolidated balances for a facility arrangement","tags":["CORPORATE"],"parameters":[{"name":"facilityId","in":"path","type":"string","required":true,"description":"Unique identifier (contract number) of the facility"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"FacilityConsolidatedBalancesResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"POST","path":"/holdings/creditAgreements/facilities/directDebits","fullPath":"/api/v7.4.0/holdings/creditAgreements/facilities/directDebits","operationId":"createFacilityDirectDebitLink","name":"Links a direct debit to an existing facility","summary":"Links a direct debit to a facility","tags":["CORPORATE"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"customers":[{}],"arrangement":"string","productId":"string","currency":"string","effectiveDate":"2024-01-01","extensions":{},"settlement":[{}]}},"responses":{"200":"createFacilityDirectDebitLinkResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"POST","path":"/holdings/creditAgreements/facilities/drawings/directDebits","fullPath":"/api/v7.4.0/holdings/creditAgreements/facilities/drawings/directDebits","operationId":"createDrawingDirectDebitLink","name":"Link the direct debit to an existing drawing under a facility","summary":"Links a direct debit to a drawing","tags":["CORPORATE"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"customers":[{}],"arrangement":"string","currency":"string","facilityId":"string","effectiveDate":"string","productId":"string","extensions":{},"settlement":[{}]}},"responses":{"200":"createDrawingDirectDebitLinkResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"POST","path":"/holdings/creditAgreements/facilities/rollovers/offers","fullPath":"/api/v7.4.0/holdings/creditAgreements/facilities/rollovers/offers","operationId":"createFacilityRolloverOffer","name":"Create rollover process from the facility where the rollover could be a split rollover, merge rollover or a one to one rollover. Split also called as one to many will rollover an old loan and create multiple new offer loans. Merge also called as many to one will rollover multiple old loans simultaneously and create a single new offer loan. Rollover also called as one to one will simply rollover an old loan and create a new offer loan","summary":"Create rollover offer from facility","tags":["CORPORATE"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"arrangement":"string","rolloverDate":"string","productId":"string","extensions":{},"splitsMerges":[{}]}},"responses":{"200":"createFacilityRolloverOfferResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"POST","path":"/holdings/creditAgreements/drawdowns/rollovers/offers","fullPath":"/api/v7.4.0/holdings/creditAgreements/drawdowns/rollovers/offers","operationId":"createDrawdownRolloverOffer","name":"Create rollover process from the drawdown where the rollover could be a split rollover, merge rollover or a one to one rollover. Split also called as one to many will rollover an old loan and create multiple new offer loans. Merge also called as many to one will rollover multiple old loans simultaneously and create a single new offer loan. Rollover also called as one to one will simply rollover an old loan and create a new offer loan","summary":"Create rollover offer from drawdown","tags":["CORPORATE"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"arrangement":"string","rolloverDate":"string","productId":"string","extensions":{},"splitsMerges":[{}]}},"responses":{"200":"createDrawdownRolloverOfferResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"POST","path":"/holdings/creditAgreements/facilities/commitmentIncreases/{arrangementId}","fullPath":"/api/v7.4.0/holdings/creditAgreements/facilities/commitmentIncreases/{arrangementId}","operationId":"updateFacilityCommitmentIncrease","name":"Increase the facility amount to facilitate further drawdowns","summary":"Increase facility amount","tags":["CORPORATE"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"arrangementId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"productId":"string","effectiveDate":"2024-01-01","extensions":{},"facommitment":[{}]}},"responses":{"200":"updateFacilityCommitmentIncreaseResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"POST","path":"/holdings/creditAgreements/facilities/commitmentTerms/{arrangementId}","fullPath":"/api/v7.4.0/holdings/creditAgreements/facilities/commitmentTerms/{arrangementId}","operationId":"updateFacilityCommitmentTerms","name":"Updates facility tenure by increasing or decreasing the term, in addition it allows the amendment of the availability schedule of the contract.","summary":"Update facility maturity date and availability","tags":["CORPORATE"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"arrangementId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"productId":"string","effectiveDate":"2024-01-01","extensions":{},"facommitment":[{}]}},"responses":{"200":"updateFacilityCommitmentTermsResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"GET","path":"/holdings/customers/{customerId}/creditAgreements/exposures","fullPath":"/api/v7.4.0/holdings/customers/{customerId}/creditAgreements/exposures","operationId":"getCustomerExposure","name":"Retrieves the customer exposure such as the facility number, type of facility, maturity date and various amounts of the facilities/standalone loans.","summary":"Retrieves the customer exposure for facilities and loans","tags":["CORPORATE"],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"Identifier of the customer"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"CustomerExposureResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/customers/{customerId}/creditAgreements/drawings","fullPath":"/api/v7.4.0/holdings/customers/{customerId}/creditAgreements/drawings","operationId":"getCustomerDrawings","name":"Retrieves the details such as the drawing id, account number, short description of the loan, customer name and loan status for a customer. ","summary":"Retrieves the drawing details for a customer.","tags":["CORPORATE"],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":""},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"CustomerDrawingsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/customers/{customerId}/creditAgreements/facilities","fullPath":"/api/v7.4.0/holdings/customers/{customerId}/creditAgreements/facilities","operationId":"getCustomerFacilities","name":"Retrieves the details such as the facility id, account number, short description of the facility, customer name and facility status for a customer.","summary":"Retrieves the facility details for a customer.","tags":["CORPORATE"],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"Identifier of the customer"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"CustomerFacilitiesResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/customers/{customerId}/creditAgreements/deals","fullPath":"/api/v7.4.0/holdings/customers/{customerId}/creditAgreements/deals","operationId":"getCustomerDeals","name":"Retrieves the details such as the deal id, account number, short description of the facility, customer name and deal status for a customer.","summary":"Retrieves the deal details for a customer.","tags":["CORPORATE"],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"Identifier of the customer"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"CustomerDealsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/creditAgreements/deals/{dealId}/facilities","fullPath":"/api/v7.4.0/holdings/creditAgreements/deals/{dealId}/facilities","operationId":"getFacilitiesUnderDeal","name":"Retrieves the details such as facility id, title, currency, status and commitment amount for all the facilities under a deal.","summary":"Retrieves the details of facilities under a deal.","tags":["CORPORATE"],"parameters":[{"name":"dealId","in":"path","type":"string","required":true,"description":"Unique identifier (contract number) of the corporate deals"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"FacilitiesUnderDealResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/creditAgreements/productCatalogues","fullPath":"/api/v7.4.0/holdings/creditAgreements/productCatalogues","operationId":"getCreditAgreementsProductCatalogue","name":"Retrieves the list of available products for credit agreements.","summary":"Retrieves the credit agreements product catalogue.","tags":["CORPORATE"],"parameters":[{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"CreditAgreementsProductCatalogueResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/creditAgreements/drawings/{drawingId}/pendingActivities","fullPath":"/api/v7.4.0/holdings/creditAgreements/drawings/{drawingId}/pendingActivities","operationId":"getPendingActivities","name":"Retrieves the details such as rollover date, rollover status etc of pending drawdowns and rollovers for a drawing.","summary":"Retrieves the details of pending drawdowns and rollovers for a drawing.","tags":["CORPORATE"],"parameters":[{"name":"drawingId","in":"path","type":"string","required":true,"description":"Identifier of drawings application under the Letter of Credit system that is used to effect the transfer of funds and the acceptance of documents under Letters of Credit and Documentary Collection tra"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"PendingActivitiesResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/creditAgreements/drawings/expiries","fullPath":"/api/v7.4.0/holdings/creditAgreements/drawings/expiries","operationId":"getLoansExpiring","name":"Retrieves the drawings expiring in the next 7 days.","summary":"Retrieves expiring drawings.","tags":["CORPORATE"],"parameters":[{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"LoansExpiringResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/creditAgreements/facilities/expiries","fullPath":"/api/v7.4.0/holdings/creditAgreements/facilities/expiries","operationId":"getFacilitiesExpiring","name":"Retrieves the facilities expiring in the next 7 days","summary":"Retrieves expiring facilities","tags":["CORPORATE"],"parameters":[{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"FacilitiesExpiringResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/creditAgreements/drawings/{drawingId}/balances","fullPath":"/api/v7.4.0/holdings/creditAgreements/drawings/{drawingId}/balances","operationId":"getDrawingBalances","name":"Retrieves the balance details such as commitment balances, utilized balances.","summary":"Retrieves drawing balances","tags":["CORPORATE"],"parameters":[{"name":"drawingId","in":"path","type":"string","required":true,"description":"Identifier of drawings application under the Letter of Credit system that is used to effect the transfer of funds and the acceptance of documents under Letters of Credit and Documentary Collection tra"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"DrawingBalancesResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/creditAgreements/drawings/{drawingId}/OverdueBalances","fullPath":"/api/v7.4.0/holdings/creditAgreements/drawings/{drawingId}/OverdueBalances","operationId":"getDrawingOverdueBalances","name":"Retrieves the past dues and overdues for a drawing","summary":"Retrieves drawing overdue balances","tags":["CORPORATE"],"parameters":[{"name":"drawingId","in":"path","type":"string","required":true,"description":"Identifier of drawings application under the Letter of Credit system that is used to effect the transfer of funds and the acceptance of documents under Letters of Credit and Documentary Collection tra"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"DrawingOverdueBalancesResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/creditAgreements/facilities/clubFacilities","fullPath":"/api/v7.4.0/holdings/creditAgreements/facilities/clubFacilities","operationId":"getClubFacilities","name":"Retrieves club facilities, drawings and deal","summary":"Retrieves club facilities, drawings and deal","tags":["CORPORATE"],"parameters":[{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"ClubFacilitiesResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"POST","path":"/holdings/creditAgreements/facilities/clubFacilities","fullPath":"/api/v7.4.0/holdings/creditAgreements/facilities/clubFacilities","operationId":"createClubFacilities","name":"Creates a club facility with facility details along with the details of participating lenders","summary":"Creates a club facility","tags":["CORPORATE"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"customers":[{}],"productId":"string","currency":"string","effectiveDate":"2024-01-01","extensions":{},"account":[{}],"settlement":[{}],"facommitment":[{}],"upfrontfee":[{}],"coordinationfee":[{}],"limit":[{}],"participant":[{}],"riskparticipant":[{}]}},"responses":{"200":"createClubFacilitiesResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"POST","path":"/holdings/creditAgreements/facilities/drawings/clubDrawings","fullPath":"/api/v7.4.0/holdings/creditAgreements/facilities/drawings/clubDrawings","operationId":"createClubDrawings","name":"Creates a club drawing arrangement with drawdown details along with the details of participating lenders","summary":"Creates a club drawing","tags":["CORPORATE"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"customers":[{}],"arrangmentId":"string","currency":"string","facilityId":"string","effectiveDate":"string","activity":"string","productId":"string","extensions":{},"account":[{}],"escrow":[{}],"dwcommitment":[{}],"settlement":[{}],"participant":[{}],"riskparticipant":[{}]}},"responses":{"200":"createClubDrawingsResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"GET","path":"/holdings/creditAgreements/facilities/drawings/{drawingId}/participants","fullPath":"/api/v7.4.0/holdings/creditAgreements/facilities/drawings/{drawingId}/participants","operationId":"getClubDrawingParticipants","name":"Retrieves the participation details of the lending arrangement for a customer. This will be used to view the agent bank and the participant details and the share amounts when an arrangement id is passed as an input.","summary":"Retrieves the participant details","tags":["CORPORATE"],"parameters":[{"name":"drawingId","in":"path","type":"string","required":true,"description":"Identifier of drawings application under the Letter of Credit system that is used to effect the transfer of funds and the acceptance of documents under Letters of Credit and Documentary Collection tra"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"ClubDrawingParticipantsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"POST","path":"/holdings/creditAgreements/facilities/{facilityId}/fundedShareTransfers","fullPath":"/api/v7.4.0/holdings/creditAgreements/facilities/{facilityId}/fundedShareTransfers","operationId":"createFacilityFundedShareTransfer","name":"Creates a funded share transfer for a facility when participant details are passed. Share of a funding participant is transferred to another funding participant in a club facility and underlying drawings","summary":"Creates a funded share transfer for a facility","tags":["CORPORATE"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"facilityId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"productId":"string","effectiveDate":"2024-01-01","extensions":{},"shareTransfer":[{}]}},"responses":{"200":"createFacilityFundedShareTransferResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"POST","path":"/holdings/creditAgreements/facilities/drawings/{drawingId}/fundedShareTransfers","fullPath":"/api/v7.4.0/holdings/creditAgreements/facilities/drawings/{drawingId}/fundedShareTransfers","operationId":"createDrawingFundedShareTransfer","name":"Creates a funded share transfer for a drawing under a facility when participant details are passed. Share of a funding participant is transferred to another funding participant in a standalone club loan","summary":"Creates a funded share transfer for a drawing","tags":["CORPORATE"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"drawingId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"productId":"string","effectiveDate":"2024-01-01","extensions":{},"shareTransfer":[{}]}},"responses":{"200":"createDrawingFundedShareTransferResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"POST","path":"/holdings/creditAgreements/facilities/{facilityId}/riskShareTransfers","fullPath":"/api/v7.4.0/holdings/creditAgreements/facilities/{facilityId}/riskShareTransfers","operationId":"createFacilityRiskShareTransfer","name":"Creates a risk share transfer for a facility when participant details are passed. The risk of the own bank in a facility is mitigated by selling a portion risk to another financial institution","summary":"Creates a risk share transfer for a facility","tags":["CORPORATE"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"facilityId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"productId":"string","effectiveDate":"2024-01-01","extensions":{},"shareTransfer":[{}]}},"responses":{"200":"createFacilityRiskShareTransferResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"POST","path":"/holdings/creditAgreements/facilities/drawings/{drawingId}/riskShareTransfers","fullPath":"/api/v7.4.0/holdings/creditAgreements/facilities/drawings/{drawingId}/riskShareTransfers","operationId":"createDrawingRiskShareTransfer","name":"Creates a risk share transfer for a drawing under a facility when participant details are passed. The risk of the own bank in a loan is mitigated by selling a portion risk to another financial institution","summary":"Creates a risk share transfer for a drawing","tags":["CORPORATE"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"drawingId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"productId":"string","effectiveDate":"2024-01-01","extensions":{},"shareTransfer":[{}]}},"responses":{"200":"createDrawingRiskShareTransferResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"POST","path":"/holdings/creditAgreements/guarantees/{guaranteeId}/guaranteeIncreases","fullPath":"/api/v7.4.0/holdings/creditAgreements/guarantees/{guaranteeId}/guaranteeIncreases","operationId":"updateGuaranteeCommitmentIncrease","name":"Increase the commitment amount of the guarantee that the financial institution has issued on behalf of the applicant","summary":"Increase the commitment amount of the guarantee","tags":["CORPORATE"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"guaranteeId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"productId":"string","effectiveDate":"2024-01-01","extensions":{},"gteecommitment":[{}]}},"responses":{"200":"updateGuaranteeCommitmentIncreaseResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"POST","path":"/holdings/creditAgreements/guarantees/{guaranteeId}/guaranteeDecreases","fullPath":"/api/v7.4.0/holdings/creditAgreements/guarantees/{guaranteeId}/guaranteeDecreases","operationId":"updateGuaranteeCommitmentDecrease","name":"Decrease the commitment amount of the guarantee that the financial institution has issued on behalf of the applicant","summary":"Decrease the commitment amount of the guarantee","tags":["CORPORATE"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"guaranteeId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"productId":"string","effectiveDate":"2024-01-01","extensions":{},"gteecommitment":[{}]}},"responses":{"200":"updateGuaranteeCommitmentDecreaseResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"POST","path":"/holdings/creditAgreements/guarantees","fullPath":"/api/v7.4.0/holdings/creditAgreements/guarantees","operationId":"createCreditAgreementGuarantee","name":"Register the issuance of a new guarantee undertaking on behalf of the applicant when all the basic details relevant to the undertaking are passed","summary":"Register the issuance of a guarantee","tags":["CORPORATE"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"customers":[{}],"productId":"string","currency":"string","effectiveDate":"2024-01-01","facilityId":"string","extensions":{},"gteecommitment":[{}],"newarrfee":[{}],"settlement":[{}],"termsConditions":[{}]}},"responses":{"200":"createCreditAgreementGuaranteeResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"POST","path":"/holdings/creditAgreements/guarantees/clubGuarantees","fullPath":"/api/v7.4.0/holdings/creditAgreements/guarantees/clubGuarantees","operationId":"createClubGuarantee","name":"Create a club guarantee with guarantee details along with the details of participating lenders","summary":"Create a club guarantee","tags":["CORPORATE"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"customers":[{}],"productId":"string","currency":"string","effectiveDate":"2024-01-01","facilityId":"string","extensions":{},"account":[{}],"gteecommitment":[{}],"newarrfee":[{}],"settlement":[{}],"termsConditions":[{}],"participant":[{}]}},"responses":{"200":"createClubGuaranteeResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"POST","path":"/holdings/creditAgreements/guarantees/{guaranteeId}/cancellations","fullPath":"/api/v7.4.0/holdings/creditAgreements/guarantees/{guaranteeId}/cancellations","operationId":"cancelCorporateGuarantee","name":"Cancel a guarantee arrangement before its expiry date. All the accrued fees are made-due for collection and the bank is discharged of its liability.","summary":"Cancel a guarantee arrangement before the expiry date.","tags":["CORPORATE"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"guaranteeId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"productId":"string","effectiveDate":"2024-01-01","extensions":{},"settlement":[{}]}},"responses":{"200":"cancelCorporateGuaranteeResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"POST","path":"/holdings/creditAgreements/deals","fullPath":"/api/v7.4.0/holdings/creditAgreements/deals","operationId":"createDeals","name":"Create a new deal for the customer with the details like product, term and amount . Corporate deal is a credit agreement between two parties- the lender and the borrower, who agree to certain terms and conditions along with their rights and obligations","summary":"Creates corporate deal","tags":["CORPORATE"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"customers":[{}],"productId":"string","currency":"string","effectiveDate":"2024-01-01","extensions":{},"settlement":[{}],"facilityRules":[{}],"dacommitment":[{}],"adminfee":[{}],"coordinationfee":[{}],"upfrontfee":[{}],"limit":[{}]}},"responses":{"200":"createDealsResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"POST","path":"/holdings/creditAgreements/loanTrades/trades","fullPath":"/api/v7.4.0/holdings/creditAgreements/loanTrades/trades","operationId":"createTrade","name":"Create a trade for a syndicated loan as initially agreed upon between counterparties.","summary":"Create a trade for a syndicated loan.","tags":["CORPORATE"],"parameters":[{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"counterPartyDetails":[{}],"dealCustomerDetails":[{}],"dealAdditionalInfo":[{}],"ssi":[{}],"ownBankDetails":[{}],"agentBankDetails":[{}],"consentDetails":[{}],"chargeDetails":[{}],"tradeAccountDetails":[{}],"tradeActivity":"string","alternateId":"string","tradeProduct":"string","tradeDate":"string","tradeCurrency":"string","transferType":"string"}},"responses":{"200":"TradeResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"POST","path":"/holdings/creditAgreements/loanTrades/{loanTradeId}/confirmationTrade","fullPath":"/api/v7.4.0/holdings/creditAgreements/loanTrades/{loanTradeId}/confirmationTrade","operationId":"acceptTrade","name":"Confirm the trade when all the parties involved agreed the terms and conditions of the trade.","summary":"Confirm the trade","tags":["CORPORATE"],"parameters":[{"name":"loanTradeId","in":"path","type":"string","required":true,"description":""},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"dealCustomerDetails":[{}],"dealAdditionalinfos":[{}],"dealReference":"string","dealTitle":"string","currency":"string","globalAmount":"string","startDate":"string","agentBank":"string","agentId":"string","agentName":"string","extensions":{}}},"responses":{"200":"TradeResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"POST","path":"/holdings/creditAgreements/loanTrades/{loanTradeId}","fullPath":"/api/v7.4.0/holdings/creditAgreements/loanTrades/{loanTradeId}","operationId":"updateTrade","name":"Update additional details in trade.","summary":"Update trade details","tags":["CORPORATE"],"parameters":[{"name":"loanTradeId","in":"path","type":"string","required":true,"description":""},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"dealCustomerDetails":[{}],"dealAdditionalInfo":[{}],"ssi":[{}],"ownBankDetails":[{}],"agentBankDetails":[{}],"chargeDetails":[{}],"tradeAccountDetails":[{}],"alternateId":"string","transferType":"string","expectedSettlementDate":"string","tradeNotes":"string","businessDayCentre":"string","dealReference":"string","dealTitle":"string","currency":"string"}},"responses":{"200":"TradeResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"POST","path":"/holdings/creditAgreements/loanTrades/{loanTradeId}/consents","fullPath":"/api/v7.4.0/holdings/creditAgreements/loanTrades/{loanTradeId}/consents","operationId":"updateConsent","name":"Update borrower consent for trade","summary":"Update consent status if borrower has agreed or rejected trade.","tags":["CORPORATE"],"parameters":[{"name":"loanTradeId","in":"path","type":"string","required":true,"description":""},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"consentDetails":[{}],"chargeDetails":[{}],"tradeStatus":"string","extensions":{}}},"responses":{"200":"ConsentResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"POST","path":"/holdings/creditAgreements/loanTrades/{loanTradeId}/commitments","fullPath":"/api/v7.4.0/holdings/creditAgreements/loanTrades/{loanTradeId}/commitments","operationId":"updateCommitment","name":"Update the trade due to changes in commitment amount being traded.","summary":"Update commitment details","tags":["CORPORATE"],"parameters":[{"name":"loanTradeId","in":"path","type":"string","required":true,"description":""},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"chargeDetails":[{}],"tradeAccountDetails":[{}],"amount":"string","expectedSettlementDate":"string","actualSettlementDate":"string","tradePrice":"string","settlementMethod":"string","allowNetback":"string","allowBoCR":"string","extensions":{}}},"responses":{"200":"CommitmentResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"POST","path":"/holdings/creditAgreements/loanTrades/{loanTradeId}/acceptances","fullPath":"/api/v7.4.0/holdings/creditAgreements/loanTrades/{loanTradeId}/acceptances","operationId":"approveTrade","name":"Finalize the trade to verify all necessary details are available.","summary":"Finalize the trade to issue pricing letter.","tags":["CORPORATE"],"parameters":[{"name":"loanTradeId","in":"path","type":"string","required":true,"description":""},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"dealCustomerDetails":[{}],"dealAdditionalInfo":[{}],"ssi":[{}],"ownBankDetails":[{}],"agentBankDetails":[{}],"tradeNotes":"string","dealReference":"string","dealTitle":"string","currency":"string","globalAmount":"string","startDate":"string","agentBank":"string","agentId":"string","agentName":"string","extensions":{}}},"responses":{"200":"TradeResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"POST","path":"/holdings/creditAgreements/loanTrades/{loanTradeId}/messages","fullPath":"/api/v7.4.0/holdings/creditAgreements/loanTrades/{loanTradeId}/messages","operationId":"showPricingLetter","name":"Issue pricing letter to the counter party for a final settlement amount.","summary":"Issue pricing letter to counterparty.","tags":["CORPORATE"],"parameters":[{"name":"loanTradeId","in":"path","type":"string","required":true,"description":""},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"extensions":{}}},"responses":{"200":"PricingLetterResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"POST","path":"/holdings/creditAgreements/loanTrades/{loanTradeId}/settlements","fullPath":"/api/v7.4.0/holdings/creditAgreements/loanTrades/{loanTradeId}/settlements","operationId":"calculateTrade","name":"Settle the trade in bank books.","summary":"Settle trade.","tags":["CORPORATE"],"parameters":[{"name":"loanTradeId","in":"path","type":"string","required":true,"description":""},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"issuePricing":"string","tradeNotes":"string","extensions":{}}},"responses":{"200":"TradeResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"POST","path":"/holdings/creditAgreements/loanTrades/{loanTradeId}/cancellations","fullPath":"/api/v7.4.0/holdings/creditAgreements/loanTrades/{loanTradeId}/cancellations","operationId":"cancelTrade","name":"Cancel the trade in bank books.","summary":"Cancel trade.","tags":["CORPORATE"],"parameters":[{"name":"loanTradeId","in":"path","type":"string","required":true,"description":""},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"tradeNotes":"string","extensions":{}}},"responses":{"200":"TradeResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/holdings/creditAgreements/loanTrades/{loanTradeId}/charges","fullPath":"/api/v7.4.0/holdings/creditAgreements/loanTrades/{loanTradeId}/charges","operationId":"getCharges","name":"View all the charge details for a given trade.","summary":"View charges.","tags":["CORPORATE"],"parameters":[{"name":"loanTradeId","in":"path","type":"string","required":true,"description":""},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"ChargesResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"PUT","path":"/holdings/creditAgreements/loanTrades/{loanTradeId}/charges","fullPath":"/api/v7.4.0/holdings/creditAgreements/loanTrades/{loanTradeId}/charges","operationId":"updateCharges","name":"Amend charges already authorized in the trade","summary":"Amend charges.","tags":["CORPORATE"],"parameters":[{"name":"loanTradeId","in":"path","type":"string","required":true,"description":""},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"chargeDetails":[{}],"extensions":{}}},"responses":{"200":"ChargesResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/holdings/creditAgreements/loanTrades/products","fullPath":"/api/v7.4.0/holdings/creditAgreements/loanTrades/products","operationId":"getTradeProducts","name":"View all the trade products","summary":"View trade products","tags":["CORPORATE"],"parameters":[{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"TradeProductsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"PUT","path":"/holdings/creditAgreements/facilities/{facilityId}/coordinationFees","fullPath":"/api/v7.4.0/holdings/creditAgreements/facilities/{facilityId}/coordinationFees","operationId":"updateFacilityCoordinationFees","name":"Updation of coordination fees Indicates the fees collected from the borrower to pay to its participants in facility","summary":"Update coordination fees to pay the fee to its participants in facility","tags":["CORPORATE"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"facilityId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"productId":"string","effectiveDate":"2024-01-01","extensions":{},"coordinationfee":[{}]}},"responses":{"200":"updateFacilityCoordinationFeesResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"PUT","path":"/holdings/creditAgreements/facilities/{facilityId}/upfrontFees","fullPath":"/api/v7.4.0/holdings/creditAgreements/facilities/{facilityId}/upfrontFees","operationId":"updateFacilityUpfrontFees","name":"It is a common fee charged by lenders when you apply for a loan, it covers the costs of processing your application, including things like administrative costs, credit assessment, loan set-up and document preparation etc.","summary":"Update the upfront fee which is collect one time by bank","tags":["CORPORATE"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"facilityId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"productId":"string","effectiveDate":"2024-01-01","extensions":{},"upfrontfee":[{}]}},"responses":{"200":"updateFacilityUpfrontFeesResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"PUT","path":"/holdings/creditAgreements/facilities/{facilityId}/drawdowns/rules","fullPath":"/api/v7.4.0/holdings/creditAgreements/facilities/{facilityId}/drawdowns/rules","operationId":"UpdateFacilityDrawingRules","name":"Drawing rules such as Borrower, currency, product and product group are defned for drawdown under facility level.","summary":"Initiate drawing rules to restrict customer, currency and products for drawdown under facility level.","tags":["CORPORATE"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"facilityId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"productId":"string","effectiveDate":"2024-01-01","extensions":{},"drawingRules":[{}]}},"responses":{"200":"UpdateFacilityDrawingRulesResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"PUT","path":"/holdings/creditAgreements/facilities/{facilityId}/drawdowns/conditions","fullPath":"/api/v7.4.0/holdings/creditAgreements/facilities/{facilityId}/drawdowns/conditions","operationId":"updateFacilityDrawingConditions","name":"Drawing condition are set based on the product line, product group, product, property, currency, attribute, value, message for drawdown under facility level.","summary":"Initiate drawing condition to restrict customer, currency and products for drawdown with overrides.","tags":["CORPORATE"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"facilityId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"productId":"string","effectiveDate":"2024-01-01","extensions":{},"drawingConditions":[{}]}},"responses":{"200":"updateFacilityDrawingConditionsResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"PUT","path":"/holdings/creditAgreements/deals/{dealId}/commitmentAndTermBlock","fullPath":"/api/v7.4.0/holdings/creditAgreements/deals/{dealId}/commitmentAndTermBlock","operationId":"UpdateBlockcommitmentandTerm","name":"Existing deal level commitment term is blocked","summary":"Block the commitment and term of the existing deal arrangement.","tags":["CORPORATE"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"dealId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"parties":[{}],"activityId":"string","effectiveDate":"string","productId":"string","currencyId":"string","simulationId":"string","extensions":{}}},"responses":{"200":"UpdateBlockcommitmentandTermResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"PUT","path":"/holdings/creditAgreements/deals/{dealId}/commitmentAndTermUnblock","fullPath":"/api/v7.4.0/holdings/creditAgreements/deals/{dealId}/commitmentAndTermUnblock","operationId":"UpdateUnblockcommitmentandTerm","name":"Existing deal level commitment term is unblocked","summary":"Unblock the commitment and term of the existing deal arrangement.","tags":["CORPORATE"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"dealId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"parties":[{}],"activityId":"string","effectiveDate":"string","productId":"string","currencyId":"string","simulationId":"string","extensions":{}}},"responses":{"200":"UpdateUnblockcommitmentandTermResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"PUT","path":"/holdings/creditAgreements/deals/{dealId}/commitmentTerms","fullPath":"/api/v7.4.0/holdings/creditAgreements/deals/{dealId}/commitmentTerms","operationId":"updateDealCommitmentTerms","name":"Deal tenure can be increased or decreased","summary":"Update tenure by increasing or decreasing the term in deal level","tags":["CORPORATE"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"dealId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"productId":"string","effectiveDate":"2024-01-01","extensions":{},"dacommitment":[{}]}},"responses":{"200":"updateDealCommitmentTermsResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"PUT","path":"/holdings/creditAgreements/facilities/{facilityId}/scheduleDefinitions","fullPath":"/api/v7.4.0/holdings/creditAgreements/facilities/{facilityId}/scheduleDefinitions","operationId":"updateFacilityPaymentSchedules","name":"Allow user to change schedule condition in facility level.","summary":"User to change schedule condition in facility level.","tags":["CORPORATE"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"facilityId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"productId":"string","effectiveDate":"2024-01-01","extensions":{},"schedule":[{}],"feeschedule":[{}]}},"responses":{"200":"updateFacilityPaymentSchedulesResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"PUT","path":"/holdings/creditAgreements/facility/{facilityId}/adjustments","fullPath":"/api/v7.4.0/holdings/creditAgreements/facility/{facilityId}/adjustments","operationId":"initiateAdjustmets","name":"Bill balances  such as commitment balance, principal or interest or charge amount of facility should be adjusted","summary":"Perform adjust balances and bills such as commitment balance, principal or interest or charge amount of facility","tags":["CORPORATE"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"facilityId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"productId":"string","effectiveDate":"2024-01-01","extensions":{},"balanceMaintenance":[{}]}},"responses":{"200":"initiateAdjustmetsResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"PUT","path":"/holdings/creditAgreements/facilities/{facilityId}/commitmentAndTermBlock","fullPath":"/api/v7.4.0/holdings/creditAgreements/facilities/{facilityId}/commitmentAndTermBlock","operationId":"updateBlockFacilityCommitment","name":"There could be adverse credit rating of the customer as part of the periodic review and bank would like to restrict further credit exposure. In such cases when the facility is blocked further drawdowns are not allowed while the existing drawings can be serviced.","summary":"When the facility is blocked further drawdowns are not allowed while the existing drawings can be serviced.","tags":["CORPORATE"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"facilityId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"parties":[{}],"activityId":"string","effectiveDate":"string","productId":"string","currencyId":"string","simulationId":"string","extensions":{}}},"responses":{"200":"updateBlockFacilityCommitmentResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"PUT","path":"/holdings/creditAgreements/facilities/{facilityId}/commitmentAndTermUnblock","fullPath":"/api/v7.4.0/holdings/creditAgreements/facilities/{facilityId}/commitmentAndTermUnblock","operationId":"updateUnblockFacilityCommitment","name":"There could be adverse credit rating of the customer as part of the periodic review and bank would have restricted further credit exposure and stipulated some mitigants to be fulfilled by customer based on which the restrictions on credit exposure can be lifted. This API is used to unblock the facility commitment.","summary":"Update unblock facility commitment is used to unblock the blocked commitment.","tags":["CORPORATE"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"facilityId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"parties":[{}],"activityId":"string","effectiveDate":"string","productId":"string","currencyId":"string","simulationId":"string","extensions":{}}},"responses":{"200":"updateUnblockFacilityCommitmentResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"PUT","path":"/holdings/creditAgreements/drawings/{drawingsId}/rolloverType","fullPath":"/api/v7.4.0/holdings/creditAgreements/drawings/{drawingsId}/rolloverType","operationId":"createDrawingsRollovers","name":"Create rollover process for drawings rollover could be splitting of drawing, merging two or more drawings into a single drawing or rollover one drawing to another.","summary":"Perform splits/merge/rollover a drawings into many drawings","tags":["CORPORATE"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"drawingsId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"parties":[{}],"activityId":"string","effectiveDate":"string","productId":"string","currencyId":"string","simulationId":"string","extensions":{},"splitsMerges":[{}]}},"responses":{"200":"createDrawingsRolloversResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"PUT","path":"/holdings/creditAgreements/deals/{dealId}/commitmentIncreases","fullPath":"/api/v7.4.0/holdings/creditAgreements/deals/{dealId}/commitmentIncreases","operationId":"updateDealCommitmentIncreases","name":"User should be able to increase the commitment amount of the existing deal arrangement.","summary":"Increases the commitment amount of the existing deal arrangement.","tags":["CORPORATE"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"dealId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"effectiveDate":"2024-01-01","activityId":"string","externalEventStatus":"string","extensions":{},"dacommitment":[{}]}},"responses":{"200":"createDealCommitmentIncreasesResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"PUT","path":"/holdings/creditAgreements/deals/{dealId}/commitmentDecreases","fullPath":"/api/v7.4.0/holdings/creditAgreements/deals/{dealId}/commitmentDecreases","operationId":"updateDealCommitmentDecreases","name":"User should be able to decrease the commitment amount of the existing deal arrangement","summary":"The commitment amount of the existing deal arrangement can be decreased","tags":["CORPORATE"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"dealId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"effectiveDate":"2024-01-01","activityId":"string","externalEventStatus":"string","extensions":{},"dacommitment":[{}]}},"responses":{"200":"createDealCommitmentDecreasesResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"PUT","path":"/holdings/creditAgreements/facilities/{facilityId}/drawdowns/subLimits","fullPath":"/api/v7.4.0/holdings/creditAgreements/facilities/{facilityId}/drawdowns/subLimits","operationId":"updateSubLimits","name":"User should be able to update  the sub limits based on the risk criterion. When restrictions and allocations are regulated based on the risk elements, borrower, currency and product (Product, Product group, and Product line).","summary":"Update sub limits based on the risk criterion","tags":["CORPORATE"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"facilityId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"productId":"string","effectiveDate":"2024-01-01","extensions":{},"sublimits":[{}]}},"responses":{"200":"updateSubLimitsResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"PUT","path":"/holdings/creditAgreements/drawings/{drawingId}/commitmentIncreases","fullPath":"/api/v7.4.0/holdings/creditAgreements/drawings/{drawingId}/commitmentIncreases","operationId":"createDrawdownCommitmentIncrease","name":"To increase the drawdown commitment for a given arrangement","summary":"To increase the drawdown commitment for a given arrangement","tags":["CORPORATE"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"drawingId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"productId":"string","drawdownDate":"2024-01-01","extensions":{},"dwcommitment":[{}]}},"responses":{"200":"createDrawdownCommitmentIncreaseResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"PUT","path":"/holdings/creditAgreements/drawings/{drawingId}/commitmentDecreases","fullPath":"/api/v7.4.0/holdings/creditAgreements/drawings/{drawingId}/commitmentDecreases","operationId":"createDrawdownCommitmentDecreases","name":"To decrease the drawdown commitment for a given arrangement","summary":"To decrease the drawdown commitment for a given arrangement","tags":["CORPORATE"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"drawingId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"productId":"string","drawdownDate":"2024-01-01","extensions":{},"dwcommitment":[{}]}},"responses":{"200":"createDrawdownCommitmentDecreasesResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"PUT","path":"/holdings/creditAgreements/facility/{facilityId}/writeOffs","fullPath":"/api/v7.4.0/holdings/creditAgreements/facility/{facilityId}/writeOffs","operationId":"updateWriteOffBillMaintenance","name":"Perform the write off of all the balances and bills of a loan. Bank calls for the write off of a loan borrowed by a defaulter when the chances of loan recovery are almost zero and its assets are non-performing.","summary":"Writeoff bill balance under facility level","tags":["CORPORATE"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"facilityId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"productId":"string","effectiveDate":"2024-01-01","extensions":{},"balanceMaintenance":[{}]}},"responses":{"200":"updateWriteOffBillMaintenanceResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"POST","path":"/holdings/creditAgreements/loanTrades/{loanTradeId}/subAllocations","fullPath":"/api/v7.4.0/holdings/creditAgreements/loanTrades/{loanTradeId}/subAllocations","operationId":"allocateTrade","name":"The division of the sold loans by the seller, as advised by the original buyer.","summary":"Allocation of the sold loans among multiple buyers.","tags":["CORPORATE"],"parameters":[{"name":"loanTradeId","in":"path","type":"string","required":true,"description":"Unique identifier generated for each trade booked in  the system."},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"buyerDetails":[{}],"tradeActivity":"string","tradeStatus":"string","extensions":{}}},"responses":{"200":"TradeResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}}]},{"key":"holdings-creditAgreements-api-service-v7.5.0","title":"Corporate Credit Agreements","version":"v7.5.0","description":"API for the creation and management of credit agreements for corporate customers. The types of credit agreements are single level facility, credit agreement with multiple facilities, club loans with agency and syndicated loans","endpointCount":91,"endpoints":[{"method":"POST","path":"/holdings/creditAgreements/deals/offers","fullPath":"/api/v7.5.0/holdings/creditAgreements/deals/offers","operationId":"createDealOffer","name":"Creates new offer deal for the required customer when the mandatory input details are provided. Offer deal creates a draft contract and allows the users to negotiate multiple times. Offer deal is a draft contract and will not affect the balance sheet of the bank.","summary":"Creates an offer for a deal contract","tags":["CORPORATE"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"customers":[{}],"productId":"string","currency":"string","effectiveDate":"2024-01-01","activity":"string","extensions":{},"facilityRules":[{}],"dacommitment":[{}],"adminfee":[{}],"coordinationfee":[{}],"upfrontfee":[{}],"limit":[{}]}},"responses":{"200":"createDealOfferResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"POST","path":"/holdings/creditAgreements/facilities/offers","fullPath":"/api/v7.5.0/holdings/creditAgreements/facilities/offers","operationId":"createFacilityOffer","name":"Creates a new offer facility for the required customer when at least the mandatory input is provided. Offer facility creates a draft contract and allow the users to negotiate multiple times. Offer facility is a draft contract and will not affect the balance sheet of the bank.","summary":"Creates an offer for a facility contract","tags":["CORPORATE"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"customers":[{}],"productId":"string","currency":"string","dealId":"string","effectiveDate":"2024-01-01","activity":"string","extensions":{},"settlement":[{}],"facommitment":[{}],"upfrontfee":[{}],"coordinationfee":[{}],"limit":[{}]}},"responses":{"200":"createFacilityOfferResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"POST","path":"/holdings/creditAgreements/deals/offers/cancellations/{arrangementId}","fullPath":"/api/v7.5.0/holdings/creditAgreements/deals/offers/cancellations/{arrangementId}","operationId":"deleteDealOffer","name":"Deletes a new offer for the required deal contract when at least the mandatory input is provided. Deal offer is a draft contract, which allow the user to delete the contract online and deal offer contract will not affect the balance sheet of the bank.","summary":"Deletes an offer for a deal contract","tags":["CORPORATE"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"arrangementId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"productId":"string","effectiveDate":"2024-01-01","extensions":{}}},"responses":{"200":"deleteDealOfferResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"POST","path":"/holdings/creditAgreements/facilities/offers/cancellations/{arrangementId}","fullPath":"/api/v7.5.0/holdings/creditAgreements/facilities/offers/cancellations/{arrangementId}","operationId":"deleteFacilityOffer","name":"Deletes a new offer for the required facility contract when at least the mandatory input is provided. Facility offer is a draft contract, which allow the user to delete the contract online and facility offer contract will not affect the balance sheet of the bank.","summary":"Deletes an offer for a facility contract","tags":["CORPORATE"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"arrangementId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"productId":"string","effectiveDate":"2024-01-01","extensions":{}}},"responses":{"200":"deleteFacilityOfferResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"POST","path":"/holdings/creditAgreements/deals/offers/acceptances/{arrangementId}","fullPath":"/api/v7.5.0/holdings/creditAgreements/deals/offers/acceptances/{arrangementId}","operationId":"acceptDealOffer","name":"On executing acceptance, the contract is changed from offer to live deal for the required customer when at least the mandatory input is provided. Process will check all the required mandatory inputs and prompt an error message when mandatory details are not provided. Once the accept deal offer is processed further offer negotiation is not allowed.","summary":"Accept the deal offer and execute the contract to live","tags":["CORPORATE"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"arrangementId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"productId":"string","effectiveDate":"2024-01-01","extensions":{},"settlement":[{}],"facilityRules":[{}],"dacommitment":[{}],"adminfee":[{}],"coordinationfee":[{}],"upfrontfee":[{}],"limit":[{}]}},"responses":{"200":"acceptDealOfferResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"POST","path":"/holdings/creditAgreements/facilities/offers/acceptances/{arrangementId}","fullPath":"/api/v7.5.0/holdings/creditAgreements/facilities/offers/acceptances/{arrangementId}","operationId":"acceptFacilityOffer","name":"On executing acceptance, the contract is changed from offer to live facility for the required customer when at least the mandatory input is provided. Process will check all the required mandatory inputs and prompt an error message when mandatory details are not provided. Once the accept deal offer is processed further offer negotiation is not allowed.","summary":"Accept the facility offer and execute the contract to live","tags":["CORPORATE"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"arrangementId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"productId":"string","effectiveDate":"2024-01-01","extensions":{},"settlement":[{}],"facommitment":[{}],"upfrontfee":[{}],"coordinationfee":[{}],"limit":[{}]}},"responses":{"200":"acceptFacilityOfferResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"POST","path":"/holdings/creditAgreements/drawdowns/offers","fullPath":"/api/v7.5.0/holdings/creditAgreements/drawdowns/offers","operationId":"createDrawdownOffer","name":"Creates a new drawdown offer for the required customer. ","summary":"Creates a new drawdown offer for the required customer. ","tags":["CORPORATE"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"customers":[{}],"productId":"string","currency":"string","facilityId":"string","offerDate":"2024-01-01","drawdownDate":"2024-01-01","activity":"string","extensions":{},"maintenancefee":[{}],"dwcommitment":[{}],"settlement":[{}]}},"responses":{"200":"createDrawdownOfferResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"POST","path":"/holdings/creditAgreements/drawdowns/offers/negotiations","fullPath":"/api/v7.5.0/holdings/creditAgreements/drawdowns/offers/negotiations","operationId":"createOfferDrawdownRenegotiation","name":"Renegotiate the offer drawdown for the required customer.","summary":"Renegotiate the offer drawdown for the required customer.","tags":["CORPORATE"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"productId":"string","drawdownDate":"2024-01-01","extensions":{},"maintenancefee":[{}],"settlement":[{}]}},"responses":{"200":"createOfferDrawdownRenegotiationResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"POST","path":"/holdings/creditAgreements/drawdowns/offers/cancellations","fullPath":"/api/v7.5.0/holdings/creditAgreements/drawdowns/offers/cancellations","operationId":"deleteDrawdownOffer","name":"Cancellation of offer drawdown for the required customer.","summary":"Cancellation of offer drawdown for the required customer.","tags":["CORPORATE"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"productId":"string","drawdownDate":"2024-01-01","extensions":{}}},"responses":{"200":"deleteDrawdownOfferResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"POST","path":"/holdings/creditAgreements/drawdowns/offers/acceptances","fullPath":"/api/v7.5.0/holdings/creditAgreements/drawdowns/offers/acceptances","operationId":"acceptOfferDrawdown","name":"Convert an offer drawdown to a live drawdown for the required customer.","summary":"Convert an offer drawdown to a live drawdown for the required customer.","tags":["CORPORATE"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"productId":"string","drawdownDate":"2024-01-01","extensions":{},"maintenancefee":[{}],"dwcommitment":[{}],"settlement":[{}]}},"responses":{"200":"acceptOfferDrawdownResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"GET","path":"/holdings/creditAgreements/facilities/{facilityId}/drawingProducts","fullPath":"/api/v7.5.0/holdings/creditAgreements/facilities/{facilityId}/drawingProducts","operationId":"getFacilityDrawingProducts","name":"Retrieves the available drawing products under the facility ","summary":"Retrieves the available drawing products under the facility ","tags":["CORPORATE"],"parameters":[{"name":"facilityId","in":"path","type":"string","required":true,"description":"Unique identifier (contract number) of the facility"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"FacilityDrawingProductsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/creditAgreements/facilities/{facilityId}/combinedSchedules","fullPath":"/api/v7.5.0/holdings/creditAgreements/facilities/{facilityId}/combinedSchedules","operationId":"getCombinedSchedules","name":"Retrieves the payment schedule of facility and its drawings","summary":"Retrieves the payment schedule of facility and its drawings","tags":["CORPORATE"],"parameters":[{"name":"facilityId","in":"path","type":"string","required":true,"description":"Unique identifier (contract number) of the facility"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"CombinedSchedulesResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"POST","path":"/holdings/creditAgreements/facilities","fullPath":"/api/v7.5.0/holdings/creditAgreements/facilities","operationId":"createFacilities","name":"Creates corporate facilities","summary":"Creates corporate facilities","tags":["CORPORATE"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"customers":[{}],"productId":"string","currency":"string","effectiveDate":"2024-01-01","dealId":"string","extensions":{},"settlement":[{}],"facommitment":[{}],"upfrontfee":[{}],"coordinationfee":[{}],"limit":[{}]}},"responses":{"200":"createFacilitiesResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"POST","path":"/holdings/creditAgreements/drawdowns","fullPath":"/api/v7.5.0/holdings/creditAgreements/drawdowns","operationId":"createDrawdowns","name":"Creates drawdowns under facility","summary":"Creates drawdowns under facility","tags":["CORPORATE"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"customers":[{}],"arrangmentId":"string","currency":"string","facilityId":"string","effectiveDate":"string","activity":"string","productId":"string","extensions":{},"escrow":[{}],"dwcommitment":[{}],"settlement":[{}]}},"responses":{"200":"createDrawdownsResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"GET","path":"/holdings/creditAgreements/facilities/{facilityId}/drawingRules","fullPath":"/api/v7.5.0/holdings/creditAgreements/facilities/{facilityId}/drawingRules","operationId":"getFacilityDrawingRules","name":"Retrieves the allowed customers, currencies and products for a new drawing under the facility","summary":"Retrieves the allowed customers, currencies and products for a new drawing under the facility","tags":["CORPORATE"],"parameters":[{"name":"facilityId","in":"path","type":"string","required":true,"description":"Unique identifier (contract number) of the facility"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"FacilityDrawingRulesResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/creditAgreements/facilities/{facilityId}/drawings","fullPath":"/api/v7.5.0/holdings/creditAgreements/facilities/{facilityId}/drawings","operationId":"getDrawingsUnderFacility","name":"Retrieves the drawings under a facility","summary":"Retrieves the drawings under a facility","tags":["CORPORATE"],"parameters":[{"name":"facilityId","in":"path","type":"string","required":true,"description":"Unique identifier (contract number) of the facility"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"DrawingsUnderFacilityResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/creditAgreements/facilities/drawings/{drawingId}/parentFacilities","fullPath":"/api/v7.5.0/holdings/creditAgreements/facilities/drawings/{drawingId}/parentFacilities","operationId":"getDrawingFacility","name":"Retrieves the parent facility for a drawing","summary":"Retrieves the parent facility for a drawing","tags":["CORPORATE"],"parameters":[{"name":"drawingId","in":"path","type":"string","required":true,"description":"Identifier of drawings application under the Letter of Credit system that is used to effect the transfer of funds and the acceptance of documents under Letters of Credit and Documentary Collection tra"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"DrawingFacilityResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/creditAgreements/facilities/{facilityId}/commitmentSchedules","fullPath":"/api/v7.5.0/holdings/creditAgreements/facilities/{facilityId}/commitmentSchedules","operationId":"getFacilityCommitmentSchedule","name":"Retrieves the commitment schedule of a facility","summary":"Retrieves the commitment schedule of a facility","tags":["CORPORATE"],"parameters":[{"name":"facilityId","in":"path","type":"string","required":true,"description":"Unique identifier (contract number) of the facility"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"FacilityCommitmentScheduleResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/creditAgreements/facilities/{facilityId}/parentDeals","fullPath":"/api/v7.5.0/holdings/creditAgreements/facilities/{facilityId}/parentDeals","operationId":"getFacilityDeal","name":"Retrieves the parent deal for a facility","summary":"Retrieves the parent deal for a facility","tags":["CORPORATE"],"parameters":[{"name":"facilityId","in":"path","type":"string","required":true,"description":"Unique identifier (contract number) of the facility"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"FacilityDealResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/creditAgreements/facilities/{facilityId}/balances","fullPath":"/api/v7.5.0/holdings/creditAgreements/facilities/{facilityId}/balances","operationId":"getFacilityFinancialSummary","name":"Retrieves the financial summary for a facility arrangement","summary":"Retrieves the financial summary for a facility arrangement","tags":["CORPORATE"],"parameters":[{"name":"facilityId","in":"path","type":"string","required":true,"description":"Unique identifier (contract number) of the facility"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"FacilityFinancialSummaryResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/creditAgreements/facilities/{facilityId}/consolidatedBalances","fullPath":"/api/v7.5.0/holdings/creditAgreements/facilities/{facilityId}/consolidatedBalances","operationId":"getFacilityConsolidatedBalances","name":"Retrieves the consolidated balances for a facility arrangement","summary":"Retrieves the consolidated balances for a facility arrangement","tags":["CORPORATE"],"parameters":[{"name":"facilityId","in":"path","type":"string","required":true,"description":"Unique identifier (contract number) of the facility"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"FacilityConsolidatedBalancesResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"POST","path":"/holdings/creditAgreements/facilities/directDebits","fullPath":"/api/v7.5.0/holdings/creditAgreements/facilities/directDebits","operationId":"createFacilityDirectDebitLink","name":"Links a direct debit to an existing facility","summary":"Links a direct debit to a facility","tags":["CORPORATE"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"customers":[{}],"arrangement":"string","productId":"string","currency":"string","effectiveDate":"2024-01-01","extensions":{},"settlement":[{}]}},"responses":{"200":"createFacilityDirectDebitLinkResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"POST","path":"/holdings/creditAgreements/facilities/drawings/directDebits","fullPath":"/api/v7.5.0/holdings/creditAgreements/facilities/drawings/directDebits","operationId":"createDrawingDirectDebitLink","name":"Link the direct debit to an existing drawing under a facility","summary":"Links a direct debit to a drawing","tags":["CORPORATE"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"customers":[{}],"arrangement":"string","currency":"string","facilityId":"string","effectiveDate":"string","productId":"string","extensions":{},"settlement":[{}]}},"responses":{"200":"createDrawingDirectDebitLinkResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"POST","path":"/holdings/creditAgreements/facilities/rollovers/offers","fullPath":"/api/v7.5.0/holdings/creditAgreements/facilities/rollovers/offers","operationId":"createFacilityRolloverOffer","name":"Create rollover process from the facility where the rollover could be a split rollover, merge rollover or a one to one rollover. Split also called as one to many will rollover an old loan and create multiple new offer loans. Merge also called as many to one will rollover multiple old loans simultaneously and create a single new offer loan. Rollover also called as one to one will simply rollover an old loan and create a new offer loan","summary":"Create rollover offer from facility","tags":["CORPORATE"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"arrangement":"string","rolloverDate":"string","productId":"string","extensions":{},"splitsMerges":[{}]}},"responses":{"200":"createFacilityRolloverOfferResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"POST","path":"/holdings/creditAgreements/drawdowns/rollovers/offers","fullPath":"/api/v7.5.0/holdings/creditAgreements/drawdowns/rollovers/offers","operationId":"createDrawdownRolloverOffer","name":"Create rollover process from the drawdown where the rollover could be a split rollover, merge rollover or a one to one rollover. Split also called as one to many will rollover an old loan and create multiple new offer loans. Merge also called as many to one will rollover multiple old loans simultaneously and create a single new offer loan. Rollover also called as one to one will simply rollover an old loan and create a new offer loan","summary":"Create rollover offer from drawdown","tags":["CORPORATE"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"arrangement":"string","rolloverDate":"string","productId":"string","extensions":{},"splitsMerges":[{}]}},"responses":{"200":"createDrawdownRolloverOfferResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"POST","path":"/holdings/creditAgreements/facilities/commitmentIncreases/{arrangementId}","fullPath":"/api/v7.5.0/holdings/creditAgreements/facilities/commitmentIncreases/{arrangementId}","operationId":"updateFacilityCommitmentIncrease","name":"Increase the facility amount to facilitate further drawdowns","summary":"Increase facility amount","tags":["CORPORATE"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"arrangementId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"productId":"string","effectiveDate":"2024-01-01","extensions":{},"facommitment":[{}]}},"responses":{"200":"updateFacilityCommitmentIncreaseResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"POST","path":"/holdings/creditAgreements/facilities/commitmentTerms/{arrangementId}","fullPath":"/api/v7.5.0/holdings/creditAgreements/facilities/commitmentTerms/{arrangementId}","operationId":"updateFacilityCommitmentTerms","name":"Updates facility tenure by increasing or decreasing the term, in addition it allows the amendment of the availability schedule of the contract.","summary":"Update facility maturity date and availability","tags":["CORPORATE"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"arrangementId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"productId":"string","effectiveDate":"2024-01-01","extensions":{},"facommitment":[{}]}},"responses":{"200":"updateFacilityCommitmentTermsResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"GET","path":"/holdings/customers/{customerId}/creditAgreements/exposures","fullPath":"/api/v7.5.0/holdings/customers/{customerId}/creditAgreements/exposures","operationId":"getCustomerExposure","name":"Retrieves the customer exposure such as the facility number, type of facility, maturity date and various amounts of the facilities/standalone loans.","summary":"Retrieves the customer exposure for facilities and loans","tags":["CORPORATE"],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"Identifier of the customer"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"CustomerExposureResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/customers/{customerId}/creditAgreements/drawings","fullPath":"/api/v7.5.0/holdings/customers/{customerId}/creditAgreements/drawings","operationId":"getCustomerDrawings","name":"Retrieves the details such as the drawing id, account number, short description of the loan, customer name and loan status for a customer. ","summary":"Retrieves the drawing details for a customer.","tags":["CORPORATE"],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":""},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"CustomerDrawingsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/customers/{customerId}/creditAgreements/facilities","fullPath":"/api/v7.5.0/holdings/customers/{customerId}/creditAgreements/facilities","operationId":"getCustomerFacilities","name":"Retrieves the details such as the facility id, account number, short description of the facility, customer name and facility status for a customer.","summary":"Retrieves the facility details for a customer.","tags":["CORPORATE"],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"Identifier of the customer"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"CustomerFacilitiesResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/customers/{customerId}/creditAgreements/deals","fullPath":"/api/v7.5.0/holdings/customers/{customerId}/creditAgreements/deals","operationId":"getCustomerDeals","name":"Retrieves the details such as the deal id, account number, short description of the facility, customer name and deal status for a customer.","summary":"Retrieves the deal details for a customer.","tags":["CORPORATE"],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"Identifier of the customer"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"CustomerDealsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/creditAgreements/deals/{dealId}/facilities","fullPath":"/api/v7.5.0/holdings/creditAgreements/deals/{dealId}/facilities","operationId":"getFacilitiesUnderDeal","name":"Retrieves the details such as facility id, title, currency, status and commitment amount for all the facilities under a deal.","summary":"Retrieves the details of facilities under a deal.","tags":["CORPORATE"],"parameters":[{"name":"dealId","in":"path","type":"string","required":true,"description":"Unique identifier (contract number) of the corporate deals"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"FacilitiesUnderDealResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/creditAgreements/productCatalogues","fullPath":"/api/v7.5.0/holdings/creditAgreements/productCatalogues","operationId":"getCreditAgreementsProductCatalogue","name":"Retrieves the list of available products for credit agreements.","summary":"Retrieves the credit agreements product catalogue.","tags":["CORPORATE"],"parameters":[{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"CreditAgreementsProductCatalogueResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/creditAgreements/drawings/{drawingId}/pendingActivities","fullPath":"/api/v7.5.0/holdings/creditAgreements/drawings/{drawingId}/pendingActivities","operationId":"getPendingActivities","name":"Retrieves the details such as rollover date, rollover status etc of pending drawdowns and rollovers for a drawing.","summary":"Retrieves the details of pending drawdowns and rollovers for a drawing.","tags":["CORPORATE"],"parameters":[{"name":"drawingId","in":"path","type":"string","required":true,"description":"Identifier of drawings application under the Letter of Credit system that is used to effect the transfer of funds and the acceptance of documents under Letters of Credit and Documentary Collection tra"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"PendingActivitiesResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/creditAgreements/drawings/expiries","fullPath":"/api/v7.5.0/holdings/creditAgreements/drawings/expiries","operationId":"getLoansExpiring","name":"Retrieves the drawings expiring in the next 7 days.","summary":"Retrieves expiring drawings.","tags":["CORPORATE"],"parameters":[{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"LoansExpiringResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/creditAgreements/facilities/expiries","fullPath":"/api/v7.5.0/holdings/creditAgreements/facilities/expiries","operationId":"getFacilitiesExpiring","name":"Retrieves the facilities expiring in the next 7 days","summary":"Retrieves expiring facilities","tags":["CORPORATE"],"parameters":[{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"FacilitiesExpiringResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/creditAgreements/drawings/{drawingId}/balances","fullPath":"/api/v7.5.0/holdings/creditAgreements/drawings/{drawingId}/balances","operationId":"getDrawingBalances","name":"Retrieves the balance details such as commitment balances, utilized balances.","summary":"Retrieves drawing balances","tags":["CORPORATE"],"parameters":[{"name":"drawingId","in":"path","type":"string","required":true,"description":"Identifier of drawings application under the Letter of Credit system that is used to effect the transfer of funds and the acceptance of documents under Letters of Credit and Documentary Collection tra"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"DrawingBalancesResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/creditAgreements/drawings/{drawingId}/OverdueBalances","fullPath":"/api/v7.5.0/holdings/creditAgreements/drawings/{drawingId}/OverdueBalances","operationId":"getDrawingOverdueBalances","name":"Retrieves the past dues and overdues for a drawing","summary":"Retrieves drawing overdue balances","tags":["CORPORATE"],"parameters":[{"name":"drawingId","in":"path","type":"string","required":true,"description":"Identifier of drawings application under the Letter of Credit system that is used to effect the transfer of funds and the acceptance of documents under Letters of Credit and Documentary Collection tra"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"DrawingOverdueBalancesResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/creditAgreements/facilities/clubFacilities","fullPath":"/api/v7.5.0/holdings/creditAgreements/facilities/clubFacilities","operationId":"getClubFacilities","name":"Retrieves club facilities, drawings and deal","summary":"Retrieves club facilities, drawings and deal","tags":["CORPORATE"],"parameters":[{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"ClubFacilitiesResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"POST","path":"/holdings/creditAgreements/facilities/clubFacilities","fullPath":"/api/v7.5.0/holdings/creditAgreements/facilities/clubFacilities","operationId":"createClubFacilities","name":"Creates a club facility with facility details along with the details of participating lenders","summary":"Creates a club facility","tags":["CORPORATE"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"customers":[{}],"productId":"string","currency":"string","effectiveDate":"2024-01-01","extensions":{},"account":[{}],"settlement":[{}],"facommitment":[{}],"upfrontfee":[{}],"coordinationfee":[{}],"limit":[{}],"participant":[{}],"riskparticipant":[{}]}},"responses":{"200":"createClubFacilitiesResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"POST","path":"/holdings/creditAgreements/facilities/drawings/clubDrawings","fullPath":"/api/v7.5.0/holdings/creditAgreements/facilities/drawings/clubDrawings","operationId":"createClubDrawings","name":"Creates a club drawing arrangement with drawdown details along with the details of participating lenders","summary":"Creates a club drawing","tags":["CORPORATE"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"customers":[{}],"arrangmentId":"string","currency":"string","facilityId":"string","effectiveDate":"string","activity":"string","productId":"string","extensions":{},"account":[{}],"escrow":[{}],"dwcommitment":[{}],"settlement":[{}],"participant":[{}],"riskparticipant":[{}]}},"responses":{"200":"createClubDrawingsResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"GET","path":"/holdings/creditAgreements/facilities/drawings/{drawingId}/participants","fullPath":"/api/v7.5.0/holdings/creditAgreements/facilities/drawings/{drawingId}/participants","operationId":"getClubDrawingParticipants","name":"Retrieves the participation details of the lending arrangement for a customer. This will be used to view the agent bank and the participant details and the share amounts when an arrangement id is passed as an input.","summary":"Retrieves the participant details","tags":["CORPORATE"],"parameters":[{"name":"drawingId","in":"path","type":"string","required":true,"description":"Identifier of drawings application under the Letter of Credit system that is used to effect the transfer of funds and the acceptance of documents under Letters of Credit and Documentary Collection tra"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"ClubDrawingParticipantsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"POST","path":"/holdings/creditAgreements/facilities/{facilityId}/fundedShareTransfers","fullPath":"/api/v7.5.0/holdings/creditAgreements/facilities/{facilityId}/fundedShareTransfers","operationId":"createFacilityFundedShareTransfer","name":"Creates a funded share transfer for a facility when participant details are passed. Share of a funding participant is transferred to another funding participant in a club facility and underlying drawings","summary":"Creates a funded share transfer for a facility","tags":["CORPORATE"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"facilityId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"productId":"string","effectiveDate":"2024-01-01","extensions":{},"shareTransfer":[{}]}},"responses":{"200":"createFacilityFundedShareTransferResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"POST","path":"/holdings/creditAgreements/facilities/drawings/{drawingId}/fundedShareTransfers","fullPath":"/api/v7.5.0/holdings/creditAgreements/facilities/drawings/{drawingId}/fundedShareTransfers","operationId":"createDrawingFundedShareTransfer","name":"Creates a funded share transfer for a drawing under a facility when participant details are passed. Share of a funding participant is transferred to another funding participant in a standalone club loan","summary":"Creates a funded share transfer for a drawing","tags":["CORPORATE"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"drawingId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"productId":"string","effectiveDate":"2024-01-01","extensions":{},"shareTransfer":[{}]}},"responses":{"200":"createDrawingFundedShareTransferResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"POST","path":"/holdings/creditAgreements/facilities/{facilityId}/riskShareTransfers","fullPath":"/api/v7.5.0/holdings/creditAgreements/facilities/{facilityId}/riskShareTransfers","operationId":"createFacilityRiskShareTransfer","name":"Creates a risk share transfer for a facility when participant details are passed. The risk of the own bank in a facility is mitigated by selling a portion risk to another financial institution","summary":"Creates a risk share transfer for a facility","tags":["CORPORATE"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"facilityId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"productId":"string","effectiveDate":"2024-01-01","extensions":{},"shareTransfer":[{}]}},"responses":{"200":"createFacilityRiskShareTransferResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"POST","path":"/holdings/creditAgreements/facilities/drawings/{drawingId}/riskShareTransfers","fullPath":"/api/v7.5.0/holdings/creditAgreements/facilities/drawings/{drawingId}/riskShareTransfers","operationId":"createDrawingRiskShareTransfer","name":"Creates a risk share transfer for a drawing under a facility when participant details are passed. The risk of the own bank in a loan is mitigated by selling a portion risk to another financial institution","summary":"Creates a risk share transfer for a drawing","tags":["CORPORATE"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"drawingId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"productId":"string","effectiveDate":"2024-01-01","extensions":{},"shareTransfer":[{}]}},"responses":{"200":"createDrawingRiskShareTransferResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"POST","path":"/holdings/creditAgreements/guarantees/{guaranteeId}/guaranteeIncreases","fullPath":"/api/v7.5.0/holdings/creditAgreements/guarantees/{guaranteeId}/guaranteeIncreases","operationId":"updateGuaranteeCommitmentIncrease","name":"Increase the commitment amount of the guarantee that the financial institution has issued on behalf of the applicant","summary":"Increase the commitment amount of the guarantee","tags":["CORPORATE"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"guaranteeId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"productId":"string","effectiveDate":"2024-01-01","extensions":{},"gteecommitment":[{}]}},"responses":{"200":"updateGuaranteeCommitmentIncreaseResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"POST","path":"/holdings/creditAgreements/guarantees/{guaranteeId}/guaranteeDecreases","fullPath":"/api/v7.5.0/holdings/creditAgreements/guarantees/{guaranteeId}/guaranteeDecreases","operationId":"updateGuaranteeCommitmentDecrease","name":"Decrease the commitment amount of the guarantee that the financial institution has issued on behalf of the applicant","summary":"Decrease the commitment amount of the guarantee","tags":["CORPORATE"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"guaranteeId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"productId":"string","effectiveDate":"2024-01-01","extensions":{},"gteecommitment":[{}]}},"responses":{"200":"updateGuaranteeCommitmentDecreaseResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"POST","path":"/holdings/creditAgreements/guarantees","fullPath":"/api/v7.5.0/holdings/creditAgreements/guarantees","operationId":"createCreditAgreementGuarantee","name":"Register the issuance of a new guarantee undertaking on behalf of the applicant when all the basic details relevant to the undertaking are passed","summary":"Register the issuance of a guarantee","tags":["CORPORATE"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"customers":[{}],"productId":"string","currency":"string","effectiveDate":"2024-01-01","facilityId":"string","extensions":{},"gteecommitment":[{}],"newarrfee":[{}],"settlement":[{}],"termsConditions":[{}]}},"responses":{"200":"createCreditAgreementGuaranteeResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"POST","path":"/holdings/creditAgreements/guarantees/clubGuarantees","fullPath":"/api/v7.5.0/holdings/creditAgreements/guarantees/clubGuarantees","operationId":"createClubGuarantee","name":"Create a club guarantee with guarantee details along with the details of participating lenders","summary":"Create a club guarantee","tags":["CORPORATE"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"customers":[{}],"productId":"string","currency":"string","effectiveDate":"2024-01-01","facilityId":"string","extensions":{},"account":[{}],"gteecommitment":[{}],"newarrfee":[{}],"settlement":[{}],"termsConditions":[{}],"participant":[{}]}},"responses":{"200":"createClubGuaranteeResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"POST","path":"/holdings/creditAgreements/guarantees/{guaranteeId}/cancellations","fullPath":"/api/v7.5.0/holdings/creditAgreements/guarantees/{guaranteeId}/cancellations","operationId":"cancelCorporateGuarantee","name":"Cancel a guarantee arrangement before its expiry date. All the accrued fees are made-due for collection and the bank is discharged of its liability.","summary":"Cancel a guarantee arrangement before the expiry date.","tags":["CORPORATE"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"guaranteeId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"productId":"string","effectiveDate":"2024-01-01","extensions":{},"settlement":[{}]}},"responses":{"200":"cancelCorporateGuaranteeResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"POST","path":"/holdings/creditAgreements/deals","fullPath":"/api/v7.5.0/holdings/creditAgreements/deals","operationId":"createDeals","name":"Create a new deal for the customer with the details like product, term and amount . Corporate deal is a credit agreement between two parties- the lender and the borrower, who agree to certain terms and conditions along with their rights and obligations","summary":"Creates corporate deal","tags":["CORPORATE"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"customers":[{}],"productId":"string","currency":"string","effectiveDate":"2024-01-01","extensions":{},"settlement":[{}],"facilityRules":[{}],"dacommitment":[{}],"adminfee":[{}],"coordinationfee":[{}],"upfrontfee":[{}],"limit":[{}]}},"responses":{"200":"createDealsResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"POST","path":"/holdings/creditAgreements/loanTrades/trades","fullPath":"/api/v7.5.0/holdings/creditAgreements/loanTrades/trades","operationId":"createTrade","name":"Create a trade for a syndicated loan as initially agreed upon between counterparties.","summary":"Create a trade for a syndicated loan.","tags":["CORPORATE"],"parameters":[{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"counterPartyDetails":[{}],"dealCustomerDetails":[{}],"dealAdditionalInfo":[{}],"ssi":[{}],"ownBankDetails":[{}],"agentBankDetails":[{}],"consentDetails":[{}],"chargeDetails":[{}],"tradeAccountDetails":[{}],"tradeActivity":"string","alternateId":"string","tradeProduct":"string","tradeDate":"string","tradeCurrency":"string","transferType":"string"}},"responses":{"200":"TradeResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"POST","path":"/holdings/creditAgreements/loanTrades/{loanTradeId}/confirmationTrade","fullPath":"/api/v7.5.0/holdings/creditAgreements/loanTrades/{loanTradeId}/confirmationTrade","operationId":"acceptTrade","name":"Confirm the trade when all the parties involved agreed the terms and conditions of the trade.","summary":"Confirm the trade","tags":["CORPORATE"],"parameters":[{"name":"loanTradeId","in":"path","type":"string","required":true,"description":""},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"dealCustomerDetails":[{}],"dealAdditionalinfos":[{}],"dealReference":"string","dealTitle":"string","currency":"string","globalAmount":"string","startDate":"string","agentBank":"string","agentId":"string","agentName":"string","extensions":{}}},"responses":{"200":"TradeResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"POST","path":"/holdings/creditAgreements/loanTrades/{loanTradeId}","fullPath":"/api/v7.5.0/holdings/creditAgreements/loanTrades/{loanTradeId}","operationId":"updateTrade","name":"Update additional details in trade.","summary":"Update trade details","tags":["CORPORATE"],"parameters":[{"name":"loanTradeId","in":"path","type":"string","required":true,"description":""},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"dealCustomerDetails":[{}],"dealAdditionalInfo":[{}],"ssi":[{}],"ownBankDetails":[{}],"agentBankDetails":[{}],"chargeDetails":[{}],"tradeAccountDetails":[{}],"alternateId":"string","transferType":"string","expectedSettlementDate":"string","tradeNotes":"string","businessDayCentre":"string","dealReference":"string","dealTitle":"string","currency":"string"}},"responses":{"200":"TradeResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"POST","path":"/holdings/creditAgreements/loanTrades/{loanTradeId}/consents","fullPath":"/api/v7.5.0/holdings/creditAgreements/loanTrades/{loanTradeId}/consents","operationId":"updateConsent","name":"Update borrower consent for trade","summary":"Update consent status if borrower has agreed or rejected trade.","tags":["CORPORATE"],"parameters":[{"name":"loanTradeId","in":"path","type":"string","required":true,"description":""},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"consentDetails":[{}],"chargeDetails":[{}],"tradeStatus":"string","extensions":{}}},"responses":{"200":"ConsentResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"POST","path":"/holdings/creditAgreements/loanTrades/{loanTradeId}/commitments","fullPath":"/api/v7.5.0/holdings/creditAgreements/loanTrades/{loanTradeId}/commitments","operationId":"updateCommitment","name":"Update the trade due to changes in commitment amount being traded.","summary":"Update commitment details","tags":["CORPORATE"],"parameters":[{"name":"loanTradeId","in":"path","type":"string","required":true,"description":""},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"chargeDetails":[{}],"tradeAccountDetails":[{}],"amount":"string","expectedSettlementDate":"string","actualSettlementDate":"string","tradePrice":"string","settlementMethod":"string","allowNetback":"string","allowBoCR":"string","extensions":{}}},"responses":{"200":"CommitmentResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"POST","path":"/holdings/creditAgreements/loanTrades/{loanTradeId}/acceptances","fullPath":"/api/v7.5.0/holdings/creditAgreements/loanTrades/{loanTradeId}/acceptances","operationId":"approveTrade","name":"Finalize the trade to verify all necessary details are available.","summary":"Finalize the trade to issue pricing letter.","tags":["CORPORATE"],"parameters":[{"name":"loanTradeId","in":"path","type":"string","required":true,"description":""},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"dealCustomerDetails":[{}],"dealAdditionalInfo":[{}],"ssi":[{}],"ownBankDetails":[{}],"agentBankDetails":[{}],"tradeNotes":"string","dealReference":"string","dealTitle":"string","currency":"string","globalAmount":"string","startDate":"string","agentBank":"string","agentId":"string","agentName":"string","extensions":{}}},"responses":{"200":"TradeResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"POST","path":"/holdings/creditAgreements/loanTrades/{loanTradeId}/messages","fullPath":"/api/v7.5.0/holdings/creditAgreements/loanTrades/{loanTradeId}/messages","operationId":"showPricingLetter","name":"Issue pricing letter to the counter party for a final settlement amount.","summary":"Issue pricing letter to counterparty.","tags":["CORPORATE"],"parameters":[{"name":"loanTradeId","in":"path","type":"string","required":true,"description":""},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"extensions":{}}},"responses":{"200":"PricingLetterResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"POST","path":"/holdings/creditAgreements/loanTrades/{loanTradeId}/settlements","fullPath":"/api/v7.5.0/holdings/creditAgreements/loanTrades/{loanTradeId}/settlements","operationId":"calculateTrade","name":"Settle the trade in bank books.","summary":"Settle trade.","tags":["CORPORATE"],"parameters":[{"name":"loanTradeId","in":"path","type":"string","required":true,"description":""},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"issuePricing":"string","tradeNotes":"string","extensions":{}}},"responses":{"200":"TradeResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"POST","path":"/holdings/creditAgreements/loanTrades/{loanTradeId}/cancellations","fullPath":"/api/v7.5.0/holdings/creditAgreements/loanTrades/{loanTradeId}/cancellations","operationId":"cancelTrade","name":"Cancel the trade in bank books.","summary":"Cancel trade.","tags":["CORPORATE"],"parameters":[{"name":"loanTradeId","in":"path","type":"string","required":true,"description":""},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"tradeNotes":"string","extensions":{}}},"responses":{"200":"TradeResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/holdings/creditAgreements/loanTrades/{loanTradeId}/charges","fullPath":"/api/v7.5.0/holdings/creditAgreements/loanTrades/{loanTradeId}/charges","operationId":"getCharges","name":"View all the charge details for a given trade.","summary":"View charges.","tags":["CORPORATE"],"parameters":[{"name":"loanTradeId","in":"path","type":"string","required":true,"description":""},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"ChargesResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"PUT","path":"/holdings/creditAgreements/loanTrades/{loanTradeId}/charges","fullPath":"/api/v7.5.0/holdings/creditAgreements/loanTrades/{loanTradeId}/charges","operationId":"updateCharges","name":"Amend charges already authorized in the trade","summary":"Amend charges.","tags":["CORPORATE"],"parameters":[{"name":"loanTradeId","in":"path","type":"string","required":true,"description":""},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"chargeDetails":[{}],"extensions":{}}},"responses":{"200":"ChargesResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/holdings/creditAgreements/loanTrades/products","fullPath":"/api/v7.5.0/holdings/creditAgreements/loanTrades/products","operationId":"getTradeProducts","name":"View all the trade products","summary":"View trade products","tags":["CORPORATE"],"parameters":[{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"TradeProductsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"PUT","path":"/holdings/creditAgreements/facilities/{facilityId}/coordinationFees","fullPath":"/api/v7.5.0/holdings/creditAgreements/facilities/{facilityId}/coordinationFees","operationId":"updateFacilityCoordinationFees","name":"Updation of coordination fees Indicates the fees collected from the borrower to pay to its participants in facility","summary":"Update coordination fees to pay the fee to its participants in facility","tags":["CORPORATE"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"facilityId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"productId":"string","effectiveDate":"2024-01-01","extensions":{},"coordinationfee":[{}]}},"responses":{"200":"updateFacilityCoordinationFeesResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"PUT","path":"/holdings/creditAgreements/facilities/{facilityId}/upfrontFees","fullPath":"/api/v7.5.0/holdings/creditAgreements/facilities/{facilityId}/upfrontFees","operationId":"updateFacilityUpfrontFees","name":"It is a common fee charged by lenders when you apply for a loan, it covers the costs of processing your application, including things like administrative costs, credit assessment, loan set-up and document preparation etc.","summary":"Update the upfront fee which is collect one time by bank","tags":["CORPORATE"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"facilityId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"productId":"string","effectiveDate":"2024-01-01","extensions":{},"upfrontfee":[{}]}},"responses":{"200":"updateFacilityUpfrontFeesResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"PUT","path":"/holdings/creditAgreements/facilities/{facilityId}/drawdowns/rules","fullPath":"/api/v7.5.0/holdings/creditAgreements/facilities/{facilityId}/drawdowns/rules","operationId":"UpdateFacilityDrawingRules","name":"Drawing rules such as Borrower, currency, product and product group are defned for drawdown under facility level.","summary":"Initiate drawing rules to restrict customer, currency and products for drawdown under facility level.","tags":["CORPORATE"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"facilityId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"productId":"string","effectiveDate":"2024-01-01","extensions":{},"drawingRules":[{}]}},"responses":{"200":"UpdateFacilityDrawingRulesResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"PUT","path":"/holdings/creditAgreements/facilities/{facilityId}/drawdowns/conditions","fullPath":"/api/v7.5.0/holdings/creditAgreements/facilities/{facilityId}/drawdowns/conditions","operationId":"updateFacilityDrawingConditions","name":"Drawing condition are set based on the product line, product group, product, property, currency, attribute, value, message for drawdown under facility level.","summary":"Initiate drawing condition to restrict customer, currency and products for drawdown with overrides.","tags":["CORPORATE"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"facilityId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"productId":"string","effectiveDate":"2024-01-01","extensions":{},"drawingConditions":[{}]}},"responses":{"200":"updateFacilityDrawingConditionsResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"PUT","path":"/holdings/creditAgreements/deals/{dealId}/commitmentAndTermBlock","fullPath":"/api/v7.5.0/holdings/creditAgreements/deals/{dealId}/commitmentAndTermBlock","operationId":"UpdateBlockcommitmentandTerm","name":"Existing deal level commitment term is blocked","summary":"Block the commitment and term of the existing deal arrangement.","tags":["CORPORATE"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"dealId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"parties":[{}],"activityId":"string","effectiveDate":"string","productId":"string","currencyId":"string","simulationId":"string","extensions":{}}},"responses":{"200":"UpdateBlockcommitmentandTermResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"PUT","path":"/holdings/creditAgreements/deals/{dealId}/commitmentAndTermUnblock","fullPath":"/api/v7.5.0/holdings/creditAgreements/deals/{dealId}/commitmentAndTermUnblock","operationId":"UpdateUnblockcommitmentandTerm","name":"Existing deal level commitment term is unblocked","summary":"Unblock the commitment and term of the existing deal arrangement.","tags":["CORPORATE"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"dealId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"parties":[{}],"activityId":"string","effectiveDate":"string","productId":"string","currencyId":"string","simulationId":"string","extensions":{}}},"responses":{"200":"UpdateUnblockcommitmentandTermResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"PUT","path":"/holdings/creditAgreements/deals/{dealId}/commitmentTerms","fullPath":"/api/v7.5.0/holdings/creditAgreements/deals/{dealId}/commitmentTerms","operationId":"updateDealCommitmentTerms","name":"Deal tenure can be increased or decreased","summary":"Update tenure by increasing or decreasing the term in deal level","tags":["CORPORATE"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"dealId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"productId":"string","effectiveDate":"2024-01-01","extensions":{},"dacommitment":[{}]}},"responses":{"200":"updateDealCommitmentTermsResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"PUT","path":"/holdings/creditAgreements/facilities/{facilityId}/scheduleDefinitions","fullPath":"/api/v7.5.0/holdings/creditAgreements/facilities/{facilityId}/scheduleDefinitions","operationId":"updateFacilityPaymentSchedules","name":"Allow user to change schedule condition in facility level.","summary":"User to change schedule condition in facility level.","tags":["CORPORATE"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"facilityId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"productId":"string","effectiveDate":"2024-01-01","extensions":{},"schedule":[{}],"feeschedule":[{}]}},"responses":{"200":"updateFacilityPaymentSchedulesResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"PUT","path":"/holdings/creditAgreements/facilities/{facilityId}/participants","fullPath":"/api/v7.5.0/holdings/creditAgreements/facilities/{facilityId}/participants","operationId":"updateparticipant","name":"Update participant settlement instructions, skims, charges, own bank account details, agent bank beneficiary details and trading details.","summary":"Update participant settlement instructions, skims, charges, own bank account details, agent bank beneficiary details and trading details.","tags":["CORPORATE"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"facilityId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"productId":"string","effectiveDate":"2024-01-01","extensions":{},"participant":[{}]}},"responses":{"200":"updateparticipantResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"PUT","path":"/holdings/creditAgreements/facility/{facilityId}/adjustments","fullPath":"/api/v7.5.0/holdings/creditAgreements/facility/{facilityId}/adjustments","operationId":"initiateAdjustmets","name":"Bill balances  such as commitment balance, principal or interest or charge amount of facility should be adjusted","summary":"Perform adjust balances and bills such as commitment balance, principal or interest or charge amount of facility","tags":["CORPORATE"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"facilityId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"productId":"string","effectiveDate":"2024-01-01","extensions":{},"balanceMaintenance":[{}]}},"responses":{"200":"initiateAdjustmetsResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"PUT","path":"/holdings/creditAgreements/facilities/{facilityId}/commitmentAndTermBlock","fullPath":"/api/v7.5.0/holdings/creditAgreements/facilities/{facilityId}/commitmentAndTermBlock","operationId":"updateBlockFacilityCommitment","name":"There could be adverse credit rating of the customer as part of the periodic review and bank would like to restrict further credit exposure. In such cases when the facility is blocked further drawdowns are not allowed while the existing drawings can be serviced.","summary":"When the facility is blocked further drawdowns are not allowed while the existing drawings can be serviced.","tags":["CORPORATE"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"facilityId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"parties":[{}],"activityId":"string","effectiveDate":"string","productId":"string","currencyId":"string","simulationId":"string","extensions":{}}},"responses":{"200":"updateBlockFacilityCommitmentResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"PUT","path":"/holdings/creditAgreements/facilities/{facilityId}/commitmentAndTermUnblock","fullPath":"/api/v7.5.0/holdings/creditAgreements/facilities/{facilityId}/commitmentAndTermUnblock","operationId":"updateUnblockFacilityCommitment","name":"There could be adverse credit rating of the customer as part of the periodic review and bank would have restricted further credit exposure and stipulated some mitigants to be fulfilled by customer based on which the restrictions on credit exposure can be lifted. This API is used to unblock the facility commitment.","summary":"Update unblock facility commitment is used to unblock the blocked commitment.","tags":["CORPORATE"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"facilityId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"parties":[{}],"activityId":"string","effectiveDate":"string","productId":"string","currencyId":"string","simulationId":"string","extensions":{}}},"responses":{"200":"updateUnblockFacilityCommitmentResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"PUT","path":"/holdings/creditAgreements/drawings/{drawingsId}/rolloverType","fullPath":"/api/v7.5.0/holdings/creditAgreements/drawings/{drawingsId}/rolloverType","operationId":"createDrawingsRollovers","name":"Create rollover process for drawings rollover could be splitting of drawing, merging two or more drawings into a single drawing or rollover one drawing to another.","summary":"Perform splits/merge/rollover a drawings into many drawings","tags":["CORPORATE"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"drawingsId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"parties":[{}],"activityId":"string","effectiveDate":"string","productId":"string","currencyId":"string","simulationId":"string","extensions":{},"splitsMerges":[{}]}},"responses":{"200":"createDrawingsRolloversResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"PUT","path":"/holdings/creditAgreements/deals/{dealId}/commitmentIncreases","fullPath":"/api/v7.5.0/holdings/creditAgreements/deals/{dealId}/commitmentIncreases","operationId":"updateDealCommitmentIncreases","name":"User should be able to increase the commitment amount of the existing deal arrangement.","summary":"Increases the commitment amount of the existing deal arrangement.","tags":["CORPORATE"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"dealId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"effectiveDate":"2024-01-01","activityId":"string","externalEventStatus":"string","extensions":{},"dacommitment":[{}]}},"responses":{"200":"createDealCommitmentIncreasesResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"PUT","path":"/holdings/creditAgreements/deals/{dealId}/commitmentDecreases","fullPath":"/api/v7.5.0/holdings/creditAgreements/deals/{dealId}/commitmentDecreases","operationId":"updateDealCommitmentDecreases","name":"User should be able to decrease the commitment amount of the existing deal arrangement","summary":"The commitment amount of the existing deal arrangement can be decreased","tags":["CORPORATE"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"dealId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"effectiveDate":"2024-01-01","activityId":"string","externalEventStatus":"string","extensions":{},"dacommitment":[{}]}},"responses":{"200":"createDealCommitmentDecreasesResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"GET","path":"/holdings/creditAgreements/facilities/{facilityId}/drawdowns/subLimits","fullPath":"/api/v7.5.0/holdings/creditAgreements/facilities/{facilityId}/drawdowns/subLimits","operationId":"getFacilitySubLimits","name":"Retrieve sub limits details for the specific facility arrangement","summary":"Retrieve sub limits details for the specific facility arrangement","tags":["CORPORATE"],"parameters":[{"name":"facilityId","in":"path","type":"string","required":true,"description":"Unique identifier (contract number) of the facility"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"FacilitySubLimitsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"PUT","path":"/holdings/creditAgreements/facilities/{facilityId}/drawdowns/subLimits","fullPath":"/api/v7.5.0/holdings/creditAgreements/facilities/{facilityId}/drawdowns/subLimits","operationId":"updateSubLimits","name":"User should be able to update  the sub limits based on the risk criterion. When restrictions and allocations are regulated based on the risk elements, borrower, currency and product (Product, Product group, and Product line).","summary":"Update sub limits based on the risk criterion","tags":["CORPORATE"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"facilityId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"productId":"string","effectiveDate":"2024-01-01","extensions":{},"sublimits":[{}]}},"responses":{"200":"updateSubLimitsResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"GET","path":"/holdings/creditAgreements/deal/{dealId}/drawings/conditions","fullPath":"/api/v7.5.0/holdings/creditAgreements/deal/{dealId}/drawings/conditions","operationId":"getDealDrawingCondition","name":"Retrieve drawing conditions for the specific deal or facility arrangement","summary":"Retrieve drawing conditions for the specific deal or facility arrangement","tags":["CORPORATE"],"parameters":[{"name":"dealId","in":"path","type":"string","required":true,"description":"Unique identifier (contract number) of the corporate deals"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"DrawingDetailsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"PUT","path":"/holdings/creditAgreements/drawings/{drawingId}/commitmentIncreases","fullPath":"/api/v7.5.0/holdings/creditAgreements/drawings/{drawingId}/commitmentIncreases","operationId":"createDrawdownCommitmentIncrease","name":"To increase the drawdown commitment for a given arrangement","summary":"To increase the drawdown commitment for a given arrangement","tags":["CORPORATE"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"drawingId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"productId":"string","drawdownDate":"2024-01-01","extensions":{},"dwcommitment":[{}]}},"responses":{"200":"createDrawdownCommitmentIncreaseResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"PUT","path":"/holdings/creditAgreements/drawings/{drawingId}/commitmentDecreases","fullPath":"/api/v7.5.0/holdings/creditAgreements/drawings/{drawingId}/commitmentDecreases","operationId":"createDrawdownCommitmentDecreases","name":"To decrease the drawdown commitment for a given arrangement","summary":"To decrease the drawdown commitment for a given arrangement","tags":["CORPORATE"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"drawingId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"productId":"string","drawdownDate":"2024-01-01","extensions":{},"dwcommitment":[{}]}},"responses":{"200":"createDrawdownCommitmentDecreasesResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"PUT","path":"/holdings/creditAgreements/facility/{facilityId}/writeOffs","fullPath":"/api/v7.5.0/holdings/creditAgreements/facility/{facilityId}/writeOffs","operationId":"updateWriteOffBillMaintenance","name":"Perform the write off of all the balances and bills of a loan. Bank calls for the write off of a loan borrowed by a defaulter when the chances of loan recovery are almost zero and its assets are non-performing.","summary":"Writeoff bill balance under facility level","tags":["CORPORATE"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"facilityId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"productId":"string","effectiveDate":"2024-01-01","extensions":{},"balanceMaintenance":[{}]}},"responses":{"200":"updateWriteOffBillMaintenanceResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"PUT","path":"/holdings/creditAgreements/{creditAgreementId}/cancellations","fullPath":"/api/v7.5.0/holdings/creditAgreements/{creditAgreementId}/cancellations","operationId":"cancelFacility","name":"Perform the full credit agreement (facility) cancellation","summary":"Cancel the facility for buy now pay later service","tags":["CORPORATE"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"creditAgreementId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"effectiveDate":"2024-01-01","activityId":"string","externalEventStatus":"string","extensions":{},"account":[{}]}},"responses":{"200":"cancelFacilityResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"POST","path":"/holdings/creditAgreements/buyNowPayLater/facilities","fullPath":"/api/v7.5.0/holdings/creditAgreements/buyNowPayLater/facilities","operationId":"createFacility","name":"Creates corporate facilities","summary":"Creates corporate facilities","tags":["CORPORATE"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"customers":[{}],"productId":"string","currency":"string","effectiveDate":"2024-01-01","dealId":"string","extensions":{},"settlement":[{}],"facommitment":[{}],"upfrontfee":[{}],"coordinationfee":[{}],"limit":[{}]}},"responses":{"200":"createFacilityResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"PUT","path":"/holdings/creditAgreements/{creditAgreementId}/commitmentIncreases","fullPath":"/api/v7.5.0/holdings/creditAgreements/{creditAgreementId}/commitmentIncreases","operationId":"updateFacilityTopupAmount","name":"Increase the commitment amount of the credit agreement (facility) with the incremental amount","summary":"Increase the commitment amount of the facility","tags":["CORPORATE"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"creditAgreementId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"effectiveDate":"2024-01-01","activityId":"string","externalEventStatus":"string","extensions":{},"facommitment":[{}]}},"responses":{"200":"updateFacilityTopupAmountResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"PUT","path":"/holdings/creditAgreements/{creditAgreementId}/commitmentDecreases","fullPath":"/api/v7.5.0/holdings/creditAgreements/{creditAgreementId}/commitmentDecreases","operationId":"updateFacilityDecreaseAmount","name":"Decrease the commitment amount of the credit agreement (facility) by the specified amount","summary":"Decrease the commitment amount of the facility","tags":["CORPORATE"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"creditAgreementId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"effectiveDate":"2024-01-01","activityId":"string","externalEventStatus":"string","extensions":{},"facommitment":[{}]}},"responses":{"200":"updateFacilityDecreaseAmountResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"PUT","path":"/holdings/creditAgreements/{creditAgreementId}/commitmentTerms","fullPath":"/api/v7.5.0/holdings/creditAgreements/{creditAgreementId}/commitmentTerms","operationId":"updateFacilityTerm","name":"Decrease/Increase the maturity period of the facility","summary":"Decrease/ Increase the maturity period of the credit agreement(facility)","tags":["CORPORATE"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"creditAgreementId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"effectiveDate":"2024-01-01","activityId":"string","externalEventStatus":"string","extensions":{},"agentCommission":[{}],"schedule":[{}],"feeschedule":[{}],"facommitment":[{}]}},"responses":{"200":"updateFacilityTermResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"POST","path":"/holdings/creditAgreements/loanTrades/{loanTradeId}/subAllocations","fullPath":"/api/v7.5.0/holdings/creditAgreements/loanTrades/{loanTradeId}/subAllocations","operationId":"allocateTrade","name":"The division of the sold loans by the seller, as advised by the original buyer.","summary":"Allocation of the sold loans among multiple buyers.","tags":["CORPORATE"],"parameters":[{"name":"loanTradeId","in":"path","type":"string","required":true,"description":"Unique identifier generated for each trade booked in  the system."},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"buyerDetails":[{}],"tradeActivity":"string","tradeStatus":"string","extensions":{}}},"responses":{"200":"TradeResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}}]},{"key":"holdings-creditAgreements-api-service-v7.6.0","title":"Corporate Credit Agreements","version":"v7.6.0","description":"API for the creation and management of credit agreements for corporate customers. The types of credit agreements are single level facility, credit agreement with multiple facilities, club loans with agency and syndicated loans","endpointCount":110,"endpoints":[{"method":"POST","path":"/holdings/creditAgreements/deals/offers","fullPath":"/api/v7.6.0/holdings/creditAgreements/deals/offers","operationId":"createDealOffer","name":"Creates new offer deal for the required customer when the mandatory input details are provided. Offer deal creates a draft contract and allows the users to negotiate multiple times. Offer deal is a draft contract and will not affect the balance sheet of the bank.","summary":"Creates an offer for a deal contract","tags":["CORPORATE"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"customers":[{}],"productId":"string","currency":"string","effectiveDate":"2024-01-01","activity":"string","extensions":{},"facilityRules":[{}],"dacommitment":[{}],"adminfee":[{}],"coordinationfee":[{}],"upfrontfee":[{}],"limit":[{}]}},"responses":{"200":"createDealOfferResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"POST","path":"/holdings/creditAgreements/facilities/offers","fullPath":"/api/v7.6.0/holdings/creditAgreements/facilities/offers","operationId":"createFacilityOffer","name":"Creates a new offer facility for the required customer when at least the mandatory input is provided. Offer facility creates a draft contract and allow the users to negotiate multiple times. Offer facility is a draft contract and will not affect the balance sheet of the bank.","summary":"Creates an offer for a facility contract","tags":["CORPORATE"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"customers":[{}],"productId":"string","currency":"string","dealId":"string","effectiveDate":"2024-01-01","activity":"string","extensions":{},"account":[{}],"feeschedule":[{}],"settlement":[{}],"drawingRules":[{}],"facommitment":[{}],"upfrontfee":[{}],"coordinationfee":[{}],"limit":[{}]}},"responses":{"200":"createFacilityOfferResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"POST","path":"/holdings/creditAgreements/deals/offers/cancellations/{arrangementId}","fullPath":"/api/v7.6.0/holdings/creditAgreements/deals/offers/cancellations/{arrangementId}","operationId":"deleteDealOffer","name":"Deletes a new offer for the required deal contract when at least the mandatory input is provided. Deal offer is a draft contract, which allow the user to delete the contract online and deal offer contract will not affect the balance sheet of the bank.","summary":"Deletes an offer for a deal contract","tags":["CORPORATE"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"arrangementId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"productId":"string","effectiveDate":"2024-01-01","extensions":{}}},"responses":{"200":"deleteDealOfferResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"POST","path":"/holdings/creditAgreements/facilities/offers/cancellations/{arrangementId}","fullPath":"/api/v7.6.0/holdings/creditAgreements/facilities/offers/cancellations/{arrangementId}","operationId":"deleteFacilityOffer","name":"Deletes a new offer for the required facility contract when at least the mandatory input is provided. Facility offer is a draft contract, which allow the user to delete the contract online and facility offer contract will not affect the balance sheet of the bank.","summary":"Deletes an offer for a facility contract","tags":["CORPORATE"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"arrangementId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"productId":"string","effectiveDate":"2024-01-01","extensions":{}}},"responses":{"200":"deleteFacilityOfferResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"POST","path":"/holdings/creditAgreements/deals/offers/acceptances/{arrangementId}","fullPath":"/api/v7.6.0/holdings/creditAgreements/deals/offers/acceptances/{arrangementId}","operationId":"acceptDealOffer","name":"On executing acceptance, the contract is changed from offer to live deal for the required customer when at least the mandatory input is provided. Process will check all the required mandatory inputs and prompt an error message when mandatory details are not provided. Once the accept deal offer is processed further offer negotiation is not allowed.","summary":"Accept the deal offer and execute the contract to live","tags":["CORPORATE"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"arrangementId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"productId":"string","effectiveDate":"2024-01-01","extensions":{},"settlement":[{}],"facilityRules":[{}],"dacommitment":[{}],"adminfee":[{}],"coordinationfee":[{}],"upfrontfee":[{}],"limit":[{}]}},"responses":{"200":"acceptDealOfferResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"POST","path":"/holdings/creditAgreements/facilities/offers/acceptances/{arrangementId}","fullPath":"/api/v7.6.0/holdings/creditAgreements/facilities/offers/acceptances/{arrangementId}","operationId":"acceptFacilityOffer","name":"On executing acceptance, the contract is changed from offer to live facility for the required customer when at least the mandatory input is provided. Process will check all the required mandatory inputs and prompt an error message when mandatory details are not provided. Once the accept deal offer is processed further offer negotiation is not allowed.","summary":"Accept the facility offer and execute the contract to live","tags":["CORPORATE"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"arrangementId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"productId":"string","effectiveDate":"2024-01-01","extensions":{},"settlement":[{}],"facommitment":[{}],"upfrontfee":[{}],"coordinationfee":[{}],"limit":[{}]}},"responses":{"200":"acceptFacilityOfferResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"POST","path":"/holdings/creditAgreements/drawdowns/offers","fullPath":"/api/v7.6.0/holdings/creditAgreements/drawdowns/offers","operationId":"createDrawdownOffer","name":"Creates a new drawdown offer for the required customer. ","summary":"Creates a new drawdown offer for the required customer. ","tags":["CORPORATE"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"customers":[{}],"productId":"string","currency":"string","facilityId":"string","offerDate":"2024-01-01","drawdownDate":"2024-01-01","activity":"string","extensions":{},"maintenancefee":[{}],"dwcommitment":[{}],"settlement":[{}]}},"responses":{"200":"createDrawdownOfferResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"POST","path":"/holdings/creditAgreements/drawdowns/offers/negotiations","fullPath":"/api/v7.6.0/holdings/creditAgreements/drawdowns/offers/negotiations","operationId":"createOfferDrawdownRenegotiation","name":"Renegotiate the offer drawdown for the required customer.","summary":"Renegotiate the offer drawdown for the required customer.","tags":["CORPORATE"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"productId":"string","drawdownDate":"2024-01-01","extensions":{},"maintenancefee":[{}],"settlement":[{}]}},"responses":{"200":"createOfferDrawdownRenegotiationResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"POST","path":"/holdings/creditAgreements/drawdowns/offers/cancellations","fullPath":"/api/v7.6.0/holdings/creditAgreements/drawdowns/offers/cancellations","operationId":"deleteDrawdownOffer","name":"Cancellation of offer drawdown for the required customer.","summary":"Cancellation of offer drawdown for the required customer.","tags":["CORPORATE"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"productId":"string","drawdownDate":"2024-01-01","extensions":{}}},"responses":{"200":"deleteDrawdownOfferResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"POST","path":"/holdings/creditAgreements/drawdowns/offers/acceptances","fullPath":"/api/v7.6.0/holdings/creditAgreements/drawdowns/offers/acceptances","operationId":"acceptOfferDrawdown","name":"Convert an offer drawdown to a live drawdown for the required customer.","summary":"Convert an offer drawdown to a live drawdown for the required customer.","tags":["CORPORATE"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"productId":"string","drawdownDate":"2024-01-01","extensions":{},"maintenancefee":[{}],"dwcommitment":[{}],"settlement":[{}]}},"responses":{"200":"acceptOfferDrawdownResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"GET","path":"/holdings/creditAgreements/facilities/{facilityId}/drawingProducts","fullPath":"/api/v7.6.0/holdings/creditAgreements/facilities/{facilityId}/drawingProducts","operationId":"getFacilityDrawingProducts","name":"Retrieves the available drawing products under the facility ","summary":"Retrieves the available drawing products under the facility ","tags":["CORPORATE"],"parameters":[{"name":"facilityId","in":"path","type":"string","required":true,"description":"Unique identifier (contract number) of the facility"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"FacilityDrawingProductsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/creditAgreements/facilities/{facilityId}/combinedSchedules","fullPath":"/api/v7.6.0/holdings/creditAgreements/facilities/{facilityId}/combinedSchedules","operationId":"getCombinedSchedules","name":"Retrieves the payment schedule of facility and its drawings","summary":"Retrieves the payment schedule of facility and its drawings","tags":["CORPORATE"],"parameters":[{"name":"facilityId","in":"path","type":"string","required":true,"description":"Unique identifier (contract number) of the facility"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"CombinedSchedulesResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"POST","path":"/holdings/creditAgreements/facilities","fullPath":"/api/v7.6.0/holdings/creditAgreements/facilities","operationId":"createFacilities","name":"Creates corporate facilities","summary":"Creates corporate facilities","tags":["CORPORATE"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"customers":[{}],"productId":"string","currency":"string","effectiveDate":"2024-01-01","dealId":"string","extensions":{},"settlement":[{}],"facommitment":[{}],"upfrontfee":[{}],"coordinationfee":[{}],"limit":[{}]}},"responses":{"200":"createFacilitiesResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"POST","path":"/holdings/creditAgreements/drawdowns","fullPath":"/api/v7.6.0/holdings/creditAgreements/drawdowns","operationId":"createDrawdowns","name":"Creates drawdowns under facility","summary":"Creates drawdowns under facility","tags":["CORPORATE"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"customers":[{}],"arrangmentId":"string","currency":"string","facilityId":"string","effectiveDate":"string","activity":"string","productId":"string","extensions":{},"escrow":[{}],"schedule":[{}],"dwcommitment":[{}],"settlement":[{}]}},"responses":{"200":"createDrawdownsResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"GET","path":"/holdings/creditAgreements/facilities/{facilityId}/drawingRules","fullPath":"/api/v7.6.0/holdings/creditAgreements/facilities/{facilityId}/drawingRules","operationId":"getFacilityDrawingRules","name":"Retrieves the allowed customers, currencies and products for a new drawing under the facility","summary":"Retrieves the allowed customers, currencies and products for a new drawing under the facility","tags":["CORPORATE"],"parameters":[{"name":"facilityId","in":"path","type":"string","required":true,"description":"Unique identifier (contract number) of the facility"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"FacilityDrawingRulesResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/creditAgreements/facilities/{facilityId}/drawings","fullPath":"/api/v7.6.0/holdings/creditAgreements/facilities/{facilityId}/drawings","operationId":"getDrawingsUnderFacility","name":"Retrieves the drawings under a facility","summary":"Retrieves the drawings under a facility","tags":["CORPORATE"],"parameters":[{"name":"facilityId","in":"path","type":"string","required":true,"description":"Unique identifier (contract number) of the facility"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"DrawingsUnderFacilityResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/creditAgreements/facilities/drawings/{drawingId}/parentFacilities","fullPath":"/api/v7.6.0/holdings/creditAgreements/facilities/drawings/{drawingId}/parentFacilities","operationId":"getDrawingFacility","name":"Retrieves the parent facility for a drawing","summary":"Retrieves the parent facility for a drawing","tags":["CORPORATE"],"parameters":[{"name":"drawingId","in":"path","type":"string","required":true,"description":"Identifier of drawings application under the Letter of Credit system that is used to effect the transfer of funds and the acceptance of documents under Letters of Credit and Documentary Collection tra"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"DrawingFacilityResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/creditAgreements/facilities/{facilityId}/commitmentSchedules","fullPath":"/api/v7.6.0/holdings/creditAgreements/facilities/{facilityId}/commitmentSchedules","operationId":"getFacilityCommitmentSchedule","name":"Retrieves the commitment schedule of a facility","summary":"Retrieves the commitment schedule of a facility","tags":["CORPORATE"],"parameters":[{"name":"facilityId","in":"path","type":"string","required":true,"description":"Unique identifier (contract number) of the facility"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"FacilityCommitmentScheduleResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/creditAgreements/facilities/{facilityId}/parentDeals","fullPath":"/api/v7.6.0/holdings/creditAgreements/facilities/{facilityId}/parentDeals","operationId":"getFacilityDeal","name":"Retrieves the parent deal for a facility","summary":"Retrieves the parent deal for a facility","tags":["CORPORATE"],"parameters":[{"name":"facilityId","in":"path","type":"string","required":true,"description":"Unique identifier (contract number) of the facility"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"FacilityDealResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/creditAgreements/facilities/{facilityId}/balances","fullPath":"/api/v7.6.0/holdings/creditAgreements/facilities/{facilityId}/balances","operationId":"getFacilityFinancialSummary","name":"Retrieves the financial summary for a facility arrangement","summary":"Retrieves the financial summary for a facility arrangement","tags":["CORPORATE"],"parameters":[{"name":"facilityId","in":"path","type":"string","required":true,"description":"Unique identifier (contract number) of the facility"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"FacilityFinancialSummaryResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/creditAgreements/facilities/{facilityId}/consolidatedBalances","fullPath":"/api/v7.6.0/holdings/creditAgreements/facilities/{facilityId}/consolidatedBalances","operationId":"getFacilityConsolidatedBalances","name":"Retrieves the consolidated balances for a facility arrangement","summary":"Retrieves the consolidated balances for a facility arrangement","tags":["CORPORATE"],"parameters":[{"name":"facilityId","in":"path","type":"string","required":true,"description":"Unique identifier (contract number) of the facility"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"FacilityConsolidatedBalancesResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"POST","path":"/holdings/creditAgreements/facilities/directDebits","fullPath":"/api/v7.6.0/holdings/creditAgreements/facilities/directDebits","operationId":"createFacilityDirectDebitLink","name":"Links a direct debit to an existing facility","summary":"Links a direct debit to a facility","tags":["CORPORATE"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"customers":[{}],"arrangement":"string","productId":"string","currency":"string","effectiveDate":"2024-01-01","extensions":{},"settlement":[{}]}},"responses":{"200":"createFacilityDirectDebitLinkResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"POST","path":"/holdings/creditAgreements/facilities/drawings/directDebits","fullPath":"/api/v7.6.0/holdings/creditAgreements/facilities/drawings/directDebits","operationId":"createDrawingDirectDebitLink","name":"Link the direct debit to an existing drawing under a facility","summary":"Links a direct debit to a drawing","tags":["CORPORATE"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"customers":[{}],"arrangement":"string","currency":"string","facilityId":"string","effectiveDate":"string","productId":"string","extensions":{},"settlement":[{}]}},"responses":{"200":"createDrawingDirectDebitLinkResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"POST","path":"/holdings/creditAgreements/facilities/rollovers/offers","fullPath":"/api/v7.6.0/holdings/creditAgreements/facilities/rollovers/offers","operationId":"createFacilityRolloverOffer","name":"Create rollover process from the facility where the rollover could be a split rollover, merge rollover or a one to one rollover. Split also called as one to many will rollover an old loan and create multiple new offer loans. Merge also called as many to one will rollover multiple old loans simultaneously and create a single new offer loan. Rollover also called as one to one will simply rollover an old loan and create a new offer loan","summary":"Create rollover offer from facility","tags":["CORPORATE"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"arrangement":"string","rolloverDate":"string","productId":"string","extensions":{},"splitsMerges":[{}]}},"responses":{"200":"createFacilityRolloverOfferResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"POST","path":"/holdings/creditAgreements/drawdowns/rollovers/offers","fullPath":"/api/v7.6.0/holdings/creditAgreements/drawdowns/rollovers/offers","operationId":"createDrawdownRolloverOffer","name":"Create rollover process from the drawdown where the rollover could be a split rollover, merge rollover or a one to one rollover. Split also called as one to many will rollover an old loan and create multiple new offer loans. Merge also called as many to one will rollover multiple old loans simultaneously and create a single new offer loan. Rollover also called as one to one will simply rollover an old loan and create a new offer loan","summary":"Create rollover offer from drawdown","tags":["CORPORATE"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"arrangement":"string","rolloverDate":"string","productId":"string","extensions":{},"splitsMerges":[{}]}},"responses":{"200":"createDrawdownRolloverOfferResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"POST","path":"/holdings/creditAgreements/facilities/commitmentIncreases/{arrangementId}","fullPath":"/api/v7.6.0/holdings/creditAgreements/facilities/commitmentIncreases/{arrangementId}","operationId":"updateFacilityCommitmentIncrease","name":"Increase the facility amount to facilitate further drawdowns","summary":"Increase facility amount","tags":["CORPORATE"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"arrangementId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"productId":"string","effectiveDate":"2024-01-01","extensions":{},"facommitment":[{}]}},"responses":{"200":"updateFacilityCommitmentIncreaseResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"POST","path":"/holdings/creditAgreements/facilities/commitmentTerms/{arrangementId}","fullPath":"/api/v7.6.0/holdings/creditAgreements/facilities/commitmentTerms/{arrangementId}","operationId":"updateFacilityCommitmentTerms","name":"Updates facility tenure by increasing or decreasing the term, in addition it allows the amendment of the availability schedule of the contract.","summary":"Update facility maturity date and availability","tags":["CORPORATE"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"arrangementId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"productId":"string","effectiveDate":"2024-01-01","extensions":{},"facommitment":[{}]}},"responses":{"200":"updateFacilityCommitmentTermsResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"GET","path":"/holdings/customers/{customerId}/creditAgreements/exposures","fullPath":"/api/v7.6.0/holdings/customers/{customerId}/creditAgreements/exposures","operationId":"getCustomerExposure","name":"Retrieves the customer exposure such as the facility number, type of facility, maturity date and various amounts of the facilities/standalone loans.","summary":"Retrieves the customer exposure for facilities and loans","tags":["CORPORATE"],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"Identifier of the customer"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"CustomerExposureResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/customers/{customerId}/creditAgreements/drawings","fullPath":"/api/v7.6.0/holdings/customers/{customerId}/creditAgreements/drawings","operationId":"getCustomerDrawings","name":"Retrieves the details such as the drawing id, account number, short description of the loan, customer name and loan status for a customer. ","summary":"Retrieves the drawing details for a customer.","tags":["CORPORATE"],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":""},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"CustomerDrawingsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/customers/{customerId}/creditAgreements/facilities","fullPath":"/api/v7.6.0/holdings/customers/{customerId}/creditAgreements/facilities","operationId":"getCustomerFacilities","name":"Retrieves the details such as the facility id, account number, short description of the facility, customer name and facility status for a customer.","summary":"Retrieves the facility details for a customer.","tags":["CORPORATE"],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"Identifier of the customer"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"CustomerFacilitiesResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/customers/{customerId}/creditAgreements/deals","fullPath":"/api/v7.6.0/holdings/customers/{customerId}/creditAgreements/deals","operationId":"getCustomerDeals","name":"Retrieves the details such as the deal id, account number, short description of the facility, customer name and deal status for a customer.","summary":"Retrieves the deal details for a customer.","tags":["CORPORATE"],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"Identifier of the customer"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"CustomerDealsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/creditAgreements/deals/{dealId}/facilities","fullPath":"/api/v7.6.0/holdings/creditAgreements/deals/{dealId}/facilities","operationId":"getFacilitiesUnderDeal","name":"Retrieves the details such as facility id, title, currency, status and commitment amount for all the facilities under a deal.","summary":"Retrieves the details of facilities under a deal.","tags":["CORPORATE"],"parameters":[{"name":"dealId","in":"path","type":"string","required":true,"description":"Unique identifier (contract number) of the corporate deals"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"FacilitiesUnderDealResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/creditAgreements/productCatalogues","fullPath":"/api/v7.6.0/holdings/creditAgreements/productCatalogues","operationId":"getCreditAgreementsProductCatalogue","name":"Retrieves the list of available products for credit agreements.","summary":"Retrieves the credit agreements product catalogue.","tags":["CORPORATE"],"parameters":[{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"CreditAgreementsProductCatalogueResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/creditAgreements/drawings/{drawingId}/pendingActivities","fullPath":"/api/v7.6.0/holdings/creditAgreements/drawings/{drawingId}/pendingActivities","operationId":"getPendingActivities","name":"Retrieves the details such as rollover date, rollover status etc of pending drawdowns and rollovers for a drawing.","summary":"Retrieves the details of pending drawdowns and rollovers for a drawing.","tags":["CORPORATE"],"parameters":[{"name":"drawingId","in":"path","type":"string","required":true,"description":"Identifier of drawings application under the Letter of Credit system that is used to effect the transfer of funds and the acceptance of documents under Letters of Credit and Documentary Collection tra"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"PendingActivitiesResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/creditAgreements/drawings/expiries","fullPath":"/api/v7.6.0/holdings/creditAgreements/drawings/expiries","operationId":"getLoansExpiring","name":"Retrieves the drawings expiring in the next 7 days.","summary":"Retrieves expiring drawings.","tags":["CORPORATE"],"parameters":[{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"LoansExpiringResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/creditAgreements/facilities/expiries","fullPath":"/api/v7.6.0/holdings/creditAgreements/facilities/expiries","operationId":"getFacilitiesExpiring","name":"Retrieves the facilities expiring in the next 7 days","summary":"Retrieves expiring facilities","tags":["CORPORATE"],"parameters":[{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"FacilitiesExpiringResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/creditAgreements/drawings/{drawingId}/balances","fullPath":"/api/v7.6.0/holdings/creditAgreements/drawings/{drawingId}/balances","operationId":"getDrawingBalances","name":"Retrieves the balance details such as commitment balances, utilized balances.","summary":"Retrieves drawing balances","tags":["CORPORATE"],"parameters":[{"name":"drawingId","in":"path","type":"string","required":true,"description":"Identifier of drawings application under the Letter of Credit system that is used to effect the transfer of funds and the acceptance of documents under Letters of Credit and Documentary Collection tra"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"DrawingBalancesResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/creditAgreements/drawings/{drawingId}/OverdueBalances","fullPath":"/api/v7.6.0/holdings/creditAgreements/drawings/{drawingId}/OverdueBalances","operationId":"getDrawingOverdueBalances","name":"Retrieves the past dues and overdues for a drawing","summary":"Retrieves drawing overdue balances","tags":["CORPORATE"],"parameters":[{"name":"drawingId","in":"path","type":"string","required":true,"description":"Identifier of drawings application under the Letter of Credit system that is used to effect the transfer of funds and the acceptance of documents under Letters of Credit and Documentary Collection tra"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"DrawingOverdueBalancesResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/creditAgreements/facilities/clubFacilities","fullPath":"/api/v7.6.0/holdings/creditAgreements/facilities/clubFacilities","operationId":"getClubFacilities","name":"Retrieves club facilities, drawings and deal","summary":"Retrieves club facilities, drawings and deal","tags":["CORPORATE"],"parameters":[{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"ClubFacilitiesResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"POST","path":"/holdings/creditAgreements/facilities/clubFacilities","fullPath":"/api/v7.6.0/holdings/creditAgreements/facilities/clubFacilities","operationId":"createClubFacilities","name":"Creates a club facility with facility details along with the details of participating lenders","summary":"Creates a club facility","tags":["CORPORATE"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"customers":[{}],"productId":"string","currency":"string","effectiveDate":"2024-01-01","extensions":{},"account":[{}],"settlement":[{}],"facommitment":[{}],"upfrontfee":[{}],"coordinationfee":[{}],"limit":[{}],"participant":[{}],"riskparticipant":[{}]}},"responses":{"200":"createClubFacilitiesResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"POST","path":"/holdings/creditAgreements/facilities/drawings/clubDrawings","fullPath":"/api/v7.6.0/holdings/creditAgreements/facilities/drawings/clubDrawings","operationId":"createClubDrawings","name":"Creates a club drawing arrangement with drawdown details along with the details of participating lenders","summary":"Creates a club drawing","tags":["CORPORATE"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"customers":[{}],"arrangmentId":"string","currency":"string","facilityId":"string","effectiveDate":"string","activity":"string","productId":"string","extensions":{},"account":[{}],"escrow":[{}],"dwcommitment":[{}],"settlement":[{}],"participant":[{}],"riskparticipant":[{}]}},"responses":{"200":"createClubDrawingsResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"GET","path":"/holdings/creditAgreements/facilities/drawings/{drawingId}/participants","fullPath":"/api/v7.6.0/holdings/creditAgreements/facilities/drawings/{drawingId}/participants","operationId":"getClubDrawingParticipants","name":"Retrieves the participation details of the lending arrangement for a customer. This will be used to view the agent bank and the participant details and the share amounts when an arrangement id is passed as an input.","summary":"Retrieves the participant details","tags":["CORPORATE"],"parameters":[{"name":"drawingId","in":"path","type":"string","required":true,"description":"Identifier of drawings application under the Letter of Credit system that is used to effect the transfer of funds and the acceptance of documents under Letters of Credit and Documentary Collection tra"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"ClubDrawingParticipantsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"POST","path":"/holdings/creditAgreements/facilities/{facilityId}/fundedShareTransfers","fullPath":"/api/v7.6.0/holdings/creditAgreements/facilities/{facilityId}/fundedShareTransfers","operationId":"createFacilityFundedShareTransfer","name":"Creates a funded share transfer for a facility when participant details are passed. Share of a funding participant is transferred to another funding participant in a club facility and underlying drawings","summary":"Creates a funded share transfer for a facility","tags":["CORPORATE"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"facilityId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"productId":"string","effectiveDate":"2024-01-01","extensions":{},"shareTransfer":[{}]}},"responses":{"200":"createFacilityFundedShareTransferResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"POST","path":"/holdings/creditAgreements/facilities/drawings/{drawingId}/fundedShareTransfers","fullPath":"/api/v7.6.0/holdings/creditAgreements/facilities/drawings/{drawingId}/fundedShareTransfers","operationId":"createDrawingFundedShareTransfer","name":"Creates a funded share transfer for a drawing under a facility when participant details are passed. Share of a funding participant is transferred to another funding participant in a standalone club loan","summary":"Creates a funded share transfer for a drawing","tags":["CORPORATE"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"drawingId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"productId":"string","effectiveDate":"2024-01-01","extensions":{},"shareTransfer":[{}]}},"responses":{"200":"createDrawingFundedShareTransferResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"POST","path":"/holdings/creditAgreements/facilities/{facilityId}/riskShareTransfers","fullPath":"/api/v7.6.0/holdings/creditAgreements/facilities/{facilityId}/riskShareTransfers","operationId":"createFacilityRiskShareTransfer","name":"Creates a risk share transfer for a facility when participant details are passed. The risk of the own bank in a facility is mitigated by selling a portion risk to another financial institution","summary":"Creates a risk share transfer for a facility","tags":["CORPORATE"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"facilityId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"productId":"string","effectiveDate":"2024-01-01","extensions":{},"shareTransfer":[{}]}},"responses":{"200":"createFacilityRiskShareTransferResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"POST","path":"/holdings/creditAgreements/facilities/drawings/{drawingId}/riskShareTransfers","fullPath":"/api/v7.6.0/holdings/creditAgreements/facilities/drawings/{drawingId}/riskShareTransfers","operationId":"createDrawingRiskShareTransfer","name":"Creates a risk share transfer for a drawing under a facility when participant details are passed. The risk of the own bank in a loan is mitigated by selling a portion risk to another financial institution","summary":"Creates a risk share transfer for a drawing","tags":["CORPORATE"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"drawingId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"productId":"string","effectiveDate":"2024-01-01","extensions":{},"shareTransfer":[{}]}},"responses":{"200":"createDrawingRiskShareTransferResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"POST","path":"/holdings/creditAgreements/guarantees/{guaranteeId}/guaranteeIncreases","fullPath":"/api/v7.6.0/holdings/creditAgreements/guarantees/{guaranteeId}/guaranteeIncreases","operationId":"updateGuaranteeCommitmentIncrease","name":"Increase the commitment amount of the guarantee that the financial institution has issued on behalf of the applicant","summary":"Increase the commitment amount of the guarantee","tags":["CORPORATE"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"guaranteeId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"productId":"string","effectiveDate":"2024-01-01","extensions":{},"gteecommitment":[{}]}},"responses":{"200":"updateGuaranteeCommitmentIncreaseResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"POST","path":"/holdings/creditAgreements/guarantees/{guaranteeId}/guaranteeDecreases","fullPath":"/api/v7.6.0/holdings/creditAgreements/guarantees/{guaranteeId}/guaranteeDecreases","operationId":"updateGuaranteeCommitmentDecrease","name":"Decrease the commitment amount of the guarantee that the financial institution has issued on behalf of the applicant","summary":"Decrease the commitment amount of the guarantee","tags":["CORPORATE"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"guaranteeId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"productId":"string","effectiveDate":"2024-01-01","extensions":{},"gteecommitment":[{}]}},"responses":{"200":"updateGuaranteeCommitmentDecreaseResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"POST","path":"/holdings/creditAgreements/guarantees","fullPath":"/api/v7.6.0/holdings/creditAgreements/guarantees","operationId":"createCreditAgreementGuarantee","name":"Register the issuance of a new guarantee undertaking on behalf of the applicant when all the basic details relevant to the undertaking are passed","summary":"Register the issuance of a guarantee","tags":["CORPORATE"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"customers":[{}],"productId":"string","currency":"string","effectiveDate":"2024-01-01","facilityId":"string","extensions":{},"gteecommitment":[{}],"newarrfee":[{}],"settlement":[{}],"termsConditions":[{}]}},"responses":{"200":"createCreditAgreementGuaranteeResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"POST","path":"/holdings/creditAgreements/guarantees/clubGuarantees","fullPath":"/api/v7.6.0/holdings/creditAgreements/guarantees/clubGuarantees","operationId":"createClubGuarantee","name":"Create a club guarantee with guarantee details along with the details of participating lenders","summary":"Create a club guarantee","tags":["CORPORATE"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"customers":[{}],"productId":"string","currency":"string","effectiveDate":"2024-01-01","facilityId":"string","extensions":{},"account":[{}],"gteecommitment":[{}],"newarrfee":[{}],"settlement":[{}],"termsConditions":[{}],"participant":[{}]}},"responses":{"200":"createClubGuaranteeResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"POST","path":"/holdings/creditAgreements/guarantees/{guaranteeId}/cancellations","fullPath":"/api/v7.6.0/holdings/creditAgreements/guarantees/{guaranteeId}/cancellations","operationId":"cancelCorporateGuarantee","name":"Cancel a guarantee arrangement before its expiry date. All the accrued fees are made-due for collection and the bank is discharged of its liability.","summary":"Cancel a guarantee arrangement before the expiry date.","tags":["CORPORATE"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"guaranteeId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"productId":"string","effectiveDate":"2024-01-01","extensions":{},"settlement":[{}]}},"responses":{"200":"cancelCorporateGuaranteeResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"POST","path":"/holdings/creditAgreements/deals","fullPath":"/api/v7.6.0/holdings/creditAgreements/deals","operationId":"createDeals","name":"Create a new deal for the customer with the details like product, term and amount . Corporate deal is a credit agreement between two parties- the lender and the borrower, who agree to certain terms and conditions along with their rights and obligations","summary":"Creates corporate deal","tags":["CORPORATE"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"customers":[{}],"productId":"string","currency":"string","effectiveDate":"2024-01-01","extensions":{},"settlement":[{}],"facilityRules":[{}],"dacommitment":[{}],"adminfee":[{}],"coordinationfee":[{}],"upfrontfee":[{}],"limit":[{}]}},"responses":{"200":"createDealsResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"POST","path":"/holdings/creditAgreements/loanTrades/trades","fullPath":"/api/v7.6.0/holdings/creditAgreements/loanTrades/trades","operationId":"createTrade","name":"Create a trade for a syndicated loan as initially agreed upon between counterparties.","summary":"Create a trade for a syndicated loan.","tags":["CORPORATE"],"parameters":[{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"counterPartyDetails":[{}],"dealCustomerDetails":[{}],"dealAdditionalInfo":[{}],"ssi":[{}],"ownBankDetails":[{}],"agentBankDetails":[{}],"consentDetails":[{}],"chargeDetails":[{}],"tradeAccountDetails":[{}],"tradeActivity":"string","alternateId":"string","tradeProduct":"string","tradeDate":"string","tradeCurrency":"string","transferType":"string"}},"responses":{"200":"TradeResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"POST","path":"/holdings/creditAgreements/loanTrades/{loanTradeId}/confirmationTrade","fullPath":"/api/v7.6.0/holdings/creditAgreements/loanTrades/{loanTradeId}/confirmationTrade","operationId":"acceptTrade","name":"Confirm the trade when all the parties involved agreed the terms and conditions of the trade.","summary":"Confirm the trade","tags":["CORPORATE"],"parameters":[{"name":"loanTradeId","in":"path","type":"string","required":true,"description":""},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"dealCustomerDetails":[{}],"dealAdditionalinfos":[{}],"dealReference":"string","dealTitle":"string","currency":"string","globalAmount":"string","startDate":"string","agentBank":"string","agentId":"string","agentName":"string","extensions":{}}},"responses":{"200":"TradeResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"POST","path":"/holdings/creditAgreements/loanTrades/{loanTradeId}","fullPath":"/api/v7.6.0/holdings/creditAgreements/loanTrades/{loanTradeId}","operationId":"updateTrade","name":"Update additional details in trade.","summary":"Update trade details","tags":["CORPORATE"],"parameters":[{"name":"loanTradeId","in":"path","type":"string","required":true,"description":""},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"dealCustomerDetails":[{}],"dealAdditionalInfo":[{}],"ssi":[{}],"ownBankDetails":[{}],"agentBankDetails":[{}],"chargeDetails":[{}],"tradeAccountDetails":[{}],"alternateId":"string","transferType":"string","expectedSettlementDate":"string","tradeNotes":"string","businessDayCentre":"string","dealReference":"string","dealTitle":"string","currency":"string"}},"responses":{"200":"TradeResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"POST","path":"/holdings/creditAgreements/loanTrades/{loanTradeId}/consents","fullPath":"/api/v7.6.0/holdings/creditAgreements/loanTrades/{loanTradeId}/consents","operationId":"updateConsent","name":"Update borrower consent for trade","summary":"Update consent status if borrower has agreed or rejected trade.","tags":["CORPORATE"],"parameters":[{"name":"loanTradeId","in":"path","type":"string","required":true,"description":""},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"consentDetails":[{}],"chargeDetails":[{}],"tradeStatus":"string","extensions":{}}},"responses":{"200":"ConsentResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"POST","path":"/holdings/creditAgreements/loanTrades/{loanTradeId}/commitments","fullPath":"/api/v7.6.0/holdings/creditAgreements/loanTrades/{loanTradeId}/commitments","operationId":"updateCommitment","name":"Update the trade due to changes in commitment amount being traded.","summary":"Update commitment details","tags":["CORPORATE"],"parameters":[{"name":"loanTradeId","in":"path","type":"string","required":true,"description":""},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"chargeDetails":[{}],"tradeAccountDetails":[{}],"amount":"string","expectedSettlementDate":"string","actualSettlementDate":"string","tradePrice":"string","settlementMethod":"string","allowNetback":"string","allowBoCR":"string","extensions":{}}},"responses":{"200":"CommitmentResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"POST","path":"/holdings/creditAgreements/loanTrades/{loanTradeId}/acceptances","fullPath":"/api/v7.6.0/holdings/creditAgreements/loanTrades/{loanTradeId}/acceptances","operationId":"approveTrade","name":"Finalize the trade to verify all necessary details are available.","summary":"Finalize the trade to issue pricing letter.","tags":["CORPORATE"],"parameters":[{"name":"loanTradeId","in":"path","type":"string","required":true,"description":""},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"dealCustomerDetails":[{}],"dealAdditionalInfo":[{}],"ssi":[{}],"ownBankDetails":[{}],"agentBankDetails":[{}],"tradeNotes":"string","dealReference":"string","dealTitle":"string","currency":"string","globalAmount":"string","startDate":"string","agentBank":"string","agentId":"string","agentName":"string","extensions":{}}},"responses":{"200":"TradeResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"POST","path":"/holdings/creditAgreements/loanTrades/{loanTradeId}/messages","fullPath":"/api/v7.6.0/holdings/creditAgreements/loanTrades/{loanTradeId}/messages","operationId":"showPricingLetter","name":"Issue pricing letter to the counter party for a final settlement amount.","summary":"Issue pricing letter to counterparty.","tags":["CORPORATE"],"parameters":[{"name":"loanTradeId","in":"path","type":"string","required":true,"description":""},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"extensions":{}}},"responses":{"200":"PricingLetterResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"POST","path":"/holdings/creditAgreements/loanTrades/{loanTradeId}/settlements","fullPath":"/api/v7.6.0/holdings/creditAgreements/loanTrades/{loanTradeId}/settlements","operationId":"calculateTrade","name":"Settle the trade in bank books.","summary":"Settle trade.","tags":["CORPORATE"],"parameters":[{"name":"loanTradeId","in":"path","type":"string","required":true,"description":""},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"issuePricing":"string","tradeNotes":"string","extensions":{}}},"responses":{"200":"TradeResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"POST","path":"/holdings/creditAgreements/loanTrades/{loanTradeId}/cancellations","fullPath":"/api/v7.6.0/holdings/creditAgreements/loanTrades/{loanTradeId}/cancellations","operationId":"cancelTrade","name":"Cancel the trade in bank books.","summary":"Cancel trade.","tags":["CORPORATE"],"parameters":[{"name":"loanTradeId","in":"path","type":"string","required":true,"description":""},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"tradeNotes":"string","extensions":{}}},"responses":{"200":"TradeResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/holdings/creditAgreements/loanTrades/{loanTradeId}/charges","fullPath":"/api/v7.6.0/holdings/creditAgreements/loanTrades/{loanTradeId}/charges","operationId":"getCharges","name":"View all the charge details for a given trade.","summary":"View charges.","tags":["CORPORATE"],"parameters":[{"name":"loanTradeId","in":"path","type":"string","required":true,"description":""},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"ChargesResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"PUT","path":"/holdings/creditAgreements/loanTrades/{loanTradeId}/charges","fullPath":"/api/v7.6.0/holdings/creditAgreements/loanTrades/{loanTradeId}/charges","operationId":"updateCharges","name":"Amend charges already authorized in the trade","summary":"Amend charges.","tags":["CORPORATE"],"parameters":[{"name":"loanTradeId","in":"path","type":"string","required":true,"description":""},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"chargeDetails":[{}],"extensions":{}}},"responses":{"200":"ChargesResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/holdings/creditAgreements/loanTrades/products","fullPath":"/api/v7.6.0/holdings/creditAgreements/loanTrades/products","operationId":"getTradeProducts","name":"View all the trade products","summary":"View trade products","tags":["CORPORATE"],"parameters":[{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"TradeProductsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"PUT","path":"/holdings/creditAgreements/facilities/{facilityId}/coordinationFees","fullPath":"/api/v7.6.0/holdings/creditAgreements/facilities/{facilityId}/coordinationFees","operationId":"updateFacilityCoordinationFees","name":"Updation of coordination fees Indicates the fees collected from the borrower to pay to its participants in facility","summary":"Update coordination fees to pay the fee to its participants in facility","tags":["CORPORATE"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"facilityId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"productId":"string","effectiveDate":"2024-01-01","extensions":{},"coordinationfee":[{}]}},"responses":{"200":"updateFacilityCoordinationFeesResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"PUT","path":"/holdings/creditAgreements/facilities/{facilityId}/upfrontFees","fullPath":"/api/v7.6.0/holdings/creditAgreements/facilities/{facilityId}/upfrontFees","operationId":"updateFacilityUpfrontFees","name":"It is a common fee charged by lenders when you apply for a loan, it covers the costs of processing your application, including things like administrative costs, credit assessment, loan set-up and document preparation etc.","summary":"Update the upfront fee which is collect one time by bank","tags":["CORPORATE"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"facilityId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"productId":"string","effectiveDate":"2024-01-01","extensions":{},"upfrontfee":[{}]}},"responses":{"200":"updateFacilityUpfrontFeesResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"PUT","path":"/holdings/creditAgreements/facilities/{facilityId}/drawdowns/rules","fullPath":"/api/v7.6.0/holdings/creditAgreements/facilities/{facilityId}/drawdowns/rules","operationId":"UpdateFacilityDrawingRules","name":"Drawing rules such as Borrower, currency, product and product group are defned for drawdown under facility level.","summary":"Initiate drawing rules to restrict customer, currency and products for drawdown under facility level.","tags":["CORPORATE"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"facilityId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"productId":"string","effectiveDate":"2024-01-01","extensions":{},"drawingRules":[{}]}},"responses":{"200":"UpdateFacilityDrawingRulesResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"PUT","path":"/holdings/creditAgreements/facilities/{facilityId}/drawdowns/conditions","fullPath":"/api/v7.6.0/holdings/creditAgreements/facilities/{facilityId}/drawdowns/conditions","operationId":"updateFacilityDrawingConditions","name":"Drawing condition are set based on the product line, product group, product, property, currency, attribute, value, message for drawdown under facility level.","summary":"Initiate drawing condition to restrict customer, currency and products for drawdown with overrides.","tags":["CORPORATE"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"facilityId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"productId":"string","effectiveDate":"2024-01-01","extensions":{},"drawingConditions":[{}]}},"responses":{"200":"updateFacilityDrawingConditionsResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"PUT","path":"/holdings/creditAgreements/deals/{dealId}/commitmentAndTermBlock","fullPath":"/api/v7.6.0/holdings/creditAgreements/deals/{dealId}/commitmentAndTermBlock","operationId":"UpdateBlockcommitmentandTerm","name":"Existing deal level commitment term is blocked","summary":"Block the commitment and term of the existing deal arrangement.","tags":["CORPORATE"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"dealId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"parties":[{}],"activityId":"string","effectiveDate":"string","productId":"string","currencyId":"string","simulationId":"string","extensions":{}}},"responses":{"200":"UpdateBlockcommitmentandTermResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"PUT","path":"/holdings/creditAgreements/deals/{dealId}/commitmentAndTermUnblock","fullPath":"/api/v7.6.0/holdings/creditAgreements/deals/{dealId}/commitmentAndTermUnblock","operationId":"UpdateUnblockcommitmentandTerm","name":"Existing deal level commitment term is unblocked","summary":"Unblock the commitment and term of the existing deal arrangement.","tags":["CORPORATE"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"dealId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"parties":[{}],"activityId":"string","effectiveDate":"string","productId":"string","currencyId":"string","simulationId":"string","extensions":{}}},"responses":{"200":"UpdateUnblockcommitmentandTermResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"PUT","path":"/holdings/creditAgreements/deals/{dealId}/commitmentTerms","fullPath":"/api/v7.6.0/holdings/creditAgreements/deals/{dealId}/commitmentTerms","operationId":"updateDealCommitmentTerms","name":"Deal tenure can be increased or decreased","summary":"Update tenure by increasing or decreasing the term in deal level","tags":["CORPORATE"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"dealId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"productId":"string","effectiveDate":"2024-01-01","extensions":{},"dacommitment":[{}]}},"responses":{"200":"updateDealCommitmentTermsResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"PUT","path":"/holdings/creditAgreements/facilities/{facilityId}/scheduleDefinitions","fullPath":"/api/v7.6.0/holdings/creditAgreements/facilities/{facilityId}/scheduleDefinitions","operationId":"updateFacilityPaymentSchedules","name":"Allow user to change schedule condition in facility level.","summary":"User to change schedule condition in facility level.","tags":["CORPORATE"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"facilityId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"productId":"string","effectiveDate":"2024-01-01","extensions":{},"schedule":[{}],"feeschedule":[{}]}},"responses":{"200":"updateFacilityPaymentSchedulesResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"PUT","path":"/holdings/creditAgreements/facilities/{facilityId}/participants","fullPath":"/api/v7.6.0/holdings/creditAgreements/facilities/{facilityId}/participants","operationId":"updateparticipant","name":"Update participant settlement instructions, skims, charges, own bank account details, agent bank beneficiary details and trading details.","summary":"Update participant settlement instructions, skims, charges, own bank account details, agent bank beneficiary details and trading details.","tags":["CORPORATE"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"facilityId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"productId":"string","effectiveDate":"2024-01-01","extensions":{},"participant":[{}]}},"responses":{"200":"updateparticipantResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"PUT","path":"/holdings/creditAgreements/facility/{facilityId}/adjustments","fullPath":"/api/v7.6.0/holdings/creditAgreements/facility/{facilityId}/adjustments","operationId":"initiateAdjustmets","name":"Bill balances  such as commitment balance, principal or interest or charge amount of facility should be adjusted","summary":"Perform adjust balances and bills such as commitment balance, principal or interest or charge amount of facility","tags":["CORPORATE"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"facilityId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"productId":"string","effectiveDate":"2024-01-01","extensions":{},"balanceMaintenance":[{}]}},"responses":{"200":"initiateAdjustmetsResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"PUT","path":"/holdings/creditAgreements/facilities/{facilityId}/commitmentAndTermBlock","fullPath":"/api/v7.6.0/holdings/creditAgreements/facilities/{facilityId}/commitmentAndTermBlock","operationId":"updateBlockFacilityCommitment","name":"There could be adverse credit rating of the customer as part of the periodic review and bank would like to restrict further credit exposure. In such cases when the facility is blocked further drawdowns are not allowed while the existing drawings can be serviced.","summary":"When the facility is blocked further drawdowns are not allowed while the existing drawings can be serviced.","tags":["CORPORATE"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"facilityId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"parties":[{}],"activityId":"string","effectiveDate":"string","productId":"string","currencyId":"string","simulationId":"string","extensions":{}}},"responses":{"200":"updateBlockFacilityCommitmentResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"PUT","path":"/holdings/creditAgreements/facilities/{facilityId}/commitmentAndTermUnblock","fullPath":"/api/v7.6.0/holdings/creditAgreements/facilities/{facilityId}/commitmentAndTermUnblock","operationId":"updateUnblockFacilityCommitment","name":"There could be adverse credit rating of the customer as part of the periodic review and bank would have restricted further credit exposure and stipulated some mitigants to be fulfilled by customer based on which the restrictions on credit exposure can be lifted. This API is used to unblock the facility commitment.","summary":"Update unblock facility commitment is used to unblock the blocked commitment.","tags":["CORPORATE"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"facilityId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"parties":[{}],"activityId":"string","effectiveDate":"string","productId":"string","currencyId":"string","simulationId":"string","extensions":{}}},"responses":{"200":"updateUnblockFacilityCommitmentResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"PUT","path":"/holdings/creditAgreements/drawings/{drawingsId}/rolloverType","fullPath":"/api/v7.6.0/holdings/creditAgreements/drawings/{drawingsId}/rolloverType","operationId":"createDrawingsRollovers","name":"Splits/Merge/Rollover in Drawings level","summary":"Splits/Merge/Rollover a drawings into many drawings","tags":["CORPORATE"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"drawingsId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"parties":[{}],"activityId":"string","effectiveDate":"string","productId":"string","currencyId":"string","simulationId":"string","extensions":{},"splitsMerges":[{}]}},"responses":{"200":"createDrawingsRolloversResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"PUT","path":"/holdings/creditAgreements/deals/{dealId}/commitmentIncreases","fullPath":"/api/v7.6.0/holdings/creditAgreements/deals/{dealId}/commitmentIncreases","operationId":"updateDealCommitmentIncreases","name":"User should be able to increase the commitment amount of the existing deal arrangement.","summary":"Increases the commitment amount of the existing deal arrangement.","tags":["CORPORATE"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"dealId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"effectiveDate":"2024-01-01","activityId":"string","externalEventStatus":"string","extensions":{},"dacommitment":[{}]}},"responses":{"200":"createDealCommitmentIncreasesResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"PUT","path":"/holdings/creditAgreements/deals/{dealId}/commitmentDecreases","fullPath":"/api/v7.6.0/holdings/creditAgreements/deals/{dealId}/commitmentDecreases","operationId":"updateDealCommitmentDecreases","name":"User should be able to decrease the commitment amount of the existing deal arrangement","summary":"The commitment amount of the existing deal arrangement can be decreased","tags":["CORPORATE"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"dealId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"effectiveDate":"2024-01-01","activityId":"string","externalEventStatus":"string","extensions":{},"dacommitment":[{}]}},"responses":{"200":"createDealCommitmentDecreasesResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"GET","path":"/holdings/creditAgreements/facilities/{facilityId}/drawdowns/subLimits","fullPath":"/api/v7.6.0/holdings/creditAgreements/facilities/{facilityId}/drawdowns/subLimits","operationId":"getFacilitySubLimits","name":"Retrieve sub limits details for the specific facility arrangement","summary":"Retrieve sub limits details for the specific facility arrangement","tags":["CORPORATE"],"parameters":[{"name":"facilityId","in":"path","type":"string","required":true,"description":"Unique identifier (contract number) of the facility"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"FacilitySubLimitsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"PUT","path":"/holdings/creditAgreements/facilities/{facilityId}/drawdowns/subLimits","fullPath":"/api/v7.6.0/holdings/creditAgreements/facilities/{facilityId}/drawdowns/subLimits","operationId":"updateSubLimits","name":"User should be able to update  the sub limits based on the risk criterion. When restrictions and allocations are regulated based on the risk elements, borrower, currency and product (Product, Product group, and Product line).","summary":"Update sub limits based on the risk criterion","tags":["CORPORATE"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"facilityId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"productId":"string","effectiveDate":"2024-01-01","extensions":{},"sublimits":[{}]}},"responses":{"200":"updateSubLimitsResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"GET","path":"/holdings/creditAgreements/deal/{dealId}/drawings/conditions","fullPath":"/api/v7.6.0/holdings/creditAgreements/deal/{dealId}/drawings/conditions","operationId":"getDealDrawingCondition","name":"Retrieve drawing conditions for the specific deal or facility arrangement","summary":"Retrieve drawing conditions for the specific deal or facility arrangement","tags":["CORPORATE"],"parameters":[{"name":"dealId","in":"path","type":"string","required":true,"description":"Unique identifier (contract number) of the corporate deals"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"DrawingDetailsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"PUT","path":"/holdings/creditAgreements/drawings/{drawingId}/commitmentIncreases","fullPath":"/api/v7.6.0/holdings/creditAgreements/drawings/{drawingId}/commitmentIncreases","operationId":"createDrawdownCommitmentIncrease","name":"To increase the drawdown commitment for a given arrangement","summary":"To increase the drawdown commitment for a given arrangement","tags":["CORPORATE"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"drawingId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"productId":"string","drawdownDate":"2024-01-01","extensions":{},"dwcommitment":[{}]}},"responses":{"200":"createDrawdownCommitmentIncreaseResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"PUT","path":"/holdings/creditAgreements/drawings/{drawingId}/commitmentDecreases","fullPath":"/api/v7.6.0/holdings/creditAgreements/drawings/{drawingId}/commitmentDecreases","operationId":"createDrawdownCommitmentDecreases","name":"To decrease the drawdown commitment for a given arrangement","summary":"To decrease the drawdown commitment for a given arrangement","tags":["CORPORATE"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"drawingId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"productId":"string","drawdownDate":"2024-01-01","extensions":{},"dwcommitment":[{}]}},"responses":{"200":"createDrawdownCommitmentDecreasesResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"PUT","path":"/holdings/creditAgreements/facility/{facilityId}/writeOffs","fullPath":"/api/v7.6.0/holdings/creditAgreements/facility/{facilityId}/writeOffs","operationId":"updateWriteOffBillMaintenance","name":"Perform the write off of all the balances and bills of a loan. Bank calls for the write off of a loan borrowed by a defaulter when the chances of loan recovery are almost zero and its assets are non-performing.","summary":"Writeoff bill balance under facility level","tags":["CORPORATE"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"facilityId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"productId":"string","effectiveDate":"2024-01-01","extensions":{},"balanceMaintenance":[{}]}},"responses":{"200":"updateWriteOffBillMaintenanceResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"PUT","path":"/holdings/creditAgreements/{creditAgreementId}/cancellations","fullPath":"/api/v7.6.0/holdings/creditAgreements/{creditAgreementId}/cancellations","operationId":"cancelFacility","name":"Perform the full credit agreement (facility) cancellation","summary":"Cancel the facility for buy now pay later service","tags":["CORPORATE"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"creditAgreementId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"effectiveDate":"2024-01-01","activityId":"string","externalEventStatus":"string","extensions":{},"account":[{}]}},"responses":{"200":"cancelFacilityResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"POST","path":"/holdings/creditAgreements/buyNowPayLater/facilities","fullPath":"/api/v7.6.0/holdings/creditAgreements/buyNowPayLater/facilities","operationId":"createFacility","name":"Creates corporate facilities","summary":"Creates corporate facilities","tags":["CORPORATE"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"customers":[{}],"productId":"string","currency":"string","effectiveDate":"2024-01-01","dealId":"string","extensions":{},"settlement":[{}],"facommitment":[{}],"upfrontfee":[{}],"coordinationfee":[{}],"limit":[{}]}},"responses":{"200":"createFacilityResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"PUT","path":"/holdings/creditAgreements/{creditAgreementId}/commitmentIncreases","fullPath":"/api/v7.6.0/holdings/creditAgreements/{creditAgreementId}/commitmentIncreases","operationId":"updateFacilityTopupAmount","name":"Increase the commitment amount of the credit agreement (facility) with the incremental amount","summary":"Increase the commitment amount of the facility","tags":["CORPORATE"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"creditAgreementId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"effectiveDate":"2024-01-01","activityId":"string","externalEventStatus":"string","extensions":{},"facommitment":[{}]}},"responses":{"200":"updateFacilityTopupAmountResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"PUT","path":"/holdings/creditAgreements/{creditAgreementId}/commitmentDecreases","fullPath":"/api/v7.6.0/holdings/creditAgreements/{creditAgreementId}/commitmentDecreases","operationId":"updateFacilityDecreaseAmount","name":"Decrease the commitment amount of the credit agreement (facility) by the specified amount","summary":"Decrease the commitment amount of the facility","tags":["CORPORATE"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"creditAgreementId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"effectiveDate":"2024-01-01","activityId":"string","externalEventStatus":"string","extensions":{},"facommitment":[{}]}},"responses":{"200":"updateFacilityDecreaseAmountResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"PUT","path":"/holdings/creditAgreements/{creditAgreementId}/commitmentTerms","fullPath":"/api/v7.6.0/holdings/creditAgreements/{creditAgreementId}/commitmentTerms","operationId":"updateFacilityTerm","name":"Decrease/Increase the maturity period of the facility","summary":"Decrease/ Increase the maturity period of the credit agreement(facility)","tags":["CORPORATE"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"creditAgreementId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"effectiveDate":"2024-01-01","activityId":"string","externalEventStatus":"string","extensions":{},"agentCommission":[{}],"schedule":[{}],"feeschedule":[{}],"facommitment":[{}]}},"responses":{"200":"updateFacilityTermResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"POST","path":"/holdings/creditAgreements/loanTrades/{loanTradeId}/subAllocations","fullPath":"/api/v7.6.0/holdings/creditAgreements/loanTrades/{loanTradeId}/subAllocations","operationId":"allocateTrade","name":"The division of the sold loans by the seller, as advised by the original buyer.","summary":"Allocation of the sold loans among multiple buyers.","tags":["CORPORATE"],"parameters":[{"name":"loanTradeId","in":"path","type":"string","required":true,"description":"Unique identifier generated for each trade booked in  the system."},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"buyerDetails":[{}],"tradeActivity":"string","tradeStatus":"string","extensions":{}}},"responses":{"200":"TradeResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/holdings/creditAgreements/arrangements/evidences/dues","fullPath":"/api/v7.6.0/holdings/creditAgreements/arrangements/evidences/dues","operationId":"getEvidencesDue","name":"Retrieves the covenants and conditions associated with an arrangement which are either due or overdue","summary":"Retrieves the covenants and conditions associated with an arrangement which are either due or overdue","tags":["CORPORATE"],"parameters":[{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"EvidencesDueResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"PUT","path":"/holdings/creditAgreements/facility/{facilityId}/offers/negotiations","fullPath":"/api/v7.6.0/holdings/creditAgreements/facility/{facilityId}/offers/negotiations","operationId":"createOfferFacilityNegotiation","name":"Negotiate the offer facility for the required customer","summary":"Negotiate the offer facility for the required customer","tags":["CORPORATE"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"facilityId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"partyIds":[{}],"effectiveDate":"2024-01-01","extensions":{},"account":[{}],"feeschedule":[{}],"settlement":[{}],"drawingRules":[{}],"facommitment":[{}],"upfrontfee":[{}],"coordinationfee":[{}],"limit":[{}],"covenantConditions":[{}],"drawingConditions":[{}],"pgMarginGrid":[{}],"participant":[{}]}},"responses":{"200":"createOfferFacilityRenegotiationResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"GET","path":"/holdings/creditAgreements/arrangements/{arrangementId}/charges","fullPath":"/api/v7.6.0/holdings/creditAgreements/arrangements/{arrangementId}/charges","operationId":"getChargeConditions","name":"Retrieves the charge details associated at facility and drawdown level","summary":"Retrieves the charge details associated at facility and drawdown level","tags":["CORPORATE"],"parameters":[{"name":"arrangementId","in":"path","type":"string","required":true,"description":"Indicates an unique identifier of an account"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"ChargeConditionsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/creditAgreements/drawings/{drawingId}/exchangeRates","fullPath":"/api/v7.6.0/holdings/creditAgreements/drawings/{drawingId}/exchangeRates","operationId":"getExchangeRates","name":"Retrieves the exchange rate maintained at drawdown which is used for conversion of amount in different currencies.","summary":"Retrieves the exchange rate maintained at drawdown which is used for conversion of amount in different currencies.","tags":["CORPORATE"],"parameters":[{"name":"drawingId","in":"path","type":"string","required":true,"description":"Unique identifier (contract number) of the drawdown"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"ExchangeRatesResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"PUT","path":"/holdings/creditAgreements/deal/{dealId}/schedules","fullPath":"/api/v7.6.0/holdings/creditAgreements/deal/{dealId}/schedules","operationId":"updateDealPaymentSchedule","name":"When there is requirement to change the schedule based on the type, method, frequency, property, start/end date , no of payments, and calculated amount, bill type and in adv, by using this activity user should be able to update the schedule and based on which the charges are paid","summary":"Allow user to change fee schedule condition in deal level.","tags":["CORPORATE"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"arrangementId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"productId":"string","effectiveDate":"2024-01-01","extensions":{},"schedule":[{}],"settlement":[{}]}},"responses":{"200":"updateFeeScheduleResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"PUT","path":"/holdings/creditAgreements/facilities/{facilityId}/rolloverType","fullPath":"/api/v7.6.0/holdings/creditAgreements/facilities/{facilityId}/rolloverType","operationId":"createFacilityRollovers","name":"API for the creation and management of credit agreements for corporate customers. The types of credit agreements are single level facility, credit agreement with multiple facilities, club loans with agency and syndicated loans","summary":"Splits a drawings into many drawings in facility level","tags":["CORPORATE"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"facilityId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"customers":[{}],"productId":"string","currency":"string","effectiveDate":"2024-01-01","dealId":"string","extensions":{},"splitsMerges":[{}]}},"responses":{"200":"createFacilityRolloversResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"PUT","path":"/holdings/creditAgreements/arrangements/{arrangementId}/interestRatchet","fullPath":"/api/v7.6.0/holdings/creditAgreements/arrangements/{arrangementId}/interestRatchet","operationId":"updateInterestMarginRatchet","name":"Update margin ratchet details for principal Interest, penal interest and commission at deal level","summary":"Update interest margin ratchet details for a deal or facility","tags":["CORPORATE"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"arrangementId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"productId":"string","effectiveDate":"2024-01-01","extensions":{},"pgMarginGrid":[{}]}},"responses":{"200":"updateInterestMarginRatchetResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"PUT","path":"/holdings/creditAgreements/arrangements/{arrangementId}/feeRatchet","fullPath":"/api/v7.6.0/holdings/creditAgreements/arrangements/{arrangementId}/feeRatchet","operationId":"updateFeeRatchet","name":"Update fee ratchet for a given facility or deal arrangement","summary":"Update fee ratchet for a given facility or deal arrangement","tags":["CORPORATE"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"arrangementId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"productId":"string","effectiveDate":"2024-01-01","extensions":{},"pgFeeGrid":[{}]}},"responses":{"200":"updateFeeRatchetResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"GET","path":"/holdings/creditAgreements/arrangements/{arrangementId}/margins","fullPath":"/api/v7.6.0/holdings/creditAgreements/arrangements/{arrangementId}/margins","operationId":"getInterestAndMarginDetails","name":"Retrieves the fee and margin ratchet details pertaining to deal, facility or drawdown","summary":"Retrieves the fee and margin ratchet details pertaining to deal, facility or drawdown","tags":["CORPORATE"],"parameters":[{"name":"arrangementId","in":"path","type":"string","required":true,"description":"Indicates an unique identifier of an account"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"InterestAndMarginDetailsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/creditAgreements/facilities/closures","fullPath":"/api/v7.6.0/holdings/creditAgreements/facilities/closures","operationId":"getClosedMaturedFacilities","name":"Retrieves the list of closed or matured accounts for facility product line","summary":"Retrieves the list of closed or matured accounts for facility product line","tags":["CORPORATE"],"parameters":[{"name":"arrangementId","in":"query","type":"string","required":false,"description":"Indicates an unique identifier of an account"},{"name":"productGroup","in":"query","type":"string","required":false,"description":"Indicates a group under which the products exists"},{"name":"product","in":"query","type":"string","required":false,"description":"Contains the name of the product"},{"name":"currency","in":"query","type":"string","required":false,"description":"Identifies the currency. E.g. USD, GBP etc"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"ClosedMaturedFacilitiesResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"PUT","path":"/holdings/creditAgreements/facilities/{facilityId}/exchangeRates","fullPath":"/api/v7.6.0/holdings/creditAgreements/facilities/{facilityId}/exchangeRates","operationId":"updateExchangeRate","name":"Given the scenario, when there is a cross currency involved considering facility and drawings in different currencies, exchange rate is applicable and the same is updated using the exchange rate functionality. Exchange rate property class is to define the Exchange Rate (FX), rate tolerance and prior days, advance FX fix activity, and so on to support the advance FX fixing requirement. Drawings created other than the facility currency, the exchange rate defined under the exchange rate property sh","summary":"Update exchange rate maintained at facility level which is used during cross currency drawings","tags":["CORPORATE"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"facilityId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"productId":"string","effectiveDate":"2024-01-01","extensions":{},"exchangeRate":[{}]}},"responses":{"200":"updateExchangeRateResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"GET","path":"/holdings/creditAgreements/arrangements","fullPath":"/api/v7.6.0/holdings/creditAgreements/arrangements","operationId":"getCreditAgreements","name":"Retrieves the list of deals and facilities along with their basic information","summary":"Retrieves the list of deals and facilities along with their basic information","tags":["CORPORATE"],"parameters":[{"name":"arrangementId","in":"query","type":"string","required":false,"description":"Indicates an unique identifier of an account"},{"name":"customers","in":"query","type":"string","required":false,"description":"Contains the customer identifier"},{"name":"allowedProductGroup","in":"query","type":"string","required":false,"description":"Group allowed to be used for a sub contract, for example Mortgages or Term Loans"},{"name":"aaProduct","in":"query","type":"string","required":false,"description":"This is the product associated with the arrangement, set of values to select from."},{"name":"allowedCurrency","in":"query","type":"string","required":false,"description":"Available currencies for the product"},{"name":"status","in":"query","type":"string","required":false,"description":"Contains status of the data rights request.Allowed values are INITIATED, INPROGESS, EXTENDED, COMPLETED, REJECTED."},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"CreditAgreementsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/creditAgreements/arrangements/evidences/nonCompliances","fullPath":"/api/v7.6.0/holdings/creditAgreements/arrangements/evidences/nonCompliances","operationId":"getEvidencesNonCompliance","name":"Retrieves the covenants and conditions associated with an arrangement which are non compliant in nature","summary":"Retrieves the covenants and conditions associated with an arrangement which are non compliant in nature","tags":["CORPORATE"],"parameters":[{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"EvidencesNonCompliantResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/creditAgreements/arrangements/evidences/upcoming","fullPath":"/api/v7.6.0/holdings/creditAgreements/arrangements/evidences/upcoming","operationId":"getEvidencesUpcoming","name":"Retrieves the covenants and conditions associated with an arrangement which are falling due in the near future","summary":"Retrieves the covenants and conditions associated with an arrangement which are falling due in the near future","tags":["CORPORATE"],"parameters":[{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"EvidencesUpcomingResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"PUT","path":"/holdings/creditAgreements/arrangements/{arrangementId}/covenants","fullPath":"/api/v7.6.0/holdings/creditAgreements/arrangements/{arrangementId}/covenants","operationId":"updateCovenantsFacility","name":"Performs update of covenants and conditions for a facility. Covenants are requested in periodic basis and the conditions are one-time evidence. On non-submission or non-compliance of the evidences, the related consequent activity will be restricted","summary":"Update the covenants and conditions for a facility or deal","tags":["CORPORATE"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"arrangementId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"partyIds":[{}],"partyRoles":[{}],"agentCustomerIds":[{}],"agentArrangementIds":[{}],"agentRoles":[{}],"arrangmentId":"string","productId":"string","activityId":"string","currency":"string","productVariation":"string","pricingSelection":"string","pricingPlan":"string","rewardsArrangementId":"string","tradeDate":"string","arrangementEffectiveDate":"string"}},"responses":{"200":"updateCovenantsFacilityResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"PUT","path":"/holdings/creditAgreements/drawings/{drawingId}/covenants","fullPath":"/api/v7.6.0/holdings/creditAgreements/drawings/{drawingId}/covenants","operationId":"updateCovenantDrawings","name":"Performs update of covenants and conditions for a loan account. Covenants are requested in periodic basis and the conditions are one-time evidence. On non-submission or non-compliance of the evidences, the related consequent activity will be restricted","summary":"Update the covenants and conditions for a loan account","tags":["CORPORATE"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"drawingId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"partyIds":[{}],"partyRoles":[{}],"agentCustomerIds":[{}],"agentArrangementIds":[{}],"agentRoles":[{}],"arrangmentId":"string","productId":"string","activityId":"string","currency":"string","productVariation":"string","pricingSelection":"string","pricingPlan":"string","rewardsArrangementId":"string","tradeDate":"string","arrangementEffectiveDate":"string"}},"responses":{"200":"updateCovenantDrawingsResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"PUT","path":"/holdings/creditAgreements/deal/{dealId}/administrativeFees","fullPath":"/api/v7.6.0/holdings/creditAgreements/deal/{dealId}/administrativeFees","operationId":"updateAdministrativeFees","name":"Update administrative fee collected for the deal","summary":"Update administrative fee collected for the deal","tags":["CORPORATE"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"dealId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"productId":"string","effectiveDate":"2024-01-01","extensions":{},"schedule":[{}],"adminfee":[{}]}},"responses":{"200":"updateAdministrativeFeesResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"PUT","path":"/holdings/creditAgreements/drawings/{drawingId}/pricings","fullPath":"/api/v7.6.0/holdings/creditAgreements/drawings/{drawingId}/pricings","operationId":"updateDrawingPricingGrid","name":"Update pricing grid margin for principal & penal interest at drawdown level","summary":"Update pricing grid margin for principal & penal interest at drawdown level","tags":["CORPORATE"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"drawingId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"productId":"string","effectiveDate":"2024-01-01","extensions":{},"principalint":[{}],"penaltyint":[{}],"penalint":[{}]}},"responses":{"200":"updateDrawingPricingGridResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"PUT","path":"/holdings/creditAgreements/drawings/{drawingId}/adjustments","fullPath":"/api/v7.6.0/holdings/creditAgreements/drawings/{drawingId}/adjustments","operationId":"initiateDrawingsAdjustments","name":"Bill balances such as commitment balance, principal or interest or charge amount of facility should be adjusted","summary":"Perform adjust balances and bills such as commitment balance, principal or interest or charge amount of facility","tags":["CORPORATE"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"drawingId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"productId":"string","effectiveDate":"2024-01-01","extensions":{},"balanceMaintenance":[{}]}},"responses":{"200":"initiateAdjustmetsResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}}]},{"key":"holdings-creditAgreements-api-service-v7.7.0","title":"Corporate Credit Agreements","version":"v7.7.0","description":"API for the creation and management of credit agreements for corporate customers. The types of credit agreements are single level facility, credit agreement with multiple facilities, club loans with agency and syndicated loans","endpointCount":111,"endpoints":[{"method":"PUT","path":"/holdings/creditAgreements/deals/{dealId}/commitmentIncreases","fullPath":"/api/v7.7.0/holdings/creditAgreements/deals/{dealId}/commitmentIncreases","operationId":"updateDealCommitmentIncreases","name":"User should be able to increase the commitment amount of the existing deal arrangement.","summary":"Increases the commitment amount of the existing deal arrangement.","tags":["CORPORATE"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"dealId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"effectiveDate":"2024-01-01","activityId":"string","externalEventStatus":"string","extensions":{},"dacommitment":[{}]}},"responses":{"200":"updateDealCommitmentIncreasesResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"PUT","path":"/holdings/creditAgreements/deals/{dealId}/commitmentDecreases","fullPath":"/api/v7.7.0/holdings/creditAgreements/deals/{dealId}/commitmentDecreases","operationId":"updateDealCommitmentDecreases","name":"User should be able to decrease the commitment amount of the existing deal arrangement","summary":"The commitment amount of the existing deal arrangement can be decreased","tags":["CORPORATE"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"dealId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"effectiveDate":"2024-01-01","activityId":"string","externalEventStatus":"string","extensions":{},"dacommitment":[{}]}},"responses":{"200":"updateDealCommitmentDecreasesResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"GET","path":"/holdings/creditAgreements/facilities/{facilityId}/drawdowns/subLimits","fullPath":"/api/v7.7.0/holdings/creditAgreements/facilities/{facilityId}/drawdowns/subLimits","operationId":"getFacilitySubLimits","name":"Retrieve sublimits details for the specific facility arrangement","summary":"Retrieve sublimits details for the specific facility arrangement","tags":["CORPORATE"],"parameters":[{"name":"facilityId","in":"path","type":"string","required":true,"description":"Unique identifier (contract number) of the facility"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"FacilitySubLimitsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"PUT","path":"/holdings/creditAgreements/facilities/{facilityId}/drawdowns/subLimits","fullPath":"/api/v7.7.0/holdings/creditAgreements/facilities/{facilityId}/drawdowns/subLimits","operationId":"updateSubLimits","name":"User should be able to update  the sub limits based on the risk criterion. When restrictions and allocations are regulated based on the risk elements, borrower, currency and product (Product, Product group, and Product line).","summary":"Update sub limits based on the risk criterion","tags":["CORPORATE"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"facilityId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"productId":"string","effectiveDate":"2024-01-01","extensions":{},"sublimits":[{}]}},"responses":{"200":"updateSubLimitsResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"POST","path":"/holdings/creditAgreements/deals/offers","fullPath":"/api/v7.7.0/holdings/creditAgreements/deals/offers","operationId":"createDealOffer","name":"Creates new offer deal for the required customer when the mandatory input details are provided. Offer deal creates a draft contract and allows the users to negotiate multiple times. Offer deal is a draft contract and will not affect the balance sheet of the bank.","summary":"Creates an offer for a deal contract","tags":["CORPORATE"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"customers":[{}],"productId":"string","currency":"string","effectiveDate":"2024-01-01","activity":"string","extensions":{},"facilityRules":[{}],"dacommitment":[{}],"adminfee":[{}],"coordinationfee":[{}],"upfrontfee":[{}],"limit":[{}]}},"responses":{"200":"createDealOfferResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"POST","path":"/holdings/creditAgreements/deals/offers/cancellations/{arrangementId}","fullPath":"/api/v7.7.0/holdings/creditAgreements/deals/offers/cancellations/{arrangementId}","operationId":"deleteDealOffer","name":"Deletes a new offer for the required deal contract when at least the mandatory input is provided. Deal offer is a draft contract, which allow the user to delete the contract online and deal offer contract will not affect the balance sheet of the bank.","summary":"Deletes an offer for a deal contract","tags":["CORPORATE"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"arrangementId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"productId":"string","effectiveDate":"2024-01-01","extensions":{}}},"responses":{"200":"deleteDealOfferResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"POST","path":"/holdings/creditAgreements/facilities/offers/cancellations/{arrangementId}","fullPath":"/api/v7.7.0/holdings/creditAgreements/facilities/offers/cancellations/{arrangementId}","operationId":"deleteFacilityOffer","name":"Deletes a new offer for the required facility contract when at least the mandatory input is provided. Facility offer is a draft contract, which allow the user to delete the contract online and facility offer contract will not affect the balance sheet of the bank.","summary":"Deletes an offer for a facility contract","tags":["CORPORATE"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"arrangementId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"productId":"string","effectiveDate":"2024-01-01","extensions":{},"settlement":[{}],"facommitment":[{}],"upfrontfee":[{}],"coordinationfee":[{}],"limit":[{}]}},"responses":{"200":"deleteFacilityOfferResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"POST","path":"/holdings/creditAgreements/deals/offers/acceptances/{arrangementId}","fullPath":"/api/v7.7.0/holdings/creditAgreements/deals/offers/acceptances/{arrangementId}","operationId":"acceptDealOffer","name":"On executing acceptance, the contract is changed from offer to live deal for the required customer when at least the mandatory input is provided. Process will check all the required mandatory inputs and prompt an error message when mandatory details are not provided. Once the accept deal offer is processed further offer negotiation is not allowed.","summary":"Accept the deal offer and execute the contract to live","tags":["CORPORATE"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"arrangementId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"productId":"string","effectiveDate":"2024-01-01","extensions":{},"settlement":[{}],"facilityRules":[{}],"dacommitment":[{}],"adminfee":[{}],"coordinationfee":[{}],"upfrontfee":[{}],"limit":[{}]}},"responses":{"200":"acceptDealOfferResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"POST","path":"/holdings/creditAgreements/facilities/offers/acceptances/{arrangementId}","fullPath":"/api/v7.7.0/holdings/creditAgreements/facilities/offers/acceptances/{arrangementId}","operationId":"acceptFacilityOffer","name":"On executing acceptance, the contract is changed from offer to live facility for the required customer when at least the mandatory input is provided. Process will check all the required mandatory inputs and prompt an error message when mandatory details are not provided. Once the accept deal offer is processed further offer negotiation is not allowed.","summary":"Accept the facility offer and execute the contract to live","tags":["CORPORATE"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"arrangementId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"customers":[{}],"productId":"string","currency":"string","dealId":"string","effectiveDate":"2024-01-01","activity":"string","extensions":{},"account":[{}],"feeschedule":[{}],"settlement":[{}],"drawingRules":[{}],"facommitment":[{}],"upfrontfee":[{}],"coordinationfee":[{}],"limit":[{}]}},"responses":{"200":"acceptFacilityOfferResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"POST","path":"/holdings/creditAgreements/drawdowns/offers","fullPath":"/api/v7.7.0/holdings/creditAgreements/drawdowns/offers","operationId":"createDrawdownOffer","name":"Creates a new drawdown offer for the required customer. ","summary":"Creates a new drawdown offer for the required customer. ","tags":["CORPORATE"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"customers":[{}],"productId":"string","currency":"string","facilityId":"string","offerDate":"2024-01-01","drawdownDate":"2024-01-01","activity":"string","extensions":{},"maintenancefee":[{}],"dwcommitment":[{}],"settlement":[{}]}},"responses":{"200":"createDrawdownOfferResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"POST","path":"/holdings/creditAgreements/drawdowns/offers/negotiations","fullPath":"/api/v7.7.0/holdings/creditAgreements/drawdowns/offers/negotiations","operationId":"createOfferDrawdownRenegotiation","name":"Renegotiate the offer drawdown for the required customer.","summary":"Renegotiate the offer drawdown for the required customer.","tags":["CORPORATE"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"productId":"string","drawdownDate":"2024-01-01","extensions":{},"maintenancefee":[{}],"settlement":[{}]}},"responses":{"200":"createOfferDrawdownRenegotiationResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"POST","path":"/holdings/creditAgreements/drawdowns/offers/cancellations","fullPath":"/api/v7.7.0/holdings/creditAgreements/drawdowns/offers/cancellations","operationId":"deleteDrawdownOffer","name":"Cancellation of offer drawdown for the required customer.","summary":"Cancellation of offer drawdown for the required customer.","tags":["CORPORATE"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"productId":"string","drawdownDate":"2024-01-01","extensions":{}}},"responses":{"200":"deleteDrawdownOfferResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"POST","path":"/holdings/creditAgreements/drawdowns/offers/acceptances","fullPath":"/api/v7.7.0/holdings/creditAgreements/drawdowns/offers/acceptances","operationId":"acceptOfferDrawdown","name":"Convert an offer drawdown to a live drawdown for the required customer.","summary":"Convert an offer drawdown to a live drawdown for the required customer.","tags":["CORPORATE"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"productId":"string","drawdownDate":"2024-01-01","extensions":{},"maintenancefee":[{}],"dwcommitment":[{}],"settlement":[{}]}},"responses":{"200":"acceptOfferDrawdownResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"GET","path":"/holdings/creditAgreements/facilities/{facilityId}/drawingProducts","fullPath":"/api/v7.7.0/holdings/creditAgreements/facilities/{facilityId}/drawingProducts","operationId":"getFacilityDrawingProducts","name":"Retrieves the available drawing products under the facility ","summary":"Retrieves the available drawing products under the facility ","tags":["CORPORATE"],"parameters":[{"name":"facilityId","in":"path","type":"string","required":true,"description":"Unique identifier (contract number) of the facility"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"FacilityDrawingProductsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/creditAgreements/facilities/{facilityId}/combinedSchedules","fullPath":"/api/v7.7.0/holdings/creditAgreements/facilities/{facilityId}/combinedSchedules","operationId":"getCombinedSchedules","name":"Retrieves the payment schedule of facility and its drawings","summary":"Retrieves the payment schedule of facility and its drawings","tags":["CORPORATE"],"parameters":[{"name":"facilityId","in":"path","type":"string","required":true,"description":"Unique identifier (contract number) of the facility"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"CombinedSchedulesResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"POST","path":"/holdings/creditAgreements/facilities","fullPath":"/api/v7.7.0/holdings/creditAgreements/facilities","operationId":"createFacilities","name":"Creates corporate facilities","summary":"Creates corporate facilities","tags":["CORPORATE"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"customers":[{}],"productId":"string","currency":"string","effectiveDate":"2024-01-01","dealId":"string","extensions":{},"settlement":[{}],"facommitment":[{}],"upfrontfee":[{}],"coordinationfee":[{}],"limit":[{}]}},"responses":{"200":"createFacilitiesResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"GET","path":"/holdings/creditAgreements/facilities/{facilityId}/drawingRules","fullPath":"/api/v7.7.0/holdings/creditAgreements/facilities/{facilityId}/drawingRules","operationId":"getFacilityDrawingRules","name":"Retrieves the allowed customers, currencies and products for a new drawing under the facility","summary":"Retrieves the allowed customers, currencies and products for a new drawing under the facility","tags":["CORPORATE"],"parameters":[{"name":"facilityId","in":"path","type":"string","required":true,"description":"Unique identifier (contract number) of the facility"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"FacilityDrawingRulesResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/creditAgreements/facilities/{facilityId}/drawings","fullPath":"/api/v7.7.0/holdings/creditAgreements/facilities/{facilityId}/drawings","operationId":"getDrawingsUnderFacility","name":"Retrieves the drawings under a facility","summary":"Retrieves the drawings under a facility","tags":["CORPORATE"],"parameters":[{"name":"facilityId","in":"path","type":"string","required":true,"description":"Unique identifier (contract number) of the facility"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"DrawingsUnderFacilityResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/creditAgreements/facilities/drawings/{drawingId}/parentFacilities","fullPath":"/api/v7.7.0/holdings/creditAgreements/facilities/drawings/{drawingId}/parentFacilities","operationId":"getDrawingFacility","name":"Retrieves the parent facility for a drawing","summary":"Retrieves the parent facility for a drawing","tags":["CORPORATE"],"parameters":[{"name":"drawingId","in":"path","type":"string","required":true,"description":"Identifier of drawings application under the Letter of Credit system that is used to effect the transfer of funds and the acceptance of documents under Letters of Credit and Documentary Collection tra"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"DrawingFacilityResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/creditAgreements/facilities/{facilityId}/commitmentSchedules","fullPath":"/api/v7.7.0/holdings/creditAgreements/facilities/{facilityId}/commitmentSchedules","operationId":"getFacilityCommitmentSchedule","name":"Retrieves the commitment schedule of a facility","summary":"Retrieves the commitment schedule of a facility","tags":["CORPORATE"],"parameters":[{"name":"facilityId","in":"path","type":"string","required":true,"description":"Unique identifier (contract number) of the facility"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"FacilityCommitmentScheduleResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/creditAgreements/facilities/{facilityId}/parentDeals","fullPath":"/api/v7.7.0/holdings/creditAgreements/facilities/{facilityId}/parentDeals","operationId":"getFacilityDeal","name":"Retrieves the parent deal for a facility","summary":"Retrieves the parent deal for a facility","tags":["CORPORATE"],"parameters":[{"name":"facilityId","in":"path","type":"string","required":true,"description":"Unique identifier (contract number) of the facility"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"FacilityDealResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/creditAgreements/facilities/{facilityId}/balances","fullPath":"/api/v7.7.0/holdings/creditAgreements/facilities/{facilityId}/balances","operationId":"getFacilityFinancialSummary","name":"Retrieves the financial summary for a facility arrangement","summary":"Retrieves the financial summary for a facility arrangement","tags":["CORPORATE"],"parameters":[{"name":"facilityId","in":"path","type":"string","required":true,"description":"Unique identifier (contract number) of the facility"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"FacilityFinancialSummaryResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/creditAgreements/facilities/{facilityId}/consolidatedBalances","fullPath":"/api/v7.7.0/holdings/creditAgreements/facilities/{facilityId}/consolidatedBalances","operationId":"getFacilityConsolidatedBalances","name":"Retrieves the consolidated balances for a facility arrangement","summary":"Retrieves the consolidated balances for a facility arrangement","tags":["CORPORATE"],"parameters":[{"name":"facilityId","in":"path","type":"string","required":true,"description":"Unique identifier (contract number) of the facility"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"FacilityConsolidatedBalancesResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"POST","path":"/holdings/creditAgreements/facilities/directDebits","fullPath":"/api/v7.7.0/holdings/creditAgreements/facilities/directDebits","operationId":"createFacilityDirectDebitLink","name":"Links a direct debit to an existing facility","summary":"Links a direct debit to a facility","tags":["CORPORATE"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"customers":[{}],"arrangement":"string","productId":"string","currency":"string","effectiveDate":"2024-01-01","extensions":{},"settlement":[{}]}},"responses":{"200":"createFacilityDirectDebitLinkResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"POST","path":"/holdings/creditAgreements/facilities/drawings/directDebits","fullPath":"/api/v7.7.0/holdings/creditAgreements/facilities/drawings/directDebits","operationId":"createDrawingDirectDebitLink","name":"Link the direct debit to an existing drawing under a facility","summary":"Links a direct debit to a drawing","tags":["CORPORATE"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"customers":[{}],"arrangement":"string","currency":"string","facilityId":"string","effectiveDate":"string","productId":"string","extensions":{},"settlement":[{}]}},"responses":{"200":"createDrawingDirectDebitLinkResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"POST","path":"/holdings/creditAgreements/facilities/rollovers/offers","fullPath":"/api/v7.7.0/holdings/creditAgreements/facilities/rollovers/offers","operationId":"createFacilityRolloverOffer","name":"Create rollover process from the facility where the rollover could be a split rollover, merge rollover or a one to one rollover. Split also called as one to many will rollover an old loan and create multiple new offer loans. Merge also called as many to one will rollover multiple old loans simultaneously and create a single new offer loan. Rollover also called as one to one will simply rollover an old loan and create a new offer loan","summary":"Create rollover offer from facility","tags":["CORPORATE"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"arrangement":"string","rolloverDate":"string","productId":"string","extensions":{},"splitsMerges":[{}]}},"responses":{"200":"createFacilityRolloverOfferResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"POST","path":"/holdings/creditAgreements/drawdowns/rollovers/offers","fullPath":"/api/v7.7.0/holdings/creditAgreements/drawdowns/rollovers/offers","operationId":"createDrawdownRolloverOffer","name":"Create rollover process from the drawdown where the rollover could be a split rollover, merge rollover or a one to one rollover. Split also called as one to many will rollover an old loan and create multiple new offer loans. Merge also called as many to one will rollover multiple old loans simultaneously and create a single new offer loan. Rollover also called as one to one will simply rollover an old loan and create a new offer loan","summary":"Create rollover offer from drawdown","tags":["CORPORATE"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"arrangement":"string","rolloverDate":"string","productId":"string","extensions":{},"splitsMerges":[{}]}},"responses":{"200":"createDrawdownRolloverOfferResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"POST","path":"/holdings/creditAgreements/facilities/commitmentIncreases/{arrangementId}","fullPath":"/api/v7.7.0/holdings/creditAgreements/facilities/commitmentIncreases/{arrangementId}","operationId":"updateFacilityCommitmentIncrease","name":"Increase the facility amount to facilitate further drawdowns","summary":"Increase facility amount","tags":["CORPORATE"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"arrangementId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"productId":"string","effectiveDate":"2024-01-01","extensions":{},"facommitment":[{}]}},"responses":{"200":"updateFacilityCommitmentIncreaseResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"POST","path":"/holdings/creditAgreements/facilities/commitmentTerms/{arrangementId}","fullPath":"/api/v7.7.0/holdings/creditAgreements/facilities/commitmentTerms/{arrangementId}","operationId":"updateFacilityCommitmentTerms","name":"Updates facility tenure by increasing or decreasing the term, in addition it allows the amendment of the availability schedule of the contract.","summary":"Update facility maturity date and availability","tags":["CORPORATE"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"arrangementId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"productId":"string","effectiveDate":"2024-01-01","extensions":{},"facommitment":[{}]}},"responses":{"200":"updateFacilityCommitmentTermsResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"GET","path":"/holdings/customers/{customerId}/creditAgreements/exposures","fullPath":"/api/v7.7.0/holdings/customers/{customerId}/creditAgreements/exposures","operationId":"getCustomerExposure","name":"Retrieves the customer exposure such as the facility number, type of facility, maturity date and various amounts of the facilities/standalone loans.","summary":"Retrieves the customer exposure for facilities and loans","tags":["CORPORATE"],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"Identifier of the customer"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"CustomerExposureResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/customers/{customerId}/creditAgreements/drawings","fullPath":"/api/v7.7.0/holdings/customers/{customerId}/creditAgreements/drawings","operationId":"getCustomerDrawings","name":"Retrieves the details such as the drawing id, account number, short description of the loan, customer name and loan status for a customer. ","summary":"Retrieves the drawing details for a customer.","tags":["CORPORATE"],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"Identifier of the customer"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"CustomerDrawingsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/customers/{customerId}/creditAgreements/facilities","fullPath":"/api/v7.7.0/holdings/customers/{customerId}/creditAgreements/facilities","operationId":"getCustomerFacilities","name":"Retrieves the details such as the facility id, account number, short description of the facility, customer name and facility status for a customer.","summary":"Retrieves the facility details for a customer.","tags":["CORPORATE"],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"Identifier of the customer"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"CustomerFacilitiesResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/customers/{customerId}/creditAgreements/deals","fullPath":"/api/v7.7.0/holdings/customers/{customerId}/creditAgreements/deals","operationId":"getCustomerDeals","name":"Retrieves the details such as the deal id, account number, short description of the facility, customer name and deal status for a customer.","summary":"Retrieves the deal details for a customer.","tags":["CORPORATE"],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"Identifier of the customer"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"CustomerDealsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/creditAgreements/deals/{dealId}/facilities","fullPath":"/api/v7.7.0/holdings/creditAgreements/deals/{dealId}/facilities","operationId":"getFacilitiesUnderDeal","name":"Retrieves the details such as facility id, title, currency, status and commitment amount for all the facilities under a deal.","summary":"Retrieves the details of facilities under a deal.","tags":["CORPORATE"],"parameters":[{"name":"dealId","in":"path","type":"string","required":true,"description":"Unique identifier (contract number) of the corporate deals"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"FacilitiesUnderDealResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/creditAgreements/productCatalogues","fullPath":"/api/v7.7.0/holdings/creditAgreements/productCatalogues","operationId":"getCreditAgreementsProductCatalogue","name":"Retrieves the list of available products for credit agreements.","summary":"Retrieves the credit agreements product catalogue.","tags":["CORPORATE"],"parameters":[{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"CreditAgreementsProductCatalogueResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/creditAgreements/drawings/{drawingId}/pendingActivities","fullPath":"/api/v7.7.0/holdings/creditAgreements/drawings/{drawingId}/pendingActivities","operationId":"getPendingActivities","name":"Retrieves the details such as rollover date, rollover status etc of pending drawdowns and rollovers for a drawing.","summary":"Retrieves the details of pending drawdowns and rollovers for a drawing.","tags":["CORPORATE"],"parameters":[{"name":"drawingId","in":"path","type":"string","required":true,"description":"Identifier of drawings application under the Letter of Credit system that is used to effect the transfer of funds and the acceptance of documents under Letters of Credit and Documentary Collection tra"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"PendingActivitiesResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/creditAgreements/drawings/expiries","fullPath":"/api/v7.7.0/holdings/creditAgreements/drawings/expiries","operationId":"getLoansExpiring","name":"Retrieves the drawings expiring in the next 7 days.","summary":"Retrieves expiring drawings.","tags":["CORPORATE"],"parameters":[{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"LoansExpiringResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/creditAgreements/facilities/expiries","fullPath":"/api/v7.7.0/holdings/creditAgreements/facilities/expiries","operationId":"getFacilitiesExpiring","name":"Retrieves the facilities expiring in the next 7 days","summary":"Retrieves expiring facilities","tags":["CORPORATE"],"parameters":[{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"FacilitiesExpiringResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/creditAgreements/drawings/{drawingId}/balances","fullPath":"/api/v7.7.0/holdings/creditAgreements/drawings/{drawingId}/balances","operationId":"getDrawingBalances","name":"Retrieves the balance details such as commitment balances, utilized balances.","summary":"Retrieves drawing balances","tags":["CORPORATE"],"parameters":[{"name":"drawingId","in":"path","type":"string","required":true,"description":"Identifier of drawings application under the Letter of Credit system that is used to effect the transfer of funds and the acceptance of documents under Letters of Credit and Documentary Collection tra"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"DrawingBalancesResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/creditAgreements/drawings/{drawingId}/OverdueBalances","fullPath":"/api/v7.7.0/holdings/creditAgreements/drawings/{drawingId}/OverdueBalances","operationId":"getDrawingOverdueBalances","name":"Retrieves the past dues and overdues for a drawing","summary":"Retrieves drawing overdue balances","tags":["CORPORATE"],"parameters":[{"name":"drawingId","in":"path","type":"string","required":true,"description":"Identifier of drawings application under the Letter of Credit system that is used to effect the transfer of funds and the acceptance of documents under Letters of Credit and Documentary Collection tra"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"DrawingOverdueBalancesResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/creditAgreements/facilities/clubFacilities","fullPath":"/api/v7.7.0/holdings/creditAgreements/facilities/clubFacilities","operationId":"getClubFacilities","name":"Retrieves club facilities, drawings and deal","summary":"Retrieves club facilities, drawings and deal","tags":["CORPORATE"],"parameters":[{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"ClubFacilitiesResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"POST","path":"/holdings/creditAgreements/facilities/clubFacilities","fullPath":"/api/v7.7.0/holdings/creditAgreements/facilities/clubFacilities","operationId":"createClubFacilities","name":"Creates a club facility with facility details along with the details of participating lenders","summary":"Creates a club facility","tags":["CORPORATE"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"customers":[{}],"productId":"string","currency":"string","effectiveDate":"2024-01-01","extensions":{},"account":[{}],"settlement":[{}],"facommitment":[{}],"upfrontfee":[{}],"coordinationfee":[{}],"limit":[{}],"participant":[{}],"riskparticipant":[{}]}},"responses":{"200":"createClubFacilitiesResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"POST","path":"/holdings/creditAgreements/facilities/drawings/clubDrawings","fullPath":"/api/v7.7.0/holdings/creditAgreements/facilities/drawings/clubDrawings","operationId":"createClubDrawings","name":"Creates a club drawing arrangement with drawdown details along with the details of participating lenders","summary":"Creates a club drawing","tags":["CORPORATE"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"customers":[{}],"currency":"string","facilityId":"string","effectiveDate":"string","activity":"string","productId":"string","extensions":{},"account":[{}],"escrow":[{}],"dwcommitment":[{}],"settlement":[{}],"participant":[{}],"riskparticipant":[{}]}},"responses":{"200":"createClubDrawingsResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"GET","path":"/holdings/creditAgreements/facilities/drawings/{drawingId}/participants","fullPath":"/api/v7.7.0/holdings/creditAgreements/facilities/drawings/{drawingId}/participants","operationId":"getClubDrawingParticipants","name":"Retrieves the participation details of the lending arrangement for a customer. This will be used to view the agent bank and the participant details and the share amounts when an arrangement id is passed as an input.","summary":"Retrieves the participant details","tags":["CORPORATE"],"parameters":[{"name":"drawingId","in":"path","type":"string","required":true,"description":"Identifier of drawings application under the Letter of Credit system that is used to effect the transfer of funds and the acceptance of documents under Letters of Credit and Documentary Collection tra"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"ClubDrawingParticipantsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"POST","path":"/holdings/creditAgreements/facilities/{facilityId}/fundedShareTransfers","fullPath":"/api/v7.7.0/holdings/creditAgreements/facilities/{facilityId}/fundedShareTransfers","operationId":"createFacilityFundedShareTransfer","name":"Creates a funded share transfer for a facility when participant details are passed. Share of a funding participant is transferred to another funding participant in a club facility and underlying drawings","summary":"Creates a funded share transfer for a facility","tags":["CORPORATE"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"facilityId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"productId":"string","effectiveDate":"2024-01-01","extensions":{},"shareTransfer":[{}]}},"responses":{"200":"createFacilityFundedShareTransferResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"POST","path":"/holdings/creditAgreements/facilities/drawings/{drawingId}/fundedShareTransfers","fullPath":"/api/v7.7.0/holdings/creditAgreements/facilities/drawings/{drawingId}/fundedShareTransfers","operationId":"createDrawingFundedShareTransfer","name":"Creates a funded share transfer for a drawing under a facility when participant details are passed. Share of a funding participant is transferred to another funding participant in a standalone club loan","summary":"Creates a funded share transfer for a drawing","tags":["CORPORATE"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"drawingId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"productId":"string","effectiveDate":"2024-01-01","extensions":{},"shareTransfer":[{}]}},"responses":{"200":"createDrawingFundedShareTransferResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"POST","path":"/holdings/creditAgreements/facilities/{facilityId}/riskShareTransfers","fullPath":"/api/v7.7.0/holdings/creditAgreements/facilities/{facilityId}/riskShareTransfers","operationId":"createFacilityRiskShareTransfer","name":"Creates a risk share transfer for a facility when participant details are passed. The risk of the own bank in a facility is mitigated by selling a portion risk to another financial institution","summary":"Creates a risk share transfer for a facility","tags":["CORPORATE"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"facilityId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"productId":"string","effectiveDate":"2024-01-01","extensions":{},"shareTransfer":[{}]}},"responses":{"200":"createFacilityRiskShareTransferResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"POST","path":"/holdings/creditAgreements/facilities/drawings/{drawingId}/riskShareTransfers","fullPath":"/api/v7.7.0/holdings/creditAgreements/facilities/drawings/{drawingId}/riskShareTransfers","operationId":"createDrawingRiskShareTransfer","name":"Creates a risk share transfer for a drawing under a facility when participant details are passed. The risk of the own bank in a loan is mitigated by selling a portion risk to another financial institution","summary":"Creates a risk share transfer for a drawing","tags":["CORPORATE"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"drawingId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"productId":"string","effectiveDate":"2024-01-01","extensions":{},"shareTransfer":[{}]}},"responses":{"200":"createDrawingRiskShareTransferResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"POST","path":"/holdings/creditAgreements/guarantees/{guaranteeId}/guaranteeIncreases","fullPath":"/api/v7.7.0/holdings/creditAgreements/guarantees/{guaranteeId}/guaranteeIncreases","operationId":"updateGuaranteeCommitmentIncrease","name":"Increase the commitment amount of the guarantee that the financial institution has issued on behalf of the applicant","summary":"Increase the commitment amount of the guarantee","tags":["CORPORATE"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"guaranteeId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"productId":"string","effectiveDate":"2024-01-01","extensions":{},"gteecommitment":[{}]}},"responses":{"200":"updateGuaranteeCommitmentIncreaseResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"POST","path":"/holdings/creditAgreements/guarantees/{guaranteeId}/guaranteeDecreases","fullPath":"/api/v7.7.0/holdings/creditAgreements/guarantees/{guaranteeId}/guaranteeDecreases","operationId":"updateGuaranteeCommitmentDecrease","name":"Decrease the commitment amount of the guarantee that the financial institution has issued on behalf of the applicant","summary":"Decrease the commitment amount of the guarantee","tags":["CORPORATE"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"guaranteeId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"productId":"string","effectiveDate":"2024-01-01","extensions":{},"gteecommitment":[{}]}},"responses":{"200":"updateGuaranteeCommitmentDecreaseResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"POST","path":"/holdings/creditAgreements/guarantees","fullPath":"/api/v7.7.0/holdings/creditAgreements/guarantees","operationId":"createCreditAgreementGuarantee","name":"Register the issuance of a new guarantee undertaking on behalf of the applicant when all the basic details relevant to the undertaking are passed","summary":"Register the issuance of a guarantee","tags":["CORPORATE"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"customers":[{}],"productId":"string","currency":"string","effectiveDate":"2024-01-01","facilityId":"string","extensions":{},"gteecommitment":[{}],"newarrfee":[{}],"settlement":[{}],"termsConditions":[{}]}},"responses":{"200":"createCreditAgreementGuaranteeResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"POST","path":"/holdings/creditAgreements/guarantees/clubGuarantees","fullPath":"/api/v7.7.0/holdings/creditAgreements/guarantees/clubGuarantees","operationId":"createClubGuarantee","name":"Create a club guarantee with guarantee details along with the details of participating lenders","summary":"Create a club guarantee","tags":["CORPORATE"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"customers":[{}],"productId":"string","currency":"string","effectiveDate":"2024-01-01","facilityId":"string","extensions":{},"account":[{}],"gteecommitment":[{}],"newarrfee":[{}],"settlement":[{}],"termsConditions":[{}],"participant":[{}]}},"responses":{"200":"createClubGuaranteeResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"POST","path":"/holdings/creditAgreements/guarantees/{guaranteeId}/cancellations","fullPath":"/api/v7.7.0/holdings/creditAgreements/guarantees/{guaranteeId}/cancellations","operationId":"cancelCorporateGuarantee","name":"Cancel a guarantee arrangement before its expiry date. All the accrued fees are made-due for collection and the bank is discharged of its liability.","summary":"Cancel a guarantee arrangement before the expiry date.","tags":["CORPORATE"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"guaranteeId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"productId":"string","effectiveDate":"2024-01-01","extensions":{},"settlement":[{}]}},"responses":{"200":"cancelCorporateGuaranteeResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"POST","path":"/holdings/creditAgreements/deals","fullPath":"/api/v7.7.0/holdings/creditAgreements/deals","operationId":"createDeals","name":"Create a new deal for the customer with the details like product, term and amount . Corporate deal is a credit agreement between two parties- the lender and the borrower, who agree to certain terms and conditions along with their rights and obligations","summary":"Creates corporate deal","tags":["CORPORATE"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"customers":[{}],"productId":"string","currency":"string","effectiveDate":"2024-01-01","extensions":{},"settlement":[{}],"facilityRules":[{}],"dacommitment":[{}],"adminfee":[{}],"coordinationfee":[{}],"upfrontfee":[{}],"limit":[{}]}},"responses":{"200":"createDealsResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"POST","path":"/holdings/creditAgreements/loanTrades/trades","fullPath":"/api/v7.7.0/holdings/creditAgreements/loanTrades/trades","operationId":"createTrade","name":"Create a trade for a syndicated loan as initially agreed upon between counterparties.","summary":"Create a trade for a syndicated loan.","tags":["CORPORATE"],"parameters":[{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"counterPartyDetails":[{}],"dealCustomerDetails":[{}],"dealAdditionalInfo":[{}],"ssi":[{}],"ownBankDetails":[{}],"agentBankDetails":[{}],"consentDetails":[{}],"chargeDetails":[{}],"tradeAccountDetails":[{}],"tradeActivity":"string","alternateId":"string","tradeProduct":"string","tradeDate":"string","tradeCurrency":"string","transferType":"string"}},"responses":{"200":"TradeResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"POST","path":"/holdings/creditAgreements/loanTrades/{loanTradeId}/confirmationTrade","fullPath":"/api/v7.7.0/holdings/creditAgreements/loanTrades/{loanTradeId}/confirmationTrade","operationId":"acceptTrade","name":"Confirm the trade when all the parties involved agreed the terms and conditions of the trade.","summary":"Confirm the trade","tags":["CORPORATE"],"parameters":[{"name":"loanTradeId","in":"path","type":"string","required":true,"description":""},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"dealCustomerDetails":[{}],"dealAdditionalinfos":[{}],"dealReference":"string","dealTitle":"string","currency":"string","globalAmount":"string","startDate":"string","agentBank":"string","agentId":"string","agentName":"string","extensions":{}}},"responses":{"200":"TradeResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"POST","path":"/holdings/creditAgreements/loanTrades/{loanTradeId}","fullPath":"/api/v7.7.0/holdings/creditAgreements/loanTrades/{loanTradeId}","operationId":"updateTrade","name":"Update additional details in trade.","summary":"Update trade details","tags":["CORPORATE"],"parameters":[{"name":"loanTradeId","in":"path","type":"string","required":true,"description":""},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"dealCustomerDetails":[{}],"dealAdditionalInfo":[{}],"ssi":[{}],"ownBankDetails":[{}],"agentBankDetails":[{}],"chargeDetails":[{}],"tradeAccountDetails":[{}],"alternateId":"string","transferType":"string","expectedSettlementDate":"string","tradeNotes":"string","businessDayCentre":"string","dealReference":"string","dealTitle":"string","currency":"string"}},"responses":{"200":"TradeResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"POST","path":"/holdings/creditAgreements/loanTrades/{loanTradeId}/consents","fullPath":"/api/v7.7.0/holdings/creditAgreements/loanTrades/{loanTradeId}/consents","operationId":"updateConsent","name":"Update borrower consent for trade","summary":"Update consent status if borrower has agreed or rejected trade.","tags":["CORPORATE"],"parameters":[{"name":"loanTradeId","in":"path","type":"string","required":true,"description":""},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"consentDetails":[{}],"chargeDetails":[{}],"tradeStatus":"string","extensions":{}}},"responses":{"200":"ConsentResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"POST","path":"/holdings/creditAgreements/loanTrades/{loanTradeId}/commitments","fullPath":"/api/v7.7.0/holdings/creditAgreements/loanTrades/{loanTradeId}/commitments","operationId":"updateCommitment","name":"Update the trade due to changes in commitment amount being traded.","summary":"Update commitment details","tags":["CORPORATE"],"parameters":[{"name":"loanTradeId","in":"path","type":"string","required":true,"description":""},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"chargeDetails":[{}],"tradeAccountDetails":[{}],"amount":"string","expectedSettlementDate":"string","actualSettlementDate":"string","tradePrice":"string","settlementMethod":"string","allowNetback":"string","allowBoCR":"string","extensions":{}}},"responses":{"200":"CommitmentResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"POST","path":"/holdings/creditAgreements/loanTrades/{loanTradeId}/acceptances","fullPath":"/api/v7.7.0/holdings/creditAgreements/loanTrades/{loanTradeId}/acceptances","operationId":"approveTrade","name":"Finalize the trade to verify all necessary details are available.","summary":"Finalize the trade to issue pricing letter.","tags":["CORPORATE"],"parameters":[{"name":"loanTradeId","in":"path","type":"string","required":true,"description":""},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"dealCustomerDetails":[{}],"dealAdditionalInfo":[{}],"ssi":[{}],"ownBankDetails":[{}],"agentBankDetails":[{}],"tradeNotes":"string","dealReference":"string","dealTitle":"string","currency":"string","globalAmount":"string","startDate":"string","agentBank":"string","agentId":"string","agentName":"string","extensions":{}}},"responses":{"200":"TradeResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"POST","path":"/holdings/creditAgreements/loanTrades/{loanTradeId}/messages","fullPath":"/api/v7.7.0/holdings/creditAgreements/loanTrades/{loanTradeId}/messages","operationId":"showPricingLetter","name":"Issue pricing letter to the counter party for a final settlement amount.","summary":"Issue pricing letter to counterparty.","tags":["CORPORATE"],"parameters":[{"name":"loanTradeId","in":"path","type":"string","required":true,"description":""},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"extensions":{}}},"responses":{"200":"PricingLetterResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"POST","path":"/holdings/creditAgreements/loanTrades/{loanTradeId}/settlements","fullPath":"/api/v7.7.0/holdings/creditAgreements/loanTrades/{loanTradeId}/settlements","operationId":"calculateTrade","name":"Settle the trade in bank books.","summary":"Settle trade.","tags":["CORPORATE"],"parameters":[{"name":"loanTradeId","in":"path","type":"string","required":true,"description":""},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"issuePricing":"string","tradeNotes":"string","extensions":{}}},"responses":{"200":"TradeResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"POST","path":"/holdings/creditAgreements/loanTrades/{loanTradeId}/cancellations","fullPath":"/api/v7.7.0/holdings/creditAgreements/loanTrades/{loanTradeId}/cancellations","operationId":"cancelTrade","name":"Cancel the trade in bank books.","summary":"Cancel trade.","tags":["CORPORATE"],"parameters":[{"name":"loanTradeId","in":"path","type":"string","required":true,"description":""},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"tradeNotes":"string","extensions":{}}},"responses":{"200":"TradeResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/holdings/creditAgreements/loanTrades/{loanTradeId}/charges","fullPath":"/api/v7.7.0/holdings/creditAgreements/loanTrades/{loanTradeId}/charges","operationId":"getCharges","name":"View all the charge details for a given trade.","summary":"View charges.","tags":["CORPORATE"],"parameters":[{"name":"loanTradeId","in":"path","type":"string","required":true,"description":""},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"ChargesResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"PUT","path":"/holdings/creditAgreements/loanTrades/{loanTradeId}/charges","fullPath":"/api/v7.7.0/holdings/creditAgreements/loanTrades/{loanTradeId}/charges","operationId":"updateCharges","name":"Amend charges already authorized in the trade","summary":"Amend charges.","tags":["CORPORATE"],"parameters":[{"name":"loanTradeId","in":"path","type":"string","required":true,"description":""},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"chargeDetails":[{}],"extensions":{}}},"responses":{"200":"ChargesResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/holdings/creditAgreements/loanTrades/products","fullPath":"/api/v7.7.0/holdings/creditAgreements/loanTrades/products","operationId":"getTradeProducts","name":"View all the trade products","summary":"View trade products","tags":["CORPORATE"],"parameters":[{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"TradeProductsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"PUT","path":"/holdings/creditAgreements/facilities/{facilityId}/coordinationFees","fullPath":"/api/v7.7.0/holdings/creditAgreements/facilities/{facilityId}/coordinationFees","operationId":"updateFacilityCoordinationFees","name":"Updation of coordination fees Indicates the fees collected from the borrower to pay to its participants in facility","summary":"Update coordination fees to pay the fee to its participants in facility","tags":["CORPORATE"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"facilityId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"productId":"string","effectiveDate":"2024-01-01","extensions":{},"coordinationfee":[{}]}},"responses":{"200":"updateFacilityCoordinationFeesResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"PUT","path":"/holdings/creditAgreements/facilities/{facilityId}/upfrontFees","fullPath":"/api/v7.7.0/holdings/creditAgreements/facilities/{facilityId}/upfrontFees","operationId":"updateFacilityUpfrontFees","name":"It is a common fee charged by lenders when you apply for a loan, it covers the costs of processing your application, including things like administrative costs, credit assessment, loan set-up and document preparation etc.","summary":"Update the upfront fee which is collect one time by bank","tags":["CORPORATE"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"facilityId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"productId":"string","effectiveDate":"2024-01-01","extensions":{},"upfrontfee":[{}]}},"responses":{"200":"updateFacilityUpfrontFeesResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"PUT","path":"/holdings/creditAgreements/facilities/{facilityId}/drawdowns/rules","fullPath":"/api/v7.7.0/holdings/creditAgreements/facilities/{facilityId}/drawdowns/rules","operationId":"UpdateFacilityDrawingRules","name":"Drawing rules such as borrower, currency, product and product group are defined for drawdown under facility level.","summary":"Initiate drawing rules to restrict customer, currency and products for drawdown under facility level.","tags":["CORPORATE"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"facilityId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"productId":"string","effectiveDate":"2024-01-01","extensions":{},"drawingRules":[{}]}},"responses":{"200":"UpdateFacilityDrawingRulesResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"PUT","path":"/holdings/creditAgreements/facilities/{facilityId}/drawdowns/conditions","fullPath":"/api/v7.7.0/holdings/creditAgreements/facilities/{facilityId}/drawdowns/conditions","operationId":"updateFacilityDrawingConditions","name":"Drawing condition are set based on the product line, product group, product, property, currency, attribute, value, message for drawdown under facility level.","summary":"Initiate drawing condition to restrict customer, currency and products for drawdown with overrides.","tags":["CORPORATE"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"facilityId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"productId":"string","effectiveDate":"2024-01-01","extensions":{},"drawingConditions":[{}]}},"responses":{"200":"updateFacilityDrawingConditionsResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"PUT","path":"/holdings/creditAgreements/deals/{dealId}/commitmentAndTermBlock","fullPath":"/api/v7.7.0/holdings/creditAgreements/deals/{dealId}/commitmentAndTermBlock","operationId":"UpdateBlockcommitmentandTerm","name":"Existing deal level commitment term is blocked","summary":"Block the commitment and term of the existing deal arrangement.","tags":["CORPORATE"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"dealId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"parties":[{}],"activityId":"string","effectiveDate":"string","productId":"string","currencyId":"string","simulationId":"string","extensions":{}}},"responses":{"200":"UpdateBlockcommitmentandTermResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"PUT","path":"/holdings/creditAgreements/deals/{dealId}/commitmentAndTermUnblock","fullPath":"/api/v7.7.0/holdings/creditAgreements/deals/{dealId}/commitmentAndTermUnblock","operationId":"UpdateUnblockcommitmentandTerm","name":"Existing deal level commitment term is unblocked","summary":"Unblock the commitment and term of the existing deal arrangement.","tags":["CORPORATE"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"dealId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"parties":[{}],"activityId":"string","effectiveDate":"string","productId":"string","currencyId":"string","simulationId":"string","extensions":{}}},"responses":{"200":"UpdateUnblockcommitmentandTermResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"PUT","path":"/holdings/creditAgreements/deals/{dealId}/commitmentTerms","fullPath":"/api/v7.7.0/holdings/creditAgreements/deals/{dealId}/commitmentTerms","operationId":"updateDealCommitmentTerms","name":"Deal tenure can be increased or decreased","summary":"Update tenure by increasing or decreasing the term in deal level","tags":["CORPORATE"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"dealId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"productId":"string","effectiveDate":"2024-01-01","extensions":{},"dacommitment":[{}]}},"responses":{"200":"updateDealCommitmentTermsResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"PUT","path":"/holdings/creditAgreements/facilities/{facilityId}/scheduleDefinitions","fullPath":"/api/v7.7.0/holdings/creditAgreements/facilities/{facilityId}/scheduleDefinitions","operationId":"updateFacilityPaymentSchedules","name":"Allow user to change schedule condition in facility level.","summary":"User to change schedule condition in facility level.","tags":["CORPORATE"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"facilityId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"productId":"string","effectiveDate":"2024-01-01","extensions":{},"schedule":[{}],"feeschedule":[{}]}},"responses":{"200":"updateFacilityPaymentSchedulesResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"GET","path":"/holdings/creditAgreements/facilities/{facilityId}/participants","fullPath":"/api/v7.7.0/holdings/creditAgreements/facilities/{facilityId}/participants","operationId":"getFacilityParticipant","name":"Retrieve participant details for the specific facility arrangement","summary":"Retrieve participant details for the specific facility arrangement","tags":["CORPORATE"],"parameters":[{"name":"facilityId","in":"path","type":"string","required":true,"description":"Unique identifier (contract number) of the facility"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"FacilityParticipantResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"PUT","path":"/holdings/creditAgreements/facilities/{facilityId}/participants","fullPath":"/api/v7.7.0/holdings/creditAgreements/facilities/{facilityId}/participants","operationId":"updateparticipant","name":"Update participant settlement instructions, skims, charges, own bank account details, agent bank beneficiary details and trading details.","summary":"Update participant settlement instructions, skims, charges, own bank account details, agent bank beneficiary details and trading details.","tags":["CORPORATE"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"facilityId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"productId":"string","effectiveDate":"2024-01-01","extensions":{},"participant":[{}]}},"responses":{"200":"updateparticipantResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"PUT","path":"/holdings/creditAgreements/facility/{facilityId}/adjustments","fullPath":"/api/v7.7.0/holdings/creditAgreements/facility/{facilityId}/adjustments","operationId":"initiateAdjustmets","name":"Bill balances  such as commitment balance, principal or interest or charge amount of facility should be adjusted","summary":"Perform adjust balances and bills such as commitment balance, principal or interest or charge amount of facility","tags":["CORPORATE"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"facilityId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"productId":"string","effectiveDate":"2024-01-01","extensions":{},"balanceMaintenance":[{}]}},"responses":{"200":"initiateAdjustmetsResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"PUT","path":"/holdings/creditAgreements/facilities/{facilityId}/commitmentAndTermBlock","fullPath":"/api/v7.7.0/holdings/creditAgreements/facilities/{facilityId}/commitmentAndTermBlock","operationId":"updateBlockFacilityCommitment","name":"There could be adverse credit rating of the customer as part of the periodic review and bank would like to restrict further credit exposure. In such cases when the facility is blocked further drawdowns are not allowed while the existing drawings can be serviced.","summary":"When the facility is blocked further drawdowns are not allowed while the existing drawings can be serviced.","tags":["CORPORATE"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"facilityId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"parties":[{}],"activityId":"string","effectiveDate":"string","productId":"string","currencyId":"string","simulationId":"string","extensions":{}}},"responses":{"200":"updateBlockFacilityCommitmentResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"PUT","path":"/holdings/creditAgreements/facilities/{facilityId}/commitmentAndTermUnblock","fullPath":"/api/v7.7.0/holdings/creditAgreements/facilities/{facilityId}/commitmentAndTermUnblock","operationId":"updateUnblockFacilityCommitment","name":"There could be adverse credit rating of the customer as part of the periodic review and bank would have restricted further credit exposure and stipulated some mitigants to be fulfilled by customer based on which the restrictions on credit exposure can be lifted. This API is used to unblock the facility commitment.","summary":"Update unblock facility commitment is used to unblock the blocked commitment.","tags":["CORPORATE"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"facilityId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"parties":[{}],"activityId":"string","effectiveDate":"string","productId":"string","currencyId":"string","simulationId":"string","extensions":{}}},"responses":{"200":"updateUnblockFacilityCommitmentResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"GET","path":"/holdings/creditAgreements/deal/{dealId}/drawings/conditions","fullPath":"/api/v7.7.0/holdings/creditAgreements/deal/{dealId}/drawings/conditions","operationId":"getDealDrawingCondition","name":"Retrieve drawing conditions for the specific deal or facility arrangement","summary":"Retrieve drawing conditions for the specific deal or facility arrangement","tags":["CORPORATE"],"parameters":[{"name":"dealId","in":"path","type":"string","required":true,"description":"Unique identifier (contract number) of the corporate deals"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"DealDrawingConditionResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"PUT","path":"/holdings/creditAgreements/drawings/{drawingId}/commitmentIncreases","fullPath":"/api/v7.7.0/holdings/creditAgreements/drawings/{drawingId}/commitmentIncreases","operationId":"createDrawdownCommitmentIncrease","name":"To increase the drawdown commitment for a given arrangement","summary":"To increase the drawdown commitment for a given arrangement","tags":["CORPORATE"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"drawingId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"productId":"string","drawdownDate":"2024-01-01","extensions":{},"dwcommitment":[{}]}},"responses":{"200":"createDrawdownCommitmentIncreaseResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"PUT","path":"/holdings/creditAgreements/drawings/{drawingId}/commitmentDecreases","fullPath":"/api/v7.7.0/holdings/creditAgreements/drawings/{drawingId}/commitmentDecreases","operationId":"createDrawdownCommitmentDecreases","name":"To decrease the drawdown commitment for a given arrangement","summary":"To decrease the drawdown commitment for a given arrangement","tags":["CORPORATE"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"drawingId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"productId":"string","drawdownDate":"2024-01-01","extensions":{},"dwcommitment":[{}]}},"responses":{"200":"createDrawdownCommitmentDecreasesResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"PUT","path":"/holdings/creditAgreements/facility/{facilityId}/writeOffs","fullPath":"/api/v7.7.0/holdings/creditAgreements/facility/{facilityId}/writeOffs","operationId":"updateWriteOffBillMaintenance","name":"Perform the write off of all the balances and bills of a loan. Bank calls for the write off of a loan borrowed by a defaulter when the chances of loan recovery are almost zero and its assets are non-performing.","summary":"Writeoff bill balance under facility level","tags":["CORPORATE"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"facilityId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"productId":"string","effectiveDate":"2024-01-01","extensions":{},"balanceMaintenance":[{}]}},"responses":{"200":"updateWriteOffBillMaintenanceResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"PUT","path":"/holdings/creditAgreements/{creditAgreementId}/commitmentTerms","fullPath":"/api/v7.7.0/holdings/creditAgreements/{creditAgreementId}/commitmentTerms","operationId":"updateFacilityTerm","name":"Decrease/Increase the maturity period of the facility","summary":"Decrease/ Increase the maturity period of the credit agreement(facility)","tags":["CORPORATE"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"creditAgreementId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"effectiveDate":"2024-01-01","activityId":"string","externalEventStatus":"string","extensions":{},"facommitment":[{}]}},"responses":{"200":"updateFacilityTermResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"PUT","path":"/holdings/creditAgreements/{creditAgreementId}/cancellations","fullPath":"/api/v7.7.0/holdings/creditAgreements/{creditAgreementId}/cancellations","operationId":"cancelFacility","name":"Perform the full credit agreement (facility) cancellation","summary":"Cancel the facility for buy now pay later service","tags":["CORPORATE"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"creditAgreementId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"effectiveDate":"2024-01-01","activityId":"string","externalEventStatus":"string","extensions":{},"account":[{}]}},"responses":{"200":"cancelFacilityResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"POST","path":"/holdings/creditAgreements/buyNowPayLater/facilities","fullPath":"/api/v7.7.0/holdings/creditAgreements/buyNowPayLater/facilities","operationId":"createFacility","name":"Creates corporate facilities","summary":"Creates corporate facilities","tags":["CORPORATE"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"customers":[{}],"productId":"string","currency":"string","effectiveDate":"2024-01-01","dealId":"string","extensions":{},"settlement":[{}],"facommitment":[{}],"upfrontfee":[{}],"coordinationfee":[{}],"limit":[{}]}},"responses":{"200":"createFacilityResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"PUT","path":"/holdings/creditAgreements/{creditAgreementId}/commitmentIncreases","fullPath":"/api/v7.7.0/holdings/creditAgreements/{creditAgreementId}/commitmentIncreases","operationId":"updateFacilityTopupAmount","name":"Increase the commitment amount of the credit agreement (facility) with the incremental amount","summary":"Increase the commitment amount of the facility","tags":["CORPORATE"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"creditAgreementId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"effectiveDate":"2024-01-01","activityId":"string","externalEventStatus":"string","extensions":{},"facommitment":[{}]}},"responses":{"200":"updateFacilityTopupAmountResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"PUT","path":"/holdings/creditAgreements/{creditAgreementId}/commitmentDecreases","fullPath":"/api/v7.7.0/holdings/creditAgreements/{creditAgreementId}/commitmentDecreases","operationId":"updateFacilityDecreaseAmount","name":"Decrease the commitment amount of the credit agreement (facility) by the specified amount","summary":"Decrease the commitment amount of the facility","tags":["CORPORATE"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"creditAgreementId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"effectiveDate":"2024-01-01","activityId":"string","externalEventStatus":"string","extensions":{},"facommitment":[{}]}},"responses":{"200":"updateFacilityDecreaseAmountResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"POST","path":"/holdings/creditAgreements/loanTrades/{loanTradeId}/subAllocations","fullPath":"/api/v7.7.0/holdings/creditAgreements/loanTrades/{loanTradeId}/subAllocations","operationId":"allocateTrade","name":"The division of the sold loans by the seller, as advised by the original buyer.","summary":"Allocation of the sold loans among multiple buyers.","tags":["CORPORATE"],"parameters":[{"name":"loanTradeId","in":"path","type":"string","required":true,"description":"Unique identifier generated for each trade booked in  the system."},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"buyerDetails":[{}],"tradeActivity":"string","tradeStatus":"string","extensions":{}}},"responses":{"200":"TradeResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/holdings/creditAgreements/arrangements/evidences/upcoming","fullPath":"/api/v7.7.0/holdings/creditAgreements/arrangements/evidences/upcoming","operationId":"getEvidencesUpcoming","name":"Retrieves the covenants and conditions associated with an arrangement which are falling due in the near future","summary":"Retrieves the covenants and conditions associated with an arrangement which are falling due in the near future","tags":["CORPORATE"],"parameters":[{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"EvidencesUpcomingResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/creditAgreements/arrangements/evidences/nonCompliances","fullPath":"/api/v7.7.0/holdings/creditAgreements/arrangements/evidences/nonCompliances","operationId":"getEvidencesNonCompliance","name":"Retrieves the covenants and conditions associated with an arrangement which are non compliant in nature","summary":"Retrieves the covenants and conditions associated with an arrangement which are non compliant in nature","tags":["CORPORATE"],"parameters":[{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"EvidencesNonComplianceResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/creditAgreements/arrangements/evidences/dues","fullPath":"/api/v7.7.0/holdings/creditAgreements/arrangements/evidences/dues","operationId":"getEvidencesDue","name":"Retrieves the covenants and conditions associated with an arrangement which are either due or overdue","summary":"Retrieves the covenants and conditions associated with an arrangement which are either due or overdue","tags":["CORPORATE"],"parameters":[{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"EvidencesDueResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"PUT","path":"/holdings/creditAgreements/facility/{facilityId}/offers/negotiations","fullPath":"/api/v7.7.0/holdings/creditAgreements/facility/{facilityId}/offers/negotiations","operationId":"createOfferFacilityNegotiation","name":"Negotiate the offer facility for the required customer","summary":"Negotiate the offer facility for the required customer","tags":["CORPORATE"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"facilityId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{},"responses":{"200":"createOfferFacilityRenegotiationResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"POST","path":"/holdings/creditAgreements/facilities/offers","fullPath":"/api/v7.7.0/holdings/creditAgreements/facilities/offers","operationId":"createFacilityOffer","name":"Creates a new offer facility for the required customer when at least the mandatory input is provided. Offer facility creates a draft contract and allow the users to negotiate multiple times. Offer facility is a draft contract and will not affect the balance sheet of the bank.","summary":"Creates an offer for a facility contract","tags":["CORPORATE"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"customers":[{}],"productId":"string","currency":"string","dealId":"string","effectiveDate":"2024-01-01","activity":"string","extensions":{},"account":[{}],"feeschedule":[{}],"settlement":[{}],"drawingRules":[{}],"facommitment":[{}],"upfrontfee":[{}],"coordinationfee":[{}],"limit":[{}]}},"responses":{"200":"createFacilityOfferResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"GET","path":"/holdings/creditAgreements/arrangements/{arrangementId}/charges","fullPath":"/api/v7.7.0/holdings/creditAgreements/arrangements/{arrangementId}/charges","operationId":"getChargeConditions","name":"Retrieves the charge details associated at facility and drawdown level","summary":"Retrieves the charge details associated at facility and drawdown level","tags":["CORPORATE"],"parameters":[{"name":"arrangementId","in":"path","type":"string","required":true,"description":"Indicates an unique identifier of an account"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"ChargeConditionsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"PUT","path":"/holdings/creditAgreements/drawings/{drawingsId}/rolloverType","fullPath":"/api/v7.7.0/holdings/creditAgreements/drawings/{drawingsId}/rolloverType","operationId":"createDrawingsRollovers","name":"Splits/Merge/Rollover in Drawings level","summary":"Splits/Merge/Rollover a drawings into many drawings","tags":["CORPORATE"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"drawingsId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"parties":[{}],"activityId":"string","effectiveDate":"string","productId":"string","currencyId":"string","simulationId":"string","extensions":{},"splitsMerges":[{}]}},"responses":{"200":"createDrawingsRolloversResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"GET","path":"/holdings/creditAgreements/drawings/{drawingId}/exchangeRates","fullPath":"/api/v7.7.0/holdings/creditAgreements/drawings/{drawingId}/exchangeRates","operationId":"getExchangeRates","name":"Retrieves the exchange rate maintained at drawdown which is used for conversion of amount in different currencies.","summary":"Retrieves the exchange rate maintained at drawdown which is used for conversion of amount in different currencies.","tags":["CORPORATE"],"parameters":[{"name":"drawingId","in":"path","type":"string","required":true,"description":"Unique identifier (contract number) of the drawdown"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"ExchangeRatesResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"PUT","path":"/holdings/creditAgreements/deal/{dealId}/schedules","fullPath":"/api/v7.7.0/holdings/creditAgreements/deal/{dealId}/schedules","operationId":"updateDealPaymentSchedule","name":"When there is requirement to change the schedule based on the type, method, frequency, property, start/end date , no of payments, and calculated amount, bill type and in advance, by using this activity user should be able to update the schedule and based on which the charges are paid","summary":"Allow user to change fee schedule condition in deal level.","tags":["CORPORATE"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"arrangementId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{},"responses":{"200":"updateFeeScheduleResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"PUT","path":"/holdings/creditAgreements/facilities/{facilityId}/rolloverType","fullPath":"/api/v7.7.0/holdings/creditAgreements/facilities/{facilityId}/rolloverType","operationId":"createFacilityRollovers","name":"API for the creation and management of credit agreements for corporate customers. The types of credit agreements are single level facility, credit agreement with multiple facilities, club loans with agency and syndicated loans","summary":"Splits a drawings into many drawings in facility level","tags":["CORPORATE"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"facilityId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"customers":[{}],"productId":"string","currency":"string","effectiveDate":"2024-01-01","dealId":"string","extensions":{},"splitsMerges":[{}]}},"responses":{"200":"createFacilityRolloversResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"PUT","path":"/holdings/creditAgreements/arrangements/{arrangementId}/interestRatchet","fullPath":"/api/v7.7.0/holdings/creditAgreements/arrangements/{arrangementId}/interestRatchet","operationId":"updateInterestMarginRatchet","name":"Update margin ratchet details for principal Interest, penal interest and commission at deal level","summary":"Update interest margin ratchet details for a deal or facility","tags":["CORPORATE"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"arrangementId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"productId":"string","effectiveDate":"2024-01-01","extensions":{},"pgMarginGrid":[{}]}},"responses":{"200":"updateInterestMarginRatchetResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"PUT","path":"/holdings/creditAgreements/arrangements/{arrangementId}/feeRatchet","fullPath":"/api/v7.7.0/holdings/creditAgreements/arrangements/{arrangementId}/feeRatchet","operationId":"updateFeeRatchet","name":"Update fee ratchet for a given facility or deal arrangement","summary":"Update fee ratchet for a given facility or deal arrangement","tags":["CORPORATE"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"arrangementId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{},"responses":{"200":"updateFeeRatchetResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"GET","path":"/holdings/creditAgreements/arrangements/{arrangementId}/margins","fullPath":"/api/v7.7.0/holdings/creditAgreements/arrangements/{arrangementId}/margins","operationId":"getInterestAndMarginDetails","name":"Retrieves the fee and margin ratchet details pertaining to deal, facility or drawdown","summary":"Retrieves the fee and margin ratchet details pertaining to deal, facility or drawdown","tags":["CORPORATE"],"parameters":[{"name":"arrangementId","in":"path","type":"string","required":true,"description":"Indicates an unique identifier of an account"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"InterestAndMarginDetailsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/creditAgreements/facilities/closures","fullPath":"/api/v7.7.0/holdings/creditAgreements/facilities/closures","operationId":"getClosedMaturedFacilities","name":"Retrieves the list of closed or matured accounts for facility product line","summary":"Retrieves the list of closed or matured accounts for facility product line","tags":["CORPORATE"],"parameters":[{"name":"arrangementId","in":"query","type":"string","required":false,"description":"Indicates an unique identifier of an account"},{"name":"productGroup","in":"query","type":"string","required":false,"description":"Indicates a group under which the products exists"},{"name":"product","in":"query","type":"string","required":false,"description":"Contains the name of the product"},{"name":"currency","in":"query","type":"string","required":false,"description":"Identifies the currency. E.g. USD, GBP etc"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"ClosedMaturedFacilitiesResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"PUT","path":"/holdings/creditAgreements/facilities/{facilityId}/exchangeRates","fullPath":"/api/v7.7.0/holdings/creditAgreements/facilities/{facilityId}/exchangeRates","operationId":"updateExchangeRate","name":"Given the scenario, when there is a cross currency involved considering facility and drawings in different currencies, exchange rate is applicable and the same is updated using the exchange rate functionality. Exchange rate property class is to define the Exchange Rate (FX), rate tolerance and prior days, advance FX fix activity, and so on to support the advance FX fixing requirement. Drawings created other than the facility currency, the exchange rate defined under the exchange rate property sh","summary":"Update exchange rate maintained at facility level which is used during cross currency drawings","tags":["CORPORATE"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"facilityId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"productId":"string","effectiveDate":"2024-01-01","extensions":{},"exchangeRate":[{}]}},"responses":{"200":"updateExchangeRateResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"GET","path":"/holdings/creditAgreements/arrangements","fullPath":"/api/v7.7.0/holdings/creditAgreements/arrangements","operationId":"getCreditAgreements","name":"Given the scenario when the user wants to fetch the complete authorized deal details , by inputting the details like arrangement id, customer number, product group , product , currency they should get the output pertains to that respective deal","summary":"Retrieves the list of deals and facilities along with their basic information","tags":["CORPORATE"],"parameters":[{"name":"arrangementId","in":"query","type":"string","required":false,"description":"Indicates an unique identifier of an account"},{"name":"customers","in":"query","type":"string","required":false,"description":"Contains the customer identifier"},{"name":"allowedProductGroup","in":"query","type":"string","required":false,"description":"Group allowed to be used for a sub contract, for example Mortgages or Term Loans"},{"name":"aaProduct","in":"query","type":"string","required":false,"description":"This is the product associated with the arrangement, set of values to select from."},{"name":"allowedCurrency","in":"query","type":"string","required":false,"description":"Available currencies for the product"},{"name":"status","in":"query","type":"string","required":false,"description":"Contains status of the data rights request.Allowed values are INITIATED, INPROGESS, EXTENDED, COMPLETED, REJECTED."},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"CreditAgreementsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"PUT","path":"/holdings/creditAgreements/arrangements/{arrangementId}/covenants","fullPath":"/api/v7.7.0/holdings/creditAgreements/arrangements/{arrangementId}/covenants","operationId":"updateCovenantsFacility","name":"Performs update of covenants and conditions for a facility. Covenants are requested in periodic basis and the conditions are one-time evidence. On non-submission or non-compliance of the evidences, the related consequent activity will be restricted","summary":"Update the covenants and conditions for a facility or deal","tags":["CORPORATE"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"arrangementId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"partyIds":[{}],"partyRoles":[{}],"agentCustomerIds":[{}],"agentArrangementIds":[{}],"agentRoles":[{}],"arrangmentId":"string","productId":"string","activityId":"string","currency":"string","productVariation":"string","pricingSelection":"string","pricingPlan":"string","rewardsArrangementId":"string","tradeDate":"string","arrangementEffectiveDate":"string"}},"responses":{"200":"updateCovenantsFacilityResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"PUT","path":"/holdings/creditAgreements/drawings/{drawingId}/covenants","fullPath":"/api/v7.7.0/holdings/creditAgreements/drawings/{drawingId}/covenants","operationId":"updateCovenantDrawings","name":"Performs update of covenants and conditions for a loan account. Covenants are requested in periodic basis and the conditions are one-time evidence. On non-submission or non-compliance of the evidences, the related consequent activity will be restricted","summary":"Update the covenants and conditions for a loan account","tags":["CORPORATE"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"drawingId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"partyIds":[{}],"partyRoles":[{}],"agentCustomerIds":[{}],"agentArrangementIds":[{}],"agentRoles":[{}],"arrangmentId":"string","productId":"string","activityId":"string","currency":"string","productVariation":"string","pricingSelection":"string","pricingPlan":"string","rewardsArrangementId":"string","tradeDate":"string","arrangementEffectiveDate":"string"}},"responses":{"200":"updateCovenantDrawingsResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"PUT","path":"/holdings/creditAgreements/deal/{dealId}/administrativeFees","fullPath":"/api/v7.7.0/holdings/creditAgreements/deal/{dealId}/administrativeFees","operationId":"updateAdministrativeFees","name":"Update administrative fee collected for the deal","summary":"Update administrative fee collected for the deal","tags":["CORPORATE"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"dealId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"productId":"string","effectiveDate":"2024-01-01","extensions":{},"schedule":[{}],"adminfee":[{}]}},"responses":{"200":"updateAdministrativeFeesResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"PUT","path":"/holdings/creditAgreements/drawings/{drawingId}/adjustments","fullPath":"/api/v7.7.0/holdings/creditAgreements/drawings/{drawingId}/adjustments","operationId":"initiateDrawingsAdjustments","name":"Bill balances such as commitment balance, principal or interest or charge amount of facility should be adjusted","summary":"Perform adjust balances and bills such as commitment balance, principal or interest or charge amount of facility","tags":["CORPORATE"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"drawingId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"productId":"string","effectiveDate":"2024-01-01","extensions":{},"balanceMaintenance":[{}]}},"responses":{"200":"initiateDrawingsAdjustmentsResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"POST","path":"/holdings/creditAgreements/drawdowns","fullPath":"/api/v7.7.0/holdings/creditAgreements/drawdowns","operationId":"createDrawdowns","name":"Creates drawdowns under facility","summary":"Creates drawdowns under facility","tags":["CORPORATE"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"customers":[{}],"currency":"string","facilityId":"string","effectiveDate":"string","activity":"string","productId":"string","extensions":{},"escrow":[{}],"schedule":[{}],"dwcommitment":[{}],"settlement":[{}]}},"responses":{"200":"createDrawdownsResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"PUT","path":"/holdings/creditAgreements/drawings/{drawingId}/pricings","fullPath":"/api/v7.7.0/holdings/creditAgreements/drawings/{drawingId}/pricings","operationId":"updateDrawingPricingGrid","name":"Update pricing grid margin for principal & penal interest at drawdown level","summary":"Update pricing grid margin for principal & penal interest at drawdown level","tags":["CORPORATE"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"drawingId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"productId":"string","effectiveDate":"2024-01-01","extensions":{},"principalint":[{}],"penaltyint":[{}],"penalint":[{}]}},"responses":{"200":"updateDrawingPricingGridResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}}]},{"key":"holdings-creditLimits-service-v1.0.0","title":"Credit Limits","version":"v1.0.0","description":"APIs to create, manage and approve or cancel credit limits types and limits overseen by the credit committee. Credit Limits are overdraft features on a contract or account of a customer approved by credit committee. These APIs also provides review reports, expiry reports and utilization reports of t","endpointCount":54,"endpoints":[{"method":"POST","path":"/holdings/creditLimits/limits/unsecuredLimits","fullPath":"/api/v1.0.0/holdings/creditLimits/limits/unsecuredLimits","operationId":"createUnsecuredLimits","name":"Allows creation of credit limit for customer which doesn't require any assets to secure the limit, with information such as limit product, approved amount, currency, allowed and restricted definitions of limit products, customers or risk group and companies, intraday balance details, expiry date and review frequency of limit.","summary":"Allows creation of unsecured credit limit for the given limit product & customer.","tags":["RETAIL"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"","default":"","400":"","500":""}},{"method":"PUT","path":"/holdings/creditLimits/limits/{limitId}/unsecuredLimits","fullPath":"/api/v1.0.0/holdings/creditLimits/limits/{limitId}/unsecuredLimits","operationId":"updateUnsecuredLimits","name":"Allows amendment of credit limit for customer which doesn't require any assets to secure the limit, with information such as limit product, approved amount, currency, allowed and restricted definitions of limit products, customers or risk group and companies, intraday balance details, expiry date and review frequency of limit.","summary":"Allows amendment of unsecured credit limit details.","tags":["RETAIL"],"parameters":[{"name":"limitId","in":"path","type":"string","required":true,"description":"The identifier of credit limit"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"","default":"","400":"","500":""}},{"method":"PUT","path":"/holdings/creditLimits/limits/{limitId}/dates","fullPath":"/api/v1.0.0/holdings/creditLimits/limits/{limitId}/dates","operationId":"updateLimitExpiry","name":"Allows amendment of expiry date & admin extension date of a credit limit where the date can be extended or reduced.","summary":"Allows amendment of expiry date & admin extension date of a credit limit ","tags":["RETAIL"],"parameters":[{"name":"limitId","in":"path","type":"string","required":true,"description":"The identifier of credit limit"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"","default":"","400":"","500":""}},{"method":"PUT","path":"/holdings/creditLimits/limits/{limitId}/limitAvailabilities","fullPath":"/api/v1.0.0/holdings/creditLimits/limits/{limitId}/limitAvailabilities","operationId":"updateLimitAvailability","name":"Allows amendment to the credit limit availability to specify if the limit is available for use.","summary":"Allows amendment to the credit limit availability","tags":["RETAIL"],"parameters":[{"name":"limitId","in":"path","type":"string","required":true,"description":"The identifier of credit limit"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"","default":"","400":"","500":""}},{"method":"PUT","path":"/holdings/creditLimits/limits/{limitId}/limitAmounts","fullPath":"/api/v1.0.0/holdings/creditLimits/limits/{limitId}/limitAmounts","operationId":"updateLimitAmounts","name":"Allows amendment of credit limit amount related values such as approved amount, advised amount & maximum total amount.","summary":"Allows amendment of credit limit amounts","tags":["RETAIL"],"parameters":[{"name":"limitId","in":"path","type":"string","required":true,"description":"The identifier of credit limit"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"","default":"","400":"","500":""}},{"method":"PUT","path":"/holdings/creditLimits/limits/{limitId}/approvals","fullPath":"/api/v1.0.0/holdings/creditLimits/limits/{limitId}/approvals","operationId":"approveLimits","name":"Allows authorization of limit product with information such as product name, product type, mnemonic, exposure percentage, etc","summary":"Allows authorization of credit limit","tags":["RETAIL"],"parameters":[{"name":"limitId","in":"path","type":"string","required":true,"description":"The identifier of credit limit"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"","default":"","400":"","500":""}},{"method":"GET","path":"/holdings/creditLimits/limits/{limitId}","fullPath":"/api/v1.0.0/holdings/creditLimits/limits/{limitId}","operationId":"getCreditLimitDetails","name":"Retrieves the details of credit limit such as product, currency, serial no, approved amount, advised amount, maximum total, available amount based on the given limit identifier","summary":"Retrieve the details about the credit limit for the given limit identifier","tags":["RETAIL"],"parameters":[{"name":"limitId","in":"path","type":"string","required":true,"description":"The identifier of credit limit"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"","default":"","400":"","500":""}},{"method":"DELETE","path":"/holdings/creditLimits/limits/{limitId}","fullPath":"/api/v1.0.0/holdings/creditLimits/limits/{limitId}","operationId":"deleteUnapprovedLimit","name":"Allows deletion of unapproved credit limit that is no longer required.","summary":"Allows deletion of an unapproved credit limit","tags":["RETAIL"],"parameters":[{"name":"limitId","in":"path","type":"string","required":true,"description":"The identifier of credit limit"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"","default":"","400":"","500":""}},{"method":"DELETE","path":"/holdings/creditLimits/limits/{limitId}/cancellations","fullPath":"/api/v1.0.0/holdings/creditLimits/limits/{limitId}/cancellations","operationId":"cancelLimit","name":"Allows cancellation of credit limit that is no more available for utilization or not being utilized.","summary":"Allows cancellation of a credit limit","tags":["RETAIL"],"parameters":[{"name":"limitId","in":"path","type":"string","required":true,"description":"The identifier of credit limit"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"","default":"","400":"","500":""}},{"method":"GET","path":"/holdings/creditLimits/products/pendingApprovals","fullPath":"/api/v1.0.0/holdings/creditLimits/products/pendingApprovals","operationId":"getUnapprovedLimitProducts","name":"Retrieves the details of unapproved limit products such as product description, shortname, reducing limit, mnemonic, limit type","summary":"Retrieves the details of unapproved limit products","tags":["RETAIL"],"parameters":[{"name":"productId","in":"query","type":"string","required":false,"description":"Contains the unique identifier of the product, e.g. the product id of the arrangement account."},{"name":"nonRevolving","in":"query","type":"string","required":false,"description":"Indicates whether the nature of limit product is revolving or non revolving."},{"name":"mnemonic","in":"query","type":"string","required":false,"description":"Shortcut code for referring an Entity/Company/Branch."},{"name":"productLevel","in":"query","type":"string","required":false,"description":"Indicates the type of limit to be created in product hierarchy structure."},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"","default":"","400":"","500":""}},{"method":"GET","path":"/holdings/creditLimits/limits/expiringLimits","fullPath":"/api/v1.0.0/holdings/creditLimits/limits/expiringLimits","operationId":"getExpiringCreditLimits","name":"Retrieves the list of limits which are about to expire for a given date. System uses the default expiry period if the query parameters are not supplied","summary":"Retrieves the list of credit limits which are about to expire","tags":["RETAIL"],"parameters":[{"name":"uptoExpiryDate","in":"query","type":"string","required":false,"description":"Indicates the date based on  which expiring limits should be retrieved."},{"name":"daysToExpiry","in":"query","type":"string","required":false,"description":"Indicates the number of days based on which expiring limits should be retrieved."},{"name":"customerId","in":"query","type":"string","required":false,"description":"Identifier of the customer"},{"name":"limitCurrency","in":"query","type":"string","required":false,"description":"Currency in which the credit limit is granted"},{"name":"limitProduct","in":"query","type":"string","required":false,"description":"Identifier of the credit limit product"},{"name":"productLevel","in":"query","type":"string","required":false,"description":"Indicates the type of limit to be created in product hierarchy structure."},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"","default":"","400":"","500":""}},{"method":"GET","path":"/holdings/creditLimits/limits/expiredLimits","fullPath":"/api/v1.0.0/holdings/creditLimits/limits/expiredLimits","operationId":"getExpiredLimits","name":"Retrieves the list of credit limits which are expired","summary":"Retrieves the list of credit limits which are expired","tags":["RETAIL"],"parameters":[{"name":"customerId","in":"query","type":"string","required":false,"description":"Identifier of the customer"},{"name":"limitCurrency","in":"query","type":"string","required":false,"description":"Currency in which the credit limit is granted"},{"name":"limitProduct","in":"query","type":"string","required":false,"description":"Identifier of the credit limit product"},{"name":"productLevel","in":"query","type":"string","required":false,"description":"Indicates the type of limit to be created in product hierarchy structure."},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"","default":"","400":"","500":""}},{"method":"GET","path":"/holdings/creditLimits/limits/assessments","fullPath":"/api/v1.0.0/holdings/creditLimits/limits/assessments","operationId":"getLimitsForAssessment","name":"Retrieves the list of limits which are to be reviewed by a given date. System uses the default review period if the query parameters are not supplied","summary":"Retrieves the list of credit limits which are due for review","tags":["RETAIL"],"parameters":[{"name":"uptoReviewDate","in":"query","type":"string","required":false,"description":"Indicates the date based on  which limits should be reviewed."},{"name":"daysToReview","in":"query","type":"string","required":false,"description":"Indicates the number of days based on which limits should be reviewed."},{"name":"customerId","in":"query","type":"string","required":false,"description":"Identifier of the customer"},{"name":"limitCurrency","in":"query","type":"string","required":false,"description":"Currency in which the credit limit is granted"},{"name":"limitProduct","in":"query","type":"string","required":false,"description":"Identifier of the credit limit product"},{"name":"productLevel","in":"query","type":"string","required":false,"description":"Indicates the type of limit to be created in product hierarchy structure."},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"","default":"","400":"","500":""}},{"method":"PUT","path":"/holdings/creditLimits/limits/{limitId}/scheduleIncreases","fullPath":"/api/v1.0.0/holdings/creditLimits/limits/{limitId}/scheduleIncreases","operationId":"createLimitScheduleIncrease","name":"Allows increase of credit limit amount such as approved amount, advised amount & maximum total amount by defining a periodic schedule.","summary":"Allows increase of limit amount on a periodical schedule.","tags":["RETAIL"],"parameters":[{"name":"limitId","in":"path","type":"string","required":true,"description":"The identifier of credit limit"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"","default":"","400":"","500":""}},{"method":"PUT","path":"/holdings/creditLimits/limits/{limitId}/scheduleDecreases","fullPath":"/api/v1.0.0/holdings/creditLimits/limits/{limitId}/scheduleDecreases","operationId":"createLimitScheduleDecrease","name":"Allows decrease of credit limit amount such as approved amount, advised amount & maximum total amount by defining a periodic schedule.","summary":"Allows the decrease of limit amount on a periodical schedule","tags":["RETAIL"],"parameters":[{"name":"limitId","in":"path","type":"string","required":true,"description":"The identifier of credit limit"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"","default":"","400":"","500":""}},{"method":"PUT","path":"/holdings/creditLimits/products/{productId}/approvals","fullPath":"/api/v1.0.0/holdings/creditLimits/products/{productId}/approvals","operationId":"approveLimitProduct","name":"Allows approval of modified limit product with information such as product name, product type, mnemonic, child products, etc","summary":"Allows approval of limit product","tags":["RETAIL"],"parameters":[{"name":"productId","in":"path","type":"string","required":true,"description":"Contains the unique identifier of the product, e.g. the product id of the arrangement account."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"","default":"","400":"","500":""}},{"method":"PUT","path":"/holdings/creditLimits/products/{productId}","fullPath":"/api/v1.0.0/holdings/creditLimits/products/{productId}","operationId":"updateLimitProduct","name":"Allows amendment of limit product using which bank can create line of credit for a business domain (such as, Mortgages, Forex, Money Markets) with the information such as product name, product type, mnemonic, exposure percentage, intraday definitions, revaluation rate conversion types, sub allocation allowed products etc.","summary":"Allows amendment to limit product","tags":["RETAIL"],"parameters":[{"name":"productId","in":"path","type":"string","required":true,"description":"Contains the unique identifier of the product, e.g. the product id of the arrangement account."},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"","default":"","400":"","500":""}},{"method":"POST","path":"/holdings/creditLimits/products/{productId}","fullPath":"/api/v1.0.0/holdings/creditLimits/products/{productId}","operationId":"createLimitProduct","name":"Allows creation of limit product using which bank can create line of credit for a business domain (such as, Mortgages, Forex, Money Markets) with the information such as product name, product type, mnemonic, exposure percentage, intraday definitions, revaluation rate conversion types, sub allocation allowed products etc.","summary":"Allows creation of limit product","tags":["RETAIL"],"parameters":[{"name":"productId","in":"path","type":"string","required":true,"description":"Contains the unique identifier of the product, e.g. the product id of the arrangement account."},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"","default":"","400":"","500":""}},{"method":"DELETE","path":"/holdings/creditLimits/products/{productId}","fullPath":"/api/v1.0.0/holdings/creditLimits/products/{productId}","operationId":"deleteUnapprovedLimitProduct","name":"Allows deletion of unapproved limit product that is no more for use.","summary":"Allows deletion of unapproved limit product","tags":["RETAIL"],"parameters":[{"name":"productId","in":"path","type":"string","required":true,"description":"Contains the unique identifier of the product, e.g. the product id of the arrangement account."},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"","default":"","400":"","500":""}},{"method":"DELETE","path":"/holdings/creditLimits/products/{productId}/cancellations","fullPath":"/api/v1.0.0/holdings/creditLimits/products/{productId}/cancellations","operationId":"cancelLimitProduct","name":"Allows cancellation of limit product that is no more for use.","summary":"Allows cancellation of limit product","tags":["RETAIL"],"parameters":[{"name":"productId","in":"path","type":"string","required":true,"description":"Contains the unique identifier of the product, e.g. the product id of the arrangement account."},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"","default":"","400":"","500":""}},{"method":"POST","path":"/holdings/creditLimits/limits/reservations","fullPath":"/api/v1.0.0/holdings/creditLimits/limits/reservations","operationId":"createReservationLimits","name":"Create credit reservation limit with details such as customer or risk group, limit amount, offered until or expiry date and review frequency.","summary":"Create credit reservation limits.","tags":["RETAIL"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"","default":"","400":"","500":""}},{"method":"PUT","path":"/holdings/creditLimits/limits/{limitId}/intraday","fullPath":"/api/v1.0.0/holdings/creditLimits/limits/{limitId}/intraday","operationId":"updateIntradayLimits","name":"Update intraday definitions such as effective date, advised and approved amounts, start and end time when the intraday limit amount can be used by the credit party.","summary":"Update intraday limits.","tags":["RETAIL"],"parameters":[{"name":"limitId","in":"path","type":"string","required":true,"description":"The identifier of credit limit"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"","default":"","400":"","500":""}},{"method":"GET","path":"/holdings/creditLimits/limits/overdrafts","fullPath":"/api/v1.0.0/holdings/creditLimits/limits/overdrafts","operationId":"getLimitOverdrafts","name":"Retrieves the list of credit limits that has overutilized the approved amount with details such as limit key,  utilized amount, breach amount and date time.","summary":"Retrieves overdraft reports of credit limits.","tags":["RETAIL"],"parameters":[{"name":"limitId","in":"query","type":"string","required":false,"description":"The identifier of credit limit"},{"name":"limitCurrency","in":"query","type":"string","required":false,"description":"Currency in which the credit limit is granted"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"","default":"","400":"","500":""}},{"method":"POST","path":"/holdings/creditLimits/limits/buffers","fullPath":"/api/v1.0.0/holdings/creditLimits/limits/buffers","operationId":"createBufferLimits","name":"Allows creation of buffer limit for a customer or a group of customers that serves for the purpose of sub allocating or increasing the limit amounts of credit limits held by this customer or customer group without requiring the approval of the credit committee. This will need information such as limit product, approved amount, currency, customer or risk group & expiry date of limit.","summary":"Allows creation of buffer limit for a customer or a group of customers.","tags":["RETAIL"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"","default":"","400":"","500":""}},{"method":"POST","path":"/holdings/creditLimits/limits/securedLimits","fullPath":"/api/v1.0.0/holdings/creditLimits/limits/securedLimits","operationId":"createSecuredLimits","name":"Allows creation of credit limit for customer who can pledge any assets to secure the limit, with information such as limit product, approved amount, currency, secured amount, allowed and restricted definitions of limit products, customers or risk group and companies, intraday balance details, expiry date and review frequency of limit.","summary":"Allows creation of secured credit limit for the given limit product & customer.","tags":["RETAIL"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"","default":"","400":"","500":""}},{"method":"PUT","path":"/holdings/creditLimits/limits/{limitId}/securedLimits","fullPath":"/api/v1.0.0/holdings/creditLimits/limits/{limitId}/securedLimits","operationId":"updateSecuredLimits","name":"Allows update of credit limit for customer who can pledge any assets to secure the limit, with information such as limit product, approved amount, currency, secured amount, allowed and restricted definitions of limit products, customers or risk group and companies, intraday balance details, expiry date and review frequency of limit.","summary":"Allows update of secured credit limit for the given limit product & customer.","tags":["RETAIL"],"parameters":[{"name":"limitId","in":"path","type":"string","required":true,"description":"The identifier of credit limit"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"","default":"","400":"","500":""}},{"method":"GET","path":"/holdings/creditLimits/products","fullPath":"/api/v1.0.0/holdings/creditLimits/products","operationId":"getLimitProducts","name":"Retrieves the details of limit products such as product description, short name, reducing limit, mnemonic, limit type, etc. Retrieves the details of a specific limit product or all limit products based on query supplied.","summary":"Retrieves the details of limit products","tags":["RETAIL"],"parameters":[{"name":"productId","in":"query","type":"string","required":false,"description":"Contains the unique identifier of the product, e.g. the product id of the arrangement account."},{"name":"nonRevolving","in":"query","type":"string","required":false,"description":"Indicates whether the nature of limit product is revolving or non revolving."},{"name":"mnemonic","in":"query","type":"string","required":false,"description":"Shortcut code for referring an Entity/Company/Branch."},{"name":"productLevel","in":"query","type":"string","required":false,"description":"Indicates the type of limit to be created in product hierarchy structure."},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"","default":"","400":"","500":""}},{"method":"GET","path":"/holdings/creditLimits/subAllocations","fullPath":"/api/v1.0.0/holdings/creditLimits/subAllocations","operationId":"getLimitSubAllocations","name":"Retrieves the details of limits sub-allocation like sub-allocated from, sub-allocate to, allocation amount, effective, expiry date and currency.","summary":"Retrieves the list of limit sub allocations","tags":["RETAIL"],"parameters":[{"name":"subAllocationId","in":"query","type":"string","required":false,"description":"Indicates the identifier of the limit sub allocation."},{"name":"subAllocationFromLimit","in":"query","type":"string","required":false,"description":"Indicates the credit line or sub limit or branch which is giving the sub allocation i.e. Information about the origin of a sub allocation"},{"name":"subAllocationToLimit","in":"query","type":"string","required":false,"description":"Indicates the credit line or sub limit or branch which is receiving the sub allocation i.e. Information about the destination of a sub allocation"},{"name":"effectiveDate","in":"query","type":"string","required":false,"description":"Contains the identifier for the transaction date. Dates are expected in \u00e2\u20ac\u02dcYYYYMMDD\u00e2\u20ac\u2122 format"},{"name":"expiryDate","in":"query","type":"string","required":false,"description":"This indicates the  date  on which the offer or privilege terminates for the event."},{"name":"subAllocationCurrency","in":"query","type":"string","required":false,"description":"Identifies the currency of the sub allocation and it can be different from limit currency. This is the 3-letter ISO 4217 code of the currency."},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"","default":"","400":"","500":""}},{"method":"POST","path":"/holdings/creditLimits/subAllocations","fullPath":"/api/v1.0.0/holdings/creditLimits/subAllocations","operationId":"createLimitSubAllocation","name":"Allows creation of limit sub allocation which is used to record the sub allocation between two limits held in the system with the details such as id of limit that provides sub allocation, id of sub allocation receiving limit, sub allocation amount, sub allocation currency, start date, expiry date etc.","summary":"Allows creation of limit sub allocation.","tags":["RETAIL"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"","default":"","400":"","500":""}},{"method":"PUT","path":"/holdings/creditLimits/subAllocations/{subAllocationId}","fullPath":"/api/v1.0.0/holdings/creditLimits/subAllocations/{subAllocationId}","operationId":"updateLimitSubAllocation","name":"Allows amendment of limit sub allocation which is recorded between two limits held in the system with the details such as id of limit that provides sub allocation, id of sub allocation receiving limit, sub allocation amount, sub allocation currency, start date, expiry date etc.","summary":"Allows amendment of limit sub allocation.","tags":["RETAIL"],"parameters":[{"name":"subAllocationId","in":"path","type":"string","required":true,"description":"Indicates the identifier of the limit sub allocation."},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"","default":"","400":"","500":""}},{"method":"DELETE","path":"/holdings/creditLimits/subAllocations/{subAllocationId}","fullPath":"/api/v1.0.0/holdings/creditLimits/subAllocations/{subAllocationId}","operationId":"deleteLimitSubAllocation","name":"Allows deletion of unapproved limit sub allocation recorded between two limits held in the system.","summary":"Allows deletion of limit sub allocation.","tags":["RETAIL"],"parameters":[{"name":"subAllocationId","in":"path","type":"string","required":true,"description":"Indicates the identifier of the limit sub allocation."},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"","default":"","400":"","500":""}},{"method":"DELETE","path":"/holdings/creditLimits/subAllocations/{subAllocationId}/cancellations","fullPath":"/api/v1.0.0/holdings/creditLimits/subAllocations/{subAllocationId}/cancellations","operationId":"cancelLimitSubAllocation","name":"Allows cancellation of approved limit sub allocation recorded between two limits held in the system.","summary":"Allows cancellation of limit sub allocation.","tags":["RETAIL"],"parameters":[{"name":"subAllocationId","in":"path","type":"string","required":true,"description":"Indicates the identifier of the limit sub allocation."},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"","default":"","400":"","500":""}},{"method":"PUT","path":"/holdings/creditLimits/subAllocations/{subAllocationId}/approvals","fullPath":"/api/v1.0.0/holdings/creditLimits/subAllocations/{subAllocationId}/approvals","operationId":"approveLimitSubAllocation","name":"Approves the limit sub allocation recorded between two limits. In the sub allocation given limit, the available limit will be reduced by the sub allocated amount and sub allocation given details will be updated, whereas, in the sub allocation taken limit, the available limit will be increased by the sub allocated amount and sub allocation taken details will be updated.","summary":"Approves the limit sub allocations recorded between two limits.","tags":["RETAIL"],"parameters":[{"name":"subAllocationId","in":"path","type":"string","required":true,"description":"Indicates the identifier of the limit sub allocation."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"","default":"","400":"","500":""}},{"method":"GET","path":"/holdings/creditLimits/subAllocations/pendingApprovals","fullPath":"/api/v1.0.0/holdings/creditLimits/subAllocations/pendingApprovals","operationId":"getUnapprovedLimitSubAllocations","name":"Retrieves the details of unapproved limits sub-allocation like sub-allocated from, sub-allocate to, allocation amount, effective, expiry date and currency.","summary":"Retrieves the list of limit sub allocations pending for approvals","tags":["RETAIL"],"parameters":[{"name":"subAllocationId","in":"query","type":"string","required":false,"description":"Indicates the identifier of the limit sub allocation."},{"name":"subAllocationFromLimit","in":"query","type":"string","required":false,"description":"Indicates the credit line or sub limit or branch which is giving the sub allocation i.e. Information about the origin of a sub allocation"},{"name":"subAllocationToLimit","in":"query","type":"string","required":false,"description":"Indicates the credit line or sub limit or branch which is receiving the sub allocation i.e. Information about the destination of a sub allocation"},{"name":"effectiveDate","in":"query","type":"string","required":false,"description":"Contains the identifier for the transaction date. Dates are expected in \u00e2\u20ac\u02dcYYYYMMDD\u00e2\u20ac\u2122 format"},{"name":"expiryDate","in":"query","type":"string","required":false,"description":"This indicates the  date  on which the offer or privilege terminates for the event."},{"name":"subAllocationCurrency","in":"query","type":"string","required":false,"description":"Identifies the currency of the sub allocation and it can be different from limit currency. This is the 3-letter ISO 4217 code of the currency."},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"","default":"","400":"","500":""}},{"method":"GET","path":"/holdings/creditLimits/limits","fullPath":"/api/v1.0.0/holdings/creditLimits/limits","operationId":"getLimitList","name":"Retrieves the list of credit lines for the given customer with details like product, currency, serial no, approved amount, advised amount, maximum total, available amount","summary":"Retrieve the list of credit lines available for a given customer","tags":["RETAIL"],"parameters":[{"name":"customerId","in":"query","type":"string","required":false,"description":"Identifier of the customer"},{"name":"limitId","in":"query","type":"string","required":false,"description":"The identifier of credit limit"},{"name":"limitCurrency","in":"query","type":"string","required":false,"description":"Currency in which the credit limit is granted"},{"name":"limitProduct","in":"query","type":"string","required":false,"description":"Identifier of the credit limit product"},{"name":"availableMarker","in":"query","type":"string","required":false,"description":"Whether the limit available for use or not"},{"name":"productLevel","in":"query","type":"string","required":false,"description":"Indicates the type of limit to be created in product hierarchy structure."},{"name":"securedLimitType","in":"query","type":"string","required":false,"description":"Indicates whether the nature of limit is fixed or variable based on the attached collateral."},{"name":"liabilityNumber","in":"query","type":"string","required":false,"description":"Identifier of the Liability Customer to the credit limit"},{"name":"riskGroupId","in":"query","type":"string","required":false,"description":"Identifier of the CUSTOMER.GROUP that constitutes one or more related customers which would be used while arrivnig collective risk exposure of credit line liable to them either individually or shared "},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"","default":"","400":"","500":""}},{"method":"GET","path":"/holdings/creditLimits/limits/pendingApprovals","fullPath":"/api/v1.0.0/holdings/creditLimits/limits/pendingApprovals","operationId":"getUnapprovedLimits","name":"Retrieves unapproved credit limits with details like product, currency, serial no, based on the limit identifier.","summary":"Retrieves the details of unapproved limits","tags":["RETAIL"],"parameters":[{"name":"customerId","in":"query","type":"string","required":false,"description":"Identifier of the customer"},{"name":"limitId","in":"query","type":"string","required":false,"description":"The identifier of credit limit"},{"name":"limitCurrency","in":"query","type":"string","required":false,"description":"Currency in which the credit limit is granted"},{"name":"limitProduct","in":"query","type":"string","required":false,"description":"Identifier of the credit limit product"},{"name":"availableMarker","in":"query","type":"string","required":false,"description":"Whether the limit available for use or not"},{"name":"productLevel","in":"query","type":"string","required":false,"description":"Indicates the type of limit to be created in product hierarchy structure."},{"name":"securedLimitType","in":"query","type":"string","required":false,"description":"Indicates whether the nature of limit is fixed or variable based on the attached collateral."},{"name":"liabilityNumber","in":"query","type":"string","required":false,"description":"Identifier of the Liability Customer to the credit limit"},{"name":"riskGroupId","in":"query","type":"string","required":false,"description":"Identifier of the CUSTOMER.GROUP that constitutes one or more related customers which would be used while arrivnig collective risk exposure of credit line liable to them either individually or shared "},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"","default":"","400":"","500":""}},{"method":"GET","path":"/holdings/creditLimits/limitCashflows/arrangements/{arrangementId}","fullPath":"/api/v1.0.0/holdings/creditLimits/limitCashflows/arrangements/{arrangementId}","operationId":"getLimitCashflow","name":"Retrieves the facility cashflow against the limit, commitment and drawing schedules utilized","summary":"Retrieves limit cashflow details of contract","tags":["RETAIL"],"parameters":[{"name":"arrangementId","in":"path","type":"string","required":true,"description":"Indicates an unique identifier of an account"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"","default":"","400":"","500":""}},{"method":"GET","path":"/holdings/creditLimits/relationships/{customerGroupId}","fullPath":"/api/v1.0.0/holdings/creditLimits/relationships/{customerGroupId}","operationId":"getCustomerGroupRelations","name":"Retrieves all of the customer relation details such as party or customer id, type, name and aggregate customer details under a customer group.","summary":"Retrieves relations among customers","tags":["RETAIL"],"parameters":[{"name":"customerGroupId","in":"path","type":"string","required":true,"description":"Identifier of the CUSTOMER.GROUP that constitues one or more related customers which would be used while arrivnig collective risk exposure of credit line liable to them either individually or shared a"},{"name":"subGroup","in":"query","type":"string","required":false,"description":"Identifier of the Limit Sharing Sub Group"},{"name":"showReverseRelation","in":"query","type":"string","required":false,"description":"Indicates whether reverse relations among customer or entity are required"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"","default":"","400":"","500":""}},{"method":"GET","path":"/holdings/creditLimits/liabilities/{liabilityNumber}/forexDeals","fullPath":"/api/v1.0.0/holdings/creditLimits/liabilities/{liabilityNumber}/forexDeals","operationId":"getLimitsForexTradeSummary","name":"Retrieves the summary of limit details such as currency, advised, available and utilised limit balance by Forex contracts","summary":"Retrieves summary of customer's Forex liability","tags":["RETAIL"],"parameters":[{"name":"liabilityNumber","in":"path","type":"string","required":true,"description":"Identifier of the Liability Customer to the credit limit"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"","default":"","400":"","500":""}},{"method":"GET","path":"/holdings/creditLimits/customers/groups","fullPath":"/api/v1.0.0/holdings/creditLimits/customers/groups","operationId":"getCustomerLimitGroups","name":"Retrieves the list of customer under a limit sharing group or list of groups the specified customer is part of.","summary":"Retrieves limit sharing group of the customer","tags":["RETAIL"],"parameters":[{"name":"groupId","in":"query","type":"string","required":false,"description":"Unique ID of the group"},{"name":"customerId","in":"query","type":"string","required":false,"description":"Identifier of the customer"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"","default":"","400":"","500":""}},{"method":"GET","path":"/holdings/creditLimits/groups/{groupId}/allocations","fullPath":"/api/v1.0.0/holdings/creditLimits/groups/{groupId}/allocations","operationId":"getLimitGroupAllocations","name":"Retrieves the list of limit group allocation details such as group limit reference, contract reference, total commitment, utilised & remaining commitment balance of the limits under the limit sharing group","summary":"Retrieves limit group allocation details","tags":["RETAIL"],"parameters":[{"name":"groupId","in":"path","type":"string","required":true,"description":"Unique ID of the group"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"","default":"","400":"","500":""}},{"method":"GET","path":"/holdings/creditLimits/customers/masterGroups","fullPath":"/api/v1.0.0/holdings/creditLimits/customers/masterGroups","operationId":"getCustomerLimitMasterGroups","name":"Retrieves the limit sharing master group details such as list of customer in the group & the sharing priority defined for the customers","summary":"Retrieves limit sharing master group details","tags":["RETAIL"],"parameters":[{"name":"groupId","in":"query","type":"string","required":false,"description":"Unique ID of the group"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"","default":"","400":"","500":""}},{"method":"GET","path":"/holdings/creditLimits/{limitId}/forexDeals","fullPath":"/api/v1.0.0/holdings/creditLimits/{limitId}/forexDeals","operationId":"getLimitForexDeals","name":"Retrieves the details of Forex contract reference, buy & sell currency, amount associated with the limit","summary":"Retrieves list of Forex contract details available to the limit","tags":["RETAIL"],"parameters":[{"name":"limitId","in":"path","type":"string","required":true,"description":"The identifier of credit limit"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"","default":"","400":"","500":""}},{"method":"GET","path":"/holdings/creditLimits/sharedLimits","fullPath":"/api/v1.0.0/holdings/creditLimits/sharedLimits","operationId":"getSharedLimits","name":"Retrieves the master and sub group available in limit sharing group details along with limit product and list of customer linked to the group","summary":"Retrieves limit sharing group details","tags":["RETAIL"],"parameters":[{"name":"groupId","in":"query","type":"string","required":false,"description":"Unique ID of the group"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"","default":"","400":"","500":""}},{"method":"GET","path":"/holdings/creditLimits/customers/{customerId}/sharingPriorities","fullPath":"/api/v1.0.0/holdings/creditLimits/customers/{customerId}/sharingPriorities","operationId":"getCustomerLimitSharingPriorities","name":"Retrieves the limit sharing priority of the master group for the specified group or customer","summary":"Retrieves limit sharing priority","tags":["RETAIL"],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"Identifier of the customer"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"","default":"","400":"","500":""}},{"method":"GET","path":"/holdings/creditLimits/masterGroups/{masterGroupId}/subGroups","fullPath":"/api/v1.0.0/holdings/creditLimits/masterGroups/{masterGroupId}/subGroups","operationId":"getLimitSubGroups","name":"Retrieves the list of sub groups available under a master group in limit sharing group along with limit product & customer linked to the group","summary":"Retrieves details of limit sub groups","tags":["RETAIL"],"parameters":[{"name":"masterGroupId","in":"path","type":"string","required":true,"description":"Identifier of the Limit Sharing Master Group"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"","default":"","400":"","500":""}},{"method":"GET","path":"/holdings/creditLimits/{limitId}/liabilities","fullPath":"/api/v1.0.0/holdings/creditLimits/{limitId}/liabilities","operationId":"getLimitSummary","name":"Retrieves the limit details such as advised, available & utilised, outstanding balances for a specific customer","summary":"Retrieves summary of customer outstanding details","tags":["RETAIL"],"parameters":[{"name":"limitId","in":"path","type":"string","required":true,"description":"The identifier of credit limit"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"","default":"","400":"","500":""}},{"method":"GET","path":"/holdings/creditLimits/{liabilityNumber}/overdrawnLimits","fullPath":"/api/v1.0.0/holdings/creditLimits/{liabilityNumber}/overdrawnLimits","operationId":"getCustomerOverdrawnLimits","name":"Retrieves the list of credit lines that are overdrawn or in excess of utilisation","summary":"Retrieves list of overdrawn credit limits","tags":["RETAIL"],"parameters":[{"name":"liabilityNumber","in":"path","type":"string","required":true,"description":"Identifier of the Liability Customer to the credit limit"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"","default":"","400":"","500":""}},{"method":"GET","path":"/holdings/creditLimits/{customerId}/subCategoryLimits/{customerGroupId}","fullPath":"/api/v1.0.0/holdings/creditLimits/{customerId}/subCategoryLimits/{customerGroupId}","operationId":"getSubCategoryLimits","name":"Retrieves category, subcategory limit products and timebands from the credit limit for the specified customer group and customerId combination","summary":"Retrieves customer sub category limits","tags":["RETAIL"],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"Identifier of the customer"},{"name":"customerGroupId","in":"path","type":"string","required":true,"description":"Identifier of the CUSTOMER.GROUP that constitues one or more related customers which would be used while arrivnig collective risk exposure of credit line liable to them either individually or shared a"},{"name":"subGroup","in":"query","type":"string","required":false,"description":"Identifier of the Limit Sharing Sub Group"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"","default":"","400":"","500":""}},{"method":"GET","path":"/holdings/creditLimits/{customerGroupId}/subGroups","fullPath":"/api/v1.0.0/holdings/creditLimits/{customerGroupId}/subGroups","operationId":"getSubGroupList","name":"Retrieves list of sub group details such as sub group name, list of related customers ids, party type under specific customer group","summary":"Retrieves list of sub groups","tags":["RETAIL"],"parameters":[{"name":"customerGroupId","in":"path","type":"string","required":true,"description":"Identifier of the CUSTOMER.GROUP that constitues one or more related customers which would be used while arrivnig collective risk exposure of credit line liable to them either individually or shared a"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"","default":"","400":"","500":""}},{"method":"GET","path":"/holdings/creditLimits/{limitId}/subLimits","fullPath":"/api/v1.0.0/holdings/creditLimits/{limitId}/subLimits","operationId":"getSubLimits","name":"Provides list of sub limits applicable for a credit line created based on risk elements of the contract.","summary":"Retrieves list of sublimits applicable for a credit line.","tags":["RETAIL"],"parameters":[{"name":"limitId","in":"path","type":"string","required":true,"description":"The identifier of credit limit"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"","default":"","400":"","500":""}},{"method":"GET","path":"/holdings/creditLimits/collaterals","fullPath":"/api/v1.0.0/holdings/creditLimits/collaterals","operationId":"getLimitCollaterals","name":"Retrieves all secured credit lines or one that has been sanctioned to a specific customer","summary":"Retrieves list of secured credit limits","tags":["RETAIL"],"parameters":[{"name":"liabilityNumber","in":"query","type":"string","required":false,"description":"Identifier of the Liability Customer to the credit limit"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"","default":"","400":"","500":""}},{"method":"GET","path":"/holdings/creditLimits/{limitId}/liabilities/forexDeals","fullPath":"/api/v1.0.0/holdings/creditLimits/{limitId}/liabilities/forexDeals","operationId":"getLimitForexLiabilities","name":"Retrieves the risk excess details of Forex contracts associated to a limit along with the contract amount and limit balance","summary":"Retrieves risk excess details of the limits unutilised by Forex contracts","tags":["RETAIL"],"parameters":[{"name":"limitId","in":"path","type":"string","required":true,"description":"The identifier of credit limit"},{"name":"limitReferenceId","in":"query","type":"string","required":false,"description":"Limit reference identifier for the limit order."},{"name":"serialNumber","in":"query","type":"string","required":false,"description":"A sequence reference for the limit, which when used together with other fields such as Liability Number and/or Limit Reference, provides a unique identifier for a credit line"},{"name":"customerNumber","in":"query","type":"string","required":false,"description":"Identifier of the customer"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"","default":"","400":"","500":""}},{"method":"GET","path":"/holdings/creditLimits/customerGroupLimits","fullPath":"/api/v1.0.0/holdings/creditLimits/customerGroupLimits","operationId":"getCustomerGroupLimits","name":"Retrieves all of the customer group limit exposures such as limit allocations, outstanding, product, expiry along with details of related customers in the group, related sub groups","summary":"Retrieves limit details of customer group","tags":["RETAIL"],"parameters":[{"name":"customerLimitId","in":"query","type":"string","required":false,"description":"Limit reference of the customer"},{"name":"riskGroupId","in":"query","type":"string","required":false,"description":"Identifier of the CUSTOMER.GROUP that constitutes one or more related customers which would be used while arrivnig collective risk exposure of credit line liable to them either individually or shared "},{"name":"liabilityNumber","in":"query","type":"string","required":false,"description":"Identifier of the Liability Customer to the credit limit"},{"name":"limitId","in":"query","type":"string","required":false,"description":"The identifier of credit limit"},{"name":"creditLineNumber","in":"query","type":"string","required":false,"description":"Details of the top most parent credit line plus the limit product in the hierarchy. Eg : 300/LI1701101987 where 300 is the limit product of the topmost parent and second part is the respective creditl"},{"name":"recordParent","in":"query","type":"string","required":false,"description":"Identifier of the immediate parent limit"},{"name":"limitProduct","in":"query","type":"string","required":false,"description":"Identifier of the credit limit product"},{"name":"serialNumber","in":"query","type":"string","required":false,"description":"A sequence reference for the limit, which when used together with other fields such as Liability Number and/or Limit Reference, provides a unique identifier for a credit line"},{"name":"limitCurrency","in":"query","type":"string","required":false,"description":"Currency in which the credit limit is granted"},{"name":"buisnessUnit","in":"query","type":"string","required":false,"description":"The identifier of the underlying Entity/Company/Branch."},{"name":"expiryDate","in":"query","type":"string","required":false,"description":"This indicates the  date  on which the offer or privilege terminates for the event."},{"name":"timeBandName","in":"query","type":"string","required":false,"description":"Description of the individual time code under a credit facility"},{"name":"internalAmount","in":"query","type":"string","required":false,"description":"Indicates the amount allocated to the Credit Limit by the Bank"},{"name":"advisedAmount","in":"query","type":"string","required":false,"description":"Indicates the amount advised to the Credit Limit by the bank"},{"name":"outstandingAmount","in":"query","type":"string","required":false,"description":"Contains the aggregate outstanding principal amount thereof after giving effect to any borrowings and prepayments or repayments of Committed Loans"},{"name":"availableAmount","in":"query","type":"string","required":false,"description":"The credit limit available to the customer for use"},{"name":"availableOrExcess","in":"query","type":"string","required":false,"description":"The available amount for the corresponding liability number and limit reference. This amount is always expressed in the currency of the limit. Calculated as the sum of the online limit, the available "},{"name":"totalCommitment","in":"query","type":"string","required":false,"description":"Specifies the total available commitment amounts  specific to a credit facility"},{"name":"totalCredit","in":"query","type":"string","required":false,"description":"Contains the total number of credits"},{"name":"totalDebit","in":"query","type":"string","required":false,"description":"Contains the total number of debits"},{"name":"requestedCurrency","in":"query","type":"string","required":false,"description":"The currency the amount is requested in."},{"name":"exchangeRate","in":"query","type":"string","required":false,"description":"Contains the exchange rate returned from the system. i.e. For entries over foreign currency accounts, this contains the rate which used to convert the currency amount to the local equivalent at the ti"},{"name":"idlType","in":"query","type":"string","required":false,"description":"The INTRA.DAY.LIMIT type that is applicable for a specific credit facility of the customer"},{"name":"idlApprovedAmount","in":"query","type":"string","required":false,"description":"The approved amount by the bank as INTRA.DAY.LIMIT on a credit facility within a specific period of the day"},{"name":"idlAdvisedAmount","in":"query","type":"string","required":false,"description":"The advised amount by the bank to the customer as INTRA.DAY.LIMIT on a credit facility within a specific period of the day"},{"name":"limitType","in":"query","type":"string","required":false,"description":"Defines the limit type for the trade"},{"name":"relatedCustomer","in":"query","type":"string","required":false,"description":"Indicates the related customers of multi customer and joint limits"},{"name":"sharedLimit","in":"query","type":"string","required":false,"description":"Indicates whether the credit line is of shared limit structure"},{"name":"adjustAvailableAmount","in":"query","type":"string","required":false,"description":"Indicates to adjust the available funds to respective time bands."},{"name":"rebuildData","in":"query","type":"string","required":false,"description":"Indicates to rebuild the customer exposure when enquired by user."},{"name":"aggregateCustomerId","in":"query","type":"string","required":false,"description":"List of customer/person entity that are aggregated under a main customer on risk exposure view"},{"name":"aggregateCustomerRelation","in":"query","type":"string","required":false,"description":"Relation code that exists between the main customer and the aggregated customers"},{"name":"limitNote","in":"query","type":"string","required":false,"description":"Indicates the user defined free text information regarding the limit"},{"name":"sessionId","in":"query","type":"string","required":false,"description":"Id of the T24 session where the risk exposure view executed"},{"name":"subGroup","in":"query","type":"string","required":false,"description":"Identifier of the Limit Sharing Sub Group"},{"name":"originalInternalAmount","in":"query","type":"string","required":false,"description":"Specifies the orignal amount actually approved or authorised on a credit line by Management or the Credit Committee before any repayment made"},{"name":"originalAdvisedAmount","in":"query","type":"string","required":false,"description":"Specifies the original amount advised to the customer holding the credit facility before any repayment made"},{"name":"repaidAmount","in":"query","type":"string","required":false,"description":"Indicates the amount which was repaid from the customer"},{"name":"totalRepaidAmount","in":"query","type":"string","required":false,"description":"Total of the repaid amount under a credit facility"},{"name":"excessFlag","in":"query","type":"string","required":false,"description":"Flag to indicate the credit line has been over utilised"},{"name":"fixedOrVariable","in":"query","type":"string","required":false,"description":"Indicates the secured nature of limit that has been covered by a customer collateral. When FIXED the limit amount sanctioned will not have impact on changing value of collateral whereas when VARIABLE "},{"name":"securedAmount","in":"query","type":"string","required":false,"description":"The total amount that has been covered by the collateral underlying the credit facility"},{"name":"multiCustomerLimit","in":"query","type":"string","required":false,"description":"Specifies if a credit facility shall be used by multiple customers"},{"name":"groupClass","in":"query","type":"string","required":false,"description":"Classify the type of group, whether it is a CUSTOMER.GROUP or SUB.GROUP"},{"name":"isAggregationExists","in":"query","type":"string","required":false,"description":"Indicates if there exists aggregation of one or many customer exposure under a primary customer"},{"name":"mainGroupId","in":"query","type":"string","required":false,"description":"Identifier of the main group under which the sub group has been defined"},{"name":"creditLineProduct","in":"query","type":"string","required":false,"description":"Identifier of the limit product of the topmost credit facility in the hierarchy"},{"name":"gvIndicator","in":"query","type":"string","required":false,"description":"Indicator which specifies the graphical view of risk exposure report requested"},{"name":"onlineLimit","in":"query","type":"string","required":false,"description":"The Limit amount that is actually available for use.The system limit checks are performed against the online limit"},{"name":"amountInUnits","in":"query","type":"string","required":false,"description":"Indicates the Units of the Amounts"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"","default":"","400":"","500":""}}]},{"key":"holdings-creditLimits-service-v1.1.0","title":"Credit Limits","version":"v1.1.0","description":"APIs to create, manage and approve or cancel credit limits types and limits overseen by the credit committee. Credit Limits are overdraft features on a contract or account of a customer approved by credit committee. These APIs also provides review reports, expiry reports and utilization reports of t","endpointCount":54,"endpoints":[{"method":"POST","path":"/holdings/creditLimits/limits/unsecuredLimits","fullPath":"/api/v1.0.0/holdings/creditLimits/limits/unsecuredLimits","operationId":"createUnsecuredLimits","name":"Allows creation of credit limit for customer which doesn't require any assets to secure the limit, with information such as limit product, approved amount, currency, allowed and restricted definitions of limit products, customers or risk group and companies, intraday balance details, expiry date and review frequency of limit.","summary":"Allows creation of unsecured credit limit for the given limit product & customer.","tags":["RETAIL"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"","default":"","400":"","500":""}},{"method":"PUT","path":"/holdings/creditLimits/limits/{limitId}/unsecuredLimits","fullPath":"/api/v1.0.0/holdings/creditLimits/limits/{limitId}/unsecuredLimits","operationId":"updateUnsecuredLimits","name":"Allows amendment of credit limit for customer which doesn't require any assets to secure the limit, with information such as limit product, approved amount, currency, allowed and restricted definitions of limit products, customers or risk group and companies, intraday balance details, expiry date and review frequency of limit.","summary":"Allows amendment of unsecured credit limit details.","tags":["RETAIL"],"parameters":[{"name":"limitId","in":"path","type":"string","required":true,"description":"The identifier of credit limit"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"","default":"","400":"","500":""}},{"method":"PUT","path":"/holdings/creditLimits/limits/{limitId}/dates","fullPath":"/api/v1.0.0/holdings/creditLimits/limits/{limitId}/dates","operationId":"updateLimitExpiry","name":"Allows amendment of expiry date & admin extension date of a credit limit where the date can be extended or reduced.","summary":"Allows amendment of expiry date & admin extension date of a credit limit ","tags":["RETAIL"],"parameters":[{"name":"limitId","in":"path","type":"string","required":true,"description":"The identifier of credit limit"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"","default":"","400":"","500":""}},{"method":"PUT","path":"/holdings/creditLimits/limits/{limitId}/limitAvailabilities","fullPath":"/api/v1.0.0/holdings/creditLimits/limits/{limitId}/limitAvailabilities","operationId":"updateLimitAvailability","name":"Allows amendment to the credit limit availability to specify if the limit is available for use.","summary":"Allows amendment to the credit limit availability","tags":["RETAIL"],"parameters":[{"name":"limitId","in":"path","type":"string","required":true,"description":"The identifier of credit limit"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"","default":"","400":"","500":""}},{"method":"PUT","path":"/holdings/creditLimits/limits/{limitId}/limitAmounts","fullPath":"/api/v1.0.0/holdings/creditLimits/limits/{limitId}/limitAmounts","operationId":"updateLimitAmounts","name":"Allows amendment of credit limit amount related values such as approved amount, advised amount & maximum total amount.","summary":"Allows amendment of credit limit amounts","tags":["RETAIL"],"parameters":[{"name":"limitId","in":"path","type":"string","required":true,"description":"The identifier of credit limit"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"","default":"","400":"","500":""}},{"method":"PUT","path":"/holdings/creditLimits/limits/{limitId}/approvals","fullPath":"/api/v1.0.0/holdings/creditLimits/limits/{limitId}/approvals","operationId":"approveLimits","name":"Allows authorization of limit product with information such as product name, product type, mnemonic, exposure percentage, etc","summary":"Allows authorization of credit limit","tags":["RETAIL"],"parameters":[{"name":"limitId","in":"path","type":"string","required":true,"description":"The identifier of credit limit"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"","default":"","400":"","500":""}},{"method":"GET","path":"/holdings/creditLimits/limits/{limitId}","fullPath":"/api/v1.0.0/holdings/creditLimits/limits/{limitId}","operationId":"getCreditLimitDetails","name":"Retrieves the details of credit limit such as product, currency, serial no, approved amount, advised amount, maximum total, available amount based on the given limit identifier","summary":"Retrieve the details about the credit limit for the given limit identifier","tags":["RETAIL"],"parameters":[{"name":"limitId","in":"path","type":"string","required":true,"description":"The identifier of credit limit"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"","default":"","400":"","500":""}},{"method":"DELETE","path":"/holdings/creditLimits/limits/{limitId}","fullPath":"/api/v1.0.0/holdings/creditLimits/limits/{limitId}","operationId":"deleteUnapprovedLimit","name":"Allows deletion of unapproved credit limit that is no longer required.","summary":"Allows deletion of an unapproved credit limit","tags":["RETAIL"],"parameters":[{"name":"limitId","in":"path","type":"string","required":true,"description":"The identifier of credit limit"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"","default":"","400":"","500":""}},{"method":"DELETE","path":"/holdings/creditLimits/limits/{limitId}/cancellations","fullPath":"/api/v1.0.0/holdings/creditLimits/limits/{limitId}/cancellations","operationId":"cancelLimit","name":"Allows cancellation of credit limit that is no more available for utilization or not being utilized.","summary":"Allows cancellation of a credit limit","tags":["RETAIL"],"parameters":[{"name":"limitId","in":"path","type":"string","required":true,"description":"The identifier of credit limit"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"","default":"","400":"","500":""}},{"method":"GET","path":"/holdings/creditLimits/products/pendingApprovals","fullPath":"/api/v1.0.0/holdings/creditLimits/products/pendingApprovals","operationId":"getUnapprovedLimitProducts","name":"Retrieves the details of unapproved limit products such as product description, shortname, reducing limit, mnemonic, limit type","summary":"Retrieves the details of unapproved limit products","tags":["RETAIL"],"parameters":[{"name":"productId","in":"query","type":"string","required":false,"description":"Contains the unique identifier of the product, e.g. the product id of the arrangement account."},{"name":"nonRevolving","in":"query","type":"string","required":false,"description":"Indicates whether the nature of limit product is revolving or non revolving."},{"name":"mnemonic","in":"query","type":"string","required":false,"description":"Shortcut code for referring an Entity/Company/Branch."},{"name":"productLevel","in":"query","type":"string","required":false,"description":"Indicates the type of limit to be created in product hierarchy structure."},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"","default":"","400":"","500":""}},{"method":"GET","path":"/holdings/creditLimits/limits/expiringLimits","fullPath":"/api/v1.0.0/holdings/creditLimits/limits/expiringLimits","operationId":"getExpiringCreditLimits","name":"Retrieves the list of limits which are about to expire for a given date. System uses the default expiry period if the query parameters are not supplied","summary":"Retrieves the list of credit limits which are about to expire","tags":["RETAIL"],"parameters":[{"name":"uptoExpiryDate","in":"query","type":"string","required":false,"description":"Indicates the date based on  which expiring limits should be retrieved."},{"name":"daysToExpiry","in":"query","type":"string","required":false,"description":"Indicates the number of days based on which expiring limits should be retrieved."},{"name":"customerId","in":"query","type":"string","required":false,"description":"Identifier of the customer"},{"name":"limitCurrency","in":"query","type":"string","required":false,"description":"Currency in which the credit limit is granted"},{"name":"limitProduct","in":"query","type":"string","required":false,"description":"Identifier of the credit limit product"},{"name":"productLevel","in":"query","type":"string","required":false,"description":"Indicates the type of limit to be created in product hierarchy structure."},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"","default":"","400":"","500":""}},{"method":"GET","path":"/holdings/creditLimits/limits/expiredLimits","fullPath":"/api/v1.0.0/holdings/creditLimits/limits/expiredLimits","operationId":"getExpiredLimits","name":"Retrieves the list of credit limits which are expired","summary":"Retrieves the list of credit limits which are expired","tags":["RETAIL"],"parameters":[{"name":"customerId","in":"query","type":"string","required":false,"description":"Identifier of the customer"},{"name":"limitCurrency","in":"query","type":"string","required":false,"description":"Currency in which the credit limit is granted"},{"name":"limitProduct","in":"query","type":"string","required":false,"description":"Identifier of the credit limit product"},{"name":"productLevel","in":"query","type":"string","required":false,"description":"Indicates the type of limit to be created in product hierarchy structure."},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"","default":"","400":"","500":""}},{"method":"GET","path":"/holdings/creditLimits/limits/assessments","fullPath":"/api/v1.0.0/holdings/creditLimits/limits/assessments","operationId":"getLimitsForAssessment","name":"Retrieves the list of limits which are to be reviewed by a given date. System uses the default review period if the query parameters are not supplied","summary":"Retrieves the list of credit limits which are due for review","tags":["RETAIL"],"parameters":[{"name":"uptoReviewDate","in":"query","type":"string","required":false,"description":"Indicates the date based on  which limits should be reviewed."},{"name":"daysToReview","in":"query","type":"string","required":false,"description":"Indicates the number of days based on which limits should be reviewed."},{"name":"customerId","in":"query","type":"string","required":false,"description":"Identifier of the customer"},{"name":"limitCurrency","in":"query","type":"string","required":false,"description":"Currency in which the credit limit is granted"},{"name":"limitProduct","in":"query","type":"string","required":false,"description":"Identifier of the credit limit product"},{"name":"productLevel","in":"query","type":"string","required":false,"description":"Indicates the type of limit to be created in product hierarchy structure."},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"","default":"","400":"","500":""}},{"method":"PUT","path":"/holdings/creditLimits/limits/{limitId}/scheduleIncreases","fullPath":"/api/v1.0.0/holdings/creditLimits/limits/{limitId}/scheduleIncreases","operationId":"createLimitScheduleIncrease","name":"Allows increase of credit limit amount such as approved amount, advised amount & maximum total amount by defining a periodic schedule.","summary":"Allows increase of limit amount on a periodical schedule.","tags":["RETAIL"],"parameters":[{"name":"limitId","in":"path","type":"string","required":true,"description":"The identifier of credit limit"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"","default":"","400":"","500":""}},{"method":"PUT","path":"/holdings/creditLimits/limits/{limitId}/scheduleDecreases","fullPath":"/api/v1.0.0/holdings/creditLimits/limits/{limitId}/scheduleDecreases","operationId":"createLimitScheduleDecrease","name":"Allows decrease of credit limit amount such as approved amount, advised amount & maximum total amount by defining a periodic schedule.","summary":"Allows the decrease of limit amount on a periodical schedule","tags":["RETAIL"],"parameters":[{"name":"limitId","in":"path","type":"string","required":true,"description":"The identifier of credit limit"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"","default":"","400":"","500":""}},{"method":"PUT","path":"/holdings/creditLimits/products/{productId}/approvals","fullPath":"/api/v1.0.0/holdings/creditLimits/products/{productId}/approvals","operationId":"approveLimitProduct","name":"Allows approval of modified limit product with information such as product name, product type, mnemonic, child products, etc","summary":"Allows approval of limit product","tags":["RETAIL"],"parameters":[{"name":"productId","in":"path","type":"string","required":true,"description":"Contains the unique identifier of the product, e.g. the product id of the arrangement account."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"","default":"","400":"","500":""}},{"method":"PUT","path":"/holdings/creditLimits/products/{productId}","fullPath":"/api/v1.0.0/holdings/creditLimits/products/{productId}","operationId":"updateLimitProduct","name":"Allows amendment of limit product using which bank can create line of credit for a business domain (such as, Mortgages, Forex, Money Markets) with the information such as product name, product type, mnemonic, exposure percentage, intraday definitions, revaluation rate conversion types, sub allocation allowed products etc.","summary":"Allows amendment to limit product","tags":["RETAIL"],"parameters":[{"name":"productId","in":"path","type":"string","required":true,"description":"Contains the unique identifier of the product, e.g. the product id of the arrangement account."},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"","default":"","400":"","500":""}},{"method":"POST","path":"/holdings/creditLimits/products/{productId}","fullPath":"/api/v1.0.0/holdings/creditLimits/products/{productId}","operationId":"createLimitProduct","name":"Allows creation of limit product using which bank can create line of credit for a business domain (such as, Mortgages, Forex, Money Markets) with the information such as product name, product type, mnemonic, exposure percentage, intraday definitions, revaluation rate conversion types, sub allocation allowed products etc.","summary":"Allows creation of limit product","tags":["RETAIL"],"parameters":[{"name":"productId","in":"path","type":"string","required":true,"description":"Contains the unique identifier of the product, e.g. the product id of the arrangement account."},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"","default":"","400":"","500":""}},{"method":"DELETE","path":"/holdings/creditLimits/products/{productId}","fullPath":"/api/v1.0.0/holdings/creditLimits/products/{productId}","operationId":"deleteUnapprovedLimitProduct","name":"Allows deletion of unapproved limit product that is no more for use.","summary":"Allows deletion of unapproved limit product","tags":["RETAIL"],"parameters":[{"name":"productId","in":"path","type":"string","required":true,"description":"Contains the unique identifier of the product, e.g. the product id of the arrangement account."},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"","default":"","400":"","500":""}},{"method":"DELETE","path":"/holdings/creditLimits/products/{productId}/cancellations","fullPath":"/api/v1.0.0/holdings/creditLimits/products/{productId}/cancellations","operationId":"cancelLimitProduct","name":"Allows cancellation of limit product that is no more for use.","summary":"Allows cancellation of limit product","tags":["RETAIL"],"parameters":[{"name":"productId","in":"path","type":"string","required":true,"description":"Contains the unique identifier of the product, e.g. the product id of the arrangement account."},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"","default":"","400":"","500":""}},{"method":"POST","path":"/holdings/creditLimits/limits/reservations","fullPath":"/api/v1.0.0/holdings/creditLimits/limits/reservations","operationId":"createReservationLimits","name":"Create credit reservation limit with details such as customer or risk group, limit amount, offered until or expiry date and review frequency.","summary":"Create credit reservation limits.","tags":["RETAIL"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"","default":"","400":"","500":""}},{"method":"PUT","path":"/holdings/creditLimits/limits/{limitId}/intraday","fullPath":"/api/v1.0.0/holdings/creditLimits/limits/{limitId}/intraday","operationId":"updateIntradayLimits","name":"Update intraday definitions such as effective date, advised and approved amounts, start and end time when the intraday limit amount can be used by the credit party.","summary":"Update intraday limits.","tags":["RETAIL"],"parameters":[{"name":"limitId","in":"path","type":"string","required":true,"description":"The identifier of credit limit"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"","default":"","400":"","500":""}},{"method":"GET","path":"/holdings/creditLimits/limits/overdrafts","fullPath":"/api/v1.0.0/holdings/creditLimits/limits/overdrafts","operationId":"getLimitOverdrafts","name":"Retrieves the list of credit limits that has overutilized the approved amount with details such as limit key,  utilized amount, breach amount and date time.","summary":"Retrieves overdraft reports of credit limits.","tags":["RETAIL"],"parameters":[{"name":"limitId","in":"query","type":"string","required":false,"description":"The identifier of credit limit"},{"name":"limitCurrency","in":"query","type":"string","required":false,"description":"Currency in which the credit limit is granted"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"","default":"","400":"","500":""}},{"method":"POST","path":"/holdings/creditLimits/limits/buffers","fullPath":"/api/v1.0.0/holdings/creditLimits/limits/buffers","operationId":"createBufferLimits","name":"Allows creation of buffer limit for a customer or a group of customers that serves for the purpose of sub allocating or increasing the limit amounts of credit limits held by this customer or customer group without requiring the approval of the credit committee. This will need information such as limit product, approved amount, currency, customer or risk group & expiry date of limit.","summary":"Allows creation of buffer limit for a customer or a group of customers.","tags":["RETAIL"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"","default":"","400":"","500":""}},{"method":"POST","path":"/holdings/creditLimits/limits/securedLimits","fullPath":"/api/v1.0.0/holdings/creditLimits/limits/securedLimits","operationId":"createSecuredLimits","name":"Allows creation of credit limit for customer who can pledge any assets to secure the limit, with information such as limit product, approved amount, currency, secured amount, allowed and restricted definitions of limit products, customers or risk group and companies, intraday balance details, expiry date and review frequency of limit.","summary":"Allows creation of secured credit limit for the given limit product & customer.","tags":["RETAIL"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"","default":"","400":"","500":""}},{"method":"PUT","path":"/holdings/creditLimits/limits/{limitId}/securedLimits","fullPath":"/api/v1.0.0/holdings/creditLimits/limits/{limitId}/securedLimits","operationId":"updateSecuredLimits","name":"Allows update of credit limit for customer who can pledge any assets to secure the limit, with information such as limit product, approved amount, currency, secured amount, allowed and restricted definitions of limit products, customers or risk group and companies, intraday balance details, expiry date and review frequency of limit.","summary":"Allows update of secured credit limit for the given limit product & customer.","tags":["RETAIL"],"parameters":[{"name":"limitId","in":"path","type":"string","required":true,"description":"The identifier of credit limit"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"","default":"","400":"","500":""}},{"method":"GET","path":"/holdings/creditLimits/products","fullPath":"/api/v1.0.0/holdings/creditLimits/products","operationId":"getLimitProducts","name":"Retrieves the details of limit products such as product description, short name, reducing limit, mnemonic, limit type, etc. Retrieves the details of a specific limit product or all limit products based on query supplied.","summary":"Retrieves the details of limit products","tags":["RETAIL"],"parameters":[{"name":"productId","in":"query","type":"string","required":false,"description":"Contains the unique identifier of the product, e.g. the product id of the arrangement account."},{"name":"nonRevolving","in":"query","type":"string","required":false,"description":"Indicates whether the nature of limit product is revolving or non revolving."},{"name":"mnemonic","in":"query","type":"string","required":false,"description":"Shortcut code for referring an Entity/Company/Branch."},{"name":"productLevel","in":"query","type":"string","required":false,"description":"Indicates the type of limit to be created in product hierarchy structure."},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"","default":"","400":"","500":""}},{"method":"GET","path":"/holdings/creditLimits/subAllocations","fullPath":"/api/v1.0.0/holdings/creditLimits/subAllocations","operationId":"getLimitSubAllocations","name":"Retrieves the details of limits sub-allocation like sub-allocated from, sub-allocate to, allocation amount, effective, expiry date and currency.","summary":"Retrieves the list of limit sub allocations","tags":["RETAIL"],"parameters":[{"name":"subAllocationId","in":"query","type":"string","required":false,"description":"Indicates the identifier of the limit sub allocation."},{"name":"subAllocationFromLimit","in":"query","type":"string","required":false,"description":"Indicates the credit line or sub limit or branch which is giving the sub allocation i.e. Information about the origin of a sub allocation"},{"name":"subAllocationToLimit","in":"query","type":"string","required":false,"description":"Indicates the credit line or sub limit or branch which is receiving the sub allocation i.e. Information about the destination of a sub allocation"},{"name":"effectiveDate","in":"query","type":"string","required":false,"description":"Contains the identifier for the transaction date. Dates are expected in \u00e2\u20ac\u02dcYYYYMMDD\u00e2\u20ac\u2122 format"},{"name":"expiryDate","in":"query","type":"string","required":false,"description":"This indicates the  date  on which the offer or privilege terminates for the event."},{"name":"subAllocationCurrency","in":"query","type":"string","required":false,"description":"Identifies the currency of the sub allocation and it can be different from limit currency. This is the 3-letter ISO 4217 code of the currency."},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"","default":"","400":"","500":""}},{"method":"POST","path":"/holdings/creditLimits/subAllocations","fullPath":"/api/v1.0.0/holdings/creditLimits/subAllocations","operationId":"createLimitSubAllocation","name":"Allows creation of limit sub allocation which is used to record the sub allocation between two limits held in the system with the details such as id of limit that provides sub allocation, id of sub allocation receiving limit, sub allocation amount, sub allocation currency, start date, expiry date etc.","summary":"Allows creation of limit sub allocation.","tags":["RETAIL"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"","default":"","400":"","500":""}},{"method":"PUT","path":"/holdings/creditLimits/subAllocations/{subAllocationId}","fullPath":"/api/v1.0.0/holdings/creditLimits/subAllocations/{subAllocationId}","operationId":"updateLimitSubAllocation","name":"Allows amendment of limit sub allocation which is recorded between two limits held in the system with the details such as id of limit that provides sub allocation, id of sub allocation receiving limit, sub allocation amount, sub allocation currency, start date, expiry date etc.","summary":"Allows amendment of limit sub allocation.","tags":["RETAIL"],"parameters":[{"name":"subAllocationId","in":"path","type":"string","required":true,"description":"Indicates the identifier of the limit sub allocation."},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"","default":"","400":"","500":""}},{"method":"DELETE","path":"/holdings/creditLimits/subAllocations/{subAllocationId}","fullPath":"/api/v1.0.0/holdings/creditLimits/subAllocations/{subAllocationId}","operationId":"deleteLimitSubAllocation","name":"Allows deletion of unapproved limit sub allocation recorded between two limits held in the system.","summary":"Allows deletion of limit sub allocation.","tags":["RETAIL"],"parameters":[{"name":"subAllocationId","in":"path","type":"string","required":true,"description":"Indicates the identifier of the limit sub allocation."},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"","default":"","400":"","500":""}},{"method":"DELETE","path":"/holdings/creditLimits/subAllocations/{subAllocationId}/cancellations","fullPath":"/api/v1.0.0/holdings/creditLimits/subAllocations/{subAllocationId}/cancellations","operationId":"cancelLimitSubAllocation","name":"Allows cancellation of approved limit sub allocation recorded between two limits held in the system.","summary":"Allows cancellation of limit sub allocation.","tags":["RETAIL"],"parameters":[{"name":"subAllocationId","in":"path","type":"string","required":true,"description":"Indicates the identifier of the limit sub allocation."},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"","default":"","400":"","500":""}},{"method":"PUT","path":"/holdings/creditLimits/subAllocations/{subAllocationId}/approvals","fullPath":"/api/v1.0.0/holdings/creditLimits/subAllocations/{subAllocationId}/approvals","operationId":"approveLimitSubAllocation","name":"Approves the limit sub allocation recorded between two limits. In the sub allocation given limit, the available limit will be reduced by the sub allocated amount and sub allocation given details will be updated, whereas, in the sub allocation taken limit, the available limit will be increased by the sub allocated amount and sub allocation taken details will be updated.","summary":"Approves the limit sub allocations recorded between two limits.","tags":["RETAIL"],"parameters":[{"name":"subAllocationId","in":"path","type":"string","required":true,"description":"Indicates the identifier of the limit sub allocation."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"","default":"","400":"","500":""}},{"method":"GET","path":"/holdings/creditLimits/subAllocations/pendingApprovals","fullPath":"/api/v1.0.0/holdings/creditLimits/subAllocations/pendingApprovals","operationId":"getUnapprovedLimitSubAllocations","name":"Retrieves the details of unapproved limits sub-allocation like sub-allocated from, sub-allocate to, allocation amount, effective, expiry date and currency.","summary":"Retrieves the list of limit sub allocations pending for approvals","tags":["RETAIL"],"parameters":[{"name":"subAllocationId","in":"query","type":"string","required":false,"description":"Indicates the identifier of the limit sub allocation."},{"name":"subAllocationFromLimit","in":"query","type":"string","required":false,"description":"Indicates the credit line or sub limit or branch which is giving the sub allocation i.e. Information about the origin of a sub allocation"},{"name":"subAllocationToLimit","in":"query","type":"string","required":false,"description":"Indicates the credit line or sub limit or branch which is receiving the sub allocation i.e. Information about the destination of a sub allocation"},{"name":"effectiveDate","in":"query","type":"string","required":false,"description":"Contains the identifier for the transaction date. Dates are expected in \u00e2\u20ac\u02dcYYYYMMDD\u00e2\u20ac\u2122 format"},{"name":"expiryDate","in":"query","type":"string","required":false,"description":"This indicates the  date  on which the offer or privilege terminates for the event."},{"name":"subAllocationCurrency","in":"query","type":"string","required":false,"description":"Identifies the currency of the sub allocation and it can be different from limit currency. This is the 3-letter ISO 4217 code of the currency."},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"","default":"","400":"","500":""}},{"method":"GET","path":"/holdings/creditLimits/limits","fullPath":"/api/v1.0.0/holdings/creditLimits/limits","operationId":"getLimitList","name":"Retrieves the list of credit lines for the given customer with details like product, currency, serial no, approved amount, advised amount, maximum total, available amount","summary":"Retrieve the list of credit lines available for a given customer","tags":["RETAIL"],"parameters":[{"name":"customerId","in":"query","type":"string","required":false,"description":"Identifier of the customer"},{"name":"limitId","in":"query","type":"string","required":false,"description":"The identifier of credit limit"},{"name":"limitCurrency","in":"query","type":"string","required":false,"description":"Currency in which the credit limit is granted"},{"name":"limitProduct","in":"query","type":"string","required":false,"description":"Identifier of the credit limit product"},{"name":"availableMarker","in":"query","type":"string","required":false,"description":"Whether the limit available for use or not"},{"name":"productLevel","in":"query","type":"string","required":false,"description":"Indicates the type of limit to be created in product hierarchy structure."},{"name":"securedLimitType","in":"query","type":"string","required":false,"description":"Indicates whether the nature of limit is fixed or variable based on the attached collateral."},{"name":"liabilityNumber","in":"query","type":"string","required":false,"description":"Identifier of the Liability Customer to the credit limit"},{"name":"riskGroupId","in":"query","type":"string","required":false,"description":"Identifier of the CUSTOMER.GROUP that constitutes one or more related customers which would be used while arrivnig collective risk exposure of credit line liable to them either individually or shared "},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"","default":"","400":"","500":""}},{"method":"GET","path":"/holdings/creditLimits/limits/pendingApprovals","fullPath":"/api/v1.0.0/holdings/creditLimits/limits/pendingApprovals","operationId":"getUnapprovedLimits","name":"Retrieves unapproved credit limits with details like product, currency, serial no, based on the limit identifier.","summary":"Retrieves the details of unapproved limits","tags":["RETAIL"],"parameters":[{"name":"customerId","in":"query","type":"string","required":false,"description":"Identifier of the customer"},{"name":"limitId","in":"query","type":"string","required":false,"description":"The identifier of credit limit"},{"name":"limitCurrency","in":"query","type":"string","required":false,"description":"Currency in which the credit limit is granted"},{"name":"limitProduct","in":"query","type":"string","required":false,"description":"Identifier of the credit limit product"},{"name":"availableMarker","in":"query","type":"string","required":false,"description":"Whether the limit available for use or not"},{"name":"productLevel","in":"query","type":"string","required":false,"description":"Indicates the type of limit to be created in product hierarchy structure."},{"name":"securedLimitType","in":"query","type":"string","required":false,"description":"Indicates whether the nature of limit is fixed or variable based on the attached collateral."},{"name":"liabilityNumber","in":"query","type":"string","required":false,"description":"Identifier of the Liability Customer to the credit limit"},{"name":"riskGroupId","in":"query","type":"string","required":false,"description":"Identifier of the CUSTOMER.GROUP that constitutes one or more related customers which would be used while arrivnig collective risk exposure of credit line liable to them either individually or shared "},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"","default":"","400":"","500":""}},{"method":"GET","path":"/holdings/creditLimits/limitCashflows/arrangements/{arrangementId}","fullPath":"/api/v1.0.0/holdings/creditLimits/limitCashflows/arrangements/{arrangementId}","operationId":"getLimitCashflow","name":"Retrieves the facility cashflow against the limit, commitment and drawing schedules utilized","summary":"Retrieves limit cashflow details of contract","tags":["RETAIL"],"parameters":[{"name":"arrangementId","in":"path","type":"string","required":true,"description":"Indicates an unique identifier of an account"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"","default":"","400":"","500":""}},{"method":"GET","path":"/holdings/creditLimits/relationships/{customerGroupId}","fullPath":"/api/v1.0.0/holdings/creditLimits/relationships/{customerGroupId}","operationId":"getCustomerGroupRelations","name":"Retrieves all of the customer relation details such as party or customer id, type, name and aggregate customer details under a customer group.","summary":"Retrieves relations among customers","tags":["RETAIL"],"parameters":[{"name":"customerGroupId","in":"path","type":"string","required":true,"description":"Identifier of the CUSTOMER.GROUP that constitues one or more related customers which would be used while arrivnig collective risk exposure of credit line liable to them either individually or shared a"},{"name":"subGroup","in":"query","type":"string","required":false,"description":"Identifier of the limit sharing sub group"},{"name":"showReverseRelation","in":"query","type":"string","required":false,"description":"Indicates whether reverse relations among customer or entity are required"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"","default":"","400":"","500":""}},{"method":"GET","path":"/holdings/creditLimits/liabilities/{liabilityNumber}/forexDeals","fullPath":"/api/v1.0.0/holdings/creditLimits/liabilities/{liabilityNumber}/forexDeals","operationId":"getLimitsForexTradeSummary","name":"Retrieves the summary of limit details such as currency, advised, available and utilised limit balance by Forex contracts","summary":"Retrieves summary of customer's Forex liability","tags":["RETAIL"],"parameters":[{"name":"liabilityNumber","in":"path","type":"string","required":true,"description":"Identifier of the Liability Customer to the credit limit"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"","default":"","400":"","500":""}},{"method":"GET","path":"/holdings/creditLimits/customers/groups","fullPath":"/api/v1.0.0/holdings/creditLimits/customers/groups","operationId":"getCustomerLimitGroups","name":"Retrieves the list of customer under a limit sharing group or list of groups the specified customer is part of.","summary":"Retrieves limit sharing group of the customer","tags":["RETAIL"],"parameters":[{"name":"groupId","in":"query","type":"string","required":false,"description":"Unique ID of the group"},{"name":"customerId","in":"query","type":"string","required":false,"description":"Identifier of the customer"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"","default":"","400":"","500":""}},{"method":"GET","path":"/holdings/creditLimits/groups/{groupId}/allocations","fullPath":"/api/v1.0.0/holdings/creditLimits/groups/{groupId}/allocations","operationId":"getLimitGroupAllocations","name":"Retrieves the list of limit group allocation details such as group limit reference, contract reference, total commitment, utilised & remaining commitment balance of the limits under the limit sharing group","summary":"Retrieves limit group allocation details","tags":["RETAIL"],"parameters":[{"name":"groupId","in":"path","type":"string","required":true,"description":"Unique ID of the group"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"","default":"","400":"","500":""}},{"method":"GET","path":"/holdings/creditLimits/customers/masterGroups","fullPath":"/api/v1.0.0/holdings/creditLimits/customers/masterGroups","operationId":"getCustomerLimitMasterGroups","name":"Retrieves the limit sharing master group details such as list of customer in the group & the sharing priority defined for the customers","summary":"Retrieves limit sharing master group details","tags":["RETAIL"],"parameters":[{"name":"groupId","in":"query","type":"string","required":false,"description":"Unique ID of the group"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"","default":"","400":"","500":""}},{"method":"GET","path":"/holdings/creditLimits/{limitId}/forexDeals","fullPath":"/api/v1.0.0/holdings/creditLimits/{limitId}/forexDeals","operationId":"getLimitForexDeals","name":"Retrieves the details of Forex contract reference, buy & sell currency, amount associated with the limit","summary":"Retrieves list of Forex contract details available to the limit","tags":["RETAIL"],"parameters":[{"name":"limitId","in":"path","type":"string","required":true,"description":"The identifier of credit limit"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"","default":"","400":"","500":""}},{"method":"GET","path":"/holdings/creditLimits/sharedLimits","fullPath":"/api/v1.0.0/holdings/creditLimits/sharedLimits","operationId":"getSharedLimits","name":"Retrieves the master and sub group available in limit sharing group details along with limit product and list of customer linked to the group","summary":"Retrieves limit sharing group details","tags":["RETAIL"],"parameters":[{"name":"groupId","in":"query","type":"string","required":false,"description":"Unique ID of the group"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"","default":"","400":"","500":""}},{"method":"GET","path":"/holdings/creditLimits/customers/{customerId}/sharingPriorities","fullPath":"/api/v1.0.0/holdings/creditLimits/customers/{customerId}/sharingPriorities","operationId":"getCustomerLimitSharingPriorities","name":"Retrieves the limit sharing priority of the master group for the specified group or customer","summary":"Retrieves limit sharing priority","tags":["RETAIL"],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"Identifier of the customer"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"","default":"","400":"","500":""}},{"method":"GET","path":"/holdings/creditLimits/masterGroups/{masterGroupId}/subGroups","fullPath":"/api/v1.0.0/holdings/creditLimits/masterGroups/{masterGroupId}/subGroups","operationId":"getLimitSubGroups","name":"Retrieves the list of sub groups available under a master group in limit sharing group along with limit product & customer linked to the group","summary":"Retrieves details of limit sub groups","tags":["RETAIL"],"parameters":[{"name":"masterGroupId","in":"path","type":"string","required":true,"description":"Identifier of the Limit Sharing Master Group"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"","default":"","400":"","500":""}},{"method":"GET","path":"/holdings/creditLimits/{limitId}/liabilities","fullPath":"/api/v1.0.0/holdings/creditLimits/{limitId}/liabilities","operationId":"getLimitSummary","name":"Retrieves the limit details such as advised, available & utilised, outstanding balances for a specific customer","summary":"Retrieves summary of customer outstanding details","tags":["RETAIL"],"parameters":[{"name":"limitId","in":"path","type":"string","required":true,"description":"The identifier of credit limit"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"","default":"","400":"","500":""}},{"method":"GET","path":"/holdings/creditLimits/{liabilityNumber}/overdrawnLimits","fullPath":"/api/v1.0.0/holdings/creditLimits/{liabilityNumber}/overdrawnLimits","operationId":"getCustomerOverdrawnLimits","name":"Retrieves the list of credit lines that are overdrawn or in excess of utilisation","summary":"Retrieves list of overdrawn credit limits","tags":["RETAIL"],"parameters":[{"name":"liabilityNumber","in":"path","type":"string","required":true,"description":"Identifier of the Liability Customer to the credit limit"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"","default":"","400":"","500":""}},{"method":"GET","path":"/holdings/creditLimits/{customerId}/subCategoryLimits/{customerGroupId}","fullPath":"/api/v1.0.0/holdings/creditLimits/{customerId}/subCategoryLimits/{customerGroupId}","operationId":"getSubCategoryLimits","name":"Retrieves category, subcategory limit products and timebands from the credit limit for the specified customer group and customerId combination","summary":"Retrieves customer sub category limits","tags":["RETAIL"],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"Identifier of the customer"},{"name":"customerGroupId","in":"path","type":"string","required":true,"description":"Identifier of the CUSTOMER.GROUP that constitues one or more related customers which would be used while arrivnig collective risk exposure of credit line liable to them either individually or shared a"},{"name":"subGroup","in":"query","type":"string","required":false,"description":"Identifier of the limit sharing sub group"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"","default":"","400":"","500":""}},{"method":"GET","path":"/holdings/creditLimits/{customerGroupId}/subGroups","fullPath":"/api/v1.0.0/holdings/creditLimits/{customerGroupId}/subGroups","operationId":"getSubGroupList","name":"Retrieves list of sub group details such as sub group name, list of related customers ids, party type under specific customer group","summary":"Retrieves list of sub groups","tags":["RETAIL"],"parameters":[{"name":"customerGroupId","in":"path","type":"string","required":true,"description":"Identifier of the CUSTOMER.GROUP that constitues one or more related customers which would be used while arrivnig collective risk exposure of credit line liable to them either individually or shared a"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"","default":"","400":"","500":""}},{"method":"GET","path":"/holdings/creditLimits/{limitId}/subLimits","fullPath":"/api/v1.0.0/holdings/creditLimits/{limitId}/subLimits","operationId":"getSubLimits","name":"Provides list of sub limits applicable for a credit line created based on risk elements of the contract.","summary":"Retrieves list of sublimits applicable for a credit line.","tags":["RETAIL"],"parameters":[{"name":"limitId","in":"path","type":"string","required":true,"description":"The identifier of credit limit"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"","default":"","400":"","500":""}},{"method":"GET","path":"/holdings/creditLimits/collaterals","fullPath":"/api/v1.0.0/holdings/creditLimits/collaterals","operationId":"getLimitCollaterals","name":"Retrieves all secured credit lines or one that has been sanctioned to a specific customer","summary":"Retrieves list of secured credit limits","tags":["RETAIL"],"parameters":[{"name":"liabilityNumber","in":"query","type":"string","required":false,"description":"Identifier of the Liability Customer to the credit limit"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"","default":"","400":"","500":""}},{"method":"GET","path":"/holdings/creditLimits/{limitId}/liabilities/forexDeals","fullPath":"/api/v1.0.0/holdings/creditLimits/{limitId}/liabilities/forexDeals","operationId":"getLimitForexLiabilities","name":"Retrieves the risk excess details of Forex contracts associated to a limit along with the contract amount and limit balance","summary":"Retrieves risk excess details of the limits unutilised by Forex contracts","tags":["RETAIL"],"parameters":[{"name":"limitId","in":"path","type":"string","required":true,"description":"The identifier of credit limit"},{"name":"limitReferenceId","in":"query","type":"string","required":false,"description":"Limit reference identifier for the limit order."},{"name":"serialNumber","in":"query","type":"string","required":false,"description":"A sequence reference for the limit, which when used together with other fields such as Liability Number and/or Limit Reference, provides a unique identifier for a credit line"},{"name":"customerNumber","in":"query","type":"string","required":false,"description":"Identifier of the customer"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"","default":"","400":"","500":""}},{"method":"GET","path":"/holdings/creditLimits/customerGroupLimits","fullPath":"/api/v1.0.0/holdings/creditLimits/customerGroupLimits","operationId":"getCustomerGroupLimits","name":"Retrieves all of the customer group limit exposures such as limit allocations, outstanding, product, expiry along with details of related customers in the group, related sub groups","summary":"Retrieves limit details of customer group","tags":["RETAIL"],"parameters":[{"name":"customerLimitId","in":"query","type":"string","required":false,"description":"Limit reference of the customer"},{"name":"riskGroupId","in":"query","type":"string","required":false,"description":"Identifier of the CUSTOMER.GROUP that constitutes one or more related customers which would be used while arrivnig collective risk exposure of credit line liable to them either individually or shared "},{"name":"liabilityNumber","in":"query","type":"string","required":false,"description":"Identifier of the Liability Customer to the credit limit"},{"name":"limitId","in":"query","type":"string","required":false,"description":"The identifier of credit limit"},{"name":"creditLineNumber","in":"query","type":"string","required":false,"description":"Details of the top most parent credit line plus the limit product in the hierarchy. Eg : 300/LI1701101987 where 300 is the limit product of the topmost parent and second part is the respective creditl"},{"name":"recordParent","in":"query","type":"string","required":false,"description":"Identifier of the immediate parent limit"},{"name":"limitProduct","in":"query","type":"string","required":false,"description":"Identifier of the credit limit product"},{"name":"serialNumber","in":"query","type":"string","required":false,"description":"A sequence reference for the limit, which when used together with other fields such as Liability Number and/or Limit Reference, provides a unique identifier for a credit line"},{"name":"limitCurrency","in":"query","type":"string","required":false,"description":"Currency in which the credit limit is granted"},{"name":"buisnessUnit","in":"query","type":"string","required":false,"description":"The identifier of the underlying Entity/Company/Branch."},{"name":"expiryDate","in":"query","type":"string","required":false,"description":"This indicates the  date  on which the offer or privilege terminates for the event."},{"name":"timeBandName","in":"query","type":"string","required":false,"description":"Description of the individual time code under a credit facility"},{"name":"internalAmount","in":"query","type":"string","required":false,"description":"Indicates the amount allocated to the Credit Limit by the Bank"},{"name":"advisedAmount","in":"query","type":"string","required":false,"description":"Indicates the amount advised to the Credit Limit by the bank"},{"name":"outstandingAmount","in":"query","type":"string","required":false,"description":"Contains the aggregate outstanding principal amount thereof after giving effect to any borrowings and prepayments or repayments of Committed Loans"},{"name":"availableAmount","in":"query","type":"string","required":false,"description":"The credit limit available to the customer for use"},{"name":"availableOrExcess","in":"query","type":"string","required":false,"description":"The available amount for the corresponding liability number and limit reference. This amount is always expressed in the currency of the limit. Calculated as the sum of the online limit, the available "},{"name":"totalCommitment","in":"query","type":"string","required":false,"description":"Specifies the total available commitment amounts  specific to a credit facility"},{"name":"totalCredit","in":"query","type":"string","required":false,"description":"Contains the total number of credits"},{"name":"totalDebit","in":"query","type":"string","required":false,"description":"Contains the total number of debits"},{"name":"requestedCurrency","in":"query","type":"string","required":false,"description":"The currency the amount is requested in."},{"name":"exchangeRate","in":"query","type":"string","required":false,"description":"Contains the exchange rate returned from the system. i.e. For entries over foreign currency accounts, this contains the rate which used to convert the currency amount to the local equivalent at the ti"},{"name":"idlType","in":"query","type":"string","required":false,"description":"The INTRA.DAY.LIMIT type that is applicable for a specific credit facility of the customer"},{"name":"idlApprovedAmount","in":"query","type":"string","required":false,"description":"The approved amount by the bank as INTRA.DAY.LIMIT on a credit facility within a specific period of the day"},{"name":"idlAdvisedAmount","in":"query","type":"string","required":false,"description":"The advised amount by the bank to the customer as INTRA.DAY.LIMIT on a credit facility within a specific period of the day"},{"name":"limitType","in":"query","type":"string","required":false,"description":"Defines the limit type for the trade"},{"name":"relatedCustomer","in":"query","type":"string","required":false,"description":"Indicates the related customers of multi customer and joint limits"},{"name":"sharedLimit","in":"query","type":"string","required":false,"description":"Indicates whether the credit line is of shared limit structure"},{"name":"adjustAvailableAmount","in":"query","type":"string","required":false,"description":"Indicates to adjust the available funds to respective time bands."},{"name":"rebuildData","in":"query","type":"string","required":false,"description":"Indicates to rebuild the customer exposure when enquired by user."},{"name":"aggregateCustomerId","in":"query","type":"string","required":false,"description":"List of customer/person entity that are aggregated under a main customer on risk exposure view"},{"name":"aggregateCustomerRelation","in":"query","type":"string","required":false,"description":"Relation code that exists between the main customer and the aggregated customers"},{"name":"limitNote","in":"query","type":"string","required":false,"description":"Indicates the user defined free text information regarding the limit"},{"name":"sessionId","in":"query","type":"string","required":false,"description":"Id of the T24 session where the risk exposure view executed"},{"name":"subGroup","in":"query","type":"string","required":false,"description":"Identifier of the limit sharing sub group"},{"name":"originalInternalAmount","in":"query","type":"string","required":false,"description":"Specifies the orignal amount actually approved or authorised on a credit line by Management or the Credit Committee before any repayment made"},{"name":"originalAdvisedAmount","in":"query","type":"string","required":false,"description":"Specifies the original amount advised to the customer holding the credit facility before any repayment made"},{"name":"repaidAmount","in":"query","type":"string","required":false,"description":"Indicates the amount which was repaid from the customer"},{"name":"totalRepaidAmount","in":"query","type":"string","required":false,"description":"Total of the repaid amount under a credit facility"},{"name":"excessFlag","in":"query","type":"string","required":false,"description":"Flag to indicate the credit line has been over utilised"},{"name":"fixedOrVariable","in":"query","type":"string","required":false,"description":"Indicates the secured nature of limit that has been covered by a customer collateral. When FIXED the limit amount sanctioned will not have impact on changing value of collateral whereas when VARIABLE "},{"name":"securedAmount","in":"query","type":"string","required":false,"description":"The total amount that has been covered by the collateral underlying the credit facility"},{"name":"multiCustomerLimit","in":"query","type":"string","required":false,"description":"Specifies if a credit facility shall be used by multiple customers"},{"name":"groupClass","in":"query","type":"string","required":false,"description":"Classify the type of group, whether it is a CUSTOMER.GROUP or SUB.GROUP"},{"name":"isAggregationExists","in":"query","type":"string","required":false,"description":"Indicates if there exists aggregation of one or many customer exposure under a primary customer"},{"name":"mainGroupId","in":"query","type":"string","required":false,"description":"Identifier of the main group under which the sub group has been defined"},{"name":"creditLineProduct","in":"query","type":"string","required":false,"description":"Identifier of the limit product of the topmost credit facility in the hierarchy"},{"name":"gvIndicator","in":"query","type":"string","required":false,"description":"Indicator which specifies the graphical view of risk exposure report requested"},{"name":"onlineLimit","in":"query","type":"string","required":false,"description":"The Limit amount that is actually available for use.The system limit checks are performed against the online limit"},{"name":"amountInUnits","in":"query","type":"string","required":false,"description":"Indicates the Units of the Amounts"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"","default":"","400":"","500":""}}]},{"key":"holdings-creditLimits-transactions-service-v1.0.0","title":"Limit Contracts and Transaction Management","version":"v1.0.0","description":"API to manage Credit Limit related information such as updating, retrieving and deleting the contract associated with limit and transactions posted against the contract. This contains two types of functionalities supported, one - to record contract static information like contract nature, currency, ","endpointCount":7,"endpoints":[{"method":"POST","path":"/holdings/creditLimits/accounts/{accountId}","fullPath":"/api/v1.0.0/holdings/creditLimits/accounts/{accountId}","operationId":"createLimitContractLink","name":"Create a contract with static information such as contract type, reference, maturity, customers and system details. This establishes a link between contract static data and the credit limit and checks if the contract is applicable to be linked against specified limit based on rules defined for the credit line product.","summary":"Create contract association with the credit limit.","tags":["RETAIL"],"parameters":[{"name":"accountId","in":"path","type":"string","required":true,"description":"Identifier of the account. Often referred to as the account number, yet for consistency this is always referred to as accountId. Accepts both IBAN & BBAN"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"contractCustomerDetails":[{}],"additionalInformations":[{}],"originalTransactionId":"string","companyCode":"string","currencyId":"string","startDate":"2024-01-01","maturityDate":"2024-01-01","categoryId":"string","accountOfficer":"string","currencyMarket":"string","revolving":"string","contractStatus":"string","productLine":"string","jointLiability":"string","limitId":"string"}},"responses":{"200":"LimitContractLinkResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/holdings/creditLimits/accounts/{accountId}","fullPath":"/api/v1.0.0/holdings/creditLimits/accounts/{accountId}","operationId":"updateLimitContactLink","name":"Update contract's static information such as contract type, reference, maturity, customers and system details. This establishes a link between contract static data and the credit limit and checks if the contract is applicable to be linked against specified limit based on rules defined for the credit line product.","summary":"Update contract association with the credit limit.","tags":["RETAIL"],"parameters":[{"name":"accountId","in":"path","type":"string","required":true,"description":"Identifier of the account. Often referred to as the account number, yet for consistency this is always referred to as accountId. Accepts both IBAN & BBAN"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"contractCustomerDetails":[{}],"additionalInformations":[{}],"originalTransactionId":"string","companyCode":"string","currencyId":"string","startDate":"2024-01-01","maturityDate":"2024-01-01","categoryId":"string","accountOfficer":"string","currencyMarket":"string","revolving":"string","contractStatus":"string","productLine":"string","jointLiability":"string","limitId":"string"}},"responses":{"200":"LimitContactLinkResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"DELETE","path":"/holdings/creditLimits/accounts/{accountId}","fullPath":"/api/v1.0.0/holdings/creditLimits/accounts/{accountId}","operationId":"cancelLimitContractLink","name":"Closure of contract associated with the credit limit upon maturity or reversal of contract.","summary":"Closure of contract associated with the credit limit.","tags":["RETAIL"],"parameters":[{"name":"accountId","in":"path","type":"string","required":true,"description":"Identifier of the account. Often referred to as the account number, yet for consistency this is always referred to as accountId. Accepts both IBAN & BBAN"},{"name":"payload","in":"body","type":"object","required":false,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}}},"responses":{"200":"LimitContractLinkResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"POST","path":"/holdings/creditLimits/accounts/transactions/{transactionId}","fullPath":"/api/v1.0.0/holdings/creditLimits/accounts/transactions/{transactionId}","operationId":"createLimitTransactions","name":"Creates movements on credit limits with details such as transaction reference, amount, value date, revolving nature of contract and credit or debit indicator for contracts upon commitment or utilization or repayment of credit limit.","summary":"Creates the credit limit transactions.","tags":["RETAIL"],"parameters":[{"name":"transactionId","in":"path","type":"string","required":true,"description":"Unique transaction identifier for retrieving the details of the transaction. For example: FT0102030333 etc."},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"limitTransactionDetails":[{}],"additionalInformations":[{}],"eventType":"string","eventReference":"string","extensions":{}}},"responses":{"200":"LimitTransactionsResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/holdings/creditLimits/accounts/transactions/{transactionId}","fullPath":"/api/v1.0.0/holdings/creditLimits/accounts/transactions/{transactionId}","operationId":"updateLimitTransactions","name":"Updates movements on credit limits with details such as transaction reference, amount, value date, revolving nature of contract and credit or debit indicator for contracts upon commitment or utilization or repayment of credit limit.","summary":"Updates the credit limit transactions.","tags":["RETAIL"],"parameters":[{"name":"transactionId","in":"path","type":"string","required":true,"description":"Unique transaction identifier for retrieving the details of the transaction. For example: FT0102030333 etc."},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"limitTransactionDetails":[{}],"additionalInformations":[{}],"eventType":"string","eventReference":"string","extensions":{}}},"responses":{"200":"LimitTransactionsResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"DELETE","path":"/holdings/creditLimits/accounts/transactions/{transactionId}","fullPath":"/api/v1.0.0/holdings/creditLimits/accounts/transactions/{transactionId}","operationId":"deleteLimitTransactions","name":"Deletes the unauthorized credit limit transactions without performing any limit movements.","summary":"Deletes the credit limit transactions.","tags":["RETAIL"],"parameters":[{"name":"transactionId","in":"path","type":"string","required":true,"description":"Unique transaction identifier for retrieving the details of the transaction. For example: FT0102030333 etc."},{"name":"payload","in":"body","type":"object","required":false,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}}},"responses":{"200":"LimitTransactionsResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/holdings/creditLimits/accounts/transactions/{transactionId}/status","fullPath":"/api/v1.0.0/holdings/creditLimits/accounts/transactions/{transactionId}/status","operationId":"updateLimitTransactionStatus","name":"Update transaction status associated with the credit limit.","summary":"Update transaction status associated with the credit limit.","tags":["RETAIL"],"parameters":[{"name":"transactionId","in":"path","type":"string","required":true,"description":"Unique transaction identifier for retrieving the details of the transaction. For example: FT0102030333 etc."},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"limitTransactionDetails":[{}],"additionalInformations":[{}],"eventType":"string","eventReference":"string","extensions":{}}},"responses":{"200":"LimitTransactionStatusResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}}]},{"key":"holdings-creditLimits-transactions-service-v1.1.0","title":"Limit Contracts and Transaction Management","version":"v1.1.0","description":"API to manage Credit Limit related information such as updating, retrieving and deleting the contract associated with limit and transactions posted against the contract. This contains two types of functionalities supported, one - to record contract static information like contract nature, currency, ","endpointCount":9,"endpoints":[{"method":"POST","path":"/holdings/creditLimits/accounts/{accountId}","fullPath":"/api/v1.1.0/holdings/creditLimits/accounts/{accountId}","operationId":"createLimitContractLink","name":"Create a contract with static information such as contract type, reference, maturity, customers and system details. This establishes a link between contract static data and the credit limit and checks if the contract is applicable to be linked against specified limit based on rules defined for the credit line product.","summary":"Create contract association with the credit limit.","tags":["RETAIL"],"parameters":[{"name":"accountId","in":"path","type":"string","required":true,"description":"Identifier of the account. Often referred to as the account number, yet for consistency this is always referred to as accountId. Accepts both IBAN & BBAN"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"contractCustomerDetails":[{}],"additionalInformations":[{}],"originalTransactionId":"string","companyCode":"string","currencyId":"string","startDate":"2024-01-01","maturityDate":"2024-01-01","categoryId":"string","accountOfficer":"string","currencyMarket":"string","revolving":"string","contractStatus":"string","productLine":"string","jointLiability":"string","limitId":"string"}},"responses":{"200":"LimitContractLinkResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/holdings/creditLimits/accounts/{accountId}","fullPath":"/api/v1.1.0/holdings/creditLimits/accounts/{accountId}","operationId":"updateLimitContactLink","name":"Update contract's static information such as contract type, reference, maturity, customers and system details. This establishes a link between contract static data and the credit limit and checks if the contract is applicable to be linked against specified limit based on rules defined for the credit line product.","summary":"Update contract association with the credit limit.","tags":["RETAIL"],"parameters":[{"name":"accountId","in":"path","type":"string","required":true,"description":"Identifier of the account. Often referred to as the account number, yet for consistency this is always referred to as accountId. Accepts both IBAN & BBAN"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"contractCustomerDetails":[{}],"additionalInformations":[{}],"originalTransactionId":"string","companyCode":"string","currencyId":"string","startDate":"2024-01-01","maturityDate":"2024-01-01","categoryId":"string","accountOfficer":"string","currencyMarket":"string","revolving":"string","contractStatus":"string","productLine":"string","jointLiability":"string","limitId":"string"}},"responses":{"200":"LimitContactLinkResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"DELETE","path":"/holdings/creditLimits/accounts/{accountId}","fullPath":"/api/v1.1.0/holdings/creditLimits/accounts/{accountId}","operationId":"cancelLimitContractLink","name":"Closure of contract associated with the credit limit upon maturity or reversal of contract.","summary":"Closure of contract associated with the credit limit.","tags":["RETAIL"],"parameters":[{"name":"accountId","in":"path","type":"string","required":true,"description":"Identifier of the account. Often referred to as the account number, yet for consistency this is always referred to as accountId. Accepts both IBAN & BBAN"},{"name":"payload","in":"body","type":"object","required":false,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}}},"responses":{"200":"LimitContractLinkResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"POST","path":"/holdings/creditLimits/accounts/transactions/{transactionId}","fullPath":"/api/v1.1.0/holdings/creditLimits/accounts/transactions/{transactionId}","operationId":"createLimitTransactions","name":"Creates movements on credit limits with details such as transaction reference, amount, value date, revolving nature of contract and credit or debit indicator for contracts upon commitment or utilization or repayment of credit limit.","summary":"Creates the credit limit transactions.","tags":["RETAIL"],"parameters":[{"name":"transactionId","in":"path","type":"string","required":true,"description":"Unique transaction identifier for retrieving the details of the transaction. For example: FT0102030333 etc."},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"limitTransactionDetails":[{}],"additionalInformations":[{}],"eventType":"string","eventReference":"string","extensions":{}}},"responses":{"200":"LimitTransactionsResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/holdings/creditLimits/accounts/transactions/{transactionId}","fullPath":"/api/v1.1.0/holdings/creditLimits/accounts/transactions/{transactionId}","operationId":"updateLimitTransactions","name":"Updates movements on credit limits with details such as transaction reference, amount, value date, revolving nature of contract and credit or debit indicator for contracts upon commitment or utilization or repayment of credit limit.","summary":"Updates the credit limit transactions.","tags":["RETAIL"],"parameters":[{"name":"transactionId","in":"path","type":"string","required":true,"description":"Unique transaction identifier for retrieving the details of the transaction. For example: FT0102030333 etc."},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"limitTransactionDetails":[{}],"additionalInformations":[{}],"eventType":"string","eventReference":"string","extensions":{}}},"responses":{"200":"LimitTransactionsResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"DELETE","path":"/holdings/creditLimits/accounts/transactions/{transactionId}","fullPath":"/api/v1.1.0/holdings/creditLimits/accounts/transactions/{transactionId}","operationId":"deleteLimitTransactions","name":"Deletes the unauthorized movements on credit limits with details such as transaction reference, amount, value date, revolving nature of contract and credit or debit indicator for contracts upon commitment or utilization or repayment of credit limit.","summary":"Deletes the credit limit transactions.","tags":["RETAIL"],"parameters":[{"name":"transactionId","in":"path","type":"string","required":true,"description":"Unique transaction identifier for retrieving the details of the transaction. For example: FT0102030333 etc."},{"name":"payload","in":"body","type":"object","required":false,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}}},"responses":{"200":"LimitTransactionsResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/holdings/creditLimits/accounts/transactions/{transactionId}/approvals","fullPath":"/api/v1.1.0/holdings/creditLimits/accounts/transactions/{transactionId}/approvals","operationId":"approveLimitTransactions","name":"Approves the unauthorized movements on credit limits with details such as transaction reference, amount, value date, revolving nature of contract and credit or debit indicator for contracts upon commitment or utilization or repayment of credit limit.","summary":"Approves the credit limit transactions.","tags":["RETAIL"],"parameters":[{"name":"transactionId","in":"path","type":"string","required":true,"description":"Unique transaction identifier for retrieving the details of the transaction. For example: FT0102030333 etc."},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"limitTransactionDetails":[{}],"additionalInformations":[{}],"eventType":"string","eventReference":"string","extensions":{}}},"responses":{"200":"LimitTransactionsResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/holdings/creditLimits/accounts/transactions/{transactionId}/status","fullPath":"/api/v1.1.0/holdings/creditLimits/accounts/transactions/{transactionId}/status","operationId":"updateLimitTransactionStatus","name":"Update transaction status associated with the credit limit.","summary":"Update transaction status associated with the credit limit.","tags":["RETAIL"],"parameters":[{"name":"transactionId","in":"path","type":"string","required":true,"description":"Unique transaction identifier for retrieving the details of the transaction. For example: FT0102030333 etc."},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"limitTransactionDetails":[{}],"additionalInformations":[{}],"eventType":"string","eventReference":"string","extensions":{}}},"responses":{"200":"LimitTransactionStatusResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"DELETE","path":"/holdings/creditLimits/accounts/transactions/{transactionId}/cancellations","fullPath":"/api/v1.1.0/holdings/creditLimits/accounts/transactions/{transactionId}/cancellations","operationId":"cancelLimitTransactions","name":"Cancels the authorized movements on credit limits with details such as transaction reference, amount, value date, revolving nature of contract and credit or debit indicator for contracts upon commitment or utilization or repayment of credit limit.","summary":"Cancels the credit limit transactions.","tags":["RETAIL"],"parameters":[{"name":"transactionId","in":"path","type":"string","required":true,"description":"Unique transaction identifier for retrieving the details of the transaction. For example: FT0102030333 etc."},{"name":"payload","in":"body","type":"object","required":false,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}}},"responses":{"200":"LimitTransactionsResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}}]},{"key":"holdings-creditLines-service-v1.0.0","title":"Credit line details","version":"v1.0.0","description":"API to manage Credit Line related information such as updating, retrieving and deleting the contract associated with limit and transactions posted against the contract.","endpointCount":7,"endpoints":[{"method":"GET","path":"/holdings/creditLines/contracts/{contractId}","fullPath":"/api/v1.0.0/holdings/creditLines/contracts/{contractId}","operationId":"getLimitContractLink","name":"Retrieves the contract information such as customer id, contract currency, maturity date etc, linked to a credit line","summary":"Retrieves the contract information linked to limit.","tags":[],"parameters":[{"name":"contractId","in":"path","type":"string","required":true,"description":"Identifies the unique identifier of the transaction or contract."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"LimitContractLinkResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"POST","path":"/holdings/creditLines/contracts/{contractId}","fullPath":"/api/v1.0.0/holdings/creditLines/contracts/{contractId}","operationId":"createLimitContractLink","name":"Estabilishes a link between contract static data and the credit line. This also validates the rules defined for the credit line product.","summary":"Create contract association with the credit line.","tags":[],"parameters":[{"name":"contractId","in":"path","type":"string","required":true,"description":"Identifies the unique identifier of the transaction or contract."},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"customerIds":[{}],"primaryCustomers":[{}],"jointOwnershipPercentages":[{}],"jointOwners":[{}],"contractReference":"string","companyCode":"string","contractCurrency":"string","valueDate":"string","maturityDate":"string","categoryId":"string","accountOfficer":"string","currencyMarket":"string","revolving":"string","recordStatus":"string","productLine":"string"}},"responses":{"200":"LimitContractLinkResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/holdings/creditLines/contracts/{contractId}","fullPath":"/api/v1.0.0/holdings/creditLines/contracts/{contractId}","operationId":"updateLimitContractDetails","name":"Updates the modified information about the contract associated with a credit line. This also validates the rules defined for the credit line product.","summary":"Updates contract information linked to limit.","tags":[],"parameters":[{"name":"contractId","in":"path","type":"string","required":true,"description":"Identifies the unique identifier of the transaction or contract."},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"customerIds":[{}],"primaryCustomers":[{}],"jointOwnershipPercentages":[{}],"jointOwners":[{}],"contractReference":"string","companyCode":"string","contractCurrency":"string","valueDate":"string","maturityDate":"string","categoryId":"string","accountOfficer":"string","currencyMarket":"string","revolving":"string","recordStatus":"string","productLine":"string"}},"responses":{"200":"LimitContractDetailsResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"DELETE","path":"/holdings/creditLines/contracts/{contractId}","fullPath":"/api/v1.0.0/holdings/creditLines/contracts/{contractId}","operationId":"deleteLimitContract","name":"Deletes the contract information and delinks the association with the credit line.","summary":"Deletes the contract linked to limit.","tags":[],"parameters":[{"name":"contractId","in":"path","type":"string","required":true,"description":"Identifies the unique identifier of the transaction or contract."},{"name":"payload","in":"body","type":"object","required":false,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}}},"responses":{"200":"LimitContractResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"POST","path":"/holdings/creditLines/transactions","fullPath":"/api/v1.0.0/holdings/creditLines/transactions","operationId":"createLimitTransactions","name":"Creates a movements on credit line such as utilisation or repayment for contracts associated with the credit line.","summary":"Creates the credit line transactions.","tags":[],"parameters":[{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"externalTransactionDetails":[{}],"eventType":"string","extensionData":{}}},"responses":{"200":"LimitTransactionsResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/holdings/creditLines/{transactionId}/transactions","fullPath":"/api/v1.0.0/holdings/creditLines/{transactionId}/transactions","operationId":"getLimitTransactions","name":"Retrieves the information of movements on a credit line such as transaction reference, transaction amount, transaction currency, limit id etc.","summary":"Retrieves the credit line transactions.","tags":[],"parameters":[{"name":"transactionId","in":"path","type":"string","required":true,"description":"Unique transaction identifier for retrieving the details of the transaction. For example: FT0102030333 etc."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"LimitTransactionsResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"DELETE","path":"/holdings/creditLines/{transactionId}/transactions","fullPath":"/api/v1.0.0/holdings/creditLines/{transactionId}/transactions","operationId":"deleteLimitTransactions","name":"Deletes the movements on credit line such as utilisation or repayment for contract associated with the credit line.","summary":"Deletes the credit line transactions.","tags":[],"parameters":[{"name":"transactionId","in":"path","type":"string","required":true,"description":"Unique transaction identifier for retrieving the details of the transaction. For example: FT0102030333 etc."},{"name":"payload","in":"body","type":"object","required":false,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}}},"responses":{"200":"LimitTransactionsResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}}]},{"key":"holdings-currencyPosition-service-v1.0.0","title":"Treasury currency positions","version":"v1.0.0","description":"API to retrieve active spot and forward forex positions and closed forex (asset and liability) positions across each currency based on the forex contract's maturity status. Matured contracts are placed in the asset/liability position bucket and active positions are classified into spot/forward posit","endpointCount":2,"endpoints":[{"method":"GET","path":"/holdings/currency/positions","fullPath":"/api/v1.0.0/v1.0.0/holdings/currency/positions","operationId":"getCurrencyPositions","name":"Retrieves forex positions by currency and provides a break-up of closed positions(asset and liability position) and open positions(spot and forward position). It also arrives at the net currency position across each currency.","summary":"Retrieves currency positions","tags":[],"parameters":[{"name":"currency","in":"query","type":"string","required":false,"description":"Contains all details of each individual currency, for example, currency name, number of decimal places together with other information such as the buy and sell rates"},{"name":"dealerDesk","in":"query","type":"string","required":false,"description":"The dealer/desk responsible for monitoring and managing the currency positions."},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from t24 on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"The identifier of the underlying Entity/Company/Branch."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"CurrencyPositionsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/currency/{currencyId}/calendarPositions","fullPath":"/api/v1.0.0/v1.0.0/holdings/currency/{currencyId}/calendarPositions","operationId":"getCurrencyCalendarPositions","name":"Retrieves forex positions by currency,provides a break-up of closed positions(asset and liability position) and open positions(spot and forward position) and arranges them according to effective dates.","summary":"Retrieves currency positions","tags":[],"parameters":[{"name":"currencyId","in":"path","type":"string","required":true,"description":""},{"name":"currency","in":"query","type":"string","required":false,"description":"Contains all details of each individual currency, for example, currency name, number of decimal places together with other information such as the buy and sell rates"},{"name":"dealerDesk","in":"query","type":"string","required":false,"description":"The dealer/desk responsible for monitoring and managing the currency positions."},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from t24 on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"The identifier of the underlying Entity/Company/Branch."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"CurrencyCalendarPositionsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}}]},{"key":"holdings-customer-arrangements-v1.0.0","title":"Retrieve Customer Arrangements","version":"v1.0.0","description":"Retrieves the list of arrangement accounts associated with a customer","endpointCount":7,"endpoints":[{"method":"GET","path":"/holdings/customers/{customerId}/loans","fullPath":"/api/v1.0.0/holdings/customers/{customerId}/loans","operationId":"getCustomerLoans","name":"Retrieves the List of Loans associated with a customer","summary":"Retrieves the List of Loans associated with a customer","tags":[],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"Identifier of the customer"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"CustomerLoansResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/customers/loans","fullPath":"/api/v1.0.0/holdings/customers/loans","operationId":"getLoans","name":"Retrieves the Loan Details of an account","summary":"Retrieves the Loan Details of an account","tags":[],"parameters":[{"name":"customerId","in":"query","type":"string","required":false,"description":"Identifier of the customer"},{"name":"arrangementId","in":"query","type":"string","required":false,"description":"Indicates an unique identifier of an account"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"LoansResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/customers/{customerId}/deposits","fullPath":"/api/v1.0.0/holdings/customers/{customerId}/deposits","operationId":"getCustomerDeposits","name":"Retrieves the List of Deposit account for a given customer","summary":"Retrieves the List of Deposit account for a given customer","tags":[],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"Identifier of the customer"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"CustomerDepositsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/customers/deposits","fullPath":"/api/v1.0.0/holdings/customers/deposits","operationId":"getDeposits","name":"Retrieves the deposit details for a given account or a customer","summary":"Retrieves the deposit details for a given account or a customer","tags":[],"parameters":[{"name":"customerId","in":"query","type":"string","required":false,"description":"Identifier of the customer"},{"name":"arrangementId","in":"query","type":"string","required":false,"description":"Indicates an unique identifier of an account"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"DepositsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/customerArrangements/{customerId}","fullPath":"/api/v1.0.0/holdings/customerArrangements/{customerId}","operationId":"getCustomerArrangementDetails","name":"Retrieves the list of Arrangement Ids for a given Customer -This API is deprecated and going forward the following URL has to be used.URL:/holdings/customers/{customerId}/arrangements","summary":"Retrieves the list of Arrangement Ids for a given Customer","tags":[],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"Identifier of the customer"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"CustomerArrangementDetailsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/externalProducts/{customerId}/externalAccounts","fullPath":"/api/v1.0.0/holdings/externalProducts/{customerId}/externalAccounts","operationId":"getCustomerExternal","name":"Retrieves the List of available external accounts for a given customer","summary":"Retrieves the List of available external accounts for a given customer","tags":[],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"Identifier of the customer"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"CustomerExternalResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/externalProducts/{customerId}/closedAccounts","fullPath":"/api/v1.0.0/holdings/externalProducts/{customerId}/closedAccounts","operationId":"getCustomerClosedExternal","name":"Retrieves the List of closed external accounts for a given customer","summary":"Retrieves the List of closed external accounts for a given customer","tags":[],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"Identifier of the customer"},{"name":"arrangementId","in":"query","type":"string","required":false,"description":"Indicates an unique identifier of an account"},{"name":"productLine","in":"query","type":"string","required":false,"description":"The top level product line, which the product is ultimately attached to. May be a Temenos-defined product line such as ACCOUNTS, AGENT, BUNDLE, CONSENT, DEPOSITS, LENDING, REWARDS, etc. or one defined"},{"name":"productGroup","in":"query","type":"string","required":false,"description":"Indicates a group under which the products exists"},{"name":"product","in":"query","type":"string","required":false,"description":"Specifies the list of products licensed for the institution. This will be used to set the products field in the SPF (System Parameter) table and the master company. The products in the company can onl"},{"name":"currency","in":"query","type":"string","required":false,"description":"Identifies the currency. E.g. USD, GBP etc"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"CustomerClosedExternalResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}}]},{"key":"holdings-customer-arrangements-v1.1.0","title":"Retrieve Customer Arrangements","version":"v1.0.0","description":"Retrieves the list of arrangement accounts associated with a customer","endpointCount":7,"endpoints":[{"method":"GET","path":"/holdings/customers/{customerId}/loans","fullPath":"/api/v1.0.0/holdings/customers/{customerId}/loans","operationId":"getCustomerLoans","name":"Retrieves the list of loans associated with a customer","summary":"Retrieves the list of loans associated with a customer","tags":[],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"Identifier of the customer"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"CustomerLoansResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/customers/loans","fullPath":"/api/v1.0.0/holdings/customers/loans","operationId":"getLoans","name":"Retrieves the loan details of an account","summary":"Retrieves the loan details of an account","tags":[],"parameters":[{"name":"customerId","in":"query","type":"string","required":false,"description":"Identifier of the customer"},{"name":"arrangementId","in":"query","type":"string","required":false,"description":"Indicates an unique identifier of an account"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"LoansResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/customers/{customerId}/deposits","fullPath":"/api/v1.0.0/holdings/customers/{customerId}/deposits","operationId":"getCustomerDeposits","name":"Retrieves the list of deposit account for a given customer","summary":"Retrieves the list of deposit account for a given customer","tags":[],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"Identifier of the customer"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"CustomerDepositsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/customers/deposits","fullPath":"/api/v1.0.0/holdings/customers/deposits","operationId":"getDeposits","name":"Retrieves the deposit details for a given account or a customer","summary":"Retrieves the deposit details for a given account or a customer","tags":[],"parameters":[{"name":"customerId","in":"query","type":"string","required":false,"description":"Identifier of the customer"},{"name":"arrangementId","in":"query","type":"string","required":false,"description":"Indicates an unique identifier of an account"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"DepositsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/customerArrangements/{customerId}","fullPath":"/api/v1.0.0/holdings/customerArrangements/{customerId}","operationId":"getCustomerArrangementDetails","name":"Retrieves the list of arrangement ids for a given customer -This API is deprecated and going forward the following URL has to be used.URL:/holdings/customers/{customerId}/arrangements","summary":"Retrieves the list of arrangement ids for a given customer","tags":[],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"Identifier of the customer"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"CustomerArrangementDetailsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/externalProducts/{customerId}/externalAccounts","fullPath":"/api/v1.0.0/holdings/externalProducts/{customerId}/externalAccounts","operationId":"getCustomerExternal","name":"Retrieves the list of available external accounts for a given customer","summary":"Retrieves the list of available external accounts for a given customer","tags":[],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"Identifier of the customer"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"CustomerExternalResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/externalProducts/{customerId}/closedAccounts","fullPath":"/api/v1.0.0/holdings/externalProducts/{customerId}/closedAccounts","operationId":"getCustomerClosedExternal","name":"Retrieves the list of closed external accounts for a given customer","summary":"Retrieves the list of closed external accounts for a given customer","tags":[],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"Identifier of the customer"},{"name":"arrangementId","in":"query","type":"string","required":false,"description":"Indicates an unique identifier of an account"},{"name":"productLine","in":"query","type":"string","required":false,"description":"The top level product line, which the product is ultimately attached to. May be a Temenos-defined product line such as ACCOUNTS, AGENT, BUNDLE, CONSENT, DEPOSITS, LENDING, REWARDS, etc. or one defined"},{"name":"productGroup","in":"query","type":"string","required":false,"description":"Indicates a group under which the products exists"},{"name":"product","in":"query","type":"string","required":false,"description":"Specifies the list of products licensed for the institution. This will be used to set the products field in the SPF (System Parameter) table and the master company. The products in the company can onl"},{"name":"currency","in":"query","type":"string","required":false,"description":"Identifies the currency. E.g. USD, GBP etc"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"CustomerClosedExternalResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}}]},{"key":"holdings-customers-service-v1.0.0","title":"Holdings Customers APIs","version":"v1.0.0","description":"Retrieves all Holdings of the Customer","endpointCount":7,"endpoints":[{"method":"GET","path":"/holdings/customers/{customerId}/arrangements","fullPath":"/api/v1.0.0/holdings/customers/{customerId}/arrangements","operationId":"getArrangementsForCustomer","name":"","summary":"","tags":[],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"Identifier of the customer"},{"name":"arrangementId","in":"query","type":"string","required":false,"description":"Indicates an unique identifier of an account"},{"name":"productLineId","in":"query","type":"string","required":false,"description":"The top level product line, which the product is ultimately attached to. May be a Temenos-defined product line such as ACCOUNTS, AGENT, BUNDLE, CONSENT, DEPOSITS, LENDING, REWARDS, etc. or one defined"},{"name":"productGroupId","in":"query","type":"string","required":false,"description":"The group, as defined by the institution, that the product belongs to."},{"name":"productId","in":"query","type":"string","required":false,"description":"Contains the unique identifier of the product, e.g. the product id of the arrangement account."},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from t24 on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"The identifier of the underlying Entity/Company/Branch."}],"requestBodyExample":null,"responses":{"200":"ArrangementsForCustomerResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/customers/{customerId}/arrangements/{arrangementId}","fullPath":"/api/v1.0.0/holdings/customers/{customerId}/arrangements/{arrangementId}","operationId":"getArrangementForCustomer","name":"","summary":"","tags":[],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"Identifier of the customer"},{"name":"arrangementId","in":"path","type":"string","required":true,"description":"Indicates an unique identifier of an account"},{"name":"productLineId","in":"query","type":"string","required":false,"description":"The top level product line, which the product is ultimately attached to. May be a Temenos-defined product line such as ACCOUNTS, AGENT, BUNDLE, CONSENT, DEPOSITS, LENDING, REWARDS, etc. or one defined"},{"name":"productGroupId","in":"query","type":"string","required":false,"description":"The group, as defined by the institution, that the product belongs to."},{"name":"productId","in":"query","type":"string","required":false,"description":"Contains the unique identifier of the product, e.g. the product id of the arrangement account."},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from t24 on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"The identifier of the underlying Entity/Company/Branch."}],"requestBodyExample":null,"responses":{"200":"ArrangementForCustomerResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/customers/{customerId}/accounts/{accountId}","fullPath":"/api/v1.0.0/holdings/customers/{customerId}/accounts/{accountId}","operationId":"getAccountForCustomer","name":"","summary":"","tags":[],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"Identifier of the customer"},{"name":"accountId","in":"path","type":"string","required":true,"description":"Identifier of the account. Often referred to as the account number, yet for consistency this is always referred to as accountId. Accepts both IBAN & BBAN"},{"name":"productId","in":"query","type":"string","required":false,"description":"Contains the unique identifier of the product, e.g. the product id of the arrangement account."},{"name":"currencyId","in":"query","type":"string","required":false,"description":"Identifier of the currency. This is the 3-letter ISO 4217 code of the currency."},{"name":"limitReference","in":"query","type":"string","required":false,"description":"Identifies the credit limit reference for the underlying account."},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from t24 on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"The identifier of the underlying Entity/Company/Branch."}],"requestBodyExample":null,"responses":{"200":"AccountForCustomerResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/customers/{customerId}/overdueSettlements","fullPath":"/api/v1.0.0/holdings/customers/{customerId}/overdueSettlements","operationId":"getOverdueSettlementsByCustomer","name":"","summary":"","tags":[],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"Identifier of the customer"},{"name":"transactionId","in":"query","type":"string","required":false,"description":"Unique transaction identifier for retrieving the details of the transaction. For example: FT0102030333 etc."},{"name":"portfolioId","in":"query","type":"string","required":false,"description":"Id of the portfolio or security account"},{"name":"brokerId","in":"query","type":"string","required":false,"description":"The identifier of the broker"},{"name":"tradeDate","in":"query","type":"string","required":false,"description":"Standard date field which records trade date of the account"},{"name":"valueDate","in":"query","type":"string","required":false,"description":"Indicates the value date on which the underlying accounting entry is to be given value (for interest purposes)"},{"name":"depository","in":"query","type":"string","required":false,"description":"Person designated as depository by the company in or pursuant to this Indenture, and, unless otherwise provided with respect to any security, any successor to such person"},{"name":"currency","in":"query","type":"string","required":false,"description":"Contains all details of each individual currency, for example, currency name, number of decimal places together with other information such as the buy and sell rates"},{"name":"instrumentId","in":"query","type":"string","required":false,"description":"The identifier of the instrument"},{"name":"deliveryInstruction","in":"query","type":"string","required":false,"description":"Customer's directions to a bank as to the disposition of funds and securities in the customer's account"},{"name":"transactionType","in":"query","type":"string","required":false,"description":"Identifies the transaction type applicable to the transaction being processed, i.e. outward or inward payment. For example: ACPX, OTPX etc."},{"name":"quantity","in":"query","type":"string","required":false,"description":"The nominal quantity"},{"name":"stockExchange","in":"query","type":"string","required":false,"description":"The stock exchange identifier"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from t24 on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"The identifier of the underlying Entity/Company/Branch."}],"requestBodyExample":null,"responses":{"200":"OverdueSettlementsByCustomerResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/customers/{customerId}/accounts/{accountId}/transactions","fullPath":"/api/v1.0.0/holdings/customers/{customerId}/accounts/{accountId}/transactions","operationId":"getAccountTransactionsForCustomer","name":"","summary":"","tags":[],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":""},{"name":"accountId","in":"path","type":"string","required":true,"description":"Identifier of the account. Often referred to as the account number, yet for consistency this is always referred to as accountId. Accepts both IBAN & BBAN"},{"name":"bookingDate","in":"query","type":"string","required":false,"description":"Business date on which the accounting entry was generated."},{"name":"processingDate","in":"query","type":"string","required":false,"description":"The date when payment instruction is processed in system."},{"name":"valueDate","in":"query","type":"string","required":false,"description":"Indicates the value date on which the underlying accounting entry is to be given value (for interest purposes)"},{"name":"description","in":"query","type":"string","required":false,"description":"Contains the description of purpose of the payment."},{"name":"reversalMarker","in":"query","type":"string","required":false,"description":"Denotes the flag which is set whenever any credit or reversal debit entries with future exposure dates are processed"},{"name":"includeSubAcct","in":"query","type":"string","required":false,"description":"Denotes the flag which needs to be set in order to allow the automatic creation of sub-accounts and the automatic distribution of transactions over sub-accounts"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from t24 on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"The identifier of the underlying Entity/Company/Branch."}],"requestBodyExample":null,"responses":{"200":"AccountTransactionsForCustomerResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/customers/{customerId}/portfolios/{portfolioId}/outstandingSettlements","fullPath":"/api/v1.0.0/holdings/customers/{customerId}/portfolios/{portfolioId}/outstandingSettlements","operationId":"getOutstandingSettlements","name":"","summary":"","tags":[],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"Identifier of the customer"},{"name":"portfolioId","in":"path","type":"string","required":true,"description":"Id of the portfolio or security account"},{"name":"transactionId","in":"query","type":"string","required":false,"description":"Unique transaction identifier for retrieving the details of the transaction. For example: FT0102030333 etc."},{"name":"brokerId","in":"query","type":"string","required":false,"description":"The identifier of the broker"},{"name":"tradeDate","in":"query","type":"string","required":false,"description":"Standard date field which records trade date of the account"},{"name":"valueDate","in":"query","type":"string","required":false,"description":"Indicates the value date on which the underlying accounting entry is to be given value (for interest purposes)"},{"name":"depository","in":"query","type":"string","required":false,"description":"Person designated as depository by the company in or pursuant to this Indenture, and, unless otherwise provided with respect to any security, any successor to such person"},{"name":"currency","in":"query","type":"string","required":false,"description":"Contains all details of each individual currency, for example, currency name, number of decimal places together with other information such as the buy and sell rates"},{"name":"instrumentId","in":"query","type":"string","required":false,"description":"The identifier of the instrument"},{"name":"deliveryInstruction","in":"query","type":"string","required":false,"description":"Customer's directions to a bank as to the disposition of funds and securities in the customer's account"},{"name":"transactionType","in":"query","type":"string","required":false,"description":"Identifies the transaction type applicable to the transaction being processed, i.e. outward or inward payment. For example: ACPX, OTPX etc."},{"name":"quantity","in":"query","type":"string","required":false,"description":"The nominal quantity"},{"name":"stockExchange","in":"query","type":"string","required":false,"description":"The stock exchange identifier"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from t24 on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"The identifier of the underlying Entity/Company/Branch."}],"requestBodyExample":null,"responses":{"200":"OutstandingSettlementsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/customers/{customerId}/accounts","fullPath":"/api/v1.0.0/holdings/customers/{customerId}/accounts","operationId":"getAccountsForCustomer","name":"","summary":"","tags":[],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"Identifier of the customer"},{"name":"accountId","in":"query","type":"string","required":false,"description":"Identifier of the account. Often referred to as the account number, yet for consistency this is always referred to as accountId. Accepts both IBAN & BBAN"},{"name":"productId","in":"query","type":"string","required":false,"description":"Contains the unique identifier of the product, e.g. the product id of the arrangement account."},{"name":"currencyId","in":"query","type":"string","required":false,"description":"Identifier of the currency. This is the 3-letter ISO 4217 code of the currency."},{"name":"limitReference","in":"query","type":"string","required":false,"description":"Identifies the credit limit reference for the underlying account."},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from t24 on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"The identifier of the underlying Entity/Company/Branch."}],"requestBodyExample":null,"responses":{"200":"AccountsForCustomerResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}}]},{"key":"holdings-dashboards-service-v1.0.0","title":" Corporate Dashboard","version":"v1.0.0","description":"API to retrieve the limits, trade finance, guarantees and other corporate approval requests","endpointCount":4,"endpoints":[{"method":"GET","path":"/holdings/dashboards/limits","fullPath":"/api/v1.0.0/holdings/dashboards/limits","operationId":"getLimits","name":"Retrieves the limit details for corporate products","summary":"Retrieves the limit details","tags":[],"parameters":[{"name":"customerId","in":"query","type":"string","required":false,"description":"Identifier of the customer"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"LimitsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/dashboards/drafts","fullPath":"/api/v1.0.0/holdings/dashboards/drafts","operationId":"getDashboardDrafts","name":"Retrieves the list of created drafts for the customer","summary":"Retrieves the created drafts","tags":[],"parameters":[{"name":"customerId","in":"query","type":"string","required":false,"description":"Identifier of the customer"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"DashboardDraftsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/dashboards/messages","fullPath":"/api/v1.0.0/holdings/dashboards/messages","operationId":"getBankMessages","name":"Retrieves the list of messages from the bank for specific customer ","summary":"Retrieves the bank messages","tags":[],"parameters":[{"name":"customerId","in":"query","type":"string","required":false,"description":"Identifier of the customer"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"BankMessagesResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/dashboards/approvals","fullPath":"/api/v1.0.0/holdings/dashboards/approvals","operationId":"getDashboardApprovals","name":"Retrieves the list of initiated corporate approval requests, Such as Trade Finance, Guarantees and etc.","summary":"Retrieves the initiated records for approval","tags":[],"parameters":[{"name":"customerId","in":"query","type":"string","required":false,"description":"Identifier of the customer"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"DashboardApprovalsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}}]},{"key":"holdings-deliveries-service-v1.0.0","title":"Inward and Outward messages","version":"v1.0.0","description":"Get and Management of Deliveries APIs","endpointCount":11,"endpoints":[{"method":"GET","path":"/holdings/messages/summary","fullPath":"/api/v1.0.0/holdings/messages/summary","operationId":"getDeliveryMessageSummary","name":"Retrieve the details of delivery message summary for specific id","summary":"Retrieve the delivery message summary","tags":[],"parameters":[{"name":"deliveryReference","in":"query","type":"string","required":false,"description":"Indicates the delivery reference Id generated for the activity"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"DeliveryMessageSummaryResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/messages/preview","fullPath":"/api/v1.0.0/holdings/messages/preview","operationId":"getDeliveryMessages","name":"Retrieve the list of delivery messages for specific transaction","summary":"Retrieve the delivery messages","tags":[],"parameters":[{"name":"messageId","in":"query","type":"string","required":false,"description":"The holds the record key of the message ID."},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"DeliveryMessagesResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/messages/inwards","fullPath":"/api/v1.0.0/holdings/messages/inwards","operationId":"getInwardDeliveries","name":"Retrieve the list of inward delivery messages for specific transaction","summary":"Retrieve the inward delivery messages","tags":[],"parameters":[{"name":"keys","in":"query","type":"string","required":false,"description":"Contains the Unique reference number made up of the home country code, the NCA(National Competent Authorities) and the reference number at the NCA(National Competent Authorities). For example GB-FCA-1"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"InwardDeliveriesResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/messages/outwards","fullPath":"/api/v1.0.0/holdings/messages/outwards","operationId":"getOutwardDeliveries","name":"Retrieve the list of outward delivery messages for specific transaction","summary":"Retrieve the outward delivery messages","tags":[],"parameters":[{"name":"keys","in":"query","type":"string","required":false,"description":"Contains the Unique reference number made up of the home country code, the NCA(National Competent Authorities) and the reference number at the NCA(National Competent Authorities). For example GB-FCA-1"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"OutwardDeliveriesResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/messages/advices","fullPath":"/api/v1.0.0/holdings/messages/advices","operationId":"getDeliveryAdvices","name":"Retrieve the list of delivery advice's for specific transaction ","summary":"Retrieves the delivery advices","tags":[],"parameters":[{"name":"transactionReference","in":"query","type":"string","required":false,"description":"Contains the identifier for the transaction in the core system"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"DeliveryAdvicesResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"POST","path":"/holdings/messages/securityTrades/cancellations","fullPath":"/api/v1.0.0/holdings/messages/securityTrades/cancellations","operationId":"cancelDeliveryOrder","name":"Creates ISO MX message with details such as message reference, receiver and order reference to cancel trade orders","summary":"Creates ISO MX message to cancel trade orders","tags":[],"parameters":[{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"msgId":"string","creDtTm":"string","ordrRef":"string","receiver":"string"}},"responses":{"200":"DeliveryOrderResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"POST","path":"/holdings/messages/securityTrades/status","fullPath":"/api/v1.0.0/holdings/messages/securityTrades/status","operationId":"orderStatusReport","name":"Creates ISO MX message to retrieve trade order status with details such as order reference, order type, message reference and status reason codes","summary":"Creates ISO MX message to retrieve trade order status","tags":[],"parameters":[{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"orderDetsTypeGroup":[{}],"orderDetsRefGroup":[{}],"ordrStsGroup":[{}],"ordrStsCancCdGroup":[{}],"ordrStsCancIdGroup":[{}],"ordrStsCancSchmeNmGroup":[{}],"ordrStsCancIssrGroup":[{}],"ordrStsCondlyAccptdNoSpcfdRsnGroup":[{}],"ordrStsCondlyAccptdCdGroup":[{}],"ordrStsCondlyAccptdIdGroup":[{}],"ordrStsCondlyAccptdSchmeNmGroup":[{}],"ordrStsCondlyAccptdIssrGroup":[{}],"ordrStsRjctdCdGroup":[{}],"ordrStsRjctdIdGroup":[{}],"ordrStsRjctdSchmeNmGroup":[{}]}},"responses":{"200":"StatusReportResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"POST","path":"/holdings/messages/securityTrades/switchOrders","fullPath":"/api/v1.0.0/holdings/messages/securityTrades/switchOrders","operationId":"switchOrder","name":"Creates ISO MX message to switch trade orders with details such as order reference, message reference, receiver and order switch details","summary":"Creates ISO MX message to switch trade orders","tags":[],"parameters":[{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"swtchOrdrDtlsLegTypeGroup":[{}],"finInstrmDtlsISINGroup":[{}],"finInstrmDtlsSEPOLGroup":[{}],"finInstrmDtlsCUSIPGroup":[{}],"finInstrmDtlsRICGroup":[{}],"finInstrmDtlsTckrSymbGroup":[{}],"finInstrmDtlsBlmbrgGroup":[{}],"finInstrmDtlsCTAGroup":[{}],"finInstrmDtlsQUICKGroup":[{}],"finInstrmDtlsWrtpprGroup":[{}],"finInstrmDtlsDtchGroup":[{}],"finInstrmDtlsVlrnGroup":[{}],"finInstrmDtlsSCVMGroup":[{}],"finInstrmDtlsBelgnGroup":[{}],"finInstrmDtlsCmonGroup":[{}]}},"responses":{"200":"OrderResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/holdings/messages/inwards/{headerId}/status ","fullPath":"/api/v1.0.0/holdings/messages/inwards/{headerId}/status ","operationId":"updateMessageStatus","name":"Updates inward header messages with details such as disposition status and errors reasons","summary":"Updates status of inward header messages","tags":[],"parameters":[{"name":"headerId","in":"path","type":"string","required":true,"description":"Identifier of the inward or outward header"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"transactionReferenceGroup":[{}],"messageDisposition":"string","errorMessage":"string"}},"responses":{"200":"MessageStatusResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"POST","path":"/holdings/messages/securityTrades/confirmations","fullPath":"/api/v1.0.0/holdings/messages/securityTrades/confirmations","operationId":"orderConfirmation","name":"Creates ISO MX message to confirm trade orders with details such as order reference, message reference, receiver, deal code, units, price and amount","summary":"Creates ISO MX message to confirm trade orders","tags":[],"parameters":[{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"msgId":"string","creDtTm":"string","invstmtAcctDtlsAcctId":"string","ordrRef":"string","dealRef":"string","finInstrmDtlsISIN":"string","finInstrmDtlsSEPOL":"string","finInstrmDtlsCUSIP":"string","finInstrmDtlsRIC":"string","finInstrmDtlsTckrSymb":"string","finInstrmDtlsBlmbrg":"string","finInstrmDtlsCTA":"string","finInstrmDtlsQUICK":"string","finInstrmDtlsWrtppr":"string","finInstrmDtlsDtch":"string"}},"responses":{"200":"ConfirmationResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"POST","path":"/holdings/messages/statements/xml","fullPath":"/api/v1.0.0/holdings/messages/statements/xml","operationId":"createXmlStatementEvent","name":"Creates the details related to an XML statement of an account along with the delivery preferences that will be further utilized for delivery message generation.","summary":"Creates the details of XML statement","tags":[],"parameters":[{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"xmlStatementMessageId":"string","xmlStatementMessageKey":"string","masterXmlStatementMessageId":"string","camtMessageType":"string","customerId":0.0,"accountId":"string","accountCurrency":"string","deliveryStatementRequestId":"string","carrier":"string","ownerDeliveryAddress":"string","companyCode":"string","ownerStatementVariant":"string","ownerTransformationRule":"string","recipientId":"string","recipientName":"string"}},"responses":{"200":"XmlStatementEventResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}}]},{"key":"holdings-deliveries-service-v1.1.0","title":"Inward and Outward messages","version":"v1.1.0","description":"API to manage inward and outward delivery messages used for payment transactions, notices and communications between banks and customers using message formats like MT SWIFT, ISO MX and XML","endpointCount":12,"endpoints":[{"method":"GET","path":"/holdings/messages/summary","fullPath":"/api/v1.1.0/holdings/messages/summary","operationId":"getDeliveryMessageSummary","name":"Retrieve the details of delivery message summary with details such as delivery reference, date, message type and message reference","summary":"Retrieve the delivery message summary","tags":[],"parameters":[{"name":"deliveryReference","in":"query","type":"string","required":false,"description":"Indicates the delivery reference Id generated for the activity"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"DeliveryMessageSummaryResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/messages/preview","fullPath":"/api/v1.1.0/holdings/messages/preview","operationId":"getDeliveryMessages","name":"Retrieve the list of delivery messages for specific transaction","summary":"Retrieve the delivery messages","tags":[],"parameters":[{"name":"messageId","in":"query","type":"string","required":false,"description":"The holds the record key of the message ID."},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"DeliveryMessagesResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/messages/inwards","fullPath":"/api/v1.1.0/holdings/messages/inwards","operationId":"getInwardDeliveries","name":"Retrieve the list of inward delivery messages for specific transaction","summary":"Retrieve the inward delivery messages","tags":[],"parameters":[{"name":"keys","in":"query","type":"string","required":false,"description":"Contains the Unique reference number made up of the home country code, the NCA(National Competent Authorities) and the reference number at the NCA(National Competent Authorities). For example GB-FCA-1"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"InwardDeliveriesResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/messages/outwards","fullPath":"/api/v1.1.0/holdings/messages/outwards","operationId":"getOutwardDeliveries","name":"Retrieve the list of outward delivery messages for specific transaction","summary":"Retrieve the outward delivery messages","tags":[],"parameters":[{"name":"keys","in":"query","type":"string","required":false,"description":"Contains the Unique reference number made up of the home country code, the NCA(National Competent Authorities) and the reference number at the NCA(National Competent Authorities). For example GB-FCA-1"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"OutwardDeliveriesResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/messages/advices","fullPath":"/api/v1.1.0/holdings/messages/advices","operationId":"getDeliveryAdvices","name":"Retrieve the list of delivery advice's for specific transaction ","summary":"Retrieves the delivery advices","tags":[],"parameters":[{"name":"transactionReference","in":"query","type":"string","required":false,"description":"Contains the identifier for the transaction in the core system"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"DeliveryAdvicesResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"POST","path":"/holdings/messages/securityTrades/cancellations","fullPath":"/api/v1.1.0/holdings/messages/securityTrades/cancellations","operationId":"cancelDeliveryOrder","name":"Creates ISO MX message with details such as message reference, receiver and order reference to cancel trade orders","summary":"Creates ISO MX message to cancel trade orders","tags":[],"parameters":[{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"msgId":"string","creDtTm":"string","ordrRef":"string","receiver":"string"}},"responses":{"200":"DeliveryOrderResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"POST","path":"/holdings/messages/securityTrades/status","fullPath":"/api/v1.1.0/holdings/messages/securityTrades/status","operationId":"orderStatusReport","name":"Creates ISO MX message to retrieve trade order status with details such as order reference, order type, message reference and status reason codes","summary":"Creates ISO MX message to retrieve trade order status","tags":[],"parameters":[{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"orderDetsTypeGroup":[{}],"orderDetsRefGroup":[{}],"ordrStsGroup":[{}],"ordrStsCancCdGroup":[{}],"ordrStsCancIdGroup":[{}],"ordrStsCancSchmeNmGroup":[{}],"ordrStsCancIssrGroup":[{}],"ordrStsCondlyAccptdNoSpcfdRsnGroup":[{}],"ordrStsCondlyAccptdCdGroup":[{}],"ordrStsCondlyAccptdIdGroup":[{}],"ordrStsCondlyAccptdSchmeNmGroup":[{}],"ordrStsCondlyAccptdIssrGroup":[{}],"ordrStsRjctdCdGroup":[{}],"ordrStsRjctdIdGroup":[{}],"ordrStsRjctdSchmeNmGroup":[{}]}},"responses":{"200":"StatusReportResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"POST","path":"/holdings/messages/securityTrades/switchOrders","fullPath":"/api/v1.1.0/holdings/messages/securityTrades/switchOrders","operationId":"switchOrder","name":"Creates ISO MX message to switch trade orders with details such as order reference, message reference, receiver and order switch details","summary":"Creates ISO MX message to switch trade orders","tags":[],"parameters":[{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"swtchOrdrDtlsLegTypeGroup":[{}],"finInstrmDtlsISINGroup":[{}],"finInstrmDtlsSEPOLGroup":[{}],"finInstrmDtlsCUSIPGroup":[{}],"finInstrmDtlsRICGroup":[{}],"finInstrmDtlsTckrSymbGroup":[{}],"finInstrmDtlsBlmbrgGroup":[{}],"finInstrmDtlsCTAGroup":[{}],"finInstrmDtlsQUICKGroup":[{}],"finInstrmDtlsWrtpprGroup":[{}],"finInstrmDtlsDtchGroup":[{}],"finInstrmDtlsVlrnGroup":[{}],"finInstrmDtlsSCVMGroup":[{}],"finInstrmDtlsBelgnGroup":[{}],"finInstrmDtlsCmonGroup":[{}]}},"responses":{"200":"OrderResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/holdings/messages/inwards/{headerId}/status ","fullPath":"/api/v1.1.0/holdings/messages/inwards/{headerId}/status ","operationId":"updateMessageStatus","name":"Updates inward header messages with details such as disposition status and errors reasons","summary":"Updates status of inward header messages","tags":[],"parameters":[{"name":"headerId","in":"path","type":"string","required":true,"description":"Identifier of the inward header"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"transactionReferenceGroup":[{}],"carrierAddressIds":[{}],"messageDisposition":"string","errorMessage":"string","messageType":"string","format":"string"}},"responses":{"200":"MessageStatusResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"POST","path":"/holdings/messages/securityTrades/confirmations","fullPath":"/api/v1.1.0/holdings/messages/securityTrades/confirmations","operationId":"orderConfirmation","name":"Creates ISO MX message to confirm trade orders with details such as order reference, message reference, receiver, deal code, units, price and amount","summary":"Creates ISO MX message to confirm trade orders","tags":[],"parameters":[{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"msgId":"string","creDtTm":"string","invstmtAcctDtlsAcctId":"string","ordrRef":"string","dealRef":"string","finInstrmDtlsISIN":"string","finInstrmDtlsSEPOL":"string","finInstrmDtlsCUSIP":"string","finInstrmDtlsRIC":"string","finInstrmDtlsTckrSymb":"string","finInstrmDtlsBlmbrg":"string","finInstrmDtlsCTA":"string","finInstrmDtlsQUICK":"string","finInstrmDtlsWrtppr":"string","finInstrmDtlsDtch":"string"}},"responses":{"200":"ConfirmationResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"POST","path":"/holdings/messages/statements/xml","fullPath":"/api/v1.1.0/holdings/messages/statements/xml","operationId":"createXmlStatementEvent","name":"Creates the details related to an XML statement of an account along with the delivery preferences that will be further utilized for delivery message generation.","summary":"Creates the details of XML statement","tags":[],"parameters":[{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"xmlStatementMessageId":"string","xmlStatementMessageKey":"string","masterXmlStatementMessageId":"string","camtMessageType":"string","customerId":0.0,"accountId":"string","accountCurrency":"string","deliveryStatementRequestId":"string","carrier":"string","ownerDeliveryAddress":"string","companyCode":"string","ownerStatementVariant":"string","ownerTransformationRule":"string","recipientId":"string","recipientName":"string"}},"responses":{"200":"XmlStatementEventResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/holdings/messages/inwards/{headerId}/status","fullPath":"/api/v1.1.0/holdings/messages/inwards/{headerId}/status","operationId":"getInwardMessageStatus","name":"Retrieves status of inward header message","summary":"Retrieves the inward header message with details such as disposition status and error messages for the specified header id.","tags":[],"parameters":[{"name":"headerId","in":"path","type":"string","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"MessageStatusResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}}]},{"key":"holdings-deposits-arrangements-v1.0.0","title":"Deposit Arrangements","version":"v1.0.0","description":"API to create and manage various types of deposits such as Short term, Long term, call, bond, Islamic and Redeemable term deposit accounts","endpointCount":11,"endpoints":[{"method":"POST","path":"/holdings/deposits/shortTermDeposits","fullPath":"/api/v1.0.0/holdings/deposits/shortTermDeposits","operationId":"createShortTermDeposit","name":"Create a Short Term Deposit Account","summary":"Create a Short Term Deposit Account","tags":[],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"partyIds":[{}],"partyRoles":[{}],"agentCustomerIds":[{}],"agentArrangementIds":[{}],"agentRoles":[{}],"arrangmentId":"string","productId":"string","activityId":"string","currency":"string","productVariation":"string","pricingSelection":"string","pricingPlan":"string","rewardsArrangementId":"string","tradeDate":"string","arrangementEffectiveDate":"string"}},"responses":{"200":"createShortTermDepositResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"POST","path":"/holdings/deposits/oneYearBonds","fullPath":"/api/v1.0.0/holdings/deposits/oneYearBonds","operationId":"createOneYearBond","name":"Creates a One year Bond/Deposit Account","summary":"Creates a One year Bond/Deposit Account","tags":[],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"partyIds":[{}],"partyRoles":[{}],"agentCustomerIds":[{}],"agentArrangementIds":[{}],"agentRoles":[{}],"arrangmentId":"string","productId":"string","activityId":"string","currency":"string","productVariation":"string","pricingSelection":"string","pricingPlan":"string","rewardsArrangementId":"string","tradeDate":"string","arrangementEffectiveDate":"string"}},"responses":{"200":"createOneYearBondResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"POST","path":"/holdings/deposits/threeYearBonds","fullPath":"/api/v1.0.0/holdings/deposits/threeYearBonds","operationId":"createThreeYearBond","name":"Creates a Three Year Bond/Deposit Account","summary":"Creates a Three Year Bond/Deposit Account","tags":[],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"partyIds":[{}],"partyRoles":[{}],"agentCustomerIds":[{}],"agentArrangementIds":[{}],"agentRoles":[{}],"arrangmentId":"string","productId":"string","activityId":"string","currency":"string","productVariation":"string","pricingSelection":"string","pricingPlan":"string","rewardsArrangementId":"string","tradeDate":"string","arrangementEffectiveDate":"string"}},"responses":{"200":"createThreeYearBondResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"POST","path":"/holdings/deposits/longTermDeposits","fullPath":"/api/v1.0.0/holdings/deposits/longTermDeposits","operationId":"createLongTermDeposit","name":"Creates a Long Term Deposit Account","summary":"Creates a Long Term Deposit Account","tags":[],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"partyIds":[{}],"partyRoles":[{}],"agentCustomerIds":[{}],"agentArrangementIds":[{}],"agentRoles":[{}],"arrangmentId":"string","productId":"string","activityId":"string","currency":"string","productVariation":"string","pricingSelection":"string","pricingPlan":"string","rewardsArrangementId":"string","tradeDate":"string","arrangementEffectiveDate":"string"}},"responses":{"200":"createLongTermDepositResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"POST","path":"/holdings/deposits/callDeposits","fullPath":"/api/v1.0.0/holdings/deposits/callDeposits","operationId":"createCallDeposit","name":"Create a call deposit Account","summary":"Create a call deposit Account (No term or period)","tags":[],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"partyIds":[{}],"partyRoles":[{}],"agentCustomerIds":[{}],"agentArrangementIds":[{}],"agentRoles":[{}],"arrangmentId":"string","productId":"string","activityId":"string","currency":"string","productVariation":"string","pricingSelection":"string","pricingPlan":"string","rewardsArrangementId":"string","tradeDate":"string","arrangementEffectiveDate":"string"}},"responses":{"200":"createCallDepositResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"POST","path":"/holdings/deposits/createDeposits","fullPath":"/api/v1.0.0/holdings/deposits/createDeposits","operationId":"createDeposits","name":"Create a Deposit Account-This API is deprecated and going forward the following URL has to be used.URL:/holdings/deposits/termDeposits","summary":"Create a Deposit Account","tags":[],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"partyIds":[{}],"partyRoles":[{}],"agentCustomerIds":[{}],"agentArrangementIds":[{}],"agentRoles":[{}],"arrangmentId":"string","productId":"string","activityId":"string","currency":"string","productVariation":"string","pricingSelection":"string","pricingPlan":"string","rewardsArrangementId":"string","tradeDate":"string","arrangementEffectiveDate":"string"}},"responses":{"200":"createDepositsResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"POST","path":"/holdings/deposits/mudarabaDeposits","fullPath":"/api/v1.0.0/holdings/deposits/mudarabaDeposits","operationId":"createMudarabaDeposit","name":"Create a Mudaraba deposit account","summary":"Create a Mudaraba deposit account","tags":[],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"partyIds":[{}],"partyRoles":[{}],"agentCustomerIds":[{}],"agentArrangementIds":[{}],"agentRoles":[{}],"arrangmentId":"string","productId":"string","activityId":"string","currency":"string","productVariation":"string","pricingSelection":"string","pricingPlan":"string","rewardsArrangementId":"string","tradeDate":"string","arrangementEffectiveDate":"string"}},"responses":{"200":"createMudarabaDepositResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"POST","path":"/holdings/deposits/redeemDeposits","fullPath":"/api/v1.0.0/holdings/deposits/redeemDeposits","operationId":"redeemDeposits","name":"Redeem a Deposit Account","summary":"Redeem a Deposit Account","tags":[],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"partyIds":[{}],"partyRoles":[{}],"agentCustomerIds":[{}],"agentArrangementIds":[{}],"agentRoles":[{}],"arrangmentId":"string","productId":"string","activityId":"string","currency":"string","productVariation":"string","pricingSelection":"string","pricingPlan":"string","rewardsArrangementId":"string","tradeDate":"string","arrangementEffectiveDate":"string"}},"responses":{"200":"redeemDepositsResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"POST","path":"/holdings/deposits/redeemDeposits/{arrangementId}","fullPath":"/api/v1.0.0/holdings/deposits/redeemDeposits/{arrangementId}","operationId":"simulateRedeemDeposits","name":"Simulate to Redeem a Deposit Account","summary":"Simulate to Redeem a Deposit Account","tags":[],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"arrangementId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"partyIds":[{}],"partyRoles":[{}],"agentCustomerIds":[{}],"agentArrangementIds":[{}],"agentRoles":[{}],"arrangmentId":"string","productId":"string","activityId":"string","currency":"string","productVariation":"string","pricingSelection":"string","pricingPlan":"string","rewardsArrangementId":"string","tradeDate":"string","arrangementEffectiveDate":"string"}},"responses":{"200":"simulateRedeemDepositsResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"GET","path":"/holdings/deposits/{arrangementId}/chargeAmount","fullPath":"/api/v1.0.0/holdings/deposits/{arrangementId}/chargeAmount","operationId":"getChargeAmount","name":"Retrieves the Charge amount for a given Charge Property","summary":"Retrieves the Charge amount for a given Charge Property","tags":[],"parameters":[{"name":"arrangementId","in":"path","type":"string","required":true,"description":"Indicates an unique identifier of an account"},{"name":"chargeProperty","in":"query","type":"string","required":true,"description":"Contains the charge name which is corresponding to the calculated charge amount"},{"name":"simulationReference","in":"query","type":"string","required":true,"description":"Indicates the Reference ID for simulation activity"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"ChargeAmountResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"POST","path":"/holdings/deposits/wakalaDeposits","fullPath":"/api/v1.0.0/holdings/deposits/wakalaDeposits","operationId":"createWakalaDeposit","name":"Create a Wakala deposit account","summary":"Create a Wakala deposit account","tags":[],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"partyIds":[{}],"partyRoles":[{}],"agentCustomerIds":[{}],"agentArrangementIds":[{}],"agentRoles":[{}],"arrangmentId":"string","productId":"string","activityId":"string","currency":"string","productVariation":"string","pricingSelection":"string","pricingPlan":"string","rewardsArrangementId":"string","tradeDate":"string","arrangementEffectiveDate":"string"}},"responses":{"200":"createWakalaDepositResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}}]},{"key":"holdings-deposits-arrangements-v2.0.0","title":"Deposit Arrangements","version":"v2.0.0","description":"The Arrangement Architecture is a Temenos Transact Framework to create and manage  various products such as Loans, Deposits, Accounts, etc. It provides a modular business component-based architecture, whereby users can create their Products by using the components provided by Temenos and these compo","endpointCount":13,"endpoints":[{"method":"POST","path":"/holdings/deposits/shortTermDeposits","fullPath":"/api/v2.0.0/holdings/deposits/shortTermDeposits","operationId":"createShortTermDeposit","name":"This can be used to create a short-term deposit and the payload should include customer identifier, customer role,  deposit currency, deposit amount, term, etc.","summary":"Create a Short Term Deposit Account","tags":[],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"partyIds":[{}],"partyRoles":[{}],"agentCustomerIds":[{}],"agentArrangementIds":[{}],"agentRoles":[{}],"arrangmentId":"string","productId":"string","activityId":"string","currency":"string","productVariation":"string","pricingSelection":"string","pricingPlan":"string","rewardsArrangementId":"string","tradeDate":"string","arrangementEffectiveDate":"string"}},"responses":{"200":"createShortTermDepositResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"POST","path":"/holdings/deposits/oneYearBonds","fullPath":"/api/v2.0.0/holdings/deposits/oneYearBonds","operationId":"createOneYearBond","name":"This can be used to create a one-year bond and the payload should include customer identifier, customer role,  bond currency, bond amount, etc.","summary":"Creates a One year Bond/Deposit Account","tags":[],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"partyIds":[{}],"partyRoles":[{}],"agentCustomerIds":[{}],"agentArrangementIds":[{}],"agentRoles":[{}],"arrangmentId":"string","productId":"string","activityId":"string","currency":"string","productVariation":"string","pricingSelection":"string","pricingPlan":"string","rewardsArrangementId":"string","tradeDate":"string","arrangementEffectiveDate":"string"}},"responses":{"200":"createOneYearBondResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"POST","path":"/holdings/deposits/threeYearBonds","fullPath":"/api/v2.0.0/holdings/deposits/threeYearBonds","operationId":"createThreeYearBond","name":"This can be used to create a three-year bond and the payload should include customer identifier, customer role,  bond currency, bond amount, etc.","summary":"Creates a Three Year Bond/Deposit Account","tags":[],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"partyIds":[{}],"partyRoles":[{}],"agentCustomerIds":[{}],"agentArrangementIds":[{}],"agentRoles":[{}],"arrangmentId":"string","productId":"string","activityId":"string","currency":"string","productVariation":"string","pricingSelection":"string","pricingPlan":"string","rewardsArrangementId":"string","tradeDate":"string","arrangementEffectiveDate":"string"}},"responses":{"200":"createThreeYearBondResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"POST","path":"/holdings/deposits/longTermDeposits","fullPath":"/api/v2.0.0/holdings/deposits/longTermDeposits","operationId":"createLongTermDeposit","name":"This can be used to create long-term deposits and the payload should include customer identifier, customer role,  deposit currency, deposit amount, term, etc.","summary":"Creates a Long Term Deposit Account","tags":[],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"partyIds":[{}],"partyRoles":[{}],"agentCustomerIds":[{}],"agentArrangementIds":[{}],"agentRoles":[{}],"arrangmentId":"string","productId":"string","activityId":"string","currency":"string","productVariation":"string","pricingSelection":"string","pricingPlan":"string","rewardsArrangementId":"string","tradeDate":"string","arrangementEffectiveDate":"string"}},"responses":{"200":"createLongTermDepositResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"POST","path":"/holdings/deposits/callDeposits","fullPath":"/api/v2.0.0/holdings/deposits/callDeposits","operationId":"createCallDeposit","name":"This can be used to create call deposits which have no fixed term or maturity period and the payload should include the customer identifier, customer role,  deposit currency, deposit amount, etc.","summary":"Create a call deposit Account (No term or period)","tags":[],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"partyIds":[{}],"partyRoles":[{}],"agentCustomerIds":[{}],"agentArrangementIds":[{}],"agentRoles":[{}],"arrangmentId":"string","productId":"string","activityId":"string","currency":"string","productVariation":"string","pricingSelection":"string","pricingPlan":"string","rewardsArrangementId":"string","tradeDate":"string","arrangementEffectiveDate":"string"}},"responses":{"200":"createCallDepositResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"POST","path":"/holdings/deposits/termDeposits","fullPath":"/api/v2.0.0/holdings/deposits/termDeposits","operationId":"createDeposits","name":"This can be used to create term deposits and the payload should include customer identifier, customer role,  deposit currency, deposit amount and the deposit duration term etc.","summary":"Create a Deposit Account","tags":[],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"partyIds":[{}],"partyRoles":[{}],"agentCustomerIds":[{}],"agentArrangementIds":[{}],"agentRoles":[{}],"arrangmentId":"string","productId":"string","activityId":"string","currency":"string","productVariation":"string","pricingSelection":"string","pricingPlan":"string","rewardsArrangementId":"string","tradeDate":"string","arrangementEffectiveDate":"string"}},"responses":{"200":"createDepositsResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"POST","path":"/holdings/deposits/mudarabaDeposits","fullPath":"/api/v2.0.0/holdings/deposits/mudarabaDeposits","operationId":"createMudarabaDeposit","name":"This can be used to create Islamic mudarba deposits and the payload should include customer identifier, customer role,  deposit currency, deposit amount,term etc.","summary":"Create a Mudaraba deposit account","tags":[],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"partyIds":[{}],"partyRoles":[{}],"agentCustomerIds":[{}],"agentArrangementIds":[{}],"agentRoles":[{}],"arrangmentId":"string","productId":"string","activityId":"string","currency":"string","productVariation":"string","pricingSelection":"string","pricingPlan":"string","rewardsArrangementId":"string","tradeDate":"string","arrangementEffectiveDate":"string"}},"responses":{"200":"createMudarabaDepositResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"POST","path":"/holdings/deposits/redeemDeposits","fullPath":"/api/v2.0.0/holdings/deposits/redeemDeposits","operationId":"redeemDeposits","name":"This can be used to redeem deposits and the payload to redeem should include the settlement instructions to which the deposit amount is to be credited. Common usage of this is when customers want to withdraw their deposits before the actual  maturity date of the deposits.","summary":"Redeem a Deposit","tags":[],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"partyIds":[{}],"partyRoles":[{}],"agentCustomerIds":[{}],"agentArrangementIds":[{}],"agentRoles":[{}],"arrangmentId":"string","productId":"string","activityId":"string","currency":"string","productVariation":"string","pricingSelection":"string","pricingPlan":"string","rewardsArrangementId":"string","tradeDate":"string","arrangementEffectiveDate":"string"}},"responses":{"200":"redeemDepositsResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"POST","path":"/holdings/deposits/redeemDeposits/{arrangementId}","fullPath":"/api/v2.0.0/holdings/deposits/redeemDeposits/{arrangementId}","operationId":"simulateRedeemDeposits","name":"This can be used to simulate a deposit redemption and the payload should include the settlement instructions to which the deposit amount is to be credited. Common usage of this is for simulating withdrawals when customers want to withdraw their deposits before the actual fixed maturity date of the deposits.","summary":"Simulate a Deposit redemption","tags":[],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"arrangementId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"partyIds":[{}],"partyRoles":[{}],"agentCustomerIds":[{}],"agentArrangementIds":[{}],"agentRoles":[{}],"arrangmentId":"string","productId":"string","activityId":"string","currency":"string","productVariation":"string","pricingSelection":"string","pricingPlan":"string","rewardsArrangementId":"string","tradeDate":"string","arrangementEffectiveDate":"string"}},"responses":{"200":"simulateRedeemDepositsResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"GET","path":"/holdings/deposits/{arrangementId}/chargeAmount","fullPath":"/api/v2.0.0/holdings/deposits/{arrangementId}/chargeAmount","operationId":"getChargeAmount","name":"Retrieves the charge amount for a given charge property and its payload includes charge identifier, simulation reference, etc.","summary":"Retrieves the charge amount for a given charge property","tags":[],"parameters":[{"name":"arrangementId","in":"path","type":"string","required":true,"description":"Indicates an unique identifier of an account"},{"name":"chargeProperty","in":"query","type":"string","required":true,"description":"Contains the charge name which is corresponding to the calculated charge amount"},{"name":"simulationReference","in":"query","type":"string","required":true,"description":"Indicates the Reference ID for simulation activity"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from t24 on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"ChargeAmountResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"POST","path":"/holdings/deposits/wakalaDeposits","fullPath":"/api/v2.0.0/holdings/deposits/wakalaDeposits","operationId":"createWakalaDeposit","name":"This can be used to create Islamic wakala  deposits and the payload should include customer identifier, customer role,  deposit currency, deposit amount and the fixed term of the deposit etc.","summary":"Create a Wakala deposit account","tags":[],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"partyIds":[{}],"partyRoles":[{}],"agentCustomerIds":[{}],"agentArrangementIds":[{}],"agentRoles":[{}],"arrangmentId":"string","productId":"string","activityId":"string","currency":"string","productVariation":"string","pricingSelection":"string","pricingPlan":"string","rewardsArrangementId":"string","tradeDate":"string","arrangementEffectiveDate":"string"}},"responses":{"200":"createWakalaDepositResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"GET","path":"/holdings/deposits/{depositId}","fullPath":"/api/v2.0.0/holdings/deposits/{depositId}","operationId":"getDepositDetails","name":"Retrieves the basic information of the deposit account including deposit amount, term, maturity days, tax details, charge details, etc. Common usage of this could be to display the basic information of deposits in a Customer user interface.","summary":"Retrieves the deposit details","tags":[],"parameters":[{"name":"depositId","in":"path","type":"string","required":true,"description":"Indicates the Id of the deposit account"},{"name":"balanceTypes","in":"query","type":"string","required":false,"description":"Type of balance (e.g. current balance, credit interest accrued, deferred commission, etc.) as defined in the institution's accounting schemas."},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from t24 on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"DepositDetailsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/deposits/{depositId}/redemptions/bills","fullPath":"/api/v2.0.0/holdings/deposits/{depositId}/redemptions/bills","operationId":"getRedeemDepositBillDetails","name":"Retrieves the redeem bill for the given deposit by providing the deposit reference and simulation reference for simulated deposits","summary":"Retrieves the redeem bill for the given deposit","tags":["RETAIL"],"parameters":[{"name":"depositId","in":"path","type":"string","required":true,"description":"Indicates the Id of the deposit account"},{"name":"simulationReference","in":"query","type":"string","required":false,"description":"Indicates the reference id for simulation activity"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"RedeemDepositBillDetailsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}}]},{"key":"holdings-deposits-arrangements-v3.0.0","title":"Deposit Arrangements","version":"v3.0.0","description":"The Arrangement Architecture is a Temenos Transact Framework to create and manage  various products such as Loans, Deposits, Accounts, etc. It provides a modular business component-based architecture, whereby users can create their Products by using the components provided by Temenos and these compo","endpointCount":15,"endpoints":[{"method":"POST","path":"/holdings/deposits/shortTermDeposits","fullPath":"/api/v3.0.0/holdings/deposits/shortTermDeposits","operationId":"createShortTermDeposit","name":"This can be used to create a short-term deposit and the payload should include customer identifier, customer role,  deposit currency, deposit amount, term, etc.","summary":"Create a short term deposit acount","tags":[],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"partyIds":[{}],"partyRoles":[{}],"agentCustomerIds":[{}],"agentArrangementIds":[{}],"agentRoles":[{}],"arrangmentId":"string","productId":"string","activityId":"string","currency":"string","productVariation":"string","pricingSelection":"string","pricingPlan":"string","rewardsArrangementId":"string","tradeDate":"string","arrangementEffectiveDate":"string"}},"responses":{"200":"createShortTermDepositResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"POST","path":"/holdings/deposits/oneYearBonds","fullPath":"/api/v3.0.0/holdings/deposits/oneYearBonds","operationId":"createOneYearBond","name":"This can be used to create a one-year bond and the payload should include customer identifier, customer role,  bond currency, bond amount, etc.","summary":"Creates a one year bond/deposit account","tags":[],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"partyIds":[{}],"partyRoles":[{}],"agentCustomerIds":[{}],"agentArrangementIds":[{}],"agentRoles":[{}],"arrangmentId":"string","productId":"string","activityId":"string","currency":"string","productVariation":"string","pricingSelection":"string","pricingPlan":"string","rewardsArrangementId":"string","tradeDate":"string","arrangementEffectiveDate":"string"}},"responses":{"200":"createOneYearBondResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"POST","path":"/holdings/deposits/threeYearBonds","fullPath":"/api/v3.0.0/holdings/deposits/threeYearBonds","operationId":"createThreeYearBond","name":"This can be used to create a three-year bond and the payload should include customer identifier, customer role,  bond currency, bond amount, etc.","summary":"Creates a three year bond/deposit account","tags":[],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"partyIds":[{}],"partyRoles":[{}],"agentCustomerIds":[{}],"agentArrangementIds":[{}],"agentRoles":[{}],"arrangmentId":"string","productId":"string","activityId":"string","currency":"string","productVariation":"string","pricingSelection":"string","pricingPlan":"string","rewardsArrangementId":"string","tradeDate":"string","arrangementEffectiveDate":"string"}},"responses":{"200":"createThreeYearBondResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"POST","path":"/holdings/deposits/longTermDeposits","fullPath":"/api/v3.0.0/holdings/deposits/longTermDeposits","operationId":"createLongTermDeposit","name":"This can be used to create long-term deposits and the payload should include customer identifier, customer role,  deposit currency, deposit amount, term, etc.","summary":"Creates a long term deposit account","tags":[],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"partyIds":[{}],"partyRoles":[{}],"agentCustomerIds":[{}],"agentArrangementIds":[{}],"agentRoles":[{}],"arrangmentId":"string","productId":"string","activityId":"string","currency":"string","productVariation":"string","pricingSelection":"string","pricingPlan":"string","rewardsArrangementId":"string","tradeDate":"string","arrangementEffectiveDate":"string"}},"responses":{"200":"createLongTermDepositResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"POST","path":"/holdings/deposits/callDeposits","fullPath":"/api/v3.0.0/holdings/deposits/callDeposits","operationId":"createCallDeposit","name":"This can be used to create call deposits which have no fixed term or maturity period and the payload should include the customer identifier, customer role,  deposit currency, deposit amount, etc.","summary":"Create a call deposit account (No term or period)","tags":[],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"partyIds":[{}],"partyRoles":[{}],"agentCustomerIds":[{}],"agentArrangementIds":[{}],"agentRoles":[{}],"arrangmentId":"string","productId":"string","activityId":"string","currency":"string","productVariation":"string","pricingSelection":"string","pricingPlan":"string","rewardsArrangementId":"string","tradeDate":"string","arrangementEffectiveDate":"string"}},"responses":{"200":"createCallDepositResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"POST","path":"/holdings/deposits/termDeposits","fullPath":"/api/v3.0.0/holdings/deposits/termDeposits","operationId":"createDeposits","name":"This can be used to create term deposits and the payload should include customer identifier, customer role,  deposit currency, deposit amount and the deposit duration term etc.","summary":"Create a deposit account","tags":[],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"partyIds":[{}],"partyRoles":[{}],"agentCustomerIds":[{}],"agentArrangementIds":[{}],"agentRoles":[{}],"arrangmentId":"string","productId":"string","activityId":"string","currency":"string","productVariation":"string","pricingSelection":"string","pricingPlan":"string","rewardsArrangementId":"string","tradeDate":"string","arrangementEffectiveDate":"string"}},"responses":{"200":"createDepositsResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"POST","path":"/holdings/deposits/mudarabaDeposits","fullPath":"/api/v3.0.0/holdings/deposits/mudarabaDeposits","operationId":"createMudarabaDeposit","name":"This can be used to create Islamic mudarba deposits and the payload should include customer identifier, customer role,  deposit currency, deposit amount,term etc.","summary":"Create a mudaraba deposit account","tags":[],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"partyIds":[{}],"partyRoles":[{}],"agentCustomerIds":[{}],"agentArrangementIds":[{}],"agentRoles":[{}],"arrangmentId":"string","productId":"string","activityId":"string","currency":"string","productVariation":"string","pricingSelection":"string","pricingPlan":"string","rewardsArrangementId":"string","tradeDate":"string","arrangementEffectiveDate":"string"}},"responses":{"200":"createMudarabaDepositResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"POST","path":"/holdings/deposits/redeemDeposits","fullPath":"/api/v3.0.0/holdings/deposits/redeemDeposits","operationId":"redeemDeposits","name":"This can be used to redeem deposits and the payload to redeem should include the settlement instructions to which the deposit amount is to be credited. Common usage of this is when customers want to withdraw their deposits before the actual  maturity date of the deposits.","summary":"Redeem a deposit","tags":[],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"partyIds":[{}],"partyRoles":[{}],"agentCustomerIds":[{}],"agentArrangementIds":[{}],"agentRoles":[{}],"arrangmentId":"string","productId":"string","activityId":"string","currency":"string","productVariation":"string","pricingSelection":"string","pricingPlan":"string","rewardsArrangementId":"string","tradeDate":"string","arrangementEffectiveDate":"string"}},"responses":{"200":"redeemDepositsResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"POST","path":"/holdings/deposits/redeemDeposits/{arrangementId}","fullPath":"/api/v3.0.0/holdings/deposits/redeemDeposits/{arrangementId}","operationId":"simulateRedeemDeposits","name":"This can be used to simulate a deposit redemption and the payload should include the settlement instructions to which the deposit amount is to be credited. Common usage of this is for simulating withdrawals when customers want to withdraw their deposits before the actual fixed maturity date of the deposits.","summary":"Simulate a deposit redemption","tags":[],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"arrangementId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"partyIds":[{}],"partyRoles":[{}],"agentCustomerIds":[{}],"agentArrangementIds":[{}],"agentRoles":[{}],"arrangmentId":"string","productId":"string","activityId":"string","currency":"string","productVariation":"string","pricingSelection":"string","pricingPlan":"string","rewardsArrangementId":"string","tradeDate":"string","arrangementEffectiveDate":"string"}},"responses":{"200":"simulateRedeemDepositsResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"GET","path":"/holdings/deposits/{arrangementId}/chargeAmount","fullPath":"/api/v3.0.0/holdings/deposits/{arrangementId}/chargeAmount","operationId":"getChargeAmount","name":"Retrieves the charge amount for a given charge property and its payload includes charge identifier, simulation reference, etc.","summary":"Retrieves the charge amount for a given charge property","tags":[],"parameters":[{"name":"arrangementId","in":"path","type":"string","required":true,"description":"Indicates an unique identifier of an account"},{"name":"chargeProperty","in":"query","type":"string","required":true,"description":"Contains the charge name which is corresponding to the calculated charge amount"},{"name":"simulationReference","in":"query","type":"string","required":true,"description":"Indicates the Reference ID for simulation activity"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from t24 on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"ChargeAmountResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"POST","path":"/holdings/deposits/wakalaDeposits","fullPath":"/api/v3.0.0/holdings/deposits/wakalaDeposits","operationId":"createWakalaDeposit","name":"This can be used to create Islamic wakala  deposits and the payload should include customer identifier, customer role,  deposit currency, deposit amount and the fixed term of the deposit etc.","summary":"Create a wakala deposit account","tags":[],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"partyIds":[{}],"partyRoles":[{}],"agentCustomerIds":[{}],"agentArrangementIds":[{}],"agentRoles":[{}],"arrangmentId":"string","productId":"string","activityId":"string","currency":"string","productVariation":"string","pricingSelection":"string","pricingPlan":"string","rewardsArrangementId":"string","tradeDate":"string","arrangementEffectiveDate":"string"}},"responses":{"200":"createWakalaDepositResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"GET","path":"/holdings/deposits/{depositId}","fullPath":"/api/v3.0.0/holdings/deposits/{depositId}","operationId":"getDepositDetails","name":"Retrieves the basic information of the deposit account including deposit amount, term, maturity days, tax details, charge details, etc. Common usage of this could be to display the basic information of deposits in a customer user interface.","summary":"Retrieves the deposit details","tags":[],"parameters":[{"name":"depositId","in":"path","type":"string","required":true,"description":"Indicates the Id of the deposit account"},{"name":"balanceTypes","in":"query","type":"string","required":false,"description":"Type of balance (e.g. current balance, credit interest accrued, deferred commission, etc.) as defined in the institution's accounting schemas."},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from t24 on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"DepositDetailsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/deposits/{depositId}/redemptions/bills","fullPath":"/api/v3.0.0/holdings/deposits/{depositId}/redemptions/bills","operationId":"getRedeemDepositBillDetails","name":"Retrieves the redeem bill for the given deposit by providing the deposit reference and simulation reference for simulated deposits","summary":"Retrieves the redeem bill for the given deposit","tags":["RETAIL"],"parameters":[{"name":"depositId","in":"path","type":"string","required":true,"description":"Indicates the Id of the deposit account"},{"name":"simulationReference","in":"query","type":"string","required":false,"description":"Indicates the reference id for simulation activity"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"RedeemDepositBillDetailsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"POST","path":"/holdings/deposits/simulations","fullPath":"/api/v3.0.0/holdings/deposits/simulations","operationId":"createDepositSimulation","name":"This can be used to create a simulation for deposit product and the payload should include customer identifier, currency, etc.","summary":"Create simulation for deposit products","tags":["RETAIL"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"customerIds":[{}],"properties":[{}],"overrides":[{}],"productId":"string","masterArrangementId":"string","roleName":"string","currencyId":"string","effectiveDate":"2024-01-01","activityId":"string","transactionAmount":0.0,"reason":"string","automaticRun":"string","simulationRunReference":"string","synchronous":"string","account":[{}]}},"responses":{"200":"createDepositSimulationResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"PUT","path":"/holdings/deposits/simulations/{simulationId}","fullPath":"/api/v3.0.0/holdings/deposits/simulations/{simulationId}","operationId":"updateDepositSimulation","name":"This can be used to amend a simulation for deposit product and the payload should include customer identifier, currency, etc.","summary":"Amend simulation for deposit products","tags":["RETAIL"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"simulationId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"customerIds":[{}],"properties":[{}],"overrides":[{}],"productId":"string","masterArrangementId":"string","roleName":"string","currencyId":"string","effectiveDate":"2024-01-01","activityId":"string","transactionAmount":0.0,"reason":"string","automaticRun":"string","simulationRunReference":"string","synchronous":"string","account":[{}]}},"responses":{"200":"updateDepositSimulationResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}}]},{"key":"holdings-deposits-arrangements-v4.0.0","title":"Deposit Arrangements","version":"v4.0.0","description":"The Arrangement Architecture is a Temenos Transact Framework to create and manage  various products such as Loans, Deposits, Accounts, etc. It provides a modular business component-based architecture, whereby users can create their Products by using the components provided by Temenos and these compo","endpointCount":15,"endpoints":[{"method":"POST","path":"/holdings/deposits/shortTermDeposits","fullPath":"/api/v4.0.0/holdings/deposits/shortTermDeposits","operationId":"createShortTermDeposit","name":"This can be used to create a short-term deposit and the payload should include customer identifier, customer role,  deposit currency, deposit amount, term, etc.","summary":"Create a short term deposit acount","tags":[],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"partyIds":[{}],"partyRoles":[{}],"agentCustomerIds":[{}],"agentArrangementIds":[{}],"agentRoles":[{}],"arrangmentId":"string","productId":"string","activityId":"string","currency":"string","productVariation":"string","pricingSelection":"string","pricingPlan":"string","rewardsArrangementId":"string","tradeDate":"string","arrangementEffectiveDate":"string"}},"responses":{"200":"createShortTermDepositResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"POST","path":"/holdings/deposits/oneYearBonds","fullPath":"/api/v4.0.0/holdings/deposits/oneYearBonds","operationId":"createOneYearBond","name":"This can be used to create a one-year bond and the payload should include customer identifier, customer role,  bond currency, bond amount, etc.","summary":"Creates a one year bond/deposit account","tags":[],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"partyIds":[{}],"partyRoles":[{}],"agentCustomerIds":[{}],"agentArrangementIds":[{}],"agentRoles":[{}],"arrangmentId":"string","productId":"string","activityId":"string","currency":"string","productVariation":"string","pricingSelection":"string","pricingPlan":"string","rewardsArrangementId":"string","tradeDate":"string","arrangementEffectiveDate":"string"}},"responses":{"200":"createOneYearBondResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"POST","path":"/holdings/deposits/threeYearBonds","fullPath":"/api/v4.0.0/holdings/deposits/threeYearBonds","operationId":"createThreeYearBond","name":"This can be used to create a three-year bond and the payload should include customer identifier, customer role,  bond currency, bond amount, etc.","summary":"Creates a three year bond/deposit account","tags":[],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"partyIds":[{}],"partyRoles":[{}],"agentCustomerIds":[{}],"agentArrangementIds":[{}],"agentRoles":[{}],"arrangmentId":"string","productId":"string","activityId":"string","currency":"string","productVariation":"string","pricingSelection":"string","pricingPlan":"string","rewardsArrangementId":"string","tradeDate":"string","arrangementEffectiveDate":"string"}},"responses":{"200":"createThreeYearBondResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"POST","path":"/holdings/deposits/longTermDeposits","fullPath":"/api/v4.0.0/holdings/deposits/longTermDeposits","operationId":"createLongTermDeposit","name":"This can be used to create long-term deposits and the payload should include customer identifier, customer role,  deposit currency, deposit amount, term, etc.","summary":"Creates a long term deposit account","tags":[],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"partyIds":[{}],"partyRoles":[{}],"agentCustomerIds":[{}],"agentArrangementIds":[{}],"agentRoles":[{}],"arrangmentId":"string","productId":"string","activityId":"string","currency":"string","productVariation":"string","pricingSelection":"string","pricingPlan":"string","rewardsArrangementId":"string","tradeDate":"string","arrangementEffectiveDate":"string"}},"responses":{"200":"createLongTermDepositResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"POST","path":"/holdings/deposits/callDeposits","fullPath":"/api/v4.0.0/holdings/deposits/callDeposits","operationId":"createCallDeposit","name":"This can be used to create call deposits which have no fixed term or maturity period and the payload should include the customer identifier, customer role,  deposit currency, deposit amount, etc.","summary":"Create a call deposit account (No term or period)","tags":[],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"partyIds":[{}],"partyRoles":[{}],"agentCustomerIds":[{}],"agentArrangementIds":[{}],"agentRoles":[{}],"arrangmentId":"string","productId":"string","activityId":"string","currency":"string","productVariation":"string","pricingSelection":"string","pricingPlan":"string","rewardsArrangementId":"string","tradeDate":"string","arrangementEffectiveDate":"string"}},"responses":{"200":"createCallDepositResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"POST","path":"/holdings/deposits/termDeposits","fullPath":"/api/v4.0.0/holdings/deposits/termDeposits","operationId":"createDeposits","name":"This can be used to create term deposits and the payload should include customer identifier, customer role,  deposit currency, deposit amount and the deposit duration term etc.","summary":"Create a deposit account","tags":[],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"partyIds":[{}],"partyRoles":[{}],"agentCustomerIds":[{}],"agentArrangementIds":[{}],"agentRoles":[{}],"arrangmentId":"string","productId":"string","activityId":"string","currency":"string","productVariation":"string","pricingSelection":"string","pricingPlan":"string","rewardsArrangementId":"string","tradeDate":"string","arrangementEffectiveDate":"string"}},"responses":{"200":"createDepositsResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"POST","path":"/holdings/deposits/mudarabaDeposits","fullPath":"/api/v4.0.0/holdings/deposits/mudarabaDeposits","operationId":"createMudarabaDeposit","name":"This can be used to create Islamic mudarba deposits and the payload should include customer identifier, customer role,  deposit currency, deposit amount,term etc.","summary":"Create a mudaraba deposit account","tags":[],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"partyIds":[{}],"partyRoles":[{}],"agentCustomerIds":[{}],"agentArrangementIds":[{}],"agentRoles":[{}],"arrangmentId":"string","productId":"string","activityId":"string","currency":"string","productVariation":"string","pricingSelection":"string","pricingPlan":"string","rewardsArrangementId":"string","tradeDate":"string","arrangementEffectiveDate":"string"}},"responses":{"200":"createMudarabaDepositResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"POST","path":"/holdings/deposits/redeemDeposits","fullPath":"/api/v4.0.0/holdings/deposits/redeemDeposits","operationId":"redeemDeposits","name":"This can be used to redeem deposits and the payload to redeem should include the settlement instructions to which the deposit amount is to be credited. Common usage of this is when customers want to withdraw their deposits before the actual  maturity date of the deposits.","summary":"Redeem a deposit","tags":[],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"partyIds":[{}],"partyRoles":[{}],"agentCustomerIds":[{}],"agentArrangementIds":[{}],"agentRoles":[{}],"arrangmentId":"string","productId":"string","activityId":"string","currency":"string","productVariation":"string","pricingSelection":"string","pricingPlan":"string","rewardsArrangementId":"string","tradeDate":"string","arrangementEffectiveDate":"string"}},"responses":{"200":"redeemDepositsResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"POST","path":"/holdings/deposits/redeemDeposits/{arrangementId}","fullPath":"/api/v4.0.0/holdings/deposits/redeemDeposits/{arrangementId}","operationId":"simulateRedeemDeposits","name":"This can be used to simulate a deposit redemption and the payload should include the settlement instructions to which the deposit amount is to be credited. Common usage of this is for simulating withdrawals when customers want to withdraw their deposits before the actual fixed maturity date of the deposits.","summary":"Simulate a deposit redemption","tags":[],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"arrangementId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"partyIds":[{}],"partyRoles":[{}],"agentCustomerIds":[{}],"agentArrangementIds":[{}],"agentRoles":[{}],"arrangmentId":"string","productId":"string","activityId":"string","currency":"string","productVariation":"string","pricingSelection":"string","pricingPlan":"string","rewardsArrangementId":"string","tradeDate":"string","arrangementEffectiveDate":"string"}},"responses":{"200":"simulateRedeemDepositsResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"GET","path":"/holdings/deposits/{arrangementId}/chargeAmount","fullPath":"/api/v4.0.0/holdings/deposits/{arrangementId}/chargeAmount","operationId":"getChargeAmount","name":"Retrieves the charge amount for a given charge property and its payload includes charge identifier, simulation reference, etc.","summary":"Retrieves the charge amount for a given charge property","tags":[],"parameters":[{"name":"arrangementId","in":"path","type":"string","required":true,"description":"Indicates an unique identifier of an account"},{"name":"chargeProperty","in":"query","type":"string","required":true,"description":"Contains the charge name which is corresponding to the calculated charge amount"},{"name":"simulationReference","in":"query","type":"string","required":true,"description":"Indicates the Reference ID for simulation activity"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from t24 on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"ChargeAmountResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"POST","path":"/holdings/deposits/wakalaDeposits","fullPath":"/api/v4.0.0/holdings/deposits/wakalaDeposits","operationId":"createWakalaDeposit","name":"This can be used to create Islamic wakala  deposits and the payload should include customer identifier, customer role,  deposit currency, deposit amount and the fixed term of the deposit etc.","summary":"Create a wakala deposit account","tags":[],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"partyIds":[{}],"partyRoles":[{}],"agentCustomerIds":[{}],"agentArrangementIds":[{}],"agentRoles":[{}],"arrangmentId":"string","productId":"string","activityId":"string","currency":"string","productVariation":"string","pricingSelection":"string","pricingPlan":"string","rewardsArrangementId":"string","tradeDate":"string","arrangementEffectiveDate":"string"}},"responses":{"200":"createWakalaDepositResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"GET","path":"/holdings/deposits/{depositId}","fullPath":"/api/v4.0.0/holdings/deposits/{depositId}","operationId":"getDepositDetails","name":"Retrieves the basic information of the deposit account including deposit amount, term, maturity days, tax details, charge details, etc. Common usage of this could be to display the basic information of deposits in a customer user interface.","summary":"Retrieves the deposit details","tags":[],"parameters":[{"name":"depositId","in":"path","type":"string","required":true,"description":"Indicates the Id of the deposit account"},{"name":"balanceTypes","in":"query","type":"string","required":false,"description":"Type of balance (e.g. current balance, credit interest accrued, deferred commission, etc.) as defined in the institution's accounting schemas."},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from t24 on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"DepositDetailsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/deposits/{depositId}/redemptions/bills","fullPath":"/api/v4.0.0/holdings/deposits/{depositId}/redemptions/bills","operationId":"getRedeemDepositBillDetails","name":"Retrieves the redeem bill for the given deposit by providing the deposit reference and simulation reference for simulated deposits","summary":"Retrieves the redeem bill for the given deposit","tags":["RETAIL"],"parameters":[{"name":"depositId","in":"path","type":"string","required":true,"description":"Indicates the Id of the deposit account"},{"name":"simulationReference","in":"query","type":"string","required":false,"description":"Indicates the reference id for simulation activity"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"RedeemDepositBillDetailsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"POST","path":"/holdings/deposits/simulations","fullPath":"/api/v4.0.0/holdings/deposits/simulations","operationId":"createDepositSimulation","name":"This can be used to create a simulation for deposit product and the payload should include customer identifier, currency, etc.","summary":"Create simulation for deposit products","tags":["RETAIL"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"customerIds":[{}],"properties":[{}],"overrides":[{}],"productId":"string","masterArrangementId":"string","roleName":"string","currencyId":"string","effectiveDate":"2024-01-01","activityId":"string","transactionAmount":0.0,"reason":"string","automaticRun":"string","simulationRunReference":"string","synchronous":"string","account":[{}]}},"responses":{"200":"createDepositSimulationResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"PUT","path":"/holdings/deposits/simulations/{simulationId}","fullPath":"/api/v4.0.0/holdings/deposits/simulations/{simulationId}","operationId":"updateDepositSimulation","name":"This can be used to amend a simulation for deposit product and the payload should include customer identifier, currency, etc.","summary":"Amend simulation for deposit products","tags":["RETAIL"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"simulationId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"customerIds":[{}],"properties":[{}],"overrides":[{}],"productId":"string","masterArrangementId":"string","roleName":"string","currencyId":"string","effectiveDate":"2024-01-01","activityId":"string","transactionAmount":0.0,"reason":"string","automaticRun":"string","simulationRunReference":"string","synchronous":"string","account":[{}]}},"responses":{"200":"updateDepositSimulationResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}}]},{"key":"holdings-deposits-arrangements-v5.0.0","title":"Deposit Arrangements","version":"v5.0.0","description":"The Arrangement Architecture is a Temenos Transact Framework to create and manage  various products such as Loans, Deposits, Accounts, etc. It provides a modular business component-based architecture, whereby users can create their Products by using the components provided by Temenos and these compo","endpointCount":35,"endpoints":[{"method":"PUT","path":"/holdings/deposits/{depositId}/branches","fullPath":"/api/v5.0.0/holdings/deposits/{depositId}/branches","operationId":"updateDepositBranch","name":"Change of branch for the deposit","summary":"Change of branch for the deposit","tags":["RETAIL"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"depositId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"effectiveDate":"2024-01-01","branch":"string","extensions":{}}},"responses":{"200":"updateDepositBranchResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"PUT","path":"/holdings/deposits/{depositId}/commitments","fullPath":"/api/v5.0.0/holdings/deposits/{depositId}/commitments","operationId":"updateTenure","name":"Update the tenure of the term deposit by providing tenure or maturity date","summary":"Update the tenure of the term amount","tags":["RETAIL"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"depositId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"productId":"string","drawdownDate":"2024-01-01","extensions":{},"commitment":[{}]}},"responses":{"200":"updateTenureResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"POST","path":"/holdings/deposits/termDeposits","fullPath":"/api/v5.0.0/holdings/deposits/termDeposits","operationId":"createDeposits","name":"This can be used to create term deposits and the payload should include customer identifier, customer role,  deposit currency, deposit amount and the deposit duration term etc.","summary":"Create a deposit account","tags":["RETAIL"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"partyIds":[{}],"partyRoles":[{}],"agentCustomerIds":[{}],"agentArrangementIds":[{}],"agentRoles":[{}],"arrangmentId":"string","productId":"string","activityId":"string","currency":"string","productVariation":"string","pricingSelection":"string","pricingPlan":"string","rewardsArrangementId":"string","tradeDate":"string","arrangementEffectiveDate":"string"}},"responses":{"200":"createDepositsResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"PUT","path":"/holdings/deposits/{depositId}/withdrawals","fullPath":"/api/v5.0.0/holdings/deposits/{depositId}/withdrawals","operationId":"withdrawDeposits","name":"Withdraw from the deposit account","summary":"Withdraw from the amount by providing the withdrawal amount","tags":["RETAIL"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"depositId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"partyIds":[{}],"partyRoles":[{}],"agentCustomerIds":[{}],"agentArrangementIds":[{}],"agentRoles":[{}],"arrangmentId":"string","productId":"string","activityId":"string","currency":"string","productVariation":"string","pricingSelection":"string","pricingPlan":"string","rewardsArrangementId":"string","tradeDate":"string","arrangementEffectiveDate":"string"}},"responses":{"200":"withdrawDepositsResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"PUT","path":"/holdings/deposits/{depositId}/renegotiations","fullPath":"/api/v5.0.0/holdings/deposits/{depositId}/renegotiations","operationId":"updateDepositConditions","name":"Perform the renegotiation of the term deposit contract details such as payment frequency, interest rates, etc.","summary":"Renegotiation of the term deposit contract details","tags":["RETAIL"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"depositId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"productId":"string","drawdownDate":"2024-01-01","extensions":{},"account":[{}],"customer":[{}],"schedule":[{}],"settlement":[{}],"commitment":[{}]}},"responses":{"200":"updateDepositConditionsResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"PUT","path":"/holdings/deposits/{depositId}/redemptions","fullPath":"/api/v5.0.0/holdings/deposits/{depositId}/redemptions","operationId":"redeemDeposit","name":"Redeem the term deposit to close the deposit by providing the settlement instructions","summary":"Redeem the term deposit to close the deposit","tags":["RETAIL"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"depositId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"effectiveDate":"2024-01-01"}},"responses":{"200":"RedemptionsDepositResponse","default":"RedemptionsArrangementErrorResponse","400":"RedemptionsBusinessArrangementErrorResponse","500":"RedemptionsSystemArrangementErrorResponse"}},{"method":"POST","path":"/holdings/deposits/simulations","fullPath":"/api/v5.0.0/holdings/deposits/simulations","operationId":"simulateNewdeposit","name":"Simulate a deposit Arrangement for the given principal amount, term, payment frequency and interest rates","summary":"Simulate a deposit Arrangement for the given principal amount, term, payment frequency and interest rates","tags":["RETAIL"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"customerIds":[{}],"properties":[{}],"overrides":[{}],"productId":"string","masterArrangementId":"string","roleName":"string","currencyId":"string","effectiveDate":"2024-01-01","activityId":"string","transactionAmount":0.0,"reason":"string","simulationRunReference":"string","extensions":{},"account":[{}],"customer":[{}]}},"responses":{"200":"simulateNewdepositResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"POST","path":"/holdings/deposits/migrations","fullPath":"/api/v5.0.0/holdings/deposits/migrations","operationId":"initiateDepositsMigration","name":"Migration of a legacy system deposit contract to the given deposit product by providing the original contract date, account name, statement, payment frequency and start date, etc. This can be used for migrating the legacy contract to deposits account by providing  required details.","summary":"Migration of legacy system deposits contract to the given deposits product","tags":["RETAIL"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"partyIds":[{}],"originationReference":[{}],"effectiveDate":"2024-01-01","productId":"string","currency":"string","branch":"string","channel":"string","lineOfBusiness":"string","originalContractDate":"2024-01-01","extensions":{},"account":[{}],"customer":[{}],"schedule":[{}],"renewal":[{}],"settlement":[{}]}},"responses":{"200":"initiateDepositsMigrationResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"PUT","path":"/holdings/deposits/{depositId}/funding","fullPath":"/api/v5.0.0/holdings/deposits/{depositId}/funding","operationId":"fundTermDeposit","name":"Fund the term deposit manually by providing the deposit amount","summary":"Fund the term deposit account","tags":["RETAIL"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"depositId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"currencyId":"string","effectiveDate":"2024-01-01","activityId":"string","transactionAmount":0.0,"contractId":"string","systemId":"string","externalEventStatus":"string","extensions":{}}},"responses":{"200":"fundTermDepositResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"PUT","path":"/holdings/deposits/{depositId}/accounts","fullPath":"/api/v5.0.0/holdings/deposits/{depositId}/accounts","operationId":"updateTermDepositAccount","name":"Update the account conditions of the term deposit such as alternate references, posting restrictions, etc","summary":"Update the account conditions of the term deposit","tags":["RETAIL"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"depositId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"effectiveDate":"2024-01-01","productId":"string","extensions":{},"account":[{}]}},"responses":{"200":"updateTermDepositAccountResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"PUT","path":"/holdings/deposits/{depositId}/migrations/bills","fullPath":"/api/v5.0.0/holdings/deposits/{depositId}/migrations/bills","operationId":"updateDepositsBillMigration","name":"Captures the bill information of the deposits account such as bill id, property names, bill amount etc. This is used to migrate the bills of a legacy contract which is migrated from other system & update the bill details.","summary":"Captures outstanding bill information of a contract migrated from legacy system.","tags":["RETAIL"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"depositId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"effectiveDate":"2024-01-01","productId":"string","extensions":{},"balanceMaintenance":[{}]}},"responses":{"200":"updateDepositsBillMigrationResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"PUT","path":"/holdings/deposits/{depositId}/withdrawal","fullPath":"/api/v5.0.0/holdings/deposits/{depositId}/withdrawal","operationId":"withdrawDeposit","name":"Withdraw from the amount by providing the withdrawal amount","summary":"Withdraw from the deposit account","tags":["RETAIL"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"depositId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"currencyId":"string","effectiveDate":"2024-01-01","activityId":"string","transactionAmount":0.0,"contractId":"string","systemId":"string","externalEventStatus":"string","extensions":{}}},"responses":{"200":"withdrawDepositResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"PUT","path":"/holdings/deposits/{depositId}/products","fullPath":"/api/v5.0.0/holdings/deposits/{depositId}/products","operationId":"updateDepositProduct","name":"Change of contract from one deposit product to another","summary":"Change of contract from one deposit product to another","tags":["RETAIL"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"depositId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"productId":"string","drawdownDate":"2024-01-01","extensions":{},"facility":[{}],"constraint":[{}],"xidDeposit":[{}],"account":[{}],"activityCharges":[{}],"messaging":[{}],"arrangementRules":[{}],"agentCommission":[{}],"rewardsPoints":[{}],"balanceMaintenance":[{}],"adminfees":[{}],"redemptionfee":[{}]}},"responses":{"200":"updateDepositProductResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"PUT","path":"/holdings/deposits/{depositId}/paymentSchedules","fullPath":"/api/v5.0.0/holdings/deposits/{depositId}/paymentSchedules","operationId":"updateDepositSchedule","name":"Update the payment schedule details of the term deposit such as payment frequency, payment type","summary":"Update the payment schedule of the term deposit","tags":["RETAIL"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"depositId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"productId":"string","drawdownDate":"2024-01-01","extensions":{},"schedule":[{}]}},"responses":{"200":"updateDepositScheduleResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"PUT","path":"/holdings/deposits/{depositId}/migrations/balances","fullPath":"/api/v5.0.0/holdings/deposits/{depositId}/migrations/balances","operationId":"updateDepositsBalanceMigration","name":"Captures the balance details of the deposits account such as balance type, due amount etc. This is used to migrate the balances of a legacy contract which is migrated from other system & update the balance details.","summary":"Captures outstanding balance details of of a contract migrated from legacy system.","tags":["RETAIL"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"depositId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"productId":"string","drawdownDate":"2024-01-01","extensions":{},"balanceMaintenance":[{}]}},"responses":{"200":"updateDepositsBalanceMigrationResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"PUT","path":"/holdings/deposits/{depositId}/noticeUpdates","fullPath":"/api/v5.0.0/holdings/deposits/{depositId}/noticeUpdates","operationId":"updateDepositWithdrawalNotice","name":"Updates the notice of withdrawal of amount from deposit account by providing the withdrawal date","summary":"Updates the notice of withdrawal of amount from account ","tags":["RETAIL"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"depositId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"productId":"string","drawdownDate":"2024-01-01","extensions":{},"noticeWithdrawal":[{}]}},"responses":{"200":"updateDepositWithdrawalNoticeResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"PUT","path":"/holdings/deposits/{depositId}/cancellations","fullPath":"/api/v5.0.0/holdings/deposits/{depositId}/cancellations","operationId":"cancelDepositWithdrawalNotice","name":"Cancels the notification of withdrawal of amount from deposit account by providing the withdrawal date","summary":"Cancels the notification of withdrawal of amount from account","tags":["RETAIL"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"depositId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"productId":"string","drawdownDate":"2024-01-01","extensions":{},"noticeWithdrawal":[{}]}},"responses":{"200":"cancelDepositWithdrawalNoticeResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"PUT","path":"/holdings/deposits/{depositId}/withdrawalnotices","fullPath":"/api/v5.0.0/holdings/deposits/{depositId}/withdrawalnotices","operationId":"captureDepositWithdrawalNotice","name":"Notifies the withdrawal of amount from deposit account by providing the withdrawal date and amount etc. This is applicable only for notice type of deposits.","summary":"Notifies the withdrawal of amount from deposit account","tags":["RETAIL"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"depositId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"productId":"string","drawdownDate":"2024-01-01","extensions":{},"noticeWithdrawal":[{}]}},"responses":{"200":"captureDepositWithdrawalNoticeResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"PUT","path":"/holdings/deposits/{depositId}/settlements","fullPath":"/api/v5.0.0/holdings/deposits/{depositId}/settlements","operationId":"updateDepositSettlement","name":"Update the settlement conditions of the term deposit such as payin account, payout account, beneficiary etc","summary":"Update the settlement conditions of the term deposit","tags":["RETAIL"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"depositId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"productId":"string","drawdownDate":"2024-01-01","extensions":{},"settlement":[{}]}},"responses":{"200":"updateDepositSettlementResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"PUT","path":"/holdings/deposits/{depositId}/customers","fullPath":"/api/v5.0.0/holdings/deposits/{depositId}/customers","operationId":"updateDepositCustomer","name":"Update the customer details of the term deposit such as add or remove joint customers","summary":"Update the customer details of the term deposit","tags":["RETAIL"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"depositId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"partyIds":[{}],"effectiveDate":"2024-01-01","extensions":{},"statement":[{}]}},"responses":{"200":"updateDepositCustomerResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"PUT","path":"/holdings/deposits/{depositId}/interestConditions","fullPath":"/api/v5.0.0/holdings/deposits/{depositId}/interestConditions","operationId":"updateDepositInterest","name":"Update the interest conditions of the term deposit such as interest rate, spread, margin etc","summary":"Update the interest conditions of the term deposit","tags":["RETAIL"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"depositId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"productId":"string","drawdownDate":"2024-01-01","extensions":{}}},"responses":{"200":"updateDepositInterestResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"PUT","path":"/holdings/deposits/{depositId}/rollovers","fullPath":"/api/v5.0.0/holdings/deposits/{depositId}/rollovers","operationId":"updateDepositRollover","name":"Perform the rollover of the deposit for the given rollover date or period","summary":"Perform the rollover of the deposit","tags":["RETAIL"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"depositId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"productId":"string","drawdownDate":"2024-01-01","extensions":{},"depositint":[{}],"schedule":[{}],"renewal":[{}],"settlement":[{}],"commitment":[{}]}},"responses":{"200":"updateDepositRolloverResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"POST","path":"/holdings/deposits/shortTermDeposits","fullPath":"/api/v5.0.0/holdings/deposits/shortTermDeposits","operationId":"createShortTermDeposit","name":"This can be used to create a short-term deposit and the payload should include customer identifier, customer role,  deposit currency, deposit amount, term, etc.","summary":"Create a short term deposit acount","tags":[],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"partyIds":[{}],"partyRoles":[{}],"agentCustomerIds":[{}],"agentArrangementIds":[{}],"agentRoles":[{}],"arrangmentId":"string","productId":"string","activityId":"string","currency":"string","productVariation":"string","pricingSelection":"string","pricingPlan":"string","rewardsArrangementId":"string","tradeDate":"string","arrangementEffectiveDate":"string"}},"responses":{"200":"createShortTermDepositResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"POST","path":"/holdings/deposits/oneYearBonds","fullPath":"/api/v5.0.0/holdings/deposits/oneYearBonds","operationId":"createOneYearBond","name":"This can be used to create a one-year bond and the payload should include customer identifier, customer role,  bond currency, bond amount, etc.","summary":"Creates a one year bond/deposit account","tags":[],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"partyIds":[{}],"partyRoles":[{}],"agentCustomerIds":[{}],"agentArrangementIds":[{}],"agentRoles":[{}],"arrangmentId":"string","productId":"string","activityId":"string","currency":"string","productVariation":"string","pricingSelection":"string","pricingPlan":"string","rewardsArrangementId":"string","tradeDate":"string","arrangementEffectiveDate":"string"}},"responses":{"200":"createOneYearBondResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"POST","path":"/holdings/deposits/threeYearBonds","fullPath":"/api/v5.0.0/holdings/deposits/threeYearBonds","operationId":"createThreeYearBond","name":"This can be used to create a three-year bond and the payload should include customer identifier, customer role,  bond currency, bond amount, etc.","summary":"Creates a three year bond/deposit account","tags":[],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"partyIds":[{}],"partyRoles":[{}],"agentCustomerIds":[{}],"agentArrangementIds":[{}],"agentRoles":[{}],"arrangmentId":"string","productId":"string","activityId":"string","currency":"string","productVariation":"string","pricingSelection":"string","pricingPlan":"string","rewardsArrangementId":"string","tradeDate":"string","arrangementEffectiveDate":"string"}},"responses":{"200":"createThreeYearBondResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"POST","path":"/holdings/deposits/longTermDeposits","fullPath":"/api/v5.0.0/holdings/deposits/longTermDeposits","operationId":"createLongTermDeposit","name":"This can be used to create long-term deposits and the payload should include customer identifier, customer role,  deposit currency, deposit amount, term, etc.","summary":"Creates a long term deposit account","tags":[],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"partyIds":[{}],"partyRoles":[{}],"agentCustomerIds":[{}],"agentArrangementIds":[{}],"agentRoles":[{}],"arrangmentId":"string","productId":"string","activityId":"string","currency":"string","productVariation":"string","pricingSelection":"string","pricingPlan":"string","rewardsArrangementId":"string","tradeDate":"string","arrangementEffectiveDate":"string"}},"responses":{"200":"createLongTermDepositResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"POST","path":"/holdings/deposits/callDeposits","fullPath":"/api/v5.0.0/holdings/deposits/callDeposits","operationId":"createCallDeposit","name":"This can be used to create call deposits which have no fixed term or maturity period and the payload should include the customer identifier, customer role,  deposit currency, deposit amount, etc.","summary":"Create a call deposit account (No term or period)","tags":[],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"partyIds":[{}],"partyRoles":[{}],"agentCustomerIds":[{}],"agentArrangementIds":[{}],"agentRoles":[{}],"arrangmentId":"string","productId":"string","activityId":"string","currency":"string","productVariation":"string","pricingSelection":"string","pricingPlan":"string","rewardsArrangementId":"string","tradeDate":"string","arrangementEffectiveDate":"string"}},"responses":{"200":"createCallDepositResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"POST","path":"/holdings/deposits/mudarabaDeposits","fullPath":"/api/v5.0.0/holdings/deposits/mudarabaDeposits","operationId":"createMudarabaDeposit","name":"This can be used to create Islamic mudarba deposits and the payload should include customer identifier, customer role,  deposit currency, deposit amount,term etc.","summary":"Create a mudaraba deposit account","tags":[],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"partyIds":[{}],"partyRoles":[{}],"agentCustomerIds":[{}],"agentArrangementIds":[{}],"agentRoles":[{}],"arrangmentId":"string","productId":"string","activityId":"string","currency":"string","productVariation":"string","pricingSelection":"string","pricingPlan":"string","rewardsArrangementId":"string","tradeDate":"string","arrangementEffectiveDate":"string"}},"responses":{"200":"createMudarabaDepositResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"POST","path":"/holdings/deposits/redeemDeposits","fullPath":"/api/v5.0.0/holdings/deposits/redeemDeposits","operationId":"redeemDeposits","name":"This can be used to redeem deposits and the payload to redeem should include the settlement instructions to which the deposit amount is to be credited. Common usage of this is when customers want to withdraw their deposits before the actual  maturity date of the deposits.","summary":"Redeem a deposit","tags":[],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"partyIds":[{}],"partyRoles":[{}],"agentCustomerIds":[{}],"agentArrangementIds":[{}],"agentRoles":[{}],"arrangmentId":"string","productId":"string","activityId":"string","currency":"string","productVariation":"string","pricingSelection":"string","pricingPlan":"string","rewardsArrangementId":"string","tradeDate":"string","arrangementEffectiveDate":"string"}},"responses":{"200":"redeemDepositsResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"POST","path":"/holdings/deposits/redeemDeposits/{arrangementId}","fullPath":"/api/v5.0.0/holdings/deposits/redeemDeposits/{arrangementId}","operationId":"simulateRedeemDeposits","name":"This can be used to simulate a deposit redemption and the payload should include the settlement instructions to which the deposit amount is to be credited. Common usage of this is for simulating withdrawals when customers want to withdraw their deposits before the actual fixed maturity date of the deposits.","summary":"Simulate a deposit redemption","tags":[],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"arrangementId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"partyIds":[{}],"partyRoles":[{}],"agentCustomerIds":[{}],"agentArrangementIds":[{}],"agentRoles":[{}],"arrangmentId":"string","productId":"string","activityId":"string","currency":"string","productVariation":"string","pricingSelection":"string","pricingPlan":"string","rewardsArrangementId":"string","tradeDate":"string","arrangementEffectiveDate":"string"}},"responses":{"200":"simulateRedeemDepositsResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"GET","path":"/holdings/deposits/{arrangementId}/chargeAmount","fullPath":"/api/v5.0.0/holdings/deposits/{arrangementId}/chargeAmount","operationId":"getChargeAmount","name":"Retrieves the charge amount for a given charge property and its payload includes charge identifier, simulation reference, etc.","summary":"Retrieves the charge amount for a given charge property","tags":[],"parameters":[{"name":"arrangementId","in":"path","type":"string","required":true,"description":"Indicates an unique identifier of an account"},{"name":"chargeProperty","in":"query","type":"string","required":true,"description":"Contains the charge name which is corresponding to the calculated charge amount"},{"name":"simulationReference","in":"query","type":"string","required":true,"description":"Indicates the Reference ID for simulation activity"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from t24 on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"ChargeAmountResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"POST","path":"/holdings/deposits/wakalaDeposits","fullPath":"/api/v5.0.0/holdings/deposits/wakalaDeposits","operationId":"createWakalaDeposit","name":"This can be used to create Islamic wakala  deposits and the payload should include customer identifier, customer role,  deposit currency, deposit amount and the fixed term of the deposit etc.","summary":"Create a wakala deposit account","tags":[],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"partyIds":[{}],"partyRoles":[{}],"agentCustomerIds":[{}],"agentArrangementIds":[{}],"agentRoles":[{}],"arrangmentId":"string","productId":"string","activityId":"string","currency":"string","productVariation":"string","pricingSelection":"string","pricingPlan":"string","rewardsArrangementId":"string","tradeDate":"string","arrangementEffectiveDate":"string"}},"responses":{"200":"createWakalaDepositResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"GET","path":"/holdings/deposits/{depositId}","fullPath":"/api/v5.0.0/holdings/deposits/{depositId}","operationId":"getDepositDetails","name":"Retrieves the basic information of the deposit account including deposit amount, term, maturity days, tax details, charge details, etc. Common usage of this could be to display the basic information of deposits in a customer user interface.","summary":"Retrieves the deposit details","tags":[],"parameters":[{"name":"depositId","in":"path","type":"string","required":true,"description":"Indicates the Id of the deposit account"},{"name":"balanceTypes","in":"query","type":"string","required":false,"description":"Type of balance (e.g. current balance, credit interest accrued, deferred commission, etc.) as defined in the institution's accounting schemas."},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from t24 on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"DepositDetailsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/deposits/{depositId}/redemptions/bills","fullPath":"/api/v5.0.0/holdings/deposits/{depositId}/redemptions/bills","operationId":"getRedeemDepositBillDetails","name":"Retrieves the redeem bill for the given deposit by providing the deposit reference and simulation reference for simulated deposits","summary":"Retrieves the redeem bill for the given deposit","tags":["RETAIL"],"parameters":[{"name":"depositId","in":"path","type":"string","required":true,"description":"Indicates the Id of the deposit account"},{"name":"simulationReference","in":"query","type":"string","required":false,"description":"Indicates the reference id for simulation activity"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"RedeemDepositBillDetailsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"PUT","path":"/holdings/deposits/simulations/{simulationId}","fullPath":"/api/v5.0.0/holdings/deposits/simulations/{simulationId}","operationId":"updateDepositSimulation","name":"This can be used to amend a simulation for deposit product and the payload should include customer identifier, currency, etc.","summary":"Amend simulation for deposit products","tags":["RETAIL"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"simulationId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"customerIds":[{}],"properties":[{}],"overrides":[{}],"productId":"string","masterArrangementId":"string","roleName":"string","currencyId":"string","effectiveDate":"2024-01-01","activityId":"string","transactionAmount":0.0,"reason":"string","automaticRun":"string","simulationRunReference":"string","synchronous":"string","account":[{}]}},"responses":{"200":"updateDepositSimulationResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}}]},{"key":"holdings-deposits-arrangements-v6.0.0","title":"Deposit Arrangements","version":"v6.0.0","description":"The arrangement architecture is a Temenos transact framework to create and manage various products such as loans, deposits, accounts, etc. It provides a modular business component-based architecture, whereby users can create their products by using the components provided by Temenos and these compon","endpointCount":35,"endpoints":[{"method":"POST","path":"/holdings/deposits/termDeposits","fullPath":"/api/v6.0.0/holdings/deposits/termDeposits","operationId":"createDeposits","name":"Creates term deposits and the payload should include customer identifier, customer role, deposit currency, deposit amount and the deposit duration term etc.","summary":"Create a deposit account","tags":["RETAIL"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"partyIds":[{}],"partyRoles":[{}],"agentCustomerIds":[{}],"agentArrangementIds":[{}],"agentRoles":[{}],"arrangmentId":"string","productId":"string","activityId":"string","currency":"string","productVariation":"string","pricingSelection":"string","pricingPlan":"string","rewardsArrangementId":"string","tradeDate":"string","arrangementEffectiveDate":"string"}},"responses":{"200":"createDepositsResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"PUT","path":"/holdings/deposits/{depositId}/rollovers","fullPath":"/api/v6.0.0/holdings/deposits/{depositId}/rollovers","operationId":"updateDepositRollover","name":"Perform the rollover of the deposit for the given rollover date or period","summary":"Perform the rollover of the deposit","tags":["RETAIL"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"depositId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"productId":"string","drawdownDate":"2024-01-01","extensions":{},"depositint":[{}],"schedule":[{}],"renewal":[{}],"settlement":[{}],"commitment":[{}]}},"responses":{"200":"updateDepositRolloverResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"PUT","path":"/holdings/deposits/{depositId}/branches","fullPath":"/api/v6.0.0/holdings/deposits/{depositId}/branches","operationId":"updateDepositBranch","name":"Update the branch for the deposit","summary":"Update the branch for the deposit","tags":["RETAIL"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"depositId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"effectiveDate":"2024-01-01","branch":"string","extensions":{}}},"responses":{"200":"updateDepositBranchResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"PUT","path":"/holdings/deposits/{depositId}/commitments","fullPath":"/api/v6.0.0/holdings/deposits/{depositId}/commitments","operationId":"updateTenure","name":"Update the tenure of the term deposit by providing tenure or maturity date","summary":"Update the tenure of the term amount","tags":["RETAIL"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"depositId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"productId":"string","drawdownDate":"2024-01-01","extensions":{},"commitment":[{}]}},"responses":{"200":"updateTenureResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"PUT","path":"/holdings/deposits/{depositId}/withdrawals","fullPath":"/api/v6.0.0/holdings/deposits/{depositId}/withdrawals","operationId":"withdrawDeposits","name":"Withdraw from the deposit account","summary":"Withdraw from the amount by providing the withdrawal amount","tags":["RETAIL"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"depositId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"partyIds":[{}],"partyRoles":[{}],"agentCustomerIds":[{}],"agentArrangementIds":[{}],"agentRoles":[{}],"arrangmentId":"string","productId":"string","activityId":"string","currency":"string","productVariation":"string","pricingSelection":"string","pricingPlan":"string","rewardsArrangementId":"string","tradeDate":"string","arrangementEffectiveDate":"string"}},"responses":{"200":"withdrawDepositsResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"PUT","path":"/holdings/deposits/{depositId}/renegotiations","fullPath":"/api/v6.0.0/holdings/deposits/{depositId}/renegotiations","operationId":"updateDepositConditions","name":"Perform the renegotiation of the term deposit contract details such as payment frequency, interest rates, etc.","summary":"Renegotiation of the term deposit contract details","tags":["RETAIL"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"depositId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"productId":"string","drawdownDate":"2024-01-01","extensions":{},"account":[{}],"customer":[{}],"schedule":[{}],"settlement":[{}],"commitment":[{}]}},"responses":{"200":"updateDepositConditionsResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"PUT","path":"/holdings/deposits/{depositId}/redemptions","fullPath":"/api/v6.0.0/holdings/deposits/{depositId}/redemptions","operationId":"redeemDeposit","name":"Redeem the term deposit to close the deposit by providing the settlement instructions","summary":"Redeem the term deposit to close the deposit","tags":["RETAIL"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"depositId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"effectiveDate":"2024-01-01"}},"responses":{"200":"RedemptionsDepositResponse","default":"RedemptionsArrangementErrorResponse","400":"RedemptionsBusinessArrangementErrorResponse","500":"RedemptionsSystemArrangementErrorResponse"}},{"method":"POST","path":"/holdings/deposits/simulations","fullPath":"/api/v6.0.0/holdings/deposits/simulations","operationId":"simulateNewdeposit","name":"Simulate a deposit arrangement for the given principal amount, term, payment frequency and interest rates","summary":"Simulate a deposit arrangement for the given principal amount, term, payment frequency and interest rates","tags":["RETAIL"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"customerIds":[{}],"properties":[{}],"overrides":[{}],"productId":"string","masterArrangementId":"string","roleName":"string","currencyId":"string","effectiveDate":"2024-01-01","activityId":"string","transactionAmount":0.0,"reason":"string","simulationRunReference":"string","extensions":{},"account":[{}],"customer":[{}]}},"responses":{"200":"simulateNewdepositResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"POST","path":"/holdings/deposits/migrations","fullPath":"/api/v6.0.0/holdings/deposits/migrations","operationId":"initiateDepositsMigration","name":"Migration of a legacy system deposit contract to the given deposit product by providing the original contract date, account name, statement, payment frequency and start date, etc. This can be used for migrating the legacy contract to deposits account by providing required details.","summary":"Migration of legacy system deposits contract to the given deposits product","tags":["RETAIL"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"partyIds":[{}],"originationReference":[{}],"effectiveDate":"2024-01-01","productId":"string","currency":"string","branch":"string","channel":"string","lineOfBusiness":"string","originalContractDate":"2024-01-01","extensions":{},"account":[{}],"customer":[{}],"schedule":[{}],"renewal":[{}],"settlement":[{}]}},"responses":{"200":"initiateDepositsMigrationResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"PUT","path":"/holdings/deposits/{depositId}/funding","fullPath":"/api/v6.0.0/holdings/deposits/{depositId}/funding","operationId":"fundTermDeposit","name":"Fund the term deposit manually by providing the deposit amount","summary":"Fund the term deposit account","tags":["RETAIL"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"depositId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"currencyId":"string","effectiveDate":"2024-01-01","activityId":"string","transactionAmount":0.0,"contractId":"string","systemId":"string","externalEventStatus":"string","extensions":{}}},"responses":{"200":"fundTermDepositResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"PUT","path":"/holdings/deposits/{depositId}/accounts","fullPath":"/api/v6.0.0/holdings/deposits/{depositId}/accounts","operationId":"updateTermDepositAccount","name":"Update the account conditions of the term deposit such as alternate references, posting restrictions, etc","summary":"Update the account conditions of the term deposit","tags":["RETAIL"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"depositId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"effectiveDate":"2024-01-01","productId":"string","extensions":{},"account":[{}]}},"responses":{"200":"updateTermDepositAccountResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"PUT","path":"/holdings/deposits/{depositId}/migrations/bills","fullPath":"/api/v6.0.0/holdings/deposits/{depositId}/migrations/bills","operationId":"updateDepositsBillMigration","name":"Captures the bill information of the deposits account such as bill id, property names, bill amount etc. This is used to migrate the bills of a legacy contract which is migrated from other system & update the bill details.","summary":"Captures outstanding bill information of a contract migrated from legacy system.","tags":["RETAIL"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"depositId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"effectiveDate":"2024-01-01","productId":"string","extensions":{},"balanceMaintenance":[{}]}},"responses":{"200":"updateDepositsBillMigrationResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"PUT","path":"/holdings/deposits/{depositId}/withdrawal","fullPath":"/api/v6.0.0/holdings/deposits/{depositId}/withdrawal","operationId":"withdrawDeposit","name":"Withdraw from the amount by providing the withdrawal amount","summary":"Withdraw from the deposit account","tags":["RETAIL"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"depositId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"currencyId":"string","effectiveDate":"2024-01-01","activityId":"string","transactionAmount":0.0,"contractId":"string","systemId":"string","externalEventStatus":"string","extensions":{}}},"responses":{"200":"withdrawDepositResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"PUT","path":"/holdings/deposits/{depositId}/products","fullPath":"/api/v6.0.0/holdings/deposits/{depositId}/products","operationId":"updateDepositProduct","name":"Update the contract from one deposit product to another","summary":"Update the contract from one deposit product to another","tags":["RETAIL"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"depositId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"productId":"string","drawdownDate":"2024-01-01","extensions":{},"facility":[{}],"constraint":[{}],"xidDeposit":[{}],"account":[{}],"activityCharges":[{}],"messaging":[{}],"arrangementRules":[{}],"agentCommission":[{}],"rewardsPoints":[{}],"balanceMaintenance":[{}],"adminfees":[{}],"redemptionfee":[{}]}},"responses":{"200":"updateDepositProductResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"PUT","path":"/holdings/deposits/{depositId}/paymentSchedules","fullPath":"/api/v6.0.0/holdings/deposits/{depositId}/paymentSchedules","operationId":"updateDepositSchedule","name":"Update the payment schedule details of the term deposit such as payment frequency, payment type","summary":"Update the payment schedule of the term deposit","tags":["RETAIL"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"depositId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"productId":"string","drawdownDate":"2024-01-01","extensions":{},"schedule":[{}]}},"responses":{"200":"updateDepositScheduleResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"PUT","path":"/holdings/deposits/{depositId}/migrations/balances","fullPath":"/api/v6.0.0/holdings/deposits/{depositId}/migrations/balances","operationId":"updateDepositsBalanceMigration","name":"Captures the balance details of the deposits account such as balance type, due amount etc. This is used to migrate the balances of a legacy contract which is migrated from other system & update the balance details.","summary":"Captures outstanding balance details of of a contract migrated from legacy system.","tags":["RETAIL"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"depositId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"productId":"string","drawdownDate":"2024-01-01","extensions":{},"balanceMaintenance":[{}]}},"responses":{"200":"updateDepositsBalanceMigrationResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"PUT","path":"/holdings/deposits/{depositId}/noticeUpdates","fullPath":"/api/v6.0.0/holdings/deposits/{depositId}/noticeUpdates","operationId":"updateDepositWithdrawalNotice","name":"Updates the notice of withdrawal of amount from deposit account by providing the withdrawal date","summary":"Updates the notice of withdrawal of amount from account ","tags":["RETAIL"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"depositId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"productId":"string","drawdownDate":"2024-01-01","extensions":{},"noticeWithdrawal":[{}]}},"responses":{"200":"updateDepositWithdrawalNoticeResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"PUT","path":"/holdings/deposits/{depositId}/cancellations","fullPath":"/api/v6.0.0/holdings/deposits/{depositId}/cancellations","operationId":"cancelDepositWithdrawalNotice","name":"Cancels the notification of withdrawal of amount from deposit account by providing the withdrawal date","summary":"Cancels the notification of withdrawal of amount from account","tags":["RETAIL"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"depositId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"productId":"string","drawdownDate":"2024-01-01","extensions":{},"noticeWithdrawal":[{}]}},"responses":{"200":"cancelDepositWithdrawalNoticeResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"PUT","path":"/holdings/deposits/{depositId}/withdrawalnotices","fullPath":"/api/v6.0.0/holdings/deposits/{depositId}/withdrawalnotices","operationId":"captureDepositWithdrawalNotice","name":"Notifies the withdrawal of amount from deposit account by providing the withdrawal date and amount etc. This is applicable only for notice type of deposits.","summary":"Notifies the withdrawal of amount from deposit account","tags":["RETAIL"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"depositId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"productId":"string","drawdownDate":"2024-01-01","extensions":{},"noticeWithdrawal":[{}]}},"responses":{"200":"captureDepositWithdrawalNoticeResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"PUT","path":"/holdings/deposits/{depositId}/settlements","fullPath":"/api/v6.0.0/holdings/deposits/{depositId}/settlements","operationId":"updateDepositSettlement","name":"Update the settlement conditions of the term deposit such as payin account, payout account, beneficiary etc","summary":"Update the settlement conditions of the term deposit","tags":["RETAIL"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"depositId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"productId":"string","drawdownDate":"2024-01-01","extensions":{},"settlement":[{}]}},"responses":{"200":"updateDepositSettlementResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"PUT","path":"/holdings/deposits/{depositId}/customers","fullPath":"/api/v6.0.0/holdings/deposits/{depositId}/customers","operationId":"updateDepositCustomer","name":"Update the customer details of the term deposit such as add or remove joint customers","summary":"Update the customer details of the term deposit","tags":["RETAIL"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"depositId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"partyIds":[{}],"effectiveDate":"2024-01-01","extensions":{},"statement":[{}]}},"responses":{"200":"updateDepositCustomerResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"PUT","path":"/holdings/deposits/{depositId}/interestConditions","fullPath":"/api/v6.0.0/holdings/deposits/{depositId}/interestConditions","operationId":"updateDepositInterest","name":"Update the interest conditions of the term deposit such as interest rate, spread, margin etc","summary":"Update the interest conditions of the term deposit","tags":["RETAIL"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"depositId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"productId":"string","drawdownDate":"2024-01-01","extensions":{}}},"responses":{"200":"updateDepositInterestResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"POST","path":"/holdings/deposits/shortTermDeposits","fullPath":"/api/v6.0.0/holdings/deposits/shortTermDeposits","operationId":"createShortTermDeposit","name":"Creates a short-term deposit and the payload should include customer identifier, customer role, deposit currency, deposit amount, term, etc.","summary":"Create a short term deposit acount","tags":[],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"partyIds":[{}],"partyRoles":[{}],"agentCustomerIds":[{}],"agentArrangementIds":[{}],"agentRoles":[{}],"arrangmentId":"string","productId":"string","activityId":"string","currency":"string","productVariation":"string","pricingSelection":"string","pricingPlan":"string","rewardsArrangementId":"string","tradeDate":"string","arrangementEffectiveDate":"string"}},"responses":{"200":"createShortTermDepositResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"POST","path":"/holdings/deposits/oneYearBonds","fullPath":"/api/v6.0.0/holdings/deposits/oneYearBonds","operationId":"createOneYearBond","name":"Creates a one-year bond and the payload should include customer identifier, customer role, bond currency, bond amount, etc.","summary":"Creates a one year bond/deposit account","tags":[],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"partyIds":[{}],"partyRoles":[{}],"agentCustomerIds":[{}],"agentArrangementIds":[{}],"agentRoles":[{}],"arrangmentId":"string","productId":"string","activityId":"string","currency":"string","productVariation":"string","pricingSelection":"string","pricingPlan":"string","rewardsArrangementId":"string","tradeDate":"string","arrangementEffectiveDate":"string"}},"responses":{"200":"createOneYearBondResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"POST","path":"/holdings/deposits/threeYearBonds","fullPath":"/api/v6.0.0/holdings/deposits/threeYearBonds","operationId":"createThreeYearBond","name":"Creates a three-year bond and the payload should include customer identifier, customer role, bond currency, bond amount, etc.","summary":"Creates a three year bond/deposit account","tags":[],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"partyIds":[{}],"partyRoles":[{}],"agentCustomerIds":[{}],"agentArrangementIds":[{}],"agentRoles":[{}],"arrangmentId":"string","productId":"string","activityId":"string","currency":"string","productVariation":"string","pricingSelection":"string","pricingPlan":"string","rewardsArrangementId":"string","tradeDate":"string","arrangementEffectiveDate":"string"}},"responses":{"200":"createThreeYearBondResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"POST","path":"/holdings/deposits/longTermDeposits","fullPath":"/api/v6.0.0/holdings/deposits/longTermDeposits","operationId":"createLongTermDeposit","name":"Creates long-term deposits and the payload should include customer identifier, customer role, deposit currency, deposit amount, term, etc.","summary":"Creates a long term deposit account","tags":[],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"partyIds":[{}],"partyRoles":[{}],"agentCustomerIds":[{}],"agentArrangementIds":[{}],"agentRoles":[{}],"arrangmentId":"string","productId":"string","activityId":"string","currency":"string","productVariation":"string","pricingSelection":"string","pricingPlan":"string","rewardsArrangementId":"string","tradeDate":"string","arrangementEffectiveDate":"string"}},"responses":{"200":"createLongTermDepositResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"POST","path":"/holdings/deposits/callDeposits","fullPath":"/api/v6.0.0/holdings/deposits/callDeposits","operationId":"createCallDeposit","name":"Creates call deposits which have no fixed term or maturity period and the payload should include the customer identifier, customer role, deposit currency, deposit amount, etc.","summary":"Create a call deposit account (No term or period)","tags":[],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"partyIds":[{}],"partyRoles":[{}],"agentCustomerIds":[{}],"agentArrangementIds":[{}],"agentRoles":[{}],"arrangmentId":"string","productId":"string","activityId":"string","currency":"string","productVariation":"string","pricingSelection":"string","pricingPlan":"string","rewardsArrangementId":"string","tradeDate":"string","arrangementEffectiveDate":"string"}},"responses":{"200":"createCallDepositResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"POST","path":"/holdings/deposits/mudarabaDeposits","fullPath":"/api/v6.0.0/holdings/deposits/mudarabaDeposits","operationId":"createMudarabaDeposit","name":"Creates Islamic mudarba deposits and the payload should include customer identifier, customer role, deposit currency, deposit amount,term etc.","summary":"Create a mudaraba deposit account","tags":[],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"partyIds":[{}],"partyRoles":[{}],"agentCustomerIds":[{}],"agentArrangementIds":[{}],"agentRoles":[{}],"arrangmentId":"string","productId":"string","activityId":"string","currency":"string","productVariation":"string","pricingSelection":"string","pricingPlan":"string","rewardsArrangementId":"string","tradeDate":"string","arrangementEffectiveDate":"string"}},"responses":{"200":"createMudarabaDepositResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"POST","path":"/holdings/deposits/redeemDeposits","fullPath":"/api/v6.0.0/holdings/deposits/redeemDeposits","operationId":"redeemDeposits","name":"Creates redeem deposits and the payload to redeem should include the settlement instructions to which the deposit amount is to be credited. Common usage of this is when customers want to withdraw their deposits before the actual maturity date of the deposits.","summary":"Redeem a deposit","tags":[],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"partyIds":[{}],"partyRoles":[{}],"agentCustomerIds":[{}],"agentArrangementIds":[{}],"agentRoles":[{}],"arrangmentId":"string","productId":"string","activityId":"string","currency":"string","productVariation":"string","pricingSelection":"string","pricingPlan":"string","rewardsArrangementId":"string","tradeDate":"string","arrangementEffectiveDate":"string"}},"responses":{"200":"redeemDepositsResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"POST","path":"/holdings/deposits/redeemDeposits/{arrangementId}","fullPath":"/api/v6.0.0/holdings/deposits/redeemDeposits/{arrangementId}","operationId":"simulateRedeemDeposits","name":"Simulates a deposit redemption and the payload should include the settlement instructions to which the deposit amount is to be credited. Common usage of this is for simulating withdrawals when customers want to withdraw their deposits before the actual fixed maturity date of the deposits.","summary":"Simulate a deposit redemption","tags":[],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"arrangementId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"partyIds":[{}],"partyRoles":[{}],"agentCustomerIds":[{}],"agentArrangementIds":[{}],"agentRoles":[{}],"arrangmentId":"string","productId":"string","activityId":"string","currency":"string","productVariation":"string","pricingSelection":"string","pricingPlan":"string","rewardsArrangementId":"string","tradeDate":"string","arrangementEffectiveDate":"string"}},"responses":{"200":"simulateRedeemDepositsResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"GET","path":"/holdings/deposits/{arrangementId}/chargeAmount","fullPath":"/api/v6.0.0/holdings/deposits/{arrangementId}/chargeAmount","operationId":"getChargeAmount","name":"Retrieves the charge amount for a given charge property and its payload includes charge identifier, simulation reference, etc.","summary":"Retrieves the charge amount for a given charge property","tags":[],"parameters":[{"name":"arrangementId","in":"path","type":"string","required":true,"description":"Indicates an unique identifier of an account"},{"name":"chargeProperty","in":"query","type":"string","required":true,"description":"Contains the charge name which is corresponding to the calculated charge amount"},{"name":"simulationReference","in":"query","type":"string","required":true,"description":"Indicates the Reference ID for simulation activity"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from t24 on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"ChargeAmountResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"POST","path":"/holdings/deposits/wakalaDeposits","fullPath":"/api/v6.0.0/holdings/deposits/wakalaDeposits","operationId":"createWakalaDeposit","name":"Creates Islamic wakala  deposits and the payload should include customer identifier, customer role,  deposit currency, deposit amount and the fixed term of the deposit etc.","summary":"Create a wakala deposit account","tags":[],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"partyIds":[{}],"partyRoles":[{}],"agentCustomerIds":[{}],"agentArrangementIds":[{}],"agentRoles":[{}],"arrangmentId":"string","productId":"string","activityId":"string","currency":"string","productVariation":"string","pricingSelection":"string","pricingPlan":"string","rewardsArrangementId":"string","tradeDate":"string","arrangementEffectiveDate":"string"}},"responses":{"200":"createWakalaDepositResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"GET","path":"/holdings/deposits/{depositId}","fullPath":"/api/v6.0.0/holdings/deposits/{depositId}","operationId":"getDepositDetails","name":"Retrieves the basic information of the deposit account including deposit amount, term, maturity days, tax details, charge details, etc. Common usage of this could be to display the basic information of deposits in a customer user interface.","summary":"Retrieves the deposit details","tags":[],"parameters":[{"name":"depositId","in":"path","type":"string","required":true,"description":"Indicates the Id of the deposit account"},{"name":"balanceTypes","in":"query","type":"string","required":false,"description":"Type of balance (e.g. current balance, credit interest accrued, deferred commission, etc.) as defined in the institution's accounting schemas."},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from t24 on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"DepositDetailsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/deposits/{depositId}/redemptions/bills","fullPath":"/api/v6.0.0/holdings/deposits/{depositId}/redemptions/bills","operationId":"getRedeemDepositBillDetails","name":"Retrieves the redeem bill for the given deposit by providing the deposit reference and simulation reference for simulated deposits","summary":"Retrieves the redeem bill for the given deposit","tags":["RETAIL"],"parameters":[{"name":"depositId","in":"path","type":"string","required":true,"description":"Indicates the Id of the deposit account"},{"name":"simulationReference","in":"query","type":"string","required":false,"description":"Indicates the reference id for simulation activity"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"RedeemDepositBillDetailsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"PUT","path":"/holdings/deposits/simulations/{simulationId}","fullPath":"/api/v6.0.0/holdings/deposits/simulations/{simulationId}","operationId":"updateDepositSimulation","name":"Amend a simulation for deposit product and the payload should include customer identifier, currency, etc.","summary":"Amend simulation for deposit products","tags":["RETAIL"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"simulationId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"customerIds":[{}],"properties":[{}],"overrides":[{}],"productId":"string","masterArrangementId":"string","roleName":"string","currencyId":"string","effectiveDate":"2024-01-01","activityId":"string","transactionAmount":0.0,"reason":"string","automaticRun":"string","simulationRunReference":"string","synchronous":"string","account":[{}]}},"responses":{"200":"updateDepositSimulationResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}}]},{"key":"holdings-deposits-arrangements-v7.0.0","title":"Deposit Arrangements","version":"v7.0.0","description":"The arrangement architecture is a Temenos Transact framework to create and manage various products such as loans, deposits, accounts, etc. It provides a modular business component-based architecture, whereby users can create their products by using the components provided by Temenos and these compon","endpointCount":35,"endpoints":[{"method":"POST","path":"/holdings/deposits/termDeposits","fullPath":"/api/v7.0.0/holdings/deposits/termDeposits","operationId":"createDeposits","name":"Creates term deposits that includes customer identifier, customer role, deposit currency, deposit amount and the deposit duration term etc.","summary":"Create a deposit account","tags":["RETAIL"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"partyIds":[{}],"partyRoles":[{}],"agentCustomerIds":[{}],"agentArrangementIds":[{}],"agentRoles":[{}],"arrangmentId":"string","productId":"string","activityId":"string","currency":"string","productVariation":"string","pricingSelection":"string","pricingPlan":"string","rewardsArrangementId":"string","tradeDate":"string","arrangementEffectiveDate":"string"}},"responses":{"200":"createDepositsResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"PUT","path":"/holdings/deposits/{depositId}/rollovers","fullPath":"/api/v7.0.0/holdings/deposits/{depositId}/rollovers","operationId":"updateDepositRollover","name":"Perform the rollover of the deposit for the given rollover date or period","summary":"Perform the rollover of the deposit","tags":["RETAIL"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"depositId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"productId":"string","drawdownDate":"2024-01-01","extensions":{},"depositint":[{}],"schedule":[{}],"renewal":[{}],"settlement":[{}],"commitment":[{}]}},"responses":{"200":"updateDepositRolloverResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"PUT","path":"/holdings/deposits/{depositId}/branches","fullPath":"/api/v7.0.0/holdings/deposits/{depositId}/branches","operationId":"updateDepositBranch","name":"Update the branch for the deposit","summary":"Update the branch for the deposit","tags":["RETAIL"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"depositId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"effectiveDate":"2024-01-01","branch":"string","extensions":{}}},"responses":{"200":"updateDepositBranchResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"PUT","path":"/holdings/deposits/{depositId}/commitments","fullPath":"/api/v7.0.0/holdings/deposits/{depositId}/commitments","operationId":"updateTenure","name":"Update the tenure of the term deposit by providing tenure or maturity date","summary":"Update the tenure of the term amount","tags":["RETAIL"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"depositId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"productId":"string","drawdownDate":"2024-01-01","extensions":{},"commitment":[{}]}},"responses":{"200":"updateTenureResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"PUT","path":"/holdings/deposits/{depositId}/withdrawals","fullPath":"/api/v7.0.0/holdings/deposits/{depositId}/withdrawals","operationId":"withdrawDeposits","name":"Withdraw from the deposit account","summary":"Withdraw from the amount by providing the withdrawal amount","tags":["RETAIL"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"depositId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"partyIds":[{}],"partyRoles":[{}],"agentCustomerIds":[{}],"agentArrangementIds":[{}],"agentRoles":[{}],"arrangmentId":"string","productId":"string","activityId":"string","currency":"string","productVariation":"string","pricingSelection":"string","pricingPlan":"string","rewardsArrangementId":"string","tradeDate":"string","arrangementEffectiveDate":"string"}},"responses":{"200":"withdrawDepositsResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"PUT","path":"/holdings/deposits/{depositId}/renegotiations","fullPath":"/api/v7.0.0/holdings/deposits/{depositId}/renegotiations","operationId":"updateDepositConditions","name":"Perform the renegotiation of the term deposit contract details such as payment frequency, interest rates, etc.","summary":"Renegotiation of the term deposit contract details","tags":["RETAIL"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"depositId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"productId":"string","drawdownDate":"2024-01-01","extensions":{},"account":[{}],"customer":[{}],"schedule":[{}],"settlement":[{}],"commitment":[{}]}},"responses":{"200":"updateDepositConditionsResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"PUT","path":"/holdings/deposits/{depositId}/redemptions","fullPath":"/api/v7.0.0/holdings/deposits/{depositId}/redemptions","operationId":"redeemDeposit","name":"Redeem the term deposit to close the deposit by providing the settlement instructions","summary":"Redeem the term deposit to close the deposit","tags":["RETAIL"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"depositId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"effectiveDate":"2024-01-01","productId":"string"}},"responses":{"200":"RedemptionsDepositResponse","default":"RedemptionsArrangementErrorResponse","400":"RedemptionsBusinessArrangementErrorResponse","500":"RedemptionsSystemArrangementErrorResponse"}},{"method":"POST","path":"/holdings/deposits/simulations","fullPath":"/api/v7.0.0/holdings/deposits/simulations","operationId":"simulateNewdeposit","name":"Simulate a deposit arrangement for the given principal amount, term, payment frequency and interest rates","summary":"Simulate a deposit arrangement for the given principal amount, term, payment frequency and interest rates","tags":["RETAIL"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"customerIds":[{}],"properties":[{}],"overrides":[{}],"productId":"string","masterArrangementId":"string","roleName":"string","currencyId":"string","effectiveDate":"2024-01-01","activityId":"string","transactionAmount":0.0,"reason":"string","simulationRunReference":"string","extensions":{},"account":[{}],"customer":[{}]}},"responses":{"200":"simulateNewdepositResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"POST","path":"/holdings/deposits/migrations","fullPath":"/api/v7.0.0/holdings/deposits/migrations","operationId":"initiateDepositsMigration","name":"Migration of a legacy system deposit contract to the given deposit product by providing the original contract date, account name, statement, payment frequency and start date, etc. This can be used for migrating the legacy contract to deposits account by providing required details.","summary":"Migration of legacy system deposits contract to the given deposits product","tags":["RETAIL"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"partyIds":[{}],"originationReference":[{}],"effectiveDate":"2024-01-01","productId":"string","currency":"string","branch":"string","channel":"string","lineOfBusiness":"string","originalContractDate":"2024-01-01","extensions":{},"account":[{}],"customer":[{}],"schedule":[{}],"renewal":[{}],"settlement":[{}]}},"responses":{"200":"initiateDepositsMigrationResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"PUT","path":"/holdings/deposits/{depositId}/funding","fullPath":"/api/v7.0.0/holdings/deposits/{depositId}/funding","operationId":"fundTermDeposit","name":"Fund the term deposit manually by providing the deposit amount","summary":"Fund the term deposit account","tags":["RETAIL"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"depositId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"currencyId":"string","effectiveDate":"2024-01-01","activityId":"string","transactionAmount":0.0,"contractId":"string","systemId":"string","externalEventStatus":"string","extensions":{}}},"responses":{"200":"fundTermDepositResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"PUT","path":"/holdings/deposits/{depositId}/accounts","fullPath":"/api/v7.0.0/holdings/deposits/{depositId}/accounts","operationId":"updateTermDepositAccount","name":"Update the account conditions of the term deposit such as alternate references, posting restrictions, etc","summary":"Update the account conditions of the term deposit","tags":["RETAIL"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"depositId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"effectiveDate":"2024-01-01","productId":"string","extensions":{},"account":[{}]}},"responses":{"200":"updateTermDepositAccountResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"PUT","path":"/holdings/deposits/{depositId}/migrations/bills","fullPath":"/api/v7.0.0/holdings/deposits/{depositId}/migrations/bills","operationId":"updateDepositsBillMigration","name":"Captures the bill information of the deposits account such as bill id, property names, bill amount etc. This is used to migrate the bills of a legacy contract which is migrated from other system & update the bill details.","summary":"Captures outstanding bill information of a contract migrated from legacy system.","tags":["RETAIL"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"depositId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"effectiveDate":"2024-01-01","productId":"string","extensions":{},"balanceMaintenance":[{}]}},"responses":{"200":"updateDepositsBillMigrationResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"PUT","path":"/holdings/deposits/{depositId}/withdrawal","fullPath":"/api/v7.0.0/holdings/deposits/{depositId}/withdrawal","operationId":"withdrawDeposit","name":"Withdraw from the amount by providing the withdrawal amount","summary":"Withdraw from the deposit account","tags":["RETAIL"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"depositId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"currencyId":"string","effectiveDate":"2024-01-01","activityId":"string","transactionAmount":0.0,"contractId":"string","systemId":"string","externalEventStatus":"string","extensions":{}}},"responses":{"200":"withdrawDepositResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"PUT","path":"/holdings/deposits/{depositId}/products","fullPath":"/api/v7.0.0/holdings/deposits/{depositId}/products","operationId":"updateDepositProduct","name":"Update the contract from one deposit product to another","summary":"Update the contract from one deposit product to another","tags":["RETAIL"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"depositId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"productId":"string","drawdownDate":"2024-01-01","extensions":{},"facility":[{}],"constraint":[{}],"xidDeposit":[{}],"account":[{}],"activityCharges":[{}],"messaging":[{}],"arrangementRules":[{}],"agentCommission":[{}],"rewardsPoints":[{}],"balanceMaintenance":[{}],"adminfees":[{}],"redemptionfee":[{}]}},"responses":{"200":"updateDepositProductResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"PUT","path":"/holdings/deposits/{depositId}/paymentSchedules","fullPath":"/api/v7.0.0/holdings/deposits/{depositId}/paymentSchedules","operationId":"updateDepositSchedule","name":"Update the payment schedule details of the term deposit such as payment frequency, payment type","summary":"Update the payment schedule of the term deposit","tags":["RETAIL"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"depositId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"productId":"string","drawdownDate":"2024-01-01","extensions":{},"schedule":[{}]}},"responses":{"200":"updateDepositScheduleResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"PUT","path":"/holdings/deposits/{depositId}/migrations/balances","fullPath":"/api/v7.0.0/holdings/deposits/{depositId}/migrations/balances","operationId":"updateDepositsBalanceMigration","name":"Captures the balance details of the deposits account such as balance type, due amount etc. This is used to migrate the balances of a legacy contract which is migrated from other system & update the balance details.","summary":"Captures outstanding balance details of of a contract migrated from legacy system.","tags":["RETAIL"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"depositId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"productId":"string","drawdownDate":"2024-01-01","extensions":{},"balanceMaintenance":[{}]}},"responses":{"200":"updateDepositsBalanceMigrationResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"PUT","path":"/holdings/deposits/{depositId}/noticeUpdates","fullPath":"/api/v7.0.0/holdings/deposits/{depositId}/noticeUpdates","operationId":"updateDepositWithdrawalNotice","name":"Updates the notice of withdrawal of amount from deposit account by providing the withdrawal date","summary":"Updates the notice of withdrawal of amount from account ","tags":["RETAIL"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"depositId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"productId":"string","drawdownDate":"2024-01-01","extensions":{},"noticeWithdrawal":[{}]}},"responses":{"200":"updateDepositWithdrawalNoticeResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"PUT","path":"/holdings/deposits/{depositId}/cancellations","fullPath":"/api/v7.0.0/holdings/deposits/{depositId}/cancellations","operationId":"cancelDepositWithdrawalNotice","name":"Cancels the notification of withdrawal of amount from deposit account by providing the withdrawal date","summary":"Cancels the notification of withdrawal of amount from account","tags":["RETAIL"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"depositId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"productId":"string","drawdownDate":"2024-01-01","extensions":{},"noticeWithdrawal":[{}]}},"responses":{"200":"cancelDepositWithdrawalNoticeResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"PUT","path":"/holdings/deposits/{depositId}/withdrawalnotices","fullPath":"/api/v7.0.0/holdings/deposits/{depositId}/withdrawalnotices","operationId":"captureDepositWithdrawalNotice","name":"Notifies the withdrawal of amount from deposit account by providing the withdrawal date and amount etc. This is applicable only for notice type of deposits.","summary":"Notifies the withdrawal of amount from deposit account","tags":["RETAIL"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"depositId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"productId":"string","drawdownDate":"2024-01-01","extensions":{},"noticeWithdrawal":[{}]}},"responses":{"200":"captureDepositWithdrawalNoticeResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"PUT","path":"/holdings/deposits/{depositId}/settlements","fullPath":"/api/v7.0.0/holdings/deposits/{depositId}/settlements","operationId":"updateDepositSettlement","name":"Update the settlement conditions of the term deposit such as payin account, payout account, beneficiary etc","summary":"Update the settlement conditions of the term deposit","tags":["RETAIL"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"depositId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"productId":"string","drawdownDate":"2024-01-01","extensions":{},"settlement":[{}]}},"responses":{"200":"updateDepositSettlementResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"PUT","path":"/holdings/deposits/{depositId}/customers","fullPath":"/api/v7.0.0/holdings/deposits/{depositId}/customers","operationId":"updateDepositCustomer","name":"Update the customer details of the term deposit such as add or remove joint customers","summary":"Update the customer details of the term deposit","tags":["RETAIL"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"depositId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"partyIds":[{}],"effectiveDate":"2024-01-01","extensions":{},"statement":[{}]}},"responses":{"200":"updateDepositCustomerResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"PUT","path":"/holdings/deposits/{depositId}/interestConditions","fullPath":"/api/v7.0.0/holdings/deposits/{depositId}/interestConditions","operationId":"updateDepositInterest","name":"Update the interest conditions of the term deposit such as interest rate, spread, margin etc","summary":"Update the interest conditions of the term deposit","tags":["RETAIL"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"depositId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"productId":"string","drawdownDate":"2024-01-01","extensions":{}}},"responses":{"200":"updateDepositInterestResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"POST","path":"/holdings/deposits/shortTermDeposits","fullPath":"/api/v7.0.0/holdings/deposits/shortTermDeposits","operationId":"createShortTermDeposit","name":"Creates a short-term deposit that includes customer identifier, customer role, deposit currency, deposit amount, term, etc.","summary":"Create a short term deposit account","tags":[],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"partyIds":[{}],"partyRoles":[{}],"agentCustomerIds":[{}],"agentArrangementIds":[{}],"agentRoles":[{}],"arrangmentId":"string","productId":"string","activityId":"string","currency":"string","productVariation":"string","pricingSelection":"string","pricingPlan":"string","rewardsArrangementId":"string","tradeDate":"string","arrangementEffectiveDate":"string"}},"responses":{"200":"createShortTermDepositResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"POST","path":"/holdings/deposits/oneYearBonds","fullPath":"/api/v7.0.0/holdings/deposits/oneYearBonds","operationId":"createOneYearBond","name":"Creates a one-year bond that includes customer identifier, customer role, bond currency, bond amount, etc.","summary":"Creates a one year bond/deposit account","tags":[],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"partyIds":[{}],"partyRoles":[{}],"agentCustomerIds":[{}],"agentArrangementIds":[{}],"agentRoles":[{}],"arrangmentId":"string","productId":"string","activityId":"string","currency":"string","productVariation":"string","pricingSelection":"string","pricingPlan":"string","rewardsArrangementId":"string","tradeDate":"string","arrangementEffectiveDate":"string"}},"responses":{"200":"createOneYearBondResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"POST","path":"/holdings/deposits/threeYearBonds","fullPath":"/api/v7.0.0/holdings/deposits/threeYearBonds","operationId":"createThreeYearBond","name":"Creates a three-year bond that includes customer identifier, customer role, bond currency, bond amount, etc.","summary":"Creates a three year bond/deposit account","tags":[],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"partyIds":[{}],"partyRoles":[{}],"agentCustomerIds":[{}],"agentArrangementIds":[{}],"agentRoles":[{}],"arrangmentId":"string","productId":"string","activityId":"string","currency":"string","productVariation":"string","pricingSelection":"string","pricingPlan":"string","rewardsArrangementId":"string","tradeDate":"string","arrangementEffectiveDate":"string"}},"responses":{"200":"createThreeYearBondResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"POST","path":"/holdings/deposits/longTermDeposits","fullPath":"/api/v7.0.0/holdings/deposits/longTermDeposits","operationId":"createLongTermDeposit","name":"Creates long-term deposits that includes customer identifier, customer role, deposit currency, deposit amount, term, etc.","summary":"Creates a long term deposit account","tags":[],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"partyIds":[{}],"partyRoles":[{}],"agentCustomerIds":[{}],"agentArrangementIds":[{}],"agentRoles":[{}],"arrangmentId":"string","productId":"string","activityId":"string","currency":"string","productVariation":"string","pricingSelection":"string","pricingPlan":"string","rewardsArrangementId":"string","tradeDate":"string","arrangementEffectiveDate":"string"}},"responses":{"200":"createLongTermDepositResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"POST","path":"/holdings/deposits/callDeposits","fullPath":"/api/v7.0.0/holdings/deposits/callDeposits","operationId":"createCallDeposit","name":"Creates call deposits which have no fixed term or maturity period that includes customer identifier, customer role, deposit currency, deposit amount, etc.","summary":"Create a call deposit account (No term or period)","tags":[],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"partyIds":[{}],"partyRoles":[{}],"agentCustomerIds":[{}],"agentArrangementIds":[{}],"agentRoles":[{}],"arrangmentId":"string","productId":"string","activityId":"string","currency":"string","productVariation":"string","pricingSelection":"string","pricingPlan":"string","rewardsArrangementId":"string","tradeDate":"string","arrangementEffectiveDate":"string"}},"responses":{"200":"createCallDepositResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"POST","path":"/holdings/deposits/mudarabaDeposits","fullPath":"/api/v7.0.0/holdings/deposits/mudarabaDeposits","operationId":"createMudarabaDeposit","name":"Creates Islamic mudarba deposits that includes customer identifier, customer role, deposit currency, deposit amount,term etc.","summary":"Create a mudaraba deposit account","tags":[],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"partyIds":[{}],"partyRoles":[{}],"agentCustomerIds":[{}],"agentArrangementIds":[{}],"agentRoles":[{}],"arrangmentId":"string","productId":"string","activityId":"string","currency":"string","productVariation":"string","pricingSelection":"string","pricingPlan":"string","rewardsArrangementId":"string","tradeDate":"string","arrangementEffectiveDate":"string"}},"responses":{"200":"createMudarabaDepositResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"POST","path":"/holdings/deposits/redeemDeposits","fullPath":"/api/v7.0.0/holdings/deposits/redeemDeposits","operationId":"redeemDeposits","name":"Creates redeem deposits that includes settlement instructions to which the deposit amount is to be credited. Common usage of this is when customers want to withdraw their deposits before the actual maturity date of the deposits.","summary":"Redeem a deposit","tags":[],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"partyIds":[{}],"partyRoles":[{}],"agentCustomerIds":[{}],"agentArrangementIds":[{}],"agentRoles":[{}],"arrangmentId":"string","productId":"string","activityId":"string","currency":"string","productVariation":"string","pricingSelection":"string","pricingPlan":"string","rewardsArrangementId":"string","tradeDate":"string","arrangementEffectiveDate":"string"}},"responses":{"200":"redeemDepositsResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"POST","path":"/holdings/deposits/redeemDeposits/{arrangementId}","fullPath":"/api/v7.0.0/holdings/deposits/redeemDeposits/{arrangementId}","operationId":"simulateRedeemDeposits","name":"Simulates a deposit redemption that includes the settlement instructions to which the deposit amount is to be credited. Common usage of this is for simulating withdrawals when customers want to withdraw their deposits before the actual fixed maturity date of the deposits.","summary":"Simulate a deposit redemption","tags":[],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"arrangementId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"partyIds":[{}],"partyRoles":[{}],"agentCustomerIds":[{}],"agentArrangementIds":[{}],"agentRoles":[{}],"arrangmentId":"string","productId":"string","activityId":"string","currency":"string","productVariation":"string","pricingSelection":"string","pricingPlan":"string","rewardsArrangementId":"string","tradeDate":"string","arrangementEffectiveDate":"string"}},"responses":{"200":"simulateRedeemDepositsResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"GET","path":"/holdings/deposits/{arrangementId}/chargeAmount","fullPath":"/api/v7.0.0/holdings/deposits/{arrangementId}/chargeAmount","operationId":"getChargeAmount","name":"Retrieves the charge amount for a given charge property that includes charge identifier, simulation reference, etc.","summary":"Retrieves the charge amount for a given charge property","tags":[],"parameters":[{"name":"arrangementId","in":"path","type":"string","required":true,"description":"Indicates an unique identifier of an account"},{"name":"chargeProperty","in":"query","type":"string","required":true,"description":"Contains the charge name which is corresponding to the calculated charge amount"},{"name":"simulationReference","in":"query","type":"string","required":true,"description":"Indicates the Reference ID for simulation activity"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from t24 on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"ChargeAmountResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"POST","path":"/holdings/deposits/wakalaDeposits","fullPath":"/api/v7.0.0/holdings/deposits/wakalaDeposits","operationId":"createWakalaDeposit","name":"Creates Islamic wakala  deposits that includes customer identifier, customer role,  deposit currency, deposit amount and the fixed term of the deposit etc.","summary":"Create a wakala deposit account","tags":[],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"partyIds":[{}],"partyRoles":[{}],"agentCustomerIds":[{}],"agentArrangementIds":[{}],"agentRoles":[{}],"arrangmentId":"string","productId":"string","activityId":"string","currency":"string","productVariation":"string","pricingSelection":"string","pricingPlan":"string","rewardsArrangementId":"string","tradeDate":"string","arrangementEffectiveDate":"string"}},"responses":{"200":"createWakalaDepositResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"GET","path":"/holdings/deposits/{depositId}","fullPath":"/api/v7.0.0/holdings/deposits/{depositId}","operationId":"getDepositDetails","name":"Retrieves the basic information of the deposit account including deposit amount, term, maturity days, tax details, charge details, etc. Common usage of this could be to display the basic information of deposits in a customer user interface.","summary":"Retrieves the deposit details","tags":[],"parameters":[{"name":"depositId","in":"path","type":"string","required":true,"description":"Indicates the Id of the deposit account"},{"name":"balanceTypes","in":"query","type":"string","required":false,"description":"Type of balance (e.g. current balance, credit interest accrued, deferred commission, etc.) as defined in the institution's accounting schemas."},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from t24 on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"DepositDetailsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/deposits/{depositId}/redemptions/bills","fullPath":"/api/v7.0.0/holdings/deposits/{depositId}/redemptions/bills","operationId":"getRedeemDepositBillDetails","name":"Retrieves the redeem bill for the given deposit by providing the deposit reference and simulation reference for simulated deposits","summary":"Retrieves the redeem bill for the given deposit","tags":["RETAIL"],"parameters":[{"name":"depositId","in":"path","type":"string","required":true,"description":"Indicates the Id of the deposit account"},{"name":"simulationReference","in":"query","type":"string","required":false,"description":"Indicates the reference id for simulation activity"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"RedeemDepositBillDetailsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"PUT","path":"/holdings/deposits/simulations/{simulationId}","fullPath":"/api/v7.0.0/holdings/deposits/simulations/{simulationId}","operationId":"updateDepositSimulation","name":"Amend a simulation for deposit product that includes customer identifier, currency, etc.","summary":"Amend simulation for deposit products","tags":["RETAIL"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"simulationId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"customerIds":[{}],"properties":[{}],"overrides":[{}],"productId":"string","masterArrangementId":"string","roleName":"string","currencyId":"string","effectiveDate":"2024-01-01","activityId":"string","transactionAmount":0.0,"reason":"string","automaticRun":"string","simulationRunReference":"string","synchronous":"string","account":[{}]}},"responses":{"200":"updateDepositSimulationResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}}]},{"key":"holdings-deposits-arrangements-v7.2.0","title":"Deposit Arrangements","version":"v7.2.0","description":"The arrangement architecture is a Temenos Transact framework to create and manage various products such as loans, deposits, accounts, etc. It provides a modular business component-based architecture, whereby users can create their products by using the components provided by Temenos and these compon","endpointCount":35,"endpoints":[{"method":"POST","path":"/holdings/deposits/termDeposits","fullPath":"/api/v7.2.0/holdings/deposits/termDeposits","operationId":"createDeposits","name":"Creates term deposits that includes customer identifier, customer role, deposit currency, deposit amount and the deposit duration term etc.","summary":"Create a deposit account","tags":["RETAIL"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"partyIds":[{}],"partyRoles":[{}],"agentCustomerIds":[{}],"agentArrangementIds":[{}],"agentRoles":[{}],"arrangmentId":"string","productId":"string","activityId":"string","currency":"string","productVariation":"string","pricingSelection":"string","pricingPlan":"string","rewardsArrangementId":"string","tradeDate":"string","arrangementEffectiveDate":"string"}},"responses":{"200":"createDepositsResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"PUT","path":"/holdings/deposits/{depositId}/rollovers","fullPath":"/api/v7.2.0/holdings/deposits/{depositId}/rollovers","operationId":"updateDepositRollover","name":"Perform the rollover of the deposit for the given rollover date or period","summary":"Perform the rollover of the deposit","tags":["RETAIL"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"depositId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"productId":"string","effectiveDate":"2024-01-01","extensions":{},"depositint":[{}],"schedule":[{}],"renewal":[{}],"settlement":[{}],"commitment":[{}]}},"responses":{"200":"updateDepositRolloverResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"PUT","path":"/holdings/deposits/{depositId}/branches","fullPath":"/api/v7.2.0/holdings/deposits/{depositId}/branches","operationId":"updateDepositBranch","name":"Update the branch for the deposit","summary":"Update the branch for the deposit","tags":["RETAIL"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"depositId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"effectiveDate":"2024-01-01","branch":"string","extensions":{}}},"responses":{"200":"updateDepositBranchResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"PUT","path":"/holdings/deposits/{depositId}/commitments","fullPath":"/api/v7.2.0/holdings/deposits/{depositId}/commitments","operationId":"updateTenure","name":"Update the tenure of the term deposit by providing tenure or maturity date","summary":"Update the tenure of the term amount","tags":["RETAIL"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"depositId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"productId":"string","effectiveDate":"2024-01-01","extensions":{},"commitment":[{}]}},"responses":{"200":"updateTenureResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"PUT","path":"/holdings/deposits/{depositId}/withdrawals","fullPath":"/api/v7.2.0/holdings/deposits/{depositId}/withdrawals","operationId":"withdrawDeposits","name":"Withdraw from the deposit account","summary":"Withdraw from the amount by providing the withdrawal amount","tags":["RETAIL"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"depositId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"partyIds":[{}],"partyRoles":[{}],"agentCustomerIds":[{}],"agentArrangementIds":[{}],"agentRoles":[{}],"arrangmentId":"string","productId":"string","activityId":"string","currency":"string","productVariation":"string","pricingSelection":"string","pricingPlan":"string","rewardsArrangementId":"string","tradeDate":"string","arrangementEffectiveDate":"string"}},"responses":{"200":"withdrawDepositsResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"PUT","path":"/holdings/deposits/{depositId}/renegotiations","fullPath":"/api/v7.2.0/holdings/deposits/{depositId}/renegotiations","operationId":"updateDepositConditions","name":"Perform the renegotiation of the term deposit contract details such as payment frequency, interest rates, etc.","summary":"Renegotiation of the term deposit contract details","tags":["RETAIL"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"depositId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"productId":"string","effectiveDate":"2024-01-01","extensions":{},"account":[{}],"customer":[{}],"schedule":[{}],"settlement":[{}],"commitment":[{}]}},"responses":{"200":"updateDepositConditionsResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"PUT","path":"/holdings/deposits/{depositId}/redemptions","fullPath":"/api/v7.2.0/holdings/deposits/{depositId}/redemptions","operationId":"redeemDeposit","name":"Redeem the term deposit to close the deposit by providing the settlement instructions","summary":"Redeem the term deposit to close the deposit","tags":["RETAIL"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"depositId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"effectiveDate":"2024-01-01","productId":"string"}},"responses":{"200":"RedemptionsDepositResponse","default":"RedemptionsArrangementErrorResponse","400":"RedemptionsBusinessArrangementErrorResponse","500":"RedemptionsSystemArrangementErrorResponse"}},{"method":"POST","path":"/holdings/deposits/simulations","fullPath":"/api/v7.2.0/holdings/deposits/simulations","operationId":"simulateNewdeposit","name":"Simulate a deposit arrangement for the given principal amount, term, payment frequency and interest rates","summary":"Simulate a deposit arrangement for the given principal amount, term, payment frequency and interest rates","tags":["RETAIL"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"customerIds":[{}],"properties":[{}],"overrides":[{}],"productId":"string","masterArrangementId":"string","roleName":"string","currencyId":"string","effectiveDate":"2024-01-01","activityId":"string","transactionAmount":0.0,"reason":"string","simulationRunReference":"string","extensions":{},"account":[{}],"customer":[{}]}},"responses":{"200":"simulateNewdepositResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"POST","path":"/holdings/deposits/migrations","fullPath":"/api/v7.2.0/holdings/deposits/migrations","operationId":"initiateDepositsMigration","name":"Migration of a legacy system deposit contract to the given deposit product by providing the original contract date, account name, statement, payment frequency and start date, etc. This can be used for migrating the legacy contract to deposits account by providing required details.","summary":"Migration of legacy system deposits contract to the given deposits product","tags":["RETAIL"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"partyIds":[{}],"originationReference":[{}],"effectiveDate":"2024-01-01","productId":"string","currency":"string","branch":"string","channel":"string","lineOfBusiness":"string","originalContractDate":"2024-01-01","extensions":{},"account":[{}],"customer":[{}],"schedule":[{}],"renewal":[{}],"settlement":[{}]}},"responses":{"200":"initiateDepositsMigrationResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"PUT","path":"/holdings/deposits/{depositId}/funding","fullPath":"/api/v7.2.0/holdings/deposits/{depositId}/funding","operationId":"fundTermDeposit","name":"Fund the term deposit manually by providing the deposit amount","summary":"Fund the term deposit account","tags":["RETAIL"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"depositId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"currencyId":"string","effectiveDate":"2024-01-01","activityId":"string","transactionAmount":0.0,"contractId":"string","systemId":"string","externalEventStatus":"string","extensions":{}}},"responses":{"200":"fundTermDepositResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"PUT","path":"/holdings/deposits/{depositId}/accounts","fullPath":"/api/v7.2.0/holdings/deposits/{depositId}/accounts","operationId":"updateTermDepositAccount","name":"Update the account conditions of the term deposit such as alternate references, posting restrictions, etc","summary":"Update the account conditions of the term deposit","tags":["RETAIL"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"depositId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"effectiveDate":"2024-01-01","productId":"string","extensions":{},"account":[{}]}},"responses":{"200":"updateTermDepositAccountResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"PUT","path":"/holdings/deposits/{depositId}/migrations/bills","fullPath":"/api/v7.2.0/holdings/deposits/{depositId}/migrations/bills","operationId":"updateDepositsBillMigration","name":"Captures the bill information of the deposits account such as bill id, property names, bill amount etc. This is used to migrate the bills of a legacy contract which is migrated from other system & update the bill details.","summary":"Captures outstanding bill information of a contract migrated from legacy system.","tags":["RETAIL"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"depositId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"effectiveDate":"2024-01-01","productId":"string","extensions":{},"balanceMaintenance":[{}]}},"responses":{"200":"updateDepositsBillMigrationResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"PUT","path":"/holdings/deposits/{depositId}/withdrawal","fullPath":"/api/v7.2.0/holdings/deposits/{depositId}/withdrawal","operationId":"withdrawDeposit","name":"Withdraw from the amount by providing the withdrawal amount","summary":"Withdraw from the deposit account","tags":["RETAIL"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"depositId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"currencyId":"string","effectiveDate":"2024-01-01","activityId":"string","transactionAmount":0.0,"contractId":"string","systemId":"string","externalEventStatus":"string","extensions":{}}},"responses":{"200":"withdrawDepositResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"PUT","path":"/holdings/deposits/{depositId}/products","fullPath":"/api/v7.2.0/holdings/deposits/{depositId}/products","operationId":"updateDepositProduct","name":"Update the contract from one deposit product to another","summary":"Update the contract from one deposit product to another","tags":["RETAIL"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"depositId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"productId":"string","effectiveDate":"2024-01-01","extensions":{},"facility":[{}],"constraint":[{}],"xidDeposit":[{}],"account":[{}],"activityCharges":[{}],"messaging":[{}],"arrangementRules":[{}],"agentCommission":[{}],"rewardsPoints":[{}],"balanceMaintenance":[{}],"adminfees":[{}],"redemptionfee":[{}]}},"responses":{"200":"updateDepositProductResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"PUT","path":"/holdings/deposits/{depositId}/paymentSchedules","fullPath":"/api/v7.2.0/holdings/deposits/{depositId}/paymentSchedules","operationId":"updateDepositSchedule","name":"Update the payment schedule details of the term deposit such as payment frequency, payment type","summary":"Update the payment schedule of the term deposit","tags":["RETAIL"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"depositId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"productId":"string","effectiveDate":"2024-01-01","extensions":{},"schedule":[{}]}},"responses":{"200":"updateDepositScheduleResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"PUT","path":"/holdings/deposits/{depositId}/migrations/balances","fullPath":"/api/v7.2.0/holdings/deposits/{depositId}/migrations/balances","operationId":"updateDepositsBalanceMigration","name":"Captures the balance details of the deposits account such as balance type, due amount etc. This is used to migrate the balances of a legacy contract which is migrated from other system & update the balance details.","summary":"Captures outstanding balance details of of a contract migrated from legacy system.","tags":["RETAIL"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"depositId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"productId":"string","effectiveDate":"2024-01-01","extensions":{},"balanceMaintenance":[{}]}},"responses":{"200":"updateDepositsBalanceMigrationResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"PUT","path":"/holdings/deposits/{depositId}/noticeUpdates","fullPath":"/api/v7.2.0/holdings/deposits/{depositId}/noticeUpdates","operationId":"updateDepositWithdrawalNotice","name":"Updates the notice of withdrawal of amount from deposit account by providing the withdrawal date","summary":"Updates the notice of withdrawal of amount from account ","tags":["RETAIL"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"depositId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"productId":"string","effectiveDate":"2024-01-01","extensions":{},"noticeWithdrawal":[{}]}},"responses":{"200":"updateDepositWithdrawalNoticeResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"PUT","path":"/holdings/deposits/{depositId}/cancellations","fullPath":"/api/v7.2.0/holdings/deposits/{depositId}/cancellations","operationId":"cancelDepositWithdrawalNotice","name":"Cancels the notification of withdrawal of amount from deposit account by providing the withdrawal date","summary":"Cancels the notification of withdrawal of amount from account","tags":["RETAIL"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"depositId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"productId":"string","effectiveDate":"2024-01-01","extensions":{},"noticeWithdrawal":[{}]}},"responses":{"200":"cancelDepositWithdrawalNoticeResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"PUT","path":"/holdings/deposits/{depositId}/withdrawalnotices","fullPath":"/api/v7.2.0/holdings/deposits/{depositId}/withdrawalnotices","operationId":"captureDepositWithdrawalNotice","name":"Notifies the withdrawal of amount from deposit account by providing the withdrawal date and amount etc. This is applicable only for notice type of deposits.","summary":"Notifies the withdrawal of amount from deposit account","tags":["RETAIL"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"depositId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"productId":"string","effectiveDate":"2024-01-01","extensions":{},"noticeWithdrawal":[{}]}},"responses":{"200":"captureDepositWithdrawalNoticeResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"PUT","path":"/holdings/deposits/{depositId}/settlements","fullPath":"/api/v7.2.0/holdings/deposits/{depositId}/settlements","operationId":"updateDepositSettlement","name":"Update the settlement conditions of the term deposit such as payin account, payout account, beneficiary etc","summary":"Update the settlement conditions of the term deposit","tags":["RETAIL"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"depositId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"productId":"string","effectiveDate":"2024-01-01","extensions":{},"settlement":[{}]}},"responses":{"200":"updateDepositSettlementResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"PUT","path":"/holdings/deposits/{depositId}/customers","fullPath":"/api/v7.2.0/holdings/deposits/{depositId}/customers","operationId":"updateDepositCustomer","name":"Update the customer details of the term deposit such as add or remove joint customers","summary":"Update the customer details of the term deposit","tags":["RETAIL"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"depositId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"partyIds":[{}],"effectiveDate":"2024-01-01","extensions":{},"statement":[{}]}},"responses":{"200":"updateDepositCustomerResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"PUT","path":"/holdings/deposits/{depositId}/interestConditions","fullPath":"/api/v7.2.0/holdings/deposits/{depositId}/interestConditions","operationId":"updateDepositInterest","name":"Update the interest conditions of the term deposit such as interest rate, spread, margin etc","summary":"Update the interest conditions of the term deposit","tags":["RETAIL"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"depositId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"productId":"string","effectiveDate":"2024-01-01","extensions":{}}},"responses":{"200":"updateDepositInterestResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"POST","path":"/holdings/deposits/shortTermDeposits","fullPath":"/api/v7.2.0/holdings/deposits/shortTermDeposits","operationId":"createShortTermDeposit","name":"Creates a short-term deposit that includes customer identifier, customer role, deposit currency, deposit amount, term, etc.","summary":"Create a short term deposit account","tags":[],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"partyIds":[{}],"partyRoles":[{}],"agentCustomerIds":[{}],"agentArrangementIds":[{}],"agentRoles":[{}],"arrangmentId":"string","productId":"string","activityId":"string","currency":"string","productVariation":"string","pricingSelection":"string","pricingPlan":"string","rewardsArrangementId":"string","tradeDate":"string","arrangementEffectiveDate":"string"}},"responses":{"200":"createShortTermDepositResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"POST","path":"/holdings/deposits/oneYearBonds","fullPath":"/api/v7.2.0/holdings/deposits/oneYearBonds","operationId":"createOneYearBond","name":"Creates a one-year bond that includes customer identifier, customer role, bond currency, bond amount, etc.","summary":"Creates a one year bond/deposit account","tags":[],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"partyIds":[{}],"partyRoles":[{}],"agentCustomerIds":[{}],"agentArrangementIds":[{}],"agentRoles":[{}],"arrangmentId":"string","productId":"string","activityId":"string","currency":"string","productVariation":"string","pricingSelection":"string","pricingPlan":"string","rewardsArrangementId":"string","tradeDate":"string","arrangementEffectiveDate":"string"}},"responses":{"200":"createOneYearBondResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"POST","path":"/holdings/deposits/threeYearBonds","fullPath":"/api/v7.2.0/holdings/deposits/threeYearBonds","operationId":"createThreeYearBond","name":"Creates a three-year bond that includes customer identifier, customer role, bond currency, bond amount, etc.","summary":"Creates a three year bond/deposit account","tags":[],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"partyIds":[{}],"partyRoles":[{}],"agentCustomerIds":[{}],"agentArrangementIds":[{}],"agentRoles":[{}],"arrangmentId":"string","productId":"string","activityId":"string","currency":"string","productVariation":"string","pricingSelection":"string","pricingPlan":"string","rewardsArrangementId":"string","tradeDate":"string","arrangementEffectiveDate":"string"}},"responses":{"200":"createThreeYearBondResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"POST","path":"/holdings/deposits/longTermDeposits","fullPath":"/api/v7.2.0/holdings/deposits/longTermDeposits","operationId":"createLongTermDeposit","name":"Creates long-term deposits that includes customer identifier, customer role, deposit currency, deposit amount, term, etc.","summary":"Creates a long term deposit account","tags":[],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"partyIds":[{}],"partyRoles":[{}],"agentCustomerIds":[{}],"agentArrangementIds":[{}],"agentRoles":[{}],"arrangmentId":"string","productId":"string","activityId":"string","currency":"string","productVariation":"string","pricingSelection":"string","pricingPlan":"string","rewardsArrangementId":"string","tradeDate":"string","arrangementEffectiveDate":"string"}},"responses":{"200":"createLongTermDepositResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"POST","path":"/holdings/deposits/callDeposits","fullPath":"/api/v7.2.0/holdings/deposits/callDeposits","operationId":"createCallDeposit","name":"Creates call deposits which have no fixed term or maturity period that includes customer identifier, customer role, deposit currency, deposit amount, etc.","summary":"Create a call deposit account (No term or period)","tags":[],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"partyIds":[{}],"partyRoles":[{}],"agentCustomerIds":[{}],"agentArrangementIds":[{}],"agentRoles":[{}],"arrangmentId":"string","productId":"string","activityId":"string","currency":"string","productVariation":"string","pricingSelection":"string","pricingPlan":"string","rewardsArrangementId":"string","tradeDate":"string","arrangementEffectiveDate":"string"}},"responses":{"200":"createCallDepositResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"POST","path":"/holdings/deposits/mudarabaDeposits","fullPath":"/api/v7.2.0/holdings/deposits/mudarabaDeposits","operationId":"createMudarabaDeposit","name":"Creates Islamic mudarba deposits that includes customer identifier, customer role, deposit currency, deposit amount,term etc.","summary":"Create a mudaraba deposit account","tags":[],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"partyIds":[{}],"partyRoles":[{}],"agentCustomerIds":[{}],"agentArrangementIds":[{}],"agentRoles":[{}],"arrangmentId":"string","productId":"string","activityId":"string","currency":"string","productVariation":"string","pricingSelection":"string","pricingPlan":"string","rewardsArrangementId":"string","tradeDate":"string","arrangementEffectiveDate":"string"}},"responses":{"200":"createMudarabaDepositResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"POST","path":"/holdings/deposits/redeemDeposits","fullPath":"/api/v7.2.0/holdings/deposits/redeemDeposits","operationId":"redeemDeposits","name":"Creates redeem deposits that includes settlement instructions to which the deposit amount is to be credited. Common usage of this is when customers want to withdraw their deposits before the actual maturity date of the deposits.","summary":"Redeem a deposit","tags":[],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"partyIds":[{}],"partyRoles":[{}],"agentCustomerIds":[{}],"agentArrangementIds":[{}],"agentRoles":[{}],"arrangmentId":"string","productId":"string","activityId":"string","currency":"string","productVariation":"string","pricingSelection":"string","pricingPlan":"string","rewardsArrangementId":"string","tradeDate":"string","arrangementEffectiveDate":"string"}},"responses":{"200":"redeemDepositsResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"POST","path":"/holdings/deposits/redeemDeposits/{arrangementId}","fullPath":"/api/v7.2.0/holdings/deposits/redeemDeposits/{arrangementId}","operationId":"simulateRedeemDeposits","name":"Simulates a deposit redemption that includes the settlement instructions to which the deposit amount is to be credited. Common usage of this is for simulating withdrawals when customers want to withdraw their deposits before the actual fixed maturity date of the deposits.","summary":"Simulate a deposit redemption","tags":[],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"arrangementId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"partyIds":[{}],"partyRoles":[{}],"agentCustomerIds":[{}],"agentArrangementIds":[{}],"agentRoles":[{}],"arrangmentId":"string","productId":"string","activityId":"string","currency":"string","productVariation":"string","pricingSelection":"string","pricingPlan":"string","rewardsArrangementId":"string","tradeDate":"string","arrangementEffectiveDate":"string"}},"responses":{"200":"simulateRedeemDepositsResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"GET","path":"/holdings/deposits/{arrangementId}/chargeAmount","fullPath":"/api/v7.2.0/holdings/deposits/{arrangementId}/chargeAmount","operationId":"getChargeAmount","name":"Retrieves the charge amount for a given charge property that includes charge identifier, simulation reference, etc.","summary":"Retrieves the charge amount for a given charge property","tags":[],"parameters":[{"name":"arrangementId","in":"path","type":"string","required":true,"description":"Indicates an unique identifier of an account"},{"name":"chargeProperty","in":"query","type":"string","required":true,"description":"Contains the charge name which is corresponding to the calculated charge amount"},{"name":"simulationReference","in":"query","type":"string","required":true,"description":"Indicates the Reference ID for simulation activity"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from t24 on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"ChargeAmountResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"POST","path":"/holdings/deposits/wakalaDeposits","fullPath":"/api/v7.2.0/holdings/deposits/wakalaDeposits","operationId":"createWakalaDeposit","name":"Creates Islamic wakala  deposits that includes customer identifier, customer role,  deposit currency, deposit amount and the fixed term of the deposit etc.","summary":"Create a wakala deposit account","tags":[],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"partyIds":[{}],"partyRoles":[{}],"agentCustomerIds":[{}],"agentArrangementIds":[{}],"agentRoles":[{}],"arrangmentId":"string","productId":"string","activityId":"string","currency":"string","productVariation":"string","pricingSelection":"string","pricingPlan":"string","rewardsArrangementId":"string","tradeDate":"string","arrangementEffectiveDate":"string"}},"responses":{"200":"createWakalaDepositResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"GET","path":"/holdings/deposits/{depositId}","fullPath":"/api/v7.2.0/holdings/deposits/{depositId}","operationId":"getDepositDetails","name":"Retrieves the basic information of the deposit account including deposit amount, term, maturity days, tax details, charge details, etc. Common usage of this could be to display the basic information of deposits in a customer user interface.","summary":"Retrieves the deposit details","tags":[],"parameters":[{"name":"depositId","in":"path","type":"string","required":true,"description":"Indicates the Id of the deposit account"},{"name":"balanceTypes","in":"query","type":"string","required":false,"description":"Type of balance (e.g. current balance, credit interest accrued, deferred commission, etc.) as defined in the institution's accounting schemas."},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from t24 on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"DepositDetailsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/deposits/{depositId}/redemptions/bills","fullPath":"/api/v7.2.0/holdings/deposits/{depositId}/redemptions/bills","operationId":"getRedeemDepositBillDetails","name":"Retrieves the redeem bill for the given deposit by providing the deposit reference and simulation reference for simulated deposits","summary":"Retrieves the redeem bill for the given deposit","tags":["RETAIL"],"parameters":[{"name":"depositId","in":"path","type":"string","required":true,"description":"Indicates the Id of the deposit account"},{"name":"simulationReference","in":"query","type":"string","required":false,"description":"Indicates the reference id for simulation activity"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"RedeemDepositBillDetailsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"PUT","path":"/holdings/deposits/simulations/{simulationId}","fullPath":"/api/v7.2.0/holdings/deposits/simulations/{simulationId}","operationId":"updateDepositSimulation","name":"Amend a simulation for deposit product that includes customer identifier, currency, etc.","summary":"Amend simulation for deposit products","tags":["RETAIL"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"simulationId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"customerIds":[{}],"properties":[{}],"overrides":[{}],"productId":"string","masterArrangementId":"string","roleName":"string","currencyId":"string","effectiveDate":"2024-01-01","activityId":"string","transactionAmount":0.0,"reason":"string","automaticRun":"string","simulationRunReference":"string","synchronous":"string","account":[{}]}},"responses":{"200":"updateDepositSimulationResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}}]},{"key":"holdings-deposits-service-v1.0.0","title":"Holdings Deposits APIs","version":"v1.0.0","description":"Get and manage Holdings Deposits","endpointCount":3,"endpoints":[{"method":"GET","path":"/holdings/deposits/{depositId}","fullPath":"/api/v1.0.0/holdings/deposits/{depositId}","operationId":"getDepositDetails","name":"Retrieves deposit details - Deprecated. Use holdings-deposits-service-v1.1.0 instead","summary":"Retrieves the deposit account details","tags":[],"parameters":[{"name":"depositId","in":"path","type":"string","required":true,"description":"Indicates the Id of the deposit account"},{"name":"balanceTypes","in":"query","type":"string","required":false,"description":"Type of balance (e.g. current balance, credit interest accrued, deferred commission, etc.) as defined in the institution's accounting schemas."},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"DepositDetailsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/deposits/{depositId}/bills","fullPath":"/api/v1.0.0/holdings/deposits/{depositId}/bills","operationId":"getDepositBillDetails","name":"Retrieves deposit bill details","summary":"Retrieves the simulation details for the full withdrawal of the funds in a deposit (redemption) based on the selection criteria","tags":[],"parameters":[{"name":"depositId","in":"path","type":"string","required":true,"description":"Indicates the Id of the deposit account"},{"name":"simulationReference","in":"query","type":"string","required":false,"description":"Indicates the Reference ID for simulation activity"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"DepositBillDetailsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/deposits/{simulationCaptureReferenceId}/partialBills","fullPath":"/api/v1.0.0/holdings/deposits/{simulationCaptureReferenceId}/partialBills","operationId":"getDepositPartialBills","name":"Retrieves deposit partial bills details","summary":"Retrieves the charge and interest details of the partial bills, based on the selection criteria, the simulation capture reference Id. Not passing a simulation reference Id will return all the simulation reference records","tags":[],"parameters":[{"name":"simulationCaptureReferenceId","in":"path","type":"string","required":true,"description":"Indicates the Reference Id for the simulation activity"},{"name":"arrangementId","in":"query","type":"string","required":false,"description":"Indicates an unique identifier of an account"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"DepositPartialBillsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}}]},{"key":"holdings-deposits-service-v1.1.0","title":"Holdings Deposits APIs","version":"v1.1.0","description":"Get and manage Holdings Deposits","endpointCount":1,"endpoints":[{"method":"GET","path":"/holdings/deposits/{depositId}","fullPath":"/api/v1.1.0/holdings/deposits/{depositId}","operationId":"getDepositDetails","name":"Retrieve the overview information of deposit account-This API is deprecated","summary":"Retrieves the deposit Overview","tags":[],"parameters":[{"name":"depositId","in":"path","type":"string","required":true,"description":"Indicates the Id of the deposit account"},{"name":"balanceTypes","in":"query","type":"string","required":false,"description":"Type of balance (e.g. current balance, credit interest accrued, deferred commission, etc.) as defined in the institution's accounting schemas."},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from t24 on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"DepositDetailsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}}]},{"key":"holdings-derivativesOptions-service-v1.0.0","title":"Derivative Instrument Operations","version":"v1.0.0","description":"Allows the viewing and creation of option contracts to assign/exercise/expire based on either the trade reference selected or the trades filtered based on - Derivatives Contract, Maturity Date, Options(Call / Put) and Strike Price","endpointCount":6,"endpoints":[{"method":"GET","path":"/holdings/instruments/options/assigns","fullPath":"/api/v1.0.0/holdings/instruments/options/assigns","operationId":"getSellOptionTrades","name":"Retrieves the sell option contracts","summary":"Retrieves sell option trades","tags":[],"parameters":[{"name":"portfolioId","in":"query","type":"string","required":false,"description":"Id of the portfolio or security account"},{"name":"contractId","in":"query","type":"string","required":false,"description":"The identifier of the contract"},{"name":"maturityDate","in":"query","type":"string","required":false,"description":"Indicates maturity date of the contract"},{"name":"strikePrice","in":"query","type":"string","required":false,"description":"The price at which the option holder has the right to buy (Call Options) or sell (Put Options) the underlying instrument, or to cash-settle the option if appropriate"},{"name":"callOrPut","in":"query","type":"string","required":false,"description":"Indicates whether the transaction is a call or put.  Allowed values: - CALL  - PUT"},{"name":"tradeCurrency","in":"query","type":"string","required":false,"description":"The trade currency is the settlement currency for the trade"},{"name":"currencyId","in":"query","type":"string","required":false,"description":"Identifier of the currency. This is the 3-letter ISO 4217 code of the currency."},{"name":"optionStyle","in":"query","type":"string","required":false,"description":"The type of settlement rule that should be applied on the option. AMERICAN: An option that may be exercised at any time prior to its expiry date. EUROPEAN: An option that may only be exercised on its "},{"name":"referenceId","in":"query","type":"string","required":false,"description":""},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from t24 on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":""},{"name":"companyId","in":"header","type":"string","required":false,"description":""}],"requestBodyExample":null,"responses":{"200":"SellOptionTradesResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"POST","path":"/holdings/instruments/options/assigns","fullPath":"/api/v1.0.0/holdings/instruments/options/assigns","operationId":"createManualAssignOptionTrades","name":"Creates the manual assign contract to assign the lots based on either the trade reference selected or the trades filtered based on - Derivatives Contract, Maturity Date, Options(Call / Put) and Strike Price","summary":"Creates manual assign contract","tags":[],"parameters":[{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":""},{"name":"companyId","in":"header","type":"string","required":false,"description":""}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"transactionDetails":[{}],"closeoutIds":[{}],"status":"string","marketPrice":0.0,"exchangeRate":0.0,"contractSize":0.0,"price":0.0,"quoteCurrency":"string","spotRate":0.0,"spotPayoutRate":"string","payoutCurrency":0.0}},"responses":{"200":"ManualAssignOptionTradesResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/holdings/instruments/options/exercises","fullPath":"/api/v1.0.0/holdings/instruments/options/exercises","operationId":"getBuyOptionTrades","name":"Retrieves the buy option contracts","summary":"Retrieves buy option trades","tags":[],"parameters":[{"name":"portfolioId","in":"query","type":"string","required":false,"description":"Id of the portfolio or security account"},{"name":"contactId","in":"query","type":"string","required":false,"description":""},{"name":"maturityDate","in":"query","type":"string","required":false,"description":"Indicates maturity date of the contract"},{"name":"strikePrice","in":"query","type":"string","required":false,"description":"The price at which the option holder has the right to buy (Call Options) or sell (Put Options) the underlying instrument, or to cash-settle the option if appropriate"},{"name":"callOrPut","in":"query","type":"string","required":false,"description":"Indicates whether the transaction is a call or put.  Allowed values: - CALL  - PUT"},{"name":"tradeCurrency","in":"query","type":"string","required":false,"description":"The trade currency is the settlement currency for the trade"},{"name":"currencyId","in":"query","type":"string","required":false,"description":"Identifier of the currency. This is the 3-letter ISO 4217 code of the currency."},{"name":"optionStyle","in":"query","type":"string","required":false,"description":"The type of settlement rule that should be applied on the option. AMERICAN: An option that may be exercised at any time prior to its expiry date. EUROPEAN: An option that may only be exercised on its "},{"name":"referenceId","in":"query","type":"string","required":false,"description":""},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from t24 on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":""},{"name":"companyId","in":"header","type":"string","required":false,"description":""}],"requestBodyExample":null,"responses":{"200":"BuyOptionTradesResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"POST","path":"/holdings/instruments/options/exercises","fullPath":"/api/v1.0.0/holdings/instruments/options/exercises","operationId":"createManualExerciseOptionTrades","name":"Creates manual exercise to exercise the lots based on either the trade reference selected or the trades filtered based on - Derivatives Contract, Maturity Date, Options(Call / Put) and Strike Price","summary":"Creates manual exercise contract","tags":[],"parameters":[{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":""},{"name":"companyId","in":"header","type":"string","required":false,"description":""}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"transactionDetails":[{}],"closeoutIds":[{}],"status":"string","marketPrice":0.0,"exchangeRate":0.0,"contractSize":0.0,"price":0.0,"quoteCurrency":"string","spotRate":0.0,"spotPayoutRate":"string","payoutCurrency":0.0}},"responses":{"200":"ManualExerciseOptionTradesResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/holdings/instruments/options/expires","fullPath":"/api/v1.0.0/holdings/instruments/options/expires","operationId":"getActiveOptionTrades","name":"Retrieves the option contracts","summary":"Retrieves option trades","tags":[],"parameters":[{"name":"portfolioId","in":"query","type":"string","required":false,"description":"Id of the portfolio or security account"},{"name":"contactId","in":"query","type":"string","required":false,"description":""},{"name":"maturityDate","in":"query","type":"string","required":false,"description":"Indicates maturity date of the contract"},{"name":"strikePrice","in":"query","type":"string","required":false,"description":"The price at which the option holder has the right to buy (Call Options) or sell (Put Options) the underlying instrument, or to cash-settle the option if appropriate"},{"name":"callOrPut","in":"query","type":"string","required":false,"description":"Indicates whether the transaction is a call or put.  Allowed values: - CALL  - PUT"},{"name":"tradeCurrency","in":"query","type":"string","required":false,"description":"The trade currency is the settlement currency for the trade"},{"name":"currencyId","in":"query","type":"string","required":false,"description":"Identifier of the currency. This is the 3-letter ISO 4217 code of the currency."},{"name":"optionStyle","in":"query","type":"string","required":false,"description":"The type of settlement rule that should be applied on the option. AMERICAN: An option that may be exercised at any time prior to its expiry date. EUROPEAN: An option that may only be exercised on its "},{"name":"referenceId","in":"query","type":"string","required":false,"description":""},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from t24 on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":""},{"name":"companyId","in":"header","type":"string","required":false,"description":""}],"requestBodyExample":null,"responses":{"200":"ActiveOptionTradesResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"POST","path":"/holdings/instruments/options/expires","fullPath":"/api/v1.0.0/holdings/instruments/options/expires","operationId":"createManualExpireOptionTrades","name":"Creates manual expire to expire the lots based on either the trade reference selected or the trades filtered based on - Derivatives Contract, Maturity Date, Options(Call / Put) and Strike Price","summary":"Creates manual expire contract","tags":[],"parameters":[{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":""},{"name":"companyId","in":"header","type":"string","required":false,"description":""}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"transactionDetails":[{}],"closeoutId":"string"}},"responses":{"200":"ManualExpireOptionTradesResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}}]},{"key":"holdings-dpcTransactions-service-v1.0.0","title":"Get transaction details","version":"v1.0.0","description":"Allows to view the transaction details for Cash, Interest Rate Gap and Currency Position enquiries","endpointCount":1,"endpoints":[{"method":"GET","path":"/holdings/treasury/transactions/{transactionId}","fullPath":"/api/v1.0.0/holdings/treasury/transactions/{transactionId}","operationId":"getTreasuryTransactionDetails","name":"","summary":"","tags":[],"parameters":[{"name":"transactionId","in":"path","type":"string","required":true,"description":"Unique transaction identifier for retrieving the details of the transaction. For example: FT0102030333 etc."},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from t24 on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"The identifier of the underlying Entity/Company/Branch."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"TreasuryTransactionDetailsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}}]},{"key":"holdings-enterpriseProducts-accounts-services-v1.0.0","title":"Account management","version":"v1.0.0","description":"API to manage account related services such as retrieving balances, transaction and card details, emergency blocks, funds diversion, reservations, proxy identifiers and account closures. In addition, it provides functionality to support the capability to switch accounts from the current system to an","endpointCount":26,"endpoints":[{"method":"PUT","path":"/holdings/enterpriseProducts/accounts/{accountId}/accounts","fullPath":"/api/v1.0.0/holdings/enterpriseProducts/accounts/{accountId}/accounts","operationId":"updateAccount","name":"Update the account details to block or unblock the account by setting the posting restriction and to change the nick name of the account","summary":"Update the account's details","tags":["RETAIL"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"accountId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"productId":"string","effectiveDate":"2024-01-01","extensions":{},"balance":[{}]}},"responses":{"200":"updateAccountResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"PUT","path":"/holdings/enterpriseProducts/accounts/{accountId}/customers","fullPath":"/api/v1.0.0/holdings/enterpriseProducts/accounts/{accountId}/customers","operationId":"updateAccountCustomer","name":"Update the customer details of the account such as add or remove the joint customers, tax liability percentange, limit liability percentage of the joint customers","summary":"Update customers for the given account","tags":["RETAIL"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"accountId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"partyIds":[{}],"effectiveDate":"2024-01-01","extensions":{},"party":[{}]}},"responses":{"200":"updateAccountCustomerResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"GET","path":"/holdings/enterpriseProducts/accounts/accountsDetails","fullPath":"/api/v1.0.0/holdings/enterpriseProducts/accounts/accountsDetails","operationId":"getAccountInfo","name":"Retrieves the currency, balances, limit details and arrangement details of the account","summary":"Retrieves list of account basic details","tags":["RETAIL"],"parameters":[{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"AccountInfoResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"PUT","path":"/holdings/enterpriseProducts/accounts/{accountId}/statements","fullPath":"/api/v1.0.0/holdings/enterpriseProducts/accounts/{accountId}/statements","operationId":"updateAccountStatement","name":"Update the statement frequency of an account.","summary":"Update the statement frequency of an account","tags":["RETAIL"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"accountId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"productId":"string","effectiveDate":"2024-01-01","extensions":{},"statementcondition":[{}]}},"responses":{"200":"updateAccountStatementResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"PUT","path":"/holdings/enterpriseProducts/accounts/{accountId}/schedules","fullPath":"/api/v1.0.0/holdings/enterpriseProducts/accounts/{accountId}/schedules","operationId":"updateAccountSchedule","name":"Update the payment schedule condition such as payment method from capitalise to pay, payment frequency from monthly to quarterly etc., on an account","summary":"Update payment schedule for the given account","tags":["RETAIL"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"accountId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"productId":"string","effectiveDate":"2024-01-01","extensions":{},"paymentschedule":[{}]}},"responses":{"200":"updateAccountScheduleResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"PUT","path":"/holdings/enterpriseProducts/accounts/{accountId}/dormancyStatus/{status}","fullPath":"/api/v1.0.0/holdings/enterpriseProducts/accounts/{accountId}/dormancyStatus/{status}","operationId":"updateAccountDormancyStatus","name":"De-activates the savings account and moves it to given dormancy status.","summary":"De-activates the savings account to given status","tags":["RETAIL"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"accountId","in":"path","type":"string","required":true,"description":""},{"name":"status","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"effectiveDate":"2024-01-01","productId":"string","extensions":{}}},"responses":{"200":"updateAccountDormancyStatusResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"PUT","path":"/holdings/enterpriseProducts/accounts/{accountId}/dormancyStatus/reactivations","fullPath":"/api/v1.0.0/holdings/enterpriseProducts/accounts/{accountId}/dormancyStatus/reactivations","operationId":"updateAccountDormancyReactivation","name":"Reset the dormant account to active status manually","summary":"Reset the account dormancy status","tags":["RETAIL"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"accountId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"effectiveDate":"2024-01-01","productId":"string","extensions":{}}},"responses":{"200":"updateAccountDormancyReactivationResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"PUT","path":"/holdings/enterpriseProducts/accounts/{accountId}/settlements","fullPath":"/api/v1.0.0/holdings/enterpriseProducts/accounts/{accountId}/settlements","operationId":"updateAccountSettlement","name":"Update the settlement conditions of the account such as payin account, payin percentage, payin amount, payout account, payout percentage, payout amount, etc","summary":"Update the settlement conditions of the account such as payin account, payin percentage, payin amount, payout account, payout percentage, payout amount, etc","tags":["RETAIL"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"accountId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"productId":"string","effectiveDate":"2024-01-01","extensions":{},"autosettlement":[{}]}},"responses":{"200":"updateAccountSettlementResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"PUT","path":"/holdings/enterpriseProducts/accounts/{accountId}/interestConditions","fullPath":"/api/v1.0.0/holdings/enterpriseProducts/accounts/{accountId}/interestConditions","operationId":"updateAccountInterestConditions","name":"Update the interest conditions of the account such as interest rate, tier details, margin amount etc.","summary":"Update the interest conditions of the account","tags":["RETAIL"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"accountId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"effectiveDate":"2024-01-01","channel":"string","extensions":{},"crinterest":[{}]}},"responses":{"200":"updateAccountInterestConditionsResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"PUT","path":"/holdings/enterpriseProducts/accounts/{accountId}/products","fullPath":"/api/v1.0.0/holdings/enterpriseProducts/accounts/{accountId}/products","operationId":"updateAccountProduct","name":"Change account from one product to another such as changing savings account to current account","summary":"Change of contract from one account product to another","tags":["RETAIL"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"accountId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"productId":"string","effectiveDate":"2024-01-01","extensions":{},"changeProduct":[{}]}},"responses":{"200":"updateAccountProductResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"PUT","path":"/holdings/enterpriseProducts/accounts/{accountId}/branches","fullPath":"/api/v1.0.0/holdings/enterpriseProducts/accounts/{accountId}/branches","operationId":"updateAccountBranch","name":"Updates the branch of an account","summary":"Updates the branch of an account","tags":["RETAIL"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"accountId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"effectiveDate":"2024-01-01","branch":"string","extensions":{}}},"responses":{"200":"updateAccountBranchResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"PUT","path":"/holdings/enterpriseProducts/accounts/{accountId}/limits","fullPath":"/api/v1.0.0/holdings/enterpriseProducts/accounts/{accountId}/limits","operationId":"updateAccountLimit","name":"Update the limit conditions of the account with the secondary limit amount and other limit details","summary":"Update the limit conditions of the account","tags":["RETAIL"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"accountId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"parties":[{}],"activityId":"string","effectiveDate":"string","productId":"string","currencyId":"string","simulationId":"string","extensions":{},"accountlimit":[{}]}},"responses":{"200":"updateAccountLimitResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"PUT","path":"/holdings/enterpriseProducts/accounts/{accountId}/adjustments","fullPath":"/api/v1.0.0/holdings/enterpriseProducts/accounts/{accountId}/adjustments","operationId":"updateAccountAdjustment","name":"Performs backdated adjustment and re-acrrual for the given savings account.  This is used when interest adjustment is required due to backdated rate change or transaction.","summary":"Performs backdated adjustment and re-acrrual for the given savings account ","tags":["RETAIL"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"accountId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"currencyId":"string","effectiveDate":"2024-01-01","activityId":"string","transactionAmount":0.0,"contractId":"string","systemId":"string","externalEventStatus":"string","extensions":{}}},"responses":{"200":"updateAccountAdjustmentResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"POST","path":"/holdings/enterpriseProducts/accounts/migrations","fullPath":"/api/v1.0.0/holdings/enterpriseProducts/accounts/migrations","operationId":"initiateAccountMigration","name":"Migration of a legacy system account contract to the given account product by providing the original contract date, account name, statement, payment frequency and start date, etc. ","summary":"Migration of legacy system account contract to the given account product","tags":["RETAIL"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"partyIds":[{}],"originationReference":[{}],"effectiveDate":"2024-01-01","productId":"string","currency":"string","branch":"string","channel":"string","lineOfBusiness":"string","originalContractDate":"2024-01-01","extensions":{},"accountlimit":[{}],"balance":[{}],"party":[{}],"crinterest":[{}],"paymentschedule":[{}]}},"responses":{"200":"initiateAccountMigrationResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"PUT","path":"/holdings/enterpriseProducts/accounts/{accountId}/renegotiations","fullPath":"/api/v1.0.0/holdings/enterpriseProducts/accounts/{accountId}/renegotiations","operationId":"updateAccountConditions","name":"Perform the renegotiation of the account contract details such as payment frequency, payment start date, interest rate, statement frequency and settlement details, etc.","summary":"Renegotiation of the account contract details","tags":["RETAIL"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"accountId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"productId":"string","effectiveDate":"2024-01-01","extensions":{},"accountlimit":[{}],"balance":[{}],"party":[{}],"crinterest":[{}],"paymentschedule":[{}],"autosettlement":[{}],"statementcondition":[{}]}},"responses":{"200":"updateAccountConditionsResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"PUT","path":"/holdings/enterpriseProducts/accounts/{accountId}/channels","fullPath":"/api/v1.0.0/holdings/enterpriseProducts/accounts/{accountId}/channels","operationId":"updateAccountChannel","name":"Updates the channel of the account","summary":"Change of channel for the account","tags":["RETAIL"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"accountId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"effectiveDate":"2024-01-01","channel":"string","extensions":{}}},"responses":{"200":"updateAccountChannelResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"PUT","path":"/holdings/enterpriseProducts/accounts/{accountId}/lineofBusiness","fullPath":"/api/v1.0.0/holdings/enterpriseProducts/accounts/{accountId}/lineofBusiness","operationId":"updateAccountLob","name":"Updates the type of line of business of the account","summary":"Change of line of business for the account","tags":["RETAIL"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"accountId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"effectiveDate":"2024-01-01","lineOfBusiness":"string","extensions":{}}},"responses":{"200":"updateAccountLobResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"PUT","path":"/holdings/enterpriseProducts/accounts/{accountId}/payoffCalculations","fullPath":"/api/v1.0.0/holdings/enterpriseProducts/accounts/{accountId}/payoffCalculations","operationId":"calculatePayoffAccounts","name":"Calculate the outstanding amount to close the account","summary":"Calculate the outstanding amount to close the account","tags":["RETAIL"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"accountId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"customerIds":[{}],"properties":[{}],"overrides":[{}],"productId":"string","masterArrangementId":"string","roleName":"string","currencyId":"string","effectiveDate":"2024-01-01","activityId":"string","transactionAmount":0.0,"reason":"string","simulationRunReference":"string","extensions":{}}},"responses":{"200":"calculatePayoffAccountsResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"GET","path":"/holdings/enterpriseProducts/accounts","fullPath":"/api/v1.0.0/holdings/enterpriseProducts/accounts","operationId":"getAccount","name":"Retrieves the currency, balances, limit details and arrangement details of the account","summary":"Retrieves list of account basic details","tags":["RETAIL"],"parameters":[{"name":"accountId","in":"query","type":"string","required":false,"description":"Identifier of the account. Often referred to as the account number, yet for consistency this is always referred to as accountId. Accepts both IBAN & BBAN"},{"name":"customerId","in":"query","type":"string","required":false,"description":"Identifier of the customer"},{"name":"productId","in":"query","type":"string","required":false,"description":"Contains the unique identifier of the product, e.g. the product id of the arrangement account."},{"name":"currencyId","in":"query","type":"string","required":false,"description":"Identifier of the currency. This is the 3-letter ISO 4217 code of the currency."},{"name":"limitReference","in":"query","type":"string","required":false,"description":"Identifies the credit limit reference for the underlying account."},{"name":"arrangementId","in":"query","type":"string","required":false,"description":"Indicates an unique identifier of an account"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"AccountResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"POST","path":"/holdings/enterpriseProducts/accounts/savingsAccounts","fullPath":"/api/v1.0.0/holdings/enterpriseProducts/accounts/savingsAccounts","operationId":"createSavingAccount","name":"Create a savings account with the details such as customer identifier, account currency, etc.","summary":"Create savings account","tags":["RETAIL"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"partyIds":[{}],"properties":[{}],"contextNames":[{}],"arrangement":"string","currency":"string","productId":"string","activity":"string","effectiveDate":"string","transactionAmount":0.0,"transactionReference":"string","branch":"string","channel":"string","companyCode":"string","originalTransactionAmount":"string","lineOfBusiness":"string"}},"responses":{"200":"createSavingAccountResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"POST","path":"/holdings/enterpriseProducts/accounts/currentAccounts","fullPath":"/api/v1.0.0/holdings/enterpriseProducts/accounts/currentAccounts","operationId":"createCurrentAccounts","name":"Create a current account with the details such as customer identifier, account currency, etc.","summary":"Create current account","tags":["RETAIL"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"partyIds":[{}],"properties":[{}],"contextNames":[{}],"arrangement":"string","currency":"string","productId":"string","activity":"string","effectiveDate":"string","transactionAmount":0.0,"transactionReference":"string","branch":"string","channel":"string","companyCode":"string","originalTransactionAmount":"string","lineOfBusiness":"string"}},"responses":{"200":"createCurrentAccountsResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"POST","path":"/holdings/enterpriseProducts/accounts/simulations","fullPath":"/api/v1.0.0/holdings/enterpriseProducts/accounts/simulations","operationId":"createAccountSimulation","name":"Creates a simulation for account product with the details such as customer identifier, account currency, etc.","summary":"Create simulation for account products","tags":["RETAIL"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"customerIds":[{}],"properties":[{}],"overrides":[{}],"productId":"string","masterArrangementId":"string","roleName":"string","currencyId":"string","effectiveDate":"2024-01-01","activityId":"string","transactionAmount":0.0,"reason":"string","simulationRunReference":"string","extensions":{},"accountlimit":[{}],"balance":[{}]}},"responses":{"200":"createAccountSimulationResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"PUT","path":"/holdings/enterpriseProducts/accounts/{accountId}/accountOfficers","fullPath":"/api/v1.0.0/holdings/enterpriseProducts/accounts/{accountId}/accountOfficers","operationId":"updateAccountOfficers","name":"Update accounts officer of the account.","summary":"Update accounts officer of the account.","tags":["RETAIL"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"accountId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"productId":"string","effectiveDate":"2024-01-01","extensions":{},"accountOfficers":[{}]}},"responses":{"200":"updateAccountOfficersResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"PUT","path":"/holdings/enterpriseProducts/accounts/{accountId}/migrations/balances","fullPath":"/api/v1.0.0/holdings/enterpriseProducts/accounts/{accountId}/migrations/balances","operationId":"updateAccountBalanceMigration","name":"Captures the balance details of the account such as balance type, due amount etc. This is used to migrate the balances of a legacy contract which is migrated from other system & update the balance details","summary":"Captures outstanding balance details of of a contract migrated from legacy system","tags":["RETAIL"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"accountId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"productId":"string","effectiveDate":"2024-01-01","extensions":{},"balanceMaintenance":[{}]}},"responses":{"200":"updateAccountBalanceMigrationResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"PUT","path":"/holdings/enterpriseProducts/accounts/{accountId}/migrations/bills","fullPath":"/api/v1.0.0/holdings/enterpriseProducts/accounts/{accountId}/migrations/bills","operationId":"updateAccountBillMigration","name":"Captures the bill information of the account such as bill id, property names, bill amount etc. This is used to migrate the bills of a legacy contract which is migrated from other system & update the bill details","summary":"Captures the bill information of the account . This is used to migrate the bills of a legacy contract which is migrated from other system & update the bill details","tags":["RETAIL"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"accountId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"parties":[{}],"activityId":"string","effectiveDate":"string","productId":"string","currencyId":"string","simulationId":"string","extensions":{},"balanceMaintenance":[{}]}},"responses":{"200":"updateAccountBillMigrationResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"PUT","path":"/holdings/enterpriseProducts/accounts/{accountId}/payoffs","fullPath":"/api/v1.0.0/holdings/enterpriseProducts/accounts/{accountId}/payoffs","operationId":"initiatePayoffAccounts","name":"Perform the settlement of payoff amount for the savings account by providing the transaction amount, currency and also settlement instructions","summary":"Perform the settlement of payoff amount for the account","tags":["RETAIL"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"accountId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"partyIds":[{}],"properties":[{}],"contextNames":[{}],"arrangement":"string","currency":"string","productId":"string","activity":"string","effectiveDate":"string","transactionAmount":0.0,"transactionReference":"string","branch":"string","channel":"string","companyCode":"string","originalTransactionAmount":"string","lineOfBusiness":"string"}},"responses":{"200":"initiatePayoffAccountsResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}}]},{"key":"holdings-enterpriseProducts-deposits-services-v1.0.0","title":"Deposits lifecycle operations","version":"v1.0.0","description":"Deposits lifecycle operations","endpointCount":22,"endpoints":[{"method":"PUT","path":"/holdings/enterpriseProducts/deposits/{depositId}/lineofBusiness","fullPath":"/api/v1.0.0/holdings/enterpriseProducts/deposits/{depositId}/lineofBusiness","operationId":"updateDepositLob","name":"Update the type of line of business of the term deposits","summary":"Change of line of business for the term deposits","tags":["RETAIL"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"depositId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"effectiveDate":"2024-01-01","lineOfBusiness":"string","extensions":{}}},"responses":{"200":"updateDepositLobResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"PUT","path":"/holdings/enterpriseProducts/deposits/{depositId}/accountOfficers","fullPath":"/api/v1.0.0/holdings/enterpriseProducts/deposits/{depositId}/accountOfficers","operationId":"UpdateDepositOfficers","name":"Update the officer details of the deposits account.","summary":"Update the primary and secondary officer of the deposits account.","tags":["RETAIL"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"depositId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"productId":"string","effectiveDate":"2024-01-01","extensions":{},"accountOfficers":[{}]}},"responses":{"200":"UpdateDepositOfficersResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"PUT","path":"/holdings/enterpriseProducts/deposits/{depositId}/rollovers","fullPath":"/api/v1.0.0/holdings/enterpriseProducts/deposits/{depositId}/rollovers","operationId":"updateDepositRollover","name":"Perform the rollover of the deposit","summary":"Perform the rollover of the deposit for the given rollover date or period","tags":["RETAIL"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"depositId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"productId":"string","effectiveDate":"2024-01-01","extensions":{},"depositsrollover":[{}]}},"responses":{"200":"updateDepositRolloverResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"PUT","path":"/holdings/enterpriseProducts/deposits/{depositId}/commitments","fullPath":"/api/v1.0.0/holdings/enterpriseProducts/deposits/{depositId}/commitments","operationId":"updateTermAmount","name":"Update the term amount and tenure details of the deposit","summary":"Update the tenure of the term deposit by providing tenure or maturity date","tags":["RETAIL"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"depositId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"productId":"string","effectiveDate":"2024-01-01","extensions":{},"termamount":[{}]}},"responses":{"200":"updateTermAmountResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"PUT","path":"/holdings/enterpriseProducts/deposits/{depositId}/customers","fullPath":"/api/v1.0.0/holdings/enterpriseProducts/deposits/{depositId}/customers","operationId":"updateDepositCustomer","name":"Update the customer details of the term deposit","summary":"Update the customer details of the term deposit","tags":["RETAIL"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"depositId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"partyIds":[{}],"effectiveDate":"2024-01-01","extensions":{},"party":[{}]}},"responses":{"200":"updateDepositCustomerResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"PUT","path":"/holdings/enterpriseProducts/deposits/{depositId}/statements","fullPath":"/api/v1.0.0/holdings/enterpriseProducts/deposits/{depositId}/statements","operationId":"updateDepositStatement","name":"Update the statement condition details of the term deposit","summary":"Update the statement condition details of the term deposits such as statement frequency, statement mode etc.,","tags":["RETAIL"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"depositId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"productId":"string","effectiveDate":"2024-01-01","extensions":{},"statementcondition":[{}]}},"responses":{"200":"updateDepositStatementResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"GET","path":"/holdings/enterpriseProducts/deposits/{depositId}","fullPath":"/api/v1.0.0/holdings/enterpriseProducts/deposits/{depositId}","operationId":"getDepositDetails","name":"Retrieves the basic information of the deposit account including deposit amount, term, maturity days, tax details, charge details, etc","summary":"Retrieves the basic information of the deposit account including deposit amount, term, maturity days, tax details, charge details, etc","tags":["RETAIL"],"parameters":[{"name":"depositId","in":"path","type":"string","required":true,"description":"Indicates the Id of the deposit account"},{"name":"balanceTypes","in":"query","type":"string","required":false,"description":"Type of balance (e.g. current balance, credit interest accrued, deferred commission, etc.) as defined in the institution's accounting schemas."},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"DepositDetailsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"PUT","path":"/holdings/enterpriseProducts/deposits/{depositId}/paymentSchedules","fullPath":"/api/v1.0.0/holdings/enterpriseProducts/deposits/{depositId}/paymentSchedules","operationId":"updateDepositSchedule","name":"Update the payment schedule of the term deposit","summary":"Update the payment schedule details of the term deposit such as payment frequency, payment type","tags":["RETAIL"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"depositId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"productId":"string","effectiveDate":"2024-01-01","extensions":{},"paymentschedule":[{}]}},"responses":{"200":"updateDepositScheduleResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"PUT","path":"/holdings/enterpriseProducts/deposits/{depositId}/settlements","fullPath":"/api/v1.0.0/holdings/enterpriseProducts/deposits/{depositId}/settlements","operationId":"updateDepositSettlement","name":"Update the settlement conditions of the term deposit such as payin account, payout account, beneficiary, etc","summary":"Update the settlement details of the term deposit","tags":["RETAIL"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"depositId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"productId":"string","effectiveDate":"2024-01-01","extensions":{},"autosettlement":[{}]}},"responses":{"200":"updateDepositSettlementResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"PUT","path":"/holdings/enterpriseProducts/deposits/{depositId}/products","fullPath":"/api/v1.0.0/holdings/enterpriseProducts/deposits/{depositId}/products","operationId":"updateDepositProduct","name":"Update the contract from one deposit product to another.","summary":"Update the contract from one deposit product to another.","tags":["RETAIL"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"depositId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"productId":"string","effectiveDate":"2024-01-01","extensions":{},"depositsrollover":[{}],"termamount":[{}],"paymentschedule":[{}]}},"responses":{"200":"updateDepositProductResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"PUT","path":"/holdings/enterpriseProducts/deposits/{depositId}/branches","fullPath":"/api/v1.0.0/holdings/enterpriseProducts/deposits/{depositId}/branches","operationId":"updateDepositBranch","name":"Update branch of the term deposit.","summary":"Update branch of the term deposit.","tags":["RETAIL"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"depositId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"effectiveDate":"2024-01-01","branch":"string","extensions":{}}},"responses":{"200":"updateDepositBranchResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"PUT","path":"/holdings/enterpriseProducts/deposits/{depositId}/migrations/balances","fullPath":"/api/v1.0.0/holdings/enterpriseProducts/deposits/{depositId}/migrations/balances","operationId":"updateDepositsBalanceMigration","name":"Captures the balance details of the deposits account such as balance type, due amount etc. This is used to migrate the balances of a legacy contract which is migrated from other system & update the balance details.","summary":"Captures the balance details of the deposits account such as balance type, due amount etc","tags":["RETAIL"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"depositId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"productId":"string","effectiveDate":"2024-01-01","extensions":{},"balanceMaintenance":[{}]}},"responses":{"200":"updateDepositsBalanceMigrationResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"PUT","path":"/holdings/enterpriseProducts/deposits/{depositId}/migrations/bills","fullPath":"/api/v1.0.0/holdings/enterpriseProducts/deposits/{depositId}/migrations/bills","operationId":"updateDepositsBillMigration","name":"Captures the bill information of the deposits account such as bill id, property names, bill amount etc. This is used to migrate the bills of a legacy contract which is migrated from other system & update the bill details.","summary":"Capture the bill information of the deposits account such as bill id, property names, bill amount etc.","tags":["RETAIL"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"depositId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"effectiveDate":"2024-01-01","productId":"string","extensions":{},"balanceMaintenance":[{}]}},"responses":{"200":"updateDepositsBillMigrationResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"POST","path":"/holdings/enterpriseProducts/deposits/{depositId}/redeemDeposits/simulations","fullPath":"/api/v1.0.0/holdings/enterpriseProducts/deposits/{depositId}/redeemDeposits/simulations","operationId":"simulateRedeemDeposits","name":"Simulates a deposit redemption that includes the settlement instructions to which the deposit amount is to be credited. Common usage of this is for simulating withdrawals when customers want to withdraw their deposits before the actual fixed maturity date of the deposits","summary":"Simulate term deposit closure.","tags":["RETAIL"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"depositId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"partyIds":[{}],"properties":[{}],"contextNames":[{}],"arrangement":"string","currency":"string","productId":"string","activity":"string","effectiveDate":"string","transactionAmount":0.0,"transactionReference":"string","branch":"string","channel":"string","companyCode":"string","originalTransactionAmount":"string","lineOfBusiness":"string"}},"responses":{"200":"simulateRedeemDepositsResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"POST","path":"/holdings/enterpriseProducts/deposits/{depositId}/redeemDeposits","fullPath":"/api/v1.0.0/holdings/enterpriseProducts/deposits/{depositId}/redeemDeposits","operationId":"redeemDeposits","name":"Creates redeem deposits that includes settlement instructions to which the deposit amount is to be credited. Common usage of this is when customers want to withdraw their deposits before the actual maturity date of the deposits.","summary":"Redeem the term deposit to close the deposit","tags":["RETAIL"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"depositId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"partyIds":[{}],"properties":[{}],"contextNames":[{}],"arrangement":"string","currency":"string","productId":"string","activity":"string","effectiveDate":"string","transactionAmount":0.0,"transactionReference":"string","branch":"string","channel":"string","companyCode":"string","originalTransactionAmount":"string","lineOfBusiness":"string"}},"responses":{"200":"redeemDepositsResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"PUT","path":"/holdings/enterpriseProducts/deposits/{depositId}/channels","fullPath":"/api/v1.0.0/holdings/enterpriseProducts/deposits/{depositId}/channels","operationId":"updateDepositsChannel","name":"Updates the channel of the account","summary":"Change of channel for the account","tags":["RETAIL"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"depositId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"effectiveDate":"2024-01-01","channel":"string","extensions":{}}},"responses":{"200":"updateDepositsChannelResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"PUT","path":"/holdings/enterpriseProducts/deposits/{depositId}/withdrawals","fullPath":"/api/v1.0.0/holdings/enterpriseProducts/deposits/{depositId}/withdrawals","operationId":"withdrawDeposits","name":"Perform partial withdrawal in the term deposit","summary":"Perform partial withdrawal from the term deposit account/ Perform partial withdrawal.","tags":["RETAIL"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"depositId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"partyIds":[{}],"properties":[{}],"contextNames":[{}],"arrangement":"string","currency":"string","productId":"string","activity":"string","effectiveDate":"string","transactionAmount":0.0,"transactionReference":"string","branch":"string","channel":"string","companyCode":"string","originalTransactionAmount":"string","lineOfBusiness":"string"}},"responses":{"200":"withdrawDepositsResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"POST","path":"/holdings/enterpriseProducts/deposits/termdeposits","fullPath":"/api/v1.0.0/holdings/enterpriseProducts/deposits/termdeposits","operationId":"createDeposit","name":"Creates term deposits that includes customer identifier, customer role, deposit currency, deposit amount and the deposit duration term etc.","summary":"Creates term deposits that includes customer identifier, customer role, deposit currency, deposit amount and the deposit duration term etc.","tags":["RETAIL"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"partyIds":[{}],"properties":[{}],"contextNames":[{}],"arrangement":"string","currency":"string","productId":"string","activity":"string","effectiveDate":"string","transactionAmount":0.0,"transactionReference":"string","branch":"string","channel":"string","companyCode":"string","originalTransactionAmount":"string","lineOfBusiness":"string"}},"responses":{"200":"createDepositResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"PUT","path":"/holdings/enterpriseProducts/deposits/{depositId}/accounts","fullPath":"/api/v1.0.0/holdings/enterpriseProducts/deposits/{depositId}/accounts","operationId":"updateDepositAccount","name":"Update the account conditions of the term deposit","summary":"Update the account conditions of the term deposit","tags":["RETAIL"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"depositId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"effectiveDate":"2024-01-01","productId":"string","extensions":{},"principal":[{}]}},"responses":{"200":"updateDepositAccountResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"POST","path":"/holdings/enterpriseProducts/deposits/migrations","fullPath":"/api/v1.0.0/holdings/enterpriseProducts/deposits/migrations","operationId":"initiateDepositsMigration","name":"Migration of a legacy system deposit contract to the given deposit product by providing the original contract date, account name, statement, payment frequency and start date, etc. This can be used for migrating the legacy contract to deposits account by providing required details.","summary":"Perform migration of a legacy system deposit contract to the given deposit product.","tags":["RETAIL"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"partyIds":[{}],"originationReference":[{}],"effectiveDate":"2024-01-01","productId":"string","currency":"string","branch":"string","channel":"string","lineOfBusiness":"string","originalContractDate":"2024-01-01","extensions":{},"principal":[{}],"party":[{}],"paymentschedule":[{}],"depositsrollover":[{}],"autosettlement":[{}]}},"responses":{"200":"initiateDepositsMigrationResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"PUT","path":"/holdings/enterpriseProducts/deposits/{depositId}/renegotiations","fullPath":"/api/v1.0.0/holdings/enterpriseProducts/deposits/{depositId}/renegotiations","operationId":"updateDepositConditions","name":"Update the renegotiations of term deposit","summary":"Renegotiation of term deposit","tags":["RETAIL"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"depositId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"productId":"string","effectiveDate":"2024-01-01","extensions":{},"principal":[{}],"party":[{}],"paymentschedule":[{}],"autosettlement":[{}],"termamount":[{}]}},"responses":{"200":"updateDepositConditionsResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"POST","path":"/holdings/enterpriseProducts/deposits/simulations","fullPath":"/api/v1.0.0/holdings/enterpriseProducts/deposits/simulations","operationId":"simulateNewdeposit","name":"Simulate a deposit arrangement for the given principal amount, term, payment frequency and interest rates","summary":"Simulate a deposit arrangement for the given principal amount, term, payment frequency and interest rates","tags":["RETAIL"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"partyIds":[{}],"properties":[{}],"contextNames":[{}],"arrangement":"string","currency":"string","productId":"string","activity":"string","effectiveDate":"string","transactionAmount":0.0,"branch":"string","automaticRun":"string","simulationRunReference":"string","synchronous":"string","channel":"string","companyCode":"string"}},"responses":{"200":"simulateNewdepositResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}}]},{"key":"holdings-entitlements-service-v1.0.0","title":"Corporate Action Event Management","version":"v1.0.0","description":"Allows the viewing of Options of the Entitlements, approval awaiting Entitlements and management of the Entitlements","endpointCount":6,"endpoints":[{"method":"GET","path":"/holdings/entitlements/entitlementOptions","fullPath":"/api/v1.0.0/holdings/entitlements/entitlementOptions","operationId":"getPendingEntitlements","name":"Retrieves the list of all pending entitlements","summary":"Retrieves pending entitlements","tags":[],"parameters":[{"name":"diaryId","in":"query","type":"string","required":false,"description":"The identifier of the diary"},{"name":"portfolioId","in":"query","type":"string","required":false,"description":"Id of the portfolio or security account"},{"name":"customerId","in":"query","type":"string","required":false,"description":"Identifier of the customer"},{"name":"eventType","in":"query","type":"string","required":false,"description":"Event Type of the corporate action"},{"name":"accountOfficerId","in":"query","type":"string","required":false,"description":"The identifier of the department head or specific account officer responsible for the customer"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from t24 on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"The identifier of the underlying Entity/Company/Branch."}],"requestBodyExample":null,"responses":{"200":"PendingEntitlementsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/entitlements/{entitlementId}","fullPath":"/api/v1.0.0/holdings/entitlements/{entitlementId}","operationId":"getSecurityEntitlement","name":"Retreives the entitlement details","summary":"Retreives the entitlement","tags":[],"parameters":[{"name":"entitlementId","in":"path","type":"string","required":true,"description":"The identifier of the entitlement"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"The identifier of the underlying Entity/Company/Branch."}],"requestBodyExample":null,"responses":{"200":"SecurityEntitlementResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/holdings/entitlements/{entitlementId}","fullPath":"/api/v1.0.0/holdings/entitlements/{entitlementId}","operationId":"updateSecurityEntitlement","name":"Updates the details in entitlement","summary":"Updates the entitlement","tags":[],"parameters":[{"name":"entitlementId","in":"path","type":"string","required":true,"description":"The identifier of the entitlement"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"The identifier of the underlying Entity/Company/Branch."}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"optionDetails":[{}],"sellBuyOptionDescriptions":[{}],"localTaxAmounts":[{}],"eventResult":[{}],"brokerDetails":[{}],"eventOptionDetails":[{}],"accountCurrencyTax":[{}],"depositoryId":0.0,"portfolioId":"string","instrumentId":"string","diaryId":"string","accountId":"string","qualifyingHolding":0.0,"eventQuantity":0.0,"currency":"string"}},"responses":{"200":"SecurityEntitlementResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/holdings/entitlements/{entitlementId}/buySellRights","fullPath":"/api/v1.0.0/holdings/entitlements/{entitlementId}/buySellRights","operationId":"getEntitlementBuySellRights","name":"Updates the buy sell rights holdings","summary":"Updates buy sell rights","tags":[],"parameters":[{"name":"entitlementId","in":"path","type":"string","required":true,"description":"The identifier of the entitlement"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"The identifier of the underlying Entity/Company/Branch."}],"requestBodyExample":null,"responses":{"200":"EntitlementBuySellRightsResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/holdings/entitlements/{entitlementId}/buySellRights","fullPath":"/api/v1.0.0/holdings/entitlements/{entitlementId}/buySellRights","operationId":"updateEntitlementBuySellRights","name":"Retrieves the entitlement information","summary":"Retrieves entitlement information","tags":[],"parameters":[{"name":"entitlementId","in":"path","type":"string","required":true,"description":"The identifier of the entitlement"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"The identifier of the underlying Entity/Company/Branch."}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"optionDetails":[{}],"diaryId":"string","portfolioId":"string","depositoryId":0.0,"nominee":"string","subAccount":"string","instrumentId":"string","eventType":"string","currencyId":"string","qualifyingHolding":0.0,"rightsPosition":0.0,"recordType":"string","netNominal":0.0,"generateInstruction":true,"MT566Confirmation":true}},"responses":{"200":"EntitlementBuySellRightsResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/holdings/entitlementApprovals","fullPath":"/api/v1.0.0/holdings/entitlementApprovals","operationId":"getEntitlementApprovals","name":"Retrieves the list of all unauthorised entitlements for approval","summary":"Retrieves unauthorised entitlements","tags":[],"parameters":[{"name":"diaryId","in":"query","type":"string","required":false,"description":"The identifier of the diary"},{"name":"instrumentId","in":"query","type":"string","required":false,"description":"The identifier of the instrument"},{"name":"securityUpdate","in":"query","type":"string","required":false,"description":"Indicates to update Security Position based on Corporate Action Event processing"},{"name":"portfolioId","in":"query","type":"string","required":false,"description":"Id of the portfolio or security account"},{"name":"customerId","in":"query","type":"string","required":false,"description":"Identifier of the customer"},{"name":"eventType","in":"query","type":"string","required":false,"description":"Event Type of the corporate action"},{"name":"accountOfficerId","in":"query","type":"string","required":false,"description":"The identifier of the department head or specific account officer responsible for the customer"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from t24 on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"The identifier of the underlying Entity/Company/Branch."}],"requestBodyExample":null,"responses":{"200":"EntitlementApprovalsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}}]},{"key":"holdings-entitlements-service-v2.0.0","title":"Corporate Action Event Management","version":"v2.0.0","description":"Allows the viewing of Options of the Entitlements, approval awaiting Entitlements and management of the Entitlements","endpointCount":6,"endpoints":[{"method":"GET","path":"/holdings/entitlements/entitlementOptions","fullPath":"/api/v2.0.0/holdings/entitlements/entitlementOptions","operationId":"getPendingEntitlements","name":"Retrieves the list of all pending entitlements","summary":"Retrieves pending entitlements","tags":[],"parameters":[{"name":"diaryId","in":"query","type":"string","required":false,"description":"The identifier of the diary"},{"name":"portfolioId","in":"query","type":"string","required":false,"description":"Id of the portfolio or security account"},{"name":"customerId","in":"query","type":"string","required":false,"description":"Identifier of the customer"},{"name":"eventType","in":"query","type":"string","required":false,"description":"Event Type of the corporate action"},{"name":"accountOfficerId","in":"query","type":"string","required":false,"description":"The identifier of the department head or specific account officer responsible for the customer"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from t24 on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"The identifier of the underlying Entity/Company/Branch."}],"requestBodyExample":null,"responses":{"200":"PendingEntitlementsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/entitlements/{entitlementId}","fullPath":"/api/v2.0.0/holdings/entitlements/{entitlementId}","operationId":"getSecurityEntitlements","name":"Allows to view the entitlement details along with the delivery message information","summary":"Allows to view the entitlement details","tags":[],"parameters":[{"name":"entitlementId","in":"path","type":"string","required":true,"description":"The identifier of the entitlement"},{"name":"diaryId","in":"query","type":"string","required":false,"description":"The identifier of the diary"},{"name":"portfolioId","in":"query","type":"string","required":false,"description":"Id of the portfolio or security account"},{"name":"eventType","in":"query","type":"string","required":false,"description":"Event Type of the corporate action"},{"name":"accountOfficerId","in":"query","type":"string","required":false,"description":"The identifier of the department head or specific account officer responsible for the customer"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from t24 on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"The identifier of the underlying Entity/Company/Branch."}],"requestBodyExample":null,"responses":{"200":"SecurityEntitlementsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"PUT","path":"/holdings/entitlements/{entitlementId}","fullPath":"/api/v2.0.0/holdings/entitlements/{entitlementId}","operationId":"updateSecurityEntitlement","name":"Updates the details in entitlement","summary":"Updates the entitlement","tags":[],"parameters":[{"name":"entitlementId","in":"path","type":"string","required":true,"description":"The identifier of the entitlement"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"The identifier of the underlying Entity/Company/Branch."}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"optionDetails":[{}],"sellBuyOptionDescriptions":[{}],"localTaxAmounts":[{}],"eventResult":[{}],"brokerDetails":[{}],"eventOptionDetails":[{}],"accountCurrencyTax":[{}],"depositoryId":0.0,"portfolioId":"string","instrumentId":"string","diaryId":"string","accountId":"string","qualifyingHolding":0.0,"eventQuantity":0.0,"currency":"string"}},"responses":{"200":"SecurityEntitlementResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/holdings/entitlements/{entitlementId}/buySellRights","fullPath":"/api/v2.0.0/holdings/entitlements/{entitlementId}/buySellRights","operationId":"getEntitlementBuySellRights","name":"Updates the buy sell rights holdings","summary":"Updates buy sell rights","tags":[],"parameters":[{"name":"entitlementId","in":"path","type":"string","required":true,"description":"The identifier of the entitlement"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"The identifier of the underlying Entity/Company/Branch."}],"requestBodyExample":null,"responses":{"200":"EntitlementBuySellRightsResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/holdings/entitlements/{entitlementId}/buySellRights","fullPath":"/api/v2.0.0/holdings/entitlements/{entitlementId}/buySellRights","operationId":"updateEntitlementBuySellRights","name":"Retrieves the entitlement information","summary":"Retrieves entitlement information","tags":[],"parameters":[{"name":"entitlementId","in":"path","type":"string","required":true,"description":"The identifier of the entitlement"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"The identifier of the underlying Entity/Company/Branch."}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"optionDetails":[{}],"diaryId":"string","portfolioId":"string","depositoryId":0.0,"nominee":"string","subAccount":"string","instrumentId":"string","eventType":"string","currencyId":"string","qualifyingHolding":0.0,"rightsPosition":0.0,"recordType":"string","netNominal":0.0,"generateInstruction":true,"MT566Confirmation":true}},"responses":{"200":"EntitlementBuySellRightsResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/holdings/entitlementApprovals","fullPath":"/api/v2.0.0/holdings/entitlementApprovals","operationId":"getEntitlementApprovals","name":"Retrieves the list of all unauthorised entitlements for approval","summary":"Retrieves unauthorised entitlements","tags":[],"parameters":[{"name":"diaryId","in":"query","type":"string","required":false,"description":"The identifier of the diary"},{"name":"instrumentId","in":"query","type":"string","required":false,"description":"The identifier of the instrument"},{"name":"securityUpdate","in":"query","type":"string","required":false,"description":"Indicates to update Security Position based on Corporate Action Event processing"},{"name":"portfolioId","in":"query","type":"string","required":false,"description":"Id of the portfolio or security account"},{"name":"customerId","in":"query","type":"string","required":false,"description":"Identifier of the customer"},{"name":"eventType","in":"query","type":"string","required":false,"description":"Event Type of the corporate action"},{"name":"accountOfficerId","in":"query","type":"string","required":false,"description":"The identifier of the department head or specific account officer responsible for the customer"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from t24 on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"The identifier of the underlying Entity/Company/Branch."}],"requestBodyExample":null,"responses":{"200":"EntitlementApprovalsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}}]},{"key":"holdings-entitlements-service-v2.1.0","title":"Corporate Action Event Management","version":"v2.1.0","description":"Allows the viewing of Corporate Action Events, Options of the Entitlements, approval awaiting Entitlements and management of the Entitlements","endpointCount":7,"endpoints":[{"method":"GET","path":"/holdings/entitlements/entitlementOptions","fullPath":"/api/v2.1.0/holdings/entitlements/entitlementOptions","operationId":"getPendingEntitlements","name":"Retrieves the list of all pending entitlements","summary":"Retrieves pending entitlements","tags":[],"parameters":[{"name":"diaryId","in":"query","type":"string","required":false,"description":"Identifier of a Diary."},{"name":"portfolioId","in":"query","type":"string","required":false,"description":"Id of the portfolio or security account"},{"name":"customerId","in":"query","type":"string","required":false,"description":"Identifier of the customer"},{"name":"eventType","in":"query","type":"string","required":false,"description":"Event Type of the corporate action"},{"name":"accountOfficerId","in":"query","type":"string","required":false,"description":"The identifier of the department head or specific account officer responsible for the customer"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"PendingEntitlementsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/entitlements/{entitlementId}","fullPath":"/api/v2.1.0/holdings/entitlements/{entitlementId}","operationId":"getSecurityEntitlements","name":"Allows to view the entitlement details along with the delivery message information","summary":"Allows to view the entitlement details","tags":[],"parameters":[{"name":"entitlementId","in":"path","type":"string","required":true,"description":"The identifier of the entitlement"},{"name":"diaryId","in":"query","type":"string","required":false,"description":"Identifier of a Diary."},{"name":"portfolioId","in":"query","type":"string","required":false,"description":"Id of the portfolio or security account"},{"name":"eventType","in":"query","type":"string","required":false,"description":"Event Type of the corporate action"},{"name":"accountOfficerId","in":"query","type":"string","required":false,"description":"The identifier of the department head or specific account officer responsible for the customer"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"SecurityEntitlementsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"PUT","path":"/holdings/entitlements/{entitlementId}","fullPath":"/api/v2.1.0/holdings/entitlements/{entitlementId}","operationId":"updateSecurityEntitlement","name":"Updates the details in entitlement","summary":"Updates the entitlement","tags":[],"parameters":[{"name":"entitlementId","in":"path","type":"string","required":true,"description":"The identifier of the entitlement"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"optionDetails":[{}],"sellBuyOptionDescriptions":[{}],"localTaxAmounts":[{}],"eventResult":[{}],"brokerDetails":[{}],"eventOptionDetails":[{}],"accountCurrencyTax":[{}],"depositoryId":0.0,"portfolioId":"string","instrumentId":"string","diaryId":"string","accountId":"string","qualifyingHolding":0.0,"eventQuantity":0.0,"currency":"string"}},"responses":{"200":"SecurityEntitlementResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/holdings/entitlements/{entitlementId}/buySellRights","fullPath":"/api/v2.1.0/holdings/entitlements/{entitlementId}/buySellRights","operationId":"getEntitlementBuySellRights","name":"Updates the buy sell rights holdings","summary":"Updates buy sell rights","tags":[],"parameters":[{"name":"entitlementId","in":"path","type":"string","required":true,"description":"The identifier of the entitlement"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"EntitlementBuySellRightsResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/holdings/entitlements/{entitlementId}/buySellRights","fullPath":"/api/v2.1.0/holdings/entitlements/{entitlementId}/buySellRights","operationId":"updateEntitlementBuySellRights","name":"Retrieves the entitlement information","summary":"Retrieves entitlement information","tags":[],"parameters":[{"name":"entitlementId","in":"path","type":"string","required":true,"description":"The identifier of the entitlement"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"optionDetails":[{}],"diaryId":"string","portfolioId":"string","depositoryId":0.0,"nominee":"string","subAccount":"string","instrumentId":"string","eventType":"string","currencyId":"string","qualifyingHolding":0.0,"rightsPosition":0.0,"recordType":"string","netNominal":0.0,"generateInstruction":true,"MT566Confirmation":true}},"responses":{"200":"EntitlementBuySellRightsResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/holdings/entitlementApprovals","fullPath":"/api/v2.1.0/holdings/entitlementApprovals","operationId":"getEntitlementApprovals","name":"Retrieves the list of all unauthorised entitlements for approval","summary":"Retrieves unauthorised entitlements","tags":[],"parameters":[{"name":"diaryId","in":"query","type":"string","required":false,"description":"Identifier of a Diary."},{"name":"instrumentId","in":"query","type":"string","required":false,"description":"The identifier of the instrument"},{"name":"securityUpdate","in":"query","type":"string","required":false,"description":"Indicates to update Security Position based on Corporate Action Event processing"},{"name":"portfolioId","in":"query","type":"string","required":false,"description":"Id of the portfolio or security account"},{"name":"customerId","in":"query","type":"string","required":false,"description":"Identifier of the customer"},{"name":"accountOfficerId","in":"query","type":"string","required":false,"description":"The identifier of the department head or specific account officer responsible for the customer"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"EntitlementApprovalsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/diaries","fullPath":"/api/v2.1.0/holdings/diaries","operationId":"getDiaryDetails","name":"Allows to view the corporate action event at the Instrument level","summary":"Allows to view the corporate action event at the Instrument level","tags":[],"parameters":[{"name":"diaryId","in":"query","type":"string","required":false,"description":"Identifier of a Diary."},{"name":"instrumentId","in":"query","type":"string","required":false,"description":"The identifier of the instrument"},{"name":"eventType","in":"query","type":"string","required":false,"description":"Event Type of the corporate action"},{"name":"depositoryId","in":"query","type":"string","required":false,"description":"Id of the securities depository."},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"DiaryDetailsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}}]},{"key":"holdings-entitlements-service-v2.2.0","title":"Corporate Action Event Management","version":"v2.2.0","description":"Allows to view Corporate Action Events, Options of the Entitlements, approval awaiting Entitlements and management of the Entitlements","endpointCount":7,"endpoints":[{"method":"GET","path":"/holdings/entitlements/entitlementOptions","fullPath":"/api/v2.2.0/holdings/entitlements/entitlementOptions","operationId":"getPendingEntitlements","name":"Retrieves the list of all pending entitlements","summary":"Retrieves pending entitlements","tags":[],"parameters":[{"name":"diaryId","in":"query","type":"string","required":false,"description":"The identifier of the diary"},{"name":"portfolioId","in":"query","type":"string","required":false,"description":"Id of the portfolio or security account"},{"name":"customerId","in":"query","type":"string","required":false,"description":"Identifier of the customer"},{"name":"eventType","in":"query","type":"string","required":false,"description":"Event Type of the corporate action"},{"name":"accountOfficerId","in":"query","type":"string","required":false,"description":"The identifier of the department head or specific account officer responsible for the customer"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"PendingEntitlementsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/entitlements/{entitlementId}","fullPath":"/api/v2.2.0/holdings/entitlements/{entitlementId}","operationId":"getSecurityEntitlements","name":"Allows to view the entitlement details along with the delivery message information","summary":"Allows to view the entitlement details","tags":[],"parameters":[{"name":"entitlementId","in":"path","type":"string","required":true,"description":"The identifier of the entitlement"},{"name":"diaryId","in":"query","type":"string","required":false,"description":"The identifier of the diary"},{"name":"portfolioId","in":"query","type":"string","required":false,"description":"Id of the portfolio or security account"},{"name":"eventType","in":"query","type":"string","required":false,"description":"Event Type of the corporate action"},{"name":"accountOfficerId","in":"query","type":"string","required":false,"description":"The identifier of the department head or specific account officer responsible for the customer"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"SecurityEntitlementsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"PUT","path":"/holdings/entitlements/{entitlementId}","fullPath":"/api/v2.2.0/holdings/entitlements/{entitlementId}","operationId":"updateSecurityEntitlement","name":"Updates the details in entitlement","summary":"Updates the entitlement","tags":[],"parameters":[{"name":"entitlementId","in":"path","type":"string","required":true,"description":"The identifier of the entitlement"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"optionDetails":[{}],"sellBuyOptionDescriptions":[{}],"localTaxAmounts":[{}],"eventResult":[{}],"brokerDetails":[{}],"eventOptionDetails":[{}],"accountCurrencyTax":[{}],"depositoryId":0.0,"portfolioId":"string","instrumentId":"string","diaryId":"string","accountId":"string","qualifyingHolding":0.0,"eventQuantity":0.0,"currency":"string"}},"responses":{"200":"SecurityEntitlementResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/holdings/entitlements/{entitlementId}/buySellRights","fullPath":"/api/v2.2.0/holdings/entitlements/{entitlementId}/buySellRights","operationId":"getEntitlementBuySellRights","name":"Updates the buy sell rights holdings","summary":"Updates buy sell rights","tags":[],"parameters":[{"name":"entitlementId","in":"path","type":"string","required":true,"description":"The identifier of the entitlement"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"EntitlementBuySellRightsResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/holdings/entitlements/{entitlementId}/buySellRights","fullPath":"/api/v2.2.0/holdings/entitlements/{entitlementId}/buySellRights","operationId":"updateEntitlementBuySellRights","name":"Retrieves the entitlement information","summary":"Retrieves entitlement information","tags":[],"parameters":[{"name":"entitlementId","in":"path","type":"string","required":true,"description":"The identifier of the entitlement"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"optionDetails":[{}],"diaryId":"string","portfolioId":"string","depositoryId":0.0,"nominee":"string","subAccount":"string","instrumentId":"string","eventType":"string","currencyId":"string","qualifyingHolding":0.0,"rightsPosition":0.0,"recordType":"string","netNominal":0.0,"generateInstruction":true,"MT566Confirmation":true}},"responses":{"200":"EntitlementBuySellRightsResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/holdings/entitlementApprovals","fullPath":"/api/v2.2.0/holdings/entitlementApprovals","operationId":"getEntitlementApprovals","name":"Retrieves the list of all unauthorised entitlements for approval","summary":"Retrieves unauthorised entitlements","tags":[],"parameters":[{"name":"diaryId","in":"query","type":"string","required":false,"description":"The identifier of the diary"},{"name":"instrumentId","in":"query","type":"string","required":false,"description":"The identifier of the instrument"},{"name":"securityUpdate","in":"query","type":"string","required":false,"description":"Indicates to update Security Position based on Corporate Action Event processing"},{"name":"portfolioId","in":"query","type":"string","required":false,"description":"Id of the portfolio or security account"},{"name":"customerId","in":"query","type":"string","required":false,"description":"Identifier of the customer"},{"name":"accountOfficerId","in":"query","type":"string","required":false,"description":"The identifier of the department head or specific account officer responsible for the customer"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"EntitlementApprovalsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/diaries","fullPath":"/api/v2.2.0/holdings/diaries","operationId":"getDiaryDetails","name":"Allows to view the corporate action event at the Instrument level","summary":"Allows to view the corporate action event at the Instrument level","tags":[],"parameters":[{"name":"diaryId","in":"query","type":"string","required":false,"description":"The identifier of the diary"},{"name":"instrumentId","in":"query","type":"string","required":false,"description":"The identifier of the instrument"},{"name":"eventType","in":"query","type":"string","required":false,"description":"Event Type of the corporate action"},{"name":"depositoryId","in":"query","type":"string","required":false,"description":"Id of the securities depository."},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"DiaryDetailsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}}]},{"key":"holdings-entitlements-service-v2.3.0","title":"Corporate Action Event Management","version":"v2.3.0","description":"Allows to view Corporate Action Events, Options of the Entitlements, approval awaiting Entitlements and management of the Entitlements","endpointCount":7,"endpoints":[{"method":"GET","path":"/holdings/entitlements/entitlementOptions","fullPath":"/api/v2.3.0/holdings/entitlements/entitlementOptions","operationId":"getPendingEntitlements","name":"Retrieves the list of all pending entitlements","summary":"Retrieves pending entitlements","tags":["WEALTH"],"parameters":[{"name":"diaryId","in":"query","type":"string","required":false,"description":"The identifier of the diary"},{"name":"portfolioId","in":"query","type":"string","required":false,"description":"Id of the portfolio or security account"},{"name":"customerId","in":"query","type":"string","required":false,"description":"Identifier of the customer"},{"name":"eventType","in":"query","type":"string","required":false,"description":"Event Type of the corporate action"},{"name":"accountOfficerId","in":"query","type":"string","required":false,"description":"The identifier of the department head or specific account officer responsible for the customer"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"PendingEntitlementsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/entitlements/{entitlementId}","fullPath":"/api/v2.3.0/holdings/entitlements/{entitlementId}","operationId":"getSecurityEntitlements","name":"Allows to view the entitlement details along with the delivery message information","summary":"Allows to view the entitlement details","tags":["WEALTH"],"parameters":[{"name":"entitlementId","in":"path","type":"string","required":true,"description":"The identifier of the entitlement"},{"name":"diaryId","in":"query","type":"string","required":false,"description":"The identifier of the diary"},{"name":"portfolioId","in":"query","type":"string","required":false,"description":"Id of the portfolio or security account"},{"name":"eventType","in":"query","type":"string","required":false,"description":"Event Type of the corporate action"},{"name":"accountOfficerId","in":"query","type":"string","required":false,"description":"The identifier of the department head or specific account officer responsible for the customer"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"SecurityEntitlementsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"PUT","path":"/holdings/entitlements/{entitlementId}","fullPath":"/api/v2.3.0/holdings/entitlements/{entitlementId}","operationId":"updateSecurityEntitlement","name":"Updates the details in entitlement","summary":"Updates the entitlement","tags":["WEALTH"],"parameters":[{"name":"entitlementId","in":"path","type":"string","required":true,"description":"The identifier of the entitlement"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"optionDetails":[{}],"sellBuyOptionDescriptions":[{}],"localTaxAmounts":[{}],"eventResult":[{}],"brokerDetails":[{}],"eventOptionDetails":[{}],"accountCurrencyTax":[{}],"depositoryId":0.0,"portfolioId":"string","instrumentId":"string","diaryId":"string","accountId":"string","qualifyingHolding":0.0,"eventQuantity":0.0,"currency":"string"}},"responses":{"200":"SecurityEntitlementResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/holdings/entitlements/{entitlementId}/buySellRights","fullPath":"/api/v2.3.0/holdings/entitlements/{entitlementId}/buySellRights","operationId":"getEntitlementBuySellRights","name":"Updates the buy sell rights holdings","summary":"Updates buy sell rights","tags":["WEALTH"],"parameters":[{"name":"entitlementId","in":"path","type":"string","required":true,"description":"The identifier of the entitlement"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"EntitlementBuySellRightsResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/holdings/entitlements/{entitlementId}/buySellRights","fullPath":"/api/v2.3.0/holdings/entitlements/{entitlementId}/buySellRights","operationId":"updateEntitlementBuySellRights","name":"Retrieves the entitlement information","summary":"Retrieves entitlement information","tags":["WEALTH"],"parameters":[{"name":"entitlementId","in":"path","type":"string","required":true,"description":"The identifier of the entitlement"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"optionDetails":[{}],"diaryId":"string","portfolioId":"string","depositoryId":0.0,"nominee":"string","subAccount":"string","instrumentId":"string","eventType":"string","currencyId":"string","qualifyingHolding":0.0,"rightsPosition":0.0,"recordType":"string","netNominal":0.0,"generateInstruction":true,"MT566Confirmation":true}},"responses":{"200":"EntitlementBuySellRightsResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/holdings/entitlementApprovals","fullPath":"/api/v2.3.0/holdings/entitlementApprovals","operationId":"getEntitlementApprovals","name":"Retrieves the list of all unauthorised entitlements for approval","summary":"Retrieves unauthorised entitlements","tags":["WEALTH"],"parameters":[{"name":"diaryId","in":"query","type":"string","required":false,"description":"The identifier of the diary"},{"name":"instrumentId","in":"query","type":"string","required":false,"description":"The identifier of the instrument"},{"name":"securityUpdate","in":"query","type":"string","required":false,"description":"Indicates to update Security Position based on Corporate Action Event processing"},{"name":"portfolioId","in":"query","type":"string","required":false,"description":"Id of the portfolio or security account"},{"name":"customerId","in":"query","type":"string","required":false,"description":"Identifier of the customer"},{"name":"accountOfficerId","in":"query","type":"string","required":false,"description":"The identifier of the department head or specific account officer responsible for the customer"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"EntitlementApprovalsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/diaries","fullPath":"/api/v2.3.0/holdings/diaries","operationId":"getDiaryDetails","name":"Allows to view the corporate action event at the Instrument level","summary":"Allows to view the corporate action event at the Instrument level","tags":["WEALTH"],"parameters":[{"name":"diaryId","in":"query","type":"string","required":false,"description":"The identifier of the diary"},{"name":"instrumentId","in":"query","type":"string","required":false,"description":"The identifier of the instrument"},{"name":"eventType","in":"query","type":"string","required":false,"description":"Event Type of the corporate action"},{"name":"depositoryId","in":"query","type":"string","required":false,"description":"Id of the securities depository."},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"DiaryDetailsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}}]},{"key":"holdings-entitlements-service-v2.4.0","title":"Corporate Action Event Management","version":"v2.4.0","description":"Allows to view Corporate Action Events, Options of the Entitlements, approval awaiting Entitlements and management of the Entitlements","endpointCount":7,"endpoints":[{"method":"GET","path":"/holdings/entitlements/entitlementOptions","fullPath":"/api/v2.4.0/holdings/entitlements/entitlementOptions","operationId":"getPendingEntitlements","name":"Retrieves the list of all pending entitlements","summary":"Retrieves pending entitlements","tags":["WEALTH"],"parameters":[{"name":"diaryId","in":"query","type":"string","required":false,"description":"The identifier of the diary"},{"name":"portfolioId","in":"query","type":"string","required":false,"description":"Id of the portfolio or security account"},{"name":"customerId","in":"query","type":"string","required":false,"description":"Identifier of the customer"},{"name":"eventType","in":"query","type":"string","required":false,"description":"Indicates the type of event raised or requested from the originating system"},{"name":"accountOfficerId","in":"query","type":"string","required":false,"description":"The identifier of the department head or specific account officer responsible for the customer"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"PendingEntitlementsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/entitlements/{entitlementId}","fullPath":"/api/v2.4.0/holdings/entitlements/{entitlementId}","operationId":"getSecurityEntitlements","name":"Allows to view the entitlement details along with the delivery message information","summary":"Allows to view the entitlement details","tags":["WEALTH"],"parameters":[{"name":"entitlementId","in":"path","type":"string","required":true,"description":"The identifier of the entitlement"},{"name":"diaryId","in":"query","type":"string","required":false,"description":"The identifier of the diary"},{"name":"portfolioId","in":"query","type":"string","required":false,"description":"Id of the portfolio or security account"},{"name":"eventType","in":"query","type":"string","required":false,"description":"Indicates the type of event raised or requested from the originating system"},{"name":"accountOfficerId","in":"query","type":"string","required":false,"description":"The identifier of the department head or specific account officer responsible for the customer"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"SecurityEntitlementsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"PUT","path":"/holdings/entitlements/{entitlementId}","fullPath":"/api/v2.4.0/holdings/entitlements/{entitlementId}","operationId":"updateSecurityEntitlement","name":"Updates the details in entitlement","summary":"Updates the entitlement","tags":["WEALTH"],"parameters":[{"name":"entitlementId","in":"path","type":"string","required":true,"description":"The identifier of the entitlement"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"optionDetails":[{}],"sellBuyOptionDescriptions":[{}],"localTaxAmounts":[{}],"eventResult":[{}],"brokerDetails":[{}],"eventOptionDetails":[{}],"accountCurrencyTax":[{}],"depositoryId":0.0,"portfolioId":"string","instrumentId":"string","diaryId":"string","accountId":"string","qualifyingHolding":0.0,"eventQuantity":0.0,"currency":"string"}},"responses":{"200":"SecurityEntitlementResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/holdings/entitlements/{entitlementId}/buySellRights","fullPath":"/api/v2.4.0/holdings/entitlements/{entitlementId}/buySellRights","operationId":"getEntitlementBuySellRights","name":"Updates the buy sell rights holdings","summary":"Updates buy sell rights","tags":["WEALTH"],"parameters":[{"name":"entitlementId","in":"path","type":"string","required":true,"description":"The identifier of the entitlement"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"EntitlementBuySellRightsResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/holdings/entitlements/{entitlementId}/buySellRights","fullPath":"/api/v2.4.0/holdings/entitlements/{entitlementId}/buySellRights","operationId":"updateEntitlementBuySellRights","name":"Retrieves the entitlement information","summary":"Retrieves entitlement information","tags":["WEALTH"],"parameters":[{"name":"entitlementId","in":"path","type":"string","required":true,"description":"The identifier of the entitlement"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"optionDetails":[{}],"diaryId":"string","portfolioId":"string","depositoryId":0.0,"nominee":"string","subAccount":"string","instrumentId":"string","eventType":"string","currencyId":"string","qualifyingHolding":0.0,"rightsPosition":0.0,"recordType":"string","netNominal":0.0,"generateInstruction":true,"MT566Confirmation":true}},"responses":{"200":"EntitlementBuySellRightsResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/holdings/entitlementApprovals","fullPath":"/api/v2.4.0/holdings/entitlementApprovals","operationId":"getEntitlementApprovals","name":"Retrieves the list of all unauthorised entitlements for approval","summary":"Retrieves unauthorised entitlements","tags":["WEALTH"],"parameters":[{"name":"diaryId","in":"query","type":"string","required":false,"description":"The identifier of the diary"},{"name":"instrumentId","in":"query","type":"string","required":false,"description":"The identifier of the instrument"},{"name":"securityUpdate","in":"query","type":"string","required":false,"description":"Indicates to update Security Position based on Corporate Action Event processing"},{"name":"portfolioId","in":"query","type":"string","required":false,"description":"Id of the portfolio or security account"},{"name":"customerId","in":"query","type":"string","required":false,"description":"Identifier of the customer"},{"name":"accountOfficerId","in":"query","type":"string","required":false,"description":"The identifier of the department head or specific account officer responsible for the customer"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"EntitlementApprovalsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/diaries","fullPath":"/api/v2.4.0/holdings/diaries","operationId":"getDiaryDetails","name":"Allows to view the corporate action event at the Instrument level","summary":"Allows to view the corporate action event at the Instrument level","tags":["WEALTH"],"parameters":[{"name":"diaryId","in":"query","type":"string","required":false,"description":"The identifier of the diary"},{"name":"instrumentId","in":"query","type":"string","required":false,"description":"The identifier of the instrument"},{"name":"eventType","in":"query","type":"string","required":false,"description":"Indicates the type of event raised or requested from the originating system"},{"name":"depositoryId","in":"query","type":"string","required":false,"description":"Id of the securities depository."},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"DiaryDetailsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}}]},{"key":"holdings-entitlements-service-v2.4.1","title":"Corporate action event management","version":"v2.4.1","description":"Allows to view corporate action events, options of the entitlements, approval awaiting entitlements and management of the entitlements","endpointCount":7,"endpoints":[{"method":"GET","path":"/holdings/entitlements/entitlementOptions","fullPath":"/api/v2.4.1/holdings/entitlements/entitlementOptions","operationId":"getPendingEntitlements","name":"Retrieves the list of all pending entitlements","summary":"Retrieves pending entitlements","tags":["WEALTH"],"parameters":[{"name":"diaryId","in":"query","type":"string","required":false,"description":"The identifier of the diary"},{"name":"portfolioId","in":"query","type":"string","required":false,"description":"Id of the portfolio or security account"},{"name":"customerId","in":"query","type":"string","required":false,"description":"Identifier of the customer"},{"name":"eventType","in":"query","type":"string","required":false,"description":"Indicates the type of event raised or requested from the originating system"},{"name":"accountOfficerId","in":"query","type":"string","required":false,"description":"The identifier of the department head or specific account officer responsible for the customer"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"PendingEntitlementsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/entitlements/{entitlementId}","fullPath":"/api/v2.4.1/holdings/entitlements/{entitlementId}","operationId":"getSecurityEntitlements","name":"Allows to view the entitlement details along with the delivery message information","summary":"Allows to view the entitlement details","tags":["WEALTH"],"parameters":[{"name":"entitlementId","in":"path","type":"string","required":true,"description":"The identifier of the entitlement"},{"name":"diaryId","in":"query","type":"string","required":false,"description":"The identifier of the diary"},{"name":"portfolioId","in":"query","type":"string","required":false,"description":"Id of the portfolio or security account"},{"name":"eventType","in":"query","type":"string","required":false,"description":"Indicates the type of event raised or requested from the originating system"},{"name":"accountOfficerId","in":"query","type":"string","required":false,"description":"The identifier of the department head or specific account officer responsible for the customer"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"SecurityEntitlementsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"PUT","path":"/holdings/entitlements/{entitlementId}","fullPath":"/api/v2.4.1/holdings/entitlements/{entitlementId}","operationId":"updateSecurityEntitlement","name":"Updates the details in entitlement","summary":"Updates the entitlement","tags":["WEALTH"],"parameters":[{"name":"entitlementId","in":"path","type":"string","required":true,"description":"The identifier of the entitlement"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"optionDetails":[{}],"sellBuyOptionDescriptions":[{}],"localTaxAmounts":[{}],"eventResult":[{}],"brokerDetails":[{}],"eventOptionDetails":[{}],"accountCurrencyTax":[{}],"depositoryId":0.0,"portfolioId":"string","instrumentId":"string","diaryId":"string","accountId":"string","qualifyingHolding":0.0,"eventQuantity":0.0,"currency":"string"}},"responses":{"200":"SecurityEntitlementResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/holdings/entitlements/{entitlementId}/buySellRights","fullPath":"/api/v2.4.1/holdings/entitlements/{entitlementId}/buySellRights","operationId":"getEntitlementBuySellRights","name":"Updates the buy sell rights holdings","summary":"Updates buy sell rights","tags":["WEALTH"],"parameters":[{"name":"entitlementId","in":"path","type":"string","required":true,"description":"The identifier of the entitlement"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"EntitlementBuySellRightsResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/holdings/entitlements/{entitlementId}/buySellRights","fullPath":"/api/v2.4.1/holdings/entitlements/{entitlementId}/buySellRights","operationId":"updateEntitlementBuySellRights","name":"Retrieves the entitlement information","summary":"Retrieves entitlement information","tags":["WEALTH"],"parameters":[{"name":"entitlementId","in":"path","type":"string","required":true,"description":"The identifier of the entitlement"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"optionDetails":[{}],"diaryId":"string","portfolioId":"string","depositoryId":0.0,"nominee":"string","subAccount":"string","instrumentId":"string","eventType":"string","currencyId":"string","qualifyingHolding":0.0,"rightsPosition":0.0,"recordType":"string","netNominal":0.0,"generateInstruction":true,"MT566Confirmation":true}},"responses":{"200":"EntitlementBuySellRightsResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/holdings/entitlementApprovals","fullPath":"/api/v2.4.1/holdings/entitlementApprovals","operationId":"getEntitlementApprovals","name":"Retrieves the list of all unauthorised entitlements for approval","summary":"Retrieves unauthorised entitlements","tags":["WEALTH"],"parameters":[{"name":"diaryId","in":"query","type":"string","required":false,"description":"The identifier of the diary"},{"name":"instrumentId","in":"query","type":"string","required":false,"description":"The identifier of the instrument"},{"name":"securityUpdate","in":"query","type":"string","required":false,"description":"Indicates to update Security Position based on Corporate Action Event processing"},{"name":"portfolioId","in":"query","type":"string","required":false,"description":"Id of the portfolio or security account"},{"name":"customerId","in":"query","type":"string","required":false,"description":"Identifier of the customer"},{"name":"eventType","in":"query","type":"string","required":false,"description":"Indicates the type of event raised or requested from the originating system"},{"name":"accountOfficerId","in":"query","type":"string","required":false,"description":"The identifier of the department head or specific account officer responsible for the customer"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"EntitlementApprovalsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/diaries","fullPath":"/api/v2.4.1/holdings/diaries","operationId":"getDiaryDetails","name":"Allows to view the corporate action event at the Instrument level","summary":"Allows to view the corporate action event at the Instrument level","tags":["WEALTH"],"parameters":[{"name":"diaryId","in":"query","type":"string","required":false,"description":"The identifier of the diary"},{"name":"instrumentId","in":"query","type":"string","required":false,"description":"The identifier of the instrument"},{"name":"eventType","in":"query","type":"string","required":false,"description":"Indicates the type of event raised or requested from the originating system"},{"name":"depositoryId","in":"query","type":"string","required":false,"description":"Id of the securities depository."},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"DiaryDetailsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}}]},{"key":"holdings-entitlements-service-v2.5.1","title":"Corporate action event management","version":"v2.5.1","description":"Allows to view corporate action events, options of the entitlements, approval awaiting entitlements and management of the entitlements","endpointCount":7,"endpoints":[{"method":"GET","path":"/holdings/entitlements/entitlementOptions","fullPath":"/api/v2.5.1/holdings/entitlements/entitlementOptions","operationId":"getPendingEntitlements","name":"Retrieves the list of all pending entitlements","summary":"Retrieves pending entitlements","tags":["WEALTH"],"parameters":[{"name":"diaryId","in":"query","type":"string","required":false,"description":"The identifier of the diary"},{"name":"portfolioId","in":"query","type":"string","required":false,"description":"Id of the portfolio or security account"},{"name":"customerId","in":"query","type":"string","required":false,"description":"Identifier of the customer"},{"name":"eventType","in":"query","type":"string","required":false,"description":"Indicates the type of event raised or requested from the originating system"},{"name":"accountOfficerId","in":"query","type":"string","required":false,"description":"The identifier of the department head or specific account officer responsible for the customer"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"PendingEntitlementsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/entitlements/{entitlementId}","fullPath":"/api/v2.5.1/holdings/entitlements/{entitlementId}","operationId":"getSecurityEntitlements","name":"Allows to view the entitlement details along with the delivery message information","summary":"Allows to view the entitlement details","tags":["WEALTH"],"parameters":[{"name":"entitlementId","in":"path","type":"string","required":true,"description":"The identifier of the entitlement"},{"name":"diaryId","in":"query","type":"string","required":false,"description":"The identifier of the diary"},{"name":"portfolioId","in":"query","type":"string","required":false,"description":"Id of the portfolio or security account"},{"name":"eventType","in":"query","type":"string","required":false,"description":"Indicates the type of event raised or requested from the originating system"},{"name":"accountOfficerId","in":"query","type":"string","required":false,"description":"The identifier of the department head or specific account officer responsible for the customer"},{"name":"optionStatus","in":"query","type":"string","required":false,"description":"Indicates the current status of the Entitlement"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"SecurityEntitlementsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"PUT","path":"/holdings/entitlements/{entitlementId}","fullPath":"/api/v2.5.1/holdings/entitlements/{entitlementId}","operationId":"updateSecurityEntitlement","name":"Updates the details in entitlement","summary":"Updates the entitlement","tags":["WEALTH"],"parameters":[{"name":"entitlementId","in":"path","type":"string","required":true,"description":"The identifier of the entitlement"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"optionDetails":[{}],"sellBuyOptionDescriptions":[{}],"localTaxAmounts":[{}],"eventResult":[{}],"brokerDetails":[{}],"eventOptionDetails":[{}],"accountCurrencyTax":[{}],"depositoryId":0.0,"portfolioId":"string","instrumentId":"string","diaryId":"string","accountId":"string","qualifyingHolding":0.0,"eventQuantity":0.0,"currency":"string"}},"responses":{"200":"SecurityEntitlementResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/holdings/entitlements/{entitlementId}/buySellRights","fullPath":"/api/v2.5.1/holdings/entitlements/{entitlementId}/buySellRights","operationId":"getEntitlementBuySellRights","name":"Updates the buy sell rights holdings","summary":"Updates buy sell rights","tags":["WEALTH"],"parameters":[{"name":"entitlementId","in":"path","type":"string","required":true,"description":"The identifier of the entitlement"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"EntitlementBuySellRightsResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/holdings/entitlements/{entitlementId}/buySellRights","fullPath":"/api/v2.5.1/holdings/entitlements/{entitlementId}/buySellRights","operationId":"updateEntitlementBuySellRights","name":"Retrieves the entitlement information","summary":"Retrieves entitlement information","tags":["WEALTH"],"parameters":[{"name":"entitlementId","in":"path","type":"string","required":true,"description":"The identifier of the entitlement"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"optionDetails":[{}],"diaryId":"string","portfolioId":"string","depositoryId":0.0,"nominee":"string","subAccount":"string","instrumentId":"string","eventType":"string","currencyId":"string","qualifyingHolding":0.0,"rightsPosition":0.0,"recordType":"string","netNominal":0.0,"generateInstruction":true,"MT566Confirmation":true}},"responses":{"200":"EntitlementBuySellRightsResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/holdings/entitlementApprovals","fullPath":"/api/v2.5.1/holdings/entitlementApprovals","operationId":"getEntitlementApprovals","name":"Retrieves the list of all unauthorised entitlements for approval","summary":"Retrieves unauthorised entitlements","tags":["WEALTH"],"parameters":[{"name":"diaryId","in":"query","type":"string","required":false,"description":"The identifier of the diary"},{"name":"instrumentId","in":"query","type":"string","required":false,"description":"The identifier of the instrument"},{"name":"securityUpdate","in":"query","type":"string","required":false,"description":"Indicates to update Security Position based on Corporate Action Event processing"},{"name":"portfolioId","in":"query","type":"string","required":false,"description":"Id of the portfolio or security account"},{"name":"customerId","in":"query","type":"string","required":false,"description":"Identifier of the customer"},{"name":"eventType","in":"query","type":"string","required":false,"description":"Indicates the type of event raised or requested from the originating system"},{"name":"accountOfficerId","in":"query","type":"string","required":false,"description":"The identifier of the department head or specific account officer responsible for the customer"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"EntitlementApprovalsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/diaries","fullPath":"/api/v2.5.1/holdings/diaries","operationId":"getDiaryDetails","name":"Allows to view the corporate action event at the Instrument level","summary":"Allows to view the corporate action event at the Instrument level","tags":["WEALTH"],"parameters":[{"name":"diaryId","in":"query","type":"string","required":false,"description":"The identifier of the diary"},{"name":"instrumentId","in":"query","type":"string","required":false,"description":"The identifier of the instrument"},{"name":"eventType","in":"query","type":"string","required":false,"description":"Indicates the type of event raised or requested from the originating system"},{"name":"depositoryId","in":"query","type":"string","required":false,"description":"Id of the securities depository."},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"DiaryDetailsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}}]},{"key":"holdings-evidence-v1.0.0","title":"Evidence API","version":"v1.0.0","description":"Captures the covenants and conditions details for a loan account. Covenants are requested in periodic basis and the Conditions are one-time evidence. On non-submission or non-compliance of the evidences, the related consequent activity will be restricted","endpointCount":3,"endpoints":[{"method":"POST","path":"/holdings/evidence/annualFinancialStatement","fullPath":"/api/v1.0.0/holdings/evidence/annualFinancialStatement","operationId":"acceptAnnualFinancialStatement","name":"Captures and accepts the annual financial statement details like debt equity ratio, profit or loss and turnover of the company","summary":"Captures and accepts the annual financial statement details","tags":["RETAIL"],"parameters":[{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"payload","in":"body","type":"object","required":true,"description":""}],"requestBodyExample":null,"responses":{"200":"annualFinancialStatementResponse","default":"annualFinancialStatementError"}},{"method":"POST","path":"/holdings/evidence/incorporationCertificate","fullPath":"/api/v1.0.0/holdings/evidence/incorporationCertificate","operationId":"acceptIncorporationCertificate","name":"Captures and accepts the incorporation certificate details like entity name, type, incorporation date","summary":"Captures and accepts the incorporation certificate details.","tags":["RETAIL"],"parameters":[{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"payload","in":"body","type":"object","required":true,"description":""}],"requestBodyExample":null,"responses":{"200":"incorporationCertificateResponse","default":"incorporationCertificateError"}},{"method":"POST","path":"/holdings/evidence/quarterlyFinancialStatement","fullPath":"/api/v1.0.0/holdings/evidence/quarterlyFinancialStatement","operationId":"acceptQuarterlyFinancialStatement","name":"Captures and accepts the quarterly financial statement details like debt equity ratio, profit or loss and turnover of the company","summary":"Captures and accepts the quarterly financial statement details.","tags":["RETAIL"],"parameters":[{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"payload","in":"body","type":"object","required":true,"description":""}],"requestBodyExample":null,"responses":{"200":"quarterlyFinancialStmtResponse","default":"quarterlyFinancialStmtError"}}]},{"key":"holdings-externalAccounts-v1.0.0","title":"External Account Arrangements","version":"v1.0.0","description":"The Arrangement Architecture is a Temenos Transact Framework to create and manage  various products such as Loans, Deposits, Accounts, etc. It provides a modular business component-based architecture, whereby users can create their Products by using the components provided by Temenos and these compo","endpointCount":5,"endpoints":[{"method":"POST","path":"/holdings/accounts/externalAccounts","fullPath":"/api/v1.0.0/holdings/accounts/externalAccounts","operationId":"createExternalAccounts","name":"Creates an external account to mirror the balances of accounts held in the external/source systems for the purpose of overdraft protection.","summary":"Create an external account","tags":["RETAIL"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"effectiveDate":"2024-01-01","partyId":"string","productId":"string","currencyId":"string","extensions":{},"balance":[{}]}},"responses":{"200":"createExternalAccountsResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"PUT","path":"/holdings/accounts/externalAccounts/{externalAccountId}/accountClosures","fullPath":"/api/v1.0.0/holdings/accounts/externalAccounts/{externalAccountId}/accountClosures","operationId":"closeExternalAccounts","name":"Perform the closure of an external account","summary":"closeExternalAccounts","tags":["RETAIL"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"externalAccountId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"closureReason":"string","extensions":{}}},"responses":{"200":"closeExternalAccountsResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"PUT","path":"/holdings/accounts/externalAccounts/{externalAccountId}/commitmentAmount","fullPath":"/api/v1.0.0/holdings/accounts/externalAccounts/{externalAccountId}/commitmentAmount","operationId":"updateExternalAccountCommitmentBalances","name":"Updates the commitment balance of an external account that is fed from the source system","summary":"Update commitment balance of an external account","tags":["RETAIL"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"externalAccountId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"effectiveDate":"string","currencyId":"string","transactionAmount":"string","extensions":{}}},"responses":{"200":"updateExternalAccountCommitmentBalancesResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"PUT","path":"/holdings/accounts/externalAccounts/{externalAccountId}/utilisedAmount","fullPath":"/api/v1.0.0/holdings/accounts/externalAccounts/{externalAccountId}/utilisedAmount","operationId":"updateExternalAccountUtilisedAmounts","name":"Update drawing or utilised balance of an external account that is fed from the source system","summary":"Update drawing or utilisation balance of an external account","tags":["RETAIL"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"externalAccountId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"effectiveDate":"string","currencyId":"string","transactionAmount":"string","extensions":{}}},"responses":{"200":"updateExternalAccountUtilisedAmountsResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"GET","path":"/holdings/accounts/externalAccounts/{externalAccountId}","fullPath":"/api/v1.0.0/holdings/accounts/externalAccounts/{externalAccountId}","operationId":"getExternalAccountDetails","name":"Get the details of external account","summary":"Get the details of the external account inlcuding the account alternate reference, account name, currency, commitment balance and drawing balance","tags":["RETAIL"],"parameters":[{"name":"externalAccountId","in":"path","type":"string","required":true,"description":""},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"ExternalAccountDetailsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}}]},{"key":"holdings-externalAccounts-v1.1.0","title":"External Account Arrangements","version":"v1.1.0","description":"The Arrangement Architecture is a Temenos Transact Framework to create and manage  various products such as Loans, Deposits, Accounts, etc. It provides a modular business component-based architecture, whereby users can create their Products by using the components provided by Temenos and these compo","endpointCount":5,"endpoints":[{"method":"POST","path":"/holdings/accounts/externalAccounts","fullPath":"/api/v1.1.0/holdings/accounts/externalAccounts","operationId":"createExternalAccounts","name":"Creates an external account to mirror the balances of accounts held in the external/source systems for the purpose of overdraft protection.","summary":"Create an external account","tags":["RETAIL"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"effectiveDate":"2024-01-01","partyId":"string","productId":"string","currencyId":"string","extensions":{},"balance":[{}]}},"responses":{"200":"createExternalAccountsResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"PUT","path":"/holdings/accounts/externalAccounts/{externalAccountId}/accountClosures","fullPath":"/api/v1.1.0/holdings/accounts/externalAccounts/{externalAccountId}/accountClosures","operationId":"closeExternalAccounts","name":"Perform the closure of an external account","summary":"Closure of external account","tags":["RETAIL"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"externalAccountId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"closureReason":"string","extensions":{}}},"responses":{"200":"closeExternalAccountsResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"PUT","path":"/holdings/accounts/externalAccounts/{externalAccountId}/commitmentAmount","fullPath":"/api/v1.1.0/holdings/accounts/externalAccounts/{externalAccountId}/commitmentAmount","operationId":"updateExternalAccountCommitmentBalances","name":"Updates the commitment balance of an external account that is fed from the source system","summary":"Update commitment balance of an external account","tags":["RETAIL"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"externalAccountId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"effectiveDate":"string","currencyId":"string","transactionAmount":"string","extensions":{}}},"responses":{"200":"updateExternalAccountCommitmentBalancesResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"PUT","path":"/holdings/accounts/externalAccounts/{externalAccountId}/utilisedAmount","fullPath":"/api/v1.1.0/holdings/accounts/externalAccounts/{externalAccountId}/utilisedAmount","operationId":"updateExternalAccountUtilisedAmounts","name":"Update drawing or utilised balance of an external account that is fed from the source system","summary":"Update drawing or utilisation balance of an external account","tags":["RETAIL"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"externalAccountId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"effectiveDate":"string","currencyId":"string","transactionAmount":"string","extensions":{}}},"responses":{"200":"updateExternalAccountUtilisedAmountsResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"GET","path":"/holdings/accounts/externalAccounts/{externalAccountId}","fullPath":"/api/v1.1.0/holdings/accounts/externalAccounts/{externalAccountId}","operationId":"getExternalAccountDetails","name":"Retrieve external account details including the account alternate reference, account name, currency, commitment balance and drawing balance","summary":"Retrieve external account details","tags":["RETAIL"],"parameters":[{"name":"externalAccountId","in":"path","type":"string","required":true,"description":""},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"ExternalAccountDetailsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}}]},{"key":"holdings-externalAccounts-v1.2.0","title":"External Account Arrangements","version":"v1.2.0","description":"The Arrangement Architecture is a Temenos Transact Framework to create and manage  various products such as Loans, Deposits, Accounts, etc. It provides a modular business component-based architecture, whereby users can create their Products by using the components provided by Temenos and these compo","endpointCount":5,"endpoints":[{"method":"POST","path":"/holdings/accounts/externalAccounts","fullPath":"/api/v1.2.0/holdings/accounts/externalAccounts","operationId":"createExternalAccounts","name":"Creates an external account to mirror the balances of accounts held in the external/source systems for the purpose of overdraft protection.","summary":"Create an external account","tags":["RETAIL"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"effectiveDate":"2024-01-01","partyId":"string","productId":"string","currencyId":"string","extensions":{},"balance":[{}]}},"responses":{"200":"createExternalAccountsResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"PUT","path":"/holdings/accounts/externalAccounts/{externalAccountId}/accountClosures","fullPath":"/api/v1.2.0/holdings/accounts/externalAccounts/{externalAccountId}/accountClosures","operationId":"closeExternalAccounts","name":"Perform the closure of an external account","summary":"Closure of external account","tags":["RETAIL"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"externalAccountId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"closureReason":"string","extensions":{}}},"responses":{"200":"closeExternalAccountsResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"PUT","path":"/holdings/accounts/externalAccounts/{externalAccountId}/commitmentAmount","fullPath":"/api/v1.2.0/holdings/accounts/externalAccounts/{externalAccountId}/commitmentAmount","operationId":"updateExternalAccountCommitmentBalances","name":"Updates the commitment balance of an external account that is fed from the source system","summary":"Update commitment balance of an external account","tags":["RETAIL"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"externalAccountId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"effectiveDate":"string","currencyId":"string","transactionAmount":"string","extensions":{}}},"responses":{"200":"updateExternalAccountCommitmentBalancesResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"PUT","path":"/holdings/accounts/externalAccounts/{externalAccountId}/utilisedAmount","fullPath":"/api/v1.2.0/holdings/accounts/externalAccounts/{externalAccountId}/utilisedAmount","operationId":"updateExternalAccountUtilisedAmounts","name":"Update drawing or utilised balance of an external account that is fed from the source system","summary":"Update drawing or utilisation balance of an external account","tags":["RETAIL"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"externalAccountId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"effectiveDate":"string","currencyId":"string","transactionAmount":"string","extensions":{}}},"responses":{"200":"updateExternalAccountUtilisedAmountsResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"GET","path":"/holdings/accounts/externalAccounts/{externalAccountId}","fullPath":"/api/v1.2.0/holdings/accounts/externalAccounts/{externalAccountId}","operationId":"getExternalAccountDetails","name":"Retrieve external account details including the account alternate reference, account name, currency, commitment balance and drawing balance","summary":"Retrieve external account details","tags":["RETAIL"],"parameters":[{"name":"externalAccountId","in":"path","type":"string","required":true,"description":"Indicates the account number of the external arrangement account mirrored in Transact"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"ExternalAccountDetailsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}}]},{"key":"holdings-facilities-arrangements-v1.1.0","title":"Retrieves the details of a facility arrangement account","version":"v1.1.0","description":"Retrieves the details of a facility arrangement account. It includes purchase summary and details of drawings such as interest rates, installment dates, installment amounts, total payment amounts and cash back applicable for the installment products under the facility arrangement","endpointCount":4,"endpoints":[{"method":"GET","path":"/holdings/facilities/{facilityId}/drawings","fullPath":"/api/v1.1.0/holdings/facilities/{facilityId}/drawings","operationId":"getFacilityDrawingDetails","name":"Retrieves the details of a facility arrangement account. It includes the details of drawings linked under the facility account such as drawing id, installment amount, maturity date, settled bills count, settled bills amount, etc","summary":"Retrieves the details of a facility arrangement account","tags":["RETAIL"],"parameters":[{"name":"facilityId","in":"path","type":"string","required":true,"description":"Unique identifier (contract number) of the facility"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"FacilityDrawingDetailsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/facilities/{facilityId}/installments/{transactionAmount}","fullPath":"/api/v1.1.0/holdings/facilities/{facilityId}/installments/{transactionAmount}","operationId":"getFacilityInstallments","name":"Retrieves the interest rates, installment dates, installment amounts, total payment amounts and cash back applicable for the installment products under the facility arrangement account","summary":"Retrieves the details of the installments undert the facility account","tags":["RETAIL"],"parameters":[{"name":"facilityId","in":"path","type":"string","required":true,"description":"Unique identifier (contract number) of the facility"},{"name":"transactionAmount","in":"path","type":"string","required":true,"description":"Contains the transaction amount. This is based on the currency, either local or foreign currency"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"FacilityInstallmentsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/facilities/purchases","fullPath":"/api/v1.1.0/holdings/facilities/purchases","operationId":"getPosTxnDetails","name":"Retrieves the recent purchase summary. It includes merchant name, merchant beneficiary id, merchant account id, purchase amount, purchase description, etc","summary":"Retrieves the recent purchase summary","tags":["RETAIL"],"parameters":[{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"PosTxnDetailsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"POST","path":"/holdings/facilities/installmentLoans","fullPath":"/api/v1.1.0/holdings/facilities/installmentLoans","operationId":"Installment Loans","name":"Create a installment loan for the given product by providing the principal amount, term, payment frequency and start date, etc","summary":"Create a installment loan for the given product","tags":["RETAIL"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"customers":[{}],"arrangmentId":"string","currency":"string","facilityId":"string","effectiveDate":"string","activity":"string","productId":"string","extensions":{},"account":[{}],"schedule":[{}],"settlement":[{}],"commitment":[{}]}},"responses":{"200":"Installment LoansResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}}]},{"key":"holdings-facilities-arrangements-v2.0.0","title":"Retrieves the details of a facility arrangement account","version":"v2.0.0","description":"Retrieves the details of a facility arrangement account. It includes purchase summary and details of drawings such as interest rates, installment dates, installment amounts, total payment amounts and cash back applicable for the installment products under the facility arrangement","endpointCount":5,"endpoints":[{"method":"GET","path":"/holdings/facilities/{facilityId}/drawings/loans","fullPath":"/api/v2.0.0/holdings/facilities/{facilityId}/drawings/loans","operationId":"getFacilityDrawingLoanDetails","name":"Retrieves the details of a facility arrangement account. It includes the details of drawings linked under the facility account such as drawing id, installment amount, maturity date, settled bills count, settled bills amount, etc","summary":"Retrieves the details of a facility arrangement account","tags":["RETAIL"],"parameters":[{"name":"facilityId","in":"path","type":"string","required":true,"description":"Unique identifier (contract number) of the facility"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"FacilityDrawingLoanDetailsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/facilities/{facilityId}/installments/{transactionAmount}","fullPath":"/api/v2.0.0/holdings/facilities/{facilityId}/installments/{transactionAmount}","operationId":"getFacilityInstallments","name":"Retrieves the interest rates, installment dates, installment amounts, total payment amounts and cash back applicable for the installment products under the facility arrangement account","summary":"Retrieves the details of the installments undert the facility account","tags":["RETAIL"],"parameters":[{"name":"facilityId","in":"path","type":"string","required":true,"description":"Unique identifier (contract number) of the facility"},{"name":"transactionAmount","in":"path","type":"string","required":true,"description":"Contains the transaction amount. This is based on the currency, either local or foreign currency"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"FacilityInstallmentsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/facilities/purchases","fullPath":"/api/v2.0.0/holdings/facilities/purchases","operationId":"getPosTxnDetails","name":"Retrieves the recent purchase summary. It includes merchant name, merchant beneficiary id, merchant account id, purchase amount, purchase description, etc","summary":"Retrieves the recent purchase summary","tags":["RETAIL"],"parameters":[{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"PosTxnDetailsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"POST","path":"/holdings/facilities/installmentLoans","fullPath":"/api/v2.0.0/holdings/facilities/installmentLoans","operationId":"Installment Loans","name":"Create an installment loan for the given product by providing the principal amount, term, payment frequency and start date, etc","summary":"Create an installment loan for the given product","tags":["RETAIL"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"customers":[{}],"arrangmentId":"string","currency":"string","facilityId":"string","effectiveDate":"string","activity":"string","productId":"string","extensions":{},"account":[{}],"schedule":[{}],"settlement":[{}],"commitment":[{}]}},"responses":{"200":"Installment LoansResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"PUT","path":"/holdings/facilities/{facilityId}/evidences","fullPath":"/api/v2.0.0/holdings/facilities/{facilityId}/evidences","operationId":"updateEvidenceFacility","name":"Performs update of covenants and conditions for a facility. Covenants are requested in periodic basis and the Conditions are one-time evidence. On non-submission or non-compliance of the evidences, the related consequent activity will be restricted","summary":"Update the covenants and conditions for a facility","tags":["RETAIL"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"facilityId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"partyIds":[{}],"partyRoles":[{}],"agentCustomerIds":[{}],"agentArrangementIds":[{}],"agentRoles":[{}],"arrangmentId":"string","productId":"string","activityId":"string","currency":"string","productVariation":"string","pricingSelection":"string","pricingPlan":"string","rewardsArrangementId":"string","tradeDate":"string","arrangementEffectiveDate":"string"}},"responses":{"200":"updateEvidenceFacilityResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}}]},{"key":"holdings-facilitiesProductCatalog-service-v1.0.0","title":"Get Facility product catalog","version":"v1.0.0","description":"API for fetching the facility product catalog-deprecated. The new URL is: api/v1.0.0/holdings/creditAgreements/facilities/{facilityId}/drawingProducts","endpointCount":1,"endpoints":[{"method":"GET","path":"/holdings/facilities/{facilityId}/drawdowns/productCatalogues","fullPath":"/api/v1.0.0/holdings/facilities/{facilityId}/drawdowns/productCatalogues","operationId":"getFacilityProductCatalog","name":"API for fetching the facility product catalog-deprecated. The new URL is: api/v1.0.0/holdings/creditAgreements/facilities/{facilityId}/drawingProducts","summary":"API for fetching the facility product catalog","tags":[],"parameters":[{"name":"facilityId","in":"path","type":"string","required":true,"description":"Unique identifier (contract number) of the facility"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from t24 on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"FacilityProductCatalogResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}}]},{"key":"holdings-financialAccounting-service-v1.0.0","title":"Financial Accounting details","version":"v1.0.0","description":"API to manage financial accounting related infomartion such as updating, retrieving and deleting journal entries, general ledger account.","endpointCount":7,"endpoints":[{"method":"POST","path":"/holdings/financialAccounting/journalEntries","fullPath":"/api/v1.0.0/holdings/financialAccounting/journalEntries","operationId":"createAccountingJournalEntries","name":"Creates accounting journal entries for a financial transaction for a particular posting date.","summary":"Creates accounting journal entries","tags":[],"parameters":[{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"externalTransactionDetails":[{}]}},"responses":{"200":"AccountingJournalEntriesResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/holdings/financialAccounting/{transactionId}/journalEntries","fullPath":"/api/v1.0.0/holdings/financialAccounting/{transactionId}/journalEntries","operationId":"getAccountingJournalEntries","name":"Retrieves the details of the accounting journal entries for a particular transaction.","summary":"Retrieves the accounting journal entries","tags":[],"parameters":[{"name":"transactionId","in":"path","type":"string","required":true,"description":"Unique transaction identifier for retrieving the details of the transaction. For example: FT0102030333 etc."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"AccountingJournalEntriesResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"DELETE","path":"/holdings/financialAccounting/{transactionId}/journalEntries","fullPath":"/api/v1.0.0/holdings/financialAccounting/{transactionId}/journalEntries","operationId":"deleteAccountingJournalEntries","name":" Deletes the accounting journal entries of a financial transaction for a particular posting date.","summary":"Deletes the accounting journal entries","tags":[],"parameters":[{"name":"transactionId","in":"path","type":"string","required":true,"description":"Unique transaction identifier for retrieving the details of the transaction. For example: FT0102030333 etc."},{"name":"payload","in":"body","type":"object","required":false,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}}},"responses":{"200":"AccountingJournalEntriesResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/holdings/financialAccounting/generalLedgerAccounts/{generalLedgerAccountId}","fullPath":"/api/v1.0.0/holdings/financialAccounting/generalLedgerAccounts/{generalLedgerAccountId}","operationId":"getGeneralLedgerAccount","name":"Updates the general ledger account details such as customer id, currency, maturity date etc. ","summary":"Updates the information related to the general ledger account.","tags":[],"parameters":[{"name":"generalLedgerAccountId","in":"path","type":"string","required":true,"description":"Contains the identifier of the general ledger account which holds all the transaction data needed to produce general ledger."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"GeneralLedgerAccountResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"POST","path":"/holdings/financialAccounting/generalLedgerAccounts/{generalLedgerAccountId}","fullPath":"/api/v1.0.0/holdings/financialAccounting/generalLedgerAccounts/{generalLedgerAccountId}","operationId":"createGeneralLedgerAccount","name":"Creates the general ledger account with details such as customer id, currency, category, account officer etc. The journal entries will be raised against this general ledger account.","summary":"Creates the general ledger account against which the journal entries will be raised.","tags":[],"parameters":[{"name":"generalLedgerAccountId","in":"path","type":"string","required":true,"description":"Contains the identifier of the general ledger account which holds all the transaction data needed to produce general ledger."},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"customerIds":[{}],"primaryCustomers":[{}],"jointOwnershipPercentages":[{}],"jointOwners":[{}],"generalLedgerCustomerId":"string","categoryId":"string","positionType":"string","currency":"string","currencyMarket":"string","accountOfficer":"string","valueDate":"string","maturityDate":"string","bookingDate":"string","contractId":"string","companyId":"string"}},"responses":{"200":"GeneralLedgerAccountResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/holdings/financialAccounting/generalLedgerAccounts/{generalLedgerAccountId}","fullPath":"/api/v1.0.0/holdings/financialAccounting/generalLedgerAccounts/{generalLedgerAccountId}","operationId":"updateGeneralLedgerAccount","name":"Updates the general ledger account details such as customer id, currency, maturity date etc.","summary":"Updates the information related to the general ledger account.","tags":[],"parameters":[{"name":"generalLedgerAccountId","in":"path","type":"string","required":true,"description":"Contains the identifier of the general ledger account which holds all the transaction data needed to produce general ledger."},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"customerIds":[{}],"primaryCustomers":[{}],"jointOwnershipPercentages":[{}],"jointOwners":[{}],"generalLedgerCustomerId":"string","categoryId":"string","positionType":"string","currency":"string","currencyMarket":"string","accountOfficer":"string","valueDate":"string","maturityDate":"string","bookingDate":"string","contractId":"string","companyId":"string"}},"responses":{"200":"GeneralLedgerAccountResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"DELETE","path":"/holdings/financialAccounting/generalLedgerAccounts/{generalLedgerAccountId}","fullPath":"/api/v1.0.0/holdings/financialAccounting/generalLedgerAccounts/{generalLedgerAccountId}","operationId":"deleteGeneralLedgerAccount","name":"Close the general ledger account which contains static information such as customer id, currency, category, account officer etc.","summary":"Closure of general ledger account.","tags":[],"parameters":[{"name":"generalLedgerAccountId","in":"path","type":"string","required":true,"description":"Contains the identifier of the general ledger account which holds all the transaction data needed to produce general ledger."},{"name":"payload","in":"body","type":"object","required":false,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}}},"responses":{"200":"GeneralLedgerAccountResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}}]},{"key":"holdings-forexUtilisations-service-v1.0.0","title":"Management of Forex Utilisations","version":"v1.0.0","description":"Allows management of Forex utilisations for external settlement contracts ","endpointCount":3,"endpoints":[{"method":"GET","path":"/holdings/treasury/forex/utilisations/{utilisationId}","fullPath":"/api/v1.0.0/holdings/treasury/forex/utilisations/{utilisationId}","operationId":"getUtilisations","name":"View Forex contracts which are utilised","summary":"Retrieves the forex contracts for the provided reference","tags":["TREASURY"],"parameters":[{"name":"utilisationId","in":"path","type":"string","required":true,"description":"Identifies the unique identifier of the transaction or contract which will be utilised."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"The identifier of the underlying Entity/Company/Branch."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"UtilisationsResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/holdings/treasury/forex/utilisationsInitiations/{utilisationId}","fullPath":"/api/v1.0.0/holdings/treasury/forex/utilisationsInitiations/{utilisationId}","operationId":"addUtilisations","name":"Amend the Forex to add utilisations","summary":"Initiation of the Forex contract which will be utilised for external settlement","tags":["TREASURY"],"parameters":[{"name":"utilisationId","in":"path","type":"string","required":true,"description":"Identifies the unique identifier of the transaction or contract which will be utilised."},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"The identifier of the underlying Entity/Company/Branch."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"utilisations":[{}],"customerName":"string","valueDateBuy":"string","valueDateSell":"string","optionDate":"string","projectedOutstandingAmount":"string","buyCurrency":"string","sellCurrency":"string","baseCurrency":"string","optionCurrency":"string","buyAmount":"string","sellAmount":"string","spotRate":"string","forwardRate":"string","treasuryRate":"string"}},"responses":{"200":"UtilisationsResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/holdings/treasury/forex/utilisationsApprovals/{utilisationId}","fullPath":"/api/v1.0.0/holdings/treasury/forex/utilisationsApprovals/{utilisationId}","operationId":"approveUtilisations","name":"Authorises the utilisation added on Forex contracts","summary":"Authorization of the Forex contract which has been utilised for external settlement","tags":["TREASURY"],"parameters":[{"name":"utilisationId","in":"path","type":"string","required":true,"description":"Identifies the unique identifier of the transaction or contract which will be utilised."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"The identifier of the underlying Entity/Company/Branch."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"UtilisationsResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}}]},{"key":"holdings-forexUtilisations-service-v1.1.0","title":"Management of Forex Utilisations","version":"v1.1.0","description":"Allows management of Forex utilisations for external settlement contracts ","endpointCount":4,"endpoints":[{"method":"GET","path":"/holdings/treasury/forex/utilisations/{utilisationId}","fullPath":"/api/v1.1.0/holdings/treasury/forex/utilisations/{utilisationId}","operationId":"getUtilisations","name":"View Forex contracts which are utilised","summary":"Retrieves the forex contracts for the provided reference","tags":["TREASURY"],"parameters":[{"name":"utilisationId","in":"path","type":"string","required":true,"description":"Identifies the unique identifier of the transaction or contract which will be utilised."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"UtilisationsResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/holdings/treasury/forex/utilisationsInitiations/{utilisationId}","fullPath":"/api/v1.1.0/holdings/treasury/forex/utilisationsInitiations/{utilisationId}","operationId":"addUtilisations","name":"Amend the Forex to add utilisations","summary":"Initiation of the Forex contract which will be utilised for external settlement","tags":["TREASURY"],"parameters":[{"name":"utilisationId","in":"path","type":"string","required":true,"description":"Identifies the unique identifier of the transaction or contract which will be utilised."},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"utilisations":[{}],"customerName":"string","valueDateBuy":"string","valueDateSell":"string","optionDate":"string","projectedOutstandingAmount":"string","buyCurrency":"string","sellCurrency":"string","baseCurrency":"string","optionCurrency":"string","buyAmount":"string","sellAmount":"string","spotRate":"string","forwardRate":"string","treasuryRate":"string"}},"responses":{"200":"UtilisationsResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/holdings/treasury/forex/utilisationsApprovals/{utilisationId}","fullPath":"/api/v1.1.0/holdings/treasury/forex/utilisationsApprovals/{utilisationId}","operationId":"approveUtilisations","name":"Authorises the utilisation added on Forex contracts","summary":"Authorization of the Forex contract which has been utilised for external settlement","tags":["TREASURY"],"parameters":[{"name":"utilisationId","in":"path","type":"string","required":true,"description":"Identifies the unique identifier of the transaction or contract which will be utilised."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"UtilisationsResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/holdings/treasury/forex/utilisations/rates","fullPath":"/api/v1.1.0/holdings/treasury/forex/utilisations/rates","operationId":"getFxUtilisationRates","name":"Retrieves the exchange rate to be applied for foreign currency settlement from the Transaction Processing applications like Payments, Loans, Trade finance etc. ","summary":"Retrieves the currency exchange rates from the given forex contract that will be used by the transaction processing application for the conversion.","tags":["TREASURY"],"parameters":[{"name":"utilisationId","in":"query","type":"string","required":false,"description":"Identifies the unique identifier of the transaction or contract which will be utilised."},{"name":"counterparty","in":"query","type":"string","required":false,"description":"The counterparty ID  for the  deal."},{"name":"utilisationCurrency","in":"query","type":"string","required":false,"description":"Identifies the currency in which the amount is being utilised."},{"name":"utilisationAmount","in":"query","type":"string","required":false,"description":"Identifies the utilized amount of the Forex contract."},{"name":"executionDate","in":"query","type":"string","required":false,"description":"Date on which the transaction or payment gets processed, i.e. the processing date of the transaction."},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"FxUtilisationRatesResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}}]},{"key":"holdings-fundsauthorisationstatus-v1.0.0","title":"Holdings Funds Authorisation Status","version":"v1.0.0","description":"Funds Authorisation Status","endpointCount":1,"endpoints":[{"method":"PUT","path":"/holdings/famsParameter/{famsParameterId}/fundsAuthorisationStatus","fullPath":"/api/v1.0.0/holdings/famsParameter/{famsParameterId}/fundsAuthorisationStatus","operationId":"updateFundAuthorisationStatus","name":"Updates Funds Authorisation Status in ACFAMS.PARAMETER.","summary":"Funds Authorisation Status Update","tags":[],"parameters":[{"name":"famsParameterId","in":"path","type":"string","required":true,"description":""},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"faStatus":"string"}},"responses":{"200":"FundAuthorisationStatusResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}}]},{"key":"holdings-guarantees-service-v1.0.0","title":"Management of Guarantees","version":"v1.0.0","description":"API to create, update and manage various types of bank issued guarantees and their associated status and details. Some of the types of guarantees that can be created are bid bonds, performance bonds and Trade Finance shipping guarantees.","endpointCount":37,"endpoints":[{"method":"GET","path":"/holdings/guarantees/clauses/{clauseId}","fullPath":"/api/v1.0.0/holdings/guarantees/clauses/{clauseId}","operationId":"getClause","name":"Retrieves the guarantee clause details of specific id","summary":"Details of guarantee clause","tags":[],"parameters":[{"name":"clauseId","in":"path","type":"string","required":true,"description":"Represents id of MD.CLAUSES. Id can be used in MD application and description is automatically populated in the deal.Records created for customer specific clauses, to have ID beginning with the custom"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"ClauseResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"POST","path":"/holdings/guarantees/clauses/{clauseId}","fullPath":"/api/v1.0.0/holdings/guarantees/clauses/{clauseId}","operationId":"createClause","name":"Creates the guarantee clause record for a specific customer","summary":"Create guarantee clause","tags":[],"parameters":[{"name":"clauseId","in":"path","type":"string","required":true,"description":"Represents id of MD.CLAUSES. Id can be used in MD application and description is automatically populated in the deal.Records created for customer specific clauses, to have ID beginning with the custom"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"mdClausesDescriptions":[{}],"mdClausesDisplayName":"string"}},"responses":{"200":"ClauseResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/holdings/guarantees/clauses/{clauseId}","fullPath":"/api/v1.0.0/holdings/guarantees/clauses/{clauseId}","operationId":"updateClause","name":"Updates the guarantee clause for the specific id","summary":"Update guarantee clause","tags":[],"parameters":[{"name":"clauseId","in":"path","type":"string","required":true,"description":"Represents id of MD.CLAUSES. Id can be used in MD application and description is automatically populated in the deal.Records created for customer specific clauses, to have ID beginning with the custom"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"mdClausesDescriptions":[{}],"mdClausesDisplayName":"string"}},"responses":{"200":"ClauseResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"DELETE","path":"/holdings/guarantees/clauses/{clauseId}","fullPath":"/api/v1.0.0/holdings/guarantees/clauses/{clauseId}","operationId":"deleteClause","name":"Removes the guarantee clause record","summary":"Remove guarantee clause","tags":[],"parameters":[{"name":"clauseId","in":"path","type":"string","required":true,"description":"Represents id of MD.CLAUSES. Id can be used in MD application and description is automatically populated in the deal.Records created for customer specific clauses, to have ID beginning with the custom"},{"name":"payload","in":"body","type":"object","required":false,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}}},"responses":{"200":"ClauseResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/holdings/guarantees/requests","fullPath":"/api/v1.0.0/holdings/guarantees/requests","operationId":"getGuaranteeIssuanceRequests","name":"Retrieves the list of guarantee initiation request details","summary":"Retrieves the guarantee initiation requests","tags":[],"parameters":[{"name":"mdIbRequestId","in":"query","type":"string","required":false,"description":"The guarantees issuance id initiated by internet banking"},{"name":"customerId","in":"query","type":"string","required":false,"description":"Identifier of the customer"},{"name":"ibEventStatus","in":"query","type":"string","required":false,"description":"Specifies the status of the guarantee issuance request."},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"GuaranteeIssuanceRequestsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"POST","path":"/holdings/guarantees/requests","fullPath":"/api/v1.0.0/holdings/guarantees/requests","operationId":"createIbRequest","name":"Creates the guarantee initiation request from internet banking","summary":"Create guarantee initiation request","tags":[],"parameters":[{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"beneficiaryIds":[{}],"guarantees":[{}],"documentDetails":[{}],"limits":[{}],"messageFromBanks":[{}],"messageFromCustomers":[{}],"information":[{}],"amendmentDetails":[{}],"overrides":[{}],"customerId":"string","currencyId":"string","principalAmount":0.0,"startDate":"2024-01-01","maturityDate":"2024-01-01","categoryName":"string"}},"responses":{"200":"IbRequestResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/holdings/guarantees/requests/{requestId}","fullPath":"/api/v1.0.0/holdings/guarantees/requests/{requestId}","operationId":"getIbRequest","name":"Retrieves the guarantee initiation request details for specific id","summary":"Details of guarantee initiation request","tags":[],"parameters":[{"name":"requestId","in":"path","type":"string","required":true,"description":"The guarantees issuance id initiated by internet banking"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"IbRequestResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/holdings/guarantees/requests/{requestId}","fullPath":"/api/v1.0.0/holdings/guarantees/requests/{requestId}","operationId":"updateIbRequest","name":"Updates the existing guarantee initiation record for a customer","summary":"Update guarantee initiation record","tags":[],"parameters":[{"name":"requestId","in":"path","type":"string","required":true,"description":"The guarantees issuance id initiated by internet banking"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"beneficiaryIds":[{}],"guarantees":[{}],"documentDetails":[{}],"limits":[{}],"messageFromBanks":[{}],"messageFromCustomers":[{}],"information":[{}],"amendmentDetails":[{}],"overrides":[{}],"customerId":"string","currencyId":"string","principalAmount":0.0,"startDate":"2024-01-01","maturityDate":"2024-01-01","categoryName":"string"}},"responses":{"200":"IbRequestResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"DELETE","path":"/holdings/guarantees/requests/{requestId}","fullPath":"/api/v1.0.0/holdings/guarantees/requests/{requestId}","operationId":"deleteIbRequest","name":"Removes the existing guarantee initiation record","summary":"Remove guarantee initiation record","tags":[],"parameters":[{"name":"requestId","in":"path","type":"string","required":true,"description":"The guarantees issuance id initiated by internet banking"},{"name":"payload","in":"body","type":"object","required":false,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}}},"responses":{"200":"IbRequestResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/holdings/guarantees/guaranteesApprovals/{requestId}","fullPath":"/api/v1.0.0/holdings/guarantees/guaranteesApprovals/{requestId}","operationId":"approveGuarantee","name":"Approves the guarantee initiation request","summary":"Approve guarantee initiation request","tags":[],"parameters":[{"name":"requestId","in":"path","type":"string","required":true,"description":"The guarantees issuance id initiated by internet banking"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"GuaranteeResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"DELETE","path":"/holdings/guarantees/cancellations/{requestId}","fullPath":"/api/v1.0.0/holdings/guarantees/cancellations/{requestId}","operationId":"rejectGuarantee","name":"Reject the guarantee initiation request","summary":"Reject guarantee initiation request","tags":[],"parameters":[{"name":"requestId","in":"path","type":"string","required":true,"description":"The guarantees issuance id initiated by internet banking"},{"name":"payload","in":"body","type":"object","required":false,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}}},"responses":{"200":"GuaranteeResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/holdings/guarantees/{guaranteeId}/receivedGuarantees","fullPath":"/api/v1.0.0/holdings/guarantees/{guaranteeId}/receivedGuarantees","operationId":"getReceivedGuaranteeHistory","name":"Retrieves the received guarantee records for the customer ","summary":"Retrieves received guarantee records","tags":[],"parameters":[{"name":"guaranteeId","in":"path","type":"string","required":true,"description":"Identifier of the guarantee"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"ReceivedGuaranteeHistoryResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/guarantees/clauses","fullPath":"/api/v1.0.0/holdings/guarantees/clauses","operationId":"getGuaranteeClauses","name":"Retrieves the list of guarantee clause records for specific customer","summary":"Retrieves the guarantee clause records","tags":[],"parameters":[{"name":"clauseId","in":"query","type":"string","required":false,"description":"Represents id of MD.CLAUSES. Id can be used in MD application and description is automatically populated in the deal.Records created for customer specific clauses, to have ID beginning with the custom"},{"name":"customerId","in":"query","type":"string","required":false,"description":"Identifier of the customer"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"GuaranteeClausesResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/guarantees/receivedGuarantees/amendments","fullPath":"/api/v1.0.0/holdings/guarantees/receivedGuarantees/amendments","operationId":"getReceivedGuaranteesAmendments","name":"Retrieves the list of amended guarantee records","summary":"Retrieves the amended guarantee records","tags":[],"parameters":[{"name":"alternateId","in":"query","type":"string","required":false,"description":"An Alternate Identification for the Deal. This can be used to retrieve the Deal for amendment."},{"name":"contractType","in":"query","type":"string","required":false,"description":"Indicates if the position is related to Loan, Deposit ,FX-Forward/FX-Swap"},{"name":"customerId","in":"query","type":"string","required":false,"description":"Identifier of the customer"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"ReceivedGuaranteesAmendmentsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/guarantees/{guaranteeId}/invocations","fullPath":"/api/v1.0.0/holdings/guarantees/{guaranteeId}/invocations","operationId":"getClaimInvocationHistory","name":"Retrieves the list of guarantee claim invocation details","summary":"Retrieves the guarantee claim invocation details","tags":[],"parameters":[{"name":"guaranteeId","in":"path","type":"string","required":true,"description":"Identifier of the guarantee"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"ClaimInvocationHistoryResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/guarantees/receivedClaims","fullPath":"/api/v1.0.0/holdings/guarantees/receivedClaims","operationId":"getReceivedGuaranteeClaims","name":"Retrieves the list of received guarantee claim records for a customer","summary":"Retrieves the received guarantee claims","tags":[],"parameters":[{"name":"customerId","in":"query","type":"string","required":false,"description":"Identifier of the customer"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"ReceivedGuaranteeClaimsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/guarantees/amendments","fullPath":"/api/v1.0.0/holdings/guarantees/amendments","operationId":"getGuaranteeAmendments","name":"Retrieves the list of amended guarantee records for specific customer","summary":"Retrieves guarantee amendment records","tags":[],"parameters":[{"name":"customerId","in":"query","type":"string","required":false,"description":"Identifier of the customer"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"GuaranteeAmendmentsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/guarantees/issuedGuarantees","fullPath":"/api/v1.0.0/holdings/guarantees/issuedGuarantees","operationId":"getIssuedGuarantees","name":"Retrieves the list of issued guarantee request details for specific customer","summary":"Retrieves the issued guarantee details","tags":[],"parameters":[{"name":"customerId","in":"query","type":"string","required":false,"description":"Identifier of the customer"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"IssuedGuaranteesResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/guarantees/limits","fullPath":"/api/v1.0.0/holdings/guarantees/limits","operationId":"getGuaranteeLimits","name":"Retrieves the list of guarantees limit details","summary":"Retrieves the guarantee limits","tags":[],"parameters":[{"name":"customerId","in":"query","type":"string","required":false,"description":"Identifier of the customer"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"GuaranteeLimitsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/guarantees/issuedClaims","fullPath":"/api/v1.0.0/holdings/guarantees/issuedClaims","operationId":"getIssuedGuaranteeClaims","name":"Retrieves the list of received guarantee claim details","summary":"Retrieves the received guarantee claims","tags":[],"parameters":[{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"IssuedGuaranteeClaimsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/guarantees","fullPath":"/api/v1.0.0/holdings/guarantees","operationId":"getGuarantees","name":"Retrieves the list of guarantee details","summary":"Retrieves the guarantee details","tags":[],"parameters":[{"name":"guaranteeId","in":"query","type":"string","required":false,"description":"Identifier of the guarantee"},{"name":"beneficiaryCustomerId","in":"query","type":"string","required":false,"description":"Identifies the Customer who is to be the ultimate receiver of the funds transferred by the sending bank when this Beneficiary is not a bank."},{"name":"contractType","in":"query","type":"string","required":false,"description":"Indicates if the position is related to Loan, Deposit ,FX-Forward/FX-Swap"},{"name":"ibRequestId","in":"query","type":"string","required":false,"description":"The guarantees issuance id initiated by internet banking"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"GuaranteesResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"POST","path":"/holdings/guarantees","fullPath":"/api/v1.0.0/holdings/guarantees","operationId":"createGuaranteeGeneric","name":"Creates a generic guarantee for the requested customer reference number","summary":"Creates a generic Guarantee","tags":[],"parameters":[{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"beneficiaryIds":[{}],"beneficiaryAddresses":[{}],"charges":[{}],"bankAddresses":[{}],"detailsOfGuarantee":[{}],"guaranteeReference":"string","customerId":"string","currency":"string","amount":0.0,"dealDate":"2024-01-01","startDate":"2024-01-01","expiryDate":"2024-01-01","maturityDate":"2024-01-01","limitReference":"string","termsAndConditions":"string"}},"responses":{"200":"GuaranteeGenericResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/holdings/customers/{customerId}/guarantees/outstandings","fullPath":"/api/v1.0.0/holdings/customers/{customerId}/guarantees/outstandings","operationId":"getGuaranteesOutstandings","name":"Retrieves the detailed information on issued guarantees for the specified customer/guarantee reference","summary":"Retrieves outstanding guarantees","tags":[],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"Identifier of the customer"},{"name":"transactionReference","in":"query","type":"string","required":false,"description":"Contains the identifier for the transaction in the core system"},{"name":"guaranteeType","in":"query","type":"string","required":false,"description":"Refers to the type of the contract that is being issued."},{"name":"currency","in":"query","type":"string","required":false,"description":"Identifies the currency. E.g. USD, GBP etc"},{"name":"amount","in":"query","type":"string","required":false,"description":"This is the payment amount"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"GuaranteesOutstandingsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/customers/{customerId}/guarantees/expiries","fullPath":"/api/v1.0.0/holdings/customers/{customerId}/guarantees/expiries","operationId":"getGuaranteeExpiringWithDate","name":"Retrieves the expiring guarantees details for the specified customer/guarantee reference ","summary":"Retrieves expiring guarantees","tags":[],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"Identifier of the customer"},{"name":"transactionReference","in":"query","type":"string","required":false,"description":"Contains the identifier for the transaction in the core system"},{"name":"currency","in":"query","type":"string","required":false,"description":"Identifies the currency. E.g. USD, GBP etc"},{"name":"amount","in":"query","type":"string","required":false,"description":"This is the payment amount"},{"name":"maturityDate","in":"query","type":"string","required":false,"description":"Indicates maturity date of the contract"},{"name":"gteeReturnDate","in":"query","type":"string","required":false,"description":"Date on which the original Guarantee will be returned by the customer to the Bank that issued it"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"GuaranteeExpiringWithDateResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/customer/{customerId}/guarantees/outstandingClaims","fullPath":"/api/v1.0.0/holdings/customer/{customerId}/guarantees/outstandingClaims","operationId":"getClaimOutstandingUnderGuarantees","name":"Retrieves the list of corporate miscellaneous deals for the customer.","summary":"Retrieves outstanding guarantee claims","tags":[],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"Identifier of the customer"},{"name":"transactionReference","in":"query","type":"string","required":false,"description":"Contains the identifier for the transaction in the core system"},{"name":"currency","in":"query","type":"string","required":false,"description":"Identifies the currency. E.g. USD, GBP etc"},{"name":"amount","in":"query","type":"string","required":false,"description":"This is the payment amount"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"ClaimOutstandingUnderGuaranteesResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/customers/{customerId}/guarantees/cancellations","fullPath":"/api/v1.0.0/holdings/customers/{customerId}/guarantees/cancellations","operationId":"getGuaranteesReversed","name":"Retrieves the list of cancelled guarantees for the specified customer/guarantee reference","summary":"Retrieves list of cancelled guarantees","tags":[],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"Identifier of the customer"},{"name":"transactionReference","in":"query","type":"string","required":false,"description":"Contains the identifier for the transaction in the core system"},{"name":"guaranteeType","in":"query","type":"string","required":false,"description":"Refers to the type of the contract that is being issued."},{"name":"currency","in":"query","type":"string","required":false,"description":"Identifies the currency. E.g. USD, GBP etc"},{"name":"amount","in":"query","type":"string","required":false,"description":"This is the payment amount"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"GuaranteesReversedResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/guarantees/{guaranteeId}/issuedClaims","fullPath":"/api/v1.0.0/holdings/guarantees/{guaranteeId}/issuedClaims","operationId":"getClaimsPaidUnderGuarantee","name":"Retrieves the list of issued guarantees paid/cancelled for the specified customer/guarantee reference.","summary":"Retrieves paid/cancelled details of issued guarantees","tags":[],"parameters":[{"name":"guaranteeId","in":"path","type":"string","required":true,"description":""},{"name":"transactionReference","in":"query","type":"string","required":false,"description":"Contains the identifier for the transaction in the core system"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"ClaimsPaidUnderGuaranteeResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/guarantees/{guaranteeId}/shippings/outstandings","fullPath":"/api/v1.0.0/holdings/guarantees/{guaranteeId}/shippings/outstandings","operationId":"getOutstandingShippingGuarantees","name":"Retrieves the details of outstanding shipping guarantees for the specified customer/guarantee reference.","summary":"Retrieves list of outstanding shipping guarantees","tags":[],"parameters":[{"name":"guaranteeId","in":"path","type":"string","required":true,"description":""},{"name":"transactionReference","in":"query","type":"string","required":false,"description":"Contains the identifier for the transaction in the core system"},{"name":"lCReference","in":"query","type":"string","required":false,"description":"Indicates the LC reference under which the guarantee is to be opened"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"OutstandingShippingGuaranteesResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/customers/{customerId}/guarantees/receivedOutstandings","fullPath":"/api/v1.0.0/holdings/customers/{customerId}/guarantees/receivedOutstandings","operationId":"getOutstandingReceivedGuarantees","name":"Retrieves the details of outstanding received guarantees for the specified customer/guarantee reference.","summary":"Retrieves outstanding received guarantees details","tags":[],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":""},{"name":"transactionReference","in":"query","type":"string","required":false,"description":"Contains the identifier for the transaction in the core system"},{"name":"customer","in":"query","type":"string","required":false,"description":"Contains the customer identifier to fetch list of consent arrangements for the customer or customer identifier of the debtor account. This will be populated once the SCA(Strong Customer Authentication"},{"name":"guaranteeType","in":"query","type":"string","required":false,"description":"Refers to the type of the contract that is being issued."},{"name":"currency","in":"query","type":"string","required":false,"description":"Identifies the currency. E.g. USD, GBP etc"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"OutstandingReceivedGuaranteesResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"POST","path":"/holdings/guarantee/performanceBonds","fullPath":"/api/v1.0.0/holdings/guarantee/performanceBonds","operationId":"createGuaranteesPerformanceBond","name":"Creates Performance bond Guarantee for the requested customer reference number","summary":"Creates Performance Bond Guarantee","tags":[],"parameters":[{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"beneficiaryIds":[{}],"beneficiaryaddresses":[{}],"charges":[{}],"bankAddresses":[{}],"detailsOfGuarantee":[{}],"performanceBondReference":"string","customerId":"string","currency":"string","amount":0.0,"dealDate":"2024-01-01","valueDate":"2024-01-01","expiryDate":"2024-01-01","maturityDate":"2024-01-01","termsAndConditions":"string","eventsProcessing":"string"}},"responses":{"200":"GuaranteesPerformanceBondResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"POST","path":"/holdings/guarantees/letterOfCredits/standBys","fullPath":"/api/v1.0.0/holdings/guarantees/letterOfCredits/standBys","operationId":"createGuaranteesStandbyLC","name":"Creates Standby Letter of Credit Guarantee for the requested customer reference number","summary":"Creates Standby Letter of Credit Guarantee","tags":[],"parameters":[{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"beneficiaryIds":[{}],"beneficiaryAddresses":[{}],"charges":[{}],"bankAddresses":[{}],"detailsOfGuarantee":[{}],"standByImportLC":"string","customerId":"string","currency":"string","amount":0.0,"dealDate":"2024-01-01","valueDate":"2024-01-01","expiryDate":"2024-01-01","maturityDate":"2024-01-01","termsAndConditions":"string","eventsProcessing":"string"}},"responses":{"200":"GuaranteesStandbyLCResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"POST","path":"/holdings/guarantees/letterOfCredits/shippings","fullPath":"/api/v1.0.0/holdings/guarantees/letterOfCredits/shippings","operationId":"createShippingGuaranteeUnderLC","name":"Creates Shipping Guarantee under Letter of Credit for the requested customer reference number","summary":"Creates  Shipping Guarantes under Letter of Credit","tags":[],"parameters":[{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"beneficiaryIds":[{}],"beneficiaryAddresses":[{}],"charges":[{}],"bankAddresses":[{}],"detailsOfGuarantee":[{}],"internalReference":"string","customerId":"string","currency":"string","amount":0.0,"dealDate":"2024-01-01","valueDate":"2024-01-01","maturityDate":"2024-01-01","termsAndConditions":"string","eventsProcessing":"string","autoExpiry":"string"}},"responses":{"200":"ShippingGuaranteeUnderLCResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"POST","path":"/holdings/guarantees/letterOfCredits/shippings/collections","fullPath":"/api/v1.0.0/holdings/guarantees/letterOfCredits/shippings/collections","operationId":"createShippingGuaranteeUnderCollection","name":"Creates Shipping guarantee under collection Letter of Credit for the requested customer reference number","summary":"Creates Shipping Guarantee under Collection Letter of Credit","tags":[],"parameters":[{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"beneficiaryId":[{}],"beneficiaryAddresses":[{}],"charges":[{}],"bankAddresses":[{}],"detailsOfGuarantee":[{}],"shippingGuaranteeReference":"string","customerId":"string","currency":"string","amount":0.0,"dealDate":"2024-01-01","valueDate":"2024-01-01","maturityDate":"2024-01-01","termsAndConditions":"string","eventsProcessing":"string","autoExpiry":"string"}},"responses":{"200":"ShippingGuaranteeUnderCollectionResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"POST","path":"/holdings/guarantees/{guaranteeId}","fullPath":"/api/v1.0.0/holdings/guarantees/{guaranteeId}","operationId":"updateGuaranteesAmendment","name":"Updates additional guarantee information for the specified  customer/guarantee reference number","summary":"Updates guarantee details","tags":[],"parameters":[{"name":"guaranteeId","in":"path","type":"string","required":true,"description":""},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"BeneficiaryIds":[{}],"BeneficiaryAddresses":[{}],"pincipalMovements":[{}],"texts":[{}],"guarantees":[{}],"ibClaimNarratives":[{}],"charges":[{}],"bankAddresses":[{}],"detailsOfGuarantee":[{}],"guaranteeReference":"string","customerReference":"string","customerId":"string","guaranteeType":"string","productCategoryId":"string","currency":"string"}},"responses":{"200":"GuaranteesAmendmentResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"POST","path":"/holdings/guarantees/{guaranteeId}/rejectedClaims","fullPath":"/api/v1.0.0/holdings/guarantees/{guaranteeId}/rejectedClaims","operationId":"updateGuaranteesRejection","name":"Updates the rejection of claim for the specified guarantee/customer reference number","summary":"Updates the rejection of claim for a guarantee","tags":[],"parameters":[{"name":"guaranteeId","in":"path","type":"string","required":true,"description":""},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"beneficiaryIds":[{}],"beneficairyAddresses":[{}],"guaranteeReference":"string","guaranteeType":"string","customerId":"string","limitReference":"string","currency":"string","amount":"string","startDate":"string","maturityDate":"string","autoExpiry":"string","onlineMaturity":"string","eventsProcessing":"string","liquidationMode":"string","claimRegisterDate":"string"}},"responses":{"200":"GuaranteesRejectionResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/holdings/guarantees/{guaranteeId}/receivedClaims","fullPath":"/api/v1.0.0/holdings/guarantees/{guaranteeId}/receivedClaims","operationId":"getInvocationPaidOrCancelled","name":"Retrieves the list of received guarantees paid/cancelled for the specified customer/guarantee reference","summary":"Retrieves paid/cancelled details of received guarantees","tags":[],"parameters":[{"name":"guaranteeId","in":"path","type":"string","required":true,"description":""},{"name":"transactionReference","in":"query","type":"string","required":false,"description":"Contains the identifier for the transaction in the core system"},{"name":"beneficiary","in":"query","type":"string","required":false,"description":"Identifies the Beneficiary name and address of the Standing Order"},{"name":"debitAccountId","in":"query","type":"string","required":false,"description":"Indicates the debit account number of the payment or transaction."},{"name":"creditAccountId","in":"query","type":"string","required":false,"description":"Credit account identifier of the payment or transaction"},{"name":"amount","in":"query","type":"string","required":false,"description":"This is the payment amount"},{"name":"debitValueDate","in":"query","type":"string","required":false,"description":"Date on which the amount will be debited for settlement"},{"name":"creditValueDate","in":"query","type":"string","required":false,"description":"Reference quoted by the credit account for a payment"},{"name":"correspondentBank","in":"query","type":"string","required":false,"description":"Correspondent bank, where our nostro account is held."},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"InvocationPaidOrCancelledResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"POST","path":"/holdings/guarantees/bidBonds","fullPath":"/api/v1.0.0/holdings/guarantees/bidBonds","operationId":"createGuarnteeBidBond","name":"Creates Bid bond Guarantee for the requested customer reference number","summary":"Creates Bid Bond Guarantee","tags":[],"parameters":[{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"beneficiaryIds":[{}],"beneficiaryAddresses":[{}],"charges":[{}],"bankAddresses":[{}],"detailsOfGuarantee":[{}],"bidBondReference":"string","customerId":"string","currency":"string","amount":0.0,"dealDate":"2024-01-01","valueDate":"2024-01-01","expiryDate":"2024-01-01","maturityDate":"string","termsAndConditions":"string","eventsProcessing":"string"}},"responses":{"200":"GuarnteeBidBondResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}}]},{"key":"holdings-guarantees-service-v2.0.0","title":"Management of Guarantees","version":"v2.0.0","description":"API to create, update and manage various types of bank issued guarantees and their associated status and details. Some of the types of guarantees that can be created are bid bonds, performance bonds and trade finance shipping guarantees.","endpointCount":51,"endpoints":[{"method":"GET","path":"/holdings/guarantees/clauses/{clauseId}","fullPath":"/api/v2.0.0/holdings/guarantees/clauses/{clauseId}","operationId":"getClause","name":"Retrieves the guarantee clause details of specific id","summary":"Details of guarantee clause","tags":["CORPORATE"],"parameters":[{"name":"clauseId","in":"path","type":"string","required":true,"description":"Represents id of MD.CLAUSES. Id can be used in MD application and description is automatically populated in the deal.Records created for customer specific clauses, to have ID beginning with the custom"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"ClauseResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"POST","path":"/holdings/guarantees/clauses/{clauseId}","fullPath":"/api/v2.0.0/holdings/guarantees/clauses/{clauseId}","operationId":"createClause","name":"Creates the guarantee clause for a specific customer","summary":"Create guarantee clause","tags":["CORPORATE"],"parameters":[{"name":"clauseId","in":"path","type":"string","required":true,"description":"Represents id of MD.CLAUSES. Id can be used in MD application and description is automatically populated in the deal.Records created for customer specific clauses, to have ID beginning with the custom"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"mdClausesDescriptions":[{}],"mdClausesDisplayName":"string","extensions":{}}},"responses":{"200":"ClauseResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/holdings/guarantees/clauses/{clauseId}","fullPath":"/api/v2.0.0/holdings/guarantees/clauses/{clauseId}","operationId":"updateClause","name":"Updates the guarantee clause for the specific id","summary":"Update guarantee clause","tags":["CORPORATE"],"parameters":[{"name":"clauseId","in":"path","type":"string","required":true,"description":"Represents id of MD.CLAUSES. Id can be used in MD application and description is automatically populated in the deal.Records created for customer specific clauses, to have ID beginning with the custom"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"mdClausesDescriptions":[{}],"mdClausesDisplayName":"string","extensions":{}}},"responses":{"200":"ClauseResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"DELETE","path":"/holdings/guarantees/clauses/{clauseId}","fullPath":"/api/v2.0.0/holdings/guarantees/clauses/{clauseId}","operationId":"deleteClause","name":"Removes the guarantee clause","summary":"Remove guarantee clause","tags":["CORPORATE"],"parameters":[{"name":"clauseId","in":"path","type":"string","required":true,"description":"Represents id of MD.CLAUSES. Id can be used in MD application and description is automatically populated in the deal.Records created for customer specific clauses, to have ID beginning with the custom"},{"name":"payload","in":"body","type":"object","required":false,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}}},"responses":{"200":"ClauseResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/holdings/guarantees/requests","fullPath":"/api/v2.0.0/holdings/guarantees/requests","operationId":"getGuaranteeIssuanceRequests","name":"Retrieves the list of guarantee initiation request details","summary":"Retrieves the guarantee initiation requests","tags":["CORPORATE"],"parameters":[{"name":"mdIbRequestId","in":"query","type":"string","required":false,"description":"The guarantees issuance id initiated by internet banking"},{"name":"customerId","in":"query","type":"string","required":false,"description":"Identifier of the customer"},{"name":"ibEventStatus","in":"query","type":"string","required":false,"description":"Specifies the status of the guarantee issuance request."},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"GuaranteeIssuanceRequestsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"POST","path":"/holdings/guarantees/requests","fullPath":"/api/v2.0.0/holdings/guarantees/requests","operationId":"createIbRequest","name":"Creates the guarantee initiation request from internet banking","summary":"Create guarantee initiation request","tags":["CORPORATE"],"parameters":[{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"beneficiaryIds":[{}],"guarantees":[{}],"documentDetails":[{}],"limits":[{}],"messageFromBanks":[{}],"messageFromCustomers":[{}],"information":[{}],"amendmentDetails":[{}],"overrides":[{}],"customerId":"string","currencyId":"string","principalAmount":0.0,"startDate":"2024-01-01","maturityDate":"2024-01-01","categoryName":"string"}},"responses":{"200":"IbRequestResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/holdings/guarantees/requests/{requestId}","fullPath":"/api/v2.0.0/holdings/guarantees/requests/{requestId}","operationId":"getIbRequest","name":"Retrieves the guarantee initiation request details for specific id","summary":"Details of guarantee initiation request","tags":["CORPORATE"],"parameters":[{"name":"requestId","in":"path","type":"string","required":true,"description":"The guarantees issuance id initiated by internet banking"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"IbRequestResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/holdings/guarantees/requests/{requestId}","fullPath":"/api/v2.0.0/holdings/guarantees/requests/{requestId}","operationId":"updateIbRequest","name":"Updates the existing guarantee initiation request for a customer","summary":"Update guarantee initiation request","tags":["CORPORATE"],"parameters":[{"name":"requestId","in":"path","type":"string","required":true,"description":"The guarantees issuance id initiated by internet banking"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"beneficiaryIds":[{}],"guarantees":[{}],"documentDetails":[{}],"limits":[{}],"messageFromBanks":[{}],"messageFromCustomers":[{}],"information":[{}],"amendmentDetails":[{}],"overrides":[{}],"customerId":"string","currencyId":"string","principalAmount":0.0,"startDate":"2024-01-01","maturityDate":"2024-01-01","categoryName":"string"}},"responses":{"200":"IbRequestResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"DELETE","path":"/holdings/guarantees/requests/{requestId}","fullPath":"/api/v2.0.0/holdings/guarantees/requests/{requestId}","operationId":"deleteIbRequest","name":"Removes the existing guarantee initiation request","summary":"Remove guarantee initiation request","tags":["CORPORATE"],"parameters":[{"name":"requestId","in":"path","type":"string","required":true,"description":"The guarantees issuance id initiated by internet banking"},{"name":"payload","in":"body","type":"object","required":false,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}}},"responses":{"200":"IbRequestResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/holdings/guarantees/guaranteesApprovals/{requestId}","fullPath":"/api/v2.0.0/holdings/guarantees/guaranteesApprovals/{requestId}","operationId":"approveGuarantee","name":"Approves the guarantee initiation request","summary":"Approve guarantee initiation request","tags":["CORPORATE"],"parameters":[{"name":"requestId","in":"path","type":"string","required":true,"description":"The guarantees issuance id initiated by internet banking"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"GuaranteeResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"DELETE","path":"/holdings/guarantees/cancellations/{requestId}","fullPath":"/api/v2.0.0/holdings/guarantees/cancellations/{requestId}","operationId":"rejectGuarantee","name":"Reject the guarantee initiation request","summary":"Reject guarantee initiation request","tags":["CORPORATE"],"parameters":[{"name":"requestId","in":"path","type":"string","required":true,"description":"The guarantees issuance id initiated by internet banking"},{"name":"payload","in":"body","type":"object","required":false,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}}},"responses":{"200":"GuaranteeResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/holdings/guarantees/{guaranteeId}/receivedGuarantees","fullPath":"/api/v2.0.0/holdings/guarantees/{guaranteeId}/receivedGuarantees","operationId":"getReceivedGuaranteeHistory","name":"Retrieves the received guarantees for the customer ","summary":"Retrieves received guarantees","tags":["CORPORATE"],"parameters":[{"name":"guaranteeId","in":"path","type":"string","required":true,"description":"Identifier of the guarantee"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"ReceivedGuaranteeHistoryResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/guarantees/clauses","fullPath":"/api/v2.0.0/holdings/guarantees/clauses","operationId":"getGuaranteeClauses","name":"Retrieves the list of guarantee clauses for specific customer","summary":"Retrieves the guarantee clauses","tags":["CORPORATE"],"parameters":[{"name":"clauseId","in":"query","type":"string","required":false,"description":"Represents id of MD.CLAUSES. Id can be used in MD application and description is automatically populated in the deal.Records created for customer specific clauses, to have ID beginning with the custom"},{"name":"customerId","in":"query","type":"string","required":false,"description":"Identifier of the customer"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"GuaranteeClausesResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/guarantees/receivedGuarantees/amendments","fullPath":"/api/v2.0.0/holdings/guarantees/receivedGuarantees/amendments","operationId":"getReceivedGuaranteesAmendments","name":"Retrieves the list of amended guarantees","summary":"Retrieves the amended guarantees","tags":["CORPORATE"],"parameters":[{"name":"alternateId","in":"query","type":"string","required":false,"description":"An Alternate Identification for the Deal. This can be used to retrieve the Deal for amendment."},{"name":"contractType","in":"query","type":"string","required":false,"description":"Indicates if the position is related to Loan, Deposit ,FX-Forward/FX-Swap"},{"name":"customerId","in":"query","type":"string","required":false,"description":"Identifier of the customer"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"ReceivedGuaranteesAmendmentsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/guarantees/{guaranteeId}/invocations","fullPath":"/api/v2.0.0/holdings/guarantees/{guaranteeId}/invocations","operationId":"getClaimInvocationHistory","name":"Retrieves the list of guarantee claim invocation details","summary":"Retrieves the guarantee claim invocation details","tags":["CORPORATE"],"parameters":[{"name":"guaranteeId","in":"path","type":"string","required":true,"description":"Identifier of the guarantee"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"ClaimInvocationHistoryResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/guarantees/receivedClaims","fullPath":"/api/v2.0.0/holdings/guarantees/receivedClaims","operationId":"getReceivedGuaranteeClaims","name":"Retrieves the list of received guarantee claims for a customer","summary":"Retrieves the received guarantee claims","tags":["CORPORATE"],"parameters":[{"name":"customerId","in":"query","type":"string","required":false,"description":"Identifier of the customer"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"ReceivedGuaranteeClaimsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/guarantees/amendments","fullPath":"/api/v2.0.0/holdings/guarantees/amendments","operationId":"getGuaranteeAmendments","name":"Retrieves the list of amended guarantees for specific customer","summary":"Retrieves guarantee amendment requests","tags":["CORPORATE"],"parameters":[{"name":"customerId","in":"query","type":"string","required":false,"description":"Identifier of the customer"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"GuaranteeAmendmentsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/guarantees/issuedGuarantees","fullPath":"/api/v2.0.0/holdings/guarantees/issuedGuarantees","operationId":"getIssuedGuarantees","name":"Retrieves the list of issued guarantee request details for specific customer","summary":"Retrieves the issued guarantee details","tags":["CORPORATE"],"parameters":[{"name":"customerId","in":"query","type":"string","required":false,"description":"Identifier of the customer"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"IssuedGuaranteesResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/guarantees/limits","fullPath":"/api/v2.0.0/holdings/guarantees/limits","operationId":"getGuaranteeLimits","name":"Retrieves the list of guarantees limit details","summary":"Retrieves the guarantee limits","tags":["CORPORATE"],"parameters":[{"name":"customerId","in":"query","type":"string","required":false,"description":"Identifier of the customer"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"GuaranteeLimitsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/guarantees/issuedClaims","fullPath":"/api/v2.0.0/holdings/guarantees/issuedClaims","operationId":"getIssuedGuaranteeClaims","name":"Retrieves the list of received guarantee claim details","summary":"Retrieves the received guarantee claims","tags":["CORPORATE"],"parameters":[{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"IssuedGuaranteeClaimsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/guarantees","fullPath":"/api/v2.0.0/holdings/guarantees","operationId":"getGuarantees","name":"Retrieves the list of guarantee details","summary":"Retrieves the guarantee details","tags":["CORPORATE"],"parameters":[{"name":"guaranteeId","in":"query","type":"string","required":false,"description":"Identifier of the guarantee"},{"name":"beneficiaryCustomerId","in":"query","type":"string","required":false,"description":"Identifies the Customer who is to be the ultimate receiver of the funds transferred by the sending bank when this Beneficiary is not a bank."},{"name":"contractType","in":"query","type":"string","required":false,"description":"Indicates if the position is related to Loan, Deposit ,FX-Forward/FX-Swap"},{"name":"ibRequestId","in":"query","type":"string","required":false,"description":"The guarantees issuance id initiated by internet banking"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"GuaranteesResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"POST","path":"/holdings/guarantees","fullPath":"/api/v2.0.0/holdings/guarantees","operationId":"createGuaranteeGeneric","name":"Creates a generic guarantee for the requested customer reference number","summary":"Creates a generic guarantee","tags":["CORPORATE"],"parameters":[{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"beneficiaryIds":[{}],"beneficiaryAddresses":[{}],"charges":[{}],"bankAddresses":[{}],"detailsOfGuarantee":[{}],"guaranteeReference":"string","customerId":"string","currency":"string","amount":0.0,"dealDate":"2024-01-01","startDate":"2024-01-01","expiryDate":"2024-01-01","maturityDate":"2024-01-01","limitReference":"string","termsAndConditions":"string"}},"responses":{"200":"GuaranteeGenericResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/holdings/customers/{customerId}/guarantees/outstandings","fullPath":"/api/v2.0.0/holdings/customers/{customerId}/guarantees/outstandings","operationId":"getGuaranteesOutstandings","name":"Retrieves the detailed information on issued guarantees for the specified customer/guarantee reference","summary":"Retrieves outstanding guarantees","tags":["CORPORATE"],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"Identifier of the customer"},{"name":"transactionReference","in":"query","type":"string","required":false,"description":"Contains the identifier for the transaction in the core system"},{"name":"guaranteeType","in":"query","type":"string","required":false,"description":"Refers to the type of the contract that is being issued."},{"name":"currency","in":"query","type":"string","required":false,"description":"Identifies the currency. E.g. USD, GBP etc"},{"name":"amount","in":"query","type":"string","required":false,"description":"This is the payment amount"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"GuaranteesOutstandingsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/customers/{customerId}/guarantees/expiries","fullPath":"/api/v2.0.0/holdings/customers/{customerId}/guarantees/expiries","operationId":"getGuaranteeExpiringWithDate","name":"Retrieves the expiring guarantees details for the specified customer/guarantee reference ","summary":"Retrieves expiring guarantees","tags":["CORPORATE"],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"Identifier of the customer"},{"name":"transactionReference","in":"query","type":"string","required":false,"description":"Contains the identifier for the transaction in the core system"},{"name":"currency","in":"query","type":"string","required":false,"description":"Identifies the currency. E.g. USD, GBP etc"},{"name":"amount","in":"query","type":"string","required":false,"description":"This is the payment amount"},{"name":"maturityDate","in":"query","type":"string","required":false,"description":"Indicates maturity date of the contract"},{"name":"gteeReturnDate","in":"query","type":"string","required":false,"description":"Date on which the original Guarantee will be returned by the customer to the Bank that issued it"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"GuaranteeExpiringWithDateResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/customers/{customerId}/guarantees/outstandingClaims","fullPath":"/api/v2.0.0/holdings/customers/{customerId}/guarantees/outstandingClaims","operationId":"getClaimOutstandingUnderGuarantees","name":"Retrieves the list of corporate miscellaneous deals for the customer.","summary":"Retrieves outstanding guarantee claims","tags":["CORPORATE"],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"Identifier of the customer"},{"name":"transactionReference","in":"query","type":"string","required":false,"description":"Contains the identifier for the transaction in the core system"},{"name":"currency","in":"query","type":"string","required":false,"description":"Identifies the currency. E.g. USD, GBP etc"},{"name":"amount","in":"query","type":"string","required":false,"description":"This is the payment amount"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"ClaimOutstandingUnderGuaranteesResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/customers/{customerId}/guarantees/cancellations","fullPath":"/api/v2.0.0/holdings/customers/{customerId}/guarantees/cancellations","operationId":"getGuaranteesReversed","name":"Retrieves the list of cancelled guarantees for the specified customer/guarantee reference","summary":"Retrieves list of cancelled guarantees","tags":["CORPORATE"],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"Identifier of the customer"},{"name":"transactionReference","in":"query","type":"string","required":false,"description":"Contains the identifier for the transaction in the core system"},{"name":"guaranteeType","in":"query","type":"string","required":false,"description":"Refers to the type of the contract that is being issued."},{"name":"currency","in":"query","type":"string","required":false,"description":"Identifies the currency. E.g. USD, GBP etc"},{"name":"amount","in":"query","type":"string","required":false,"description":"This is the payment amount"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"GuaranteesReversedResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/guarantees/{guaranteeId}/issuedClaims","fullPath":"/api/v2.0.0/holdings/guarantees/{guaranteeId}/issuedClaims","operationId":"getClaimsPaidUnderGuarantee","name":"Retrieves the list of issued guarantees paid/cancelled for the specified customer/guarantee reference.","summary":"Retrieves paid/cancelled details of issued guarantees","tags":["CORPORATE"],"parameters":[{"name":"guaranteeId","in":"path","type":"string","required":true,"description":""},{"name":"transactionReference","in":"query","type":"string","required":false,"description":"Contains the identifier for the transaction in the core system"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"ClaimsPaidUnderGuaranteeResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/guarantees/{guaranteeId}/shippings/outstandings","fullPath":"/api/v2.0.0/holdings/guarantees/{guaranteeId}/shippings/outstandings","operationId":"getOutstandingShippingGuarantees","name":"Retrieves the details of outstanding shipping guarantees for the specified customer/guarantee reference.","summary":"Retrieves list of outstanding shipping guarantees","tags":["CORPORATE"],"parameters":[{"name":"guaranteeId","in":"path","type":"string","required":true,"description":""},{"name":"transactionReference","in":"query","type":"string","required":false,"description":"Contains the identifier for the transaction in the core system"},{"name":"lCReference","in":"query","type":"string","required":false,"description":"Indicates the LC reference under which the guarantee is to be opened"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"OutstandingShippingGuaranteesResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/customers/{customerId}/guarantees/receivedOutstandings","fullPath":"/api/v2.0.0/holdings/customers/{customerId}/guarantees/receivedOutstandings","operationId":"getOutstandingReceivedGuarantees","name":"Retrieves the details of outstanding received guarantees for the specified customer/guarantee reference.","summary":"Retrieves outstanding received guarantees details","tags":["CORPORATE"],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":""},{"name":"transactionReference","in":"query","type":"string","required":false,"description":"Contains the identifier for the transaction in the core system"},{"name":"customer","in":"query","type":"string","required":false,"description":"Contains the customer identifier to fetch list of consent arrangements for the customer or customer identifier of the debtor account. This will be populated once the SCA(Strong Customer Authentication"},{"name":"guaranteeType","in":"query","type":"string","required":false,"description":"Refers to the type of the contract that is being issued."},{"name":"currency","in":"query","type":"string","required":false,"description":"Identifies the currency. E.g. USD, GBP etc"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"OutstandingReceivedGuaranteesResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"POST","path":"/holdings/guarantee/performanceBonds","fullPath":"/api/v2.0.0/holdings/guarantee/performanceBonds","operationId":"createGuaranteesPerformanceBond","name":"Creates performance bond guarantee for the requested customer reference number","summary":"Creates performance bond guarantee","tags":["CORPORATE"],"parameters":[{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"beneficiaryIds":[{}],"beneficiaryaddresses":[{}],"charges":[{}],"bankAddresses":[{}],"detailsOfGuarantee":[{}],"performanceBondReference":"string","customerId":"string","currency":"string","amount":0.0,"dealDate":"2024-01-01","valueDate":"2024-01-01","expiryDate":"2024-01-01","maturityDate":"2024-01-01","termsAndConditions":"string","eventsProcessing":"string"}},"responses":{"200":"GuaranteesPerformanceBondResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"POST","path":"/holdings/guarantees/letterOfCredits/standBys","fullPath":"/api/v2.0.0/holdings/guarantees/letterOfCredits/standBys","operationId":"createGuaranteesStandbyLC","name":"Creates standby letter of credit guarantee for the requested customer reference number","summary":"Creates standby letter of credit guarantee","tags":["CORPORATE"],"parameters":[{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"beneficiaryIds":[{}],"beneficiaryAddresses":[{}],"charges":[{}],"bankAddresses":[{}],"detailsOfGuarantee":[{}],"standByImportLC":"string","customerId":"string","currency":"string","amount":0.0,"dealDate":"2024-01-01","valueDate":"2024-01-01","expiryDate":"2024-01-01","maturityDate":"2024-01-01","termsAndConditions":"string","eventsProcessing":"string"}},"responses":{"200":"GuaranteesStandbyLCResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"POST","path":"/holdings/guarantees/letterOfCredits/shippings","fullPath":"/api/v2.0.0/holdings/guarantees/letterOfCredits/shippings","operationId":"createShippingGuaranteeUnderLC","name":"Creates shipping guarantees under letter of credit for the requested customer reference number","summary":"Creates  shipping guarantees under letter of credit","tags":["CORPORATE"],"parameters":[{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"beneficiaryIds":[{}],"beneficiaryAddresses":[{}],"charges":[{}],"bankAddresses":[{}],"detailsOfGuarantee":[{}],"internalReference":"string","customerId":"string","currency":"string","amount":0.0,"dealDate":"2024-01-01","valueDate":"2024-01-01","maturityDate":"2024-01-01","termsAndConditions":"string","eventsProcessing":"string","autoExpiry":"string"}},"responses":{"200":"ShippingGuaranteeUnderLCResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"POST","path":"/holdings/guarantees/letterOfCredits/shippings/collections","fullPath":"/api/v2.0.0/holdings/guarantees/letterOfCredits/shippings/collections","operationId":"createShippingGuaranteeUnderCollection","name":"Creates shipping guarantee under collection letter of credit for the requested customer reference number","summary":"Creates shipping guarantee under collection letter of credit","tags":["CORPORATE"],"parameters":[{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"beneficiaryId":[{}],"beneficiaryAddresses":[{}],"charges":[{}],"bankAddresses":[{}],"detailsOfGuarantee":[{}],"shippingGuaranteeReference":"string","customerId":"string","currency":"string","amount":0.0,"dealDate":"2024-01-01","valueDate":"2024-01-01","maturityDate":"2024-01-01","termsAndConditions":"string","eventsProcessing":"string","autoExpiry":"string"}},"responses":{"200":"ShippingGuaranteeUnderCollectionResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/holdings/guarantees/{guaranteeId}/receivedClaims","fullPath":"/api/v2.0.0/holdings/guarantees/{guaranteeId}/receivedClaims","operationId":"getInvocationPaidOrCancelled","name":"Retrieves the list of received guarantees paid/cancelled for the specified customer/guarantee reference","summary":"Retrieves paid/cancelled details of received guarantees","tags":["CORPORATE"],"parameters":[{"name":"guaranteeId","in":"path","type":"string","required":true,"description":""},{"name":"transactionReference","in":"query","type":"string","required":false,"description":"Contains the identifier for the transaction in the core system"},{"name":"beneficiary","in":"query","type":"string","required":false,"description":"Beneficiary information"},{"name":"debitAccountId","in":"query","type":"string","required":false,"description":"Indicates the debit account number of the payment or transaction."},{"name":"creditAccountId","in":"query","type":"string","required":false,"description":"Credit account identifier of the payment or transaction"},{"name":"amount","in":"query","type":"string","required":false,"description":"This is the payment amount"},{"name":"debitValueDate","in":"query","type":"string","required":false,"description":"Date on which the amount will be debited for settlement"},{"name":"creditValueDate","in":"query","type":"string","required":false,"description":"Reference quoted by the credit account for a payment"},{"name":"correspondentBank","in":"query","type":"string","required":false,"description":"Correspondent bank, where our nostro account is held."},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"InvocationPaidOrCancelledResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"POST","path":"/holdings/guarantees/bidBonds","fullPath":"/api/v2.0.0/holdings/guarantees/bidBonds","operationId":"createGuarnteeBidBond","name":"Creates bid bond guarantee for the requested customer reference number","summary":"Creates bid bond guarantee","tags":["CORPORATE"],"parameters":[{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"beneficiaryIds":[{}],"beneficiaryAddresses":[{}],"charges":[{}],"bankAddresses":[{}],"detailsOfGuarantee":[{}],"bidBondReference":"string","customerId":"string","currency":"string","amount":0.0,"dealDate":"2024-01-01","valueDate":"2024-01-01","expiryDate":"2024-01-01","maturityDate":"string","termsAndConditions":"string","eventsProcessing":"string"}},"responses":{"200":"GuarnteeBidBondResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"POST","path":"/holdings/guarantees/{guaranteeId}/rejectedClaims","fullPath":"/api/v2.0.0/holdings/guarantees/{guaranteeId}/rejectedClaims","operationId":"updateGuaranteesRejection","name":"Updates the rejection of claim for the specified guarantee/customer reference number","summary":"Updates the rejection of claim for a guarantee","tags":["CORPORATE"],"parameters":[{"name":"guaranteeId","in":"path","type":"string","required":true,"description":""},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"beneficiaryIds":[{}],"beneficairyAddresses":[{}],"guaranteeReference":"string","guaranteeType":"string","customerId":"string","limitReference":"string","currency":"string","amount":"string","startDate":"string","maturityDate":"string","autoExpiry":"string","onlineMaturity":"string","eventsProcessing":"string","liquidationMode":"string","claimRegisterDate":"string"}},"responses":{"200":"GuaranteesRejectionResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"POST","path":"/holdings/guarantees/{guaranteeId}","fullPath":"/api/v2.0.0/holdings/guarantees/{guaranteeId}","operationId":"updateGuaranteesAmendment","name":"Updates additional guarantee information for the specified  customer/guarantee reference number","summary":"Updates guarantee details","tags":["CORPORATE"],"parameters":[{"name":"guaranteeId","in":"path","type":"string","required":true,"description":""},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"BeneficiaryIds":[{}],"BeneficiaryAddresses":[{}],"pincipalMovements":[{}],"texts":[{}],"guarantees":[{}],"ibClaimNarratives":[{}],"charges":[{}],"bankAddresses":[{}],"detailsOfGuarantee":[{}],"guaranteeReference":"string","customerReference":"string","customerId":"string","guaranteeType":"string","productCategoryId":"string","currency":"string"}},"responses":{"200":"GuaranteesAmendmentResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"POST","path":"/holdings/guarantees/issuances/requests/initiations","fullPath":"/api/v2.0.0/holdings/guarantees/issuances/requests/initiations","operationId":"initiateIssuance","name":"Initiates guarantee issuance request through self service channel for the corporate user","summary":"Initiates new guarantee issuance","tags":["CORPORATE"],"parameters":[{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"guaranteeDetail":[{}],"beneficiaries":[{}],"charges":[{}],"commission":[{}],"undertakingIssued":[{}],"formOfUndertaking":"string","currency":"string","valueDate":"string","expiryType":"string","adviceExpiryDate":"string","applicableRule":"string","advisingBank":"string","marginDebitAccount":"string","guaranteeType":"string","category":"string"}},"responses":{"200":"IssuanceResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/holdings/guarantees/issuances/requests/{requestId}","fullPath":"/api/v2.0.0/holdings/guarantees/issuances/requests/{requestId}","operationId":"updateIssuance","name":"Updates the details of the guarantee request which are mandated for the issuing by the issuing bank","summary":"Facilitates the updation of  the Guarantee which is initiated  for a customer","tags":["CORPORATE"],"parameters":[{"name":"requestId","in":"path","type":"string","required":true,"description":"The guarantees issuance id initiated by internet banking"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"guaranteeDetail":[{}],"applicantCustomers":[{}],"charges":[{}],"commission":[{}],"commissionType":[{}],"beneficiaryAddresses":[{}],"beneficiaries":[{}],"senderReceiversInfoMT730":[{}],"undertakingIssued":[{}],"counterparty":[{}],"counterpartyBeneficiaries":[{}],"comments":[{}],"guaranteeReference":"string","guaranteeType":"string","advisingBank":"string"}},"responses":{"200":"IssuanceResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"DELETE","path":"/holdings/guarantees/issuances/requests/{requestId}","fullPath":"/api/v2.0.0/holdings/guarantees/issuances/requests/{requestId}","operationId":"reverseIssuance","name":"Reverse the existing guarantee file issued by the issuing bak on behalf of a corporate customer","summary":"Enables the option to reverse the existing guarantee for a customer","tags":["CORPORATE"],"parameters":[{"name":"requestId","in":"path","type":"string","required":true,"description":"The guarantees issuance id initiated by internet banking"},{"name":"payload","in":"body","type":"object","required":false,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}}},"responses":{"200":"IssuanceResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/holdings/guarantees/issuances/requests/{requestId}/rejections","fullPath":"/api/v2.0.0/holdings/guarantees/issuances/requests/{requestId}/rejections","operationId":"rejectClaimIssuance","name":"Reject response of a claim received by the issuing bank to the beneficiary bank","summary":"Captures the values for the  the rejection of claim for a guarantee issued","tags":["CORPORATE"],"parameters":[{"name":"requestId","in":"path","type":"string","required":true,"description":"The guarantees issuance id initiated by internet banking"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"beneficiaries":[{}],"beneficiaryAddresses":[{}],"guaranteeDetail":[{}],"internetBankingClaimNarratives":[{}],"narratives":[{}],"senderToReceiverInfos":[{}],"comments":[{}],"guaranteeReference":"string","guaranteeType":"string","maturityDate":"2024-01-01","currency":"string","invocationAmount":0.0,"advisingBank":"string","claimRegisterDate":"2024-01-01","formOfUndertaking":"string"}},"responses":{"200":"ClaimIssuanceResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/holdings/guarantees/issuances/requests/{requestId}/amendments/confirmations","fullPath":"/api/v2.0.0/holdings/guarantees/issuances/requests/{requestId}/amendments/confirmations","operationId":"approveIssuance","name":"Approves  the amendment response  received  from the corporate user  for an received guarantees for a corporate customer","summary":"Enables to capture the approval for the amendment response for the incoming amendments","tags":["CORPORATE"],"parameters":[{"name":"requestId","in":"path","type":"string","required":true,"description":"The guarantees issuance id initiated by internet banking"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"rejectionReasons":[{}],"additionalInformations":[{}],"comments":[{}],"amendmentStatus":"string","amendmentNumber":"string","extensions":{}}},"responses":{"200":"IssuanceResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/holdings/guarantees/issuances/requests","fullPath":"/api/v2.0.0/holdings/guarantees/issuances/requests","operationId":"getIssuance","name":"Retrieves the list of issued guarantees by the issuing bank for any corporate customer","summary":"Enables to retrieve the list of issued guarantees outstanding","tags":["CORPORATE"],"parameters":[{"name":"beneficiary","in":"query","type":"string","required":false,"description":"Beneficiary information"},{"name":"contractType","in":"query","type":"string","required":false,"description":"Indicates if the position is related to Loan, Deposit ,FX-Forward/FX-Swap"},{"name":"guaranteeId","in":"query","type":"string","required":false,"description":"Identifier of the guarantee"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"IssuanceResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"POST","path":"/holdings/guarantees/issuances/requests","fullPath":"/api/v2.0.0/holdings/guarantees/issuances/requests","operationId":"createIssuance","name":"Initiation of  a guarantee issuance request by the the issuing bank for the applicant or the instructing party.","summary":"Facilitates the creation of guarantee issuance for a customer","tags":["CORPORATE"],"parameters":[{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"guaranteeDetail":[{}],"applicantCustomers":[{}],"charges":[{}],"commission":[{}],"commissionType":[{}],"beneficiaryAddresses":[{}],"beneficiaries":[{}],"senderReceiversInfoMT730":[{}],"undertakingIssued":[{}],"counterparty":[{}],"counterpartyBeneficiaries":[{}],"comments":[{}],"guaranteeReference":"string","guaranteeType":"string","advisingBank":"string"}},"responses":{"200":"IssuanceResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/holdings/guarantees/issuances/amendments","fullPath":"/api/v2.0.0/holdings/guarantees/issuances/amendments","operationId":"getAmendmentsIssuance","name":"Retrieves the list of amendments and the details for  an issued guarantee by the issuing bank","summary":"Retrieves the list of amendment history for the issued guarantees for a corporate customer","tags":["CORPORATE"],"parameters":[{"name":"customerId","in":"query","type":"string","required":false,"description":"Identifier of the customer"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"AmendmentsIssuanceResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"PUT","path":"/holdings/guarantees/issuances/requests/{requestId}/claims","fullPath":"/api/v2.0.0/holdings/guarantees/issuances/requests/{requestId}/claims","operationId":"updateClaimIssuance","name":"Updates the received claim details sent by the beneficiary to the issued guarantee records","summary":"Facilitates in updating the details of a claim for the guarantee issuance","tags":["CORPORATE"],"parameters":[{"name":"requestId","in":"path","type":"string","required":true,"description":"The guarantees issuance id initiated by internet banking"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"senderToReceiverInfoS":[{}],"beneficiaryIdS":[{}],"beneficiaryAddresses":[{}],"applicationIds":[{}],"narratives":[{}],"statementNarratives":[{}],"claimDebitAccount":"string","chargeBearer":"string","claimPaymentMethod":"string","claimCreditAccount":"string","autoExpiry":"string","guaranteeReference":"string","guaranteeType":"string","maturityDate":"string","currency":"string"}},"responses":{"200":"ClaimIssuanceResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/holdings/guarantees/issuances/requests/{requestId}/amendments","fullPath":"/api/v2.0.0/holdings/guarantees/issuances/requests/{requestId}/amendments","operationId":"amendIssuance","name":"Amendment of the terms and conditions of the guarantee after issuance  by the issuing bank and notifying the parties in the guarantee","summary":"Facilitates the updation of  the existing guarantee initiation request for a customer","tags":["CORPORATE"],"parameters":[{"name":"requestId","in":"path","type":"string","required":true,"description":"The guarantees issuance id initiated by internet banking"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"guaranteeDetails":[{}],"charges":[{}],"commission":[{}],"amendmentDetail":[{}],"counterparties":[{}],"reimbursingBankReferences":[{}],"newCreditTolerance":"string","newDebitTolerances":"string","externalReference":"string","increaseDecreaseAmount":"string","adviceExpiryDate":"string","comments":"string","extensions":{}}},"responses":{"200":"IssuanceResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/holdings/guarantees/issuances/extensions","fullPath":"/api/v2.0.0/holdings/guarantees/issuances/extensions","operationId":"getAutoExtensionDetails","name":"Provides a view of guarantees which are subject to auto extension","summary":"Retrieves the auto extension details associated with guarantee issuance","tags":["CORPORATE"],"parameters":[{"name":"guaranteeType","in":"query","type":"string","required":false,"description":"Refers to the type of the contract that is being issued."},{"name":"guaranteeId","in":"query","type":"string","required":false,"description":"Identifier of the guarantee"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"AutoExtensionDetailsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"PUT","path":"/holdings/guarantees/receipts/requests/{requestId}","fullPath":"/api/v2.0.0/holdings/guarantees/receipts/requests/{requestId}","operationId":"updateStatusOfReceipt","name":"Updates the status for the existing guarantee received field by the issuing bank with the concurrence of the beneficiary","summary":"Facilitates in updating  the status for the existing guarantee received","tags":["CORPORATE"],"parameters":[{"name":"requestId","in":"path","type":"string","required":true,"description":"The guarantees issuance id initiated by internet banking"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"comments":[{}],"guaranteeReference":"string","senderToReceiverInfo":"string","extensions":{}}},"responses":{"200":"StatusOfReceiptResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/holdings/guarantees/receipts/requests","fullPath":"/api/v2.0.0/holdings/guarantees/receipts/requests","operationId":"getReceipts","name":"Retrieves the list of issued guarantee claims that are received for the guarantees issued","summary":"Enables to retrieve the list of received guarantees and outstanding","tags":["CORPORATE"],"parameters":[{"name":"guaranteeId","in":"query","type":"string","required":false,"description":"Identifier of the guarantee"},{"name":"guaranteeReference","in":"query","type":"string","required":false,"description":"Another ID for the transaction for retrieval purposes or it can be used for the bank to use a unique guarantee number rather than the system generated ID"},{"name":"beneficiary","in":"query","type":"string","required":false,"description":"Beneficiary information"},{"name":"claimStatus","in":"query","type":"string","required":false,"description":"Status update of the claim records"},{"name":"guaranteeType","in":"query","type":"string","required":false,"description":"Refers to the type of the contract that is being issued."},{"name":"applicantCustomerId","in":"query","type":"string","required":false,"description":"This field identifies the applicant on whose behalf the Letter of Credit is issued, if the applicant is held on the CUSTOMER file."},{"name":"applicantAddress","in":"query","type":"string","required":false,"description":"It indicates the name and address of the party who is engaged in trade agreement with beneficiary. Although the initial values are defaulted from the Customer file, yet they may be altered with an alt"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"ReceiptsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/guarantees/receipts/amendments","fullPath":"/api/v2.0.0/holdings/guarantees/receipts/amendments","operationId":"getAmendmentsReceipts","name":"Retrieves the list of amendment history details for the received guarantee file for a corporate customer","summary":"Fetches the list of amendment history for the received guarantees for a corporate customer","tags":["CORPORATE"],"parameters":[{"name":"beneficiary","in":"query","type":"string","required":true,"description":"Beneficiary information"},{"name":"guaranteeId","in":"query","type":"string","required":false,"description":"Identifier of the guarantee"},{"name":"inwardMessageId","in":"query","type":"string","required":false,"description":"This field holds the inward delivery reference for the corresponding message type."},{"name":"inwardPaymentType","in":"query","type":"string","required":false,"description":"To identify the incoming SWIFT payment received direct from Delivery, payments generated by standing orders and local clearing payments."},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"AmendmentsReceiptsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}}]},{"key":"holdings-guarantees-service-v3.0.0","title":"Management of Guarantees","version":"v3.0.0","description":"API to create, update and manage various types of bank issued guarantees and their associated status and details. Some of the types of guarantees that can be created are bid bonds, performance bonds and trade finance shipping guarantees.","endpointCount":55,"endpoints":[{"method":"GET","path":"/holdings/guarantees/clauses/{clauseId}","fullPath":"/api/v3.0.0/holdings/guarantees/clauses/{clauseId}","operationId":"getClause","name":"Retrieves the guarantee clause details of specific id","summary":"Details of guarantee clause","tags":["CORPORATE"],"parameters":[{"name":"clauseId","in":"path","type":"string","required":true,"description":"Represents id of MD.CLAUSES. Id can be used in MD application and description is automatically populated in the deal.Records created for customer specific clauses, to have ID beginning with the custom"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"ClauseResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"POST","path":"/holdings/guarantees/clauses/{clauseId}","fullPath":"/api/v3.0.0/holdings/guarantees/clauses/{clauseId}","operationId":"createClause","name":"Creates the guarantee clause for a specific customer","summary":"Create guarantee clause","tags":["CORPORATE"],"parameters":[{"name":"clauseId","in":"path","type":"string","required":true,"description":"Represents id of MD.CLAUSES. Id can be used in MD application and description is automatically populated in the deal.Records created for customer specific clauses, to have ID beginning with the custom"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"mdClausesDescriptions":[{}],"mdClausesDisplayName":"string","extensions":{}}},"responses":{"200":"ClauseResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/holdings/guarantees/clauses/{clauseId}","fullPath":"/api/v3.0.0/holdings/guarantees/clauses/{clauseId}","operationId":"updateClause","name":"Updates the guarantee clause for the specific id","summary":"Update guarantee clause","tags":["CORPORATE"],"parameters":[{"name":"clauseId","in":"path","type":"string","required":true,"description":"Represents id of MD.CLAUSES. Id can be used in MD application and description is automatically populated in the deal.Records created for customer specific clauses, to have ID beginning with the custom"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"mdClausesDescriptions":[{}],"mdClausesDisplayName":"string","extensions":{}}},"responses":{"200":"ClauseResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"DELETE","path":"/holdings/guarantees/clauses/{clauseId}","fullPath":"/api/v3.0.0/holdings/guarantees/clauses/{clauseId}","operationId":"deleteClause","name":"Removes the guarantee clause request","summary":"Remove guarantee clause","tags":["CORPORATE"],"parameters":[{"name":"clauseId","in":"path","type":"string","required":true,"description":"Represents id of MD.CLAUSES. Id can be used in MD application and description is automatically populated in the deal.Records created for customer specific clauses, to have ID beginning with the custom"},{"name":"payload","in":"body","type":"object","required":false,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}}},"responses":{"200":"ClauseResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/holdings/guarantees/requests","fullPath":"/api/v3.0.0/holdings/guarantees/requests","operationId":"getGuaranteeIssuanceRequests","name":"Retrieves the list of guarantee initiation request details","summary":"Retrieves the guarantee initiation requests","tags":["CORPORATE"],"parameters":[{"name":"mdIbRequestId","in":"query","type":"string","required":false,"description":"The guarantees issuance id initiated by internet banking"},{"name":"customerId","in":"query","type":"string","required":false,"description":"Identifier of the customer"},{"name":"ibEventStatus","in":"query","type":"string","required":false,"description":"Specifies the status of the guarantee issuance request."},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it Retrieves all the data"}],"requestBodyExample":null,"responses":{"200":"GuaranteeIssuanceRequestsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"POST","path":"/holdings/guarantees/requests","fullPath":"/api/v3.0.0/holdings/guarantees/requests","operationId":"createIbRequest","name":"Creates the guarantee initiation request from internet banking","summary":"Create guarantee initiation request","tags":["CORPORATE"],"parameters":[{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"beneficiaryIds":[{}],"guarantees":[{}],"documentDetails":[{}],"limits":[{}],"messageFromBanks":[{}],"messageFromCustomers":[{}],"information":[{}],"amendmentDetails":[{}],"overrides":[{}],"customerId":"string","currencyId":"string","principalAmount":0.0,"startDate":"2024-01-01","maturityDate":"2024-01-01","categoryName":"string"}},"responses":{"200":"IbRequestResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/holdings/guarantees/requests/{requestId}","fullPath":"/api/v3.0.0/holdings/guarantees/requests/{requestId}","operationId":"getIbRequest","name":"Retrieves the guarantee initiation request details for specific id","summary":"Details of guarantee initiation request","tags":["CORPORATE"],"parameters":[{"name":"requestId","in":"path","type":"string","required":true,"description":"The guarantees issuance id initiated by internet banking"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"IbRequestResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/holdings/guarantees/requests/{requestId}","fullPath":"/api/v3.0.0/holdings/guarantees/requests/{requestId}","operationId":"updateIbRequest","name":"Updates the existing guarantee initiation request for a customer","summary":"Update guarantee initiation request","tags":["CORPORATE"],"parameters":[{"name":"requestId","in":"path","type":"string","required":true,"description":"The guarantees issuance id initiated by internet banking"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"beneficiaryIds":[{}],"guarantees":[{}],"documentDetails":[{}],"limits":[{}],"messageFromBanks":[{}],"messageFromCustomers":[{}],"information":[{}],"amendmentDetails":[{}],"overrides":[{}],"customerId":"string","currencyId":"string","principalAmount":0.0,"startDate":"2024-01-01","maturityDate":"2024-01-01","categoryName":"string"}},"responses":{"200":"IbRequestResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"DELETE","path":"/holdings/guarantees/requests/{requestId}","fullPath":"/api/v3.0.0/holdings/guarantees/requests/{requestId}","operationId":"deleteIbRequest","name":"Removes the existing guarantee initiation request","summary":"Remove guarantee initiation request","tags":["CORPORATE"],"parameters":[{"name":"requestId","in":"path","type":"string","required":true,"description":"The guarantees issuance id initiated by internet banking"},{"name":"payload","in":"body","type":"object","required":false,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}}},"responses":{"200":"IbRequestResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/holdings/guarantees/guaranteesApprovals/{requestId}","fullPath":"/api/v3.0.0/holdings/guarantees/guaranteesApprovals/{requestId}","operationId":"approveGuarantee","name":"Approves the guarantee initiation request","summary":"Approve guarantee initiation request","tags":["CORPORATE"],"parameters":[{"name":"requestId","in":"path","type":"string","required":true,"description":"The guarantees issuance id initiated by internet banking"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"GuaranteeResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"DELETE","path":"/holdings/guarantees/cancellations/{requestId}","fullPath":"/api/v3.0.0/holdings/guarantees/cancellations/{requestId}","operationId":"rejectGuarantee","name":"Reject the guarantee initiation request","summary":"Reject guarantee initiation request","tags":["CORPORATE"],"parameters":[{"name":"requestId","in":"path","type":"string","required":true,"description":"The guarantees issuance id initiated by internet banking"},{"name":"payload","in":"body","type":"object","required":false,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}}},"responses":{"200":"GuaranteeResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/holdings/guarantees/{guaranteeId}/receivedGuarantees","fullPath":"/api/v3.0.0/holdings/guarantees/{guaranteeId}/receivedGuarantees","operationId":"getReceivedGuaranteeHistory","name":"Retrieves the received guarantee requests for the customer ","summary":"Retrieves received guarantee requests","tags":["CORPORATE"],"parameters":[{"name":"guaranteeId","in":"path","type":"string","required":true,"description":"Identifier of the guarantee"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it Retrieves all the data"}],"requestBodyExample":null,"responses":{"200":"ReceivedGuaranteeHistoryResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/guarantees/clauses","fullPath":"/api/v3.0.0/holdings/guarantees/clauses","operationId":"getGuaranteeClauses","name":"Retrieves the list of guarantee clause requests for specific customer","summary":"Retrieves the guarantee clause requests","tags":["CORPORATE"],"parameters":[{"name":"clauseId","in":"query","type":"string","required":false,"description":"Represents id of MD.CLAUSES. Id can be used in MD application and description is automatically populated in the deal.Records created for customer specific clauses, to have ID beginning with the custom"},{"name":"customerId","in":"query","type":"string","required":false,"description":"Identifier of the customer"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it Retrieves all the data"}],"requestBodyExample":null,"responses":{"200":"GuaranteeClausesResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/guarantees/receivedGuarantees/amendments","fullPath":"/api/v3.0.0/holdings/guarantees/receivedGuarantees/amendments","operationId":"getReceivedGuaranteesAmendments","name":"Retrieves the list of amended guarantee requests","summary":"Retrieves the amended guarantee requests","tags":["CORPORATE"],"parameters":[{"name":"alternateId","in":"query","type":"string","required":false,"description":"An Alternate Identification for the Deal. This can be used to retrieve the Deal for amendment."},{"name":"contractType","in":"query","type":"string","required":false,"description":"Indicates if the position is related to Loan, Deposit ,FX-Forward/FX-Swap"},{"name":"customerId","in":"query","type":"string","required":false,"description":"Identifier of the customer"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it Retrieves all the data"}],"requestBodyExample":null,"responses":{"200":"ReceivedGuaranteesAmendmentsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/guarantees/{guaranteeId}/invocations","fullPath":"/api/v3.0.0/holdings/guarantees/{guaranteeId}/invocations","operationId":"getClaimInvocationHistory","name":"Retrieves the list of guarantee claim invocation details","summary":"Retrieves the guarantee claim invocation details","tags":["CORPORATE"],"parameters":[{"name":"guaranteeId","in":"path","type":"string","required":true,"description":"Identifier of the guarantee"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it Retrieves all the data"}],"requestBodyExample":null,"responses":{"200":"ClaimInvocationHistoryResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/guarantees/receivedClaims","fullPath":"/api/v3.0.0/holdings/guarantees/receivedClaims","operationId":"getReceivedGuaranteeClaims","name":"Retrieves the list of received guarantee claim for a customer","summary":"Retrieves the received guarantee claims","tags":["CORPORATE"],"parameters":[{"name":"customerId","in":"query","type":"string","required":false,"description":"Identifier of the customer"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it Retrieves all the data"}],"requestBodyExample":null,"responses":{"200":"ReceivedGuaranteeClaimsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/guarantees/amendments","fullPath":"/api/v3.0.0/holdings/guarantees/amendments","operationId":"getGuaranteeAmendments","name":"Retrieves the list of amended guarantee requests for specific customer","summary":"Retrieves guarantee amendment requests","tags":["CORPORATE"],"parameters":[{"name":"customerId","in":"query","type":"string","required":false,"description":"Identifier of the customer"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it Retrieves all the data"}],"requestBodyExample":null,"responses":{"200":"GuaranteeAmendmentsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/guarantees/issuedGuarantees","fullPath":"/api/v3.0.0/holdings/guarantees/issuedGuarantees","operationId":"getIssuedGuarantees","name":"Retrieves the list of issued guarantee request details for specific customer","summary":"Retrieves the issued guarantee details","tags":["CORPORATE"],"parameters":[{"name":"customerId","in":"query","type":"string","required":false,"description":"Identifier of the customer"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it Retrieves all the data"}],"requestBodyExample":null,"responses":{"200":"IssuedGuaranteesResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/guarantees/limits","fullPath":"/api/v3.0.0/holdings/guarantees/limits","operationId":"getGuaranteeLimits","name":"Retrieves the list of guarantees limit details","summary":"Retrieves the guarantee limits","tags":["CORPORATE"],"parameters":[{"name":"customerId","in":"query","type":"string","required":false,"description":"Identifier of the customer"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it Retrieves all the data"}],"requestBodyExample":null,"responses":{"200":"GuaranteeLimitsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/guarantees/issuedClaims","fullPath":"/api/v3.0.0/holdings/guarantees/issuedClaims","operationId":"getIssuedGuaranteeClaims","name":"Retrieves the list of received guarantee claim details","summary":"Retrieves the received guarantee claims","tags":["CORPORATE"],"parameters":[{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it Retrieves all the data"}],"requestBodyExample":null,"responses":{"200":"IssuedGuaranteeClaimsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/guarantees","fullPath":"/api/v3.0.0/holdings/guarantees","operationId":"getGuarantees","name":"Retrieves the list of guarantee details","summary":"Retrieves the guarantee details","tags":["CORPORATE"],"parameters":[{"name":"guaranteeId","in":"query","type":"string","required":false,"description":"Identifier of the guarantee"},{"name":"beneficiaryCustomerId","in":"query","type":"string","required":false,"description":"Identifies the Customer who is to be the ultimate receiver of the funds transferred by the sending bank when this Beneficiary is not a bank."},{"name":"contractType","in":"query","type":"string","required":false,"description":"Indicates if the position is related to Loan, Deposit ,FX-Forward/FX-Swap"},{"name":"ibRequestId","in":"query","type":"string","required":false,"description":"The guarantees issuance id initiated by internet banking"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it Retrieves all the data"}],"requestBodyExample":null,"responses":{"200":"GuaranteesResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"POST","path":"/holdings/guarantees","fullPath":"/api/v3.0.0/holdings/guarantees","operationId":"createGuaranteeGeneric","name":"Creates a generic guarantee for the requested customer reference number","summary":"Creates a generic guarantee","tags":["CORPORATE"],"parameters":[{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"beneficiaryIds":[{}],"beneficiaryAddresses":[{}],"charges":[{}],"bankAddresses":[{}],"detailsOfGuarantee":[{}],"guaranteeReference":"string","customerId":"string","currency":"string","amount":0.0,"dealDate":"2024-01-01","startDate":"2024-01-01","expiryDate":"2024-01-01","maturityDate":"2024-01-01","limitReference":"string","termsAndConditions":"string"}},"responses":{"200":"GuaranteeGenericResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/holdings/customers/{customerId}/guarantees/outstandings","fullPath":"/api/v3.0.0/holdings/customers/{customerId}/guarantees/outstandings","operationId":"getGuaranteesOutstandings","name":"Retrieves the detailed information on issued guarantees for the specified customer/guarantee reference","summary":"Retrieves outstanding guarantees","tags":["CORPORATE"],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"Identifier of the customer"},{"name":"transactionReference","in":"query","type":"string","required":false,"description":"Contains the identifier for the transaction in the core system"},{"name":"guaranteeType","in":"query","type":"string","required":false,"description":"Refers to the type of the contract that is being issued."},{"name":"currency","in":"query","type":"string","required":false,"description":"Identifies the currency. E.g. USD, GBP etc"},{"name":"amount","in":"query","type":"string","required":false,"description":"This is the payment amount"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it Retrieves all the data"}],"requestBodyExample":null,"responses":{"200":"GuaranteesOutstandingsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/customers/{customerId}/guarantees/expiries","fullPath":"/api/v3.0.0/holdings/customers/{customerId}/guarantees/expiries","operationId":"getGuaranteeExpiringWithDate","name":"Retrieves the expiring guarantees details for the specified customer/guarantee reference ","summary":"Retrieves expiring guarantees","tags":["CORPORATE"],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"Identifier of the customer"},{"name":"transactionReference","in":"query","type":"string","required":false,"description":"Contains the identifier for the transaction in the core system"},{"name":"currency","in":"query","type":"string","required":false,"description":"Identifies the currency. E.g. USD, GBP etc"},{"name":"amount","in":"query","type":"string","required":false,"description":"This is the payment amount"},{"name":"maturityDate","in":"query","type":"string","required":false,"description":"Indicates maturity date of the contract"},{"name":"gteeReturnDate","in":"query","type":"string","required":false,"description":"Date on which the original Guarantee will be returned by the customer to the Bank that issued it"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it Retrieves all the data"}],"requestBodyExample":null,"responses":{"200":"GuaranteeExpiringWithDateResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/customers/{customerId}/guarantees/outstandingClaims","fullPath":"/api/v3.0.0/holdings/customers/{customerId}/guarantees/outstandingClaims","operationId":"getClaimOutstandingUnderGuarantees","name":"Retrieves the list of corporate miscellaneous deals for the customer.","summary":"Retrieves outstanding guarantee claims","tags":["CORPORATE"],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"Identifier of the customer"},{"name":"transactionReference","in":"query","type":"string","required":false,"description":"Contains the identifier for the transaction in the core system"},{"name":"currency","in":"query","type":"string","required":false,"description":"Identifies the currency. E.g. USD, GBP etc"},{"name":"amount","in":"query","type":"string","required":false,"description":"This is the payment amount"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it Retrieves all the data"}],"requestBodyExample":null,"responses":{"200":"ClaimOutstandingUnderGuaranteesResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/customers/{customerId}/guarantees/cancellations","fullPath":"/api/v3.0.0/holdings/customers/{customerId}/guarantees/cancellations","operationId":"getGuaranteesReversed","name":"Retrieves the list of cancelled guarantees for the specified customer/guarantee reference","summary":"Retrieves list of cancelled guarantees","tags":["CORPORATE"],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"Identifier of the customer"},{"name":"transactionReference","in":"query","type":"string","required":false,"description":"Contains the identifier for the transaction in the core system"},{"name":"guaranteeType","in":"query","type":"string","required":false,"description":"Refers to the type of the contract that is being issued."},{"name":"currency","in":"query","type":"string","required":false,"description":"Identifies the currency. E.g. USD, GBP etc"},{"name":"amount","in":"query","type":"string","required":false,"description":"This is the payment amount"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it Retrieves all the data"}],"requestBodyExample":null,"responses":{"200":"GuaranteesReversedResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/guarantees/{guaranteeId}/issuedClaims","fullPath":"/api/v3.0.0/holdings/guarantees/{guaranteeId}/issuedClaims","operationId":"getClaimsPaidUnderGuarantee","name":"Retrieves the list of issued guarantees paid/cancelled for the specified customer/guarantee reference.","summary":"Retrieves paid/cancelled details of issued guarantees","tags":["CORPORATE"],"parameters":[{"name":"guaranteeId","in":"path","type":"string","required":true,"description":""},{"name":"transactionReference","in":"query","type":"string","required":false,"description":"Contains the identifier for the transaction in the core system"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it Retrieves all the data"}],"requestBodyExample":null,"responses":{"200":"ClaimsPaidUnderGuaranteeResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/guarantees/{guaranteeId}/shippings/outstandings","fullPath":"/api/v3.0.0/holdings/guarantees/{guaranteeId}/shippings/outstandings","operationId":"getOutstandingShippingGuarantees","name":"Retrieves the details of outstanding shipping guarantees for the specified customer/guarantee reference.","summary":"Retrieves list of outstanding shipping guarantees","tags":["CORPORATE"],"parameters":[{"name":"guaranteeId","in":"path","type":"string","required":true,"description":""},{"name":"transactionReference","in":"query","type":"string","required":false,"description":"Contains the identifier for the transaction in the core system"},{"name":"lCReference","in":"query","type":"string","required":false,"description":"Indicates the LC reference under which the guarantee is to be opened"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it Retrieves all the data"}],"requestBodyExample":null,"responses":{"200":"OutstandingShippingGuaranteesResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/customers/{customerId}/guarantees/receivedOutstandings","fullPath":"/api/v3.0.0/holdings/customers/{customerId}/guarantees/receivedOutstandings","operationId":"getOutstandingReceivedGuarantees","name":"Retrieves the details of outstanding received guarantees for the specified customer/guarantee reference.","summary":"Retrieves outstanding received guarantees details","tags":["CORPORATE"],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"Identifier of the customer"},{"name":"guaranteeId","in":"query","type":"string","required":false,"description":"Identifier of the guarantee"},{"name":"guaranteeType","in":"query","type":"string","required":false,"description":"Refers to the type of the contract that is being issued."},{"name":"formOfUndertaking","in":"query","type":"string","required":false,"description":"It specifies the form of the independent and irrevocable undertaking. The undertaking cycle is determined based on the value provided here.Possible values are, DGAR \u00c3\u00a2\u00e2\u201a\u00ac\u00e2\u20ac\u0153 The undertaking takes the "},{"name":"principalAmount","in":"query","type":"string","required":false,"description":"Indicates the principal amount of the loan or a deposit"},{"name":"currency","in":"query","type":"string","required":false,"description":"Identifies the currency. E.g. USD, GBP etc"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it Retrieves all the data"}],"requestBodyExample":null,"responses":{"200":"OutstandingReceivedGuaranteesResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"POST","path":"/holdings/guarantee/performanceBonds","fullPath":"/api/v3.0.0/holdings/guarantee/performanceBonds","operationId":"createGuaranteesPerformanceBond","name":"Creates performance bond guarantee for the requested customer reference number","summary":"Creates performance bond guarantee","tags":["CORPORATE"],"parameters":[{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"beneficiaryIds":[{}],"beneficiaryaddresses":[{}],"charges":[{}],"bankAddresses":[{}],"detailsOfGuarantee":[{}],"performanceBondReference":"string","customerId":"string","currency":"string","amount":0.0,"dealDate":"2024-01-01","valueDate":"2024-01-01","expiryDate":"2024-01-01","maturityDate":"2024-01-01","termsAndConditions":"string","eventsProcessing":"string"}},"responses":{"200":"GuaranteesPerformanceBondResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"POST","path":"/holdings/guarantees/letterOfCredits/standBys","fullPath":"/api/v3.0.0/holdings/guarantees/letterOfCredits/standBys","operationId":"createGuaranteesStandbyLC","name":"Creates standby letter of credit guarantee for the requested customer reference number","summary":"Creates standby letter of credit guarantee","tags":["CORPORATE"],"parameters":[{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"beneficiaryIds":[{}],"beneficiaryAddresses":[{}],"charges":[{}],"bankAddresses":[{}],"detailsOfGuarantee":[{}],"standByImportLC":"string","customerId":"string","currency":"string","amount":0.0,"dealDate":"2024-01-01","valueDate":"2024-01-01","expiryDate":"2024-01-01","maturityDate":"2024-01-01","termsAndConditions":"string","eventsProcessing":"string"}},"responses":{"200":"GuaranteesStandbyLCResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"POST","path":"/holdings/guarantees/letterOfCredits/shippings","fullPath":"/api/v3.0.0/holdings/guarantees/letterOfCredits/shippings","operationId":"createShippingGuaranteeUnderLC","name":"Creates shipping guarantees under letter of credit for the requested customer reference number","summary":"Creates shipping guarantees under letter of credit","tags":["CORPORATE"],"parameters":[{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"beneficiaryIds":[{}],"beneficiaryAddresses":[{}],"charges":[{}],"bankAddresses":[{}],"detailsOfGuarantee":[{}],"internalReference":"string","customerId":"string","currency":"string","amount":0.0,"dealDate":"2024-01-01","valueDate":"2024-01-01","maturityDate":"2024-01-01","termsAndConditions":"string","eventsProcessing":"string","autoExpiry":"string"}},"responses":{"200":"ShippingGuaranteeUnderLCResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"POST","path":"/holdings/guarantees/letterOfCredits/shippings/collections","fullPath":"/api/v3.0.0/holdings/guarantees/letterOfCredits/shippings/collections","operationId":"createShippingGuaranteeUnderCollection","name":"Creates shipping guarantee under collection letter of credit for the requested customer reference number","summary":"Creates shipping guarantee under collection letter of credit","tags":["CORPORATE"],"parameters":[{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"beneficiaryId":[{}],"beneficiaryAddresses":[{}],"charges":[{}],"bankAddresses":[{}],"detailsOfGuarantee":[{}],"shippingGuaranteeReference":"string","customerId":"string","currency":"string","amount":0.0,"dealDate":"2024-01-01","valueDate":"2024-01-01","maturityDate":"2024-01-01","termsAndConditions":"string","eventsProcessing":"string","autoExpiry":"string"}},"responses":{"200":"ShippingGuaranteeUnderCollectionResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/holdings/guarantees/{guaranteeId}/receivedClaims","fullPath":"/api/v3.0.0/holdings/guarantees/{guaranteeId}/receivedClaims","operationId":"getInvocationPaidOrCancelled","name":"Retrieves the list of received guarantees paid/cancelled for the specified customer/guarantee reference","summary":"Retrieves paid/cancelled details of received guarantees","tags":["CORPORATE"],"parameters":[{"name":"guaranteeId","in":"path","type":"string","required":true,"description":""},{"name":"transactionReference","in":"query","type":"string","required":false,"description":"Contains the identifier for the transaction in the core system"},{"name":"beneficiary","in":"query","type":"string","required":false,"description":"Beneficiary information"},{"name":"debitAccountId","in":"query","type":"string","required":false,"description":"Indicates the debit account number of the payment or transaction."},{"name":"creditAccountId","in":"query","type":"string","required":false,"description":"Credit account identifier of the payment or transaction"},{"name":"amount","in":"query","type":"string","required":false,"description":"This is the payment amount"},{"name":"debitValueDate","in":"query","type":"string","required":false,"description":"Date on which the amount will be debited for settlement"},{"name":"creditValueDate","in":"query","type":"string","required":false,"description":"Reference quoted by the credit account for a payment"},{"name":"correspondentBank","in":"query","type":"string","required":false,"description":"Correspondent bank, where our nostro account is held."},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it Retrieves all the data"}],"requestBodyExample":null,"responses":{"200":"InvocationPaidOrCancelledResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"POST","path":"/holdings/guarantees/bidBonds","fullPath":"/api/v3.0.0/holdings/guarantees/bidBonds","operationId":"createGuarnteeBidBond","name":"Creates bid bond guarantee for the requested customer reference number","summary":"Creates bid bond guarantee","tags":["CORPORATE"],"parameters":[{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"beneficiaryIds":[{}],"beneficiaryAddresses":[{}],"charges":[{}],"bankAddresses":[{}],"detailsOfGuarantee":[{}],"bidBondReference":"string","customerId":"string","currency":"string","amount":0.0,"dealDate":"2024-01-01","valueDate":"2024-01-01","expiryDate":"2024-01-01","maturityDate":"string","termsAndConditions":"string","eventsProcessing":"string"}},"responses":{"200":"GuarnteeBidBondResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"POST","path":"/holdings/guarantees/{guaranteeId}/rejectedClaims","fullPath":"/api/v3.0.0/holdings/guarantees/{guaranteeId}/rejectedClaims","operationId":"updateGuaranteesRejection","name":"Updates the rejection of claim for the specified guarantee/customer reference number","summary":"Updates the rejection of claim for a guarantee","tags":["CORPORATE"],"parameters":[{"name":"guaranteeId","in":"path","type":"string","required":true,"description":""},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"beneficiaryIds":[{}],"beneficairyAddresses":[{}],"guaranteeReference":"string","guaranteeType":"string","customerId":"string","limitReference":"string","currency":"string","amount":"string","startDate":"string","maturityDate":"string","autoExpiry":"string","onlineMaturity":"string","eventsProcessing":"string","liquidationMode":"string","claimRegisterDate":"string"}},"responses":{"200":"GuaranteesRejectionResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"POST","path":"/holdings/guarantees/{guaranteeId}","fullPath":"/api/v3.0.0/holdings/guarantees/{guaranteeId}","operationId":"updateGuaranteesAmendment","name":"Updates additional guarantee information for the specified  customer/guarantee reference number","summary":"Updates guarantee details","tags":["CORPORATE"],"parameters":[{"name":"guaranteeId","in":"path","type":"string","required":true,"description":""},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"BeneficiaryIds":[{}],"BeneficiaryAddresses":[{}],"pincipalMovements":[{}],"texts":[{}],"guarantees":[{}],"ibClaimNarratives":[{}],"charges":[{}],"bankAddresses":[{}],"detailsOfGuarantee":[{}],"guaranteeReference":"string","customerReference":"string","customerId":"string","guaranteeType":"string","productCategoryId":"string","currency":"string"}},"responses":{"200":"GuaranteesAmendmentResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"POST","path":"/holdings/guarantees/issuances/requests/initiations","fullPath":"/api/v3.0.0/holdings/guarantees/issuances/requests/initiations","operationId":"initiateIssuance","name":"Initiates guarantee issuance request through self service channel for the corporate user","summary":"Initiates new guarantee issuance","tags":["CORPORATE"],"parameters":[{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"guaranteeDetail":[{}],"beneficiaries":[{}],"charges":[{}],"commission":[{}],"undertakingIssued":[{}],"formOfUndertaking":"string","currency":"string","valueDate":"string","expiryType":"string","adviceExpiryDate":"string","applicableRule":"string","advisingBank":"string","marginDebitAccount":"string","guaranteeType":"string","category":"string"}},"responses":{"200":"IssuanceResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/holdings/guarantees/issuances/requests/{requestId}","fullPath":"/api/v3.0.0/holdings/guarantees/issuances/requests/{requestId}","operationId":"updateIssuance","name":"Updates the details of the guarantee request which are mandated for the issuing by the issuing bank","summary":"Facilitates the updation of the Guarantee which is initiated for a customer","tags":["CORPORATE"],"parameters":[{"name":"requestId","in":"path","type":"string","required":true,"description":"The guarantees issuance id initiated by internet banking"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"guaranteeDetail":[{}],"applicantCustomers":[{}],"charges":[{}],"commission":[{}],"commissionType":[{}],"beneficiaryAddresses":[{}],"beneficiaries":[{}],"senderReceiversInfoMT730":[{}],"undertakingIssued":[{}],"counterparty":[{}],"counterpartyBeneficiaries":[{}],"comments":[{}],"guaranteeReference":"string","guaranteeType":"string","advisingBank":"string"}},"responses":{"200":"IssuanceResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"DELETE","path":"/holdings/guarantees/issuances/requests/{requestId}","fullPath":"/api/v3.0.0/holdings/guarantees/issuances/requests/{requestId}","operationId":"reverseIssuance","name":"Reverse the existing guarantee file issued by the issuing bank on behalf of a corporate customer","summary":"Enables the option to reverse the existing guarantee for a customer","tags":["CORPORATE"],"parameters":[{"name":"requestId","in":"path","type":"string","required":true,"description":"The guarantees issuance id initiated by internet banking"},{"name":"payload","in":"body","type":"object","required":false,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}}},"responses":{"200":"IssuanceResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/holdings/guarantees/issuances/requests/{requestId}/rejections","fullPath":"/api/v3.0.0/holdings/guarantees/issuances/requests/{requestId}/rejections","operationId":"rejectClaimIssuance","name":"Reject response of a claim received by the issuing bank to the beneficiary bank","summary":"Captures the values for the the rejection of claim for a guarantee issued","tags":["CORPORATE"],"parameters":[{"name":"requestId","in":"path","type":"string","required":true,"description":"The guarantees issuance id initiated by internet banking"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"beneficiaries":[{}],"beneficiaryAddresses":[{}],"guaranteeDetail":[{}],"internetBankingClaimNarratives":[{}],"narratives":[{}],"senderToReceiverInfos":[{}],"comments":[{}],"guaranteeReference":"string","guaranteeType":"string","maturityDate":"2024-01-01","currency":"string","invocationAmount":0.0,"advisingBank":"string","claimRegisterDate":"2024-01-01","formOfUndertaking":"string"}},"responses":{"200":"ClaimIssuanceResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/holdings/guarantees/issuances/requests/{requestId}/amendments/confirmations","fullPath":"/api/v3.0.0/holdings/guarantees/issuances/requests/{requestId}/amendments/confirmations","operationId":"approveIssuance","name":"Approves  the amendment response  received  from the corporate user  for an received guarantees for a corporate customer","summary":"Enables to capture the approval for the amendment response for the incoming amendments","tags":["CORPORATE"],"parameters":[{"name":"requestId","in":"path","type":"string","required":true,"description":"The guarantees issuance id initiated by internet banking"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"rejectionReasons":[{}],"additionalInformations":[{}],"comments":[{}],"amendmentStatus":"string","amendmentNumber":"string","extensions":{}}},"responses":{"200":"IssuanceResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/holdings/guarantees/issuances/requests","fullPath":"/api/v3.0.0/holdings/guarantees/issuances/requests","operationId":"getIssuance","name":"Retrieves the list of issued guarantees by the issuing bank for any corporate customer","summary":"Enables to retrieve the list of issued guarantees outstanding","tags":["CORPORATE"],"parameters":[{"name":"beneficiary","in":"query","type":"string","required":false,"description":"Beneficiary information"},{"name":"contractType","in":"query","type":"string","required":false,"description":"Indicates if the position is related to Loan, Deposit ,FX-Forward/FX-Swap"},{"name":"guaranteeId","in":"query","type":"string","required":false,"description":"Identifier of the guarantee"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it Retrieves all the data"}],"requestBodyExample":null,"responses":{"200":"IssuanceResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"POST","path":"/holdings/guarantees/issuances/requests","fullPath":"/api/v3.0.0/holdings/guarantees/issuances/requests","operationId":"createIssuance","name":"Initiation of  a guarantee issuance request by the issuing bank for the applicant or the instructing party.","summary":"Facilitates the creation of guarantee issuance for a customer","tags":["CORPORATE"],"parameters":[{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"guaranteeDetail":[{}],"applicantCustomers":[{}],"charges":[{}],"commission":[{}],"commissionType":[{}],"beneficiaryAddresses":[{}],"beneficiaries":[{}],"senderReceiversInfoMT730":[{}],"undertakingIssued":[{}],"counterparty":[{}],"counterpartyBeneficiaries":[{}],"comments":[{}],"guaranteeReference":"string","guaranteeType":"string","advisingBank":"string"}},"responses":{"200":"IssuanceResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/holdings/guarantees/issuances/amendments","fullPath":"/api/v3.0.0/holdings/guarantees/issuances/amendments","operationId":"getAmendmentsIssuance","name":"Retrieves the list of amendments and the details for  an issued guarantee by the issuing bank","summary":"Retrieves the list of amendment history for the issued guarantees for a corporate customer","tags":["CORPORATE"],"parameters":[{"name":"customerId","in":"query","type":"string","required":false,"description":"Identifier of the customer"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it Retrieves all the data"}],"requestBodyExample":null,"responses":{"200":"AmendmentsIssuanceResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"PUT","path":"/holdings/guarantees/issuances/requests/{requestId}/claims","fullPath":"/api/v3.0.0/holdings/guarantees/issuances/requests/{requestId}/claims","operationId":"updateClaimIssuance","name":"Updates the received claim details sent by the beneficiary to the issued guarantee request","summary":"Facilitates in updating the details of a claim for the guarantee issuance","tags":["CORPORATE"],"parameters":[{"name":"requestId","in":"path","type":"string","required":true,"description":"The guarantees issuance id initiated by internet banking"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"senderToReceiverInfoS":[{}],"beneficiaryIdS":[{}],"beneficiaryAddresses":[{}],"applicationIds":[{}],"narratives":[{}],"statementNarratives":[{}],"claimDebitAccount":"string","chargeBearer":"string","claimPaymentMethod":"string","claimCreditAccount":"string","autoExpiry":"string","guaranteeReference":"string","guaranteeType":"string","maturityDate":"string","currency":"string"}},"responses":{"200":"ClaimIssuanceResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/holdings/guarantees/issuances/requests/{requestId}/amendments","fullPath":"/api/v3.0.0/holdings/guarantees/issuances/requests/{requestId}/amendments","operationId":"amendIssuance","name":"Amendment of the terms and conditions of the guarantee after issuance  by the issuing bank and notifying the parties in the guarantee","summary":"Facilitates the updation of  the existing guarantee initiation for a customer","tags":["CORPORATE"],"parameters":[{"name":"requestId","in":"path","type":"string","required":true,"description":"The guarantees issuance id initiated by internet banking"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"guaranteeDetails":[{}],"charges":[{}],"commission":[{}],"amendmentDetail":[{}],"counterparties":[{}],"reimbursingBankReferences":[{}],"newCreditTolerance":"string","newDebitTolerances":"string","externalReference":"string","increaseDecreaseAmount":"string","adviceExpiryDate":"string","comments":"string","extensions":{}}},"responses":{"200":"IssuanceResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/holdings/guarantees/issuances/extensions","fullPath":"/api/v3.0.0/holdings/guarantees/issuances/extensions","operationId":"getAutoExtensionDetails","name":"Retrieves a list of guarantees for which auto extension is enabled","summary":"Retrieves guarantees subject to auto extension","tags":["CORPORATE"],"parameters":[{"name":"guaranteeType","in":"query","type":"string","required":false,"description":"Refers to the type of the contract that is being issued."},{"name":"guaranteeId","in":"query","type":"string","required":false,"description":"Identifier of the guarantee"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it Retrieves all the data"}],"requestBodyExample":null,"responses":{"200":"AutoExtensionDetailsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"PUT","path":"/holdings/guarantees/receipts/requests/{requestId}","fullPath":"/api/v3.0.0/holdings/guarantees/receipts/requests/{requestId}","operationId":"updateStatusOfReceipt","name":"Updates the status for the existing guarantee received field by the issuing bank with the concurrence of the beneficiary","summary":"Facilitates in updating  the status for the existing guarantee received","tags":["CORPORATE"],"parameters":[{"name":"requestId","in":"path","type":"string","required":true,"description":"The guarantees issuance id initiated by internet banking"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"comments":[{}],"guaranteeReference":"string","senderToReceiverInfo":"string","extensions":{}}},"responses":{"200":"StatusOfReceiptResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/holdings/guarantees/receipts/requests","fullPath":"/api/v3.0.0/holdings/guarantees/receipts/requests","operationId":"getReceipts","name":"Retrieves the list of issued guarantee claims that are received for the guarantees issued","summary":"Enables to retrieve the list of received guarantees and outstanding","tags":["CORPORATE"],"parameters":[{"name":"guaranteeId","in":"query","type":"string","required":false,"description":"Identifier of the guarantee"},{"name":"guaranteeReference","in":"query","type":"string","required":false,"description":"Another ID for the transaction for retrieval purposes or it can be used for the bank to use a unique guarantee number rather than the system generated ID"},{"name":"beneficiary","in":"query","type":"string","required":false,"description":"Beneficiary information"},{"name":"claimStatus","in":"query","type":"string","required":false,"description":"Status update of the claim records"},{"name":"guaranteeType","in":"query","type":"string","required":false,"description":"Refers to the type of the contract that is being issued."},{"name":"applicantCustomerId","in":"query","type":"string","required":false,"description":"This field identifies the applicant on whose behalf the Letter of Credit is issued, if the applicant is held on the CUSTOMER file."},{"name":"applicantAddress","in":"query","type":"string","required":false,"description":"It indicates the name and address of the party who is engaged in trade agreement with beneficiary. Although the initial values are defaulted from the Customer file, yet they may be altered with an alt"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it Retrieves all the data"}],"requestBodyExample":null,"responses":{"200":"ReceiptsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/guarantees/receipts/amendments","fullPath":"/api/v3.0.0/holdings/guarantees/receipts/amendments","operationId":"getAmendmentsReceipts","name":"Retrieves the list of amendment history details for the received guarantee file for a corporate customer","summary":"Retrieves the list of amendment history for the received guarantees for a corporate customer","tags":["CORPORATE"],"parameters":[{"name":"beneficiary","in":"query","type":"string","required":true,"description":"Beneficiary information"},{"name":"guaranteeId","in":"query","type":"string","required":false,"description":"Identifier of the guarantee"},{"name":"inwardMessageId","in":"query","type":"string","required":false,"description":"This field holds the inward delivery reference for the corresponding message type."},{"name":"inwardPaymentType","in":"query","type":"string","required":false,"description":"To identify the incoming SWIFT payment received direct from Delivery, payments generated by standing orders and local clearing payments."},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it Retrieves all the data"}],"requestBodyExample":null,"responses":{"200":"AmendmentsReceiptsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"PUT","path":"/holdings/guarantees/receipts/requests/{requestId}/rejections","fullPath":"/api/v3.0.0/holdings/guarantees/receipts/requests/{requestId}/rejections","operationId":"rejectClaimReceipt","name":"Updates the rejection of claim for a guarantee received file from the beneficiary bank","summary":"Facilitates the updation of the rejection of claim for a guarantee received","tags":["CORPORATE"],"parameters":[{"name":"requestId","in":"path","type":"string","required":true,"description":"The guarantees issuance id initiated by internet banking"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"beneficiaries":[{}],"beneficiaryAddresses":[{}],"applicationIds":[{}],"narratives":[{}],"decisionReasons":[{}],"comments":[{}],"guaranteeId":"string","guaranteeType":"string","maturityDate":"2024-01-01","currency":"string","invocationAmount":0.0,"advisingBank":"string","claimRegisterDate":"2024-01-01","formOfUndertaking":"string","adviceExpiryDate":"2024-01-01"}},"responses":{"200":"ClaimReceiptResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/holdings/guarantees/receipts/requests/{requestId}/claims/confirmations","fullPath":"/api/v3.0.0/holdings/guarantees/receipts/requests/{requestId}/claims/confirmations","operationId":"updateClaimReceipt","name":"Updates the response for the claim  initiated to guarantee received by the issuing bank","summary":"Facilitates the updation of  the confirmation of claim for the guarantee received","tags":["CORPORATE"],"parameters":[{"name":"requestId","in":"path","type":"string","required":true,"description":"The guarantees issuance id initiated by internet banking"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"senderToReceiverInfoS":[{}],"beneficiaryIdS":[{}],"beneficiaryAddresses":[{}],"applicationIds":[{}],"narratives":[{}],"statementNarratives":[{}],"claimDebitAccount":"string","chargeBearer":"string","claimPaymentMethod":"string","claimCreditAccount":"string","autoExpiry":"string","guaranteeReference":"string","guaranteeType":"string","maturityDate":"string","currency":"string"}},"responses":{"200":"ClaimReceiptResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/holdings/guarantees/receipts/requests/{requestId}/claims","fullPath":"/api/v3.0.0/holdings/guarantees/receipts/requests/{requestId}/claims","operationId":"createClaimReceipts","name":"Facilitates the creation of claim for the guarantee received","summary":"Creates the claim  initiated to guarantee received by the issuing bank","tags":["CORPORATE"],"parameters":[{"name":"requestId","in":"path","type":"string","required":true,"description":"The guarantees issuance id initiated by internet banking"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"claimDetails":[{}],"chargeDetails":[{}],"comments":[{}],"receivingBank":"string","demandType":"string","requestedExpiryDate":"2024-01-01","statementNarrative":"string","senderToReceiverInfo":"string","additionalInformation":"string","demandStatementCode":"string","newExpiryDate":"2024-01-01","invocationStatus":"string","extensions":{}}},"responses":{"200":"ClaimReceiptsResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/holdings/guarantees/receipts/reimbursements","fullPath":"/api/v3.0.0/holdings/guarantees/receipts/reimbursements","operationId":"getReimbursements","name":"Retrieves the details of guarantee clauses","summary":"Retrieves the guarantee clause details","tags":["CORPORATE"],"parameters":[{"name":"guaranteeId","in":"query","type":"string","required":false,"description":"Identifier of the guarantee"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it Retrieves all the data"}],"requestBodyExample":null,"responses":{"200":"ReimbursementProceesingResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}}]},{"key":"holdings-guarantees-service-v4.0.0","title":"Management of Guarantees","version":"v4.0.0","description":"API to create, update and manage various types of bank issued guarantees and their associated status and details. Some of the types of guarantees that can be created are bid bonds, performance bonds and trade finance shipping guarantees.","endpointCount":55,"endpoints":[{"method":"GET","path":"/holdings/guarantees/clauses/{clauseId}","fullPath":"/api/v4.0.0/holdings/guarantees/clauses/{clauseId}","operationId":"getClause","name":"Retrieves the guarantee clause details of specific id","summary":"Details of guarantee clause","tags":["CORPORATE"],"parameters":[{"name":"clauseId","in":"path","type":"string","required":true,"description":"Represents id of MD.CLAUSES. Id can be used in MD application and description is automatically populated in the deal.Records created for customer specific clauses, to have ID beginning with the custom"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"ClauseResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"POST","path":"/holdings/guarantees/clauses/{clauseId}","fullPath":"/api/v4.0.0/holdings/guarantees/clauses/{clauseId}","operationId":"createClause","name":"Creates the guarantee clause for a specific customer","summary":"Create guarantee clause","tags":["CORPORATE"],"parameters":[{"name":"clauseId","in":"path","type":"string","required":true,"description":"Represents id of MD.CLAUSES. Id can be used in MD application and description is automatically populated in the deal.Records created for customer specific clauses, to have ID beginning with the custom"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"mdClausesDescriptions":[{}],"mdClausesDisplayName":"string","extensions":{}}},"responses":{"200":"ClauseResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/holdings/guarantees/clauses/{clauseId}","fullPath":"/api/v4.0.0/holdings/guarantees/clauses/{clauseId}","operationId":"updateClause","name":"Updates the guarantee clause for the specific id","summary":"Update guarantee clause","tags":["CORPORATE"],"parameters":[{"name":"clauseId","in":"path","type":"string","required":true,"description":"Represents id of MD.CLAUSES. Id can be used in MD application and description is automatically populated in the deal.Records created for customer specific clauses, to have ID beginning with the custom"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"mdClausesDescriptions":[{}],"mdClausesDisplayName":"string","extensions":{}}},"responses":{"200":"ClauseResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"DELETE","path":"/holdings/guarantees/clauses/{clauseId}","fullPath":"/api/v4.0.0/holdings/guarantees/clauses/{clauseId}","operationId":"deleteClause","name":"Removes the guarantee clause request","summary":"Remove guarantee clause","tags":["CORPORATE"],"parameters":[{"name":"clauseId","in":"path","type":"string","required":true,"description":"Represents id of MD.CLAUSES. Id can be used in MD application and description is automatically populated in the deal.Records created for customer specific clauses, to have ID beginning with the custom"},{"name":"payload","in":"body","type":"object","required":false,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}}},"responses":{"200":"ClauseResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/holdings/guarantees/requests","fullPath":"/api/v4.0.0/holdings/guarantees/requests","operationId":"getGuaranteeIssuanceRequests","name":"Retrieves the list of guarantee initiation request details","summary":"Retrieves the guarantee initiation requests","tags":["CORPORATE"],"parameters":[{"name":"mdIbRequestId","in":"query","type":"string","required":false,"description":"The guarantees issuance id initiated by internet banking"},{"name":"customerId","in":"query","type":"string","required":false,"description":"Identifier of the customer"},{"name":"ibEventStatus","in":"query","type":"string","required":false,"description":"Specifies the status of the guarantee issuance request."},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it Retrieves all the data"}],"requestBodyExample":null,"responses":{"200":"GuaranteeIssuanceRequestsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"POST","path":"/holdings/guarantees/requests","fullPath":"/api/v4.0.0/holdings/guarantees/requests","operationId":"createIbRequest","name":"Creates the guarantee initiation request from internet banking","summary":"Create guarantee initiation request","tags":["CORPORATE"],"parameters":[{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"beneficiaryIds":[{}],"guarantees":[{}],"documentDetails":[{}],"limits":[{}],"messageFromBanks":[{}],"messageFromCustomers":[{}],"information":[{}],"amendmentDetails":[{}],"overrides":[{}],"customerId":"string","currencyId":"string","principalAmount":0.0,"startDate":"2024-01-01","maturityDate":"2024-01-01","categoryName":"string"}},"responses":{"200":"IbRequestResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/holdings/guarantees/requests/{requestId}","fullPath":"/api/v4.0.0/holdings/guarantees/requests/{requestId}","operationId":"getIbRequest","name":"Retrieves the guarantee initiation request details for specific id","summary":"Details of guarantee initiation request","tags":["CORPORATE"],"parameters":[{"name":"requestId","in":"path","type":"string","required":true,"description":"The guarantees issuance id initiated by internet banking"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"IbRequestResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/holdings/guarantees/requests/{requestId}","fullPath":"/api/v4.0.0/holdings/guarantees/requests/{requestId}","operationId":"updateIbRequest","name":"Updates the existing guarantee initiation request for a customer","summary":"Update guarantee initiation request","tags":["CORPORATE"],"parameters":[{"name":"requestId","in":"path","type":"string","required":true,"description":"The guarantees issuance id initiated by internet banking"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"beneficiaryIds":[{}],"guarantees":[{}],"documentDetails":[{}],"limits":[{}],"messageFromBanks":[{}],"messageFromCustomers":[{}],"information":[{}],"amendmentDetails":[{}],"overrides":[{}],"customerId":"string","currencyId":"string","principalAmount":0.0,"startDate":"2024-01-01","maturityDate":"2024-01-01","categoryName":"string"}},"responses":{"200":"IbRequestResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"DELETE","path":"/holdings/guarantees/requests/{requestId}","fullPath":"/api/v4.0.0/holdings/guarantees/requests/{requestId}","operationId":"deleteIbRequest","name":"Removes the existing guarantee initiation request","summary":"Remove guarantee initiation request","tags":["CORPORATE"],"parameters":[{"name":"requestId","in":"path","type":"string","required":true,"description":"The guarantees issuance id initiated by internet banking"},{"name":"payload","in":"body","type":"object","required":false,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}}},"responses":{"200":"IbRequestResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/holdings/guarantees/guaranteesApprovals/{requestId}","fullPath":"/api/v4.0.0/holdings/guarantees/guaranteesApprovals/{requestId}","operationId":"approveGuarantee","name":"Approves the guarantee initiation request","summary":"Approve guarantee initiation request","tags":["CORPORATE"],"parameters":[{"name":"requestId","in":"path","type":"string","required":true,"description":"The guarantees issuance id initiated by internet banking"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"GuaranteeResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"DELETE","path":"/holdings/guarantees/cancellations/{requestId}","fullPath":"/api/v4.0.0/holdings/guarantees/cancellations/{requestId}","operationId":"rejectGuarantee","name":"Reject the guarantee initiation request","summary":"Reject guarantee initiation request","tags":["CORPORATE"],"parameters":[{"name":"requestId","in":"path","type":"string","required":true,"description":"The guarantees issuance id initiated by internet banking"},{"name":"payload","in":"body","type":"object","required":false,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}}},"responses":{"200":"GuaranteeResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/holdings/guarantees/{guaranteeId}/receivedGuarantees","fullPath":"/api/v4.0.0/holdings/guarantees/{guaranteeId}/receivedGuarantees","operationId":"getReceivedGuaranteeHistory","name":"Retrieves the received guarantee requests for the customer ","summary":"Retrieves received guarantee requests","tags":["CORPORATE"],"parameters":[{"name":"guaranteeId","in":"path","type":"string","required":true,"description":"Identifier of the guarantee"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it Retrieves all the data"}],"requestBodyExample":null,"responses":{"200":"ReceivedGuaranteeHistoryResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/guarantees/clauses","fullPath":"/api/v4.0.0/holdings/guarantees/clauses","operationId":"getGuaranteeClauses","name":"Retrieves the list of guarantee clause requests for specific customer","summary":"Retrieves the guarantee clause requests","tags":["CORPORATE"],"parameters":[{"name":"clauseId","in":"query","type":"string","required":false,"description":"Represents id of MD.CLAUSES. Id can be used in MD application and description is automatically populated in the deal.Records created for customer specific clauses, to have ID beginning with the custom"},{"name":"customerId","in":"query","type":"string","required":false,"description":"Identifier of the customer"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it Retrieves all the data"}],"requestBodyExample":null,"responses":{"200":"GuaranteeClausesResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/guarantees/receivedGuarantees/amendments","fullPath":"/api/v4.0.0/holdings/guarantees/receivedGuarantees/amendments","operationId":"getReceivedGuaranteesAmendments","name":"Retrieves the list of amended guarantee requests","summary":"Retrieves the amended guarantee requests","tags":["CORPORATE"],"parameters":[{"name":"alternateId","in":"query","type":"string","required":false,"description":"An Alternate Identification for the Deal. This can be used to retrieve the Deal for amendment."},{"name":"contractType","in":"query","type":"string","required":false,"description":"Indicates if the position is related to Loan, Deposit ,FX-Forward/FX-Swap"},{"name":"customerId","in":"query","type":"string","required":false,"description":"Identifier of the customer"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it Retrieves all the data"}],"requestBodyExample":null,"responses":{"200":"ReceivedGuaranteesAmendmentsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/guarantees/{guaranteeId}/invocations","fullPath":"/api/v4.0.0/holdings/guarantees/{guaranteeId}/invocations","operationId":"getClaimInvocationHistory","name":"Retrieves the list of guarantee claim invocation details","summary":"Retrieves the guarantee claim invocation details","tags":["CORPORATE"],"parameters":[{"name":"guaranteeId","in":"path","type":"string","required":true,"description":"Identifier of the guarantee"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it Retrieves all the data"}],"requestBodyExample":null,"responses":{"200":"ClaimInvocationHistoryResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/guarantees/receivedClaims","fullPath":"/api/v4.0.0/holdings/guarantees/receivedClaims","operationId":"getReceivedGuaranteeClaims","name":"Retrieves the list of received guarantee claim for a customer","summary":"Retrieves the received guarantee claims","tags":["CORPORATE"],"parameters":[{"name":"customerId","in":"query","type":"string","required":false,"description":"Identifier of the customer"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it Retrieves all the data"}],"requestBodyExample":null,"responses":{"200":"ReceivedGuaranteeClaimsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/guarantees/amendments","fullPath":"/api/v4.0.0/holdings/guarantees/amendments","operationId":"getGuaranteeAmendments","name":"Retrieves the list of amended guarantee requests for specific customer","summary":"Retrieves guarantee amendment requests","tags":["CORPORATE"],"parameters":[{"name":"customerId","in":"query","type":"string","required":false,"description":"Identifier of the customer"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it Retrieves all the data"}],"requestBodyExample":null,"responses":{"200":"GuaranteeAmendmentsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/guarantees/issuedGuarantees","fullPath":"/api/v4.0.0/holdings/guarantees/issuedGuarantees","operationId":"getIssuedGuarantees","name":"Retrieves the list of issued guarantee request details for specific customer","summary":"Retrieves the issued guarantee details","tags":["CORPORATE"],"parameters":[{"name":"customerId","in":"query","type":"string","required":false,"description":"Identifier of the customer"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it Retrieves all the data"}],"requestBodyExample":null,"responses":{"200":"IssuedGuaranteesResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/guarantees/limits","fullPath":"/api/v4.0.0/holdings/guarantees/limits","operationId":"getGuaranteeLimits","name":"Retrieves the list of guarantees limit details","summary":"Retrieves the guarantee limits","tags":["CORPORATE"],"parameters":[{"name":"customerId","in":"query","type":"string","required":false,"description":"Identifier of the customer"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it Retrieves all the data"}],"requestBodyExample":null,"responses":{"200":"GuaranteeLimitsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/guarantees/issuedClaims","fullPath":"/api/v4.0.0/holdings/guarantees/issuedClaims","operationId":"getIssuedGuaranteeClaims","name":"Retrieves the list of received guarantee claim details","summary":"Retrieves the received guarantee claims","tags":["CORPORATE"],"parameters":[{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it Retrieves all the data"}],"requestBodyExample":null,"responses":{"200":"IssuedGuaranteeClaimsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/guarantees","fullPath":"/api/v4.0.0/holdings/guarantees","operationId":"getGuarantees","name":"Retrieves the list of guarantee details","summary":"Retrieves the guarantee details","tags":["CORPORATE"],"parameters":[{"name":"guaranteeId","in":"query","type":"string","required":false,"description":"Identifier of the guarantee"},{"name":"beneficiaryCustomerId","in":"query","type":"string","required":false,"description":"Identifies the Customer who is to be the ultimate receiver of the funds transferred by the sending bank when this Beneficiary is not a bank."},{"name":"contractType","in":"query","type":"string","required":false,"description":"Indicates if the position is related to Loan, Deposit ,FX-Forward/FX-Swap"},{"name":"ibRequestId","in":"query","type":"string","required":false,"description":"The guarantees issuance id initiated by internet banking"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it Retrieves all the data"}],"requestBodyExample":null,"responses":{"200":"GuaranteesResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"POST","path":"/holdings/guarantees","fullPath":"/api/v4.0.0/holdings/guarantees","operationId":"createGuaranteeGeneric","name":"Creates a generic guarantee for the requested customer reference number","summary":"Creates a generic guarantee","tags":["CORPORATE"],"parameters":[{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"beneficiaryIds":[{}],"beneficiaryAddresses":[{}],"charges":[{}],"bankAddresses":[{}],"detailsOfGuarantee":[{}],"guaranteeReference":"string","customerId":"string","currency":"string","amount":0.0,"dealDate":"2024-01-01","startDate":"2024-01-01","expiryDate":"2024-01-01","maturityDate":"2024-01-01","limitReference":"string","termsAndConditions":"string"}},"responses":{"200":"GuaranteeGenericResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/holdings/customers/{customerId}/guarantees/outstandings","fullPath":"/api/v4.0.0/holdings/customers/{customerId}/guarantees/outstandings","operationId":"getGuaranteesOutstandings","name":"Retrieves the detailed information on issued guarantees for the specified customer/guarantee reference","summary":"Retrieves outstanding guarantees","tags":["CORPORATE"],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"Identifier of the customer"},{"name":"transactionReference","in":"query","type":"string","required":false,"description":"Contains the identifier for the transaction in the core system"},{"name":"guaranteeType","in":"query","type":"string","required":false,"description":"Refers to the type of the contract that is being issued."},{"name":"currency","in":"query","type":"string","required":false,"description":"Identifies the currency. E.g. USD, GBP etc"},{"name":"amount","in":"query","type":"string","required":false,"description":"This is the payment amount"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it Retrieves all the data"}],"requestBodyExample":null,"responses":{"200":"GuaranteesOutstandingsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/customers/{customerId}/guarantees/expiries","fullPath":"/api/v4.0.0/holdings/customers/{customerId}/guarantees/expiries","operationId":"getGuaranteeExpiringWithDate","name":"Retrieves the expiring guarantees details for the specified customer/guarantee reference ","summary":"Retrieves expiring guarantees","tags":["CORPORATE"],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"Identifier of the customer"},{"name":"transactionReference","in":"query","type":"string","required":false,"description":"Contains the identifier for the transaction in the core system"},{"name":"currency","in":"query","type":"string","required":false,"description":"Identifies the currency. E.g. USD, GBP etc"},{"name":"amount","in":"query","type":"string","required":false,"description":"This is the payment amount"},{"name":"maturityDate","in":"query","type":"string","required":false,"description":"Indicates maturity date of the contract"},{"name":"gteeReturnDate","in":"query","type":"string","required":false,"description":"Date on which the original Guarantee will be returned by the customer to the Bank that issued it"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it Retrieves all the data"}],"requestBodyExample":null,"responses":{"200":"GuaranteeExpiringWithDateResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/customers/{customerId}/guarantees/outstandingClaims","fullPath":"/api/v4.0.0/holdings/customers/{customerId}/guarantees/outstandingClaims","operationId":"getClaimOutstandingUnderGuarantees","name":"Retrieves the list of corporate miscellaneous deals for the customer.","summary":"Retrieves outstanding guarantee claims","tags":["CORPORATE"],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"Identifier of the customer"},{"name":"transactionReference","in":"query","type":"string","required":false,"description":"Contains the identifier for the transaction in the core system"},{"name":"currency","in":"query","type":"string","required":false,"description":"Identifies the currency. E.g. USD, GBP etc"},{"name":"amount","in":"query","type":"string","required":false,"description":"This is the payment amount"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it Retrieves all the data"}],"requestBodyExample":null,"responses":{"200":"ClaimOutstandingUnderGuaranteesResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/customers/{customerId}/guarantees/cancellations","fullPath":"/api/v4.0.0/holdings/customers/{customerId}/guarantees/cancellations","operationId":"getGuaranteesReversed","name":"Retrieves the list of cancelled guarantees for the specified customer/guarantee reference","summary":"Retrieves list of cancelled guarantees","tags":["CORPORATE"],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"Identifier of the customer"},{"name":"transactionReference","in":"query","type":"string","required":false,"description":"Contains the identifier for the transaction in the core system"},{"name":"guaranteeType","in":"query","type":"string","required":false,"description":"Refers to the type of the contract that is being issued."},{"name":"currency","in":"query","type":"string","required":false,"description":"Identifies the currency. E.g. USD, GBP etc"},{"name":"amount","in":"query","type":"string","required":false,"description":"This is the payment amount"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it Retrieves all the data"}],"requestBodyExample":null,"responses":{"200":"GuaranteesReversedResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/guarantees/{guaranteeId}/issuedClaims","fullPath":"/api/v4.0.0/holdings/guarantees/{guaranteeId}/issuedClaims","operationId":"getClaimsPaidUnderGuarantee","name":"Retrieves the list of issued guarantees paid/cancelled for the specified customer/guarantee reference.","summary":"Retrieves paid/cancelled details of issued guarantees","tags":["CORPORATE"],"parameters":[{"name":"guaranteeId","in":"path","type":"string","required":true,"description":""},{"name":"transactionReference","in":"query","type":"string","required":false,"description":"Contains the identifier for the transaction in the core system"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it Retrieves all the data"}],"requestBodyExample":null,"responses":{"200":"ClaimsPaidUnderGuaranteeResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/guarantees/{guaranteeId}/shippings/outstandings","fullPath":"/api/v4.0.0/holdings/guarantees/{guaranteeId}/shippings/outstandings","operationId":"getOutstandingShippingGuarantees","name":"Retrieves the details of outstanding shipping guarantees for the specified customer/guarantee reference.","summary":"Retrieves list of outstanding shipping guarantees","tags":["CORPORATE"],"parameters":[{"name":"guaranteeId","in":"path","type":"string","required":true,"description":""},{"name":"transactionReference","in":"query","type":"string","required":false,"description":"Contains the identifier for the transaction in the core system"},{"name":"lCReference","in":"query","type":"string","required":false,"description":"Indicates the LC reference under which the guarantee is to be opened"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it Retrieves all the data"}],"requestBodyExample":null,"responses":{"200":"OutstandingShippingGuaranteesResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/customers/{customerId}/guarantees/receivedOutstandings","fullPath":"/api/v4.0.0/holdings/customers/{customerId}/guarantees/receivedOutstandings","operationId":"getOutstandingReceivedGuarantees","name":"Retrieves the details of outstanding received guarantees for the specified customer/guarantee reference.","summary":"Retrieves outstanding received guarantees details","tags":["CORPORATE"],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"Identifier of the customer"},{"name":"guaranteeId","in":"query","type":"string","required":false,"description":"Identifier of the guarantee"},{"name":"guaranteeType","in":"query","type":"string","required":false,"description":"Refers to the type of the contract that is being issued."},{"name":"formOfUndertaking","in":"query","type":"string","required":false,"description":"It specifies the form of the independent and irrevocable undertaking. The undertaking cycle is determined based on the value provided here.Possible values are, DGAR \u00e2\u20ac\u201c The undertaking takes the form "},{"name":"principalAmount","in":"query","type":"string","required":false,"description":"Indicates the principal amount of the loan or a deposit"},{"name":"currency","in":"query","type":"string","required":false,"description":"Identifies the currency. E.g. USD, GBP etc"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it Retrieves all the data"}],"requestBodyExample":null,"responses":{"200":"OutstandingReceivedGuaranteesResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"POST","path":"/holdings/guarantee/performanceBonds","fullPath":"/api/v4.0.0/holdings/guarantee/performanceBonds","operationId":"createGuaranteesPerformanceBond","name":"Creates performance bond guarantee for the requested customer reference number","summary":"Creates performance bond guarantee","tags":["CORPORATE"],"parameters":[{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"beneficiaryIds":[{}],"beneficiaryaddresses":[{}],"charges":[{}],"bankAddresses":[{}],"detailsOfGuarantee":[{}],"performanceBondReference":"string","customerId":"string","currency":"string","amount":0.0,"dealDate":"2024-01-01","valueDate":"2024-01-01","expiryDate":"2024-01-01","maturityDate":"2024-01-01","termsAndConditions":"string","eventsProcessing":"string"}},"responses":{"200":"GuaranteesPerformanceBondResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"POST","path":"/holdings/guarantees/letterOfCredits/standBys","fullPath":"/api/v4.0.0/holdings/guarantees/letterOfCredits/standBys","operationId":"createGuaranteesStandbyLC","name":"Creates standby letter of credit guarantee for the requested customer reference number","summary":"Creates standby letter of credit guarantee","tags":["CORPORATE"],"parameters":[{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"beneficiaryIds":[{}],"beneficiaryAddresses":[{}],"charges":[{}],"bankAddresses":[{}],"detailsOfGuarantee":[{}],"standByImportLC":"string","customerId":"string","currency":"string","amount":0.0,"dealDate":"2024-01-01","valueDate":"2024-01-01","expiryDate":"2024-01-01","maturityDate":"2024-01-01","termsAndConditions":"string","eventsProcessing":"string"}},"responses":{"200":"GuaranteesStandbyLCResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"POST","path":"/holdings/guarantees/letterOfCredits/shippings","fullPath":"/api/v4.0.0/holdings/guarantees/letterOfCredits/shippings","operationId":"createShippingGuaranteeUnderLC","name":"Creates shipping guarantees under letter of credit for the requested customer reference number","summary":"Creates shipping guarantees under letter of credit","tags":["CORPORATE"],"parameters":[{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"beneficiaryIds":[{}],"beneficiaryAddresses":[{}],"charges":[{}],"bankAddresses":[{}],"detailsOfGuarantee":[{}],"internalReference":"string","customerId":"string","currency":"string","amount":0.0,"dealDate":"2024-01-01","valueDate":"2024-01-01","maturityDate":"2024-01-01","termsAndConditions":"string","eventsProcessing":"string","autoExpiry":"string"}},"responses":{"200":"ShippingGuaranteeUnderLCResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"POST","path":"/holdings/guarantees/letterOfCredits/shippings/collections","fullPath":"/api/v4.0.0/holdings/guarantees/letterOfCredits/shippings/collections","operationId":"createShippingGuaranteeUnderCollection","name":"Creates shipping guarantee under collection letter of credit for the requested customer reference number","summary":"Creates shipping guarantee under collection letter of credit","tags":["CORPORATE"],"parameters":[{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"beneficiaryId":[{}],"beneficiaryAddresses":[{}],"charges":[{}],"bankAddresses":[{}],"detailsOfGuarantee":[{}],"shippingGuaranteeReference":"string","customerId":"string","currency":"string","amount":0.0,"dealDate":"2024-01-01","valueDate":"2024-01-01","maturityDate":"2024-01-01","termsAndConditions":"string","eventsProcessing":"string","autoExpiry":"string"}},"responses":{"200":"ShippingGuaranteeUnderCollectionResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/holdings/guarantees/{guaranteeId}/receivedClaims","fullPath":"/api/v4.0.0/holdings/guarantees/{guaranteeId}/receivedClaims","operationId":"getInvocationPaidOrCancelled","name":"Retrieves the list of received guarantees paid/cancelled for the specified customer/guarantee reference","summary":"Retrieves paid/cancelled details of received guarantees","tags":["CORPORATE"],"parameters":[{"name":"guaranteeId","in":"path","type":"string","required":true,"description":""},{"name":"transactionReference","in":"query","type":"string","required":false,"description":"Contains the identifier for the transaction in the core system"},{"name":"beneficiary","in":"query","type":"string","required":false,"description":"Beneficiary information"},{"name":"debitAccountId","in":"query","type":"string","required":false,"description":"Indicates the debit account number of the payment or transaction."},{"name":"creditAccountId","in":"query","type":"string","required":false,"description":"Credit account identifier of the payment or transaction"},{"name":"amount","in":"query","type":"string","required":false,"description":"This is the payment amount"},{"name":"debitValueDate","in":"query","type":"string","required":false,"description":"Date on which the amount will be debited for settlement"},{"name":"creditValueDate","in":"query","type":"string","required":false,"description":"Reference quoted by the credit account for a payment"},{"name":"correspondentBank","in":"query","type":"string","required":false,"description":"Correspondent bank, where our nostro account is held."},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it Retrieves all the data"}],"requestBodyExample":null,"responses":{"200":"InvocationPaidOrCancelledResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"POST","path":"/holdings/guarantees/bidBonds","fullPath":"/api/v4.0.0/holdings/guarantees/bidBonds","operationId":"createGuarnteeBidBond","name":"Creates bid bond guarantee for the requested customer reference number","summary":"Creates bid bond guarantee","tags":["CORPORATE"],"parameters":[{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"beneficiaryIds":[{}],"beneficiaryAddresses":[{}],"charges":[{}],"bankAddresses":[{}],"detailsOfGuarantee":[{}],"bidBondReference":"string","customerId":"string","currency":"string","amount":0.0,"dealDate":"2024-01-01","valueDate":"2024-01-01","expiryDate":"2024-01-01","maturityDate":"string","termsAndConditions":"string","eventsProcessing":"string"}},"responses":{"200":"GuarnteeBidBondResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"POST","path":"/holdings/guarantees/{guaranteeId}/rejectedClaims","fullPath":"/api/v4.0.0/holdings/guarantees/{guaranteeId}/rejectedClaims","operationId":"updateGuaranteesRejection","name":"Updates the rejection of claim for the specified guarantee/customer reference number","summary":"Updates the rejection of claim for a guarantee","tags":["CORPORATE"],"parameters":[{"name":"guaranteeId","in":"path","type":"string","required":true,"description":""},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"beneficiaryIds":[{}],"beneficairyAddresses":[{}],"guaranteeReference":"string","guaranteeType":"string","customerId":"string","limitReference":"string","currency":"string","amount":"string","startDate":"string","maturityDate":"string","autoExpiry":"string","onlineMaturity":"string","eventsProcessing":"string","liquidationMode":"string","claimRegisterDate":"string"}},"responses":{"200":"GuaranteesRejectionResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"POST","path":"/holdings/guarantees/{guaranteeId}","fullPath":"/api/v4.0.0/holdings/guarantees/{guaranteeId}","operationId":"updateGuaranteesAmendment","name":"Updates additional guarantee information for the specified  customer/guarantee reference number","summary":"Updates guarantee details","tags":["CORPORATE"],"parameters":[{"name":"guaranteeId","in":"path","type":"string","required":true,"description":""},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"BeneficiaryIds":[{}],"BeneficiaryAddresses":[{}],"pincipalMovements":[{}],"texts":[{}],"guarantees":[{}],"ibClaimNarratives":[{}],"charges":[{}],"bankAddresses":[{}],"detailsOfGuarantee":[{}],"guaranteeReference":"string","customerReference":"string","customerId":"string","guaranteeType":"string","productCategoryId":"string","currency":"string"}},"responses":{"200":"GuaranteesAmendmentResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"POST","path":"/holdings/guarantees/issuances/requests/initiations","fullPath":"/api/v4.0.0/holdings/guarantees/issuances/requests/initiations","operationId":"initiateIssuance","name":"Initiates guarantee issuance request through self service channel for the corporate user","summary":"Initiates new guarantee issuance","tags":["CORPORATE"],"parameters":[{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"guaranteeDetail":[{}],"beneficiaries":[{}],"charges":[{}],"commission":[{}],"undertakingIssued":[{}],"formOfUndertaking":"string","currency":"string","valueDate":"string","expiryType":"string","adviceExpiryDate":"string","applicableRule":"string","advisingBank":"string","marginDebitAccount":"string","guaranteeType":"string","category":"string"}},"responses":{"200":"IssuanceResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/holdings/guarantees/issuances/requests/{requestId}","fullPath":"/api/v4.0.0/holdings/guarantees/issuances/requests/{requestId}","operationId":"updateIssuance","name":"Updates the details of the guarantee request which are mandated for the issuing by the issuing bank","summary":"Facilitates the updation of the Guarantee which is initiated for a customer","tags":["CORPORATE"],"parameters":[{"name":"requestId","in":"path","type":"string","required":true,"description":"The guarantees issuance id initiated by internet banking"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"guaranteeDetail":[{}],"applicantCustomers":[{}],"charges":[{}],"commission":[{}],"commissionType":[{}],"beneficiaryAddresses":[{}],"beneficiaries":[{}],"senderReceiversInfoMT730":[{}],"undertakingIssued":[{}],"counterparty":[{}],"counterpartyBeneficiaries":[{}],"comments":[{}],"guaranteeReference":"string","guaranteeType":"string","advisingBank":"string"}},"responses":{"200":"IssuanceResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"DELETE","path":"/holdings/guarantees/issuances/requests/{requestId}","fullPath":"/api/v4.0.0/holdings/guarantees/issuances/requests/{requestId}","operationId":"reverseIssuance","name":"Reverse the existing guarantee file issued by the issuing bank on behalf of a corporate customer","summary":"Enables the option to reverse the existing guarantee for a customer","tags":["CORPORATE"],"parameters":[{"name":"requestId","in":"path","type":"string","required":true,"description":"The guarantees issuance id initiated by internet banking"},{"name":"payload","in":"body","type":"object","required":false,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}}},"responses":{"200":"IssuanceResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/holdings/guarantees/issuances/requests/{requestId}/rejections","fullPath":"/api/v4.0.0/holdings/guarantees/issuances/requests/{requestId}/rejections","operationId":"rejectClaimIssuance","name":"Reject response of a claim received by the issuing bank to the beneficiary bank","summary":"Captures the values for the the rejection of claim for a guarantee issued","tags":["CORPORATE"],"parameters":[{"name":"requestId","in":"path","type":"string","required":true,"description":"The guarantees issuance id initiated by internet banking"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"beneficiaries":[{}],"beneficiaryAddresses":[{}],"guaranteeDetail":[{}],"internetBankingClaimNarratives":[{}],"narratives":[{}],"senderToReceiverInfos":[{}],"comments":[{}],"guaranteeReference":"string","guaranteeType":"string","maturityDate":"2024-01-01","currency":"string","invocationAmount":0.0,"advisingBank":"string","claimRegisterDate":"2024-01-01","formOfUndertaking":"string"}},"responses":{"200":"ClaimIssuanceResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/holdings/guarantees/issuances/requests/{requestId}/amendments/confirmations","fullPath":"/api/v4.0.0/holdings/guarantees/issuances/requests/{requestId}/amendments/confirmations","operationId":"approveIssuance","name":"Approves  the amendment response received from the corporate user for the received guarantees for a corporate customer","summary":"Enables to capture the approval for the amendment response for the incoming amendments","tags":["CORPORATE"],"parameters":[{"name":"requestId","in":"path","type":"string","required":true,"description":"The guarantees issuance id initiated by internet banking"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"rejectionReasons":[{}],"additionalInformations":[{}],"comments":[{}],"amendmentStatus":"string","amendmentNumber":"string","extensions":{}}},"responses":{"200":"IssuanceResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/holdings/guarantees/issuances/requests","fullPath":"/api/v4.0.0/holdings/guarantees/issuances/requests","operationId":"getIssuance","name":"Retrieves the list of issued guarantees by the issuing bank for any corporate customer","summary":"Enables to retrieve the list of issued guarantees outstanding","tags":["CORPORATE"],"parameters":[{"name":"beneficiary","in":"query","type":"string","required":false,"description":"Beneficiary information"},{"name":"contractType","in":"query","type":"string","required":false,"description":"Indicates if the position is related to Loan, Deposit ,FX-Forward/FX-Swap"},{"name":"guaranteeId","in":"query","type":"string","required":false,"description":"Identifier of the guarantee"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it Retrieves all the data"}],"requestBodyExample":null,"responses":{"200":"IssuanceResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"POST","path":"/holdings/guarantees/issuances/requests","fullPath":"/api/v4.0.0/holdings/guarantees/issuances/requests","operationId":"createIssuance","name":"Initiation of  a guarantee issuance request by the issuing bank for the applicant or the instructing party.","summary":"Facilitates the creation of guarantee issuance for a customer","tags":["CORPORATE"],"parameters":[{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"guaranteeDetail":[{}],"applicantCustomers":[{}],"charges":[{}],"commission":[{}],"commissionType":[{}],"beneficiaryAddresses":[{}],"beneficiaries":[{}],"senderReceiversInfoMT730":[{}],"undertakingIssued":[{}],"counterparty":[{}],"counterpartyBeneficiaries":[{}],"comments":[{}],"guaranteeReference":"string","guaranteeType":"string","advisingBank":"string"}},"responses":{"200":"IssuanceResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/holdings/guarantees/issuances/amendments","fullPath":"/api/v4.0.0/holdings/guarantees/issuances/amendments","operationId":"getAmendmentsIssuance","name":"Retrieves the list of amendments and the details for  an issued guarantee by the issuing bank","summary":"Retrieves the list of amendment history for the issued guarantees for a corporate customer","tags":["CORPORATE"],"parameters":[{"name":"customerId","in":"query","type":"string","required":false,"description":"Identifier of the customer"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it Retrieves all the data"}],"requestBodyExample":null,"responses":{"200":"AmendmentsIssuanceResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"PUT","path":"/holdings/guarantees/issuances/requests/{requestId}/claims","fullPath":"/api/v4.0.0/holdings/guarantees/issuances/requests/{requestId}/claims","operationId":"updateClaimIssuance","name":"Updates the received claim details sent by the beneficiary to the issued guarantee request","summary":"Facilitates in updating the details of a claim for the guarantee issuance","tags":["CORPORATE"],"parameters":[{"name":"requestId","in":"path","type":"string","required":true,"description":"The guarantees issuance id initiated by internet banking"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"senderToReceiverInfoS":[{}],"beneficiaryIdS":[{}],"beneficiaryAddresses":[{}],"applicationIds":[{}],"narratives":[{}],"statementNarratives":[{}],"claimDebitAccount":"string","chargeBearer":"string","claimPaymentMethod":"string","claimCreditAccount":"string","autoExpiry":"string","guaranteeReference":"string","guaranteeType":"string","maturityDate":"string","currency":"string"}},"responses":{"200":"ClaimIssuanceResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/holdings/guarantees/issuances/requests/{requestId}/amendments","fullPath":"/api/v4.0.0/holdings/guarantees/issuances/requests/{requestId}/amendments","operationId":"amendIssuance","name":"Amendment of the terms and conditions of the guarantee after issuance by the issuing bank and notifying the parties in the guarantee","summary":"Facilitates the updation of  the existing guarantee initiation for a customer","tags":["CORPORATE"],"parameters":[{"name":"requestId","in":"path","type":"string","required":true,"description":"The guarantees issuance id initiated by internet banking"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"guaranteeDetails":[{}],"charges":[{}],"commission":[{}],"amendmentDetail":[{}],"counterparties":[{}],"reimbursingBankReferences":[{}],"newCreditTolerance":"string","newDebitTolerances":"string","externalReference":"string","increaseDecreaseAmount":"string","adviceExpiryDate":"string","comments":"string","extensions":{}}},"responses":{"200":"IssuanceResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/holdings/guarantees/issuances/extensions","fullPath":"/api/v4.0.0/holdings/guarantees/issuances/extensions","operationId":"getAutoExtensionDetails","name":"Retrieves a list of guarantees for which auto extension is enabled","summary":"Retrieves guarantees subject to auto extension","tags":["CORPORATE"],"parameters":[{"name":"guaranteeType","in":"query","type":"string","required":false,"description":"Refers to the type of the contract that is being issued."},{"name":"guaranteeId","in":"query","type":"string","required":false,"description":"Identifier of the guarantee"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it Retrieves all the data"}],"requestBodyExample":null,"responses":{"200":"AutoExtensionDetailsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"PUT","path":"/holdings/guarantees/receipts/requests/{requestId}","fullPath":"/api/v4.0.0/holdings/guarantees/receipts/requests/{requestId}","operationId":"updateStatusOfReceipt","name":"Updates the status for the existing guarantee received field by the issuing bank with the concurrence of the beneficiary","summary":"Facilitates in updating  the status for the existing guarantee received","tags":["CORPORATE"],"parameters":[{"name":"requestId","in":"path","type":"string","required":true,"description":"The guarantees issuance id initiated by internet banking"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"comments":[{}],"guaranteeReference":"string","senderToReceiverInfo":"string","extensions":{}}},"responses":{"200":"StatusOfReceiptResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/holdings/guarantees/receipts/requests","fullPath":"/api/v4.0.0/holdings/guarantees/receipts/requests","operationId":"getReceipts","name":"Retrieves the list of issued guarantee claims that are received for the guarantees issued","summary":"Enables to retrieve the list of received guarantees and outstanding","tags":["CORPORATE"],"parameters":[{"name":"guaranteeId","in":"query","type":"string","required":false,"description":"Identifier of the guarantee"},{"name":"guaranteeReference","in":"query","type":"string","required":false,"description":"Another ID for the transaction for retrieval purposes or it can be used for the bank to use a unique guarantee number rather than the system generated ID"},{"name":"beneficiary","in":"query","type":"string","required":false,"description":"Beneficiary information"},{"name":"claimStatus","in":"query","type":"string","required":false,"description":"Status update of the claim records"},{"name":"guaranteeType","in":"query","type":"string","required":false,"description":"Refers to the type of the contract that is being issued."},{"name":"applicantCustomerId","in":"query","type":"string","required":false,"description":"This field identifies the applicant on whose behalf the Letter of Credit is issued, if the applicant is held on the CUSTOMER file."},{"name":"applicantAddress","in":"query","type":"string","required":false,"description":"It indicates the name and address of the party who is engaged in trade agreement with beneficiary. Although the initial values are defaulted from the Customer file, yet they may be altered with an alt"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it Retrieves all the data"}],"requestBodyExample":null,"responses":{"200":"ReceiptsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/guarantees/receipts/amendments","fullPath":"/api/v4.0.0/holdings/guarantees/receipts/amendments","operationId":"getAmendmentsReceipts","name":"Retrieves the list of amendment history details for the received guarantee file for a corporate customer","summary":"Retrieves the list of amendment history for the received guarantees for a corporate customer","tags":["CORPORATE"],"parameters":[{"name":"beneficiary","in":"query","type":"string","required":true,"description":"Beneficiary information"},{"name":"guaranteeId","in":"query","type":"string","required":false,"description":"Identifier of the guarantee"},{"name":"inwardMessageId","in":"query","type":"string","required":false,"description":"This field holds the inward delivery reference for the corresponding message type."},{"name":"inwardPaymentType","in":"query","type":"string","required":false,"description":"To identify the incoming SWIFT payment received direct from Delivery, payments generated by standing orders and local clearing payments."},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it Retrieves all the data"}],"requestBodyExample":null,"responses":{"200":"AmendmentsReceiptsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"PUT","path":"/holdings/guarantees/receipts/requests/{requestId}/rejections","fullPath":"/api/v4.0.0/holdings/guarantees/receipts/requests/{requestId}/rejections","operationId":"rejectClaimReceipt","name":"Updates the rejection of claim for a guarantee received file from the beneficiary bank","summary":"Facilitates the updation of the rejection of claim for a guarantee received","tags":["CORPORATE"],"parameters":[{"name":"requestId","in":"path","type":"string","required":true,"description":"The guarantees issuance id initiated by internet banking"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"beneficiaries":[{}],"beneficiaryAddresses":[{}],"applicationIds":[{}],"narratives":[{}],"decisionReasons":[{}],"comments":[{}],"guaranteeId":"string","guaranteeType":"string","maturityDate":"2024-01-01","currency":"string","invocationAmount":0.0,"advisingBank":"string","claimRegisterDate":"2024-01-01","formOfUndertaking":"string","adviceExpiryDate":"2024-01-01"}},"responses":{"200":"ClaimReceiptResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/holdings/guarantees/receipts/requests/{requestId}/claims/confirmations","fullPath":"/api/v4.0.0/holdings/guarantees/receipts/requests/{requestId}/claims/confirmations","operationId":"updateClaimReceipt","name":"Updates the response for the claim  initiated to guarantee received by the issuing bank","summary":"Facilitates the updation of  the confirmation of claim for the guarantee received","tags":["CORPORATE"],"parameters":[{"name":"requestId","in":"path","type":"string","required":true,"description":"The guarantees issuance id initiated by internet banking"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"senderToReceiverInfoS":[{}],"beneficiaryIdS":[{}],"beneficiaryAddresses":[{}],"applicationIds":[{}],"narratives":[{}],"statementNarratives":[{}],"claimDebitAccount":"string","chargeBearer":"string","claimPaymentMethod":"string","claimCreditAccount":"string","autoExpiry":"string","guaranteeReference":"string","guaranteeType":"string","maturityDate":"string","currency":"string"}},"responses":{"200":"ClaimReceiptResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/holdings/guarantees/receipts/requests/{requestId}/claims","fullPath":"/api/v4.0.0/holdings/guarantees/receipts/requests/{requestId}/claims","operationId":"createClaimReceipts","name":"Facilitates the creation of claim for the guarantee received","summary":"Creates the claim  initiated to guarantee received by the issuing bank","tags":["CORPORATE"],"parameters":[{"name":"requestId","in":"path","type":"string","required":true,"description":"The guarantees issuance id initiated by internet banking"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"claimDetails":[{}],"chargeDetails":[{}],"comments":[{}],"receivingBank":"string","demandType":"string","requestedExpiryDate":"2024-01-01","statementNarrative":"string","senderToReceiverInfo":"string","additionalInformation":"string","demandStatementCode":"string","newExpiryDate":"2024-01-01","invocationStatus":"string","extensions":{}}},"responses":{"200":"ClaimReceiptsResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/holdings/guarantees/receipts/reimbursements","fullPath":"/api/v4.0.0/holdings/guarantees/receipts/reimbursements","operationId":"getReimbursements","name":"Retrieves the details of guarantee clauses","summary":"Retrieves the guarantee clause details","tags":["CORPORATE"],"parameters":[{"name":"guaranteeId","in":"query","type":"string","required":false,"description":"Identifier of the guarantee"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it Retrieves all the data"}],"requestBodyExample":null,"responses":{"200":"ReimbursementsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}}]},{"key":"holdings-guarantees-service-v5.0.0","title":"Management of Guarantees","version":"v5.0.0","description":"API to create, update and manage various types of bank issued guarantees and their associated status and details. Some of the types of guarantees that can be created are bid bonds, performance bonds and trade finance shipping guarantees.","endpointCount":56,"endpoints":[{"method":"GET","path":"/holdings/guarantees/clauses/{clauseId}","fullPath":"/api/v5.0.0/holdings/guarantees/clauses/{clauseId}","operationId":"getClause","name":"Retrieves the guarantee clause details of specific id","summary":"Details of guarantee clause","tags":["CORPORATE"],"parameters":[{"name":"clauseId","in":"path","type":"string","required":true,"description":"Represents id of MD.CLAUSES. Id can be used in MD application and description is automatically populated in the deal.Records created for customer specific clauses, to have ID beginning with the custom"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"ClauseResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"POST","path":"/holdings/guarantees/clauses/{clauseId}","fullPath":"/api/v5.0.0/holdings/guarantees/clauses/{clauseId}","operationId":"createClause","name":"Creates the guarantee clause for a specific customer","summary":"Create guarantee clause","tags":["CORPORATE"],"parameters":[{"name":"clauseId","in":"path","type":"string","required":true,"description":"Represents id of MD.CLAUSES. Id can be used in MD application and description is automatically populated in the deal.Records created for customer specific clauses, to have ID beginning with the custom"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"mdClausesDescriptions":[{}],"mdClausesDisplayName":"string","extensions":{}}},"responses":{"200":"ClauseResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/holdings/guarantees/clauses/{clauseId}","fullPath":"/api/v5.0.0/holdings/guarantees/clauses/{clauseId}","operationId":"updateClause","name":"Updates the guarantee clause for the specific id","summary":"Update guarantee clause","tags":["CORPORATE"],"parameters":[{"name":"clauseId","in":"path","type":"string","required":true,"description":"Represents id of MD.CLAUSES. Id can be used in MD application and description is automatically populated in the deal.Records created for customer specific clauses, to have ID beginning with the custom"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"mdClausesDescriptions":[{}],"mdClausesDisplayName":"string","extensions":{}}},"responses":{"200":"ClauseResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"DELETE","path":"/holdings/guarantees/clauses/{clauseId}","fullPath":"/api/v5.0.0/holdings/guarantees/clauses/{clauseId}","operationId":"deleteClause","name":"Removes the guarantee clause request","summary":"Remove guarantee clause","tags":["CORPORATE"],"parameters":[{"name":"clauseId","in":"path","type":"string","required":true,"description":"Represents id of MD.CLAUSES. Id can be used in MD application and description is automatically populated in the deal.Records created for customer specific clauses, to have ID beginning with the custom"},{"name":"payload","in":"body","type":"object","required":false,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}}},"responses":{"200":"ClauseResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/holdings/guarantees/requests","fullPath":"/api/v5.0.0/holdings/guarantees/requests","operationId":"getGuaranteeIssuanceRequests","name":"Retrieves the list of guarantee initiation request details","summary":"Retrieves the guarantee initiation requests","tags":["CORPORATE"],"parameters":[{"name":"mdIbRequestId","in":"query","type":"string","required":false,"description":"The guarantees issuance id initiated by internet banking"},{"name":"customerId","in":"query","type":"string","required":false,"description":"Identifier of the customer"},{"name":"ibEventStatus","in":"query","type":"string","required":false,"description":"Specifies the status of the guarantee issuance request."},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it Retrieves all the data"}],"requestBodyExample":null,"responses":{"200":"GuaranteeIssuanceRequestsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"POST","path":"/holdings/guarantees/requests","fullPath":"/api/v5.0.0/holdings/guarantees/requests","operationId":"createIbRequest","name":"Creates the guarantee initiation request from internet banking","summary":"Create guarantee initiation request","tags":["CORPORATE"],"parameters":[{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"beneficiaryIds":[{}],"guarantees":[{}],"documentDetails":[{}],"limits":[{}],"messageFromBanks":[{}],"messageFromCustomers":[{}],"information":[{}],"amendmentDetails":[{}],"overrides":[{}],"customerId":"string","currencyId":"string","principalAmount":0.0,"startDate":"2024-01-01","maturityDate":"2024-01-01","categoryName":"string"}},"responses":{"200":"IbRequestResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/holdings/guarantees/requests/{requestId}","fullPath":"/api/v5.0.0/holdings/guarantees/requests/{requestId}","operationId":"getIbRequest","name":"Retrieves the guarantee initiation request details for specific id","summary":"Details of guarantee initiation request","tags":["CORPORATE"],"parameters":[{"name":"requestId","in":"path","type":"string","required":true,"description":"The guarantees issuance id initiated by internet banking"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"IbRequestResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/holdings/guarantees/requests/{requestId}","fullPath":"/api/v5.0.0/holdings/guarantees/requests/{requestId}","operationId":"updateIbRequest","name":"Updates the existing guarantee initiation request for a customer","summary":"Update guarantee initiation request","tags":["CORPORATE"],"parameters":[{"name":"requestId","in":"path","type":"string","required":true,"description":"The guarantees issuance id initiated by internet banking"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"beneficiaryIds":[{}],"guarantees":[{}],"documentDetails":[{}],"limits":[{}],"messageFromBanks":[{}],"messageFromCustomers":[{}],"information":[{}],"amendmentDetails":[{}],"overrides":[{}],"customerId":"string","currencyId":"string","principalAmount":0.0,"startDate":"2024-01-01","maturityDate":"2024-01-01","categoryName":"string"}},"responses":{"200":"IbRequestResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"DELETE","path":"/holdings/guarantees/requests/{requestId}","fullPath":"/api/v5.0.0/holdings/guarantees/requests/{requestId}","operationId":"deleteIbRequest","name":"Removes the existing guarantee initiation request","summary":"Remove guarantee initiation request","tags":["CORPORATE"],"parameters":[{"name":"requestId","in":"path","type":"string","required":true,"description":"The guarantees issuance id initiated by internet banking"},{"name":"payload","in":"body","type":"object","required":false,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}}},"responses":{"200":"IbRequestResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/holdings/guarantees/guaranteesApprovals/{requestId}","fullPath":"/api/v5.0.0/holdings/guarantees/guaranteesApprovals/{requestId}","operationId":"approveGuarantee","name":"Approves the guarantee initiation request","summary":"Approve guarantee initiation request","tags":["CORPORATE"],"parameters":[{"name":"requestId","in":"path","type":"string","required":true,"description":"The guarantees issuance id initiated by internet banking"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"GuaranteeResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"DELETE","path":"/holdings/guarantees/cancellations/{requestId}","fullPath":"/api/v5.0.0/holdings/guarantees/cancellations/{requestId}","operationId":"rejectGuarantee","name":"Reject the guarantee initiation request","summary":"Reject guarantee initiation request","tags":["CORPORATE"],"parameters":[{"name":"requestId","in":"path","type":"string","required":true,"description":"The guarantees issuance id initiated by internet banking"},{"name":"payload","in":"body","type":"object","required":false,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}}},"responses":{"200":"GuaranteeResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/holdings/guarantees/{guaranteeId}/receivedGuarantees","fullPath":"/api/v5.0.0/holdings/guarantees/{guaranteeId}/receivedGuarantees","operationId":"getReceivedGuaranteeHistory","name":"Retrieves the received guarantee requests for the customer ","summary":"Retrieves received guarantee requests","tags":["CORPORATE"],"parameters":[{"name":"guaranteeId","in":"path","type":"string","required":true,"description":"Identifier of the guarantee"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it Retrieves all the data"}],"requestBodyExample":null,"responses":{"200":"ReceivedGuaranteeHistoryResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/guarantees/clauses","fullPath":"/api/v5.0.0/holdings/guarantees/clauses","operationId":"getGuaranteeClauses","name":"Retrieves the list of guarantee clause requests for specific customer","summary":"Retrieves the guarantee clause requests","tags":["CORPORATE"],"parameters":[{"name":"clauseId","in":"query","type":"string","required":false,"description":"Represents id of MD.CLAUSES. Id can be used in MD application and description is automatically populated in the deal.Records created for customer specific clauses, to have ID beginning with the custom"},{"name":"customerId","in":"query","type":"string","required":false,"description":"Identifier of the customer"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it Retrieves all the data"}],"requestBodyExample":null,"responses":{"200":"GuaranteeClausesResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/guarantees/receivedGuarantees/amendments","fullPath":"/api/v5.0.0/holdings/guarantees/receivedGuarantees/amendments","operationId":"getReceivedGuaranteesAmendments","name":"Retrieves the list of amended guarantee requests","summary":"Retrieves the amended guarantee requests","tags":["CORPORATE"],"parameters":[{"name":"alternateId","in":"query","type":"string","required":false,"description":"An Alternate Identification for the Deal. This can be used to retrieve the Deal for amendment."},{"name":"contractType","in":"query","type":"string","required":false,"description":"Indicates if the position is related to Loan, Deposit ,FX-Forward/FX-Swap"},{"name":"customerId","in":"query","type":"string","required":false,"description":"Identifier of the customer"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it Retrieves all the data"}],"requestBodyExample":null,"responses":{"200":"ReceivedGuaranteesAmendmentsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/guarantees/{guaranteeId}/invocations","fullPath":"/api/v5.0.0/holdings/guarantees/{guaranteeId}/invocations","operationId":"getClaimInvocationHistory","name":"Retrieves the list of guarantee claim invocation details","summary":"Retrieves the guarantee claim invocation details","tags":["CORPORATE"],"parameters":[{"name":"guaranteeId","in":"path","type":"string","required":true,"description":"Identifier of the guarantee"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it Retrieves all the data"}],"requestBodyExample":null,"responses":{"200":"ClaimInvocationHistoryResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/guarantees/receivedClaims","fullPath":"/api/v5.0.0/holdings/guarantees/receivedClaims","operationId":"getReceivedGuaranteeClaims","name":"Retrieves the list of received guarantee claim for a customer","summary":"Retrieves the received guarantee claims","tags":["CORPORATE"],"parameters":[{"name":"customerId","in":"query","type":"string","required":false,"description":"Identifier of the customer"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it Retrieves all the data"}],"requestBodyExample":null,"responses":{"200":"ReceivedGuaranteeClaimsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/guarantees/amendments","fullPath":"/api/v5.0.0/holdings/guarantees/amendments","operationId":"getGuaranteeAmendments","name":"Retrieves the list of amended guarantee requests for specific customer","summary":"Retrieves guarantee amendment requests","tags":["CORPORATE"],"parameters":[{"name":"customerId","in":"query","type":"string","required":false,"description":"Identifier of the customer"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it Retrieves all the data"}],"requestBodyExample":null,"responses":{"200":"GuaranteeAmendmentsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/guarantees/issuedGuarantees","fullPath":"/api/v5.0.0/holdings/guarantees/issuedGuarantees","operationId":"getIssuedGuarantees","name":"Retrieves the list of issued guarantee request details for specific customer","summary":"Retrieves the issued guarantee details","tags":["CORPORATE"],"parameters":[{"name":"customerId","in":"query","type":"string","required":false,"description":"Identifier of the customer"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it Retrieves all the data"}],"requestBodyExample":null,"responses":{"200":"IssuedGuaranteesResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/guarantees/limits","fullPath":"/api/v5.0.0/holdings/guarantees/limits","operationId":"getGuaranteeLimits","name":"Retrieves the list of guarantees limit details","summary":"Retrieves the guarantee limits","tags":["CORPORATE"],"parameters":[{"name":"customerId","in":"query","type":"string","required":false,"description":"Identifier of the customer"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it Retrieves all the data"}],"requestBodyExample":null,"responses":{"200":"GuaranteeLimitsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/guarantees/issuedClaims","fullPath":"/api/v5.0.0/holdings/guarantees/issuedClaims","operationId":"getIssuedGuaranteeClaims","name":"Retrieves the list of received guarantee claim details","summary":"Retrieves the received guarantee claims","tags":["CORPORATE"],"parameters":[{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it Retrieves all the data"}],"requestBodyExample":null,"responses":{"200":"IssuedGuaranteeClaimsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/guarantees","fullPath":"/api/v5.0.0/holdings/guarantees","operationId":"getGuarantees","name":"Retrieves the list of guarantee details","summary":"Retrieves the guarantee details","tags":["CORPORATE"],"parameters":[{"name":"guaranteeId","in":"query","type":"string","required":false,"description":"Identifier of the guarantee"},{"name":"beneficiaryCustomerId","in":"query","type":"string","required":false,"description":"Identifies the Customer who is to be the ultimate receiver of the funds transferred by the sending bank when this Beneficiary is not a bank."},{"name":"contractType","in":"query","type":"string","required":false,"description":"Indicates if the position is related to Loan, Deposit ,FX-Forward/FX-Swap"},{"name":"ibRequestId","in":"query","type":"string","required":false,"description":"The guarantees issuance id initiated by internet banking"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it Retrieves all the data"}],"requestBodyExample":null,"responses":{"200":"GuaranteesResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"POST","path":"/holdings/guarantees","fullPath":"/api/v5.0.0/holdings/guarantees","operationId":"createGuaranteeGeneric","name":"Creates a generic guarantee for the requested customer reference number","summary":"Creates a generic guarantee","tags":["CORPORATE"],"parameters":[{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"beneficiaryIds":[{}],"beneficiaryAddresses":[{}],"charges":[{}],"bankAddresses":[{}],"detailsOfGuarantee":[{}],"guaranteeReference":"string","customerId":"string","currency":"string","amount":0.0,"dealDate":"2024-01-01","startDate":"2024-01-01","expiryDate":"2024-01-01","maturityDate":"2024-01-01","limitReference":"string","termsAndConditions":"string"}},"responses":{"200":"GuaranteeGenericResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/holdings/customers/{customerId}/guarantees/outstandings","fullPath":"/api/v5.0.0/holdings/customers/{customerId}/guarantees/outstandings","operationId":"getGuaranteesOutstandings","name":"Retrieves the detailed information on issued guarantees for the specified customer/guarantee reference","summary":"Retrieves outstanding guarantees","tags":["CORPORATE"],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"Identifier of the customer"},{"name":"transactionReference","in":"query","type":"string","required":false,"description":"Contains the identifier for the transaction in the core system"},{"name":"guaranteeType","in":"query","type":"string","required":false,"description":"Refers to the type of the contract that is being issued."},{"name":"currency","in":"query","type":"string","required":false,"description":"Identifies the currency. E.g. USD, GBP etc"},{"name":"amount","in":"query","type":"string","required":false,"description":"This is the payment amount"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it Retrieves all the data"}],"requestBodyExample":null,"responses":{"200":"GuaranteesOutstandingsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/customers/{customerId}/guarantees/expiries","fullPath":"/api/v5.0.0/holdings/customers/{customerId}/guarantees/expiries","operationId":"getGuaranteeExpiringWithDate","name":"Retrieves the expiring guarantees details for the specified customer/guarantee reference ","summary":"Retrieves expiring guarantees","tags":["CORPORATE"],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"Identifier of the customer"},{"name":"transactionReference","in":"query","type":"string","required":false,"description":"Contains the identifier for the transaction in the core system"},{"name":"currency","in":"query","type":"string","required":false,"description":"Identifies the currency. E.g. USD, GBP etc"},{"name":"amount","in":"query","type":"string","required":false,"description":"This is the payment amount"},{"name":"maturityDate","in":"query","type":"string","required":false,"description":"Indicates maturity date of the contract"},{"name":"gteeReturnDate","in":"query","type":"string","required":false,"description":"Date on which the original Guarantee will be returned by the customer to the Bank that issued it"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it Retrieves all the data"}],"requestBodyExample":null,"responses":{"200":"GuaranteeExpiringWithDateResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/customers/{customerId}/guarantees/outstandingClaims","fullPath":"/api/v5.0.0/holdings/customers/{customerId}/guarantees/outstandingClaims","operationId":"getClaimOutstandingUnderGuarantees","name":"Retrieves the list of corporate miscellaneous deals for the customer.","summary":"Retrieves outstanding guarantee claims","tags":["CORPORATE"],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"Identifier of the customer"},{"name":"transactionReference","in":"query","type":"string","required":false,"description":"Contains the identifier for the transaction in the core system"},{"name":"currency","in":"query","type":"string","required":false,"description":"Identifies the currency. E.g. USD, GBP etc"},{"name":"amount","in":"query","type":"string","required":false,"description":"This is the payment amount"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it Retrieves all the data"}],"requestBodyExample":null,"responses":{"200":"ClaimOutstandingUnderGuaranteesResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/customers/{customerId}/guarantees/cancellations","fullPath":"/api/v5.0.0/holdings/customers/{customerId}/guarantees/cancellations","operationId":"getGuaranteesReversed","name":"Retrieves the list of cancelled guarantees for the specified customer/guarantee reference","summary":"Retrieves list of cancelled guarantees","tags":["CORPORATE"],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"Identifier of the customer"},{"name":"transactionReference","in":"query","type":"string","required":false,"description":"Contains the identifier for the transaction in the core system"},{"name":"guaranteeType","in":"query","type":"string","required":false,"description":"Refers to the type of the contract that is being issued."},{"name":"currency","in":"query","type":"string","required":false,"description":"Identifies the currency. E.g. USD, GBP etc"},{"name":"amount","in":"query","type":"string","required":false,"description":"This is the payment amount"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it Retrieves all the data"}],"requestBodyExample":null,"responses":{"200":"GuaranteesReversedResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/guarantees/{guaranteeId}/issuedClaims","fullPath":"/api/v5.0.0/holdings/guarantees/{guaranteeId}/issuedClaims","operationId":"getClaimsPaidUnderGuarantee","name":"Retrieves the list of issued guarantees paid/cancelled for the specified customer/guarantee reference.","summary":"Retrieves paid/cancelled details of issued guarantees","tags":["CORPORATE"],"parameters":[{"name":"guaranteeId","in":"path","type":"string","required":true,"description":""},{"name":"transactionReference","in":"query","type":"string","required":false,"description":"Contains the identifier for the transaction in the core system"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it Retrieves all the data"}],"requestBodyExample":null,"responses":{"200":"ClaimsPaidUnderGuaranteeResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/guarantees/{guaranteeId}/shippings/outstandings","fullPath":"/api/v5.0.0/holdings/guarantees/{guaranteeId}/shippings/outstandings","operationId":"getOutstandingShippingGuarantees","name":"Retrieves the details of outstanding shipping guarantees for the specified customer/guarantee reference.","summary":"Retrieves list of outstanding shipping guarantees","tags":["CORPORATE"],"parameters":[{"name":"guaranteeId","in":"path","type":"string","required":true,"description":""},{"name":"transactionReference","in":"query","type":"string","required":false,"description":"Contains the identifier for the transaction in the core system"},{"name":"lCReference","in":"query","type":"string","required":false,"description":"Indicates the LC reference under which the guarantee is to be opened"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it Retrieves all the data"}],"requestBodyExample":null,"responses":{"200":"OutstandingShippingGuaranteesResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/customers/{customerId}/guarantees/receivedOutstandings","fullPath":"/api/v5.0.0/holdings/customers/{customerId}/guarantees/receivedOutstandings","operationId":"getOutstandingReceivedGuarantees","name":"Retrieves the details of outstanding received guarantees for the specified customer/guarantee reference.","summary":"Retrieves outstanding received guarantees details","tags":["CORPORATE"],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"Identifier of the customer"},{"name":"guaranteeId","in":"query","type":"string","required":false,"description":"Identifier of the guarantee"},{"name":"guaranteeType","in":"query","type":"string","required":false,"description":"Refers to the type of the contract that is being issued."},{"name":"formOfUndertaking","in":"query","type":"string","required":false,"description":"It specifies the form of the independent and irrevocable undertaking. The undertaking cycle is determined based on the value provided here.Possible values are, DGAR \u00e2\u20ac\u201c The undertaking takes the form "},{"name":"principalAmount","in":"query","type":"string","required":false,"description":"Indicates the principal amount of the loan or a deposit"},{"name":"currency","in":"query","type":"string","required":false,"description":"Identifies the currency. E.g. USD, GBP etc"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it Retrieves all the data"}],"requestBodyExample":null,"responses":{"200":"OutstandingReceivedGuaranteesResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"POST","path":"/holdings/guarantee/performanceBonds","fullPath":"/api/v5.0.0/holdings/guarantee/performanceBonds","operationId":"createGuaranteesPerformanceBond","name":"Creates performance bond guarantee for the requested customer reference number","summary":"Creates performance bond guarantee","tags":["CORPORATE"],"parameters":[{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"beneficiaryIds":[{}],"beneficiaryaddresses":[{}],"charges":[{}],"bankAddresses":[{}],"detailsOfGuarantee":[{}],"performanceBondReference":"string","customerId":"string","currency":"string","amount":0.0,"dealDate":"2024-01-01","valueDate":"2024-01-01","expiryDate":"2024-01-01","maturityDate":"2024-01-01","termsAndConditions":"string","eventsProcessing":"string"}},"responses":{"200":"GuaranteesPerformanceBondResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"POST","path":"/holdings/guarantees/letterOfCredits/standBys","fullPath":"/api/v5.0.0/holdings/guarantees/letterOfCredits/standBys","operationId":"createGuaranteesStandbyLC","name":"Creates standby letter of credit guarantee for the requested customer reference number","summary":"Creates standby letter of credit guarantee","tags":["CORPORATE"],"parameters":[{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"beneficiaryIds":[{}],"beneficiaryAddresses":[{}],"charges":[{}],"bankAddresses":[{}],"detailsOfGuarantee":[{}],"standByImportLC":"string","customerId":"string","currency":"string","amount":0.0,"dealDate":"2024-01-01","valueDate":"2024-01-01","expiryDate":"2024-01-01","maturityDate":"2024-01-01","termsAndConditions":"string","eventsProcessing":"string"}},"responses":{"200":"GuaranteesStandbyLCResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"POST","path":"/holdings/guarantees/letterOfCredits/shippings","fullPath":"/api/v5.0.0/holdings/guarantees/letterOfCredits/shippings","operationId":"createShippingGuaranteeUnderLC","name":"Creates shipping guarantees under letter of credit for the requested customer reference number","summary":"Creates shipping guarantees under letter of credit","tags":["CORPORATE"],"parameters":[{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"beneficiaryIds":[{}],"beneficiaryAddresses":[{}],"charges":[{}],"bankAddresses":[{}],"detailsOfGuarantee":[{}],"internalReference":"string","customerId":"string","currency":"string","amount":0.0,"dealDate":"2024-01-01","valueDate":"2024-01-01","maturityDate":"2024-01-01","termsAndConditions":"string","eventsProcessing":"string","autoExpiry":"string"}},"responses":{"200":"ShippingGuaranteeUnderLCResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"POST","path":"/holdings/guarantees/letterOfCredits/shippings/collections","fullPath":"/api/v5.0.0/holdings/guarantees/letterOfCredits/shippings/collections","operationId":"createShippingGuaranteeUnderCollection","name":"Creates shipping guarantee under collection letter of credit for the requested customer reference number","summary":"Creates shipping guarantee under collection letter of credit","tags":["CORPORATE"],"parameters":[{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"beneficiaryId":[{}],"beneficiaryAddresses":[{}],"charges":[{}],"bankAddresses":[{}],"detailsOfGuarantee":[{}],"shippingGuaranteeReference":"string","customerId":"string","currency":"string","amount":0.0,"dealDate":"2024-01-01","valueDate":"2024-01-01","maturityDate":"2024-01-01","termsAndConditions":"string","eventsProcessing":"string","autoExpiry":"string"}},"responses":{"200":"ShippingGuaranteeUnderCollectionResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/holdings/guarantees/{guaranteeId}/receivedClaims","fullPath":"/api/v5.0.0/holdings/guarantees/{guaranteeId}/receivedClaims","operationId":"getInvocationPaidOrCancelled","name":"Retrieves the list of received guarantees paid/cancelled for the specified customer/guarantee reference","summary":"Retrieves paid/cancelled details of received guarantees","tags":["CORPORATE"],"parameters":[{"name":"guaranteeId","in":"path","type":"string","required":true,"description":""},{"name":"transactionReference","in":"query","type":"string","required":false,"description":"Contains the identifier for the transaction in the core system"},{"name":"beneficiary","in":"query","type":"string","required":false,"description":"Beneficiary information"},{"name":"debitAccountId","in":"query","type":"string","required":false,"description":"Indicates the debit account number of the payment or transaction."},{"name":"creditAccountId","in":"query","type":"string","required":false,"description":"Credit account identifier of the payment or transaction"},{"name":"amount","in":"query","type":"string","required":false,"description":"This is the payment amount"},{"name":"debitValueDate","in":"query","type":"string","required":false,"description":"Date on which the amount will be debited for settlement"},{"name":"creditValueDate","in":"query","type":"string","required":false,"description":"Reference quoted by the credit account for a payment"},{"name":"correspondentBank","in":"query","type":"string","required":false,"description":"Correspondent bank, where our nostro account is held."},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it Retrieves all the data"}],"requestBodyExample":null,"responses":{"200":"InvocationPaidOrCancelledResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"POST","path":"/holdings/guarantees/bidBonds","fullPath":"/api/v5.0.0/holdings/guarantees/bidBonds","operationId":"createGuarnteeBidBond","name":"Creates bid bond guarantee for the requested customer reference number","summary":"Creates bid bond guarantee","tags":["CORPORATE"],"parameters":[{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"beneficiaryIds":[{}],"beneficiaryAddresses":[{}],"charges":[{}],"bankAddresses":[{}],"detailsOfGuarantee":[{}],"bidBondReference":"string","customerId":"string","currency":"string","amount":0.0,"dealDate":"2024-01-01","valueDate":"2024-01-01","expiryDate":"2024-01-01","maturityDate":"string","termsAndConditions":"string","eventsProcessing":"string"}},"responses":{"200":"GuarnteeBidBondResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"POST","path":"/holdings/guarantees/{guaranteeId}/rejectedClaims","fullPath":"/api/v5.0.0/holdings/guarantees/{guaranteeId}/rejectedClaims","operationId":"updateGuaranteesRejection","name":"Updates the rejection of claim for the specified guarantee/customer reference number","summary":"Updates the rejection of claim for a guarantee","tags":["CORPORATE"],"parameters":[{"name":"guaranteeId","in":"path","type":"string","required":true,"description":""},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"beneficiaryIds":[{}],"beneficairyAddresses":[{}],"guaranteeReference":"string","guaranteeType":"string","customerId":"string","limitReference":"string","currency":"string","amount":"string","startDate":"string","maturityDate":"string","autoExpiry":"string","onlineMaturity":"string","eventsProcessing":"string","liquidationMode":"string","claimRegisterDate":"string"}},"responses":{"200":"GuaranteesRejectionResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"POST","path":"/holdings/guarantees/{guaranteeId}","fullPath":"/api/v5.0.0/holdings/guarantees/{guaranteeId}","operationId":"updateGuaranteesAmendment","name":"Updates additional guarantee information for the specified  customer/guarantee reference number","summary":"Updates guarantee details","tags":["CORPORATE"],"parameters":[{"name":"guaranteeId","in":"path","type":"string","required":true,"description":""},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"BeneficiaryIds":[{}],"BeneficiaryAddresses":[{}],"pincipalMovements":[{}],"texts":[{}],"guarantees":[{}],"ibClaimNarratives":[{}],"charges":[{}],"bankAddresses":[{}],"detailsOfGuarantee":[{}],"guaranteeReference":"string","customerReference":"string","customerId":"string","guaranteeType":"string","productCategoryId":"string","currency":"string"}},"responses":{"200":"GuaranteesAmendmentResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"POST","path":"/holdings/guarantees/issuances/requests/initiations","fullPath":"/api/v5.0.0/holdings/guarantees/issuances/requests/initiations","operationId":"initiateIssuance","name":"Initiates guarantee issuance request through self service channel for the corporate user","summary":"Initiates new guarantee issuance","tags":["CORPORATE"],"parameters":[{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"guaranteeDetail":[{}],"beneficiaries":[{}],"charges":[{}],"commission":[{}],"undertakingIssued":[{}],"formOfUndertaking":"string","currency":"string","valueDate":"string","expiryType":"string","adviceExpiryDate":"string","applicableRule":"string","advisingBank":"string","marginDebitAccount":"string","guaranteeType":"string","category":"string"}},"responses":{"200":"IssuanceResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/holdings/guarantees/issuances/requests/{requestId}","fullPath":"/api/v5.0.0/holdings/guarantees/issuances/requests/{requestId}","operationId":"updateIssuance","name":"Updates the details of the guarantee request which are mandated for the issuing by the issuing bank","summary":"Facilitates the updation of the Guarantee which is initiated for a customer","tags":["CORPORATE"],"parameters":[{"name":"requestId","in":"path","type":"string","required":true,"description":"The guarantees issuance id initiated by internet banking"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"guaranteeDetail":[{}],"applicantCustomers":[{}],"charges":[{}],"commission":[{}],"commissionType":[{}],"beneficiaryAddresses":[{}],"beneficiaries":[{}],"senderReceiversInfoMT730":[{}],"undertakingIssued":[{}],"counterparty":[{}],"counterpartyBeneficiaries":[{}],"comments":[{}],"guaranteeReference":"string","guaranteeType":"string","advisingBank":"string"}},"responses":{"200":"IssuanceResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"DELETE","path":"/holdings/guarantees/issuances/requests/{requestId}","fullPath":"/api/v5.0.0/holdings/guarantees/issuances/requests/{requestId}","operationId":"reverseIssuance","name":"Reverse the existing guarantee file issued by the issuing bank on behalf of a corporate customer","summary":"Enables the option to reverse the existing guarantee for a customer","tags":["CORPORATE"],"parameters":[{"name":"requestId","in":"path","type":"string","required":true,"description":"The guarantees issuance id initiated by internet banking"},{"name":"payload","in":"body","type":"object","required":false,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}}},"responses":{"200":"IssuanceResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/holdings/guarantees/issuances/requests/{requestId}/rejections","fullPath":"/api/v5.0.0/holdings/guarantees/issuances/requests/{requestId}/rejections","operationId":"rejectClaimIssuance","name":"Reject response of a claim received by the issuing bank to the beneficiary bank","summary":"Captures the values for the the rejection of claim for a guarantee issued","tags":["CORPORATE"],"parameters":[{"name":"requestId","in":"path","type":"string","required":true,"description":"The guarantees issuance id initiated by internet banking"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"beneficiaries":[{}],"beneficiaryAddresses":[{}],"guaranteeDetail":[{}],"internetBankingClaimNarratives":[{}],"narratives":[{}],"senderToReceiverInfos":[{}],"comments":[{}],"guaranteeReference":"string","guaranteeType":"string","maturityDate":"2024-01-01","currency":"string","invocationAmount":0.0,"advisingBank":"string","claimRegisterDate":"2024-01-01","formOfUndertaking":"string"}},"responses":{"200":"ClaimIssuanceResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/holdings/guarantees/issuances/requests/{requestId}/amendments/confirmations","fullPath":"/api/v5.0.0/holdings/guarantees/issuances/requests/{requestId}/amendments/confirmations","operationId":"approveIssuance","name":"Approves  the amendment response received from the corporate user for the received guarantees for a corporate customer","summary":"Enables to capture the approval for the amendment response for the incoming amendments","tags":["CORPORATE"],"parameters":[{"name":"requestId","in":"path","type":"string","required":true,"description":"The guarantees issuance id initiated by internet banking"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"rejectionReasons":[{}],"additionalInformations":[{}],"comments":[{}],"amendmentStatus":"string","amendmentNumber":"string","extensions":{}}},"responses":{"200":"IssuanceResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/holdings/guarantees/issuances/requests","fullPath":"/api/v5.0.0/holdings/guarantees/issuances/requests","operationId":"getIssuance","name":"Retrieves the list of issued guarantees by the issuing bank for any corporate customer","summary":"Enables to retrieve the list of issued guarantees outstanding","tags":["CORPORATE"],"parameters":[{"name":"beneficiary","in":"query","type":"string","required":false,"description":"Beneficiary information"},{"name":"contractType","in":"query","type":"string","required":false,"description":"Indicates if the position is related to Loan, Deposit ,FX-Forward/FX-Swap"},{"name":"guaranteeId","in":"query","type":"string","required":false,"description":"Identifier of the guarantee"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it Retrieves all the data"}],"requestBodyExample":null,"responses":{"200":"IssuanceResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"POST","path":"/holdings/guarantees/issuances/requests","fullPath":"/api/v5.0.0/holdings/guarantees/issuances/requests","operationId":"createIssuance","name":"Initiation of  a guarantee issuance request by the issuing bank for the applicant or the instructing party.","summary":"Facilitates the creation of guarantee issuance for a customer","tags":["CORPORATE"],"parameters":[{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"guaranteeDetail":[{}],"applicantCustomers":[{}],"charges":[{}],"commission":[{}],"commissionType":[{}],"beneficiaryAddresses":[{}],"beneficiaries":[{}],"senderReceiversInfoMT730":[{}],"undertakingIssued":[{}],"counterparty":[{}],"counterpartyBeneficiaries":[{}],"comments":[{}],"guaranteeReference":"string","guaranteeType":"string","advisingBank":"string"}},"responses":{"200":"IssuanceResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/holdings/guarantees/issuances/amendments","fullPath":"/api/v5.0.0/holdings/guarantees/issuances/amendments","operationId":"getAmendmentsIssuance","name":"Retrieves the list of amendments and the details for  an issued guarantee by the issuing bank","summary":"Retrieves the list of amendment history for the issued guarantees for a corporate customer","tags":["CORPORATE"],"parameters":[{"name":"customerId","in":"query","type":"string","required":false,"description":"Identifier of the customer"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it Retrieves all the data"}],"requestBodyExample":null,"responses":{"200":"AmendmentsIssuanceResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"PUT","path":"/holdings/guarantees/issuances/requests/{requestId}/claims","fullPath":"/api/v5.0.0/holdings/guarantees/issuances/requests/{requestId}/claims","operationId":"updateClaimIssuance","name":"Updates the received claim details sent by the beneficiary to the issued guarantee request","summary":"Facilitates in updating the details of a claim for the guarantee issuance","tags":["CORPORATE"],"parameters":[{"name":"requestId","in":"path","type":"string","required":true,"description":"The guarantees issuance id initiated by internet banking"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"senderToReceiverInfoS":[{}],"beneficiaryIdS":[{}],"beneficiaryAddresses":[{}],"applicationIds":[{}],"narratives":[{}],"statementNarratives":[{}],"claimDebitAccount":"string","chargeBearer":"string","claimPaymentMethod":"string","claimCreditAccount":"string","autoExpiry":"string","guaranteeReference":"string","guaranteeType":"string","maturityDate":"string","currency":"string"}},"responses":{"200":"ClaimIssuanceResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/holdings/guarantees/issuances/requests/{requestId}/amendments","fullPath":"/api/v5.0.0/holdings/guarantees/issuances/requests/{requestId}/amendments","operationId":"amendIssuance","name":"Amendment of the terms and conditions of the guarantee after issuance by the issuing bank and notifying the parties in the guarantee","summary":"Facilitates the updation of  the existing guarantee initiation for a customer","tags":["CORPORATE"],"parameters":[{"name":"requestId","in":"path","type":"string","required":true,"description":"The guarantees issuance id initiated by internet banking"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"guaranteeDetails":[{}],"charges":[{}],"commission":[{}],"amendmentDetail":[{}],"counterparties":[{}],"reimbursingBankReferences":[{}],"newCreditTolerance":"string","newDebitTolerances":"string","externalReference":"string","increaseDecreaseAmount":"string","adviceExpiryDate":"string","comments":"string","extensions":{}}},"responses":{"200":"IssuanceResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/holdings/guarantees/issuances/extensions","fullPath":"/api/v5.0.0/holdings/guarantees/issuances/extensions","operationId":"getAutoExtensionDetails","name":"Retrieves a list of guarantees for which auto extension is enabled","summary":"Retrieves guarantees subject to auto extension","tags":["CORPORATE"],"parameters":[{"name":"guaranteeType","in":"query","type":"string","required":false,"description":"Refers to the type of the contract that is being issued."},{"name":"guaranteeId","in":"query","type":"string","required":false,"description":"Identifier of the guarantee"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it Retrieves all the data"}],"requestBodyExample":null,"responses":{"200":"AutoExtensionDetailsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"PUT","path":"/holdings/guarantees/receipts/requests/{requestId}","fullPath":"/api/v5.0.0/holdings/guarantees/receipts/requests/{requestId}","operationId":"updateStatusOfReceipt","name":"Updates the status for the existing guarantee received field by the issuing bank with the concurrence of the beneficiary","summary":"Facilitates in updating  the status for the existing guarantee received","tags":["CORPORATE"],"parameters":[{"name":"requestId","in":"path","type":"string","required":true,"description":"The guarantees issuance id initiated by internet banking"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"comments":[{}],"guaranteeReference":"string","senderToReceiverInfo":"string","extensions":{}}},"responses":{"200":"StatusOfReceiptResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/holdings/guarantees/receipts/requests","fullPath":"/api/v5.0.0/holdings/guarantees/receipts/requests","operationId":"getReceipts","name":"Retrieves the list of issued guarantee claims that are received for the guarantees issued","summary":"Enables to retrieve the list of received guarantees and outstanding","tags":["CORPORATE"],"parameters":[{"name":"guaranteeId","in":"query","type":"string","required":false,"description":"Identifier of the guarantee"},{"name":"guaranteeReference","in":"query","type":"string","required":false,"description":"Another ID for the transaction for retrieval purposes or it can be used for the bank to use a unique guarantee number rather than the system generated ID"},{"name":"beneficiary","in":"query","type":"string","required":false,"description":"Beneficiary information"},{"name":"claimStatus","in":"query","type":"string","required":false,"description":"Status update of the claim records"},{"name":"guaranteeType","in":"query","type":"string","required":false,"description":"Refers to the type of the contract that is being issued."},{"name":"applicantCustomerId","in":"query","type":"string","required":false,"description":"This field identifies the applicant on whose behalf the Letter of Credit is issued, if the applicant is held on the CUSTOMER file."},{"name":"applicantAddress","in":"query","type":"string","required":false,"description":"It indicates the name and address of the party who is engaged in trade agreement with beneficiary. Although the initial values are defaulted from the Customer file, yet they may be altered with an alt"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it Retrieves all the data"}],"requestBodyExample":null,"responses":{"200":"ReceiptsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/guarantees/receipts/amendments","fullPath":"/api/v5.0.0/holdings/guarantees/receipts/amendments","operationId":"getAmendmentsReceipts","name":"Retrieves the list of amendment history details for the received guarantee file for a corporate customer","summary":"Retrieves the list of amendment history for the received guarantees for a corporate customer","tags":["CORPORATE"],"parameters":[{"name":"beneficiary","in":"query","type":"string","required":true,"description":"Beneficiary information"},{"name":"guaranteeId","in":"query","type":"string","required":false,"description":"Identifier of the guarantee"},{"name":"inwardMessageId","in":"query","type":"string","required":false,"description":"This field holds the inward delivery reference for the corresponding message type."},{"name":"inwardPaymentType","in":"query","type":"string","required":false,"description":"To identify the incoming SWIFT payment received direct from Delivery, payments generated by standing orders and local clearing payments."},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it Retrieves all the data"}],"requestBodyExample":null,"responses":{"200":"AmendmentsReceiptsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"PUT","path":"/holdings/guarantees/receipts/requests/{requestId}/rejections","fullPath":"/api/v5.0.0/holdings/guarantees/receipts/requests/{requestId}/rejections","operationId":"rejectClaimReceipt","name":"Updates the rejection of claim for a guarantee received file from the beneficiary bank","summary":"Facilitates the updation of the rejection of claim for a guarantee received","tags":["CORPORATE"],"parameters":[{"name":"requestId","in":"path","type":"string","required":true,"description":"The guarantees issuance id initiated by internet banking"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"beneficiaries":[{}],"beneficiaryAddresses":[{}],"applicationIds":[{}],"narratives":[{}],"decisionReasons":[{}],"comments":[{}],"guaranteeId":"string","guaranteeType":"string","maturityDate":"2024-01-01","currency":"string","invocationAmount":0.0,"advisingBank":"string","claimRegisterDate":"2024-01-01","formOfUndertaking":"string","adviceExpiryDate":"2024-01-01"}},"responses":{"200":"ClaimReceiptResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/holdings/guarantees/receipts/requests/{requestId}/claims/confirmations","fullPath":"/api/v5.0.0/holdings/guarantees/receipts/requests/{requestId}/claims/confirmations","operationId":"updateClaimReceipt","name":"Updates the response for the claim  initiated to guarantee received by the issuing bank","summary":"Facilitates the updation of  the confirmation of claim for the guarantee received","tags":["CORPORATE"],"parameters":[{"name":"requestId","in":"path","type":"string","required":true,"description":"The guarantees issuance id initiated by internet banking"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"senderToReceiverInfoS":[{}],"beneficiaryIdS":[{}],"beneficiaryAddresses":[{}],"applicationIds":[{}],"narratives":[{}],"statementNarratives":[{}],"claimDebitAccount":"string","chargeBearer":"string","claimPaymentMethod":"string","claimCreditAccount":"string","autoExpiry":"string","guaranteeReference":"string","guaranteeType":"string","maturityDate":"string","currency":"string"}},"responses":{"200":"ClaimReceiptResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/holdings/guarantees/receipts/requests/{requestId}/claims","fullPath":"/api/v5.0.0/holdings/guarantees/receipts/requests/{requestId}/claims","operationId":"createClaimReceipts","name":"Facilitates the creation of claim for the guarantee received","summary":"Creates the claim  initiated to guarantee received by the issuing bank","tags":["CORPORATE"],"parameters":[{"name":"requestId","in":"path","type":"string","required":true,"description":"The guarantees issuance id initiated by internet banking"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"claimDetails":[{}],"chargeDetails":[{}],"comments":[{}],"receivingBank":"string","demandType":"string","requestedExpiryDate":"2024-01-01","statementNarrative":"string","senderToReceiverInfo":"string","additionalInformation":"string","demandStatementCode":"string","newExpiryDate":"2024-01-01","invocationStatus":"string","extensions":{}}},"responses":{"200":"ClaimReceiptsResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/holdings/guarantees/receipts/reimbursements","fullPath":"/api/v5.0.0/holdings/guarantees/receipts/reimbursements","operationId":"getReimbursements","name":"Retrieves the details of guarantee clauses","summary":"Retrieves the guarantee clause details","tags":["CORPORATE"],"parameters":[{"name":"guaranteeId","in":"query","type":"string","required":false,"description":"Identifier of the guarantee"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it Retrieves all the data"}],"requestBodyExample":null,"responses":{"200":"ReimbursementsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/guarantees/receipts/claims","fullPath":"/api/v5.0.0/holdings/guarantees/receipts/claims","operationId":"getClaimsReceipt","name":"Retrieves the list of received guarantee claim details that are initiated by the issuing bank ","summary":"Retrieves the list of received guarantee claims","tags":["CORPORATE"],"parameters":[{"name":"guaranteeReference","in":"query","type":"string","required":false,"description":"Another ID for the transaction for retrieval purposes or it can be used for the bank to use a unique guarantee number rather than the system generated ID"},{"name":"guaranteeId","in":"query","type":"string","required":false,"description":"Identifier of the guarantee"},{"name":"beneficiaryId","in":"query","type":"string","required":false,"description":"Indicates the the participant beneficiary account details for cash outflow. Account indicated in the beneficiary will be used to credit participant shares upon borrower repayment. Allowed value should"},{"name":"claimStatus","in":"query","type":"string","required":false,"description":"Status update of the claim records"},{"name":"guaranteeType","in":"query","type":"string","required":false,"description":"Refers to the type of the contract that is being issued."},{"name":"customerId","in":"query","type":"string","required":false,"description":"Identifier of the customer"},{"name":"applicantAddress","in":"query","type":"string","required":false,"description":"It indicates the name and address of the party who is engaged in trade agreement with beneficiary. Although the initial values are defaulted from the Customer file, yet they may be altered with an alt"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"ClaimsReceiptResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}}]},{"key":"holdings-guarantees-service-v6.0.0","title":"Management of Guarantees","version":"v6.0.0","description":"API to create, update and manage various types of bank issued guarantees and their associated status and details. Some of the types of guarantees that can be created are bid bonds, performance bonds and trade finance shipping guarantees.","endpointCount":56,"endpoints":[{"method":"GET","path":"/holdings/guarantees/clauses/{clauseId}","fullPath":"/api/v6.0.0/holdings/guarantees/clauses/{clauseId}","operationId":"getClause","name":"Retrieves the guarantee clause details of specific id","summary":"Details of guarantee clause","tags":["CORPORATE"],"parameters":[{"name":"clauseId","in":"path","type":"string","required":true,"description":"Represents id of MD.CLAUSES. Id can be used in MD application and description is automatically populated in the deal.Records created for customer specific clauses, to have ID beginning with the custom"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"ClauseResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"POST","path":"/holdings/guarantees/clauses/{clauseId}","fullPath":"/api/v6.0.0/holdings/guarantees/clauses/{clauseId}","operationId":"createClause","name":"Creates the guarantee clause for a specific customer","summary":"Create guarantee clause","tags":["CORPORATE"],"parameters":[{"name":"clauseId","in":"path","type":"string","required":true,"description":"Represents id of MD.CLAUSES. Id can be used in MD application and description is automatically populated in the deal.Records created for customer specific clauses, to have ID beginning with the custom"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"mdClausesDescriptions":[{}],"mdClausesDisplayName":"string","extensions":{}}},"responses":{"200":"ClauseResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/holdings/guarantees/clauses/{clauseId}","fullPath":"/api/v6.0.0/holdings/guarantees/clauses/{clauseId}","operationId":"updateClause","name":"Updates the guarantee clause for the specific id","summary":"Update guarantee clause","tags":["CORPORATE"],"parameters":[{"name":"clauseId","in":"path","type":"string","required":true,"description":"Represents id of MD.CLAUSES. Id can be used in MD application and description is automatically populated in the deal.Records created for customer specific clauses, to have ID beginning with the custom"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"mdClausesDescriptions":[{}],"mdClausesDisplayName":"string","extensions":{}}},"responses":{"200":"ClauseResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"DELETE","path":"/holdings/guarantees/clauses/{clauseId}","fullPath":"/api/v6.0.0/holdings/guarantees/clauses/{clauseId}","operationId":"deleteClause","name":"Removes the guarantee clause request","summary":"Remove guarantee clause","tags":["CORPORATE"],"parameters":[{"name":"clauseId","in":"path","type":"string","required":true,"description":"Represents id of MD.CLAUSES. Id can be used in MD application and description is automatically populated in the deal.Records created for customer specific clauses, to have ID beginning with the custom"},{"name":"payload","in":"body","type":"object","required":false,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}}},"responses":{"200":"ClauseResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/holdings/guarantees/requests","fullPath":"/api/v6.0.0/holdings/guarantees/requests","operationId":"getGuaranteeIssuanceRequests","name":"Retrieves the list of guarantee initiation request details","summary":"Retrieves the guarantee initiation requests","tags":["CORPORATE"],"parameters":[{"name":"mdIbRequestId","in":"query","type":"string","required":false,"description":"The guarantees issuance id initiated by internet banking"},{"name":"customerId","in":"query","type":"string","required":false,"description":"Identifier of the customer"},{"name":"ibEventStatus","in":"query","type":"string","required":false,"description":"Specifies the status of the guarantee issuance request."},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it Retrieves all the data"}],"requestBodyExample":null,"responses":{"200":"GuaranteeIssuanceRequestsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"POST","path":"/holdings/guarantees/requests","fullPath":"/api/v6.0.0/holdings/guarantees/requests","operationId":"createIbRequest","name":"Creates the guarantee initiation request from internet banking","summary":"Create guarantee initiation request","tags":["CORPORATE"],"parameters":[{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"beneficiaryIds":[{}],"guarantees":[{}],"documentDetails":[{}],"limits":[{}],"messageFromBanks":[{}],"messageFromCustomers":[{}],"information":[{}],"amendmentDetails":[{}],"overrides":[{}],"customerId":"string","currencyId":"string","principalAmount":0.0,"startDate":"2024-01-01","maturityDate":"2024-01-01","categoryName":"string"}},"responses":{"200":"IbRequestResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/holdings/guarantees/requests/{requestId}","fullPath":"/api/v6.0.0/holdings/guarantees/requests/{requestId}","operationId":"getIbRequest","name":"Retrieves the guarantee initiation request details for specific id","summary":"Details of guarantee initiation request","tags":["CORPORATE"],"parameters":[{"name":"requestId","in":"path","type":"string","required":true,"description":"The guarantees issuance id initiated by internet banking"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"IbRequestResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/holdings/guarantees/requests/{requestId}","fullPath":"/api/v6.0.0/holdings/guarantees/requests/{requestId}","operationId":"updateIbRequest","name":"Updates the existing guarantee initiation request for a customer","summary":"Update guarantee initiation request","tags":["CORPORATE"],"parameters":[{"name":"requestId","in":"path","type":"string","required":true,"description":"The guarantees issuance id initiated by internet banking"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"beneficiaryIds":[{}],"guarantees":[{}],"documentDetails":[{}],"limits":[{}],"messageFromBanks":[{}],"messageFromCustomers":[{}],"information":[{}],"amendmentDetails":[{}],"overrides":[{}],"customerId":"string","currencyId":"string","principalAmount":0.0,"startDate":"2024-01-01","maturityDate":"2024-01-01","categoryName":"string"}},"responses":{"200":"IbRequestResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"DELETE","path":"/holdings/guarantees/requests/{requestId}","fullPath":"/api/v6.0.0/holdings/guarantees/requests/{requestId}","operationId":"deleteIbRequest","name":"Removes the existing guarantee initiation request","summary":"Remove guarantee initiation request","tags":["CORPORATE"],"parameters":[{"name":"requestId","in":"path","type":"string","required":true,"description":"The guarantees issuance id initiated by internet banking"},{"name":"payload","in":"body","type":"object","required":false,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}}},"responses":{"200":"IbRequestResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/holdings/guarantees/guaranteesApprovals/{requestId}","fullPath":"/api/v6.0.0/holdings/guarantees/guaranteesApprovals/{requestId}","operationId":"approveGuarantee","name":"Approves the guarantee initiation request","summary":"Approve guarantee initiation request","tags":["CORPORATE"],"parameters":[{"name":"requestId","in":"path","type":"string","required":true,"description":"The guarantees issuance id initiated by internet banking"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"GuaranteeResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"DELETE","path":"/holdings/guarantees/cancellations/{requestId}","fullPath":"/api/v6.0.0/holdings/guarantees/cancellations/{requestId}","operationId":"rejectGuarantee","name":"Reject the guarantee initiation request","summary":"Reject guarantee initiation request","tags":["CORPORATE"],"parameters":[{"name":"requestId","in":"path","type":"string","required":true,"description":"The guarantees issuance id initiated by internet banking"},{"name":"payload","in":"body","type":"object","required":false,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}}},"responses":{"200":"GuaranteeResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/holdings/guarantees/{guaranteeId}/receivedGuarantees","fullPath":"/api/v6.0.0/holdings/guarantees/{guaranteeId}/receivedGuarantees","operationId":"getReceivedGuaranteeHistory","name":"Retrieves the received guarantee requests for the customer ","summary":"Retrieves received guarantee requests","tags":["CORPORATE"],"parameters":[{"name":"guaranteeId","in":"path","type":"string","required":true,"description":"Identifier of the guarantee"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it Retrieves all the data"}],"requestBodyExample":null,"responses":{"200":"ReceivedGuaranteeHistoryResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/guarantees/clauses","fullPath":"/api/v6.0.0/holdings/guarantees/clauses","operationId":"getGuaranteeClauses","name":"Retrieves the list of guarantee clause requests for specific customer","summary":"Retrieves the guarantee clause requests","tags":["CORPORATE"],"parameters":[{"name":"clauseId","in":"query","type":"string","required":false,"description":"Represents id of MD.CLAUSES. Id can be used in MD application and description is automatically populated in the deal.Records created for customer specific clauses, to have ID beginning with the custom"},{"name":"customerId","in":"query","type":"string","required":false,"description":"Identifier of the customer"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it Retrieves all the data"}],"requestBodyExample":null,"responses":{"200":"GuaranteeClausesResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/guarantees/receivedGuarantees/amendments","fullPath":"/api/v6.0.0/holdings/guarantees/receivedGuarantees/amendments","operationId":"getReceivedGuaranteesAmendments","name":"Retrieves the list of amended guarantee requests","summary":"Retrieves the amended guarantee requests","tags":["CORPORATE"],"parameters":[{"name":"alternateId","in":"query","type":"string","required":false,"description":"An Alternate Identification for the Deal. This can be used to retrieve the Deal for amendment."},{"name":"contractType","in":"query","type":"string","required":false,"description":"Indicates if the position is related to Loan, Deposit ,FX-Forward/FX-Swap"},{"name":"customerId","in":"query","type":"string","required":false,"description":"Identifier of the customer"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it Retrieves all the data"}],"requestBodyExample":null,"responses":{"200":"ReceivedGuaranteesAmendmentsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/guarantees/{guaranteeId}/invocations","fullPath":"/api/v6.0.0/holdings/guarantees/{guaranteeId}/invocations","operationId":"getClaimInvocationHistory","name":"Retrieves the list of guarantee claim invocation details","summary":"Retrieves the guarantee claim invocation details","tags":["CORPORATE"],"parameters":[{"name":"guaranteeId","in":"path","type":"string","required":true,"description":"Identifier of the guarantee"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it Retrieves all the data"}],"requestBodyExample":null,"responses":{"200":"ClaimInvocationHistoryResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/guarantees/receivedClaims","fullPath":"/api/v6.0.0/holdings/guarantees/receivedClaims","operationId":"getReceivedGuaranteeClaims","name":"Retrieves the list of received guarantee claim for a customer","summary":"Retrieves the received guarantee claims","tags":["CORPORATE"],"parameters":[{"name":"customerId","in":"query","type":"string","required":false,"description":"Identifier of the customer"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it Retrieves all the data"}],"requestBodyExample":null,"responses":{"200":"ReceivedGuaranteeClaimsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/guarantees/amendments","fullPath":"/api/v6.0.0/holdings/guarantees/amendments","operationId":"getGuaranteeAmendments","name":"Retrieves the list of amended guarantee requests for specific customer","summary":"Retrieves guarantee amendment requests","tags":["CORPORATE"],"parameters":[{"name":"customerId","in":"query","type":"string","required":false,"description":"Identifier of the customer"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it Retrieves all the data"}],"requestBodyExample":null,"responses":{"200":"GuaranteeAmendmentsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/guarantees/issuedGuarantees","fullPath":"/api/v6.0.0/holdings/guarantees/issuedGuarantees","operationId":"getIssuedGuarantees","name":"Retrieves the list of issued guarantee request details for specific customer","summary":"Retrieves the issued guarantee details","tags":["CORPORATE"],"parameters":[{"name":"customerId","in":"query","type":"string","required":false,"description":"Identifier of the customer"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it Retrieves all the data"}],"requestBodyExample":null,"responses":{"200":"IssuedGuaranteesResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/guarantees/limits","fullPath":"/api/v6.0.0/holdings/guarantees/limits","operationId":"getGuaranteeLimits","name":"Retrieves the list of guarantees limit details","summary":"Retrieves the guarantee limits","tags":["CORPORATE"],"parameters":[{"name":"customerId","in":"query","type":"string","required":false,"description":"Identifier of the customer"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it Retrieves all the data"}],"requestBodyExample":null,"responses":{"200":"GuaranteeLimitsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/guarantees/issuedClaims","fullPath":"/api/v6.0.0/holdings/guarantees/issuedClaims","operationId":"getIssuedGuaranteeClaims","name":"Retrieves the list of received guarantee claim details","summary":"Retrieves the received guarantee claims","tags":["CORPORATE"],"parameters":[{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it Retrieves all the data"}],"requestBodyExample":null,"responses":{"200":"IssuedGuaranteeClaimsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/guarantees","fullPath":"/api/v6.0.0/holdings/guarantees","operationId":"getGuarantees","name":"Retrieves the list of guarantee details","summary":"Retrieves the guarantee details","tags":["CORPORATE"],"parameters":[{"name":"guaranteeId","in":"query","type":"string","required":false,"description":"Identifier of the guarantee"},{"name":"beneficiaryCustomerId","in":"query","type":"string","required":false,"description":"Identifies the Customer who is to be the ultimate receiver of the funds transferred by the sending bank when this Beneficiary is not a bank."},{"name":"contractType","in":"query","type":"string","required":false,"description":"Indicates if the position is related to Loan, Deposit ,FX-Forward/FX-Swap"},{"name":"ibRequestId","in":"query","type":"string","required":false,"description":"The guarantees issuance id initiated by internet banking"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it Retrieves all the data"}],"requestBodyExample":null,"responses":{"200":"GuaranteesResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"POST","path":"/holdings/guarantees","fullPath":"/api/v6.0.0/holdings/guarantees","operationId":"createGuaranteeGeneric","name":"Creates a generic guarantee for the requested customer reference number","summary":"Creates a generic guarantee","tags":["CORPORATE"],"parameters":[{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"beneficiaryIds":[{}],"beneficiaryAddresses":[{}],"charges":[{}],"bankAddresses":[{}],"detailsOfGuarantee":[{}],"guaranteeReference":"string","customerId":"string","currency":"string","amount":0.0,"dealDate":"2024-01-01","startDate":"2024-01-01","expiryDate":"2024-01-01","maturityDate":"2024-01-01","limitReference":"string","termsAndConditions":"string"}},"responses":{"200":"GuaranteeGenericResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/holdings/customers/{customerId}/guarantees/outstandings","fullPath":"/api/v6.0.0/holdings/customers/{customerId}/guarantees/outstandings","operationId":"getGuaranteesOutstandings","name":"Retrieves the detailed information on issued guarantees for the specified customer/guarantee reference","summary":"Retrieves outstanding guarantees","tags":["CORPORATE"],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"Identifier of the customer"},{"name":"transactionReference","in":"query","type":"string","required":false,"description":"Contains the identifier for the transaction in the core system"},{"name":"guaranteeType","in":"query","type":"string","required":false,"description":"Refers to the type of the contract that is being issued."},{"name":"currency","in":"query","type":"string","required":false,"description":"Identifies the currency. E.g. USD, GBP etc"},{"name":"amount","in":"query","type":"string","required":false,"description":"This is the payment amount"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it Retrieves all the data"}],"requestBodyExample":null,"responses":{"200":"GuaranteesOutstandingsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/customers/{customerId}/guarantees/expiries","fullPath":"/api/v6.0.0/holdings/customers/{customerId}/guarantees/expiries","operationId":"getGuaranteeExpiringWithDate","name":"Retrieves the expiring guarantees details for the specified customer/guarantee reference ","summary":"Retrieves expiring guarantees","tags":["CORPORATE"],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"Identifier of the customer"},{"name":"transactionReference","in":"query","type":"string","required":false,"description":"Contains the identifier for the transaction in the core system"},{"name":"currency","in":"query","type":"string","required":false,"description":"Identifies the currency. E.g. USD, GBP etc"},{"name":"amount","in":"query","type":"string","required":false,"description":"This is the payment amount"},{"name":"maturityDate","in":"query","type":"string","required":false,"description":"Indicates maturity date of the contract"},{"name":"gteeReturnDate","in":"query","type":"string","required":false,"description":"Date on which the original Guarantee will be returned by the customer to the Bank that issued it"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it Retrieves all the data"}],"requestBodyExample":null,"responses":{"200":"GuaranteeExpiringWithDateResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/customers/{customerId}/guarantees/outstandingClaims","fullPath":"/api/v6.0.0/holdings/customers/{customerId}/guarantees/outstandingClaims","operationId":"getClaimOutstandingUnderGuarantees","name":"Retrieves the list of corporate miscellaneous deals for the customer.","summary":"Retrieves outstanding guarantee claims","tags":["CORPORATE"],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"Identifier of the customer"},{"name":"transactionReference","in":"query","type":"string","required":false,"description":"Contains the identifier for the transaction in the core system"},{"name":"currency","in":"query","type":"string","required":false,"description":"Identifies the currency. E.g. USD, GBP etc"},{"name":"amount","in":"query","type":"string","required":false,"description":"This is the payment amount"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it Retrieves all the data"}],"requestBodyExample":null,"responses":{"200":"ClaimOutstandingUnderGuaranteesResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/customers/{customerId}/guarantees/cancellations","fullPath":"/api/v6.0.0/holdings/customers/{customerId}/guarantees/cancellations","operationId":"getGuaranteesReversed","name":"Retrieves the list of cancelled guarantees for the specified customer/guarantee reference","summary":"Retrieves list of cancelled guarantees","tags":["CORPORATE"],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"Identifier of the customer"},{"name":"transactionReference","in":"query","type":"string","required":false,"description":"Contains the identifier for the transaction in the core system"},{"name":"guaranteeType","in":"query","type":"string","required":false,"description":"Refers to the type of the contract that is being issued."},{"name":"currency","in":"query","type":"string","required":false,"description":"Identifies the currency. E.g. USD, GBP etc"},{"name":"amount","in":"query","type":"string","required":false,"description":"This is the payment amount"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it Retrieves all the data"}],"requestBodyExample":null,"responses":{"200":"GuaranteesReversedResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/guarantees/{guaranteeId}/issuedClaims","fullPath":"/api/v6.0.0/holdings/guarantees/{guaranteeId}/issuedClaims","operationId":"getClaimsPaidUnderGuarantee","name":"Retrieves the list of issued guarantees paid/cancelled for the specified customer/guarantee reference.","summary":"Retrieves paid/cancelled details of issued guarantees","tags":["CORPORATE"],"parameters":[{"name":"guaranteeId","in":"path","type":"string","required":true,"description":""},{"name":"transactionReference","in":"query","type":"string","required":false,"description":"Contains the identifier for the transaction in the core system"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it Retrieves all the data"}],"requestBodyExample":null,"responses":{"200":"ClaimsPaidUnderGuaranteeResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/guarantees/{guaranteeId}/shippings/outstandings","fullPath":"/api/v6.0.0/holdings/guarantees/{guaranteeId}/shippings/outstandings","operationId":"getOutstandingShippingGuarantees","name":"Retrieves the details of outstanding shipping guarantees for the specified customer/guarantee reference.","summary":"Retrieves list of outstanding shipping guarantees","tags":["CORPORATE"],"parameters":[{"name":"guaranteeId","in":"path","type":"string","required":true,"description":""},{"name":"transactionReference","in":"query","type":"string","required":false,"description":"Contains the identifier for the transaction in the core system"},{"name":"lCReference","in":"query","type":"string","required":false,"description":"Indicates the LC reference under which the guarantee is to be opened"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it Retrieves all the data"}],"requestBodyExample":null,"responses":{"200":"OutstandingShippingGuaranteesResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/customers/{customerId}/guarantees/receivedOutstandings","fullPath":"/api/v6.0.0/holdings/customers/{customerId}/guarantees/receivedOutstandings","operationId":"getOutstandingReceivedGuarantees","name":"Retrieves the details of outstanding received guarantees for the specified customer/guarantee reference.","summary":"Retrieves outstanding received guarantees details","tags":["CORPORATE"],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"Identifier of the customer"},{"name":"guaranteeId","in":"query","type":"string","required":false,"description":"Identifier of the guarantee"},{"name":"guaranteeType","in":"query","type":"string","required":false,"description":"Refers to the type of the contract that is being issued."},{"name":"formOfUndertaking","in":"query","type":"string","required":false,"description":"It specifies the form of the independent and irrevocable undertaking. The undertaking cycle is determined based on the value provided here.Possible values are, DGAR \u00e2\u20ac\u201c The undertaking takes the form "},{"name":"principalAmount","in":"query","type":"string","required":false,"description":"Indicates the principal amount of the loan or a deposit"},{"name":"currency","in":"query","type":"string","required":false,"description":"Identifies the currency. E.g. USD, GBP etc"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it Retrieves all the data"}],"requestBodyExample":null,"responses":{"200":"OutstandingReceivedGuaranteesResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"POST","path":"/holdings/guarantee/performanceBonds","fullPath":"/api/v6.0.0/holdings/guarantee/performanceBonds","operationId":"createGuaranteesPerformanceBond","name":"Creates performance bond guarantee for the requested customer reference number","summary":"Creates performance bond guarantee","tags":["CORPORATE"],"parameters":[{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"beneficiaryIds":[{}],"beneficiaryaddresses":[{}],"charges":[{}],"bankAddresses":[{}],"detailsOfGuarantee":[{}],"performanceBondReference":"string","customerId":"string","currency":"string","amount":0.0,"dealDate":"2024-01-01","valueDate":"2024-01-01","expiryDate":"2024-01-01","maturityDate":"2024-01-01","termsAndConditions":"string","eventsProcessing":"string"}},"responses":{"200":"GuaranteesPerformanceBondResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"POST","path":"/holdings/guarantees/letterOfCredits/standBys","fullPath":"/api/v6.0.0/holdings/guarantees/letterOfCredits/standBys","operationId":"createGuaranteesStandbyLC","name":"Creates standby letter of credit guarantee for the requested customer reference number","summary":"Creates standby letter of credit guarantee","tags":["CORPORATE"],"parameters":[{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"beneficiaryIds":[{}],"beneficiaryAddresses":[{}],"charges":[{}],"bankAddresses":[{}],"detailsOfGuarantee":[{}],"standByImportLC":"string","customerId":"string","currency":"string","amount":0.0,"dealDate":"2024-01-01","valueDate":"2024-01-01","expiryDate":"2024-01-01","maturityDate":"2024-01-01","termsAndConditions":"string","eventsProcessing":"string"}},"responses":{"200":"GuaranteesStandbyLCResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"POST","path":"/holdings/guarantees/letterOfCredits/shippings","fullPath":"/api/v6.0.0/holdings/guarantees/letterOfCredits/shippings","operationId":"createShippingGuaranteeUnderLC","name":"Creates shipping guarantees under letter of credit for the requested customer reference number","summary":"Creates shipping guarantees under letter of credit","tags":["CORPORATE"],"parameters":[{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"beneficiaryIds":[{}],"beneficiaryAddresses":[{}],"charges":[{}],"bankAddresses":[{}],"detailsOfGuarantee":[{}],"internalReference":"string","customerId":"string","currency":"string","amount":0.0,"dealDate":"2024-01-01","valueDate":"2024-01-01","maturityDate":"2024-01-01","termsAndConditions":"string","eventsProcessing":"string","autoExpiry":"string"}},"responses":{"200":"ShippingGuaranteeUnderLCResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"POST","path":"/holdings/guarantees/letterOfCredits/shippings/collections","fullPath":"/api/v6.0.0/holdings/guarantees/letterOfCredits/shippings/collections","operationId":"createShippingGuaranteeUnderCollection","name":"Creates shipping guarantee under collection letter of credit for the requested customer reference number","summary":"Creates shipping guarantee under collection letter of credit","tags":["CORPORATE"],"parameters":[{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"beneficiaryId":[{}],"beneficiaryAddresses":[{}],"charges":[{}],"bankAddresses":[{}],"detailsOfGuarantee":[{}],"shippingGuaranteeReference":"string","customerId":"string","currency":"string","amount":0.0,"dealDate":"2024-01-01","valueDate":"2024-01-01","maturityDate":"2024-01-01","termsAndConditions":"string","eventsProcessing":"string","autoExpiry":"string"}},"responses":{"200":"ShippingGuaranteeUnderCollectionResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/holdings/guarantees/{guaranteeId}/receivedClaims","fullPath":"/api/v6.0.0/holdings/guarantees/{guaranteeId}/receivedClaims","operationId":"getInvocationPaidOrCancelled","name":"Retrieves the list of received guarantees paid/cancelled for the specified customer/guarantee reference","summary":"Retrieves paid/cancelled details of received guarantees","tags":["CORPORATE"],"parameters":[{"name":"guaranteeId","in":"path","type":"string","required":true,"description":""},{"name":"transactionReference","in":"query","type":"string","required":false,"description":"Contains the identifier for the transaction in the core system"},{"name":"beneficiary","in":"query","type":"string","required":false,"description":"Beneficiary information"},{"name":"debitAccountId","in":"query","type":"string","required":false,"description":"Indicates the debit account number of the payment or transaction."},{"name":"creditAccountId","in":"query","type":"string","required":false,"description":"Credit account identifier of the payment or transaction"},{"name":"amount","in":"query","type":"string","required":false,"description":"This is the payment amount"},{"name":"debitValueDate","in":"query","type":"string","required":false,"description":"Date on which the amount will be debited for settlement"},{"name":"creditValueDate","in":"query","type":"string","required":false,"description":"Reference quoted by the credit account for a payment"},{"name":"correspondentBank","in":"query","type":"string","required":false,"description":"Correspondent bank, where our nostro account is held."},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it Retrieves all the data"}],"requestBodyExample":null,"responses":{"200":"InvocationPaidOrCancelledResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"POST","path":"/holdings/guarantees/bidBonds","fullPath":"/api/v6.0.0/holdings/guarantees/bidBonds","operationId":"createGuarnteeBidBond","name":"Creates bid bond guarantee for the requested customer reference number","summary":"Creates bid bond guarantee","tags":["CORPORATE"],"parameters":[{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"beneficiaryIds":[{}],"beneficiaryAddresses":[{}],"charges":[{}],"bankAddresses":[{}],"detailsOfGuarantee":[{}],"bidBondReference":"string","customerId":"string","currency":"string","amount":0.0,"dealDate":"2024-01-01","valueDate":"2024-01-01","expiryDate":"2024-01-01","maturityDate":"string","termsAndConditions":"string","eventsProcessing":"string"}},"responses":{"200":"GuarnteeBidBondResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"POST","path":"/holdings/guarantees/{guaranteeId}/rejectedClaims","fullPath":"/api/v6.0.0/holdings/guarantees/{guaranteeId}/rejectedClaims","operationId":"updateGuaranteesRejection","name":"Updates the rejection of claim for the specified guarantee/customer reference number","summary":"Updates the rejection of claim for a guarantee","tags":["CORPORATE"],"parameters":[{"name":"guaranteeId","in":"path","type":"string","required":true,"description":""},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"beneficiaryIds":[{}],"beneficairyAddresses":[{}],"guaranteeReference":"string","guaranteeType":"string","customerId":"string","limitReference":"string","currency":"string","amount":"string","startDate":"string","maturityDate":"string","autoExpiry":"string","onlineMaturity":"string","eventsProcessing":"string","liquidationMode":"string","claimRegisterDate":"string"}},"responses":{"200":"GuaranteesRejectionResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"POST","path":"/holdings/guarantees/{guaranteeId}","fullPath":"/api/v6.0.0/holdings/guarantees/{guaranteeId}","operationId":"updateGuaranteesAmendment","name":"Updates additional guarantee information for the specified  customer/guarantee reference number","summary":"Updates guarantee details","tags":["CORPORATE"],"parameters":[{"name":"guaranteeId","in":"path","type":"string","required":true,"description":""},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"BeneficiaryIds":[{}],"BeneficiaryAddresses":[{}],"pincipalMovements":[{}],"texts":[{}],"guarantees":[{}],"ibClaimNarratives":[{}],"charges":[{}],"bankAddresses":[{}],"detailsOfGuarantee":[{}],"guaranteeReference":"string","customerReference":"string","customerId":"string","guaranteeType":"string","productCategoryId":"string","currency":"string"}},"responses":{"200":"GuaranteesAmendmentResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"POST","path":"/holdings/guarantees/issuances/requests/initiations","fullPath":"/api/v6.0.0/holdings/guarantees/issuances/requests/initiations","operationId":"initiateIssuance","name":"Initiates guarantee issuance request through self service channel for the corporate user","summary":"Initiates new guarantee issuance","tags":["CORPORATE"],"parameters":[{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"guaranteeDetail":[{}],"beneficiaries":[{}],"charges":[{}],"commission":[{}],"undertakingIssued":[{}],"formOfUndertaking":"string","currency":"string","valueDate":"string","expiryType":"string","adviceExpiryDate":"string","applicableRule":"string","advisingBank":"string","marginDebitAccount":"string","guaranteeType":"string","category":"string"}},"responses":{"200":"IssuanceResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/holdings/guarantees/issuances/requests/{requestId}","fullPath":"/api/v6.0.0/holdings/guarantees/issuances/requests/{requestId}","operationId":"updateIssuance","name":"Updates the details of the guarantee request which are mandated for the issuing by the issuing bank","summary":"Facilitates the updation of the Guarantee which is initiated for a customer","tags":["CORPORATE"],"parameters":[{"name":"requestId","in":"path","type":"string","required":true,"description":"The guarantees issuance id initiated by internet banking"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"guaranteeDetail":[{}],"applicantCustomers":[{}],"charges":[{}],"commission":[{}],"commissionType":[{}],"beneficiaryAddresses":[{}],"beneficiaries":[{}],"senderReceiversInfoMT730":[{}],"undertakingIssued":[{}],"counterparty":[{}],"counterpartyBeneficiaries":[{}],"comments":[{}],"guaranteeReference":"string","guaranteeType":"string","advisingBank":"string"}},"responses":{"200":"IssuanceResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"DELETE","path":"/holdings/guarantees/issuances/requests/{requestId}","fullPath":"/api/v6.0.0/holdings/guarantees/issuances/requests/{requestId}","operationId":"reverseIssuance","name":"Reverse the existing guarantee file issued by the issuing bank on behalf of a corporate customer","summary":"Enables the option to reverse the existing guarantee for a customer","tags":["CORPORATE"],"parameters":[{"name":"requestId","in":"path","type":"string","required":true,"description":"The guarantees issuance id initiated by internet banking"},{"name":"payload","in":"body","type":"object","required":false,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}}},"responses":{"200":"IssuanceResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/holdings/guarantees/issuances/requests/{requestId}/rejections","fullPath":"/api/v6.0.0/holdings/guarantees/issuances/requests/{requestId}/rejections","operationId":"rejectClaimIssuance","name":"Reject response of a claim received by the issuing bank to the beneficiary bank","summary":"Captures the values for the the rejection of claim for a guarantee issued","tags":["CORPORATE"],"parameters":[{"name":"requestId","in":"path","type":"string","required":true,"description":"The guarantees issuance id initiated by internet banking"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"beneficiaries":[{}],"beneficiaryAddresses":[{}],"guaranteeDetail":[{}],"internetBankingClaimNarratives":[{}],"narratives":[{}],"senderToReceiverInfos":[{}],"comments":[{}],"guaranteeReference":"string","guaranteeType":"string","maturityDate":"2024-01-01","currency":"string","invocationAmount":0.0,"advisingBank":"string","claimRegisterDate":"2024-01-01","formOfUndertaking":"string"}},"responses":{"200":"ClaimIssuanceResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/holdings/guarantees/issuances/requests/{requestId}/amendments/confirmations","fullPath":"/api/v6.0.0/holdings/guarantees/issuances/requests/{requestId}/amendments/confirmations","operationId":"approveIssuance","name":"Approves  the amendment response received from the corporate user for the received guarantees for a corporate customer","summary":"Enables to capture the approval for the amendment response for the incoming amendments","tags":["CORPORATE"],"parameters":[{"name":"requestId","in":"path","type":"string","required":true,"description":"The guarantees issuance id initiated by internet banking"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"rejectionReasons":[{}],"additionalInformations":[{}],"comments":[{}],"amendmentStatus":"string","amendmentNumber":"string","extensions":{}}},"responses":{"200":"IssuanceResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/holdings/guarantees/issuances/requests","fullPath":"/api/v6.0.0/holdings/guarantees/issuances/requests","operationId":"getIssuance","name":"Retrieves the list of issued guarantees by the issuing bank for any corporate customer","summary":"Enables to retrieve the list of issued guarantees outstanding","tags":["CORPORATE"],"parameters":[{"name":"beneficiary","in":"query","type":"string","required":false,"description":"Beneficiary information"},{"name":"contractType","in":"query","type":"string","required":false,"description":"Indicates if the position is related to Loan, Deposit ,FX-Forward/FX-Swap"},{"name":"guaranteeId","in":"query","type":"string","required":false,"description":"Identifier of the guarantee"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it Retrieves all the data"}],"requestBodyExample":null,"responses":{"200":"IssuanceResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"POST","path":"/holdings/guarantees/issuances/requests","fullPath":"/api/v6.0.0/holdings/guarantees/issuances/requests","operationId":"createIssuance","name":"Initiation of  a guarantee issuance request by the issuing bank for the applicant or the instructing party.","summary":"Facilitates the creation of guarantee issuance for a customer","tags":["CORPORATE"],"parameters":[{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"guaranteeDetail":[{}],"applicantCustomers":[{}],"charges":[{}],"commission":[{}],"commissionType":[{}],"beneficiaryAddresses":[{}],"beneficiaries":[{}],"senderReceiversInfoMT730":[{}],"undertakingIssued":[{}],"counterparty":[{}],"counterpartyBeneficiaries":[{}],"comments":[{}],"guaranteeReference":"string","guaranteeType":"string","advisingBank":"string"}},"responses":{"200":"IssuanceResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/holdings/guarantees/issuances/amendments","fullPath":"/api/v6.0.0/holdings/guarantees/issuances/amendments","operationId":"getAmendmentsIssuance","name":"Retrieves the list of amendments and the details for  an issued guarantee by the issuing bank","summary":"Retrieves the list of amendment history for the issued guarantees for a corporate customer","tags":["CORPORATE"],"parameters":[{"name":"customerId","in":"query","type":"string","required":false,"description":"Identifier of the customer"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it Retrieves all the data"}],"requestBodyExample":null,"responses":{"200":"AmendmentsIssuanceResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"PUT","path":"/holdings/guarantees/issuances/requests/{requestId}/claims","fullPath":"/api/v6.0.0/holdings/guarantees/issuances/requests/{requestId}/claims","operationId":"updateClaimIssuance","name":"Updates the received claim details sent by the beneficiary to the issued guarantee request","summary":"Facilitates in updating the details of a claim for the guarantee issuance","tags":["CORPORATE"],"parameters":[{"name":"requestId","in":"path","type":"string","required":true,"description":"The guarantees issuance id initiated by internet banking"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"senderToReceiverInfoS":[{}],"beneficiaryIdS":[{}],"beneficiaryAddresses":[{}],"applicationIds":[{}],"narratives":[{}],"statementNarratives":[{}],"claimDebitAccount":"string","chargeBearer":"string","claimPaymentMethod":"string","claimCreditAccount":"string","autoExpiry":"string","guaranteeReference":"string","guaranteeType":"string","maturityDate":"string","currency":"string"}},"responses":{"200":"ClaimIssuanceResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/holdings/guarantees/issuances/requests/{requestId}/amendments","fullPath":"/api/v6.0.0/holdings/guarantees/issuances/requests/{requestId}/amendments","operationId":"amendIssuance","name":"Amendment of the terms and conditions of the guarantee after issuance by the issuing bank and notifying the parties in the guarantee","summary":"Facilitates the updation of  the existing guarantee initiation for a customer","tags":["CORPORATE"],"parameters":[{"name":"requestId","in":"path","type":"string","required":true,"description":"The guarantees issuance id initiated by internet banking"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"guaranteeDetails":[{}],"charges":[{}],"commission":[{}],"amendmentDetail":[{}],"counterparties":[{}],"reimbursingBankReferences":[{}],"newCreditTolerance":"string","newDebitTolerances":"string","externalReference":"string","increaseDecreaseAmount":"string","adviceExpiryDate":"string","comments":"string","extensions":{}}},"responses":{"200":"IssuanceResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/holdings/guarantees/issuances/extensions","fullPath":"/api/v6.0.0/holdings/guarantees/issuances/extensions","operationId":"getAutoExtensionDetails","name":"Retrieves a list of guarantees for which auto extension is enabled","summary":"Retrieves guarantees subject to auto extension","tags":["CORPORATE"],"parameters":[{"name":"guaranteeType","in":"query","type":"string","required":false,"description":"Refers to the type of the contract that is being issued."},{"name":"guaranteeId","in":"query","type":"string","required":false,"description":"Identifier of the guarantee"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it Retrieves all the data"}],"requestBodyExample":null,"responses":{"200":"AutoExtensionDetailsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"PUT","path":"/holdings/guarantees/receipts/requests/{requestId}","fullPath":"/api/v6.0.0/holdings/guarantees/receipts/requests/{requestId}","operationId":"updateStatusOfReceipt","name":"Updates the status for the existing guarantee received field by the issuing bank with the concurrence of the beneficiary","summary":"Facilitates in updating  the status for the existing guarantee received","tags":["CORPORATE"],"parameters":[{"name":"requestId","in":"path","type":"string","required":true,"description":"The guarantees issuance id initiated by internet banking"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"comments":[{}],"guaranteeReference":"string","senderToReceiverInfo":"string","extensions":{}}},"responses":{"200":"StatusOfReceiptResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/holdings/guarantees/receipts/requests","fullPath":"/api/v6.0.0/holdings/guarantees/receipts/requests","operationId":"getReceipts","name":"Retrieves the list of issued guarantee claims that are received for the guarantees issued","summary":"Enables to retrieve the list of received guarantees and outstanding","tags":["CORPORATE"],"parameters":[{"name":"guaranteeId","in":"query","type":"string","required":false,"description":"Identifier of the guarantee"},{"name":"guaranteeReference","in":"query","type":"string","required":false,"description":"Another ID for the transaction for retrieval purposes or it can be used for the bank to use a unique guarantee number rather than the system generated ID"},{"name":"beneficiary","in":"query","type":"string","required":false,"description":"Beneficiary information"},{"name":"claimStatus","in":"query","type":"string","required":false,"description":"Status update of the claim records"},{"name":"guaranteeType","in":"query","type":"string","required":false,"description":"Refers to the type of the contract that is being issued."},{"name":"applicantCustomerId","in":"query","type":"string","required":false,"description":"This field identifies the applicant on whose behalf the Letter of Credit is issued, if the applicant is held on the CUSTOMER file."},{"name":"applicantAddress","in":"query","type":"string","required":false,"description":"It indicates the name and address of the party who is engaged in trade agreement with beneficiary. Although the initial values are defaulted from the Customer file, yet they may be altered with an alt"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it Retrieves all the data"}],"requestBodyExample":null,"responses":{"200":"ReceiptsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/guarantees/receipts/amendments","fullPath":"/api/v6.0.0/holdings/guarantees/receipts/amendments","operationId":"getAmendmentsReceipts","name":"Retrieves the list of amendment history details for the received guarantee file for a corporate customer","summary":"Retrieves the list of amendment history for the received guarantees for a corporate customer","tags":["CORPORATE"],"parameters":[{"name":"beneficiary","in":"query","type":"string","required":true,"description":"Beneficiary information"},{"name":"guaranteeId","in":"query","type":"string","required":false,"description":"Identifier of the guarantee"},{"name":"inwardMessageId","in":"query","type":"string","required":false,"description":"This field holds the inward delivery reference for the corresponding message type."},{"name":"inwardPaymentType","in":"query","type":"string","required":false,"description":"To identify the incoming SWIFT payment received direct from Delivery, payments generated by standing orders and local clearing payments."},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it Retrieves all the data"}],"requestBodyExample":null,"responses":{"200":"AmendmentsReceiptsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"PUT","path":"/holdings/guarantees/receipts/requests/{requestId}/rejections","fullPath":"/api/v6.0.0/holdings/guarantees/receipts/requests/{requestId}/rejections","operationId":"rejectClaimReceipt","name":"Updates the rejection of claim for a guarantee received file from the beneficiary bank","summary":"Facilitates the updation of the rejection of claim for a guarantee received","tags":["CORPORATE"],"parameters":[{"name":"requestId","in":"path","type":"string","required":true,"description":"The guarantees issuance id initiated by internet banking"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"beneficiaries":[{}],"beneficiaryAddresses":[{}],"applicationIds":[{}],"narratives":[{}],"decisionReasons":[{}],"comments":[{}],"guaranteeId":"string","guaranteeType":"string","maturityDate":"2024-01-01","currency":"string","invocationAmount":0.0,"advisingBank":"string","claimRegisterDate":"2024-01-01","formOfUndertaking":"string","adviceExpiryDate":"2024-01-01"}},"responses":{"200":"ClaimReceiptResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/holdings/guarantees/receipts/requests/{requestId}/claims/confirmations","fullPath":"/api/v6.0.0/holdings/guarantees/receipts/requests/{requestId}/claims/confirmations","operationId":"updateClaimReceipt","name":"Updates the response for the claim  initiated to guarantee received by the issuing bank","summary":"Facilitates the updation of  the confirmation of claim for the guarantee received","tags":["CORPORATE"],"parameters":[{"name":"requestId","in":"path","type":"string","required":true,"description":"The guarantees issuance id initiated by internet banking"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"senderToReceiverInfoS":[{}],"beneficiaryIdS":[{}],"beneficiaryAddresses":[{}],"applicationIds":[{}],"narratives":[{}],"statementNarratives":[{}],"claimDebitAccount":"string","chargeBearer":"string","claimPaymentMethod":"string","claimCreditAccount":"string","autoExpiry":"string","guaranteeReference":"string","guaranteeType":"string","maturityDate":"string","currency":"string"}},"responses":{"200":"ClaimReceiptResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/holdings/guarantees/receipts/requests/{requestId}/claims","fullPath":"/api/v6.0.0/holdings/guarantees/receipts/requests/{requestId}/claims","operationId":"createClaimReceipts","name":"Facilitates the creation of claim for the guarantee received","summary":"Creates the claim  initiated to guarantee received by the issuing bank","tags":["CORPORATE"],"parameters":[{"name":"requestId","in":"path","type":"string","required":true,"description":"The guarantees issuance id initiated by internet banking"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"claimDetails":[{}],"chargeDetails":[{}],"comments":[{}],"receivingBank":"string","demandType":"string","requestedExpiryDate":"2024-01-01","statementNarrative":"string","senderToReceiverInfo":"string","additionalInformation":"string","demandStatementCode":"string","newExpiryDate":"2024-01-01","invocationStatus":"string","extensions":{}}},"responses":{"200":"ClaimReceiptsResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/holdings/guarantees/receipts/reimbursements","fullPath":"/api/v6.0.0/holdings/guarantees/receipts/reimbursements","operationId":"getReimbursements","name":"Retrieves the details of guarantee clauses","summary":"Retrieves the guarantee clause details","tags":["CORPORATE"],"parameters":[{"name":"guaranteeId","in":"query","type":"string","required":false,"description":"Identifier of the guarantee"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it Retrieves all the data"}],"requestBodyExample":null,"responses":{"200":"ReimbursementsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/guarantees/receipts/claims","fullPath":"/api/v6.0.0/holdings/guarantees/receipts/claims","operationId":"getClaimsReceipt","name":"Retrieves the list of received guarantee claim details that are initiated by the issuing bank ","summary":"Retrieves the list of received guarantee claims","tags":["CORPORATE"],"parameters":[{"name":"guaranteeReference","in":"query","type":"string","required":false,"description":"Another ID for the transaction for retrieval purposes or it can be used for the bank to use a unique guarantee number rather than the system generated ID"},{"name":"guaranteeId","in":"query","type":"string","required":false,"description":"Identifier of the guarantee"},{"name":"beneficiaryId","in":"query","type":"string","required":false,"description":"Indicates the the participant beneficiary account details for cash outflow. Account indicated in the beneficiary will be used to credit participant shares upon borrower repayment. Allowed value should"},{"name":"claimStatus","in":"query","type":"string","required":false,"description":"Status update of the claim records"},{"name":"guaranteeType","in":"query","type":"string","required":false,"description":"Refers to the type of the contract that is being issued."},{"name":"customerId","in":"query","type":"string","required":false,"description":"Identifier of the customer"},{"name":"applicantAddress","in":"query","type":"string","required":false,"description":"It indicates the name and address of the party who is engaged in trade agreement with beneficiary. Although the initial values are defaulted from the Customer file, yet they may be altered with an alt"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"ClaimsReceiptResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}}]},{"key":"holdings-letterOfCredit-service-v1.0.0","title":"Management of Letter of Credits","version":"v1.0.0","description":"API to create, update and manage various types of Trade Finance Letter of Credit (LC) instruments and their associated status and details. Some of the types of LCs that can be created are Sight payments, Back-to-Back, Standby's and Usance LCs","endpointCount":65,"endpoints":[{"method":"POST","path":"/holdings/letterOfCredits/drawingsInitiation/{drawingId}","fullPath":"/api/v1.0.0/holdings/letterOfCredits/drawingsInitiation/{drawingId}","operationId":"createDrawing","name":"Initiate a new drawing request for a specific letter of credit","summary":"Initiate a new drawing request to check the documents for letter of credit","tags":[],"parameters":[{"name":"drawingId","in":"path","type":"string","required":true,"description":"Identifier of drawings application under the Letter of Credit system that is used to effect the transfer of funds and the acceptance of documents under Letters of Credit and Documentary Collection tra"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"chargeAccountIds":[{}],"messageFromBanks":[{}],"messageFromCustomers":[{}],"supportDocuments":[{}],"documentNames":[{}],"consolidatedDiscrepancies":[{}],"presentorIds":[{}],"overrides":[{}],"drawingType":"string","currencyId":"string","documentAmount":0.0,"valueDate":"2024-01-01","debitAccountId":"string","creditAccountId":"string","creditAmount":0.0}},"responses":{"200":"DrawingResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/holdings/letterOfCredits/drawings/{drawingId}","fullPath":"/api/v1.0.0/holdings/letterOfCredits/drawings/{drawingId}","operationId":"getDrawing","name":"Retrieve the details of specific letter of credit drawing","summary":"Overview details of letter of credit drawing","tags":[],"parameters":[{"name":"drawingId","in":"path","type":"string","required":true,"description":"Identifier of drawings application under the Letter of Credit system that is used to effect the transfer of funds and the acceptance of documents under Letters of Credit and Documentary Collection tra"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"DrawingResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/holdings/letterOfCredits/drawings/{drawingId}","fullPath":"/api/v1.0.0/holdings/letterOfCredits/drawings/{drawingId}","operationId":"updateDrawing","name":"Update an existing drawing for a specific letter of credit","summary":"Update drawing details","tags":[],"parameters":[{"name":"drawingId","in":"path","type":"string","required":true,"description":"Identifier of drawings application under the Letter of Credit system that is used to effect the transfer of funds and the acceptance of documents under Letters of Credit and Documentary Collection tra"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"chargeAccountIds":[{}],"messageFromBanks":[{}],"messageFromCustomers":[{}],"supportDocuments":[{}],"documentNames":[{}],"consolidatedDiscrepancies":[{}],"presentorIds":[{}],"overrides":[{}],"drawingType":"string","currencyId":"string","documentAmount":0.0,"valueDate":"2024-01-01","debitAccountId":"string","creditAccountId":"string","creditAmount":0.0}},"responses":{"200":"DrawingResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"DELETE","path":"/holdings/letterOfCredits/drawings/{drawingId}","fullPath":"/api/v1.0.0/holdings/letterOfCredits/drawings/{drawingId}","operationId":"deleteDrawing","name":"Remove an existing drawing for a specific letter of credit","summary":"Remove drawing details","tags":[],"parameters":[{"name":"drawingId","in":"path","type":"string","required":true,"description":"Identifier of drawings application under the Letter of Credit system that is used to effect the transfer of funds and the acceptance of documents under Letters of Credit and Documentary Collection tra"},{"name":"payload","in":"body","type":"object","required":false,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}}},"responses":{"200":"DrawingResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/holdings/letterOfCredits/drawingsApprovals/{drawingId}","fullPath":"/api/v1.0.0/holdings/letterOfCredits/drawingsApprovals/{drawingId}","operationId":"approveDrawing","name":"Approve a drawing  for specific letter of credit","summary":"Approve drawing ","tags":[],"parameters":[{"name":"drawingId","in":"path","type":"string","required":true,"description":"Identifier of drawings application under the Letter of Credit system that is used to effect the transfer of funds and the acceptance of documents under Letters of Credit and Documentary Collection tra"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"DrawingResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/holdings/letterOfCredits/documents/{documentId}","fullPath":"/api/v1.0.0/holdings/letterOfCredits/documents/{documentId}","operationId":"getLcDocument","name":"Retrieves the details of specific letter of credit advice text","summary":"Overview details of letter of credit advice text","tags":[],"parameters":[{"name":"documentId","in":"path","type":"string","required":true,"description":"Based on documentCode, the field defaults the required document codes"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"LcDocumentResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"POST","path":"/holdings/letterOfCredits/documents/{documentId}","fullPath":"/api/v1.0.0/holdings/letterOfCredits/documents/{documentId}","operationId":"createLcDocument","name":"Create a new letter of credit advice text","summary":"Create letter of credit advice text","tags":[],"parameters":[{"name":"documentId","in":"path","type":"string","required":true,"description":"Based on documentCode, the field defaults the required document codes"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"documentDetails":[{}]}},"responses":{"200":"LcDocumentResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/holdings/letterOfCredits/documents/{documentId}","fullPath":"/api/v1.0.0/holdings/letterOfCredits/documents/{documentId}","operationId":"updateLcDocument","name":"Create an existing letter of credit advice text","summary":"Update letter of credit advice text","tags":[],"parameters":[{"name":"documentId","in":"path","type":"string","required":true,"description":"Based on documentCode, the field defaults the required document codes"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"documentDetails":[{}]}},"responses":{"200":"LcDocumentResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"DELETE","path":"/holdings/letterOfCredits/documents/{documentId}","fullPath":"/api/v1.0.0/holdings/letterOfCredits/documents/{documentId}","operationId":"deleteLcDocument","name":"Delete an existing letter of credit advice text","summary":"Delete letter of credit advice text","tags":[],"parameters":[{"name":"documentId","in":"path","type":"string","required":true,"description":"Based on documentCode, the field defaults the required document codes"},{"name":"payload","in":"body","type":"object","required":false,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}}},"responses":{"200":"LcDocumentResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"POST","path":"/holdings/letterOfCredits/{letterOfCreditId}/amendmentsInitiation","fullPath":"/api/v1.0.0/holdings/letterOfCredits/{letterOfCreditId}/amendmentsInitiation","operationId":"createLcAmendment","name":"Initiate a new letter of credit amendment","summary":"Initiate letter of credit amendment","tags":[],"parameters":[{"name":"letterOfCreditId","in":"path","type":"string","required":true,"description":"Identifier of the Letter Of Credit"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"ibLimitExceeds":[{}],"additionalAmountsCovered":[{}],"shipmentPeriods":[{}],"lcAmend":[{}],"messageFromCustomers":[{}],"messageFromBanks":[{}],"overrides":[{}],"lcAmount":0.0,"increaseDecreaseAmount":0.0,"decreaseCreditAmount":0.0,"increaseCreditAmount":0.0,"maximumCreditAmount":"string","newAdviceExpiryDate":"2024-01-01","shipmentDespatch":"string","otherDespatchDetails":"string"}},"responses":{"200":"LcAmendmentResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/holdings/letterOfCredits/{letterOfCreditId}/amendments","fullPath":"/api/v1.0.0/holdings/letterOfCredits/{letterOfCreditId}/amendments","operationId":"getLCAmendments","name":"Retrieves the list of letter of credit amendment details","summary":"Retrieves the letter of credit amendments","tags":[],"parameters":[{"name":"letterOfCreditId","in":"path","type":"string","required":true,"description":"Identifier of the Letter Of Credit"},{"name":"eventStatus","in":"query","type":"string","required":false,"description":"Specifies the status of the request.Allowed values are - With Bank_With Customer_Approved_Rejected."},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"LCAmendmentsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"PUT","path":"/holdings/letterOfCredits/{letterOfCreditId}/amendments","fullPath":"/api/v1.0.0/holdings/letterOfCredits/{letterOfCreditId}/amendments","operationId":"updateLcAmendment","name":"Update an existing amendment for specific letter of credit","summary":"update letter of credit amendment","tags":[],"parameters":[{"name":"letterOfCreditId","in":"path","type":"string","required":true,"description":"Identifier of the Letter Of Credit"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"ibLimitExceeds":[{}],"additionalAmountsCovered":[{}],"shipmentPeriods":[{}],"lcAmend":[{}],"messageFromCustomers":[{}],"messageFromBanks":[{}],"overrides":[{}],"lcAmount":0.0,"increaseDecreaseAmount":0.0,"decreaseCreditAmount":0.0,"increaseCreditAmount":0.0,"maximumCreditAmount":"string","newAdviceExpiryDate":"2024-01-01","shipmentDespatch":"string","otherDespatchDetails":"string"}},"responses":{"200":"LcAmendmentResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"DELETE","path":"/holdings/letterOfCredits/{letterOfCreditId}/amendments","fullPath":"/api/v1.0.0/holdings/letterOfCredits/{letterOfCreditId}/amendments","operationId":"deleteLcAmendment","name":"Remove an existing letter of credit amendment","summary":"Remove letter of credit amendment","tags":[],"parameters":[{"name":"letterOfCreditId","in":"path","type":"string","required":true,"description":"Identifier of the Letter Of Credit"},{"name":"payload","in":"body","type":"object","required":false,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}}},"responses":{"200":"LcAmendmentResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/holdings/letterOfCredits/{letterOfCreditId}/amendmentApprovals","fullPath":"/api/v1.0.0/holdings/letterOfCredits/{letterOfCreditId}/amendmentApprovals","operationId":"approveLcAmendment","name":"Approve an initiated letter of credit amendment ","summary":"Approve letter of credit amendment","tags":[],"parameters":[{"name":"letterOfCreditId","in":"path","type":"string","required":true,"description":"Identifier of the Letter Of Credit"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"LcAmendmentResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/holdings/letterOfCredits/clauses/{clausesId}","fullPath":"/api/v1.0.0/holdings/letterOfCredits/clauses/{clausesId}","operationId":"getLcClause","name":"Retrieves the details of specific letter of credit clause","summary":"Overview details of letter of credit clause","tags":[],"parameters":[{"name":"clausesId","in":"path","type":"string","required":true,"description":"This is the key to the LC.CLAUSES file.During the input of an L/C this code can be entered for the inclusion of standard clauses."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"LcClauseResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"POST","path":"/holdings/letterOfCredits/clauses/{clausesId}","fullPath":"/api/v1.0.0/holdings/letterOfCredits/clauses/{clausesId}","operationId":"createLcClause","name":"Create a new letter of credit clause","summary":"Create a static narrative information for letter of credit","tags":[],"parameters":[{"name":"clausesId","in":"path","type":"string","required":true,"description":"This is the key to the LC.CLAUSES file.During the input of an L/C this code can be entered for the inclusion of standard clauses."},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"narratives":[{}],"lcClausesName":"string"}},"responses":{"200":"LcClauseResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/holdings/letterOfCredits/clauses/{clausesId}","fullPath":"/api/v1.0.0/holdings/letterOfCredits/clauses/{clausesId}","operationId":"updateLcClause","name":"Update an existing letter of credit clause","summary":"Update a static narrative information for letter of credit","tags":[],"parameters":[{"name":"clausesId","in":"path","type":"string","required":true,"description":"This is the key to the LC.CLAUSES file.During the input of an L/C this code can be entered for the inclusion of standard clauses."},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"narratives":[{}],"lcClausesName":"string"}},"responses":{"200":"LcClauseResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"DELETE","path":"/holdings/letterOfCredits/clauses/{clausesId}","fullPath":"/api/v1.0.0/holdings/letterOfCredits/clauses/{clausesId}","operationId":"deleteLcClause","name":"Remove an existing letter of credit clause","summary":"Remove a static narrative information for letter of credit","tags":[],"parameters":[{"name":"clausesId","in":"path","type":"string","required":true,"description":"This is the key to the LC.CLAUSES file.During the input of an L/C this code can be entered for the inclusion of standard clauses."},{"name":"payload","in":"body","type":"object","required":false,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}}},"responses":{"200":"LcClauseResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/holdings/letterOfCredits/{letterOfCreditId}/drawings","fullPath":"/api/v1.0.0/holdings/letterOfCredits/{letterOfCreditId}/drawings","operationId":"getDrawings","name":"Retrieves the list of drawings for specific customer","summary":"Retrieve drawing details","tags":[],"parameters":[{"name":"letterOfCreditId","in":"path","type":"string","required":true,"description":"Identifier of the Letter Of Credit"},{"name":"eventStatus","in":"query","type":"string","required":false,"description":"Specifies the status of the request.Allowed values are - With Bank_With Customer_Approved_Rejected."},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"DrawingsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/customers/{customerId}/letterOfCredits/documents","fullPath":"/api/v1.0.0/holdings/customers/{customerId}/letterOfCredits/documents","operationId":"getLCDocuments","name":"Retrieves the list of letter of credit advice text details","summary":"Retrieves the letter of credit advice text details","tags":[],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"Identifier of the customer"},{"name":"lcAdviceTextId","in":"query","type":"string","required":false,"description":"This is the key to the letter of credit advice text file.During the input of an L/C this code can be entered for the inclusion of standard text."},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"LCDocumentsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/customers/{customerId}/letterOfCredits/clauses","fullPath":"/api/v1.0.0/holdings/customers/{customerId}/letterOfCredits/clauses","operationId":"getLCClauses","name":"Retrieves the list of narrative static information data for use in the mapping and construction of L/C Advices/Documents generated as a result of L/C transactions within the T24 Delivery Application","summary":"Retrieves the letter of credit clause details","tags":[],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"Identifier of the customer"},{"name":"lcClausesId","in":"query","type":"string","required":false,"description":"This is the key to the LC.CLAUSES file.During the input of an L/C this code can be entered for the inclusion of standard clauses."},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"LCClausesResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/letterOfCredits/incoTerms","fullPath":"/api/v1.0.0/holdings/letterOfCredits/incoTerms","operationId":"getIncoTerms","name":"Retrieves the list of letter of credit enrichment text details","summary":"Retrieves letter of credit enrichments","tags":[],"parameters":[{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"IncoTermsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/letterOfCredits","fullPath":"/api/v1.0.0/holdings/letterOfCredits","operationId":"getLetterOfCredits","name":"Retrieves the list of letter of credits for specific customer","summary":"Retrieves letter of credit details","tags":[],"parameters":[{"name":"letterOfCreditId","in":"query","type":"string","required":false,"description":"Identifier of the Letter Of Credit"},{"name":"customerId","in":"query","type":"string","required":false,"description":"Identifier of the customer"},{"name":"operation","in":"query","type":"string","required":false,"description":"Identifies the required operation to be executed for a Trade Finance contract. Input of valid codes as: O for opening of LC, P for Pre-advise of LC, A for Amend LC, C for Collect Charges, D for Decisi"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"LetterOfCreditsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/letterOfCredits/exports/drawings","fullPath":"/api/v1.0.0/holdings/letterOfCredits/exports/drawings","operationId":"getExportDrawings","name":"Retrieves the list of export letter of credit drawings for specific customer","summary":"Retrieves export letter of credit drawings","tags":[],"parameters":[{"name":"customerId","in":"query","type":"string","required":false,"description":"Identifier of the customer"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"ExportDrawingsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/letterOfCredits/exports/amendments","fullPath":"/api/v1.0.0/holdings/letterOfCredits/exports/amendments","operationId":"getExportLCAmendments","name":"Retrieves the list of export letter of credit amendments for specific customer","summary":"Retrieves export letter of credit amendments","tags":[],"parameters":[{"name":"customerId","in":"query","type":"string","required":false,"description":"Identifier of the customer"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"ExportLCAmendmentsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/letterOfCredits/exports","fullPath":"/api/v1.0.0/holdings/letterOfCredits/exports","operationId":"getExportLc","name":"Retrieves the list of export letter of credits for specific customer","summary":"Retrieves export letter of credits","tags":[],"parameters":[{"name":"customerId","in":"query","type":"string","required":false,"description":"Identifier of the customer"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"ExportLcResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/letterOfCredits/imports/drawings","fullPath":"/api/v1.0.0/holdings/letterOfCredits/imports/drawings","operationId":"getImportDrawings","name":"Retrieves the list of import letter of credit drawings for specific customer","summary":"Retrieves import letter of credit drawings","tags":[],"parameters":[{"name":"customerId","in":"query","type":"string","required":false,"description":"Identifier of the customer"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"ImportDrawingsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/letterOfCredits/imports/amendments","fullPath":"/api/v1.0.0/holdings/letterOfCredits/imports/amendments","operationId":"getImportLCAmendments","name":"Retrieves the list of import letter of credit amendments for specific customer","summary":"Retrieves import letter of credit amendments","tags":[],"parameters":[{"name":"customerId","in":"query","type":"string","required":false,"description":"Identifier of the customer"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"ImportLCAmendmentsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/letterOfCredits/imports","fullPath":"/api/v1.0.0/holdings/letterOfCredits/imports","operationId":"getImportLc","name":"Retrieves the list of import letter of credits for specific customer","summary":"Retrieves import letter of credits","tags":[],"parameters":[{"name":"customerId","in":"query","type":"string","required":false,"description":"Identifier of the customer"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"ImportLcResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/letterOfCredits/outwardCollections/documents","fullPath":"/api/v1.0.0/holdings/letterOfCredits/outwardCollections/documents","operationId":"getOutwardCollectionDocuments","name":"Retrieves the list of outward collections document codes for specific customer","summary":"Retrieves the outward collection document codes","tags":[],"parameters":[{"name":"lcAdviceTextId","in":"query","type":"string","required":false,"description":"This is the key to the letter of credit advice text file.During the input of an L/C this code can be entered for the inclusion of standard text."},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"OutwardCollectionDocumentsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/letterOfCredits/inwardCollections/amendments","fullPath":"/api/v1.0.0/holdings/letterOfCredits/inwardCollections/amendments","operationId":"getInwardCollectionsAmendments","name":"Retrieves the list of inward collection amendments for specific customer","summary":"Retrieves the inward collection amendments","tags":[],"parameters":[{"name":"customerId","in":"query","type":"string","required":false,"description":"Identifier of the customer"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"InwardCollectionsAmendmentsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/letterOfCredits/inwardCollections","fullPath":"/api/v1.0.0/holdings/letterOfCredits/inwardCollections","operationId":"getInwardCollections","name":"Retrieves the list of inward collections for specific customer","summary":"Retrieves the inward collections","tags":[],"parameters":[{"name":"customerId","in":"query","type":"string","required":false,"description":"Identifier of the customer"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"InwardCollectionsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/letterOfCredits/tenors","fullPath":"/api/v1.0.0/holdings/letterOfCredits/tenors","operationId":"getLcTenors","name":"Retrieves the list of letter of credit tenor details","summary":"Retrieves letter of credit tenor details","tags":[],"parameters":[{"name":"lcPayTypeId","in":"query","type":"string","required":false,"description":"Indicates the identifier of payment type enrichment for letter of credit."},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"LcTenorsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/letterOfCredits/outwardCollections/amendments","fullPath":"/api/v1.0.0/holdings/letterOfCredits/outwardCollections/amendments","operationId":"getOutwardCollectionAmdendments","name":"Retrieves the list of outward collection amendments for specific customer","summary":"Retrieves outward collection amendments","tags":[],"parameters":[{"name":"customerId","in":"query","type":"string","required":false,"description":"Identifier of the customer"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"OutwardCollectionAmdendmentsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/letterOfCredits/outwardCollections","fullPath":"/api/v1.0.0/holdings/letterOfCredits/outwardCollections","operationId":"getOutwardCollections","name":"Retrieves the list of inward collections for specific customer","summary":"Retrieves inward collections","tags":[],"parameters":[{"name":"customerId","in":"query","type":"string","required":false,"description":"Identifier of the customer"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"OutwardCollectionsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/letterOfCredits/limits","fullPath":"/api/v1.0.0/holdings/letterOfCredits/limits","operationId":"getLcLimits","name":"Retrieves the list of letter of credit limit details","summary":"Retrieves the letter of credit limits","tags":[],"parameters":[{"name":"customerId","in":"query","type":"string","required":false,"description":"Identifier of the customer"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"LcLimitsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"DELETE","path":"/holdings/letterOfCredits/drawings/cancellations/{drawingId}","fullPath":"/api/v1.0.0/holdings/letterOfCredits/drawings/cancellations/{drawingId}","operationId":"rejectDrawing","name":"Cancel an initiated drawing for letter of credit","summary":"Cancel initiated drawing","tags":[],"parameters":[{"name":"drawingId","in":"path","type":"string","required":true,"description":"Identifier of drawings application under the Letter of Credit system that is used to effect the transfer of funds and the acceptance of documents under Letters of Credit and Documentary Collection tra"},{"name":"payload","in":"body","type":"object","required":false,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}}},"responses":{"200":"DrawingResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"DELETE","path":"/holdings/letterOfCredits/{letterOfCreditId}/amendments/cancellations","fullPath":"/api/v1.0.0/holdings/letterOfCredits/{letterOfCreditId}/amendments/cancellations","operationId":"rejectLcAmendment","name":"Cancel an initiated letter of credit amendment","summary":"Cancel letter of credit amendment","tags":[],"parameters":[{"name":"letterOfCreditId","in":"path","type":"string","required":true,"description":"Identifier of the Letter Of Credit"},{"name":"payload","in":"body","type":"object","required":false,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}}},"responses":{"200":"LcAmendmentResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/holdings/letterOfCredits/ApprovedOutwardCollections","fullPath":"/api/v1.0.0/holdings/letterOfCredits/ApprovedOutwardCollections","operationId":"getApprovedOutwardCollections","name":"Retrieve the list of approved outward collections for specific customer","summary":"Retrieve approved outward collections","tags":[],"parameters":[{"name":"collectionId","in":"query","type":"string","required":false,"description":"Identifier of collection id"},{"name":"beneficiaryCustomerId","in":"query","type":"string","required":false,"description":"Identifies the Customer who is to be the ultimate receiver of the funds transferred by the sending bank when this Beneficiary is not a bank."},{"name":"ibStatus","in":"query","type":"string","required":false,"description":"Field to indicate the status of LC request through internet banking."},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"ApprovedOutwardCollectionsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/letterOfCredits/{lcAmendmentId}/amendment","fullPath":"/api/v1.0.0/holdings/letterOfCredits/{lcAmendmentId}/amendment","operationId":"getLcAmendment","name":"Retrieve the details of specific letter of credit amendment details","summary":"Overview details of letter of credit amendment","tags":[],"parameters":[{"name":"lcAmendmentId","in":"path","type":"string","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"LcAmendmentResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"POST","path":"/holdings/letterOfCreditsInitiation","fullPath":"/api/v1.0.0/holdings/letterOfCreditsInitiation","operationId":"createLetterOfCredit","name":"Initiate a new letter of credit request for specific customer","summary":"Create letter of credit request","tags":[],"parameters":[{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"applicantCustomerNames":[{}],"advisingBanks":[{}],"beneficiaryCustomerNames":[{}],"availableWithDetails":[{}],"additionalAmountsCovered":[{}],"deferredPayments":[{}],"contactDetails":[{}],"shipmentPeriods":[{}],"presentationPeriods":[{}],"descriptionOfGoods":[{}],"documentDetails":[{}],"documentsRequired":[{}],"clausesDetails":[{}],"additionalConditions":[{}],"narrativeCharges":[{}]}},"responses":{"200":"LetterOfCreditResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/holdings/letterOfCredit/{letterOfCreditId}","fullPath":"/api/v1.0.0/holdings/letterOfCredit/{letterOfCreditId}","operationId":"updateLetterOfCredit","name":"Update an existing letter of credit for specific customer","summary":"Update letter of credit","tags":[],"parameters":[{"name":"letterOfCreditId","in":"path","type":"string","required":true,"description":"Identifier of the Letter Of Credit"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"applicantCustomerNames":[{}],"advisingBanks":[{}],"beneficiaryCustomerNames":[{}],"availableWithDetails":[{}],"additionalAmountsCovered":[{}],"deferredPayments":[{}],"contactDetails":[{}],"shipmentPeriods":[{}],"presentationPeriods":[{}],"descriptionOfGoods":[{}],"documentDetails":[{}],"documentsRequired":[{}],"clausesDetails":[{}],"additionalConditions":[{}],"narrativeCharges":[{}]}},"responses":{"200":"LetterOfCreditResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/holdings/letterOfCredits/{letterOfCreditId}","fullPath":"/api/v1.0.0/holdings/letterOfCredits/{letterOfCreditId}","operationId":"getLetterOfCredit","name":"Retrieves the details of specific letter of credit","summary":"Overview details of letter of credit","tags":[],"parameters":[{"name":"letterOfCreditId","in":"path","type":"string","required":true,"description":"Identifier of the Letter Of Credit"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"LetterOfCreditResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"POST","path":"/holdings/letterOfCredits/{letterOfCreditId}","fullPath":"/api/v1.0.0/holdings/letterOfCredits/{letterOfCreditId}","operationId":"updateExternalAmendmentToAnLC","name":"Updates external amendments to the Letter of Credit for the specified Letter of Credit/customer reference number","summary":"Updates Letter of Credit details","tags":[],"parameters":[{"name":"letterOfCreditId","in":"path","type":"string","required":true,"description":""},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"additionalAmountsCovered":[{}],"beneficiaries":[{}],"shipmentPeriods":[{}],"narrativeCharges":[{}],"charges":[{}],"reimNarratives":[{}],"lcNumber":"string","advisingBankReference":"string","issueDate":"string","amendmentDate":"string","lcType":"string","applicant":"string","advisingBank":"string","newLcCurrency":"string","newLcAmount":"string"}},"responses":{"200":"ExternalAmendmentToAnLCResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"DELETE","path":"/holdings/letterOfCredits/{letterOfCreditId}","fullPath":"/api/v1.0.0/holdings/letterOfCredits/{letterOfCreditId}","operationId":"deleteLetterOfCredit","name":"Remove an existing letter of credit for specific customer","summary":"Remove letter of credit","tags":[],"parameters":[{"name":"letterOfCreditId","in":"path","type":"string","required":true,"description":"Identifier of the Letter Of Credit"},{"name":"payload","in":"body","type":"object","required":false,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}}},"responses":{"200":"LetterOfCreditResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/holdings/letterOfCredits/letterOfCreditApprovals/{letterOfCreditId}","fullPath":"/api/v1.0.0/holdings/letterOfCredits/letterOfCreditApprovals/{letterOfCreditId}","operationId":"approveLetterOfCredit","name":"Approve an initiated letter of credit request for specific customer","summary":"Approve letter of credit request","tags":[],"parameters":[{"name":"letterOfCreditId","in":"path","type":"string","required":true,"description":"Identifier of the Letter Of Credit"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"LetterOfCreditResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"DELETE","path":"/holdings/letterOfCredits/cancellations/{letterOfCreditId}","fullPath":"/api/v1.0.0/holdings/letterOfCredits/cancellations/{letterOfCreditId}","operationId":"rejectLetterOfCredit","name":"Cancel an initiated letter of credit request for specific customer","summary":"Cancel letter of credit request","tags":[],"parameters":[{"name":"letterOfCreditId","in":"path","type":"string","required":true,"description":"Identifier of the Letter Of Credit"},{"name":"payload","in":"body","type":"object","required":false,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}}},"responses":{"200":"LetterOfCreditResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"POST","path":"/holdings/letterOfCredit/exports","fullPath":"/api/v1.0.0/holdings/letterOfCredit/exports","operationId":"createExportLetterOfCredit","name":"Create a new export letter of credit for specific customer","summary":"Create export letter of credit","tags":[],"parameters":[{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"applicantCustomerNames":[{}],"advisingBanks":[{}],"beneficiaryCustomerNames":[{}],"availableWithDetails":[{}],"additionalAmountsCovered":[{}],"deferredPayments":[{}],"contactDetails":[{}],"shipmentPeriods":[{}],"presentationPeriods":[{}],"descriptionOfGoods":[{}],"documentDetails":[{}],"documentsRequired":[{}],"clausesDetails":[{}],"additionalConditions":[{}],"narrativeCharges":[{}]}},"responses":{"200":"ExportLetterOfCreditResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/holdings/letterOfCredit/{letterOfCreditId}/exports","fullPath":"/api/v1.0.0/holdings/letterOfCredit/{letterOfCreditId}/exports","operationId":"updateExportLetterOfCredit","name":"Update a new export letter of credit for specific customer","summary":"Update export letter of credit","tags":[],"parameters":[{"name":"letterOfCreditId","in":"path","type":"string","required":true,"description":"Identifier of the Letter Of Credit"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"applicantCustomerNames":[{}],"advisingBanks":[{}],"beneficiaryCustomerNames":[{}],"availableWithDetails":[{}],"additionalAmountsCovered":[{}],"deferredPayments":[{}],"contactDetails":[{}],"shipmentPeriods":[{}],"presentationPeriods":[{}],"descriptionOfGoods":[{}],"documentDetails":[{}],"documentsRequired":[{}],"clausesDetails":[{}],"additionalConditions":[{}],"narrativeCharges":[{}]}},"responses":{"200":"ExportLetterOfCreditResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"POST","path":"/holdings/letterOfCredits/sightPayments","fullPath":"/api/v1.0.0/holdings/letterOfCredits/sightPayments","operationId":"createIssuanceOfSightPaymentLC","name":"Creates Sight Payment Letter of Credit for the requested customer reference number","summary":"Create Sight Payment Letter of Credit","tags":[],"parameters":[{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"applicantAddresses":[{}],"beneficiaryAddresses":[{}],"advisingBankAddresses":[{}],"adviseThroughBanks":[{}],"availableWithBanks":[{}],"reimbursingBanks1":[{}],"requestedConfirmBankNames":[{}],"charges":[{}],"importSightPmtLcType":"string","lcNumber":"string","applicant":"string","lcCurrency":"string","lcAmount":0.0,"creditTolerance":"string","debitTolerance":"string"}},"responses":{"200":"IssuanceOfSightPaymentLCResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"POST","path":"/holdings/letterOfCredits/usances","fullPath":"/api/v1.0.0/holdings/letterOfCredits/usances","operationId":"createIssuanceOfUsanceLC","name":"Creates Usance Letter of Credit for the requested customer reference number","summary":"Create Usance Letter of Credit","tags":[],"parameters":[{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"applicantAddresses":[{}],"limitReferences":[{}],"beneficiaryAddresses":[{}],"advisingBankAddresses":[{}],"adviseThroughBanks":[{}],"availableWithBanks":[{}],"reimbursingBanks1":[{}],"requestedConfirmBankNames":[{}],"charges":[{}],"importUsanceLCType":"string","lcNumber":"string","applicant":"string","currency":"string","amount":0.0,"creditTolerance":"string"}},"responses":{"200":"IssuanceOfUsanceLCResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"POST","path":"/holdings/letterOfCredits/negotiations","fullPath":"/api/v1.0.0/holdings/letterOfCredits/negotiations","operationId":"createIssuanceOfNegotiationLC","name":"Creates Negotiation Letter of Credit for the requested customer reference number","summary":"Create Negotiation Letter of Credit","tags":[],"parameters":[{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"applicantAddresses":[{}],"beneficiaryAddresses":[{}],"advisingBankAddresses":[{}],"adviseThroughBanks":[{}],"availableWithBanks":[{}],"reimbursingBanks1":[{}],"requestedConfirmBankNames":[{}],"charges":[{}],"importNegotiationLCType":"string","lcNumber":"string","applicant":"string","lcCurrency":"string","lcAmount":"string","creditTolerance":"string","debitTolerance":"string"}},"responses":{"200":"IssuanceOfNegotiationLCResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"POST","path":"/holdings/letterOfCredits/mixedPayments","fullPath":"/api/v1.0.0/holdings/letterOfCredits/mixedPayments","operationId":"createIssuanceOfMixedPaymentLC","name":"Creates Mixed Payment Letter of Credit for the requested customer reference number","summary":"Create Mixed Payment Letter of Credit","tags":[],"parameters":[{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"applicantAddresses":[{}],"beneficiaryAddresses":[{}],"advisingBankAddresses":[{}],"adviseThroughBanks":[{}],"availableWithBanks":[{}],"reimbursingBanks1":[{}],"requestedConfirmBankNames":[{}],"charges":[{}],"drawings":[{}],"importMixedPmtLCType":"string","lcNumber":"string","applicantCustomer":"string","lcCurrency":"string","lcAmount":"string","creditTolerance":"string"}},"responses":{"200":"IssuanceOfMixedPaymentLCResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"POST","path":"/holdings/letterOfCredits/standbys","fullPath":"/api/v1.0.0/holdings/letterOfCredits/standbys","operationId":"createIssuanceOfStandbyLC","name":"Creates Standby Letter of Credit for the requested customer reference number","summary":"Create Standby Letter of Credit","tags":[],"parameters":[{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"applicantAddresses":[{}],"limitReferences":[{}],"beneficiaryAddresses":[{}],"advisingBankAddresses":[{}],"adviseThroughBanks":[{}],"availableWithBanks":[{}],"reimbursingBanks1":[{}],"requestedConfirmBankNames":[{}],"charges":[{}],"importLCType":"string","lcNumber":"string","applicantCustomer":"string","lcCurrency":"string","lcAmount":0.0,"creditTolerance":"string"}},"responses":{"200":"IssuanceOfStandbyLCResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"POST","path":"/holdings/letterOfCredits/imports/preAdvises","fullPath":"/api/v1.0.0/holdings/letterOfCredits/imports/preAdvises","operationId":"createIssuanceOfPreAdviseImportLC","name":"Creates a Pre-advice Import Letter of Credit request.","summary":"Creates Pre-advice Letter of credit","tags":[],"parameters":[{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"applicantAddresses":[{}],"limitReferences":[{}],"beneficiaryAddresses":[{}],"advisingBankAddresses":[{}],"adviseThroughBanks":[{}],"availableWithBanks":[{}],"reimbursingBanks1":[{}],"requestedConfirmBankNames":[{}],"charges":[{}],"lcNumber":"string","lcType":"string","applicant":"string","currency":"string","amount":0.0,"creditTolerance":"string"}},"responses":{"200":"IssuanceOfPreAdviseImportLCResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"POST","path":"/holdings/letterOfCredits/backToBacks","fullPath":"/api/v1.0.0/holdings/letterOfCredits/backToBacks","operationId":"createIssuanceOfBackToBackLC","name":"Creates Back-to-Back Letter of Credit for the requested customer reference number","summary":"Creates Back-to-Back Letter of Credit","tags":[],"parameters":[{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"limitReferences":[{}],"beneficiaryAddresses":[{}],"applicantNames":[{}],"availableWithBanks":[{}],"adviseThroughBanks":[{}],"charges":[{}],"drawings":[{}],"accountWithBanks":[{}],"senderReceiversInfoMT730":[{}],"exportLCType":"string","backToBackLCRequired":"string","relatedImportLCReference":"string","advisingBankReference":"string","lcAdvisingReference":"string","issuingBankLCReference":"string"}},"responses":{"200":"IssuanceOfBackToBackLCResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"POST","path":"/holdings/letterOfCredits/transferables","fullPath":"/api/v1.0.0/holdings/letterOfCredits/transferables","operationId":"createIssuanceOfTransferableLC","name":"Creates transferable Letter of Credit for the requested customer reference number","summary":"Creates transferable Letters of Credit","tags":[],"parameters":[{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"advisingBanks":[{}],"limitReferences":[{}],"drawings":[{}],"charges":[{}],"assignments":[{}],"secondBeneficiaries":[{}],"availableWithBanks":[{}],"draftsAt":[{}],"drawees":[{}],"mixedPaymentDetails":[{}],"negotiationDeferredPaymentDetails":[{}],"shipmentPeriods":[{}],"documentsRequired":[{}],"additionalConditions":[{}],"narrativeCharges":[{}]}},"responses":{"200":"IssuanceOfTransferableLCResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"POST","path":"/holdings/letterOfCredits/{letterOfCreditId}/beneficiaryConsents","fullPath":"/api/v1.0.0/holdings/letterOfCredits/{letterOfCreditId}/beneficiaryConsents","operationId":"updateAmendmentSeekingBeneficiaryConsent","name":"Updates Letter of Credit amendments seeking beneficiary's consent for the specified Letter of Credit/customer reference number","summary":"Updates Letter of Credit beneficiary's consent details","tags":[],"parameters":[{"name":"letterOfCreditId","in":"path","type":"string","required":true,"description":""},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"advisingBankIds":[{}],"beneficiaryAddresses":[{}],"documentsRequired":[{}],"additionalConditions":[{}],"charges":[{}],"lcCurrency":"string","lcAmount":0.0,"issueDate":"2024-01-01","beneficiaryId":"string","lcLiabilityAmountOutStanding":"string","pendingAmendMovement":"string","debitTolerance":"string","creditTolerance":"string","advisingBankReference":"string","increaseOrDecreaseAmount":0.0}},"responses":{"200":"AmendmentSeekingBeneficiaryConsentResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"POST","path":"/holdings/letterOfCredits/{letterOfCreditId}/imports/decisions","fullPath":"/api/v1.0.0/holdings/letterOfCredits/{letterOfCreditId}/imports/decisions","operationId":"updateDecisionOnAmendment","name":"Updates the decision on amendments to import Letter of Credit for the specified Letter of Credit/customer reference number","summary":"Updates decision on amendment to the import Letter of Credit","tags":[],"parameters":[{"name":"letterOfCreditId","in":"path","type":"string","required":true,"description":""},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"additionalAmountsCovered":[{}],"limitReferences":[{}],"beneficiaries":[{}],"bankToBanks":[{}],"internalAmendmentDetails":[{}],"charges":[{}],"commissions":[{}],"amendmentNumber":"string","amendStatus":"string","sendAmendmentAdvice":"string","lcNumber":"string","advisingBankReference":"string","issueDate":"2024-01-01","lcType":"string","amendmentDate":"2024-01-01"}},"responses":{"200":"DecisionOnAmendmentResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"POST","path":"/holdings/letterOfCredits/{letterOfCreditId}/imports/cancellations","fullPath":"/api/v1.0.0/holdings/letterOfCredits/{letterOfCreditId}/imports/cancellations","operationId":"updateCancellationOfLC","name":"Updates the cancellation details of the issued Import Letter of Credit for the specified Letter of Credit/customer reference number","summary":"Updates import Letter of Credit cancellation details","tags":[],"parameters":[{"name":"letterOfCreditId","in":"path","type":"string","required":true,"description":""},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"limitReferences":[{}],"beneficiaries":[{}],"charges":[{}],"commissions":[{}],"lcNumber":"string","sendAmendmentAdvice":"string","lcType":"string","advisingBankReference":"string","applicantCustomer":"string","advisingBank":"string","issueDate":"string","newLcCurrency":"string","newLcAmount":"string","creditTolerance":"string","debitTolerance":"string"}},"responses":{"200":"CancellationOfLCResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"POST","path":"/holdings/letterOfCredits/{letterOfCreditId}/exports/decisions","fullPath":"/api/v1.0.0/holdings/letterOfCredits/{letterOfCreditId}/exports/decisions","operationId":"updateDecisionOnExportLCAmendment","name":"Updates the decision on amendments to export Letter of Credit for the specified Letter of Credit/customer reference number","summary":"Updates decision on amendment to the export Letter of Credit","tags":[],"parameters":[{"name":"letterOfCreditId","in":"path","type":"string","required":true,"description":""},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"beneficiaries":[{}],"shipmentPeriods":[{}],"internalAmendmentDetails":[{}],"charges":[{}],"amendmentNumber":"string","lcType":"string","amendStatus":"string","applicantCustomer":"string","lcNumber":"string","sendAmendmentAdvice":"string","issuingBankReference":"string","issueDate":"string","issuingBankId":"string","lcCurrency":"string","lcAmount":"string"}},"responses":{"200":"DecisionOnExportLCAmendmentResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"POST","path":"/holdings/letterOfCredits/{letterOfCreditId}/exports/cancellations","fullPath":"/api/v1.0.0/holdings/letterOfCredits/{letterOfCreditId}/exports/cancellations","operationId":"updateCancellationOfExportLC","name":"Updates the cancellation details of the issued export Letter of Credit for the specified Letter of Credit/customer reference number","summary":"Updates export Letter of Credit cancellation details ","tags":[],"parameters":[{"name":"letterOfCreditId","in":"path","type":"string","required":true,"description":""},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"applicants":[{}],"additionalAmountsCovered":[{}],"beneficiaries":[{}],"charges":[{}],"lcNumber":"string","sendAmendmentAdvice":"string","lcType":"string","issuingBankReference":"string","issuingBankId":"string","lcIssueDate":"string","newLcCurrency":"string","newLcAmount":"string","creditTolerance":"string","debitTolerance":"string","purposeOfMessage":"string"}},"responses":{"200":"CancellationOfExportLCResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/holdings/customers/{customerId}/LettersOfCredits/imports/outstandings","fullPath":"/api/v1.0.0/holdings/customers/{customerId}/LettersOfCredits/imports/outstandings","operationId":"getImportLcsOutstanding","name":"Retrieves the details of outstanding import Letter of Credits for the specified customer/guarantee reference.","summary":"Retrieves outstanding import Letter of Credit details","tags":[],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":""},{"name":"transactionReference","in":"query","type":"string","required":false,"description":"Contains the identifier for the transaction in the core system"},{"name":"applicantCustomer","in":"query","type":"string","required":false,"description":"Indicates the applicant ID on whose behalf the Letter of Credit is issued."},{"name":"lcCurrency","in":"query","type":"string","required":false,"description":"Denote the currency of the Letter of Credit."},{"name":"advisingBank","in":"query","type":"string","required":false,"description":"Identifies the advising bank under the Letter of Credit, through whom the Letter of Credit is to be advised to the second advising bank or beneficiary"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"ImportLcsOutstandingResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/customers/{customerId}/letterOfCredits/imports/expiries","fullPath":"/api/v1.0.0/holdings/customers/{customerId}/letterOfCredits/imports/expiries","operationId":"getImportLcsExpiringButOutstanding","name":"Retrieves the expired import Letter of Credit details for the specified customer/guarantee reference.","summary":"Retrieves expired Import Letter of Credit details","tags":[],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":""},{"name":"transactionReference","in":"query","type":"string","required":false,"description":"Contains the identifier for the transaction in the core system"},{"name":"applicantCustomer","in":"query","type":"string","required":false,"description":"Indicates the applicant ID on whose behalf the Letter of Credit is issued."},{"name":"lcCurrency","in":"query","type":"string","required":false,"description":"Denote the currency of the Letter of Credit."},{"name":"advisingBank","in":"query","type":"string","required":false,"description":"Identifies the advising bank under the Letter of Credit, through whom the Letter of Credit is to be advised to the second advising bank or beneficiary"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"ImportLcsExpiringButOutstandingResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/letterOfCredits/{letterOfCreditId}/exports/outstandings","fullPath":"/api/v1.0.0/holdings/letterOfCredits/{letterOfCreditId}/exports/outstandings","operationId":"getExportlcsOutstanding","name":"Retrieves the details of outstanding export Letter of Credits for the specified customer/guarantee reference.","summary":"Retrieves outstanding export Letter of Credit details","tags":[],"parameters":[{"name":"letterOfCreditId","in":"path","type":"string","required":true,"description":""},{"name":"transactionReference","in":"query","type":"string","required":false,"description":"Contains the identifier for the transaction in the core system"},{"name":"issuingBankId","in":"query","type":"string","required":false,"description":"Identifies the Issuing bank ID under the LC, who issues the LC under when a bank is advising the Letter of Credit"},{"name":"lcCurrency","in":"query","type":"string","required":false,"description":"Denote the currency of the Letter of Credit."},{"name":"lcAmount","in":"query","type":"string","required":false,"description":"This field indicates the amount of the Letter of Credit that will always be expressed in the currency of Letter of Credit."},{"name":"beneficiaryCustomerId","in":"query","type":"string","required":false,"description":"Identifies the Customer who is to be the ultimate receiver of the funds transferred by the sending bank when this Beneficiary is not a bank."},{"name":"expiryDate","in":"query","type":"string","required":false,"description":"The date an agreement such as an arrangement, product, credit facility or limit is due to expire"},{"name":"liabilityReversalDate","in":"query","type":"string","required":false,"description":"Date on which the contingent entries and the limits raised on the LC will be reversed."},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"ExportlcsOutstandingResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}}]},{"key":"holdings-letterOfCredit-service-v2.0.0","title":"Management of Letter of Credits","version":"v2.0.0","description":"API to create, update and manage various types of trade finance letter of credit (LC) instruments and their associated status and details. Some of the types of LCs that can be created are sight payments, back-to-back, standby's and usance LCs","endpointCount":75,"endpoints":[{"method":"POST","path":"/holdings/letterOfCredits/drawingsInitiation/{drawingId}","fullPath":"/api/v2.0.0/holdings/letterOfCredits/drawingsInitiation/{drawingId}","operationId":"createDrawings","name":"Initiate a new drawing request for a specific letter of credit","summary":"Initiate a new drawing request to check the documents for letter of credit","tags":["CORPORATE"],"parameters":[{"name":"drawingId","in":"path","type":"string","required":true,"description":"Identifier of drawings application under the Letter of Credit system that is used to effect the transfer of funds and the acceptance of documents under Letters of Credit and Documentary Collection tra"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"addresses":[{}],"documentStatus":[{}],"clausesTexts":[{}],"invoiceDocuments":[{}],"transportDocuments":[{}],"documents":[{}],"discrepancyDetails":[{}],"presentorCustomerId":"string","referenceId":"string","currencyId":"string","documentAmount":0.0,"paymentMethod":"string","debitAccountId":"string","creditAccountId":"string","nextReviewDate":"2024-01-01"}},"responses":{"200":"DrawingsResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"POST","path":"/holdings/letterOfCredits/drawings/{drawingId}/initiations","fullPath":"/api/v2.0.0/holdings/letterOfCredits/drawings/{drawingId}/initiations","operationId":"createDrawing","name":"Initiate a new drawing request registerered  for a specific letter of credit","summary":"Initiate a new drawing request to check the documents for letter of credit","tags":["CORPORATE"],"parameters":[{"name":"drawingId","in":"path","type":"string","required":true,"description":"Identifier of drawings application under the Letter of Credit system that is used to effect the transfer of funds and the acceptance of documents under Letters of Credit and Documentary Collection tra"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"addresses":[{}],"documentStatus":[{}],"clausesTexts":[{}],"invoiceDocuments":[{}],"transportDocuments":[{}],"documents":[{}],"discrepancyDetails":[{}],"presentorCustomerId":"string","referenceId":"string","currencyId":"string","documentAmount":0.0,"paymentMethod":"string","debitAccountId":"string","creditAccountId":"string","nextReviewDate":"2024-01-01"}},"responses":{"200":"DrawingResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/holdings/letterOfCredits/drawings/{drawingId}","fullPath":"/api/v2.0.0/holdings/letterOfCredits/drawings/{drawingId}","operationId":"getDrawing","name":"Retrieves the details of specific drawing that is created against a letter of credit","summary":"Retrieves the drawing requests for a specific letter of credit","tags":["CORPORATE"],"parameters":[{"name":"drawingId","in":"path","type":"string","required":true,"description":"Identifier of drawings application under the Letter of Credit system that is used to effect the transfer of funds and the acceptance of documents under Letters of Credit and Documentary Collection tra"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"DrawingResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/holdings/letterOfCredits/drawings/{drawingId}","fullPath":"/api/v2.0.0/holdings/letterOfCredits/drawings/{drawingId}","operationId":"updateDrawing","name":"Update an existing drawing for a specific letter of credit","summary":"Update drawing details","tags":["CORPORATE"],"parameters":[{"name":"drawingId","in":"path","type":"string","required":true,"description":"Identifier of drawings application under the Letter of Credit system that is used to effect the transfer of funds and the acceptance of documents under Letters of Credit and Documentary Collection tra"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"addresses":[{}],"documentStatus":[{}],"clausesTexts":[{}],"invoiceDocuments":[{}],"transportDocuments":[{}],"documents":[{}],"discrepancyDetails":[{}],"presentorCustomerId":"string","referenceId":"string","documentAmount":0.0,"paymentMethod":"string","debitAccountId":"string","creditAccountId":"string","nextReviewDate":"2024-01-01","valueDate":"2024-01-01"}},"responses":{"200":"DrawingResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"DELETE","path":"/holdings/letterOfCredits/drawings/{drawingId}","fullPath":"/api/v2.0.0/holdings/letterOfCredits/drawings/{drawingId}","operationId":"deleteDrawing","name":"Remove an existing drawing for a specific letter of credit","summary":"Remove drawing details","tags":["CORPORATE"],"parameters":[{"name":"drawingId","in":"path","type":"string","required":true,"description":"Identifier of drawings application under the Letter of Credit system that is used to effect the transfer of funds and the acceptance of documents under Letters of Credit and Documentary Collection tra"},{"name":"payload","in":"body","type":"object","required":false,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}}},"responses":{"200":"DrawingResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/holdings/letterOfCredits/drawingsApprovals/{drawingId}","fullPath":"/api/v2.0.0/holdings/letterOfCredits/drawingsApprovals/{drawingId}","operationId":"approveDrawing","name":"Approve a drawing  for specific letter of credit","summary":"Approve drawing ","tags":["CORPORATE"],"parameters":[{"name":"drawingId","in":"path","type":"string","required":true,"description":"Identifier of drawings application under the Letter of Credit system that is used to effect the transfer of funds and the acceptance of documents under Letters of Credit and Documentary Collection tra"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"DrawingResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/holdings/letterOfCredits/documents/{documentId}","fullPath":"/api/v2.0.0/holdings/letterOfCredits/documents/{documentId}","operationId":"getLcDocument","name":"Retrieves the details of specific letter of credit advice text","summary":"Overview details of letter of credit advice text","tags":["CORPORATE"],"parameters":[{"name":"documentId","in":"path","type":"string","required":true,"description":"Based on documentCode, the field defaults the required document codes"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"LcDocumentResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"POST","path":"/holdings/letterOfCredits/documents/{documentId}","fullPath":"/api/v2.0.0/holdings/letterOfCredits/documents/{documentId}","operationId":"createLcDocument","name":"Create a new letter of credit advice text","summary":"Create letter of credit advice text","tags":["CORPORATE"],"parameters":[{"name":"documentId","in":"path","type":"string","required":true,"description":"Based on documentCode, the field defaults the required document codes"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"documentDetails":[{}],"extensions":{}}},"responses":{"200":"LcDocumentResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/holdings/letterOfCredits/documents/{documentId}","fullPath":"/api/v2.0.0/holdings/letterOfCredits/documents/{documentId}","operationId":"updateLcDocument","name":"Create an existing letter of credit advice text","summary":"Update letter of credit advice text","tags":["CORPORATE"],"parameters":[{"name":"documentId","in":"path","type":"string","required":true,"description":"Based on documentCode, the field defaults the required document codes"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"documentDetails":[{}],"extensions":{}}},"responses":{"200":"LcDocumentResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"DELETE","path":"/holdings/letterOfCredits/documents/{documentId}","fullPath":"/api/v2.0.0/holdings/letterOfCredits/documents/{documentId}","operationId":"deleteLcDocument","name":"Delete an existing letter of credit advice text","summary":"Delete letter of credit advice text","tags":["CORPORATE"],"parameters":[{"name":"documentId","in":"path","type":"string","required":true,"description":"Based on documentCode, the field defaults the required document codes"},{"name":"payload","in":"body","type":"object","required":false,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}}},"responses":{"200":"LcDocumentResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"POST","path":"/holdings/letterOfCredits/{letterOfCreditId}/amendmentsInitiation","fullPath":"/api/v2.0.0/holdings/letterOfCredits/{letterOfCreditId}/amendmentsInitiation","operationId":"createLcAmendments","name":"Initiate a new letter of credit amendment","summary":"Initiate letter of credit amendment","tags":["CORPORATE"],"parameters":[{"name":"letterOfCreditId","in":"path","type":"string","required":true,"description":"Identifier of the Letter Of Credit"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"ibLimitExceeds":[{}],"additionalAmountsCovered":[{}],"shipmentPeriods":[{}],"lcAmend":[{}],"messageFromCustomers":[{}],"messageFromBanks":[{}],"overrides":[{}],"lcAmount":0.0,"increaseDecreaseAmount":0.0,"decreaseCreditAmount":0.0,"increaseCreditAmount":0.0,"maximumCreditAmount":"string","newAdviceExpiryDate":"2024-01-01","shipmentDespatch":"string","otherDespatchDetails":"string"}},"responses":{"200":"LcAmendmentsResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"POST","path":"/holdings/letterOfCredits/{letterOfCreditId}/amendments/initiations","fullPath":"/api/v2.0.0/holdings/letterOfCredits/{letterOfCreditId}/amendments/initiations","operationId":"createLcAmendment","name":"Initiate a new letter of credit amendment","summary":"Initiate letter of credit amendment","tags":["CORPORATE"],"parameters":[{"name":"letterOfCreditId","in":"path","type":"string","required":true,"description":"Identifier of the Letter Of Credit"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"ibLimitExceeds":[{}],"additionalAmountsCovered":[{}],"shipmentPeriods":[{}],"lcAmend":[{}],"messageFromCustomers":[{}],"messageFromBanks":[{}],"overrides":[{}],"lcAmount":0.0,"increaseDecreaseAmount":0.0,"decreaseCreditAmount":0.0,"increaseCreditAmount":0.0,"maximumCreditAmount":"string","newAdviceExpiryDate":"2024-01-01","shipmentDespatch":"string","otherDespatchDetails":"string"}},"responses":{"200":"LcAmendmentResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/holdings/letterOfCredits/{letterOfCreditId}/amendments","fullPath":"/api/v2.0.0/holdings/letterOfCredits/{letterOfCreditId}/amendments","operationId":"getLCAmendments","name":"Retrieves the list of letter of credit amendment details","summary":"Retrieves the letter of credit amendments","tags":["CORPORATE"],"parameters":[{"name":"letterOfCreditId","in":"path","type":"string","required":true,"description":"Identifier of the Letter Of Credit"},{"name":"eventStatus","in":"query","type":"string","required":false,"description":"Specifies the status of the request.Allowed values are - With Bank_With Customer_Approved_Rejected."},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it Retrieves all the data"}],"requestBodyExample":null,"responses":{"200":"LCAmendmentsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"PUT","path":"/holdings/letterOfCredits/{letterOfCreditId}/amendments","fullPath":"/api/v2.0.0/holdings/letterOfCredits/{letterOfCreditId}/amendments","operationId":"updateLcAmendment","name":"Update an existing amendment for specific letter of credit","summary":"Update letter of credit amendment","tags":["CORPORATE"],"parameters":[{"name":"letterOfCreditId","in":"path","type":"string","required":true,"description":"Identifier of the Letter Of Credit"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"ibLimitExceeds":[{}],"additionalAmountsCovered":[{}],"shipmentPeriods":[{}],"lcAmend":[{}],"messageFromCustomers":[{}],"messageFromBanks":[{}],"overrides":[{}],"lcAmount":0.0,"increaseDecreaseAmount":0.0,"decreaseCreditAmount":0.0,"increaseCreditAmount":0.0,"maximumCreditAmount":"string","newAdviceExpiryDate":"2024-01-01","shipmentDespatch":"string","otherDespatchDetails":"string"}},"responses":{"200":"LcAmendmentResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"DELETE","path":"/holdings/letterOfCredits/{letterOfCreditId}/amendments","fullPath":"/api/v2.0.0/holdings/letterOfCredits/{letterOfCreditId}/amendments","operationId":"deleteLcAmendment","name":"Remove an existing letter of credit amendment","summary":"Remove letter of credit amendment","tags":["CORPORATE"],"parameters":[{"name":"letterOfCreditId","in":"path","type":"string","required":true,"description":"Identifier of the Letter Of Credit"},{"name":"payload","in":"body","type":"object","required":false,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}}},"responses":{"200":"LcAmendmentResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/holdings/letterOfCredits/{letterOfCreditId}/amendmentApprovals","fullPath":"/api/v2.0.0/holdings/letterOfCredits/{letterOfCreditId}/amendmentApprovals","operationId":"approveLcAmendments","name":"Approve an initiated letter of credit amendment ","summary":"Approve letter of credit amendment","tags":["CORPORATE"],"parameters":[{"name":"letterOfCreditId","in":"path","type":"string","required":true,"description":"Identifier of the Letter Of Credit"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"LcAmendmentsResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/holdings/letterOfCredits/{letterOfCreditId}/amendments/approvals","fullPath":"/api/v2.0.0/holdings/letterOfCredits/{letterOfCreditId}/amendments/approvals","operationId":"approveLcAmendment","name":"Approve an initiated letter of credit amendment ","summary":"Approve letter of credit amendment","tags":["CORPORATE"],"parameters":[{"name":"letterOfCreditId","in":"path","type":"string","required":true,"description":"Identifier of the Letter Of Credit"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"LcAmendmentResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/holdings/letterOfCredits/clauses/{clausesId}","fullPath":"/api/v2.0.0/holdings/letterOfCredits/clauses/{clausesId}","operationId":"getLcClause","name":"Retrieves the details of specific letter of credit clause","summary":"Overview details of letter of credit clause","tags":["CORPORATE"],"parameters":[{"name":"clausesId","in":"path","type":"string","required":true,"description":"This is the key to the LC.CLAUSES file.During the input of an L/C this code can be entered for the inclusion of standard clauses."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"LcClauseResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"POST","path":"/holdings/letterOfCredits/clauses/{clausesId}","fullPath":"/api/v2.0.0/holdings/letterOfCredits/clauses/{clausesId}","operationId":"createLcClause","name":"Create a new letter of credit clause","summary":"Create a static narrative information for letter of credit","tags":["CORPORATE"],"parameters":[{"name":"clausesId","in":"path","type":"string","required":true,"description":"This is the key to the LC.CLAUSES file.During the input of an L/C this code can be entered for the inclusion of standard clauses."},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"narratives":[{}],"lcClausesName":"string","extensions":{}}},"responses":{"200":"LcClauseResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/holdings/letterOfCredits/clauses/{clausesId}","fullPath":"/api/v2.0.0/holdings/letterOfCredits/clauses/{clausesId}","operationId":"updateLcClause","name":"Update an existing letter of credit clause","summary":"Update a static narrative information for letter of credit","tags":["CORPORATE"],"parameters":[{"name":"clausesId","in":"path","type":"string","required":true,"description":"This is the key to the LC.CLAUSES file.During the input of an L/C this code can be entered for the inclusion of standard clauses."},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"narratives":[{}],"lcClausesName":"string","extensions":{}}},"responses":{"200":"LcClauseResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"DELETE","path":"/holdings/letterOfCredits/clauses/{clausesId}","fullPath":"/api/v2.0.0/holdings/letterOfCredits/clauses/{clausesId}","operationId":"deleteLcClause","name":"Remove an existing letter of credit clause","summary":"Remove a static narrative information for letter of credit","tags":["CORPORATE"],"parameters":[{"name":"clausesId","in":"path","type":"string","required":true,"description":"This is the key to the LC.CLAUSES file.During the input of an L/C this code can be entered for the inclusion of standard clauses."},{"name":"payload","in":"body","type":"object","required":false,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}}},"responses":{"200":"LcClauseResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/holdings/letterOfCredits/{letterOfCreditId}/drawings","fullPath":"/api/v2.0.0/holdings/letterOfCredits/{letterOfCreditId}/drawings","operationId":"getDrawings","name":"Retrieves the list of drawings for specific customer","summary":"Retrieves drawing details","tags":["CORPORATE"],"parameters":[{"name":"letterOfCreditId","in":"path","type":"string","required":true,"description":"Identifier of the Letter Of Credit"},{"name":"eventStatus","in":"query","type":"string","required":false,"description":"Specifies the status of the request.Allowed values are - With Bank_With Customer_Approved_Rejected."},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it Retrieves all the data"}],"requestBodyExample":null,"responses":{"200":"DrawingsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/customers/{customerId}/letterOfCredits/documents","fullPath":"/api/v2.0.0/holdings/customers/{customerId}/letterOfCredits/documents","operationId":"getLCDocuments","name":"Retrieves the list of letter of credit advice text details","summary":"Retrieves the letter of credit advice text details","tags":["CORPORATE"],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"Identifier of the customer"},{"name":"lcAdviceTextId","in":"query","type":"string","required":false,"description":"This is the key to the letter of credit advice text file.During the input of an L/C this code can be entered for the inclusion of standard text."},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it Retrieves all the data"}],"requestBodyExample":null,"responses":{"200":"LCDocumentsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/customers/{customerId}/letterOfCredits/clauses","fullPath":"/api/v2.0.0/holdings/customers/{customerId}/letterOfCredits/clauses","operationId":"getLCClauses","name":"Retrieves the list of narrative static information data for use in the mapping and construction of L/C Advices/Documents generated as a result of L/C transactions within the Transact delivery application","summary":"Retrieves the letter of credit clause details","tags":["CORPORATE"],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"Identifier of the customer"},{"name":"lcClausesId","in":"query","type":"string","required":false,"description":"This is the key to the LC.CLAUSES file.During the input of an L/C this code can be entered for the inclusion of standard clauses."},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it Retrieves all the data"}],"requestBodyExample":null,"responses":{"200":"LCClausesResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/letterOfCredits/incoTerms","fullPath":"/api/v2.0.0/holdings/letterOfCredits/incoTerms","operationId":"getIncoTerms","name":"Retrieves the list of letter of credit enrichment text details","summary":"Retrieves letter of credit enrichments","tags":["CORPORATE"],"parameters":[{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it Retrieves all the data"}],"requestBodyExample":null,"responses":{"200":"IncoTermsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/letterOfCredits","fullPath":"/api/v2.0.0/holdings/letterOfCredits","operationId":"getLetterOfCredits","name":"Retrieves the list of letter of credits for specific customer","summary":"Retrieves letter of credit details","tags":["CORPORATE"],"parameters":[{"name":"letterOfCreditId","in":"query","type":"string","required":false,"description":"Identifier of the Letter Of Credit"},{"name":"customerId","in":"query","type":"string","required":false,"description":"Identifier of the customer"},{"name":"operation","in":"query","type":"string","required":false,"description":"Identifies the required operation to be executed for a Trade Finance contract. Input of valid codes as: O for opening of LC, P for Pre-advise of LC, A for Amend LC, C for Collect Charges, D for Decisi"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it Retrieves all the data"}],"requestBodyExample":null,"responses":{"200":"LetterOfCreditsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/letterOfCredits/exports/drawings","fullPath":"/api/v2.0.0/holdings/letterOfCredits/exports/drawings","operationId":"getExportDrawings","name":"Retrieves the list of export letter of credit drawings for specific customer","summary":"Retrieves export letter of credit drawings","tags":["CORPORATE"],"parameters":[{"name":"customerId","in":"query","type":"string","required":false,"description":"Identifier of the customer"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it Retrieves all the data"}],"requestBodyExample":null,"responses":{"200":"ExportDrawingsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/letterOfCredits/exports/amendments","fullPath":"/api/v2.0.0/holdings/letterOfCredits/exports/amendments","operationId":"getExportLCAmendments","name":"Retrieves the list of export letter of credit amendments for specific customer","summary":"Retrieves export letter of credit amendments","tags":["CORPORATE"],"parameters":[{"name":"customerId","in":"query","type":"string","required":false,"description":"Identifier of the customer"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it Retrieves all the data"}],"requestBodyExample":null,"responses":{"200":"ExportLCAmendmentsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/letterOfCredits/exports","fullPath":"/api/v2.0.0/holdings/letterOfCredits/exports","operationId":"getExportLc","name":"Retrieves the list of export letter of credits for specific customer","summary":"Retrieves export letter of credits","tags":["CORPORATE"],"parameters":[{"name":"customerId","in":"query","type":"string","required":false,"description":"Identifier of the customer"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it Retrieves all the data"}],"requestBodyExample":null,"responses":{"200":"ExportLcResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/letterOfCredits/imports/drawings","fullPath":"/api/v2.0.0/holdings/letterOfCredits/imports/drawings","operationId":"getImportDrawings","name":"Retrieves the list of import letter of credit drawings for specific customer","summary":"Retrieves import letter of credit drawings","tags":["CORPORATE"],"parameters":[{"name":"customerId","in":"query","type":"string","required":false,"description":"Identifier of the customer"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it Retrieves all the data"}],"requestBodyExample":null,"responses":{"200":"ImportDrawingsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/letterOfCredits/imports/amendments","fullPath":"/api/v2.0.0/holdings/letterOfCredits/imports/amendments","operationId":"getImportLCAmendments","name":"Retrieves the list of import letter of credit amendments for specific customer","summary":"Retrieves import letter of credit amendments","tags":["CORPORATE"],"parameters":[{"name":"customerId","in":"query","type":"string","required":false,"description":"Identifier of the customer"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it Retrieves all the data"}],"requestBodyExample":null,"responses":{"200":"ImportLCAmendmentsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/letterOfCredits/imports","fullPath":"/api/v2.0.0/holdings/letterOfCredits/imports","operationId":"getImportLc","name":"Retrieves the list of import letter of credits for specific customer","summary":"Retrieves import letter of credits","tags":["CORPORATE"],"parameters":[{"name":"customerId","in":"query","type":"string","required":false,"description":"Identifier of the customer"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it Retrieves all the data"}],"requestBodyExample":null,"responses":{"200":"ImportLcResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/letterOfCredits/outwardCollections/documents","fullPath":"/api/v2.0.0/holdings/letterOfCredits/outwardCollections/documents","operationId":"getOutwardCollectionDocuments","name":"Retrieves the list of outward collections document codes for specific customer","summary":"Retrieves the outward collection document codes","tags":["CORPORATE"],"parameters":[{"name":"lcAdviceTextId","in":"query","type":"string","required":false,"description":"This is the key to the letter of credit advice text file.During the input of an L/C this code can be entered for the inclusion of standard text."},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it Retrieves all the data"}],"requestBodyExample":null,"responses":{"200":"OutwardCollectionDocumentsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/letterOfCredits/inwardCollections/amendments","fullPath":"/api/v2.0.0/holdings/letterOfCredits/inwardCollections/amendments","operationId":"getInwardCollectionsAmendments","name":"Retrieves the list of inward collection amendments for specific customer","summary":"Retrieves the inward collection amendments","tags":["CORPORATE"],"parameters":[{"name":"customerId","in":"query","type":"string","required":false,"description":"Identifier of the customer"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it Retrieves all the data"}],"requestBodyExample":null,"responses":{"200":"InwardCollectionsAmendmentsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/letterOfCredits/inwardCollections","fullPath":"/api/v2.0.0/holdings/letterOfCredits/inwardCollections","operationId":"getInwardCollections","name":"Retrieves the list of inward collections for specific customer","summary":"Retrieves the inward collections","tags":["CORPORATE"],"parameters":[{"name":"customerId","in":"query","type":"string","required":false,"description":"Identifier of the customer"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it Retrieves all the data"}],"requestBodyExample":null,"responses":{"200":"InwardCollectionsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"POST","path":"/holdings/letterOfCredits/inwardCollections","fullPath":"/api/v2.0.0/holdings/letterOfCredits/inwardCollections","operationId":"createInwardCollection","name":"Lodgment of the Import documentary collection by the collecting bank ","summary":"Creates a new inward documentary collection","tags":["CORPORATE"],"parameters":[{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"Inward":[{}],"applicantAddresses":[{}],"advisingBanks":[{}],"beneficiaries":[{}],"guaranteeReferences":[{}],"documents":[{}],"additionalConditions":[{}],"instructions":[{}],"bankToBanks":[{}],"invoiceReferences":[{}],"transportation":[{}],"charges":[{}],"chargeCodes":[{}],"extensions":{}}},"responses":{"200":"InwardCollectionResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/holdings/letterOfCredits/tenors","fullPath":"/api/v2.0.0/holdings/letterOfCredits/tenors","operationId":"getLcTenors","name":"Retrieves the list of letter of credit tenor details","summary":"Retrieves letter of credit tenor details","tags":["CORPORATE"],"parameters":[{"name":"lcPayTypeId","in":"query","type":"string","required":false,"description":"Indicates the identifier of payment type enrichment for letter of credit."},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it Retrieves all the data"}],"requestBodyExample":null,"responses":{"200":"LcTenorsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/letterOfCredits/outwardCollections/amendments","fullPath":"/api/v2.0.0/holdings/letterOfCredits/outwardCollections/amendments","operationId":"getOutwardCollectionAmdendments","name":"Retrieves the list of outward collection amendments for specific customer","summary":"Retrieves outward collection amendments","tags":["CORPORATE"],"parameters":[{"name":"customerId","in":"query","type":"string","required":false,"description":"Identifier of the customer"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it Retrieves all the data"}],"requestBodyExample":null,"responses":{"200":"OutwardCollectionAmdendmentsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/letterOfCredits/outwardCollections","fullPath":"/api/v2.0.0/holdings/letterOfCredits/outwardCollections","operationId":"getOutwardCollections","name":"Retrieves the export documentary collection that are available for viewing","summary":"Retrieves the outward collection amendments","tags":["CORPORATE"],"parameters":[{"name":"customerId","in":"query","type":"string","required":false,"description":"Identifier of the customer"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it Retrieves all the data"}],"requestBodyExample":null,"responses":{"200":"OutwardCollectionsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"POST","path":"/holdings/letterOfCredits/outwardCollections","fullPath":"/api/v2.0.0/holdings/letterOfCredits/outwardCollections","operationId":"createOutwardCollections","name":"Initiation for the export documentary collection by the collecting bank","summary":"Creates the outward collections","tags":["CORPORATE"],"parameters":[{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"beneficiaryDetails":[{}],"issuingBankNames":[{}],"applicantNames":[{}],"documentCodes":[{}],"additionalConditions":[{}],"instructionDetails":[{}],"bankToBanks":[{}],"deliveryInstructions":[{}],"chargeCodes":[{}],"avalisationDetails":[{}],"externalReference":"string","beneficiaryCustomerId":"string","beneficiaryAccountId":"string","currencyId":"string","issueDate":"string"}},"responses":{"200":"OutwardCollectionsResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/holdings/letterOfCredits/limits","fullPath":"/api/v2.0.0/holdings/letterOfCredits/limits","operationId":"getLcLimits","name":"Retrieves the list of letter of credit limit details","summary":"Retrieves the letter of credit limits","tags":["CORPORATE"],"parameters":[{"name":"customerId","in":"query","type":"string","required":false,"description":"Identifier of the customer"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it Retrieves all the data"}],"requestBodyExample":null,"responses":{"200":"LcLimitsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"DELETE","path":"/holdings/letterOfCredits/drawings/{drawingId}/cancellations/","fullPath":"/api/v2.0.0/holdings/letterOfCredits/drawings/{drawingId}/cancellations/","operationId":"rejectDrawing","name":"Cancel an initiated drawing for letter of credit","summary":"Cancel initiated drawing","tags":["CORPORATE"],"parameters":[{"name":"drawingId","in":"path","type":"string","required":true,"description":"Identifier of drawings application under the Letter of Credit system that is used to effect the transfer of funds and the acceptance of documents under Letters of Credit and Documentary Collection tra"},{"name":"payload","in":"body","type":"object","required":false,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}}},"responses":{"200":"DrawingResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"DELETE","path":"/holdings/letterOfCredits/{letterOfCreditId}/amendments/cancellations","fullPath":"/api/v2.0.0/holdings/letterOfCredits/{letterOfCreditId}/amendments/cancellations","operationId":"rejectLcAmendment","name":"Cancel an initiated letter of credit amendment","summary":"Cancel letter of credit amendment","tags":["CORPORATE"],"parameters":[{"name":"letterOfCreditId","in":"path","type":"string","required":true,"description":"Identifier of the Letter Of Credit"},{"name":"payload","in":"body","type":"object","required":false,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}}},"responses":{"200":"LcAmendmentResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/holdings/letterOfCredits/ApprovedOutwardCollections","fullPath":"/api/v2.0.0/holdings/letterOfCredits/ApprovedOutwardCollections","operationId":"getApprovedOutwardCollections","name":"Retrieves the list of approved outward collections for specific customer","summary":"Retrieves approved outward collections","tags":["CORPORATE"],"parameters":[{"name":"collectionId","in":"query","type":"string","required":false,"description":"Identifier of collection id"},{"name":"beneficiaryCustomerId","in":"query","type":"string","required":false,"description":"Identifies the Customer who is to be the ultimate receiver of the funds transferred by the sending bank when this Beneficiary is not a bank."},{"name":"ibStatus","in":"query","type":"string","required":false,"description":"Field to indicate the status of LC request through internet banking."},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it Retrieves all the data"}],"requestBodyExample":null,"responses":{"200":"ApprovedOutwardCollectionsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/letterOfCredits/{lcAmendmentId}/amendment","fullPath":"/api/v2.0.0/holdings/letterOfCredits/{lcAmendmentId}/amendment","operationId":"getLcAmendment","name":"Retrieves the details of specific letter of credit amendment details","summary":"Overview details of letter of credit amendment","tags":["CORPORATE"],"parameters":[{"name":"lcAmendmentId","in":"path","type":"string","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"LcAmendmentResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"POST","path":"/holdings/letterOfCreditsInitiation","fullPath":"/api/v2.0.0/holdings/letterOfCreditsInitiation","operationId":"createLetterOfCredit","name":"Initiate a new letter of credit request for specific customer","summary":"Create letter of credit request","tags":["CORPORATE"],"parameters":[{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"applicantCustomerNames":[{}],"advisingBanks":[{}],"beneficiaryCustomerNames":[{}],"availableWithDetails":[{}],"additionalAmountsCovered":[{}],"deferredPayments":[{}],"contactDetails":[{}],"shipmentPeriods":[{}],"presentationPeriods":[{}],"descriptionOfGoods":[{}],"documentDetails":[{}],"documentsRequired":[{}],"clausesDetails":[{}],"additionalConditions":[{}],"narrativeCharges":[{}]}},"responses":{"200":"LetterOfCreditResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/holdings/letterOfCredit/{letterOfCreditId}","fullPath":"/api/v2.0.0/holdings/letterOfCredit/{letterOfCreditId}","operationId":"updateLetterOfCredit","name":"Update an existing letter of credit for specific customer","summary":"Update letter of credit","tags":["CORPORATE"],"parameters":[{"name":"letterOfCreditId","in":"path","type":"string","required":true,"description":"Identifier of the Letter Of Credit"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"applicantCustomerNames":[{}],"advisingBanks":[{}],"beneficiaryCustomerNames":[{}],"availableWithDetails":[{}],"additionalAmountsCovered":[{}],"deferredPayments":[{}],"contactDetails":[{}],"shipmentPeriods":[{}],"presentationPeriods":[{}],"descriptionOfGoods":[{}],"documentDetails":[{}],"documentsRequired":[{}],"clausesDetails":[{}],"additionalConditions":[{}],"narrativeCharges":[{}]}},"responses":{"200":"LetterOfCreditResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/holdings/letterOfCredits/{letterOfCreditId}","fullPath":"/api/v2.0.0/holdings/letterOfCredits/{letterOfCreditId}","operationId":"getLetterOfCredit","name":"Retrieves the details of specific letter of credit","summary":"Retrieves the details of letter of credit","tags":["CORPORATE"],"parameters":[{"name":"letterOfCreditId","in":"path","type":"string","required":true,"description":"Identifier of the Letter Of Credit"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"LetterOfCreditResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"POST","path":"/holdings/letterOfCredits/{letterOfCreditId}","fullPath":"/api/v2.0.0/holdings/letterOfCredits/{letterOfCreditId}","operationId":"updateExternalAmendmentToAnLC","name":"Updates the  amendments to the letter of credit for the specified letter of credit/customer reference number","summary":"Updates letter of credit details","tags":["CORPORATE"],"parameters":[{"name":"letterOfCreditId","in":"path","type":"string","required":true,"description":""},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"additionalAmountsCovered":[{}],"amendmentInformations":[{}],"beneficiaries":[{}],"narrativeCharges":[{}],"reimbursingBankAndAddresses":[{}],"bankToBanks":[{}],"charges":[{}],"chargeCodes":[{}],"commissionDetails":[{}],"margins":[{}],"issuingBankNames":[{}],"applicantAddresses":[{}],"availableWithBanks":[{}],"draftsAt":[{}],"drawees":[{}]}},"responses":{"200":"ExternalAmendmentToAnLCResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"DELETE","path":"/holdings/letterOfCredits/{letterOfCreditId}","fullPath":"/api/v2.0.0/holdings/letterOfCredits/{letterOfCreditId}","operationId":"deleteLetterOfCredit","name":"Remove an existing letter of credit for specific customer","summary":"Remove letter of credit","tags":["CORPORATE"],"parameters":[{"name":"letterOfCreditId","in":"path","type":"string","required":true,"description":"Identifier of the Letter Of Credit"},{"name":"payload","in":"body","type":"object","required":false,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}}},"responses":{"200":"LetterOfCreditResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/holdings/letterOfCredits/letterOfCreditApprovals/{letterOfCreditId}","fullPath":"/api/v2.0.0/holdings/letterOfCredits/letterOfCreditApprovals/{letterOfCreditId}","operationId":"approveLetterOfCredit","name":"Approve an initiated letter of credit request for specific customer","summary":"Approve letter of credit request","tags":["CORPORATE"],"parameters":[{"name":"letterOfCreditId","in":"path","type":"string","required":true,"description":"Identifier of the Letter Of Credit"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"LetterOfCreditResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"DELETE","path":"/holdings/letterOfCredits/cancellations/{letterOfCreditId}","fullPath":"/api/v2.0.0/holdings/letterOfCredits/cancellations/{letterOfCreditId}","operationId":"rejectLetterOfCredit","name":"Cancel an initiated letter of credit request for specific customer","summary":"Cancel letter of credit request","tags":["CORPORATE"],"parameters":[{"name":"letterOfCreditId","in":"path","type":"string","required":true,"description":"Identifier of the Letter Of Credit"},{"name":"payload","in":"body","type":"object","required":false,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}}},"responses":{"200":"LetterOfCreditResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"POST","path":"/holdings/letterOfCredit/exports","fullPath":"/api/v2.0.0/holdings/letterOfCredit/exports","operationId":"createExportLetterOfCredit","name":"Create a new export letter of credit for specific customer","summary":"Create export letter of credit","tags":["CORPORATE"],"parameters":[{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"applicantCustomerNames":[{}],"advisingBanks":[{}],"beneficiaryCustomerNames":[{}],"availableWithDetails":[{}],"additionalAmountsCovered":[{}],"deferredPayments":[{}],"contactDetails":[{}],"shipmentPeriods":[{}],"presentationPeriods":[{}],"descriptionOfGoods":[{}],"documentDetails":[{}],"documentsRequired":[{}],"clausesDetails":[{}],"additionalConditions":[{}],"narrativeCharges":[{}]}},"responses":{"200":"ExportLetterOfCreditResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/holdings/letterOfCredit/{letterOfCreditId}/exports","fullPath":"/api/v2.0.0/holdings/letterOfCredit/{letterOfCreditId}/exports","operationId":"updateExportLetterOfCredit","name":"Update a new export letter of credit for specific customer","summary":"Update export letter of credit","tags":["CORPORATE"],"parameters":[{"name":"letterOfCreditId","in":"path","type":"string","required":true,"description":"Identifier of the Letter Of Credit"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"applicantCustomerNames":[{}],"advisingBanks":[{}],"beneficiaryCustomerNames":[{}],"availableWithDetails":[{}],"additionalAmountsCovered":[{}],"deferredPayments":[{}],"contactDetails":[{}],"shipmentPeriods":[{}],"presentationPeriods":[{}],"descriptionOfGoods":[{}],"documentDetails":[{}],"documentsRequired":[{}],"clausesDetails":[{}],"additionalConditions":[{}],"narrativeCharges":[{}]}},"responses":{"200":"ExportLetterOfCreditResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"POST","path":"/holdings/letterOfCredits/sightPayments","fullPath":"/api/v2.0.0/holdings/letterOfCredits/sightPayments","operationId":"createIssuanceOfSightPaymentLC","name":"Creates sight payment letter of credit for the requested customer reference number","summary":"Create sight payment letter of credit","tags":["CORPORATE"],"parameters":[{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"applicantAddresses":[{}],"beneficiaryAddresses":[{}],"advisingBankAddresses":[{}],"adviseThroughBanks":[{}],"availableWithBanks":[{}],"reimbursingBanks1":[{}],"requestedConfirmBankNames":[{}],"charges":[{}],"importSightPmtLcType":"string","lcNumber":"string","applicant":"string","lcCurrency":"string","lcAmount":0.0,"creditTolerance":"string","debitTolerance":"string"}},"responses":{"200":"IssuanceOfSightPaymentLCResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"POST","path":"/holdings/letterOfCredits/usances","fullPath":"/api/v2.0.0/holdings/letterOfCredits/usances","operationId":"createIssuanceOfUsanceLC","name":"Creates usance letter of credit for the requested customer reference number","summary":"Create usance letter of credit","tags":["CORPORATE"],"parameters":[{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"applicantAddresses":[{}],"limitReferences":[{}],"beneficiaryAddresses":[{}],"advisingBankAddresses":[{}],"adviseThroughBanks":[{}],"availableWithBanks":[{}],"reimbursingBanks1":[{}],"requestedConfirmBankNames":[{}],"charges":[{}],"importUsanceLCType":"string","lcNumber":"string","applicant":"string","currency":"string","amount":0.0,"creditTolerance":"string"}},"responses":{"200":"IssuanceOfUsanceLCResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"POST","path":"/holdings/letterOfCredits/negotiations","fullPath":"/api/v2.0.0/holdings/letterOfCredits/negotiations","operationId":"createIssuanceOfNegotiationLC","name":"Creates negotiation letter of credit for the requested customer reference number","summary":"Create negotiation letter of credit","tags":["CORPORATE"],"parameters":[{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"applicantAddresses":[{}],"beneficiaryAddresses":[{}],"advisingBankAddresses":[{}],"adviseThroughBanks":[{}],"availableWithBanks":[{}],"reimbursingBanks1":[{}],"requestedConfirmBankNames":[{}],"charges":[{}],"importNegotiationLCType":"string","lcNumber":"string","applicant":"string","lcCurrency":"string","lcAmount":"string","creditTolerance":"string","debitTolerance":"string"}},"responses":{"200":"IssuanceOfNegotiationLCResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"POST","path":"/holdings/letterOfCredits/mixedPayments","fullPath":"/api/v2.0.0/holdings/letterOfCredits/mixedPayments","operationId":"createIssuanceOfMixedPaymentLC","name":"Creates mixed payment letter of credit for the requested customer reference number","summary":"Create mixed payment letter of credit","tags":["CORPORATE"],"parameters":[{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"applicantAddresses":[{}],"beneficiaryAddresses":[{}],"advisingBankAddresses":[{}],"adviseThroughBanks":[{}],"availableWithBanks":[{}],"reimbursingBanks1":[{}],"requestedConfirmBankNames":[{}],"charges":[{}],"drawings":[{}],"importMixedPmtLCType":"string","lcNumber":"string","applicantCustomer":"string","lcCurrency":"string","lcAmount":"string","creditTolerance":"string"}},"responses":{"200":"IssuanceOfMixedPaymentLCResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"POST","path":"/holdings/letterOfCredits/standbys","fullPath":"/api/v2.0.0/holdings/letterOfCredits/standbys","operationId":"createIssuanceOfStandbyLC","name":"Creates standby letter of credit for the requested customer reference number","summary":"Create standby letter of credit","tags":["CORPORATE"],"parameters":[{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"applicantAddresses":[{}],"limitReferences":[{}],"beneficiaryAddresses":[{}],"advisingBankAddresses":[{}],"adviseThroughBanks":[{}],"availableWithBanks":[{}],"reimbursingBanks1":[{}],"requestedConfirmBankNames":[{}],"charges":[{}],"importLCType":"string","lcNumber":"string","applicantCustomer":"string","lcCurrency":"string","lcAmount":0.0,"creditTolerance":"string"}},"responses":{"200":"IssuanceOfStandbyLCResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"POST","path":"/holdings/letterOfCredits/imports/preAdvises","fullPath":"/api/v2.0.0/holdings/letterOfCredits/imports/preAdvises","operationId":"createIssuanceOfPreAdviseImportLC","name":"Creates a pre-advice import letter of credit request.","summary":"Creates pre-advice letter of credit","tags":["CORPORATE"],"parameters":[{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"applicantAddresses":[{}],"limitReferences":[{}],"beneficiaryAddresses":[{}],"advisingBankAddresses":[{}],"adviseThroughBanks":[{}],"availableWithBanks":[{}],"reimbursingBanks1":[{}],"requestedConfirmBankNames":[{}],"charges":[{}],"lcNumber":"string","lcType":"string","applicant":"string","currency":"string","amount":0.0,"creditTolerance":"string"}},"responses":{"200":"IssuanceOfPreAdviseImportLCResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"POST","path":"/holdings/letterOfCredits/backToBacks","fullPath":"/api/v2.0.0/holdings/letterOfCredits/backToBacks","operationId":"createIssuanceOfBackToBackLC","name":"Creates back-to-back letter of credit for the requested customer reference number","summary":"Creates back-to-back letter of credit","tags":["CORPORATE"],"parameters":[{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"limitReferences":[{}],"beneficiaryAddresses":[{}],"applicantNames":[{}],"availableWithBanks":[{}],"adviseThroughBanks":[{}],"charges":[{}],"drawings":[{}],"accountWithBanks":[{}],"senderReceiversInfoMT730":[{}],"exportLCType":"string","backToBackLCRequired":"string","relatedImportLCReference":"string","advisingBankReference":"string","lcAdvisingReference":"string","issuingBankLCReference":"string"}},"responses":{"200":"IssuanceOfBackToBackLCResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"POST","path":"/holdings/letterOfCredits/transferables","fullPath":"/api/v2.0.0/holdings/letterOfCredits/transferables","operationId":"createIssuanceOfTransferableLC","name":"Creates transferable letter of credit for the requested customer reference number","summary":"Creates transferable letter of credit","tags":["CORPORATE"],"parameters":[{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"advisingBanks":[{}],"limitReferences":[{}],"drawings":[{}],"charges":[{}],"assignments":[{}],"secondBeneficiaries":[{}],"availableWithBanks":[{}],"draftsAt":[{}],"drawees":[{}],"mixedPaymentDetails":[{}],"negotiationDeferredPaymentDetails":[{}],"shipmentPeriods":[{}],"documentsRequired":[{}],"additionalConditions":[{}],"narrativeCharges":[{}]}},"responses":{"200":"IssuanceOfTransferableLCResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"POST","path":"/holdings/letterOfCredits/{letterOfCreditId}/beneficiaryConsents","fullPath":"/api/v2.0.0/holdings/letterOfCredits/{letterOfCreditId}/beneficiaryConsents","operationId":"updateAmendmentSeekingBeneficiaryConsent","name":"Updates letter of credit amendments seeking beneficiary's consent for the specified letter of credit/customer reference number","summary":"Updates letter of credit beneficiary's consent details","tags":["CORPORATE"],"parameters":[{"name":"letterOfCreditId","in":"path","type":"string","required":true,"description":"Identifier of the Letter Of Credit"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"advisingBankIds":[{}],"beneficiaryAddresses":[{}],"documentsRequired":[{}],"additionalConditions":[{}],"charges":[{}],"lcCurrency":"string","lcAmount":0.0,"issueDate":"2024-01-01","beneficiaryId":"string","lcLiabilityAmountOutStanding":"string","pendingAmendMovement":"string","debitTolerance":"string","creditTolerance":"string","advisingBankReference":"string","increaseOrDecreaseAmount":0.0}},"responses":{"200":"AmendmentSeekingBeneficiaryConsentResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"POST","path":"/holdings/letterOfCredits/{letterOfCreditId}/imports/decisions","fullPath":"/api/v2.0.0/holdings/letterOfCredits/{letterOfCreditId}/imports/decisions","operationId":"updateDecisionOnAmendment","name":"Updates the decision on amendments to import letter of credit for the specified letter of credit/customer reference number","summary":"Updates decision on amendment to the import letter of credit","tags":["CORPORATE"],"parameters":[{"name":"letterOfCreditId","in":"path","type":"string","required":true,"description":"Identifier of the Letter Of Credit"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"additionalAmountsCovered":[{}],"limitReferences":[{}],"beneficiaries":[{}],"bankToBanks":[{}],"internalAmendmentDetails":[{}],"charges":[{}],"commissions":[{}],"amendmentNumber":"string","amendStatus":"string","sendAmendmentAdvice":"string","lcNumber":"string","advisingBankReference":"string","issueDate":"2024-01-01","lcType":"string","amendmentDate":"2024-01-01"}},"responses":{"200":"DecisionOnAmendmentResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"POST","path":"/holdings/letterOfCredits/{letterOfCreditId}/imports/cancellations","fullPath":"/api/v2.0.0/holdings/letterOfCredits/{letterOfCreditId}/imports/cancellations","operationId":"updateCancellationOfLC","name":"Updates the cancellation details of the issued import letter of credit for the specified letter of credit/customer reference number","summary":"Updates import letter of credit cancellation details","tags":["CORPORATE"],"parameters":[{"name":"letterOfCreditId","in":"path","type":"string","required":true,"description":"Identifier of the Letter Of Credit"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"limitReferences":[{}],"beneficiaries":[{}],"charges":[{}],"commissions":[{}],"lcNumber":"string","sendAmendmentAdvice":"string","lcType":"string","advisingBankReference":"string","applicantCustomer":"string","advisingBank":"string","issueDate":"string","newLcCurrency":"string","newLcAmount":"string","creditTolerance":"string","debitTolerance":"string"}},"responses":{"200":"CancellationOfLCResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"POST","path":"/holdings/letterOfCredits/{letterOfCreditId}/exports/decisions","fullPath":"/api/v2.0.0/holdings/letterOfCredits/{letterOfCreditId}/exports/decisions","operationId":"updateDecisionOnExportLCAmendment","name":"Updates the decision on amendments to export letter of credit for the specified letter of credit/customer reference number","summary":"Updates decision on amendment to the export letter of credit","tags":["CORPORATE"],"parameters":[{"name":"letterOfCreditId","in":"path","type":"string","required":true,"description":"Identifier of the Letter Of Credit"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"beneficiaries":[{}],"shipmentPeriods":[{}],"internalAmendmentDetails":[{}],"charges":[{}],"amendmentNumber":"string","lcType":"string","amendStatus":"string","applicantCustomer":"string","lcNumber":"string","sendAmendmentAdvice":"string","issuingBankReference":"string","issueDate":"string","issuingBankId":"string","lcCurrency":"string","lcAmount":"string"}},"responses":{"200":"DecisionOnExportLCAmendmentResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"POST","path":"/holdings/letterOfCredits/{letterOfCreditId}/exports/cancellations","fullPath":"/api/v2.0.0/holdings/letterOfCredits/{letterOfCreditId}/exports/cancellations","operationId":"updateCancellationOfExportLC","name":"Updates the cancellation details of the issued export letter of credit for the specified letter of credit/customer reference number","summary":"Updates export letter of credit cancellation details ","tags":["CORPORATE"],"parameters":[{"name":"letterOfCreditId","in":"path","type":"string","required":true,"description":""},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"applicants":[{}],"additionalAmountsCovered":[{}],"beneficiaries":[{}],"charges":[{}],"lcNumber":"string","sendAmendmentAdvice":"string","lcType":"string","issuingBankReference":"string","issuingBankId":"string","lcIssueDate":"string","newLcCurrency":"string","newLcAmount":"string","creditTolerance":"string","debitTolerance":"string","purposeOfMessage":"string"}},"responses":{"200":"CancellationOfExportLCResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/holdings/customers/{customerId}/letterOfCredits/imports/outstandings","fullPath":"/api/v2.0.0/holdings/customers/{customerId}/letterOfCredits/imports/outstandings","operationId":"getImportLcsOutstanding","name":"Retrieves the details of outstanding import letter of credits for the specified customer/guarantee reference.","summary":"Retrieves outstanding import letter of credit details","tags":["CORPORATE"],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"Identifier of the customer"},{"name":"transactionReference","in":"query","type":"string","required":false,"description":"Contains the identifier for the transaction in the core system"},{"name":"lcCurrency","in":"query","type":"string","required":false,"description":"Denote the currency of the Letter of Credit."},{"name":"advisingBank","in":"query","type":"string","required":false,"description":"Identifies the advising bank under the Letter of Credit, through whom the Letter of Credit is to be advised to the second advising bank or beneficiary"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it Retrieves all the data"}],"requestBodyExample":null,"responses":{"200":"ImportLcsOutstandingResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/customers/{customerId}/letterOfCredits/imports/expiries","fullPath":"/api/v2.0.0/holdings/customers/{customerId}/letterOfCredits/imports/expiries","operationId":"getImportLcsExpiringButOutstanding","name":"Retrieves the expired import letter of credit details for the specified customer/guarantee reference.","summary":"Retrieves expired import letter of credit details","tags":["CORPORATE"],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":""},{"name":"transactionReference","in":"query","type":"string","required":false,"description":"Contains the identifier for the transaction in the core system"},{"name":"applicantCustomer","in":"query","type":"string","required":false,"description":"Indicates the applicant ID on whose behalf the Letter of Credit is issued."},{"name":"lcCurrency","in":"query","type":"string","required":false,"description":"Denote the currency of the Letter of Credit."},{"name":"advisingBank","in":"query","type":"string","required":false,"description":"Identifies the advising bank under the Letter of Credit, through whom the Letter of Credit is to be advised to the second advising bank or beneficiary"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it Retrieves all the data"}],"requestBodyExample":null,"responses":{"200":"ImportLcsExpiringButOutstandingResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/letterOfCredits/{letterOfCreditId}/exports/outstandings","fullPath":"/api/v2.0.0/holdings/letterOfCredits/{letterOfCreditId}/exports/outstandings","operationId":"getExportlcsOutstanding","name":"Retrieves the details of outstanding export letter of credits for the specified customer/guarantee reference.","summary":"Retrieves outstanding export letter of credit details","tags":["CORPORATE"],"parameters":[{"name":"letterOfCreditId","in":"path","type":"string","required":true,"description":""},{"name":"transactionReference","in":"query","type":"string","required":false,"description":"Contains the identifier for the transaction in the core system"},{"name":"issuingBankId","in":"query","type":"string","required":false,"description":"Identifies the Issuing bank ID under the LC, who issues the LC under when a bank is advising the Letter of Credit"},{"name":"lcCurrency","in":"query","type":"string","required":false,"description":"Denote the currency of the Letter of Credit."},{"name":"lcAmount","in":"query","type":"string","required":false,"description":"This field indicates the amount of the Letter of Credit that will always be expressed in the currency of Letter of Credit."},{"name":"beneficiaryCustomerId","in":"query","type":"string","required":false,"description":"Identifies the Customer who is to be the ultimate receiver of the funds transferred by the sending bank when this Beneficiary is not a bank."},{"name":"expiryDate","in":"query","type":"string","required":false,"description":"This indicates the  date  on which the offer or privilege terminates for the event."},{"name":"liabilityReversalDate","in":"query","type":"string","required":false,"description":"Date on which the contingent entries and the limits raised on the LC will be reversed."},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it Retrieves all the data"}],"requestBodyExample":null,"responses":{"200":"ExportlcsOutstandingResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"PUT","path":"/holdings/letterOfCredits/{letterOfCreditId}/outwardCollections","fullPath":"/api/v2.0.0/holdings/letterOfCredits/{letterOfCreditId}/outwardCollections","operationId":"amendOutwardCollections","name":"Amendments to an outward collection contracts are processed by updating the new values in the contract","summary":"Updates the outward collections","tags":["CORPORATE"],"parameters":[{"name":"letterOfCreditId","in":"path","type":"string","required":true,"description":"Identifier of the Letter Of Credit"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"applicantNames":[{}],"advisingBanks":[{}],"beneficiaryDetails":[{}],"availableWithDetails":[{}],"additionalAmountsCovered":[{}],"deferredPayments":[{}],"contactDetails":[{}],"shipmentPeriods":[{}],"presentationPeriods":[{}],"descriptionOfGoods":[{}],"documentCodes":[{}],"documentDetails":[{}],"documentsRequired":[{}],"clausesDetails":[{}],"additionalConditions":[{}]}},"responses":{"200":"OutwardCollectionsResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/holdings/letterOfCredits/outwardCollections/outstandings","fullPath":"/api/v2.0.0/holdings/letterOfCredits/outwardCollections/outstandings","operationId":"getOutwardCollectionsOutstanding","name":"Retrieves the outstanding details of outward collections","summary":"Retrieves the outstanding details of outward collections","tags":["CORPORATE"],"parameters":[{"name":"collectionReference","in":"query","type":"string","required":true,"description":"The ID of the Letter of Credit, to be linked to this Guarantee for the purpose of apportioning the Margin"},{"name":"beneficiaryCustomerId","in":"query","type":"string","required":false,"description":"Identifies the Customer who is to be the ultimate receiver of the funds transferred by the sending bank when this Beneficiary is not a bank."},{"name":"currencyId","in":"query","type":"string","required":false,"description":"Identifier of the currency. This is the 3-letter ISO 4217 code of the currency."},{"name":"days","in":"query","type":"string","required":false,"description":"Valid for Documentary Collections and used in conjunction with the field TENOR to indicate the tenor of the drafts under the collection. It is used in the production of corresponding documentary colle"},{"name":"tenor","in":"query","type":"string","required":false,"description":"This field is valid for Documentary Collections only. It is used in conjunction with the following field 'DAYS' or 'COLL.MAT.CODE' to indicate the TENOR of the drafts under the collection and is used "},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it Retrieves all the data"}],"requestBodyExample":null,"responses":{"200":"OutwardCollectionsOutstandingResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"POST","path":"/holdings/letterOfCredits/drawings/{drawingId}/documents","fullPath":"/api/v2.0.0/holdings/letterOfCredits/drawings/{drawingId}/documents","operationId":"createDrawingDocument","name":"Initiate the registration of a presentation done for letter of credit transaction","summary":"Initiate a new drawing request to register the documents for letter of credit","tags":["CORPORATE"],"parameters":[{"name":"drawingId","in":"path","type":"string","required":true,"description":"Identifier of drawings application under the Letter of Credit system that is used to effect the transfer of funds and the acceptance of documents under Letters of Credit and Documentary Collection tra"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"presentorIds":[{}],"presentorCustomerId":"string","referenceId":"string","currencyId":"string","documentAmount":0.0,"creditAccountId":"string","debitAccountId":"string","paymentMethod":"string","nextReviewDate":"2024-01-01","days":"string","documentReceived":"string","maturityReview":"string","extensions":{}}},"responses":{"200":"DrawingDocumentResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/holdings/letterOfCredits/drawings","fullPath":"/api/v2.0.0/holdings/letterOfCredits/drawings","operationId":"getDrawingsDetails","name":"Retrieves the list of drawings for specific customer","summary":"Retrieves drawing details","tags":["CORPORATE"],"parameters":[{"name":"drawingId","in":"query","type":"string","required":false,"description":"Identifier of drawings application under the Letter of Credit system that is used to effect the transfer of funds and the acceptance of documents under Letters of Credit and Documentary Collection tra"},{"name":"applicantCustomer","in":"query","type":"string","required":true,"description":"Indicates the applicant ID on whose behalf the Letter of Credit is issued."},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it Retrieves all the data"}],"requestBodyExample":null,"responses":{"200":"DrawingsDetailsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"POST","path":"/holdings/letterOfCredits/initiations","fullPath":"/api/v2.0.0/holdings/letterOfCredits/initiations","operationId":"createLetterOfCreditInitiation","name":"Initiate a new letter of credit request for specific customer","summary":"Creates letter of credit request","tags":["CORPORATE"],"parameters":[{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"applicantAddresses":[{}],"advisingBanks":[{}],"beneficiaries":[{}],"availableWithBanks":[{}],"additionalAmountsCovered":[{}],"deferredPayments":[{}],"contactDetails":[{}],"shipmentPeriods":[{}],"presentationPeriods":[{}],"descriptionsOfGoods":[{}],"documentCodes":[{}],"documentDetails":[{}],"documentsRequired":[{}],"additionalConditions":[{}],"narrativeCharges":[{}]}},"responses":{"200":"LetterOfCreditInitiationResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}}]},{"key":"holdings-letterOfCredit-service-v3.0.0","title":"Management of Letter of Credits","version":"v3.0.0","description":"API to create, update and manage various types of trade finance letter of credit (LC) instruments and their associated status and details. Some of the types of LCs that can be created are sight payments, back-to-back, standby's and usance LCs","endpointCount":82,"endpoints":[{"method":"POST","path":"/holdings/letterOfCredits/drawingsInitiation/{drawingId}","fullPath":"/api/v3.0.0/holdings/letterOfCredits/drawingsInitiation/{drawingId}","operationId":"createDrawings","name":"Initiate a new drawing request for a specific letter of credit","summary":"Initiate a new drawing request to check the documents for letter of credit","tags":["CORPORATE"],"parameters":[{"name":"drawingId","in":"path","type":"string","required":true,"description":"Identifier of drawings application under the Letter of Credit system that is used to effect the transfer of funds and the acceptance of documents under Letters of Credit and Documentary Collection tra"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"addresses":[{}],"documentStatus":[{}],"clausesTexts":[{}],"invoiceDocuments":[{}],"transportDocuments":[{}],"documents":[{}],"discrepancyDetails":[{}],"presentorCustomerId":"string","referenceId":"string","currencyId":"string","documentAmount":0.0,"paymentMethod":"string","debitAccountId":"string","creditAccountId":"string","nextReviewDate":"2024-01-01"}},"responses":{"200":"DrawingsResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"POST","path":"/holdings/letterOfCredits/drawings/{drawingId}/initiations","fullPath":"/api/v3.0.0/holdings/letterOfCredits/drawings/{drawingId}/initiations","operationId":"createDrawing","name":"Initiate a new drawing request registerered  for a specific letter of credit","summary":"Initiate a new drawing request to check the documents for letter of credit","tags":["CORPORATE"],"parameters":[{"name":"drawingId","in":"path","type":"string","required":true,"description":"Identifier of drawings application under the Letter of Credit system that is used to effect the transfer of funds and the acceptance of documents under Letters of Credit and Documentary Collection tra"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"addresses":[{}],"documentStatus":[{}],"clausesTexts":[{}],"invoiceDocuments":[{}],"transportDocuments":[{}],"documents":[{}],"discrepancyDetails":[{}],"presentorCustomerId":"string","referenceId":"string","currencyId":"string","documentAmount":0.0,"paymentMethod":"string","debitAccountId":"string","creditAccountId":"string","nextReviewDate":"2024-01-01"}},"responses":{"200":"DrawingResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/holdings/letterOfCredits/drawings/{drawingId}","fullPath":"/api/v3.0.0/holdings/letterOfCredits/drawings/{drawingId}","operationId":"getDrawing","name":"Retrieve the details of specific drawing that is created against a letter of credit","summary":"Retrieve the drawing requests for a specific letter of credit","tags":["CORPORATE"],"parameters":[{"name":"drawingId","in":"path","type":"string","required":true,"description":"Identifier of drawings application under the Letter of Credit system that is used to effect the transfer of funds and the acceptance of documents under Letters of Credit and Documentary Collection tra"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"DrawingResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/holdings/letterOfCredits/drawings/{drawingId}","fullPath":"/api/v3.0.0/holdings/letterOfCredits/drawings/{drawingId}","operationId":"updateDrawing","name":"Update an existing drawing for a specific letter of credit","summary":"Update drawing details","tags":["CORPORATE"],"parameters":[{"name":"drawingId","in":"path","type":"string","required":true,"description":"Identifier of drawings application under the Letter of Credit system that is used to effect the transfer of funds and the acceptance of documents under Letters of Credit and Documentary Collection tra"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"addresses":[{}],"documentStatus":[{}],"clausesTexts":[{}],"invoiceDocuments":[{}],"transportDocuments":[{}],"documents":[{}],"discrepancyDetails":[{}],"presentorCustomerId":"string","referenceId":"string","documentAmount":0.0,"paymentMethod":"string","debitAccountId":"string","creditAccountId":"string","nextReviewDate":"2024-01-01","valueDate":"2024-01-01"}},"responses":{"200":"DrawingResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"DELETE","path":"/holdings/letterOfCredits/drawings/{drawingId}","fullPath":"/api/v3.0.0/holdings/letterOfCredits/drawings/{drawingId}","operationId":"deleteDrawing","name":"Remove an existing drawing for a specific letter of credit","summary":"Remove drawing details","tags":["CORPORATE"],"parameters":[{"name":"drawingId","in":"path","type":"string","required":true,"description":"Identifier of drawings application under the Letter of Credit system that is used to effect the transfer of funds and the acceptance of documents under Letters of Credit and Documentary Collection tra"},{"name":"payload","in":"body","type":"object","required":false,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}}},"responses":{"200":"DrawingResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/holdings/letterOfCredits/drawingsApprovals/{drawingId}","fullPath":"/api/v3.0.0/holdings/letterOfCredits/drawingsApprovals/{drawingId}","operationId":"approveDrawing","name":"Approve a drawing  for specific letter of credit","summary":"Approve drawing ","tags":["CORPORATE"],"parameters":[{"name":"drawingId","in":"path","type":"string","required":true,"description":"Identifier of drawings application under the Letter of Credit system that is used to effect the transfer of funds and the acceptance of documents under Letters of Credit and Documentary Collection tra"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"DrawingResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/holdings/letterOfCredits/documents/{documentId}","fullPath":"/api/v3.0.0/holdings/letterOfCredits/documents/{documentId}","operationId":"getLcDocument","name":"Retrieves the details of specific letter of credit advice text","summary":"Overview details of letter of credit advice text","tags":["CORPORATE"],"parameters":[{"name":"documentId","in":"path","type":"string","required":true,"description":"Based on documentCode, the field defaults the required document codes"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"LcDocumentResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"POST","path":"/holdings/letterOfCredits/documents/{documentId}","fullPath":"/api/v3.0.0/holdings/letterOfCredits/documents/{documentId}","operationId":"createLcDocument","name":"Create a new letter of credit advice text","summary":"Create letter of credit advice text","tags":["CORPORATE"],"parameters":[{"name":"documentId","in":"path","type":"string","required":true,"description":"Based on documentCode, the field defaults the required document codes"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"documentDetails":[{}],"extensions":{}}},"responses":{"200":"LcDocumentResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/holdings/letterOfCredits/documents/{documentId}","fullPath":"/api/v3.0.0/holdings/letterOfCredits/documents/{documentId}","operationId":"updateLcDocument","name":"Update an existing letter of credit advice text","summary":"Update letter of credit advice text","tags":["CORPORATE"],"parameters":[{"name":"documentId","in":"path","type":"string","required":true,"description":"Based on documentCode, the field defaults the required document codes"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"documentDetails":[{}],"extensions":{}}},"responses":{"200":"LcDocumentResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"DELETE","path":"/holdings/letterOfCredits/documents/{documentId}","fullPath":"/api/v3.0.0/holdings/letterOfCredits/documents/{documentId}","operationId":"deleteLcDocument","name":"Delete an existing letter of credit advice text","summary":"Delete letter of credit advice text","tags":["CORPORATE"],"parameters":[{"name":"documentId","in":"path","type":"string","required":true,"description":"Based on documentCode, the field defaults the required document codes"},{"name":"payload","in":"body","type":"object","required":false,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}}},"responses":{"200":"LcDocumentResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"POST","path":"/holdings/letterOfCredits/{letterOfCreditId}/amendmentsInitiation","fullPath":"/api/v3.0.0/holdings/letterOfCredits/{letterOfCreditId}/amendmentsInitiation","operationId":"createLcAmendments","name":"Initiate a new letter of credit amendment","summary":"Initiate letter of credit amendment","tags":["CORPORATE"],"parameters":[{"name":"letterOfCreditId","in":"path","type":"string","required":true,"description":"Identifier of the Letter Of Credit"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"ibLimitExceeds":[{}],"additionalAmountsCovered":[{}],"shipmentPeriods":[{}],"lcAmend":[{}],"messageFromCustomers":[{}],"messageFromBanks":[{}],"overrides":[{}],"lcAmount":0.0,"increaseDecreaseAmount":0.0,"decreaseCreditAmount":0.0,"increaseCreditAmount":0.0,"maximumCreditAmount":"string","newAdviceExpiryDate":"2024-01-01","shipmentDespatch":"string","otherDespatchDetails":"string"}},"responses":{"200":"LcAmendmentsResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"POST","path":"/holdings/letterOfCredits/{letterOfCreditId}/amendments/initiations","fullPath":"/api/v3.0.0/holdings/letterOfCredits/{letterOfCreditId}/amendments/initiations","operationId":"createLcAmendment","name":"Initiate a new letter of credit amendment","summary":"Initiate letter of credit amendment","tags":["CORPORATE"],"parameters":[{"name":"letterOfCreditId","in":"path","type":"string","required":true,"description":"Identifier of the Letter Of Credit"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"ibLimitExceeds":[{}],"additionalAmountsCovered":[{}],"shipmentPeriods":[{}],"lcAmend":[{}],"messageFromCustomers":[{}],"messageFromBanks":[{}],"overrides":[{}],"lcAmount":0.0,"increaseDecreaseAmount":0.0,"decreaseCreditAmount":0.0,"increaseCreditAmount":0.0,"maximumCreditAmount":"string","newAdviceExpiryDate":"2024-01-01","shipmentDespatch":"string","otherDespatchDetails":"string"}},"responses":{"200":"LcAmendmentResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/holdings/letterOfCredits/{letterOfCreditId}/amendments","fullPath":"/api/v3.0.0/holdings/letterOfCredits/{letterOfCreditId}/amendments","operationId":"getLCAmendments","name":"Retrieves the list of letter of credit amendment details","summary":"Retrieves the letter of credit amendments","tags":["CORPORATE"],"parameters":[{"name":"letterOfCreditId","in":"path","type":"string","required":true,"description":"Identifier of the Letter Of Credit"},{"name":"eventStatus","in":"query","type":"string","required":false,"description":"Specifies the status of the request.Allowed values are - With Bank_With Customer_Approved_Rejected."},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"LCAmendmentsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"PUT","path":"/holdings/letterOfCredits/{letterOfCreditId}/amendments","fullPath":"/api/v3.0.0/holdings/letterOfCredits/{letterOfCreditId}/amendments","operationId":"updateLcAmendment","name":"Update an existing amendment for specific letter of credit","summary":"Update letter of credit amendment","tags":["CORPORATE"],"parameters":[{"name":"letterOfCreditId","in":"path","type":"string","required":true,"description":"Identifier of the Letter Of Credit"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"ibLimitExceeds":[{}],"additionalAmountsCovered":[{}],"shipmentPeriods":[{}],"lcAmend":[{}],"messageFromCustomers":[{}],"messageFromBanks":[{}],"overrides":[{}],"lcAmount":0.0,"increaseDecreaseAmount":0.0,"decreaseCreditAmount":0.0,"increaseCreditAmount":0.0,"maximumCreditAmount":"string","newAdviceExpiryDate":"2024-01-01","shipmentDespatch":"string","otherDespatchDetails":"string"}},"responses":{"200":"LcAmendmentResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"DELETE","path":"/holdings/letterOfCredits/{letterOfCreditId}/amendments","fullPath":"/api/v3.0.0/holdings/letterOfCredits/{letterOfCreditId}/amendments","operationId":"deleteLcAmendment","name":"Remove an existing letter of credit amendment","summary":"Remove letter of credit amendment","tags":["CORPORATE"],"parameters":[{"name":"letterOfCreditId","in":"path","type":"string","required":true,"description":"Identifier of the Letter Of Credit"},{"name":"payload","in":"body","type":"object","required":false,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}}},"responses":{"200":"LcAmendmentResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/holdings/letterOfCredits/{letterOfCreditId}/amendmentApprovals","fullPath":"/api/v3.0.0/holdings/letterOfCredits/{letterOfCreditId}/amendmentApprovals","operationId":"approveLcAmendments","name":"Approve an initiated letter of credit amendment ","summary":"Approve letter of credit amendment","tags":["CORPORATE"],"parameters":[{"name":"letterOfCreditId","in":"path","type":"string","required":true,"description":"Identifier of the Letter Of Credit"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"LcAmendmentsResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/holdings/letterOfCredits/{letterOfCreditId}/amendments/approvals","fullPath":"/api/v3.0.0/holdings/letterOfCredits/{letterOfCreditId}/amendments/approvals","operationId":"approveLcAmendment","name":"Approve an initiated letter of credit amendment ","summary":"Approve letter of credit amendment","tags":["CORPORATE"],"parameters":[{"name":"letterOfCreditId","in":"path","type":"string","required":true,"description":"Identifier of the Letter Of Credit"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"LcAmendmentResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/holdings/letterOfCredits/clauses/{clausesId}","fullPath":"/api/v3.0.0/holdings/letterOfCredits/clauses/{clausesId}","operationId":"getLcClause","name":"Retrieves the details of specific letter of credit clause","summary":"Overview details of letter of credit clause","tags":["CORPORATE"],"parameters":[{"name":"clausesId","in":"path","type":"string","required":true,"description":"This is the key to the LC.CLAUSES file.During the input of an L/C this code can be entered for the inclusion of standard clauses."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"LcClauseResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"POST","path":"/holdings/letterOfCredits/clauses/{clausesId}","fullPath":"/api/v3.0.0/holdings/letterOfCredits/clauses/{clausesId}","operationId":"createLcClause","name":"Create a new letter of credit clause","summary":"Create a static narrative information for letter of credit","tags":["CORPORATE"],"parameters":[{"name":"clausesId","in":"path","type":"string","required":true,"description":"This is the key to the LC.CLAUSES file.During the input of an L/C this code can be entered for the inclusion of standard clauses."},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"narratives":[{}],"lcClausesName":"string","extensions":{}}},"responses":{"200":"LcClauseResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/holdings/letterOfCredits/clauses/{clausesId}","fullPath":"/api/v3.0.0/holdings/letterOfCredits/clauses/{clausesId}","operationId":"updateLcClause","name":"Update an existing letter of credit clause","summary":"Update a static narrative information for letter of credit","tags":["CORPORATE"],"parameters":[{"name":"clausesId","in":"path","type":"string","required":true,"description":"This is the key to the LC.CLAUSES file.During the input of an L/C this code can be entered for the inclusion of standard clauses."},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"narratives":[{}],"lcClausesName":"string","extensions":{}}},"responses":{"200":"LcClauseResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"DELETE","path":"/holdings/letterOfCredits/clauses/{clausesId}","fullPath":"/api/v3.0.0/holdings/letterOfCredits/clauses/{clausesId}","operationId":"deleteLcClause","name":"Remove an existing letter of credit clause","summary":"Remove a static narrative information for letter of credit","tags":["CORPORATE"],"parameters":[{"name":"clausesId","in":"path","type":"string","required":true,"description":"This is the key to the LC.CLAUSES file.During the input of an L/C this code can be entered for the inclusion of standard clauses."},{"name":"payload","in":"body","type":"object","required":false,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}}},"responses":{"200":"LcClauseResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/holdings/letterOfCredits/{letterOfCreditId}/drawings","fullPath":"/api/v3.0.0/holdings/letterOfCredits/{letterOfCreditId}/drawings","operationId":"getDrawings","name":"Retrieves the list of drawings for specific customer","summary":"Retrieve drawing details","tags":["CORPORATE"],"parameters":[{"name":"letterOfCreditId","in":"path","type":"string","required":true,"description":"Identifier of the Letter Of Credit"},{"name":"eventStatus","in":"query","type":"string","required":false,"description":"Specifies the status of the request.Allowed values are - With Bank_With Customer_Approved_Rejected."},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"DrawingsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/customers/{customerId}/letterOfCredits/documents","fullPath":"/api/v3.0.0/holdings/customers/{customerId}/letterOfCredits/documents","operationId":"getLCDocuments","name":"Retrieves the list of letter of credit advice text details","summary":"Retrieves the letter of credit advice text details","tags":["CORPORATE"],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"Identifier of the customer"},{"name":"lcAdviceTextId","in":"query","type":"string","required":false,"description":"This is the key to the letter of credit advice text file.During the input of an L/C this code can be entered for the inclusion of standard text."},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"LCDocumentsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/customers/{customerId}/letterOfCredits/clauses","fullPath":"/api/v3.0.0/holdings/customers/{customerId}/letterOfCredits/clauses","operationId":"getLCClauses","name":"Retrieves the list of narrative static information data for use in the mapping and construction of L/C advices/documents generated as a result of L/C transactions within the transact delivery application","summary":"Retrieves the letter of credit clause details","tags":["CORPORATE"],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"Identifier of the customer"},{"name":"lcClausesId","in":"query","type":"string","required":false,"description":"This is the key to the LC.CLAUSES file.During the input of an L/C this code can be entered for the inclusion of standard clauses."},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"LCClausesResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/letterOfCredits/incoTerms","fullPath":"/api/v3.0.0/holdings/letterOfCredits/incoTerms","operationId":"getIncoTerms","name":"Retrieves the list of letter of credit enrichment text details","summary":"Retrieves letter of credit enrichments","tags":["CORPORATE"],"parameters":[{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"IncoTermsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/letterOfCredits","fullPath":"/api/v3.0.0/holdings/letterOfCredits","operationId":"getLetterOfCredits","name":"Retrieves the list of letter of credits for specific customer","summary":"Retrieves letter of credit details","tags":["CORPORATE"],"parameters":[{"name":"letterOfCreditId","in":"query","type":"string","required":false,"description":"Identifier of the Letter Of Credit"},{"name":"customerId","in":"query","type":"string","required":false,"description":"Identifier of the customer"},{"name":"operation","in":"query","type":"string","required":false,"description":"Identifies the required operation to be executed for a Trade Finance contract. Input of valid codes as: O for opening of LC, P for Pre-advise of LC, A for Amend LC, C for Collect Charges, D for Decisi"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"LetterOfCreditsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/letterOfCredits/exports/drawings","fullPath":"/api/v3.0.0/holdings/letterOfCredits/exports/drawings","operationId":"getExportDrawings","name":"Retrieves the list of export letter of credit drawings for specific customer","summary":"Retrieves export letter of credit drawings","tags":["CORPORATE"],"parameters":[{"name":"customerId","in":"query","type":"string","required":false,"description":"Identifier of the customer"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"ExportDrawingsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/letterOfCredits/exports/amendments","fullPath":"/api/v3.0.0/holdings/letterOfCredits/exports/amendments","operationId":"getExportLCAmendments","name":"Retrieves the list of export letter of credit amendments for specific customer","summary":"Retrieves export letter of credit amendments","tags":["CORPORATE"],"parameters":[{"name":"customerId","in":"query","type":"string","required":false,"description":"Identifier of the customer"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"ExportLCAmendmentsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/letterOfCredits/exports","fullPath":"/api/v3.0.0/holdings/letterOfCredits/exports","operationId":"getRegisteredExportLc","name":"Retrieves the list of export letter of credits registered for specific customer","summary":"Retrieves registered export letter of credits","tags":["CORPORATE"],"parameters":[{"name":"adviceExpiryDate","in":"query","type":"string","required":false,"description":"Specifies the actual expiry date of Guarantee."},{"name":"transactionReference","in":"query","type":"string","required":true,"description":"Contains the identifier for the transaction in the core system"},{"name":"issuingBankId","in":"query","type":"string","required":false,"description":"Identifies the Issuing bank ID under the LC, who issues the LC under when a bank is advising the Letter of Credit"},{"name":"lcCurrency","in":"query","type":"string","required":false,"description":"Denote the currency of the Letter of Credit."},{"name":"lcAmount","in":"query","type":"string","required":false,"description":"This field indicates the amount of the Letter of Credit that will always be expressed in the currency of Letter of Credit."},{"name":"beneficiaryCustomerId","in":"query","type":"string","required":false,"description":"Identifies the Customer who is to be the ultimate receiver of the funds transferred by the sending bank when this Beneficiary is not a bank."},{"name":"liabilityReversalDate","in":"query","type":"string","required":false,"description":"Date on which the contingent entries and the limits raised on the LC will be reversed."},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"RegisteredExportLcResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"POST","path":"/holdings/letterOfCredits/exports","fullPath":"/api/v3.0.0/holdings/letterOfCredits/exports","operationId":"createExportLetterOfCredit","name":"Create a new export letter of credit for specific customer","summary":"Create export letter of credit","tags":["CORPORATE"],"parameters":[{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"applicants":[{}],"advisingBanks":[{}],"beneficiaries":[{}],"additionalInformations":[{}],"additionalAmountsCovered":[{}],"deferredPayments":[{}],"contactDetails":[{}],"shipmentPeriods":[{}],"presentationPeriods":[{}],"descriptionOfGoods":[{}],"documentDetails":[{}],"documentsRequired":[{}],"clausesDetails":[{}],"additionalConditions":[{}],"narrativeCharges":[{}]}},"responses":{"200":"ExportLetterOfCreditResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/holdings/letterOfCredits/imports/drawings","fullPath":"/api/v3.0.0/holdings/letterOfCredits/imports/drawings","operationId":"getImportDrawings","name":"Retrieves the list of import letter of credit drawings for specific customer","summary":"Retrieves import letter of credit drawings","tags":["CORPORATE"],"parameters":[{"name":"customerId","in":"query","type":"string","required":false,"description":"Identifier of the customer"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"ImportDrawingsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/letterOfCredits/imports/amendments","fullPath":"/api/v3.0.0/holdings/letterOfCredits/imports/amendments","operationId":"getImportLCAmendments","name":"Retrieves the list of import letter of credit amendments for specific customer","summary":"Retrieves import letter of credit amendments","tags":["CORPORATE"],"parameters":[{"name":"customerId","in":"query","type":"string","required":false,"description":"Identifier of the customer"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"ImportLCAmendmentsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/letterOfCredits/imports","fullPath":"/api/v3.0.0/holdings/letterOfCredits/imports","operationId":"getImportLc","name":"Retrieves the list of import letter of credits for specific customer","summary":"Retrieves import letter of credits","tags":["CORPORATE"],"parameters":[{"name":"customerId","in":"query","type":"string","required":false,"description":"Identifier of the customer"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"ImportLcResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/letterOfCredits/outwardCollections/documents","fullPath":"/api/v3.0.0/holdings/letterOfCredits/outwardCollections/documents","operationId":"getOutwardCollectionDocuments","name":"Retrieves the list of outward collections document codes for specific customer","summary":"Retrieves the outward collection document codes","tags":["CORPORATE"],"parameters":[{"name":"lcAdviceTextId","in":"query","type":"string","required":false,"description":"This is the key to the letter of credit advice text file.During the input of an L/C this code can be entered for the inclusion of standard text."},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"OutwardCollectionDocumentsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/letterOfCredits/inwardCollections/amendments","fullPath":"/api/v3.0.0/holdings/letterOfCredits/inwardCollections/amendments","operationId":"getInwardCollectionsAmendments","name":"Retrieves the list of inward collection amendments for specific customer","summary":"Retrieves the inward collection amendments","tags":["CORPORATE"],"parameters":[{"name":"customerId","in":"query","type":"string","required":false,"description":"Identifier of the customer"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"InwardCollectionsAmendmentsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/letterOfCredits/inwardCollections","fullPath":"/api/v3.0.0/holdings/letterOfCredits/inwardCollections","operationId":"getInwardCollections","name":"Retrieves the list of inward collections for specific customer","summary":"Retrieves the inward collections","tags":["CORPORATE"],"parameters":[{"name":"customerId","in":"query","type":"string","required":false,"description":"Identifier of the customer"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"InwardCollectionsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"POST","path":"/holdings/letterOfCredits/inwardCollections","fullPath":"/api/v3.0.0/holdings/letterOfCredits/inwardCollections","operationId":"createInwardCollection","name":"Lodgment of the Import documentary collection by the collecting bank ","summary":"Creates a new inward documentary collection","tags":["CORPORATE"],"parameters":[{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"inward":[{}],"applicantAddresses":[{}],"advisingBanks":[{}],"beneficiaries":[{}],"guaranteeReferences":[{}],"documents":[{}],"additionalConditions":[{}],"instructions":[{}],"bankToBanks":[{}],"invoiceReferences":[{}],"transportation":[{}],"charges":[{}],"chargeCodes":[{}],"extensions":{}}},"responses":{"200":"InwardCollectionResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/holdings/letterOfCredits/tenors","fullPath":"/api/v3.0.0/holdings/letterOfCredits/tenors","operationId":"getLcTenors","name":"Retrieves the list of letter of credit tenor details","summary":"Retrieves letter of credit tenor details","tags":["CORPORATE"],"parameters":[{"name":"lcPayTypeId","in":"query","type":"string","required":false,"description":"Indicates the identifier of payment type enrichment for letter of credit."},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"LcTenorsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/letterOfCredits/outwardCollections/amendments","fullPath":"/api/v3.0.0/holdings/letterOfCredits/outwardCollections/amendments","operationId":"getOutwardCollectionAmdendments","name":"Retrieves the list of outward collection amendments for specific customer","summary":"Retrieves outward collection amendments","tags":["CORPORATE"],"parameters":[{"name":"customerId","in":"query","type":"string","required":false,"description":"Identifier of the customer"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"OutwardCollectionAmdendmentsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/letterOfCredits/outwardCollections","fullPath":"/api/v3.0.0/holdings/letterOfCredits/outwardCollections","operationId":"getOutwardCollections","name":"Retrieves the outstanding details of outward collections","summary":"Retrieves the outward collection amendments","tags":["CORPORATE"],"parameters":[{"name":"customerId","in":"query","type":"string","required":false,"description":"Identifier of the customer"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"OutwardCollectionsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"POST","path":"/holdings/letterOfCredits/outwardCollections","fullPath":"/api/v3.0.0/holdings/letterOfCredits/outwardCollections","operationId":"createOutwardCollections","name":"Initiation of the export documentary collection by the collecting bank","summary":"Creates the outward collections","tags":["CORPORATE"],"parameters":[{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"beneficiaryDetails":[{}],"issuingBankNames":[{}],"applicantNames":[{}],"documentCodes":[{}],"additionalConditions":[{}],"instructionDetails":[{}],"bankToBanks":[{}],"deliveryInstructions":[{}],"chargeCodes":[{}],"avalisationDetails":[{}],"externalReference":"string","beneficiaryCustomerId":"string","beneficiaryAccountId":"string","currencyId":"string","issueDate":"string"}},"responses":{"200":"OutwardCollectionsResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/holdings/letterOfCredits/limits","fullPath":"/api/v3.0.0/holdings/letterOfCredits/limits","operationId":"getLcLimits","name":"Retrieves the list of letter of credit limit details","summary":"Retrieves the letter of credit limits","tags":["CORPORATE"],"parameters":[{"name":"customerId","in":"query","type":"string","required":false,"description":"Identifier of the customer"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"LcLimitsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"DELETE","path":"/holdings/letterOfCredits/drawings/{drawingId}/cancellations/","fullPath":"/api/v3.0.0/holdings/letterOfCredits/drawings/{drawingId}/cancellations/","operationId":"rejectDrawing","name":"Cancel an initiated drawing for letter of credit","summary":"Cancel initiated drawing","tags":["CORPORATE"],"parameters":[{"name":"drawingId","in":"path","type":"string","required":true,"description":"Identifier of drawings application under the Letter of Credit system that is used to effect the transfer of funds and the acceptance of documents under Letters of Credit and Documentary Collection tra"},{"name":"payload","in":"body","type":"object","required":false,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}}},"responses":{"200":"DrawingResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"DELETE","path":"/holdings/letterOfCredits/{letterOfCreditId}/amendments/cancellations","fullPath":"/api/v3.0.0/holdings/letterOfCredits/{letterOfCreditId}/amendments/cancellations","operationId":"rejectLcAmendment","name":"Cancel an initiated letter of credit amendment","summary":"Cancel letter of credit amendment","tags":["CORPORATE"],"parameters":[{"name":"letterOfCreditId","in":"path","type":"string","required":true,"description":"Identifier of the Letter Of Credit"},{"name":"payload","in":"body","type":"object","required":false,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}}},"responses":{"200":"LcAmendmentResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/holdings/letterOfCredits/ApprovedOutwardCollections","fullPath":"/api/v3.0.0/holdings/letterOfCredits/ApprovedOutwardCollections","operationId":"getApprovedOutwardCollections","name":"Retrieve the list of approved outward collections for specific customer","summary":"Retrieve approved outward collections","tags":["CORPORATE"],"parameters":[{"name":"collectionId","in":"query","type":"string","required":false,"description":"Identifier of collection id"},{"name":"beneficiaryCustomerId","in":"query","type":"string","required":false,"description":"Identifies the Customer who is to be the ultimate receiver of the funds transferred by the sending bank when this Beneficiary is not a bank."},{"name":"ibStatus","in":"query","type":"string","required":false,"description":"Field to indicate the status of LC request through internet banking."},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"ApprovedOutwardCollectionsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/letterOfCredits/{lcAmendmentId}/amendment","fullPath":"/api/v3.0.0/holdings/letterOfCredits/{lcAmendmentId}/amendment","operationId":"getLcAmendment","name":"Retrieve the details of specific letter of credit amendment details","summary":"Overview details of letter of credit amendment","tags":["CORPORATE"],"parameters":[{"name":"lcAmendmentId","in":"path","type":"string","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"LcAmendmentResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"POST","path":"/holdings/letterOfCreditsInitiation","fullPath":"/api/v3.0.0/holdings/letterOfCreditsInitiation","operationId":"createLetterOfCredit","name":"Initiate a new letter of credit request for specific customer","summary":"Create letter of credit request","tags":["CORPORATE"],"parameters":[{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"applicantCustomerNames":[{}],"advisingBanks":[{}],"beneficiaryCustomerNames":[{}],"availableWithDetails":[{}],"additionalAmountsCovered":[{}],"deferredPayments":[{}],"contactDetails":[{}],"shipmentPeriods":[{}],"presentationPeriods":[{}],"descriptionOfGoods":[{}],"documentDetails":[{}],"documentsRequired":[{}],"clausesDetails":[{}],"additionalConditions":[{}],"narrativeCharges":[{}]}},"responses":{"200":"LetterOfCreditResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/holdings/letterOfCredit/{letterOfCreditId}","fullPath":"/api/v3.0.0/holdings/letterOfCredit/{letterOfCreditId}","operationId":"updateLetterOfCredits","name":"Update an existing letter of credit for specific customer","summary":"Update letter of credit","tags":["CORPORATE"],"parameters":[{"name":"letterOfCreditId","in":"path","type":"string","required":true,"description":"Identifier of the Letter Of Credit"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"applicantCustomerNames":[{}],"advisingBanks":[{}],"beneficiaryCustomerNames":[{}],"availableWithDetails":[{}],"additionalAmountsCovered":[{}],"deferredPayments":[{}],"contactDetails":[{}],"shipmentPeriods":[{}],"presentationPeriods":[{}],"descriptionOfGoods":[{}],"documentDetails":[{}],"documentsRequired":[{}],"clausesDetails":[{}],"additionalConditions":[{}],"narrativeCharges":[{}]}},"responses":{"200":"LetterOfCreditsResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/holdings/letterOfCredits/{letterOfCreditId}","fullPath":"/api/v3.0.0/holdings/letterOfCredits/{letterOfCreditId}","operationId":"getLetterOfCredit","name":"Retrieves the details of specific letter of credit","summary":"Retrieves the details of letter of credit","tags":["CORPORATE"],"parameters":[{"name":"letterOfCreditId","in":"path","type":"string","required":true,"description":"Identifier of the Letter Of Credit"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"LetterOfCreditResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"POST","path":"/holdings/letterOfCredits/{letterOfCreditId}","fullPath":"/api/v3.0.0/holdings/letterOfCredits/{letterOfCreditId}","operationId":"updateExternalAmendmentToAnLC","name":"Updates the  amendments to the letter of credit for the specified letter of credit/customer reference number","summary":"Updates letter of credit details","tags":["CORPORATE"],"parameters":[{"name":"letterOfCreditId","in":"path","type":"string","required":true,"description":""},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"additionalAmountsCovered":[{}],"amendmentInformations":[{}],"beneficiaries":[{}],"narrativeCharges":[{}],"reimbursingBankAndAddresses":[{}],"bankToBanks":[{}],"charges":[{}],"chargeCodes":[{}],"commissionDetails":[{}],"margins":[{}],"issuingBankNames":[{}],"applicantAddresses":[{}],"availableWithBanks":[{}],"draftsAt":[{}],"drawees":[{}]}},"responses":{"200":"ExternalAmendmentToAnLCResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/holdings/letterOfCredits/{letterOfCreditId}","fullPath":"/api/v3.0.0/holdings/letterOfCredits/{letterOfCreditId}","operationId":"updateLetterOfCredit","name":"Updates the letter of credit initiation for the specified letter of credit/customer reference number","summary":"Updates letter of credit details","tags":["CORPORATE"],"parameters":[{"name":"letterOfCreditId","in":"path","type":"string","required":true,"description":"Identifier of the Letter Of Credit"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"applicantAddresses":[{}],"advisingBanks":[{}],"beneficiaries":[{}],"availableWithBanks":[{}],"additionalAmountsCovered":[{}],"deferredPayments":[{}],"contactDetails":[{}],"shipmentPeriods":[{}],"presentationPeriods":[{}],"descriptionsOfGoods":[{}],"documentCodes":[{}],"documentDetails":[{}],"documentsRequired":[{}],"additionalConditions":[{}],"narrativeCharges":[{}]}},"responses":{"200":"LetterOfCreditResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"DELETE","path":"/holdings/letterOfCredits/{letterOfCreditId}","fullPath":"/api/v3.0.0/holdings/letterOfCredits/{letterOfCreditId}","operationId":"deleteLetterOfCredit","name":"Remove an existing letter of credit for specific customer","summary":"Remove letter of credit","tags":["CORPORATE"],"parameters":[{"name":"letterOfCreditId","in":"path","type":"string","required":true,"description":"Identifier of the Letter Of Credit"},{"name":"payload","in":"body","type":"object","required":false,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}}},"responses":{"200":"LetterOfCreditResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/holdings/letterOfCredits/letterOfCreditApprovals/{letterOfCreditId}","fullPath":"/api/v3.0.0/holdings/letterOfCredits/letterOfCreditApprovals/{letterOfCreditId}","operationId":"approveLetterOfCredit","name":"Approve an initiated letter of credit request for specific customer","summary":"Approve letter of credit request","tags":["CORPORATE"],"parameters":[{"name":"letterOfCreditId","in":"path","type":"string","required":true,"description":"Identifier of the Letter Of Credit"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"LetterOfCreditResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"DELETE","path":"/holdings/letterOfCredits/cancellations/{letterOfCreditId}","fullPath":"/api/v3.0.0/holdings/letterOfCredits/cancellations/{letterOfCreditId}","operationId":"rejectLetterOfCredit","name":"Cancel an initiated letter of credit request for specific customer","summary":"Cancel letter of credit request","tags":["CORPORATE"],"parameters":[{"name":"letterOfCreditId","in":"path","type":"string","required":true,"description":"Identifier of the Letter Of Credit"},{"name":"payload","in":"body","type":"object","required":false,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}}},"responses":{"200":"LetterOfCreditResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"POST","path":"/holdings/letterOfCredit/exports","fullPath":"/api/v3.0.0/holdings/letterOfCredit/exports","operationId":"createExportLetterOfCredits","name":"Create a new export letter of credit for specific customer","summary":"Create export letter of credit","tags":["CORPORATE"],"parameters":[{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"applicantCustomerNames":[{}],"advisingBanks":[{}],"beneficiaryCustomerNames":[{}],"availableWithDetails":[{}],"additionalAmountsCovered":[{}],"deferredPayments":[{}],"contactDetails":[{}],"shipmentPeriods":[{}],"presentationPeriods":[{}],"descriptionOfGoods":[{}],"documentDetails":[{}],"documentsRequired":[{}],"clausesDetails":[{}],"additionalConditions":[{}],"narrativeCharges":[{}]}},"responses":{"200":"ExportLetterOfCreditsResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/holdings/letterOfCredit/{letterOfCreditId}/exports","fullPath":"/api/v3.0.0/holdings/letterOfCredit/{letterOfCreditId}/exports","operationId":"updateExportLetterOfCredits","name":"Update a new export letter of credit for specific customer","summary":"Update export letter of credit","tags":["CORPORATE"],"parameters":[{"name":"letterOfCreditId","in":"path","type":"string","required":true,"description":"Identifier of the Letter Of Credit"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"applicantCustomerNames":[{}],"advisingBanks":[{}],"beneficiaryCustomerNames":[{}],"availableWithDetails":[{}],"additionalAmountsCovered":[{}],"deferredPayments":[{}],"contactDetails":[{}],"shipmentPeriods":[{}],"presentationPeriods":[{}],"descriptionOfGoods":[{}],"documentDetails":[{}],"documentsRequired":[{}],"clausesDetails":[{}],"additionalConditions":[{}],"narrativeCharges":[{}]}},"responses":{"200":"ExportLetterOfCreditsResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"POST","path":"/holdings/letterOfCredits/sightPayments","fullPath":"/api/v3.0.0/holdings/letterOfCredits/sightPayments","operationId":"createIssuanceOfSightPaymentLC","name":"Creates sight payment letter of credit for the requested customer reference number","summary":"Create sight payment letter of credit","tags":["CORPORATE"],"parameters":[{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"applicantAddresses":[{}],"beneficiaryAddresses":[{}],"advisingBankAddresses":[{}],"adviseThroughBanks":[{}],"availableWithBanks":[{}],"reimbursingBanks1":[{}],"requestedConfirmBankNames":[{}],"charges":[{}],"importSightPmtLcType":"string","lcNumber":"string","applicant":"string","lcCurrency":"string","lcAmount":0.0,"creditTolerance":"string","debitTolerance":"string"}},"responses":{"200":"IssuanceOfSightPaymentLCResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"POST","path":"/holdings/letterOfCredits/usances","fullPath":"/api/v3.0.0/holdings/letterOfCredits/usances","operationId":"createIssuanceOfUsanceLC","name":"Creates usance letter of credit for the requested customer reference number","summary":"Create usance letter of credit","tags":["CORPORATE"],"parameters":[{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"applicantAddresses":[{}],"limitReferences":[{}],"beneficiaryAddresses":[{}],"advisingBankAddresses":[{}],"adviseThroughBanks":[{}],"availableWithBanks":[{}],"reimbursingBanks1":[{}],"requestedConfirmBankNames":[{}],"charges":[{}],"importUsanceLCType":"string","lcNumber":"string","applicant":"string","currency":"string","amount":0.0,"creditTolerance":"string"}},"responses":{"200":"IssuanceOfUsanceLCResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"POST","path":"/holdings/letterOfCredits/negotiations","fullPath":"/api/v3.0.0/holdings/letterOfCredits/negotiations","operationId":"createIssuanceOfNegotiationLC","name":"Creates negotiation letter of credit for the requested customer reference number","summary":"Create negotiation letter of credit","tags":["CORPORATE"],"parameters":[{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"applicantAddresses":[{}],"beneficiaryAddresses":[{}],"advisingBankAddresses":[{}],"adviseThroughBanks":[{}],"availableWithBanks":[{}],"reimbursingBanks1":[{}],"requestedConfirmBankNames":[{}],"charges":[{}],"importNegotiationLCType":"string","lcNumber":"string","applicant":"string","lcCurrency":"string","lcAmount":"string","creditTolerance":"string","debitTolerance":"string"}},"responses":{"200":"IssuanceOfNegotiationLCResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"POST","path":"/holdings/letterOfCredits/mixedPayments","fullPath":"/api/v3.0.0/holdings/letterOfCredits/mixedPayments","operationId":"createIssuanceOfMixedPaymentLC","name":"Creates mixed payment letter of credit for the requested customer reference number","summary":"Create mixed payment letter of credit","tags":["CORPORATE"],"parameters":[{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"applicantAddresses":[{}],"beneficiaryAddresses":[{}],"advisingBankAddresses":[{}],"adviseThroughBanks":[{}],"availableWithBanks":[{}],"reimbursingBanks1":[{}],"requestedConfirmBankNames":[{}],"charges":[{}],"drawings":[{}],"importMixedPmtLCType":"string","lcNumber":"string","applicantCustomer":"string","lcCurrency":"string","lcAmount":"string","creditTolerance":"string"}},"responses":{"200":"IssuanceOfMixedPaymentLCResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"POST","path":"/holdings/letterOfCredits/standbys","fullPath":"/api/v3.0.0/holdings/letterOfCredits/standbys","operationId":"createIssuanceOfStandbyLC","name":"Creates standby letter of credit for the requested customer reference number","summary":"Create standby letter of credit","tags":["CORPORATE"],"parameters":[{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"applicantAddresses":[{}],"limitReferences":[{}],"beneficiaryAddresses":[{}],"advisingBankAddresses":[{}],"adviseThroughBanks":[{}],"availableWithBanks":[{}],"reimbursingBanks1":[{}],"requestedConfirmBankNames":[{}],"charges":[{}],"importLCType":"string","lcNumber":"string","applicantCustomer":"string","lcCurrency":"string","lcAmount":0.0,"creditTolerance":"string"}},"responses":{"200":"IssuanceOfStandbyLCResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"POST","path":"/holdings/letterOfCredits/imports/preAdvises","fullPath":"/api/v3.0.0/holdings/letterOfCredits/imports/preAdvises","operationId":"createIssuanceOfPreAdviseImportLC","name":"Creates a pre-advice import letter of credit request.","summary":"Creates pre-advice letter of credit","tags":["CORPORATE"],"parameters":[{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"applicantAddresses":[{}],"limitReferences":[{}],"beneficiaryAddresses":[{}],"advisingBankAddresses":[{}],"adviseThroughBanks":[{}],"availableWithBanks":[{}],"reimbursingBanks1":[{}],"requestedConfirmBankNames":[{}],"charges":[{}],"lcNumber":"string","lcType":"string","applicant":"string","currency":"string","amount":0.0,"creditTolerance":"string"}},"responses":{"200":"IssuanceOfPreAdviseImportLCResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"POST","path":"/holdings/letterOfCredits/backToBacks","fullPath":"/api/v3.0.0/holdings/letterOfCredits/backToBacks","operationId":"createIssuanceOfBackToBackLC","name":"Creates back-to-back letter of credit for the requested customer reference number","summary":"Creates back-to-back letter of credit","tags":["CORPORATE"],"parameters":[{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"limitReferences":[{}],"beneficiaryAddresses":[{}],"applicantNames":[{}],"availableWithBanks":[{}],"adviseThroughBanks":[{}],"charges":[{}],"drawings":[{}],"accountWithBanks":[{}],"senderReceiversInfoMT730":[{}],"exportLCType":"string","backToBackLCRequired":"string","relatedImportLCReference":"string","advisingBankReference":"string","lcAdvisingReference":"string","issuingBankLCReference":"string"}},"responses":{"200":"IssuanceOfBackToBackLCResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"POST","path":"/holdings/letterOfCredits/transferables","fullPath":"/api/v3.0.0/holdings/letterOfCredits/transferables","operationId":"createIssuanceOfTransferableLC","name":"Creates transferable letter of credit for the requested customer reference number","summary":"Creates transferable letter of credit","tags":["CORPORATE"],"parameters":[{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"advisingBanks":[{}],"limitReferences":[{}],"drawings":[{}],"charges":[{}],"assignments":[{}],"secondBeneficiaries":[{}],"availableWithBanks":[{}],"draftsAt":[{}],"drawees":[{}],"mixedPaymentDetails":[{}],"negotiationDeferredPaymentDetails":[{}],"shipmentPeriods":[{}],"documentsRequired":[{}],"additionalConditions":[{}],"narrativeCharges":[{}]}},"responses":{"200":"IssuanceOfTransferableLCResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"POST","path":"/holdings/letterOfCredits/{letterOfCreditId}/beneficiaryConsents","fullPath":"/api/v3.0.0/holdings/letterOfCredits/{letterOfCreditId}/beneficiaryConsents","operationId":"updateAmendmentSeekingBeneficiaryConsent","name":"Updates letter of credit amendments seeking beneficiary's consent for the specified letter of credit/customer reference number","summary":"Updates letter of credit beneficiary's consent details","tags":["CORPORATE"],"parameters":[{"name":"letterOfCreditId","in":"path","type":"string","required":true,"description":"Identifier of the Letter Of Credit"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"advisingBankIds":[{}],"beneficiaryAddresses":[{}],"documentsRequired":[{}],"additionalConditions":[{}],"charges":[{}],"lcCurrency":"string","lcAmount":0.0,"issueDate":"2024-01-01","beneficiaryId":"string","lcLiabilityAmountOutStanding":"string","pendingAmendMovement":"string","debitTolerance":"string","creditTolerance":"string","advisingBankReference":"string","increaseOrDecreaseAmount":0.0}},"responses":{"200":"AmendmentSeekingBeneficiaryConsentResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"POST","path":"/holdings/letterOfCredits/{letterOfCreditId}/imports/decisions","fullPath":"/api/v3.0.0/holdings/letterOfCredits/{letterOfCreditId}/imports/decisions","operationId":"updateDecisionOnAmendment","name":"Updates the decision on amendments to import letter of credit for the specified letter of credit/customer reference number","summary":"Updates decision on amendment to the import letter of credit","tags":["CORPORATE"],"parameters":[{"name":"letterOfCreditId","in":"path","type":"string","required":true,"description":"Identifier of the Letter Of Credit"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"additionalAmountsCovered":[{}],"limitReferences":[{}],"beneficiaries":[{}],"bankToBanks":[{}],"internalAmendmentDetails":[{}],"charges":[{}],"commissions":[{}],"amendmentNumber":"string","amendStatus":"string","sendAmendmentAdvice":"string","lcNumber":"string","advisingBankReference":"string","issueDate":"2024-01-01","lcType":"string","amendmentDate":"2024-01-01"}},"responses":{"200":"DecisionOnAmendmentResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"POST","path":"/holdings/letterOfCredits/{letterOfCreditId}/imports/cancellations","fullPath":"/api/v3.0.0/holdings/letterOfCredits/{letterOfCreditId}/imports/cancellations","operationId":"updateCancellationOfLC","name":"Updates the cancellation details of the issued import letter of credit for the specified letter of credit/customer reference number","summary":"Updates import letter of credit cancellation details","tags":["CORPORATE"],"parameters":[{"name":"letterOfCreditId","in":"path","type":"string","required":true,"description":"Identifier of the Letter Of Credit"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"limitReferences":[{}],"beneficiaries":[{}],"charges":[{}],"commissions":[{}],"lcNumber":"string","sendAmendmentAdvice":"string","lcType":"string","advisingBankReference":"string","applicantCustomer":"string","advisingBank":"string","issueDate":"string","newLcCurrency":"string","newLcAmount":"string","creditTolerance":"string","debitTolerance":"string"}},"responses":{"200":"CancellationOfLCResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"POST","path":"/holdings/letterOfCredits/{letterOfCreditId}/exports/decisions","fullPath":"/api/v3.0.0/holdings/letterOfCredits/{letterOfCreditId}/exports/decisions","operationId":"updateDecisionOnExportLCAmendment","name":"Updates the decision on amendments to export letter of credit for the specified letter of credit/customer reference number","summary":"Updates decision on amendment to the export letter of credit","tags":["CORPORATE"],"parameters":[{"name":"letterOfCreditId","in":"path","type":"string","required":true,"description":"Identifier of the Letter Of Credit"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"beneficiaries":[{}],"shipmentPeriods":[{}],"internalAmendmentDetails":[{}],"charges":[{}],"amendmentNumber":"string","lcType":"string","amendStatus":"string","applicantCustomer":"string","lcNumber":"string","sendAmendmentAdvice":"string","issuingBankReference":"string","issueDate":"string","issuingBankId":"string","lcCurrency":"string","lcAmount":"string"}},"responses":{"200":"DecisionOnExportLCAmendmentResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"POST","path":"/holdings/letterOfCredits/{letterOfCreditId}/exports/cancellations","fullPath":"/api/v3.0.0/holdings/letterOfCredits/{letterOfCreditId}/exports/cancellations","operationId":"updateCancellationOfExportLC","name":"Updates the cancellation details of the issued export letter of credit for the specified letter of credit/customer reference number","summary":"Updates export letter of credit cancellation details ","tags":["CORPORATE"],"parameters":[{"name":"letterOfCreditId","in":"path","type":"string","required":true,"description":""},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"applicants":[{}],"additionalAmountsCovered":[{}],"beneficiaries":[{}],"charges":[{}],"lcNumber":"string","sendAmendmentAdvice":"string","lcType":"string","issuingBankReference":"string","issuingBankId":"string","lcIssueDate":"string","newLcCurrency":"string","newLcAmount":"string","creditTolerance":"string","debitTolerance":"string","purposeOfMessage":"string"}},"responses":{"200":"CancellationOfExportLCResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/holdings/customers/{customerId}/letterOfCredits/imports/outstandings","fullPath":"/api/v3.0.0/holdings/customers/{customerId}/letterOfCredits/imports/outstandings","operationId":"getImportLcsOutstanding","name":"Retrieves the details of outstanding import letter of credits for the specified customer/guarantee reference.","summary":"Retrieves outstanding import letter of credit details","tags":["CORPORATE"],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"Identifier of the customer"},{"name":"transactionReference","in":"query","type":"string","required":false,"description":"Contains the identifier for the transaction in the core system"},{"name":"lcCurrency","in":"query","type":"string","required":false,"description":"Denote the currency of the Letter of Credit."},{"name":"advisingBank","in":"query","type":"string","required":false,"description":"Identifies the advising bank under the Letter of Credit, through whom the Letter of Credit is to be advised to the second advising bank or beneficiary"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"ImportLcsOutstandingResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/customers/{customerId}/letterOfCredits/imports/expiries","fullPath":"/api/v3.0.0/holdings/customers/{customerId}/letterOfCredits/imports/expiries","operationId":"getImportLcsExpiringButOutstanding","name":"Retrieves the expired import letter of credit details for the specified customer/guarantee reference.","summary":"Retrieves expired import letter of credit details","tags":["CORPORATE"],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":""},{"name":"transactionReference","in":"query","type":"string","required":false,"description":"Contains the identifier for the transaction in the core system"},{"name":"applicantCustomer","in":"query","type":"string","required":false,"description":"Indicates the applicant ID on whose behalf the Letter of Credit is issued."},{"name":"lcCurrency","in":"query","type":"string","required":false,"description":"Denote the currency of the Letter of Credit."},{"name":"advisingBank","in":"query","type":"string","required":false,"description":"Identifies the advising bank under the Letter of Credit, through whom the Letter of Credit is to be advised to the second advising bank or beneficiary"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"ImportLcsExpiringButOutstandingResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/letterOfCredits/{letterOfCreditId}/exports/outstandings","fullPath":"/api/v3.0.0/holdings/letterOfCredits/{letterOfCreditId}/exports/outstandings","operationId":"getExportlcsOutstanding","name":"Retrieves the details of outstanding export letter of credits for the specified customer/guarantee reference.","summary":"Retrieves outstanding export letter of credit details","tags":["CORPORATE"],"parameters":[{"name":"letterOfCreditId","in":"path","type":"string","required":true,"description":""},{"name":"transactionReference","in":"query","type":"string","required":false,"description":"Contains the identifier for the transaction in the core system"},{"name":"issuingBankId","in":"query","type":"string","required":false,"description":"Identifies the Issuing bank ID under the LC, who issues the LC under when a bank is advising the Letter of Credit"},{"name":"lcCurrency","in":"query","type":"string","required":false,"description":"Denote the currency of the Letter of Credit."},{"name":"lcAmount","in":"query","type":"string","required":false,"description":"This field indicates the amount of the Letter of Credit that will always be expressed in the currency of Letter of Credit."},{"name":"beneficiaryCustomerId","in":"query","type":"string","required":false,"description":"Identifies the Customer who is to be the ultimate receiver of the funds transferred by the sending bank when this Beneficiary is not a bank."},{"name":"expiryDate","in":"query","type":"string","required":false,"description":"This indicates the  date  on which the offer or privilege terminates for the event."},{"name":"liabilityReversalDate","in":"query","type":"string","required":false,"description":"Date on which the contingent entries and the limits raised on the LC will be reversed."},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"ExportlcsOutstandingResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"PUT","path":"/holdings/letterOfCredits/{letterOfCreditId}/outwardCollections/amendments","fullPath":"/api/v3.0.0/holdings/letterOfCredits/{letterOfCreditId}/outwardCollections/amendments","operationId":"amendOutwardCollections","name":"Amendments to outward collection contracts are implemented by revising the contract with updated values","summary":"Updates the outward collections","tags":["CORPORATE"],"parameters":[{"name":"letterOfCreditId","in":"path","type":"string","required":true,"description":"Identifier of the Letter Of Credit"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"applicantNames":[{}],"advisingBanks":[{}],"beneficiaryDetails":[{}],"availableWithDetails":[{}],"additionalAmountsCovered":[{}],"deferredPayments":[{}],"contactDetails":[{}],"shipmentPeriods":[{}],"presentationPeriods":[{}],"descriptionOfGoods":[{}],"documentCodes":[{}],"documentDetails":[{}],"documentsRequired":[{}],"clausesDetails":[{}],"additionalConditions":[{}]}},"responses":{"200":"OutwardCollectionsResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/holdings/letterOfCredits/outwardCollections/outstandings","fullPath":"/api/v3.0.0/holdings/letterOfCredits/outwardCollections/outstandings","operationId":"getOutwardCollectionsOutstanding","name":"Retrieves the outstanding details of outward collections","summary":"Retrieves the outstanding details of outward collections","tags":["CORPORATE"],"parameters":[{"name":"collectionReference","in":"query","type":"string","required":true,"description":"The ID of the Letter of Credit, to be linked to this Guarantee for the purpose of apportioning the Margin"},{"name":"beneficiaryCustomerId","in":"query","type":"string","required":false,"description":"Identifies the Customer who is to be the ultimate receiver of the funds transferred by the sending bank when this Beneficiary is not a bank."},{"name":"currencyId","in":"query","type":"string","required":false,"description":"Identifier of the currency. This is the 3-letter ISO 4217 code of the currency."},{"name":"days","in":"query","type":"string","required":false,"description":"Valid for Documentary Collections and used in conjunction with the field TENOR to indicate the tenor of the drafts under the collection. It is used in the production of corresponding documentary colle"},{"name":"tenor","in":"query","type":"string","required":false,"description":"This field is valid for Documentary Collections only. It is used in conjunction with the following field 'DAYS' or 'COLL.MAT.CODE' to indicate the TENOR of the drafts under the collection and is used "},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"OutwardCollectionsOutstandingResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"POST","path":"/holdings/letterOfCredits/drawings/{drawingId}/documents","fullPath":"/api/v3.0.0/holdings/letterOfCredits/drawings/{drawingId}/documents","operationId":"createDrawingDocument","name":"Initiate the registration of a presentation done for letter of credit transaction","summary":"Initiate a new drawing request to register the documents for letter of credit","tags":["CORPORATE"],"parameters":[{"name":"drawingId","in":"path","type":"string","required":true,"description":"Identifier of drawings application under the Letter of Credit system that is used to effect the transfer of funds and the acceptance of documents under Letters of Credit and Documentary Collection tra"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"addresses":[{}],"presentorCustomerId":"string","referenceId":"string","currencyId":"string","documentAmount":0.0,"creditAccountId":"string","debitAccountId":"string","paymentMethod":"string","nextReviewDate":"2024-01-01","days":"string","documentReceived":"string","maturityReview":"string","extensions":{}}},"responses":{"200":"DrawingDocumentResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/holdings/letterOfCredits/drawings","fullPath":"/api/v3.0.0/holdings/letterOfCredits/drawings","operationId":"getDrawingsDetails","name":"Retrieves the list of drawings for specific customer","summary":"Retrieve drawing details","tags":["CORPORATE"],"parameters":[{"name":"lcType","in":"query","type":"string","required":false,"description":"Indicates the type of LC, whether this is an Import/Export, Confirmed/Unconfirmed/Revolving/Transferrable/Back to Back LC/documentary collection/Clean collection etc."},{"name":"applicantCustomer","in":"query","type":"string","required":false,"description":"Indicates the applicant ID on whose behalf the Letter of Credit is issued."},{"name":"drawingId","in":"query","type":"string","required":false,"description":"Identifier of drawings application under the Letter of Credit system that is used to effect the transfer of funds and the acceptance of documents under Letters of Credit and Documentary Collection tra"},{"name":"drawingType","in":"query","type":"string","required":false,"description":"This field is correlated to the other field payment type and identifies the Draw type under Letter of credit. Whether its a sight LC payment, acceptance, deferred payment or Mixed payment."},{"name":"currencyId","in":"query","type":"string","required":false,"description":"Identifier of the currency. This is the 3-letter ISO 4217 code of the currency."},{"name":"creditType","in":"query","type":"string","required":false,"description":"Contains the credit line type. Possible values are 'Available' and 'Credit'."},{"name":"documentAmount","in":"query","type":"string","required":false,"description":"This field contains the amount to be drawn under this transaction, expressed in the currency above (DRAW.CURRENCY)."},{"name":"referenceId","in":"query","type":"string","required":false,"description":"Reference Identifier of the Derivatives Trade "},{"name":"recordStatus","in":"query","type":"string","required":false,"description":"General status of the record. Possible values: - null - authorised - IHLD - input, on hold - INAU - input, not authorised - INA2 - input, authorised, pending second authorisation - INAO - input, not a"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"DrawingsDetailsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"POST","path":"/holdings/letterOfCredits/initiations","fullPath":"/api/v3.0.0/holdings/letterOfCredits/initiations","operationId":"createLetterOfCreditInitiation","name":"Initiate a new letter of credit request for specific customer","summary":"Creates letter of credit request","tags":["CORPORATE"],"parameters":[{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"applicantAddresses":[{}],"advisingBanks":[{}],"beneficiaries":[{}],"availableWithBanks":[{}],"additionalAmountsCovered":[{}],"deferredPayments":[{}],"contactDetails":[{}],"shipmentPeriods":[{}],"presentationPeriods":[{}],"descriptionsOfGoods":[{}],"documentCodes":[{}],"documentDetails":[{}],"documentsRequired":[{}],"additionalConditions":[{}],"narrativeCharges":[{}]}},"responses":{"200":"LetterOfCreditInitiationResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/holdings/letterOfCredits/{letterOfCreditId}/exports","fullPath":"/api/v3.0.0/holdings/letterOfCredits/{letterOfCreditId}/exports","operationId":"updateExportLetterOfCredit","name":"Update a new export letter of credit for specific customer","summary":"Update export letter of credit","tags":["CORPORATE"],"parameters":[{"name":"letterOfCreditId","in":"path","type":"string","required":true,"description":"Identifier of the Letter Of Credit"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"applicants":[{}],"advisingBanks":[{}],"beneficiaries":[{}],"additionalInformations":[{}],"additionalAmountsCovered":[{}],"deferredPayments":[{}],"contactDetails":[{}],"shipmentPeriods":[{}],"presentationPeriods":[{}],"descriptionOfGoods":[{}],"documentDetails":[{}],"documentsRequired":[{}],"clausesDetails":[{}],"additionalConditions":[{}],"narrativeCharges":[{}]}},"responses":{"200":"ExportLetterOfCreditResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/holdings/letterOfCredits/drawings/bills/negotiations","fullPath":"/api/v3.0.0/holdings/letterOfCredits/drawings/bills/negotiations","operationId":"getDrawingsNegotiationBills","name":"Retrieves the negotiated/discounted bills under the letter of credit","summary":"Retrieves the negotiated/discounted bills for drawings","tags":["CORPORATE"],"parameters":[{"name":"maturityReview","in":"query","type":"string","required":false,"description":"This field contains the date on which Acceptance/Deferred Payment drawings will mature, or Letter of Credit Collection drawings will be due for chasing."},{"name":"drawingType","in":"query","type":"string","required":false,"description":"This field is correlated to the other field payment type and identifies the Draw type under Letter of credit. Whether its a sight LC payment, acceptance, deferred payment or Mixed payment."},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"DrawingsNegotiationBillsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/letterOfCredits/drawings/bills/outstandings","fullPath":"/api/v3.0.0/holdings/letterOfCredits/drawings/bills/outstandings","operationId":"getDrawingsOutstandingBills","name":"Retrieves outstanding documents such as bills under the letter of credit","summary":"Retrieves the outstanding bills for drawings","tags":["CORPORATE"],"parameters":[{"name":"maturityReview","in":"query","type":"string","required":false,"description":"This field contains the date on which Acceptance/Deferred Payment drawings will mature, or Letter of Credit Collection drawings will be due for chasing."},{"name":"drawingType","in":"query","type":"string","required":false,"description":"This field is correlated to the other field payment type and identifies the Draw type under Letter of credit. Whether its a sight LC payment, acceptance, deferred payment or Mixed payment."},{"name":"presentorCustomerId","in":"query","type":"string","required":true,"description":"This field is used to identify the presentor of the documents if they are not a customer of the bank with a valid CUSTOMER.NO.Optionally input, identifies the presentor customer."},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"DrawingsOutstandingBillsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"PUT","path":"/holdings/letterOfCredits/{letterOfCreditId}/outwardCollections","fullPath":"/api/v3.0.0/holdings/letterOfCredits/{letterOfCreditId}/outwardCollections","operationId":"updateOutwardCollections","name":"Updates the amendments to the outward collection for the specified letter of credit/customer reference number","summary":"Updates the outward collection details","tags":["CORPORATE"],"parameters":[{"name":"letterOfCreditId","in":"path","type":"string","required":true,"description":"Identifier of the Letter Of Credit"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"applicantCustomerNames":[{}],"advisingBanks":[{}],"beneficiaryCustomerNames":[{}],"availableWithDetails":[{}],"additionalAmountsCovered":[{}],"deferredPayments":[{}],"contactDetails":[{}],"shipmentPeriods":[{}],"presentationPeriods":[{}],"descriptionOfGoods":[{}],"documentDetails":[{}],"documentsRequired":[{}],"clausesDetails":[{}],"additionalConditions":[{}],"narrativeCharges":[{}]}},"responses":{"200":"OutwardCollectionsResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/holdings/letterOfCredits/{letterOfCreditId}/inwardCollections","fullPath":"/api/v3.0.0/holdings/letterOfCredits/{letterOfCreditId}/inwardCollections","operationId":"updateInwardCollections","name":"Updates the amendments to the inward collection for the specified letter of credit/customer reference number","summary":"Updates the inward collection details","tags":["CORPORATE"],"parameters":[{"name":"letterOfCreditId","in":"path","type":"string","required":true,"description":"Identifier of the Letter Of Credit"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"inward":[{}],"applicantAddresses":[{}],"advisingBanks":[{}],"beneficiaries":[{}],"guaranteeReferences":[{}],"documents":[{}],"additionalConditions":[{}],"instructions":[{}],"bankToBanks":[{}],"invoiceReferences":[{}],"transportation":[{}],"charges":[{}],"chargeCodes":[{}],"extensions":{}}},"responses":{"200":"InwardCollectionsResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}}]},{"key":"holdings-letterOfCredit-service-v4.0.0","title":"Management of Letter of Credits","version":"v4.0.0","description":"API to create, update and manage various types of trade finance letter of credit (LC) instruments and their associated status and details. Some of the types of LCs that can be created are sight payments, back-to-back, standby's and usance LCs","endpointCount":82,"endpoints":[{"method":"POST","path":"/holdings/letterOfCredits/drawingsInitiation/{drawingId}","fullPath":"/api/v4.0.0/holdings/letterOfCredits/drawingsInitiation/{drawingId}","operationId":"createDrawings","name":"Initiate a new drawing request for a specific letter of credit","summary":"Initiate a new drawing request to check the documents for letter of credit","tags":["CORPORATE"],"parameters":[{"name":"drawingId","in":"path","type":"string","required":true,"description":"Identifier of drawings application under the Letter of Credit system that is used to effect the transfer of funds and the acceptance of documents under Letters of Credit and Documentary Collection tra"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"addresses":[{}],"documentStatus":[{}],"clausesTexts":[{}],"invoiceDocuments":[{}],"transportDocuments":[{}],"documents":[{}],"discrepancyDetails":[{}],"presentorCustomerId":"string","referenceId":"string","currencyId":"string","documentAmount":0.0,"paymentMethod":"string","debitAccountId":"string","creditAccountId":"string","nextReviewDate":"2024-01-01"}},"responses":{"200":"DrawingsResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"POST","path":"/holdings/letterOfCredits/drawings/{drawingId}/initiations","fullPath":"/api/v4.0.0/holdings/letterOfCredits/drawings/{drawingId}/initiations","operationId":"createDrawing","name":"Initiate a new drawing request registerered  for a specific letter of credit","summary":"Initiate a new drawing request to check the documents for letter of credit","tags":["CORPORATE"],"parameters":[{"name":"drawingId","in":"path","type":"string","required":true,"description":"Identifier of drawings application under the Letter of Credit system that is used to effect the transfer of funds and the acceptance of documents under Letters of Credit and Documentary Collection tra"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"addresses":[{}],"documentStatus":[{}],"clausesTexts":[{}],"invoiceDocuments":[{}],"transportDocuments":[{}],"documents":[{}],"discrepancyDetails":[{}],"presentorCustomerId":"string","referenceId":"string","currencyId":"string","documentAmount":0.0,"paymentMethod":"string","debitAccountId":"string","creditAccountId":"string","nextReviewDate":"2024-01-01"}},"responses":{"200":"DrawingResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/holdings/letterOfCredits/drawings/{drawingId}","fullPath":"/api/v4.0.0/holdings/letterOfCredits/drawings/{drawingId}","operationId":"getDrawing","name":"Retrieve the details of specific drawing that is created against a letter of credit","summary":"Retrieve the drawing requests for a specific letter of credit","tags":["CORPORATE"],"parameters":[{"name":"drawingId","in":"path","type":"string","required":true,"description":"Identifier of drawings application under the Letter of Credit system that is used to effect the transfer of funds and the acceptance of documents under Letters of Credit and Documentary Collection tra"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"DrawingResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/holdings/letterOfCredits/drawings/{drawingId}","fullPath":"/api/v4.0.0/holdings/letterOfCredits/drawings/{drawingId}","operationId":"updateDrawing","name":"Update an existing drawing for a specific letter of credit","summary":"Update drawing details","tags":["CORPORATE"],"parameters":[{"name":"drawingId","in":"path","type":"string","required":true,"description":"Identifier of drawings application under the Letter of Credit system that is used to effect the transfer of funds and the acceptance of documents under Letters of Credit and Documentary Collection tra"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"addresses":[{}],"documentStatus":[{}],"clausesTexts":[{}],"invoiceDocuments":[{}],"transportDocuments":[{}],"documents":[{}],"discrepancyDetails":[{}],"presentorCustomerId":"string","referenceId":"string","documentAmount":0.0,"paymentMethod":"string","debitAccountId":"string","creditAccountId":"string","nextReviewDate":"2024-01-01","valueDate":"2024-01-01"}},"responses":{"200":"DrawingResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"DELETE","path":"/holdings/letterOfCredits/drawings/{drawingId}","fullPath":"/api/v4.0.0/holdings/letterOfCredits/drawings/{drawingId}","operationId":"deleteDrawing","name":"Remove an existing drawing for a specific letter of credit","summary":"Remove drawing details","tags":["CORPORATE"],"parameters":[{"name":"drawingId","in":"path","type":"string","required":true,"description":"Identifier of drawings application under the Letter of Credit system that is used to effect the transfer of funds and the acceptance of documents under Letters of Credit and Documentary Collection tra"},{"name":"payload","in":"body","type":"object","required":false,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}}},"responses":{"200":"DrawingResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/holdings/letterOfCredits/drawingsApprovals/{drawingId}","fullPath":"/api/v4.0.0/holdings/letterOfCredits/drawingsApprovals/{drawingId}","operationId":"approveDrawing","name":"Approve a drawing  for specific letter of credit","summary":"Approve drawing ","tags":["CORPORATE"],"parameters":[{"name":"drawingId","in":"path","type":"string","required":true,"description":"Identifier of drawings application under the Letter of Credit system that is used to effect the transfer of funds and the acceptance of documents under Letters of Credit and Documentary Collection tra"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"DrawingResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/holdings/letterOfCredits/documents/{documentId}","fullPath":"/api/v4.0.0/holdings/letterOfCredits/documents/{documentId}","operationId":"getLcDocument","name":"Retrieves the details of specific letter of credit advice text","summary":"Overview details of letter of credit advice text","tags":["CORPORATE"],"parameters":[{"name":"documentId","in":"path","type":"string","required":true,"description":"Based on documentCode, the field defaults the required document codes"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"LcDocumentResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"POST","path":"/holdings/letterOfCredits/documents/{documentId}","fullPath":"/api/v4.0.0/holdings/letterOfCredits/documents/{documentId}","operationId":"createLcDocument","name":"Create a new letter of credit advice text","summary":"Create letter of credit advice text","tags":["CORPORATE"],"parameters":[{"name":"documentId","in":"path","type":"string","required":true,"description":"Based on documentCode, the field defaults the required document codes"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"documentDetails":[{}],"extensions":{}}},"responses":{"200":"LcDocumentResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/holdings/letterOfCredits/documents/{documentId}","fullPath":"/api/v4.0.0/holdings/letterOfCredits/documents/{documentId}","operationId":"updateLcDocument","name":"Update an existing letter of credit advice text","summary":"Update letter of credit advice text","tags":["CORPORATE"],"parameters":[{"name":"documentId","in":"path","type":"string","required":true,"description":"Based on documentCode, the field defaults the required document codes"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"documentDetails":[{}],"extensions":{}}},"responses":{"200":"LcDocumentResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"DELETE","path":"/holdings/letterOfCredits/documents/{documentId}","fullPath":"/api/v4.0.0/holdings/letterOfCredits/documents/{documentId}","operationId":"deleteLcDocument","name":"Delete an existing letter of credit advice text","summary":"Delete letter of credit advice text","tags":["CORPORATE"],"parameters":[{"name":"documentId","in":"path","type":"string","required":true,"description":"Based on documentCode, the field defaults the required document codes"},{"name":"payload","in":"body","type":"object","required":false,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}}},"responses":{"200":"LcDocumentResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"POST","path":"/holdings/letterOfCredits/{letterOfCreditId}/amendmentsInitiation","fullPath":"/api/v4.0.0/holdings/letterOfCredits/{letterOfCreditId}/amendmentsInitiation","operationId":"createLcAmendments","name":"Initiate a new letter of credit amendment","summary":"Initiate letter of credit amendment","tags":["CORPORATE"],"parameters":[{"name":"letterOfCreditId","in":"path","type":"string","required":true,"description":"Identifier of the Letter Of Credit"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"ibLimitExceeds":[{}],"additionalAmountsCovered":[{}],"shipmentPeriods":[{}],"lcAmend":[{}],"messageFromCustomers":[{}],"messageFromBanks":[{}],"overrides":[{}],"lcAmount":0.0,"increaseDecreaseAmount":0.0,"decreaseCreditAmount":0.0,"increaseCreditAmount":0.0,"maximumCreditAmount":"string","newAdviceExpiryDate":"2024-01-01","shipmentDespatch":"string","otherDespatchDetails":"string"}},"responses":{"200":"LcAmendmentsResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"POST","path":"/holdings/letterOfCredits/{letterOfCreditId}/amendments/initiations","fullPath":"/api/v4.0.0/holdings/letterOfCredits/{letterOfCreditId}/amendments/initiations","operationId":"createLcAmendment","name":"Initiate a new letter of credit amendment","summary":"Initiate letter of credit amendment","tags":["CORPORATE"],"parameters":[{"name":"letterOfCreditId","in":"path","type":"string","required":true,"description":"Identifier of the Letter Of Credit"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"ibLimitExceeds":[{}],"additionalAmountsCovered":[{}],"shipmentPeriods":[{}],"lcAmend":[{}],"messageFromCustomers":[{}],"messageFromBanks":[{}],"overrides":[{}],"lcAmount":0.0,"increaseDecreaseAmount":0.0,"decreaseCreditAmount":0.0,"increaseCreditAmount":0.0,"maximumCreditAmount":"string","newAdviceExpiryDate":"2024-01-01","shipmentDespatch":"string","otherDespatchDetails":"string"}},"responses":{"200":"LcAmendmentResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/holdings/letterOfCredits/{letterOfCreditId}/amendments","fullPath":"/api/v4.0.0/holdings/letterOfCredits/{letterOfCreditId}/amendments","operationId":"getLCAmendments","name":"Retrieves the list of letter of credit amendment details","summary":"Retrieves the letter of credit amendments","tags":["CORPORATE"],"parameters":[{"name":"letterOfCreditId","in":"path","type":"string","required":true,"description":"Identifier of the Letter Of Credit"},{"name":"eventStatus","in":"query","type":"string","required":false,"description":"Specifies the status of the request.Allowed values are - With Bank_With Customer_Approved_Rejected."},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"LCAmendmentsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"PUT","path":"/holdings/letterOfCredits/{letterOfCreditId}/amendments","fullPath":"/api/v4.0.0/holdings/letterOfCredits/{letterOfCreditId}/amendments","operationId":"updateLcAmendment","name":"Update an existing amendment for specific letter of credit","summary":"Update letter of credit amendment","tags":["CORPORATE"],"parameters":[{"name":"letterOfCreditId","in":"path","type":"string","required":true,"description":"Identifier of the Letter Of Credit"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"ibLimitExceeds":[{}],"additionalAmountsCovered":[{}],"shipmentPeriods":[{}],"lcAmend":[{}],"messageFromCustomers":[{}],"messageFromBanks":[{}],"overrides":[{}],"lcAmount":0.0,"increaseDecreaseAmount":0.0,"decreaseCreditAmount":0.0,"increaseCreditAmount":0.0,"maximumCreditAmount":"string","newAdviceExpiryDate":"2024-01-01","shipmentDespatch":"string","otherDespatchDetails":"string"}},"responses":{"200":"LcAmendmentResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"DELETE","path":"/holdings/letterOfCredits/{letterOfCreditId}/amendments","fullPath":"/api/v4.0.0/holdings/letterOfCredits/{letterOfCreditId}/amendments","operationId":"deleteLcAmendment","name":"Remove an existing letter of credit amendment","summary":"Remove letter of credit amendment","tags":["CORPORATE"],"parameters":[{"name":"letterOfCreditId","in":"path","type":"string","required":true,"description":"Identifier of the Letter Of Credit"},{"name":"payload","in":"body","type":"object","required":false,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}}},"responses":{"200":"LcAmendmentResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/holdings/letterOfCredits/{letterOfCreditId}/amendmentApprovals","fullPath":"/api/v4.0.0/holdings/letterOfCredits/{letterOfCreditId}/amendmentApprovals","operationId":"approveLcAmendments","name":"Approve an initiated letter of credit amendment ","summary":"Approve letter of credit amendment","tags":["CORPORATE"],"parameters":[{"name":"letterOfCreditId","in":"path","type":"string","required":true,"description":"Identifier of the Letter Of Credit"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"LcAmendmentsResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/holdings/letterOfCredits/{letterOfCreditId}/amendments/approvals","fullPath":"/api/v4.0.0/holdings/letterOfCredits/{letterOfCreditId}/amendments/approvals","operationId":"approveLcAmendment","name":"Approve an initiated letter of credit amendment ","summary":"Approve letter of credit amendment","tags":["CORPORATE"],"parameters":[{"name":"letterOfCreditId","in":"path","type":"string","required":true,"description":"Identifier of the Letter Of Credit"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"LcAmendmentResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/holdings/letterOfCredits/clauses/{clausesId}","fullPath":"/api/v4.0.0/holdings/letterOfCredits/clauses/{clausesId}","operationId":"getLcClause","name":"Retrieves the details of specific letter of credit clause","summary":"Overview details of letter of credit clause","tags":["CORPORATE"],"parameters":[{"name":"clausesId","in":"path","type":"string","required":true,"description":"This is the key to the LC.CLAUSES file.During the input of an L/C this code can be entered for the inclusion of standard clauses."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"LcClauseResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"POST","path":"/holdings/letterOfCredits/clauses/{clausesId}","fullPath":"/api/v4.0.0/holdings/letterOfCredits/clauses/{clausesId}","operationId":"createLcClause","name":"Create a new letter of credit clause","summary":"Create a static narrative information for letter of credit","tags":["CORPORATE"],"parameters":[{"name":"clausesId","in":"path","type":"string","required":true,"description":"This is the key to the LC.CLAUSES file.During the input of an L/C this code can be entered for the inclusion of standard clauses."},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"narratives":[{}],"lcClausesName":"string","extensions":{}}},"responses":{"200":"LcClauseResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/holdings/letterOfCredits/clauses/{clausesId}","fullPath":"/api/v4.0.0/holdings/letterOfCredits/clauses/{clausesId}","operationId":"updateLcClause","name":"Update an existing letter of credit clause","summary":"Update a static narrative information for letter of credit","tags":["CORPORATE"],"parameters":[{"name":"clausesId","in":"path","type":"string","required":true,"description":"This is the key to the LC.CLAUSES file.During the input of an L/C this code can be entered for the inclusion of standard clauses."},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"narratives":[{}],"lcClausesName":"string","extensions":{}}},"responses":{"200":"LcClauseResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"DELETE","path":"/holdings/letterOfCredits/clauses/{clausesId}","fullPath":"/api/v4.0.0/holdings/letterOfCredits/clauses/{clausesId}","operationId":"deleteLcClause","name":"Remove an existing letter of credit clause","summary":"Remove a static narrative information for letter of credit","tags":["CORPORATE"],"parameters":[{"name":"clausesId","in":"path","type":"string","required":true,"description":"This is the key to the LC.CLAUSES file.During the input of an L/C this code can be entered for the inclusion of standard clauses."},{"name":"payload","in":"body","type":"object","required":false,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}}},"responses":{"200":"LcClauseResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/holdings/letterOfCredits/{letterOfCreditId}/drawings","fullPath":"/api/v4.0.0/holdings/letterOfCredits/{letterOfCreditId}/drawings","operationId":"getDrawings","name":"Retrieves the list of drawings for specific customer","summary":"Retrieve drawing details","tags":["CORPORATE"],"parameters":[{"name":"letterOfCreditId","in":"path","type":"string","required":true,"description":"Identifier of the Letter Of Credit"},{"name":"eventStatus","in":"query","type":"string","required":false,"description":"Specifies the status of the request.Allowed values are - With Bank_With Customer_Approved_Rejected."},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"DrawingsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/customers/{customerId}/letterOfCredits/documents","fullPath":"/api/v4.0.0/holdings/customers/{customerId}/letterOfCredits/documents","operationId":"getLCDocuments","name":"Retrieves the list of letter of credit advice text details","summary":"Retrieves the letter of credit advice text details","tags":["CORPORATE"],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"Identifier of the customer"},{"name":"lcAdviceTextId","in":"query","type":"string","required":false,"description":"This is the key to the letter of credit advice text file.During the input of an L/C this code can be entered for the inclusion of standard text."},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"LCDocumentsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/customers/{customerId}/letterOfCredits/clauses","fullPath":"/api/v4.0.0/holdings/customers/{customerId}/letterOfCredits/clauses","operationId":"getLCClauses","name":"Retrieves the list of narrative static information data for use in the mapping and construction of L/C advices/documents generated as a result of L/C transactions within the Transact delivery application","summary":"Retrieves the letter of credit clause details","tags":["CORPORATE"],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"Identifier of the customer"},{"name":"lcClausesId","in":"query","type":"string","required":false,"description":"This is the key to the LC.CLAUSES file.During the input of an L/C this code can be entered for the inclusion of standard clauses."},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"LCClausesResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/letterOfCredits/incoTerms","fullPath":"/api/v4.0.0/holdings/letterOfCredits/incoTerms","operationId":"getIncoTerms","name":"Retrieves the list of letter of credit enrichment text details","summary":"Retrieves letter of credit enrichments","tags":["CORPORATE"],"parameters":[{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"IncoTermsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/letterOfCredits","fullPath":"/api/v4.0.0/holdings/letterOfCredits","operationId":"getLetterOfCredits","name":"Retrieves the list of letter of credits for specific customer","summary":"Retrieves letter of credit details","tags":["CORPORATE"],"parameters":[{"name":"letterOfCreditId","in":"query","type":"string","required":false,"description":"Identifier of the Letter Of Credit"},{"name":"customerId","in":"query","type":"string","required":false,"description":"Identifier of the customer"},{"name":"operation","in":"query","type":"string","required":false,"description":"Identifies the required operation to be executed for a Trade Finance contract. Input of valid codes as: O for opening of LC, P for Pre-advise of LC, A for Amend LC, C for Collect Charges, D for Decisi"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"LetterOfCreditsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/letterOfCredits/exports/drawings","fullPath":"/api/v4.0.0/holdings/letterOfCredits/exports/drawings","operationId":"getExportDrawings","name":"Retrieves the list of export letter of credit drawings for specific customer","summary":"Retrieves export letter of credit drawings","tags":["CORPORATE"],"parameters":[{"name":"customerId","in":"query","type":"string","required":false,"description":"Identifier of the customer"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"ExportDrawingsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/letterOfCredits/exports/amendments","fullPath":"/api/v4.0.0/holdings/letterOfCredits/exports/amendments","operationId":"getExportLCAmendments","name":"Retrieves the list of export letter of credit amendments for specific customer","summary":"Retrieves export letter of credit amendments","tags":["CORPORATE"],"parameters":[{"name":"customerId","in":"query","type":"string","required":false,"description":"Identifier of the customer"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"ExportLCAmendmentsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/letterOfCredits/exports","fullPath":"/api/v4.0.0/holdings/letterOfCredits/exports","operationId":"getRegisteredExportLc","name":"Retrieves the list of export letter of credits registered for specific customer","summary":"Retrieves registered export letter of credits","tags":["CORPORATE"],"parameters":[{"name":"adviceExpiryDate","in":"query","type":"string","required":false,"description":"Specifies the actual expiry date of Guarantee."},{"name":"transactionReference","in":"query","type":"string","required":true,"description":"Contains the identifier for the transaction in the core system"},{"name":"issuingBankId","in":"query","type":"string","required":false,"description":"Identifies the Issuing bank ID under the LC, who issues the LC under when a bank is advising the Letter of Credit"},{"name":"lcCurrency","in":"query","type":"string","required":false,"description":"Denote the currency of the Letter of Credit."},{"name":"lcAmount","in":"query","type":"string","required":false,"description":"This field indicates the amount of the Letter of Credit that will always be expressed in the currency of Letter of Credit."},{"name":"beneficiaryCustomerId","in":"query","type":"string","required":false,"description":"Identifies the Customer who is to be the ultimate receiver of the funds transferred by the sending bank when this Beneficiary is not a bank."},{"name":"liabilityReversalDate","in":"query","type":"string","required":false,"description":"Date on which the contingent entries and the limits raised on the LC will be reversed."},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"RegisteredExportLcResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"POST","path":"/holdings/letterOfCredits/exports","fullPath":"/api/v4.0.0/holdings/letterOfCredits/exports","operationId":"createExportLetterOfCredit","name":"Create a new export letter of credit for specific customer","summary":"Create export letter of credit","tags":["CORPORATE"],"parameters":[{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"applicants":[{}],"advisingBanks":[{}],"beneficiaries":[{}],"additionalInformations":[{}],"additionalAmountsCovered":[{}],"deferredPayments":[{}],"contactDetails":[{}],"shipmentPeriods":[{}],"presentationPeriods":[{}],"descriptionOfGoods":[{}],"documentDetails":[{}],"documentsRequired":[{}],"clausesDetails":[{}],"additionalConditions":[{}],"narrativeCharges":[{}]}},"responses":{"200":"ExportLetterOfCreditResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/holdings/letterOfCredits/imports/drawings","fullPath":"/api/v4.0.0/holdings/letterOfCredits/imports/drawings","operationId":"getImportDrawings","name":"Retrieves the list of import letter of credit drawings for specific customer","summary":"Retrieves import letter of credit drawings","tags":["CORPORATE"],"parameters":[{"name":"customerId","in":"query","type":"string","required":false,"description":"Identifier of the customer"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"ImportDrawingsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/letterOfCredits/imports/amendments","fullPath":"/api/v4.0.0/holdings/letterOfCredits/imports/amendments","operationId":"getImportLCAmendments","name":"Retrieves the list of import letter of credit amendments for specific customer","summary":"Retrieves import letter of credit amendments","tags":["CORPORATE"],"parameters":[{"name":"customerId","in":"query","type":"string","required":false,"description":"Identifier of the customer"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"ImportLCAmendmentsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/letterOfCredits/imports","fullPath":"/api/v4.0.0/holdings/letterOfCredits/imports","operationId":"getImportLc","name":"Retrieves the list of import letter of credits for specific customer","summary":"Retrieves import letter of credits","tags":["CORPORATE"],"parameters":[{"name":"customerId","in":"query","type":"string","required":false,"description":"Identifier of the customer"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"ImportLcResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/letterOfCredits/outwardCollections/documents","fullPath":"/api/v4.0.0/holdings/letterOfCredits/outwardCollections/documents","operationId":"getOutwardCollectionDocuments","name":"Retrieves the list of outward collections document codes for specific customer","summary":"Retrieves the outward collection document codes","tags":["CORPORATE"],"parameters":[{"name":"lcAdviceTextId","in":"query","type":"string","required":false,"description":"This is the key to the letter of credit advice text file.During the input of an L/C this code can be entered for the inclusion of standard text."},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"OutwardCollectionDocumentsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/letterOfCredits/inwardCollections/amendments","fullPath":"/api/v4.0.0/holdings/letterOfCredits/inwardCollections/amendments","operationId":"getInwardCollectionsAmendments","name":"Retrieves the list of inward collection amendments for specific customer","summary":"Retrieves the inward collection amendments","tags":["CORPORATE"],"parameters":[{"name":"customerId","in":"query","type":"string","required":false,"description":"Identifier of the customer"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"InwardCollectionsAmendmentsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/letterOfCredits/inwardCollections","fullPath":"/api/v4.0.0/holdings/letterOfCredits/inwardCollections","operationId":"getInwardCollections","name":"Retrieves the list of inward collections for specific customer","summary":"Retrieves the inward collections","tags":["CORPORATE"],"parameters":[{"name":"customerId","in":"query","type":"string","required":false,"description":"Identifier of the customer"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"InwardCollectionsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"POST","path":"/holdings/letterOfCredits/inwardCollections","fullPath":"/api/v4.0.0/holdings/letterOfCredits/inwardCollections","operationId":"createInwardCollection","name":"Lodgment of the Import documentary collection by the collecting bank ","summary":"Creates a new inward documentary collection","tags":["CORPORATE"],"parameters":[{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"inward":[{}],"applicantAddresses":[{}],"advisingBanks":[{}],"beneficiaries":[{}],"guaranteeReferences":[{}],"documents":[{}],"additionalConditions":[{}],"instructions":[{}],"bankToBanks":[{}],"invoiceReferences":[{}],"transportation":[{}],"charges":[{}],"chargeCodes":[{}],"extensions":{}}},"responses":{"200":"InwardCollectionResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/holdings/letterOfCredits/tenors","fullPath":"/api/v4.0.0/holdings/letterOfCredits/tenors","operationId":"getLcTenors","name":"Retrieves the list of letter of credit tenor details","summary":"Retrieves letter of credit tenor details","tags":["CORPORATE"],"parameters":[{"name":"lcPayTypeId","in":"query","type":"string","required":false,"description":"Indicates the identifier of payment type enrichment for letter of credit."},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"LcTenorsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/letterOfCredits/outwardCollections/amendments","fullPath":"/api/v4.0.0/holdings/letterOfCredits/outwardCollections/amendments","operationId":"getOutwardCollectionAmdendments","name":"Retrieves the list of outward collection amendments for specific customer","summary":"Retrieves outward collection amendments","tags":["CORPORATE"],"parameters":[{"name":"customerId","in":"query","type":"string","required":false,"description":"Identifier of the customer"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"OutwardCollectionAmdendmentsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/letterOfCredits/outwardCollections","fullPath":"/api/v4.0.0/holdings/letterOfCredits/outwardCollections","operationId":"getOutwardCollections","name":"Retrieves the outstanding details of outward collections","summary":"Retrieves the outward collection amendments","tags":["CORPORATE"],"parameters":[{"name":"customerId","in":"query","type":"string","required":false,"description":"Identifier of the customer"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"OutwardCollectionsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"POST","path":"/holdings/letterOfCredits/outwardCollections","fullPath":"/api/v4.0.0/holdings/letterOfCredits/outwardCollections","operationId":"createOutwardCollections","name":"Initiation of the export documentary collection by the collecting bank","summary":"Creates the outward collections","tags":["CORPORATE"],"parameters":[{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"beneficiaryDetails":[{}],"issuingBankNames":[{}],"applicantNames":[{}],"documentCodes":[{}],"additionalConditions":[{}],"instructionDetails":[{}],"bankToBanks":[{}],"deliveryInstructions":[{}],"chargeCodes":[{}],"avalisationDetails":[{}],"externalReference":"string","beneficiaryCustomerId":"string","beneficiaryAccountId":"string","currencyId":"string","issueDate":"string"}},"responses":{"200":"OutwardCollectionsResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/holdings/letterOfCredits/limits","fullPath":"/api/v4.0.0/holdings/letterOfCredits/limits","operationId":"getLcLimits","name":"Retrieves the list of letter of credit limit details","summary":"Retrieves the letter of credit limits","tags":["CORPORATE"],"parameters":[{"name":"customerId","in":"query","type":"string","required":false,"description":"Identifier of the customer"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"LcLimitsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"DELETE","path":"/holdings/letterOfCredits/drawings/{drawingId}/cancellations/","fullPath":"/api/v4.0.0/holdings/letterOfCredits/drawings/{drawingId}/cancellations/","operationId":"rejectDrawing","name":"Cancel an initiated drawing for letter of credit","summary":"Cancel initiated drawing","tags":["CORPORATE"],"parameters":[{"name":"drawingId","in":"path","type":"string","required":true,"description":"Identifier of drawings application under the Letter of Credit system that is used to effect the transfer of funds and the acceptance of documents under Letters of Credit and Documentary Collection tra"},{"name":"payload","in":"body","type":"object","required":false,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}}},"responses":{"200":"DrawingResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"DELETE","path":"/holdings/letterOfCredits/{letterOfCreditId}/amendments/cancellations","fullPath":"/api/v4.0.0/holdings/letterOfCredits/{letterOfCreditId}/amendments/cancellations","operationId":"rejectLcAmendment","name":"Cancel an initiated letter of credit amendment","summary":"Cancel letter of credit amendment","tags":["CORPORATE"],"parameters":[{"name":"letterOfCreditId","in":"path","type":"string","required":true,"description":"Identifier of the Letter Of Credit"},{"name":"payload","in":"body","type":"object","required":false,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}}},"responses":{"200":"LcAmendmentResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/holdings/letterOfCredits/ApprovedOutwardCollections","fullPath":"/api/v4.0.0/holdings/letterOfCredits/ApprovedOutwardCollections","operationId":"getApprovedOutwardCollections","name":"Retrieve the list of approved outward collections for specific customer","summary":"Retrieve approved outward collections","tags":["CORPORATE"],"parameters":[{"name":"collectionId","in":"query","type":"string","required":false,"description":"Identifier of collection id"},{"name":"beneficiaryCustomerId","in":"query","type":"string","required":false,"description":"Identifies the Customer who is to be the ultimate receiver of the funds transferred by the sending bank when this Beneficiary is not a bank."},{"name":"ibStatus","in":"query","type":"string","required":false,"description":"Field to indicate the status of LC request through internet banking."},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"ApprovedOutwardCollectionsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/letterOfCredits/{lcAmendmentId}/amendment","fullPath":"/api/v4.0.0/holdings/letterOfCredits/{lcAmendmentId}/amendment","operationId":"getLcAmendment","name":"Retrieve the details of specific letter of credit amendment details","summary":"Overview details of letter of credit amendment","tags":["CORPORATE"],"parameters":[{"name":"lcAmendmentId","in":"path","type":"string","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"LcAmendmentResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"POST","path":"/holdings/letterOfCreditsInitiation","fullPath":"/api/v4.0.0/holdings/letterOfCreditsInitiation","operationId":"createLetterOfCredit","name":"Initiate a new letter of credit request for specific customer","summary":"Create letter of credit request","tags":["CORPORATE"],"parameters":[{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"applicantCustomerNames":[{}],"advisingBanks":[{}],"beneficiaryCustomerNames":[{}],"availableWithDetails":[{}],"additionalAmountsCovered":[{}],"deferredPayments":[{}],"contactDetails":[{}],"shipmentPeriods":[{}],"presentationPeriods":[{}],"descriptionOfGoods":[{}],"documentDetails":[{}],"documentsRequired":[{}],"clausesDetails":[{}],"additionalConditions":[{}],"narrativeCharges":[{}]}},"responses":{"200":"LetterOfCreditResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/holdings/letterOfCredit/{letterOfCreditId}","fullPath":"/api/v4.0.0/holdings/letterOfCredit/{letterOfCreditId}","operationId":"updateLetterOfCredits","name":"Update an existing letter of credit for specific customer","summary":"Update letter of credit","tags":["CORPORATE"],"parameters":[{"name":"letterOfCreditId","in":"path","type":"string","required":true,"description":"Identifier of the Letter Of Credit"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"applicantCustomerNames":[{}],"advisingBanks":[{}],"beneficiaryCustomerNames":[{}],"availableWithDetails":[{}],"additionalAmountsCovered":[{}],"deferredPayments":[{}],"contactDetails":[{}],"shipmentPeriods":[{}],"presentationPeriods":[{}],"descriptionOfGoods":[{}],"documentDetails":[{}],"documentsRequired":[{}],"clausesDetails":[{}],"additionalConditions":[{}],"narrativeCharges":[{}]}},"responses":{"200":"LetterOfCreditsResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/holdings/letterOfCredits/{letterOfCreditId}","fullPath":"/api/v4.0.0/holdings/letterOfCredits/{letterOfCreditId}","operationId":"getLetterOfCredit","name":"Retrieves the details of specific letter of credit","summary":"Retrieves the details of letter of credit","tags":["CORPORATE"],"parameters":[{"name":"letterOfCreditId","in":"path","type":"string","required":true,"description":"Identifier of the Letter Of Credit"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"LetterOfCreditResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"POST","path":"/holdings/letterOfCredits/{letterOfCreditId}","fullPath":"/api/v4.0.0/holdings/letterOfCredits/{letterOfCreditId}","operationId":"updateExternalAmendmentToAnLC","name":"Updates the  amendments to the letter of credit for the specified letter of credit/customer reference number","summary":"Updates letter of credit details","tags":["CORPORATE"],"parameters":[{"name":"letterOfCreditId","in":"path","type":"string","required":true,"description":""},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"additionalAmountsCovered":[{}],"amendmentInformations":[{}],"beneficiaries":[{}],"narrativeCharges":[{}],"reimbursingBankAndAddresses":[{}],"bankToBanks":[{}],"charges":[{}],"chargeCodes":[{}],"commissionDetails":[{}],"margins":[{}],"issuingBankNames":[{}],"applicantAddresses":[{}],"availableWithBanks":[{}],"draftsAt":[{}],"drawees":[{}]}},"responses":{"200":"ExternalAmendmentToAnLCResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/holdings/letterOfCredits/{letterOfCreditId}","fullPath":"/api/v4.0.0/holdings/letterOfCredits/{letterOfCreditId}","operationId":"updateLetterOfCredit","name":"Updates the letter of credit initiation for the specified letter of credit/customer reference number","summary":"Updates letter of credit details","tags":["CORPORATE"],"parameters":[{"name":"letterOfCreditId","in":"path","type":"string","required":true,"description":"Identifier of the Letter Of Credit"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"applicantAddresses":[{}],"advisingBanks":[{}],"beneficiaries":[{}],"availableWithBanks":[{}],"additionalAmountsCovered":[{}],"deferredPayments":[{}],"contactDetails":[{}],"shipmentPeriods":[{}],"presentationPeriods":[{}],"descriptionsOfGoods":[{}],"documentCodes":[{}],"documentDetails":[{}],"documentsRequired":[{}],"additionalConditions":[{}],"narrativeCharges":[{}]}},"responses":{"200":"LetterOfCreditResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"DELETE","path":"/holdings/letterOfCredits/{letterOfCreditId}","fullPath":"/api/v4.0.0/holdings/letterOfCredits/{letterOfCreditId}","operationId":"deleteLetterOfCredit","name":"Remove an existing letter of credit for specific customer","summary":"Remove letter of credit","tags":["CORPORATE"],"parameters":[{"name":"letterOfCreditId","in":"path","type":"string","required":true,"description":"Identifier of the Letter Of Credit"},{"name":"payload","in":"body","type":"object","required":false,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}}},"responses":{"200":"LetterOfCreditResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/holdings/letterOfCredits/letterOfCreditApprovals/{letterOfCreditId}","fullPath":"/api/v4.0.0/holdings/letterOfCredits/letterOfCreditApprovals/{letterOfCreditId}","operationId":"approveLetterOfCredit","name":"Approve an initiated letter of credit request for specific customer","summary":"Approve letter of credit request","tags":["CORPORATE"],"parameters":[{"name":"letterOfCreditId","in":"path","type":"string","required":true,"description":"Identifier of the Letter Of Credit"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"LetterOfCreditResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"DELETE","path":"/holdings/letterOfCredits/cancellations/{letterOfCreditId}","fullPath":"/api/v4.0.0/holdings/letterOfCredits/cancellations/{letterOfCreditId}","operationId":"rejectLetterOfCredit","name":"Cancel an initiated letter of credit request for specific customer","summary":"Cancel letter of credit request","tags":["CORPORATE"],"parameters":[{"name":"letterOfCreditId","in":"path","type":"string","required":true,"description":"Identifier of the Letter Of Credit"},{"name":"payload","in":"body","type":"object","required":false,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}}},"responses":{"200":"LetterOfCreditResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"POST","path":"/holdings/letterOfCredit/exports","fullPath":"/api/v4.0.0/holdings/letterOfCredit/exports","operationId":"createExportLetterOfCredits","name":"Create a new export letter of credit for specific customer","summary":"Create export letter of credit","tags":["CORPORATE"],"parameters":[{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"applicantCustomerNames":[{}],"advisingBanks":[{}],"beneficiaryCustomerNames":[{}],"availableWithDetails":[{}],"additionalAmountsCovered":[{}],"deferredPayments":[{}],"contactDetails":[{}],"shipmentPeriods":[{}],"presentationPeriods":[{}],"descriptionOfGoods":[{}],"documentDetails":[{}],"documentsRequired":[{}],"clausesDetails":[{}],"additionalConditions":[{}],"narrativeCharges":[{}]}},"responses":{"200":"ExportLetterOfCreditsResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/holdings/letterOfCredit/{letterOfCreditId}/exports","fullPath":"/api/v4.0.0/holdings/letterOfCredit/{letterOfCreditId}/exports","operationId":"updateExportLetterOfCredits","name":"Update a new export letter of credit for specific customer","summary":"Update export letter of credit","tags":["CORPORATE"],"parameters":[{"name":"letterOfCreditId","in":"path","type":"string","required":true,"description":"Identifier of the Letter Of Credit"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"applicantCustomerNames":[{}],"advisingBanks":[{}],"beneficiaryCustomerNames":[{}],"availableWithDetails":[{}],"additionalAmountsCovered":[{}],"deferredPayments":[{}],"contactDetails":[{}],"shipmentPeriods":[{}],"presentationPeriods":[{}],"descriptionOfGoods":[{}],"documentDetails":[{}],"documentsRequired":[{}],"clausesDetails":[{}],"additionalConditions":[{}],"narrativeCharges":[{}]}},"responses":{"200":"ExportLetterOfCreditsResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"POST","path":"/holdings/letterOfCredits/sightPayments","fullPath":"/api/v4.0.0/holdings/letterOfCredits/sightPayments","operationId":"createIssuanceOfSightPaymentLC","name":"Creates sight payment letter of credit for the requested customer reference number","summary":"Create sight payment letter of credit","tags":["CORPORATE"],"parameters":[{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"applicantAddresses":[{}],"beneficiaryAddresses":[{}],"advisingBankAddresses":[{}],"adviseThroughBanks":[{}],"availableWithBanks":[{}],"reimbursingBanks1":[{}],"requestedConfirmBankNames":[{}],"charges":[{}],"importSightPmtLcType":"string","lcNumber":"string","applicant":"string","lcCurrency":"string","lcAmount":0.0,"creditTolerance":"string","debitTolerance":"string"}},"responses":{"200":"IssuanceOfSightPaymentLCResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"POST","path":"/holdings/letterOfCredits/usances","fullPath":"/api/v4.0.0/holdings/letterOfCredits/usances","operationId":"createIssuanceOfUsanceLC","name":"Creates usance letter of credit for the requested customer reference number","summary":"Create usance letter of credit","tags":["CORPORATE"],"parameters":[{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"applicantAddresses":[{}],"limitReferences":[{}],"beneficiaryAddresses":[{}],"advisingBankAddresses":[{}],"adviseThroughBanks":[{}],"availableWithBanks":[{}],"reimbursingBanks1":[{}],"requestedConfirmBankNames":[{}],"charges":[{}],"importUsanceLCType":"string","lcNumber":"string","applicant":"string","currency":"string","amount":0.0,"creditTolerance":"string"}},"responses":{"200":"IssuanceOfUsanceLCResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"POST","path":"/holdings/letterOfCredits/negotiations","fullPath":"/api/v4.0.0/holdings/letterOfCredits/negotiations","operationId":"createIssuanceOfNegotiationLC","name":"Creates negotiation letter of credit for the requested customer reference number","summary":"Create negotiation letter of credit","tags":["CORPORATE"],"parameters":[{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"applicantAddresses":[{}],"beneficiaryAddresses":[{}],"advisingBankAddresses":[{}],"adviseThroughBanks":[{}],"availableWithBanks":[{}],"reimbursingBanks1":[{}],"requestedConfirmBankNames":[{}],"charges":[{}],"importNegotiationLCType":"string","lcNumber":"string","applicant":"string","lcCurrency":"string","lcAmount":"string","creditTolerance":"string","debitTolerance":"string"}},"responses":{"200":"IssuanceOfNegotiationLCResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"POST","path":"/holdings/letterOfCredits/mixedPayments","fullPath":"/api/v4.0.0/holdings/letterOfCredits/mixedPayments","operationId":"createIssuanceOfMixedPaymentLC","name":"Creates mixed payment letter of credit for the requested customer reference number","summary":"Create mixed payment letter of credit","tags":["CORPORATE"],"parameters":[{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"applicantAddresses":[{}],"beneficiaryAddresses":[{}],"advisingBankAddresses":[{}],"adviseThroughBanks":[{}],"availableWithBanks":[{}],"reimbursingBanks1":[{}],"requestedConfirmBankNames":[{}],"charges":[{}],"drawings":[{}],"importMixedPmtLCType":"string","lcNumber":"string","applicantCustomer":"string","lcCurrency":"string","lcAmount":"string","creditTolerance":"string"}},"responses":{"200":"IssuanceOfMixedPaymentLCResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"POST","path":"/holdings/letterOfCredits/standbys","fullPath":"/api/v4.0.0/holdings/letterOfCredits/standbys","operationId":"createIssuanceOfStandbyLC","name":"Creates standby letter of credit for the requested customer reference number","summary":"Create standby letter of credit","tags":["CORPORATE"],"parameters":[{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"applicantAddresses":[{}],"limitReferences":[{}],"beneficiaryAddresses":[{}],"advisingBankAddresses":[{}],"adviseThroughBanks":[{}],"availableWithBanks":[{}],"reimbursingBanks1":[{}],"requestedConfirmBankNames":[{}],"charges":[{}],"importLCType":"string","lcNumber":"string","applicantCustomer":"string","lcCurrency":"string","lcAmount":0.0,"creditTolerance":"string"}},"responses":{"200":"IssuanceOfStandbyLCResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"POST","path":"/holdings/letterOfCredits/imports/preAdvises","fullPath":"/api/v4.0.0/holdings/letterOfCredits/imports/preAdvises","operationId":"createIssuanceOfPreAdviseImportLC","name":"Creates a pre-advice import letter of credit request.","summary":"Creates pre-advice letter of credit","tags":["CORPORATE"],"parameters":[{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"applicantAddresses":[{}],"limitReferences":[{}],"beneficiaryAddresses":[{}],"advisingBankAddresses":[{}],"adviseThroughBanks":[{}],"availableWithBanks":[{}],"reimbursingBanks1":[{}],"requestedConfirmBankNames":[{}],"charges":[{}],"lcNumber":"string","lcType":"string","applicant":"string","currency":"string","amount":0.0,"creditTolerance":"string"}},"responses":{"200":"IssuanceOfPreAdviseImportLCResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"POST","path":"/holdings/letterOfCredits/backToBacks","fullPath":"/api/v4.0.0/holdings/letterOfCredits/backToBacks","operationId":"createIssuanceOfBackToBackLC","name":"Creates back-to-back letter of credit for the requested customer reference number","summary":"Creates back-to-back letter of credit","tags":["CORPORATE"],"parameters":[{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"limitReferences":[{}],"beneficiaryAddresses":[{}],"applicantNames":[{}],"availableWithBanks":[{}],"adviseThroughBanks":[{}],"charges":[{}],"drawings":[{}],"accountWithBanks":[{}],"senderReceiversInfoMT730":[{}],"exportLCType":"string","backToBackLCRequired":"string","relatedImportLCReference":"string","advisingBankReference":"string","lcAdvisingReference":"string","issuingBankLCReference":"string"}},"responses":{"200":"IssuanceOfBackToBackLCResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"POST","path":"/holdings/letterOfCredits/transferables","fullPath":"/api/v4.0.0/holdings/letterOfCredits/transferables","operationId":"createIssuanceOfTransferableLC","name":"Creates transferable letter of credit for the requested customer reference number","summary":"Creates transferable letter of credit","tags":["CORPORATE"],"parameters":[{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"advisingBanks":[{}],"limitReferences":[{}],"drawings":[{}],"charges":[{}],"assignments":[{}],"secondBeneficiaries":[{}],"availableWithBanks":[{}],"draftsAt":[{}],"drawees":[{}],"mixedPaymentDetails":[{}],"negotiationDeferredPaymentDetails":[{}],"shipmentPeriods":[{}],"documentsRequired":[{}],"additionalConditions":[{}],"narrativeCharges":[{}]}},"responses":{"200":"IssuanceOfTransferableLCResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"POST","path":"/holdings/letterOfCredits/{letterOfCreditId}/beneficiaryConsents","fullPath":"/api/v4.0.0/holdings/letterOfCredits/{letterOfCreditId}/beneficiaryConsents","operationId":"updateAmendmentSeekingBeneficiaryConsent","name":"Updates letter of credit amendments seeking beneficiary's consent for the specified letter of credit/customer reference number","summary":"Updates letter of credit beneficiary's consent details","tags":["CORPORATE"],"parameters":[{"name":"letterOfCreditId","in":"path","type":"string","required":true,"description":"Identifier of the Letter Of Credit"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"advisingBankIds":[{}],"beneficiaryAddresses":[{}],"documentsRequired":[{}],"additionalConditions":[{}],"charges":[{}],"lcCurrency":"string","lcAmount":0.0,"issueDate":"2024-01-01","beneficiaryId":"string","lcLiabilityAmountOutStanding":"string","pendingAmendMovement":"string","debitTolerance":"string","creditTolerance":"string","advisingBankReference":"string","increaseOrDecreaseAmount":0.0}},"responses":{"200":"AmendmentSeekingBeneficiaryConsentResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"POST","path":"/holdings/letterOfCredits/{letterOfCreditId}/imports/decisions","fullPath":"/api/v4.0.0/holdings/letterOfCredits/{letterOfCreditId}/imports/decisions","operationId":"updateDecisionOnAmendment","name":"Updates the decision on amendments to import letter of credit for the specified letter of credit/customer reference number","summary":"Updates decision on amendment to the import letter of credit","tags":["CORPORATE"],"parameters":[{"name":"letterOfCreditId","in":"path","type":"string","required":true,"description":"Identifier of the Letter Of Credit"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"additionalAmountsCovered":[{}],"limitReferences":[{}],"beneficiaries":[{}],"bankToBanks":[{}],"internalAmendmentDetails":[{}],"charges":[{}],"commissions":[{}],"amendmentNumber":"string","amendStatus":"string","sendAmendmentAdvice":"string","lcNumber":"string","advisingBankReference":"string","issueDate":"2024-01-01","lcType":"string","amendmentDate":"2024-01-01"}},"responses":{"200":"DecisionOnAmendmentResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"POST","path":"/holdings/letterOfCredits/{letterOfCreditId}/imports/cancellations","fullPath":"/api/v4.0.0/holdings/letterOfCredits/{letterOfCreditId}/imports/cancellations","operationId":"updateCancellationOfLC","name":"Updates the cancellation details of the issued import letter of credit for the specified letter of credit/customer reference number","summary":"Updates import letter of credit cancellation details","tags":["CORPORATE"],"parameters":[{"name":"letterOfCreditId","in":"path","type":"string","required":true,"description":"Identifier of the Letter Of Credit"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"limitReferences":[{}],"beneficiaries":[{}],"charges":[{}],"commissions":[{}],"lcNumber":"string","sendAmendmentAdvice":"string","lcType":"string","advisingBankReference":"string","applicantCustomer":"string","advisingBank":"string","issueDate":"string","newLcCurrency":"string","newLcAmount":"string","creditTolerance":"string","debitTolerance":"string"}},"responses":{"200":"CancellationOfLCResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"POST","path":"/holdings/letterOfCredits/{letterOfCreditId}/exports/decisions","fullPath":"/api/v4.0.0/holdings/letterOfCredits/{letterOfCreditId}/exports/decisions","operationId":"updateDecisionOnExportLCAmendment","name":"Updates the decision on amendments to export letter of credit for the specified letter of credit/customer reference number","summary":"Updates decision on amendment to the export letter of credit","tags":["CORPORATE"],"parameters":[{"name":"letterOfCreditId","in":"path","type":"string","required":true,"description":"Identifier of the Letter Of Credit"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"beneficiaries":[{}],"shipmentPeriods":[{}],"internalAmendmentDetails":[{}],"charges":[{}],"amendmentNumber":"string","lcType":"string","amendStatus":"string","applicantCustomer":"string","lcNumber":"string","sendAmendmentAdvice":"string","issuingBankReference":"string","issueDate":"string","issuingBankId":"string","lcCurrency":"string","lcAmount":"string"}},"responses":{"200":"DecisionOnExportLCAmendmentResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"POST","path":"/holdings/letterOfCredits/{letterOfCreditId}/exports/cancellations","fullPath":"/api/v4.0.0/holdings/letterOfCredits/{letterOfCreditId}/exports/cancellations","operationId":"updateCancellationOfExportLC","name":"Updates the cancellation details of the issued export letter of credit for the specified letter of credit/customer reference number","summary":"Updates export letter of credit cancellation details ","tags":["CORPORATE"],"parameters":[{"name":"letterOfCreditId","in":"path","type":"string","required":true,"description":""},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"applicants":[{}],"additionalAmountsCovered":[{}],"beneficiaries":[{}],"charges":[{}],"lcNumber":"string","sendAmendmentAdvice":"string","lcType":"string","issuingBankReference":"string","issuingBankId":"string","lcIssueDate":"string","newLcCurrency":"string","newLcAmount":"string","creditTolerance":"string","debitTolerance":"string","purposeOfMessage":"string"}},"responses":{"200":"CancellationOfExportLCResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/holdings/customers/{customerId}/letterOfCredits/imports/outstandings","fullPath":"/api/v4.0.0/holdings/customers/{customerId}/letterOfCredits/imports/outstandings","operationId":"getImportLcsOutstanding","name":"Retrieves the details of outstanding import letter of credits for the specified customer/guarantee reference.","summary":"Retrieves outstanding import letter of credit details","tags":["CORPORATE"],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"Identifier of the customer"},{"name":"transactionReference","in":"query","type":"string","required":false,"description":"Contains the identifier for the transaction in the core system"},{"name":"lcCurrency","in":"query","type":"string","required":false,"description":"Denote the currency of the Letter of Credit."},{"name":"advisingBank","in":"query","type":"string","required":false,"description":"Identifies the advising bank under the Letter of Credit, through whom the Letter of Credit is to be advised to the second advising bank or beneficiary"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"ImportLcsOutstandingResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/customers/{customerId}/letterOfCredits/imports/expiries","fullPath":"/api/v4.0.0/holdings/customers/{customerId}/letterOfCredits/imports/expiries","operationId":"getImportLcsExpiringButOutstanding","name":"Retrieves the expired import letter of credit details for the specified customer/guarantee reference.","summary":"Retrieves expired import letter of credit details","tags":["CORPORATE"],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":""},{"name":"transactionReference","in":"query","type":"string","required":false,"description":"Contains the identifier for the transaction in the core system"},{"name":"applicantCustomer","in":"query","type":"string","required":false,"description":"Indicates the applicant ID on whose behalf the Letter of Credit is issued."},{"name":"lcCurrency","in":"query","type":"string","required":false,"description":"Denote the currency of the Letter of Credit."},{"name":"advisingBank","in":"query","type":"string","required":false,"description":"Identifies the advising bank under the Letter of Credit, through whom the Letter of Credit is to be advised to the second advising bank or beneficiary"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"ImportLcsExpiringButOutstandingResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/letterOfCredits/{letterOfCreditId}/exports/outstandings","fullPath":"/api/v4.0.0/holdings/letterOfCredits/{letterOfCreditId}/exports/outstandings","operationId":"getExportlcsOutstanding","name":"Retrieves the details of outstanding export letter of credits for the specified customer/guarantee reference.","summary":"Retrieves outstanding export letter of credit details","tags":["CORPORATE"],"parameters":[{"name":"letterOfCreditId","in":"path","type":"string","required":true,"description":""},{"name":"transactionReference","in":"query","type":"string","required":false,"description":"Contains the identifier for the transaction in the core system"},{"name":"issuingBankId","in":"query","type":"string","required":false,"description":"Identifies the Issuing bank ID under the LC, who issues the LC under when a bank is advising the Letter of Credit"},{"name":"lcCurrency","in":"query","type":"string","required":false,"description":"Denote the currency of the Letter of Credit."},{"name":"lcAmount","in":"query","type":"string","required":false,"description":"This field indicates the amount of the Letter of Credit that will always be expressed in the currency of Letter of Credit."},{"name":"beneficiaryCustomerId","in":"query","type":"string","required":false,"description":"Identifies the Customer who is to be the ultimate receiver of the funds transferred by the sending bank when this Beneficiary is not a bank."},{"name":"expiryDate","in":"query","type":"string","required":false,"description":"This indicates the  date  on which the offer or privilege terminates for the event."},{"name":"liabilityReversalDate","in":"query","type":"string","required":false,"description":"Date on which the contingent entries and the limits raised on the LC will be reversed."},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"ExportlcsOutstandingResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"PUT","path":"/holdings/letterOfCredits/{letterOfCreditId}/outwardCollections/amendments","fullPath":"/api/v4.0.0/holdings/letterOfCredits/{letterOfCreditId}/outwardCollections/amendments","operationId":"amendOutwardCollections","name":"Amendments to outward collection contracts are implemented by revising the contract with updated values","summary":"Updates the outward collections","tags":["CORPORATE"],"parameters":[{"name":"letterOfCreditId","in":"path","type":"string","required":true,"description":"Identifier of the Letter Of Credit"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"applicantNames":[{}],"advisingBanks":[{}],"beneficiaryDetails":[{}],"availableWithDetails":[{}],"additionalAmountsCovered":[{}],"deferredPayments":[{}],"contactDetails":[{}],"shipmentPeriods":[{}],"presentationPeriods":[{}],"descriptionOfGoods":[{}],"documentCodes":[{}],"documentDetails":[{}],"documentsRequired":[{}],"clausesDetails":[{}],"additionalConditions":[{}]}},"responses":{"200":"OutwardCollectionsResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/holdings/letterOfCredits/outwardCollections/outstandings","fullPath":"/api/v4.0.0/holdings/letterOfCredits/outwardCollections/outstandings","operationId":"getOutwardCollectionsOutstanding","name":"Retrieves the outstanding details of outward collections","summary":"Retrieves the outstanding details of outward collections","tags":["CORPORATE"],"parameters":[{"name":"collectionReference","in":"query","type":"string","required":true,"description":"The ID of the Letter of Credit, to be linked to this Guarantee for the purpose of apportioning the Margin"},{"name":"beneficiaryCustomerId","in":"query","type":"string","required":false,"description":"Identifies the Customer who is to be the ultimate receiver of the funds transferred by the sending bank when this Beneficiary is not a bank."},{"name":"currencyId","in":"query","type":"string","required":false,"description":"Identifier of the currency. This is the 3-letter ISO 4217 code of the currency."},{"name":"days","in":"query","type":"string","required":false,"description":"Valid for Documentary Collections and used in conjunction with the field TENOR to indicate the tenor of the drafts under the collection. It is used in the production of corresponding documentary colle"},{"name":"tenor","in":"query","type":"string","required":false,"description":"This field is valid for Documentary Collections only. It is used in conjunction with the following field 'DAYS' or 'COLL.MAT.CODE' to indicate the TENOR of the drafts under the collection and is used "},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"OutwardCollectionsOutstandingResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"POST","path":"/holdings/letterOfCredits/drawings/{drawingId}/documents","fullPath":"/api/v4.0.0/holdings/letterOfCredits/drawings/{drawingId}/documents","operationId":"createDrawingDocument","name":"Initiate the registration of a presentation done for letter of credit transaction","summary":"Initiate a new drawing request to register the documents for letter of credit","tags":["CORPORATE"],"parameters":[{"name":"drawingId","in":"path","type":"string","required":true,"description":"Identifier of drawings application under the Letter of Credit system that is used to effect the transfer of funds and the acceptance of documents under Letters of Credit and Documentary Collection tra"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"addresses":[{}],"presentorCustomerId":"string","referenceId":"string","currencyId":"string","documentAmount":0.0,"creditAccountId":"string","debitAccountId":"string","paymentMethod":"string","nextReviewDate":"2024-01-01","days":"string","documentReceived":"string","maturityReview":"string","extensions":{}}},"responses":{"200":"DrawingDocumentResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/holdings/letterOfCredits/drawings","fullPath":"/api/v4.0.0/holdings/letterOfCredits/drawings","operationId":"getDrawingsDetails","name":"Retrieves the list of drawings for specific customer","summary":"Retrieve drawing details","tags":["CORPORATE"],"parameters":[{"name":"lcType","in":"query","type":"string","required":false,"description":"Indicates the type of LC, whether this is an Import/Export, Confirmed/Unconfirmed/Revolving/Transferrable/Back to Back LC/documentary collection/Clean collection etc."},{"name":"applicantCustomer","in":"query","type":"string","required":false,"description":"Indicates the applicant ID on whose behalf the Letter of Credit is issued."},{"name":"drawingId","in":"query","type":"string","required":false,"description":"Identifier of drawings application under the Letter of Credit system that is used to effect the transfer of funds and the acceptance of documents under Letters of Credit and Documentary Collection tra"},{"name":"drawingType","in":"query","type":"string","required":false,"description":"This field is correlated to the other field payment type and identifies the Draw type under Letter of credit. Whether its a sight LC payment, acceptance, deferred payment or Mixed payment."},{"name":"currencyId","in":"query","type":"string","required":false,"description":"Identifier of the currency. This is the 3-letter ISO 4217 code of the currency."},{"name":"creditType","in":"query","type":"string","required":false,"description":"Contains the credit line type. Possible values are 'Available' and 'Credit'."},{"name":"documentAmount","in":"query","type":"string","required":false,"description":"This field contains the amount to be drawn under this transaction, expressed in the currency above (DRAW.CURRENCY)."},{"name":"referenceId","in":"query","type":"string","required":false,"description":"Reference Identifier of the Derivatives Trade "},{"name":"recordStatus","in":"query","type":"string","required":false,"description":"General status of the record. Possible values: - null - authorised - IHLD - input, on hold - INAU - input, not authorised - INA2 - input, authorised, pending second authorisation - INAO - input, not a"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"DrawingsDetailsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"POST","path":"/holdings/letterOfCredits/initiations","fullPath":"/api/v4.0.0/holdings/letterOfCredits/initiations","operationId":"createLetterOfCreditInitiation","name":"Initiate a new letter of credit request for specific customer","summary":"Creates letter of credit request","tags":["CORPORATE"],"parameters":[{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"applicantAddresses":[{}],"advisingBanks":[{}],"beneficiaries":[{}],"availableWithBanks":[{}],"additionalAmountsCovered":[{}],"deferredPayments":[{}],"contactDetails":[{}],"shipmentPeriods":[{}],"presentationPeriods":[{}],"descriptionsOfGoods":[{}],"documentCodes":[{}],"documentDetails":[{}],"documentsRequired":[{}],"additionalConditions":[{}],"narrativeCharges":[{}]}},"responses":{"200":"LetterOfCreditInitiationResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/holdings/letterOfCredits/{letterOfCreditId}/exports","fullPath":"/api/v4.0.0/holdings/letterOfCredits/{letterOfCreditId}/exports","operationId":"updateExportLetterOfCredit","name":"Update a new export letter of credit for specific customer","summary":"Update export letter of credit","tags":["CORPORATE"],"parameters":[{"name":"letterOfCreditId","in":"path","type":"string","required":true,"description":"Identifier of the Letter Of Credit"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"applicants":[{}],"advisingBanks":[{}],"beneficiaries":[{}],"additionalInformations":[{}],"additionalAmountsCovered":[{}],"deferredPayments":[{}],"contactDetails":[{}],"shipmentPeriods":[{}],"presentationPeriods":[{}],"descriptionOfGoods":[{}],"documentDetails":[{}],"documentsRequired":[{}],"clausesDetails":[{}],"additionalConditions":[{}],"narrativeCharges":[{}]}},"responses":{"200":"ExportLetterOfCreditResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/holdings/letterOfCredits/drawings/bills/negotiations","fullPath":"/api/v4.0.0/holdings/letterOfCredits/drawings/bills/negotiations","operationId":"getDrawingsNegotiationBills","name":"Retrieves the negotiated/discounted bills under the letter of credit","summary":"Retrieves the negotiated/discounted bills for drawings","tags":["CORPORATE"],"parameters":[{"name":"maturityReview","in":"query","type":"string","required":false,"description":"This field contains the date on which Acceptance/Deferred Payment drawings will mature, or Letter of Credit Collection drawings will be due for chasing."},{"name":"drawingType","in":"query","type":"string","required":false,"description":"This field is correlated to the other field payment type and identifies the Draw type under Letter of credit. Whether its a sight LC payment, acceptance, deferred payment or Mixed payment."},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"DrawingsNegotiationBillsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/letterOfCredits/drawings/bills/outstandings","fullPath":"/api/v4.0.0/holdings/letterOfCredits/drawings/bills/outstandings","operationId":"getDrawingsOutstandingBills","name":"Retrieves outstanding documents such as bills under the letter of credit","summary":"Retrieves the outstanding bills for drawings","tags":["CORPORATE"],"parameters":[{"name":"maturityReview","in":"query","type":"string","required":false,"description":"This field contains the date on which Acceptance/Deferred Payment drawings will mature, or Letter of Credit Collection drawings will be due for chasing."},{"name":"drawingType","in":"query","type":"string","required":false,"description":"This field is correlated to the other field payment type and identifies the Draw type under Letter of credit. Whether its a sight LC payment, acceptance, deferred payment or Mixed payment."},{"name":"presentorCustomerId","in":"query","type":"string","required":true,"description":"This field is used to identify the presentor of the documents if they are not a customer of the bank with a valid CUSTOMER.NO.Optionally input, identifies the presentor customer."},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"DrawingsOutstandingBillsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"PUT","path":"/holdings/letterOfCredits/{letterOfCreditId}/outwardCollections","fullPath":"/api/v4.0.0/holdings/letterOfCredits/{letterOfCreditId}/outwardCollections","operationId":"updateOutwardCollections","name":"Updates the amendments to the outward collection for the specified letter of credit/customer reference number","summary":"Updates the outward collection details","tags":["CORPORATE"],"parameters":[{"name":"letterOfCreditId","in":"path","type":"string","required":true,"description":"Identifier of the Letter Of Credit"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"applicantCustomerNames":[{}],"advisingBanks":[{}],"beneficiaryCustomerNames":[{}],"availableWithDetails":[{}],"additionalAmountsCovered":[{}],"deferredPayments":[{}],"contactDetails":[{}],"shipmentPeriods":[{}],"presentationPeriods":[{}],"descriptionOfGoods":[{}],"documentDetails":[{}],"documentsRequired":[{}],"clausesDetails":[{}],"additionalConditions":[{}],"narrativeCharges":[{}]}},"responses":{"200":"OutwardCollectionsResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/holdings/letterOfCredits/{letterOfCreditId}/inwardCollections","fullPath":"/api/v4.0.0/holdings/letterOfCredits/{letterOfCreditId}/inwardCollections","operationId":"updateInwardCollections","name":"Updates the amendments to the inward collection for the specified letter of credit/customer reference number","summary":"Updates the inward collection details","tags":["CORPORATE"],"parameters":[{"name":"letterOfCreditId","in":"path","type":"string","required":true,"description":"Identifier of the Letter Of Credit"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"inward":[{}],"applicantAddresses":[{}],"advisingBanks":[{}],"beneficiaries":[{}],"guaranteeReferences":[{}],"documents":[{}],"additionalConditions":[{}],"instructions":[{}],"bankToBanks":[{}],"invoiceReferences":[{}],"transportation":[{}],"charges":[{}],"chargeCodes":[{}],"extensions":{}}},"responses":{"200":"InwardCollectionsResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}}]},{"key":"holdings-letterOfCredit-service-v5.0.0","title":"Management of Letter of Credits","version":"v5.0.0","description":"API to create, update and manage various types of trade finance letter of credit (LC) instruments and their associated status and details. Some of the types of LCs that can be created are sight payments, back-to-back, standby's and usance LCs","endpointCount":83,"endpoints":[{"method":"POST","path":"/holdings/letterOfCredits/drawingsInitiation/{drawingId}","fullPath":"/api/v5.0.0/holdings/letterOfCredits/drawingsInitiation/{drawingId}","operationId":"createDrawings","name":"Initiate a new drawing request for a specific letter of credit","summary":"Initiate a new drawing request to check the documents for letter of credit","tags":["CORPORATE"],"parameters":[{"name":"drawingId","in":"path","type":"string","required":true,"description":"Identifier of drawings application under the Letter of Credit system that is used to effect the transfer of funds and the acceptance of documents under Letters of Credit and Documentary Collection tra"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"addresses":[{}],"documentStatus":[{}],"clausesTexts":[{}],"invoiceDocuments":[{}],"transportDocuments":[{}],"documents":[{}],"discrepancyDetails":[{}],"presentorCustomerId":"string","referenceId":"string","currencyId":"string","documentAmount":0.0,"paymentMethod":"string","debitAccountId":"string","creditAccountId":"string","nextReviewDate":"2024-01-01"}},"responses":{"200":"DrawingsResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"POST","path":"/holdings/letterOfCredits/drawings/{drawingId}/initiations","fullPath":"/api/v5.0.0/holdings/letterOfCredits/drawings/{drawingId}/initiations","operationId":"createDrawing","name":"Initiate a new drawing request registerered  for a specific letter of credit","summary":"Initiate a new drawing request to check the documents for letter of credit","tags":["CORPORATE"],"parameters":[{"name":"drawingId","in":"path","type":"string","required":true,"description":"Identifier of drawings application under the Letter of Credit system that is used to effect the transfer of funds and the acceptance of documents under Letters of Credit and Documentary Collection tra"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"addresses":[{}],"documentStatus":[{}],"clausesTexts":[{}],"invoiceDocuments":[{}],"transportDocuments":[{}],"documents":[{}],"discrepancyDetails":[{}],"presentorCustomerId":"string","referenceId":"string","currencyId":"string","documentAmount":0.0,"paymentMethod":"string","debitAccountId":"string","creditAccountId":"string","nextReviewDate":"2024-01-01"}},"responses":{"200":"DrawingResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/holdings/letterOfCredits/drawings/{drawingId}","fullPath":"/api/v5.0.0/holdings/letterOfCredits/drawings/{drawingId}","operationId":"getDrawing","name":"Retrieve the details of specific drawing that is created against a letter of credit","summary":"Retrieve the drawing requests for a specific letter of credit","tags":["CORPORATE"],"parameters":[{"name":"drawingId","in":"path","type":"string","required":true,"description":"Identifier of drawings application under the Letter of Credit system that is used to effect the transfer of funds and the acceptance of documents under Letters of Credit and Documentary Collection tra"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"DrawingResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/holdings/letterOfCredits/drawings/{drawingId}","fullPath":"/api/v5.0.0/holdings/letterOfCredits/drawings/{drawingId}","operationId":"updateDrawing","name":"Update an existing drawing for a specific letter of credit","summary":"Update drawing details","tags":["CORPORATE"],"parameters":[{"name":"drawingId","in":"path","type":"string","required":true,"description":"Identifier of drawings application under the Letter of Credit system that is used to effect the transfer of funds and the acceptance of documents under Letters of Credit and Documentary Collection tra"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"addresses":[{}],"documentStatus":[{}],"clausesTexts":[{}],"invoiceDocuments":[{}],"transportDocuments":[{}],"documents":[{}],"discrepancyDetails":[{}],"presentorCustomerId":"string","referenceId":"string","documentAmount":0.0,"paymentMethod":"string","debitAccountId":"string","creditAccountId":"string","nextReviewDate":"2024-01-01","valueDate":"2024-01-01"}},"responses":{"200":"DrawingResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"DELETE","path":"/holdings/letterOfCredits/drawings/{drawingId}","fullPath":"/api/v5.0.0/holdings/letterOfCredits/drawings/{drawingId}","operationId":"deleteDrawing","name":"Remove an existing drawing for a specific letter of credit","summary":"Remove drawing details","tags":["CORPORATE"],"parameters":[{"name":"drawingId","in":"path","type":"string","required":true,"description":"Identifier of drawings application under the Letter of Credit system that is used to effect the transfer of funds and the acceptance of documents under Letters of Credit and Documentary Collection tra"},{"name":"payload","in":"body","type":"object","required":false,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}}},"responses":{"200":"DrawingResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/holdings/letterOfCredits/drawingsApprovals/{drawingId}","fullPath":"/api/v5.0.0/holdings/letterOfCredits/drawingsApprovals/{drawingId}","operationId":"approveDrawing","name":"Approve a drawing  for specific letter of credit","summary":"Approve drawing ","tags":["CORPORATE"],"parameters":[{"name":"drawingId","in":"path","type":"string","required":true,"description":"Identifier of drawings application under the Letter of Credit system that is used to effect the transfer of funds and the acceptance of documents under Letters of Credit and Documentary Collection tra"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"DrawingResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/holdings/letterOfCredits/documents/{documentId}","fullPath":"/api/v5.0.0/holdings/letterOfCredits/documents/{documentId}","operationId":"getLcDocument","name":"Retrieves the details of specific letter of credit advice text","summary":"Overview details of letter of credit advice text","tags":["CORPORATE"],"parameters":[{"name":"documentId","in":"path","type":"string","required":true,"description":"Based on documentCode, the field defaults the required document codes"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"LcDocumentResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"POST","path":"/holdings/letterOfCredits/documents/{documentId}","fullPath":"/api/v5.0.0/holdings/letterOfCredits/documents/{documentId}","operationId":"createLcDocument","name":"Create a new letter of credit advice text","summary":"Create letter of credit advice text","tags":["CORPORATE"],"parameters":[{"name":"documentId","in":"path","type":"string","required":true,"description":"Based on documentCode, the field defaults the required document codes"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"documentDetails":[{}],"extensions":{}}},"responses":{"200":"LcDocumentResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/holdings/letterOfCredits/documents/{documentId}","fullPath":"/api/v5.0.0/holdings/letterOfCredits/documents/{documentId}","operationId":"updateLcDocument","name":"Update an existing letter of credit advice text","summary":"Update letter of credit advice text","tags":["CORPORATE"],"parameters":[{"name":"documentId","in":"path","type":"string","required":true,"description":"Based on documentCode, the field defaults the required document codes"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"documentDetails":[{}],"extensions":{}}},"responses":{"200":"LcDocumentResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"DELETE","path":"/holdings/letterOfCredits/documents/{documentId}","fullPath":"/api/v5.0.0/holdings/letterOfCredits/documents/{documentId}","operationId":"deleteLcDocument","name":"Delete an existing letter of credit advice text","summary":"Delete letter of credit advice text","tags":["CORPORATE"],"parameters":[{"name":"documentId","in":"path","type":"string","required":true,"description":"Based on documentCode, the field defaults the required document codes"},{"name":"payload","in":"body","type":"object","required":false,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}}},"responses":{"200":"LcDocumentResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"POST","path":"/holdings/letterOfCredits/{letterOfCreditId}/amendmentsInitiation","fullPath":"/api/v5.0.0/holdings/letterOfCredits/{letterOfCreditId}/amendmentsInitiation","operationId":"createLcAmendments","name":"Initiate a new letter of credit amendment","summary":"Initiate letter of credit amendment","tags":["CORPORATE"],"parameters":[{"name":"letterOfCreditId","in":"path","type":"string","required":true,"description":"Identifier of the Letter Of Credit"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"ibLimitExceeds":[{}],"additionalAmountsCovered":[{}],"shipmentPeriods":[{}],"lcAmend":[{}],"messageFromCustomers":[{}],"messageFromBanks":[{}],"overrides":[{}],"lcAmount":0.0,"increaseDecreaseAmount":0.0,"decreaseCreditAmount":0.0,"increaseCreditAmount":0.0,"maximumCreditAmount":"string","newAdviceExpiryDate":"2024-01-01","shipmentDespatch":"string","otherDespatchDetails":"string"}},"responses":{"200":"LcAmendmentsResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"POST","path":"/holdings/letterOfCredits/{letterOfCreditId}/amendments/initiations","fullPath":"/api/v5.0.0/holdings/letterOfCredits/{letterOfCreditId}/amendments/initiations","operationId":"createLcAmendment","name":"Initiate a new letter of credit amendment","summary":"Initiate letter of credit amendment","tags":["CORPORATE"],"parameters":[{"name":"letterOfCreditId","in":"path","type":"string","required":true,"description":"Identifier of the Letter Of Credit"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"ibLimitExceeds":[{}],"additionalAmountsCovered":[{}],"shipmentPeriods":[{}],"lcAmend":[{}],"messageFromCustomers":[{}],"messageFromBanks":[{}],"overrides":[{}],"lcAmount":0.0,"increaseDecreaseAmount":0.0,"decreaseCreditAmount":0.0,"increaseCreditAmount":0.0,"maximumCreditAmount":"string","newAdviceExpiryDate":"2024-01-01","shipmentDespatch":"string","otherDespatchDetails":"string"}},"responses":{"200":"LcAmendmentResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/holdings/letterOfCredits/{letterOfCreditId}/amendments","fullPath":"/api/v5.0.0/holdings/letterOfCredits/{letterOfCreditId}/amendments","operationId":"getLCAmendments","name":"Retrieves the list of letter of credit amendment details","summary":"Retrieves the letter of credit amendments","tags":["CORPORATE"],"parameters":[{"name":"letterOfCreditId","in":"path","type":"string","required":true,"description":"Identifier of the Letter Of Credit"},{"name":"eventStatus","in":"query","type":"string","required":false,"description":"Specifies the status of the request.Allowed values are - With Bank_With Customer_Approved_Rejected."},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"LCAmendmentsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"PUT","path":"/holdings/letterOfCredits/{letterOfCreditId}/amendments","fullPath":"/api/v5.0.0/holdings/letterOfCredits/{letterOfCreditId}/amendments","operationId":"updateLcAmendment","name":"Update an existing amendment for specific letter of credit","summary":"Update letter of credit amendment","tags":["CORPORATE"],"parameters":[{"name":"letterOfCreditId","in":"path","type":"string","required":true,"description":"Identifier of the Letter Of Credit"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"ibLimitExceeds":[{}],"additionalAmountsCovered":[{}],"shipmentPeriods":[{}],"lcAmend":[{}],"messageFromCustomers":[{}],"messageFromBanks":[{}],"overrides":[{}],"lcAmount":0.0,"increaseDecreaseAmount":0.0,"decreaseCreditAmount":0.0,"increaseCreditAmount":0.0,"maximumCreditAmount":"string","newAdviceExpiryDate":"2024-01-01","shipmentDespatch":"string","otherDespatchDetails":"string"}},"responses":{"200":"LcAmendmentResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"DELETE","path":"/holdings/letterOfCredits/{letterOfCreditId}/amendments","fullPath":"/api/v5.0.0/holdings/letterOfCredits/{letterOfCreditId}/amendments","operationId":"deleteLcAmendment","name":"Remove an existing letter of credit amendment","summary":"Remove letter of credit amendment","tags":["CORPORATE"],"parameters":[{"name":"letterOfCreditId","in":"path","type":"string","required":true,"description":"Identifier of the Letter Of Credit"},{"name":"payload","in":"body","type":"object","required":false,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}}},"responses":{"200":"LcAmendmentResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/holdings/letterOfCredits/{letterOfCreditId}/amendmentApprovals","fullPath":"/api/v5.0.0/holdings/letterOfCredits/{letterOfCreditId}/amendmentApprovals","operationId":"approveLcAmendments","name":"Approve an initiated letter of credit amendment ","summary":"Approve letter of credit amendment","tags":["CORPORATE"],"parameters":[{"name":"letterOfCreditId","in":"path","type":"string","required":true,"description":"Identifier of the Letter Of Credit"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"LcAmendmentsResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/holdings/letterOfCredits/{letterOfCreditId}/amendments/approvals","fullPath":"/api/v5.0.0/holdings/letterOfCredits/{letterOfCreditId}/amendments/approvals","operationId":"approveLcAmendment","name":"Approve an initiated letter of credit amendment ","summary":"Approve letter of credit amendment","tags":["CORPORATE"],"parameters":[{"name":"letterOfCreditId","in":"path","type":"string","required":true,"description":"Identifier of the Letter Of Credit"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"LcAmendmentResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/holdings/letterOfCredits/clauses/{clausesId}","fullPath":"/api/v5.0.0/holdings/letterOfCredits/clauses/{clausesId}","operationId":"getLcClause","name":"Retrieves the details of specific letter of credit clause","summary":"Overview details of letter of credit clause","tags":["CORPORATE"],"parameters":[{"name":"clausesId","in":"path","type":"string","required":true,"description":"This is the key to the LC.CLAUSES file.During the input of an L/C this code can be entered for the inclusion of standard clauses."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"LcClauseResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"POST","path":"/holdings/letterOfCredits/clauses/{clausesId}","fullPath":"/api/v5.0.0/holdings/letterOfCredits/clauses/{clausesId}","operationId":"createLcClause","name":"Create a new letter of credit clause","summary":"Create a static narrative information for letter of credit","tags":["CORPORATE"],"parameters":[{"name":"clausesId","in":"path","type":"string","required":true,"description":"This is the key to the LC.CLAUSES file.During the input of an L/C this code can be entered for the inclusion of standard clauses."},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"narratives":[{}],"lcClausesName":"string","extensions":{}}},"responses":{"200":"LcClauseResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/holdings/letterOfCredits/clauses/{clausesId}","fullPath":"/api/v5.0.0/holdings/letterOfCredits/clauses/{clausesId}","operationId":"updateLcClause","name":"Update an existing letter of credit clause","summary":"Update a static narrative information for letter of credit","tags":["CORPORATE"],"parameters":[{"name":"clausesId","in":"path","type":"string","required":true,"description":"This is the key to the LC.CLAUSES file.During the input of an L/C this code can be entered for the inclusion of standard clauses."},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"narratives":[{}],"lcClausesName":"string","extensions":{}}},"responses":{"200":"LcClauseResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"DELETE","path":"/holdings/letterOfCredits/clauses/{clausesId}","fullPath":"/api/v5.0.0/holdings/letterOfCredits/clauses/{clausesId}","operationId":"deleteLcClause","name":"Remove an existing letter of credit clause","summary":"Remove a static narrative information for letter of credit","tags":["CORPORATE"],"parameters":[{"name":"clausesId","in":"path","type":"string","required":true,"description":"This is the key to the LC.CLAUSES file.During the input of an L/C this code can be entered for the inclusion of standard clauses."},{"name":"payload","in":"body","type":"object","required":false,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}}},"responses":{"200":"LcClauseResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/holdings/letterOfCredits/{letterOfCreditId}/drawings","fullPath":"/api/v5.0.0/holdings/letterOfCredits/{letterOfCreditId}/drawings","operationId":"getDrawings","name":"Retrieves the list of drawings for specific customer","summary":"Retrieve drawing details","tags":["CORPORATE"],"parameters":[{"name":"letterOfCreditId","in":"path","type":"string","required":true,"description":"Identifier of the Letter Of Credit"},{"name":"eventStatus","in":"query","type":"string","required":false,"description":"Specifies the status of the request.Allowed values are - With Bank_With Customer_Approved_Rejected."},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"DrawingsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/customers/{customerId}/letterOfCredits/documents","fullPath":"/api/v5.0.0/holdings/customers/{customerId}/letterOfCredits/documents","operationId":"getLCDocuments","name":"Retrieves the list of letter of credit advice text details","summary":"Retrieves the letter of credit advice text details","tags":["CORPORATE"],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"Identifier of the customer"},{"name":"lcAdviceTextId","in":"query","type":"string","required":false,"description":"This is the key to the letter of credit advice text file.During the input of an L/C this code can be entered for the inclusion of standard text."},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"LCDocumentsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/customers/{customerId}/letterOfCredits/clauses","fullPath":"/api/v5.0.0/holdings/customers/{customerId}/letterOfCredits/clauses","operationId":"getLCClauses","name":"Retrieves the list of narrative static information data for use in the mapping and construction of L/C advices/documents generated as a result of L/C transactions within the Transact delivery application","summary":"Retrieves the letter of credit clause details","tags":["CORPORATE"],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"Identifier of the customer"},{"name":"lcClausesId","in":"query","type":"string","required":false,"description":"This is the key to the LC.CLAUSES file.During the input of an L/C this code can be entered for the inclusion of standard clauses."},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"LCClausesResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/letterOfCredits/incoTerms","fullPath":"/api/v5.0.0/holdings/letterOfCredits/incoTerms","operationId":"getIncoTerms","name":"Retrieves the list of letter of credit enrichment text details","summary":"Retrieves letter of credit enrichments","tags":["CORPORATE"],"parameters":[{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"IncoTermsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/letterOfCredits","fullPath":"/api/v5.0.0/holdings/letterOfCredits","operationId":"getLetterOfCredits","name":"Retrieves the list of letter of credits for specific customer","summary":"Retrieves letter of credit details","tags":["CORPORATE"],"parameters":[{"name":"letterOfCreditId","in":"query","type":"string","required":false,"description":"Identifier of the Letter Of Credit"},{"name":"customerId","in":"query","type":"string","required":false,"description":"Identifier of the customer"},{"name":"operation","in":"query","type":"string","required":false,"description":"Identifies the required operation to be executed for a Trade Finance contract. Input of valid codes as: O for opening of LC, P for Pre-advise of LC, A for Amend LC, C for Collect Charges, D for Decisi"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"LetterOfCreditsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/letterOfCredits/exports/drawings","fullPath":"/api/v5.0.0/holdings/letterOfCredits/exports/drawings","operationId":"getExportDrawings","name":"Retrieves the list of export letter of credit drawings for specific customer","summary":"Retrieves export letter of credit drawings","tags":["CORPORATE"],"parameters":[{"name":"customerId","in":"query","type":"string","required":false,"description":"Identifier of the customer"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"ExportDrawingsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/letterOfCredits/exports/amendments","fullPath":"/api/v5.0.0/holdings/letterOfCredits/exports/amendments","operationId":"getExportLCAmendments","name":"Retrieves the list of export letter of credit amendments for specific customer","summary":"Retrieves export letter of credit amendments","tags":["CORPORATE"],"parameters":[{"name":"customerId","in":"query","type":"string","required":false,"description":"Identifier of the customer"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"ExportLCAmendmentsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/letterOfCredits/exports","fullPath":"/api/v5.0.0/holdings/letterOfCredits/exports","operationId":"getRegisteredExportLc","name":"Retrieves the list of export letter of credits registered for specific customer","summary":"Retrieves registered export letter of credits","tags":["CORPORATE"],"parameters":[{"name":"adviceExpiryDate","in":"query","type":"string","required":false,"description":"Specifies the actual expiry date of Guarantee."},{"name":"transactionReference","in":"query","type":"string","required":true,"description":"Contains the identifier for the transaction in the core system"},{"name":"issuingBankId","in":"query","type":"string","required":false,"description":"Identifies the Issuing bank ID under the LC, who issues the LC under when a bank is advising the Letter of Credit"},{"name":"lcCurrency","in":"query","type":"string","required":false,"description":"Denote the currency of the Letter of Credit."},{"name":"lcAmount","in":"query","type":"string","required":false,"description":"This field indicates the amount of the Letter of Credit that will always be expressed in the currency of Letter of Credit."},{"name":"beneficiaryCustomerId","in":"query","type":"string","required":false,"description":"Identifies the Customer who is to be the ultimate receiver of the funds transferred by the sending bank when this Beneficiary is not a bank."},{"name":"liabilityReversalDate","in":"query","type":"string","required":false,"description":"Date on which the contingent entries and the limits raised on the LC will be reversed."},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"RegisteredExportLcResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"POST","path":"/holdings/letterOfCredits/exports","fullPath":"/api/v5.0.0/holdings/letterOfCredits/exports","operationId":"createExportLetterOfCredit","name":"Create a new export letter of credit for specific customer","summary":"Create export letter of credit","tags":["CORPORATE"],"parameters":[{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"applicants":[{}],"advisingBanks":[{}],"beneficiaries":[{}],"additionalInformations":[{}],"additionalAmountsCovered":[{}],"deferredPayments":[{}],"contactDetails":[{}],"shipmentPeriods":[{}],"presentationPeriods":[{}],"descriptionOfGoods":[{}],"documentDetails":[{}],"documentsRequired":[{}],"clausesDetails":[{}],"additionalConditions":[{}],"narrativeCharges":[{}]}},"responses":{"200":"ExportLetterOfCreditResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/holdings/letterOfCredits/imports/drawings","fullPath":"/api/v5.0.0/holdings/letterOfCredits/imports/drawings","operationId":"getImportDrawings","name":"Retrieves the list of import letter of credit drawings for specific customer","summary":"Retrieves import letter of credit drawings","tags":["CORPORATE"],"parameters":[{"name":"customerId","in":"query","type":"string","required":false,"description":"Identifier of the customer"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"ImportDrawingsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/letterOfCredits/imports/amendments","fullPath":"/api/v5.0.0/holdings/letterOfCredits/imports/amendments","operationId":"getImportLCAmendments","name":"Retrieves the list of import letter of credit amendments for specific customer","summary":"Retrieves import letter of credit amendments","tags":["CORPORATE"],"parameters":[{"name":"customerId","in":"query","type":"string","required":false,"description":"Identifier of the customer"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"ImportLCAmendmentsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/letterOfCredits/imports","fullPath":"/api/v5.0.0/holdings/letterOfCredits/imports","operationId":"getImportLc","name":"Retrieves the list of import letter of credits for specific customer","summary":"Retrieves import letter of credits","tags":["CORPORATE"],"parameters":[{"name":"customerId","in":"query","type":"string","required":false,"description":"Identifier of the customer"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"ImportLcResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/letterOfCredits/outwardCollections/documents","fullPath":"/api/v5.0.0/holdings/letterOfCredits/outwardCollections/documents","operationId":"getOutwardCollectionDocuments","name":"Retrieves the list of outward collections document codes for specific customer","summary":"Retrieves the outward collection document codes","tags":["CORPORATE"],"parameters":[{"name":"lcAdviceTextId","in":"query","type":"string","required":false,"description":"This is the key to the letter of credit advice text file.During the input of an L/C this code can be entered for the inclusion of standard text."},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"OutwardCollectionDocumentsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/letterOfCredits/inwardCollections/amendments","fullPath":"/api/v5.0.0/holdings/letterOfCredits/inwardCollections/amendments","operationId":"getInwardCollectionsAmendments","name":"Retrieves the list of inward collection amendments for specific customer","summary":"Retrieves the inward collection amendments","tags":["CORPORATE"],"parameters":[{"name":"customerId","in":"query","type":"string","required":false,"description":"Identifier of the customer"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"InwardCollectionsAmendmentsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/letterOfCredits/inwardCollections","fullPath":"/api/v5.0.0/holdings/letterOfCredits/inwardCollections","operationId":"getInwardCollections","name":"Retrieves the list of inward collections for specific customer","summary":"Retrieves the inward collections","tags":["CORPORATE"],"parameters":[{"name":"customerId","in":"query","type":"string","required":false,"description":"Identifier of the customer"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"InwardCollectionsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"POST","path":"/holdings/letterOfCredits/inwardCollections","fullPath":"/api/v5.0.0/holdings/letterOfCredits/inwardCollections","operationId":"createInwardCollection","name":"Lodgment of the Import documentary collection by the collecting bank ","summary":"Creates a new inward documentary collection","tags":["CORPORATE"],"parameters":[{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"inward":[{}],"applicantAddresses":[{}],"advisingBanks":[{}],"beneficiaries":[{}],"guaranteeReferences":[{}],"documents":[{}],"additionalConditions":[{}],"instructions":[{}],"bankToBanks":[{}],"invoiceReferences":[{}],"transportation":[{}],"charges":[{}],"chargeCodes":[{}],"extensions":{}}},"responses":{"200":"InwardCollectionResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/holdings/letterOfCredits/tenors","fullPath":"/api/v5.0.0/holdings/letterOfCredits/tenors","operationId":"getLcTenors","name":"Retrieves the list of letter of credit tenor details","summary":"Retrieves letter of credit tenor details","tags":["CORPORATE"],"parameters":[{"name":"lcPayTypeId","in":"query","type":"string","required":false,"description":"Indicates the identifier of payment type enrichment for letter of credit."},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"LcTenorsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/letterOfCredits/outwardCollections/amendments","fullPath":"/api/v5.0.0/holdings/letterOfCredits/outwardCollections/amendments","operationId":"getOutwardCollectionAmdendments","name":"Retrieves the list of outward collection amendments for specific customer","summary":"Retrieves outward collection amendments","tags":["CORPORATE"],"parameters":[{"name":"customerId","in":"query","type":"string","required":false,"description":"Identifier of the customer"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"OutwardCollectionAmdendmentsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/letterOfCredits/outwardCollections","fullPath":"/api/v5.0.0/holdings/letterOfCredits/outwardCollections","operationId":"getOutwardCollections","name":"Retrieves the outstanding details of outward collections","summary":"Retrieves the outward collection amendments","tags":["CORPORATE"],"parameters":[{"name":"customerId","in":"query","type":"string","required":false,"description":"Identifier of the customer"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"OutwardCollectionsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"POST","path":"/holdings/letterOfCredits/outwardCollections","fullPath":"/api/v5.0.0/holdings/letterOfCredits/outwardCollections","operationId":"createOutwardCollections","name":"Initiation of the export documentary collection by the collecting bank","summary":"Creates the outward collections","tags":["CORPORATE"],"parameters":[{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"beneficiaryDetails":[{}],"issuingBankNames":[{}],"applicantNames":[{}],"documentCodes":[{}],"additionalConditions":[{}],"instructionDetails":[{}],"bankToBanks":[{}],"deliveryInstructions":[{}],"chargeCodes":[{}],"avalisationDetails":[{}],"externalReference":"string","beneficiaryCustomerId":"string","beneficiaryAccountId":"string","currencyId":"string","issueDate":"string"}},"responses":{"200":"OutwardCollectionsResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/holdings/letterOfCredits/limits","fullPath":"/api/v5.0.0/holdings/letterOfCredits/limits","operationId":"getLcLimits","name":"Retrieves the list of letter of credit limit details","summary":"Retrieves the letter of credit limits","tags":["CORPORATE"],"parameters":[{"name":"customerId","in":"query","type":"string","required":false,"description":"Identifier of the customer"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"LcLimitsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"DELETE","path":"/holdings/letterOfCredits/drawings/{drawingId}/cancellations/","fullPath":"/api/v5.0.0/holdings/letterOfCredits/drawings/{drawingId}/cancellations/","operationId":"rejectDrawing","name":"Cancel an initiated drawing for letter of credit","summary":"Cancel initiated drawing","tags":["CORPORATE"],"parameters":[{"name":"drawingId","in":"path","type":"string","required":true,"description":"Identifier of drawings application under the Letter of Credit system that is used to effect the transfer of funds and the acceptance of documents under Letters of Credit and Documentary Collection tra"},{"name":"payload","in":"body","type":"object","required":false,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}}},"responses":{"200":"DrawingResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"DELETE","path":"/holdings/letterOfCredits/{letterOfCreditId}/amendments/cancellations","fullPath":"/api/v5.0.0/holdings/letterOfCredits/{letterOfCreditId}/amendments/cancellations","operationId":"rejectLcAmendment","name":"Cancel an initiated letter of credit amendment","summary":"Cancel letter of credit amendment","tags":["CORPORATE"],"parameters":[{"name":"letterOfCreditId","in":"path","type":"string","required":true,"description":"Identifier of the Letter Of Credit"},{"name":"payload","in":"body","type":"object","required":false,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}}},"responses":{"200":"LcAmendmentResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/holdings/letterOfCredits/ApprovedOutwardCollections","fullPath":"/api/v5.0.0/holdings/letterOfCredits/ApprovedOutwardCollections","operationId":"getApprovedOutwardCollections","name":"Retrieve the list of approved outward collections for specific customer","summary":"Retrieve approved outward collections","tags":["CORPORATE"],"parameters":[{"name":"collectionId","in":"query","type":"string","required":false,"description":"Identifier of collection id"},{"name":"beneficiaryCustomerId","in":"query","type":"string","required":false,"description":"Identifies the Customer who is to be the ultimate receiver of the funds transferred by the sending bank when this Beneficiary is not a bank."},{"name":"ibStatus","in":"query","type":"string","required":false,"description":"Field to indicate the status of LC request through internet banking."},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"ApprovedOutwardCollectionsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/letterOfCredits/{lcAmendmentId}/amendment","fullPath":"/api/v5.0.0/holdings/letterOfCredits/{lcAmendmentId}/amendment","operationId":"getLcAmendment","name":"Retrieve the details of specific letter of credit amendment details","summary":"Overview details of letter of credit amendment","tags":["CORPORATE"],"parameters":[{"name":"lcAmendmentId","in":"path","type":"string","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"LcAmendmentResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"POST","path":"/holdings/letterOfCreditsInitiation","fullPath":"/api/v5.0.0/holdings/letterOfCreditsInitiation","operationId":"createLetterOfCredit","name":"Initiate a new letter of credit request for specific customer","summary":"Create letter of credit request","tags":["CORPORATE"],"parameters":[{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"applicantCustomerNames":[{}],"advisingBanks":[{}],"beneficiaryCustomerNames":[{}],"availableWithDetails":[{}],"additionalAmountsCovered":[{}],"deferredPayments":[{}],"contactDetails":[{}],"shipmentPeriods":[{}],"presentationPeriods":[{}],"descriptionOfGoods":[{}],"documentDetails":[{}],"documentsRequired":[{}],"clausesDetails":[{}],"additionalConditions":[{}],"narrativeCharges":[{}]}},"responses":{"200":"LetterOfCreditResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/holdings/letterOfCredit/{letterOfCreditId}","fullPath":"/api/v5.0.0/holdings/letterOfCredit/{letterOfCreditId}","operationId":"updateLetterOfCredits","name":"Update an existing letter of credit for specific customer","summary":"Update letter of credit","tags":["CORPORATE"],"parameters":[{"name":"letterOfCreditId","in":"path","type":"string","required":true,"description":"Identifier of the Letter Of Credit"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"applicantCustomerNames":[{}],"advisingBanks":[{}],"beneficiaryCustomerNames":[{}],"availableWithDetails":[{}],"additionalAmountsCovered":[{}],"deferredPayments":[{}],"contactDetails":[{}],"shipmentPeriods":[{}],"presentationPeriods":[{}],"descriptionOfGoods":[{}],"documentDetails":[{}],"documentsRequired":[{}],"clausesDetails":[{}],"additionalConditions":[{}],"narrativeCharges":[{}]}},"responses":{"200":"LetterOfCreditsResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/holdings/letterOfCredits/{letterOfCreditId}","fullPath":"/api/v5.0.0/holdings/letterOfCredits/{letterOfCreditId}","operationId":"getLetterOfCredit","name":"Retrieves the details of specific letter of credit","summary":"Retrieves the details of letter of credit","tags":["CORPORATE"],"parameters":[{"name":"letterOfCreditId","in":"path","type":"string","required":true,"description":"Identifier of the Letter Of Credit"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"LetterOfCreditResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"POST","path":"/holdings/letterOfCredits/{letterOfCreditId}","fullPath":"/api/v5.0.0/holdings/letterOfCredits/{letterOfCreditId}","operationId":"updateExternalAmendmentToAnLC","name":"Updates the  amendments to the letter of credit for the specified letter of credit/customer reference number","summary":"Updates letter of credit details","tags":["CORPORATE"],"parameters":[{"name":"letterOfCreditId","in":"path","type":"string","required":true,"description":""},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"additionalAmountsCovered":[{}],"amendmentInformations":[{}],"beneficiaries":[{}],"narrativeCharges":[{}],"reimbursingBankAndAddresses":[{}],"bankToBanks":[{}],"charges":[{}],"chargeCodes":[{}],"commissionDetails":[{}],"margins":[{}],"issuingBankNames":[{}],"applicantAddresses":[{}],"availableWithBanks":[{}],"draftsAt":[{}],"drawees":[{}]}},"responses":{"200":"ExternalAmendmentToAnLCResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/holdings/letterOfCredits/{letterOfCreditId}","fullPath":"/api/v5.0.0/holdings/letterOfCredits/{letterOfCreditId}","operationId":"updateLetterOfCredit","name":"Updates the letter of credit initiation for the specified letter of credit/customer reference number","summary":"Updates letter of credit details","tags":["CORPORATE"],"parameters":[{"name":"letterOfCreditId","in":"path","type":"string","required":true,"description":"Identifier of the Letter Of Credit"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"applicantAddresses":[{}],"advisingBanks":[{}],"beneficiaries":[{}],"availableWithBanks":[{}],"additionalAmountsCovered":[{}],"deferredPayments":[{}],"contactDetails":[{}],"shipmentPeriods":[{}],"presentationPeriods":[{}],"descriptionsOfGoods":[{}],"documentCodes":[{}],"documentDetails":[{}],"documentsRequired":[{}],"additionalConditions":[{}],"narrativeCharges":[{}]}},"responses":{"200":"LetterOfCreditResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"DELETE","path":"/holdings/letterOfCredits/{letterOfCreditId}","fullPath":"/api/v5.0.0/holdings/letterOfCredits/{letterOfCreditId}","operationId":"deleteLetterOfCredit","name":"Remove an existing letter of credit for specific customer","summary":"Remove letter of credit","tags":["CORPORATE"],"parameters":[{"name":"letterOfCreditId","in":"path","type":"string","required":true,"description":"Identifier of the Letter Of Credit"},{"name":"payload","in":"body","type":"object","required":false,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}}},"responses":{"200":"LetterOfCreditResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/holdings/letterOfCredits/letterOfCreditApprovals/{letterOfCreditId}","fullPath":"/api/v5.0.0/holdings/letterOfCredits/letterOfCreditApprovals/{letterOfCreditId}","operationId":"approveLetterOfCredit","name":"Approve an initiated letter of credit request for specific customer","summary":"Approve letter of credit request","tags":["CORPORATE"],"parameters":[{"name":"letterOfCreditId","in":"path","type":"string","required":true,"description":"Identifier of the Letter Of Credit"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"LetterOfCreditResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"DELETE","path":"/holdings/letterOfCredits/cancellations/{letterOfCreditId}","fullPath":"/api/v5.0.0/holdings/letterOfCredits/cancellations/{letterOfCreditId}","operationId":"rejectLetterOfCredit","name":"Cancel an initiated letter of credit request for specific customer","summary":"Cancel letter of credit request","tags":["CORPORATE"],"parameters":[{"name":"letterOfCreditId","in":"path","type":"string","required":true,"description":"Identifier of the Letter Of Credit"},{"name":"payload","in":"body","type":"object","required":false,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}}},"responses":{"200":"LetterOfCreditResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"POST","path":"/holdings/letterOfCredit/exports","fullPath":"/api/v5.0.0/holdings/letterOfCredit/exports","operationId":"createExportLetterOfCredits","name":"Create a new export letter of credit for specific customer","summary":"Create export letter of credit","tags":["CORPORATE"],"parameters":[{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"applicantCustomerNames":[{}],"advisingBanks":[{}],"beneficiaryCustomerNames":[{}],"availableWithDetails":[{}],"additionalAmountsCovered":[{}],"deferredPayments":[{}],"contactDetails":[{}],"shipmentPeriods":[{}],"presentationPeriods":[{}],"descriptionOfGoods":[{}],"documentDetails":[{}],"documentsRequired":[{}],"clausesDetails":[{}],"additionalConditions":[{}],"narrativeCharges":[{}]}},"responses":{"200":"ExportLetterOfCreditsResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/holdings/letterOfCredit/{letterOfCreditId}/exports","fullPath":"/api/v5.0.0/holdings/letterOfCredit/{letterOfCreditId}/exports","operationId":"updateExportLetterOfCredits","name":"Update a new export letter of credit for specific customer","summary":"Update export letter of credit","tags":["CORPORATE"],"parameters":[{"name":"letterOfCreditId","in":"path","type":"string","required":true,"description":"Identifier of the Letter Of Credit"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"applicantCustomerNames":[{}],"advisingBanks":[{}],"beneficiaryCustomerNames":[{}],"availableWithDetails":[{}],"additionalAmountsCovered":[{}],"deferredPayments":[{}],"contactDetails":[{}],"shipmentPeriods":[{}],"presentationPeriods":[{}],"descriptionOfGoods":[{}],"documentDetails":[{}],"documentsRequired":[{}],"clausesDetails":[{}],"additionalConditions":[{}],"narrativeCharges":[{}]}},"responses":{"200":"ExportLetterOfCreditsResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"POST","path":"/holdings/letterOfCredits/sightPayments","fullPath":"/api/v5.0.0/holdings/letterOfCredits/sightPayments","operationId":"createIssuanceOfSightPaymentLC","name":"Creates sight payment letter of credit for the requested customer reference number","summary":"Create sight payment letter of credit","tags":["CORPORATE"],"parameters":[{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"applicantAddresses":[{}],"beneficiaryAddresses":[{}],"advisingBankAddresses":[{}],"adviseThroughBanks":[{}],"availableWithBanks":[{}],"reimbursingBanks1":[{}],"requestedConfirmBankNames":[{}],"charges":[{}],"importSightPmtLcType":"string","lcNumber":"string","applicant":"string","lcCurrency":"string","lcAmount":0.0,"creditTolerance":"string","debitTolerance":"string"}},"responses":{"200":"IssuanceOfSightPaymentLCResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"POST","path":"/holdings/letterOfCredits/usances","fullPath":"/api/v5.0.0/holdings/letterOfCredits/usances","operationId":"createIssuanceOfUsanceLC","name":"Creates usance letter of credit for the requested customer reference number","summary":"Create usance letter of credit","tags":["CORPORATE"],"parameters":[{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"applicantAddresses":[{}],"limitReferences":[{}],"beneficiaryAddresses":[{}],"advisingBankAddresses":[{}],"adviseThroughBanks":[{}],"availableWithBanks":[{}],"reimbursingBanks1":[{}],"requestedConfirmBankNames":[{}],"charges":[{}],"importUsanceLCType":"string","lcNumber":"string","applicant":"string","currency":"string","amount":0.0,"creditTolerance":"string"}},"responses":{"200":"IssuanceOfUsanceLCResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"POST","path":"/holdings/letterOfCredits/negotiations","fullPath":"/api/v5.0.0/holdings/letterOfCredits/negotiations","operationId":"createIssuanceOfNegotiationLC","name":"Creates negotiation letter of credit for the requested customer reference number","summary":"Create negotiation letter of credit","tags":["CORPORATE"],"parameters":[{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"applicantAddresses":[{}],"beneficiaryAddresses":[{}],"advisingBankAddresses":[{}],"adviseThroughBanks":[{}],"availableWithBanks":[{}],"reimbursingBanks1":[{}],"requestedConfirmBankNames":[{}],"charges":[{}],"importNegotiationLCType":"string","lcNumber":"string","applicant":"string","lcCurrency":"string","lcAmount":"string","creditTolerance":"string","debitTolerance":"string"}},"responses":{"200":"IssuanceOfNegotiationLCResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"POST","path":"/holdings/letterOfCredits/mixedPayments","fullPath":"/api/v5.0.0/holdings/letterOfCredits/mixedPayments","operationId":"createIssuanceOfMixedPaymentLC","name":"Creates mixed payment letter of credit for the requested customer reference number","summary":"Create mixed payment letter of credit","tags":["CORPORATE"],"parameters":[{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"applicantAddresses":[{}],"beneficiaryAddresses":[{}],"advisingBankAddresses":[{}],"adviseThroughBanks":[{}],"availableWithBanks":[{}],"reimbursingBanks1":[{}],"requestedConfirmBankNames":[{}],"charges":[{}],"drawings":[{}],"importMixedPmtLCType":"string","lcNumber":"string","applicantCustomer":"string","lcCurrency":"string","lcAmount":"string","creditTolerance":"string"}},"responses":{"200":"IssuanceOfMixedPaymentLCResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"POST","path":"/holdings/letterOfCredits/standbys","fullPath":"/api/v5.0.0/holdings/letterOfCredits/standbys","operationId":"createIssuanceOfStandbyLC","name":"Creates standby letter of credit for the requested customer reference number","summary":"Create standby letter of credit","tags":["CORPORATE"],"parameters":[{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"applicantAddresses":[{}],"limitReferences":[{}],"beneficiaryAddresses":[{}],"advisingBankAddresses":[{}],"adviseThroughBanks":[{}],"availableWithBanks":[{}],"reimbursingBanks1":[{}],"requestedConfirmBankNames":[{}],"charges":[{}],"importLCType":"string","lcNumber":"string","applicantCustomer":"string","lcCurrency":"string","lcAmount":0.0,"creditTolerance":"string"}},"responses":{"200":"IssuanceOfStandbyLCResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"POST","path":"/holdings/letterOfCredits/imports/preAdvises","fullPath":"/api/v5.0.0/holdings/letterOfCredits/imports/preAdvises","operationId":"createIssuanceOfPreAdviseImportLC","name":"Creates a pre-advice import letter of credit request.","summary":"Creates pre-advice letter of credit","tags":["CORPORATE"],"parameters":[{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"applicantAddresses":[{}],"limitReferences":[{}],"beneficiaryAddresses":[{}],"advisingBankAddresses":[{}],"adviseThroughBanks":[{}],"availableWithBanks":[{}],"reimbursingBanks1":[{}],"requestedConfirmBankNames":[{}],"charges":[{}],"lcNumber":"string","lcType":"string","applicant":"string","currency":"string","amount":0.0,"creditTolerance":"string"}},"responses":{"200":"IssuanceOfPreAdviseImportLCResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"POST","path":"/holdings/letterOfCredits/backToBacks","fullPath":"/api/v5.0.0/holdings/letterOfCredits/backToBacks","operationId":"createIssuanceOfBackToBackLC","name":"Creates back-to-back letter of credit for the requested customer reference number","summary":"Creates back-to-back letter of credit","tags":["CORPORATE"],"parameters":[{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"limitReferences":[{}],"beneficiaryAddresses":[{}],"applicantNames":[{}],"availableWithBanks":[{}],"adviseThroughBanks":[{}],"charges":[{}],"drawings":[{}],"accountWithBanks":[{}],"senderReceiversInfoMT730":[{}],"exportLCType":"string","backToBackLCRequired":"string","relatedImportLCReference":"string","advisingBankReference":"string","lcAdvisingReference":"string","issuingBankLCReference":"string"}},"responses":{"200":"IssuanceOfBackToBackLCResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"POST","path":"/holdings/letterOfCredits/transferables","fullPath":"/api/v5.0.0/holdings/letterOfCredits/transferables","operationId":"createIssuanceOfTransferableLC","name":"Creates transferable letter of credit for the requested customer reference number","summary":"Creates transferable letter of credit","tags":["CORPORATE"],"parameters":[{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"advisingBanks":[{}],"limitReferences":[{}],"drawings":[{}],"charges":[{}],"assignments":[{}],"secondBeneficiaries":[{}],"availableWithBanks":[{}],"draftsAt":[{}],"drawees":[{}],"mixedPaymentDetails":[{}],"negotiationDeferredPaymentDetails":[{}],"shipmentPeriods":[{}],"documentsRequired":[{}],"additionalConditions":[{}],"narrativeCharges":[{}]}},"responses":{"200":"IssuanceOfTransferableLCResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"POST","path":"/holdings/letterOfCredits/{letterOfCreditId}/beneficiaryConsents","fullPath":"/api/v5.0.0/holdings/letterOfCredits/{letterOfCreditId}/beneficiaryConsents","operationId":"updateAmendmentSeekingBeneficiaryConsent","name":"Updates letter of credit amendments seeking beneficiary's consent for the specified letter of credit/customer reference number","summary":"Updates letter of credit beneficiary's consent details","tags":["CORPORATE"],"parameters":[{"name":"letterOfCreditId","in":"path","type":"string","required":true,"description":"Identifier of the Letter Of Credit"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"advisingBankIds":[{}],"beneficiaryAddresses":[{}],"documentsRequired":[{}],"additionalConditions":[{}],"charges":[{}],"lcCurrency":"string","lcAmount":0.0,"issueDate":"2024-01-01","beneficiaryId":"string","lcLiabilityAmountOutStanding":"string","pendingAmendMovement":"string","debitTolerance":"string","creditTolerance":"string","advisingBankReference":"string","increaseOrDecreaseAmount":0.0}},"responses":{"200":"AmendmentSeekingBeneficiaryConsentResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"POST","path":"/holdings/letterOfCredits/{letterOfCreditId}/imports/decisions","fullPath":"/api/v5.0.0/holdings/letterOfCredits/{letterOfCreditId}/imports/decisions","operationId":"updateDecisionOnAmendment","name":"Updates the decision on amendments to import letter of credit for the specified letter of credit/customer reference number","summary":"Updates decision on amendment to the import letter of credit","tags":["CORPORATE"],"parameters":[{"name":"letterOfCreditId","in":"path","type":"string","required":true,"description":"Identifier of the Letter Of Credit"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"additionalAmountsCovered":[{}],"limitReferences":[{}],"beneficiaries":[{}],"bankToBanks":[{}],"internalAmendmentDetails":[{}],"charges":[{}],"commissions":[{}],"amendmentNumber":"string","amendStatus":"string","sendAmendmentAdvice":"string","lcNumber":"string","advisingBankReference":"string","issueDate":"2024-01-01","lcType":"string","amendmentDate":"2024-01-01"}},"responses":{"200":"DecisionOnAmendmentResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"POST","path":"/holdings/letterOfCredits/{letterOfCreditId}/imports/cancellations","fullPath":"/api/v5.0.0/holdings/letterOfCredits/{letterOfCreditId}/imports/cancellations","operationId":"updateCancellationOfLC","name":"Updates the cancellation details of the issued import letter of credit for the specified letter of credit/customer reference number","summary":"Updates import letter of credit cancellation details","tags":["CORPORATE"],"parameters":[{"name":"letterOfCreditId","in":"path","type":"string","required":true,"description":"Identifier of the Letter Of Credit"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"limitReferences":[{}],"beneficiaries":[{}],"charges":[{}],"commissions":[{}],"lcNumber":"string","sendAmendmentAdvice":"string","lcType":"string","advisingBankReference":"string","applicantCustomer":"string","advisingBank":"string","issueDate":"string","newLcCurrency":"string","newLcAmount":"string","creditTolerance":"string","debitTolerance":"string"}},"responses":{"200":"CancellationOfLCResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"POST","path":"/holdings/letterOfCredits/{letterOfCreditId}/exports/decisions","fullPath":"/api/v5.0.0/holdings/letterOfCredits/{letterOfCreditId}/exports/decisions","operationId":"updateDecisionOnExportLCAmendment","name":"Updates the decision on amendments to export letter of credit for the specified letter of credit/customer reference number","summary":"Updates decision on amendment to the export letter of credit","tags":["CORPORATE"],"parameters":[{"name":"letterOfCreditId","in":"path","type":"string","required":true,"description":"Identifier of the Letter Of Credit"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"beneficiaries":[{}],"shipmentPeriods":[{}],"internalAmendmentDetails":[{}],"charges":[{}],"amendmentNumber":"string","lcType":"string","amendStatus":"string","applicantCustomer":"string","lcNumber":"string","sendAmendmentAdvice":"string","issuingBankReference":"string","issueDate":"string","issuingBankId":"string","lcCurrency":"string","lcAmount":"string"}},"responses":{"200":"DecisionOnExportLCAmendmentResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"POST","path":"/holdings/letterOfCredits/{letterOfCreditId}/exports/cancellations","fullPath":"/api/v5.0.0/holdings/letterOfCredits/{letterOfCreditId}/exports/cancellations","operationId":"updateCancellationOfExportLC","name":"Updates the cancellation details of the issued export letter of credit for the specified letter of credit/customer reference number","summary":"Updates export letter of credit cancellation details ","tags":["CORPORATE"],"parameters":[{"name":"letterOfCreditId","in":"path","type":"string","required":true,"description":""},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"applicants":[{}],"additionalAmountsCovered":[{}],"beneficiaries":[{}],"charges":[{}],"lcNumber":"string","sendAmendmentAdvice":"string","lcType":"string","issuingBankReference":"string","issuingBankId":"string","lcIssueDate":"string","newLcCurrency":"string","newLcAmount":"string","creditTolerance":"string","debitTolerance":"string","purposeOfMessage":"string"}},"responses":{"200":"CancellationOfExportLCResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/holdings/customers/{customerId}/letterOfCredits/imports/outstandings","fullPath":"/api/v5.0.0/holdings/customers/{customerId}/letterOfCredits/imports/outstandings","operationId":"getImportLcsOutstanding","name":"Retrieves the details of outstanding import letter of credits for the specified customer/guarantee reference.","summary":"Retrieves outstanding import letter of credit details","tags":["CORPORATE"],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"Identifier of the customer"},{"name":"transactionReference","in":"query","type":"string","required":false,"description":"Contains the identifier for the transaction in the core system"},{"name":"lcCurrency","in":"query","type":"string","required":false,"description":"Denote the currency of the Letter of Credit."},{"name":"advisingBank","in":"query","type":"string","required":false,"description":"Identifies the advising bank under the Letter of Credit, through whom the Letter of Credit is to be advised to the second advising bank or beneficiary"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"ImportLcsOutstandingResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/customers/{customerId}/letterOfCredits/imports/expiries","fullPath":"/api/v5.0.0/holdings/customers/{customerId}/letterOfCredits/imports/expiries","operationId":"getImportLcsExpiringButOutstanding","name":"Retrieves the expired import letter of credit details for the specified customer/guarantee reference.","summary":"Retrieves expired import letter of credit details","tags":["CORPORATE"],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":""},{"name":"transactionReference","in":"query","type":"string","required":false,"description":"Contains the identifier for the transaction in the core system"},{"name":"applicantCustomer","in":"query","type":"string","required":false,"description":"Indicates the applicant ID on whose behalf the Letter of Credit is issued."},{"name":"lcCurrency","in":"query","type":"string","required":false,"description":"Denote the currency of the Letter of Credit."},{"name":"advisingBank","in":"query","type":"string","required":false,"description":"Identifies the advising bank under the Letter of Credit, through whom the Letter of Credit is to be advised to the second advising bank or beneficiary"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"ImportLcsExpiringButOutstandingResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/letterOfCredits/{letterOfCreditId}/exports/outstandings","fullPath":"/api/v5.0.0/holdings/letterOfCredits/{letterOfCreditId}/exports/outstandings","operationId":"getExportlcsOutstanding","name":"Retrieves the details of outstanding export letter of credits for the specified customer/guarantee reference.","summary":"Retrieves outstanding export letter of credit details","tags":["CORPORATE"],"parameters":[{"name":"letterOfCreditId","in":"path","type":"string","required":true,"description":""},{"name":"transactionReference","in":"query","type":"string","required":false,"description":"Contains the identifier for the transaction in the core system"},{"name":"issuingBankId","in":"query","type":"string","required":false,"description":"Identifies the Issuing bank ID under the LC, who issues the LC under when a bank is advising the Letter of Credit"},{"name":"lcCurrency","in":"query","type":"string","required":false,"description":"Denote the currency of the Letter of Credit."},{"name":"lcAmount","in":"query","type":"string","required":false,"description":"This field indicates the amount of the Letter of Credit that will always be expressed in the currency of Letter of Credit."},{"name":"beneficiaryCustomerId","in":"query","type":"string","required":false,"description":"Identifies the Customer who is to be the ultimate receiver of the funds transferred by the sending bank when this Beneficiary is not a bank."},{"name":"expiryDate","in":"query","type":"string","required":false,"description":"This indicates the  date  on which the offer or privilege terminates for the event."},{"name":"liabilityReversalDate","in":"query","type":"string","required":false,"description":"Date on which the contingent entries and the limits raised on the LC will be reversed."},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"ExportlcsOutstandingResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"PUT","path":"/holdings/letterOfCredits/{letterOfCreditId}/outwardCollections/amendments","fullPath":"/api/v5.0.0/holdings/letterOfCredits/{letterOfCreditId}/outwardCollections/amendments","operationId":"amendOutwardCollections","name":"Amendments to outward collection contracts are implemented by revising the contract with updated values","summary":"Updates the outward collections","tags":["CORPORATE"],"parameters":[{"name":"letterOfCreditId","in":"path","type":"string","required":true,"description":"Identifier of the Letter Of Credit"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"applicantNames":[{}],"advisingBanks":[{}],"beneficiaryDetails":[{}],"availableWithDetails":[{}],"additionalAmountsCovered":[{}],"deferredPayments":[{}],"contactDetails":[{}],"shipmentPeriods":[{}],"presentationPeriods":[{}],"descriptionOfGoods":[{}],"documentCodes":[{}],"documentDetails":[{}],"documentsRequired":[{}],"clausesDetails":[{}],"additionalConditions":[{}]}},"responses":{"200":"OutwardCollectionsResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/holdings/letterOfCredits/outwardCollections/outstandings","fullPath":"/api/v5.0.0/holdings/letterOfCredits/outwardCollections/outstandings","operationId":"getOutwardCollectionsOutstanding","name":"Retrieves the outstanding details of outward collections","summary":"Retrieves the outstanding details of outward collections","tags":["CORPORATE"],"parameters":[{"name":"collectionReference","in":"query","type":"string","required":true,"description":"The ID of the Letter of Credit, to be linked to this Guarantee for the purpose of apportioning the Margin"},{"name":"beneficiaryCustomerId","in":"query","type":"string","required":false,"description":"Identifies the Customer who is to be the ultimate receiver of the funds transferred by the sending bank when this Beneficiary is not a bank."},{"name":"currencyId","in":"query","type":"string","required":false,"description":"Identifier of the currency. This is the 3-letter ISO 4217 code of the currency."},{"name":"days","in":"query","type":"string","required":false,"description":"Valid for Documentary Collections and used in conjunction with the field TENOR to indicate the tenor of the drafts under the collection. It is used in the production of corresponding documentary colle"},{"name":"tenor","in":"query","type":"string","required":false,"description":"This field is valid for Documentary Collections only. It is used in conjunction with the following field 'DAYS' or 'COLL.MAT.CODE' to indicate the TENOR of the drafts under the collection and is used "},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"OutwardCollectionsOutstandingResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"POST","path":"/holdings/letterOfCredits/drawings/{drawingId}/documents","fullPath":"/api/v5.0.0/holdings/letterOfCredits/drawings/{drawingId}/documents","operationId":"createDrawingDocument","name":"Initiate the registration of a presentation done for letter of credit transaction","summary":"Initiate a new drawing request to register the documents for letter of credit","tags":["CORPORATE"],"parameters":[{"name":"drawingId","in":"path","type":"string","required":true,"description":"Identifier of drawings application under the Letter of Credit system that is used to effect the transfer of funds and the acceptance of documents under Letters of Credit and Documentary Collection tra"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"addresses":[{}],"presentorCustomerId":"string","referenceId":"string","currencyId":"string","documentAmount":0.0,"creditAccountId":"string","debitAccountId":"string","paymentMethod":"string","nextReviewDate":"2024-01-01","days":"string","documentReceived":"string","maturityReview":"string","extensions":{}}},"responses":{"200":"DrawingDocumentResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/holdings/letterOfCredits/drawings","fullPath":"/api/v5.0.0/holdings/letterOfCredits/drawings","operationId":"getDrawingsDetails","name":"Retrieves the list of drawings for specific customer","summary":"Retrieve drawing details","tags":["CORPORATE"],"parameters":[{"name":"lcType","in":"query","type":"string","required":false,"description":"Indicates the type of LC, whether this is an Import/Export, Confirmed/Unconfirmed/Revolving/Transferrable/Back to Back LC/documentary collection/Clean collection etc."},{"name":"applicantCustomer","in":"query","type":"string","required":false,"description":"Indicates the applicant ID on whose behalf the Letter of Credit is issued."},{"name":"drawingId","in":"query","type":"string","required":false,"description":"Identifier of drawings application under the Letter of Credit system that is used to effect the transfer of funds and the acceptance of documents under Letters of Credit and Documentary Collection tra"},{"name":"drawingType","in":"query","type":"string","required":false,"description":"This field is correlated to the other field payment type and identifies the Draw type under Letter of credit. Whether its a sight LC payment, acceptance, deferred payment or Mixed payment."},{"name":"currencyId","in":"query","type":"string","required":false,"description":"Identifier of the currency. This is the 3-letter ISO 4217 code of the currency."},{"name":"creditType","in":"query","type":"string","required":false,"description":"Contains the credit line type. Possible values are 'Available' and 'Credit'."},{"name":"documentAmount","in":"query","type":"string","required":false,"description":"This field contains the amount to be drawn under this transaction, expressed in the currency above (DRAW.CURRENCY)."},{"name":"referenceId","in":"query","type":"string","required":false,"description":"Reference Identifier of the Derivatives Trade "},{"name":"recordStatus","in":"query","type":"string","required":false,"description":"General status of the record. Possible values: - null - authorised - IHLD - input, on hold - INAU - input, not authorised - INA2 - input, authorised, pending second authorisation - INAO - input, not a"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"DrawingsDetailsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"POST","path":"/holdings/letterOfCredits/initiations","fullPath":"/api/v5.0.0/holdings/letterOfCredits/initiations","operationId":"createLetterOfCreditInitiation","name":"Initiate a new letter of credit request for specific customer","summary":"Creates letter of credit request","tags":["CORPORATE"],"parameters":[{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"applicantAddresses":[{}],"advisingBanks":[{}],"beneficiaries":[{}],"availableWithBanks":[{}],"additionalAmountsCovered":[{}],"deferredPayments":[{}],"contactDetails":[{}],"shipmentPeriods":[{}],"presentationPeriods":[{}],"descriptionsOfGoods":[{}],"documentCodes":[{}],"documentDetails":[{}],"documentsRequired":[{}],"additionalConditions":[{}],"narrativeCharges":[{}]}},"responses":{"200":"LetterOfCreditInitiationResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/holdings/letterOfCredits/{letterOfCreditId}/exports","fullPath":"/api/v5.0.0/holdings/letterOfCredits/{letterOfCreditId}/exports","operationId":"updateExportLetterOfCredit","name":"Update a new export letter of credit for specific customer","summary":"Update export letter of credit","tags":["CORPORATE"],"parameters":[{"name":"letterOfCreditId","in":"path","type":"string","required":true,"description":"Identifier of the Letter Of Credit"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"applicants":[{}],"advisingBanks":[{}],"beneficiaries":[{}],"additionalInformations":[{}],"additionalAmountsCovered":[{}],"deferredPayments":[{}],"contactDetails":[{}],"shipmentPeriods":[{}],"presentationPeriods":[{}],"descriptionOfGoods":[{}],"documentDetails":[{}],"documentsRequired":[{}],"clausesDetails":[{}],"additionalConditions":[{}],"narrativeCharges":[{}]}},"responses":{"200":"ExportLetterOfCreditResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/holdings/letterOfCredits/drawings/bills/negotiations","fullPath":"/api/v5.0.0/holdings/letterOfCredits/drawings/bills/negotiations","operationId":"getDrawingsNegotiationBills","name":"Retrieves the negotiated/discounted bills under the letter of credit","summary":"Retrieves the negotiated/discounted bills for drawings","tags":["CORPORATE"],"parameters":[{"name":"maturityReview","in":"query","type":"string","required":false,"description":"This field contains the date on which Acceptance/Deferred Payment drawings will mature, or Letter of Credit Collection drawings will be due for chasing."},{"name":"drawingType","in":"query","type":"string","required":false,"description":"This field is correlated to the other field payment type and identifies the Draw type under Letter of credit. Whether its a sight LC payment, acceptance, deferred payment or Mixed payment."},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"DrawingsNegotiationBillsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/letterOfCredits/drawings/bills/outstandings","fullPath":"/api/v5.0.0/holdings/letterOfCredits/drawings/bills/outstandings","operationId":"getDrawingsOutstandingBills","name":"Retrieves outstanding documents such as bills under the letter of credit","summary":"Retrieves the outstanding bills for drawings","tags":["CORPORATE"],"parameters":[{"name":"maturityReview","in":"query","type":"string","required":false,"description":"This field contains the date on which Acceptance/Deferred Payment drawings will mature, or Letter of Credit Collection drawings will be due for chasing."},{"name":"drawingType","in":"query","type":"string","required":false,"description":"This field is correlated to the other field payment type and identifies the Draw type under Letter of credit. Whether its a sight LC payment, acceptance, deferred payment or Mixed payment."},{"name":"presentorCustomerId","in":"query","type":"string","required":true,"description":"This field is used to identify the presentor of the documents if they are not a customer of the bank with a valid CUSTOMER.NO.Optionally input, identifies the presentor customer."},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"DrawingsOutstandingBillsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"PUT","path":"/holdings/letterOfCredits/{letterOfCreditId}/outwardCollections","fullPath":"/api/v5.0.0/holdings/letterOfCredits/{letterOfCreditId}/outwardCollections","operationId":"updateOutwardCollections","name":"Updates the amendments to the outward collection for the specified letter of credit/customer reference number","summary":"Updates the outward collection details","tags":["CORPORATE"],"parameters":[{"name":"letterOfCreditId","in":"path","type":"string","required":true,"description":"Identifier of the Letter Of Credit"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"applicantCustomerNames":[{}],"advisingBanks":[{}],"beneficiaryCustomerNames":[{}],"availableWithDetails":[{}],"additionalAmountsCovered":[{}],"deferredPayments":[{}],"contactDetails":[{}],"shipmentPeriods":[{}],"presentationPeriods":[{}],"descriptionOfGoods":[{}],"documentDetails":[{}],"documentsRequired":[{}],"clausesDetails":[{}],"additionalConditions":[{}],"narrativeCharges":[{}]}},"responses":{"200":"OutwardCollectionsResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/holdings/letterOfCredits/{letterOfCreditId}/inwardCollections","fullPath":"/api/v5.0.0/holdings/letterOfCredits/{letterOfCreditId}/inwardCollections","operationId":"updateInwardCollections","name":"Updates the amendments to the inward collection for the specified letter of credit/customer reference number","summary":"Updates the inward collection details","tags":["CORPORATE"],"parameters":[{"name":"letterOfCreditId","in":"path","type":"string","required":true,"description":"Identifier of the Letter Of Credit"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"inward":[{}],"applicantAddresses":[{}],"advisingBanks":[{}],"beneficiaries":[{}],"guaranteeReferences":[{}],"documents":[{}],"additionalConditions":[{}],"instructions":[{}],"bankToBanks":[{}],"invoiceReferences":[{}],"transportation":[{}],"charges":[{}],"chargeCodes":[{}],"extensions":{}}},"responses":{"200":"InwardCollectionsResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/holdings/letterOfCredits/exports/drawings/pendings","fullPath":"/api/v5.0.0/holdings/letterOfCredits/exports/drawings/pendings","operationId":"getPeningDrawingPresentation","name":"Retrieves the details of export drawings pending for presentation","summary":"Retrieves the export drawings pending for presentation","tags":["CORPORATE"],"parameters":[{"name":"drawingReference","in":"query","type":"string","required":false,"description":"The field stating the Drawing reference under the guarantee"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"PeningDrawingPresentationResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}}]},{"key":"holdings-letterOfCredit-service-v6.0.0","title":"Management of Letter of Credits","version":"v6.0.0","description":"API to create, update and manage various types of trade finance letter of credit (LC) instruments and their associated status and details. Some of the types of LCs that can be created are sight payments, back-to-back, standby's and usance LCs","endpointCount":83,"endpoints":[{"method":"POST","path":"/holdings/letterOfCredits/drawingsInitiation/{drawingId}","fullPath":"/api/v6.0.0/holdings/letterOfCredits/drawingsInitiation/{drawingId}","operationId":"createDrawings","name":"Initiate a new drawing request for a specific letter of credit","summary":"Initiate a new drawing request to check the documents for letter of credit","tags":["CORPORATE"],"parameters":[{"name":"drawingId","in":"path","type":"string","required":true,"description":"Identifier of drawings application under the Letter of Credit system that is used to effect the transfer of funds and the acceptance of documents under Letters of Credit and Documentary Collection tra"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"addresses":[{}],"documentStatus":[{}],"clausesTexts":[{}],"invoiceDocuments":[{}],"transportDocuments":[{}],"documents":[{}],"discrepancyDetails":[{}],"presentorCustomerId":"string","referenceId":"string","currencyId":"string","documentAmount":0.0,"paymentMethod":"string","debitAccountId":"string","creditAccountId":"string","nextReviewDate":"2024-01-01"}},"responses":{"200":"DrawingsResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"POST","path":"/holdings/letterOfCredits/drawings/{drawingId}/initiations","fullPath":"/api/v6.0.0/holdings/letterOfCredits/drawings/{drawingId}/initiations","operationId":"createDrawing","name":"Initiate a new drawing request registerered  for a specific letter of credit","summary":"Initiate a new drawing request to check the documents for letter of credit","tags":["CORPORATE"],"parameters":[{"name":"drawingId","in":"path","type":"string","required":true,"description":"Identifier of drawings application under the Letter of Credit system that is used to effect the transfer of funds and the acceptance of documents under Letters of Credit and Documentary Collection tra"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"addresses":[{}],"documentStatus":[{}],"clausesTexts":[{}],"invoiceDocuments":[{}],"transportDocuments":[{}],"documents":[{}],"discrepancyDetails":[{}],"presentorCustomerId":"string","referenceId":"string","currencyId":"string","documentAmount":0.0,"paymentMethod":"string","debitAccountId":"string","creditAccountId":"string","nextReviewDate":"2024-01-01"}},"responses":{"200":"DrawingResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/holdings/letterOfCredits/drawings/{drawingId}","fullPath":"/api/v6.0.0/holdings/letterOfCredits/drawings/{drawingId}","operationId":"getDrawing","name":"Retrieve the details of specific drawing that is created against a letter of credit","summary":"Retrieve the drawing requests for a specific letter of credit","tags":["CORPORATE"],"parameters":[{"name":"drawingId","in":"path","type":"string","required":true,"description":"Identifier of drawings application under the Letter of Credit system that is used to effect the transfer of funds and the acceptance of documents under Letters of Credit and Documentary Collection tra"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"DrawingResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/holdings/letterOfCredits/drawings/{drawingId}","fullPath":"/api/v6.0.0/holdings/letterOfCredits/drawings/{drawingId}","operationId":"updateDrawing","name":"Update an existing drawing for a specific letter of credit","summary":"Update drawing details","tags":["CORPORATE"],"parameters":[{"name":"drawingId","in":"path","type":"string","required":true,"description":"Identifier of drawings application under the Letter of Credit system that is used to effect the transfer of funds and the acceptance of documents under Letters of Credit and Documentary Collection tra"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"addresses":[{}],"documentStatus":[{}],"clausesTexts":[{}],"invoiceDocuments":[{}],"transportDocuments":[{}],"documents":[{}],"discrepancyDetails":[{}],"presentorCustomerId":"string","referenceId":"string","documentAmount":0.0,"paymentMethod":"string","debitAccountId":"string","creditAccountId":"string","nextReviewDate":"2024-01-01","valueDate":"2024-01-01"}},"responses":{"200":"DrawingResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"DELETE","path":"/holdings/letterOfCredits/drawings/{drawingId}","fullPath":"/api/v6.0.0/holdings/letterOfCredits/drawings/{drawingId}","operationId":"deleteDrawing","name":"Remove an existing drawing for a specific letter of credit","summary":"Remove drawing details","tags":["CORPORATE"],"parameters":[{"name":"drawingId","in":"path","type":"string","required":true,"description":"Identifier of drawings application under the Letter of Credit system that is used to effect the transfer of funds and the acceptance of documents under Letters of Credit and Documentary Collection tra"},{"name":"payload","in":"body","type":"object","required":false,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}}},"responses":{"200":"DrawingResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/holdings/letterOfCredits/drawingsApprovals/{drawingId}","fullPath":"/api/v6.0.0/holdings/letterOfCredits/drawingsApprovals/{drawingId}","operationId":"approveDrawing","name":"Approve a drawing  for specific letter of credit","summary":"Approve drawing ","tags":["CORPORATE"],"parameters":[{"name":"drawingId","in":"path","type":"string","required":true,"description":"Identifier of drawings application under the Letter of Credit system that is used to effect the transfer of funds and the acceptance of documents under Letters of Credit and Documentary Collection tra"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"DrawingResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/holdings/letterOfCredits/documents/{documentId}","fullPath":"/api/v6.0.0/holdings/letterOfCredits/documents/{documentId}","operationId":"getLcDocument","name":"Retrieves the details of specific letter of credit advice text","summary":"Overview details of letter of credit advice text","tags":["CORPORATE"],"parameters":[{"name":"documentId","in":"path","type":"string","required":true,"description":"Based on documentCode, the field defaults the required document codes"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"LcDocumentResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"POST","path":"/holdings/letterOfCredits/documents/{documentId}","fullPath":"/api/v6.0.0/holdings/letterOfCredits/documents/{documentId}","operationId":"createLcDocument","name":"Create a new letter of credit advice text","summary":"Create letter of credit advice text","tags":["CORPORATE"],"parameters":[{"name":"documentId","in":"path","type":"string","required":true,"description":"Based on documentCode, the field defaults the required document codes"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"documentDetails":[{}],"extensions":{}}},"responses":{"200":"LcDocumentResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/holdings/letterOfCredits/documents/{documentId}","fullPath":"/api/v6.0.0/holdings/letterOfCredits/documents/{documentId}","operationId":"updateLcDocument","name":"Update an existing letter of credit advice text","summary":"Update letter of credit advice text","tags":["CORPORATE"],"parameters":[{"name":"documentId","in":"path","type":"string","required":true,"description":"Based on documentCode, the field defaults the required document codes"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"documentDetails":[{}],"extensions":{}}},"responses":{"200":"LcDocumentResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"DELETE","path":"/holdings/letterOfCredits/documents/{documentId}","fullPath":"/api/v6.0.0/holdings/letterOfCredits/documents/{documentId}","operationId":"deleteLcDocument","name":"Delete an existing letter of credit advice text","summary":"Delete letter of credit advice text","tags":["CORPORATE"],"parameters":[{"name":"documentId","in":"path","type":"string","required":true,"description":"Based on documentCode, the field defaults the required document codes"},{"name":"payload","in":"body","type":"object","required":false,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}}},"responses":{"200":"LcDocumentResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"POST","path":"/holdings/letterOfCredits/{letterOfCreditId}/amendmentsInitiation","fullPath":"/api/v6.0.0/holdings/letterOfCredits/{letterOfCreditId}/amendmentsInitiation","operationId":"createLcAmendments","name":"Initiate a new letter of credit amendment","summary":"Initiate letter of credit amendment","tags":["CORPORATE"],"parameters":[{"name":"letterOfCreditId","in":"path","type":"string","required":true,"description":"Identifier of the Letter Of Credit"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"ibLimitExceeds":[{}],"additionalAmountsCovered":[{}],"shipmentPeriods":[{}],"lcAmend":[{}],"messageFromCustomers":[{}],"messageFromBanks":[{}],"overrides":[{}],"lcAmount":0.0,"increaseDecreaseAmount":0.0,"decreaseCreditAmount":0.0,"increaseCreditAmount":0.0,"maximumCreditAmount":"string","newAdviceExpiryDate":"2024-01-01","shipmentDespatch":"string","otherDespatchDetails":"string"}},"responses":{"200":"LcAmendmentsResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"POST","path":"/holdings/letterOfCredits/{letterOfCreditId}/amendments/initiations","fullPath":"/api/v6.0.0/holdings/letterOfCredits/{letterOfCreditId}/amendments/initiations","operationId":"createLcAmendment","name":"Initiate a new letter of credit amendment","summary":"Initiate letter of credit amendment","tags":["CORPORATE"],"parameters":[{"name":"letterOfCreditId","in":"path","type":"string","required":true,"description":"Identifier of the Letter Of Credit"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"ibLimitExceeds":[{}],"additionalAmountsCovered":[{}],"shipmentPeriods":[{}],"lcAmend":[{}],"messageFromCustomers":[{}],"messageFromBanks":[{}],"overrides":[{}],"lcAmount":0.0,"increaseDecreaseAmount":0.0,"decreaseCreditAmount":0.0,"increaseCreditAmount":0.0,"maximumCreditAmount":"string","newAdviceExpiryDate":"2024-01-01","shipmentDespatch":"string","otherDespatchDetails":"string"}},"responses":{"200":"LcAmendmentResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/holdings/letterOfCredits/{letterOfCreditId}/amendments","fullPath":"/api/v6.0.0/holdings/letterOfCredits/{letterOfCreditId}/amendments","operationId":"getLCAmendments","name":"Retrieves the list of letter of credit amendment details","summary":"Retrieves the letter of credit amendments","tags":["CORPORATE"],"parameters":[{"name":"letterOfCreditId","in":"path","type":"string","required":true,"description":"Identifier of the Letter Of Credit"},{"name":"eventStatus","in":"query","type":"string","required":false,"description":"Specifies the status of the request.Allowed values are - With Bank_With Customer_Approved_Rejected."},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"LCAmendmentsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"PUT","path":"/holdings/letterOfCredits/{letterOfCreditId}/amendments","fullPath":"/api/v6.0.0/holdings/letterOfCredits/{letterOfCreditId}/amendments","operationId":"updateLcAmendment","name":"Update an existing amendment for specific letter of credit","summary":"Update letter of credit amendment","tags":["CORPORATE"],"parameters":[{"name":"letterOfCreditId","in":"path","type":"string","required":true,"description":"Identifier of the Letter Of Credit"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"ibLimitExceeds":[{}],"additionalAmountsCovered":[{}],"shipmentPeriods":[{}],"lcAmend":[{}],"messageFromCustomers":[{}],"messageFromBanks":[{}],"overrides":[{}],"lcAmount":0.0,"increaseDecreaseAmount":0.0,"decreaseCreditAmount":0.0,"increaseCreditAmount":0.0,"maximumCreditAmount":"string","newAdviceExpiryDate":"2024-01-01","shipmentDespatch":"string","otherDespatchDetails":"string"}},"responses":{"200":"LcAmendmentResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"DELETE","path":"/holdings/letterOfCredits/{letterOfCreditId}/amendments","fullPath":"/api/v6.0.0/holdings/letterOfCredits/{letterOfCreditId}/amendments","operationId":"deleteLcAmendment","name":"Remove an existing letter of credit amendment","summary":"Remove letter of credit amendment","tags":["CORPORATE"],"parameters":[{"name":"letterOfCreditId","in":"path","type":"string","required":true,"description":"Identifier of the Letter Of Credit"},{"name":"payload","in":"body","type":"object","required":false,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}}},"responses":{"200":"LcAmendmentResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/holdings/letterOfCredits/{letterOfCreditId}/amendmentApprovals","fullPath":"/api/v6.0.0/holdings/letterOfCredits/{letterOfCreditId}/amendmentApprovals","operationId":"approveLcAmendments","name":"Approve an initiated letter of credit amendment ","summary":"Approve letter of credit amendment","tags":["CORPORATE"],"parameters":[{"name":"letterOfCreditId","in":"path","type":"string","required":true,"description":"Identifier of the Letter Of Credit"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"LcAmendmentsResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/holdings/letterOfCredits/{letterOfCreditId}/amendments/approvals","fullPath":"/api/v6.0.0/holdings/letterOfCredits/{letterOfCreditId}/amendments/approvals","operationId":"approveLcAmendment","name":"Approve an initiated letter of credit amendment ","summary":"Approve letter of credit amendment","tags":["CORPORATE"],"parameters":[{"name":"letterOfCreditId","in":"path","type":"string","required":true,"description":"Identifier of the Letter Of Credit"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"LcAmendmentResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/holdings/letterOfCredits/clauses/{clausesId}","fullPath":"/api/v6.0.0/holdings/letterOfCredits/clauses/{clausesId}","operationId":"getLcClause","name":"Retrieves the details of specific letter of credit clause","summary":"Overview details of letter of credit clause","tags":["CORPORATE"],"parameters":[{"name":"clausesId","in":"path","type":"string","required":true,"description":"This is the key to the LC.CLAUSES file.During the input of an L/C this code can be entered for the inclusion of standard clauses."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"LcClauseResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"POST","path":"/holdings/letterOfCredits/clauses/{clausesId}","fullPath":"/api/v6.0.0/holdings/letterOfCredits/clauses/{clausesId}","operationId":"createLcClause","name":"Create a new letter of credit clause","summary":"Create a static narrative information for letter of credit","tags":["CORPORATE"],"parameters":[{"name":"clausesId","in":"path","type":"string","required":true,"description":"This is the key to the LC.CLAUSES file.During the input of an L/C this code can be entered for the inclusion of standard clauses."},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"narratives":[{}],"lcClausesName":"string","extensions":{}}},"responses":{"200":"LcClauseResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/holdings/letterOfCredits/clauses/{clausesId}","fullPath":"/api/v6.0.0/holdings/letterOfCredits/clauses/{clausesId}","operationId":"updateLcClause","name":"Update an existing letter of credit clause","summary":"Update a static narrative information for letter of credit","tags":["CORPORATE"],"parameters":[{"name":"clausesId","in":"path","type":"string","required":true,"description":"This is the key to the LC.CLAUSES file.During the input of an L/C this code can be entered for the inclusion of standard clauses."},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"narratives":[{}],"lcClausesName":"string","extensions":{}}},"responses":{"200":"LcClauseResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"DELETE","path":"/holdings/letterOfCredits/clauses/{clausesId}","fullPath":"/api/v6.0.0/holdings/letterOfCredits/clauses/{clausesId}","operationId":"deleteLcClause","name":"Remove an existing letter of credit clause","summary":"Remove a static narrative information for letter of credit","tags":["CORPORATE"],"parameters":[{"name":"clausesId","in":"path","type":"string","required":true,"description":"This is the key to the LC.CLAUSES file.During the input of an L/C this code can be entered for the inclusion of standard clauses."},{"name":"payload","in":"body","type":"object","required":false,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}}},"responses":{"200":"LcClauseResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/holdings/letterOfCredits/{letterOfCreditId}/drawings","fullPath":"/api/v6.0.0/holdings/letterOfCredits/{letterOfCreditId}/drawings","operationId":"getDrawings","name":"Retrieves the list of drawings for specific customer","summary":"Retrieve drawing details","tags":["CORPORATE"],"parameters":[{"name":"letterOfCreditId","in":"path","type":"string","required":true,"description":"Identifier of the Letter Of Credit"},{"name":"eventStatus","in":"query","type":"string","required":false,"description":"Specifies the status of the request.Allowed values are - With Bank_With Customer_Approved_Rejected."},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"DrawingsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/customers/{customerId}/letterOfCredits/documents","fullPath":"/api/v6.0.0/holdings/customers/{customerId}/letterOfCredits/documents","operationId":"getLCDocuments","name":"Retrieves the list of letter of credit advice text details","summary":"Retrieves the letter of credit advice text details","tags":["CORPORATE"],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"Identifier of the customer"},{"name":"lcAdviceTextId","in":"query","type":"string","required":false,"description":"This is the key to the letter of credit advice text file.During the input of an L/C this code can be entered for the inclusion of standard text."},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"LCDocumentsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/customers/{customerId}/letterOfCredits/clauses","fullPath":"/api/v6.0.0/holdings/customers/{customerId}/letterOfCredits/clauses","operationId":"getLCClauses","name":"Retrieves the list of narrative static information data for use in the mapping and construction of L/C advices/documents generated as a result of L/C transactions within the Transact delivery application","summary":"Retrieves the letter of credit clause details","tags":["CORPORATE"],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"Identifier of the customer"},{"name":"lcClausesId","in":"query","type":"string","required":false,"description":"This is the key to the LC.CLAUSES file.During the input of an L/C this code can be entered for the inclusion of standard clauses."},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"LCClausesResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/letterOfCredits/incoTerms","fullPath":"/api/v6.0.0/holdings/letterOfCredits/incoTerms","operationId":"getIncoTerms","name":"Retrieves the list of letter of credit enrichment text details","summary":"Retrieves letter of credit enrichments","tags":["CORPORATE"],"parameters":[{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"IncoTermsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/letterOfCredits","fullPath":"/api/v6.0.0/holdings/letterOfCredits","operationId":"getLetterOfCredits","name":"Retrieves the list of letter of credits for specific customer","summary":"Retrieves letter of credit details","tags":["CORPORATE"],"parameters":[{"name":"letterOfCreditId","in":"query","type":"string","required":false,"description":"Identifier of the Letter Of Credit"},{"name":"customerId","in":"query","type":"string","required":false,"description":"Identifier of the customer"},{"name":"operation","in":"query","type":"string","required":false,"description":"Identifies the required operation to be executed for a Trade Finance contract. Input of valid codes as: O for opening of LC, P for Pre-advise of LC, A for Amend LC, C for Collect Charges, D for Decisi"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"LetterOfCreditsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/letterOfCredits/exports/drawings","fullPath":"/api/v6.0.0/holdings/letterOfCredits/exports/drawings","operationId":"getExportDrawings","name":"Retrieves the list of export letter of credit drawings for specific customer","summary":"Retrieves export letter of credit drawings","tags":["CORPORATE"],"parameters":[{"name":"customerId","in":"query","type":"string","required":false,"description":"Identifier of the customer"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"ExportDrawingsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/letterOfCredits/exports/amendments","fullPath":"/api/v6.0.0/holdings/letterOfCredits/exports/amendments","operationId":"getExportLCAmendments","name":"Retrieves the list of export letter of credit amendments for specific customer","summary":"Retrieves export letter of credit amendments","tags":["CORPORATE"],"parameters":[{"name":"customerId","in":"query","type":"string","required":false,"description":"Identifier of the customer"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"ExportLCAmendmentsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/letterOfCredits/exports","fullPath":"/api/v6.0.0/holdings/letterOfCredits/exports","operationId":"getRegisteredExportLc","name":"Retrieves the list of export letter of credits registered for specific customer","summary":"Retrieves registered export letter of credits","tags":["CORPORATE"],"parameters":[{"name":"adviceExpiryDate","in":"query","type":"string","required":false,"description":"Specifies the actual expiry date of Guarantee."},{"name":"transactionReference","in":"query","type":"string","required":true,"description":"Contains the identifier for the transaction in the core system"},{"name":"issuingBankId","in":"query","type":"string","required":false,"description":"Identifies the Issuing bank ID under the LC, who issues the LC under when a bank is advising the Letter of Credit"},{"name":"lcCurrency","in":"query","type":"string","required":false,"description":"Denote the currency of the Letter of Credit."},{"name":"lcAmount","in":"query","type":"string","required":false,"description":"This field indicates the amount of the Letter of Credit that will always be expressed in the currency of Letter of Credit."},{"name":"beneficiaryCustomerId","in":"query","type":"string","required":false,"description":"Identifies the Customer who is to be the ultimate receiver of the funds transferred by the sending bank when this Beneficiary is not a bank."},{"name":"liabilityReversalDate","in":"query","type":"string","required":false,"description":"Date on which the contingent entries and the limits raised on the LC will be reversed."},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"RegisteredExportLcResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"POST","path":"/holdings/letterOfCredits/exports","fullPath":"/api/v6.0.0/holdings/letterOfCredits/exports","operationId":"createExportLetterOfCredit","name":"Create a new export letter of credit for specific customer","summary":"Create export letter of credit","tags":["CORPORATE"],"parameters":[{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"applicants":[{}],"advisingBanks":[{}],"beneficiaries":[{}],"additionalInformations":[{}],"additionalAmountsCovered":[{}],"deferredPayments":[{}],"contactDetails":[{}],"shipmentPeriods":[{}],"presentationPeriods":[{}],"descriptionOfGoods":[{}],"documentDetails":[{}],"documentsRequired":[{}],"clausesDetails":[{}],"additionalConditions":[{}],"narrativeCharges":[{}]}},"responses":{"200":"ExportLetterOfCreditResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/holdings/letterOfCredits/imports/drawings","fullPath":"/api/v6.0.0/holdings/letterOfCredits/imports/drawings","operationId":"getImportDrawings","name":"Retrieves the list of import letter of credit drawings for specific customer","summary":"Retrieves import letter of credit drawings","tags":["CORPORATE"],"parameters":[{"name":"customerId","in":"query","type":"string","required":false,"description":"Identifier of the customer"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"ImportDrawingsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/letterOfCredits/imports/amendments","fullPath":"/api/v6.0.0/holdings/letterOfCredits/imports/amendments","operationId":"getImportLCAmendments","name":"Retrieves the list of import letter of credit amendments for specific customer","summary":"Retrieves import letter of credit amendments","tags":["CORPORATE"],"parameters":[{"name":"customerId","in":"query","type":"string","required":false,"description":"Identifier of the customer"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"ImportLCAmendmentsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/letterOfCredits/imports","fullPath":"/api/v6.0.0/holdings/letterOfCredits/imports","operationId":"getImportLc","name":"Retrieves the list of import letter of credits for specific customer","summary":"Retrieves import letter of credits","tags":["CORPORATE"],"parameters":[{"name":"customerId","in":"query","type":"string","required":false,"description":"Identifier of the customer"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"ImportLcResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/letterOfCredits/outwardCollections/documents","fullPath":"/api/v6.0.0/holdings/letterOfCredits/outwardCollections/documents","operationId":"getOutwardCollectionDocuments","name":"Retrieves the list of outward collections document codes for specific customer","summary":"Retrieves the outward collection document codes","tags":["CORPORATE"],"parameters":[{"name":"lcAdviceTextId","in":"query","type":"string","required":false,"description":"This is the key to the letter of credit advice text file.During the input of an L/C this code can be entered for the inclusion of standard text."},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"OutwardCollectionDocumentsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/letterOfCredits/inwardCollections/amendments","fullPath":"/api/v6.0.0/holdings/letterOfCredits/inwardCollections/amendments","operationId":"getInwardCollectionsAmendments","name":"Retrieves the list of inward collection amendments for specific customer","summary":"Retrieves the inward collection amendments","tags":["CORPORATE"],"parameters":[{"name":"customerId","in":"query","type":"string","required":false,"description":"Identifier of the customer"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"InwardCollectionsAmendmentsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/letterOfCredits/inwardCollections","fullPath":"/api/v6.0.0/holdings/letterOfCredits/inwardCollections","operationId":"getInwardCollections","name":"Retrieves the list of inward collections for specific customer","summary":"Retrieves the inward collections","tags":["CORPORATE"],"parameters":[{"name":"customerId","in":"query","type":"string","required":false,"description":"Identifier of the customer"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"InwardCollectionsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"POST","path":"/holdings/letterOfCredits/inwardCollections","fullPath":"/api/v6.0.0/holdings/letterOfCredits/inwardCollections","operationId":"createInwardCollection","name":"Lodgment of the Import documentary collection by the collecting bank ","summary":"Creates a new inward documentary collection","tags":["CORPORATE"],"parameters":[{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"inward":[{}],"applicantAddresses":[{}],"advisingBanks":[{}],"beneficiaries":[{}],"guaranteeReferences":[{}],"documents":[{}],"additionalConditions":[{}],"instructions":[{}],"bankToBanks":[{}],"invoiceReferences":[{}],"transportation":[{}],"charges":[{}],"chargeCodes":[{}],"extensions":{}}},"responses":{"200":"InwardCollectionResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/holdings/letterOfCredits/tenors","fullPath":"/api/v6.0.0/holdings/letterOfCredits/tenors","operationId":"getLcTenors","name":"Retrieves the list of letter of credit tenor details","summary":"Retrieves letter of credit tenor details","tags":["CORPORATE"],"parameters":[{"name":"lcPayTypeId","in":"query","type":"string","required":false,"description":"Indicates the identifier of payment type enrichment for letter of credit."},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"LcTenorsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/letterOfCredits/outwardCollections/amendments","fullPath":"/api/v6.0.0/holdings/letterOfCredits/outwardCollections/amendments","operationId":"getOutwardCollectionAmdendments","name":"Retrieves the list of outward collection amendments for specific customer","summary":"Retrieves outward collection amendments","tags":["CORPORATE"],"parameters":[{"name":"customerId","in":"query","type":"string","required":false,"description":"Identifier of the customer"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"OutwardCollectionAmdendmentsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/letterOfCredits/outwardCollections","fullPath":"/api/v6.0.0/holdings/letterOfCredits/outwardCollections","operationId":"getOutwardCollections","name":"Retrieves the outstanding details of outward collections","summary":"Retrieves the outward collection amendments","tags":["CORPORATE"],"parameters":[{"name":"customerId","in":"query","type":"string","required":false,"description":"Identifier of the customer"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"OutwardCollectionsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"POST","path":"/holdings/letterOfCredits/outwardCollections","fullPath":"/api/v6.0.0/holdings/letterOfCredits/outwardCollections","operationId":"createOutwardCollections","name":"Initiation of the export documentary collection by the collecting bank","summary":"Creates the outward collections","tags":["CORPORATE"],"parameters":[{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"beneficiaryDetails":[{}],"issuingBankNames":[{}],"applicantNames":[{}],"documentCodes":[{}],"additionalConditions":[{}],"instructionDetails":[{}],"bankToBanks":[{}],"deliveryInstructions":[{}],"chargeCodes":[{}],"avalisationDetails":[{}],"externalReference":"string","beneficiaryCustomerId":"string","beneficiaryAccountId":"string","currencyId":"string","issueDate":"string"}},"responses":{"200":"OutwardCollectionsResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/holdings/letterOfCredits/limits","fullPath":"/api/v6.0.0/holdings/letterOfCredits/limits","operationId":"getLcLimits","name":"Retrieves the list of letter of credit limit details","summary":"Retrieves the letter of credit limits","tags":["CORPORATE"],"parameters":[{"name":"customerId","in":"query","type":"string","required":false,"description":"Identifier of the customer"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"LcLimitsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"DELETE","path":"/holdings/letterOfCredits/drawings/{drawingId}/cancellations/","fullPath":"/api/v6.0.0/holdings/letterOfCredits/drawings/{drawingId}/cancellations/","operationId":"rejectDrawing","name":"Cancel an initiated drawing for letter of credit","summary":"Cancel initiated drawing","tags":["CORPORATE"],"parameters":[{"name":"drawingId","in":"path","type":"string","required":true,"description":"Identifier of drawings application under the Letter of Credit system that is used to effect the transfer of funds and the acceptance of documents under Letters of Credit and Documentary Collection tra"},{"name":"payload","in":"body","type":"object","required":false,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}}},"responses":{"200":"DrawingResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"DELETE","path":"/holdings/letterOfCredits/{letterOfCreditId}/amendments/cancellations","fullPath":"/api/v6.0.0/holdings/letterOfCredits/{letterOfCreditId}/amendments/cancellations","operationId":"rejectLcAmendment","name":"Cancel an initiated letter of credit amendment","summary":"Cancel letter of credit amendment","tags":["CORPORATE"],"parameters":[{"name":"letterOfCreditId","in":"path","type":"string","required":true,"description":"Identifier of the Letter Of Credit"},{"name":"payload","in":"body","type":"object","required":false,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}}},"responses":{"200":"LcAmendmentResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/holdings/letterOfCredits/ApprovedOutwardCollections","fullPath":"/api/v6.0.0/holdings/letterOfCredits/ApprovedOutwardCollections","operationId":"getApprovedOutwardCollections","name":"Retrieve the list of approved outward collections for specific customer","summary":"Retrieve approved outward collections","tags":["CORPORATE"],"parameters":[{"name":"collectionId","in":"query","type":"string","required":false,"description":"Identifier of collection id"},{"name":"beneficiaryCustomerId","in":"query","type":"string","required":false,"description":"Identifies the Customer who is to be the ultimate receiver of the funds transferred by the sending bank when this Beneficiary is not a bank."},{"name":"ibStatus","in":"query","type":"string","required":false,"description":"Field to indicate the status of LC request through internet banking."},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"ApprovedOutwardCollectionsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/letterOfCredits/{lcAmendmentId}/amendment","fullPath":"/api/v6.0.0/holdings/letterOfCredits/{lcAmendmentId}/amendment","operationId":"getLcAmendment","name":"Retrieve the details of specific letter of credit amendment details","summary":"Overview details of letter of credit amendment","tags":["CORPORATE"],"parameters":[{"name":"lcAmendmentId","in":"path","type":"string","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"LcAmendmentResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"POST","path":"/holdings/letterOfCreditsInitiation","fullPath":"/api/v6.0.0/holdings/letterOfCreditsInitiation","operationId":"createLetterOfCredit","name":"Initiate a new letter of credit request for specific customer","summary":"Create letter of credit request","tags":["CORPORATE"],"parameters":[{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"applicantCustomerNames":[{}],"advisingBanks":[{}],"beneficiaryCustomerNames":[{}],"availableWithDetails":[{}],"additionalAmountsCovered":[{}],"deferredPayments":[{}],"contactDetails":[{}],"shipmentPeriods":[{}],"presentationPeriods":[{}],"descriptionOfGoods":[{}],"documentDetails":[{}],"documentsRequired":[{}],"clausesDetails":[{}],"additionalConditions":[{}],"narrativeCharges":[{}]}},"responses":{"200":"LetterOfCreditResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/holdings/letterOfCredit/{letterOfCreditId}","fullPath":"/api/v6.0.0/holdings/letterOfCredit/{letterOfCreditId}","operationId":"updateLetterOfCredits","name":"Update an existing letter of credit for specific customer","summary":"Update letter of credit","tags":["CORPORATE"],"parameters":[{"name":"letterOfCreditId","in":"path","type":"string","required":true,"description":"Identifier of the Letter Of Credit"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"applicantCustomerNames":[{}],"advisingBanks":[{}],"beneficiaryCustomerNames":[{}],"availableWithDetails":[{}],"additionalAmountsCovered":[{}],"deferredPayments":[{}],"contactDetails":[{}],"shipmentPeriods":[{}],"presentationPeriods":[{}],"descriptionOfGoods":[{}],"documentDetails":[{}],"documentsRequired":[{}],"clausesDetails":[{}],"additionalConditions":[{}],"narrativeCharges":[{}]}},"responses":{"200":"LetterOfCreditsResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/holdings/letterOfCredits/{letterOfCreditId}","fullPath":"/api/v6.0.0/holdings/letterOfCredits/{letterOfCreditId}","operationId":"getLetterOfCredit","name":"Retrieves the details of specific letter of credit","summary":"Retrieves the details of letter of credit","tags":["CORPORATE"],"parameters":[{"name":"letterOfCreditId","in":"path","type":"string","required":true,"description":"Identifier of the Letter Of Credit"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"LetterOfCreditResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"POST","path":"/holdings/letterOfCredits/{letterOfCreditId}","fullPath":"/api/v6.0.0/holdings/letterOfCredits/{letterOfCreditId}","operationId":"updateExternalAmendmentToAnLC","name":"Updates the  amendments to the letter of credit for the specified letter of credit/customer reference number","summary":"Updates letter of credit details","tags":["CORPORATE"],"parameters":[{"name":"letterOfCreditId","in":"path","type":"string","required":true,"description":""},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"additionalAmountsCovered":[{}],"amendmentInformations":[{}],"beneficiaries":[{}],"narrativeCharges":[{}],"reimbursingBankAndAddresses":[{}],"bankToBanks":[{}],"charges":[{}],"chargeCodes":[{}],"commissionDetails":[{}],"margins":[{}],"issuingBankNames":[{}],"applicantAddresses":[{}],"availableWithBanks":[{}],"draftsAt":[{}],"drawees":[{}]}},"responses":{"200":"ExternalAmendmentToAnLCResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/holdings/letterOfCredits/{letterOfCreditId}","fullPath":"/api/v6.0.0/holdings/letterOfCredits/{letterOfCreditId}","operationId":"updateLetterOfCredit","name":"Updates the letter of credit initiation for the specified letter of credit/customer reference number","summary":"Updates letter of credit details","tags":["CORPORATE"],"parameters":[{"name":"letterOfCreditId","in":"path","type":"string","required":true,"description":"Identifier of the Letter Of Credit"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"applicantAddresses":[{}],"advisingBanks":[{}],"beneficiaries":[{}],"availableWithBanks":[{}],"additionalAmountsCovered":[{}],"deferredPayments":[{}],"contactDetails":[{}],"shipmentPeriods":[{}],"presentationPeriods":[{}],"descriptionsOfGoods":[{}],"documentCodes":[{}],"documentDetails":[{}],"documentsRequired":[{}],"additionalConditions":[{}],"narrativeCharges":[{}]}},"responses":{"200":"LetterOfCreditResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"DELETE","path":"/holdings/letterOfCredits/{letterOfCreditId}","fullPath":"/api/v6.0.0/holdings/letterOfCredits/{letterOfCreditId}","operationId":"deleteLetterOfCredit","name":"Remove an existing letter of credit for specific customer","summary":"Remove letter of credit","tags":["CORPORATE"],"parameters":[{"name":"letterOfCreditId","in":"path","type":"string","required":true,"description":"Identifier of the Letter Of Credit"},{"name":"payload","in":"body","type":"object","required":false,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}}},"responses":{"200":"LetterOfCreditResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/holdings/letterOfCredits/letterOfCreditApprovals/{letterOfCreditId}","fullPath":"/api/v6.0.0/holdings/letterOfCredits/letterOfCreditApprovals/{letterOfCreditId}","operationId":"approveLetterOfCredit","name":"Approve an initiated letter of credit request for specific customer","summary":"Approve letter of credit request","tags":["CORPORATE"],"parameters":[{"name":"letterOfCreditId","in":"path","type":"string","required":true,"description":"Identifier of the Letter Of Credit"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"LetterOfCreditResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"DELETE","path":"/holdings/letterOfCredits/cancellations/{letterOfCreditId}","fullPath":"/api/v6.0.0/holdings/letterOfCredits/cancellations/{letterOfCreditId}","operationId":"rejectLetterOfCredit","name":"Cancel an initiated letter of credit request for specific customer","summary":"Cancel letter of credit request","tags":["CORPORATE"],"parameters":[{"name":"letterOfCreditId","in":"path","type":"string","required":true,"description":"Identifier of the Letter Of Credit"},{"name":"payload","in":"body","type":"object","required":false,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}}},"responses":{"200":"LetterOfCreditResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"POST","path":"/holdings/letterOfCredit/exports","fullPath":"/api/v6.0.0/holdings/letterOfCredit/exports","operationId":"createExportLetterOfCredits","name":"Create a new export letter of credit for specific customer","summary":"Create export letter of credit","tags":["CORPORATE"],"parameters":[{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"applicantCustomerNames":[{}],"advisingBanks":[{}],"beneficiaryCustomerNames":[{}],"availableWithDetails":[{}],"additionalAmountsCovered":[{}],"deferredPayments":[{}],"contactDetails":[{}],"shipmentPeriods":[{}],"presentationPeriods":[{}],"descriptionOfGoods":[{}],"documentDetails":[{}],"documentsRequired":[{}],"clausesDetails":[{}],"additionalConditions":[{}],"narrativeCharges":[{}]}},"responses":{"200":"ExportLetterOfCreditsResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/holdings/letterOfCredit/{letterOfCreditId}/exports","fullPath":"/api/v6.0.0/holdings/letterOfCredit/{letterOfCreditId}/exports","operationId":"updateExportLetterOfCredits","name":"Update a new export letter of credit for specific customer","summary":"Update export letter of credit","tags":["CORPORATE"],"parameters":[{"name":"letterOfCreditId","in":"path","type":"string","required":true,"description":"Identifier of the Letter Of Credit"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"applicantCustomerNames":[{}],"advisingBanks":[{}],"beneficiaryCustomerNames":[{}],"availableWithDetails":[{}],"additionalAmountsCovered":[{}],"deferredPayments":[{}],"contactDetails":[{}],"shipmentPeriods":[{}],"presentationPeriods":[{}],"descriptionOfGoods":[{}],"documentDetails":[{}],"documentsRequired":[{}],"clausesDetails":[{}],"additionalConditions":[{}],"narrativeCharges":[{}]}},"responses":{"200":"ExportLetterOfCreditsResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"POST","path":"/holdings/letterOfCredits/sightPayments","fullPath":"/api/v6.0.0/holdings/letterOfCredits/sightPayments","operationId":"createIssuanceOfSightPaymentLC","name":"Creates sight payment letter of credit for the requested customer reference number","summary":"Create sight payment letter of credit","tags":["CORPORATE"],"parameters":[{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"applicantAddresses":[{}],"beneficiaryAddresses":[{}],"advisingBankAddresses":[{}],"adviseThroughBanks":[{}],"availableWithBanks":[{}],"reimbursingBanks1":[{}],"requestedConfirmBankNames":[{}],"charges":[{}],"importSightPmtLcType":"string","lcNumber":"string","applicant":"string","lcCurrency":"string","lcAmount":0.0,"creditTolerance":"string","debitTolerance":"string"}},"responses":{"200":"IssuanceOfSightPaymentLCResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"POST","path":"/holdings/letterOfCredits/usances","fullPath":"/api/v6.0.0/holdings/letterOfCredits/usances","operationId":"createIssuanceOfUsanceLC","name":"Creates usance letter of credit for the requested customer reference number","summary":"Create usance letter of credit","tags":["CORPORATE"],"parameters":[{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"applicantAddresses":[{}],"limitReferences":[{}],"beneficiaryAddresses":[{}],"advisingBankAddresses":[{}],"adviseThroughBanks":[{}],"availableWithBanks":[{}],"reimbursingBanks1":[{}],"requestedConfirmBankNames":[{}],"charges":[{}],"importUsanceLCType":"string","lcNumber":"string","applicant":"string","currency":"string","amount":0.0,"creditTolerance":"string"}},"responses":{"200":"IssuanceOfUsanceLCResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"POST","path":"/holdings/letterOfCredits/negotiations","fullPath":"/api/v6.0.0/holdings/letterOfCredits/negotiations","operationId":"createIssuanceOfNegotiationLC","name":"Creates negotiation letter of credit for the requested customer reference number","summary":"Create negotiation letter of credit","tags":["CORPORATE"],"parameters":[{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"applicantAddresses":[{}],"beneficiaryAddresses":[{}],"advisingBankAddresses":[{}],"adviseThroughBanks":[{}],"availableWithBanks":[{}],"reimbursingBanks1":[{}],"requestedConfirmBankNames":[{}],"charges":[{}],"importNegotiationLCType":"string","lcNumber":"string","applicant":"string","lcCurrency":"string","lcAmount":"string","creditTolerance":"string","debitTolerance":"string"}},"responses":{"200":"IssuanceOfNegotiationLCResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"POST","path":"/holdings/letterOfCredits/mixedPayments","fullPath":"/api/v6.0.0/holdings/letterOfCredits/mixedPayments","operationId":"createIssuanceOfMixedPaymentLC","name":"Creates mixed payment letter of credit for the requested customer reference number","summary":"Create mixed payment letter of credit","tags":["CORPORATE"],"parameters":[{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"applicantAddresses":[{}],"beneficiaryAddresses":[{}],"advisingBankAddresses":[{}],"adviseThroughBanks":[{}],"availableWithBanks":[{}],"reimbursingBanks1":[{}],"requestedConfirmBankNames":[{}],"charges":[{}],"drawings":[{}],"importMixedPmtLCType":"string","lcNumber":"string","applicantCustomer":"string","lcCurrency":"string","lcAmount":"string","creditTolerance":"string"}},"responses":{"200":"IssuanceOfMixedPaymentLCResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"POST","path":"/holdings/letterOfCredits/standbys","fullPath":"/api/v6.0.0/holdings/letterOfCredits/standbys","operationId":"createIssuanceOfStandbyLC","name":"Creates standby letter of credit for the requested customer reference number","summary":"Create standby letter of credit","tags":["CORPORATE"],"parameters":[{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"applicantAddresses":[{}],"limitReferences":[{}],"beneficiaryAddresses":[{}],"advisingBankAddresses":[{}],"adviseThroughBanks":[{}],"availableWithBanks":[{}],"reimbursingBanks1":[{}],"requestedConfirmBankNames":[{}],"charges":[{}],"importLCType":"string","lcNumber":"string","applicantCustomer":"string","lcCurrency":"string","lcAmount":0.0,"creditTolerance":"string"}},"responses":{"200":"IssuanceOfStandbyLCResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"POST","path":"/holdings/letterOfCredits/imports/preAdvises","fullPath":"/api/v6.0.0/holdings/letterOfCredits/imports/preAdvises","operationId":"createIssuanceOfPreAdviseImportLC","name":"Creates a pre-advice import letter of credit request.","summary":"Creates pre-advice letter of credit","tags":["CORPORATE"],"parameters":[{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"applicantAddresses":[{}],"limitReferences":[{}],"beneficiaryAddresses":[{}],"advisingBankAddresses":[{}],"adviseThroughBanks":[{}],"availableWithBanks":[{}],"reimbursingBanks1":[{}],"requestedConfirmBankNames":[{}],"charges":[{}],"lcNumber":"string","lcType":"string","applicant":"string","currency":"string","amount":0.0,"creditTolerance":"string"}},"responses":{"200":"IssuanceOfPreAdviseImportLCResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"POST","path":"/holdings/letterOfCredits/backToBacks","fullPath":"/api/v6.0.0/holdings/letterOfCredits/backToBacks","operationId":"createIssuanceOfBackToBackLC","name":"Creates back-to-back letter of credit for the requested customer reference number","summary":"Creates back-to-back letter of credit","tags":["CORPORATE"],"parameters":[{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"limitReferences":[{}],"beneficiaryAddresses":[{}],"applicantNames":[{}],"availableWithBanks":[{}],"adviseThroughBanks":[{}],"charges":[{}],"drawings":[{}],"accountWithBanks":[{}],"senderReceiversInfoMT730":[{}],"exportLCType":"string","backToBackLCRequired":"string","relatedImportLCReference":"string","advisingBankReference":"string","lcAdvisingReference":"string","issuingBankLCReference":"string"}},"responses":{"200":"IssuanceOfBackToBackLCResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"POST","path":"/holdings/letterOfCredits/transferables","fullPath":"/api/v6.0.0/holdings/letterOfCredits/transferables","operationId":"createIssuanceOfTransferableLC","name":"Creates transferable letter of credit for the requested customer reference number","summary":"Creates transferable letter of credit","tags":["CORPORATE"],"parameters":[{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"advisingBanks":[{}],"limitReferences":[{}],"drawings":[{}],"charges":[{}],"assignments":[{}],"secondBeneficiaries":[{}],"availableWithBanks":[{}],"draftsAt":[{}],"drawees":[{}],"mixedPaymentDetails":[{}],"negotiationDeferredPaymentDetails":[{}],"shipmentPeriods":[{}],"documentsRequired":[{}],"additionalConditions":[{}],"narrativeCharges":[{}]}},"responses":{"200":"IssuanceOfTransferableLCResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"POST","path":"/holdings/letterOfCredits/{letterOfCreditId}/beneficiaryConsents","fullPath":"/api/v6.0.0/holdings/letterOfCredits/{letterOfCreditId}/beneficiaryConsents","operationId":"updateAmendmentSeekingBeneficiaryConsent","name":"Updates letter of credit amendments seeking beneficiary's consent for the specified letter of credit/customer reference number","summary":"Updates letter of credit beneficiary's consent details","tags":["CORPORATE"],"parameters":[{"name":"letterOfCreditId","in":"path","type":"string","required":true,"description":"Identifier of the Letter Of Credit"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"advisingBankIds":[{}],"beneficiaryAddresses":[{}],"documentsRequired":[{}],"additionalConditions":[{}],"charges":[{}],"lcCurrency":"string","lcAmount":0.0,"issueDate":"2024-01-01","beneficiaryId":"string","lcLiabilityAmountOutStanding":"string","pendingAmendMovement":"string","debitTolerance":"string","creditTolerance":"string","advisingBankReference":"string","increaseOrDecreaseAmount":0.0}},"responses":{"200":"AmendmentSeekingBeneficiaryConsentResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"POST","path":"/holdings/letterOfCredits/{letterOfCreditId}/imports/decisions","fullPath":"/api/v6.0.0/holdings/letterOfCredits/{letterOfCreditId}/imports/decisions","operationId":"updateDecisionOnAmendment","name":"Updates the decision on amendments to import letter of credit for the specified letter of credit/customer reference number","summary":"Updates decision on amendment to the import letter of credit","tags":["CORPORATE"],"parameters":[{"name":"letterOfCreditId","in":"path","type":"string","required":true,"description":"Identifier of the Letter Of Credit"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"additionalAmountsCovered":[{}],"limitReferences":[{}],"beneficiaries":[{}],"bankToBanks":[{}],"internalAmendmentDetails":[{}],"charges":[{}],"commissions":[{}],"amendmentNumber":"string","amendStatus":"string","sendAmendmentAdvice":"string","lcNumber":"string","advisingBankReference":"string","issueDate":"2024-01-01","lcType":"string","amendmentDate":"2024-01-01"}},"responses":{"200":"DecisionOnAmendmentResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"POST","path":"/holdings/letterOfCredits/{letterOfCreditId}/imports/cancellations","fullPath":"/api/v6.0.0/holdings/letterOfCredits/{letterOfCreditId}/imports/cancellations","operationId":"updateCancellationOfLC","name":"Updates the cancellation details of the issued import letter of credit for the specified letter of credit/customer reference number","summary":"Updates import letter of credit cancellation details","tags":["CORPORATE"],"parameters":[{"name":"letterOfCreditId","in":"path","type":"string","required":true,"description":"Identifier of the Letter Of Credit"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"limitReferences":[{}],"beneficiaries":[{}],"charges":[{}],"commissions":[{}],"lcNumber":"string","sendAmendmentAdvice":"string","lcType":"string","advisingBankReference":"string","applicantCustomer":"string","advisingBank":"string","issueDate":"string","newLcCurrency":"string","newLcAmount":"string","creditTolerance":"string","debitTolerance":"string"}},"responses":{"200":"CancellationOfLCResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"POST","path":"/holdings/letterOfCredits/{letterOfCreditId}/exports/decisions","fullPath":"/api/v6.0.0/holdings/letterOfCredits/{letterOfCreditId}/exports/decisions","operationId":"updateDecisionOnExportLCAmendment","name":"Updates the decision on amendments to export letter of credit for the specified letter of credit/customer reference number","summary":"Updates decision on amendment to the export letter of credit","tags":["CORPORATE"],"parameters":[{"name":"letterOfCreditId","in":"path","type":"string","required":true,"description":"Identifier of the Letter Of Credit"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"beneficiaries":[{}],"shipmentPeriods":[{}],"internalAmendmentDetails":[{}],"charges":[{}],"amendmentNumber":"string","lcType":"string","amendStatus":"string","applicantCustomer":"string","lcNumber":"string","sendAmendmentAdvice":"string","issuingBankReference":"string","issueDate":"string","issuingBankId":"string","lcCurrency":"string","lcAmount":"string"}},"responses":{"200":"DecisionOnExportLCAmendmentResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"POST","path":"/holdings/letterOfCredits/{letterOfCreditId}/exports/cancellations","fullPath":"/api/v6.0.0/holdings/letterOfCredits/{letterOfCreditId}/exports/cancellations","operationId":"updateCancellationOfExportLC","name":"Updates the cancellation details of the issued export letter of credit for the specified letter of credit/customer reference number","summary":"Updates export letter of credit cancellation details ","tags":["CORPORATE"],"parameters":[{"name":"letterOfCreditId","in":"path","type":"string","required":true,"description":""},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"applicants":[{}],"additionalAmountsCovered":[{}],"beneficiaries":[{}],"charges":[{}],"lcNumber":"string","sendAmendmentAdvice":"string","lcType":"string","issuingBankReference":"string","issuingBankId":"string","lcIssueDate":"string","newLcCurrency":"string","newLcAmount":"string","creditTolerance":"string","debitTolerance":"string","purposeOfMessage":"string"}},"responses":{"200":"CancellationOfExportLCResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/holdings/customers/{customerId}/letterOfCredits/imports/outstandings","fullPath":"/api/v6.0.0/holdings/customers/{customerId}/letterOfCredits/imports/outstandings","operationId":"getImportLcsOutstanding","name":"Retrieves the details of outstanding import letter of credits for the specified customer/guarantee reference.","summary":"Retrieves outstanding import letter of credit details","tags":["CORPORATE"],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"Identifier of the customer"},{"name":"transactionReference","in":"query","type":"string","required":false,"description":"Contains the identifier for the transaction in the core system"},{"name":"lcCurrency","in":"query","type":"string","required":false,"description":"Denote the currency of the Letter of Credit."},{"name":"advisingBank","in":"query","type":"string","required":false,"description":"Identifies the advising bank under the Letter of Credit, through whom the Letter of Credit is to be advised to the second advising bank or beneficiary"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"ImportLcsOutstandingResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/customers/{customerId}/letterOfCredits/imports/expiries","fullPath":"/api/v6.0.0/holdings/customers/{customerId}/letterOfCredits/imports/expiries","operationId":"getImportLcsExpiringButOutstanding","name":"Retrieves the expired import letter of credit details for the specified customer/guarantee reference.","summary":"Retrieves expired import letter of credit details","tags":["CORPORATE"],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":""},{"name":"transactionReference","in":"query","type":"string","required":false,"description":"Contains the identifier for the transaction in the core system"},{"name":"applicantCustomer","in":"query","type":"string","required":false,"description":"Indicates the applicant ID on whose behalf the Letter of Credit is issued."},{"name":"lcCurrency","in":"query","type":"string","required":false,"description":"Denote the currency of the Letter of Credit."},{"name":"advisingBank","in":"query","type":"string","required":false,"description":"Identifies the advising bank under the Letter of Credit, through whom the Letter of Credit is to be advised to the second advising bank or beneficiary"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"ImportLcsExpiringButOutstandingResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/letterOfCredits/{letterOfCreditId}/exports/outstandings","fullPath":"/api/v6.0.0/holdings/letterOfCredits/{letterOfCreditId}/exports/outstandings","operationId":"getExportlcsOutstanding","name":"Retrieves the details of outstanding export letter of credits for the specified customer/guarantee reference.","summary":"Retrieves outstanding export letter of credit details","tags":["CORPORATE"],"parameters":[{"name":"letterOfCreditId","in":"path","type":"string","required":true,"description":""},{"name":"transactionReference","in":"query","type":"string","required":false,"description":"Contains the identifier for the transaction in the core system"},{"name":"issuingBankId","in":"query","type":"string","required":false,"description":"Identifies the Issuing bank ID under the LC, who issues the LC under when a bank is advising the Letter of Credit"},{"name":"lcCurrency","in":"query","type":"string","required":false,"description":"Denote the currency of the Letter of Credit."},{"name":"lcAmount","in":"query","type":"string","required":false,"description":"This field indicates the amount of the Letter of Credit that will always be expressed in the currency of Letter of Credit."},{"name":"beneficiaryCustomerId","in":"query","type":"string","required":false,"description":"Identifies the Customer who is to be the ultimate receiver of the funds transferred by the sending bank when this Beneficiary is not a bank."},{"name":"expiryDate","in":"query","type":"string","required":false,"description":"This indicates the  date  on which the offer or privilege terminates for the event."},{"name":"liabilityReversalDate","in":"query","type":"string","required":false,"description":"Date on which the contingent entries and the limits raised on the LC will be reversed."},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"ExportlcsOutstandingResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"PUT","path":"/holdings/letterOfCredits/{letterOfCreditId}/outwardCollections/amendments","fullPath":"/api/v6.0.0/holdings/letterOfCredits/{letterOfCreditId}/outwardCollections/amendments","operationId":"amendOutwardCollections","name":"Amendments to outward collection contracts are implemented by revising the contract with updated values","summary":"Updates the outward collections","tags":["CORPORATE"],"parameters":[{"name":"letterOfCreditId","in":"path","type":"string","required":true,"description":"Identifier of the Letter Of Credit"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"applicantNames":[{}],"advisingBanks":[{}],"beneficiaryDetails":[{}],"availableWithDetails":[{}],"additionalAmountsCovered":[{}],"deferredPayments":[{}],"contactDetails":[{}],"shipmentPeriods":[{}],"presentationPeriods":[{}],"descriptionOfGoods":[{}],"documentCodes":[{}],"documentDetails":[{}],"documentsRequired":[{}],"clausesDetails":[{}],"additionalConditions":[{}]}},"responses":{"200":"OutwardCollectionsResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/holdings/letterOfCredits/outwardCollections/outstandings","fullPath":"/api/v6.0.0/holdings/letterOfCredits/outwardCollections/outstandings","operationId":"getOutwardCollectionsOutstanding","name":"Retrieves the outstanding details of outward collections","summary":"Retrieves the outstanding details of outward collections","tags":["CORPORATE"],"parameters":[{"name":"collectionReference","in":"query","type":"string","required":true,"description":"The ID of the Letter of Credit, to be linked to this Guarantee for the purpose of apportioning the Margin"},{"name":"beneficiaryCustomerId","in":"query","type":"string","required":false,"description":"Identifies the Customer who is to be the ultimate receiver of the funds transferred by the sending bank when this Beneficiary is not a bank."},{"name":"currencyId","in":"query","type":"string","required":false,"description":"Identifier of the currency. This is the 3-letter ISO 4217 code of the currency."},{"name":"days","in":"query","type":"string","required":false,"description":"Valid for Documentary Collections and used in conjunction with the field TENOR to indicate the tenor of the drafts under the collection. It is used in the production of corresponding documentary colle"},{"name":"tenor","in":"query","type":"string","required":false,"description":"This field is valid for Documentary Collections only. It is used in conjunction with the following field 'DAYS' or 'COLL.MAT.CODE' to indicate the TENOR of the drafts under the collection and is used "},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"OutwardCollectionsOutstandingResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"POST","path":"/holdings/letterOfCredits/drawings/{drawingId}/documents","fullPath":"/api/v6.0.0/holdings/letterOfCredits/drawings/{drawingId}/documents","operationId":"createDrawingDocument","name":"Initiate the registration of a presentation done for letter of credit transaction","summary":"Initiate a new drawing request to register the documents for letter of credit","tags":["CORPORATE"],"parameters":[{"name":"drawingId","in":"path","type":"string","required":true,"description":"Identifier of drawings application under the Letter of Credit system that is used to effect the transfer of funds and the acceptance of documents under Letters of Credit and Documentary Collection tra"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"addresses":[{}],"presentorCustomerId":"string","referenceId":"string","currencyId":"string","documentAmount":0.0,"creditAccountId":"string","debitAccountId":"string","paymentMethod":"string","nextReviewDate":"2024-01-01","days":"string","documentReceived":"string","maturityReview":"string","extensions":{}}},"responses":{"200":"DrawingDocumentResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/holdings/letterOfCredits/drawings","fullPath":"/api/v6.0.0/holdings/letterOfCredits/drawings","operationId":"getDrawingsDetails","name":"Retrieves the list of drawings for specific customer","summary":"Retrieve drawing details","tags":["CORPORATE"],"parameters":[{"name":"lcType","in":"query","type":"string","required":false,"description":"Indicates the type of LC, whether this is an Import/Export, Confirmed/Unconfirmed/Revolving/Transferrable/Back to Back LC/documentary collection/Clean collection etc."},{"name":"applicantCustomer","in":"query","type":"string","required":false,"description":"Indicates the applicant ID on whose behalf the Letter of Credit is issued."},{"name":"drawingId","in":"query","type":"string","required":false,"description":"Identifier of drawings application under the Letter of Credit system that is used to effect the transfer of funds and the acceptance of documents under Letters of Credit and Documentary Collection tra"},{"name":"drawingType","in":"query","type":"string","required":false,"description":"This field is correlated to the other field payment type and identifies the Draw type under Letter of credit. Whether its a sight LC payment, acceptance, deferred payment or Mixed payment."},{"name":"currencyId","in":"query","type":"string","required":false,"description":"Identifier of the currency. This is the 3-letter ISO 4217 code of the currency."},{"name":"creditType","in":"query","type":"string","required":false,"description":"Contains the credit line type. Possible values are 'Available' and 'Credit'."},{"name":"documentAmount","in":"query","type":"string","required":false,"description":"This field contains the amount to be drawn under this transaction, expressed in the currency above (DRAW.CURRENCY)."},{"name":"referenceId","in":"query","type":"string","required":false,"description":"Reference Identifier of the Derivatives Trade "},{"name":"recordStatus","in":"query","type":"string","required":false,"description":"General status of the record. Possible values: - null - authorised - IHLD - input, on hold - INAU - input, not authorised - INA2 - input, authorised, pending second authorisation - INAO - input, not a"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"DrawingsDetailsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"POST","path":"/holdings/letterOfCredits/initiations","fullPath":"/api/v6.0.0/holdings/letterOfCredits/initiations","operationId":"createLetterOfCreditInitiation","name":"Initiate a new letter of credit request for specific customer","summary":"Creates letter of credit request","tags":["CORPORATE"],"parameters":[{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"applicantAddresses":[{}],"advisingBanks":[{}],"beneficiaries":[{}],"availableWithBanks":[{}],"additionalAmountsCovered":[{}],"deferredPayments":[{}],"contactDetails":[{}],"shipmentPeriods":[{}],"presentationPeriods":[{}],"descriptionsOfGoods":[{}],"documentCodes":[{}],"documentDetails":[{}],"documentsRequired":[{}],"additionalConditions":[{}],"narrativeCharges":[{}]}},"responses":{"200":"LetterOfCreditInitiationResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/holdings/letterOfCredits/{letterOfCreditId}/exports","fullPath":"/api/v6.0.0/holdings/letterOfCredits/{letterOfCreditId}/exports","operationId":"updateExportLetterOfCredit","name":"Update a new export letter of credit for specific customer","summary":"Update export letter of credit","tags":["CORPORATE"],"parameters":[{"name":"letterOfCreditId","in":"path","type":"string","required":true,"description":"Identifier of the Letter Of Credit"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"applicants":[{}],"advisingBanks":[{}],"beneficiaries":[{}],"additionalInformations":[{}],"additionalAmountsCovered":[{}],"deferredPayments":[{}],"contactDetails":[{}],"shipmentPeriods":[{}],"presentationPeriods":[{}],"descriptionOfGoods":[{}],"documentDetails":[{}],"documentsRequired":[{}],"clausesDetails":[{}],"additionalConditions":[{}],"narrativeCharges":[{}]}},"responses":{"200":"ExportLetterOfCreditResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/holdings/letterOfCredits/drawings/bills/negotiations","fullPath":"/api/v6.0.0/holdings/letterOfCredits/drawings/bills/negotiations","operationId":"getDrawingsNegotiationBills","name":"Retrieves the negotiated/discounted bills under the letter of credit","summary":"Retrieves the negotiated/discounted bills for drawings","tags":["CORPORATE"],"parameters":[{"name":"maturityReview","in":"query","type":"string","required":false,"description":"This field contains the date on which Acceptance/Deferred Payment drawings will mature, or Letter of Credit Collection drawings will be due for chasing."},{"name":"drawingType","in":"query","type":"string","required":false,"description":"This field is correlated to the other field payment type and identifies the Draw type under Letter of credit. Whether its a sight LC payment, acceptance, deferred payment or Mixed payment."},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"DrawingsNegotiationBillsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/letterOfCredits/drawings/bills/outstandings","fullPath":"/api/v6.0.0/holdings/letterOfCredits/drawings/bills/outstandings","operationId":"getDrawingsOutstandingBills","name":"Retrieves outstanding documents such as bills under the letter of credit","summary":"Retrieves the outstanding bills for drawings","tags":["CORPORATE"],"parameters":[{"name":"maturityReview","in":"query","type":"string","required":false,"description":"This field contains the date on which Acceptance/Deferred Payment drawings will mature, or Letter of Credit Collection drawings will be due for chasing."},{"name":"drawingType","in":"query","type":"string","required":false,"description":"This field is correlated to the other field payment type and identifies the Draw type under Letter of credit. Whether its a sight LC payment, acceptance, deferred payment or Mixed payment."},{"name":"presentorCustomerId","in":"query","type":"string","required":true,"description":"This field is used to identify the presentor of the documents if they are not a customer of the bank with a valid CUSTOMER.NO.Optionally input, identifies the presentor customer."},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"DrawingsOutstandingBillsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"PUT","path":"/holdings/letterOfCredits/{letterOfCreditId}/outwardCollections","fullPath":"/api/v6.0.0/holdings/letterOfCredits/{letterOfCreditId}/outwardCollections","operationId":"updateOutwardCollections","name":"Updates the amendments to the outward collection for the specified letter of credit/customer reference number","summary":"Updates the outward collection details","tags":["CORPORATE"],"parameters":[{"name":"letterOfCreditId","in":"path","type":"string","required":true,"description":"Identifier of the Letter Of Credit"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"applicantCustomerNames":[{}],"advisingBanks":[{}],"beneficiaryCustomerNames":[{}],"availableWithDetails":[{}],"additionalAmountsCovered":[{}],"deferredPayments":[{}],"contactDetails":[{}],"shipmentPeriods":[{}],"presentationPeriods":[{}],"descriptionOfGoods":[{}],"documentDetails":[{}],"documentsRequired":[{}],"clausesDetails":[{}],"additionalConditions":[{}],"narrativeCharges":[{}]}},"responses":{"200":"OutwardCollectionsResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/holdings/letterOfCredits/{letterOfCreditId}/inwardCollections","fullPath":"/api/v6.0.0/holdings/letterOfCredits/{letterOfCreditId}/inwardCollections","operationId":"updateInwardCollections","name":"Updates the amendments to the inward collection for the specified letter of credit/customer reference number","summary":"Updates the inward collection details","tags":["CORPORATE"],"parameters":[{"name":"letterOfCreditId","in":"path","type":"string","required":true,"description":"Identifier of the Letter Of Credit"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"inward":[{}],"applicantAddresses":[{}],"advisingBanks":[{}],"beneficiaries":[{}],"guaranteeReferences":[{}],"documents":[{}],"additionalConditions":[{}],"instructions":[{}],"bankToBanks":[{}],"invoiceReferences":[{}],"transportation":[{}],"charges":[{}],"chargeCodes":[{}],"extensions":{}}},"responses":{"200":"InwardCollectionsResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/holdings/letterOfCredits/exports/drawings/pendings","fullPath":"/api/v6.0.0/holdings/letterOfCredits/exports/drawings/pendings","operationId":"getPeningDrawingPresentation","name":"Retrieves the details of export drawings pending for presentation","summary":"Retrieves the export drawings pending for presentation","tags":["CORPORATE"],"parameters":[{"name":"drawingReference","in":"query","type":"string","required":false,"description":"The field stating the Drawing reference under the guarantee"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"PeningDrawingPresentationResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}}]},{"key":"holdings-limits-service-v1.0.0","title":"Limit liabilities and Forex limits","version":"v1.0.0","description":"API to manage Credit Limit related information such as retrieving Limit Utilisation or Outstandings, Limit Cashflow, Overdrawn Limits, Limits Review & Expiry, SubLimit details and manage Limit Sharing Group details of Master and Sub Groups. ","endpointCount":25,"endpoints":[{"method":"GET","path":"/holdings/limits/{arrangementId}/limitCashflow","fullPath":"/api/v1.0.0/holdings/limits/{arrangementId}/limitCashflow","operationId":"getLimitCashflow","name":"Retrieves the facility cashflow against the Limit, commitment and drawing schedules utilized","summary":"Retrieves Limit cashflow details of contract","tags":[],"parameters":[{"name":"arrangementId","in":"path","type":"string","required":true,"description":"Indicates an unique identifier of an account"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from t24 on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"LimitCashflowResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/limits/customerGroupLimits","fullPath":"/api/v1.0.0/holdings/limits/customerGroupLimits","operationId":"getCustomerGroupLimits","name":"Retrieves all of the customer group limit exposures such as limit allocations, Outstanding, Product, Expiry along with details of related Customers in the Group, related Sub groups","summary":"Retrieves Limit details of Customer group","tags":[],"parameters":[{"name":"customerLimitId","in":"query","type":"string","required":false,"description":"Limit reference of the customer"},{"name":"riskGroupId","in":"query","type":"string","required":false,"description":"Identifier of the CUSTOMER.GROUP that constitutes one or more related customers which would be used while arrivnig collective risk exposure of credit line liable to them either individually or shared "},{"name":"liabilityNumber","in":"query","type":"string","required":false,"description":"Identifier of the Liability Customer to the credit limit"},{"name":"limitId","in":"query","type":"string","required":false,"description":"The identifier of credit limit"},{"name":"creditLineNumber","in":"query","type":"string","required":false,"description":"Details of the top most parent credit line plus the limit product in the hierarchy. Eg : 300/LI1701101987 where 300 is the limit product of the topmost parent and second part is the respective creditl"},{"name":"recordParent","in":"query","type":"string","required":false,"description":"Identifier of the immediate parent limit"},{"name":"limitProduct","in":"query","type":"string","required":false,"description":"Identifier of the credit limit product"},{"name":"serialNumber","in":"query","type":"string","required":false,"description":"A sequence reference for the limit, which when used together with other fields such as Liability Number and/or Limit Reference, provides a unique identifier for a credit line"},{"name":"limitCurrency","in":"query","type":"string","required":false,"description":"Currency in which the credit limit is granted"},{"name":"buisnessUnit","in":"query","type":"string","required":false,"description":"The identifier of the underlying Entity/Company/Branch."},{"name":"expiryDate","in":"query","type":"string","required":false,"description":"The date an agreement such as an arrangement, product, credit facility or limit is due to expire"},{"name":"timeBandName","in":"query","type":"string","required":false,"description":"Description of the individual time code under a credit facility"},{"name":"internalAmount","in":"query","type":"string","required":false,"description":"Indicates the amount allocated to the Credit Limit by the Bank"},{"name":"advisedAmount","in":"query","type":"string","required":false,"description":"Indicates the amount advised to the Credit Limit by the bank"},{"name":"outstandingAmount","in":"query","type":"string","required":false,"description":"Contains the aggregate outstanding principal amount thereof after giving effect to any borrowings and prepayments or repayments of Committed Loans"},{"name":"availableAmount","in":"query","type":"string","required":false,"description":"The credit limit available to the customer for use"},{"name":"availableOrExcess","in":"query","type":"string","required":false,"description":"The available amount for the corresponding liability number and limit reference. This amount is always expressed in the currency of the limit. Calculated as the sum of the online limit, the available "},{"name":"totalCommitment","in":"query","type":"string","required":false,"description":"Specifies the total available commitment amounts  specific to a credit facility"},{"name":"totalCredit","in":"query","type":"string","required":false,"description":"Indicates the total credit balance of the customer's account"},{"name":"totalDebit","in":"query","type":"string","required":false,"description":"Indicates the total debit balance of the customer's account"},{"name":"requestedCurrency","in":"query","type":"string","required":false,"description":"The currency the amount is requested in."},{"name":"exchangeRate","in":"query","type":"string","required":false,"description":"Contains the exchange rate returned from the system. i.e. For entries over foreign currency accounts, this contains the rate which used to convert the currency amount to the local equivalent at the ti"},{"name":"idlType","in":"query","type":"string","required":false,"description":"The INTRA.DAY.LIMIT type that is applicable for a specific credit facility of the customer"},{"name":"idlApprovedAmount","in":"query","type":"string","required":false,"description":"The approved amount by the bank as INTRA.DAY.LIMIT on a credit facility within a specific period of the day"},{"name":"idlAdvisedAmount","in":"query","type":"string","required":false,"description":"The advised amount by the bank to the customer as INTRA.DAY.LIMIT on a credit facility within a specific period of the day"},{"name":"limitType","in":"query","type":"string","required":false,"description":"Defines the limit type for the trade"},{"name":"relatedCustomer","in":"query","type":"string","required":false,"description":"Indicates the related customers of multi customer and joint limits"},{"name":"sharedLimit","in":"query","type":"string","required":false,"description":"Indicates whether the credit line is of shared limit structure"},{"name":"adjustAvailableAmount","in":"query","type":"string","required":false,"description":"Indicates to adjust the available funds to respective time bands."},{"name":"rebuildData","in":"query","type":"string","required":false,"description":"Indicates to rebuild the customer exposure when enquired by user."},{"name":"aggregateCustomerId","in":"query","type":"string","required":false,"description":"List of customer/person entity that are aggregated under a main customer on risk exposure view"},{"name":"aggregateCustomerRelation","in":"query","type":"string","required":false,"description":"Relation code that exists between the main customer and the aggregated customers"},{"name":"limitNote","in":"query","type":"string","required":false,"description":"Relation code that exists between the main customer and the aggregated customers"},{"name":"sessionId","in":"query","type":"string","required":false,"description":"Id of the T24 session where the risk exposure view executed"},{"name":"subGroup","in":"query","type":"string","required":false,"description":"Identifier of the sub group within a CUSTOMER.GROUP that constitues one or more related customers which would be used while arrivnig collective risk exposure of credit line liable to them either indiv"},{"name":"originalInternalAmount","in":"query","type":"string","required":false,"description":"Specifies the orignal amount actually approved or authorised on a credit line by Management or the Credit Committee before any repayment made"},{"name":"originalAdvisedAmount","in":"query","type":"string","required":false,"description":"Specifies the original amount advised to the customer holding the credit facility before any repayment made"},{"name":"repaidAmount","in":"query","type":"string","required":false,"description":"Indicates the amount which was repaid from the customer"},{"name":"totalRepaidAmount","in":"query","type":"string","required":false,"description":"Total of the repaid amount under a credit facility"},{"name":"excessFlag","in":"query","type":"string","required":false,"description":"Flag to indicate the credit line has been over utilised"},{"name":"fixedOrVariable","in":"query","type":"string","required":false,"description":"Indicates the secured nature of limit that has been covered by a customer collateral. When FIXED the limit amount sanctioned will not have impact on changing value of collateral whereas when VARIABLE "},{"name":"securedAmount","in":"query","type":"string","required":false,"description":"The total amount that has been covered by the collateral underlying the credit facility"},{"name":"multiCustomerLimit","in":"query","type":"string","required":false,"description":"Specifies if a credit facility shall be used by multiple customers"},{"name":"groupClass","in":"query","type":"string","required":false,"description":"Classify the type of group, whether it is a CUSTOMER.GROUP or SUB.GROUP"},{"name":"isAggregationExists","in":"query","type":"string","required":false,"description":"Indicates if there exists aggregation of one or many customer exposure under a primary customer"},{"name":"mainGroupId","in":"query","type":"string","required":false,"description":"Identifier of the main group under which the sub group has been defined"},{"name":"creditLineProduct","in":"query","type":"string","required":false,"description":"Identifier of the limit product of the topmost credit facility in the hierarchy"},{"name":"gvIndicator","in":"query","type":"string","required":false,"description":"Indicator which specifies the graphical view of risk exposure report requested"},{"name":"onlineLimit","in":"query","type":"string","required":false,"description":"The Limit amount that is actually available for use.The system limit checks are performed against the online limit"},{"name":"amountInUnits","in":"query","type":"string","required":false,"description":"Indicates the Units of the Amounts"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from t24 on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"CustomerGroupLimitsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/limits/relationships/{customerGroupId}","fullPath":"/api/v1.0.0/holdings/limits/relationships/{customerGroupId}","operationId":"getCustomerGroupRelations","name":"Retrieves all of the customer relation details such as party or customer id, type, name and aggregate customer details under a customer group.","summary":"Retrieves relations among customers","tags":[],"parameters":[{"name":"customerGroupId","in":"path","type":"string","required":true,"description":"Identifier of the CUSTOMER.GROUP that constitues one or more related customers which would be used while arrivnig collective risk exposure of credit line liable to them either individually or shared a"},{"name":"subGroup","in":"query","type":"string","required":false,"description":"Identifier of the sub group within a CUSTOMER.GROUP that constitues one or more related customers which would be used while arrivnig collective risk exposure of credit line liable to them either indiv"},{"name":"showReverseRelation","in":"query","type":"string","required":false,"description":"Indicates whether reverse relations among customer or entity are required"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from t24 on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"CustomerGroupRelationsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/limits/{customerId}","fullPath":"/api/v1.0.0/holdings/limits/{customerId}","operationId":"getCustomerLimits","name":"Retrieves a list of credit lines that the institution has sanctioned to any specific customer.","summary":"Retrieves Customer Credit Limits","tags":[],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"Identifier of the customer"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from t24 on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"CustomerLimitsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/limits/expiringLimits","fullPath":"/api/v1.0.0/holdings/limits/expiringLimits","operationId":"getExpiringLimits","name":"Retrieves the list of Credit Lines with details such as the Available and the Outstanding Limit Balances that are due for Expiry for a specific date","summary":"Retrieves list of Credit Lines that are due for Expiry","tags":[],"parameters":[{"name":"expiryDate","in":"query","type":"string","required":false,"description":"The date an agreement such as an arrangement, product, credit facility or limit is due to expire"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from t24 on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"ExpiringLimitsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/treasury/forex/limits/{liabilityNumber}","fullPath":"/api/v1.0.0/holdings/treasury/forex/limits/{liabilityNumber}","operationId":"getLimitsForexTradeSummary","name":"Retrieves the summary of Limit details such as Currency, Advised, Available and Utilised Limit Balance by Forex Contracts","summary":"Retrieves summary of customer's Forex Liability","tags":[],"parameters":[{"name":"liabilityNumber","in":"path","type":"string","required":true,"description":"Identifier of the Liability Customer to the credit limit"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from t24 on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"LimitsForexTradeSummaryResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/limits/customers/groups","fullPath":"/api/v1.0.0/holdings/limits/customers/groups","operationId":"getCustomerLimitGroups","name":"Retrieves the list of Customer under a Limit Sharing group or list of groups the specified customer is part of.","summary":"Retrieves Limit Sharing group of the customer","tags":[],"parameters":[{"name":"groupId","in":"query","type":"string","required":false,"description":"Unique ID of the group"},{"name":"customerId","in":"query","type":"string","required":false,"description":"Identifier of the customer"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from t24 on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"CustomerLimitGroupsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/limits/groups/{groupId}/allocations","fullPath":"/api/v1.0.0/holdings/limits/groups/{groupId}/allocations","operationId":"getLimitGroupAllocations","name":"Retrieves the list of Limit group alloction details such as Group Limit Reference, Contract Reference, total commitment, Utilised & remaining commitment balance of the Limits under the Limit Sharing Group","summary":"Retrieves Limit group alloction details","tags":[],"parameters":[{"name":"groupId","in":"path","type":"string","required":true,"description":"Unique ID of the group"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from t24 on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"LimitGroupAllocationsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/limits/customers/masterGroups","fullPath":"/api/v1.0.0/holdings/limits/customers/masterGroups","operationId":"getCustomerLimitMasterGroups","name":"Retrieves the Limit Sharing Master Group details such as list of customer in the group &  the sharing priority defined for the Customers","summary":"Retrieves Limit Sharing Master Group details","tags":[],"parameters":[{"name":"groupId","in":"query","type":"string","required":false,"description":"Unique ID of the group"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from t24 on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"CustomerLimitMasterGroupsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/limits/{limitId}/forexDeals","fullPath":"/api/v1.0.0/holdings/limits/{limitId}/forexDeals","operationId":"getLimitForexDeals","name":"Retrieves the details of Forex Contract Reference, buy & sell Currency, Amount associated with the Limit","summary":"Retrieves List of FOREX contract details available to the Limit","tags":[],"parameters":[{"name":"limitId","in":"path","type":"string","required":true,"description":"The identifier of credit limit"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from t24 on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"LimitForexDealsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/limits/{limitId}/liabilities","fullPath":"/api/v1.0.0/holdings/limits/{limitId}/liabilities","operationId":"getLimitForexLiabilities","name":"Retrieves the risk excess details of Forex contracts associated to a limit along with the Contract amount and limit balance","summary":"Retrieves risk Excess details of the Limits untilised by Forex contracts","tags":[],"parameters":[{"name":"limitId","in":"path","type":"string","required":true,"description":"The identifier of credit limit"},{"name":"limitReferenceId","in":"query","type":"string","required":false,"description":"Limit reference identifier for the limit order."},{"name":"serialNumber","in":"query","type":"string","required":false,"description":"A sequence reference for the limit, which when used together with other fields such as Liability Number and/or Limit Reference, provides a unique identifier for a credit line"},{"name":"customerNumber","in":"query","type":"string","required":false,"description":"Identifier of the Customer Number"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from t24 on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"LimitForexLiabilitiesResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/limits/sharedLimits","fullPath":"/api/v1.0.0/holdings/limits/sharedLimits","operationId":"getSharedLimits","name":"Retrieves the Master and Sub Group available in Limit Sharing Group details along with Limit Product and list of customer linked to the group","summary":"Retrieves Limit Sharing group details","tags":[],"parameters":[{"name":"groupId","in":"query","type":"string","required":false,"description":"Unique ID of the group"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from t24 on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"SharedLimitsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/limits/customers/{customerId}/sharingPriorities","fullPath":"/api/v1.0.0/holdings/limits/customers/{customerId}/sharingPriorities","operationId":"getCustomerLimitSharingPriorities","name":"Retrieves the Limit sharing Priority of the Master group for the specified group or Customer","summary":"Retrieves Limit sharing Priority","tags":[],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"Identifier of the customer"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from t24 on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"CustomerLimitSharingPrioritiesResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/limits/masterGroups/{masterGroupId}/subGroups","fullPath":"/api/v1.0.0/holdings/limits/masterGroups/{masterGroupId}/subGroups","operationId":"getLimitSubGroups","name":"Retrieves the list of Sub Groups available under a Master Group in Limit Sharing Group along with Limit Product & Customer linked to the Group","summary":"Retrieves details of limit sub groups","tags":[],"parameters":[{"name":"masterGroupId","in":"path","type":"string","required":true,"description":"Identifier of the Limit Sharing Master Group"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from t24 on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"LimitSubGroupsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/treasury/limits/{limitId}","fullPath":"/api/v1.0.0/holdings/treasury/limits/{limitId}","operationId":"getLimitSummary","name":"Retrieves the Limit details such as Advised, Available & Utilised, Outstanding balances for a specific Customer","summary":"Retrieves summary of Customer outstanding details","tags":[],"parameters":[{"name":"limitId","in":"path","type":"string","required":true,"description":"The identifier of credit limit"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from t24 on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"LimitSummaryResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/limits/{liabilityNumber}/overdrawnLimits","fullPath":"/api/v1.0.0/holdings/limits/{liabilityNumber}/overdrawnLimits","operationId":"getCustomerOverdrawnLimits","name":"Retrieves the list of credit Lines that are overdrawn or in excess of utilisation","summary":"Retrieves list of overdrawn Credit Limits","tags":[],"parameters":[{"name":"liabilityNumber","in":"path","type":"string","required":true,"description":"Identifier of the Liability Customer to the credit limit"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from t24 on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"CustomerOverdrawnLimitsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/limits/reviewLimits","fullPath":"/api/v1.0.0/holdings/limits/reviewLimits","operationId":"getLimitsToReviewToday","name":"Retrieves the list of Credit Limit details such as Advised, Available and the Outstanding Limit Balances that are due for Review for a specific date","summary":"Retrieves the Credit Lines that are due for review","tags":[],"parameters":[{"name":"liabilityNumber","in":"query","type":"string","required":false,"description":"Identifier of the Liability Customer to the credit limit"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from t24 on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"LimitsToReviewTodayResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/limits/{customerId}/subCategoryLimits/{customerGroupId}","fullPath":"/api/v1.0.0/holdings/limits/{customerId}/subCategoryLimits/{customerGroupId}","operationId":"getSubCategoryLimits","name":"Retrieves Category, SubCategory Limit Products and Timebands from the Credit Limit for the specified CustomerGroup and CustomerId Combination","summary":"Retrieves Customer Sub Category Limits","tags":[],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"Identifier of the customer"},{"name":"customerGroupId","in":"path","type":"string","required":true,"description":"Identifier of the CUSTOMER.GROUP that constitues one or more related customers which would be used while arrivnig collective risk exposure of credit line liable to them either individually or shared a"},{"name":"subGroup","in":"query","type":"string","required":false,"description":"Identifier of the sub group within a CUSTOMER.GROUP that constitues one or more related customers which would be used while arrivnig collective risk exposure of credit line liable to them either indiv"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from t24 on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"SubCategoryLimitsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/limits/{customerGroupId}/subGroups","fullPath":"/api/v1.0.0/holdings/limits/{customerGroupId}/subGroups","operationId":"getSubGroupList","name":"Retrieves list of Sub Group details such as sub group name, list of related customers Ids, Party Type under specific customer group","summary":"Retrieves list of Sub groups","tags":[],"parameters":[{"name":"customerGroupId","in":"path","type":"string","required":true,"description":"Identifier of the CUSTOMER.GROUP that constitues one or more related customers which would be used while arrivnig collective risk exposure of credit line liable to them either individually or shared a"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from t24 on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"SubGroupListResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/limits/{limitId}/subLimits","fullPath":"/api/v1.0.0/holdings/limits/{limitId}/subLimits","operationId":"getSubLimits","name":"Provides list of sub limits applicable for a credit line created based on risk elements of the contract.","summary":"Retrieves list of sublimits applicable for a credit line.","tags":[],"parameters":[{"name":"limitId","in":"path","type":"string","required":true,"description":"The identifier of credit limit"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from t24 on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"SubLimitsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/limits/collaterals","fullPath":"/api/v1.0.0/holdings/limits/collaterals","operationId":"getLimitCollaterals","name":"Retrieves all secured credit lines or one that has been sanctioned to a specific customer","summary":"Retrieves list of secured credit limits","tags":[],"parameters":[{"name":"liabilityNumber","in":"query","type":"string","required":false,"description":"Identifier of the Liability Customer to the credit limit"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from t24 on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"LimitCollateralsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"POST","path":"/holdings/limits/creditLimits","fullPath":"/api/v1.0.0/holdings/limits/creditLimits","operationId":"createCreditLimits","name":"Allows creation of credit limit for customer with information such as limit product, sanctioned amount, currency, expiry date and review frequency of limit","summary":"Creates a credit limit","tags":[],"parameters":[{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"notes":[{}],"limitDetails":[{}],"customerIds":[{}],"limitCurrency":"string","approvalDate":"string","offeredUntilDate":"string","limitReviewDate":"string","expiryDate":"string","onlineLimitDate":"string","lastDrawDate":"string","internalAmount":"string","advisedAmount":"string","availableMarker":"string","extensionDate":"string","onlineUpdate":"string"}},"responses":{"200":"CreditLimitsResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/holdings/limits/{limitId}/creditLimits","fullPath":"/api/v1.0.0/holdings/limits/{limitId}/creditLimits","operationId":"getLimitDetails","name":"Retrieves the details such as currency,expiry date, limit amount, available marker & limit type for the requested limit id.","summary":"Retrieves details of the limits","tags":[],"parameters":[{"name":"limitId","in":"path","type":"string","required":true,"description":"The identifier of credit limit"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"LimitDetailsResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/holdings/limits/{limitId}/creditLimits","fullPath":"/api/v1.0.0/holdings/limits/{limitId}/creditLimits","operationId":"updateCreditLimits","name":"Allows update of credit limit for customer with information such as sanctioned amount, expiry date, review frequency of limit","summary":"Updates a credit limit","tags":[],"parameters":[{"name":"limitId","in":"path","type":"string","required":true,"description":"The identifier of credit limit"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"notes":[{}],"limitDetails":[{}],"customerIds":[{}],"limitCurrency":"string","approvalDate":"string","offeredUntilDate":"string","limitReviewDate":"string","expiryDate":"string","onlineLimitDate":"string","lastDrawDate":"string","internalAmount":"string","advisedAmount":"string","availableMarker":"string","extensionDate":"string","onlineUpdate":"string"}},"responses":{"200":"CreditLimitsResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"DELETE","path":"/holdings/limits/{limitId}/creditLimits","fullPath":"/api/v1.0.0/holdings/limits/{limitId}/creditLimits","operationId":"deleteCreditLimits","name":"Allows deletion of credit limit that are either no more available for utilisation or not being utilized","summary":"Deletes a credit limit","tags":[],"parameters":[{"name":"limitId","in":"path","type":"string","required":true,"description":"The identifier of credit limit"},{"name":"payload","in":"body","type":"object","required":false,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}}},"responses":{"200":"CreditLimitsResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}}]},{"key":"holdings-limits-service-v1.1.0","title":"Limit liabilities and Forex limits","version":"v1.1.0","description":"API to manage credit limit related information such as retrieving limit utilisation or outstandings, limit cashflow, overdrawn limits, limits review & expiry, sublimit details and manage limit sharing group details of master and sub groups. ","endpointCount":25,"endpoints":[{"method":"GET","path":"/holdings/limits/{arrangementId}/limitCashflow","fullPath":"/api/v1.1.0/holdings/limits/{arrangementId}/limitCashflow","operationId":"getLimitCashflow","name":"Retrieves the facility cashflow against the limit, commitment and drawing schedules utilized","summary":"Retrieves limit cashflow details of contract","tags":[],"parameters":[{"name":"arrangementId","in":"path","type":"string","required":true,"description":"Indicates an unique identifier of an account"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from t24 on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"LimitCashflowResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/limits/customerGroupLimits","fullPath":"/api/v1.1.0/holdings/limits/customerGroupLimits","operationId":"getCustomerGroupLimits","name":"Retrieves all of the customer group limit exposures such as limit allocations, outstanding, product, expiry along with details of related customers in the group, related sub groups","summary":"Retrieves limit details of customer group","tags":[],"parameters":[{"name":"customerLimitId","in":"query","type":"string","required":false,"description":"Limit reference of the customer"},{"name":"riskGroupId","in":"query","type":"string","required":false,"description":"Identifier of the CUSTOMER.GROUP that constitutes one or more related customers which would be used while arrivnig collective risk exposure of credit line liable to them either individually or shared "},{"name":"liabilityNumber","in":"query","type":"string","required":false,"description":"Identifier of the Liability Customer to the credit limit"},{"name":"limitId","in":"query","type":"string","required":false,"description":"The identifier of credit limit"},{"name":"creditLineNumber","in":"query","type":"string","required":false,"description":"Details of the top most parent credit line plus the limit product in the hierarchy. Eg : 300/LI1701101987 where 300 is the limit product of the topmost parent and second part is the respective creditl"},{"name":"recordParent","in":"query","type":"string","required":false,"description":"Identifier of the immediate parent limit"},{"name":"limitProduct","in":"query","type":"string","required":false,"description":"Identifier of the credit limit product"},{"name":"serialNumber","in":"query","type":"string","required":false,"description":"A sequence reference for the limit, which when used together with other fields such as Liability Number and/or Limit Reference, provides a unique identifier for a credit line"},{"name":"limitCurrency","in":"query","type":"string","required":false,"description":"Currency in which the credit limit is granted"},{"name":"buisnessUnit","in":"query","type":"string","required":false,"description":"The identifier of the underlying Entity/Company/Branch."},{"name":"expiryDate","in":"query","type":"string","required":false,"description":"The date an agreement such as an arrangement, product, credit facility or limit is due to expire"},{"name":"timeBandName","in":"query","type":"string","required":false,"description":"Description of the individual time code under a credit facility"},{"name":"internalAmount","in":"query","type":"string","required":false,"description":"Indicates the amount allocated to the Credit Limit by the Bank"},{"name":"advisedAmount","in":"query","type":"string","required":false,"description":"Indicates the amount advised to the Credit Limit by the bank"},{"name":"outstandingAmount","in":"query","type":"string","required":false,"description":"Contains the aggregate outstanding principal amount thereof after giving effect to any borrowings and prepayments or repayments of Committed Loans"},{"name":"availableAmount","in":"query","type":"string","required":false,"description":"The credit limit available to the customer for use"},{"name":"availableOrExcess","in":"query","type":"string","required":false,"description":"The available amount for the corresponding liability number and limit reference. This amount is always expressed in the currency of the limit. Calculated as the sum of the online limit, the available "},{"name":"totalCommitment","in":"query","type":"string","required":false,"description":"Specifies the total available commitment amounts  specific to a credit facility"},{"name":"totalCredit","in":"query","type":"string","required":false,"description":"Indicates the total credit balance of the customer's account"},{"name":"totalDebit","in":"query","type":"string","required":false,"description":"Indicates the total debit balance of the customer's account"},{"name":"requestedCurrency","in":"query","type":"string","required":false,"description":"The currency the amount is requested in."},{"name":"exchangeRate","in":"query","type":"string","required":false,"description":"Contains the exchange rate returned from the system. i.e. For entries over foreign currency accounts, this contains the rate which used to convert the currency amount to the local equivalent at the ti"},{"name":"idlType","in":"query","type":"string","required":false,"description":"The INTRA.DAY.LIMIT type that is applicable for a specific credit facility of the customer"},{"name":"idlApprovedAmount","in":"query","type":"string","required":false,"description":"The approved amount by the bank as INTRA.DAY.LIMIT on a credit facility within a specific period of the day"},{"name":"idlAdvisedAmount","in":"query","type":"string","required":false,"description":"The advised amount by the bank to the customer as INTRA.DAY.LIMIT on a credit facility within a specific period of the day"},{"name":"limitType","in":"query","type":"string","required":false,"description":"Defines the limit type for the trade"},{"name":"relatedCustomer","in":"query","type":"string","required":false,"description":"Indicates the related customers of multi customer and joint limits"},{"name":"sharedLimit","in":"query","type":"string","required":false,"description":"Indicates whether the credit line is of shared limit structure"},{"name":"adjustAvailableAmount","in":"query","type":"string","required":false,"description":"Indicates to adjust the available funds to respective time bands."},{"name":"rebuildData","in":"query","type":"string","required":false,"description":"Indicates to rebuild the customer exposure when enquired by user."},{"name":"aggregateCustomerId","in":"query","type":"string","required":false,"description":"List of customer/person entity that are aggregated under a main customer on risk exposure view"},{"name":"aggregateCustomerRelation","in":"query","type":"string","required":false,"description":"Relation code that exists between the main customer and the aggregated customers"},{"name":"limitNote","in":"query","type":"string","required":false,"description":"Relation code that exists between the main customer and the aggregated customers"},{"name":"sessionId","in":"query","type":"string","required":false,"description":"Id of the T24 session where the risk exposure view executed"},{"name":"subGroup","in":"query","type":"string","required":false,"description":"Identifier of the sub group within a CUSTOMER.GROUP that constitues one or more related customers which would be used while arrivnig collective risk exposure of credit line liable to them either indiv"},{"name":"originalInternalAmount","in":"query","type":"string","required":false,"description":"Specifies the orignal amount actually approved or authorised on a credit line by Management or the Credit Committee before any repayment made"},{"name":"originalAdvisedAmount","in":"query","type":"string","required":false,"description":"Specifies the original amount advised to the customer holding the credit facility before any repayment made"},{"name":"repaidAmount","in":"query","type":"string","required":false,"description":"Indicates the amount which was repaid from the customer"},{"name":"totalRepaidAmount","in":"query","type":"string","required":false,"description":"Total of the repaid amount under a credit facility"},{"name":"excessFlag","in":"query","type":"string","required":false,"description":"Flag to indicate the credit line has been over utilised"},{"name":"fixedOrVariable","in":"query","type":"string","required":false,"description":"Indicates the secured nature of limit that has been covered by a customer collateral. When FIXED the limit amount sanctioned will not have impact on changing value of collateral whereas when VARIABLE "},{"name":"securedAmount","in":"query","type":"string","required":false,"description":"The total amount that has been covered by the collateral underlying the credit facility"},{"name":"multiCustomerLimit","in":"query","type":"string","required":false,"description":"Specifies if a credit facility shall be used by multiple customers"},{"name":"groupClass","in":"query","type":"string","required":false,"description":"Classify the type of group, whether it is a CUSTOMER.GROUP or SUB.GROUP"},{"name":"isAggregationExists","in":"query","type":"string","required":false,"description":"Indicates if there exists aggregation of one or many customer exposure under a primary customer"},{"name":"mainGroupId","in":"query","type":"string","required":false,"description":"Identifier of the main group under which the sub group has been defined"},{"name":"creditLineProduct","in":"query","type":"string","required":false,"description":"Identifier of the limit product of the topmost credit facility in the hierarchy"},{"name":"gvIndicator","in":"query","type":"string","required":false,"description":"Indicator which specifies the graphical view of risk exposure report requested"},{"name":"onlineLimit","in":"query","type":"string","required":false,"description":"The Limit amount that is actually available for use.The system limit checks are performed against the online limit"},{"name":"amountInUnits","in":"query","type":"string","required":false,"description":"Indicates the Units of the Amounts"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from t24 on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"CustomerGroupLimitsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/limits/relationships/{customerGroupId}","fullPath":"/api/v1.1.0/holdings/limits/relationships/{customerGroupId}","operationId":"getCustomerGroupRelations","name":"Retrieves all of the customer relation details such as party or customer id, type, name and aggregate customer details under a customer group.","summary":"Retrieves relations among customers","tags":[],"parameters":[{"name":"customerGroupId","in":"path","type":"string","required":true,"description":"Identifier of the CUSTOMER.GROUP that constitues one or more related customers which would be used while arrivnig collective risk exposure of credit line liable to them either individually or shared a"},{"name":"subGroup","in":"query","type":"string","required":false,"description":"Identifier of the sub group within a CUSTOMER.GROUP that constitues one or more related customers which would be used while arrivnig collective risk exposure of credit line liable to them either indiv"},{"name":"showReverseRelation","in":"query","type":"string","required":false,"description":"Indicates whether reverse relations among customer or entity are required"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from t24 on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"CustomerGroupRelationsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/limits/{customerId}","fullPath":"/api/v1.1.0/holdings/limits/{customerId}","operationId":"getCustomerLimits","name":"Retrieves a list of credit lines that the institution has sanctioned to any specific customer.","summary":"Retrieves customer credit limits","tags":[],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"Identifier of the customer"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from t24 on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"CustomerLimitsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/limits/expiringLimits","fullPath":"/api/v1.1.0/holdings/limits/expiringLimits","operationId":"getExpiringLimits","name":"Retrieves the list of credit lines with details such as the available and the outstanding limit balances that are due for expiry for a specific date","summary":"Retrieves list of credit lines that are due for expiry","tags":[],"parameters":[{"name":"expiryDate","in":"query","type":"string","required":false,"description":"The date an agreement such as an arrangement, product, credit facility or limit is due to expire"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from t24 on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"ExpiringLimitsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/treasury/forex/limits/{liabilityNumber}","fullPath":"/api/v1.1.0/holdings/treasury/forex/limits/{liabilityNumber}","operationId":"getLimitsForexTradeSummary","name":"Retrieves the summary of limit details such as currency, advised, available and utilised limit balance by forex contracts","summary":"Retrieves summary of customer's forex liability","tags":[],"parameters":[{"name":"liabilityNumber","in":"path","type":"string","required":true,"description":"Identifier of the Liability Customer to the credit limit"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from t24 on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"LimitsForexTradeSummaryResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/limits/customers/groups","fullPath":"/api/v1.1.0/holdings/limits/customers/groups","operationId":"getCustomerLimitGroups","name":"Retrieves the list of customer under a limit sharing group or list of groups the specified customer is part of.","summary":"Retrieves limit sharing group of the customer","tags":[],"parameters":[{"name":"groupId","in":"query","type":"string","required":false,"description":"Unique ID of the group"},{"name":"customerId","in":"query","type":"string","required":false,"description":"Identifier of the customer"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from t24 on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"CustomerLimitGroupsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/limits/groups/{groupId}/allocations","fullPath":"/api/v1.1.0/holdings/limits/groups/{groupId}/allocations","operationId":"getLimitGroupAllocations","name":"Retrieves the list of limit group alloction details such as group limit reference, contract reference, total commitment, utilised & remaining commitment balance of the limits under the limit sharing group","summary":"Retrieves limit group alloction details","tags":[],"parameters":[{"name":"groupId","in":"path","type":"string","required":true,"description":"Unique ID of the group"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from t24 on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"LimitGroupAllocationsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/limits/customers/masterGroups","fullPath":"/api/v1.1.0/holdings/limits/customers/masterGroups","operationId":"getCustomerLimitMasterGroups","name":"Retrieves the limit sharing master group details such as list of customer in the group &  the sharing priority defined for the customers","summary":"Retrieves limit sharing master group details","tags":[],"parameters":[{"name":"groupId","in":"query","type":"string","required":false,"description":"Unique ID of the group"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from t24 on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"CustomerLimitMasterGroupsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/limits/{limitId}/forexDeals","fullPath":"/api/v1.1.0/holdings/limits/{limitId}/forexDeals","operationId":"getLimitForexDeals","name":"Retrieves the details of Forex contract reference, buy & sell currency, amount associated with the limit","summary":"Retrieves list of Forex contract details available to the limit","tags":[],"parameters":[{"name":"limitId","in":"path","type":"string","required":true,"description":"The identifier of credit limit"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from t24 on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"LimitForexDealsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/limits/{limitId}/liabilities","fullPath":"/api/v1.1.0/holdings/limits/{limitId}/liabilities","operationId":"getLimitForexLiabilities","name":"Retrieves the risk excess details of Forex contracts associated to a limit along with the contract amount and limit balance","summary":"Retrieves risk excess details of the limits untilised by Forex contracts","tags":[],"parameters":[{"name":"limitId","in":"path","type":"string","required":true,"description":"The identifier of credit limit"},{"name":"limitReferenceId","in":"query","type":"string","required":false,"description":"Limit reference identifier for the limit order."},{"name":"serialNumber","in":"query","type":"string","required":false,"description":"A sequence reference for the limit, which when used together with other fields such as Liability Number and/or Limit Reference, provides a unique identifier for a credit line"},{"name":"customerNumber","in":"query","type":"string","required":false,"description":"Identifier of the Customer Number"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from t24 on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"LimitForexLiabilitiesResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/limits/sharedLimits","fullPath":"/api/v1.1.0/holdings/limits/sharedLimits","operationId":"getSharedLimits","name":"Retrieves the master and sub group available in limit sharing group details along with limit product and list of customer linked to the group","summary":"Retrieves limit sharing group details","tags":[],"parameters":[{"name":"groupId","in":"query","type":"string","required":false,"description":"Unique ID of the group"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from t24 on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"SharedLimitsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/limits/customers/{customerId}/sharingPriorities","fullPath":"/api/v1.1.0/holdings/limits/customers/{customerId}/sharingPriorities","operationId":"getCustomerLimitSharingPriorities","name":"Retrieves the limit sharing priority of the master group for the specified group or customer","summary":"Retrieves limit sharing priority","tags":[],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"Identifier of the customer"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from t24 on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"CustomerLimitSharingPrioritiesResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/limits/masterGroups/{masterGroupId}/subGroups","fullPath":"/api/v1.1.0/holdings/limits/masterGroups/{masterGroupId}/subGroups","operationId":"getLimitSubGroups","name":"Retrieves the list of sub groups available under a master group in limit sharing group along with limit product & customer linked to the group","summary":"Retrieves details of limit sub groups","tags":[],"parameters":[{"name":"masterGroupId","in":"path","type":"string","required":true,"description":"Identifier of the Limit Sharing Master Group"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from t24 on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"LimitSubGroupsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/treasury/limits/{limitId}","fullPath":"/api/v1.1.0/holdings/treasury/limits/{limitId}","operationId":"getLimitSummary","name":"Retrieves the limit details such as advised, available & utilised, outstanding balances for a specific customer","summary":"Retrieves summary of customer outstanding details","tags":[],"parameters":[{"name":"limitId","in":"path","type":"string","required":true,"description":"The identifier of credit limit"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from t24 on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"LimitSummaryResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/limits/{liabilityNumber}/overdrawnLimits","fullPath":"/api/v1.1.0/holdings/limits/{liabilityNumber}/overdrawnLimits","operationId":"getCustomerOverdrawnLimits","name":"Retrieves the list of credit lines that are overdrawn or in excess of utilisation","summary":"Retrieves list of overdrawn credit limits","tags":[],"parameters":[{"name":"liabilityNumber","in":"path","type":"string","required":true,"description":"Identifier of the Liability Customer to the credit limit"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from t24 on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"CustomerOverdrawnLimitsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/limits/reviewLimits","fullPath":"/api/v1.1.0/holdings/limits/reviewLimits","operationId":"getLimitsToReviewToday","name":"Retrieves the list of credit limit details such as advised, available and the outstanding limit balances that are due for review for a specific date","summary":"Retrieves the credit lines that are due for review","tags":[],"parameters":[{"name":"liabilityNumber","in":"query","type":"string","required":false,"description":"Identifier of the Liability Customer to the credit limit"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from t24 on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"LimitsToReviewTodayResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/limits/{customerId}/subCategoryLimits/{customerGroupId}","fullPath":"/api/v1.1.0/holdings/limits/{customerId}/subCategoryLimits/{customerGroupId}","operationId":"getSubCategoryLimits","name":"Retrieves category, subcategory limit products and timebands from the credit limit for the specified customer group and customerId combination","summary":"Retrieves customer sub category limits","tags":[],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"Identifier of the customer"},{"name":"customerGroupId","in":"path","type":"string","required":true,"description":"Identifier of the CUSTOMER.GROUP that constitues one or more related customers which would be used while arrivnig collective risk exposure of credit line liable to them either individually or shared a"},{"name":"subGroup","in":"query","type":"string","required":false,"description":"Identifier of the sub group within a CUSTOMER.GROUP that constitues one or more related customers which would be used while arrivnig collective risk exposure of credit line liable to them either indiv"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from t24 on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"SubCategoryLimitsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/limits/{customerGroupId}/subGroups","fullPath":"/api/v1.1.0/holdings/limits/{customerGroupId}/subGroups","operationId":"getSubGroupList","name":"Retrieves list of sub group details such as sub group name, list of related customersIds, party type under specific customer group","summary":"Retrieves list of sub groups","tags":[],"parameters":[{"name":"customerGroupId","in":"path","type":"string","required":true,"description":"Identifier of the CUSTOMER.GROUP that constitues one or more related customers which would be used while arrivnig collective risk exposure of credit line liable to them either individually or shared a"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from t24 on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"SubGroupListResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/limits/{limitId}/subLimits","fullPath":"/api/v1.1.0/holdings/limits/{limitId}/subLimits","operationId":"getSubLimits","name":"Provides list of sub limits applicable for a credit line created based on risk elements of the contract.","summary":"Retrieves list of sublimits applicable for a credit line.","tags":[],"parameters":[{"name":"limitId","in":"path","type":"string","required":true,"description":"The identifier of credit limit"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from t24 on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"SubLimitsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/limits/collaterals","fullPath":"/api/v1.1.0/holdings/limits/collaterals","operationId":"getLimitCollaterals","name":"Retrieves all secured credit lines or one that has been sanctioned to a specific customer","summary":"Retrieves list of secured credit limits","tags":[],"parameters":[{"name":"liabilityNumber","in":"query","type":"string","required":false,"description":"Identifier of the Liability Customer to the credit limit"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from t24 on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"LimitCollateralsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"POST","path":"/holdings/limits/creditLimits","fullPath":"/api/v1.1.0/holdings/limits/creditLimits","operationId":"createCreditLimits","name":"Allows creation of credit limit for customer with information such as limit product, sanctioned amount, currency, expiry date and review frequency of limit","summary":"Creates a credit limit","tags":[],"parameters":[{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"notes":[{}],"limitDetails":[{}],"customerIds":[{}],"collaterals":[{}],"limitCurrency":"string","approvalDate":"string","offeredUntilDate":"string","limitReviewDate":"string","expiryDate":"string","onlineLimitDate":"string","lastDrawDate":"string","internalAmount":"string","advisedAmount":"string","availableMarker":"string","extensionDate":"string"}},"responses":{"200":"CreditLimitsResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/holdings/limits/{limitId}/creditLimits","fullPath":"/api/v1.1.0/holdings/limits/{limitId}/creditLimits","operationId":"getLimitDetails","name":"Retrieves the details such as currency,expiry date, limit amount, available marker & limit type for the requested limit id.","summary":"Retrieves details of the limits","tags":[],"parameters":[{"name":"limitId","in":"path","type":"string","required":true,"description":"The identifier of credit limit"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"LimitDetailsResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/holdings/limits/{limitId}/creditLimits","fullPath":"/api/v1.1.0/holdings/limits/{limitId}/creditLimits","operationId":"updateCreditLimits","name":"Allows update of credit limit for customer with information such as sanctioned amount, expiry date, review frequency of limit","summary":"Updates a credit limit","tags":[],"parameters":[{"name":"limitId","in":"path","type":"string","required":true,"description":"The identifier of credit limit"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"notes":[{}],"limitDetails":[{}],"customerIds":[{}],"collaterals":[{}],"limitCurrency":"string","approvalDate":"string","offeredUntilDate":"string","limitReviewDate":"string","expiryDate":"string","onlineLimitDate":"string","lastDrawDate":"string","internalAmount":"string","advisedAmount":"string","availableMarker":"string","extensionDate":"string"}},"responses":{"200":"CreditLimitsResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"DELETE","path":"/holdings/limits/{limitId}/creditLimits","fullPath":"/api/v1.1.0/holdings/limits/{limitId}/creditLimits","operationId":"deleteCreditLimits","name":"Allows deletion of credit limit that are either no more available for utilisation or not being utilized","summary":"Deletes a credit limit","tags":[],"parameters":[{"name":"limitId","in":"path","type":"string","required":true,"description":"The identifier of credit limit"},{"name":"payload","in":"body","type":"object","required":false,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}}},"responses":{"200":"CreditLimitsResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}}]},{"key":"holdings-limits-service-v1.2.0","title":"Limit liabilities and Forex limits","version":"v1.2.0","description":"API to manage credit limit related information such as retrieving limit utilisation or outstandings, limit cashflow, overdrawn limits, limits review & expiry, sublimit details and manage limit sharing group details of master and sub groups. ","endpointCount":25,"endpoints":[{"method":"GET","path":"/holdings/limits/{arrangementId}/limitCashflow","fullPath":"/api/v1.0.0/holdings/limits/{arrangementId}/limitCashflow","operationId":"getLimitCashflow","name":"Retrieves the facility cashflow against the limit, commitment and drawing schedules utilized - Deprecated. Use holdings-creditLimits-service-v1.0.0 instead. New url- /holdings/creditLimits/limitCashflows/arrangements/{arrangementId}","summary":"Retrieves limit cashflow details of contract","tags":["RETAIL"],"parameters":[{"name":"arrangementId","in":"path","type":"string","required":true,"description":"Indicates an unique identifier of an account"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"","default":"","400":"","500":""}},{"method":"GET","path":"/holdings/limits/customerGroupLimits","fullPath":"/api/v1.0.0/holdings/limits/customerGroupLimits","operationId":"getCustomerGroupLimits","name":"Retrieves all of the customer group limit exposures such as limit allocations, outstanding, product, expiry along with details of related customers in the group, related sub groups - Deprecated. Use holdings-creditLimits-service-v1.0.0 instead. New url- /holdings/creditLimits/customerGroupLimits","summary":"Retrieves limit details of customer group","tags":["RETAIL"],"parameters":[{"name":"customerLimitId","in":"query","type":"string","required":false,"description":"Limit reference of the customer"},{"name":"riskGroupId","in":"query","type":"string","required":false,"description":"Identifier of the CUSTOMER.GROUP that constitutes one or more related customers which would be used while arrivnig collective risk exposure of credit line liable to them either individually or shared "},{"name":"liabilityNumber","in":"query","type":"string","required":false,"description":"Identifier of the Liability Customer to the credit limit"},{"name":"limitId","in":"query","type":"string","required":false,"description":"The identifier of credit limit"},{"name":"creditLineNumber","in":"query","type":"string","required":false,"description":"Details of the top most parent credit line plus the limit product in the hierarchy. Eg : 300/LI1701101987 where 300 is the limit product of the topmost parent and second part is the respective creditl"},{"name":"recordParent","in":"query","type":"string","required":false,"description":"Identifier of the immediate parent limit"},{"name":"limitProduct","in":"query","type":"string","required":false,"description":"Identifier of the credit limit product"},{"name":"serialNumber","in":"query","type":"string","required":false,"description":"A sequence reference for the limit, which when used together with other fields such as Liability Number and/or Limit Reference, provides a unique identifier for a credit line"},{"name":"limitCurrency","in":"query","type":"string","required":false,"description":"Currency in which the credit limit is granted"},{"name":"buisnessUnit","in":"query","type":"string","required":false,"description":"The identifier of the underlying Entity/Company/Branch."},{"name":"expiryDate","in":"query","type":"string","required":false,"description":"This indicates the  date  on which the offer or privilege terminates for the event."},{"name":"timeBandName","in":"query","type":"string","required":false,"description":"Description of the individual time code under a credit facility"},{"name":"internalAmount","in":"query","type":"string","required":false,"description":"Indicates the amount allocated to the Credit Limit by the Bank"},{"name":"advisedAmount","in":"query","type":"string","required":false,"description":"Indicates the amount advised to the Credit Limit by the bank"},{"name":"outstandingAmount","in":"query","type":"string","required":false,"description":"Contains the aggregate outstanding principal amount thereof after giving effect to any borrowings and prepayments or repayments of Committed Loans"},{"name":"availableAmount","in":"query","type":"string","required":false,"description":"The credit limit available to the customer for use"},{"name":"availableOrExcess","in":"query","type":"string","required":false,"description":"The available amount for the corresponding liability number and limit reference. This amount is always expressed in the currency of the limit. Calculated as the sum of the online limit, the available "},{"name":"totalCommitment","in":"query","type":"string","required":false,"description":"Specifies the total available commitment amounts  specific to a credit facility"},{"name":"totalCredit","in":"query","type":"string","required":false,"description":"Contains the total number of credits"},{"name":"totalDebit","in":"query","type":"string","required":false,"description":"Contains the total number of debits"},{"name":"requestedCurrency","in":"query","type":"string","required":false,"description":"The currency the amount is requested in."},{"name":"exchangeRate","in":"query","type":"string","required":false,"description":"Contains the exchange rate returned from the system. i.e. For entries over foreign currency accounts, this contains the rate which used to convert the currency amount to the local equivalent at the ti"},{"name":"idlType","in":"query","type":"string","required":false,"description":"The INTRA.DAY.LIMIT type that is applicable for a specific credit facility of the customer"},{"name":"idlApprovedAmount","in":"query","type":"string","required":false,"description":"The approved amount by the bank as INTRA.DAY.LIMIT on a credit facility within a specific period of the day"},{"name":"idlAdvisedAmount","in":"query","type":"string","required":false,"description":"The advised amount by the bank to the customer as INTRA.DAY.LIMIT on a credit facility within a specific period of the day"},{"name":"limitType","in":"query","type":"string","required":false,"description":"Defines the limit type for the trade"},{"name":"relatedCustomer","in":"query","type":"string","required":false,"description":"Indicates the related customers of multi customer and joint limits"},{"name":"sharedLimit","in":"query","type":"string","required":false,"description":"Indicates whether the credit line is of shared limit structure"},{"name":"adjustAvailableAmount","in":"query","type":"string","required":false,"description":"Indicates to adjust the available funds to respective time bands."},{"name":"rebuildData","in":"query","type":"string","required":false,"description":"Indicates to rebuild the customer exposure when enquired by user."},{"name":"aggregateCustomerId","in":"query","type":"string","required":false,"description":"List of customer/person entity that are aggregated under a main customer on risk exposure view"},{"name":"aggregateCustomerRelation","in":"query","type":"string","required":false,"description":"Relation code that exists between the main customer and the aggregated customers"},{"name":"limitNote","in":"query","type":"string","required":false,"description":"Indicates the user defined free text information regarding the limit"},{"name":"sessionId","in":"query","type":"string","required":false,"description":"Id of the T24 session where the risk exposure view executed"},{"name":"subGroup","in":"query","type":"string","required":false,"description":"Identifier of the Limit Sharing Sub Group"},{"name":"originalInternalAmount","in":"query","type":"string","required":false,"description":"Specifies the orignal amount actually approved or authorised on a credit line by Management or the Credit Committee before any repayment made"},{"name":"originalAdvisedAmount","in":"query","type":"string","required":false,"description":"Specifies the original amount advised to the customer holding the credit facility before any repayment made"},{"name":"repaidAmount","in":"query","type":"string","required":false,"description":"Indicates the amount which was repaid from the customer"},{"name":"totalRepaidAmount","in":"query","type":"string","required":false,"description":"Total of the repaid amount under a credit facility"},{"name":"excessFlag","in":"query","type":"string","required":false,"description":"Flag to indicate the credit line has been over utilised"},{"name":"fixedOrVariable","in":"query","type":"string","required":false,"description":"Indicates the secured nature of limit that has been covered by a customer collateral. When FIXED the limit amount sanctioned will not have impact on changing value of collateral whereas when VARIABLE "},{"name":"securedAmount","in":"query","type":"string","required":false,"description":"The total amount that has been covered by the collateral underlying the credit facility"},{"name":"multiCustomerLimit","in":"query","type":"string","required":false,"description":"Specifies if a credit facility shall be used by multiple customers"},{"name":"groupClass","in":"query","type":"string","required":false,"description":"Classify the type of group, whether it is a CUSTOMER.GROUP or SUB.GROUP"},{"name":"isAggregationExists","in":"query","type":"string","required":false,"description":"Indicates if there exists aggregation of one or many customer exposure under a primary customer"},{"name":"mainGroupId","in":"query","type":"string","required":false,"description":"Identifier of the main group under which the sub group has been defined"},{"name":"creditLineProduct","in":"query","type":"string","required":false,"description":"Identifier of the limit product of the topmost credit facility in the hierarchy"},{"name":"gvIndicator","in":"query","type":"string","required":false,"description":"Indicator which specifies the graphical view of risk exposure report requested"},{"name":"onlineLimit","in":"query","type":"string","required":false,"description":"The Limit amount that is actually available for use.The system limit checks are performed against the online limit"},{"name":"amountInUnits","in":"query","type":"string","required":false,"description":"Indicates the Units of the Amounts"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"","default":"","400":"","500":""}},{"method":"GET","path":"/holdings/limits/relationships/{customerGroupId}","fullPath":"/api/v1.0.0/holdings/limits/relationships/{customerGroupId}","operationId":"getCustomerGroupRelations","name":"Retrieves all of the customer relation details such as party or customer id, type, name and aggregate customer details under a customer group - Deprecated. Use holdings-creditLimits-service-v1.0.0 instead. New url- /holdings/creditLimits/relationships/{customerGroupId}","summary":"Retrieves relations among customers","tags":["RETAIL"],"parameters":[{"name":"customerGroupId","in":"path","type":"string","required":true,"description":"Identifier of the CUSTOMER.GROUP that constitues one or more related customers which would be used while arrivnig collective risk exposure of credit line liable to them either individually or shared a"},{"name":"subGroup","in":"query","type":"string","required":false,"description":"Identifier of the Limit Sharing Sub Group"},{"name":"showReverseRelation","in":"query","type":"string","required":false,"description":"Indicates whether reverse relations among customer or entity are required"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"","default":"","400":"","500":""}},{"method":"GET","path":"/holdings/limits/{customerId}","fullPath":"/api/v1.0.0/holdings/limits/{customerId}","operationId":"getCustomerLimits","name":"Retrieves a list of credit lines that the institution has sanctioned to any specific customer - Deprecated. Use holdings-creditLimits-service-v1.0.0 instead. New url- /holdings/creditLimits/limits(getLimitList) or /holdings/creditLimits/limits/pendingApprovals(getUnapprovedLimits)","summary":"Retrieves customer credit limits","tags":["RETAIL"],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"Identifier of the customer"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"","default":"","400":"","500":""}},{"method":"GET","path":"/holdings/limits/expiringLimits","fullPath":"/api/v1.0.0/holdings/limits/expiringLimits","operationId":"getExpiringLimits","name":"Retrieves the list of credit lines with details such as the available and the outstanding limit balances that are due for expiry for a specific date - Deprecated. Use holdings-creditLimits-service-v1.0.0 instead. New url- /holdings/creditLimits/limits/expiredLimits","summary":"Retrieves list of credit lines that are due for expiry","tags":["RETAIL"],"parameters":[{"name":"expiryDate","in":"query","type":"string","required":false,"description":"This indicates the  date  on which the offer or privilege terminates for the event."},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"","default":"","400":"","500":""}},{"method":"GET","path":"/holdings/treasury/forex/limits/{liabilityNumber}","fullPath":"/api/v1.0.0/holdings/treasury/forex/limits/{liabilityNumber}","operationId":"getLimitsForexTradeSummary","name":"Retrieves the summary of limit details such as currency, advised, available and utilised limit balance by Forex contracts - Deprecated. Use holdings-creditLimits-service-v1.0.0 instead. New url- /holdings/creditLimits/liabilities/{liabilityNumber}/forexDeals","summary":"Retrieves summary of customer's Forex liability","tags":["RETAIL"],"parameters":[{"name":"liabilityNumber","in":"path","type":"string","required":true,"description":"Identifier of the Liability Customer to the credit limit"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"","default":"","400":"","500":""}},{"method":"GET","path":"/holdings/limits/customers/groups","fullPath":"/api/v1.0.0/holdings/limits/customers/groups","operationId":"getCustomerLimitGroups","name":"Retrieves the list of customer under a limit sharing group or list of groups the specified customer is part of - Deprecated. Use holdings-creditLimits-service-v1.0.0 instead. New url- /holdings/creditLimits/customers/groups","summary":"Retrieves limit sharing group of the customer","tags":["RETAIL"],"parameters":[{"name":"groupId","in":"query","type":"string","required":false,"description":"Unique ID of the group"},{"name":"customerId","in":"query","type":"string","required":false,"description":"Identifier of the customer"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"","default":"","400":"","500":""}},{"method":"GET","path":"/holdings/limits/groups/{groupId}/allocations","fullPath":"/api/v1.0.0/holdings/limits/groups/{groupId}/allocations","operationId":"getLimitGroupAllocations","name":"Retrieves the list of limit group alloction details such as group limit reference, contract reference, total commitment, utilised & remaining commitment balance of the limits under the limit sharing group - Deprecated. Use holdings-creditLimits-service-v1.0.0 instead. New url- /holdings/creditLimits/groups/{groupId}/allocations","summary":"Retrieves limit group alloction details","tags":["RETAIL"],"parameters":[{"name":"groupId","in":"path","type":"string","required":true,"description":"Unique ID of the group"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"","default":"","400":"","500":""}},{"method":"GET","path":"/holdings/limits/customers/masterGroups","fullPath":"/api/v1.0.0/holdings/limits/customers/masterGroups","operationId":"getCustomerLimitMasterGroups","name":"Retrieves the limit sharing master group details such as list of customer in the group & the sharing priority defined for the customers - Deprecated. Use holdings-creditLimits-service-v1.0.0 instead. New url- /holdings/creditLimits/customers/masterGroups","summary":"Retrieves limit sharing master group details","tags":["RETAIL"],"parameters":[{"name":"groupId","in":"query","type":"string","required":false,"description":"Unique ID of the group"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"","default":"","400":"","500":""}},{"method":"GET","path":"/holdings/limits/{limitId}/forexDeals","fullPath":"/api/v1.0.0/holdings/limits/{limitId}/forexDeals","operationId":"getLimitForexDeals","name":"Retrieves the details of Forex contract reference, buy & sell currency, amount associated with the limit - Deprecated. Use holdings-creditLimits-service-v1.0.0 instead. New url- /holdings/creditLimits/{limitId}/forexDeals","summary":"Retrieves list of Forex contract details available to the limit","tags":["RETAIL"],"parameters":[{"name":"limitId","in":"path","type":"string","required":true,"description":"The identifier of credit limit"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"","default":"","400":"","500":""}},{"method":"GET","path":"/holdings/limits/{limitId}/liabilities","fullPath":"/api/v1.0.0/holdings/limits/{limitId}/liabilities","operationId":"getLimitForexLiabilities","name":"Retrieves the risk excess details of Forex contracts associated to a limit along with the contract amount and limit balance - Deprecated. Use holdings-creditLimits-service-v1.0.0 instead. New url- /holdings/creditLimits/{limitId}/liabilities/forexDeals","summary":"Retrieves risk excess details of the limits untilised by Forex contracts","tags":["RETAIL"],"parameters":[{"name":"limitId","in":"path","type":"string","required":true,"description":"The identifier of credit limit"},{"name":"limitReferenceId","in":"query","type":"string","required":false,"description":"Limit reference identifier for the limit order."},{"name":"serialNumber","in":"query","type":"string","required":false,"description":"A sequence reference for the limit, which when used together with other fields such as Liability Number and/or Limit Reference, provides a unique identifier for a credit line"},{"name":"customerNumber","in":"query","type":"string","required":false,"description":"Identifier of the customer"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"","default":"","400":"","500":""}},{"method":"GET","path":"/holdings/limits/sharedLimits","fullPath":"/api/v1.0.0/holdings/limits/sharedLimits","operationId":"getSharedLimits","name":"Retrieves the master and sub group available in limit sharing group details along with limit product and list of customer linked to the group - Deprecated. Use holdings-creditLimits-service-v1.0.0 instead. New url- /holdings/creditLimits/sharedLimits","summary":"Retrieves limit sharing group details","tags":["RETAIL"],"parameters":[{"name":"groupId","in":"query","type":"string","required":false,"description":"Unique ID of the group"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"","default":"","400":"","500":""}},{"method":"GET","path":"/holdings/limits/customers/{customerId}/sharingPriorities","fullPath":"/api/v1.0.0/holdings/limits/customers/{customerId}/sharingPriorities","operationId":"getCustomerLimitSharingPriorities","name":"Retrieves the limit sharing priority of the master group for the specified group or customer - Deprecated. Use holdings-creditLimits-service-v1.0.0 instead. New url- /holdings/creditLimits/customers/{customerId}/sharingPriorities","summary":"Retrieves limit sharing priority","tags":["RETAIL"],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"Identifier of the customer"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"","default":"","400":"","500":""}},{"method":"GET","path":"/holdings/limits/masterGroups/{masterGroupId}/subGroups","fullPath":"/api/v1.0.0/holdings/limits/masterGroups/{masterGroupId}/subGroups","operationId":"getLimitSubGroups","name":"Retrieves the list of sub groups available under a master group in limit sharing group along with limit product & customer linked to the group - Deprecated. Use holdings-creditLimits-service-v1.0.0 instead. New url- /holdings/creditLimits/masterGroups/{masterGroupId}/subGroups","summary":"Retrieves details of limit sub groups","tags":["RETAIL"],"parameters":[{"name":"masterGroupId","in":"path","type":"string","required":true,"description":"Identifier of the Limit Sharing Master Group"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"","default":"","400":"","500":""}},{"method":"GET","path":"/holdings/treasury/limits/{limitId}","fullPath":"/api/v1.0.0/holdings/treasury/limits/{limitId}","operationId":"getLimitSummary","name":"Retrieves the limit details such as advised, available & utilised, outstanding balances for a specific customer - Deprecated. Use holdings-creditLimits-service-v1.0.0 instead. New url- /holdings/creditLimits/{limitId}/liabilities","summary":"Retrieves summary of customer outstanding details","tags":["RETAIL"],"parameters":[{"name":"limitId","in":"path","type":"string","required":true,"description":"The identifier of credit limit"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"","default":"","400":"","500":""}},{"method":"GET","path":"/holdings/limits/{liabilityNumber}/overdrawnLimits","fullPath":"/api/v1.0.0/holdings/limits/{liabilityNumber}/overdrawnLimits","operationId":"getCustomerOverdrawnLimits","name":"Retrieves the list of credit lines that are overdrawn or in excess of utilisation - Deprecated. Use holdings-creditLimits-service-v1.0.0 instead. New url- /holdings/creditLimits/{liabilityNumber}/overdrawnLimits","summary":"Retrieves list of overdrawn credit limits","tags":["RETAIL"],"parameters":[{"name":"liabilityNumber","in":"path","type":"string","required":true,"description":"Identifier of the Liability Customer to the credit limit"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"","default":"","400":"","500":""}},{"method":"GET","path":"/holdings/limits/reviewLimits","fullPath":"/api/v1.0.0/holdings/limits/reviewLimits","operationId":"getLimitsToReviewToday","name":"Retrieves the list of credit limit details such as advised, available and the outstanding limit balances that are due for review for a specific date - Deprecated. Use holdings-creditLimits-service-v1.0.0 instead. New url- /holdings/creditLimits/limits/assessments","summary":"Retrieves the credit lines that are due for review","tags":["RETAIL"],"parameters":[{"name":"liabilityNumber","in":"query","type":"string","required":false,"description":"Identifier of the Liability Customer to the credit limit"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"","default":"","400":"","500":""}},{"method":"GET","path":"/holdings/limits/{customerId}/subCategoryLimits/{customerGroupId}","fullPath":"/api/v1.0.0/holdings/limits/{customerId}/subCategoryLimits/{customerGroupId}","operationId":"getSubCategoryLimits","name":"Retrieves category, subcategory limit products and timebands from the credit limit for the specified customer group and customerId combination - Deprecated. Use holdings-creditLimits-service-v1.0.0 instead. New url- /holdings/creditLimits/{customerId}/subCategoryLimits/{customerGroupId}","summary":"Retrieves customer sub category limits","tags":["RETAIL"],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"Identifier of the customer"},{"name":"customerGroupId","in":"path","type":"string","required":true,"description":"Identifier of the CUSTOMER.GROUP that constitues one or more related customers which would be used while arrivnig collective risk exposure of credit line liable to them either individually or shared a"},{"name":"subGroup","in":"query","type":"string","required":false,"description":"Identifier of the Limit Sharing Sub Group"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"","default":"","400":"","500":""}},{"method":"GET","path":"/holdings/limits/{customerGroupId}/subGroups","fullPath":"/api/v1.0.0/holdings/limits/{customerGroupId}/subGroups","operationId":"getSubGroupList","name":"Retrieves list of sub group details such as sub group name, list of related customers ids, party type under specific customer group - Deprecated. Use holdings-creditLimits-service-v1.0.0 instead. New url- /holdings/creditLimits/{customerGroupId}/subGroups","summary":"Retrieves list of sub groups","tags":["RETAIL"],"parameters":[{"name":"customerGroupId","in":"path","type":"string","required":true,"description":"Identifier of the CUSTOMER.GROUP that constitues one or more related customers which would be used while arrivnig collective risk exposure of credit line liable to them either individually or shared a"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"","default":"","400":"","500":""}},{"method":"GET","path":"/holdings/limits/{limitId}/subLimits","fullPath":"/api/v1.0.0/holdings/limits/{limitId}/subLimits","operationId":"getSubLimits","name":"Provides list of sub limits applicable for a credit line created based on risk elements of the contract - Deprecated. Use holdings-creditLimits-service-v1.0.0 instead. New url- /holdings/creditLimits/{limitId}/subLimits","summary":"Retrieves list of sublimits applicable for a credit line.","tags":["RETAIL"],"parameters":[{"name":"limitId","in":"path","type":"string","required":true,"description":"The identifier of credit limit"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"","default":"","400":"","500":""}},{"method":"GET","path":"/holdings/limits/collaterals","fullPath":"/api/v1.0.0/holdings/limits/collaterals","operationId":"getLimitCollaterals","name":"Retrieves all secured credit lines or one that has been sanctioned to a specific customer - Deprecated. Use holdings-creditLimits-service-v1.0.0 instead. New url- /holdings/creditLimits/collaterals","summary":"Retrieves list of secured credit limits","tags":["RETAIL"],"parameters":[{"name":"liabilityNumber","in":"query","type":"string","required":false,"description":"Identifier of the Liability Customer to the credit limit"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"","default":"","400":"","500":""}},{"method":"POST","path":"/holdings/limits/creditLimits","fullPath":"/api/v1.0.0/holdings/limits/creditLimits","operationId":"createCreditLimits","name":"Allows creation of credit limit for customer with information such as limit product, sanctioned amount, currency, expiry date and review frequency of limit - Deprecated. Use holdings-creditLimits-service-v1.0.0 instead. New url- /holdings/creditLimits/limits/unsecuredLimits(createUnsecuredLimits) or /holdings/creditLimits/limits/securedLimits(createSecuredLimits)","summary":"Creates a credit limit","tags":["RETAIL"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"","default":"","400":"","500":""}},{"method":"GET","path":"/holdings/limits/{limitId}/creditLimits","fullPath":"/api/v1.0.0/holdings/limits/{limitId}/creditLimits","operationId":"getLimitDetails","name":"Retrieves the details such as currency,expiry date, limit amount, available marker & limit type for the requested limit identifier - Deprecated. Use holdings-creditLimits-service-v1.0.0 instead. New url- /holdings/creditLimits/limits/{limitId}","summary":"Retrieves details of the limits","tags":["RETAIL"],"parameters":[{"name":"limitId","in":"path","type":"string","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"","default":"","400":"","500":""}},{"method":"PUT","path":"/holdings/limits/{limitId}/creditLimits","fullPath":"/api/v1.0.0/holdings/limits/{limitId}/creditLimits","operationId":"updateCreditLimits","name":"Allows update of credit limit for customer with information such as sanctioned amount, expiry date, review frequency of limit - Deprecated. Use holdings-creditLimits-service-v1.0.0 instead. New url- /holdings/creditLimits/limits/{limitId}/unsecuredLimits(updateUnsecuredLimits) or /holdings/creditLimits/limits/{limitId}/securedLimits(updateSecuredLimits) or /holdings/creditLimits/limits/{limitId}/limitAmounts(updateLimitAmounts)","summary":"Updates a credit limit","tags":["RETAIL"],"parameters":[{"name":"limitId","in":"path","type":"string","required":true,"description":"The identifier of credit limit"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"","default":"","400":"","500":""}},{"method":"DELETE","path":"/holdings/limits/{limitId}/creditLimits","fullPath":"/api/v1.0.0/holdings/limits/{limitId}/creditLimits","operationId":"deleteCreditLimits","name":"Allows deletion of credit limit that are either no more available for utilisation or not being utilized - Deprecated. Use holdings-creditLimits-service-v1.0.0 instead. New url- /holdings/creditLimits/limits/{limitId}(deleteUnapprovedLimit) or /holdings/creditLimits/limits/{limitId}/cancellations(cancelLimit)","summary":"Deletes a credit limit","tags":["RETAIL"],"parameters":[{"name":"limitId","in":"path","type":"string","required":true,"description":"The identifier of credit limit"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"","default":"","400":"","500":""}}]},{"key":"holdings-limitsManagement-v1.0.0","title":"Limits Management APIS","version":"v1.0.0","description":"To enable user to view product, intraday, stoploss and overnight limit utilisations and transactions affecting the configured limits","endpointCount":8,"endpoints":[{"method":"GET","path":"/holdings/limits/products/dealerLimits","fullPath":"/api/v1.0.0/holdings/limits/products/dealerLimits","operationId":"getProductDealerLimit","name":"Retrieve the dealer-specific product limits set and utilized","summary":"Retrieve the dealer-specific product limits set and utilized","tags":[],"parameters":[{"name":"dealerDesk","in":"query","type":"string","required":false,"description":"The dealer/desk responsible for monitoring and managing the currency positions."},{"name":"limitReference","in":"query","type":"string","required":false,"description":"Identifies the credit limit reference for the underlying account."},{"name":"limitCurrency","in":"query","type":"string","required":false,"description":"Currency in which the credit limit is granted"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"ProductDealerLimitResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/limits/products/transactions","fullPath":"/api/v1.0.0/holdings/limits/products/transactions","operationId":"getDealerLimitTransactions","name":"To view the transactions which are causing the limits utilization for dealer-specific product limits set.","summary":"To view the transactions which are causing the limits utilization for dealer-specific product limits set.","tags":[],"parameters":[{"name":"dealerDesk","in":"query","type":"string","required":true,"description":"The dealer/desk responsible for monitoring and managing the currency positions."},{"name":"limitReference","in":"query","type":"string","required":true,"description":"Identifies the credit limit reference for the underlying account."},{"name":"currency","in":"query","type":"string","required":true,"description":"Identifies the currency. E.g. USD, GBP etc"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"DealerLimitTransactionsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/limits/intraday/dealerLimits","fullPath":"/api/v1.0.0/holdings/limits/intraday/dealerLimits","operationId":"getDealerIntradayCurrencyLimit","name":"To view the dealer specific intraday limits set and utilised","summary":"To view the dealer specific intraday limits set and utilised","tags":[],"parameters":[{"name":"companyId","in":"query","type":"string","required":true,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"limitCurrency","in":"query","type":"string","required":true,"description":"Currency in which the credit limit is granted"},{"name":"dealerDesk","in":"query","type":"string","required":false,"description":"The dealer/desk responsible for monitoring and managing the currency positions."},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"DealerIntradayCurrencyLimitResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/currencies/{currency}/deals","fullPath":"/api/v1.0.0/holdings/currencies/{currency}/deals","operationId":"getTreasuryCurrencyPositionDeals","name":"To view the transactions which is contributing to the intraday/ overnight limit utilisation","summary":"To view the transactions which is contributing to the intraday/ overnight limit utilisation","tags":[],"parameters":[{"name":"currency","in":"path","type":"string","required":true,"description":"Identifies the currency. E.g. USD, GBP etc"},{"name":"company","in":"query","type":"string","required":false,"description":"The company code"},{"name":"positionType","in":"query","type":"string","required":false,"description":"Identifies the position type. Possible values are CAS(cash position), GAP(Interest mismatch position), FXP(Foreign exchange position)"},{"name":"dealerDesk","in":"query","type":"string","required":false,"description":"The dealer/desk responsible for monitoring and managing the currency positions."},{"name":"valueDate","in":"query","type":"string","required":false,"description":"Indicates the value date on which the underlying accounting entry is to be given value (for interest purposes)"},{"name":"dealDate","in":"query","type":"string","required":false,"description":"Date on which the deal was agreed. "},{"name":"period","in":"query","type":"string","required":false,"description":"Indicates spread of time buckets.Ex: 3M,6M,9M,10Y etc."},{"name":"application","in":"query","type":"string","required":true,"description":"Name of the application or virtual table"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"TreasuryCurrencyPositionDealsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/limits/overnight/dealerLimits","fullPath":"/api/v1.0.0/holdings/limits/overnight/dealerLimits","operationId":"getDealerOvernightExposure","name":"To view the dealer-specific overnight limits set and utilized","summary":"To view the dealer-specific overnight limits set and utilized","tags":[],"parameters":[{"name":"companyId","in":"query","type":"string","required":true,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"limitCurrency","in":"query","type":"string","required":true,"description":"Currency in which the credit limit is granted"},{"name":"dealerDesk","in":"query","type":"string","required":false,"description":"The dealer/desk responsible for monitoring and managing the currency positions."},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"DealerOvernightExposureResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/limits/overnight/dealerLimits/timeBands","fullPath":"/api/v1.0.0/holdings/limits/overnight/dealerLimits/timeBands","operationId":"getDealerTimebandOvernightExposure","name":"To view the dealer-specific overnight limits set for a predefined periods.","summary":"To view the dealer-specific overnight limits set for a predefined periods.","tags":[],"parameters":[{"name":"companyId","in":"query","type":"string","required":true,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"limitCurrency","in":"query","type":"string","required":true,"description":"Currency in which the credit limit is granted"},{"name":"dealerDesk","in":"query","type":"string","required":false,"description":"The dealer/desk responsible for monitoring and managing the currency positions."},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"DealerTimebandOvernightExposureResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/limits/stoploss/dealerLimits","fullPath":"/api/v1.0.0/holdings/limits/stoploss/dealerLimits","operationId":"getDealerStopLossExposure","name":"To view the dealer-specific stop loss limits set and utilized","summary":"To view the dealer-specific stop loss limits set and utilized","tags":[],"parameters":[{"name":"revaluation","in":"query","type":"string","required":false,"description":"Indicates whether the currency position is revalued online against the local currency to generate."},{"name":"user","in":"query","type":"string","required":false,"description":"The user who created the project"},{"name":"dealerDesk","in":"query","type":"string","required":false,"description":"The dealer/desk responsible for monitoring and managing the currency positions."},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"DealerStopLossExposureResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/limits/stoploss/transactions","fullPath":"/api/v1.0.0/holdings/limits/stoploss/transactions","operationId":"getStopLossTransactions","name":"To view the transactions which contributes to limits utilization for dealer-specific stop loss defined.","summary":"To view the transactions which contributes to limits utilization for dealer-specific stop loss defined.","tags":[],"parameters":[{"name":"dealerDesk","in":"query","type":"string","required":false,"description":"The dealer/desk responsible for monitoring and managing the currency positions."},{"name":"currency","in":"query","type":"string","required":false,"description":"Identifies the currency. E.g. USD, GBP etc"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"StopLossTransactionsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}}]},{"key":"holdings-loans-arrangements-v3.0.0","title":"Loan creation","version":"v3.0.0","description":"API to create and Manage various types of loans such as Personal, Commercial, Mortgage, Line of Credit, etc","endpointCount":30,"endpoints":[{"method":"POST","path":"/holdings/loans/personalLoans","fullPath":"/api/v3.0.0/holdings/loans/personalLoans","operationId":"createPersonalLoan","name":"Create a Personal Loan Account","summary":"Create a Personal Loan Account","tags":[],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"partyIds":[{}],"partyRoles":[{}],"agentCustomerIds":[{}],"agentArrangementIds":[{}],"agentRoles":[{}],"arrangmentId":"string","productId":"string","activityId":"string","currency":"string","productVariation":"string","pricingSelection":"string","pricingPlan":"string","rewardsArrangementId":"string","tradeDate":"string","arrangementEffectiveDate":"string"}},"responses":{"200":"createPersonalLoanResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"POST","path":"/holdings/loans/linkedRateLoans","fullPath":"/api/v3.0.0/holdings/loans/linkedRateLoans","operationId":"createLinkedRateLoan","name":"Create a Personal Loan account with Linked rate","summary":"Create a Personal Loan account with Linked rate","tags":[],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"partyIds":[{}],"partyRoles":[{}],"agentCustomerIds":[{}],"agentArrangementIds":[{}],"agentRoles":[{}],"arrangmentId":"string","productId":"string","activityId":"string","currency":"string","productVariation":"string","pricingSelection":"string","pricingPlan":"string","rewardsArrangementId":"string","tradeDate":"string","arrangementEffectiveDate":"string"}},"responses":{"200":"createLinkedRateLoanResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"POST","path":"/holdings/loans/commercialLoans","fullPath":"/api/v3.0.0/holdings/loans/commercialLoans","operationId":"createCommercialLoan","name":"Create a Commercial or Business Account","summary":"Create a Commercial or Business Account","tags":[],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"partyIds":[{}],"partyRoles":[{}],"agentCustomerIds":[{}],"agentArrangementIds":[{}],"agentRoles":[{}],"arrangmentId":"string","productId":"string","activityId":"string","currency":"string","productVariation":"string","pricingSelection":"string","pricingPlan":"string","rewardsArrangementId":"string","tradeDate":"string","arrangementEffectiveDate":"string"}},"responses":{"200":"createCommercialLoanResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"POST","path":"/holdings/loans/mortgages","fullPath":"/api/v3.0.0/holdings/loans/mortgages","operationId":"createMortgage","name":"Create a Mortgage Loan","summary":"Create a Mortgage Loan","tags":[],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"partyIds":[{}],"partyRoles":[{}],"agentCustomerIds":[{}],"agentArrangementIds":[{}],"agentRoles":[{}],"arrangmentId":"string","productId":"string","activityId":"string","currency":"string","productVariation":"string","pricingSelection":"string","pricingPlan":"string","rewardsArrangementId":"string","tradeDate":"string","arrangementEffectiveDate":"string"}},"responses":{"200":"createMortgageResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"POST","path":"/holdings/loans/creditLines","fullPath":"/api/v3.0.0/holdings/loans/creditLines","operationId":"createCreditLine","name":"Create a Lines of Credit Account","summary":"Create a Lines of Credit Account","tags":[],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"partyIds":[{}],"partyRoles":[{}],"agentCustomerIds":[{}],"agentArrangementIds":[{}],"agentRoles":[{}],"arrangmentId":"string","productId":"string","activityId":"string","currency":"string","productVariation":"string","pricingSelection":"string","pricingPlan":"string","rewardsArrangementId":"string","tradeDate":"string","arrangementEffectiveDate":"string"}},"responses":{"200":"createCreditLineResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"POST","path":"/holdings/facilities/createInstallmentLoan","fullPath":"/api/v3.0.0/holdings/facilities/createInstallmentLoan","operationId":"createInstallmentLoan","name":"Create a Installment Loan for the given product","summary":"Create a Installment Loan for the given product","tags":[],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"customers":[{}],"arrangmentId":"string","currency":"string","facilityId":"string","effectiveDate":"string","activity":"string","product":"string","account":[{}],"schedule":[{}],"settlement":[{}],"commitment":[{}]}},"responses":{"200":"createInstallmentLoanResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"POST","path":"/holdings/fundsTransfer","fullPath":"/api/v3.0.0/holdings/fundsTransfer","operationId":"createFundsTransfer","name":"Create a account transfer between AA Accounts","summary":"Create a account transfer between AA Accounts","tags":[],"parameters":[{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"transactionType":"string","debitAccountId":"string","debitCurrency":"string","debitAmount":0.0,"debitValueDate":"2024-01-01","creditAccountId":"string","creditCurrencyId":"string","creditAmount":0.0,"creditValueDate":"2024-01-01","commissionCode":"string","commissionType":"string","commissionAmount":0.0,"paymentDetails":"string"}},"responses":{"200":"FundsTransferResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"POST","path":"/holdings/loans/consumerLoans","fullPath":"/api/v3.0.0/holdings/loans/consumerLoans","operationId":"createConsumerLoan","name":"creates a consumer loan for the given product","summary":"Initiates the creation of consumer loan for the given product","tags":["RETAIL"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"partyIds":[{}],"productId":"string","activityId":"string","currency":"string","arrangementEffectiveDate":"string","externalEventStatus":"string","account":[{}],"customer":[{}],"officers":[{}],"schedule":[{}],"settlement":[{}],"commitment":[{}]}},"responses":{"200":"createConsumerLoanResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"PUT","path":"/holdings/loans/consumerLoans/{consumerLoanId}/disbursements","fullPath":"/api/v3.0.0/holdings/loans/consumerLoans/{consumerLoanId}/disbursements","operationId":"createConsumerLoanDisbursement","name":"Disburses the consumer loan commitment amount","summary":"Initiates the disbursement of the given consumer loan contracts commitment amount","tags":["RETAIL"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"consumerLoanId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"currencyId":"string","effectiveDate":"2024-01-01","activityId":"string","transactionAmount":0.0,"contractId":"string","systemId":"string","externalEventStatus":"string"}},"responses":{"200":"createConsumerLoanDisbursementResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"PUT","path":"/holdings/loans/consumerLoans/{consumerLoanId}/commitmentIncreases","fullPath":"/api/v3.0.0/holdings/loans/consumerLoans/{consumerLoanId}/commitmentIncreases","operationId":"updateConsumerLoanTopupAmount","name":"Increases the commitment amount of the consumer loan","summary":"Increases the commitment amount of the given consumer loan contract","tags":["RETAIL"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"consumerLoanId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"effectiveDate":"2024-01-01","activityId":"string","externalEventStatus":"string","schedule":[{}],"settlement":[{}],"commitment":[{}]}},"responses":{"200":"updateConsumerLoanTopupAmountResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"PUT","path":"/holdings/loans/consumerLoans/{consumerLoanId}/commitmentDecreases","fullPath":"/api/v3.0.0/holdings/loans/consumerLoans/{consumerLoanId}/commitmentDecreases","operationId":"updateConsumerLoanDecreaseAmount","name":"Decreases the commitment amount of the consumer loan","summary":"Decreases the commitment amount of the given consumer loan contract","tags":["RETAIL"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"consumerLoanId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"effectiveDate":"2024-01-01","activityId":"string","externalEventStatus":"string","schedule":[{}],"commitment":[{}]}},"responses":{"200":"updateConsumerLoanDecreaseAmountResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"PUT","path":"/holdings/loans/consumerLoans/{consumerLoanId}/repayments","fullPath":"/api/v3.0.0/holdings/loans/consumerLoans/{consumerLoanId}/repayments","operationId":"createConsumerLoanRepayment","name":"Repays the consumer loan amount","summary":"Initiates the repayment of the given consumer loan amount","tags":["RETAIL"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"consumerLoanId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"currencyId":"string","effectiveDate":"2024-01-01","activityId":"string","transactionAmount":0.0,"contractId":"string","systemId":"string","externalEventStatus":"string"}},"responses":{"200":"createConsumerLoanRepaymentResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"PUT","path":"/holdings/loans/consumerLoans/{consumerLoanId}/principalDecreases","fullPath":"/api/v3.0.0/holdings/loans/consumerLoans/{consumerLoanId}/principalDecreases","operationId":"createConsumerLoanPrepayment","name":"Prepays the consumer loan amount ","summary":"Initiates the advance repayment of the given consumer loan amount","tags":["RETAIL"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"consumerLoanId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"currencyId":"string","effectiveDate":"2024-01-01","activityId":"string","transactionAmount":0.0,"contractId":"string","systemId":"string","externalEventStatus":"string"}},"responses":{"200":"createConsumerLoanPrepaymentResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"PUT","path":"/holdings/loans/consumerLoans/{consumerLoanId}/schedules","fullPath":"/api/v3.0.0/holdings/loans/consumerLoans/{consumerLoanId}/schedules","operationId":"updateConsumerLoanSchedule","name":"Change payment schedule of the consumer loan","summary":"Initiates the change of payment schedule for the given consumer loan contract","tags":["RETAIL"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"consumerLoanId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"effectiveDate":"2024-01-01","activityId":"string","externalEventStatus":"string","schedule":[{}],"settlement":[{}]}},"responses":{"200":"updateConsumerLoanScheduleResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"PUT","path":"/holdings/loans/consumerLoans/{consumerLoanId}/paymentHolidays","fullPath":"/api/v3.0.0/holdings/loans/consumerLoans/{consumerLoanId}/paymentHolidays","operationId":"updateConsumerLoanHoliday","name":"Update payment holiday for the consumer loan ","summary":"Initiates the update of payment holiday for the given consumer loan contract ","tags":["RETAIL"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"consumerLoanId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"effectiveDate":"2024-01-01","activityId":"string","externalEventStatus":"string","paymentHoliday":[{}]}},"responses":{"200":"updateConsumerLoanHolidayResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"GET","path":"/holdings/loans/{loanId}/outstandingBills","fullPath":"/api/v3.0.0/holdings/loans/{loanId}/outstandingBills","operationId":"getLoanOutstandingBills","name":"Retrieves the Outstanding amount to be paid for an loan","summary":"Retrieves the Outstanding amount to be paid for the given loan","tags":["RETAIL"],"parameters":[{"name":"loanId","in":"path","type":"string","required":true,"description":"Denotes the arrangement id of the loan"},{"name":"fileVersion","in":"query","type":"string","required":false,"description":"Indicates if the file is of type simulation or live"},{"name":"simulationReference","in":"query","type":"string","required":false,"description":"Indicates the Reference ID for simulation activity"},{"name":"paymentDate","in":"query","type":"string","required":false,"description":"The date on which a payment is due"},{"name":"deferDate","in":"query","type":"string","required":false,"description":"Date that the payment has been deferred to"},{"name":"billedAmount","in":"query","type":"string","required":false,"description":"Indicates the bill amount"},{"name":"outstandingAmount","in":"query","type":"string","required":false,"description":"Contains the aggregate outstanding principal amount thereof after giving effect to any borrowings and prepayments or repayments of Committed Loans"},{"name":"delinquentAmount","in":"query","type":"string","required":false,"description":"Indicates the bill amount during the ageing status(Bill which crossed the due date)"},{"name":"property","in":"query","type":"string","required":false,"description":"Id of the product property"},{"name":"billStatus","in":"query","type":"string","required":false,"description":"Indicates the status of a bill(Issued,Due,Ageing,Settled)"},{"name":"settlementStatus","in":"query","type":"string","required":false,"description":"Defines the status of the settlement for the incoming MT548 swift message.The values allowed are: Waiting : pending to receive settlement status update meaning pending to receive MT548 swift message, "},{"name":"agingStatus","in":"query","type":"string","required":false,"description":"Indicates the ageing status of a bill"},{"name":"settled","in":"query","type":"string","required":false,"description":"Flag to indicate whether a bill is settled or not"},{"name":"paymentType","in":"query","type":"string","required":false,"description":"Indicates if the payment is Customer (C) type or Bank (B) type"},{"name":"billDate","in":"query","type":"string","required":false,"description":"Indicates a date on which a bill has been raised"},{"name":"paymentMethod","in":"query","type":"string","required":false,"description":"Method chosen to make the payment"},{"name":"infoPayType","in":"query","type":"string","required":false,"description":"Indicates a bill which is raised when a loan is paid off"},{"name":"advancePayment","in":"query","type":"string","required":false,"description":"Indicates whether advance payment made is set on an account"},{"name":"paymentIndicator","in":"query","type":"string","required":false,"description":"Indicates whether its a credit/debit type of bill"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"LoanOutstandingBillsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/loans/{loanId}/payoffCalculations","fullPath":"/api/v3.0.0/holdings/loans/{loanId}/payoffCalculations","operationId":"getLoanPayoffDetails","name":"Retrieves the Payoff Details of an loan","summary":"Retrieves the Payoff Details of the given loan","tags":["RETAIL"],"parameters":[{"name":"loanId","in":"path","type":"string","required":true,"description":"Denotes the arrangement id of the loan"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"LoanPayoffDetailsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"PUT","path":"/holdings/loans/consumerLoans/{consumerLoanId}/customers","fullPath":"/api/v3.0.0/holdings/loans/consumerLoans/{consumerLoanId}/customers","operationId":"updateConsumerLoansCustomer","name":"Changes the customers of the consumer loan ","summary":"Initiates the change of customers for the given consumer loan contract","tags":["RETAIL"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"consumerLoanId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"partyIds":[{}],"effectiveDate":"2024-01-01","activityId":"string","externalEventStatus":"string","customer":[{}]}},"responses":{"200":"updateConsumerLoansCustomerResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"PUT","path":"/holdings/loans/consumerLoans/{consumerLoanId}/payoffs","fullPath":"/api/v3.0.0/holdings/loans/consumerLoans/{consumerLoanId}/payoffs","operationId":"createPayoffConsumerLoan","name":"Payoffs the consumer loan amount","summary":"Initiates the payoff of the given consumer loan contract amount","tags":["RETAIL"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"consumerLoanId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"currencyId":"string","effectiveDate":"2024-01-01","activityId":"string","transactionAmount":0.0,"contractId":"string","systemId":"string","externalEventStatus":"string"}},"responses":{"200":"createPayoffConsumerLoanResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"PUT","path":"/holdings/loans/consumerLoans/{consumerLoanId}/renegotiations","fullPath":"/api/v3.0.0/holdings/loans/consumerLoans/{consumerLoanId}/renegotiations","operationId":"updateConsumerLoanConditions","name":"Renegotiates the consumer loan contract details","summary":"Initiates the renegotiation of the given consumer loan contract details","tags":["RETAIL"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"consumerLoanId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"effectiveDate":"2024-01-01","activityId":"string","externalEventStatus":"string","account":[{}],"customer":[{}],"officers":[{}],"schedule":[{}],"settlement":[{}],"commitment":[{}]}},"responses":{"200":"updateConsumerLoanConditionsResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"GET","path":"/holdings/loans/{loanId}/status","fullPath":"/api/v3.0.0/holdings/loans/{loanId}/status","operationId":"getArrangementDetails","name":"Retrieves the status of a Loan","summary":"Retrieves the status of the given Loan","tags":["RETAIL"],"parameters":[{"name":"loanId","in":"path","type":"string","required":true,"description":"Denotes the arrangement id of the loan"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"ArrangementDetailsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/loans/arrangements/activities/{arrangementActivityId}/status","fullPath":"/api/v3.0.0/holdings/loans/arrangements/activities/{arrangementActivityId}/status","operationId":"getExternalEventStatus","name":"Retrieves the status of the given activity ","summary":"Retrieves the status of the given activity ","tags":["RETAIL"],"parameters":[{"name":"arrangementActivityId","in":"path","type":"string","required":true,"description":"The unique identifier of an arrangement activity"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"ExternalEventStatusResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"PUT","path":"/holdings/loans/consumerLoans/{consumerLoanId}/payoffCalculations","fullPath":"/api/v3.0.0/holdings/loans/consumerLoans/{consumerLoanId}/payoffCalculations","operationId":"calculatePayoffConsumerLoans","name":"Calculates consumer loan payment amount to close an loan","summary":"Initiates Calculate Payoff activity to calculate consumer loan payment amount to close the given loan","tags":["RETAIL"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"consumerLoanId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"closureNotes":[{}],"activityId":"string","automaticRun":"string","simulationRunReference":"string","effectiveDate":"2024-01-01","currencyId":"string","transactionAmount":0.0,"closureReason":"string"}},"responses":{"200":"calculatePayoffConsumerLoansResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"GET","path":"/holdings/loans/{loanId}/schedules","fullPath":"/api/v3.0.0/holdings/loans/{loanId}/schedules","operationId":"getPaymentSchedulesProjection","name":"Retrieves payment schedules details","summary":"Retrieves the schedule payment information for paid and upcoming installment details","tags":["RETAIL"],"parameters":[{"name":"loanId","in":"path","type":"string","required":true,"description":"Denotes the arrangement id of the loan"},{"name":"dateFrom","in":"query","type":"string","required":false,"description":"Start date of the loan"},{"name":"dateTo","in":"query","type":"string","required":false,"description":"End date of the loan"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"PaymentSchedulesProjectionResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/loans/{loanId}/loanDetails","fullPath":"/api/v3.0.0/holdings/loans/{loanId}/loanDetails","operationId":"getLoanOverview","name":"Retrieves loan details","summary":"Retrieves the details of the given loan ","tags":["RETAIL"],"parameters":[{"name":"loanId","in":"path","type":"string","required":true,"description":"Denotes the arrangement id of the loan"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"LoanOverviewResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/loans/{loanId}/bills","fullPath":"/api/v3.0.0/holdings/loans/{loanId}/bills","operationId":"getLoanBills","name":"Retrieves loan bills details","summary":"Retrieves the simulation details of the contract based on the selection criteria. It returns the bill details of the loan","tags":[],"parameters":[{"name":"loanId","in":"path","type":"string","required":true,"description":"Denotes the arrangement id of the loan"},{"name":"billType","in":"query","type":"string","required":false,"description":"The type of payment obligation generated"},{"name":"paymentDate","in":"query","type":"string","required":false,"description":"The date on which a payment is due"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"LoanBillsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/loans/{loanId}/collaterals","fullPath":"/api/v3.0.0/holdings/loans/{loanId}/collaterals","operationId":"getLoanCollaterals","name":"Retrieves loan collateral details","summary":"Retrieves the collateral details linked to the loan arrangement. The collateral right and status have to be passed within the api","tags":[],"parameters":[{"name":"loanId","in":"path","type":"string","required":true,"description":"Denotes the arrangement id of the loan"},{"name":"status","in":"query","type":"string","required":false,"description":"Contains status of the data rights request.Allowed values are INITIATED, INPROGESS, EXTENDED, COMPLETED, REJECTED."},{"name":"statusNE","in":"query","type":"string","required":false,"description":"Status not equal to"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"LoanCollateralsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/loans/{loanId}","fullPath":"/api/v3.0.0/holdings/loans/{loanId}","operationId":"getLoanDetails","name":"Retrieves loan details","summary":"Retrieves the loan account details","tags":[],"parameters":[{"name":"loanId","in":"path","type":"string","required":true,"description":"Denotes the arrangement id of the loan"},{"name":"dateFrom","in":"query","type":"string","required":false,"description":"Start date of the loan"},{"name":"dateTo","in":"query","type":"string","required":false,"description":"End date of the loan"},{"name":"balanceTypes","in":"query","type":"string","required":false,"description":"Type of balance (e.g. current balance, credit interest accrued, deferred commission, etc.) as defined in the institution's accounting schemas."},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"LoanDetailsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/loans/{loanId}/schedulePaymentFrequencies","fullPath":"/api/v3.0.0/holdings/loans/{loanId}/schedulePaymentFrequencies","operationId":"getPaymentSchedules","name":"Retrieves payment schedules details","summary":"Retrieves the schedule payment information for paid and upcoming installments details","tags":[],"parameters":[{"name":"loanId","in":"path","type":"string","required":true,"description":"Denotes the arrangement id of the loan"},{"name":"dateFrom","in":"query","type":"string","required":false,"description":"Start date of the loan"},{"name":"dateTo","in":"query","type":"string","required":false,"description":"End date of the loan"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"PaymentSchedulesResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"POST","path":"/holdings/simulationCapture/{arrangementId}","fullPath":"/api/v3.0.0/holdings/simulationCapture/{arrangementId}","operationId":"createSimulationCapture","name":"Simulate payoff calculate activity for a loan arrangement","summary":"Simulate payoff calculate activity for a loan arrangement","tags":[],"parameters":[{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"arrangementId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"closureNotes":[{}],"activityId":"string","automaticRun":"string","simulationRunReference":"string","effectiveDate":"2024-01-01","currencyId":"string","transactionAmount":0.0,"closureReason":"string","payoff":{"amount":{},"expiryDays":{},"settleDues":{},"percentage":{},"action":{}},"settlement":{"settlement":{},"assocSettlement":{},"payout":{},"paymentType":{},"defaultSettlementAccount":{}}}},"responses":{"200":"createSimulationCaptureResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}}]},{"key":"holdings-loans-arrangements-v4.0.0","title":"Loan creation","version":"v4.0.0","description":"API to create and manage various types of loans such as personal, commercial, mortgage, line of credit, etc","endpointCount":35,"endpoints":[{"method":"POST","path":"/holdings/loans/personalLoans","fullPath":"/api/v4.0.0/holdings/loans/personalLoans","operationId":"createPersonalLoan","name":"Create a personal loan account","summary":"Create a personal loan account","tags":[],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"partyIds":[{}],"partyRoles":[{}],"agentCustomerIds":[{}],"agentArrangementIds":[{}],"agentRoles":[{}],"arrangmentId":"string","productId":"string","activityId":"string","currency":"string","productVariation":"string","pricingSelection":"string","pricingPlan":"string","rewardsArrangementId":"string","tradeDate":"string","arrangementEffectiveDate":"string"}},"responses":{"200":"createPersonalLoanResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"POST","path":"/holdings/loans/linkedRateLoans","fullPath":"/api/v4.0.0/holdings/loans/linkedRateLoans","operationId":"createLinkedRateLoan","name":"Create a personal loan account with linked rate","summary":"Create a personal loan account with linked rate","tags":[],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"partyIds":[{}],"partyRoles":[{}],"agentCustomerIds":[{}],"agentArrangementIds":[{}],"agentRoles":[{}],"arrangmentId":"string","productId":"string","activityId":"string","currency":"string","productVariation":"string","pricingSelection":"string","pricingPlan":"string","rewardsArrangementId":"string","tradeDate":"string","arrangementEffectiveDate":"string"}},"responses":{"200":"createLinkedRateLoanResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"POST","path":"/holdings/loans/commercialLoans","fullPath":"/api/v4.0.0/holdings/loans/commercialLoans","operationId":"createCommercialLoan","name":"Create a commercial or business account","summary":"Create a commercial or business account","tags":[],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"partyIds":[{}],"partyRoles":[{}],"agentCustomerIds":[{}],"agentArrangementIds":[{}],"agentRoles":[{}],"arrangmentId":"string","productId":"string","activityId":"string","currency":"string","productVariation":"string","pricingSelection":"string","pricingPlan":"string","rewardsArrangementId":"string","tradeDate":"string","arrangementEffectiveDate":"string"}},"responses":{"200":"createCommercialLoanResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"POST","path":"/holdings/loans/mortgages","fullPath":"/api/v4.0.0/holdings/loans/mortgages","operationId":"createMortgage","name":"Create a mortgage loan","summary":"Create a mortgage loan","tags":[],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"partyIds":[{}],"partyRoles":[{}],"agentCustomerIds":[{}],"agentArrangementIds":[{}],"agentRoles":[{}],"arrangmentId":"string","productId":"string","activityId":"string","currency":"string","productVariation":"string","pricingSelection":"string","pricingPlan":"string","rewardsArrangementId":"string","tradeDate":"string","arrangementEffectiveDate":"string"}},"responses":{"200":"createMortgageResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"POST","path":"/holdings/loans/creditLines","fullPath":"/api/v4.0.0/holdings/loans/creditLines","operationId":"createCreditLine","name":"Create a lines of credit account","summary":"Create a lines of credit account","tags":[],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"partyIds":[{}],"partyRoles":[{}],"agentCustomerIds":[{}],"agentArrangementIds":[{}],"agentRoles":[{}],"arrangmentId":"string","productId":"string","activityId":"string","currency":"string","productVariation":"string","pricingSelection":"string","pricingPlan":"string","rewardsArrangementId":"string","tradeDate":"string","arrangementEffectiveDate":"string"}},"responses":{"200":"createCreditLineResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"POST","path":"/holdings/facilities/createInstallmentLoan","fullPath":"/api/v4.0.0/holdings/facilities/createInstallmentLoan","operationId":"createInstallmentLoan","name":"Create a installment loan for the given product","summary":"Create a installment loan for the given product","tags":[],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"customers":[{}],"arrangmentId":"string","currency":"string","facilityId":"string","effectiveDate":"string","activity":"string","product":"string","account":[{}],"schedule":[{}],"settlement":[{}],"commitment":[{}]}},"responses":{"200":"createInstallmentLoanResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"POST","path":"/holdings/fundsTransfer","fullPath":"/api/v4.0.0/holdings/fundsTransfer","operationId":"createFundsTransfer","name":"Create a account transfer between arrangement accounts","summary":"Create a account transfer between arrangement accounts","tags":[],"parameters":[{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"transactionType":"string","debitAccountId":"string","debitCurrency":"string","debitAmount":0.0,"debitValueDate":"2024-01-01","creditAccountId":"string","creditCurrencyId":"string","creditAmount":0.0,"creditValueDate":"2024-01-01","commissionCode":"string","commissionType":"string","commissionAmount":0.0,"paymentDetails":"string"}},"responses":{"200":"FundsTransferResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"POST","path":"/holdings/loans/consumerLoans","fullPath":"/api/v4.0.0/holdings/loans/consumerLoans","operationId":"createConsumerLoan","name":"creates a consumer loan for the given product","summary":"Initiates the creation of consumer loan for the given product","tags":["RETAIL"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"partyIds":[{}],"productId":"string","activityId":"string","currency":"string","arrangementEffectiveDate":"string","externalEventStatus":"string","account":[{}],"customer":[{}],"officers":[{}],"schedule":[{}],"settlement":[{}],"commitment":[{}]}},"responses":{"200":"createConsumerLoanResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"PUT","path":"/holdings/loans/consumerLoans/{consumerLoanId}/disbursements","fullPath":"/api/v4.0.0/holdings/loans/consumerLoans/{consumerLoanId}/disbursements","operationId":"createConsumerLoanDisbursement","name":"Initiates the disbursement of the given consumer loan contracts commitment amount","summary":"Disburses the consumer loan commitment amount","tags":["RETAIL"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"consumerLoanId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"currencyId":"string","effectiveDate":"2024-01-01","activityId":"string","transactionAmount":0.0,"contractId":"string","systemId":"string","externalEventStatus":"string"}},"responses":{"200":"createConsumerLoanDisbursementResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"PUT","path":"/holdings/loans/consumerLoans/{consumerLoanId}/commitmentIncreases","fullPath":"/api/v4.0.0/holdings/loans/consumerLoans/{consumerLoanId}/commitmentIncreases","operationId":"updateConsumerLoanTopupAmount","name":"Increases the commitment amount of the given consumer loan contract","summary":"Increases the commitment amount of the consumer loan ","tags":["RETAIL"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"consumerLoanId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"effectiveDate":"2024-01-01","activityId":"string","externalEventStatus":"string"}},"responses":{"200":"updateConsumerLoanTopupAmountResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"PUT","path":"/holdings/loans/consumerLoans/{consumerLoanId}/commitmentDecreases","fullPath":"/api/v4.0.0/holdings/loans/consumerLoans/{consumerLoanId}/commitmentDecreases","operationId":"updateConsumerLoanDecreaseAmount","name":"Decreases the commitment amount of the given consumer loan contract","summary":"Decreases the commitment amount of the consumer loan","tags":["RETAIL"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"consumerLoanId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"effectiveDate":"2024-01-01","activityId":"string","externalEventStatus":"string"}},"responses":{"200":"updateConsumerLoanDecreaseAmountResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"PUT","path":"/holdings/loans/consumerLoans/{consumerLoanId}/repayments","fullPath":"/api/v4.0.0/holdings/loans/consumerLoans/{consumerLoanId}/repayments","operationId":"createConsumerLoanRepayment","name":"Initiates the repayment of the given consumer loan amount","summary":"Repays the consumer loan amount","tags":["RETAIL"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"consumerLoanId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"currencyId":"string","effectiveDate":"2024-01-01","activityId":"string","transactionAmount":0.0,"contractId":"string","systemId":"string","externalEventStatus":"string"}},"responses":{"200":"createConsumerLoanRepaymentResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"PUT","path":"/holdings/loans/consumerLoans/{consumerLoanId}/principalDecreases","fullPath":"/api/v4.0.0/holdings/loans/consumerLoans/{consumerLoanId}/principalDecreases","operationId":"createConsumerLoanPrepayment","name":"Initiates the advance repayment of the given consumer loan amount","summary":"Prepays the consumer loan amount ","tags":["RETAIL"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"consumerLoanId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"currencyId":"string","effectiveDate":"2024-01-01","activityId":"string","transactionAmount":0.0,"contractId":"string","systemId":"string","externalEventStatus":"string"}},"responses":{"200":"createConsumerLoanPrepaymentResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"PUT","path":"/holdings/loans/consumerLoans/{consumerLoanId}/schedules","fullPath":"/api/v4.0.0/holdings/loans/consumerLoans/{consumerLoanId}/schedules","operationId":"updateConsumerLoanSchedule","name":"Initiates the change of payment schedule for the given consumer loan contract","summary":"Change payment schedule of the consumer loan","tags":["RETAIL"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"consumerLoanId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"effectiveDate":"2024-01-01","activityId":"string","externalEventStatus":"string"}},"responses":{"200":"updateConsumerLoanScheduleResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"PUT","path":"/holdings/loans/consumerLoans/{consumerLoanId}/paymentHolidays","fullPath":"/api/v4.0.0/holdings/loans/consumerLoans/{consumerLoanId}/paymentHolidays","operationId":"updateConsumerLoanHoliday","name":"Initiates the update of payment holiday for the given consumer loan contract ","summary":"Update payment holiday for the consumer loan ","tags":["RETAIL"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"consumerLoanId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"effectiveDate":"2024-01-01","activityId":"string","externalEventStatus":"string"}},"responses":{"200":"updateConsumerLoanHolidayResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"GET","path":"/holdings/loans/{loanId}/outstandingBills","fullPath":"/api/v4.0.0/holdings/loans/{loanId}/outstandingBills","operationId":"getLoanOutstandingBills","name":"Retrieves the outstanding amount to be paid for a loan","summary":"Retrieves the outstanding amount to be paid for the given loan","tags":["RETAIL"],"parameters":[{"name":"loanId","in":"path","type":"string","required":true,"description":"Denotes the arrangement id of the loan"},{"name":"fileVersion","in":"query","type":"string","required":false,"description":"Indicates if the file is of type simulation or live"},{"name":"simulationReference","in":"query","type":"string","required":false,"description":"Indicates the Reference ID for simulation activity"},{"name":"paymentDate","in":"query","type":"string","required":false,"description":"The date on which a payment is due"},{"name":"deferDate","in":"query","type":"string","required":false,"description":"Date that the payment has been deferred to"},{"name":"billedAmount","in":"query","type":"string","required":false,"description":"Indicates the bill amount"},{"name":"outstandingAmount","in":"query","type":"string","required":false,"description":"Contains the aggregate outstanding principal amount thereof after giving effect to any borrowings and prepayments or repayments of Committed Loans"},{"name":"delinquentAmount","in":"query","type":"string","required":false,"description":"Indicates the bill amount during the ageing status(Bill which crossed the due date)"},{"name":"property","in":"query","type":"string","required":false,"description":"Id of the product property"},{"name":"billStatus","in":"query","type":"string","required":false,"description":"Indicates the status of a bill(Issued,Due,Ageing,Settled)"},{"name":"settlementStatus","in":"query","type":"string","required":false,"description":"Defines the status of the settlement for the incoming MT548 swift message.The values allowed are: Waiting : pending to receive settlement status update meaning pending to receive MT548 swift message, "},{"name":"agingStatus","in":"query","type":"string","required":false,"description":"Indicates the ageing status of a bill"},{"name":"settled","in":"query","type":"string","required":false,"description":"Flag to indicate whether a bill is settled or not"},{"name":"paymentType","in":"query","type":"string","required":false,"description":"Indicates if the payment is Customer (C) type or Bank (B) type"},{"name":"billDate","in":"query","type":"string","required":false,"description":"Indicates a date on which a bill has been raised"},{"name":"paymentMethod","in":"query","type":"string","required":false,"description":"Method chosen to make the payment"},{"name":"infoPayType","in":"query","type":"string","required":false,"description":"Indicates a bill which is raised when a loan is paid off"},{"name":"advancePayment","in":"query","type":"string","required":false,"description":"Indicates whether advance payment made is set on an account"},{"name":"paymentIndicator","in":"query","type":"string","required":false,"description":"Indicates whether its a credit/debit type of bill"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"LoanOutstandingBillsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/loans/{loanId}/payoffCalculations","fullPath":"/api/v4.0.0/holdings/loans/{loanId}/payoffCalculations","operationId":"getLoanPayoffDetails","name":"Retrieves the payoff details of a loan","summary":"Retrieves the payoff details of the given loan","tags":["RETAIL"],"parameters":[{"name":"loanId","in":"path","type":"string","required":true,"description":"Denotes the arrangement id of the loan"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"LoanPayoffDetailsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"PUT","path":"/holdings/loans/consumerLoans/{consumerLoanId}/customers","fullPath":"/api/v4.0.0/holdings/loans/consumerLoans/{consumerLoanId}/customers","operationId":"updateConsumerLoansCustomer","name":"Initiates the change of customers for the given consumer loan contract","summary":"Changes the customers of the consumer loan ","tags":["RETAIL"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"consumerLoanId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"partyIds":[{}],"effectiveDate":"2024-01-01","activityId":"string","externalEventStatus":"string"}},"responses":{"200":"updateConsumerLoansCustomerResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"PUT","path":"/holdings/loans/consumerLoans/{consumerLoanId}/payoffs","fullPath":"/api/v4.0.0/holdings/loans/consumerLoans/{consumerLoanId}/payoffs","operationId":"createPayoffConsumerLoan","name":"Initiates the payoff of the given consumer loan contract amount","summary":"Payoffs the consumer loan amount","tags":["RETAIL"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"consumerLoanId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"currencyId":"string","effectiveDate":"2024-01-01","activityId":"string","transactionAmount":0.0,"contractId":"string","systemId":"string","externalEventStatus":"string"}},"responses":{"200":"createPayoffConsumerLoanResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"PUT","path":"/holdings/loans/consumerLoans/{consumerLoanId}/renegotiations","fullPath":"/api/v4.0.0/holdings/loans/consumerLoans/{consumerLoanId}/renegotiations","operationId":"updateConsumerLoanConditions","name":"Initiates the renegotiation of the given consumer loan contract details","summary":"Renegotiates the consumer loan contract details","tags":["RETAIL"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"consumerLoanId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"effectiveDate":"2024-01-01","activityId":"string","externalEventStatus":"string"}},"responses":{"200":"updateConsumerLoanConditionsResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"GET","path":"/holdings/loans/{loanId}/status","fullPath":"/api/v4.0.0/holdings/loans/{loanId}/status","operationId":"getArrangementDetails","name":"Retrieves the status of a loan","summary":"Retrieves the status of the given loan","tags":["RETAIL"],"parameters":[{"name":"loanId","in":"path","type":"string","required":true,"description":"Denotes the arrangement id of the loan"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"ArrangementDetailsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/loans/arrangements/activities/{arrangementActivityId}/status","fullPath":"/api/v4.0.0/holdings/loans/arrangements/activities/{arrangementActivityId}/status","operationId":"getExternalEventStatus","name":"Retrieves the status of the given activity ","summary":"Retrieves the status of the given activity ","tags":["RETAIL"],"parameters":[{"name":"arrangementActivityId","in":"path","type":"string","required":true,"description":"The unique identifier of an arrangement activity"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"ExternalEventStatusResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"PUT","path":"/holdings/loans/consumerLoans/{consumerLoanId}/payoffCalculations","fullPath":"/api/v4.0.0/holdings/loans/consumerLoans/{consumerLoanId}/payoffCalculations","operationId":"calculatePayoffConsumerLoans","name":"Initiates calculate payoff activity to calculate consumer loan payment amount to close the given loan","summary":"Calculates consumer loan payment amount to close a loan","tags":["RETAIL"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"consumerLoanId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"parties":[{}],"activityId":"string","effectiveDate":"string","productId":"string","currencyId":"string","simulationId":"string"}},"responses":{"200":"calculatePayoffConsumerLoansResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"GET","path":"/holdings/loans/{loanId}/schedules","fullPath":"/api/v4.0.0/holdings/loans/{loanId}/schedules","operationId":"getPaymentSchedulesProjection","name":"Retrieves the schedule payment information for paid and upcoming installment details","summary":"Retrieves payment schedules details","tags":["RETAIL"],"parameters":[{"name":"loanId","in":"path","type":"string","required":true,"description":"Denotes the arrangement id of the loan"},{"name":"dateFrom","in":"query","type":"string","required":false,"description":"Start date of the loan"},{"name":"dateTo","in":"query","type":"string","required":false,"description":"End date of the loan"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"PaymentSchedulesProjectionResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/loans/{loanId}/loanDetails","fullPath":"/api/v4.0.0/holdings/loans/{loanId}/loanDetails","operationId":"getLoanOverview","name":"Retrieves the details of the given loan","summary":"Retrieves loan details ","tags":["RETAIL"],"parameters":[{"name":"loanId","in":"path","type":"string","required":true,"description":"Denotes the arrangement id of the loan"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"LoanOverviewResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/loans/{loanId}/bills","fullPath":"/api/v4.0.0/holdings/loans/{loanId}/bills","operationId":"getLoanBills","name":"Retrieves the simulation details of the contract based on the selection criteria. It returns the bill details of the loan","summary":"Retrieves loan bills details","tags":[],"parameters":[{"name":"loanId","in":"path","type":"string","required":true,"description":"Denotes the arrangement id of the loan"},{"name":"billType","in":"query","type":"string","required":false,"description":"The type of payment obligation generated"},{"name":"paymentDate","in":"query","type":"string","required":false,"description":"The date on which a payment is due"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"LoanBillsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/loans/{loanId}/collaterals","fullPath":"/api/v4.0.0/holdings/loans/{loanId}/collaterals","operationId":"getLoanCollaterals","name":"Retrieves the collateral details linked to the loan arrangement. The collateral right and status have to be passed within the api","summary":"Retrieves loan collateral details","tags":[],"parameters":[{"name":"loanId","in":"path","type":"string","required":true,"description":"Denotes the arrangement id of the loan"},{"name":"status","in":"query","type":"string","required":false,"description":"Contains status of the data rights request.Allowed values are INITIATED, INPROGESS, EXTENDED, COMPLETED, REJECTED."},{"name":"statusNE","in":"query","type":"string","required":false,"description":"Status not equal to"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"LoanCollateralsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/loans/{loanId}","fullPath":"/api/v4.0.0/holdings/loans/{loanId}","operationId":"getLoanDetails","name":"Retrieves the loan account details","summary":"Retrieves loan account details","tags":[],"parameters":[{"name":"loanId","in":"path","type":"string","required":true,"description":"Denotes the arrangement id of the loan"},{"name":"dateFrom","in":"query","type":"string","required":false,"description":"Start date of the loan"},{"name":"dateTo","in":"query","type":"string","required":false,"description":"End date of the loan"},{"name":"balanceTypes","in":"query","type":"string","required":false,"description":"Type of balance (e.g. current balance, credit interest accrued, deferred commission, etc.) as defined in the institution's accounting schemas."},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"LoanDetailsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/loans/{loanId}/schedulePaymentFrequencies","fullPath":"/api/v4.0.0/holdings/loans/{loanId}/schedulePaymentFrequencies","operationId":"getPaymentSchedules","name":"Retrieves the schedule payment information for paid and upcoming installments details","summary":"Retrieves payment schedules details","tags":[],"parameters":[{"name":"loanId","in":"path","type":"string","required":true,"description":"Denotes the arrangement id of the loan"},{"name":"dateFrom","in":"query","type":"string","required":false,"description":"Start date of the loan"},{"name":"dateTo","in":"query","type":"string","required":false,"description":"End date of the loan"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"PaymentSchedulesResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"POST","path":"/holdings/simulationCapture/{arrangementId}","fullPath":"/api/v4.0.0/holdings/simulationCapture/{arrangementId}","operationId":"createSimulationCapture","name":"Simulate payoff calculate activity for a loan arrangement","summary":"Simulate payoff calculate activity for a loan arrangement","tags":[],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"arrangementId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"customerIds":[{}],"properties":[{}],"overrides":[{}],"productId":"string","masterArrangementId":"string","roleName":"string","currencyId":"string","effectiveDate":"2024-01-01","activityId":"string","transactionAmount":0.0,"reason":"string","payoff":[{}]}},"responses":{"200":"createSimulationCaptureResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"POST","path":"/holdings/loans/simulations","fullPath":"/api/v4.0.0/holdings/loans/simulations","operationId":"createLoanSimulation","name":"This can be used to create a simulation for loan product and the payload should include customer identifier, currency, etc.","summary":"Create simulation for loan products","tags":["RETAIL"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"customerIds":[{}],"properties":[{}],"overrides":[{}],"productId":"string","masterArrangementId":"string","roleName":"string","currencyId":"string","effectiveDate":"2024-01-01","activityId":"string","transactionAmount":0.0,"reason":"string","automaticRun":"string","simulationRunReference":"string","synchronous":"string","account":[{}]}},"responses":{"200":"createLoanSimulationResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"PUT","path":"/holdings/loans/simulations/{simulationId}","fullPath":"/api/v4.0.0/holdings/loans/simulations/{simulationId}","operationId":"updateLoanSimulation","name":"This can be used to amend a simulation for loan product and the payload should include customer identifier, currency, etc.","summary":"Amend simulation for loan products","tags":["RETAIL"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"simulationId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"customerIds":[{}],"properties":[{}],"overrides":[{}],"productId":"string","masterArrangementId":"string","roleName":"string","currencyId":"string","effectiveDate":"2024-01-01","activityId":"string","transactionAmount":0.0,"reason":"string","automaticRun":"string","simulationRunReference":"string","synchronous":"string","account":[{}]}},"responses":{"200":"updateLoanSimulationResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"POST","path":"/holdings/loans/{loanId}/simulations/payoffs","fullPath":"/api/v4.0.0/holdings/loans/{loanId}/simulations/payoffs","operationId":"createLoanPayoffSimulation","name":"This can be used to create a simulation payoff activity for loan product and the payload should include product Id , etc.","summary":"Create simulation payoff activity for loan products","tags":["RETAIL"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"loanId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"customerIds":[{}],"properties":[{}],"overrides":[{}],"productId":"string","masterArrangementId":"string","roleName":"string","currencyId":"string","effectiveDate":"2024-01-01","activityId":"string","transactionAmount":0.0,"reason":"string","automaticRun":"string","simulationRunReference":"string","synchronous":"string","payoff":[{}]}},"responses":{"200":"createLoanPayoffSimulationResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"POST","path":"/holdings/loans/{loanId}/payoffs","fullPath":"/api/v4.0.0/holdings/loans/{loanId}/payoffs","operationId":"createLoanArrangementPayoff","name":" This can be used to execute payoff activity for loan product and the payload should include simulation run reference, product Id , etc.","summary":"Execute payoff activity for loan products","tags":["RETAIL"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"loanId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"customerIds":[{}],"properties":[{}],"overrides":[{}],"productId":"string","masterArrangementId":"string","roleName":"string","currencyId":"string","effectiveDate":"2024-01-01","activityId":"string","transactionAmount":0.0,"reason":"string","simulationRunReference":"string","payoff":[{}]}},"responses":{"200":"createLoanArrangementPayoffResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"GET","path":"/holdings/loans/{loanId}/overpayments","fullPath":"/api/v4.0.0/holdings/loans/{loanId}/overpayments","operationId":"getOverpaymentDetails","name":"Fetch the product id, type of overpay, overpay limit, overpay period, utilized overpay and remaining overpay limit of a loan arrangement","summary":"To  fetch overpayment details that has happened for a loan arrangement","tags":["RETAIL"],"parameters":[{"name":"loanId","in":"path","type":"string","required":true,"description":"Denotes the arrangement id of the loan"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"OverpaymentDetailsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}}]},{"key":"holdings-loans-arrangements-v5.0.0","title":"Loan creation","version":"v5.0.0","description":"API to create and manage various types of loans such as personal, commercial, mortgage, line of credit, etc","endpointCount":35,"endpoints":[{"method":"POST","path":"/holdings/loans/personalLoans","fullPath":"/api/v5.0.0/holdings/loans/personalLoans","operationId":"createPersonalLoan","name":"Create a personal loan account","summary":"Create a personal loan account","tags":[],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"partyIds":[{}],"partyRoles":[{}],"agentCustomerIds":[{}],"agentArrangementIds":[{}],"agentRoles":[{}],"arrangmentId":"string","productId":"string","activityId":"string","currency":"string","productVariation":"string","pricingSelection":"string","pricingPlan":"string","rewardsArrangementId":"string","tradeDate":"string","arrangementEffectiveDate":"string"}},"responses":{"200":"createPersonalLoanResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"POST","path":"/holdings/loans/linkedRateLoans","fullPath":"/api/v5.0.0/holdings/loans/linkedRateLoans","operationId":"createLinkedRateLoan","name":"Create a personal loan account with linked rate","summary":"Create a personal loan account with linked rate","tags":[],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"partyIds":[{}],"partyRoles":[{}],"agentCustomerIds":[{}],"agentArrangementIds":[{}],"agentRoles":[{}],"arrangmentId":"string","productId":"string","activityId":"string","currency":"string","productVariation":"string","pricingSelection":"string","pricingPlan":"string","rewardsArrangementId":"string","tradeDate":"string","arrangementEffectiveDate":"string"}},"responses":{"200":"createLinkedRateLoanResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"POST","path":"/holdings/loans/commercialLoans","fullPath":"/api/v5.0.0/holdings/loans/commercialLoans","operationId":"createCommercialLoan","name":"Create a commercial or business account","summary":"Create a commercial or business account","tags":[],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"partyIds":[{}],"partyRoles":[{}],"agentCustomerIds":[{}],"agentArrangementIds":[{}],"agentRoles":[{}],"arrangmentId":"string","productId":"string","activityId":"string","currency":"string","productVariation":"string","pricingSelection":"string","pricingPlan":"string","rewardsArrangementId":"string","tradeDate":"string","arrangementEffectiveDate":"string"}},"responses":{"200":"createCommercialLoanResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"POST","path":"/holdings/loans/mortgages","fullPath":"/api/v5.0.0/holdings/loans/mortgages","operationId":"createMortgage","name":"Create a mortgage loan","summary":"Create a mortgage loan","tags":[],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"partyIds":[{}],"partyRoles":[{}],"agentCustomerIds":[{}],"agentArrangementIds":[{}],"agentRoles":[{}],"arrangmentId":"string","productId":"string","activityId":"string","currency":"string","productVariation":"string","pricingSelection":"string","pricingPlan":"string","rewardsArrangementId":"string","tradeDate":"string","arrangementEffectiveDate":"string"}},"responses":{"200":"createMortgageResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"POST","path":"/holdings/loans/creditLines","fullPath":"/api/v5.0.0/holdings/loans/creditLines","operationId":"createCreditLine","name":"Create a lines of credit account","summary":"Create a lines of credit account","tags":[],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"partyIds":[{}],"partyRoles":[{}],"agentCustomerIds":[{}],"agentArrangementIds":[{}],"agentRoles":[{}],"arrangmentId":"string","productId":"string","activityId":"string","currency":"string","productVariation":"string","pricingSelection":"string","pricingPlan":"string","rewardsArrangementId":"string","tradeDate":"string","arrangementEffectiveDate":"string"}},"responses":{"200":"createCreditLineResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"POST","path":"/holdings/facilities/createInstallmentLoan","fullPath":"/api/v5.0.0/holdings/facilities/createInstallmentLoan","operationId":"createInstallmentLoan","name":"Create a installment loan for the given product","summary":"Create a installment loan for the given product","tags":[],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"customers":[{}],"arrangmentId":"string","currency":"string","facilityId":"string","effectiveDate":"string","activity":"string","product":"string","account":[{}],"schedule":[{}],"settlement":[{}],"commitment":[{}]}},"responses":{"200":"createInstallmentLoanResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"POST","path":"/holdings/fundsTransfer","fullPath":"/api/v5.0.0/holdings/fundsTransfer","operationId":"createFundsTransfer","name":"Create a account transfer between arrangement accounts","summary":"Create a account transfer between arrangement accounts","tags":[],"parameters":[{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"transactionType":"string","debitAccountId":"string","debitCurrency":"string","debitAmount":0.0,"debitValueDate":"2024-01-01","creditAccountId":"string","creditCurrencyId":"string","creditAmount":0.0,"creditValueDate":"2024-01-01","commissionCode":"string","commissionType":"string","commissionAmount":0.0,"paymentDetails":"string"}},"responses":{"200":"FundsTransferResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"POST","path":"/holdings/loans/consumerLoans","fullPath":"/api/v5.0.0/holdings/loans/consumerLoans","operationId":"createConsumerLoan","name":"creates a consumer loan for the given product","summary":"Initiates the creation of consumer loan for the given product","tags":["RETAIL"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"partyIds":[{}],"productId":"string","activityId":"string","currency":"string","arrangementEffectiveDate":"string","externalEventStatus":"string","account":[{}],"customer":[{}],"officers":[{}],"schedule":[{}],"settlement":[{}],"commitment":[{}]}},"responses":{"200":"createConsumerLoanResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"PUT","path":"/holdings/loans/consumerLoans/{consumerLoanId}/disbursements","fullPath":"/api/v5.0.0/holdings/loans/consumerLoans/{consumerLoanId}/disbursements","operationId":"createConsumerLoanDisbursement","name":"Initiates the disbursement of the given consumer loan contracts commitment amount","summary":"Disburses the consumer loan commitment amount","tags":["RETAIL"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"consumerLoanId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"currencyId":"string","effectiveDate":"2024-01-01","activityId":"string","transactionAmount":0.0,"contractId":"string","systemId":"string","externalEventStatus":"string"}},"responses":{"200":"createConsumerLoanDisbursementResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"PUT","path":"/holdings/loans/consumerLoans/{consumerLoanId}/commitmentIncreases","fullPath":"/api/v5.0.0/holdings/loans/consumerLoans/{consumerLoanId}/commitmentIncreases","operationId":"updateConsumerLoanTopupAmount","name":"Increases the commitment amount of the given consumer loan contract","summary":"Increases the commitment amount of the consumer loan ","tags":["RETAIL"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"consumerLoanId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"effectiveDate":"2024-01-01","activityId":"string","externalEventStatus":"string"}},"responses":{"200":"updateConsumerLoanTopupAmountResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"PUT","path":"/holdings/loans/consumerLoans/{consumerLoanId}/commitmentDecreases","fullPath":"/api/v5.0.0/holdings/loans/consumerLoans/{consumerLoanId}/commitmentDecreases","operationId":"updateConsumerLoanDecreaseAmount","name":"Decreases the commitment amount of the given consumer loan contract","summary":"Decreases the commitment amount of the consumer loan","tags":["RETAIL"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"consumerLoanId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"effectiveDate":"2024-01-01","activityId":"string","externalEventStatus":"string"}},"responses":{"200":"updateConsumerLoanDecreaseAmountResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"PUT","path":"/holdings/loans/consumerLoans/{consumerLoanId}/repayments","fullPath":"/api/v5.0.0/holdings/loans/consumerLoans/{consumerLoanId}/repayments","operationId":"createConsumerLoanRepayment","name":"Initiates the repayment of the given consumer loan amount","summary":"Repays the consumer loan amount","tags":["RETAIL"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"consumerLoanId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"currencyId":"string","effectiveDate":"2024-01-01","activityId":"string","transactionAmount":0.0,"contractId":"string","systemId":"string","externalEventStatus":"string"}},"responses":{"200":"createConsumerLoanRepaymentResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"PUT","path":"/holdings/loans/consumerLoans/{consumerLoanId}/principalDecreases","fullPath":"/api/v5.0.0/holdings/loans/consumerLoans/{consumerLoanId}/principalDecreases","operationId":"createConsumerLoanPrepayment","name":"Initiates the advance repayment of the given consumer loan amount","summary":"Prepays the consumer loan amount ","tags":["RETAIL"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"consumerLoanId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"currencyId":"string","effectiveDate":"2024-01-01","activityId":"string","transactionAmount":0.0,"contractId":"string","systemId":"string","externalEventStatus":"string"}},"responses":{"200":"createConsumerLoanPrepaymentResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"PUT","path":"/holdings/loans/consumerLoans/{consumerLoanId}/schedules","fullPath":"/api/v5.0.0/holdings/loans/consumerLoans/{consumerLoanId}/schedules","operationId":"updateConsumerLoanSchedule","name":"Initiates the change of payment schedule for the given consumer loan contract","summary":"Change payment schedule of the consumer loan","tags":["RETAIL"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"consumerLoanId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"effectiveDate":"2024-01-01","activityId":"string","externalEventStatus":"string"}},"responses":{"200":"updateConsumerLoanScheduleResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"PUT","path":"/holdings/loans/consumerLoans/{consumerLoanId}/paymentHolidays","fullPath":"/api/v5.0.0/holdings/loans/consumerLoans/{consumerLoanId}/paymentHolidays","operationId":"updateConsumerLoanHoliday","name":"Initiates the update of payment holiday for the given consumer loan contract ","summary":"Update payment holiday for the consumer loan ","tags":["RETAIL"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"consumerLoanId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"effectiveDate":"2024-01-01","activityId":"string","externalEventStatus":"string"}},"responses":{"200":"updateConsumerLoanHolidayResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"GET","path":"/holdings/loans/{loanId}/outstandingBills","fullPath":"/api/v5.0.0/holdings/loans/{loanId}/outstandingBills","operationId":"getLoanOutstandingBills","name":"Retrieves the outstanding amount to be paid for a loan","summary":"Retrieves the outstanding amount to be paid for the given loan","tags":["RETAIL"],"parameters":[{"name":"loanId","in":"path","type":"string","required":true,"description":"Denotes the arrangement id of the loan"},{"name":"fileVersion","in":"query","type":"string","required":false,"description":"Indicates if the file is of type simulation or live"},{"name":"simulationReference","in":"query","type":"string","required":false,"description":"Indicates the Reference ID for simulation activity"},{"name":"paymentDate","in":"query","type":"string","required":false,"description":"The date on which a payment is due"},{"name":"deferDate","in":"query","type":"string","required":false,"description":"Date that the payment has been deferred to"},{"name":"billedAmount","in":"query","type":"string","required":false,"description":"Indicates the bill amount"},{"name":"outstandingAmount","in":"query","type":"string","required":false,"description":"Contains the aggregate outstanding principal amount thereof after giving effect to any borrowings and prepayments or repayments of Committed Loans"},{"name":"delinquentAmount","in":"query","type":"string","required":false,"description":"Indicates the bill amount during the ageing status(Bill which crossed the due date)"},{"name":"property","in":"query","type":"string","required":false,"description":"Id of the product property"},{"name":"billStatus","in":"query","type":"string","required":false,"description":"Indicates the status of a bill(Issued,Due,Ageing,Settled)"},{"name":"settlementStatus","in":"query","type":"string","required":false,"description":"Defines the status of the settlement for the incoming MT548 swift message.The values allowed are: Waiting : pending to receive settlement status update meaning pending to receive MT548 swift message, "},{"name":"agingStatus","in":"query","type":"string","required":false,"description":"Indicates the ageing status of a bill"},{"name":"settled","in":"query","type":"string","required":false,"description":"Flag to indicate whether a bill is settled or not"},{"name":"paymentType","in":"query","type":"string","required":false,"description":"Indicates if the payment is Customer (C) type or Bank (B) type"},{"name":"billDate","in":"query","type":"string","required":false,"description":"Indicates a date on which a bill has been raised"},{"name":"paymentMethod","in":"query","type":"string","required":false,"description":"Method chosen to make the payment"},{"name":"infoPayType","in":"query","type":"string","required":false,"description":"Indicates a bill which is raised when a loan is paid off"},{"name":"advancePayment","in":"query","type":"string","required":false,"description":"Indicates whether advance payment made is set on an account"},{"name":"paymentIndicator","in":"query","type":"string","required":false,"description":"Indicates whether its a credit/debit type of bill"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"LoanOutstandingBillsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/loans/{loanId}/payoffCalculations","fullPath":"/api/v5.0.0/holdings/loans/{loanId}/payoffCalculations","operationId":"getLoanPayoffDetails","name":"Retrieves the payoff details of a loan","summary":"Retrieves the payoff details of the given loan","tags":["RETAIL"],"parameters":[{"name":"loanId","in":"path","type":"string","required":true,"description":"Denotes the arrangement id of the loan"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"LoanPayoffDetailsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"PUT","path":"/holdings/loans/consumerLoans/{consumerLoanId}/customers","fullPath":"/api/v5.0.0/holdings/loans/consumerLoans/{consumerLoanId}/customers","operationId":"updateConsumerLoansCustomer","name":"Initiates the change of customers for the given consumer loan contract","summary":"Changes the customers of the consumer loan ","tags":["RETAIL"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"consumerLoanId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"partyIds":[{}],"effectiveDate":"2024-01-01","activityId":"string","externalEventStatus":"string"}},"responses":{"200":"updateConsumerLoansCustomerResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"PUT","path":"/holdings/loans/consumerLoans/{consumerLoanId}/payoffs","fullPath":"/api/v5.0.0/holdings/loans/consumerLoans/{consumerLoanId}/payoffs","operationId":"createPayoffConsumerLoan","name":"Initiates the payoff of the given consumer loan contract amount","summary":"Payoffs the consumer loan amount","tags":["RETAIL"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"consumerLoanId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"currencyId":"string","effectiveDate":"2024-01-01","activityId":"string","transactionAmount":0.0,"contractId":"string","systemId":"string","externalEventStatus":"string"}},"responses":{"200":"createPayoffConsumerLoanResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"PUT","path":"/holdings/loans/consumerLoans/{consumerLoanId}/renegotiations","fullPath":"/api/v5.0.0/holdings/loans/consumerLoans/{consumerLoanId}/renegotiations","operationId":"updateConsumerLoanConditions","name":"Initiates the renegotiation of the given consumer loan contract details","summary":"Renegotiates the consumer loan contract details","tags":["RETAIL"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"consumerLoanId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"effectiveDate":"2024-01-01","activityId":"string","externalEventStatus":"string"}},"responses":{"200":"updateConsumerLoanConditionsResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"GET","path":"/holdings/loans/{loanId}/status","fullPath":"/api/v5.0.0/holdings/loans/{loanId}/status","operationId":"getArrangementDetails","name":"Retrieves the status of loan","summary":"Retrieves the status of the given loan","tags":["RETAIL"],"parameters":[{"name":"loanId","in":"path","type":"string","required":true,"description":"Denotes the arrangement id of the loan"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"ArrangementDetailsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/loans/arrangements/activities/{arrangementActivityId}/status","fullPath":"/api/v5.0.0/holdings/loans/arrangements/activities/{arrangementActivityId}/status","operationId":"getExternalEventStatus","name":"Retrieves the status of the given activity ","summary":"Retrieves the status of the given activity ","tags":["RETAIL"],"parameters":[{"name":"arrangementActivityId","in":"path","type":"string","required":true,"description":"The unique identifier of an arrangement activity"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"ExternalEventStatusResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"PUT","path":"/holdings/loans/consumerLoans/{consumerLoanId}/payoffCalculations","fullPath":"/api/v5.0.0/holdings/loans/consumerLoans/{consumerLoanId}/payoffCalculations","operationId":"calculatePayoffConsumerLoans","name":"Initiates calculate payoff activity to calculate consumer loan payment amount to close the given loan","summary":"Calculates consumer loan payment amount to close a loan","tags":["RETAIL"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"consumerLoanId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"parties":[{}],"activityId":"string","effectiveDate":"string","productId":"string","currencyId":"string","simulationId":"string"}},"responses":{"200":"calculatePayoffConsumerLoansResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"GET","path":"/holdings/loans/{loanId}/schedules","fullPath":"/api/v5.0.0/holdings/loans/{loanId}/schedules","operationId":"getPaymentSchedulesProjection","name":"Retrieves the schedule payment information for paid and upcoming installment details","summary":"Retrieves payment schedules details","tags":["RETAIL"],"parameters":[{"name":"loanId","in":"path","type":"string","required":true,"description":"Denotes the arrangement id of the loan"},{"name":"dateFrom","in":"query","type":"string","required":false,"description":"Start date of the loan"},{"name":"dateTo","in":"query","type":"string","required":false,"description":"End date of the loan"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"PaymentSchedulesProjectionResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/loans/{loanId}/loanDetails","fullPath":"/api/v5.0.0/holdings/loans/{loanId}/loanDetails","operationId":"getLoanOverview","name":"Retrieves the details of the given loan","summary":"Retrieves loan details ","tags":["RETAIL"],"parameters":[{"name":"loanId","in":"path","type":"string","required":true,"description":"Denotes the arrangement id of the loan"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"LoanOverviewResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/loans/{loanId}/bills","fullPath":"/api/v5.0.0/holdings/loans/{loanId}/bills","operationId":"getLoanBills","name":"Retrieves the simulation details of the contract based on the selection criteria. It returns the bill details of the loan","summary":"Retrieves loan bills details","tags":[],"parameters":[{"name":"loanId","in":"path","type":"string","required":true,"description":"Denotes the arrangement id of the loan"},{"name":"billType","in":"query","type":"string","required":false,"description":"The type of payment obligation generated"},{"name":"paymentDate","in":"query","type":"string","required":false,"description":"The date on which a payment is due"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"LoanBillsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/loans/{loanId}/collaterals","fullPath":"/api/v5.0.0/holdings/loans/{loanId}/collaterals","operationId":"getLoanCollaterals","name":"Retrieves the collateral details linked to the loan arrangement. The collateral right and status have to be passed within the api","summary":"Retrieves loan collateral details","tags":[],"parameters":[{"name":"loanId","in":"path","type":"string","required":true,"description":"Denotes the arrangement id of the loan"},{"name":"status","in":"query","type":"string","required":false,"description":"Contains status of the data rights request.Allowed values are INITIATED, INPROGESS, EXTENDED, COMPLETED, REJECTED."},{"name":"statusNE","in":"query","type":"string","required":false,"description":"Status not equal to"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"LoanCollateralsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/loans/{loanId}","fullPath":"/api/v5.0.0/holdings/loans/{loanId}","operationId":"getLoanDetails","name":"Retrieves the loan account details","summary":"Retrieves loan account details","tags":[],"parameters":[{"name":"loanId","in":"path","type":"string","required":true,"description":"Denotes the arrangement id of the loan"},{"name":"dateFrom","in":"query","type":"string","required":false,"description":"Start date of the loan"},{"name":"dateTo","in":"query","type":"string","required":false,"description":"End date of the loan"},{"name":"balanceTypes","in":"query","type":"string","required":false,"description":"Type of balance (e.g. current balance, credit interest accrued, deferred commission, etc.) as defined in the institution's accounting schemas."},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"LoanDetailsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/loans/{loanId}/schedulePaymentFrequencies","fullPath":"/api/v5.0.0/holdings/loans/{loanId}/schedulePaymentFrequencies","operationId":"getPaymentSchedules","name":"Retrieves the schedule payment information for paid and upcoming installments details","summary":"Retrieves payment schedules details","tags":[],"parameters":[{"name":"loanId","in":"path","type":"string","required":true,"description":"Denotes the arrangement id of the loan"},{"name":"dateFrom","in":"query","type":"string","required":false,"description":"Start date of the loan"},{"name":"dateTo","in":"query","type":"string","required":false,"description":"End date of the loan"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"PaymentSchedulesResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"POST","path":"/holdings/simulationCapture/{arrangementId}","fullPath":"/api/v5.0.0/holdings/simulationCapture/{arrangementId}","operationId":"createSimulationCapture","name":"Simulate payoff calculate activity for a loan arrangement","summary":"Simulate payoff calculate activity for a loan arrangement","tags":[],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"arrangementId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"customerIds":[{}],"properties":[{}],"overrides":[{}],"productId":"string","masterArrangementId":"string","roleName":"string","currencyId":"string","effectiveDate":"2024-01-01","activityId":"string","transactionAmount":0.0,"reason":"string","payoff":[{}]}},"responses":{"200":"createSimulationCaptureResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"POST","path":"/holdings/loans/simulations","fullPath":"/api/v5.0.0/holdings/loans/simulations","operationId":"createLoanSimulation","name":"This can be used to create a simulation for loan product and the payload should include customer identifier, currency, etc.","summary":"Create simulation for loan products","tags":["RETAIL"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"customerIds":[{}],"properties":[{}],"overrides":[{}],"productId":"string","masterArrangementId":"string","roleName":"string","currencyId":"string","effectiveDate":"2024-01-01","activityId":"string","transactionAmount":0.0,"reason":"string","automaticRun":"string","simulationRunReference":"string","synchronous":"string","account":[{}]}},"responses":{"200":"createLoanSimulationResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"PUT","path":"/holdings/loans/simulations/{simulationId}","fullPath":"/api/v5.0.0/holdings/loans/simulations/{simulationId}","operationId":"updateLoanSimulation","name":"This can be used to amend a simulation for loan product and the payload should include customer identifier, currency, etc.","summary":"Amend simulation for loan products","tags":["RETAIL"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"simulationId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"customerIds":[{}],"properties":[{}],"overrides":[{}],"productId":"string","masterArrangementId":"string","roleName":"string","currencyId":"string","effectiveDate":"2024-01-01","activityId":"string","transactionAmount":0.0,"reason":"string","automaticRun":"string","simulationRunReference":"string","synchronous":"string","account":[{}]}},"responses":{"200":"updateLoanSimulationResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"POST","path":"/holdings/loans/{loanId}/simulations/payoffs","fullPath":"/api/v5.0.0/holdings/loans/{loanId}/simulations/payoffs","operationId":"createLoanPayoffSimulation","name":"This can be used to create a simulation payoff activity for loan product and the payload should include product Id , etc.","summary":"Create simulation payoff activity for loan products","tags":["RETAIL"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"loanId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"customerIds":[{}],"properties":[{}],"overrides":[{}],"productId":"string","masterArrangementId":"string","roleName":"string","currencyId":"string","effectiveDate":"2024-01-01","activityId":"string","transactionAmount":0.0,"reason":"string","automaticRun":"string","simulationRunReference":"string","synchronous":"string","payoff":[{}]}},"responses":{"200":"createLoanPayoffSimulationResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"POST","path":"/holdings/loans/{loanId}/payoffs","fullPath":"/api/v5.0.0/holdings/loans/{loanId}/payoffs","operationId":"createLoanArrangementPayoff","name":" This can be used to execute payoff activity for loan product and the payload should include simulation run reference, product Id , etc.","summary":"Execute payoff activity for loan products","tags":["RETAIL"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"loanId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"customerIds":[{}],"properties":[{}],"overrides":[{}],"productId":"string","masterArrangementId":"string","roleName":"string","currencyId":"string","effectiveDate":"2024-01-01","activityId":"string","transactionAmount":0.0,"reason":"string","simulationRunReference":"string","payoff":[{}]}},"responses":{"200":"createLoanArrangementPayoffResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"GET","path":"/holdings/loans/{loanId}/overpayments","fullPath":"/api/v5.0.0/holdings/loans/{loanId}/overpayments","operationId":"getOverpaymentDetails","name":"Fetch the product id, type of overpay, overpay limit, overpay period, utilized overpay and remaining overpay limit of a loan arrangement","summary":"To  fetch overpayment details that has happened for a loan arrangement","tags":["RETAIL"],"parameters":[{"name":"loanId","in":"path","type":"string","required":true,"description":"Denotes the arrangement id of the loan"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"OverpaymentDetailsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}}]},{"key":"holdings-loans-arrangements-v5.1.0","title":"Loan creation","version":"v5.1.0","description":"API to create and Manage various types of loans such as Personal, Commercial, Mortgage, Line of Credit, etc","endpointCount":41,"endpoints":[{"method":"POST","path":"/holdings/loans/personalLoans","fullPath":"/api/v5.1.0/holdings/loans/personalLoans","operationId":"createPersonalLoan","name":"Create a personal loan account","summary":"Create a personal loan account","tags":[],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"partyIds":[{}],"partyRoles":[{}],"agentCustomerIds":[{}],"agentArrangementIds":[{}],"agentRoles":[{}],"arrangmentId":"string","productId":"string","activityId":"string","currency":"string","productVariation":"string","pricingSelection":"string","pricingPlan":"string","rewardsArrangementId":"string","tradeDate":"string","arrangementEffectiveDate":"string"}},"responses":{"200":"createPersonalLoanResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"POST","path":"/holdings/loans/linkedRateLoans","fullPath":"/api/v5.1.0/holdings/loans/linkedRateLoans","operationId":"createLinkedRateLoan","name":"Create a personal loan account with linked rate","summary":"Create a personal loan account with linked rate","tags":[],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"partyIds":[{}],"partyRoles":[{}],"agentCustomerIds":[{}],"agentArrangementIds":[{}],"agentRoles":[{}],"arrangmentId":"string","productId":"string","activityId":"string","currency":"string","productVariation":"string","pricingSelection":"string","pricingPlan":"string","rewardsArrangementId":"string","tradeDate":"string","arrangementEffectiveDate":"string"}},"responses":{"200":"createLinkedRateLoanResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"POST","path":"/holdings/loans/commercialLoans","fullPath":"/api/v5.1.0/holdings/loans/commercialLoans","operationId":"createCommercialLoan","name":"Create a commercial or business account","summary":"Create a commercial or business account","tags":[],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"partyIds":[{}],"partyRoles":[{}],"agentCustomerIds":[{}],"agentArrangementIds":[{}],"agentRoles":[{}],"arrangmentId":"string","productId":"string","activityId":"string","currency":"string","productVariation":"string","pricingSelection":"string","pricingPlan":"string","rewardsArrangementId":"string","tradeDate":"string","arrangementEffectiveDate":"string"}},"responses":{"200":"createCommercialLoanResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"POST","path":"/holdings/loans/mortgages","fullPath":"/api/v5.1.0/holdings/loans/mortgages","operationId":"createMortgage","name":"Create a mortgage loan","summary":"Create a mortgage loan","tags":[],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"partyIds":[{}],"partyRoles":[{}],"agentCustomerIds":[{}],"agentArrangementIds":[{}],"agentRoles":[{}],"arrangmentId":"string","productId":"string","activityId":"string","currency":"string","productVariation":"string","pricingSelection":"string","pricingPlan":"string","rewardsArrangementId":"string","tradeDate":"string","arrangementEffectiveDate":"string"}},"responses":{"200":"createMortgageResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"POST","path":"/holdings/loans/creditLines","fullPath":"/api/v5.1.0/holdings/loans/creditLines","operationId":"createCreditLine","name":"Create a lines of credit account","summary":"Create a lines of credit account","tags":[],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"partyIds":[{}],"partyRoles":[{}],"agentCustomerIds":[{}],"agentArrangementIds":[{}],"agentRoles":[{}],"arrangmentId":"string","productId":"string","activityId":"string","currency":"string","productVariation":"string","pricingSelection":"string","pricingPlan":"string","rewardsArrangementId":"string","tradeDate":"string","arrangementEffectiveDate":"string"}},"responses":{"200":"createCreditLineResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"POST","path":"/holdings/facilities/installmentLoans","fullPath":"/api/v5.1.0/holdings/facilities/installmentLoans","operationId":"createInstallmentLoan","name":"Create an installment loan for the given product","summary":"Create an installment loan for the given product","tags":[],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"customers":[{}],"arrangmentId":"string","currency":"string","facilityId":"string","effectiveDate":"string","activity":"string","productId":"string","extensions":{},"account":[{}],"schedule":[{}],"settlement":[{}],"commitment":[{}]}},"responses":{"200":"createInstallmentLoanResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"POST","path":"/holdings/fundsTransfer","fullPath":"/api/v5.1.0/holdings/fundsTransfer","operationId":"createFundsTransfer","name":"Create an account transfer","summary":"Create an account transfer","tags":[],"parameters":[{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"transactionType":"string","debitAccountId":"string","debitCurrency":"string","debitAmount":0.0,"debitValueDate":"2024-01-01","creditAccountId":"string","creditCurrencyId":"string","creditAmount":0.0,"creditValueDate":"2024-01-01","commissionCode":"string","commissionType":"string","commissionAmount":0.0,"paymentDetails":"string","extensions":{}}},"responses":{"200":"FundsTransferResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"POST","path":"/holdings/loans/consumerLoans","fullPath":"/api/v5.1.0/holdings/loans/consumerLoans","operationId":"createConsumerLoan","name":"creates a consumer loan for the given product","summary":"Initiates the creation of consumer loan for the given product","tags":["RETAIL"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"partyIds":[{}],"productId":"string","activityId":"string","currency":"string","arrangementEffectiveDate":"string","externalEventStatus":"string","extensions":{}}},"responses":{"200":"createConsumerLoanResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"PUT","path":"/holdings/loans/consumerLoans/{consumerLoanId}/disbursements","fullPath":"/api/v5.1.0/holdings/loans/consumerLoans/{consumerLoanId}/disbursements","operationId":"createConsumerLoanDisbursement","name":"Initiates the disbursement of the given consumer loan contracts commitment amount","summary":"Disburses the consumer loan commitment amount","tags":["RETAIL"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"consumerLoanId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"currencyId":"string","effectiveDate":"2024-01-01","activityId":"string","transactionAmount":0.0,"contractId":"string","systemId":"string","externalEventStatus":"string","extensions":{}}},"responses":{"200":"createConsumerLoanDisbursementResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"PUT","path":"/holdings/loans/consumerLoans/{consumerLoanId}/commitmentIncreases","fullPath":"/api/v5.1.0/holdings/loans/consumerLoans/{consumerLoanId}/commitmentIncreases","operationId":"updateConsumerLoanTopupAmount","name":"Increases the commitment amount of the consumer loan","summary":"Increases the commitment amount of the given consumer loan contract","tags":["RETAIL"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"consumerLoanId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"effectiveDate":"2024-01-01","activityId":"string","externalEventStatus":"string","extensions":{}}},"responses":{"200":"updateConsumerLoanTopupAmountResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"PUT","path":"/holdings/loans/consumerLoans/{consumerLoanId}/commitmentDecreases","fullPath":"/api/v5.1.0/holdings/loans/consumerLoans/{consumerLoanId}/commitmentDecreases","operationId":"updateConsumerLoanDecreaseAmount","name":"Decreases the commitment amount of the consumer loan","summary":"Decreases the commitment amount of the given consumer loan contract","tags":["RETAIL"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"consumerLoanId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"effectiveDate":"2024-01-01","activityId":"string","externalEventStatus":"string","extensions":{}}},"responses":{"200":"updateConsumerLoanDecreaseAmountResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"PUT","path":"/holdings/loans/consumerLoans/{consumerLoanId}/repayments","fullPath":"/api/v5.1.0/holdings/loans/consumerLoans/{consumerLoanId}/repayments","operationId":"createConsumerLoanRepayment","name":"Initiates the repayment of the given consumer loan amount","summary":"Repays the consumer loan amount","tags":["RETAIL"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"consumerLoanId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"currencyId":"string","effectiveDate":"2024-01-01","activityId":"string","transactionAmount":0.0,"contractId":"string","systemId":"string","externalEventStatus":"string","extensions":{}}},"responses":{"200":"createConsumerLoanRepaymentResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"PUT","path":"/holdings/loans/consumerLoans/{consumerLoanId}/principalDecreases","fullPath":"/api/v5.1.0/holdings/loans/consumerLoans/{consumerLoanId}/principalDecreases","operationId":"createConsumerLoanPrepayment","name":"Initiates the advance repayment of the given consumer loan amount","summary":"Prepays the consumer loan amount","tags":["RETAIL"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"consumerLoanId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"currencyId":"string","effectiveDate":"2024-01-01","activityId":"string","transactionAmount":0.0,"contractId":"string","systemId":"string","externalEventStatus":"string","extensions":{}}},"responses":{"200":"createConsumerLoanPrepaymentResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"PUT","path":"/holdings/loans/consumerLoans/{consumerLoanId}/schedules","fullPath":"/api/v5.1.0/holdings/loans/consumerLoans/{consumerLoanId}/schedules","operationId":"updateConsumerLoanSchedule","name":"Initiates the change of payment schedule for the given consumer loan contract","summary":"Change payment schedule of the consumer loan","tags":["RETAIL"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"consumerLoanId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"effectiveDate":"2024-01-01","activityId":"string","externalEventStatus":"string","extensions":{}}},"responses":{"200":"updateConsumerLoanScheduleResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"PUT","path":"/holdings/loans/consumerLoans/{consumerLoanId}/paymentHolidays","fullPath":"/api/v5.1.0/holdings/loans/consumerLoans/{consumerLoanId}/paymentHolidays","operationId":"updateConsumerLoanHoliday","name":"Initiates the update of payment holiday for the given consumer loan contract","summary":"Update payment holiday for the consumer loan","tags":["RETAIL"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"consumerLoanId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"effectiveDate":"2024-01-01","activityId":"string","externalEventStatus":"string","extensions":{}}},"responses":{"200":"updateConsumerLoanHolidayResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"GET","path":"/holdings/loans/{loanId}/outstandingBills","fullPath":"/api/v5.1.0/holdings/loans/{loanId}/outstandingBills","operationId":"getLoanOutstandingBills","name":"Retrieves the outstanding amount to be paid for a loan","summary":"Retrieves the outstanding amount to be paid for the given loan","tags":["RETAIL"],"parameters":[{"name":"loanId","in":"path","type":"string","required":true,"description":"Denotes the arrangement id of the loan"},{"name":"fileVersion","in":"query","type":"string","required":false,"description":"Indicates if the file is of type simulation or live"},{"name":"simulationReference","in":"query","type":"string","required":false,"description":"Indicates the reference id for simulation activity"},{"name":"paymentDate","in":"query","type":"string","required":false,"description":"Contains the date in which the payment will be sent out. Date in the format YYYYMMDD. E.g. 20191231"},{"name":"deferDate","in":"query","type":"string","required":false,"description":"Date that the payment has been deferred to"},{"name":"billedAmount","in":"query","type":"string","required":false,"description":"Indicates the bill amount"},{"name":"outstandingAmount","in":"query","type":"string","required":false,"description":"Contains the aggregate outstanding principal amount thereof after giving effect to any borrowings and prepayments or repayments of Committed Loans"},{"name":"delinquentAmount","in":"query","type":"string","required":false,"description":"Indicates the bill amount during the ageing status(Bill which crossed the due date)"},{"name":"property","in":"query","type":"string","required":false,"description":"Id of the product property"},{"name":"billStatus","in":"query","type":"string","required":false,"description":"Indicates the status of a bill(Issued,Due,Ageing,Settled)"},{"name":"settlementStatus","in":"query","type":"string","required":false,"description":"Defines the status of the settlement for the incoming MT548 swift message.The values allowed are: Waiting : pending to receive settlement status update meaning pending to receive MT548 swift message, "},{"name":"agingStatus","in":"query","type":"string","required":false,"description":"Indicates the ageing status of a bill"},{"name":"settled","in":"query","type":"string","required":false,"description":"Flag to indicate whether a bill is settled or not"},{"name":"paymentType","in":"query","type":"string","required":false,"description":"Indicates if the payment is Customer (C) type or Bank (B) type"},{"name":"billDate","in":"query","type":"string","required":false,"description":"Indicates a date on which a bill has been raised"},{"name":"paymentMethod","in":"query","type":"string","required":false,"description":"Method chosen to make the payment"},{"name":"infoPayType","in":"query","type":"string","required":false,"description":"Indicates a bill which is raised when a loan is paid off"},{"name":"advancePayment","in":"query","type":"string","required":false,"description":"Indicates whether advance payment made is set on an account"},{"name":"paymentIndicator","in":"query","type":"string","required":false,"description":"Indicates whether its a credit/debit type of bill"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"LoanOutstandingBillsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/loans/{loanId}/payoffCalculations","fullPath":"/api/v5.1.0/holdings/loans/{loanId}/payoffCalculations","operationId":"getLoanPayoffDetails","name":"Retrieves the payoff details of a loan","summary":"Retrieves the payoff details of the given loan","tags":["RETAIL"],"parameters":[{"name":"loanId","in":"path","type":"string","required":true,"description":"Denotes the arrangement id of the loan"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"LoanPayoffDetailsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"PUT","path":"/holdings/loans/consumerLoans/{consumerLoanId}/customers","fullPath":"/api/v5.1.0/holdings/loans/consumerLoans/{consumerLoanId}/customers","operationId":"updateConsumerLoansCustomer","name":"Initiates the change of customers for the given consumer loan contract","summary":"Changes the customers of the consumer loan ","tags":["RETAIL"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"consumerLoanId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"partyIds":[{}],"effectiveDate":"2024-01-01","activityId":"string","externalEventStatus":"string","extensions":{}}},"responses":{"200":"updateConsumerLoansCustomerResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"PUT","path":"/holdings/loans/consumerLoans/{consumerLoanId}/payoffs","fullPath":"/api/v5.1.0/holdings/loans/consumerLoans/{consumerLoanId}/payoffs","operationId":"createPayoffConsumerLoan","name":"Initiates the payoff of the given consumer loan contract amount","summary":"Payoffs the consumer loan amount","tags":["RETAIL"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"consumerLoanId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"currencyId":"string","effectiveDate":"2024-01-01","activityId":"string","transactionAmount":0.0,"contractId":"string","systemId":"string","externalEventStatus":"string","extensions":{}}},"responses":{"200":"createPayoffConsumerLoanResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"PUT","path":"/holdings/loans/consumerLoans/{consumerLoanId}/renegotiations","fullPath":"/api/v5.1.0/holdings/loans/consumerLoans/{consumerLoanId}/renegotiations","operationId":"updateConsumerLoanConditions","name":"Initiates the renegotiation of the given consumer loan contract details","summary":"Renegotiates the consumer loan contract details","tags":["RETAIL"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"consumerLoanId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"effectiveDate":"2024-01-01","activityId":"string","externalEventStatus":"string","extensions":{}}},"responses":{"200":"updateConsumerLoanConditionsResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"GET","path":"/holdings/loans/{loanId}/status","fullPath":"/api/v5.1.0/holdings/loans/{loanId}/status","operationId":"getArrangementDetails","name":"Retrieves the status of a loan","summary":"Retrieves the status of the given loan","tags":["RETAIL"],"parameters":[{"name":"loanId","in":"path","type":"string","required":true,"description":"Denotes the arrangement id of the loan"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"ArrangementDetailsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/loans/arrangements/activities/{arrangementActivityId}/status","fullPath":"/api/v5.1.0/holdings/loans/arrangements/activities/{arrangementActivityId}/status","operationId":"getExternalEventStatus","name":"Retrieves the status of the given activity ","summary":"Retrieves the status of the given activity ","tags":["RETAIL"],"parameters":[{"name":"arrangementActivityId","in":"path","type":"string","required":true,"description":"Contains the arrangement activity reference identifier"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"ExternalEventStatusResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"PUT","path":"/holdings/loans/consumerLoans/{consumerLoanId}/payoffCalculations","fullPath":"/api/v5.1.0/holdings/loans/consumerLoans/{consumerLoanId}/payoffCalculations","operationId":"calculatePayoffConsumerLoans","name":"Initiates calculate pyoff activity to calculate consumer loan payment amount to close the given loan","summary":"Calculates consumer loan payment amount to close a loan","tags":["RETAIL"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"consumerLoanId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"parties":[{}],"activityId":"string","effectiveDate":"string","productId":"string","currencyId":"string","simulationId":"string","extensions":{}}},"responses":{"200":"calculatePayoffConsumerLoansResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"GET","path":"/holdings/loans/{loanId}/schedules","fullPath":"/api/v5.1.0/holdings/loans/{loanId}/schedules","operationId":"getPaymentSchedulesProjection","name":"Retrieves the schedule payment information for paid and upcoming installments details","summary":"Retrieves payment schedules details","tags":["RETAIL"],"parameters":[{"name":"loanId","in":"path","type":"string","required":true,"description":"Denotes the arrangement id of the loan"},{"name":"dateFrom","in":"query","type":"string","required":false,"description":"Start date of the loan"},{"name":"dateTo","in":"query","type":"string","required":false,"description":"End date of the loan"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"PaymentSchedulesProjectionResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/loans/{loanId}/loanDetails","fullPath":"/api/v5.1.0/holdings/loans/{loanId}/loanDetails","operationId":"getLoanOverview","name":"Retrieves the details of the given loan","summary":"Retrieves loan details ","tags":["RETAIL"],"parameters":[{"name":"loanId","in":"path","type":"string","required":true,"description":"Denotes the arrangement id of the loan"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"LoanOverviewResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/loans/{loanId}/bills","fullPath":"/api/v5.1.0/holdings/loans/{loanId}/bills","operationId":"getLoanBills","name":"Retrieves the simulation details of the contract based on the selection criteria. It returns the bill details of the loan","summary":"Retrieves loan bills details","tags":[],"parameters":[{"name":"loanId","in":"path","type":"string","required":true,"description":"Denotes the arrangement id of the loan"},{"name":"billType","in":"query","type":"string","required":false,"description":"The type of payment obligation generated"},{"name":"paymentDate","in":"query","type":"string","required":false,"description":"Contains the date in which the payment will be sent out. Date in the format YYYYMMDD. E.g. 20191231"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"LoanBillsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/loans/{loanId}/collaterals","fullPath":"/api/v5.1.0/holdings/loans/{loanId}/collaterals","operationId":"getLoanCollaterals","name":"Retrieves the collateral details linked to the loan arrangement. The collateral right and status have to be passed within the api","summary":"Retrieves loan collateral details","tags":[],"parameters":[{"name":"loanId","in":"path","type":"string","required":true,"description":"Denotes the arrangement id of the loan"},{"name":"status","in":"query","type":"string","required":false,"description":"Contains status of the data rights request.Allowed values are INITIATED, INPROGESS, EXTENDED, COMPLETED, REJECTED."},{"name":"statusNE","in":"query","type":"string","required":false,"description":"Status not equal to"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"LoanCollateralsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/loans/{loanId}","fullPath":"/api/v5.1.0/holdings/loans/{loanId}","operationId":"getLoanDetails","name":"Retrieves loan details","summary":"Retrieves the loan account details","tags":[],"parameters":[{"name":"loanId","in":"path","type":"string","required":true,"description":"Denotes the arrangement id of the loan"},{"name":"dateFrom","in":"query","type":"string","required":false,"description":"Start date of the loan"},{"name":"dateTo","in":"query","type":"string","required":false,"description":"End date of the loan"},{"name":"balanceTypes","in":"query","type":"string","required":false,"description":"Type of balance (e.g. current balance, credit interest accrued, deferred commission, etc.) as defined in the institution's accounting schemas."},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"LoanDetailsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/loans/{loanId}/schedulePaymentFrequencies","fullPath":"/api/v5.1.0/holdings/loans/{loanId}/schedulePaymentFrequencies","operationId":"getPaymentSchedules","name":"Retrieves the schedule payment information for paid and upcoming installments details","summary":"Retrieves payment schedules details","tags":[],"parameters":[{"name":"loanId","in":"path","type":"string","required":true,"description":"Denotes the arrangement id of the loan"},{"name":"dateFrom","in":"query","type":"string","required":false,"description":"Start date of the loan"},{"name":"dateTo","in":"query","type":"string","required":false,"description":"End date of the loan"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"PaymentSchedulesResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"POST","path":"/holdings/simulationCapture/{arrangementId}","fullPath":"/api/v5.1.0/holdings/simulationCapture/{arrangementId}","operationId":"createSimulationCapture","name":"Simulate payoff calculate activity for a loan arrangement","summary":"Simulate payoff calculate activity for a loan arrangement","tags":[],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"arrangementId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"customerIds":[{}],"properties":[{}],"overrides":[{}],"productId":"string","masterArrangementId":"string","roleName":"string","currencyId":"string","effectiveDate":"2024-01-01","activityId":"string","transactionAmount":0.0,"reason":"string","simulationRunReference":"string","extensions":{},"payoff":[{}]}},"responses":{"200":"createSimulationCaptureResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"POST","path":"/holdings/loans/simulations","fullPath":"/api/v5.1.0/holdings/loans/simulations","operationId":"createLoanSimulation","name":"Create a simulation for loan product with details like customer identifier, currency, etc.","summary":"Create simulation for loan products","tags":["RETAIL"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"customerIds":[{}],"properties":[{}],"overrides":[{}],"productId":"string","masterArrangementId":"string","roleName":"string","currencyId":"string","effectiveDate":"2024-01-01","activityId":"string","transactionAmount":0.0,"reason":"string","automaticRun":"string","simulationRunReference":"string","synchronous":"string","extensions":{}}},"responses":{"200":"createLoanSimulationResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"PUT","path":"/holdings/loans/simulations/{simulationId}","fullPath":"/api/v5.1.0/holdings/loans/simulations/{simulationId}","operationId":"updateLoanSimulation","name":"Update a simulation for loan product with details like customer identifier, currency, etc.","summary":"Update a simulation for loan products","tags":["RETAIL"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"simulationId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"customerIds":[{}],"properties":[{}],"overrides":[{}],"productId":"string","masterArrangementId":"string","roleName":"string","currencyId":"string","effectiveDate":"2024-01-01","activityId":"string","transactionAmount":0.0,"reason":"string","automaticRun":"string","simulationRunReference":"string","synchronous":"string","extensions":{}}},"responses":{"200":"updateLoanSimulationResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"POST","path":"/holdings/loans/{loanId}/simulations/payoffs","fullPath":"/api/v5.1.0/holdings/loans/{loanId}/simulations/payoffs","operationId":"createLoanPayoffSimulation","name":"Create a simulation payoff activity for loan product with product id details","summary":"Create simulation payoff activity for loan products","tags":["RETAIL"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"loanId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"customerIds":[{}],"properties":[{}],"overrides":[{}],"productId":"string","masterArrangementId":"string","roleName":"string","currencyId":"string","effectiveDate":"2024-01-01","activityId":"string","transactionAmount":0.0,"reason":"string","automaticRun":"string","simulationRunReference":"string","synchronous":"string","extensions":{}}},"responses":{"200":"createLoanPayoffSimulationResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"POST","path":"/holdings/loans/{loanId}/payoffs","fullPath":"/api/v5.1.0/holdings/loans/{loanId}/payoffs","operationId":"createLoanArrangementPayoff","name":"Execute payoff activity for loan product with details like simulation run reference, product id , etc.","summary":"Execute payoff activity for loan products","tags":["RETAIL"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"loanId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"customerIds":[{}],"properties":[{}],"overrides":[{}],"productId":"string","masterArrangementId":"string","roleName":"string","currencyId":"string","effectiveDate":"2024-01-01","activityId":"string","transactionAmount":0.0,"reason":"string","simulationRunReference":"string","extensions":{},"payoff":[{}]}},"responses":{"200":"createLoanArrangementPayoffResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"GET","path":"/holdings/loans/{loanId}/overpayments","fullPath":"/api/v5.1.0/holdings/loans/{loanId}/overpayments","operationId":"getOverpaymentDetails","name":"Retrieves the product id, type of overpay, overpay limit, overpay period, utilised overpay and remaining overpay limit of a loan arrangement","summary":"Retrieves overpayment details that has happened for a loan arrangement","tags":["RETAIL"],"parameters":[{"name":"loanId","in":"path","type":"string","required":true,"description":"Denotes the arrangement id of the loan"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"OverpaymentDetailsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"POST","path":"/holdings/loans/drawdowns/offers","fullPath":"/api/v5.1.0/holdings/loans/drawdowns/offers","operationId":"createLoanDrawdownOffer","name":"Creates a new drawdown offer for the required customer.","summary":"Creates a new drawdown offer for the required customer.","tags":[],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"customers":[{}],"productId":"string","currency":"string","facilityId":"string","offerDate":"2024-01-01","drawdownDate":"2024-01-01","activity":"string","pricingSelection":"string","pricingPlan":"string","rewardsArrangementId":"string","extensions":{},"principalint":[{}],"penaltyint":[{}],"penalinterest":[{}],"schedule":[{}]}},"responses":{"200":"createLoanDrawdownOfferResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"POST","path":"/holdings/loans/{loanId}/drawdowns/acceptances","fullPath":"/api/v5.1.0/holdings/loans/{loanId}/drawdowns/acceptances","operationId":"createLoanDrawdownOfferAcceptance","name":"Accept the offer drawdown for the retail loan and convert offer drawdown into a live loan arrangement.","summary":"Accept the offer drawdown for the retail loan and convert offer drawdown into a live loan arrangement.","tags":[],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"loanId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"customers":[{}],"productId":"string","currency":"string","facilityId":"string","offerDate":"2024-01-01","drawdownDate":"2024-01-01","activity":"string","pricingSelection":"string","pricingPlan":"string","rewardsArrangementId":"string","extensions":{},"principalint":[{}],"penaltyint":[{}],"penalinterest":[{}],"schedule":[{}]}},"responses":{"200":"createLoanDrawdownOfferAcceptanceResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"POST","path":"/holdings/loans/{loanId}/drawdowns/renegotiations","fullPath":"/api/v5.1.0/holdings/loans/{loanId}/drawdowns/renegotiations","operationId":"createLoanDrawdownOfferRenegotiation","name":"Renegotiate the offer drawdown for the retail loan and convert offer drawdown into live loan arrangement.","summary":"Renegotiate the offer drawdown for the required customer.","tags":[],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"loanId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"customers":[{}],"productId":"string","currency":"string","facilityId":"string","offerDate":"2024-01-01","drawdownDate":"2024-01-01","activity":"string","pricingSelection":"string","pricingPlan":"string","rewardsArrangementId":"string","extensions":{},"principalint":[{}],"penaltyint":[{}],"penalinterest":[{}],"schedule":[{}]}},"responses":{"200":"createLoanDrawdownOfferRenegotiationResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"POST","path":"/holdings/loans/{loanId}/drawdowns/cancellations","fullPath":"/api/v5.1.0/holdings/loans/{loanId}/drawdowns/cancellations","operationId":"cancelLoanDrawdownOffer","name":"Cancellation of offer drawdown for the required customer.","summary":"Cancellation of offer drawdown for the required customer.","tags":[],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"loanId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"customers":[{}],"productId":"string","currency":"string","facilityId":"string","offerDate":"2024-01-01","drawdownDate":"2024-01-01","activity":"string","extensions":{}}},"responses":{"200":"cancelLoanDrawdownOfferResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"POST","path":"/holdings/loans/{loanId}/drawdowns/acceptances/schedules","fullPath":"/api/v5.1.0/holdings/loans/{loanId}/drawdowns/acceptances/schedules","operationId":"createLoanDrawdownOfferAcceptanceSchedules","name":"Accept the offer drawdown for the retail loan and convert offer drawdown into a live loan arrangement and retrieve the payment schedule details.","summary":"Accept the offer drawdown for the retail loan and convert offer drawdown into a live loan arrangement and retrieve the payment schedule details.","tags":[],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"loanId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"customers":[{}],"productId":"string","currency":"string","facilityId":"string","offerDate":"2024-01-01","drawdownDate":"2024-01-01","activity":"string","pricingSelection":"string","pricingPlan":"string","rewardsArrangementId":"string","extensions":{},"principalint":[{}],"penaltyint":[{}],"penalinterest":[{}],"schedule":[{}]}},"responses":{"200":"createLoanDrawdownOfferAcceptanceSchedulesResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"POST","path":"/holdings/loans/{loanId}/drawdowns/renegotiations/schedules","fullPath":"/api/v5.1.0/holdings/loans/{loanId}/drawdowns/renegotiations/schedules","operationId":"createLoanDrawdownOfferRenegotiationSchedules","name":"Renegotiate the offer drawdown for the retail loan and convert offer drawdown into live loan arrangement and retrieve the payment schedule details.","summary":"Renegotiate the offer drawdown for the required customer and retrieve the payment schedule details.","tags":[],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"loanId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"customers":[{}],"productId":"string","currency":"string","facilityId":"string","offerDate":"2024-01-01","drawdownDate":"2024-01-01","activity":"string","pricingSelection":"string","pricingPlan":"string","rewardsArrangementId":"string","extensions":{},"principalint":[{}],"penaltyint":[{}],"penalinterest":[{}],"schedule":[{}]}},"responses":{"200":"createLoanDrawdownOfferRenegotiationSchedulesResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}}]},{"key":"holdings-loans-arrangements-v5.2.0","title":"Loan creation","version":"v5.2.0","description":"API to create and manage various types of loans such as Personal, Commercial, Mortgage, Line of Credit, etc","endpointCount":41,"endpoints":[{"method":"POST","path":"/holdings/loans/personalLoans","fullPath":"/api/v5.2.0/holdings/loans/personalLoans","operationId":"createPersonalLoan","name":"Create a personal loan account","summary":"Create a personal loan account","tags":[],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"partyIds":[{}],"partyRoles":[{}],"agentCustomerIds":[{}],"agentArrangementIds":[{}],"agentRoles":[{}],"arrangmentId":"string","productId":"string","activityId":"string","currency":"string","productVariation":"string","pricingSelection":"string","pricingPlan":"string","rewardsArrangementId":"string","tradeDate":"string","arrangementEffectiveDate":"string"}},"responses":{"200":"createPersonalLoanResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"POST","path":"/holdings/loans/linkedRateLoans","fullPath":"/api/v5.2.0/holdings/loans/linkedRateLoans","operationId":"createLinkedRateLoan","name":"Create a personal loan account with linked rate","summary":"Create a personal loan account with linked rate","tags":[],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"partyIds":[{}],"partyRoles":[{}],"agentCustomerIds":[{}],"agentArrangementIds":[{}],"agentRoles":[{}],"arrangmentId":"string","productId":"string","activityId":"string","currency":"string","productVariation":"string","pricingSelection":"string","pricingPlan":"string","rewardsArrangementId":"string","tradeDate":"string","arrangementEffectiveDate":"string"}},"responses":{"200":"createLinkedRateLoanResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"POST","path":"/holdings/loans/commercialLoans","fullPath":"/api/v5.2.0/holdings/loans/commercialLoans","operationId":"createCommercialLoan","name":"Create a commercial or business account","summary":"Create a commercial or business account","tags":[],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"partyIds":[{}],"partyRoles":[{}],"agentCustomerIds":[{}],"agentArrangementIds":[{}],"agentRoles":[{}],"arrangmentId":"string","productId":"string","activityId":"string","currency":"string","productVariation":"string","pricingSelection":"string","pricingPlan":"string","rewardsArrangementId":"string","tradeDate":"string","arrangementEffectiveDate":"string"}},"responses":{"200":"createCommercialLoanResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"POST","path":"/holdings/loans/mortgages","fullPath":"/api/v5.2.0/holdings/loans/mortgages","operationId":"createMortgage","name":"Create a mortgage loan","summary":"Create a mortgage loan","tags":[],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"partyIds":[{}],"partyRoles":[{}],"agentCustomerIds":[{}],"agentArrangementIds":[{}],"agentRoles":[{}],"arrangmentId":"string","productId":"string","activityId":"string","currency":"string","productVariation":"string","pricingSelection":"string","pricingPlan":"string","rewardsArrangementId":"string","tradeDate":"string","arrangementEffectiveDate":"string"}},"responses":{"200":"createMortgageResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"POST","path":"/holdings/loans/creditLines","fullPath":"/api/v5.2.0/holdings/loans/creditLines","operationId":"createCreditLine","name":"Create a lines of credit account","summary":"Create a lines of credit account","tags":[],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"partyIds":[{}],"partyRoles":[{}],"agentCustomerIds":[{}],"agentArrangementIds":[{}],"agentRoles":[{}],"arrangmentId":"string","productId":"string","activityId":"string","currency":"string","productVariation":"string","pricingSelection":"string","pricingPlan":"string","rewardsArrangementId":"string","tradeDate":"string","arrangementEffectiveDate":"string"}},"responses":{"200":"createCreditLineResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"POST","path":"/holdings/facilities/installmentLoans","fullPath":"/api/v5.2.0/holdings/facilities/installmentLoans","operationId":"createInstallmentLoan","name":"Create an installment loan for the given product","summary":"Create an installment loan for the given product","tags":[],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"customers":[{}],"arrangmentId":"string","currency":"string","facilityId":"string","effectiveDate":"string","activity":"string","productId":"string","extensions":{},"account":[{}],"schedule":[{}],"settlement":[{}],"commitment":[{}]}},"responses":{"200":"createInstallmentLoanResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"POST","path":"/holdings/fundsTransfer","fullPath":"/api/v5.2.0/holdings/fundsTransfer","operationId":"createFundsTransfer","name":"Create an account transfer","summary":"Create an account transfer","tags":[],"parameters":[{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"transactionType":"string","debitAccountId":"string","debitCurrency":"string","debitAmount":0.0,"debitValueDate":"2024-01-01","creditAccountId":"string","creditCurrencyId":"string","creditAmount":0.0,"creditValueDate":"2024-01-01","commissionCode":"string","commissionType":"string","commissionAmount":0.0,"paymentDetails":"string","extensions":{}}},"responses":{"200":"FundsTransferResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"POST","path":"/holdings/loans/consumerLoans","fullPath":"/api/v5.2.0/holdings/loans/consumerLoans","operationId":"createConsumerLoan","name":"creates a consumer loan for the given product","summary":"Initiates the creation of consumer loan for the given product","tags":["RETAIL"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"partyIds":[{}],"productId":"string","activityId":"string","currency":"string","arrangementEffectiveDate":"string","externalEventStatus":"string","extensions":{}}},"responses":{"200":"createConsumerLoanResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"PUT","path":"/holdings/loans/consumerLoans/{consumerLoanId}/disbursements","fullPath":"/api/v5.2.0/holdings/loans/consumerLoans/{consumerLoanId}/disbursements","operationId":"createConsumerLoanDisbursement","name":"Initiates the disbursement of the given consumer loan contracts commitment amount","summary":"Disburses the consumer loan commitment amount","tags":["RETAIL"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"consumerLoanId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"currencyId":"string","effectiveDate":"2024-01-01","activityId":"string","transactionAmount":0.0,"contractId":"string","systemId":"string","externalEventStatus":"string","extensions":{}}},"responses":{"200":"createConsumerLoanDisbursementResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"PUT","path":"/holdings/loans/consumerLoans/{consumerLoanId}/commitmentIncreases","fullPath":"/api/v5.2.0/holdings/loans/consumerLoans/{consumerLoanId}/commitmentIncreases","operationId":"updateConsumerLoanTopupAmount","name":"Increases the commitment amount of the consumer loan","summary":"Increases the commitment amount of the given consumer loan contract","tags":["RETAIL"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"consumerLoanId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"effectiveDate":"2024-01-01","activityId":"string","externalEventStatus":"string","extensions":{}}},"responses":{"200":"updateConsumerLoanTopupAmountResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"PUT","path":"/holdings/loans/consumerLoans/{consumerLoanId}/commitmentDecreases","fullPath":"/api/v5.2.0/holdings/loans/consumerLoans/{consumerLoanId}/commitmentDecreases","operationId":"updateConsumerLoanDecreaseAmount","name":"Decreases the commitment amount of the consumer loan","summary":"Decreases the commitment amount of the given consumer loan contract","tags":["RETAIL"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"consumerLoanId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"effectiveDate":"2024-01-01","activityId":"string","externalEventStatus":"string","extensions":{}}},"responses":{"200":"updateConsumerLoanDecreaseAmountResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"PUT","path":"/holdings/loans/consumerLoans/{consumerLoanId}/repayments","fullPath":"/api/v5.2.0/holdings/loans/consumerLoans/{consumerLoanId}/repayments","operationId":"createConsumerLoanRepayment","name":"Initiates the repayment of the given consumer loan amount","summary":"Repays the consumer loan amount","tags":["RETAIL"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"consumerLoanId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"currencyId":"string","effectiveDate":"2024-01-01","activityId":"string","transactionAmount":0.0,"contractId":"string","systemId":"string","externalEventStatus":"string","extensions":{}}},"responses":{"200":"createConsumerLoanRepaymentResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"PUT","path":"/holdings/loans/consumerLoans/{consumerLoanId}/principalDecreases","fullPath":"/api/v5.2.0/holdings/loans/consumerLoans/{consumerLoanId}/principalDecreases","operationId":"createConsumerLoanPrepayment","name":"Initiates the advance repayment of the given consumer loan amount","summary":"Prepays the consumer loan amount","tags":["RETAIL"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"consumerLoanId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"currencyId":"string","effectiveDate":"2024-01-01","activityId":"string","transactionAmount":0.0,"contractId":"string","systemId":"string","externalEventStatus":"string","extensions":{}}},"responses":{"200":"createConsumerLoanPrepaymentResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"PUT","path":"/holdings/loans/consumerLoans/{consumerLoanId}/schedules","fullPath":"/api/v5.2.0/holdings/loans/consumerLoans/{consumerLoanId}/schedules","operationId":"updateConsumerLoanSchedule","name":"Initiates the change of payment schedule for the given consumer loan contract","summary":"Change payment schedule of the consumer loan","tags":["RETAIL"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"consumerLoanId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"effectiveDate":"2024-01-01","activityId":"string","externalEventStatus":"string","extensions":{}}},"responses":{"200":"updateConsumerLoanScheduleResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"PUT","path":"/holdings/loans/consumerLoans/{consumerLoanId}/paymentHolidays","fullPath":"/api/v5.2.0/holdings/loans/consumerLoans/{consumerLoanId}/paymentHolidays","operationId":"updateConsumerLoanHoliday","name":"Initiates the update of payment holiday for the given consumer loan contract","summary":"Update payment holiday for the consumer loan","tags":["RETAIL"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"consumerLoanId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"effectiveDate":"2024-01-01","activityId":"string","externalEventStatus":"string","extensions":{}}},"responses":{"200":"updateConsumerLoanHolidayResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"GET","path":"/holdings/loans/{loanId}/outstandingBills","fullPath":"/api/v5.2.0/holdings/loans/{loanId}/outstandingBills","operationId":"getLoanOutstandingBills","name":"Retrieves the outstanding amount to be paid for a loan","summary":"Retrieves the outstanding amount to be paid for the given loan","tags":["RETAIL"],"parameters":[{"name":"loanId","in":"path","type":"string","required":true,"description":"Denotes the arrangement id of the loan"},{"name":"fileVersion","in":"query","type":"string","required":false,"description":"Indicates if the file is of type simulation or live"},{"name":"simulationReference","in":"query","type":"string","required":false,"description":"Indicates the reference id for simulation activity"},{"name":"paymentDate","in":"query","type":"string","required":false,"description":"Contains the date in which the payment will be sent out. Date in the format YYYYMMDD. E.g. 20191231"},{"name":"deferDate","in":"query","type":"string","required":false,"description":"Date that the payment has been deferred to"},{"name":"billedAmount","in":"query","type":"string","required":false,"description":"Indicates the bill amount"},{"name":"outstandingAmount","in":"query","type":"string","required":false,"description":"Contains the aggregate outstanding principal amount thereof after giving effect to any borrowings and prepayments or repayments of Committed Loans"},{"name":"delinquentAmount","in":"query","type":"string","required":false,"description":"Indicates the bill amount during the ageing status(Bill which crossed the due date)"},{"name":"property","in":"query","type":"string","required":false,"description":"Id of the product property"},{"name":"billStatus","in":"query","type":"string","required":false,"description":"Indicates the status of a bill(Issued,Due,Ageing,Settled)"},{"name":"settlementStatus","in":"query","type":"string","required":false,"description":"Defines the status of the settlement for the incoming MT548 swift message.The values allowed are: Waiting : pending to receive settlement status update meaning pending to receive MT548 swift message, "},{"name":"agingStatus","in":"query","type":"string","required":false,"description":"Indicates the ageing status of a bill"},{"name":"settled","in":"query","type":"string","required":false,"description":"Flag to indicate whether a bill is settled or not"},{"name":"paymentType","in":"query","type":"string","required":false,"description":"Indicates if the payment is Customer (C) type or Bank (B) type"},{"name":"billDate","in":"query","type":"string","required":false,"description":"Indicates a date on which a bill has been raised"},{"name":"paymentMethod","in":"query","type":"string","required":false,"description":"Method chosen to make the payment"},{"name":"infoPayType","in":"query","type":"string","required":false,"description":"Indicates a bill which is raised when a loan is paid off"},{"name":"advancePayment","in":"query","type":"string","required":false,"description":"Indicates whether advance payment made is set on an account"},{"name":"paymentIndicator","in":"query","type":"string","required":false,"description":"Indicates whether its a credit/debit type of bill"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"LoanOutstandingBillsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/loans/{loanId}/payoffCalculations","fullPath":"/api/v5.2.0/holdings/loans/{loanId}/payoffCalculations","operationId":"getLoanPayoffDetails","name":"Retrieves the payoff details of a loan","summary":"Retrieves the payoff details of the given loan","tags":["RETAIL"],"parameters":[{"name":"loanId","in":"path","type":"string","required":true,"description":"Denotes the arrangement id of the loan"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"LoanPayoffDetailsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"PUT","path":"/holdings/loans/consumerLoans/{consumerLoanId}/customers","fullPath":"/api/v5.2.0/holdings/loans/consumerLoans/{consumerLoanId}/customers","operationId":"updateConsumerLoansCustomer","name":"Initiates the change of customers for the given consumer loan contract","summary":"Changes the customers of the consumer loan ","tags":["RETAIL"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"consumerLoanId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"partyIds":[{}],"effectiveDate":"2024-01-01","activityId":"string","externalEventStatus":"string","extensions":{}}},"responses":{"200":"updateConsumerLoansCustomerResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"PUT","path":"/holdings/loans/consumerLoans/{consumerLoanId}/payoffs","fullPath":"/api/v5.2.0/holdings/loans/consumerLoans/{consumerLoanId}/payoffs","operationId":"createPayoffConsumerLoan","name":"Initiates the payoff of the given consumer loan contract amount","summary":"Payoffs the consumer loan amount","tags":["RETAIL"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"consumerLoanId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"currencyId":"string","effectiveDate":"2024-01-01","activityId":"string","transactionAmount":0.0,"contractId":"string","systemId":"string","externalEventStatus":"string","extensions":{}}},"responses":{"200":"createPayoffConsumerLoanResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"PUT","path":"/holdings/loans/consumerLoans/{consumerLoanId}/renegotiations","fullPath":"/api/v5.2.0/holdings/loans/consumerLoans/{consumerLoanId}/renegotiations","operationId":"updateConsumerLoanConditions","name":"Initiates the renegotiation of the given consumer loan contract details","summary":"Renegotiates the consumer loan contract details","tags":["RETAIL"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"consumerLoanId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"effectiveDate":"2024-01-01","activityId":"string","externalEventStatus":"string","extensions":{}}},"responses":{"200":"updateConsumerLoanConditionsResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"GET","path":"/holdings/loans/{loanId}/status","fullPath":"/api/v5.2.0/holdings/loans/{loanId}/status","operationId":"getArrangementDetails","name":"Retrieves the status of a loan","summary":"Retrieves the status of the given loan","tags":["RETAIL"],"parameters":[{"name":"loanId","in":"path","type":"string","required":true,"description":"Denotes the arrangement id of the loan"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"ArrangementDetailsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/loans/arrangements/activities/{arrangementActivityId}/status","fullPath":"/api/v5.2.0/holdings/loans/arrangements/activities/{arrangementActivityId}/status","operationId":"getExternalEventStatus","name":"Retrieves the status of the given activity ","summary":"Retrieves the status of the given activity ","tags":["RETAIL"],"parameters":[{"name":"arrangementActivityId","in":"path","type":"string","required":true,"description":"Contains the arrangement activity reference identifier"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"ExternalEventStatusResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"PUT","path":"/holdings/loans/consumerLoans/{consumerLoanId}/payoffCalculations","fullPath":"/api/v5.2.0/holdings/loans/consumerLoans/{consumerLoanId}/payoffCalculations","operationId":"calculatePayoffConsumerLoans","name":"Initiates calculate payoff activity to calculate consumer loan payment amount to close the given loan","summary":"Calculates consumer loan payment amount to close a loan","tags":["RETAIL"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"consumerLoanId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"parties":[{}],"activityId":"string","effectiveDate":"string","productId":"string","currencyId":"string","simulationId":"string","extensions":{}}},"responses":{"200":"calculatePayoffConsumerLoansResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"GET","path":"/holdings/loans/{loanId}/schedules","fullPath":"/api/v5.2.0/holdings/loans/{loanId}/schedules","operationId":"getPaymentSchedulesProjection","name":"Retrieves the schedule payment information for paid and upcoming installments details","summary":"Retrieves payment schedules details","tags":["RETAIL"],"parameters":[{"name":"loanId","in":"path","type":"string","required":true,"description":"Denotes the arrangement id of the loan"},{"name":"dateFrom","in":"query","type":"string","required":false,"description":"Start date of the loan"},{"name":"dateTo","in":"query","type":"string","required":false,"description":"End date of the loan"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"PaymentSchedulesProjectionResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/loans/{loanId}/loanDetails","fullPath":"/api/v5.2.0/holdings/loans/{loanId}/loanDetails","operationId":"getLoanOverview","name":"Retrieves the details of the given loan","summary":"Retrieves loan details ","tags":["RETAIL"],"parameters":[{"name":"loanId","in":"path","type":"string","required":true,"description":"Denotes the arrangement id of the loan"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"LoanOverviewResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/loans/{loanId}/bills","fullPath":"/api/v5.2.0/holdings/loans/{loanId}/bills","operationId":"getLoanBills","name":"Retrieves the simulation details of the contract based on the selection criteria. It returns the bill details of the loan","summary":"Retrieves loan bills details","tags":[],"parameters":[{"name":"loanId","in":"path","type":"string","required":true,"description":"Denotes the arrangement id of the loan"},{"name":"billType","in":"query","type":"string","required":false,"description":"The type of payment obligation generated"},{"name":"paymentDate","in":"query","type":"string","required":false,"description":"Contains the date in which the payment will be sent out. Date in the format YYYYMMDD. E.g. 20191231"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"LoanBillsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/loans/{loanId}/collaterals","fullPath":"/api/v5.2.0/holdings/loans/{loanId}/collaterals","operationId":"getLoanCollaterals","name":"Retrieves the collateral details linked to the loan arrangement. The collateral right and status have to be passed within the api","summary":"Retrieves loan collateral details","tags":[],"parameters":[{"name":"loanId","in":"path","type":"string","required":true,"description":"Denotes the arrangement id of the loan"},{"name":"status","in":"query","type":"string","required":false,"description":"Contains status of the data rights request.Allowed values are INITIATED, INPROGESS, EXTENDED, COMPLETED, REJECTED."},{"name":"statusNE","in":"query","type":"string","required":false,"description":"Status not equal to"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"LoanCollateralsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/loans/{loanId}","fullPath":"/api/v5.2.0/holdings/loans/{loanId}","operationId":"getLoanDetails","name":"Retrieves loan details","summary":"Retrieves the loan account details","tags":[],"parameters":[{"name":"loanId","in":"path","type":"string","required":true,"description":"Denotes the arrangement id of the loan"},{"name":"dateFrom","in":"query","type":"string","required":false,"description":"Start date of the loan"},{"name":"dateTo","in":"query","type":"string","required":false,"description":"End date of the loan"},{"name":"balanceTypes","in":"query","type":"string","required":false,"description":"Type of balance (e.g. current balance, credit interest accrued, deferred commission, etc.) as defined in the institution's accounting schemas."},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"LoanDetailsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/loans/{loanId}/schedulePaymentFrequencies","fullPath":"/api/v5.2.0/holdings/loans/{loanId}/schedulePaymentFrequencies","operationId":"getPaymentSchedules","name":"Retrieves the schedule payment information for paid and upcoming installments details","summary":"Retrieves payment schedules details","tags":[],"parameters":[{"name":"loanId","in":"path","type":"string","required":true,"description":"Denotes the arrangement id of the loan"},{"name":"dateFrom","in":"query","type":"string","required":false,"description":"Start date of the loan"},{"name":"dateTo","in":"query","type":"string","required":false,"description":"End date of the loan"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"PaymentSchedulesResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"POST","path":"/holdings/simulationCapture/{arrangementId}","fullPath":"/api/v5.2.0/holdings/simulationCapture/{arrangementId}","operationId":"createSimulationCapture","name":"Simulate payoff calculate activity for a loan arrangement","summary":"Simulate payoff calculate activity for a loan arrangement","tags":[],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"arrangementId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"customerIds":[{}],"properties":[{}],"overrides":[{}],"activityId":"string","effectiveDate":"2024-01-01","tradeDate":"string","alternateId":"string","roleName":"string","arrangementLinkId":"string","masterArrangementId":"string","productId":"string","currencyId":"string","channel":"string","effective":"string","transactionAmount":0.0}},"responses":{"200":"createSimulationCaptureResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"POST","path":"/holdings/loans/simulations","fullPath":"/api/v5.2.0/holdings/loans/simulations","operationId":"createLoanSimulation","name":"Create a simulation for loan product with details like customer identifier, currency, etc.","summary":"Create simulation for loan products","tags":["RETAIL"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"customerIds":[{}],"properties":[{}],"overrides":[{}],"productId":"string","masterArrangementId":"string","roleName":"string","currencyId":"string","effectiveDate":"2024-01-01","activityId":"string","transactionAmount":0.0,"reason":"string","automaticRun":"string","simulationRunReference":"string","synchronous":"string","latestProductCondition":"string"}},"responses":{"200":"createLoanSimulationResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"PUT","path":"/holdings/loans/simulations/{simulationId}","fullPath":"/api/v5.2.0/holdings/loans/simulations/{simulationId}","operationId":"updateLoanSimulation","name":"Update a simulation for loan product with details like customer identifier, currency, etc.","summary":"Update a simulation for loan products","tags":["RETAIL"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"simulationId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"customerIds":[{}],"properties":[{}],"overrides":[{}],"productId":"string","masterArrangementId":"string","roleName":"string","currencyId":"string","effectiveDate":"2024-01-01","activityId":"string","transactionAmount":0.0,"reason":"string","automaticRun":"string","simulationRunReference":"string","synchronous":"string","latestProductCondition":"string"}},"responses":{"200":"updateLoanSimulationResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"POST","path":"/holdings/loans/{loanId}/simulations/payoffs","fullPath":"/api/v5.2.0/holdings/loans/{loanId}/simulations/payoffs","operationId":"createLoanPayoffSimulation","name":"Create a simulation payoff activity for loan product with product id details","summary":"Create simulation payoff activity for loan products","tags":["RETAIL"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"loanId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"customerIds":[{}],"properties":[{}],"overrides":[{}],"productId":"string","masterArrangementId":"string","roleName":"string","currencyId":"string","effectiveDate":"2024-01-01","activityId":"string","transactionAmount":0.0,"reason":"string","automaticRun":"string","simulationRunReference":"string","synchronous":"string","extensions":{}}},"responses":{"200":"createLoanPayoffSimulationResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"POST","path":"/holdings/loans/{loanId}/payoffs","fullPath":"/api/v5.2.0/holdings/loans/{loanId}/payoffs","operationId":"createLoanArrangementPayoff","name":"Execute payoff activity for loan product with details like simulation run reference, product id , etc.","summary":"Execute payoff activity for loan products","tags":["RETAIL"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"loanId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"customerIds":[{}],"properties":[{}],"overrides":[{}],"productId":"string","masterArrangementId":"string","roleName":"string","currencyId":"string","effectiveDate":"2024-01-01","activityId":"string","transactionAmount":0.0,"reason":"string","simulationRunReference":"string","extensions":{},"payoff":[{}]}},"responses":{"200":"createLoanArrangementPayoffResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"GET","path":"/holdings/loans/{loanId}/overpayments","fullPath":"/api/v5.2.0/holdings/loans/{loanId}/overpayments","operationId":"getOverpaymentDetails","name":"Retrieves the product id, type of overpay, overpay limit, overpay period, utilised overpay and remaining overpay limit of a loan arrangement","summary":"Retrieves overpayment details that has happened for a loan arrangement","tags":["RETAIL"],"parameters":[{"name":"loanId","in":"path","type":"string","required":true,"description":"Denotes the arrangement id of the loan"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"OverpaymentDetailsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"POST","path":"/holdings/loans/drawdowns/offers","fullPath":"/api/v5.2.0/holdings/loans/drawdowns/offers","operationId":"createLoanDrawdownOffer","name":"Creates a new drawdown offer for the required customer.","summary":"Creates a new drawdown offer for the required customer.","tags":[],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"customers":[{}],"productId":"string","currency":"string","facilityId":"string","offerDate":"2024-01-01","drawdownDate":"2024-01-01","activity":"string","pricingSelection":"string","pricingPlan":"string","rewardsArrangementId":"string","extensions":{},"principalint":[{}],"penaltyint":[{}],"penalinterest":[{}],"schedule":[{}]}},"responses":{"200":"createLoanDrawdownOfferResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"POST","path":"/holdings/loans/{loanId}/drawdowns/acceptances","fullPath":"/api/v5.2.0/holdings/loans/{loanId}/drawdowns/acceptances","operationId":"createLoanDrawdownOfferAcceptance","name":"Accept the offer drawdown for the retail loan and convert offer drawdown into a live loan arrangement.","summary":"Accept the offer drawdown for the retail loan and convert offer drawdown into a live loan arrangement.","tags":[],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"loanId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"customers":[{}],"productId":"string","currency":"string","facilityId":"string","offerDate":"2024-01-01","drawdownDate":"2024-01-01","activity":"string","pricingSelection":"string","pricingPlan":"string","rewardsArrangementId":"string","extensions":{},"principalint":[{}],"penaltyint":[{}],"penalinterest":[{}],"schedule":[{}]}},"responses":{"200":"createLoanDrawdownOfferAcceptanceResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"POST","path":"/holdings/loans/{loanId}/drawdowns/renegotiations","fullPath":"/api/v5.2.0/holdings/loans/{loanId}/drawdowns/renegotiations","operationId":"createLoanDrawdownOfferRenegotiation","name":"Renegotiate the offer drawdown for the retail loan and convert offer drawdown into live loan arrangement.","summary":"Renegotiate the offer drawdown for the required customer.","tags":[],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"loanId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"customers":[{}],"productId":"string","currency":"string","facilityId":"string","offerDate":"2024-01-01","drawdownDate":"2024-01-01","activity":"string","pricingSelection":"string","pricingPlan":"string","rewardsArrangementId":"string","extensions":{},"principalint":[{}],"penaltyint":[{}],"penalinterest":[{}],"schedule":[{}]}},"responses":{"200":"createLoanDrawdownOfferRenegotiationResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"POST","path":"/holdings/loans/{loanId}/drawdowns/cancellations","fullPath":"/api/v5.2.0/holdings/loans/{loanId}/drawdowns/cancellations","operationId":"cancelLoanDrawdownOffer","name":"Cancellation of offer drawdown for the required customer.","summary":"Cancellation of offer drawdown for the required customer.","tags":[],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"loanId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"customers":[{}],"productId":"string","currency":"string","facilityId":"string","offerDate":"2024-01-01","drawdownDate":"2024-01-01","activity":"string","extensions":{}}},"responses":{"200":"cancelLoanDrawdownOfferResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"POST","path":"/holdings/loans/{loanId}/drawdowns/acceptances/schedules","fullPath":"/api/v5.2.0/holdings/loans/{loanId}/drawdowns/acceptances/schedules","operationId":"createLoanDrawdownOfferAcceptanceSchedules","name":"Accept the offer drawdown for the retail loan and convert offer drawdown into a live loan arrangement and retrieve the payment schedule details.","summary":"Accept the offer drawdown for the retail loan and convert offer drawdown into a live loan arrangement and retrieve the payment schedule details.","tags":[],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"loanId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"customers":[{}],"productId":"string","currency":"string","facilityId":"string","offerDate":"2024-01-01","drawdownDate":"2024-01-01","activity":"string","pricingSelection":"string","pricingPlan":"string","rewardsArrangementId":"string","extensions":{},"principalint":[{}],"penaltyint":[{}],"penalinterest":[{}],"schedule":[{}]}},"responses":{"200":"createLoanDrawdownOfferAcceptanceSchedulesResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"POST","path":"/holdings/loans/{loanId}/drawdowns/renegotiations/schedules","fullPath":"/api/v5.2.0/holdings/loans/{loanId}/drawdowns/renegotiations/schedules","operationId":"createLoanDrawdownOfferRenegotiationSchedules","name":"Renegotiate the offer drawdown for the retail loan and convert offer drawdown into live loan arrangement and retrieve the payment schedule details.","summary":"Renegotiate the offer drawdown for the required customer and retrieve the payment schedule details.","tags":[],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"loanId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"customers":[{}],"productId":"string","currency":"string","facilityId":"string","offerDate":"2024-01-01","drawdownDate":"2024-01-01","activity":"string","pricingSelection":"string","pricingPlan":"string","rewardsArrangementId":"string","extensions":{},"principalint":[{}],"penaltyint":[{}],"penalinterest":[{}],"schedule":[{}]}},"responses":{"200":"createLoanDrawdownOfferRenegotiationSchedulesResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}}]},{"key":"holdings-loans-arrangements-v5.3.0","title":"Loan creation","version":"v5.3.0","description":"API to create and Manage various types of loans such as Personal, Commercial, Mortgage, Line of Credit, etc","endpointCount":42,"endpoints":[{"method":"POST","path":"/holdings/loans/personalLoans","fullPath":"/api/v5.3.0/holdings/loans/personalLoans","operationId":"createPersonalLoan","name":"Create a personal loan account","summary":"Create a personal loan account","tags":[],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"partyIds":[{}],"partyRoles":[{}],"agentCustomerIds":[{}],"agentArrangementIds":[{}],"agentRoles":[{}],"arrangmentId":"string","productId":"string","activityId":"string","currency":"string","productVariation":"string","pricingSelection":"string","pricingPlan":"string","rewardsArrangementId":"string","tradeDate":"string","arrangementEffectiveDate":"string"}},"responses":{"200":"createPersonalLoanResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"POST","path":"/holdings/loans/linkedRateLoans","fullPath":"/api/v5.3.0/holdings/loans/linkedRateLoans","operationId":"createLinkedRateLoan","name":"Create a personal loan account with linked rate","summary":"Create a personal loan account with linked rate","tags":[],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"partyIds":[{}],"partyRoles":[{}],"agentCustomerIds":[{}],"agentArrangementIds":[{}],"agentRoles":[{}],"arrangmentId":"string","productId":"string","activityId":"string","currency":"string","productVariation":"string","pricingSelection":"string","pricingPlan":"string","rewardsArrangementId":"string","tradeDate":"string","arrangementEffectiveDate":"string"}},"responses":{"200":"createLinkedRateLoanResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"POST","path":"/holdings/loans/commercialLoans","fullPath":"/api/v5.3.0/holdings/loans/commercialLoans","operationId":"createCommercialLoan","name":"Create a commercial or business account","summary":"Create a commercial or business account","tags":[],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"partyIds":[{}],"partyRoles":[{}],"agentCustomerIds":[{}],"agentArrangementIds":[{}],"agentRoles":[{}],"arrangmentId":"string","productId":"string","activityId":"string","currency":"string","productVariation":"string","pricingSelection":"string","pricingPlan":"string","rewardsArrangementId":"string","tradeDate":"string","arrangementEffectiveDate":"string"}},"responses":{"200":"createCommercialLoanResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"POST","path":"/holdings/loans/mortgages","fullPath":"/api/v5.3.0/holdings/loans/mortgages","operationId":"createMortgage","name":"Create a mortgage loan","summary":"Create a mortgage loan","tags":[],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"partyIds":[{}],"partyRoles":[{}],"agentCustomerIds":[{}],"agentArrangementIds":[{}],"agentRoles":[{}],"arrangmentId":"string","productId":"string","activityId":"string","currency":"string","productVariation":"string","pricingSelection":"string","pricingPlan":"string","rewardsArrangementId":"string","tradeDate":"string","arrangementEffectiveDate":"string"}},"responses":{"200":"createMortgageResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"POST","path":"/holdings/loans/creditLines","fullPath":"/api/v5.3.0/holdings/loans/creditLines","operationId":"createCreditLine","name":"Create a lines of credit account","summary":"Create a lines of credit account","tags":[],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"partyIds":[{}],"partyRoles":[{}],"agentCustomerIds":[{}],"agentArrangementIds":[{}],"agentRoles":[{}],"arrangmentId":"string","productId":"string","activityId":"string","currency":"string","productVariation":"string","pricingSelection":"string","pricingPlan":"string","rewardsArrangementId":"string","tradeDate":"string","arrangementEffectiveDate":"string"}},"responses":{"200":"createCreditLineResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"POST","path":"/holdings/facilities/installmentLoans","fullPath":"/api/v5.3.0/holdings/facilities/installmentLoans","operationId":"createInstallmentLoan","name":"Create an installment loan for the given product","summary":"Create an installment loan for the given product","tags":[],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"customers":[{}],"arrangmentId":"string","currency":"string","facilityId":"string","effectiveDate":"string","activity":"string","productId":"string","extensions":{},"account":[{}],"schedule":[{}],"settlement":[{}],"commitment":[{}]}},"responses":{"200":"createInstallmentLoanResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"POST","path":"/holdings/fundsTransfer","fullPath":"/api/v5.3.0/holdings/fundsTransfer","operationId":"createFundsTransfer","name":"Create an account transfer","summary":"Create an account transfer","tags":[],"parameters":[{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"transactionType":"string","debitAccountId":"string","debitCurrency":"string","debitAmount":0.0,"debitValueDate":"2024-01-01","creditAccountId":"string","creditCurrencyId":"string","creditAmount":0.0,"creditValueDate":"2024-01-01","commissionCode":"string","commissionType":"string","commissionAmount":0.0,"paymentDetails":"string","extensions":{}}},"responses":{"200":"FundsTransferResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"POST","path":"/holdings/loans/consumerLoans","fullPath":"/api/v5.3.0/holdings/loans/consumerLoans","operationId":"createConsumerLoan","name":"creates a consumer loan for the given product","summary":"Initiates the creation of consumer loan for the given product","tags":["RETAIL"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"partyIds":[{}],"productId":"string","activityId":"string","currency":"string","arrangementEffectiveDate":"string","externalEventStatus":"string","extensions":{}}},"responses":{"200":"createConsumerLoanResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"PUT","path":"/holdings/loans/consumerLoans/{consumerLoanId}/disbursements","fullPath":"/api/v5.3.0/holdings/loans/consumerLoans/{consumerLoanId}/disbursements","operationId":"createConsumerLoanDisbursement","name":"Initiates the disbursement of the given consumer loan contracts commitment amount","summary":"Disburses the consumer loan commitment amount","tags":["RETAIL"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"consumerLoanId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"currencyId":"string","effectiveDate":"2024-01-01","activityId":"string","transactionAmount":0.0,"contractId":"string","systemId":"string","externalEventStatus":"string","extensions":{}}},"responses":{"200":"createConsumerLoanDisbursementResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"PUT","path":"/holdings/loans/consumerLoans/{consumerLoanId}/commitmentIncreases","fullPath":"/api/v5.3.0/holdings/loans/consumerLoans/{consumerLoanId}/commitmentIncreases","operationId":"updateConsumerLoanTopupAmount","name":"Increases the commitment amount of the consumer loan","summary":"Increases the commitment amount of the given consumer loan contract","tags":["RETAIL"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"consumerLoanId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"effectiveDate":"2024-01-01","activityId":"string","externalEventStatus":"string","extensions":{}}},"responses":{"200":"updateConsumerLoanTopupAmountResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"PUT","path":"/holdings/loans/consumerLoans/{consumerLoanId}/commitmentDecreases","fullPath":"/api/v5.3.0/holdings/loans/consumerLoans/{consumerLoanId}/commitmentDecreases","operationId":"updateConsumerLoanDecreaseAmount","name":"Decreases the commitment amount of the consumer loan","summary":"Decreases the commitment amount of the given consumer loan contract","tags":["RETAIL"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"consumerLoanId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"effectiveDate":"2024-01-01","activityId":"string","externalEventStatus":"string","extensions":{}}},"responses":{"200":"updateConsumerLoanDecreaseAmountResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"PUT","path":"/holdings/loans/consumerLoans/{consumerLoanId}/repayments","fullPath":"/api/v5.3.0/holdings/loans/consumerLoans/{consumerLoanId}/repayments","operationId":"createConsumerLoanRepayment","name":"Initiates the repayment of the given consumer loan amount","summary":"Repays the consumer loan amount","tags":["RETAIL"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"consumerLoanId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"currencyId":"string","effectiveDate":"2024-01-01","activityId":"string","transactionAmount":0.0,"contractId":"string","systemId":"string","externalEventStatus":"string","extensions":{}}},"responses":{"200":"createConsumerLoanRepaymentResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"PUT","path":"/holdings/loans/consumerLoans/{consumerLoanId}/principalDecreases","fullPath":"/api/v5.3.0/holdings/loans/consumerLoans/{consumerLoanId}/principalDecreases","operationId":"createConsumerLoanPrepayment","name":"Initiates the advance repayment of the given consumer loan amount","summary":"Prepays the consumer loan amount","tags":["RETAIL"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"consumerLoanId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"currencyId":"string","effectiveDate":"2024-01-01","activityId":"string","transactionAmount":0.0,"contractId":"string","systemId":"string","externalEventStatus":"string","extensions":{}}},"responses":{"200":"createConsumerLoanPrepaymentResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"PUT","path":"/holdings/loans/consumerLoans/{consumerLoanId}/schedules","fullPath":"/api/v5.3.0/holdings/loans/consumerLoans/{consumerLoanId}/schedules","operationId":"updateConsumerLoanSchedule","name":"Initiates the change of payment schedule for the given consumer loan contract","summary":"Change payment schedule of the consumer loan","tags":["RETAIL"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"consumerLoanId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"effectiveDate":"2024-01-01","activityId":"string","externalEventStatus":"string","extensions":{}}},"responses":{"200":"updateConsumerLoanScheduleResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"PUT","path":"/holdings/loans/consumerLoans/{consumerLoanId}/paymentHolidays","fullPath":"/api/v5.3.0/holdings/loans/consumerLoans/{consumerLoanId}/paymentHolidays","operationId":"updateConsumerLoanHoliday","name":"Initiates the update of payment holiday for the given consumer loan contract","summary":"Update payment holiday for the consumer loan","tags":["RETAIL"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"consumerLoanId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"effectiveDate":"2024-01-01","activityId":"string","externalEventStatus":"string","extensions":{}}},"responses":{"200":"updateConsumerLoanHolidayResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"GET","path":"/holdings/loans/{loanId}/outstandingBills","fullPath":"/api/v5.3.0/holdings/loans/{loanId}/outstandingBills","operationId":"getLoanOutstandingBills","name":"Retrieves the outstanding amount to be paid for the loan","summary":"Retrieves the outstanding amount to be paid for the loan","tags":["RETAIL"],"parameters":[{"name":"loanId","in":"path","type":"string","required":true,"description":"Denotes the arrangement id of the loan"},{"name":"fileVersion","in":"query","type":"string","required":false,"description":"Indicates if the file is of type simulation or live"},{"name":"simulationReference","in":"query","type":"string","required":false,"description":"Indicates the reference id for simulation activity"},{"name":"paymentDate","in":"query","type":"string","required":false,"description":"Contains the date in which the payment will be sent out. Date in the format YYYYMMDD. E.g. 20191231"},{"name":"deferDate","in":"query","type":"string","required":false,"description":"Date that the payment has been deferred to"},{"name":"billedAmount","in":"query","type":"string","required":false,"description":"Indicates the bill amount"},{"name":"outstandingAmount","in":"query","type":"string","required":false,"description":"Contains the aggregate outstanding principal amount thereof after giving effect to any borrowings and prepayments or repayments of Committed Loans"},{"name":"delinquentAmount","in":"query","type":"string","required":false,"description":"Indicates the bill amount during the ageing status(Bill which crossed the due date)"},{"name":"property","in":"query","type":"string","required":false,"description":"Id of the product property"},{"name":"billStatus","in":"query","type":"string","required":false,"description":"Indicates the status of a bill(Issued,Due,Ageing,Settled)"},{"name":"settlementStatus","in":"query","type":"string","required":false,"description":"Defines the status of the settlement for the incoming MT548 swift message.The values allowed are: Waiting : pending to receive settlement status update meaning pending to receive MT548 swift message, "},{"name":"agingStatus","in":"query","type":"string","required":false,"description":"Indicates the ageing status of a bill"},{"name":"settled","in":"query","type":"string","required":false,"description":"Flag to indicate whether a bill is settled or not"},{"name":"paymentType","in":"query","type":"string","required":false,"description":"Indicates if the payment is Customer (C) type or Bank (B) type"},{"name":"billDate","in":"query","type":"string","required":false,"description":"Indicates a date on which a bill has been raised"},{"name":"paymentMethod","in":"query","type":"string","required":false,"description":"Method chosen to make the payment"},{"name":"infoPayType","in":"query","type":"string","required":false,"description":"Indicates a bill which is raised when a loan is paid off"},{"name":"advancePayment","in":"query","type":"string","required":false,"description":"Indicates whether advance payment made is set on an account"},{"name":"paymentIndicator","in":"query","type":"string","required":false,"description":"Indicates whether its a credit/debit type of bill"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"LoanOutstandingBillsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/loans/{loanId}/payoffCalculations","fullPath":"/api/v5.3.0/holdings/loans/{loanId}/payoffCalculations","operationId":"getLoanPayoffDetails","name":"Retrieves the payoff details for the loan","summary":"Retrieves the payoff details for the loan","tags":["RETAIL"],"parameters":[{"name":"loanId","in":"path","type":"string","required":true,"description":"Denotes the arrangement id of the loan"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"LoanPayoffDetailsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"PUT","path":"/holdings/loans/consumerLoans/{consumerLoanId}/customers","fullPath":"/api/v5.3.0/holdings/loans/consumerLoans/{consumerLoanId}/customers","operationId":"updateConsumerLoansCustomer","name":"Initiates the change of customers for the given consumer loan contract","summary":"Changes the customers of the consumer loan ","tags":["RETAIL"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"consumerLoanId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"partyIds":[{}],"effectiveDate":"2024-01-01","activityId":"string","externalEventStatus":"string","extensions":{}}},"responses":{"200":"updateConsumerLoansCustomerResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"PUT","path":"/holdings/loans/consumerLoans/{consumerLoanId}/payoffs","fullPath":"/api/v5.3.0/holdings/loans/consumerLoans/{consumerLoanId}/payoffs","operationId":"createPayoffConsumerLoan","name":"Initiates the payoff of the given consumer loan contract amount","summary":"Payoffs the consumer loan amount","tags":["RETAIL"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"consumerLoanId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"currencyId":"string","effectiveDate":"2024-01-01","activityId":"string","transactionAmount":0.0,"contractId":"string","systemId":"string","externalEventStatus":"string","extensions":{}}},"responses":{"200":"createPayoffConsumerLoanResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"PUT","path":"/holdings/loans/consumerLoans/{consumerLoanId}/renegotiations","fullPath":"/api/v5.3.0/holdings/loans/consumerLoans/{consumerLoanId}/renegotiations","operationId":"updateConsumerLoanConditions","name":"Initiates the renegotiation of the given consumer loan contract details","summary":"Renegotiates the consumer loan contract details","tags":["RETAIL"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"consumerLoanId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"effectiveDate":"2024-01-01","activityId":"string","externalEventStatus":"string","extensions":{}}},"responses":{"200":"updateConsumerLoanConditionsResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"GET","path":"/holdings/loans/{loanId}/status","fullPath":"/api/v5.3.0/holdings/loans/{loanId}/status","operationId":"getArrangementDetails","name":"Retrieves the status of a loan","summary":"Retrieves the status of the given loan","tags":["RETAIL"],"parameters":[{"name":"loanId","in":"path","type":"string","required":true,"description":"Denotes the arrangement id of the loan"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"ArrangementDetailsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/loans/arrangements/activities/{arrangementActivityId}/status","fullPath":"/api/v5.3.0/holdings/loans/arrangements/activities/{arrangementActivityId}/status","operationId":"getExternalEventStatus","name":"Retrieves the status of the given activity ","summary":"Retrieves the status of the given activity ","tags":["RETAIL"],"parameters":[{"name":"arrangementActivityId","in":"path","type":"string","required":true,"description":"Contains the arrangement activity reference identifier"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"ExternalEventStatusResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"PUT","path":"/holdings/loans/consumerLoans/{consumerLoanId}/payoffCalculations","fullPath":"/api/v5.3.0/holdings/loans/consumerLoans/{consumerLoanId}/payoffCalculations","operationId":"calculatePayoffConsumerLoans","name":"Initiates calculate payoff activity to calculate consumer loan payment amount to close the given loan","summary":"Calculates consumer loan payment amount to close a loan","tags":["RETAIL"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"consumerLoanId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"parties":[{}],"activityId":"string","effectiveDate":"string","productId":"string","currencyId":"string","simulationId":"string","extensions":{}}},"responses":{"200":"calculatePayoffConsumerLoansResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"GET","path":"/holdings/loans/{loanId}/schedules","fullPath":"/api/v5.3.0/holdings/loans/{loanId}/schedules","operationId":"getPaymentSchedulesProjection","name":"Retrieves the schedule payment information for paid and upcoming installments details","summary":"Retrieves payment schedules details","tags":["RETAIL"],"parameters":[{"name":"loanId","in":"path","type":"string","required":true,"description":"Denotes the arrangement id of the loan"},{"name":"dateFrom","in":"query","type":"string","required":false,"description":"Start date of the loan"},{"name":"dateTo","in":"query","type":"string","required":false,"description":"End date of the loan"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"PaymentSchedulesProjectionResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/loans/{loanId}/loanDetails","fullPath":"/api/v5.3.0/holdings/loans/{loanId}/loanDetails","operationId":"getLoanOverview","name":"Retrieves the details of the given loan","summary":"Retrieves loan details ","tags":["RETAIL"],"parameters":[{"name":"loanId","in":"path","type":"string","required":true,"description":"Denotes the arrangement id of the loan"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"LoanOverviewResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/loans/{loanId}/bills","fullPath":"/api/v5.3.0/holdings/loans/{loanId}/bills","operationId":"getLoanBills","name":"Retrieves the simulation details of the contract based on the selection criteria. It returns the bill details of the loan","summary":"Retrieves loan bills details","tags":[],"parameters":[{"name":"loanId","in":"path","type":"string","required":true,"description":"Denotes the arrangement id of the loan"},{"name":"billType","in":"query","type":"string","required":false,"description":"The type of payment obligation generated"},{"name":"paymentDate","in":"query","type":"string","required":false,"description":"Contains the date in which the payment will be sent out. Date in the format YYYYMMDD. E.g. 20191231"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"LoanBillsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/loans/{loanId}/collaterals","fullPath":"/api/v5.3.0/holdings/loans/{loanId}/collaterals","operationId":"getLoanCollaterals","name":"Retrieves the collateral details linked to the loan arrangement. The collateral right and status have to be passed within the api","summary":"Retrieves loan collateral details","tags":[],"parameters":[{"name":"loanId","in":"path","type":"string","required":true,"description":"Denotes the arrangement id of the loan"},{"name":"status","in":"query","type":"string","required":false,"description":"Contains status of the data rights request.Allowed values are INITIATED, INPROGESS, EXTENDED, COMPLETED, REJECTED."},{"name":"statusNE","in":"query","type":"string","required":false,"description":"Status not equal to"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"LoanCollateralsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/loans/{loanId}","fullPath":"/api/v5.3.0/holdings/loans/{loanId}","operationId":"getLoanDetails","name":"Retrieves loan details","summary":"Retrieves the loan account details","tags":[],"parameters":[{"name":"loanId","in":"path","type":"string","required":true,"description":"Denotes the arrangement id of the loan"},{"name":"dateFrom","in":"query","type":"string","required":false,"description":"Start date of the loan"},{"name":"dateTo","in":"query","type":"string","required":false,"description":"End date of the loan"},{"name":"balanceTypes","in":"query","type":"string","required":false,"description":"Type of balance (e.g. current balance, credit interest accrued, deferred commission, etc.) as defined in the institution's accounting schemas."},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"LoanDetailsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/loans/{loanId}/schedulePaymentFrequencies","fullPath":"/api/v5.3.0/holdings/loans/{loanId}/schedulePaymentFrequencies","operationId":"getPaymentSchedules","name":"Retrieves the schedule payment information for paid and upcoming installments details","summary":"Retrieves payment schedules details","tags":[],"parameters":[{"name":"loanId","in":"path","type":"string","required":true,"description":"Denotes the arrangement id of the loan"},{"name":"dateFrom","in":"query","type":"string","required":false,"description":"Start date of the loan"},{"name":"dateTo","in":"query","type":"string","required":false,"description":"End date of the loan"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"PaymentSchedulesResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"POST","path":"/holdings/simulationCapture/{arrangementId}","fullPath":"/api/v5.3.0/holdings/simulationCapture/{arrangementId}","operationId":"createSimulationCapture","name":"Simulate payoff calculate activity for a loan arrangement","summary":"Simulate payoff calculate activity for a loan arrangement","tags":[],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"arrangementId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"customerIds":[{}],"properties":[{}],"overrides":[{}],"activityId":"string","effectiveDate":"2024-01-01","tradeDate":"string","alternateId":"string","roleName":"string","arrangementLinkId":"string","masterArrangementId":"string","productId":"string","currencyId":"string","channel":"string","effective":"string","transactionAmount":0.0}},"responses":{"200":"createSimulationCaptureResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"POST","path":"/holdings/loans/simulations","fullPath":"/api/v5.3.0/holdings/loans/simulations","operationId":"createLoanSimulation","name":"Create a simulation for loan product with details like customer identifier, currency, etc.","summary":"Create simulation for loan products","tags":["RETAIL"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"customerIds":[{}],"properties":[{}],"overrides":[{}],"productId":"string","masterArrangementId":"string","roleName":"string","currencyId":"string","effectiveDate":"2024-01-01","activityId":"string","transactionAmount":0.0,"reason":"string","automaticRun":"string","simulationRunReference":"string","synchronous":"string","latestProductCondition":"string"}},"responses":{"200":"createLoanSimulationResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"PUT","path":"/holdings/loans/simulations/{simulationId}","fullPath":"/api/v5.3.0/holdings/loans/simulations/{simulationId}","operationId":"updateLoanSimulation","name":"Update a simulation for loan product with details like customer identifier, currency, etc.","summary":"Update a simulation for loan products","tags":["RETAIL"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"simulationId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"customerIds":[{}],"properties":[{}],"overrides":[{}],"productId":"string","masterArrangementId":"string","roleName":"string","currencyId":"string","effectiveDate":"2024-01-01","activityId":"string","transactionAmount":0.0,"reason":"string","automaticRun":"string","simulationRunReference":"string","synchronous":"string","latestProductCondition":"string"}},"responses":{"200":"updateLoanSimulationResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"POST","path":"/holdings/loans/{loanId}/simulations/payoffs","fullPath":"/api/v5.3.0/holdings/loans/{loanId}/simulations/payoffs","operationId":"createLoanPayoffSimulation","name":"Create a simulation payoff activity for loan product with product id details","summary":"Create simulation payoff activity for loan products","tags":["RETAIL"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"loanId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"customerIds":[{}],"properties":[{}],"overrides":[{}],"productId":"string","masterArrangementId":"string","roleName":"string","currencyId":"string","effectiveDate":"2024-01-01","activityId":"string","transactionAmount":0.0,"reason":"string","automaticRun":"string","simulationRunReference":"string","synchronous":"string","extensions":{}}},"responses":{"200":"createLoanPayoffSimulationResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"POST","path":"/holdings/loans/{loanId}/payoffs","fullPath":"/api/v5.3.0/holdings/loans/{loanId}/payoffs","operationId":"createLoanArrangementPayoff","name":"Execute payoff activity for loan product with details like simulation run reference, product id , etc.","summary":"Execute payoff activity for loan products","tags":["RETAIL"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"loanId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"customerIds":[{}],"properties":[{}],"overrides":[{}],"productId":"string","masterArrangementId":"string","roleName":"string","currencyId":"string","effectiveDate":"2024-01-01","activityId":"string","transactionAmount":0.0,"reason":"string","simulationRunReference":"string","extensions":{},"payoff":[{}]}},"responses":{"200":"createLoanArrangementPayoffResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"GET","path":"/holdings/loans/{loanId}/overpayments","fullPath":"/api/v5.3.0/holdings/loans/{loanId}/overpayments","operationId":"getOverpaymentDetails","name":"Retrieves the product id, type of overpay, overpay limit, overpay period, utilised overpay and remaining overpay limit of a loan arrangement","summary":"Retrieves overpayment details that has happened for a loan arrangement","tags":["RETAIL"],"parameters":[{"name":"loanId","in":"path","type":"string","required":true,"description":"Denotes the arrangement id of the loan"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"OverpaymentDetailsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"POST","path":"/holdings/loans/drawdowns/offers","fullPath":"/api/v5.3.0/holdings/loans/drawdowns/offers","operationId":"createLoanDrawdownOffer","name":"Creates a new drawdown offer for the required customer.","summary":"Creates a new drawdown offer for the required customer.","tags":[],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"customers":[{}],"productId":"string","currency":"string","facilityId":"string","offerDate":"2024-01-01","drawdownDate":"2024-01-01","activity":"string","pricingSelection":"string","pricingPlan":"string","rewardsArrangementId":"string","extensions":{},"principalint":[{}],"penaltyint":[{}],"penalinterest":[{}],"schedule":[{}]}},"responses":{"200":"createLoanDrawdownOfferResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"POST","path":"/holdings/loans/{loanId}/drawdowns/acceptances","fullPath":"/api/v5.3.0/holdings/loans/{loanId}/drawdowns/acceptances","operationId":"createLoanDrawdownOfferAcceptance","name":"Accept the offer drawdown for the retail loan and convert offer drawdown into a live loan arrangement.","summary":"Accept the offer drawdown for the retail loan and convert offer drawdown into a live loan arrangement.","tags":[],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"loanId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"customers":[{}],"productId":"string","currency":"string","facilityId":"string","offerDate":"2024-01-01","drawdownDate":"2024-01-01","activity":"string","pricingSelection":"string","pricingPlan":"string","rewardsArrangementId":"string","extensions":{},"principalint":[{}],"penaltyint":[{}],"penalinterest":[{}],"schedule":[{}]}},"responses":{"200":"createLoanDrawdownOfferAcceptanceResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"POST","path":"/holdings/loans/{loanId}/drawdowns/renegotiations","fullPath":"/api/v5.3.0/holdings/loans/{loanId}/drawdowns/renegotiations","operationId":"createLoanDrawdownOfferRenegotiation","name":"Renegotiate the offer drawdown for the retail loan and convert offer drawdown into live loan arrangement.","summary":"Renegotiate the offer drawdown for the required customer.","tags":[],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"loanId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"customers":[{}],"productId":"string","currency":"string","facilityId":"string","offerDate":"2024-01-01","drawdownDate":"2024-01-01","activity":"string","pricingSelection":"string","pricingPlan":"string","rewardsArrangementId":"string","extensions":{},"principalint":[{}],"penaltyint":[{}],"penalinterest":[{}],"schedule":[{}]}},"responses":{"200":"createLoanDrawdownOfferRenegotiationResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"POST","path":"/holdings/loans/{loanId}/drawdowns/cancellations","fullPath":"/api/v5.3.0/holdings/loans/{loanId}/drawdowns/cancellations","operationId":"cancelLoanDrawdownOffer","name":"Cancellation of offer drawdown for the required customer.","summary":"Cancellation of offer drawdown for the required customer.","tags":[],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"loanId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"customers":[{}],"productId":"string","currency":"string","facilityId":"string","offerDate":"2024-01-01","drawdownDate":"2024-01-01","activity":"string","extensions":{}}},"responses":{"200":"cancelLoanDrawdownOfferResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"POST","path":"/holdings/loans/{loanId}/drawdowns/acceptances/schedules","fullPath":"/api/v5.3.0/holdings/loans/{loanId}/drawdowns/acceptances/schedules","operationId":"createLoanDrawdownOfferAcceptanceSchedules","name":"Accept the offer drawdown for the retail loan and convert offer drawdown into a live loan arrangement and retrieve the payment schedule details.","summary":"Accept the offer drawdown for the retail loan and convert offer drawdown into a live loan arrangement and retrieve the payment schedule details.","tags":[],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"loanId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"customers":[{}],"productId":"string","currency":"string","facilityId":"string","offerDate":"2024-01-01","drawdownDate":"2024-01-01","activity":"string","pricingSelection":"string","pricingPlan":"string","rewardsArrangementId":"string","extensions":{},"principalint":[{}],"penaltyint":[{}],"penalinterest":[{}],"schedule":[{}]}},"responses":{"200":"createLoanDrawdownOfferAcceptanceSchedulesResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"POST","path":"/holdings/loans/{loanId}/drawdowns/renegotiations/schedules","fullPath":"/api/v5.3.0/holdings/loans/{loanId}/drawdowns/renegotiations/schedules","operationId":"createLoanDrawdownOfferRenegotiationSchedules","name":"Renegotiate the offer drawdown for the retail loan and convert offer drawdown into live loan arrangement and retrieve the payment schedule details.","summary":"Renegotiate the offer drawdown for the required customer and retrieve the payment schedule details.","tags":[],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"loanId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"customers":[{}],"productId":"string","currency":"string","facilityId":"string","offerDate":"2024-01-01","drawdownDate":"2024-01-01","activity":"string","pricingSelection":"string","pricingPlan":"string","rewardsArrangementId":"string","extensions":{},"principalint":[{}],"penaltyint":[{}],"penalinterest":[{}],"schedule":[{}]}},"responses":{"200":"createLoanDrawdownOfferRenegotiationSchedulesResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"POST","path":"/holdings/loans","fullPath":"/api/v5.3.0/holdings/loans","operationId":"createLoans","name":"Create an arrangement by negotiating all fields across all property condition.","summary":"Create an arrangement by negotiating all fields across all property condition.","tags":["RETAIL"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"customerIds":[{}],"properties":[{}],"overrides":[{}],"productId":"string","masterArrangementId":"string","roleName":"string","currencyId":"string","effectiveDate":"2024-01-01","activityId":"string","transactionAmount":0.0,"reason":"string","simulationRunReference":"string","extensions":{},"commitment":[{}]}},"responses":{"200":"createLoansResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}}]},{"key":"holdings-loans-arrangements-v6.0.0","title":"Loan creation","version":"v6.0.0","description":"API to create and Manage various types of loans such as Personal, Commercial, Mortgage, Line of Credit, etc","endpointCount":48,"endpoints":[{"method":"POST","path":"/holdings/loans/personalLoans","fullPath":"/api/v1.0.0/holdings/loans/personalLoans","operationId":"createPersonalLoan","name":"Create a personal loan account","summary":"Create a personal loan account","tags":[],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"","default":"","400":"","500":""}},{"method":"POST","path":"/holdings/loans/linkedRateLoans","fullPath":"/api/v1.0.0/holdings/loans/linkedRateLoans","operationId":"createLinkedRateLoan","name":"Create a personal loan account with linked rate","summary":"Create a personal loan account with linked rate","tags":[],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"","default":"","400":"","500":""}},{"method":"POST","path":"/holdings/loans/commercialLoans","fullPath":"/api/v1.0.0/holdings/loans/commercialLoans","operationId":"createCommercialLoan","name":"Create a commercial or business account","summary":"Create a commercial or business account","tags":[],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"","default":"","400":"","500":""}},{"method":"POST","path":"/holdings/loans/mortgages","fullPath":"/api/v1.0.0/holdings/loans/mortgages","operationId":"createMortgage","name":"Create a mortgage loan","summary":"Create a mortgage loan","tags":[],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"","default":"","400":"","500":""}},{"method":"POST","path":"/holdings/loans/creditLines","fullPath":"/api/v1.0.0/holdings/loans/creditLines","operationId":"createCreditLine","name":"Create a lines of credit account","summary":"Create a lines of credit account","tags":[],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"","default":"","400":"","500":""}},{"method":"POST","path":"/holdings/facilities/installmentLoans","fullPath":"/api/v1.0.0/holdings/facilities/installmentLoans","operationId":"createInstallmentLoan","name":"Create an installment loan for the given product","summary":"Create an installment loan for the given product","tags":[],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"","default":"","400":"","500":""}},{"method":"POST","path":"/holdings/fundsTransfer","fullPath":"/api/v1.0.0/holdings/fundsTransfer","operationId":"createFundsTransfer","name":"Create an account transfer","summary":"Create an account transfer","tags":[],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"","default":"","400":"","500":""}},{"method":"POST","path":"/holdings/loans/consumerLoans","fullPath":"/api/v1.0.0/holdings/loans/consumerLoans","operationId":"createConsumerLoan","name":"creates a consumer loan for the given product","summary":"Initiates the creation of consumer loan for the given product","tags":["RETAIL"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"","default":"","400":"","500":""}},{"method":"PUT","path":"/holdings/loans/consumerLoans/{consumerLoanId}/disbursements","fullPath":"/api/v1.0.0/holdings/loans/consumerLoans/{consumerLoanId}/disbursements","operationId":"createConsumerLoanDisbursement","name":"Initiates the disbursement of the given consumer loan contracts commitment amount","summary":"Disburses the consumer loan commitment amount","tags":["RETAIL"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"consumerLoanId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":null,"responses":{"200":"","default":"","400":"","500":""}},{"method":"PUT","path":"/holdings/loans/consumerLoans/{consumerLoanId}/commitmentIncreases","fullPath":"/api/v1.0.0/holdings/loans/consumerLoans/{consumerLoanId}/commitmentIncreases","operationId":"updateConsumerLoanTopupAmount","name":"Increases the commitment amount of the consumer loan","summary":"Increases the commitment amount of the given consumer loan contract","tags":["RETAIL"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"consumerLoanId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":null,"responses":{"200":"","default":"","400":"","500":""}},{"method":"PUT","path":"/holdings/loans/consumerLoans/{consumerLoanId}/commitmentDecreases","fullPath":"/api/v1.0.0/holdings/loans/consumerLoans/{consumerLoanId}/commitmentDecreases","operationId":"updateConsumerLoanDecreaseAmount","name":"Decreases the commitment amount of the consumer loan","summary":"Decreases the commitment amount of the given consumer loan contract","tags":["RETAIL"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"consumerLoanId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":null,"responses":{"200":"","default":"","400":"","500":""}},{"method":"PUT","path":"/holdings/loans/consumerLoans/{consumerLoanId}/repayments","fullPath":"/api/v1.0.0/holdings/loans/consumerLoans/{consumerLoanId}/repayments","operationId":"createConsumerLoanRepayment","name":"Initiates the repayment of the given consumer loan amount","summary":"Repays the consumer loan amount","tags":["RETAIL"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"consumerLoanId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":null,"responses":{"200":"","default":"","400":"","500":""}},{"method":"PUT","path":"/holdings/loans/consumerLoans/{consumerLoanId}/principalDecreases","fullPath":"/api/v1.0.0/holdings/loans/consumerLoans/{consumerLoanId}/principalDecreases","operationId":"createConsumerLoanPrepayment","name":"Initiates the advance repayment of the given consumer loan amount","summary":"Prepays the consumer loan amount","tags":["RETAIL"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"consumerLoanId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":null,"responses":{"200":"","default":"","400":"","500":""}},{"method":"PUT","path":"/holdings/loans/consumerLoans/{consumerLoanId}/schedules","fullPath":"/api/v1.0.0/holdings/loans/consumerLoans/{consumerLoanId}/schedules","operationId":"updateConsumerLoanSchedule","name":"Initiates the change of payment schedule for the given consumer loan contract","summary":"Change payment schedule of the consumer loan","tags":["RETAIL"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"consumerLoanId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":null,"responses":{"200":"","default":"","400":"","500":""}},{"method":"PUT","path":"/holdings/loans/consumerLoans/{consumerLoanId}/paymentHolidays","fullPath":"/api/v1.0.0/holdings/loans/consumerLoans/{consumerLoanId}/paymentHolidays","operationId":"updateConsumerLoanHoliday","name":"Initiates the update of payment holiday for the given consumer loan contract","summary":"Update payment holiday for the consumer loan","tags":["RETAIL"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"consumerLoanId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":null,"responses":{"200":"","default":"","400":"","500":""}},{"method":"GET","path":"/holdings/loans/{loanId}/outstandingBills","fullPath":"/api/v1.0.0/holdings/loans/{loanId}/outstandingBills","operationId":"getLoanOutstandingBills","name":"Retrieves the outstanding amount to be paid for a loan","summary":"Retrieves the outstanding amount to be paid for the given loan","tags":["RETAIL"],"parameters":[{"name":"loanId","in":"path","type":"string","required":true,"description":"Denotes the arrangement id of the loan"},{"name":"fileVersion","in":"query","type":"string","required":false,"description":"Indicates if the file is of type simulation or live"},{"name":"simulationReference","in":"query","type":"string","required":false,"description":"Indicates the reference id for simulation activity"},{"name":"paymentDate","in":"query","type":"string","required":false,"description":"Contains the date in which the payment will be sent out. Date in the format YYYYMMDD. E.g. 20191231"},{"name":"deferDate","in":"query","type":"string","required":false,"description":"Date that the payment has been deferred to"},{"name":"billedAmount","in":"query","type":"string","required":false,"description":"Indicates the bill amount"},{"name":"outstandingAmount","in":"query","type":"string","required":false,"description":"Contains the aggregate outstanding principal amount thereof after giving effect to any borrowings and prepayments or repayments of Committed Loans"},{"name":"delinquentAmount","in":"query","type":"string","required":false,"description":"Indicates the bill amount during the ageing status(Bill which crossed the due date)"},{"name":"property","in":"query","type":"string","required":false,"description":"Id of the product property"},{"name":"billStatus","in":"query","type":"string","required":false,"description":"Indicates the status of a bill(Issued,Due,Ageing,Settled)"},{"name":"settlementStatus","in":"query","type":"string","required":false,"description":"Defines the status of the settlement for the incoming MT548 swift message.The values allowed are: Waiting : pending to receive settlement status update meaning pending to receive MT548 swift message, "},{"name":"agingStatus","in":"query","type":"string","required":false,"description":"Indicates the ageing status of a bill"},{"name":"settled","in":"query","type":"string","required":false,"description":"Flag to indicate whether a bill is settled or not"},{"name":"paymentType","in":"query","type":"string","required":false,"description":"Indicates if the payment is Customer (C) type or Bank (B) type"},{"name":"billDate","in":"query","type":"string","required":false,"description":"Indicates a date on which a bill has been raised"},{"name":"paymentMethod","in":"query","type":"string","required":false,"description":"Method chosen to make the payment"},{"name":"infoPayType","in":"query","type":"string","required":false,"description":"Indicates a bill which is raised when a loan is paid off"},{"name":"advancePayment","in":"query","type":"string","required":false,"description":"Indicates whether advance payment made is set on an account"},{"name":"paymentIndicator","in":"query","type":"string","required":false,"description":"Indicates whether its a credit/debit type of bill"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"","default":"","400":"","500":""}},{"method":"GET","path":"/holdings/loans/{loanId}/payoffCalculations","fullPath":"/api/v1.0.0/holdings/loans/{loanId}/payoffCalculations","operationId":"getLoanPayoffDetails","name":"Retrieves the payoff details of a loan","summary":"Retrieves the payoff details of the given loan","tags":["RETAIL"],"parameters":[{"name":"loanId","in":"path","type":"string","required":true,"description":"Denotes the arrangement id of the loan"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"","default":"","400":"","500":""}},{"method":"PUT","path":"/holdings/loans/consumerLoans/{consumerLoanId}/customers","fullPath":"/api/v1.0.0/holdings/loans/consumerLoans/{consumerLoanId}/customers","operationId":"updateConsumerLoansCustomer","name":"Initiates the change of customers for the given consumer loan contract","summary":"Changes the customers of the consumer loan ","tags":["RETAIL"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"consumerLoanId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":null,"responses":{"200":"","default":"","400":"","500":""}},{"method":"PUT","path":"/holdings/loans/consumerLoans/{consumerLoanId}/payoffs","fullPath":"/api/v1.0.0/holdings/loans/consumerLoans/{consumerLoanId}/payoffs","operationId":"createPayoffConsumerLoan","name":"Initiates the payoff of the given consumer loan contract amount","summary":"Payoffs the consumer loan amount","tags":["RETAIL"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"consumerLoanId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":null,"responses":{"200":"","default":"","400":"","500":""}},{"method":"PUT","path":"/holdings/loans/consumerLoans/{consumerLoanId}/renegotiations","fullPath":"/api/v1.0.0/holdings/loans/consumerLoans/{consumerLoanId}/renegotiations","operationId":"updateConsumerLoanConditions","name":"Initiates the renegotiation of the given consumer loan contract details","summary":"Renegotiates the consumer loan contract details","tags":["RETAIL"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"consumerLoanId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":null,"responses":{"200":"","default":"","400":"","500":""}},{"method":"GET","path":"/holdings/loans/{loanId}/status","fullPath":"/api/v1.0.0/holdings/loans/{loanId}/status","operationId":"getArrangementDetails","name":"Retrieves the status of a loan","summary":"Retrieves the status of the given loan","tags":["RETAIL"],"parameters":[{"name":"loanId","in":"path","type":"string","required":true,"description":"Denotes the arrangement id of the loan"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"","default":"","400":"","500":""}},{"method":"GET","path":"/holdings/loans/arrangements/activities/{arrangementActivityId}/status","fullPath":"/api/v1.0.0/holdings/loans/arrangements/activities/{arrangementActivityId}/status","operationId":"getExternalEventStatus","name":"Retrieves the status of the given activity ","summary":"Retrieves the status of the given activity ","tags":["RETAIL"],"parameters":[{"name":"arrangementActivityId","in":"path","type":"string","required":true,"description":"Contains the arrangement activity reference identifier"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"","default":"","400":"","500":""}},{"method":"PUT","path":"/holdings/loans/consumerLoans/{consumerLoanId}/payoffCalculations","fullPath":"/api/v1.0.0/holdings/loans/consumerLoans/{consumerLoanId}/payoffCalculations","operationId":"calculatePayoffConsumerLoans","name":"Initiates calculate pyoff activity to calculate consumer loan payment amount to close the given loan","summary":"Calculates consumer loan payment amount to close a loan","tags":["RETAIL"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"consumerLoanId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":null,"responses":{"200":"","default":"","400":"","500":""}},{"method":"GET","path":"/holdings/loans/{loanId}/schedules","fullPath":"/api/v1.0.0/holdings/loans/{loanId}/schedules","operationId":"getPaymentSchedulesProjection","name":"Retrieves the schedule payment information for paid and upcoming installments details","summary":"Retrieves payment schedules details","tags":["RETAIL"],"parameters":[{"name":"loanId","in":"path","type":"string","required":true,"description":"Denotes the arrangement id of the loan"},{"name":"dateFrom","in":"query","type":"string","required":false,"description":"Start date of the loan"},{"name":"dateTo","in":"query","type":"string","required":false,"description":"End date of the loan"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"","default":"","400":"","500":""}},{"method":"GET","path":"/holdings/loans/{loanId}/loanDetails","fullPath":"/api/v1.0.0/holdings/loans/{loanId}/loanDetails","operationId":"getLoanOverview","name":"Retrieves the details of the given loan","summary":"Retrieves loan details ","tags":["RETAIL"],"parameters":[{"name":"loanId","in":"path","type":"string","required":true,"description":"Denotes the arrangement id of the loan"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"","default":"","400":"","500":""}},{"method":"GET","path":"/holdings/loans/{loanId}/bills","fullPath":"/api/v1.0.0/holdings/loans/{loanId}/bills","operationId":"getLoanBills","name":"Retrieves the simulation details of the contract based on the selection criteria. It returns the bill details of the loan","summary":"Retrieves loan bills details","tags":[],"parameters":[{"name":"loanId","in":"path","type":"string","required":true,"description":"Denotes the arrangement id of the loan"},{"name":"billType","in":"query","type":"string","required":false,"description":"The type of payment obligation generated"},{"name":"paymentDate","in":"query","type":"string","required":false,"description":"Contains the date in which the payment will be sent out. Date in the format YYYYMMDD. E.g. 20191231"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"","default":"","400":"","500":""}},{"method":"GET","path":"/holdings/loans/{loanId}/collaterals","fullPath":"/api/v1.0.0/holdings/loans/{loanId}/collaterals","operationId":"getLoanCollaterals","name":"Retrieves the collateral details linked to the loan arrangement. The collateral right and status have to be passed within the api","summary":"Retrieves loan collateral details","tags":[],"parameters":[{"name":"loanId","in":"path","type":"string","required":true,"description":"Denotes the arrangement id of the loan"},{"name":"status","in":"query","type":"string","required":false,"description":"Contains status of the data rights request.Allowed values are INITIATED, INPROGESS, EXTENDED, COMPLETED, REJECTED."},{"name":"statusNE","in":"query","type":"string","required":false,"description":"Status not equal to"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"","default":"","400":"","500":""}},{"method":"GET","path":"/holdings/loans/{loanId}","fullPath":"/api/v1.0.0/holdings/loans/{loanId}","operationId":"getLoanDetails","name":"Retrieves loan details","summary":"Retrieves the loan account details","tags":[],"parameters":[{"name":"loanId","in":"path","type":"string","required":true,"description":"Denotes the arrangement id of the loan"},{"name":"dateFrom","in":"query","type":"string","required":false,"description":"Start date of the loan"},{"name":"dateTo","in":"query","type":"string","required":false,"description":"End date of the loan"},{"name":"balanceTypes","in":"query","type":"string","required":false,"description":"Type of balance (e.g. current balance, credit interest accrued, deferred commission, etc.) as defined in the institution's accounting schemas."},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"","default":"","400":"","500":""}},{"method":"GET","path":"/holdings/loans/{loanId}/schedulePaymentFrequencies","fullPath":"/api/v1.0.0/holdings/loans/{loanId}/schedulePaymentFrequencies","operationId":"getPaymentSchedules","name":"Retrieves the schedule payment information for paid and upcoming installments details","summary":"Retrieves payment schedules details","tags":[],"parameters":[{"name":"loanId","in":"path","type":"string","required":true,"description":"Denotes the arrangement id of the loan"},{"name":"dateFrom","in":"query","type":"string","required":false,"description":"Start date of the loan"},{"name":"dateTo","in":"query","type":"string","required":false,"description":"End date of the loan"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"","default":"","400":"","500":""}},{"method":"POST","path":"/holdings/simulationCapture/{arrangementId}","fullPath":"/api/v1.0.0/holdings/simulationCapture/{arrangementId}","operationId":"createSimulationCapture","name":"Simulate payoff calculate activity for a loan arrangement","summary":"Simulate payoff calculate activity for a loan arrangement","tags":[],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"arrangementId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":null,"responses":{"200":"","default":"","400":"","500":""}},{"method":"POST","path":"/holdings/loans/simulations","fullPath":"/api/v1.0.0/holdings/loans/simulations","operationId":"createLoanSimulation","name":"Create a simulation for loan product with details like customer identifier, currency, etc.","summary":"Create simulation for loan products","tags":["RETAIL"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"","default":"","400":"","500":""}},{"method":"PUT","path":"/holdings/loans/simulations/{simulationId}","fullPath":"/api/v1.0.0/holdings/loans/simulations/{simulationId}","operationId":"updateLoanSimulation","name":"Update a simulation for loan product with details like customer identifier, currency, etc.","summary":"Update a simulation for loan products","tags":["RETAIL"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"simulationId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":null,"responses":{"200":"","default":"","400":"","500":""}},{"method":"POST","path":"/holdings/loans/{loanId}/simulations/payoffs","fullPath":"/api/v1.0.0/holdings/loans/{loanId}/simulations/payoffs","operationId":"createLoanPayoffSimulation","name":"Create a simulation payoff activity for loan product with product id details","summary":"Create simulation payoff activity for loan products","tags":["RETAIL"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"loanId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":null,"responses":{"200":"","default":"","400":"","500":""}},{"method":"POST","path":"/holdings/loans/{loanId}/payoffs","fullPath":"/api/v1.0.0/holdings/loans/{loanId}/payoffs","operationId":"createLoanArrangementPayoff","name":"Execute payoff activity for loan product with details like simulation run reference, product id , etc.","summary":"Execute payoff activity for loan products","tags":["RETAIL"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"loanId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":null,"responses":{"200":"","default":"","400":"","500":""}},{"method":"GET","path":"/holdings/loans/{loanId}/overpayments","fullPath":"/api/v1.0.0/holdings/loans/{loanId}/overpayments","operationId":"getOverpaymentDetails","name":"Retrieves the product id, type of overpay, overpay limit, overpay period, utilised overpay and remaining overpay limit of a loan arrangement","summary":"Retrieves overpayment details that has happened for a loan arrangement","tags":["RETAIL"],"parameters":[{"name":"loanId","in":"path","type":"string","required":true,"description":"Denotes the arrangement id of the loan"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"","default":"","400":"","500":""}},{"method":"POST","path":"/holdings/loans/drawdowns/offers","fullPath":"/api/v1.0.0/holdings/loans/drawdowns/offers","operationId":"createLoanDrawdownOffer","name":"Creates a new drawdown offer for the required customer.","summary":"Creates a new drawdown offer for the required customer.","tags":[],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"","default":"","400":"","500":""}},{"method":"POST","path":"/holdings/loans/{loanId}/drawdowns/acceptances","fullPath":"/api/v1.0.0/holdings/loans/{loanId}/drawdowns/acceptances","operationId":"createLoanDrawdownOfferAcceptance","name":"Accept the offer drawdown for the retail loan and convert offer drawdown into a live loan arrangement.","summary":"Accept the offer drawdown for the retail loan and convert offer drawdown into a live loan arrangement.","tags":[],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"loanId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":null,"responses":{"200":"","default":"","400":"","500":""}},{"method":"POST","path":"/holdings/loans/{loanId}/drawdowns/renegotiations","fullPath":"/api/v1.0.0/holdings/loans/{loanId}/drawdowns/renegotiations","operationId":"createLoanDrawdownOfferRenegotiation","name":"Renegotiate the offer drawdown for the retail loan and convert offer drawdown into live loan arrangement.","summary":"Renegotiate the offer drawdown for the required customer.","tags":[],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"loanId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":null,"responses":{"200":"","default":"","400":"","500":""}},{"method":"POST","path":"/holdings/loans/{loanId}/drawdowns/cancellations","fullPath":"/api/v1.0.0/holdings/loans/{loanId}/drawdowns/cancellations","operationId":"cancelLoanDrawdownOffer","name":"Cancellation of offer drawdown for the required customer.","summary":"Cancellation of offer drawdown for the required customer.","tags":[],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"loanId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":null,"responses":{"200":"","default":"","400":"","500":""}},{"method":"POST","path":"/holdings/loans/{loanId}/drawdowns/acceptances/schedules","fullPath":"/api/v1.0.0/holdings/loans/{loanId}/drawdowns/acceptances/schedules","operationId":"createLoanDrawdownOfferAcceptanceSchedules","name":"Accept the offer drawdown for the retail loan and convert offer drawdown into a live loan arrangement and retrieve the payment schedule details.","summary":"Accept the offer drawdown for the retail loan and convert offer drawdown into a live loan arrangement and retrieve the payment schedule details.","tags":[],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"loanId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":null,"responses":{"200":"","default":"","400":"","500":""}},{"method":"POST","path":"/holdings/loans/{loanId}/drawdowns/renegotiations/schedules","fullPath":"/api/v1.0.0/holdings/loans/{loanId}/drawdowns/renegotiations/schedules","operationId":"createLoanDrawdownOfferRenegotiationSchedules","name":"Renegotiate the offer drawdown for the retail loan and convert offer drawdown into live loan arrangement and retrieve the payment schedule details.","summary":"Renegotiate the offer drawdown for the required customer and retrieve the payment schedule details.","tags":[],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"loanId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":null,"responses":{"200":"","default":"","400":"","500":""}},{"method":"PUT","path":"/holdings/loans/{LoanId}/settlements","fullPath":"/api/v1.0.0/holdings/loans/{LoanId}/settlements","operationId":"updateLoanSettlement","name":"Updates the settlement condition of the Loan","summary":"Updates the settlement condition of the Loan","tags":[],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"LoanId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":null,"responses":{"200":"","default":"","400":"","500":""}},{"method":"POST","path":"/holdings/loans/{loanId}/simulations/repayments","fullPath":"/api/v1.0.0/holdings/loans/{loanId}/simulations/repayments","operationId":"createRepaymentSimulation","name":"Simulate the pre payment of the given loan amount","summary":"Simulate  the loan pre payment","tags":[],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"loanId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":null,"responses":{"200":"","default":"","400":"","500":""}},{"method":"POST","path":"/holdings/loans/{loanId}/simulations/repayments/schedules","fullPath":"/api/v1.0.0/holdings/loans/{loanId}/simulations/repayments/schedules","operationId":"createRepaymentSchedule","name":"Simulate the pre payment of the given loan amount and retrieve the payment schedule","summary":"Simulate the pre payment of the given loan amount and retrieve the payment schedule","tags":[],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"loanId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":null,"responses":{"200":"","default":"","400":"","500":""}},{"method":"PUT","path":"/holdings/loans/{loanId}/repaymentDates","fullPath":"/api/v1.0.0/holdings/loans/{loanId}/repaymentDates","operationId":"updateRepaymentDate","name":"Perform repayment date change for the loan product with details like loan reference, product id , etc.","summary":"Perform repayment date change for the loan","tags":[],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"loanId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":null,"responses":{"200":"","default":"","400":"","500":""}},{"method":"PUT","path":"/holdings/loans/{loanId}/repaymentDates/schedules","fullPath":"/api/v1.0.0/holdings/loans/{loanId}/repaymentDates/schedules","operationId":"updateRepaymentDateAndSchedules","name":"Perform repayment date change for the loan product and retrieve the payment schedule , interest details etc.","summary":"Perform repayment date change for the loan and retrieve the payment schedule details.","tags":[],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"loanId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":null,"responses":{"200":"","default":"","400":"","500":""}},{"method":"POST","path":"/holdings/loans/{loanId}/simulations/repaymentDates","fullPath":"/api/v1.0.0/holdings/loans/{loanId}/simulations/repaymentDates","operationId":"createRepaymentDateChangeSimulation","name":"Simulate a loan arrangement for the given payment date","summary":"Simulate a loan arrangement for the given payment date","tags":[],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"loanId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":null,"responses":{"200":"","default":"","400":"","500":""}},{"method":"POST","path":"/holdings/loans/{loanId}/simulations/repaymentDates/schedules","fullPath":"/api/v1.0.0/holdings/loans/{loanId}/simulations/repaymentDates/schedules","operationId":"createRepaymentDateChangeSimulationSchedules","name":"Simulate a loan arrangement for the given payment date and retrieve the payments schedule , interest details etc.","summary":"Simulate a loan arrangement for the given payment date and retrieve the payments schedule details.","tags":[],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"loanId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":null,"responses":{"200":"","default":"","400":"","500":""}}]},{"key":"holdings-loans-arrangements-v6.1.0","title":"Loan creation","version":"v6.1.0","description":"API to create and manage various types of loans such as Personal, Commercial, Mortgage, Line of Credit, etc","endpointCount":49,"endpoints":[{"method":"POST","path":"/holdings/loans/businessLoans","fullPath":"/api/v1.0.0/holdings/loans/businessLoans","operationId":"createBusinessLoan","name":"Creates a business banking loan for a single customer or more than one customer(like a joint account relationship) with the customer identifier, customer role, loan currency details","summary":"Creates a business banking loan for a single or joint customer","tags":["RETAIL"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"","default":"","400":"","500":""}},{"method":"POST","path":"/holdings/loans/personalLoans","fullPath":"/api/v1.0.0/holdings/loans/personalLoans","operationId":"createPersonalLoan","name":"Create a personal loan account","summary":"Create a personal loan account","tags":[],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"","default":"","400":"","500":""}},{"method":"POST","path":"/holdings/loans/linkedRateLoans","fullPath":"/api/v1.0.0/holdings/loans/linkedRateLoans","operationId":"createLinkedRateLoan","name":"Create a personal loan account with linked rate","summary":"Create a personal loan account with linked rate","tags":[],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"","default":"","400":"","500":""}},{"method":"POST","path":"/holdings/loans/commercialLoans","fullPath":"/api/v1.0.0/holdings/loans/commercialLoans","operationId":"createCommercialLoan","name":"Create a commercial or business loan account","summary":"Create a commercial or business loan account","tags":[],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"","default":"","400":"","500":""}},{"method":"POST","path":"/holdings/loans/mortgages","fullPath":"/api/v1.0.0/holdings/loans/mortgages","operationId":"createMortgage","name":"Create a mortgage loan","summary":"Create a mortgage loan","tags":[],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"","default":"","400":"","500":""}},{"method":"POST","path":"/holdings/loans/creditLines","fullPath":"/api/v1.0.0/holdings/loans/creditLines","operationId":"createCreditLine","name":"Create a lines of credit account","summary":"Create a lines of credit account","tags":[],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"","default":"","400":"","500":""}},{"method":"POST","path":"/holdings/facilities/installmentLoans","fullPath":"/api/v1.0.0/holdings/facilities/installmentLoans","operationId":"createInstallmentLoan","name":"Create an installment loan for the given product","summary":"Create an installment loan for the given product","tags":[],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"","default":"","400":"","500":""}},{"method":"POST","path":"/holdings/fundsTransfer","fullPath":"/api/v1.0.0/holdings/fundsTransfer","operationId":"createFundsTransfer","name":"Create an account transfer","summary":"Create an account transfer","tags":[],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"","default":"","400":"","500":""}},{"method":"POST","path":"/holdings/loans/consumerLoans","fullPath":"/api/v1.0.0/holdings/loans/consumerLoans","operationId":"createConsumerLoan","name":"creates a consumer loan for the given product","summary":"Initiates the creation of consumer loan for the given product","tags":["RETAIL"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"","default":"","400":"","500":""}},{"method":"PUT","path":"/holdings/loans/consumerLoans/{consumerLoanId}/disbursements","fullPath":"/api/v1.0.0/holdings/loans/consumerLoans/{consumerLoanId}/disbursements","operationId":"createConsumerLoanDisbursement","name":"Initiates the disbursement of the given consumer loan contracts commitment amount","summary":"Disburses the consumer loan commitment amount","tags":["RETAIL"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"consumerLoanId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":null,"responses":{"200":"","default":"","400":"","500":""}},{"method":"PUT","path":"/holdings/loans/consumerLoans/{consumerLoanId}/commitmentIncreases","fullPath":"/api/v1.0.0/holdings/loans/consumerLoans/{consumerLoanId}/commitmentIncreases","operationId":"updateConsumerLoanTopupAmount","name":"Increases the commitment amount of the consumer loan","summary":"Increases the commitment amount of the given consumer loan contract","tags":["RETAIL"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"consumerLoanId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":null,"responses":{"200":"","default":"","400":"","500":""}},{"method":"PUT","path":"/holdings/loans/consumerLoans/{consumerLoanId}/commitmentDecreases","fullPath":"/api/v1.0.0/holdings/loans/consumerLoans/{consumerLoanId}/commitmentDecreases","operationId":"updateConsumerLoanDecreaseAmount","name":"Decreases the commitment amount of the consumer loan","summary":"Decreases the commitment amount of the given consumer loan contract","tags":["RETAIL"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"consumerLoanId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":null,"responses":{"200":"","default":"","400":"","500":""}},{"method":"PUT","path":"/holdings/loans/consumerLoans/{consumerLoanId}/repayments","fullPath":"/api/v1.0.0/holdings/loans/consumerLoans/{consumerLoanId}/repayments","operationId":"createConsumerLoanRepayment","name":"Initiates the repayment of the given consumer loan amount","summary":"Repays the consumer loan amount","tags":["RETAIL"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"consumerLoanId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":null,"responses":{"200":"","default":"","400":"","500":""}},{"method":"PUT","path":"/holdings/loans/consumerLoans/{consumerLoanId}/principalDecreases","fullPath":"/api/v1.0.0/holdings/loans/consumerLoans/{consumerLoanId}/principalDecreases","operationId":"createConsumerLoanPrepayment","name":"Initiates the advance repayment of the given consumer loan amount","summary":"Prepays the consumer loan amount","tags":["RETAIL"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"consumerLoanId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":null,"responses":{"200":"","default":"","400":"","500":""}},{"method":"PUT","path":"/holdings/loans/consumerLoans/{consumerLoanId}/schedules","fullPath":"/api/v1.0.0/holdings/loans/consumerLoans/{consumerLoanId}/schedules","operationId":"updateConsumerLoanSchedule","name":"Initiates the change of payment schedule for the given consumer loan contract","summary":"Change payment schedule of the consumer loan","tags":["RETAIL"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"consumerLoanId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":null,"responses":{"200":"","default":"","400":"","500":""}},{"method":"PUT","path":"/holdings/loans/consumerLoans/{consumerLoanId}/paymentHolidays","fullPath":"/api/v1.0.0/holdings/loans/consumerLoans/{consumerLoanId}/paymentHolidays","operationId":"updateConsumerLoanHoliday","name":"Initiates the update of payment holiday for the given consumer loan contract","summary":"Update payment holiday for the consumer loan","tags":["RETAIL"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"consumerLoanId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":null,"responses":{"200":"","default":"","400":"","500":""}},{"method":"GET","path":"/holdings/loans/{loanId}/outstandingBills","fullPath":"/api/v1.0.0/holdings/loans/{loanId}/outstandingBills","operationId":"getLoanOutstandingBills","name":"Retrieves the outstanding amount to be paid for a loan","summary":"Retrieves the outstanding amount to be paid for the given loan","tags":["RETAIL"],"parameters":[{"name":"loanId","in":"path","type":"string","required":true,"description":"Denotes the arrangement id of the loan"},{"name":"fileVersion","in":"query","type":"string","required":false,"description":"Indicates if the file is of type simulation or live"},{"name":"simulationReference","in":"query","type":"string","required":false,"description":"Indicates the reference id for simulation activity"},{"name":"paymentDate","in":"query","type":"string","required":false,"description":"Contains the date in which the payment will be sent out. Date in the format YYYYMMDD. E.g. 20191231"},{"name":"deferDate","in":"query","type":"string","required":false,"description":"Date that the payment has been deferred to"},{"name":"billedAmount","in":"query","type":"string","required":false,"description":"Indicates the bill amount"},{"name":"outstandingAmount","in":"query","type":"string","required":false,"description":"Contains the aggregate outstanding principal amount thereof after giving effect to any borrowings and prepayments or repayments of Committed Loans"},{"name":"delinquentAmount","in":"query","type":"string","required":false,"description":"Indicates the bill amount during the ageing status(Bill which crossed the due date)"},{"name":"property","in":"query","type":"string","required":false,"description":"Id of the product property"},{"name":"billStatus","in":"query","type":"string","required":false,"description":"Indicates the status of a bill(Issued,Due,Ageing,Settled)"},{"name":"settlementStatus","in":"query","type":"string","required":false,"description":"Defines the status of the settlement for the incoming MT548 swift message.The values allowed are: Waiting : pending to receive settlement status update meaning pending to receive MT548 swift message, "},{"name":"agingStatus","in":"query","type":"string","required":false,"description":"Indicates the ageing status of a bill"},{"name":"settled","in":"query","type":"string","required":false,"description":"Flag to indicate whether a bill is settled or not"},{"name":"paymentType","in":"query","type":"string","required":false,"description":"Indicates if the payment is Customer (C) type or Bank (B) type"},{"name":"billDate","in":"query","type":"string","required":false,"description":"Indicates a date on which a bill has been raised"},{"name":"paymentMethod","in":"query","type":"string","required":false,"description":"Method chosen to make the payment"},{"name":"infoPayType","in":"query","type":"string","required":false,"description":"Indicates a bill which is raised when a loan is paid off"},{"name":"advancePayment","in":"query","type":"string","required":false,"description":"Indicates whether advance payment made is set on an account"},{"name":"paymentIndicator","in":"query","type":"string","required":false,"description":"Indicates whether its a credit/debit type of bill"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"","default":"","400":"","500":""}},{"method":"GET","path":"/holdings/loans/{loanId}/payoffCalculations","fullPath":"/api/v1.0.0/holdings/loans/{loanId}/payoffCalculations","operationId":"getLoanPayoffDetails","name":"Retrieves the payoff details of a loan","summary":"Retrieves the payoff details of the given loan","tags":["RETAIL"],"parameters":[{"name":"loanId","in":"path","type":"string","required":true,"description":"Denotes the arrangement id of the loan"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"","default":"","400":"","500":""}},{"method":"PUT","path":"/holdings/loans/consumerLoans/{consumerLoanId}/customers","fullPath":"/api/v1.0.0/holdings/loans/consumerLoans/{consumerLoanId}/customers","operationId":"updateConsumerLoansCustomer","name":"Initiates the change of customers for the given consumer loan contract","summary":"Changes the customers of the consumer loan ","tags":["RETAIL"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"consumerLoanId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":null,"responses":{"200":"","default":"","400":"","500":""}},{"method":"PUT","path":"/holdings/loans/consumerLoans/{consumerLoanId}/payoffs","fullPath":"/api/v1.0.0/holdings/loans/consumerLoans/{consumerLoanId}/payoffs","operationId":"createPayoffConsumerLoan","name":"Initiates the payoff of the given consumer loan contract amount","summary":"Payoffs the consumer loan amount","tags":["RETAIL"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"consumerLoanId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":null,"responses":{"200":"","default":"","400":"","500":""}},{"method":"PUT","path":"/holdings/loans/consumerLoans/{consumerLoanId}/renegotiations","fullPath":"/api/v1.0.0/holdings/loans/consumerLoans/{consumerLoanId}/renegotiations","operationId":"updateConsumerLoanConditions","name":"Initiates the renegotiation of the given consumer loan contract details","summary":"Renegotiates the consumer loan contract details","tags":["RETAIL"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"consumerLoanId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":null,"responses":{"200":"","default":"","400":"","500":""}},{"method":"GET","path":"/holdings/loans/{loanId}/status","fullPath":"/api/v1.0.0/holdings/loans/{loanId}/status","operationId":"getArrangementDetails","name":"Retrieves the status of a loan","summary":"Retrieves the status of the given loan","tags":["RETAIL"],"parameters":[{"name":"loanId","in":"path","type":"string","required":true,"description":"Denotes the arrangement id of the loan"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"","default":"","400":"","500":""}},{"method":"GET","path":"/holdings/loans/arrangements/activities/{arrangementActivityId}/status","fullPath":"/api/v1.0.0/holdings/loans/arrangements/activities/{arrangementActivityId}/status","operationId":"getExternalEventStatus","name":"Retrieves the status of the given activity ","summary":"Retrieves the status of the given activity ","tags":["RETAIL"],"parameters":[{"name":"arrangementActivityId","in":"path","type":"string","required":true,"description":"Contains the arrangement activity reference identifier"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"","default":"","400":"","500":""}},{"method":"PUT","path":"/holdings/loans/consumerLoans/{consumerLoanId}/payoffCalculations","fullPath":"/api/v1.0.0/holdings/loans/consumerLoans/{consumerLoanId}/payoffCalculations","operationId":"calculatePayoffConsumerLoans","name":"Initiates calculate pyoff activity to calculate consumer loan payment amount to close the given loan","summary":"Calculates consumer loan payment amount to close a loan","tags":["RETAIL"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"consumerLoanId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":null,"responses":{"200":"","default":"","400":"","500":""}},{"method":"GET","path":"/holdings/loans/{loanId}/schedules","fullPath":"/api/v1.0.0/holdings/loans/{loanId}/schedules","operationId":"getPaymentSchedulesProjection","name":"Retrieves the schedule payment information for paid and upcoming installments details","summary":"Retrieves payment schedules details","tags":["RETAIL"],"parameters":[{"name":"loanId","in":"path","type":"string","required":true,"description":"Denotes the arrangement id of the loan"},{"name":"dateFrom","in":"query","type":"string","required":false,"description":"Start date of the loan"},{"name":"dateTo","in":"query","type":"string","required":false,"description":"End date of the loan"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"","default":"","400":"","500":""}},{"method":"GET","path":"/holdings/loans/{loanId}/loanDetails","fullPath":"/api/v1.0.0/holdings/loans/{loanId}/loanDetails","operationId":"getLoanOverview","name":"Retrieves the details of the given loan","summary":"Retrieves loan details ","tags":["RETAIL"],"parameters":[{"name":"loanId","in":"path","type":"string","required":true,"description":"Denotes the arrangement id of the loan"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"","default":"","400":"","500":""}},{"method":"GET","path":"/holdings/loans/{loanId}/bills","fullPath":"/api/v1.0.0/holdings/loans/{loanId}/bills","operationId":"getLoanBills","name":"Retrieves the simulation details of the contract based on the selection criteria. It returns the bill details of the loan","summary":"Retrieves loan bills details","tags":[],"parameters":[{"name":"loanId","in":"path","type":"string","required":true,"description":"Denotes the arrangement id of the loan"},{"name":"billType","in":"query","type":"string","required":false,"description":"The type of payment obligation generated"},{"name":"paymentDate","in":"query","type":"string","required":false,"description":"Contains the date in which the payment will be sent out. Date in the format YYYYMMDD. E.g. 20191231"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"","default":"","400":"","500":""}},{"method":"GET","path":"/holdings/loans/{loanId}/collaterals","fullPath":"/api/v1.0.0/holdings/loans/{loanId}/collaterals","operationId":"getLoanCollaterals","name":"Retrieves the collateral details linked to the loan arrangement. The collateral right and status have to be provided","summary":"Retrieves loan collateral details","tags":[],"parameters":[{"name":"loanId","in":"path","type":"string","required":true,"description":"Denotes the arrangement id of the loan"},{"name":"status","in":"query","type":"string","required":false,"description":"Contains status of the data rights request.Allowed values are INITIATED, INPROGESS, EXTENDED, COMPLETED, REJECTED."},{"name":"statusNE","in":"query","type":"string","required":false,"description":"Status not equal to"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"","default":"","400":"","500":""}},{"method":"GET","path":"/holdings/loans/{loanId}","fullPath":"/api/v1.0.0/holdings/loans/{loanId}","operationId":"getLoanDetails","name":"Retrieves loan details","summary":"Retrieves the loan account details","tags":[],"parameters":[{"name":"loanId","in":"path","type":"string","required":true,"description":"Denotes the arrangement id of the loan"},{"name":"dateFrom","in":"query","type":"string","required":false,"description":"Start date of the loan"},{"name":"dateTo","in":"query","type":"string","required":false,"description":"End date of the loan"},{"name":"balanceTypes","in":"query","type":"string","required":false,"description":"Type of balance (e.g. current balance, credit interest accrued, deferred commission, etc.) as defined in the institution's accounting schemas."},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"","default":"","400":"","500":""}},{"method":"GET","path":"/holdings/loans/{loanId}/schedulePaymentFrequencies","fullPath":"/api/v1.0.0/holdings/loans/{loanId}/schedulePaymentFrequencies","operationId":"getPaymentSchedules","name":"Retrieves the schedule payment information for paid and upcoming installments details","summary":"Retrieves payment schedules details","tags":[],"parameters":[{"name":"loanId","in":"path","type":"string","required":true,"description":"Denotes the arrangement id of the loan"},{"name":"dateFrom","in":"query","type":"string","required":false,"description":"Start date of the loan"},{"name":"dateTo","in":"query","type":"string","required":false,"description":"End date of the loan"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"","default":"","400":"","500":""}},{"method":"POST","path":"/holdings/simulationCapture/{arrangementId}","fullPath":"/api/v1.0.0/holdings/simulationCapture/{arrangementId}","operationId":"createSimulationCapture","name":"Simulate payoff calculate activity for a loan arrangement","summary":"Simulate payoff calculate activity for a loan arrangement","tags":[],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"arrangementId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":null,"responses":{"200":"","default":"","400":"","500":""}},{"method":"POST","path":"/holdings/loans/simulations","fullPath":"/api/v1.0.0/holdings/loans/simulations","operationId":"createLoanSimulation","name":"Create a simulation for loan product with details like customer identifier, currency, etc.","summary":"Create simulation for loan products","tags":["RETAIL"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"","default":"","400":"","500":""}},{"method":"PUT","path":"/holdings/loans/simulations/{simulationId}","fullPath":"/api/v1.0.0/holdings/loans/simulations/{simulationId}","operationId":"updateLoanSimulation","name":"Update a simulation for loan product with details like customer identifier, currency, etc.","summary":"Update a simulation for loan products","tags":["RETAIL"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"simulationId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":null,"responses":{"200":"","default":"","400":"","500":""}},{"method":"POST","path":"/holdings/loans/{loanId}/simulations/payoffs","fullPath":"/api/v1.0.0/holdings/loans/{loanId}/simulations/payoffs","operationId":"createLoanPayoffSimulation","name":"Create a simulation payoff activity for loan product with product id details","summary":"Create simulation payoff activity for loan products","tags":["RETAIL"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"loanId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":null,"responses":{"200":"","default":"","400":"","500":""}},{"method":"POST","path":"/holdings/loans/{loanId}/payoffs","fullPath":"/api/v1.0.0/holdings/loans/{loanId}/payoffs","operationId":"createLoanArrangementPayoff","name":"Execute payoff activity for loan product with details like simulation run reference, product id , etc.","summary":"Execute payoff activity for loan products","tags":["RETAIL"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"loanId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":null,"responses":{"200":"","default":"","400":"","500":""}},{"method":"GET","path":"/holdings/loans/{loanId}/overpayments","fullPath":"/api/v1.0.0/holdings/loans/{loanId}/overpayments","operationId":"getOverpaymentDetails","name":"Retrieves the product id, type of overpay, overpay limit, overpay period, utilised overpay and remaining overpay limit of a loan arrangement","summary":"Retrieves overpayment details that has happened for a loan arrangement","tags":["RETAIL"],"parameters":[{"name":"loanId","in":"path","type":"string","required":true,"description":"Denotes the arrangement id of the loan"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"","default":"","400":"","500":""}},{"method":"POST","path":"/holdings/loans/drawdowns/offers","fullPath":"/api/v1.0.0/holdings/loans/drawdowns/offers","operationId":"createLoanDrawdownOffer","name":"Creates a new drawdown offer for the required customer.","summary":"Creates a new drawdown offer for the required customer.","tags":[],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"","default":"","400":"","500":""}},{"method":"POST","path":"/holdings/loans/{loanId}/drawdowns/acceptances","fullPath":"/api/v1.0.0/holdings/loans/{loanId}/drawdowns/acceptances","operationId":"createLoanDrawdownOfferAcceptance","name":"Accept the offer drawdown for the retail loan and convert offer drawdown into a live loan arrangement.","summary":"Accept the offer drawdown for the retail loan and convert offer drawdown into a live loan arrangement.","tags":[],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"loanId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":null,"responses":{"200":"","default":"","400":"","500":""}},{"method":"POST","path":"/holdings/loans/{loanId}/drawdowns/renegotiations","fullPath":"/api/v1.0.0/holdings/loans/{loanId}/drawdowns/renegotiations","operationId":"createLoanDrawdownOfferRenegotiation","name":"Renegotiate the offer drawdown for the retail loan and convert offer drawdown into live loan arrangement.","summary":"Renegotiate the offer drawdown for the required customer.","tags":[],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"loanId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":null,"responses":{"200":"","default":"","400":"","500":""}},{"method":"POST","path":"/holdings/loans/{loanId}/drawdowns/cancellations","fullPath":"/api/v1.0.0/holdings/loans/{loanId}/drawdowns/cancellations","operationId":"cancelLoanDrawdownOffer","name":"Cancellation of offer drawdown for the required customer.","summary":"Cancellation of offer drawdown for the required customer.","tags":[],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"loanId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":null,"responses":{"200":"","default":"","400":"","500":""}},{"method":"POST","path":"/holdings/loans/{loanId}/drawdowns/acceptances/schedules","fullPath":"/api/v1.0.0/holdings/loans/{loanId}/drawdowns/acceptances/schedules","operationId":"createLoanDrawdownOfferAcceptanceSchedules","name":"Accept the offer drawdown for the retail loan and convert offer drawdown into a live loan arrangement and retrieve the payment schedule details.","summary":"Accept the offer drawdown for the retail loan and convert offer drawdown into a live loan arrangement and retrieve the payment schedule details.","tags":[],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"loanId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":null,"responses":{"200":"","default":"","400":"","500":""}},{"method":"POST","path":"/holdings/loans/{loanId}/drawdowns/renegotiations/schedules","fullPath":"/api/v1.0.0/holdings/loans/{loanId}/drawdowns/renegotiations/schedules","operationId":"createLoanDrawdownOfferRenegotiationSchedules","name":"Renegotiate the offer drawdown for the retail loan and convert offer drawdown into live loan arrangement and retrieve the payment schedule details.","summary":"Renegotiate the offer drawdown for the required customer and retrieve the payment schedule details.","tags":[],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"loanId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":null,"responses":{"200":"","default":"","400":"","500":""}},{"method":"PUT","path":"/holdings/loans/{LoanId}/settlements","fullPath":"/api/v1.0.0/holdings/loans/{LoanId}/settlements","operationId":"updateLoanSettlement","name":"Updates the settlement condition of the loan","summary":"Updates the settlement condition of the loan","tags":[],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"LoanId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":null,"responses":{"200":"","default":"","400":"","500":""}},{"method":"POST","path":"/holdings/loans/{loanId}/simulations/repayments","fullPath":"/api/v1.0.0/holdings/loans/{loanId}/simulations/repayments","operationId":"createRepaymentSimulation","name":"Simulate the pre payment of the given loan amount","summary":"Simulate  the loan pre payment","tags":[],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"loanId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":null,"responses":{"200":"","default":"","400":"","500":""}},{"method":"POST","path":"/holdings/loans/{loanId}/simulations/repayments/schedules","fullPath":"/api/v1.0.0/holdings/loans/{loanId}/simulations/repayments/schedules","operationId":"createRepaymentSchedule","name":"Simulate the pre payment of the given loan amount and retrieve the payment schedule","summary":"Simulate the pre payment of the given loan amount and retrieve the payment schedule","tags":[],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"loanId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":null,"responses":{"200":"","default":"","400":"","500":""}},{"method":"PUT","path":"/holdings/loans/{loanId}/repaymentDates","fullPath":"/api/v1.0.0/holdings/loans/{loanId}/repaymentDates","operationId":"updateRepaymentDate","name":"Perform repayment date change for the loan product with details like loan reference, product id , etc.","summary":"Perform repayment date change for the loan","tags":[],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"loanId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":null,"responses":{"200":"","default":"","400":"","500":""}},{"method":"PUT","path":"/holdings/loans/{loanId}/repaymentDates/schedules","fullPath":"/api/v1.0.0/holdings/loans/{loanId}/repaymentDates/schedules","operationId":"updateRepaymentDateAndSchedules","name":"Perform repayment date change for the loan product and retrieve the payment schedule , interest details etc.","summary":"Perform repayment date change for the loan and retrieve the payment schedule details.","tags":[],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"loanId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":null,"responses":{"200":"","default":"","400":"","500":""}},{"method":"POST","path":"/holdings/loans/{loanId}/simulations/repaymentDates","fullPath":"/api/v1.0.0/holdings/loans/{loanId}/simulations/repaymentDates","operationId":"createRepaymentDateChangeSimulation","name":"Simulate a loan arrangement for the given payment date","summary":"Simulate a loan arrangement for the given payment date","tags":[],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"loanId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":null,"responses":{"200":"","default":"","400":"","500":""}},{"method":"POST","path":"/holdings/loans/{loanId}/simulations/repaymentDates/schedules","fullPath":"/api/v1.0.0/holdings/loans/{loanId}/simulations/repaymentDates/schedules","operationId":"createRepaymentDateChangeSimulationSchedules","name":"Simulate a loan arrangement for the given payment date and retrieve the payments schedule , interest details etc.","summary":"Simulate a loan arrangement for the given payment date and retrieve the payments schedule details.","tags":[],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"loanId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":null,"responses":{"200":"","default":"","400":"","500":""}}]},{"key":"holdings-loans-arrangements-v6.2.0","title":"Loan creation","version":"v6.2.0","description":"API to create and Manage various types of loans such as Personal, Commercial, Mortgage, Line of Credit, etc","endpointCount":51,"endpoints":[{"method":"PUT","path":"/holdings/loans/{loanId}/writeOffs/balances","fullPath":"/api/v1.0.0/holdings/loans/{loanId}/writeOffs/balances","operationId":"initiateWriteOffBalanceLoans","name":"Perform a write off of the balances such as principal or interest or charge amount for the unpaid consumer loans","summary":"Perform a loan balance write off","tags":["RETAIL"],"parameters":[{"name":"loanId","in":"path","type":"string","required":true,"description":""},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"initiateWriteOffBalanceLoansResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse","default":"ArrangementErrorResponse"}},{"method":"PUT","path":"/holdings/loans/{loanId}/writeOffs","fullPath":"/api/v1.0.0/holdings/loans/{loanId}/writeOffs","operationId":"initiateWriteOffLoans","name":"Perform a write off of all the balances including principal , interest and charge amounts for the unpaid consumer loans","summary":"Perform a write off of all the balances for the unpaid consumer loans","tags":["RETAIL"],"parameters":[{"name":"loanId","in":"path","type":"string","required":true,"description":""},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"initiateWriteOffLoansResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse","default":"ArrangementErrorResponse"}},{"method":"PUT","path":"/holdings/loans/{loanId}/writeOffs/bills","fullPath":"/api/v1.0.0/holdings/loans/{loanId}/writeOffs/bills","operationId":"initiateWriteOffBillLoans","name":"Perform a write off of all the balances including principal , interest and charge amounts for the unpaid consumer loans","summary":"Perform a write off of all the balances for the unpaid consumer loans","tags":["RETAIL"],"parameters":[{"name":"loanId","in":"path","type":"string","required":true,"description":""},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"initiateWriteOffBillLoansResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse","default":"ArrangementErrorResponse"}},{"method":"POST","path":"/holdings/loans/personalLoans","fullPath":"/api/v1.0.0/holdings/loans/personalLoans","operationId":"createPersonalLoan","name":"Create a personal loan account","summary":"Create a personal loan account","tags":[],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"","default":"","400":"","500":""}},{"method":"POST","path":"/holdings/loans/linkedRateLoans","fullPath":"/api/v1.0.0/holdings/loans/linkedRateLoans","operationId":"createLinkedRateLoan","name":"Create a personal loan account with linked rate","summary":"Create a personal loan account with linked rate","tags":[],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"","default":"","400":"","500":""}},{"method":"POST","path":"/holdings/loans/commercialLoans","fullPath":"/api/v1.0.0/holdings/loans/commercialLoans","operationId":"createCommercialLoan","name":"Create a commercial or business account","summary":"Create a commercial or business account","tags":[],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"","default":"","400":"","500":""}},{"method":"POST","path":"/holdings/loans/mortgages","fullPath":"/api/v1.0.0/holdings/loans/mortgages","operationId":"createMortgage","name":"Create a mortgage loan","summary":"Create a mortgage loan","tags":[],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"","default":"","400":"","500":""}},{"method":"POST","path":"/holdings/loans/creditLines","fullPath":"/api/v1.0.0/holdings/loans/creditLines","operationId":"createCreditLine","name":"Create a lines of credit account","summary":"Create a lines of credit account","tags":[],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"","default":"","400":"","500":""}},{"method":"POST","path":"/holdings/facilities/installmentLoans","fullPath":"/api/v1.0.0/holdings/facilities/installmentLoans","operationId":"createInstallmentLoan","name":"Create an installment loan for the given product","summary":"Create an installment loan for the given product","tags":[],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"","default":"","400":"","500":""}},{"method":"POST","path":"/holdings/fundsTransfer","fullPath":"/api/v1.0.0/holdings/fundsTransfer","operationId":"createFundsTransfer","name":"Create an account transfer","summary":"Create an account transfer","tags":[],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"","default":"","400":"","500":""}},{"method":"POST","path":"/holdings/loans/consumerLoans","fullPath":"/api/v1.0.0/holdings/loans/consumerLoans","operationId":"createConsumerLoan","name":"creates a consumer loan for the given product","summary":"Initiates the creation of consumer loan for the given product","tags":["RETAIL"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"","default":"","400":"","500":""}},{"method":"PUT","path":"/holdings/loans/consumerLoans/{consumerLoanId}/disbursements","fullPath":"/api/v1.0.0/holdings/loans/consumerLoans/{consumerLoanId}/disbursements","operationId":"createConsumerLoanDisbursement","name":"Initiates the disbursement of the given consumer loan contracts commitment amount","summary":"Disburses the consumer loan commitment amount","tags":["RETAIL"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"consumerLoanId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":null,"responses":{"200":"","default":"","400":"","500":""}},{"method":"PUT","path":"/holdings/loans/consumerLoans/{consumerLoanId}/commitmentIncreases","fullPath":"/api/v1.0.0/holdings/loans/consumerLoans/{consumerLoanId}/commitmentIncreases","operationId":"updateConsumerLoanTopupAmount","name":"Increases the commitment amount of the consumer loan","summary":"Increases the commitment amount of the given consumer loan contract","tags":["RETAIL"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"consumerLoanId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":null,"responses":{"200":"","default":"","400":"","500":""}},{"method":"PUT","path":"/holdings/loans/consumerLoans/{consumerLoanId}/commitmentDecreases","fullPath":"/api/v1.0.0/holdings/loans/consumerLoans/{consumerLoanId}/commitmentDecreases","operationId":"updateConsumerLoanDecreaseAmount","name":"Decreases the commitment amount of the consumer loan","summary":"Decreases the commitment amount of the given consumer loan contract","tags":["RETAIL"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"consumerLoanId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":null,"responses":{"200":"","default":"","400":"","500":""}},{"method":"PUT","path":"/holdings/loans/consumerLoans/{consumerLoanId}/repayments","fullPath":"/api/v1.0.0/holdings/loans/consumerLoans/{consumerLoanId}/repayments","operationId":"createConsumerLoanRepayment","name":"Initiates the repayment of the given consumer loan amount","summary":"Repays the consumer loan amount","tags":["RETAIL"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"consumerLoanId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":null,"responses":{"200":"","default":"","400":"","500":""}},{"method":"PUT","path":"/holdings/loans/consumerLoans/{consumerLoanId}/principalDecreases","fullPath":"/api/v1.0.0/holdings/loans/consumerLoans/{consumerLoanId}/principalDecreases","operationId":"createConsumerLoanPrepayment","name":"Initiates the advance repayment of the given consumer loan amount","summary":"Prepays the consumer loan amount","tags":["RETAIL"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"consumerLoanId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":null,"responses":{"200":"","default":"","400":"","500":""}},{"method":"PUT","path":"/holdings/loans/consumerLoans/{consumerLoanId}/schedules","fullPath":"/api/v1.0.0/holdings/loans/consumerLoans/{consumerLoanId}/schedules","operationId":"updateConsumerLoanSchedule","name":"Initiates the change of payment schedule for the given consumer loan contract","summary":"Change payment schedule of the consumer loan","tags":["RETAIL"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"consumerLoanId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":null,"responses":{"200":"","default":"","400":"","500":""}},{"method":"PUT","path":"/holdings/loans/consumerLoans/{consumerLoanId}/paymentHolidays","fullPath":"/api/v1.0.0/holdings/loans/consumerLoans/{consumerLoanId}/paymentHolidays","operationId":"updateConsumerLoanHoliday","name":"Initiates the update of payment holiday for the given consumer loan contract","summary":"Update payment holiday for the consumer loan","tags":["RETAIL"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"consumerLoanId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":null,"responses":{"200":"","default":"","400":"","500":""}},{"method":"GET","path":"/holdings/loans/{loanId}/outstandingBills","fullPath":"/api/v1.0.0/holdings/loans/{loanId}/outstandingBills","operationId":"getLoanOutstandingBills","name":"Retrieves the outstanding amount to be paid for a loan","summary":"Retrieves the outstanding amount to be paid for the given loan","tags":["RETAIL"],"parameters":[{"name":"loanId","in":"path","type":"string","required":true,"description":"Denotes the arrangement id of the loan"},{"name":"fileVersion","in":"query","type":"string","required":false,"description":"Indicates if the file is of type simulation or live"},{"name":"simulationReference","in":"query","type":"string","required":false,"description":"Indicates the reference id for simulation activity"},{"name":"paymentDate","in":"query","type":"string","required":false,"description":"Contains the date in which the payment will be sent out. Date in the format YYYYMMDD. E.g. 20191231"},{"name":"deferDate","in":"query","type":"string","required":false,"description":"Date that the payment has been deferred to"},{"name":"billedAmount","in":"query","type":"string","required":false,"description":"Indicates the bill amount"},{"name":"outstandingAmount","in":"query","type":"string","required":false,"description":"Contains the aggregate outstanding principal amount thereof after giving effect to any borrowings and prepayments or repayments of Committed Loans"},{"name":"delinquentAmount","in":"query","type":"string","required":false,"description":"Indicates the bill amount during the ageing status(Bill which crossed the due date)"},{"name":"property","in":"query","type":"string","required":false,"description":"Id of the product property"},{"name":"billStatus","in":"query","type":"string","required":false,"description":"Indicates the status of a bill(Issued,Due,Ageing,Settled)"},{"name":"settlementStatus","in":"query","type":"string","required":false,"description":"Defines the status of the settlement for the incoming MT548 swift message.The values allowed are: Waiting : pending to receive settlement status update meaning pending to receive MT548 swift message, "},{"name":"agingStatus","in":"query","type":"string","required":false,"description":"Indicates the ageing status of a bill"},{"name":"settled","in":"query","type":"string","required":false,"description":"Flag to indicate whether a bill is settled or not"},{"name":"paymentType","in":"query","type":"string","required":false,"description":"Indicates if the payment is Customer (C) type or Bank (B) type"},{"name":"billDate","in":"query","type":"string","required":false,"description":"Indicates a date on which a bill has been raised"},{"name":"paymentMethod","in":"query","type":"string","required":false,"description":"Method chosen to make the payment"},{"name":"infoPayType","in":"query","type":"string","required":false,"description":"Indicates a bill which is raised when a loan is paid off"},{"name":"advancePayment","in":"query","type":"string","required":false,"description":"Indicates whether advance payment made is set on an account"},{"name":"paymentIndicator","in":"query","type":"string","required":false,"description":"Indicates whether its a credit/debit type of bill"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"","default":"","400":"","500":""}},{"method":"GET","path":"/holdings/loans/{loanId}/payoffCalculations","fullPath":"/api/v1.0.0/holdings/loans/{loanId}/payoffCalculations","operationId":"getLoanPayoffDetails","name":"Retrieves the payoff details of a loan","summary":"Retrieves the payoff details of the given loan","tags":["RETAIL"],"parameters":[{"name":"loanId","in":"path","type":"string","required":true,"description":"Denotes the arrangement id of the loan"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"","default":"","400":"","500":""}},{"method":"PUT","path":"/holdings/loans/consumerLoans/{consumerLoanId}/customers","fullPath":"/api/v1.0.0/holdings/loans/consumerLoans/{consumerLoanId}/customers","operationId":"updateConsumerLoansCustomer","name":"Initiates the change of customers for the given consumer loan contract","summary":"Changes the customers of the consumer loan ","tags":["RETAIL"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"consumerLoanId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":null,"responses":{"200":"","default":"","400":"","500":""}},{"method":"PUT","path":"/holdings/loans/consumerLoans/{consumerLoanId}/payoffs","fullPath":"/api/v1.0.0/holdings/loans/consumerLoans/{consumerLoanId}/payoffs","operationId":"createPayoffConsumerLoan","name":"Initiates the payoff of the given consumer loan contract amount","summary":"Payoffs the consumer loan amount","tags":["RETAIL"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"consumerLoanId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":null,"responses":{"200":"","default":"","400":"","500":""}},{"method":"PUT","path":"/holdings/loans/consumerLoans/{consumerLoanId}/renegotiations","fullPath":"/api/v1.0.0/holdings/loans/consumerLoans/{consumerLoanId}/renegotiations","operationId":"updateConsumerLoanConditions","name":"Initiates the renegotiation of the given consumer loan contract details","summary":"Renegotiates the consumer loan contract details","tags":["RETAIL"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"consumerLoanId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":null,"responses":{"200":"","default":"","400":"","500":""}},{"method":"GET","path":"/holdings/loans/{loanId}/status","fullPath":"/api/v1.0.0/holdings/loans/{loanId}/status","operationId":"getArrangementDetails","name":"Retrieves the status of a loan","summary":"Retrieves the status of the given loan","tags":["RETAIL"],"parameters":[{"name":"loanId","in":"path","type":"string","required":true,"description":"Denotes the arrangement id of the loan"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"","default":"","400":"","500":""}},{"method":"GET","path":"/holdings/loans/arrangements/activities/{arrangementActivityId}/status","fullPath":"/api/v1.0.0/holdings/loans/arrangements/activities/{arrangementActivityId}/status","operationId":"getExternalEventStatus","name":"Retrieves the status of the given activity ","summary":"Retrieves the status of the given activity ","tags":["RETAIL"],"parameters":[{"name":"arrangementActivityId","in":"path","type":"string","required":true,"description":"Contains the arrangement activity reference identifier"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"","default":"","400":"","500":""}},{"method":"PUT","path":"/holdings/loans/consumerLoans/{consumerLoanId}/payoffCalculations","fullPath":"/api/v1.0.0/holdings/loans/consumerLoans/{consumerLoanId}/payoffCalculations","operationId":"calculatePayoffConsumerLoans","name":"Initiates calculate pyoff activity to calculate consumer loan payment amount to close the given loan","summary":"Calculates consumer loan payment amount to close a loan","tags":["RETAIL"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"consumerLoanId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":null,"responses":{"200":"","default":"","400":"","500":""}},{"method":"GET","path":"/holdings/loans/{loanId}/schedules","fullPath":"/api/v1.0.0/holdings/loans/{loanId}/schedules","operationId":"getPaymentSchedulesProjection","name":"Retrieves the schedule payment information for paid and upcoming installments details","summary":"Retrieves payment schedules details","tags":["RETAIL"],"parameters":[{"name":"loanId","in":"path","type":"string","required":true,"description":"Denotes the arrangement id of the loan"},{"name":"dateFrom","in":"query","type":"string","required":false,"description":"Start date of the loan"},{"name":"dateTo","in":"query","type":"string","required":false,"description":"End date of the loan"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"","default":"","400":"","500":""}},{"method":"GET","path":"/holdings/loans/{loanId}/loanDetails","fullPath":"/api/v1.0.0/holdings/loans/{loanId}/loanDetails","operationId":"getLoanOverview","name":"Retrieves the details of the given loan","summary":"Retrieves loan details ","tags":["RETAIL"],"parameters":[{"name":"loanId","in":"path","type":"string","required":true,"description":"Denotes the arrangement id of the loan"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"","default":"","400":"","500":""}},{"method":"GET","path":"/holdings/loans/{loanId}/bills","fullPath":"/api/v1.0.0/holdings/loans/{loanId}/bills","operationId":"getLoanBills","name":"Retrieves the simulation details of the contract based on the selection criteria. It returns the bill details of the loan","summary":"Retrieves loan bills details","tags":[],"parameters":[{"name":"loanId","in":"path","type":"string","required":true,"description":"Denotes the arrangement id of the loan"},{"name":"billType","in":"query","type":"string","required":false,"description":"The type of payment obligation generated"},{"name":"paymentDate","in":"query","type":"string","required":false,"description":"Contains the date in which the payment will be sent out. Date in the format YYYYMMDD. E.g. 20191231"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"","default":"","400":"","500":""}},{"method":"GET","path":"/holdings/loans/{loanId}/collaterals","fullPath":"/api/v1.0.0/holdings/loans/{loanId}/collaterals","operationId":"getLoanCollaterals","name":"Retrieves the collateral details linked to the loan arrangement. The collateral right and status have to be passed within the api","summary":"Retrieves loan collateral details","tags":[],"parameters":[{"name":"loanId","in":"path","type":"string","required":true,"description":"Denotes the arrangement id of the loan"},{"name":"status","in":"query","type":"string","required":false,"description":"Contains status of the data rights request.Allowed values are INITIATED, INPROGESS, EXTENDED, COMPLETED, REJECTED."},{"name":"statusNE","in":"query","type":"string","required":false,"description":"Status not equal to"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"","default":"","400":"","500":""}},{"method":"GET","path":"/holdings/loans/{loanId}","fullPath":"/api/v1.0.0/holdings/loans/{loanId}","operationId":"getLoanDetails","name":"Retrieves loan details","summary":"Retrieves the loan account details","tags":[],"parameters":[{"name":"loanId","in":"path","type":"string","required":true,"description":"Denotes the arrangement id of the loan"},{"name":"dateFrom","in":"query","type":"string","required":false,"description":"Start date of the loan"},{"name":"dateTo","in":"query","type":"string","required":false,"description":"End date of the loan"},{"name":"balanceTypes","in":"query","type":"string","required":false,"description":"Type of balance (e.g. current balance, credit interest accrued, deferred commission, etc.) as defined in the institution's accounting schemas."},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"","default":"","400":"","500":""}},{"method":"GET","path":"/holdings/loans/{loanId}/schedulePaymentFrequencies","fullPath":"/api/v1.0.0/holdings/loans/{loanId}/schedulePaymentFrequencies","operationId":"getPaymentSchedules","name":"Retrieves the schedule payment information for paid and upcoming installments details","summary":"Retrieves payment schedules details","tags":[],"parameters":[{"name":"loanId","in":"path","type":"string","required":true,"description":"Denotes the arrangement id of the loan"},{"name":"dateFrom","in":"query","type":"string","required":false,"description":"Start date of the loan"},{"name":"dateTo","in":"query","type":"string","required":false,"description":"End date of the loan"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"","default":"","400":"","500":""}},{"method":"POST","path":"/holdings/simulationCapture/{arrangementId}","fullPath":"/api/v1.0.0/holdings/simulationCapture/{arrangementId}","operationId":"createSimulationCapture","name":"Simulate payoff calculate activity for a loan arrangement","summary":"Simulate payoff calculate activity for a loan arrangement","tags":[],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"arrangementId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":null,"responses":{"200":"","default":"","400":"","500":""}},{"method":"POST","path":"/holdings/loans/simulations","fullPath":"/api/v1.0.0/holdings/loans/simulations","operationId":"createLoanSimulation","name":"Create a simulation for loan product with details like customer identifier, currency, etc.","summary":"Create simulation for loan products","tags":["RETAIL"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"","default":"","400":"","500":""}},{"method":"PUT","path":"/holdings/loans/simulations/{simulationId}","fullPath":"/api/v1.0.0/holdings/loans/simulations/{simulationId}","operationId":"updateLoanSimulation","name":"Update a simulation for loan product with details like customer identifier, currency, etc.","summary":"Update a simulation for loan products","tags":["RETAIL"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"simulationId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":null,"responses":{"200":"","default":"","400":"","500":""}},{"method":"POST","path":"/holdings/loans/{loanId}/simulations/payoffs","fullPath":"/api/v1.0.0/holdings/loans/{loanId}/simulations/payoffs","operationId":"createLoanPayoffSimulation","name":"Create a simulation payoff activity for loan product with product id details","summary":"Create simulation payoff activity for loan products","tags":["RETAIL"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"loanId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":null,"responses":{"200":"","default":"","400":"","500":""}},{"method":"POST","path":"/holdings/loans/{loanId}/payoffs","fullPath":"/api/v1.0.0/holdings/loans/{loanId}/payoffs","operationId":"createLoanArrangementPayoff","name":"Execute payoff activity for loan product with details like simulation run reference, product id , etc.","summary":"Execute payoff activity for loan products","tags":["RETAIL"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"loanId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":null,"responses":{"200":"","default":"","400":"","500":""}},{"method":"GET","path":"/holdings/loans/{loanId}/overpayments","fullPath":"/api/v1.0.0/holdings/loans/{loanId}/overpayments","operationId":"getOverpaymentDetails","name":"Retrieves the product id, type of overpay, overpay limit, overpay period, utilised overpay and remaining overpay limit of a loan arrangement","summary":"Retrieves overpayment details that has happened for a loan arrangement","tags":["RETAIL"],"parameters":[{"name":"loanId","in":"path","type":"string","required":true,"description":"Denotes the arrangement id of the loan"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"","default":"","400":"","500":""}},{"method":"POST","path":"/holdings/loans/drawdowns/offers","fullPath":"/api/v1.0.0/holdings/loans/drawdowns/offers","operationId":"createLoanDrawdownOffer","name":"Creates a new drawdown offer for the required customer.","summary":"Creates a new drawdown offer for the required customer.","tags":[],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"","default":"","400":"","500":""}},{"method":"POST","path":"/holdings/loans/{loanId}/drawdowns/acceptances","fullPath":"/api/v1.0.0/holdings/loans/{loanId}/drawdowns/acceptances","operationId":"createLoanDrawdownOfferAcceptance","name":"Accept the offer drawdown for the retail loan and convert offer drawdown into a live loan arrangement.","summary":"Accept the offer drawdown for the retail loan and convert offer drawdown into a live loan arrangement.","tags":[],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"loanId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":null,"responses":{"200":"","default":"","400":"","500":""}},{"method":"POST","path":"/holdings/loans/{loanId}/drawdowns/renegotiations","fullPath":"/api/v1.0.0/holdings/loans/{loanId}/drawdowns/renegotiations","operationId":"createLoanDrawdownOfferRenegotiation","name":"Renegotiate the offer drawdown for the retail loan and convert offer drawdown into live loan arrangement.","summary":"Renegotiate the offer drawdown for the required customer.","tags":[],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"loanId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":null,"responses":{"200":"","default":"","400":"","500":""}},{"method":"POST","path":"/holdings/loans/{loanId}/drawdowns/cancellations","fullPath":"/api/v1.0.0/holdings/loans/{loanId}/drawdowns/cancellations","operationId":"cancelLoanDrawdownOffer","name":"Cancellation of offer drawdown for the required customer.","summary":"Cancellation of offer drawdown for the required customer.","tags":[],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"loanId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":null,"responses":{"200":"","default":"","400":"","500":""}},{"method":"POST","path":"/holdings/loans/{loanId}/drawdowns/acceptances/schedules","fullPath":"/api/v1.0.0/holdings/loans/{loanId}/drawdowns/acceptances/schedules","operationId":"createLoanDrawdownOfferAcceptanceSchedules","name":"Accept the offer drawdown for the retail loan and convert offer drawdown into a live loan arrangement and retrieve the payment schedule details.","summary":"Accept the offer drawdown for the retail loan and convert offer drawdown into a live loan arrangement and retrieve the payment schedule details.","tags":[],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"loanId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":null,"responses":{"200":"","default":"","400":"","500":""}},{"method":"POST","path":"/holdings/loans/{loanId}/drawdowns/renegotiations/schedules","fullPath":"/api/v1.0.0/holdings/loans/{loanId}/drawdowns/renegotiations/schedules","operationId":"createLoanDrawdownOfferRenegotiationSchedules","name":"Renegotiate the offer drawdown for the retail loan and convert offer drawdown into live loan arrangement and retrieve the payment schedule details.","summary":"Renegotiate the offer drawdown for the required customer and retrieve the payment schedule details.","tags":[],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"loanId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":null,"responses":{"200":"","default":"","400":"","500":""}},{"method":"PUT","path":"/holdings/loans/{LoanId}/settlements","fullPath":"/api/v1.0.0/holdings/loans/{LoanId}/settlements","operationId":"updateLoanSettlement","name":"Updates the settlement condition of the Loan","summary":"Updates the settlement condition of the Loan","tags":[],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"LoanId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":null,"responses":{"200":"","default":"","400":"","500":""}},{"method":"POST","path":"/holdings/loans/{loanId}/simulations/repayments","fullPath":"/api/v1.0.0/holdings/loans/{loanId}/simulations/repayments","operationId":"createRepaymentSimulation","name":"Simulate the pre payment of the given loan amount","summary":"Simulate  the loan pre payment","tags":[],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"loanId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":null,"responses":{"200":"","default":"","400":"","500":""}},{"method":"POST","path":"/holdings/loans/{loanId}/simulations/repayments/schedules","fullPath":"/api/v1.0.0/holdings/loans/{loanId}/simulations/repayments/schedules","operationId":"createRepaymentSchedule","name":"Simulate the pre payment of the given loan amount and retrieve the payment schedule","summary":"Simulate the pre payment of the given loan amount and retrieve the payment schedule","tags":[],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"loanId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":null,"responses":{"200":"","default":"","400":"","500":""}},{"method":"PUT","path":"/holdings/loans/{loanId}/repaymentDates","fullPath":"/api/v1.0.0/holdings/loans/{loanId}/repaymentDates","operationId":"updateRepaymentDate","name":"Perform repayment date change for the loan product with details like loan reference, product id , etc.","summary":"Perform repayment date change for the loan","tags":[],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"loanId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":null,"responses":{"200":"","default":"","400":"","500":""}},{"method":"PUT","path":"/holdings/loans/{loanId}/repaymentDates/schedules","fullPath":"/api/v1.0.0/holdings/loans/{loanId}/repaymentDates/schedules","operationId":"updateRepaymentDateAndSchedules","name":"Perform repayment date change for the loan product and retrieve the payment schedule , interest details etc.","summary":"Perform repayment date change for the loan and retrieve the payment schedule details.","tags":[],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"loanId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":null,"responses":{"200":"","default":"","400":"","500":""}},{"method":"POST","path":"/holdings/loans/{loanId}/simulations/repaymentDates","fullPath":"/api/v1.0.0/holdings/loans/{loanId}/simulations/repaymentDates","operationId":"createRepaymentDateChangeSimulation","name":"Simulate a loan arrangement for the given payment date","summary":"Simulate a loan arrangement for the given payment date","tags":[],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"loanId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":null,"responses":{"200":"","default":"","400":"","500":""}},{"method":"POST","path":"/holdings/loans/{loanId}/simulations/repaymentDates/schedules","fullPath":"/api/v1.0.0/holdings/loans/{loanId}/simulations/repaymentDates/schedules","operationId":"createRepaymentDateChangeSimulationSchedules","name":"Simulate a loan arrangement for the given payment date and retrieve the payments schedule , interest details etc.","summary":"Simulate a loan arrangement for the given payment date and retrieve the payments schedule details.","tags":[],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"loanId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":null,"responses":{"200":"","default":"","400":"","500":""}}]},{"key":"holdings-loans-arrangements-v6.3.0","title":"Loan creation","version":"v6.3.0","description":"API to create and manage various types of loans such as personal, commercial, mortgage, line of credit, etc","endpointCount":62,"endpoints":[{"method":"POST","path":"/holdings/loans/creditLines","fullPath":"/api/v1.0.0/holdings/loans/creditLines","operationId":"createlineOfCredit","name":"Create a lines of credit account","summary":"Create a lines of credit account","tags":["RETAIL"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"createlineOfCreditResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse","default":"ArrangementErrorResponse"}},{"method":"POST","path":"/holdings/loans","fullPath":"/api/v1.0.0/holdings/loans","operationId":"createLoans","name":"Creates a loan for the given product","summary":"Creates a loan for the given product","tags":["RETAIL"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"createloansResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse","default":"ArrangementErrorResponse"}},{"method":"POST","path":"/holdings/loans/vehicleLoans","fullPath":"/api/v1.0.0/holdings/loans/vehicleLoans","operationId":"createvehicleLoan","name":"creates a vehicle loan for the given product","summary":"Creates a vehicle loan for the given product","tags":["RETAIL"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"createvehicleLoanResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse","default":"ArrangementErrorResponse"}},{"method":"POST","path":"/holdings/loans/personalLoans","fullPath":"/api/v1.0.0/holdings/loans/personalLoans","operationId":"createPersonalLoan","name":"Create a personal loan account","summary":"Create a personal loan account","tags":[],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"","default":"","400":"","500":""}},{"method":"POST","path":"/holdings/loans/consumerLoans","fullPath":"/api/v1.0.0/holdings/loans/consumerLoans","operationId":"createConsumerLoan","name":"creates a consumer loan for the given product","summary":"Creates a consumer loan for the given product","tags":["RETAIL"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"createConsumerLoanResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse","default":"ArrangementErrorResponse"}},{"method":"POST","path":"/holdings/loans/{loanId}/simulations/paymentHolidays","fullPath":"/api/v1.0.0/holdings/loans/{loanId}/simulations/paymentHolidays","operationId":"simulatePaymentHoliday","name":"Simulate payment holiday activity for a loan account","summary":"Simulate payment holiday activity for a loan account","tags":["RETAIL"],"parameters":[{"name":"loanId","in":"path","type":"string","required":true,"description":""},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"simulatePaymentHolidayResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse","default":"ArrangementErrorResponse"}},{"method":"PUT","path":"/holdings/loans/{loanId}/renegotiations","fullPath":"/api/v1.0.0/holdings/loans/{loanId}/renegotiations","operationId":"updateLoanConditions","name":"Perform the renegotiation of the loan contract details such as payment frequency, interest rates, etc.","summary":"Perform the renegotiation of the loan contract details","tags":["RETAIL"],"parameters":[{"name":"loanId","in":"path","type":"string","required":true,"description":""},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"updateLoanConditionsResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse","default":"ArrangementErrorResponse"}},{"method":"PUT","path":"/holdings/loans/{loanId}/accounts","fullPath":"/api/v1.0.0/holdings/loans/{loanId}/accounts","operationId":"updateLoanAccount","name":"Update the account conditions of the loan such as alternate references, posting restrictions, etc","summary":"Update the account conditions of the loan","tags":["RETAIL"],"parameters":[{"name":"loanId","in":"path","type":"string","required":true,"description":""},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"updateLoanAccountResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse","default":"ArrangementErrorResponse"}},{"method":"PUT","path":"/holdings/loans/{loanId}/interestConditions","fullPath":"/api/v1.0.0/holdings/loans/{loanId}/interestConditions","operationId":"updateLoanInterest","name":"Update the interest conditions of the loan such as interest rate, spread, margin etc","summary":"Update the interest conditions of the loan","tags":["RETAIL"],"parameters":[{"name":"loanId","in":"path","type":"string","required":true,"description":""},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"updateLoanInterestResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse","default":"ArrangementErrorResponse"}},{"method":"PUT","path":"/holdings/loans/{loanId}/chargeOffs","fullPath":"/api/v1.0.0/holdings/loans/{loanId}/chargeOffs","operationId":"createChargeOffActivity","name":"Execute loan charge-off activity to charge-off account balance only","summary":"Execute loan charge-off activity to charge-off account balance only","tags":["RETAIL"],"parameters":[{"name":"loanId","in":"path","type":"string","required":true,"description":""},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"createChargeOffActivityResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse","default":"ArrangementErrorResponse"}},{"method":"PUT","path":"/holdings/loans/{loanId}/disbursements","fullPath":"/api/v1.0.0/holdings/loans/{loanId}/disbursements","operationId":"createLoanDisbursement","name":"Creates a disbursement of the given loan contracts commitment amount","summary":"Disburses the loan commitment amount","tags":["RETAIL"],"parameters":[{"name":"loanId","in":"path","type":"string","required":true,"description":""},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"createLoanDisbursementResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse","default":"ArrangementErrorResponse"}},{"method":"PUT","path":"/holdings/loans/{loanId}/customers","fullPath":"/api/v1.0.0/holdings/loans/{loanId}/customers","operationId":"updateLoansCustomer","name":"Updates the customer for the given loan contract","summary":"Updates the customer for the given loan contract","tags":["RETAIL"],"parameters":[{"name":"loanId","in":"path","type":"string","required":true,"description":""},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"updateLoansCustomerResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse","default":"ArrangementErrorResponse"}},{"method":"PUT","path":"/holdings/loans/{loanId}/commitmentIncreases","fullPath":"/api/v1.0.0/holdings/loans/{loanId}/commitmentIncreases","operationId":"updateLoanTopupAmount","name":"Increases the commitment amount of the loan","summary":"Increases the commitment amount of the given loan contract","tags":["RETAIL"],"parameters":[{"name":"loanId","in":"path","type":"string","required":true,"description":""},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"updateLoanTopupAmountResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse","default":"ArrangementErrorResponse"}},{"method":"PUT","path":"/holdings/loans/{loanId}/commitmentDecreases","fullPath":"/api/v1.0.0/holdings/loans/{loanId}/commitmentDecreases","operationId":"updateLoanDecreaseAmount","name":"Decreases the commitment amount of the loan","summary":"Decreases the commitment amount of the given loan contract","tags":["RETAIL"],"parameters":[{"name":"loanId","in":"path","type":"string","required":true,"description":""},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"updateLoanDecreaseAmountResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse","default":"ArrangementErrorResponse"}},{"method":"PUT","path":"/holdings/loans/{loanId}/repaymentDates","fullPath":"/api/v1.0.0/holdings/loans/{loanId}/repaymentDates","operationId":"updateRepaymentDate","name":"Perform repayment date change for the loan product with details like loan reference, product id , etc.","summary":"Perform repayment date change for the loan","tags":["RETAIL"],"parameters":[{"name":"loanId","in":"path","type":"string","required":true,"description":""},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"updateRepaymentDateResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse","default":"ArrangementErrorResponse"}},{"method":"PUT","path":"/holdings/loans/{loanId}/writeOffs/balances","fullPath":"/api/v1.0.0/holdings/loans/{loanId}/writeOffs/balances","operationId":"initiateWriteOffBalanceLoans","name":"Perform a write off of the balances such as principal or interest or charge amount for the unpaid consumer loans","summary":"Perform a loan balance write off","tags":["RETAIL"],"parameters":[{"name":"loanId","in":"path","type":"string","required":true,"description":""},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"initiateWriteOffBalanceLoansResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse","default":"ArrangementErrorResponse"}},{"method":"PUT","path":"/holdings/loans/{loanId}/writeOffs","fullPath":"/api/v1.0.0/holdings/loans/{loanId}/writeOffs","operationId":"initiateWriteOffLoans","name":"Perform a write off of all the balances including principal , interest and charge amounts for the unpaid consumer loans","summary":"Perform a write off of all the balances for the unpaid consumer loans","tags":["RETAIL"],"parameters":[{"name":"loanId","in":"path","type":"string","required":true,"description":""},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"initiateWriteOffLoansResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse","default":"ArrangementErrorResponse"}},{"method":"PUT","path":"/holdings/loans/{loanId}/writeOffs/bills","fullPath":"/api/v1.0.0/holdings/loans/{loanId}/writeOffs/bills","operationId":"initiateWriteOffBillLoans","name":"Perform a write off of all the balances including principal , interest and charge amounts for the unpaid consumer loans","summary":"Perform a write off of all the balances for the unpaid consumer loans","tags":["RETAIL"],"parameters":[{"name":"loanId","in":"path","type":"string","required":true,"description":""},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"initiateWriteOffBillLoansResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse","default":"ArrangementErrorResponse"}},{"method":"POST","path":"/holdings/loans/linkedRateLoans","fullPath":"/api/v1.0.0/holdings/loans/linkedRateLoans","operationId":"createLinkedRateLoan","name":"Create a personal loan account with linked rate","summary":"Create a personal loan account with linked rate","tags":[],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"","default":"","400":"","500":""}},{"method":"POST","path":"/holdings/loans/commercialLoans","fullPath":"/api/v1.0.0/holdings/loans/commercialLoans","operationId":"createCommercialLoan","name":"Create a commercial or business account","summary":"Create a commercial or business account","tags":[],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"","default":"","400":"","500":""}},{"method":"POST","path":"/holdings/loans/mortgages","fullPath":"/api/v1.0.0/holdings/loans/mortgages","operationId":"createMortgage","name":"Create a mortgage loan","summary":"Create a mortgage loan","tags":[],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"","default":"","400":"","500":""}},{"method":"POST","path":"/holdings/facilities/installmentLoans","fullPath":"/api/v1.0.0/holdings/facilities/installmentLoans","operationId":"createInstallmentLoan","name":"Create an installment loan for the given product","summary":"Create an installment loan for the given product","tags":[],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"","default":"","400":"","500":""}},{"method":"POST","path":"/holdings/fundsTransfer","fullPath":"/api/v1.0.0/holdings/fundsTransfer","operationId":"createFundsTransfer","name":"Create an account transfer","summary":"Create an account transfer","tags":[],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"","default":"","400":"","500":""}},{"method":"PUT","path":"/holdings/loans/consumerLoans/{consumerLoanId}/disbursements","fullPath":"/api/v1.0.0/holdings/loans/consumerLoans/{consumerLoanId}/disbursements","operationId":"createConsumerLoanDisbursement","name":"Creates a disbursement of the given consumer loan contracts commitment amount","summary":"Disburses the consumer loan commitment amount","tags":["RETAIL"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"consumerLoanId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":null,"responses":{"200":"","default":"","400":"","500":""}},{"method":"PUT","path":"/holdings/loans/consumerLoans/{consumerLoanId}/commitmentIncreases","fullPath":"/api/v1.0.0/holdings/loans/consumerLoans/{consumerLoanId}/commitmentIncreases","operationId":"updateConsumerLoanTopupAmount","name":"Increases the commitment amount of the consumer loan","summary":"Increases the commitment amount of the given consumer loan contract","tags":["RETAIL"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"consumerLoanId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":null,"responses":{"200":"","default":"","400":"","500":""}},{"method":"PUT","path":"/holdings/loans/consumerLoans/{consumerLoanId}/commitmentDecreases","fullPath":"/api/v1.0.0/holdings/loans/consumerLoans/{consumerLoanId}/commitmentDecreases","operationId":"updateConsumerLoanDecreaseAmount","name":"Decreases the commitment amount of the consumer loan","summary":"Decreases the commitment amount of the given consumer loan contract","tags":["RETAIL"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"consumerLoanId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":null,"responses":{"200":"","default":"","400":"","500":""}},{"method":"PUT","path":"/holdings/loans/consumerLoans/{consumerLoanId}/repayments","fullPath":"/api/v1.0.0/holdings/loans/consumerLoans/{consumerLoanId}/repayments","operationId":"createConsumerLoanRepayment","name":"Creates the repayment of the given consumer loan amount","summary":"Repays the consumer loan amount","tags":["RETAIL"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"consumerLoanId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":null,"responses":{"200":"","default":"","400":"","500":""}},{"method":"PUT","path":"/holdings/loans/consumerLoans/{consumerLoanId}/principalDecreases","fullPath":"/api/v1.0.0/holdings/loans/consumerLoans/{consumerLoanId}/principalDecreases","operationId":"createConsumerLoanPrepayment","name":"Creates the advance repayment of the given consumer loan amount","summary":"Prepays the consumer loan amount","tags":["RETAIL"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"consumerLoanId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":null,"responses":{"200":"","default":"","400":"","500":""}},{"method":"PUT","path":"/holdings/loans/consumerLoans/{consumerLoanId}/schedules","fullPath":"/api/v1.0.0/holdings/loans/consumerLoans/{consumerLoanId}/schedules","operationId":"updateConsumerLoanSchedule","name":"Update the change of payment schedule for the given consumer loan contract","summary":"Update the payment schedule of the consumer loan","tags":["RETAIL"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"consumerLoanId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":null,"responses":{"200":"","default":"","400":"","500":""}},{"method":"PUT","path":"/holdings/loans/consumerLoans/{consumerLoanId}/paymentHolidays","fullPath":"/api/v1.0.0/holdings/loans/consumerLoans/{consumerLoanId}/paymentHolidays","operationId":"updateConsumerLoanHoliday","name":"Update of payment holiday for the given consumer loan contract","summary":"Update payment holiday for the consumer loan","tags":["RETAIL"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"consumerLoanId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":null,"responses":{"200":"","default":"","400":"","500":""}},{"method":"GET","path":"/holdings/loans/{loanId}/outstandingBills","fullPath":"/api/v1.0.0/holdings/loans/{loanId}/outstandingBills","operationId":"getLoanOutstandingBills","name":"Retrieves the outstanding amount to be paid for a loan","summary":"Retrieves the outstanding amount to be paid for the given loan","tags":["RETAIL"],"parameters":[{"name":"loanId","in":"path","type":"string","required":true,"description":"Denotes the arrangement id of the loan"},{"name":"fileVersion","in":"query","type":"string","required":false,"description":"Indicates if the file is of type simulation or live"},{"name":"simulationReference","in":"query","type":"string","required":false,"description":"Indicates the reference id for simulation activity"},{"name":"paymentDate","in":"query","type":"string","required":false,"description":"Contains the date in which the payment will be sent out. Date in the format YYYYMMDD. E.g. 20191231"},{"name":"deferDate","in":"query","type":"string","required":false,"description":"Date that the payment has been deferred to"},{"name":"billedAmount","in":"query","type":"string","required":false,"description":"Indicates the bill amount"},{"name":"outstandingAmount","in":"query","type":"string","required":false,"description":"Contains the aggregate outstanding principal amount thereof after giving effect to any borrowings and prepayments or repayments of Committed Loans"},{"name":"delinquentAmount","in":"query","type":"string","required":false,"description":"Indicates the bill amount during the ageing status(Bill which crossed the due date)"},{"name":"property","in":"query","type":"string","required":false,"description":"Id of the product property"},{"name":"billStatus","in":"query","type":"string","required":false,"description":"Indicates the status of a bill(Issued,Due,Ageing,Settled)"},{"name":"settlementStatus","in":"query","type":"string","required":false,"description":"Defines the status of the settlement for the incoming MT548 swift message.The values allowed are: Waiting : pending to receive settlement status update meaning pending to receive MT548 swift message, "},{"name":"agingStatus","in":"query","type":"string","required":false,"description":"Indicates the ageing status of a bill"},{"name":"settled","in":"query","type":"string","required":false,"description":"Flag to indicate whether a bill is settled or not"},{"name":"paymentType","in":"query","type":"string","required":false,"description":"Indicates if the payment is Customer (C) type or Bank (B) type"},{"name":"billDate","in":"query","type":"string","required":false,"description":"Indicates a date on which a bill has been raised"},{"name":"paymentMethod","in":"query","type":"string","required":false,"description":"Method chosen to make the payment"},{"name":"infoPayType","in":"query","type":"string","required":false,"description":"Indicates a bill which is raised when a loan is paid off"},{"name":"advancePayment","in":"query","type":"string","required":false,"description":"Indicates whether advance payment made is set on an account"},{"name":"paymentIndicator","in":"query","type":"string","required":false,"description":"Indicates whether its a credit/debit type of bill"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"","default":"","400":"","500":""}},{"method":"GET","path":"/holdings/loans/{loanId}/payoffCalculations","fullPath":"/api/v1.0.0/holdings/loans/{loanId}/payoffCalculations","operationId":"getLoanPayoffDetails","name":"Retrieves the payoff details of a loan","summary":"Retrieves the payoff details of the given loan","tags":["RETAIL"],"parameters":[{"name":"loanId","in":"path","type":"string","required":true,"description":"Denotes the arrangement id of the loan"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"","default":"","400":"","500":""}},{"method":"PUT","path":"/holdings/loans/consumerLoans/{consumerLoanId}/customers","fullPath":"/api/v1.0.0/holdings/loans/consumerLoans/{consumerLoanId}/customers","operationId":"updateConsumerLoansCustomer","name":"Updates the customers for the given consumer loan contract","summary":"Update the customers of the consumer loan ","tags":["RETAIL"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"consumerLoanId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":null,"responses":{"200":"","default":"","400":"","500":""}},{"method":"PUT","path":"/holdings/loans/consumerLoans/{consumerLoanId}/payoffs","fullPath":"/api/v1.0.0/holdings/loans/consumerLoans/{consumerLoanId}/payoffs","operationId":"createPayoffConsumerLoan","name":"Creates the payoff of the given consumer loan contract amount","summary":"Payoffs the consumer loan amount","tags":["RETAIL"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"consumerLoanId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":null,"responses":{"200":"","default":"","400":"","500":""}},{"method":"PUT","path":"/holdings/loans/consumerLoans/{consumerLoanId}/renegotiations","fullPath":"/api/v1.0.0/holdings/loans/consumerLoans/{consumerLoanId}/renegotiations","operationId":"updateConsumerLoanConditions","name":"Creates the renegotiation of the given consumer loan contract details","summary":"Renegotiates the consumer loan contract details","tags":["RETAIL"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"consumerLoanId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":null,"responses":{"200":"","default":"","400":"","500":""}},{"method":"GET","path":"/holdings/loans/{loanId}/status","fullPath":"/api/v1.0.0/holdings/loans/{loanId}/status","operationId":"getArrangementDetails","name":"Retrieves the status of a loan","summary":"Retrieves the status of the given loan","tags":["RETAIL"],"parameters":[{"name":"loanId","in":"path","type":"string","required":true,"description":"Denotes the arrangement id of the loan"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"","default":"","400":"","500":""}},{"method":"GET","path":"/holdings/loans/arrangements/activities/{arrangementActivityId}/status","fullPath":"/api/v1.0.0/holdings/loans/arrangements/activities/{arrangementActivityId}/status","operationId":"getExternalEventStatus","name":"Retrieves the status of the given activity ","summary":"Retrieves the status of the given activity ","tags":["RETAIL"],"parameters":[{"name":"arrangementActivityId","in":"path","type":"string","required":true,"description":"Contains the arrangement activity reference identifier"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"","default":"","400":"","500":""}},{"method":"PUT","path":"/holdings/loans/consumerLoans/{consumerLoanId}/payoffCalculations","fullPath":"/api/v1.0.0/holdings/loans/consumerLoans/{consumerLoanId}/payoffCalculations","operationId":"calculatePayoffConsumerLoans","name":"Creates calculates payoff activity to calculate consumer loan payment amount to close the given loan","summary":"Calculates consumer loan payment amount to close a loan","tags":["RETAIL"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"consumerLoanId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":null,"responses":{"200":"","default":"","400":"","500":""}},{"method":"GET","path":"/holdings/loans/{loanId}/schedules","fullPath":"/api/v1.0.0/holdings/loans/{loanId}/schedules","operationId":"getPaymentSchedulesProjection","name":"Retrieves the schedule payment information for paid and upcoming installments details","summary":"Retrieves payment schedules details","tags":["RETAIL"],"parameters":[{"name":"loanId","in":"path","type":"string","required":true,"description":"Denotes the arrangement id of the loan"},{"name":"dateFrom","in":"query","type":"string","required":false,"description":"Start date of the loan"},{"name":"dateTo","in":"query","type":"string","required":false,"description":"End date of the loan"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"","default":"","400":"","500":""}},{"method":"GET","path":"/holdings/loans/{loanId}/loanDetails","fullPath":"/api/v1.0.0/holdings/loans/{loanId}/loanDetails","operationId":"getLoanOverview","name":"Retrieves the details of the given loan","summary":"Retrieves loan details ","tags":["RETAIL"],"parameters":[{"name":"loanId","in":"path","type":"string","required":true,"description":"Denotes the arrangement id of the loan"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"","default":"","400":"","500":""}},{"method":"GET","path":"/holdings/loans/{loanId}/bills","fullPath":"/api/v1.0.0/holdings/loans/{loanId}/bills","operationId":"getLoanBills","name":"Retrieves the simulation details of the contract based on the selection criteria. It returns the bill details of the loan","summary":"Retrieves loan bills details","tags":[],"parameters":[{"name":"loanId","in":"path","type":"string","required":true,"description":"Denotes the arrangement id of the loan"},{"name":"billType","in":"query","type":"string","required":false,"description":"The type of payment obligation generated"},{"name":"paymentDate","in":"query","type":"string","required":false,"description":"Contains the date in which the payment will be sent out. Date in the format YYYYMMDD. E.g. 20191231"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"","default":"","400":"","500":""}},{"method":"GET","path":"/holdings/loans/{loanId}/collaterals","fullPath":"/api/v1.0.0/holdings/loans/{loanId}/collaterals","operationId":"getLoanCollaterals","name":"Retrieves the collateral details linked to the loan arrangement.","summary":"Retrieves loan collateral details","tags":[],"parameters":[{"name":"loanId","in":"path","type":"string","required":true,"description":"Denotes the arrangement id of the loan"},{"name":"status","in":"query","type":"string","required":false,"description":"Contains status of the data rights request.Allowed values are INITIATED, INPROGESS, EXTENDED, COMPLETED, REJECTED."},{"name":"statusNE","in":"query","type":"string","required":false,"description":"Status not equal to"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"","default":"","400":"","500":""}},{"method":"GET","path":"/holdings/loans/{loanId}","fullPath":"/api/v1.0.0/holdings/loans/{loanId}","operationId":"getLoanDetails","name":"Retrieves loan details","summary":"Retrieves the loan account details","tags":[],"parameters":[{"name":"loanId","in":"path","type":"string","required":true,"description":"Denotes the arrangement id of the loan"},{"name":"dateFrom","in":"query","type":"string","required":false,"description":"Start date of the loan"},{"name":"dateTo","in":"query","type":"string","required":false,"description":"End date of the loan"},{"name":"balanceTypes","in":"query","type":"string","required":false,"description":"Type of balance (e.g. current balance, credit interest accrued, deferred commission, etc.) as defined in the institution's accounting schemas."},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"","default":"","400":"","500":""}},{"method":"GET","path":"/holdings/loans/{loanId}/schedulePaymentFrequencies","fullPath":"/api/v1.0.0/holdings/loans/{loanId}/schedulePaymentFrequencies","operationId":"getPaymentSchedules","name":"Retrieves the schedule payment information for paid and upcoming installments details","summary":"Retrieves payment schedules details","tags":[],"parameters":[{"name":"loanId","in":"path","type":"string","required":true,"description":"Denotes the arrangement id of the loan"},{"name":"dateFrom","in":"query","type":"string","required":false,"description":"Start date of the loan"},{"name":"dateTo","in":"query","type":"string","required":false,"description":"End date of the loan"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"","default":"","400":"","500":""}},{"method":"POST","path":"/holdings/simulationCapture/{arrangementId}","fullPath":"/api/v1.0.0/holdings/simulationCapture/{arrangementId}","operationId":"createSimulationCapture","name":"Simulate payoff calculate activity for a loan arrangement","summary":"Simulate payoff calculate activity for a loan arrangement","tags":[],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"arrangementId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":null,"responses":{"200":"","default":"","400":"","500":""}},{"method":"POST","path":"/holdings/loans/simulations","fullPath":"/api/v1.0.0/holdings/loans/simulations","operationId":"createLoanSimulation","name":"Create a simulation for loan product with details like customer identifier, currency, etc.","summary":"Create simulation for loan products","tags":["RETAIL"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"","default":"","400":"","500":""}},{"method":"PUT","path":"/holdings/loans/simulations/{simulationId}","fullPath":"/api/v1.0.0/holdings/loans/simulations/{simulationId}","operationId":"updateLoanSimulation","name":"Update a simulation for loan product with details like customer identifier, currency, etc.","summary":"Update a simulation for loan products","tags":["RETAIL"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"simulationId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":null,"responses":{"200":"","default":"","400":"","500":""}},{"method":"POST","path":"/holdings/loans/{loanId}/simulations/payoffs","fullPath":"/api/v1.0.0/holdings/loans/{loanId}/simulations/payoffs","operationId":"createLoanPayoffSimulation","name":"Create a simulation payoff activity for loan product with product id details","summary":"Create simulation payoff activity for loan products","tags":["RETAIL"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"loanId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":null,"responses":{"200":"","default":"","400":"","500":""}},{"method":"POST","path":"/holdings/loans/{loanId}/payoffs","fullPath":"/api/v1.0.0/holdings/loans/{loanId}/payoffs","operationId":"createLoanArrangementPayoff","name":"Execute payoff activity for loan product with details like simulation run reference, product id , etc.","summary":"Execute payoff activity for loan products","tags":["RETAIL"],"parameters":[{"name":"loanId","in":"path","type":"string","required":true,"description":""},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"createLoanArrangementPayoffResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse","default":"ArrangementErrorResponse"}},{"method":"GET","path":"/holdings/loans/{loanId}/overpayments","fullPath":"/api/v1.0.0/holdings/loans/{loanId}/overpayments","operationId":"getOverpaymentDetails","name":"Retrieves the product id, type of overpay, overpay limit, overpay period, utilised overpay and remaining overpay limit of a loan arrangement","summary":"Retrieves overpayment details that has happened for a loan arrangement","tags":["RETAIL"],"parameters":[{"name":"loanId","in":"path","type":"string","required":true,"description":"Denotes the arrangement id of the loan"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"","default":"","400":"","500":""}},{"method":"POST","path":"/holdings/loans/drawdowns/offers","fullPath":"/api/v1.0.0/holdings/loans/drawdowns/offers","operationId":"createLoanDrawdownOffer","name":"Creates a new drawdown offer for the required customer.","summary":"Creates a new drawdown offer for the required customer.","tags":[],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"","default":"","400":"","500":""}},{"method":"POST","path":"/holdings/loans/{loanId}/drawdowns/acceptances","fullPath":"/api/v1.0.0/holdings/loans/{loanId}/drawdowns/acceptances","operationId":"createLoanDrawdownOfferAcceptance","name":"Accept the offer drawdown for the retail loan and convert offer drawdown into a live loan arrangement.","summary":"Accept the offer drawdown for the retail loan and convert offer drawdown into a live loan arrangement.","tags":[],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"loanId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":null,"responses":{"200":"","default":"","400":"","500":""}},{"method":"POST","path":"/holdings/loans/{loanId}/drawdowns/renegotiations","fullPath":"/api/v1.0.0/holdings/loans/{loanId}/drawdowns/renegotiations","operationId":"createLoanDrawdownOfferRenegotiation","name":"Renegotiate the offer drawdown for the retail loan and convert offer drawdown into live loan arrangement.","summary":"Renegotiate the offer drawdown for the required customer.","tags":[],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"loanId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":null,"responses":{"200":"","default":"","400":"","500":""}},{"method":"POST","path":"/holdings/loans/{loanId}/drawdowns/cancellations","fullPath":"/api/v1.0.0/holdings/loans/{loanId}/drawdowns/cancellations","operationId":"cancelLoanDrawdownOffer","name":"Cancellation of offer drawdown for the required customer.","summary":"Cancellation of offer drawdown for the required customer.","tags":[],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"loanId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":null,"responses":{"200":"","default":"","400":"","500":""}},{"method":"POST","path":"/holdings/loans/{loanId}/drawdowns/acceptances/schedules","fullPath":"/api/v1.0.0/holdings/loans/{loanId}/drawdowns/acceptances/schedules","operationId":"createLoanDrawdownOfferAcceptanceSchedules","name":"Accept the offer drawdown for the retail loan and convert offer drawdown into a live loan arrangement and retrieve the payment schedule details.","summary":"Accept the offer drawdown for the retail loan and convert offer drawdown into a live loan arrangement and retrieve the payment schedule details.","tags":[],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"loanId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":null,"responses":{"200":"","default":"","400":"","500":""}},{"method":"POST","path":"/holdings/loans/{loanId}/drawdowns/renegotiations/schedules","fullPath":"/api/v1.0.0/holdings/loans/{loanId}/drawdowns/renegotiations/schedules","operationId":"createLoanDrawdownOfferRenegotiationSchedules","name":"Renegotiate the offer drawdown for the retail loan and convert offer drawdown into live loan arrangement and retrieve the payment schedule details.","summary":"Renegotiate the offer drawdown for the required customer and retrieve the payment schedule details.","tags":[],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"loanId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":null,"responses":{"200":"","default":"","400":"","500":""}},{"method":"PUT","path":"/holdings/loans/{LoanId}/settlements","fullPath":"/api/v1.0.0/holdings/loans/{LoanId}/settlements","operationId":"updateLoanSettlement","name":"Updates the settlement condition of the loan","summary":"Updates the settlement condition of the loan","tags":[],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"LoanId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":null,"responses":{"200":"","default":"","400":"","500":""}},{"method":"POST","path":"/holdings/loans/{loanId}/simulations/repayments","fullPath":"/api/v1.0.0/holdings/loans/{loanId}/simulations/repayments","operationId":"createRepaymentSimulation","name":"Simulate the pre payment of the given loan account","summary":"Simulate  the loan pre payment","tags":[],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"loanId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":null,"responses":{"200":"","default":"","400":"","500":""}},{"method":"POST","path":"/holdings/loans/{loanId}/simulations/repayments/schedules","fullPath":"/api/v1.0.0/holdings/loans/{loanId}/simulations/repayments/schedules","operationId":"createRepaymentSchedule","name":"Simulate the pre payment of the given loan amount and retrieve the payment schedule","summary":"Simulate the pre payment of the given loan amount and retrieve the payment schedule","tags":[],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"loanId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":null,"responses":{"200":"","default":"","400":"","500":""}},{"method":"PUT","path":"/holdings/loans/{loanId}/repaymentDates/schedules","fullPath":"/api/v1.0.0/holdings/loans/{loanId}/repaymentDates/schedules","operationId":"updateRepaymentDateAndSchedules","name":"Perform repayment date change for the loan product and retrieve the payment schedule , interest details etc.","summary":"Perform repayment date change for the loan and retrieve the payment schedule details.","tags":[],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"loanId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":null,"responses":{"200":"","default":"","400":"","500":""}},{"method":"POST","path":"/holdings/loans/{loanId}/simulations/repaymentDates","fullPath":"/api/v1.0.0/holdings/loans/{loanId}/simulations/repaymentDates","operationId":"createRepaymentDateChangeSimulation","name":"Simulate a loan arrangement for the given payment date","summary":"Simulate a loan arrangement for the given payment date","tags":[],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"loanId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":null,"responses":{"200":"","default":"","400":"","500":""}},{"method":"POST","path":"/holdings/loans/{loanId}/simulations/repaymentDates/schedules","fullPath":"/api/v1.0.0/holdings/loans/{loanId}/simulations/repaymentDates/schedules","operationId":"createRepaymentDateChangeSimulationSchedules","name":"Simulate a loan arrangement for the given payment date and retrieve the payments schedule , interest details etc.","summary":"Simulate a loan arrangement for the given payment date and retrieve the payments schedule details.","tags":[],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"loanId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":null,"responses":{"200":"","default":"","400":"","500":""}}]},{"key":"holdings-loans-arrangements-v6.4.0","title":"Loan creation","version":"v6.4.0","description":"API to create and manage various types of loans such as personal, commercial, mortgage, line of credit, etc","endpointCount":65,"endpoints":[{"method":"POST","path":"/holdings/loans/buyNowPayLater","fullPath":"/api/v1.0.0/holdings/loans/buyNowPayLater","operationId":"createBNPLLoan","name":"Creates a business banking loan for a single customer or more than one customer(like a joint account relationship) with the customer identifier, customer role, loan currency details","summary":"Creates a business banking loan for a single or joint customer","tags":["RETAIL"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"createBNPLLoanResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse","default":"ArrangementErrorResponse"}},{"method":"GET","path":"/holdings/loans/balances","fullPath":"/api/v1.0.0/holdings/loans/balances","operationId":"getLoanInformation","name":"Retrieves the loans details for a given customer id and alternate id or arrangementid of the buy now pay later loan.","summary":"Retrieve the buy now pay later loan details","tags":["RETAIL"],"parameters":[{"name":"customerId","in":"query","type":"string","required":false,"description":"Identifier of the customer"},{"name":"alternateId","in":"query","type":"string","required":false,"description":"An Alternate Identification for the Deal. This can be used to retrieve the Deal for amendment."},{"name":"arrangementId","in":"query","type":"string","required":false,"description":"Indicates an unique identifier of an account"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"LoanInformationResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse","default":"QueryErrorResponse"}},{"method":"PUT","path":"/holdings/loans/{loanId}/cancellations","fullPath":"/api/v1.0.0/holdings/loans/{loanId}/cancellations","operationId":"cancelArrangement","name":"Performs the full loan cancellation incase of preshipment return of products under buy now pay later loan.","summary":"Performs the loan cancellation for buy now pay later service","tags":["RETAIL"],"parameters":[{"name":"loanId","in":"path","type":"string","required":true,"description":""},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"cancelArrangementResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse","default":"ArrangementErrorResponse"}},{"method":"POST","path":"/holdings/loans/creditLines","fullPath":"/api/v1.0.0/holdings/loans/creditLines","operationId":"createlineOfCredit","name":"Create a lines of credit account","summary":"Create a lines of credit account","tags":["RETAIL"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"createlineOfCreditResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse","default":"ArrangementErrorResponse"}},{"method":"POST","path":"/holdings/loans","fullPath":"/api/v1.0.0/holdings/loans","operationId":"createLoans","name":"Creates a loan for the given product","summary":"Creates a loan for the given product","tags":["RETAIL"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"createloansResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse","default":"ArrangementErrorResponse"}},{"method":"POST","path":"/holdings/loans/vehicleLoans","fullPath":"/api/v1.0.0/holdings/loans/vehicleLoans","operationId":"createvehicleLoan","name":"creates a vehicle loan for the given product","summary":"Creates a vehicle loan for the given product","tags":["RETAIL"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"createvehicleLoanResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse","default":"ArrangementErrorResponse"}},{"method":"POST","path":"/holdings/loans/personalLoans","fullPath":"/api/v1.0.0/holdings/loans/personalLoans","operationId":"createPersonalLoan","name":"Create a personal loan account","summary":"Create a personal loan account","tags":[],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"","default":"","400":"","500":""}},{"method":"POST","path":"/holdings/loans/consumerLoans","fullPath":"/api/v1.0.0/holdings/loans/consumerLoans","operationId":"createConsumerLoan","name":"creates a consumer loan for the given product","summary":"Creates a consumer loan for the given product","tags":["RETAIL"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"createConsumerLoanResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse","default":"ArrangementErrorResponse"}},{"method":"POST","path":"/holdings/loans/{loanId}/simulations/paymentHolidays","fullPath":"/api/v1.0.0/holdings/loans/{loanId}/simulations/paymentHolidays","operationId":"simulatePaymentHoliday","name":"Simulate payment holiday activity for a loan account","summary":"Simulate payment holiday activity for a loan account","tags":["RETAIL"],"parameters":[{"name":"loanId","in":"path","type":"string","required":true,"description":""},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"simulatePaymentHolidayResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse","default":"ArrangementErrorResponse"}},{"method":"PUT","path":"/holdings/loans/{loanId}/renegotiations","fullPath":"/api/v1.0.0/holdings/loans/{loanId}/renegotiations","operationId":"updateLoanConditions","name":"Perform the renegotiation of the loan contract details such as payment frequency, interest rates, etc.","summary":"Perform the renegotiation of the loan contract details","tags":["RETAIL"],"parameters":[{"name":"loanId","in":"path","type":"string","required":true,"description":""},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"updateLoanConditionsResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse","default":"ArrangementErrorResponse"}},{"method":"PUT","path":"/holdings/loans/{loanId}/accounts","fullPath":"/api/v1.0.0/holdings/loans/{loanId}/accounts","operationId":"updateLoanAccount","name":"Update the account conditions of the loan such as alternate references, posting restrictions, etc","summary":"Update the account conditions of the loan","tags":["RETAIL"],"parameters":[{"name":"loanId","in":"path","type":"string","required":true,"description":""},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"updateLoanAccountResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse","default":"ArrangementErrorResponse"}},{"method":"PUT","path":"/holdings/loans/{loanId}/interestConditions","fullPath":"/api/v1.0.0/holdings/loans/{loanId}/interestConditions","operationId":"updateLoanInterest","name":"Update the interest conditions of the loan such as interest rate, spread, margin etc","summary":"Update the interest conditions of the loan","tags":["RETAIL"],"parameters":[{"name":"loanId","in":"path","type":"string","required":true,"description":""},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"updateLoanInterestResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse","default":"ArrangementErrorResponse"}},{"method":"PUT","path":"/holdings/loans/{loanId}/chargeOffs","fullPath":"/api/v1.0.0/holdings/loans/{loanId}/chargeOffs","operationId":"createChargeOffActivity","name":"Execute loan charge-off activity to charge-off account balance only","summary":"Execute loan charge-off activity to charge-off account balance only","tags":["RETAIL"],"parameters":[{"name":"loanId","in":"path","type":"string","required":true,"description":""},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"createChargeOffActivityResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse","default":"ArrangementErrorResponse"}},{"method":"PUT","path":"/holdings/loans/{loanId}/disbursements","fullPath":"/api/v1.0.0/holdings/loans/{loanId}/disbursements","operationId":"createLoanDisbursement","name":"Creates a disbursement of the given loan contracts commitment amount","summary":"Disburses the loan commitment amount","tags":["RETAIL"],"parameters":[{"name":"loanId","in":"path","type":"string","required":true,"description":""},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"createLoanDisbursementResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse","default":"ArrangementErrorResponse"}},{"method":"PUT","path":"/holdings/loans/{loanId}/customers","fullPath":"/api/v1.0.0/holdings/loans/{loanId}/customers","operationId":"updateLoansCustomer","name":"Updates the customer for the given loan contract","summary":"Updates the customer for the given loan contract","tags":["RETAIL"],"parameters":[{"name":"loanId","in":"path","type":"string","required":true,"description":""},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"updateLoansCustomerResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse","default":"ArrangementErrorResponse"}},{"method":"PUT","path":"/holdings/loans/{loanId}/commitmentIncreases","fullPath":"/api/v1.0.0/holdings/loans/{loanId}/commitmentIncreases","operationId":"updateLoanTopupAmount","name":"Increases the commitment amount of the loan","summary":"Increases the commitment amount of the given loan contract","tags":["RETAIL"],"parameters":[{"name":"loanId","in":"path","type":"string","required":true,"description":""},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"updateLoanTopupAmountResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse","default":"ArrangementErrorResponse"}},{"method":"PUT","path":"/holdings/loans/{loanId}/commitmentDecreases","fullPath":"/api/v1.0.0/holdings/loans/{loanId}/commitmentDecreases","operationId":"updateLoanDecreaseAmount","name":"Decreases the commitment amount of the loan","summary":"Decreases the commitment amount of the given loan contract","tags":["RETAIL"],"parameters":[{"name":"loanId","in":"path","type":"string","required":true,"description":""},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"updateLoanDecreaseAmountResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse","default":"ArrangementErrorResponse"}},{"method":"PUT","path":"/holdings/loans/{loanId}/repaymentDates","fullPath":"/api/v1.0.0/holdings/loans/{loanId}/repaymentDates","operationId":"updateRepaymentDate","name":"Perform repayment date change for the loan product with details like loan reference, product id , etc.","summary":"Perform repayment date change for the loan","tags":["RETAIL"],"parameters":[{"name":"loanId","in":"path","type":"string","required":true,"description":""},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"updateRepaymentDateResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse","default":"ArrangementErrorResponse"}},{"method":"PUT","path":"/holdings/loans/{loanId}/writeOffs/balances","fullPath":"/api/v1.0.0/holdings/loans/{loanId}/writeOffs/balances","operationId":"initiateWriteOffBalanceLoans","name":"Perform a write off of the balances such as principal or interest or charge amount for the unpaid consumer loans","summary":"Perform a loan balance write off","tags":["RETAIL"],"parameters":[{"name":"loanId","in":"path","type":"string","required":true,"description":""},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"initiateWriteOffBalanceLoansResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse","default":"ArrangementErrorResponse"}},{"method":"PUT","path":"/holdings/loans/{loanId}/writeOffs","fullPath":"/api/v1.0.0/holdings/loans/{loanId}/writeOffs","operationId":"initiateWriteOffLoans","name":"Perform a write off of all the balances including principal , interest and charge amounts for the unpaid consumer loans","summary":"Perform a write off of all the balances for the unpaid consumer loans","tags":["RETAIL"],"parameters":[{"name":"loanId","in":"path","type":"string","required":true,"description":""},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"initiateWriteOffLoansResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse","default":"ArrangementErrorResponse"}},{"method":"PUT","path":"/holdings/loans/{loanId}/writeOffs/bills","fullPath":"/api/v1.0.0/holdings/loans/{loanId}/writeOffs/bills","operationId":"initiateWriteOffBillLoans","name":"Perform a write off of all the balances including principal , interest and charge amounts for the unpaid consumer loans","summary":"Perform a write off of all the balances for the unpaid consumer loans","tags":["RETAIL"],"parameters":[{"name":"loanId","in":"path","type":"string","required":true,"description":""},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"initiateWriteOffBillLoansResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse","default":"ArrangementErrorResponse"}},{"method":"POST","path":"/holdings/loans/linkedRateLoans","fullPath":"/api/v1.0.0/holdings/loans/linkedRateLoans","operationId":"createLinkedRateLoan","name":"Create a personal loan account with linked rate","summary":"Create a personal loan account with linked rate","tags":[],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"","default":"","400":"","500":""}},{"method":"POST","path":"/holdings/loans/commercialLoans","fullPath":"/api/v1.0.0/holdings/loans/commercialLoans","operationId":"createCommercialLoan","name":"Create a commercial or business account","summary":"Create a commercial or business account","tags":[],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"","default":"","400":"","500":""}},{"method":"POST","path":"/holdings/loans/mortgages","fullPath":"/api/v1.0.0/holdings/loans/mortgages","operationId":"createMortgage","name":"Create a mortgage loan","summary":"Create a mortgage loan","tags":[],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"","default":"","400":"","500":""}},{"method":"POST","path":"/holdings/facilities/installmentLoans","fullPath":"/api/v1.0.0/holdings/facilities/installmentLoans","operationId":"createInstallmentLoan","name":"Create an installment loan for the given product","summary":"Create an installment loan for the given product","tags":[],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"","default":"","400":"","500":""}},{"method":"POST","path":"/holdings/fundsTransfer","fullPath":"/api/v1.0.0/holdings/fundsTransfer","operationId":"createFundsTransfer","name":"Create an account transfer","summary":"Create an account transfer","tags":[],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"","default":"","400":"","500":""}},{"method":"PUT","path":"/holdings/loans/consumerLoans/{consumerLoanId}/disbursements","fullPath":"/api/v1.0.0/holdings/loans/consumerLoans/{consumerLoanId}/disbursements","operationId":"createConsumerLoanDisbursement","name":"Creates a disbursement of the given consumer loan contracts commitment amount","summary":"Disburses the consumer loan commitment amount","tags":["RETAIL"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"consumerLoanId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":null,"responses":{"200":"","default":"","400":"","500":""}},{"method":"PUT","path":"/holdings/loans/consumerLoans/{consumerLoanId}/commitmentIncreases","fullPath":"/api/v1.0.0/holdings/loans/consumerLoans/{consumerLoanId}/commitmentIncreases","operationId":"updateConsumerLoanTopupAmount","name":"Increases the commitment amount of the consumer loan","summary":"Increases the commitment amount of the given consumer loan contract","tags":["RETAIL"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"consumerLoanId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":null,"responses":{"200":"","default":"","400":"","500":""}},{"method":"PUT","path":"/holdings/loans/consumerLoans/{consumerLoanId}/commitmentDecreases","fullPath":"/api/v1.0.0/holdings/loans/consumerLoans/{consumerLoanId}/commitmentDecreases","operationId":"updateConsumerLoanDecreaseAmount","name":"Decreases the commitment amount of the consumer loan","summary":"Decreases the commitment amount of the given consumer loan contract","tags":["RETAIL"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"consumerLoanId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":null,"responses":{"200":"","default":"","400":"","500":""}},{"method":"PUT","path":"/holdings/loans/consumerLoans/{consumerLoanId}/repayments","fullPath":"/api/v1.0.0/holdings/loans/consumerLoans/{consumerLoanId}/repayments","operationId":"createConsumerLoanRepayment","name":"Creates the repayment of the given consumer loan amount","summary":"Repays the consumer loan amount","tags":["RETAIL"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"consumerLoanId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":null,"responses":{"200":"","default":"","400":"","500":""}},{"method":"PUT","path":"/holdings/loans/consumerLoans/{consumerLoanId}/principalDecreases","fullPath":"/api/v1.0.0/holdings/loans/consumerLoans/{consumerLoanId}/principalDecreases","operationId":"createConsumerLoanPrepayment","name":"Creates the advance repayment of the given consumer loan amount","summary":"Prepays the consumer loan amount","tags":["RETAIL"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"consumerLoanId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":null,"responses":{"200":"","default":"","400":"","500":""}},{"method":"PUT","path":"/holdings/loans/consumerLoans/{consumerLoanId}/schedules","fullPath":"/api/v1.0.0/holdings/loans/consumerLoans/{consumerLoanId}/schedules","operationId":"updateConsumerLoanSchedule","name":"Update the change of payment schedule for the given consumer loan contract","summary":"Update the payment schedule of the consumer loan","tags":["RETAIL"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"consumerLoanId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":null,"responses":{"200":"","default":"","400":"","500":""}},{"method":"PUT","path":"/holdings/loans/consumerLoans/{consumerLoanId}/paymentHolidays","fullPath":"/api/v1.0.0/holdings/loans/consumerLoans/{consumerLoanId}/paymentHolidays","operationId":"updateConsumerLoanHoliday","name":"Update of payment holiday for the given consumer loan contract","summary":"Update payment holiday for the consumer loan","tags":["RETAIL"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"consumerLoanId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":null,"responses":{"200":"","default":"","400":"","500":""}},{"method":"GET","path":"/holdings/loans/{loanId}/outstandingBills","fullPath":"/api/v1.0.0/holdings/loans/{loanId}/outstandingBills","operationId":"getLoanOutstandingBills","name":"Retrieves the outstanding amount to be paid for a loan","summary":"Retrieves the outstanding amount to be paid for the given loan","tags":["RETAIL"],"parameters":[{"name":"loanId","in":"path","type":"string","required":true,"description":"Denotes the arrangement id of the loan"},{"name":"fileVersion","in":"query","type":"string","required":false,"description":"Indicates if the file is of type simulation or live"},{"name":"simulationReference","in":"query","type":"string","required":false,"description":"Indicates the reference id for simulation activity"},{"name":"paymentDate","in":"query","type":"string","required":false,"description":"Contains the date in which the payment will be sent out. Date in the format YYYYMMDD. E.g. 20191231"},{"name":"deferDate","in":"query","type":"string","required":false,"description":"Date that the payment has been deferred to"},{"name":"billedAmount","in":"query","type":"string","required":false,"description":"Indicates the bill amount"},{"name":"outstandingAmount","in":"query","type":"string","required":false,"description":"Contains the aggregate outstanding principal amount thereof after giving effect to any borrowings and prepayments or repayments of Committed Loans"},{"name":"delinquentAmount","in":"query","type":"string","required":false,"description":"Indicates the bill amount during the ageing status(Bill which crossed the due date)"},{"name":"property","in":"query","type":"string","required":false,"description":"Id of the product property"},{"name":"billStatus","in":"query","type":"string","required":false,"description":"Indicates the status of a bill(Issued,Due,Ageing,Settled)"},{"name":"settlementStatus","in":"query","type":"string","required":false,"description":"Defines the status of the settlement for the incoming MT548 swift message.The values allowed are: Waiting : pending to receive settlement status update meaning pending to receive MT548 swift message, "},{"name":"agingStatus","in":"query","type":"string","required":false,"description":"Indicates the ageing status of a bill"},{"name":"settled","in":"query","type":"string","required":false,"description":"Flag to indicate whether a bill is settled or not"},{"name":"paymentType","in":"query","type":"string","required":false,"description":"Indicates if the payment is Customer (C) type or Bank (B) type"},{"name":"billDate","in":"query","type":"string","required":false,"description":"Indicates a date on which a bill has been raised"},{"name":"paymentMethod","in":"query","type":"string","required":false,"description":"Method chosen to make the payment"},{"name":"infoPayType","in":"query","type":"string","required":false,"description":"Indicates a bill which is raised when a loan is paid off"},{"name":"advancePayment","in":"query","type":"string","required":false,"description":"Indicates whether advance payment made is set on an account"},{"name":"paymentIndicator","in":"query","type":"string","required":false,"description":"Indicates whether its a credit/debit type of bill"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"","default":"","400":"","500":""}},{"method":"GET","path":"/holdings/loans/{loanId}/payoffCalculations","fullPath":"/api/v1.0.0/holdings/loans/{loanId}/payoffCalculations","operationId":"getLoanPayoffDetails","name":"Retrieves the payoff details of a loan","summary":"Retrieves the payoff details of the given loan","tags":["RETAIL"],"parameters":[{"name":"loanId","in":"path","type":"string","required":true,"description":"Denotes the arrangement id of the loan"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"","default":"","400":"","500":""}},{"method":"PUT","path":"/holdings/loans/consumerLoans/{consumerLoanId}/customers","fullPath":"/api/v1.0.0/holdings/loans/consumerLoans/{consumerLoanId}/customers","operationId":"updateConsumerLoansCustomer","name":"Updates the customers for the given consumer loan contract","summary":"Update the customers of the consumer loan ","tags":["RETAIL"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"consumerLoanId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":null,"responses":{"200":"","default":"","400":"","500":""}},{"method":"PUT","path":"/holdings/loans/consumerLoans/{consumerLoanId}/payoffs","fullPath":"/api/v1.0.0/holdings/loans/consumerLoans/{consumerLoanId}/payoffs","operationId":"createPayoffConsumerLoan","name":"Creates the payoff of the given consumer loan contract amount","summary":"Payoffs the consumer loan amount","tags":["RETAIL"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"consumerLoanId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":null,"responses":{"200":"","default":"","400":"","500":""}},{"method":"PUT","path":"/holdings/loans/consumerLoans/{consumerLoanId}/renegotiations","fullPath":"/api/v1.0.0/holdings/loans/consumerLoans/{consumerLoanId}/renegotiations","operationId":"updateConsumerLoanConditions","name":"Creates the renegotiation of the given consumer loan contract details","summary":"Renegotiates the consumer loan contract details","tags":["RETAIL"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"consumerLoanId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":null,"responses":{"200":"","default":"","400":"","500":""}},{"method":"GET","path":"/holdings/loans/{loanId}/status","fullPath":"/api/v1.0.0/holdings/loans/{loanId}/status","operationId":"getArrangementDetails","name":"Retrieves the status of a loan","summary":"Retrieves the status of the given loan","tags":["RETAIL"],"parameters":[{"name":"loanId","in":"path","type":"string","required":true,"description":"Denotes the arrangement id of the loan"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"","default":"","400":"","500":""}},{"method":"GET","path":"/holdings/loans/arrangements/activities/{arrangementActivityId}/status","fullPath":"/api/v1.0.0/holdings/loans/arrangements/activities/{arrangementActivityId}/status","operationId":"getExternalEventStatus","name":"Retrieves the status of the given activity ","summary":"Retrieves the status of the given activity ","tags":["RETAIL"],"parameters":[{"name":"arrangementActivityId","in":"path","type":"string","required":true,"description":"Contains the arrangement activity reference identifier"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"","default":"","400":"","500":""}},{"method":"PUT","path":"/holdings/loans/consumerLoans/{consumerLoanId}/payoffCalculations","fullPath":"/api/v1.0.0/holdings/loans/consumerLoans/{consumerLoanId}/payoffCalculations","operationId":"calculatePayoffConsumerLoans","name":"Creates calculates payoff activity to calculate consumer loan payment amount to close the given loan","summary":"Calculates consumer loan payment amount to close a loan","tags":["RETAIL"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"consumerLoanId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":null,"responses":{"200":"","default":"","400":"","500":""}},{"method":"GET","path":"/holdings/loans/{loanId}/schedules","fullPath":"/api/v1.0.0/holdings/loans/{loanId}/schedules","operationId":"getPaymentSchedulesProjection","name":"Retrieves the schedule payment information for paid and upcoming installments details","summary":"Retrieves payment schedules details","tags":["RETAIL"],"parameters":[{"name":"loanId","in":"path","type":"string","required":true,"description":"Denotes the arrangement id of the loan"},{"name":"dateFrom","in":"query","type":"string","required":false,"description":"Start date of the loan"},{"name":"dateTo","in":"query","type":"string","required":false,"description":"End date of the loan"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"","default":"","400":"","500":""}},{"method":"GET","path":"/holdings/loans/{loanId}/loanDetails","fullPath":"/api/v1.0.0/holdings/loans/{loanId}/loanDetails","operationId":"getLoanOverview","name":"Retrieves the details of the given loan","summary":"Retrieves loan details ","tags":["RETAIL"],"parameters":[{"name":"loanId","in":"path","type":"string","required":true,"description":"Denotes the arrangement id of the loan"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"","default":"","400":"","500":""}},{"method":"GET","path":"/holdings/loans/{loanId}/bills","fullPath":"/api/v1.0.0/holdings/loans/{loanId}/bills","operationId":"getLoanBills","name":"Retrieves the simulation details of the contract based on the selection criteria. It returns the bill details of the loan","summary":"Retrieves loan bills details","tags":[],"parameters":[{"name":"loanId","in":"path","type":"string","required":true,"description":"Denotes the arrangement id of the loan"},{"name":"billType","in":"query","type":"string","required":false,"description":"The type of payment obligation generated"},{"name":"paymentDate","in":"query","type":"string","required":false,"description":"Contains the date in which the payment will be sent out. Date in the format YYYYMMDD. E.g. 20191231"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"","default":"","400":"","500":""}},{"method":"GET","path":"/holdings/loans/{loanId}/collaterals","fullPath":"/api/v1.0.0/holdings/loans/{loanId}/collaterals","operationId":"getLoanCollaterals","name":"Retrieves the collateral details linked to the loan arrangement.","summary":"Retrieves loan collateral details","tags":[],"parameters":[{"name":"loanId","in":"path","type":"string","required":true,"description":"Denotes the arrangement id of the loan"},{"name":"status","in":"query","type":"string","required":false,"description":"Contains status of the data rights request.Allowed values are INITIATED, INPROGESS, EXTENDED, COMPLETED, REJECTED."},{"name":"statusNE","in":"query","type":"string","required":false,"description":"Status not equal to"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"","default":"","400":"","500":""}},{"method":"GET","path":"/holdings/loans/{loanId}","fullPath":"/api/v1.0.0/holdings/loans/{loanId}","operationId":"getLoanDetails","name":"Retrieves loan details","summary":"Retrieves the loan account details","tags":[],"parameters":[{"name":"loanId","in":"path","type":"string","required":true,"description":"Denotes the arrangement id of the loan"},{"name":"dateFrom","in":"query","type":"string","required":false,"description":"Start date of the loan"},{"name":"dateTo","in":"query","type":"string","required":false,"description":"End date of the loan"},{"name":"balanceTypes","in":"query","type":"string","required":false,"description":"Type of balance (e.g. current balance, credit interest accrued, deferred commission, etc.) as defined in the institution's accounting schemas."},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"","default":"","400":"","500":""}},{"method":"GET","path":"/holdings/loans/{loanId}/schedulePaymentFrequencies","fullPath":"/api/v1.0.0/holdings/loans/{loanId}/schedulePaymentFrequencies","operationId":"getPaymentSchedules","name":"Retrieves the schedule payment information for paid and upcoming installments details","summary":"Retrieves payment schedules details","tags":[],"parameters":[{"name":"loanId","in":"path","type":"string","required":true,"description":"Denotes the arrangement id of the loan"},{"name":"dateFrom","in":"query","type":"string","required":false,"description":"Start date of the loan"},{"name":"dateTo","in":"query","type":"string","required":false,"description":"End date of the loan"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"","default":"","400":"","500":""}},{"method":"POST","path":"/holdings/simulationCapture/{arrangementId}","fullPath":"/api/v1.0.0/holdings/simulationCapture/{arrangementId}","operationId":"createSimulationCapture","name":"Simulate payoff calculate activity for a loan arrangement","summary":"Simulate payoff calculate activity for a loan arrangement","tags":[],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"arrangementId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":null,"responses":{"200":"","default":"","400":"","500":""}},{"method":"POST","path":"/holdings/loans/simulations","fullPath":"/api/v1.0.0/holdings/loans/simulations","operationId":"createLoanSimulation","name":"Create a simulation for loan product with details like customer identifier, currency, etc.","summary":"Create simulation for loan products","tags":["RETAIL"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"","default":"","400":"","500":""}},{"method":"PUT","path":"/holdings/loans/simulations/{simulationId}","fullPath":"/api/v1.0.0/holdings/loans/simulations/{simulationId}","operationId":"updateLoanSimulation","name":"Update a simulation for loan product with details like customer identifier, currency, etc.","summary":"Update a simulation for loan products","tags":["RETAIL"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"simulationId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":null,"responses":{"200":"","default":"","400":"","500":""}},{"method":"POST","path":"/holdings/loans/{loanId}/simulations/payoffs","fullPath":"/api/v1.0.0/holdings/loans/{loanId}/simulations/payoffs","operationId":"createLoanPayoffSimulation","name":"Create a simulation payoff activity for loan product with product id details","summary":"Create simulation payoff activity for loan products","tags":["RETAIL"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"loanId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":null,"responses":{"200":"","default":"","400":"","500":""}},{"method":"POST","path":"/holdings/loans/{loanId}/payoffs","fullPath":"/api/v1.0.0/holdings/loans/{loanId}/payoffs","operationId":"createLoanArrangementPayoff","name":"Execute payoff activity for loan product with details like simulation run reference, product id , etc.","summary":"Execute payoff activity for loan products","tags":["RETAIL"],"parameters":[{"name":"loanId","in":"path","type":"string","required":true,"description":""},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"createLoanArrangementPayoffResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse","default":"ArrangementErrorResponse"}},{"method":"GET","path":"/holdings/loans/{loanId}/overpayments","fullPath":"/api/v1.0.0/holdings/loans/{loanId}/overpayments","operationId":"getOverpaymentDetails","name":"Retrieves the product id, type of overpay, overpay limit, overpay period, utilised overpay and remaining overpay limit of a loan arrangement","summary":"Retrieves overpayment details that has happened for a loan arrangement","tags":["RETAIL"],"parameters":[{"name":"loanId","in":"path","type":"string","required":true,"description":"Denotes the arrangement id of the loan"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"","default":"","400":"","500":""}},{"method":"POST","path":"/holdings/loans/drawdowns/offers","fullPath":"/api/v1.0.0/holdings/loans/drawdowns/offers","operationId":"createLoanDrawdownOffer","name":"Creates a new drawdown offer for the required customer.","summary":"Creates a new drawdown offer for the required customer.","tags":[],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"","default":"","400":"","500":""}},{"method":"POST","path":"/holdings/loans/{loanId}/drawdowns/acceptances","fullPath":"/api/v1.0.0/holdings/loans/{loanId}/drawdowns/acceptances","operationId":"createLoanDrawdownOfferAcceptance","name":"Accept the offer drawdown for the retail loan and convert offer drawdown into a live loan arrangement.","summary":"Accept the offer drawdown for the retail loan and convert offer drawdown into a live loan arrangement.","tags":[],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"loanId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":null,"responses":{"200":"","default":"","400":"","500":""}},{"method":"POST","path":"/holdings/loans/{loanId}/drawdowns/renegotiations","fullPath":"/api/v1.0.0/holdings/loans/{loanId}/drawdowns/renegotiations","operationId":"createLoanDrawdownOfferRenegotiation","name":"Renegotiate the offer drawdown for the retail loan and convert offer drawdown into live loan arrangement.","summary":"Renegotiate the offer drawdown for the required customer.","tags":[],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"loanId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":null,"responses":{"200":"","default":"","400":"","500":""}},{"method":"POST","path":"/holdings/loans/{loanId}/drawdowns/cancellations","fullPath":"/api/v1.0.0/holdings/loans/{loanId}/drawdowns/cancellations","operationId":"cancelLoanDrawdownOffer","name":"Cancellation of offer drawdown for the required customer.","summary":"Cancellation of offer drawdown for the required customer.","tags":[],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"loanId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":null,"responses":{"200":"","default":"","400":"","500":""}},{"method":"POST","path":"/holdings/loans/{loanId}/drawdowns/acceptances/schedules","fullPath":"/api/v1.0.0/holdings/loans/{loanId}/drawdowns/acceptances/schedules","operationId":"createLoanDrawdownOfferAcceptanceSchedules","name":"Accept the offer drawdown for the retail loan and convert offer drawdown into a live loan arrangement and retrieve the payment schedule details.","summary":"Accept the offer drawdown for the retail loan and convert offer drawdown into a live loan arrangement and retrieve the payment schedule details.","tags":[],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"loanId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":null,"responses":{"200":"","default":"","400":"","500":""}},{"method":"POST","path":"/holdings/loans/{loanId}/drawdowns/renegotiations/schedules","fullPath":"/api/v1.0.0/holdings/loans/{loanId}/drawdowns/renegotiations/schedules","operationId":"createLoanDrawdownOfferRenegotiationSchedules","name":"Renegotiate the offer drawdown for the retail loan and convert offer drawdown into live loan arrangement and retrieve the payment schedule details.","summary":"Renegotiate the offer drawdown for the required customer and retrieve the payment schedule details.","tags":[],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"loanId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":null,"responses":{"200":"","default":"","400":"","500":""}},{"method":"PUT","path":"/holdings/loans/{LoanId}/settlements","fullPath":"/api/v1.0.0/holdings/loans/{LoanId}/settlements","operationId":"updateLoanSettlement","name":"Updates the settlement condition of the loan","summary":"Updates the settlement condition of the loan","tags":[],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"LoanId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":null,"responses":{"200":"","default":"","400":"","500":""}},{"method":"POST","path":"/holdings/loans/{loanId}/simulations/repayments","fullPath":"/api/v1.0.0/holdings/loans/{loanId}/simulations/repayments","operationId":"createRepaymentSimulation","name":"Simulate the pre payment of the given loan account","summary":"Simulate  the loan pre payment","tags":[],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"loanId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":null,"responses":{"200":"","default":"","400":"","500":""}},{"method":"POST","path":"/holdings/loans/{loanId}/simulations/repayments/schedules","fullPath":"/api/v1.0.0/holdings/loans/{loanId}/simulations/repayments/schedules","operationId":"createRepaymentSchedule","name":"Simulate the pre payment of the given loan amount and retrieve the payment schedule","summary":"Simulate the pre payment of the given loan amount and retrieve the payment schedule","tags":[],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"loanId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":null,"responses":{"200":"","default":"","400":"","500":""}},{"method":"PUT","path":"/holdings/loans/{loanId}/repaymentDates/schedules","fullPath":"/api/v1.0.0/holdings/loans/{loanId}/repaymentDates/schedules","operationId":"updateRepaymentDateAndSchedules","name":"Perform repayment date change for the loan product and retrieve the payment schedule , interest details etc.","summary":"Perform repayment date change for the loan and retrieve the payment schedule details.","tags":[],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"loanId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":null,"responses":{"200":"","default":"","400":"","500":""}},{"method":"POST","path":"/holdings/loans/{loanId}/simulations/repaymentDates","fullPath":"/api/v1.0.0/holdings/loans/{loanId}/simulations/repaymentDates","operationId":"createRepaymentDateChangeSimulation","name":"Simulate a loan arrangement for the given payment date","summary":"Simulate a loan arrangement for the given payment date","tags":[],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"loanId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":null,"responses":{"200":"","default":"","400":"","500":""}},{"method":"POST","path":"/holdings/loans/{loanId}/simulations/repaymentDates/schedules","fullPath":"/api/v1.0.0/holdings/loans/{loanId}/simulations/repaymentDates/schedules","operationId":"createRepaymentDateChangeSimulationSchedules","name":"Simulate a loan arrangement for the given payment date and retrieve the payments schedule , interest details etc.","summary":"Simulate a loan arrangement for the given payment date and retrieve the payments schedule details.","tags":[],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"loanId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":null,"responses":{"200":"","default":"","400":"","500":""}}]},{"key":"holdings-loans-arrangements-v6.5.0","title":"Loan creation","version":"v6.5.0","description":"API to create and manage various types of loans such as personal, commercial, mortgage, line of credit, etc","endpointCount":72,"endpoints":[{"method":"POST","path":"/holdings/loans/migrations","fullPath":"/api/v1.0.0/holdings/loans/migrations","operationId":"initiateTakeoverloan","name":"Migration of a legacy system loan contract to the given product by providing the original contract date, principal amount, term, payment frequency and start date, etc. ","summary":"Migration of legacy system loan contract to the given product","tags":["RETAIL"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"","400":"","500":"","default":""}},{"method":"PUT","path":"/holdings/loans/{loanId}/balances/migrations","fullPath":"/api/v1.0.0/holdings/loans/{loanId}/balances/migrations","operationId":"captureBalance","name":"Captures the balance details of the mortgage loan such as balance type, due amount etc. This is used to migrate the balances of a legacy contract which is migrated from other system & update the balance details.","summary":"Captures outstanding balance details of of a contract migrated from legacy system","tags":["RETAIL"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"loanId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":null,"responses":{"200":"","400":"","500":"","default":""}},{"method":"PUT","path":"/holdings/loans/{loanId}/bills/migrations","fullPath":"/api/v1.0.0/holdings/loans/{loanId}/bills/migrations","operationId":"captureBills","name":"Captures the bill information of the loan such as bill id, property names, bill amount etc. This is used to migrate the bills of a legacy contract which is migrated from other system & update the bill details","summary":"Captures outstanding bill information of a contract migrated from legacy system.","tags":["RETAIL"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"loanId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":null,"responses":{"200":"","400":"","500":"","default":""}},{"method":"PUT","path":"/holdings/loans/{loanId}/products","fullPath":"/api/v1.0.0/holdings/loans/{loanId}/products","operationId":"updateChangeProduct","name":"Change loan from one product to another such as changing one loan product to another loan product","summary":"Change of contract from one loan product to another","tags":["RETAIL"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"loanId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":null,"responses":{"200":"","400":"","500":"","default":""}},{"method":"GET","path":"/holdings/loans/{loanId}/evidences","fullPath":"/api/v1.0.0/holdings/loans/{loanId}/evidences","operationId":"getEvidence","name":"Retrieves the covenants and conditions for a loan account. Covenants are requested in periodic basis and the Conditions are one-time evidence. On non-submission or non-compliance of the evidences, the related consequent activity will be restricted","summary":"Retrieves the covenants and conditions for a loan account.","tags":["RETAIL"],"parameters":[{"name":"loanId","in":"path","type":"string","required":true,"description":"Denotes the arrangement id of the loan"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"","400":"","500":"","default":""}},{"method":"PUT","path":"/holdings/loans/{loanId}/evidences","fullPath":"/api/v1.0.0/holdings/loans/{loanId}/evidences","operationId":"updateEvidence","name":"Performs update of covenants and conditions for a loan account. Covenants are requested in periodic basis and the Conditions are one-time evidence. On non-submission or non-compliance of the evidences, the related consequent activity will be restricted","summary":"Update the covenants and conditions for a loan account","tags":["RETAIL"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"loanId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":null,"responses":{"200":"","400":"","500":"","default":""}},{"method":"POST","path":"/holdings/loans/{loanId}/simulations/paymentHolidays","fullPath":"/api/v1.0.0/holdings/loans/{loanId}/simulations/paymentHolidays","operationId":"simulatePaymentHoliday","name":"Simulate payment holiday activity for a loan account","summary":"Simulate payment holiday activity for a loan account","tags":["RETAIL"],"parameters":[{"name":"loanId","in":"path","type":"string","required":true,"description":""},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"simulatePaymentHolidayResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse","default":"ArrangementErrorResponse"}},{"method":"GET","path":"/holdings/loans/{loanId}/simulations/paymentHolidays","fullPath":"/api/v1.0.0/holdings/loans/{loanId}/simulations/paymentHolidays","operationId":"getPaymentHolidaySim","name":"Retrieves payment holiday simulation details for the loan such as payment type, holiday date, original payment amount and new payment amount","summary":"Retrieves payment holiday simulation details for the loan","tags":["RETAIL"],"parameters":[{"name":"loanId","in":"path","type":"string","required":true,"description":"Denotes the arrangement id of the loan"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"","400":"","500":"","default":""}},{"method":"POST","path":"/holdings/loans/buyNowPayLater","fullPath":"/api/v1.0.0/holdings/loans/buyNowPayLater","operationId":"createBNPLLoan","name":"Creates a business banking loan for a single customer or more than one customer(like a joint account relationship) with the customer identifier, customer role, loan currency details","summary":"Creates a business banking loan for a single or joint customer","tags":["RETAIL"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"createBNPLLoanResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse","default":"ArrangementErrorResponse"}},{"method":"GET","path":"/holdings/loans/balances","fullPath":"/api/v1.0.0/holdings/loans/balances","operationId":"getLoanInformation","name":"Retrieves the loans details for a given customer id and alternate id or arrangement id of the buy now pay later loan.","summary":"Retrieve the buy now pay later loan details","tags":["RETAIL"],"parameters":[{"name":"customerId","in":"query","type":"string","required":false,"description":"Identifier of the customer"},{"name":"alternateId","in":"query","type":"string","required":false,"description":"An Alternate Identification for the Deal. This can be used to retrieve the Deal for amendment."},{"name":"arrangementId","in":"query","type":"string","required":false,"description":"Indicates an unique identifier of an account"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"LoanInformationResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse","default":"QueryErrorResponse"}},{"method":"PUT","path":"/holdings/loans/{loanId}/cancellations","fullPath":"/api/v1.0.0/holdings/loans/{loanId}/cancellations","operationId":"cancelArrangement","name":"Performs the full loan cancellation incase of preshipment return of products under buy now pay later loan.","summary":"Performs the loan cancellation for buy now pay later service","tags":["RETAIL"],"parameters":[{"name":"loanId","in":"path","type":"string","required":true,"description":""},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"cancelArrangementResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse","default":"ArrangementErrorResponse"}},{"method":"POST","path":"/holdings/loans/creditLines","fullPath":"/api/v1.0.0/holdings/loans/creditLines","operationId":"createlineOfCredit","name":"Create a lines of credit account","summary":"Create a lines of credit account","tags":["RETAIL"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"createlineOfCreditResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse","default":"ArrangementErrorResponse"}},{"method":"POST","path":"/holdings/loans","fullPath":"/api/v1.0.0/holdings/loans","operationId":"createLoans","name":"Creates a loan for the given product","summary":"Creates a loan for the given product","tags":["RETAIL"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"createloansResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse","default":"ArrangementErrorResponse"}},{"method":"POST","path":"/holdings/loans/vehicleLoans","fullPath":"/api/v1.0.0/holdings/loans/vehicleLoans","operationId":"createvehicleLoan","name":"Creates a vehicle loan for the given product","summary":"Creates a vehicle loan for the given product","tags":["RETAIL"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"createvehicleLoanResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse","default":"ArrangementErrorResponse"}},{"method":"POST","path":"/holdings/loans/personalLoans","fullPath":"/api/v1.0.0/holdings/loans/personalLoans","operationId":"createPersonalLoan","name":"Create a personal loan account","summary":"Create a personal loan account","tags":[],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"createpersonalLoansResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse","default":"ArrangementErrorResponse"}},{"method":"POST","path":"/holdings/loans/consumerLoans","fullPath":"/api/v1.0.0/holdings/loans/consumerLoans","operationId":"createConsumerLoan","name":"creates a consumer loan for the given product","summary":"Creates a consumer loan for the given product","tags":["RETAIL"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"createConsumerLoanResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse","default":"ArrangementErrorResponse"}},{"method":"PUT","path":"/holdings/loans/{loanId}/renegotiations","fullPath":"/api/v1.0.0/holdings/loans/{loanId}/renegotiations","operationId":"updateLoanConditions","name":"Perform the renegotiation of the loan contract details such as payment frequency, interest rates, etc.","summary":"Perform the renegotiation of the loan contract details","tags":["RETAIL"],"parameters":[{"name":"loanId","in":"path","type":"string","required":true,"description":""},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"updateLoanConditionsResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse","default":"ArrangementErrorResponse"}},{"method":"PUT","path":"/holdings/loans/{loanId}/accounts","fullPath":"/api/v1.0.0/holdings/loans/{loanId}/accounts","operationId":"updateLoanAccount","name":"Update the account conditions of the loan such as alternate references, posting restrictions, etc","summary":"Update the account conditions of the loan","tags":["RETAIL"],"parameters":[{"name":"loanId","in":"path","type":"string","required":true,"description":""},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"updateLoanAccountResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse","default":"ArrangementErrorResponse"}},{"method":"PUT","path":"/holdings/loans/{loanId}/interestConditions","fullPath":"/api/v1.0.0/holdings/loans/{loanId}/interestConditions","operationId":"updateLoanInterest","name":"Update the interest conditions of the loan such as interest rate, spread, margin etc","summary":"Update the interest conditions of the loan","tags":["RETAIL"],"parameters":[{"name":"loanId","in":"path","type":"string","required":true,"description":""},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"updateLoanInterestResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse","default":"ArrangementErrorResponse"}},{"method":"PUT","path":"/holdings/loans/{loanId}/chargeOffs","fullPath":"/api/v1.0.0/holdings/loans/{loanId}/chargeOffs","operationId":"createChargeOffActivity","name":"Execute loan charge-off activity to charge-off account balance only","summary":"Execute loan charge-off activity to charge-off account balance only","tags":["RETAIL"],"parameters":[{"name":"loanId","in":"path","type":"string","required":true,"description":""},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"createChargeOffActivityResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse","default":"ArrangementErrorResponse"}},{"method":"PUT","path":"/holdings/loans/{loanId}/disbursements","fullPath":"/api/v1.0.0/holdings/loans/{loanId}/disbursements","operationId":"createLoanDisbursement","name":"Creates a disbursement of the given loan contracts commitment amount","summary":"Disburses the loan commitment amount","tags":["RETAIL"],"parameters":[{"name":"loanId","in":"path","type":"string","required":true,"description":""},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"createLoanDisbursementResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse","default":"ArrangementErrorResponse"}},{"method":"PUT","path":"/holdings/loans/{loanId}/customers","fullPath":"/api/v1.0.0/holdings/loans/{loanId}/customers","operationId":"updateLoansCustomer","name":"Updates the customer for the given loan contract","summary":"Updates the customer for the given loan contract","tags":["RETAIL"],"parameters":[{"name":"loanId","in":"path","type":"string","required":true,"description":""},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"updateLoansCustomerResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse","default":"ArrangementErrorResponse"}},{"method":"PUT","path":"/holdings/loans/{loanId}/commitmentIncreases","fullPath":"/api/v1.0.0/holdings/loans/{loanId}/commitmentIncreases","operationId":"updateLoanTopupAmount","name":"Increases the commitment amount of the loan","summary":"Increases the commitment amount of the given loan contract","tags":["RETAIL"],"parameters":[{"name":"loanId","in":"path","type":"string","required":true,"description":""},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"updateLoanTopupAmountResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse","default":"ArrangementErrorResponse"}},{"method":"PUT","path":"/holdings/loans/{loanId}/commitmentDecreases","fullPath":"/api/v1.0.0/holdings/loans/{loanId}/commitmentDecreases","operationId":"updateLoanDecreaseAmount","name":"Decreases the commitment amount of the loan","summary":"Decreases the commitment amount of the given loan contract","tags":["RETAIL"],"parameters":[{"name":"loanId","in":"path","type":"string","required":true,"description":""},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"updateLoanDecreaseAmountResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse","default":"ArrangementErrorResponse"}},{"method":"PUT","path":"/holdings/loans/{loanId}/repaymentDates","fullPath":"/api/v1.0.0/holdings/loans/{loanId}/repaymentDates","operationId":"updateRepaymentDate","name":"Perform repayment date change for the loan product with details like loan reference, product id , etc.","summary":"Perform repayment date change for the loan","tags":["RETAIL"],"parameters":[{"name":"loanId","in":"path","type":"string","required":true,"description":""},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"updateRepaymentDateResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse","default":"ArrangementErrorResponse"}},{"method":"PUT","path":"/holdings/loans/{loanId}/writeOffs/balances","fullPath":"/api/v1.0.0/holdings/loans/{loanId}/writeOffs/balances","operationId":"initiateWriteOffBalanceLoans","name":"Perform a write off of the balances such as principal or interest or charge amount for the unpaid loans","summary":"Perform a loan balance write off","tags":["RETAIL"],"parameters":[{"name":"loanId","in":"path","type":"string","required":true,"description":""},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"initiateWriteOffBalanceLoansResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse","default":"ArrangementErrorResponse"}},{"method":"PUT","path":"/holdings/loans/{loanId}/writeOffs","fullPath":"/api/v1.0.0/holdings/loans/{loanId}/writeOffs","operationId":"initiateWriteOffLoans","name":"Perform a write off of the balances and bills such as principal or interest or charge amount for the unpaid loans","summary":"Perform a loan write off of balances and bills","tags":["RETAIL"],"parameters":[{"name":"loanId","in":"path","type":"string","required":true,"description":""},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"initiateWriteOffLoansResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse","default":"ArrangementErrorResponse"}},{"method":"PUT","path":"/holdings/loans/{loanId}/writeOffs/bills","fullPath":"/api/v1.0.0/holdings/loans/{loanId}/writeOffs/bills","operationId":"initiateWriteOffBillLoans","name":"Perform a write off of the bills such as interest or charge amount for the unpaid loans","summary":"Perform a write off bills of unpaid loans","tags":["RETAIL"],"parameters":[{"name":"loanId","in":"path","type":"string","required":true,"description":""},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"initiateWriteOffBillLoansResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse","default":"ArrangementErrorResponse"}},{"method":"POST","path":"/holdings/loans/linkedRateLoans","fullPath":"/api/v1.0.0/holdings/loans/linkedRateLoans","operationId":"createLinkedRateLoan","name":"Create a personal loan account with linked rate","summary":"Create a personal loan account with linked rate","tags":[],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"","400":"","500":"","default":""}},{"method":"POST","path":"/holdings/loans/commercialLoans","fullPath":"/api/v1.0.0/holdings/loans/commercialLoans","operationId":"createCommercialLoan","name":"Create a commercial or business account","summary":"Create a commercial or business account","tags":[],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"","400":"","500":"","default":""}},{"method":"POST","path":"/holdings/loans/mortgages","fullPath":"/api/v1.0.0/holdings/loans/mortgages","operationId":"createMortgage","name":"Create a mortgage loan","summary":"Create a mortgage loan","tags":[],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"","400":"","500":"","default":""}},{"method":"POST","path":"/holdings/facilities/installmentLoans","fullPath":"/api/v1.0.0/holdings/facilities/installmentLoans","operationId":"createInstallmentLoan","name":"Create an installment loan for the given product","summary":"Create an installment loan for the given product","tags":[],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"","400":"","500":"","default":""}},{"method":"POST","path":"/holdings/fundsTransfer","fullPath":"/api/v1.0.0/holdings/fundsTransfer","operationId":"createFundsTransfer","name":"Create an account transfer","summary":"Create an account transfer","tags":[],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"","400":"","500":"","default":""}},{"method":"PUT","path":"/holdings/loans/consumerLoans/{consumerLoanId}/disbursements","fullPath":"/api/v1.0.0/holdings/loans/consumerLoans/{consumerLoanId}/disbursements","operationId":"createConsumerLoanDisbursement","name":"Creates a disbursement of the given consumer loan contracts commitment amount","summary":"Disburses the consumer loan commitment amount","tags":["RETAIL"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"consumerLoanId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":null,"responses":{"200":"","400":"","500":"","default":""}},{"method":"PUT","path":"/holdings/loans/consumerLoans/{consumerLoanId}/commitmentIncreases","fullPath":"/api/v1.0.0/holdings/loans/consumerLoans/{consumerLoanId}/commitmentIncreases","operationId":"updateConsumerLoanTopupAmount","name":"Increases the commitment amount of the consumer loan","summary":"Increases the commitment amount of the given consumer loan contract","tags":["RETAIL"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"consumerLoanId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":null,"responses":{"200":"","400":"","500":"","default":""}},{"method":"PUT","path":"/holdings/loans/consumerLoans/{consumerLoanId}/commitmentDecreases","fullPath":"/api/v1.0.0/holdings/loans/consumerLoans/{consumerLoanId}/commitmentDecreases","operationId":"updateConsumerLoanDecreaseAmount","name":"Decreases the commitment amount of the consumer loan","summary":"Decreases the commitment amount of the given consumer loan contract","tags":["RETAIL"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"consumerLoanId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":null,"responses":{"200":"","400":"","500":"","default":""}},{"method":"PUT","path":"/holdings/loans/consumerLoans/{consumerLoanId}/repayments","fullPath":"/api/v1.0.0/holdings/loans/consumerLoans/{consumerLoanId}/repayments","operationId":"createConsumerLoanRepayment","name":"Creates the repayment of the given consumer loan amount","summary":"Repays the consumer loan amount","tags":["RETAIL"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"consumerLoanId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":null,"responses":{"200":"","400":"","500":"","default":""}},{"method":"PUT","path":"/holdings/loans/consumerLoans/{consumerLoanId}/principalDecreases","fullPath":"/api/v1.0.0/holdings/loans/consumerLoans/{consumerLoanId}/principalDecreases","operationId":"createConsumerLoanPrepayment","name":"Creates the advance repayment of the given consumer loan amount","summary":"Prepays the consumer loan amount","tags":["RETAIL"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"consumerLoanId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":null,"responses":{"200":"","400":"","500":"","default":""}},{"method":"PUT","path":"/holdings/loans/consumerLoans/{consumerLoanId}/schedules","fullPath":"/api/v1.0.0/holdings/loans/consumerLoans/{consumerLoanId}/schedules","operationId":"updateConsumerLoanSchedule","name":"Update the change of payment schedule for the given consumer loan contract","summary":"Update the payment schedule of the consumer loan","tags":["RETAIL"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"consumerLoanId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":null,"responses":{"200":"","400":"","500":"","default":""}},{"method":"PUT","path":"/holdings/loans/consumerLoans/{consumerLoanId}/paymentHolidays","fullPath":"/api/v1.0.0/holdings/loans/consumerLoans/{consumerLoanId}/paymentHolidays","operationId":"updateConsumerLoanHoliday","name":"Update of payment holiday for the given consumer loan contract","summary":"Update payment holiday for the consumer loan","tags":["RETAIL"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"consumerLoanId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":null,"responses":{"200":"","400":"","500":"","default":""}},{"method":"GET","path":"/holdings/loans/{loanId}/outstandingBills","fullPath":"/api/v1.0.0/holdings/loans/{loanId}/outstandingBills","operationId":"getLoanOutstandingBills","name":"Retrieves the outstanding amount to be paid for a loan","summary":"Retrieves the outstanding amount to be paid for the given loan","tags":["RETAIL"],"parameters":[{"name":"loanId","in":"path","type":"string","required":true,"description":"Denotes the arrangement id of the loan"},{"name":"fileVersion","in":"query","type":"string","required":false,"description":"Indicates if the file is of type simulation or live"},{"name":"simulationReference","in":"query","type":"string","required":false,"description":"Indicates the reference id for simulation activity"},{"name":"paymentDate","in":"query","type":"string","required":false,"description":"Contains the date in which the payment will be sent out. Date in the format YYYYMMDD. E.g. 20191231"},{"name":"deferDate","in":"query","type":"string","required":false,"description":"Date that the payment has been deferred to"},{"name":"billedAmount","in":"query","type":"string","required":false,"description":"Indicates the bill amount"},{"name":"outstandingAmount","in":"query","type":"string","required":false,"description":"Contains the aggregate outstanding principal amount thereof after giving effect to any borrowings and prepayments or repayments of Committed Loans"},{"name":"delinquentAmount","in":"query","type":"string","required":false,"description":"Indicates the bill amount during the ageing status(Bill which crossed the due date)"},{"name":"property","in":"query","type":"string","required":false,"description":"Id of the product property"},{"name":"billStatus","in":"query","type":"string","required":false,"description":"Indicates the status of a bill(Issued,Due,Ageing,Settled)"},{"name":"settlementStatus","in":"query","type":"string","required":false,"description":"Defines the status of the settlement for the incoming MT548 swift message.The values allowed are: Waiting : pending to receive settlement status update meaning pending to receive MT548 swift message, "},{"name":"agingStatus","in":"query","type":"string","required":false,"description":"Indicates the ageing status of a bill"},{"name":"settled","in":"query","type":"string","required":false,"description":"Flag to indicate whether a bill is settled or not"},{"name":"paymentType","in":"query","type":"string","required":false,"description":"Indicates if the payment is Customer (C) type or Bank (B) type"},{"name":"billDate","in":"query","type":"string","required":false,"description":"Indicates a date on which a bill has been raised"},{"name":"paymentMethod","in":"query","type":"string","required":false,"description":"Method chosen to make the payment"},{"name":"infoPayType","in":"query","type":"string","required":false,"description":"Indicates a bill which is raised when a loan is paid off"},{"name":"advancePayment","in":"query","type":"string","required":false,"description":"Indicates whether advance payment made is set on an account"},{"name":"paymentIndicator","in":"query","type":"string","required":false,"description":"Indicates whether its a credit/debit type of bill"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"","400":"","500":"","default":""}},{"method":"GET","path":"/holdings/loans/{loanId}/payoffCalculations","fullPath":"/api/v1.0.0/holdings/loans/{loanId}/payoffCalculations","operationId":"getLoanPayoffDetails","name":"Retrieves the payoff details of a loan","summary":"Retrieves the payoff details of the given loan","tags":["RETAIL"],"parameters":[{"name":"loanId","in":"path","type":"string","required":true,"description":"Denotes the arrangement id of the loan"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"","400":"","500":"","default":""}},{"method":"PUT","path":"/holdings/loans/consumerLoans/{consumerLoanId}/customers","fullPath":"/api/v1.0.0/holdings/loans/consumerLoans/{consumerLoanId}/customers","operationId":"updateConsumerLoansCustomer","name":"Updates the customers for the given consumer loan contract","summary":"Update the customers of the consumer loan ","tags":["RETAIL"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"consumerLoanId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":null,"responses":{"200":"","400":"","500":"","default":""}},{"method":"PUT","path":"/holdings/loans/consumerLoans/{consumerLoanId}/payoffs","fullPath":"/api/v1.0.0/holdings/loans/consumerLoans/{consumerLoanId}/payoffs","operationId":"createPayoffConsumerLoan","name":"Creates the payoff of the given consumer loan contract amount","summary":"Payoffs the consumer loan amount","tags":["RETAIL"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"consumerLoanId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":null,"responses":{"200":"","400":"","500":"","default":""}},{"method":"PUT","path":"/holdings/loans/consumerLoans/{consumerLoanId}/renegotiations","fullPath":"/api/v1.0.0/holdings/loans/consumerLoans/{consumerLoanId}/renegotiations","operationId":"updateConsumerLoanConditions","name":"Creates the renegotiation of the given consumer loan contract details","summary":"Renegotiates the consumer loan contract details","tags":["RETAIL"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"consumerLoanId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":null,"responses":{"200":"","400":"","500":"","default":""}},{"method":"GET","path":"/holdings/loans/{loanId}/status","fullPath":"/api/v1.0.0/holdings/loans/{loanId}/status","operationId":"getArrangementDetails","name":"Retrieves the status of a loan","summary":"Retrieves the status of the given loan","tags":["RETAIL"],"parameters":[{"name":"loanId","in":"path","type":"string","required":true,"description":"Denotes the arrangement id of the loan"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"","400":"","500":"","default":""}},{"method":"GET","path":"/holdings/loans/arrangements/activities/{arrangementActivityId}/status","fullPath":"/api/v1.0.0/holdings/loans/arrangements/activities/{arrangementActivityId}/status","operationId":"getExternalEventStatus","name":"Retrieves the status of the given activity ","summary":"Retrieves the status of the given activity ","tags":["RETAIL"],"parameters":[{"name":"arrangementActivityId","in":"path","type":"string","required":true,"description":"Contains the arrangement activity reference identifier"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"","400":"","500":"","default":""}},{"method":"PUT","path":"/holdings/loans/consumerLoans/{consumerLoanId}/payoffCalculations","fullPath":"/api/v1.0.0/holdings/loans/consumerLoans/{consumerLoanId}/payoffCalculations","operationId":"calculatePayoffConsumerLoans","name":"Creates calculates payoff activity to calculate consumer loan payment amount to close the given loan","summary":"Calculates consumer loan payment amount to close a loan","tags":["RETAIL"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"consumerLoanId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":null,"responses":{"200":"","400":"","500":"","default":""}},{"method":"GET","path":"/holdings/loans/{loanId}/schedules","fullPath":"/api/v1.0.0/holdings/loans/{loanId}/schedules","operationId":"getPaymentSchedulesProjection","name":"Retrieves the schedule payment information for paid and upcoming installments details","summary":"Retrieves payment schedules details","tags":["RETAIL"],"parameters":[{"name":"loanId","in":"path","type":"string","required":true,"description":"Denotes the arrangement id of the loan"},{"name":"dateFrom","in":"query","type":"string","required":false,"description":"Start date of the loan"},{"name":"dateTo","in":"query","type":"string","required":false,"description":"End date of the loan"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"","400":"","500":"","default":""}},{"method":"GET","path":"/holdings/loans/{loanId}/loanDetails","fullPath":"/api/v1.0.0/holdings/loans/{loanId}/loanDetails","operationId":"getLoanOverview","name":"Retrieves the details of the given loan","summary":"Retrieves loan details ","tags":["RETAIL"],"parameters":[{"name":"loanId","in":"path","type":"string","required":true,"description":"Denotes the arrangement id of the loan"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"","400":"","500":"","default":""}},{"method":"GET","path":"/holdings/loans/{loanId}/bills","fullPath":"/api/v1.0.0/holdings/loans/{loanId}/bills","operationId":"getLoanBills","name":"Retrieves the simulation details of the contract based on the selection criteria. It returns the bill details of the loan","summary":"Retrieves loan bills details","tags":[],"parameters":[{"name":"loanId","in":"path","type":"string","required":true,"description":"Denotes the arrangement id of the loan"},{"name":"billType","in":"query","type":"string","required":false,"description":"The type of payment obligation generated"},{"name":"paymentDate","in":"query","type":"string","required":false,"description":"Contains the date in which the payment will be sent out. Date in the format YYYYMMDD. E.g. 20191231"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"","400":"","500":"","default":""}},{"method":"GET","path":"/holdings/loans/{loanId}/collaterals","fullPath":"/api/v1.0.0/holdings/loans/{loanId}/collaterals","operationId":"getLoanCollaterals","name":"Retrieves the collateral details linked to the loan arrangement.","summary":"Retrieves loan collateral details","tags":[],"parameters":[{"name":"loanId","in":"path","type":"string","required":true,"description":"Denotes the arrangement id of the loan"},{"name":"status","in":"query","type":"string","required":false,"description":"Contains status of the data rights request.Allowed values are INITIATED, INPROGESS, EXTENDED, COMPLETED, REJECTED."},{"name":"statusNE","in":"query","type":"string","required":false,"description":"Status not equal to"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"","400":"","500":"","default":""}},{"method":"GET","path":"/holdings/loans/{loanId}","fullPath":"/api/v1.0.0/holdings/loans/{loanId}","operationId":"getLoanDetails","name":"Retrieves loan details","summary":"Retrieves the loan account details","tags":[],"parameters":[{"name":"loanId","in":"path","type":"string","required":true,"description":"Denotes the arrangement id of the loan"},{"name":"dateFrom","in":"query","type":"string","required":false,"description":"Start date of the loan"},{"name":"dateTo","in":"query","type":"string","required":false,"description":"End date of the loan"},{"name":"balanceTypes","in":"query","type":"string","required":false,"description":"Type of balance (e.g. current balance, credit interest accrued, deferred commission, etc.) as defined in the institution's accounting schemas."},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"","400":"","500":"","default":""}},{"method":"GET","path":"/holdings/loans/{loanId}/schedulePaymentFrequencies","fullPath":"/api/v1.0.0/holdings/loans/{loanId}/schedulePaymentFrequencies","operationId":"getPaymentSchedules","name":"Retrieves the schedule payment information for paid and upcoming installments details","summary":"Retrieves payment schedules details","tags":[],"parameters":[{"name":"loanId","in":"path","type":"string","required":true,"description":"Denotes the arrangement id of the loan"},{"name":"dateFrom","in":"query","type":"string","required":false,"description":"Start date of the loan"},{"name":"dateTo","in":"query","type":"string","required":false,"description":"End date of the loan"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"","400":"","500":"","default":""}},{"method":"POST","path":"/holdings/simulationCapture/{arrangementId}","fullPath":"/api/v1.0.0/holdings/simulationCapture/{arrangementId}","operationId":"createSimulationCapture","name":"Simulate payoff calculate activity for a loan arrangement","summary":"Simulate payoff calculate activity for a loan arrangement","tags":[],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"arrangementId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":null,"responses":{"200":"","400":"","500":"","default":""}},{"method":"POST","path":"/holdings/loans/simulations","fullPath":"/api/v1.0.0/holdings/loans/simulations","operationId":"createLoanSimulation","name":"Create a simulation for loan product with details like customer identifier, currency, etc.","summary":"Create simulation for loan products","tags":["RETAIL"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"","400":"","500":"","default":""}},{"method":"PUT","path":"/holdings/loans/simulations/{simulationId}","fullPath":"/api/v1.0.0/holdings/loans/simulations/{simulationId}","operationId":"updateLoanSimulation","name":"Update a simulation for loan product with details like customer identifier, currency, etc.","summary":"Update a simulation for loan products","tags":["RETAIL"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"simulationId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":null,"responses":{"200":"","400":"","500":"","default":""}},{"method":"POST","path":"/holdings/loans/{loanId}/simulations/payoffs","fullPath":"/api/v1.0.0/holdings/loans/{loanId}/simulations/payoffs","operationId":"createLoanPayoffSimulation","name":"Create a simulation payoff activity for loan product with product id details","summary":"Create simulation payoff activity for loan products","tags":["RETAIL"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"loanId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":null,"responses":{"200":"","400":"","500":"","default":""}},{"method":"POST","path":"/holdings/loans/{loanId}/payoffs","fullPath":"/api/v1.0.0/holdings/loans/{loanId}/payoffs","operationId":"createLoanArrangementPayoff","name":"Execute payoff activity for loan product with details like simulation run reference, product id , etc.","summary":"Execute payoff activity for loan products","tags":["RETAIL"],"parameters":[{"name":"loanId","in":"path","type":"string","required":true,"description":""},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"createLoanArrangementPayoffResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse","default":"ArrangementErrorResponse"}},{"method":"GET","path":"/holdings/loans/{loanId}/overpayments","fullPath":"/api/v1.0.0/holdings/loans/{loanId}/overpayments","operationId":"getOverpaymentDetails","name":"Retrieves the product id, type of overpay, overpay limit, overpay period, utilised overpay and remaining overpay limit of a loan arrangement","summary":"Retrieves overpayment details that has happened for a loan arrangement","tags":["RETAIL"],"parameters":[{"name":"loanId","in":"path","type":"string","required":true,"description":"Denotes the arrangement id of the loan"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"","400":"","500":"","default":""}},{"method":"POST","path":"/holdings/loans/drawdowns/offers","fullPath":"/api/v1.0.0/holdings/loans/drawdowns/offers","operationId":"createLoanDrawdownOffer","name":"Creates a new drawdown offer for the required customer.","summary":"Creates a new drawdown offer for the required customer.","tags":[],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"","400":"","500":"","default":""}},{"method":"POST","path":"/holdings/loans/{loanId}/drawdowns/acceptances","fullPath":"/api/v1.0.0/holdings/loans/{loanId}/drawdowns/acceptances","operationId":"createLoanDrawdownOfferAcceptance","name":"Accept the offer drawdown for the retail loan and convert offer drawdown into a live loan arrangement.","summary":"Accept the offer drawdown for the retail loan and convert offer drawdown into a live loan arrangement.","tags":[],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"loanId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":null,"responses":{"200":"","400":"","500":"","default":""}},{"method":"POST","path":"/holdings/loans/{loanId}/drawdowns/renegotiations","fullPath":"/api/v1.0.0/holdings/loans/{loanId}/drawdowns/renegotiations","operationId":"createLoanDrawdownOfferRenegotiation","name":"Renegotiate the offer drawdown for the retail loan and convert offer drawdown into live loan arrangement.","summary":"Renegotiate the offer drawdown for the required customer.","tags":[],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"loanId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":null,"responses":{"200":"","400":"","500":"","default":""}},{"method":"POST","path":"/holdings/loans/{loanId}/drawdowns/cancellations","fullPath":"/api/v1.0.0/holdings/loans/{loanId}/drawdowns/cancellations","operationId":"cancelLoanDrawdownOffer","name":"Cancellation of offer drawdown for the required customer.","summary":"Cancellation of offer drawdown for the required customer.","tags":[],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"loanId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":null,"responses":{"200":"","400":"","500":"","default":""}},{"method":"POST","path":"/holdings/loans/{loanId}/drawdowns/acceptances/schedules","fullPath":"/api/v1.0.0/holdings/loans/{loanId}/drawdowns/acceptances/schedules","operationId":"createLoanDrawdownOfferAcceptanceSchedules","name":"Accept the offer drawdown for the retail loan and convert offer drawdown into a live loan arrangement and retrieve the payment schedule details.","summary":"Accept the offer drawdown for the retail loan and convert offer drawdown into a live loan arrangement and retrieve the payment schedule details.","tags":[],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"loanId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":null,"responses":{"200":"","400":"","500":"","default":""}},{"method":"POST","path":"/holdings/loans/{loanId}/drawdowns/renegotiations/schedules","fullPath":"/api/v1.0.0/holdings/loans/{loanId}/drawdowns/renegotiations/schedules","operationId":"createLoanDrawdownOfferRenegotiationSchedules","name":"Renegotiate the offer drawdown for the retail loan and convert offer drawdown into live loan arrangement and retrieve the payment schedule details.","summary":"Renegotiate the offer drawdown for the required customer and retrieve the payment schedule details.","tags":[],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"loanId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":null,"responses":{"200":"","400":"","500":"","default":""}},{"method":"PUT","path":"/holdings/loans/{LoanId}/settlements","fullPath":"/api/v1.0.0/holdings/loans/{LoanId}/settlements","operationId":"updateLoanSettlement","name":"Updates the settlement condition of the loan","summary":"Updates the settlement condition of the loan","tags":[],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"LoanId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":null,"responses":{"200":"","400":"","500":"","default":""}},{"method":"POST","path":"/holdings/loans/{loanId}/simulations/repayments","fullPath":"/api/v1.0.0/holdings/loans/{loanId}/simulations/repayments","operationId":"createRepaymentSimulation","name":"Simulate the pre payment of the given loan account","summary":"Simulate  the loan pre payment","tags":[],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"loanId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":null,"responses":{"200":"","400":"","500":"","default":""}},{"method":"POST","path":"/holdings/loans/{loanId}/simulations/repayments/schedules","fullPath":"/api/v1.0.0/holdings/loans/{loanId}/simulations/repayments/schedules","operationId":"createRepaymentSchedule","name":"Simulate the pre payment of the given loan amount and retrieve the payment schedule","summary":"Simulate the pre payment of the given loan amount and retrieve the payment schedule","tags":[],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"loanId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":null,"responses":{"200":"","400":"","500":"","default":""}},{"method":"PUT","path":"/holdings/loans/{loanId}/repaymentDates/schedules","fullPath":"/api/v1.0.0/holdings/loans/{loanId}/repaymentDates/schedules","operationId":"updateRepaymentDateAndSchedules","name":"Perform repayment date change for the loan product and retrieve the payment schedule , interest details etc.","summary":"Perform repayment date change for the loan and retrieve the payment schedule details.","tags":[],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"loanId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":null,"responses":{"200":"","400":"","500":"","default":""}},{"method":"POST","path":"/holdings/loans/{loanId}/simulations/repaymentDates","fullPath":"/api/v1.0.0/holdings/loans/{loanId}/simulations/repaymentDates","operationId":"createRepaymentDateChangeSimulation","name":"Simulate a loan arrangement for the given payment date","summary":"Simulate a loan arrangement for the given payment date","tags":[],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"loanId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":null,"responses":{"200":"","400":"","500":"","default":""}},{"method":"POST","path":"/holdings/loans/{loanId}/simulations/repaymentDates/schedules","fullPath":"/api/v1.0.0/holdings/loans/{loanId}/simulations/repaymentDates/schedules","operationId":"createRepaymentDateChangeSimulationSchedules","name":"Simulate a loan arrangement for the given payment date and retrieve the payments schedule , interest details etc.","summary":"Simulate a loan arrangement for the given payment date and retrieve the payments schedule details.","tags":[],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"loanId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":null,"responses":{"200":"","400":"","500":"","default":""}}]},{"key":"holdings-loans-arrangements-v6.6.0","title":"Loan creation","version":"v6.6.0","description":"API to create and manage various types of loans such as personal, commercial, mortgage, line of credit, etc","endpointCount":73,"endpoints":[{"method":"POST","path":"/holdings/loans/businessLoans","fullPath":"/api/v1.0.0/holdings/loans/businessLoans","operationId":"createBusinessLoan","name":"Creates a business banking loan for a single or joint customer","summary":"Creates a business banking loan for a single customer or more than one customer(like a joint account relationship) with the customer identifier, customer role, loan currency details","tags":["RETAIL"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"","default":"","400":"","500":""}},{"method":"POST","path":"/holdings/loans/migrations","fullPath":"/api/v1.0.0/holdings/loans/migrations","operationId":"initiateTakeoverloan","name":"Migration of a legacy system loan contract to the given product by providing the original contract date, principal amount, term, payment frequency and start date, etc. ","summary":"Migration of legacy system loan contract to the given product","tags":["RETAIL"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"","400":"","500":"","default":""}},{"method":"PUT","path":"/holdings/loans/{loanId}/balances/migrations","fullPath":"/api/v1.0.0/holdings/loans/{loanId}/balances/migrations","operationId":"captureBalance","name":"Captures the balance details of the mortgage loan such as balance type, due amount etc. This is used to migrate the balances of a legacy contract which is migrated from other system & update the balance details.","summary":"Captures outstanding balance details of of a contract migrated from legacy system","tags":["RETAIL"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"loanId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":null,"responses":{"200":"","400":"","500":"","default":""}},{"method":"PUT","path":"/holdings/loans/{loanId}/bills/migrations","fullPath":"/api/v1.0.0/holdings/loans/{loanId}/bills/migrations","operationId":"captureBills","name":"Captures the bill information of the loan such as bill id, property names, bill amount etc. This is used to migrate the bills of a legacy contract which is migrated from other system & update the bill details","summary":"Captures outstanding bill information of a contract migrated from legacy system.","tags":["RETAIL"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"loanId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":null,"responses":{"200":"","400":"","500":"","default":""}},{"method":"PUT","path":"/holdings/loans/{loanId}/products","fullPath":"/api/v1.0.0/holdings/loans/{loanId}/products","operationId":"updateChangeProduct","name":"Change loan from one product to another such as changing one loan product to another loan product","summary":"Change of contract from one loan product to another","tags":["RETAIL"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"loanId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":null,"responses":{"200":"","400":"","500":"","default":""}},{"method":"GET","path":"/holdings/loans/{loanId}/evidences","fullPath":"/api/v1.0.0/holdings/loans/{loanId}/evidences","operationId":"getEvidence","name":"Retrieves the covenants and conditions for a loan account. Covenants are requested in periodic basis and the Conditions are one-time evidence. On non-submission or non-compliance of the evidences, the related consequent activity will be restricted","summary":"Retrieves the covenants and conditions for a loan account.","tags":["RETAIL"],"parameters":[{"name":"loanId","in":"path","type":"string","required":true,"description":"Denotes the arrangement id of the loan"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"","400":"","500":"","default":""}},{"method":"PUT","path":"/holdings/loans/{loanId}/evidences","fullPath":"/api/v1.0.0/holdings/loans/{loanId}/evidences","operationId":"updateEvidence","name":"Performs update of covenants and conditions for a loan account. Covenants are requested in periodic basis and the Conditions are one-time evidence. On non-submission or non-compliance of the evidences, the related consequent activity will be restricted","summary":"Update the covenants and conditions for a loan account","tags":["RETAIL"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"loanId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":null,"responses":{"200":"","400":"","500":"","default":""}},{"method":"POST","path":"/holdings/loans/{loanId}/simulations/paymentHolidays","fullPath":"/api/v1.0.0/holdings/loans/{loanId}/simulations/paymentHolidays","operationId":"simulatePaymentHoliday","name":"Simulate payment holiday activity for a loan account","summary":"Simulate payment holiday activity for a loan account","tags":["RETAIL"],"parameters":[{"name":"loanId","in":"path","type":"string","required":true,"description":""},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"simulatePaymentHolidayResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse","default":"ArrangementErrorResponse"}},{"method":"GET","path":"/holdings/loans/{loanId}/simulations/paymentHolidays","fullPath":"/api/v1.0.0/holdings/loans/{loanId}/simulations/paymentHolidays","operationId":"getPaymentHolidaySim","name":"Retrieves payment holiday simulation details for the loan such as payment type, holiday date, original payment amount and new payment amount","summary":"Retrieves payment holiday simulation details for the loan","tags":["RETAIL"],"parameters":[{"name":"loanId","in":"path","type":"string","required":true,"description":"Denotes the arrangement id of the loan"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"","400":"","500":"","default":""}},{"method":"POST","path":"/holdings/loans/buyNowPayLater","fullPath":"/api/v1.0.0/holdings/loans/buyNowPayLater","operationId":"createBNPLLoan","name":"Creates a business banking loan for a single customer or more than one customer(like a joint account relationship) with the customer identifier, customer role, loan currency details","summary":"Creates a business banking loan for a single or joint customer","tags":["RETAIL"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"createBNPLLoanResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse","default":"ArrangementErrorResponse"}},{"method":"GET","path":"/holdings/loans/balances","fullPath":"/api/v1.0.0/holdings/loans/balances","operationId":"getLoanInformation","name":"Retrieves the loans details for a given customer id and alternate id or arrangement id of the buy now pay later loan.","summary":"Retrieve the buy now pay later loan details","tags":["RETAIL"],"parameters":[{"name":"customerId","in":"query","type":"string","required":false,"description":"Identifier of the customer"},{"name":"alternateId","in":"query","type":"string","required":false,"description":"An Alternate Identification for the Deal. This can be used to retrieve the Deal for amendment."},{"name":"arrangementId","in":"query","type":"string","required":false,"description":"Indicates an unique identifier of an account"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"LoanInformationResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse","default":"QueryErrorResponse"}},{"method":"PUT","path":"/holdings/loans/{loanId}/cancellations","fullPath":"/api/v1.0.0/holdings/loans/{loanId}/cancellations","operationId":"cancelArrangement","name":"Performs the full loan cancellation incase of preshipment return of products under buy now pay later loan.","summary":"Performs the loan cancellation for buy now pay later service","tags":["RETAIL"],"parameters":[{"name":"loanId","in":"path","type":"string","required":true,"description":""},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"cancelArrangementResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse","default":"ArrangementErrorResponse"}},{"method":"POST","path":"/holdings/loans/creditLines","fullPath":"/api/v1.0.0/holdings/loans/creditLines","operationId":"createlineOfCredit","name":"Create a lines of credit account","summary":"Create a lines of credit account","tags":["RETAIL"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"createlineOfCreditResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse","default":"ArrangementErrorResponse"}},{"method":"POST","path":"/holdings/loans","fullPath":"/api/v1.0.0/holdings/loans","operationId":"createLoans","name":"Creates a loan for the given product","summary":"Creates a loan for the given product","tags":["RETAIL"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"createloansResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse","default":"ArrangementErrorResponse"}},{"method":"POST","path":"/holdings/loans/vehicleLoans","fullPath":"/api/v1.0.0/holdings/loans/vehicleLoans","operationId":"createvehicleLoan","name":"Creates a vehicle loan for the given product","summary":"Creates a vehicle loan for the given product","tags":["RETAIL"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"createvehicleLoanResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse","default":"ArrangementErrorResponse"}},{"method":"POST","path":"/holdings/loans/personalLoans","fullPath":"/api/v1.0.0/holdings/loans/personalLoans","operationId":"createPersonalLoan","name":"Create a personal loan account","summary":"Create a personal loan account","tags":[],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"createpersonalLoansResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse","default":"ArrangementErrorResponse"}},{"method":"POST","path":"/holdings/loans/consumerLoans","fullPath":"/api/v1.0.0/holdings/loans/consumerLoans","operationId":"createConsumerLoan","name":"creates a consumer loan for the given product","summary":"Creates a consumer loan for the given product","tags":["RETAIL"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"createConsumerLoanResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse","default":"ArrangementErrorResponse"}},{"method":"PUT","path":"/holdings/loans/{loanId}/renegotiations","fullPath":"/api/v1.0.0/holdings/loans/{loanId}/renegotiations","operationId":"updateLoanConditions","name":"Perform the renegotiation of the loan contract details such as payment frequency, interest rates, etc.","summary":"Perform the renegotiation of the loan contract details","tags":["RETAIL"],"parameters":[{"name":"loanId","in":"path","type":"string","required":true,"description":""},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"updateLoanConditionsResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse","default":"ArrangementErrorResponse"}},{"method":"PUT","path":"/holdings/loans/{loanId}/accounts","fullPath":"/api/v1.0.0/holdings/loans/{loanId}/accounts","operationId":"updateLoanAccount","name":"Update the account conditions of the loan such as alternate references, posting restrictions, etc","summary":"Update the account conditions of the loan","tags":["RETAIL"],"parameters":[{"name":"loanId","in":"path","type":"string","required":true,"description":""},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"updateLoanAccountResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse","default":"ArrangementErrorResponse"}},{"method":"PUT","path":"/holdings/loans/{loanId}/interestConditions","fullPath":"/api/v1.0.0/holdings/loans/{loanId}/interestConditions","operationId":"updateLoanInterest","name":"Update the interest conditions of the loan such as interest rate, spread, margin etc","summary":"Update the interest conditions of the loan","tags":["RETAIL"],"parameters":[{"name":"loanId","in":"path","type":"string","required":true,"description":""},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"updateLoanInterestResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse","default":"ArrangementErrorResponse"}},{"method":"PUT","path":"/holdings/loans/{loanId}/chargeOffs","fullPath":"/api/v1.0.0/holdings/loans/{loanId}/chargeOffs","operationId":"createChargeOffActivity","name":"Execute loan charge-off activity to charge-off account balance only","summary":"Execute loan charge-off activity to charge-off account balance only","tags":["RETAIL"],"parameters":[{"name":"loanId","in":"path","type":"string","required":true,"description":""},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"createChargeOffActivityResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse","default":"ArrangementErrorResponse"}},{"method":"PUT","path":"/holdings/loans/{loanId}/disbursements","fullPath":"/api/v1.0.0/holdings/loans/{loanId}/disbursements","operationId":"createLoanDisbursement","name":"Creates a disbursement of the given loan contracts commitment amount","summary":"Disburses the loan commitment amount","tags":["RETAIL"],"parameters":[{"name":"loanId","in":"path","type":"string","required":true,"description":""},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"createLoanDisbursementResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse","default":"ArrangementErrorResponse"}},{"method":"PUT","path":"/holdings/loans/{loanId}/customers","fullPath":"/api/v1.0.0/holdings/loans/{loanId}/customers","operationId":"updateLoansCustomer","name":"Updates the customer for the given loan contract","summary":"Updates the customer for the given loan contract","tags":["RETAIL"],"parameters":[{"name":"loanId","in":"path","type":"string","required":true,"description":""},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"updateLoansCustomerResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse","default":"ArrangementErrorResponse"}},{"method":"PUT","path":"/holdings/loans/{loanId}/commitmentIncreases","fullPath":"/api/v1.0.0/holdings/loans/{loanId}/commitmentIncreases","operationId":"updateLoanTopupAmount","name":"Increases the commitment amount of the loan","summary":"Increases the commitment amount of the given loan contract","tags":["RETAIL"],"parameters":[{"name":"loanId","in":"path","type":"string","required":true,"description":""},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"updateLoanTopupAmountResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse","default":"ArrangementErrorResponse"}},{"method":"PUT","path":"/holdings/loans/{loanId}/commitmentDecreases","fullPath":"/api/v1.0.0/holdings/loans/{loanId}/commitmentDecreases","operationId":"updateLoanDecreaseAmount","name":"Decreases the commitment amount of the loan","summary":"Decreases the commitment amount of the given loan contract","tags":["RETAIL"],"parameters":[{"name":"loanId","in":"path","type":"string","required":true,"description":""},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"updateLoanDecreaseAmountResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse","default":"ArrangementErrorResponse"}},{"method":"PUT","path":"/holdings/loans/{loanId}/repaymentDates","fullPath":"/api/v1.0.0/holdings/loans/{loanId}/repaymentDates","operationId":"updateRepaymentDate","name":"Perform repayment date change for the loan product with details like loan reference, product id , etc.","summary":"Perform repayment date change for the loan","tags":["RETAIL"],"parameters":[{"name":"loanId","in":"path","type":"string","required":true,"description":""},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"updateRepaymentDateResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse","default":"ArrangementErrorResponse"}},{"method":"PUT","path":"/holdings/loans/{loanId}/writeOffs/balances","fullPath":"/api/v1.0.0/holdings/loans/{loanId}/writeOffs/balances","operationId":"initiateWriteOffBalanceLoans","name":"Perform a write off of the balances such as principal or interest or charge amount for the unpaid loans","summary":"Perform a loan balance write off","tags":["RETAIL"],"parameters":[{"name":"loanId","in":"path","type":"string","required":true,"description":""},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"initiateWriteOffBalanceLoansResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse","default":"ArrangementErrorResponse"}},{"method":"PUT","path":"/holdings/loans/{loanId}/writeOffs","fullPath":"/api/v1.0.0/holdings/loans/{loanId}/writeOffs","operationId":"initiateWriteOffLoans","name":"Perform a write off of the balances and bills such as principal or interest or charge amount for the unpaid loans","summary":"Perform a loan write off of balances and bills","tags":["RETAIL"],"parameters":[{"name":"loanId","in":"path","type":"string","required":true,"description":""},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"initiateWriteOffLoansResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse","default":"ArrangementErrorResponse"}},{"method":"PUT","path":"/holdings/loans/{loanId}/writeOffs/bills","fullPath":"/api/v1.0.0/holdings/loans/{loanId}/writeOffs/bills","operationId":"initiateWriteOffBillLoans","name":"Perform a write off of the bills such as interest or charge amount for the unpaid loans","summary":"Perform a write off bills of unpaid loans","tags":["RETAIL"],"parameters":[{"name":"loanId","in":"path","type":"string","required":true,"description":""},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"initiateWriteOffBillLoansResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse","default":"ArrangementErrorResponse"}},{"method":"POST","path":"/holdings/loans/linkedRateLoans","fullPath":"/api/v1.0.0/holdings/loans/linkedRateLoans","operationId":"createLinkedRateLoan","name":"Create a personal loan account with linked rate","summary":"Create a personal loan account with linked rate","tags":[],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"","400":"","500":"","default":""}},{"method":"POST","path":"/holdings/loans/commercialLoans","fullPath":"/api/v1.0.0/holdings/loans/commercialLoans","operationId":"createCommercialLoan","name":"Create a commercial or business account","summary":"Create a commercial or business account","tags":[],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"","400":"","500":"","default":""}},{"method":"POST","path":"/holdings/loans/mortgages","fullPath":"/api/v1.0.0/holdings/loans/mortgages","operationId":"createMortgage","name":"Create a mortgage loan","summary":"Create a mortgage loan","tags":[],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"","400":"","500":"","default":""}},{"method":"POST","path":"/holdings/facilities/installmentLoans","fullPath":"/api/v1.0.0/holdings/facilities/installmentLoans","operationId":"createInstallmentLoan","name":"Create an installment loan for the given product","summary":"Create an installment loan for the given product","tags":[],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"","400":"","500":"","default":""}},{"method":"POST","path":"/holdings/fundsTransfer","fullPath":"/api/v1.0.0/holdings/fundsTransfer","operationId":"createFundsTransfer","name":"Create an account transfer","summary":"Create an account transfer","tags":[],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"","400":"","500":"","default":""}},{"method":"PUT","path":"/holdings/loans/consumerLoans/{consumerLoanId}/disbursements","fullPath":"/api/v1.0.0/holdings/loans/consumerLoans/{consumerLoanId}/disbursements","operationId":"createConsumerLoanDisbursement","name":"Creates a disbursement of the given consumer loan contracts commitment amount","summary":"Disburses the consumer loan commitment amount","tags":["RETAIL"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"consumerLoanId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":null,"responses":{"200":"","400":"","500":"","default":""}},{"method":"PUT","path":"/holdings/loans/consumerLoans/{consumerLoanId}/commitmentIncreases","fullPath":"/api/v1.0.0/holdings/loans/consumerLoans/{consumerLoanId}/commitmentIncreases","operationId":"updateConsumerLoanTopupAmount","name":"Increases the commitment amount of the consumer loan","summary":"Increases the commitment amount of the given consumer loan contract","tags":["RETAIL"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"consumerLoanId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":null,"responses":{"200":"","400":"","500":"","default":""}},{"method":"PUT","path":"/holdings/loans/consumerLoans/{consumerLoanId}/commitmentDecreases","fullPath":"/api/v1.0.0/holdings/loans/consumerLoans/{consumerLoanId}/commitmentDecreases","operationId":"updateConsumerLoanDecreaseAmount","name":"Decreases the commitment amount of the consumer loan","summary":"Decreases the commitment amount of the given consumer loan contract","tags":["RETAIL"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"consumerLoanId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":null,"responses":{"200":"","400":"","500":"","default":""}},{"method":"PUT","path":"/holdings/loans/consumerLoans/{consumerLoanId}/repayments","fullPath":"/api/v1.0.0/holdings/loans/consumerLoans/{consumerLoanId}/repayments","operationId":"createConsumerLoanRepayment","name":"Creates the repayment of the given consumer loan amount","summary":"Repays the consumer loan amount","tags":["RETAIL"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"consumerLoanId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":null,"responses":{"200":"","400":"","500":"","default":""}},{"method":"PUT","path":"/holdings/loans/consumerLoans/{consumerLoanId}/principalDecreases","fullPath":"/api/v1.0.0/holdings/loans/consumerLoans/{consumerLoanId}/principalDecreases","operationId":"createConsumerLoanPrepayment","name":"Creates the advance repayment of the given consumer loan amount","summary":"Prepays the consumer loan amount","tags":["RETAIL"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"consumerLoanId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":null,"responses":{"200":"","400":"","500":"","default":""}},{"method":"PUT","path":"/holdings/loans/consumerLoans/{consumerLoanId}/schedules","fullPath":"/api/v1.0.0/holdings/loans/consumerLoans/{consumerLoanId}/schedules","operationId":"updateConsumerLoanSchedule","name":"Update the change of payment schedule for the given consumer loan contract","summary":"Update the payment schedule of the consumer loan","tags":["RETAIL"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"consumerLoanId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":null,"responses":{"200":"","400":"","500":"","default":""}},{"method":"PUT","path":"/holdings/loans/consumerLoans/{consumerLoanId}/paymentHolidays","fullPath":"/api/v1.0.0/holdings/loans/consumerLoans/{consumerLoanId}/paymentHolidays","operationId":"updateConsumerLoanHoliday","name":"Update of payment holiday for the given consumer loan contract","summary":"Update payment holiday for the consumer loan","tags":["RETAIL"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"consumerLoanId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":null,"responses":{"200":"","400":"","500":"","default":""}},{"method":"GET","path":"/holdings/loans/{loanId}/outstandingBills","fullPath":"/api/v1.0.0/holdings/loans/{loanId}/outstandingBills","operationId":"getLoanOutstandingBills","name":"Retrieves the outstanding amount to be paid for a loan","summary":"Retrieves the outstanding amount to be paid for the given loan","tags":["RETAIL"],"parameters":[{"name":"loanId","in":"path","type":"string","required":true,"description":"Denotes the arrangement id of the loan"},{"name":"fileVersion","in":"query","type":"string","required":false,"description":"Indicates if the file is of type simulation or live"},{"name":"simulationReference","in":"query","type":"string","required":false,"description":"Indicates the reference id for simulation activity"},{"name":"paymentDate","in":"query","type":"string","required":false,"description":"Contains the date in which the payment will be sent out. Date in the format YYYYMMDD. E.g. 20191231"},{"name":"deferDate","in":"query","type":"string","required":false,"description":"Date that the payment has been deferred to"},{"name":"billedAmount","in":"query","type":"string","required":false,"description":"Indicates the bill amount"},{"name":"outstandingAmount","in":"query","type":"string","required":false,"description":"Contains the aggregate outstanding principal amount thereof after giving effect to any borrowings and prepayments or repayments of Committed Loans"},{"name":"delinquentAmount","in":"query","type":"string","required":false,"description":"Indicates the bill amount during the ageing status(Bill which crossed the due date)"},{"name":"property","in":"query","type":"string","required":false,"description":"Id of the product property"},{"name":"billStatus","in":"query","type":"string","required":false,"description":"Indicates the status of a bill(Issued,Due,Ageing,Settled)"},{"name":"settlementStatus","in":"query","type":"string","required":false,"description":"Defines the status of the settlement for the incoming MT548 swift message.The values allowed are: Waiting : pending to receive settlement status update meaning pending to receive MT548 swift message, "},{"name":"agingStatus","in":"query","type":"string","required":false,"description":"Indicates the ageing status of a bill"},{"name":"settled","in":"query","type":"string","required":false,"description":"Flag to indicate whether a bill is settled or not"},{"name":"paymentType","in":"query","type":"string","required":false,"description":"Indicates if the payment is Customer (C) type or Bank (B) type"},{"name":"billDate","in":"query","type":"string","required":false,"description":"Indicates a date on which a bill has been raised"},{"name":"paymentMethod","in":"query","type":"string","required":false,"description":"Method chosen to make the payment"},{"name":"infoPayType","in":"query","type":"string","required":false,"description":"Indicates a bill which is raised when a loan is paid off"},{"name":"advancePayment","in":"query","type":"string","required":false,"description":"Indicates whether advance payment made is set on an account"},{"name":"paymentIndicator","in":"query","type":"string","required":false,"description":"Indicates whether its a credit/debit type of bill"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"","400":"","500":"","default":""}},{"method":"GET","path":"/holdings/loans/{loanId}/payoffCalculations","fullPath":"/api/v1.0.0/holdings/loans/{loanId}/payoffCalculations","operationId":"getLoanPayoffDetails","name":"Retrieves the payoff details of a loan","summary":"Retrieves the payoff details of the given loan","tags":["RETAIL"],"parameters":[{"name":"loanId","in":"path","type":"string","required":true,"description":"Denotes the arrangement id of the loan"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"","400":"","500":"","default":""}},{"method":"PUT","path":"/holdings/loans/consumerLoans/{consumerLoanId}/customers","fullPath":"/api/v1.0.0/holdings/loans/consumerLoans/{consumerLoanId}/customers","operationId":"updateConsumerLoansCustomer","name":"Updates the customers for the given consumer loan contract","summary":"Update the customers of the consumer loan ","tags":["RETAIL"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"consumerLoanId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":null,"responses":{"200":"","400":"","500":"","default":""}},{"method":"PUT","path":"/holdings/loans/consumerLoans/{consumerLoanId}/payoffs","fullPath":"/api/v1.0.0/holdings/loans/consumerLoans/{consumerLoanId}/payoffs","operationId":"createPayoffConsumerLoan","name":"Creates the payoff of the given consumer loan contract amount","summary":"Payoffs the consumer loan amount","tags":["RETAIL"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"consumerLoanId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":null,"responses":{"200":"","400":"","500":"","default":""}},{"method":"PUT","path":"/holdings/loans/consumerLoans/{consumerLoanId}/renegotiations","fullPath":"/api/v1.0.0/holdings/loans/consumerLoans/{consumerLoanId}/renegotiations","operationId":"updateConsumerLoanConditions","name":"Creates the renegotiation of the given consumer loan contract details","summary":"Renegotiates the consumer loan contract details","tags":["RETAIL"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"consumerLoanId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":null,"responses":{"200":"","400":"","500":"","default":""}},{"method":"GET","path":"/holdings/loans/{loanId}/status","fullPath":"/api/v1.0.0/holdings/loans/{loanId}/status","operationId":"getArrangementDetails","name":"Retrieves the status of a loan","summary":"Retrieves the status of the given loan","tags":["RETAIL"],"parameters":[{"name":"loanId","in":"path","type":"string","required":true,"description":"Denotes the arrangement id of the loan"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"","400":"","500":"","default":""}},{"method":"GET","path":"/holdings/loans/arrangements/activities/{arrangementActivityId}/status","fullPath":"/api/v1.0.0/holdings/loans/arrangements/activities/{arrangementActivityId}/status","operationId":"getExternalEventStatus","name":"Retrieves the status of the given activity ","summary":"Retrieves the status of the given activity ","tags":["RETAIL"],"parameters":[{"name":"arrangementActivityId","in":"path","type":"string","required":true,"description":"Contains the arrangement activity reference identifier"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"","400":"","500":"","default":""}},{"method":"PUT","path":"/holdings/loans/consumerLoans/{consumerLoanId}/payoffCalculations","fullPath":"/api/v1.0.0/holdings/loans/consumerLoans/{consumerLoanId}/payoffCalculations","operationId":"calculatePayoffConsumerLoans","name":"Creates calculates payoff activity to calculate consumer loan payment amount to close the given loan","summary":"Calculates consumer loan payment amount to close a loan","tags":["RETAIL"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"consumerLoanId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":null,"responses":{"200":"","400":"","500":"","default":""}},{"method":"GET","path":"/holdings/loans/{loanId}/schedules","fullPath":"/api/v1.0.0/holdings/loans/{loanId}/schedules","operationId":"getPaymentSchedulesProjection","name":"Retrieves the schedule payment information for paid and upcoming installments details","summary":"Retrieves payment schedules details","tags":["RETAIL"],"parameters":[{"name":"loanId","in":"path","type":"string","required":true,"description":"Denotes the arrangement id of the loan"},{"name":"dateFrom","in":"query","type":"string","required":false,"description":"Start date of the loan"},{"name":"dateTo","in":"query","type":"string","required":false,"description":"End date of the loan"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"","400":"","500":"","default":""}},{"method":"GET","path":"/holdings/loans/{loanId}/loanDetails","fullPath":"/api/v1.0.0/holdings/loans/{loanId}/loanDetails","operationId":"getLoanOverview","name":"Retrieves the details of the given loan","summary":"Retrieves loan details ","tags":["RETAIL"],"parameters":[{"name":"loanId","in":"path","type":"string","required":true,"description":"Denotes the arrangement id of the loan"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"","400":"","500":"","default":""}},{"method":"GET","path":"/holdings/loans/{loanId}/bills","fullPath":"/api/v1.0.0/holdings/loans/{loanId}/bills","operationId":"getLoanBills","name":"Retrieves the simulation details of the contract based on the selection criteria. It returns the bill details of the loan","summary":"Retrieves loan bills details","tags":[],"parameters":[{"name":"loanId","in":"path","type":"string","required":true,"description":"Denotes the arrangement id of the loan"},{"name":"billType","in":"query","type":"string","required":false,"description":"The type of payment obligation generated"},{"name":"paymentDate","in":"query","type":"string","required":false,"description":"Contains the date in which the payment will be sent out. Date in the format YYYYMMDD. E.g. 20191231"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"","400":"","500":"","default":""}},{"method":"GET","path":"/holdings/loans/{loanId}/collaterals","fullPath":"/api/v1.0.0/holdings/loans/{loanId}/collaterals","operationId":"getLoanCollaterals","name":"Retrieves the collateral details linked to the loan arrangement.","summary":"Retrieves loan collateral details","tags":[],"parameters":[{"name":"loanId","in":"path","type":"string","required":true,"description":"Denotes the arrangement id of the loan"},{"name":"status","in":"query","type":"string","required":false,"description":"Contains status of the data rights request.Allowed values are INITIATED, INPROGESS, EXTENDED, COMPLETED, REJECTED."},{"name":"statusNE","in":"query","type":"string","required":false,"description":"Status not equal to"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"","400":"","500":"","default":""}},{"method":"GET","path":"/holdings/loans/{loanId}","fullPath":"/api/v1.0.0/holdings/loans/{loanId}","operationId":"getLoanDetails","name":"Retrieves loan details","summary":"Retrieves the loan account details","tags":[],"parameters":[{"name":"loanId","in":"path","type":"string","required":true,"description":"Denotes the arrangement id of the loan"},{"name":"dateFrom","in":"query","type":"string","required":false,"description":"Start date of the loan"},{"name":"dateTo","in":"query","type":"string","required":false,"description":"End date of the loan"},{"name":"balanceTypes","in":"query","type":"string","required":false,"description":"Type of balance (e.g. current balance, credit interest accrued, deferred commission, etc.) as defined in the institution's accounting schemas."},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"","400":"","500":"","default":""}},{"method":"GET","path":"/holdings/loans/{loanId}/schedulePaymentFrequencies","fullPath":"/api/v1.0.0/holdings/loans/{loanId}/schedulePaymentFrequencies","operationId":"getPaymentSchedules","name":"Retrieves the schedule payment information for paid and upcoming installments details","summary":"Retrieves payment schedules details","tags":[],"parameters":[{"name":"loanId","in":"path","type":"string","required":true,"description":"Denotes the arrangement id of the loan"},{"name":"dateFrom","in":"query","type":"string","required":false,"description":"Start date of the loan"},{"name":"dateTo","in":"query","type":"string","required":false,"description":"End date of the loan"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"","400":"","500":"","default":""}},{"method":"POST","path":"/holdings/simulationCapture/{arrangementId}","fullPath":"/api/v1.0.0/holdings/simulationCapture/{arrangementId}","operationId":"createSimulationCapture","name":"Simulate payoff calculate activity for a loan arrangement","summary":"Simulate payoff calculate activity for a loan arrangement","tags":[],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"arrangementId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":null,"responses":{"200":"","400":"","500":"","default":""}},{"method":"POST","path":"/holdings/loans/simulations","fullPath":"/api/v1.0.0/holdings/loans/simulations","operationId":"createLoanSimulation","name":"Create a simulation for loan product with details like customer identifier, currency, etc.","summary":"Create simulation for loan products","tags":["RETAIL"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"","400":"","500":"","default":""}},{"method":"PUT","path":"/holdings/loans/simulations/{simulationId}","fullPath":"/api/v1.0.0/holdings/loans/simulations/{simulationId}","operationId":"updateLoanSimulation","name":"Update a simulation for loan product with details like customer identifier, currency, etc.","summary":"Update a simulation for loan products","tags":["RETAIL"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"simulationId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":null,"responses":{"200":"","400":"","500":"","default":""}},{"method":"POST","path":"/holdings/loans/{loanId}/simulations/payoffs","fullPath":"/api/v1.0.0/holdings/loans/{loanId}/simulations/payoffs","operationId":"createLoanPayoffSimulation","name":"Create a simulation payoff activity for loan product with product id details","summary":"Create simulation payoff activity for loan products","tags":["RETAIL"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"loanId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":null,"responses":{"200":"","400":"","500":"","default":""}},{"method":"POST","path":"/holdings/loans/{loanId}/payoffs","fullPath":"/api/v1.0.0/holdings/loans/{loanId}/payoffs","operationId":"createLoanArrangementPayoff","name":"Execute payoff activity for loan product with details like simulation run reference, product id , etc.","summary":"Execute payoff activity for loan products","tags":["RETAIL"],"parameters":[{"name":"loanId","in":"path","type":"string","required":true,"description":""},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"createLoanArrangementPayoffResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse","default":"ArrangementErrorResponse"}},{"method":"GET","path":"/holdings/loans/{loanId}/overpayments","fullPath":"/api/v1.0.0/holdings/loans/{loanId}/overpayments","operationId":"getOverpaymentDetails","name":"Retrieves the product id, type of overpay, overpay limit, overpay period, utilised overpay and remaining overpay limit of a loan arrangement","summary":"Retrieves overpayment details that has happened for a loan arrangement","tags":["RETAIL"],"parameters":[{"name":"loanId","in":"path","type":"string","required":true,"description":"Denotes the arrangement id of the loan"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"","400":"","500":"","default":""}},{"method":"POST","path":"/holdings/loans/drawdowns/offers","fullPath":"/api/v1.0.0/holdings/loans/drawdowns/offers","operationId":"createLoanDrawdownOffer","name":"Creates a new drawdown offer for the required customer.","summary":"Creates a new drawdown offer for the required customer.","tags":[],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"","400":"","500":"","default":""}},{"method":"POST","path":"/holdings/loans/{loanId}/drawdowns/acceptances","fullPath":"/api/v1.0.0/holdings/loans/{loanId}/drawdowns/acceptances","operationId":"createLoanDrawdownOfferAcceptance","name":"Accept the offer drawdown for the retail loan and convert offer drawdown into a live loan arrangement.","summary":"Accept the offer drawdown for the retail loan and convert offer drawdown into a live loan arrangement.","tags":[],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"loanId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":null,"responses":{"200":"","400":"","500":"","default":""}},{"method":"POST","path":"/holdings/loans/{loanId}/drawdowns/renegotiations","fullPath":"/api/v1.0.0/holdings/loans/{loanId}/drawdowns/renegotiations","operationId":"createLoanDrawdownOfferRenegotiation","name":"Renegotiate the offer drawdown for the retail loan and convert offer drawdown into live loan arrangement.","summary":"Renegotiate the offer drawdown for the required customer.","tags":[],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"loanId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":null,"responses":{"200":"","400":"","500":"","default":""}},{"method":"POST","path":"/holdings/loans/{loanId}/drawdowns/cancellations","fullPath":"/api/v1.0.0/holdings/loans/{loanId}/drawdowns/cancellations","operationId":"cancelLoanDrawdownOffer","name":"Cancellation of offer drawdown for the required customer.","summary":"Cancellation of offer drawdown for the required customer.","tags":[],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"loanId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":null,"responses":{"200":"","400":"","500":"","default":""}},{"method":"POST","path":"/holdings/loans/{loanId}/drawdowns/acceptances/schedules","fullPath":"/api/v1.0.0/holdings/loans/{loanId}/drawdowns/acceptances/schedules","operationId":"createLoanDrawdownOfferAcceptanceSchedules","name":"Accept the offer drawdown for the retail loan and convert offer drawdown into a live loan arrangement and retrieve the payment schedule details.","summary":"Accept the offer drawdown for the retail loan and convert offer drawdown into a live loan arrangement and retrieve the payment schedule details.","tags":[],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"loanId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":null,"responses":{"200":"","400":"","500":"","default":""}},{"method":"POST","path":"/holdings/loans/{loanId}/drawdowns/renegotiations/schedules","fullPath":"/api/v1.0.0/holdings/loans/{loanId}/drawdowns/renegotiations/schedules","operationId":"createLoanDrawdownOfferRenegotiationSchedules","name":"Renegotiate the offer drawdown for the retail loan and convert offer drawdown into live loan arrangement and retrieve the payment schedule details.","summary":"Renegotiate the offer drawdown for the required customer and retrieve the payment schedule details.","tags":[],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"loanId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":null,"responses":{"200":"","400":"","500":"","default":""}},{"method":"PUT","path":"/holdings/loans/{LoanId}/settlements","fullPath":"/api/v1.0.0/holdings/loans/{LoanId}/settlements","operationId":"updateLoanSettlement","name":"Updates the settlement condition of the loan","summary":"Updates the settlement condition of the loan","tags":[],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"LoanId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":null,"responses":{"200":"","400":"","500":"","default":""}},{"method":"POST","path":"/holdings/loans/{loanId}/simulations/repayments","fullPath":"/api/v1.0.0/holdings/loans/{loanId}/simulations/repayments","operationId":"createRepaymentSimulation","name":"Simulate the pre payment of the given loan account","summary":"Simulate  the loan pre payment","tags":[],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"loanId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":null,"responses":{"200":"","400":"","500":"","default":""}},{"method":"POST","path":"/holdings/loans/{loanId}/simulations/repayments/schedules","fullPath":"/api/v1.0.0/holdings/loans/{loanId}/simulations/repayments/schedules","operationId":"createRepaymentSchedule","name":"Simulate the pre payment of the given loan amount and retrieve the payment schedule","summary":"Simulate the pre payment of the given loan amount and retrieve the payment schedule","tags":[],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"loanId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":null,"responses":{"200":"","400":"","500":"","default":""}},{"method":"PUT","path":"/holdings/loans/{loanId}/repaymentDates/schedules","fullPath":"/api/v1.0.0/holdings/loans/{loanId}/repaymentDates/schedules","operationId":"updateRepaymentDateAndSchedules","name":"Perform repayment date change for the loan product and retrieve the payment schedule , interest details etc.","summary":"Perform repayment date change for the loan and retrieve the payment schedule details.","tags":[],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"loanId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":null,"responses":{"200":"","400":"","500":"","default":""}},{"method":"POST","path":"/holdings/loans/{loanId}/simulations/repaymentDates","fullPath":"/api/v1.0.0/holdings/loans/{loanId}/simulations/repaymentDates","operationId":"createRepaymentDateChangeSimulation","name":"Simulate a loan arrangement for the given payment date","summary":"Simulate a loan arrangement for the given payment date","tags":[],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"loanId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":null,"responses":{"200":"","400":"","500":"","default":""}},{"method":"POST","path":"/holdings/loans/{loanId}/simulations/repaymentDates/schedules","fullPath":"/api/v1.0.0/holdings/loans/{loanId}/simulations/repaymentDates/schedules","operationId":"createRepaymentDateChangeSimulationSchedules","name":"Simulate a loan arrangement for the given payment date and retrieve the payments schedule , interest details etc.","summary":"Simulate a loan arrangement for the given payment date and retrieve the payments schedule details.","tags":[],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"loanId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":null,"responses":{"200":"","400":"","500":"","default":""}}]},{"key":"holdings-loans-arrangements-v6.8.0","title":"Loan creation","version":"v6.8.0","description":"API to create and manage various types of loans such as personal, commercial, mortgage, line of credit, etc","endpointCount":73,"endpoints":[{"method":"POST","path":"/holdings/loans/businessLoans","fullPath":"/api/v1.0.0/holdings/loans/businessLoans","operationId":"createBusinessLoan","name":"Creates a business banking loan for a single or joint customer","summary":"Creates a business banking loan for a single customer or more than one customer(like a joint account relationship) with the customer identifier, customer role, loan currency details","tags":["RETAIL"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"","default":"","400":"","500":""}},{"method":"POST","path":"/holdings/loans/migrations","fullPath":"/api/v1.0.0/holdings/loans/migrations","operationId":"initiateTakeoverloan","name":"Migration of a legacy system loan contract to the given product by providing the original contract date, principal amount, term, payment frequency and start date, etc. ","summary":"Migration of legacy system loan contract to the given product","tags":["RETAIL"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"","400":"","500":"","default":""}},{"method":"PUT","path":"/holdings/loans/{loanId}/balances/migrations","fullPath":"/api/v1.0.0/holdings/loans/{loanId}/balances/migrations","operationId":"captureBalance","name":"Captures the balance details of the mortgage loan such as balance type, due amount etc. This is used to migrate the balances of a legacy contract which is migrated from other system & update the balance details.","summary":"Captures outstanding balance details of a contract migrated from legacy system","tags":["RETAIL"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"loanId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":null,"responses":{"200":"","400":"","500":"","default":""}},{"method":"PUT","path":"/holdings/loans/{loanId}/bills/migrations","fullPath":"/api/v1.0.0/holdings/loans/{loanId}/bills/migrations","operationId":"captureBills","name":"Captures the bill information of the loan such as bill id, property names, bill amount etc. This is used to migrate the bills of a legacy contract which is migrated from other system & update the bill details","summary":"Captures outstanding bill information of a contract migrated from legacy system.","tags":["RETAIL"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"loanId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":null,"responses":{"200":"","400":"","500":"","default":""}},{"method":"PUT","path":"/holdings/loans/{loanId}/products","fullPath":"/api/v1.0.0/holdings/loans/{loanId}/products","operationId":"updateChangeProduct","name":"Change loan from one product to another such as changing one loan product to another loan product","summary":"Change of contract from one loan product to another","tags":["RETAIL"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"loanId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":null,"responses":{"200":"","400":"","500":"","default":""}},{"method":"GET","path":"/holdings/loans/{loanId}/evidences","fullPath":"/api/v1.0.0/holdings/loans/{loanId}/evidences","operationId":"getEvidence","name":"Retrieves the covenants and conditions for a loan account. Covenants are requested in periodic basis and the Conditions are one-time evidence. On non-submission or non-compliance of the evidences, the related consequent activity will be restricted","summary":"Retrieves the covenants and conditions for a loan account.","tags":["RETAIL"],"parameters":[{"name":"loanId","in":"path","type":"string","required":true,"description":"Denotes the arrangement id of the loan"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"","400":"","500":"","default":""}},{"method":"PUT","path":"/holdings/loans/{loanId}/evidences","fullPath":"/api/v1.0.0/holdings/loans/{loanId}/evidences","operationId":"updateEvidence","name":"Performs update of covenants and conditions for a loan account. Covenants are requested in periodic basis and the Conditions are one-time evidence. On non-submission or non-compliance of the evidences, the related consequent activity will be restricted","summary":"Update the covenants and conditions for a loan account","tags":["RETAIL"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"loanId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":null,"responses":{"200":"","400":"","500":"","default":""}},{"method":"POST","path":"/holdings/loans/{loanId}/simulations/paymentHolidays","fullPath":"/api/v1.0.0/holdings/loans/{loanId}/simulations/paymentHolidays","operationId":"simulatePaymentHoliday","name":"Simulate payment holiday activity for a loan account","summary":"Simulate payment holiday activity for a loan account","tags":["RETAIL"],"parameters":[{"name":"loanId","in":"path","type":"string","required":true,"description":""},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"simulatePaymentHolidayResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse","default":"ArrangementErrorResponse"}},{"method":"GET","path":"/holdings/loans/{loanId}/simulations/paymentHolidays","fullPath":"/api/v1.0.0/holdings/loans/{loanId}/simulations/paymentHolidays","operationId":"getPaymentHolidaySim","name":"Retrieves payment holiday simulation details for the loan such as payment type, holiday date, original payment amount and new payment amount","summary":"Retrieves payment holiday simulation details for the loan","tags":["RETAIL"],"parameters":[{"name":"loanId","in":"path","type":"string","required":true,"description":"Denotes the arrangement id of the loan"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"","400":"","500":"","default":""}},{"method":"POST","path":"/holdings/loans/buyNowPayLater","fullPath":"/api/v1.0.0/holdings/loans/buyNowPayLater","operationId":"createBNPLLoan","name":"Creates a business banking loan for a single customer or more than one customer(like a joint account relationship) with the customer identifier, customer role, loan currency details","summary":"Creates a business banking loan for a single or joint customer","tags":["RETAIL"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"createBNPLLoanResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse","default":"ArrangementErrorResponse"}},{"method":"GET","path":"/holdings/loans/balances","fullPath":"/api/v1.0.0/holdings/loans/balances","operationId":"getLoanInformation","name":"Retrieves the loans details for a given customer id and alternate id or arrangement id of the buy now pay later loan.","summary":"Retrieve the buy now pay later loan details","tags":["RETAIL"],"parameters":[{"name":"customerId","in":"query","type":"string","required":false,"description":"Identifier of the customer"},{"name":"alternateId","in":"query","type":"string","required":false,"description":"An Alternate Identification for the Deal. This can be used to retrieve the Deal for amendment."},{"name":"arrangementId","in":"query","type":"string","required":false,"description":"Indicates an unique identifier of an account"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"LoanInformationResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse","default":"QueryErrorResponse"}},{"method":"PUT","path":"/holdings/loans/{loanId}/cancellations","fullPath":"/api/v1.0.0/holdings/loans/{loanId}/cancellations","operationId":"cancelArrangement","name":"Performs the full loan cancellation incase of preshipment return of products under buy now pay later loan.","summary":"Performs the loan cancellation for buy now pay later service","tags":["RETAIL"],"parameters":[{"name":"loanId","in":"path","type":"string","required":true,"description":""},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"cancelArrangementResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse","default":"ArrangementErrorResponse"}},{"method":"POST","path":"/holdings/loans/creditLines","fullPath":"/api/v1.0.0/holdings/loans/creditLines","operationId":"createlineOfCredit","name":"Create a lines of credit account","summary":"Create a lines of credit account","tags":["RETAIL"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"createlineOfCreditResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse","default":"ArrangementErrorResponse"}},{"method":"POST","path":"/holdings/loans","fullPath":"/api/v1.0.0/holdings/loans","operationId":"createLoans","name":"Creates a loan for the given product","summary":"Creates a loan for the given product","tags":["RETAIL"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"createloansResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse","default":"ArrangementErrorResponse"}},{"method":"POST","path":"/holdings/loans/vehicleLoans","fullPath":"/api/v1.0.0/holdings/loans/vehicleLoans","operationId":"createvehicleLoan","name":"Creates a vehicle loan for the given product","summary":"Creates a vehicle loan for the given product","tags":["RETAIL"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"createvehicleLoanResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse","default":"ArrangementErrorResponse"}},{"method":"POST","path":"/holdings/loans/personalLoans","fullPath":"/api/v1.0.0/holdings/loans/personalLoans","operationId":"createPersonalLoan","name":"Create a personal loan account","summary":"Create a personal loan account","tags":[],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"createpersonalLoansResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse","default":"ArrangementErrorResponse"}},{"method":"POST","path":"/holdings/loans/consumerLoans","fullPath":"/api/v1.0.0/holdings/loans/consumerLoans","operationId":"createConsumerLoan","name":"creates a consumer loan for the given product","summary":"Creates a consumer loan for the given product","tags":["RETAIL"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"createConsumerLoanResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse","default":"ArrangementErrorResponse"}},{"method":"PUT","path":"/holdings/loans/{loanId}/renegotiations","fullPath":"/api/v1.0.0/holdings/loans/{loanId}/renegotiations","operationId":"updateLoanConditions","name":"Perform the renegotiation of the loan contract details such as payment frequency, interest rates, etc.","summary":"Perform the renegotiation of the loan contract details","tags":["RETAIL"],"parameters":[{"name":"loanId","in":"path","type":"string","required":true,"description":""},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"updateLoanConditionsResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse","default":"ArrangementErrorResponse"}},{"method":"PUT","path":"/holdings/loans/{loanId}/accounts","fullPath":"/api/v1.0.0/holdings/loans/{loanId}/accounts","operationId":"updateLoanAccount","name":"Update the account conditions of the loan such as alternate references, posting restrictions, etc","summary":"Update the account conditions of the loan","tags":["RETAIL"],"parameters":[{"name":"loanId","in":"path","type":"string","required":true,"description":""},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"updateLoanAccountResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse","default":"ArrangementErrorResponse"}},{"method":"PUT","path":"/holdings/loans/{loanId}/interestConditions","fullPath":"/api/v1.0.0/holdings/loans/{loanId}/interestConditions","operationId":"updateLoanInterest","name":"Update the interest conditions of the loan such as interest rate, spread, margin etc","summary":"Update the interest conditions of the loan","tags":["RETAIL"],"parameters":[{"name":"loanId","in":"path","type":"string","required":true,"description":""},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"updateLoanInterestResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse","default":"ArrangementErrorResponse"}},{"method":"PUT","path":"/holdings/loans/{loanId}/chargeOffs","fullPath":"/api/v1.0.0/holdings/loans/{loanId}/chargeOffs","operationId":"createChargeOffActivity","name":"Execute loan charge-off activity to charge-off account balance only","summary":"Execute loan charge-off activity to charge-off account balance only","tags":["RETAIL"],"parameters":[{"name":"loanId","in":"path","type":"string","required":true,"description":""},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"createChargeOffActivityResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse","default":"ArrangementErrorResponse"}},{"method":"PUT","path":"/holdings/loans/{loanId}/disbursements","fullPath":"/api/v1.0.0/holdings/loans/{loanId}/disbursements","operationId":"createLoanDisbursement","name":"Creates a disbursement of the given loan contracts commitment amount","summary":"Disburses the loan commitment amount","tags":["RETAIL"],"parameters":[{"name":"loanId","in":"path","type":"string","required":true,"description":""},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"createLoanDisbursementResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse","default":"ArrangementErrorResponse"}},{"method":"PUT","path":"/holdings/loans/{loanId}/customers","fullPath":"/api/v1.0.0/holdings/loans/{loanId}/customers","operationId":"updateLoansCustomer","name":"Updates the customer for the given loan contract","summary":"Updates the customer for the given loan contract","tags":["RETAIL"],"parameters":[{"name":"loanId","in":"path","type":"string","required":true,"description":""},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"updateLoansCustomerResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse","default":"ArrangementErrorResponse"}},{"method":"PUT","path":"/holdings/loans/{loanId}/commitmentIncreases","fullPath":"/api/v1.0.0/holdings/loans/{loanId}/commitmentIncreases","operationId":"updateLoanTopupAmount","name":"Increases the commitment amount of the loan","summary":"Increases the commitment amount of the given loan contract","tags":["RETAIL"],"parameters":[{"name":"loanId","in":"path","type":"string","required":true,"description":""},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"updateLoanTopupAmountResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse","default":"ArrangementErrorResponse"}},{"method":"PUT","path":"/holdings/loans/{loanId}/commitmentDecreases","fullPath":"/api/v1.0.0/holdings/loans/{loanId}/commitmentDecreases","operationId":"updateLoanDecreaseAmount","name":"Decreases the commitment amount of the loan","summary":"Decreases the commitment amount of the given loan contract","tags":["RETAIL"],"parameters":[{"name":"loanId","in":"path","type":"string","required":true,"description":""},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"updateLoanDecreaseAmountResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse","default":"ArrangementErrorResponse"}},{"method":"PUT","path":"/holdings/loans/{loanId}/repaymentDates","fullPath":"/api/v1.0.0/holdings/loans/{loanId}/repaymentDates","operationId":"updateRepaymentDate","name":"Perform repayment date change for the loan product with details like loan reference, product id , etc.","summary":"Perform repayment date change for the loan","tags":["RETAIL"],"parameters":[{"name":"loanId","in":"path","type":"string","required":true,"description":""},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"updateRepaymentDateResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse","default":"ArrangementErrorResponse"}},{"method":"PUT","path":"/holdings/loans/{loanId}/writeOffs/balances","fullPath":"/api/v1.0.0/holdings/loans/{loanId}/writeOffs/balances","operationId":"initiateWriteOffBalanceLoans","name":"Perform a write off of the balances such as principal or interest or charge amount for the unpaid loans","summary":"Perform a loan balance write off","tags":["RETAIL"],"parameters":[{"name":"loanId","in":"path","type":"string","required":true,"description":""},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"initiateWriteOffBalanceLoansResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse","default":"ArrangementErrorResponse"}},{"method":"PUT","path":"/holdings/loans/{loanId}/writeOffs","fullPath":"/api/v1.0.0/holdings/loans/{loanId}/writeOffs","operationId":"initiateWriteOffLoans","name":"Perform a write off of the balances and bills such as principal or interest or charge amount for the unpaid loans","summary":"Perform a loan write off of balances and bills","tags":["RETAIL"],"parameters":[{"name":"loanId","in":"path","type":"string","required":true,"description":""},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"initiateWriteOffLoansResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse","default":"ArrangementErrorResponse"}},{"method":"PUT","path":"/holdings/loans/{loanId}/writeOffs/bills","fullPath":"/api/v1.0.0/holdings/loans/{loanId}/writeOffs/bills","operationId":"initiateWriteOffBillLoans","name":"Perform a write off of the bills such as interest or charge amount for the unpaid loans","summary":"Perform a write off bills of unpaid loans","tags":["RETAIL"],"parameters":[{"name":"loanId","in":"path","type":"string","required":true,"description":""},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"initiateWriteOffBillLoansResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse","default":"ArrangementErrorResponse"}},{"method":"POST","path":"/holdings/loans/linkedRateLoans","fullPath":"/api/v1.0.0/holdings/loans/linkedRateLoans","operationId":"createLinkedRateLoan","name":"Create a personal loan account with linked rate","summary":"Create a personal loan account with linked rate","tags":[],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"","400":"","500":"","default":""}},{"method":"POST","path":"/holdings/loans/commercialLoans","fullPath":"/api/v1.0.0/holdings/loans/commercialLoans","operationId":"createCommercialLoan","name":"Create a commercial or business account","summary":"Create a commercial or business account","tags":[],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"","400":"","500":"","default":""}},{"method":"POST","path":"/holdings/loans/mortgages","fullPath":"/api/v1.0.0/holdings/loans/mortgages","operationId":"createMortgage","name":"Create a mortgage loan","summary":"Create a mortgage loan","tags":[],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"","400":"","500":"","default":""}},{"method":"POST","path":"/holdings/facilities/installmentLoans","fullPath":"/api/v1.0.0/holdings/facilities/installmentLoans","operationId":"createInstallmentLoan","name":"Create an installment loan for the given product","summary":"Create an installment loan for the given product","tags":[],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"","400":"","500":"","default":""}},{"method":"POST","path":"/holdings/fundsTransfer","fullPath":"/api/v1.0.0/holdings/fundsTransfer","operationId":"createFundsTransfer","name":"Create an account transfer","summary":"Create an account transfer","tags":[],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"","400":"","500":"","default":""}},{"method":"PUT","path":"/holdings/loans/consumerLoans/{consumerLoanId}/disbursements","fullPath":"/api/v1.0.0/holdings/loans/consumerLoans/{consumerLoanId}/disbursements","operationId":"createConsumerLoanDisbursement","name":"Creates a disbursement of the given consumer loan contracts commitment amount","summary":"Disburses the consumer loan commitment amount","tags":["RETAIL"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"consumerLoanId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":null,"responses":{"200":"","400":"","500":"","default":""}},{"method":"PUT","path":"/holdings/loans/consumerLoans/{consumerLoanId}/commitmentIncreases","fullPath":"/api/v1.0.0/holdings/loans/consumerLoans/{consumerLoanId}/commitmentIncreases","operationId":"updateConsumerLoanTopupAmount","name":"Increases the commitment amount of the consumer loan","summary":"Increases the commitment amount of the given consumer loan contract","tags":["RETAIL"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"consumerLoanId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":null,"responses":{"200":"","400":"","500":"","default":""}},{"method":"PUT","path":"/holdings/loans/consumerLoans/{consumerLoanId}/commitmentDecreases","fullPath":"/api/v1.0.0/holdings/loans/consumerLoans/{consumerLoanId}/commitmentDecreases","operationId":"updateConsumerLoanDecreaseAmount","name":"Decreases the commitment amount of the consumer loan","summary":"Decreases the commitment amount of the given consumer loan contract","tags":["RETAIL"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"consumerLoanId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":null,"responses":{"200":"","400":"","500":"","default":""}},{"method":"PUT","path":"/holdings/loans/consumerLoans/{consumerLoanId}/repayments","fullPath":"/api/v1.0.0/holdings/loans/consumerLoans/{consumerLoanId}/repayments","operationId":"createConsumerLoanRepayment","name":"Creates the repayment of the given consumer loan amount","summary":"Repays the consumer loan amount","tags":["RETAIL"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"consumerLoanId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":null,"responses":{"200":"","400":"","500":"","default":""}},{"method":"PUT","path":"/holdings/loans/consumerLoans/{consumerLoanId}/principalDecreases","fullPath":"/api/v1.0.0/holdings/loans/consumerLoans/{consumerLoanId}/principalDecreases","operationId":"createConsumerLoanPrepayment","name":"Creates the advance repayment of the given consumer loan amount","summary":"Prepays the consumer loan amount","tags":["RETAIL"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"consumerLoanId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":null,"responses":{"200":"","400":"","500":"","default":""}},{"method":"PUT","path":"/holdings/loans/consumerLoans/{consumerLoanId}/schedules","fullPath":"/api/v1.0.0/holdings/loans/consumerLoans/{consumerLoanId}/schedules","operationId":"updateConsumerLoanSchedule","name":"Update the change of payment schedule for the given consumer loan contract","summary":"Update the payment schedule of the consumer loan","tags":["RETAIL"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"consumerLoanId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":null,"responses":{"200":"","400":"","500":"","default":""}},{"method":"PUT","path":"/holdings/loans/consumerLoans/{consumerLoanId}/paymentHolidays","fullPath":"/api/v1.0.0/holdings/loans/consumerLoans/{consumerLoanId}/paymentHolidays","operationId":"updateConsumerLoanHoliday","name":"Update of payment holiday for the given consumer loan contract","summary":"Update payment holiday for the consumer loan","tags":["RETAIL"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"consumerLoanId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":null,"responses":{"200":"","400":"","500":"","default":""}},{"method":"GET","path":"/holdings/loans/{loanId}/outstandingBills","fullPath":"/api/v1.0.0/holdings/loans/{loanId}/outstandingBills","operationId":"getLoanOutstandingBills","name":"Retrieves the outstanding amount to be paid for a loan","summary":"Retrieves the outstanding amount to be paid for the given loan","tags":["RETAIL"],"parameters":[{"name":"loanId","in":"path","type":"string","required":true,"description":"Denotes the arrangement id of the loan"},{"name":"fileVersion","in":"query","type":"string","required":false,"description":"Indicates if the file is of type simulation or live"},{"name":"simulationReference","in":"query","type":"string","required":false,"description":"Indicates the reference id for simulation activity"},{"name":"paymentDate","in":"query","type":"string","required":false,"description":"Contains the date in which the payment will be sent out. Date in the format YYYYMMDD. E.g. 20191231"},{"name":"deferDate","in":"query","type":"string","required":false,"description":"Date that the payment has been deferred to"},{"name":"billedAmount","in":"query","type":"string","required":false,"description":"Indicates the bill amount"},{"name":"outstandingAmount","in":"query","type":"string","required":false,"description":"Contains the aggregate outstanding principal amount thereof after giving effect to any borrowings and prepayments or repayments of Committed Loans"},{"name":"delinquentAmount","in":"query","type":"string","required":false,"description":"Indicates the bill amount during the ageing status(Bill which crossed the due date)"},{"name":"property","in":"query","type":"string","required":false,"description":"Id of the product property"},{"name":"billStatus","in":"query","type":"string","required":false,"description":"Indicates the status of a bill(Issued,Due,Ageing,Settled)"},{"name":"settlementStatus","in":"query","type":"string","required":false,"description":"Defines the status of the settlement for the incoming MT548 swift message.The values allowed are: Waiting : pending to receive settlement status update meaning pending to receive MT548 swift message, "},{"name":"agingStatus","in":"query","type":"string","required":false,"description":"Indicates the ageing status of a bill"},{"name":"settled","in":"query","type":"string","required":false,"description":"Flag to indicate whether a bill is settled or not"},{"name":"paymentType","in":"query","type":"string","required":false,"description":"Indicates if the payment is Customer (C) type or Bank (B) type"},{"name":"billDate","in":"query","type":"string","required":false,"description":"Indicates a date on which a bill has been raised"},{"name":"paymentMethod","in":"query","type":"string","required":false,"description":"Method chosen to make the payment"},{"name":"infoPayType","in":"query","type":"string","required":false,"description":"Indicates a bill which is raised when a loan is paid off"},{"name":"advancePayment","in":"query","type":"string","required":false,"description":"Indicates whether advance payment made is set on an account"},{"name":"paymentIndicator","in":"query","type":"string","required":false,"description":"Indicates whether its a credit/debit type of bill"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"","400":"","500":"","default":""}},{"method":"GET","path":"/holdings/loans/{loanId}/payoffCalculations","fullPath":"/api/v1.0.0/holdings/loans/{loanId}/payoffCalculations","operationId":"getLoanPayoffDetails","name":"Retrieves the payoff details of a loan","summary":"Retrieves the payoff details of the given loan","tags":["RETAIL"],"parameters":[{"name":"loanId","in":"path","type":"string","required":true,"description":"Denotes the arrangement id of the loan"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"","400":"","500":"","default":""}},{"method":"PUT","path":"/holdings/loans/consumerLoans/{consumerLoanId}/customers","fullPath":"/api/v1.0.0/holdings/loans/consumerLoans/{consumerLoanId}/customers","operationId":"updateConsumerLoansCustomer","name":"Updates the customers for the given consumer loan contract","summary":"Update the customers of the consumer loan ","tags":["RETAIL"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"consumerLoanId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":null,"responses":{"200":"","400":"","500":"","default":""}},{"method":"PUT","path":"/holdings/loans/consumerLoans/{consumerLoanId}/payoffs","fullPath":"/api/v1.0.0/holdings/loans/consumerLoans/{consumerLoanId}/payoffs","operationId":"createPayoffConsumerLoan","name":"Creates the payoff of the given consumer loan contract amount","summary":"Payoffs the consumer loan amount","tags":["RETAIL"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"consumerLoanId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":null,"responses":{"200":"","400":"","500":"","default":""}},{"method":"PUT","path":"/holdings/loans/consumerLoans/{consumerLoanId}/renegotiations","fullPath":"/api/v1.0.0/holdings/loans/consumerLoans/{consumerLoanId}/renegotiations","operationId":"updateConsumerLoanConditions","name":"Creates the renegotiation of the given consumer loan contract details","summary":"Renegotiates the consumer loan contract details","tags":["RETAIL"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"consumerLoanId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":null,"responses":{"200":"","400":"","500":"","default":""}},{"method":"GET","path":"/holdings/loans/{loanId}/status","fullPath":"/api/v1.0.0/holdings/loans/{loanId}/status","operationId":"getArrangementDetails","name":"Retrieves the status of a loan","summary":"Retrieves the status of the given loan","tags":["RETAIL"],"parameters":[{"name":"loanId","in":"path","type":"string","required":true,"description":"Denotes the arrangement id of the loan"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"","400":"","500":"","default":""}},{"method":"GET","path":"/holdings/loans/arrangements/activities/{arrangementActivityId}/status","fullPath":"/api/v1.0.0/holdings/loans/arrangements/activities/{arrangementActivityId}/status","operationId":"getExternalEventStatus","name":"Retrieves the status of the given activity ","summary":"Retrieves the status of the given activity ","tags":["RETAIL"],"parameters":[{"name":"arrangementActivityId","in":"path","type":"string","required":true,"description":"Contains the arrangement activity reference identifier"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"","400":"","500":"","default":""}},{"method":"PUT","path":"/holdings/loans/consumerLoans/{consumerLoanId}/payoffCalculations","fullPath":"/api/v1.0.0/holdings/loans/consumerLoans/{consumerLoanId}/payoffCalculations","operationId":"calculatePayoffConsumerLoans","name":"Creates calculates payoff activity to calculate consumer loan payment amount to close the given loan","summary":"Calculates consumer loan payment amount to close a loan","tags":["RETAIL"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"consumerLoanId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":null,"responses":{"200":"","400":"","500":"","default":""}},{"method":"GET","path":"/holdings/loans/{loanId}/schedules","fullPath":"/api/v1.0.0/holdings/loans/{loanId}/schedules","operationId":"getPaymentSchedulesProjection","name":"Retrieves the schedule payment information for paid and upcoming installments details","summary":"Retrieves payment schedules details","tags":["RETAIL"],"parameters":[{"name":"loanId","in":"path","type":"string","required":true,"description":"Denotes the arrangement id of the loan"},{"name":"dateFrom","in":"query","type":"string","required":false,"description":"Start date of the loan"},{"name":"dateTo","in":"query","type":"string","required":false,"description":"End date of the loan"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"","400":"","500":"","default":""}},{"method":"GET","path":"/holdings/loans/{loanId}/loanDetails","fullPath":"/api/v1.0.0/holdings/loans/{loanId}/loanDetails","operationId":"getLoanOverview","name":"Retrieves the details of the given loan","summary":"Retrieves loan details ","tags":["RETAIL"],"parameters":[{"name":"loanId","in":"path","type":"string","required":true,"description":"Denotes the arrangement id of the loan"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"","400":"","500":"","default":""}},{"method":"GET","path":"/holdings/loans/{loanId}/bills","fullPath":"/api/v1.0.0/holdings/loans/{loanId}/bills","operationId":"getLoanBills","name":"Retrieves the simulation details of the contract based on the selection criteria. It returns the bill details of the loan","summary":"Retrieves loan bills details","tags":[],"parameters":[{"name":"loanId","in":"path","type":"string","required":true,"description":"Denotes the arrangement id of the loan"},{"name":"billType","in":"query","type":"string","required":false,"description":"The type of payment obligation generated"},{"name":"paymentDate","in":"query","type":"string","required":false,"description":"Contains the date in which the payment will be sent out. Date in the format YYYYMMDD. E.g. 20191231"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"","400":"","500":"","default":""}},{"method":"GET","path":"/holdings/loans/{loanId}/collaterals","fullPath":"/api/v1.0.0/holdings/loans/{loanId}/collaterals","operationId":"getLoanCollaterals","name":"Retrieves the collateral details linked to the loan arrangement.","summary":"Retrieves loan collateral details","tags":[],"parameters":[{"name":"loanId","in":"path","type":"string","required":true,"description":"Denotes the arrangement id of the loan"},{"name":"status","in":"query","type":"string","required":false,"description":"Contains status of the data rights request.Allowed values are INITIATED, INPROGESS, EXTENDED, COMPLETED, REJECTED."},{"name":"statusNE","in":"query","type":"string","required":false,"description":"Status not equal to"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"","400":"","500":"","default":""}},{"method":"GET","path":"/holdings/loans/{loanId}","fullPath":"/api/v1.0.0/holdings/loans/{loanId}","operationId":"getLoanDetails","name":"Retrieves loan details","summary":"Retrieves the loan account details","tags":[],"parameters":[{"name":"loanId","in":"path","type":"string","required":true,"description":"Denotes the arrangement id of the loan"},{"name":"dateFrom","in":"query","type":"string","required":false,"description":"Start date of the loan"},{"name":"dateTo","in":"query","type":"string","required":false,"description":"End date of the loan"},{"name":"balanceTypes","in":"query","type":"string","required":false,"description":"Type of balance (e.g. current balance, credit interest accrued, deferred commission, etc.) as defined in the institution's accounting schemas."},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"","400":"","500":"","default":""}},{"method":"GET","path":"/holdings/loans/{loanId}/schedulePaymentFrequencies","fullPath":"/api/v1.0.0/holdings/loans/{loanId}/schedulePaymentFrequencies","operationId":"getPaymentSchedules","name":"Retrieves the schedule payment information for paid and upcoming installments details","summary":"Retrieves payment schedules details","tags":[],"parameters":[{"name":"loanId","in":"path","type":"string","required":true,"description":"Denotes the arrangement id of the loan"},{"name":"dateFrom","in":"query","type":"string","required":false,"description":"Start date of the loan"},{"name":"dateTo","in":"query","type":"string","required":false,"description":"End date of the loan"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"","400":"","500":"","default":""}},{"method":"POST","path":"/holdings/simulationCapture/{arrangementId}","fullPath":"/api/v1.0.0/holdings/simulationCapture/{arrangementId}","operationId":"createSimulationCapture","name":"Simulate payoff calculate activity for a loan arrangement","summary":"Simulate payoff calculate activity for a loan arrangement","tags":[],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"arrangementId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":null,"responses":{"200":"","400":"","500":"","default":""}},{"method":"POST","path":"/holdings/loans/simulations","fullPath":"/api/v1.0.0/holdings/loans/simulations","operationId":"createLoanSimulation","name":"Create a simulation for loan product with details like customer identifier, currency, etc.","summary":"Create simulation for loan products","tags":["RETAIL"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"","400":"","500":"","default":""}},{"method":"PUT","path":"/holdings/loans/simulations/{simulationId}","fullPath":"/api/v1.0.0/holdings/loans/simulations/{simulationId}","operationId":"updateLoanSimulation","name":"Update a simulation for loan product with details like customer identifier, currency, etc.","summary":"Update a simulation for loan products","tags":["RETAIL"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"simulationId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":null,"responses":{"200":"","400":"","500":"","default":""}},{"method":"POST","path":"/holdings/loans/{loanId}/simulations/payoffs","fullPath":"/api/v1.0.0/holdings/loans/{loanId}/simulations/payoffs","operationId":"createLoanPayoffSimulation","name":"Create a simulation payoff activity for loan product with product id details","summary":"Create simulation payoff activity for loan products","tags":["RETAIL"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"loanId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":null,"responses":{"200":"","400":"","500":"","default":""}},{"method":"POST","path":"/holdings/loans/{loanId}/payoffs","fullPath":"/api/v1.0.0/holdings/loans/{loanId}/payoffs","operationId":"createLoanArrangementPayoff","name":"Execute payoff activity for loan product with details like simulation run reference, product id , etc.","summary":"Execute payoff activity for loan products","tags":["RETAIL"],"parameters":[{"name":"loanId","in":"path","type":"string","required":true,"description":""},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"createLoanArrangementPayoffResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse","default":"ArrangementErrorResponse"}},{"method":"GET","path":"/holdings/loans/{loanId}/overpayments","fullPath":"/api/v1.0.0/holdings/loans/{loanId}/overpayments","operationId":"getOverpaymentDetails","name":"Retrieves the product id, type of overpay, overpay limit, overpay period, utilised overpay and remaining overpay limit of a loan arrangement","summary":"Retrieves overpayment details that has happened for a loan arrangement","tags":["RETAIL"],"parameters":[{"name":"loanId","in":"path","type":"string","required":true,"description":"Denotes the arrangement id of the loan"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"","400":"","500":"","default":""}},{"method":"POST","path":"/holdings/loans/drawdowns/offers","fullPath":"/api/v1.0.0/holdings/loans/drawdowns/offers","operationId":"createLoanDrawdownOffer","name":"Creates a new drawdown offer for the required customer.","summary":"Creates a new drawdown offer for the required customer.","tags":[],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"","400":"","500":"","default":""}},{"method":"POST","path":"/holdings/loans/{loanId}/drawdowns/acceptances","fullPath":"/api/v1.0.0/holdings/loans/{loanId}/drawdowns/acceptances","operationId":"createLoanDrawdownOfferAcceptance","name":"Accept the offer drawdown for the retail loan and convert offer drawdown into a live loan arrangement.","summary":"Accept the offer drawdown for the retail loan and convert offer drawdown into a live loan arrangement.","tags":[],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"loanId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":null,"responses":{"200":"","400":"","500":"","default":""}},{"method":"POST","path":"/holdings/loans/{loanId}/drawdowns/renegotiations","fullPath":"/api/v1.0.0/holdings/loans/{loanId}/drawdowns/renegotiations","operationId":"createLoanDrawdownOfferRenegotiation","name":"Renegotiate the offer drawdown for the retail loan and convert offer drawdown into live loan arrangement.","summary":"Renegotiate the offer drawdown for the required customer.","tags":[],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"loanId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":null,"responses":{"200":"","400":"","500":"","default":""}},{"method":"POST","path":"/holdings/loans/{loanId}/drawdowns/cancellations","fullPath":"/api/v1.0.0/holdings/loans/{loanId}/drawdowns/cancellations","operationId":"cancelLoanDrawdownOffer","name":"Cancellation of offer drawdown for the required customer.","summary":"Cancellation of offer drawdown for the required customer.","tags":[],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"loanId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":null,"responses":{"200":"","400":"","500":"","default":""}},{"method":"POST","path":"/holdings/loans/{loanId}/drawdowns/acceptances/schedules","fullPath":"/api/v1.0.0/holdings/loans/{loanId}/drawdowns/acceptances/schedules","operationId":"createLoanDrawdownOfferAcceptanceSchedules","name":"Accept the offer drawdown for the retail loan and convert offer drawdown into a live loan arrangement and retrieve the payment schedule details.","summary":"Accept the offer drawdown for the retail loan and convert offer drawdown into a live loan arrangement and retrieve the payment schedule details.","tags":[],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"loanId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":null,"responses":{"200":"","400":"","500":"","default":""}},{"method":"POST","path":"/holdings/loans/{loanId}/drawdowns/renegotiations/schedules","fullPath":"/api/v1.0.0/holdings/loans/{loanId}/drawdowns/renegotiations/schedules","operationId":"createLoanDrawdownOfferRenegotiationSchedules","name":"Renegotiate the offer drawdown for the retail loan and convert offer drawdown into live loan arrangement and retrieve the payment schedule details.","summary":"Renegotiate the offer drawdown for the required customer and retrieve the payment schedule details.","tags":[],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"loanId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":null,"responses":{"200":"","400":"","500":"","default":""}},{"method":"PUT","path":"/holdings/loans/{LoanId}/settlements","fullPath":"/api/v1.0.0/holdings/loans/{LoanId}/settlements","operationId":"updateLoanSettlement","name":"Updates the settlement condition of the loan","summary":"Updates the settlement condition of the loan","tags":[],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"LoanId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":null,"responses":{"200":"","400":"","500":"","default":""}},{"method":"POST","path":"/holdings/loans/{loanId}/simulations/repayments","fullPath":"/api/v1.0.0/holdings/loans/{loanId}/simulations/repayments","operationId":"createRepaymentSimulation","name":"Simulate the pre payment of the given loan account","summary":"Simulate  the loan pre payment","tags":[],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"loanId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":null,"responses":{"200":"","400":"","500":"","default":""}},{"method":"POST","path":"/holdings/loans/{loanId}/simulations/repayments/schedules","fullPath":"/api/v1.0.0/holdings/loans/{loanId}/simulations/repayments/schedules","operationId":"createRepaymentSchedule","name":"Simulate the pre payment of the given loan amount and retrieve the payment schedule","summary":"Simulate the pre payment of the given loan amount and retrieve the payment schedule","tags":[],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"loanId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":null,"responses":{"200":"","400":"","500":"","default":""}},{"method":"PUT","path":"/holdings/loans/{loanId}/repaymentDates/schedules","fullPath":"/api/v1.0.0/holdings/loans/{loanId}/repaymentDates/schedules","operationId":"updateRepaymentDateAndSchedules","name":"Perform repayment date change for the loan product and retrieve the payment schedule , interest details etc.","summary":"Perform repayment date change for the loan and retrieve the payment schedule details.","tags":[],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"loanId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":null,"responses":{"200":"","400":"","500":"","default":""}},{"method":"POST","path":"/holdings/loans/{loanId}/simulations/repaymentDates","fullPath":"/api/v1.0.0/holdings/loans/{loanId}/simulations/repaymentDates","operationId":"createRepaymentDateChangeSimulation","name":"Simulate a loan arrangement for the given payment date","summary":"Simulate a loan arrangement for the given payment date","tags":[],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"loanId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":null,"responses":{"200":"","400":"","500":"","default":""}},{"method":"POST","path":"/holdings/loans/{loanId}/simulations/repaymentDates/schedules","fullPath":"/api/v1.0.0/holdings/loans/{loanId}/simulations/repaymentDates/schedules","operationId":"createRepaymentDateChangeSimulationSchedules","name":"Simulate a loan arrangement for the given payment date and retrieve the payments schedule , interest details etc.","summary":"Simulate a loan arrangement for the given payment date and retrieve the payments schedule details.","tags":[],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"loanId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":null,"responses":{"200":"","400":"","500":"","default":""}}]},{"key":"holdings-loans-service-v1.0.0","title":"Holdings Loans APIs Deprecated","version":"v1.0.0","description":"Get and manage Holdings Loans","endpointCount":4,"endpoints":[{"method":"GET","path":"/holdings/loans/{loanId}/bills","fullPath":"/api/v1.0.0/holdings/loans/{loanId}/bills","operationId":"getLoanBills","name":"Retrieves loan bills details - Deprecated. Use holdings-loans-service-v2.0.0 instead","summary":"Retrieves the simulation details of the contract based on the selection criteria. It returns the bill details of the loan","tags":[],"parameters":[{"name":"loanId","in":"path","type":"string","required":true,"description":"Denotes the arrangement id of the loan"},{"name":"billType","in":"query","type":"string","required":false,"description":"The type of payment obligation generated"},{"name":"paymentDate","in":"query","type":"string","required":false,"description":"The date on which a payment is due"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"LoanBillsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/loans/{loanId}","fullPath":"/api/v1.0.0/holdings/loans/{loanId}","operationId":"getLoanDetails","name":"Retrieves loan details - Deprecated. Use holdings-loans-service-v2.0.0 instead","summary":"Retrieves the loan account details","tags":[],"parameters":[{"name":"loanId","in":"path","type":"string","required":true,"description":"Denotes the arrangement id of the loan"},{"name":"dateFrom","in":"query","type":"string","required":false,"description":"Start date of the loan"},{"name":"dateTo","in":"query","type":"string","required":false,"description":"End date of the loan"},{"name":"balanceTypes","in":"query","type":"string","required":false,"description":"Type of balance (e.g. current balance, credit interest accrued, deferred commission, etc.) as defined in the institution's accounting schemas."},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"LoanDetailsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/loans/{loanId}/collaterals","fullPath":"/api/v1.0.0/holdings/loans/{loanId}/collaterals","operationId":"getLoanCollaterals","name":"Retrieves loan collateral details - Deprecated. Use holdings-loans-service-v2.0.0 instead","summary":"Retrieves the collateral details linked to the loan arrangement. The collateral right and status have to be passed within the api","tags":[],"parameters":[{"name":"loanId","in":"path","type":"string","required":true,"description":"Denotes the arrangement id of the loan"},{"name":"status","in":"query","type":"string","required":false,"description":"Contains status of the data rights request.Allowed values are INITIATED, INPROGESS, EXTENDED, COMPLETED, REJECTED."},{"name":"statusNE","in":"query","type":"string","required":false,"description":"Status not equal to"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"LoanCollateralsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/loans/{loanId}/schedulePaymentFrequencies","fullPath":"/api/v1.0.0/holdings/loans/{loanId}/schedulePaymentFrequencies","operationId":"getPaymentSchedules","name":"Retrieves payment schedules details - Deprecated. Use holdings-loans-service-v2.0.0 instead","summary":"Retrieves the schedule payment information for paid and upcoming installments details","tags":[],"parameters":[{"name":"loanId","in":"path","type":"string","required":true,"description":"Denotes the arrangement id of the loan"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"PaymentSchedulesResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}}]},{"key":"holdings-loans-service-v1.1.0","title":"Holdings Loans APIs Deprecated","version":"v1.1.0","description":"Get and manage Holdings Loans","endpointCount":3,"endpoints":[{"method":"GET","path":"/holdings/loans/{loanId}","fullPath":"/api/v1.1.0/holdings/loans/{loanId}","operationId":"getLoanDetails","name":"Retrieves the overview of loan account details - Deprecated. Use holdings-loans-service-v2.0.0 instead","summary":"Retrieves the overview of customer loan","tags":[],"parameters":[{"name":"loanId","in":"path","type":"string","required":true,"description":"Denotes the arrangement id of the loan"},{"name":"dateFrom","in":"query","type":"string","required":false,"description":"Start date of the loan"},{"name":"dateTo","in":"query","type":"string","required":false,"description":"End date of the loan"},{"name":"balanceTypes","in":"query","type":"string","required":false,"description":"Type of balance (e.g. current balance, credit interest accrued, deferred commission, etc.) as defined in the institution's accounting schemas."},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"LoanDetailsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/loans/{loanId}/collaterals","fullPath":"/api/v1.1.0/holdings/loans/{loanId}/collaterals","operationId":"getArrangementCollateralDetails","name":"Retrieves loan collateral details - Deprecated. Use holdings-loans-service-v2.0.0 instead","summary":"Retrieves the collateral details linked to the loan arrangement. The collateral right and status have to be passed within the api","tags":[],"parameters":[{"name":"loanId","in":"path","type":"string","required":true,"description":""},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"ArrangementCollateralDetailsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/loans/{loanId}/bills","fullPath":"/api/v1.1.0/holdings/loans/{loanId}/bills","operationId":"getLoanBillDetails","name":"Retrieves the list of Loan Bills - Deprecated. Use holdings-loans-service-v2.0.0 instead","summary":"Retrieves Loan Bills","tags":[],"parameters":[{"name":"loanId","in":"path","type":"string","required":true,"description":"Denotes the arrangement id of the loan"},{"name":"billType","in":"query","type":"string","required":false,"description":"The type of payment obligation generated"},{"name":"paymentDate","in":"query","type":"string","required":false,"description":"The date on which a payment is due"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"LoanBillDetailsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}}]},{"key":"holdings-loans-service-v2.0.0","title":"Customer loans and collateral details","version":"v2.0.0","description":"API to retrieve the collateral ,bills and schedules of a loan account","endpointCount":4,"endpoints":[{"method":"GET","path":"/holdings/loans/{loanId}/bills","fullPath":"/api/v2.0.0/holdings/loans/{loanId}/bills","operationId":"getLoanBills","name":"Retrieves loan bills details-This API is deprecated","summary":"Retrieves the simulation details of the contract based on the selection criteria. It returns the bill details of the loan","tags":[],"parameters":[{"name":"loanId","in":"path","type":"string","required":true,"description":"Denotes the arrangement id of the loan"},{"name":"billType","in":"query","type":"string","required":false,"description":"The type of payment obligation generated"},{"name":"paymentDate","in":"query","type":"string","required":false,"description":"The date on which a payment is due"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from t24 on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"LoanBillsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/loans/{loanId}/collaterals","fullPath":"/api/v2.0.0/holdings/loans/{loanId}/collaterals","operationId":"getLoanCollaterals","name":"Retrieves loan collateral details-This API is deprecated","summary":"Retrieves the collateral details linked to the loan arrangement. The collateral right and status have to be passed within the api","tags":[],"parameters":[{"name":"loanId","in":"path","type":"string","required":true,"description":"Denotes the arrangement id of the loan"},{"name":"status","in":"query","type":"string","required":false,"description":"Contains status of the data rights request.Allowed values are INITIATED, INPROGESS, EXTENDED, COMPLETED, REJECTED."},{"name":"statusNE","in":"query","type":"string","required":false,"description":"Status not equal to"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from t24 on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"LoanCollateralsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/loans/{loanId}","fullPath":"/api/v2.0.0/holdings/loans/{loanId}","operationId":"getLoanDetails","name":"Retrieves loan details-This API is deprecated","summary":"Retrieves the loan account details","tags":[],"parameters":[{"name":"loanId","in":"path","type":"string","required":true,"description":"Denotes the arrangement id of the loan"},{"name":"dateFrom","in":"query","type":"string","required":false,"description":"Start date of the loan"},{"name":"dateTo","in":"query","type":"string","required":false,"description":"End date of the loan"},{"name":"balanceTypes","in":"query","type":"string","required":false,"description":"Type of balance (e.g. current balance, credit interest accrued, deferred commission, etc.) as defined in the institution's accounting schemas."},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from t24 on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"LoanDetailsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/loans/{loanId}/schedulePaymentFrequencies","fullPath":"/api/v2.0.0/holdings/loans/{loanId}/schedulePaymentFrequencies","operationId":"getPaymentSchedules","name":"Retrieves payment schedules details-This API is deprecated","summary":"Retrieves the schedule payment information for paid and upcoming installments details","tags":[],"parameters":[{"name":"loanId","in":"path","type":"string","required":true,"description":"Denotes the arrangement id of the loan"},{"name":"dateFrom","in":"query","type":"string","required":false,"description":"Start date of the loan"},{"name":"dateTo","in":"query","type":"string","required":false,"description":"End date of the loan"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from t24 on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"PaymentSchedulesResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}}]},{"key":"holdings-moneyMarket-v1.0.0","title":"Treasury money market contracts","version":"v1.0.0","description":"API to create, amend and delete money market contract","endpointCount":3,"endpoints":[{"method":"POST","path":"/holdings/moneyMarkets/","fullPath":"/api/v1.0.0/holdings/moneyMarkets/","operationId":"createMoneyMarkets","name":"Create money market contract","summary":"Create money market contract","tags":[],"parameters":[{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"customerId":"string","currency":"string","principal":"string","dealDate":"string","valueDate":"string","category":"string","maturityDate":"string","interestRateType":"string","periodicInterestId":"string","interestDueDate":"string","interestRate":"string","interestKey":"string","interestSpread":"string","interestSchedule":"string","portfolioId":"string"}},"responses":{"200":"MoneyMarketsResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/holdings/moneyMarkets/{transactionId}","fullPath":"/api/v1.0.0/holdings/moneyMarkets/{transactionId}","operationId":"updateMoneyMarkets","name":"Amend money markets contracts","summary":"Amend money markets contracts","tags":[],"parameters":[{"name":"transactionId","in":"path","type":"string","required":true,"description":""},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"customerId":"string","currency":"string","principal":"string","dealDate":"string","valueDate":"string","category":"string","maturityDate":"string","interestRateType":"string","periodicInterestId":"string","interestDueDate":"string","interestRate":"string","interestKey":"string","interestSpread":"string","interestSchedule":"string","portfolioId":"string"}},"responses":{"200":"MoneyMarketsResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"DELETE","path":"/holdings/moneyMarkets/{transactionId}","fullPath":"/api/v1.0.0/holdings/moneyMarkets/{transactionId}","operationId":"deleteMoneyMarkets","name":"Delete money market contracts","summary":"Delete money market contracts","tags":[],"parameters":[{"name":"transactionId","in":"path","type":"string","required":true,"description":""},{"name":"payload","in":"body","type":"object","required":false,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}}},"responses":{"200":"MoneyMarketsResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}}]},{"key":"holdings-multicurrencyaccount-arrangements-v1.0.0","title":"Multi Currency Account Arrangements","version":"v1.0.0","description":"The Arrangement Architecture is a Temenos Transact Framework to create and manage  various products such as Loans, Deposits, Accounts, Multi Currency Account, etc. It provides a modular business component-based architecture, whereby users can create their Products by using the components provided by","endpointCount":12,"endpoints":[{"method":"POST","path":"/holdings/accounts/multiCurrencyAccounts","fullPath":"/api/v1.0.0/holdings/accounts/multiCurrencyAccounts","operationId":"createMultiCurrencyAccounts","name":"Creates a multi currency account for a single customer or more than one customer(like a joint account relationship) with the customer identifier, customer role, account currency details.","summary":"Creates a multi currency account for a single or joint customer","tags":["RETAIL"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"customers":[{}],"productId":"string","activityId":"string","currency":"string","arrangementEffectiveDate":"string"}},"responses":{"200":"createMultiCurrencyAccountsResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"PUT","path":"/holdings/accounts/multiCurrencyAccounts/{multiCurrencyAccountId}/sweepPriorities","fullPath":"/api/v1.0.0/holdings/accounts/multiCurrencyAccounts/{multiCurrencyAccountId}/sweepPriorities","operationId":"updateSweepPriority","name":"Updates currency priority rules for automatic position transfer between the sub accounts (of different currencies) in the same multi currency account with position adjustment and adjustment order information.","summary":"Updates priority rules for settling insufficient funds","tags":["RETAIL"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"multiCurrencyAccountId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"arrangementEffectiveDate":"string","mcyBalAvl":[{}]}},"responses":{"200":"updateSweepPriorityResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"POST","path":"/holdings/accounts/multiCurrencyAccounts/subAccounts","fullPath":"/api/v1.0.0/holdings/accounts/multiCurrencyAccounts/subAccounts","operationId":"createSubAccounts","name":"Creates a sub account in a new currency under a multi currency account with the details like customer identifier, customer role, account currency.","summary":"Creates a sub account under a multi currency account in the new currency specified","tags":["RETAIL"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"customers":[{}],"multiCurrencyAccountId":"string","productId":"string","activityId":"string","currency":"string","arrangementEffectiveDate":"string"}},"responses":{"200":"createSubAccountsResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"POST","path":"/holdings/accounts/multiCurrencyAccounts/{multiCurrencyAccountId}/accountClosures","fullPath":"/api/v1.0.0/holdings/accounts/multiCurrencyAccounts/{multiCurrencyAccountId}/accountClosures","operationId":"closeMultiCurrencyAccounts","name":"Perform the closure of the multi currency account after settlement of payoff amount","summary":"Perform the closure of the multi currency account after settlement of payoff amount","tags":["RETAIL"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"multiCurrencyAccountId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"arrangementEffectiveDate":"string"}},"responses":{"200":"closeMultiCurrencyAccountsResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"POST","path":"/holdings/accounts/multiCurrencyAccounts/{multiCurrencyAccountId}/payoffs","fullPath":"/api/v1.0.0/holdings/accounts/multiCurrencyAccounts/{multiCurrencyAccountId}/payoffs","operationId":"performLiveClosure","name":"Perform the settlement of payoff amount for the multi currency account by providing the transaction amount, currency and also settlement instructions","summary":"Perform the settlement of payoff amount for the multi currency account","tags":["RETAIL"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"multiCurrencyAccountId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"arrangementEffectiveDate":"string","mcySettlement":[{}]}},"responses":{"200":"performLiveClosureResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"GET","path":"/holdings/customer/{customerId}/multiCurrencyAccounts","fullPath":"/api/v1.0.0/holdings/customer/{customerId}/multiCurrencyAccounts","operationId":"getCustomerMultiCurrencyAccounts","name":"Retrieves the list of multi currency accounts associated with a customer. The details include account number, ledger balance, available balance, etc.","summary":"Retrieves the list of multi currency accounts associated with a customer","tags":["RETAIL"],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"Identifier of the customer"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"CustomerMultiCurrencyAccountsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/accounts/multiCurrencyAccounts/{multiCurrencyAccountId}/subAccounts","fullPath":"/api/v1.0.0/holdings/accounts/multiCurrencyAccounts/{multiCurrencyAccountId}/subAccounts","operationId":"getMcySubAccounts","name":"Retrieves the list of multi currency sub account accounts associated with a mutli currency account.The details include account number, ledger balance, available balance, etc.","summary":"Retrieves the list of currency accounts associated with a multi currency account","tags":["RETAIL"],"parameters":[{"name":"multiCurrencyAccountId","in":"path","type":"string","required":true,"description":"Indicates an arrangement reference which acts as a master for the sub arrangements being created in different currencies"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"McySubAccountsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/accounts/multiCurrencyAccounts/{multiCurrencyAccountId}/payoffCalculations","fullPath":"/api/v1.0.0/holdings/accounts/multiCurrencyAccounts/{multiCurrencyAccountId}/payoffCalculations","operationId":"getMcyPayoffBill","name":"Retrieves the payoff bill after  payoff calculations is initiated. The payoff amount for the multi currency account  includes  account balances, interest, and charge amounts.","summary":"Retrieves the payoff bill generated for an multi currency account","tags":["RETAIL"],"parameters":[{"name":"multiCurrencyAccountId","in":"path","type":"string","required":true,"description":"Indicates an arrangement reference which acts as a master for the sub arrangements being created in different currencies"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"McyPayoffBillResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"POST","path":"/holdings/accounts/multiCurrencyAccounts/{multiCurrencyAccountId}/payoffCalculations","fullPath":"/api/v1.0.0/holdings/accounts/multiCurrencyAccounts/{multiCurrencyAccountId}/payoffCalculations","operationId":"simulateMultiCurrencyAccountPayoff","name":"Calculate the payoff amount for the multi currency account which includes the outstanding amounts and also amounts such as account balances, interest, and charge amounts","summary":"Calculate the outstanding amount to close the multi currency account","tags":["RETAIL"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"multiCurrencyAccountId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"closureNotes":[{}],"activityId":"string","automaticRun":"string","simulationRunReference":"string","effectiveDate":"2024-01-01","currencyId":"string","transactionAmount":0.0,"closureReason":"string"}},"responses":{"200":"simulateMultiCurrencyAccountPayoffResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"POST","path":"/holdings/accounts/multiCurrencyAccounts/{multiCurrencyAccountId}/positionTransfers","fullPath":"/api/v1.0.0/holdings/accounts/multiCurrencyAccounts/{multiCurrencyAccountId}/positionTransfers","operationId":"triggerInternalTransfer","name":"Initiates an internal position transfer between two currency accounts of a multi-currency account. The payload should include debit currency, credit currency and the amount to be transferred.","summary":"Initiates position transfer between two currency accounts of a multi-currency account","tags":["RETAIL"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"multiCurrencyAccountId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"positionTransfers":[{}]}},"responses":{"200":"triggerInternalTransferResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"GET","path":"/holdings/accounts/multiCurrencyAccounts/{multiCurrencyAccountId}/statements","fullPath":"/api/v1.0.0/holdings/accounts/multiCurrencyAccounts/{multiCurrencyAccountId}/statements","operationId":"getMcyRecentTxns","name":"Retrieves the statement details of the transactions for the given multi currency account such as booking date, value date, transaction reference, transaction code, debit or credit amount based on the given value date and transaction count. If value date is not given, retrieves the transactions with the value date lesser than or equals to today. If transaction count is not given, retrieves the last 10 transaction details.","summary":"Retrieves the statement details for the given account","tags":["RETAIL"],"parameters":[{"name":"multiCurrencyAccountId","in":"path","type":"string","required":true,"description":"Indicates an arrangement reference which acts as a master for the sub arrangements being created in different currencies"},{"name":"valueDate","in":"query","type":"string","required":false,"description":"Indicates the value date on which the underlying accounting entry is to be given value (for interest purposes)"},{"name":"currency","in":"query","type":"string","required":false,"description":"Identifies the currency. E.g. USD, GBP etc"},{"name":"transactionCount","in":"query","type":"string","required":false,"description":"Indicates the total number of transactions"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"McyRecentTxnsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"POST","path":"/holdings/accounts/multiCurrencyAccounts/{multiCurrencyAccountId}/products","fullPath":"/api/v1.0.0/holdings/accounts/multiCurrencyAccounts/{multiCurrencyAccountId}/products","operationId":"changeMultiCurrencyProduct","name":"Changes the product of the multi currency account to another product. When the product of a multi currency account is changed, the product of the sub accounts under that multi currency account are also automatically changed to the sub account product of the current (new) multi currency account product. ","summary":"Changes the product of a multi currency account","tags":["RETAIL"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"multiCurrencyAccountId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"productId":"string","effectiveDate":"2024-01-01"}},"responses":{"200":"changeMultiCurrencyProductResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}}]},{"key":"holdings-multicurrencyaccount-arrangements-v2.0.0","title":"Multi Currency Account Arrangements","version":"v2.0.0","description":"The Arrangement Architecture is a Temenos Transact Framework to create and manage  various products such as Loans, Deposits, Accounts, Multi Currency Account, etc. It provides a modular business component-based architecture, whereby users can create their Products by using the components provided by","endpointCount":18,"endpoints":[{"method":"POST","path":"/holdings/accounts/multiCurrencyAccounts/subAccounts","fullPath":"/api/v2.0.0/holdings/accounts/multiCurrencyAccounts/subAccounts","operationId":"createMultiCurrencySubAccount","name":"Create multicurrency sub account","summary":"Create multicurrency sub account","tags":["RETAIL"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"customers":[{}],"multiCurrencyAccountId":"string","productId":"string","activityId":"string","currency":"string","arrangementEffectiveDate":"string","extensions":{},"balance":[{}],"customer":[{}],"crinterest":[{}],"drinterest":[{}],"limit":[{}],"schedule":[{}],"settlement":[{}],"statement":[{}]}},"responses":{"200":"createMultiCurrencySubAccountResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"PUT","path":"/holdings/accounts/multiCurrencyAccounts/{multiCurrencyAccountId}/customers","fullPath":"/api/v2.0.0/holdings/accounts/multiCurrencyAccounts/{multiCurrencyAccountId}/customers","operationId":"updateMultiCurrencyAccountCustomer","name":"Update the customer details of the multi currency account such as add or remove the joint customers, tax liability percentange, limit liability percentage of the joint customers and GL allocation percentage.","summary":"Update customers for the given multi currency account","tags":["RETAIL"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"multiCurrencyAccountId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"partyIds":[{}],"effectiveDate":"2024-01-01","extensions":{},"customer":[{}]}},"responses":{"200":"updateMultiCurrencyAccountCustomerResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"PUT","path":"/holdings/accounts/multiCurrencyAccounts/{multiCurrencyAccountId}/accounts","fullPath":"/api/v2.0.0/holdings/accounts/multiCurrencyAccounts/{multiCurrencyAccountId}/accounts","operationId":"updateMultiCurrencyAccount","name":"Update the account details to change the account title, short name, mnemonic, alternate id of the multi-currency account and also to add or remove posting restrictions in the multi-currency account","summary":"Update the multi currency account's details","tags":["RETAIL"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"multiCurrencyAccountId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"productId":"string","drawdownDate":"2024-01-01","extensions":{},"balance":[{}]}},"responses":{"200":"updateMultiCurrencyAccountResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"POST","path":"/holdings/accounts/multiCurrencyAccounts","fullPath":"/api/v2.0.0/holdings/accounts/multiCurrencyAccounts","operationId":"createMultiCurrencyAccounts","name":"Creates a multi currency account for a single customer or more than one customer(like a joint account relationship) with the customer identifier, customer role, account currency details.","summary":"Creates a multi currency account for a single or joint customer","tags":["RETAIL"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"customers":[{}],"productId":"string","activityId":"string","currency":"string","arrangementEffectiveDate":"string"}},"responses":{"200":"createMultiCurrencyAccountsResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"PUT","path":"/holdings/accounts/multiCurrencyAccounts/{multiCurrencyAccountId}/sweepPriorities","fullPath":"/api/v2.0.0/holdings/accounts/multiCurrencyAccounts/{multiCurrencyAccountId}/sweepPriorities","operationId":"updateSweepPriority","name":"Updates currency priority rules for automatic position transfer between the sub accounts (of different currencies) in the same multi currency account with position adjustment and adjustment order information.","summary":"Updates priority rules for settling insufficient funds","tags":["RETAIL"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"multiCurrencyAccountId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"arrangementEffectiveDate":"string","mcyBalAvl":[{}]}},"responses":{"200":"updateSweepPriorityResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"POST","path":"/holdings/accounts/multiCurrencyAccounts/{multiCurrencyAccountId}/accountClosures","fullPath":"/api/v2.0.0/holdings/accounts/multiCurrencyAccounts/{multiCurrencyAccountId}/accountClosures","operationId":"closeMultiCurrencyAccounts","name":"Perform the closure of the multi currency account after settlement of payoff amount","summary":"Perform the closure of the multi currency account after settlement of payoff amount","tags":["RETAIL"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"multiCurrencyAccountId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"arrangementEffectiveDate":"string"}},"responses":{"200":"closeMultiCurrencyAccountsResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"POST","path":"/holdings/accounts/multiCurrencyAccounts/{multiCurrencyAccountId}/payoffs","fullPath":"/api/v2.0.0/holdings/accounts/multiCurrencyAccounts/{multiCurrencyAccountId}/payoffs","operationId":"performLiveClosure","name":"Perform the settlement of payoff amount for the multi currency account by providing the transaction amount, currency and also settlement instructions","summary":"Perform the settlement of payoff amount for the multi currency account","tags":["RETAIL"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"multiCurrencyAccountId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"arrangementEffectiveDate":"string","mcySettlement":[{}]}},"responses":{"200":"performLiveClosureResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"GET","path":"/holdings/customer/{customerId}/multiCurrencyAccounts","fullPath":"/api/v2.0.0/holdings/customer/{customerId}/multiCurrencyAccounts","operationId":"getCustomerMultiCurrencyAccounts","name":"Retrieves the list of multi currency accounts associated with a customer. The details include account number, ledger balance, available balance, etc.","summary":"Retrieves the list of multi currency accounts associated with a customer","tags":["RETAIL"],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"Identifier of the customer"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"CustomerMultiCurrencyAccountsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/accounts/multiCurrencyAccounts/{multiCurrencyAccountId}/subAccounts","fullPath":"/api/v2.0.0/holdings/accounts/multiCurrencyAccounts/{multiCurrencyAccountId}/subAccounts","operationId":"getMcySubAccounts","name":"Retrieves the list of multi currency sub account accounts associated with a mutli currency account.The details include account number, ledger balance, available balance, etc.","summary":"Retrieves the list of currency accounts associated with a multi currency account","tags":["RETAIL"],"parameters":[{"name":"multiCurrencyAccountId","in":"path","type":"string","required":true,"description":"Indicates an arrangement reference which acts as a master for the sub arrangements being created in different currencies"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"McySubAccountsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/accounts/multiCurrencyAccounts/{multiCurrencyAccountId}/payoffCalculations","fullPath":"/api/v2.0.0/holdings/accounts/multiCurrencyAccounts/{multiCurrencyAccountId}/payoffCalculations","operationId":"getMcyPayoffBill","name":"Retrieves the payoff bill after  payoff calculations is initiated. The payoff amount for the multi currency account  includes  account balances, interest, and charge amounts.","summary":"Retrieves the payoff bill generated for an multi currency account","tags":["RETAIL"],"parameters":[{"name":"multiCurrencyAccountId","in":"path","type":"string","required":true,"description":"Indicates an arrangement reference which acts as a master for the sub arrangements being created in different currencies"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"McyPayoffBillResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"POST","path":"/holdings/accounts/multiCurrencyAccounts/{multiCurrencyAccountId}/payoffCalculations","fullPath":"/api/v2.0.0/holdings/accounts/multiCurrencyAccounts/{multiCurrencyAccountId}/payoffCalculations","operationId":"simulateMultiCurrencyAccountPayoff","name":"Calculate the payoff amount for the multi currency account which includes the outstanding amounts and also amounts such as account balances, interest, and charge amounts","summary":"Calculate the outstanding amount to close the multi currency account","tags":["RETAIL"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"multiCurrencyAccountId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"closureNotes":[{}],"activityId":"string","automaticRun":"string","simulationRunReference":"string","effectiveDate":"2024-01-01","currencyId":"string","transactionAmount":0.0,"closureReason":"string"}},"responses":{"200":"simulateMultiCurrencyAccountPayoffResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"POST","path":"/holdings/accounts/multiCurrencyAccounts/{multiCurrencyAccountId}/positionTransfers","fullPath":"/api/v2.0.0/holdings/accounts/multiCurrencyAccounts/{multiCurrencyAccountId}/positionTransfers","operationId":"triggerInternalTransfer","name":"Initiates an internal position transfer between two currency accounts of a multi-currency account. The payload should include debit currency, credit currency and the amount to be transferred.","summary":"Initiates position transfer between two currency accounts of a multi-currency account","tags":["RETAIL"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"multiCurrencyAccountId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"positionTransfers":[{}]}},"responses":{"200":"triggerInternalTransferResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"GET","path":"/holdings/accounts/multiCurrencyAccounts/{multiCurrencyAccountId}/statements","fullPath":"/api/v2.0.0/holdings/accounts/multiCurrencyAccounts/{multiCurrencyAccountId}/statements","operationId":"getMcyRecentTxns","name":"Retrieves the statement details of the transactions for the given multi currency account such as booking date, value date, transaction reference, transaction code, debit or credit amount based on the given value date and transaction count. If value date is not given, retrieves the transactions with the value date lesser than or equals to today. If transaction count is not given, retrieves the last 10 transaction details.","summary":"Retrieves the statement details for the given account","tags":["RETAIL"],"parameters":[{"name":"multiCurrencyAccountId","in":"path","type":"string","required":true,"description":"Indicates an arrangement reference which acts as a master for the sub arrangements being created in different currencies"},{"name":"valueDate","in":"query","type":"string","required":false,"description":"Indicates the value date on which the underlying accounting entry is to be given value (for interest purposes)"},{"name":"currency","in":"query","type":"string","required":false,"description":"Identifies the currency. E.g. USD, GBP etc"},{"name":"transactionCount","in":"query","type":"string","required":false,"description":"Indicates the total number of transactions"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"McyRecentTxnsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"POST","path":"/holdings/accounts/multiCurrencyAccounts/{multiCurrencyAccountId}/products","fullPath":"/api/v2.0.0/holdings/accounts/multiCurrencyAccounts/{multiCurrencyAccountId}/products","operationId":"changeMultiCurrencyProduct","name":"Changes the product of the multi currency account to another product. When the product of a multi currency account is changed, the product of the sub accounts under that multi currency account are also automatically changed to the sub account product of the current (new) multi currency account product. ","summary":"Changes the product of a multi currency account","tags":["RETAIL"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"multiCurrencyAccountId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"productId":"string","effectiveDate":"2024-01-01"}},"responses":{"200":"changeMultiCurrencyProductResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"PUT","path":"/holdings/accounts/multiCurrencyAccounts/{multiCurrencyAccountId}/settlements","fullPath":"/api/v2.0.0/holdings/accounts/multiCurrencyAccounts/{multiCurrencyAccountId}/settlements","operationId":"updateMultiCurrencyAccountSettlement","name":"Update the settlement conditions of the multi currency account such as payin account, payin percentage, payin amount, payout account, payout percentage, payout amount, etc","summary":"Update the Settlement details of the Multicurrency account","tags":["RETAIL"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"multiCurrencyAccountId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"productId":"string","drawdownDate":"2024-01-01","extensions":{},"settlement":[{}]}},"responses":{"200":"updateMultiCurrencyAccountSettlementResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"PUT","path":"/holdings/accounts/multiCurrencyAccounts/{multiCurrencyAccountId}/schedules","fullPath":"/api/v2.0.0/holdings/accounts/multiCurrencyAccounts/{multiCurrencyAccountId}/schedules","operationId":"updateMultiCurrencyAccountSchedule","name":"Update the payment schedule condition such as payment method from capitalise to pay, payment frequency from monthly to quarterly etc., on a multi currency account","summary":"Update payment schedule for the given multi currency account","tags":["RETAIL"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"multiCurrencyAccountId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"productId":"string","drawdownDate":"2024-01-01","extensions":{},"mcySchedule":[{}]}},"responses":{"200":"updateMultiCurrencyAccountScheduleResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"PUT","path":"/holdings/accounts/{accountId}/lineofBusiness","fullPath":"/api/v2.0.0/holdings/accounts/{accountId}/lineofBusiness","operationId":"updateAccountLob","name":"Updates the type of line of business of the savings account","summary":"Change of line of business for the savings account","tags":["RETAIL"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"accountId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"effectiveDate":"2024-01-01","lineOfBusiness":"string","extensions":{}}},"responses":{"200":"updateAccountLobResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"PUT","path":"/holdings/accounts/multiCurrencyAccounts/{multiCurrencyAccountId}/channels","fullPath":"/api/v2.0.0/holdings/accounts/multiCurrencyAccounts/{multiCurrencyAccountId}/channels","operationId":"updateMultiCurrencyAccountChannel","name":"Updates the channel of the multi currency account","summary":"Change of channel for the multi currency account","tags":["RETAIL"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"multiCurrencyAccountId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"effectiveDate":"2024-01-01","channel":"string","extensions":{}}},"responses":{"200":"updateMultiCurrencyAccountChannelResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}}]},{"key":"holdings-multicurrencyaccount-arrangements-v3.0.0","title":"Multi Currency Account Arrangements","version":"v3.0.0","description":"The arrangement architecture is a Temenos transact framework to create and manage  various products such as loans, deposits, accounts, multi currency account, etc. It provides a modular business component-based architecture, whereby users can create their Products by using the components provided by","endpointCount":17,"endpoints":[{"method":"POST","path":"/holdings/accounts/multiCurrencyAccounts/subAccounts","fullPath":"/api/v3.0.0/holdings/accounts/multiCurrencyAccounts/subAccounts","operationId":"createMultiCurrencySubAccount","name":"Create multicurrency sub account","summary":"Create multicurrency sub account","tags":["RETAIL"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"customers":[{}],"multiCurrencyAccountId":"string","productId":"string","activityId":"string","currency":"string","arrangementEffectiveDate":"string","extensions":{},"balance":[{}],"customer":[{}],"crinterest":[{}],"drinterest":[{}],"limit":[{}],"schedule":[{}],"settlement":[{}],"statement":[{}]}},"responses":{"200":"createMultiCurrencySubAccountResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"PUT","path":"/holdings/accounts/multiCurrencyAccounts/{multiCurrencyAccountId}/customers","fullPath":"/api/v3.0.0/holdings/accounts/multiCurrencyAccounts/{multiCurrencyAccountId}/customers","operationId":"updateMultiCurrencyAccountCustomer","name":"Update the customer details of the multi currency account such as add or remove the joint customers, tax liability percentange, limit liability percentage of the joint customers and GL allocation percentage.","summary":"Update customers for the given multi currency account","tags":["RETAIL"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"multiCurrencyAccountId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"partyIds":[{}],"effectiveDate":"2024-01-01","extensions":{},"customer":[{}]}},"responses":{"200":"updateMultiCurrencyAccountCustomerResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"PUT","path":"/holdings/accounts/multiCurrencyAccounts/{multiCurrencyAccountId}/accounts","fullPath":"/api/v3.0.0/holdings/accounts/multiCurrencyAccounts/{multiCurrencyAccountId}/accounts","operationId":"updateMultiCurrencyAccount","name":"Update the account details to change the account title, short name, mnemonic, alternate id of the multi-currency account and also to add or remove posting restrictions in the multi-currency account","summary":"Update the multi currency account's details","tags":["RETAIL"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"multiCurrencyAccountId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"productId":"string","drawdownDate":"2024-01-01","extensions":{},"balance":[{}]}},"responses":{"200":"updateMultiCurrencyAccountResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"POST","path":"/holdings/accounts/multiCurrencyAccounts","fullPath":"/api/v3.0.0/holdings/accounts/multiCurrencyAccounts","operationId":"createMultiCurrencyAccounts","name":"Creates a multi currency account for a single customer or more than one customer(like a joint account relationship) with the customer identifier, customer role, account currency details.","summary":"Creates a multi currency account for a single or joint customer","tags":["RETAIL"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"customers":[{}],"productId":"string","activityId":"string","currency":"string","arrangementEffectiveDate":"string"}},"responses":{"200":"createMultiCurrencyAccountsResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"PUT","path":"/holdings/accounts/multiCurrencyAccounts/{multiCurrencyAccountId}/sweepPriorities","fullPath":"/api/v3.0.0/holdings/accounts/multiCurrencyAccounts/{multiCurrencyAccountId}/sweepPriorities","operationId":"updateSweepPriority","name":"Updates currency priority rules for automatic position transfer between the sub accounts (of different currencies) in the same multi currency account with position adjustment and adjustment order information.","summary":"Updates priority rules for settling insufficient funds","tags":["RETAIL"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"multiCurrencyAccountId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"arrangementEffectiveDate":"string","mcyBalAvl":[{}]}},"responses":{"200":"updateSweepPriorityResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"POST","path":"/holdings/accounts/multiCurrencyAccounts/{multiCurrencyAccountId}/accountClosures","fullPath":"/api/v3.0.0/holdings/accounts/multiCurrencyAccounts/{multiCurrencyAccountId}/accountClosures","operationId":"closeMultiCurrencyAccounts","name":"Perform the closure of the multi currency account after settlement of payoff amount","summary":"Perform the closure of the multi currency account after settlement of payoff amount","tags":["RETAIL"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"multiCurrencyAccountId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"arrangementEffectiveDate":"string"}},"responses":{"200":"closeMultiCurrencyAccountsResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"POST","path":"/holdings/accounts/multiCurrencyAccounts/{multiCurrencyAccountId}/payoffs","fullPath":"/api/v3.0.0/holdings/accounts/multiCurrencyAccounts/{multiCurrencyAccountId}/payoffs","operationId":"performLiveClosure","name":"Perform the settlement of payoff amount for the multi currency account by providing the transaction amount, currency and also settlement instructions","summary":"Perform the settlement of payoff amount for the multi currency account","tags":["RETAIL"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"multiCurrencyAccountId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"arrangementEffectiveDate":"string","mcySettlement":[{}]}},"responses":{"200":"performLiveClosureResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"GET","path":"/holdings/customer/{customerId}/multiCurrencyAccounts","fullPath":"/api/v3.0.0/holdings/customer/{customerId}/multiCurrencyAccounts","operationId":"getCustomerMultiCurrencyAccounts","name":"Retrieves the list of multi currency accounts associated with a customer. The details include account number, ledger balance, available balance, etc.","summary":"Retrieves the list of multi currency accounts associated with a customer","tags":["RETAIL"],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"Identifier of the customer"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"CustomerMultiCurrencyAccountsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/accounts/multiCurrencyAccounts/{multiCurrencyAccountId}/subAccounts","fullPath":"/api/v3.0.0/holdings/accounts/multiCurrencyAccounts/{multiCurrencyAccountId}/subAccounts","operationId":"getMcySubAccounts","name":"Retrieves the list of multi currency sub account accounts associated with a mutli currency account.The details include account number, ledger balance, available balance, etc.","summary":"Retrieves the list of currency accounts associated with a multi currency account","tags":["RETAIL"],"parameters":[{"name":"multiCurrencyAccountId","in":"path","type":"string","required":true,"description":"Indicates an arrangement reference which acts as a master for the sub arrangements being created in different currencies"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"McySubAccountsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/accounts/multiCurrencyAccounts/{multiCurrencyAccountId}/payoffCalculations","fullPath":"/api/v3.0.0/holdings/accounts/multiCurrencyAccounts/{multiCurrencyAccountId}/payoffCalculations","operationId":"getMcyPayoffBill","name":"Retrieves the payoff bill after  payoff calculations is initiated. The payoff amount for the multi currency account  includes  account balances, interest, and charge amounts.","summary":"Retrieves the payoff bill generated for an multi currency account","tags":["RETAIL"],"parameters":[{"name":"multiCurrencyAccountId","in":"path","type":"string","required":true,"description":"Indicates an arrangement reference which acts as a master for the sub arrangements being created in different currencies"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"McyPayoffBillResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"POST","path":"/holdings/accounts/multiCurrencyAccounts/{multiCurrencyAccountId}/payoffCalculations","fullPath":"/api/v3.0.0/holdings/accounts/multiCurrencyAccounts/{multiCurrencyAccountId}/payoffCalculations","operationId":"simulateMultiCurrencyAccountPayoff","name":"Calculate the payoff amount for the multi currency account which includes the outstanding amounts and also amounts such as account balances, interest, and charge amounts","summary":"Calculate the outstanding amount to close the multi currency account","tags":["RETAIL"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"multiCurrencyAccountId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"closureNotes":[{}],"activityId":"string","automaticRun":"string","simulationRunReference":"string","effectiveDate":"2024-01-01","currencyId":"string","transactionAmount":0.0,"closureReason":"string"}},"responses":{"200":"simulateMultiCurrencyAccountPayoffResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"POST","path":"/holdings/accounts/multiCurrencyAccounts/{multiCurrencyAccountId}/positionTransfers","fullPath":"/api/v3.0.0/holdings/accounts/multiCurrencyAccounts/{multiCurrencyAccountId}/positionTransfers","operationId":"triggerInternalTransfer","name":"Creates an internal position transfer between two currency accounts of a multi-currency account. The payload should include debit currency, credit currency and the amount to be transferred.","summary":"Creates a position transfer between two currency accounts of a multi-currency account","tags":["RETAIL"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"multiCurrencyAccountId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"positionTransfers":[{}]}},"responses":{"200":"triggerInternalTransferResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"GET","path":"/holdings/accounts/multiCurrencyAccounts/{multiCurrencyAccountId}/statements","fullPath":"/api/v3.0.0/holdings/accounts/multiCurrencyAccounts/{multiCurrencyAccountId}/statements","operationId":"getMcyRecentTxns","name":"Retrieves the statement details of the transactions for the given multi currency account such as booking date, value date, transaction reference, transaction code, debit or credit amount based on the given value date and transaction count. If value date is not given, retrieves the transactions with the value date lesser than or equals to today. If transaction count is not given, retrieves the last 10 transaction details.","summary":"Retrieves the statement details for the given account","tags":["RETAIL"],"parameters":[{"name":"multiCurrencyAccountId","in":"path","type":"string","required":true,"description":"Indicates an arrangement reference which acts as a master for the sub arrangements being created in different currencies"},{"name":"valueDate","in":"query","type":"string","required":false,"description":"Indicates the value date on which the underlying accounting entry is to be given value (for interest purposes)"},{"name":"currency","in":"query","type":"string","required":false,"description":"Identifies the currency. E.g. USD, GBP etc"},{"name":"transactionCount","in":"query","type":"string","required":false,"description":"Indicates the total number of transactions"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"McyRecentTxnsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"POST","path":"/holdings/accounts/multiCurrencyAccounts/{multiCurrencyAccountId}/products","fullPath":"/api/v3.0.0/holdings/accounts/multiCurrencyAccounts/{multiCurrencyAccountId}/products","operationId":"changeMultiCurrencyProduct","name":"Update the product of the multi currency account to another product. When the product of a multi currency account is changed, the product of the sub accounts under that multi currency account are also automatically changed to the sub account product of the current (new) multi currency account product. ","summary":"Update the product of a multi currency account","tags":["RETAIL"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"multiCurrencyAccountId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"productId":"string","effectiveDate":"2024-01-01"}},"responses":{"200":"changeMultiCurrencyProductResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"PUT","path":"/holdings/accounts/multiCurrencyAccounts/{multiCurrencyAccountId}/settlements","fullPath":"/api/v3.0.0/holdings/accounts/multiCurrencyAccounts/{multiCurrencyAccountId}/settlements","operationId":"updateMultiCurrencyAccountSettlement","name":"Update the settlement conditions of the multi currency account such as payin account, payin percentage, payin amount, payout account, payout percentage, payout amount, etc","summary":"Update the settlement details of the multicurrency account","tags":["RETAIL"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"multiCurrencyAccountId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"productId":"string","drawdownDate":"2024-01-01","extensions":{},"settlement":[{}]}},"responses":{"200":"updateMultiCurrencyAccountSettlementResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"PUT","path":"/holdings/accounts/multiCurrencyAccounts/{multiCurrencyAccountId}/schedules","fullPath":"/api/v3.0.0/holdings/accounts/multiCurrencyAccounts/{multiCurrencyAccountId}/schedules","operationId":"updateMultiCurrencyAccountSchedule","name":"Update the payment schedule condition such as payment method from capitalise to pay, payment frequency from monthly to quarterly etc., on a multi currency account","summary":"Update payment schedule for the given multi currency account","tags":["RETAIL"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"multiCurrencyAccountId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"productId":"string","drawdownDate":"2024-01-01","extensions":{},"mcySchedule":[{}]}},"responses":{"200":"updateMultiCurrencyAccountScheduleResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"PUT","path":"/holdings/accounts/multiCurrencyAccounts/{multiCurrencyAccountId}/channels","fullPath":"/api/v3.0.0/holdings/accounts/multiCurrencyAccounts/{multiCurrencyAccountId}/channels","operationId":"updateMultiCurrencyAccountChannel","name":"Updates the channel of the multi currency account","summary":"Update the channel for the multi currency account","tags":["RETAIL"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"multiCurrencyAccountId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"effectiveDate":"2024-01-01","channel":"string","extensions":{}}},"responses":{"200":"updateMultiCurrencyAccountChannelResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}}]},{"key":"holdings-multicurrencyaccount-arrangements-v3.1.0","title":"Multi Currency Account Arrangements","version":"v3.1.0","description":"The arrangement architecture is a Temenos Transact framework to create and manage  various products such as loans, deposits, accounts, multi currency account, etc. It provides a modular business component-based architecture, whereby users can create their Products by using the components provided by","endpointCount":17,"endpoints":[{"method":"POST","path":"/holdings/accounts/multiCurrencyAccounts/subAccounts","fullPath":"/api/v3.1.0/holdings/accounts/multiCurrencyAccounts/subAccounts","operationId":"createMultiCurrencySubAccount","name":"Create multicurrency sub account","summary":"Create multicurrency sub account","tags":["RETAIL"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"customers":[{}],"multiCurrencyAccountId":"string","productId":"string","activityId":"string","currency":"string","arrangementEffectiveDate":"string","extensions":{},"balance":[{}],"customer":[{}],"crinterest":[{}],"drinterest":[{}],"limit":[{}],"schedule":[{}],"settlement":[{}],"statement":[{}]}},"responses":{"200":"createMultiCurrencySubAccountResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"PUT","path":"/holdings/accounts/multiCurrencyAccounts/{multiCurrencyAccountId}/customers","fullPath":"/api/v3.1.0/holdings/accounts/multiCurrencyAccounts/{multiCurrencyAccountId}/customers","operationId":"updateMultiCurrencyAccountCustomer","name":"Update the customer details of the multi currency account such as add or remove the joint customers, tax liability percentange, limit liability percentage of the joint customers and GL allocation percentage.","summary":"Update customers for the given multi currency account","tags":["RETAIL"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"multiCurrencyAccountId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"partyIds":[{}],"effectiveDate":"2024-01-01","extensions":{},"customer":[{}]}},"responses":{"200":"updateMultiCurrencyAccountCustomerResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"PUT","path":"/holdings/accounts/multiCurrencyAccounts/{multiCurrencyAccountId}/accounts","fullPath":"/api/v3.1.0/holdings/accounts/multiCurrencyAccounts/{multiCurrencyAccountId}/accounts","operationId":"updateMultiCurrencyAccount","name":"Update the account details to change the account title, short name, mnemonic, alternate id of the multi-currency account and also to add or remove posting restrictions in the multi-currency account","summary":"Update the multi currency account's details","tags":["RETAIL"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"multiCurrencyAccountId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"productId":"string","effectiveDate":"2024-01-01","extensions":{},"balance":[{}]}},"responses":{"200":"updateMultiCurrencyAccountResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"POST","path":"/holdings/accounts/multiCurrencyAccounts","fullPath":"/api/v3.1.0/holdings/accounts/multiCurrencyAccounts","operationId":"createMultiCurrencyAccounts","name":"Creates a multi currency account for a single customer or more than one customer(like a joint account relationship) with the customer identifier, customer role, account currency details.","summary":"Creates a multi currency account for a single or joint customer","tags":["RETAIL"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"customers":[{}],"productId":"string","activityId":"string","currency":"string","arrangementEffectiveDate":"string"}},"responses":{"200":"createMultiCurrencyAccountsResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"PUT","path":"/holdings/accounts/multiCurrencyAccounts/{multiCurrencyAccountId}/sweepPriorities","fullPath":"/api/v3.1.0/holdings/accounts/multiCurrencyAccounts/{multiCurrencyAccountId}/sweepPriorities","operationId":"updateSweepPriority","name":"Updates currency priority rules for automatic position transfer between the sub accounts (of different currencies) in the same multi currency account with position adjustment and adjustment order information.","summary":"Updates priority rules for settling insufficient funds","tags":["RETAIL"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"multiCurrencyAccountId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"arrangementEffectiveDate":"string","mcyBalAvl":[{}]}},"responses":{"200":"updateSweepPriorityResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"POST","path":"/holdings/accounts/multiCurrencyAccounts/{multiCurrencyAccountId}/accountClosures","fullPath":"/api/v3.1.0/holdings/accounts/multiCurrencyAccounts/{multiCurrencyAccountId}/accountClosures","operationId":"closeMultiCurrencyAccounts","name":"Perform the closure of the multi currency account after settlement of payoff amount","summary":"Perform the closure of the multi currency account after settlement of payoff amount","tags":["RETAIL"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"multiCurrencyAccountId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"arrangementEffectiveDate":"string"}},"responses":{"200":"closeMultiCurrencyAccountsResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"POST","path":"/holdings/accounts/multiCurrencyAccounts/{multiCurrencyAccountId}/payoffs","fullPath":"/api/v3.1.0/holdings/accounts/multiCurrencyAccounts/{multiCurrencyAccountId}/payoffs","operationId":"performLiveClosure","name":"Perform the settlement of payoff amount for the multi currency account by providing the transaction amount, currency and also settlement instructions","summary":"Perform the settlement of payoff amount for the multi currency account","tags":["RETAIL"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"multiCurrencyAccountId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"arrangementEffectiveDate":"string","mcySettlement":[{}]}},"responses":{"200":"performLiveClosureResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"GET","path":"/holdings/customer/{customerId}/multiCurrencyAccounts","fullPath":"/api/v3.1.0/holdings/customer/{customerId}/multiCurrencyAccounts","operationId":"getCustomerMultiCurrencyAccounts","name":"Retrieves the list of multi currency accounts associated with a customer. The details include account number, ledger balance, available balance, etc.","summary":"Retrieves the list of multi currency accounts associated with a customer","tags":["RETAIL"],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"Identifier of the customer"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"CustomerMultiCurrencyAccountsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/accounts/multiCurrencyAccounts/{multiCurrencyAccountId}/subAccounts","fullPath":"/api/v3.1.0/holdings/accounts/multiCurrencyAccounts/{multiCurrencyAccountId}/subAccounts","operationId":"getMcySubAccounts","name":"Retrieves the list of multi currency sub account accounts associated with a mutli currency account.The details include account number, ledger balance, available balance, etc.","summary":"Retrieves the list of currency accounts associated with a multi currency account","tags":["RETAIL"],"parameters":[{"name":"multiCurrencyAccountId","in":"path","type":"string","required":true,"description":"Indicates an arrangement reference which acts as a master for the sub arrangements being created in different currencies"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"McySubAccountsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/accounts/multiCurrencyAccounts/{multiCurrencyAccountId}/payoffCalculations","fullPath":"/api/v3.1.0/holdings/accounts/multiCurrencyAccounts/{multiCurrencyAccountId}/payoffCalculations","operationId":"getMcyPayoffBill","name":"Retrieves the payoff bill after  payoff calculations is initiated. The payoff amount for the multi currency account  includes  account balances, interest, and charge amounts.","summary":"Retrieves the payoff bill generated for an multi currency account","tags":["RETAIL"],"parameters":[{"name":"multiCurrencyAccountId","in":"path","type":"string","required":true,"description":"Indicates an arrangement reference which acts as a master for the sub arrangements being created in different currencies"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"McyPayoffBillResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"POST","path":"/holdings/accounts/multiCurrencyAccounts/{multiCurrencyAccountId}/payoffCalculations","fullPath":"/api/v3.1.0/holdings/accounts/multiCurrencyAccounts/{multiCurrencyAccountId}/payoffCalculations","operationId":"simulateMultiCurrencyAccountPayoff","name":"Calculate the payoff amount for the multi currency account which includes the outstanding amounts and also amounts such as account balances, interest, and charge amounts","summary":"Calculate the outstanding amount to close the multi currency account","tags":["RETAIL"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"multiCurrencyAccountId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"closureNotes":[{}],"activityId":"string","automaticRun":"string","simulationRunReference":"string","effectiveDate":"2024-01-01","currencyId":"string","transactionAmount":0.0,"closureReason":"string"}},"responses":{"200":"simulateMultiCurrencyAccountPayoffResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"POST","path":"/holdings/accounts/multiCurrencyAccounts/{multiCurrencyAccountId}/positionTransfers","fullPath":"/api/v3.1.0/holdings/accounts/multiCurrencyAccounts/{multiCurrencyAccountId}/positionTransfers","operationId":"triggerInternalTransfer","name":"Creates an internal position transfer between two currency accounts of a multi-currency account. The payload should include debit currency, credit currency and the amount to be transferred.","summary":"Creates a position transfer between two currency accounts of a multi-currency account","tags":["RETAIL"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"multiCurrencyAccountId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"positionTransfers":[{}]}},"responses":{"200":"triggerInternalTransferResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"GET","path":"/holdings/accounts/multiCurrencyAccounts/{multiCurrencyAccountId}/statements","fullPath":"/api/v3.1.0/holdings/accounts/multiCurrencyAccounts/{multiCurrencyAccountId}/statements","operationId":"getMcyRecentTxns","name":"Retrieves the statement details of the transactions for the given multi currency account such as booking date, value date, transaction reference, transaction code, debit or credit amount based on the given value date and transaction count. If value date is not given, retrieves the transactions with the value date lesser than or equals to today. If transaction count is not given, retrieves the last 10 transaction details.","summary":"Retrieves the statement details for the given account","tags":["RETAIL"],"parameters":[{"name":"multiCurrencyAccountId","in":"path","type":"string","required":true,"description":"Indicates an arrangement reference which acts as a master for the sub arrangements being created in different currencies"},{"name":"valueDate","in":"query","type":"string","required":false,"description":"Indicates the value date on which the underlying accounting entry is to be given value (for interest purposes)"},{"name":"currency","in":"query","type":"string","required":false,"description":"Identifies the currency. E.g. USD, GBP etc"},{"name":"transactionCount","in":"query","type":"string","required":false,"description":"Indicates the total number of transactions"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"McyRecentTxnsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"POST","path":"/holdings/accounts/multiCurrencyAccounts/{multiCurrencyAccountId}/products","fullPath":"/api/v3.1.0/holdings/accounts/multiCurrencyAccounts/{multiCurrencyAccountId}/products","operationId":"changeMultiCurrencyProduct","name":"Update the product of the multi currency account to another product. When the product of a multi currency account is changed, the product of the sub accounts under that multi currency account are also automatically changed to the sub account product of the current (new) multi currency account product. ","summary":"Update the product of a multi currency account","tags":["RETAIL"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"multiCurrencyAccountId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"productId":"string","effectiveDate":"2024-01-01"}},"responses":{"200":"changeMultiCurrencyProductResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"PUT","path":"/holdings/accounts/multiCurrencyAccounts/{multiCurrencyAccountId}/settlements","fullPath":"/api/v3.1.0/holdings/accounts/multiCurrencyAccounts/{multiCurrencyAccountId}/settlements","operationId":"updateMultiCurrencyAccountSettlement","name":"Update the settlement conditions of the multi currency account such as payin account, payin percentage, payin amount, payout account, payout percentage, payout amount, etc","summary":"Update the settlement details of the multicurrency account","tags":["RETAIL"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"multiCurrencyAccountId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"productId":"string","effectiveDate":"2024-01-01","extensions":{},"settlement":[{}]}},"responses":{"200":"updateMultiCurrencyAccountSettlementResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"PUT","path":"/holdings/accounts/multiCurrencyAccounts/{multiCurrencyAccountId}/schedules","fullPath":"/api/v3.1.0/holdings/accounts/multiCurrencyAccounts/{multiCurrencyAccountId}/schedules","operationId":"updateMultiCurrencyAccountSchedule","name":"Update the payment schedule condition such as payment method from capitalise to pay, payment frequency from monthly to quarterly etc., on a multi currency account","summary":"Update payment schedule for the given multi currency account","tags":["RETAIL"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"multiCurrencyAccountId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"productId":"string","effectiveDate":"2024-01-01","extensions":{},"mcySchedule":[{}]}},"responses":{"200":"updateMultiCurrencyAccountScheduleResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"PUT","path":"/holdings/accounts/multiCurrencyAccounts/{multiCurrencyAccountId}/channels","fullPath":"/api/v3.1.0/holdings/accounts/multiCurrencyAccounts/{multiCurrencyAccountId}/channels","operationId":"updateMultiCurrencyAccountChannel","name":"Updates the channel of the multi currency account","summary":"Update the channel for the multi currency account","tags":["RETAIL"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"multiCurrencyAccountId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"effectiveDate":"2024-01-01","channel":"string","extensions":{}}},"responses":{"200":"updateMultiCurrencyAccountChannelResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}}]},{"key":"holdings-onlineAccounts-service-v1.0.0","title":"Holdings Online Accounts APIs Deprecated","version":"v1.0.0","description":"Retrieves the list and details of online accounts","endpointCount":1,"endpoints":[{"method":"GET","path":"/holdings/accounts/{accountId}","fullPath":"/api/v1.0.0/holdings/accounts/{accountId}","operationId":"getAccountDetails","name":"Retrieves account details","summary":"Retrieves the account specific information for Internet Banking Users - Deprecated. Use holdings-accounts-service-v4.0.0 instead","tags":[],"parameters":[{"name":"accountId","in":"path","type":"string","required":true,"description":"Identifier of the account. Often referred to as the account number, yet for consistency this is always referred to as accountId. Accepts both IBAN & BBAN"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"AccountDetailsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}}]},{"key":"holdings-outstandingBills-v1.0.0","title":"Account bill details","version":"v1.0.0","description":"API to retrieve the Bill Details of an arrangement account","endpointCount":8,"endpoints":[{"method":"GET","path":"/holdings/accounts/{arrangementId}/outstandingBills","fullPath":"/api/v1.0.0/holdings/accounts/{arrangementId}/outstandingBills","operationId":"getOutstandingBills","name":"Retrieves the Outstanding amount to be paid for an account-This API is deprecated and going forward the following URL has to be used.URL:/holdings/arrangements/{arrangementId}/outstandingBills","summary":"Retrieves the Outstanding amount to be paid for an account","tags":[],"parameters":[{"name":"arrangementId","in":"path","type":"string","required":true,"description":"Indicates an unique identifier of an account"},{"name":"fileVersion","in":"query","type":"string","required":false,"description":"Indicates if the file is of type simulation or live"},{"name":"simulationReference","in":"query","type":"string","required":false,"description":"Indicates the Reference ID for simulation activity"},{"name":"paymentDate","in":"query","type":"string","required":false,"description":"The date on which a payment is due"},{"name":"deferDate","in":"query","type":"string","required":false,"description":"Date that the payment has been deferred to"},{"name":"billedAmount","in":"query","type":"string","required":false,"description":"Indicates the bill amount"},{"name":"outstandingAmount","in":"query","type":"string","required":false,"description":"Contains the aggregate outstanding principal amount thereof after giving effect to any borrowings and prepayments or repayments of Committed Loans"},{"name":"delinquentAmount","in":"query","type":"string","required":false,"description":"Indicates the bill amount during the ageing status(Bill which crossed the due date)"},{"name":"property","in":"query","type":"string","required":false,"description":"Id of the product property"},{"name":"billStatus","in":"query","type":"string","required":false,"description":"Indicates the status of a bill(Issued,Due,Ageing,Settled)"},{"name":"settlementStatus","in":"query","type":"string","required":false,"description":"Defines the status of the settlement for the incoming MT548 swift message.The values allowed are: Waiting : pending to receive settlement status update meaning pending to receive MT548 swift message, "},{"name":"agingStatus","in":"query","type":"string","required":false,"description":"Indicates the ageing status of a bill"},{"name":"settled","in":"query","type":"string","required":false,"description":"Flag to indicate whether a bill is settled or not"},{"name":"paymentType","in":"query","type":"string","required":false,"description":"Indicates if the payment is Customer (C) type or Bank (B) type"},{"name":"billDate","in":"query","type":"string","required":false,"description":"Indicates a date on which a bill has been raised"},{"name":"billType","in":"query","type":"string","required":false,"description":"The type of payment obligation generated"},{"name":"paymentMethod","in":"query","type":"string","required":false,"description":"Method chosen to make the payment"},{"name":"infoPayType","in":"query","type":"string","required":false,"description":"Indicates a bill which is raised when a loan is paid off"},{"name":"advancePayment","in":"query","type":"string","required":false,"description":"Indicates whether advance payment made is set on an account"},{"name":"paymentIndicator","in":"query","type":"string","required":false,"description":"Indicates whether its a credit/debit type of bill"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"OutstandingBillsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/accounts/{arrangementId}/deferredBills","fullPath":"/api/v1.0.0/holdings/accounts/{arrangementId}/deferredBills","operationId":"getDeferredBills","name":"Retrieves the details of the deferred bills-This API is deprecated and going forward the following URL has to be used.URL:/holdings/arrangements/{arrangementId}/deferredBills","summary":"Retrieves the details of the deferred bills","tags":[],"parameters":[{"name":"arrangementId","in":"path","type":"string","required":true,"description":"Indicates an unique identifier of an account"},{"name":"fileVersion","in":"query","type":"string","required":false,"description":"Indicates if the file is of type simulation or live"},{"name":"simulationReference","in":"query","type":"string","required":false,"description":"Indicates the Reference ID for simulation activity"},{"name":"paymentDate","in":"query","type":"string","required":false,"description":"The date on which a payment is due"},{"name":"deferDate","in":"query","type":"string","required":false,"description":"Date that the payment has been deferred to"},{"name":"billedAmount","in":"query","type":"string","required":false,"description":"Indicates the bill amount"},{"name":"outstandingAmount","in":"query","type":"string","required":false,"description":"Contains the aggregate outstanding principal amount thereof after giving effect to any borrowings and prepayments or repayments of Committed Loans"},{"name":"delinquentAmount","in":"query","type":"string","required":false,"description":"Indicates the bill amount during the ageing status(Bill which crossed the due date)"},{"name":"property","in":"query","type":"string","required":false,"description":"Id of the product property"},{"name":"billStatus","in":"query","type":"string","required":false,"description":"Indicates the status of a bill(Issued,Due,Ageing,Settled)"},{"name":"settlementStatus","in":"query","type":"string","required":false,"description":"Defines the status of the settlement for the incoming MT548 swift message.The values allowed are: Waiting : pending to receive settlement status update meaning pending to receive MT548 swift message, "},{"name":"agingStatus","in":"query","type":"string","required":false,"description":"Indicates the ageing status of a bill"},{"name":"paymentType","in":"query","type":"string","required":false,"description":"Indicates if the payment is Customer (C) type or Bank (B) type"},{"name":"billDate","in":"query","type":"string","required":false,"description":"Indicates a date on which a bill has been raised"},{"name":"billType","in":"query","type":"string","required":false,"description":"The type of payment obligation generated"},{"name":"paymentMethod","in":"query","type":"string","required":false,"description":"Method chosen to make the payment"},{"name":"infoPayType","in":"query","type":"string","required":false,"description":"Indicates a bill which is raised when a loan is paid off"},{"name":"advancePayment","in":"query","type":"string","required":false,"description":"Indicates whether advance payment made is set on an account"},{"name":"paymentIndicator","in":"query","type":"string","required":false,"description":"Indicates whether its a credit/debit type of bill"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"DeferredBillsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/accounts/{arrangementId}/externalBills","fullPath":"/api/v1.0.0/holdings/accounts/{arrangementId}/externalBills","operationId":"getExternalBills","name":"Retrieves the details of the external type of bills-This API is deprecated and going forward the following URL has to be used.URL:/holdings/arrangements/{arrangementId}/externalBills","summary":"Retrieves the details of the external type of bills","tags":[],"parameters":[{"name":"arrangementId","in":"path","type":"string","required":true,"description":"Indicates an unique identifier of an account"},{"name":"simulationReference","in":"query","type":"string","required":false,"description":"Indicates the Reference ID for simulation activity"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"ExternalBillsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/accounts/{arrangementId}/billDetails","fullPath":"/api/v1.0.0/holdings/accounts/{arrangementId}/billDetails","operationId":"getAllBills","name":"Retrieves the details of all the types of bills-This API is deprecated and going forward the following URL has to be used.URL:/holdings/arrangements/{arrangementId}/bills","summary":"Retrieves the details of all the types of bills","tags":[],"parameters":[{"name":"arrangementId","in":"path","type":"string","required":true,"description":"Indicates an unique identifier of an account"},{"name":"fileVersion","in":"query","type":"string","required":false,"description":"Indicates if the file is of type simulation or live"},{"name":"simulationReference","in":"query","type":"string","required":false,"description":"Indicates the Reference ID for simulation activity"},{"name":"paymentDate","in":"query","type":"string","required":false,"description":"The date on which a payment is due"},{"name":"deferDate","in":"query","type":"string","required":false,"description":"Date that the payment has been deferred to"},{"name":"billedAmount","in":"query","type":"string","required":false,"description":"Indicates the bill amount"},{"name":"outstandingAmount","in":"query","type":"string","required":false,"description":"Contains the aggregate outstanding principal amount thereof after giving effect to any borrowings and prepayments or repayments of Committed Loans"},{"name":"delinquentAmount","in":"query","type":"string","required":false,"description":"Indicates the bill amount during the ageing status(Bill which crossed the due date)"},{"name":"property","in":"query","type":"string","required":false,"description":"Id of the product property"},{"name":"billStatus","in":"query","type":"string","required":false,"description":"Indicates the status of a bill(Issued,Due,Ageing,Settled)"},{"name":"settlementStatus","in":"query","type":"string","required":false,"description":"Defines the status of the settlement for the incoming MT548 swift message.The values allowed are: Waiting : pending to receive settlement status update meaning pending to receive MT548 swift message, "},{"name":"agingStatus","in":"query","type":"string","required":false,"description":"Indicates the ageing status of a bill"},{"name":"settled","in":"query","type":"string","required":false,"description":"Flag to indicate whether a bill is settled or not"},{"name":"paymentType","in":"query","type":"string","required":false,"description":"Indicates if the payment is Customer (C) type or Bank (B) type"},{"name":"billDate","in":"query","type":"string","required":false,"description":"Indicates a date on which a bill has been raised"},{"name":"billType","in":"query","type":"string","required":false,"description":"The type of payment obligation generated"},{"name":"paymentMethod","in":"query","type":"string","required":false,"description":"Method chosen to make the payment"},{"name":"infoPayType","in":"query","type":"string","required":false,"description":"Indicates a bill which is raised when a loan is paid off"},{"name":"advancePayment","in":"query","type":"string","required":false,"description":"Indicates whether advance payment made is set on an account"},{"name":"paymentIndicator","in":"query","type":"string","required":false,"description":"Indicates whether its a credit/debit type of bill"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"AllBillsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/accounts/{arrangementId}/advanceBills","fullPath":"/api/v1.0.0/holdings/accounts/{arrangementId}/advanceBills","operationId":"getAdvanceBills","name":"Retrieves the details of the Advance bills-This API is deprecated and going forward the following URL has to be used.URL:/holdings/arrangements/{arrangementId}/advanceBills","summary":"Retrieves the details of the Advance bills","tags":[],"parameters":[{"name":"arrangementId","in":"path","type":"string","required":true,"description":"Indicates an unique identifier of an account"},{"name":"billStatus","in":"query","type":"string","required":false,"description":"Indicates the status of a bill(Issued,Due,Ageing,Settled)"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"AdvanceBillsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/accounts/{arrangementId}/writeOffBills","fullPath":"/api/v1.0.0/holdings/accounts/{arrangementId}/writeOffBills","operationId":"getWriteoffBills","name":"Retrieves the details of the write off bills-This API is deprecated and going forward the following URL has to be used.URL:/holdings/arrangements/{arrangementId}/writeOffBills","summary":"Retrieves the details of the write off bills","tags":[],"parameters":[{"name":"arrangementId","in":"path","type":"string","required":true,"description":"Indicates an unique identifier of an account"},{"name":"billStatus","in":"query","type":"string","required":false,"description":"Indicates the status of a bill(Issued,Due,Ageing,Settled)"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"WriteoffBillsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/accounts/{arrangementId}/payOffBills","fullPath":"/api/v1.0.0/holdings/accounts/{arrangementId}/payOffBills","operationId":"getPayoffDetails","name":"Retrieves the Payoff Details of an account-This API is deprecated and going forward the following URL has to be used.URL:/holdings/arrangements/{arrangementId}/payOffBills","summary":"Retrieves the Payoff Details of an account","tags":[],"parameters":[{"name":"arrangementId","in":"path","type":"string","required":true,"description":"Indicates an unique identifier of an account"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"PayoffDetailsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/accounts/writeOff/{arrangementId}/activities","fullPath":"/api/v1.0.0/holdings/accounts/writeOff/{arrangementId}/activities","operationId":"getWriteOffActivitiesDetails","name":"Retrieves the details of write off bills based on activities-This API is deprecated and going forward the following URL has to be used.URL:/holdings/arrangements/writeOff/{arrangementId}/activities","summary":"Retrieves the details of write off bills based on activities","tags":[],"parameters":[{"name":"arrangementId","in":"path","type":"string","required":true,"description":"Indicates an unique identifier of an account"},{"name":"fileVersion","in":"query","type":"string","required":false,"description":"Indicates if the file is of type simulation or live"},{"name":"simulationReference","in":"query","type":"string","required":false,"description":"Indicates the Reference ID for simulation activity"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"WriteOffActivitiesDetailsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}}]},{"key":"holdings-paymentStops-service-v1.0.0","title":"Management of Payment stops","version":"v1.0.0","description":"Management of Holdings Payment Stops","endpointCount":5,"endpoints":[{"method":"POST","path":"/holdings/paymentStops/{paymentStopId}","fullPath":"/api/v1.0.0/holdings/paymentStops/{paymentStopId}","operationId":"createPaymentStop","name":"Initiate a stop cheque request for an account","summary":"Initiate payment stop","tags":[],"parameters":[{"name":"paymentStopId","in":"path","type":"string","required":true,"description":"Reference cheques details for stopped payment id"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"stops":[{}],"currencyId":"string","issueDate":"string"}},"responses":{"200":"PaymentStopResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/holdings/paymentStops/{paymentStopId}","fullPath":"/api/v1.0.0/holdings/paymentStops/{paymentStopId}","operationId":"updatePaymentStop","name":"Update an existing stop cheque request for an account","summary":"Update payment stop","tags":[],"parameters":[{"name":"paymentStopId","in":"path","type":"string","required":true,"description":"Reference cheques details for stopped payment id"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"stops":[{}],"currencyId":"string","issueDate":"string"}},"responses":{"200":"PaymentStopResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/holdings/paymentStops","fullPath":"/api/v1.0.0/holdings/paymentStops","operationId":"getPaymentStops","name":"Retrieves the list of stopped payment cheques details","summary":"Retrieves payment stops","tags":[],"parameters":[{"name":"accountId","in":"query","type":"string","required":false,"description":"Identifier of the account. Often referred to as the account number, yet for consistency this is always referred to as accountId. Accepts both IBAN & BBAN"},{"name":"customerId","in":"query","type":"string","required":false,"description":"Identifier of the customer"},{"name":"stopTypeId","in":"query","type":"string","required":false,"description":"Indicates the reason why a Payment Stop is requested for e.g. Cheque lost, funds not available etc. "},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from t24 on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"PaymentStopsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"PUT","path":"/holdings/paymentStopsApprovals/{paymentStopId}","fullPath":"/api/v1.0.0/holdings/paymentStopsApprovals/{paymentStopId}","operationId":"approvePaymentStop","name":"Approve a stop cheque request for an account","summary":"Approve payment stop","tags":[],"parameters":[{"name":"paymentStopId","in":"path","type":"string","required":true,"description":"Reference cheques details for stopped payment id"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"PaymentStopResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"DELETE","path":"/holdings/paymentStops/cancellations/{paymentStopId}","fullPath":"/api/v1.0.0/holdings/paymentStops/cancellations/{paymentStopId}","operationId":"rejectPaymentStop","name":"Reject a stop cheque request for an account","summary":"Reject Payment Stop","tags":[],"parameters":[{"name":"paymentStopId","in":"path","type":"string","required":true,"description":"Reference cheques details for stopped payment id"},{"name":"payload","in":"body","type":"object","required":false,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}}},"responses":{"200":"PaymentStopResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}}]},{"key":"holdings-portfolioSettlement-service-v1.0.0","title":"Security Settlements","version":"v1.0.0","description":"Allow to retrieve and manage Security Settlement details which can be Portfolio or Transaction specific","endpointCount":6,"endpoints":[{"method":"GET","path":"/holdings/portfolios/{portfolioId}/overdueSettlement","fullPath":"/api/v1.0.0/holdings/portfolios/{portfolioId}/overdueSettlement","operationId":"getOverdueSettlementsByPortfolio","name":"Retrieves the list of overdue settlements based on the transaction reference, portfolio, broker and depository","summary":"Retrieves the overdue settlements","tags":[],"parameters":[{"name":"portfolioId","in":"path","type":"string","required":true,"description":"Id of the portfolio or security account"},{"name":"transactionId","in":"query","type":"string","required":false,"description":"Unique transaction identifier for retrieving the details of the transaction. For example: FT0102030333 etc."},{"name":"customerId","in":"query","type":"string","required":false,"description":"Identifier of the customer"},{"name":"brokerId","in":"query","type":"string","required":false,"description":"The identifier of the broker"},{"name":"tradeDate","in":"query","type":"string","required":false,"description":"Standard date field which records trade date of the account"},{"name":"valueDate","in":"query","type":"string","required":false,"description":"Indicates the value date on which the underlying accounting entry is to be given value (for interest purposes)"},{"name":"depository","in":"query","type":"string","required":false,"description":"The custodian where securities are held"},{"name":"currency","in":"query","type":"string","required":false,"description":"Indicates the type of currency to which the account belongs"},{"name":"instrumentId","in":"query","type":"string","required":false,"description":"The identifier of the instrument"},{"name":"deliveryInstruction","in":"query","type":"string","required":false,"description":"Type of Delivery to be made for this transaction. Allowed values: - DAP: Delivery Against Payment - FOP: Free of Payment"},{"name":"transactionType","in":"query","type":"string","required":false,"description":"Identifies the transaction type applicable to the transaction being processed, i.e. outward or inward payment. For example: ACPX, OTPX etc."},{"name":"quantity","in":"query","type":"string","required":false,"description":"The nominal quantity"},{"name":"stockExchange","in":"query","type":"string","required":false,"description":"The stock exchange identifier"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from t24 on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"The identifier of the underlying Entity/Company/Branch."}],"requestBodyExample":null,"responses":{"200":"OverdueSettlementsByPortfolioResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/securitySettlements","fullPath":"/api/v1.0.0/holdings/securitySettlements","operationId":"getSecuritySettlements","name":"Allows to view the outstanding and overdue settlement details along with the delivery message information","summary":"Allows to view the outstanding and overdue settlement details","tags":[],"parameters":[{"name":"transactionId","in":"query","type":"string","required":false,"description":"Unique transaction identifier for retrieving the details of the transaction. For example: FT0102030333 etc."},{"name":"customerId","in":"query","type":"string","required":false,"description":"Identifier of the customer"},{"name":"portfolioId","in":"query","type":"string","required":false,"description":"Id of the portfolio or security account"},{"name":"brokerId","in":"query","type":"string","required":false,"description":"The identifier of the broker"},{"name":"tradeDate","in":"query","type":"string","required":false,"description":"Standard date field which records trade date of the account"},{"name":"valueDate","in":"query","type":"string","required":false,"description":"Indicates the value date on which the underlying accounting entry is to be given value (for interest purposes)"},{"name":"depository","in":"query","type":"string","required":false,"description":"The custodian where securities are held"},{"name":"currency","in":"query","type":"string","required":false,"description":"Indicates the type of currency to which the account belongs"},{"name":"instrumentId","in":"query","type":"string","required":false,"description":"The identifier of the instrument"},{"name":"deliveryInstruction","in":"query","type":"string","required":false,"description":"Type of Delivery to be made for this transaction. Allowed values: - DAP: Delivery Against Payment - FOP: Free of Payment"},{"name":"transactionType","in":"query","type":"string","required":false,"description":"Identifies the transaction type applicable to the transaction being processed, i.e. outward or inward payment. For example: ACPX, OTPX etc."},{"name":"quantity","in":"query","type":"string","required":false,"description":"The nominal quantity"},{"name":"stockExchange","in":"query","type":"string","required":false,"description":"The stock exchange identifier"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from t24 on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"The identifier of the underlying Entity/Company/Branch."}],"requestBodyExample":null,"responses":{"200":"SecuritySettlementsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/securitySettlements/{securitySettlementsId}/fullSettlements","fullPath":"/api/v1.0.0/holdings/securitySettlements/{securitySettlementsId}/fullSettlements","operationId":"getFullSettlements","name":"Allows to view the settlement  details of the transaction pending to be settled","summary":"Allows to view the settlement  details of the transaction pending to be settled","tags":[],"parameters":[{"name":"securitySettlementsId","in":"path","type":"string","required":true,"description":"Identifier of the Security Settlement"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"The identifier of the underlying Entity/Company/Branch."}],"requestBodyExample":null,"responses":{"200":"FullSettlementsResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/holdings/securitySettlements/{securitySettlementsId}/fullSettlements","fullPath":"/api/v1.0.0/holdings/securitySettlements/{securitySettlementsId}/fullSettlements","operationId":"updateFullSettlements","name":"Allows to perform complete settlement on the transaction","summary":"Allows to perform complete settlement on the transaction","tags":[],"parameters":[{"name":"securitySettlementsId","in":"path","type":"string","required":true,"description":"Identifier of the Security Settlement"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"The identifier of the underlying Entity/Company/Branch."}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"brokerDetails":[{}],"customerDetails":[{}],"instrumentId":"string","transactionCode":"string","depository":"string","tradeDate":"2024-01-01","valueDate":"2024-01-01","tradeCurrency":"string","quantity":0.0,"brokerAmount":"string","customerAmount":"string","settled":0.0,"quantityToSettle":0.0,"quantityCancelled":0.0,"quantityToCancel":0.0}},"responses":{"200":"FullSettlementsResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/holdings/securitySettlements/{securitySettlementsId}/partialSettlements","fullPath":"/api/v1.0.0/holdings/securitySettlements/{securitySettlementsId}/partialSettlements","operationId":"getPartialSettlements","name":"Allows to view the settlement  details of the transaction pending to be settled","summary":"Allows to view the settlement  details of the transaction pending to be settled","tags":[],"parameters":[{"name":"securitySettlementsId","in":"path","type":"string","required":true,"description":"Identifier of the Security Settlement"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"The identifier of the underlying Entity/Company/Branch."}],"requestBodyExample":null,"responses":{"200":"PartialSettlementsResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/holdings/securitySettlements/{securitySettlementsId}/partialSettlements","fullPath":"/api/v1.0.0/holdings/securitySettlements/{securitySettlementsId}/partialSettlements","operationId":"updatePartialSettlements","name":"Allows to perform partial settlement on the transaction","summary":"Allows to perform partial settlement on the transaction","tags":[],"parameters":[{"name":"securitySettlementsId","in":"path","type":"string","required":true,"description":"Identifier of the Security Settlement"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"The identifier of the underlying Entity/Company/Branch."}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"brokerDetails":[{}],"customerDetails":[{}],"instrumentId":"string","depository":"string","tradeDate":"2024-01-01","valueDate":"2024-01-01","tradeCurrency":"string","quantity":0.0,"quantitySettled":0.0,"quantityToSettle":0.0,"quantityCancelled":0.0,"quantityToCancel":0.0,"netAmount":0.0,"customerAmountSettled":0.0,"customerAmountCancelled":0.0}},"responses":{"200":"PartialSettlementsResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}}]},{"key":"holdings-portfolioSettlement-service-v1.1.0","title":"Security Settlements ","version":"v1.1.0","description":"Allow to retrieve and manage security settlement details which can be portfolio or transaction specific","endpointCount":6,"endpoints":[{"method":"GET","path":"/holdings/portfolios/{portfolioId}/overdueSettlement","fullPath":"/api/v1.1.0/holdings/portfolios/{portfolioId}/overdueSettlement","operationId":"getOverdueSettlementsByPortfolio","name":"Retrieves the list of overdue settlements based on the transaction reference, portfolio, broker and depository","summary":"Retrieves the overdue settlements","tags":["WEALTH"],"parameters":[{"name":"portfolioId","in":"path","type":"string","required":true,"description":"Id of the portfolio or security account"},{"name":"transactionId","in":"query","type":"string","required":false,"description":"Unique transaction identifier for retrieving the details of the transaction. For example: FT0102030333 etc."},{"name":"customerId","in":"query","type":"string","required":false,"description":"Identifier of the customer"},{"name":"brokerId","in":"query","type":"string","required":false,"description":"The identifier of the broker"},{"name":"tradeDate","in":"query","type":"string","required":false,"description":"Standard date field which records trade date of the account"},{"name":"valueDate","in":"query","type":"string","required":false,"description":"Indicates the value date on which the underlying accounting entry is to be given value (for interest purposes)"},{"name":"depository","in":"query","type":"string","required":false,"description":"Person designated as depository by the company in or pursuant to this Indenture, and, unless otherwise provided with respect to any security, any successor to such person"},{"name":"currency","in":"query","type":"string","required":false,"description":"Identifies the currency. E.g. USD, GBP etc"},{"name":"instrumentId","in":"query","type":"string","required":false,"description":"The identifier of the instrument"},{"name":"deliveryInstruction","in":"query","type":"string","required":false,"description":"Customer's directions to a bank as to the disposition of funds and securities in the customer's account"},{"name":"transactionType","in":"query","type":"string","required":false,"description":"Identifies the transaction type applicable to the transaction being processed, i.e. outward or inward payment. For example: ACPX, OTPX etc."},{"name":"quantity","in":"query","type":"string","required":false,"description":"The nominal quantity"},{"name":"stockExchange","in":"query","type":"string","required":false,"description":"Contains the stock exchange details where a particular security is usually dealt"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"OverdueSettlementsByPortfolioResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/securitySettlements","fullPath":"/api/v1.1.0/holdings/securitySettlements","operationId":"getSecuritySettlements","name":"Allows to view the outstanding and overdue settlement details along with the delivery message information","summary":"Allows to view the outstanding and overdue settlement details","tags":["WEALTH"],"parameters":[{"name":"transactionId","in":"query","type":"string","required":false,"description":"Unique transaction identifier for retrieving the details of the transaction. For example: FT0102030333 etc."},{"name":"customerId","in":"query","type":"string","required":false,"description":"Identifier of the customer"},{"name":"portfolioId","in":"query","type":"string","required":false,"description":"Id of the portfolio or security account"},{"name":"brokerId","in":"query","type":"string","required":false,"description":"The identifier of the broker"},{"name":"tradeDate","in":"query","type":"string","required":false,"description":"Standard date field which records trade date of the account"},{"name":"valueDate","in":"query","type":"string","required":false,"description":"Indicates the value date on which the underlying accounting entry is to be given value (for interest purposes)"},{"name":"depository","in":"query","type":"string","required":false,"description":"Person designated as depository by the company in or pursuant to this Indenture, and, unless otherwise provided with respect to any security, any successor to such person"},{"name":"currency","in":"query","type":"string","required":false,"description":"Identifies the currency. E.g. USD, GBP etc"},{"name":"instrumentId","in":"query","type":"string","required":false,"description":"The identifier of the instrument"},{"name":"deliveryInstruction","in":"query","type":"string","required":false,"description":"Customer's directions to a bank as to the disposition of funds and securities in the customer's account"},{"name":"transactionType","in":"query","type":"string","required":false,"description":"Identifies the transaction type applicable to the transaction being processed, i.e. outward or inward payment. For example: ACPX, OTPX etc."},{"name":"quantity","in":"query","type":"string","required":false,"description":"The nominal quantity"},{"name":"stockExchange","in":"query","type":"string","required":false,"description":"Contains the stock exchange details where a particular security is usually dealt"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"SecuritySettlementsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/securitySettlements/{securitySettlementsId}/fullSettlements","fullPath":"/api/v1.1.0/holdings/securitySettlements/{securitySettlementsId}/fullSettlements","operationId":"getFullSettlements","name":"Allows to view the settlement  details of the transaction pending to be settled","summary":"Allows to view the settlement  details of the transaction pending to be settled","tags":["WEALTH"],"parameters":[{"name":"securitySettlementsId","in":"path","type":"string","required":true,"description":"Identifier of the Security Settlement"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"FullSettlementsResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/holdings/securitySettlements/{securitySettlementsId}/fullSettlements","fullPath":"/api/v1.1.0/holdings/securitySettlements/{securitySettlementsId}/fullSettlements","operationId":"updateFullSettlements","name":"Allows to perform complete settlement on the transaction","summary":"Allows to perform complete settlement on the transaction","tags":["WEALTH"],"parameters":[{"name":"securitySettlementsId","in":"path","type":"string","required":true,"description":"Identifier of the Security Settlement"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"brokerDetails":[{}],"customerDetails":[{}],"transactionNarratives":[{}],"instrumentId":"string","transactionCode":"string","depository":"string","tradeDate":"2024-01-01","valueDate":"2024-01-01","tradeCurrency":"string","quantity":0.0,"brokerAmount":"string","customerAmount":"string","settled":0.0,"quantityToSettle":0.0,"quantityCancelled":0.0}},"responses":{"200":"FullSettlementsResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/holdings/securitySettlements/{securitySettlementsId}/partialSettlements","fullPath":"/api/v1.1.0/holdings/securitySettlements/{securitySettlementsId}/partialSettlements","operationId":"getPartialSettlements","name":"Allows to view the settlement  details of the transaction pending to be settled","summary":"Allows to view the settlement  details of the transaction pending to be settled","tags":["WEALTH"],"parameters":[{"name":"securitySettlementsId","in":"path","type":"string","required":true,"description":"Identifier of the Security Settlement"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"PartialSettlementsResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/holdings/securitySettlements/{securitySettlementsId}/partialSettlements","fullPath":"/api/v1.1.0/holdings/securitySettlements/{securitySettlementsId}/partialSettlements","operationId":"updatePartialSettlements","name":"Allows to perform partial settlement on the transaction","summary":"Allows to perform partial settlement on the transaction","tags":["WEALTH"],"parameters":[{"name":"securitySettlementsId","in":"path","type":"string","required":true,"description":"Identifier of the Security Settlement"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"brokerDetails":[{}],"customerDetails":[{}],"transactionNarratives":[{}],"instrumentId":"string","depository":"string","tradeDate":"2024-01-01","valueDate":"2024-01-01","tradeCurrency":"string","quantity":0.0,"quantitySettled":0.0,"quantityToSettle":0.0,"quantityCancelled":0.0,"quantityToCancel":0.0,"netAmount":0.0,"customerAmountSettled":0.0}},"responses":{"200":"PartialSettlementsResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}}]},{"key":"holdings-portfolioSettlement-service-v1.2.0","title":"Security Settlements ","version":"v1.2.0","description":"Allow to retrieve and manage security settlement details which can be portfolio or transaction specific","endpointCount":7,"endpoints":[{"method":"GET","path":"/holdings/portfolios/{portfolioId}/overdueSettlement","fullPath":"/api/v1.2.0/holdings/portfolios/{portfolioId}/overdueSettlement","operationId":"getOverdueSettlementsByPortfolio","name":"Retrieves the list of overdue settlements based on the transaction reference, portfolio, broker and depository","summary":"Retrieves the overdue settlements","tags":["WEALTH"],"parameters":[{"name":"portfolioId","in":"path","type":"string","required":true,"description":"Id of the portfolio or security account"},{"name":"transactionId","in":"query","type":"string","required":false,"description":"Unique transaction identifier for retrieving the details of the transaction. For example: FT0102030333 etc."},{"name":"customerId","in":"query","type":"string","required":false,"description":"Identifier of the customer"},{"name":"brokerId","in":"query","type":"string","required":false,"description":"The identifier of the broker"},{"name":"tradeDate","in":"query","type":"string","required":false,"description":"Standard date field which records trade date of the account"},{"name":"valueDate","in":"query","type":"string","required":false,"description":"Indicates the value date on which the underlying accounting entry is to be given value (for interest purposes)"},{"name":"depository","in":"query","type":"string","required":false,"description":"Person designated as depository by the company in or pursuant to this Indenture, and, unless otherwise provided with respect to any security, any successor to such person"},{"name":"currency","in":"query","type":"string","required":false,"description":"Identifies the currency. E.g. USD, GBP etc"},{"name":"instrumentId","in":"query","type":"string","required":false,"description":"The identifier of the instrument"},{"name":"deliveryInstruction","in":"query","type":"string","required":false,"description":"Customer's directions to a bank as to the disposition of funds and securities in the customer's account"},{"name":"transactionType","in":"query","type":"string","required":false,"description":"Identifies the transaction type applicable to the transaction being processed, i.e. outward or inward payment. For example: ACPX, OTPX etc."},{"name":"quantity","in":"query","type":"string","required":false,"description":"The nominal quantity"},{"name":"stockExchange","in":"query","type":"string","required":false,"description":"Contains the stock exchange details where a particular security is usually dealt"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"OverdueSettlementsByPortfolioResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/securitySettlements","fullPath":"/api/v1.2.0/holdings/securitySettlements","operationId":"getSecuritySettlements","name":"Allows to view the outstanding and overdue settlement details along with the delivery message information","summary":"Allows to view the outstanding and overdue settlement details","tags":["WEALTH"],"parameters":[{"name":"transactionId","in":"query","type":"string","required":false,"description":"Unique transaction identifier for retrieving the details of the transaction. For example: FT0102030333 etc."},{"name":"customerId","in":"query","type":"string","required":false,"description":"Identifier of the customer"},{"name":"portfolioId","in":"query","type":"string","required":false,"description":"Id of the portfolio or security account"},{"name":"brokerId","in":"query","type":"string","required":false,"description":"The identifier of the broker"},{"name":"tradeDate","in":"query","type":"string","required":false,"description":"Standard date field which records trade date of the account"},{"name":"valueDate","in":"query","type":"string","required":false,"description":"Indicates the value date on which the underlying accounting entry is to be given value (for interest purposes)"},{"name":"depository","in":"query","type":"string","required":false,"description":"Person designated as depository by the company in or pursuant to this Indenture, and, unless otherwise provided with respect to any security, any successor to such person"},{"name":"currency","in":"query","type":"string","required":false,"description":"Identifies the currency. E.g. USD, GBP etc"},{"name":"instrumentId","in":"query","type":"string","required":false,"description":"The identifier of the instrument"},{"name":"deliveryInstruction","in":"query","type":"string","required":false,"description":"Customer's directions to a bank as to the disposition of funds and securities in the customer's account"},{"name":"transactionType","in":"query","type":"string","required":false,"description":"Identifies the transaction type applicable to the transaction being processed, i.e. outward or inward payment. For example: ACPX, OTPX etc."},{"name":"quantity","in":"query","type":"string","required":false,"description":"The nominal quantity"},{"name":"stockExchange","in":"query","type":"string","required":false,"description":"Contains the stock exchange details where a particular security is usually dealt"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"SecuritySettlementsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/securitySettlements/{securitySettlementsId}/fullSettlements","fullPath":"/api/v1.2.0/holdings/securitySettlements/{securitySettlementsId}/fullSettlements","operationId":"getFullSettlements","name":"Allows to view the settlement  details of the transaction pending to be settled","summary":"Allows to view the settlement  details of the transaction pending to be settled","tags":["WEALTH"],"parameters":[{"name":"securitySettlementsId","in":"path","type":"string","required":true,"description":"Identifier of the Security Settlement"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"FullSettlementsResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/holdings/securitySettlements/{securitySettlementsId}/fullSettlements","fullPath":"/api/v1.2.0/holdings/securitySettlements/{securitySettlementsId}/fullSettlements","operationId":"updateFullSettlements","name":"Allows to perform complete settlement on the transaction","summary":"Allows to perform complete settlement on the transaction","tags":["WEALTH"],"parameters":[{"name":"securitySettlementsId","in":"path","type":"string","required":true,"description":"Identifier of the Security Settlement"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"brokerDetails":[{}],"customerDetails":[{}],"transactionNarratives":[{}],"instrumentId":"string","transactionCode":"string","depository":"string","tradeDate":"2024-01-01","valueDate":"2024-01-01","tradeCurrency":"string","quantity":0.0,"brokerAmount":"string","customerAmount":"string","settled":0.0,"quantityToSettle":0.0,"quantityCancelled":0.0}},"responses":{"200":"FullSettlementsResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/holdings/securitySettlements/{securitySettlementsId}/partialSettlements","fullPath":"/api/v1.2.0/holdings/securitySettlements/{securitySettlementsId}/partialSettlements","operationId":"getPartialSettlements","name":"Allows to view the settlement  details of the transaction pending to be settled","summary":"Allows to view the settlement  details of the transaction pending to be settled","tags":["WEALTH"],"parameters":[{"name":"securitySettlementsId","in":"path","type":"string","required":true,"description":"Identifier of the Security Settlement"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"PartialSettlementsResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/holdings/securitySettlements/{securitySettlementsId}/partialSettlements","fullPath":"/api/v1.2.0/holdings/securitySettlements/{securitySettlementsId}/partialSettlements","operationId":"updatePartialSettlements","name":"Allows to perform partial settlement on the transaction","summary":"Allows to perform partial settlement on the transaction","tags":["WEALTH"],"parameters":[{"name":"securitySettlementsId","in":"path","type":"string","required":true,"description":"Identifier of the Security Settlement"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"brokerDetails":[{}],"customerDetails":[{}],"transactionNarratives":[{}],"instrumentId":"string","depository":"string","tradeDate":"2024-01-01","valueDate":"2024-01-01","tradeCurrency":"string","quantity":0.0,"quantitySettled":0.0,"quantityToSettle":0.0,"quantityCancelled":0.0,"quantityToCancel":0.0,"netAmount":0.0,"customerAmountSettled":0.0}},"responses":{"200":"PartialSettlementsResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"POST","path":"/holdings/securitySettlements/{securitySettlementsId}/repairs","fullPath":"/api/v1.2.0/holdings/securitySettlements/{securitySettlementsId}/repairs","operationId":"updateSettlementRepairStatus","name":"Allows to update the repair status of the security settlement","summary":"Allows to update the repair status of the security settlement","tags":["WEALTH"],"parameters":[{"name":"securitySettlementsId","in":"path","type":"string","required":true,"description":"Identifier of the Security Settlement"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"matchCodeDetails":[{}],"rejectionReasonDetails":[{}],"transactionDateTime":"string","quantity":"string","settlementAmount":0.0,"tradeDate":"2024-01-01","actualSettlementDate":"2024-01-01","delivery":"string","paymentIndicator":"string","instrumentId":"string","externalReference":"string","extensions":{}}},"responses":{"200":"SettlementRepairStatusResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}}]},{"key":"holdings-portfolioSettlement-service-v1.3.0","title":"Security Settlements ","version":"v1.3.0","description":"Allow to retrieve and manage security settlement details which can be portfolio or transaction specific","endpointCount":9,"endpoints":[{"method":"GET","path":"/holdings/portfolios/{portfolioId}/overdueSettlements","fullPath":"/api/v1.3.0/holdings/portfolios/{portfolioId}/overdueSettlements","operationId":"getOverdueSettlementsByPortfolio","name":"Retrieves the list of overdue settlements based on the transaction reference, portfolio, broker and depository","summary":"Retrieves the overdue settlements","tags":["WEALTH"],"parameters":[{"name":"portfolioId","in":"path","type":"string","required":true,"description":"Id of the portfolio or security account"},{"name":"transactionId","in":"query","type":"string","required":false,"description":"Unique transaction identifier for retrieving the details of the transaction. For example: FT0102030333 etc."},{"name":"customerId","in":"query","type":"string","required":false,"description":"Identifier of the customer"},{"name":"brokerId","in":"query","type":"string","required":false,"description":"The identifier of the broker"},{"name":"tradeDate","in":"query","type":"string","required":false,"description":"Standard date field which records trade date of the account"},{"name":"valueDate","in":"query","type":"string","required":false,"description":"Indicates the value date on which the underlying accounting entry is to be given value (for interest purposes)"},{"name":"depository","in":"query","type":"string","required":false,"description":"Person designated as depository by the company in or pursuant to this Indenture, and, unless otherwise provided with respect to any security, any successor to such person"},{"name":"currency","in":"query","type":"string","required":false,"description":"Identifies the currency. E.g. USD, GBP etc"},{"name":"instrumentId","in":"query","type":"string","required":false,"description":"The identifier of the instrument"},{"name":"deliveryInstruction","in":"query","type":"string","required":false,"description":"Customer's directions to a bank as to the disposition of funds and securities in the customer's account"},{"name":"transactionType","in":"query","type":"string","required":false,"description":"Identifies the transaction type applicable to the transaction being processed, i.e. outward or inward payment. For example: ACPX, OTPX etc."},{"name":"quantity","in":"query","type":"string","required":false,"description":"The nominal quantity"},{"name":"stockExchange","in":"query","type":"string","required":false,"description":"Contains the stock exchange details where a particular security is usually dealt"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"OverdueSettlementsByPortfolioResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/securitySettlements/{securitySettlementsId}/fullSettlements","fullPath":"/api/v1.3.0/holdings/securitySettlements/{securitySettlementsId}/fullSettlements","operationId":"getFullSettlements","name":"Allows to view the settlement  details of the transaction pending to be settled","summary":"Allows to view the settlement  details of the transaction pending to be settled","tags":["WEALTH"],"parameters":[{"name":"securitySettlementsId","in":"path","type":"string","required":true,"description":"Identifier of the Security Settlement"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"FullSettlementsResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/holdings/securitySettlements/{securitySettlementsId}/fullSettlements","fullPath":"/api/v1.3.0/holdings/securitySettlements/{securitySettlementsId}/fullSettlements","operationId":"updateFullSettlements","name":"Allows to perform complete settlement on the transaction","summary":"Allows to perform complete settlement on the transaction","tags":["WEALTH"],"parameters":[{"name":"securitySettlementsId","in":"path","type":"string","required":true,"description":"Identifier of the Security Settlement"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"brokerDetails":[{}],"customerDetails":[{}],"transactionNarratives":[{}],"instrumentId":"string","transactionCode":"string","depository":"string","tradeDate":"2024-01-01","valueDate":"2024-01-01","tradeCurrency":"string","quantity":0.0,"brokerAmount":"string","customerAmount":"string","settled":0.0,"quantityToSettle":0.0,"quantityCancelled":0.0}},"responses":{"200":"FullSettlementsResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/holdings/securitySettlements/{securitySettlementsId}/partialSettlements","fullPath":"/api/v1.3.0/holdings/securitySettlements/{securitySettlementsId}/partialSettlements","operationId":"getPartialSettlements","name":"Allows to view the settlement  details of the transaction pending to be settled","summary":"Allows to view the settlement  details of the transaction pending to be settled","tags":["WEALTH"],"parameters":[{"name":"securitySettlementsId","in":"path","type":"string","required":true,"description":"Identifier of the Security Settlement"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"PartialSettlementsResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/holdings/securitySettlements/{securitySettlementsId}/partialSettlements","fullPath":"/api/v1.3.0/holdings/securitySettlements/{securitySettlementsId}/partialSettlements","operationId":"updatePartialSettlements","name":"Allows to perform partial settlement on the transaction","summary":"Allows to perform partial settlement on the transaction","tags":["WEALTH"],"parameters":[{"name":"securitySettlementsId","in":"path","type":"string","required":true,"description":"Identifier of the Security Settlement"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"brokerDetails":[{}],"customerDetails":[{}],"transactionNarratives":[{}],"instrumentId":"string","depository":"string","tradeDate":"2024-01-01","valueDate":"2024-01-01","tradeCurrency":"string","quantity":0.0,"quantitySettled":0.0,"quantityToSettle":0.0,"quantityCancelled":0.0,"quantityToCancel":0.0,"netAmount":0.0,"customerAmountSettled":0.0}},"responses":{"200":"PartialSettlementsResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"POST","path":"/holdings/securitySettlements/{securitySettlementsId}/repairs","fullPath":"/api/v1.3.0/holdings/securitySettlements/{securitySettlementsId}/repairs","operationId":"updateSettlementRepairStatus","name":"Allows to update the repair status of the security settlement","summary":"Allows to update the repair status of the security settlement","tags":["WEALTH"],"parameters":[{"name":"securitySettlementsId","in":"path","type":"string","required":true,"description":"Identifier of the Security Settlement"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"matchCodeDetails":[{}],"rejectionReasonDetails":[{}],"transactionDateTime":"string","quantity":"string","settlementAmount":0.0,"tradeDate":"2024-01-01","actualSettlementDate":"2024-01-01","delivery":"string","paymentIndicator":"string","instrumentId":"string","externalReference":"string","extensions":{}}},"responses":{"200":"SettlementRepairStatusResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/holdings/securitySettlements/pendings/itemCount","fullPath":"/api/v1.3.0/holdings/securitySettlements/pendings/itemCount","operationId":"getActionRequiredStatusCount","name":"To retrieve the count of securities settlements for the statuses that requires immediate attention of the settlement officer","summary":"To retrieve the count of securities settlements for the statuses that requires immediate attention of the settlement officer","tags":["WEALTH"],"parameters":[{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"ActionRequiredStatusCountResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/securitySettlements","fullPath":"/api/v1.3.0/holdings/securitySettlements","operationId":"getSecuritySettlements","name":"Allows to view the outstanding and overdue settlement details along with the delivery message information","summary":"Allows to view the outstanding and overdue settlement details along with the delivery message information","tags":["WEALTH"],"parameters":[{"name":"transactionId","in":"query","type":"string","required":false,"description":"Unique transaction identifier for retrieving the details of the transaction. For example: FT0102030333 etc."},{"name":"customerId","in":"query","type":"string","required":false,"description":"Identifier of the customer"},{"name":"portfolioId","in":"query","type":"string","required":false,"description":"Id of the portfolio or security account"},{"name":"brokerId","in":"query","type":"string","required":false,"description":"The identifier of the broker"},{"name":"tradeDate","in":"query","type":"string","required":false,"description":"Standard date field which records trade date of the account"},{"name":"valueDate","in":"query","type":"string","required":false,"description":"Indicates the value date on which the underlying accounting entry is to be given value (for interest purposes)"},{"name":"valueDate","in":"query","type":"string","required":false,"description":"Indicates the value date on which the underlying accounting entry is to be given value (for interest purposes)"},{"name":"depository","in":"query","type":"string","required":false,"description":"Person designated as depository by the company in or pursuant to this Indenture, and, unless otherwise provided with respect to any security, any successor to such person"},{"name":"currency","in":"query","type":"string","required":false,"description":"Identifies the currency. E.g. USD, GBP etc"},{"name":"instrumentId","in":"query","type":"string","required":false,"description":"The identifier of the instrument"},{"name":"deliveryInstruction","in":"query","type":"string","required":false,"description":"Customer's directions to a bank as to the disposition of funds and securities in the customer's account"},{"name":"transactionType","in":"query","type":"string","required":false,"description":"Identifies the transaction type applicable to the transaction being processed, i.e. outward or inward payment. For example: ACPX, OTPX etc."},{"name":"quantity","in":"query","type":"string","required":false,"description":"The nominal quantity"},{"name":"stockExchange","in":"query","type":"string","required":false,"description":"Contains the stock exchange details where a particular security is usually dealt"},{"name":"settlementStatus","in":"query","type":"string","required":false,"description":"To get settlement count based on priority status"},{"name":"reasonCode","in":"query","type":"string","required":false,"description":"Contains the code of the direct debit collection's status applicable to clearing system"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"SecuritySettlementsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/securitySettlements/statuses/itemCount","fullPath":"/api/v1.3.0/holdings/securitySettlements/statuses/itemCount","operationId":"getSettementsByStatusCountAndValue","name":"To retrieve the count and value of the settlements grouped based on the priority settlement statuses","summary":"To retrieve the count and value of the settlements grouped based on the priority settlement statuses","tags":["WEALTH"],"parameters":[{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"SettementsByStatusCountAndValueResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}}]},{"key":"holdings-portfolios-service-v1.0.0","title":"Portfolio Management","version":"v1.0.0","description":"Allows the creation, updation and closure of the portfolio, delinking an account from the portfolio and retrieves the account balance, valuation and other information","endpointCount":11,"endpoints":[{"method":"PUT","path":"/holdings/portfolios/{portfolioId}/portfolioClosures","fullPath":"/api/v1.0.0/holdings/portfolios/{portfolioId}/portfolioClosures","operationId":"updatePortfolioClosure","name":"Updates the closure date for a portfolio","summary":"Updates the closure date","tags":[],"parameters":[{"name":"portfolioId","in":"path","type":"string","required":true,"description":"Id of the portfolio or security account"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"The identifier of the underlying Entity/Company/Branch."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"accountIds":[{}],"jointHolder":[{}],"customerId":0.0,"referenceCurrency":"string","valuationCurrency":"string","portfolioName":"string","accountOfficer":0.0,"investmentProgram":0.0,"managedAccount":0.0,"safekeepChargeAccount":"string","currencyId":"string","startDate":"2024-01-01","closureDate":"2024-01-01"}},"responses":{"200":"PortfolioClosureResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/holdings/portfolios/{portfolioId}/accountRemovals","fullPath":"/api/v1.0.0/holdings/portfolios/{portfolioId}/accountRemovals","operationId":"updatePortfolioDelinkAccount","name":"Allows to delink an account from the portfolio","summary":"Allows to delink an account","tags":[],"parameters":[{"name":"portfolioId","in":"path","type":"string","required":true,"description":"Id of the portfolio or security account"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"The identifier of the underlying Entity/Company/Branch."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"accountIds":[{}],"jointHolder":[{}],"customerId":0.0,"referenceCurrency":"string","valuationCurrency":"string","portfolioName":"string","accountOfficer":0.0,"investmentProgram":0.0,"managedAccount":0.0,"safekeepChargeAccount":"string","currencyId":"string","startDate":"2024-01-01","closureDate":"2024-01-01"}},"responses":{"200":"PortfolioDelinkAccountResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/holdings/portfolios/{portfolioId}/valuations","fullPath":"/api/v1.0.0/holdings/portfolios/{portfolioId}/valuations","operationId":"getPortfolioValuations","name":"Retrieves the asset and liability information based on the portfolio","summary":"Retrieves the portfolio information","tags":[],"parameters":[{"name":"portfolioId","in":"path","type":"string","required":true,"description":"Id of the portfolio or security account"},{"name":"currencyId","in":"query","type":"string","required":false,"description":"Identifier of the currency. This is the 3-letter ISO 4217 code of the currency."},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from t24 on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"The identifier of the underlying Entity/Company/Branch."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"PortfolioValuationsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/portfolios/{portfolioId}/LTV","fullPath":"/api/v1.0.0/holdings/portfolios/{portfolioId}/LTV","operationId":"getPortfolioLTV","name":"Retrieves the liability information based on the portfolio and the currency","summary":"Retrieves the portfolio information","tags":[],"parameters":[{"name":"portfolioId","in":"path","type":"string","required":true,"description":"Id of the portfolio or security account"},{"name":"currencyId","in":"query","type":"string","required":false,"description":"Identifier of the currency. This is the 3-letter ISO 4217 code of the currency."},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from t24 on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"The identifier of the underlying Entity/Company/Branch."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"PortfolioLTVResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/portfolios/ownBooks","fullPath":"/api/v1.0.0/holdings/portfolios/ownBooks","operationId":"getOwnBookPortfolios","name":"Retrieves the own book portfolio information filtered based on the portfolio id","summary":"Retrieves the own book portfolio list.","tags":[],"parameters":[{"name":"portfolioId","in":"query","type":"string","required":false,"description":"Id of the portfolio or security account"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from t24 on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"The identifier of the underlying Entity/Company/Branch."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"OwnBookPortfoliosResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/portfolios/{portfolioId}/accounts","fullPath":"/api/v1.0.0/holdings/portfolios/{portfolioId}/accounts","operationId":"getPortfolioAccounts","name":"Retrieves the accounts and balance information for the portfolio","summary":"Retrieves the porfolio account information","tags":[],"parameters":[{"name":"portfolioId","in":"path","type":"string","required":true,"description":"Id of the portfolio or security account"},{"name":"customerId","in":"query","type":"string","required":false,"description":"Identifier of the customer"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from t24 on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"The identifier of the underlying Entity/Company/Branch."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"PortfolioAccountsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/portfolios/{customerId}","fullPath":"/api/v1.0.0/holdings/portfolios/{customerId}","operationId":"getPortfolios","name":"Retrieves the portfolio information for a single customer","summary":"Retrieves the portfolio information","tags":[],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"Identifier of the customer"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from t24 on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"The identifier of the underlying Entity/Company/Branch."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"PortfoliosResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"DELETE","path":"/holdings/portfolios/{portfolioId}","fullPath":"/api/v1.0.0/holdings/portfolios/{portfolioId}","operationId":"reversePortfolio","name":"Reverses the portfolio that does not have positions","summary":"Reverses the portfolio","tags":[],"parameters":[{"name":"portfolioId","in":"path","type":"string","required":true,"description":""},{"name":"payload","in":"body","type":"object","required":false,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"The identifier of the underlying Entity/Company/Branch."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}}},"responses":{"200":"PortfolioResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"POST","path":"/holdings/portfolio","fullPath":"/api/v1.0.0/holdings/portfolio","operationId":"createPortfolio","name":"Creates a new portfolio for a securities customer","summary":"Create a new portfolio for a customer","tags":[],"parameters":[{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"The identifier of the underlying Entity/Company/Branch."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"accountIds":[{}],"jointHolder":[{}],"customerId":"string","referenceCurrency":"string","valuationCurrency":"string","portfolioName":"string","accountOfficer":"string","investmentProgram":"string","managedAccount":"string","safekeepChargeAccount":"string","startDate":"string"}},"responses":{"200":"PortfolioResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/holdings/portfolio/{portfolioId}","fullPath":"/api/v1.0.0/holdings/portfolio/{portfolioId}","operationId":"getPortfolio","name":"Retrieves information about the customer's portfolio","summary":"Retrieve portfolio information","tags":[],"parameters":[{"name":"portfolioId","in":"path","type":"string","required":true,"description":"Id of the portfolio or security account"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"The identifier of the underlying Entity/Company/Branch."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"PortfolioResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/holdings/portfolio/{portfolioId}","fullPath":"/api/v1.0.0/holdings/portfolio/{portfolioId}","operationId":"updatePortfolio","name":"Update details about the customer's portfolio","summary":"Updates the customer's portfolio","tags":[],"parameters":[{"name":"portfolioId","in":"path","type":"string","required":true,"description":"Id of the portfolio or security account"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"The identifier of the underlying Entity/Company/Branch."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"accountIds":[{}],"jointHolder":[{}],"customerId":"string","referenceCurrency":"string","valuationCurrency":"string","portfolioName":"string","accountOfficer":"string","investmentProgram":"string","managedAccount":"string","safekeepChargeAccount":"string","startDate":"string"}},"responses":{"200":"PortfolioResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}}]},{"key":"holdings-portfolios-service-v2.0.0","title":"Portfolio Management","version":"v2.0.0","description":"Allows the creation, updation and closure of the portfolio, delinking an account from the portfolio and retrieves the account balance, valuation and other information","endpointCount":15,"endpoints":[{"method":"PUT","path":"/holdings/portfolios/{portfolioId}/portfolioClosures","fullPath":"/api/v2.0.0/holdings/portfolios/{portfolioId}/portfolioClosures","operationId":"updatePortfolioClosure","name":"Updates the closure date for a portfolio","summary":"Updates the closure date","tags":[],"parameters":[{"name":"portfolioId","in":"path","type":"string","required":true,"description":"Id of the portfolio or security account"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"accountIds":[{}],"jointHolder":[{}],"customerId":0.0,"referenceCurrency":"string","valuationCurrency":"string","portfolioName":"string","accountOfficer":0.0,"investmentProgram":0.0,"managedAccount":0.0,"safekeepChargeAccount":"string","currencyId":"string","startDate":"2024-01-01","closureDate":"2024-01-01"}},"responses":{"200":"PortfolioClosureResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/holdings/portfolios/{portfolioId}/accountRemovals","fullPath":"/api/v2.0.0/holdings/portfolios/{portfolioId}/accountRemovals","operationId":"updatePortfolioDelinkAccount","name":"Allows to delink an account from the portfolio","summary":"Allows to delink an account","tags":[],"parameters":[{"name":"portfolioId","in":"path","type":"string","required":true,"description":"Id of the portfolio or security account"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"accountIds":[{}],"jointHolder":[{}],"customerId":0.0,"referenceCurrency":"string","valuationCurrency":"string","portfolioName":"string","accountOfficer":0.0,"investmentProgram":0.0,"managedAccount":0.0,"safekeepChargeAccount":"string","currencyId":"string","startDate":"2024-01-01","closureDate":"2024-01-01"}},"responses":{"200":"PortfolioDelinkAccountResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/holdings/portfolios/{portfolioId}/valuations","fullPath":"/api/v2.0.0/holdings/portfolios/{portfolioId}/valuations","operationId":"getPortfolioValuations","name":"Retrieves the asset and liability information based on the portfolio","summary":"Retrieves the portfolio information","tags":[],"parameters":[{"name":"portfolioId","in":"path","type":"string","required":true,"description":"Id of the portfolio or security account"},{"name":"currencyId","in":"query","type":"string","required":false,"description":"Identifier of the currency. This is the 3-letter ISO 4217 code of the currency."},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"PortfolioValuationsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/portfolios/{portfolioId}/LTV","fullPath":"/api/v2.0.0/holdings/portfolios/{portfolioId}/LTV","operationId":"getPortfolioLTV","name":"Retrieves the liability information based on the portfolio and the currency","summary":"Retrieves the portfolio information","tags":[],"parameters":[{"name":"portfolioId","in":"path","type":"string","required":true,"description":"Id of the portfolio or security account"},{"name":"currencyId","in":"query","type":"string","required":false,"description":"Identifier of the currency. This is the 3-letter ISO 4217 code of the currency."},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"PortfolioLTVResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/portfolios/ownBooks","fullPath":"/api/v2.0.0/holdings/portfolios/ownBooks","operationId":"getOwnBookPortfolios","name":"Retrieves the own book portfolio information filtered based on the portfolio id","summary":"Retrieves the own book portfolio list","tags":[],"parameters":[{"name":"portfolioId","in":"query","type":"string","required":false,"description":"Id of the portfolio or security account"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"OwnBookPortfoliosResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/portfolios/{portfolioId}/accounts","fullPath":"/api/v2.0.0/holdings/portfolios/{portfolioId}/accounts","operationId":"getPortfolioAccounts","name":"Retrieves the accounts and balance information for the portfolio","summary":"Retrieves the porfolio account information","tags":[],"parameters":[{"name":"portfolioId","in":"path","type":"string","required":true,"description":"Id of the portfolio or security account"},{"name":"customerId","in":"query","type":"string","required":false,"description":"Identifier of the customer"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"PortfolioAccountsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/customers/{customerId}/portfolios","fullPath":"/api/v2.0.0/holdings/customers/{customerId}/portfolios","operationId":"getPortfolios","name":"Retrieves the portfolio information for a single customer","summary":"Retrieves the portfolio information","tags":[],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"Identifier of the customer"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"PortfoliosResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/portfolios/{portfolioId}","fullPath":"/api/v2.0.0/holdings/portfolios/{portfolioId}","operationId":"getPortfolio","name":"Retrieves information about the customer's portfolio","summary":"Retrieve portfolio information","tags":[],"parameters":[{"name":"portfolioId","in":"path","type":"string","required":true,"description":"Id of the portfolio or security account"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"PortfolioResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/holdings/portfolios/{portfolioId}","fullPath":"/api/v2.0.0/holdings/portfolios/{portfolioId}","operationId":"updatePortfolio","name":"Update details about the customer's portfolio","summary":"Updates the customer's portfolio","tags":[],"parameters":[{"name":"portfolioId","in":"path","type":"string","required":true,"description":"Id of the portfolio or security account"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"accountIds":[{}],"jointHolder":[{}],"customerId":"string","referenceCurrency":"string","valuationCurrency":"string","portfolioName":"string","accountOfficer":"string","investmentProgram":"string","managedAccount":"string","safekeepChargeAccount":"string","startDate":"string"}},"responses":{"200":"PortfolioResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"DELETE","path":"/holdings/portfolios/{portfolioId}","fullPath":"/api/v2.0.0/holdings/portfolios/{portfolioId}","operationId":"reversePortfolio","name":"Reverses the portfolio that does not have positions","summary":"Reverses the portfolio","tags":[],"parameters":[{"name":"portfolioId","in":"path","type":"string","required":true,"description":""},{"name":"payload","in":"body","type":"object","required":false,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}}},"responses":{"200":"PortfolioResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"POST","path":"/holdings/portfolios","fullPath":"/api/v2.0.0/holdings/portfolios","operationId":"createPortfolio","name":"Creates a new portfolio for a securities customer","summary":"Create a new portfolio for a customer","tags":[],"parameters":[{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"accountIds":[{}],"jointHolder":[{}],"customerId":"string","referenceCurrency":"string","valuationCurrency":"string","portfolioName":"string","accountOfficer":"string","investmentProgram":"string","managedAccount":"string","safekeepChargeAccount":"string","startDate":"string"}},"responses":{"200":"PortfolioResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/holdings/portfolios/{portfolioId}/orderBlotters","fullPath":"/api/v2.0.0/holdings/portfolios/{portfolioId}/orderBlotters","operationId":"getPortfolioOrderBlotter","name":"Allows to retrieve the pending and completed orders of the portfolio","summary":"Allows to retrieve the pending and completed orders of the portfolio","tags":[],"parameters":[{"name":"portfolioId","in":"path","type":"string","required":true,"description":"Id of the portfolio or security account"},{"name":"instrumentId","in":"query","type":"string","required":false,"description":"The identifier of the instrument"},{"name":"fromDate","in":"query","type":"string","required":false,"description":"Indicates the business date from when the balance reservation event is active."},{"name":"toDate","in":"query","type":"string","required":false,"description":"Indicates the business date until when the balance reservation event is active."},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"PortfolioOrderBlotterResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/portfolios/{portfolioId}/securityTransactions","fullPath":"/api/v2.0.0/holdings/portfolios/{portfolioId}/securityTransactions","operationId":"getPortfolioTransactionDetails","name":"Allows to retrieve security transactions of the portfolio","summary":"Allows to retrieve security transactions of the portfolio","tags":[],"parameters":[{"name":"portfolioId","in":"path","type":"string","required":true,"description":"Id of the portfolio or security account"},{"name":"customerId","in":"query","type":"string","required":false,"description":"Identifier of the customer"},{"name":"instrumentId","in":"query","type":"string","required":false,"description":"The identifier of the instrument"},{"name":"startDate","in":"query","type":"string","required":false,"description":"Contains the date on which the transaction or payment gets initiated."},{"name":"endDate","in":"query","type":"string","required":false,"description":"Indicates the date till which the transaction history requested. If 20120101 is the start date and 20120201 is the end date, all transactions that are booked between January 1 to February 1 2012 are r"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"PortfolioTransactionDetailsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/portfolios/{portfolioId}/assetAllocations","fullPath":"/api/v2.0.0/holdings/portfolios/{portfolioId}/assetAllocations","operationId":"getPortfolioDetails","name":"Allows to retrieve asset allocations and cash balance of the portfolio","summary":"Allows to retrieve asset allocations and cash balance of the portfolio","tags":[],"parameters":[{"name":"portfolioId","in":"path","type":"string","required":true,"description":"Id of the portfolio or security account"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"PortfolioDetailsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/portfolios/{portfolioId}/holdings","fullPath":"/api/v2.0.0/holdings/portfolios/{portfolioId}/holdings","operationId":"getPortfolioHoldings","name":"Allows to retrieve the holding details of the portfolio","summary":"Allows to retrieve the holding details of the portfolio","tags":[],"parameters":[{"name":"portfolioId","in":"path","type":"string","required":true,"description":"Id of the portfolio or security account"},{"name":"onlineUpdate","in":"query","type":"string","required":false,"description":"The valuation for the portfolio will be done online if this flag is set to 'Y'"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"PortfolioHoldingsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}}]},{"key":"holdings-portfolios-service-v3.0.0","title":"Portfolio Management","version":"v3.0.0","description":"Allows the creation, updation and closure of the portfolio, delinking an account from the portfolio and retrieves the account balance, valuation and other information","endpointCount":15,"endpoints":[{"method":"PUT","path":"/holdings/portfolios/{portfolioId}/portfolioClosures","fullPath":"/api/v3.0.0/holdings/portfolios/{portfolioId}/portfolioClosures","operationId":"updatePortfolioClosure","name":"Updates the closure date for a portfolio","summary":"Updates the closure date","tags":[],"parameters":[{"name":"portfolioId","in":"path","type":"string","required":true,"description":"Id of the portfolio or security account"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"accountIds":[{}],"jointHolder":[{}],"customerId":0.0,"referenceCurrency":"string","valuationCurrency":"string","portfolioName":"string","accountOfficer":0.0,"investmentProgram":0.0,"managedAccount":0.0,"safekeepChargeAccount":"string","currencyId":"string","startDate":"2024-01-01","closureDate":"2024-01-01"}},"responses":{"200":"PortfolioClosureResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/holdings/portfolios/{portfolioId}/accountRemovals","fullPath":"/api/v3.0.0/holdings/portfolios/{portfolioId}/accountRemovals","operationId":"updatePortfolioDelinkAccount","name":"Allows to delink an account from the portfolio","summary":"Allows to delink an account","tags":[],"parameters":[{"name":"portfolioId","in":"path","type":"string","required":true,"description":"Id of the portfolio or security account"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"accountIds":[{}],"jointHolder":[{}],"customerId":0.0,"referenceCurrency":"string","valuationCurrency":"string","portfolioName":"string","accountOfficer":0.0,"investmentProgram":0.0,"managedAccount":0.0,"safekeepChargeAccount":"string","currencyId":"string","startDate":"2024-01-01","closureDate":"2024-01-01"}},"responses":{"200":"PortfolioDelinkAccountResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/holdings/portfolios/{portfolioId}/valuations","fullPath":"/api/v3.0.0/holdings/portfolios/{portfolioId}/valuations","operationId":"getPortfolioValuations","name":"Retrieves the asset and liability information based on the portfolio","summary":"Retrieves the asset and liability information","tags":[],"parameters":[{"name":"portfolioId","in":"path","type":"string","required":true,"description":"Id of the portfolio or security account"},{"name":"currencyId","in":"query","type":"string","required":false,"description":"Identifier of the currency. This is the 3-letter ISO 4217 code of the currency."},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"PortfolioValuationsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/portfolios/{portfolioId}/LTV","fullPath":"/api/v3.0.0/holdings/portfolios/{portfolioId}/LTV","operationId":"getPortfolioLTV","name":"Retrieves the liability information based on the portfolio and the currency","summary":"Retrieves the liability information","tags":[],"parameters":[{"name":"portfolioId","in":"path","type":"string","required":true,"description":"Id of the portfolio or security account"},{"name":"currencyId","in":"query","type":"string","required":false,"description":"Identifier of the currency. This is the 3-letter ISO 4217 code of the currency."},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"PortfolioLTVResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/portfolios/ownBooks","fullPath":"/api/v3.0.0/holdings/portfolios/ownBooks","operationId":"getOwnBookPortfolios","name":"Retrieves the own book portfolio information filtered based on the portfolio id","summary":"Retrieves the own book portfolio list","tags":[],"parameters":[{"name":"portfolioId","in":"query","type":"string","required":false,"description":"Id of the portfolio or security account"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"OwnBookPortfoliosResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/portfolios/{portfolioId}/accounts","fullPath":"/api/v3.0.0/holdings/portfolios/{portfolioId}/accounts","operationId":"getPortfolioAccounts","name":"Retrieves the accounts and balance information for the portfolio","summary":"Retrieves the porfolio account information","tags":[],"parameters":[{"name":"portfolioId","in":"path","type":"string","required":true,"description":"Id of the portfolio or security account"},{"name":"customerId","in":"query","type":"string","required":false,"description":"Identifier of the customer"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"PortfolioAccountsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/customers/{customerId}/portfolios","fullPath":"/api/v3.0.0/holdings/customers/{customerId}/portfolios","operationId":"getPortfolios","name":"Retrieves the portfolio information for a single customer","summary":"Retrieves the portfolio information of single customer","tags":[],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"Identifier of the customer"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"PortfoliosResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/portfolios/{portfolioId}","fullPath":"/api/v3.0.0/holdings/portfolios/{portfolioId}","operationId":"getPortfolio","name":"Retrieves information about the customer's portfolio","summary":"Retrieve portfolio information","tags":[],"parameters":[{"name":"portfolioId","in":"path","type":"string","required":true,"description":"Id of the portfolio or security account"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"PortfolioResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"POST","path":"/holdings/portfolios/{portfolioId}","fullPath":"/api/v3.0.0/holdings/portfolios/{portfolioId}","operationId":"createPortfolio","name":"Creates a new portfolio for a securities customer","summary":"Create a new portfolio for a customer","tags":[],"parameters":[{"name":"portfolioId","in":"path","type":"string","required":true,"description":"Id of the portfolio or security account"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"accountIds":[{}],"jointHolder":[{}],"customerId":"string","referenceCurrency":"string","valuationCurrency":"string","portfolioName":"string","accountOfficer":"string","investmentProgram":"string","managedAccount":"string","safekeepChargeAccount":"string","startDate":"string","memoAccount":"string"}},"responses":{"200":"PortfolioResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/holdings/portfolios/{portfolioId}","fullPath":"/api/v3.0.0/holdings/portfolios/{portfolioId}","operationId":"updatePortfolio","name":"Update details about the customer's portfolio","summary":"Updates the customer's portfolio","tags":[],"parameters":[{"name":"portfolioId","in":"path","type":"string","required":true,"description":"Id of the portfolio or security account"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"accountIds":[{}],"jointHolder":[{}],"customerId":"string","referenceCurrency":"string","valuationCurrency":"string","portfolioName":"string","accountOfficer":"string","investmentProgram":"string","managedAccount":"string","safekeepChargeAccount":"string","startDate":"string","memoAccount":"string"}},"responses":{"200":"PortfolioResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"DELETE","path":"/holdings/portfolios/{portfolioId}","fullPath":"/api/v3.0.0/holdings/portfolios/{portfolioId}","operationId":"reversePortfolio","name":"Reverses the portfolio that does not have positions","summary":"Reverses the portfolio","tags":[],"parameters":[{"name":"portfolioId","in":"path","type":"string","required":true,"description":""},{"name":"payload","in":"body","type":"object","required":false,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}}},"responses":{"200":"PortfolioResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/holdings/portfolios/{portfolioId}/orderBlotters","fullPath":"/api/v3.0.0/holdings/portfolios/{portfolioId}/orderBlotters","operationId":"getPortfolioOrderBlotter","name":"Allows to retrieve the pending and completed orders of the portfolio","summary":"Allows to retrieve the pending and completed orders of the portfolio","tags":[],"parameters":[{"name":"portfolioId","in":"path","type":"string","required":true,"description":"Id of the portfolio or security account"},{"name":"instrumentId","in":"query","type":"string","required":false,"description":"The identifier of the instrument"},{"name":"fromDate","in":"query","type":"string","required":false,"description":"Indicates the business date from when the balance reservation event is active."},{"name":"toDate","in":"query","type":"string","required":false,"description":"Indicates the business date until when the balance reservation event is active."},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"PortfolioOrderBlotterResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/portfolios/{portfolioId}/securityTransactions","fullPath":"/api/v3.0.0/holdings/portfolios/{portfolioId}/securityTransactions","operationId":"getPortfolioTransactionDetails","name":"Allows to retrieve security transactions of the portfolio","summary":"Allows to retrieve security transactions of the portfolio","tags":[],"parameters":[{"name":"portfolioId","in":"path","type":"string","required":true,"description":"Id of the portfolio or security account"},{"name":"customerId","in":"query","type":"string","required":false,"description":"Identifier of the customer"},{"name":"instrumentId","in":"query","type":"string","required":false,"description":"The identifier of the instrument"},{"name":"startDate","in":"query","type":"string","required":false,"description":"Contains the date on which the transaction or payment gets initiated."},{"name":"endDate","in":"query","type":"string","required":false,"description":"Indicates the date till which the transaction history requested. If 20120101 is the start date and 20120201 is the end date, all transactions that are booked between January 1 to February 1 2012 are r"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"PortfolioTransactionDetailsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/portfolios/{portfolioId}/assetAllocations","fullPath":"/api/v3.0.0/holdings/portfolios/{portfolioId}/assetAllocations","operationId":"getPortfolioDetails","name":"Allows to retrieve asset allocations and cash balance of the portfolio","summary":"Allows to retrieve asset allocations and cash balance of the portfolio","tags":[],"parameters":[{"name":"portfolioId","in":"path","type":"string","required":true,"description":"Id of the portfolio or security account"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"PortfolioDetailsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/portfolios/{portfolioId}/holdings","fullPath":"/api/v3.0.0/holdings/portfolios/{portfolioId}/holdings","operationId":"getPortfolioHoldings","name":"Allows to retrieve the holding details of the portfolio","summary":"Allows to retrieve the holding details of the portfolio","tags":[],"parameters":[{"name":"portfolioId","in":"path","type":"string","required":true,"description":"Id of the portfolio or security account"},{"name":"onlineUpdate","in":"query","type":"string","required":false,"description":"The valuation for the portfolio will be done online if this flag is set to 'Y'"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"PortfolioHoldingsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}}]},{"key":"holdings-portfolios-service-v3.0.1","title":"Portfolio Management","version":"v3.0.1","description":"Allows the creation, updation and closure of the portfolio, delinking an account from the portfolio and retrieves the account balance, valuation and other information","endpointCount":15,"endpoints":[{"method":"PUT","path":"/holdings/portfolios/{portfolioId}/portfolioClosures","fullPath":"/api/v3.0.1/holdings/portfolios/{portfolioId}/portfolioClosures","operationId":"updatePortfolioClosure","name":"Updates the closure date for a portfolio","summary":"Updates the closure date","tags":[],"parameters":[{"name":"portfolioId","in":"path","type":"string","required":true,"description":"Id of the portfolio or security account"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"accountIds":[{}],"jointHolder":[{}],"customerId":0.0,"referenceCurrency":"string","valuationCurrency":"string","portfolioName":"string","accountOfficer":0.0,"investmentProgram":0.0,"managedAccount":0.0,"safekeepChargeAccount":"string","currencyId":"string","startDate":"2024-01-01","closureDate":"2024-01-01"}},"responses":{"200":"PortfolioClosureResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/holdings/portfolios/{portfolioId}/accountRemovals","fullPath":"/api/v3.0.1/holdings/portfolios/{portfolioId}/accountRemovals","operationId":"updatePortfolioDelinkAccount","name":"Allows to delink an account from the portfolio","summary":"Allows to delink an account","tags":[],"parameters":[{"name":"portfolioId","in":"path","type":"string","required":true,"description":"Id of the portfolio or security account"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"accountIds":[{}],"jointHolder":[{}],"customerId":0.0,"referenceCurrency":"string","valuationCurrency":"string","portfolioName":"string","accountOfficer":0.0,"investmentProgram":0.0,"managedAccount":0.0,"safekeepChargeAccount":"string","currencyId":"string","startDate":"2024-01-01","closureDate":"2024-01-01"}},"responses":{"200":"PortfolioDelinkAccountResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/holdings/portfolios/{portfolioId}/valuations","fullPath":"/api/v3.0.1/holdings/portfolios/{portfolioId}/valuations","operationId":"getPortfolioValuations","name":"Retrieves the asset and liability information based on the portfolio","summary":"Retrieves the asset and liability information","tags":[],"parameters":[{"name":"portfolioId","in":"path","type":"string","required":true,"description":"Id of the portfolio or security account"},{"name":"currencyId","in":"query","type":"string","required":false,"description":"Identifier of the currency. This is the 3-letter ISO 4217 code of the currency."},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"PortfolioValuationsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/portfolios/{portfolioId}/LTV","fullPath":"/api/v3.0.1/holdings/portfolios/{portfolioId}/LTV","operationId":"getPortfolioLTV","name":"Retrieves the liability information based on the portfolio and the currency","summary":"Retrieves the liability information","tags":[],"parameters":[{"name":"portfolioId","in":"path","type":"string","required":true,"description":"Id of the portfolio or security account"},{"name":"currencyId","in":"query","type":"string","required":false,"description":"Identifier of the currency. This is the 3-letter ISO 4217 code of the currency."},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"PortfolioLTVResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/portfolios/ownBooks","fullPath":"/api/v3.0.1/holdings/portfolios/ownBooks","operationId":"getOwnBookPortfolios","name":"Retrieves the own book portfolio information filtered based on the portfolio id","summary":"Retrieves the own book portfolio list","tags":[],"parameters":[{"name":"portfolioId","in":"query","type":"string","required":false,"description":"Id of the portfolio or security account"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"OwnBookPortfoliosResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/portfolios/{portfolioId}/accounts","fullPath":"/api/v3.0.1/holdings/portfolios/{portfolioId}/accounts","operationId":"getPortfolioAccounts","name":"Retrieves the accounts and balance information for the portfolio","summary":"Retrieves the porfolio account information","tags":[],"parameters":[{"name":"portfolioId","in":"path","type":"string","required":true,"description":"Id of the portfolio or security account"},{"name":"customerId","in":"query","type":"string","required":false,"description":"Identifier of the customer"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"PortfolioAccountsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/customers/{customerId}/portfolios","fullPath":"/api/v3.0.1/holdings/customers/{customerId}/portfolios","operationId":"getPortfolios","name":"Retrieves the portfolio information for a single customer","summary":"Retrieves the portfolio information of single customer","tags":[],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"Identifier of the customer"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"PortfoliosResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/portfolios/{portfolioId}","fullPath":"/api/v3.0.1/holdings/portfolios/{portfolioId}","operationId":"getPortfolio","name":"Retrieves information about the customer's portfolio","summary":"Retrieve portfolio information","tags":[],"parameters":[{"name":"portfolioId","in":"path","type":"string","required":true,"description":"Id of the portfolio or security account"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"PortfolioResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"POST","path":"/holdings/portfolios/{portfolioId}","fullPath":"/api/v3.0.1/holdings/portfolios/{portfolioId}","operationId":"createPortfolio","name":"Creates a new portfolio for a securities customer","summary":"Create a new portfolio for a customer","tags":[],"parameters":[{"name":"portfolioId","in":"path","type":"string","required":true,"description":"Id of the portfolio or security account"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"accountIds":[{}],"jointHolder":[{}],"customerId":"string","referenceCurrency":"string","valuationCurrency":"string","portfolioName":"string","accountOfficer":"string","investmentProgram":"string","managedAccount":"string","safekeepChargeAccount":"string","startDate":"string","memoAccount":"string"}},"responses":{"200":"PortfolioResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/holdings/portfolios/{portfolioId}","fullPath":"/api/v3.0.1/holdings/portfolios/{portfolioId}","operationId":"updatePortfolio","name":"Update details about the customer's portfolio","summary":"Updates the customer's portfolio","tags":[],"parameters":[{"name":"portfolioId","in":"path","type":"string","required":true,"description":"Id of the portfolio or security account"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"accountIds":[{}],"jointHolder":[{}],"customerId":"string","referenceCurrency":"string","valuationCurrency":"string","portfolioName":"string","accountOfficer":"string","investmentProgram":"string","managedAccount":"string","safekeepChargeAccount":"string","startDate":"string","memoAccount":"string"}},"responses":{"200":"PortfolioResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"DELETE","path":"/holdings/portfolios/{portfolioId}","fullPath":"/api/v3.0.1/holdings/portfolios/{portfolioId}","operationId":"reversePortfolio","name":"Reverses the portfolio that does not have positions","summary":"Reverses the portfolio","tags":[],"parameters":[{"name":"portfolioId","in":"path","type":"string","required":true,"description":""},{"name":"payload","in":"body","type":"object","required":false,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}}},"responses":{"200":"PortfolioResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/holdings/portfolios/{portfolioId}/orderBlotters","fullPath":"/api/v3.0.1/holdings/portfolios/{portfolioId}/orderBlotters","operationId":"getPortfolioOrderBlotter","name":"Allows to retrieve the pending and completed orders of the portfolio","summary":"Allows to retrieve the pending and completed orders of the portfolio","tags":[],"parameters":[{"name":"portfolioId","in":"path","type":"string","required":true,"description":"Id of the portfolio or security account"},{"name":"instrumentId","in":"query","type":"string","required":false,"description":"The identifier of the instrument"},{"name":"fromDate","in":"query","type":"string","required":false,"description":"Indicates the business date from when the balance reservation event is active."},{"name":"toDate","in":"query","type":"string","required":false,"description":"Indicates the business date until when the balance reservation event is active."},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"PortfolioOrderBlotterResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/portfolios/{portfolioId}/securityTransactions","fullPath":"/api/v3.0.1/holdings/portfolios/{portfolioId}/securityTransactions","operationId":"getPortfolioTransactionDetails","name":"Allows to retrieve security transactions of the portfolio","summary":"Allows to retrieve security transactions of the portfolio","tags":[],"parameters":[{"name":"portfolioId","in":"path","type":"string","required":true,"description":"Id of the portfolio or security account"},{"name":"customerId","in":"query","type":"string","required":false,"description":"Identifier of the customer"},{"name":"instrumentId","in":"query","type":"string","required":false,"description":"The identifier of the instrument"},{"name":"startDate","in":"query","type":"string","required":false,"description":"Contains the date on which the transaction or payment gets initiated."},{"name":"endDate","in":"query","type":"string","required":false,"description":"Indicates the date till which the transaction history requested. If 20120101 is the start date and 20120201 is the end date, all transactions that are booked between January 1 to February 1 2012 are r"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"PortfolioTransactionDetailsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/portfolios/{portfolioId}/assetAllocations","fullPath":"/api/v3.0.1/holdings/portfolios/{portfolioId}/assetAllocations","operationId":"getPortfolioDetails","name":"Allows to retrieve asset allocations and cash balance of the portfolio","summary":"Allows to retrieve asset allocations and cash balance of the portfolio","tags":[],"parameters":[{"name":"portfolioId","in":"path","type":"string","required":true,"description":"Id of the portfolio or security account"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"PortfolioDetailsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/portfolios/{portfolioId}/holdings","fullPath":"/api/v3.0.1/holdings/portfolios/{portfolioId}/holdings","operationId":"getPortfolioHoldings","name":"Allows to retrieve the holding details of the portfolio","summary":"Allows to retrieve the holding details of the portfolio","tags":[],"parameters":[{"name":"portfolioId","in":"path","type":"string","required":true,"description":"Id of the portfolio or security account"},{"name":"onlineUpdate","in":"query","type":"string","required":false,"description":"The valuation for the portfolio will be done online if this flag is set to 'Y'"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"PortfolioHoldingsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}}]},{"key":"holdings-portfolios-service-v3.0.2","title":"Portfolio Management","version":"v3.0.2","description":"Allows the creation, updation and closure of the portfolio, delinking an account from the portfolio and retrieves the account balance, valuation and other information","endpointCount":15,"endpoints":[{"method":"PUT","path":"/holdings/portfolios/{portfolioId}/portfolioClosures","fullPath":"/api/v3.0.2/holdings/portfolios/{portfolioId}/portfolioClosures","operationId":"updatePortfolioClosure","name":"Updates the closure date for a portfolio","summary":"Updates the closure date","tags":[],"parameters":[{"name":"portfolioId","in":"path","type":"string","required":true,"description":"Id of the portfolio or security account"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"accountIds":[{}],"jointHolder":[{}],"customerId":0.0,"referenceCurrency":"string","valuationCurrency":"string","portfolioName":"string","accountOfficer":0.0,"investmentProgram":0.0,"managedAccount":0.0,"safekeepChargeAccount":"string","currencyId":"string","startDate":"2024-01-01","closureDate":"2024-01-01"}},"responses":{"200":"PortfolioClosureResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/holdings/portfolios/{portfolioId}/accountRemovals","fullPath":"/api/v3.0.2/holdings/portfolios/{portfolioId}/accountRemovals","operationId":"updatePortfolioDelinkAccount","name":"Allows to delink an account from the portfolio","summary":"Allows to delink an account","tags":[],"parameters":[{"name":"portfolioId","in":"path","type":"string","required":true,"description":"Id of the portfolio or security account"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"accountIds":[{}],"jointHolder":[{}],"customerId":0.0,"referenceCurrency":"string","valuationCurrency":"string","portfolioName":"string","accountOfficer":0.0,"investmentProgram":0.0,"managedAccount":0.0,"safekeepChargeAccount":"string","currencyId":"string","startDate":"2024-01-01","closureDate":"2024-01-01"}},"responses":{"200":"PortfolioDelinkAccountResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/holdings/portfolios/{portfolioId}/valuations","fullPath":"/api/v3.0.2/holdings/portfolios/{portfolioId}/valuations","operationId":"getPortfolioValuations","name":"Retrieves the asset and liability information based on the portfolio","summary":"Retrieves the asset and liability information","tags":[],"parameters":[{"name":"portfolioId","in":"path","type":"string","required":true,"description":"Id of the portfolio or security account"},{"name":"currencyId","in":"query","type":"string","required":false,"description":"Identifier of the currency. This is the 3-letter ISO 4217 code of the currency."},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"PortfolioValuationsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/portfolios/{portfolioId}/LTV","fullPath":"/api/v3.0.2/holdings/portfolios/{portfolioId}/LTV","operationId":"getPortfolioLTV","name":"Retrieves the liability information based on the portfolio and the currency","summary":"Retrieves the liability information","tags":[],"parameters":[{"name":"portfolioId","in":"path","type":"string","required":true,"description":"Id of the portfolio or security account"},{"name":"currencyId","in":"query","type":"string","required":true,"description":"Identifier of the currency. This is the 3-letter ISO 4217 code of the currency."},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"PortfolioLTVResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/portfolios/ownBooks","fullPath":"/api/v3.0.2/holdings/portfolios/ownBooks","operationId":"getOwnBookPortfolios","name":"Retrieves the own book portfolio information filtered based on the portfolio id","summary":"Retrieves the own book portfolio list","tags":[],"parameters":[{"name":"portfolioId","in":"query","type":"string","required":false,"description":"Id of the portfolio or security account"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"OwnBookPortfoliosResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/portfolios/{portfolioId}/accounts","fullPath":"/api/v3.0.2/holdings/portfolios/{portfolioId}/accounts","operationId":"getPortfolioAccounts","name":"Retrieves the accounts and balance information for the portfolio","summary":"Retrieves the porfolio account information","tags":[],"parameters":[{"name":"portfolioId","in":"path","type":"string","required":true,"description":"Id of the portfolio or security account"},{"name":"customerId","in":"query","type":"string","required":false,"description":"Identifier of the customer"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"PortfolioAccountsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/customers/{customerId}/portfolios","fullPath":"/api/v3.0.2/holdings/customers/{customerId}/portfolios","operationId":"getPortfolios","name":"Retrieves the portfolio information for a single customer","summary":"Retrieves the portfolio information of single customer","tags":[],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"Identifier of the customer"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"PortfoliosResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/portfolios/{portfolioId}","fullPath":"/api/v3.0.2/holdings/portfolios/{portfolioId}","operationId":"getPortfolio","name":"Retrieves information about the customer's portfolio","summary":"Retrieve portfolio information","tags":[],"parameters":[{"name":"portfolioId","in":"path","type":"string","required":true,"description":"Id of the portfolio or security account"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"PortfolioResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"POST","path":"/holdings/portfolios/{portfolioId}","fullPath":"/api/v3.0.2/holdings/portfolios/{portfolioId}","operationId":"createPortfolio","name":"Creates a new portfolio for a securities customer","summary":"Create a new portfolio for a customer","tags":[],"parameters":[{"name":"portfolioId","in":"path","type":"string","required":true,"description":"Id of the portfolio or security account"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"accountIds":[{}],"jointHolder":[{}],"customerId":"string","referenceCurrency":"string","valuationCurrency":"string","portfolioName":"string","accountOfficer":"string","investmentProgram":"string","managedAccount":"string","safekeepChargeAccount":"string","startDate":"string","memoAccount":"string"}},"responses":{"200":"PortfolioResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/holdings/portfolios/{portfolioId}","fullPath":"/api/v3.0.2/holdings/portfolios/{portfolioId}","operationId":"updatePortfolio","name":"Update details about the customer's portfolio","summary":"Updates the customer's portfolio","tags":[],"parameters":[{"name":"portfolioId","in":"path","type":"string","required":true,"description":"Id of the portfolio or security account"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"accountIds":[{}],"jointHolder":[{}],"customerId":"string","referenceCurrency":"string","valuationCurrency":"string","portfolioName":"string","accountOfficer":"string","investmentProgram":"string","managedAccount":"string","safekeepChargeAccount":"string","startDate":"string","memoAccount":"string"}},"responses":{"200":"PortfolioResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"DELETE","path":"/holdings/portfolios/{portfolioId}","fullPath":"/api/v3.0.2/holdings/portfolios/{portfolioId}","operationId":"reversePortfolio","name":"Reverses the portfolio that does not have positions","summary":"Reverses the portfolio","tags":[],"parameters":[{"name":"portfolioId","in":"path","type":"string","required":true,"description":""},{"name":"payload","in":"body","type":"object","required":false,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}}},"responses":{"200":"PortfolioResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/holdings/portfolios/{portfolioId}/orderBlotters","fullPath":"/api/v3.0.2/holdings/portfolios/{portfolioId}/orderBlotters","operationId":"getPortfolioOrderBlotter","name":"Allows to retrieve the pending and completed orders of the portfolio","summary":"Allows to retrieve the pending and completed orders of the portfolio","tags":[],"parameters":[{"name":"portfolioId","in":"path","type":"string","required":true,"description":"Id of the portfolio or security account"},{"name":"instrumentId","in":"query","type":"string","required":false,"description":"The identifier of the instrument"},{"name":"fromDate","in":"query","type":"string","required":false,"description":"Indicates the business date from when the balance reservation event is active."},{"name":"toDate","in":"query","type":"string","required":false,"description":"Indicates the business date until when the balance reservation event is active."},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"PortfolioOrderBlotterResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/portfolios/{portfolioId}/securityTransactions","fullPath":"/api/v3.0.2/holdings/portfolios/{portfolioId}/securityTransactions","operationId":"getPortfolioTransactionDetails","name":"Allows to retrieve security transactions of the portfolio","summary":"Allows to retrieve security transactions of the portfolio","tags":[],"parameters":[{"name":"portfolioId","in":"path","type":"string","required":true,"description":"Id of the portfolio or security account"},{"name":"customerId","in":"query","type":"string","required":false,"description":"Identifier of the customer"},{"name":"instrumentId","in":"query","type":"string","required":false,"description":"The identifier of the instrument"},{"name":"startDate","in":"query","type":"string","required":false,"description":"Contains the date on which the transaction or payment gets initiated."},{"name":"endDate","in":"query","type":"string","required":false,"description":"Indicates the date till which the transaction history requested. If 20120101 is the start date and 20120201 is the end date, all transactions that are booked between January 1 to February 1 2012 are r"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"PortfolioTransactionDetailsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/portfolios/{portfolioId}/assetAllocations","fullPath":"/api/v3.0.2/holdings/portfolios/{portfolioId}/assetAllocations","operationId":"getPortfolioDetails","name":"Allows to retrieve asset allocations and cash balance of the portfolio","summary":"Allows to retrieve asset allocations and cash balance of the portfolio","tags":[],"parameters":[{"name":"portfolioId","in":"path","type":"string","required":true,"description":"Id of the portfolio or security account"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"PortfolioDetailsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/portfolios/{portfolioId}/holdings","fullPath":"/api/v3.0.2/holdings/portfolios/{portfolioId}/holdings","operationId":"getPortfolioHoldings","name":"Allows to retrieve the holding details of the portfolio","summary":"Allows to retrieve the holding details of the portfolio","tags":[],"parameters":[{"name":"portfolioId","in":"path","type":"string","required":true,"description":"Id of the portfolio or security account"},{"name":"onlineUpdate","in":"query","type":"string","required":false,"description":"The valuation for the portfolio will be done online if this flag is set to 'Y'"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"PortfolioHoldingsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}}]},{"key":"holdings-portfolios-service-v3.1.0","title":"Portfolio Management","version":"v3.1.0","description":"Allows the creation, updation and closure of the portfolio, delinking an account from the portfolio and retrieves the account balance, valuation and other information  and creating credit facility for a portfolio by pledging assets","endpointCount":21,"endpoints":[{"method":"PUT","path":"/holdings/portfolios/{portfolioId}/portfolioClosures","fullPath":"/api/v3.1.0/holdings/portfolios/{portfolioId}/portfolioClosures","operationId":"updatePortfolioClosure","name":"Updates the closure date for a portfolio","summary":"Updates the closure date","tags":[],"parameters":[{"name":"portfolioId","in":"path","type":"string","required":true,"description":"Id of the portfolio or security account"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"accountIds":[{}],"jointHolder":[{}],"customerId":0.0,"referenceCurrency":"string","valuationCurrency":"string","portfolioName":"string","accountOfficer":0.0,"investmentProgram":0.0,"managedAccount":0.0,"safekeepChargeAccount":"string","currencyId":"string","startDate":"2024-01-01","closureDate":"2024-01-01"}},"responses":{"200":"PortfolioClosureResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/holdings/portfolios/{portfolioId}/accountRemovals","fullPath":"/api/v3.1.0/holdings/portfolios/{portfolioId}/accountRemovals","operationId":"updatePortfolioDelinkAccount","name":"Allows to delink an account from the portfolio","summary":"Allows to delink an account","tags":[],"parameters":[{"name":"portfolioId","in":"path","type":"string","required":true,"description":"Id of the portfolio or security account"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"accountIds":[{}],"jointHolder":[{}],"customerId":0.0,"referenceCurrency":"string","valuationCurrency":"string","portfolioName":"string","accountOfficer":0.0,"investmentProgram":0.0,"managedAccount":0.0,"safekeepChargeAccount":"string","currencyId":"string","startDate":"2024-01-01","closureDate":"2024-01-01"}},"responses":{"200":"PortfolioDelinkAccountResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/holdings/portfolios/{portfolioId}/valuations","fullPath":"/api/v3.1.0/holdings/portfolios/{portfolioId}/valuations","operationId":"getPortfolioValuations","name":"Retrieves the asset and liability information based on the portfolio","summary":"Retrieves the asset and liability information","tags":[],"parameters":[{"name":"portfolioId","in":"path","type":"string","required":true,"description":"Id of the portfolio or security account"},{"name":"currencyId","in":"query","type":"string","required":false,"description":"Identifier of the currency. This is the 3-letter ISO 4217 code of the currency."},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"PortfolioValuationsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/portfolios/{portfolioId}/LTV","fullPath":"/api/v3.1.0/holdings/portfolios/{portfolioId}/LTV","operationId":"getPortfolioLTV","name":"Retrieves the liability information based on the portfolio and the currency","summary":"Retrieves the liability information","tags":[],"parameters":[{"name":"portfolioId","in":"path","type":"string","required":true,"description":"Id of the portfolio or security account"},{"name":"currencyId","in":"query","type":"string","required":true,"description":"Identifier of the currency. This is the 3-letter ISO 4217 code of the currency."},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"PortfolioLTVResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/portfolios/ownBooks","fullPath":"/api/v3.1.0/holdings/portfolios/ownBooks","operationId":"getOwnBookPortfolios","name":"Retrieves the own book portfolio information filtered based on the portfolio id","summary":"Retrieves the own book portfolio list","tags":[],"parameters":[{"name":"portfolioId","in":"query","type":"string","required":false,"description":"Id of the portfolio or security account"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"OwnBookPortfoliosResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/portfolios/{portfolioId}/accounts","fullPath":"/api/v3.1.0/holdings/portfolios/{portfolioId}/accounts","operationId":"getPortfolioAccounts","name":"Retrieves the accounts and balance information for the portfolio","summary":"Retrieves the porfolio account information","tags":[],"parameters":[{"name":"portfolioId","in":"path","type":"string","required":true,"description":"Id of the portfolio or security account"},{"name":"customerId","in":"query","type":"string","required":false,"description":"Identifier of the customer"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"PortfolioAccountsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/customers/{customerId}/portfolios","fullPath":"/api/v3.1.0/holdings/customers/{customerId}/portfolios","operationId":"getPortfolios","name":"Retrieves the portfolio information for a single customer","summary":"Retrieves the portfolio information of single customer","tags":[],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"Identifier of the customer"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"PortfoliosResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/portfolios/{portfolioId}","fullPath":"/api/v3.1.0/holdings/portfolios/{portfolioId}","operationId":"getPortfolio","name":"Retrieves information about the customer's portfolio","summary":"Retrieve portfolio information","tags":[],"parameters":[{"name":"portfolioId","in":"path","type":"string","required":true,"description":"Id of the portfolio or security account"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"PortfolioResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"POST","path":"/holdings/portfolios/{portfolioId}","fullPath":"/api/v3.1.0/holdings/portfolios/{portfolioId}","operationId":"createPortfolio","name":"Creates a new portfolio for a securities customer","summary":"Create a new portfolio for a customer","tags":[],"parameters":[{"name":"portfolioId","in":"path","type":"string","required":true,"description":"Id of the portfolio or security account"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"accountIds":[{}],"jointHolder":[{}],"customerId":"string","referenceCurrency":"string","valuationCurrency":"string","portfolioName":"string","accountOfficer":"string","investmentProgram":"string","managedAccount":"string","safekeepChargeAccount":"string","startDate":"string","memoAccount":"string"}},"responses":{"200":"PortfolioResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/holdings/portfolios/{portfolioId}","fullPath":"/api/v3.1.0/holdings/portfolios/{portfolioId}","operationId":"updatePortfolio","name":"Update details about the customer's portfolio","summary":"Updates the customer's portfolio","tags":[],"parameters":[{"name":"portfolioId","in":"path","type":"string","required":true,"description":"Id of the portfolio or security account"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"accountIds":[{}],"jointHolder":[{}],"customerId":"string","referenceCurrency":"string","valuationCurrency":"string","portfolioName":"string","accountOfficer":"string","investmentProgram":"string","managedAccount":"string","safekeepChargeAccount":"string","startDate":"string","memoAccount":"string"}},"responses":{"200":"PortfolioResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"DELETE","path":"/holdings/portfolios/{portfolioId}","fullPath":"/api/v3.1.0/holdings/portfolios/{portfolioId}","operationId":"reversePortfolio","name":"Reverses the portfolio that does not have positions","summary":"Reverses the portfolio","tags":[],"parameters":[{"name":"portfolioId","in":"path","type":"string","required":true,"description":""},{"name":"payload","in":"body","type":"object","required":false,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}}},"responses":{"200":"PortfolioResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/holdings/portfolios/{portfolioId}/orderBlotters","fullPath":"/api/v3.1.0/holdings/portfolios/{portfolioId}/orderBlotters","operationId":"getPortfolioOrderBlotter","name":"Allows to retrieve the pending and completed orders of the portfolio","summary":"Allows to retrieve the pending and completed orders of the portfolio","tags":[],"parameters":[{"name":"portfolioId","in":"path","type":"string","required":true,"description":"Id of the portfolio or security account"},{"name":"instrumentId","in":"query","type":"string","required":false,"description":"The identifier of the instrument"},{"name":"fromDate","in":"query","type":"string","required":false,"description":"Indicates the business date from when the balance reservation event is active."},{"name":"toDate","in":"query","type":"string","required":false,"description":"Indicates the business date until when the balance reservation event is active."},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"PortfolioOrderBlotterResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/portfolios/{portfolioId}/securityTransactions","fullPath":"/api/v3.1.0/holdings/portfolios/{portfolioId}/securityTransactions","operationId":"getPortfolioTransactionDetails","name":"Allows to retrieve security transactions of the portfolio","summary":"Allows to retrieve security transactions of the portfolio","tags":[],"parameters":[{"name":"portfolioId","in":"path","type":"string","required":true,"description":"Id of the portfolio or security account"},{"name":"customerId","in":"query","type":"string","required":false,"description":"Identifier of the customer"},{"name":"instrumentId","in":"query","type":"string","required":false,"description":"The identifier of the instrument"},{"name":"startDate","in":"query","type":"string","required":false,"description":"Contains the date on which the transaction or payment gets initiated."},{"name":"endDate","in":"query","type":"string","required":false,"description":"Indicates the date till which the transaction history requested. If 20120101 is the start date and 20120201 is the end date, all transactions that are booked between January 1 to February 1 2012 are r"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"PortfolioTransactionDetailsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/portfolios/{portfolioId}/assetAllocations","fullPath":"/api/v3.1.0/holdings/portfolios/{portfolioId}/assetAllocations","operationId":"getPortfolioDetails","name":"Allows to retrieve asset allocations and cash balance of the portfolio","summary":"Allows to retrieve asset allocations and cash balance of the portfolio","tags":[],"parameters":[{"name":"portfolioId","in":"path","type":"string","required":true,"description":"Id of the portfolio or security account"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"PortfolioDetailsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/portfolios/{portfolioId}/holdings","fullPath":"/api/v3.1.0/holdings/portfolios/{portfolioId}/holdings","operationId":"getPortfolioHoldings","name":"Allows to retrieve the holding details of the portfolio","summary":"Allows to retrieve the holding details of the portfolio","tags":[],"parameters":[{"name":"portfolioId","in":"path","type":"string","required":true,"description":"Id of the portfolio or security account"},{"name":"onlineUpdate","in":"query","type":"string","required":false,"description":"The valuation for the portfolio will be done online if this flag is set to 'Y'"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"PortfolioHoldingsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/portfolios/{portfolioId}/facilities","fullPath":"/api/v3.1.0/holdings/portfolios/{portfolioId}/facilities","operationId":"getPortfolioFacilities","name":"Retrieves credit facilities available for a portfolio","summary":"Retrieves credit facilities available for a portfolio","tags":[],"parameters":[{"name":"portfolioId","in":"path","type":"string","required":true,"description":"Id of the portfolio or security account"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"PortfolioFacilitiesResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"POST","path":"/holdings/portfolios/facilities","fullPath":"/api/v3.1.0/holdings/portfolios/facilities","operationId":"createPortfolioFacility","name":"Creates credit facility for a porftolio","summary":"Creates credit facility for a porftolio","tags":[],"parameters":[{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"facilityDetails":[{}],"documentTypes":[{}],"collaterals":[{}],"customerId":"string","portfolioId":"string","facilityProduct":"string","openingDate":"string","closingDate":"string","reviewDate":"string","uniqueTransactionReference":"string","currency":"string","amount":"string","collateralType":"string","collateralCodeId":"string","collateralId":"string"}},"responses":{"200":"PortfolioFacilityResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/holdings/portfolios/facilities/{facilityId}","fullPath":"/api/v3.1.0/holdings/portfolios/facilities/{facilityId}","operationId":"getPortfolioFacility","name":"Retrieves the credit facility of the portfolio","summary":"Retrieves the credit facility of the portfolio","tags":[],"parameters":[{"name":"facilityId","in":"path","type":"string","required":true,"description":"Unique identifier (contract number) of the facility"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"PortfolioFacilityResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/holdings/portfolios/facilities/{facilityId}","fullPath":"/api/v3.1.0/holdings/portfolios/facilities/{facilityId}","operationId":"updatePortfolioFacility","name":"Updates the credit facility of the portfolio","summary":"Updates the credit facility of the portfolio","tags":[],"parameters":[{"name":"facilityId","in":"path","type":"string","required":true,"description":"Unique identifier (contract number) of the facility"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"facilityDetails":[{}],"documentTypes":[{}],"collaterals":[{}],"customerId":"string","portfolioId":"string","facilityProduct":"string","openingDate":"string","closingDate":"string","reviewDate":"string","uniqueTransactionReference":"string","currency":"string","amount":"string","collateralType":"string","collateralCodeId":"string","collateralId":"string"}},"responses":{"200":"PortfolioFacilityResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/holdings/portfolios/{portfolioId}/availableNominals","fullPath":"/api/v3.1.0/holdings/portfolios/{portfolioId}/availableNominals","operationId":"getPortfolioAvailableNominals","name":"Retrieves the available nominals to pledge as collateral for each security position of a portfolio","summary":"Retrieves the available nominals to pledge as collateral for each security position of a portfolio","tags":[],"parameters":[{"name":"portfolioId","in":"path","type":"string","required":true,"description":"Id of the portfolio or security account"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"PortfolioAvailableNominalsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/portfolios/{portfolioId}/availablePositions","fullPath":"/api/v3.1.0/holdings/portfolios/{portfolioId}/availablePositions","operationId":"getPortfolioAvailablePositions","name":"Retrieves the available positions of each asset of a portfolio to pledge as collateral","summary":"Retrieves the available positions of each asset of a portfolio to pledge as collateral","tags":[],"parameters":[{"name":"portfolioId","in":"path","type":"string","required":true,"description":"Id of the portfolio or security account"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"PortfolioAvailablePositionsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}}]},{"key":"holdings-portfolios-service-v3.2.0","title":"Portfolio Management","version":"v3.2.0","description":"Allows the creation, updation and closure of the portfolio, delinking an account from the portfolio and retrieves the account balance, valuation and other information  and creating credit facility for a portfolio by pledging assets","endpointCount":21,"endpoints":[{"method":"PUT","path":"/holdings/portfolios/{portfolioId}/portfolioClosures","fullPath":"/api/v3.2.0/holdings/portfolios/{portfolioId}/portfolioClosures","operationId":"updatePortfolioClosure","name":"Updates the closure date for a portfolio","summary":"Updates the closure date","tags":[],"parameters":[{"name":"portfolioId","in":"path","type":"string","required":true,"description":"Id of the portfolio or security account"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"accountIds":[{}],"jointHolder":[{}],"customerId":0.0,"referenceCurrency":"string","valuationCurrency":"string","portfolioName":"string","accountOfficer":0.0,"investmentProgram":0.0,"managedAccount":0.0,"safekeepChargeAccount":"string","currencyId":"string","startDate":"2024-01-01","closureDate":"2024-01-01","extensionData":{}}},"responses":{"200":"PortfolioClosureResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/holdings/portfolios/{portfolioId}/accountRemovals","fullPath":"/api/v3.2.0/holdings/portfolios/{portfolioId}/accountRemovals","operationId":"updatePortfolioDelinkAccount","name":"Allows to delink an account from the portfolio","summary":"Allows to delink an account","tags":[],"parameters":[{"name":"portfolioId","in":"path","type":"string","required":true,"description":"Id of the portfolio or security account"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"accountIds":[{}],"jointHolder":[{}],"customerId":0.0,"referenceCurrency":"string","valuationCurrency":"string","portfolioName":"string","accountOfficer":0.0,"investmentProgram":0.0,"managedAccount":0.0,"safekeepChargeAccount":"string","currencyId":"string","startDate":"2024-01-01","closureDate":"2024-01-01","extensionData":{}}},"responses":{"200":"PortfolioDelinkAccountResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/holdings/portfolios/{portfolioId}/valuations","fullPath":"/api/v3.2.0/holdings/portfolios/{portfolioId}/valuations","operationId":"getPortfolioValuations","name":"Retrieves the asset and liability information based on the portfolio","summary":"Retrieves the asset and liability information","tags":[],"parameters":[{"name":"portfolioId","in":"path","type":"string","required":true,"description":"Id of the portfolio or security account"},{"name":"currencyId","in":"query","type":"string","required":false,"description":"Identifier of the currency. This is the 3-letter ISO 4217 code of the currency."},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"PortfolioValuationsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/portfolios/{portfolioId}/LTV","fullPath":"/api/v3.2.0/holdings/portfolios/{portfolioId}/LTV","operationId":"getPortfolioLTV","name":"Retrieves the liability information based on the portfolio and the currency","summary":"Retrieves the liability information","tags":[],"parameters":[{"name":"portfolioId","in":"path","type":"string","required":true,"description":"Id of the portfolio or security account"},{"name":"currencyId","in":"query","type":"string","required":true,"description":"Identifier of the currency. This is the 3-letter ISO 4217 code of the currency."},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"PortfolioLTVResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/portfolios/ownBooks","fullPath":"/api/v3.2.0/holdings/portfolios/ownBooks","operationId":"getOwnBookPortfolios","name":"Retrieves the own book portfolio information filtered based on the portfolio id","summary":"Retrieves the own book portfolio list","tags":[],"parameters":[{"name":"portfolioId","in":"query","type":"string","required":false,"description":"Id of the portfolio or security account"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"OwnBookPortfoliosResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/portfolios/{portfolioId}/accounts","fullPath":"/api/v3.2.0/holdings/portfolios/{portfolioId}/accounts","operationId":"getPortfolioAccounts","name":"Retrieves the accounts and balance information for the portfolio","summary":"Retrieves the porfolio account information","tags":[],"parameters":[{"name":"portfolioId","in":"path","type":"string","required":true,"description":"Id of the portfolio or security account"},{"name":"customerId","in":"query","type":"string","required":false,"description":"Identifier of the customer"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"PortfolioAccountsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/customers/{customerId}/portfolios","fullPath":"/api/v3.2.0/holdings/customers/{customerId}/portfolios","operationId":"getPortfolios","name":"Retrieves the portfolio information for a single customer","summary":"Retrieves the portfolio information of single customer","tags":[],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"Identifier of the customer"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"PortfoliosResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/portfolios/{portfolioId}","fullPath":"/api/v3.2.0/holdings/portfolios/{portfolioId}","operationId":"getPortfolio","name":"Retrieves information about the customer's portfolio","summary":"Retrieve portfolio information","tags":[],"parameters":[{"name":"portfolioId","in":"path","type":"string","required":true,"description":"Id of the portfolio or security account"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"PortfolioResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"POST","path":"/holdings/portfolios/{portfolioId}","fullPath":"/api/v3.2.0/holdings/portfolios/{portfolioId}","operationId":"createPortfolio","name":"Creates a new portfolio for a securities customer","summary":"Create a new portfolio for a customer","tags":[],"parameters":[{"name":"portfolioId","in":"path","type":"string","required":true,"description":"Id of the portfolio or security account"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"accountIds":[{}],"jointHolder":[{}],"customerId":"string","referenceCurrency":"string","valuationCurrency":"string","portfolioName":"string","accountOfficer":"string","investmentProgram":"string","managedAccount":"string","safekeepChargeAccount":"string","startDate":"string","memoAccount":"string","extensionData":{}}},"responses":{"200":"PortfolioResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/holdings/portfolios/{portfolioId}","fullPath":"/api/v3.2.0/holdings/portfolios/{portfolioId}","operationId":"updatePortfolio","name":"Update details about the customer's portfolio","summary":"Updates the customer's portfolio","tags":[],"parameters":[{"name":"portfolioId","in":"path","type":"string","required":true,"description":"Id of the portfolio or security account"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"accountIds":[{}],"jointHolder":[{}],"customerId":"string","referenceCurrency":"string","valuationCurrency":"string","portfolioName":"string","accountOfficer":"string","investmentProgram":"string","managedAccount":"string","safekeepChargeAccount":"string","startDate":"string","memoAccount":"string","extensionData":{}}},"responses":{"200":"PortfolioResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"DELETE","path":"/holdings/portfolios/{portfolioId}","fullPath":"/api/v3.2.0/holdings/portfolios/{portfolioId}","operationId":"reversePortfolio","name":"Reverses the portfolio that does not have positions","summary":"Reverses the portfolio","tags":[],"parameters":[{"name":"portfolioId","in":"path","type":"string","required":true,"description":""},{"name":"payload","in":"body","type":"object","required":false,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}}},"responses":{"200":"PortfolioResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/holdings/portfolios/{portfolioId}/orderBlotters","fullPath":"/api/v3.2.0/holdings/portfolios/{portfolioId}/orderBlotters","operationId":"getPortfolioOrderBlotter","name":"Allows to retrieve the pending and completed orders of the portfolio","summary":"Allows to retrieve the pending and completed orders of the portfolio","tags":[],"parameters":[{"name":"portfolioId","in":"path","type":"string","required":true,"description":"Id of the portfolio or security account"},{"name":"instrumentId","in":"query","type":"string","required":false,"description":"The identifier of the instrument"},{"name":"fromDate","in":"query","type":"string","required":false,"description":"Indicates the business date from when the balance reservation event is active."},{"name":"toDate","in":"query","type":"string","required":false,"description":"Indicates the business date until when the balance reservation event is active."},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"PortfolioOrderBlotterResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/portfolios/{portfolioId}/securityTransactions","fullPath":"/api/v3.2.0/holdings/portfolios/{portfolioId}/securityTransactions","operationId":"getPortfolioTransactionDetails","name":"Allows to retrieve security transactions of the portfolio","summary":"Allows to retrieve security transactions of the portfolio","tags":[],"parameters":[{"name":"portfolioId","in":"path","type":"string","required":true,"description":"Id of the portfolio or security account"},{"name":"customerId","in":"query","type":"string","required":false,"description":"Identifier of the customer"},{"name":"instrumentId","in":"query","type":"string","required":false,"description":"The identifier of the instrument"},{"name":"startDate","in":"query","type":"string","required":false,"description":"Contains the date on which the transaction or payment gets initiated."},{"name":"endDate","in":"query","type":"string","required":false,"description":"Indicates the date till which the transaction history requested. If 20120101 is the start date and 20120201 is the end date, all transactions that are booked between January 1 to February 1 2012 are r"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"PortfolioTransactionDetailsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/portfolios/{portfolioId}/holdings","fullPath":"/api/v3.2.0/holdings/portfolios/{portfolioId}/holdings","operationId":"getPortfolioHoldings","name":"Allows to retrieve the holding details of the portfolio","summary":"Allows to retrieve the holding details of the portfolio","tags":[],"parameters":[{"name":"portfolioId","in":"path","type":"string","required":true,"description":"Id of the portfolio or security account"},{"name":"onlineUpdate","in":"query","type":"string","required":false,"description":"The valuation for the portfolio will be done online if this flag is set to 'Y'"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"PortfolioHoldingsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/portfolios/{portfolioId}/facilities","fullPath":"/api/v3.2.0/holdings/portfolios/{portfolioId}/facilities","operationId":"getPortfolioFacilities","name":"Retrieves credit facilities available for a portfolio","summary":"Retrieves credit facilities available for a portfolio","tags":[],"parameters":[{"name":"portfolioId","in":"path","type":"string","required":true,"description":"Id of the portfolio or security account"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"PortfolioFacilitiesResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"POST","path":"/holdings/portfolios/facilities","fullPath":"/api/v3.2.0/holdings/portfolios/facilities","operationId":"createPortfolioFacility","name":"Creates credit facility for a porftolio","summary":"Creates credit facility for a porftolio","tags":[],"parameters":[{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"facilityDetails":[{}],"documentTypes":[{}],"collaterals":[{}],"customerId":"string","portfolioId":"string","facilityProduct":"string","openingDate":"string","closingDate":"string","reviewDate":"string","uniqueTransactionReference":"string","currency":"string","amount":"string","collateralType":"string","collateralCodeId":"string","collateralId":"string"}},"responses":{"200":"PortfolioFacilityResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/holdings/portfolios/facilities/{facilityId}","fullPath":"/api/v3.2.0/holdings/portfolios/facilities/{facilityId}","operationId":"getPortfolioFacility","name":"Retrieves the credit facility of the portfolio","summary":"Retrieves the credit facility of the portfolio","tags":[],"parameters":[{"name":"facilityId","in":"path","type":"string","required":true,"description":"Unique identifier (contract number) of the facility"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"PortfolioFacilityResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/holdings/portfolios/facilities/{facilityId}","fullPath":"/api/v3.2.0/holdings/portfolios/facilities/{facilityId}","operationId":"updatePortfolioFacility","name":"Updates the credit facility of the portfolio","summary":"Updates the credit facility of the portfolio","tags":[],"parameters":[{"name":"facilityId","in":"path","type":"string","required":true,"description":"Unique identifier (contract number) of the facility"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"facilityDetails":[{}],"documentTypes":[{}],"collaterals":[{}],"customerId":"string","portfolioId":"string","facilityProduct":"string","openingDate":"string","closingDate":"string","reviewDate":"string","uniqueTransactionReference":"string","currency":"string","amount":"string","collateralType":"string","collateralCodeId":"string","collateralId":"string"}},"responses":{"200":"PortfolioFacilityResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/holdings/portfolios/{portfolioId}/availableNominals","fullPath":"/api/v3.2.0/holdings/portfolios/{portfolioId}/availableNominals","operationId":"getPortfolioAvailableNominals","name":"Retrieves the available nominals to pledge as collateral for each security position of a portfolio","summary":"Retrieves the available nominals to pledge as collateral for each security position of a portfolio","tags":[],"parameters":[{"name":"portfolioId","in":"path","type":"string","required":true,"description":"Id of the portfolio or security account"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"PortfolioAvailableNominalsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/portfolios/{portfolioId}/availablePositions","fullPath":"/api/v3.2.0/holdings/portfolios/{portfolioId}/availablePositions","operationId":"getPortfolioAvailablePositions","name":"Retrieves the available positions of each asset of a portfolio to pledge as collateral","summary":"Retrieves the available positions of each asset of a portfolio to pledge as collateral","tags":[],"parameters":[{"name":"portfolioId","in":"path","type":"string","required":true,"description":"Id of the portfolio or security account"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"PortfolioAvailablePositionsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/portfolios/{portfolioId}/assetAllocations","fullPath":"/api/v3.2.0/holdings/portfolios/{portfolioId}/assetAllocations","operationId":"getPortfolioDetails","name":"Allows to retrieve asset allocations and cash balance of the portfolio","summary":"Allows to retrieve asset allocations and cash balance of the portfolio","tags":[],"parameters":[{"name":"portfolioId","in":"path","type":"string","required":true,"description":"Id of the portfolio or security account"},{"name":"onlineUpdate","in":"query","type":"string","required":false,"description":"The valuation for the portfolio will be done online if this flag is set to 'Y'"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"PortfolioDetailsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}}]},{"key":"holdings-portfolios-service-v3.2.1","title":"Portfolio Management","version":"v3.2.1","description":"Allows the creation, updation and closure of the portfolio, delinking an account from the portfolio and retrieves the account balance, valuation and other information  and creating credit facility for a portfolio by pledging assets","endpointCount":21,"endpoints":[{"method":"PUT","path":"/holdings/portfolios/{portfolioId}/portfolioClosures","fullPath":"/api/v3.2.1/holdings/portfolios/{portfolioId}/portfolioClosures","operationId":"updatePortfolioClosure","name":"Updates the closure date for a portfolio","summary":"Updates the closure date","tags":[],"parameters":[{"name":"portfolioId","in":"path","type":"string","required":true,"description":"Id of the portfolio or security account"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"accountIds":[{}],"jointHolder":[{}],"customerId":0.0,"referenceCurrency":"string","valuationCurrency":"string","portfolioName":"string","accountOfficer":0.0,"investmentProgram":0.0,"managedAccount":0.0,"safekeepChargeAccount":"string","currencyId":"string","startDate":"2024-01-01","closureDate":"2024-01-01","extensions":{}}},"responses":{"200":"PortfolioClosureResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/holdings/portfolios/{portfolioId}/accountRemovals","fullPath":"/api/v3.2.1/holdings/portfolios/{portfolioId}/accountRemovals","operationId":"updatePortfolioDelinkAccount","name":"Allows to delink an account from the portfolio","summary":"Allows to delink an account","tags":[],"parameters":[{"name":"portfolioId","in":"path","type":"string","required":true,"description":"Id of the portfolio or security account"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"accountIds":[{}],"jointHolder":[{}],"customerId":0.0,"referenceCurrency":"string","valuationCurrency":"string","portfolioName":"string","accountOfficer":0.0,"investmentProgram":0.0,"managedAccount":0.0,"safekeepChargeAccount":"string","currencyId":"string","startDate":"2024-01-01","closureDate":"2024-01-01","extensions":{}}},"responses":{"200":"PortfolioDelinkAccountResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/holdings/portfolios/{portfolioId}/valuations","fullPath":"/api/v3.2.1/holdings/portfolios/{portfolioId}/valuations","operationId":"getPortfolioValuations","name":"Retrieves the asset and liability information based on the portfolio","summary":"Retrieves the asset and liability information","tags":[],"parameters":[{"name":"portfolioId","in":"path","type":"string","required":true,"description":"Id of the portfolio or security account"},{"name":"currencyId","in":"query","type":"string","required":false,"description":"Identifier of the currency. This is the 3-letter ISO 4217 code of the currency."},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"PortfolioValuationsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/portfolios/{portfolioId}/LTV","fullPath":"/api/v3.2.1/holdings/portfolios/{portfolioId}/LTV","operationId":"getPortfolioLTV","name":"Retrieves the liability information based on the portfolio and the currency","summary":"Retrieves the liability information","tags":[],"parameters":[{"name":"portfolioId","in":"path","type":"string","required":true,"description":"Id of the portfolio or security account"},{"name":"currencyId","in":"query","type":"string","required":true,"description":"Identifier of the currency. This is the 3-letter ISO 4217 code of the currency."},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"PortfolioLTVResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/portfolios/ownBooks","fullPath":"/api/v3.2.1/holdings/portfolios/ownBooks","operationId":"getOwnBookPortfolios","name":"Retrieves the own book portfolio information filtered based on the portfolio id","summary":"Retrieves the own book portfolio list","tags":[],"parameters":[{"name":"portfolioId","in":"query","type":"string","required":false,"description":"Id of the portfolio or security account"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"OwnBookPortfoliosResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/portfolios/{portfolioId}/accounts","fullPath":"/api/v3.2.1/holdings/portfolios/{portfolioId}/accounts","operationId":"getPortfolioAccounts","name":"Retrieves the accounts and balance information for the portfolio","summary":"Retrieves the porfolio account information","tags":[],"parameters":[{"name":"portfolioId","in":"path","type":"string","required":true,"description":"Id of the portfolio or security account"},{"name":"customerId","in":"query","type":"string","required":false,"description":"Identifier of the customer"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"PortfolioAccountsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/customers/{customerId}/portfolios","fullPath":"/api/v3.2.1/holdings/customers/{customerId}/portfolios","operationId":"getPortfolios","name":"Retrieves the portfolio information for a single customer","summary":"Retrieves the portfolio information of single customer","tags":[],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"Identifier of the customer"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"PortfoliosResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/portfolios/{portfolioId}","fullPath":"/api/v3.2.1/holdings/portfolios/{portfolioId}","operationId":"getPortfolio","name":"Retrieves information about the customer's portfolio","summary":"Retrieve portfolio information","tags":[],"parameters":[{"name":"portfolioId","in":"path","type":"string","required":true,"description":"Id of the portfolio or security account"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"PortfolioResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"POST","path":"/holdings/portfolios/{portfolioId}","fullPath":"/api/v3.2.1/holdings/portfolios/{portfolioId}","operationId":"createPortfolio","name":"Creates a new portfolio for a securities customer","summary":"Create a new portfolio for a customer","tags":[],"parameters":[{"name":"portfolioId","in":"path","type":"string","required":true,"description":"Id of the portfolio or security account"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"accountIds":[{}],"jointHolder":[{}],"customerId":"string","referenceCurrency":"string","valuationCurrency":"string","portfolioName":"string","accountOfficer":"string","investmentProgram":"string","managedAccount":"string","safekeepChargeAccount":"string","startDate":"string","memoAccount":"string","extensions":{}}},"responses":{"200":"PortfolioResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/holdings/portfolios/{portfolioId}","fullPath":"/api/v3.2.1/holdings/portfolios/{portfolioId}","operationId":"updatePortfolio","name":"Update details about the customer's portfolio","summary":"Updates the customer's portfolio","tags":[],"parameters":[{"name":"portfolioId","in":"path","type":"string","required":true,"description":"Id of the portfolio or security account"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"accountIds":[{}],"jointHolder":[{}],"customerId":"string","referenceCurrency":"string","valuationCurrency":"string","portfolioName":"string","accountOfficer":"string","investmentProgram":"string","managedAccount":"string","safekeepChargeAccount":"string","startDate":"string","memoAccount":"string","extensions":{}}},"responses":{"200":"PortfolioResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"DELETE","path":"/holdings/portfolios/{portfolioId}","fullPath":"/api/v3.2.1/holdings/portfolios/{portfolioId}","operationId":"reversePortfolio","name":"Reverses the portfolio that does not have positions","summary":"Reverses the portfolio","tags":[],"parameters":[{"name":"portfolioId","in":"path","type":"string","required":true,"description":""},{"name":"payload","in":"body","type":"object","required":false,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}}},"responses":{"200":"PortfolioResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/holdings/portfolios/{portfolioId}/orderBlotters","fullPath":"/api/v3.2.1/holdings/portfolios/{portfolioId}/orderBlotters","operationId":"getPortfolioOrderBlotter","name":"Allows to retrieve the pending and completed orders of the portfolio","summary":"Allows to retrieve the pending and completed orders of the portfolio","tags":[],"parameters":[{"name":"portfolioId","in":"path","type":"string","required":true,"description":"Id of the portfolio or security account"},{"name":"instrumentId","in":"query","type":"string","required":false,"description":"The identifier of the instrument"},{"name":"fromDate","in":"query","type":"string","required":false,"description":"Indicates the business date from when the balance reservation event is active."},{"name":"toDate","in":"query","type":"string","required":false,"description":"Indicates the business date until when the balance reservation event is active."},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"PortfolioOrderBlotterResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/portfolios/{portfolioId}/securityTransactions","fullPath":"/api/v3.2.1/holdings/portfolios/{portfolioId}/securityTransactions","operationId":"getPortfolioTransactionDetails","name":"Allows to retrieve security transactions of the portfolio","summary":"Allows to retrieve security transactions of the portfolio","tags":[],"parameters":[{"name":"portfolioId","in":"path","type":"string","required":true,"description":"Id of the portfolio or security account"},{"name":"customerId","in":"query","type":"string","required":false,"description":"Identifier of the customer"},{"name":"instrumentId","in":"query","type":"string","required":false,"description":"The identifier of the instrument"},{"name":"startDate","in":"query","type":"string","required":false,"description":"Contains the date on which the transaction or payment gets initiated."},{"name":"endDate","in":"query","type":"string","required":false,"description":"Indicates the date till which the transaction history requested. If 20120101 is the start date and 20120201 is the end date, all transactions that are booked between January 1 to February 1 2012 are r"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"PortfolioTransactionDetailsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/portfolios/{portfolioId}/holdings","fullPath":"/api/v3.2.1/holdings/portfolios/{portfolioId}/holdings","operationId":"getPortfolioHoldings","name":"Allows to retrieve the holding details of the portfolio","summary":"Allows to retrieve the holding details of the portfolio","tags":[],"parameters":[{"name":"portfolioId","in":"path","type":"string","required":true,"description":"Id of the portfolio or security account"},{"name":"onlineUpdate","in":"query","type":"string","required":false,"description":"The valuation for the portfolio will be done online if this flag is set to 'Y'"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"PortfolioHoldingsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/portfolios/{portfolioId}/facilities","fullPath":"/api/v3.2.1/holdings/portfolios/{portfolioId}/facilities","operationId":"getPortfolioFacilities","name":"Retrieves credit facilities available for a portfolio","summary":"Retrieves credit facilities available for a portfolio","tags":[],"parameters":[{"name":"portfolioId","in":"path","type":"string","required":true,"description":"Id of the portfolio or security account"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"PortfolioFacilitiesResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"POST","path":"/holdings/portfolios/facilities","fullPath":"/api/v3.2.1/holdings/portfolios/facilities","operationId":"createPortfolioFacility","name":"Creates credit facility for a porftolio","summary":"Creates credit facility for a porftolio","tags":[],"parameters":[{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"facilityDetails":[{}],"documentTypes":[{}],"collaterals":[{}],"customerId":"string","portfolioId":"string","facilityProduct":"string","openingDate":"string","closingDate":"string","reviewDate":"string","uniqueTransactionReference":"string","currency":"string","amount":"string","collateralType":"string","collateralCodeId":"string","collateralId":"string"}},"responses":{"200":"PortfolioFacilityResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/holdings/portfolios/facilities/{facilityId}","fullPath":"/api/v3.2.1/holdings/portfolios/facilities/{facilityId}","operationId":"getPortfolioFacility","name":"Retrieves the credit facility of the portfolio","summary":"Retrieves the credit facility of the portfolio","tags":[],"parameters":[{"name":"facilityId","in":"path","type":"string","required":true,"description":"Unique identifier (contract number) of the facility"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"PortfolioFacilityResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/holdings/portfolios/facilities/{facilityId}","fullPath":"/api/v3.2.1/holdings/portfolios/facilities/{facilityId}","operationId":"updatePortfolioFacility","name":"Updates the credit facility of the portfolio","summary":"Updates the credit facility of the portfolio","tags":[],"parameters":[{"name":"facilityId","in":"path","type":"string","required":true,"description":"Unique identifier (contract number) of the facility"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"facilityDetails":[{}],"documentTypes":[{}],"collaterals":[{}],"customerId":"string","portfolioId":"string","facilityProduct":"string","openingDate":"string","closingDate":"string","reviewDate":"string","uniqueTransactionReference":"string","currency":"string","amount":"string","collateralType":"string","collateralCodeId":"string","collateralId":"string"}},"responses":{"200":"PortfolioFacilityResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/holdings/portfolios/{portfolioId}/availableNominals","fullPath":"/api/v3.2.1/holdings/portfolios/{portfolioId}/availableNominals","operationId":"getPortfolioAvailableNominals","name":"Retrieves the available nominals to pledge as collateral for each security position of a portfolio","summary":"Retrieves the available nominals to pledge as collateral for each security position of a portfolio","tags":[],"parameters":[{"name":"portfolioId","in":"path","type":"string","required":true,"description":"Id of the portfolio or security account"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"PortfolioAvailableNominalsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/portfolios/{portfolioId}/availablePositions","fullPath":"/api/v3.2.1/holdings/portfolios/{portfolioId}/availablePositions","operationId":"getPortfolioAvailablePositions","name":"Retrieves the available positions of each asset of a portfolio to pledge as collateral","summary":"Retrieves the available positions of each asset of a portfolio to pledge as collateral","tags":[],"parameters":[{"name":"portfolioId","in":"path","type":"string","required":true,"description":"Id of the portfolio or security account"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"PortfolioAvailablePositionsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/portfolios/{portfolioId}/assetAllocations","fullPath":"/api/v3.2.1/holdings/portfolios/{portfolioId}/assetAllocations","operationId":"getPortfolioDetails","name":"Allows to retrieve asset allocations and cash balance of the portfolio","summary":"Allows to retrieve asset allocations and cash balance of the portfolio","tags":[],"parameters":[{"name":"portfolioId","in":"path","type":"string","required":true,"description":"Id of the portfolio or security account"},{"name":"onlineUpdate","in":"query","type":"string","required":false,"description":"The valuation for the portfolio will be done online if this flag is set to 'Y'"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"PortfolioDetailsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}}]},{"key":"holdings-portfolios-service-v3.3.0","title":"Portfolio Management","version":"v3.3.0","description":"Allows the creation, updation and closure of the portfolio, delinking an account from the portfolio and retrieves the account balance, valuation and other information  and creating credit facility for a portfolio by pledging assets","endpointCount":24,"endpoints":[{"method":"PUT","path":"/holdings/portfolios/{portfolioId}/portfolioClosures","fullPath":"/api/v3.3.0/holdings/portfolios/{portfolioId}/portfolioClosures","operationId":"updatePortfolioClosure","name":"Updates the closure date for a portfolio","summary":"Updates the closure date","tags":["WEALTH"],"parameters":[{"name":"portfolioId","in":"path","type":"string","required":true,"description":"Id of the portfolio or security account"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"accountIds":[{}],"jointHolder":[{}],"customerId":0.0,"referenceCurrency":"string","valuationCurrency":"string","portfolioName":"string","accountOfficer":0.0,"investmentProgram":0.0,"managedAccount":0.0,"safekeepChargeAccount":"string","currencyId":"string","startDate":"2024-01-01","closureDate":"2024-01-01","extensions":{}}},"responses":{"200":"PortfolioClosureResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/holdings/portfolios/{portfolioId}/accountRemovals","fullPath":"/api/v3.3.0/holdings/portfolios/{portfolioId}/accountRemovals","operationId":"updatePortfolioDelinkAccount","name":"Allows to delink an account from the portfolio","summary":"Allows to delink an account","tags":["WEALTH"],"parameters":[{"name":"portfolioId","in":"path","type":"string","required":true,"description":"Id of the portfolio or security account"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"accountIds":[{}],"jointHolder":[{}],"customerId":0.0,"referenceCurrency":"string","valuationCurrency":"string","portfolioName":"string","accountOfficer":0.0,"investmentProgram":0.0,"managedAccount":0.0,"safekeepChargeAccount":"string","currencyId":"string","startDate":"2024-01-01","closureDate":"2024-01-01","extensions":{}}},"responses":{"200":"PortfolioDelinkAccountResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/holdings/portfolios/{portfolioId}/valuations","fullPath":"/api/v3.3.0/holdings/portfolios/{portfolioId}/valuations","operationId":"getPortfolioValuations","name":"Retrieves the asset and liability information based on the portfolio","summary":"Retrieves the asset and liability information","tags":["WEALTH"],"parameters":[{"name":"portfolioId","in":"path","type":"string","required":true,"description":"Id of the portfolio or security account"},{"name":"currencyId","in":"query","type":"string","required":false,"description":"Identifier of the currency. This is the 3-letter ISO 4217 code of the currency."},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"PortfolioValuationsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/portfolios/{portfolioId}/LTV","fullPath":"/api/v3.3.0/holdings/portfolios/{portfolioId}/LTV","operationId":"getPortfolioLTV","name":"Retrieves the liability information based on the portfolio and the currency","summary":"Retrieves the liability information","tags":["WEALTH"],"parameters":[{"name":"portfolioId","in":"path","type":"string","required":true,"description":"Id of the portfolio or security account"},{"name":"currencyId","in":"query","type":"string","required":true,"description":"Identifier of the currency. This is the 3-letter ISO 4217 code of the currency."},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"PortfolioLTVResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/portfolios/ownBooks","fullPath":"/api/v3.3.0/holdings/portfolios/ownBooks","operationId":"getOwnBookPortfolios","name":"Retrieves the own book portfolio information filtered based on the portfolio id","summary":"Retrieves the own book portfolio list","tags":["WEALTH"],"parameters":[{"name":"portfolioId","in":"query","type":"string","required":false,"description":"Id of the portfolio or security account"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"OwnBookPortfoliosResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/portfolios/{portfolioId}/accounts","fullPath":"/api/v3.3.0/holdings/portfolios/{portfolioId}/accounts","operationId":"getPortfolioAccounts","name":"Retrieves the accounts and balance information for the portfolio","summary":"Retrieves the porfolio account information","tags":["WEALTH"],"parameters":[{"name":"portfolioId","in":"path","type":"string","required":true,"description":"Id of the portfolio or security account"},{"name":"customerId","in":"query","type":"string","required":false,"description":"Identifier of the customer"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"PortfolioAccountsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/customers/{customerId}/portfolios","fullPath":"/api/v3.3.0/holdings/customers/{customerId}/portfolios","operationId":"getPortfolios","name":"Retrieves the portfolio information for a single customer","summary":"Retrieves the portfolio information of single customer","tags":["WEALTH"],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"Identifier of the customer"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"PortfoliosResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/portfolios/{portfolioId}","fullPath":"/api/v3.3.0/holdings/portfolios/{portfolioId}","operationId":"getPortfolio","name":"Retrieves information about the customer's portfolio","summary":"Retrieve portfolio information","tags":["WEALTH"],"parameters":[{"name":"portfolioId","in":"path","type":"string","required":true,"description":"Id of the portfolio or security account"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"PortfolioResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"POST","path":"/holdings/portfolios/{portfolioId}","fullPath":"/api/v3.3.0/holdings/portfolios/{portfolioId}","operationId":"createPortfolio","name":"Creates a new portfolio for a securities customer","summary":"Create a new portfolio for a customer","tags":["WEALTH"],"parameters":[{"name":"portfolioId","in":"path","type":"string","required":true,"description":"Id of the portfolio or security account"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"accountIds":[{}],"jointHolder":[{}],"depoDetails":[{}],"customerId":"string","referenceCurrency":"string","valuationCurrency":"string","portfolioName":"string","accountOfficer":"string","investmentProgram":"string","managedAccount":"string","safekeepChargeAccount":"string","startDate":"2024-01-01","memoAccount":"string","extensions":{}}},"responses":{"200":"PortfolioResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/holdings/portfolios/{portfolioId}","fullPath":"/api/v3.3.0/holdings/portfolios/{portfolioId}","operationId":"updatePortfolio","name":"Update details about the customer's portfolio","summary":"Updates the customer's portfolio","tags":["WEALTH"],"parameters":[{"name":"portfolioId","in":"path","type":"string","required":true,"description":"Id of the portfolio or security account"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"accountIds":[{}],"jointHolder":[{}],"depoDetails":[{}],"customerId":"string","referenceCurrency":"string","valuationCurrency":"string","portfolioName":"string","accountOfficer":"string","investmentProgram":"string","managedAccount":"string","safekeepChargeAccount":"string","startDate":"2024-01-01","memoAccount":"string","extensions":{}}},"responses":{"200":"PortfolioResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"DELETE","path":"/holdings/portfolios/{portfolioId}","fullPath":"/api/v3.3.0/holdings/portfolios/{portfolioId}","operationId":"reversePortfolio","name":"Reverses the portfolio that does not have positions","summary":"Reverses the portfolio","tags":["WEALTH"],"parameters":[{"name":"portfolioId","in":"path","type":"string","required":true,"description":""},{"name":"payload","in":"body","type":"object","required":false,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}}},"responses":{"200":"PortfolioResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/holdings/cryptoPortfolios/{portfolioId}","fullPath":"/api/v3.3.0/holdings/cryptoPortfolios/{portfolioId}","operationId":"getCryptoPortfolio","name":"Retrieves information about the customer's portfolio","summary":"Retrieve portfolio information","tags":["WEALTH"],"parameters":[{"name":"portfolioId","in":"path","type":"string","required":true,"description":"Id of the portfolio or security account"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"CryptoPortfolioResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"POST","path":"/holdings/cryptoPortfolios/{portfolioId}","fullPath":"/api/v3.3.0/holdings/cryptoPortfolios/{portfolioId}","operationId":"createCryptoPortfolio","name":"Creates a new portfolio for a securities customer","summary":"Create a new portfolio for a customer","tags":["WEALTH"],"parameters":[{"name":"portfolioId","in":"path","type":"string","required":true,"description":"Id of the portfolio or security account"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"accountIds":[{}],"blockChainDetails":[{}],"customerId":"string","referenceCurrency":"string","valuationCurrency":"string","portfolioName":"string","accountOfficer":"string","investmentProgram":"string","managedAccount":"string","safekeepChargeAccount":"string","startDate":"2024-01-01","memoAccount":"string","notes":"string","extensions":{}}},"responses":{"200":"CryptoPortfolioResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/holdings/cryptoPortfolios/{portfolioId}","fullPath":"/api/v3.3.0/holdings/cryptoPortfolios/{portfolioId}","operationId":"updateCryptoPortfolio","name":"Update details about the customer's portfolio","summary":"Updates the customer's portfolio","tags":["WEALTH"],"parameters":[{"name":"portfolioId","in":"path","type":"string","required":true,"description":"Id of the portfolio or security account"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"accountIds":[{}],"blockChainDetails":[{}],"customerId":"string","referenceCurrency":"string","valuationCurrency":"string","portfolioName":"string","accountOfficer":"string","investmentProgram":"string","managedAccount":"string","safekeepChargeAccount":"string","startDate":"2024-01-01","memoAccount":"string","notes":"string","extensions":{}}},"responses":{"200":"CryptoPortfolioResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/holdings/portfolios/{portfolioId}/orderBlotters","fullPath":"/api/v3.3.0/holdings/portfolios/{portfolioId}/orderBlotters","operationId":"getPortfolioOrderBlotter","name":"Allows to retrieve the pending and completed orders of the portfolio","summary":"Allows to retrieve the pending and completed orders of the portfolio","tags":["WEALTH"],"parameters":[{"name":"portfolioId","in":"path","type":"string","required":true,"description":"Id of the portfolio or security account"},{"name":"instrumentId","in":"query","type":"string","required":false,"description":"The identifier of the instrument"},{"name":"fromDate","in":"query","type":"string","required":false,"description":"Indicates the business date from when the balance reservation event is active."},{"name":"toDate","in":"query","type":"string","required":false,"description":"Indicates the business date until when the balance reservation event is active."},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"PortfolioOrderBlotterResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/portfolios/{portfolioId}/securityTransactions","fullPath":"/api/v3.3.0/holdings/portfolios/{portfolioId}/securityTransactions","operationId":"getPortfolioTransactionDetails","name":"Allows to retrieve security transactions of the portfolio","summary":"Allows to retrieve security transactions of the portfolio","tags":["WEALTH"],"parameters":[{"name":"portfolioId","in":"path","type":"string","required":true,"description":"Id of the portfolio or security account"},{"name":"customerId","in":"query","type":"string","required":false,"description":"Identifier of the customer"},{"name":"instrumentId","in":"query","type":"string","required":false,"description":"The identifier of the instrument"},{"name":"startDate","in":"query","type":"string","required":false,"description":"Contains the date on which the transaction or payment gets initiated."},{"name":"endDate","in":"query","type":"string","required":false,"description":"Indicates the date till which the transaction history requested. If 20120101 is the start date and 20120201 is the end date, all transactions that are booked between January 1 to February 1 2012 are r"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"PortfolioTransactionDetailsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/portfolios/{portfolioId}/holdings","fullPath":"/api/v3.3.0/holdings/portfolios/{portfolioId}/holdings","operationId":"getPortfolioHoldings","name":"Allows to retrieve the holding details of the portfolio","summary":"Allows to retrieve the holding details of the portfolio","tags":["WEALTH"],"parameters":[{"name":"portfolioId","in":"path","type":"string","required":true,"description":"Id of the portfolio or security account"},{"name":"onlineUpdate","in":"query","type":"string","required":false,"description":"The valuation for the portfolio will be done online if this flag is set to 'Y'"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"PortfolioHoldingsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/portfolios/{portfolioId}/facilities","fullPath":"/api/v3.3.0/holdings/portfolios/{portfolioId}/facilities","operationId":"getPortfolioFacilities","name":"Retrieves credit facilities available for a portfolio","summary":"Retrieves credit facilities available for a portfolio","tags":["WEALTH"],"parameters":[{"name":"portfolioId","in":"path","type":"string","required":true,"description":"Id of the portfolio or security account"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"PortfolioFacilitiesResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"POST","path":"/holdings/portfolios/facilities","fullPath":"/api/v3.3.0/holdings/portfolios/facilities","operationId":"createPortfolioFacility","name":"Creates credit facility for a porftolio","summary":"Creates credit facility for a porftolio","tags":["WEALTH"],"parameters":[{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"facilityDetails":[{}],"documentTypes":[{}],"collaterals":[{}],"customerId":"string","portfolioId":"string","facilityProduct":"string","openingDate":"string","closingDate":"string","reviewDate":"string","uniqueTransactionReference":"string","currency":"string","amount":"string","collateralType":"string","collateralCodeId":"string","collateralId":"string"}},"responses":{"200":"PortfolioFacilityResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/holdings/portfolios/facilities/{facilityId}","fullPath":"/api/v3.3.0/holdings/portfolios/facilities/{facilityId}","operationId":"getPortfolioFacility","name":"Retrieves the credit facility of the portfolio","summary":"Retrieves the credit facility of the portfolio","tags":["WEALTH"],"parameters":[{"name":"facilityId","in":"path","type":"string","required":true,"description":"Unique identifier (contract number) of the facility"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"PortfolioFacilityResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/holdings/portfolios/facilities/{facilityId}","fullPath":"/api/v3.3.0/holdings/portfolios/facilities/{facilityId}","operationId":"updatePortfolioFacility","name":"Updates the credit facility of the portfolio","summary":"Updates the credit facility of the portfolio","tags":["WEALTH"],"parameters":[{"name":"facilityId","in":"path","type":"string","required":true,"description":"Unique identifier (contract number) of the facility"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"facilityDetails":[{}],"documentTypes":[{}],"collaterals":[{}],"customerId":"string","portfolioId":"string","facilityProduct":"string","openingDate":"string","closingDate":"string","reviewDate":"string","uniqueTransactionReference":"string","currency":"string","amount":"string","collateralType":"string","collateralCodeId":"string","collateralId":"string"}},"responses":{"200":"PortfolioFacilityResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/holdings/portfolios/{portfolioId}/availableNominals","fullPath":"/api/v3.3.0/holdings/portfolios/{portfolioId}/availableNominals","operationId":"getPortfolioAvailableNominals","name":"Retrieves the available nominals to pledge as collateral for each security position of a portfolio","summary":"Retrieves the available nominals to pledge as collateral for each security position of a portfolio","tags":["WEALTH"],"parameters":[{"name":"portfolioId","in":"path","type":"string","required":true,"description":"Id of the portfolio or security account"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"PortfolioAvailableNominalsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/portfolios/{portfolioId}/availablePositions","fullPath":"/api/v3.3.0/holdings/portfolios/{portfolioId}/availablePositions","operationId":"getPortfolioAvailablePositions","name":"Retrieves the available positions of each asset of a portfolio to pledge as collateral","summary":"Retrieves the available positions of each asset of a portfolio to pledge as collateral","tags":["WEALTH"],"parameters":[{"name":"portfolioId","in":"path","type":"string","required":true,"description":"Id of the portfolio or security account"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"PortfolioAvailablePositionsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/portfolios/{portfolioId}/assetAllocations","fullPath":"/api/v3.3.0/holdings/portfolios/{portfolioId}/assetAllocations","operationId":"getPortfolioDetails","name":"Allows to retrieve asset allocations and cash balance of the portfolio","summary":"Allows to retrieve asset allocations and cash balance of the portfolio","tags":["WEALTH"],"parameters":[{"name":"portfolioId","in":"path","type":"string","required":true,"description":"Id of the portfolio or security account"},{"name":"onlineUpdate","in":"query","type":"string","required":false,"description":"The valuation for the portfolio will be done online if this flag is set to 'Y'"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"PortfolioDetailsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}}]},{"key":"holdings-portfolios-service-v4.0.0","title":"Portfolio Management","version":"v4.0.0","description":"Allows the creation, updation and closure of the portfolio, delinking an account from the portfolio and retrieves the account balance, valuation and other information  and creating credit facility for a portfolio by pledging assets","endpointCount":24,"endpoints":[{"method":"GET","path":"/holdings/portfolios/{portfolioId}/valuations","fullPath":"/api/v4.0.0/holdings/portfolios/{portfolioId}/valuations","operationId":"getPortfolioValuations","name":"Retrieves the asset and liability information based on the portfolio","summary":"Retrieves the asset and liability information","tags":["WEALTH"],"parameters":[{"name":"portfolioId","in":"path","type":"string","required":true,"description":"Id of the portfolio or security account"},{"name":"currencyId","in":"query","type":"string","required":false,"description":"Identifier of the currency. This is the 3-letter ISO 4217 code of the currency."},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"PortfolioValuationsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/portfolios/{portfolioId}/LTV","fullPath":"/api/v4.0.0/holdings/portfolios/{portfolioId}/LTV","operationId":"getPortfolioLTV","name":"Retrieves the liability information based on the portfolio and the currency","summary":"Retrieves the liability information","tags":["WEALTH"],"parameters":[{"name":"portfolioId","in":"path","type":"string","required":true,"description":"Id of the portfolio or security account"},{"name":"currencyId","in":"query","type":"string","required":true,"description":"Identifier of the currency. This is the 3-letter ISO 4217 code of the currency."},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"PortfolioLTVResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/portfolios/ownBooks","fullPath":"/api/v4.0.0/holdings/portfolios/ownBooks","operationId":"getOwnBookPortfolios","name":"Retrieves the own book portfolio information filtered based on the portfolio id","summary":"Retrieves the own book portfolio list","tags":["WEALTH"],"parameters":[{"name":"portfolioId","in":"query","type":"string","required":false,"description":"Id of the portfolio or security account"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"OwnBookPortfoliosResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/portfolios/{portfolioId}/accounts","fullPath":"/api/v4.0.0/holdings/portfolios/{portfolioId}/accounts","operationId":"getPortfolioAccounts","name":"Retrieves the accounts and balance information for the portfolio","summary":"Retrieves the porfolio account information","tags":["WEALTH"],"parameters":[{"name":"portfolioId","in":"path","type":"string","required":true,"description":"Id of the portfolio or security account"},{"name":"customerId","in":"query","type":"string","required":false,"description":"Identifier of the customer"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"PortfolioAccountsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/customers/{customerId}/portfolios","fullPath":"/api/v4.0.0/holdings/customers/{customerId}/portfolios","operationId":"getPortfolios","name":"Retrieves the portfolio information for a single customer","summary":"Retrieves the portfolio information of single customer","tags":["WEALTH"],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"Identifier of the customer"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"PortfoliosResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/cryptoPortfolios/{portfolioId}","fullPath":"/api/v4.0.0/holdings/cryptoPortfolios/{portfolioId}","operationId":"getCryptoPortfolio","name":"Retrieves information about the customer's portfolio","summary":"Retrieve portfolio information","tags":["WEALTH"],"parameters":[{"name":"portfolioId","in":"path","type":"string","required":true,"description":"Id of the portfolio or security account"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"CryptoPortfolioResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"POST","path":"/holdings/cryptoPortfolios/{portfolioId}","fullPath":"/api/v4.0.0/holdings/cryptoPortfolios/{portfolioId}","operationId":"createCryptoPortfolio","name":"Creates a new portfolio for a securities customer","summary":"Create a new portfolio for a customer","tags":["WEALTH"],"parameters":[{"name":"portfolioId","in":"path","type":"string","required":true,"description":"Id of the portfolio or security account"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"accountIds":[{}],"blockChainDetails":[{}],"customerId":"string","referenceCurrency":"string","valuationCurrency":"string","portfolioName":"string","accountOfficer":"string","investmentProgram":"string","managedAccount":"string","safekeepChargeAccount":"string","startDate":"2024-01-01","memoAccount":"string","notes":"string","extensions":{}}},"responses":{"200":"CryptoPortfolioResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/holdings/cryptoPortfolios/{portfolioId}","fullPath":"/api/v4.0.0/holdings/cryptoPortfolios/{portfolioId}","operationId":"updateCryptoPortfolio","name":"Update details about the customer's portfolio","summary":"Updates the customer's portfolio","tags":["WEALTH"],"parameters":[{"name":"portfolioId","in":"path","type":"string","required":true,"description":"Id of the portfolio or security account"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"accountIds":[{}],"blockChainDetails":[{}],"customerId":"string","referenceCurrency":"string","valuationCurrency":"string","portfolioName":"string","accountOfficer":"string","investmentProgram":"string","managedAccount":"string","safekeepChargeAccount":"string","startDate":"2024-01-01","memoAccount":"string","notes":"string","extensions":{}}},"responses":{"200":"CryptoPortfolioResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/holdings/portfolios/{portfolioId}/orderBlotters","fullPath":"/api/v4.0.0/holdings/portfolios/{portfolioId}/orderBlotters","operationId":"getPortfolioOrderBlotter","name":"Allows to retrieve the pending and completed orders of the portfolio","summary":"Allows to retrieve the pending and completed orders of the portfolio","tags":["WEALTH"],"parameters":[{"name":"portfolioId","in":"path","type":"string","required":true,"description":"Id of the portfolio or security account"},{"name":"instrumentId","in":"query","type":"string","required":false,"description":"The identifier of the instrument"},{"name":"fromDate","in":"query","type":"string","required":false,"description":"Indicates the business date from when the balance reservation event is active."},{"name":"toDate","in":"query","type":"string","required":false,"description":"Indicates the business date until when the balance reservation event is active."},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"PortfolioOrderBlotterResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/portfolios/{portfolioId}/securityTransactions","fullPath":"/api/v4.0.0/holdings/portfolios/{portfolioId}/securityTransactions","operationId":"getPortfolioTransactionDetails","name":"Allows to retrieve security transactions of the portfolio","summary":"Allows to retrieve security transactions of the portfolio","tags":["WEALTH"],"parameters":[{"name":"portfolioId","in":"path","type":"string","required":true,"description":"Id of the portfolio or security account"},{"name":"customerId","in":"query","type":"string","required":false,"description":"Identifier of the customer"},{"name":"instrumentId","in":"query","type":"string","required":false,"description":"The identifier of the instrument"},{"name":"startDate","in":"query","type":"string","required":false,"description":"Contains the date on which the transaction or payment gets initiated."},{"name":"endDate","in":"query","type":"string","required":false,"description":"Indicates the date till which the transaction history requested. If 20120101 is the start date and 20120201 is the end date, all transactions that are booked between January 1 to February 1 2012 are r"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"PortfolioTransactionDetailsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/portfolios/{portfolioId}/holdings","fullPath":"/api/v4.0.0/holdings/portfolios/{portfolioId}/holdings","operationId":"getPortfolioHoldings","name":"Allows to retrieve the holding details of the portfolio","summary":"Allows to retrieve the holding details of the portfolio","tags":["WEALTH"],"parameters":[{"name":"portfolioId","in":"path","type":"string","required":true,"description":"Id of the portfolio or security account"},{"name":"onlineUpdate","in":"query","type":"string","required":false,"description":"The valuation for the portfolio will be done online if this flag is set to 'Y'"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"PortfolioHoldingsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/portfolios/{portfolioId}/facilities","fullPath":"/api/v4.0.0/holdings/portfolios/{portfolioId}/facilities","operationId":"getPortfolioFacilities","name":"Retrieves credit facilities available for a portfolio","summary":"Retrieves credit facilities available for a portfolio","tags":["WEALTH"],"parameters":[{"name":"portfolioId","in":"path","type":"string","required":true,"description":"Id of the portfolio or security account"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"PortfolioFacilitiesResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"POST","path":"/holdings/portfolios/facilities","fullPath":"/api/v4.0.0/holdings/portfolios/facilities","operationId":"createPortfolioFacility","name":"Creates credit facility for a porftolio","summary":"Creates credit facility for a porftolio","tags":["WEALTH"],"parameters":[{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"facilityDetails":[{}],"documentTypes":[{}],"collaterals":[{}],"customerId":"string","portfolioId":"string","facilityProduct":"string","openingDate":"string","closingDate":"string","reviewDate":"string","uniqueTransactionReference":"string","currency":"string","amount":"string","collateralType":"string","collateralCodeId":"string","collateralId":"string"}},"responses":{"200":"PortfolioFacilityResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/holdings/portfolios/facilities/{facilityId}","fullPath":"/api/v4.0.0/holdings/portfolios/facilities/{facilityId}","operationId":"getPortfolioFacility","name":"Retrieves the credit facility of the portfolio","summary":"Retrieves the credit facility of the portfolio","tags":["WEALTH"],"parameters":[{"name":"facilityId","in":"path","type":"string","required":true,"description":"Unique identifier (contract number) of the facility"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"PortfolioFacilityResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/holdings/portfolios/facilities/{facilityId}","fullPath":"/api/v4.0.0/holdings/portfolios/facilities/{facilityId}","operationId":"updatePortfolioFacility","name":"Updates the credit facility of the portfolio","summary":"Updates the credit facility of the portfolio","tags":["WEALTH"],"parameters":[{"name":"facilityId","in":"path","type":"string","required":true,"description":"Unique identifier (contract number) of the facility"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"facilityDetails":[{}],"documentTypes":[{}],"collaterals":[{}],"customerId":"string","portfolioId":"string","facilityProduct":"string","openingDate":"string","closingDate":"string","reviewDate":"string","uniqueTransactionReference":"string","currency":"string","amount":"string","collateralType":"string","collateralCodeId":"string","collateralId":"string"}},"responses":{"200":"PortfolioFacilityResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/holdings/portfolios/{portfolioId}/availableNominals","fullPath":"/api/v4.0.0/holdings/portfolios/{portfolioId}/availableNominals","operationId":"getPortfolioAvailableNominals","name":"Retrieves the available nominals to pledge as collateral for each security position of a portfolio","summary":"Retrieves the available nominals to pledge as collateral for each security position of a portfolio","tags":["WEALTH"],"parameters":[{"name":"portfolioId","in":"path","type":"string","required":true,"description":"Id of the portfolio or security account"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"PortfolioAvailableNominalsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/portfolios/{portfolioId}/availablePositions","fullPath":"/api/v4.0.0/holdings/portfolios/{portfolioId}/availablePositions","operationId":"getPortfolioAvailablePositions","name":"Retrieves the available positions of each asset of a portfolio to pledge as collateral","summary":"Retrieves the available positions of each asset of a portfolio to pledge as collateral","tags":["WEALTH"],"parameters":[{"name":"portfolioId","in":"path","type":"string","required":true,"description":"Id of the portfolio or security account"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"PortfolioAvailablePositionsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/portfolios/{portfolioId}/assetAllocations","fullPath":"/api/v4.0.0/holdings/portfolios/{portfolioId}/assetAllocations","operationId":"getPortfolioDetails","name":"Allows to retrieve asset allocations and cash balance of the portfolio","summary":"Allows to retrieve asset allocations and cash balance of the portfolio","tags":["WEALTH"],"parameters":[{"name":"portfolioId","in":"path","type":"string","required":true,"description":"Id of the portfolio or security account"},{"name":"onlineUpdate","in":"query","type":"string","required":false,"description":"The valuation for the portfolio will be done online if this flag is set to 'Y'"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"PortfolioDetailsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/portfolios/{portfolioId}","fullPath":"/api/v4.0.0/holdings/portfolios/{portfolioId}","operationId":"getPortfolio","name":"Retrieves information about the customer's portfolio","summary":"Retrieve portfolio information","tags":["WEALTH"],"parameters":[{"name":"portfolioId","in":"path","type":"string","required":true,"description":"Id of the portfolio or security account"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"PortfolioResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"POST","path":"/holdings/portfolios/{portfolioId}","fullPath":"/api/v4.0.0/holdings/portfolios/{portfolioId}","operationId":"createPortfolio","name":"Creates a new portfolio for a securities customer","summary":"Create a new portfolio for a customer","tags":["WEALTH"],"parameters":[{"name":"portfolioId","in":"path","type":"string","required":true,"description":"Id of the portfolio or security account"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"accountIds":[{}],"jointHolder":[{}],"depoDetails":[{}],"customerId":"string","referenceCurrency":"string","valuationCurrency":"string","portfolioName":"string","accountOfficer":"string","investmentProgram":"string","managedAccount":"string","safekeepChargeAccount":"string","startDate":"2024-01-01","memoAccount":"string","marginAllowed":"string","portfolioFees":"string"}},"responses":{"200":"PortfolioResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/holdings/portfolios/{portfolioId}","fullPath":"/api/v4.0.0/holdings/portfolios/{portfolioId}","operationId":"updatePortfolio","name":"Update details about the customer's portfolio","summary":"Updates the customer's portfolio","tags":["WEALTH"],"parameters":[{"name":"portfolioId","in":"path","type":"string","required":true,"description":"Id of the portfolio or security account"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"accountIds":[{}],"jointHolder":[{}],"depoDetails":[{}],"customerId":"string","referenceCurrency":"string","valuationCurrency":"string","portfolioName":"string","accountOfficer":"string","investmentProgram":"string","managedAccount":"string","safekeepChargeAccount":"string","startDate":"2024-01-01","memoAccount":"string","marginAllowed":"string","portfolioFees":"string"}},"responses":{"200":"PortfolioResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"DELETE","path":"/holdings/portfolios/{portfolioId}","fullPath":"/api/v4.0.0/holdings/portfolios/{portfolioId}","operationId":"reversePortfolio","name":"Reverses the portfolio that does not have positions","summary":"Reverses the portfolio","tags":["WEALTH"],"parameters":[{"name":"portfolioId","in":"path","type":"string","required":true,"description":""},{"name":"payload","in":"body","type":"object","required":false,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}}},"responses":{"200":"PortfolioResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/holdings/portfolios/{portfolioId}/accountRemovals","fullPath":"/api/v4.0.0/holdings/portfolios/{portfolioId}/accountRemovals","operationId":"updatePortfolioDelinkAccount","name":"Allows to delink an account from the portfolio","summary":"Allows to delink an account","tags":["WEALTH"],"parameters":[{"name":"portfolioId","in":"path","type":"string","required":true,"description":"Id of the portfolio or security account"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"accountIds":[{}],"jointHolder":[{}],"customerId":0.0,"referenceCurrency":"string","valuationCurrency":"string","portfolioName":"string","accountOfficer":0.0,"investmentProgram":0.0,"managedAccount":0.0,"safekeepChargeAccount":"string","currencyId":"string","startDate":"2024-01-01","closureDate":"2024-01-01","marginAllowed":"string","portfolioFees":"string"}},"responses":{"200":"PortfolioDelinkAccountResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/holdings/portfolios/{portfolioId}/portfolioClosures","fullPath":"/api/v4.0.0/holdings/portfolios/{portfolioId}/portfolioClosures","operationId":"updatePortfolioClosure","name":"Updates the closure date for a portfolio","summary":"Updates the closure date","tags":["WEALTH"],"parameters":[{"name":"portfolioId","in":"path","type":"string","required":true,"description":"Id of the portfolio or security account"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"accountIds":[{}],"jointHolder":[{}],"customerId":0.0,"referenceCurrency":"string","valuationCurrency":"string","portfolioName":"string","accountOfficer":0.0,"investmentProgram":0.0,"managedAccount":0.0,"safekeepChargeAccount":"string","currencyId":"string","startDate":"2024-01-01","closureDate":"2024-01-01","marginAllowed":"string","portfolioFees":"string"}},"responses":{"200":"PortfolioClosureResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}}]},{"key":"holdings-position-service-v1.0.0-v1.0.0","title":"Treasury positions","version":"v1.0.0","description":"API to retrieve position information from different transactions affecting cash flows, interest rate mismatches, foreign exchange positions along with mark to market revaluation, profit/loss resulting from changes in the market value of the currency and arranges them into different time buckets as c","endpointCount":3,"endpoints":[{"method":"GET","path":"/holdings/treasury/positions/cash","fullPath":"/api/v1.0.0/holdings/treasury/positions/cash","operationId":"getTreasuryCashPosition","name":"Retrieves information from different transactions affecting the cash inflow/outflow, along with the projected cashflow data and arranges them into different time buckets as configured by the institution.","summary":"Retrieves cash inflow and outflow positions","tags":[],"parameters":[{"name":"currency","in":"query","type":"string","required":true,"description":"Identifies the currency. E.g. USD, GBP etc"},{"name":"dealerDesk","in":"query","type":"string","required":false,"description":"The dealer/desk responsible for monitoring and managing the currency positions."},{"name":"currencyMarket","in":"query","type":"string","required":false,"description":"Identifies the currency market to be used to get the correct exchange and revaluation rates to be applied to each currency"},{"name":"calendar","in":"query","type":"string","required":false,"description":"Identifies the calendar to be used for the spreading of different position data into different time buckets. Ex: CAL-Standard calendar and DE1-Deutsche calendar"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from t24 on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"The identifier of the underlying Entity/Company/Branch."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"TreasuryCashPositionResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/treasury/positions/gap","fullPath":"/api/v1.0.0/holdings/treasury/positions/gap","operationId":"getTreasuryGapPosition","name":"Retrieves interest rate mismatch resulting from different transactions across all the applications, it arranges them into different time buckets as configured by the respective institution and also provides a breakeven interest rate to close the gap","summary":"Retrieves interest rate mismatch position","tags":[],"parameters":[{"name":"currency","in":"query","type":"string","required":true,"description":"Identifies the currency. E.g. USD, GBP etc"},{"name":"dealerDesk","in":"query","type":"string","required":false,"description":"The dealer/desk responsible for monitoring and managing the currency positions."},{"name":"currencyMarket","in":"query","type":"string","required":false,"description":"Identifies the currency market to be used to get the correct exchange and revaluation rates to be applied to each currency"},{"name":"calendar","in":"query","type":"string","required":false,"description":"Identifies the calendar to be used for the spreading of different position data into different time buckets. Ex: CAL-Standard calendar and DE1-Deutsche calendar"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from t24 on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"The identifier of the underlying Entity/Company/Branch."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"TreasuryGapPositionResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/treasury/positions/forexRevaluations","fullPath":"/api/v1.0.0/holdings/treasury/positions/forexRevaluations","operationId":"getForexRevaluationPositions","name":"Retrieves mark to market foreign currency positions(arranged into time buckets) detailing the daily unrealised profit/loss resulting from changes in the market value of the currency from spot date to settlement date.","summary":"Retrieves the mark to market revaluation of foreign exchange positions.","tags":[],"parameters":[{"name":"currency","in":"query","type":"string","required":false,"description":"Identifies the currency. E.g. USD, GBP etc"},{"name":"currencyMarket","in":"query","type":"string","required":false,"description":"Identifies the currency market to be used to get the correct exchange and revaluation rates to be applied to each currency"},{"name":"dealerDesk","in":"query","type":"string","required":false,"description":"The dealer/desk responsible for monitoring and managing the currency positions."},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from t24 on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"The identifier of the underlying Entity/Company/Branch."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"ForexRevaluationPositionsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}}]},{"key":"holdings-position-service-v2.0.0","title":"Treasury positions","version":"v2.0.0","description":"API to retrieve position information from different transactions affecting cash flows, interest rate mismatches, foreign exchange positions along with mark to market revaluation, profit/loss resulting from changes in the market value of the currency and arranges them into different time buckets as c","endpointCount":4,"endpoints":[{"method":"GET","path":"/holdings/treasury/positions/cash","fullPath":"/api/v2.0.0/holdings/treasury/positions/cash","operationId":"getTreasuryCashPosition","name":"Retrieves information from different transactions affecting the cash inflow/outflow, along with the projected cashflow data and arranges them into different time buckets as configured by the institution.","summary":"Retrieves cash inflow and outflow positions","tags":[],"parameters":[{"name":"currency","in":"query","type":"string","required":true,"description":"Identifies the currency. E.g. USD, GBP etc"},{"name":"dealerDesk","in":"query","type":"string","required":false,"description":"The dealer/desk responsible for monitoring and managing the currency positions."},{"name":"currencyMarket","in":"query","type":"string","required":false,"description":"Identifies the currency market to be used to get the correct exchange and revaluation rates to be applied to each currency"},{"name":"calendar","in":"query","type":"string","required":false,"description":"Identifies the calendar to be used for the spreading of different position data into different time buckets. Ex: CAL-Standard calendar and DE1-Deutsche calendar"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from t24 on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"TreasuryCashPositionResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/treasury/positions/gap","fullPath":"/api/v2.0.0/holdings/treasury/positions/gap","operationId":"getTreasuryGapPosition","name":"Retrieves interest rate mismatch resulting from different transactions across all the applications, it arranges them into different time buckets as configured by the respective institution and also provides a breakeven interest rate to close the gap","summary":"Retrieves interest rate mismatch position","tags":[],"parameters":[{"name":"currency","in":"query","type":"string","required":true,"description":"Identifies the currency. E.g. USD, GBP etc"},{"name":"dealerDesk","in":"query","type":"string","required":false,"description":"The dealer/desk responsible for monitoring and managing the currency positions."},{"name":"currencyMarket","in":"query","type":"string","required":false,"description":"Identifies the currency market to be used to get the correct exchange and revaluation rates to be applied to each currency"},{"name":"calendar","in":"query","type":"string","required":false,"description":"Identifies the calendar to be used for the spreading of different position data into different time buckets. Ex: CAL-Standard calendar and DE1-Deutsche calendar"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from t24 on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"TreasuryGapPositionResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/treasury/positions/forexRevaluations","fullPath":"/api/v2.0.0/holdings/treasury/positions/forexRevaluations","operationId":"getForexRevaluationPositions","name":"Retrieves mark to market foreign currency positions(arranged into time buckets) detailing the daily unrealised profit/loss resulting from changes in the market value of the currency from spot date to settlement date.","summary":"Retrieves the mark to market revaluation of foreign exchange positions.","tags":[],"parameters":[{"name":"currency","in":"query","type":"string","required":false,"description":"Identifies the currency. E.g. USD, GBP etc"},{"name":"currencyMarket","in":"query","type":"string","required":false,"description":"Identifies the currency market to be used to get the correct exchange and revaluation rates to be applied to each currency"},{"name":"dealerDesk","in":"query","type":"string","required":false,"description":"The dealer/desk responsible for monitoring and managing the currency positions."},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from t24 on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"ForexRevaluationPositionsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/treasury/transactions/{transactionId}","fullPath":"/api/v2.0.0/holdings/treasury/transactions/{transactionId}","operationId":"getTreasuryTransactionDetails","name":"Retrieves transaction details responsible for daily cash flow, interest rate mismatch and foreign currency positions. This also calculates the daily total of all the transaction amounts, which represents the aggregate of the daily activities.","summary":"Retrieves transaction details resulting daily cash flow, interest rate mismatch and foreign currency positions.","tags":[],"parameters":[{"name":"transactionId","in":"path","type":"string","required":true,"description":"Unique transaction identifier for retrieving the details of the transaction. For example: FT0102030333 etc."},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from t24 on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"TreasuryTransactionDetailsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}}]},{"key":"holdings-products-service-v1.0.0","title":"Holdings Products APIs","version":"v1.0.0","description":"Management of Holdings Products","endpointCount":2,"endpoints":[{"method":"POST","path":"/holdings/products","fullPath":"/api/v1.0.0/holdings/products","operationId":"createProduct","name":"This API is deprecated.Going forward,use the URL:/holdings/deposits/termDeposits","summary":"","tags":[],"parameters":[{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"query","type":"string","required":false,"description":""},{"name":"companyId","in":"query","type":"string","required":false,"description":""}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"customerIds":[{}],"properties":[{}],"overrides":[{}],"productId":"string","masterArrangementId":"string","roleName":"string","currencyId":"string","effectiveDate":"2024-01-01","activityId":"string","transactionAmount":0.0,"account":{"alternateIds":{},"accountType":{},"accountName":{},"accountId":{},"portfolioId":{},"anniversary":{},"customerReference":{}},"balance":{"alternateIds":{},"accountType":{},"accountName":{},"accountId":{},"portfolioId":{},"anniversary":{},"customerReference":{}},"customer":{"customers":{},"jointLiability":{}},"schedule":{"payment":{},"amortisationTerm":{},"residualAmount":{},"billsCombined":{},"recalcFrequency":{}},"settlement":{"settlement":{},"assocSettlement":{},"payout":{},"paymentType":{},"defaultSettlementAccount":{}}}},"responses":{"200":"createProductResponse","default":"ArrangementErrorResponse"}},{"method":"PUT","path":"/holdings/products/{arrangementId}","fullPath":"/api/v1.0.0/holdings/products/{arrangementId}","operationId":"updateProduct","name":"This API is deprecated as it is an invalid endpoint","summary":"","tags":[],"parameters":[{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"query","type":"string","required":false,"description":""},{"name":"companyId","in":"query","type":"string","required":false,"description":""},{"name":"arrangementId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"customerIds":[{}],"properties":[{}],"overrides":[{}],"productId":"string","masterArrangementId":"string","roleName":"string","currencyId":"string","effectiveDate":"2024-01-01","activityId":"string","transactionAmount":0.0,"account":{"alternateIds":{},"accountType":{},"accountName":{},"accountId":{},"portfolioId":{},"anniversary":{},"customerReference":{}},"balance":{"alternateIds":{},"accountType":{},"accountName":{},"accountId":{},"portfolioId":{},"anniversary":{},"customerReference":{}},"customer":{"customers":{},"jointLiability":{}},"schedule":{"payment":{},"amortisationTerm":{},"residualAmount":{},"billsCombined":{},"recalcFrequency":{}},"settlement":{"settlement":{},"assocSettlement":{},"payout":{},"paymentType":{},"defaultSettlementAccount":{}}}},"responses":{"200":"updateProductResponse","default":"ArrangementErrorResponse"}}]},{"key":"holdings-reports-service-v1.0.0","title":"Treasury reports","version":"v1.0.0","description":"API to retrieve the key details of all the live trades captured from various treasury related applications such as Forex, Money Market, Swap, Forward Rate Agreement, Securities and other derivative deal capture applications. Segregates the currency positions in the different time buckets as configur","endpointCount":5,"endpoints":[{"method":"GET","path":"/holdings/reports/treasuryProfitability","fullPath":"/api/v1.0.0/holdings/reports/treasuryProfitability","operationId":"getProfitabilityReport","name":"Retrieves the realized and unrealised mark to market details(profit/loss) displayed according to the configuration done by the institution","summary":"Retrieves the realized and unrealised mark to market details","tags":[],"parameters":[{"name":"dealer","in":"query","type":"string","required":false,"description":"The dealer/desk responsible for monitoring and managing the currency position "},{"name":"groupId","in":"query","type":"string","required":false,"description":"Unique ID of the group"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from t24 on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"ProfitabilityReportResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/reports/treasuryCurrencyCalendarPositions","fullPath":"/api/v1.0.0/holdings/reports/treasuryCurrencyCalendarPositions","operationId":"getCurrencyCalendarPositionsReport","name":"Retrieves the position details(long/short) for all the currencies in different calenders","summary":"Retrieves the position details for all the currencies in different calenders","tags":[],"parameters":[{"name":"currency","in":"query","type":"string","required":false,"description":"Identifies the currency. E.g. USD, GBP etc"},{"name":"company","in":"query","type":"string","required":false,"description":"The company code"},{"name":"positionType","in":"query","type":"string","required":false,"description":"Identifies the position type. Possible values are CAS(cash position), GAP(Interest mismatch position), FXP(Foreign exchange position)"},{"name":"dealerDesk","in":"query","type":"string","required":false,"description":"The dealer/desk responsible for monitoring and managing the currency positions."},{"name":"valueDate","in":"query","type":"string","required":false,"description":"Indicates the value date on which the underlying accounting entry is to be given value (for interest purposes)"},{"name":"valueDateFrom","in":"query","type":"string","required":false,"description":"Contains the from value of value date to be specified in a range."},{"name":"valueDateTo","in":"query","type":"string","required":false,"description":"Contains the to value of value date to be specified in a range."},{"name":"dealDate","in":"query","type":"string","required":false,"description":"Date on which the deal was agreed. "},{"name":"period","in":"query","type":"string","required":false,"description":"Indicates spread of time buckets.Ex: 3M,6M,9M,10Y etc."},{"name":"calendar","in":"query","type":"string","required":false,"description":"Identifies the calendar to be used for the spreading of different position data into different time buckets. Ex: CAL-Standard calendar and DE1-Deutsche calendar"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from t24 on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"CurrencyCalendarPositionsReportResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/reports/treasuryBlotter","fullPath":"/api/v1.0.0/holdings/reports/treasuryBlotter","operationId":"getBlotterReport","name":"Retrieves details on all open deals across various treasury products","summary":"Retrieves all the active(open) deals","tags":[],"parameters":[{"name":"contractId","in":"query","type":"string","required":false,"description":"Indicates the unique identifier of the transaction or contract which initiated the activity"},{"name":"counterpartyId","in":"query","type":"string","required":false,"description":"The identifier of the counter party"},{"name":"counterpartyName","in":"query","type":"string","required":false,"description":"The counterparty name for the forex deal."},{"name":"dealType","in":"query","type":"string","required":false,"description":"Foreign Exchange deal type. Allowed values: - SP(spot) - FW(forward) - SW(Swap)"},{"name":"dealSubType","in":"query","type":"string","required":false,"description":"Under a deal type, there can be further sub deal types. E.g. Broker and Internal are sub deal types for FX spot and forward deal types."},{"name":"buyAmount","in":"query","type":"string","required":false,"description":"Amount bought in the FX deal."},{"name":"buyAmountFrom","in":"query","type":"string","required":false,"description":"Contains the from value of buy amount to be specified in a range."},{"name":"buyAmountTo","in":"query","type":"string","required":false,"description":"Contains the to value of buy amount to be specified in a range."},{"name":"buyCurrency","in":"query","type":"string","required":false,"description":"ISO Currency code for the bought currency.  "},{"name":"buyRate","in":"query","type":"string","required":false,"description":"The exchange rate at which is currency is bought."},{"name":"buyRateFrom","in":"query","type":"string","required":false,"description":"Contains the from value of buy rate to be specified in a range."},{"name":"buyRateTo","in":"query","type":"string","required":false,"description":"Contains the to value of buy rate to be specified in a range."},{"name":"sellAmount","in":"query","type":"string","required":false,"description":"Amount sold in the FX deal."},{"name":"sellAmountFrom","in":"query","type":"string","required":false,"description":"Contains the from value of sell amount to be specified in a range."},{"name":"sellAmountTo","in":"query","type":"string","required":false,"description":"Contains the to value of sell amount to be specified in a range."},{"name":"sellCurrency","in":"query","type":"string","required":false,"description":"ISO Currency code for the sold currency.  "},{"name":"sellRate","in":"query","type":"string","required":false,"description":"The exchange rate at which is currency is sold."},{"name":"sellRateFrom","in":"query","type":"string","required":false,"description":"Contains the from value of sell rate to be specified in a range."},{"name":"sellRateTo","in":"query","type":"string","required":false,"description":"Contains the to value of sell rate to be specified in a range."},{"name":"valueDate","in":"query","type":"string","required":false,"description":"Indicates the value date on which the underlying accounting entry is to be given value (for interest purposes)"},{"name":"valueDateFrom","in":"query","type":"string","required":false,"description":"Contains the from value of value date to be specified in a range."},{"name":"valueDateTo","in":"query","type":"string","required":false,"description":"Contains the to value of value date to be specified in a range."},{"name":"reutersDealId","in":"query","type":"string","required":false,"description":"The Reuters deal reference number, if the deal is booked on Reuters dealing platform."},{"name":"maturityDate","in":"query","type":"string","required":false,"description":"Indicates maturity date of the contract"},{"name":"maturityDateFrom","in":"query","type":"string","required":false,"description":"Contains the from value of maturity date to be specified in a range."},{"name":"maturityDateTo","in":"query","type":"string","required":false,"description":"Contains the to value of maturity date to be specified in a range."},{"name":"dealDate","in":"query","type":"string","required":false,"description":"Date on which the deal was agreed. "},{"name":"dealDateFrom","in":"query","type":"string","required":false,"description":"Date on which the deal was agreed. "},{"name":"dealDateTo","in":"query","type":"string","required":false,"description":"Date on which the deal was agreed. "},{"name":"instrument","in":"query","type":"string","required":false,"description":"The instrument identifier"},{"name":"issuedBy","in":"query","type":"string","required":false,"description":"The issuer of a security or a bond."},{"name":"portfolio","in":"query","type":"string","required":false,"description":"Id of the portfolio (security account), which the arrangement (account, deposit, loan, etc.) is attached to."},{"name":"depository","in":"query","type":"string","required":false,"description":"Person designated as depository by the company in or pursuant to this Indenture, and, unless otherwise provided with respect to any security, any successor to such person"},{"name":"inputter","in":"query","type":"string","required":false,"description":"The user identifier who input the transaction"},{"name":"broker","in":"query","type":"string","required":false,"description":"Broker involved in the transaction"},{"name":"method","in":"query","type":"string","required":false,"description":"A pricing plan can be applied to an account, the selection is automatic or manual"},{"name":"dealerDesk","in":"query","type":"string","required":false,"description":"The dealer/desk responsible for monitoring and managing the currency positions."},{"name":"internalDealerDesk","in":"query","type":"string","required":false,"description":"One of the dealer/desk for an internal deal between two dealer/desks."},{"name":"displayName","in":"query","type":"string","required":false,"description":"Contains the name used for display or enrichment purposes"},{"name":"orderStatus","in":"query","type":"string","required":false,"description":"Status of the order."},{"name":"buyOrSell","in":"query","type":"string","required":false,"description":"Whether the transaction is a buy or a sell."},{"name":"recordStatus","in":"query","type":"string","required":false,"description":"General status of the record. Possible values: - null - authorised - IHLD - input, on hold - INAU - input, not authorised - INA2 - input, authorised, pending second authorisation - INAO - input, not a"},{"name":"contractStatus","in":"query","type":"string","required":false,"description":"Status of the contract, e.g. open, matured or liquidated."},{"name":"dateTime","in":"query","type":"string","required":false,"description":"Contains the date and time separated by '-'"},{"name":"dateTimeFrom","in":"query","type":"string","required":false,"description":"Contains the from value of date and time to be specified in a range."},{"name":"dateTimeTo","in":"query","type":"string","required":false,"description":"Contains the to value of date and time to be specified in a range."},{"name":"fixingExerciseDate","in":"query","type":"string","required":false,"description":"Fixing or Exercise Date for FRA deal."},{"name":"fixingExerciseDateFrom","in":"query","type":"string","required":false,"description":"Contains the from value of fixing or exercise date to be specified in a range."},{"name":"fixingExerciseDateTo","in":"query","type":"string","required":false,"description":"Contains the to value of fixing or exercise date to be specified in a range."},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from t24 on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"BlotterReportResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/treasury/moneyMarkets/events","fullPath":"/api/v1.0.0/holdings/treasury/moneyMarkets/events","operationId":"getMoneyMarketEventsToDate","name":"Retrieves the informaton on events processed till date for money market deals like Principal payment, contract initiation, interest payment etc.","summary":"Retrieves all events till date of money market deals.","tags":[],"parameters":[{"name":"contractId","in":"query","type":"string","required":false,"description":"Indicates the unique identifier of the transaction or contract which initiated the activity"},{"name":"transactionDate","in":"query","type":"string","required":false,"description":"Contains the date on which the deal was booked."},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from t24 on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"MoneyMarketEventsToDateResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/treasury/forex","fullPath":"/api/v1.0.0/holdings/treasury/forex","operationId":"getOutstandingForexDealsToday","name":"Retrieves the foreign exchange outstanding(active) deals as on today.","summary":"Retrieves all the foreign exchange active deals as on today","tags":[],"parameters":[{"name":"dealType","in":"query","type":"string","required":false,"description":"Foreign Exchange deal type. Allowed values: - SP(spot) - FW(forward) - SW(Swap)"},{"name":"counterparty","in":"query","type":"string","required":false,"description":"The counterparty ID  for the  deal."},{"name":"transactionReference","in":"query","type":"string","required":false,"description":"Contains the identifier for the transaction in the core system"},{"name":"swapReference","in":"query","type":"string","required":false,"description":"As the near and far leg of the swap have separate reference number, the swap reference is the near leg reference in the far leg and far leg reference in the near leg of a FX swap deal."},{"name":"settlementDateSell","in":"query","type":"string","required":false,"description":"Settlement date for sell side."},{"name":"settlementDateBuy","in":"query","type":"string","required":false,"description":"Settlement date for buy side."},{"name":"buyCurrency","in":"query","type":"string","required":false,"description":"ISO Currency code for the bought currency.  "},{"name":"buyAmount","in":"query","type":"string","required":false,"description":"Amount bought in the FX deal."},{"name":"sellCurrency","in":"query","type":"string","required":false,"description":"ISO Currency code for the sold currency.  "},{"name":"sellAmount","in":"query","type":"string","required":false,"description":"Amount sold in the FX deal."},{"name":"dealDate","in":"query","type":"string","required":false,"description":"Date on which the deal was agreed. "},{"name":"ourAccountPay","in":"query","type":"string","required":false,"description":"Account from which payment is  made."},{"name":"ourAccountRecieve","in":"query","type":"string","required":false,"description":"Account from which payment is received."},{"name":"dealerDesk","in":"query","type":"string","required":false,"description":"The dealer/desk responsible for monitoring and managing the currency positions."},{"name":"unevenSwap","in":"query","type":"string","required":false,"description":"Identifier for a FX uneven swap  (the swap base currency amount in near and far leg are not the same)."},{"name":"forwardForwardSwap","in":"query","type":"string","required":false,"description":"A FX swap where both the near and the far leg have a value date greater than spot value date."},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from t24 on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"OutstandingForexDealsTodayResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}}]},{"key":"holdings-reports-service-v1.0.1","title":"Treasury reports","version":"v1.0.1","description":"API to retrieve the key details of all the live trades captured from various treasury related applications such as Forex, Money Market, Swap, Forward Rate Agreement, Securities and other derivative deal capture applications. Segregates the currency positions in the different time buckets as configur","endpointCount":5,"endpoints":[{"method":"GET","path":"/holdings/reports/treasuryProfitability","fullPath":"/api/v1.0.1/holdings/reports/treasuryProfitability","operationId":"getProfitabilityReport","name":"Retrieves the realized and unrealised mark to market details(profit/loss) displayed according to the configuration done by the institution","summary":"Retrieves the realized and unrealised mark to market details","tags":[],"parameters":[{"name":"dealer","in":"query","type":"string","required":false,"description":"The dealer/desk responsible for monitoring and managing the currency position "},{"name":"groupId","in":"query","type":"string","required":false,"description":"Unique ID of the group"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from t24 on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"ProfitabilityReportResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/reports/treasuryCurrencyCalendarPositions","fullPath":"/api/v1.0.1/holdings/reports/treasuryCurrencyCalendarPositions","operationId":"getCurrencyCalendarPositionsReport","name":"Retrieves the position details(long/short) for all the currencies in different calenders","summary":"Retrieves the position details for all the currencies in different calenders","tags":[],"parameters":[{"name":"currency","in":"query","type":"string","required":false,"description":"Identifies the currency. E.g. USD, GBP etc"},{"name":"company","in":"query","type":"string","required":false,"description":"The company code"},{"name":"positionType","in":"query","type":"string","required":false,"description":"Identifies the position type. Possible values are CAS(cash position), GAP(Interest mismatch position), FXP(Foreign exchange position)"},{"name":"dealerDesk","in":"query","type":"string","required":false,"description":"The dealer/desk responsible for monitoring and managing the currency positions."},{"name":"valueDate","in":"query","type":"string","required":false,"description":"Indicates the value date on which the underlying accounting entry is to be given value (for interest purposes)"},{"name":"valueDateFrom","in":"query","type":"string","required":false,"description":"Contains the from value of value date to be specified in a range."},{"name":"valueDateTo","in":"query","type":"string","required":false,"description":"Contains the to value of value date to be specified in a range."},{"name":"dealDate","in":"query","type":"string","required":false,"description":"Date on which the deal was agreed. "},{"name":"period","in":"query","type":"string","required":false,"description":"Indicates spread of time buckets.Ex: 3M,6M,9M,10Y etc."},{"name":"calendar","in":"query","type":"string","required":false,"description":"Identifies the calendar to be used for the spreading of different position data into different time buckets. Ex: CAL-Standard calendar and DE1-Deutsche calendar"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from t24 on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"CurrencyCalendarPositionsReportResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/reports/treasuryBlotter","fullPath":"/api/v1.0.1/holdings/reports/treasuryBlotter","operationId":"getBlotterReport","name":"Retrieves details on all open deals across various treasury products","summary":"Retrieves all the active(open) deals","tags":[],"parameters":[{"name":"contractId","in":"query","type":"string","required":false,"description":"Indicates the unique identifier of the transaction or contract which initiated the activity"},{"name":"counterpartyId","in":"query","type":"string","required":false,"description":"The identifier of the counter party"},{"name":"counterpartyName","in":"query","type":"string","required":false,"description":"The counterparty name for the forex deal."},{"name":"dealType","in":"query","type":"string","required":false,"description":"Foreign Exchange deal type. Allowed values: - SP(spot) - FW(forward) - SW(Swap)"},{"name":"dealSubType","in":"query","type":"string","required":false,"description":"Under a deal type, there can be further sub deal types. E.g. Broker and Internal are sub deal types for FX spot and forward deal types."},{"name":"buyAmount","in":"query","type":"string","required":false,"description":"Amount bought in the FX deal."},{"name":"buyAmountFrom","in":"query","type":"string","required":false,"description":"Contains the from value of buy amount to be specified in a range."},{"name":"buyAmountTo","in":"query","type":"string","required":false,"description":"Contains the to value of buy amount to be specified in a range."},{"name":"buyCurrency","in":"query","type":"string","required":false,"description":"ISO Currency code for the bought currency.  "},{"name":"buyRate","in":"query","type":"string","required":false,"description":"The exchange rate at which is currency is bought."},{"name":"buyRateFrom","in":"query","type":"string","required":false,"description":"Contains the from value of buy rate to be specified in a range."},{"name":"buyRateTo","in":"query","type":"string","required":false,"description":"Contains the to value of buy rate to be specified in a range."},{"name":"sellAmount","in":"query","type":"string","required":false,"description":"Amount sold in the FX deal."},{"name":"sellAmountFrom","in":"query","type":"string","required":false,"description":"Contains the from value of sell amount to be specified in a range."},{"name":"sellAmountTo","in":"query","type":"string","required":false,"description":"Contains the to value of sell amount to be specified in a range."},{"name":"sellCurrency","in":"query","type":"string","required":false,"description":"ISO Currency code for the sold currency.  "},{"name":"sellRate","in":"query","type":"string","required":false,"description":"The exchange rate at which is currency is sold."},{"name":"sellRateFrom","in":"query","type":"string","required":false,"description":"Contains the from value of sell rate to be specified in a range."},{"name":"sellRateTo","in":"query","type":"string","required":false,"description":"Contains the to value of sell rate to be specified in a range."},{"name":"valueDate","in":"query","type":"string","required":false,"description":"Indicates the value date on which the underlying accounting entry is to be given value (for interest purposes)"},{"name":"valueDateFrom","in":"query","type":"string","required":false,"description":"Contains the from value of value date to be specified in a range."},{"name":"valueDateTo","in":"query","type":"string","required":false,"description":"Contains the to value of value date to be specified in a range."},{"name":"reutersDealId","in":"query","type":"string","required":false,"description":"The Reuters deal reference number, if the deal is booked on Reuters dealing platform."},{"name":"maturityDate","in":"query","type":"string","required":false,"description":"Indicates maturity date of the contract"},{"name":"maturityDateFrom","in":"query","type":"string","required":false,"description":"Contains the from value of maturity date to be specified in a range."},{"name":"maturityDateTo","in":"query","type":"string","required":false,"description":"Contains the to value of maturity date to be specified in a range."},{"name":"dealDate","in":"query","type":"string","required":false,"description":"Date on which the deal was agreed. "},{"name":"dealDateFrom","in":"query","type":"string","required":false,"description":"Date on which the deal was agreed. "},{"name":"dealDateTo","in":"query","type":"string","required":false,"description":"Date on which the deal was agreed. "},{"name":"instrument","in":"query","type":"string","required":false,"description":"The instrument identifier"},{"name":"issuedBy","in":"query","type":"string","required":false,"description":"The issuer of a security or a bond."},{"name":"portfolio","in":"query","type":"string","required":false,"description":"Id of the portfolio (security account), which the arrangement (account, deposit, loan, etc.) is attached to."},{"name":"depository","in":"query","type":"string","required":false,"description":"Person designated as depository by the company in or pursuant to this Indenture, and, unless otherwise provided with respect to any security, any successor to such person"},{"name":"inputter","in":"query","type":"string","required":false,"description":"The user identifier who input the transaction"},{"name":"broker","in":"query","type":"string","required":false,"description":"Broker involved in the transaction"},{"name":"method","in":"query","type":"string","required":false,"description":"A pricing plan can be applied to an account, the selection is automatic or manual"},{"name":"dealerDesk","in":"query","type":"string","required":false,"description":"The dealer/desk responsible for monitoring and managing the currency positions."},{"name":"internalDealerDesk","in":"query","type":"string","required":false,"description":"One of the dealer/desk for an internal deal between two dealer/desks."},{"name":"displayName","in":"query","type":"string","required":false,"description":"Contains the name used for display or enrichment purposes"},{"name":"orderStatus","in":"query","type":"string","required":false,"description":"Status of the order."},{"name":"buyOrSell","in":"query","type":"string","required":false,"description":"Whether the transaction is a buy or a sell."},{"name":"recordStatus","in":"query","type":"string","required":false,"description":"General status of the record. Possible values: - null - authorised - IHLD - input, on hold - INAU - input, not authorised - INA2 - input, authorised, pending second authorisation - INAO - input, not a"},{"name":"contractStatus","in":"query","type":"string","required":false,"description":"Status of the contract, e.g. open, matured or liquidated."},{"name":"dateTime","in":"query","type":"string","required":false,"description":"Contains the date and time separated by '-'"},{"name":"dateTimeFrom","in":"query","type":"string","required":false,"description":"Contains the from value of date and time to be specified in a range."},{"name":"dateTimeTo","in":"query","type":"string","required":false,"description":"Contains the to value of date and time to be specified in a range."},{"name":"fixingExerciseDate","in":"query","type":"string","required":false,"description":"Fixing or Exercise Date for FRA deal."},{"name":"fixingExerciseDateFrom","in":"query","type":"string","required":false,"description":"Contains the from value of fixing or exercise date to be specified in a range."},{"name":"fixingExerciseDateTo","in":"query","type":"string","required":false,"description":"Contains the to value of fixing or exercise date to be specified in a range."},{"name":"rateKey","in":"query","type":"string","required":false,"description":"Identifies the periodic interest key used in case of money market deals or on the asset side of swap contract."},{"name":"liabilityRateKey","in":"query","type":"string","required":false,"description":"Identifies the periodic interest key used on the liability side of swap contract."},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from t24 on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"BlotterReportResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/treasury/moneyMarkets/events","fullPath":"/api/v1.0.1/holdings/treasury/moneyMarkets/events","operationId":"getMoneyMarketEventsToDate","name":"Retrieves the informaton on events processed till date for money market deals like Principal payment, contract initiation, interest payment etc.","summary":"Retrieves all events till date of money market deals.","tags":[],"parameters":[{"name":"contractId","in":"query","type":"string","required":false,"description":"Indicates the unique identifier of the transaction or contract which initiated the activity"},{"name":"transactionDate","in":"query","type":"string","required":false,"description":"Contains the date on which the deal was booked."},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from t24 on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"MoneyMarketEventsToDateResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/treasury/forex","fullPath":"/api/v1.0.1/holdings/treasury/forex","operationId":"getOutstandingForexDealsToday","name":"Retrieves the foreign exchange outstanding(active) deals as on today.","summary":"Retrieves all the foreign exchange active deals as on today","tags":[],"parameters":[{"name":"dealType","in":"query","type":"string","required":false,"description":"Foreign Exchange deal type. Allowed values: - SP(spot) - FW(forward) - SW(Swap)"},{"name":"counterparty","in":"query","type":"string","required":false,"description":"The counterparty ID  for the  deal."},{"name":"transactionReference","in":"query","type":"string","required":false,"description":"Contains the identifier for the transaction in the core system"},{"name":"swapReference","in":"query","type":"string","required":false,"description":"As the near and far leg of the swap have separate reference number, the swap reference is the near leg reference in the far leg and far leg reference in the near leg of a FX swap deal."},{"name":"settlementDateSell","in":"query","type":"string","required":false,"description":"Settlement date for sell side."},{"name":"settlementDateBuy","in":"query","type":"string","required":false,"description":"Settlement date for buy side."},{"name":"buyCurrency","in":"query","type":"string","required":false,"description":"ISO Currency code for the bought currency.  "},{"name":"buyAmount","in":"query","type":"string","required":false,"description":"Amount bought in the FX deal."},{"name":"sellCurrency","in":"query","type":"string","required":false,"description":"ISO Currency code for the sold currency.  "},{"name":"sellAmount","in":"query","type":"string","required":false,"description":"Amount sold in the FX deal."},{"name":"dealDate","in":"query","type":"string","required":false,"description":"Date on which the deal was agreed. "},{"name":"ourAccountPay","in":"query","type":"string","required":false,"description":"Account from which payment is  made."},{"name":"ourAccountRecieve","in":"query","type":"string","required":false,"description":"Account from which payment is received."},{"name":"dealerDesk","in":"query","type":"string","required":false,"description":"The dealer/desk responsible for monitoring and managing the currency positions."},{"name":"unevenSwap","in":"query","type":"string","required":false,"description":"Identifier for a FX uneven swap  (the swap base currency amount in near and far leg are not the same)."},{"name":"forwardForwardSwap","in":"query","type":"string","required":false,"description":"A FX swap where both the near and the far leg have a value date greater than spot value date."},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from t24 on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"OutstandingForexDealsTodayResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}}]},{"key":"holdings-reports-service-v2.0.0","title":"Treasury reports","version":"v2.0.0","description":"API to retrieve the key details of all the live trades captured from various treasury related applications such as Forex, Money Market, Swap, Forward Rate Agreement, Securities and other derivative deal capture applications. Segregates the currency positions in the different time buckets as configur","endpointCount":5,"endpoints":[{"method":"GET","path":"/holdings/reports/treasuryProfitability","fullPath":"/api/v2.0.0/holdings/reports/treasuryProfitability","operationId":"getProfitabilityReport","name":"Retrieves the realized and unrealised mark to market details(profit/loss) displayed according to the configuration done by the institution","summary":"Retrieves the realized and unrealised mark to market details","tags":[],"parameters":[{"name":"dealer","in":"query","type":"string","required":false,"description":"The dealer/desk responsible for monitoring and managing the currency position "},{"name":"groupId","in":"query","type":"string","required":false,"description":"Unique ID of the group"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"ProfitabilityReportResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/reports/treasuryCurrencyCalendarPositions","fullPath":"/api/v2.0.0/holdings/reports/treasuryCurrencyCalendarPositions","operationId":"getCurrencyCalendarPositionsReport","name":"Retrieves the position details(long/short) for all the currencies in different calenders","summary":"Retrieves the position details for all the currencies in different calenders","tags":[],"parameters":[{"name":"currency","in":"query","type":"string","required":true,"description":"Identifies the currency. E.g. USD, GBP etc"},{"name":"company","in":"query","type":"string","required":false,"description":"The company code"},{"name":"positionType","in":"query","type":"string","required":false,"description":"Identifies the position type. Possible values are CAS(cash position), GAP(Interest mismatch position), FXP(Foreign exchange position)"},{"name":"dealerDesk","in":"query","type":"string","required":false,"description":"The dealer/desk responsible for monitoring and managing the currency positions."},{"name":"valueDate","in":"query","type":"string","required":false,"description":"Indicates the value date on which the underlying accounting entry is to be given value (for interest purposes)"},{"name":"valueDateFrom","in":"query","type":"string","required":false,"description":"Contains the from value of value date to be specified in a range."},{"name":"valueDateTo","in":"query","type":"string","required":false,"description":"Contains the to value of value date to be specified in a range."},{"name":"dealDate","in":"query","type":"string","required":false,"description":"Date on which the deal was agreed. "},{"name":"period","in":"query","type":"string","required":false,"description":"Indicates spread of time buckets.Ex: 3M,6M,9M,10Y etc."},{"name":"calendar","in":"query","type":"string","required":true,"description":"Identifies the calendar to be used for the spreading of different position data into different time buckets. Ex: CAL-Standard calendar and DE1-Deutsche calendar"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"CurrencyCalendarPositionsReportResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/treasury/moneyMarkets/events","fullPath":"/api/v2.0.0/holdings/treasury/moneyMarkets/events","operationId":"getMoneyMarketEventsToDate","name":"Retrieves the informaton on events processed till date for money market deals like Principal payment, contract initiation, interest payment etc.","summary":"Retrieves all events till date of money market deals.","tags":[],"parameters":[{"name":"contractId","in":"query","type":"string","required":false,"description":"Indicates the unique identifier of the transaction or contract which initiated the activity"},{"name":"transactionDate","in":"query","type":"string","required":false,"description":"Contains the date on which the deal was booked."},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"MoneyMarketEventsToDateResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/treasury/forex","fullPath":"/api/v2.0.0/holdings/treasury/forex","operationId":"getOutstandingForexDealsToday","name":"Retrieves the foreign exchange outstanding(active) deals as on today.","summary":"Retrieves all the foreign exchange active deals as on today","tags":[],"parameters":[{"name":"dealType","in":"query","type":"string","required":false,"description":"Foreign Exchange deal type. Allowed values: - SP(spot) - FW(forward) - SW(Swap)"},{"name":"counterparty","in":"query","type":"string","required":false,"description":"The counterparty ID  for the  deal."},{"name":"transactionReference","in":"query","type":"string","required":false,"description":"Contains the identifier for the transaction in the core system"},{"name":"swapReference","in":"query","type":"string","required":false,"description":"As the near and far leg of the swap have separate reference number, the swap reference is the near leg reference in the far leg and far leg reference in the near leg of a FX swap deal."},{"name":"settlementDateSell","in":"query","type":"string","required":false,"description":"Settlement date for sell side."},{"name":"settlementDateBuy","in":"query","type":"string","required":false,"description":"Settlement date for buy side."},{"name":"buyCurrency","in":"query","type":"string","required":false,"description":"ISO Currency code for the bought currency.  "},{"name":"buyAmount","in":"query","type":"string","required":false,"description":"Amount bought in the FX deal."},{"name":"sellCurrency","in":"query","type":"string","required":false,"description":"ISO Currency code for the sold currency.  "},{"name":"sellAmount","in":"query","type":"string","required":false,"description":"Amount sold in the FX deal."},{"name":"dealDate","in":"query","type":"string","required":false,"description":"Date on which the deal was agreed. "},{"name":"ourAccountPay","in":"query","type":"string","required":false,"description":"Account from which payment is  made."},{"name":"ourAccountRecieve","in":"query","type":"string","required":false,"description":"Account from which payment is received."},{"name":"dealerDesk","in":"query","type":"string","required":false,"description":"The dealer/desk responsible for monitoring and managing the currency positions."},{"name":"unevenSwap","in":"query","type":"string","required":false,"description":"Identifier for a FX uneven swap  (the swap base currency amount in near and far leg are not the same)."},{"name":"forwardForwardSwap","in":"query","type":"string","required":false,"description":"A FX swap where both the near and the far leg have a value date greater than spot value date."},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"OutstandingForexDealsTodayResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/reports/treasuryBlotter","fullPath":"/api/v2.0.0/holdings/reports/treasuryBlotter","operationId":"getBlotterReport","name":"Retrieves details on all open deals across various treasury products","summary":"Retrieves all the active(open) deals","tags":[],"parameters":[{"name":"contractId","in":"query","type":"string","required":false,"description":"Indicates the unique identifier of the transaction or contract which initiated the activity"},{"name":"counterpartyId","in":"query","type":"string","required":false,"description":"The identifier of the counter party"},{"name":"counterpartyName","in":"query","type":"string","required":false,"description":"The counterparty name for the forex deal."},{"name":"dealType","in":"query","type":"string","required":false,"description":"Foreign Exchange deal type. Allowed values: - SP(spot) - FW(forward) - SW(Swap)"},{"name":"dealSubType","in":"query","type":"string","required":false,"description":"Under a deal type, there can be further sub deal types. E.g. Broker and Internal are sub deal types for FX spot and forward deal types."},{"name":"buyAmount","in":"query","type":"string","required":false,"description":"Amount bought in the FX deal."},{"name":"buyAmountFrom","in":"query","type":"string","required":false,"description":"Contains the from value of buy amount to be specified in a range."},{"name":"buyAmountTo","in":"query","type":"string","required":false,"description":"Contains the to value of buy amount to be specified in a range."},{"name":"buyCurrency","in":"query","type":"string","required":false,"description":"ISO Currency code for the bought currency.  "},{"name":"buyRate","in":"query","type":"string","required":false,"description":"The exchange rate at which is currency is bought."},{"name":"buyRateFrom","in":"query","type":"string","required":false,"description":"Contains the from value of buy rate to be specified in a range."},{"name":"buyRateTo","in":"query","type":"string","required":false,"description":"Contains the to value of buy rate to be specified in a range."},{"name":"sellAmount","in":"query","type":"string","required":false,"description":"Amount sold in the FX deal."},{"name":"sellAmountFrom","in":"query","type":"string","required":false,"description":"Contains the from value of sell amount to be specified in a range."},{"name":"sellAmountTo","in":"query","type":"string","required":false,"description":"Contains the to value of sell amount to be specified in a range."},{"name":"sellCurrency","in":"query","type":"string","required":false,"description":"ISO Currency code for the sold currency.  "},{"name":"sellRate","in":"query","type":"string","required":false,"description":"The exchange rate at which is currency is sold."},{"name":"sellRateFrom","in":"query","type":"string","required":false,"description":"Contains the from value of sell rate to be specified in a range."},{"name":"sellRateTo","in":"query","type":"string","required":false,"description":"Contains the to value of sell rate to be specified in a range."},{"name":"valueDate","in":"query","type":"string","required":false,"description":"Indicates the value date on which the underlying accounting entry is to be given value (for interest purposes)"},{"name":"valueDateFrom","in":"query","type":"string","required":false,"description":"Contains the from value of value date to be specified in a range."},{"name":"valueDateTo","in":"query","type":"string","required":false,"description":"Contains the to value of value date to be specified in a range."},{"name":"reutersDealId","in":"query","type":"string","required":false,"description":"The Reuters deal reference number, if the deal is booked on Reuters dealing platform."},{"name":"maturityDate","in":"query","type":"string","required":false,"description":"Indicates maturity date of the contract"},{"name":"maturityDateFrom","in":"query","type":"string","required":false,"description":"Contains the from value of maturity date to be specified in a range."},{"name":"maturityDateTo","in":"query","type":"string","required":false,"description":"Contains the to value of maturity date to be specified in a range."},{"name":"dealDate","in":"query","type":"string","required":false,"description":"Date on which the deal was agreed. "},{"name":"dealDateFrom","in":"query","type":"string","required":false,"description":"Date on which the deal was agreed. "},{"name":"dealDateTo","in":"query","type":"string","required":false,"description":"Date on which the deal was agreed. "},{"name":"instrument","in":"query","type":"string","required":false,"description":"The instrument identifier"},{"name":"issuedBy","in":"query","type":"string","required":false,"description":"The issuer of a security or a bond."},{"name":"portfolio","in":"query","type":"string","required":false,"description":"Id of the portfolio (security account), which the arrangement (account, deposit, loan, etc.) is attached to."},{"name":"depository","in":"query","type":"string","required":false,"description":"Person designated as depository by the company in or pursuant to this Indenture, and, unless otherwise provided with respect to any security, any successor to such person"},{"name":"inputter","in":"query","type":"string","required":false,"description":"The user identifier who input the transaction"},{"name":"broker","in":"query","type":"string","required":false,"description":"Broker involved in the transaction"},{"name":"method","in":"query","type":"string","required":false,"description":"A pricing plan can be applied to an account, the selection is automatic or manual"},{"name":"dealerDesk","in":"query","type":"string","required":false,"description":"The dealer/desk responsible for monitoring and managing the currency positions."},{"name":"internalDealerDesk","in":"query","type":"string","required":false,"description":"One of the dealer/desk for an internal deal between two dealer/desks."},{"name":"displayName","in":"query","type":"string","required":false,"description":"Contains the name used for display or enrichment purposes"},{"name":"orderStatus","in":"query","type":"string","required":false,"description":"Status of the order."},{"name":"buyOrSell","in":"query","type":"string","required":false,"description":"Whether the transaction is a buy or a sell."},{"name":"recordStatus","in":"query","type":"string","required":false,"description":"General status of the record. Possible values: - null - authorised - IHLD - input, on hold - INAU - input, not authorised - INA2 - input, authorised, pending second authorisation - INAO - input, not a"},{"name":"contractStatus","in":"query","type":"string","required":false,"description":"Status of the contract, e.g. open, matured or liquidated."},{"name":"dateTime","in":"query","type":"string","required":false,"description":"Contains the date and time separated by '-'"},{"name":"dateTimeFrom","in":"query","type":"string","required":false,"description":"Contains the from value of date and time to be specified in a range."},{"name":"dateTimeTo","in":"query","type":"string","required":false,"description":"Contains the to value of date and time to be specified in a range."},{"name":"fixingExerciseDate","in":"query","type":"string","required":false,"description":"Fixing or Exercise Date for FRA deal."},{"name":"fixingExerciseDateFrom","in":"query","type":"string","required":false,"description":"Contains the from value of fixing or exercise date to be specified in a range."},{"name":"fixingExerciseDateTo","in":"query","type":"string","required":false,"description":"Contains the to value of fixing or exercise date to be specified in a range."},{"name":"whatIf","in":"query","type":"string","required":false,"description":"A flag to indicate a what if contract, for portfolio management"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"BlotterReportResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}}]},{"key":"holdings-repurchaseAgreements-service-v1.0.0","title":"Repurchase Agreements","version":"v1.0.0","description":"Allows to view the REPO/RESO positions and position movements","endpointCount":4,"endpoints":[{"method":"GET","path":"/holdings/instruments/repurchaseAgreements/positions","fullPath":"/api/v1.0.0/holdings/instruments/repurchaseAgreements/positions","operationId":"getREPOPosition","name":"Allows to view the Repurchase Agreement Position details which can be filtered by positionId/portfolioId/instrumentId/depositoryId/quantity to view the specific details","summary":"Allows to view the Repurchase Agreement Positions","tags":[],"parameters":[{"name":"positionId","in":"query","type":"string","required":false,"description":"Key or Identifier of the Portfolio Position"},{"name":"portfolioId","in":"query","type":"string","required":false,"description":"Identifier of the portfolio or security account"},{"name":"instrumentId","in":"query","type":"string","required":false,"description":"The identifier of the instrument"},{"name":"depositoryId","in":"query","type":"string","required":false,"description":"Id of the securities depository."},{"name":"quantity","in":"query","type":"string","required":false,"description":"The nominal quantity"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from t24 on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":""},{"name":"companyId","in":"header","type":"string","required":false,"description":""}],"requestBodyExample":null,"responses":{"200":"REPOPositionResponse","default":"QueryErrorResponse"}},{"method":"GET","path":"/holdings/instruments/reverseRepurchaseAgreements/positions","fullPath":"/api/v1.0.0/holdings/instruments/reverseRepurchaseAgreements/positions","operationId":"getRESOPosition","name":"Allows to view the Reverse Repurchase Agreement Position details which can be filtered by positionId/portfolioId/instrumentId/depositoryId/quantity to view the specific details","summary":"Allows to view the Reverse Repurchase Agreement Positions","tags":[],"parameters":[{"name":"positionId","in":"query","type":"string","required":false,"description":"Key or Identifier of the Portfolio Position"},{"name":"portfolioId","in":"query","type":"string","required":false,"description":"Id of the portfolio or security account"},{"name":"instrumentId","in":"query","type":"string","required":false,"description":"The identifier of the instrument"},{"name":"depositoryId","in":"query","type":"string","required":false,"description":"Id of the securities depository."},{"name":"quantity","in":"query","type":"string","required":false,"description":"The nominal quantity"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from t24 on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":""},{"name":"companyId","in":"header","type":"string","required":false,"description":""}],"requestBodyExample":null,"responses":{"200":"RESOPositionResponse","default":"QueryErrorResponse"}},{"method":"GET","path":"/holdings/instruments/repurchaseAgreements/positionMovements","fullPath":"/api/v1.0.0/holdings/instruments/repurchaseAgreements/positionMovements","operationId":"getREPOPositionMovements","name":"Allows to view the Repurchase Agreement Position Movements which can be filtered by positionId/portfolioId/instrumentId/depositoryId to view the specific details","summary":"Allows to view the Repurchase Agreement Position Movements","tags":[],"parameters":[{"name":"positionId","in":"query","type":"string","required":false,"description":"Key or Identifier of the Portfolio Position"},{"name":"portfolioId","in":"query","type":"string","required":false,"description":"Id of the portfolio or security account"},{"name":"instrumentId","in":"query","type":"string","required":false,"description":"The identifier of the instrument"},{"name":"depositoryId","in":"query","type":"string","required":false,"description":"Id of the securities depository."},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from t24 on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":""},{"name":"companyId","in":"header","type":"string","required":false,"description":""}],"requestBodyExample":null,"responses":{"200":"REPOPositionMovementsResponse","default":"QueryErrorResponse"}},{"method":"GET","path":"/holdings/instruments/reverseRepurchaseAgreements/positionMovements","fullPath":"/api/v1.0.0/holdings/instruments/reverseRepurchaseAgreements/positionMovements","operationId":"getRESOPositionMovements","name":"Allows to view the Reverse Repurchase Agreement Position Movements which can be filtered by positionId/portfolioId/instrumentId/depositoryId to view the specific details","summary":"Allows to view the Reverse Repurchase Agreement Position Movements","tags":[],"parameters":[{"name":"positionId","in":"query","type":"string","required":false,"description":"Key or Identifier of the Portfolio Position"},{"name":"portfolioId","in":"query","type":"string","required":false,"description":"Id of the portfolio or security account"},{"name":"instrumentId","in":"query","type":"string","required":false,"description":"The identifier of the instrument"},{"name":"depositoryId","in":"query","type":"string","required":false,"description":"Id of the securities depository."},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from t24 on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":""},{"name":"companyId","in":"header","type":"string","required":false,"description":""}],"requestBodyExample":null,"responses":{"200":"RESOPositionMovementsResponse","default":"QueryErrorResponse"}}]},{"key":"holdings-securityMovements-service-v1.0.0","title":"Security Movements","version":"v1.0.0","description":"Allows to view the Security Movements of the Portfolio","endpointCount":1,"endpoints":[{"method":"GET","path":"/holdings/securityMovements/portfolios/{portfolioId}","fullPath":"/api/v1.0.0/holdings/securityMovements/portfolios/{portfolioId}","operationId":"getSecurityMovementsByPortfolio","name":"Allows to view the Security Movements of the Portfolio which can be further filtered by referenceNumber/instrumentId","summary":"Allows to view the Security Movements of the Portfolio","tags":[],"parameters":[{"name":"portfolioId","in":"path","type":"string","required":true,"description":"Id of the portfolio or security account"},{"name":"referenceNumber","in":"query","type":"string","required":false,"description":"Reference Numbers"},{"name":"instrumentId","in":"query","type":"string","required":false,"description":"The identifier of the instrument"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from t24 on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":""},{"name":"companyId","in":"header","type":"string","required":false,"description":""}],"requestBodyExample":null,"responses":{"200":"SecurityMovementsByPortfolioResponse","default":"QueryErrorResponse"}}]},{"key":"holdings-securityMovements-service-v1.0.1","title":"Security Movements","version":"v1.0.1","description":"Allows to view the security movements of the portfolio","endpointCount":1,"endpoints":[{"method":"GET","path":"/holdings/securityMovements/portfolios/{portfolioId}","fullPath":"/api/v1.0.1/holdings/securityMovements/portfolios/{portfolioId}","operationId":"getSecurityMovementsByPortfolio","name":"Allows to view the security movements of the portfolio which can be further filtered by referenceNumber or instrumentId","summary":"Allows to view the security movements of the portfolio","tags":[],"parameters":[{"name":"portfolioId","in":"path","type":"string","required":true,"description":"Id of the portfolio or security account"},{"name":"referenceNumber","in":"query","type":"string","required":false,"description":"Specifies the reference for the document, if any."},{"name":"instrumentId","in":"query","type":"string","required":false,"description":"The identifier of the instrument"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"SecurityMovementsByPortfolioResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}}]},{"key":"holdings-securityPositions-service-v1.0.0","title":"Security Positions","version":"v1.0.0","description":"Allows to retrieve Security Position details","endpointCount":6,"endpoints":[{"method":"GET","path":"/holdings/portfolios/transactions","fullPath":"/api/v1.0.0/v1.0.0/holdings/portfolios/transactions","operationId":"getPortfoliosTransactions","name":"Retrieves the security position details based on the security, portfolio and transaction reference","summary":"Retrieves the security position details","tags":[],"parameters":[{"name":"securityNumber","in":"query","type":"string","required":false,"description":"Security Numbers"},{"name":"securityAccount","in":"query","type":"string","required":false,"description":"Security Accounts"},{"name":"referenceNumber","in":"query","type":"string","required":false,"description":"Reference Numbers"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from t24 on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":""},{"name":"companyId","in":"header","type":"string","required":false,"description":""}],"requestBodyExample":null,"responses":{"200":"PortfoliosTransactionsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/securityInventoryPositions","fullPath":"/api/v1.0.0/v1.0.0/holdings/securityInventoryPositions","operationId":"getSecurityInventoryPositions","name":"Retrieves the security position details for own book portfolios based on instrument id","summary":"Retrieves the security position details for own book portfolios","tags":[],"parameters":[{"name":"instrumentId","in":"query","type":"string","required":false,"description":"The identifier of the instrument"},{"name":"dealerBook","in":"query","type":"string","required":false,"description":"Dealer Book"},{"name":"securityCode","in":"query","type":"string","required":false,"description":"Security Code"},{"name":"currentPosition","in":"query","type":"string","required":false,"description":"Current Positions"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from t24 on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":""},{"name":"companyId","in":"header","type":"string","required":false,"description":""}],"requestBodyExample":null,"responses":{"200":"SecurityInventoryPositionsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/portfolios/{portfolioId}/transactions","fullPath":"/api/v1.0.0/v1.0.0/holdings/portfolios/{portfolioId}/transactions","operationId":"getPortfolioTransactions","name":"Retrieves the security position details based on the security, portfolio and transaction reference","summary":"Retrieves the security position details","tags":[],"parameters":[{"name":"portfolioId","in":"path","type":"string","required":true,"description":""},{"name":"securityNumber","in":"query","type":"string","required":false,"description":"Security Numbers"},{"name":"securityAccount","in":"query","type":"string","required":false,"description":"Security Accounts"},{"name":"referenceNumber","in":"query","type":"string","required":false,"description":"Reference Numbers"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from t24 on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":""},{"name":"companyId","in":"header","type":"string","required":false,"description":""}],"requestBodyExample":null,"responses":{"200":"PortfolioTransactionsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/instruments/{instrumentId}/positions","fullPath":"/api/v1.0.0/v1.0.0/holdings/instruments/{instrumentId}/positions","operationId":"getInstrumentPositions","name":"Retrieves the position information for the legal entities own book portfolios","summary":"Retrieves the position information","tags":[],"parameters":[{"name":"instrumentId","in":"path","type":"string","required":true,"description":"The identifier of the instrument"},{"name":"portfolioId","in":"query","type":"string","required":false,"description":"Id of the portfolio or security account"},{"name":"depository","in":"query","type":"string","required":false,"description":"The custodian where securities are held"},{"name":"subAccount","in":"query","type":"string","required":false,"description":"The sub-account that the security position is held in."},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from t24 on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":""},{"name":"companyId","in":"header","type":"string","required":false,"description":""}],"requestBodyExample":null,"responses":{"200":"InstrumentPositionsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/portfolios/{portfolioId}/positions","fullPath":"/api/v1.0.0/v1.0.0/holdings/portfolios/{portfolioId}/positions","operationId":"getPortfolioSecurityPositions","name":"Retrieves the position information of a portfolio","summary":"Retrieves the position information","tags":[],"parameters":[{"name":"portfolioId","in":"path","type":"string","required":true,"description":"Id of the portfolio or security account"},{"name":"instrumentId","in":"query","type":"string","required":false,"description":"The identifier of the instrument"},{"name":"depository","in":"query","type":"string","required":false,"description":"The custodian where securities are held"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from t24 on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":""},{"name":"companyId","in":"header","type":"string","required":false,"description":""}],"requestBodyExample":null,"responses":{"200":"PortfolioSecurityPositionsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/holdings/securityMovements/portfolios/{portfolioId}","fullPath":"/api/v1.0.0/v1.0.0/holdings/holdings/securityMovements/portfolios/{portfolioId}","operationId":"getSecurityMovementsByPortfolio","name":"Allows to view the Security Movements of the Portfolio which can be further filtered by referenceNumber/instrumentId","summary":"Allows to view the Security Movements of the Portfolio","tags":[],"parameters":[{"name":"portfolioId","in":"path","type":"string","required":true,"description":"Id of the portfolio or security account"},{"name":"referenceNumber","in":"query","type":"string","required":false,"description":"Specifies the reference for the document, if any."},{"name":"instrumentId","in":"query","type":"string","required":false,"description":"The identifier of the instrument"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from t24 on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"SecurityMovementsByPortfolioResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}}]},{"key":"holdings-securityTrades-service-v1.0.0","title":"Security Trades","version":"v1.0.0","description":"Allows to view the security trade details","endpointCount":1,"endpoints":[{"method":"GET","path":"/holdings/securityTrades/{securityTradeId}","fullPath":"/api/v1.0.0/holdings/securityTrades/{securityTradeId}","operationId":"getSecurityTrades","name":"Allows to view the security trade details along with the delivery message information","summary":"Allows to view the security trade details","tags":[],"parameters":[{"name":"securityTradeId","in":"path","type":"string","required":true,"description":"Identifier of the Security Trade"},{"name":"customerId","in":"query","type":"string","required":false,"description":"Identifier of the customer"},{"name":"instrumentId","in":"query","type":"string","required":false,"description":"The identifier of the instrument"},{"name":"depositoryId","in":"query","type":"string","required":false,"description":"Id of the securities depository."},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from t24 on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"The identifier of the underlying Entity/Company/Branch."}],"requestBodyExample":null,"responses":{"200":"SecurityTradesResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}}]},{"key":"holdings-securityTrades-service-v1.1.0","title":"Security Trades","version":"v1.1.0","description":"Allows to view the security trade details","endpointCount":3,"endpoints":[{"method":"GET","path":"/holdings/securityTrades/{securityTradeId}","fullPath":"/api/v1.1.0/holdings/securityTrades/{securityTradeId}","operationId":"getSecurityTrades","name":"Retrieves the details of security trade transaction which includes the fees, taxes and the applicable delivery messages.","summary":"Retrieves the details of security trade transaction","tags":[],"parameters":[{"name":"securityTradeId","in":"path","type":"string","required":true,"description":"Identifier of the Security Trade"},{"name":"customerId","in":"query","type":"string","required":false,"description":"Identifier of the customer"},{"name":"instrumentId","in":"query","type":"string","required":false,"description":"The identifier of the instrument"},{"name":"depositoryId","in":"query","type":"string","required":false,"description":"Id of the securities depository."},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"SecurityTradesResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"PUT","path":"/holdings/securityTrades/{securityTradeId}","fullPath":"/api/v1.1.0/holdings/securityTrades/{securityTradeId}","operationId":"updateSecurityTrades","name":"Update security trades","summary":"Update security trades","tags":[],"parameters":[{"name":"securityTradeId","in":"path","type":"string","required":true,"description":""},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"customerDetails":[{}],"brokerDetails":[{}],"brokerNumberNominalDetails":[{}],"overrideDetails":[{}],"securityCode":"string","instrumentCurrencyId":"string","priceType":"string","depository":"string","tradeDate":"string","valueDate":"string","tradeCurrency":"string","stockExchange":"string","exchangeRateSecurity":"string","exchangeRateTrade":"string","holdCashSettlement":"string"}},"responses":{"200":"SecurityTradesResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"POST","path":"/holdings/securityTrades/","fullPath":"/api/v1.1.0/holdings/securityTrades/","operationId":"createSecurityTrades","name":"Create security trades","summary":"Create security trades","tags":[],"parameters":[{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"customerDetails":[{}],"brokerDetails":[{}],"brokerNumberNominalDetails":[{}],"overrideDetails":[{}],"securityCode":"string","instrumentCurrencyId":"string","priceType":"string","depository":"string","tradeDate":"string","valueDate":"string","tradeCurrency":"string","stockExchange":"string","exchangeRateSecurity":"string","exchangeRateTrade":"string","holdCashSettlement":"string"}},"responses":{"200":"SecurityTradesResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}}]},{"key":"holdings-securityTrades-service-v2.0.0","title":"Security Trades","version":"v2.0.0","description":"Allows to view the security trade details","endpointCount":3,"endpoints":[{"method":"GET","path":"/holdings/securityTrades/{securityTradeId}","fullPath":"/api/v2.0.0/holdings/securityTrades/{securityTradeId}","operationId":"getSecurityTrades","name":"Retrieves the details of security trade transaction which includes the fees, taxes and the applicable delivery messages.","summary":"Retrieves the details of security trade transaction","tags":["WEALTH"],"parameters":[{"name":"securityTradeId","in":"path","type":"string","required":true,"description":"Identifier of the Security Trade"},{"name":"customerId","in":"query","type":"string","required":false,"description":"Identifier of the customer"},{"name":"instrumentId","in":"query","type":"string","required":false,"description":"The identifier of the instrument"},{"name":"depositoryId","in":"query","type":"string","required":false,"description":"Id of the securities depository."},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"SecurityTradesResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"PUT","path":"/holdings/securityTrades/{securityTradeId}","fullPath":"/api/v2.0.0/holdings/securityTrades/{securityTradeId}","operationId":"updateSecurityTrades","name":"Update security trades","summary":"Update security trades","tags":["WEALTH"],"parameters":[{"name":"securityTradeId","in":"path","type":"string","required":true,"description":""},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"customerDetails":[{}],"brokerDetails":[{}],"brokerNumberNominalDetails":[{}],"overrideDetails":[{}],"securityCode":"string","instrumentCurrencyId":"string","priceType":"string","depository":"string","tradeDate":"string","valueDate":"string","tradeCurrency":"string","stockExchange":"string","exchangeRateSecurity":"string","exchangeRateTrade":"string","holdCashSettlement":"string"}},"responses":{"200":"SecurityTradesResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"POST","path":"/holdings/securityTrades/","fullPath":"/api/v2.0.0/holdings/securityTrades/","operationId":"createSecurityTrades","name":"Create security trades","summary":"Create security trades","tags":["WEALTH"],"parameters":[{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"customerDetails":[{}],"brokerDetails":[{}],"brokerNumberNominalDetails":[{}],"overrideDetails":[{}],"securityCode":"string","instrumentCurrencyId":"string","priceType":"string","depository":"string","tradeDate":"string","valueDate":"string","tradeCurrency":"string","stockExchange":"string","exchangeRateSecurity":"string","exchangeRateTrade":"string","holdCashSettlement":"string"}},"responses":{"200":"SecurityTradesResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}}]},{"key":"holdings-service-v1.0.0","title":"List of all holdings","version":"v1.0.0","description":"Retrieves all the Holdings","endpointCount":2,"endpoints":[{"method":"GET","path":"/holdings/","fullPath":"/api/v1.0.0/holdings/","operationId":"getHoldings","name":"Retrieves the list of customer holdings details, Such as AA Accounts, loans and deposits.","summary":"Retrieves the list of product(Current/Saving/Loan/Deposit) details","tags":[],"parameters":[{"name":"customerId","in":"query","type":"string","required":false,"description":"Identifier of the customer"},{"name":"holdingsType","in":"query","type":"string","required":false,"description":"Contains the types of customer holdings"},{"name":"holdingsId","in":"query","type":"string","required":false,"description":"Contains the identifier specific to the holding details of the customer"},{"name":"getPreferredHoldings","in":"query","type":"string","required":false,"description":"Flag to fetch the preferred holding details (JWT required)"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"HoldingsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/customers/{customerId}/holdings","fullPath":"/api/v1.0.0/holdings/customers/{customerId}/holdings","operationId":"getCustomerHoldings","name":"Retrieves the list of customer holdings","summary":"Retrieves the list of customer accounts","tags":[],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"Identifier of the customer"},{"name":"holdingsType","in":"query","type":"string","required":false,"description":"Contains the types of customer holdings"},{"name":"holdingsId","in":"query","type":"string","required":false,"description":"Contains the identifier specific to the holding details of the customer"},{"name":"getPreferredHoldings","in":"query","type":"string","required":false,"description":"Flag to fetch the preferred holding details (JWT required)"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"CustomerHoldingsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}}]},{"key":"holdings-service-v2.0.0","title":"List of all holdings","version":"v2.0.0","description":"Retrieves all the Holdings","endpointCount":2,"endpoints":[{"method":"GET","path":"/holdings/customers/{customerId}/holdings","fullPath":"/api/v1.0.0/holdings/customers/{customerId}/holdings","operationId":"getCustomerHoldings","name":"Retrieves the list of customer holdings","summary":"Retrieves the list of customer accounts","tags":[],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"Identifier of the customer"},{"name":"holdingsType","in":"query","type":"string","required":false,"description":"Contains the types of customer holdings"},{"name":"holdingsId","in":"query","type":"string","required":false,"description":"Contains the identifier specific to the holding details of the customer"},{"name":"getPreferredHoldings","in":"query","type":"string","required":false,"description":"Flag to fetch the preferred holding details (JWT required)"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"","default":"","400":"","500":""}},{"method":"GET","path":"/holdings/","fullPath":"/api/v1.0.0/holdings/","operationId":"getHoldings","name":"Retrieves the list of customer holdings details, such as AA Accounts, loans and deposits.","summary":"Retrieves the list of product(Current/Saving/Loan/Deposit) details","tags":[],"parameters":[{"name":"customerId","in":"query","type":"string","required":false,"description":"Identifier of the customer"},{"name":"holdingsType","in":"query","type":"string","required":false,"description":"Contains the types of customer holdings"},{"name":"holdingsId","in":"query","type":"string","required":false,"description":"Contains the identifier specific to the holding details of the customer"},{"name":"getPreferredHoldings","in":"query","type":"string","required":false,"description":"Flag to fetch the preferred holding details (JWT required)"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"","default":"","400":"","500":""}}]},{"key":"holdings-service-v3.0.0","title":"List of all holdings","version":"v3.0.0","description":"Retrieves all the Holdings","endpointCount":2,"endpoints":[{"method":"GET","path":"/holdings/customers/{customerId}/holdings","fullPath":"/api/v1.0.0/holdings/customers/{customerId}/holdings","operationId":"getCustomerHoldings","name":"Retrieves the list of customer holdings","summary":"Retrieves the list of customer accounts","tags":[],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"Identifier of the customer"},{"name":"holdingsType","in":"query","type":"string","required":false,"description":"Contains the types of customer holdings"},{"name":"holdingsId","in":"query","type":"string","required":false,"description":"Contains the identifier specific to the holding details of the customer"},{"name":"getPreferredHoldings","in":"query","type":"string","required":false,"description":"Flag to fetch the preferred holding details (JWT required)"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"","default":"","400":"","500":""}},{"method":"GET","path":"/holdings/","fullPath":"/api/v1.0.0/holdings/","operationId":"getHoldings","name":"Retrieves the list of customer holdings details, such as accounts, loans and deposits.","summary":"Retrieves the list of product(Current/Saving/Loan/Deposit) details","tags":[],"parameters":[{"name":"customerId","in":"query","type":"string","required":false,"description":"Identifier of the customer"},{"name":"holdingsType","in":"query","type":"string","required":false,"description":"Contains the types of customer holdings"},{"name":"holdingsId","in":"query","type":"string","required":false,"description":"Contains the identifier specific to the holding details of the customer"},{"name":"getPreferredHoldings","in":"query","type":"string","required":false,"description":"Flag to fetch the preferred holding details (JWT required)"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"","default":"","400":"","500":""}}]},{"key":"holdings-simulationCapture-service-v1.0.0","title":"Holdings Simulation Capture APIs","version":"v1.0.0","description":"Management of Simulation Capture","endpointCount":1,"endpoints":[{"method":"POST","path":"/holdings/simulationCapture/{arrangementId}","fullPath":"/api/v1.0.0/holdings/simulationCapture/{arrangementId}","operationId":"createSimulationCapture","name":"This API is deprecated","summary":"","tags":[],"parameters":[{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"query","type":"string","required":false,"description":""},{"name":"companyId","in":"query","type":"string","required":false,"description":""},{"name":"arrangementId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"closureNotes":[{}],"activityId":"string","automaticRun":"string","simulationRunReference":"string","effectiveDate":"2024-01-01","currencyId":"string","transactionAmount":0.0,"closureReason":"string","payoff":{"amount":{},"expiryDays":{},"settleDues":{},"percentage":{},"action":{}},"settlement":{"settlement":{},"assocSettlement":{},"payout":{},"paymentType":{},"defaultSettlementAccount":{}}}},"responses":{"200":"createSimulationCaptureResponse","default":"ArrangementErrorResponse"}}]},{"key":"holdings-swapNPVRevaluation-service-v1.0.0","title":"Treasury interest rate swap revaluation","version":"v1.0.0","description":"API to retrieve the cash flow details of the interest rate swap contracts and calculates the present value of both asset leg and liability leg cash flows. In case of cross currency swap contracts this API calculates the currency wise daily profit/loss incurred from the NPV revaluation based on the d","endpointCount":3,"endpoints":[{"method":"GET","path":"/holdings/treasury/swaps/NPV/revaluations","fullPath":"/api/v1.0.0/holdings/treasury/swaps/NPV/revaluations","operationId":"getSwapNPVRevaluations","name":"Retrieves the currency wise daily profit/loss details of swap contract resulting from NPV revaluation based on the discount rate provided.","summary":"Retrieves the currency wise daily profit/loss details for net present value method of revaluation.","tags":[],"parameters":[{"name":"currency","in":"query","type":"string","required":false,"description":"Identifies the currency. E.g. USD, GBP etc"},{"name":"discountRate","in":"query","type":"string","required":false,"description":"The rate used to discount a future cash flow. "},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from t24 on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"The identifier of the underlying Entity/Company/Branch."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"SwapNPVRevaluationsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/treasury/swaps/NPV","fullPath":"/api/v1.0.0/holdings/treasury/swaps/NPV","operationId":"getSwapNPVDetails","name":"Retrieves cash flow details for selected swap contract and calculates the present value for both asset leg and liability leg.","summary":"Retrieves cash flow details for selected swap contract and calculates the present value total cash flow.","tags":[],"parameters":[{"name":"contractId","in":"query","type":"string","required":false,"description":"Identifies the unique identifier of the transaction or contract."},{"name":"discountRate","in":"query","type":"string","required":false,"description":"The rate used to discount a future cash flow. "},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from t24 on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"The identifier of the underlying Entity/Company/Branch."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"SwapNPVDetailsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/treasury/swaps/NPV/currencies/revaluations","fullPath":"/api/v1.0.0/holdings/treasury/swaps/NPV/currencies/revaluations","operationId":"getSwapNPVCurrencyRevaluations","name":"Retrieves the present value of asset leg and liability leg of cross currency interest rate swap contracts and calculates the daily profit and loss based on the discount rate provided.","summary":"Retrieves the present value of cross currency interest rate swap contracts and calculates the daily profit and loss.","tags":[],"parameters":[{"name":"currency","in":"query","type":"string","required":false,"description":"Identifies the currency. E.g. USD, GBP etc"},{"name":"discountRate","in":"query","type":"string","required":false,"description":"The rate used to discount a future cash flow. "},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from t24 on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"The identifier of the underlying Entity/Company/Branch."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"SwapNPVCurrencyRevaluationsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}}]},{"key":"holdings-synchronizationerror-v1.0.0","title":"Holdings Synchronization Error","version":"v1.0.0","description":"Synchronization error in an account","endpointCount":1,"endpoints":[{"method":"PUT","path":"/holdings/accounts/{accountId}/synchronizationError","fullPath":"/api/v1.0.0/holdings/accounts/{accountId}/synchronizationError","operationId":"updateSynchronizationError","name":"Updates error occurred during Synchronization of account.Refer the same URI from the holdings-accounts-service-v4.0.0 swagger group","summary":"Synchronization error update.","tags":[],"parameters":[{"name":"accountId","in":"path","type":"string","required":true,"description":""},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"emergencyBlockError":"string"}},"responses":{"200":"SynchronizationErrorResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}}]},{"key":"holdings-transactions-service-v1.0.0","title":"Holdings Transactions APIs","version":"v1.0.0","description":"Get Holdings Transactions Details","endpointCount":3,"endpoints":[{"method":"GET","path":"/holdings/transactions/{transactionId}","fullPath":"/api/v1.0.0/holdings/transactions/{transactionId}","operationId":"getTransactionDetails","name":"","summary":"","tags":[],"parameters":[{"name":"transactionId","in":"path","type":"string","required":true,"description":"The unique transaction identifier"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from t24 on every enquiry request."},{"name":"credentials","in":"query","type":"string","required":false,"description":""},{"name":"companyId","in":"query","type":"string","required":false,"description":""}],"requestBodyExample":null,"responses":{"200":"TransactionDetailsResponse","default":"QueryErrorResponse"}},{"method":"GET","path":"/holdings/transactions/{transactionReference}/transactions","fullPath":"/api/v1.0.0/holdings/transactions/{transactionReference}/transactions","operationId":"getStatementForTransaction","name":"","summary":"","tags":[],"parameters":[{"name":"transactionReference","in":"path","type":"string","required":true,"description":"The transaction reference identifier"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from t24 on every enquiry request."},{"name":"credentials","in":"query","type":"string","required":false,"description":""},{"name":"companyId","in":"query","type":"string","required":false,"description":""}],"requestBodyExample":null,"responses":{"200":"StatementForTransactionResponse","default":"QueryErrorResponse"}},{"method":"GET","path":"/holdings/transactions","fullPath":"/api/v1.0.0/holdings/transactions","operationId":"getAccountTransactions","name":"","summary":"","tags":[],"parameters":[{"name":"accountId","in":"query","type":"string","required":false,"description":"The identifier of the account. Often referred to as the account number, yet for consistency this is always referred to as accountId."},{"name":"customerId","in":"query","type":"string","required":false,"description":"The identifier of the customer"},{"name":"listType","in":"query","type":"string","required":false,"description":""},{"name":"transactionCount","in":"query","type":"string","required":false,"description":""},{"name":"payType","in":"query","type":"string","required":false,"description":""},{"name":"dateFrom","in":"query","type":"string","required":false,"description":"Payment schedule from date"},{"name":"dateTo","in":"query","type":"string","required":false,"description":"Payment schedule to date"},{"name":"minimumAmount","in":"query","type":"string","required":false,"description":""},{"name":"maximumAmount","in":"query","type":"string","required":false,"description":""},{"name":"displayName","in":"query","type":"string","required":false,"description":"The name used for display purposes"},{"name":"transactionCode","in":"query","type":"string","required":false,"description":""},{"name":"statementReference","in":"query","type":"string","required":false,"description":""},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from t24 on every enquiry request."},{"name":"credentials","in":"query","type":"string","required":false,"description":""},{"name":"companyId","in":"query","type":"string","required":false,"description":""}],"requestBodyExample":null,"responses":{"200":"AccountTransactionsResponse","default":"QueryErrorResponse"}}]},{"key":"holdings-transactions-service-v2.0.0","title":"Transaction details","version":"v2.0.0","description":"API to retrieve account transactions and accounting entries","endpointCount":3,"endpoints":[{"method":"GET","path":"/holdings/transactions/{transactionId}","fullPath":"/api/v2.0.0/holdings/transactions/{transactionId}","operationId":"getTransactionDetails","name":"Retrieves the details of a transaction","summary":"Retrieves transaction details","tags":[],"parameters":[{"name":"transactionId","in":"path","type":"string","required":true,"description":"Unique transaction identifier for retrieving the details of the transaction. For example: FT0102030333 etc."},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from t24 on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"TransactionDetailsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/transactions/{transactionReference}/transactions","fullPath":"/api/v2.0.0/holdings/transactions/{transactionReference}/transactions","operationId":"getStatementForTransaction","name":"Retrieves the details of accounting entries","summary":"Retrieves accounting entries","tags":[],"parameters":[{"name":"transactionReference","in":"path","type":"string","required":true,"description":"Contains the identifier for the transaction in the core system"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from t24 on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"StatementForTransactionResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/transactions","fullPath":"/api/v2.0.0/holdings/transactions","operationId":"getAccountTransactions","name":"Retrieves the details of account transaction","summary":"Retrieves account transaction","tags":[],"parameters":[{"name":"accountId","in":"query","type":"string","required":false,"description":"Identifier of the account. Often referred to as the account number, yet for consistency this is always referred to as accountId. Accepts both IBAN & BBAN"},{"name":"customerId","in":"query","type":"string","required":false,"description":"Identifier of the customer"},{"name":"listType","in":"query","type":"string","required":false,"description":"Specifies the transaction Method(RECENT,COMPLETED,PENDING,SEARCH)"},{"name":"transactionCount","in":"query","type":"string","required":false,"description":"Specifies the number of transaction to be shown"},{"name":"payType","in":"query","type":"string","required":false,"description":"Indicates the identifier of payment types for  letter of credit."},{"name":"dateFrom","in":"query","type":"string","required":false,"description":"Start date of the loan"},{"name":"dateTo","in":"query","type":"string","required":false,"description":"End date of the loan"},{"name":"minimumAmount","in":"query","type":"string","required":false,"description":"The minimum account balance required."},{"name":"maximumAmount","in":"query","type":"string","required":false,"description":"The maximum account balance allowed."},{"name":"displayName","in":"query","type":"string","required":false,"description":"Contains the name used for display or enrichment purposes"},{"name":"transactionCode","in":"query","type":"string","required":false,"description":"Identifies the system internal transaction code applicable to the transaction"},{"name":"entryReference","in":"query","type":"string","required":false,"description":"It is the transaction reference. This is the identifier of the transaction on Temenos Core Banking system."},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from t24 on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"AccountTransactionsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}}]},{"key":"holdings-transactions-service-v2.1.0","title":"Transaction details","version":"v2.1.0","description":"API to retrieve account transactions and accounting entries","endpointCount":3,"endpoints":[{"method":"GET","path":"/holdings/transactions/{transactionId}","fullPath":"/api/v2.1.0/holdings/transactions/{transactionId}","operationId":"getTransactionDetails","name":"Retrieves the details of a transaction","summary":"Retrieves transaction details","tags":[],"parameters":[{"name":"transactionId","in":"path","type":"string","required":true,"description":"Unique transaction identifier for retrieving the details of the transaction. For example: FT0102030333 etc."},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from t24 on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"TransactionDetailsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/transactions/{transactionReference}/transactions","fullPath":"/api/v2.1.0/holdings/transactions/{transactionReference}/transactions","operationId":"getStatementForTransaction","name":"Retrieves the details of accounting entries","summary":"Retrieves accounting entries","tags":[],"parameters":[{"name":"transactionReference","in":"path","type":"string","required":true,"description":"Contains the identifier for the transaction in the core system"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from t24 on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"StatementForTransactionResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/transactions","fullPath":"/api/v2.1.0/holdings/transactions","operationId":"getAccountTransactions","name":"Retrieves the details of account transaction","summary":"Retrieves account transaction","tags":[],"parameters":[{"name":"accountId","in":"query","type":"string","required":false,"description":"Identifier of the account. Often referred to as the account number, yet for consistency this is always referred to as accountId. Accepts both IBAN & BBAN"},{"name":"customerId","in":"query","type":"string","required":false,"description":"Identifier of the customer"},{"name":"listType","in":"query","type":"string","required":false,"description":"Specifies the transaction Method(RECENT,COMPLETED,PENDING,SEARCH)"},{"name":"transactionCount","in":"query","type":"string","required":false,"description":"Specifies the number of transaction to be shown"},{"name":"payType","in":"query","type":"string","required":false,"description":"Indicates the identifier of payment types for  letter of credit."},{"name":"dateFrom","in":"query","type":"string","required":false,"description":"Start date of the loan"},{"name":"dateTo","in":"query","type":"string","required":false,"description":"End date of the loan"},{"name":"minimumAmount","in":"query","type":"string","required":false,"description":"The minimum account balance required."},{"name":"maximumAmount","in":"query","type":"string","required":false,"description":"The maximum account balance allowed."},{"name":"displayName","in":"query","type":"string","required":false,"description":"Contains the name used for display or enrichment purposes"},{"name":"transactionCode","in":"query","type":"string","required":false,"description":"Identifies the system internal transaction code applicable to the transaction"},{"name":"entryReference","in":"query","type":"string","required":false,"description":"It is the transaction reference. This is the identifier of the transaction on Temenos Core Banking system."},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from t24 on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"AccountTransactionsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}}]},{"key":"holdings-transactions-service-v2.2.0","title":"Transaction Details","version":"v2.2.0","description":"API to retrieve information on transactions and accounting entries.","endpointCount":3,"endpoints":[{"method":"GET","path":"/holdings/transactions/{entryReference}","fullPath":"/api/v2.2.0/holdings/transactions/{entryReference}","operationId":"getTransactionDetails","name":"Retrieves the details of a transaction for a specific accounting entry reference that includes debit and credit party details , amount , date , payment reference , charges and cheque details.","summary":"Retrieves transaction details for a specific accounting entry","tags":["RETAIL"],"parameters":[{"name":"entryReference","in":"path","type":"string","required":true,"description":"It is the transaction reference. This is the identifier of the transaction on Temenos Core Banking system."},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"TransactionDetailsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/transactions/{transactionReference}/transactions","fullPath":"/api/v2.2.0/holdings/transactions/{transactionReference}/transactions","operationId":"getStatementForTransaction","name":"Retrieves the details of accounting entries for a specific transaction that includes entry reference , account number , name , transaction code , date , amount , currency and narrative.","summary":"Retrieves accounting entries for a specific transaction reference","tags":["RETAIL"],"parameters":[{"name":"transactionReference","in":"path","type":"string","required":true,"description":"Contains the identifier for the transaction in the core system"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"StatementForTransactionResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/transactions","fullPath":"/api/v2.2.0/holdings/transactions","operationId":"getAccountTransactions","name":"Retrieves transaction details for the specified account that includes entry reference , account number , name , transaction code , date , amount , currency , narrative , cheque numbers and balance.","summary":"Retrieves the details of account transaction","tags":["RETAIL"],"parameters":[{"name":"accountId","in":"query","type":"string","required":false,"description":"Identifier of the account. Often referred to as the account number, yet for consistency this is always referred to as accountId. Accepts both IBAN & BBAN"},{"name":"customerId","in":"query","type":"string","required":false,"description":"Identifier of the customer"},{"name":"listType","in":"query","type":"string","required":true,"description":"Indicates the transaction search type"},{"name":"transactionCount","in":"query","type":"string","required":false,"description":"Indicates the total number of transactions"},{"name":"payType","in":"query","type":"string","required":false,"description":"Indicates the identifier of payment types for  letter of credit."},{"name":"dateFrom","in":"query","type":"string","required":false,"description":"Start date of the loan"},{"name":"dateTo","in":"query","type":"string","required":false,"description":"End date of the loan"},{"name":"minimumAmount","in":"query","type":"string","required":false,"description":"The minimum account balance required."},{"name":"maximumAmount","in":"query","type":"string","required":false,"description":"The maximum account balance allowed."},{"name":"displayName","in":"query","type":"string","required":false,"description":"Contains the name used for display or enrichment purposes"},{"name":"transactionCode","in":"query","type":"string","required":false,"description":"Identifies the system internal transaction code applicable to the transaction"},{"name":"entryReference","in":"query","type":"string","required":false,"description":"It is the transaction reference. This is the identifier of the transaction on Temenos Core Banking system."},{"name":"chequeNumber","in":"query","type":"string","required":false,"description":"Cheque number associated with the transaction or accounting entry."},{"name":"chequeNumberRange","in":"query","type":"string","required":false,"description":"Indicates the criteria for the range operation search on cheque numbers"},{"name":"skipImageDetails","in":"query","type":"string","required":false,"description":"Indicates to skip retrieval of image specific details for a statement reference. Accept Values YES, NO or NULL"},{"name":"statementSortMethod","in":"query","type":"string","required":false,"description":"Indicates the method in which the statement entries are to be sorted. Possible values oldest/latest. Oldest - displays the entries in ascending timestamp order. Latest - displays the entries in descen"},{"name":"statementPageSize","in":"query","type":"string","required":false,"description":"Contains the total number of statement to be returned per page"},{"name":"statementPageNumber","in":"query","type":"string","required":false,"description":"Contains the record from which the statement must be displayed"},{"name":"entryReferenceFrom","in":"query","type":"string","required":false,"description":"Indicates the entry from which the transaction history needs to be retrieved. If an end date is not specified, transactions from delta list till 'today' are retrieved."},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"AccountTransactionsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}}]},{"key":"holdings-transactions-service-v2.3.0","title":"Transaction Details","version":"v2.3.0","description":"API to retrieve information on transactions and accounting entries.","endpointCount":3,"endpoints":[{"method":"GET","path":"/holdings/transactions/{entryReference}","fullPath":"/api/v2.3.0/holdings/transactions/{entryReference}","operationId":"getTransactionDetails","name":"Retrieves the details of a transaction for a specific accounting entry reference that includes debit and credit party details , amount , date , payment reference , charges and cheque details.","summary":"Retrieves transaction details for a specific accounting entry","tags":["RETAIL"],"parameters":[{"name":"entryReference","in":"path","type":"string","required":true,"description":"It is the transaction reference. This is the identifier of the transaction on Temenos Core Banking system."},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"TransactionDetailsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/transactions/{transactionReference}/transactions","fullPath":"/api/v2.3.0/holdings/transactions/{transactionReference}/transactions","operationId":"getStatementForTransaction","name":"Retrieves the details of accounting entries for a specific transaction that includes entry reference , account number , name , transaction code , date , amount , currency and narrative.","summary":"Retrieves accounting entries for a specific transaction reference","tags":["RETAIL"],"parameters":[{"name":"transactionReference","in":"path","type":"string","required":true,"description":"Contains the identifier for the transaction in the core system"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"StatementForTransactionResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/transactions","fullPath":"/api/v2.3.0/holdings/transactions","operationId":"getAccountTransactions","name":"Retrieves transaction details for the specified account that includes entry reference , account number , name , transaction code , date , amount , currency , narrative , cheque numbers and balance.","summary":"Retrieves the details of account transaction","tags":["RETAIL"],"parameters":[{"name":"accountId","in":"query","type":"string","required":false,"description":"Identifier of the account. Often referred to as the account number, yet for consistency this is always referred to as accountId. Accepts both IBAN & BBAN"},{"name":"customerId","in":"query","type":"string","required":false,"description":"Identifier of the customer"},{"name":"listType","in":"query","type":"string","required":true,"description":"Indicates the transaction search type"},{"name":"transactionCount","in":"query","type":"string","required":false,"description":"Indicates the total number of transactions"},{"name":"payType","in":"query","type":"string","required":false,"description":"Indicates the identifier of payment types for  letter of credit."},{"name":"dateFrom","in":"query","type":"string","required":false,"description":"Start date of the loan"},{"name":"dateTo","in":"query","type":"string","required":false,"description":"End date of the loan"},{"name":"minimumAmount","in":"query","type":"string","required":false,"description":"The minimum account balance required."},{"name":"maximumAmount","in":"query","type":"string","required":false,"description":"The maximum account balance allowed."},{"name":"displayName","in":"query","type":"string","required":false,"description":"Contains the name used for display or enrichment purposes"},{"name":"transactionCode","in":"query","type":"string","required":false,"description":"Identifies the system internal transaction code applicable to the transaction"},{"name":"entryReference","in":"query","type":"string","required":false,"description":"It is the transaction reference. This is the identifier of the transaction on Temenos Core Banking system."},{"name":"chequeNumber","in":"query","type":"string","required":false,"description":"Cheque number associated with the transaction or accounting entry."},{"name":"chequeNumberRange","in":"query","type":"string","required":false,"description":"Indicates the criteria for the range operation search on cheque numbers"},{"name":"skipImageDetails","in":"query","type":"string","required":false,"description":"Indicates to skip retrieval of image specific details for a statement reference. Accept Values YES, NO or NULL"},{"name":"statementSortMethod","in":"query","type":"string","required":false,"description":"Indicates the method in which the statement entries are to be sorted. Possible values oldest/latest. Oldest - displays the entries in ascending timestamp order. Latest - displays the entries in descen"},{"name":"statementPageSize","in":"query","type":"string","required":false,"description":"Contains the total number of statement to be returned per page"},{"name":"statementPageNumber","in":"query","type":"string","required":false,"description":"Contains the record from which the statement must be displayed"},{"name":"entryReferenceFrom","in":"query","type":"string","required":false,"description":"Indicates the entry from which the transaction history needs to be retrieved. If an end date is not specified, transactions from delta list till 'today' are retrieved."},{"name":"suppressMaskEntries","in":"query","type":"string","required":false,"description":"Indicator to skip retrieval of masked entry details. Example, reversal entries of a transaction. Allowed values are Yes or Y."},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"AccountTransactionsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}}]},{"key":"holdings-treasury-currencies-service-v1.0.0","title":"Treasury live rates","version":"v1.0.0","description":"API to retrieve the currency exchange rate (market middle rate) of a foreign currency with respect to local currency of the institution, which is stored and updated regularly in the system data records. This middle rate is used in the revaluation process to revalue the foreign currency positions.","endpointCount":2,"endpoints":[{"method":"GET","path":"/holdings/currencies/{currencyId}/rates","fullPath":"/api/v1.0.0/holdings/currencies/{currencyId}/rates","operationId":"getCurrencyMarketRates","name":"Retrieves the live market rate from a given rate feed and displays the rate provider for a given currency ","summary":"Retrieves the live market rate from  rate feeds","tags":[],"parameters":[{"name":"currencyId","in":"path","type":"string","required":true,"description":"Identifier of the currency. This is the 3-letter ISO 4217 code of the currency."},{"name":"rateSource","in":"query","type":"string","required":false,"description":"The market rates source in general. In the case of currency rate, whether rate is to be sourced from  currency table (front office) or from market rates table (back office)."},{"name":"rateProvider","in":"query","type":"string","required":false,"description":"The market rate provider, e.g. Bloomberg, Reuters, etc."},{"name":"assetType","in":"query","type":"string","required":false,"description":"Type of the asset, e.g. FX, equity, etc."},{"name":"dateOrPeriod","in":"query","type":"string","required":false,"description":"Refers to a date or a given period."},{"name":"rateIndicator","in":"query","type":"string","required":false,"description":"Market rate indicator as per the asset class. For currency, it  will be buy rate(B) , sell rate(S) or mid rate(M)."},{"name":"interpolationMethod","in":"query","type":"string","required":false,"description":"Identifies whether forward exchange rates are to be interpolated or not. Possible values are 'Blank' - Rate will be interpolated '1' - Takes the next available rate '2' - Takes the closest rate"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from t24 on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"The identifier of the underlying Entity/Company/Branch."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"CurrencyMarketRatesResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/currencies/revaluationRates","fullPath":"/api/v1.0.0/holdings/currencies/revaluationRates","operationId":"getCurrencyRevaluationRates","name":"Retrieves the exchange rate(market middle rate) of a foreign currency with respect to local currency, which is stored in the system. This middle rate is used in revaluation to revalue the  foreign exchange contracts.","summary":"Retrieves the exchange rate(used in revaluation) of a foreign currency with respect to local currency","tags":[],"parameters":[{"name":"currency","in":"query","type":"string","required":false,"description":"Identifies the currency. E.g. USD, GBP etc"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from t24 on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"The identifier of the underlying Entity/Company/Branch."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"CurrencyRevaluationRatesResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}}]},{"key":"holdings-treasury-currencyPairs-service-v1.0.0","title":"Treasury currency pairs","version":"v1.0.0","description":"API to retrieve the currency details such as quotation PIPS, rounding decimals, live market rates with rate provider details and others for the currency pairs configured by the institution. It also retrieves the currency pair position with mark to market revaluation profit and loss for the given cur","endpointCount":8,"endpoints":[{"method":"GET","path":"/holdings/currencyPairs/{currencyPair}/positions","fullPath":"/api/v1.0.0/holdings/currencyPairs/{currencyPair}/positions","operationId":"getCurrencyPairPositions","name":"Retrieves the position in the given currency pair and the revalued(marked-to market) profit/loss ","summary":"Retrieves position information for the given currency pair ","tags":[],"parameters":[{"name":"currencyPair","in":"path","type":"string","required":true,"description":"Identifies the currency pair. Ex: USDCHF, USDGBP"},{"name":"companyId","in":"query","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"positionType","in":"query","type":"string","required":false,"description":"Identifies the position type. Possible values are CAS(cash position), GAP(Interest mismatch position), FXP(Foreign exchange position)"},{"name":"dealerDesk","in":"query","type":"string","required":false,"description":"The dealer/desk responsible for monitoring and managing the currency positions."},{"name":"buyDate","in":"query","type":"string","required":false,"description":"Value date of the buy currency. "},{"name":"dealDate","in":"query","type":"string","required":false,"description":"Date on which the deal was agreed. "},{"name":"positionPeriod","in":"query","type":"string","required":false,"description":"Identifies the period for which position is retrieved. Possible values are SPOT, FORWARD"},{"name":"counterpartyName","in":"query","type":"string","required":false,"description":"The counterparty name for the forex deal."},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"CurrencyPairPositionsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/currencyPairs/{currencyPair}/calendarPositions","fullPath":"/api/v1.0.0/holdings/currencyPairs/{currencyPair}/calendarPositions","operationId":"getCurrencyPairCalendarPositions","name":"Retrieves the position in the currency pair and the revalued(marked-to market) profit/loss ","summary":"Retrieves the position details for the given currency pair and calender","tags":[],"parameters":[{"name":"currencyPair","in":"path","type":"string","required":true,"description":"Identifies the currency pair. Ex: USDCHF, USDGBP"},{"name":"companyId","in":"query","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"positionType","in":"query","type":"string","required":false,"description":"Identifies the position type. Possible values are CAS(cash position), GAP(Interest mismatch position), FXP(Foreign exchange position)"},{"name":"dealerDesk","in":"query","type":"string","required":false,"description":"The dealer/desk responsible for monitoring and managing the currency positions."},{"name":"buyDate","in":"query","type":"string","required":false,"description":"Value date of the buy currency. "},{"name":"buyDateFrom","in":"query","type":"string","required":false,"description":"Contains the from value date in a range while retrieving the position."},{"name":"buyDateTo","in":"query","type":"string","required":false,"description":"Contains the to value date in a range while retrieving the position."},{"name":"dealDate","in":"query","type":"string","required":false,"description":"Date on which the deal was agreed. "},{"name":"dealDateFrom","in":"query","type":"string","required":false,"description":"Date on which the deal was agreed. "},{"name":"dealDateTo","in":"query","type":"string","required":false,"description":"Date on which the deal was agreed. "},{"name":"positionPeriod","in":"query","type":"string","required":false,"description":"Identifies the period for which position is retrieved. Possible values are SPOT, FORWARD"},{"name":"counterpartyName","in":"query","type":"string","required":false,"description":"The counterparty name for the forex deal."},{"name":"calendar","in":"query","type":"string","required":false,"description":"Identifies the calendar to be used for the spreading of different position data into different time buckets. Ex: CAL-Standard calendar and DE1-Deutsche calendar"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"CurrencyPairCalendarPositionsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/currencyPairs/{currencyPair}/rates","fullPath":"/api/v1.0.0/holdings/currencyPairs/{currencyPair}/rates","operationId":"getCurrencyPairMarketRates","name":"Retrieves the live market rate from a given rate feed and displays the rate provider for a given currency pair","summary":"Retrieves the live market rate from a given rate feed","tags":[],"parameters":[{"name":"currencyPair","in":"path","type":"string","required":true,"description":"Identifies the currency pair. Ex: USDCHF, USDGBP"},{"name":"rateSource","in":"query","type":"string","required":false,"description":"The market rates source in general. In the case of currency rate, whether rate is to be sourced from  currency table (front office) or from market rates table (back office)."},{"name":"rateProvider","in":"query","type":"string","required":false,"description":"The market rate provider, e.g. Bloomberg, Reuters, etc."},{"name":"assetType","in":"query","type":"string","required":false,"description":"Type of the asset, e.g. FX, equity, etc."},{"name":"dateOrPeriod","in":"query","type":"string","required":false,"description":"Refers to a date or a given period."},{"name":"rateIndicator","in":"query","type":"string","required":false,"description":"Market rate indicator as per the asset class. For currency, it  will be buy rate(B) , sell rate(S) or mid rate(M)."},{"name":"interpolationMethod","in":"query","type":"string","required":false,"description":"Identifies whether forward exchange rates are to be interpolated or not. Possible values are 'Blank' - Rate will be interpolated '1' - Takes the next available rate '2' - Takes the closest rate"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"CurrencyPairMarketRatesResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/currencyPairs/positions","fullPath":"/api/v1.0.0/holdings/currencyPairs/positions","operationId":"getAllCurrencyPairPositions","name":"Retrieves the position of all the currency pairs and the revalued(marked-to market) profit/loss ","summary":"Retrieves position information for the currency pair outstanding deals","tags":[],"parameters":[{"name":"currencyPair","in":"query","type":"string","required":false,"description":"Identifies the currency pair. Ex: USDCHF, USDGBP"},{"name":"companyId","in":"query","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"positionType","in":"query","type":"string","required":false,"description":"Identifies the position type. Possible values are CAS(cash position), GAP(Interest mismatch position), FXP(Foreign exchange position)"},{"name":"dealerDesk","in":"query","type":"string","required":false,"description":"The dealer/desk responsible for monitoring and managing the currency positions."},{"name":"buyDate","in":"query","type":"string","required":false,"description":"Value date of the buy currency. "},{"name":"buyDateFrom","in":"query","type":"string","required":false,"description":"Contains the from value date in a range while retrieving the position."},{"name":"buyDateTo","in":"query","type":"string","required":false,"description":"Contains the to value date in a range while retrieving the position."},{"name":"dealDate","in":"query","type":"string","required":false,"description":"Date on which the deal was agreed. "},{"name":"dealDateFrom","in":"query","type":"string","required":false,"description":"Date on which the deal was agreed. "},{"name":"dealDateTo","in":"query","type":"string","required":false,"description":"Date on which the deal was agreed. "},{"name":"positionPeriod","in":"query","type":"string","required":false,"description":"Identifies the period for which position is retrieved. Possible values are SPOT, FORWARD"},{"name":"counterpartyName","in":"query","type":"string","required":false,"description":"The counterparty name for the forex deal."},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"AllCurrencyPairPositionsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/currencyPairs/{currencyPair}/deals","fullPath":"/api/v1.0.0/holdings/currencyPairs/{currencyPair}/deals","operationId":"getCurrencyPairPositionDeals","name":"Retrieves the deals because of which positions have been created for the given currency pair","summary":"Retrieves the underlying deal responsible for the positions in the given currency pair","tags":[],"parameters":[{"name":"currencyPair","in":"path","type":"string","required":true,"description":"Identifies the currency pair. Ex: USDCHF, USDGBP"},{"name":"companyId","in":"query","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"positionType","in":"query","type":"string","required":false,"description":"Identifies the position type. Possible values are CAS(cash position), GAP(Interest mismatch position), FXP(Foreign exchange position)"},{"name":"dealerDesk","in":"query","type":"string","required":false,"description":"The dealer/desk responsible for monitoring and managing the currency positions."},{"name":"buyDate","in":"query","type":"string","required":false,"description":"Value date of the buy currency. "},{"name":"buyDateFrom","in":"query","type":"string","required":false,"description":"Contains the from value date in a range while retrieving the position."},{"name":"buyDateTo","in":"query","type":"string","required":false,"description":"Contains the to value date in a range while retrieving the position."},{"name":"dealDate","in":"query","type":"string","required":false,"description":"Date on which the deal was agreed. "},{"name":"dealDateFrom","in":"query","type":"string","required":false,"description":"Date on which the deal was agreed. "},{"name":"dealDateTo","in":"query","type":"string","required":false,"description":"Date on which the deal was agreed. "},{"name":"positionPeriod","in":"query","type":"string","required":false,"description":"Identifies the period for which position is retrieved. Possible values are SPOT, FORWARD"},{"name":"counterpartyName","in":"query","type":"string","required":false,"description":"The counterparty name for the forex deal."},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"CurrencyPairPositionDealsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/currencyPairs/","fullPath":"/api/v1.0.0/holdings/currencyPairs/","operationId":"getCurrencyPairs","name":"Retrieves all the currency pairs ","summary":"Retrieves all the currency pairs ","tags":[],"parameters":[{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"CurrencyPairsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/currencyPairs/{currencyPair}","fullPath":"/api/v1.0.0/holdings/currencyPairs/{currencyPair}","operationId":"getCurrencyPair","name":"Retrieves the given currency pair ","summary":"Retrieves the given currency pair ","tags":[],"parameters":[{"name":"currencyPair","in":"path","type":"string","required":true,"description":"Identifies the currency pair. Ex: USDCHF, USDGBP"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"CurrencyPairResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/currencyPairs/portfolioValuationRates","fullPath":"/api/v1.0.0/holdings/currencyPairs/portfolioValuationRates","operationId":"getFxPortfolioValuationRates","name":"Retrieves the exchange rate to be used for the valuation of the forex contracts in the portfolio.","summary":"Retrieves the exchange rates to be used for portfolio valuation.","tags":[],"parameters":[{"name":"portfolioId","in":"query","type":"string","required":false,"description":"Id of the portfolio or security account"},{"name":"buyCurrency","in":"query","type":"string","required":false,"description":"ISO Currency code for the bought currency.  "},{"name":"sellCurrency","in":"query","type":"string","required":false,"description":"ISO Currency code for the sold currency.  "},{"name":"dateOrPeriod","in":"query","type":"string","required":false,"description":"Refers to a date or a given period."},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"FxPortfolioValuationRatesResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}}]},{"key":"holdings-us-accounts-service-v1.0.0","title":"US Model Bank Management of Accounts","version":"v1.0.0","description":"Create, update account, change account product, retreive account summary and overview,  statement addresses and list of accounts available for a customer","endpointCount":10,"endpoints":[{"method":"GET","path":"/holdings/us/accounts/{accountId}/balances","fullPath":"/api/v1.0.0/holdings/us/accounts/{accountId}/balances","operationId":"getUsAccountSummary","name":"Retrieves summary level balance information for an account","summary":"Account Summary","tags":["RETAIL"],"parameters":[{"name":"accountId","in":"path","type":"string","required":true,"description":"Identifier of the account. Often referred to as the account number, yet for consistency this is always referred to as accountId. Accepts both IBAN & BBAN"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"UsAccountSummaryResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/us/accounts/{accountId}/addresses","fullPath":"/api/v1.0.0/holdings/us/accounts/{accountId}/addresses","operationId":"getUsStatementAddress","name":"Retrieves address information for the account","summary":"Statement Address","tags":["RETAIL"],"parameters":[{"name":"accountId","in":"path","type":"string","required":true,"description":"Identifier of the account. Often referred to as the account number, yet for consistency this is always referred to as accountId. Accepts both IBAN & BBAN"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"UsStatementAddressResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/us/customers/{customerId}/accounts","fullPath":"/api/v1.0.0/holdings/us/customers/{customerId}/accounts","operationId":"getUsAccountList","name":"Retrieves the available accounts details for a customer.","summary":"Account list","tags":["RETAIL"],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"Identifier of the customer"},{"name":"accountId","in":"query","type":"string","required":false,"description":"Identifier of the account. Often referred to as the account number, yet for consistency this is always referred to as accountId. Accepts both IBAN & BBAN"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"UsAccountListResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/us/accounts/{accountId}/accountOverview","fullPath":"/api/v1.0.0/holdings/us/accounts/{accountId}/accountOverview","operationId":"getUsAccountOverview","name":"Retrieves the account details, balances, due balances, interest earned, RegD and NSF details, etc,.","summary":"Account Overview","tags":["RETAIL"],"parameters":[{"name":"accountId","in":"path","type":"string","required":true,"description":"Identifier of the account. Often referred to as the account number, yet for consistency this is always referred to as accountId. Accepts both IBAN & BBAN"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"UsAccountOverviewResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"POST","path":"/holdings/us/accounts/consumerAccounts","fullPath":"/api/v1.0.0/holdings/us/accounts/consumerAccounts","operationId":"createUsConsumerAccount","name":"Create a new consumer account of type checkings or savings.","summary":"Create a new consumer account ","tags":["RETAIL"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"customerIds":[{}],"properties":[{}],"overrides":[{}],"productId":"string","masterArrangementId":"string","roleName":"string","currencyId":"string","effectiveDate":"2024-01-01","activityId":"string","transactionAmount":0.0,"narrative":"string","reason":"string"}},"responses":{"200":"createUsConsumerAccountResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"PUT","path":"/holdings/us/accounts/{accountId}/consumerAccounts","fullPath":"/api/v1.0.0/holdings/us/accounts/{accountId}/consumerAccounts","operationId":"updateUsConsumerAccount","name":"Modify existing account information like, customer and ownership information, settlement accounts, charges etc,.","summary":"Update consumer Account","tags":["RETAIL"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"accountId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"customerIds":[{}],"properties":[{}],"overrides":[{}],"productId":"string","masterArrangementId":"string","roleName":"string","currencyId":"string","effectiveDate":"2024-01-01","activityId":"string","transactionAmount":0.0,"narrative":"string","reason":"string"}},"responses":{"200":"updateUsConsumerAccountResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"POST","path":"/holdings/us/accounts/businessCheckings","fullPath":"/api/v1.0.0/holdings/us/accounts/businessCheckings","operationId":"createUsBusinessCheckingAccount","name":"Create a new business checking account for the corporate customer","summary":"Create a new business checking account for the corporate customer","tags":["RETAIL"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"customerIds":[{}],"properties":[{}],"overrides":[{}],"productId":"string","masterArrangementId":"string","roleName":"string","currencyId":"string","effectiveDate":"2024-01-01","activityId":"string","transactionAmount":0.0,"narrative":"string","reason":"string"}},"responses":{"200":"createUsBusinessCheckingAccountResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"PUT","path":"/holdings/us/accounts/{accountId}/businessChecking","fullPath":"/api/v1.0.0/holdings/us/accounts/{accountId}/businessChecking","operationId":"updateUsBusinessCheckingAccount","name":"Renegotiate existing Business Checking account conditions","summary":"Renegotiate Business Checking account conditions","tags":["RETAIL"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"accountId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"customerIds":[{}],"properties":[{}],"overrides":[{}],"productId":"string","masterArrangementId":"string","roleName":"string","currencyId":"string","effectiveDate":"2024-01-01","activityId":"string","transactionAmount":0.0,"narrative":"string","reason":"string"}},"responses":{"200":"updateUsBusinessCheckingAccountResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"POST","path":"/holdings/us/accounts/businessSavings","fullPath":"/api/v1.0.0/holdings/us/accounts/businessSavings","operationId":"createUsBusinessSavingsAccount","name":"Create a new business savings account for the corporate customer","summary":"Create a new business savings account for the corporate customer","tags":["RETAIL"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"customerIds":[{}],"properties":[{}],"overrides":[{}],"productId":"string","masterArrangementId":"string","roleName":"string","currencyId":"string","effectiveDate":"2024-01-01","activityId":"string","transactionAmount":0.0,"narrative":"string","reason":"string"}},"responses":{"200":"createUsBusinessSavingsAccountResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"PUT","path":"/holdings/us/accounts/{accountId}/businessSavings","fullPath":"/api/v1.0.0/holdings/us/accounts/{accountId}/businessSavings","operationId":"updateUsBusinessSavingsAccount","name":"Renegotiate existing  business savings account conditions","summary":"Renegotiate business savings account conditions","tags":["RETAIL"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"accountId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"customerIds":[{}],"properties":[{}],"overrides":[{}],"productId":"string","masterArrangementId":"string","roleName":"string","currencyId":"string","effectiveDate":"2024-01-01","activityId":"string","transactionAmount":0.0,"narrative":"string","reason":"string"}},"responses":{"200":"updateUsBusinessSavingsAccountResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}}]},{"key":"holdings-us-accounts-service-v2.0.0","title":"US Model Bank Management of Accounts","version":"v2.0.0","description":"Create, update account, change account product, retreive account summary and overview,  statement addresses and list of accounts available for a customer","endpointCount":11,"endpoints":[{"method":"GET","path":"/holdings/us/accounts/{accountId}/balances","fullPath":"/api/v2.0.0/holdings/us/accounts/{accountId}/balances","operationId":"getUsAccountSummary","name":"Retrieves summary level balance information for an account","summary":"Account Summary","tags":["RETAIL"],"parameters":[{"name":"accountId","in":"path","type":"string","required":true,"description":"Identifier of the account. Often referred to as the account number, yet for consistency this is always referred to as accountId. Accepts both IBAN & BBAN"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"UsAccountSummaryResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/us/accounts/{accountId}/addresses","fullPath":"/api/v2.0.0/holdings/us/accounts/{accountId}/addresses","operationId":"getUsStatementAddress","name":"Retrieves address information for the account","summary":"Statement Address","tags":["RETAIL"],"parameters":[{"name":"accountId","in":"path","type":"string","required":true,"description":"Identifier of the account. Often referred to as the account number, yet for consistency this is always referred to as accountId. Accepts both IBAN & BBAN"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"UsStatementAddressResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/us/customers/{customerId}/accounts","fullPath":"/api/v2.0.0/holdings/us/customers/{customerId}/accounts","operationId":"getUsAccountList","name":"Retrieves the available accounts details for a customer.","summary":"Account list","tags":["RETAIL"],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"Identifier of the customer"},{"name":"accountId","in":"query","type":"string","required":false,"description":"Identifier of the account. Often referred to as the account number, yet for consistency this is always referred to as accountId. Accepts both IBAN & BBAN"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"UsAccountListResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/us/accounts/{accountId}/accountOverview","fullPath":"/api/v2.0.0/holdings/us/accounts/{accountId}/accountOverview","operationId":"getUsAccountOverview","name":"Retrieves the account details, balances, due balances, interest earned, RegD and NSF details, etc,.","summary":"Account Overview","tags":["RETAIL"],"parameters":[{"name":"accountId","in":"path","type":"string","required":true,"description":"Identifier of the account. Often referred to as the account number, yet for consistency this is always referred to as accountId. Accepts both IBAN & BBAN"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"UsAccountOverviewResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"POST","path":"/holdings/us/accounts/consumerAccounts","fullPath":"/api/v2.0.0/holdings/us/accounts/consumerAccounts","operationId":"createUsConsumerAccount","name":"Create a new consumer account of type checkings or savings.","summary":"Create a new consumer account ","tags":["RETAIL"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"customerIds":[{}],"properties":[{}],"overrides":[{}],"productId":"string","masterArrangementId":"string","roleName":"string","currencyId":"string","effectiveDate":"2024-01-01","activityId":"string","transactionAmount":0.0,"narrative":"string","reason":"string","extensions":{},"balance":[{}],"messaging":[{}]}},"responses":{"200":"createUsConsumerAccountResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"PUT","path":"/holdings/us/accounts/{accountId}/consumerAccounts","fullPath":"/api/v2.0.0/holdings/us/accounts/{accountId}/consumerAccounts","operationId":"updateUsConsumerAccount","name":"Modify existing account information like, customer and ownership information, settlement accounts, charges etc,.","summary":"Update consumer Account","tags":["RETAIL"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"accountId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"customerIds":[{}],"properties":[{}],"overrides":[{}],"productId":"string","masterArrangementId":"string","roleName":"string","currencyId":"string","effectiveDate":"2024-01-01","activityId":"string","transactionAmount":0.0,"narrative":"string","reason":"string","extensions":{},"balance":[{}],"messaging":[{}]}},"responses":{"200":"updateUsConsumerAccountResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"POST","path":"/holdings/us/accounts/businessCheckings","fullPath":"/api/v2.0.0/holdings/us/accounts/businessCheckings","operationId":"createUsBusinessCheckingAccount","name":"Create a new business checking account for the corporate customer","summary":"New business checking account opening API","tags":["RETAIL"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"customerIds":[{}],"properties":[{}],"overrides":[{}],"productId":"string","masterArrangementId":"string","roleName":"string","currencyId":"string","effectiveDate":"2024-01-01","activityId":"string","transactionAmount":0.0,"narrative":"string","reason":"string","extensions":{},"balance":[{}],"messaging":[{}]}},"responses":{"200":"createUsBusinessCheckingAccountResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"PUT","path":"/holdings/us/accounts/{accountId}/businessCheckings","fullPath":"/api/v2.0.0/holdings/us/accounts/{accountId}/businessCheckings","operationId":"updateUsBusinessCheckingAccount","name":"Renegotiate existing business checking account conditions","summary":"Renegotiate business checking account conditions","tags":["RETAIL"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"accountId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"customerIds":[{}],"properties":[{}],"overrides":[{}],"productId":"string","masterArrangementId":"string","roleName":"string","currencyId":"string","effectiveDate":"2024-01-01","activityId":"string","transactionAmount":0.0,"narrative":"string","reason":"string","extensions":{},"balance":[{}],"messaging":[{}]}},"responses":{"200":"updateUsBusinessCheckingAccountResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"POST","path":"/holdings/us/accounts/businessSavings","fullPath":"/api/v2.0.0/holdings/us/accounts/businessSavings","operationId":"createUsBusinessSavingsAccount","name":"Create a new business savings account for the corporate customer","summary":"New business savings account opening API","tags":["RETAIL"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"customerIds":[{}],"properties":[{}],"overrides":[{}],"productId":"string","masterArrangementId":"string","roleName":"string","currencyId":"string","effectiveDate":"2024-01-01","activityId":"string","transactionAmount":0.0,"narrative":"string","reason":"string","extensions":{},"balance":[{}],"messaging":[{}]}},"responses":{"200":"createUsBusinessSavingsAccountResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"PUT","path":"/holdings/us/accounts/{accountId}/businessSavings","fullPath":"/api/v2.0.0/holdings/us/accounts/{accountId}/businessSavings","operationId":"updateUsBusinessSavingsAccount","name":"Renegotiate existing  business savings account conditions","summary":"Renegotiate business savings account conditions","tags":["RETAIL"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"accountId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"customerIds":[{}],"properties":[{}],"overrides":[{}],"productId":"string","masterArrangementId":"string","roleName":"string","currencyId":"string","effectiveDate":"2024-01-01","activityId":"string","transactionAmount":0.0,"narrative":"string","reason":"string","extensions":{},"balance":[{}],"messaging":[{}]}},"responses":{"200":"updateUsBusinessSavingsAccountResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"PUT","path":"/holdings/us/accounts/{accountId}/consumerAccounts/overdrafts/coverages","fullPath":"/api/v2.0.0/holdings/us/accounts/{accountId}/consumerAccounts/overdrafts/coverages","operationId":"updateOverdraftCoverageCode","name":"Updates the overdraft protection option opted by the customer. Overdraft protection options are offered by financial institutions to allow customers to choose if overdraft coverage is required, if transaction causing overdraft can be cleared, the type of balances that can be used to cover the overdraft (shared account balance, overdraft limit etc.) and the type of transactions that can be considered for overdraft coverage (ATM/Check/point of sale transactions etc.)","summary":"Updates the overdraft protection option opted by the customer.","tags":["RETAIL"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"accountId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"customerIds":[{}],"properties":[{}],"overrides":[{}],"productId":"string","masterArrangementId":"string","roleName":"string","currencyId":"string","effectiveDate":"2024-01-01","activityId":"string","transactionAmount":0.0,"narrative":"string","reason":"string","extensions":{},"balanceAvailability":[{}]}},"responses":{"200":"updateOverdraftCoverageCodeResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}}]},{"key":"holdings-us-accounts-service-v2.1.0","title":"US Model Bank Management of Accounts","version":"v2.1.0","description":"Create, update account, change account product, retreive account summary and overview,  statement addresses and list of accounts available for a customer","endpointCount":11,"endpoints":[{"method":"GET","path":"/holdings/us/accounts/{accountId}/balances","fullPath":"/api/v2.1.0/holdings/us/accounts/{accountId}/balances","operationId":"getUsAccountSummary","name":"Retrieves summary level balance information for an account","summary":"Account Summary","tags":["RETAIL"],"parameters":[{"name":"accountId","in":"path","type":"string","required":true,"description":"Identifier of the account. Often referred to as the account number, yet for consistency this is always referred to as accountId. Accepts both IBAN & BBAN"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"UsAccountSummaryResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/us/accounts/{accountId}/addresses","fullPath":"/api/v2.1.0/holdings/us/accounts/{accountId}/addresses","operationId":"getUsStatementAddress","name":"Retrieves address information for the account","summary":"Statement Address","tags":["RETAIL"],"parameters":[{"name":"accountId","in":"path","type":"string","required":true,"description":"Identifier of the account. Often referred to as the account number, yet for consistency this is always referred to as accountId. Accepts both IBAN & BBAN"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"UsStatementAddressResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/us/customers/{customerId}/accounts","fullPath":"/api/v2.1.0/holdings/us/customers/{customerId}/accounts","operationId":"getUsAccountList","name":"Retrieves the available accounts details for a customer.","summary":"Account list","tags":["RETAIL"],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"Identifier of the customer"},{"name":"accountId","in":"query","type":"string","required":false,"description":"Identifier of the account. Often referred to as the account number, yet for consistency this is always referred to as accountId. Accepts both IBAN & BBAN"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"UsAccountListResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/us/accounts/{accountId}/accountOverview","fullPath":"/api/v2.1.0/holdings/us/accounts/{accountId}/accountOverview","operationId":"getUsAccountOverview","name":"Retrieves the account details, balances, due balances, interest earned, RegD and NSF details, etc,.","summary":"Account Overview","tags":["RETAIL"],"parameters":[{"name":"accountId","in":"path","type":"string","required":true,"description":"Identifier of the account. Often referred to as the account number, yet for consistency this is always referred to as accountId. Accepts both IBAN & BBAN"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"UsAccountOverviewResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"POST","path":"/holdings/us/accounts/consumerAccounts","fullPath":"/api/v2.1.0/holdings/us/accounts/consumerAccounts","operationId":"createUsConsumerAccount","name":"Create a new consumer account of type checkings or savings.","summary":"Create a new consumer account ","tags":["RETAIL"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"customerIds":[{}],"properties":[{}],"overrides":[{}],"productId":"string","masterArrangementId":"string","roleName":"string","currencyId":"string","effectiveDate":"2024-01-01","activityId":"string","transactionAmount":0.0,"narrative":"string","reason":"string","extensions":{},"balance":[{}],"messaging":[{}]}},"responses":{"200":"createUsConsumerAccountResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"PUT","path":"/holdings/us/accounts/{accountId}/consumerAccounts","fullPath":"/api/v2.1.0/holdings/us/accounts/{accountId}/consumerAccounts","operationId":"updateUsConsumerAccount","name":"Modify existing account information like, customer and ownership information, settlement accounts, charges etc,.","summary":"Update consumer Account","tags":["RETAIL"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"accountId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"customerIds":[{}],"properties":[{}],"overrides":[{}],"productId":"string","masterArrangementId":"string","roleName":"string","currencyId":"string","effectiveDate":"2024-01-01","activityId":"string","transactionAmount":0.0,"narrative":"string","reason":"string","extensions":{},"balance":[{}],"messaging":[{}]}},"responses":{"200":"updateUsConsumerAccountResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"POST","path":"/holdings/us/accounts/businessCheckings","fullPath":"/api/v2.1.0/holdings/us/accounts/businessCheckings","operationId":"createUsBusinessCheckingAccount","name":"Create a new business checking account for the corporate customer","summary":"New business checking account opening API","tags":["RETAIL"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"customerIds":[{}],"properties":[{}],"overrides":[{}],"productId":"string","masterArrangementId":"string","roleName":"string","currencyId":"string","effectiveDate":"2024-01-01","activityId":"string","transactionAmount":0.0,"narrative":"string","reason":"string","extensions":{},"balance":[{}],"messaging":[{}]}},"responses":{"200":"createUsBusinessCheckingAccountResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"PUT","path":"/holdings/us/accounts/{accountId}/businessCheckings","fullPath":"/api/v2.1.0/holdings/us/accounts/{accountId}/businessCheckings","operationId":"updateUsBusinessCheckingAccount","name":"Renegotiate existing business checking account conditions","summary":"Renegotiate business checking account conditions","tags":["RETAIL"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"accountId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"customerIds":[{}],"properties":[{}],"overrides":[{}],"productId":"string","masterArrangementId":"string","roleName":"string","currencyId":"string","effectiveDate":"2024-01-01","activityId":"string","transactionAmount":0.0,"narrative":"string","reason":"string","extensions":{},"balance":[{}],"messaging":[{}]}},"responses":{"200":"updateUsBusinessCheckingAccountResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"POST","path":"/holdings/us/accounts/businessSavings","fullPath":"/api/v2.1.0/holdings/us/accounts/businessSavings","operationId":"createUsBusinessSavingsAccount","name":"Create a new business savings account for the corporate customer","summary":"New business savings account opening API","tags":["RETAIL"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"customerIds":[{}],"properties":[{}],"overrides":[{}],"productId":"string","masterArrangementId":"string","roleName":"string","currencyId":"string","effectiveDate":"2024-01-01","activityId":"string","transactionAmount":0.0,"narrative":"string","reason":"string","extensions":{},"balance":[{}],"messaging":[{}]}},"responses":{"200":"createUsBusinessSavingsAccountResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"PUT","path":"/holdings/us/accounts/{accountId}/businessSavings","fullPath":"/api/v2.1.0/holdings/us/accounts/{accountId}/businessSavings","operationId":"updateUsBusinessSavingsAccount","name":"Renegotiate existing  business savings account conditions","summary":"Renegotiate business savings account conditions","tags":["RETAIL"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"accountId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"customerIds":[{}],"properties":[{}],"overrides":[{}],"productId":"string","masterArrangementId":"string","roleName":"string","currencyId":"string","effectiveDate":"2024-01-01","activityId":"string","transactionAmount":0.0,"narrative":"string","reason":"string","extensions":{},"balance":[{}],"messaging":[{}]}},"responses":{"200":"updateUsBusinessSavingsAccountResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"PUT","path":"/holdings/us/accounts/{accountId}/consumerAccounts/overdrafts/coverages","fullPath":"/api/v2.1.0/holdings/us/accounts/{accountId}/consumerAccounts/overdrafts/coverages","operationId":"updateOverdraftCoverageCode","name":"Updates the overdraft protection option opted by the customer. Overdraft protection options are offered by financial institutions to allow customers to choose if overdraft coverage is required, if transaction causing overdraft can be cleared, the type of balances that can be used to cover the overdraft (shared account balance, overdraft limit etc.) and the type of transactions that can be considered for overdraft coverage (ATM/Check/point of sale transactions etc.)","summary":"Updates the overdraft protection option opted by the customer.","tags":["RETAIL"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"accountId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"customerIds":[{}],"properties":[{}],"overrides":[{}],"productId":"string","masterArrangementId":"string","roleName":"string","currencyId":"string","effectiveDate":"2024-01-01","activityId":"string","transactionAmount":0.0,"narrative":"string","reason":"string","extensions":{},"balanceAvailability":[{}]}},"responses":{"200":"updateOverdraftCoverageCodeResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}}]},{"key":"holdings-us-accounts-service-v3.0.0","title":"US Model Bank Management of Accounts","version":"v3.0.0","description":"Create, update account, change account product, retrieve account summary and overview,  statement addresses and list of accounts available for a customer","endpointCount":15,"endpoints":[{"method":"GET","path":"/holdings/us/accounts/{accountId}/balances","fullPath":"/api/v3.0.0/holdings/us/accounts/{accountId}/balances","operationId":"getUsAccountSummary","name":"Retrieves summary level balance information for an account","summary":"Account Summary","tags":["RETAIL"],"parameters":[{"name":"accountId","in":"path","type":"string","required":true,"description":"Identifier of the account. Often referred to as the account number, yet for consistency this is always referred to as accountId. Accepts both IBAN & BBAN"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"UsAccountSummaryResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/us/accounts/{accountId}/addresses","fullPath":"/api/v3.0.0/holdings/us/accounts/{accountId}/addresses","operationId":"getUsStatementAddress","name":"Retrieves address information for the account","summary":"Statement Address","tags":["RETAIL"],"parameters":[{"name":"accountId","in":"path","type":"string","required":true,"description":"Identifier of the account. Often referred to as the account number, yet for consistency this is always referred to as accountId. Accepts both IBAN & BBAN"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"UsStatementAddressResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/us/customers/{customerId}/accounts","fullPath":"/api/v3.0.0/holdings/us/customers/{customerId}/accounts","operationId":"getUsAccountList","name":"Retrieves the available accounts details for a customer.","summary":"Account list","tags":["RETAIL"],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"Identifier of the customer"},{"name":"accountId","in":"query","type":"string","required":false,"description":"Identifier of the account. Often referred to as the account number, yet for consistency this is always referred to as accountId. Accepts both IBAN & BBAN"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"UsAccountListResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/us/accounts/{accountId}/accountOverview","fullPath":"/api/v3.0.0/holdings/us/accounts/{accountId}/accountOverview","operationId":"getUsAccountOverview","name":"Retrieves the account details, balances, due balances, interest earned, RegD and NSF details, etc,.","summary":"Account Overview","tags":["RETAIL"],"parameters":[{"name":"accountId","in":"path","type":"string","required":true,"description":"Identifier of the account. Often referred to as the account number, yet for consistency this is always referred to as accountId. Accepts both IBAN & BBAN"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"UsAccountOverviewResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"POST","path":"/holdings/us/accounts/consumerAccounts","fullPath":"/api/v3.0.0/holdings/us/accounts/consumerAccounts","operationId":"createUsConsumerAccount","name":"Create a new consumer account of type checkings or savings.","summary":"Create a new consumer account ","tags":["RETAIL"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"customerIds":[{}],"properties":[{}],"overrides":[{}],"productId":"string","masterArrangementId":"string","roleName":"string","currencyId":"string","effectiveDate":"2024-01-01","activityId":"string","transactionAmount":0.0,"narrative":"string","reason":"string","extensions":{},"balance":[{}],"messaging":[{}]}},"responses":{"200":"createUsConsumerAccountResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"PUT","path":"/holdings/us/accounts/{accountId}/consumerAccounts","fullPath":"/api/v3.0.0/holdings/us/accounts/{accountId}/consumerAccounts","operationId":"updateUsConsumerAccount","name":"Modify existing account information like, customer and ownership information, settlement accounts, charges etc,.","summary":"Update consumer Account","tags":["RETAIL"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"accountId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"customerIds":[{}],"properties":[{}],"overrides":[{}],"productId":"string","masterArrangementId":"string","roleName":"string","currencyId":"string","effectiveDate":"2024-01-01","activityId":"string","transactionAmount":0.0,"narrative":"string","reason":"string","extensions":{},"balance":[{}],"messaging":[{}]}},"responses":{"200":"updateUsConsumerAccountResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"POST","path":"/holdings/us/accounts/businessCheckings","fullPath":"/api/v3.0.0/holdings/us/accounts/businessCheckings","operationId":"createUsBusinessCheckingAccount","name":"Create a new business checking account for the corporate customer","summary":"New business checking account opening API","tags":["RETAIL"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"customerIds":[{}],"properties":[{}],"overrides":[{}],"productId":"string","masterArrangementId":"string","roleName":"string","currencyId":"string","effectiveDate":"2024-01-01","activityId":"string","transactionAmount":0.0,"narrative":"string","reason":"string","extensions":{},"balance":[{}],"messaging":[{}]}},"responses":{"200":"createUsBusinessCheckingAccountResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"PUT","path":"/holdings/us/accounts/{accountId}/businessCheckings","fullPath":"/api/v3.0.0/holdings/us/accounts/{accountId}/businessCheckings","operationId":"updateUsBusinessCheckingAccount","name":"Renegotiate existing business checking account conditions","summary":"Renegotiate business checking account conditions","tags":["RETAIL"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"accountId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"customerIds":[{}],"properties":[{}],"overrides":[{}],"productId":"string","masterArrangementId":"string","roleName":"string","currencyId":"string","effectiveDate":"2024-01-01","activityId":"string","transactionAmount":0.0,"narrative":"string","reason":"string","extensions":{},"balance":[{}],"messaging":[{}]}},"responses":{"200":"updateUsBusinessCheckingAccountResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"POST","path":"/holdings/us/accounts/businessSavings","fullPath":"/api/v3.0.0/holdings/us/accounts/businessSavings","operationId":"createUsBusinessSavingsAccount","name":"Create a new business savings account for the corporate customer","summary":"New business savings account opening API","tags":["RETAIL"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"customerIds":[{}],"properties":[{}],"overrides":[{}],"productId":"string","masterArrangementId":"string","roleName":"string","currencyId":"string","effectiveDate":"2024-01-01","activityId":"string","transactionAmount":0.0,"narrative":"string","reason":"string","extensions":{},"balance":[{}],"messaging":[{}]}},"responses":{"200":"createUsBusinessSavingsAccountResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"PUT","path":"/holdings/us/accounts/{accountId}/businessSavings","fullPath":"/api/v3.0.0/holdings/us/accounts/{accountId}/businessSavings","operationId":"updateUsBusinessSavingsAccount","name":"Renegotiate existing  business savings account conditions","summary":"Renegotiate business savings account conditions","tags":["RETAIL"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"accountId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"customerIds":[{}],"properties":[{}],"overrides":[{}],"productId":"string","masterArrangementId":"string","roleName":"string","currencyId":"string","effectiveDate":"2024-01-01","activityId":"string","transactionAmount":0.0,"narrative":"string","reason":"string","extensions":{},"balance":[{}],"messaging":[{}]}},"responses":{"200":"updateUsBusinessSavingsAccountResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"PUT","path":"/holdings/us/accounts/{accountId}/consumerAccounts/overdrafts/coverages","fullPath":"/api/v3.0.0/holdings/us/accounts/{accountId}/consumerAccounts/overdrafts/coverages","operationId":"updateOverdraftCoverageCode","name":"Updates the overdraft protection option opted by the customer. Overdraft protection options are offered by financial institutions to allow customers to choose if overdraft coverage is required, if transaction causing overdraft can be cleared, the type of balances that can be used to cover the overdraft (shared account balance, overdraft limit etc.) and the type of transactions that can be considered for overdraft coverage (ATM/Check/point of sale transactions etc.)","summary":"Updates the overdraft protection option opted by the customer.","tags":["RETAIL"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"accountId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"customerIds":[{}],"properties":[{}],"overrides":[{}],"productId":"string","masterArrangementId":"string","roleName":"string","currencyId":"string","effectiveDate":"2024-01-01","activityId":"string","transactionAmount":0.0,"narrative":"string","reason":"string","extensions":{},"balanceAvailability":[{}]}},"responses":{"200":"updateOverdraftCoverageCodeResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"GET","path":"/holdings/us/accounts/{accountId}/forcedClosures","fullPath":"/api/v3.0.0/holdings/us/accounts/{accountId}/forcedClosures","operationId":"getForcedClosureStatus","name":"Retrieves the status of the force closure process for an account. ","summary":"Get account force closure status.","tags":["RETAIL"],"parameters":[{"name":"accountId","in":"path","type":"string","required":true,"description":"Identifier of the account. Often referred to as the account number, yet for consistency this is always referred to as accountId. Accepts both IBAN & BBAN"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"ForcedClosureStatusResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"POST","path":"/holdings/us/accounts/{accountId}/consumerAccounts/forcedClosures","fullPath":"/api/v3.0.0/holdings/us/accounts/{accountId}/consumerAccounts/forcedClosures","operationId":"createConsumerAccountForcedClosure","name":"Creates a new request to initiate the process of forcefully closing a consumer account.  This process applies to accounts with credit, zero, or debit balances. The steps involved in this process includes validating the closure and settlement account, posting entry restrictions to the closure account and finally initiating the force closure.","summary":"Initiate force closure process for consumer account.","tags":["RETAIL"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"accountId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"accountId":"string","productId":"string","activityId":"string","customerId":0.0,"customerRole":"string","currencyId":"string","effectiveDate":"2024-01-01","contextName":"string","payoutAccount":"string","override":"string","extensions":{},"balance":[{}]}},"responses":{"200":"createConsumerAccountForcedClosureResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"POST","path":"/holdings/us/accounts/{accountId}/businessCheckings/forcedClosures","fullPath":"/api/v3.0.0/holdings/us/accounts/{accountId}/businessCheckings/forcedClosures","operationId":"createBusinessCheckingForcedClosure","name":"Creates a new request to initiate the process of forcefully closing a business checking account.  This process applies to accounts with credit, zero, or debit balances. The steps involved in this process includes validating the closure and settlement account, posting entry restrictions to the closure account and finally initiating the force closure.","summary":"Initiate force closure process for business checking account.","tags":["RETAIL"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"accountId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"accountId":"string","productId":"string","activityId":"string","customerId":0.0,"customerRole":"string","currencyId":"string","effectiveDate":"2024-01-01","contextName":"string","payoutAccount":"string","override":"string","extensions":{},"balance":[{}]}},"responses":{"200":"createBusinessCheckingForcedClosureResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"POST","path":"/holdings/us/accounts/{accountId}/businessSavings/forcedClosures","fullPath":"/api/v3.0.0/holdings/us/accounts/{accountId}/businessSavings/forcedClosures","operationId":"createBusinessSavingsForcedClosure","name":"Creates a new request to initiate the process of forcefully closing a business savings account.  This process applies to accounts with credit, zero, or debit balances. The steps involved in this process includes validating the closure and settlement account, posting entry restrictions to the closure account and finally initiating the force closure.","summary":"Initiate force closure process for business savings account.","tags":["RETAIL"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"accountId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"accountId":"string","productId":"string","activityId":"string","customerId":0.0,"customerRole":"string","currencyId":"string","effectiveDate":"2024-01-01","contextName":"string","payoutAccount":"string","override":"string","extensions":{},"balance":[{}]}},"responses":{"200":"createBusinessSavingsForcedClosureResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}}]},{"key":"holdings-us-accounts-service-v3.1.0","title":"US Model Bank Management of Accounts","version":"v3.1.0","description":"Create, update account, change account product, retrieve account summary and overview,  statement addresses and list of accounts available for a customer","endpointCount":15,"endpoints":[{"method":"GET","path":"/holdings/us/accounts/{accountId}/balances","fullPath":"/api/v3.1.0/holdings/us/accounts/{accountId}/balances","operationId":"getUsAccountSummary","name":"Retrieves summary level balance information for an account","summary":"Account Summary","tags":["RETAIL"],"parameters":[{"name":"accountId","in":"path","type":"string","required":true,"description":"Identifier of the account. Often referred to as the account number, yet for consistency this is always referred to as accountId. Accepts both IBAN & BBAN"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"UsAccountSummaryResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/us/accounts/{accountId}/addresses","fullPath":"/api/v3.1.0/holdings/us/accounts/{accountId}/addresses","operationId":"getUsStatementAddress","name":"Retrieves address information for the account","summary":"Statement Address","tags":["RETAIL"],"parameters":[{"name":"accountId","in":"path","type":"string","required":true,"description":"Identifier of the account. Often referred to as the account number, yet for consistency this is always referred to as accountId. Accepts both IBAN & BBAN"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"UsStatementAddressResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/us/customers/{customerId}/accounts","fullPath":"/api/v3.1.0/holdings/us/customers/{customerId}/accounts","operationId":"getUsAccountList","name":"Retrieves the available accounts details for a customer.","summary":"Account list","tags":["RETAIL"],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"Identifier of the customer"},{"name":"accountId","in":"query","type":"string","required":false,"description":"Identifier of the account. Often referred to as the account number, yet for consistency this is always referred to as accountId. Accepts both IBAN & BBAN"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"UsAccountListResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/us/accounts/{accountId}/accountOverview","fullPath":"/api/v3.1.0/holdings/us/accounts/{accountId}/accountOverview","operationId":"getUsAccountOverview","name":"Retrieves the account details, balances, due balances, interest earned, RegD and NSF details, etc,.","summary":"Account Overview","tags":["RETAIL"],"parameters":[{"name":"accountId","in":"path","type":"string","required":true,"description":"Identifier of the account. Often referred to as the account number, yet for consistency this is always referred to as accountId. Accepts both IBAN & BBAN"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"UsAccountOverviewResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"POST","path":"/holdings/us/accounts/consumerAccounts","fullPath":"/api/v3.1.0/holdings/us/accounts/consumerAccounts","operationId":"createUsConsumerAccount","name":"Create a new consumer account of type checkings or savings.","summary":"Create a new consumer account ","tags":["RETAIL"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"customerIds":[{}],"properties":[{}],"overrides":[{}],"productId":"string","masterArrangementId":"string","roleName":"string","currencyId":"string","effectiveDate":"2024-01-01","activityId":"string","transactionAmount":0.0,"narrative":"string","reason":"string","branch":"string","lineOfBusiness":"string","extensions":{}}},"responses":{"200":"createUsConsumerAccountResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"PUT","path":"/holdings/us/accounts/{accountId}/consumerAccounts","fullPath":"/api/v3.1.0/holdings/us/accounts/{accountId}/consumerAccounts","operationId":"updateUsConsumerAccount","name":"Modify existing account information like, customer and ownership information, settlement accounts, charges etc,.","summary":"Update consumer Account","tags":["RETAIL"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"accountId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"customerIds":[{}],"properties":[{}],"overrides":[{}],"productId":"string","masterArrangementId":"string","roleName":"string","currencyId":"string","effectiveDate":"2024-01-01","activityId":"string","transactionAmount":0.0,"narrative":"string","reason":"string","branch":"string","lineOfBusiness":"string","extensions":{}}},"responses":{"200":"updateUsConsumerAccountResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"POST","path":"/holdings/us/accounts/businessCheckings","fullPath":"/api/v3.1.0/holdings/us/accounts/businessCheckings","operationId":"createUsBusinessCheckingAccount","name":"Create a new business checking account for the corporate customer","summary":"New business checking account opening API","tags":["RETAIL"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"customerIds":[{}],"properties":[{}],"overrides":[{}],"productId":"string","masterArrangementId":"string","roleName":"string","currencyId":"string","effectiveDate":"2024-01-01","activityId":"string","transactionAmount":0.0,"narrative":"string","reason":"string","branch":"string","lineOfBusiness":"string","extensions":{}}},"responses":{"200":"createUsBusinessCheckingAccountResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"PUT","path":"/holdings/us/accounts/{accountId}/businessCheckings","fullPath":"/api/v3.1.0/holdings/us/accounts/{accountId}/businessCheckings","operationId":"updateUsBusinessCheckingAccount","name":"Renegotiate existing business checking account conditions","summary":"Renegotiate business checking account conditions","tags":["RETAIL"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"accountId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"customerIds":[{}],"properties":[{}],"overrides":[{}],"productId":"string","masterArrangementId":"string","roleName":"string","currencyId":"string","effectiveDate":"2024-01-01","activityId":"string","transactionAmount":0.0,"narrative":"string","reason":"string","branch":"string","lineOfBusiness":"string","extensions":{}}},"responses":{"200":"updateUsBusinessCheckingAccountResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"POST","path":"/holdings/us/accounts/businessSavings","fullPath":"/api/v3.1.0/holdings/us/accounts/businessSavings","operationId":"createUsBusinessSavingsAccount","name":"Create a new business savings account for the corporate customer","summary":"New business savings account opening API","tags":["RETAIL"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"customerIds":[{}],"properties":[{}],"overrides":[{}],"productId":"string","masterArrangementId":"string","roleName":"string","currencyId":"string","effectiveDate":"2024-01-01","activityId":"string","transactionAmount":0.0,"narrative":"string","reason":"string","branch":"string","lineOfBusiness":"string","extensions":{}}},"responses":{"200":"createUsBusinessSavingsAccountResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"PUT","path":"/holdings/us/accounts/{accountId}/businessSavings","fullPath":"/api/v3.1.0/holdings/us/accounts/{accountId}/businessSavings","operationId":"updateUsBusinessSavingsAccount","name":"Renegotiate existing  business savings account conditions","summary":"Renegotiate business savings account conditions","tags":["RETAIL"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"accountId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"customerIds":[{}],"properties":[{}],"overrides":[{}],"productId":"string","masterArrangementId":"string","roleName":"string","currencyId":"string","effectiveDate":"2024-01-01","activityId":"string","transactionAmount":0.0,"narrative":"string","reason":"string","branch":"string","lineOfBusiness":"string","extensions":{}}},"responses":{"200":"updateUsBusinessSavingsAccountResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"PUT","path":"/holdings/us/accounts/{accountId}/consumerAccounts/overdrafts/coverages","fullPath":"/api/v3.1.0/holdings/us/accounts/{accountId}/consumerAccounts/overdrafts/coverages","operationId":"updateOverdraftCoverageCode","name":"Updates the overdraft protection option opted by the customer. Overdraft protection options are offered by financial institutions to allow customers to choose if overdraft coverage is required, if transaction causing overdraft can be cleared, the type of balances that can be used to cover the overdraft (shared account balance, overdraft limit etc.) and the type of transactions that can be considered for overdraft coverage (ATM/Check/point of sale transactions etc.)","summary":"Updates the overdraft protection option opted by the customer.","tags":["RETAIL"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"accountId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"customerIds":[{}],"properties":[{}],"overrides":[{}],"productId":"string","masterArrangementId":"string","roleName":"string","currencyId":"string","effectiveDate":"2024-01-01","activityId":"string","transactionAmount":0.0,"narrative":"string","reason":"string","branch":"string","lineOfBusiness":"string","extensions":{}}},"responses":{"200":"updateOverdraftCoverageCodeResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"GET","path":"/holdings/us/accounts/{accountId}/forcedClosures","fullPath":"/api/v3.1.0/holdings/us/accounts/{accountId}/forcedClosures","operationId":"getForcedClosureStatus","name":"Retrieves the status of the force closure process for an account. ","summary":"Get account force closure status.","tags":["RETAIL"],"parameters":[{"name":"accountId","in":"path","type":"string","required":true,"description":"Identifier of the account. Often referred to as the account number, yet for consistency this is always referred to as accountId. Accepts both IBAN & BBAN"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"ForcedClosureStatusResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"POST","path":"/holdings/us/accounts/{accountId}/consumerAccounts/forcedClosures","fullPath":"/api/v3.1.0/holdings/us/accounts/{accountId}/consumerAccounts/forcedClosures","operationId":"createConsumerAccountForcedClosure","name":"Creates a new request to initiate the process of forcefully closing a consumer account.  This process applies to accounts with credit, zero, or debit balances. The steps involved in this process includes validating the closure and settlement account, posting entry restrictions to the closure account and finally initiating the force closure.","summary":"Initiate force closure process for consumer account.","tags":["RETAIL"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"accountId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"accountId":"string","productId":"string","activityId":"string","customerId":0.0,"customerRole":"string","currencyId":"string","effectiveDate":"2024-01-01","contextName":"string","payoutAccount":"string","override":"string","extensions":{},"balance":[{}]}},"responses":{"200":"createConsumerAccountForcedClosureResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"POST","path":"/holdings/us/accounts/{accountId}/businessCheckings/forcedClosures","fullPath":"/api/v3.1.0/holdings/us/accounts/{accountId}/businessCheckings/forcedClosures","operationId":"createBusinessCheckingForcedClosure","name":"Creates a new request to initiate the process of forcefully closing a business checking account.  This process applies to accounts with credit, zero, or debit balances. The steps involved in this process includes validating the closure and settlement account, posting entry restrictions to the closure account and finally initiating the force closure.","summary":"Initiate force closure process for business checking account.","tags":["RETAIL"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"accountId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"accountId":"string","productId":"string","activityId":"string","customerId":0.0,"customerRole":"string","currencyId":"string","effectiveDate":"2024-01-01","contextName":"string","payoutAccount":"string","override":"string","extensions":{},"balance":[{}]}},"responses":{"200":"createBusinessCheckingForcedClosureResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"POST","path":"/holdings/us/accounts/{accountId}/businessSavings/forcedClosures","fullPath":"/api/v3.1.0/holdings/us/accounts/{accountId}/businessSavings/forcedClosures","operationId":"createBusinessSavingsForcedClosure","name":"Creates a new request to initiate the process of forcefully closing a business savings account.  This process applies to accounts with credit, zero, or debit balances. The steps involved in this process includes validating the closure and settlement account, posting entry restrictions to the closure account and finally initiating the force closure.","summary":"Initiate force closure process for business savings account.","tags":["RETAIL"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"accountId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"accountId":"string","productId":"string","activityId":"string","customerId":0.0,"customerRole":"string","currencyId":"string","effectiveDate":"2024-01-01","contextName":"string","payoutAccount":"string","override":"string","extensions":{},"balance":[{}]}},"responses":{"200":"createBusinessSavingsForcedClosureResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}}]},{"key":"holdings-us-accounts-service-v4.0.0","title":"US Model Bank Management of Accounts","version":"v4.0.0","description":"Create, update account, change account product, retrieve account summary and overview,  statement addresses and list of accounts available for a customer","endpointCount":17,"endpoints":[{"method":"GET","path":"/holdings/us/accounts/{accountId}/balances","fullPath":"/api/v4.0.0/holdings/us/accounts/{accountId}/balances","operationId":"getUsAccountSummary","name":"Retrieves balance information for an account such as available balance, current balance, float balance etc.","summary":"Retrieves the account balance information.","tags":["RETAIL"],"parameters":[{"name":"accountId","in":"path","type":"string","required":true,"description":"Identifier of the account. Often referred to as the account number, yet for consistency this is always referred to as accountId. Accepts both IBAN & BBAN"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"UsAccountSummaryResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/us/accounts/{accountId}/addresses","fullPath":"/api/v4.0.0/holdings/us/accounts/{accountId}/addresses","operationId":"getUsStatementAddress","name":"Retrieves address information for the account","summary":"Statement Address","tags":["RETAIL"],"parameters":[{"name":"accountId","in":"path","type":"string","required":true,"description":"Identifier of the account. Often referred to as the account number, yet for consistency this is always referred to as accountId. Accepts both IBAN & BBAN"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"UsStatementAddressResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/us/customers/{customerId}/accounts","fullPath":"/api/v4.0.0/holdings/us/customers/{customerId}/accounts","operationId":"getUsAccountList","name":"Retrieves the available accounts details for a customer.","summary":"Account list","tags":["RETAIL"],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"Identifier of the customer"},{"name":"accountId","in":"query","type":"string","required":false,"description":"Identifier of the account. Often referred to as the account number, yet for consistency this is always referred to as accountId. Accepts both IBAN & BBAN"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"UsAccountListResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/us/accounts/{accountId}/accountOverview","fullPath":"/api/v4.0.0/holdings/us/accounts/{accountId}/accountOverview","operationId":"getUsAccountOverview","name":"Retrieves the account details, balances, due balances, interest earned, Regulation D and NSF details etc.","summary":"Retrieves the basic details of an account.","tags":["RETAIL"],"parameters":[{"name":"accountId","in":"path","type":"string","required":true,"description":"Identifier of the account. Often referred to as the account number, yet for consistency this is always referred to as accountId. Accepts both IBAN & BBAN"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"UsAccountOverviewResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"POST","path":"/holdings/us/accounts/consumerAccounts","fullPath":"/api/v4.0.0/holdings/us/accounts/consumerAccounts","operationId":"createUsConsumerAccount","name":"Create a new consumer account of type checkings or savings.","summary":"Create a new consumer account ","tags":["RETAIL"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"customerIds":[{}],"properties":[{}],"overrides":[{}],"productId":"string","masterArrangementId":"string","roleName":"string","currencyId":"string","effectiveDate":"2024-01-01","activityId":"string","transactionAmount":0.0,"narrative":"string","reason":"string","branch":"string","lineOfBusiness":"string","extensions":{}}},"responses":{"200":"createUsConsumerAccountResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"PUT","path":"/holdings/us/accounts/{accountId}/consumerAccounts","fullPath":"/api/v4.0.0/holdings/us/accounts/{accountId}/consumerAccounts","operationId":"updateUsConsumerAccount","name":"Modify existing account information like, customer and ownership information, settlement accounts, charges etc,.","summary":"Update consumer Account","tags":["RETAIL"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"accountId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"customerIds":[{}],"properties":[{}],"overrides":[{}],"productId":"string","masterArrangementId":"string","roleName":"string","currencyId":"string","effectiveDate":"2024-01-01","activityId":"string","transactionAmount":0.0,"narrative":"string","reason":"string","branch":"string","lineOfBusiness":"string","extensions":{}}},"responses":{"200":"updateUsConsumerAccountResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"POST","path":"/holdings/us/accounts/businessCheckings","fullPath":"/api/v4.0.0/holdings/us/accounts/businessCheckings","operationId":"createUsBusinessCheckingAccount","name":"Create a new business checking account for the corporate customer","summary":"New business checking account opening API","tags":["RETAIL"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"customerIds":[{}],"properties":[{}],"overrides":[{}],"productId":"string","masterArrangementId":"string","roleName":"string","currencyId":"string","effectiveDate":"2024-01-01","activityId":"string","transactionAmount":0.0,"narrative":"string","reason":"string","branch":"string","lineOfBusiness":"string","extensions":{}}},"responses":{"200":"createUsBusinessCheckingAccountResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"PUT","path":"/holdings/us/accounts/{accountId}/businessCheckings","fullPath":"/api/v4.0.0/holdings/us/accounts/{accountId}/businessCheckings","operationId":"updateUsBusinessCheckingAccount","name":"Renegotiate existing business checking account conditions","summary":"Renegotiate business checking account conditions","tags":["RETAIL"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"accountId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"customerIds":[{}],"properties":[{}],"overrides":[{}],"productId":"string","masterArrangementId":"string","roleName":"string","currencyId":"string","effectiveDate":"2024-01-01","activityId":"string","transactionAmount":0.0,"narrative":"string","reason":"string","branch":"string","lineOfBusiness":"string","extensions":{}}},"responses":{"200":"updateUsBusinessCheckingAccountResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"POST","path":"/holdings/us/accounts/businessSavings","fullPath":"/api/v4.0.0/holdings/us/accounts/businessSavings","operationId":"createUsBusinessSavingsAccount","name":"Create a new business savings account for the corporate customer","summary":"New business savings account opening API","tags":["RETAIL"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"customerIds":[{}],"properties":[{}],"overrides":[{}],"productId":"string","masterArrangementId":"string","roleName":"string","currencyId":"string","effectiveDate":"2024-01-01","activityId":"string","transactionAmount":0.0,"narrative":"string","reason":"string","branch":"string","lineOfBusiness":"string","extensions":{}}},"responses":{"200":"createUsBusinessSavingsAccountResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"PUT","path":"/holdings/us/accounts/{accountId}/businessSavings","fullPath":"/api/v4.0.0/holdings/us/accounts/{accountId}/businessSavings","operationId":"updateUsBusinessSavingsAccount","name":"Renegotiate existing  business savings account conditions","summary":"Renegotiate business savings account conditions","tags":["RETAIL"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"accountId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"customerIds":[{}],"properties":[{}],"overrides":[{}],"productId":"string","masterArrangementId":"string","roleName":"string","currencyId":"string","effectiveDate":"2024-01-01","activityId":"string","transactionAmount":0.0,"narrative":"string","reason":"string","branch":"string","lineOfBusiness":"string","extensions":{}}},"responses":{"200":"updateUsBusinessSavingsAccountResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"PUT","path":"/holdings/us/accounts/{accountId}/consumerAccounts/overdrafts/coverages","fullPath":"/api/v4.0.0/holdings/us/accounts/{accountId}/consumerAccounts/overdrafts/coverages","operationId":"updateOverdraftCoverageCode","name":"Updates the overdraft protection option opted by the customer. Overdraft protection options are offered by financial institutions to allow customers to choose if overdraft coverage is required, if transaction causing overdraft can be cleared, the type of balances that can be used to cover the overdraft (shared account balance, overdraft limit etc.) and the type of transactions that can be considered for overdraft coverage (ATM/Check/point of sale transactions etc.)","summary":"Updates the overdraft protection option opted by the customer.","tags":["RETAIL"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"accountId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"customerIds":[{}],"properties":[{}],"overrides":[{}],"productId":"string","masterArrangementId":"string","roleName":"string","currencyId":"string","effectiveDate":"2024-01-01","activityId":"string","transactionAmount":0.0,"narrative":"string","reason":"string","branch":"string","lineOfBusiness":"string","extensions":{}}},"responses":{"200":"updateOverdraftCoverageCodeResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"GET","path":"/holdings/us/accounts/{accountId}/forcedClosures","fullPath":"/api/v4.0.0/holdings/us/accounts/{accountId}/forcedClosures","operationId":"getForcedClosureStatus","name":"Retrieves the status of the force closure process for an account. ","summary":"Get account force closure status.","tags":["RETAIL"],"parameters":[{"name":"accountId","in":"path","type":"string","required":true,"description":"Identifier of the account. Often referred to as the account number, yet for consistency this is always referred to as accountId. Accepts both IBAN & BBAN"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"ForcedClosureStatusResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"POST","path":"/holdings/us/accounts/{accountId}/consumerAccounts/forcedClosures","fullPath":"/api/v4.0.0/holdings/us/accounts/{accountId}/consumerAccounts/forcedClosures","operationId":"createConsumerAccountForcedClosure","name":"Creates a new request to initiate the process of forcefully closing a consumer account.  This process applies to accounts with credit, zero, or debit balances. The steps involved in this process includes validating the closure and settlement account, posting entry restrictions to the closure account and finally initiating the force closure.","summary":"Initiate force closure process for consumer account.","tags":["RETAIL"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"accountId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"accountId":"string","productId":"string","activityId":"string","customerId":0.0,"customerRole":"string","currencyId":"string","effectiveDate":"2024-01-01","contextName":"string","payoutAccount":"string","override":"string","extensions":{},"balance":[{}]}},"responses":{"200":"createConsumerAccountForcedClosureResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"POST","path":"/holdings/us/accounts/{accountId}/businessCheckings/forcedClosures","fullPath":"/api/v4.0.0/holdings/us/accounts/{accountId}/businessCheckings/forcedClosures","operationId":"createBusinessCheckingForcedClosure","name":"Creates a new request to initiate the process of forcefully closing a business checking account.  This process applies to accounts with credit, zero, or debit balances. The steps involved in this process includes validating the closure and settlement account, posting entry restrictions to the closure account and finally initiating the force closure.","summary":"Initiate force closure process for business checking account.","tags":["RETAIL"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"accountId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"accountId":"string","productId":"string","activityId":"string","customerId":0.0,"customerRole":"string","currencyId":"string","effectiveDate":"2024-01-01","contextName":"string","payoutAccount":"string","override":"string","extensions":{},"balance":[{}]}},"responses":{"200":"createBusinessCheckingForcedClosureResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"POST","path":"/holdings/us/accounts/{accountId}/businessSavings/forcedClosures","fullPath":"/api/v4.0.0/holdings/us/accounts/{accountId}/businessSavings/forcedClosures","operationId":"createBusinessSavingsForcedClosure","name":"Creates a new request to initiate the process of forcefully closing a business savings account.  This process applies to accounts with credit, zero, or debit balances. The steps involved in this process includes validating the closure and settlement account, posting entry restrictions to the closure account and finally initiating the force closure.","summary":"Initiate force closure process for business savings account.","tags":["RETAIL"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"accountId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"accountId":"string","productId":"string","activityId":"string","customerId":0.0,"customerRole":"string","currencyId":"string","effectiveDate":"2024-01-01","contextName":"string","payoutAccount":"string","override":"string","extensions":{},"balance":[{}]}},"responses":{"200":"createBusinessSavingsForcedClosureResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"POST","path":"/holdings/us/coverdellEducationSavings/accounts","fullPath":"/api/v4.0.0/holdings/us/coverdellEducationSavings/accounts","operationId":"createUsCoverdellESA","name":"Allows creation of a new coverdell education savings account.","summary":"Create a new coverdell education savings account.","tags":["RETAIL"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"customerIds":[{}],"properties":[{}],"overrides":[{}],"productId":"string","masterArrangementId":"string","roleName":"string","currencyId":"string","effectiveDate":"2024-01-01","activityId":"string","transactionAmount":0.0,"narrative":"string","reason":"string","branch":"string","lineOfBusiness":"string","extensions":{}}},"responses":{"200":"createUsCoverdellESAResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"PUT","path":"/holdings/us/coverdellEducationSavings/accounts/{accountId}","fullPath":"/api/v4.0.0/holdings/us/coverdellEducationSavings/accounts/{accountId}","operationId":"updateUsCoverdellESA","name":"Modify existing coverdell education savings account information like, payment schedule, settlement accounts, charge etc,.","summary":"Update coverdell education savings account.","tags":["RETAIL"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"accountId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"customerIds":[{}],"properties":[{}],"overrides":[{}],"productId":"string","masterArrangementId":"string","roleName":"string","currencyId":"string","effectiveDate":"2024-01-01","activityId":"string","transactionAmount":0.0,"narrative":"string","reason":"string","branch":"string","lineOfBusiness":"string","extensions":{}}},"responses":{"200":"updateUsCoverdellESAResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}}]},{"key":"holdings-us-accounts-service-v4.1.0","title":"US Model Bank Management of Accounts","version":"v4.1.0","description":"Create, update account, change account product, retrieve account summary and overview,  statement addresses and list of accounts available for a customer","endpointCount":17,"endpoints":[{"method":"GET","path":"/holdings/us/accounts/{accountId}/addresses","fullPath":"/api/v4.1.0/holdings/us/accounts/{accountId}/addresses","operationId":"getUsStatementAddress","name":"Retrieves address information for the account","summary":"Statement Address","tags":["RETAIL"],"parameters":[{"name":"accountId","in":"path","type":"string","required":true,"description":"Identifier of the account. Often referred to as the account number, yet for consistency this is always referred to as accountId. Accepts both IBAN & BBAN"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"UsStatementAddressResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/us/customers/{customerId}/accounts","fullPath":"/api/v4.1.0/holdings/us/customers/{customerId}/accounts","operationId":"getUsAccountList","name":"Retrieves the available accounts details for a customer.","summary":"Account list","tags":["RETAIL"],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"Identifier of the customer"},{"name":"accountId","in":"query","type":"string","required":false,"description":"Identifier of the account. Often referred to as the account number, yet for consistency this is always referred to as accountId. Accepts both IBAN & BBAN"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"UsAccountListResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/us/accounts/{accountId}/accountOverview","fullPath":"/api/v4.1.0/holdings/us/accounts/{accountId}/accountOverview","operationId":"getUsAccountOverview","name":"Retrieves the account details, balances, due balances, interest earned, RegD and NSF details, etc,.","summary":"Account Overview","tags":["RETAIL"],"parameters":[{"name":"accountId","in":"path","type":"string","required":true,"description":"Identifier of the account. Often referred to as the account number, yet for consistency this is always referred to as accountId. Accepts both IBAN & BBAN"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"UsAccountOverviewResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"POST","path":"/holdings/us/accounts/consumerAccounts","fullPath":"/api/v4.1.0/holdings/us/accounts/consumerAccounts","operationId":"createUsConsumerAccount","name":"Create a new consumer account of type checkings or savings.","summary":"Create a new consumer account ","tags":["RETAIL"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"customerIds":[{}],"properties":[{}],"overrides":[{}],"productId":"string","masterArrangementId":"string","roleName":"string","currencyId":"string","effectiveDate":"2024-01-01","activityId":"string","transactionAmount":0.0,"narrative":"string","reason":"string","branch":"string","lineOfBusiness":"string","extensions":{}}},"responses":{"200":"createUsConsumerAccountResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"PUT","path":"/holdings/us/accounts/{accountId}/consumerAccounts","fullPath":"/api/v4.1.0/holdings/us/accounts/{accountId}/consumerAccounts","operationId":"updateUsConsumerAccount","name":"Modify existing account information like, customer and ownership information, settlement accounts, charges etc,.","summary":"Update consumer Account","tags":["RETAIL"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"accountId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"customerIds":[{}],"properties":[{}],"overrides":[{}],"productId":"string","masterArrangementId":"string","roleName":"string","currencyId":"string","effectiveDate":"2024-01-01","activityId":"string","transactionAmount":0.0,"narrative":"string","reason":"string","branch":"string","lineOfBusiness":"string","extensions":{}}},"responses":{"200":"updateUsConsumerAccountResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"POST","path":"/holdings/us/accounts/businessCheckings","fullPath":"/api/v4.1.0/holdings/us/accounts/businessCheckings","operationId":"createUsBusinessCheckingAccount","name":"Create a new business checking account for the corporate customer","summary":"New business checking account opening API","tags":["RETAIL"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"customerIds":[{}],"properties":[{}],"overrides":[{}],"productId":"string","masterArrangementId":"string","roleName":"string","currencyId":"string","effectiveDate":"2024-01-01","activityId":"string","transactionAmount":0.0,"narrative":"string","reason":"string","branch":"string","lineOfBusiness":"string","extensions":{}}},"responses":{"200":"createUsBusinessCheckingAccountResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"PUT","path":"/holdings/us/accounts/{accountId}/businessCheckings","fullPath":"/api/v4.1.0/holdings/us/accounts/{accountId}/businessCheckings","operationId":"updateUsBusinessCheckingAccount","name":"Renegotiate existing business checking account conditions","summary":"Renegotiate business checking account conditions","tags":["RETAIL"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"accountId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"customerIds":[{}],"properties":[{}],"overrides":[{}],"productId":"string","masterArrangementId":"string","roleName":"string","currencyId":"string","effectiveDate":"2024-01-01","activityId":"string","transactionAmount":0.0,"narrative":"string","reason":"string","branch":"string","lineOfBusiness":"string","extensions":{}}},"responses":{"200":"updateUsBusinessCheckingAccountResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"POST","path":"/holdings/us/accounts/businessSavings","fullPath":"/api/v4.1.0/holdings/us/accounts/businessSavings","operationId":"createUsBusinessSavingsAccount","name":"Create a new business savings account for the corporate customer","summary":"New business savings account opening API","tags":["RETAIL"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"customerIds":[{}],"properties":[{}],"overrides":[{}],"productId":"string","masterArrangementId":"string","roleName":"string","currencyId":"string","effectiveDate":"2024-01-01","activityId":"string","transactionAmount":0.0,"narrative":"string","reason":"string","branch":"string","lineOfBusiness":"string","extensions":{}}},"responses":{"200":"createUsBusinessSavingsAccountResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"PUT","path":"/holdings/us/accounts/{accountId}/businessSavings","fullPath":"/api/v4.1.0/holdings/us/accounts/{accountId}/businessSavings","operationId":"updateUsBusinessSavingsAccount","name":"Renegotiate existing  business savings account conditions","summary":"Renegotiate business savings account conditions","tags":["RETAIL"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"accountId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"customerIds":[{}],"properties":[{}],"overrides":[{}],"productId":"string","masterArrangementId":"string","roleName":"string","currencyId":"string","effectiveDate":"2024-01-01","activityId":"string","transactionAmount":0.0,"narrative":"string","reason":"string","branch":"string","lineOfBusiness":"string","extensions":{}}},"responses":{"200":"updateUsBusinessSavingsAccountResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"PUT","path":"/holdings/us/accounts/{accountId}/consumerAccounts/overdrafts/coverages","fullPath":"/api/v4.1.0/holdings/us/accounts/{accountId}/consumerAccounts/overdrafts/coverages","operationId":"updateOverdraftCoverageCode","name":"Updates the overdraft protection option opted by the customer. Overdraft protection options are offered by financial institutions to allow customers to choose if overdraft coverage is required, if transaction causing overdraft can be cleared, the type of balances that can be used to cover the overdraft (shared account balance, overdraft limit etc.) and the type of transactions that can be considered for overdraft coverage (ATM/Check/point of sale transactions etc.)","summary":"Updates the overdraft protection option opted by the customer.","tags":["RETAIL"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"accountId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"customerIds":[{}],"properties":[{}],"overrides":[{}],"productId":"string","masterArrangementId":"string","roleName":"string","currencyId":"string","effectiveDate":"2024-01-01","activityId":"string","transactionAmount":0.0,"narrative":"string","reason":"string","branch":"string","lineOfBusiness":"string","extensions":{}}},"responses":{"200":"updateOverdraftCoverageCodeResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"GET","path":"/holdings/us/accounts/{accountId}/forcedClosures","fullPath":"/api/v4.1.0/holdings/us/accounts/{accountId}/forcedClosures","operationId":"getForcedClosureStatus","name":"Retrieves the status of the force closure process for an account. ","summary":"Get account force closure status.","tags":["RETAIL"],"parameters":[{"name":"accountId","in":"path","type":"string","required":true,"description":"Identifier of the account. Often referred to as the account number, yet for consistency this is always referred to as accountId. Accepts both IBAN & BBAN"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"ForcedClosureStatusResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"POST","path":"/holdings/us/accounts/{accountId}/consumerAccounts/forcedClosures","fullPath":"/api/v4.1.0/holdings/us/accounts/{accountId}/consumerAccounts/forcedClosures","operationId":"createConsumerAccountForcedClosure","name":"Creates a new request to initiate the process of forcefully closing a consumer account.  This process applies to accounts with credit, zero, or debit balances. The steps involved in this process includes validating the closure and settlement account, posting entry restrictions to the closure account and finally initiating the force closure.","summary":"Initiate force closure process for consumer account.","tags":["RETAIL"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"accountId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"accountId":"string","productId":"string","activityId":"string","customerId":0.0,"customerRole":"string","currencyId":"string","effectiveDate":"2024-01-01","contextName":"string","payoutAccount":"string","override":"string","extensions":{},"balance":[{}]}},"responses":{"200":"createConsumerAccountForcedClosureResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"POST","path":"/holdings/us/accounts/{accountId}/businessCheckings/forcedClosures","fullPath":"/api/v4.1.0/holdings/us/accounts/{accountId}/businessCheckings/forcedClosures","operationId":"createBusinessCheckingForcedClosure","name":"Creates a new request to initiate the process of forcefully closing a business checking account.  This process applies to accounts with credit, zero, or debit balances. The steps involved in this process includes validating the closure and settlement account, posting entry restrictions to the closure account and finally initiating the force closure.","summary":"Initiate force closure process for business checking account.","tags":["RETAIL"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"accountId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"accountId":"string","productId":"string","activityId":"string","customerId":0.0,"customerRole":"string","currencyId":"string","effectiveDate":"2024-01-01","contextName":"string","payoutAccount":"string","override":"string","extensions":{},"balance":[{}]}},"responses":{"200":"createBusinessCheckingForcedClosureResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"POST","path":"/holdings/us/accounts/{accountId}/businessSavings/forcedClosures","fullPath":"/api/v4.1.0/holdings/us/accounts/{accountId}/businessSavings/forcedClosures","operationId":"createBusinessSavingsForcedClosure","name":"Creates a new request to initiate the process of forcefully closing a business savings account.  This process applies to accounts with credit, zero, or debit balances. The steps involved in this process includes validating the closure and settlement account, posting entry restrictions to the closure account and finally initiating the force closure.","summary":"Initiate force closure process for business savings account.","tags":["RETAIL"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"accountId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"accountId":"string","productId":"string","activityId":"string","customerId":0.0,"customerRole":"string","currencyId":"string","effectiveDate":"2024-01-01","contextName":"string","payoutAccount":"string","override":"string","extensions":{},"balance":[{}]}},"responses":{"200":"createBusinessSavingsForcedClosureResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"POST","path":"/holdings/us/coverdellEducationSavings/accounts","fullPath":"/api/v4.1.0/holdings/us/coverdellEducationSavings/accounts","operationId":"createUsCoverdellESA","name":"Allows creation of a new coverdell education savings account.","summary":"Create a new coverdell education savings account.","tags":["RETAIL"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"customerIds":[{}],"properties":[{}],"overrides":[{}],"productId":"string","masterArrangementId":"string","roleName":"string","currencyId":"string","effectiveDate":"2024-01-01","activityId":"string","transactionAmount":0.0,"narrative":"string","reason":"string","branch":"string","lineOfBusiness":"string","extensions":{}}},"responses":{"200":"createUsCoverdellESAResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"PUT","path":"/holdings/us/coverdellEducationSavings/accounts/{accountId}","fullPath":"/api/v4.1.0/holdings/us/coverdellEducationSavings/accounts/{accountId}","operationId":"updateUsCoverdellESA","name":"Modify existing coverdell education savings account information like, payment schedule, settlement accounts, charge etc,.","summary":"Update coverdell education savings account.","tags":["RETAIL"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"accountId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"customerIds":[{}],"properties":[{}],"overrides":[{}],"productId":"string","masterArrangementId":"string","roleName":"string","currencyId":"string","effectiveDate":"2024-01-01","activityId":"string","transactionAmount":0.0,"narrative":"string","reason":"string","branch":"string","lineOfBusiness":"string","extensions":{}}},"responses":{"200":"updateUsCoverdellESAResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"GET","path":"/holdings/us/accounts/{accountId}/balances","fullPath":"/api/v4.1.0/holdings/us/accounts/{accountId}/balances","operationId":"getUSAccountSummary","name":"Retrieves summary level balance information for an account","summary":"Account Summary","tags":["RETAIL"],"parameters":[{"name":"accountId","in":"path","type":"string","required":true,"description":"Identifier of the account. Often referred to as the account number, yet for consistency this is always referred to as accountId. Accepts both IBAN & BBAN"},{"name":"enquiryParameterDescription","in":"query","type":"string","required":false,"description":"Describes the enquiry parameter record settings which allows to input the additional dynamic field name ,label and type for the enquiry output display to be exposed for the enquiry output"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"USAccountSummaryResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}}]},{"key":"holdings-us-accounts-service-v5.0.0","title":"US Model Bank Management of Accounts","version":"v5.0.0","description":"Create, update account, change account product, retrieve account summary and overview,  statement addresses and list of accounts available for a customer","endpointCount":19,"endpoints":[{"method":"GET","path":"/holdings/us/accounts/{accountId}/addresses","fullPath":"/api/v5.0.0/holdings/us/accounts/{accountId}/addresses","operationId":"getUsStatementAddress","name":"Retrieves address information for the account","summary":"Statement Address","tags":["RETAIL"],"parameters":[{"name":"accountId","in":"path","type":"string","required":true,"description":"Identifier of the account. Often referred to as the account number, yet for consistency this is always referred to as accountId. Accepts both IBAN & BBAN"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"UsStatementAddressResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/us/customers/{customerId}/accounts","fullPath":"/api/v5.0.0/holdings/us/customers/{customerId}/accounts","operationId":"getUsAccountList","name":"Retrieves the available accounts details for a customer.","summary":"Account list","tags":["RETAIL"],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"Identifier of the customer"},{"name":"accountId","in":"query","type":"string","required":false,"description":"Identifier of the account. Often referred to as the account number, yet for consistency this is always referred to as accountId. Accepts both IBAN & BBAN"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"UsAccountListResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/us/accounts/{accountId}/accountOverview","fullPath":"/api/v5.0.0/holdings/us/accounts/{accountId}/accountOverview","operationId":"getUsAccountOverview","name":"Retrieves the account details, balances, due balances, interest earned, RegD and NSF details, etc,.","summary":"Account Overview","tags":["RETAIL"],"parameters":[{"name":"accountId","in":"path","type":"string","required":true,"description":"Identifier of the account. Often referred to as the account number, yet for consistency this is always referred to as accountId. Accepts both IBAN & BBAN"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"UsAccountOverviewResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"POST","path":"/holdings/us/accounts/consumerAccounts","fullPath":"/api/v5.0.0/holdings/us/accounts/consumerAccounts","operationId":"createUsConsumerAccount","name":"Create a new consumer account of type checkings or savings.","summary":"Create a new consumer account ","tags":["RETAIL"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"customerIds":[{}],"properties":[{}],"overrides":[{}],"productId":"string","masterArrangementId":"string","roleName":"string","currencyId":"string","effectiveDate":"2024-01-01","activityId":"string","transactionAmount":0.0,"narrative":"string","reason":"string","branch":"string","lineOfBusiness":"string","extensions":{}}},"responses":{"200":"createUsConsumerAccountResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"PUT","path":"/holdings/us/accounts/{accountId}/consumerAccounts","fullPath":"/api/v5.0.0/holdings/us/accounts/{accountId}/consumerAccounts","operationId":"updateUsConsumerAccount","name":"Modify existing account information like, customer and ownership information, settlement accounts, charges etc,.","summary":"Update consumer Account","tags":["RETAIL"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"accountId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"customerIds":[{}],"properties":[{}],"overrides":[{}],"productId":"string","masterArrangementId":"string","roleName":"string","currencyId":"string","effectiveDate":"2024-01-01","activityId":"string","transactionAmount":0.0,"narrative":"string","reason":"string","branch":"string","lineOfBusiness":"string","extensions":{}}},"responses":{"200":"updateUsConsumerAccountResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"POST","path":"/holdings/us/accounts/businessCheckings","fullPath":"/api/v5.0.0/holdings/us/accounts/businessCheckings","operationId":"createUsBusinessCheckingAccount","name":"Create a new business checking account for the corporate customer","summary":"New business checking account opening API","tags":["RETAIL"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"customerIds":[{}],"properties":[{}],"overrides":[{}],"productId":"string","masterArrangementId":"string","roleName":"string","currencyId":"string","effectiveDate":"2024-01-01","activityId":"string","transactionAmount":0.0,"narrative":"string","reason":"string","branch":"string","lineOfBusiness":"string","extensions":{}}},"responses":{"200":"createUsBusinessCheckingAccountResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"PUT","path":"/holdings/us/accounts/{accountId}/businessCheckings","fullPath":"/api/v5.0.0/holdings/us/accounts/{accountId}/businessCheckings","operationId":"updateUsBusinessCheckingAccount","name":"Renegotiate existing business checking account conditions","summary":"Renegotiate business checking account conditions","tags":["RETAIL"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"accountId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"customerIds":[{}],"properties":[{}],"overrides":[{}],"productId":"string","masterArrangementId":"string","roleName":"string","currencyId":"string","effectiveDate":"2024-01-01","activityId":"string","transactionAmount":0.0,"narrative":"string","reason":"string","branch":"string","lineOfBusiness":"string","extensions":{}}},"responses":{"200":"updateUsBusinessCheckingAccountResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"POST","path":"/holdings/us/accounts/businessSavings","fullPath":"/api/v5.0.0/holdings/us/accounts/businessSavings","operationId":"createUsBusinessSavingsAccount","name":"Create a new business savings account for the corporate customer","summary":"New business savings account opening API","tags":["RETAIL"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"customerIds":[{}],"properties":[{}],"overrides":[{}],"productId":"string","masterArrangementId":"string","roleName":"string","currencyId":"string","effectiveDate":"2024-01-01","activityId":"string","transactionAmount":0.0,"narrative":"string","reason":"string","branch":"string","lineOfBusiness":"string","extensions":{}}},"responses":{"200":"createUsBusinessSavingsAccountResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"PUT","path":"/holdings/us/accounts/{accountId}/businessSavings","fullPath":"/api/v5.0.0/holdings/us/accounts/{accountId}/businessSavings","operationId":"updateUsBusinessSavingsAccount","name":"Renegotiate existing  business savings account conditions","summary":"Renegotiate business savings account conditions","tags":["RETAIL"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"accountId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"customerIds":[{}],"properties":[{}],"overrides":[{}],"productId":"string","masterArrangementId":"string","roleName":"string","currencyId":"string","effectiveDate":"2024-01-01","activityId":"string","transactionAmount":0.0,"narrative":"string","reason":"string","branch":"string","lineOfBusiness":"string","extensions":{}}},"responses":{"200":"updateUsBusinessSavingsAccountResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"PUT","path":"/holdings/us/accounts/{accountId}/consumerAccounts/overdrafts/coverages","fullPath":"/api/v5.0.0/holdings/us/accounts/{accountId}/consumerAccounts/overdrafts/coverages","operationId":"updateOverdraftCoverageCode","name":"Updates the overdraft protection option opted by the customer. Overdraft protection options are offered by financial institutions to allow customers to choose if overdraft coverage is required, if transaction causing overdraft can be cleared, the type of balances that can be used to cover the overdraft (shared account balance, overdraft limit etc.) and the type of transactions that can be considered for overdraft coverage (ATM/Check/point of sale transactions etc.)","summary":"Updates the overdraft protection option opted by the customer.","tags":["RETAIL"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"accountId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"customerIds":[{}],"properties":[{}],"overrides":[{}],"productId":"string","masterArrangementId":"string","roleName":"string","currencyId":"string","effectiveDate":"2024-01-01","activityId":"string","transactionAmount":0.0,"narrative":"string","reason":"string","branch":"string","lineOfBusiness":"string","extensions":{}}},"responses":{"200":"updateOverdraftCoverageCodeResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"GET","path":"/holdings/us/accounts/{accountId}/forcedClosures","fullPath":"/api/v5.0.0/holdings/us/accounts/{accountId}/forcedClosures","operationId":"getForcedClosureStatus","name":"Retrieves the status of the force closure process for an account. ","summary":"Get account force closure status.","tags":["RETAIL"],"parameters":[{"name":"accountId","in":"path","type":"string","required":true,"description":"Identifier of the account. Often referred to as the account number, yet for consistency this is always referred to as accountId. Accepts both IBAN & BBAN"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"ForcedClosureStatusResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"POST","path":"/holdings/us/accounts/{accountId}/consumerAccounts/forcedClosures","fullPath":"/api/v5.0.0/holdings/us/accounts/{accountId}/consumerAccounts/forcedClosures","operationId":"createConsumerAccountForcedClosure","name":"Creates a new request to initiate the process of forcefully closing a consumer account.  This process applies to accounts with credit, zero, or debit balances. The steps involved in this process includes validating the closure and settlement account, posting entry restrictions to the closure account and finally initiating the force closure.","summary":"Initiate force closure process for consumer account.","tags":["RETAIL"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"accountId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"accountId":"string","productId":"string","activityId":"string","customerId":0.0,"customerRole":"string","currencyId":"string","effectiveDate":"2024-01-01","contextName":"string","payoutAccount":"string","override":"string","extensions":{},"balance":[{}]}},"responses":{"200":"createConsumerAccountForcedClosureResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"POST","path":"/holdings/us/accounts/{accountId}/businessCheckings/forcedClosures","fullPath":"/api/v5.0.0/holdings/us/accounts/{accountId}/businessCheckings/forcedClosures","operationId":"createBusinessCheckingForcedClosure","name":"Creates a new request to initiate the process of forcefully closing a business checking account.  This process applies to accounts with credit, zero, or debit balances. The steps involved in this process includes validating the closure and settlement account, posting entry restrictions to the closure account and finally initiating the force closure.","summary":"Initiate force closure process for business checking account.","tags":["RETAIL"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"accountId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"accountId":"string","productId":"string","activityId":"string","customerId":0.0,"customerRole":"string","currencyId":"string","effectiveDate":"2024-01-01","contextName":"string","payoutAccount":"string","override":"string","extensions":{},"balance":[{}]}},"responses":{"200":"createBusinessCheckingForcedClosureResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"POST","path":"/holdings/us/accounts/{accountId}/businessSavings/forcedClosures","fullPath":"/api/v5.0.0/holdings/us/accounts/{accountId}/businessSavings/forcedClosures","operationId":"createBusinessSavingsForcedClosure","name":"Creates a new request to initiate the process of forcefully closing a business savings account.  This process applies to accounts with credit, zero, or debit balances. The steps involved in this process includes validating the closure and settlement account, posting entry restrictions to the closure account and finally initiating the force closure.","summary":"Initiate force closure process for business savings account.","tags":["RETAIL"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"accountId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"accountId":"string","productId":"string","activityId":"string","customerId":0.0,"customerRole":"string","currencyId":"string","effectiveDate":"2024-01-01","contextName":"string","payoutAccount":"string","override":"string","extensions":{},"balance":[{}]}},"responses":{"200":"createBusinessSavingsForcedClosureResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"POST","path":"/holdings/us/coverdellEducationSavings/accounts","fullPath":"/api/v5.0.0/holdings/us/coverdellEducationSavings/accounts","operationId":"createUsCoverdellESA","name":"Allows creation of a new coverdell education savings account.","summary":"Create a new coverdell education savings account.","tags":["RETAIL"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"customerIds":[{}],"properties":[{}],"overrides":[{}],"productId":"string","masterArrangementId":"string","roleName":"string","currencyId":"string","effectiveDate":"2024-01-01","activityId":"string","transactionAmount":0.0,"narrative":"string","reason":"string","branch":"string","lineOfBusiness":"string","extensions":{}}},"responses":{"200":"createUsCoverdellESAResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"PUT","path":"/holdings/us/coverdellEducationSavings/accounts/{accountId}","fullPath":"/api/v5.0.0/holdings/us/coverdellEducationSavings/accounts/{accountId}","operationId":"updateUsCoverdellESA","name":"Modify existing coverdell education savings account information like, payment schedule, settlement accounts, charge etc,.","summary":"Update coverdell education savings account.","tags":["RETAIL"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"accountId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"customerIds":[{}],"properties":[{}],"overrides":[{}],"productId":"string","masterArrangementId":"string","roleName":"string","currencyId":"string","effectiveDate":"2024-01-01","activityId":"string","transactionAmount":0.0,"narrative":"string","reason":"string","branch":"string","lineOfBusiness":"string","extensions":{}}},"responses":{"200":"updateUsCoverdellESAResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"GET","path":"/holdings/us/accounts/{accountId}/balances","fullPath":"/api/v5.0.0/holdings/us/accounts/{accountId}/balances","operationId":"getUSAccountSummary","name":"Retrieves summary level balance information for an account","summary":"Account Summary","tags":["RETAIL"],"parameters":[{"name":"accountId","in":"path","type":"string","required":true,"description":"Identifier of the account. Often referred to as the account number, yet for consistency this is always referred to as accountId. Accepts both IBAN & BBAN"},{"name":"enquiryParameterDescription","in":"query","type":"string","required":false,"description":"Describes the enquiry parameter record settings which allows to input the additional dynamic field name ,label and type for the enquiry output display to be exposed for the enquiry output"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"USAccountSummaryResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/us/retirementSavings/accounts/{accountId}/contributions","fullPath":"/api/v5.0.0/holdings/us/retirementSavings/accounts/{accountId}/contributions","operationId":"getIraContributions","name":"Retrieve additional information regarding the contribution (funds deposited) made towards IRA (Individual Retirement Account) accounts and deposits","summary":"Retrieve contributions for IRA (Individual Retirement Account) accounts and deposits","tags":["RETAIL"],"parameters":[{"name":"accountId","in":"path","type":"string","required":true,"description":"Identifier of the account. Often referred to as the account number, yet for consistency this is always referred to as accountId. Accepts both IBAN & BBAN"},{"name":"period","in":"query","type":"string","required":false,"description":"Indicates spread of time buckets.Ex: 3M,6M,9M,10Y etc."},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"IraContributionsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/us/retirementSavings/accounts/{accountId}/distributions","fullPath":"/api/v5.0.0/holdings/us/retirementSavings/accounts/{accountId}/distributions","operationId":"getIraDistributions","name":"Retrieve additional information regarding the distributions (funds withdrawn) from IRA (Individual Retirement Account) accounts and deposits","summary":"Retrieve distributions for IRA (Individual Retirement Account) accounts and deposits","tags":["RETAIL"],"parameters":[{"name":"accountId","in":"path","type":"string","required":true,"description":"Identifier of the account. Often referred to as the account number, yet for consistency this is always referred to as accountId. Accepts both IBAN & BBAN"},{"name":"period","in":"query","type":"string","required":false,"description":"Indicates spread of time buckets.Ex: 3M,6M,9M,10Y etc."},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"IraDistributionsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}}]},{"key":"holdings-us-accounts-service-v6.0.0","title":"US Model Bank Management of Accounts","version":"v6.0.0","description":"Create, update account, change account product, retrieve account summary and overview,  statement addresses and list of accounts available for a customer","endpointCount":20,"endpoints":[{"method":"GET","path":"/holdings/us/accounts/{accountId}/addresses","fullPath":"/api/v6.0.0/holdings/us/accounts/{accountId}/addresses","operationId":"getUsStatementAddress","name":"Retrieves address information for the account","summary":"Statement Address","tags":["RETAIL"],"parameters":[{"name":"accountId","in":"path","type":"string","required":true,"description":"Identifier of the account. Often referred to as the account number, yet for consistency this is always referred to as accountId. Accepts both IBAN & BBAN"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"UsStatementAddressResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/us/customers/{customerId}/accounts","fullPath":"/api/v6.0.0/holdings/us/customers/{customerId}/accounts","operationId":"getUsAccountList","name":"Retrieves the available accounts details for a customer.","summary":"Account list","tags":["RETAIL"],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"Identifier of the customer"},{"name":"accountId","in":"query","type":"string","required":false,"description":"Identifier of the account. Often referred to as the account number, yet for consistency this is always referred to as accountId. Accepts both IBAN & BBAN"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"UsAccountListResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/us/accounts/{accountId}/accountOverview","fullPath":"/api/v6.0.0/holdings/us/accounts/{accountId}/accountOverview","operationId":"getUsAccountOverview","name":"Retrieves the account details, balances, due balances, interest earned, RegD and NSF details, etc,.","summary":"Account Overview","tags":["RETAIL"],"parameters":[{"name":"accountId","in":"path","type":"string","required":true,"description":"Identifier of the account. Often referred to as the account number, yet for consistency this is always referred to as accountId. Accepts both IBAN & BBAN"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"UsAccountOverviewResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"POST","path":"/holdings/us/accounts/consumerAccounts","fullPath":"/api/v6.0.0/holdings/us/accounts/consumerAccounts","operationId":"createUsConsumerAccount","name":"Create a new consumer account of type checkings or savings.","summary":"Create a new consumer account ","tags":["RETAIL"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"customerIds":[{}],"properties":[{}],"overrides":[{}],"productId":"string","masterArrangementId":"string","roleName":"string","currencyId":"string","effectiveDate":"2024-01-01","activityId":"string","transactionAmount":0.0,"narrative":"string","reason":"string","branch":"string","lineOfBusiness":"string","extensions":{}}},"responses":{"200":"createUsConsumerAccountResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"PUT","path":"/holdings/us/accounts/{accountId}/consumerAccounts","fullPath":"/api/v6.0.0/holdings/us/accounts/{accountId}/consumerAccounts","operationId":"updateUsConsumerAccount","name":"Modify existing account information like, customer and ownership information, settlement accounts, charges etc,.","summary":"Update consumer Account","tags":["RETAIL"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"accountId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"customerIds":[{}],"properties":[{}],"overrides":[{}],"productId":"string","masterArrangementId":"string","roleName":"string","currencyId":"string","effectiveDate":"2024-01-01","activityId":"string","transactionAmount":0.0,"narrative":"string","reason":"string","branch":"string","lineOfBusiness":"string","extensions":{}}},"responses":{"200":"updateUsConsumerAccountResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"POST","path":"/holdings/us/accounts/businessCheckings","fullPath":"/api/v6.0.0/holdings/us/accounts/businessCheckings","operationId":"createUsBusinessCheckingAccount","name":"Create a new business checking account for the corporate customer","summary":"New business checking account opening API","tags":["RETAIL"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"customerIds":[{}],"properties":[{}],"overrides":[{}],"productId":"string","masterArrangementId":"string","roleName":"string","currencyId":"string","effectiveDate":"2024-01-01","activityId":"string","transactionAmount":0.0,"narrative":"string","reason":"string","branch":"string","lineOfBusiness":"string","extensions":{}}},"responses":{"200":"createUsBusinessCheckingAccountResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"PUT","path":"/holdings/us/accounts/{accountId}/businessCheckings","fullPath":"/api/v6.0.0/holdings/us/accounts/{accountId}/businessCheckings","operationId":"updateUsBusinessCheckingAccount","name":"Renegotiate existing business checking account conditions","summary":"Renegotiate business checking account conditions","tags":["RETAIL"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"accountId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"customerIds":[{}],"properties":[{}],"overrides":[{}],"productId":"string","masterArrangementId":"string","roleName":"string","currencyId":"string","effectiveDate":"2024-01-01","activityId":"string","transactionAmount":0.0,"narrative":"string","reason":"string","branch":"string","lineOfBusiness":"string","extensions":{}}},"responses":{"200":"updateUsBusinessCheckingAccountResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"POST","path":"/holdings/us/accounts/businessSavings","fullPath":"/api/v6.0.0/holdings/us/accounts/businessSavings","operationId":"createUsBusinessSavingsAccount","name":"Create a new business savings account for the corporate customer","summary":"New business savings account opening API","tags":["RETAIL"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"customerIds":[{}],"properties":[{}],"overrides":[{}],"productId":"string","masterArrangementId":"string","roleName":"string","currencyId":"string","effectiveDate":"2024-01-01","activityId":"string","transactionAmount":0.0,"narrative":"string","reason":"string","branch":"string","lineOfBusiness":"string","extensions":{}}},"responses":{"200":"createUsBusinessSavingsAccountResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"PUT","path":"/holdings/us/accounts/{accountId}/businessSavings","fullPath":"/api/v6.0.0/holdings/us/accounts/{accountId}/businessSavings","operationId":"updateUsBusinessSavingsAccount","name":"Renegotiate existing  business savings account conditions","summary":"Renegotiate business savings account conditions","tags":["RETAIL"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"accountId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"customerIds":[{}],"properties":[{}],"overrides":[{}],"productId":"string","masterArrangementId":"string","roleName":"string","currencyId":"string","effectiveDate":"2024-01-01","activityId":"string","transactionAmount":0.0,"narrative":"string","reason":"string","branch":"string","lineOfBusiness":"string","extensions":{}}},"responses":{"200":"updateUsBusinessSavingsAccountResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"PUT","path":"/holdings/us/accounts/{accountId}/consumerAccounts/overdrafts/coverages","fullPath":"/api/v6.0.0/holdings/us/accounts/{accountId}/consumerAccounts/overdrafts/coverages","operationId":"updateOverdraftCoverageCode","name":"Updates the overdraft protection option opted by the customer. Overdraft protection options are offered by financial institutions to allow customers to choose if overdraft coverage is required, if transaction causing overdraft can be cleared, the type of balances that can be used to cover the overdraft (shared account balance, overdraft limit etc.) and the type of transactions that can be considered for overdraft coverage (ATM/Check/point of sale transactions etc.)","summary":"Updates the overdraft protection option opted by the customer.","tags":["RETAIL"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"accountId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"customerIds":[{}],"properties":[{}],"overrides":[{}],"productId":"string","masterArrangementId":"string","roleName":"string","currencyId":"string","effectiveDate":"2024-01-01","activityId":"string","transactionAmount":0.0,"narrative":"string","reason":"string","branch":"string","lineOfBusiness":"string","extensions":{}}},"responses":{"200":"updateOverdraftCoverageCodeResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"GET","path":"/holdings/us/accounts/{accountId}/forcedClosures","fullPath":"/api/v6.0.0/holdings/us/accounts/{accountId}/forcedClosures","operationId":"getForcedClosureStatus","name":"Retrieves the status of the force closure process for an account. ","summary":"Get account force closure status.","tags":["RETAIL"],"parameters":[{"name":"accountId","in":"path","type":"string","required":true,"description":"Identifier of the account. Often referred to as the account number, yet for consistency this is always referred to as accountId. Accepts both IBAN & BBAN"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"ForcedClosureStatusResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"POST","path":"/holdings/us/accounts/{accountId}/consumerAccounts/forcedClosures","fullPath":"/api/v6.0.0/holdings/us/accounts/{accountId}/consumerAccounts/forcedClosures","operationId":"createConsumerAccountForcedClosure","name":"Creates a new request to initiate the process of forcefully closing a consumer account.  This process applies to accounts with credit, zero, or debit balances. The steps involved in this process includes validating the closure and settlement account, posting entry restrictions to the closure account and finally initiating the force closure.","summary":"Initiate force closure process for consumer account.","tags":["RETAIL"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"accountId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"accountId":"string","productId":"string","activityId":"string","customerId":0.0,"customerRole":"string","currencyId":"string","effectiveDate":"2024-01-01","contextName":"string","payoutAccount":"string","override":"string","extensions":{},"balance":[{}]}},"responses":{"200":"createConsumerAccountForcedClosureResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"POST","path":"/holdings/us/accounts/{accountId}/businessCheckings/forcedClosures","fullPath":"/api/v6.0.0/holdings/us/accounts/{accountId}/businessCheckings/forcedClosures","operationId":"createBusinessCheckingForcedClosure","name":"Creates a new request to initiate the process of forcefully closing a business checking account.  This process applies to accounts with credit, zero, or debit balances. The steps involved in this process includes validating the closure and settlement account, posting entry restrictions to the closure account and finally initiating the force closure.","summary":"Initiate force closure process for business checking account.","tags":["RETAIL"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"accountId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"accountId":"string","productId":"string","activityId":"string","customerId":0.0,"customerRole":"string","currencyId":"string","effectiveDate":"2024-01-01","contextName":"string","payoutAccount":"string","override":"string","extensions":{},"balance":[{}]}},"responses":{"200":"createBusinessCheckingForcedClosureResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"POST","path":"/holdings/us/accounts/{accountId}/businessSavings/forcedClosures","fullPath":"/api/v6.0.0/holdings/us/accounts/{accountId}/businessSavings/forcedClosures","operationId":"createBusinessSavingsForcedClosure","name":"Creates a new request to initiate the process of forcefully closing a business savings account.  This process applies to accounts with credit, zero, or debit balances. The steps involved in this process includes validating the closure and settlement account, posting entry restrictions to the closure account and finally initiating the force closure.","summary":"Initiate force closure process for business savings account.","tags":["RETAIL"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"accountId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"accountId":"string","productId":"string","activityId":"string","customerId":0.0,"customerRole":"string","currencyId":"string","effectiveDate":"2024-01-01","contextName":"string","payoutAccount":"string","override":"string","extensions":{},"balance":[{}]}},"responses":{"200":"createBusinessSavingsForcedClosureResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"POST","path":"/holdings/us/coverdellEducationSavings/accounts","fullPath":"/api/v6.0.0/holdings/us/coverdellEducationSavings/accounts","operationId":"createUsCoverdellESA","name":"Allows creation of a new coverdell education savings account.","summary":"Create a new coverdell education savings account.","tags":["RETAIL"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"customerIds":[{}],"properties":[{}],"overrides":[{}],"productId":"string","masterArrangementId":"string","roleName":"string","currencyId":"string","effectiveDate":"2024-01-01","activityId":"string","transactionAmount":0.0,"narrative":"string","reason":"string","branch":"string","lineOfBusiness":"string","extensions":{}}},"responses":{"200":"createUsCoverdellESAResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"PUT","path":"/holdings/us/coverdellEducationSavings/accounts/{accountId}","fullPath":"/api/v6.0.0/holdings/us/coverdellEducationSavings/accounts/{accountId}","operationId":"updateUsCoverdellESA","name":"Modify existing coverdell education savings account information like, payment schedule, settlement accounts, charge etc,.","summary":"Update coverdell education savings account.","tags":["RETAIL"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"accountId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"customerIds":[{}],"properties":[{}],"overrides":[{}],"productId":"string","masterArrangementId":"string","roleName":"string","currencyId":"string","effectiveDate":"2024-01-01","activityId":"string","transactionAmount":0.0,"narrative":"string","reason":"string","branch":"string","lineOfBusiness":"string","extensions":{}}},"responses":{"200":"updateUsCoverdellESAResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"GET","path":"/holdings/us/accounts/{accountId}/balances","fullPath":"/api/v6.0.0/holdings/us/accounts/{accountId}/balances","operationId":"getUSAccountSummary","name":"Retrieves summary level balance information for an account","summary":"Account Summary","tags":["RETAIL"],"parameters":[{"name":"accountId","in":"path","type":"string","required":true,"description":"Identifier of the account. Often referred to as the account number, yet for consistency this is always referred to as accountId. Accepts both IBAN & BBAN"},{"name":"enquiryParameterDescription","in":"query","type":"string","required":false,"description":"Describes the enquiry parameter record settings which allows to input the additional dynamic field name ,label and type for the enquiry output display to be exposed for the enquiry output"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"USAccountSummaryResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/us/retirementSavings/accounts/{accountId}/contributions","fullPath":"/api/v6.0.0/holdings/us/retirementSavings/accounts/{accountId}/contributions","operationId":"getIraContributions","name":"Retrieve additional information regarding the contribution (funds deposited) made towards IRA (Individual Retirement Account) accounts and deposits","summary":"Retrieve contributions for IRA (Individual Retirement Account) accounts and deposits","tags":["RETAIL"],"parameters":[{"name":"accountId","in":"path","type":"string","required":true,"description":"Identifier of the account. Often referred to as the account number, yet for consistency this is always referred to as accountId. Accepts both IBAN & BBAN"},{"name":"period","in":"query","type":"string","required":false,"description":"Indicates spread of time buckets.Ex: 3M,6M,9M,10Y etc."},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"IraContributionsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/us/retirementSavings/accounts/{accountId}/distributions","fullPath":"/api/v6.0.0/holdings/us/retirementSavings/accounts/{accountId}/distributions","operationId":"getIraDistributions","name":"Retrieve additional information regarding the distributions (funds withdrawn) from IRA (Individual Retirement Account) accounts and deposits","summary":"Retrieve distributions for IRA (Individual Retirement Account) accounts and deposits","tags":["RETAIL"],"parameters":[{"name":"accountId","in":"path","type":"string","required":true,"description":"Identifier of the account. Often referred to as the account number, yet for consistency this is always referred to as accountId. Accepts both IBAN & BBAN"},{"name":"period","in":"query","type":"string","required":false,"description":"Indicates spread of time buckets.Ex: 3M,6M,9M,10Y etc."},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"IraDistributionsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/us/accounts/retirementSavings","fullPath":"/api/v6.0.0/holdings/us/accounts/retirementSavings","operationId":"getIRAccountDetails","name":"Retrieve accounts details for IRA(Individual Retirement Account). This is used to retrieve details of different types of IRA plan types such as Simple, Traditional, SEP, Roth, Inherited IRA","summary":"Retrieve accounts details for IRA(Individual Retirement Account)","tags":["RETAIL"],"parameters":[{"name":"accountId","in":"query","type":"string","required":false,"description":"Identifier of the account. Often referred to as the account number, yet for consistency this is always referred to as accountId. Accepts both IBAN & BBAN"},{"name":"customerId","in":"query","type":"string","required":false,"description":"Identifier of the customer"},{"name":"planType","in":"query","type":"string","required":false,"description":"Contains the type of registered plans. Example - RRSP-REG, RRIF-REG, TFSA, etc"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"IRAccountDetailsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}}]},{"key":"holdings-us-accounts-service-v6.2.0","title":"US Model Bank Management of Accounts","version":"v6.2.0","description":"Create, update account, change account product, retrieve account summary and overview,  statement addresses and list of accounts available for a customer","endpointCount":20,"endpoints":[{"method":"GET","path":"/holdings/us/accounts/{accountId}/addresses","fullPath":"/api/v6.2.0/holdings/us/accounts/{accountId}/addresses","operationId":"getUsStatementAddress","name":"Retrieves address information for the account","summary":"Statement Address","tags":["RETAIL"],"parameters":[{"name":"accountId","in":"path","type":"string","required":true,"description":"Identifier of the account. Often referred to as the account number, yet for consistency this is always referred to as accountId. Accepts both IBAN & BBAN"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"UsStatementAddressResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/us/customers/{customerId}/accounts","fullPath":"/api/v6.2.0/holdings/us/customers/{customerId}/accounts","operationId":"getUsAccountList","name":"Retrieves the available accounts details for a customer.","summary":"Account list","tags":["RETAIL"],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"Identifier of the customer"},{"name":"accountId","in":"query","type":"string","required":false,"description":"Identifier of the account. Often referred to as the account number, yet for consistency this is always referred to as accountId. Accepts both IBAN & BBAN"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"UsAccountListResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"POST","path":"/holdings/us/accounts/consumerAccounts","fullPath":"/api/v6.2.0/holdings/us/accounts/consumerAccounts","operationId":"createUsConsumerAccount","name":"Create a new consumer account of type checkings or savings.","summary":"Create a new consumer account ","tags":["RETAIL"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"customerIds":[{}],"properties":[{}],"overrides":[{}],"productId":"string","masterArrangementId":"string","roleName":"string","currencyId":"string","effectiveDate":"2024-01-01","activityId":"string","transactionAmount":0.0,"narrative":"string","reason":"string","branch":"string","lineOfBusiness":"string","extensions":{}}},"responses":{"200":"createUsConsumerAccountResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"PUT","path":"/holdings/us/accounts/{accountId}/consumerAccounts","fullPath":"/api/v6.2.0/holdings/us/accounts/{accountId}/consumerAccounts","operationId":"updateUsConsumerAccount","name":"Modify existing account information like, customer and ownership information, settlement accounts, charges etc,.","summary":"Update consumer Account","tags":["RETAIL"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"accountId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"customerIds":[{}],"properties":[{}],"overrides":[{}],"productId":"string","masterArrangementId":"string","roleName":"string","currencyId":"string","effectiveDate":"2024-01-01","activityId":"string","transactionAmount":0.0,"narrative":"string","reason":"string","branch":"string","lineOfBusiness":"string","extensions":{}}},"responses":{"200":"updateUsConsumerAccountResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"POST","path":"/holdings/us/accounts/businessCheckings","fullPath":"/api/v6.2.0/holdings/us/accounts/businessCheckings","operationId":"createUsBusinessCheckingAccount","name":"Create a new business checking account for the corporate customer","summary":"New business checking account opening API","tags":["RETAIL"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"customerIds":[{}],"properties":[{}],"overrides":[{}],"productId":"string","masterArrangementId":"string","roleName":"string","currencyId":"string","effectiveDate":"2024-01-01","activityId":"string","transactionAmount":0.0,"narrative":"string","reason":"string","branch":"string","lineOfBusiness":"string","extensions":{}}},"responses":{"200":"createUsBusinessCheckingAccountResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"PUT","path":"/holdings/us/accounts/{accountId}/businessCheckings","fullPath":"/api/v6.2.0/holdings/us/accounts/{accountId}/businessCheckings","operationId":"updateUsBusinessCheckingAccount","name":"Renegotiate existing business checking account conditions","summary":"Renegotiate business checking account conditions","tags":["RETAIL"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"accountId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"customerIds":[{}],"properties":[{}],"overrides":[{}],"productId":"string","masterArrangementId":"string","roleName":"string","currencyId":"string","effectiveDate":"2024-01-01","activityId":"string","transactionAmount":0.0,"narrative":"string","reason":"string","branch":"string","lineOfBusiness":"string","extensions":{}}},"responses":{"200":"updateUsBusinessCheckingAccountResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"POST","path":"/holdings/us/accounts/businessSavings","fullPath":"/api/v6.2.0/holdings/us/accounts/businessSavings","operationId":"createUsBusinessSavingsAccount","name":"Create a new business savings account for the corporate customer","summary":"New business savings account opening API","tags":["RETAIL"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"customerIds":[{}],"properties":[{}],"overrides":[{}],"productId":"string","masterArrangementId":"string","roleName":"string","currencyId":"string","effectiveDate":"2024-01-01","activityId":"string","transactionAmount":0.0,"narrative":"string","reason":"string","branch":"string","lineOfBusiness":"string","extensions":{}}},"responses":{"200":"createUsBusinessSavingsAccountResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"PUT","path":"/holdings/us/accounts/{accountId}/businessSavings","fullPath":"/api/v6.2.0/holdings/us/accounts/{accountId}/businessSavings","operationId":"updateUsBusinessSavingsAccount","name":"Renegotiate existing  business savings account conditions","summary":"Renegotiate business savings account conditions","tags":["RETAIL"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"accountId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"customerIds":[{}],"properties":[{}],"overrides":[{}],"productId":"string","masterArrangementId":"string","roleName":"string","currencyId":"string","effectiveDate":"2024-01-01","activityId":"string","transactionAmount":0.0,"narrative":"string","reason":"string","branch":"string","lineOfBusiness":"string","extensions":{}}},"responses":{"200":"updateUsBusinessSavingsAccountResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"PUT","path":"/holdings/us/accounts/{accountId}/consumerAccounts/overdrafts/coverages","fullPath":"/api/v6.2.0/holdings/us/accounts/{accountId}/consumerAccounts/overdrafts/coverages","operationId":"updateOverdraftCoverageCode","name":"Updates the overdraft protection option opted by the customer. Overdraft protection options are offered by financial institutions to allow customers to choose if overdraft coverage is required, if transaction causing overdraft can be cleared, the type of balances that can be used to cover the overdraft (shared account balance, overdraft limit etc.) and the type of transactions that can be considered for overdraft coverage (ATM/Check/point of sale transactions etc.)","summary":"Updates the overdraft protection option opted by the customer.","tags":["RETAIL"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"accountId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"customerIds":[{}],"properties":[{}],"overrides":[{}],"productId":"string","masterArrangementId":"string","roleName":"string","currencyId":"string","effectiveDate":"2024-01-01","activityId":"string","transactionAmount":0.0,"narrative":"string","reason":"string","branch":"string","lineOfBusiness":"string","extensions":{}}},"responses":{"200":"updateOverdraftCoverageCodeResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"GET","path":"/holdings/us/accounts/{accountId}/forcedClosures","fullPath":"/api/v6.2.0/holdings/us/accounts/{accountId}/forcedClosures","operationId":"getForcedClosureStatus","name":"Retrieves the status of the force closure process for an account. ","summary":"Get account force closure status.","tags":["RETAIL"],"parameters":[{"name":"accountId","in":"path","type":"string","required":true,"description":"Identifier of the account. Often referred to as the account number, yet for consistency this is always referred to as accountId. Accepts both IBAN & BBAN"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"ForcedClosureStatusResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"POST","path":"/holdings/us/accounts/{accountId}/consumerAccounts/forcedClosures","fullPath":"/api/v6.2.0/holdings/us/accounts/{accountId}/consumerAccounts/forcedClosures","operationId":"createConsumerAccountForcedClosure","name":"Creates a new request to initiate the process of forcefully closing a consumer account.  This process applies to accounts with credit, zero, or debit balances. The steps involved in this process includes validating the closure and settlement account, posting entry restrictions to the closure account and finally initiating the force closure.","summary":"Initiate force closure process for consumer account.","tags":["RETAIL"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"accountId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"accountId":"string","productId":"string","activityId":"string","customerId":0.0,"customerRole":"string","currencyId":"string","effectiveDate":"2024-01-01","contextName":"string","payoutAccount":"string","override":"string","extensions":{},"balance":[{}]}},"responses":{"200":"createConsumerAccountForcedClosureResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"POST","path":"/holdings/us/accounts/{accountId}/businessCheckings/forcedClosures","fullPath":"/api/v6.2.0/holdings/us/accounts/{accountId}/businessCheckings/forcedClosures","operationId":"createBusinessCheckingForcedClosure","name":"Creates a new request to initiate the process of forcefully closing a business checking account.  This process applies to accounts with credit, zero, or debit balances. The steps involved in this process includes validating the closure and settlement account, posting entry restrictions to the closure account and finally initiating the force closure.","summary":"Initiate force closure process for business checking account.","tags":["RETAIL"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"accountId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"accountId":"string","productId":"string","activityId":"string","customerId":0.0,"customerRole":"string","currencyId":"string","effectiveDate":"2024-01-01","contextName":"string","payoutAccount":"string","override":"string","extensions":{},"balance":[{}]}},"responses":{"200":"createBusinessCheckingForcedClosureResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"POST","path":"/holdings/us/accounts/{accountId}/businessSavings/forcedClosures","fullPath":"/api/v6.2.0/holdings/us/accounts/{accountId}/businessSavings/forcedClosures","operationId":"createBusinessSavingsForcedClosure","name":"Creates a new request to initiate the process of forcefully closing a business savings account.  This process applies to accounts with credit, zero, or debit balances. The steps involved in this process includes validating the closure and settlement account, posting entry restrictions to the closure account and finally initiating the force closure.","summary":"Initiate force closure process for business savings account.","tags":["RETAIL"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"accountId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"accountId":"string","productId":"string","activityId":"string","customerId":0.0,"customerRole":"string","currencyId":"string","effectiveDate":"2024-01-01","contextName":"string","payoutAccount":"string","override":"string","extensions":{},"balance":[{}]}},"responses":{"200":"createBusinessSavingsForcedClosureResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"POST","path":"/holdings/us/coverdellEducationSavings/accounts","fullPath":"/api/v6.2.0/holdings/us/coverdellEducationSavings/accounts","operationId":"createUsCoverdellESA","name":"Allows creation of a new coverdell education savings account.","summary":"Create a new coverdell education savings account.","tags":["RETAIL"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"customerIds":[{}],"properties":[{}],"overrides":[{}],"productId":"string","masterArrangementId":"string","roleName":"string","currencyId":"string","effectiveDate":"2024-01-01","activityId":"string","transactionAmount":0.0,"narrative":"string","reason":"string","branch":"string","lineOfBusiness":"string","extensions":{}}},"responses":{"200":"createUsCoverdellESAResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"PUT","path":"/holdings/us/coverdellEducationSavings/accounts/{accountId}","fullPath":"/api/v6.2.0/holdings/us/coverdellEducationSavings/accounts/{accountId}","operationId":"updateUsCoverdellESA","name":"Modify existing coverdell education savings account information like, payment schedule, settlement accounts, charge etc,.","summary":"Update coverdell education savings account.","tags":["RETAIL"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"accountId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"customerIds":[{}],"properties":[{}],"overrides":[{}],"productId":"string","masterArrangementId":"string","roleName":"string","currencyId":"string","effectiveDate":"2024-01-01","activityId":"string","transactionAmount":0.0,"narrative":"string","reason":"string","branch":"string","lineOfBusiness":"string","extensions":{}}},"responses":{"200":"updateUsCoverdellESAResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"GET","path":"/holdings/us/accounts/{accountId}/balances","fullPath":"/api/v6.2.0/holdings/us/accounts/{accountId}/balances","operationId":"getUSAccountSummary","name":"Retrieves summary level balance information for an account","summary":"Account Summary","tags":["RETAIL"],"parameters":[{"name":"accountId","in":"path","type":"string","required":true,"description":"Identifier of the account. Often referred to as the account number, yet for consistency this is always referred to as accountId. Accepts both IBAN & BBAN"},{"name":"enquiryParameterDescription","in":"query","type":"string","required":false,"description":"Describes the enquiry parameter record settings which allows to input the additional dynamic field name ,label and type for the enquiry output display to be exposed for the enquiry output"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"USAccountSummaryResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/us/retirementSavings/accounts/{accountId}/contributions","fullPath":"/api/v6.2.0/holdings/us/retirementSavings/accounts/{accountId}/contributions","operationId":"getIraContributions","name":"Retrieve additional information regarding the contribution (funds deposited) made towards IRA (Individual Retirement Account) accounts and deposits","summary":"Retrieve contributions for IRA (Individual Retirement Account) accounts and deposits","tags":["RETAIL"],"parameters":[{"name":"accountId","in":"path","type":"string","required":true,"description":"Identifier of the account. Often referred to as the account number, yet for consistency this is always referred to as accountId. Accepts both IBAN & BBAN"},{"name":"period","in":"query","type":"string","required":false,"description":"Indicates spread of time buckets.Ex: 3M,6M,9M,10Y etc."},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"IraContributionsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/us/retirementSavings/accounts/{accountId}/distributions","fullPath":"/api/v6.2.0/holdings/us/retirementSavings/accounts/{accountId}/distributions","operationId":"getIraDistributions","name":"Retrieve additional information regarding the distributions (funds withdrawn) from IRA (Individual Retirement Account) accounts and deposits","summary":"Retrieve distributions for IRA (Individual Retirement Account) accounts and deposits","tags":["RETAIL"],"parameters":[{"name":"accountId","in":"path","type":"string","required":true,"description":"Identifier of the account. Often referred to as the account number, yet for consistency this is always referred to as accountId. Accepts both IBAN & BBAN"},{"name":"period","in":"query","type":"string","required":false,"description":"Indicates spread of time buckets.Ex: 3M,6M,9M,10Y etc."},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"IraDistributionsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/us/accounts/retirementSavings","fullPath":"/api/v6.2.0/holdings/us/accounts/retirementSavings","operationId":"getIRAccountDetails","name":"Retrieve accounts details for IRA(Individual Retirement Account). This is used to retrieve details of different types of IRA plan types such as Simple, Traditional, SEP, Roth, Inherited IRA","summary":"Retrieve accounts details for IRA(Individual Retirement Account)","tags":["RETAIL"],"parameters":[{"name":"accountId","in":"query","type":"string","required":false,"description":"Identifier of the account. Often referred to as the account number, yet for consistency this is always referred to as accountId. Accepts both IBAN & BBAN"},{"name":"customerId","in":"query","type":"string","required":false,"description":"Identifier of the customer"},{"name":"planType","in":"query","type":"string","required":false,"description":"Contains the type of registered plans. Example - RRSP-REG, RRIF-REG, TFSA, etc"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"IRAccountDetailsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/us/accounts/{accountId}/accountOverview","fullPath":"/api/v6.2.0/holdings/us/accounts/{accountId}/accountOverview","operationId":"getUsAccountOverview","name":"Retrieves the account details, balances, due balances, interest earned, RegD and NSF details, etc,.","summary":"AccountOverview","tags":["RETAIL"],"parameters":[{"name":"accountId","in":"path","type":"string","required":true,"description":"Identifier of the account. Often referred to as the account number, yet for consistency this is always referred to as accountId. Accepts both IBAN & BBAN"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"UsAccountOverviewResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}}]},{"key":"holdings-us-collections-service-v1.0.0","title":"US Model Bank Infinity Collection Integration","version":"v1.0.0","description":"Account collection notes API","endpointCount":4,"endpoints":[{"method":"GET","path":"/holdings/collections/accounts/{accountId}/notes","fullPath":"/api/v1.0.0/holdings/collections/accounts/{accountId}/notes","operationId":"getAccountNotes","name":"Retrieve notes related to an account","summary":"Retrieve notes related to an account","tags":["RETAIL"],"parameters":[{"name":"accountId","in":"path","type":"string","required":true,"description":"Identifier of the account. Often referred to as the account number, yet for consistency this is always referred to as accountId. Accepts both IBAN & BBAN"},{"name":"notesId","in":"query","type":"string","required":false,"description":"Identifier of notes recorded for a given customer or account"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"AccountNotesResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"POST","path":"/holdings/collections/accounts/{accountId}/notes","fullPath":"/api/v1.0.0/holdings/collections/accounts/{accountId}/notes","operationId":"createAccountNotes","name":"Create collection notes related to an account","summary":"Create account notes","tags":["RETAIL"],"parameters":[{"name":"accountId","in":"path","type":"string","required":true,"description":"Identifier of the account. Often referred to as the account number, yet for consistency this is always referred to as accountId. Accepts both IBAN & BBAN"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"notesType":"/v1.0.0/reference/lookups?virtualTableName=NOTES.TYPE","placementDate":"2024-01-01","placementTime":"string","userId":"string","lastModifiedDate":"2024-01-01","expiryDate":"2024-01-01","notes":"string"}},"responses":{"200":"AccountNotesResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/holdings/collections/accounts/notes/{notesId}","fullPath":"/api/v1.0.0/holdings/collections/accounts/notes/{notesId}","operationId":"updateAccountNotes","name":"Update previously added notes related to an account","summary":"Update account notes","tags":["RETAIL"],"parameters":[{"name":"notesId","in":"path","type":"string","required":true,"description":"Identifier of notes recorded for a given customer or account"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"notesType":"/v1.0.0/reference/lookups?virtualTableName=NOTES.TYPE","placementDate":"2024-01-01","placementTime":"string","userId":"string","lastModifiedDate":"2024-01-01","expiryDate":"2024-01-01","notes":"string"}},"responses":{"200":"AccountNotesResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/holdings/collections/loans/chargeOffs/{accountId}","fullPath":"/api/v1.0.0/holdings/collections/loans/chargeOffs/{accountId}","operationId":"createChargeOffActivity","name":"Execute loan charge-off activity to charge-off account balance only","summary":"Execute loan charge-off activity to charge-off account balance only","tags":["RETAIL"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"accountId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"customerIds":[{}],"properties":[{}],"overrides":[{}],"productId":"string","masterArrangementId":"string","roleName":"string","currencyId":"string","effectiveDate":"2024-01-01","activityId":"string","transactionAmount":0.0,"narrative":"string","reason":"string"}},"responses":{"200":"createChargeOffActivityResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}}]},{"key":"holdings-us-dashboards-service-v1.0.0","title":"US Model Bank Holdings summary","version":"v1.0.0","description":"Retrieves account balances and summary information to be utilized for building customer Dashboard","endpointCount":4,"endpoints":[{"method":"GET","path":"/holdings/us/customers/{customerId}/dashboards","fullPath":"/api/v1.0.0/holdings/us/customers/{customerId}/dashboards","operationId":"getUsCustomerHoldings","name":"Get account and product information, balances, payment details, etc,.","summary":"Get Customer account holdings","tags":["RETAIL"],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"Identifier of the customer"},{"name":"holdingsType","in":"query","type":"string","required":false,"description":"Contains the types of customer holdings"},{"name":"holdingsId","in":"query","type":"string","required":false,"description":"Contains the identifier specific to the holding details of the customer"},{"name":"getPreferredHoldings","in":"query","type":"string","required":false,"description":"Flag to fetch the preferred holding details (JWT required)"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from t24 on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"The identifier of the underlying Entity/Company/Branch."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"UsCustomerHoldingsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/us/deposits/{accountId}/dashboards","fullPath":"/api/v1.0.0/holdings/us/deposits/{accountId}/dashboards","operationId":"getUsDepositsDashboard","name":"Get minimum deposit information for publishing in customer dashboard","summary":"Get Deposit information for publishing in dashboard","tags":["RETAIL"],"parameters":[{"name":"accountId","in":"path","type":"string","required":true,"description":"Identifier of the account. Often referred to as the account number, yet for consistency this is always referred to as accountId. Accepts both IBAN & BBAN"},{"name":"balanceTypes","in":"query","type":"string","required":false,"description":"Type of balance (e.g. current balance, credit interest accrued, deferred commission, etc.) as defined in the institution's accounting schemas."},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from t24 on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"The identifier of the underlying Entity/Company/Branch."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"UsDepositsDashboardResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/us/dashboard/customer/{customerId}/accounts","fullPath":"/api/v1.0.0/holdings/us/dashboard/customer/{customerId}/accounts","operationId":"getUsAccountsHoldings","name":"Get account balances for publishing in dashboard","summary":"Get list of accounts, the product and account details","tags":["RETAIL"],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"Identifier of the customer"},{"name":"accountId","in":"query","type":"string","required":false,"description":"Identifier of the account. Often referred to as the account number, yet for consistency this is always referred to as accountId. Accepts both IBAN & BBAN"},{"name":"productId","in":"query","type":"string","required":false,"description":"Contains the unique identifier of the product, e.g. the product id of the arrangement account."},{"name":"currencyId","in":"query","type":"string","required":false,"description":"Identifier of the currency. This is the 3-letter ISO 4217 code of the currency."},{"name":"limitReference","in":"query","type":"string","required":false,"description":"Identifies the credit limit reference for the underlying account."},{"name":"arrangementId","in":"query","type":"string","required":false,"description":"Indicates an unique identifier of an account"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from t24 on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"The identifier of the underlying Entity/Company/Branch."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"UsAccountsHoldingsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/us/accounts/{accountId}/dashboards","fullPath":"/api/v1.0.0/holdings/us/accounts/{accountId}/dashboards","operationId":"getUsAccountsDashboard","name":"Get account balance, overdraft, interest, payment schedule and joint holder information for publishing in customer dashboard","summary":"Get account information for dashboard","tags":["RETAIL"],"parameters":[{"name":"accountId","in":"path","type":"string","required":true,"description":"Identifier of the account. Often referred to as the account number, yet for consistency this is always referred to as accountId. Accepts both IBAN & BBAN"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from t24 on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"The identifier of the underlying Entity/Company/Branch."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"UsAccountsDashboardResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}}]},{"key":"holdings-us-dashboards-service-v1.1.0","title":"US Model Bank Holdings summary","version":"v1.1.0","description":"Retrieves account balance and summary information to be utilized for building customer dashboard","endpointCount":4,"endpoints":[{"method":"GET","path":"/holdings/us/customers/{customerId}/dashboards","fullPath":"/api/v1.1.0/holdings/us/customers/{customerId}/dashboards","operationId":"getUsCustomerHoldings","name":"Get account and product information, balances, payment details, etc,.","summary":"Get customer account holdings","tags":["RETAIL"],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"Identifier of the customer"},{"name":"holdingsType","in":"query","type":"string","required":false,"description":"Contains the types of customer holdings"},{"name":"holdingsId","in":"query","type":"string","required":false,"description":"Contains the identifier specific to the holding details of the customer"},{"name":"getPreferredHoldings","in":"query","type":"string","required":false,"description":"Flag to fetch the preferred holding details (JWT required)"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"UsCustomerHoldingsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/us/deposits/{accountId}/dashboards","fullPath":"/api/v1.1.0/holdings/us/deposits/{accountId}/dashboards","operationId":"getUsDepositsDashboard","name":"Get minimum deposit information for publishing in customer dashboard","summary":"Get deposit information for publishing in dashboard","tags":["RETAIL"],"parameters":[{"name":"accountId","in":"path","type":"string","required":true,"description":"Identifier of the account. Often referred to as the account number, yet for consistency this is always referred to as accountId. Accepts both IBAN & BBAN"},{"name":"balanceTypes","in":"query","type":"string","required":false,"description":"Type of balance (e.g. current balance, credit interest accrued, deferred commission, etc.) as defined in the institution's accounting schemas."},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"UsDepositsDashboardResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/us/dashboard/customer/{customerId}/accounts","fullPath":"/api/v1.1.0/holdings/us/dashboard/customer/{customerId}/accounts","operationId":"getUsAccountsHoldings","name":"Get account balances for publishing in dashboard","summary":"Get list of accounts, product and account details","tags":["RETAIL"],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"Identifier of the customer"},{"name":"accountId","in":"query","type":"string","required":false,"description":"Identifier of the account. Often referred to as the account number, yet for consistency this is always referred to as accountId. Accepts both IBAN & BBAN"},{"name":"productId","in":"query","type":"string","required":false,"description":"Contains the unique identifier of the product, e.g. the product id of the arrangement account."},{"name":"currencyId","in":"query","type":"string","required":false,"description":"Identifier of the currency. This is the 3-letter ISO 4217 code of the currency."},{"name":"limitReference","in":"query","type":"string","required":false,"description":"Identifies the credit limit reference for the underlying account."},{"name":"arrangementId","in":"query","type":"string","required":false,"description":"Indicates an unique identifier of an account"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"UsAccountsHoldingsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/us/accounts/{accountId}/dashboards","fullPath":"/api/v1.1.0/holdings/us/accounts/{accountId}/dashboards","operationId":"getUsAccountsDashboard","name":"Get account balance, overdraft, interest, payment schedule and joint holder information for publishing in customer dashboard","summary":"Get account information for dashboard","tags":["RETAIL"],"parameters":[{"name":"accountId","in":"path","type":"string","required":true,"description":"Identifier of the account. Often referred to as the account number, yet for consistency this is always referred to as accountId. Accepts both IBAN & BBAN"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"UsAccountsDashboardResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}}]},{"key":"holdings-us-dashboards-service-v1.2.0","title":"US Model Bank Holdings summary","version":"v1.2.0","description":"Retrieves account balance and summary information to be utilized for building customer dashboard","endpointCount":4,"endpoints":[{"method":"GET","path":"/holdings/us/customers/{customerId}/dashboards","fullPath":"/api/v1.2.0/holdings/us/customers/{customerId}/dashboards","operationId":"getUsCustomerHoldings","name":"Get account and product information, balances, payment details, etc,.","summary":"Get customer account holdings","tags":["RETAIL"],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"Identifier of the customer"},{"name":"holdingsType","in":"query","type":"string","required":false,"description":"Contains the types of customer holdings"},{"name":"holdingsId","in":"query","type":"string","required":false,"description":"Contains the identifier specific to the holding details of the customer"},{"name":"getPreferredHoldings","in":"query","type":"string","required":false,"description":"Flag to fetch the preferred holding details (JWT required)"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"UsCustomerHoldingsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/us/deposits/{accountId}/dashboards","fullPath":"/api/v1.2.0/holdings/us/deposits/{accountId}/dashboards","operationId":"getUsDepositsDashboard","name":"Get minimum deposit information for publishing in customer dashboard","summary":"Get deposit information for publishing in dashboard","tags":["RETAIL"],"parameters":[{"name":"accountId","in":"path","type":"string","required":true,"description":"Identifier of the account. Often referred to as the account number, yet for consistency this is always referred to as accountId. Accepts both IBAN & BBAN"},{"name":"balanceTypes","in":"query","type":"string","required":false,"description":"Type of balance (e.g. current balance, credit interest accrued, deferred commission, etc.) as defined in the institution's accounting schemas."},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"UsDepositsDashboardResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/us/dashboard/customer/{customerId}/accounts","fullPath":"/api/v1.2.0/holdings/us/dashboard/customer/{customerId}/accounts","operationId":"getUsAccountsHoldings","name":"Get account balances for publishing in dashboard","summary":"Get list of accounts, product and account details","tags":["RETAIL"],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"Identifier of the customer"},{"name":"accountId","in":"query","type":"string","required":false,"description":"Identifier of the account. Often referred to as the account number, yet for consistency this is always referred to as accountId. Accepts both IBAN & BBAN"},{"name":"productId","in":"query","type":"string","required":false,"description":"Contains the unique identifier of the product, e.g. the product id of the arrangement account."},{"name":"currencyId","in":"query","type":"string","required":false,"description":"Identifier of the currency. This is the 3-letter ISO 4217 code of the currency."},{"name":"limitReference","in":"query","type":"string","required":false,"description":"Identifies the credit limit reference for the underlying account."},{"name":"arrangementId","in":"query","type":"string","required":false,"description":"Indicates an unique identifier of an account"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"UsAccountsHoldingsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/us/accounts/{accountId}/dashboards","fullPath":"/api/v1.2.0/holdings/us/accounts/{accountId}/dashboards","operationId":"getUsAccountsDashboard","name":"Get account balance, overdraft, interest, payment schedule and joint holder information for publishing in customer dashboard","summary":"Get account information for dashboard","tags":["RETAIL"],"parameters":[{"name":"accountId","in":"path","type":"string","required":true,"description":"Identifier of the account. Often referred to as the account number, yet for consistency this is always referred to as accountId. Accepts both IBAN & BBAN"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"UsAccountsDashboardResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}}]},{"key":"holdings-us-dashboards-service-v2.0.0","title":"US Model Bank Holdings summary","version":"v2.0.0","description":"Retrieves account balance and summary information to be utilized for building customer dashboard","endpointCount":4,"endpoints":[{"method":"GET","path":"/holdings/us/customers/{customerId}/accounts","fullPath":"/api/v2.0.0/holdings/us/customers/{customerId}/accounts","operationId":"getUsAccountsHoldings","name":"Retrieves list of accounts held by a customer along with account details along with multiple balances and joint holder information. ","summary":"Retrieves details of accounts held by a customer with detailed balance information","tags":["RETAIL"],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"Identifier of the customer"},{"name":"accountId","in":"query","type":"string","required":false,"description":"Identifier of the account. Often referred to as the account number, yet for consistency this is always referred to as accountId. Accepts both IBAN & BBAN"},{"name":"productId","in":"query","type":"string","required":false,"description":"Contains the unique identifier of the product, e.g. the product id of the arrangement account."},{"name":"currencyId","in":"query","type":"string","required":false,"description":"Identifier of the currency. This is the 3-letter ISO 4217 code of the currency."},{"name":"limitReference","in":"query","type":"string","required":false,"description":"Identifies the credit limit reference for the underlying account."},{"name":"arrangementId","in":"query","type":"string","required":false,"description":"Indicates an unique identifier of an account"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"UsAccountsHoldingsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/us/customers/{customerId}/holdings","fullPath":"/api/v2.0.0/holdings/us/customers/{customerId}/holdings","operationId":"getUsCustomerHoldings","name":"Retrieves list of accounts held by a customer along with account details and  balances. ","summary":"Retrieves details of accounts held by a customer","tags":["RETAIL"],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"Identifier of the customer"},{"name":"holdingsType","in":"query","type":"string","required":false,"description":"Contains the types of customer holdings"},{"name":"holdingsId","in":"query","type":"string","required":false,"description":"Contains the identifier specific to the holding details of the customer"},{"name":"getPreferredHoldings","in":"query","type":"string","required":false,"description":"Flag to fetch the preferred holding details (JWT required)"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"UsCustomerHoldingsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/us/deposits/{depositId}","fullPath":"/api/v2.0.0/holdings/us/deposits/{depositId}","operationId":"getUsDepositsDashboard","name":"Retrieves term deposit details like term amount, term, interest, interest earned, accruals,  settlement accounts, charge schedule, last payment details.","summary":"Retrieves details of a term deposit ","tags":["RETAIL"],"parameters":[{"name":"depositId","in":"path","type":"string","required":true,"description":"Indicates the Id of the deposit account"},{"name":"balanceTypes","in":"query","type":"string","required":false,"description":"Type of balance (e.g. current balance, credit interest accrued, deferred commission, etc.) as defined in the institution's accounting schemas."},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"UsDepositsDashboardResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/us/accounts/{accountId}","fullPath":"/api/v2.0.0/holdings/us/accounts/{accountId}","operationId":"getUsAccountsDashboard","name":"Retrieves account information, balances, overdraft, interest, payment schedule and joint ownership details","summary":"Retrieves account and ownership details","tags":["RETAIL"],"parameters":[{"name":"accountId","in":"path","type":"string","required":true,"description":"Identifier of the account. Often referred to as the account number, yet for consistency this is always referred to as accountId. Accepts both IBAN & BBAN"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"UsAccountsDashboardResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}}]},{"key":"holdings-us-deposits-service-v1.0.0","title":"US Model Bank - Management of Deposits","version":"v1.0.0","description":"Create US Deposit accounts, update deposit information like statement frequency, renewal, change schedule etc,  and view deposit summary","endpointCount":3,"endpoints":[{"method":"POST","path":"/holdings/us/deposits/termDeposits","fullPath":"/api/v1.0.0/holdings/us/deposits/termDeposits","operationId":"createUsDepositsAccount","name":"Create a new term deposit account","summary":"Create a new term deposit account","tags":[],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"The identifier of the underlying Entity/Company/Branch."}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"customerIds":[{}],"properties":[{}],"overrides":[{}],"productId":"string","masterArrangementId":"string","roleName":"string","currencyId":"string","effectiveDate":"2024-01-01","activityId":"string","transactionAmount":0.0,"narrative":"string","reason":"string","account":{"restriction":{},"alternateIds":{},"holidayCalendar":{},"accountTitle":{},"shortTitle":{},"currency":{},"productCategoryId":{},"accountId":{},"portfolioId":{},"baseDateType":{},"anniversary":{},"originationReference":{},"dateConvention":{},"dateAdjustment":{},"ffiecCode":{}},"balanceMaintenance":{"adjustmentDisplayname":{},"netAdjustmentAmount":{},"adjustmentDifferenceAccount":{}},"customer":{"customers":{},"otherParties":{},"accountTitles":{},"jointLiability":{},"inActiveMilitaryService":{},"accountTitlingOperand":{}}}},"responses":{"200":"createUsDepositsAccountResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"PUT","path":"/holdings/us/deposits/{accountId}/termDeposit","fullPath":"/api/v1.0.0/holdings/us/deposits/{accountId}/termDeposit","operationId":"updateUsDepositsAccount","name":"Update term deposit","summary":"Update term deposits account information, customer and ownership information, term, payment schedule, renewal and maturity information, settlement accounts, charges etc,.","tags":[],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"The identifier of the underlying Entity/Company/Branch."},{"name":"accountId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"customerIds":[{}],"properties":[{}],"overrides":[{}],"productId":"string","masterArrangementId":"string","roleName":"string","currencyId":"string","effectiveDate":"2024-01-01","activityId":"string","transactionAmount":0.0,"narrative":"string","reason":"string","account":{"restriction":{},"alternateIds":{},"holidayCalendar":{},"accountTitle":{},"shortTitle":{},"currency":{},"productCategoryId":{},"accountId":{},"portfolioId":{},"baseDateType":{},"anniversary":{},"originationReference":{},"dateConvention":{},"dateAdjustment":{},"ffiecCode":{}},"balanceMaintenance":{"adjustmentDisplayname":{},"netAdjustmentAmount":{},"adjustmentDifferenceAccount":{}},"customer":{"customers":{},"otherParties":{},"accountTitles":{},"jointLiability":{},"inActiveMilitaryService":{},"accountTitlingOperand":{}}}},"responses":{"200":"updateUsDepositsAccountResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"GET","path":"/holdings/us/deposit/{accountId}/depositOverview","fullPath":"/api/v1.0.0/holdings/us/deposit/{accountId}/depositOverview","operationId":"getUsDepositOverview","name":"Deposit Overview","summary":"API to view deposit details, balances, interest earned, APY, etc,.","tags":[],"parameters":[{"name":"accountId","in":"path","type":"string","required":true,"description":"Identifier of the account. Often referred to as the account number, yet for consistency this is always referred to as accountId. Accepts both IBAN & BBAN"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from t24 on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"The identifier of the underlying Entity/Company/Branch."}],"requestBodyExample":null,"responses":{"200":"UsDepositOverviewResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}}]},{"key":"holdings-us-deposits-service-v2.0.0","title":"US Model Bank Create and service deposit accounts","version":"v2.0.0","description":"Allows to create deposit accounts, perform updates to deposit information like statement frequency, renewal, change schedule etc, and view deposit summary.","endpointCount":5,"endpoints":[{"method":"POST","path":"/holdings/us/deposits/termDeposits","fullPath":"/api/v2.0.0/holdings/us/deposits/termDeposits","operationId":"createUsDepositsAccount","name":"Create a new term deposit account","summary":"Create a new term deposit account","tags":["RETAIL"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"customerIds":[{}],"properties":[{}],"overrides":[{}],"productId":"string","masterArrangementId":"string","roleName":"string","currencyId":"string","effectiveDate":"2024-01-01","activityId":"string","transactionAmount":0.0,"narrative":"string","reason":"string","branch":"string","lineOfBusiness":"string","extensions":{}}},"responses":{"200":"createUsDepositsAccountResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"PUT","path":"/holdings/us/deposits/{accountId}/termDeposit","fullPath":"/api/v2.0.0/holdings/us/deposits/{accountId}/termDeposit","operationId":"updateUsDepositsAccount","name":"Update term deposits account information, customer and ownership information, term, payment schedule, renewal and maturity information, settlement accounts, charges etc,.","summary":"Update term deposit","tags":["RETAIL"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"accountId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"customerIds":[{}],"properties":[{}],"overrides":[{}],"productId":"string","masterArrangementId":"string","roleName":"string","currencyId":"string","effectiveDate":"2024-01-01","activityId":"string","transactionAmount":0.0,"narrative":"string","reason":"string","branch":"string","lineOfBusiness":"string","extensions":{}}},"responses":{"200":"updateUsDepositsAccountResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"GET","path":"/holdings/us/deposits/{accountId}/depositOverview","fullPath":"/api/v2.0.0/holdings/us/deposits/{accountId}/depositOverview","operationId":"getUsDepositOverview","name":"API to view deposit details, balances, interest earned, APY, etc,.","summary":"Deposit Overview","tags":["RETAIL"],"parameters":[{"name":"accountId","in":"path","type":"string","required":true,"description":"Identifier of the account. Often referred to as the account number, yet for consistency this is always referred to as accountId. Accepts both IBAN & BBAN"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"UsDepositOverviewResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"POST","path":"/holdings/us/coverdellEducationSavings/deposits","fullPath":"/api/v2.0.0/holdings/us/coverdellEducationSavings/deposits","operationId":"createUsCoverdellESAdeposit","name":"Allows creation of a new coverdell education savings deposit account.","summary":"Create a new coverdell education savings deposit account.","tags":["RETAIL"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"customerIds":[{}],"properties":[{}],"overrides":[{}],"productId":"string","masterArrangementId":"string","roleName":"string","currencyId":"string","effectiveDate":"2024-01-01","activityId":"string","transactionAmount":0.0,"narrative":"string","reason":"string","branch":"string","lineOfBusiness":"string","extensions":{}}},"responses":{"200":"createUsCoverdellESAdepositResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"PUT","path":"/holdings/us/coverdellEducationSavings/deposits/{depositId}","fullPath":"/api/v2.0.0/holdings/us/coverdellEducationSavings/deposits/{depositId}","operationId":"updateUsCoverdellESAdeposit","name":"Modify existing coverdell education savings deposit  account information like, payment schedule, settlement accounts, charge etc,. ","summary":"Update coverdell education savings deposit account.","tags":["RETAIL"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"depositId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"customerIds":[{}],"properties":[{}],"overrides":[{}],"productId":"string","masterArrangementId":"string","roleName":"string","currencyId":"string","effectiveDate":"2024-01-01","activityId":"string","transactionAmount":0.0,"narrative":"string","reason":"string","branch":"string","lineOfBusiness":"string","extensions":{}}},"responses":{"200":"updateUsCoverdellESAdepositResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}}]},{"key":"holdings-us-facilities-service-v1.0.0","title":"Create a Buy Now Pay Later Facility","version":"v1.0.0","description":"Create a Buy Now Pay Later Facility","endpointCount":3,"endpoints":[{"method":"POST","path":"/holdings/us/facilities/buyNowPayLater","fullPath":"/api/v1.0.0/holdings/us/facilities/buyNowPayLater","operationId":"createUsBuyNowPayLaterFacility","name":"Create a Buy Now Pay Later Facility","summary":"Create a Buy Now Pay Later Facility","tags":[],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"customerIds":[{}],"properties":[{}],"overrides":[{}],"productId":"string","masterArrangementId":"string","roleName":"string","currencyId":"string","effectiveDate":"2024-01-01","activityId":"string","transactionAmount":0.0,"narrative":"string","reason":"string","activityCharges":[{}],"overdue":[{}],"periodicCharges":[{}]}},"responses":{"200":"createUsBuyNowPayLaterFacilityResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"POST","path":"/holdings/us/facilities/buyNowPayLater/drawdown","fullPath":"/api/v1.0.0/holdings/us/facilities/buyNowPayLater/drawdown","operationId":"createUsBuyNowPayLaterDrawdown","name":"Create a Buy Now Pay Later Drawing","summary":"Create a Buy Now Pay Later Drawing","tags":[],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"customerIds":[{}],"properties":[{}],"overrides":[{}],"facilityId":"string","productId":"string","roleName":"string","currencyId":"string","effectiveDate":"2024-01-01","activityId":"string","transactionAmount":0.0,"narrative":"string","reason":"string","limit":[{}],"splitsMerges":[{}],"statement":[{}]}},"responses":{"200":"createUsBuyNowPayLaterDrawdownResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"GET","path":"/holdings/us/facilities/{facilityId}","fullPath":"/api/v1.0.0/holdings/us/facilities/{facilityId}","operationId":"getUsFacilityDetails","name":"Retrieve facility details","summary":"Retrieve facility details","tags":[],"parameters":[{"name":"facilityId","in":"path","type":"string","required":true,"description":"Unique identifier (contract number) of the facility"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"UsFacilityDetailsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}}]},{"key":"holdings-us-loans-service-v1.0.0","title":"US Model Bank Loan details","version":"v1.0.0","description":"API to view loan information like ownership, roles, balances, due amounts, payment history, collateral details, limit, etc,.","endpointCount":5,"endpoints":[{"method":"GET","path":"/holdings/us/loan/{accountId}/loanOverview","fullPath":"/api/v1.0.0/holdings/us/loan/{accountId}/loanOverview","operationId":"getUsLoanOverview","name":"API to view loan information like ownership, roles, balances, due amounts, payment history, collateral details, limit, etc,.","summary":"Loan Overview","tags":["RETAIL"],"parameters":[{"name":"accountId","in":"path","type":"string","required":true,"description":"Identifier of the account. Often referred to as the account number, yet for consistency this is always referred to as accountId. Accepts both IBAN & BBAN"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from t24 on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"UsLoanOverviewResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"POST","path":"/holdings/us/loans/consumerLoan","fullPath":"/api/v1.0.0/holdings/us/loans/consumerLoan","operationId":"createUsConsumerLoan","name":"New consumer loan creation API","summary":"New consumer loan creation API","tags":["RETAIL"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"customerIds":[{}],"properties":[{}],"overrides":[{}],"productId":"string","masterArrangementId":"string","roleName":"string","currencyId":"string","effectiveDate":"2024-01-01","activityId":"string","transactionAmount":0.0,"narrative":"string","reason":"string","account":[{}],"usLenActCharges":[{}],"messaging":[{}]}},"responses":{"200":"createUsConsumerLoanResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"PUT","path":"/holdings/us/loans/{accountId}/consumerLoan","fullPath":"/api/v1.0.0/holdings/us/loans/{accountId}/consumerLoan","operationId":"updateUsConsumerLoan","name":"Renegotiate existing consumer loan conditions","summary":"Renegotiate existing consumer loan conditions","tags":["RETAIL"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"accountId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"customerIds":[{}],"properties":[{}],"overrides":[{}],"productId":"string","masterArrangementId":"string","roleName":"string","currencyId":"string","effectiveDate":"2024-01-01","activityId":"string","transactionAmount":0.0,"narrative":"string","reason":"string","account":[{}],"usLenActCharges":[{}],"messaging":[{}]}},"responses":{"200":"updateUsConsumerLoanResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"POST","path":"/holdings/us/loans/lineofcredits/consumers/creditLine","fullPath":"/api/v1.0.0/holdings/us/loans/lineofcredits/consumers/creditLine","operationId":"createUsConsumerLoC","name":"Book a new consumer line of credit","summary":"Book a new consumer line of credit","tags":["RETAIL"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"customerIds":[{}],"properties":[{}],"overrides":[{}],"productId":"string","masterArrangementId":"string","roleName":"string","currencyId":"string","effectiveDate":"2024-01-01","activityId":"string","transactionAmount":0.0,"narrative":"string","reason":"string","account":[{}],"usLenActCharges":[{}],"messaging":[{}]}},"responses":{"200":"createUsConsumerLoCResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"PUT","path":"/holdings/us/loans/lineofcredits/consumers/{accountId}/creditLine","fullPath":"/api/v1.0.0/holdings/us/loans/lineofcredits/consumers/{accountId}/creditLine","operationId":"updateUsConsumerLoC","name":"Renegotiate consumer line of credit conditions","summary":"Renegotiate consumer line of credit conditions","tags":["RETAIL"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"accountId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"customerIds":[{}],"properties":[{}],"overrides":[{}],"productId":"string","masterArrangementId":"string","roleName":"string","currencyId":"string","effectiveDate":"2024-01-01","activityId":"string","transactionAmount":0.0,"narrative":"string","reason":"string","account":[{}],"usLenActCharges":[{}],"messaging":[{}]}},"responses":{"200":"updateUsConsumerLoCResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}}]},{"key":"holdings-userAdmin-service-v1.0.0","title":"UserAdministration","version":"v1.0.0","description":"User Administration","endpointCount":15,"endpoints":[{"method":"GET","path":"/holdings/onlineServices","fullPath":"/api/v1.0.0/v1.0.0/holdings/onlineServices","operationId":"getOnlineServices","name":"","summary":"","tags":[],"parameters":[{"name":"arrangementId","in":"query","type":"string","required":false,"description":"The identifier of the arrangement"},{"name":"arrangementStatus","in":"query","type":"string","required":false,"description":"Status of the arrangement: UNAUTH - input but not authorised yet. AUTH - authorised. AUTH-FWD (Forward) - authorised, will become active on a future date. CURRENT - the arrangement has begun full or p"},{"name":"masterOnly","in":"query","type":"string","required":false,"description":""},{"name":"roleOnly","in":"query","type":"string","required":false,"description":""},{"name":"masterArrangementId","in":"query","type":"string","required":false,"description":""},{"name":"productGroupId","in":"query","type":"string","required":false,"description":"The group, as defined by the institution, that the product belongs to."},{"name":"productId","in":"query","type":"string","required":false,"description":"Id of the product."},{"name":"customerId","in":"query","type":"string","required":false,"description":"The identifier of the customer"},{"name":"subArrangementName","in":"query","type":"string","required":false,"description":""},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from t24 on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":""},{"name":"companyId","in":"header","type":"string","required":false,"description":""}],"requestBodyExample":null,"responses":{"200":"OnlineServicesResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"POST","path":"/holdings/onlineServices","fullPath":"/api/v1.0.0/v1.0.0/holdings/onlineServices","operationId":"validateOnlineService","name":"","summary":"","tags":[],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":""},{"name":"companyId","in":"header","type":"string","required":false,"description":""}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"customerIds":[{}],"properties":[{}],"overrides":[{}],"productId":"string","masterArrangementId":"string","subArrangementName":"string","currencyId":"string","effectiveDate":"2024-01-01","activityId":"string","transactionAmount":0.0,"customer":{"customers":{},"jointLiability":{}},"tcpermissions":{"definedCustomers":{},"defPrdGroups":{},"relCustomers":{},"masterLevelChange":{}},"tcprivileges":{"services":{},"masterLevelChange":{}},"tcavailability":{"day":{},"masterLevelChange":{}},"dailylimits":{"system":{},"transaction":{},"currency":{},"riskRate":{},"timeOfDay":{},"currencyId":{},"limitAmount":{}}}},"responses":{"200":"validateOnlineServiceResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"PUT","path":"/holdings/onlineServiceApprovals/amendments/{arrangementActivityId}/{arrangementId}","fullPath":"/api/v1.0.0/v1.0.0/holdings/onlineServiceApprovals/amendments/{arrangementActivityId}/{arrangementId}","operationId":"amendOnlineService","name":"","summary":"","tags":[],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":""},{"name":"companyId","in":"header","type":"string","required":false,"description":""},{"name":"arrangementActivityId","in":"path","type":"string","required":true,"description":""},{"name":"arrangementId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"customerIds":[{}],"properties":[{}],"overrides":[{}],"productId":"string","masterArrangementId":"string","subArrangementName":"string","currencyId":"string","effectiveDate":"2024-01-01","activityId":"string","transactionAmount":0.0,"customer":{"customers":{},"jointLiability":{}},"tcpermissions":{"definedCustomers":{},"defPrdGroups":{},"relCustomers":{},"masterLevelChange":{}},"tcprivileges":{"services":{},"masterLevelChange":{}},"tcavailability":{"day":{},"masterLevelChange":{}},"dailylimits":{"system":{},"transaction":{},"currency":{},"riskRate":{},"timeOfDay":{},"currencyId":{},"limitAmount":{}}}},"responses":{"200":"amendOnlineServiceResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"PUT","path":"/holdings/onlineServiceApprovals/{arrangementActivityId}","fullPath":"/api/v1.0.0/v1.0.0/holdings/onlineServiceApprovals/{arrangementActivityId}","operationId":"approveOnlineService","name":"","summary":"","tags":[],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":""},{"name":"companyId","in":"header","type":"string","required":false,"description":""},{"name":"arrangementActivityId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"customerIds":[{}],"properties":[{}],"overrides":[{}],"productId":"string","masterArrangementId":"string","subArrangementName":"string","currencyId":"string","effectiveDate":"2024-01-01","activityId":"string","transactionAmount":0.0,"customer":{"customers":{},"jointLiability":{}},"tcpermissions":{"definedCustomers":{},"defPrdGroups":{},"relCustomers":{},"masterLevelChange":{}},"tcprivileges":{"services":{},"masterLevelChange":{}},"tcavailability":{"day":{},"masterLevelChange":{}},"dailylimits":{"system":{},"transaction":{},"currency":{},"riskRate":{},"timeOfDay":{},"currencyId":{},"limitAmount":{}}}},"responses":{"200":"approveOnlineServiceResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"DELETE","path":"/holdings/onlineServiceApprovals/{arrangementActivityId}","fullPath":"/api/v1.0.0/v1.0.0/holdings/onlineServiceApprovals/{arrangementActivityId}","operationId":"rejectOnlineService","name":"","summary":"","tags":[],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":""},{"name":"companyId","in":"header","type":"string","required":false,"description":""},{"name":"arrangementActivityId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":null,"responses":{"200":"rejectOnlineServiceResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"PUT","path":"/holdings/onlineServiceApprovals/{arrangementActivityId}/{arrangementId}","fullPath":"/api/v1.0.0/v1.0.0/holdings/onlineServiceApprovals/{arrangementActivityId}/{arrangementId}","operationId":"initiateOnlineService","name":"","summary":"","tags":[],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":""},{"name":"companyId","in":"header","type":"string","required":false,"description":""},{"name":"arrangementActivityId","in":"path","type":"string","required":true,"description":""},{"name":"arrangementId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"customerIds":[{}],"properties":[{}],"overrides":[{}],"productId":"string","masterArrangementId":"string","subArrangementName":"string","currencyId":"string","effectiveDate":"2024-01-01","activityId":"string","transactionAmount":0.0,"customer":{"customers":{},"jointLiability":{}},"tcpermissions":{"definedCustomers":{},"defPrdGroups":{},"relCustomers":{},"masterLevelChange":{}},"tcprivileges":{"services":{},"masterLevelChange":{}},"tcavailability":{"day":{},"masterLevelChange":{}},"dailylimits":{"system":{},"transaction":{},"currency":{},"riskRate":{},"timeOfDay":{},"currencyId":{},"limitAmount":{}}}},"responses":{"200":"initiateOnlineServiceResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"GET","path":"/holdings/customers/{customerId}/productGroups/{productGroupId}/products","fullPath":"/api/v1.0.0/v1.0.0/holdings/customers/{customerId}/productGroups/{productGroupId}/products","operationId":"getCustomerProductsByProductGroup","name":"","summary":"","tags":[],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"The identifier of the customer"},{"name":"productGroupId","in":"path","type":"string","required":true,"description":"The group, as defined by the institution, that the product belongs to."},{"name":"allowedProducts","in":"query","type":"string","required":false,"description":"Product or products allowed to be used within the product bundle."},{"name":"companyId","in":"query","type":"string","required":false,"description":"The identifier of the underlying Entity/Company/Branch."},{"name":"productId","in":"query","type":"string","required":false,"description":"Id of the product."},{"name":"onlineServicesProductId","in":"query","type":"string","required":false,"description":""},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from t24 on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":""},{"name":"companyId","in":"header","type":"string","required":false,"description":""}],"requestBodyExample":null,"responses":{"200":"CustomerProductsByProductGroupResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/customers/{customerId}/onlineServices/{onlineServicesProductId}/products","fullPath":"/api/v1.0.0/v1.0.0/holdings/customers/{customerId}/onlineServices/{onlineServicesProductId}/products","operationId":"getCustomerProductsByOnlineServicesProduct","name":"","summary":"","tags":[],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"The identifier of the customer"},{"name":"onlineServicesProductId","in":"path","type":"string","required":true,"description":""},{"name":"allowedProducts","in":"query","type":"string","required":false,"description":"Product or products allowed to be used within the product bundle."},{"name":"companyId","in":"query","type":"string","required":false,"description":"The identifier of the underlying Entity/Company/Branch."},{"name":"productId","in":"query","type":"string","required":false,"description":"Id of the product."},{"name":"productGroupId","in":"query","type":"string","required":false,"description":"The group, as defined by the institution, that the product belongs to."},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from t24 on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":""},{"name":"companyId","in":"header","type":"string","required":false,"description":""}],"requestBodyExample":null,"responses":{"200":"CustomerProductsByOnlineServicesProductResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/onlineServices/{arrangementId}/externalUserAllocations","fullPath":"/api/v1.0.0/v1.0.0/holdings/onlineServices/{arrangementId}/externalUserAllocations","operationId":"getExternalUserAllocations","name":"","summary":"","tags":[],"parameters":[{"name":"arrangementId","in":"path","type":"string","required":true,"description":"The identifier of the arrangement"},{"name":"subArrangementId","in":"query","type":"string","required":false,"description":""},{"name":"masterOnly","in":"query","type":"string","required":false,"description":""},{"name":"countOnly","in":"query","type":"string","required":false,"description":""},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from t24 on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":""},{"name":"companyId","in":"header","type":"string","required":false,"description":""}],"requestBodyExample":null,"responses":{"200":"ExternalUserAllocationsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/onlineServices/{arrangementId}","fullPath":"/api/v1.0.0/v1.0.0/holdings/onlineServices/{arrangementId}","operationId":"getOnlineServiceByArrangement","name":"","summary":"","tags":[],"parameters":[{"name":"status","in":"query","type":"string","required":false,"description":""},{"name":"arrangementActivityId","in":"query","type":"string","required":false,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":""},{"name":"companyId","in":"header","type":"string","required":false,"description":""},{"name":"arrangementId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":null,"responses":{"200":"getOnlineServiceByArrangementResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/onlineServices/activity/{arrangementActivityId}","fullPath":"/api/v1.0.0/v1.0.0/holdings/onlineServices/activity/{arrangementActivityId}","operationId":"getOnlineServiceByArrangementActivity","name":"","summary":"","tags":[],"parameters":[{"name":"status","in":"query","type":"string","required":false,"description":""},{"name":"arrangementId","in":"query","type":"string","required":false,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":""},{"name":"companyId","in":"header","type":"string","required":false,"description":""},{"name":"arrangementActivityId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":null,"responses":{"200":"getOnlineServiceByArrangementActivityResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/onlineServiceApprovals/{arrangementId}","fullPath":"/api/v1.0.0/v1.0.0/holdings/onlineServiceApprovals/{arrangementId}","operationId":"getOnlineServiceApprovalByArrangement","name":"","summary":"","tags":[],"parameters":[{"name":"status","in":"query","type":"string","required":false,"description":""},{"name":"arrangementActivityId","in":"query","type":"string","required":false,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":""},{"name":"companyId","in":"header","type":"string","required":false,"description":""},{"name":"arrangementId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":null,"responses":{"200":"getOnlineServiceApprovalByArrangementResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/onlineServiceApprovals/activity/{arrangementActivityId}","fullPath":"/api/v1.0.0/v1.0.0/holdings/onlineServiceApprovals/activity/{arrangementActivityId}","operationId":"getOnlineServiceApprovalByArrangementActivity","name":"","summary":"","tags":[],"parameters":[{"name":"status","in":"query","type":"string","required":false,"description":""},{"name":"arrangementId","in":"query","type":"string","required":false,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":""},{"name":"companyId","in":"header","type":"string","required":false,"description":""},{"name":"arrangementActivityId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":null,"responses":{"200":"getOnlineServiceApprovalByArrangementActivityResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/onlineServiceApprovals","fullPath":"/api/v1.0.0/v1.0.0/holdings/onlineServiceApprovals","operationId":"getOnlineServiceApprovals","name":"","summary":"","tags":[],"parameters":[{"name":"customerId","in":"query","type":"string","required":false,"description":"The identifier of the customer"},{"name":"arrangementId","in":"query","type":"string","required":false,"description":"The identifier of the arrangement"},{"name":"masterOnly","in":"query","type":"string","required":false,"description":""},{"name":"roleOnly","in":"query","type":"string","required":false,"description":""},{"name":"masterArrangementId","in":"query","type":"string","required":false,"description":""},{"name":"productId","in":"query","type":"string","required":false,"description":"Id of the product."},{"name":"arrangementStatus","in":"query","type":"string","required":false,"description":"Status of the arrangement: UNAUTH - input but not authorised yet. AUTH - authorised. AUTH-FWD (Forward) - authorised, will become active on a future date. CURRENT - the arrangement has begun full or p"},{"name":"productGroupId","in":"query","type":"string","required":false,"description":"The group, as defined by the institution, that the product belongs to."},{"name":"subArrangementName","in":"query","type":"string","required":false,"description":""},{"name":"inputterId","in":"query","type":"string","required":false,"description":""},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from t24 on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":""},{"name":"companyId","in":"header","type":"string","required":false,"description":""}],"requestBodyExample":null,"responses":{"200":"OnlineServiceApprovalsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"PUT","path":"/holdings/onlineServices/{arrangementActivityId}/{arrangementId}","fullPath":"/api/v1.0.0/v1.0.0/holdings/onlineServices/{arrangementActivityId}/{arrangementId}","operationId":"createOnlineService","name":"","summary":"","tags":[],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":""},{"name":"companyId","in":"header","type":"string","required":false,"description":""},{"name":"arrangementActivityId","in":"path","type":"string","required":true,"description":""},{"name":"arrangementId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"customerIds":[{}],"properties":[{}],"overrides":[{}],"productId":"string","masterArrangementId":"string","subArrangementName":"string","currencyId":"string","effectiveDate":"2024-01-01","activityId":"string","transactionAmount":0.0,"customer":{"customers":{},"jointLiability":{}},"tcpermissions":{"definedCustomers":{},"defPrdGroups":{},"relCustomers":{},"masterLevelChange":{}},"tcprivileges":{"services":{},"masterLevelChange":{}},"tcavailability":{"day":{},"masterLevelChange":{}},"dailylimits":{"system":{},"transaction":{},"currency":{},"riskRate":{},"timeOfDay":{},"currencyId":{},"limitAmount":{}}}},"responses":{"200":"createOnlineServiceResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}}]},{"key":"holdings-userAdmin-service-v2.0.0","title":"Channels User Administration","version":"v2.0.0","description":"Channels User Administration - Holdings APIs are used to create online service arrangements containing privileges, permissions for Channel users. Online Service Arrangements are CUSTOMER specific, personalized instances of a Online Service Product, for example, providing access to the Online Banking","endpointCount":15,"endpoints":[{"method":"GET","path":"/holdings/onlineServices","fullPath":"/api/v2.0.0/v2.0.0/holdings/onlineServices","operationId":"getOnlineServices","name":"Retrieves online service arrangement for a customer, supports various selection filters like customerId, arrangementId, status, product and etc.","summary":"Retrieves Online Service Arrangements created for customer","tags":[],"parameters":[{"name":"arrangementId","in":"query","type":"string","required":false,"description":"The unique identifier of an arrangement contract."},{"name":"arrangementStatus","in":"query","type":"string","required":false,"description":"Status of the arrangement. E.g. AUTH, CLOSE, UNAUTH etc."},{"name":"masterOnly","in":"query","type":"string","required":false,"description":"Contains flag value to retrieve Online Service master contracts."},{"name":"roleOnly","in":"query","type":"string","required":false,"description":"Contains flag value to retrieve Online Service role contracts or sub contracts."},{"name":"productGroupId","in":"query","type":"string","required":false,"description":"The group, as defined by the institution, that the product belongs to."},{"name":"productId","in":"query","type":"string","required":false,"description":"Contains the unique identifier of the product, e.g. the product id of the arrangement account."},{"name":"customerId","in":"query","type":"string","required":false,"description":"Identifier of the customer"},{"name":"subArrangementName","in":"query","type":"string","required":false,"description":"The name of the sub arrangement that is displayed."},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from t24 on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"The identifier of the underlying Entity/Company/Branch."}],"requestBodyExample":null,"responses":{"200":"OnlineServicesResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"POST","path":"/holdings/onlineServices","fullPath":"/api/v2.0.0/v2.0.0/holdings/onlineServices","operationId":"validateOnlineService","name":"Validates Online Service Arrangement request, this is mainly used before creating the arrangement","summary":"Validates the arrangement creation request","tags":[],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"The identifier of the underlying Entity/Company/Branch."}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"customerIds":[{}],"properties":[{}],"overrides":[{}],"productId":"string","masterArrangementId":"string","roleName":"string","currencyId":"string","effectiveDate":"2024-01-01","activityId":"string","transactionAmount":0.0,"customer":{"customers":{},"jointLiability":{}},"tcpermissions":{"definedCustomers":{},"defPrdGroups":{},"relCustomers":{},"masterLevelChange":{}},"tcprivileges":{"services":{},"masterLevelChange":{}},"tcavailability":{"day":{},"masterLevelChange":{}},"dailylimits":{"system":{},"transaction":{},"currency":{},"riskRate":{},"customerLimits":{},"utilisationReset":{},"timeOfDay":{},"currencyId":{},"limitAmount":{},"usageUpdate":{},"customerMaximumLimit":{}}}},"responses":{"200":"validateOnlineServiceResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"PUT","path":"/holdings/onlineServiceApprovals/amendments/{arrangementActivityId}/{arrangementId}","fullPath":"/api/v2.0.0/v2.0.0/holdings/onlineServiceApprovals/amendments/{arrangementActivityId}/{arrangementId}","operationId":"amendOnlineService","name":"To update Online Service Arrangement created for a customer","summary":"Updates the arrangement for a customer","tags":[],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"The identifier of the underlying Entity/Company/Branch."},{"name":"arrangementActivityId","in":"path","type":"string","required":true,"description":"The unique identifiier of an arrangementactivity contract."},{"name":"arrangementId","in":"path","type":"string","required":true,"description":"The unique identifier of an arrangement contract."}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"customerIds":[{}],"properties":[{}],"overrides":[{}],"productId":"string","masterArrangementId":"string","roleName":"string","currencyId":"string","effectiveDate":"2024-01-01","activityId":"string","transactionAmount":0.0,"customer":{"customers":{},"jointLiability":{}},"tcpermissions":{"definedCustomers":{},"defPrdGroups":{},"relCustomers":{},"masterLevelChange":{}},"tcprivileges":{"services":{},"masterLevelChange":{}},"tcavailability":{"day":{},"masterLevelChange":{}},"dailylimits":{"system":{},"transaction":{},"currency":{},"riskRate":{},"customerLimits":{},"utilisationReset":{},"timeOfDay":{},"currencyId":{},"limitAmount":{},"usageUpdate":{},"customerMaximumLimit":{}}}},"responses":{"200":"amendOnlineServiceResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"GET","path":"/holdings/onlineServiceApprovals/activity/{arrangementActivityId}","fullPath":"/api/v2.0.0/v2.0.0/holdings/onlineServiceApprovals/activity/{arrangementActivityId}","operationId":"getOnlineServiceApprovalByArrangementActivity","name":"Retrieves the pending arrangement awaiting approval","summary":"Retrieves the pending arrangement awaiting approval","tags":[],"parameters":[{"name":"status","in":"query","type":"string","required":false,"description":"The status of the record"},{"name":"arrangementId","in":"query","type":"string","required":false,"description":"The unique identifier of an arrangement contract."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"The identifier of the underlying Entity/Company/Branch."},{"name":"arrangementActivityId","in":"path","type":"string","required":true,"description":"The unique identifiier of an arrangementactivity contract."}],"requestBodyExample":null,"responses":{"200":"getOnlineServiceApprovalByArrangementActivityResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"PUT","path":"/holdings/onlineServiceApprovals/activity/{arrangementActivityId}","fullPath":"/api/v2.0.0/v2.0.0/holdings/onlineServiceApprovals/activity/{arrangementActivityId}","operationId":"approveOnlineService","name":"Approves Online Service Arrangement created for a customer","summary":"Approves an arrangement created for a customer","tags":[],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"The identifier of the underlying Entity/Company/Branch."},{"name":"arrangementActivityId","in":"path","type":"string","required":true,"description":"The unique identifiier of an arrangementactivity contract."}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"customerIds":[{}],"properties":[{}],"overrides":[{}],"productId":"string","masterArrangementId":"string","roleName":"string","currencyId":"string","effectiveDate":"2024-01-01","activityId":"string","transactionAmount":0.0,"customer":{"customers":{},"jointLiability":{}},"tcpermissions":{"definedCustomers":{},"defPrdGroups":{},"relCustomers":{},"masterLevelChange":{}},"tcprivileges":{"services":{},"masterLevelChange":{}},"tcavailability":{"day":{},"masterLevelChange":{}},"dailylimits":{"system":{},"transaction":{},"currency":{},"riskRate":{},"customerLimits":{},"utilisationReset":{},"timeOfDay":{},"currencyId":{},"limitAmount":{},"usageUpdate":{},"customerMaximumLimit":{}}}},"responses":{"200":"approveOnlineServiceResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"DELETE","path":"/holdings/onlineServiceApprovals/activity/{arrangementActivityId}","fullPath":"/api/v2.0.0/v2.0.0/holdings/onlineServiceApprovals/activity/{arrangementActivityId}","operationId":"rejectOnlineService","name":"Rejects the pending arrangement awaiting approval","summary":"Rejects the pending arrangement awaiting approval","tags":[],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"The identifier of the underlying Entity/Company/Branch."},{"name":"arrangementActivityId","in":"path","type":"string","required":true,"description":"The unique identifiier of an arrangementactivity contract."}],"requestBodyExample":null,"responses":{"200":"rejectOnlineServiceResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"PUT","path":"/holdings/onlineServiceApprovals/{arrangementActivityId}/{arrangementId}","fullPath":"/api/v2.0.0/v2.0.0/holdings/onlineServiceApprovals/{arrangementActivityId}/{arrangementId}","operationId":"initiateOnlineService","name":"Creates an Online Service Arrangement in pending status","summary":"Creates an arrangement in pending status","tags":[],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"The identifier of the underlying Entity/Company/Branch."},{"name":"arrangementActivityId","in":"path","type":"string","required":true,"description":"The unique identifiier of an arrangementactivity contract."},{"name":"arrangementId","in":"path","type":"string","required":true,"description":"The unique identifier of an arrangement contract."}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"customerIds":[{}],"properties":[{}],"overrides":[{}],"productId":"string","masterArrangementId":"string","roleName":"string","currencyId":"string","effectiveDate":"2024-01-01","activityId":"string","transactionAmount":0.0,"customer":{"customers":{},"jointLiability":{}},"tcpermissions":{"definedCustomers":{},"defPrdGroups":{},"relCustomers":{},"masterLevelChange":{}},"tcprivileges":{"services":{},"masterLevelChange":{}},"tcavailability":{"day":{},"masterLevelChange":{}},"dailylimits":{"system":{},"transaction":{},"currency":{},"riskRate":{},"customerLimits":{},"utilisationReset":{},"timeOfDay":{},"currencyId":{},"limitAmount":{},"usageUpdate":{},"customerMaximumLimit":{}}}},"responses":{"200":"initiateOnlineServiceResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"GET","path":"/holdings/customers/{customerId}/productGroups/{productGroupId}/products","fullPath":"/api/v2.0.0/v2.0.0/holdings/customers/{customerId}/productGroups/{productGroupId}/products","operationId":"getCustomerProductsByProductGroup","name":"Retrieves the list of accounts, loans, deposits and other holdings for a customer based on the Product Group","summary":"Retrieves the list of customer holdings for a Product Group","tags":[],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"Identifier of the customer"},{"name":"productGroupId","in":"path","type":"string","required":true,"description":"The group, as defined by the institution, that the product belongs to."},{"name":"allowedProducts","in":"query","type":"string","required":false,"description":"Product or products allowed to be used within the product bundle."},{"name":"companyId","in":"query","type":"string","required":false,"description":"The identifier of the underlying Entity/Company/Branch."},{"name":"productId","in":"query","type":"string","required":false,"description":"Contains the unique identifier of the product, e.g. the product id of the arrangement account."},{"name":"onlineServicesProductId","in":"query","type":"string","required":false,"description":"Identifier of Online Service product, for eg: Retail Online Service, Corporate Online Server and etc.."},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from t24 on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"The identifier of the underlying Entity/Company/Branch."}],"requestBodyExample":null,"responses":{"200":"CustomerProductsByProductGroupResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/customers/{customerId}/onlineServices/{onlineServicesProductId}/products","fullPath":"/api/v2.0.0/v2.0.0/holdings/customers/{customerId}/onlineServices/{onlineServicesProductId}/products","operationId":"getCustomerProductsByOnlineServicesProduct","name":"Retrieves the list of customer holdings like accounts, loans, deposits and etc for an Online Service Product","summary":"Retrieves the list of  customer holdings for an Online Service Product","tags":[],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"Identifier of the customer"},{"name":"onlineServicesProductId","in":"path","type":"string","required":true,"description":"Identifier of Online Service product, for eg: Retail Online Service, Corporate Online Server and etc.."},{"name":"allowedProducts","in":"query","type":"string","required":false,"description":"Product or products allowed to be used within the product bundle."},{"name":"companyId","in":"query","type":"string","required":false,"description":"The identifier of the underlying Entity/Company/Branch."},{"name":"productId","in":"query","type":"string","required":false,"description":"Contains the unique identifier of the product, e.g. the product id of the arrangement account."},{"name":"productGroupId","in":"query","type":"string","required":false,"description":"The group, as defined by the institution, that the product belongs to."},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from t24 on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"The identifier of the underlying Entity/Company/Branch."}],"requestBodyExample":null,"responses":{"200":"CustomerProductsByOnlineServicesProductResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/onlineServices/{arrangementId}/externalUserAllocations","fullPath":"/api/v2.0.0/v2.0.0/holdings/onlineServices/{arrangementId}/externalUserAllocations","operationId":"getExternalUserAllocations","name":"Retrieves the list of external users created for the given Online Service Arrangement","summary":"Retrieves the list of external users created for an arrangement","tags":[],"parameters":[{"name":"arrangementId","in":"path","type":"string","required":true,"description":"The unique identifier of an arrangement contract."},{"name":"subArrangementId","in":"query","type":"string","required":false,"description":"The subset of Master arrangement."},{"name":"masterOnly","in":"query","type":"string","required":false,"description":"Contains flag value to retrieve Online Service master contracts."},{"name":"Contains flag value for retrieving count of user and arrangements linked to a paticular arrangement.","in":"query","type":"string","required":false,"description":"Contains flag value for retrieving count of user and arrangements linked to a paticular arrangement."},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from t24 on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"The identifier of the underlying Entity/Company/Branch."}],"requestBodyExample":null,"responses":{"200":"ExternalUserAllocationsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/onlineServices/{arrangementId}","fullPath":"/api/v2.0.0/v2.0.0/holdings/onlineServices/{arrangementId}","operationId":"getOnlineServiceByArrangement","name":"Retrieves an Online Service Arrangement by using Arrangement Id","summary":"Retrieves an Online Service Arrangement by using Arrangement Id","tags":[],"parameters":[{"name":"status","in":"query","type":"string","required":false,"description":"The status of the record"},{"name":"arrangementActivityId","in":"query","type":"string","required":false,"description":"The unique identifiier of an arrangementactivity contract."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"The identifier of the underlying Entity/Company/Branch."},{"name":"arrangementId","in":"path","type":"string","required":true,"description":"The unique identifier of an arrangement contract."}],"requestBodyExample":null,"responses":{"200":"getOnlineServiceByArrangementResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/onlineServices/activity/{arrangementActivityId}","fullPath":"/api/v2.0.0/v2.0.0/holdings/onlineServices/activity/{arrangementActivityId}","operationId":"getOnlineServiceByArrangementActivity","name":"Retrieves an Online Service Arranagement by using Arrangement Activity Id","summary":"Retrieves an Online Service Arranagement by using Arrangement Activity Id","tags":[],"parameters":[{"name":"status","in":"query","type":"string","required":false,"description":"The status of the record"},{"name":"arrangementId","in":"query","type":"string","required":false,"description":"The unique identifier of an arrangement contract."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"The identifier of the underlying Entity/Company/Branch."},{"name":"arrangementActivityId","in":"path","type":"string","required":true,"description":"The unique identifiier of an arrangementactivity contract."}],"requestBodyExample":null,"responses":{"200":"getOnlineServiceByArrangementActivityResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/onlineServiceApprovals/{arrangementId}","fullPath":"/api/v2.0.0/v2.0.0/holdings/onlineServiceApprovals/{arrangementId}","operationId":"getOnlineServiceApprovalByArrangement","name":"Retrieves a pending Online Service Arranagement by using Arrangement Id","summary":"Retrieves a pending Online Service Arranagement by using Arrangement Id","tags":[],"parameters":[{"name":"status","in":"query","type":"string","required":false,"description":"The status of the record"},{"name":"arrangementActivityId","in":"query","type":"string","required":false,"description":"The unique identifiier of an arrangementactivity contract."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"The identifier of the underlying Entity/Company/Branch."},{"name":"arrangementId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":null,"responses":{"200":"getOnlineServiceApprovalByArrangementResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/onlineServiceApprovals","fullPath":"/api/v2.0.0/v2.0.0/holdings/onlineServiceApprovals","operationId":"getOnlineServiceApprovals","name":"Retrieves pending Online Service Arranagements awaiting approval","summary":"Retrieves pending Online Service Arranagements awaiting approval","tags":[],"parameters":[{"name":"customerId","in":"query","type":"string","required":false,"description":"Identifier of the customer"},{"name":"arrangementId","in":"query","type":"string","required":false,"description":"The unique identifier of an arrangement contract."},{"name":"masterOnly","in":"query","type":"string","required":false,"description":"Contains flag value to retrieve Online Service master contracts."},{"name":"roleOnly","in":"query","type":"string","required":false,"description":"Contains flag value to retrieve Online Service role contracts or sub contracts."},{"name":"productId","in":"query","type":"string","required":false,"description":"Contains the unique identifier of the product, e.g. the product id of the arrangement account."},{"name":"arrangementStatus","in":"query","type":"string","required":false,"description":"Status of the arrangement. E.g. AUTH, CLOSE, UNAUTH etc."},{"name":"productGroupId","in":"query","type":"string","required":false,"description":"The group, as defined by the institution, that the product belongs to."},{"name":"subArrangementName","in":"query","type":"string","required":false,"description":"The name of the sub arrangement that is displayed."},{"name":"inputterId","in":"query","type":"string","required":false,"description":""},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from t24 on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"The identifier of the underlying Entity/Company/Branch."}],"requestBodyExample":null,"responses":{"200":"OnlineServiceApprovalsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"PUT","path":"/holdings/onlineServices/{arrangementActivityId}/{arrangementId}","fullPath":"/api/v2.0.0/v2.0.0/holdings/onlineServices/{arrangementActivityId}/{arrangementId}","operationId":"createOnlineService","name":"Create an Online Service Arrangement","summary":"Create an Online Service Arrangement","tags":[],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"The identifier of the underlying Entity/Company/Branch."},{"name":"arrangementActivityId","in":"path","type":"string","required":true,"description":"The unique identifiier of an arrangementactivity contract."},{"name":"arrangementId","in":"path","type":"string","required":true,"description":"The unique identifier of an arrangement contract."}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"customerIds":[{}],"properties":[{}],"overrides":[{}],"productId":"string","masterArrangementId":"string","roleName":"string","currencyId":"string","effectiveDate":"2024-01-01","activityId":"string","transactionAmount":0.0,"customer":{"customers":{},"jointLiability":{}},"tcpermissions":{"definedCustomers":{},"defPrdGroups":{},"relCustomers":{},"masterLevelChange":{}},"tcprivileges":{"services":{},"masterLevelChange":{}},"tcavailability":{"day":{},"masterLevelChange":{}},"dailylimits":{"system":{},"transaction":{},"currency":{},"riskRate":{},"customerLimits":{},"utilisationReset":{},"timeOfDay":{},"currencyId":{},"limitAmount":{},"usageUpdate":{},"customerMaximumLimit":{}}}},"responses":{"200":"createOnlineServiceResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}}]}]},{"name":"Requesttopaypayments","serviceCount":14,"endpointCount":412,"services":[{"key":"RequestToPayPayments-v1.0.0","title":"Request to Pay Payment services","version":"v1.0.0","description":"APIs to create and manage Request to Pay payments in order to create, view, update, block and decline the payment requests from both Biller and Payer systems","endpointCount":22,"endpoints":[{"method":"PUT","path":"/order/paymentRequests/{requestId}/extensions","fullPath":"/api/v1.0.0/order/paymentRequests/{requestId}/extensions","operationId":"updateDateExtension","name":"Enables the payer to request the biller for a new due date in the future for the biller's payment request","summary":"Request the biller for an extension of the payment due date","tags":[],"parameters":[{"name":"requestId","in":"path","type":"string","required":true,"description":"The guarantees issuance id initiated by internet banking"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"additionalInfo":[{}],"requestedExpiryDate":"string","payerResponse":"string"}},"responses":{"200":"DateExtensionResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/order/paymentRequests/{requestId}/declinedRequests","fullPath":"/api/v1.0.0/order/paymentRequests/{requestId}/declinedRequests","operationId":"updateDeclinePayment","name":"Enables the payer to decline the biller's payment request when payer does not want make any payment towards that request","summary":"Decline the payment request from biller","tags":[],"parameters":[{"name":"requestId","in":"path","type":"string","required":true,"description":"The guarantees issuance id initiated by internet banking"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"additionalInfoToRequestor":[{}],"payerResponse":"string"}},"responses":{"200":"DeclinePaymentResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/order/paymentRequests/{requestId}/billerNotes","fullPath":"/api/v1.0.0/order/paymentRequests/{requestId}/billerNotes","operationId":"updateNotesToRequestor","name":"Enables the payer to send messages to biller when the payer requires further information regarding a specific payment request","summary":"Update the messages sent to biller by payer","tags":[],"parameters":[{"name":"requestId","in":"path","type":"string","required":true,"description":"The guarantees issuance id initiated by internet banking"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"notesToRequestor":[{}],"payerResponse":"string"}},"responses":{"200":"NotesToRequestorResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/order/paymentRequests/{requestId}/amountModifications","fullPath":"/api/v1.0.0/order/paymentRequests/{requestId}/amountModifications","operationId":"updatePaymentAmount","name":"Enables the payer to modify the amount requested by biller, if modification is allowed by the respective scheme","summary":"Update the requested amount in a payment request","tags":[],"parameters":[{"name":"requestId","in":"path","type":"string","required":true,"description":"The guarantees issuance id initiated by internet banking"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"debitAccount":"string","payerAccountIBAN":"string","amountModifiedByPayer":"string"}},"responses":{"200":"PaymentAmountResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/order/paymentRequests/{requestId}/blocks","fullPath":"/api/v1.0.0/order/paymentRequests/{requestId}/blocks","operationId":"updateDeclineAndBlock","name":"Enables the payer to decline the biller's payment request and block the biller when payer does not want make any payment towards that biller","summary":"Decline the payment request and block the biller","tags":[],"parameters":[{"name":"requestId","in":"path","type":"string","required":true,"description":"The guarantees issuance id initiated by internet banking"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"additionalInfoToRequestor":[{}],"payerResponse":"string"}},"responses":{"200":"DeclineAndBlockResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/order/paymentRequests/{requestId}/payerNotes","fullPath":"/api/v1.0.0/order/paymentRequests/{requestId}/payerNotes","operationId":"updateNotesToPayer","name":"Enables the biller to send messages to payer when the biller requires further information regarding a specific payment request","summary":"Update the messages sent to payer by biller","tags":[],"parameters":[{"name":"requestId","in":"path","type":"string","required":true,"description":"The guarantees issuance id initiated by internet banking"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"notesToPayer":[{}],"payerName":"string","creditAccountId":"string","requestorAccountIBAN":"string","requestorName":"string","requestedExecutionDate":"string","endToEndReference":"string","remittanceInformation":"string"}},"responses":{"200":"NotesToPayerResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/order/paymentRequests/{requestId}/extensions/acceptances","fullPath":"/api/v1.0.0/order/paymentRequests/{requestId}/extensions/acceptances","operationId":"getPayerListWithExtensionGranted","name":"Retrieves the payers payments requests for which the due date extensions have been granted by the biller","summary":"Retrieves the payment requests for which extension have been granted","tags":[],"parameters":[{"name":"requestId","in":"path","type":"string","required":true,"description":""},{"name":"customerId","in":"query","type":"string","required":false,"description":"Identifier of the customer"},{"name":"scheme","in":"query","type":"string","required":false,"description":"Represents the scheme (a synonym for the National ID type) under which the National ID is defined"},{"name":"currentState","in":"query","type":"string","required":false,"description":"Contains the current state of the transaction"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"PayerListWithExtensionGrantedResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"PUT","path":"/order/paymentRequests/{requestId}/extensions/acceptances","fullPath":"/api/v1.0.0/order/paymentRequests/{requestId}/extensions/acceptances","operationId":"updateGrantExtension","name":"Enables the Biller to approve the new due date for the payment, requested by the payer","summary":"Approve the due date extension requested by the payer","tags":[],"parameters":[{"name":"requestId","in":"path","type":"string","required":true,"description":"The guarantees issuance id initiated by internet banking"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"additionalInfo":[{}]}},"responses":{"200":"GrantExtensionResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/order/paymentRequests/{requestId}/extensions/rejections","fullPath":"/api/v1.0.0/order/paymentRequests/{requestId}/extensions/rejections","operationId":"getPayersListWithExtensionDeclined","name":"Retrieves the incoming payments requests for which extensions have been declined by the biller","summary":"Retrieves the incoming payment requests for which the extension have been declined","tags":[],"parameters":[{"name":"requestId","in":"path","type":"string","required":true,"description":""},{"name":"customerId","in":"query","type":"string","required":false,"description":"Identifier of the customer"},{"name":"scheme","in":"query","type":"string","required":false,"description":"Represents the scheme (a synonym for the National ID type) under which the National ID is defined"},{"name":"currentState","in":"query","type":"string","required":false,"description":"Contains the current state of the transaction"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"PayersListWithExtensionDeclinedResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"PUT","path":"/order/paymentRequests/{requestId}/extensions/rejections","fullPath":"/api/v1.0.0/order/paymentRequests/{requestId}/extensions/rejections","operationId":"updateDeclineExtension","name":"Enables the biller to decline the due date extension for the payment requested by the payer","summary":"Decline the due date extension requested by payer","tags":[],"parameters":[{"name":"requestId","in":"path","type":"string","required":true,"description":"The guarantees issuance id initiated by internet banking"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"additionalInfo":[{}],"requestorResponse":"string"}},"responses":{"200":"DeclineExtensionResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/order/paymentRequests/{requestId}/billers/pendingExtensions","fullPath":"/api/v1.0.0/order/paymentRequests/{requestId}/billers/pendingExtensions","operationId":"getRequestorsDateExtension","name":"Retrieves the  payment requests with biller which are awaiting response for due date extension. These requests can either be declined or approved by the biller","summary":"Retrieves the billers payment requests which are awaiting due date extension approval","tags":[],"parameters":[{"name":"requestId","in":"path","type":"string","required":true,"description":""},{"name":"customerId","in":"query","type":"string","required":false,"description":"Identifier of the customer"},{"name":"scheme","in":"query","type":"string","required":false,"description":"Represents the scheme (a synonym for the National ID type) under which the National ID is defined"},{"name":"requestorReference","in":"query","type":"string","required":false,"description":"Contains the reference of the requestor"},{"name":"currentState","in":"query","type":"string","required":false,"description":"Contains the current state of the transaction"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"RequestorsDateExtensionResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/order/paymentRequests/{requestId}/errors","fullPath":"/api/v1.0.0/order/paymentRequests/{requestId}/errors","operationId":"getOutwardErrors","name":"Retrieves the payment requests which are in error status due to technical reasons such as payment processing failures.","summary":"Retrieve the payment requests which are in error status","tags":[],"parameters":[{"name":"requestId","in":"path","type":"string","required":true,"description":""},{"name":"customerId","in":"query","type":"string","required":false,"description":"Identifier of the customer"},{"name":"scheme","in":"query","type":"string","required":false,"description":"Represents the scheme (a synonym for the National ID type) under which the National ID is defined"},{"name":"currentState","in":"query","type":"string","required":false,"description":"Contains the current state of the transaction"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"OutwardErrorsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/order/paymentRequests/{requestId}/billers/pendingAcknowledgements","fullPath":"/api/v1.0.0/order/paymentRequests/{requestId}/billers/pendingAcknowledgements","operationId":"getApiPendingAck","name":"Retrieves the payment requests which are yet to be acknowledged by the biller. Generally, Partially paid or Paid are the two statuses with which the biller acknowledges the payer","summary":"Retrieves the billers payment requests which are pending to be acknowledged","tags":[],"parameters":[{"name":"requestId","in":"path","type":"string","required":true,"description":""},{"name":"customerId","in":"query","type":"string","required":false,"description":"Identifier of the customer"},{"name":"scheme","in":"query","type":"string","required":false,"description":"Represents the scheme (a synonym for the National ID type) under which the National ID is defined"},{"name":"currentState","in":"query","type":"string","required":false,"description":"Contains the current state of the transaction"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"ApiPendingAckResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"POST","path":"/order/paymentRequests","fullPath":"/api/v1.0.0/order/paymentRequests","operationId":"createPaymentRequests","name":"Create payment requests for EBA and UK scheme from Biller application","summary":"Payment request initiation for EBA and UK Scheme","tags":[],"parameters":[{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"chargeDetails":[{}],"portalInfo":[{}],"errorInfo":[{}],"paymentMethod":"string","requestedExecutionDate":"string","payerName":"string","payerStreetName":"string","payerBuildingNumber":"string","payerPostalCode":"string","payerTownName":"string","payerCountry":"string","payerDateOfBirth":"string","payerCityOfBirth":"string","payerCountryOfBirth":"string","debitAccount":"string"}},"responses":{"200":"PaymentRequestsResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/order/paymentRequests/{requestId}/partialPayments","fullPath":"/api/v1.0.0/order/paymentRequests/{requestId}/partialPayments","operationId":"updatePartialPayment","name":"Enables the Payer to accept Biller's request but pays only a part of the outstanding amount. The original request sent by the biller remains open until the total amount is paid by the payer","summary":"Update partial payment by payer","tags":[],"parameters":[{"name":"requestId","in":"path","type":"string","required":true,"description":"The guarantees issuance id initiated by internet banking"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"additionalInfo":[{}],"debitAmount":"string","currentBalance":"string","requestedExecutionDate":"string","debitAccount":"string","paymentReference":"string","payerResponse":"string","amountModifiedByPayer":"string","payerAccountIBAN":"string","paymentDate":"string"}},"responses":{"200":"PartialPaymentResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/order/paymentRequests/{requestId}/payments","fullPath":"/api/v1.0.0/order/paymentRequests/{requestId}/payments","operationId":"updateFullPayment","name":"Enables the payer to accept the biller's request and pay the outstanding amount","summary":"Update the payment with full amount requested by the biller","tags":[],"parameters":[{"name":"requestId","in":"path","type":"string","required":true,"description":"The guarantees issuance id initiated by internet banking"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"additionalInfo":[{}],"debitAccount":"string","currentBalance":"string","requestedExecutionDate":"string","paymentReference":"string","amountModifiedByPayer":"string","payerAccountIBAN":"string","paymentDate":"string"}},"responses":{"200":"FullPaymentResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/order/paymentRequests/payers/status","fullPath":"/api/v1.0.0/order/paymentRequests/payers/status","operationId":"getPayersStatus","name":"Retrieves the list of payer payment requests which are in pending, completed and askForExtension status and requires action from payer","summary":"Retrieves the list of payment requests that are pending, completed and askForExtension with payer","tags":[],"parameters":[{"name":"currentState","in":"query","type":"string","required":false,"description":"Contains the current state of the transaction"},{"name":"customerId","in":"query","type":"string","required":false,"description":"Identifier of the customer"},{"name":"scheme","in":"query","type":"string","required":false,"description":"Represents the scheme (a synonym for the National ID type) under which the National ID is defined"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"PayersStatusResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"POST","path":"/order/paymentRequests/ukPayments/billerRequests","fullPath":"/api/v1.0.0/order/paymentRequests/ukPayments/billerRequests","operationId":"createPayUKPaymentRequests","name":"Creates payment request for UK scheme. This API can be linked to any published API which is in accordance to requesttopay.co.uk standards","summary":"Payment request initiation for UK scheme from biller to payer system","tags":[],"parameters":[{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"portalInfo":[{}],"errorInfo":[{}],"chargeDetails":[{}],"paymentStatus":[{}],"acceptanceDateTime":[{}],"additionalInfo":[{}],"messageToPayer":[{}],"messageToRequestor":[{}],"paymentReferenceDetails":[{}],"endToEndReference":"string","paymentMethod":"string","requestorBankBic":"string","requestorBankSortCode":"string","requestorAccountIBAN":"string","requestorAccountNumber":"string"}},"responses":{"200":"PayUKPaymentRequestsResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/order/paymentRequests/{requestId}/ukPayments","fullPath":"/api/v1.0.0/order/paymentRequests/{requestId}/ukPayments","operationId":"amendPayUKPaymentForRepository","name":" Update payment request onto the biller system from payer to support partial payment, full payment, due date extension request , decline and block the biller, decline the payment request and messages sent to the biller. Similarly, update payment request onto the payer system from biller to support approval of due date extension, rejection of due date extension, messages sent to the payer and acknowledgement to payer.This API can be linked to any published API which is in accordance to requesttop","summary":"Manages payment requests for UK scheme between biller and payer systems","tags":[],"parameters":[{"name":"requestId","in":"path","type":"string","required":true,"description":"The guarantees issuance id initiated by internet banking"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"portalInfo":[{}],"errorInfo":[{}],"chargeDetails":[{}],"paymentStatus":[{}],"acceptanceDateTime":[{}],"additionalInfo":[{}],"messageToPayer":[{}],"messageToRequestor":[{}],"paymentReferenceDetails":[{}],"endToEndReference":"string","paymentMethod":"string","requestorBankBic":"string","requestorBankSortCode":"string","requestorAccountIBAN":"string","requestorAccountNumber":"string"}},"responses":{"200":"PayUKPaymentForRepositoryResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/order/paymentRequests/{requestId}/payers","fullPath":"/api/v1.0.0/order/paymentRequests/{requestId}/payers","operationId":"getPayersList","name":"Retrieves the list of payer payment requests which are in Completed, Partially paid, Extension Granted, Declined, Extension Declined and Asked For Extension status","summary":"Retrieves the payer payment requests","tags":[],"parameters":[{"name":"requestId","in":"path","type":"string","required":true,"description":""},{"name":"customerId","in":"query","type":"string","required":false,"description":"Identifier of the customer"},{"name":"scheme","in":"query","type":"string","required":false,"description":"Represents the scheme (a synonym for the National ID type) under which the National ID is defined"},{"name":"requestorReference","in":"query","type":"string","required":false,"description":"Contains the reference of the requestor"},{"name":"currentState","in":"query","type":"string","required":false,"description":"Contains the current state of the transaction"},{"name":"endToEndReference","in":"query","type":"string","required":false,"description":"Indicates the end to end reference for the payment. This field can be provided by the person who instructs the payment and this flows through the lifecycle of the payment."},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"PayersListResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/order/paymentRequests/{requestId}/billers","fullPath":"/api/v1.0.0/order/paymentRequests/{requestId}/billers","operationId":"getRequestorsOutwardRequest","name":"Retrieves the list of biller payment requests which are in Completed, Rejected and Pending status","summary":"Retrieves the list of biller payment requests","tags":[],"parameters":[{"name":"requestId","in":"path","type":"string","required":true,"description":""},{"name":"currentState","in":"query","type":"string","required":false,"description":"Contains the current state of the transaction"},{"name":"customerId","in":"query","type":"string","required":false,"description":"Identifier of the customer"},{"name":"scheme","in":"query","type":"string","required":false,"description":"Represents the scheme (a synonym for the National ID type) under which the National ID is defined"},{"name":"endToEndReference","in":"query","type":"string","required":false,"description":"Indicates the end to end reference for the payment. This field can be provided by the person who instructs the payment and this flows through the lifecycle of the payment."},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"RequestorsOutwardRequestResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"PUT","path":"/order/paymentRequests/{requestId}/billers/acknowledgements","fullPath":"/api/v1.0.0/order/paymentRequests/{requestId}/billers/acknowledgements","operationId":"updateBillerAcknowledgements","name":"Enables the biller to send full acknowledgement to payer when payer paid full amount and send partial acknowledgement to payer when payer paid partial amount","summary":"Update the full or partial acknowledgement in a payment request","tags":[],"parameters":[{"name":"requestId","in":"path","type":"string","required":true,"description":"The guarantees issuance id initiated by internet banking"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"requestorResponse":"string"}},"responses":{"200":"BillerAcknowledgementsResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}}]},{"key":"RequestToPayPayments-v1.1.0","title":"Request to Pay Payment services","version":"v1.1.0","description":"APIs to create and manage Request to Pay payments in order to create, view, update, block and decline the payment requests from both Biller and Payer systems","endpointCount":22,"endpoints":[{"method":"PUT","path":"/order/paymentRequests/{requestId}/extensions","fullPath":"/api/v1.1.0/order/paymentRequests/{requestId}/extensions","operationId":"updateDateExtension","name":"Enables the payer to request the biller for a new due date in the future for the biller's payment request","summary":"Request the biller for an extension of the payment due date","tags":[],"parameters":[{"name":"requestId","in":"path","type":"string","required":true,"description":"The guarantees issuance id initiated by internet banking"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"additionalInfo":[{}],"requestedExpiryDate":"string","payerResponse":"string"}},"responses":{"200":"DateExtensionResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/order/paymentRequests/{requestId}/declinedRequests","fullPath":"/api/v1.1.0/order/paymentRequests/{requestId}/declinedRequests","operationId":"updateDeclinePayment","name":"Enables the payer to decline the biller's payment request when payer does not want make any payment towards that request","summary":"Decline the payment request from biller","tags":[],"parameters":[{"name":"requestId","in":"path","type":"string","required":true,"description":"The guarantees issuance id initiated by internet banking"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"additionalInfoToRequestor":[{}],"payerResponse":"string"}},"responses":{"200":"DeclinePaymentResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/order/paymentRequests/{requestId}/billerNotes","fullPath":"/api/v1.1.0/order/paymentRequests/{requestId}/billerNotes","operationId":"updateNotesToRequestor","name":"Enables the payer to send messages to biller when the payer requires further information regarding a specific payment request","summary":"Update the messages sent to biller by payer","tags":[],"parameters":[{"name":"requestId","in":"path","type":"string","required":true,"description":"The guarantees issuance id initiated by internet banking"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"notesToRequestor":[{}],"payerResponse":"string"}},"responses":{"200":"NotesToRequestorResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/order/paymentRequests/{requestId}/amountModifications","fullPath":"/api/v1.1.0/order/paymentRequests/{requestId}/amountModifications","operationId":"updatePaymentAmount","name":"Enables the payer to modify the amount requested by biller, if modification is allowed by the respective scheme","summary":"Update the requested amount in a payment request","tags":[],"parameters":[{"name":"requestId","in":"path","type":"string","required":true,"description":"The guarantees issuance id initiated by internet banking"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"debitAccount":"string","payerAccountIBAN":"string","amountModifiedByPayer":"string"}},"responses":{"200":"PaymentAmountResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/order/paymentRequests/{requestId}/blocks","fullPath":"/api/v1.1.0/order/paymentRequests/{requestId}/blocks","operationId":"updateDeclineAndBlock","name":"Enables the payer to decline the biller's payment request and block the biller when payer does not want to make any payment towards that biller","summary":"Decline the payment request and block the biller","tags":[],"parameters":[{"name":"requestId","in":"path","type":"string","required":true,"description":"The guarantees issuance id initiated by internet banking"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"additionalInfoToRequestor":[{}],"payerResponse":"string"}},"responses":{"200":"DeclineAndBlockResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/order/paymentRequests/{requestId}/payerNotes","fullPath":"/api/v1.1.0/order/paymentRequests/{requestId}/payerNotes","operationId":"updateNotesToPayer","name":"Enables the biller to send messages to payer when the biller requires further information regarding a specific payment request","summary":"Update the messages sent to payer by biller","tags":[],"parameters":[{"name":"requestId","in":"path","type":"string","required":true,"description":"The guarantees issuance id initiated by internet banking"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"notesToPayer":[{}],"payerName":"string","creditAccountId":"string","requestorAccountIBAN":"string","requestorName":"string","requestedExecutionDate":"string","endToEndReference":"string","remittanceInformation":"string"}},"responses":{"200":"NotesToPayerResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/order/paymentRequests/{requestId}/extensions/acceptances","fullPath":"/api/v1.1.0/order/paymentRequests/{requestId}/extensions/acceptances","operationId":"getPayerListWithExtensionGranted","name":"Retrieves the payers payments requests for which the due date extensions have been granted by the biller","summary":"Retrieves the payment requests for which extension have been granted","tags":[],"parameters":[{"name":"requestId","in":"path","type":"string","required":true,"description":""},{"name":"customerId","in":"query","type":"string","required":false,"description":"Identifier of the customer"},{"name":"scheme","in":"query","type":"string","required":false,"description":"Represents the scheme (a synonym for the National ID type) under which the National ID is defined"},{"name":"currentState","in":"query","type":"string","required":false,"description":"Contains the current state of the transaction"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"PayerListWithExtensionGrantedResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"PUT","path":"/order/paymentRequests/{requestId}/extensions/acceptances","fullPath":"/api/v1.1.0/order/paymentRequests/{requestId}/extensions/acceptances","operationId":"updateGrantExtension","name":"Enables the Biller to approve the new due date for the payment, requested by the payer","summary":"Approve the due date extension requested by the payer","tags":[],"parameters":[{"name":"requestId","in":"path","type":"string","required":true,"description":"The guarantees issuance id initiated by internet banking"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"additionalInfo":[{}]}},"responses":{"200":"GrantExtensionResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/order/paymentRequests/{requestId}/extensions/rejections","fullPath":"/api/v1.1.0/order/paymentRequests/{requestId}/extensions/rejections","operationId":"getPayersListWithExtensionDeclined","name":"Retrieves the incoming payments requests for which extensions have been declined by the biller","summary":"Retrieves the incoming payment requests for which the extension have been declined","tags":[],"parameters":[{"name":"requestId","in":"path","type":"string","required":true,"description":""},{"name":"customerId","in":"query","type":"string","required":false,"description":"Identifier of the customer"},{"name":"scheme","in":"query","type":"string","required":false,"description":"Represents the scheme (a synonym for the National ID type) under which the National ID is defined"},{"name":"currentState","in":"query","type":"string","required":false,"description":"Contains the current state of the transaction"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"PayersListWithExtensionDeclinedResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"PUT","path":"/order/paymentRequests/{requestId}/extensions/rejections","fullPath":"/api/v1.1.0/order/paymentRequests/{requestId}/extensions/rejections","operationId":"updateDeclineExtension","name":"Enables the biller to decline the due date extension for the payment requested by the payer","summary":"Decline the due date extension requested by payer","tags":[],"parameters":[{"name":"requestId","in":"path","type":"string","required":true,"description":"The guarantees issuance id initiated by internet banking"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"additionalInfo":[{}],"requestorResponse":"string"}},"responses":{"200":"DeclineExtensionResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/order/paymentRequests/{requestId}/billers/pendingExtensions","fullPath":"/api/v1.1.0/order/paymentRequests/{requestId}/billers/pendingExtensions","operationId":"getRequestorsDateExtension","name":"Retrieves the  payment requests with biller which are awaiting response for due date extension. These requests can either be declined or approved by the biller","summary":"Retrieves the billers payment requests which are awaiting due date extension approval","tags":[],"parameters":[{"name":"requestId","in":"path","type":"string","required":true,"description":""},{"name":"customerId","in":"query","type":"string","required":false,"description":"Identifier of the customer"},{"name":"scheme","in":"query","type":"string","required":false,"description":"Represents the scheme (a synonym for the National ID type) under which the National ID is defined"},{"name":"requestorReference","in":"query","type":"string","required":false,"description":"Contains the reference of the requestor"},{"name":"currentState","in":"query","type":"string","required":false,"description":"Contains the current state of the transaction"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"RequestorsDateExtensionResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/order/paymentRequests/{requestId}/errors","fullPath":"/api/v1.1.0/order/paymentRequests/{requestId}/errors","operationId":"getOutwardErrors","name":"Retrieves the payment requests which are in error status due to technical reasons such as payment processing failures.","summary":"Retrieve the payment requests which are in error status","tags":[],"parameters":[{"name":"requestId","in":"path","type":"string","required":true,"description":""},{"name":"customerId","in":"query","type":"string","required":false,"description":"Identifier of the customer"},{"name":"scheme","in":"query","type":"string","required":false,"description":"Represents the scheme (a synonym for the National ID type) under which the National ID is defined"},{"name":"currentState","in":"query","type":"string","required":false,"description":"Contains the current state of the transaction"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"OutwardErrorsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/order/paymentRequests/{requestId}/billers/pendingAcknowledgements","fullPath":"/api/v1.1.0/order/paymentRequests/{requestId}/billers/pendingAcknowledgements","operationId":"getApiPendingAck","name":"Retrieves the payment requests which are yet to be acknowledged by the biller. Generally, Partially paid or Paid are the two statuses with which the biller acknowledges the payer","summary":"Retrieves the billers payment requests which are pending to be acknowledged","tags":[],"parameters":[{"name":"requestId","in":"path","type":"string","required":true,"description":""},{"name":"customerId","in":"query","type":"string","required":false,"description":"Identifier of the customer"},{"name":"scheme","in":"query","type":"string","required":false,"description":"Represents the scheme (a synonym for the National ID type) under which the National ID is defined"},{"name":"currentState","in":"query","type":"string","required":false,"description":"Contains the current state of the transaction"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"ApiPendingAckResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"POST","path":"/order/paymentRequests","fullPath":"/api/v1.1.0/order/paymentRequests","operationId":"createPaymentRequests","name":"Create payment requests for EBA and UK scheme from Biller application","summary":"Payment request initiation for EBA and UK Scheme","tags":[],"parameters":[{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"chargeDetails":[{}],"portalInfo":[{}],"errorInfo":[{}],"paymentMethod":"string","requestedExecutionDate":"string","payerName":"string","payerStreetName":"string","payerBuildingNumber":"string","payerPostalCode":"string","payerTownName":"string","payerCountry":"string","payerDateOfBirth":"string","payerCityOfBirth":"string","payerCountryOfBirth":"string","debitAccount":"string"}},"responses":{"200":"PaymentRequestsResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/order/paymentRequests/{requestId}/partialPayments","fullPath":"/api/v1.1.0/order/paymentRequests/{requestId}/partialPayments","operationId":"updatePartialPayment","name":"Enables the Payer to accept Biller's request but pays only a part of the outstanding amount. The original request sent by the biller remains open until the total amount is paid by the payer","summary":"Update partial payment by payer","tags":[],"parameters":[{"name":"requestId","in":"path","type":"string","required":true,"description":"The guarantees issuance id initiated by internet banking"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"additionalInfo":[{}],"debitAmount":"string","currentBalance":"string","requestedExecutionDate":"string","debitAccount":"string","paymentReference":"string","payerResponse":"string","amountModifiedByPayer":"string","payerAccountIBAN":"string","paymentDate":"string"}},"responses":{"200":"PartialPaymentResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/order/paymentRequests/{requestId}/payments","fullPath":"/api/v1.1.0/order/paymentRequests/{requestId}/payments","operationId":"updateFullPayment","name":"Enables the payer to accept the biller's request and pay the outstanding amount","summary":"Update the payment with full amount requested by the biller","tags":[],"parameters":[{"name":"requestId","in":"path","type":"string","required":true,"description":"The guarantees issuance id initiated by internet banking"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"additionalInfo":[{}],"debitAccount":"string","currentBalance":"string","requestedExecutionDate":"string","paymentReference":"string","amountModifiedByPayer":"string","payerAccountIBAN":"string","paymentDate":"string"}},"responses":{"200":"FullPaymentResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/order/paymentRequests/payers/status","fullPath":"/api/v1.1.0/order/paymentRequests/payers/status","operationId":"getPayersStatus","name":"Retrieves the list of payer payment requests which are in pending, completed and askForExtension status and requires action from payer","summary":"Retrieves the list of payment requests that are pending, completed and askForExtension with payer","tags":[],"parameters":[{"name":"currentState","in":"query","type":"string","required":false,"description":"Contains the current state of the transaction"},{"name":"customerId","in":"query","type":"string","required":false,"description":"Identifier of the customer"},{"name":"scheme","in":"query","type":"string","required":false,"description":"Represents the scheme (a synonym for the National ID type) under which the National ID is defined"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"PayersStatusResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"POST","path":"/order/paymentRequests/ukPayments/billerRequests","fullPath":"/api/v1.1.0/order/paymentRequests/ukPayments/billerRequests","operationId":"createPayUKPaymentRequests","name":"Creates payment request for UK scheme. This API can be linked to any published API which is in accordance to requesttopay.co.uk standards","summary":"Payment request initiation for UK scheme from biller to payer system","tags":[],"parameters":[{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"portalInfo":[{}],"errorInfo":[{}],"chargeDetails":[{}],"paymentStatus":[{}],"acceptanceDateTime":[{}],"additionalInfo":[{}],"messageToPayer":[{}],"messageToRequestor":[{}],"paymentReferenceDetails":[{}],"endToEndReference":"string","paymentMethod":"string","requestorBankBic":"string","requestorBankSortCode":"string","requestorAccountIBAN":"string","requestorAccountNumber":"string"}},"responses":{"200":"PayUKPaymentRequestsResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/order/paymentRequests/{requestId}/ukPayments","fullPath":"/api/v1.1.0/order/paymentRequests/{requestId}/ukPayments","operationId":"amendPayUKPaymentForRepository","name":" Update payment request onto the biller system from payer to support partial payment, full payment, due date extension request , decline and block the biller, decline the payment request and messages sent to the biller. Similarly, update payment request onto the payer system from biller to support approval of due date extension, rejection of due date extension, messages sent to the payer and acknowledgement to payer.This API can be linked to any published API which is in accordance to requesttop","summary":"Manages payment requests for UK scheme between biller and payer systems","tags":[],"parameters":[{"name":"requestId","in":"path","type":"string","required":true,"description":"The guarantees issuance id initiated by internet banking"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"portalInfo":[{}],"errorInfo":[{}],"chargeDetails":[{}],"paymentStatus":[{}],"acceptanceDateTime":[{}],"additionalInfo":[{}],"messageToPayer":[{}],"messageToRequestor":[{}],"paymentReferenceDetails":[{}],"endToEndReference":"string","paymentMethod":"string","requestorBankBic":"string","requestorBankSortCode":"string","requestorAccountIBAN":"string","requestorAccountNumber":"string"}},"responses":{"200":"PayUKPaymentForRepositoryResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/order/paymentRequests/{requestId}/billers/acknowledgements","fullPath":"/api/v1.1.0/order/paymentRequests/{requestId}/billers/acknowledgements","operationId":"updateBillerAcknowledgements","name":"Enables the biller to send full acknowledgement to payer when payer paid full amount and send partial acknowledgement to payer when payer paid partial amount","summary":"Update the full or partial acknowledgement in a payment request","tags":[],"parameters":[{"name":"requestId","in":"path","type":"string","required":true,"description":"The guarantees issuance id initiated by internet banking"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"requestorResponse":"string"}},"responses":{"200":"BillerAcknowledgementsResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/order/paymentRequests/{requestId}/payers","fullPath":"/api/v1.1.0/order/paymentRequests/{requestId}/payers","operationId":"getPayersList","name":"Retrieves the list of payer payment requests which are in Completed, Partially paid, Extension Granted, Declined, Extension Declined and Asked For Extension status","summary":"Retrieves the payer payment requests","tags":[],"parameters":[{"name":"requestId","in":"path","type":"string","required":true,"description":""},{"name":"customerId","in":"query","type":"string","required":false,"description":"Identifier of the customer"},{"name":"scheme","in":"query","type":"string","required":false,"description":"Represents the scheme (a synonym for the National ID type) under which the National ID is defined"},{"name":"requestorReference","in":"query","type":"string","required":false,"description":"Contains the reference of the requestor"},{"name":"currentState","in":"query","type":"string","required":false,"description":"Contains the current state of the transaction"},{"name":"endToEndReference","in":"query","type":"string","required":false,"description":"Indicates the end to end reference for the payment. This field can be provided by the person who instructs the payment and this flows through the lifecycle of the payment."},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"PayersListResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/order/paymentRequests/{requestId}/billers","fullPath":"/api/v1.1.0/order/paymentRequests/{requestId}/billers","operationId":"getRequestorsOutwardRequest","name":"Retrieves the list of biller payment requests which are in Completed, Rejected and Pending status","summary":"Retrieves the list of biller payment requests","tags":[],"parameters":[{"name":"requestId","in":"path","type":"string","required":true,"description":""},{"name":"currentState","in":"query","type":"string","required":false,"description":"Contains the current state of the transaction"},{"name":"customerId","in":"query","type":"string","required":false,"description":"Identifier of the customer"},{"name":"scheme","in":"query","type":"string","required":false,"description":"Represents the scheme (a synonym for the National ID type) under which the National ID is defined"},{"name":"endToEndReference","in":"query","type":"string","required":false,"description":"Indicates the end to end reference for the payment. This field can be provided by the person who instructs the payment and this flows through the lifecycle of the payment."},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"RequestorsOutwardRequestResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}}]},{"key":"RequestToPayPayments-v1.1.1","title":"Request to Pay","version":"v1.1.1","description":"Request To Pay (RTP) is a Temenos Payments Application that helps Temenos bank manage their request to pay functionality. It provides RTP functionality and information exchange between the actor (payer or payee) and the RTP clearing. This page lists the APIs offered by Temenos RTP Application to con","endpointCount":22,"endpoints":[{"method":"GET","path":"/order/paymentRequests/{requestId}/payers","fullPath":"/api/v1.1.1/order/paymentRequests/{requestId}/payers","operationId":"getPayersList","name":"Retrieves the list of RTP requests which are received by the payer. The API retrieves RTPs in various states - Completed, Partially paid, Extension Granted, Declined, Extension Declined and Asked For Extension. This API is only to be used for payer side.","summary":"Retrieve RTP requests (payer side)","tags":[],"parameters":[{"name":"requestId","in":"path","type":"string","required":true,"description":""},{"name":"customerId","in":"query","type":"string","required":false,"description":"Identifier of the customer"},{"name":"scheme","in":"query","type":"string","required":false,"description":"Represents the scheme (a synonym for the National ID type) under which the National ID is defined"},{"name":"requestorReference","in":"query","type":"string","required":false,"description":"Contains the reference of the requestor"},{"name":"currentState","in":"query","type":"string","required":false,"description":"Contains the current state of the transaction"},{"name":"endToEndReference","in":"query","type":"string","required":false,"description":"Indicates the end to end reference for the payment. This field can be provided by the person who instructs the payment and this flows through the lifecycle of the payment."},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"PayersListResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"PUT","path":"/order/paymentRequests/{requestId}/payments","fullPath":"/api/v1.1.1/order/paymentRequests/{requestId}/payments","operationId":"updateFullPayment","name":"Enables the payer to accept RTP Request and pay the outstanding amount","summary":"Accept the RTP request with full amount","tags":[],"parameters":[{"name":"requestId","in":"path","type":"string","required":true,"description":"The guarantees issuance id initiated by internet banking"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"additionalInfo":[{}],"debitAccount":"string","currentBalance":"string","requestedExecutionDate":"string","paymentReference":"string","amountModifiedByPayer":"string","payerAccountIBAN":"string","paymentDate":"string"}},"responses":{"200":"FullPaymentResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/order/paymentRequests/{requestId}/partialPayments","fullPath":"/api/v1.1.1/order/paymentRequests/{requestId}/partialPayments","operationId":"updatePartialPayment","name":"Enables the payer to accept RTP request and pay partial amount. The original request sent by the biller remains open until the total amount is paid by the payer","summary":"Accept the RTP request and pay partially","tags":[],"parameters":[{"name":"requestId","in":"path","type":"string","required":true,"description":"The guarantees issuance id initiated by internet banking"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"additionalInfo":[{}],"debitAmount":"string","currentBalance":"string","requestedExecutionDate":"string","debitAccount":"string","paymentReference":"string","payerResponse":"string","amountModifiedByPayer":"string","payerAccountIBAN":"string","paymentDate":"string"}},"responses":{"200":"PartialPaymentResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/order/paymentRequests/{requestId}/declinedRequests","fullPath":"/api/v1.1.1/order/paymentRequests/{requestId}/declinedRequests","operationId":"updateDeclinePayment","name":"Enables the payer to decline RTP request when payer does not wish to make any payment towards that request","summary":"Decline a RTP request from payee","tags":[],"parameters":[{"name":"requestId","in":"path","type":"string","required":true,"description":"The guarantees issuance id initiated by internet banking"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"additionalInfoToRequestor":[{}],"payerResponse":"string"}},"responses":{"200":"DeclinePaymentResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/order/paymentRequests/{requestId}/billerNotes","fullPath":"/api/v1.1.1/order/paymentRequests/{requestId}/billerNotes","operationId":"updateNotesToRequestor","name":"Enables the payer to send messages to payee when the Payer requires further information regarding a specific RTP request","summary":"Send notes/additional information to payee","tags":[],"parameters":[{"name":"requestId","in":"path","type":"string","required":true,"description":"The guarantees issuance id initiated by internet banking"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"notesToRequestor":[{}],"payerResponse":"string"}},"responses":{"200":"NotesToRequestorResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/order/paymentRequests/{requestId}/amountModifications","fullPath":"/api/v1.1.1/order/paymentRequests/{requestId}/amountModifications","operationId":"updatePaymentAmount","name":"Enables the payer to modify the amount requested by payee in the original RTP request, if modification is allowed by the payee and the corresponding RTP scheme","summary":"Modify the requested amount in the RTP request","tags":[],"parameters":[{"name":"requestId","in":"path","type":"string","required":true,"description":"The guarantees issuance id initiated by internet banking"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"debitAccount":"string","payerAccountIBAN":"string","amountModifiedByPayer":"string"}},"responses":{"200":"PaymentAmountResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/order/paymentRequests/{requestId}/blocks","fullPath":"/api/v1.1.1/order/paymentRequests/{requestId}/blocks","operationId":"updateDeclineAndBlock","name":"Enables the payer to decline the payee's RTP request and block the payee when payer does not want to receive any further RTP requests in future from the specific payee","summary":"Decline the RTP request and block the payee","tags":[],"parameters":[{"name":"requestId","in":"path","type":"string","required":true,"description":"The guarantees issuance id initiated by internet banking"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"additionalInfoToRequestor":[{}],"payerResponse":"string"}},"responses":{"200":"DeclineAndBlockResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/order/paymentRequests/{requestId}/payerNotes","fullPath":"/api/v1.1.1/order/paymentRequests/{requestId}/payerNotes","operationId":"updateNotesToPayer","name":"Enables the payee to send notes, additional information to payer when the payee requires further information regarding a specific RTP request","summary":"Send notes / additional information to payer","tags":[],"parameters":[{"name":"requestId","in":"path","type":"string","required":true,"description":"The guarantees issuance id initiated by internet banking"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"notesToPayer":[{}],"payerName":"string","creditAccountId":"string","requestorAccountIBAN":"string","requestorName":"string","requestedExecutionDate":"string","endToEndReference":"string","remittanceInformation":"string"}},"responses":{"200":"NotesToPayerResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/order/paymentRequests/{requestId}/extensions","fullPath":"/api/v1.1.1/order/paymentRequests/{requestId}/extensions","operationId":"updateDateExtension","name":"Enables the payer to request the payee for a new expiry date for the RTP request received","summary":"Request extension of the RTP expiry date","tags":[],"parameters":[{"name":"requestId","in":"path","type":"string","required":true,"description":"The guarantees issuance id initiated by internet banking"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"additionalInfo":[{}],"requestedExpiryDate":"string","payerResponse":"string"}},"responses":{"200":"DateExtensionResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/order/paymentRequests/{requestId}/billers/pendingExtensions","fullPath":"/api/v1.1.1/order/paymentRequests/{requestId}/billers/pendingExtensions","operationId":"getRequestorsDateExtension","name":"Retrieves the RTP requests with payee which are awaiting response for RTP expiry date extension. These requests can either be declined or approved by the payee","summary":"Payee's RTP requests awaiting RTP expiry date extension approval","tags":[],"parameters":[{"name":"requestId","in":"path","type":"string","required":true,"description":""},{"name":"customerId","in":"query","type":"string","required":false,"description":"Identifier of the customer"},{"name":"scheme","in":"query","type":"string","required":false,"description":"Represents the scheme (a synonym for the National ID type) under which the National ID is defined"},{"name":"requestorReference","in":"query","type":"string","required":false,"description":"Contains the reference of the requestor"},{"name":"currentState","in":"query","type":"string","required":false,"description":"Contains the current state of the transaction"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"RequestorsDateExtensionResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/order/paymentRequests/{requestId}/billers","fullPath":"/api/v1.1.1/order/paymentRequests/{requestId}/billers","operationId":"getRequestorsOutwardRequest","name":"Retrieves the list of requests sent by the payee. Details returned are payer name, amount, status, expiry date, outstanding amount to pay and the notes exchanged so far with payer.","summary":"Retrieve RTP requests (payee side)","tags":[],"parameters":[{"name":"requestId","in":"path","type":"string","required":true,"description":""},{"name":"currentState","in":"query","type":"string","required":false,"description":"Contains the current state of the transaction"},{"name":"customerId","in":"query","type":"string","required":false,"description":"Identifier of the customer"},{"name":"scheme","in":"query","type":"string","required":false,"description":"Represents the scheme (a synonym for the National ID type) under which the National ID is defined"},{"name":"endToEndReference","in":"query","type":"string","required":false,"description":"Indicates the end to end reference for the payment. This field can be provided by the person who instructs the payment and this flows through the lifecycle of the payment."},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"RequestorsOutwardRequestResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/order/paymentRequests/payers/status","fullPath":"/api/v1.1.1/order/paymentRequests/payers/status","operationId":"getPayersStatus","name":"Retrieves the list of RTP requests of payer that are pending (that requires action from payer), completed and asked for extension","summary":"Retrieve the list of RTP requests of payer","tags":[],"parameters":[{"name":"currentState","in":"query","type":"string","required":true,"description":"Contains the current state of the transaction"},{"name":"customerId","in":"query","type":"string","required":false,"description":"Identifier of the customer"},{"name":"scheme","in":"query","type":"string","required":false,"description":"Represents the scheme (a synonym for the National ID type) under which the National ID is defined"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"PayersStatusResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/order/paymentRequests/{requestId}/extensions/acceptances","fullPath":"/api/v1.1.1/order/paymentRequests/{requestId}/extensions/acceptances","operationId":"getPayerListWithExtensionGranted","name":"Retrieves the payer RTP requests for which the expiry date extensions have been granted by the payee","summary":"Retrieve RTP requests for which extension is granted","tags":[],"parameters":[{"name":"requestId","in":"path","type":"string","required":true,"description":""},{"name":"customerId","in":"query","type":"string","required":false,"description":"Identifier of the customer"},{"name":"scheme","in":"query","type":"string","required":false,"description":"Represents the scheme (a synonym for the National ID type) under which the National ID is defined"},{"name":"currentState","in":"query","type":"string","required":false,"description":"Contains the current state of the transaction"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"PayerListWithExtensionGrantedResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"PUT","path":"/order/paymentRequests/{requestId}/extensions/acceptances","fullPath":"/api/v1.1.1/order/paymentRequests/{requestId}/extensions/acceptances","operationId":"updateGrantExtension","name":"Enables the payee to approve the expiry date for the RTP request sought by the payer","summary":"Approve the expiry date extension requested by the payer","tags":[],"parameters":[{"name":"requestId","in":"path","type":"string","required":true,"description":"The guarantees issuance id initiated by internet banking"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"additionalInfo":[{}]}},"responses":{"200":"GrantExtensionResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/order/paymentRequests/{requestId}/extensions/rejections","fullPath":"/api/v1.1.1/order/paymentRequests/{requestId}/extensions/rejections","operationId":"getPayersListWithExtensionDeclined","name":"Retrieves the payer RTP requests for which the expiry date extensions have been declined by the payee","summary":"Retrieve RTP requests for which the extension is declined","tags":[],"parameters":[{"name":"requestId","in":"path","type":"string","required":true,"description":""},{"name":"customerId","in":"query","type":"string","required":false,"description":"Identifier of the customer"},{"name":"scheme","in":"query","type":"string","required":false,"description":"Represents the scheme (a synonym for the National ID type) under which the National ID is defined"},{"name":"currentState","in":"query","type":"string","required":false,"description":"Contains the current state of the transaction"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"PayersListWithExtensionDeclinedResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"PUT","path":"/order/paymentRequests/{requestId}/extensions/rejections","fullPath":"/api/v1.1.1/order/paymentRequests/{requestId}/extensions/rejections","operationId":"updateDeclineExtension","name":"Enables the payee to decline the expiry date for the RTP request sought by the payer","summary":"Decline the expiry date extension requested by payer","tags":[],"parameters":[{"name":"requestId","in":"path","type":"string","required":true,"description":"The guarantees issuance id initiated by internet banking"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"additionalInfo":[{}],"requestorResponse":"string"}},"responses":{"200":"DeclineExtensionResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/order/paymentRequests/{requestId}/billers/pendingAcknowledgements","fullPath":"/api/v1.1.1/order/paymentRequests/{requestId}/billers/pendingAcknowledgements","operationId":"getApiPendingAck","name":"Retrieves the RTP requests which are yet to be acknowledged by the payee for a payment that has come in due to a result of RTP Request being accepted by payer. Generally, Partially paid or Paid are the two statuses in which payee can send an acknowledgement message corresponding to a payment received","summary":"RTP requests sent which are pending to be acknowledged by payee as payment received","tags":[],"parameters":[{"name":"requestId","in":"path","type":"string","required":true,"description":""},{"name":"customerId","in":"query","type":"string","required":false,"description":"Identifier of the customer"},{"name":"scheme","in":"query","type":"string","required":false,"description":"Represents the scheme (a synonym for the National ID type) under which the National ID is defined"},{"name":"currentState","in":"query","type":"string","required":false,"description":"Contains the current state of the transaction"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"ApiPendingAckResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"PUT","path":"/order/paymentRequests/{requestId}/billers/acknowledgements","fullPath":"/api/v1.1.1/order/paymentRequests/{requestId}/billers/acknowledgements","operationId":"updateBillerAcknowledgements","name":"Enables the payee to send full acknowledgement to payer when payer has paid full amount and to send partial acknowledgement to payer when payer has paid partial amount","summary":"Acknowledge RTP requests waiting for payment confirmation by payee","tags":[],"parameters":[{"name":"requestId","in":"path","type":"string","required":true,"description":"The guarantees issuance id initiated by internet banking"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"requestorResponse":"string"}},"responses":{"200":"BillerAcknowledgementsResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/order/paymentRequests/{requestId}/errors","fullPath":"/api/v1.1.1/order/paymentRequests/{requestId}/errors","operationId":"getOutwardErrors","name":"Retrieves the RTP requests which are in error status due to technical reasons. Such requests must be checked for the reason for error manually and a new RTP request must be created/initiated by payee to send the request again to payer","summary":"Retrieve the RTP requests in error status","tags":[],"parameters":[{"name":"requestId","in":"path","type":"string","required":true,"description":""},{"name":"customerId","in":"query","type":"string","required":false,"description":"Identifier of the customer"},{"name":"scheme","in":"query","type":"string","required":false,"description":"Represents the scheme (a synonym for the National ID type) under which the National ID is defined"},{"name":"currentState","in":"query","type":"string","required":false,"description":"Contains the current state of the transaction"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"OutwardErrorsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"POST","path":"/order/paymentRequests/ukPayments/billerRequests","fullPath":"/api/v1.1.1/order/paymentRequests/ukPayments/billerRequests","operationId":"createPayUKPaymentRequests","name":"Creates an RTP request at the Repository Service Provider(RSP). The API is for RSP-RSP communication for biller RSP to place RTP request with payer RSP. This is a provider API which can be linked to any published API in accordance to requesttopay.co.uk standards.","summary":"UK RTP scheme request initiation (RSP - RSP)","tags":[],"parameters":[{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"portalInfo":[{}],"errorInfo":[{}],"chargeDetails":[{}],"paymentStatus":[{}],"acceptanceDateTime":[{}],"additionalInfo":[{}],"messageToPayer":[{}],"messageToRequestor":[{}],"paymentReferenceDetails":[{}],"contextNames":[{}],"contextValues":[{}],"endToEndReference":"string","paymentMethod":"string","requestorBankBic":"string","requestorBankSortCode":"string"}},"responses":{"200":"PayUKPaymentRequestsResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/order/paymentRequests/{requestId}/ukPayments","fullPath":"/api/v1.1.1/order/paymentRequests/{requestId}/ukPayments","operationId":"amendPayUKPaymentForRepository","name":"API to exchange RTP messages between biller RSP and payer RSP. The API can be used for exchanging various follow up messages for an RTP request(subsequent to RTP initiation) such as acceptance of the request in full or partial, denial of a request, exchange of notes, expiry date extension management, payment acknowledgements. This is a provider API which can be linked to any published API in accordance to requesttopay.co.uk standards.","summary":"UK RTP scheme message exchanges between biller and payer (RSP - RSP)","tags":[],"parameters":[{"name":"requestId","in":"path","type":"string","required":true,"description":"The guarantees issuance id initiated by internet banking"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"portalInfo":[{}],"errorInfo":[{}],"chargeDetails":[{}],"paymentStatus":[{}],"acceptanceDateTime":[{}],"additionalInfo":[{}],"messageToPayer":[{}],"messageToRequestor":[{}],"paymentReferenceDetails":[{}],"contextNames":[{}],"contextValues":[{}],"endToEndReference":"string","paymentMethod":"string","requestorBankBic":"string","requestorBankSortCode":"string"}},"responses":{"200":"PayUKPaymentForRepositoryResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"POST","path":"/order/paymentRequests","fullPath":"/api/v1.1.1/order/paymentRequests","operationId":"createPaymentRequests","name":"Create payment requests for EBA and UK scheme from biller application","summary":"Initiate a RTP request ","tags":[],"parameters":[{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"chargeDetails":[{}],"portalInfo":[{}],"errorInfo":[{}],"paymentMethod":"string","requestedExecutionDate":"string","payerName":"string","payerStreetName":"string","payerBuildingNumber":"string","payerPostalCode":"string","payerTownName":"string","payerCountry":"string","payerDateOfBirth":"string","payerCityOfBirth":"string","payerCountryOfBirth":"string","debitAccount":"string"}},"responses":{"200":"PaymentRequestsResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}}]},{"key":"RequestToPayPayments-v1.2.0","title":"Request to Pay","version":"v1.2.0","description":"Request To Pay (RTP) is a Temenos Payments Application that helps Temenos bank manage their request to pay functionality. It provides RTP functionality and information exchange between the actor (payer or payee) and the RTP clearing. This page lists the APIs offered by Temenos RTP Application to con","endpointCount":22,"endpoints":[{"method":"PUT","path":"/order/paymentRequests/{requestId}/payments","fullPath":"/api/v1.2.0/order/paymentRequests/{requestId}/payments","operationId":"updateFullPayment","name":"Enables the payer to accept RTP Request and pay the outstanding amount","summary":"Accept the RTP request with full amount","tags":[],"parameters":[{"name":"requestId","in":"path","type":"string","required":true,"description":"The guarantees issuance id initiated by internet banking"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"additionalInfo":[{}],"debitAccount":"string","currentBalance":"string","requestedExecutionDate":"string","paymentReference":"string","amountModifiedByPayer":"string","payerAccountIBAN":"string","paymentDate":"string","token":"string","extensionData":{}}},"responses":{"200":"FullPaymentResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/order/paymentRequests/{requestId}/partialPayments","fullPath":"/api/v1.2.0/order/paymentRequests/{requestId}/partialPayments","operationId":"updatePartialPayment","name":"Enables the payer to accept RTP request and pay partial amount. The original request sent by the biller remains open until the total amount is paid by the payer","summary":"Accept the RTP request and pay partially","tags":[],"parameters":[{"name":"requestId","in":"path","type":"string","required":true,"description":"The guarantees issuance id initiated by internet banking"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"additionalInfo":[{}],"debitAmount":"string","currentBalance":"string","requestedExecutionDate":"string","debitAccount":"string","paymentReference":"string","amountModifiedByPayer":"string","payerAccountIBAN":"string","paymentDate":"string","token":"string","extensionData":{}}},"responses":{"200":"PartialPaymentResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/order/paymentRequests/{requestId}/declinedRequests","fullPath":"/api/v1.2.0/order/paymentRequests/{requestId}/declinedRequests","operationId":"updateDeclinePayment","name":"Enables the payer to decline RTP request when payer does not wish to make any payment towards that request","summary":"Decline a RTP request from payee","tags":[],"parameters":[{"name":"requestId","in":"path","type":"string","required":true,"description":"The guarantees issuance id initiated by internet banking"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"additionalInfoToRequestor":[{}],"token":"string","extensionData":{}}},"responses":{"200":"DeclinePaymentResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/order/paymentRequests/{requestId}/billerNotes","fullPath":"/api/v1.2.0/order/paymentRequests/{requestId}/billerNotes","operationId":"updateNotesToRequestor","name":"Enables the payer to send messages to payee when the Payer requires further information regarding a specific RTP request","summary":"Send notes/additional information to payee","tags":[],"parameters":[{"name":"requestId","in":"path","type":"string","required":true,"description":"The guarantees issuance id initiated by internet banking"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"notesToRequestor":[{}],"token":"string","extensionData":{}}},"responses":{"200":"NotesToRequestorResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/order/paymentRequests/{requestId}/amountModifications","fullPath":"/api/v1.2.0/order/paymentRequests/{requestId}/amountModifications","operationId":"updatePaymentAmount","name":"Enables the payer to modify the amount requested by payee in the original RTP request, if modification is allowed by the payee and the corresponding RTP scheme","summary":"Modify the requested amount in the RTP request","tags":[],"parameters":[{"name":"requestId","in":"path","type":"string","required":true,"description":"The guarantees issuance id initiated by internet banking"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"debitAccount":"string","payerAccountIBAN":"string","amountModifiedByPayer":"string","extensionData":{}}},"responses":{"200":"PaymentAmountResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/order/paymentRequests/{requestId}/blocks","fullPath":"/api/v1.2.0/order/paymentRequests/{requestId}/blocks","operationId":"updateDeclineAndBlock","name":"Enables the payer to decline the payee's RTP request and block the payee when payer does not want to receive any further RTP requests in future from the specific payee","summary":"Decline the RTP request and block the payee","tags":[],"parameters":[{"name":"requestId","in":"path","type":"string","required":true,"description":"The guarantees issuance id initiated by internet banking"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"additionalInfoToRequestor":[{}],"token":"string","extensionData":{}}},"responses":{"200":"DeclineAndBlockResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/order/paymentRequests/{requestId}/payerNotes","fullPath":"/api/v1.2.0/order/paymentRequests/{requestId}/payerNotes","operationId":"updateNotesToPayer","name":"Enables the payee to send notes, additional information to payer when the payee requires further information regarding a specific RTP request","summary":"Send notes / additional information to payer","tags":[],"parameters":[{"name":"requestId","in":"path","type":"string","required":true,"description":"The guarantees issuance id initiated by internet banking"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"notesToPayer":[{}],"payerName":"string","creditAccountId":"string","requestorAccountIBAN":"string","requestorName":"string","requestedExecutionDate":"string","endToEndReference":"string","remittanceInformation":"string","extensionData":{}}},"responses":{"200":"NotesToPayerResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/order/paymentRequests/{requestId}/extensions","fullPath":"/api/v1.2.0/order/paymentRequests/{requestId}/extensions","operationId":"updateDateExtension","name":"Enables the payer to request the payee for a new expiry date for the RTP request received","summary":"Request extension of the RTP expiry date","tags":[],"parameters":[{"name":"requestId","in":"path","type":"string","required":true,"description":"The guarantees issuance id initiated by internet banking"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"additionalInfo":[{}],"requestedExpiryDate":"string","token":"string","extensionData":{}}},"responses":{"200":"DateExtensionResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/order/paymentRequests/{requestId}/extensions/acceptances","fullPath":"/api/v1.2.0/order/paymentRequests/{requestId}/extensions/acceptances","operationId":"getPayerListWithExtensionGranted","name":"Retrieves the payer RTP requests for which the expiry date extensions have been granted by the payee","summary":"Retrieve RTP requests for which extension is granted","tags":[],"parameters":[{"name":"requestId","in":"path","type":"string","required":true,"description":""},{"name":"customerId","in":"query","type":"string","required":false,"description":"Identifier of the customer"},{"name":"scheme","in":"query","type":"string","required":false,"description":"Represents the scheme (a synonym for the National ID type) under which the National ID is defined"},{"name":"currentState","in":"query","type":"string","required":false,"description":"Contains the current state of the transaction"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"PayerListWithExtensionGrantedResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"PUT","path":"/order/paymentRequests/{requestId}/extensions/acceptances","fullPath":"/api/v1.2.0/order/paymentRequests/{requestId}/extensions/acceptances","operationId":"updateGrantExtension","name":"Enables the payee to approve the expiry date for the RTP request sought by the payer","summary":"Approve the expiry date extension requested by the payer","tags":[],"parameters":[{"name":"requestId","in":"path","type":"string","required":true,"description":"The guarantees issuance id initiated by internet banking"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"additionalInfo":[{}],"extensionData":{}}},"responses":{"200":"GrantExtensionResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/order/paymentRequests/{requestId}/extensions/rejections","fullPath":"/api/v1.2.0/order/paymentRequests/{requestId}/extensions/rejections","operationId":"getPayersListWithExtensionDeclined","name":"Retrieves the payer RTP requests for which the expiry date extensions have been declined by the payee","summary":"Retrieve RTP requests for which the extension is declined","tags":[],"parameters":[{"name":"requestId","in":"path","type":"string","required":true,"description":""},{"name":"customerId","in":"query","type":"string","required":false,"description":"Identifier of the customer"},{"name":"scheme","in":"query","type":"string","required":false,"description":"Represents the scheme (a synonym for the National ID type) under which the National ID is defined"},{"name":"currentState","in":"query","type":"string","required":false,"description":"Contains the current state of the transaction"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"PayersListWithExtensionDeclinedResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"PUT","path":"/order/paymentRequests/{requestId}/extensions/rejections","fullPath":"/api/v1.2.0/order/paymentRequests/{requestId}/extensions/rejections","operationId":"updateDeclineExtension","name":"Enables the payee to decline the expiry date for the RTP request sought by the payer","summary":"Decline the expiry date extension requested by payer","tags":[],"parameters":[{"name":"requestId","in":"path","type":"string","required":true,"description":"The guarantees issuance id initiated by internet banking"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"additionalInfo":[{}],"requestorResponse":"string","extensionData":{}}},"responses":{"200":"DeclineExtensionResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/order/paymentRequests/{requestId}/billers/acknowledgements","fullPath":"/api/v1.2.0/order/paymentRequests/{requestId}/billers/acknowledgements","operationId":"updateBillerAcknowledgements","name":"Enables the payee to send full acknowledgement to payer when payer has paid full amount and to send partial acknowledgement to payer when payer has paid partial amount","summary":"Acknowledge RTP requests waiting for payment confirmation by payee","tags":[],"parameters":[{"name":"requestId","in":"path","type":"string","required":true,"description":"The guarantees issuance id initiated by internet banking"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"requestorResponse":"string","extensionData":{}}},"responses":{"200":"BillerAcknowledgementsResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"POST","path":"/order/paymentRequests","fullPath":"/api/v1.2.0/order/paymentRequests","operationId":"createPaymentRequests","name":"Create payment requests for EBA and UK scheme from biller application","summary":"Initiate a RTP request ","tags":[],"parameters":[{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"chargeDetails":[{}],"portalInfo":[{}],"errorInfo":[{}],"paymentMethod":"string","requestedExecutionDate":"string","payerName":"string","payerStreetName":"string","payerBuildingNumber":"string","payerPostalCode":"string","payerTownName":"string","payerCountry":"string","payerDateOfBirth":"string","payerCityOfBirth":"string","payerCountryOfBirth":"string","debitAccount":"string"}},"responses":{"200":"PaymentRequestsResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/order/paymentRequests/{requestId}/payers","fullPath":"/api/v1.2.0/order/paymentRequests/{requestId}/payers","operationId":"getPayersList","name":"Retrieves the list of RTP requests which are received by the payer. The API retrieves RTPs in various states - Completed, Partially paid, Extension Granted, Declined, Extension Declined and Asked For Extension. This API is only to be used for payer side.","summary":"Retrieve RTP requests (payer side)","tags":[],"parameters":[{"name":"requestId","in":"path","type":"string","required":true,"description":""},{"name":"customerId","in":"query","type":"string","required":false,"description":"Identifier of the customer"},{"name":"scheme","in":"query","type":"string","required":false,"description":"Represents the scheme (a synonym for the National ID type) under which the National ID is defined"},{"name":"requestorReference","in":"query","type":"string","required":false,"description":"Contains the reference of the requestor"},{"name":"currentState","in":"query","type":"string","required":false,"description":"Contains the current state of the transaction"},{"name":"endToEndReference","in":"query","type":"string","required":false,"description":"Indicates the end to end reference for the payment. This field can be provided by the person who instructs the payment and this flows through the lifecycle of the payment."},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"PayersListResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/order/paymentRequests/payers/status","fullPath":"/api/v1.2.0/order/paymentRequests/payers/status","operationId":"getPayersStatus","name":"Retrieves the list of RTP requests of payer that are pending (that requires action from payer), completed and asked for extension","summary":"Retrieve the list of RTP requests of payer","tags":[],"parameters":[{"name":"currentState","in":"query","type":"string","required":true,"description":"Contains the current state of the transaction"},{"name":"customerId","in":"query","type":"string","required":false,"description":"Identifier of the customer"},{"name":"scheme","in":"query","type":"string","required":false,"description":"Represents the scheme (a synonym for the National ID type) under which the National ID is defined"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"PayersStatusResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/order/paymentRequests/{requestId}/billers/pendingAcknowledgements","fullPath":"/api/v1.2.0/order/paymentRequests/{requestId}/billers/pendingAcknowledgements","operationId":"getApiPendingAck","name":"Retrieves the RTP requests which are yet to be acknowledged by the payee for a payment that has come in due to a result of RTP Request being accepted by payer. Generally, Partially paid or Paid are the two statuses in which payee can send an acknowledgement message corresponding to a payment received","summary":"RTP requests sent which are pending to be acknowledged by payee as payment received","tags":[],"parameters":[{"name":"requestId","in":"path","type":"string","required":true,"description":""},{"name":"customerId","in":"query","type":"string","required":false,"description":"Identifier of the customer"},{"name":"scheme","in":"query","type":"string","required":false,"description":"Represents the scheme (a synonym for the National ID type) under which the National ID is defined"},{"name":"currentState","in":"query","type":"string","required":false,"description":"Contains the current state of the transaction"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"ApiPendingAckResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/order/paymentRequests/{requestId}/billers/pendingExtensions","fullPath":"/api/v1.2.0/order/paymentRequests/{requestId}/billers/pendingExtensions","operationId":"getRequestorsDateExtension","name":"Retrieves the RTP requests with payee which are awaiting response for RTP expiry date extension. These requests can either be declined or approved by the payee","summary":"Payee's RTP requests awaiting RTP expiry date extension approval","tags":[],"parameters":[{"name":"requestId","in":"path","type":"string","required":true,"description":""},{"name":"customerId","in":"query","type":"string","required":false,"description":"Identifier of the customer"},{"name":"scheme","in":"query","type":"string","required":false,"description":"Represents the scheme (a synonym for the National ID type) under which the National ID is defined"},{"name":"requestorReference","in":"query","type":"string","required":false,"description":"Contains the reference of the requestor"},{"name":"currentState","in":"query","type":"string","required":false,"description":"Contains the current state of the transaction"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"RequestorsDateExtensionResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/order/paymentRequests/{requestId}/billers","fullPath":"/api/v1.2.0/order/paymentRequests/{requestId}/billers","operationId":"getRequestorsOutwardRequest","name":"Retrieves the list of requests sent by the payee. Details returned are payer name, amount, status, expiry date, outstanding amount to pay and the notes exchanged so far with payer.","summary":"Retrieve RTP requests (payee side)","tags":[],"parameters":[{"name":"requestId","in":"path","type":"string","required":true,"description":""},{"name":"currentState","in":"query","type":"string","required":false,"description":"Contains the current state of the transaction"},{"name":"customerId","in":"query","type":"string","required":false,"description":"Identifier of the customer"},{"name":"scheme","in":"query","type":"string","required":false,"description":"Represents the scheme (a synonym for the National ID type) under which the National ID is defined"},{"name":"endToEndReference","in":"query","type":"string","required":false,"description":"Indicates the end to end reference for the payment. This field can be provided by the person who instructs the payment and this flows through the lifecycle of the payment."},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"RequestorsOutwardRequestResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/order/paymentRequests/{requestId}/errors","fullPath":"/api/v1.2.0/order/paymentRequests/{requestId}/errors","operationId":"getOutwardErrors","name":"Retrieves the RTP requests which are in error status due to technical reasons. Such requests must be checked for the reason for error manually and a new RTP request must be created/initiated by payee to send the request again to payer","summary":"Retrieve the RTP requests in error status","tags":[],"parameters":[{"name":"requestId","in":"path","type":"string","required":true,"description":""},{"name":"customerId","in":"query","type":"string","required":false,"description":"Identifier of the customer"},{"name":"scheme","in":"query","type":"string","required":false,"description":"Represents the scheme (a synonym for the National ID type) under which the National ID is defined"},{"name":"currentState","in":"query","type":"string","required":false,"description":"Contains the current state of the transaction"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"OutwardErrorsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"POST","path":"/order/paymentRequests/ukPayments/billerRequests","fullPath":"/api/v1.2.0/order/paymentRequests/ukPayments/billerRequests","operationId":"createPayUKPaymentRequests","name":"Creates an RTP request at the Repository Service Provider(RSP). The API is for RSP-RSP communication for biller RSP to place RTP request with payer RSP. This is a provider API which can be linked to any published API in accordance to requesttopay.co.uk standards.","summary":"UK RTP scheme request initiation (RSP - RSP)","tags":[],"parameters":[{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"portalInfo":[{}],"errorInfo":[{}],"chargeDetails":[{}],"paymentStatus":[{}],"acceptanceDateTime":[{}],"additionalInfo":[{}],"messageToPayer":[{}],"messageToRequestor":[{}],"paymentReferenceDetails":[{}],"endToEndReference":"string","paymentMethod":"string","requestorBankBic":"string","requestorBankSortCode":"string","requestorAccountIBAN":"string","requestorAccountNumber":"string"}},"responses":{"200":"PayUKPaymentRequestsResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/order/paymentRequests/{requestId}/ukPayments","fullPath":"/api/v1.2.0/order/paymentRequests/{requestId}/ukPayments","operationId":"amendPayUKPaymentForRepository","name":"API to exchange RTP messages between biller RSP and payer RSP. The API can be used for exchanging various follow up messages for an RTP request(subsequent to RTP initiation) such as acceptance of the request in full or partial, denial of a request, exchange of notes, expiry date extension management, payment acknowledgements. This is a provider API which can be linked to any published API in accordance to requesttopay.co.uk standards.","summary":"UK RTP scheme message exchanges between biller and payer (RSP - RSP)","tags":[],"parameters":[{"name":"requestId","in":"path","type":"string","required":true,"description":""},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"portalInfo":[{}],"errorInfo":[{}],"chargeDetails":[{}],"paymentStatus":[{}],"acceptanceDateTime":[{}],"additionalInfo":[{}],"messageToPayer":[{}],"messageToRequestor":[{}],"paymentReferenceDetails":[{}],"endToEndReference":"string","paymentMethod":"string","requestorBankBic":"string","requestorBankSortCode":"string","requestorAccountIBAN":"string","requestorAccountNumber":"string"}},"responses":{"200":"PayUKPaymentForRepositoryResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}}]},{"key":"RequestToPayPayments-v1.3.0","title":"Request to Pay","version":"v1.3.0","description":"Request To Pay (RTP) is a Temenos Payments Application that helps Temenos bank manage their request to pay functionality. It provides RTP functionality and information exchange between the actor (payer or payee) and the RTP clearing. This page lists the APIs offered by Temenos RTP Application to con","endpointCount":23,"endpoints":[{"method":"PUT","path":"/order/paymentRequests/{requestId}/payments","fullPath":"/api/v1.3.0/order/paymentRequests/{requestId}/payments","operationId":"updateFullPayment","name":"Enables the payer to accept RTP Request and pay the outstanding amount","summary":"Accept the RTP request with full amount","tags":[],"parameters":[{"name":"requestId","in":"path","type":"string","required":true,"description":"The guarantees issuance id initiated by internet banking"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"additionalInfo":[{}],"debitAccount":"string","currentBalance":"string","requestedExecutionDate":"string","paymentReference":"string","amountModifiedByPayer":"string","payerAccountIBAN":"string","paymentDate":"string","extensionData":{}}},"responses":{"200":"FullPaymentResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/order/paymentRequests/{requestId}/partialPayments","fullPath":"/api/v1.3.0/order/paymentRequests/{requestId}/partialPayments","operationId":"updatePartialPayment","name":"Enables the payer to accept RTP request and pay partial amount. The original request sent by the biller remains open until the total amount is paid by the payer","summary":"Accept the RTP request and pay partially","tags":[],"parameters":[{"name":"requestId","in":"path","type":"string","required":true,"description":"The guarantees issuance id initiated by internet banking"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"additionalInfo":[{}],"debitAmount":"string","currentBalance":"string","requestedExecutionDate":"string","debitAccount":"string","paymentReference":"string","payerResponse":"string","amountModifiedByPayer":"string","payerAccountIBAN":"string","paymentDate":"string","extensionData":{}}},"responses":{"200":"PartialPaymentResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/order/paymentRequests/{requestId}/declinedRequests","fullPath":"/api/v1.3.0/order/paymentRequests/{requestId}/declinedRequests","operationId":"updateDeclinePayment","name":"Enables the payer to decline RTP request when payer does not wish to make any payment towards that request","summary":"Decline a RTP request from payee","tags":[],"parameters":[{"name":"requestId","in":"path","type":"string","required":true,"description":"The guarantees issuance id initiated by internet banking"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"additionalInfoToRequestor":[{}],"payerResponse":"string","extensionData":{}}},"responses":{"200":"DeclinePaymentResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/order/paymentRequests/{requestId}/billerNotes","fullPath":"/api/v1.3.0/order/paymentRequests/{requestId}/billerNotes","operationId":"updateNotesToRequestor","name":"Enables the payer to send messages to payee when the Payer requires further information regarding a specific RTP request","summary":"Send notes/additional information to payee","tags":[],"parameters":[{"name":"requestId","in":"path","type":"string","required":true,"description":"The guarantees issuance id initiated by internet banking"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"notesToRequestor":[{}],"payerResponse":"string","extensionData":{}}},"responses":{"200":"NotesToRequestorResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/order/paymentRequests/{requestId}/amountModifications","fullPath":"/api/v1.3.0/order/paymentRequests/{requestId}/amountModifications","operationId":"updatePaymentAmount","name":"Enables the payer to modify the amount requested by payee in the original RTP request, if modification is allowed by the payee and the corresponding RTP scheme","summary":"Modify the requested amount in the RTP request","tags":[],"parameters":[{"name":"requestId","in":"path","type":"string","required":true,"description":"The guarantees issuance id initiated by internet banking"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"debitAccount":"string","payerAccountIBAN":"string","amountModifiedByPayer":"string","extensionData":{}}},"responses":{"200":"PaymentAmountResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/order/paymentRequests/{requestId}/blocks","fullPath":"/api/v1.3.0/order/paymentRequests/{requestId}/blocks","operationId":"updateDeclineAndBlock","name":"Enables the payer to decline the payee's RTP request and block the payee when payer does not want to receive any further RTP requests in future from the specific payee","summary":"Decline the RTP request and block the payee","tags":[],"parameters":[{"name":"requestId","in":"path","type":"string","required":true,"description":"The guarantees issuance id initiated by internet banking"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"additionalInfoToRequestor":[{}],"payerResponse":"string","extensionData":{}}},"responses":{"200":"DeclineAndBlockResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/order/paymentRequests/{requestId}/payerNotes","fullPath":"/api/v1.3.0/order/paymentRequests/{requestId}/payerNotes","operationId":"updateNotesToPayer","name":"Enables the payee to send notes, additional information to payer when the payee requires further information regarding a specific RTP request","summary":"Send notes / additional information to payer","tags":[],"parameters":[{"name":"requestId","in":"path","type":"string","required":true,"description":"The guarantees issuance id initiated by internet banking"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"notesToPayer":[{}],"payerName":"string","creditAccountId":"string","requestorAccountIBAN":"string","requestorName":"string","requestedExecutionDate":"string","endToEndReference":"string","remittanceInformation":"string","extensionData":{}}},"responses":{"200":"NotesToPayerResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/order/paymentRequests/{requestId}/extensions","fullPath":"/api/v1.3.0/order/paymentRequests/{requestId}/extensions","operationId":"updateDateExtension","name":"Enables the payer to request the payee for a new expiry date for the RTP request received","summary":"Request extension of the RTP expiry date","tags":[],"parameters":[{"name":"requestId","in":"path","type":"string","required":true,"description":"The guarantees issuance id initiated by internet banking"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"additionalInfo":[{}],"requestedExpiryDate":"string","payerResponse":"string","extensionData":{}}},"responses":{"200":"DateExtensionResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/order/paymentRequests/{requestId}/extensions/acceptances","fullPath":"/api/v1.3.0/order/paymentRequests/{requestId}/extensions/acceptances","operationId":"getPayerListWithExtensionGranted","name":"Retrieves the payer RTP requests for which the expiry date extensions have been granted by the payee","summary":"Retrieve RTP requests for which extension is granted","tags":[],"parameters":[{"name":"requestId","in":"path","type":"string","required":true,"description":""},{"name":"customerId","in":"query","type":"string","required":false,"description":"Identifier of the customer"},{"name":"scheme","in":"query","type":"string","required":false,"description":"Represents the scheme (a synonym for the National ID type) under which the National ID is defined"},{"name":"currentState","in":"query","type":"string","required":false,"description":"Contains the current state of the transaction"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"PayerListWithExtensionGrantedResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"PUT","path":"/order/paymentRequests/{requestId}/extensions/acceptances","fullPath":"/api/v1.3.0/order/paymentRequests/{requestId}/extensions/acceptances","operationId":"updateGrantExtension","name":"Enables the payee to approve the expiry date for the RTP request sought by the payer","summary":"Approve the expiry date extension requested by the payer","tags":[],"parameters":[{"name":"requestId","in":"path","type":"string","required":true,"description":"The guarantees issuance id initiated by internet banking"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"additionalInfo":[{}],"extensionData":{}}},"responses":{"200":"GrantExtensionResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/order/paymentRequests/{requestId}/extensions/rejections","fullPath":"/api/v1.3.0/order/paymentRequests/{requestId}/extensions/rejections","operationId":"getPayersListWithExtensionDeclined","name":"Retrieves the payer RTP requests for which the expiry date extensions have been declined by the payee","summary":"Retrieve RTP requests for which the extension is declined","tags":[],"parameters":[{"name":"requestId","in":"path","type":"string","required":true,"description":""},{"name":"customerId","in":"query","type":"string","required":false,"description":"Identifier of the customer"},{"name":"scheme","in":"query","type":"string","required":false,"description":"Represents the scheme (a synonym for the National ID type) under which the National ID is defined"},{"name":"currentState","in":"query","type":"string","required":false,"description":"Contains the current state of the transaction"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"PayersListWithExtensionDeclinedResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"PUT","path":"/order/paymentRequests/{requestId}/extensions/rejections","fullPath":"/api/v1.3.0/order/paymentRequests/{requestId}/extensions/rejections","operationId":"updateDeclineExtension","name":"Enables the payee to decline the expiry date for the RTP request sought by the payer","summary":"Decline the expiry date extension requested by payer","tags":[],"parameters":[{"name":"requestId","in":"path","type":"string","required":true,"description":"The guarantees issuance id initiated by internet banking"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"additionalInfo":[{}],"requestorResponse":"string","extensionData":{}}},"responses":{"200":"DeclineExtensionResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/order/paymentRequests/{requestId}/billers/acknowledgements","fullPath":"/api/v1.3.0/order/paymentRequests/{requestId}/billers/acknowledgements","operationId":"updateBillerAcknowledgements","name":"Enables the payee to send full acknowledgement to payer when payer has paid full amount and to send partial acknowledgement to payer when payer has paid partial amount","summary":"Acknowledge RTP requests waiting for payment confirmation by payee","tags":[],"parameters":[{"name":"requestId","in":"path","type":"string","required":true,"description":"The guarantees issuance id initiated by internet banking"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"requestorResponse":"string","extensionData":{}}},"responses":{"200":"BillerAcknowledgementsResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"POST","path":"/order/paymentRequests","fullPath":"/api/v1.3.0/order/paymentRequests","operationId":"createPaymentRequests","name":"Create payment requests for EBA and UK scheme from biller application","summary":"Initiate a RTP request ","tags":[],"parameters":[{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"chargeDetails":[{}],"portalInfo":[{}],"errorInfo":[{}],"paymentMethod":"string","requestedExecutionDate":"string","payerName":"string","payerStreetName":"string","payerBuildingNumber":"string","payerPostalCode":"string","payerTownName":"string","payerCountry":"string","payerDateOfBirth":"string","payerCityOfBirth":"string","payerCountryOfBirth":"string","debitAccount":"string"}},"responses":{"200":"PaymentRequestsResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/order/paymentRequests/payers/status","fullPath":"/api/v1.3.0/order/paymentRequests/payers/status","operationId":"getPayersStatus","name":"Retrieves the list of RTP requests of payer that are pending (that requires action from payer), completed and asked for extension","summary":"Retrieve the list of RTP requests of payer","tags":[],"parameters":[{"name":"currentState","in":"query","type":"string","required":true,"description":"Contains the current state of the transaction"},{"name":"customerId","in":"query","type":"string","required":false,"description":"Identifier of the customer"},{"name":"scheme","in":"query","type":"string","required":false,"description":"Represents the scheme (a synonym for the National ID type) under which the National ID is defined"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"PayersStatusResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/order/paymentRequests/{requestId}/billers/pendingAcknowledgements","fullPath":"/api/v1.3.0/order/paymentRequests/{requestId}/billers/pendingAcknowledgements","operationId":"getApiPendingAck","name":"Retrieves the RTP requests which are yet to be acknowledged by the payee for a payment that has come in due to a result of RTP Request being accepted by payer. Generally, Partially paid or Paid are the two statuses in which payee can send an acknowledgement message corresponding to a payment received","summary":"RTP requests sent which are pending to be acknowledged by payee as payment received","tags":[],"parameters":[{"name":"requestId","in":"path","type":"string","required":true,"description":""},{"name":"customerId","in":"query","type":"string","required":false,"description":"Identifier of the customer"},{"name":"scheme","in":"query","type":"string","required":false,"description":"Represents the scheme (a synonym for the National ID type) under which the National ID is defined"},{"name":"currentState","in":"query","type":"string","required":false,"description":"Contains the current state of the transaction"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"ApiPendingAckResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/order/paymentRequests/{requestId}/billers/pendingExtensions","fullPath":"/api/v1.3.0/order/paymentRequests/{requestId}/billers/pendingExtensions","operationId":"getRequestorsDateExtension","name":"Retrieves the RTP requests with payee which are awaiting response for RTP expiry date extension. These requests can either be declined or approved by the payee","summary":"Payee's RTP requests awaiting RTP expiry date extension approval","tags":[],"parameters":[{"name":"requestId","in":"path","type":"string","required":true,"description":""},{"name":"customerId","in":"query","type":"string","required":false,"description":"Identifier of the customer"},{"name":"scheme","in":"query","type":"string","required":false,"description":"Represents the scheme (a synonym for the National ID type) under which the National ID is defined"},{"name":"requestorReference","in":"query","type":"string","required":false,"description":"Contains the reference of the requestor"},{"name":"currentState","in":"query","type":"string","required":false,"description":"Contains the current state of the transaction"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"RequestorsDateExtensionResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/order/paymentRequests/{requestId}/billers","fullPath":"/api/v1.3.0/order/paymentRequests/{requestId}/billers","operationId":"getRequestorsOutwardRequest","name":"Retrieves the list of requests sent by the payee. Details returned are payer name, amount, status, expiry date, outstanding amount to pay and the notes exchanged so far with payer.","summary":"Retrieve RTP requests (payee side)","tags":[],"parameters":[{"name":"requestId","in":"path","type":"string","required":true,"description":""},{"name":"currentState","in":"query","type":"string","required":false,"description":"Contains the current state of the transaction"},{"name":"customerId","in":"query","type":"string","required":false,"description":"Identifier of the customer"},{"name":"scheme","in":"query","type":"string","required":false,"description":"Represents the scheme (a synonym for the National ID type) under which the National ID is defined"},{"name":"endToEndReference","in":"query","type":"string","required":false,"description":"Indicates the end to end reference for the payment. This field can be provided by the person who instructs the payment and this flows through the lifecycle of the payment."},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"RequestorsOutwardRequestResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/order/paymentRequests/{requestId}/errors","fullPath":"/api/v1.3.0/order/paymentRequests/{requestId}/errors","operationId":"getOutwardErrors","name":"Retrieves the RTP requests which are in error status due to technical reasons. Such requests must be checked for the reason for error manually and a new RTP request must be created/initiated by payee to send the request again to payer","summary":"Retrieve the RTP requests in error status","tags":[],"parameters":[{"name":"requestId","in":"path","type":"string","required":true,"description":""},{"name":"customerId","in":"query","type":"string","required":false,"description":"Identifier of the customer"},{"name":"scheme","in":"query","type":"string","required":false,"description":"Represents the scheme (a synonym for the National ID type) under which the National ID is defined"},{"name":"currentState","in":"query","type":"string","required":false,"description":"Contains the current state of the transaction"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"OutwardErrorsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"POST","path":"/order/paymentRequests/ukPayments/billerRequests","fullPath":"/api/v1.3.0/order/paymentRequests/ukPayments/billerRequests","operationId":"createPayUKPaymentRequests","name":"Creates an RTP request at the Repository Service Provider(RSP). The API is for RSP-RSP communication for biller RSP to place RTP request with payer RSP. This is a provider API which can be linked to any published API in accordance to requesttopay.co.uk standards.","summary":"UK RTP scheme request initiation (RSP - RSP)","tags":[],"parameters":[{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"portalInfo":[{}],"errorInfo":[{}],"chargeDetails":[{}],"paymentStatus":[{}],"acceptanceDateTime":[{}],"additionalInfo":[{}],"messageToPayer":[{}],"messageToRequestor":[{}],"paymentReferenceDetails":[{}],"endToEndReference":"string","paymentMethod":"string","requestorBankBic":"string","requestorBankSortCode":"string","requestorAccountIBAN":"string","requestorAccountNumber":"string"}},"responses":{"200":"PayUKPaymentRequestsResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/order/paymentRequests/{requestId}/ukPayments","fullPath":"/api/v1.3.0/order/paymentRequests/{requestId}/ukPayments","operationId":"amendPayUKPaymentForRepository","name":"API to exchange RTP messages between biller RSP and payer RSP. The API can be used for exchanging various follow up messages for an RTP request(subsequent to RTP initiation) such as acceptance of the request in full or partial, denial of a request, exchange of notes, expiry date extension management, payment acknowledgements. This is a provider API which can be linked to any published API in accordance to requesttopay.co.uk standards.","summary":"UK RTP scheme message exchanges between biller and payer (RSP - RSP)","tags":[],"parameters":[{"name":"requestId","in":"path","type":"string","required":true,"description":""},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"portalInfo":[{}],"errorInfo":[{}],"chargeDetails":[{}],"paymentStatus":[{}],"acceptanceDateTime":[{}],"additionalInfo":[{}],"messageToPayer":[{}],"messageToRequestor":[{}],"paymentReferenceDetails":[{}],"endToEndReference":"string","paymentMethod":"string","requestorBankBic":"string","requestorBankSortCode":"string","requestorAccountIBAN":"string","requestorAccountNumber":"string"}},"responses":{"200":"PayUKPaymentForRepositoryResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/order/paymentRequests/accessTokenRefreshes/{proxyIdentifiers}","fullPath":"/api/v1.3.0/order/paymentRequests/accessTokenRefreshes/{proxyIdentifiers}","operationId":"updatePaymentRequestAccessToken","name":"Update accessToken and scheme for a specific proxy identifier which in turn triggers the refresh and updation of Request To Pay(RTP) data store","summary":"Refresh and update the Request To Pay(RTP) data store","tags":[],"parameters":[{"name":"proxyIdentifiers","in":"path","type":"string","required":true,"description":"Indicates an information that is unique to a customer, such as mobile number, email id etc"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"token":"string","scheme":"string","extensionData":{}}},"responses":{"200":"PaymentRequestAccessTokenResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/order/paymentRequests/{requestId}/payers","fullPath":"/api/v1.3.0/order/paymentRequests/{requestId}/payers","operationId":"getPayersList","name":"Retrieves the list of RTP requests which are received by the payer. The API retrieves RTPs in various states - Completed, Partially paid, Extension Granted, Declined, Extension Declined and Asked For Extension. This API is only to be used for payer side.","summary":"Retrieve RTP requests (payer side)","tags":[],"parameters":[{"name":"requestId","in":"path","type":"string","required":true,"description":""},{"name":"customerId","in":"query","type":"string","required":false,"description":"Identifier of the customer"},{"name":"scheme","in":"query","type":"string","required":false,"description":"Represents the scheme (a synonym for the National ID type) under which the National ID is defined"},{"name":"requestorReference","in":"query","type":"string","required":false,"description":"Contains the reference of the requestor"},{"name":"currentState","in":"query","type":"string","required":false,"description":"Contains the current state of the transaction"},{"name":"endToEndReference","in":"query","type":"string","required":false,"description":"Indicates the end to end reference for the payment. This field can be provided by the person who instructs the payment and this flows through the lifecycle of the payment."},{"name":"payerProxy","in":"query","type":"string","required":false,"description":"Contains the proxy identification of the payer"},{"name":"orderReference","in":"query","type":"string","required":false,"description":"The  order reference number."},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"PayersListResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}}]},{"key":"RequestToPayPayments-v1.4.0","title":"Request to Pay","version":"v1.4.0","description":"Request To Pay (RTP) is a Temenos Payments Application that helps Temenos bank manage their request to pay functionality. It provides RTP functionality and information exchange between the actor (payer or payee) and the RTP clearing. This page lists the APIs offered by Temenos RTP Application to con","endpointCount":24,"endpoints":[{"method":"PUT","path":"/order/paymentRequests/{requestId}/payments","fullPath":"/api/v1.4.0/order/paymentRequests/{requestId}/payments","operationId":"updateFullPayment","name":"Enables the payer to accept RTP request and pay the outstanding amount","summary":"Accept the RTP request with full amount","tags":[],"parameters":[{"name":"requestId","in":"path","type":"string","required":true,"description":"The guarantees issuance id initiated by internet banking"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"additionalInfo":[{}],"debitAccount":"string","paymentReference":"string","amountModifiedByPayer":"string","payerAccountIBAN":"string","paymentDate":"string","token":"string","paymentTime":"string","paymentOrderProduct":"string","extensionData":{}}},"responses":{"200":"FullPaymentResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/order/paymentRequests/{requestId}/partialPayments","fullPath":"/api/v1.4.0/order/paymentRequests/{requestId}/partialPayments","operationId":"updatePartialPayment","name":"Enables the payer to accept RTP request and pay partial amount. The original request sent by the biller remains open until the total amount is paid by the payer","summary":"Accept the RTP request and pay partially","tags":[],"parameters":[{"name":"requestId","in":"path","type":"string","required":true,"description":"The guarantees issuance id initiated by internet banking"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"additionalInfo":[{}],"debitAmount":"string","debitAccount":"string","paymentReference":"string","payerResponse":"string","amountModifiedByPayer":"string","payerAccountIBAN":"string","paymentDate":"string","token":"string","instructedAmount":"string","paymentTime":"string","paymentOrderProduct":"string","extensionData":{}}},"responses":{"200":"PartialPaymentResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/order/paymentRequests/{requestId}/declinedRequests","fullPath":"/api/v1.4.0/order/paymentRequests/{requestId}/declinedRequests","operationId":"updateDeclinePayment","name":"Enables the payer to decline RTP request when payer does not wish to make any payment towards that request","summary":"Decline a RTP request from payee","tags":[],"parameters":[{"name":"requestId","in":"path","type":"string","required":true,"description":"The guarantees issuance id initiated by internet banking"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"additionalInfoToRequestor":[{}],"payerResponse":"string","token":"string","rejectReasonCode":"string","extensionData":{}}},"responses":{"200":"DeclinePaymentResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/order/paymentRequests/{requestId}/billerNotes","fullPath":"/api/v1.4.0/order/paymentRequests/{requestId}/billerNotes","operationId":"updateNotesToRequestor","name":"Enables the payer to send messages to payee when the Payer requires further information regarding a specific RTP request","summary":"Send notes/additional information to payee","tags":[],"parameters":[{"name":"requestId","in":"path","type":"string","required":true,"description":"The guarantees issuance id initiated by internet banking"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"notesToRequestor":[{}],"payerResponse":"string","token":"string","extensionData":{}}},"responses":{"200":"NotesToRequestorResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/order/paymentRequests/{requestId}/amountModifications","fullPath":"/api/v1.4.0/order/paymentRequests/{requestId}/amountModifications","operationId":"updatePaymentAmount","name":"Enables the payer to modify the amount requested by payee in the original RTP request, if modification is allowed by the payee and the corresponding RTP scheme","summary":"Modify the requested amount in the RTP request","tags":[],"parameters":[{"name":"requestId","in":"path","type":"string","required":true,"description":"The guarantees issuance id initiated by internet banking"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"debitAccount":"string","payerAccountIBAN":"string","amountModifiedByPayer":"string","debitAmount":"string","paymentDate":"string","paymentTime":"string","paymentOrderProduct":"string","extensionData":{}}},"responses":{"200":"PaymentAmountResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/order/paymentRequests/{requestId}/blocks","fullPath":"/api/v1.4.0/order/paymentRequests/{requestId}/blocks","operationId":"updateDeclineAndBlock","name":"Enables the payer to decline the payee's RTP request and block the payee when payer does not want to receive any further RTP requests in future from the specific payee","summary":"Decline the RTP request and block the payee","tags":[],"parameters":[{"name":"requestId","in":"path","type":"string","required":true,"description":"The guarantees issuance id initiated by internet banking"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"additionalInfoToRequestor":[{}],"payerResponse":"string","token":"string","rejectReasonCode":"string","extensionData":{}}},"responses":{"200":"DeclineAndBlockResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/order/paymentRequests/{requestId}/payerNotes","fullPath":"/api/v1.4.0/order/paymentRequests/{requestId}/payerNotes","operationId":"updateNotesToPayer","name":"Enables the payee to send notes, additional information to payer when the payee requires further information regarding a specific RTP request","summary":"Send notes / additional information to payer","tags":[],"parameters":[{"name":"requestId","in":"path","type":"string","required":true,"description":"The guarantees issuance id initiated by internet banking"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"notesToPayer":[{}],"payerName":"string","creditAccountId":"string","requestorAccountIBAN":"string","requestorName":"string","requestedExecutionDate":"string","endToEndReference":"string","remittanceInformation":"string","extensionData":{}}},"responses":{"200":"NotesToPayerResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/order/paymentRequests/{requestId}/extensions","fullPath":"/api/v1.4.0/order/paymentRequests/{requestId}/extensions","operationId":"updateDateExtension","name":"Enables the payer to request the payee for a new expiry date for the RTP request received","summary":"Request extension of the RTP expiry date","tags":[],"parameters":[{"name":"requestId","in":"path","type":"string","required":true,"description":"The guarantees issuance id initiated by internet banking"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"additionalInfo":[{}],"requestedExpiryDate":"string","payerResponse":"string","token":"string","extensionData":{}}},"responses":{"200":"DateExtensionResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/order/paymentRequests/{requestId}/extensions/acceptances","fullPath":"/api/v1.4.0/order/paymentRequests/{requestId}/extensions/acceptances","operationId":"getPayerListWithExtensionGranted","name":"Retrieves the payer RTP requests for which the expiry date extensions have been granted by the payee","summary":"Retrieve RTP requests for which extension is granted","tags":[],"parameters":[{"name":"requestId","in":"path","type":"string","required":true,"description":""},{"name":"customerId","in":"query","type":"string","required":false,"description":"Identifier of the customer"},{"name":"scheme","in":"query","type":"string","required":false,"description":"Represents the scheme (a synonym for the National ID type) under which the National ID is defined"},{"name":"currentState","in":"query","type":"string","required":false,"description":"Contains the current state of the transaction"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"PayerListWithExtensionGrantedResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"PUT","path":"/order/paymentRequests/{requestId}/extensions/acceptances","fullPath":"/api/v1.4.0/order/paymentRequests/{requestId}/extensions/acceptances","operationId":"updateGrantExtension","name":"Enables the payee to approve the expiry date for the RTP request sought by the payer","summary":"Approve the expiry date extension requested by the payer","tags":[],"parameters":[{"name":"requestId","in":"path","type":"string","required":true,"description":"The guarantees issuance id initiated by internet banking"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"additionalInfo":[{}],"extensionData":{}}},"responses":{"200":"GrantExtensionResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/order/paymentRequests/{requestId}/extensions/rejections","fullPath":"/api/v1.4.0/order/paymentRequests/{requestId}/extensions/rejections","operationId":"getPayersListWithExtensionDeclined","name":"Retrieves the payer RTP requests for which the expiry date extensions have been declined by the payee","summary":"Retrieve RTP requests for which the extension is declined","tags":[],"parameters":[{"name":"requestId","in":"path","type":"string","required":true,"description":""},{"name":"customerId","in":"query","type":"string","required":false,"description":"Identifier of the customer"},{"name":"scheme","in":"query","type":"string","required":false,"description":"Represents the scheme (a synonym for the National ID type) under which the National ID is defined"},{"name":"currentState","in":"query","type":"string","required":false,"description":"Contains the current state of the transaction"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"PayersListWithExtensionDeclinedResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"PUT","path":"/order/paymentRequests/{requestId}/extensions/rejections","fullPath":"/api/v1.4.0/order/paymentRequests/{requestId}/extensions/rejections","operationId":"updateDeclineExtension","name":"Enables the payee to decline the expiry date for the RTP request sought by the payer","summary":"Decline the expiry date extension requested by payer","tags":[],"parameters":[{"name":"requestId","in":"path","type":"string","required":true,"description":"The guarantees issuance id initiated by internet banking"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"additionalInfo":[{}],"requestorResponse":"string","extensionData":{}}},"responses":{"200":"DeclineExtensionResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/order/paymentRequests/{requestId}/billers/acknowledgements","fullPath":"/api/v1.4.0/order/paymentRequests/{requestId}/billers/acknowledgements","operationId":"updateBillerAcknowledgements","name":"Enables the payee to send full acknowledgement to payer when payer has paid full amount and to send partial acknowledgement to payer when payer has paid partial amount","summary":"Acknowledge RTP requests waiting for payment confirmation by payee","tags":[],"parameters":[{"name":"requestId","in":"path","type":"string","required":true,"description":"The guarantees issuance id initiated by internet banking"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"requestorResponse":"string","extensionData":{}}},"responses":{"200":"BillerAcknowledgementsResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"POST","path":"/order/paymentRequests","fullPath":"/api/v1.4.0/order/paymentRequests","operationId":"createPaymentRequests","name":"Create payment requests for EBA and UK scheme from biller application","summary":"Initiate a RTP request ","tags":[],"parameters":[{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"chargeDetails":[{}],"portalInfo":[{}],"errorInfo":[{}],"paymentMethod":"string","requestedExecutionDate":"string","payerName":"string","payerStreetName":"string","payerBuildingNumber":"string","payerPostalCode":"string","payerTownName":"string","payerCountry":"string","payerDateOfBirth":"string","payerCityOfBirth":"string","payerCountryOfBirth":"string","debitAccount":"string"}},"responses":{"200":"PaymentRequestsResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/order/paymentRequests/payers/status","fullPath":"/api/v1.4.0/order/paymentRequests/payers/status","operationId":"getPayersStatus","name":"Retrieves the list of RTP requests of payer that are pending (that requires action from payer), completed and asked for extension","summary":"Retrieve the list of RTP requests of payer","tags":[],"parameters":[{"name":"currentState","in":"query","type":"string","required":true,"description":"Contains the current state of the transaction"},{"name":"customerId","in":"query","type":"string","required":false,"description":"Identifier of the customer"},{"name":"scheme","in":"query","type":"string","required":false,"description":"Represents the scheme (a synonym for the National ID type) under which the National ID is defined"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"PayersStatusResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/order/paymentRequests/{requestId}/billers/pendingAcknowledgements","fullPath":"/api/v1.4.0/order/paymentRequests/{requestId}/billers/pendingAcknowledgements","operationId":"getApiPendingAck","name":"Retrieves the RTP requests which are yet to be acknowledged by the payee for a payment that has come in due to a result of RTP request being accepted by payer. Generally, Partially paid or Paid are the two statuses in which payee can send an acknowledgement message corresponding to a payment received","summary":"RTP requests sent which are pending to be acknowledged by payee as payment received","tags":[],"parameters":[{"name":"requestId","in":"path","type":"string","required":true,"description":""},{"name":"customerId","in":"query","type":"string","required":false,"description":"Identifier of the customer"},{"name":"scheme","in":"query","type":"string","required":false,"description":"Represents the scheme (a synonym for the National ID type) under which the National ID is defined"},{"name":"currentState","in":"query","type":"string","required":false,"description":"Contains the current state of the transaction"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"ApiPendingAckResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/order/paymentRequests/{requestId}/billers/pendingExtensions","fullPath":"/api/v1.4.0/order/paymentRequests/{requestId}/billers/pendingExtensions","operationId":"getRequestorsDateExtension","name":"Retrieves the RTP requests with payee which are awaiting response for RTP expiry date extension. These requests can either be declined or approved by the payee","summary":"Payee's RTP requests awaiting RTP expiry date extension approval","tags":[],"parameters":[{"name":"requestId","in":"path","type":"string","required":true,"description":""},{"name":"customerId","in":"query","type":"string","required":false,"description":"Identifier of the customer"},{"name":"scheme","in":"query","type":"string","required":false,"description":"Represents the scheme (a synonym for the National ID type) under which the National ID is defined"},{"name":"requestorReference","in":"query","type":"string","required":false,"description":"Contains the reference of the requestor"},{"name":"currentState","in":"query","type":"string","required":false,"description":"Contains the current state of the transaction"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"RequestorsDateExtensionResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/order/paymentRequests/{requestId}/errors","fullPath":"/api/v1.4.0/order/paymentRequests/{requestId}/errors","operationId":"getOutwardErrors","name":"Retrieves the RTP requests which are in error status due to technical reasons. Such requests must be checked for the reason for error manually and a new RTP request must be created/initiated by payee to send the request again to payer","summary":"Retrieve the RTP requests in error status","tags":[],"parameters":[{"name":"requestId","in":"path","type":"string","required":true,"description":""},{"name":"customerId","in":"query","type":"string","required":false,"description":"Identifier of the customer"},{"name":"scheme","in":"query","type":"string","required":false,"description":"Represents the scheme (a synonym for the National ID type) under which the National ID is defined"},{"name":"currentState","in":"query","type":"string","required":false,"description":"Contains the current state of the transaction"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"OutwardErrorsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"POST","path":"/order/paymentRequests/ukPayments/billerRequests","fullPath":"/api/v1.4.0/order/paymentRequests/ukPayments/billerRequests","operationId":"createPayUKPaymentRequests","name":"Creates an RTP request at the Repository Service Provider(RSP). The API is for RSP-RSP communication for biller RSP to place RTP request with payer RSP. This is a provider API which can be linked to any published API in accordance to requesttopay.co.uk standards.","summary":"UK RTP scheme request initiation (RSP - RSP)","tags":[],"parameters":[{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"portalInfo":[{}],"errorInfo":[{}],"chargeDetails":[{}],"paymentStatus":[{}],"acceptanceDateTime":[{}],"additionalInfo":[{}],"messageToPayer":[{}],"messageToRequestor":[{}],"paymentReferenceDetails":[{}],"endToEndReference":"string","paymentMethod":"string","requestorBankBic":"string","requestorBankSortCode":"string","requestorAccountIBAN":"string","requestorAccountNumber":"string"}},"responses":{"200":"PayUKPaymentRequestsResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/order/paymentRequests/{requestId}/ukPayments","fullPath":"/api/v1.4.0/order/paymentRequests/{requestId}/ukPayments","operationId":"amendPayUKPaymentForRepository","name":"API to exchange RTP messages between biller RSP and payer RSP. The API can be used for exchanging various follow up messages for an RTP request(subsequent to RTP initiation) such as acceptance of the request in full or partial, denial of a request, exchange of notes, expiry date extension management, payment acknowledgements. This is a provider API which can be linked to any published API in accordance to requesttopay.co.uk standards.","summary":"UK RTP scheme message exchanges between biller and payer (RSP - RSP)","tags":[],"parameters":[{"name":"requestId","in":"path","type":"string","required":true,"description":""},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"portalInfo":[{}],"errorInfo":[{}],"chargeDetails":[{}],"paymentStatus":[{}],"acceptanceDateTime":[{}],"additionalInfo":[{}],"messageToPayer":[{}],"messageToRequestor":[{}],"paymentReferenceDetails":[{}],"endToEndReference":"string","paymentMethod":"string","requestorBankBic":"string","requestorBankSortCode":"string","requestorAccountIBAN":"string","requestorAccountNumber":"string"}},"responses":{"200":"PayUKPaymentForRepositoryResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/order/paymentRequests/accessTokenRefreshes/{proxyIdentifiers}","fullPath":"/api/v1.4.0/order/paymentRequests/accessTokenRefreshes/{proxyIdentifiers}","operationId":"updatePaymentRequestAccessToken","name":"Update accessToken and scheme for a specific proxy identifier which in turn triggers the refresh and updation of Request To Pay(RTP) data store","summary":"Refresh and update the Request To Pay(RTP) data store","tags":[],"parameters":[{"name":"proxyIdentifiers","in":"path","type":"string","required":true,"description":"Indicates an information that is unique to a customer, such as mobile number, email id etc"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"token":"string","scheme":"string","extensionData":{}}},"responses":{"200":"PaymentRequestAccessTokenResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/order/paymentRequests/{requestId}/payers","fullPath":"/api/v1.4.0/order/paymentRequests/{requestId}/payers","operationId":"getPayersList","name":"Retrieves the list of RTP requests which are received by the payer. The API retrieves RTPs in various states - Completed, Partially paid, Extension Granted, Declined, Extension Declined and Asked For Extension. This API is only to be used for payer side.","summary":"Retrieve RTP requests (payer side)","tags":[],"parameters":[{"name":"requestId","in":"path","type":"string","required":true,"description":""},{"name":"customerId","in":"query","type":"string","required":false,"description":"Identifier of the customer"},{"name":"scheme","in":"query","type":"string","required":false,"description":"Represents the scheme (a synonym for the National ID type) under which the National ID is defined"},{"name":"requestorReference","in":"query","type":"string","required":false,"description":"Contains the reference of the requestor"},{"name":"currentState","in":"query","type":"string","required":false,"description":"Contains the current state of the transaction"},{"name":"endToEndReference","in":"query","type":"string","required":false,"description":"Indicates the end to end reference for the payment. This field can be provided by the person who instructs the payment and this flows through the lifecycle of the payment."},{"name":"payerProxy","in":"query","type":"string","required":false,"description":"Contains the proxy identification of the payer"},{"name":"orderReference","in":"query","type":"string","required":false,"description":"The  order reference number."},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"PayersListResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/order/paymentRequests/schemes","fullPath":"/api/v1.4.0/order/paymentRequests/schemes","operationId":"getSchemeDetails","name":"Retrieves the configured details for the Request to pay (RTP) scheme such as connectivity model, response type and validations","summary":"Retrieve Request to pay (RTP) scheme details","tags":[],"parameters":[{"name":"scheme","in":"query","type":"string","required":false,"description":"Represents the scheme (a synonym for the National ID type) under which the National ID is defined"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"SchemeDetailsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/order/paymentRequests/{requestId}/billers","fullPath":"/api/v1.4.0/order/paymentRequests/{requestId}/billers","operationId":"getRequestorsOutwardRequest","name":"Retrieves the list of requests sent by the payee. Details returned are payer name, amount, status, expiry date, outstanding amount to pay and the notes exchanged so far with payer.","summary":"Retrieve RTP requests (payee side)","tags":[],"parameters":[{"name":"requestId","in":"path","type":"string","required":true,"description":""},{"name":"currentState","in":"query","type":"string","required":false,"description":"Contains the current state of the transaction"},{"name":"customerId","in":"query","type":"string","required":false,"description":"Identifier of the customer"},{"name":"scheme","in":"query","type":"string","required":false,"description":"Represents the scheme (a synonym for the National ID type) under which the National ID is defined"},{"name":"endToEndReference","in":"query","type":"string","required":false,"description":"Indicates the end to end reference for the payment. This field can be provided by the person who instructs the payment and this flows through the lifecycle of the payment."},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"RequestorsOutwardRequestResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}}]},{"key":"RequestToPayPayments-v1.5.0","title":"Request to Pay","version":"v1.5.0","description":"Request To Pay (RTP) is a Temenos Payments Application that helps Temenos bank manage their request to pay functionality. It provides RTP functionality and information exchange between the actor (payer or payee) and the RTP clearing. This page lists the APIs offered by Temenos RTP Application to con","endpointCount":29,"endpoints":[{"method":"PUT","path":"/order/paymentRequests/{requestId}/payments","fullPath":"/api/v1.5.0/order/paymentRequests/{requestId}/payments","operationId":"updateFullPayment","name":"Enables the payer to accept RTP Request and pay the outstanding amount","summary":"Accept the RTP request with full amount","tags":[],"parameters":[{"name":"requestId","in":"path","type":"string","required":true,"description":"The guarantees issuance id initiated by internet banking"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"additionalInfo":[{}],"debitAccount":"string","paymentReference":"string","amountModifiedByPayer":"string","payerAccountIBAN":"string","paymentDate":"string","token":"string","paymentTime":"string","paymentOrderProduct":"string","extensionData":{}}},"responses":{"200":"FullPaymentResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/order/paymentRequests/{requestId}/partialPayments","fullPath":"/api/v1.5.0/order/paymentRequests/{requestId}/partialPayments","operationId":"updatePartialPayment","name":"Enables the payer to accept RTP request and pay partial amount. The original request sent by the biller remains open until the total amount is paid by the payer","summary":"Accept the RTP request and pay partially","tags":[],"parameters":[{"name":"requestId","in":"path","type":"string","required":true,"description":"The guarantees issuance id initiated by internet banking"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"additionalInfo":[{}],"debitAmount":"string","debitAccount":"string","paymentReference":"string","payerResponse":"string","amountModifiedByPayer":"string","payerAccountIBAN":"string","paymentDate":"string","token":"string","instructedAmount":"string","paymentTime":"string","paymentOrderProduct":"string","extensionData":{}}},"responses":{"200":"PartialPaymentResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/order/paymentRequests/{requestId}/declinedRequests","fullPath":"/api/v1.5.0/order/paymentRequests/{requestId}/declinedRequests","operationId":"updateDeclinePayment","name":"Enables the payer to decline RTP request when payer does not wish to make any payment towards that request","summary":"Decline a RTP request from payee","tags":[],"parameters":[{"name":"requestId","in":"path","type":"string","required":true,"description":"The guarantees issuance id initiated by internet banking"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"additionalInfoToRequestor":[{}],"payerResponse":"string","token":"string","rejectReasonCode":"string","extensionData":{}}},"responses":{"200":"DeclinePaymentResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/order/paymentRequests/{requestId}/billerNotes","fullPath":"/api/v1.5.0/order/paymentRequests/{requestId}/billerNotes","operationId":"updateNotesToRequestor","name":"Enables the payer to send messages to payee when the Payer requires further information regarding a specific RTP request","summary":"Send notes/additional information to payee","tags":[],"parameters":[{"name":"requestId","in":"path","type":"string","required":true,"description":"The guarantees issuance id initiated by internet banking"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"notesToRequestor":[{}],"payerResponse":"string","token":"string","extensionData":{}}},"responses":{"200":"NotesToRequestorResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/order/paymentRequests/{requestId}/amountModifications","fullPath":"/api/v1.5.0/order/paymentRequests/{requestId}/amountModifications","operationId":"updatePaymentAmount","name":"Enables the payer to modify the amount requested by payee in the original RTP request, if modification is allowed by the payee and the corresponding RTP scheme","summary":"Modify the requested amount in the RTP request","tags":[],"parameters":[{"name":"requestId","in":"path","type":"string","required":true,"description":"The guarantees issuance id initiated by internet banking"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"debitAccount":"string","payerAccountIBAN":"string","amountModifiedByPayer":"string","debitAmount":"string","paymentDate":"string","paymentTime":"string","paymentOrderProduct":"string","extensionData":{}}},"responses":{"200":"PaymentAmountResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/order/paymentRequests/{requestId}/blocks","fullPath":"/api/v1.5.0/order/paymentRequests/{requestId}/blocks","operationId":"updateDeclineAndBlock","name":"Enables the payer to decline the payee's RTP request and block the payee when payer does not want to receive any further RTP requests in future from the specific payee","summary":"Decline the RTP request and block the payee","tags":[],"parameters":[{"name":"requestId","in":"path","type":"string","required":true,"description":"The guarantees issuance id initiated by internet banking"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"additionalInfoToRequestor":[{}],"payerResponse":"string","token":"string","rejectReasonCode":"string","extensionData":{}}},"responses":{"200":"DeclineAndBlockResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/order/paymentRequests/{requestId}/payerNotes","fullPath":"/api/v1.5.0/order/paymentRequests/{requestId}/payerNotes","operationId":"updateNotesToPayer","name":"Enables the payee to send notes, additional information to payer when the payee requires further information regarding a specific RTP request","summary":"Send notes / additional information to payer","tags":[],"parameters":[{"name":"requestId","in":"path","type":"string","required":true,"description":"The guarantees issuance id initiated by internet banking"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"notesToPayer":[{}],"payerName":"string","creditAccountId":"string","requestorAccountIBAN":"string","requestorName":"string","requestedExecutionDate":"string","endToEndReference":"string","remittanceInformation":"string","extensionData":{}}},"responses":{"200":"NotesToPayerResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/order/paymentRequests/{requestId}/extensions","fullPath":"/api/v1.5.0/order/paymentRequests/{requestId}/extensions","operationId":"updateDateExtension","name":"Enables the payer to request the payee for a new expiry date for the RTP request received","summary":"Request extension of the RTP expiry date","tags":[],"parameters":[{"name":"requestId","in":"path","type":"string","required":true,"description":"The guarantees issuance id initiated by internet banking"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"additionalInfo":[{}],"requestedExpiryDate":"string","payerResponse":"string","token":"string","extensionData":{}}},"responses":{"200":"DateExtensionResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/order/paymentRequests/{requestId}/extensions/acceptances","fullPath":"/api/v1.5.0/order/paymentRequests/{requestId}/extensions/acceptances","operationId":"getPayerListWithExtensionGranted","name":"Retrieves the payer RTP requests for which the expiry date extensions have been granted by the payee","summary":"Retrieve RTP requests for which extension is granted","tags":[],"parameters":[{"name":"requestId","in":"path","type":"string","required":true,"description":""},{"name":"customerId","in":"query","type":"string","required":false,"description":"Identifier of the customer"},{"name":"scheme","in":"query","type":"string","required":false,"description":"Represents the scheme (a synonym for the National ID type) under which the National ID is defined"},{"name":"currentState","in":"query","type":"string","required":false,"description":"Contains the current state of the transaction"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"PayerListWithExtensionGrantedResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"PUT","path":"/order/paymentRequests/{requestId}/extensions/acceptances","fullPath":"/api/v1.5.0/order/paymentRequests/{requestId}/extensions/acceptances","operationId":"updateGrantExtension","name":"Enables the payee to approve the expiry date for the RTP request sought by the payer","summary":"Approve the expiry date extension requested by the payer","tags":[],"parameters":[{"name":"requestId","in":"path","type":"string","required":true,"description":"The guarantees issuance id initiated by internet banking"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"additionalInfo":[{}],"extensionData":{}}},"responses":{"200":"GrantExtensionResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/order/paymentRequests/{requestId}/extensions/rejections","fullPath":"/api/v1.5.0/order/paymentRequests/{requestId}/extensions/rejections","operationId":"getPayersListWithExtensionDeclined","name":"Retrieves the payer RTP requests for which the expiry date extensions have been declined by the payee","summary":"Retrieve RTP requests for which the extension is declined","tags":[],"parameters":[{"name":"requestId","in":"path","type":"string","required":true,"description":""},{"name":"customerId","in":"query","type":"string","required":false,"description":"Identifier of the customer"},{"name":"scheme","in":"query","type":"string","required":false,"description":"Represents the scheme (a synonym for the National ID type) under which the National ID is defined"},{"name":"currentState","in":"query","type":"string","required":false,"description":"Contains the current state of the transaction"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"PayersListWithExtensionDeclinedResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"PUT","path":"/order/paymentRequests/{requestId}/extensions/rejections","fullPath":"/api/v1.5.0/order/paymentRequests/{requestId}/extensions/rejections","operationId":"updateDeclineExtension","name":"Enables the payee to decline the expiry date for the RTP request sought by the payer","summary":"Decline the expiry date extension requested by payer","tags":[],"parameters":[{"name":"requestId","in":"path","type":"string","required":true,"description":"The guarantees issuance id initiated by internet banking"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"additionalInfo":[{}],"requestorResponse":"string","extensionData":{}}},"responses":{"200":"DeclineExtensionResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/order/paymentRequests/{requestId}/billers/acknowledgements","fullPath":"/api/v1.5.0/order/paymentRequests/{requestId}/billers/acknowledgements","operationId":"updateBillerAcknowledgements","name":"Enables the payee to send full acknowledgement to payer when payer has paid full amount and to send partial acknowledgement to payer when payer has paid partial amount","summary":"Acknowledge RTP requests waiting for payment confirmation by payee","tags":[],"parameters":[{"name":"requestId","in":"path","type":"string","required":true,"description":"The guarantees issuance id initiated by internet banking"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"requestorResponse":"string","extensionData":{}}},"responses":{"200":"BillerAcknowledgementsResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"POST","path":"/order/paymentRequests","fullPath":"/api/v1.5.0/order/paymentRequests","operationId":"createPaymentRequests","name":"Create payment requests for EBA and UK scheme from biller application","summary":"Initiate a RTP request ","tags":[],"parameters":[{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"chargeDetails":[{}],"portalInfo":[{}],"errorInfo":[{}],"paymentMethod":"string","requestedExecutionDate":"string","payerName":"string","payerStreetName":"string","payerBuildingNumber":"string","payerPostalCode":"string","payerTownName":"string","payerCountry":"string","payerDateOfBirth":"string","payerCityOfBirth":"string","payerCountryOfBirth":"string","debitAccount":"string"}},"responses":{"200":"PaymentRequestsResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/order/paymentRequests/payers/status","fullPath":"/api/v1.5.0/order/paymentRequests/payers/status","operationId":"getPayersStatus","name":"Retrieves the list of RTP requests of payer that are pending (that requires action from payer), completed and asked for extension","summary":"Retrieve the list of RTP requests of payer","tags":[],"parameters":[{"name":"currentState","in":"query","type":"string","required":true,"description":"Contains the current state of the transaction"},{"name":"customerId","in":"query","type":"string","required":false,"description":"Identifier of the customer"},{"name":"scheme","in":"query","type":"string","required":false,"description":"Represents the scheme (a synonym for the National ID type) under which the National ID is defined"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"PayersStatusResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/order/paymentRequests/{requestId}/billers/pendingAcknowledgements","fullPath":"/api/v1.5.0/order/paymentRequests/{requestId}/billers/pendingAcknowledgements","operationId":"getApiPendingAck","name":"Retrieves the RTP requests which are yet to be acknowledged by the payee for a payment that has come in due to a result of RTP request being accepted by payer. Generally, Partially paid or Paid are the two statuses in which payee can send an acknowledgement message corresponding to a payment received","summary":"RTP requests sent which are pending to be acknowledged by payee as payment received","tags":[],"parameters":[{"name":"requestId","in":"path","type":"string","required":true,"description":""},{"name":"customerId","in":"query","type":"string","required":false,"description":"Identifier of the customer"},{"name":"scheme","in":"query","type":"string","required":false,"description":"Represents the scheme (a synonym for the National ID type) under which the National ID is defined"},{"name":"currentState","in":"query","type":"string","required":false,"description":"Contains the current state of the transaction"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"ApiPendingAckResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/order/paymentRequests/{requestId}/billers/pendingExtensions","fullPath":"/api/v1.5.0/order/paymentRequests/{requestId}/billers/pendingExtensions","operationId":"getRequestorsDateExtension","name":"Retrieves the RTP requests with payee which are awaiting response for RTP expiry date extension. These requests can either be declined or approved by the payee","summary":"Payee's RTP requests awaiting RTP expiry date extension approval","tags":[],"parameters":[{"name":"requestId","in":"path","type":"string","required":true,"description":""},{"name":"customerId","in":"query","type":"string","required":false,"description":"Identifier of the customer"},{"name":"scheme","in":"query","type":"string","required":false,"description":"Represents the scheme (a synonym for the National ID type) under which the National ID is defined"},{"name":"requestorReference","in":"query","type":"string","required":false,"description":"Contains the reference of the requestor"},{"name":"currentState","in":"query","type":"string","required":false,"description":"Contains the current state of the transaction"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"RequestorsDateExtensionResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/order/paymentRequests/{requestId}/errors","fullPath":"/api/v1.5.0/order/paymentRequests/{requestId}/errors","operationId":"getOutwardErrors","name":"Retrieves the RTP requests which are in error status due to technical reasons. Such requests must be checked for the reason for error manually and a new RTP request must be created/initiated by payee to send the request again to payer","summary":"Retrieve the RTP requests in error status","tags":[],"parameters":[{"name":"requestId","in":"path","type":"string","required":true,"description":""},{"name":"customerId","in":"query","type":"string","required":false,"description":"Identifier of the customer"},{"name":"scheme","in":"query","type":"string","required":false,"description":"Represents the scheme (a synonym for the National ID type) under which the National ID is defined"},{"name":"currentState","in":"query","type":"string","required":false,"description":"Contains the current state of the transaction"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"OutwardErrorsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"POST","path":"/order/paymentRequests/ukPayments/billerRequests","fullPath":"/api/v1.5.0/order/paymentRequests/ukPayments/billerRequests","operationId":"createPayUKPaymentRequests","name":"Creates an RTP request at the Repository Service Provider(RSP). The API is for RSP-RSP communication for biller RSP to place RTP request with payer RSP. This is a provider API which can be linked to any published API in accordance to requesttopay.co.uk standards.","summary":"UK RTP scheme request initiation (RSP - RSP)","tags":[],"parameters":[{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"portalInfo":[{}],"errorInfo":[{}],"chargeDetails":[{}],"paymentStatus":[{}],"acceptanceDateTime":[{}],"additionalInfo":[{}],"messageToPayer":[{}],"messageToRequestor":[{}],"paymentReferenceDetails":[{}],"endToEndReference":"string","paymentMethod":"string","requestorBankBic":"string","requestorBankSortCode":"string","requestorAccountIBAN":"string","requestorAccountNumber":"string"}},"responses":{"200":"PayUKPaymentRequestsResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/order/paymentRequests/{requestId}/ukPayments","fullPath":"/api/v1.5.0/order/paymentRequests/{requestId}/ukPayments","operationId":"amendPayUKPaymentForRepository","name":"API to exchange RTP messages between biller RSP and payer RSP. The API can be used for exchanging various follow up messages for an RTP request(subsequent to RTP initiation) such as acceptance of the request in full or partial, denial of a request, exchange of notes, expiry date extension management, payment acknowledgements. This is a provider API which can be linked to any published API in accordance to requesttopay.co.uk standards.","summary":"UK RTP scheme message exchanges between biller and payer (RSP - RSP)","tags":[],"parameters":[{"name":"requestId","in":"path","type":"string","required":true,"description":""},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"portalInfo":[{}],"errorInfo":[{}],"chargeDetails":[{}],"paymentStatus":[{}],"acceptanceDateTime":[{}],"additionalInfo":[{}],"messageToPayer":[{}],"messageToRequestor":[{}],"paymentReferenceDetails":[{}],"endToEndReference":"string","paymentMethod":"string","requestorBankBic":"string","requestorBankSortCode":"string","requestorAccountIBAN":"string","requestorAccountNumber":"string"}},"responses":{"200":"PayUKPaymentForRepositoryResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/order/paymentRequests/accessTokenRefreshes/{proxyIdentifiers}","fullPath":"/api/v1.5.0/order/paymentRequests/accessTokenRefreshes/{proxyIdentifiers}","operationId":"updatePaymentRequestAccessToken","name":"Update access token and scheme for a specific proxy identifier which in turn triggers the refresh and updation of Request To Pay(RTP) data store","summary":"Refresh and update the Request To Pay(RTP) data store","tags":[],"parameters":[{"name":"proxyIdentifiers","in":"path","type":"string","required":true,"description":"Indicates an information that is unique to a customer, such as mobile number, email id etc"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"token":"string","scheme":"string","extensionData":{}}},"responses":{"200":"PaymentRequestAccessTokenResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/order/paymentRequests/{requestId}/payers","fullPath":"/api/v1.5.0/order/paymentRequests/{requestId}/payers","operationId":"getPayersList","name":"Retrieves the list of RTP requests which are received by the payer. The API retrieves RTPs in various states - Completed, Partially paid, Extension Granted, Declined, Extension Declined and Asked For Extension. This API is only to be used for payer side.","summary":"Retrieve RTP requests (payer side)","tags":[],"parameters":[{"name":"requestId","in":"path","type":"string","required":true,"description":""},{"name":"customerId","in":"query","type":"string","required":false,"description":"Identifier of the customer"},{"name":"scheme","in":"query","type":"string","required":false,"description":"Represents the scheme (a synonym for the National ID type) under which the National ID is defined"},{"name":"requestorReference","in":"query","type":"string","required":false,"description":"Contains the reference of the requestor"},{"name":"currentState","in":"query","type":"string","required":false,"description":"Contains the current state of the transaction"},{"name":"endToEndReference","in":"query","type":"string","required":false,"description":"Indicates the end to end reference for the payment. This field can be provided by the person who instructs the payment and this flows through the lifecycle of the payment."},{"name":"payerProxy","in":"query","type":"string","required":false,"description":"Contains the proxy identification of the payer"},{"name":"orderReference","in":"query","type":"string","required":false,"description":"The  order reference number."},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"PayersListResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/order/paymentRequests/{requestId}/billers","fullPath":"/api/v1.5.0/order/paymentRequests/{requestId}/billers","operationId":"getRequestorsOutwardRequest","name":"Retrieves the list of requests sent by the payee. Details returned are payer name, amount, status, expiry date, outstanding amount to pay and the notes exchanged so far with payer.","summary":"Retrieve RTP requests (payee side)","tags":[],"parameters":[{"name":"requestId","in":"path","type":"string","required":true,"description":""},{"name":"currentState","in":"query","type":"string","required":false,"description":"Contains the current state of the transaction"},{"name":"customerId","in":"query","type":"string","required":false,"description":"Identifier of the customer"},{"name":"scheme","in":"query","type":"string","required":false,"description":"Represents the scheme (a synonym for the National ID type) under which the National ID is defined"},{"name":"endToEndReference","in":"query","type":"string","required":false,"description":"Indicates the end to end reference for the payment. This field can be provided by the person who instructs the payment and this flows through the lifecycle of the payment."},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"RequestorsOutwardRequestResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/order/paymentRequests/mandates","fullPath":"/api/v1.5.0/order/paymentRequests/mandates","operationId":"getAllMandateRequest","name":"View list of all mandates","summary":"View list of all mandates","tags":[],"parameters":[{"name":"currentState","in":"query","type":"string","required":false,"description":"Contains the current state of the transaction"},{"name":"customerId","in":"query","type":"string","required":false,"description":"Identifier of the customer"},{"name":"requestToPayScheme","in":"query","type":"string","required":false,"description":"Indicates the scheme in which request to pay message is sent or received"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"AllMandateRequestResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"POST","path":"/order/paymentRequests/mandates","fullPath":"/api/v1.5.0/order/paymentRequests/mandates","operationId":"createMandateRequest","name":"Initiation process to establish mandate between requestor and payer","summary":"Initiation process to establish mandate between requestor and payer","tags":[],"parameters":[{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"endToEndReference":"string","additionalInformationToPayer":"string","requestorName":"string","requestorProxy":"string","requestorAccountNumber":"string","requestorAccountIBAN":"string","payerName":"string","payerProxy":"string","payerAccountNumber":"string","payerAccountIBAN":"string","requestToPayScheme":"string","customerId":"string","currentState":"string","startDate":"string","endDate":"string"}},"responses":{"200":"MandateRequestResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/order/paymentRequests/mandates/{mandateId}","fullPath":"/api/v1.5.0/order/paymentRequests/mandates/{mandateId}","operationId":"updateMandateRequest","name":"Update mandate request status and notes on payer and requestor systems","summary":"Update mandate request status","tags":[],"parameters":[{"name":"mandateId","in":"path","type":"string","required":true,"description":"Contains the mandatory SEPA(Single Euro Payment Area) payment identifier from the transaction"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"messageToPayer":[{}],"messageToRequestor":[{}],"payerResponse":"string","endToEndReference":"string","extensionData":{}}},"responses":{"200":"MandateRequestResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"POST","path":"/order/paymentRequests/ukPayments/mandates","fullPath":"/api/v1.5.0/order/paymentRequests/ukPayments/mandates","operationId":"createUkMandateRequest","name":"Initiation process to establish mandate between requestor and payer","summary":"Initiation process to establish mandate between requestor and payer","tags":[],"parameters":[{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"messageToPayer":[{}],"messageToRequestor":[{}],"endToEndReference":"string","requestMessage":"string","role":"string","requestorName":"string","requestorProxy":"string","requestorAccountNumber":"string","requestorAccountIBAN":"string","payerName":"string","payerProxy":"string","payerAccountNumber":"string","payerAccountIBAN":"string","requestToPayScheme":"string","customerId":"string"}},"responses":{"200":"UkMandateRequestResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/order/paymentRequests/ukPayments/mandates/{mandateId}","fullPath":"/api/v1.5.0/order/paymentRequests/ukPayments/mandates/{mandateId}","operationId":"amendUkMandateRequest","name":"Update mandate request status and notes on payer and requestor systems","summary":"Update mandate request status","tags":[],"parameters":[{"name":"mandateId","in":"path","type":"string","required":true,"description":"Contains the mandatory SEPA(Single Euro Payment Area) payment identifier from the transaction"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"messageToPayer":[{}],"messageToRequestor":[{}],"endToEndReference":"string","requestMessage":"string","role":"string","requestorName":"string","requestorProxy":"string","requestorAccountNumber":"string","requestorAccountIBAN":"string","payerName":"string","payerProxy":"string","payerAccountNumber":"string","payerAccountIBAN":"string","requestToPayScheme":"string","customerId":"string"}},"responses":{"200":"UkMandateRequestResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/order/paymentRequests/schemes","fullPath":"/api/v1.5.0/order/paymentRequests/schemes","operationId":"getSchemeDetails","name":"Retrieve Request to pay (RTP) scheme details","summary":"Retrieves the configured details for the Request to pay (RTP) scheme such as connectivity model, response type and validations","tags":[],"parameters":[{"name":"scheme","in":"query","type":"string","required":false,"description":"Represents the scheme (a synonym for the National ID type) under which the National ID is defined"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"SchemeDetailsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}}]},{"key":"RequestToPayPayments-v1.6.0","title":"Request to Pay","version":"v1.6.0","description":"Request To Pay (RTP) is a Temenos Payments application that helps Temenos bank manage their request to pay functionality. It provides RTP functionality and information exchange between the actor (payer or payee) and the RTP clearing. This page lists the APIs offered by Temenos RTP application to con","endpointCount":31,"endpoints":[{"method":"PUT","path":"/order/paymentRequests/{requestId}/payments","fullPath":"/api/v1.6.0/order/paymentRequests/{requestId}/payments","operationId":"updateFullPayment","name":"Enables the payer to accept RTP request and pay the outstanding amount","summary":"Accept the RTP request with full amount","tags":[],"parameters":[{"name":"requestId","in":"path","type":"string","required":true,"description":"The guarantees issuance id initiated by internet banking"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"additionalInfo":[{}],"debitAccount":"string","paymentReference":"string","amountModifiedByPayer":"string","payerAccountIBAN":"string","paymentDate":"string","token":"string","paymentTime":"string","paymentOrderProduct":"string","extensions":{}}},"responses":{"200":"FullPaymentResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/order/paymentRequests/{requestId}/partialPayments","fullPath":"/api/v1.6.0/order/paymentRequests/{requestId}/partialPayments","operationId":"updatePartialPayment","name":"Enables the payer to accept RTP request and pay partial amount. The original request sent by the biller remains open until the total amount is paid by the payer","summary":"Accept the RTP request and pay partially","tags":[],"parameters":[{"name":"requestId","in":"path","type":"string","required":true,"description":"The guarantees issuance id initiated by internet banking"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"additionalInfo":[{}],"debitAmount":"string","debitAccount":"string","paymentReference":"string","payerResponse":"string","amountModifiedByPayer":"string","payerAccountIBAN":"string","paymentDate":"string","token":"string","instructedAmount":"string","paymentTime":"string","paymentOrderProduct":"string","extensions":{}}},"responses":{"200":"PartialPaymentResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/order/paymentRequests/{requestId}/declinedRequests","fullPath":"/api/v1.6.0/order/paymentRequests/{requestId}/declinedRequests","operationId":"updateDeclinePayment","name":"Enables the payer to decline RTP request when payer does not wish to make any payment towards that request","summary":"Decline a RTP request from payee","tags":[],"parameters":[{"name":"requestId","in":"path","type":"string","required":true,"description":"The guarantees issuance id initiated by internet banking"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"additionalInfoToRequestor":[{}],"payerResponse":"string","token":"string","rejectReasonCode":"string","extensions":{}}},"responses":{"200":"DeclinePaymentResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/order/paymentRequests/{requestId}/billerNotes","fullPath":"/api/v1.6.0/order/paymentRequests/{requestId}/billerNotes","operationId":"updateNotesToRequestor","name":"Enables the payer to send messages to payee when the payer requires further information regarding a specific RTP request","summary":"Send notes/additional information to payee","tags":[],"parameters":[{"name":"requestId","in":"path","type":"string","required":true,"description":"The guarantees issuance id initiated by internet banking"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"notesToRequestor":[{}],"payerResponse":"string","token":"string","extensions":{}}},"responses":{"200":"NotesToRequestorResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/order/paymentRequests/{requestId}/amountModifications","fullPath":"/api/v1.6.0/order/paymentRequests/{requestId}/amountModifications","operationId":"updatePaymentAmount","name":"Enables the payer to modify the amount requested by payee in the original RTP request, if modification is allowed by the payee and the corresponding RTP scheme","summary":"Modify the requested amount in the RTP request","tags":[],"parameters":[{"name":"requestId","in":"path","type":"string","required":true,"description":"The guarantees issuance id initiated by internet banking"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"debitAccount":"string","payerAccountIBAN":"string","amountModifiedByPayer":"string","debitAmount":"string","paymentDate":"string","paymentTime":"string","paymentOrderProduct":"string","extensions":{}}},"responses":{"200":"PaymentAmountResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/order/paymentRequests/{requestId}/blocks","fullPath":"/api/v1.6.0/order/paymentRequests/{requestId}/blocks","operationId":"updateDeclineAndBlock","name":"Enables the payer to decline the payee's RTP request and block the payee when payer does not want to receive any further RTP requests in future from the specific payee","summary":"Decline the RTP request and block the payee","tags":[],"parameters":[{"name":"requestId","in":"path","type":"string","required":true,"description":"The guarantees issuance id initiated by internet banking"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"additionalInfoToRequestor":[{}],"payerResponse":"string","token":"string","rejectReasonCode":"string","extensions":{}}},"responses":{"200":"DeclineAndBlockResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/order/paymentRequests/{requestId}/payerNotes","fullPath":"/api/v1.6.0/order/paymentRequests/{requestId}/payerNotes","operationId":"updateNotesToPayer","name":"Enables the payee to send notes, additional information to payer when the payee requires further information regarding a specific RTP request","summary":"Send notes / additional information to payer","tags":[],"parameters":[{"name":"requestId","in":"path","type":"string","required":true,"description":"The guarantees issuance id initiated by internet banking"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"notesToPayer":[{}],"payerName":"string","creditAccountId":"string","requestorAccountIBAN":"string","requestorName":"string","requestedExecutionDate":"string","endToEndReference":"string","remittanceInformation":"string","extensions":{}}},"responses":{"200":"NotesToPayerResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/order/paymentRequests/{requestId}/extensions","fullPath":"/api/v1.6.0/order/paymentRequests/{requestId}/extensions","operationId":"updateDateExtension","name":"Enables the payer to request the payee for a new expiry date for the RTP request received","summary":"Request extension of the RTP expiry date","tags":[],"parameters":[{"name":"requestId","in":"path","type":"string","required":true,"description":"The guarantees issuance id initiated by internet banking"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"additionalInfo":[{}],"requestedExpiryDate":"string","payerResponse":"string","token":"string","extensions":{}}},"responses":{"200":"DateExtensionResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/order/paymentRequests/{requestId}/extensions/acceptances","fullPath":"/api/v1.6.0/order/paymentRequests/{requestId}/extensions/acceptances","operationId":"getPayerListWithExtensionGranted","name":"Retrieves the payer RTP requests for which the expiry date extensions have been granted by the payee","summary":"Retrieve RTP requests for which extension is granted","tags":[],"parameters":[{"name":"requestId","in":"path","type":"string","required":true,"description":""},{"name":"customerId","in":"query","type":"string","required":false,"description":"Identifier of the customer"},{"name":"scheme","in":"query","type":"string","required":false,"description":"Represents the scheme (a synonym for the National ID type) under which the National ID is defined"},{"name":"currentState","in":"query","type":"string","required":false,"description":"Contains the current state of the transaction"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"PayerListWithExtensionGrantedResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"PUT","path":"/order/paymentRequests/{requestId}/extensions/acceptances","fullPath":"/api/v1.6.0/order/paymentRequests/{requestId}/extensions/acceptances","operationId":"updateGrantExtension","name":"Enables the payee to approve the expiry date for the RTP request sought by the payer","summary":"Approve the expiry date extension requested by the payer","tags":[],"parameters":[{"name":"requestId","in":"path","type":"string","required":true,"description":"The guarantees issuance id initiated by internet banking"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"additionalInfo":[{}],"extensions":{}}},"responses":{"200":"GrantExtensionResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/order/paymentRequests/{requestId}/extensions/rejections","fullPath":"/api/v1.6.0/order/paymentRequests/{requestId}/extensions/rejections","operationId":"getPayersListWithExtensionDeclined","name":"Retrieves the payer RTP requests for which the expiry date extensions have been declined by the payee","summary":"Retrieve RTP requests for which the extension is declined","tags":[],"parameters":[{"name":"requestId","in":"path","type":"string","required":true,"description":""},{"name":"customerId","in":"query","type":"string","required":false,"description":"Identifier of the customer"},{"name":"scheme","in":"query","type":"string","required":false,"description":"Represents the scheme (a synonym for the National ID type) under which the National ID is defined"},{"name":"currentState","in":"query","type":"string","required":false,"description":"Contains the current state of the transaction"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"PayersListWithExtensionDeclinedResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"PUT","path":"/order/paymentRequests/{requestId}/extensions/rejections","fullPath":"/api/v1.6.0/order/paymentRequests/{requestId}/extensions/rejections","operationId":"updateDeclineExtension","name":"Enables the payee to decline the expiry date for the RTP request sought by the payer","summary":"Decline the expiry date extension requested by payer","tags":[],"parameters":[{"name":"requestId","in":"path","type":"string","required":true,"description":"The guarantees issuance id initiated by internet banking"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"additionalInfo":[{}],"requestorResponse":"string","extensions":{}}},"responses":{"200":"DeclineExtensionResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/order/paymentRequests/{requestId}/billers/acknowledgements","fullPath":"/api/v1.6.0/order/paymentRequests/{requestId}/billers/acknowledgements","operationId":"updateBillerAcknowledgements","name":"Enables the payee to send full acknowledgement to payer when payer has paid full amount and to send partial acknowledgement to payer when payer has paid partial amount","summary":"Acknowledge RTP requests waiting for payment confirmation by payee","tags":[],"parameters":[{"name":"requestId","in":"path","type":"string","required":true,"description":"The guarantees issuance id initiated by internet banking"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"requestorResponse":"string","extensions":{}}},"responses":{"200":"BillerAcknowledgementsResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"POST","path":"/order/paymentRequests","fullPath":"/api/v1.6.0/order/paymentRequests","operationId":"createPaymentRequests","name":"Create payment requests for EBA and UK scheme from biller application","summary":"Initiate a RTP request ","tags":[],"parameters":[{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"chargeDetails":[{}],"portalInfo":[{}],"errorInfo":[{}],"paymentMethod":"string","requestedExecutionDate":"string","payerName":"string","payerStreetName":"string","payerBuildingNumber":"string","payerPostalCode":"string","payerTownName":"string","payerCountry":"string","payerDateOfBirth":"string","payerCityOfBirth":"string","payerCountryOfBirth":"string","debitAccount":"string"}},"responses":{"200":"PaymentRequestsResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/order/paymentRequests/payers/status","fullPath":"/api/v1.6.0/order/paymentRequests/payers/status","operationId":"getPayersStatus","name":"Retrieves the list of RTP requests of payer that are pending (that requires action from payer), completed and asked for extension","summary":"Retrieve the list of RTP requests of payer","tags":[],"parameters":[{"name":"currentState","in":"query","type":"string","required":true,"description":"Contains the current state of the transaction"},{"name":"customerId","in":"query","type":"string","required":false,"description":"Identifier of the customer"},{"name":"scheme","in":"query","type":"string","required":false,"description":"Represents the scheme (a synonym for the National ID type) under which the National ID is defined"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"PayersStatusResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/order/paymentRequests/{requestId}/billers/pendingAcknowledgements","fullPath":"/api/v1.6.0/order/paymentRequests/{requestId}/billers/pendingAcknowledgements","operationId":"getApiPendingAck","name":"Retrieves the RTP requests which are yet to be acknowledged by the payee for a payment that has come in due to a result of RTP request being accepted by payer. Generally, 'Partially paid' or 'Paid' are the two statuses in which payee can send an acknowledgement message corresponding to a payment received","summary":"RTP requests sent which are pending to be acknowledged by payee as payment received","tags":[],"parameters":[{"name":"requestId","in":"path","type":"string","required":true,"description":""},{"name":"customerId","in":"query","type":"string","required":false,"description":"Identifier of the customer"},{"name":"scheme","in":"query","type":"string","required":false,"description":"Represents the scheme (a synonym for the National ID type) under which the National ID is defined"},{"name":"currentState","in":"query","type":"string","required":false,"description":"Contains the current state of the transaction"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"ApiPendingAckResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/order/paymentRequests/{requestId}/billers/pendingExtensions","fullPath":"/api/v1.6.0/order/paymentRequests/{requestId}/billers/pendingExtensions","operationId":"getRequestorsDateExtension","name":"Retrieves the RTP requests with payee which are awaiting response for RTP expiry date extension. These requests can either be declined or approved by the payee","summary":"Payee's RTP requests awaiting RTP expiry date extension approval","tags":[],"parameters":[{"name":"requestId","in":"path","type":"string","required":true,"description":""},{"name":"customerId","in":"query","type":"string","required":false,"description":"Identifier of the customer"},{"name":"scheme","in":"query","type":"string","required":false,"description":"Represents the scheme (a synonym for the National ID type) under which the National ID is defined"},{"name":"requestorReference","in":"query","type":"string","required":false,"description":"Contains the reference of the requestor"},{"name":"currentState","in":"query","type":"string","required":false,"description":"Contains the current state of the transaction"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"RequestorsDateExtensionResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/order/paymentRequests/{requestId}/errors","fullPath":"/api/v1.6.0/order/paymentRequests/{requestId}/errors","operationId":"getOutwardErrors","name":"Retrieves the RTP requests which are in error status due to technical reasons. Such requests must be checked for the reason for error manually and a new RTP request must be created/initiated by payee to send the request again to payer","summary":"Retrieve the RTP requests in error status","tags":[],"parameters":[{"name":"requestId","in":"path","type":"string","required":true,"description":""},{"name":"customerId","in":"query","type":"string","required":false,"description":"Identifier of the customer"},{"name":"scheme","in":"query","type":"string","required":false,"description":"Represents the scheme (a synonym for the National ID type) under which the National ID is defined"},{"name":"currentState","in":"query","type":"string","required":false,"description":"Contains the current state of the transaction"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"OutwardErrorsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"POST","path":"/order/paymentRequests/ukPayments/billerRequests","fullPath":"/api/v1.6.0/order/paymentRequests/ukPayments/billerRequests","operationId":"createPayUKPaymentRequests","name":"Creates an RTP request at the Repository Service Provider(RSP). The API is for RSP-RSP communication for biller RSP to place RTP request with payer RSP. This is a provider API which can be linked to any published API in accordance to requesttopay.co.uk standards.","summary":"UK RTP scheme request initiation (RSP - RSP)","tags":[],"parameters":[{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"portalInfo":[{}],"errorInfo":[{}],"chargeDetails":[{}],"paymentStatus":[{}],"acceptanceDateTime":[{}],"additionalInfo":[{}],"messageToPayer":[{}],"messageToRequestor":[{}],"paymentReferenceDetails":[{}],"endToEndReference":"string","paymentMethod":"string","requestorBankBic":"string","requestorBankSortCode":"string","requestorAccountIBAN":"string","requestorAccountNumber":"string"}},"responses":{"200":"PayUKPaymentRequestsResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/order/paymentRequests/{requestId}/ukPayments","fullPath":"/api/v1.6.0/order/paymentRequests/{requestId}/ukPayments","operationId":"amendPayUKPaymentForRepository","name":"API to exchange RTP messages between biller RSP and payer RSP. The API can be used for exchanging various follow up messages for an RTP request(subsequent to RTP initiation) such as acceptance of the request in full or partial, denial of a request, exchange of notes, expiry date extension management, payment acknowledgements. This is a provider API which can be linked to any published API in accordance to requesttopay.co.uk standards.","summary":"UK RTP scheme message exchanges between biller and payer (RSP - RSP)","tags":[],"parameters":[{"name":"requestId","in":"path","type":"string","required":true,"description":""},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"portalInfo":[{}],"errorInfo":[{}],"chargeDetails":[{}],"paymentStatus":[{}],"acceptanceDateTime":[{}],"additionalInfo":[{}],"messageToPayer":[{}],"messageToRequestor":[{}],"paymentReferenceDetails":[{}],"endToEndReference":"string","paymentMethod":"string","requestorBankBic":"string","requestorBankSortCode":"string","requestorAccountIBAN":"string","requestorAccountNumber":"string"}},"responses":{"200":"PayUKPaymentForRepositoryResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/order/paymentRequests/accessTokenRefreshes/{proxyIdentifiers}","fullPath":"/api/v1.6.0/order/paymentRequests/accessTokenRefreshes/{proxyIdentifiers}","operationId":"updatePaymentRequestAccessToken","name":"Update accessToken and scheme for a specific proxy identifier which in turn triggers the refresh and updation of Request To Pay(RTP) data store","summary":"Refresh and update the Request To Pay(RTP) data store","tags":[],"parameters":[{"name":"proxyIdentifiers","in":"path","type":"string","required":true,"description":"Indicates an information that is unique to a customer, such as mobile number, email id etc"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"token":"string","scheme":"string","extensions":{}}},"responses":{"200":"PaymentRequestAccessTokenResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/order/paymentRequests/{requestId}/payers","fullPath":"/api/v1.6.0/order/paymentRequests/{requestId}/payers","operationId":"getPayersList","name":"Retrieves the list of RTP requests which are received by the payer. The API retrieves RTPs in various states - Completed, Partially paid, Extension Granted, Declined, Extension Declined and Asked For Extension. This API is only to be used for payer side.","summary":"Retrieve RTP requests (payer side)","tags":[],"parameters":[{"name":"requestId","in":"path","type":"string","required":true,"description":""},{"name":"customerId","in":"query","type":"string","required":false,"description":"Identifier of the customer"},{"name":"scheme","in":"query","type":"string","required":false,"description":"Represents the scheme (a synonym for the National ID type) under which the National ID is defined"},{"name":"requestorReference","in":"query","type":"string","required":false,"description":"Contains the reference of the requestor"},{"name":"currentState","in":"query","type":"string","required":false,"description":"Contains the current state of the transaction"},{"name":"endToEndReference","in":"query","type":"string","required":false,"description":"Indicates the end to end reference for the payment. This field can be provided by the person who instructs the payment and this flows through the lifecycle of the payment."},{"name":"payerProxy","in":"query","type":"string","required":false,"description":"Contains the proxy identification of the payer"},{"name":"orderReference","in":"query","type":"string","required":false,"description":"The  order reference number."},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"PayersListResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/order/paymentRequests/{requestId}/billers","fullPath":"/api/v1.6.0/order/paymentRequests/{requestId}/billers","operationId":"getRequestorsOutwardRequest","name":"Retrieves the list of requests sent by the payee. Details returned are payer name, amount, status, expiry date, outstanding amount to pay and the notes exchanged so far with payer.","summary":"Retrieve RTP requests (payee side)","tags":[],"parameters":[{"name":"requestId","in":"path","type":"string","required":true,"description":""},{"name":"currentState","in":"query","type":"string","required":false,"description":"Contains the current state of the transaction"},{"name":"customerId","in":"query","type":"string","required":false,"description":"Identifier of the customer"},{"name":"scheme","in":"query","type":"string","required":false,"description":"Represents the scheme (a synonym for the National ID type) under which the National ID is defined"},{"name":"endToEndReference","in":"query","type":"string","required":false,"description":"Indicates the end to end reference for the payment. This field can be provided by the person who instructs the payment and this flows through the lifecycle of the payment."},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"RequestorsOutwardRequestResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/order/paymentRequests/mandates","fullPath":"/api/v1.6.0/order/paymentRequests/mandates","operationId":"getAllMandateRequest","name":"View list of all Mandates","summary":"View list of all Mandates","tags":[],"parameters":[{"name":"currentState","in":"query","type":"string","required":false,"description":"Contains the current state of the transaction"},{"name":"customerId","in":"query","type":"string","required":false,"description":"Identifier of the customer"},{"name":"requestToPayScheme","in":"query","type":"string","required":false,"description":"Indicates the scheme in which request to pay message is sent or received"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"AllMandateRequestResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"POST","path":"/order/paymentRequests/mandates","fullPath":"/api/v1.6.0/order/paymentRequests/mandates","operationId":"createMandateRequest","name":"Initiation process to establish mandate between requestor and payer","summary":"Initiation process to establish mandate between requestor and payer","tags":[],"parameters":[{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"endToEndReference":"string","additionalInformationToPayer":"string","requestorName":"string","requestorProxy":"string","requestorAccountNumber":"string","requestorAccountIBAN":"string","payerName":"string","payerProxy":"string","payerAccountNumber":"string","payerAccountIBAN":"string","requestToPayScheme":"string","customerId":"string","currentState":"string","startDate":"string","endDate":"string"}},"responses":{"200":"MandateRequestResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/order/paymentRequests/mandates/{mandateId}","fullPath":"/api/v1.6.0/order/paymentRequests/mandates/{mandateId}","operationId":"updateMandateRequest","name":"Update mandate request status and notes on payer and requestor systems","summary":"Update mandate request status","tags":[],"parameters":[{"name":"mandateId","in":"path","type":"string","required":true,"description":"Contains the mandatory SEPA(Single Euro Payment Area) payment identifier from the transaction"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"messageToPayer":[{}],"messageToRequestor":[{}],"payerResponse":"string","endToEndReference":"string","extensions":{}}},"responses":{"200":"MandateRequestResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"POST","path":"/order/paymentRequests/ukPayments/mandates","fullPath":"/api/v1.6.0/order/paymentRequests/ukPayments/mandates","operationId":"createUkMandateRequest","name":"Initiation process to establish mandate between requestor and payer","summary":"Initiation process to establish mandate between requestor and payer","tags":[],"parameters":[{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"messageToPayer":[{}],"messageToRequestor":[{}],"endToEndReference":"string","requestMessage":"string","role":"string","requestorName":"string","requestorProxy":"string","requestorAccountNumber":"string","requestorAccountIBAN":"string","payerName":"string","payerProxy":"string","payerAccountNumber":"string","payerAccountIBAN":"string","requestToPayScheme":"string","customerId":"string"}},"responses":{"200":"UkMandateRequestResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/order/paymentRequests/ukPayments/mandates/{mandateId}","fullPath":"/api/v1.6.0/order/paymentRequests/ukPayments/mandates/{mandateId}","operationId":"amendUkMandateRequest","name":"Update mandate request status and notes on payer and requestor systems","summary":"Update mandate request status","tags":[],"parameters":[{"name":"mandateId","in":"path","type":"string","required":true,"description":"Contains the mandatory SEPA(Single Euro Payment Area) payment identifier from the transaction"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"messageToPayer":[{}],"messageToRequestor":[{}],"endToEndReference":"string","requestMessage":"string","role":"string","requestorName":"string","requestorProxy":"string","requestorAccountNumber":"string","requestorAccountIBAN":"string","payerName":"string","payerProxy":"string","payerAccountNumber":"string","payerAccountIBAN":"string","requestToPayScheme":"string","customerId":"string"}},"responses":{"200":"UkMandateRequestResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/order/paymentRequests/schemes","fullPath":"/api/v1.6.0/order/paymentRequests/schemes","operationId":"getSchemeDetails","name":"Retrieves the configured details for the Request to pay (RTP) scheme such as connectivity model, response type and validations","summary":"Retrieve Request to pay (RTP) scheme details","tags":[],"parameters":[{"name":"scheme","in":"query","type":"string","required":false,"description":"Represents the scheme (a synonym for the National ID type) under which the National ID is defined"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"SchemeDetailsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"PUT","path":"/order/paymentRequests/{requestId}/recalls","fullPath":"/api/v1.6.0/order/paymentRequests/{requestId}/recalls","operationId":"updateRTPRecall","name":"The user can initiate a recall of an already initiated RTP. RTP request can be recalled for various reason such as duplication request, fraudulent request etc.","summary":"Recall RTP request","tags":[],"parameters":[{"name":"requestId","in":"path","type":"string","required":true,"description":""},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"recallId":"Recall ID","requestToPayScheme":"RTP Scheme","requestorResponse":"Requestor response","cancelReason":"Cancel Reason Code","extensions":{}}},"responses":{"200":"RTPRecallResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/order/paymentRequests/schemes/returnCodes","fullPath":"/api/v1.6.0/order/paymentRequests/schemes/returnCodes","operationId":"getSchemeReturnCodes","name":"Retrieves the list of return codes configured for a particular clearing scheme. The return codes will be used in processing Request to pay (RTP) rejects and  recall processing.","summary":"Retrieve Request to pay (RTP) scheme return code details","tags":[],"parameters":[{"name":"requestToPayScheme","in":"query","type":"string","required":false,"description":"Indicates the scheme in which request to pay message is sent or received"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"SchemeReturnCodesResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}}]},{"key":"RequestToPayPayments-v1.7.0","title":"Request to Pay","version":"v1.7.0","description":"Request To Pay (RTP) is a Temenos Payments application that helps Temenos bank manage their request to pay functionality. It provides RTP functionality and information exchange between the actor (payer or payee) and the RTP clearing. This page lists the APIs offered by Temenos RTP Application to con","endpointCount":34,"endpoints":[{"method":"PUT","path":"/order/paymentRequests/{requestId}/payments","fullPath":"/api/v1.7.0/order/paymentRequests/{requestId}/payments","operationId":"updateFullPayment","name":"Enables the payer to accept RTP Request and pay the outstanding amount","summary":"Accept the RTP request with full amount","tags":[],"parameters":[{"name":"requestId","in":"path","type":"string","required":true,"description":"The guarantees issuance id initiated by internet banking"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"additionalInfo":[{}],"debitAccount":"string","paymentReference":"string","amountModifiedByPayer":"string","payerAccountIBAN":"string","paymentDate":"string","token":"string","paymentTime":"string","paymentOrderProduct":"string","extensions":{}}},"responses":{"200":"FullPaymentResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/order/paymentRequests/{requestId}/partialPayments","fullPath":"/api/v1.7.0/order/paymentRequests/{requestId}/partialPayments","operationId":"updatePartialPayment","name":"Enables the payer to accept RTP request and pay partial amount. The original request sent by the biller remains open until the total amount is paid by the payer","summary":"Accept the RTP request and pay partially","tags":[],"parameters":[{"name":"requestId","in":"path","type":"string","required":true,"description":"The guarantees issuance id initiated by internet banking"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"additionalInfo":[{}],"debitAmount":"string","debitAccount":"string","paymentReference":"string","payerResponse":"string","amountModifiedByPayer":"string","payerAccountIBAN":"string","paymentDate":"string","token":"string","instructedAmount":"string","paymentTime":"string","paymentOrderProduct":"string","extensions":{}}},"responses":{"200":"PartialPaymentResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/order/paymentRequests/{requestId}/declinedRequests","fullPath":"/api/v1.7.0/order/paymentRequests/{requestId}/declinedRequests","operationId":"updateDeclinePayment","name":"Enables the payer to decline RTP request when payer does not wish to make any payment towards that request","summary":"Decline a RTP request from payee","tags":[],"parameters":[{"name":"requestId","in":"path","type":"string","required":true,"description":"The guarantees issuance id initiated by internet banking"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"additionalInfoToRequestor":[{}],"payerResponse":"string","token":"string","rejectReasonCode":"string","extensions":{}}},"responses":{"200":"DeclinePaymentResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/order/paymentRequests/{requestId}/billerNotes","fullPath":"/api/v1.7.0/order/paymentRequests/{requestId}/billerNotes","operationId":"updateNotesToRequestor","name":"Enables the payer to send messages to payee when the Payer requires further information regarding a specific RTP request","summary":"Send notes/additional information to payee","tags":[],"parameters":[{"name":"requestId","in":"path","type":"string","required":true,"description":"The guarantees issuance id initiated by internet banking"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"notesToRequestor":[{}],"payerResponse":"string","token":"string","extensions":{}}},"responses":{"200":"NotesToRequestorResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/order/paymentRequests/{requestId}/amountModifications","fullPath":"/api/v1.7.0/order/paymentRequests/{requestId}/amountModifications","operationId":"updatePaymentAmount","name":"Enables the payer to modify the amount requested by payee in the original RTP request, if modification is allowed by the payee and the corresponding RTP scheme","summary":"Modify the requested amount in the RTP request","tags":[],"parameters":[{"name":"requestId","in":"path","type":"string","required":true,"description":"The guarantees issuance id initiated by internet banking"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"debitAccount":"string","payerAccountIBAN":"string","amountModifiedByPayer":"string","debitAmount":"string","paymentDate":"string","paymentTime":"string","paymentOrderProduct":"string","extensions":{}}},"responses":{"200":"PaymentAmountResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/order/paymentRequests/{requestId}/blocks","fullPath":"/api/v1.7.0/order/paymentRequests/{requestId}/blocks","operationId":"updateDeclineAndBlock","name":"Enables the payer to decline the payee's RTP request and block the payee when payer does not want to receive any further RTP requests in future from the specific payee","summary":"Decline the RTP request and block the payee","tags":[],"parameters":[{"name":"requestId","in":"path","type":"string","required":true,"description":"The guarantees issuance id initiated by internet banking"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"additionalInfoToRequestor":[{}],"payerResponse":"string","token":"string","rejectReasonCode":"string","extensions":{}}},"responses":{"200":"DeclineAndBlockResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/order/paymentRequests/{requestId}/payerNotes","fullPath":"/api/v1.7.0/order/paymentRequests/{requestId}/payerNotes","operationId":"updateNotesToPayer","name":"Enables the payee to send notes, additional information to payer when the payee requires further information regarding a specific RTP request","summary":"Send notes / additional information to payer","tags":[],"parameters":[{"name":"requestId","in":"path","type":"string","required":true,"description":"The guarantees issuance id initiated by internet banking"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"notesToPayer":[{}],"payerName":"string","creditAccountId":"string","requestorAccountIBAN":"string","requestorName":"string","requestedExecutionDate":"string","endToEndReference":"string","remittanceInformation":"string","extensions":{}}},"responses":{"200":"NotesToPayerResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/order/paymentRequests/{requestId}/extensions","fullPath":"/api/v1.7.0/order/paymentRequests/{requestId}/extensions","operationId":"updateDateExtension","name":"Enables the payer to request the payee for a new expiry date for the RTP request received","summary":"Request extension of the RTP expiry date","tags":[],"parameters":[{"name":"requestId","in":"path","type":"string","required":true,"description":"The guarantees issuance id initiated by internet banking"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"additionalInfo":[{}],"requestedExpiryDate":"string","payerResponse":"string","token":"string","extensions":{}}},"responses":{"200":"DateExtensionResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/order/paymentRequests/{requestId}/extensions/acceptances","fullPath":"/api/v1.7.0/order/paymentRequests/{requestId}/extensions/acceptances","operationId":"getPayerListWithExtensionGranted","name":"Retrieves the payer RTP requests for which the expiry date extensions have been granted by the payee","summary":"Retrieve RTP requests for which extension is granted","tags":[],"parameters":[{"name":"requestId","in":"path","type":"string","required":true,"description":""},{"name":"customerId","in":"query","type":"string","required":false,"description":"Identifier of the customer"},{"name":"scheme","in":"query","type":"string","required":false,"description":"Represents the scheme (a synonym for the National ID type) under which the National ID is defined"},{"name":"currentState","in":"query","type":"string","required":false,"description":"Contains the current state of the transaction"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"PayerListWithExtensionGrantedResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"PUT","path":"/order/paymentRequests/{requestId}/extensions/acceptances","fullPath":"/api/v1.7.0/order/paymentRequests/{requestId}/extensions/acceptances","operationId":"updateGrantExtension","name":"Enables the payee to approve the expiry date for the RTP request sought by the payer","summary":"Approve the expiry date extension requested by the payer","tags":[],"parameters":[{"name":"requestId","in":"path","type":"string","required":true,"description":"The guarantees issuance id initiated by internet banking"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"additionalInfo":[{}],"extensions":{}}},"responses":{"200":"GrantExtensionResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/order/paymentRequests/{requestId}/extensions/rejections","fullPath":"/api/v1.7.0/order/paymentRequests/{requestId}/extensions/rejections","operationId":"getPayersListWithExtensionDeclined","name":"Retrieves the payer RTP requests for which the expiry date extensions have been declined by the payee","summary":"Retrieve RTP requests for which the extension is declined","tags":[],"parameters":[{"name":"requestId","in":"path","type":"string","required":true,"description":""},{"name":"customerId","in":"query","type":"string","required":false,"description":"Identifier of the customer"},{"name":"scheme","in":"query","type":"string","required":false,"description":"Represents the scheme (a synonym for the National ID type) under which the National ID is defined"},{"name":"currentState","in":"query","type":"string","required":false,"description":"Contains the current state of the transaction"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"PayersListWithExtensionDeclinedResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"PUT","path":"/order/paymentRequests/{requestId}/extensions/rejections","fullPath":"/api/v1.7.0/order/paymentRequests/{requestId}/extensions/rejections","operationId":"updateDeclineExtension","name":"Enables the payee to decline the expiry date for the RTP request sought by the payer","summary":"Decline the expiry date extension requested by payer","tags":[],"parameters":[{"name":"requestId","in":"path","type":"string","required":true,"description":"The guarantees issuance id initiated by internet banking"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"additionalInfo":[{}],"requestorResponse":"string","extensions":{}}},"responses":{"200":"DeclineExtensionResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/order/paymentRequests/{requestId}/billers/acknowledgements","fullPath":"/api/v1.7.0/order/paymentRequests/{requestId}/billers/acknowledgements","operationId":"updateBillerAcknowledgements","name":"Enables the payee to send full acknowledgement to payer when payer has paid full amount and to send partial acknowledgement to payer when payer has paid partial amount","summary":"Acknowledge RTP requests waiting for payment confirmation by payee","tags":[],"parameters":[{"name":"requestId","in":"path","type":"string","required":true,"description":"The guarantees issuance id initiated by internet banking"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"requestorResponse":"string","extensions":{}}},"responses":{"200":"BillerAcknowledgementsResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"POST","path":"/order/paymentRequests","fullPath":"/api/v1.7.0/order/paymentRequests","operationId":"createPaymentRequests","name":"Create payment requests for EBA and UK scheme from biller application","summary":"Initiate a RTP request ","tags":[],"parameters":[{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"chargeDetails":[{}],"portalInfo":[{}],"errorInfo":[{}],"paymentMethod":"string","requestedExecutionDate":"string","payerName":"string","payerStreetName":"string","payerBuildingNumber":"string","payerPostalCode":"string","payerTownName":"string","payerCountry":"string","payerDateOfBirth":"string","payerCityOfBirth":"string","payerCountryOfBirth":"string","debitAccount":"string"}},"responses":{"200":"PaymentRequestsResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/order/paymentRequests/{requestId}/billers/pendingAcknowledgements","fullPath":"/api/v1.7.0/order/paymentRequests/{requestId}/billers/pendingAcknowledgements","operationId":"getApiPendingAck","name":"Retrieves the RTP requests which are yet to be acknowledged by the payee for a payment that has come in due to a result of RTP request being accepted by payer. Generally, 'Partially paid' or 'Paid' are the two statuses in which payee can send an acknowledgement message corresponding to a payment received","summary":"RTP requests sent which are pending to be acknowledged by payee as payment received","tags":[],"parameters":[{"name":"requestId","in":"path","type":"string","required":true,"description":""},{"name":"customerId","in":"query","type":"string","required":false,"description":"Identifier of the customer"},{"name":"scheme","in":"query","type":"string","required":false,"description":"Represents the scheme (a synonym for the National ID type) under which the National ID is defined"},{"name":"currentState","in":"query","type":"string","required":false,"description":"Contains the current state of the transaction"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"ApiPendingAckResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/order/paymentRequests/{requestId}/billers/pendingExtensions","fullPath":"/api/v1.7.0/order/paymentRequests/{requestId}/billers/pendingExtensions","operationId":"getRequestorsDateExtension","name":"Retrieves the RTP requests with payee which are awaiting response for RTP expiry date extension. These requests can either be declined or approved by the payee","summary":"Payee's RTP requests awaiting RTP expiry date extension approval","tags":[],"parameters":[{"name":"requestId","in":"path","type":"string","required":true,"description":""},{"name":"customerId","in":"query","type":"string","required":false,"description":"Identifier of the customer"},{"name":"scheme","in":"query","type":"string","required":false,"description":"Represents the scheme (a synonym for the National ID type) under which the National ID is defined"},{"name":"requestorReference","in":"query","type":"string","required":false,"description":"Contains the reference of the requestor"},{"name":"currentState","in":"query","type":"string","required":false,"description":"Contains the current state of the transaction"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"RequestorsDateExtensionResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/order/paymentRequests/{requestId}/errors","fullPath":"/api/v1.7.0/order/paymentRequests/{requestId}/errors","operationId":"getOutwardErrors","name":"Retrieves the RTP requests which are in error status due to technical reasons. Such requests must be checked for the reason for error manually and a new RTP request must be created/initiated by payee to send the request again to payer","summary":"Retrieve the RTP requests in error status","tags":[],"parameters":[{"name":"requestId","in":"path","type":"string","required":true,"description":""},{"name":"customerId","in":"query","type":"string","required":false,"description":"Identifier of the customer"},{"name":"scheme","in":"query","type":"string","required":false,"description":"Represents the scheme (a synonym for the National ID type) under which the National ID is defined"},{"name":"currentState","in":"query","type":"string","required":false,"description":"Contains the current state of the transaction"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"OutwardErrorsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"POST","path":"/order/paymentRequests/ukPayments/billerRequests","fullPath":"/api/v1.7.0/order/paymentRequests/ukPayments/billerRequests","operationId":"createPayUKPaymentRequests","name":"Creates an RTP request at the Repository Service Provider(RSP). The API is for RSP-RSP communication for biller RSP to place RTP request with payer RSP. This is a provider API which can be linked to any published API in accordance to requesttopay.co.uk standards.","summary":"UK RTP scheme request initiation (RSP - RSP)","tags":[],"parameters":[{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"portalInfo":[{}],"errorInfo":[{}],"chargeDetails":[{}],"paymentStatus":[{}],"acceptanceDateTime":[{}],"additionalInfo":[{}],"messageToPayer":[{}],"messageToRequestor":[{}],"paymentReferenceDetails":[{}],"endToEndReference":"string","paymentMethod":"string","requestorBankBic":"string","requestorBankSortCode":"string","requestorAccountIBAN":"string","requestorAccountNumber":"string"}},"responses":{"200":"PayUKPaymentRequestsResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/order/paymentRequests/{requestId}/ukPayments","fullPath":"/api/v1.7.0/order/paymentRequests/{requestId}/ukPayments","operationId":"amendPayUKPaymentForRepository","name":"API to exchange RTP messages between biller RSP and payer RSP. The API can be used for exchanging various follow up messages for an RTP request(subsequent to RTP initiation) such as acceptance of the request in full or partial, denial of a request, exchange of notes, expiry date extension management, payment acknowledgements. This is a provider API which can be linked to any published API in accordance to requesttopay.co.uk standards.","summary":"UK RTP scheme message exchanges between biller and payer (RSP - RSP)","tags":[],"parameters":[{"name":"requestId","in":"path","type":"string","required":true,"description":""},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"portalInfo":[{}],"errorInfo":[{}],"chargeDetails":[{}],"paymentStatus":[{}],"acceptanceDateTime":[{}],"additionalInfo":[{}],"messageToPayer":[{}],"messageToRequestor":[{}],"paymentReferenceDetails":[{}],"endToEndReference":"string","paymentMethod":"string","requestorBankBic":"string","requestorBankSortCode":"string","requestorAccountIBAN":"string","requestorAccountNumber":"string"}},"responses":{"200":"PayUKPaymentForRepositoryResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/order/paymentRequests/accessTokenRefreshes/{proxyIdentifiers}","fullPath":"/api/v1.7.0/order/paymentRequests/accessTokenRefreshes/{proxyIdentifiers}","operationId":"updatePaymentRequestAccessToken","name":"Update accessToken and scheme for a specific proxy identifier which in turn triggers the refresh and updation of Request To Pay(RTP) data store","summary":"Refresh and update the Request To Pay(RTP) data store","tags":[],"parameters":[{"name":"proxyIdentifiers","in":"path","type":"string","required":true,"description":"Indicates an information that is unique to a customer, such as mobile number, email id etc"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"token":"string","scheme":"string","extensions":{}}},"responses":{"200":"PaymentRequestAccessTokenResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/order/paymentRequests/mandates","fullPath":"/api/v1.7.0/order/paymentRequests/mandates","operationId":"getAllMandateRequest","name":"View list of all Mandates","summary":"View list of all Mandates","tags":[],"parameters":[{"name":"currentState","in":"query","type":"string","required":false,"description":"Contains the current state of the transaction"},{"name":"customerId","in":"query","type":"string","required":false,"description":"Identifier of the customer"},{"name":"requestToPayScheme","in":"query","type":"string","required":false,"description":"Indicates the scheme in which request to pay message is sent or received"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"AllMandateRequestResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"POST","path":"/order/paymentRequests/mandates","fullPath":"/api/v1.7.0/order/paymentRequests/mandates","operationId":"createMandateRequest","name":"Initiation process to establish mandate between requestor and payer","summary":"Initiation process to establish mandate between requestor and payer","tags":[],"parameters":[{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"endToEndReference":"string","additionalInformationToPayer":"string","requestorName":"string","requestorProxy":"string","requestorAccountNumber":"string","requestorAccountIBAN":"string","payerName":"string","payerProxy":"string","payerAccountNumber":"string","payerAccountIBAN":"string","requestToPayScheme":"string","customerId":"string","currentState":"string","startDate":"string","endDate":"string"}},"responses":{"200":"MandateRequestResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/order/paymentRequests/mandates/{mandateId}","fullPath":"/api/v1.7.0/order/paymentRequests/mandates/{mandateId}","operationId":"updateMandateRequest","name":"Update mandate request status and notes on payer and requestor systems","summary":"Update mandate request status","tags":[],"parameters":[{"name":"mandateId","in":"path","type":"string","required":true,"description":"Contains the mandatory SEPA(Single Euro Payment Area) payment identifier from the transaction"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"messageToPayer":[{}],"messageToRequestor":[{}],"payerResponse":"string","endToEndReference":"string","extensions":{}}},"responses":{"200":"MandateRequestResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"POST","path":"/order/paymentRequests/ukPayments/mandates","fullPath":"/api/v1.7.0/order/paymentRequests/ukPayments/mandates","operationId":"createUkMandateRequest","name":"Initiation process to establish mandate between requestor and payer","summary":"Initiation process to establish mandate between requestor and payer","tags":[],"parameters":[{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"messageToPayer":[{}],"messageToRequestor":[{}],"endToEndReference":"string","requestMessage":"string","role":"string","requestorName":"string","requestorProxy":"string","requestorAccountNumber":"string","requestorAccountIBAN":"string","payerName":"string","payerProxy":"string","payerAccountNumber":"string","payerAccountIBAN":"string","requestToPayScheme":"string","customerId":"string"}},"responses":{"200":"UkMandateRequestResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/order/paymentRequests/ukPayments/mandates/{mandateId}","fullPath":"/api/v1.7.0/order/paymentRequests/ukPayments/mandates/{mandateId}","operationId":"amendUkMandateRequest","name":"Update mandate request status and notes on payer and requestor systems","summary":"Update mandate request status","tags":[],"parameters":[{"name":"mandateId","in":"path","type":"string","required":true,"description":"Contains the mandatory SEPA(Single Euro Payment Area) payment identifier from the transaction"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"messageToPayer":[{}],"messageToRequestor":[{}],"endToEndReference":"string","requestMessage":"string","role":"string","requestorName":"string","requestorProxy":"string","requestorAccountNumber":"string","requestorAccountIBAN":"string","payerName":"string","payerProxy":"string","payerAccountNumber":"string","payerAccountIBAN":"string","requestToPayScheme":"string","customerId":"string"}},"responses":{"200":"UkMandateRequestResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/order/paymentRequests/schemes","fullPath":"/api/v1.7.0/order/paymentRequests/schemes","operationId":"getSchemeDetails","name":"Retrieves the configured details for the Request to pay (RTP) scheme such as connectivity model, response type and validations","summary":"Retrieve Request to pay (RTP) scheme details","tags":[],"parameters":[{"name":"scheme","in":"query","type":"string","required":false,"description":"Represents the scheme (a synonym for the National ID type) under which the National ID is defined"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"SchemeDetailsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"PUT","path":"/order/paymentRequests/{requestId}/recalls","fullPath":"/api/v1.7.0/order/paymentRequests/{requestId}/recalls","operationId":"updateRTPRecall","name":"The user can initiate a recall of an already initiated RTP. RTP request can be recalled for various reason such as duplication request, fraudulent request etc.","summary":"Recall RTP request","tags":[],"parameters":[{"name":"requestId","in":"path","type":"string","required":true,"description":""},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"recallId":"Recall ID","requestToPayScheme":"RTP Scheme","requestorResponse":"Requestor response","cancelReason":"Cancel Reason Code","extensions":{}}},"responses":{"200":"RTPRecallResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/order/paymentRequests/schemes/returnCodes","fullPath":"/api/v1.7.0/order/paymentRequests/schemes/returnCodes","operationId":"getSchemeReturnCodes","name":"Retrieves the list of return codes configured for a particular clearing scheme. The return codes will be used in processing Request to pay (RTP) rejects and  recall processing.","summary":"Retrieve Request to pay (RTP) scheme return code details","tags":[],"parameters":[{"name":"requestToPayScheme","in":"query","type":"string","required":false,"description":"Indicates the scheme in which request to pay message is sent or received"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"SchemeReturnCodesResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/order/paymentRequests/{requestId}/payers","fullPath":"/api/v1.7.0/order/paymentRequests/{requestId}/payers","operationId":"getPayersList","name":"Retrieves the list of RTP requests which are received by the payer. The API retrieves RTPs in various states - Completed, Partially paid, Extension Granted, Declined, Extension Declined and Asked For Extension. This API is only to be used for payer side.","summary":"Retrieve RTP requests (payer side)","tags":[],"parameters":[{"name":"requestId","in":"path","type":"string","required":true,"description":""},{"name":"customerId","in":"query","type":"string","required":false,"description":"Identifier of the customer"},{"name":"scheme","in":"query","type":"string","required":false,"description":"Represents the scheme (a synonym for the National ID type) under which the National ID is defined"},{"name":"requestorReference","in":"query","type":"string","required":false,"description":"Contains the reference of the requestor"},{"name":"currentState","in":"query","type":"string","required":false,"description":"Contains the current state of the transaction"},{"name":"endToEndReference","in":"query","type":"string","required":false,"description":"Indicates the end to end reference for the payment. This field can be provided by the person who instructs the payment and this flows through the lifecycle of the payment."},{"name":"payerProxy","in":"query","type":"string","required":false,"description":"Contains the proxy identification of the payer"},{"name":"orderReference","in":"query","type":"string","required":false,"description":"The  order reference number."},{"name":"messageId","in":"query","type":"string","required":false,"description":"The holds the record key of the message ID."},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"PayersListResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/order/paymentRequests/payers/status","fullPath":"/api/v1.7.0/order/paymentRequests/payers/status","operationId":"getPayersStatus","name":"Retrieves the list of RTP requests of payer that are pending (that requires action from payer), completed and asked for extension","summary":"Retrieve the list of RTP requests of payer","tags":[],"parameters":[{"name":"currentState","in":"query","type":"string","required":true,"description":"Contains the current state of the transaction"},{"name":"customerId","in":"query","type":"string","required":false,"description":"Identifier of the customer"},{"name":"scheme","in":"query","type":"string","required":false,"description":"Represents the scheme (a synonym for the National ID type) under which the National ID is defined"},{"name":"messageId","in":"query","type":"string","required":false,"description":"The holds the record key of the message ID."},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"PayersStatusResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/order/paymentRequests/{requestId}/billers","fullPath":"/api/v1.7.0/order/paymentRequests/{requestId}/billers","operationId":"getRequestorsOutwardRequest","name":"Retrieves the list of requests sent by the payee. Details returned are payer name, amount, status, expiry date, outstanding amount to pay and the notes exchanged so far with payer.","summary":"Retrieve RTP requests (payee side)","tags":[],"parameters":[{"name":"requestId","in":"path","type":"string","required":true,"description":""},{"name":"currentState","in":"query","type":"string","required":false,"description":"Contains the current state of the transaction"},{"name":"customerId","in":"query","type":"string","required":false,"description":"Identifier of the customer"},{"name":"scheme","in":"query","type":"string","required":false,"description":"Represents the scheme (a synonym for the National ID type) under which the National ID is defined"},{"name":"endToEndReference","in":"query","type":"string","required":false,"description":"Indicates the end to end reference for the payment. This field can be provided by the person who instructs the payment and this flows through the lifecycle of the payment."},{"name":"messageId","in":"query","type":"string","required":false,"description":"The holds the record key of the message ID."},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"RequestorsOutwardRequestResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/order/paymentRequests/sentFiles","fullPath":"/api/v1.7.0/order/paymentRequests/sentFiles","operationId":"getSentFileDetails","name":"Retrieves the list of files related to payment requests sent by the bank","summary":"Retrieve Request to pay (RTP) sent file list","tags":[],"parameters":[{"name":"fileName","in":"query","type":"string","required":false,"description":"Identifies the type of methods to be listed. Possible values are FX.DEAL.METHOD, BROKER or blank."},{"name":"systemFileName","in":"query","type":"string","required":false,"description":"Contains the system generated name for the uploaded file"},{"name":"status","in":"query","type":"string","required":false,"description":"The status of the early maturity request"},{"name":"originalFileReference","in":"query","type":"string","required":false,"description":"Indicates reference of the incoming file for which response is being sent"},{"name":"dateSent","in":"query","type":"string","required":false,"description":"The date when the message is sent."},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"SentFileDetailsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/order/paymentRequests/status","fullPath":"/api/v1.7.0/order/paymentRequests/status","operationId":"getFileSummary","name":"Retrieves status summary of payment requests which were received by the bank as a part of file","summary":"Retrieves status summary of payment requests\u00c2\u00a0","tags":[],"parameters":[{"name":"receivedFileId","in":"query","type":"string","required":false,"description":"Indicates id of received file details records"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"FileSummaryResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/order/paymentRequests/receivedFiles","fullPath":"/api/v1.7.0/order/paymentRequests/receivedFiles","operationId":"getReceivedFileDetails","name":"Retrieves the list of files received by the bank for payment requests","summary":"Retrieve Request to pay (RTP) received file list","tags":[],"parameters":[{"name":"fileName","in":"query","type":"string","required":false,"description":"Identifies the type of methods to be listed. Possible values are FX.DEAL.METHOD, BROKER or blank."},{"name":"systemFileName","in":"query","type":"string","required":false,"description":"Contains the system generated name for the uploaded file"},{"name":"messageId","in":"query","type":"string","required":false,"description":"The holds the record key of the message ID."},{"name":"sourceType","in":"query","type":"string","required":false,"description":"Indicates source type to determine base amount. Possible values are BALANCE (base amount of a property), ACTIVITY ( transaction amount against an activity) or PROPERTY (this type is currently not supp"},{"name":"statusCode","in":"query","type":"string","required":false,"description":"Status code, as defined by the institution"},{"name":"userSignOnName","in":"query","type":"string","required":false,"description":"This is the name entered by the User to sign on to the System. It is used by the System as an alternative key to access User details"},{"name":"uploadType","in":"query","type":"string","required":false,"description":"Indicates if the record is created or maintained through an upload or manually. It can contain the following values: Upload \u00e2\u20ac\u201c The record is created through upload. Custom \u00e2\u20ac\u201c The record is created m"},{"name":"countOfRecords","in":"query","type":"string","required":false,"description":"Total count of records information for NOFILE (an enquiry does not exist in a single file) enquiry for online upgrade"},{"name":"customerName","in":"query","type":"string","required":false,"description":"Name of the customer"},{"name":"receivedDateTime","in":"query","type":"string","required":false,"description":"Indicates the date and time when the request to pay message is received for payer and requestor"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"ReceivedFileDetailsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}}]},{"key":"RequestToPayPayments-v1.8.0","title":"Request to Pay","version":"v1.8.0","description":"Request To Pay (RTP) is a Temenos Payments application that helps Temenos bank manage their request to pay functionality. It provides RTP functionality and information exchange between the actor (payer or payee) and the RTP clearing. This page lists the APIs offered by Temenos RTP Application to con","endpointCount":34,"endpoints":[{"method":"PUT","path":"/order/paymentRequests/{requestId}/payments","fullPath":"/api/v1.8.0/order/paymentRequests/{requestId}/payments","operationId":"updateFullPayment","name":"Enables the payer to accept RTP Request and pay the outstanding amount","summary":"Accept the RTP request with full amount","tags":[],"parameters":[{"name":"requestId","in":"path","type":"string","required":true,"description":"The guarantees issuance id initiated by internet banking"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"additionalInfo":[{}],"debitAccount":"string","paymentReference":"string","amountModifiedByPayer":"string","payerAccountIBAN":"string","paymentDate":"string","token":"string","paymentTime":"string","paymentOrderProduct":"string","extensions":{}}},"responses":{"200":"FullPaymentResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/order/paymentRequests/{requestId}/partialPayments","fullPath":"/api/v1.8.0/order/paymentRequests/{requestId}/partialPayments","operationId":"updatePartialPayment","name":"Enables the payer to accept RTP request and pay partial amount. The original request sent by the biller remains open until the total amount is paid by the payer","summary":"Accept the RTP request and pay partially","tags":[],"parameters":[{"name":"requestId","in":"path","type":"string","required":true,"description":"The guarantees issuance id initiated by internet banking"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"additionalInfo":[{}],"debitAmount":"string","debitAccount":"string","paymentReference":"string","payerResponse":"string","amountModifiedByPayer":"string","payerAccountIBAN":"string","paymentDate":"string","token":"string","instructedAmount":"string","paymentTime":"string","paymentOrderProduct":"string","extensions":{}}},"responses":{"200":"PartialPaymentResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/order/paymentRequests/{requestId}/declinedRequests","fullPath":"/api/v1.8.0/order/paymentRequests/{requestId}/declinedRequests","operationId":"updateDeclinePayment","name":"Enables the payer to decline RTP request when payer does not wish to make any payment towards that request","summary":"Decline a RTP request from payee","tags":[],"parameters":[{"name":"requestId","in":"path","type":"string","required":true,"description":"The guarantees issuance id initiated by internet banking"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"additionalInfoToRequestor":[{}],"payerResponse":"string","token":"string","rejectReasonCode":"string","extensions":{}}},"responses":{"200":"DeclinePaymentResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/order/paymentRequests/{requestId}/billerNotes","fullPath":"/api/v1.8.0/order/paymentRequests/{requestId}/billerNotes","operationId":"updateNotesToRequestor","name":"Enables the payer to send messages to payee when the payer requires further information regarding a specific RTP request","summary":"Send notes/additional information to payee","tags":[],"parameters":[{"name":"requestId","in":"path","type":"string","required":true,"description":"The guarantees issuance id initiated by internet banking"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"notesToRequestor":[{}],"payerResponse":"string","token":"string","extensions":{}}},"responses":{"200":"NotesToRequestorResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/order/paymentRequests/{requestId}/amountModifications","fullPath":"/api/v1.8.0/order/paymentRequests/{requestId}/amountModifications","operationId":"updatePaymentAmount","name":"Enables the payer to modify the amount requested by payee in the original RTP request, if modification is allowed by the payee and the corresponding RTP scheme","summary":"Modify the requested amount in the RTP request","tags":[],"parameters":[{"name":"requestId","in":"path","type":"string","required":true,"description":"The guarantees issuance id initiated by internet banking"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"debitAccount":"string","payerAccountIBAN":"string","amountModifiedByPayer":"string","debitAmount":"string","paymentDate":"string","paymentTime":"string","paymentOrderProduct":"string","extensions":{}}},"responses":{"200":"PaymentAmountResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/order/paymentRequests/{requestId}/blocks","fullPath":"/api/v1.8.0/order/paymentRequests/{requestId}/blocks","operationId":"updateDeclineAndBlock","name":"Enables the payer to decline the payee's RTP request and block the payee when payer does not want to receive any further RTP requests in future from the specific payee","summary":"Decline the RTP request and block the payee","tags":[],"parameters":[{"name":"requestId","in":"path","type":"string","required":true,"description":"The guarantees issuance id initiated by internet banking"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"additionalInfoToRequestor":[{}],"payerResponse":"string","token":"string","rejectReasonCode":"string","extensions":{}}},"responses":{"200":"DeclineAndBlockResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/order/paymentRequests/{requestId}/payerNotes","fullPath":"/api/v1.8.0/order/paymentRequests/{requestId}/payerNotes","operationId":"updateNotesToPayer","name":"Enables the payee to send notes, additional information to payer when the payee requires further information regarding a specific RTP request","summary":"Send notes / additional information to payer","tags":[],"parameters":[{"name":"requestId","in":"path","type":"string","required":true,"description":"The guarantees issuance id initiated by internet banking"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"notesToPayer":[{}],"payerName":"string","creditAccountId":"string","requestorAccountIBAN":"string","requestorName":"string","requestedExecutionDate":"string","endToEndReference":"string","remittanceInformation":"string","extensions":{}}},"responses":{"200":"NotesToPayerResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/order/paymentRequests/{requestId}/extensions","fullPath":"/api/v1.8.0/order/paymentRequests/{requestId}/extensions","operationId":"updateDateExtension","name":"Enables the payer to request the payee for a new expiry date for the RTP request received","summary":"Request extension of the RTP expiry date","tags":[],"parameters":[{"name":"requestId","in":"path","type":"string","required":true,"description":"The guarantees issuance id initiated by internet banking"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"additionalInfo":[{}],"requestedExpiryDate":"string","payerResponse":"string","token":"string","extensions":{}}},"responses":{"200":"DateExtensionResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/order/paymentRequests/{requestId}/extensions/acceptances","fullPath":"/api/v1.8.0/order/paymentRequests/{requestId}/extensions/acceptances","operationId":"getPayerListWithExtensionGranted","name":"Retrieves the payer RTP requests for which the expiry date extensions have been granted by the payee","summary":"Retrieve RTP requests for which extension is granted","tags":[],"parameters":[{"name":"requestId","in":"path","type":"string","required":true,"description":""},{"name":"customerId","in":"query","type":"string","required":false,"description":"Identifier of the customer"},{"name":"scheme","in":"query","type":"string","required":false,"description":"Represents the scheme (a synonym for the National ID type) under which the National ID is defined"},{"name":"currentState","in":"query","type":"string","required":false,"description":"Contains the current state of the transaction"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"PayerListWithExtensionGrantedResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"PUT","path":"/order/paymentRequests/{requestId}/extensions/acceptances","fullPath":"/api/v1.8.0/order/paymentRequests/{requestId}/extensions/acceptances","operationId":"updateGrantExtension","name":"Enables the payee to approve the expiry date for the RTP request sought by the payer","summary":"Approve the expiry date extension requested by the payer","tags":[],"parameters":[{"name":"requestId","in":"path","type":"string","required":true,"description":"The guarantees issuance id initiated by internet banking"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"additionalInfo":[{}],"extensions":{}}},"responses":{"200":"GrantExtensionResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/order/paymentRequests/{requestId}/extensions/rejections","fullPath":"/api/v1.8.0/order/paymentRequests/{requestId}/extensions/rejections","operationId":"getPayersListWithExtensionDeclined","name":"Retrieves the payer RTP requests for which the expiry date extensions have been declined by the payee","summary":"Retrieve RTP requests for which the extension is declined","tags":[],"parameters":[{"name":"requestId","in":"path","type":"string","required":true,"description":""},{"name":"customerId","in":"query","type":"string","required":false,"description":"Identifier of the customer"},{"name":"scheme","in":"query","type":"string","required":false,"description":"Represents the scheme (a synonym for the National ID type) under which the National ID is defined"},{"name":"currentState","in":"query","type":"string","required":false,"description":"Contains the current state of the transaction"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"PayersListWithExtensionDeclinedResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"PUT","path":"/order/paymentRequests/{requestId}/extensions/rejections","fullPath":"/api/v1.8.0/order/paymentRequests/{requestId}/extensions/rejections","operationId":"updateDeclineExtension","name":"Enables the payee to decline the expiry date for the RTP request sought by the payer","summary":"Decline the expiry date extension requested by payer","tags":[],"parameters":[{"name":"requestId","in":"path","type":"string","required":true,"description":"The guarantees issuance id initiated by internet banking"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"additionalInfo":[{}],"requestorResponse":"string","extensions":{}}},"responses":{"200":"DeclineExtensionResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/order/paymentRequests/{requestId}/billers/acknowledgements","fullPath":"/api/v1.8.0/order/paymentRequests/{requestId}/billers/acknowledgements","operationId":"updateBillerAcknowledgements","name":"Enables the payee to send full acknowledgement to payer when payer has paid full amount and to send partial acknowledgement to payer when payer has paid partial amount","summary":"Acknowledge RTP requests waiting for payment confirmation by payee","tags":[],"parameters":[{"name":"requestId","in":"path","type":"string","required":true,"description":"The guarantees issuance id initiated by internet banking"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"requestorResponse":"string","extensions":{}}},"responses":{"200":"BillerAcknowledgementsResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/order/paymentRequests/{requestId}/billers/pendingAcknowledgements","fullPath":"/api/v1.8.0/order/paymentRequests/{requestId}/billers/pendingAcknowledgements","operationId":"getApiPendingAck","name":"Retrieves the RTP requests which are yet to be acknowledged by the payee for a payment that has come in due to a result of RTP request being accepted by payer. Generally, 'Partially paid' or 'Paid' are the two statuses in which payee can send an acknowledgement message corresponding to a payment received","summary":"RTP requests sent which are pending to be acknowledged by payee as payment received","tags":[],"parameters":[{"name":"requestId","in":"path","type":"string","required":true,"description":""},{"name":"customerId","in":"query","type":"string","required":false,"description":"Identifier of the customer"},{"name":"scheme","in":"query","type":"string","required":false,"description":"Represents the scheme (a synonym for the National ID type) under which the National ID is defined"},{"name":"currentState","in":"query","type":"string","required":false,"description":"Contains the current state of the transaction"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"ApiPendingAckResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/order/paymentRequests/{requestId}/billers/pendingExtensions","fullPath":"/api/v1.8.0/order/paymentRequests/{requestId}/billers/pendingExtensions","operationId":"getRequestorsDateExtension","name":"Retrieves the RTP requests with payee which are awaiting response for RTP expiry date extension. These requests can either be declined or approved by the payee","summary":"Payee's RTP requests awaiting RTP expiry date extension approval","tags":[],"parameters":[{"name":"requestId","in":"path","type":"string","required":true,"description":""},{"name":"customerId","in":"query","type":"string","required":false,"description":"Identifier of the customer"},{"name":"scheme","in":"query","type":"string","required":false,"description":"Represents the scheme (a synonym for the National ID type) under which the National ID is defined"},{"name":"requestorReference","in":"query","type":"string","required":false,"description":"Contains the reference of the requestor"},{"name":"currentState","in":"query","type":"string","required":false,"description":"Contains the current state of the transaction"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"RequestorsDateExtensionResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/order/paymentRequests/{requestId}/errors","fullPath":"/api/v1.8.0/order/paymentRequests/{requestId}/errors","operationId":"getOutwardErrors","name":"Retrieves the RTP requests which are in error status due to technical reasons. Such requests must be checked for the reason for error manually and a new RTP request must be created/initiated by payee to send the request again to payer","summary":"Retrieve the RTP requests in error status","tags":[],"parameters":[{"name":"requestId","in":"path","type":"string","required":true,"description":""},{"name":"customerId","in":"query","type":"string","required":false,"description":"Identifier of the customer"},{"name":"scheme","in":"query","type":"string","required":false,"description":"Represents the scheme (a synonym for the National ID type) under which the National ID is defined"},{"name":"currentState","in":"query","type":"string","required":false,"description":"Contains the current state of the transaction"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"OutwardErrorsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"PUT","path":"/order/paymentRequests/accessTokenRefreshes/{proxyIdentifiers}","fullPath":"/api/v1.8.0/order/paymentRequests/accessTokenRefreshes/{proxyIdentifiers}","operationId":"updatePaymentRequestAccessToken","name":"Update access token and scheme for a specific proxy identifier which in turn triggers the refresh and updation of Request To Pay(RTP) data store","summary":"Refresh and update the Request To Pay(RTP) data store","tags":[],"parameters":[{"name":"proxyIdentifiers","in":"path","type":"string","required":true,"description":"Indicates an information that is unique to a customer, such as mobile number, email id etc"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"token":"string","scheme":"string","extensions":{}}},"responses":{"200":"PaymentRequestAccessTokenResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/order/paymentRequests/mandates","fullPath":"/api/v1.8.0/order/paymentRequests/mandates","operationId":"getAllMandateRequest","name":"View list of all mandates","summary":"View list of all mandates","tags":[],"parameters":[{"name":"currentState","in":"query","type":"string","required":false,"description":"Contains the current state of the transaction"},{"name":"customerId","in":"query","type":"string","required":false,"description":"Identifier of the customer"},{"name":"requestToPayScheme","in":"query","type":"string","required":false,"description":"Indicates the scheme in which request to pay message is sent or received"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"AllMandateRequestResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"POST","path":"/order/paymentRequests/mandates","fullPath":"/api/v1.8.0/order/paymentRequests/mandates","operationId":"createMandateRequest","name":"Initiation process to establish mandate between requestor and payer","summary":"Initiation process to establish mandate between requestor and payer","tags":[],"parameters":[{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"endToEndReference":"string","additionalInformationToPayer":"string","requestorName":"string","requestorProxy":"string","requestorAccountNumber":"string","requestorAccountIBAN":"string","payerName":"string","payerProxy":"string","payerAccountNumber":"string","payerAccountIBAN":"string","requestToPayScheme":"string","customerId":"string","currentState":"string","startDate":"string","endDate":"string"}},"responses":{"200":"MandateRequestResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/order/paymentRequests/mandates/{mandateId}","fullPath":"/api/v1.8.0/order/paymentRequests/mandates/{mandateId}","operationId":"updateMandateRequest","name":"Update mandate request status and notes on payer and requestor systems","summary":"Update mandate request status","tags":[],"parameters":[{"name":"mandateId","in":"path","type":"string","required":true,"description":"Contains the mandatory SEPA(Single Euro Payment Area) payment identifier from the transaction"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"messageToPayer":[{}],"messageToRequestor":[{}],"payerResponse":"string","endToEndReference":"string","extensions":{}}},"responses":{"200":"MandateRequestResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"POST","path":"/order/paymentRequests/ukPayments/mandates","fullPath":"/api/v1.8.0/order/paymentRequests/ukPayments/mandates","operationId":"createUkMandateRequest","name":"Initiation process to establish mandate between requestor and payer","summary":"Initiation process to establish mandate between requestor and payer","tags":[],"parameters":[{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"messageToPayer":[{}],"messageToRequestor":[{}],"endToEndReference":"string","requestMessage":"string","role":"string","requestorName":"string","requestorProxy":"string","requestorAccountNumber":"string","requestorAccountIBAN":"string","payerName":"string","payerProxy":"string","payerAccountNumber":"string","payerAccountIBAN":"string","requestToPayScheme":"string","customerId":"string"}},"responses":{"200":"UkMandateRequestResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/order/paymentRequests/ukPayments/mandates/{mandateId}","fullPath":"/api/v1.8.0/order/paymentRequests/ukPayments/mandates/{mandateId}","operationId":"amendUkMandateRequest","name":"Update mandate request status and notes on payer and requestor systems","summary":"Update mandate request status","tags":[],"parameters":[{"name":"mandateId","in":"path","type":"string","required":true,"description":"Contains the mandatory SEPA(Single Euro Payment Area) payment identifier from the transaction"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"messageToPayer":[{}],"messageToRequestor":[{}],"endToEndReference":"string","requestMessage":"string","role":"string","requestorName":"string","requestorProxy":"string","requestorAccountNumber":"string","requestorAccountIBAN":"string","payerName":"string","payerProxy":"string","payerAccountNumber":"string","payerAccountIBAN":"string","requestToPayScheme":"string","customerId":"string"}},"responses":{"200":"UkMandateRequestResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/order/paymentRequests/schemes","fullPath":"/api/v1.8.0/order/paymentRequests/schemes","operationId":"getSchemeDetails","name":"Retrieves the configured details for the Request to pay (RTP) scheme such as connectivity model, response type and validations","summary":"Retrieve Request to pay (RTP) scheme details","tags":[],"parameters":[{"name":"scheme","in":"query","type":"string","required":false,"description":"Represents the scheme (a synonym for the National ID type) under which the National ID is defined"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"SchemeDetailsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"PUT","path":"/order/paymentRequests/{requestId}/recalls","fullPath":"/api/v1.8.0/order/paymentRequests/{requestId}/recalls","operationId":"updateRTPRecall","name":"The user can initiate a recall of an already initiated RTP. RTP request can be recalled for various reason such as duplication request, fraudulent request etc.","summary":"Recall RTP request","tags":[],"parameters":[{"name":"requestId","in":"path","type":"string","required":true,"description":""},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"recallId":"Recall ID","requestToPayScheme":"RTP Scheme","requestorResponse":"Requestor response","cancelReason":"Cancel Reason Code","extensions":{}}},"responses":{"200":"RTPRecallResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/order/paymentRequests/schemes/returnCodes","fullPath":"/api/v1.8.0/order/paymentRequests/schemes/returnCodes","operationId":"getSchemeReturnCodes","name":"Retrieves the list of return codes configured for a particular clearing scheme. The return codes will be used in processing Request to pay (RTP) rejects and  recall processing.","summary":"Retrieve Request to pay (RTP) scheme return code details","tags":[],"parameters":[{"name":"requestToPayScheme","in":"query","type":"string","required":false,"description":"Indicates the scheme in which request to pay message is sent or received"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"SchemeReturnCodesResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/order/paymentRequests/sentFiles","fullPath":"/api/v1.8.0/order/paymentRequests/sentFiles","operationId":"getSentFileDetails","name":"Retrieves the list of files related to payment requests sent by the bank","summary":"Retrieve Request to pay (RTP) sent file list","tags":[],"parameters":[{"name":"fileName","in":"query","type":"string","required":false,"description":"Identifies the type of methods to be listed. Possible values are FX.DEAL.METHOD, BROKER or blank."},{"name":"systemFileName","in":"query","type":"string","required":false,"description":"Contains the system generated name for the uploaded file"},{"name":"status","in":"query","type":"string","required":false,"description":"The status of the early maturity request"},{"name":"originalFileReference","in":"query","type":"string","required":false,"description":"Indicates reference of the incoming file for which response is being sent"},{"name":"dateSent","in":"query","type":"string","required":false,"description":"The date when the message is sent."},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"SentFileDetailsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/order/paymentRequests/status","fullPath":"/api/v1.8.0/order/paymentRequests/status","operationId":"getFileSummary","name":"Retrieves status summary of payment requests which were received by the bank as a part of file","summary":"Retrieves status summary of payment requests","tags":[],"parameters":[{"name":"receivedFileId","in":"query","type":"string","required":false,"description":"Indicates id of received file details records"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"FileSummaryResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/order/paymentRequests/receivedFiles","fullPath":"/api/v1.8.0/order/paymentRequests/receivedFiles","operationId":"getReceivedFileDetails","name":"Retrieves the list of files received by the bank for payment requests","summary":"Retrieve Request to pay (RTP) received file list","tags":[],"parameters":[{"name":"fileName","in":"query","type":"string","required":false,"description":"Identifies the type of methods to be listed. Possible values are FX.DEAL.METHOD, BROKER or blank."},{"name":"systemFileName","in":"query","type":"string","required":false,"description":"Contains the system generated name for the uploaded file"},{"name":"messageId","in":"query","type":"string","required":false,"description":"The holds the record key of the message ID."},{"name":"sourceType","in":"query","type":"string","required":false,"description":"Indicates source type to determine base amount. Possible values are BALANCE (base amount of a property), ACTIVITY ( transaction amount against an activity) or PROPERTY (this type is currently not supp"},{"name":"statusCode","in":"query","type":"string","required":false,"description":"Status code, as defined by the institution"},{"name":"userSignOnName","in":"query","type":"string","required":false,"description":"This is the name entered by the User to sign on to the System. It is used by the System as an alternative key to access User details"},{"name":"uploadType","in":"query","type":"string","required":false,"description":"Indicates if the record is created or maintained through an upload or manually. It can contain the following values: Upload \u00e2\u20ac\u201c The record is created through upload. Custom \u00e2\u20ac\u201c The record is created m"},{"name":"countOfRecords","in":"query","type":"string","required":false,"description":"Total count of records information for NOFILE (an enquiry does not exist in a single file) enquiry for online upgrade"},{"name":"customerName","in":"query","type":"string","required":false,"description":"Name of the customer"},{"name":"receivedDateTime","in":"query","type":"string","required":false,"description":"Indicates the date and time when the request to pay message is received for payer and requestor"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"ReceivedFileDetailsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"POST","path":"/order/paymentRequests","fullPath":"/api/v1.8.0/order/paymentRequests","operationId":"createPaymentRequests","name":"Create payment requests for EBA and UK scheme from biller application","summary":"Initiate a RTP request","tags":[],"parameters":[{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"chargeDetails":[{}],"portalInfo":[{}],"errorInfo":[{}],"paymentMethod":"string","requestedExecutionDate":"string","payerName":"string","payerStreetName":"string","payerBuildingNumber":"string","payerPostalCode":"string","payerTownName":"string","payerCountry":"string","payerDateOfBirth":"string","payerCityOfBirth":"string","payerCountryOfBirth":"string","debitAccount":"string"}},"responses":{"200":"PaymentRequestsResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"POST","path":"/order/paymentRequests/ukPayments/billerRequests","fullPath":"/api/v1.8.0/order/paymentRequests/ukPayments/billerRequests","operationId":"createPayUKPaymentRequests","name":"Creates an RTP request at the Repository Service Provider(RSP). The API is for RSP-RSP communication for biller RSP to place RTP request with payer RSP. This is a provider API which can be linked to any published API in accordance to requesttopay.co.uk standards.","summary":"UK RTP scheme request initiation (RSP - RSP)","tags":[],"parameters":[{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"portalInfo":[{}],"errorInfo":[{}],"chargeDetails":[{}],"paymentStatus":[{}],"acceptanceDateTime":[{}],"additionalInfo":[{}],"messageToPayer":[{}],"messageToRequestor":[{}],"paymentReferenceDetails":[{}],"endToEndReference":"string","paymentMethod":"string","requestorBankBic":"string","requestorBankSortCode":"string","requestorAccountIBAN":"string","requestorAccountNumber":"string"}},"responses":{"200":"PayUKPaymentRequestsResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/order/paymentRequests/{requestId}/ukPayments","fullPath":"/api/v1.8.0/order/paymentRequests/{requestId}/ukPayments","operationId":"amendPayUKPaymentForRepository","name":"API to exchange RTP messages between biller RSP and payer RSP. The API can be used for exchanging various follow up messages for an RTP request(subsequent to RTP initiation) such as acceptance of the request in full or partial, denial of a request, exchange of notes, expiry date extension management, payment acknowledgements. This is a provider API which can be linked to any published API in accordance to requesttopay.co.uk standards.","summary":"UK RTP scheme message exchanges between biller and payer (RSP - RSP)","tags":[],"parameters":[{"name":"requestId","in":"path","type":"string","required":true,"description":""},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"portalInfo":[{}],"errorInfo":[{}],"chargeDetails":[{}],"paymentStatus":[{}],"acceptanceDateTime":[{}],"additionalInfo":[{}],"messageToPayer":[{}],"messageToRequestor":[{}],"paymentReferenceDetails":[{}],"endToEndReference":"string","paymentMethod":"string","requestorBankBic":"string","requestorBankSortCode":"string","requestorAccountIBAN":"string","requestorAccountNumber":"string"}},"responses":{"200":"PayUKPaymentForRepositoryResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/order/paymentRequests/{requestId}/billers","fullPath":"/api/v1.8.0/order/paymentRequests/{requestId}/billers","operationId":"getRequestorsOutwardRequest","name":"Retrieves the list of requests sent by the payee with details like payer name, amount, status, expiry date, outstanding amount to pay and the notes exchanged so far with payer.","summary":"Retrieve RTP requests (payee side)","tags":[],"parameters":[{"name":"requestId","in":"path","type":"string","required":true,"description":""},{"name":"currentState","in":"query","type":"string","required":false,"description":"Contains the current state of the transaction"},{"name":"customerId","in":"query","type":"string","required":false,"description":"Identifier of the customer"},{"name":"scheme","in":"query","type":"string","required":false,"description":"Represents the scheme (a synonym for the National ID type) under which the National ID is defined"},{"name":"endToEndReference","in":"query","type":"string","required":false,"description":"Indicates the end to end reference for the payment. This field can be provided by the person who instructs the payment and this flows through the lifecycle of the payment."},{"name":"messageId","in":"query","type":"string","required":false,"description":"The holds the record key of the message ID."},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"RequestorsOutwardRequestResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/order/paymentRequests/payers/status","fullPath":"/api/v1.8.0/order/paymentRequests/payers/status","operationId":"getPayersStatus","name":"Retrieves the list of RTP requests of payer that are pending (that requires action from payer), completed and asked for extension","summary":"Retrieve the list of RTP requests of payer","tags":[],"parameters":[{"name":"currentState","in":"query","type":"string","required":true,"description":"Contains the current state of the transaction"},{"name":"customerId","in":"query","type":"string","required":false,"description":"Identifier of the customer"},{"name":"scheme","in":"query","type":"string","required":false,"description":"Represents the scheme (a synonym for the National ID type) under which the National ID is defined"},{"name":"messageId","in":"query","type":"string","required":false,"description":"The holds the record key of the message ID."},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"PayersStatusResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/order/paymentRequests/{requestId}/payers","fullPath":"/api/v1.8.0/order/paymentRequests/{requestId}/payers","operationId":"getPayersList","name":"Retrieves the RTP requests that are received by the payer in various states like Completed, Partially paid, Extension Granted, Declined, Extension Declined, Asked For Extension and to be used for payer side.","summary":"Retrieve RTP requests (payer side)","tags":[],"parameters":[{"name":"requestId","in":"path","type":"string","required":true,"description":""},{"name":"customerId","in":"query","type":"string","required":false,"description":"Identifier of the customer"},{"name":"scheme","in":"query","type":"string","required":false,"description":"Represents the scheme (a synonym for the National ID type) under which the National ID is defined"},{"name":"requestorReference","in":"query","type":"string","required":false,"description":"Contains the reference of the requestor"},{"name":"currentState","in":"query","type":"string","required":false,"description":"Contains the current state of the transaction"},{"name":"endToEndReference","in":"query","type":"string","required":false,"description":"Indicates the end to end reference for the payment. This field can be provided by the person who instructs the payment and this flows through the lifecycle of the payment."},{"name":"payerProxy","in":"query","type":"string","required":false,"description":"Contains the proxy identification of the payer"},{"name":"orderReference","in":"query","type":"string","required":false,"description":"The  order reference number."},{"name":"messageId","in":"query","type":"string","required":false,"description":"The holds the record key of the message ID."},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"PayersListResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}}]},{"key":"RequestToPayPayments-v1.9.0","title":"Request to Pay","version":"v1.9.0","description":"Request To Pay (RTP) is a Temenos Payments application that helps Temenos bank manage their request to pay functionality. It provides RTP functionality and information exchange between the actor (payer or payee) and the RTP clearing. This page lists the APIs offered by Temenos RTP Application to con","endpointCount":34,"endpoints":[{"method":"PUT","path":"/order/paymentRequests/{requestId}/payments","fullPath":"/api/v1.9.0/order/paymentRequests/{requestId}/payments","operationId":"updateFullPayment","name":"Enables the payer to accept RTP Request and pay the outstanding amount","summary":"Accept the RTP request with full amount","tags":["OTHERS"],"parameters":[{"name":"requestId","in":"path","type":"string","required":true,"description":"The guarantees issuance id initiated by internet banking"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"additionalInfo":[{}],"debitAccount":"string","paymentReference":"string","amountModifiedByPayer":"string","payerAccountIBAN":"string","paymentDate":"string","token":"string","paymentTime":"string","paymentOrderProduct":"string","extensions":{}}},"responses":{"200":"FullPaymentResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/order/paymentRequests/{requestId}/partialPayments","fullPath":"/api/v1.9.0/order/paymentRequests/{requestId}/partialPayments","operationId":"updatePartialPayment","name":"Enables the payer to accept RTP request and pay partial amount. The original request sent by the biller remains open until the total amount is paid by the payer","summary":"Accept the RTP request and pay partially","tags":["OTHERS"],"parameters":[{"name":"requestId","in":"path","type":"string","required":true,"description":"The guarantees issuance id initiated by internet banking"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"additionalInfo":[{}],"debitAmount":"string","debitAccount":"string","paymentReference":"string","payerResponse":"string","amountModifiedByPayer":"string","payerAccountIBAN":"string","paymentDate":"string","token":"string","instructedAmount":"string","paymentTime":"string","paymentOrderProduct":"string","extensions":{}}},"responses":{"200":"PartialPaymentResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/order/paymentRequests/{requestId}/declinedRequests","fullPath":"/api/v1.9.0/order/paymentRequests/{requestId}/declinedRequests","operationId":"updateDeclinePayment","name":"Enables the payer to decline RTP request when payer does not wish to make any payment towards that request","summary":"Decline a RTP request from payee","tags":["OTHERS"],"parameters":[{"name":"requestId","in":"path","type":"string","required":true,"description":"The guarantees issuance id initiated by internet banking"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"additionalInfoToRequestor":[{}],"payerResponse":"string","token":"string","rejectReasonCode":"string","extensions":{}}},"responses":{"200":"DeclinePaymentResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/order/paymentRequests/{requestId}/billerNotes","fullPath":"/api/v1.9.0/order/paymentRequests/{requestId}/billerNotes","operationId":"updateNotesToRequestor","name":"Enables the payer to send messages to payee when the payer requires further information regarding a specific RTP request","summary":"Send notes/additional information to payee","tags":["OTHERS"],"parameters":[{"name":"requestId","in":"path","type":"string","required":true,"description":"The guarantees issuance id initiated by internet banking"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"notesToRequestor":[{}],"payerResponse":"string","token":"string","extensions":{}}},"responses":{"200":"NotesToRequestorResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/order/paymentRequests/{requestId}/amountModifications","fullPath":"/api/v1.9.0/order/paymentRequests/{requestId}/amountModifications","operationId":"updatePaymentAmount","name":"Enables the payer to modify the amount requested by payee in the original RTP request, if modification is allowed by the payee and the corresponding RTP scheme","summary":"Modify the requested amount in the RTP request","tags":["OTHERS"],"parameters":[{"name":"requestId","in":"path","type":"string","required":true,"description":"The guarantees issuance id initiated by internet banking"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"debitAccount":"string","payerAccountIBAN":"string","amountModifiedByPayer":"string","debitAmount":"string","paymentDate":"string","paymentTime":"string","paymentOrderProduct":"string","extensions":{}}},"responses":{"200":"PaymentAmountResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/order/paymentRequests/{requestId}/blocks","fullPath":"/api/v1.9.0/order/paymentRequests/{requestId}/blocks","operationId":"updateDeclineAndBlock","name":"Enables the payer to decline the payee's RTP request and block the payee when payer does not want to receive any further RTP requests in future from the specific payee","summary":"Decline the RTP request and block the payee","tags":["OTHERS"],"parameters":[{"name":"requestId","in":"path","type":"string","required":true,"description":"The guarantees issuance id initiated by internet banking"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"additionalInfoToRequestor":[{}],"payerResponse":"string","token":"string","rejectReasonCode":"string","extensions":{}}},"responses":{"200":"DeclineAndBlockResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/order/paymentRequests/{requestId}/payerNotes","fullPath":"/api/v1.9.0/order/paymentRequests/{requestId}/payerNotes","operationId":"updateNotesToPayer","name":"Enables the payee to send notes, additional information to payer when the payee requires further information regarding a specific RTP request","summary":"Send notes / additional information to payer","tags":["OTHERS"],"parameters":[{"name":"requestId","in":"path","type":"string","required":true,"description":"The guarantees issuance id initiated by internet banking"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"notesToPayer":[{}],"payerName":"string","creditAccountId":"string","requestorAccountIBAN":"string","requestorName":"string","requestedExecutionDate":"string","endToEndReference":"string","remittanceInformation":"string","extensions":{}}},"responses":{"200":"NotesToPayerResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/order/paymentRequests/{requestId}/extensions","fullPath":"/api/v1.9.0/order/paymentRequests/{requestId}/extensions","operationId":"updateDateExtension","name":"Enables the payer to request the payee for a new expiry date for the RTP request received","summary":"Request extension of the RTP expiry date","tags":["OTHERS"],"parameters":[{"name":"requestId","in":"path","type":"string","required":true,"description":"The guarantees issuance id initiated by internet banking"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"additionalInfo":[{}],"requestedExpiryDate":"string","payerResponse":"string","token":"string","extensions":{}}},"responses":{"200":"DateExtensionResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/order/paymentRequests/{requestId}/extensions/acceptances","fullPath":"/api/v1.9.0/order/paymentRequests/{requestId}/extensions/acceptances","operationId":"getPayerListWithExtensionGranted","name":"Retrieves the payer RTP requests for which the expiry date extensions have been granted by the payee","summary":"Retrieve RTP requests for which extension is granted","tags":["OTHERS"],"parameters":[{"name":"requestId","in":"path","type":"string","required":true,"description":""},{"name":"customerId","in":"query","type":"string","required":false,"description":"Identifier of the customer"},{"name":"scheme","in":"query","type":"string","required":false,"description":"Represents the scheme (a synonym for the National ID type) under which the National ID is defined"},{"name":"currentState","in":"query","type":"string","required":false,"description":"Contains the current state of the transaction"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"PayerListWithExtensionGrantedResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"PUT","path":"/order/paymentRequests/{requestId}/extensions/acceptances","fullPath":"/api/v1.9.0/order/paymentRequests/{requestId}/extensions/acceptances","operationId":"updateGrantExtension","name":"Enables the payee to approve the expiry date for the RTP request sought by the payer","summary":"Approve the expiry date extension requested by the payer","tags":["OTHERS"],"parameters":[{"name":"requestId","in":"path","type":"string","required":true,"description":"The guarantees issuance id initiated by internet banking"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"additionalInfo":[{}],"extensions":{}}},"responses":{"200":"GrantExtensionResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/order/paymentRequests/{requestId}/extensions/rejections","fullPath":"/api/v1.9.0/order/paymentRequests/{requestId}/extensions/rejections","operationId":"getPayersListWithExtensionDeclined","name":"Retrieves the payer RTP requests for which the expiry date extensions have been declined by the payee","summary":"Retrieve RTP requests for which the extension is declined","tags":["OTHERS"],"parameters":[{"name":"requestId","in":"path","type":"string","required":true,"description":""},{"name":"customerId","in":"query","type":"string","required":false,"description":"Identifier of the customer"},{"name":"scheme","in":"query","type":"string","required":false,"description":"Represents the scheme (a synonym for the National ID type) under which the National ID is defined"},{"name":"currentState","in":"query","type":"string","required":false,"description":"Contains the current state of the transaction"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"PayersListWithExtensionDeclinedResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"PUT","path":"/order/paymentRequests/{requestId}/extensions/rejections","fullPath":"/api/v1.9.0/order/paymentRequests/{requestId}/extensions/rejections","operationId":"updateDeclineExtension","name":"Enables the payee to decline the expiry date for the RTP request sought by the payer","summary":"Decline the expiry date extension requested by payer","tags":["OTHERS"],"parameters":[{"name":"requestId","in":"path","type":"string","required":true,"description":"The guarantees issuance id initiated by internet banking"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"additionalInfo":[{}],"requestorResponse":"string","extensions":{}}},"responses":{"200":"DeclineExtensionResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/order/paymentRequests/{requestId}/billers/acknowledgements","fullPath":"/api/v1.9.0/order/paymentRequests/{requestId}/billers/acknowledgements","operationId":"updateBillerAcknowledgements","name":"Enables the payee to send full acknowledgement to payer when payer has paid full amount and to send partial acknowledgement to payer when payer has paid partial amount","summary":"Acknowledge RTP requests waiting for payment confirmation by payee","tags":["OTHERS"],"parameters":[{"name":"requestId","in":"path","type":"string","required":true,"description":"The guarantees issuance id initiated by internet banking"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"requestorResponse":"string","extensions":{}}},"responses":{"200":"BillerAcknowledgementsResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/order/paymentRequests/{requestId}/billers/pendingAcknowledgements","fullPath":"/api/v1.9.0/order/paymentRequests/{requestId}/billers/pendingAcknowledgements","operationId":"getApiPendingAck","name":"Retrieves the RTP requests which are yet to be acknowledged by the payee for a payment that has come in due to a result of RTP request being accepted by payer. Generally, 'Partially paid' or 'Paid' are the two statuses in which payee can send an acknowledgement message corresponding to a payment received","summary":"RTP requests sent which are pending to be acknowledged by payee as payment received","tags":["OTHERS"],"parameters":[{"name":"requestId","in":"path","type":"string","required":true,"description":""},{"name":"customerId","in":"query","type":"string","required":false,"description":"Identifier of the customer"},{"name":"scheme","in":"query","type":"string","required":false,"description":"Represents the scheme (a synonym for the National ID type) under which the National ID is defined"},{"name":"currentState","in":"query","type":"string","required":false,"description":"Contains the current state of the transaction"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"ApiPendingAckResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/order/paymentRequests/{requestId}/billers/pendingExtensions","fullPath":"/api/v1.9.0/order/paymentRequests/{requestId}/billers/pendingExtensions","operationId":"getRequestorsDateExtension","name":"Retrieves the RTP requests with payee which are awaiting response for RTP expiry date extension. These requests can either be declined or approved by the payee","summary":"Payee's RTP requests awaiting RTP expiry date extension approval","tags":["OTHERS"],"parameters":[{"name":"requestId","in":"path","type":"string","required":true,"description":""},{"name":"customerId","in":"query","type":"string","required":false,"description":"Identifier of the customer"},{"name":"scheme","in":"query","type":"string","required":false,"description":"Represents the scheme (a synonym for the National ID type) under which the National ID is defined"},{"name":"requestorReference","in":"query","type":"string","required":false,"description":"Contains the reference of the requestor"},{"name":"currentState","in":"query","type":"string","required":false,"description":"Contains the current state of the transaction"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"RequestorsDateExtensionResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/order/paymentRequests/{requestId}/errors","fullPath":"/api/v1.9.0/order/paymentRequests/{requestId}/errors","operationId":"getOutwardErrors","name":"Retrieves the RTP requests which are in error status due to technical reasons. Such requests must be checked for the reason for error manually and a new RTP request must be created/initiated by payee to send the request again to payer","summary":"Retrieve the RTP requests in error status","tags":["OTHERS"],"parameters":[{"name":"requestId","in":"path","type":"string","required":true,"description":""},{"name":"customerId","in":"query","type":"string","required":false,"description":"Identifier of the customer"},{"name":"scheme","in":"query","type":"string","required":false,"description":"Represents the scheme (a synonym for the National ID type) under which the National ID is defined"},{"name":"currentState","in":"query","type":"string","required":false,"description":"Contains the current state of the transaction"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"OutwardErrorsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"PUT","path":"/order/paymentRequests/accessTokenRefreshes/{proxyIdentifiers}","fullPath":"/api/v1.9.0/order/paymentRequests/accessTokenRefreshes/{proxyIdentifiers}","operationId":"updatePaymentRequestAccessToken","name":"Update access token and scheme for a specific proxy identifier which in turn triggers the refresh and updation of Request To Pay(RTP) data store","summary":"Refresh and update the Request To Pay(RTP) data store","tags":["OTHERS"],"parameters":[{"name":"proxyIdentifiers","in":"path","type":"string","required":true,"description":"Indicates an information that is unique to a customer, such as mobile number, email id etc"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"token":"string","scheme":"string","extensions":{}}},"responses":{"200":"PaymentRequestAccessTokenResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/order/paymentRequests/mandates","fullPath":"/api/v1.9.0/order/paymentRequests/mandates","operationId":"getAllMandateRequest","name":"View list of all mandates","summary":"View list of all mandates","tags":["OTHERS"],"parameters":[{"name":"currentState","in":"query","type":"string","required":false,"description":"Contains the current state of the transaction"},{"name":"customerId","in":"query","type":"string","required":false,"description":"Identifier of the customer"},{"name":"requestToPayScheme","in":"query","type":"string","required":false,"description":"Indicates the scheme in which request to pay message is sent or received"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"AllMandateRequestResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"POST","path":"/order/paymentRequests/mandates","fullPath":"/api/v1.9.0/order/paymentRequests/mandates","operationId":"createMandateRequest","name":"Initiation process to establish mandate between requestor and payer","summary":"Initiation process to establish mandate between requestor and payer","tags":["OTHERS"],"parameters":[{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"endToEndReference":"string","additionalInformationToPayer":"string","requestorName":"string","requestorProxy":"string","requestorAccountNumber":"string","requestorAccountIBAN":"string","payerName":"string","payerProxy":"string","payerAccountNumber":"string","payerAccountIBAN":"string","requestToPayScheme":"string","customerId":"string","currentState":"string","startDate":"string","endDate":"string"}},"responses":{"200":"MandateRequestResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/order/paymentRequests/mandates/{mandateId}","fullPath":"/api/v1.9.0/order/paymentRequests/mandates/{mandateId}","operationId":"updateMandateRequest","name":"Update mandate request status and notes on payer and requestor systems","summary":"Update mandate request status","tags":["OTHERS"],"parameters":[{"name":"mandateId","in":"path","type":"string","required":true,"description":"Contains the mandatory SEPA(Single Euro Payment Area) payment identifier from the transaction"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"messageToPayer":[{}],"messageToRequestor":[{}],"payerResponse":"string","endToEndReference":"string","extensions":{}}},"responses":{"200":"MandateRequestResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"POST","path":"/order/paymentRequests/ukPayments/mandates","fullPath":"/api/v1.9.0/order/paymentRequests/ukPayments/mandates","operationId":"createUkMandateRequest","name":"Initiation process to establish mandate between requestor and payer","summary":"Initiation process to establish mandate between requestor and payer","tags":["OTHERS"],"parameters":[{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"messageToPayer":[{}],"messageToRequestor":[{}],"endToEndReference":"string","requestMessage":"string","role":"string","requestorName":"string","requestorProxy":"string","requestorAccountNumber":"string","requestorAccountIBAN":"string","payerName":"string","payerProxy":"string","payerAccountNumber":"string","payerAccountIBAN":"string","requestToPayScheme":"string","customerId":"string"}},"responses":{"200":"UkMandateRequestResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/order/paymentRequests/ukPayments/mandates/{mandateId}","fullPath":"/api/v1.9.0/order/paymentRequests/ukPayments/mandates/{mandateId}","operationId":"amendUkMandateRequest","name":"Update mandate request status and notes on payer and requestor systems","summary":"Update mandate request status","tags":["OTHERS"],"parameters":[{"name":"mandateId","in":"path","type":"string","required":true,"description":"Contains the mandatory SEPA(Single Euro Payment Area) payment identifier from the transaction"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"messageToPayer":[{}],"messageToRequestor":[{}],"endToEndReference":"string","requestMessage":"string","role":"string","requestorName":"string","requestorProxy":"string","requestorAccountNumber":"string","requestorAccountIBAN":"string","payerName":"string","payerProxy":"string","payerAccountNumber":"string","payerAccountIBAN":"string","requestToPayScheme":"string","customerId":"string"}},"responses":{"200":"UkMandateRequestResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/order/paymentRequests/{requestId}/recalls","fullPath":"/api/v1.9.0/order/paymentRequests/{requestId}/recalls","operationId":"updateRTPRecall","name":"The user can initiate a recall of an already initiated RTP. RTP request can be recalled for various reason such as duplication request, fraudulent request etc.","summary":"Recall RTP request","tags":["OTHERS"],"parameters":[{"name":"requestId","in":"path","type":"string","required":true,"description":""},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"recallId":"Recall ID","requestToPayScheme":"RTP Scheme","requestorResponse":"Requestor response","cancelReason":"Cancel Reason Code","extensions":{}}},"responses":{"200":"RTPRecallResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/order/paymentRequests/schemes/returnCodes","fullPath":"/api/v1.9.0/order/paymentRequests/schemes/returnCodes","operationId":"getSchemeReturnCodes","name":"Retrieves the list of return codes configured for a particular clearing scheme. The return codes will be used in processing Request to pay (RTP) rejects and  recall processing.","summary":"Retrieve Request to pay (RTP) scheme return code details","tags":["OTHERS"],"parameters":[{"name":"requestToPayScheme","in":"query","type":"string","required":false,"description":"Indicates the scheme in which request to pay message is sent or received"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"SchemeReturnCodesResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/order/paymentRequests/sentFiles","fullPath":"/api/v1.9.0/order/paymentRequests/sentFiles","operationId":"getSentFileDetails","name":"Retrieves the list of files related to payment requests sent by the bank","summary":"Retrieve Request to pay (RTP) sent file list","tags":["OTHERS"],"parameters":[{"name":"fileName","in":"query","type":"string","required":false,"description":"Identifies the type of methods to be listed. Possible values are FX.DEAL.METHOD, BROKER or blank."},{"name":"systemFileName","in":"query","type":"string","required":false,"description":"Contains the system generated name for the uploaded file"},{"name":"status","in":"query","type":"string","required":false,"description":"The status of the early maturity request"},{"name":"originalFileReference","in":"query","type":"string","required":false,"description":"Indicates reference of the incoming file for which response is being sent"},{"name":"dateSent","in":"query","type":"string","required":false,"description":"The date when the message is sent."},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"SentFileDetailsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/order/paymentRequests/status","fullPath":"/api/v1.9.0/order/paymentRequests/status","operationId":"getFileSummary","name":"Retrieves status summary of payment requests which were received by the bank as a part of file","summary":"Retrieves status summary of payment requests","tags":["OTHERS"],"parameters":[{"name":"receivedFileId","in":"query","type":"string","required":false,"description":"Indicates id of received file details records"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"FileSummaryResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/order/paymentRequests/receivedFiles","fullPath":"/api/v1.9.0/order/paymentRequests/receivedFiles","operationId":"getReceivedFileDetails","name":"Retrieves the list of files received by the bank for payment requests","summary":"Retrieve Request to pay (RTP) received file list","tags":["OTHERS"],"parameters":[{"name":"fileName","in":"query","type":"string","required":false,"description":"Identifies the type of methods to be listed. Possible values are FX.DEAL.METHOD, BROKER or blank."},{"name":"systemFileName","in":"query","type":"string","required":false,"description":"Contains the system generated name for the uploaded file"},{"name":"messageId","in":"query","type":"string","required":false,"description":"The holds the record key of the message ID."},{"name":"sourceType","in":"query","type":"string","required":false,"description":"Indicates source type to determine base amount. Possible values are BALANCE (base amount of a property), ACTIVITY ( transaction amount against an activity) or PROPERTY (this type is currently not supp"},{"name":"statusCode","in":"query","type":"string","required":false,"description":"Status code, as defined by the institution"},{"name":"userSignOnName","in":"query","type":"string","required":false,"description":"This is the name entered by the User to sign on to the System. It is used by the System as an alternative key to access User details"},{"name":"uploadType","in":"query","type":"string","required":false,"description":"Indicates if the record is created or maintained through an upload or manually. It can contain the following values: Upload \u00e2\u20ac\u201c The record is created through upload. Custom \u00e2\u20ac\u201c The record is created m"},{"name":"countOfRecords","in":"query","type":"string","required":false,"description":"Total count of records information for NOFILE (an enquiry does not exist in a single file) enquiry for online upgrade"},{"name":"customerName","in":"query","type":"string","required":false,"description":"Indicates the name of the customer. Originator is the party who requests the payment cancellation."},{"name":"receivedDateTime","in":"query","type":"string","required":false,"description":"Indicates the date and time when the request to pay message is received for payer and requestor"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"ReceivedFileDetailsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"POST","path":"/order/paymentRequests/ukPayments/billerRequests","fullPath":"/api/v1.9.0/order/paymentRequests/ukPayments/billerRequests","operationId":"createPayUKPaymentRequests","name":"Creates an RTP request at the Repository Service Provider(RSP). The API is for RSP-RSP communication for biller RSP to place RTP request with payer RSP. This is a provider API which can be linked to any published API in accordance to requesttopay.co.uk standards.","summary":"UK RTP scheme request initiation (RSP - RSP)","tags":["OTHERS"],"parameters":[{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"portalInfo":[{}],"errorInfo":[{}],"chargeDetails":[{}],"paymentStatus":[{}],"acceptanceDateTime":[{}],"additionalInfo":[{}],"messageToPayer":[{}],"messageToRequestor":[{}],"paymentReferenceDetails":[{}],"endToEndReference":"string","paymentMethod":"string","requestorBankBic":"string","requestorBankSortCode":"string","requestorAccountIBAN":"string","requestorAccountNumber":"string"}},"responses":{"200":"PayUKPaymentRequestsResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/order/paymentRequests/{requestId}/ukPayments","fullPath":"/api/v1.9.0/order/paymentRequests/{requestId}/ukPayments","operationId":"amendPayUKPaymentForRepository","name":"API to exchange RTP messages between biller RSP and payer RSP. The API can be used for exchanging various follow up messages for an RTP request(subsequent to RTP initiation) such as acceptance of the request in full or partial, denial of a request, exchange of notes, expiry date extension management, payment acknowledgements. This is a provider API which can be linked to any published API in accordance to requesttopay.co.uk standards.","summary":"UK RTP scheme message exchanges between biller and payer (RSP - RSP)","tags":["OTHERS"],"parameters":[{"name":"requestId","in":"path","type":"string","required":true,"description":""},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"portalInfo":[{}],"errorInfo":[{}],"chargeDetails":[{}],"paymentStatus":[{}],"acceptanceDateTime":[{}],"additionalInfo":[{}],"messageToPayer":[{}],"messageToRequestor":[{}],"paymentReferenceDetails":[{}],"endToEndReference":"string","paymentMethod":"string","requestorBankBic":"string","requestorBankSortCode":"string","requestorAccountIBAN":"string","requestorAccountNumber":"string"}},"responses":{"200":"PayUKPaymentForRepositoryResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/order/paymentRequests/payers/status","fullPath":"/api/v1.9.0/order/paymentRequests/payers/status","operationId":"getPayersStatus","name":"Retrieves the list of RTP requests of payer that are pending (that requires action from payer), completed and asked for extension","summary":"Retrieve the list of RTP requests of payer","tags":["OTHERS"],"parameters":[{"name":"currentState","in":"query","type":"string","required":true,"description":"Contains the current state of the transaction"},{"name":"customerId","in":"query","type":"string","required":false,"description":"Identifier of the customer"},{"name":"scheme","in":"query","type":"string","required":false,"description":"Represents the scheme (a synonym for the National ID type) under which the National ID is defined"},{"name":"messageId","in":"query","type":"string","required":false,"description":"The holds the record key of the message ID."},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"PayersStatusResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/order/paymentRequests/schemes","fullPath":"/api/v1.9.0/order/paymentRequests/schemes","operationId":"getSchemeDetails","name":"Retrieves the configured details for the Request to pay (RTP) scheme such as connectivity model, response type and validations","summary":"Request to pay (RTP) scheme details","tags":["OTHERS"],"parameters":[{"name":"scheme","in":"query","type":"string","required":false,"description":"Represents the scheme (a synonym for the National ID type) under which the National ID is defined"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"SchemeDetailsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"POST","path":"/order/paymentRequests","fullPath":"/api/v1.9.0/order/paymentRequests","operationId":"createPaymentRequests","name":"Create payment requests for EBA and UK scheme from biller application","summary":"Initiate a RTP request","tags":["OTHERS"],"parameters":[{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"chargeDetails":[{}],"portalInfo":[{}],"errorInfo":[{}],"payerAddressLines":[{}],"requestorAddressLines":[{}],"ultimatePayerAddressLines":[{}],"ultimateRequestorAddressLines":[{}],"paymentMethod":"string","requestedExecutionDate":"string","payerName":"string","payerStreetName":"string","payerBuildingNumber":"string","payerPostalCode":"string","payerTownName":"string","payerCountry":"string"}},"responses":{"200":"PaymentRequestsResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/order/paymentRequests/{requestId}/billers","fullPath":"/api/v1.9.0/order/paymentRequests/{requestId}/billers","operationId":"getRequestorsOutwardRequest","name":"Retrieves the list of requests sent by the payee with details like payer name, amount, status, expiry date, outstanding amount to pay and the notes exchanged so far with payer.","summary":"Retrieve RTP requests (payee side)","tags":["OTHERS"],"parameters":[{"name":"requestId","in":"path","type":"string","required":true,"description":""},{"name":"currentState","in":"query","type":"string","required":false,"description":"Contains the current state of the transaction"},{"name":"customerId","in":"query","type":"string","required":false,"description":"Identifier of the customer"},{"name":"scheme","in":"query","type":"string","required":false,"description":"Represents the scheme (a synonym for the National ID type) under which the National ID is defined"},{"name":"endToEndReference","in":"query","type":"string","required":false,"description":"Indicates the end to end reference for the payment. This field can be provided by the person who instructs the payment and this flows through the lifecycle of the payment."},{"name":"messageId","in":"query","type":"string","required":false,"description":"The holds the record key of the message ID."},{"name":"UETRId","in":"query","type":"string","required":false,"description":"Unique transaction reference details for payments"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"RequestorsOutwardRequestResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/order/paymentRequests/{requestId}/payers","fullPath":"/api/v1.9.0/order/paymentRequests/{requestId}/payers","operationId":"getPayersList","name":"Retrieves the RTP requests that are received by the payer in various states like Completed, Partially paid, Extension Granted, Declined, Extension Declined, Asked For Extension and to be used for payer side.","summary":"Retrieve RTP requests (payer side)","tags":["OTHERS"],"parameters":[{"name":"requestId","in":"path","type":"string","required":true,"description":""},{"name":"customerId","in":"query","type":"string","required":false,"description":"Identifier of the customer"},{"name":"scheme","in":"query","type":"string","required":false,"description":"Represents the scheme (a synonym for the National ID type) under which the National ID is defined"},{"name":"requestorReference","in":"query","type":"string","required":false,"description":"Contains the reference of the requestor"},{"name":"currentState","in":"query","type":"string","required":false,"description":"Contains the current state of the transaction"},{"name":"endToEndReference","in":"query","type":"string","required":false,"description":"Indicates the end to end reference for the payment. This field can be provided by the person who instructs the payment and this flows through the lifecycle of the payment."},{"name":"payerProxy","in":"query","type":"string","required":false,"description":"Contains the proxy identification of the payer"},{"name":"orderReference","in":"query","type":"string","required":false,"description":"The  order reference number."},{"name":"messageId","in":"query","type":"string","required":false,"description":"The holds the record key of the message ID."},{"name":"UETRId","in":"query","type":"string","required":false,"description":"Unique transaction reference details for payments"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"PayersListResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}}]},{"key":"RequestToPayPayments-v2.0.0","title":"Request to Pay","version":"v2.0.0","description":"Request To Pay (RTP) is a Temenos Payments application that helps Temenos bank manage their request to pay functionality. It provides RTP functionality and information exchange between the actor (payer or payee) and the RTP clearing. This page lists the APIs offered by Temenos RTP Application to con","endpointCount":38,"endpoints":[{"method":"PUT","path":"/order/paymentRequests/{requestId}/payments","fullPath":"/api/v2.0.0/order/paymentRequests/{requestId}/payments","operationId":"updateFullPayment","name":"Enables the payer to accept RTP Request and pay the outstanding amount","summary":"Accept the RTP request with full amount","tags":["OTHERS"],"parameters":[{"name":"requestId","in":"path","type":"string","required":true,"description":"The guarantees issuance id initiated by internet banking"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"additionalInfo":[{}],"debitAccount":"string","paymentReference":"string","amountModifiedByPayer":"string","payerAccountIBAN":"string","paymentDate":"string","token":"string","paymentTime":"string","paymentOrderProduct":"string","extensions":{}}},"responses":{"200":"FullPaymentResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/order/paymentRequests/{requestId}/partialPayments","fullPath":"/api/v2.0.0/order/paymentRequests/{requestId}/partialPayments","operationId":"updatePartialPayment","name":"Enables the payer to accept RTP request and pay partial amount. The original request sent by the biller remains open until the total amount is paid by the payer","summary":"Accept the RTP request and pay partially","tags":["OTHERS"],"parameters":[{"name":"requestId","in":"path","type":"string","required":true,"description":"The guarantees issuance id initiated by internet banking"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"additionalInfo":[{}],"debitAmount":"string","debitAccount":"string","paymentReference":"string","payerResponse":"string","amountModifiedByPayer":"string","payerAccountIBAN":"string","paymentDate":"string","token":"string","instructedAmount":"string","paymentTime":"string","paymentOrderProduct":"string","extensions":{}}},"responses":{"200":"PartialPaymentResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/order/paymentRequests/{requestId}/declinedRequests","fullPath":"/api/v2.0.0/order/paymentRequests/{requestId}/declinedRequests","operationId":"updateDeclinePayment","name":"Enables the payer to decline RTP request when payer does not wish to make any payment towards that request","summary":"Decline a RTP request from payee","tags":["OTHERS"],"parameters":[{"name":"requestId","in":"path","type":"string","required":true,"description":"The guarantees issuance id initiated by internet banking"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"additionalInfoToRequestor":[{}],"payerResponse":"string","token":"string","rejectReasonCode":"string","extensions":{}}},"responses":{"200":"DeclinePaymentResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/order/paymentRequests/{requestId}/billerNotes","fullPath":"/api/v2.0.0/order/paymentRequests/{requestId}/billerNotes","operationId":"updateNotesToRequestor","name":"Enables the payer to send messages to payee when the payer requires further information regarding a specific RTP request","summary":"Send notes/additional information to payee","tags":["OTHERS"],"parameters":[{"name":"requestId","in":"path","type":"string","required":true,"description":"The guarantees issuance id initiated by internet banking"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"notesToRequestor":[{}],"payerResponse":"string","token":"string","extensions":{}}},"responses":{"200":"NotesToRequestorResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/order/paymentRequests/{requestId}/amountModifications","fullPath":"/api/v2.0.0/order/paymentRequests/{requestId}/amountModifications","operationId":"updatePaymentAmount","name":"Enables the payer to modify the amount requested by payee in the original RTP request, if modification is allowed by the payee and the corresponding RTP scheme","summary":"Modify the requested amount in the RTP request","tags":["OTHERS"],"parameters":[{"name":"requestId","in":"path","type":"string","required":true,"description":"The guarantees issuance id initiated by internet banking"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"debitAccount":"string","payerAccountIBAN":"string","amountModifiedByPayer":"string","debitAmount":"string","paymentDate":"string","paymentTime":"string","paymentOrderProduct":"string","extensions":{}}},"responses":{"200":"PaymentAmountResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/order/paymentRequests/{requestId}/blocks","fullPath":"/api/v2.0.0/order/paymentRequests/{requestId}/blocks","operationId":"updateDeclineAndBlock","name":"Enables the payer to decline the payee's RTP request and block the payee when payer does not want to receive any further RTP requests in future from the specific payee","summary":"Decline the RTP request and block the payee","tags":["OTHERS"],"parameters":[{"name":"requestId","in":"path","type":"string","required":true,"description":"The guarantees issuance id initiated by internet banking"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"additionalInfoToRequestor":[{}],"payerResponse":"string","token":"string","rejectReasonCode":"string","extensions":{}}},"responses":{"200":"DeclineAndBlockResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/order/paymentRequests/{requestId}/payerNotes","fullPath":"/api/v2.0.0/order/paymentRequests/{requestId}/payerNotes","operationId":"updateNotesToPayer","name":"Enables the payee to send notes, additional information to payer when the payee requires further information regarding a specific RTP request","summary":"Send notes / additional information to payer","tags":["OTHERS"],"parameters":[{"name":"requestId","in":"path","type":"string","required":true,"description":"The guarantees issuance id initiated by internet banking"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"notesToPayer":[{}],"payerName":"string","creditAccountId":"string","requestorAccountIBAN":"string","requestorName":"string","requestedExecutionDate":"string","endToEndReference":"string","remittanceInformation":"string","extensions":{}}},"responses":{"200":"NotesToPayerResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/order/paymentRequests/{requestId}/extensions","fullPath":"/api/v2.0.0/order/paymentRequests/{requestId}/extensions","operationId":"updateDateExtension","name":"Enables the payer to request the payee for a new expiry date for the RTP request received","summary":"Request extension of the RTP expiry date","tags":["OTHERS"],"parameters":[{"name":"requestId","in":"path","type":"string","required":true,"description":"The guarantees issuance id initiated by internet banking"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"additionalInfo":[{}],"requestedExpiryDate":"string","payerResponse":"string","token":"string","extensions":{}}},"responses":{"200":"DateExtensionResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/order/paymentRequests/{requestId}/extensions/acceptances","fullPath":"/api/v2.0.0/order/paymentRequests/{requestId}/extensions/acceptances","operationId":"getPayerListWithExtensionGranted","name":"Retrieves the payer RTP requests for which the expiry date extensions have been granted by the payee","summary":"Retrieve RTP requests for which extension is granted","tags":["OTHERS"],"parameters":[{"name":"requestId","in":"path","type":"string","required":true,"description":""},{"name":"customerId","in":"query","type":"string","required":false,"description":"Contains the unique identifier of the customer who has received the payment request (RTP) or credit transfer for which the information request is to be raised."},{"name":"scheme","in":"query","type":"string","required":false,"description":"Represents the scheme (a synonym for the National ID type) under which the National ID is defined"},{"name":"currentState","in":"query","type":"string","required":false,"description":"Contains the current state of the transaction"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"PayerListWithExtensionGrantedResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"PUT","path":"/order/paymentRequests/{requestId}/extensions/acceptances","fullPath":"/api/v2.0.0/order/paymentRequests/{requestId}/extensions/acceptances","operationId":"updateGrantExtension","name":"Enables the payee to approve the expiry date for the RTP request sought by the payer","summary":"Approve the expiry date extension requested by the payer","tags":["OTHERS"],"parameters":[{"name":"requestId","in":"path","type":"string","required":true,"description":"The guarantees issuance id initiated by internet banking"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"additionalInfo":[{}],"extensions":{}}},"responses":{"200":"GrantExtensionResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/order/paymentRequests/{requestId}/extensions/rejections","fullPath":"/api/v2.0.0/order/paymentRequests/{requestId}/extensions/rejections","operationId":"getPayersListWithExtensionDeclined","name":"Retrieves the payer RTP requests for which the expiry date extensions have been declined by the payee","summary":"Retrieve RTP requests for which the extension is declined","tags":["OTHERS"],"parameters":[{"name":"requestId","in":"path","type":"string","required":true,"description":""},{"name":"customerId","in":"query","type":"string","required":false,"description":"Contains the unique identifier of the customer who has received the payment request (RTP) or credit transfer for which the information request is to be raised."},{"name":"scheme","in":"query","type":"string","required":false,"description":"Represents the scheme (a synonym for the National ID type) under which the National ID is defined"},{"name":"currentState","in":"query","type":"string","required":false,"description":"Contains the current state of the transaction"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"PayersListWithExtensionDeclinedResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"PUT","path":"/order/paymentRequests/{requestId}/extensions/rejections","fullPath":"/api/v2.0.0/order/paymentRequests/{requestId}/extensions/rejections","operationId":"updateDeclineExtension","name":"Enables the payee to decline the expiry date for the RTP request sought by the payer","summary":"Decline the expiry date extension requested by payer","tags":["OTHERS"],"parameters":[{"name":"requestId","in":"path","type":"string","required":true,"description":"The guarantees issuance id initiated by internet banking"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"additionalInfo":[{}],"requestorResponse":"string","extensions":{}}},"responses":{"200":"DeclineExtensionResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/order/paymentRequests/{requestId}/billers/acknowledgements","fullPath":"/api/v2.0.0/order/paymentRequests/{requestId}/billers/acknowledgements","operationId":"updateBillerAcknowledgements","name":"Enables the payee to send full acknowledgement to payer when payer has paid full amount and to send partial acknowledgement to payer when payer has paid partial amount","summary":"Acknowledge RTP requests waiting for payment confirmation by payee","tags":["OTHERS"],"parameters":[{"name":"requestId","in":"path","type":"string","required":true,"description":"The guarantees issuance id initiated by internet banking"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"requestorResponse":"string","extensions":{}}},"responses":{"200":"BillerAcknowledgementsResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/order/paymentRequests/{requestId}/billers/pendingAcknowledgements","fullPath":"/api/v2.0.0/order/paymentRequests/{requestId}/billers/pendingAcknowledgements","operationId":"getApiPendingAck","name":"Retrieves the RTP requests which are yet to be acknowledged by the payee for a payment that has come in due to a result of RTP request being accepted by payer. Generally, 'Partially paid' or 'Paid' are the two statuses in which payee can send an acknowledgement message corresponding to a payment received","summary":"RTP requests sent which are pending to be acknowledged by payee as payment received","tags":["OTHERS"],"parameters":[{"name":"requestId","in":"path","type":"string","required":true,"description":""},{"name":"customerId","in":"query","type":"string","required":false,"description":"Contains the unique identifier of the customer who has received the payment request (RTP) or credit transfer for which the information request is to be raised."},{"name":"scheme","in":"query","type":"string","required":false,"description":"Represents the scheme (a synonym for the National ID type) under which the National ID is defined"},{"name":"currentState","in":"query","type":"string","required":false,"description":"Contains the current state of the transaction"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"ApiPendingAckResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/order/paymentRequests/{requestId}/billers/pendingExtensions","fullPath":"/api/v2.0.0/order/paymentRequests/{requestId}/billers/pendingExtensions","operationId":"getRequestorsDateExtension","name":"Retrieves the RTP requests with payee which are awaiting response for RTP expiry date extension. These requests can either be declined or approved by the payee","summary":"Payee's RTP requests awaiting RTP expiry date extension approval","tags":["OTHERS"],"parameters":[{"name":"requestId","in":"path","type":"string","required":true,"description":""},{"name":"customerId","in":"query","type":"string","required":false,"description":"Contains the unique identifier of the customer who has received the payment request (RTP) or credit transfer for which the information request is to be raised."},{"name":"scheme","in":"query","type":"string","required":false,"description":"Represents the scheme (a synonym for the National ID type) under which the National ID is defined"},{"name":"requestorReference","in":"query","type":"string","required":false,"description":"Contains the reference of the requestor"},{"name":"currentState","in":"query","type":"string","required":false,"description":"Contains the current state of the transaction"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"RequestorsDateExtensionResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/order/paymentRequests/{requestId}/errors","fullPath":"/api/v2.0.0/order/paymentRequests/{requestId}/errors","operationId":"getOutwardErrors","name":"Retrieves the RTP requests which are in error status due to technical reasons. Such requests must be checked for the reason for error manually and a new RTP request must be created/initiated by payee to send the request again to payer","summary":"Retrieve the RTP requests in error status","tags":["OTHERS"],"parameters":[{"name":"requestId","in":"path","type":"string","required":true,"description":""},{"name":"customerId","in":"query","type":"string","required":false,"description":"Contains the unique identifier of the customer who has received the payment request (RTP) or credit transfer for which the information request is to be raised."},{"name":"scheme","in":"query","type":"string","required":false,"description":"Represents the scheme (a synonym for the National ID type) under which the National ID is defined"},{"name":"currentState","in":"query","type":"string","required":false,"description":"Contains the current state of the transaction"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"OutwardErrorsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"PUT","path":"/order/paymentRequests/accessTokenRefreshes/{proxyIdentifiers}","fullPath":"/api/v2.0.0/order/paymentRequests/accessTokenRefreshes/{proxyIdentifiers}","operationId":"updatePaymentRequestAccessToken","name":"Update access token and scheme for a specific proxy identifier which in turn triggers the refresh and updation of Request To Pay(RTP) data store","summary":"Refresh and update the Request To Pay(RTP) data store","tags":["OTHERS"],"parameters":[{"name":"proxyIdentifiers","in":"path","type":"string","required":true,"description":"Indicates an information that is unique to a customer, such as mobile number, email id etc"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"token":"string","scheme":"string","extensions":{}}},"responses":{"200":"PaymentRequestAccessTokenResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/order/paymentRequests/mandates","fullPath":"/api/v2.0.0/order/paymentRequests/mandates","operationId":"getAllMandateRequest","name":"View list of all mandates","summary":"View list of all mandates","tags":["OTHERS"],"parameters":[{"name":"currentState","in":"query","type":"string","required":false,"description":"Contains the current state of the transaction"},{"name":"customerId","in":"query","type":"string","required":false,"description":"Contains the unique identifier of the customer who has received the payment request (RTP) or credit transfer for which the information request is to be raised."},{"name":"requestToPayScheme","in":"query","type":"string","required":false,"description":"Indicates the scheme in which request to pay message is sent or received"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"AllMandateRequestResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"POST","path":"/order/paymentRequests/mandates","fullPath":"/api/v2.0.0/order/paymentRequests/mandates","operationId":"createMandateRequest","name":"Initiation process to establish mandate between requestor and payer","summary":"Initiation process to establish mandate between requestor and payer","tags":["OTHERS"],"parameters":[{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"endToEndReference":"string","additionalInformationToPayer":"string","requestorName":"string","requestorProxy":"string","requestorAccountNumber":"string","requestorAccountIBAN":"string","payerName":"string","payerProxy":"string","payerAccountNumber":"string","payerAccountIBAN":"string","requestToPayScheme":"string","customerId":"string","currentState":"string","startDate":"string","endDate":"string"}},"responses":{"200":"MandateRequestResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/order/paymentRequests/mandates/{mandateId}","fullPath":"/api/v2.0.0/order/paymentRequests/mandates/{mandateId}","operationId":"updateMandateRequest","name":"Update mandate request status and notes on payer and requestor systems","summary":"Update mandate request status","tags":["OTHERS"],"parameters":[{"name":"mandateId","in":"path","type":"string","required":true,"description":"Contains the mandatory SEPA(Single Euro Payment Area) payment identifier from the transaction"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"messageToPayer":[{}],"messageToRequestor":[{}],"payerResponse":"string","endToEndReference":"string","extensions":{}}},"responses":{"200":"MandateRequestResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"POST","path":"/order/paymentRequests/ukPayments/mandates","fullPath":"/api/v2.0.0/order/paymentRequests/ukPayments/mandates","operationId":"createUkMandateRequest","name":"Initiation process to establish mandate between requestor and payer","summary":"Initiation process to establish mandate between requestor and payer","tags":["OTHERS"],"parameters":[{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"messageToPayer":[{}],"messageToRequestor":[{}],"endToEndReference":"string","requestMessage":"string","role":"string","requestorName":"string","requestorProxy":"string","requestorAccountNumber":"string","requestorAccountIBAN":"string","payerName":"string","payerProxy":"string","payerAccountNumber":"string","payerAccountIBAN":"string","requestToPayScheme":"string","customerId":"string"}},"responses":{"200":"UkMandateRequestResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/order/paymentRequests/ukPayments/mandates/{mandateId}","fullPath":"/api/v2.0.0/order/paymentRequests/ukPayments/mandates/{mandateId}","operationId":"amendUkMandateRequest","name":"Update mandate request status and notes on payer and requestor systems","summary":"Update mandate request status","tags":["OTHERS"],"parameters":[{"name":"mandateId","in":"path","type":"string","required":true,"description":"Contains the mandatory SEPA(Single Euro Payment Area) payment identifier from the transaction"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"messageToPayer":[{}],"messageToRequestor":[{}],"endToEndReference":"string","requestMessage":"string","role":"string","requestorName":"string","requestorProxy":"string","requestorAccountNumber":"string","requestorAccountIBAN":"string","payerName":"string","payerProxy":"string","payerAccountNumber":"string","payerAccountIBAN":"string","requestToPayScheme":"string","customerId":"string"}},"responses":{"200":"UkMandateRequestResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/order/paymentRequests/{requestId}/recalls","fullPath":"/api/v2.0.0/order/paymentRequests/{requestId}/recalls","operationId":"updateRTPRecall","name":"The user can initiate a recall of an already initiated RTP. RTP request can be recalled for various reason such as duplication request, fraudulent request etc.","summary":"Recall RTP request","tags":["OTHERS"],"parameters":[{"name":"requestId","in":"path","type":"string","required":true,"description":""},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"recallId":"Recall ID","requestToPayScheme":"RTP Scheme","requestorResponse":"Requestor response","cancelReason":"Cancel Reason Code","extensions":{}}},"responses":{"200":"RTPRecallResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/order/paymentRequests/sentFiles","fullPath":"/api/v2.0.0/order/paymentRequests/sentFiles","operationId":"getSentFileDetails","name":"Retrieves the list of files related to payment requests sent by the bank","summary":"Retrieve Request to pay (RTP) sent file list","tags":["OTHERS"],"parameters":[{"name":"fileName","in":"query","type":"string","required":false,"description":"Identifies the type of methods to be listed. Possible values are FX.DEAL.METHOD, BROKER or blank."},{"name":"systemFileName","in":"query","type":"string","required":false,"description":"Contains the system generated name for the uploaded file"},{"name":"status","in":"query","type":"string","required":false,"description":"The status of the early maturity request"},{"name":"originalFileReference","in":"query","type":"string","required":false,"description":"Indicates reference of the incoming file for which response is being sent"},{"name":"dateSent","in":"query","type":"string","required":false,"description":"The date when the message is sent."},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"SentFileDetailsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/order/paymentRequests/status","fullPath":"/api/v2.0.0/order/paymentRequests/status","operationId":"getFileSummary","name":"Retrieves status summary of payment requests which were received by the bank as a part of file","summary":"Retrieves status summary of payment requests","tags":["OTHERS"],"parameters":[{"name":"receivedFileId","in":"query","type":"string","required":false,"description":"Indicates id of received file details records"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"FileSummaryResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/order/paymentRequests/receivedFiles","fullPath":"/api/v2.0.0/order/paymentRequests/receivedFiles","operationId":"getReceivedFileDetails","name":"Retrieves the list of files received by the bank for payment requests","summary":"Retrieve Request to pay (RTP) received file list","tags":["OTHERS"],"parameters":[{"name":"fileName","in":"query","type":"string","required":false,"description":"Identifies the type of methods to be listed. Possible values are FX.DEAL.METHOD, BROKER or blank."},{"name":"systemFileName","in":"query","type":"string","required":false,"description":"Contains the system generated name for the uploaded file"},{"name":"messageId","in":"query","type":"string","required":false,"description":"The holds the record key of the message ID."},{"name":"sourceType","in":"query","type":"string","required":false,"description":"Indicates source type to determine base amount. Possible values are BALANCE (base amount of a property), ACTIVITY ( transaction amount against an activity) or PROPERTY (this type is currently not supp"},{"name":"statusCode","in":"query","type":"string","required":false,"description":"Status code, as defined by the institution"},{"name":"userSignOnName","in":"query","type":"string","required":false,"description":"This is the name entered by the User to sign on to the System. It is used by the System as an alternative key to access User details"},{"name":"uploadType","in":"query","type":"string","required":false,"description":"Indicates if the record is created or maintained through an upload or manually. It can contain the following values: Upload \u00e2\u20ac\u201c The record is created through upload. Custom \u00e2\u20ac\u201c The record is created m"},{"name":"countOfRecords","in":"query","type":"string","required":false,"description":"Total count of records information for NOFILE (an enquiry does not exist in a single file) enquiry for online upgrade"},{"name":"customerName","in":"query","type":"string","required":false,"description":"Indicates the name of the customer. Originator is the party who requests the payment cancellation."},{"name":"receivedDateTime","in":"query","type":"string","required":false,"description":"Indicates the date and time when the request to pay message is received for payer and requestor"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"ReceivedFileDetailsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"POST","path":"/order/paymentRequests/ukPayments/billerRequests","fullPath":"/api/v2.0.0/order/paymentRequests/ukPayments/billerRequests","operationId":"createPayUKPaymentRequests","name":"Creates an RTP request at the Repository Service Provider(RSP). The API is for RSP-RSP communication for biller RSP to place RTP request with payer RSP. This is a provider API which can be linked to any published API in accordance to requesttopay.co.uk standards.","summary":"UK RTP scheme request initiation (RSP - RSP)","tags":["OTHERS"],"parameters":[{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"portalInfo":[{}],"errorInfo":[{}],"chargeDetails":[{}],"paymentStatus":[{}],"acceptanceDateTime":[{}],"additionalInfo":[{}],"messageToPayer":[{}],"messageToRequestor":[{}],"paymentReferenceDetails":[{}],"endToEndReference":"string","paymentMethod":"string","requestorBankBic":"string","requestorBankSortCode":"string","requestorAccountIBAN":"string","requestorAccountNumber":"string"}},"responses":{"200":"PayUKPaymentRequestsResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/order/paymentRequests/{requestId}/ukPayments","fullPath":"/api/v2.0.0/order/paymentRequests/{requestId}/ukPayments","operationId":"amendPayUKPaymentForRepository","name":"API to exchange RTP messages between biller RSP and payer RSP. The API can be used for exchanging various follow up messages for an RTP request(subsequent to RTP initiation) such as acceptance of the request in full or partial, denial of a request, exchange of notes, expiry date extension management, payment acknowledgements. This is a provider API which can be linked to any published API in accordance to requesttopay.co.uk standards.","summary":"UK RTP scheme message exchanges between biller and payer (RSP - RSP)","tags":["OTHERS"],"parameters":[{"name":"requestId","in":"path","type":"string","required":true,"description":""},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"portalInfo":[{}],"errorInfo":[{}],"chargeDetails":[{}],"paymentStatus":[{}],"acceptanceDateTime":[{}],"additionalInfo":[{}],"messageToPayer":[{}],"messageToRequestor":[{}],"paymentReferenceDetails":[{}],"endToEndReference":"string","paymentMethod":"string","requestorBankBic":"string","requestorBankSortCode":"string","requestorAccountIBAN":"string","requestorAccountNumber":"string"}},"responses":{"200":"PayUKPaymentForRepositoryResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/order/paymentRequests/payers/status","fullPath":"/api/v2.0.0/order/paymentRequests/payers/status","operationId":"getPayersStatus","name":"Retrieves the list of RTP requests of payer that are pending (that requires action from payer), completed and asked for extension","summary":"Retrieve the list of RTP requests of payer","tags":["OTHERS"],"parameters":[{"name":"currentState","in":"query","type":"string","required":true,"description":"Contains the current state of the transaction"},{"name":"customerId","in":"query","type":"string","required":false,"description":"Contains the unique identifier of the customer who has received the payment request (RTP) or credit transfer for which the information request is to be raised."},{"name":"scheme","in":"query","type":"string","required":false,"description":"Represents the scheme (a synonym for the National ID type) under which the National ID is defined"},{"name":"messageId","in":"query","type":"string","required":false,"description":"The holds the record key of the message ID."},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"PayersStatusResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/order/paymentRequests/schemes","fullPath":"/api/v2.0.0/order/paymentRequests/schemes","operationId":"getSchemeDetails","name":"Retrieves the configured details for the Request to pay (RTP) scheme such as connectivity model, response type and validations","summary":"Request to pay (RTP) scheme details","tags":["OTHERS"],"parameters":[{"name":"scheme","in":"query","type":"string","required":false,"description":"Represents the scheme (a synonym for the National ID type) under which the National ID is defined"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"SchemeDetailsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"POST","path":"/order/paymentRequests","fullPath":"/api/v2.0.0/order/paymentRequests","operationId":"createPaymentRequests","name":"Create payment requests for EBA and UK scheme from biller application","summary":"Initiate a RTP request","tags":["OTHERS"],"parameters":[{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"chargeDetails":[{}],"portalInfo":[{}],"errorInfo":[{}],"payerAddressLines":[{}],"requestorAddressLines":[{}],"ultimatePayerAddressLines":[{}],"ultimateRequestorAddressLines":[{}],"paymentMethod":"string","requestedExecutionDate":"string","payerName":"string","payerStreetName":"string","payerBuildingNumber":"string","payerPostalCode":"string","payerTownName":"string","payerCountry":"string"}},"responses":{"200":"PaymentRequestsResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/order/paymentRequests/{requestId}/billers","fullPath":"/api/v2.0.0/order/paymentRequests/{requestId}/billers","operationId":"getRequestorsOutwardRequest","name":"Retrieves the list of requests sent by the payee with details like payer name, amount, status, expiry date, outstanding amount to pay and the notes exchanged so far with payer.","summary":"Retrieve RTP requests (payee side)","tags":["OTHERS"],"parameters":[{"name":"requestId","in":"path","type":"string","required":true,"description":""},{"name":"currentState","in":"query","type":"string","required":false,"description":"Contains the current state of the transaction"},{"name":"customerId","in":"query","type":"string","required":false,"description":"Contains the unique identifier of the customer who has received the payment request (RTP) or credit transfer for which the information request is to be raised."},{"name":"scheme","in":"query","type":"string","required":false,"description":"Represents the scheme (a synonym for the National ID type) under which the National ID is defined"},{"name":"endToEndReference","in":"query","type":"string","required":false,"description":"Indicates the end to end reference for the payment. This field can be provided by the person who instructs the payment and this flows through the lifecycle of the payment."},{"name":"messageId","in":"query","type":"string","required":false,"description":"The holds the record key of the message ID."},{"name":"UETRId","in":"query","type":"string","required":false,"description":"Contains the unique end-to-end transaction reference of the underlying payment request (RTP) or credit transfer transaction for which information request is to be raised."},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"RequestorsOutwardRequestResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/order/paymentRequests/{requestId}/payers","fullPath":"/api/v2.0.0/order/paymentRequests/{requestId}/payers","operationId":"getPayersList","name":"Retrieves the RTP requests that are received by the payer in various states like Completed, Partially paid, Extension Granted, Declined, Extension Declined, Asked For Extension and to be used for payer side.","summary":"Retrieve RTP requests (payer side)","tags":["OTHERS"],"parameters":[{"name":"requestId","in":"path","type":"string","required":true,"description":""},{"name":"customerId","in":"query","type":"string","required":false,"description":"Contains the unique identifier of the customer who has received the payment request (RTP) or credit transfer for which the information request is to be raised."},{"name":"scheme","in":"query","type":"string","required":false,"description":"Represents the scheme (a synonym for the National ID type) under which the National ID is defined"},{"name":"requestorReference","in":"query","type":"string","required":false,"description":"Contains the reference of the requestor"},{"name":"currentState","in":"query","type":"string","required":false,"description":"Contains the current state of the transaction"},{"name":"endToEndReference","in":"query","type":"string","required":false,"description":"Indicates the end to end reference for the payment. This field can be provided by the person who instructs the payment and this flows through the lifecycle of the payment."},{"name":"payerProxy","in":"query","type":"string","required":false,"description":"Contains the proxy identification of the payer"},{"name":"orderReference","in":"query","type":"string","required":false,"description":"The  order reference number."},{"name":"messageId","in":"query","type":"string","required":false,"description":"The holds the record key of the message ID."},{"name":"UETRId","in":"query","type":"string","required":false,"description":"Contains the unique end-to-end transaction reference of the underlying payment request (RTP) or credit transfer transaction for which information request is to be raised."},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"PayersListResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/order/paymentRequests/informationRequests","fullPath":"/api/v2.0.0/order/paymentRequests/informationRequests","operationId":"getInformationRequests","name":"Retrieves the list of information requests sent/received by the bank for payment requests (RTP) and credit transfers.","summary":"Retrieve list of information requests","tags":["OTHERS"],"parameters":[{"name":"informationRequestFor","in":"query","type":"string","required":false,"description":"Indicates whether the information request is being raised for a payment request (RTP) or a credit transfer transaction. Allowed values are 'RTP' in case of payment request and 'CT' in case of credit t"},{"name":"paymentRequestReference","in":"query","type":"string","required":false,"description":"Contains the reference of the payment request (RTP) for which the information request is to be raised."},{"name":"paymentReference","in":"query","type":"string","required":false,"description":"Contains the FT number of the credit transfer transaction for which information request is to be raised."},{"name":"direction","in":"query","type":"string","required":false,"description":"Contains the direction of the information request. Value of 'Outward' indicates that the information request is sent by the Bank. Value of 'Inward' indicates that the request for information is receiv"},{"name":"investigationCaseId","in":"query","type":"string","required":false,"description":"To unambiquously identify the case"},{"name":"status","in":"query","type":"string","required":false,"description":"The status of the early maturity request"},{"name":"creatorType","in":"query","type":"string","required":false,"description":"Indicates whether a party or agent is raising the information request. Allowed values are 'P' for party and 'A' for agent."},{"name":"creatorName","in":"query","type":"string","required":false,"description":"Contains the name of customer or agent who is raising the information request."},{"name":"customerId","in":"query","type":"string","required":false,"description":"Contains the unique identifier of the customer who has received the payment request (RTP) or credit transfer for which the information request is to be raised."},{"name":"reasonCode","in":"query","type":"string","required":false,"description":"Contains the reason for raising the information request in a coded form."},{"name":"clearingId","in":"query","type":"string","required":false,"description":"Contains the identifier of the RTP scheme in case information request is for a RTP request. If the information request is for a credit transfer transaction, it contains the identifier of the clearing."},{"name":"paymentCurrency","in":"query","type":"string","required":false,"description":"This field holds the transaction currency or currency in which payment is initiated. "},{"name":"amount","in":"query","type":"string","required":false,"description":"Contains the direct debit claim amount"},{"name":"endToEndReference","in":"query","type":"string","required":false,"description":"Indicates the end to end reference for the payment. This field can be provided by the person who instructs the payment and this flows through the lifecycle of the payment."},{"name":"UETRId","in":"query","type":"string","required":false,"description":"Contains the unique end-to-end transaction reference of the underlying payment request (RTP) or credit transfer transaction for which information request is to be raised."},{"name":"originalMessageReference","in":"query","type":"string","required":false,"description":"Contains the unique identifier of the underlying payment request (RTP) or credit transfer message."},{"name":"response","in":"query","type":"string","required":false,"description":"The OFS response sent from T24 for the request sent for funds reservation or deletion of the reservation"},{"name":"requestDate","in":"query","type":"string","required":false,"description":"Contains the date when the information request was sent by the bank."},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"InformationRequestsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"POST","path":"/order/paymentRequests/informationRequests","fullPath":"/api/v2.0.0/order/paymentRequests/informationRequests","operationId":"createInformationRequest","name":"Initiate an information request for a received payment request (RTP) or credit transfer.","summary":"Initiate an information request for a received payment request (RTP) or credit transfer.","tags":["OTHERS"],"parameters":[{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"reasonCodes":[{}],"additionalInformations":[{}],"creatorUnstructuredAddresses":[{}],"creatorOrgOtherIds":[{}],"creatorOrgOtherSchemeCodes":[{}],"creatorOrgOtherSchemeProprietaries":[{}],"creatorOrgOtherIssuers":[{}],"creatorPvtOtherIdentifications":[{}],"creatorPvtOtherSchemeCodes":[{}],"creatorPvtOtherSchemeProprietaries":[{}],"creatorPvtOtherIssuers":[{}],"ReqAssignmentIDs":[{}],"investigationcaseids":[{}],"requestIds":[{}],"informationRequestFor":"string"}},"responses":{"200":"InformationRequestResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/order/paymentRequests/informationRequests/{paymentRequestReference}","fullPath":"/api/v2.0.0/order/paymentRequests/informationRequests/{paymentRequestReference}","operationId":"updateRequestOrderDetails","name":"Amend details of payment request (RTP) with the reference of an information request","summary":"Amend details of payment request","tags":["OTHERS"],"parameters":[{"name":"paymentRequestReference","in":"path","type":"string","required":true,"description":"Contains the reference of the payment request (RTP) for which the information request is to be raised."},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"informationRequestId":"string","requestedExecutionDate":"string","expiryDate":"string","payerName":"string","payerAccountNumber":"string","payerAccountIBAN":"string","ultimatePayerName":"string","remittanceInformation":"string","remittanceLocationDetails":"string","requestorName":"string","ultimateRequestorName":"string","extensions":{}}},"responses":{"200":"RequestOrderDetailsResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/order/paymentRequests/informationRequests/{informationRequestId}/responses","fullPath":"/api/v2.0.0/order/paymentRequests/informationRequests/{informationRequestId}/responses","operationId":"updateInformationRequest","name":"Updates the underlying Information Request with the response provided by the receiver of the Information Request. Following the update, response message is generated and sent to the sender of Information Request.","summary":"Send response to an Information Request","tags":["OTHERS"],"parameters":[{"name":"informationRequestId","in":"path","type":"string","required":true,"description":"Contains the unique identifier of the information request. For information requests which are sent by the bank, this is auto generated by system. For information requests received by the bank, this is"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"responses":[{}],"supplementaryInformations":[{}],"extensions":{}}},"responses":{"200":"InformationRequestResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/order/paymentRequests/schemes/returnCodes","fullPath":"/api/v2.0.0/order/paymentRequests/schemes/returnCodes","operationId":"getSchemeReturnCodes","name":"Retrieves the list of return codes configured for a particular clearing scheme. The return codes will be used in processing Request to pay (RTP) rejects and  recall processing.","summary":"Retrieve Request to pay (RTP) scheme return code details","tags":["OTHERS"],"parameters":[{"name":"requestToPayScheme","in":"query","type":"string","required":false,"description":"Indicates the scheme in which request to pay message is sent or received"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"SchemeReturnCodesResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}}]},{"key":"RequestToPayPayments-v2.1.0","title":"Request to Pay","version":"v2.1.0","description":"Request To Pay (RTP) is a Temenos Payments application that helps Temenos bank manage their request to pay functionality. It provides RTP functionality and information exchange between the actor (payer or payee) and the RTP clearing. This page lists the APIs offered by Temenos RTP Application to con","endpointCount":38,"endpoints":[{"method":"PUT","path":"/order/paymentRequests/{requestId}/payments","fullPath":"/api/v2.1.0/order/paymentRequests/{requestId}/payments","operationId":"updateFullPayment","name":"Enables the payer to accept RTP Request and pay the outstanding amount","summary":"Accept the RTP request with full amount","tags":["OTHERS"],"parameters":[{"name":"requestId","in":"path","type":"string","required":true,"description":"The guarantees issuance id initiated by internet banking"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"additionalInfo":[{}],"debitAccount":"string","paymentReference":"string","amountModifiedByPayer":"string","payerAccountIBAN":"string","paymentDate":"string","token":"string","paymentTime":"string","paymentOrderProduct":"string","extensions":{}}},"responses":{"200":"FullPaymentResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/order/paymentRequests/{requestId}/partialPayments","fullPath":"/api/v2.1.0/order/paymentRequests/{requestId}/partialPayments","operationId":"updatePartialPayment","name":"Enables the payer to accept RTP request and pay partial amount. The original request sent by the biller remains open until the total amount is paid by the payer","summary":"Accept the RTP request and pay partially","tags":["OTHERS"],"parameters":[{"name":"requestId","in":"path","type":"string","required":true,"description":"The guarantees issuance id initiated by internet banking"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"additionalInfo":[{}],"debitAmount":"string","debitAccount":"string","paymentReference":"string","payerResponse":"string","amountModifiedByPayer":"string","payerAccountIBAN":"string","paymentDate":"string","token":"string","instructedAmount":"string","paymentTime":"string","paymentOrderProduct":"string","extensions":{}}},"responses":{"200":"PartialPaymentResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/order/paymentRequests/{requestId}/declinedRequests","fullPath":"/api/v2.1.0/order/paymentRequests/{requestId}/declinedRequests","operationId":"updateDeclinePayment","name":"Enables the payer to decline RTP request when payer does not wish to make any payment towards that request","summary":"Decline a RTP request from payee","tags":["OTHERS"],"parameters":[{"name":"requestId","in":"path","type":"string","required":true,"description":"The guarantees issuance id initiated by internet banking"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"additionalInfoToRequestor":[{}],"payerResponse":"string","token":"string","rejectReasonCode":"string","extensions":{}}},"responses":{"200":"DeclinePaymentResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/order/paymentRequests/{requestId}/billerNotes","fullPath":"/api/v2.1.0/order/paymentRequests/{requestId}/billerNotes","operationId":"updateNotesToRequestor","name":"Enables the payer to send messages to payee when the payer requires further information regarding a specific RTP request","summary":"Send notes/additional information to payee","tags":["OTHERS"],"parameters":[{"name":"requestId","in":"path","type":"string","required":true,"description":"The guarantees issuance id initiated by internet banking"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"notesToRequestor":[{}],"payerResponse":"string","token":"string","extensions":{}}},"responses":{"200":"NotesToRequestorResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/order/paymentRequests/{requestId}/amountModifications","fullPath":"/api/v2.1.0/order/paymentRequests/{requestId}/amountModifications","operationId":"updatePaymentAmount","name":"Enables the payer to modify the amount requested by payee in the original RTP request, if modification is allowed by the payee and the corresponding RTP scheme","summary":"Modify the requested amount in the RTP request","tags":["OTHERS"],"parameters":[{"name":"requestId","in":"path","type":"string","required":true,"description":"The guarantees issuance id initiated by internet banking"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"debitAccount":"string","payerAccountIBAN":"string","amountModifiedByPayer":"string","debitAmount":"string","paymentDate":"string","paymentTime":"string","paymentOrderProduct":"string","extensions":{}}},"responses":{"200":"PaymentAmountResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/order/paymentRequests/{requestId}/blocks","fullPath":"/api/v2.1.0/order/paymentRequests/{requestId}/blocks","operationId":"updateDeclineAndBlock","name":"Enables the payer to decline the payee's RTP request and block the payee when payer does not want to receive any further RTP requests in future from the specific payee","summary":"Decline the RTP request and block the payee","tags":["OTHERS"],"parameters":[{"name":"requestId","in":"path","type":"string","required":true,"description":"The guarantees issuance id initiated by internet banking"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"additionalInfoToRequestor":[{}],"payerResponse":"string","token":"string","rejectReasonCode":"string","extensions":{}}},"responses":{"200":"DeclineAndBlockResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/order/paymentRequests/{requestId}/payerNotes","fullPath":"/api/v2.1.0/order/paymentRequests/{requestId}/payerNotes","operationId":"updateNotesToPayer","name":"Enables the payee to send notes, additional information to payer when the payee requires further information regarding a specific RTP request","summary":"Send notes / additional information to payer","tags":["OTHERS"],"parameters":[{"name":"requestId","in":"path","type":"string","required":true,"description":"The guarantees issuance id initiated by internet banking"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"notesToPayer":[{}],"payerName":"string","creditAccountId":"string","requestorAccountIBAN":"string","requestorName":"string","requestedExecutionDate":"string","endToEndReference":"string","remittanceInformation":"string","extensions":{}}},"responses":{"200":"NotesToPayerResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/order/paymentRequests/{requestId}/extensions","fullPath":"/api/v2.1.0/order/paymentRequests/{requestId}/extensions","operationId":"updateDateExtension","name":"Enables the payer to request the payee for a new expiry date for the RTP request received","summary":"Request extension of the RTP expiry date","tags":["OTHERS"],"parameters":[{"name":"requestId","in":"path","type":"string","required":true,"description":"The guarantees issuance id initiated by internet banking"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"additionalInfo":[{}],"requestedExpiryDate":"string","payerResponse":"string","token":"string","extensions":{}}},"responses":{"200":"DateExtensionResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/order/paymentRequests/{requestId}/extensions/acceptances","fullPath":"/api/v2.1.0/order/paymentRequests/{requestId}/extensions/acceptances","operationId":"getPayerListWithExtensionGranted","name":"Retrieves the payer RTP requests for which the expiry date extensions have been granted by the payee","summary":"Retrieve RTP requests for which extension is granted","tags":["OTHERS"],"parameters":[{"name":"requestId","in":"path","type":"string","required":true,"description":""},{"name":"customerId","in":"query","type":"string","required":false,"description":"Contains the unique identifier of the customer who has received the payment request (RTP) or credit transfer for which the information request is to be raised."},{"name":"scheme","in":"query","type":"string","required":false,"description":"Represents the scheme (a synonym for the National ID type) under which the National ID is defined"},{"name":"currentState","in":"query","type":"string","required":false,"description":"Contains the current state of the transaction"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"PayerListWithExtensionGrantedResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"PUT","path":"/order/paymentRequests/{requestId}/extensions/acceptances","fullPath":"/api/v2.1.0/order/paymentRequests/{requestId}/extensions/acceptances","operationId":"updateGrantExtension","name":"Enables the payee to approve the expiry date for the RTP request sought by the payer","summary":"Approve the expiry date extension requested by the payer","tags":["OTHERS"],"parameters":[{"name":"requestId","in":"path","type":"string","required":true,"description":"The guarantees issuance id initiated by internet banking"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"additionalInfo":[{}],"extensions":{}}},"responses":{"200":"GrantExtensionResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/order/paymentRequests/{requestId}/extensions/rejections","fullPath":"/api/v2.1.0/order/paymentRequests/{requestId}/extensions/rejections","operationId":"getPayersListWithExtensionDeclined","name":"Retrieves the payer RTP requests for which the expiry date extensions have been declined by the payee","summary":"Retrieve RTP requests for which the extension is declined","tags":["OTHERS"],"parameters":[{"name":"requestId","in":"path","type":"string","required":true,"description":""},{"name":"customerId","in":"query","type":"string","required":false,"description":"Contains the unique identifier of the customer who has received the payment request (RTP) or credit transfer for which the information request is to be raised."},{"name":"scheme","in":"query","type":"string","required":false,"description":"Represents the scheme (a synonym for the National ID type) under which the National ID is defined"},{"name":"currentState","in":"query","type":"string","required":false,"description":"Contains the current state of the transaction"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"PayersListWithExtensionDeclinedResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"PUT","path":"/order/paymentRequests/{requestId}/extensions/rejections","fullPath":"/api/v2.1.0/order/paymentRequests/{requestId}/extensions/rejections","operationId":"updateDeclineExtension","name":"Enables the payee to decline the expiry date for the RTP request sought by the payer","summary":"Decline the expiry date extension requested by payer","tags":["OTHERS"],"parameters":[{"name":"requestId","in":"path","type":"string","required":true,"description":"The guarantees issuance id initiated by internet banking"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"additionalInfo":[{}],"requestorResponse":"string","extensions":{}}},"responses":{"200":"DeclineExtensionResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/order/paymentRequests/{requestId}/billers/acknowledgements","fullPath":"/api/v2.1.0/order/paymentRequests/{requestId}/billers/acknowledgements","operationId":"updateBillerAcknowledgements","name":"Enables the payee to send full acknowledgement to payer when payer has paid full amount and to send partial acknowledgement to payer when payer has paid partial amount","summary":"Acknowledge RTP requests waiting for payment confirmation by payee","tags":["OTHERS"],"parameters":[{"name":"requestId","in":"path","type":"string","required":true,"description":"The guarantees issuance id initiated by internet banking"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"requestorResponse":"string","extensions":{}}},"responses":{"200":"BillerAcknowledgementsResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/order/paymentRequests/{requestId}/billers/pendingAcknowledgements","fullPath":"/api/v2.1.0/order/paymentRequests/{requestId}/billers/pendingAcknowledgements","operationId":"getApiPendingAck","name":"Retrieves the RTP requests which are yet to be acknowledged by the payee for a payment that has come in due to a result of RTP request being accepted by payer. Generally, 'Partially paid' or 'Paid' are the two statuses in which payee can send an acknowledgement message corresponding to a payment received","summary":"RTP requests sent which are pending to be acknowledged by payee as payment received","tags":["OTHERS"],"parameters":[{"name":"requestId","in":"path","type":"string","required":true,"description":""},{"name":"customerId","in":"query","type":"string","required":false,"description":"Contains the unique identifier of the customer who has received the payment request (RTP) or credit transfer for which the information request is to be raised."},{"name":"scheme","in":"query","type":"string","required":false,"description":"Represents the scheme (a synonym for the National ID type) under which the National ID is defined"},{"name":"currentState","in":"query","type":"string","required":false,"description":"Contains the current state of the transaction"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"ApiPendingAckResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/order/paymentRequests/{requestId}/billers/pendingExtensions","fullPath":"/api/v2.1.0/order/paymentRequests/{requestId}/billers/pendingExtensions","operationId":"getRequestorsDateExtension","name":"Retrieves the RTP requests with payee which are awaiting response for RTP expiry date extension. These requests can either be declined or approved by the payee","summary":"Payee's RTP requests awaiting RTP expiry date extension approval","tags":["OTHERS"],"parameters":[{"name":"requestId","in":"path","type":"string","required":true,"description":""},{"name":"customerId","in":"query","type":"string","required":false,"description":"Contains the unique identifier of the customer who has received the payment request (RTP) or credit transfer for which the information request is to be raised."},{"name":"scheme","in":"query","type":"string","required":false,"description":"Represents the scheme (a synonym for the National ID type) under which the National ID is defined"},{"name":"requestorReference","in":"query","type":"string","required":false,"description":"Contains the reference of the requestor"},{"name":"currentState","in":"query","type":"string","required":false,"description":"Contains the current state of the transaction"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"RequestorsDateExtensionResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/order/paymentRequests/{requestId}/errors","fullPath":"/api/v2.1.0/order/paymentRequests/{requestId}/errors","operationId":"getOutwardErrors","name":"Retrieves the RTP requests which are in error status due to technical reasons. Such requests must be checked for the reason for error manually and a new RTP request must be created/initiated by payee to send the request again to payer","summary":"Retrieve the RTP requests in error status","tags":["OTHERS"],"parameters":[{"name":"requestId","in":"path","type":"string","required":true,"description":""},{"name":"customerId","in":"query","type":"string","required":false,"description":"Contains the unique identifier of the customer who has received the payment request (RTP) or credit transfer for which the information request is to be raised."},{"name":"scheme","in":"query","type":"string","required":false,"description":"Represents the scheme (a synonym for the National ID type) under which the National ID is defined"},{"name":"currentState","in":"query","type":"string","required":false,"description":"Contains the current state of the transaction"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"OutwardErrorsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"PUT","path":"/order/paymentRequests/accessTokenRefreshes/{proxyIdentifiers}","fullPath":"/api/v2.1.0/order/paymentRequests/accessTokenRefreshes/{proxyIdentifiers}","operationId":"updatePaymentRequestAccessToken","name":"Update access token and scheme for a specific proxy identifier which in turn triggers the refresh and updation of Request To Pay(RTP) data store","summary":"Refresh and update the Request To Pay(RTP) data store","tags":["OTHERS"],"parameters":[{"name":"proxyIdentifiers","in":"path","type":"string","required":true,"description":"Indicates an information that is unique to a customer, such as mobile number, email id etc"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"token":"string","scheme":"string","extensions":{}}},"responses":{"200":"PaymentRequestAccessTokenResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/order/paymentRequests/mandates","fullPath":"/api/v2.1.0/order/paymentRequests/mandates","operationId":"getAllMandateRequest","name":"View list of all mandates","summary":"View list of all mandates","tags":["OTHERS"],"parameters":[{"name":"currentState","in":"query","type":"string","required":false,"description":"Contains the current state of the transaction"},{"name":"customerId","in":"query","type":"string","required":false,"description":"Contains the unique identifier of the customer who has received the payment request (RTP) or credit transfer for which the information request is to be raised."},{"name":"requestToPayScheme","in":"query","type":"string","required":false,"description":"Indicates the scheme in which request to pay message is sent or received"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"AllMandateRequestResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"POST","path":"/order/paymentRequests/mandates","fullPath":"/api/v2.1.0/order/paymentRequests/mandates","operationId":"createMandateRequest","name":"Initiation process to establish mandate between requestor and payer","summary":"Initiation process to establish mandate between requestor and payer","tags":["OTHERS"],"parameters":[{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"endToEndReference":"string","additionalInformationToPayer":"string","requestorName":"string","requestorProxy":"string","requestorAccountNumber":"string","requestorAccountIBAN":"string","payerName":"string","payerProxy":"string","payerAccountNumber":"string","payerAccountIBAN":"string","requestToPayScheme":"string","customerId":"string","currentState":"string","startDate":"string","endDate":"string"}},"responses":{"200":"MandateRequestResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/order/paymentRequests/mandates/{mandateId}","fullPath":"/api/v2.1.0/order/paymentRequests/mandates/{mandateId}","operationId":"updateMandateRequest","name":"Update mandate request status and notes on payer and requestor systems","summary":"Update mandate request status","tags":["OTHERS"],"parameters":[{"name":"mandateId","in":"path","type":"string","required":true,"description":"Contains the mandatory SEPA(Single Euro Payment Area) payment identifier from the transaction"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"messageToPayer":[{}],"messageToRequestor":[{}],"payerResponse":"string","endToEndReference":"string","extensions":{}}},"responses":{"200":"MandateRequestResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"POST","path":"/order/paymentRequests/ukPayments/mandates","fullPath":"/api/v2.1.0/order/paymentRequests/ukPayments/mandates","operationId":"createUkMandateRequest","name":"Initiation process to establish mandate between requestor and payer","summary":"Initiation process to establish mandate between requestor and payer","tags":["OTHERS"],"parameters":[{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"messageToPayer":[{}],"messageToRequestor":[{}],"endToEndReference":"string","requestMessage":"string","role":"string","requestorName":"string","requestorProxy":"string","requestorAccountNumber":"string","requestorAccountIBAN":"string","payerName":"string","payerProxy":"string","payerAccountNumber":"string","payerAccountIBAN":"string","requestToPayScheme":"string","customerId":"string"}},"responses":{"200":"UkMandateRequestResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/order/paymentRequests/ukPayments/mandates/{mandateId}","fullPath":"/api/v2.1.0/order/paymentRequests/ukPayments/mandates/{mandateId}","operationId":"amendUkMandateRequest","name":"Update mandate request status and notes on payer and requestor systems","summary":"Update mandate request status","tags":["OTHERS"],"parameters":[{"name":"mandateId","in":"path","type":"string","required":true,"description":"Contains the mandatory SEPA(Single Euro Payment Area) payment identifier from the transaction"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"messageToPayer":[{}],"messageToRequestor":[{}],"endToEndReference":"string","requestMessage":"string","role":"string","requestorName":"string","requestorProxy":"string","requestorAccountNumber":"string","requestorAccountIBAN":"string","payerName":"string","payerProxy":"string","payerAccountNumber":"string","payerAccountIBAN":"string","requestToPayScheme":"string","customerId":"string"}},"responses":{"200":"UkMandateRequestResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/order/paymentRequests/{requestId}/recalls","fullPath":"/api/v2.1.0/order/paymentRequests/{requestId}/recalls","operationId":"updateRTPRecall","name":"The user can initiate a recall of an already initiated RTP. RTP request can be recalled for various reason such as duplication request, fraudulent request etc.","summary":"Recall RTP request","tags":["OTHERS"],"parameters":[{"name":"requestId","in":"path","type":"string","required":true,"description":""},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"recallId":"Recall ID","requestToPayScheme":"RTP Scheme","requestorResponse":"Requestor response","cancelReason":"Cancel Reason Code","extensions":{}}},"responses":{"200":"RTPRecallResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/order/paymentRequests/sentFiles","fullPath":"/api/v2.1.0/order/paymentRequests/sentFiles","operationId":"getSentFileDetails","name":"Retrieves the list of files related to payment requests sent by the bank","summary":"Retrieve Request to pay (RTP) sent file list","tags":["OTHERS"],"parameters":[{"name":"fileName","in":"query","type":"string","required":false,"description":"Identifies the type of methods to be listed. Possible values are FX.DEAL.METHOD, BROKER or blank."},{"name":"systemFileName","in":"query","type":"string","required":false,"description":"Contains the system generated name for the uploaded file"},{"name":"status","in":"query","type":"string","required":false,"description":"The status of the early maturity request"},{"name":"originalFileReference","in":"query","type":"string","required":false,"description":"Indicates reference of the incoming file for which response is being sent"},{"name":"dateSent","in":"query","type":"string","required":false,"description":"The date when the message is sent."},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"SentFileDetailsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/order/paymentRequests/status","fullPath":"/api/v2.1.0/order/paymentRequests/status","operationId":"getFileSummary","name":"Retrieves status summary of payment requests which were received by the bank as a part of file","summary":"Retrieves status summary of payment requests","tags":["OTHERS"],"parameters":[{"name":"receivedFileId","in":"query","type":"string","required":false,"description":"Indicates id of received file details records"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"FileSummaryResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/order/paymentRequests/receivedFiles","fullPath":"/api/v2.1.0/order/paymentRequests/receivedFiles","operationId":"getReceivedFileDetails","name":"Retrieves the list of files received by the bank for payment requests","summary":"Retrieve Request to pay (RTP) received file list","tags":["OTHERS"],"parameters":[{"name":"fileName","in":"query","type":"string","required":false,"description":"Identifies the type of methods to be listed. Possible values are FX.DEAL.METHOD, BROKER or blank."},{"name":"systemFileName","in":"query","type":"string","required":false,"description":"Contains the system generated name for the uploaded file"},{"name":"messageId","in":"query","type":"string","required":false,"description":"The holds the record key of the message ID."},{"name":"sourceType","in":"query","type":"string","required":false,"description":"Indicates source type to determine base amount. Possible values are BALANCE (base amount of a property), ACTIVITY ( transaction amount against an activity) or PROPERTY (this type is currently not supp"},{"name":"statusCode","in":"query","type":"string","required":false,"description":"Status code, as defined by the institution"},{"name":"userSignOnName","in":"query","type":"string","required":false,"description":"This is the name entered by the User to sign on to the System. It is used by the System as an alternative key to access User details"},{"name":"uploadType","in":"query","type":"string","required":false,"description":"Indicates if the record is created or maintained through an upload or manually. It can contain the following values: Upload \u00e2\u20ac\u201c The record is created through upload. Custom \u00e2\u20ac\u201c The record is created m"},{"name":"countOfRecords","in":"query","type":"string","required":false,"description":"Total count of records information for NOFILE (an enquiry does not exist in a single file) enquiry for online upgrade"},{"name":"customerName","in":"query","type":"string","required":false,"description":"Indicates the name of the customer. Originator is the party who requests the payment cancellation."},{"name":"receivedDateTime","in":"query","type":"string","required":false,"description":"Indicates the date and time when the request to pay message is received for payer and requestor"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"ReceivedFileDetailsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"POST","path":"/order/paymentRequests/ukPayments/billerRequests","fullPath":"/api/v2.1.0/order/paymentRequests/ukPayments/billerRequests","operationId":"createPayUKPaymentRequests","name":"Creates an RTP request at the Repository Service Provider(RSP). The API is for RSP-RSP communication for biller RSP to place RTP request with payer RSP. This is a provider API which can be linked to any published API in accordance to requesttopay.co.uk standards.","summary":"UK RTP scheme request initiation (RSP - RSP)","tags":["OTHERS"],"parameters":[{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"portalInfo":[{}],"errorInfo":[{}],"chargeDetails":[{}],"paymentStatus":[{}],"acceptanceDateTime":[{}],"additionalInfo":[{}],"messageToPayer":[{}],"messageToRequestor":[{}],"paymentReferenceDetails":[{}],"endToEndReference":"string","paymentMethod":"string","requestorBankBic":"string","requestorBankSortCode":"string","requestorAccountIBAN":"string","requestorAccountNumber":"string"}},"responses":{"200":"PayUKPaymentRequestsResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/order/paymentRequests/{requestId}/ukPayments","fullPath":"/api/v2.1.0/order/paymentRequests/{requestId}/ukPayments","operationId":"amendPayUKPaymentForRepository","name":"API to exchange RTP messages between biller RSP and payer RSP. The API can be used for exchanging various follow up messages for an RTP request(subsequent to RTP initiation) such as acceptance of the request in full or partial, denial of a request, exchange of notes, expiry date extension management, payment acknowledgements. This is a provider API which can be linked to any published API in accordance to requesttopay.co.uk standards.","summary":"UK RTP scheme message exchanges between biller and payer (RSP - RSP)","tags":["OTHERS"],"parameters":[{"name":"requestId","in":"path","type":"string","required":true,"description":""},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"portalInfo":[{}],"errorInfo":[{}],"chargeDetails":[{}],"paymentStatus":[{}],"acceptanceDateTime":[{}],"additionalInfo":[{}],"messageToPayer":[{}],"messageToRequestor":[{}],"paymentReferenceDetails":[{}],"endToEndReference":"string","paymentMethod":"string","requestorBankBic":"string","requestorBankSortCode":"string","requestorAccountIBAN":"string","requestorAccountNumber":"string"}},"responses":{"200":"PayUKPaymentForRepositoryResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/order/paymentRequests/payers/status","fullPath":"/api/v2.1.0/order/paymentRequests/payers/status","operationId":"getPayersStatus","name":"Retrieves the list of RTP requests of payer that are pending (that requires action from payer), completed and asked for extension","summary":"Retrieve the list of RTP requests of payer","tags":["OTHERS"],"parameters":[{"name":"currentState","in":"query","type":"string","required":true,"description":"Contains the current state of the transaction"},{"name":"customerId","in":"query","type":"string","required":false,"description":"Contains the unique identifier of the customer who has received the payment request (RTP) or credit transfer for which the information request is to be raised."},{"name":"scheme","in":"query","type":"string","required":false,"description":"Represents the scheme (a synonym for the National ID type) under which the National ID is defined"},{"name":"messageId","in":"query","type":"string","required":false,"description":"The holds the record key of the message ID."},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"PayersStatusResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"POST","path":"/order/paymentRequests","fullPath":"/api/v2.1.0/order/paymentRequests","operationId":"createPaymentRequests","name":"Create payment requests for EBA and UK scheme from biller application","summary":"Initiate a RTP request","tags":["OTHERS"],"parameters":[{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"chargeDetails":[{}],"portalInfo":[{}],"errorInfo":[{}],"payerAddressLines":[{}],"requestorAddressLines":[{}],"ultimatePayerAddressLines":[{}],"ultimateRequestorAddressLines":[{}],"paymentMethod":"string","requestedExecutionDate":"string","payerName":"string","payerStreetName":"string","payerBuildingNumber":"string","payerPostalCode":"string","payerTownName":"string","payerCountry":"string"}},"responses":{"200":"PaymentRequestsResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/order/paymentRequests/{requestId}/billers","fullPath":"/api/v2.1.0/order/paymentRequests/{requestId}/billers","operationId":"getRequestorsOutwardRequest","name":"Retrieves the list of requests sent by the payee with details like payer name, amount, status, expiry date, outstanding amount to pay and the notes exchanged so far with payer.","summary":"Retrieve RTP requests (payee side)","tags":["OTHERS"],"parameters":[{"name":"requestId","in":"path","type":"string","required":true,"description":""},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"RequestorsOutwardRequestResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/order/paymentRequests/{requestId}/payers","fullPath":"/api/v2.1.0/order/paymentRequests/{requestId}/payers","operationId":"getPayersList","name":"Retrieves the RTP requests that are received by the payer in various states like Completed, Partially paid, Extension Granted, Declined, Extension Declined, Asked For Extension and to be used for payer side.","summary":"Retrieve RTP requests (payer side)","tags":["OTHERS"],"parameters":[{"name":"requestId","in":"path","type":"string","required":true,"description":""},{"name":"customerId","in":"query","type":"string","required":false,"description":"Contains the unique identifier of the customer who has received the payment request (RTP) or credit transfer for which the information request is to be raised."},{"name":"scheme","in":"query","type":"string","required":false,"description":"Represents the scheme (a synonym for the National ID type) under which the National ID is defined"},{"name":"requestorReference","in":"query","type":"string","required":false,"description":"Contains the reference of the requestor"},{"name":"currentState","in":"query","type":"string","required":false,"description":"Contains the current state of the transaction"},{"name":"endToEndReference","in":"query","type":"string","required":false,"description":"Indicates the end to end reference for the payment. This field can be provided by the person who instructs the payment and this flows through the lifecycle of the payment."},{"name":"payerProxy","in":"query","type":"string","required":false,"description":"Contains the proxy identification of the payer"},{"name":"orderReference","in":"query","type":"string","required":false,"description":"The  order reference number."},{"name":"messageId","in":"query","type":"string","required":false,"description":"The holds the record key of the message ID."},{"name":"UETRId","in":"query","type":"string","required":false,"description":"Contains the unique end-to-end transaction reference of the underlying payment request (RTP) or credit transfer transaction for which information request is to be raised."},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"PayersListResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/order/paymentRequests/informationRequests","fullPath":"/api/v2.1.0/order/paymentRequests/informationRequests","operationId":"getInformationRequests","name":"Retrieves the list of information requests sent/received by the bank for payment requests (RTP) and credit transfers.","summary":"Retrieve list of information requests","tags":["OTHERS"],"parameters":[{"name":"informationRequestFor","in":"query","type":"string","required":false,"description":"Indicates whether the information request is being raised for a payment request (RTP) or a credit transfer transaction. Allowed values are 'RTP' in case of payment request and 'CT' in case of credit t"},{"name":"paymentRequestReference","in":"query","type":"string","required":false,"description":"Contains the reference of the payment request (RTP) for which the information request is to be raised."},{"name":"paymentReference","in":"query","type":"string","required":false,"description":"Contains the FT number of the credit transfer transaction for which information request is to be raised."},{"name":"direction","in":"query","type":"string","required":false,"description":"Contains the direction of the information request. Value of 'Outward' indicates that the information request is sent by the Bank. Value of 'Inward' indicates that the request for information is receiv"},{"name":"investigationCaseId","in":"query","type":"string","required":false,"description":"To unambiquously identify the case"},{"name":"status","in":"query","type":"string","required":false,"description":"The status of the early maturity request"},{"name":"creatorType","in":"query","type":"string","required":false,"description":"Indicates whether a party or agent is raising the information request. Allowed values are 'P' for party and 'A' for agent."},{"name":"creatorName","in":"query","type":"string","required":false,"description":"Contains the name of customer or agent who is raising the information request."},{"name":"customerId","in":"query","type":"string","required":false,"description":"Contains the unique identifier of the customer who has received the payment request (RTP) or credit transfer for which the information request is to be raised."},{"name":"reasonCode","in":"query","type":"string","required":false,"description":"Contains the reason for raising the information request in a coded form."},{"name":"clearingId","in":"query","type":"string","required":false,"description":"Contains the identifier of the RTP scheme in case information request is for a RTP request. If the information request is for a credit transfer transaction, it contains the identifier of the clearing."},{"name":"paymentCurrency","in":"query","type":"string","required":false,"description":"This field holds the transaction currency or currency in which payment is initiated. "},{"name":"amount","in":"query","type":"string","required":false,"description":"Contains the direct debit claim amount"},{"name":"endToEndReference","in":"query","type":"string","required":false,"description":"Indicates the end to end reference for the payment. This field can be provided by the person who instructs the payment and this flows through the lifecycle of the payment."},{"name":"UETRId","in":"query","type":"string","required":false,"description":"Contains the unique end-to-end transaction reference of the underlying payment request (RTP) or credit transfer transaction for which information request is to be raised."},{"name":"originalMessageReference","in":"query","type":"string","required":false,"description":"Contains the unique identifier of the underlying payment request (RTP) or credit transfer message."},{"name":"response","in":"query","type":"string","required":false,"description":"The OFS response sent from T24 for the request sent for funds reservation or deletion of the reservation"},{"name":"requestDate","in":"query","type":"string","required":false,"description":"Contains the date when the information request was sent by the bank."},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"InformationRequestsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"POST","path":"/order/paymentRequests/informationRequests","fullPath":"/api/v2.1.0/order/paymentRequests/informationRequests","operationId":"createInformationRequest","name":"Initiate an information request for a received payment request (RTP) or credit transfer.","summary":"Initiate an information request for a received payment request (RTP) or credit transfer.","tags":["OTHERS"],"parameters":[{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"reasonCodes":[{}],"additionalInformations":[{}],"creatorUnstructuredAddresses":[{}],"creatorOrgOtherIds":[{}],"creatorOrgOtherSchemeCodes":[{}],"creatorOrgOtherSchemeProprietaries":[{}],"creatorOrgOtherIssuers":[{}],"creatorPvtOtherIdentifications":[{}],"creatorPvtOtherSchemeCodes":[{}],"creatorPvtOtherSchemeProprietaries":[{}],"creatorPvtOtherIssuers":[{}],"ReqAssignmentIDs":[{}],"investigationcaseids":[{}],"requestIds":[{}],"informationRequestFor":"string"}},"responses":{"200":"InformationRequestResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/order/paymentRequests/informationRequests/{paymentRequestReference}","fullPath":"/api/v2.1.0/order/paymentRequests/informationRequests/{paymentRequestReference}","operationId":"updateRequestOrderDetails","name":"Amend details of payment request (RTP) with the reference of an information request","summary":"Amend details of payment request","tags":["OTHERS"],"parameters":[{"name":"paymentRequestReference","in":"path","type":"string","required":true,"description":"Contains the reference of the payment request (RTP) for which the information request is to be raised."},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"informationRequestId":"string","requestedExecutionDate":"string","expiryDate":"string","payerName":"string","payerAccountNumber":"string","payerAccountIBAN":"string","ultimatePayerName":"string","remittanceInformation":"string","remittanceLocationDetails":"string","requestorName":"string","ultimateRequestorName":"string","extensions":{}}},"responses":{"200":"RequestOrderDetailsResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/order/paymentRequests/informationRequests/{informationRequestId}/responses","fullPath":"/api/v2.1.0/order/paymentRequests/informationRequests/{informationRequestId}/responses","operationId":"updateInformationRequest","name":"Updates the underlying information request with the response provided by the receiver of the information request. Following the update, response message is generated and sent to the sender of information request.","summary":"Send response to an information request","tags":["OTHERS"],"parameters":[{"name":"informationRequestId","in":"path","type":"string","required":true,"description":"Contains the unique identifier of the information request. For information requests which are sent by the bank, this is auto generated by system. For information requests received by the bank, this is"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"responses":[{}],"supplementaryInformations":[{}],"extensions":{}}},"responses":{"200":"InformationRequestResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/order/paymentRequests/schemes/returnCodes","fullPath":"/api/v2.1.0/order/paymentRequests/schemes/returnCodes","operationId":"getSchemeReturnCodes","name":"Retrieves the list of return codes configured for a particular clearing scheme. The return codes will be used in processing Request to pay (RTP) rejects and  recall processing.","summary":"Retrieve Request to pay (RTP) scheme return code details","tags":["OTHERS"],"parameters":[{"name":"requestToPayScheme","in":"query","type":"string","required":false,"description":"Indicates the scheme in which request to pay message is sent or received"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"SchemeReturnCodesResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/order/paymentRequests/schemes","fullPath":"/api/v2.1.0/order/paymentRequests/schemes","operationId":"getSchemeDetails","name":"Retrieves the configured details for the Request to pay (RTP) scheme such as connectivity model, response type and validations","summary":"Request to pay (RTP) scheme details","tags":["OTHERS"],"parameters":[{"name":"scheme","in":"query","type":"string","required":false,"description":"Represents the scheme (a synonym for the National ID type) under which the National ID is defined"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"SchemeDetailsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}}]},{"key":"RequestToPayPayments-v2.2.0","title":"Request to Pay","version":"v2.2.0","description":"Request To Pay (RTP) is a Temenos Payments application that helps Temenos bank manage their request to pay functionality. It provides RTP functionality and information exchange between the actor (payer or payee) and the RTP clearing. This page lists the APIs offered by Temenos RTP Application to con","endpointCount":39,"endpoints":[{"method":"PUT","path":"/order/paymentRequests/{requestId}/payments","fullPath":"/api/v2.2.0/order/paymentRequests/{requestId}/payments","operationId":"updateFullPayment","name":"Enables the payer to accept RTP Request and pay the outstanding amount","summary":"Accept the RTP request with full amount","tags":["OTHERS"],"parameters":[{"name":"requestId","in":"path","type":"string","required":true,"description":"The guarantees issuance id initiated by internet banking"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"additionalInfo":[{}],"debitAccount":"string","paymentReference":"string","amountModifiedByPayer":"string","payerAccountIBAN":"string","paymentDate":"string","token":"string","paymentTime":"string","paymentOrderProduct":"string","extensions":{}}},"responses":{"200":"FullPaymentResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/order/paymentRequests/{requestId}/partialPayments","fullPath":"/api/v2.2.0/order/paymentRequests/{requestId}/partialPayments","operationId":"updatePartialPayment","name":"Enables the payer to accept RTP request and pay partial amount. The original request sent by the biller remains open until the total amount is paid by the payer","summary":"Accept the RTP request and pay partially","tags":["OTHERS"],"parameters":[{"name":"requestId","in":"path","type":"string","required":true,"description":"The guarantees issuance id initiated by internet banking"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"additionalInfo":[{}],"debitAmount":"string","debitAccount":"string","paymentReference":"string","payerResponse":"string","amountModifiedByPayer":"string","payerAccountIBAN":"string","paymentDate":"string","token":"string","instructedAmount":"string","paymentTime":"string","paymentOrderProduct":"string","extensions":{}}},"responses":{"200":"PartialPaymentResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/order/paymentRequests/{requestId}/declinedRequests","fullPath":"/api/v2.2.0/order/paymentRequests/{requestId}/declinedRequests","operationId":"updateDeclinePayment","name":"Enables the payer to decline RTP request when payer does not wish to make any payment towards that request","summary":"Decline a RTP request from payee","tags":["OTHERS"],"parameters":[{"name":"requestId","in":"path","type":"string","required":true,"description":"The guarantees issuance id initiated by internet banking"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"additionalInfoToRequestor":[{}],"payerResponse":"string","token":"string","rejectReasonCode":"string","extensions":{}}},"responses":{"200":"DeclinePaymentResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/order/paymentRequests/{requestId}/billerNotes","fullPath":"/api/v2.2.0/order/paymentRequests/{requestId}/billerNotes","operationId":"updateNotesToRequestor","name":"Enables the payer to send messages to payee when the payer requires further information regarding a specific RTP request","summary":"Send notes/additional information to payee","tags":["OTHERS"],"parameters":[{"name":"requestId","in":"path","type":"string","required":true,"description":"The guarantees issuance id initiated by internet banking"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"notesToRequestor":[{}],"payerResponse":"string","token":"string","extensions":{}}},"responses":{"200":"NotesToRequestorResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/order/paymentRequests/{requestId}/amountModifications","fullPath":"/api/v2.2.0/order/paymentRequests/{requestId}/amountModifications","operationId":"updatePaymentAmount","name":"Enables the payer to modify the amount requested by payee in the original RTP request, if modification is allowed by the payee and the corresponding RTP scheme","summary":"Modify the requested amount in the RTP request","tags":["OTHERS"],"parameters":[{"name":"requestId","in":"path","type":"string","required":true,"description":"The guarantees issuance id initiated by internet banking"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"debitAccount":"string","payerAccountIBAN":"string","amountModifiedByPayer":"string","debitAmount":"string","paymentDate":"string","paymentTime":"string","paymentOrderProduct":"string","extensions":{}}},"responses":{"200":"PaymentAmountResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/order/paymentRequests/{requestId}/blocks","fullPath":"/api/v2.2.0/order/paymentRequests/{requestId}/blocks","operationId":"updateDeclineAndBlock","name":"Enables the payer to decline the payee's RTP request and block the payee when payer does not want to receive any further RTP requests in future from the specific payee","summary":"Decline the RTP request and block the payee","tags":["OTHERS"],"parameters":[{"name":"requestId","in":"path","type":"string","required":true,"description":"The guarantees issuance id initiated by internet banking"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"additionalInfoToRequestor":[{}],"payerResponse":"string","token":"string","rejectReasonCode":"string","extensions":{}}},"responses":{"200":"DeclineAndBlockResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/order/paymentRequests/{requestId}/payerNotes","fullPath":"/api/v2.2.0/order/paymentRequests/{requestId}/payerNotes","operationId":"updateNotesToPayer","name":"Enables the payee to send notes, additional information to payer when the payee requires further information regarding a specific RTP request","summary":"Send notes / additional information to payer","tags":["OTHERS"],"parameters":[{"name":"requestId","in":"path","type":"string","required":true,"description":"The guarantees issuance id initiated by internet banking"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"notesToPayer":[{}],"payerName":"string","creditAccountId":"string","requestorAccountIBAN":"string","requestorName":"string","requestedExecutionDate":"string","endToEndReference":"string","remittanceInformation":"string","extensions":{}}},"responses":{"200":"NotesToPayerResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/order/paymentRequests/{requestId}/extensions","fullPath":"/api/v2.2.0/order/paymentRequests/{requestId}/extensions","operationId":"updateDateExtension","name":"Enables the payer to request the payee for a new expiry date for the RTP request received","summary":"Request extension of the RTP expiry date","tags":["OTHERS"],"parameters":[{"name":"requestId","in":"path","type":"string","required":true,"description":"The guarantees issuance id initiated by internet banking"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"additionalInfo":[{}],"requestedExpiryDate":"string","payerResponse":"string","token":"string","extensions":{}}},"responses":{"200":"DateExtensionResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/order/paymentRequests/{requestId}/extensions/acceptances","fullPath":"/api/v2.2.0/order/paymentRequests/{requestId}/extensions/acceptances","operationId":"getPayerListWithExtensionGranted","name":"Retrieves the payer RTP requests for which the expiry date extensions have been granted by the payee","summary":"Retrieve RTP requests for which extension is granted","tags":["OTHERS"],"parameters":[{"name":"requestId","in":"path","type":"string","required":true,"description":""},{"name":"customerId","in":"query","type":"string","required":false,"description":"Contains the unique identifier of the customer who has received the payment request (RTP) or credit transfer for which the information request is to be raised."},{"name":"scheme","in":"query","type":"string","required":false,"description":"Represents the scheme (a synonym for the National ID type) under which the National ID is defined"},{"name":"currentState","in":"query","type":"string","required":false,"description":"Contains the current state of the transaction"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"PayerListWithExtensionGrantedResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"PUT","path":"/order/paymentRequests/{requestId}/extensions/acceptances","fullPath":"/api/v2.2.0/order/paymentRequests/{requestId}/extensions/acceptances","operationId":"updateGrantExtension","name":"Enables the payee to approve the expiry date for the RTP request sought by the payer","summary":"Approve the expiry date extension requested by the payer","tags":["OTHERS"],"parameters":[{"name":"requestId","in":"path","type":"string","required":true,"description":"The guarantees issuance id initiated by internet banking"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"additionalInfo":[{}],"extensions":{}}},"responses":{"200":"GrantExtensionResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/order/paymentRequests/{requestId}/extensions/rejections","fullPath":"/api/v2.2.0/order/paymentRequests/{requestId}/extensions/rejections","operationId":"getPayersListWithExtensionDeclined","name":"Retrieves the payer RTP requests for which the expiry date extensions have been declined by the payee","summary":"Retrieve RTP requests for which the extension is declined","tags":["OTHERS"],"parameters":[{"name":"requestId","in":"path","type":"string","required":true,"description":""},{"name":"customerId","in":"query","type":"string","required":false,"description":"Contains the unique identifier of the customer who has received the payment request (RTP) or credit transfer for which the information request is to be raised."},{"name":"scheme","in":"query","type":"string","required":false,"description":"Represents the scheme (a synonym for the National ID type) under which the National ID is defined"},{"name":"currentState","in":"query","type":"string","required":false,"description":"Contains the current state of the transaction"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"PayersListWithExtensionDeclinedResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"PUT","path":"/order/paymentRequests/{requestId}/extensions/rejections","fullPath":"/api/v2.2.0/order/paymentRequests/{requestId}/extensions/rejections","operationId":"updateDeclineExtension","name":"Enables the payee to decline the expiry date for the RTP request sought by the payer","summary":"Decline the expiry date extension requested by payer","tags":["OTHERS"],"parameters":[{"name":"requestId","in":"path","type":"string","required":true,"description":"The guarantees issuance id initiated by internet banking"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"additionalInfo":[{}],"requestorResponse":"string","extensions":{}}},"responses":{"200":"DeclineExtensionResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/order/paymentRequests/{requestId}/billers/acknowledgements","fullPath":"/api/v2.2.0/order/paymentRequests/{requestId}/billers/acknowledgements","operationId":"updateBillerAcknowledgements","name":"Enables the payee to send full acknowledgement to payer when payer has paid full amount and to send partial acknowledgement to payer when payer has paid partial amount","summary":"Acknowledge RTP requests waiting for payment confirmation by payee","tags":["OTHERS"],"parameters":[{"name":"requestId","in":"path","type":"string","required":true,"description":"The guarantees issuance id initiated by internet banking"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"requestorResponse":"string","extensions":{}}},"responses":{"200":"BillerAcknowledgementsResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/order/paymentRequests/{requestId}/billers/pendingAcknowledgements","fullPath":"/api/v2.2.0/order/paymentRequests/{requestId}/billers/pendingAcknowledgements","operationId":"getApiPendingAck","name":"Retrieves the RTP requests which are yet to be acknowledged by the payee for a payment that has come in due to a result of RTP request being accepted by payer. Generally, 'Partially paid' or 'Paid' are the two statuses in which payee can send an acknowledgement message corresponding to a payment received","summary":"RTP requests sent which are pending to be acknowledged by payee as payment received","tags":["OTHERS"],"parameters":[{"name":"requestId","in":"path","type":"string","required":true,"description":""},{"name":"customerId","in":"query","type":"string","required":false,"description":"Contains the unique identifier of the customer who has received the payment request (RTP) or credit transfer for which the information request is to be raised."},{"name":"scheme","in":"query","type":"string","required":false,"description":"Represents the scheme (a synonym for the National ID type) under which the National ID is defined"},{"name":"currentState","in":"query","type":"string","required":false,"description":"Contains the current state of the transaction"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"ApiPendingAckResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/order/paymentRequests/{requestId}/billers/pendingExtensions","fullPath":"/api/v2.2.0/order/paymentRequests/{requestId}/billers/pendingExtensions","operationId":"getRequestorsDateExtension","name":"Retrieves the RTP requests with payee which are awaiting response for RTP expiry date extension. These requests can either be declined or approved by the payee","summary":"Payee's RTP requests awaiting RTP expiry date extension approval","tags":["OTHERS"],"parameters":[{"name":"requestId","in":"path","type":"string","required":true,"description":""},{"name":"customerId","in":"query","type":"string","required":false,"description":"Contains the unique identifier of the customer who has received the payment request (RTP) or credit transfer for which the information request is to be raised."},{"name":"scheme","in":"query","type":"string","required":false,"description":"Represents the scheme (a synonym for the National ID type) under which the National ID is defined"},{"name":"requestorReference","in":"query","type":"string","required":false,"description":"Contains the reference of the requestor"},{"name":"currentState","in":"query","type":"string","required":false,"description":"Contains the current state of the transaction"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"RequestorsDateExtensionResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/order/paymentRequests/{requestId}/errors","fullPath":"/api/v2.2.0/order/paymentRequests/{requestId}/errors","operationId":"getOutwardErrors","name":"Retrieves the RTP requests which are in error status due to technical reasons. Such requests must be checked for the reason for error manually and a new RTP request must be created/initiated by payee to send the request again to payer","summary":"Retrieve the RTP requests in error status","tags":["OTHERS"],"parameters":[{"name":"requestId","in":"path","type":"string","required":true,"description":""},{"name":"customerId","in":"query","type":"string","required":false,"description":"Contains the unique identifier of the customer who has received the payment request (RTP) or credit transfer for which the information request is to be raised."},{"name":"scheme","in":"query","type":"string","required":false,"description":"Represents the scheme (a synonym for the National ID type) under which the National ID is defined"},{"name":"currentState","in":"query","type":"string","required":false,"description":"Contains the current state of the transaction"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"OutwardErrorsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"PUT","path":"/order/paymentRequests/accessTokenRefreshes/{proxyIdentifiers}","fullPath":"/api/v2.2.0/order/paymentRequests/accessTokenRefreshes/{proxyIdentifiers}","operationId":"updatePaymentRequestAccessToken","name":"Update access token and scheme for a specific proxy identifier which in turn triggers the refresh and updation of Request To Pay(RTP) data store","summary":"Refresh and update the Request To Pay(RTP) data store","tags":["OTHERS"],"parameters":[{"name":"proxyIdentifiers","in":"path","type":"string","required":true,"description":"Indicates an information that is unique to a customer, such as mobile number, email id etc"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"token":"string","scheme":"string","extensions":{}}},"responses":{"200":"PaymentRequestAccessTokenResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/order/paymentRequests/mandates","fullPath":"/api/v2.2.0/order/paymentRequests/mandates","operationId":"getAllMandateRequest","name":"View list of all mandates","summary":"View list of all mandates","tags":["OTHERS"],"parameters":[{"name":"currentState","in":"query","type":"string","required":false,"description":"Contains the current state of the transaction"},{"name":"customerId","in":"query","type":"string","required":false,"description":"Contains the unique identifier of the customer who has received the payment request (RTP) or credit transfer for which the information request is to be raised."},{"name":"requestToPayScheme","in":"query","type":"string","required":false,"description":"Indicates the scheme in which request to pay message is sent or received"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"AllMandateRequestResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"POST","path":"/order/paymentRequests/mandates","fullPath":"/api/v2.2.0/order/paymentRequests/mandates","operationId":"createMandateRequest","name":"Initiation process to establish mandate between requestor and payer","summary":"Initiation process to establish mandate between requestor and payer","tags":["OTHERS"],"parameters":[{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"endToEndReference":"string","additionalInformationToPayer":"string","requestorName":"string","requestorProxy":"string","requestorAccountNumber":"string","requestorAccountIBAN":"string","payerName":"string","payerProxy":"string","payerAccountNumber":"string","payerAccountIBAN":"string","requestToPayScheme":"string","customerId":"string","currentState":"string","startDate":"string","endDate":"string"}},"responses":{"200":"MandateRequestResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/order/paymentRequests/mandates/{mandateId}","fullPath":"/api/v2.2.0/order/paymentRequests/mandates/{mandateId}","operationId":"updateMandateRequest","name":"Update mandate request status and notes on payer and requestor systems","summary":"Update mandate request status","tags":["OTHERS"],"parameters":[{"name":"mandateId","in":"path","type":"string","required":true,"description":"Contains the mandatory SEPA(Single Euro Payment Area) payment identifier from the transaction"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"messageToPayer":[{}],"messageToRequestor":[{}],"payerResponse":"string","endToEndReference":"string","extensions":{}}},"responses":{"200":"MandateRequestResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"POST","path":"/order/paymentRequests/ukPayments/mandates","fullPath":"/api/v2.2.0/order/paymentRequests/ukPayments/mandates","operationId":"createUkMandateRequest","name":"Initiation process to establish mandate between requestor and payer","summary":"Initiation process to establish mandate between requestor and payer","tags":["OTHERS"],"parameters":[{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"messageToPayer":[{}],"messageToRequestor":[{}],"endToEndReference":"string","requestMessage":"string","role":"string","requestorName":"string","requestorProxy":"string","requestorAccountNumber":"string","requestorAccountIBAN":"string","payerName":"string","payerProxy":"string","payerAccountNumber":"string","payerAccountIBAN":"string","requestToPayScheme":"string","customerId":"string"}},"responses":{"200":"UkMandateRequestResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/order/paymentRequests/ukPayments/mandates/{mandateId}","fullPath":"/api/v2.2.0/order/paymentRequests/ukPayments/mandates/{mandateId}","operationId":"amendUkMandateRequest","name":"Update mandate request status and notes on payer and requestor systems","summary":"Update mandate request status","tags":["OTHERS"],"parameters":[{"name":"mandateId","in":"path","type":"string","required":true,"description":"Contains the mandatory SEPA(Single Euro Payment Area) payment identifier from the transaction"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"messageToPayer":[{}],"messageToRequestor":[{}],"endToEndReference":"string","requestMessage":"string","role":"string","requestorName":"string","requestorProxy":"string","requestorAccountNumber":"string","requestorAccountIBAN":"string","payerName":"string","payerProxy":"string","payerAccountNumber":"string","payerAccountIBAN":"string","requestToPayScheme":"string","customerId":"string"}},"responses":{"200":"UkMandateRequestResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/order/paymentRequests/{requestId}/recalls","fullPath":"/api/v2.2.0/order/paymentRequests/{requestId}/recalls","operationId":"updateRTPRecall","name":"The user can initiate a recall of an already initiated RTP. RTP request can be recalled for various reason such as duplication request, fraudulent request etc.","summary":"Recall RTP request","tags":["OTHERS"],"parameters":[{"name":"requestId","in":"path","type":"string","required":true,"description":""},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"recallId":"Recall ID","requestToPayScheme":"RTP Scheme","requestorResponse":"Requestor response","cancelReason":"Cancel Reason Code","extensions":{}}},"responses":{"200":"RTPRecallResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/order/paymentRequests/sentFiles","fullPath":"/api/v2.2.0/order/paymentRequests/sentFiles","operationId":"getSentFileDetails","name":"Retrieves the list of files related to payment requests sent by the bank","summary":"Retrieve Request to pay (RTP) sent file list","tags":["OTHERS"],"parameters":[{"name":"fileName","in":"query","type":"string","required":false,"description":"Identifies the type of methods to be listed. Possible values are FX.DEAL.METHOD, BROKER or blank."},{"name":"systemFileName","in":"query","type":"string","required":false,"description":"Contains the system generated name for the uploaded file"},{"name":"status","in":"query","type":"string","required":false,"description":"The status of the early maturity request"},{"name":"originalFileReference","in":"query","type":"string","required":false,"description":"Indicates reference of the incoming file for which response is being sent"},{"name":"dateSent","in":"query","type":"string","required":false,"description":"The date when the message is sent."},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"SentFileDetailsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/order/paymentRequests/status","fullPath":"/api/v2.2.0/order/paymentRequests/status","operationId":"getFileSummary","name":"Retrieves status summary of payment requests which were received by the bank as a part of file","summary":"Retrieves status summary of payment requests","tags":["OTHERS"],"parameters":[{"name":"receivedFileId","in":"query","type":"string","required":false,"description":"Indicates id of received file details records"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"FileSummaryResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/order/paymentRequests/receivedFiles","fullPath":"/api/v2.2.0/order/paymentRequests/receivedFiles","operationId":"getReceivedFileDetails","name":"Retrieves the list of files received by the bank for payment requests","summary":"Retrieve Request to pay (RTP) received file list","tags":["OTHERS"],"parameters":[{"name":"fileName","in":"query","type":"string","required":false,"description":"Identifies the type of methods to be listed. Possible values are FX.DEAL.METHOD, BROKER or blank."},{"name":"systemFileName","in":"query","type":"string","required":false,"description":"Contains the system generated name for the uploaded file"},{"name":"messageId","in":"query","type":"string","required":false,"description":"The holds the record key of the message ID."},{"name":"sourceType","in":"query","type":"string","required":false,"description":"Indicates source type to determine base amount. Possible values are BALANCE (base amount of a property), ACTIVITY ( transaction amount against an activity) or PROPERTY (this type is currently not supp"},{"name":"statusCode","in":"query","type":"string","required":false,"description":"Status code, as defined by the institution"},{"name":"userSignOnName","in":"query","type":"string","required":false,"description":"This is the name entered by the User to sign on to the System. It is used by the System as an alternative key to access User details"},{"name":"uploadType","in":"query","type":"string","required":false,"description":"Indicates if the record is created or maintained through an upload or manually. It can contain the following values: Upload \u00e2\u20ac\u201c The record is created through upload. Custom \u00e2\u20ac\u201c The record is created m"},{"name":"countOfRecords","in":"query","type":"string","required":false,"description":"Total count of records information for NOFILE (an enquiry does not exist in a single file) enquiry for online upgrade"},{"name":"customerName","in":"query","type":"string","required":false,"description":"Indicates the name of the customer. Originator is the party who requests the payment cancellation."},{"name":"receivedDateTime","in":"query","type":"string","required":false,"description":"Indicates the date and time when the request to pay message is received for payer and requestor"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"ReceivedFileDetailsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"POST","path":"/order/paymentRequests/ukPayments/billerRequests","fullPath":"/api/v2.2.0/order/paymentRequests/ukPayments/billerRequests","operationId":"createPayUKPaymentRequests","name":"Creates an RTP request at the Repository Service Provider(RSP). The API is for RSP-RSP communication for biller RSP to place RTP request with payer RSP. This is a provider API which can be linked to any published API in accordance to requesttopay.co.uk standards.","summary":"UK RTP scheme request initiation (RSP - RSP)","tags":["OTHERS"],"parameters":[{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"portalInfo":[{}],"errorInfo":[{}],"chargeDetails":[{}],"paymentStatus":[{}],"acceptanceDateTime":[{}],"additionalInfo":[{}],"messageToPayer":[{}],"messageToRequestor":[{}],"paymentReferenceDetails":[{}],"endToEndReference":"string","paymentMethod":"string","requestorBankBic":"string","requestorBankSortCode":"string","requestorAccountIBAN":"string","requestorAccountNumber":"string"}},"responses":{"200":"PayUKPaymentRequestsResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/order/paymentRequests/{requestId}/ukPayments","fullPath":"/api/v2.2.0/order/paymentRequests/{requestId}/ukPayments","operationId":"amendPayUKPaymentForRepository","name":"API to exchange RTP messages between biller RSP and payer RSP. The API can be used for exchanging various follow up messages for an RTP request(subsequent to RTP initiation) such as acceptance of the request in full or partial, denial of a request, exchange of notes, expiry date extension management, payment acknowledgements. This is a provider API which can be linked to any published API in accordance to requesttopay.co.uk standards.","summary":"UK RTP scheme message exchanges between biller and payer (RSP - RSP)","tags":["OTHERS"],"parameters":[{"name":"requestId","in":"path","type":"string","required":true,"description":""},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"portalInfo":[{}],"errorInfo":[{}],"chargeDetails":[{}],"paymentStatus":[{}],"acceptanceDateTime":[{}],"additionalInfo":[{}],"messageToPayer":[{}],"messageToRequestor":[{}],"paymentReferenceDetails":[{}],"endToEndReference":"string","paymentMethod":"string","requestorBankBic":"string","requestorBankSortCode":"string","requestorAccountIBAN":"string","requestorAccountNumber":"string"}},"responses":{"200":"PayUKPaymentForRepositoryResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/order/paymentRequests/payers/status","fullPath":"/api/v2.2.0/order/paymentRequests/payers/status","operationId":"getPayersStatus","name":"Retrieves the list of RTP requests of payer that are pending (that requires action from payer), completed and asked for extension","summary":"Retrieve the list of RTP requests of payer","tags":["OTHERS"],"parameters":[{"name":"currentState","in":"query","type":"string","required":true,"description":"Contains the current state of the transaction"},{"name":"customerId","in":"query","type":"string","required":false,"description":"Contains the unique identifier of the customer who has received the payment request (RTP) or credit transfer for which the information request is to be raised."},{"name":"scheme","in":"query","type":"string","required":false,"description":"Represents the scheme (a synonym for the National ID type) under which the National ID is defined"},{"name":"messageId","in":"query","type":"string","required":false,"description":"The holds the record key of the message ID."},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"PayersStatusResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"POST","path":"/order/paymentRequests","fullPath":"/api/v2.2.0/order/paymentRequests","operationId":"createPaymentRequests","name":"Create payment requests for EBA and UK scheme from biller application","summary":"Initiate a RTP request","tags":["OTHERS"],"parameters":[{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"chargeDetails":[{}],"portalInfo":[{}],"errorInfo":[{}],"payerAddressLines":[{}],"requestorAddressLines":[{}],"ultimatePayerAddressLines":[{}],"ultimateRequestorAddressLines":[{}],"paymentMethod":"string","requestedExecutionDate":"string","payerName":"string","payerStreetName":"string","payerBuildingNumber":"string","payerPostalCode":"string","payerTownName":"string","payerCountry":"string"}},"responses":{"200":"PaymentRequestsResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/order/paymentRequests/informationRequests","fullPath":"/api/v2.2.0/order/paymentRequests/informationRequests","operationId":"getInformationRequests","name":"Retrieves the list of information requests sent/received by the bank for payment requests (RTP) and credit transfers.","summary":"Retrieve list of information requests","tags":["OTHERS"],"parameters":[{"name":"informationRequestFor","in":"query","type":"string","required":false,"description":"Indicates whether the information request is being raised for a payment request (RTP) or a credit transfer transaction. Allowed values are 'RTP' in case of payment request and 'CT' in case of credit t"},{"name":"paymentRequestReference","in":"query","type":"string","required":false,"description":"Contains the reference of the payment request (RTP) for which the information request is to be raised."},{"name":"paymentReference","in":"query","type":"string","required":false,"description":"Contains the FT number of the credit transfer transaction for which information request is to be raised."},{"name":"direction","in":"query","type":"string","required":false,"description":"Contains the direction of the information request. Value of 'Outward' indicates that the information request is sent by the Bank. Value of 'Inward' indicates that the request for information is receiv"},{"name":"investigationCaseId","in":"query","type":"string","required":false,"description":"To unambiquously identify the case"},{"name":"status","in":"query","type":"string","required":false,"description":"The status of the early maturity request"},{"name":"creatorType","in":"query","type":"string","required":false,"description":"Indicates whether a party or agent is raising the information request. Allowed values are 'P' for party and 'A' for agent."},{"name":"creatorName","in":"query","type":"string","required":false,"description":"Contains the name of customer or agent who is raising the information request."},{"name":"customerId","in":"query","type":"string","required":false,"description":"Contains the unique identifier of the customer who has received the payment request (RTP) or credit transfer for which the information request is to be raised."},{"name":"reasonCode","in":"query","type":"string","required":false,"description":"Contains the reason for raising the information request in a coded form."},{"name":"clearingId","in":"query","type":"string","required":false,"description":"Contains the identifier of the RTP scheme in case information request is for a RTP request. If the information request is for a credit transfer transaction, it contains the identifier of the clearing."},{"name":"paymentCurrency","in":"query","type":"string","required":false,"description":"This field holds the transaction currency or currency in which payment is initiated. "},{"name":"amount","in":"query","type":"string","required":false,"description":"Contains the direct debit claim amount"},{"name":"endToEndReference","in":"query","type":"string","required":false,"description":"Indicates the end to end reference for the payment. This field can be provided by the person who instructs the payment and this flows through the lifecycle of the payment."},{"name":"UETRId","in":"query","type":"string","required":false,"description":"Contains the unique end-to-end transaction reference of the underlying payment request (RTP) or credit transfer transaction for which information request is to be raised."},{"name":"originalMessageReference","in":"query","type":"string","required":false,"description":"Contains the unique identifier of the underlying payment request (RTP) or credit transfer message."},{"name":"response","in":"query","type":"string","required":false,"description":"The OFS response sent from T24 for the request sent for funds reservation or deletion of the reservation"},{"name":"requestDate","in":"query","type":"string","required":false,"description":"Contains the date when the information request was sent by the bank."},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"InformationRequestsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"POST","path":"/order/paymentRequests/informationRequests","fullPath":"/api/v2.2.0/order/paymentRequests/informationRequests","operationId":"createInformationRequest","name":"Initiate an information request for a received payment request (RTP) or credit transfer.","summary":"Initiate an information request for a received payment request (RTP) or credit transfer.","tags":["OTHERS"],"parameters":[{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"reasonCodes":[{}],"additionalInformations":[{}],"creatorUnstructuredAddresses":[{}],"creatorOrgOtherIds":[{}],"creatorOrgOtherSchemeCodes":[{}],"creatorOrgOtherSchemeProprietaries":[{}],"creatorOrgOtherIssuers":[{}],"creatorPvtOtherIdentifications":[{}],"creatorPvtOtherSchemeCodes":[{}],"creatorPvtOtherSchemeProprietaries":[{}],"creatorPvtOtherIssuers":[{}],"ReqAssignmentIDs":[{}],"investigationcaseids":[{}],"requestIds":[{}],"informationRequestFor":"string"}},"responses":{"200":"InformationRequestResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/order/paymentRequests/informationRequests/{paymentRequestReference}","fullPath":"/api/v2.2.0/order/paymentRequests/informationRequests/{paymentRequestReference}","operationId":"updateRequestOrderDetails","name":"Amend details of payment request (RTP) with the reference of an information request","summary":"Amend details of payment request","tags":["OTHERS"],"parameters":[{"name":"paymentRequestReference","in":"path","type":"string","required":true,"description":"Contains the reference of the payment request (RTP) for which the information request is to be raised."},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"informationRequestId":"string","requestedExecutionDate":"string","expiryDate":"string","payerName":"string","payerAccountNumber":"string","payerAccountIBAN":"string","ultimatePayerName":"string","remittanceInformation":"string","remittanceLocationDetails":"string","requestorName":"string","ultimateRequestorName":"string","extensions":{}}},"responses":{"200":"RequestOrderDetailsResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/order/paymentRequests/informationRequests/{informationRequestId}/responses","fullPath":"/api/v2.2.0/order/paymentRequests/informationRequests/{informationRequestId}/responses","operationId":"updateInformationRequest","name":"Updates the underlying information request with the response provided by the receiver of the information request. Following the update, response message is generated and sent to the sender of information request.","summary":"Send response to an information request","tags":["OTHERS"],"parameters":[{"name":"informationRequestId","in":"path","type":"string","required":true,"description":"Contains the unique identifier of the information request. For information requests which are sent by the bank, this is auto generated by system. For information requests received by the bank, this is"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"responses":[{}],"supplementaryInformations":[{}],"extensions":{}}},"responses":{"200":"InformationRequestResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/order/paymentRequests/schemes/returnCodes","fullPath":"/api/v2.2.0/order/paymentRequests/schemes/returnCodes","operationId":"getSchemeReturnCodes","name":"Retrieves the list of return codes configured for a particular clearing scheme. The return codes will be used in processing Request to pay (RTP) rejects and  recall processing.","summary":"Retrieve Request to pay (RTP) scheme return code details","tags":["OTHERS"],"parameters":[{"name":"requestToPayScheme","in":"query","type":"string","required":false,"description":"Indicates the scheme in which request to pay message is sent or received"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"SchemeReturnCodesResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/order/paymentRequests/schemes","fullPath":"/api/v2.2.0/order/paymentRequests/schemes","operationId":"getSchemeDetails","name":"Retrieves the configured details for the Request to pay (RTP) scheme such as connectivity model, response type and validations","summary":"Request to pay (RTP) scheme details","tags":["OTHERS"],"parameters":[{"name":"scheme","in":"query","type":"string","required":false,"description":"Represents the scheme (a synonym for the National ID type) under which the National ID is defined"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"SchemeDetailsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"PUT","path":"/order/paymentRequests/{requestId}/receipts","fullPath":"/api/v2.2.0/order/paymentRequests/{requestId}/receipts","operationId":"updatePayerReceipts","name":"Allows amending the received payment request (RTP) based on different payer actions such as request to pay message read.","summary":"Amend read receipt for a payment request","tags":["OTHERS"],"parameters":[{"name":"requestId","in":"path","type":"string","required":true,"description":"The guarantees issuance id initiated by internet banking"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"payerReadReceipt":"string","extensions":{}}},"responses":{"200":"PayerReceiptsResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/order/paymentRequests/{requestId}/billers","fullPath":"/api/v2.2.0/order/paymentRequests/{requestId}/billers","operationId":"getRequestorsOutwardRequest","name":"Retrieves the list of requests sent by the payee with details like payer name, amount, status, expiry date, outstanding amount to pay and the notes exchanged so far with payer.","summary":"Retrieve RTP requests (payee side)","tags":["OTHERS"],"parameters":[{"name":"requestId","in":"path","type":"string","required":true,"description":""},{"name":"currentState","in":"query","type":"string","required":false,"description":"Contains the current state of the transaction"},{"name":"customerId","in":"query","type":"string","required":false,"description":"Contains the unique identifier of the customer who has received the payment request (RTP) or credit transfer for which the information request is to be raised."},{"name":"scheme","in":"query","type":"string","required":false,"description":"Represents the scheme (a synonym for the National ID type) under which the National ID is defined"},{"name":"endToEndReference","in":"query","type":"string","required":false,"description":"Indicates the end to end reference for the payment. This field can be provided by the person who instructs the payment and this flows through the lifecycle of the payment."},{"name":"messageId","in":"query","type":"string","required":false,"description":"The holds the record key of the message ID."},{"name":"UETRId","in":"query","type":"string","required":false,"description":"Contains the unique end-to-end transaction reference of the underlying payment request (RTP) or credit transfer transaction for which information request is to be raised."},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"RequestorsOutwardRequestResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/order/paymentRequests/{requestId}/payers","fullPath":"/api/v2.2.0/order/paymentRequests/{requestId}/payers","operationId":"getPayersList","name":"Retrieves the RTP requests that are received by the payer in various states like Completed, Partially paid, Extension Granted, Declined, Extension Declined, Asked For Extension and to be used for payer side.","summary":"Retrieve RTP requests (payer side)","tags":["OTHERS"],"parameters":[{"name":"requestId","in":"path","type":"string","required":true,"description":""},{"name":"customerId","in":"query","type":"string","required":false,"description":"Contains the unique identifier of the customer who has received the payment request (RTP) or credit transfer for which the information request is to be raised."},{"name":"scheme","in":"query","type":"string","required":false,"description":"Represents the scheme (a synonym for the National ID type) under which the National ID is defined"},{"name":"requestorReference","in":"query","type":"string","required":false,"description":"Contains the reference of the requestor"},{"name":"currentState","in":"query","type":"string","required":false,"description":"Contains the current state of the transaction"},{"name":"endToEndReference","in":"query","type":"string","required":false,"description":"Indicates the end to end reference for the payment. This field can be provided by the person who instructs the payment and this flows through the lifecycle of the payment."},{"name":"payerProxy","in":"query","type":"string","required":false,"description":"Contains the proxy identification of the payer"},{"name":"orderReference","in":"query","type":"string","required":false,"description":"The  order reference number."},{"name":"messageId","in":"query","type":"string","required":false,"description":"The holds the record key of the message ID."},{"name":"UETRId","in":"query","type":"string","required":false,"description":"Contains the unique end-to-end transaction reference of the underlying payment request (RTP) or credit transfer transaction for which information request is to be raised."},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"PayersListResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}}]}]},{"name":"Serviceautomationenquiries","serviceCount":1,"endpointCount":9,"services":[{"key":"ServiceautomationEnquiries-v2.0.0","title":"Serviceautomation","version":"v2.0.0","description":"Allows the viewing of the available services , their status and workload profiles,the company's Close Of Business Status , Job time progress and report(Deprecated- A newer version V2.0.2 available)","endpointCount":9,"endpoints":[{"method":"GET","path":"/system/services","fullPath":"/api/v2.0.0/system/services","operationId":"getAvailableServices","name":"Retrieves a list of all available services in system.","summary":"Retrieves a list of all available services in system.(Deprecated- A newer version V2.0.2 available)","tags":[],"parameters":[{"name":"serviceId","in":"query","type":"string","required":false,"description":"Contains the identifier name of the service that has to be executed."},{"name":"serverName","in":"query","type":"string","required":false,"description":"Contains the name of the Server on which the service will run."},{"name":"serverStatus","in":"query","type":"string","required":false,"description":"Status of Server  POSSIBLE VALUES: ACTIVE: To set the server as active INACTIVE: To set the server as inactive"},{"name":"workloadProfileId","in":"query","type":"string","required":false,"description":"The ID of a record that is in a multithreaded process"},{"name":"processStatus","in":"query","type":"string","required":false,"description":"Contains the current process status. Allowed values: - 0: Ready - 1: Running - 2: Completed successfully - 3: On hold or in error"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from t24 on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"The identifier of the underlying Entity/Company/Branch."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"AvailableServicesResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/system/services/{serviceId}","fullPath":"/api/v2.0.0/system/services/{serviceId}","operationId":"getAvailableService","name":"Retrieves the details of a specific service ","summary":"Retrieves the details of a specific service(Deprecated- A newer version V2.0.2 available)","tags":[],"parameters":[{"name":"serviceId","in":"path","type":"string","required":true,"description":"Contains the identifier name of the service that has to be executed."},{"name":"serverName","in":"query","type":"string","required":false,"description":"Contains the name of the Server on which the service will run."},{"name":"serverStatus","in":"query","type":"string","required":false,"description":"Status of Server  POSSIBLE VALUES: ACTIVE: To set the server as active INACTIVE: To set the server as inactive"},{"name":"workloadProfileId","in":"query","type":"string","required":false,"description":"The ID of a record that is in a multithreaded process"},{"name":"processStatus","in":"query","type":"string","required":false,"description":"Contains the current process status. Allowed values: - 0: Ready - 1: Running - 2: Completed successfully - 3: On hold or in error"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from t24 on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"The identifier of the underlying Entity/Company/Branch."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"AvailableServiceResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/system/services/{serviceId}/status","fullPath":"/api/v2.0.0/system/services/{serviceId}/status","operationId":"getServiceStatus","name":"Retrieves a detailed status of the specified service","summary":"Retrieves a detailed status of the specified service(Deprecated- A newer version V2.0.2 available)","tags":[],"parameters":[{"name":"serviceId","in":"path","type":"string","required":true,"description":"Contains the identifier name of the service that has to be executed."},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from t24 on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"The identifier of the underlying Entity/Company/Branch."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"ServiceStatusResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/system/services/status","fullPath":"/api/v2.0.0/system/services/status","operationId":"getServicesStatus","name":"Retrieves  status of all the services","summary":"Retrieves  status of all the services(Deprecated- A newer version V2.0.2 available)","tags":[],"parameters":[{"name":"serviceId","in":"query","type":"string","required":true,"description":"Contains the identifier name of the service that has to be executed."},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from t24 on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"The identifier of the underlying Entity/Company/Branch."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"ServicesStatusResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/system/services/workProfiles","fullPath":"/api/v2.0.0/system/services/workProfiles","operationId":"getWorkLoadProfiles","name":"Retrieves list of all service workload profiles available in system","summary":"Retrieves list of all service workload profiles available in system(Deprecated- A newer version V2.0.2 available)","tags":[],"parameters":[{"name":"workloadProfileId","in":"query","type":"string","required":false,"description":"The ID of a record that is in a multithreaded process"},{"name":"agentsRequired","in":"query","type":"string","required":false,"description":"Contains the number of agents required"},{"name":"workLoadProfileTime","in":"query","type":"string","required":false,"description":"The time a multithreaded process takes."},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from t24 on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"The identifier of the underlying Entity/Company/Branch."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"WorkLoadProfilesResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/system/services/workProfiles/{workProfileId}","fullPath":"/api/v2.0.0/system/services/workProfiles/{workProfileId}","operationId":"getWorkLoadProfile","name":"Retrieves a specific workload profile ","summary":"Retrieves a specific workload profile (Deprecated- A newer version V2.0.2 available)","tags":[],"parameters":[{"name":"workProfileId","in":"path","type":"string","required":true,"description":"Contains the reference to the record in service workload profiles for services."},{"name":"agentsRequired","in":"query","type":"string","required":false,"description":"Contains the number of agents required"},{"name":"workLoadProfileTime","in":"query","type":"string","required":false,"description":"The time a multithreaded process takes."},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from t24 on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"The identifier of the underlying Entity/Company/Branch."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"WorkLoadProfileResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/system/services/{servicesId}/companies/{companyId}","fullPath":"/api/v2.0.0/system/services/{servicesId}/companies/{companyId}","operationId":"getCompanyCloseBusinessStatus","name":"Retrieves any logged error messages for a company during the Close of Business processing","summary":"Retrieves any logged error messages for a company during the Close of Business processing(Deprecated- A newer version V2.0.2 available)","tags":[],"parameters":[{"name":"servicesId","in":"path","type":"string","required":true,"description":""},{"name":"companyId","in":"path","type":"string","required":true,"description":"The identifier of the underlying Entity/Company/Branch."},{"name":"cobDate","in":"query","type":"string","required":false,"description":"The time and date on which the error occurred. The information in this field will hold the machine date and time, not the system date."},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from t24 on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"The identifier of the underlying Entity/Company/Branch."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"CompanyCloseBusinessStatusResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/system/services/jobtimes","fullPath":"/api/v2.0.0/system/services/jobtimes","operationId":"getJobTimes","name":"Retrieves a list of all available executed process times in system","summary":"Retrieves a list of all available executed process times in system(Deprecated- A newer version V2.0.2 available)","tags":[],"parameters":[{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from t24 on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"The identifier of the underlying Entity/Company/Branch."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"JobTimesResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/system/services/reportTimes","fullPath":"/api/v2.0.0/system/services/reportTimes","operationId":"getReportTimes","name":"Retrieves a list of elapsed times for reports generated during close of business processing","summary":"Retrieves a list of elapsed times for reports generated during close of business processing(Deprecated- A newer version V2.0.2 available)","tags":[],"parameters":[{"name":"batchDate","in":"query","type":"string","required":false,"description":"The bank date on which the particular report was generated."},{"name":"report","in":"query","type":"string","required":false,"description":"Contains the name of the process that produces the report"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from t24 on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"The identifier of the underlying Entity/Company/Branch."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"ReportTimesResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}}]}]},{"name":"Serviceautomationversions","serviceCount":1,"endpointCount":6,"services":[{"key":"ServiceautomationVersions-v2.0.0","title":"Serviceautomation","version":"v2.0.0","description":"Allows the creation and updation of Close of Business Process, Services and Workload Profiles(Deprecated- A newer version V2.0.2 available)","endpointCount":6,"endpoints":[{"method":"POST","path":"/system/services/processes/{processId}","fullPath":"/api/v2.0.0/system/services/processes/{processId}","operationId":"createCloseOfBusinessProcess","name":"Create new process in system","summary":"Create new process in system(Deprecated- A newer version V2.0.2 available)","tags":[],"parameters":[{"name":"processId","in":"path","type":"string","required":true,"description":""},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"The identifier of the underlying Entity/Company/Branch."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"batchStage":"string","batchEnvironment":"B","jobId":"string","verificationJobId":"string","jobFrequency":"string","nextRunDate":"2024-01-01","data":"string","userId":"string","recordStatus":"string","currNo":"string","inputter":"string","authoriser":"string","dateTime":"2024-01-01","companyId":"string","deptCode":"string"}},"responses":{"200":"CloseOfBusinessProcessResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/system/services/processes/{processId}","fullPath":"/api/v2.0.0/system/services/processes/{processId}","operationId":"updateCloseOfBusinessProcess","name":"Update process record in system","summary":"Update process record in system(Deprecated- A newer version V2.0.2 available)","tags":[],"parameters":[{"name":"processId","in":"path","type":"string","required":true,"description":"Contains the process identifier"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"The identifier of the underlying Entity/Company/Branch."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"batchStage":"string","batchEnvironment":"B","jobId":"string","verificationJobId":"string","jobFrequency":"string","nextRunDate":"2024-01-01","data":"string","userId":"string","recordStatus":"string","currNo":"string","inputter":"string","authoriser":"string","dateTime":"2024-01-01","companyId":"string","deptCode":"string"}},"responses":{"200":"CloseOfBusinessProcessResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"POST","path":"/system/services/{serviceId}","fullPath":"/api/v2.0.0/system/services/{serviceId}","operationId":"createService","name":"Create new service in system","summary":"Create new service in system(Deprecated- A newer version V2.0.2 available)","tags":[],"parameters":[{"name":"serviceId","in":"path","type":"string","required":true,"description":""},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"The identifier of the underlying Entity/Company/Branch."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"jobServerProfiles":[{}],"serviceDescription":"string","userId":"string","jobOperation":"START","recordStatus":"Status of record -authorised/on hold/unauth etc","currNo":"No of times record has been changed","inputter":"User who has input or changed the record","dateTime":"2024-01-01","authoriser":"User who has authorised the input or change","deptCode":"Department handling the record","auditorCode":"Code of Auditor who has audited the record","auditTimeDate":"2024-01-01"}},"responses":{"200":"ServiceResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/system/services/{serviceId}","fullPath":"/api/v2.0.0/system/services/{serviceId}","operationId":"updateService","name":"Update a service in the system ","summary":"Update a service in the system (Deprecated- A newer version V2.0.2 available)","tags":[],"parameters":[{"name":"serviceId","in":"path","type":"string","required":true,"description":""},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"The identifier of the underlying Entity/Company/Branch."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"jobServerProfiles":[{}],"serviceDescription":"string","userId":"string","jobOperation":"START","recordStatus":"Status of record -authorised/on hold/unauth etc","currNo":"No of times record has been changed","inputter":"User who has input or changed the record","dateTime":"2024-01-01","authoriser":"User who has authorised the input or change","deptCode":"Department handling the record","auditorCode":"Code of Auditor who has audited the record","auditTimeDate":"2024-01-01"}},"responses":{"200":"ServiceResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"POST","path":"/system/services/workProfiles/{workProfileId}","fullPath":"/api/v2.0.0/system/services/workProfiles/{workProfileId}","operationId":"createWorkloadProfile","name":"Create service work load profile","summary":"Create service work load profile(Deprecated- A newer version V2.0.2 available)","tags":[],"parameters":[{"name":"workProfileId","in":"path","type":"string","required":true,"description":"Contains the reference to the record in service workload profiles for services."},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"The identifier of the underlying Entity/Company/Branch."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"displayName":"string","startTime":"string","agentsRequired":"string","recordStatus":"string","CurrNo":0.0,"inputter":"string","authoriser":"string","datetime":"2024-01-01T00:00:00Z","coCode":"string","deptCode":"string","auditorCode":"string","auditTimeDate":"string"}},"responses":{"200":"WorkloadProfileResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/system/services/workProfiles/{workProfileId}","fullPath":"/api/v2.0.0/system/services/workProfiles/{workProfileId}","operationId":"updateWorkloadProfile","name":"Update a service work load profile","summary":"Update a service work load profile(Deprecated- A newer version V2.0.2 available)","tags":[],"parameters":[{"name":"workProfileId","in":"path","type":"string","required":true,"description":"Contains the reference to the record in service workload profiles for services."},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"The identifier of the underlying Entity/Company/Branch."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"displayName":"string","startTime":"string","agentsRequired":"string","recordStatus":"string","CurrNo":0.0,"inputter":"string","authoriser":"string","datetime":"2024-01-01T00:00:00Z","coCode":"string","deptCode":"string","auditorCode":"string","auditTimeDate":"string"}},"responses":{"200":"WorkloadProfileResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}}]}]},{"name":"Updatepsmblobapi","serviceCount":1,"endpointCount":1,"services":[{"key":"UpdatePSMBLOBApi-v1.0.0","title":"PSM BLOB update API","version":"v1.0.0","description":"API to update PSM.BLOB","endpointCount":1,"endpoints":[{"method":"PUT","path":"/order/psmblob/{psmBlobId}/update","fullPath":"/api/v1.0.0/order/psmblob/{psmBlobId}/update","operationId":"updatePSMBLOB","name":"update PSM BLOB - This API is deprecated and moved to the following URL : payments/logs/sentMessages/{sentMessageId}","summary":"update PSM BLOB","tags":[],"parameters":[{"name":"psmBlobId","in":"path","type":"string","required":true,"description":""},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"ackDetails":[{}],"orgTxnReference":"string","orgMessageId":"string"}},"responses":{"200":"PSMBLOBResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}}]}]},{"name":"Arrangements","serviceCount":2,"endpointCount":3,"services":[{"key":"arrangements-balances-v2.0.0","title":"Arrangement - Charge off balances","version":"v2.0.0","description":"API to retrieve the charge off balance details of an arrangement","endpointCount":2,"endpoints":[{"method":"GET","path":"/holdings/arrangements/{arrangementId}/chargeOffBalances","fullPath":"/api/v2.0.0/holdings/arrangements/{arrangementId}/chargeOffBalances","operationId":"getChargeOffDetails","name":"Retrieves the Charge Off balances of an arrangement account-This API is deprecated","summary":"Retrieves the Charge Off balances of an arrangement account","tags":[],"parameters":[{"name":"arrangementId","in":"path","type":"string","required":true,"description":"Indicates an unique identifier of an account"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"ChargeOffDetailsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/arrangements/{arrangementId}/consolidatedBalances","fullPath":"/api/v2.0.0/holdings/arrangements/{arrangementId}/consolidatedBalances","operationId":"getVirtualBalances","name":"Retrieves the virtual balances for a balance type of an account-This API is deprecated","summary":"Retrieves the virtual balances for a balance type of an account","tags":[],"parameters":[{"name":"arrangementId","in":"path","type":"string","required":true,"description":"Indicates an unique identifier of an account"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"VirtualBalancesResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}}]},{"key":"arrangements-documents-v1.0.0","title":"Manage Arrangement Account related documents","version":"v1.0.0","description":"Manage Arrangement Account related documents","endpointCount":1,"endpoints":[{"method":"GET","path":"/holdings/arrangements/{arrangementId}/documents","fullPath":"/api/v1.0.0/holdings/arrangements/{arrangementId}/documents","operationId":"getTransactionDocuments","name":"Retrieves the transaction document details of a given arrangement account-This API is deprecated","summary":"Retrieves the transaction document details of a given arrangement account","tags":[],"parameters":[{"name":"arrangementId","in":"path","type":"string","required":true,"description":"Indicates an unique identifier of an account"},{"name":"transactionReference","in":"query","type":"string","required":false,"description":"Contains the identifier for the transaction in the core system"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"TransactionDocumentsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}}]}]},{"name":"Cancel","serviceCount":1,"endpointCount":1,"services":[{"key":"cancel-DeliveryOrder-v1.0.0","title":"Cancel Delivery Order","version":"v1.0.0","description":"Cancel Delivery Order","endpointCount":1,"endpoints":[{"method":"POST","path":"/order/messages/cancelTrade","fullPath":"/api/v1.0.0/order/messages/cancelTrade","operationId":"cancelDeliveryOrder","name":"Use URI \"/holdings/messages/securityTrades/cancellations\"","summary":"Cancel Delivery Order","tags":[],"parameters":[{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"msgId":"string","creDtTm":"string","ordrRef":"string","receiver":"string"}},"responses":{"200":"DeliveryOrderResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}}]}]},{"name":"Cdp","serviceCount":1,"endpointCount":1,"services":[{"key":"cdp-consent-status-v1.0.0","title":"CDP consent status API","version":"v1.0.0","description":"APIs to retrieve status of customer's CDP Consent for specific type or subtype - Deprecated, use party-dataProtectionConsent-v1.1.0 instead","endpointCount":1,"endpoints":[{"method":"GET","path":"/party/consents/CDP","fullPath":"/api/v1.0.0/party/consents/CDP","operationId":"getCdpConsentStatus","name":"Retrieves CDP Consent status of a customer for given consent type or sub type","summary":"Retrieves CDP Consent status","tags":[],"parameters":[{"name":"customerId","in":"query","type":"string","required":false,"description":"Identifier of the customer"},{"name":"arrangement","in":"query","type":"string","required":false,"description":"Unique identifier for the arrangement contract"},{"name":"consentType","in":"query","type":"string","required":false,"description":"Consent Type for which the consent is given"},{"name":"consentSubType","in":"query","type":"string","required":false,"description":"Indicates the consent type provided for a particular account. For example, If consent sub type for account 100100 is given as allPsd2, the account is given global consent."},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from t24 on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":""},{"name":"companyId","in":"header","type":"string","required":false,"description":""}],"requestBodyExample":null,"responses":{"200":"CdpConsentStatusResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}}]}]},{"name":"Consent","serviceCount":1,"endpointCount":5,"services":[{"key":"consent-v1.0.0","title":"Customer Data Protection Consent Management","version":"v1.0.0","description":"Create and manage customer consent - Deprecated, use party-dataProtectionConsent-v1.1.0 instead","endpointCount":5,"endpoints":[{"method":"PUT","path":"/party/dataProtection/customers/consentApprovals/{consentId}","fullPath":"/api/v1.0.0/party/dataProtection/customers/consentApprovals/{consentId}","operationId":"approveConsent","name":"Approve consent","summary":"Approval of customer consent.","tags":[],"parameters":[{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"The identifier of the underlying Entity/Company/Branch."},{"name":"consentId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":null,"responses":{"200":"approveConsentResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"GET","path":"/party/dataProtection/customers/consents","fullPath":"/api/v1.0.0/party/dataProtection/customers/consents","operationId":"getConsent","name":"Retrieves consent details","summary":"Retrieval of customer consent details.","tags":[],"parameters":[{"name":"customerId","in":"query","type":"string","required":true,"description":"Identifier of the customer"},{"name":"consentId","in":"query","type":"string","required":true,"description":"Identifier of the corresponding consent object as retrieved by an account Information consent Request."},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from t24 on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"The identifier of the underlying Entity/Company/Branch."}],"requestBodyExample":null,"responses":{"200":"ConsentResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"PUT","path":"/party/dataProtection/customers/consents","fullPath":"/api/v1.0.0/party/dataProtection/customers/consents","operationId":"updateConsent","name":"Update consent","summary":"Update of customer consent details.","tags":[],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"The identifier of the underlying Entity/Company/Branch."}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"customers":[{}],"arrangement":"string","product":"string","arrangementEffectiveDate":"string","activity":"string","reason":"string","cdpConsent":{"consentTypes":{},"expiryDate":{}}}},"responses":{"200":"updateConsentResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"PUT","path":"/party/dataProtection/customers/consents/revocations","fullPath":"/api/v1.0.0/party/dataProtection/customers/consents/revocations","operationId":"withdrawConsent","name":"Revokes consent.","summary":"Revokes customer consent details from system.","tags":[],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"The identifier of the underlying Entity/Company/Branch."}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"customers":[{}],"arrangement":"string","product":"string","arrangementEffectiveDate":"string","activity":"string","reason":"string"}},"responses":{"200":"withdrawConsentResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"POST","path":"/party/dataProtection/customers/consentInitiation","fullPath":"/api/v1.0.0/party/dataProtection/customers/consentInitiation","operationId":"createConsent","name":"Initiate consent","summary":"Initiation of customer consent","tags":[],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"The identifier of the underlying Entity/Company/Branch."}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"customers":[{}],"arrangement":"string","product":"string","arrangementEffectiveDate":"string","activity":"string","reason":"string","cdpConsent":{"consentTypes":{},"expiryDate":{}}}},"responses":{"200":"createConsentResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}}]}]},{"name":"Customer","serviceCount":1,"endpointCount":1,"services":[{"key":"customer-account-details-v1.0.0","title":"Customer Account details","version":"v1.0.0","description":"API to retrieve customer and account details","endpointCount":1,"endpoints":[{"method":"GET","path":"/party/customers/accountDetails","fullPath":"/api/v1.0.0/party/customers/accountDetails","operationId":"getCustomerAccountDetails","name":"Retrieves details of customer and accounts related to customer for model bank installer demo purpose","summary":"Retrieves details of customer and accounts related to customer","tags":[],"parameters":[{"name":"customerId","in":"query","type":"string","required":false,"description":"Identifier of the customer"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"CustomerAccountDetailsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}}]}]},{"name":"Enterprise","serviceCount":5,"endpointCount":67,"services":[{"key":"enterprise-identityComparison-service-v1.0.0","title":"Identity Comparison","version":"v1.0.0","description":"Performs the comparison of two-name strings using an algorithm which is based on String matching using Fuzzy Wuzzy, ratio function.","endpointCount":4,"endpoints":[{"method":"GET","path":"/enterprise/identityComparison/accounts/{accountId}","fullPath":"/api/v1.0.0/enterprise/identityComparison/accounts/{accountId}","operationId":"getNameComparisonResult","name":"Compares two name sets and determines the degree of similarity or match between them. Matching score and Boolean value - 1 - True; 0- False will be returned.","summary":"Compares two given names and returns the outcome.","tags":["OTHERS"],"parameters":[{"name":"accountId","in":"path","type":"string","required":true,"description":"Identifier of the account. Often referred to as the account number, yet for consistency this is always referred to as accountId. Accepts both IBAN & BBAN"},{"name":"transactionReference","in":"query","type":"string","required":false,"description":"Contains the identifier for the transaction in the core system"},{"name":"compareName","in":"query","type":"string","required":true,"description":"Specifies the name to be compared against the source name."},{"name":"sourceName","in":"query","type":"string","required":true,"description":"Specifies the source where the event design flow is attached to. The source could be an Application, Version  (Input screens defined for Applications), TSA Service or Component Service"},{"name":"percentageToMatch","in":"query","type":"string","required":false,"description":"Indicates the percentage to be matched with respect to entitlement base"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"NameComparisonResultResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/enterprise/identityComparison/accounts/{accountId}/aliasNames","fullPath":"/api/v1.0.0/enterprise/identityComparison/accounts/{accountId}/aliasNames","operationId":"getAliasNames","name":"Retrieves the alias names for a given account.","summary":"Retrieves the alias names.","tags":["OTHERS"],"parameters":[{"name":"accountId","in":"path","type":"string","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"AliasNamesResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"POST","path":"/enterprise/identityComparison/accounts/{accountId}/aliasNames","fullPath":"/api/v1.0.0/enterprise/identityComparison/accounts/{accountId}/aliasNames","operationId":"createAliasNames","name":"Creates alias names for a name.  The name comparison API will refer these alias names when it detects a mismatch between the name sets. If the name to compare matches with one of the alias names, then the True will be retuned instead of False.","summary":"Create Match names that are common alternatives/aliases to the actual name. ","tags":["OTHERS"],"parameters":[{"name":"accountId","in":"path","type":"string","required":true,"description":"Identifier of the account. Often referred to as the account number, yet for consistency this is always referred to as accountId. Accepts both IBAN & BBAN"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"userSet":[{}],"extensions":{}}},"responses":{"200":"AliasNamesResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/enterprise/identityComparison/accounts/{accountId}/aliasNames","fullPath":"/api/v1.0.0/enterprise/identityComparison/accounts/{accountId}/aliasNames","operationId":"updateAliasNames","name":"The alias names are considered valid if the status is approved i.e., reviewed and validated by the responsible bank user. The proposed alias names are captured with status as \"unapproved\". Further, using this API, the user can add approval or reject the proposal or even mark for further approval, by changing the status to pending approval. Necessary justification or narrative and the user's name can be added.","summary":"Add user approvals or rejections for the proposed alias name and add to record the justification for the user action.","tags":["OTHERS"],"parameters":[{"name":"accountId","in":"path","type":"string","required":true,"description":""},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"systemSet":[{}],"userSet":[{}],"extensions":{}}},"responses":{"200":"AliasNamesResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}}]},{"key":"enterprise-pricing-v1.0.0","title":"Enterprise product pricing","version":"v1.0.0","description":"API to retrieve the pricing benefit details for activity charge, periodic charge or interest rates for enterprise product pricing arrangement or package","endpointCount":13,"endpoints":[{"method":"GET","path":"/enterprise/pricing/packages/{packageId}/pricingBenefits","fullPath":"/api/v1.0.0/enterprise/pricing/packages/{packageId}/pricingBenefits","operationId":"getPackageStatement","name":"Retrieves the package pricing details for the package and the linked contracts or accounts","summary":"Retrieves the package pricing benefit details","tags":["RETAIL"],"parameters":[{"name":"packageId","in":"path","type":"string","required":true,"description":"Indicates the arrangement reference of the package"},{"name":"startDate","in":"query","type":"string","required":false,"description":"Contains the date on which the transaction or payment gets initiated."},{"name":"endDate","in":"query","type":"string","required":false,"description":"Indicates the date till which the transaction history requested. If 20120101 is the start date and 20120201 is the end date, all transactions that are booked between January 1 to February 1 2012 are r"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from t24 on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"PackageStatementResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/enterprise/pricing/arrangements/{baseContractReference}/activities","fullPath":"/api/v1.0.0/enterprise/pricing/arrangements/{baseContractReference}/activities","operationId":"getActivityChargeAmount","name":"Retrieves the simulated fee amount details with benefit applied for the given event name","summary":"Retrieves the fee amount charged on an event","tags":["RETAIL"],"parameters":[{"name":"baseContractReference","in":"path","type":"string","required":true,"description":"Contains the identifier for the contract or account in which the event is raised. This would typically be a unique reference to identify the specific contract or account in the system"},{"name":"systemReference","in":"query","type":"string","required":false,"description":"Contains the identifier for the system in which the event originated from. For ex, \u00e2\u20ac\u02dcHogan\u00e2\u20ac\u2122 or \u00e2\u20ac\u02dcTransactAccounts\u00e2\u20ac\u2122 etc"},{"name":"companyReference","in":"query","type":"string","required":false,"description":"Contains the identifier of the underlying Entity or Company or Branch"},{"name":"eventName","in":"query","type":"string","required":false,"description":"The name that is displayed for the event"},{"name":"effectiveDate","in":"query","type":"string","required":false,"description":"Contains the identifier for the transaction date. Dates are expected in \u00e2\u20ac\u02dcYYYYMMDD\u00e2\u20ac\u2122 format"},{"name":"channel","in":"query","type":"string","required":false,"description":"Contains the channel in which the activity was performed. If pricing is not determined based on channel, then this is not significant"},{"name":"branch","in":"query","type":"string","required":false,"description":"Contains the branch name/code in which the business activity was performed. If pricing is not determined based on branch, then this is not significant"},{"name":"lineOfBusiness","in":"query","type":"string","required":false,"description":"Contains the line of business in which the activity was performed. If pricing is not determined based on line of business, then this is not significant"},{"name":"transactionReference","in":"query","type":"string","required":false,"description":"Contains the identifier for the transaction in the core system"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from t24 on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"ActivityChargeAmountResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/enterprise/pricing/arrangements/{baseContractReference}/periodicCharges","fullPath":"/api/v1.0.0/enterprise/pricing/arrangements/{baseContractReference}/periodicCharges","operationId":"getPeriodicChargesAmount","name":"Retrieves the simulated fee amount details with benefit applied for the given event name","summary":"Retrieves the fee amount charged on an event","tags":["RETAIL"],"parameters":[{"name":"baseContractReference","in":"path","type":"string","required":true,"description":"Contains the identifier for the contract or account in which the event is raised. This would typically be a unique reference to identify the specific contract or account in the system"},{"name":"systemReference","in":"query","type":"string","required":false,"description":"Contains the identifier for the system in which the event originated from. For ex, \u00e2\u20ac\u02dcHogan\u00e2\u20ac\u2122 or \u00e2\u20ac\u02dcTransactAccounts\u00e2\u20ac\u2122 etc"},{"name":"companyReference","in":"query","type":"string","required":false,"description":"Contains the identifier of the underlying Entity or Company or Branch"},{"name":"eventName","in":"query","type":"string","required":false,"description":"The name that is displayed for the event"},{"name":"effectiveDate","in":"query","type":"string","required":false,"description":"Contains the identifier for the transaction date. Dates are expected in \u00e2\u20ac\u02dcYYYYMMDD\u00e2\u20ac\u2122 format"},{"name":"channel","in":"query","type":"string","required":false,"description":"Contains the channel in which the activity was performed. If pricing is not determined based on channel, then this is not significant"},{"name":"branch","in":"query","type":"string","required":false,"description":"Contains the branch name/code in which the business activity was performed. If pricing is not determined based on branch, then this is not significant"},{"name":"lineOfBusiness","in":"query","type":"string","required":false,"description":"Contains the line of business in which the activity was performed. If pricing is not determined based on line of business, then this is not significant"},{"name":"transactionReference","in":"query","type":"string","required":false,"description":"Contains the identifier for the transaction in the core system"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from t24 on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"PeriodicChargesAmountResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/enterprise/pricing/arrangements/{baseContractReference}/rates","fullPath":"/api/v1.0.0/enterprise/pricing/arrangements/{baseContractReference}/rates","operationId":"getInterestRate","name":"Retrieves the simulated interest rates with benefit applied for the given event","summary":"Retrieves the interest rates","tags":["RETAIL"],"parameters":[{"name":"baseContractReference","in":"path","type":"string","required":true,"description":"Contains the identifier for the contract or account in which the event is raised. This would typically be a unique reference to identify the specific contract or account in the system"},{"name":"systemReference","in":"query","type":"string","required":false,"description":"Contains the identifier for the system in which the event originated from. For ex, \u00e2\u20ac\u02dcHogan\u00e2\u20ac\u2122 or \u00e2\u20ac\u02dcTransactAccounts\u00e2\u20ac\u2122 etc"},{"name":"companyReference","in":"query","type":"string","required":false,"description":"Contains the identifier of the underlying Entity or Company or Branch"},{"name":"eventName","in":"query","type":"string","required":false,"description":"The name that is displayed for the event"},{"name":"effectiveDate","in":"query","type":"string","required":false,"description":"Contains the identifier for the transaction date. Dates are expected in \u00e2\u20ac\u02dcYYYYMMDD\u00e2\u20ac\u2122 format"},{"name":"channel","in":"query","type":"string","required":false,"description":"Contains the channel in which the activity was performed. If pricing is not determined based on channel, then this is not significant"},{"name":"branch","in":"query","type":"string","required":false,"description":"Contains the branch name/code in which the business activity was performed. If pricing is not determined based on branch, then this is not significant"},{"name":"lineOfBusiness","in":"query","type":"string","required":false,"description":"Contains the line of business in which the activity was performed. If pricing is not determined based on line of business, then this is not significant"},{"name":"transactionReference","in":"query","type":"string","required":false,"description":"Contains the identifier for the transaction in the core system"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from t24 on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"InterestRateResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/enterprise/pricing/products/{productId}/rates","fullPath":"/api/v1.0.0/enterprise/pricing/products/{productId}/rates","operationId":"getRequestRate","name":"Retrieves the interest rates with benefit applied for the given product","summary":"Retrieves the interest rates for the given product","tags":["RETAIL"],"parameters":[{"name":"productId","in":"path","type":"string","required":true,"description":"Contains the unique identifier of the product, e.g. the product id of the arrangement account."},{"name":"partyId","in":"query","type":"string","required":false,"description":"Allows capturing of customers or person entities to be part of the relationship. If partyType is selected as Customer, then the system will allow only customer Ids to be captured into this field. If p"},{"name":"effectiveDate","in":"query","type":"string","required":false,"description":"Contains the identifier for the transaction date. Dates are expected in \u00e2\u20ac\u02dcYYYYMMDD\u00e2\u20ac\u2122 format"},{"name":"rateName","in":"query","type":"string","required":false,"description":"Specifies the name displayed for the interest rates"},{"name":"amount","in":"query","type":"string","required":false,"description":"This is the payment amount"},{"name":"tenor","in":"query","type":"string","required":false,"description":"This field is valid for Documentary Collections only. It is used in conjunction with the following field 'DAYS' or 'COLL.MAT.CODE' to indicate the TENOR of the drafts under the collection and is used "},{"name":"rolloverPeriod","in":"query","type":"string","required":false,"description":"Indicates the roll over period after which contract will switch on to the new set of interest or fee conditions. For contracts dealing with periodic indexes, rates are influenced by Amount or Tenor or"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from t24 on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"RequestRateResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/enterprise/pricing/products/{productId}/eligibilities","fullPath":"/api/v1.0.0/enterprise/pricing/products/{productId}/eligibilities","operationId":"getEligibilityDetails","name":"Retrieves the eligibility details of the product for the given party or parties","summary":"Retrieves the eligibility details for the product","tags":["RETAIL"],"parameters":[{"name":"productId","in":"path","type":"string","required":true,"description":"Contains the unique identifier of the product, e.g. the product id of the arrangement account."},{"name":"partyId","in":"query","type":"string","required":false,"description":"Allows capturing of customers or person entities to be part of the relationship. If partyType is selected as Customer, then the system will allow only customer Ids to be captured into this field. If p"},{"name":"partyRole","in":"query","type":"string","required":false,"description":"Contains the identifier used for the role played by the party or customer in the contract or account"},{"name":"effectiveDate","in":"query","type":"string","required":false,"description":"Contains the identifier for the transaction date. Dates are expected in \u00e2\u20ac\u02dcYYYYMMDD\u00e2\u20ac\u2122 format"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from t24 on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"EligibilityDetailsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/enterprise/pricing/arrangements/{baseContractReference}/transactions","fullPath":"/api/v1.0.0/enterprise/pricing/arrangements/{baseContractReference}/transactions","operationId":"getTransactionPricingRequest","name":"Retrieves the charge amounts with benefit applied for transaction business activity","summary":"Retrieves the pricing for transaction business activity","tags":["RETAIL"],"parameters":[{"name":"baseContractReference","in":"path","type":"string","required":true,"description":"Contains the identifier for the contract or account in which the event is raised. This would typically be a unique reference to identify the specific contract or account in the system"},{"name":"systemReference","in":"query","type":"string","required":false,"description":"Contains the identifier for the system in which the event originated from. For ex, \u00e2\u20ac\u02dcHogan\u00e2\u20ac\u2122 or \u00e2\u20ac\u02dcTransactAccounts\u00e2\u20ac\u2122 etc"},{"name":"companyReference","in":"query","type":"string","required":false,"description":"Contains the identifier of the underlying Entity or Company or Branch"},{"name":"eventName","in":"query","type":"string","required":false,"description":"The name that is displayed for the event"},{"name":"effectiveDate","in":"query","type":"string","required":false,"description":"Contains the identifier for the transaction date. Dates are expected in \u00e2\u20ac\u02dcYYYYMMDD\u00e2\u20ac\u2122 format"},{"name":"currency","in":"query","type":"string","required":false,"description":"Identifies the currency. E.g. USD, GBP etc"},{"name":"channel","in":"query","type":"string","required":false,"description":"Contains the channel in which the activity was performed. If pricing is not determined based on channel, then this is not significant"},{"name":"branch","in":"query","type":"string","required":false,"description":"Contains the branch name/code in which the business activity was performed. If pricing is not determined based on branch, then this is not significant"},{"name":"lineOfBusiness","in":"query","type":"string","required":false,"description":"Contains the line of business in which the activity was performed. If pricing is not determined based on line of business, then this is not significant"},{"name":"transactionCurrency","in":"query","type":"string","required":false,"description":"Indicates the currency of the transaction. For example GBP, USD etc."},{"name":"transactionAmount","in":"query","type":"string","required":false,"description":"Contains the transaction amount. This is based on the currency, either local or foreign currency"},{"name":"contractAmount","in":"query","type":"string","required":false,"description":"Indicates the amount of the transaction in contract currency"},{"name":"contextName","in":"query","type":"string","required":false,"description":"Field name returned by the payment engine (TPH) for information or further processing."},{"name":"contextValue","in":"query","type":"string","required":false,"description":"Field value returned by the payment engine (TPH) for information or further processing."},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from t24 on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"TransactionPricingRequestResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/enterprise/pricing/products/{productId}/pricing","fullPath":"/api/v1.0.0/enterprise/pricing/products/{productId}/pricing","operationId":"getNewActivityPricing","name":"Retrieves the pricing for an event with respect to product's conditions","summary":"Retrieves the pricing for an event","tags":["RETAIL"],"parameters":[{"name":"productId","in":"path","type":"string","required":true,"description":"Contains the unique identifier of the product, e.g. the product id of the arrangement account."},{"name":"companyReference","in":"query","type":"string","required":false,"description":"Contains the identifier of the underlying Entity or Company or Branch"},{"name":"eventName","in":"query","type":"string","required":false,"description":"The name that is displayed for the event"},{"name":"effectiveDate","in":"query","type":"string","required":false,"description":"Contains the identifier for the transaction date. Dates are expected in \u00e2\u20ac\u02dcYYYYMMDD\u00e2\u20ac\u2122 format"},{"name":"currency","in":"query","type":"string","required":false,"description":"Identifies the currency. E.g. USD, GBP etc"},{"name":"channel","in":"query","type":"string","required":false,"description":"Contains the channel in which the activity was performed. If pricing is not determined based on channel, then this is not significant"},{"name":"branch","in":"query","type":"string","required":false,"description":"Contains the branch name/code in which the business activity was performed. If pricing is not determined based on branch, then this is not significant"},{"name":"lineOfBusiness","in":"query","type":"string","required":false,"description":"Contains the line of business in which the activity was performed. If pricing is not determined based on line of business, then this is not significant"},{"name":"partyReference","in":"query","type":"string","required":false,"description":"Contains the identifier used for the party or customer"},{"name":"partyRole","in":"query","type":"string","required":false,"description":"Contains the identifier used for the role played by the party or customer in the contract or account"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from t24 on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"NewActivityPricingResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/enterprise/pricing/arrangements/{arrangementId}/pricing","fullPath":"/api/v1.0.0/enterprise/pricing/arrangements/{arrangementId}/pricing","operationId":"getPricingDetailsEventList","name":"Retrieves the pricing details on a single Event for the given arrangement","summary":"Retrieves the pricing details on a single Event","tags":["RETAIL"],"parameters":[{"name":"arrangementId","in":"path","type":"string","required":true,"description":"Indicates an unique identifier of an account"},{"name":"transactionReference","in":"query","type":"string","required":false,"description":"Contains the identifier for the transaction in the core system"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from t24 on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"PricingDetailsEventListResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/enterprise/pricing/arrangements/packages/{packageId}/periodicCharges","fullPath":"/api/v1.0.0/enterprise/pricing/arrangements/packages/{packageId}/periodicCharges","operationId":"getPackagePeriodicPricing","name":"Retrieves the periodic pricing that have happened on a package along with the details of linked arrangements","summary":"Retrieves the periodic pricing that have happened on a package","tags":["RETAIL"],"parameters":[{"name":"packageId","in":"path","type":"string","required":true,"description":"Indicates the arrangement reference of the package"},{"name":"effectiveDate","in":"query","type":"string","required":false,"description":"Contains the identifier for the transaction date. Dates are expected in \u00e2\u20ac\u02dcYYYYMMDD\u00e2\u20ac\u2122 format"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from t24 on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"PackagePeriodicPricingResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/enterprise/pricing/arrangements/packages/{packageId}","fullPath":"/api/v1.0.0/enterprise/pricing/arrangements/packages/{packageId}","operationId":"getPackageDetails","name":"Retrieves the details of packages created in enterprise product pricing along with the linked arrangements","summary":"Retrieves the details of packages created in enterprise product pricing","tags":["RETAIL"],"parameters":[{"name":"packageId","in":"path","type":"string","required":true,"description":"Indicates the arrangement reference of the package"},{"name":"effectiveDate","in":"query","type":"string","required":false,"description":"Contains the identifier for the transaction date. Dates are expected in \u00e2\u20ac\u02dcYYYYMMDD\u00e2\u20ac\u2122 format"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from t24 on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"PackageDetailsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/enterprise/pricing/parties/{partyId}/arrangements","fullPath":"/api/v1.0.0/enterprise/pricing/parties/{partyId}/arrangements","operationId":"getCustomerHeldContracts","name":"Retrieves the details of contracts held by the party at an enterprise level","summary":"Retrieves the details of contracts held by the party","tags":["RETAIL"],"parameters":[{"name":"partyId","in":"path","type":"string","required":true,"description":"Allows capturing of customers or person entities to be part of the relationship. If partyType is selected as Customer, then the system will allow only customer Ids to be captured into this field. If p"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from t24 on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"CustomerHeldContractsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/enterprise/pricing/arrangements/{baseContractReference}/events","fullPath":"/api/v1.0.0/enterprise/pricing/arrangements/{baseContractReference}/events","operationId":"getContractEventList","name":"Retrieves the details of events for the given enterprise product pricing arrangement","summary":"Retrieves the details of events","tags":["RETAIL"],"parameters":[{"name":"baseContractReference","in":"path","type":"string","required":true,"description":"Contains the identifier for the contract or account in which the event is raised. This would typically be a unique reference to identify the specific contract or account in the system"},{"name":"systemReference","in":"query","type":"string","required":false,"description":"Contains the identifier for the system in which the event originated from. For ex, \u00e2\u20ac\u02dcHogan\u00e2\u20ac\u2122 or \u00e2\u20ac\u02dcTransactAccounts\u00e2\u20ac\u2122 etc"},{"name":"numberOfTransactions","in":"query","type":"string","required":false,"description":"Indicates the number of transactions performed on the contract or the account"},{"name":"dateFrom","in":"query","type":"string","required":false,"description":"Indicates the end date till which the transactions or events performed on the contract or account is to be returned"},{"name":"dateTo","in":"query","type":"string","required":false,"description":"Indicates the start date from which the transactions or events performed on the contract or account is to be returned"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from t24 on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"ContractEventListResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}}]},{"key":"enterprise-pricing-v1.1.0","title":"Enterprise product pricing","version":"v1.1.0","description":"API to retrieve the pricing benefit details for activity charge, periodic charge or interest rates for enterprise product pricing arrangement or package","endpointCount":14,"endpoints":[{"method":"GET","path":"/enterprise/pricing/packages/{packageId}/pricingBenefits","fullPath":"/api/v1.1.0/enterprise/pricing/packages/{packageId}/pricingBenefits","operationId":"getPackageStatement","name":"Retrieves the package pricing details for the package and the linked contracts or accounts","summary":"Retrieves the package pricing benefit details","tags":["RETAIL"],"parameters":[{"name":"packageId","in":"path","type":"string","required":true,"description":"Indicates the arrangement reference of the package"},{"name":"startDate","in":"query","type":"string","required":false,"description":"Contains the date on which the transaction or payment gets initiated."},{"name":"endDate","in":"query","type":"string","required":false,"description":"Indicates the date till which the transaction history requested. If 20120101 is the start date and 20120201 is the end date, all transactions that are booked between January 1 to February 1 2012 are r"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"PackageStatementResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/enterprise/pricing/arrangements/{baseContractReference}/activities","fullPath":"/api/v1.1.0/enterprise/pricing/arrangements/{baseContractReference}/activities","operationId":"getActivityChargeAmount","name":"Retrieves the simulated fee amount details with benefit applied for the given event name","summary":"Retrieves the fee amount charged on an event","tags":["RETAIL"],"parameters":[{"name":"baseContractReference","in":"path","type":"string","required":true,"description":"Contains the identifier for the contract or account in which the event is raised. This would typically be a unique reference to identify the specific contract or account in the system"},{"name":"systemReference","in":"query","type":"string","required":false,"description":"Contains the identifier for the system in which the event originated from. For ex, \u00e2\u20ac\u02dcHogan\u00e2\u20ac\u2122 or \u00e2\u20ac\u02dcTransactAccounts\u00e2\u20ac\u2122 etc"},{"name":"companyReference","in":"query","type":"string","required":false,"description":"Contains the identifier of the underlying Entity or Company or Branch"},{"name":"eventName","in":"query","type":"string","required":false,"description":"Indicates the name of the event that is understood by the Enterprise product pricing system."},{"name":"effectiveDate","in":"query","type":"string","required":false,"description":"Contains the identifier for the transaction date. Dates are expected in \u00e2\u20ac\u02dcYYYYMMDD\u00e2\u20ac\u2122 format"},{"name":"channel","in":"query","type":"string","required":false,"description":"Contains the channel in which the activity was performed. If pricing is not determined based on channel, then this is not significant"},{"name":"branch","in":"query","type":"string","required":false,"description":"Contains the branch name/code in which the business activity was performed. If pricing is not determined based on branch, then this is not significant"},{"name":"lineOfBusiness","in":"query","type":"string","required":false,"description":"Contains the line of business in which the activity was performed. If pricing is not determined based on line of business, then this is not significant"},{"name":"transactionReference","in":"query","type":"string","required":false,"description":"Contains the identifier for the transaction in the core system"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"ActivityChargeAmountResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/enterprise/pricing/arrangements/{baseContractReference}/periodicCharges","fullPath":"/api/v1.1.0/enterprise/pricing/arrangements/{baseContractReference}/periodicCharges","operationId":"getPeriodicChargesAmount","name":"Retrieves the simulated fee amount details with benefit applied for the given event name","summary":"Retrieves the fee amount charged on an event","tags":["RETAIL"],"parameters":[{"name":"baseContractReference","in":"path","type":"string","required":true,"description":"Contains the identifier for the contract or account in which the event is raised. This would typically be a unique reference to identify the specific contract or account in the system"},{"name":"systemReference","in":"query","type":"string","required":false,"description":"Contains the identifier for the system in which the event originated from. For ex, \u00e2\u20ac\u02dcHogan\u00e2\u20ac\u2122 or \u00e2\u20ac\u02dcTransactAccounts\u00e2\u20ac\u2122 etc"},{"name":"companyReference","in":"query","type":"string","required":false,"description":"Contains the identifier of the underlying Entity or Company or Branch"},{"name":"eventName","in":"query","type":"string","required":false,"description":"Indicates the name of the event that is understood by the Enterprise product pricing system."},{"name":"effectiveDate","in":"query","type":"string","required":false,"description":"Contains the identifier for the transaction date. Dates are expected in \u00e2\u20ac\u02dcYYYYMMDD\u00e2\u20ac\u2122 format"},{"name":"channel","in":"query","type":"string","required":false,"description":"Contains the channel in which the activity was performed. If pricing is not determined based on channel, then this is not significant"},{"name":"branch","in":"query","type":"string","required":false,"description":"Contains the branch name/code in which the business activity was performed. If pricing is not determined based on branch, then this is not significant"},{"name":"lineOfBusiness","in":"query","type":"string","required":false,"description":"Contains the line of business in which the activity was performed. If pricing is not determined based on line of business, then this is not significant"},{"name":"transactionReference","in":"query","type":"string","required":false,"description":"Contains the identifier for the transaction in the core system"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"PeriodicChargesAmountResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/enterprise/pricing/arrangements/{baseContractReference}/rates","fullPath":"/api/v1.1.0/enterprise/pricing/arrangements/{baseContractReference}/rates","operationId":"getInterestRate","name":"Retrieves the simulated interest rates with benefit applied for the given event","summary":"Retrieves the interest rates","tags":["RETAIL"],"parameters":[{"name":"baseContractReference","in":"path","type":"string","required":true,"description":"Contains the identifier for the contract or account in which the event is raised. This would typically be a unique reference to identify the specific contract or account in the system"},{"name":"systemReference","in":"query","type":"string","required":false,"description":"Contains the identifier for the system in which the event originated from. For ex, \u00e2\u20ac\u02dcHogan\u00e2\u20ac\u2122 or \u00e2\u20ac\u02dcTransactAccounts\u00e2\u20ac\u2122 etc"},{"name":"companyReference","in":"query","type":"string","required":false,"description":"Contains the identifier of the underlying Entity or Company or Branch"},{"name":"eventName","in":"query","type":"string","required":false,"description":"Indicates the name of the event that is understood by the Enterprise product pricing system."},{"name":"effectiveDate","in":"query","type":"string","required":false,"description":"Contains the identifier for the transaction date. Dates are expected in \u00e2\u20ac\u02dcYYYYMMDD\u00e2\u20ac\u2122 format"},{"name":"channel","in":"query","type":"string","required":false,"description":"Contains the channel in which the activity was performed. If pricing is not determined based on channel, then this is not significant"},{"name":"branch","in":"query","type":"string","required":false,"description":"Contains the branch name/code in which the business activity was performed. If pricing is not determined based on branch, then this is not significant"},{"name":"lineOfBusiness","in":"query","type":"string","required":false,"description":"Contains the line of business in which the activity was performed. If pricing is not determined based on line of business, then this is not significant"},{"name":"transactionReference","in":"query","type":"string","required":false,"description":"Contains the identifier for the transaction in the core system"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"InterestRateResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/enterprise/pricing/products/{productId}/rates","fullPath":"/api/v1.1.0/enterprise/pricing/products/{productId}/rates","operationId":"getRequestRate","name":"Retrieves the interest rates with benefit applied for the given product","summary":"Retrieves the interest rates for the given product","tags":["RETAIL"],"parameters":[{"name":"productId","in":"path","type":"string","required":true,"description":"Contains the unique identifier of the product, e.g. the product id of the arrangement account."},{"name":"partyId","in":"query","type":"string","required":false,"description":"Allows capturing of customers or person entities to be part of the relationship. If partyType is selected as Customer, then the system will allow only customer Ids to be captured into this field. If p"},{"name":"effectiveDate","in":"query","type":"string","required":false,"description":"Contains the identifier for the transaction date. Dates are expected in \u00e2\u20ac\u02dcYYYYMMDD\u00e2\u20ac\u2122 format"},{"name":"rateName","in":"query","type":"string","required":false,"description":"Contains the identifier for the underlying interest rate component(s). Eg: Credit interest, Debit Interest, Penalty Interest etc"},{"name":"amount","in":"query","type":"string","required":false,"description":"This is the payment amount"},{"name":"tenor","in":"query","type":"string","required":false,"description":"Contains the term of the deposits or loans contract"},{"name":"rolloverPeriod","in":"query","type":"string","required":false,"description":"Indicates the roll over period after which contract will switch on to the new set of interest or fee conditions. For contracts dealing with periodic indexes, rates are influenced by Amount or Tenor or"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"RequestRateResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/enterprise/pricing/products/{productId}/eligibilities","fullPath":"/api/v1.1.0/enterprise/pricing/products/{productId}/eligibilities","operationId":"getEligibilityDetails","name":"Retrieves the eligibility details of the product for the given party or parties","summary":"Retrieves the eligibility details for the product","tags":["RETAIL"],"parameters":[{"name":"productId","in":"path","type":"string","required":true,"description":"Contains the unique identifier of the product, e.g. the product id of the arrangement account."},{"name":"partyId","in":"query","type":"string","required":false,"description":"Allows capturing of customers or person entities to be part of the relationship. If partyType is selected as Customer, then the system will allow only customer Ids to be captured into this field. If p"},{"name":"partyRole","in":"query","type":"string","required":false,"description":"Contains the identifier used for the role played by the party or customer in the contract or account"},{"name":"effectiveDate","in":"query","type":"string","required":false,"description":"Contains the identifier for the transaction date. Dates are expected in \u00e2\u20ac\u02dcYYYYMMDD\u00e2\u20ac\u2122 format"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"EligibilityDetailsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/enterprise/pricing/arrangements/{baseContractReference}/transactions","fullPath":"/api/v1.1.0/enterprise/pricing/arrangements/{baseContractReference}/transactions","operationId":"getTransactionPricingRequest","name":"Retrieves the charge amounts with benefit applied for transaction business activity","summary":"Retrieves the pricing for transaction business activity","tags":["RETAIL"],"parameters":[{"name":"baseContractReference","in":"path","type":"string","required":true,"description":"Contains the identifier for the contract or account in which the event is raised. This would typically be a unique reference to identify the specific contract or account in the system"},{"name":"systemReference","in":"query","type":"string","required":false,"description":"Contains the identifier for the system in which the event originated from. For ex, \u00e2\u20ac\u02dcHogan\u00e2\u20ac\u2122 or \u00e2\u20ac\u02dcTransactAccounts\u00e2\u20ac\u2122 etc"},{"name":"companyReference","in":"query","type":"string","required":false,"description":"Contains the identifier of the underlying Entity or Company or Branch"},{"name":"eventName","in":"query","type":"string","required":false,"description":"Indicates the name of the event that is understood by the Enterprise product pricing system."},{"name":"effectiveDate","in":"query","type":"string","required":false,"description":"Contains the identifier for the transaction date. Dates are expected in \u00e2\u20ac\u02dcYYYYMMDD\u00e2\u20ac\u2122 format"},{"name":"currency","in":"query","type":"string","required":false,"description":"Identifies the currency. E.g. USD, GBP etc"},{"name":"channel","in":"query","type":"string","required":false,"description":"Contains the channel in which the activity was performed. If pricing is not determined based on channel, then this is not significant"},{"name":"branch","in":"query","type":"string","required":false,"description":"Contains the branch name/code in which the business activity was performed. If pricing is not determined based on branch, then this is not significant"},{"name":"lineOfBusiness","in":"query","type":"string","required":false,"description":"Contains the line of business in which the activity was performed. If pricing is not determined based on line of business, then this is not significant"},{"name":"transactionCurrency","in":"query","type":"string","required":false,"description":"Indicates the currency of the transaction. For example GBP, USD etc."},{"name":"transactionAmount","in":"query","type":"string","required":false,"description":"Contains the transaction amount. This is based on the currency, either local or foreign currency"},{"name":"contractAmount","in":"query","type":"string","required":false,"description":"Contains the amount of the deposits or loans contract."},{"name":"contextName","in":"query","type":"string","required":false,"description":"Indicates specific context that needs to be passed in addition to the amount/currency to indicate more details. This context should influence the pricing."},{"name":"contextValue","in":"query","type":"string","required":false,"description":"Indicates the value passed for the context name."},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"TransactionPricingRequestResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/enterprise/pricing/products/{productId}/pricing","fullPath":"/api/v1.1.0/enterprise/pricing/products/{productId}/pricing","operationId":"getNewActivityPricing","name":"Retrieves the pricing for an event with respect to product's conditions","summary":"Retrieves the pricing for an event","tags":["RETAIL"],"parameters":[{"name":"productId","in":"path","type":"string","required":true,"description":"Contains the unique identifier of the product, e.g. the product id of the arrangement account."},{"name":"companyReference","in":"query","type":"string","required":false,"description":"Contains the identifier of the underlying Entity or Company or Branch"},{"name":"eventName","in":"query","type":"string","required":false,"description":"Indicates the name of the event that is understood by the Enterprise product pricing system."},{"name":"effectiveDate","in":"query","type":"string","required":false,"description":"Contains the identifier for the transaction date. Dates are expected in \u00e2\u20ac\u02dcYYYYMMDD\u00e2\u20ac\u2122 format"},{"name":"currency","in":"query","type":"string","required":false,"description":"Identifies the currency. E.g. USD, GBP etc"},{"name":"channel","in":"query","type":"string","required":false,"description":"Contains the channel in which the activity was performed. If pricing is not determined based on channel, then this is not significant"},{"name":"branch","in":"query","type":"string","required":false,"description":"Contains the branch name/code in which the business activity was performed. If pricing is not determined based on branch, then this is not significant"},{"name":"lineOfBusiness","in":"query","type":"string","required":false,"description":"Contains the line of business in which the activity was performed. If pricing is not determined based on line of business, then this is not significant"},{"name":"partyReference","in":"query","type":"string","required":false,"description":"Contains the identifier used for the party or customer"},{"name":"partyRole","in":"query","type":"string","required":false,"description":"Contains the identifier used for the role played by the party or customer in the contract or account"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"NewActivityPricingResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/enterprise/pricing/arrangements/{arrangementId}/pricing","fullPath":"/api/v1.1.0/enterprise/pricing/arrangements/{arrangementId}/pricing","operationId":"getPricingDetailsEventList","name":"Retrieves the pricing details on a single Event for the given arrangement","summary":"Retrieves the pricing details on a single Event","tags":["RETAIL"],"parameters":[{"name":"arrangementId","in":"path","type":"string","required":true,"description":"Indicates an unique identifier of an account"},{"name":"transactionReference","in":"query","type":"string","required":false,"description":"Contains the identifier for the transaction in the core system"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"PricingDetailsEventListResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/enterprise/pricing/arrangements/packages/{packageId}/periodicCharges","fullPath":"/api/v1.1.0/enterprise/pricing/arrangements/packages/{packageId}/periodicCharges","operationId":"getPackagePeriodicPricing","name":"Retrieves the periodic pricing that have happened on a package along with the details of linked arrangements","summary":"Retrieves the periodic pricing that have happened on a package","tags":["RETAIL"],"parameters":[{"name":"packageId","in":"path","type":"string","required":true,"description":"Indicates the arrangement reference of the package"},{"name":"effectiveDate","in":"query","type":"string","required":false,"description":"Contains the identifier for the transaction date. Dates are expected in \u00e2\u20ac\u02dcYYYYMMDD\u00e2\u20ac\u2122 format"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"PackagePeriodicPricingResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/enterprise/pricing/arrangements/packages/{packageId}","fullPath":"/api/v1.1.0/enterprise/pricing/arrangements/packages/{packageId}","operationId":"getPackageDetails","name":"Retrieves the details of packages created in enterprise product pricing along with the linked arrangements","summary":"Retrieves the details of packages created in enterprise product pricing","tags":["RETAIL"],"parameters":[{"name":"packageId","in":"path","type":"string","required":true,"description":"Indicates the arrangement reference of the package"},{"name":"effectiveDate","in":"query","type":"string","required":false,"description":"Contains the identifier for the transaction date. Dates are expected in \u00e2\u20ac\u02dcYYYYMMDD\u00e2\u20ac\u2122 format"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"PackageDetailsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/enterprise/pricing/parties/{partyId}/arrangements","fullPath":"/api/v1.1.0/enterprise/pricing/parties/{partyId}/arrangements","operationId":"getCustomerHeldContracts","name":"Retrieves the details of contracts held by the party at an enterprise level","summary":"Retrieves the details of contracts held by the party","tags":["RETAIL"],"parameters":[{"name":"partyId","in":"path","type":"string","required":true,"description":"Allows capturing of customers or person entities to be part of the relationship. If partyType is selected as Customer, then the system will allow only customer Ids to be captured into this field. If p"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"CustomerHeldContractsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/enterprise/pricing/arrangements/{baseContractReference}/events","fullPath":"/api/v1.1.0/enterprise/pricing/arrangements/{baseContractReference}/events","operationId":"getContractEventList","name":"Retrieves the details of events for the given enterprise product pricing arrangement","summary":"Retrieves the details of events","tags":["RETAIL"],"parameters":[{"name":"baseContractReference","in":"path","type":"string","required":true,"description":"Contains the identifier for the contract or account in which the event is raised. This would typically be a unique reference to identify the specific contract or account in the system"},{"name":"systemReference","in":"query","type":"string","required":false,"description":"Contains the identifier for the system in which the event originated from. For ex, \u00e2\u20ac\u02dcHogan\u00e2\u20ac\u2122 or \u00e2\u20ac\u02dcTransactAccounts\u00e2\u20ac\u2122 etc"},{"name":"numberOfTransactions","in":"query","type":"string","required":false,"description":"Indicates the number of transactions performed on the contract or the account"},{"name":"dateFrom","in":"query","type":"string","required":false,"description":"Indicates the end date till which the transactions or events performed on the contract or account is to be returned"},{"name":"dateTo","in":"query","type":"string","required":false,"description":"Indicates the start date from which the transactions or events performed on the contract or account is to be returned"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"ContractEventListResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/enterprise/pricing/arrangements/{baseContractReference}/relatedParties","fullPath":"/api/v1.1.0/enterprise/pricing/arrangements/{baseContractReference}/relatedParties","operationId":"getCustomerRelatedArrangement","name":"Retrieves the list of all related parties linked to the given arrangement and other related parties of the beneficial owner","summary":"Retrieves the list of all related parties for the given arrangement","tags":["RETAIL"],"parameters":[{"name":"baseContractReference","in":"path","type":"string","required":true,"description":"Contains the identifier for the contract or account in which the event is raised. This would typically be a unique reference to identify the specific contract or account in the system"},{"name":"systemReference","in":"query","type":"string","required":false,"description":"Contains the identifier for the system in which the event originated from. For ex, \u00e2\u20ac\u02dcHogan\u00e2\u20ac\u2122 or \u00e2\u20ac\u02dcTransactAccounts\u00e2\u20ac\u2122 etc"},{"name":"companyReference","in":"query","type":"string","required":false,"description":"Contains the identifier of the underlying Entity or Company or Branch"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"CustomerRelatedArrangementResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}}]},{"key":"enterprise-pricing-v2.0.0","title":"Enterprise product pricing","version":"v2.0.0","description":"API to retrieve the pricing benefit details for activity charge, periodic charge or interest rates for enterprise product pricing arrangement or package","endpointCount":18,"endpoints":[{"method":"GET","path":"/enterprise/pricing/packages/{packageId}/pricingBenefits","fullPath":"/api/v2.0.0/enterprise/pricing/packages/{packageId}/pricingBenefits","operationId":"getPackageStatement","name":"Retrieves the package pricing details for the package and the linked contracts or accounts. It also retrieves the details of previous statement","summary":"Retrieves the package pricing benefit details","tags":["RETAIL"],"parameters":[{"name":"packageId","in":"path","type":"string","required":true,"description":"Indicates the arrangement reference of the package"},{"name":"startDate","in":"query","type":"string","required":false,"description":"Contains the date on which the transaction or payment gets initiated."},{"name":"endDate","in":"query","type":"string","required":false,"description":"Indicates the date till which the transaction history requested. If 20120101 is the start date and 20120201 is the end date, all transactions that are booked between January 1 to February 1 2012 are r"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"PackageStatementResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/enterprise/pricing/arrangements/{baseContractReference}/activities","fullPath":"/api/v2.0.0/enterprise/pricing/arrangements/{baseContractReference}/activities","operationId":"getActivityChargeAmount","name":"Retrieves the simulated fee amount details with benefits applied to the activity charge event","summary":"Retrieves the fee amount charged for the activity charge event","tags":["RETAIL"],"parameters":[{"name":"baseContractReference","in":"path","type":"string","required":true,"description":"Contains the identifier for the contract or account in which the event is raised. This would typically be a unique reference to identify the specific contract or account in the system"},{"name":"systemReference","in":"query","type":"string","required":false,"description":"Contains the identifier for the system in which the event originated from. For ex, \u00e2\u20ac\u02dcHogan\u00e2\u20ac\u2122 or \u00e2\u20ac\u02dcTransactAccounts\u00e2\u20ac\u2122 etc"},{"name":"companyReference","in":"query","type":"string","required":false,"description":"Contains the identifier of the underlying Entity or Company or Branch"},{"name":"eventName","in":"query","type":"string","required":false,"description":"Indicates the name of the event that is understood by the Enterprise product pricing system."},{"name":"effectiveDate","in":"query","type":"string","required":false,"description":"Contains the identifier for the transaction date. Dates are expected in \u00e2\u20ac\u02dcYYYYMMDD\u00e2\u20ac\u2122 format"},{"name":"channel","in":"query","type":"string","required":false,"description":"Contains the channel in which the activity was performed. If pricing is not determined based on channel, then this is not significant"},{"name":"branch","in":"query","type":"string","required":false,"description":"Contains the branch name/code in which the business activity was performed. If pricing is not determined based on branch, then this is not significant"},{"name":"lineOfBusiness","in":"query","type":"string","required":false,"description":"Contains the line of business in which the activity was performed. If pricing is not determined based on line of business, then this is not significant"},{"name":"transactionReference","in":"query","type":"string","required":false,"description":"Contains the identifier for the transaction in the core system"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"ActivityChargeAmountResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/enterprise/pricing/arrangements/{baseContractReference}/periodicCharges","fullPath":"/api/v2.0.0/enterprise/pricing/arrangements/{baseContractReference}/periodicCharges","operationId":"getPeriodicChargesAmount","name":"Retrieves the simulated fee amount details with benefits applied to the periodic charge event","summary":"Retrieves the fee amount charged for the periodic charge event","tags":["RETAIL"],"parameters":[{"name":"baseContractReference","in":"path","type":"string","required":true,"description":"Contains the identifier for the contract or account in which the event is raised. This would typically be a unique reference to identify the specific contract or account in the system"},{"name":"systemReference","in":"query","type":"string","required":false,"description":"Contains the identifier for the system in which the event originated from. For ex, \u00e2\u20ac\u02dcHogan\u00e2\u20ac\u2122 or \u00e2\u20ac\u02dcTransactAccounts\u00e2\u20ac\u2122 etc"},{"name":"companyReference","in":"query","type":"string","required":false,"description":"Contains the identifier of the underlying Entity or Company or Branch"},{"name":"eventName","in":"query","type":"string","required":false,"description":"Indicates the name of the event that is understood by the Enterprise product pricing system."},{"name":"effectiveDate","in":"query","type":"string","required":false,"description":"Contains the identifier for the transaction date. Dates are expected in \u00e2\u20ac\u02dcYYYYMMDD\u00e2\u20ac\u2122 format"},{"name":"channel","in":"query","type":"string","required":false,"description":"Contains the channel in which the activity was performed. If pricing is not determined based on channel, then this is not significant"},{"name":"branch","in":"query","type":"string","required":false,"description":"Contains the branch name/code in which the business activity was performed. If pricing is not determined based on branch, then this is not significant"},{"name":"lineOfBusiness","in":"query","type":"string","required":false,"description":"Contains the line of business in which the activity was performed. If pricing is not determined based on line of business, then this is not significant"},{"name":"transactionReference","in":"query","type":"string","required":false,"description":"Contains the identifier for the transaction in the core system"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"PeriodicChargesAmountResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/enterprise/pricing/arrangements/{baseContractReference}/rates","fullPath":"/api/v2.0.0/enterprise/pricing/arrangements/{baseContractReference}/rates","operationId":"getInterestRate","name":"Retrieves the simulated interest rates with benefit applied for the given event","summary":"Retrieves the interest rates","tags":["RETAIL"],"parameters":[{"name":"baseContractReference","in":"path","type":"string","required":true,"description":"Contains the identifier for the contract or account in which the event is raised. This would typically be a unique reference to identify the specific contract or account in the system"},{"name":"systemReference","in":"query","type":"string","required":false,"description":"Contains the identifier for the system in which the event originated from. For ex, \u00e2\u20ac\u02dcHogan\u00e2\u20ac\u2122 or \u00e2\u20ac\u02dcTransactAccounts\u00e2\u20ac\u2122 etc"},{"name":"companyReference","in":"query","type":"string","required":false,"description":"Contains the identifier of the underlying Entity or Company or Branch"},{"name":"eventName","in":"query","type":"string","required":false,"description":"Indicates the name of the event that is understood by the Enterprise product pricing system."},{"name":"effectiveDate","in":"query","type":"string","required":false,"description":"Contains the identifier for the transaction date. Dates are expected in \u00e2\u20ac\u02dcYYYYMMDD\u00e2\u20ac\u2122 format"},{"name":"channel","in":"query","type":"string","required":false,"description":"Contains the channel in which the activity was performed. If pricing is not determined based on channel, then this is not significant"},{"name":"branch","in":"query","type":"string","required":false,"description":"Contains the branch name/code in which the business activity was performed. If pricing is not determined based on branch, then this is not significant"},{"name":"lineOfBusiness","in":"query","type":"string","required":false,"description":"Contains the line of business in which the activity was performed. If pricing is not determined based on line of business, then this is not significant"},{"name":"transactionReference","in":"query","type":"string","required":false,"description":"Contains the identifier for the transaction in the core system"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"InterestRateResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/enterprise/pricing/products/{productId}/rates","fullPath":"/api/v2.0.0/enterprise/pricing/products/{productId}/rates","operationId":"getRequestRate","name":"Retrieves the interest rates with benefit applied for the given product","summary":"Retrieves the interest rates for the given product","tags":["RETAIL"],"parameters":[{"name":"productId","in":"path","type":"string","required":true,"description":"Contains the unique identifier of the product, e.g. the product id of the arrangement account."},{"name":"partyId","in":"query","type":"string","required":false,"description":"Allows capturing of customers or person entities to be part of the relationship. If partyType is selected as Customer, then the system will allow only customer Ids to be captured into this field. If p"},{"name":"effectiveDate","in":"query","type":"string","required":false,"description":"Contains the identifier for the transaction date. Dates are expected in \u00e2\u20ac\u02dcYYYYMMDD\u00e2\u20ac\u2122 format"},{"name":"rateName","in":"query","type":"string","required":false,"description":"Contains the identifier for the underlying interest rate component(s). Eg: Credit interest, Debit Interest, Penalty Interest etc"},{"name":"amount","in":"query","type":"string","required":false,"description":"This is the payment amount"},{"name":"tenor","in":"query","type":"string","required":false,"description":"Contains the term of the deposits or loans contract"},{"name":"rolloverPeriod","in":"query","type":"string","required":false,"description":""},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"RequestRateResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/enterprise/pricing/products/{productId}/eligibilities","fullPath":"/api/v2.0.0/enterprise/pricing/products/{productId}/eligibilities","operationId":"getEligibilityDetails","name":"Retrieves the eligibility details of the product for the given party or parties","summary":"Retrieves the eligibility details for the product","tags":["RETAIL"],"parameters":[{"name":"productId","in":"path","type":"string","required":true,"description":"Contains the unique identifier of the product, e.g. the product id of the arrangement account."},{"name":"partyId","in":"query","type":"string","required":false,"description":"Allows capturing of customers or person entities to be part of the relationship. If partyType is selected as Customer, then the system will allow only customer Ids to be captured into this field. If p"},{"name":"partyRole","in":"query","type":"string","required":false,"description":"Contains the identifier used for the role played by the party or customer in the contract or account"},{"name":"effectiveDate","in":"query","type":"string","required":false,"description":"Contains the identifier for the transaction date. Dates are expected in \u00e2\u20ac\u02dcYYYYMMDD\u00e2\u20ac\u2122 format"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"EligibilityDetailsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/enterprise/pricing/arrangements/{baseContractReference}/transactions","fullPath":"/api/v2.0.0/enterprise/pricing/arrangements/{baseContractReference}/transactions","operationId":"getTransactionPricingRequest","name":"Retrieves the charge amounts with benefit applied for transaction business activity","summary":"Retrieves the pricing for transaction business activity","tags":["RETAIL"],"parameters":[{"name":"baseContractReference","in":"path","type":"string","required":true,"description":"Contains the identifier for the contract or account in which the event is raised. This would typically be a unique reference to identify the specific contract or account in the system"},{"name":"systemReference","in":"query","type":"string","required":false,"description":"Contains the identifier for the system in which the event originated from. For ex, \u00e2\u20ac\u02dcHogan\u00e2\u20ac\u2122 or \u00e2\u20ac\u02dcTransactAccounts\u00e2\u20ac\u2122 etc"},{"name":"companyReference","in":"query","type":"string","required":false,"description":"Contains the identifier of the underlying Entity or Company or Branch"},{"name":"eventName","in":"query","type":"string","required":false,"description":"Indicates the name of the event that is understood by the Enterprise product pricing system."},{"name":"effectiveDate","in":"query","type":"string","required":false,"description":"Contains the identifier for the transaction date. Dates are expected in \u00e2\u20ac\u02dcYYYYMMDD\u00e2\u20ac\u2122 format"},{"name":"currency","in":"query","type":"string","required":false,"description":"Identifies the currency. E.g. USD, GBP etc"},{"name":"channel","in":"query","type":"string","required":false,"description":"Contains the channel in which the activity was performed. If pricing is not determined based on channel, then this is not significant"},{"name":"branch","in":"query","type":"string","required":false,"description":"Contains the branch name/code in which the business activity was performed. If pricing is not determined based on branch, then this is not significant"},{"name":"lineOfBusiness","in":"query","type":"string","required":false,"description":"Contains the line of business in which the activity was performed. If pricing is not determined based on line of business, then this is not significant"},{"name":"transactionCurrency","in":"query","type":"string","required":false,"description":"Indicates the currency of the transaction. For example GBP, USD etc."},{"name":"transactionAmount","in":"query","type":"string","required":false,"description":"Contains the transaction amount. This is based on the currency, either local or foreign currency"},{"name":"contractAmount","in":"query","type":"string","required":false,"description":"Contains the amount of the deposits or loans contract."},{"name":"contextName","in":"query","type":"string","required":false,"description":"Indicates specific context that needs to be passed in addition to the amount/currency to indicate more details. This context should influence the pricing."},{"name":"contextValue","in":"query","type":"string","required":false,"description":"Indicates the value passed for the context name."},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"TransactionPricingRequestResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/enterprise/pricing/products/{productId}/pricing","fullPath":"/api/v2.0.0/enterprise/pricing/products/{productId}/pricing","operationId":"getNewActivityPricing","name":"Retrieves the pricing for an event with respect to product's conditions","summary":"Retrieves the pricing for an event","tags":["RETAIL"],"parameters":[{"name":"productId","in":"path","type":"string","required":true,"description":"Contains the unique identifier of the product, e.g. the product id of the arrangement account."},{"name":"companyReference","in":"query","type":"string","required":false,"description":"Contains the identifier of the underlying Entity or Company or Branch"},{"name":"eventName","in":"query","type":"string","required":false,"description":"Indicates the name of the event that is understood by the Enterprise product pricing system."},{"name":"effectiveDate","in":"query","type":"string","required":false,"description":"Contains the identifier for the transaction date. Dates are expected in \u00e2\u20ac\u02dcYYYYMMDD\u00e2\u20ac\u2122 format"},{"name":"currency","in":"query","type":"string","required":false,"description":"Identifies the currency. E.g. USD, GBP etc"},{"name":"channel","in":"query","type":"string","required":false,"description":"Contains the channel in which the activity was performed. If pricing is not determined based on channel, then this is not significant"},{"name":"branch","in":"query","type":"string","required":false,"description":"Contains the branch name/code in which the business activity was performed. If pricing is not determined based on branch, then this is not significant"},{"name":"lineOfBusiness","in":"query","type":"string","required":false,"description":"Contains the line of business in which the activity was performed. If pricing is not determined based on line of business, then this is not significant"},{"name":"partyReference","in":"query","type":"string","required":false,"description":"Contains the identifier used for the party or customer"},{"name":"partyRole","in":"query","type":"string","required":false,"description":"Contains the identifier used for the role played by the party or customer in the contract or account"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"NewActivityPricingResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/enterprise/pricing/arrangements/{arrangementId}/pricing/{transactionReference}","fullPath":"/api/v2.0.0/enterprise/pricing/arrangements/{arrangementId}/pricing/{transactionReference}","operationId":"getPricingDetailsEventList","name":"Retrieves the pricing details for the arrangement and the transaction reference","summary":"Retrieves the pricing details for a transaction","tags":["RETAIL"],"parameters":[{"name":"arrangementId","in":"path","type":"string","required":true,"description":"Indicates an unique identifier of an account"},{"name":"transactionReference","in":"path","type":"string","required":true,"description":"Contains the identifier for the transaction in the core system"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"PricingDetailsEventListResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/enterprise/pricing/arrangements/packages/{packageId}/periodicCharges","fullPath":"/api/v2.0.0/enterprise/pricing/arrangements/packages/{packageId}/periodicCharges","operationId":"getPackagePeriodicPricing","name":"Retrieves the periodic pricing that have happened on a package along with the details of linked arrangements","summary":"Retrieves the periodic pricing that have happened on a package","tags":["RETAIL"],"parameters":[{"name":"packageId","in":"path","type":"string","required":true,"description":"Indicates the arrangement reference of the package"},{"name":"effectiveDate","in":"query","type":"string","required":false,"description":"Contains the identifier for the transaction date. Dates are expected in \u00e2\u20ac\u02dcYYYYMMDD\u00e2\u20ac\u2122 format"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"PackagePeriodicPricingResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/enterprise/pricing/arrangements/packages/{packageId}","fullPath":"/api/v2.0.0/enterprise/pricing/arrangements/packages/{packageId}","operationId":"getPackageDetails","name":"Retrieves the details of packages created in enterprise product pricing along with the linked arrangements","summary":"Retrieves the details of packages created in enterprise product pricing","tags":["RETAIL"],"parameters":[{"name":"packageId","in":"path","type":"string","required":true,"description":"Indicates the arrangement reference of the package"},{"name":"effectiveDate","in":"query","type":"string","required":false,"description":"Contains the identifier for the transaction date. Dates are expected in \u00e2\u20ac\u02dcYYYYMMDD\u00e2\u20ac\u2122 format"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"PackageDetailsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/enterprise/pricing/parties/{partyId}/arrangements","fullPath":"/api/v2.0.0/enterprise/pricing/parties/{partyId}/arrangements","operationId":"getCustomerHeldContracts","name":"Retrieves the details of contracts held by the party at an enterprise level","summary":"Retrieves the details of contracts held by the party","tags":["RETAIL"],"parameters":[{"name":"partyId","in":"path","type":"string","required":true,"description":"Allows capturing of customers or person entities to be part of the relationship. If partyType is selected as Customer, then the system will allow only customer Ids to be captured into this field. If p"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"CustomerHeldContractsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/enterprise/pricing/arrangements/{baseContractReference}/events","fullPath":"/api/v2.0.0/enterprise/pricing/arrangements/{baseContractReference}/events","operationId":"getContractEventList","name":"Retrieves the details of events for the given enterprise product pricing arrangement","summary":"Retrieves the details of events","tags":["RETAIL"],"parameters":[{"name":"baseContractReference","in":"path","type":"string","required":true,"description":"Contains the identifier for the contract or account in which the event is raised. This would typically be a unique reference to identify the specific contract or account in the system"},{"name":"systemReference","in":"query","type":"string","required":false,"description":"Contains the identifier for the system in which the event originated from. For ex, \u00e2\u20ac\u02dcHogan\u00e2\u20ac\u2122 or \u00e2\u20ac\u02dcTransactAccounts\u00e2\u20ac\u2122 etc"},{"name":"numberOfTransactions","in":"query","type":"string","required":false,"description":"Indicates the number of transactions performed on the contract or the account"},{"name":"dateFrom","in":"query","type":"string","required":false,"description":"Indicates the end date till which the transactions or events performed on the contract or account is to be returned"},{"name":"dateTo","in":"query","type":"string","required":false,"description":"Indicates the start date from which the transactions or events performed on the contract or account is to be returned"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"ContractEventListResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/enterprise/pricing/arrangements/{baseContractReference}/relatedParties","fullPath":"/api/v2.0.0/enterprise/pricing/arrangements/{baseContractReference}/relatedParties","operationId":"getCustomerRelatedArrangement","name":"Retrieves the list of all related parties linked to the given arrangement and other related parties of the beneficial owner","summary":"Retrieves the list of all related parties for the given arrangement","tags":["RETAIL"],"parameters":[{"name":"baseContractReference","in":"path","type":"string","required":true,"description":"Contains the identifier for the contract or account in which the event is raised. This would typically be a unique reference to identify the specific contract or account in the system"},{"name":"systemReference","in":"query","type":"string","required":false,"description":"Contains the identifier for the system in which the event originated from. For ex, \u00e2\u20ac\u02dcHogan\u00e2\u20ac\u2122 or \u00e2\u20ac\u02dcTransactAccounts\u00e2\u20ac\u2122 etc"},{"name":"companyReference","in":"query","type":"string","required":false,"description":"Contains the identifier of the underlying Entity or Company or Branch"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"CustomerRelatedArrangementResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/enterprise/pricing/{pricingId}","fullPath":"/api/v2.0.0/enterprise/pricing/{pricingId}","operationId":"getPricingDetails","name":"Retrieves the pricing details such as the pricing class, pricing property, pricing program, pricing benefit, benefit value, tier final rate, tier base value, tier spread, individual pricing properties and their benefit details, etc.","summary":"Retrieves the pricing details","tags":["RETAIL"],"parameters":[{"name":"pricingId","in":"path","type":"string","required":true,"description":"Indicates the unique reference for the pricing evaluated for the property or property class defined in the pricing rules."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"PricingDetailsResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/enterprise/pricing/evaluations/{evaluationId}","fullPath":"/api/v2.0.0/enterprise/pricing/evaluations/{evaluationId}","operationId":"getPricingEvaluation","name":"Retrieves the pricing evaluation details such as the eligibility rule evaluation, evaluation  result, pricing benefit and pricing benefit program etc.","summary":"Retrieves the pricing evaluation details","tags":["RETAIL"],"parameters":[{"name":"evaluationId","in":"path","type":"string","required":true,"description":"Indicates the unique reference for the evaluation results of each and every rule run through pricing rules or activity restriction"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"PricingEvaluationResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/enterprise/pricing/arrangements/{arrangementId}/pricing","fullPath":"/api/v2.0.0/enterprise/pricing/arrangements/{arrangementId}/pricing","operationId":"getArrangementPricing","name":"Retrieves the list of pricing details for an arrangement and the transaction period. It includes details such as the pricing class, pricing property, base value, adjustment value, net value, transaction pricing name, transaction base value, base contract reference, system reference and evaluation reference","summary":"Retrieves the list of pricing details for an arrangement","tags":["RETAIL"],"parameters":[{"name":"arrangementId","in":"path","type":"string","required":true,"description":"Indicates an unique identifier of an account"},{"name":"effectiveDate","in":"query","type":"string","required":false,"description":"Contains the identifier for the transaction date. Dates are expected in \u00e2\u20ac\u02dcYYYYMMDD\u00e2\u20ac\u2122 format"},{"name":"baseTransactionReference","in":"query","type":"string","required":false,"description":"Indicates the transaction reference which is triggered from external system like \u00e2\u20ac\u02dcHogan\u00e2\u20ac\u2122 or \u00e2\u20ac\u02dcTransactAccounts\u00e2\u20ac\u2122 etc"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"ArrangementPricingResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/enterprise/pricing/parties/{partyId}/pricing","fullPath":"/api/v2.0.0/enterprise/pricing/parties/{partyId}/pricing","operationId":"getCustomerPricing","name":"Retrieves the list of pricing details available for the customer and the transaction period. It includes details such as the pricing class, pricing property, base value, adjust value, net value, transaction pricing name, transaction base value, base contract reference, system reference and evaluation reference","summary":"Retrieves the list of pricing details available for the customer","tags":["RETAIL"],"parameters":[{"name":"partyId","in":"path","type":"string","required":true,"description":"Allows capturing of customers or person entities to be part of the relationship. If partyType is selected as Customer, then the system will allow only customer Ids to be captured into this field. If p"},{"name":"effectiveDate","in":"query","type":"string","required":false,"description":"Contains the identifier for the transaction date. Dates are expected in \u00e2\u20ac\u02dcYYYYMMDD\u00e2\u20ac\u2122 format"},{"name":"baseTransactionReference","in":"query","type":"string","required":false,"description":"Indicates the transaction reference which is triggered from external system like \u00e2\u20ac\u02dcHogan\u00e2\u20ac\u2122 or \u00e2\u20ac\u02dcTransactAccounts\u00e2\u20ac\u2122 etc"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"CustomerPricingResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}}]},{"key":"enterprise-pricing-v2.1.0","title":"Enterprise product pricing","version":"v2.1.0","description":"API to retrieve the pricing benefit details for activity charge, periodic charge or interest rates for enterprise product pricing arrangement or package","endpointCount":18,"endpoints":[{"method":"GET","path":"/enterprise/pricing/packages/{packageId}/pricingBenefits","fullPath":"/api/v2.1.0/enterprise/pricing/packages/{packageId}/pricingBenefits","operationId":"getPackageStatement","name":"Retrieves the package pricing details for the package and the linked contracts or accounts. It also retrieves the details of previous statement","summary":"Retrieves the package pricing benefit details","tags":["RETAIL"],"parameters":[{"name":"packageId","in":"path","type":"string","required":true,"description":"Indicates the arrangement reference of the package"},{"name":"startDate","in":"query","type":"string","required":true,"description":"Contains the date on which the transaction or payment gets initiated."},{"name":"endDate","in":"query","type":"string","required":true,"description":"Indicates the date till which the transaction history requested. If 20120101 is the start date and 20120201 is the end date, all transactions that are booked between January 1 to February 1 2012 are r"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"PackageStatementResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/enterprise/pricing/arrangements/{baseContractReference}/activities","fullPath":"/api/v2.1.0/enterprise/pricing/arrangements/{baseContractReference}/activities","operationId":"getActivityChargeAmount","name":"Retrieves the simulated fee amount details with benefits applied to the activity charge event","summary":"Retrieves the fee amount charged for the activity charge event","tags":["RETAIL"],"parameters":[{"name":"baseContractReference","in":"path","type":"string","required":true,"description":"Contains the identifier for the contract or account in which the event is raised. This would typically be a unique reference to identify the specific contract or account in the system"},{"name":"systemReference","in":"query","type":"string","required":true,"description":"Contains the identifier for the system in which the event originated from. For ex, \u00e2\u20ac\u02dcHogan\u00e2\u20ac\u2122 or \u00e2\u20ac\u02dcTransactAccounts\u00e2\u20ac\u2122 etc"},{"name":"companyReference","in":"query","type":"string","required":false,"description":"Contains the identifier of the underlying Entity or Company or Branch"},{"name":"eventName","in":"query","type":"string","required":true,"description":"Indicates the name of the event that is understood by the Enterprise product pricing system."},{"name":"effectiveDate","in":"query","type":"string","required":false,"description":"Contains the identifier for the transaction date. Dates are expected in \u00e2\u20ac\u02dcYYYYMMDD\u00e2\u20ac\u2122 format"},{"name":"channel","in":"query","type":"string","required":false,"description":"Contains the channel in which the activity was performed. If pricing is not determined based on channel, then this is not significant"},{"name":"branch","in":"query","type":"string","required":false,"description":"Contains the branch name/code in which the business activity was performed. If pricing is not determined based on branch, then this is not significant"},{"name":"lineOfBusiness","in":"query","type":"string","required":false,"description":"Contains the line of business in which the activity was performed. If pricing is not determined based on line of business, then this is not significant"},{"name":"transactionReference","in":"query","type":"string","required":false,"description":"Contains the identifier for the transaction in the core system"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"ActivityChargeAmountResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/enterprise/pricing/arrangements/{baseContractReference}/periodicCharges","fullPath":"/api/v2.1.0/enterprise/pricing/arrangements/{baseContractReference}/periodicCharges","operationId":"getPeriodicChargesAmount","name":"Retrieves the simulated fee amount details with benefits applied to the periodic charge event","summary":"Retrieves the fee amount charged for the periodic charge event","tags":["RETAIL"],"parameters":[{"name":"baseContractReference","in":"path","type":"string","required":true,"description":"Contains the identifier for the contract or account in which the event is raised. This would typically be a unique reference to identify the specific contract or account in the system"},{"name":"systemReference","in":"query","type":"string","required":true,"description":"Contains the identifier for the system in which the event originated from. For ex, \u00e2\u20ac\u02dcHogan\u00e2\u20ac\u2122 or \u00e2\u20ac\u02dcTransactAccounts\u00e2\u20ac\u2122 etc"},{"name":"companyReference","in":"query","type":"string","required":false,"description":"Contains the identifier of the underlying Entity or Company or Branch"},{"name":"eventName","in":"query","type":"string","required":true,"description":"Indicates the name of the event that is understood by the Enterprise product pricing system."},{"name":"effectiveDate","in":"query","type":"string","required":false,"description":"Contains the identifier for the transaction date. Dates are expected in \u00e2\u20ac\u02dcYYYYMMDD\u00e2\u20ac\u2122 format"},{"name":"channel","in":"query","type":"string","required":false,"description":"Contains the channel in which the activity was performed. If pricing is not determined based on channel, then this is not significant"},{"name":"branch","in":"query","type":"string","required":false,"description":"Contains the branch name/code in which the business activity was performed. If pricing is not determined based on branch, then this is not significant"},{"name":"lineOfBusiness","in":"query","type":"string","required":false,"description":"Contains the line of business in which the activity was performed. If pricing is not determined based on line of business, then this is not significant"},{"name":"transactionReference","in":"query","type":"string","required":false,"description":"Contains the identifier for the transaction in the core system"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"PeriodicChargesAmountResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/enterprise/pricing/arrangements/{baseContractReference}/rates","fullPath":"/api/v2.1.0/enterprise/pricing/arrangements/{baseContractReference}/rates","operationId":"getInterestRate","name":"Retrieves the simulated interest rates with benefit applied for the given event","summary":"Retrieves the interest rates","tags":["RETAIL"],"parameters":[{"name":"baseContractReference","in":"path","type":"string","required":true,"description":"Contains the identifier for the contract or account in which the event is raised. This would typically be a unique reference to identify the specific contract or account in the system"},{"name":"systemReference","in":"query","type":"string","required":true,"description":"Contains the identifier for the system in which the event originated from. For ex, \u00e2\u20ac\u02dcHogan\u00e2\u20ac\u2122 or \u00e2\u20ac\u02dcTransactAccounts\u00e2\u20ac\u2122 etc"},{"name":"companyReference","in":"query","type":"string","required":false,"description":"Contains the identifier of the underlying Entity or Company or Branch"},{"name":"eventName","in":"query","type":"string","required":true,"description":"Indicates the name of the event that is understood by the Enterprise product pricing system."},{"name":"effectiveDate","in":"query","type":"string","required":false,"description":"Contains the identifier for the transaction date. Dates are expected in \u00e2\u20ac\u02dcYYYYMMDD\u00e2\u20ac\u2122 format"},{"name":"channel","in":"query","type":"string","required":false,"description":"Contains the channel in which the activity was performed. If pricing is not determined based on channel, then this is not significant"},{"name":"branch","in":"query","type":"string","required":false,"description":"Contains the branch name/code in which the business activity was performed. If pricing is not determined based on branch, then this is not significant"},{"name":"lineOfBusiness","in":"query","type":"string","required":false,"description":"Contains the line of business in which the activity was performed. If pricing is not determined based on line of business, then this is not significant"},{"name":"transactionReference","in":"query","type":"string","required":false,"description":"Contains the identifier for the transaction in the core system"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"InterestRateResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/enterprise/pricing/products/{productId}/rates","fullPath":"/api/v2.1.0/enterprise/pricing/products/{productId}/rates","operationId":"getRequestRate","name":"Retrieves the interest rates with benefit applied for the given product","summary":"Retrieves the interest rates for the given product","tags":["RETAIL"],"parameters":[{"name":"productId","in":"path","type":"string","required":true,"description":"Contains the unique identifier of the product, e.g. the product id of the arrangement account."},{"name":"partyId","in":"query","type":"string","required":false,"description":"Allows capturing of customers or person entities to be part of the relationship. If partyType is selected as Customer, then the system will allow only customer Ids to be captured into this field. If p"},{"name":"effectiveDate","in":"query","type":"string","required":false,"description":"Contains the identifier for the transaction date. Dates are expected in \u00e2\u20ac\u02dcYYYYMMDD\u00e2\u20ac\u2122 format"},{"name":"rateName","in":"query","type":"string","required":false,"description":"Contains the identifier for the underlying interest rate component(s). Eg: Credit interest, Debit Interest, Penalty Interest etc"},{"name":"amount","in":"query","type":"string","required":false,"description":"This is the payment amount"},{"name":"tenor","in":"query","type":"string","required":false,"description":"Contains the term of the deposits or loans contract"},{"name":"rolloverPeriod","in":"query","type":"string","required":false,"description":""},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"RequestRateResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/enterprise/pricing/products/{productId}/eligibilities","fullPath":"/api/v2.1.0/enterprise/pricing/products/{productId}/eligibilities","operationId":"getEligibilityDetails","name":"Retrieves the eligibility details of the product for the given party or parties","summary":"Retrieves the eligibility details for the product","tags":["RETAIL"],"parameters":[{"name":"productId","in":"path","type":"string","required":true,"description":"Contains the unique identifier of the product, e.g. the product id of the arrangement account."},{"name":"partyId","in":"query","type":"string","required":true,"description":"Allows capturing of customers or person entities to be part of the relationship. If partyType is selected as Customer, then the system will allow only customer Ids to be captured into this field. If p"},{"name":"partyRole","in":"query","type":"string","required":false,"description":"Contains the identifier used for the role played by the party or customer in the contract or account"},{"name":"effectiveDate","in":"query","type":"string","required":false,"description":"Contains the identifier for the transaction date. Dates are expected in \u00e2\u20ac\u02dcYYYYMMDD\u00e2\u20ac\u2122 format"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"EligibilityDetailsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/enterprise/pricing/arrangements/{baseContractReference}/transactions","fullPath":"/api/v2.1.0/enterprise/pricing/arrangements/{baseContractReference}/transactions","operationId":"getTransactionPricingRequest","name":"Retrieves the charge amounts with benefit applied for transaction business activity","summary":"Retrieves the pricing for transaction business activity","tags":["RETAIL"],"parameters":[{"name":"baseContractReference","in":"path","type":"string","required":true,"description":"Contains the identifier for the contract or account in which the event is raised. This would typically be a unique reference to identify the specific contract or account in the system"},{"name":"systemReference","in":"query","type":"string","required":true,"description":"Contains the identifier for the system in which the event originated from. For ex, \u00e2\u20ac\u02dcHogan\u00e2\u20ac\u2122 or \u00e2\u20ac\u02dcTransactAccounts\u00e2\u20ac\u2122 etc"},{"name":"companyReference","in":"query","type":"string","required":false,"description":"Contains the identifier of the underlying Entity or Company or Branch"},{"name":"eventName","in":"query","type":"string","required":true,"description":"Indicates the name of the event that is understood by the Enterprise product pricing system."},{"name":"effectiveDate","in":"query","type":"string","required":false,"description":"Contains the identifier for the transaction date. Dates are expected in \u00e2\u20ac\u02dcYYYYMMDD\u00e2\u20ac\u2122 format"},{"name":"currency","in":"query","type":"string","required":true,"description":"Identifies the currency. E.g. USD, GBP etc"},{"name":"channel","in":"query","type":"string","required":false,"description":"Contains the channel in which the activity was performed. If pricing is not determined based on channel, then this is not significant"},{"name":"branch","in":"query","type":"string","required":false,"description":"Contains the branch name/code in which the business activity was performed. If pricing is not determined based on branch, then this is not significant"},{"name":"lineOfBusiness","in":"query","type":"string","required":false,"description":"Contains the line of business in which the activity was performed. If pricing is not determined based on line of business, then this is not significant"},{"name":"transactionCurrency","in":"query","type":"string","required":false,"description":"Indicates the currency of the transaction. For example GBP, USD etc."},{"name":"transactionAmount","in":"query","type":"string","required":false,"description":"Contains the transaction amount. This is based on the currency, either local or foreign currency"},{"name":"contractAmount","in":"query","type":"string","required":false,"description":"Contains the amount of the deposits or loans contract."},{"name":"contextName","in":"query","type":"string","required":false,"description":"Indicates specific context that needs to be passed in addition to the amount/currency to indicate more details. This context should influence the pricing."},{"name":"contextValue","in":"query","type":"string","required":false,"description":"Indicates the value passed for the context name."},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"TransactionPricingRequestResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/enterprise/pricing/products/{productId}/pricing","fullPath":"/api/v2.1.0/enterprise/pricing/products/{productId}/pricing","operationId":"getNewActivityPricing","name":"Retrieves the pricing for an event with respect to product's conditions","summary":"Retrieves the pricing for an event","tags":["RETAIL"],"parameters":[{"name":"productId","in":"path","type":"string","required":true,"description":"Contains the unique identifier of the product, e.g. the product id of the arrangement account."},{"name":"companyReference","in":"query","type":"string","required":false,"description":"Contains the identifier of the underlying Entity or Company or Branch"},{"name":"eventName","in":"query","type":"string","required":true,"description":"Indicates the name of the event that is understood by the Enterprise product pricing system."},{"name":"effectiveDate","in":"query","type":"string","required":false,"description":"Contains the identifier for the transaction date. Dates are expected in \u00e2\u20ac\u02dcYYYYMMDD\u00e2\u20ac\u2122 format"},{"name":"currency","in":"query","type":"string","required":true,"description":"Identifies the currency. E.g. USD, GBP etc"},{"name":"channel","in":"query","type":"string","required":false,"description":"Contains the channel in which the activity was performed. If pricing is not determined based on channel, then this is not significant"},{"name":"branch","in":"query","type":"string","required":false,"description":"Contains the branch name/code in which the business activity was performed. If pricing is not determined based on branch, then this is not significant"},{"name":"lineOfBusiness","in":"query","type":"string","required":false,"description":"Contains the line of business in which the activity was performed. If pricing is not determined based on line of business, then this is not significant"},{"name":"partyReference","in":"query","type":"string","required":true,"description":"Contains the identifier used for the party or customer"},{"name":"partyRole","in":"query","type":"string","required":false,"description":"Contains the identifier used for the role played by the party or customer in the contract or account"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"NewActivityPricingResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/enterprise/pricing/arrangements/{arrangementId}/pricing/{transactionReference}","fullPath":"/api/v2.1.0/enterprise/pricing/arrangements/{arrangementId}/pricing/{transactionReference}","operationId":"getPricingDetailsEventList","name":"Retrieves the pricing details for the arrangement and the transaction reference","summary":"Retrieves the pricing details for a transaction","tags":["RETAIL"],"parameters":[{"name":"arrangementId","in":"path","type":"string","required":true,"description":"Indicates an unique identifier of an account"},{"name":"transactionReference","in":"path","type":"string","required":true,"description":"Contains the identifier for the transaction in the core system"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"PricingDetailsEventListResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/enterprise/pricing/arrangements/packages/{packageId}/periodicCharges","fullPath":"/api/v2.1.0/enterprise/pricing/arrangements/packages/{packageId}/periodicCharges","operationId":"getPackagePeriodicPricing","name":"Retrieves the periodic pricing that have happened on a package along with the details of linked arrangements","summary":"Retrieves the periodic pricing that have happened on a package","tags":["RETAIL"],"parameters":[{"name":"packageId","in":"path","type":"string","required":true,"description":"Indicates the arrangement reference of the package"},{"name":"effectiveDate","in":"query","type":"string","required":false,"description":"Contains the identifier for the transaction date. Dates are expected in \u00e2\u20ac\u02dcYYYYMMDD\u00e2\u20ac\u2122 format"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"PackagePeriodicPricingResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/enterprise/pricing/arrangements/packages/{packageId}","fullPath":"/api/v2.1.0/enterprise/pricing/arrangements/packages/{packageId}","operationId":"getPackageDetails","name":"Retrieves the details of packages created in enterprise product pricing along with the linked arrangements","summary":"Retrieves the details of packages created in enterprise product pricing","tags":["RETAIL"],"parameters":[{"name":"packageId","in":"path","type":"string","required":true,"description":"Indicates the arrangement reference of the package"},{"name":"effectiveDate","in":"query","type":"string","required":false,"description":"Contains the identifier for the transaction date. Dates are expected in \u00e2\u20ac\u02dcYYYYMMDD\u00e2\u20ac\u2122 format"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"PackageDetailsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/enterprise/pricing/parties/{partyId}/arrangements","fullPath":"/api/v2.1.0/enterprise/pricing/parties/{partyId}/arrangements","operationId":"getCustomerHeldContracts","name":"Retrieves the details of contracts held by the party at an enterprise level","summary":"Retrieves the details of contracts held by the party","tags":["RETAIL"],"parameters":[{"name":"partyId","in":"path","type":"string","required":true,"description":"Allows capturing of customers or person entities to be part of the relationship. If partyType is selected as Customer, then the system will allow only customer Ids to be captured into this field. If p"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"CustomerHeldContractsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/enterprise/pricing/arrangements/{baseContractReference}/events","fullPath":"/api/v2.1.0/enterprise/pricing/arrangements/{baseContractReference}/events","operationId":"getContractEventList","name":"Retrieves the details of events for the given enterprise product pricing arrangement","summary":"Retrieves the details of events","tags":["RETAIL"],"parameters":[{"name":"baseContractReference","in":"path","type":"string","required":true,"description":"Contains the identifier for the contract or account in which the event is raised. This would typically be a unique reference to identify the specific contract or account in the system"},{"name":"systemReference","in":"query","type":"string","required":true,"description":"Contains the identifier for the system in which the event originated from. For ex, \u00e2\u20ac\u02dcHogan\u00e2\u20ac\u2122 or \u00e2\u20ac\u02dcTransactAccounts\u00e2\u20ac\u2122 etc"},{"name":"numberOfTransactions","in":"query","type":"string","required":false,"description":"Indicates the number of transactions performed on the contract or the account"},{"name":"dateFrom","in":"query","type":"string","required":false,"description":"Indicates the end date till which the transactions or events performed on the contract or account is to be returned"},{"name":"dateTo","in":"query","type":"string","required":false,"description":"Indicates the start date from which the transactions or events performed on the contract or account is to be returned"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"ContractEventListResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/enterprise/pricing/arrangements/{baseContractReference}/relatedParties","fullPath":"/api/v2.1.0/enterprise/pricing/arrangements/{baseContractReference}/relatedParties","operationId":"getCustomerRelatedArrangement","name":"Retrieves the list of all related parties linked to the given arrangement and other related parties of the beneficial owner","summary":"Retrieves the list of all related parties for the given arrangement","tags":["RETAIL"],"parameters":[{"name":"baseContractReference","in":"path","type":"string","required":true,"description":"Contains the identifier for the contract or account in which the event is raised. This would typically be a unique reference to identify the specific contract or account in the system"},{"name":"systemReference","in":"query","type":"string","required":true,"description":"Contains the identifier for the system in which the event originated from. For ex, \u00e2\u20ac\u02dcHogan\u00e2\u20ac\u2122 or \u00e2\u20ac\u02dcTransactAccounts\u00e2\u20ac\u2122 etc"},{"name":"companyReference","in":"query","type":"string","required":false,"description":"Contains the identifier of the underlying Entity or Company or Branch"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"CustomerRelatedArrangementResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/enterprise/pricing/{pricingId}","fullPath":"/api/v2.1.0/enterprise/pricing/{pricingId}","operationId":"getPricingDetails","name":"Retrieves the pricing details such as the pricing class, pricing property, pricing program, pricing benefit, benefit value, tier final rate, tier base value, tier spread, individual pricing properties and their benefit details, etc.","summary":"Retrieves the pricing details","tags":["RETAIL"],"parameters":[{"name":"pricingId","in":"path","type":"string","required":true,"description":"Indicates the unique reference for the pricing evaluated for the property or property class defined in the pricing rules."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"PricingDetailsResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/enterprise/pricing/evaluations/{evaluationId}","fullPath":"/api/v2.1.0/enterprise/pricing/evaluations/{evaluationId}","operationId":"getPricingEvaluation","name":"Retrieves the pricing evaluation details such as the eligibility rule evaluation, evaluation  result, pricing benefit and pricing benefit program etc.","summary":"Retrieves the pricing evaluation details","tags":["RETAIL"],"parameters":[{"name":"evaluationId","in":"path","type":"string","required":true,"description":"Indicates the unique reference for the evaluation results of each and every rule run through pricing rules or activity restriction"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"PricingEvaluationResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/enterprise/pricing/arrangements/{arrangementId}/pricing","fullPath":"/api/v2.1.0/enterprise/pricing/arrangements/{arrangementId}/pricing","operationId":"getArrangementPricing","name":"Retrieves the list of pricing details for an arrangement and the transaction period. It includes details such as the pricing class, pricing property, base value, adjustment value, net value, transaction pricing name, transaction base value, base contract reference, system reference and evaluation reference","summary":"Retrieves the list of pricing details for an arrangement","tags":["RETAIL"],"parameters":[{"name":"arrangementId","in":"path","type":"string","required":true,"description":"Indicates an unique identifier of an account"},{"name":"effectiveDate","in":"query","type":"string","required":false,"description":"Contains the identifier for the transaction date. Dates are expected in \u00e2\u20ac\u02dcYYYYMMDD\u00e2\u20ac\u2122 format"},{"name":"baseTransactionReference","in":"query","type":"string","required":false,"description":"Indicates the transaction reference which is triggered from external system like \u00e2\u20ac\u02dcHogan\u00e2\u20ac\u2122 or \u00e2\u20ac\u02dcTransactAccounts\u00e2\u20ac\u2122 etc"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"ArrangementPricingResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/enterprise/pricing/parties/{partyId}/pricing","fullPath":"/api/v2.1.0/enterprise/pricing/parties/{partyId}/pricing","operationId":"getCustomerPricing","name":"Retrieves the list of pricing details available for the customer and the transaction period. It includes details such as the pricing class, pricing property, base value, adjust value, net value, transaction pricing name, transaction base value, base contract reference, system reference and evaluation reference","summary":"Retrieves the list of pricing details available for the customer","tags":["RETAIL"],"parameters":[{"name":"partyId","in":"path","type":"string","required":true,"description":"Allows capturing of customers or person entities to be part of the relationship. If partyType is selected as Customer, then the system will allow only customer Ids to be captured into this field. If p"},{"name":"effectiveDate","in":"query","type":"string","required":false,"description":"Contains the identifier for the transaction date. Dates are expected in \u00e2\u20ac\u02dcYYYYMMDD\u00e2\u20ac\u2122 format"},{"name":"baseTransactionReference","in":"query","type":"string","required":false,"description":"Indicates the transaction reference which is triggered from external system like \u00e2\u20ac\u02dcHogan\u00e2\u20ac\u2122 or \u00e2\u20ac\u02dcTransactAccounts\u00e2\u20ac\u2122 etc"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"CustomerPricingResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}}]}]},{"name":"Holding","serviceCount":1,"endpointCount":25,"services":[{"key":"holding-loans-arrangements-v1.0.0","title":"Loan creation","version":"v1.0.0","description":"API to create and Manage various types of loans such as Personal, Commercial, Mortgage, Line of Credit, etc","endpointCount":25,"endpoints":[{"method":"POST","path":"/holdings/loans/personalLoans","fullPath":"/api/v1.0.0/holdings/loans/personalLoans","operationId":"createPersonalLoan","name":"Create a Personal Loan Account","summary":"Create a Personal Loan Account","tags":[],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"partyIds":[{}],"partyRoles":[{}],"agentCustomerIds":[{}],"agentArrangementIds":[{}],"agentRoles":[{}],"arrangmentId":"string","productId":"string","activityId":"string","currency":"string","productVariation":"string","pricingSelection":"string","pricingPlan":"string","rewardsArrangementId":"string","tradeDate":"string","arrangementEffectiveDate":"string"}},"responses":{"200":"createPersonalLoanResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"POST","path":"/holdings/loans/linkedRateLoans","fullPath":"/api/v1.0.0/holdings/loans/linkedRateLoans","operationId":"createLinkedRateLoan","name":"Create a Personal Loan account with Linked rate","summary":"Create a Personal Loan account with Linked rate","tags":[],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"partyIds":[{}],"partyRoles":[{}],"agentCustomerIds":[{}],"agentArrangementIds":[{}],"agentRoles":[{}],"arrangmentId":"string","productId":"string","activityId":"string","currency":"string","productVariation":"string","pricingSelection":"string","pricingPlan":"string","rewardsArrangementId":"string","tradeDate":"string","arrangementEffectiveDate":"string"}},"responses":{"200":"createLinkedRateLoanResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"POST","path":"/holdings/loans/commercialLoans","fullPath":"/api/v1.0.0/holdings/loans/commercialLoans","operationId":"createCommercialLoan","name":"Create a Commercial or Business Account","summary":"Create a Commercial or Business Account","tags":[],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"partyIds":[{}],"partyRoles":[{}],"agentCustomerIds":[{}],"agentArrangementIds":[{}],"agentRoles":[{}],"arrangmentId":"string","productId":"string","activityId":"string","currency":"string","productVariation":"string","pricingSelection":"string","pricingPlan":"string","rewardsArrangementId":"string","tradeDate":"string","arrangementEffectiveDate":"string"}},"responses":{"200":"createCommercialLoanResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"POST","path":"/holdings/loans/mortgages","fullPath":"/api/v1.0.0/holdings/loans/mortgages","operationId":"createMortgage","name":"Create a Mortgage Loan","summary":"Create a Mortgage Loan","tags":[],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"partyIds":[{}],"partyRoles":[{}],"agentCustomerIds":[{}],"agentArrangementIds":[{}],"agentRoles":[{}],"arrangmentId":"string","productId":"string","activityId":"string","currency":"string","productVariation":"string","pricingSelection":"string","pricingPlan":"string","rewardsArrangementId":"string","tradeDate":"string","arrangementEffectiveDate":"string"}},"responses":{"200":"createMortgageResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"POST","path":"/holdings/loans/creditLines","fullPath":"/api/v1.0.0/holdings/loans/creditLines","operationId":"createCreditLine","name":"Create a Lines of Credit Account","summary":"Create a Lines of Credit Account","tags":[],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"partyIds":[{}],"partyRoles":[{}],"agentCustomerIds":[{}],"agentArrangementIds":[{}],"agentRoles":[{}],"arrangmentId":"string","productId":"string","activityId":"string","currency":"string","productVariation":"string","pricingSelection":"string","pricingPlan":"string","rewardsArrangementId":"string","tradeDate":"string","arrangementEffectiveDate":"string"}},"responses":{"200":"createCreditLineResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"POST","path":"/holdings/facilities/createInstallmentLoan","fullPath":"/api/v1.0.0/holdings/facilities/createInstallmentLoan","operationId":"createInstallmentLoan","name":"Create a Installment Loan for the given product","summary":"Create a Installment Loan for the given product","tags":[],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"customers":[{}],"arrangmentId":"string","currency":"string","facilityId":"string","effectiveDate":"string","activity":"string","product":"string","account":[{}],"schedule":[{}],"settlement":[{}],"commitment":[{}]}},"responses":{"200":"createInstallmentLoanResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"POST","path":"/holdings/fundsTransfer","fullPath":"/api/v1.0.0/holdings/fundsTransfer","operationId":"createFundsTransfer","name":"Create a account transfer between AA Accounts","summary":"Create a account transfer between AA Accounts","tags":[],"parameters":[{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"transactionType":"string","debitAccountId":"string","debitCurrency":"string","debitAmount":0.0,"debitValueDate":"2024-01-01","creditAccountId":"string","creditCurrencyId":"string","creditAmount":0.0,"creditValueDate":"2024-01-01","commissionCode":"string","commissionType":"string","commissionAmount":0.0,"paymentDetails":"string"}},"responses":{"200":"FundsTransferResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"POST","path":"/holdings/loans/consumerLoans","fullPath":"/api/v1.0.0/holdings/loans/consumerLoans","operationId":"createConsumerLoan","name":"creates a consumer loan for the given product","summary":"Initiates the creation of consumer loan for the given product","tags":["RETAIL"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"partyIds":[{}],"productId":"string","activityId":"string","currency":"string","arrangementEffectiveDate":"string","externalEventStatus":"string","account":[{}],"customer":[{}],"officers":[{}],"schedule":[{}],"settlement":[{}],"commitment":[{}]}},"responses":{"200":"createConsumerLoanResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"PUT","path":"/holdings/loans/consumerLoans/{consumerLoanId}/disbursements","fullPath":"/api/v1.0.0/holdings/loans/consumerLoans/{consumerLoanId}/disbursements","operationId":"createConsumerLoanDisbursement","name":"Disburses the consumer loan commitment amount","summary":"Initiates the disbursement of the given consumer loan contracts commitment amount","tags":["RETAIL"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"consumerLoanId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"currencyId":"string","effectiveDate":"2024-01-01","activityId":"string","transactionAmount":0.0,"contractId":"string","systemId":"string","externalEventStatus":"string"}},"responses":{"200":"createConsumerLoanDisbursementResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"PUT","path":"/holdings/loans/consumerLoans/{consumerLoanId}/commitmentIncreases","fullPath":"/api/v1.0.0/holdings/loans/consumerLoans/{consumerLoanId}/commitmentIncreases","operationId":"updateConsumerLoanTopupAmount","name":"Increases the commitment amount of the consumer loan","summary":"Increases the commitment amount of the given consumer loan contract","tags":["RETAIL"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"consumerLoanId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"effectiveDate":"2024-01-01","activityId":"string","externalEventStatus":"string","schedule":[{}],"settlement":[{}],"commitment":[{}]}},"responses":{"200":"updateConsumerLoanTopupAmountResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"PUT","path":"/holdings/loans/consumerLoans/{consumerLoanId}/commitmentDecreases","fullPath":"/api/v1.0.0/holdings/loans/consumerLoans/{consumerLoanId}/commitmentDecreases","operationId":"updateConsumerLoanDecreaseAmount","name":"Decreases the commitment amount of the consumer loan","summary":"Decreases the commitment amount of the given consumer loan contract","tags":["RETAIL"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"consumerLoanId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"effectiveDate":"2024-01-01","activityId":"string","externalEventStatus":"string","schedule":[{}],"commitment":[{}]}},"responses":{"200":"updateConsumerLoanDecreaseAmountResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"PUT","path":"/holdings/loans/consumerLoans/{consumerLoanId}/repayments","fullPath":"/api/v1.0.0/holdings/loans/consumerLoans/{consumerLoanId}/repayments","operationId":"createConsumerLoanRepayment","name":"Repays the consumer loan amount","summary":"Initiates the repayment of the given consumer loan amount","tags":["RETAIL"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"consumerLoanId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"currencyId":"string","effectiveDate":"2024-01-01","activityId":"string","transactionAmount":0.0,"contractId":"string","systemId":"string","externalEventStatus":"string"}},"responses":{"200":"createConsumerLoanRepaymentResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"PUT","path":"/holdings/loans/consumerLoans/{consumerLoanId}/principalDecreases","fullPath":"/api/v1.0.0/holdings/loans/consumerLoans/{consumerLoanId}/principalDecreases","operationId":"createConsumerLoanPrepayment","name":"Prepays the consumer loan amount ","summary":"Initiates the advance repayment of the given consumer loan amount","tags":["RETAIL"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"consumerLoanId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"currencyId":"string","effectiveDate":"2024-01-01","activityId":"string","transactionAmount":0.0,"contractId":"string","systemId":"string","externalEventStatus":"string"}},"responses":{"200":"createConsumerLoanPrepaymentResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"PUT","path":"/holdings/loans/consumerLoans/{consumerLoanId}/schedules","fullPath":"/api/v1.0.0/holdings/loans/consumerLoans/{consumerLoanId}/schedules","operationId":"updateConsumerLoanSchedule","name":"Change payment schedule of the consumer loan","summary":"Initiates the change of payment schedule for the given consumer loan contract","tags":["RETAIL"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"consumerLoanId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"effectiveDate":"2024-01-01","activityId":"string","externalEventStatus":"string","schedule":[{}],"settlement":[{}]}},"responses":{"200":"updateConsumerLoanScheduleResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"PUT","path":"/holdings/loans/consumerLoans/{consumerLoanId}/paymentHolidays","fullPath":"/api/v1.0.0/holdings/loans/consumerLoans/{consumerLoanId}/paymentHolidays","operationId":"updateConsumerLoanHoliday","name":"Update payment holiday for the consumer loan ","summary":"Initiates the update of payment holiday for the given consumer loan contract ","tags":["RETAIL"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"consumerLoanId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"effectiveDate":"2024-01-01","activityId":"string","externalEventStatus":"string","paymentHoliday":[{}]}},"responses":{"200":"updateConsumerLoanHolidayResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"GET","path":"/holdings/loans/{loanId}/outstandingBills","fullPath":"/api/v1.0.0/holdings/loans/{loanId}/outstandingBills","operationId":"getLoanOutstandingBills","name":"Retrieves the Outstanding amount to be paid for an loan","summary":"Retrieves the Outstanding amount to be paid for the given loan","tags":["RETAIL"],"parameters":[{"name":"loanId","in":"path","type":"string","required":true,"description":"Denotes the arrangement id of the loan"},{"name":"fileVersion","in":"query","type":"string","required":false,"description":"Indicates if the file is of type simulation or live"},{"name":"simulationReference","in":"query","type":"string","required":false,"description":"Indicates the Reference ID for simulation activity"},{"name":"paymentDate","in":"query","type":"string","required":false,"description":"The date on which a payment is due"},{"name":"deferDate","in":"query","type":"string","required":false,"description":"Date that the payment has been deferred to"},{"name":"billedAmount","in":"query","type":"string","required":false,"description":"Indicates the bill amount"},{"name":"outstandingAmount","in":"query","type":"string","required":false,"description":"Contains the aggregate outstanding principal amount thereof after giving effect to any borrowings and prepayments or repayments of Committed Loans"},{"name":"delinquentAmount","in":"query","type":"string","required":false,"description":"Indicates the bill amount during the ageing status(Bill which crossed the due date)"},{"name":"property","in":"query","type":"string","required":false,"description":"Id of the product property"},{"name":"billStatus","in":"query","type":"string","required":false,"description":"Indicates the status of a bill(Issued,Due,Ageing,Settled)"},{"name":"settlementStatus","in":"query","type":"string","required":false,"description":"Defines the status of the settlement for the incoming MT548 swift message.The values allowed are: Waiting : pending to receive settlement status update meaning pending to receive MT548 swift message, "},{"name":"agingStatus","in":"query","type":"string","required":false,"description":"Indicates the ageing status of a bill"},{"name":"settled","in":"query","type":"string","required":false,"description":"Flag to indicate whether a bill is settled or not"},{"name":"paymentType","in":"query","type":"string","required":false,"description":"Indicates if the payment is Customer (C) type or Bank (B) type"},{"name":"billDate","in":"query","type":"string","required":false,"description":"Indicates a date on which a bill has been raised"},{"name":"paymentMethod","in":"query","type":"string","required":false,"description":"Method chosen to make the payment"},{"name":"infoPayType","in":"query","type":"string","required":false,"description":"Indicates a bill which is raised when a loan is paid off"},{"name":"advancePayment","in":"query","type":"string","required":false,"description":"Indicates whether advance payment made is set on an account"},{"name":"paymentIndicator","in":"query","type":"string","required":false,"description":"Indicates whether its a credit/debit type of bill"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from t24 on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"LoanOutstandingBillsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/loans/{loanId}/payoffCalculations","fullPath":"/api/v1.0.0/holdings/loans/{loanId}/payoffCalculations","operationId":"getLoanPayoffDetails","name":"Retrieves the Payoff Details of an loan","summary":"Retrieves the Payoff Details of the given loan","tags":["RETAIL"],"parameters":[{"name":"loanId","in":"path","type":"string","required":true,"description":"Denotes the arrangement id of the loan"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from t24 on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"LoanPayoffDetailsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"PUT","path":"/holdings/loans/consumerLoans/{consumerLoanId}/customers","fullPath":"/api/v1.0.0/holdings/loans/consumerLoans/{consumerLoanId}/customers","operationId":"updateConsumerLoansCustomer","name":"Changes the customers of the consumer loan ","summary":"Initiates the change of customers for the given consumer loan contract","tags":["RETAIL"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"consumerLoanId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"partyIds":[{}],"effectiveDate":"2024-01-01","activityId":"string","externalEventStatus":"string","customer":[{}]}},"responses":{"200":"updateConsumerLoansCustomerResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"PUT","path":"/holdings/loans/consumerLoans/{consumerLoanId}/payoffs","fullPath":"/api/v1.0.0/holdings/loans/consumerLoans/{consumerLoanId}/payoffs","operationId":"createPayoffConsumerLoan","name":"Payoffs the consumer loan amount","summary":"Initiates the payoff of the given consumer loan contract amount","tags":["RETAIL"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"consumerLoanId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"currencyId":"string","effectiveDate":"2024-01-01","activityId":"string","transactionAmount":0.0,"contractId":"string","systemId":"string","externalEventStatus":"string"}},"responses":{"200":"createPayoffConsumerLoanResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"PUT","path":"/holdings/loans/consumerLoans/{consumerLoanId}/renegotiations","fullPath":"/api/v1.0.0/holdings/loans/consumerLoans/{consumerLoanId}/renegotiations","operationId":"updateConsumerLoanConditions","name":"Renegotiates the consumer loan contract details","summary":"Initiates the renegotiation of the given consumer loan contract details","tags":["RETAIL"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"consumerLoanId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"effectiveDate":"2024-01-01","activityId":"string","externalEventStatus":"string","account":[{}],"customer":[{}],"officers":[{}],"schedule":[{}],"settlement":[{}],"commitment":[{}]}},"responses":{"200":"updateConsumerLoanConditionsResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"GET","path":"/holdings/loans/{loanId}/status","fullPath":"/api/v1.0.0/holdings/loans/{loanId}/status","operationId":"getArrangementDetails","name":"Retrieves the status of a Loan","summary":"Retrieves the status of the given Loan","tags":["RETAIL"],"parameters":[{"name":"loanId","in":"path","type":"string","required":true,"description":"Denotes the arrangement id of the loan"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from t24 on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"ArrangementDetailsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/loans/arrangements/activities/{arrangementActivityId}/status","fullPath":"/api/v1.0.0/holdings/loans/arrangements/activities/{arrangementActivityId}/status","operationId":"getExternalEventStatus","name":"Retrieves the status of the given activity ","summary":"Retrieves the status of the given activity ","tags":["RETAIL"],"parameters":[{"name":"arrangementActivityId","in":"path","type":"string","required":true,"description":"The unique identifier of an arrangement activity"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from t24 on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"ExternalEventStatusResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"PUT","path":"/holdings/loans/consumerLoans/{consumerLoanId}/payoffCalculations","fullPath":"/api/v1.0.0/holdings/loans/consumerLoans/{consumerLoanId}/payoffCalculations","operationId":"calculatePayoffConsumerLoans","name":"Calculates consumer loan payment amount to close an loan","summary":"Initiates Calculate Payoff activity to calculate consumer loan payment amount to close the given loan","tags":["RETAIL"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"consumerLoanId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"closureNotes":[{}],"activityId":"string","automaticRun":"string","simulationRunReference":"string","effectiveDate":"2024-01-01","currencyId":"string","transactionAmount":0.0,"closureReason":"string"}},"responses":{"200":"calculatePayoffConsumerLoansResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"GET","path":"/holdings/loans/{loanId}/schedules","fullPath":"/api/v1.0.0/holdings/loans/{loanId}/schedules","operationId":"getPaymentSchedulesProjection","name":"Retrieves payment schedules details","summary":"Retrieves the schedule payment information for paid and upcoming installment details","tags":["RETAIL"],"parameters":[{"name":"loanId","in":"path","type":"string","required":true,"description":"Denotes the arrangement id of the loan"},{"name":"dateFrom","in":"query","type":"string","required":false,"description":"Start date of the loan"},{"name":"dateTo","in":"query","type":"string","required":false,"description":"End date of the loan"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from t24 on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"PaymentSchedulesProjectionResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/holdings/loans/{loanId}/loanDetails","fullPath":"/api/v1.0.0/holdings/loans/{loanId}/loanDetails","operationId":"getLoanOverview","name":"Retrieves loan details","summary":"Retrieves the details of the given loan ","tags":["RETAIL"],"parameters":[{"name":"loanId","in":"path","type":"string","required":true,"description":"Denotes the arrangement id of the loan"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from t24 on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"LoanOverviewResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}}]}]},{"name":"Integration","serviceCount":1,"endpointCount":4,"services":[{"key":"integration-inflowDesign-v1.0.0","title":"Integration InflowDesign","version":"v1.0.0","description":"API to create,update, delete and retrieve Inflow Designs generated using integration","endpointCount":4,"endpoints":[{"method":"POST","path":"/system/integrationInflowDesigns/{integrationInflowDesignId}","fullPath":"/api/v1.0.0/system/integrationInflowDesigns/{integrationInflowDesignId}","operationId":"createInwardDesignLanding","name":"Create a new inflow design to capture business events and data events along with their associated flow. The flows define the data to capture and the parameters that define where to route the captured data.","summary":"Create a new inflow design to capture business events and data events along with their associated flow.","tags":[],"parameters":[{"name":"integrationInflowDesignId","in":"path","type":"string","required":true,"description":"Indicates the Id of the inflow design to capture business flows and data flows"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"InflowAttributes":[{}],"activityDetails":[{}],"fieldDetails":[{}],"ProcessName":"string","inflowDescription":"string","extensionData":{}}},"responses":{"200":"InwardDesignLandingResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/system/integrationInflowDesigns/{integrationInflowDesignId}","fullPath":"/api/v1.0.0/system/integrationInflowDesigns/{integrationInflowDesignId}","operationId":"updateInwardDesignLanding","name":"Update the changes in inflow design to capture business events and data events along with their associated flow. The flows define the data to capture and the parameters that define where to route the captured data.","summary":"Update the changes in inflow design to capture business events and data events along with their associated flow.","tags":[],"parameters":[{"name":"integrationInflowDesignId","in":"path","type":"string","required":true,"description":"Indicates the Id of the inflow design to capture business flows and data flows"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"InflowAttributes":[{}],"activityDetails":[{}],"fieldDetails":[{}],"ProcessName":"string","inflowDescription":"string","extensionData":{}}},"responses":{"200":"InwardDesignLandingResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"DELETE","path":"/system/integrationInflowDesigns/{integrationInflowDesignId}","fullPath":"/api/v1.0.0/system/integrationInflowDesigns/{integrationInflowDesignId}","operationId":"deleteInwardDesignLanding","name":"Delete an existing inflow design that was setup to capture business events and data events along with their associated flow. ","summary":"Delete an inflow design that was setup to capture business events and data events","tags":[],"parameters":[{"name":"integrationInflowDesignId","in":"path","type":"string","required":true,"description":"Indicates the Id of the inflow design to capture business flows and data flows"},{"name":"payload","in":"body","type":"object","required":false,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}}},"responses":{"200":"InwardDesignLandingResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/system/integrationInflowDesigns","fullPath":"/api/v1.0.0/system/integrationInflowDesigns","operationId":"getInwardDesignLandingIds","name":"Retrieves the list of  inflow design record Id's created to capture business events and data events.","summary":"Retrieves the inflow design record Id's created to capture business events and data events.","tags":[],"parameters":[{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"InwardDesignLandingIdsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}}]}]},{"name":"Loans","serviceCount":3,"endpointCount":14,"services":[{"key":"loans-calculatePayoff-v1.0.0","title":"Initiate Loan payoff activity","version":"v1.0.0","description":"Initiate Calculate Payoff activity to calculate loan payment to close an account","endpointCount":4,"endpoints":[{"method":"POST","path":"/holdings/calculatePayoff/{arrangementId}/homeLoans","fullPath":"/api/v1.0.0/holdings/calculatePayoff/{arrangementId}/homeLoans","operationId":"calculatePayoffHomeLoans","name":"Initiate Calculate Payoff activity to calculate loan payment to close an account","summary":"Initiate Calculate Payoff activity to calculate loan payment to close an account","tags":[],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":""},{"name":"companyId","in":"header","type":"string","required":false,"description":"The identifier of the company, following the format CCGGGLLLL, where: CC is the country code, GGG is Company Group Code and LLLL is the Local Code. Country Code must be a valid countryCode, Company Gr"},{"name":"arrangementId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"customerIds":[{}],"properties":[{}],"overrides":[{}],"productId":"string","masterArrangementId":"string","roleName":"string","currencyId":"string","effectiveDate":"2024-01-01","activityId":"string","transactionAmount":0.0,"payoff":{"expiryDays":{},"settleDues":{},"Percentage":{},"fixedAmount":{},"Action":{}}}},"responses":{"200":"calculatePayoffHomeLoansResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"POST","path":"/holdings/calculatePayoff/{arrangementId}/creditLines","fullPath":"/api/v1.0.0/holdings/calculatePayoff/{arrangementId}/creditLines","operationId":"calculatePayoffCreditLines","name":"Initiate Calculate Payoff activity to calculate loan payment to close an account","summary":"Initiate Calculate Payoff activity to calculate loan payment to close an account","tags":[],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":""},{"name":"companyId","in":"header","type":"string","required":false,"description":"The identifier of the company, following the format CCGGGLLLL, where: CC is the country code, GGG is Company Group Code and LLLL is the Local Code. Country Code must be a valid countryCode, Company Gr"},{"name":"arrangementId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"customerIds":[{}],"properties":[{}],"overrides":[{}],"productId":"string","masterArrangementId":"string","roleName":"string","currencyId":"string","effectiveDate":"2024-01-01","activityId":"string","transactionAmount":0.0,"payoff":{"expiryDays":{},"settleDues":{},"Percentage":{},"fixedAmount":{},"Action":{}}}},"responses":{"200":"calculatePayoffCreditLinesResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"POST","path":"/holdings/calculatePayoff/{arrangementId}/personalLoans","fullPath":"/api/v1.0.0/holdings/calculatePayoff/{arrangementId}/personalLoans","operationId":"calculatePayoffPersonalLoans","name":"Initiate Calculate Payoff activity to calculate loan payment to close an account","summary":"Initiate Calculate Payoff activity to calculate loan payment to close an account","tags":[],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":""},{"name":"companyId","in":"header","type":"string","required":false,"description":"The identifier of the company, following the format CCGGGLLLL, where: CC is the country code, GGG is Company Group Code and LLLL is the Local Code. Country Code must be a valid countryCode, Company Gr"},{"name":"arrangementId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"customerIds":[{}],"properties":[{}],"overrides":[{}],"productId":"string","masterArrangementId":"string","roleName":"string","currencyId":"string","effectiveDate":"2024-01-01","activityId":"string","transactionAmount":0.0,"payoff":{"expiryDays":{},"settleDues":{},"Percentage":{},"fixedAmount":{},"Action":{}}}},"responses":{"200":"calculatePayoffPersonalLoansResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"POST","path":"/holdings/calculatePayoff/{arrangementId}/businessLoans","fullPath":"/api/v1.0.0/holdings/calculatePayoff/{arrangementId}/businessLoans","operationId":"calculatePayoffBusinessLoans","name":"Initiate Calculate Payoff activity to calculate loan payment to close an account","summary":"Initiate Calculate Payoff activity to calculate loan payment to close an account","tags":[],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":""},{"name":"companyId","in":"header","type":"string","required":false,"description":"The identifier of the company, following the format CCGGGLLLL, where: CC is the country code, GGG is Company Group Code and LLLL is the Local Code. Country Code must be a valid countryCode, Company Gr"},{"name":"arrangementId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"customerIds":[{}],"properties":[{}],"overrides":[{}],"productId":"string","masterArrangementId":"string","roleName":"string","currencyId":"string","effectiveDate":"2024-01-01","activityId":"string","transactionAmount":0.0,"payoff":{"expiryDays":{},"settleDues":{},"Percentage":{},"fixedAmount":{},"Action":{}}}},"responses":{"200":"calculatePayoffBusinessLoansResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}}]},{"key":"loans-updatePaymentHoliday-simulation-v1.0.0","title":"Simulate payment holiday activity for a loan account","version":"v1.0.0","description":"API to simulate update payment holiday activity for a loan account","endpointCount":5,"endpoints":[{"method":"POST","path":"/holdings/arrangements/{arrangementId}/simulate/paymentHoliday/mortgages","fullPath":"/api/v1.0.0/holdings/arrangements/{arrangementId}/simulate/paymentHoliday/mortgages","operationId":"simulatePaymentHolidayMortgages","name":"Simulate update payment holiday activity for a mortgage loan","summary":"Simulate update payment holiday activity for a mortgage loan","tags":[],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"The identifier of the underlying Entity/Company/Branch."},{"name":"arrangementId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"customerIds":[{}],"properties":[{}],"overrides":[{}],"productId":"string","masterArrangementId":"string","roleName":"string","currencyId":"string","effectiveDate":"2024-01-01","activityId":"string","transactionAmount":0.0}},"responses":{"200":"simulatePaymentHolidayMortgagesResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"POST","path":"/holdings/arrangements/{arrangementId}/simulate/paymentHoliday/homeLoans","fullPath":"/api/v1.0.0/holdings/arrangements/{arrangementId}/simulate/paymentHoliday/homeLoans","operationId":"simulatePaymentHolidayHomeLoans","name":"Simulate update payment holiday activity for a home loan","summary":"Simulate update payment holiday activity for a home loan","tags":[],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"The identifier of the underlying Entity/Company/Branch."},{"name":"arrangementId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"customerIds":[{}],"properties":[{}],"overrides":[{}],"productId":"string","masterArrangementId":"string","roleName":"string","currencyId":"string","effectiveDate":"2024-01-01","activityId":"string","transactionAmount":0.0}},"responses":{"200":"simulatePaymentHolidayHomeLoansResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"POST","path":"/holdings/arrangements/{arrangementId}/simulate/paymentHoliday/personalLoans","fullPath":"/api/v1.0.0/holdings/arrangements/{arrangementId}/simulate/paymentHoliday/personalLoans","operationId":"simulatePaymentHolidayPersonalLoans","name":"Simulate update payment holiday activity for a personal loan","summary":"Simulate update payment holiday activity for a personal loan","tags":[],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"The identifier of the underlying Entity/Company/Branch."},{"name":"arrangementId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"customerIds":[{}],"properties":[{}],"overrides":[{}],"productId":"string","masterArrangementId":"string","roleName":"string","currencyId":"string","effectiveDate":"2024-01-01","activityId":"string","transactionAmount":0.0}},"responses":{"200":"simulatePaymentHolidayPersonalLoansResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"POST","path":"/holdings/arrangements/{arrangementId}/simulate/paymentHoliday/businessLoans","fullPath":"/api/v1.0.0/holdings/arrangements/{arrangementId}/simulate/paymentHoliday/businessLoans","operationId":"simulatePaymentHolidayBusinessLoans","name":"Simulate update payment holiday activity for a small business loan","summary":"Simulate update payment holiday activity for a small business loan","tags":[],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"The identifier of the underlying Entity/Company/Branch."},{"name":"arrangementId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"customerIds":[{}],"properties":[{}],"overrides":[{}],"productId":"string","masterArrangementId":"string","roleName":"string","currencyId":"string","effectiveDate":"2024-01-01","activityId":"string","transactionAmount":0.0}},"responses":{"200":"simulatePaymentHolidayBusinessLoansResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"POST","path":"/holdings/arrangements/{arrangementId}/simulate/paymentHoliday/creditLines","fullPath":"/api/v1.0.0/holdings/arrangements/{arrangementId}/simulate/paymentHoliday/creditLines","operationId":"simulatePaymentHolidayCreditLines","name":"Simulate update payment holiday activity for a credit line","summary":"Simulate update payment holiday activity for a credit line","tags":[],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"The identifier of the underlying Entity/Company/Branch."},{"name":"arrangementId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"customerIds":[{}],"properties":[{}],"overrides":[{}],"productId":"string","masterArrangementId":"string","roleName":"string","currencyId":"string","effectiveDate":"2024-01-01","activityId":"string","transactionAmount":0.0}},"responses":{"200":"simulatePaymentHolidayCreditLinesResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}}]},{"key":"loans-updatePaymentHoliday-v1.0.0","title":"Initiate payment holiday activity for a loan account","version":"v1.0.0","description":"API to initiate update payment holiday activity for a loan account","endpointCount":5,"endpoints":[{"method":"POST","path":"/holdings/arrangements/{arrangementId}/paymentHoliday/mortgages","fullPath":"/api/v1.0.0/holdings/arrangements/{arrangementId}/paymentHoliday/mortgages","operationId":"updatePaymentHolidayMortgages","name":"Initiate update payment holiday activity for a mortgage loan","summary":"Initiate update payment holiday activity for a mortgage loan","tags":[],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"The identifier of the underlying Entity/Company/Branch."},{"name":"arrangementId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"customerIds":[{}],"properties":[{}],"overrides":[{}],"productId":"string","masterArrangementId":"string","roleName":"string","currencyId":"string","effectiveDate":"2024-01-01","activityId":"string","transactionAmount":0.0,"paymentHoliday":{"activityId":{},"activityAction":{},"paymentDate":{},"paymentType":{},"billType":{},"newPaymentAmount":{},"numberOfInstallments":{},"recalculationMethod":{}}}},"responses":{"200":"updatePaymentHolidayMortgagesResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"POST","path":"/holdings/arrangements/{arrangementId}/paymentHoliday/homeLoans","fullPath":"/api/v1.0.0/holdings/arrangements/{arrangementId}/paymentHoliday/homeLoans","operationId":"updatePaymentHolidayHomeLoans","name":"Initiate update payment holiday activity for a home loan","summary":"Initiate update payment holiday activity for a home loan","tags":[],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"The identifier of the underlying Entity/Company/Branch."},{"name":"arrangementId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"customerIds":[{}],"properties":[{}],"overrides":[{}],"productId":"string","masterArrangementId":"string","roleName":"string","currencyId":"string","effectiveDate":"2024-01-01","activityId":"string","transactionAmount":0.0,"paymentHoliday":{"activityId":{},"activityAction":{},"paymentDate":{},"paymentType":{},"billType":{},"newPaymentAmount":{},"numberOfInstallments":{},"recalculationMethod":{}}}},"responses":{"200":"updatePaymentHolidayHomeLoansResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"POST","path":"/holdings/arrangements/{arrangementId}/paymentHoliday/personalLoans","fullPath":"/api/v1.0.0/holdings/arrangements/{arrangementId}/paymentHoliday/personalLoans","operationId":"updatePaymentHolidayPersonalLoans","name":"Initiate update payment holiday activity for a personal loan","summary":"Initiate update payment holiday activity for a personal loan","tags":[],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"The identifier of the underlying Entity/Company/Branch."},{"name":"arrangementId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"customerIds":[{}],"properties":[{}],"overrides":[{}],"productId":"string","masterArrangementId":"string","roleName":"string","currencyId":"string","effectiveDate":"2024-01-01","activityId":"string","transactionAmount":0.0,"paymentHoliday":{"activityId":{},"activityAction":{},"paymentDate":{},"paymentType":{},"billType":{},"newPaymentAmount":{},"numberOfInstallments":{},"recalculationMethod":{}}}},"responses":{"200":"updatePaymentHolidayPersonalLoansResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"POST","path":"/holdings/arrangements/{arrangementId}/paymentHoliday/businessLoans","fullPath":"/api/v1.0.0/holdings/arrangements/{arrangementId}/paymentHoliday/businessLoans","operationId":"updatePaymentHolidayBusinessLoans","name":"Initiate update payment holiday activity for a small business loan","summary":"Initiate update payment holiday activity for a small business loan","tags":[],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"The identifier of the underlying Entity/Company/Branch."},{"name":"arrangementId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"customerIds":[{}],"properties":[{}],"overrides":[{}],"productId":"string","masterArrangementId":"string","roleName":"string","currencyId":"string","effectiveDate":"2024-01-01","activityId":"string","transactionAmount":0.0,"paymentHoliday":{"activityId":{},"activityAction":{},"paymentDate":{},"paymentType":{},"billType":{},"newPaymentAmount":{},"numberOfInstallments":{},"recalculationMethod":{}}}},"responses":{"200":"updatePaymentHolidayBusinessLoansResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"POST","path":"/holdings/arrangements/{arrangementId}/paymentHoliday/creditLines","fullPath":"/api/v1.0.0/holdings/arrangements/{arrangementId}/paymentHoliday/creditLines","operationId":"updatePaymentHolidayCreditLines","name":"Initiate update payment holiday activity for a credit line","summary":"Initiate update payment holiday activity for a credit line","tags":[],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"The identifier of the underlying Entity/Company/Branch."},{"name":"arrangementId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"customerIds":[{}],"properties":[{}],"overrides":[{}],"productId":"string","masterArrangementId":"string","roleName":"string","currencyId":"string","effectiveDate":"2024-01-01","activityId":"string","transactionAmount":0.0,"paymentHoliday":{"activityId":{},"activityAction":{},"paymentDate":{},"paymentType":{},"billType":{},"newPaymentAmount":{},"numberOfInstallments":{},"recalculationMethod":{}}}},"responses":{"200":"updatePaymentHolidayCreditLinesResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}}]}]},{"name":"Meta","serviceCount":9,"endpointCount":24,"services":[{"key":"meta-apis-service-v1.0.0","title":"Meta - APIs about APIs","version":"v1.0.0","description":"Retrieves information about the API ecosystem, both reference information and runtime metrics","endpointCount":4,"endpoints":[{"method":"GET","path":"/meta/apidocs","fullPath":"/api/v1.0.0/meta/apidocs","operationId":"getApiDocs","name":"","summary":"","tags":[],"parameters":[],"requestBodyExample":null,"responses":{"200":"getApiDocsResponse","default":"getApiDocsErrorResponse"}},{"method":"GET","path":"/meta/apis","fullPath":"/api/v1.0.0/meta/apis","operationId":"getApis","name":"","summary":"","tags":[],"parameters":[],"requestBodyExample":null,"responses":{"200":"getApisResponse","default":"getApisResponse"}},{"method":"GET","path":"/meta/internal/apis","fullPath":"/api/v1.0.0/meta/internal/apis","operationId":"getInternalApis","name":"","summary":"","tags":[],"parameters":[],"requestBodyExample":null,"responses":{"200":"getInternalApisResponse","default":"getInternalApisResponse"}},{"method":"GET","path":"/meta/apis/operationIds","fullPath":"/api/v1.0.0/meta/apis/operationIds","operationId":"getApis","name":"","summary":"","tags":[],"parameters":[],"requestBodyExample":null,"responses":{"200":"getApisResponse","default":"getApisResponse"}}]},{"key":"meta-dwExportProperties-v1.0.0","title":"Data warehouse export properties","version":"v1.0.0","description":"Data warehouse export properties","endpointCount":2,"endpoints":[{"method":"POST","path":"/meta/dataWarehouseExports/{dataWarehouseExportId}/properties","fullPath":"/api/v1.0.0/meta/dataWarehouseExports/{dataWarehouseExportId}/properties","operationId":"updateDWExportProperties","name":"API to update data ware house export properties","summary":"Create data warehouse export properties","tags":[],"parameters":[{"name":"dataWarehouseExportId","in":"path","type":"string","required":true,"description":"Identifier of data warehouse export."},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"utilsProperties":"string"}},"responses":{"200":"DWExportPropertiesResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/meta/dataWarehouseExports/properties","fullPath":"/api/v1.0.0/meta/dataWarehouseExports/properties","operationId":"getDWExportProperties","name":"API to get data warehouse export properties","summary":"Get data warehouse export properties","tags":[],"parameters":[{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from t24 on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"DWExportPropertiesResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}}]},{"key":"meta-menus-service-v1.0.0","title":"Meta APIs about Menus","version":"v1.0.0","description":"Allows the creation, viewing and management of menu definitions","endpointCount":6,"endpoints":[{"method":"GET","path":"/meta/menus/mainmenus","fullPath":"/api/v1.0.0/meta/menus/mainmenus","operationId":"getMainMenus","name":"","summary":"","tags":[],"parameters":[{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Random and unique string for each page. Used for security purpose"}],"requestBodyExample":null,"responses":{"200":"getMainMenusResponse","default":"getMainMenusErrorResponse"}},{"method":"GET","path":"/meta/menus/mainmenus/{menuId}","fullPath":"/api/v1.0.0/meta/menus/mainmenus/{menuId}","operationId":"getMainMenu","name":"","summary":"","tags":[],"parameters":[{"name":"menuId","in":"path","type":"string","required":true,"description":""},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Random and unique string for each page. Used for security purpose"}],"requestBodyExample":null,"responses":{"200":"getMainMenuResponse","default":"getMainMenuErrorResponse"}},{"method":"POST","path":"/meta/menus/mainmenus/{menuId}","fullPath":"/api/v1.0.0/meta/menus/mainmenus/{menuId}","operationId":"createMainMenu","name":"","summary":"","tags":[],"parameters":[{"name":"menuId","in":"path","type":"string","required":true,"description":""},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."}],"requestBodyExample":{"header":{"override_acceptId":"string"},"body":{"title":[{}],"helpmenuid":[{}],"displayMenuId":"string"}},"responses":{"200":"createMainMenuResponse","default":"createMainMenuErrorResponse"}},{"method":"GET","path":"/meta/menus","fullPath":"/api/v1.0.0/meta/menus","operationId":"getMenus","name":"","summary":"","tags":[],"parameters":[{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Random and unique string for each page. Used for security purpose"}],"requestBodyExample":null,"responses":{"200":"getMenusResponse","default":"getMenusErrorResponse"}},{"method":"GET","path":"/meta/menus/{menuId}","fullPath":"/api/v1.0.0/meta/menus/{menuId}","operationId":"getMenu","name":"","summary":"","tags":[],"parameters":[{"name":"menuId","in":"path","type":"string","required":true,"description":""},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Random and unique string for each page. Used for security purpose"}],"requestBodyExample":null,"responses":{"200":"getMenuResponse","default":"getMenuErrorResponse"}},{"method":"POST","path":"/meta/menus/{menuId}","fullPath":"/api/v1.0.0/meta/menus/{menuId}","operationId":"createMenu","name":"","summary":"","tags":[],"parameters":[{"name":"menuId","in":"path","type":"string","required":true,"description":""},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."}],"requestBodyExample":{"header":{"override_acceptId":"string"},"body":{"application":[{}],"displayApplication":"string"}},"responses":{"200":"createMenuResponse","default":"createMenuErrorResponse"}}]},{"key":"meta-payments-service-v2.0.0","title":"Payments Metadata","version":"v2.0.0","description":"Retrieves the metadata for payment artifacts","endpointCount":1,"endpoints":[{"method":"GET","path":"/meta/payments/queryFilters","fullPath":"/api/v2.0.0/meta/payments/queryFilters","operationId":"getQueryFilters","name":"Retrieves the payment transaction api query filters","summary":"Retrieves the query filters which can be applied on payment transaction api","tags":[],"parameters":[{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from t24 on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"The identifier of the underlying Entity/Company/Branch."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"QueryFiltersResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}}]},{"key":"meta-statistics-v1.0.0","title":"Statistics Provider APIs","version":"v1.0.0","description":"","endpointCount":1,"endpoints":[{"method":"GET","path":"/meta/statistics","fullPath":"/v1.0.0/meta/statistics","operationId":"getUsageStatistics","name":"","summary":"","tags":[],"parameters":[{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Random and unique string for each page. Used for security purpose"},{"name":"apiId","in":"query","type":"string","required":false,"description":"Domain Id of the resource record"},{"name":"operationId","in":"query","type":"string","required":false,"description":"IRIS Service Id"},{"name":"fromDate","in":"query","type":"string","required":false,"description":"Start Date"},{"name":"toDate","in":"query","type":"string","required":false,"description":"End Date"}],"requestBodyExample":null,"responses":{"200":"getUsageStatisticsResponse","default":"getUsageStatisticsErrorResponse"}}]},{"key":"meta-tables-service-v1.0.0","title":"Meta APIs about Tables","version":"v1.0.0","description":"Allows the viewing of table definitions","endpointCount":3,"endpoints":[{"method":"GET","path":"/meta/tables/{tableId}/fields","fullPath":"/api/v1.0.0/meta/tables/{tableId}/fields","operationId":"getFieldNames","name":"","summary":"","tags":[],"parameters":[{"name":"tableId","in":"path","type":"string","required":true,"description":"The unique application table identifier"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Random and unique string for each page. Used for security purpose"}],"requestBodyExample":null,"responses":{"200":"getFieldNamesResponse","default":"getFieldNamesErrorResponse"}},{"method":"GET","path":"/meta/tables/","fullPath":"/api/v1.0.0/meta/tables/","operationId":"getTables","name":"","summary":"","tags":[],"parameters":[{"name":"moduleId","in":"query","type":"string","required":false,"description":"The identifier of the module"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Random and unique string for each page. Used for security purpose"}],"requestBodyExample":null,"responses":{"200":"getTablesResponse","default":"getTablesErrorResponse"}},{"method":"GET","path":"/meta/tables/{tableId}/screens","fullPath":"/api/v1.0.0/meta/tables/{tableId}/screens","operationId":"getTableScreens","name":"","summary":"","tags":[],"parameters":[{"name":"tableId","in":"path","type":"string","required":true,"description":""},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Random and unique string for each page. Used for security purpose"}],"requestBodyExample":null,"responses":{"200":"getTableScreensResponse","default":"getTableScreensErrorResponse"}}]},{"key":"meta-tables-service-v1.1.0","title":"Meta APIs about Tables","version":"v1.1.0","description":"Allows the viewing of table definitions","endpointCount":4,"endpoints":[{"method":"GET","path":"/meta/tables/{tableId}/fields","fullPath":"/api/v1.1.0/meta/tables/{tableId}/fields","operationId":"getFieldNames","name":"Retrieves the fields of a table","summary":"Retrieves the fields of a table","tags":[],"parameters":[{"name":"tableId","in":"path","type":"string","required":true,"description":"The unique application table identifier"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"FieldNamesResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/meta/tables/","fullPath":"/api/v1.1.0/meta/tables/","operationId":"getTables","name":"Retrieves the tables of the modules","summary":"Retrieves the tables of the modules","tags":[],"parameters":[{"name":"moduleId","in":"query","type":"string","required":false,"description":"The identifier of the module."},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"TablesResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/meta/tables/{tableId}/screens","fullPath":"/api/v1.1.0/meta/tables/{tableId}/screens","operationId":"getTableScreens","name":"Retrieves the versions of a table","summary":"Retrieves the versions of a table","tags":[],"parameters":[{"name":"tableId","in":"path","type":"string","required":true,"description":""},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"TableScreensResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/meta/tables/{tableId}/recordIdentifiers","fullPath":"/api/v1.1.0/meta/tables/{tableId}/recordIdentifiers","operationId":"getOptionList","name":"Retrieves the list of record identifiers available for a table after applying a filter criteria","summary":"Retrieves the list of record identifiers available for a table ","tags":[],"parameters":[{"name":"tableId","in":"path","type":"string","required":true,"description":"The unique application table identifier"},{"name":"queryFilter","in":"query","type":"string","required":false,"description":""},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"OptionListResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}}]},{"key":"meta-virtualtable-v1.0.0","title":"Meta VirtualTable","version":"v1.0.0","description":"MetaVirtualTableService","endpointCount":1,"endpoints":[{"method":"GET","path":"/meta/lookup/{virtualTableName}","fullPath":"/api/v1.0.0/meta/lookup/{virtualTableName}","operationId":"getVirtualTableData","name":"","summary":"","tags":[],"parameters":[{"name":"virtualTableName","in":"path","type":"string","required":true,"description":"The first part of the lookupName, This field is to enable the selection on EB.LOOKUP based on the virtual table name."},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Random and unique string for each page. Used for security purpose"}],"requestBodyExample":null,"responses":{"200":"getVirtualTableDataResponse","default":"getVirtualTableDataErrorResponse"}}]},{"key":"meta-virtualtable-v1.1.0","title":"Meta VirtualTable","version":"v1.1.0","description":"MetaVirtualTableService","endpointCount":2,"endpoints":[{"method":"GET","path":"/meta/lookup/{virtualTableName}","fullPath":"/api/v1.1.0/meta/lookup/{virtualTableName}","operationId":"getVirtualTableData","name":"Retrieves a virtual table data","summary":"Retrieves a virtual table data","tags":["RETAIL"],"parameters":[{"name":"virtualTableName","in":"path","type":"string","required":true,"description":"Contains the name of the virtual table used to retrieve lookup details."},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"VirtualTableDataResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"POST","path":"/meta/lookup/{virtualTableName}","fullPath":"/api/v1.1.0/meta/lookup/{virtualTableName}","operationId":"createVirtualTableData","name":"Creates a virtual table data","summary":"Creates a virtual table data","tags":["RETAIL"],"parameters":[{"name":"virtualTableName","in":"path","type":"string","required":true,"description":"Contains the name of the virtual table used to retrieve lookup details."},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"description":"string"}},"responses":{"200":"VirtualTableDataResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}}]}]},{"name":"Order","serviceCount":133,"endpointCount":1462,"services":[{"key":"order-Confirmation-v1.0.0","title":"Order Confirmation","version":"v1.0.0","description":"Order Confirmation","endpointCount":1,"endpoints":[{"method":"POST","path":"/order/messages/confirmationTrade","fullPath":"/api/v1.0.0/order/messages/confirmationTrade","operationId":"orderConfirmation","name":"use URI \"/holdings/messages/securityTrades/confirmations\"","summary":"Order Confirmation","tags":[],"parameters":[{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"msgId":"string","creDtTm":"string","invstmtAcctDtlsAcctId":"string","ordrRef":"string","dealRef":"string","finInstrmDtlsISIN":"string","finInstrmDtlsSEPOL":"string","finInstrmDtlsCUSIP":"string","finInstrmDtlsRIC":"string","finInstrmDtlsTckrSymb":"string","finInstrmDtlsBlmbrg":"string","finInstrmDtlsCTA":"string","finInstrmDtlsQUICK":"string","finInstrmDtlsWrtppr":"string","finInstrmDtlsDtch":"string"}},"responses":{"200":"ConfirmationResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}}]},{"key":"order-IPOSecurityOrders-service-v1.0.0","title":"Initial Public Offering (IPO) Security Orders","version":"v1.0.0","description":"Allows the creation, viewing and management of Initial Public Offering (IPO) orders","endpointCount":3,"endpoints":[{"method":"POST","path":"/order/securityOrders/initialPublicOfferings","fullPath":"/api/v1.0.0/order/securityOrders/initialPublicOfferings","operationId":"createSecuritiesIPOOrder","name":"Creates the IPO Securities order","summary":"Creates the IPO Securities order","tags":[],"parameters":[{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":""},{"name":"companyId","in":"header","type":"string","required":false,"description":""}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"brokers":[{}],"customers":[{}],"transactionChannel":"string","instrumentId":"string","tradeCurrency":"string","stockExchange":"string","transactionType":"string","orderDate":"2024-01-01","valueDate":"2024-01-01","orderedAt":"string","tradeType":"string","threadKey":"string","depositoryId":"string","frontOfficeInstructions":"string","approximateSettlementAmount":0.0}},"responses":{"200":"SecuritiesIPOOrderResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/order/securityOrders/{securityOrderId}/initialPublicOfferings","fullPath":"/api/v1.0.0/order/securityOrders/{securityOrderId}/initialPublicOfferings","operationId":"getSecuritiesIPOOrder","name":"Retrieves the IPO Securities order","summary":"Retrieves the IPO Securities order","tags":[],"parameters":[{"name":"securityOrderId","in":"path","type":"string","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":""},{"name":"companyId","in":"header","type":"string","required":false,"description":""}],"requestBodyExample":null,"responses":{"200":"SecuritiesIPOOrderResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/order/securityOrders/{securityOrderId}/initialPublicOfferings","fullPath":"/api/v1.0.0/order/securityOrders/{securityOrderId}/initialPublicOfferings","operationId":"updateSecuritiesIPOOrder","name":"Updates the IPO Securities order","summary":"Updates the IPO Securities order","tags":[],"parameters":[{"name":"securityOrderId","in":"path","type":"string","required":true,"description":""},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":""},{"name":"companyId","in":"header","type":"string","required":false,"description":""}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"brokers":[{}],"customers":[{}],"transactionChannel":"string","instrumentId":"string","tradeCurrency":"string","stockExchange":"string","transactionType":"string","orderDate":"2024-01-01","valueDate":"2024-01-01","orderedAt":"string","tradeType":"string","threadKey":"string","depositoryId":"string","frontOfficeInstructions":"string","approximateSettlementAmount":0.0}},"responses":{"200":"SecuritiesIPOOrderResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}}]},{"key":"order-StatusReport-v1.0.0","title":"Order Status Report","version":"v1.0.0","description":"Order Status Report","endpointCount":1,"endpoints":[{"method":"POST","path":"/order/messages/statusReportTrade","fullPath":"/api/v1.0.0/order/messages/statusReportTrade","operationId":"orderStatusReport","name":"use URI \"/holdings/messages/securityTrades/status\"","summary":"Order Status Report","tags":[],"parameters":[{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"orderDetsTypeGroup":[{}],"orderDetsRefGroup":[{}],"ordrStsGroup":[{}],"ordrStsCancCdGroup":[{}],"ordrStsCancIdGroup":[{}],"ordrStsCancSchmeNmGroup":[{}],"ordrStsCancIssrGroup":[{}],"ordrStsCondlyAccptdNoSpcfdRsnGroup":[{}],"ordrStsCondlyAccptdCdGroup":[{}],"ordrStsCondlyAccptdIdGroup":[{}],"ordrStsCondlyAccptdSchmeNmGroup":[{}],"ordrStsCondlyAccptdIssrGroup":[{}],"ordrStsRjctdCdGroup":[{}],"ordrStsRjctdIdGroup":[{}],"ordrStsRjctdSchmeNmGroup":[{}]}},"responses":{"200":"StatusReportResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}}]},{"key":"order-accountTransfers-v1.0.0","title":"Funds Transfers","version":"v1.0.0","description":"API to Create, update and manage transactions related to Accounts such as inward/outward Funds Transfers and Bulk Transfers.","endpointCount":13,"endpoints":[{"method":"POST","path":"/order/fundsMovement","fullPath":"/api/v1.0.0/order/fundsMovement","operationId":"createAccountTransfer","name":"Create Funds Transfer between two customer accounts with details such as Transaction Type, Amount, Date & Commission","summary":"Create a Funds Transfer","tags":[],"parameters":[{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"transactionType":"string","debitAccountId":"string","debitCurrency":"string","debitAmount":0.0,"debitValueDate":"2024-01-01","creditAccountId":"string","creditCurrencyId":"string","creditAmount":0.0,"creditValueDate":"2024-01-01","commissionCode":"string","commissionType":"string","commissionAmount":0.0}},"responses":{"200":"AccountTransferResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/order/fundsMovement/{fundsTransferId}","fullPath":"/api/v1.0.0/order/fundsMovement/{fundsTransferId}","operationId":"updateAccountTransfer","name":"Update Funds Transfer with details such as Transaction Type, Amount, Date & Commission","summary":"Update Funds Transfer details","tags":[],"parameters":[{"name":"fundsTransferId","in":"path","type":"string","required":true,"description":"Identifier of the Funds Transfer"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"transactionType":"string","debitAccountId":"string","debitCurrency":"string","debitAmount":0.0,"debitValueDate":"2024-01-01","creditAccountId":"string","creditCurrencyId":"string","creditAmount":0.0,"creditValueDate":"2024-01-01","commissionCode":"string","commissionType":"string","commissionAmount":0.0}},"responses":{"200":"AccountTransferResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/order/fundsMovement/{debitAccountId}/{creditAccountId}","fullPath":"/api/v1.0.0/order/fundsMovement/{debitAccountId}/{creditAccountId}","operationId":"getAccountTransfers","name":"Retrieves list of Funds Transfer details such as Type of Transaction, Date & Amount for the specified Customer Accounts","summary":"Retrieves list of Funds Transfers","tags":[],"parameters":[{"name":"debitAccountId","in":"path","type":"string","required":true,"description":"Indicates the debit account number of the payment or transaction."},{"name":"creditAccountId","in":"path","type":"string","required":true,"description":"Credit account identifier of the payment or transaction"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from t24 on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"AccountTransfersResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/order/transfers/bulkTransfers/{bulkTransferId}","fullPath":"/api/v1.0.0/order/transfers/bulkTransfers/{bulkTransferId}","operationId":"getBulkTransfers","name":"Retrieves the list of Bulk Transfer details such as Transaction Reference, Type, Currency, Amount & Accounts involved in the Transaction occurred in a day","summary":"Retrieves Bulk Transfer details","tags":[],"parameters":[{"name":"bulkTransferId","in":"path","type":"string","required":true,"description":"Identifier of the Bulk Transfer"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from t24 on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"BulkTransfersResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"POST","path":"/order/transfers/inwards","fullPath":"/api/v1.0.0/order/transfers/inwards","operationId":"createInwardTransfer","name":"Create an Inward Transfer with details such as Transaction Type, Amount, Date, Commission and Ordering Bank & Customer","summary":"Create Inward Funds Transfer","tags":[],"parameters":[{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"transactionType":"string","debitAccountId":"string","debitCurrency":"string","debitAmount":0.0,"debitValueDate":"2024-01-01","creditAccountId":"string","creditCurrencyId":"string","creditAmount":0.0,"creditValueDate":"2024-01-01","orderingBank":"string","orderingCustomerId":"string"}},"responses":{"200":"InwardTransferResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/order/transfers/inwards/{fundsTransferId}","fullPath":"/api/v1.0.0/order/transfers/inwards/{fundsTransferId}","operationId":"updateInwardTransfer","name":"Update an Inward Transfer with details such as Transaction Type, Amount, Date, Commission and Ordering Bank & Customer","summary":"Update Funds Transfer details for a Inward Transfer","tags":[],"parameters":[{"name":"fundsTransferId","in":"path","type":"string","required":true,"description":"Identifier of the Funds Transfer"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"transactionType":"string","debitAccountId":"string","debitCurrency":"string","debitAmount":0.0,"debitValueDate":"2024-01-01","creditAccountId":"string","creditCurrencyId":"string","creditAmount":0.0,"creditValueDate":"2024-01-01","orderingBank":"string","orderingCustomerId":"string"}},"responses":{"200":"InwardTransferResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/order/transfers/inwards/{debitAccountId}/{creditAccountId}","fullPath":"/api/v1.0.0/order/transfers/inwards/{debitAccountId}/{creditAccountId}","operationId":"getInwardTransfers","name":"Retrieves the list of Inward Transfer details such as Transaction Reference, Type, Currency, Amount, Ordering Bank & Customer and Accounts involved in the Transaction","summary":"Retrieves Inward Funds Transfer details","tags":[],"parameters":[{"name":"debitAccountId","in":"path","type":"string","required":true,"description":"Indicates the debit account number of the payment or transaction."},{"name":"creditAccountId","in":"path","type":"string","required":true,"description":"Credit account identifier of the payment or transaction"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from t24 on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"InwardTransfersResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"POST","path":"/order/transfers/outwards","fullPath":"/api/v1.0.0/order/transfers/outwards","operationId":"createOutwardTransfer","name":"Create an Outward Transfer with details such Transaction Type, Amount, Date, Commission and Beneficiary","summary":"Create Outward Funds Transfer","tags":[],"parameters":[{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"transactionType":"string","debitAccountId":"string","debitCurrency":"string","debitAmount":0.0,"debitValueDate":"2024-01-01","creditAccountId":"string","creditCurrencyId":"string","creditAmount":0.0,"creditValueDate":"2024-01-01","beneficiaryCustomerId":"string","beneficiaryBank":"string","beneficiaryName":"string"}},"responses":{"200":"OutwardTransferResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/order/transfers/outwards/{fundsTransferId}","fullPath":"/api/v1.0.0/order/transfers/outwards/{fundsTransferId}","operationId":"updateOutwardTransfer","name":"Update an Outward Transfer with details such as Transaction Type, Amount, Date, Commission and Beneficiary","summary":"Update Funds Transfer details for a Outward Transfer","tags":[],"parameters":[{"name":"fundsTransferId","in":"path","type":"string","required":true,"description":"Identifier of the Funds Transfer"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"transactionType":"string","debitAccountId":"string","debitCurrency":"string","debitAmount":0.0,"debitValueDate":"2024-01-01","creditAccountId":"string","creditCurrencyId":"string","creditAmount":0.0,"creditValueDate":"2024-01-01","beneficiaryCustomerId":"string","beneficiaryBank":"string","beneficiaryName":"string"}},"responses":{"200":"OutwardTransferResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/order/transfers/outwards/{debitAccountId}/{creditAccountId}","fullPath":"/api/v1.0.0/order/transfers/outwards/{debitAccountId}/{creditAccountId}","operationId":"getOutwardTransfers","name":"Retrieves the list of Outward Transfer details such as Transaction Reference, Type, Currency, Amount, and Beneficiary and Accounts involved in the Transaction","summary":"Retrieves Outward Funds Transfer details","tags":[],"parameters":[{"name":"debitAccountId","in":"path","type":"string","required":true,"description":"Indicates the debit account number of the payment or transaction."},{"name":"creditAccountId","in":"path","type":"string","required":true,"description":"Credit account identifier of the payment or transaction"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from t24 on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"OutwardTransfersResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"POST","path":"/order/transfers","fullPath":"/api/v1.0.0/order/transfers","operationId":"createFundsTransfer","name":"Create funds transfer","summary":"Initiate a new fund transfer request for accounts","tags":[],"parameters":[{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"paymentDetails":[{}],"beneficiaryCustomerIds":[{}],"beneficiaryBICNames":[{}],"overrides":[{}],"debitAccountId":"string","debitCurrencyId":"string","debitAmount":0.0,"creditAccountId":"string","creditCurrencyId":"string","creditAmount":0.0,"beneficiaryOurCharges":"string","processingDate":"2024-01-01","transactionType":"string","beneficiaryAccountId":"string","beneficiaryId":"string"}},"responses":{"200":"FundsTransferResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/order/transfers/{transferId}","fullPath":"/api/v1.0.0/order/transfers/{transferId}","operationId":"updateFundsTransfer","name":"Update funds transfer details","summary":"Updates an existing fund transfer request for accounts","tags":[],"parameters":[{"name":"transferId","in":"path","type":"string","required":true,"description":""},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"paymentDetails":[{}],"beneficiaryCustomerIds":[{}],"beneficiaryBICNames":[{}],"overrides":[{}],"debitAccountId":"string","debitCurrencyId":"string","debitAmount":0.0,"creditAccountId":"string","creditCurrencyId":"string","creditAmount":0.0,"beneficiaryOurCharges":"string","processingDate":"2024-01-01","transactionType":"string","beneficiaryAccountId":"string","beneficiaryId":"string"}},"responses":{"200":"FundsTransferResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"DELETE","path":"/order/transfers/{transferId}","fullPath":"/api/v1.0.0/order/transfers/{transferId}","operationId":"deleteFundsTransfer","name":"Cancel funds transfer","summary":"Cancel fund transfer request","tags":[],"parameters":[{"name":"transferId","in":"path","type":"string","required":true,"description":""},{"name":"payload","in":"body","type":"object","required":false,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}}},"responses":{"200":"FundsTransferResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}}]},{"key":"order-accountTransfers-v1.0.1","title":"Management of fund transfers","version":"v1.0.1","description":"API to create, update and manage transactions related to accounts such as inward/outward funds transfers and bulk transfers.","endpointCount":11,"endpoints":[{"method":"GET","path":"/order/transfers/{debitAccountId}/{creditAccountId}","fullPath":"/api/v1.0.1/order/transfers/{debitAccountId}/{creditAccountId}","operationId":"getAccountTransfers","name":"Retrieves list of funds transfer details such as type of transaction, date & amount for the specified customer accounts","summary":"Retrieves list of funds transfers","tags":[],"parameters":[{"name":"debitAccountId","in":"path","type":"string","required":true,"description":"Indicates the debit account number of the payment or transaction."},{"name":"creditAccountId","in":"path","type":"string","required":true,"description":"Credit account identifier of the payment or transaction"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"AccountTransfersResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/order/transfers/bulkTransfers/{bulkTransferId}","fullPath":"/api/v1.0.1/order/transfers/bulkTransfers/{bulkTransferId}","operationId":"getBulkTransfers","name":"Retrieves the list of bulk transfer details such as transaction reference, type, currency, amount & accounts involved in the transaction occurred in a day","summary":"Retrieves bulk transfer details","tags":[],"parameters":[{"name":"bulkTransferId","in":"path","type":"string","required":true,"description":"Identifier of the Bulk Transfer"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"BulkTransfersResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"POST","path":"/order/transfers/inwards","fullPath":"/api/v1.0.1/order/transfers/inwards","operationId":"createInwardTransfer","name":"Create an inward transfer with details such as transaction type, amount, date, commission and ordering bank & customer","summary":"Create inward funds transfer","tags":[],"parameters":[{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"transactionType":"string","debitAccountId":"string","debitCurrency":"string","debitAmount":0.0,"debitValueDate":"2024-01-01","creditAccountId":"string","creditCurrencyId":"string","creditAmount":0.0,"creditValueDate":"2024-01-01","orderingBank":"string","orderingCustomerId":"string"}},"responses":{"200":"InwardTransferResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/order/transfers/inwards/{fundsTransferId}","fullPath":"/api/v1.0.1/order/transfers/inwards/{fundsTransferId}","operationId":"updateInwardTransfer","name":"Update an inward transfer with details such as transaction type, amount, date, commission and ordering bank & customer","summary":"Update funds transfer details for a inward transfer","tags":[],"parameters":[{"name":"fundsTransferId","in":"path","type":"string","required":true,"description":"Identifier of the Funds Transfer"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"transactionType":"string","debitAccountId":"string","debitCurrency":"string","debitAmount":0.0,"debitValueDate":"2024-01-01","creditAccountId":"string","creditCurrencyId":"string","creditAmount":0.0,"creditValueDate":"2024-01-01","orderingBank":"string","orderingCustomerId":"string"}},"responses":{"200":"InwardTransferResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/order/transfers/inwards/{debitAccountId}/{creditAccountId}","fullPath":"/api/v1.0.1/order/transfers/inwards/{debitAccountId}/{creditAccountId}","operationId":"getInwardTransfers","name":"Retrieves the list of inward transfer details such as transaction reference, type, currency, amount, ordering bank & customer and accounts involved in the transaction","summary":"Retrieves inward funds transfer details","tags":[],"parameters":[{"name":"debitAccountId","in":"path","type":"string","required":true,"description":"Indicates the debit account number of the payment or transaction."},{"name":"creditAccountId","in":"path","type":"string","required":true,"description":"Credit account identifier of the payment or transaction"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"InwardTransfersResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"POST","path":"/order/transfers/outwards","fullPath":"/api/v1.0.1/order/transfers/outwards","operationId":"createOutwardTransfer","name":"Create an outward transfer with details such transaction type, amount, date, commission and beneficiary","summary":"Create outward funds transfer","tags":[],"parameters":[{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"transactionType":"string","debitAccountId":"string","debitCurrency":"string","debitAmount":0.0,"debitValueDate":"2024-01-01","creditAccountId":"string","creditCurrencyId":"string","creditAmount":0.0,"creditValueDate":"2024-01-01","beneficiaryCustomerId":"string","beneficiaryBank":"string","beneficiaryName":"string"}},"responses":{"200":"OutwardTransferResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/order/transfers/outwards/{fundsTransferId}","fullPath":"/api/v1.0.1/order/transfers/outwards/{fundsTransferId}","operationId":"updateOutwardTransfer","name":"Update an outward transfer with details such as transaction type, amount, date, commission and beneficiary","summary":"Update funds transfer details for a outward transfer","tags":[],"parameters":[{"name":"fundsTransferId","in":"path","type":"string","required":true,"description":"Identifier of the Funds Transfer"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"transactionType":"string","debitAccountId":"string","debitCurrency":"string","debitAmount":0.0,"debitValueDate":"2024-01-01","creditAccountId":"string","creditCurrencyId":"string","creditAmount":0.0,"creditValueDate":"2024-01-01","beneficiaryCustomerId":"string","beneficiaryBank":"string","beneficiaryName":"string"}},"responses":{"200":"OutwardTransferResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/order/transfers/outwards/{debitAccountId}/{creditAccountId}","fullPath":"/api/v1.0.1/order/transfers/outwards/{debitAccountId}/{creditAccountId}","operationId":"getOutwardTransfers","name":"Retrieves the list of outward transfer details such as transaction reference, type, currency, amount, and beneficiary and accounts involved in the transaction","summary":"Retrieves outward funds transfer details","tags":[],"parameters":[{"name":"debitAccountId","in":"path","type":"string","required":true,"description":"Indicates the debit account number of the payment or transaction."},{"name":"creditAccountId","in":"path","type":"string","required":true,"description":"Credit account identifier of the payment or transaction"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"OutwardTransfersResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"POST","path":"/order/transfers","fullPath":"/api/v1.0.1/order/transfers","operationId":"createAccountTransfer","name":"Create funds transfer between two customer accounts with details such as transaction type, amount, date & commission","summary":"Create a funds transfer","tags":[],"parameters":[{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"orderingCustomerIds":[{}],"orderingBanks":[{}],"accountWithBanks":[{}],"beneficiaryBanks":[{}],"beneficiaryNames":[{}],"beneficiaryAddresses":[{}],"beneficiaryAddressCities":[{}],"beneficiaryCustomerIds":[{}],"paymentDetails":[{}],"transactionType":"string","debitAccountId":"string","debitCurrency":"string","debitAmount":0.0,"debitValueDate":"2024-01-01","creditAccountId":"string"}},"responses":{"200":"AccountTransferResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/order/transfers/{fundsTransferId}","fullPath":"/api/v1.0.1/order/transfers/{fundsTransferId}","operationId":"updateAccountTransfer","name":"Update funds transfer with details such as transaction type, amount, date & commission","summary":"Update funds transfer details","tags":[],"parameters":[{"name":"fundsTransferId","in":"path","type":"string","required":true,"description":"Identifier of the Funds Transfer"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"orderingCustomerIds":[{}],"orderingBanks":[{}],"accountWithBanks":[{}],"beneficiaryBanks":[{}],"beneficiaryNames":[{}],"beneficiaryAddresses":[{}],"beneficiaryAddressCities":[{}],"beneficiaryCustomerIds":[{}],"paymentDetails":[{}],"transactionType":"string","debitAccountId":"string","debitCurrency":"string","debitAmount":0.0,"debitValueDate":"2024-01-01","creditAccountId":"string"}},"responses":{"200":"AccountTransferResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"DELETE","path":"/order/transfers/{fundsTransferId}","fullPath":"/api/v1.0.1/order/transfers/{fundsTransferId}","operationId":"deleteAccountTransfer","name":"Cancel funds transfer","summary":"Cancel fund transfer request","tags":[],"parameters":[{"name":"fundsTransferId","in":"path","type":"string","required":true,"description":"Identifier of the Funds Transfer"},{"name":"payload","in":"body","type":"object","required":false,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}}},"responses":{"200":"AccountTransferResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}}]},{"key":"order-bulkitems-service-v3.0.0","title":"Bulk Items","version":"v3.0.0","description":"Allows the creation, viewing and management of bulk payment","endpointCount":5,"endpoints":[{"method":"GET","path":"/order/bulkPayments/items/{bulkItemId}","fullPath":"/api/v3.0.0/order/bulkPayments/items/{bulkItemId}","operationId":"getBulkItem","name":"Retrieves bulk item","summary":"Retrieves the list of Bulk Item","tags":[],"parameters":[{"name":"bulkItemId","in":"path","type":"string","required":true,"description":"contains individual payment id of the Bulk upload"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"BulkItemResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"POST","path":"/order/bulkPayments/items/{bulkItemId}","fullPath":"/api/v3.0.0/order/bulkPayments/items/{bulkItemId}","operationId":"createBulkItem","name":"Create a new bulk item","summary":"Create bulk item","tags":[],"parameters":[{"name":"bulkItemId","in":"path","type":"string","required":true,"description":""},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"errorMessages":[{}],"inputters":[{}],"dateTimeDetails":[{}],"overrides":[{}],"beneficiaryId":"string","accountId":"string","sortCode":"string","customerId":"string","currencyId":"string","amount":0.0,"valueDate":"2024-01-01","transactionTypeId":"string","reference":"string","manualUpload":"string","status":"string"}},"responses":{"200":"BulkItemResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/order/bulkPayments/items/{bulkItemId}","fullPath":"/api/v3.0.0/order/bulkPayments/items/{bulkItemId}","operationId":"updateBulkItem","name":"Update existing bulk item details","summary":"Update bulk item","tags":[],"parameters":[{"name":"bulkItemId","in":"path","type":"string","required":true,"description":"contains individual payment id of the Bulk upload"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"errorMessages":[{}],"inputters":[{}],"dateTimeDetails":[{}],"overrides":[{}],"beneficiaryId":"string","accountId":"string","sortCode":"string","customerId":"string","currencyId":"string","amount":0.0,"valueDate":"2024-01-01","transactionTypeId":"string","reference":"string","manualUpload":"string","status":"string"}},"responses":{"200":"BulkItemResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/order/bulkPayments/uploads/fileTypes","fullPath":"/api/v3.0.0/order/bulkPayments/uploads/fileTypes","operationId":"getUploadFileTypes","name":"Retrieves file upload types","summary":"Retrieves file upload types","tags":[],"parameters":[{"name":"uploadTypeId","in":"query","type":"string","required":false,"description":"Specifies the identifier of the upload type record which contains the directory, and optionally a maximum upload size limit and file extension."},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"UploadFileTypesResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/order/bulkPayments/items","fullPath":"/api/v3.0.0/order/bulkPayments/items","operationId":"getBulkItems","name":"Retrieves bulk items","summary":"Retrieves bulk items","tags":[],"parameters":[{"name":"bulkReference","in":"query","type":"string","required":false,"description":"Contains bulk master reference for the payment."},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"BulkItemsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}}]},{"key":"order-bulkpayments-service-v1.0.0","title":"BulkpaymentsAPIs","version":"v1.0.0","description":"Bulk Payments","endpointCount":16,"endpoints":[{"method":"GET","path":"/order/bulkPayments/uploads/files","fullPath":"/api/v1.0.0/order/bulkPayments/uploads/files","operationId":"getUploadFiles","name":"Get Upload Files","summary":"","tags":[],"parameters":[{"name":"systemFileName","in":"query","type":"string","required":false,"description":""},{"name":"externalUserId","in":"query","type":"string","required":false,"description":"The identifier of the external user"},{"name":"fileUploadId","in":"query","type":"string","required":false,"description":""},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from t24 on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":""},{"name":"companyId","in":"header","type":"string","required":false,"description":""}],"requestBodyExample":null,"responses":{"200":"UploadFilesResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"POST","path":"/order/bulkPayments/uploads/files","fullPath":"/api/v1.0.0/order/bulkPayments/uploads/files","operationId":"uploadFile","name":"Upload File","summary":"","tags":[],"parameters":[{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":""},{"name":"companyId","in":"header","type":"string","required":false,"description":""}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"overrides":[{}],"displayName":"string","systemFileName":"string","fileName":"string","uploadTypeId":"string","status":"string","uploadSize":"string","companyId":"string"}},"responses":{"200":"FileResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"POST","path":"/order/bulkPayments/items/{bulkMasterId}","fullPath":"/api/v1.0.0/order/bulkPayments/items/{bulkMasterId}","operationId":"createBulkItem","name":"Create Bulk Item","summary":"","tags":[],"parameters":[{"name":"bulkMasterId","in":"path","type":"string","required":true,"description":""},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":""},{"name":"companyId","in":"header","type":"string","required":false,"description":""}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"errorMessages":[{}],"inputters":[{}],"dateTimeDetails":[{}],"overrides":[{}],"beneficiaryId":"string","accountId":"string","sortCode":"string","customerId":"string","currencyId":"string","amount":0.0,"valueDate":"2024-01-01","transactionTypeId":"string","reference":"string","uploadManual":"string","status":"string"}},"responses":{"200":"BulkItemResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/order/bulkPayments/items/{bulkItemId}","fullPath":"/api/v1.0.0/order/bulkPayments/items/{bulkItemId}","operationId":"getBulkItem","name":"Get Bulk Item","summary":"","tags":[],"parameters":[{"name":"bulkItemId","in":"path","type":"string","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":""},{"name":"companyId","in":"header","type":"string","required":false,"description":""}],"requestBodyExample":null,"responses":{"200":"BulkItemResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/order/bulkPayments/items/{bulkItemId}","fullPath":"/api/v1.0.0/order/bulkPayments/items/{bulkItemId}","operationId":"updateBulkItem","name":"Update Bulk Item","summary":"","tags":[],"parameters":[{"name":"bulkItemId","in":"path","type":"string","required":true,"description":""},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":""},{"name":"companyId","in":"header","type":"string","required":false,"description":""}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"errorMessages":[{}],"inputters":[{}],"dateTimeDetails":[{}],"overrides":[{}],"beneficiaryId":"string","accountId":"string","sortCode":"string","customerId":"string","currencyId":"string","amount":0.0,"valueDate":"2024-01-01","transactionTypeId":"string","reference":"string","uploadManual":"string","status":"string"}},"responses":{"200":"BulkItemResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/order/bulkPayments/{bulkMasterId}","fullPath":"/api/v1.0.0/order/bulkPayments/{bulkMasterId}","operationId":"getBulkPayment","name":"Get Bulk Payment","summary":"","tags":[],"parameters":[{"name":"bulkMasterId","in":"path","type":"string","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":""},{"name":"companyId","in":"header","type":"string","required":false,"description":""}],"requestBodyExample":null,"responses":{"200":"BulkPaymentResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/order/bulkPayments/{bulkMasterId}","fullPath":"/api/v1.0.0/order/bulkPayments/{bulkMasterId}","operationId":"updateBulkPayment","name":"","summary":"","tags":[],"parameters":[{"name":"bulkMasterId","in":"path","type":"string","required":true,"description":""},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":""},{"name":"companyId","in":"header","type":"string","required":false,"description":""}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{}},"responses":{"200":"BulkPaymentResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"DELETE","path":"/order/bulkPayments/{bulkMasterId}","fullPath":"/api/v1.0.0/order/bulkPayments/{bulkMasterId}","operationId":"deleteBulkPayment","name":"Delete Bulk Payment","summary":"","tags":[],"parameters":[{"name":"bulkMasterId","in":"path","type":"string","required":true,"description":""},{"name":"payload","in":"body","type":"object","required":false,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":""},{"name":"companyId","in":"header","type":"string","required":false,"description":""}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{}},"responses":{"200":"BulkPaymentResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/order/bulkPayments","fullPath":"/api/v1.0.0/order/bulkPayments","operationId":"getBulkPayments","name":"Get Bulk Payments","summary":"","tags":[],"parameters":[{"name":"recordStatus","in":"query","type":"string","required":false,"description":"General status of the record. Possible values: - null - authorised - IHLD - input, on hold - INAU - input, not authorised - INA2 - input, authorised, pending second authorisation - INAO - input, not a"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from t24 on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":""},{"name":"companyId","in":"header","type":"string","required":false,"description":""}],"requestBodyExample":null,"responses":{"200":"BulkPaymentsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"POST","path":"/order/bulkPayments","fullPath":"/api/v1.0.0/order/bulkPayments","operationId":"createBulkPayment","name":"Create Bulk Payment","summary":"","tags":[],"parameters":[{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":""},{"name":"companyId","in":"header","type":"string","required":false,"description":""}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{}},"responses":{"200":"BulkPaymentResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/order/bulkPayments/uploads/{uploadId}","fullPath":"/api/v1.0.0/order/bulkPayments/uploads/{uploadId}","operationId":"getUploadFile","name":"Get Upload File","summary":"","tags":[],"parameters":[{"name":"uploadId","in":"path","type":"string","required":true,"description":"The unique identifier of the uploaded file"},{"name":"credentials","in":"header","type":"string","required":false,"description":""},{"name":"companyId","in":"header","type":"string","required":false,"description":""}],"requestBodyExample":null,"responses":{"200":"UploadFileResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/order/bulkPayments/uploads/{uploadId}","fullPath":"/api/v1.0.0/order/bulkPayments/uploads/{uploadId}","operationId":"updateUploadFile","name":"Update Upload File","summary":"","tags":[],"parameters":[{"name":"uploadId","in":"path","type":"string","required":true,"description":"The unique identifier of the uploaded file"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":""},{"name":"companyId","in":"header","type":"string","required":false,"description":""}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"overrides":[{}],"displayName":"string","systemFileName":"string","fileName":"string","uploadTypeId":"string","status":"string","uploadSize":"string","companyId":"string"}},"responses":{"200":"UploadFileResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"DELETE","path":"/order/bulkPayments/uploads/{uploadId}","fullPath":"/api/v1.0.0/order/bulkPayments/uploads/{uploadId}","operationId":"deleteUploadFile","name":"Delete Upload File","summary":"","tags":[],"parameters":[{"name":"uploadId","in":"path","type":"string","required":true,"description":"The unique identifier of the uploaded file"},{"name":"payload","in":"body","type":"object","required":false,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":""},{"name":"companyId","in":"header","type":"string","required":false,"description":""}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{}},"responses":{"200":"UploadFileResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/order/bulkPayments/uploads/fileTypes","fullPath":"/api/v1.0.0/order/bulkPayments/uploads/fileTypes","operationId":"getUploadFileTypes","name":"Get Upload File Types","summary":"","tags":[],"parameters":[{"name":"uploadTypeId","in":"query","type":"string","required":false,"description":""},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from t24 on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":""},{"name":"companyId","in":"header","type":"string","required":false,"description":""}],"requestBodyExample":null,"responses":{"200":"UploadFileTypesResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/order/bulkPayments/items","fullPath":"/api/v1.0.0/order/bulkPayments/items","operationId":"getBulkItems","name":"Get Bulk Items","summary":"","tags":[],"parameters":[{"name":"bulkReferenceId","in":"query","type":"string","required":false,"description":""},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from t24 on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":""},{"name":"companyId","in":"header","type":"string","required":false,"description":""}],"requestBodyExample":null,"responses":{"200":"BulkItemsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"PUT","path":"/order/bulkMasterApprovals/{bulkMasterId}","fullPath":"/api/v1.0.0/order/bulkMasterApprovals/{bulkMasterId}","operationId":"approveBulkPayment","name":"Approve Bulk Payment","summary":"","tags":[],"parameters":[{"name":"bulkMasterId","in":"path","type":"string","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":""},{"name":"companyId","in":"header","type":"string","required":false,"description":""}],"requestBodyExample":null,"responses":{"200":"BulkPaymentResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}}]},{"key":"order-bulkpayments-service-v2.0.0","title":"Bulk payments","version":"v2.0.0","description":"Allows the creation, viewing and management of bulk payment","endpointCount":17,"endpoints":[{"method":"GET","path":"/order/bulkPayments/uploads/files","fullPath":"/api/v2.0.0/order/bulkPayments/uploads/files","operationId":"getUploadFiles","name":"Retrieves uploaded file details","summary":"Retrieves uploaded files","tags":[],"parameters":[{"name":"systemFileName","in":"query","type":"string","required":false,"description":"Contains the system generated name for the uploaded file"},{"name":"uploadId","in":"query","type":"string","required":false,"description":"The unique identifier of the uploaded file"},{"name":"userSignOnName","in":"query","type":"string","required":false,"description":"This is the name entered by the User to sign on to the System. It is used by the System as an alternative key to access User details"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from t24 on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"UploadFilesResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"POST","path":"/order/bulkPayments/uploads/files","fullPath":"/api/v2.0.0/order/bulkPayments/uploads/files","operationId":"uploadFile","name":"Upload File","summary":"","tags":[],"parameters":[{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"displayName":"string","systemFileName":"string","fileName":"string","uploadTypeId":"string","status":"string","uploadSize":"string","companyId":"string"}},"responses":{"200":"FileResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/order/bulkPayments/uploads/{uploadId}","fullPath":"/api/v2.0.0/order/bulkPayments/uploads/{uploadId}","operationId":"getUploadFile","name":"Get Upload File","summary":"","tags":[],"parameters":[{"name":"uploadId","in":"path","type":"string","required":true,"description":"The unique identifier of the uploaded file"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"UploadFileResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/order/bulkPayments/uploads/{uploadId}","fullPath":"/api/v2.0.0/order/bulkPayments/uploads/{uploadId}","operationId":"updateUploadFile","name":"Update Upload File","summary":"","tags":[],"parameters":[{"name":"uploadId","in":"path","type":"string","required":true,"description":"The unique identifier of the uploaded file"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"displayName":"string","systemFileName":"string","fileName":"string","uploadTypeId":"string","status":"string","uploadSize":"string","companyId":"string"}},"responses":{"200":"UploadFileResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"DELETE","path":"/order/bulkPayments/uploads/{uploadId}","fullPath":"/api/v2.0.0/order/bulkPayments/uploads/{uploadId}","operationId":"deleteUploadFile","name":"Delete Upload File","summary":"","tags":[],"parameters":[{"name":"uploadId","in":"path","type":"string","required":true,"description":"The unique identifier of the uploaded file"},{"name":"payload","in":"body","type":"object","required":false,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}}},"responses":{"200":"UploadFileResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"POST","path":"/order/bulkPayments/items/{bulkTransferId}","fullPath":"/api/v2.0.0/order/bulkPayments/items/{bulkTransferId}","operationId":"createBulkItem","name":"Create a new bulk item","summary":"Create bulk item","tags":[],"parameters":[{"name":"bulkTransferId","in":"path","type":"string","required":true,"description":"Identifier of the Bulk Transfer"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"errorMessages":[{}],"inputters":[{}],"dateTimeDetails":[{}],"overrides":[{}],"beneficiaryId":"string","accountId":"string","sortCode":"string","customerId":"string","currencyId":"string","amount":0.0,"valueDate":"2024-01-01","transactionTypeId":"string","reference":"string","manualUpload":"string","status":"string"}},"responses":{"200":"BulkItemResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/order/bulkPayments/items/{bulkItemId}","fullPath":"/api/v2.0.0/order/bulkPayments/items/{bulkItemId}","operationId":"getBulkItem","name":"Retrieves bulk item","summary":"Retrieves the list of Bulk Item","tags":[],"parameters":[{"name":"bulkItemId","in":"path","type":"string","required":true,"description":"contains individual payment id of the Bulk upload"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"BulkItemResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/order/bulkPayments/items/{bulkItemId}","fullPath":"/api/v2.0.0/order/bulkPayments/items/{bulkItemId}","operationId":"updateBulkItem","name":"Update existing bulk item details","summary":"Update bulk item","tags":[],"parameters":[{"name":"bulkItemId","in":"path","type":"string","required":true,"description":"contains individual payment id of the Bulk upload"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"errorMessages":[{}],"inputters":[{}],"dateTimeDetails":[{}],"overrides":[{}],"beneficiaryId":"string","accountId":"string","sortCode":"string","customerId":"string","currencyId":"string","amount":0.0,"valueDate":"2024-01-01","transactionTypeId":"string","reference":"string","manualUpload":"string","status":"string"}},"responses":{"200":"BulkItemResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/order/bulkPayments","fullPath":"/api/v2.0.0/order/bulkPayments","operationId":"getBulkPayments","name":"Retrieves bulk payments","summary":"Retrieves bulk payments","tags":[],"parameters":[{"name":"recordStatus","in":"query","type":"string","required":false,"description":"General status of the record. Possible values: - null - authorised - IHLD - input, on hold - INAU - input, not authorised - INA2 - input, authorised, pending second authorisation - INAO - input, not a"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from t24 on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"BulkPaymentsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"POST","path":"/order/bulkPayments","fullPath":"/api/v2.0.0/order/bulkPayments","operationId":"createBulkPayment","name":"Create a new bulk payment","summary":"Create bulk payment","tags":[],"parameters":[{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"signatories":[{}],"rejectionReasons":[{}],"overrides":[{}],"cancellationReasons":[{}],"errorDetails":[{}],"description":"string","bulkTypeId":"string","creditOrDebitPayment":"string","singleOrmultiplePayments":"string","paymentMethod":"string","processingDate":"2024-01-01","requiredCreditValueDate":"2024-01-01","clearingDate":"2024-01-01","uploadId":"string","netAmount":0.0}},"responses":{"200":"BulkPaymentResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/order/bulkPayments/{bulkTransferId}","fullPath":"/api/v2.0.0/order/bulkPayments/{bulkTransferId}","operationId":"getBulkPayment","name":"Get an initiated bulk payments","summary":"Get Bulk Payment","tags":[],"parameters":[{"name":"bulkTransferId","in":"path","type":"string","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"BulkPaymentResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/order/bulkPayments/{bulkTransferId}","fullPath":"/api/v2.0.0/order/bulkPayments/{bulkTransferId}","operationId":"updateBulkPayment","name":"Update existing bulk payment details","summary":"Update bulk payment","tags":[],"parameters":[{"name":"bulkTransferId","in":"path","type":"string","required":true,"description":"Identifier of the Bulk Transfer"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"signatories":[{}],"rejectionReasons":[{}],"overrides":[{}],"cancellationReasons":[{}],"errorDetails":[{}],"description":"string","bulkTypeId":"string","creditOrDebitPayment":"string","singleOrmultiplePayments":"string","paymentMethod":"string","processingDate":"2024-01-01","requiredCreditValueDate":"2024-01-01","clearingDate":"2024-01-01","uploadId":"string","netAmount":0.0}},"responses":{"200":"BulkPaymentResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"DELETE","path":"/order/bulkPayments/{bulkTransferId}","fullPath":"/api/v2.0.0/order/bulkPayments/{bulkTransferId}","operationId":"deleteBulkPayment","name":"Cancel an existing bulk payment","summary":"Cancel bulk payment","tags":[],"parameters":[{"name":"bulkTransferId","in":"path","type":"string","required":true,"description":"Identifier of the Bulk Transfer"},{"name":"payload","in":"body","type":"object","required":false,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}}},"responses":{"200":"BulkPaymentResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/order/bulkMasterApprovals/{bulkTransferId}","fullPath":"/api/v2.0.0/order/bulkMasterApprovals/{bulkTransferId}","operationId":"approveBulkPayment","name":"Approve an initiated bulk payment","summary":"Approve bulk payment","tags":[],"parameters":[{"name":"bulkTransferId","in":"path","type":"string","required":true,"description":"Identifier of the Bulk Transfer"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"BulkPaymentResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/order/bulkPayments/uploads/fileTypes","fullPath":"/api/v2.0.0/order/bulkPayments/uploads/fileTypes","operationId":"getUploadFileTypes","name":"Retrieves file upload types","summary":"Retrieves file upload types","tags":[],"parameters":[{"name":"uploadTypeId","in":"query","type":"string","required":false,"description":"Specifies the identifier of the upload type record which contains the directory, and optionally a maximum upload size limit and file extension."},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from t24 on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"UploadFileTypesResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/order/bulkPayments/items","fullPath":"/api/v2.0.0/order/bulkPayments/items","operationId":"getBulkItems","name":"Retrieves bulk items","summary":"Retrieves bulk items","tags":[],"parameters":[{"name":"bulkReference","in":"query","type":"string","required":false,"description":"Contains bulk master reference for the payment."},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from t24 on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"BulkItemsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/order/bulkPayments/status","fullPath":"/api/v2.0.0/order/bulkPayments/status","operationId":"getAllBulkPayments","name":"Retrieves the status of bulk payments","summary":"Retrieves the status of bulk payments","tags":[],"parameters":[{"name":"bulkTransferId","in":"query","type":"string","required":false,"description":"Identifier of the Bulk Transfer"},{"name":"bulkReference","in":"query","type":"string","required":false,"description":"Contains bulk master reference for the payment."},{"name":"fundsTransferId","in":"query","type":"string","required":false,"description":"Identifier of the Funds Transfer"},{"name":"customerId","in":"query","type":"string","required":false,"description":"Identifier of the customer"},{"name":"executionDate","in":"query","type":"string","required":false,"description":"Date on which the transaction or payment gets processed, i.e. the processing date of the transaction."},{"name":"amount","in":"query","type":"string","required":false,"description":"This is the payment amount"},{"name":"totalAmount","in":"query","type":"string","required":false,"description":"Total amount"},{"name":"currency","in":"query","type":"string","required":false,"description":"Identifies the currency. E.g. USD, GBP etc"},{"name":"debitAccount","in":"query","type":"string","required":false,"description":" Identifier of the debitAccounts."},{"name":"creditOrDebitPayment","in":"query","type":"string","required":false,"description":"Indicates whether the Bulk processing is for Credit or Debit Payments. Allowed values are DEBIT, CREDIT."},{"name":"paymentSource","in":"query","type":"string","required":false,"description":"Indicates the source from where the payment is originated"},{"name":"bulkTypeId","in":"query","type":"string","required":false,"description":"Identifier of the bulk update type record that holds default conditions required for Bulk Master creation. SINGLE and MULTI are two record references used by payment order application for processing p"},{"name":"singleOrmultiplePayments","in":"query","type":"string","required":false,"description":"Indicates the batch booking preference of the bulk payment. SINGLE \u00e2\u20ac\u201c Single consolidated accounting entry on the debtor account. MULTI \u00e2\u20ac\u201c Individual postings per each credit entry"},{"name":"statusCode","in":"query","type":"string","required":false,"description":"Status code, as defined by the institution"},{"name":"fileSendersReference","in":"query","type":"string","required":false,"description":"Indicates the sender reference that comes from the inward payment file"},{"name":"requiredCreditValueDate","in":"query","type":"string","required":false,"description":"The credit value date i.e. tentative date on which the payment system will process the payment"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from t24 on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"AllBulkPaymentsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}}]},{"key":"order-bulkpayments-service-v2.1.0","title":"Bulk payments","version":"v2.1.0","description":"Allows the creation, viewing and management of bulk payment","endpointCount":17,"endpoints":[{"method":"GET","path":"/order/bulkPayments/uploads/files","fullPath":"/api/v2.1.0/order/bulkPayments/uploads/files","operationId":"getUploadFiles","name":"Retrieves uploaded file details","summary":"Retrieves uploaded files","tags":[],"parameters":[{"name":"systemFileName","in":"query","type":"string","required":false,"description":"Contains the system generated name for the uploaded file"},{"name":"uploadId","in":"query","type":"string","required":false,"description":"The unique identifier of the uploaded file"},{"name":"userSignOnName","in":"query","type":"string","required":false,"description":"This is the name entered by the User to sign on to the System. It is used by the System as an alternative key to access User details"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"UploadFilesResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"POST","path":"/order/bulkPayments/uploads/files","fullPath":"/api/v2.1.0/order/bulkPayments/uploads/files","operationId":"uploadFile","name":"Upload File","summary":"","tags":[],"parameters":[{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"displayName":"string","systemFileName":"string","fileName":"string","uploadTypeId":"string","status":"string","uploadSize":"string","companyId":"string"}},"responses":{"200":"FileResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/order/bulkPayments/uploads/{uploadId}","fullPath":"/api/v2.1.0/order/bulkPayments/uploads/{uploadId}","operationId":"getUploadFile","name":"Get Upload File","summary":"","tags":[],"parameters":[{"name":"uploadId","in":"path","type":"string","required":true,"description":"The unique identifier of the uploaded file"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"UploadFileResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/order/bulkPayments/uploads/{uploadId}","fullPath":"/api/v2.1.0/order/bulkPayments/uploads/{uploadId}","operationId":"updateUploadFile","name":"Update Upload File","summary":"","tags":[],"parameters":[{"name":"uploadId","in":"path","type":"string","required":true,"description":"The unique identifier of the uploaded file"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"displayName":"string","systemFileName":"string","fileName":"string","uploadTypeId":"string","status":"string","uploadSize":"string","companyId":"string"}},"responses":{"200":"UploadFileResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"DELETE","path":"/order/bulkPayments/uploads/{uploadId}","fullPath":"/api/v2.1.0/order/bulkPayments/uploads/{uploadId}","operationId":"deleteUploadFile","name":"Delete Upload File","summary":"","tags":[],"parameters":[{"name":"uploadId","in":"path","type":"string","required":true,"description":"The unique identifier of the uploaded file"},{"name":"payload","in":"body","type":"object","required":false,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}}},"responses":{"200":"UploadFileResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"POST","path":"/order/bulkPayments/items/{bulkTransferId}","fullPath":"/api/v2.1.0/order/bulkPayments/items/{bulkTransferId}","operationId":"createBulkItem","name":"Create a new bulk item","summary":"Create bulk item","tags":[],"parameters":[{"name":"bulkTransferId","in":"path","type":"string","required":true,"description":"Identifier of the Bulk Transfer"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"errorMessages":[{}],"inputters":[{}],"dateTimeDetails":[{}],"overrides":[{}],"beneficiaryId":"string","accountId":"string","sortCode":"string","customerId":"string","currencyId":"string","amount":0.0,"valueDate":"2024-01-01","transactionTypeId":"string","reference":"string","manualUpload":"string","status":"string"}},"responses":{"200":"BulkItemResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/order/bulkPayments/items/{bulkItemId}","fullPath":"/api/v2.1.0/order/bulkPayments/items/{bulkItemId}","operationId":"getBulkItem","name":"Retrieves bulk item","summary":"Retrieves the list of Bulk Item","tags":[],"parameters":[{"name":"bulkItemId","in":"path","type":"string","required":true,"description":"contains individual payment id of the Bulk upload"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"BulkItemResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/order/bulkPayments/items/{bulkItemId}","fullPath":"/api/v2.1.0/order/bulkPayments/items/{bulkItemId}","operationId":"updateBulkItem","name":"Update existing bulk item details","summary":"Update bulk item","tags":[],"parameters":[{"name":"bulkItemId","in":"path","type":"string","required":true,"description":"contains individual payment id of the Bulk upload"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"errorMessages":[{}],"inputters":[{}],"dateTimeDetails":[{}],"overrides":[{}],"beneficiaryId":"string","accountId":"string","sortCode":"string","customerId":"string","currencyId":"string","amount":0.0,"valueDate":"2024-01-01","transactionTypeId":"string","reference":"string","manualUpload":"string","status":"string"}},"responses":{"200":"BulkItemResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/order/bulkPayments/uploads/fileTypes","fullPath":"/api/v2.1.0/order/bulkPayments/uploads/fileTypes","operationId":"getUploadFileTypes","name":"Retrieves file upload types","summary":"Retrieves file upload types","tags":[],"parameters":[{"name":"uploadTypeId","in":"query","type":"string","required":false,"description":"Specifies the identifier of the upload type record which contains the directory, and optionally a maximum upload size limit and file extension."},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"UploadFileTypesResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/order/bulkPayments/items","fullPath":"/api/v2.1.0/order/bulkPayments/items","operationId":"getBulkItems","name":"Retrieves bulk items","summary":"Retrieves bulk items","tags":[],"parameters":[{"name":"bulkReference","in":"query","type":"string","required":false,"description":"Contains bulk master reference for the payment."},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"BulkItemsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/order/bulkPayments","fullPath":"/api/v2.1.0/order/bulkPayments","operationId":"getBulkPayments","name":"Retrieves bulk payments","summary":"Retrieves bulk payments","tags":[],"parameters":[{"name":"recordStatus","in":"query","type":"string","required":false,"description":"General status of the record. Possible values: - null - authorised - IHLD - input, on hold - INAU - input, not authorised - INA2 - input, authorised, pending second authorisation - INAO - input, not a"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"BulkPaymentsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"POST","path":"/order/bulkPayments","fullPath":"/api/v2.1.0/order/bulkPayments","operationId":"createBulkPayment","name":"Create a new bulk payment","summary":"Create bulk payment","tags":[],"parameters":[{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"signatories":[{}],"rejectionReasons":[{}],"overrides":[{}],"cancellationReasons":[{}],"errorDetails":[{}],"description":"string","bulkTypeId":"string","creditOrDebitPayment":"string","singleOrmultiplePayments":"string","paymentMethod":"string","processingDate":"2024-01-01","requiredCreditValueDate":"2024-01-01","clearingDate":"2024-01-01","uploadId":"string","netAmount":0.0}},"responses":{"200":"BulkPaymentResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/order/bulkPayments/status","fullPath":"/api/v2.1.0/order/bulkPayments/status","operationId":"getAllBulkPayments","name":"Retrieves the status of bulk payments","summary":"Retrieves the status of bulk payments","tags":[],"parameters":[{"name":"bulkTransferId","in":"query","type":"string","required":false,"description":"Identifier of the Bulk Transfer"},{"name":"bulkReference","in":"query","type":"string","required":false,"description":"Contains bulk master reference for the payment."},{"name":"fundsTransferId","in":"query","type":"string","required":false,"description":"Identifier of the Funds Transfer"},{"name":"customerId","in":"query","type":"string","required":false,"description":"Identifier of the customer"},{"name":"executionDate","in":"query","type":"string","required":false,"description":"Date on which the transaction or payment gets processed, i.e. the processing date of the transaction."},{"name":"amount","in":"query","type":"string","required":false,"description":"This is the payment amount"},{"name":"totalAmount","in":"query","type":"string","required":false,"description":"Total amount"},{"name":"currency","in":"query","type":"string","required":false,"description":"Identifies the currency. E.g. USD, GBP etc"},{"name":"debitAccount","in":"query","type":"string","required":false,"description":" Identifier of the debitAccounts."},{"name":"creditOrDebitPayment","in":"query","type":"string","required":false,"description":"Indicates whether the Bulk processing is for Credit or Debit Payments. Allowed values are DEBIT, CREDIT."},{"name":"paymentSource","in":"query","type":"string","required":false,"description":"Indicates the source from where the payment is originated"},{"name":"bulkTypeId","in":"query","type":"string","required":false,"description":"Identifier of the bulk update type record that holds default conditions required for Bulk Master creation. SINGLE and MULTI are two record references used by payment order application for processing p"},{"name":"singleOrmultiplePayments","in":"query","type":"string","required":false,"description":"Indicates the batch booking preference of the bulk payment. SINGLE \u00e2\u20ac\u201c Single consolidated accounting entry on the debtor account. MULTI \u00e2\u20ac\u201c Individual postings per each credit entry"},{"name":"statusCode","in":"query","type":"string","required":false,"description":"Status code, as defined by the institution"},{"name":"fileSendersReference","in":"query","type":"string","required":false,"description":"Indicates the sender reference that comes from the inward payment file"},{"name":"requiredCreditValueDate","in":"query","type":"string","required":false,"description":"The credit value date i.e. tentative date on which the payment system will process the payment"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"AllBulkPaymentsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/order/bulkPayments/{bulkTransferId}","fullPath":"/api/v2.1.0/order/bulkPayments/{bulkTransferId}","operationId":"getBulkPayment","name":"Get an initiated bulk payments","summary":"Get Bulk Payment","tags":[],"parameters":[{"name":"bulkTransferId","in":"path","type":"string","required":true,"description":"Identifier of the Bulk Transfer"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"BulkPaymentResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/order/bulkPayments/{bulkTransferId}","fullPath":"/api/v2.1.0/order/bulkPayments/{bulkTransferId}","operationId":"updateBulkPayment","name":"Update existing bulk payment details","summary":"Update bulk payment","tags":[],"parameters":[{"name":"bulkTransferId","in":"path","type":"string","required":true,"description":"Identifier of the Bulk Transfer"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"signatories":[{}],"rejectionReasons":[{}],"overrides":[{}],"cancellationReasons":[{}],"errorDetails":[{}],"description":"string","bulkTypeId":"string","creditOrDebitPayment":"string","singleOrmultiplePayments":"string","paymentMethod":"string","processingDate":"2024-01-01","requiredCreditValueDate":"2024-01-01","clearingDate":"2024-01-01","uploadId":"string","netAmount":0.0}},"responses":{"200":"BulkPaymentResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"DELETE","path":"/order/bulkPayments/{bulkTransferId}","fullPath":"/api/v2.1.0/order/bulkPayments/{bulkTransferId}","operationId":"deleteBulkPayment","name":"Cancel an existing bulk payment","summary":"Cancel bulk payment","tags":[],"parameters":[{"name":"bulkTransferId","in":"path","type":"string","required":true,"description":"Identifier of the Bulk Transfer"},{"name":"payload","in":"body","type":"object","required":false,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}}},"responses":{"200":"BulkPaymentResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/order/bulkMasterApprovals/{bulkTransferId}","fullPath":"/api/v2.1.0/order/bulkMasterApprovals/{bulkTransferId}","operationId":"approveBulkPayment","name":"Approve an initiated bulk payment","summary":"Approve bulk payment","tags":[],"parameters":[{"name":"bulkTransferId","in":"path","type":"string","required":true,"description":"Identifier of the Bulk Transfer"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"BulkPaymentResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}}]},{"key":"order-bulkpayments-service-v2.2.0","title":"Bulk payments","version":"v2.2.0","description":"Allows the creation, viewing and management of bulk payment","endpointCount":17,"endpoints":[{"method":"GET","path":"/order/bulkPayments/uploads/files","fullPath":"/api/v2.2.0/order/bulkPayments/uploads/files","operationId":"getUploadFiles","name":"Retrieves uploaded file details","summary":"Retrieves uploaded files","tags":[],"parameters":[{"name":"systemFileName","in":"query","type":"string","required":false,"description":"Contains the system generated name for the uploaded file"},{"name":"uploadId","in":"query","type":"string","required":false,"description":"The unique identifier of the uploaded file"},{"name":"userSignOnName","in":"query","type":"string","required":false,"description":"This is the name entered by the User to sign on to the System. It is used by the System as an alternative key to access User details"},{"name":"lastUpdateDate","in":"query","type":"string","required":false,"description":"Specifies the date of last update to the record."},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"UploadFilesResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"POST","path":"/order/bulkPayments/uploads/files","fullPath":"/api/v2.2.0/order/bulkPayments/uploads/files","operationId":"uploadFile","name":"Upload a new file","summary":"Upload a new file","tags":[],"parameters":[{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"displayName":"string","systemFileName":"string","fileName":"string","uploadTypeId":"string","status":"string","uploadSize":"string","companyId":"string"}},"responses":{"200":"FileResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/order/bulkPayments/uploads/{uploadId}","fullPath":"/api/v2.2.0/order/bulkPayments/uploads/{uploadId}","operationId":"getUploadFile","name":"Get uploaded file","summary":"Get uploaded file","tags":[],"parameters":[{"name":"uploadId","in":"path","type":"string","required":true,"description":"The unique identifier of the uploaded file"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"UploadFileResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/order/bulkPayments/uploads/{uploadId}","fullPath":"/api/v2.2.0/order/bulkPayments/uploads/{uploadId}","operationId":"updateUploadFile","name":"Update uploaded file","summary":"Update uploaded file","tags":[],"parameters":[{"name":"uploadId","in":"path","type":"string","required":true,"description":"The unique identifier of the uploaded file"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"displayName":"string","systemFileName":"string","fileName":"string","uploadTypeId":"string","status":"string","uploadSize":"string","companyId":"string"}},"responses":{"200":"UploadFileResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"DELETE","path":"/order/bulkPayments/uploads/{uploadId}","fullPath":"/api/v2.2.0/order/bulkPayments/uploads/{uploadId}","operationId":"deleteUploadFile","name":"Delete uploaded file","summary":"Delete uploaded file","tags":[],"parameters":[{"name":"uploadId","in":"path","type":"string","required":true,"description":"The unique identifier of the uploaded file"},{"name":"payload","in":"body","type":"object","required":false,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}}},"responses":{"200":"UploadFileResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/order/bulkPayments/items/{bulkItemId}","fullPath":"/api/v2.2.0/order/bulkPayments/items/{bulkItemId}","operationId":"getBulkItem","name":"Retrieves bulk item","summary":"Retrieves the list of Bulk Item","tags":[],"parameters":[{"name":"bulkItemId","in":"path","type":"string","required":true,"description":"contains individual payment id of the Bulk upload"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"BulkItemResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"POST","path":"/order/bulkPayments/items/{bulkItemId}","fullPath":"/api/v2.2.0/order/bulkPayments/items/{bulkItemId}","operationId":"createBulkItem","name":"Create a new bulk item","summary":"Create bulk item","tags":[],"parameters":[{"name":"bulkItemId","in":"path","type":"string","required":true,"description":""},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"errorMessages":[{}],"inputters":[{}],"dateTimeDetails":[{}],"overrides":[{}],"beneficiaryId":"string","accountId":"string","sortCode":"string","customerId":"string","currencyId":"string","amount":0.0,"valueDate":"2024-01-01","transactionTypeId":"string","reference":"string","manualUpload":"string","status":"string"}},"responses":{"200":"BulkItemResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/order/bulkPayments/items/{bulkItemId}","fullPath":"/api/v2.2.0/order/bulkPayments/items/{bulkItemId}","operationId":"updateBulkItem","name":"Update existing bulk item details","summary":"Update bulk item","tags":[],"parameters":[{"name":"bulkItemId","in":"path","type":"string","required":true,"description":"contains individual payment id of the Bulk upload"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"errorMessages":[{}],"inputters":[{}],"dateTimeDetails":[{}],"overrides":[{}],"beneficiaryId":"string","accountId":"string","sortCode":"string","customerId":"string","currencyId":"string","amount":0.0,"valueDate":"2024-01-01","transactionTypeId":"string","reference":"string","manualUpload":"string","status":"string"}},"responses":{"200":"BulkItemResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/order/bulkPayments/uploads/fileTypes","fullPath":"/api/v2.2.0/order/bulkPayments/uploads/fileTypes","operationId":"getUploadFileTypes","name":"Retrieves file upload types","summary":"Retrieves file upload types","tags":[],"parameters":[{"name":"uploadTypeId","in":"query","type":"string","required":false,"description":"Specifies the identifier of the upload type record which contains the directory, and optionally a maximum upload size limit and file extension."},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"UploadFileTypesResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/order/bulkPayments/items","fullPath":"/api/v2.2.0/order/bulkPayments/items","operationId":"getBulkItems","name":"Retrieves bulk items","summary":"Retrieves bulk items","tags":[],"parameters":[{"name":"bulkReference","in":"query","type":"string","required":false,"description":"Contains bulk master reference for the payment."},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"BulkItemsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/order/bulkPayments","fullPath":"/api/v2.2.0/order/bulkPayments","operationId":"getBulkPayments","name":"Retrieves bulk payments","summary":"Retrieves bulk payments","tags":[],"parameters":[{"name":"recordStatus","in":"query","type":"string","required":false,"description":"General status of the record. Possible values: - null - authorised - IHLD - input, on hold - INAU - input, not authorised - INA2 - input, authorised, pending second authorisation - INAO - input, not a"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"BulkPaymentsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"POST","path":"/order/bulkPayments","fullPath":"/api/v2.2.0/order/bulkPayments","operationId":"createBulkPayment","name":"Create a new bulk payment","summary":"Create bulk payment","tags":[],"parameters":[{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"signatories":[{}],"rejectionReasons":[{}],"overrides":[{}],"cancellationReasons":[{}],"errorDetails":[{}],"description":"string","bulkTypeId":"string","creditOrDebitPayment":"string","singleOrmultiplePayments":"string","paymentMethod":"string","processingDate":"2024-01-01","requiredCreditValueDate":"2024-01-01","clearingDate":"2024-01-01","uploadId":"string","netAmount":0.0}},"responses":{"200":"BulkPaymentResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/order/bulkPayments/status","fullPath":"/api/v2.2.0/order/bulkPayments/status","operationId":"getAllBulkPayments","name":"Retrieves the status of bulk payments","summary":"Retrieves the status of bulk payments","tags":[],"parameters":[{"name":"bulkTransferId","in":"query","type":"string","required":false,"description":"Identifier of the Bulk Transfer"},{"name":"bulkReference","in":"query","type":"string","required":false,"description":"Contains bulk master reference for the payment."},{"name":"fundsTransferId","in":"query","type":"string","required":false,"description":"Identifier of the Funds Transfer"},{"name":"customerId","in":"query","type":"string","required":false,"description":"Identifier of the customer"},{"name":"executionDate","in":"query","type":"string","required":false,"description":"Date on which the transaction or payment gets processed, i.e. the processing date of the transaction."},{"name":"amount","in":"query","type":"string","required":false,"description":"This is the payment amount"},{"name":"totalAmount","in":"query","type":"string","required":false,"description":"Total amount"},{"name":"currency","in":"query","type":"string","required":false,"description":"Identifies the currency. E.g. USD, GBP etc"},{"name":"debitAccount","in":"query","type":"string","required":false,"description":" Identifier of the debitAccounts."},{"name":"creditOrDebitPayment","in":"query","type":"string","required":false,"description":"Indicates whether the Bulk processing is for Credit or Debit Payments. Allowed values are DEBIT, CREDIT."},{"name":"paymentSource","in":"query","type":"string","required":false,"description":"Indicates the source from where the payment is originated"},{"name":"bulkTypeId","in":"query","type":"string","required":false,"description":"Identifier of the bulk update type record that holds default conditions required for Bulk Master creation. SINGLE and MULTI are two record references used by payment order application for processing p"},{"name":"singleOrmultiplePayments","in":"query","type":"string","required":false,"description":"Indicates the batch booking preference of the bulk payment. SINGLE \u00e2\u20ac\u201c Single consolidated accounting entry on the debtor account. MULTI \u00e2\u20ac\u201c Individual postings per each credit entry"},{"name":"statusCode","in":"query","type":"string","required":false,"description":"Status code, as defined by the institution"},{"name":"fileSendersReference","in":"query","type":"string","required":false,"description":"Indicates the sender reference that comes from the inward payment file"},{"name":"requiredCreditValueDate","in":"query","type":"string","required":false,"description":"The credit value date i.e. tentative date on which the payment system will process the payment"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"AllBulkPaymentsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/order/bulkPayments/{bulkTransferId}","fullPath":"/api/v2.2.0/order/bulkPayments/{bulkTransferId}","operationId":"getBulkPayment","name":"Get an initiated bulk payments","summary":"Get Bulk Payment","tags":[],"parameters":[{"name":"bulkTransferId","in":"path","type":"string","required":true,"description":"Identifier of the Bulk Transfer"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"BulkPaymentResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/order/bulkPayments/{bulkTransferId}","fullPath":"/api/v2.2.0/order/bulkPayments/{bulkTransferId}","operationId":"updateBulkPayment","name":"Update existing bulk payment details","summary":"Update bulk payment","tags":[],"parameters":[{"name":"bulkTransferId","in":"path","type":"string","required":true,"description":"Identifier of the Bulk Transfer"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"signatories":[{}],"rejectionReasons":[{}],"overrides":[{}],"cancellationReasons":[{}],"errorDetails":[{}],"description":"string","bulkTypeId":"string","creditOrDebitPayment":"string","singleOrmultiplePayments":"string","paymentMethod":"string","processingDate":"2024-01-01","requiredCreditValueDate":"2024-01-01","clearingDate":"2024-01-01","uploadId":"string","netAmount":0.0}},"responses":{"200":"BulkPaymentResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"DELETE","path":"/order/bulkPayments/{bulkTransferId}","fullPath":"/api/v2.2.0/order/bulkPayments/{bulkTransferId}","operationId":"deleteBulkPayment","name":"Cancel an existing bulk payment","summary":"Cancel bulk payment","tags":[],"parameters":[{"name":"bulkTransferId","in":"path","type":"string","required":true,"description":"Identifier of the Bulk Transfer"},{"name":"payload","in":"body","type":"object","required":false,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}}},"responses":{"200":"BulkPaymentResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/order/bulkMasterApprovals/{bulkTransferId}","fullPath":"/api/v2.2.0/order/bulkMasterApprovals/{bulkTransferId}","operationId":"approveBulkPayment","name":"Approve an initiated bulk payment","summary":"Approve bulk payment","tags":[],"parameters":[{"name":"bulkTransferId","in":"path","type":"string","required":true,"description":"Identifier of the Bulk Transfer"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"BulkPaymentResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}}]},{"key":"order-bulkpayments-service-v3.0.0","title":"Bulk Payment Initiation","version":"v3.0.0","description":"Bulk Initiation (BU) is a Temenos Payments Application that allows bank to upload small and medium sized bulk payment files, or manually capture bulk payments in its front office or back offices. The Application can be accessed by online channel applications by the APIs listed in this page to upload","endpointCount":12,"endpoints":[{"method":"GET","path":"/order/bulkPayments/uploads/files","fullPath":"/api/v3.0.0/order/bulkPayments/uploads/files","operationId":"getUploadFiles","name":"Enquire on uploaded bulk file","summary":"Enquire on uploaded bulk file","tags":[],"parameters":[{"name":"systemFileName","in":"query","type":"string","required":false,"description":"Contains the system generated name for the uploaded file"},{"name":"uploadId","in":"query","type":"string","required":false,"description":"The unique identifier of the uploaded file"},{"name":"userSignOnName","in":"query","type":"string","required":false,"description":"This is the name entered by the User to sign on to the System. It is used by the System as an alternative key to access User details"},{"name":"lastUpdateDate","in":"query","type":"string","required":false,"description":"Specifies the date of last update to the record."},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"UploadFilesResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"POST","path":"/order/bulkPayments/uploads/files","fullPath":"/api/v3.0.0/order/bulkPayments/uploads/files","operationId":"uploadFile","name":"Upload a SME/Corporate bulk file containing bulk payments using a channel","summary":"Upload bulk payment file","tags":[],"parameters":[{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"displayName":"string","systemFileName":"string","fileName":"string","uploadTypeId":"string","status":"string","uploadSize":"string","companyId":"string"}},"responses":{"200":"FileResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/order/bulkPayments/uploads/{uploadId}","fullPath":"/api/v3.0.0/order/bulkPayments/uploads/{uploadId}","operationId":"getUploadFile","name":"Enquire on uploaded bulk file based on upload reference","summary":"Enquire a bulk based on upload reference","tags":[],"parameters":[{"name":"uploadId","in":"path","type":"string","required":true,"description":"The unique identifier of the uploaded file"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"UploadFileResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/order/bulkPayments/uploads/{uploadId}","fullPath":"/api/v3.0.0/order/bulkPayments/uploads/{uploadId}","operationId":"updateUploadFile","name":"Perform update operation on uploaded bulk file based on upload reference","summary":"Amend a bulk based on upload reference","tags":[],"parameters":[{"name":"uploadId","in":"path","type":"string","required":true,"description":"The unique identifier of the uploaded file"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"displayName":"string","systemFileName":"string","fileName":"string","uploadTypeId":"string","status":"string","uploadSize":"string","companyId":"string"}},"responses":{"200":"UploadFileResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"DELETE","path":"/order/bulkPayments/uploads/{uploadId}","fullPath":"/api/v3.0.0/order/bulkPayments/uploads/{uploadId}","operationId":"deleteUploadFile","name":"Perform cancel operation on uploaded bulk file based on upload reference","summary":"Cancel a bulk based on upload reference","tags":[],"parameters":[{"name":"uploadId","in":"path","type":"string","required":true,"description":"The unique identifier of the uploaded file"},{"name":"payload","in":"body","type":"object","required":false,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}}},"responses":{"200":"UploadFileResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"POST","path":"/order/order/bulkPayments","fullPath":"/api/v3.0.0/order/order/bulkPayments","operationId":"uploadBulkMasterPayment","name":"Create bulk payment manually","summary":"Create manual bulk payment","tags":[],"parameters":[{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"signatories":[{}],"rejectionReasons":[{}],"overrides":[{}],"cancellationReasons":[{}],"errorDetails":[{}],"description":"string","bulkTypeId":"string","creditOrDebitPayment":"string","singleOrmultiplePayments":"string","paymentMethod":"string","processingDate":"2024-01-01","requiredCreditValueDate":"2024-01-01","clearingDate":"2024-01-01","uploadId":"string","netAmount":0.0}},"responses":{"200":"BulkMasterPaymentResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/order/bulkPayments/{bulkTransferId}","fullPath":"/api/v3.0.0/order/bulkPayments/{bulkTransferId}","operationId":"getBulkPayment","name":"Enquire on uploaded or manually created bulk based on bulk ID","summary":"Enquire a bulk based on bulk ID","tags":[],"parameters":[{"name":"bulkTransferId","in":"path","type":"string","required":true,"description":"Identifier of the Bulk Transfer"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"BulkPaymentResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/order/bulkPayments/{bulkTransferId}","fullPath":"/api/v3.0.0/order/bulkPayments/{bulkTransferId}","operationId":"updateBulkPayment","name":"Perform update operation on uploaded or manually created bulk file based on bulk ID","summary":"Amend a bulk based on bulk ID","tags":[],"parameters":[{"name":"bulkTransferId","in":"path","type":"string","required":true,"description":"Identifier of the Bulk Transfer"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"signatories":[{}],"rejectionReasons":[{}],"overrides":[{}],"cancellationReasons":[{}],"errorDetails":[{}],"description":"string","bulkTypeId":"string","creditOrDebitPayment":"string","singleOrmultiplePayments":"string","paymentMethod":"string","processingDate":"2024-01-01","requiredCreditValueDate":"2024-01-01","clearingDate":"2024-01-01","uploadId":"string","netAmount":0.0}},"responses":{"200":"BulkPaymentResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"DELETE","path":"/order/bulkPayments/{bulkTransferId}","fullPath":"/api/v3.0.0/order/bulkPayments/{bulkTransferId}","operationId":"deleteBulkPayment","name":"Perform cancel operation on uploaded bulk file based on bulk ID","summary":"Cancel a bulk based on bulk ID","tags":[],"parameters":[{"name":"bulkTransferId","in":"path","type":"string","required":true,"description":"Identifier of the Bulk Transfer"},{"name":"payload","in":"body","type":"object","required":false,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}}},"responses":{"200":"BulkPaymentResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/order/bulkMasterApprovals/{bulkTransferId}","fullPath":"/api/v3.0.0/order/bulkMasterApprovals/{bulkTransferId}","operationId":"approveBulkPayment","name":"Authorise a bulk that was previously uploaded or manually created ","summary":"Authorise a bulk","tags":[],"parameters":[{"name":"bulkTransferId","in":"path","type":"string","required":true,"description":"Identifier of the Bulk Transfer"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"BulkPaymentResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/order/bulkPayments","fullPath":"/api/v3.0.0/order/bulkPayments","operationId":"getBulkPayments","name":"Retrieve bulks based on bulk status or bulk ID","summary":"Enquire a bulk payment","tags":[],"parameters":[{"name":"recordStatus","in":"query","type":"string","required":false,"description":"General status of the record. Possible values: - null - authorised - IHLD - input, on hold - INAU - input, not authorised - INA2 - input, authorised, pending second authorisation - INAO - input, not a"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"BulkPaymentsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/order/bulkPayments/status","fullPath":"/api/v3.0.0/order/bulkPayments/status","operationId":"getAllBulkPayments","name":"Retrieve bulks based on bulk status ","summary":"Enquire on bulk status","tags":[],"parameters":[{"name":"bulkTransferId","in":"query","type":"string","required":false,"description":"Identifier of the Bulk Transfer"},{"name":"bulkReference","in":"query","type":"string","required":false,"description":"Contains bulk master reference for the payment."},{"name":"fundsTransferId","in":"query","type":"string","required":false,"description":"Identifier of the Funds Transfer"},{"name":"customerId","in":"query","type":"string","required":false,"description":"Identifier of the customer"},{"name":"executionDate","in":"query","type":"string","required":false,"description":"Date on which the transaction or payment gets processed, i.e. the processing date of the transaction."},{"name":"amount","in":"query","type":"string","required":false,"description":"This is the payment amount"},{"name":"totalAmount","in":"query","type":"string","required":false,"description":"Total amount"},{"name":"currency","in":"query","type":"string","required":false,"description":"Identifies the currency. E.g. USD, GBP etc"},{"name":"debitAccount","in":"query","type":"string","required":true,"description":" Identifier of the debitAccounts."},{"name":"creditOrDebitPayment","in":"query","type":"string","required":false,"description":"Indicates whether the Bulk processing is for Credit or Debit Payments. Allowed values are DEBIT, CREDIT."},{"name":"paymentSource","in":"query","type":"string","required":false,"description":"Indicates the source from where the payment is originated"},{"name":"bulkTypeId","in":"query","type":"string","required":false,"description":"Identifier of the bulk update type record that holds default conditions required for Bulk Master creation. SINGLE and MULTI are two record references used by payment order application for processing p"},{"name":"singleOrmultiplePayments","in":"query","type":"string","required":false,"description":"Indicates the batch booking preference of the bulk payment. SINGLE \u00e2\u20ac\u201c Single consolidated accounting entry on the debtor account. MULTI \u00e2\u20ac\u201c Individual postings per each credit entry"},{"name":"statusCode","in":"query","type":"string","required":false,"description":"Status code, as defined by the institution"},{"name":"fileSendersReference","in":"query","type":"string","required":false,"description":"Indicates the sender reference that comes from the inward payment file"},{"name":"requiredCreditValueDate","in":"query","type":"string","required":false,"description":"The credit value date i.e. tentative date on which the payment system will process the payment"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"AllBulkPaymentsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}}]},{"key":"order-bulkpayments-service-v3.1.0","title":"Bulk Payment Initiation","version":"v3.1.0","description":"Bulk Initiation (BU) is a Temenos Payments Application that allows bank to upload small and medium sized bulk payment files, or manually capture bulk payments in its front office or back offices. The Application can be accessed by online channel applications by the APIs listed in this page to upload","endpointCount":13,"endpoints":[{"method":"GET","path":"/order/bulkPayments/uploads/files","fullPath":"/api/v3.1.0/order/bulkPayments/uploads/files","operationId":"getUploadFiles","name":"Enquire on uploaded bulk file","summary":"Enquire on uploaded bulk file","tags":[],"parameters":[{"name":"systemFileName","in":"query","type":"string","required":false,"description":"Contains the system generated name for the uploaded file"},{"name":"uploadId","in":"query","type":"string","required":false,"description":"The unique identifier of the uploaded file"},{"name":"userSignOnName","in":"query","type":"string","required":false,"description":"This is the name entered by the User to sign on to the System. It is used by the System as an alternative key to access User details"},{"name":"lastUpdateDate","in":"query","type":"string","required":false,"description":"Specifies the date of last update to the record."},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"UploadFilesResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"POST","path":"/order/bulkPayments/uploads/files","fullPath":"/api/v3.1.0/order/bulkPayments/uploads/files","operationId":"uploadFile","name":"Upload a SME/Corporate bulk file containing bulk payments using a channel","summary":"Upload bulk payment file","tags":[],"parameters":[{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"displayName":"string","systemFileName":"string","fileName":"string","uploadTypeId":"string","status":"string","uploadSize":"string","companyId":"string","extensionData":{}}},"responses":{"200":"FileResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/order/bulkPayments/uploads/{uploadId}","fullPath":"/api/v3.1.0/order/bulkPayments/uploads/{uploadId}","operationId":"getUploadFile","name":"Enquire on uploaded bulk file based on upload reference","summary":"Enquire a bulk based on upload reference","tags":[],"parameters":[{"name":"uploadId","in":"path","type":"string","required":true,"description":"The unique identifier of the uploaded file"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"UploadFileResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/order/bulkPayments/uploads/{uploadId}","fullPath":"/api/v3.1.0/order/bulkPayments/uploads/{uploadId}","operationId":"updateUploadFile","name":"Perform update operation on uploaded bulk file based on upload reference","summary":"Amend a bulk based on upload reference","tags":[],"parameters":[{"name":"uploadId","in":"path","type":"string","required":true,"description":"The unique identifier of the uploaded file"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"displayName":"string","systemFileName":"string","fileName":"string","uploadTypeId":"string","status":"string","uploadSize":"string","companyId":"string","extensionData":{}}},"responses":{"200":"UploadFileResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"DELETE","path":"/order/bulkPayments/uploads/{uploadId}","fullPath":"/api/v3.1.0/order/bulkPayments/uploads/{uploadId}","operationId":"deleteUploadFile","name":"Perform cancel operation on uploaded bulk file based on upload reference","summary":"Cancel a bulk based on upload reference","tags":[],"parameters":[{"name":"uploadId","in":"path","type":"string","required":true,"description":"The unique identifier of the uploaded file"},{"name":"payload","in":"body","type":"object","required":false,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}}},"responses":{"200":"UploadFileResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"POST","path":"/order/order/bulkPayments","fullPath":"/api/v3.1.0/order/order/bulkPayments","operationId":"uploadBulkMasterPayment","name":"Create bulk payment manually","summary":"Create manual bulk payment","tags":[],"parameters":[{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"signatories":[{}],"rejectionReasons":[{}],"overrides":[{}],"cancellationReasons":[{}],"errorDetails":[{}],"description":"string","bulkTypeId":"string","creditOrDebitPayment":"string","singleOrmultiplePayments":"string","paymentMethod":"string","processingDate":"2024-01-01","requiredCreditValueDate":"2024-01-01","clearingDate":"2024-01-01","uploadId":"string","netAmount":0.0}},"responses":{"200":"BulkMasterPaymentResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/order/bulkPayments/{bulkTransferId}","fullPath":"/api/v3.1.0/order/bulkPayments/{bulkTransferId}","operationId":"getBulkPayment","name":"Enquire on uploaded or manually created bulk based on bulk ID","summary":"Enquire a bulk based on bulk ID","tags":[],"parameters":[{"name":"bulkTransferId","in":"path","type":"string","required":true,"description":"Identifier of the Bulk Transfer"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"BulkPaymentResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/order/bulkPayments/{bulkTransferId}","fullPath":"/api/v3.1.0/order/bulkPayments/{bulkTransferId}","operationId":"updateBulkPayment","name":"Perform update operation on uploaded or manually created bulk file based on bulk ID","summary":"Amend a bulk based on bulk ID","tags":[],"parameters":[{"name":"bulkTransferId","in":"path","type":"string","required":true,"description":"Identifier of the Bulk Transfer"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"signatories":[{}],"rejectionReasons":[{}],"overrides":[{}],"cancellationReasons":[{}],"errorDetails":[{}],"description":"string","bulkTypeId":"string","creditOrDebitPayment":"string","singleOrmultiplePayments":"string","paymentMethod":"string","processingDate":"2024-01-01","requiredCreditValueDate":"2024-01-01","clearingDate":"2024-01-01","uploadId":"string","netAmount":0.0}},"responses":{"200":"BulkPaymentResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"DELETE","path":"/order/bulkPayments/{bulkTransferId}","fullPath":"/api/v3.1.0/order/bulkPayments/{bulkTransferId}","operationId":"deleteBulkPayment","name":"Perform cancel operation on uploaded bulk file based on bulk ID","summary":"Cancel a bulk based on bulk ID","tags":[],"parameters":[{"name":"bulkTransferId","in":"path","type":"string","required":true,"description":"Identifier of the Bulk Transfer"},{"name":"payload","in":"body","type":"object","required":false,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}}},"responses":{"200":"BulkPaymentResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/order/bulkMasterApprovals/{bulkTransferId}","fullPath":"/api/v3.1.0/order/bulkMasterApprovals/{bulkTransferId}","operationId":"approveBulkPayment","name":"Authorise a bulk that was previously uploaded or manually created ","summary":"Authorise a bulk","tags":[],"parameters":[{"name":"bulkTransferId","in":"path","type":"string","required":true,"description":"Identifier of the Bulk Transfer"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"BulkPaymentResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/order/bulkPayments","fullPath":"/api/v3.1.0/order/bulkPayments","operationId":"getBulkPayments","name":"Retrieve bulks based on bulk status or bulk ID","summary":"Enquire a bulk payment","tags":[],"parameters":[{"name":"recordStatus","in":"query","type":"string","required":false,"description":"General status of the record. Possible values: - null - authorised - IHLD - input, on hold - INAU - input, not authorised - INA2 - input, authorised, pending second authorisation - INAO - input, not a"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"BulkPaymentsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"POST","path":"/order/bulkPayments","fullPath":"/api/v3.1.0/order/bulkPayments","operationId":"createBulkPayment","name":"Create bulk payment manually","summary":"Create manual bulk payment","tags":[],"parameters":[{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"signatories":[{}],"rejectionReasons":[{}],"overrides":[{}],"cancellationReasons":[{}],"errorDetails":[{}],"description":"string","bulkTypeId":"string","creditOrDebitPayment":"string","singleOrmultiplePayments":"string","paymentMethod":"string","processingDate":"2024-01-01","requiredCreditValueDate":"2024-01-01","clearingDate":"2024-01-01","uploadId":"string","netAmount":0.0}},"responses":{"200":"BulkPaymentResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/order/bulkPayments/status","fullPath":"/api/v3.1.0/order/bulkPayments/status","operationId":"getAllBulkPayments","name":"Retrieve bulks based on bulk status ","summary":"Enquire on bulk status","tags":[],"parameters":[{"name":"bulkTransferId","in":"query","type":"string","required":false,"description":"Identifier of the Bulk Transfer"},{"name":"bulkReference","in":"query","type":"string","required":false,"description":"Contains bulk master reference for the payment."},{"name":"fundsTransferId","in":"query","type":"string","required":false,"description":"Identifier of the Funds Transfer"},{"name":"customerId","in":"query","type":"string","required":false,"description":"Identifier of the customer"},{"name":"executionDate","in":"query","type":"string","required":false,"description":"Date on which the transaction or payment gets processed, i.e. the processing date of the transaction."},{"name":"amount","in":"query","type":"string","required":false,"description":"This is the payment amount"},{"name":"totalAmount","in":"query","type":"string","required":false,"description":"Total amount"},{"name":"currency","in":"query","type":"string","required":false,"description":"Identifies the currency. E.g. USD, GBP etc"},{"name":"debitAccount","in":"query","type":"string","required":true,"description":" Identifier of the debitAccounts."},{"name":"creditOrDebitPayment","in":"query","type":"string","required":false,"description":"Indicates whether the Bulk processing is for Credit or Debit Payments. Allowed values are DEBIT, CREDIT."},{"name":"paymentSource","in":"query","type":"string","required":false,"description":"Indicates the source from where the payment is originated"},{"name":"bulkTypeId","in":"query","type":"string","required":false,"description":"Identifier of the bulk update type record that holds default conditions required for Bulk Master creation. SINGLE and MULTI are two record references used by payment order application for processing p"},{"name":"singleOrmultiplePayments","in":"query","type":"string","required":false,"description":"Indicates the batch booking preference of the bulk payment. SINGLE \u00e2\u20ac\u201c Single consolidated accounting entry on the debtor account. MULTI \u00e2\u20ac\u201c Individual postings per each credit entry"},{"name":"statusCode","in":"query","type":"string","required":false,"description":"Status code, as defined by the institution"},{"name":"fileSendersReference","in":"query","type":"string","required":false,"description":"Indicates the sender reference that comes from the inward payment file"},{"name":"requiredCreditValueDate","in":"query","type":"string","required":false,"description":"The credit value date i.e. tentative date on which the payment system will process the payment"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"AllBulkPaymentsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}}]},{"key":"order-bulkpayments-service-v3.2.0","title":"Bulk Payment Initiation","version":"v3.2.0","description":"Bulk Initiation (BU) is a Temenos Payments Application that allows bank to upload small and medium sized bulk payment files, or manually capture bulk payments in its front office or back offices. The Application can be accessed by online channel applications by the APIs listed in this page to upload","endpointCount":13,"endpoints":[{"method":"GET","path":"/order/bulkPayments/uploads/files","fullPath":"/api/v3.2.0/order/bulkPayments/uploads/files","operationId":"getUploadFiles","name":"Enquire on uploaded bulk file","summary":"Enquire on uploaded bulk file","tags":[],"parameters":[{"name":"systemFileName","in":"query","type":"string","required":false,"description":"Contains the system generated name for the uploaded file"},{"name":"uploadId","in":"query","type":"string","required":false,"description":"The unique identifier of the uploaded file"},{"name":"userSignOnName","in":"query","type":"string","required":false,"description":"This is the name entered by the User to sign on to the System. It is used by the System as an alternative key to access User details"},{"name":"lastUpdateDate","in":"query","type":"string","required":false,"description":"Specifies the date of last update to the record."},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"UploadFilesResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"POST","path":"/order/bulkPayments/uploads/files","fullPath":"/api/v3.2.0/order/bulkPayments/uploads/files","operationId":"uploadFile","name":"Upload a SME/Corporate bulk file containing bulk payments using a channel","summary":"Upload bulk payment file","tags":[],"parameters":[{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"displayName":"string","systemFileName":"string","fileName":"string","uploadTypeId":"string","status":"string","uploadSize":"string","companyId":"string","extensionData":{}}},"responses":{"200":"FileResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/order/bulkPayments/uploads/{uploadId}","fullPath":"/api/v3.2.0/order/bulkPayments/uploads/{uploadId}","operationId":"getUploadFile","name":"Enquire on uploaded bulk file based on upload reference","summary":"Enquire a bulk based on upload reference","tags":[],"parameters":[{"name":"uploadId","in":"path","type":"string","required":true,"description":"The unique identifier of the uploaded file"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"UploadFileResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/order/bulkPayments/uploads/{uploadId}","fullPath":"/api/v3.2.0/order/bulkPayments/uploads/{uploadId}","operationId":"updateUploadFile","name":"Perform update operation on uploaded bulk file based on upload reference","summary":"Amend a bulk based on upload reference","tags":[],"parameters":[{"name":"uploadId","in":"path","type":"string","required":true,"description":"The unique identifier of the uploaded file"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"displayName":"string","systemFileName":"string","fileName":"string","uploadTypeId":"string","status":"string","uploadSize":"string","companyId":"string","extensionData":{}}},"responses":{"200":"UploadFileResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"DELETE","path":"/order/bulkPayments/uploads/{uploadId}","fullPath":"/api/v3.2.0/order/bulkPayments/uploads/{uploadId}","operationId":"deleteUploadFile","name":"Perform cancel operation on uploaded bulk file based on upload reference","summary":"Cancel a bulk based on upload reference","tags":[],"parameters":[{"name":"uploadId","in":"path","type":"string","required":true,"description":"The unique identifier of the uploaded file"},{"name":"payload","in":"body","type":"object","required":false,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}}},"responses":{"200":"UploadFileResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"POST","path":"/order/order/bulkPayments","fullPath":"/api/v3.2.0/order/order/bulkPayments","operationId":"uploadBulkMasterPayment","name":"Create bulk payment manually","summary":"Create manual bulk payment","tags":[],"parameters":[{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"signatories":[{}],"rejectionReasons":[{}],"overrides":[{}],"cancellationReasons":[{}],"errorDetails":[{}],"description":"string","bulkTypeId":"string","creditOrDebitPayment":"string","singleOrmultiplePayments":"string","paymentMethod":"string","processingDate":"2024-01-01","requiredCreditValueDate":"2024-01-01","clearingDate":"2024-01-01","uploadId":"string","netAmount":0.0}},"responses":{"200":"BulkMasterPaymentResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/order/bulkPayments/{bulkTransferId}","fullPath":"/api/v3.2.0/order/bulkPayments/{bulkTransferId}","operationId":"getBulkPayment","name":"Enquire on uploaded or manually created bulk based on bulk ID","summary":"Enquire a bulk based on bulk ID","tags":[],"parameters":[{"name":"bulkTransferId","in":"path","type":"string","required":true,"description":"Identifier of the Bulk Transfer"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"BulkPaymentResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/order/bulkPayments/{bulkTransferId}","fullPath":"/api/v3.2.0/order/bulkPayments/{bulkTransferId}","operationId":"updateBulkPayment","name":"Perform update operation on uploaded or manually created bulk file based on bulk ID","summary":"Amend a bulk based on bulk ID","tags":[],"parameters":[{"name":"bulkTransferId","in":"path","type":"string","required":true,"description":"Identifier of the Bulk Transfer"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"signatories":[{}],"rejectionReasons":[{}],"overrides":[{}],"cancellationReasons":[{}],"errorDetails":[{}],"description":"string","bulkTypeId":"string","creditOrDebitPayment":"string","singleOrmultiplePayments":"string","paymentMethod":"string","processingDate":"2024-01-01","requiredCreditValueDate":"2024-01-01","clearingDate":"2024-01-01","uploadId":"string","netAmount":0.0}},"responses":{"200":"BulkPaymentResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"DELETE","path":"/order/bulkPayments/{bulkTransferId}","fullPath":"/api/v3.2.0/order/bulkPayments/{bulkTransferId}","operationId":"deleteBulkPayment","name":"Perform cancel operation on uploaded bulk file based on bulk ID","summary":"Cancel a bulk based on bulk ID","tags":[],"parameters":[{"name":"bulkTransferId","in":"path","type":"string","required":true,"description":"Identifier of the Bulk Transfer"},{"name":"payload","in":"body","type":"object","required":false,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}}},"responses":{"200":"BulkPaymentResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/order/bulkMasterApprovals/{bulkTransferId}","fullPath":"/api/v3.2.0/order/bulkMasterApprovals/{bulkTransferId}","operationId":"approveBulkPayment","name":"Authorise a bulk that was previously uploaded or manually created ","summary":"Authorise a bulk","tags":[],"parameters":[{"name":"bulkTransferId","in":"path","type":"string","required":true,"description":"Identifier of the Bulk Transfer"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"BulkPaymentResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/order/bulkPayments","fullPath":"/api/v3.2.0/order/bulkPayments","operationId":"getBulkPayments","name":"Retrieve bulks based on bulk status or bulk ID","summary":"Enquire a bulk payment","tags":[],"parameters":[{"name":"recordStatus","in":"query","type":"string","required":false,"description":"General status of the record. Possible values: - null - authorised - IHLD - input, on hold - INAU - input, not authorised - INA2 - input, authorised, pending second authorisation - INAO - input, not a"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"BulkPaymentsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"POST","path":"/order/bulkPayments","fullPath":"/api/v3.2.0/order/bulkPayments","operationId":"createBulkPayment","name":"Create bulk payment manually","summary":"Create manual bulk payment","tags":[],"parameters":[{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"signatories":[{}],"rejectionReasons":[{}],"overrides":[{}],"cancellationReasons":[{}],"errorDetails":[{}],"description":"string","bulkTypeId":"string","creditOrDebitPayment":"string","singleOrmultiplePayments":"string","paymentMethod":"string","processingDate":"2024-01-01","requiredCreditValueDate":"2024-01-01","clearingDate":"2024-01-01","uploadId":"string","netAmount":0.0}},"responses":{"200":"BulkPaymentResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/order/bulkPayments/status","fullPath":"/api/v3.2.0/order/bulkPayments/status","operationId":"getAllBulkPayments","name":"Retrieve bulks based on bulk status ","summary":"Enquire on bulk status","tags":[],"parameters":[{"name":"bulkTransferId","in":"query","type":"string","required":false,"description":"Identifier of the Bulk Transfer"},{"name":"bulkReference","in":"query","type":"string","required":false,"description":"Contains bulk master reference for the payment."},{"name":"fundsTransferId","in":"query","type":"string","required":false,"description":"Identifier of the Funds Transfer"},{"name":"customerId","in":"query","type":"string","required":false,"description":"Identifier of the customer"},{"name":"executionDate","in":"query","type":"string","required":false,"description":"Date on which the transaction or payment gets processed, i.e. the processing date of the transaction."},{"name":"amount","in":"query","type":"string","required":false,"description":"This is the payment amount"},{"name":"totalAmount","in":"query","type":"string","required":false,"description":"Total amount"},{"name":"currency","in":"query","type":"string","required":false,"description":"Identifies the currency. E.g. USD, GBP etc"},{"name":"debitAccount","in":"query","type":"string","required":true,"description":" Identifier of the debitAccounts."},{"name":"creditOrDebitPayment","in":"query","type":"string","required":false,"description":"Indicates whether the Bulk processing is for Credit or Debit Payments. Allowed values are DEBIT, CREDIT."},{"name":"paymentSource","in":"query","type":"string","required":false,"description":"Indicates the source from where the payment is originated"},{"name":"bulkTypeId","in":"query","type":"string","required":false,"description":"Identifier of the bulk update type record that holds default conditions required for Bulk Master creation. SINGLE and MULTI are two record references used by payment order application for processing p"},{"name":"singleOrmultiplePayments","in":"query","type":"string","required":false,"description":"Indicates the batch booking preference of the bulk payment. SINGLE \u00e2\u20ac\u201c Single consolidated accounting entry on the debtor account. MULTI \u00e2\u20ac\u201c Individual postings per each credit entry"},{"name":"statusCode","in":"query","type":"string","required":false,"description":"Status code, as defined by the institution"},{"name":"fileSendersReference","in":"query","type":"string","required":false,"description":"Indicates the sender reference that comes from the inward payment file"},{"name":"requiredCreditValueDate","in":"query","type":"string","required":false,"description":"The credit value date i.e. tentative date on which the payment system will process the payment"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"AllBulkPaymentsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}}]},{"key":"order-ca-Payment-service-v1.0.0","title":"Payment management","version":"v1.0.0","description":"Canadian region APIs to create, update and retrieve external payments, payment orders and recurring order instructions for payments","endpointCount":7,"endpoints":[{"method":"POST","path":"/order/ca/standingOrders/{standingOrderID}/externalAccounts","fullPath":"/api/v1.0.0/order/ca/standingOrders/{standingOrderID}/externalAccounts","operationId":"createCaStandingOrderExternalAccounts","name":"Create standing order for the external accounts with the details such as date, currency, settlement instruction, amount, status etc. Debit or credit beneficiary should be an external party.","summary":"Create standing order for external accounts","tags":["RETAIL"],"parameters":[{"name":"standingOrderID","in":"path","type":"string","required":true,"description":"The unique standing order identifier"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"beneficiaryDetails":[{}],"Payer":[{}],"description":"string","paymentIndicator":"DR","customerId":0.0,"beneficiaryId":"string","status":"string","createDate":"2024-01-01","standAloneDdi":"YES","standaloneAmount":0.0,"valueDate":"2024-01-01","frequency":"string","paymentPurposeCode":"string","applicationId":"string","beneficiaryInstituteRoutingNo":"string"}},"responses":{"200":"CaStandingOrderExternalAccountsResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/order/ca/standingOrders/{standingOrderID}/externalAccounts","fullPath":"/api/v1.0.0/order/ca/standingOrders/{standingOrderID}/externalAccounts","operationId":"updateCaStandingOrderExternalAccounts","name":"Update standing order for the external accounts with the details such as date, currency, settlement instruction, amount, status etc. Debit or credit beneficiary should be an external party.","summary":"Update standing order for external accounts","tags":["RETAIL"],"parameters":[{"name":"standingOrderID","in":"path","type":"string","required":true,"description":"The unique standing order identifier"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"beneficiaryDetails":[{}],"Payer":[{}],"description":"string","paymentIndicator":"DR","customerId":0.0,"beneficiaryId":"string","status":"string","createDate":"2024-01-01","standAloneDdi":"YES","standaloneAmount":0.0,"valueDate":"2024-01-01","frequency":"string","paymentPurposeCode":"string","applicationId":"string","beneficiaryInstituteRoutingNo":"string"}},"responses":{"200":"CaStandingOrderExternalAccountsResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/order/ca/standingOrders/externalAccounts","fullPath":"/api/v1.0.0/order/ca/standingOrders/externalAccounts","operationId":"getCaStandingOrderExternalAccounts","name":"Retrieve standing order for the external accounts such as date, currency, settlement instruction, amount, status etc. ","summary":"Retrieve the standing order for external accounts","tags":["RETAIL"],"parameters":[{"name":"accountId","in":"query","type":"string","required":false,"description":"Identifier of the account. Often referred to as the account number, yet for consistency this is always referred to as accountId. Accepts both IBAN & BBAN"},{"name":"customerId","in":"query","type":"string","required":false,"description":"Identifier of the customer"},{"name":"ownAccount","in":"query","type":"string","required":false,"description":"Indicates the transfer of funds between accounts of same member"},{"name":"status","in":"query","type":"string","required":false,"description":"The status of the early maturity request"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"CaStandingOrderExternalAccountsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"POST","path":"/order/ca/payments/instructions/{instructionId}/standingOrders","fullPath":"/api/v1.0.0/order/ca/payments/instructions/{instructionId}/standingOrders","operationId":"createCaRecurringPaymentInstruction","name":"Create recurring payments instructions with details such as customer, settlement account number, frequency, amount, start date, end date, etc. Details in the Transact is defined for information & not accounting","summary":"Create recurring payments instructions","tags":["RETAIL"],"parameters":[{"name":"instructionId","in":"path","type":"string","required":true,"description":"Id of the Transaction Stop instruction against which the transaction has been matched."},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"customerId":0.0,"customerName":"string","initiator":"string","uniqueTransactionReference":"string","startDate":"2024-01-01","amount":0.0,"currentFrequency":"string","currentEndDate":"2024-01-01","numberOfRecurringPayments":"string","paymentDetail":"string","paymentIndicator":"DEBIT","defaultSettlementAccount":"string","routingNumber":"string","status":"LIVE","cancelDate":"2024-01-01"}},"responses":{"200":"CaRecurringPaymentInstructionResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/order/ca/payments/instructions/{instructionId}/standingOrders","fullPath":"/api/v1.0.0/order/ca/payments/instructions/{instructionId}/standingOrders","operationId":"updateCaRecurringPaymentInstruction","name":"Update recurring payments instructions with details such as next payment date, retry count , status etc","summary":"Update recurring payments instructions","tags":["RETAIL"],"parameters":[{"name":"instructionId","in":"path","type":"string","required":true,"description":"Id of the Transaction Stop instruction against which the transaction has been matched."},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"customerId":0.0,"customerName":"string","initiator":"string","uniqueTransactionReference":"string","startDate":"2024-01-01","amount":0.0,"currentFrequency":"string","currentEndDate":"2024-01-01","numberOfRecurringPayments":"string","paymentDetail":"string","paymentIndicator":"DEBIT","defaultSettlementAccount":"string","routingNumber":"string","status":"LIVE","cancelDate":"2024-01-01"}},"responses":{"200":"CaRecurringPaymentInstructionResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/order/ca/payments/instructions/standingOrders","fullPath":"/api/v1.0.0/order/ca/payments/instructions/standingOrders","operationId":"getCaRecurringPaymentInstruction","name":"Retrieves the recurring payments instructions with details such as customer, account number, settlement account, next payment date, retry count , status etc based on instruction id, originator reference, template id and booking date. Any one selection is mandatory.","summary":"Retrieves the recurring payments instructions","tags":["RETAIL"],"parameters":[{"name":"instructionId","in":"query","type":"string","required":false,"description":"Id of the Transaction Stop instruction against which the transaction has been matched."},{"name":"initiator","in":"query","type":"string","required":false,"description":"Initiator details of the payment"},{"name":"uniqueTransactionReference","in":"query","type":"string","required":false,"description":"Unique transaction reference details"},{"name":"bookingDate","in":"query","type":"string","required":false,"description":"Contains the date on which the statement entry is created"},{"name":"status","in":"query","type":"string","required":false,"description":"The status of the early maturity request"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"CaRecurringPaymentInstructionResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"POST","path":"/order/ca/paymentOrders/","fullPath":"/api/v1.0.0/order/ca/paymentOrders/","operationId":"createCaPaymentOrder","name":"Create payments order for both EFT (Electronic Funds Transfer) and CQ (Clearing Cheque) payments","summary":"Create payment order","tags":["RETAIL"],"parameters":[{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"narratives":[{}],"additionalInformations":[{}],"remittanceInformations":[{}],"beneficiaryAddresses":[{}],"signatories":[{}],"invoiceReferences":[{}],"charges":[{}],"overrides":[{}],"reasons":[{}],"accountWithInstitutionAddresses":[{}],"orderingPostAddrLine":[{}],"contextNames":[{}],"contextValues":[{}],"messageType":[{}],"payeeName":"string"}},"responses":{"200":"CaPaymentOrderResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}}]},{"key":"order-ca-billPayment-service-v1.0.0","title":"Bill payments","version":"v1.0.0","description":"API to create current/future/recurring bill payments and update/cancel bill payments for a payee. Retrieves the bill payments for given payer","endpointCount":5,"endpoints":[{"method":"POST","path":"/order/ca/billPayments","fullPath":"/api/v1.0.0/order/ca/billPayments","operationId":"createCaBillPayment","name":"Create current or future bill payment for a payee i.e vendor","summary":"Create bill payment for a payee i.e vendor","tags":["RETAIL"],"parameters":[{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"customer":"string","accountId":"string","payee":"string","toAccountId":"string","effectiveDate":"string","amount":"string","externalReference":"string","paymentStatus":"string","extensions":{}}},"responses":{"200":"CaBillPaymentResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/order/ca/billPayments/{billPaymentId}/cancellations","fullPath":"/api/v1.0.0/order/ca/billPayments/{billPaymentId}/cancellations","operationId":"cancelCaBillPayment","name":"Cancels bill payment for a payee i.e vendor for the given bill payment reference. Bill payment reference can be the exact payment reference or the external confirmation number.","summary":"Cancels bill payment for a payee i.e vendor","tags":["RETAIL"],"parameters":[{"name":"billPaymentId","in":"path","type":"string","required":true,"description":""},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"customer":"string","payee":"string","toAccountId":"string","effectiveDate":"string","amount":"string","externalReference":"string","extensions":{}}},"responses":{"200":"CaBillPaymentResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"POST","path":"/order/ca/billPayments/standingOrders","fullPath":"/api/v1.0.0/order/ca/billPayments/standingOrders","operationId":"createCaBillPaymentStandingOrder","name":"Create recurring bill payment for a payee with details such as payer, payer account number, frequency, amount, start date and end date","summary":"Create recurring bill payment for a payee","tags":["RETAIL"],"parameters":[{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"customer":"string","accountId":"string","payee":"string","toAccountId":"string","amount":"string","paymentFrequency":"string","endDate":"string","numberOfPayments":"string","cancelDate":"string","retry":"string","numberOfRetries":"string","extensions":{}}},"responses":{"200":"CaBillPaymentStandingOrderResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/order/ca/billPayments/standingOrders/{standingOrderId}/cancellations","fullPath":"/api/v1.0.0/order/ca/billPayments/standingOrders/{standingOrderId}/cancellations","operationId":"updateCaBillPaymentStandingOrder","name":"Updates the recurring bill payment with details such as frequency and amount . Also the payment can be cancelled by supplying current date as end date.","summary":"Updates or cancels the recurring bill payment","tags":["RETAIL"],"parameters":[{"name":"standingOrderId","in":"path","type":"string","required":true,"description":""},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"customer":"string","accountId":"string","payee":"string","toAccountId":"string","amount":"string","paymentFrequency":"string","endDate":"string","numberOfPayments":"string","cancelDate":"string","retry":"string","numberOfRetries":"string","extensions":{}}},"responses":{"200":"CaBillPaymentStandingOrderResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/order/ca/billPayments/customers/{customerId}","fullPath":"/api/v1.0.0/order/ca/billPayments/customers/{customerId}","operationId":"getCaCustomerBillPayment","name":"Retrieves the bill payments for a given customer with details such as customer, account number, payee, payer account number, frequency, date, amount, end date, external reference and payment id","summary":"Retrieves the bill payments for a given customer","tags":["RETAIL"],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"Identifier of the customer"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"CaCustomerBillPaymentResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}}]},{"key":"order-ca-billPayment-service-v1.1.0","title":"Bill payments","version":"v1.1.0","description":"API to create current/future/recurring bill payments and update/cancel bill payments for a payee. Retrieves the bill payments for given payer","endpointCount":5,"endpoints":[{"method":"POST","path":"/order/ca/billPayments","fullPath":"/api/v1.1.0/order/ca/billPayments","operationId":"createCaBillPayment","name":"Create current or future bill payment for a payee i.e vendor","summary":"Create bill payment for a payee i.e vendor","tags":["RETAIL"],"parameters":[{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"customer":"string","accountId":"string","payee":"string","toAccountId":"string","effectiveDate":"string","amount":"string","externalReference":"string","paymentStatus":"string","extensions":{}}},"responses":{"200":"CaBillPaymentResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/order/ca/billPayments/{billPaymentId}/cancellations","fullPath":"/api/v1.1.0/order/ca/billPayments/{billPaymentId}/cancellations","operationId":"cancelCaBillPayment","name":"Cancels bill payment for a payee i.e vendor for the given bill payment reference. Bill payment reference can be the exact payment reference or the external confirmation number.","summary":"Cancels bill payment for a payee i.e vendor","tags":["RETAIL"],"parameters":[{"name":"billPaymentId","in":"path","type":"string","required":true,"description":""},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"customer":"string","payee":"string","toAccountId":"string","effectiveDate":"string","amount":"string","externalReference":"string","extensions":{}}},"responses":{"200":"CaBillPaymentResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"POST","path":"/order/ca/billPayments/standingOrders","fullPath":"/api/v1.1.0/order/ca/billPayments/standingOrders","operationId":"createCaBillPaymentStandingOrder","name":"Create recurring bill payment for a payee with details such as payer, payer account number, frequency, amount, start date and end date","summary":"Create recurring bill payment for a payee","tags":["RETAIL"],"parameters":[{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"customer":"string","accountId":"string","payee":"string","toAccountId":"string","amount":"string","paymentFrequency":"string","endDate":"string","numberOfPayments":"string","cancelDate":"string","retry":"string","numberOfRetries":"string","extensions":{}}},"responses":{"200":"CaBillPaymentStandingOrderResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/order/ca/billPayments/standingOrders/{standingOrderId}/cancellations","fullPath":"/api/v1.1.0/order/ca/billPayments/standingOrders/{standingOrderId}/cancellations","operationId":"updateCaBillPaymentStandingOrder","name":"Updates the recurring bill payment with details such as frequency and amount . Also the payment can be cancelled by supplying current date as end date.","summary":"Updates or cancels the recurring bill payment","tags":["RETAIL"],"parameters":[{"name":"standingOrderId","in":"path","type":"string","required":true,"description":""},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"customer":"string","accountId":"string","payee":"string","toAccountId":"string","amount":"string","paymentFrequency":"string","endDate":"string","numberOfPayments":"string","cancelDate":"string","retry":"string","numberOfRetries":"string","extensions":{}}},"responses":{"200":"CaBillPaymentStandingOrderResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/order/ca/billPayments/customers/{customerId}","fullPath":"/api/v1.1.0/order/ca/billPayments/customers/{customerId}","operationId":"getCaCustomerBillPayment","name":"Retrieves the bill payments for a given customer with details such as customer, account number, payee, payer account number, frequency, date, amount, end date, external reference and payment id","summary":"Retrieves the bill payments for a given customer","tags":["RETAIL"],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"Identifier of the customer"},{"name":"transactionType","in":"query","type":"string","required":false,"description":"Identifies the transaction type applicable to the transaction being processed, i.e. outward or inward payment. For example: ACPX, OTPX etc."},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"CaCustomerBillPaymentResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}}]},{"key":"order-ca-regsiteredPlans-service-v1.0.0","title":"Registered plans","version":"v1.0.0","description":"Canadian reference APIs to retrieve the plan types, plan transaction codes, contributions, withdrawals and reversals","endpointCount":4,"endpoints":[{"method":"POST","path":"/order/ca/payments/registeredPlans/contributions","fullPath":"/api/v1.0.0/order/ca/payments/registeredPlans/contributions","operationId":"createCaRegisteredPlanContributions","name":"Create contribution towards registered plan products through online banking","summary":"Create contribution towards registered plan products","tags":["RETAIL"],"parameters":[{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"orderingCustomerIds":[{}],"orderingBanks":[{}],"accountWithBanks":[{}],"beneficiaryBanks":[{}],"beneficiaryNames":[{}],"beneficiaryAddresses":[{}],"beneficiaryAddressCities":[{}],"beneficiaryCustomerIds":[{}],"paymentDetails":[{}],"transactionCode":"string","transactionAmount":"string","transactionType":"string","debitAccountId":"string","debitCurrency":"string","debitAmount":0.0}},"responses":{"200":"CaRegisteredPlanContributionsResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"POST","path":"/order/ca/payments/registeredPlans/withdrawals","fullPath":"/api/v1.0.0/order/ca/payments/registeredPlans/withdrawals","operationId":"createCaRegisteredPlanWithdrawals","name":"Create withdrawal from registered plan product through online banking","summary":"Create withdrawal from registered plan product","tags":["RETAIL"],"parameters":[{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"orderingCustomerIds":[{}],"orderingBanks":[{}],"accountWithBanks":[{}],"beneficiaryBanks":[{}],"beneficiaryNames":[{}],"beneficiaryAddresses":[{}],"beneficiaryAddressCities":[{}],"beneficiaryCustomerIds":[{}],"paymentDetails":[{}],"transactionCode":"string","transactionAmount":"string","provinceTaxRate":"string","federalTaxRate":"string","nonResidenceTaxRate":"string","provinceTax":"string"}},"responses":{"200":"CaRegisteredPlanWithdrawalsResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"DELETE","path":"/order/ca/payments/registeredPlans/contributions/{contributionId}","fullPath":"/api/v1.0.0/order/ca/payments/registeredPlans/contributions/{contributionId}","operationId":"reverseCaRegisteredPlanContributions","name":"Cancellation of contribution from registered plan products through online banking","summary":"Cancellation of contribution from registered plan products","tags":["RETAIL"],"parameters":[{"name":"contributionId","in":"path","type":"string","required":true,"description":"Contains the contribution reference performed towards the registered plans"},{"name":"payload","in":"body","type":"object","required":false,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}}},"responses":{"200":"CaRegisteredPlanContributionsResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"DELETE","path":"/order/ca/payments/registeredPlans/withdrawals/{withdrawalId}","fullPath":"/api/v1.0.0/order/ca/payments/registeredPlans/withdrawals/{withdrawalId}","operationId":"reverseCaRegisteredPlanWithdrawals","name":"Cancellation of withdrawal from registered plan product through online banking","summary":"Cancellation withdrawal from registered plan product","tags":["RETAIL"],"parameters":[{"name":"withdrawalId","in":"path","type":"string","required":true,"description":"Contains the withdrawal reference performed towards the registered plans"},{"name":"payload","in":"body","type":"object","required":false,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}}},"responses":{"200":"CaRegisteredPlanWithdrawalsResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}}]},{"key":"order-ca-standingOrders-service-v1.0.0","title":"Standing Order Management","version":"v1.0.0","description":"API to perform create/update/cancel Standing order (recurring transfer) instructions","endpointCount":2,"endpoints":[{"method":"POST","path":"/order/ca/standingOrders/{standingOrderId}/registeredPlans/contributions","fullPath":"/api/v1.0.0/order/ca/standingOrders/{standingOrderId}/registeredPlans/contributions","operationId":"createCaStandingOrderContribution","name":"Create standing order instruction for periodic contributions through online banking","summary":"Create standing order instruction for periodic contributions.","tags":["RETAIL"],"parameters":[{"name":"standingOrderId","in":"path","type":"string","required":true,"description":"The unique standing order identifier"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"beneficiaryNames":[{}],"accountWithBanks":[{}],"displayNames":[{}],"beneficiaryBICNames":[{}],"overrides":[{}],"chargeCode":"string","paymentMethod":"string","currentFrequency":"string","currentEndDate":"2024-01-01","futureNotice":"string","counterPartyAccountId":"string","startDate":"2024-01-01","frequency":"string","beneficiaryAccountId":"string","beneficiaryId":"string"}},"responses":{"200":"CaStandingOrderContributionResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"DELETE","path":"/order/ca/standingOrders/{standingOrderId}/registeredPlans/contributions","fullPath":"/api/v1.0.0/order/ca/standingOrders/{standingOrderId}/registeredPlans/contributions","operationId":"reverseCaStandingOrderContribution","name":"Reverse standing order instruction for periodic contributions through online banking","summary":"Reverse standing order instruction for periodic contributions.","tags":["RETAIL"],"parameters":[{"name":"standingOrderId","in":"path","type":"string","required":true,"description":"The unique standing order identifier"},{"name":"payload","in":"body","type":"object","required":false,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}}},"responses":{"200":"CaStandingOrderContributionResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}}]},{"key":"order-ca-standingOrders-service-v1.1.0","title":"Standing Order Management","version":"v1.1.0","description":"API to perform create/update/cancel Standing order (recurring transfer) instructions","endpointCount":3,"endpoints":[{"method":"POST","path":"/order/ca/standingOrders/{standingOrderId}/registeredPlans/contributions","fullPath":"/api/v1.1.0/order/ca/standingOrders/{standingOrderId}/registeredPlans/contributions","operationId":"createCaStandingOrderContribution","name":"Create standing order instruction for periodic contributions through online banking","summary":"Create standing order instruction for periodic contributions.","tags":["RETAIL"],"parameters":[{"name":"standingOrderId","in":"path","type":"string","required":true,"description":"The unique standing order identifier"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"beneficiaryNames":[{}],"accountWithBanks":[{}],"displayNames":[{}],"beneficiaryBICNames":[{}],"overrides":[{}],"chargeCode":"string","paymentMethod":"string","currentFrequency":"string","currentEndDate":"2024-01-01","futureNotice":"string","counterPartyAccountId":"string","startDate":"2024-01-01","frequency":"string","beneficiaryAccountId":"string","beneficiaryId":"string"}},"responses":{"200":"CaStandingOrderContributionResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/order/ca/standingOrders/{standingOrderId}/registeredPlans/contributions","fullPath":"/api/v1.1.0/order/ca/standingOrders/{standingOrderId}/registeredPlans/contributions","operationId":"updateCaStandingOrderContribution","name":"Update standing order instruction for periodic contributions.","summary":"Update standing order instruction for periodic contributions.","tags":["RETAIL"],"parameters":[{"name":"standingOrderId","in":"path","type":"string","required":true,"description":"The unique standing order identifier"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"beneficiaryNames":[{}],"accountWithBanks":[{}],"displayNames":[{}],"beneficiaryBICNames":[{}],"overrides":[{}],"chargeCode":"string","paymentMethod":"string","currentFrequency":"string","currentEndDate":"2024-01-01","futureNotice":"string","counterPartyAccountId":"string","startDate":"2024-01-01","frequency":"string","beneficiaryAccountId":"string","beneficiaryId":"string"}},"responses":{"200":"CaStandingOrderContributionResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"DELETE","path":"/order/ca/standingOrders/{standingOrderId}/registeredPlans/contributions","fullPath":"/api/v1.1.0/order/ca/standingOrders/{standingOrderId}/registeredPlans/contributions","operationId":"reverseCaStandingOrderContribution","name":"Reverse standing order instruction for periodic contributions through online banking","summary":"Reverse standing order instruction for periodic contributions.","tags":["RETAIL"],"parameters":[{"name":"standingOrderId","in":"path","type":"string","required":true,"description":"The unique standing order identifier"},{"name":"payload","in":"body","type":"object","required":false,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}}},"responses":{"200":"CaStandingOrderContributionResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}}]},{"key":"order-cancellationsweeps-v1.0.0","title":"Order Cancellation Sweeps Deprecated","version":"v1.0.0","description":"Details of Reversed Sweep","endpointCount":1,"endpoints":[{"method":"GET","path":"/order/sweeps/cancellations","fullPath":"/api/v1.0.0/order/sweeps/cancellations","operationId":"getSweepCancellations","name":"Retrieves the list of cancelled sweeps - Deprecated. order-sweeps-service-v1.0.1 instead","summary":"Retrieves cancelled sweeps","tags":[],"parameters":[{"name":"sweepId","in":"query","type":"string","required":false,"description":"Identifier of the Retail account sweep"},{"name":"creditAccountId","in":"query","type":"string","required":false,"description":"Credit account identifier of the payment or transaction"},{"name":"debitAccountId","in":"query","type":"string","required":false,"description":"Indicates the debit account number of the payment or transaction."},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"SweepCancellationsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}}]},{"key":"order-cashManagement-service-v1.0.0","title":"Cash Management Holdings","version":"v1.0.0","description":"Cash management API","endpointCount":5,"endpoints":[{"method":"GET","path":"/order/cashManagement/transactionAccounts/sweeps/{sweepId}/intraDaySweeps","fullPath":"/api/v1.0.0/order/cashManagement/transactionAccounts/sweeps/{sweepId}/intraDaySweeps","operationId":"getProcessedSweepRecords","name":"Retrieve the processed details of intra day sweeps.","summary":"Retrieve the processed details of intra day sweeps.","tags":["CORPORATE"],"parameters":[{"name":"sweepId","in":"path","type":"string","required":true,"description":"Identifier of the Retail account sweep"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"ProcessedSweepRecordsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"POST","path":"/order/cashManagement/transactionAccounts/sweeps/{sweepId}/intraDaySweeps","fullPath":"/api/v1.0.0/order/cashManagement/transactionAccounts/sweeps/{sweepId}/intraDaySweeps","operationId":"createVirtualAccountIntraDaySweep","name":"Creates intra-day sweep for virtual accounts. This is used to run the cash pooling on-line if the group permits.","summary":"Creates intra-day sweep for virtual accounts","tags":["CORPORATE"],"parameters":[{"name":"sweepId","in":"path","type":"string","required":true,"description":"Identifier of the Retail account sweep"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"sweepTimes":[{}],"description":"string","masterCompanyTime":"string","phantomEndTime":"string","phantomUser":"string","chargeCode":"string","chargeAmount":"string","chargeAccount":"string","taxAmount":"string","sweepTime":"string","extensions":{}}},"responses":{"200":"VirtualAccountIntraDaySweepResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/order/cashManagement/transactionAccounts/sweeps/{sweepId}","fullPath":"/api/v1.0.0/order/cashManagement/transactionAccounts/sweeps/{sweepId}","operationId":"getCashpoolRecords","name":"Retrieve the complete details of the sweep till date.","summary":"Retrieve the details of the sweep.","tags":["CORPORATE"],"parameters":[{"name":"sweepId","in":"path","type":"string","required":true,"description":"Identifier of the Retail account sweep"},{"name":"date","in":"query","type":"string","required":false,"description":"Indicates the date on which activity was performed"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"CashpoolRecordsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"POST","path":"/order/cashManagement/transactionAccounts/sweeps/{sweepId}","fullPath":"/api/v1.0.0/order/cashManagement/transactionAccounts/sweeps/{sweepId}","operationId":"createVirtualAccountsSweeps","name":"This is used to create rules to move funds between accounts on defined frequency.","summary":"Creates sweep definition for accounts","tags":["CORPORATE"],"parameters":[{"name":"sweepId","in":"path","type":"string","required":true,"description":"Identifier of the Retail account sweep"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"sweepRelationshipDetails":[{}],"narratives":[{}],"groupId":"string","mainAccount":"string","sequenceNumber":0.0,"sweepCancelDate":"2024-01-01","suspensionStartDate":"2024-01-01","suspensionEndDate":"2024-01-01","suspendIndefinite":"string","counterBookingSweepAccount":"string","counterBookingLinkAccount":"string","extensions":{}}},"responses":{"200":"VirtualAccountsSweepsResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/order/cashManagement/transactionAccounts/sweeps/{sweepId}","fullPath":"/api/v1.0.0/order/cashManagement/transactionAccounts/sweeps/{sweepId}","operationId":"updateVirtualAccountSweep","name":"Amend existing sweep setup for example the sequence , minimum and maximum amount","summary":"Amend existing sweep setup for example the sequence , minimum and maximum amount","tags":["CORPORATE"],"parameters":[{"name":"sweepId","in":"path","type":"string","required":true,"description":"Identifier of the Retail account sweep"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"sweepRelationshipDetails":[{}],"narratives":[{}],"groupId":"string","mainAccount":"string","sequenceNumber":0.0,"sweepCancelDate":"2024-01-01","suspensionStartDate":"2024-01-01","suspensionEndDate":"2024-01-01","suspendIndefinite":"string","counterBookingSweepAccount":"string","counterBookingLinkAccount":"string","extensions":{}}},"responses":{"200":"VirtualAccountSweepResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}}]},{"key":"order-cashManagement-service-v2.0.0","title":"Cash Management Holdings","version":"v2.0.0","description":"Cash management API","endpointCount":7,"endpoints":[{"method":"GET","path":"/order/cashManagement/transactionAccounts/sweeps/{sweepId}/intraDaySweeps","fullPath":"/api/v2.0.0/order/cashManagement/transactionAccounts/sweeps/{sweepId}/intraDaySweeps","operationId":"getProcessedSweepRecords","name":"Retrieve the processed details of intra day sweeps.","summary":"Retrieve the processed details of intra day sweeps.","tags":["CORPORATE"],"parameters":[{"name":"sweepId","in":"path","type":"string","required":true,"description":"Identifier of the Retail account sweep"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"ProcessedSweepRecordsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"POST","path":"/order/cashManagement/transactionAccounts/sweeps/{sweepId}/intraDaySweeps","fullPath":"/api/v2.0.0/order/cashManagement/transactionAccounts/sweeps/{sweepId}/intraDaySweeps","operationId":"createVirtualAccountIntraDaySweep","name":"Creates intra-day sweep for virtual accounts. This is used to run the cash pooling on-line if the group permits.","summary":"Creates intra-day sweep for virtual accounts","tags":["CORPORATE"],"parameters":[{"name":"sweepId","in":"path","type":"string","required":true,"description":"Identifier of the Retail account sweep"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"sweepTimes":[{}],"description":"string","masterCompanyTime":"string","phantomEndTime":"string","phantomUser":"string","chargeCode":"string","chargeAmount":"string","chargeAccount":"string","taxAmount":"string","sweepTime":"string","extensions":{}}},"responses":{"200":"VirtualAccountIntraDaySweepResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/order/cashManagement/transactionAccounts/sweeps/{sweepId}","fullPath":"/api/v2.0.0/order/cashManagement/transactionAccounts/sweeps/{sweepId}","operationId":"getCashpoolRecords","name":"Retrieve the complete details of the sweep till date.","summary":"Retrieve the details of the sweep.","tags":["CORPORATE"],"parameters":[{"name":"sweepId","in":"path","type":"string","required":true,"description":"Identifier of the Retail account sweep"},{"name":"date","in":"query","type":"string","required":false,"description":"Indicates the date on which activity was performed"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"CashpoolRecordsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"POST","path":"/order/cashManagement/transactionAccounts/sweeps/{sweepId}","fullPath":"/api/v2.0.0/order/cashManagement/transactionAccounts/sweeps/{sweepId}","operationId":"createVirtualAccountsSweeps","name":"This is used to create rules to move funds between accounts on defined frequency.","summary":"Creates sweep definition for accounts","tags":["CORPORATE"],"parameters":[{"name":"sweepId","in":"path","type":"string","required":true,"description":"Identifier of the Retail account sweep"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"sweepRelationshipDetails":[{}],"narratives":[{}],"groupId":"string","mainAccount":"string","sequenceNumber":0.0,"sweepCancelDate":"2024-01-01","suspensionStartDate":"2024-01-01","suspensionEndDate":"2024-01-01","suspendIndefinite":"string","counterBookingSweepAccount":"string","counterBookingLinkAccount":"string","extensions":{}}},"responses":{"200":"VirtualAccountsSweepsResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/order/cashManagement/transactionAccounts/sweeps/{sweepId}","fullPath":"/api/v2.0.0/order/cashManagement/transactionAccounts/sweeps/{sweepId}","operationId":"updateVirtualAccountSweep","name":"Amend existing sweep setup for example the sequence , minimum and maximum amount","summary":"Amend existing sweep setup for example the sequence , minimum and maximum amount","tags":["CORPORATE"],"parameters":[{"name":"sweepId","in":"path","type":"string","required":true,"description":"Identifier of the Retail account sweep"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"sweepRelationshipDetails":[{}],"narratives":[{}],"groupId":"string","mainAccount":"string","sequenceNumber":0.0,"sweepCancelDate":"2024-01-01","suspensionStartDate":"2024-01-01","suspensionEndDate":"2024-01-01","suspendIndefinite":"string","counterBookingSweepAccount":"string","counterBookingLinkAccount":"string","extensions":{}}},"responses":{"200":"VirtualAccountSweepResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/order/cashManagement/accounts/sweeps","fullPath":"/api/v2.0.0/order/cashManagement/accounts/sweeps","operationId":"getCashpoolSweepRecords","name":"Retrieves the cashpool details of an account","summary":"Retrieves the cashpool details based on from/to account","tags":["CORPORATE"],"parameters":[{"name":"transactionId","in":"query","type":"string","required":false,"description":"Unique transaction identifier for retrieving the details of the transaction. For example: FT0102030333 etc."},{"name":"toAccountSweep","in":"query","type":"string","required":false,"description":"Details about the to account sweeps."},{"name":"fromAccountSweep","in":"query","type":"string","required":false,"description":"Details about the from account sweeps."},{"name":"sweepGroupId","in":"query","type":"string","required":false,"description":"Identifier of the sweep group"},{"name":"currency","in":"query","type":"string","required":false,"description":"Contains the currency of the mandate account"},{"name":"sweepType","in":"query","type":"string","required":false,"description":"Sweep types defined to the user"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"CashpoolSweepRecordsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"DELETE","path":"/order/cashManagement/transactionAccounts/sweeps/{sweepId}/cancellations","fullPath":"/api/v2.0.0/order/cashManagement/transactionAccounts/sweeps/{sweepId}/cancellations","operationId":"deleteCashPoolingServices","name":"Enables the option to delete the existing sweep request","summary":"Remove an existing sweep transaction for specific account","tags":["CORPORATE"],"parameters":[{"name":"sweepId","in":"path","type":"string","required":true,"description":"Identifier of the Retail account sweep"},{"name":"payload","in":"body","type":"object","required":false,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}}},"responses":{"200":"CashPoolingServicesResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}}]},{"key":"order-cashManagement-service-v3.0.0","title":"Cash Management Holdings","version":"v3.0.0","description":"Cash Management API","endpointCount":9,"endpoints":[{"method":"GET","path":"/order/cashManagement/transactionAccounts/sweeps/{sweepId}/intraDaySweeps","fullPath":"/api/v3.0.0/order/cashManagement/transactionAccounts/sweeps/{sweepId}/intraDaySweeps","operationId":"getProcessedSweepRecords","name":"Retrieve the processed sweeps.","summary":"Retrieve the processed sweeps.","tags":["CORPORATE"],"parameters":[{"name":"sweepId","in":"path","type":"string","required":true,"description":"Identifier of the Retail account sweep"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"ProcessedSweepRecordsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"POST","path":"/order/cashManagement/transactionAccounts/sweeps/{sweepId}/intraDaySweeps","fullPath":"/api/v3.0.0/order/cashManagement/transactionAccounts/sweeps/{sweepId}/intraDaySweeps","operationId":"createVirtualAccountIntraDaySweep","name":"Creates intra-day sweep for virtual accounts. This is used to run the cash pooling on-line if the group permits.","summary":"Creates intra-day sweep for virtual accounts","tags":["CORPORATE"],"parameters":[{"name":"sweepId","in":"path","type":"string","required":true,"description":"Identifier of the Retail account sweep"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"sweepTimes":[{}],"description":"string","masterCompanyTime":"string","phantomEndTime":"string","phantomUser":"string","chargeCode":"string","chargeAmount":"string","chargeAccount":"string","taxAmount":"string","sweepTime":"string","extensions":{}}},"responses":{"200":"VirtualAccountIntraDaySweepResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/order/cashManagement/transactionAccounts/sweeps/{sweepId}","fullPath":"/api/v3.0.0/order/cashManagement/transactionAccounts/sweeps/{sweepId}","operationId":"getCashpoolRecords","name":"Retrieve the cashpool details of the virtual accounts","summary":"Retrieve the cashpool details of the virtual accounts","tags":["CORPORATE"],"parameters":[{"name":"sweepId","in":"path","type":"string","required":true,"description":"Identifier of the Retail account sweep"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"CashpoolRecordsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"POST","path":"/order/cashManagement/transactionAccounts/sweeps/{sweepId}","fullPath":"/api/v3.0.0/order/cashManagement/transactionAccounts/sweeps/{sweepId}","operationId":"createVirtualAccountsSweeps","name":"Creates sweep with rules which will be checked against to see if a transfer of funds needs to be made from one account to another.","summary":"Creates sweep","tags":["CORPORATE"],"parameters":[{"name":"sweepId","in":"path","type":"string","required":true,"description":"Identifier of the Retail account sweep"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"sweepRelationshipDetails":[{}],"narratives":[{}],"groupId":"string","mainAccount":"string","sequenceNumber":0.0,"sweepCancelDate":"2024-01-01","suspensionStartDate":"2024-01-01","suspensionEndDate":"2024-01-01","suspendIndefinite":"string","counterBookingSweepAccount":"string","counterBookingLinkAccount":"string","extensions":{}}},"responses":{"200":"VirtualAccountsSweepsResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/order/cashManagement/transactionAccounts/sweeps/{sweepId}","fullPath":"/api/v3.0.0/order/cashManagement/transactionAccounts/sweeps/{sweepId}","operationId":"updateVirtualAccountSweep","name":"Amend existing sweep setup for example the sequence , minimum and maximum amount","summary":"Amend existing sweep setup for example the sequence , minimum and maximum amount","tags":["CORPORATE"],"parameters":[{"name":"sweepId","in":"path","type":"string","required":true,"description":"Identifier of the Retail account sweep"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"sweepRelationshipDetails":[{}],"narratives":[{}],"groupId":"string","mainAccount":"string","sequenceNumber":0.0,"sweepCancelDate":"2024-01-01","suspensionStartDate":"2024-01-01","suspensionEndDate":"2024-01-01","suspendIndefinite":"string","counterBookingSweepAccount":"string","counterBookingLinkAccount":"string","extensions":{}}},"responses":{"200":"VirtualAccountSweepResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"DELETE","path":"/order/cashManagement/transactionAccounts/sweeps/{sweepId}","fullPath":"/api/v3.0.0/order/cashManagement/transactionAccounts/sweeps/{sweepId}","operationId":"reverseVirtualAccountsSweeps","name":"Reverses the cash pool","summary":"Reverses the cash pool","tags":["CORPORATE"],"parameters":[{"name":"sweepId","in":"path","type":"string","required":true,"description":"Identifier of the Retail account sweep"},{"name":"payload","in":"body","type":"object","required":false,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}}},"responses":{"200":"VirtualAccountsSweepsResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/order/cashManagement/accounts/sweeps","fullPath":"/api/v3.0.0/order/cashManagement/accounts/sweeps","operationId":"getCashpoolSweepRecords","name":"Retrieves the cashpool details","summary":"Retrieves the cashpool details","tags":["CORPORATE"],"parameters":[{"name":"transactionId","in":"query","type":"string","required":false,"description":"Unique transaction identifier for retrieving the details of the transaction. For example: FT0102030333 etc."},{"name":"toAccountSweep","in":"query","type":"string","required":false,"description":"Details about the to account sweeps."},{"name":"fromAccountSweep","in":"query","type":"string","required":false,"description":"Details about the from account sweeps."},{"name":"sweepGroupId","in":"query","type":"string","required":false,"description":"Identifier of the sweep group"},{"name":"currency","in":"query","type":"string","required":false,"description":"Contains the currency of the mandate account"},{"name":"sweepType","in":"query","type":"string","required":false,"description":"Sweep types defined to the user"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"CashpoolSweepRecordsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"DELETE","path":"/order/cashManagement/transactionAccounts/sweeps/{sweepId}/cancellations","fullPath":"/api/v3.0.0/order/cashManagement/transactionAccounts/sweeps/{sweepId}/cancellations","operationId":"deleteCashPoolingServices","name":"Enables the option to delete the existing sweep request","summary":"Remove an existing sweep transaction for specific account","tags":["CORPORATE"],"parameters":[{"name":"sweepId","in":"path","type":"string","required":true,"description":"Identifier of the Retail account sweep"},{"name":"payload","in":"body","type":"object","required":false,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}}},"responses":{"200":"CashPoolingServicesResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"POST","path":"/order/sweeps/bookEntryReversals","fullPath":"/api/v3.0.0/order/sweeps/bookEntryReversals","operationId":"reverseLocSweep","name":"Reversal of sweep","summary":"Reversal of sweep","tags":[],"parameters":[{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"csmApplication":"string","csmAction":"string","transactionInput":[{}]}},"responses":{"200":"LocSweepResponse","default":"GAIErrorResponse","400":"BusinessGAIErrorResponse","500":"SystemGAIErrorResponse"}}]},{"key":"order-cashManagement-service-v4.0.0","title":"Cash Management Holdings","version":"v4.0.0","description":"Cash Management API","endpointCount":10,"endpoints":[{"method":"GET","path":"/order/cashManagement/transactionAccounts/sweeps/{sweepId}/intraDaySweeps","fullPath":"/api/v4.0.0/order/cashManagement/transactionAccounts/sweeps/{sweepId}/intraDaySweeps","operationId":"getProcessedSweepRecords","name":"Retrieve the processed sweeps.","summary":"Retrieve the processed sweeps.","tags":["CORPORATE"],"parameters":[{"name":"sweepId","in":"path","type":"string","required":true,"description":"Identifier of the Retail account sweep"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"ProcessedSweepRecordsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"POST","path":"/order/cashManagement/transactionAccounts/sweeps/{sweepId}/intraDaySweeps","fullPath":"/api/v4.0.0/order/cashManagement/transactionAccounts/sweeps/{sweepId}/intraDaySweeps","operationId":"createVirtualAccountIntraDaySweep","name":"Creates intra-day sweep for virtual accounts. This is used to run the cash pooling on-line if the group permits.","summary":"Creates intra-day sweep for virtual accounts","tags":["CORPORATE"],"parameters":[{"name":"sweepId","in":"path","type":"string","required":true,"description":"Identifier of the Retail account sweep"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"sweepTimes":[{}],"description":"string","masterCompanyTime":"string","phantomEndTime":"string","phantomUser":"string","chargeCode":"string","chargeAmount":"string","chargeAccount":"string","taxAmount":"string","sweepTime":"string","extensions":{}}},"responses":{"200":"VirtualAccountIntraDaySweepResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/order/cashManagement/transactionAccounts/sweeps/{sweepId}","fullPath":"/api/v4.0.0/order/cashManagement/transactionAccounts/sweeps/{sweepId}","operationId":"getVirtualAccountsSweeps","name":"Retrieves sweep with rules which will be checked against to see if a transfer of funds needs to be made from one account to another.","summary":"Retrieves sweep","tags":["CORPORATE"],"parameters":[{"name":"sweepId","in":"path","type":"string","required":true,"description":"Identifier of the Retail account sweep"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"VirtualAccountsSweepsResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"POST","path":"/order/cashManagement/transactionAccounts/sweeps/{sweepId}","fullPath":"/api/v4.0.0/order/cashManagement/transactionAccounts/sweeps/{sweepId}","operationId":"createVirtualAccountsSweeps","name":"Creates sweep with rules which will be checked against to see if a transfer of funds needs to be made from one account to another.","summary":"Creates sweep","tags":["CORPORATE"],"parameters":[{"name":"sweepId","in":"path","type":"string","required":true,"description":"Identifier of the Retail account sweep"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"sweepRelationshipDetails":[{}],"narratives":[{}],"groupId":"string","mainAccount":"string","sequenceNumber":0.0,"sweepCancelDate":"2024-01-01","suspensionStartDate":"2024-01-01","suspensionEndDate":"2024-01-01","suspendIndefinite":"string","counterBookingSweepAccount":"string","counterBookingLinkAccount":"string","extensions":{}}},"responses":{"200":"VirtualAccountsSweepsResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/order/cashManagement/transactionAccounts/sweeps/{sweepId}","fullPath":"/api/v4.0.0/order/cashManagement/transactionAccounts/sweeps/{sweepId}","operationId":"updateVirtualAccountSweep","name":"Amend existing sweep setup for example the sequence , minimum and maximum amount","summary":"Amend existing sweep setup for example the sequence , minimum and maximum amount","tags":["CORPORATE"],"parameters":[{"name":"sweepId","in":"path","type":"string","required":true,"description":"Identifier of the Retail account sweep"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"sweepRelationshipDetails":[{}],"narratives":[{}],"groupId":"string","mainAccount":"string","sequenceNumber":0.0,"sweepCancelDate":"2024-01-01","suspensionStartDate":"2024-01-01","suspensionEndDate":"2024-01-01","suspendIndefinite":"string","counterBookingSweepAccount":"string","counterBookingLinkAccount":"string","extensions":{}}},"responses":{"200":"VirtualAccountSweepResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"DELETE","path":"/order/cashManagement/transactionAccounts/sweeps/{sweepId}","fullPath":"/api/v4.0.0/order/cashManagement/transactionAccounts/sweeps/{sweepId}","operationId":"reverseVirtualAccountsSweeps","name":"Reverses the cash pool","summary":"Reverses the cash pool","tags":["CORPORATE"],"parameters":[{"name":"sweepId","in":"path","type":"string","required":true,"description":"Identifier of the Retail account sweep"},{"name":"payload","in":"body","type":"object","required":false,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}}},"responses":{"200":"VirtualAccountsSweepsResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/order/cashManagement/accounts/sweeps","fullPath":"/api/v4.0.0/order/cashManagement/accounts/sweeps","operationId":"getCashpoolSweepRecords","name":"Retrieves the cashpool details","summary":"Retrieves the cashpool details","tags":["CORPORATE"],"parameters":[{"name":"transactionId","in":"query","type":"string","required":false,"description":"Unique transaction identifier for retrieving the details of the transaction. For example: FT0102030333 etc."},{"name":"toAccountSweep","in":"query","type":"string","required":false,"description":"Details about the to account sweeps."},{"name":"fromAccountSweep","in":"query","type":"string","required":false,"description":"Details about the from account sweeps."},{"name":"sweepGroupId","in":"query","type":"string","required":false,"description":"Identifier of the sweep group"},{"name":"currency","in":"query","type":"string","required":false,"description":"Contains the currency of the mandate account"},{"name":"sweepType","in":"query","type":"string","required":false,"description":"Sweep types defined to the user"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"CashpoolSweepRecordsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"DELETE","path":"/order/cashManagement/transactionAccounts/sweeps/{sweepId}/cancellations","fullPath":"/api/v4.0.0/order/cashManagement/transactionAccounts/sweeps/{sweepId}/cancellations","operationId":"deleteCashPoolingServices","name":"Enables the option to delete the existing sweep request","summary":"Remove an existing sweep transaction for specific account","tags":["CORPORATE"],"parameters":[{"name":"sweepId","in":"path","type":"string","required":true,"description":"Identifier of the Retail account sweep"},{"name":"payload","in":"body","type":"object","required":false,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}}},"responses":{"200":"CashPoolingServicesResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"POST","path":"/order/sweeps/bookEntryReversals","fullPath":"/api/v4.0.0/order/sweeps/bookEntryReversals","operationId":"reverseLocSweep","name":"Reversal of sweep","summary":"Reversal of sweep","tags":[],"parameters":[{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"csmApplication":"string","csmAction":"string","transactionInput":[{}]}},"responses":{"200":"LocSweepResponse","default":"GAIErrorResponse","400":"BusinessGAIErrorResponse","500":"SystemGAIErrorResponse"}},{"method":"GET","path":"/order/cashManagement/transactionAccounts/sweeps","fullPath":"/api/v4.0.0/order/cashManagement/transactionAccounts/sweeps","operationId":"getCashpoolRecords","name":"Retrieve the cashpool details of the virtual accounts","summary":"Retrieve the cashpool details of the virtual accounts","tags":["CORPORATE"],"parameters":[{"name":"sweepId","in":"query","type":"string","required":false,"description":"Identifier of the Retail account sweep"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"CashpoolRecordsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}}]},{"key":"order-cashManagement-service-v5.0.0","title":"Cash Management Holdings","version":"v5.0.0","description":"Cash Management API","endpointCount":10,"endpoints":[{"method":"GET","path":"/order/cashManagement/transactionAccounts/sweeps/{sweepId}/intraDaySweeps","fullPath":"/api/v5.0.0/order/cashManagement/transactionAccounts/sweeps/{sweepId}/intraDaySweeps","operationId":"getProcessedSweepRecords","name":"Retrieve the processed sweeps.","summary":"Retrieve the processed sweeps.","tags":["CORPORATE"],"parameters":[{"name":"sweepId","in":"path","type":"string","required":true,"description":"Identifier of the Retail account sweep"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"ProcessedSweepRecordsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"POST","path":"/order/cashManagement/transactionAccounts/sweeps/{sweepId}/intraDaySweeps","fullPath":"/api/v5.0.0/order/cashManagement/transactionAccounts/sweeps/{sweepId}/intraDaySweeps","operationId":"createVirtualAccountIntraDaySweep","name":"Creates intra-day sweep for virtual accounts. This is used to run the cash pooling on-line if the group permits.","summary":"Creates intra-day sweep for virtual accounts","tags":["CORPORATE"],"parameters":[{"name":"sweepId","in":"path","type":"string","required":true,"description":"Identifier of the Retail account sweep"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"sweepTimes":[{}],"description":"string","masterCompanyTime":"string","phantomEndTime":"string","phantomUser":"string","chargeCode":"string","chargeAmount":"string","chargeAccount":"string","taxAmount":"string","sweepTime":"string","extensions":{}}},"responses":{"200":"VirtualAccountIntraDaySweepResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/order/cashManagement/accounts/sweeps","fullPath":"/api/v5.0.0/order/cashManagement/accounts/sweeps","operationId":"getCashpoolSweepRecords","name":"Retrieves the cashpool details","summary":"Retrieves the cashpool details","tags":["CORPORATE"],"parameters":[{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"CashpoolSweepRecordsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/order/cashManagement/transactionAccounts/sweeps/{sweepId}","fullPath":"/api/v5.0.0/order/cashManagement/transactionAccounts/sweeps/{sweepId}","operationId":"getVirtualAccountsSweeps","name":"Retrieves sweep with rules which will be checked against to see if a transfer of funds needs to be made from one account to another.","summary":"Retrieves sweep","tags":["CORPORATE"],"parameters":[{"name":"sweepId","in":"path","type":"string","required":true,"description":"Identifier of the Retail account sweep"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"VirtualAccountsSweepsResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"POST","path":"/order/cashManagement/transactionAccounts/sweeps/{sweepId}","fullPath":"/api/v5.0.0/order/cashManagement/transactionAccounts/sweeps/{sweepId}","operationId":"createVirtualAccountsSweeps","name":"Creates sweep with rules which will be checked against to see if a transfer of funds needs to be made from one account to another.","summary":"Creates sweep","tags":["CORPORATE"],"parameters":[{"name":"sweepId","in":"path","type":"string","required":true,"description":"Identifier of the Retail account sweep"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"sweepRelationshipDetails":[{}],"narratives":[{}],"groupId":"string","mainAccount":"string","sequenceNumber":0.0,"sweepCancelDate":"2024-01-01","suspensionStartDate":"2024-01-01","suspensionEndDate":"2024-01-01","suspendIndefinite":"string","counterBookingSweepAccount":"string","counterBookingLinkAccount":"string","extensions":{}}},"responses":{"200":"VirtualAccountsSweepsResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/order/cashManagement/transactionAccounts/sweeps/{sweepId}","fullPath":"/api/v5.0.0/order/cashManagement/transactionAccounts/sweeps/{sweepId}","operationId":"updateVirtualAccountSweep","name":"Amend existing sweep setup for example the sequence , minimum and maximum amount","summary":"Amend sweep","tags":["CORPORATE"],"parameters":[{"name":"sweepId","in":"path","type":"string","required":true,"description":"Identifier of the Retail account sweep"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"sweepRelationshipDetails":[{}],"narratives":[{}],"groupId":"string","mainAccount":"string","sequenceNumber":0.0,"sweepCancelDate":"2024-01-01","suspensionStartDate":"2024-01-01","suspensionEndDate":"2024-01-01","suspendIndefinite":"string","counterBookingSweepAccount":"string","counterBookingLinkAccount":"string","extensions":{}}},"responses":{"200":"VirtualAccountSweepResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"DELETE","path":"/order/cashManagement/transactionAccounts/sweeps/{sweepId}","fullPath":"/api/v5.0.0/order/cashManagement/transactionAccounts/sweeps/{sweepId}","operationId":"reverseVirtualAccountsSweeps","name":"Reverses the cash pool","summary":"Reverses the cash pool","tags":["CORPORATE"],"parameters":[{"name":"sweepId","in":"path","type":"string","required":true,"description":"Identifier of the Retail account sweep"},{"name":"payload","in":"body","type":"object","required":false,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}}},"responses":{"200":"VirtualAccountsSweepsResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"DELETE","path":"/order/cashManagement/transactionAccounts/sweeps/{sweepId}/cancellations","fullPath":"/api/v5.0.0/order/cashManagement/transactionAccounts/sweeps/{sweepId}/cancellations","operationId":"deleteCashPoolingServices","name":"Enables the option to delete the existing sweep request","summary":"Remove an existing sweep transaction for specific account","tags":["CORPORATE"],"parameters":[{"name":"sweepId","in":"path","type":"string","required":true,"description":"Identifier of the Retail account sweep"},{"name":"payload","in":"body","type":"object","required":false,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}}},"responses":{"200":"CashPoolingServicesResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"POST","path":"/order/sweeps/bookEntryReversals","fullPath":"/api/v5.0.0/order/sweeps/bookEntryReversals","operationId":"reverseLocSweeps","name":"Reversal of sweep","summary":"Reversal of sweep","tags":[],"parameters":[{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"csmApplication":"string","csmAction":"string","transactionInput":[{}]}},"responses":{"200":"LocSweepsResponse","default":"GAIErrorResponse","400":"BusinessGAIErrorResponse","500":"SystemGAIErrorResponse"}},{"method":"GET","path":"/order/cashManagement/transactionAccounts/sweeps","fullPath":"/api/v5.0.0/order/cashManagement/transactionAccounts/sweeps","operationId":"getCashpoolRecords","name":"Retrieve the cashpool details of the virtual accounts","summary":"Retrieve the cashpool details of the virtual accounts","tags":["CORPORATE"],"parameters":[{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"CashpoolRecordsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}}]},{"key":"order-cashmanagement-bundles-v1.0.0","title":"Cash Management - Bundle Account management","version":"v1.0.0","description":"API for cash management to create and update bundle accounts","endpointCount":9,"endpoints":[{"method":"POST","path":"/order/cashManagement/bundles/accounts/summaryAccounts/transactionStops","fullPath":"/api/v1.0.0/order/cashManagement/bundles/accounts/summaryAccounts/transactionStops","operationId":"createBlockOnSummaryAccounts","name":"Create Block on Summary Accounts","summary":"Create Block on Summary Accounts","tags":[],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"arrangementCustomerIds":[{}],"arrangementEffectiveDate":"string","productId":"string","activityId":"string","summary":[{}]}},"responses":{"200":"createBlockOnSummaryAccountsResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"PUT","path":"/order/cashManagement/bundles/accounts/summaryAccounts/transactionStops","fullPath":"/api/v1.0.0/order/cashManagement/bundles/accounts/summaryAccounts/transactionStops","operationId":"updateBlockOnSummaryAccounts","name":"Update Block on Summary Accounts","summary":"Update Block on Summary Accounts","tags":[],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"arrangementCustomerIds":[{}],"arrangementEffectiveDate":"string","productId":"string","activityId":"string","summary":[{}]}},"responses":{"200":"updateBlockOnSummaryAccountsResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"POST","path":"/order/cashManagement/bundles/accounts/currencySummaryAccounts/transactionStops","fullPath":"/api/v1.0.0/order/cashManagement/bundles/accounts/currencySummaryAccounts/transactionStops","operationId":"createBlockOnCurrencySummaryAccounts","name":"Create Block on Currency Summary Accounts","summary":"Create Block on Currency Summary Accounts","tags":[],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"arrangementCustomerIds":[{}],"arrangementEffectiveDate":"string","productId":"string","activityId":"string","summary":[{}]}},"responses":{"200":"createBlockOnCurrencySummaryAccountsResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"PUT","path":"/order/cashManagement/bundles/accounts/currencySummaryAccounts/transactionStops","fullPath":"/api/v1.0.0/order/cashManagement/bundles/accounts/currencySummaryAccounts/transactionStops","operationId":"updateBlockOnCurrencySummaryAccounts","name":"Update Block on Currency Summary Accounts","summary":"Update Block on Currency Summary Accounts","tags":[],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"arrangementCustomerIds":[{}],"arrangementEffectiveDate":"string","productId":"string","activityId":"string","summary":[{}]}},"responses":{"200":"updateBlockOnCurrencySummaryAccountsResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"POST","path":"/order/cashManagement/bundles/accounts/transactionAccounts/transactionStops","fullPath":"/api/v1.0.0/order/cashManagement/bundles/accounts/transactionAccounts/transactionStops","operationId":"createBlockOnTransactionAccounts","name":"Create Block on Transaction Accounts","summary":"Create Block on Transaction Accounts","tags":[],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"arrangementCustomerIds":[{}],"arrangementEffectiveDate":"string","productId":"string","activityId":"string","balance":[{}]}},"responses":{"200":"createBlockOnTransactionAccountsResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"PUT","path":"/order/cashManagement/bundles/accounts/transactionAccounts/transactionStops","fullPath":"/api/v1.0.0/order/cashManagement/bundles/accounts/transactionAccounts/transactionStops","operationId":"updateBlockOnTransactionAccounts","name":"Update Block on Transaction Accounts","summary":"Update Block on Transaction Accounts","tags":[],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"arrangementCustomerIds":[{}],"arrangementEffectiveDate":"string","productId":"string","activityId":"string","balance":[{}]}},"responses":{"200":"updateBlockOnTransactionAccountsResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"PUT","path":"/order/cashManagement/bundles/updateSettlement","fullPath":"/api/v1.0.0/order/cashManagement/bundles/updateSettlement","operationId":"updateBundleSettlementAccount","name":"Update Settlement instructions to an Account","summary":"Update Settlement instructions to an Account","tags":[],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"arrangementCustomerIds":[{}],"arrangementEffectiveDate":"string","productId":"string","activityId":"string","settlement":[{}]}},"responses":{"200":"updateBundleSettlementAccountResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"POST","path":"/order/cashManagement/bundles/transactionStops","fullPath":"/api/v1.0.0/order/cashManagement/bundles/transactionStops","operationId":"createBlockOnCashPoolStructure","name":"Create Customer Mass Block for a specific Cash Pool Arrangement Structure over a specified period","summary":"Create Customer Mass Block","tags":[],"parameters":[{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"aaBundleId":"string","startDate":"2024-01-01","endDate":"2024-01-01","unrestrictionReason":"string","unrestrictionText":"string"}},"responses":{"200":"BlockOnCashPoolStructureResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/order/cashManagement/bundles/{customerMassBlockId}/transactionStops","fullPath":"/api/v1.0.0/order/cashManagement/bundles/{customerMassBlockId}/transactionStops","operationId":"updateBlockOnCashPoolStructure","name":"Update Customer Mass Block for a specific Cash Pool Arrangement Structure over a specified period","summary":"Update Customer Mass Block","tags":[],"parameters":[{"name":"customerMassBlockId","in":"path","type":"string","required":true,"description":""},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"aaBundleId":"string","startDate":"2024-01-01","endDate":"2024-01-01","unrestrictionReason":"string","unrestrictionText":"string"}},"responses":{"200":"BlockOnCashPoolStructureResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}}]},{"key":"order-cashmanagement-sweep-v1.0.0","title":"Cash Management Sweeps","version":"v1.0.0","description":"API to create, update and manage various types of cash management balance sweeps. Some of the types of sweeps that can be created are balance maintenance - maintain a particular balance in the sweep account, surplus balance - sweep out surplus funds to the master account and two-way balance sweeps -","endpointCount":12,"endpoints":[{"method":"POST","path":"/order/cashManagement/sweeps/{accountId}/maintainBalances","fullPath":"/api/v1.0.0/order/cashManagement/sweeps/{accountId}/maintainBalances","operationId":"createMaintainBalanceSweeps","name":"Create maintenance sweep to maintain the minimum balances of the sub-account from the master account.","summary":"Create balance maintenance sweep","tags":[],"parameters":[{"name":"accountId","in":"path","type":"string","required":true,"description":"Identifier of the account. Often referred to as the account number, yet for consistency this is always referred to as accountId. Accepts both IBAN & BBAN"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"sweepRelationshipDetails":[{}],"narratives":[{}],"groupId":"string","mainAccount":"string","sequenceNumber":0.0,"sweepCancelDate":"2024-01-01","suspensionStartDate":"2024-01-01","suspensionEndDate":"2024-01-01","suspendIndefinite":"string","counterBookingSweepAccount":"string","counterBookingLinkAccount":"string"}},"responses":{"200":"MaintainBalanceSweepsResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/order/cashManagement/sweeps/{accountId}/maintainBalances","fullPath":"/api/v1.0.0/order/cashManagement/sweeps/{accountId}/maintainBalances","operationId":"updateMaintainBalanceSweeps","name":"Update the details of the maintenance sweep such as the amount, frequency and charges to be applied etc. ","summary":"Update balance maintenance sweep","tags":[],"parameters":[{"name":"accountId","in":"path","type":"string","required":true,"description":"Identifier of the account. Often referred to as the account number, yet for consistency this is always referred to as accountId. Accepts both IBAN & BBAN"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"sweepRelationshipDetails":[{}],"narratives":[{}],"groupId":"string","mainAccount":"string","sequenceNumber":0.0,"sweepCancelDate":"2024-01-01","suspensionStartDate":"2024-01-01","suspensionEndDate":"2024-01-01","suspendIndefinite":"string","counterBookingSweepAccount":"string","counterBookingLinkAccount":"string"}},"responses":{"200":"MaintainBalanceSweepsResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"POST","path":"/order/cashManagement/sweeps/{accountId}/surplusBalances","fullPath":"/api/v1.0.0/order/cashManagement/sweeps/{accountId}/surplusBalances","operationId":"createSurplusBalanceSweeps","name":"Create surplus sweep to sweep the surplus balances of the sub-account to the master account.","summary":"Create surplus balance sweep","tags":[],"parameters":[{"name":"accountId","in":"path","type":"string","required":true,"description":"Identifier of the account. Often referred to as the account number, yet for consistency this is always referred to as accountId. Accepts both IBAN & BBAN"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"sweepRelationshipDetails":[{}],"narratives":[{}],"groupId":"string","mainAccount":"string","sequenceNumber":0.0,"sweepCancelDate":"2024-01-01","suspensionStartDate":"2024-01-01","suspensionEndDate":"2024-01-01","suspendIndefinite":"string","counterBookingSweepAccount":"string","counterBookingLinkAccount":"string"}},"responses":{"200":"SurplusBalanceSweepsResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/order/cashManagement/sweeps/{accountId}/surplusBalances","fullPath":"/api/v1.0.0/order/cashManagement/sweeps/{accountId}/surplusBalances","operationId":"updateSurplusBalanceSweeps","name":"Update the details of the surplus sweep such as amount, frequency and the charges to be applied etc.","summary":"Update surplus balance sweep","tags":[],"parameters":[{"name":"accountId","in":"path","type":"string","required":true,"description":"Identifier of the account. Often referred to as the account number, yet for consistency this is always referred to as accountId. Accepts both IBAN & BBAN"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"sweepRelationshipDetails":[{}],"narratives":[{}],"groupId":"string","mainAccount":"string","sequenceNumber":0.0,"sweepCancelDate":"2024-01-01","suspensionStartDate":"2024-01-01","suspensionEndDate":"2024-01-01","suspendIndefinite":"string","counterBookingSweepAccount":"string","counterBookingLinkAccount":"string"}},"responses":{"200":"SurplusBalanceSweepsResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"POST","path":"/order/cashManagement/sweeps/{accountId}/zeroBalances","fullPath":"/api/v1.0.0/order/cashManagement/sweeps/{accountId}/zeroBalances","operationId":"createZeroBalanceSweeps","name":"Create two-way sweep to maintain or transfer the surplus balances from sub account to the master account ","summary":"Create two-way balance sweep","tags":[],"parameters":[{"name":"accountId","in":"path","type":"string","required":true,"description":"Identifier of the account. Often referred to as the account number, yet for consistency this is always referred to as accountId. Accepts both IBAN & BBAN"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"sweepRelationshipDetails":[{}],"narratives":[{}],"groupId":"string","mainAccount":"string","sequenceNumber":0.0,"sweepCancelDate":"2024-01-01","suspensionStartDate":"2024-01-01","suspensionEndDate":"2024-01-01","suspendIndefinite":"string","counterBookingSweepAccount":"string","counterBookingLinkAccount":"string"}},"responses":{"200":"ZeroBalanceSweepsResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/order/cashManagement/sweeps/{accountId}/zeroBalances","fullPath":"/api/v1.0.0/order/cashManagement/sweeps/{accountId}/zeroBalances","operationId":"updateZeroBalanceSweeps","name":"Update the details of the two-way sweep such as the amount, frequency and the charges to be applied etc.","summary":"Update two-way balance sweep","tags":[],"parameters":[{"name":"accountId","in":"path","type":"string","required":true,"description":"Identifier of the account. Often referred to as the account number, yet for consistency this is always referred to as accountId. Accepts both IBAN & BBAN"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"sweepRelationshipDetails":[{}],"narratives":[{}],"groupId":"string","mainAccount":"string","sequenceNumber":0.0,"sweepCancelDate":"2024-01-01","suspensionStartDate":"2024-01-01","suspensionEndDate":"2024-01-01","suspendIndefinite":"string","counterBookingSweepAccount":"string","counterBookingLinkAccount":"string"}},"responses":{"200":"ZeroBalanceSweepsResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"POST","path":"/order/cashManagement/sweeps/{accountId}/maintainBalances/crossCurrencies","fullPath":"/api/v1.0.0/order/cashManagement/sweeps/{accountId}/maintainBalances/crossCurrencies","operationId":"createFXCurrencyMaintainBalanceSweeps","name":"Create cross currency balance maintenance sweep to maintain minimum balance between accounts in different currency. ","summary":"Create cross currency balance maintenance sweep","tags":[],"parameters":[{"name":"accountId","in":"path","type":"string","required":true,"description":"Identifier of the account. Often referred to as the account number, yet for consistency this is always referred to as accountId. Accepts both IBAN & BBAN"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"sweepRelationshipDetails":[{}],"narratives":[{}],"groupId":"string","mainAccount":"string","sequenceNumber":0.0,"sweepCancelDate":"2024-01-01","suspensionStartDate":"2024-01-01","suspensionEndDate":"2024-01-01","suspendIndefinite":"string","counterBookingSweepAccount":"string","counterBookingLinkAccount":"string"}},"responses":{"200":"FXCurrencyMaintainBalanceSweepsResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/order/cashManagement/sweeps/{accountId}/maintainBalances/crossCurrencies","fullPath":"/api/v1.0.0/order/cashManagement/sweeps/{accountId}/maintainBalances/crossCurrencies","operationId":"updateFXCurrencyMaintainBalanceSweeps","name":"Update the details of the cross maintenance sweep such as the sweep amount, frequency and charges to be applied etc.","summary":"Update cross currency balance maintenance sweep","tags":[],"parameters":[{"name":"accountId","in":"path","type":"string","required":true,"description":"Identifier of the account. Often referred to as the account number, yet for consistency this is always referred to as accountId. Accepts both IBAN & BBAN"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"sweepRelationshipDetails":[{}],"narratives":[{}],"groupId":"string","mainAccount":"string","sequenceNumber":0.0,"sweepCancelDate":"2024-01-01","suspensionStartDate":"2024-01-01","suspensionEndDate":"2024-01-01","suspendIndefinite":"string","counterBookingSweepAccount":"string","counterBookingLinkAccount":"string"}},"responses":{"200":"FXCurrencyMaintainBalanceSweepsResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"POST","path":"/order/cashManagement/sweeps/{accountId}/surplusBalances/crossCurrencies","fullPath":"/api/v1.0.0/order/cashManagement/sweeps/{accountId}/surplusBalances/crossCurrencies","operationId":"createFXSurplusBalanceSweeps","name":"Create cross currency surplus sweep to transfer the surplus balances to the master account which is maintained in a different currency. ","summary":"Create cross currency surplus balance sweep","tags":[],"parameters":[{"name":"accountId","in":"path","type":"string","required":true,"description":"Identifier of the account. Often referred to as the account number, yet for consistency this is always referred to as accountId. Accepts both IBAN & BBAN"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"sweepRelationshipDetails":[{}],"narratives":[{}],"groupId":"string","mainAccount":"string","sequenceNumber":0.0,"sweepCancelDate":"2024-01-01","suspensionStartDate":"2024-01-01","suspensionEndDate":"2024-01-01","suspendIndefinite":"string","counterBookingSweepAccount":"string","counterBookingLinkAccount":"string"}},"responses":{"200":"FXSurplusBalanceSweepsResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/order/cashManagement/sweeps/{accountId}/surplusBalances/crossCurrencies","fullPath":"/api/v1.0.0/order/cashManagement/sweeps/{accountId}/surplusBalances/crossCurrencies","operationId":"updateFXSurplusBalanceSweeps","name":"Update the details of the cross currency surplus sweep such as the amount, frequency and charges to be applied etc. ","summary":"Update cross currency surplus balance sweep","tags":[],"parameters":[{"name":"accountId","in":"path","type":"string","required":true,"description":""},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"sweepRelationshipDetails":[{}],"narratives":[{}],"groupId":"string","mainAccount":"string","sequenceNumber":0.0,"sweepCancelDate":"2024-01-01","suspensionStartDate":"2024-01-01","suspensionEndDate":"2024-01-01","suspendIndefinite":"string","counterBookingSweepAccount":"string","counterBookingLinkAccount":"string"}},"responses":{"200":"FXSurplusBalanceSweepsResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"POST","path":"/order/cashManagement/sweeps/{accountId}/zeroBalances/crossCurrencies","fullPath":"/api/v1.0.0/order/cashManagement/sweeps/{accountId}/zeroBalances/crossCurrencies","operationId":"createFXZeroBalanceSweeps","name":"Create cross currency two-way sweep to maintain or transfer surplus balances between accounts in different currency","summary":"Create cross currency two-way balance sweep","tags":[],"parameters":[{"name":"accountId","in":"path","type":"string","required":true,"description":"Identifier of the account. Often referred to as the account number, yet for consistency this is always referred to as accountId. Accepts both IBAN & BBAN"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"sweepRelationshipDetails":[{}],"narratives":[{}],"groupId":"string","mainAccount":"string","sequenceNumber":0.0,"sweepCancelDate":"2024-01-01","suspensionStartDate":"2024-01-01","suspensionEndDate":"2024-01-01","suspendIndefinite":"string","counterBookingSweepAccount":"string","counterBookingLinkAccount":"string"}},"responses":{"200":"FXZeroBalanceSweepsResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/order/cashManagement/sweeps/{accountId}/zeroBalances/crossCurrencies","fullPath":"/api/v1.0.0/order/cashManagement/sweeps/{accountId}/zeroBalances/crossCurrencies","operationId":"updateFXZeroBalanceSweeps","name":"Update the details of the cross currency two-way sweep such as amount, freqency and the charges to be applied etc.","summary":"Update cross currency two-way balance sweep","tags":[],"parameters":[{"name":"accountId","in":"path","type":"string","required":true,"description":"Identifier of the account. Often referred to as the account number, yet for consistency this is always referred to as accountId. Accepts both IBAN & BBAN"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"sweepRelationshipDetails":[{}],"narratives":[{}],"groupId":"string","mainAccount":"string","sequenceNumber":0.0,"sweepCancelDate":"2024-01-01","suspensionStartDate":"2024-01-01","suspensionEndDate":"2024-01-01","suspendIndefinite":"string","counterBookingSweepAccount":"string","counterBookingLinkAccount":"string"}},"responses":{"200":"FXZeroBalanceSweepsResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}}]},{"key":"order-clearing-service-v1.0.0","title":"Clearing Orders","version":"v1.0.0","description":"API to manage clearing order requests. Clearing order requests are created as part of cheque exchanges between banks and central clearing houses. The process begins when a drawee deposits a cheque for clearing in the drawer bank, the banks will pass it on to the clearing house which verifies the che","endpointCount":1,"endpoints":[{"method":"POST","path":"/order/clearingEntries","fullPath":"/api/v1.0.0/order/clearingEntries","operationId":"createORValidateFR","name":"Creates or validates clearing order request of type COVER or RESERVE or BOOK with details such as payee or drawee account number, currency, amount, clearing type - debit or credit, date of clearing and other payment references. COVER requests can be initiated to verify the validity of account and availability of funds in case of debit clearing. RESERVE requests can be initiated to hold the funds in the payee account before the cheques are cleared for collections. BOOK requests can be initiated t","summary":"","tags":[],"parameters":[{"name":"companyId","in":"header","type":"string","required":false,"description":"The identifier of the underlying entity/company/branch."},{"name":"channelName","in":"header","type":"string","required":false,"description":"Name of the (digital) channel registered by the Customer used for the clearing request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"payload","in":"body","type":"object","required":true,"description":"Contains the fields and its values to be input for the clearing request in the specific order"}],"requestBodyExample":{"header":{},"body":{"operation":"string","target":"string","payload":"string"}},"responses":{"200":"createORValidateFRResponse"}}]},{"key":"order-collectionOrders-service-v1.0.0","title":"Debit Collection Order","version":"v1.0.0","description":"Debit collection order is a temenos payments application that helps bank manage their debit collection orders before they are being sent for execution by the bank's payment system. It provides order management functionality to initiate, view and manage their orders from an online channel offered by ","endpointCount":8,"endpoints":[{"method":"GET","path":"/order/collectionOrders","fullPath":"/api/v1.0.0/order/collectionOrders","operationId":"getDebitCollectionOrderLists","name":"Retrieve a list of authorised debit collection orders based on a specific criteria","summary":"Retrieve a list of debit collection orders","tags":[],"parameters":[{"name":"collectionOrderId","in":"query","type":"string","required":false,"description":"Indicates the unique reference number of debit collection order."},{"name":"currentState","in":"query","type":"string","required":false,"description":"Contains the current state of the transaction"},{"name":"paymentStatus","in":"query","type":"string","required":false,"description":"Describes the current status of the payment order in the payment system"},{"name":"creditAccountNumber","in":"query","type":"string","required":false,"description":"Contains the International Bank Account Number(IBAN) for which the camt message is sent."},{"name":"requestedCollectionDate","in":"query","type":"string","required":false,"description":"Indicates the date on which the creditor requests the transaction amount to be collected from the debtor."},{"name":"collectionProduct","in":"query","type":"string","required":false,"description":"Indicates the debit collection product for which payment is initiated."},{"name":"paymentCurrency","in":"query","type":"string","required":false,"description":"This field holds the transaction currency or currency in which payment is initiated. "},{"name":"paymentAmount","in":"query","type":"string","required":false,"description":"Indicates the payment amount for the defined term, amount and payment frequency. It will include principal, charge and interest"},{"name":"debitAccountNumber","in":"query","type":"string","required":false,"description":"Deprecated - Debit account number"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"DebitCollectionOrderListsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"POST","path":"/order/collectionOrders","fullPath":"/api/v1.0.0/order/collectionOrders","operationId":"initiateDebitCollectionOrder","name":"Create a new debit collection order","summary":"Initiate a new debit collection order","tags":[],"parameters":[{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"orderInitiationType":"string","collectionProduct":"string","CreditAccountNumber":"Creditor Account Number","creditAccountCurrency":"Creditor Account Currency","creditAccountName":"Creditor Account Currency","creditorEmail":"string","creditorMobile":"string","creditorAddress":"string","creditorIssuer":"string","creditorOtherIdType":"string","creditorOtherId":"string","creditorLEI":"string","creditorBIC":"string","creditorBankClearingCode":"string","creditorAgentBIC":"string"}},"responses":{"200":"DebitCollectionOrderResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/order/collectionOrders/{collectionOrderId}/approvals","fullPath":"/api/v1.0.0/order/collectionOrders/{collectionOrderId}/approvals","operationId":"approveDebitCollectionOrder","name":"Approve a debit collection order that is awaiting supervisor approval","summary":"Authorise a debit collection order","tags":[],"parameters":[{"name":"collectionOrderId","in":"path","type":"string","required":true,"description":"Indicates the unique reference number of debit collection order."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"DebitCollectionOrderResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/order/collectionOrders/{collectionOrderId}","fullPath":"/api/v1.0.0/order/collectionOrders/{collectionOrderId}","operationId":"getDebitCollectionOrderList","name":"Retrieve a specific order for a given debit collection order reference","summary":"Retrieve debit collection order for a given reference","tags":[],"parameters":[{"name":"collectionOrderId","in":"path","type":"string","required":true,"description":"Indicates the unique reference number of debit collection order."},{"name":"currentState","in":"query","type":"string","required":false,"description":"Contains the current state of the transaction"},{"name":"paymentStatus","in":"query","type":"string","required":false,"description":"Describes the current status of the payment order in the payment system"},{"name":"creditAccountNumber","in":"query","type":"string","required":false,"description":"Contains the International Bank Account Number(IBAN) for which the camt message is sent."},{"name":"requestedCollectionDate","in":"query","type":"string","required":false,"description":"Indicates the date on which the creditor requests the transaction amount to be collected from the debtor."},{"name":"collectionProduct","in":"query","type":"string","required":false,"description":"Indicates the debit collection product for which payment is initiated."},{"name":"paymentCurrency","in":"query","type":"string","required":false,"description":"This field holds the transaction currency or currency in which payment is initiated. "},{"name":"paymentAmount","in":"query","type":"string","required":false,"description":"Indicates the payment amount for the defined term, amount and payment frequency. It will include principal, charge and interest"},{"name":"debitAccountNumber","in":"query","type":"string","required":false,"description":"Deprecated - Debit account number"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"DebitCollectionOrderListResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"PUT","path":"/order/collectionOrders/{collectionOrderId}","fullPath":"/api/v1.0.0/order/collectionOrders/{collectionOrderId}","operationId":"amendDebitCollectionOrder","name":"Amend a debit collection order that is yet to be approved","summary":"Amend unathorised debit collection order","tags":[],"parameters":[{"name":"collectionOrderId","in":"path","type":"string","required":true,"description":"Indicates the unique reference number of debit collection order."},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"orderInitiationType":"string","collectionProduct":"string","CreditAccountNumber":"Creditor Account Number","creditAccountCurrency":"Creditor Account Currency","creditAccountName":"Creditor Account Currency","creditorEmail":"string","creditorMobile":"string","creditorAddress":"string","creditorIssuer":"string","creditorOtherIdType":"string","creditorOtherId":"string","creditorLEI":"string","creditorBIC":"string","creditorBankClearingCode":"string","creditorAgentBIC":"string"}},"responses":{"200":"DebitCollectionOrderResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"DELETE","path":"/order/collectionOrders/{collectionOrderId}","fullPath":"/api/v1.0.0/order/collectionOrders/{collectionOrderId}","operationId":"deleteDebitCollectionOrder","name":"Delete a debit collection order that is waiting for supervisor approval","summary":"Delete debit collection order","tags":[],"parameters":[{"name":"collectionOrderId","in":"path","type":"string","required":true,"description":"Indicates the unique reference number of debit collection order."},{"name":"payload","in":"body","type":"object","required":false,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}}},"responses":{"200":"DebitCollectionOrderResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/order/collectionOrders/{collectionOrderId}/cancellations","fullPath":"/api/v1.0.0/order/collectionOrders/{collectionOrderId}/cancellations","operationId":"cancelDebitCollectionOrder","name":"Cancel debit collection order that is yet to be sent to clearing","summary":"Cancel debit collection order","tags":[],"parameters":[{"name":"collectionOrderId","in":"path","type":"string","required":true,"description":"Indicates the unique reference number of debit collection order."},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"currentState":"string","cancellationReason":"Reject Reason Code","remark":"Reject Additional Info","initiator":"string","statusHistory":"Status History","extensions":{}}},"responses":{"200":"DebitCollectionOrderResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/order/collectionOrders/payment/cancellations","fullPath":"/api/v1.0.0/order/collectionOrders/payment/cancellations","operationId":"cancelOrder","name":"Request a cancellation of the existing DD collection in the payment system","summary":"Cancel DD collection","tags":[],"parameters":[{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"cancellationReason":"Cancel Description","transactionReference":"FT Number","extensions":{}}},"responses":{"200":"OrderResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}}]},{"key":"order-creditaccountsweeps-v1.0.0","title":"Order Credit Account Sweeps","version":"v1.0.0","description":"Retail Sweep Details where the requested Account is a Credit Account to the Sweep","endpointCount":1,"endpoints":[{"method":"GET","path":"/order/sweeps/accounts/{accountId}/creditAccounts","fullPath":"/api/v1.0.0/order/sweeps/accounts/{accountId}/creditAccounts","operationId":"getSweepCreditAccountDetails","name":"","summary":"","tags":[],"parameters":[{"name":"accountId","in":"path","type":"string","required":true,"description":"The identifier of the account. Often referred to as the account number, yet for consistency this is always referred to as accountId."},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from t24 on every enquiry request."},{"name":"credentials","in":"query","type":"string","required":false,"description":""},{"name":"companyId","in":"query","type":"string","required":false,"description":""}],"requestBodyExample":null,"responses":{"200":"SweepCreditAccountDetailsResponse","default":"QueryErrorResponse"}}]},{"key":"order-creditorReferences-v1.0.0","title":"Creditor Reference","version":"v1.0.0","description":"The API will generate or validate Structured Creditor Reference. The check digits will be calculated based on ISO Standards","endpointCount":1,"endpoints":[{"method":"GET","path":"/order/creditorReferences/{creditorReference}","fullPath":"/api/v1.0.0/order/creditorReferences/{creditorReference}","operationId":"getStructuredCreditorReference","name":"API validates the supplied Real/Unique Creditor Reference, if it is valid the API returns Structured Creditor Reference, else it throws an error. API validates the supplied Structured Creditor Reference, if the Reference is valid then the API returns as Success, else if there is an error, it will return n error code specific to the error reason.","summary":"Retrieves generated Structured creditor reference or validate the structured creditor reference","tags":[],"parameters":[{"name":"creditorReference","in":"path","type":"string","required":true,"description":"Creditor Reference provided in the transaction"},{"name":"generateOrValidateOption","in":"query","type":"string","required":true,"description":"The option whether to generate or validate the structured creditor reference. Respectively GENERATE or VALIDATE"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from t24 on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"The identifier of the underlying Entity/Company/Branch."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"StructuredCreditorReferenceResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}}]},{"key":"order-debitaccountsweeps-v1.0.0","title":"Order Debit Account Sweeps","version":"v1.0.0","description":"Retail Sweep Details where the requested Account is a Debit Account to the Sweep","endpointCount":1,"endpoints":[{"method":"GET","path":"/order/sweeps/accounts/{accountId}/debitAccounts","fullPath":"/api/v1.0.0/order/sweeps/accounts/{accountId}/debitAccounts","operationId":"getSweepDebitAccountDetails","name":"","summary":"","tags":[],"parameters":[{"name":"accountId","in":"path","type":"string","required":true,"description":"The identifier of the account. Often referred to as the account number, yet for consistency this is always referred to as accountId."},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from t24 on every enquiry request."},{"name":"credentials","in":"query","type":"string","required":false,"description":""},{"name":"companyId","in":"query","type":"string","required":false,"description":""}],"requestBodyExample":null,"responses":{"200":"SweepDebitAccountDetailsResponse","default":"QueryErrorResponse"}}]},{"key":"order-derivativeOrders-service-v1.0.0","title":"Derivative Instrument Orders","version":"v1.0.0","description":"Allows the creation, viewing and management of derivative orders","endpointCount":5,"endpoints":[{"method":"GET","path":"/order/deriviativeOrders/OTCOrders","fullPath":"/api/v1.0.0/order/deriviativeOrders/OTCOrders","operationId":"getOTCDerivativeOrders","name":"Retrieves the over the counter derivative trades based on the contract code and trade type","summary":"Retrieves the over the counter derivative trades","tags":[],"parameters":[{"name":"instrumentId","in":"query","type":"string","required":false,"description":"The identifier of the instrument"},{"name":"tradeType","in":"query","type":"string","required":false,"description":"The trade type"},{"name":"callOrPut","in":"query","type":"string","required":false,"description":"Indicates whether the transaction is a call or put.  Allowed values: - CALL  - PUT"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from t24 on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":""},{"name":"companyId","in":"header","type":"string","required":false,"description":""}],"requestBodyExample":null,"responses":{"200":"OTCDerivativeOrdersResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/order/deriviativeOrders/ETDOrders","fullPath":"/api/v1.0.0/order/deriviativeOrders/ETDOrders","operationId":"getETDDerivativeOrders","name":"Retrieves the exchange traded derivative trades based on the contract code and trade type","summary":"Retrieves the exchange traded derivative trades","tags":[],"parameters":[{"name":"instrumentId","in":"query","type":"string","required":false,"description":"The identifier of the instrument"},{"name":"tradeType","in":"query","type":"string","required":false,"description":"The trade type"},{"name":"callOrPut","in":"query","type":"string","required":false,"description":"Indicates whether the transaction is a call or put.  Allowed values: - CALL  - PUT"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from t24 on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":""},{"name":"companyId","in":"header","type":"string","required":false,"description":""}],"requestBodyExample":null,"responses":{"200":"ETDDerivativeOrdersResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"POST","path":"/order/deriviativeOrders","fullPath":"/api/v1.0.0/order/deriviativeOrders","operationId":"createDerivativesOrder","name":"Creates the derivatives order","summary":"Creates the derivatives order","tags":[],"parameters":[{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":""},{"name":"companyId","in":"header","type":"string","required":false,"description":""}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"customers":[{}],"rates":[{}],"closeout":[{}],"instrumentId":"string","stockExchange":"string","orderDate":"2024-01-01","orderedAt":"string","tradeDate":"2024-01-01","maturityDate":"2024-01-01","tradeCurrency":"string","priceOrPremium":0.0,"transactionType":"string","cutOffTime":"string","callOrPut":"string","strikePrice":0.0}},"responses":{"200":"DerivativesOrderResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/order/deriviativeOrders/{deriviativeOrderId}","fullPath":"/api/v1.0.0/order/deriviativeOrders/{deriviativeOrderId}","operationId":"getDerivativesOrder","name":"Retrieves the derivatives order","summary":"Retrieves the derivatives order","tags":[],"parameters":[{"name":"deriviativeOrderId","in":"path","type":"string","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":""},{"name":"companyId","in":"header","type":"string","required":false,"description":""}],"requestBodyExample":null,"responses":{"200":"DerivativesOrderResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/order/deriviativeOrders/{deriviativeOrderId}","fullPath":"/api/v1.0.0/order/deriviativeOrders/{deriviativeOrderId}","operationId":"updateDerivativesOrder","name":"Updates the derivatives order","summary":"Updates the derivatives order","tags":[],"parameters":[{"name":"deriviativeOrderId","in":"path","type":"string","required":true,"description":""},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":""},{"name":"companyId","in":"header","type":"string","required":false,"description":""}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"customers":[{}],"rates":[{}],"closeout":[{}],"instrumentId":"string","stockExchange":"string","orderDate":"2024-01-01","orderedAt":"string","tradeDate":"2024-01-01","maturityDate":"2024-01-01","tradeCurrency":"string","priceOrPremium":0.0,"transactionType":"string","cutOffTime":"string","callOrPut":"string","strikePrice":0.0}},"responses":{"200":"DerivativesOrderResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}}]},{"key":"order-directDebits-service-v1.0.0","title":"Direct Debits Management","version":"v1.0.0","description":"APIs to retrieve and manage direct debits and mandates collection details of customers or accounts. Direct debits are typically used for recurring payments, such as credit card and utility bills, where the payment amounts vary from one payment to another.","endpointCount":7,"endpoints":[{"method":"GET","path":"/order/directDebits","fullPath":"/api/v1.0.0/order/directDebits","operationId":"getAccountDirectDebits","name":"Retrieves the list of direct debits for specific account","summary":"Retrieve the direct debit details","tags":[],"parameters":[{"name":"directDebitId","in":"query","type":"string","required":false,"description":"The unique identifier of the direct debit mandate. "},{"name":"accountId","in":"query","type":"string","required":false,"description":"Identifier of the account. Often referred to as the account number, yet for consistency this is always referred to as accountId. Accepts both IBAN & BBAN"},{"name":"customerId","in":"query","type":"string","required":false,"description":"Identifier of the customer"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from t24 on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"AccountDirectDebitsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"POST","path":"/order/directDebits/{directDebitId}","fullPath":"/api/v1.0.0/order/directDebits/{directDebitId}","operationId":"createDirectDebits","name":"Creates a new direct debit record for a specific account","summary":"Create direct debit for account","tags":[],"parameters":[{"name":"directDebitId","in":"path","type":"string","required":true,"description":"The unique identifier of the direct debit mandate. "},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"overrides":[{}],"customerId":"string","displayName":"string","direction":"string","parameterId":"string","sortCode":"string","requestType":"string","currencyId":"string","currencyMarket":"string","inwardAccountId":"string","creditAccountName":"string","creditAccountId":"string","directDebitStatus":"string","standaloneAmount":0.0,"frequency":"string"}},"responses":{"200":"DirectDebitsResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/order/directDebits/{directDebitId}","fullPath":"/api/v1.0.0/order/directDebits/{directDebitId}","operationId":"updateDirectDebits","name":"Update the existing direct debit record for specific account","summary":"Update the direct debit record","tags":[],"parameters":[{"name":"directDebitId","in":"path","type":"string","required":true,"description":"The unique identifier of the direct debit mandate. "},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"overrides":[{}],"customerId":"string","displayName":"string","direction":"string","parameterId":"string","sortCode":"string","requestType":"string","currencyId":"string","currencyMarket":"string","inwardAccountId":"string","creditAccountName":"string","creditAccountId":"string","directDebitStatus":"string","standaloneAmount":0.0,"frequency":"string"}},"responses":{"200":"DirectDebitsResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/order/rejectedCollections","fullPath":"/api/v1.0.0/order/rejectedCollections","operationId":"getRejectedCollections","name":"Retrieves the list of rejected direct debits for specific account","summary":"Retrieves rejected collections","tags":[],"parameters":[{"name":"claimId","in":"query","type":"string","required":false,"description":"Reference id to track claim record"},{"name":"accountId","in":"query","type":"string","required":false,"description":"Identifier of the account. Often referred to as the account number, yet for consistency this is always referred to as accountId. Accepts both IBAN & BBAN"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from t24 on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"RejectedCollectionsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/order/directDebits/debtorMandates","fullPath":"/api/v1.0.0/order/directDebits/debtorMandates","operationId":"getDebtorDirectDebitMandates","name":"Retrieves the details from debtor mandate such as scheme, payment type, creditor information and latest collection details of the mandates of a customer or an account provided","summary":"Retrieves the debtor mandate details for the customer/account","tags":[],"parameters":[{"name":"customerId","in":"query","type":"string","required":false,"description":"Identifier of the customer"},{"name":"accountId","in":"query","type":"string","required":false,"description":"Identifier of the account. Often referred to as the account number, yet for consistency this is always referred to as accountId. Accepts both IBAN & BBAN"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from t24 on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"DebtorDirectDebitMandatesResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"PUT","path":"/order/directDebits/{directDebitId}/debtorMandates","fullPath":"/api/v1.0.0/order/directDebits/{directDebitId}/debtorMandates","operationId":"updateDebtorDirectDebitMandates","name":"Updates the existing debtor mandate with details such as scheme, creditor information, reason for amendments and latest collection details of the mandates.","summary":"Updates debtor direct debit mandate details","tags":[],"parameters":[{"name":"directDebitId","in":"path","type":"string","required":true,"description":"The unique identifier of the direct debit mandate. "},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"creditorReference":"string","creditorName":"string","ddMandateReference":"string","terminationDate":"string","maximumCollections":"string","startDate":"string","frequency":"string","endDate":"string","mandateAmendmentReasonCode":"string"}},"responses":{"200":"DebtorDirectDebitMandatesResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/order/directDebits/{directDebitId}/debtorMandates/cancellations","fullPath":"/api/v1.0.0/order/directDebits/{directDebitId}/debtorMandates/cancellations","operationId":"cancelDebtorDirectDebitMandates","name":"Updates the existing debtor mandate with status as cancelled along with the status change reasons.","summary":"Cancel the specified inward debtor direct debit mandates","tags":[],"parameters":[{"name":"directDebitId","in":"path","type":"string","required":true,"description":"The unique identifier of the direct debit mandate. "},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"cancelReason":"string"}},"responses":{"200":"DebtorDirectDebitMandatesResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}}]},{"key":"order-directDebits-service-v1.1.0","title":"Direct Debits Management","version":"v1.1.0","description":"APIs to retrieve and manage direct debits and mandates collection details of customers or accounts. Direct debits are typically used for recurring payments, such as credit card and utility bills, where the payment amounts vary from one payment to another.","endpointCount":8,"endpoints":[{"method":"GET","path":"/order/directDebits","fullPath":"/api/v1.1.0/order/directDebits","operationId":"getAccountDirectDebits","name":"Retrieves the list of direct debits for specific account","summary":"Retrieve the direct debit details","tags":[],"parameters":[{"name":"directDebitId","in":"query","type":"string","required":false,"description":"The unique identifier of the direct debit mandate. "},{"name":"accountId","in":"query","type":"string","required":false,"description":"Identifier of the account. Often referred to as the account number, yet for consistency this is always referred to as accountId. Accepts both IBAN & BBAN"},{"name":"customerId","in":"query","type":"string","required":false,"description":"Identifier of the customer"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"AccountDirectDebitsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"POST","path":"/order/directDebits/{directDebitId}","fullPath":"/api/v1.1.0/order/directDebits/{directDebitId}","operationId":"createDirectDebits","name":"Creates a new direct debit record for a specific account","summary":"Create direct debit for account","tags":[],"parameters":[{"name":"directDebitId","in":"path","type":"string","required":true,"description":"The unique identifier of the direct debit mandate. "},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"overrides":[{}],"customerId":"string","displayName":"string","direction":"string","parameterId":"string","sortCode":"string","requestType":"string","currencyId":"string","currencyMarket":"string","inwardAccountId":"string","creditAccountName":"string","creditAccountId":"string","directDebitStatus":"string","standaloneAmount":0.0,"frequency":"string"}},"responses":{"200":"DirectDebitsResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/order/directDebits/{directDebitId}","fullPath":"/api/v1.1.0/order/directDebits/{directDebitId}","operationId":"updateDirectDebits","name":"Update the existing direct debit record for specific account","summary":"Update the direct debit record","tags":[],"parameters":[{"name":"directDebitId","in":"path","type":"string","required":true,"description":"The unique identifier of the direct debit mandate. "},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"overrides":[{}],"customerId":"string","displayName":"string","direction":"string","parameterId":"string","sortCode":"string","requestType":"string","currencyId":"string","currencyMarket":"string","inwardAccountId":"string","creditAccountName":"string","creditAccountId":"string","directDebitStatus":"string","standaloneAmount":0.0,"frequency":"string"}},"responses":{"200":"DirectDebitsResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/order/directDebits/rejectedCollections","fullPath":"/api/v1.1.0/order/directDebits/rejectedCollections","operationId":"getRejectedCollections","name":"Retrieves the list of rejected direct debits for specific account","summary":"Retrieves rejected collections","tags":[],"parameters":[{"name":"claimId","in":"query","type":"string","required":false,"description":"Reference id to track claim record"},{"name":"accountId","in":"query","type":"string","required":false,"description":"Identifier of the account. Often referred to as the account number, yet for consistency this is always referred to as accountId. Accepts both IBAN & BBAN"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"RejectedCollectionsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/order/directDebits/debtorMandates","fullPath":"/api/v1.1.0/order/directDebits/debtorMandates","operationId":"getDebtorDirectDebitMandates","name":"Retrieves the details from debtor mandate such as scheme, payment type, creditor information and latest collection details of the mandates of a customer or an account provided","summary":"Retrieves the debtor mandate details for the customer/account","tags":[],"parameters":[{"name":"customerId","in":"query","type":"string","required":false,"description":"Identifier of the customer"},{"name":"accountId","in":"query","type":"string","required":false,"description":"Identifier of the account. Often referred to as the account number, yet for consistency this is always referred to as accountId. Accepts both IBAN & BBAN"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"DebtorDirectDebitMandatesResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"PUT","path":"/order/directDebits/{directDebitId}/debtorMandates/cancellations","fullPath":"/api/v1.1.0/order/directDebits/{directDebitId}/debtorMandates/cancellations","operationId":"cancelDebtorDirectDebitMandates","name":"Updates the existing debtor mandate with status as cancelled along with the status change reasons.","summary":"Cancel the specified inward debtor direct debit mandates","tags":[],"parameters":[{"name":"directDebitId","in":"path","type":"string","required":true,"description":"The unique identifier of the direct debit mandate. "},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"cancelReason":"string"}},"responses":{"200":"DebtorDirectDebitMandatesResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"POST","path":"/order/directDebits/{directDebitId}/debtorMandates","fullPath":"/api/v1.1.0/order/directDebits/{directDebitId}/debtorMandates","operationId":"createDebtorDirectDebitMandates","name":"Creates debtor mandate with details such as scheme, payment direction, creation or signing date, start and end date of mandate, cycling frequency, debtor and creditor information","summary":"Creates debtor direct debit mandates","tags":[],"parameters":[{"name":"directDebitId","in":"path","type":"string","required":true,"description":"The unique identifier of the direct debit mandate. "},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"displaynames":[{}],"debtorAddresses":[{}],"transactionNames":[{}],"direction":"string","parameterId":"string","ddMandateReference":"string","debitAccountId":"string","debitAccountName":"string","terminationDate":"2024-01-01","debitAccountIBAN":"string","creditorReference":"string","debtorAgentBIC":"string","debtorName":"string","debtorCountryCode":"string","creditorName":"string"}},"responses":{"200":"DebtorDirectDebitMandatesResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/order/directDebits/{directDebitId}/debtorMandates","fullPath":"/api/v1.1.0/order/directDebits/{directDebitId}/debtorMandates","operationId":"updateDebtorDirectDebitMandates","name":"Updates debtor mandate with details such as scheme, debtor and creditor information, reason for amendments and latest collection details of the mandates","summary":"Updates debtor direct debit mandates","tags":[],"parameters":[{"name":"directDebitId","in":"path","type":"string","required":true,"description":"The unique identifier of the direct debit mandate. "},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"displaynames":[{}],"debtorAddresses":[{}],"transactionNames":[{}],"direction":"string","parameterId":"string","ddMandateReference":"string","debitAccountId":"string","debitAccountName":"string","terminationDate":"2024-01-01","debitAccountIBAN":"string","creditorReference":"string","debtorAgentBIC":"string","debtorName":"string","debtorCountryCode":"string","creditorName":"string"}},"responses":{"200":"DebtorDirectDebitMandatesResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}}]},{"key":"order-directDebits-service-v1.2.0","title":"Direct Debits Management","version":"v1.2.0","description":"APIs to retrieve and manage direct debits and mandates collection details of customers or accounts. Direct debits are typically used for recurring payments, such as credit card and utility bills, where the payment amounts vary from one payment to another.","endpointCount":10,"endpoints":[{"method":"GET","path":"/order/directDebits","fullPath":"/api/v1.2.0/order/directDebits","operationId":"getAccountDirectDebits","name":"Retrieves the list of direct debits with details such as customer, debit and credit parties involved, status, payment start and end dates, amount, currency, direction, frequency of payments","summary":"Retrieves the direct debit details","tags":[],"parameters":[{"name":"directDebitId","in":"query","type":"string","required":false,"description":"The unique identifier of the direct debit mandate. "},{"name":"accountId","in":"query","type":"string","required":false,"description":"Identifier of the account. Often referred to as the account number, yet for consistency this is always referred to as accountId. Accepts both IBAN & BBAN"},{"name":"customerId","in":"query","type":"string","required":false,"description":"Identifier of the customer"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"AccountDirectDebitsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"POST","path":"/order/directDebits/{directDebitId}","fullPath":"/api/v1.2.0/order/directDebits/{directDebitId}","operationId":"createDirectDebits","name":"Create a new direct debit with details such as customer, debit and credit parties involved, status, payment start and end dates, amount, currency, direction, frequency of payments","summary":"Create direct debit for an account","tags":[],"parameters":[{"name":"directDebitId","in":"path","type":"string","required":true,"description":"The unique identifier of the direct debit mandate. "},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"overrides":[{}],"customerId":"string","displayName":"string","direction":"string","parameterId":"string","sortCode":"string","requestType":"string","currencyId":"string","currencyMarket":"string","inwardAccountId":"string","creditAccountName":"string","creditAccountId":"string","directDebitStatus":"string","standaloneAmount":0.0,"frequency":"string"}},"responses":{"200":"DirectDebitsResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/order/directDebits/{directDebitId}","fullPath":"/api/v1.2.0/order/directDebits/{directDebitId}","operationId":"updateDirectDebits","name":"Update direct debits with details such as customer, debit and credit parties involved, status, payment start and end dates, amount, currency, direction, frequency of payments","summary":"Update direct debit for an account","tags":[],"parameters":[{"name":"directDebitId","in":"path","type":"string","required":true,"description":"The unique identifier of the direct debit mandate. "},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"overrides":[{}],"customerId":"string","displayName":"string","direction":"string","parameterId":"string","sortCode":"string","requestType":"string","currencyId":"string","currencyMarket":"string","inwardAccountId":"string","creditAccountName":"string","creditAccountId":"string","directDebitStatus":"string","standaloneAmount":0.0,"frequency":"string"}},"responses":{"200":"DirectDebitsResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/order/directDebits/rejectedCollections","fullPath":"/api/v1.2.0/order/directDebits/rejectedCollections","operationId":"getRejectedCollections","name":"Retrieves the list of rejected direct debits collections with details such as collection reference, account, amount, payment value date and status","summary":"Retrieves rejected collections","tags":[],"parameters":[{"name":"claimId","in":"query","type":"string","required":false,"description":"Reference id to track claim record"},{"name":"accountId","in":"query","type":"string","required":false,"description":"Identifier of the account. Often referred to as the account number, yet for consistency this is always referred to as accountId. Accepts both IBAN & BBAN"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"RejectedCollectionsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/order/directDebits/debtorMandates","fullPath":"/api/v1.2.0/order/directDebits/debtorMandates","operationId":"getDebtorDirectDebitMandates","name":"Retrieves the details from debtor mandate such as scheme, payment type, creditor information and latest collection details of the mandates of a customer or an account provided","summary":"Retrieves the debtor mandate details for the customer or account","tags":[],"parameters":[{"name":"customerId","in":"query","type":"string","required":false,"description":"Identifier of the customer"},{"name":"accountId","in":"query","type":"string","required":false,"description":"Identifier of the account. Often referred to as the account number, yet for consistency this is always referred to as accountId. Accepts both IBAN & BBAN"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"DebtorDirectDebitMandatesResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"PUT","path":"/order/directDebits/{directDebitId}/debtorMandates/cancellations","fullPath":"/api/v1.2.0/order/directDebits/{directDebitId}/debtorMandates/cancellations","operationId":"cancelDebtorDirectDebitMandates","name":"Updates the existing debtor mandate with status as cancelled along with the status change reasons.","summary":"Cancel the specified inward debtor direct debit mandates","tags":[],"parameters":[{"name":"directDebitId","in":"path","type":"string","required":true,"description":"The unique identifier of the direct debit mandate. "},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"cancelReason":"string","extensions":{}}},"responses":{"200":"DebtorDirectDebitMandatesResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"POST","path":"/order/directDebits/{directDebitId}/debtorMandates","fullPath":"/api/v1.2.0/order/directDebits/{directDebitId}/debtorMandates","operationId":"createDebtorDirectDebitMandates","name":"Creates debtor mandate with details such as scheme, payment direction, creation or signing date, start and end date of mandate, cycling frequency, debtor and creditor information","summary":"Creates debtor direct debit mandates","tags":[],"parameters":[{"name":"directDebitId","in":"path","type":"string","required":true,"description":"The unique identifier of the direct debit mandate. "},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"displaynames":[{}],"debtorAddresses":[{}],"transactionNames":[{}],"direction":"string","parameterId":"string","ddMandateReference":"string","debitAccountId":"string","debitAccountName":"string","terminationDate":"2024-01-01","debitAccountIBAN":"string","creditorReference":"string","debtorAgentBIC":"string","debtorName":"string","debtorCountryCode":"string","creditorName":"string"}},"responses":{"200":"DebtorDirectDebitMandatesResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/order/directDebits/{directDebitId}/debtorMandates","fullPath":"/api/v1.2.0/order/directDebits/{directDebitId}/debtorMandates","operationId":"updateDebtorDirectDebitMandates","name":"Updates debtor mandate with details such as scheme, debtor and creditor information, reason for amendments and latest collection details of the mandates","summary":"Updates debtor direct debit mandates","tags":[],"parameters":[{"name":"directDebitId","in":"path","type":"string","required":true,"description":"The unique identifier of the direct debit mandate. "},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"displaynames":[{}],"debtorAddresses":[{}],"transactionNames":[{}],"direction":"string","parameterId":"string","ddMandateReference":"string","debitAccountId":"string","debitAccountName":"string","terminationDate":"2024-01-01","debitAccountIBAN":"string","creditorReference":"string","debtorAgentBIC":"string","debtorName":"string","debtorCountryCode":"string","creditorName":"string"}},"responses":{"200":"DebtorDirectDebitMandatesResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"POST","path":"/order/directDebits/rejectionClaimRequests","fullPath":"/api/v1.2.0/order/directDebits/rejectionClaimRequests","operationId":"createDirectDebitRejectionClaimRequest","name":"Create direct debit rejection request with details such as direct debit claim reference, rejection reason and indicates if the rejected direct debit collection must be resubmitted (retried) on a later date","summary":"Create direct debit rejection claim requests","tags":[],"parameters":[{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"rejectionReasons":[{}],"claimId":"string","rejectionReasonCode":"string","bulkReference":"string","refundOriginatorName":"string","internalRejection":"string","stopResubmitClaim":"string","resubmitValueDate":"2024-01-01","businessResubmitClaim":"string","extensions":{}}},"responses":{"200":"DirectDebitRejectionClaimRequestResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/order/directDebits/rejectionClaimRequests/{rejectionClaimRequestId}","fullPath":"/api/v1.2.0/order/directDebits/rejectionClaimRequests/{rejectionClaimRequestId}","operationId":"updateDirectDebitRejectionClaimRequest","name":"Update direct debit rejection request with details such as rejection reason, resubmit claim and resubmit date to process the rejection received for outward claims and to do resubmissions if required","summary":"Update direct debit rejection claim requests","tags":[],"parameters":[{"name":"rejectionClaimRequestId","in":"path","type":"string","required":true,"description":"Identifier of direct debit return requests"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"rejectionReasons":[{}],"claimId":"string","rejectionReasonCode":"string","bulkReference":"string","refundOriginatorName":"string","internalRejection":"string","stopResubmitClaim":"string","resubmitValueDate":"2024-01-01","businessResubmitClaim":"string","extensions":{}}},"responses":{"200":"DirectDebitRejectionClaimRequestResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}}]},{"key":"order-directDebits-service-v1.3.0","title":"Direct Debits Management","version":"v1.3.0","description":"APIs to retrieve and manage direct debits and mandates collection details of customers or accounts. Direct debits are typically used for recurring payments, such as credit card and utility bills, where the payment amounts vary from one payment to another.","endpointCount":13,"endpoints":[{"method":"GET","path":"/order/directDebits","fullPath":"/api/v1.3.0/order/directDebits","operationId":"getAccountDirectDebits","name":"Retrieves the list of direct debits with details such as customer, debit and credit parties involved, status, payment start and end dates, amount, currency, direction, frequency of payments","summary":"Retrieves the direct debit details","tags":[],"parameters":[{"name":"directDebitId","in":"query","type":"string","required":false,"description":"The unique identifier of the direct debit mandate. "},{"name":"accountId","in":"query","type":"string","required":false,"description":"Identifier of the account. Often referred to as the account number, yet for consistency this is always referred to as accountId. Accepts both IBAN & BBAN"},{"name":"customerId","in":"query","type":"string","required":false,"description":"Identifier of the customer"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"AccountDirectDebitsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"POST","path":"/order/directDebits/{directDebitId}","fullPath":"/api/v1.3.0/order/directDebits/{directDebitId}","operationId":"createDirectDebits","name":"Create a new direct debit with details such as customer, debit and credit parties involved, status, payment start and end dates, amount, currency, direction, frequency of payments","summary":"Create direct debit for an account","tags":[],"parameters":[{"name":"directDebitId","in":"path","type":"string","required":true,"description":"The unique identifier of the direct debit mandate. "},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"overrides":[{}],"customerId":"string","displayName":"string","direction":"string","parameterId":"string","sortCode":"string","requestType":"string","currencyId":"string","currencyMarket":"string","inwardAccountId":"string","creditAccountName":"string","creditAccountId":"string","directDebitStatus":"string","standaloneAmount":0.0,"frequency":"string"}},"responses":{"200":"DirectDebitsResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/order/directDebits/{directDebitId}","fullPath":"/api/v1.3.0/order/directDebits/{directDebitId}","operationId":"updateDirectDebits","name":"Update direct debits with details such as customer, debit and credit parties involved, status, payment start and end dates, amount, currency, direction, frequency of payments","summary":"Update direct debit for an account","tags":[],"parameters":[{"name":"directDebitId","in":"path","type":"string","required":true,"description":"The unique identifier of the direct debit mandate. "},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"overrides":[{}],"customerId":"string","displayName":"string","direction":"string","parameterId":"string","sortCode":"string","requestType":"string","currencyId":"string","currencyMarket":"string","inwardAccountId":"string","creditAccountName":"string","creditAccountId":"string","directDebitStatus":"string","standaloneAmount":0.0,"frequency":"string"}},"responses":{"200":"DirectDebitsResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/order/directDebits/rejectedCollections","fullPath":"/api/v1.3.0/order/directDebits/rejectedCollections","operationId":"getRejectedCollections","name":"Retrieves the list of rejected direct debits collections with details such as collection reference, account, amount, payment value date and status","summary":"Retrieves rejected collections","tags":[],"parameters":[{"name":"claimId","in":"query","type":"string","required":false,"description":"Reference id to track claim record"},{"name":"accountId","in":"query","type":"string","required":false,"description":"Identifier of the account. Often referred to as the account number, yet for consistency this is always referred to as accountId. Accepts both IBAN & BBAN"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"RejectedCollectionsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/order/directDebits/debtorMandates","fullPath":"/api/v1.3.0/order/directDebits/debtorMandates","operationId":"getDebtorDirectDebitMandates","name":"Retrieves the details from debtor mandate such as scheme, payment type, creditor information and latest collection details of the mandates of a customer or an account provided","summary":"Retrieves the debtor mandate details for the customer or account","tags":[],"parameters":[{"name":"customerId","in":"query","type":"string","required":false,"description":"Identifier of the customer"},{"name":"accountId","in":"query","type":"string","required":false,"description":"Identifier of the account. Often referred to as the account number, yet for consistency this is always referred to as accountId. Accepts both IBAN & BBAN"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"DebtorDirectDebitMandatesResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"PUT","path":"/order/directDebits/{directDebitId}/debtorMandates/cancellations","fullPath":"/api/v1.3.0/order/directDebits/{directDebitId}/debtorMandates/cancellations","operationId":"cancelDebtorDirectDebitMandates","name":"Updates the existing debtor mandate with status as cancelled along with the status change reasons.","summary":"Cancel the specified inward debtor direct debit mandates","tags":[],"parameters":[{"name":"directDebitId","in":"path","type":"string","required":true,"description":"The unique identifier of the direct debit mandate. "},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"cancelReason":"string","extensions":{}}},"responses":{"200":"DebtorDirectDebitMandatesResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"POST","path":"/order/directDebits/{directDebitId}/debtorMandates","fullPath":"/api/v1.3.0/order/directDebits/{directDebitId}/debtorMandates","operationId":"createDebtorDirectDebitMandates","name":"Creates debtor mandate with details such as scheme, payment direction, creation or signing date, start and end date of mandate, cycling frequency, debtor and creditor information","summary":"Creates debtor direct debit mandates","tags":[],"parameters":[{"name":"directDebitId","in":"path","type":"string","required":true,"description":"The unique identifier of the direct debit mandate. "},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"displaynames":[{}],"debtorAddresses":[{}],"transactionNames":[{}],"direction":"string","parameterId":"string","ddMandateReference":"string","debitAccountId":"string","debitAccountName":"string","terminationDate":"2024-01-01","debitAccountIBAN":"string","creditorReference":"string","debtorAgentBIC":"string","debtorName":"string","debtorCountryCode":"string","creditorName":"string"}},"responses":{"200":"DebtorDirectDebitMandatesResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/order/directDebits/{directDebitId}/debtorMandates","fullPath":"/api/v1.3.0/order/directDebits/{directDebitId}/debtorMandates","operationId":"updateDebtorDirectDebitMandates","name":"Updates debtor mandate with details such as scheme, debtor and creditor information, reason for amendments and latest collection details of the mandates","summary":"Updates debtor direct debit mandates","tags":[],"parameters":[{"name":"directDebitId","in":"path","type":"string","required":true,"description":"The unique identifier of the direct debit mandate. "},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"displaynames":[{}],"debtorAddresses":[{}],"transactionNames":[{}],"direction":"string","parameterId":"string","ddMandateReference":"string","debitAccountId":"string","debitAccountName":"string","terminationDate":"2024-01-01","debitAccountIBAN":"string","creditorReference":"string","debtorAgentBIC":"string","debtorName":"string","debtorCountryCode":"string","creditorName":"string"}},"responses":{"200":"DebtorDirectDebitMandatesResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"POST","path":"/order/directDebits/rejectionClaimRequests","fullPath":"/api/v1.3.0/order/directDebits/rejectionClaimRequests","operationId":"createDirectDebitRejectionClaimRequest","name":"Create direct debit rejection request with details such as direct debit claim reference, rejection reason and indicates if the rejected direct debit collection must be resubmitted (retried) on a later date","summary":"Create direct debit rejection claim requests","tags":[],"parameters":[{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"rejectionReasons":[{}],"claimId":"string","rejectionReasonCode":"string","bulkReference":"string","refundOriginatorName":"string","internalRejection":"string","stopResubmitClaim":"string","resubmitValueDate":"2024-01-01","businessResubmitClaim":"string","extensions":{}}},"responses":{"200":"DirectDebitRejectionClaimRequestResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/order/directDebits/rejectionClaimRequests/{rejectionClaimRequestId}","fullPath":"/api/v1.3.0/order/directDebits/rejectionClaimRequests/{rejectionClaimRequestId}","operationId":"updateDirectDebitRejectionClaimRequest","name":"Update direct debit rejection request with details such as rejection reason, resubmit claim and resubmit date to process the rejection received for outward claims and to do resubmissions if required","summary":"Update direct debit rejection claim requests","tags":[],"parameters":[{"name":"rejectionClaimRequestId","in":"path","type":"string","required":true,"description":"Identifier of direct debit return requests"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"rejectionReasons":[{}],"claimId":"string","rejectionReasonCode":"string","bulkReference":"string","refundOriginatorName":"string","internalRejection":"string","stopResubmitClaim":"string","resubmitValueDate":"2024-01-01","businessResubmitClaim":"string","extensions":{}}},"responses":{"200":"DirectDebitRejectionClaimRequestResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"POST","path":"/order/directDebits/{directDebitId}/creditorMandates","fullPath":"/api/v1.3.0/order/directDebits/{directDebitId}/creditorMandates","operationId":"createCreditorDirectDebits","name":"Create the creditor direct debit mandate. User need to pass the account for which the mandate should be created","summary":"Create outward direct debit mandate","tags":[],"parameters":[{"name":"directDebitId","in":"path","type":"string","required":true,"description":"The unique identifier of the direct debit mandate. "},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"signatories":[{}],"futureDetails":[{}],"creditorAddresses":[{}],"debtorAddresses":[{}],"debtorSignatures":[{}],"ultimateDebtorNames":[{}],"contractDetails":[{}],"debtorBankNames":[{}],"debtorBankPostalAddresses":[{}],"displayName":"string","directDebitParameterId":"string","ddMandateReference":"string","mandateOrigin":"string","destinationAccountId":"string","destinationAccountName":"string"}},"responses":{"200":"CreditorDirectDebitsResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/order/directDebits/creditorMandates/{creditorMandateId}/collections","fullPath":"/api/v1.3.0/order/directDebits/creditorMandates/{creditorMandateId}/collections","operationId":"getCreditorDirectDebitCollections","name":"Retrieve all the direct debit collections of the particular creditor direct debit mandate for the required tenure with creditor direct debit mandate reference id","summary":"Retrieves direct debit collections initiated for creditor direct debit mandate","tags":[],"parameters":[{"name":"creditorMandateId","in":"path","type":"string","required":true,"description":"Contains the creditor mandate identifier"},{"name":"claimStatus","in":"query","type":"string","required":false,"description":"Status update of the claim records"},{"name":"valueDate","in":"query","type":"string","required":false,"description":"Contains the value date of the claim or the date on which the amount to be claimed"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"CreditorDirectDebitCollectionsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"PUT","path":"/order/directDebits/{directDebitId}/creditorMandates/cancellations","fullPath":"/api/v1.3.0/order/directDebits/{directDebitId}/creditorMandates/cancellations","operationId":"cancelCreditorDirectDebits","name":"Cancel the creditor direct debit mandate with the mandate reference id","summary":"Cancel outward direct debit mandate","tags":[],"parameters":[{"name":"directDebitId","in":"path","type":"string","required":true,"description":"The unique identifier of the direct debit mandate. "},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"cancelReason":"string","extensions":{}}},"responses":{"200":"CreditorDirectDebitsResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}}]},{"key":"order-directDebits-service-v1.4.0","title":"Direct Debits Management","version":"v1.4.0","description":"APIs to retrieve and manage direct debits and mandates collection details of customers or accounts. Direct debits are typically used for recurring payments, such as credit card and utility bills, where the payment amounts vary from one payment to another.","endpointCount":15,"endpoints":[{"method":"GET","path":"/order/directDebits","fullPath":"/api/v1.4.0/order/directDebits","operationId":"getAccountDirectDebits","name":"Retrieves the list of direct debits with details such as customer, debit and credit parties involved, status, payment start and end dates, amount, currency, direction, frequency of payments","summary":"Retrieves the direct debit details","tags":[],"parameters":[{"name":"directDebitId","in":"query","type":"string","required":false,"description":"The unique identifier of the direct debit mandate. "},{"name":"accountId","in":"query","type":"string","required":false,"description":"Identifier of the account. Often referred to as the account number, yet for consistency this is always referred to as accountId. Accepts both IBAN & BBAN"},{"name":"customerId","in":"query","type":"string","required":false,"description":"Identifier of the customer"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"AccountDirectDebitsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"POST","path":"/order/directDebits/{directDebitId}","fullPath":"/api/v1.4.0/order/directDebits/{directDebitId}","operationId":"createDirectDebits","name":"Create a new direct debit with details such as customer, debit and credit parties involved, status, payment start and end dates, amount, currency, direction, frequency of payments","summary":"Create direct debit for an account","tags":[],"parameters":[{"name":"directDebitId","in":"path","type":"string","required":true,"description":"The unique identifier of the direct debit mandate. "},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"overrides":[{}],"customerId":"string","displayName":"string","direction":"string","parameterId":"string","sortCode":"string","requestType":"string","currencyId":"string","currencyMarket":"string","inwardAccountId":"string","creditAccountName":"string","creditAccountId":"string","directDebitStatus":"string","standaloneAmount":0.0,"frequency":"string"}},"responses":{"200":"DirectDebitsResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/order/directDebits/{directDebitId}","fullPath":"/api/v1.4.0/order/directDebits/{directDebitId}","operationId":"updateDirectDebits","name":"Update direct debits with details such as customer, debit and credit parties involved, status, payment start and end dates, amount, currency, direction, frequency of payments","summary":"Update direct debit for an account","tags":[],"parameters":[{"name":"directDebitId","in":"path","type":"string","required":true,"description":"The unique identifier of the direct debit mandate. "},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"overrides":[{}],"customerId":"string","displayName":"string","direction":"string","parameterId":"string","sortCode":"string","requestType":"string","currencyId":"string","currencyMarket":"string","inwardAccountId":"string","creditAccountName":"string","creditAccountId":"string","directDebitStatus":"string","standaloneAmount":0.0,"frequency":"string"}},"responses":{"200":"DirectDebitsResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/order/directDebits/rejectedCollections","fullPath":"/api/v1.4.0/order/directDebits/rejectedCollections","operationId":"getRejectedCollections","name":"Retrieves the list of rejected direct debits collections with details such as collection reference, account, amount, payment value date and status","summary":"Retrieves rejected collections","tags":[],"parameters":[{"name":"claimId","in":"query","type":"string","required":false,"description":"Reference id to track claim record"},{"name":"accountId","in":"query","type":"string","required":false,"description":"Identifier of the account. Often referred to as the account number, yet for consistency this is always referred to as accountId. Accepts both IBAN & BBAN"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"RejectedCollectionsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/order/directDebits/debtorMandates","fullPath":"/api/v1.4.0/order/directDebits/debtorMandates","operationId":"getDebtorDirectDebitMandates","name":"Retrieves the details from debtor mandate such as scheme, payment type, creditor information and latest collection details of the mandates of a customer or an account provided","summary":"Retrieves the debtor mandate details for the customer or account","tags":[],"parameters":[{"name":"customerId","in":"query","type":"string","required":false,"description":"Identifier of the customer"},{"name":"accountId","in":"query","type":"string","required":false,"description":"Identifier of the account. Often referred to as the account number, yet for consistency this is always referred to as accountId. Accepts both IBAN & BBAN"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"DebtorDirectDebitMandatesResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"PUT","path":"/order/directDebits/{directDebitId}/debtorMandates/cancellations","fullPath":"/api/v1.4.0/order/directDebits/{directDebitId}/debtorMandates/cancellations","operationId":"cancelDebtorDirectDebitMandates","name":"Updates the existing debtor mandate with status as cancelled along with the status change reasons.","summary":"Cancel the specified inward debtor direct debit mandates","tags":[],"parameters":[{"name":"directDebitId","in":"path","type":"string","required":true,"description":"The unique identifier of the direct debit mandate. "},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"cancelReason":"string","extensions":{}}},"responses":{"200":"DebtorDirectDebitMandatesResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"POST","path":"/order/directDebits/{directDebitId}/debtorMandates","fullPath":"/api/v1.4.0/order/directDebits/{directDebitId}/debtorMandates","operationId":"createDebtorDirectDebitMandates","name":"Creates debtor mandate with details such as scheme, payment direction, creation or signing date, start and end date of mandate, cycling frequency, debtor and creditor information","summary":"Creates debtor direct debit mandates","tags":[],"parameters":[{"name":"directDebitId","in":"path","type":"string","required":true,"description":"The unique identifier of the direct debit mandate. "},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"displaynames":[{}],"debtorAddresses":[{}],"transactionNames":[{}],"direction":"string","parameterId":"string","ddMandateReference":"string","debitAccountId":"string","debitAccountName":"string","terminationDate":"2024-01-01","debitAccountIBAN":"string","creditorReference":"string","debtorAgentBIC":"string","debtorName":"string","debtorCountryCode":"string","creditorName":"string"}},"responses":{"200":"DebtorDirectDebitMandatesResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/order/directDebits/{directDebitId}/debtorMandates","fullPath":"/api/v1.4.0/order/directDebits/{directDebitId}/debtorMandates","operationId":"updateDebtorDirectDebitMandates","name":"Updates debtor mandate with details such as scheme, debtor and creditor information, reason for amendments and latest collection details of the mandates","summary":"Updates debtor direct debit mandates","tags":[],"parameters":[{"name":"directDebitId","in":"path","type":"string","required":true,"description":"The unique identifier of the direct debit mandate. "},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"displaynames":[{}],"debtorAddresses":[{}],"transactionNames":[{}],"direction":"string","parameterId":"string","ddMandateReference":"string","debitAccountId":"string","debitAccountName":"string","terminationDate":"2024-01-01","debitAccountIBAN":"string","creditorReference":"string","debtorAgentBIC":"string","debtorName":"string","debtorCountryCode":"string","creditorName":"string"}},"responses":{"200":"DebtorDirectDebitMandatesResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"POST","path":"/order/directDebits/rejectionClaimRequests","fullPath":"/api/v1.4.0/order/directDebits/rejectionClaimRequests","operationId":"createDirectDebitRejectionClaimRequest","name":"Create direct debit rejection request with details such as direct debit claim reference, rejection reason and indicates if the rejected direct debit collection must be resubmitted (retried) on a later date","summary":"Create direct debit rejection claim requests","tags":[],"parameters":[{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"rejectionReasons":[{}],"claimId":"string","rejectionReasonCode":"string","bulkReference":"string","refundOriginatorName":"string","internalRejection":"string","stopResubmitClaim":"string","resubmitValueDate":"2024-01-01","businessResubmitClaim":"string","extensions":{}}},"responses":{"200":"DirectDebitRejectionClaimRequestResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/order/directDebits/rejectionClaimRequests/{rejectionClaimRequestId}","fullPath":"/api/v1.4.0/order/directDebits/rejectionClaimRequests/{rejectionClaimRequestId}","operationId":"updateDirectDebitRejectionClaimRequest","name":"Update direct debit rejection request with details such as rejection reason, resubmit claim and resubmit date to process the rejection received for outward claims and to do resubmissions if required","summary":"Update direct debit rejection claim requests","tags":[],"parameters":[{"name":"rejectionClaimRequestId","in":"path","type":"string","required":true,"description":"Identifier of direct debit return requests"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"rejectionReasons":[{}],"claimId":"string","rejectionReasonCode":"string","bulkReference":"string","refundOriginatorName":"string","internalRejection":"string","stopResubmitClaim":"string","resubmitValueDate":"2024-01-01","businessResubmitClaim":"string","extensions":{}}},"responses":{"200":"DirectDebitRejectionClaimRequestResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"POST","path":"/order/directDebits/{directDebitId}/creditorMandates","fullPath":"/api/v1.4.0/order/directDebits/{directDebitId}/creditorMandates","operationId":"createCreditorDirectDebits","name":"Create the creditor direct debit mandate. User need to pass the account for which the mandate should be created","summary":"Create outward direct debit mandate","tags":[],"parameters":[{"name":"directDebitId","in":"path","type":"string","required":true,"description":"The unique identifier of the direct debit mandate. "},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"signatories":[{}],"futureDetails":[{}],"creditorAddresses":[{}],"debtorAddresses":[{}],"debtorSignatures":[{}],"ultimateDebtorNames":[{}],"contractDetails":[{}],"debtorBankNames":[{}],"debtorBankPostalAddresses":[{}],"displayName":"string","directDebitParameterId":"string","ddMandateReference":"string","mandateOrigin":"string","destinationAccountId":"string","destinationAccountName":"string"}},"responses":{"200":"CreditorDirectDebitsResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/order/directDebits/{directDebitId}/creditorMandates","fullPath":"/api/v1.4.0/order/directDebits/{directDebitId}/creditorMandates","operationId":"updateCreditorDirectDebits","name":"Update the mandate information in the existing active creditor direct debit mandate","summary":"Amend outward direct debit mandate","tags":[],"parameters":[{"name":"directDebitId","in":"path","type":"string","required":true,"description":"The unique identifier of the direct debit mandate. "},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"displayNames":[{}],"signatories":[{}],"futureDetails":[{}],"creditorAddresses":[{}],"debtorBankNames":[{}],"debtorAddresses":[{}],"debtorSignatures":[{}],"destinationAccountId":"string","destinationAccountName":"string","returnCode":"string","returnReason":"string","directDebitStatus":"string","frequency":"string","terminationDate":"string","standaloneAmount":"string"}},"responses":{"200":"CreditorDirectDebitsResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/order/directDebits/creditorMandates/{creditorMandateId}/collections","fullPath":"/api/v1.4.0/order/directDebits/creditorMandates/{creditorMandateId}/collections","operationId":"getCreditorDirectDebitCollections","name":"Retrieve all the direct debit collections of the particular creditor direct debit mandate for the required tenure with creditor direct debit mandate reference id","summary":"Retrieves direct debit collections initiated for creditor direct debit mandate","tags":[],"parameters":[{"name":"creditorMandateId","in":"path","type":"string","required":true,"description":"Contains the creditor mandate identifier"},{"name":"claimStatus","in":"query","type":"string","required":false,"description":"Status update of the claim records"},{"name":"valueDate","in":"query","type":"string","required":false,"description":"Contains the value date of the claim or the date on which the amount to be claimed"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"CreditorDirectDebitCollectionsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"PUT","path":"/order/directDebits/{directDebitId}/creditorMandates/cancellations","fullPath":"/api/v1.4.0/order/directDebits/{directDebitId}/creditorMandates/cancellations","operationId":"cancelCreditorDirectDebits","name":"Cancel the creditor direct debit mandate with the mandate reference id","summary":"Cancel outward direct debit mandate","tags":[],"parameters":[{"name":"directDebitId","in":"path","type":"string","required":true,"description":"The unique identifier of the direct debit mandate. "},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"cancelReason":"string","extensions":{}}},"responses":{"200":"CreditorDirectDebitsResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/order/directDebits/{accountId}/creditorMandates/mandates","fullPath":"/api/v1.4.0/order/directDebits/{accountId}/creditorMandates/mandates","operationId":"getCreditorDirectDebitMandates","name":"Retrieve the creditor direct debit mandate details of the customer such as debtor information, payment type ,scheme etc.. with the specific account number provided","summary":"Retrieves creditor direct debit mandates","tags":[],"parameters":[{"name":"accountId","in":"path","type":"string","required":true,"description":"Identifier of the account. Often referred to as the account number, yet for consistency this is always referred to as accountId. Accepts both IBAN & BBAN"},{"name":"customer","in":"query","type":"string","required":false,"description":"Contains the customer of the creditor mandates that must be retrieved "},{"name":"directDebitId","in":"query","type":"string","required":false,"description":"The unique identifier of the direct debit mandate. "},{"name":"standAloneDdi","in":"query","type":"string","required":false,"description":"Defines whether the direct debit mandate is for stand-alone purpose i.e. one-off instruction"},{"name":"directDebitStatus","in":"query","type":"string","required":false,"description":"The status of direct debit mandate i.e. New, Advised, Hold, Active, Available, Returned or Cancelled. Only when the status is Active or Available, the instruction will be sent out for collecting funds"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"CreditorDirectDebitMandatesResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}}]},{"key":"order-fiduciaryOrders-service-v1.0.0","title":"Fiduciary Orders","version":"v1.0.0","description":"Allows to view,create,update and premature the fiduciary orders","endpointCount":4,"endpoints":[{"method":"POST","path":"/order/fiduciaryOrders/fiduciaryOrderInitiations","fullPath":"/api/v1.0.0/order/fiduciaryOrders/fiduciaryOrderInitiations","operationId":"createFiduciaryOrderInitiation","name":"Creates a fiduciary order","summary":"Creates a fiduciary order","tags":[],"parameters":[{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":""},{"name":"companyId","in":"header","type":"string","required":false,"description":""}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"customerInstructions":[{}],"frontOfficeInstructions":[{}],"dealerInstructions":[{}],"chargeDetails":[{}],"splitAmounts":[{}],"customerId":"string","portfolioId":"string","fiduciaryOrderType":"string","bicId":"string","currencyId":"string","depositAmount":0.0,"orderDate":"2024-01-01","valueDate":"2024-01-01","maturityDate":"2024-01-01","depositTerm":"string"}},"responses":{"200":"FiduciaryOrderInitiationResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/order/fiduciaryOrders/fiduciaryOrderInitiations/{fiduciaryOrderId}","fullPath":"/api/v1.0.0/order/fiduciaryOrders/fiduciaryOrderInitiations/{fiduciaryOrderId}","operationId":"getFiduciaryOrderInitiation","name":"Retrieves the fiduciary order","summary":"Retrieves the fiduciary order","tags":[],"parameters":[{"name":"fiduciaryOrderId","in":"path","type":"string","required":true,"description":"Key or Identifier of the Fiduciary Order"},{"name":"credentials","in":"header","type":"string","required":false,"description":""},{"name":"companyId","in":"header","type":"string","required":false,"description":""}],"requestBodyExample":null,"responses":{"200":"FiduciaryOrderInitiationResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/order/fiduciaryOrders/fiduciaryOrderInitiations/{fiduciaryOrderId}","fullPath":"/api/v1.0.0/order/fiduciaryOrders/fiduciaryOrderInitiations/{fiduciaryOrderId}","operationId":"updateFiduciaryOrderInitiation","name":"Updates the fiduciary order","summary":"Updates the fiduciary order","tags":[],"parameters":[{"name":"fiduciaryOrderId","in":"path","type":"string","required":true,"description":"Key or Identifier of the Fiduciary Order"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":""},{"name":"companyId","in":"header","type":"string","required":false,"description":""}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"customerInstructions":[{}],"frontOfficeInstructions":[{}],"dealerInstructions":[{}],"chargeDetails":[{}],"splitAmounts":[{}],"customerId":"string","portfolioId":"string","fiduciaryOrderType":"string","bicId":"string","currencyId":"string","depositAmount":0.0,"orderDate":"2024-01-01","valueDate":"2024-01-01","maturityDate":"2024-01-01","depositTerm":"string"}},"responses":{"200":"FiduciaryOrderInitiationResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/order/fiduciaryOrders/{fiduciaryOrderId}/prematures","fullPath":"/api/v1.0.0/order/fiduciaryOrders/{fiduciaryOrderId}/prematures","operationId":"updateFiduciaryOrderMaturity","name":"Updates the early maturity date in a fiduciary order","summary":"Updates the fiduciary order","tags":[],"parameters":[{"name":"fiduciaryOrderId","in":"path","type":"string","required":true,"description":"Key or Identifier of the Fiduciary Order"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":""},{"name":"companyId","in":"header","type":"string","required":false,"description":""}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"customerId":"string","fiduciaryOrderType":"string","currencyId":"string","depositAmount":0.0,"orderDate":"2024-01-01","valueDate":"2024-01-01","maturityDate":"2024-01-01","earlyMaturityDate":"2024-01-01","penaltyCommissionType":"string","penaltyCommissionRate":0.0,"defaultPenaltyCommissionRate":0.0,"penaltyCommissionAmount":0.0,"defaultPenaltyCommissionAmount":0.0,"contractId":"string","status":"string"}},"responses":{"200":"FiduciaryOrderMaturityResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}}]},{"key":"order-fiduciaryOrders-service-v1.1.0","title":"Fiduciary Orders","version":"v1.1.0","description":"Allows to view,create,update and premature the fiduciary orders","endpointCount":4,"endpoints":[{"method":"POST","path":"/order/fiduciaryOrders/fiduciaryOrderInitiations","fullPath":"/api/v1.1.0/order/fiduciaryOrders/fiduciaryOrderInitiations","operationId":"createFiduciaryOrderInitiation","name":"Creates a fiduciary order","summary":"Creates a fiduciary order","tags":[],"parameters":[{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"customerInstructions":[{}],"frontOfficeInstructions":[{}],"dealerInstructions":[{}],"chargeDetails":[{}],"splitAmounts":[{}],"customerId":"string","portfolioId":"string","fiduciaryOrderType":"string","bicId":"string","currencyId":"string","depositAmount":0.0,"orderDate":"2024-01-01","valueDate":"2024-01-01","maturityDate":"2024-01-01","depositTerm":"string"}},"responses":{"200":"FiduciaryOrderInitiationResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/order/fiduciaryOrders/fiduciaryOrderInitiations/{fiduciaryOrderId}","fullPath":"/api/v1.1.0/order/fiduciaryOrders/fiduciaryOrderInitiations/{fiduciaryOrderId}","operationId":"getFiduciaryOrderInitiation","name":"Retrieves the fiduciary order","summary":"Retrieves the fiduciary order","tags":[],"parameters":[{"name":"fiduciaryOrderId","in":"path","type":"string","required":true,"description":"Key or Identifier of the Fiduciary Order"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"FiduciaryOrderInitiationResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/order/fiduciaryOrders/fiduciaryOrderInitiations/{fiduciaryOrderId}","fullPath":"/api/v1.1.0/order/fiduciaryOrders/fiduciaryOrderInitiations/{fiduciaryOrderId}","operationId":"updateFiduciaryOrderInitiation","name":"Updates the fiduciary order","summary":"Updates the fiduciary order","tags":[],"parameters":[{"name":"fiduciaryOrderId","in":"path","type":"string","required":true,"description":"Key or Identifier of the Fiduciary Order"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"customerInstructions":[{}],"frontOfficeInstructions":[{}],"dealerInstructions":[{}],"chargeDetails":[{}],"splitAmounts":[{}],"customerId":"string","portfolioId":"string","fiduciaryOrderType":"string","bicId":"string","currencyId":"string","depositAmount":0.0,"orderDate":"2024-01-01","valueDate":"2024-01-01","maturityDate":"2024-01-01","depositTerm":"string"}},"responses":{"200":"FiduciaryOrderInitiationResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/order/fiduciaryOrders/{fiduciaryOrderId}/prematures","fullPath":"/api/v1.1.0/order/fiduciaryOrders/{fiduciaryOrderId}/prematures","operationId":"updateFiduciaryOrderMaturity","name":"Updates the early maturity date in a fiduciary order","summary":"Updates the early maturity date in a fiduciary order","tags":[],"parameters":[{"name":"fiduciaryOrderId","in":"path","type":"string","required":true,"description":"Key or Identifier of the Fiduciary Order"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"customerId":"string","fiduciaryOrderType":"string","currencyId":"string","depositAmount":0.0,"orderDate":"2024-01-01","valueDate":"2024-01-01","maturityDate":"2024-01-01","earlyMaturityDate":"2024-01-01","penaltyCommissionType":"string","penaltyCommissionRate":0.0,"defaultPenaltyCommissionRate":0.0,"penaltyCommissionAmount":0.0,"defaultPenaltyCommissionAmount":0.0,"contractId":"string","status":"string"}},"responses":{"200":"FiduciaryOrderMaturityResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}}]},{"key":"order-forexCustomerOrders-service-v1.0.0","title":"Treasury forex orders","version":"v1.0.0","description":"API to create, update and manage different types of foreign exchange deals such as spot, forward, swap and limit orders for a customer to buy/sell currencies at the desired exchange rates and at the predetermined dates.","endpointCount":7,"endpoints":[{"method":"GET","path":"/order/forexOrders/limitOrders/{limitOrderId}","fullPath":"/api/v1.0.0/v1.0.0/order/forexOrders/limitOrders/{limitOrderId}","operationId":"getCustomerForexLimitOrders","name":"Retrieves forex orders created for the given customer to buy/sell currencies at desired rates and specified dates along with the order status(active,cancelled etc.)","summary":"Retrieves forex orders created for customers to buy/sell currencies at desired rates","tags":[],"parameters":[{"name":"limitOrderId","in":"path","type":"string","required":true,"description":""},{"name":"customerId","in":"query","type":"string","required":false,"description":"Identifier of the customer"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from t24 on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"The identifier of the underlying Entity/Company/Branch."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"CustomerForexLimitOrdersResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"PUT","path":"/order/forexOrders/limitOrders/{limitOrderId}","fullPath":"/api/v1.0.0/v1.0.0/order/forexOrders/limitOrders/{limitOrderId}","operationId":"updateForexLimitOrder","name":"Cancels an existing forex limit order of a customer","summary":"Cancels an existing forex limit order","tags":[],"parameters":[{"name":"limitOrderId","in":"path","type":"string","required":true,"description":""},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"The identifier of the underlying Entity/Company/Branch."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"orderCurrency":"string","contraCurrency":"string","orderAmount":"string","cancelOrder":"string","remarks":"string"}},"responses":{"200":"ForexLimitOrderResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"POST","path":"/order/forexOrders/limitOrders","fullPath":"/api/v1.0.0/v1.0.0/order/forexOrders/limitOrders","operationId":"createForexLimitOrder","name":"Creates forex limit order for a customer and also displays the list of existing limit orders ","summary":"Creates forex limit order for a customer","tags":[],"parameters":[{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"The identifier of the underlying Entity/Company/Branch."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"buyOrSells":[{}],"dealType":"string","customerId":"string","dealerDesk":"string","orderCurrency":"string","contraCurrency":"string","valueDate":"string","expiryDate":"string","expiryTime":"string","goodTillCancel":"string","orderType":"string","receiveAccount":"string","payAccount":"string","remarks":"string"}},"responses":{"200":"ForexLimitOrderResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/order/forexOrders/customers/{customerId}","fullPath":"/api/v1.0.0/v1.0.0/order/forexOrders/customers/{customerId}","operationId":"getCustomerForexDeals","name":"Retrieves the forex deals created out of the forex limit order to buy/sell currencies at customer specified rates","summary":"Retrieves the forex deals created out of the forex limit order of the given customer","tags":[],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"Identifier of the customer"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from t24 on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"The identifier of the underlying Entity/Company/Branch."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"CustomerForexDealsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/order/forexOrders","fullPath":"/api/v1.0.0/v1.0.0/order/forexOrders","operationId":"getForexOrders","name":"Retrieves the open position for different currencies","summary":"Retrieves the open position","tags":[],"parameters":[{"name":"currencyId","in":"query","type":"string","required":false,"description":"Identifier of the currency. This is the 3-letter ISO 4217 code of the currency."},{"name":"dealerDeskId","in":"query","type":"string","required":false,"description":"The dealer/desk responsible for monitoring and managing the currency positions."},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from t24 on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"The identifier of the underlying Entity/Company/Branch."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"ForexOrdersResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"POST","path":"/order/forexOrders","fullPath":"/api/v1.0.0/v1.0.0/order/forexOrders","operationId":"createForexOrder","name":"Creates foreign exchange deal","summary":"Creates foreign exchange deal","tags":[],"parameters":[{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"The identifier of the underlying Entity/Company/Branch."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"customerName":"string","dealDate":"string","buyDate":"string","buyCurrency":"string","sellCurrency":"string","baseCurrency":"string","buyAmount":"string","sellAmount":"string","treasuryRate":"string","portfolioId":"string","dealType":"string","dealerDesk":"string","treasuryCustomer":"string","marginPercent":"string","marginPips":"string"}},"responses":{"200":"ForexOrderResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/order/forexOrders/outstandingOrders","fullPath":"/api/v1.0.0/v1.0.0/order/forexOrders/outstandingOrders","operationId":"getOutstandingForexOrders","name":"Retrieves the foreign exchange outstanding(active) deals as on today ","summary":"Retrieves all the foreign exchange active deals as on today","tags":[],"parameters":[{"name":"dealType","in":"query","type":"string","required":false,"description":"Foreign Exchange deal type. Allowed values: - SP(spot) - FW(forward) - SW(Swap)"},{"name":"counterparty","in":"query","type":"string","required":false,"description":"The counterparty ID  for the  deal."},{"name":"transactionId","in":"query","type":"string","required":false,"description":"Unique transaction identifier for retrieving the details of the transaction. For example: FT0102030333 etc."},{"name":"swapId","in":"query","type":"string","required":false,"description":"Swap contract identifier"},{"name":"settlementDateSell","in":"query","type":"string","required":false,"description":"Settlement date for sell side."},{"name":"settlementDateBuy","in":"query","type":"string","required":false,"description":"Settlement date for buy side."},{"name":"buyCurrency","in":"query","type":"string","required":false,"description":"ISO Currency code for the bought currency.  "},{"name":"buyAmount","in":"query","type":"string","required":false,"description":"Amount bought in the FX deal."},{"name":"sellCurrency","in":"query","type":"string","required":false,"description":"ISO Currency code for the sold currency.  "},{"name":"sellAmount","in":"query","type":"string","required":false,"description":"Amount sold in the FX deal."},{"name":"dealDate","in":"query","type":"string","required":false,"description":"Date on which the deal was agreed. "},{"name":"accountSell","in":"query","type":"string","required":false,"description":"Contains the account from which the payment is made."},{"name":"accountBuy","in":"query","type":"string","required":false,"description":"Contains the account from which the payment is received."},{"name":"dealerDeskId","in":"query","type":"string","required":false,"description":"The dealer/desk responsible for monitoring and managing the currency positions."},{"name":"unevenSwap","in":"query","type":"string","required":false,"description":"Identifier for a FX uneven swap  (the swap base currency amount in near and far leg are not the same)."},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from t24 on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"The identifier of the underlying Entity/Company/Branch."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"OutstandingForexOrdersResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}}]},{"key":"order-fundsAuthorization-v1.0.0","title":"Funds authorization management","version":"v1.0.0","description":"Funds authorization captures an approve or reject decision for a particular transaction. The funds authorization can be created manually or through payment engines or when non sufficient funds in account. Based on the decision taken by the bank user the funds authorization will be approved or reject","endpointCount":3,"endpoints":[{"method":"PUT","path":"/order/fundsAuthorizations/{fundsAuthorizationId}","fullPath":"/api/v1.0.0/order/fundsAuthorizations/{fundsAuthorizationId}","operationId":"updateFundsAuthorization","name":"Update the funds authorization with details such as funds decision, decision reason, approval code, non sufficient funds charge amount, non sufficient funds charge waived reason, non sufficient funds charge decision. Funds authorization can be created in unauthorized state by a payment engine or when non sufficient of funds in account, which has to be further actioned by bank user. Based on decision taken by the user, a hold will be created for account or, charge will be collected for non suffic","summary":"Update funds authorization request  on an account to be actioned by bank user which was created through payment processing system or non sufficient of funds in an account","tags":[],"parameters":[{"name":"fundsAuthorizationId","in":"path","type":"string","required":true,"description":"Identifier of funds authorization request."},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"decisionReasons":[{}],"fundsDecision":"string","approvalCode":"string","nonSufficientFundsChargeWaivedReason":"string","nonSufficientFundsChargeAmount":"string","nonSufficientFundsChargeDecision":"string","extensionData":{}}},"responses":{"200":"FundsAuthorizationResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/order/fundsAuthorizations","fullPath":"/api/v1.0.0/order/fundsAuthorizations","operationId":"getFundsAuthorizations","name":"Retrieve the particular funds authorization or list of all funds authorization processed for account / accounts. These are to be actioned by the bank user.","summary":"Retrieve funds authorization requests on an account or group of accounts","tags":[],"parameters":[{"name":"debitAccount","in":"query","type":"string","required":false,"description":" Identifier of the debitAccounts."},{"name":"originalTransactionReference","in":"query","type":"string","required":false,"description":"Identifies the Original Transaction Reference that created the Funds Authorisation request"},{"name":"fundsDecision","in":"query","type":"string","required":false,"description":"Contains the approval decision entered by the CAO."},{"name":"lockedEventReference","in":"query","type":"string","required":false,"description":"Captures the AC.LOCKED.EVENTS id if in case the funds is available and reserved."},{"name":"fundsAuthorizationId","in":"query","type":"string","required":false,"description":"Identifier of funds authorization request."},{"name":"requestSource","in":"query","type":"string","required":false,"description":"Request source for funds authorisation"},{"name":"arrangementActivityId","in":"query","type":"string","required":false,"description":"Contains the arrangement activity reference identifier"},{"name":"arrangementChargeActivityId","in":"query","type":"string","required":false,"description":"Identifier of arrangement activity processing the charge for an account due to non sufficient of funds."},{"name":"chargeReservationReference","in":"query","type":"string","required":false,"description":"Indicates the reference of funds reservation created due to the charge processed for an account due to non sufficient of funds."},{"name":"alternateKey","in":"query","type":"string","required":false,"description":"Indicates the alternate identifier of transaction/contract"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"FundsAuthorizationsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/order/fundsAuthorizations/pendings","fullPath":"/api/v1.0.0/order/fundsAuthorizations/pendings","operationId":"getPendingFundsAuthorizations","name":"Retrieve the particular funds authorization or list of all funds authorization created for account / accounts which are yet to be actioned by bank user. The bank user will review the funds authorizations created and will take decision on the same. Based on bank user's decision the funds authorization will be approved or rejected.","summary":"Retrieve funds authorization requests on an account or group of accounts which are pending to be actioned by bank user.","tags":[],"parameters":[{"name":"debitAccount","in":"query","type":"string","required":false,"description":" Identifier of the debitAccounts."},{"name":"originalTransactionReference","in":"query","type":"string","required":false,"description":"Identifies the Original Transaction Reference that created the Funds Authorisation request"},{"name":"fundsDecision","in":"query","type":"string","required":false,"description":"Contains the approval decision entered by the CAO."},{"name":"lockedEventReference","in":"query","type":"string","required":false,"description":"Captures the AC.LOCKED.EVENTS id if in case the funds is available and reserved."},{"name":"fundsAuthorizationId","in":"query","type":"string","required":false,"description":"Identifier of funds authorization request."},{"name":"requestSource","in":"query","type":"string","required":false,"description":"Request source for funds authorisation"},{"name":"arrangementActivityId","in":"query","type":"string","required":false,"description":"Contains the arrangement activity reference identifier"},{"name":"arrangementChargeActivityId","in":"query","type":"string","required":false,"description":"Identifier of arrangement activity processing the charge for an account due to non sufficient of funds."},{"name":"chargeReservationReference","in":"query","type":"string","required":false,"description":"Indicates the reference of funds reservation created due to the charge processed for an account due to non sufficient of funds."},{"name":"alternateKey","in":"query","type":"string","required":false,"description":"Indicates the alternate identifier of transaction/contract"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"PendingFundsAuthorizationsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}}]},{"key":"order-fundsAuthorization-v1.1.0","title":"Funds authorization management","version":"v1.1.0","description":"Funds authorization captures an approve or reject decision for a particular transaction. The funds authorization can be created manually or through payment engines or when non sufficient funds in account. Based on the decision taken by the bank user the funds authorization will be approved or reject","endpointCount":3,"endpoints":[{"method":"PUT","path":"/order/fundsAuthorizations/{fundsAuthorizationId}","fullPath":"/api/v1.1.0/order/fundsAuthorizations/{fundsAuthorizationId}","operationId":"updateFundsAuthorization","name":"Update the funds authorization with details such as funds decision, decision reason, approval code, non sufficient funds charge amount, non sufficient funds charge waived reason, non sufficient funds charge decision. Funds authorization can be created in unauthorized state by a payment engine or when non sufficient of funds in account, which has to be further actioned by bank user. Based on decision taken by the user, a hold will be created for account or, charge will be collected for non suffic","summary":"Update funds authorization request  on an account to be actioned by bank user which was created through payment processing system or non sufficient of funds in an account","tags":["RETAIL"],"parameters":[{"name":"fundsAuthorizationId","in":"path","type":"string","required":true,"description":"Identifier of funds authorization request."},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"decisionReasons":[{}],"fundsDecision":"string","approvalCode":"string","nonSufficientFundsChargeWaivedReason":"string","nonSufficientFundsChargeAmount":"string","nonSufficientFundsChargeDecision":"string","extensions":{}}},"responses":{"200":"FundsAuthorizationResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/order/fundsAuthorizations","fullPath":"/api/v1.1.0/order/fundsAuthorizations","operationId":"getFundsAuthorizations","name":"Retrieve the particular funds authorization or list of all funds authorization processed for account / accounts. These are to be actioned by the bank user.","summary":"Retrieve funds authorization requests on an account or group of accounts","tags":["RETAIL"],"parameters":[{"name":"debitAccount","in":"query","type":"string","required":false,"description":" Identifier of the debitAccounts."},{"name":"originalTransactionReference","in":"query","type":"string","required":false,"description":"Identifies the Original Transaction Reference that created the Funds Authorisation request"},{"name":"fundsDecision","in":"query","type":"string","required":false,"description":"Contains the approval decision entered by the CAO."},{"name":"lockedEventReference","in":"query","type":"string","required":false,"description":"Captures the AC.LOCKED.EVENTS id if in case the funds is available and reserved."},{"name":"fundsAuthorizationId","in":"query","type":"string","required":false,"description":"Identifier of funds authorization request."},{"name":"requestSource","in":"query","type":"string","required":false,"description":"Request source for funds authorisation"},{"name":"arrangementActivityId","in":"query","type":"string","required":false,"description":"Contains the arrangement activity reference identifier"},{"name":"arrangementChargeActivityId","in":"query","type":"string","required":false,"description":"Identifier of arrangement activity processing the charge for an account due to insufficient funds."},{"name":"chargeReservationReference","in":"query","type":"string","required":false,"description":"Indicates the reference of funds reservation created due to the charge processed for an account due to insufficient funds."},{"name":"alternateKey","in":"query","type":"string","required":false,"description":"Indicates the alternate identifier of transaction/contract"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"FundsAuthorizationsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/order/fundsAuthorizations/pendings","fullPath":"/api/v1.1.0/order/fundsAuthorizations/pendings","operationId":"getPendingFundsAuthorizations","name":"Retrieve the particular funds authorization or list of all funds authorization created for account / accounts which are yet to be actioned by bank user. The bank user will review the funds authorizations created and will take decision on the same. Based on bank user's decision the funds authorization will be approved or rejected.","summary":"Retrieve funds authorization requests on an account or group of accounts which are pending to be actioned by bank user","tags":["RETAIL"],"parameters":[{"name":"debitAccount","in":"query","type":"string","required":false,"description":" Identifier of the debitAccounts."},{"name":"originalTransactionReference","in":"query","type":"string","required":false,"description":"Identifies the Original Transaction Reference that created the Funds Authorisation request"},{"name":"fundsDecision","in":"query","type":"string","required":false,"description":"Contains the approval decision entered by the CAO."},{"name":"lockedEventReference","in":"query","type":"string","required":false,"description":"Captures the AC.LOCKED.EVENTS id if in case the funds is available and reserved."},{"name":"fundsAuthorizationId","in":"query","type":"string","required":false,"description":"Identifier of funds authorization request."},{"name":"requestSource","in":"query","type":"string","required":false,"description":"Request source for funds authorisation"},{"name":"arrangementActivityId","in":"query","type":"string","required":false,"description":"Contains the arrangement activity reference identifier"},{"name":"arrangementChargeActivityId","in":"query","type":"string","required":false,"description":"Identifier of arrangement activity processing the charge for an account due to insufficient funds."},{"name":"chargeReservationReference","in":"query","type":"string","required":false,"description":"Indicates the reference of funds reservation created due to the charge processed for an account due to insufficient funds."},{"name":"alternateKey","in":"query","type":"string","required":false,"description":"Indicates the alternate identifier of transaction/contract"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"PendingFundsAuthorizationsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}}]},{"key":"order-genericAccountingServices-v1.0.0","title":"Generic Accounting Services","version":"1.0.0","description":"API to manage different types of generic accounting requests from various source systems \u00e2\u20ac\u201c e.g. payment initiation channels, payment system, ATM interface, etc. The cover request type pre-validates that the entries related to a particular transaction can be applied (booked) on the account. The fun","endpointCount":3,"endpoints":[{"method":"POST","path":"/order/payments/bookEntries","fullPath":"/api/v1.0.0/order/payments/bookEntries","operationId":"createBookEntries","name":"The booking request type validates the supplied entries can be applied on the account and, if the validations are passed, it creates the asssociated debit/credit booking entries. If a reservation key is indicated in the request, the funds reservation is removed from the account when the booking request is successful. The external payment system or any other system can use this to reflect the entries on the accounts when the payment/transaction is finalized. ","summary":"Validate that the entry can be applied to the account and creates the booking entries on the account / group of accounts","tags":[],"parameters":[{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."}],"requestBodyExample":{"header":{},"body":{"csmApplication":"string","csmAction":"string","transactionInput":[{}]}},"responses":{"200":"BookEntriesResponse","default":"GAIErrorResponse","400":"BusinessGAIErrorResponse","500":"SystemGAIErrorResponse"}},{"method":"POST","path":"/order/payments/bookEntryChecks","fullPath":"/api/v1.0.0/order/payments/bookEntryChecks","operationId":"validateBookEntries","name":"The cover check request pre-validates that the entry/entries related to a particular transaction can be applied (booked) on the account(s) \u00e2\u20ac\u201c it verifies the account is valid and it checks the restrictions applicable to the respective entry/entries. For debit requests it also verifies if there are sufficient funds to apply the respective debit entry.  This type of request is usually received from systems which are capable to orchestrate the payment execution steps and invoke the pre-validation ","summary":"Validates that the entries related to a particular transaction can be applied (booked) on the account / group of accounts.","tags":[],"parameters":[{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."}],"requestBodyExample":{"header":{},"body":{"csmApplication":"string","csmAction":"string","transactionInput":[{}]}},"responses":{"200":"BookEntriesResponse","default":"GAIErrorResponse","400":"BusinessGAIErrorResponse","500":"SystemGAIErrorResponse"}},{"method":"POST","path":"/order/payments/fundsReservations","fullPath":"/api/v1.0.0/order/payments/fundsReservations","operationId":"createFundsReservation","name":"The funds reservation request verifies that an entry can be applied to an account and, if the validations are passed, it reserves funds on the account. The debit reservation requests reduce the available funds on the account, the credit reservation requests increase the available funds on the account. This request can be sent by order management systems which must reserve funds on the account when the customer initiates a payment order, external payment systems which must reserve funds while exe","summary":"Validates that the entry can be applied to the account and reserve funds on an account / group of accounts.","tags":[],"parameters":[{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."}],"requestBodyExample":{"header":{},"body":{"csmApplication":"string","csmAction":"string","transactionInput":[{}]}},"responses":{"200":"FundsReservationResponse","default":"GAIErrorResponse","400":"BusinessGAIErrorResponse","500":"SystemGAIErrorResponse"}}]},{"key":"order-genericAccountingServices-v1.1.0","title":"Generic Accounting Services","version":"1.1.0","description":"API to manage different types of generic accounting requests from various source systems \u00e2\u20ac\u201c e.g. payment initiation channels, payment system, ATM interface, etc and to manage exceptions related to the booking process. The cover request type pre-validates that the entries related to a particular tra","endpointCount":7,"endpoints":[{"method":"POST","path":"/order/payments/bookEntries","fullPath":"/api/v1.1.0/order/payments/bookEntries","operationId":"createBookEntries","name":"The booking request type validates the supplied entries can be applied on the account and, if the validations are passed, it creates the asssociated debit/credit booking entries. If a reservation key is indicated in the request, the funds reservation is removed from the account when the booking request is successful. The external payment system or any other system can use this to reflect the entries on the accounts when the payment/transaction is finalized. ","summary":"Validate that the entry can be applied to the account and creates the booking entries on the account / group of accounts","tags":[],"parameters":[{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."}],"requestBodyExample":{"header":{},"body":{"csmApplication":"string","csmAction":"string","transactionInput":[{}]}},"responses":{"200":"BookEntriesResponse","default":"GAIErrorResponse","400":"BusinessGAIErrorResponse","500":"SystemGAIErrorResponse"}},{"method":"POST","path":"/order/payments/bookEntryChecks","fullPath":"/api/v1.1.0/order/payments/bookEntryChecks","operationId":"validateBookEntries","name":"The cover check request pre-validates that the entry/entries related to a particular transaction can be applied (booked) on the account(s) \u00e2\u20ac\u201c it verifies the account is valid and it checks the restrictions applicable to the respective entry/entries. For debit requests it also verifies if there are sufficient funds to apply the respective debit entry.  This type of request is usually received from systems which are capable to orchestrate the payment execution steps and invoke the pre-validation ","summary":"Validates that the entries related to a particular transaction can be applied (booked) on the account / group of accounts.","tags":[],"parameters":[{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."}],"requestBodyExample":{"header":{},"body":{"csmApplication":"string","csmAction":"string","transactionInput":[{}]}},"responses":{"200":"BookEntriesResponse","default":"GAIErrorResponse","400":"BusinessGAIErrorResponse","500":"SystemGAIErrorResponse"}},{"method":"POST","path":"/order/payments/fundsReservations","fullPath":"/api/v1.1.0/order/payments/fundsReservations","operationId":"createFundsReservation","name":"The funds reservation request verifies that an entry can be applied to an account and, if the validations are passed, it reserves funds on the account. The debit reservation requests reduce the available funds on the account, the credit reservation requests increase the available funds on the account. This request can be sent by order management systems which must reserve funds on the account when the customer initiates a payment order, external payment systems which must reserve funds while exe","summary":"Validates that the entry can be applied to the account and reserve funds on an account / group of accounts.","tags":[],"parameters":[{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."}],"requestBodyExample":{"header":{},"body":{"csmApplication":"string","csmAction":"string","transactionInput":[{}]}},"responses":{"200":"FundsReservationResponse","default":"GAIErrorResponse","400":"BusinessGAIErrorResponse","500":"SystemGAIErrorResponse"}},{"method":"POST","path":"/order/payments/bookEntryReversals","fullPath":"/api/v1.1.0/order/payments/bookEntryReversals","operationId":"reverseBookEntries","name":"Reverse the booking entries for the original transaction specified in the request. The  transaction id of the original booking request and request type must be specified in order to reverse the originally booked entries. Contra tranasction code, notes and reason code are optional attributes.","summary":"Reverse the booking entries for the original transaction specified in the request.","tags":[],"parameters":[{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{},"body":{"comments":[{}],"requestType":"string","originalTransactionId":"string","transactionCode":"string","reasonCode":"string","extensions":{}}},"responses":{"200":"BookEntriesResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/order/payments/exceptions/{transactionId}","fullPath":"/api/v1.1.0/order/payments/exceptions/{transactionId}","operationId":"getBookExceptionEntries","name":"Retrieves the book entries created to correct the exceptions raised during the initial payment process.","summary":"Retrieves the book entries created to correct the exceptions raised during the initial payment process.","tags":[],"parameters":[{"name":"transactionId","in":"path","type":"string","required":true,"description":"Unique transaction identifier for retrieving the details of the transaction. For example: FT0102030333 etc."},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"BookExceptionEntriesResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/order/payments/bookEntryReversals/{transactionId}","fullPath":"/api/v1.1.0/order/payments/bookEntryReversals/{transactionId}","operationId":"getBookEntryReversals","name":"Retrieves the accounting request posted to reverse the booking entries for the original transaction specified in the request.","summary":"Retrieves the accounting request posted to reverse the booking entries for the original transaction specified in the request.","tags":[],"parameters":[{"name":"transactionId","in":"path","type":"string","required":true,"description":"Unique transaction identifier for retrieving the details of the transaction. For example: FT0102030333 etc."},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"BookEntryReversalsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"POST","path":"/order/payments/exceptions/bookEntries","fullPath":"/api/v1.1.0/order/payments/exceptions/bookEntries","operationId":"createBookExceptionEntries","name":"In case of payment processing exceptions, the booking entries may be posted by the system to a suspense account instead of the actual payment account specified in the transaction. These exceptions can be cleared from the suspense account and the booking entries posted to the actual account specified in the original transaction. The transaction id of the original booking request and request type must be specified in order to book funds to the correct account from exceptions. Notes and reason code","summary":"Create the book entries to correct the exceptions raised during the initial payment processing.","tags":[],"parameters":[{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{},"body":{"comments":[{}],"requestType":"string","originalTransactionId":"string","reasonCode":"string","accountId":"string","profitLossCategory":"string","extensions":{}}},"responses":{"200":"BookExceptionEntriesResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}}]},{"key":"order-genericAccountingServices-v1.2.0","title":"Generic Accounting Services","version":"1.2.0","description":"API to manage different types of generic accounting requests from various source systems \u00e2\u20ac\u201c e.g. payment initiation channels, payment system, ATM interface, etc and to manage exceptions related to the booking process. The cover request type pre-validates that the entries related to a particular tra","endpointCount":7,"endpoints":[{"method":"POST","path":"/order/payments/bookEntryChecks","fullPath":"/api/v1.2.0/order/payments/bookEntryChecks","operationId":"validateBookEntries","name":"The cover check request pre-validates that the entry/entries related to a particular transaction can be applied (booked) on the account(s) \u00e2\u20ac\u201c it verifies the account is valid and it checks the restrictions applicable to the respective entry/entries. For debit requests it also verifies if there are sufficient funds to apply the respective debit entry.  This type of request is usually received from systems which are capable to orchestrate the payment execution steps and invoke the pre-validation ","summary":"Validates that the entries related to a particular transaction can be applied (booked) on the account / group of accounts.","tags":[],"parameters":[{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."}],"requestBodyExample":{"header":{},"body":{"csmApplication":"string","csmAction":"string","transactionInput":[{}]}},"responses":{"200":"BookEntriesResponse","default":"GAIErrorResponse","400":"BusinessGAIErrorResponse","500":"SystemGAIErrorResponse"}},{"method":"POST","path":"/order/payments/fundsReservations","fullPath":"/api/v1.2.0/order/payments/fundsReservations","operationId":"createFundsReservation","name":"The funds reservation request verifies that an entry can be applied to an account and, if the validations are passed, it reserves funds on the account. The debit reservation requests reduce the available funds on the account, the credit reservation requests increase the available funds on the account. This request can be sent by order management systems which must reserve funds on the account when the customer initiates a payment order, external payment systems which must reserve funds while exe","summary":"Validates that the entry can be applied to the account and reserve funds on an account / group of accounts.","tags":[],"parameters":[{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."}],"requestBodyExample":{"header":{},"body":{"csmApplication":"string","csmAction":"string","transactionInput":[{}]}},"responses":{"200":"FundsReservationResponse","default":"GAIErrorResponse","400":"BusinessGAIErrorResponse","500":"SystemGAIErrorResponse"}},{"method":"POST","path":"/order/payments/bookEntryReversals","fullPath":"/api/v1.2.0/order/payments/bookEntryReversals","operationId":"reverseBookEntries","name":"Reverse the booking entries for the original transaction specified in the request. The  transaction id of the original booking request and request type must be specified in order to reverse the originally booked entries. Contra tranasction code, notes and reason code are optional attributes.","summary":"Reverse the booking entries for the original transaction specified in the request.","tags":[],"parameters":[{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{},"body":{"comments":[{}],"requestType":"string","originalTransactionId":"string","transactionCode":"string","reasonCode":"string","extensions":{}}},"responses":{"200":"BookEntriesResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/order/payments/exceptions/{transactionId}","fullPath":"/api/v1.2.0/order/payments/exceptions/{transactionId}","operationId":"getBookExceptionEntries","name":"Retrieves the book entries created to correct the exceptions raised during the initial payment process.","summary":"Retrieves the book entries created to correct the exceptions raised during the initial payment process.","tags":[],"parameters":[{"name":"transactionId","in":"path","type":"string","required":true,"description":"Unique transaction identifier for retrieving the details of the transaction. For example: FT0102030333 etc."},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"BookExceptionEntriesResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/order/payments/bookEntryReversals/{transactionId}","fullPath":"/api/v1.2.0/order/payments/bookEntryReversals/{transactionId}","operationId":"getBookEntryReversals","name":"Retrieves the accounting request posted to reverse the booking entries for the original transaction specified in the request.","summary":"Retrieves the accounting request posted to reverse the booking entries for the original transaction specified in the request.","tags":[],"parameters":[{"name":"transactionId","in":"path","type":"string","required":true,"description":"Unique transaction identifier for retrieving the details of the transaction. For example: FT0102030333 etc."},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"BookEntryReversalsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"POST","path":"/order/payments/exceptions/bookEntries","fullPath":"/api/v1.2.0/order/payments/exceptions/bookEntries","operationId":"createBookExceptionEntries","name":"In case of payment processing exceptions, the booking entries may be posted by the system to a suspense account instead of the actual payment account specified in the transaction. These exceptions can be cleared from the suspense account and the booking entries posted to the actual account specified in the original transaction. The transaction id of the original booking request and request type must be specified in order to book funds to the correct account from exceptions. Notes and reason code","summary":"Create the book entries to correct the exceptions raised during the initial payment processing.","tags":[],"parameters":[{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{},"body":{"comments":[{}],"requestType":"string","originalTransactionId":"string","reasonCode":"string","accountId":"string","profitLossCategory":"string","extensions":{}}},"responses":{"200":"BookExceptionEntriesResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"POST","path":"/order/payments/bookEntries","fullPath":"/api/v1.2.0/order/payments/bookEntries","operationId":"createBookEntries","name":"The booking request type validates the supplied entries can be applied on the account and, if the validations are passed, it creates the asssociated debit/credit booking entries. If a reservation key is indicated in the request, the funds reservation is removed from the account when the booking request is successful. The external payment system or any other system can use this to reflect the entries on the accounts when the payment/transaction is finalized. ","summary":"Validate that the entry can be applied to the account and creates the booking entries on the account / group of accounts","tags":[],"parameters":[{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."}],"requestBodyExample":{"header":{},"body":{"csmApplication":"string","csmAction":"string","transactionInput":[{}]}},"responses":{"200":"BookEntriesResponse","default":"GAIErrorResponse","400":"BusinessGAIErrorResponse","500":"SystemGAIErrorResponse"}}]},{"key":"order-genericAccountingServices-v1.3.0","title":"Generic Accounting Services","version":"1.3.0","description":"API to manage different types of generic accounting requests from various source systems \u00e2\u20ac\u201c e.g. payment initiation channels, payment system, ATM interface, etc and to manage exceptions related to the booking process. The cover request type pre-validates that the entries related to a particular tra","endpointCount":7,"endpoints":[{"method":"POST","path":"/order/payments/bookEntryChecks","fullPath":"/api/v1.3.0/order/payments/bookEntryChecks","operationId":"validateBookEntries","name":"The cover check request pre-validates that the entry/entries related to a particular transaction can be applied (booked) on the account(s) \u00e2\u20ac\u201c it verifies the account is valid and it checks the restrictions applicable to the respective entry/entries. For debit requests it also verifies if there are sufficient funds to apply the respective debit entry.  This type of request is usually received from systems which are capable to orchestrate the payment execution steps and invoke the pre-validation ","summary":"Validates that the entries related to a particular transaction can be applied (booked) on the account / group of accounts.","tags":[],"parameters":[{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."}],"requestBodyExample":{"header":{},"body":{"csmApplication":"string","csmAction":"string","transactionInput":[{}]}},"responses":{"200":"BookEntriesResponse","default":"GAIErrorResponse","400":"BusinessGAIErrorResponse","500":"SystemGAIErrorResponse"}},{"method":"POST","path":"/order/payments/fundsReservations","fullPath":"/api/v1.3.0/order/payments/fundsReservations","operationId":"createFundsReservation","name":"The funds reservation request verifies that an entry can be applied to an account and, if the validations are passed, it reserves funds on the account. The debit reservation requests reduce the available funds on the account, the credit reservation requests increase the available funds on the account. This request can be sent by order management systems which must reserve funds on the account when the customer initiates a payment order, external payment systems which must reserve funds while exe","summary":"Validates that the entry can be applied to the account and reserve funds on an account / group of accounts.","tags":[],"parameters":[{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."}],"requestBodyExample":{"header":{},"body":{"csmApplication":"string","csmAction":"string","transactionInput":[{}]}},"responses":{"200":"FundsReservationResponse","default":"GAIErrorResponse","400":"BusinessGAIErrorResponse","500":"SystemGAIErrorResponse"}},{"method":"POST","path":"/order/payments/bookEntryReversals","fullPath":"/api/v1.3.0/order/payments/bookEntryReversals","operationId":"reverseBookEntries","name":"Reverse the booking entries for the original transaction specified in the request. The  transaction id of the original booking request and request type must be specified in order to reverse the originally booked entries. Contra tranasction code, notes and reason code are optional attributes.","summary":"Reverse the booking entries for the original transaction specified in the request.","tags":[],"parameters":[{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{},"body":{"comments":[{}],"requestType":"string","originalTransactionId":"string","transactionCode":"string","reasonCode":"string","extensions":{}}},"responses":{"200":"BookEntriesResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/order/payments/exceptions/{transactionId}","fullPath":"/api/v1.3.0/order/payments/exceptions/{transactionId}","operationId":"getBookExceptionEntries","name":"Retrieves the book entries created to correct the exceptions raised during the initial payment process.","summary":"Retrieves the book entries created to correct the exceptions raised during the initial payment process.","tags":[],"parameters":[{"name":"transactionId","in":"path","type":"string","required":true,"description":"Unique transaction identifier for retrieving the details of the transaction. For example: FT0102030333 etc."},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"BookExceptionEntriesResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/order/payments/bookEntryReversals/{transactionId}","fullPath":"/api/v1.3.0/order/payments/bookEntryReversals/{transactionId}","operationId":"getBookEntryReversals","name":"Retrieves the accounting request posted to reverse the booking entries for the original transaction specified in the request.","summary":"Retrieves the accounting request posted to reverse the booking entries for the original transaction specified in the request.","tags":[],"parameters":[{"name":"transactionId","in":"path","type":"string","required":true,"description":"Unique transaction identifier for retrieving the details of the transaction. For example: FT0102030333 etc."},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"BookEntryReversalsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"POST","path":"/order/payments/exceptions/bookEntries","fullPath":"/api/v1.3.0/order/payments/exceptions/bookEntries","operationId":"createBookExceptionEntries","name":"In case of payment processing exceptions, the booking entries may be posted by the system to a suspense account instead of the actual payment account specified in the transaction. These exceptions can be cleared from the suspense account and the booking entries posted to the actual account specified in the original transaction. The transaction id of the original booking request and request type must be specified in order to book funds to the correct account from exceptions. Notes and reason code","summary":"Create the book entries to correct the exceptions raised during the initial payment processing.","tags":[],"parameters":[{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{},"body":{"comments":[{}],"requestType":"string","originalTransactionId":"string","reasonCode":"string","accountId":"string","profitLossCategory":"string","extensions":{}}},"responses":{"200":"BookExceptionEntriesResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"POST","path":"/order/payments/bookEntries","fullPath":"/api/v1.3.0/order/payments/bookEntries","operationId":"createBookEntries","name":"The booking request type validates the supplied entries can be applied on the account and, if the validations are passed, it creates the asssociated debit/credit booking entries. If a reservation key is indicated in the request, the funds reservation is removed from the account when the booking request is successful. The external payment system or any other system can use this to reflect the entries on the accounts when the payment/transaction is finalized. ","summary":"Validate that the entry can be applied to the account and creates the booking entries on the account / group of accounts","tags":[],"parameters":[{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."}],"requestBodyExample":{"header":{},"body":{"csmApplication":"string","csmAction":"string","transactionInput":[{}]}},"responses":{"200":"BookEntriesResponse","default":"GAIErrorResponse","400":"BusinessGAIErrorResponse","500":"SystemGAIErrorResponse"}}]},{"key":"order-genericAccountingServices-v1.4.0","title":"Generic Accounting Services","version":"1.4.0","description":"API to manage different types of generic accounting requests from various source systems \u00e2\u20ac\u201c e.g. payment initiation channels, payment system, ATM interface, etc and to manage exceptions related to the booking process. The cover request type pre-validates that the entries related to a particular tra","endpointCount":7,"endpoints":[{"method":"POST","path":"/order/payments/bookEntryChecks","fullPath":"/api/v1.4.0/order/payments/bookEntryChecks","operationId":"validateBookEntries","name":"The cover check request pre-validates that the entry/entries related to a particular transaction can be applied (booked) on the account(s) \u00e2\u20ac\u201c it verifies the account is valid and it checks the restrictions applicable to the respective entry/entries. For debit requests it also verifies if there are sufficient funds to apply the respective debit entry.  This type of request is usually received from systems which are capable to orchestrate the payment execution steps and invoke the pre-validation ","summary":"Validates that the entries related to a particular transaction can be applied (booked) on the account / group of accounts.","tags":[],"parameters":[{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."}],"requestBodyExample":{"header":{},"body":{"csmApplication":"string","csmAction":"string","transactionInput":[{}]}},"responses":{"200":"BookEntriesResponse","default":"GAIErrorResponse","400":"BusinessGAIErrorResponse","500":"SystemGAIErrorResponse"}},{"method":"POST","path":"/order/payments/fundsReservations","fullPath":"/api/v1.4.0/order/payments/fundsReservations","operationId":"createFundsReservation","name":"The funds reservation request verifies that an entry can be applied to an account and, if the validations are passed, it reserves funds on the account. The debit reservation requests reduce the available funds on the account, the credit reservation requests increase the available funds on the account. This request can be sent by order management systems which must reserve funds on the account when the customer initiates a payment order, external payment systems which must reserve funds while exe","summary":"Validates that the entry can be applied to the account and reserve funds on an account / group of accounts.","tags":[],"parameters":[{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."}],"requestBodyExample":{"header":{},"body":{"csmApplication":"string","csmAction":"string","transactionInput":[{}]}},"responses":{"200":"FundsReservationResponse","default":"GAIErrorResponse","400":"BusinessGAIErrorResponse","500":"SystemGAIErrorResponse"}},{"method":"POST","path":"/order/payments/bookEntryReversals","fullPath":"/api/v1.4.0/order/payments/bookEntryReversals","operationId":"reverseBookEntries","name":"Reverse the booking entries for the original transaction specified in the request. The  transaction id of the original booking request and request type must be specified in order to reverse the originally booked entries. Contra transaction code, notes and reason code are optional attributes.","summary":"Reverse the booking entries for the original transaction specified in the request.","tags":["OTHERS"],"parameters":[{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{},"body":{"comments":[{}],"requestType":"string","originalTransactionId":"string","transactionCode":"string","reasonCode":"string","extensions":{}}},"responses":{"200":"BookEntriesResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/order/payments/exceptions/{transactionId}","fullPath":"/api/v1.4.0/order/payments/exceptions/{transactionId}","operationId":"getBookExceptionEntries","name":"Retrieves the book entries created to correct the exceptions raised during the initial payment process.","summary":"Retrieves the book entries created to correct the exceptions raised during the initial payment process.","tags":["OTHERS"],"parameters":[{"name":"transactionId","in":"path","type":"string","required":true,"description":"Unique transaction identifier for retrieving the details of the transaction. For example: FT0102030333 etc."},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"BookExceptionEntriesResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/order/payments/bookEntryReversals/{transactionId}","fullPath":"/api/v1.4.0/order/payments/bookEntryReversals/{transactionId}","operationId":"getBookEntryReversals","name":"Retrieves the accounting request posted to reverse the booking entries for the original transaction specified in the request.","summary":"Retrieves the accounting request posted to reverse the booking entries for the original transaction specified in the request.","tags":["OTHERS"],"parameters":[{"name":"transactionId","in":"path","type":"string","required":true,"description":"Unique transaction identifier for retrieving the details of the transaction. For example: FT0102030333 etc."},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"BookEntryReversalsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"POST","path":"/order/payments/exceptions/bookEntries","fullPath":"/api/v1.4.0/order/payments/exceptions/bookEntries","operationId":"createBookExceptionEntries","name":"In case of payment processing exceptions, the booking entries may be posted by the system to a suspense account instead of the actual payment account specified in the transaction. These exceptions can be cleared from the suspense account and the booking entries posted to the actual account specified in the original transaction. The transaction id of the original booking request and request type must be specified in order to book funds to the correct account from exceptions. Notes and reason code","summary":"Create the book entries to correct the exceptions raised during the initial payment processing.","tags":["OTHERS"],"parameters":[{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{},"body":{"comments":[{}],"requestType":"string","originalTransactionId":"string","reasonCode":"string","accountId":"string","profitLossCategory":"string","extensions":{}}},"responses":{"200":"BookExceptionEntriesResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"POST","path":"/order/payments/bookEntries","fullPath":"/api/v1.4.0/order/payments/bookEntries","operationId":"createBookEntries","name":"The booking request type validates the supplied entries can be applied on the account and, if the validations are passed, it creates the asssociated debit/credit booking entries. If a reservation key is indicated in the request, the funds reservation is removed from the account when the booking request is successful. The external payment system or any other system can use this to reflect the entries on the accounts when the payment/transaction is finalized. Adjustment entries for post-closing ca","summary":"Validate that the entry can be applied to the account and creates the booking entries on the account/group of accounts","tags":[],"parameters":[{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."}],"requestBodyExample":{"header":{},"body":{"csmApplication":"string","csmAction":"string","transactionInput":[{}]}},"responses":{"200":"BookEntriesResponse","default":"GAIErrorResponse","400":"BusinessGAIErrorResponse","500":"SystemGAIErrorResponse"}}]},{"key":"order-genericAccountingServices-v1.4.1","title":"Generic Accounting Services","version":"1.4.1","description":"API to manage different types of generic accounting requests from various source systems - e.g. payment initiation channels, payment system, ATM interface, etc and to manage exceptions related to the booking process. The cover request type pre-validates that the entries related to a particular trans","endpointCount":7,"endpoints":[{"method":"POST","path":"/order/payments/bookEntryChecks","fullPath":"/api/v1.4.1/order/payments/bookEntryChecks","operationId":"validateBookEntries","name":"The cover check request pre-validates that the entry/entries related to a particular transaction can be applied (booked) on the account(s) - it verifies the account is valid and it checks the restrictions applicable to the respective entry/entries. For debit requests it also verifies if there are sufficient funds to apply the respective debit entry.  This type of request is usually received from systems which are capable to orchestrate the payment execution steps and invoke the pre-validation ch","summary":"Validates that the entries related to a particular transaction can be applied (booked) on the account / group of accounts.","tags":[],"parameters":[{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."}],"requestBodyExample":{"header":{},"body":{"csmApplication":"string","csmAction":"string","transactionInput":[{}]}},"responses":{"200":"BookEntriesResponse","default":"GAIErrorResponse","400":"BusinessGAIErrorResponse","500":"SystemGAIErrorResponse"}},{"method":"POST","path":"/order/payments/fundsReservations","fullPath":"/api/v1.4.1/order/payments/fundsReservations","operationId":"createFundsReservation","name":"The funds reservation request verifies that an entry can be applied to an account and, if the validations are passed, it reserves funds on the account. The debit reservation requests reduce the available funds on the account, the credit reservation requests increase the available funds on the account. This request can be sent by order management systems which must reserve funds on the account when the customer initiates a payment order, external payment systems which must reserve funds while exe","summary":"Validates that the entry can be applied to the account and reserve funds on an account / group of accounts.","tags":[],"parameters":[{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."}],"requestBodyExample":{"header":{},"body":{"csmApplication":"string","csmAction":"string","transactionInput":[{}]}},"responses":{"200":"FundsReservationResponse","default":"GAIErrorResponse","400":"BusinessGAIErrorResponse","500":"SystemGAIErrorResponse"}},{"method":"POST","path":"/order/payments/bookEntryReversals","fullPath":"/api/v1.4.1/order/payments/bookEntryReversals","operationId":"reverseBookEntries","name":"Reverse the booking entries for the original transaction specified in the request. The  transaction id of the original booking request and request type must be specified in order to reverse the originally booked entries. Contra transaction code, notes and reason code are optional attributes.","summary":"Reverse the booking entries for the original transaction specified in the request.","tags":["OTHERS"],"parameters":[{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{},"body":{"comments":[{}],"requestType":"string","originalTransactionId":"string","transactionCode":"string","reasonCode":"string","extensions":{}}},"responses":{"200":"BookEntriesResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/order/payments/exceptions/{transactionId}","fullPath":"/api/v1.4.1/order/payments/exceptions/{transactionId}","operationId":"getBookExceptionEntries","name":"Retrieves the book entries created to correct the exceptions raised during the initial payment process.","summary":"Retrieves the book entries created to correct the exceptions raised during the initial payment process.","tags":["OTHERS"],"parameters":[{"name":"transactionId","in":"path","type":"string","required":true,"description":"Unique transaction identifier for retrieving the details of the transaction. For example: FT0102030333 etc."},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"BookExceptionEntriesResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/order/payments/bookEntryReversals/{transactionId}","fullPath":"/api/v1.4.1/order/payments/bookEntryReversals/{transactionId}","operationId":"getBookEntryReversals","name":"Retrieves the accounting request posted to reverse the booking entries for the original transaction specified in the request.","summary":"Retrieves the accounting request posted to reverse the booking entries for the original transaction specified in the request.","tags":["OTHERS"],"parameters":[{"name":"transactionId","in":"path","type":"string","required":true,"description":"Unique transaction identifier for retrieving the details of the transaction. For example: FT0102030333 etc."},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"BookEntryReversalsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"POST","path":"/order/payments/exceptions/bookEntries","fullPath":"/api/v1.4.1/order/payments/exceptions/bookEntries","operationId":"createBookExceptionEntries","name":"In case of payment processing exceptions, the booking entries may be posted by the system to a suspense account instead of the actual payment account specified in the transaction. These exceptions can be cleared from the suspense account and the booking entries posted to the actual account specified in the original transaction. The transaction id of the original booking request and request type must be specified in order to book funds to the correct account from exceptions. Notes and reason code","summary":"Create the book entries to correct the exceptions raised during the initial payment processing.","tags":["OTHERS"],"parameters":[{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{},"body":{"comments":[{}],"requestType":"string","originalTransactionId":"string","reasonCode":"string","accountId":"string","profitLossCategory":"string","extensions":{}}},"responses":{"200":"BookExceptionEntriesResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"POST","path":"/order/payments/bookEntries","fullPath":"/api/v1.4.1/order/payments/bookEntries","operationId":"createBookEntries","name":"The booking request type validates the supplied entries can be applied on the account and, if the validations are passed, it creates the asssociated debit/credit booking entries. If a reservation key is indicated in the request, the funds reservation is removed from the account when the booking request is successful. The external payment system or any other system can use this to reflect the entries on the accounts when the payment/transaction is finalized. Adjustment entries for post-closing ca","summary":"Validate that the entry can be applied to the account and creates the booking entries on the account/group of accounts","tags":[],"parameters":[{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."}],"requestBodyExample":{"header":{},"body":{"csmApplication":"string","csmAction":"string","transactionInput":[{}]}},"responses":{"200":"BookEntriesResponse","default":"GAIErrorResponse","400":"BusinessGAIErrorResponse","500":"SystemGAIErrorResponse"}}]},{"key":"order-orderSimulations-service-v1.0.0","title":"Security Orders Simulation","version":"v1.0.0","description":"Allows the viewing and creation of Order Simulations","endpointCount":2,"endpoints":[{"method":"GET","path":"/order/portfolios/orderSimulations/{orderSimulationId}","fullPath":"/api/v1.0.0/order/portfolios/orderSimulations/{orderSimulationId}","operationId":"getSecurityOrderSimulation","name":"Retrieves the security order simulation","summary":"Retrieves the security order simulation","tags":[],"parameters":[{"name":"orderSimulationId","in":"path","type":"string","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":""},{"name":"companyId","in":"header","type":"string","required":false,"description":""}],"requestBodyExample":null,"responses":{"200":"SecurityOrderSimulationResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"POST","path":"/order/portfolios/orderSimulations/{orderSimulationId}","fullPath":"/api/v1.0.0/order/portfolios/orderSimulations/{orderSimulationId}","operationId":"createSecurityOrderSimulation","name":"Creates the security order simulation","summary":"Creates the security order simulation","tags":[],"parameters":[{"name":"orderSimulationId","in":"path","type":"string","required":true,"description":""},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":""},{"name":"companyId","in":"header","type":"string","required":false,"description":""}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"orderDetails":[{}],"breachInformations":[{}],"customerId":0.0,"portfolioId":"string","initialMarketValue":0.0,"initialMarginValue":0.0,"initialLiabilityPosition":0.0,"initialCollateralSurplusDeficit":0.0,"newMarketValue":0.0,"newMarginValue":0.0,"newLiabilityPosition":0.0,"collateralSurplusDeficit":0.0,"creditCheck":true,"collateralCheck":"string"}},"responses":{"200":"SecurityOrderSimulationResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}}]},{"key":"order-paymentOrders-service-v1.0.0","title":"Order Payment Orders APIs","version":"v1.0.0","description":"Allows the creation, viewing and management of payment orders","endpointCount":21,"endpoints":[{"method":"GET","path":"/order/paymentOrders/{paymentOrderId}","fullPath":"/api/v1.0.0/order/paymentOrders/{paymentOrderId}","operationId":"getPaymentOrder","name":"Retrieves the details of a payment order","summary":"Retrieves payment order details","tags":[],"parameters":[{"name":"paymentOrderId","in":"path","type":"string","required":true,"description":"The unique reference number of payment"},{"name":"currentPaymentState","in":"query","type":"string","required":false,"description":""},{"name":"paymentStatus","in":"query","type":"string","required":false,"description":"Describes the current status of the payment order in the payment system"},{"name":"paymentOrderProductId","in":"query","type":"string","required":false,"description":"Reference to identify the payment details that are allowed, optional and mandatory are defined based on product"},{"name":"debitAccountId","in":"query","type":"string","required":false,"description":"Debit account unique id"},{"name":"orderingCustomerId","in":"query","type":"string","required":false,"description":"Debit Account customer id details"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from t24 on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":""},{"name":"companyId","in":"header","type":"string","required":false,"description":""}],"requestBodyExample":null,"responses":{"200":"PaymentOrderResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"PUT","path":"/order/paymentOrders/{paymentOrderId}","fullPath":"/api/v1.0.0/order/paymentOrders/{paymentOrderId}","operationId":"updatePaymentOrder","name":"Updates an existing payment order","summary":"Update payment order details","tags":[],"parameters":[{"name":"paymentOrderId","in":"path","type":"string","required":true,"description":"The unique reference number of payment"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":""},{"name":"companyId","in":"header","type":"string","required":false,"description":""}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"narratives":[{}],"additionalInformations":[{}],"remittanceInformations":[{}],"signatories":[{}],"invoiceReferences":[{}],"charges":[{}],"overrides":[{}],"beneficiaryAddresses":[{}],"paymentOrderProductId":"string","debitAccountId":"string","debitAccountIBAN":"string","debitCurrency":"string","debitValueDate":"2024-01-01","creditAccountId":"string","creditAccountIBAN":"string"}},"responses":{"200":"PaymentOrderResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"DELETE","path":"/order/paymentOrders/{paymentOrderId}","fullPath":"/api/v1.0.0/order/paymentOrders/{paymentOrderId}","operationId":"deletePaymentOrder","name":"Cancel an existing payment order","summary":"Remove payment order","tags":[],"parameters":[{"name":"paymentOrderId","in":"path","type":"string","required":true,"description":"The unique reference number of payment"},{"name":"payload","in":"body","type":"object","required":false,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":""},{"name":"companyId","in":"header","type":"string","required":false,"description":""}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}}},"responses":{"200":"PaymentOrderResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/order/paymentOrders","fullPath":"/api/v1.0.0/order/paymentOrders","operationId":"getPaymentOrders","name":"Retrieves the list of payment orders","summary":"Retrieves the payment orders","tags":[],"parameters":[{"name":"paymentOrderId","in":"query","type":"string","required":false,"description":"Reference to identify the payment details"},{"name":"currentPaymentState","in":"query","type":"string","required":false,"description":""},{"name":"paymentStatus","in":"query","type":"string","required":false,"description":"Describes the current status of the payment order in the payment system"},{"name":"paymentOrderProductId","in":"query","type":"string","required":false,"description":"Reference to identify the payment details that are allowed, optional and mandatory are defined based on product"},{"name":"paymentOrderProductIdNE","in":"query","type":"string","required":false,"description":""},{"name":"debitAccountId","in":"query","type":"string","required":false,"description":"Debit account unique id"},{"name":"orderingCustomerId","in":"query","type":"string","required":false,"description":"Debit Account customer id details"},{"name":"uniqueTransactionReference","in":"query","type":"string","required":false,"description":""},{"name":"uniqueTransactionReferenceNE","in":"query","type":"string","required":false,"description":""},{"name":"paymentExecutionDate","in":"query","type":"string","required":false,"description":""},{"name":"paymentExecutionDateLE","in":"query","type":"string","required":false,"description":""},{"name":"paymentExecutionDateGT","in":"query","type":"string","required":false,"description":""},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from t24 on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":""},{"name":"companyId","in":"header","type":"string","required":false,"description":""}],"requestBodyExample":null,"responses":{"200":"PaymentOrdersResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"POST","path":"/order/paymentOrders","fullPath":"/api/v1.0.0/order/paymentOrders","operationId":"createPaymentOrder","name":"Creates a new payment order","summary":"Create payment order","tags":[],"parameters":[{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":""},{"name":"companyId","in":"header","type":"string","required":false,"description":""}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"narratives":[{}],"additionalInformations":[{}],"remittanceInformations":[{}],"signatories":[{}],"invoiceReferences":[{}],"charges":[{}],"overrides":[{}],"beneficiaryAddresses":[{}],"paymentOrderProductId":"string","debitAccountId":"string","debitAccountIBAN":"string","debitCurrency":"string","debitValueDate":"2024-01-01","creditAccountId":"string","creditAccountIBAN":"string"}},"responses":{"200":"PaymentOrderResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/order/paymentOrders/purposes","fullPath":"/api/v1.0.0/order/paymentOrders/purposes","operationId":"getPaymentOrderPurposes","name":"Retrieves the list of payment order purpose code details","summary":"Retrieves payment order purposes details","tags":[],"parameters":[{"name":"paymentOrderPurposeCodeId","in":"query","type":"string","required":false,"description":"Purpose code details of the payment"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from t24 on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":""},{"name":"companyId","in":"header","type":"string","required":false,"description":""}],"requestBodyExample":null,"responses":{"200":"PaymentOrderPurposesResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/order/paymentOrders/products","fullPath":"/api/v1.0.0/order/paymentOrders/products","operationId":"getPaymentOrderProducts","name":"Retrieves the list of payment order product details","summary":"Retrieves payment order products details","tags":[],"parameters":[{"name":"paymentProductGroupId","in":"query","type":"string","required":false,"description":""},{"name":"paymentOrderProductId","in":"query","type":"string","required":false,"description":"Reference to identify the payment details that are allowed, optional and mandatory are defined based on product"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from t24 on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":""},{"name":"companyId","in":"header","type":"string","required":false,"description":""}],"requestBodyExample":null,"responses":{"200":"PaymentOrderProductsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/order/paymentOrders/countryRules","fullPath":"/api/v1.0.0/order/paymentOrders/countryRules","operationId":"getPaymentOrderCountryRules","name":"Retrieves the list of payment order country rule details","summary":"Retrieves payment order country rules details","tags":[],"parameters":[{"name":"countryId","in":"query","type":"string","required":false,"description":"Country details specific to the payments"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from t24 on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":""},{"name":"companyId","in":"header","type":"string","required":false,"description":""}],"requestBodyExample":null,"responses":{"200":"PaymentOrderCountryRulesResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"POST","path":"/order/paymentOrders/sepaInstantPayment","fullPath":"/api/v1.0.0/order/paymentOrders/sepaInstantPayment","operationId":"createSepaInstantPayment","name":"Creates a new Sepa Instant payment record","summary":"Create sepa instant payment","tags":[],"parameters":[{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":""},{"name":"companyId","in":"header","type":"string","required":false,"description":""}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"narratives":[{}],"contexts":[{}],"charges":[{}],"paymentOrderProductId":"string","debitAccountIBAN":"string","paymentCurrencyId":"string","amount":0.0,"beneficiaryIBAN":"string","consent":"string","beneficiaryName":"string","endToEndReference":"string","paymentScheme":"string"}},"responses":{"200":"SepaInstantPaymentResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"POST","path":"/order/paymentOrders/sepaInstantTransfer","fullPath":"/api/v1.0.0/order/paymentOrders/sepaInstantTransfer","operationId":"createSepaInstantTransfer","name":"Creates a new Sepa instant transfer record","summary":"Create sepa instant transfer","tags":[],"parameters":[{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":""},{"name":"companyId","in":"header","type":"string","required":false,"description":""}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"narratives":[{}],"contexts":[{}],"charges":[{}],"paymentOrderProductId":"string","debitAccountId":"string","paymentCurrencyId":"string","amount":0.0,"beneficiaryAccountId":"string","beneficiaryName":"string","consent":"string","paymentScheme":"string"}},"responses":{"200":"SepaInstantTransferResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"POST","path":"/order/paymentOrders/sepaPayment","fullPath":"/api/v1.0.0/order/paymentOrders/sepaPayment","operationId":"createSepaPayment","name":"Creates a new Sepa payment record for an external account","summary":"Create sepa payment","tags":[],"parameters":[{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":""},{"name":"companyId","in":"header","type":"string","required":false,"description":""}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"narratives":[{}],"benPostAddrLine":[{}],"acctWithBankPostAddrLn":[{}],"orderingPostAddrLine":[{}],"contexts":[{}],"charges":[{}],"paymentOrderProductId":"string","debitAccountIBAN":"string","paymentCurrencyId":"string","amount":0.0,"beneficiaryIBAN":"string","purpose":"string","beneficiaryCountryCode":"string","debtorCountryCode":"string","orderingCustomerName":"string"}},"responses":{"200":"SepaPaymentResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"POST","path":"/order/paymentOrders/swiftPayment","fullPath":"/api/v1.0.0/order/paymentOrders/swiftPayment","operationId":"createSwiftPayment","name":"Creates a new Swift payment record for an external account","summary":"Create swift payment","tags":[],"parameters":[{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":""},{"name":"companyId","in":"header","type":"string","required":false,"description":""}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"orderingPostSwiftAddress":[{}],"benPostSwiftAddress":[{}],"acctWithBankPostAddrLn":[{}],"narratives":[{}],"contexts":[{}],"charges":[{}],"paymentOrderProductId":"string","debitAccountId":"string","debtorCountryCode":"string","orderingCustomerName":"string","creditorAgentId":"string","creditorBankCountryCode":"string","accountWithBankBIC":"string","beneficiaryCountryCode":"string","beneficiaryName":"string"}},"responses":{"200":"SwiftPaymentResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"POST","path":"/order/paymentOrders/fasterPayment","fullPath":"/api/v1.0.0/order/paymentOrders/fasterPayment","operationId":"createFasterPayment","name":"Creates a new fast payment record for an external account","summary":"Create faster payment","tags":[],"parameters":[{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":""},{"name":"companyId","in":"header","type":"string","required":false,"description":""}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"orderingPostSwiftAddress":[{}],"benPostSwiftAddress":[{}],"acctWithBankPostAddrLn":[{}],"narratives":[{}],"contexts":[{}],"charges":[{}],"paymentOrderProductId":"string","debitAccountId":"string","debtorSortCode":"string","debtorCountryCode":"string","orderingCustomerName":"string","creditorSortCode":"string","beneficiaryIBAN":"string","creditorAgentId":"string","creditorBankCountryCode":"string"}},"responses":{"200":"FasterPaymentResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/order/paymentOrders/{paymentOrderId}/cancelPaymentOrder","fullPath":"/api/v1.0.0/order/paymentOrders/{paymentOrderId}/cancelPaymentOrder","operationId":"cancelExternalPaymentOrder","name":"Cancel the existing payment order for external account","summary":"Cancel external payment order","tags":[],"parameters":[{"name":"paymentOrderId","in":"path","type":"string","required":true,"description":"The unique reference number of payment"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":""},{"name":"companyId","in":"header","type":"string","required":false,"description":""}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"internalStatus":"string","cancellationReason":"string","remarks":"string","initiator":"string"}},"responses":{"200":"ExternalPaymentOrderResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/order/paymentOrders/ISOClearingCodes","fullPath":"/api/v1.0.0/order/paymentOrders/ISOClearingCodes","operationId":"getISOClearingCodes","name":"Retrieves the list of ISO clearing codes","summary":"Retrieves ISO clearing codes details","tags":[],"parameters":[{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from t24 on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":""},{"name":"companyId","in":"header","type":"string","required":false,"description":""}],"requestBodyExample":null,"responses":{"200":"ISOClearingCodesResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"PUT","path":"/order/paymentOrders/paymentOrderApprovals/{paymentOrderId}","fullPath":"/api/v1.0.0/order/paymentOrders/paymentOrderApprovals/{paymentOrderId}","operationId":"approvePaymentOrder","name":"Approve an unauthorized payment order","summary":"Approve payment order","tags":[],"parameters":[{"name":"paymentOrderId","in":"path","type":"string","required":true,"description":"The unique reference number of payment"},{"name":"credentials","in":"header","type":"string","required":false,"description":""},{"name":"companyId","in":"header","type":"string","required":false,"description":""}],"requestBodyExample":null,"responses":{"200":"PaymentOrderResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"DELETE","path":"/order/paymentOrders/cancellations/{paymentOrderId}","fullPath":"/api/v1.0.0/order/paymentOrders/cancellations/{paymentOrderId}","operationId":"rejectPaymentOrder","name":"Reject an unauthorized payment order","summary":"Reject payment order","tags":[],"parameters":[{"name":"paymentOrderId","in":"path","type":"string","required":true,"description":"The unique reference number of payment"},{"name":"payload","in":"body","type":"object","required":false,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":""},{"name":"companyId","in":"header","type":"string","required":false,"description":""}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}}},"responses":{"200":"PaymentOrderResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"POST","path":"/order/paymentOrders/paymentStatus/{paymentId}","fullPath":"/api/v1.0.0/order/paymentOrders/paymentStatus/{paymentId}","operationId":"createGPIPaymentStatus","name":"Create a GPI payment status with unique transaction reference","summary":"Create GPI payment status","tags":[],"parameters":[{"name":"paymentId","in":"path","type":"string","required":true,"description":"Indicates the unique reference number of the payment"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":""},{"name":"companyId","in":"header","type":"string","required":false,"description":""}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"UETRId":"string","paymentReference":"string","requestMessage":"string","responseMessage":"string"}},"responses":{"200":"GPIPaymentStatusResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/order/paymentOrders/paymentStatus/{paymentId}","fullPath":"/api/v1.0.0/order/paymentOrders/paymentStatus/{paymentId}","operationId":"updateGPIPaymentStatus","name":"Update GPI payment status with unique transaction reference","summary":"Update GPI payment status","tags":[],"parameters":[{"name":"paymentId","in":"path","type":"string","required":true,"description":"Indicates the unique reference number of the payment"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":""},{"name":"companyId","in":"header","type":"string","required":false,"description":""}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"UETRId":"string","paymentReference":"string","requestMessage":"string","responseMessage":"string"}},"responses":{"200":"GPIPaymentStatusResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/order/paymentOrders/transactions/tracking","fullPath":"/api/v1.0.0/order/paymentOrders/transactions/tracking","operationId":"getPORTracking","name":"Retrives the GPI Tracking information","summary":"Retrieves the GPI tracking details","tags":[],"parameters":[{"name":"paymentId","in":"query","type":"string","required":false,"description":"Unique id to identify/track the payments"},{"name":"paymentMethod","in":"query","type":"string","required":false,"description":"Field to define method of transfer being initiated, which is required when it is to be processed through payment suites"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from t24 on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":""},{"name":"companyId","in":"header","type":"string","required":false,"description":""}],"requestBodyExample":null,"responses":{"200":"PORTrackingResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/order/paymentOrders/transactions","fullPath":"/api/v1.0.0/order/paymentOrders/transactions","operationId":"getPORTransactions","name":"Retrieves the list of payment order details","summary":"Retrieves the payment order details","tags":[],"parameters":[{"name":"paymentDirection","in":"query","type":"string","required":false,"description":"Possible values of payment receiving and outgoing"},{"name":"endToEndReference","in":"query","type":"string","required":false,"description":"Reference details used for SEPA"},{"name":"endToEndReferenceNE","in":"query","type":"string","required":false,"description":""},{"name":"serviceIdentifier","in":"query","type":"string","required":false,"description":""},{"name":"serviceIdentifierNE","in":"query","type":"string","required":false,"description":""},{"name":"debitCustomerId","in":"query","type":"string","required":false,"description":"Debtor customer id details"},{"name":"creditCustomerId","in":"query","type":"string","required":false,"description":"Creditor customer id details"},{"name":"creditmainAccountId","in":"query","type":"string","required":false,"description":""},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from t24 on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":""},{"name":"companyId","in":"header","type":"string","required":false,"description":""}],"requestBodyExample":null,"responses":{"200":"PORTransactionsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}}]},{"key":"order-paymentOrders-service-v2.0.0","title":"Order Payment Orders APIs","version":"v2.0.0","description":"Allows the creation, viewing and management of payment orders","endpointCount":24,"endpoints":[{"method":"GET","path":"/order/paymentOrders/{paymentOrderId}","fullPath":"/api/v2.0.0/order/paymentOrders/{paymentOrderId}","operationId":"getPaymentOrder","name":"Retrieves the details of a payment order","summary":"Retrieves payment order details","tags":[],"parameters":[{"name":"paymentOrderId","in":"path","type":"string","required":true,"description":"The unique reference number of payment"},{"name":"currentState","in":"query","type":"string","required":false,"description":"Contains the current state of the transaction"},{"name":"paymentStatus","in":"query","type":"string","required":false,"description":"Describes the current status of the payment order in the payment system"},{"name":"paymentOrderProductId","in":"query","type":"string","required":false,"description":"Indicates the payment order product for which payment is initiated"},{"name":"debitAccountId","in":"query","type":"string","required":false,"description":"Indicates the debit account number of the payment or transaction."},{"name":"orderingCustomerId","in":"query","type":"string","required":false,"description":"Indicates the customer id for the ordering customer"},{"name":"uniqueTransactionReference","in":"query","type":"string","required":false,"description":"Unique transaction reference details"},{"name":"executionDate","in":"query","type":"string","required":false,"description":"Date on which the transaction or payment gets processed, i.e. the processing date of the transaction."},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from t24 on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"The identifier of the underlying Entity/Company/Branch."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"PaymentOrderResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"PUT","path":"/order/paymentOrders/{paymentOrderId}","fullPath":"/api/v2.0.0/order/paymentOrders/{paymentOrderId}","operationId":"updatePaymentOrder","name":"Updates an existing payment order","summary":"Update payment order details","tags":[],"parameters":[{"name":"paymentOrderId","in":"path","type":"string","required":true,"description":"The unique reference number of payment"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"The identifier of the underlying Entity/Company/Branch."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"narratives":[{}],"additionalInformations":[{}],"remittanceInformations":[{}],"beneficiaryAddresses":[{}],"signatories":[{}],"invoiceReferences":[{}],"charges":[{}],"overrides":[{}],"paymentOrderProductId":"string","debitAccountId":"string","debitAccountIBAN":"string","debitCurrency":"string","debitValueDate":"2024-01-01","creditAccountId":"string","creditAccountIBAN":"string"}},"responses":{"200":"PaymentOrderResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"DELETE","path":"/order/paymentOrders/{paymentOrderId}","fullPath":"/api/v2.0.0/order/paymentOrders/{paymentOrderId}","operationId":"deletePaymentOrder","name":"Cancel an existing payment order","summary":"Cancel payment order","tags":[],"parameters":[{"name":"paymentOrderId","in":"path","type":"string","required":true,"description":"The unique reference number of payment"},{"name":"payload","in":"body","type":"object","required":false,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"The identifier of the underlying Entity/Company/Branch."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}}},"responses":{"200":"PaymentOrderResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/order/paymentOrders","fullPath":"/api/v2.0.0/order/paymentOrders","operationId":"getPaymentOrders","name":"Retrieves the list of payment orders","summary":"Retrieves the payment orders","tags":[],"parameters":[{"name":"paymentOrderId","in":"query","type":"string","required":false,"description":"The unique reference number of payment"},{"name":"currentState","in":"query","type":"string","required":false,"description":"Contains the current state of the transaction"},{"name":"paymentStatus","in":"query","type":"string","required":false,"description":"Describes the current status of the payment order in the payment system"},{"name":"paymentOrderProductId","in":"query","type":"string","required":false,"description":"Indicates the payment order product for which payment is initiated"},{"name":"paymentOrderProductIdNotEqual","in":"query","type":"string","required":false,"description":"Contains the payment order product for which payment is initiated which also implies not equals operand"},{"name":"debitAccountId","in":"query","type":"string","required":false,"description":"Indicates the debit account number of the payment or transaction."},{"name":"orderingCustomerId","in":"query","type":"string","required":false,"description":"Indicates the customer id for the ordering customer"},{"name":"uniqueTransactionReference","in":"query","type":"string","required":false,"description":"Unique transaction reference details"},{"name":"uniqueTransactionReferenceNotEqual","in":"query","type":"string","required":false,"description":"Contains the Unique transaction reference details which implies not equals operand"},{"name":"executionDate","in":"query","type":"string","required":false,"description":"Date on which the transaction or payment gets processed, i.e. the processing date of the transaction."},{"name":"executionDateGreaterThan","in":"query","type":"string","required":false,"description":"Indicates the execution date of the payment which implies greater than operand"},{"name":"executionDateLessThanEqual","in":"query","type":"string","required":false,"description":"Indicates the execution date of the payment which implies less than or equals operand"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from t24 on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"The identifier of the underlying Entity/Company/Branch."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"PaymentOrdersResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"POST","path":"/order/paymentOrders","fullPath":"/api/v2.0.0/order/paymentOrders","operationId":"createPaymentOrder","name":"Creates a new payment order","summary":"Create payment order","tags":[],"parameters":[{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"The identifier of the underlying Entity/Company/Branch."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"narratives":[{}],"additionalInformations":[{}],"remittanceInformations":[{}],"beneficiaryAddresses":[{}],"signatories":[{}],"invoiceReferences":[{}],"charges":[{}],"overrides":[{}],"paymentOrderProductId":"string","debitAccountId":"string","debitAccountIBAN":"string","debitCurrency":"string","debitValueDate":"2024-01-01","creditAccountId":"string","creditAccountIBAN":"string"}},"responses":{"200":"PaymentOrderResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/order/paymentOrders/purposes","fullPath":"/api/v2.0.0/order/paymentOrders/purposes","operationId":"getPaymentOrderPurposes","name":"Retrieves the list of payment order purpose code details","summary":"Retrieves payment order purposes details","tags":[],"parameters":[{"name":"paymentOrderPurposeCodeId","in":"query","type":"string","required":false,"description":"Indicates the Id of payment purpose code i.e. purpose of the instruction based on a set of pre-defined categories."},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from t24 on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"The identifier of the underlying Entity/Company/Branch."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"PaymentOrderPurposesResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/order/paymentOrders/products","fullPath":"/api/v2.0.0/order/paymentOrders/products","operationId":"getPaymentOrderProducts","name":"Retrieves the list of payment order product details","summary":"Retrieves payment order products details","tags":[],"parameters":[{"name":"paymentProductGroupId","in":"query","type":"string","required":false,"description":"Payment method group details of the payment"},{"name":"paymentOrderProductId","in":"query","type":"string","required":false,"description":"Indicates the payment order product for which payment is initiated"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from t24 on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"The identifier of the underlying Entity/Company/Branch."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"PaymentOrderProductsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/order/paymentOrders/countryRules","fullPath":"/api/v2.0.0/order/paymentOrders/countryRules","operationId":"getPaymentOrderCountryRules","name":"Retrieves the list of payment order country rule details","summary":"Retrieves payment order country rules details","tags":[],"parameters":[{"name":"countryId","in":"query","type":"string","required":false,"description":"ISO country code of the financial institution. "},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from t24 on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"The identifier of the underlying Entity/Company/Branch."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"PaymentOrderCountryRulesResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"POST","path":"/order/paymentOrders/sepaInstantPayments","fullPath":"/api/v2.0.0/order/paymentOrders/sepaInstantPayments","operationId":"createSepaInstantPayment","name":"Creates a new Sepa Instant payment record","summary":"Create sepa instant payment","tags":[],"parameters":[{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"The identifier of the underlying Entity/Company/Branch."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"narratives":[{}],"contexts":[{}],"charges":[{}],"paymentOrderProductId":"string","accountType":"string","debitAccountId":"string","debitCurrency":"string","debitAccountIBAN":"string","paymentCurrencyId":"string","amount":0.0,"beneficiaryIBAN":"string","requestedAmount":"string","requestedCurrency":"string","orderingCustomerId":"string","orderingCustomerName":"string"}},"responses":{"200":"SepaInstantPaymentResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"POST","path":"/order/paymentOrders/sepaInstantTransfers","fullPath":"/api/v2.0.0/order/paymentOrders/sepaInstantTransfers","operationId":"createSepaInstantTransfer","name":"Creates a new Sepa instant transfer record","summary":"Create sepa instant transfer","tags":[],"parameters":[{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"The identifier of the underlying Entity/Company/Branch."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"narratives":[{}],"contexts":[{}],"charges":[{}],"paymentOrderProductId":"string","accountType":"string","debitAccountId":"string","debitCurrency":"string","paymentCurrencyId":"string","amount":0.0,"beneficiaryAccountId":"string","beneficiaryName":"string","consent":"string","requestedAmount":"string","requestedCurrency":"string","orderingCustomerId":"string"}},"responses":{"200":"SepaInstantTransferResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"POST","path":"/order/paymentOrders/sepaPayments","fullPath":"/api/v2.0.0/order/paymentOrders/sepaPayments","operationId":"createSepaPayment","name":"Creates a new Sepa payment record for an external account","summary":"Create sepa payment","tags":[],"parameters":[{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"The identifier of the underlying Entity/Company/Branch."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"narratives":[{}],"benPostAddrLine":[{}],"acctWithBankPostAddrLn":[{}],"orderingPostAddrLine":[{}],"contexts":[{}],"charges":[{}],"paymentOrderProductId":"string","accountType":"string","debitAccountId":"string","debitCurrency":"string","debitAccountIBAN":"string","paymentCurrencyId":"string","amount":0.0,"beneficiaryIBAN":"string","purpose":"string"}},"responses":{"200":"SepaPaymentResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"POST","path":"/order/paymentOrders/swiftPayments","fullPath":"/api/v2.0.0/order/paymentOrders/swiftPayments","operationId":"createSwiftPayment","name":"Creates a new Swift payment record for an external account","summary":"Create swift payment","tags":[],"parameters":[{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"The identifier of the underlying Entity/Company/Branch."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"orderingPostSwiftAddress":[{}],"benPostSwiftAddress":[{}],"acctWithBankPostAddrLn":[{}],"narratives":[{}],"contexts":[{}],"charges":[{}],"paymentOrderProductId":"string","accountType":"string","debitAccountId":"string","debitCurrency":"string","debtorCountryCode":"string","orderingCustomerId":"string","orderingCustomerName":"string","orderingCustomerAddress":"string","orderingPaymentFxCustomerRate":"string"}},"responses":{"200":"SwiftPaymentResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"POST","path":"/order/paymentOrders/fasterPayments","fullPath":"/api/v2.0.0/order/paymentOrders/fasterPayments","operationId":"createFasterPayment","name":"Creates a new fast payment record for an external account","summary":"Create faster payment","tags":[],"parameters":[{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"The identifier of the underlying Entity/Company/Branch."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"orderingPostSwiftAddress":[{}],"benPostSwiftAddress":[{}],"acctWithBankPostAddrLn":[{}],"narratives":[{}],"contexts":[{}],"charges":[{}],"paymentOrderProductId":"string","accountType":"string","debitAccountId":"string","debitCurrency":"string","debtorSortCode":"string","debtorCountryCode":"string","orderingCustomerId":"string","orderingCustomerName":"string","orderingCustomerAddress":"string"}},"responses":{"200":"FasterPaymentResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/order/paymentOrders/{paymentOrderId}/cancellations","fullPath":"/api/v2.0.0/order/paymentOrders/{paymentOrderId}/cancellations","operationId":"cancelExternalPaymentOrder","name":"Cancel the existing payment order for external account","summary":"Cancel external payment order","tags":[],"parameters":[{"name":"paymentOrderId","in":"path","type":"string","required":true,"description":"The unique reference number of payment"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"The identifier of the underlying Entity/Company/Branch."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"internalStatus":"string","cancellationReason":"string","remarks":"string","initiator":"string"}},"responses":{"200":"ExternalPaymentOrderResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"DELETE","path":"/order/paymentOrders/{paymentOrderId}/cancellations","fullPath":"/api/v2.0.0/order/paymentOrders/{paymentOrderId}/cancellations","operationId":"rejectPaymentOrder","name":"Reject an initiated payment order","summary":"Reject payment order","tags":[],"parameters":[{"name":"paymentOrderId","in":"path","type":"string","required":true,"description":"The unique reference number of payment"},{"name":"payload","in":"body","type":"object","required":false,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"The identifier of the underlying Entity/Company/Branch."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}}},"responses":{"200":"PaymentOrderResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/order/paymentOrders/isoClearingCodes","fullPath":"/api/v2.0.0/order/paymentOrders/isoClearingCodes","operationId":"getISOClearingCodes","name":"Retrieves the list of ISO clearing codes","summary":"Retrieves ISO clearing codes details","tags":[],"parameters":[{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from t24 on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"The identifier of the underlying Entity/Company/Branch."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"ISOClearingCodesResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"PUT","path":"/order/paymentOrders/paymentOrderApprovals/{paymentOrderId}","fullPath":"/api/v2.0.0/order/paymentOrders/paymentOrderApprovals/{paymentOrderId}","operationId":"approvePaymentOrder","name":"Approve an initiated payment order","summary":"Approve payment order","tags":[],"parameters":[{"name":"paymentOrderId","in":"path","type":"string","required":true,"description":"The unique reference number of payment"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"The identifier of the underlying Entity/Company/Branch."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"PaymentOrderResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"POST","path":"/order/paymentOrders/gpi/payments/{paymentId}/status","fullPath":"/api/v2.0.0/order/paymentOrders/gpi/payments/{paymentId}/status","operationId":"createGPIPaymentStatus","name":"Create a GPI payment status with unique transaction reference","summary":"Create GPI payment status","tags":[],"parameters":[{"name":"paymentId","in":"path","type":"string","required":true,"description":"Indicates the unique reference number of the payment"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"The identifier of the underlying Entity/Company/Branch."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"UETRId":"string","paymentReference":"string","requestMessage":"string","responseMessage":"string"}},"responses":{"200":"GPIPaymentStatusResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/order/paymentOrders/gpi/payments/{paymentId}/status","fullPath":"/api/v2.0.0/order/paymentOrders/gpi/payments/{paymentId}/status","operationId":"updateGPIPaymentStatus","name":"Update GPI payment status with unique transaction reference","summary":"Update GPI payment status","tags":[],"parameters":[{"name":"paymentId","in":"path","type":"string","required":true,"description":"Indicates the unique reference number of the payment"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"The identifier of the underlying Entity/Company/Branch."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"UETRId":"string","paymentReference":"string","requestMessage":"string","responseMessage":"string"}},"responses":{"200":"GPIPaymentStatusResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/order/paymentOrders/gpi/trackedPayments","fullPath":"/api/v2.0.0/order/paymentOrders/gpi/trackedPayments","operationId":"getGpiPaymentTracking","name":"Retrieves the GPI Tracking information","summary":"Retrieves the GPI tracking details","tags":[],"parameters":[{"name":"paymentId","in":"query","type":"string","required":false,"description":"Indicates the unique reference number of the payment"},{"name":"paymentMethod","in":"query","type":"string","required":false,"description":"Method chosen to make the payment"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from t24 on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"The identifier of the underlying Entity/Company/Branch."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"GpiPaymentTrackingResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/order/paymentOrders/recalls/eligibleOrders","fullPath":"/api/v2.0.0/order/paymentOrders/recalls/eligibleOrders","operationId":"getPaymentOrdersForRecall","name":"Retrieves the payment orders for recall","summary":"Retrieves the completed payment orders which are available for recall initiation","tags":[],"parameters":[{"name":"orderingCustomerId","in":"query","type":"string","required":false,"description":"Indicates the customer id for the ordering customer"},{"name":"paymentOrderId","in":"query","type":"string","required":false,"description":"The unique reference number of payment"},{"name":"paymentOrderProductId","in":"query","type":"string","required":false,"description":"Indicates the payment order product for which payment is initiated"},{"name":"startDate","in":"query","type":"string","required":false,"description":"Contains the date on which the transaction or payment gets initiated."},{"name":"endDate","in":"query","type":"string","required":false,"description":"Indicates the date till which the transaction history requested. If 20120101 is the start date and 20120201 is the end date, all transactions that are booked between January 1 to February 1 2012 are r"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from t24 on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"The identifier of the underlying Entity/Company/Branch."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"PaymentOrdersForRecallResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/order/paymentOrders/trackedPayments","fullPath":"/api/v2.0.0/order/paymentOrders/trackedPayments","operationId":"getTrackedPaymentOrders","name":"Retrieves the payment order for the given order reference","summary":"Retrieves the payment order in order to track the payment order based on the given order reference or system reference","tags":[],"parameters":[{"name":"paymentOrderId","in":"query","type":"string","required":false,"description":"The unique reference number of payment"},{"name":"paymentSystemId","in":"query","type":"string","required":false,"description":"Payment system id details"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from t24 on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"The identifier of the underlying Entity/Company/Branch."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"TrackedPaymentOrdersResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/order/paymentOrders/transactions","fullPath":"/api/v2.0.0/order/paymentOrders/transactions","operationId":"getPaymentOrderTransactions","name":"Retrieves the list of payment order details","summary":"Retrieves the payment order details","tags":[],"parameters":[{"name":"paymentDirection","in":"query","type":"string","required":false,"description":"Indicates the direction of payment i.e. incoming, outgoing, book or redirect"},{"name":"endToEndReference","in":"query","type":"string","required":false,"description":"Indicates the end to end reference for the payment. This field can be provided by the person who instructs the payment and this flows through the lifecycle of the payment."},{"name":"endToEndReferenceNotEqual","in":"query","type":"string","required":false,"description":"Contains the end to end reference for the payment. This field can be provided by the person who instructs the payment and this flows through the lifecycle of the payment which implies the not equals o"},{"name":"serviceIdentifier","in":"query","type":"string","required":false,"description":"Contains the reference number in the user header block of the payment message"},{"name":"serviceIdentifierNotEqual","in":"query","type":"string","required":false,"description":"Contains the reference number in the user header block of the payment message which implies the not equals operand"},{"name":"debitCustomerId","in":"query","type":"string","required":false,"description":"Debtor customer details"},{"name":"creditCustomerId","in":"query","type":"string","required":false,"description":"Creditor customer id details"},{"name":"creditAccountId","in":"query","type":"string","required":false,"description":"Credit account identifier of the payment or transaction"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from t24 on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"The identifier of the underlying Entity/Company/Branch."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"PaymentOrderTransactionsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/order/paymentOrders/recalls/status","fullPath":"/api/v2.0.0/order/paymentOrders/recalls/status","operationId":"getPaymentOrderRecallStatus","name":"Retrieve the recall status of the payment order","summary":"Retrieve the recall status of the payment order for which the recall has been initiated","tags":[],"parameters":[{"name":"paymentOrderId","in":"query","type":"string","required":false,"description":"The unique reference number of payment"},{"name":"paymentOrderProductId","in":"query","type":"string","required":false,"description":"Indicates the payment order product for which payment is initiated"},{"name":"recallStatus","in":"query","type":"string","required":false,"description":"Indicates the recall status of the payment for which the recall has been initiated"},{"name":"systemId","in":"query","type":"string","required":false,"description":"The system application identifier that could be used as entry reference or used as prefix in unique transaction identifiers"},{"name":"orderingCustomerId","in":"query","type":"string","required":false,"description":"Indicates the customer id for the ordering customer"},{"name":"orderingCompany","in":"query","type":"string","required":false,"description":"Indicates the company of the customer who orders the payment"},{"name":"debitAccountId","in":"query","type":"string","required":false,"description":"Indicates the debit account number of the payment or transaction."},{"name":"debitAccountIBAN","in":"query","type":"string","required":false,"description":"International Bank Account Number (IBAN) of the debtor account, required only for International transfers/payments outside the Bank. For example: GB98 MIDL07009312345678, FR7630006000011234567890189"},{"name":"debitPL","in":"query","type":"string","required":false,"description":"Indicates the Profit and Loss Category code"},{"name":"amount","in":"query","type":"string","required":false,"description":"This is the payment amount"},{"name":"paymentCurrencyId","in":"query","type":"string","required":false,"description":"The currency of payment."},{"name":"executionDate","in":"query","type":"string","required":false,"description":"Date on which the transaction or payment gets processed, i.e. the processing date of the transaction."},{"name":"beneficiaryAccountId","in":"query","type":"string","required":false,"description":"Unique account identifier of the beneficiary account number."},{"name":"beneficiaryIBAN","in":"query","type":"string","required":false,"description":"International Bank Account Number (IBAN) of the beneficiary account, required only for International transfers/payments outside the Bank. For example: GB98 MIDL07009312345678, FR7630006000011234567890"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from t24 on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"The identifier of the underlying Entity/Company/Branch."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"PaymentOrderRecallStatusResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}}]},{"key":"order-paymentOrders-service-v2.1.0","title":"Payment Orders","version":"v2.1.0","description":"API for the creation, viewing and management of payment orders","endpointCount":25,"endpoints":[{"method":"GET","path":"/order/paymentOrders/purposes","fullPath":"/api/v2.1.0/order/paymentOrders/purposes","operationId":"getPaymentOrderPurposes","name":"Retrieves the list of payment order purpose code details","summary":"Retrieves payment order purposes details","tags":[],"parameters":[{"name":"paymentOrderPurposeCodeId","in":"query","type":"string","required":false,"description":"Indicates the Id of payment purpose code i.e. purpose of the instruction based on a set of pre-defined categories."},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from t24 on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"The identifier of the underlying Entity/Company/Branch."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"PaymentOrderPurposesResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/order/paymentOrders/products","fullPath":"/api/v2.1.0/order/paymentOrders/products","operationId":"getPaymentOrderProducts","name":"Retrieves the list of payment order product details","summary":"Retrieves payment order products details","tags":[],"parameters":[{"name":"paymentProductGroupId","in":"query","type":"string","required":false,"description":"Payment method group details of the payment"},{"name":"paymentOrderProductId","in":"query","type":"string","required":false,"description":"Indicates the payment order product for which payment is initiated"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from t24 on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"The identifier of the underlying Entity/Company/Branch."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"PaymentOrderProductsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/order/paymentOrders/countryRules","fullPath":"/api/v2.1.0/order/paymentOrders/countryRules","operationId":"getPaymentOrderCountryRules","name":"Retrieves the list of payment order country rule details","summary":"Retrieves payment order country rules details","tags":[],"parameters":[{"name":"countryId","in":"query","type":"string","required":false,"description":"ISO country code of the financial institution. "},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from t24 on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"The identifier of the underlying Entity/Company/Branch."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"PaymentOrderCountryRulesResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"POST","path":"/order/paymentOrders/sepaInstantPayments","fullPath":"/api/v2.1.0/order/paymentOrders/sepaInstantPayments","operationId":"createSepaInstantPayment","name":"Creates a new Sepa Instant payment record","summary":"Create sepa instant payment","tags":[],"parameters":[{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"The identifier of the underlying Entity/Company/Branch."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"narratives":[{}],"contexts":[{}],"charges":[{}],"paymentOrderProductId":"string","debitAccountIBAN":"string","paymentCurrencyId":"string","amount":0.0,"beneficiaryIBAN":"string","consent":"string","beneficiaryName":"string","endToEndReference":"string","paymentScheme":"string"}},"responses":{"200":"SepaInstantPaymentResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"POST","path":"/order/paymentOrders/sepaInstantTransfers","fullPath":"/api/v2.1.0/order/paymentOrders/sepaInstantTransfers","operationId":"createSepaInstantTransfer","name":"Creates a new Sepa instant transfer record","summary":"Create sepa instant transfer","tags":[],"parameters":[{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"The identifier of the underlying Entity/Company/Branch."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"narratives":[{}],"contexts":[{}],"charges":[{}],"paymentOrderProductId":"string","debitAccountId":"string","paymentCurrencyId":"string","amount":0.0,"beneficiaryAccountId":"string","beneficiaryName":"string","consent":"string","paymentScheme":"string"}},"responses":{"200":"SepaInstantTransferResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"POST","path":"/order/paymentOrders/sepaPayments","fullPath":"/api/v2.1.0/order/paymentOrders/sepaPayments","operationId":"createSepaPayment","name":"Creates a new Sepa payment record for an external account","summary":"Create sepa payment","tags":[],"parameters":[{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"The identifier of the underlying Entity/Company/Branch."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"narratives":[{}],"benPostAddrLine":[{}],"acctWithBankPostAddrLn":[{}],"orderingPostAddrLine":[{}],"contexts":[{}],"charges":[{}],"paymentOrderProductId":"string","debitAccountIBAN":"string","paymentCurrencyId":"string","amount":0.0,"beneficiaryIBAN":"string","purpose":"string","beneficiaryCountryCode":"string","debtorCountryCode":"string","orderingCustomerName":"string"}},"responses":{"200":"SepaPaymentResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"POST","path":"/order/paymentOrders/swiftPayments","fullPath":"/api/v2.1.0/order/paymentOrders/swiftPayments","operationId":"createSwiftPayment","name":"Creates a new Swift payment record for an external account","summary":"Create swift payment","tags":[],"parameters":[{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"The identifier of the underlying Entity/Company/Branch."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"orderingPostSwiftAddress":[{}],"benPostSwiftAddress":[{}],"acctWithBankPostAddrLn":[{}],"narratives":[{}],"contexts":[{}],"charges":[{}],"paymentOrderProductId":"string","debitAccountId":"string","debtorCountryCode":"string","orderingCustomerName":"string","creditorAgentId":"string","creditorBankCountryCode":"string","accountWithBankBIC":"string","beneficiaryCountryCode":"string","beneficiaryName":"string"}},"responses":{"200":"SwiftPaymentResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"POST","path":"/order/paymentOrders/fasterPayments","fullPath":"/api/v2.1.0/order/paymentOrders/fasterPayments","operationId":"createFasterPayment","name":"Creates a new fast payment record for an external account","summary":"Create faster payment","tags":[],"parameters":[{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"The identifier of the underlying Entity/Company/Branch."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"orderingPostSwiftAddress":[{}],"benPostSwiftAddress":[{}],"acctWithBankPostAddrLn":[{}],"narratives":[{}],"contexts":[{}],"charges":[{}],"paymentOrderProductId":"string","debitAccountId":"string","debtorSortCode":"string","debtorCountryCode":"string","orderingCustomerName":"string","creditorSortCode":"string","beneficiaryIBAN":"string","creditorAgentId":"string","creditorBankCountryCode":"string"}},"responses":{"200":"FasterPaymentResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/order/paymentOrders/{paymentOrderId}/cancellations","fullPath":"/api/v2.1.0/order/paymentOrders/{paymentOrderId}/cancellations","operationId":"cancelExternalPaymentOrder","name":"Cancel the existing payment order for external account","summary":"Cancel external payment order","tags":[],"parameters":[{"name":"paymentOrderId","in":"path","type":"string","required":true,"description":"The unique reference number of payment"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"The identifier of the underlying Entity/Company/Branch."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"internalStatus":"string","cancellationReason":"string","remarks":"string","initiator":"string"}},"responses":{"200":"ExternalPaymentOrderResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"DELETE","path":"/order/paymentOrders/{paymentOrderId}/cancellations","fullPath":"/api/v2.1.0/order/paymentOrders/{paymentOrderId}/cancellations","operationId":"rejectPaymentOrder","name":"Reject an initiated payment order","summary":"Reject payment order","tags":[],"parameters":[{"name":"paymentOrderId","in":"path","type":"string","required":true,"description":"The unique reference number of payment"},{"name":"payload","in":"body","type":"object","required":false,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"The identifier of the underlying Entity/Company/Branch."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}}},"responses":{"200":"PaymentOrderResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/order/paymentOrders/isoClearingCodes","fullPath":"/api/v2.1.0/order/paymentOrders/isoClearingCodes","operationId":"getISOClearingCodes","name":"Retrieves the list of ISO clearing codes","summary":"Retrieves ISO clearing codes details","tags":[],"parameters":[{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from t24 on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"The identifier of the underlying Entity/Company/Branch."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"ISOClearingCodesResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"POST","path":"/order/paymentOrders/gpi/payments/{paymentId}/status","fullPath":"/api/v2.1.0/order/paymentOrders/gpi/payments/{paymentId}/status","operationId":"createGPIPaymentStatus","name":"Create a GPI payment status with unique transaction reference","summary":"Create GPI payment status","tags":[],"parameters":[{"name":"paymentId","in":"path","type":"string","required":true,"description":"Indicates the unique reference number of the payment"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"The identifier of the underlying Entity/Company/Branch."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"UETRId":"string","paymentReference":"string","requestMessage":"string","responseMessage":"string"}},"responses":{"200":"GPIPaymentStatusResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/order/paymentOrders/gpi/payments/{paymentId}/status","fullPath":"/api/v2.1.0/order/paymentOrders/gpi/payments/{paymentId}/status","operationId":"updateGPIPaymentStatus","name":"Update GPI payment status with unique transaction reference","summary":"Update GPI payment status","tags":[],"parameters":[{"name":"paymentId","in":"path","type":"string","required":true,"description":"Indicates the unique reference number of the payment"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"The identifier of the underlying Entity/Company/Branch."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"UETRId":"string","paymentReference":"string","requestMessage":"string","responseMessage":"string"}},"responses":{"200":"GPIPaymentStatusResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/order/paymentOrders/gpi/trackedPayments","fullPath":"/api/v2.1.0/order/paymentOrders/gpi/trackedPayments","operationId":"getGpiPaymentTracking","name":"Retrieves the GPI Tracking information","summary":"Retrieves the GPI tracking details","tags":[],"parameters":[{"name":"paymentId","in":"query","type":"string","required":false,"description":"Indicates the unique reference number of the payment"},{"name":"paymentMethod","in":"query","type":"string","required":false,"description":"Method chosen to make the payment"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from t24 on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"The identifier of the underlying Entity/Company/Branch."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"GpiPaymentTrackingResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/order/paymentOrders/recalls/eligibleOrders","fullPath":"/api/v2.1.0/order/paymentOrders/recalls/eligibleOrders","operationId":"getPaymentOrdersForRecall","name":"Retrieves the payment orders for recall","summary":"Retrieves the completed payment orders which are available for recall initiation","tags":[],"parameters":[{"name":"orderingCustomerId","in":"query","type":"string","required":false,"description":"Indicates the customer id for the ordering customer"},{"name":"paymentOrderId","in":"query","type":"string","required":false,"description":"The unique reference number of payment"},{"name":"paymentOrderProductId","in":"query","type":"string","required":false,"description":"Indicates the payment order product for which payment is initiated"},{"name":"startDate","in":"query","type":"string","required":false,"description":"Contains the date on which the transaction or payment gets initiated."},{"name":"endDate","in":"query","type":"string","required":false,"description":"Indicates the date till which the transaction history requested. If 20120101 is the start date and 20120201 is the end date, all transactions that are booked between January 1 to February 1 2012 are r"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from t24 on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"The identifier of the underlying Entity/Company/Branch."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"PaymentOrdersForRecallResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/order/paymentOrders/trackedPayments","fullPath":"/api/v2.1.0/order/paymentOrders/trackedPayments","operationId":"getTrackedPaymentOrders","name":"Retrieves the payment order for the given order reference","summary":"Retrieves the payment order in order to track the payment order based on the given order reference or system reference","tags":[],"parameters":[{"name":"paymentOrderId","in":"query","type":"string","required":false,"description":"The unique reference number of payment"},{"name":"paymentSystemId","in":"query","type":"string","required":false,"description":"Payment system id details"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from t24 on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"The identifier of the underlying Entity/Company/Branch."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"TrackedPaymentOrdersResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/order/paymentOrders/transactions","fullPath":"/api/v2.1.0/order/paymentOrders/transactions","operationId":"getPaymentOrderTransactions","name":"Retrieves the list of payment order details","summary":"Retrieves the payment order details","tags":[],"parameters":[{"name":"paymentDirection","in":"query","type":"string","required":false,"description":"Indicates the direction of payment i.e. incoming, outgoing, book or redirect"},{"name":"endToEndReference","in":"query","type":"string","required":false,"description":"Indicates the end to end reference for the payment. This field can be provided by the person who instructs the payment and this flows through the lifecycle of the payment."},{"name":"endToEndReferenceNotEqual","in":"query","type":"string","required":false,"description":"Contains the end to end reference for the payment. This field can be provided by the person who instructs the payment and this flows through the lifecycle of the payment which implies the not equals o"},{"name":"serviceIdentifier","in":"query","type":"string","required":false,"description":"Contains the reference number in the user header block of the payment message"},{"name":"serviceIdentifierNotEqual","in":"query","type":"string","required":false,"description":"Contains the reference number in the user header block of the payment message which implies the not equals operand"},{"name":"debitCustomerId","in":"query","type":"string","required":false,"description":"Debtor customer details"},{"name":"creditCustomerId","in":"query","type":"string","required":false,"description":"Creditor customer id details"},{"name":"creditAccountId","in":"query","type":"string","required":false,"description":"Credit account identifier of the payment or transaction"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from t24 on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"The identifier of the underlying Entity/Company/Branch."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"PaymentOrderTransactionsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/order/paymentOrders","fullPath":"/api/v2.1.0/order/paymentOrders","operationId":"getPaymentOrders","name":"Retrieves the list of payment orders","summary":"Retrieves the payment orders","tags":[],"parameters":[{"name":"paymentOrderId","in":"query","type":"string","required":false,"description":"The unique reference number of payment"},{"name":"currentState","in":"query","type":"string","required":false,"description":"Contains the current state of the transaction"},{"name":"paymentStatus","in":"query","type":"string","required":false,"description":"Describes the current status of the payment order in the payment system"},{"name":"paymentOrderProductId","in":"query","type":"string","required":false,"description":"Indicates the payment order product for which payment is initiated"},{"name":"debitAccountId","in":"query","type":"string","required":false,"description":"Indicates the debit account number of the payment or transaction."},{"name":"orderingCustomerId","in":"query","type":"string","required":false,"description":"Indicates the customer id for the ordering customer"},{"name":"uniqueTransactionReference","in":"query","type":"string","required":false,"description":"Unique transaction reference details"},{"name":"executionDate","in":"query","type":"string","required":false,"description":"Date on which the transaction or payment gets processed, i.e. the processing date of the transaction."},{"name":"bulkReference","in":"query","type":"string","required":false,"description":"Contains bulk master reference for the payment."},{"name":"paymentOrderProductIdNotEqual","in":"query","type":"string","required":false,"description":"Contains the payment order product for which payment is initiated which also implies not equals operand."},{"name":"uniqueTransactionReferenceNotEqual","in":"query","type":"string","required":false,"description":"Contains the Unique transaction reference details which implies not equals operand."},{"name":"executionDateLessThanEqual","in":"query","type":"string","required":false,"description":"Indicates the execution date of the payment which implies less than or equals operand."},{"name":"executionDateGreaterThan","in":"query","type":"string","required":false,"description":"Indicates the execution date of the payment which implies greater than operand."},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from t24 on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"The identifier of the underlying Entity/Company/Branch."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"PaymentOrdersResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"POST","path":"/order/paymentOrders","fullPath":"/api/v2.1.0/order/paymentOrders","operationId":"createPaymentOrder","name":"Creates a new payment order","summary":"Create payment order","tags":[],"parameters":[{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"The identifier of the underlying Entity/Company/Branch."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"narratives":[{}],"additionalInformations":[{}],"remittanceInformations":[{}],"beneficiaryAddresses":[{}],"signatories":[{}],"invoiceReferences":[{}],"charges":[{}],"overrides":[{}],"reasons":[{}],"accountWithInstitutionAddresses":[{}],"orderingPostAddrLine":[{}],"paymentOrderProductId":"string","debitAccountId":"string","debitAccountIBAN":"string","debitCurrency":"string"}},"responses":{"200":"PaymentOrderResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/order/paymentOrders/{paymentOrderId}","fullPath":"/api/v2.1.0/order/paymentOrders/{paymentOrderId}","operationId":"getPaymentOrder","name":"Retrieves the details of a payment order","summary":"Retrieves payment order details","tags":[],"parameters":[{"name":"paymentOrderId","in":"path","type":"string","required":true,"description":"The unique reference number of payment"},{"name":"currentState","in":"query","type":"string","required":false,"description":"Contains the current state of the transaction"},{"name":"paymentStatus","in":"query","type":"string","required":false,"description":"Describes the current status of the payment order in the payment system"},{"name":"paymentOrderProductId","in":"query","type":"string","required":false,"description":"Indicates the payment order product for which payment is initiated"},{"name":"debitAccountId","in":"query","type":"string","required":false,"description":"Indicates the debit account number of the payment or transaction."},{"name":"orderingCustomerId","in":"query","type":"string","required":false,"description":"Indicates the customer id for the ordering customer"},{"name":"uniqueTransactionReference","in":"query","type":"string","required":false,"description":"Unique transaction reference details"},{"name":"executionDate","in":"query","type":"string","required":false,"description":"Date on which the transaction or payment gets processed, i.e. the processing date of the transaction."},{"name":"bulkReference","in":"query","type":"string","required":false,"description":"Contains bulk master reference for the payment."},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from t24 on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"The identifier of the underlying Entity/Company/Branch."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"PaymentOrderResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"PUT","path":"/order/paymentOrders/{paymentOrderId}","fullPath":"/api/v2.1.0/order/paymentOrders/{paymentOrderId}","operationId":"updatePaymentOrder","name":"Updates an existing payment order","summary":"Update payment order details","tags":[],"parameters":[{"name":"paymentOrderId","in":"path","type":"string","required":true,"description":"The unique reference number of payment"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"The identifier of the underlying Entity/Company/Branch."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"narratives":[{}],"additionalInformations":[{}],"remittanceInformations":[{}],"beneficiaryAddresses":[{}],"signatories":[{}],"invoiceReferences":[{}],"charges":[{}],"overrides":[{}],"reasons":[{}],"accountWithInstitutionAddresses":[{}],"orderingPostAddrLine":[{}],"paymentOrderProductId":"string","debitAccountId":"string","debitAccountIBAN":"string","debitCurrency":"string"}},"responses":{"200":"PaymentOrderResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"DELETE","path":"/order/paymentOrders/{paymentOrderId}","fullPath":"/api/v2.1.0/order/paymentOrders/{paymentOrderId}","operationId":"deletePaymentOrder","name":"Cancel an existing payment order","summary":"Cancel payment order","tags":[],"parameters":[{"name":"paymentOrderId","in":"path","type":"string","required":true,"description":"The unique reference number of payment"},{"name":"payload","in":"body","type":"object","required":false,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"The identifier of the underlying Entity/Company/Branch."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}}},"responses":{"200":"PaymentOrderResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/order/paymentOrders/paymentOrderApprovals/{paymentOrderId}","fullPath":"/api/v2.1.0/order/paymentOrders/paymentOrderApprovals/{paymentOrderId}","operationId":"approvePaymentOrder","name":"Approve an initiated payment order","summary":"Approve payment order","tags":[],"parameters":[{"name":"paymentOrderId","in":"path","type":"string","required":true,"description":"The unique reference number of payment"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"The identifier of the underlying Entity/Company/Branch."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"PaymentOrderResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"POST","path":"/order/paymentOrders/instantPayments","fullPath":"/api/v2.1.0/order/paymentOrders/instantPayments","operationId":"createInstantPaymentOrder","name":"Create Instant Payment Order","summary":"Create Instant Payment Order","tags":[],"parameters":[{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"The identifier of the underlying Entity/Company/Branch."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"benPostSwiftAddr":[{}],"benPostAddressLine":[{}],"remittanceInfo":[{}],"contextField":[{}],"contextFieldValue":[{}],"chargeDetails":[{}],"chargeInfo":[{}],"chargeAmt":[{}],"chargeCurr":[{}],"chargeAccountAmt":[{}],"chargeAcc":[{}],"chargeAccCurr":[{}],"debitAccountId":"Debit Account","debitAccountIBAN":"Debit Account IBAN","debitCurrency":"Debit Currency"}},"responses":{"200":"InstantPaymentOrderResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/order/paymentOrders/recalls/status","fullPath":"/api/v2.1.0/order/paymentOrders/recalls/status","operationId":"getPaymentOrderRecallStatus","name":"Retrieve the recall status of the payment order","summary":"Retrieve the recall status of the payment order for which the recall has been initiated","tags":[],"parameters":[{"name":"paymentOrderId","in":"query","type":"string","required":false,"description":"The unique reference number of payment"},{"name":"paymentOrderProductId","in":"query","type":"string","required":false,"description":"Indicates the payment order product for which payment is initiated"},{"name":"orderingCustomerId","in":"query","type":"string","required":false,"description":"Indicates the customer id for the ordering customer"},{"name":"startDate","in":"query","type":"string","required":false,"description":"Contains the date on which the transaction or payment gets initiated."},{"name":"endDate","in":"query","type":"string","required":false,"description":"Indicates the date till which the transaction history requested. If 20120101 is the start date and 20120201 is the end date, all transactions that are booked between January 1 to February 1 2012 are r"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from t24 on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"The identifier of the underlying Entity/Company/Branch."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"PaymentOrderRecallStatusResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}}]},{"key":"order-paymentOrders-service-v2.2.0","title":"Payment Orders","version":"v2.2.0","description":"API for the creation, viewing and management of payment orders","endpointCount":26,"endpoints":[{"method":"GET","path":"/order/paymentOrders/purposes","fullPath":"/api/v2.2.0/order/paymentOrders/purposes","operationId":"getPaymentOrderPurposes","name":"Retrieves the list of payment order purpose code details","summary":"Retrieves payment order purposes details","tags":[],"parameters":[{"name":"paymentOrderPurposeCodeId","in":"query","type":"string","required":false,"description":"Indicates the Id of payment purpose code i.e. purpose of the instruction based on a set of pre-defined categories."},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from t24 on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"PaymentOrderPurposesResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/order/paymentOrders/products","fullPath":"/api/v2.2.0/order/paymentOrders/products","operationId":"getPaymentOrderProducts","name":"Retrieves the list of payment order product details","summary":"Retrieves payment order products details","tags":[],"parameters":[{"name":"paymentProductGroupId","in":"query","type":"string","required":false,"description":"Payment method group details of the payment"},{"name":"paymentOrderProductId","in":"query","type":"string","required":false,"description":"Indicates the payment order product for which payment is initiated"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from t24 on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"PaymentOrderProductsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/order/paymentOrders/countryRules","fullPath":"/api/v2.2.0/order/paymentOrders/countryRules","operationId":"getPaymentOrderCountryRules","name":"Retrieves the list of payment order country rule details","summary":"Retrieves payment order country rules details","tags":[],"parameters":[{"name":"countryId","in":"query","type":"string","required":false,"description":"ISO country code of the financial institution. "},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from t24 on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"PaymentOrderCountryRulesResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"POST","path":"/order/paymentOrders/sepaInstantPayments","fullPath":"/api/v2.2.0/order/paymentOrders/sepaInstantPayments","operationId":"createSepaInstantPayment","name":"Creates a new Sepa Instant payment record","summary":"Create sepa instant payment","tags":[],"parameters":[{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"narratives":[{}],"contexts":[{}],"charges":[{}],"paymentOrderProductId":"string","accountType":"string","debitAccountId":"string","debitCurrency":"string","debitAccountIBAN":"string","paymentCurrencyId":"string","amount":0.0,"beneficiaryIBAN":"string","requestedAmount":"string","requestedCurrency":"string","orderingCustomerId":"string","orderingCustomerName":"string"}},"responses":{"200":"SepaInstantPaymentResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"POST","path":"/order/paymentOrders/sepaInstantTransfers","fullPath":"/api/v2.2.0/order/paymentOrders/sepaInstantTransfers","operationId":"createSepaInstantTransfer","name":"Creates a new Sepa instant transfer record","summary":"Create sepa instant transfer","tags":[],"parameters":[{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"narratives":[{}],"contexts":[{}],"charges":[{}],"paymentOrderProductId":"string","accountType":"string","debitAccountId":"string","debitCurrency":"string","paymentCurrencyId":"string","amount":0.0,"beneficiaryAccountId":"string","beneficiaryName":"string","consent":"string","requestedAmount":"string","requestedCurrency":"string","orderingCustomerId":"string"}},"responses":{"200":"SepaInstantTransferResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"POST","path":"/order/paymentOrders/sepaPayments","fullPath":"/api/v2.2.0/order/paymentOrders/sepaPayments","operationId":"createSepaPayment","name":"Creates a new Sepa payment record for an external account","summary":"Create sepa payment","tags":[],"parameters":[{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"narratives":[{}],"benPostAddrLine":[{}],"acctWithBankPostAddrLn":[{}],"orderingPostAddrLine":[{}],"contexts":[{}],"charges":[{}],"paymentOrderProductId":"string","accountType":"string","debitAccountId":"string","debitCurrency":"string","debitAccountIBAN":"string","paymentCurrencyId":"string","amount":0.0,"beneficiaryIBAN":"string","purpose":"string"}},"responses":{"200":"SepaPaymentResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"POST","path":"/order/paymentOrders/swiftPayments","fullPath":"/api/v2.2.0/order/paymentOrders/swiftPayments","operationId":"createSwiftPayment","name":"Creates a new Swift payment record for an external account","summary":"Create swift payment","tags":[],"parameters":[{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"orderingPostSwiftAddress":[{}],"benPostSwiftAddress":[{}],"acctWithBankPostAddrLn":[{}],"narratives":[{}],"contexts":[{}],"charges":[{}],"paymentOrderProductId":"string","accountType":"string","debitAccountId":"string","debitCurrency":"string","debtorCountryCode":"string","orderingCustomerId":"string","orderingCustomerName":"string","orderingCustomerAddress":"string","orderingPaymentFxCustomerRate":"string"}},"responses":{"200":"SwiftPaymentResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"POST","path":"/order/paymentOrders/fasterPayments","fullPath":"/api/v2.2.0/order/paymentOrders/fasterPayments","operationId":"createFasterPayment","name":"Creates a new fast payment record for an external account","summary":"Create faster payment","tags":[],"parameters":[{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"orderingPostSwiftAddress":[{}],"benPostSwiftAddress":[{}],"acctWithBankPostAddrLn":[{}],"narratives":[{}],"contexts":[{}],"charges":[{}],"paymentOrderProductId":"string","accountType":"string","debitAccountId":"string","debitCurrency":"string","debtorSortCode":"string","debtorCountryCode":"string","orderingCustomerId":"string","orderingCustomerName":"string","orderingCustomerAddress":"string"}},"responses":{"200":"FasterPaymentResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/order/paymentOrders/{paymentOrderId}/cancellations","fullPath":"/api/v2.2.0/order/paymentOrders/{paymentOrderId}/cancellations","operationId":"cancelExternalPaymentOrder","name":"Cancel the existing payment order for external account","summary":"Cancel external payment order","tags":[],"parameters":[{"name":"paymentOrderId","in":"path","type":"string","required":true,"description":"The unique reference number of payment"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"internalStatus":"string","cancellationReason":"string","remarks":"string","initiator":"string"}},"responses":{"200":"ExternalPaymentOrderResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"DELETE","path":"/order/paymentOrders/{paymentOrderId}/cancellations","fullPath":"/api/v2.2.0/order/paymentOrders/{paymentOrderId}/cancellations","operationId":"rejectPaymentOrder","name":"Reject an initiated payment order","summary":"Reject payment order","tags":[],"parameters":[{"name":"paymentOrderId","in":"path","type":"string","required":true,"description":"The unique reference number of payment"},{"name":"payload","in":"body","type":"object","required":false,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}}},"responses":{"200":"PaymentOrderResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/order/paymentOrders/isoClearingCodes","fullPath":"/api/v2.2.0/order/paymentOrders/isoClearingCodes","operationId":"getISOClearingCodes","name":"Retrieves the list of ISO clearing codes","summary":"Retrieves ISO clearing codes details","tags":[],"parameters":[{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from t24 on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"ISOClearingCodesResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"POST","path":"/order/paymentOrders/gpi/payments/{paymentId}/status","fullPath":"/api/v2.2.0/order/paymentOrders/gpi/payments/{paymentId}/status","operationId":"createGPIPaymentStatus","name":"Create a GPI payment status with unique transaction reference","summary":"Create GPI payment status","tags":[],"parameters":[{"name":"paymentId","in":"path","type":"string","required":true,"description":"Indicates the unique reference number of the payment"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"UETRId":"string","paymentReference":"string","requestMessage":"string","responseMessage":"string"}},"responses":{"200":"GPIPaymentStatusResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/order/paymentOrders/gpi/payments/{paymentId}/status","fullPath":"/api/v2.2.0/order/paymentOrders/gpi/payments/{paymentId}/status","operationId":"updateGPIPaymentStatus","name":"Update GPI payment status with unique transaction reference","summary":"Update GPI payment status","tags":[],"parameters":[{"name":"paymentId","in":"path","type":"string","required":true,"description":"Indicates the unique reference number of the payment"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"UETRId":"string","paymentReference":"string","requestMessage":"string","responseMessage":"string"}},"responses":{"200":"GPIPaymentStatusResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/order/paymentOrders/gpi/trackedPayments","fullPath":"/api/v2.2.0/order/paymentOrders/gpi/trackedPayments","operationId":"getGpiPaymentTracking","name":"Retrieves the GPI Tracking information","summary":"Retrieves the GPI tracking details","tags":[],"parameters":[{"name":"paymentId","in":"query","type":"string","required":false,"description":"Indicates the unique reference number of the payment"},{"name":"paymentMethod","in":"query","type":"string","required":false,"description":"Method chosen to make the payment"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from t24 on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"GpiPaymentTrackingResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/order/paymentOrders/recalls/eligibleOrders","fullPath":"/api/v2.2.0/order/paymentOrders/recalls/eligibleOrders","operationId":"getPaymentOrdersForRecall","name":"Retrieves the payment orders for recall","summary":"Retrieves the completed payment orders which are available for recall initiation","tags":[],"parameters":[{"name":"orderingCustomerId","in":"query","type":"string","required":false,"description":"Indicates the customer id for the ordering customer"},{"name":"paymentOrderId","in":"query","type":"string","required":false,"description":"The unique reference number of payment"},{"name":"paymentOrderProductId","in":"query","type":"string","required":false,"description":"Indicates the payment order product for which payment is initiated"},{"name":"startDate","in":"query","type":"string","required":false,"description":"Contains the date on which the transaction or payment gets initiated."},{"name":"endDate","in":"query","type":"string","required":false,"description":"Indicates the date till which the transaction history requested. If 20120101 is the start date and 20120201 is the end date, all transactions that are booked between January 1 to February 1 2012 are r"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from t24 on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"PaymentOrdersForRecallResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/order/paymentOrders/trackedPayments","fullPath":"/api/v2.2.0/order/paymentOrders/trackedPayments","operationId":"getTrackedPaymentOrders","name":"Retrieves the payment order for the given order reference","summary":"Retrieves the payment order in order to track the payment order based on the given order reference or system reference","tags":[],"parameters":[{"name":"paymentOrderId","in":"query","type":"string","required":false,"description":"The unique reference number of payment"},{"name":"paymentSystemId","in":"query","type":"string","required":false,"description":"Payment system id details"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from t24 on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"TrackedPaymentOrdersResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/order/paymentOrders/transactions","fullPath":"/api/v2.2.0/order/paymentOrders/transactions","operationId":"getPaymentOrderTransactions","name":"Retrieves the list of payment order details","summary":"Retrieves the payment order details","tags":[],"parameters":[{"name":"paymentDirection","in":"query","type":"string","required":false,"description":"Indicates the direction of payment i.e. incoming, outgoing, book or redirect"},{"name":"endToEndReference","in":"query","type":"string","required":false,"description":"Indicates the end to end reference for the payment. This field can be provided by the person who instructs the payment and this flows through the lifecycle of the payment."},{"name":"endToEndReferenceNotEqual","in":"query","type":"string","required":false,"description":"Contains the end to end reference for the payment. This field can be provided by the person who instructs the payment and this flows through the lifecycle of the payment which implies the not equals o"},{"name":"serviceIdentifier","in":"query","type":"string","required":false,"description":"Contains the reference number in the user header block of the payment message"},{"name":"serviceIdentifierNotEqual","in":"query","type":"string","required":false,"description":"Contains the reference number in the user header block of the payment message which implies the not equals operand"},{"name":"debitCustomerId","in":"query","type":"string","required":false,"description":"Debtor customer details"},{"name":"creditCustomerId","in":"query","type":"string","required":false,"description":"Creditor customer id details"},{"name":"creditAccountId","in":"query","type":"string","required":false,"description":"Credit account identifier of the payment or transaction"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from t24 on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"PaymentOrderTransactionsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/order/paymentOrders","fullPath":"/api/v2.2.0/order/paymentOrders","operationId":"getPaymentOrders","name":"Retrieves the list of payment orders","summary":"Retrieves the payment orders","tags":[],"parameters":[{"name":"paymentOrderId","in":"query","type":"string","required":false,"description":"The unique reference number of payment"},{"name":"currentState","in":"query","type":"string","required":false,"description":"Contains the current state of the transaction"},{"name":"paymentStatus","in":"query","type":"string","required":false,"description":"Describes the current status of the payment order in the payment system"},{"name":"paymentOrderProductId","in":"query","type":"string","required":false,"description":"Indicates the payment order product for which payment is initiated"},{"name":"debitAccountId","in":"query","type":"string","required":false,"description":"Indicates the debit account number of the payment or transaction."},{"name":"orderingCustomerId","in":"query","type":"string","required":false,"description":"Indicates the customer id for the ordering customer"},{"name":"uniqueTransactionReference","in":"query","type":"string","required":false,"description":"Unique transaction reference details"},{"name":"executionDate","in":"query","type":"string","required":false,"description":"Date on which the transaction or payment gets processed, i.e. the processing date of the transaction."},{"name":"bulkReference","in":"query","type":"string","required":false,"description":"Contains bulk master reference for the payment."},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from t24 on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"PaymentOrdersResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"POST","path":"/order/paymentOrders","fullPath":"/api/v2.2.0/order/paymentOrders","operationId":"createPaymentOrder","name":"Creates a new payment order","summary":"Create payment order","tags":[],"parameters":[{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"narratives":[{}],"additionalInformations":[{}],"remittanceInformations":[{}],"beneficiaryAddresses":[{}],"signatories":[{}],"invoiceReferences":[{}],"charges":[{}],"overrides":[{}],"reasons":[{}],"accountWithInstitutionAddresses":[{}],"orderingPostAddrLine":[{}],"contextNames":[{}],"contextValues":[{}],"messageType":[{}],"paymentOrderProductId":"string"}},"responses":{"200":"PaymentOrderResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/order/paymentOrders/{paymentOrderId}","fullPath":"/api/v2.2.0/order/paymentOrders/{paymentOrderId}","operationId":"getPaymentOrder","name":"Retrieves the details of a payment order","summary":"Retrieves payment order details","tags":[],"parameters":[{"name":"paymentOrderId","in":"path","type":"string","required":true,"description":"The unique reference number of payment"},{"name":"currentState","in":"query","type":"string","required":false,"description":"Contains the current state of the transaction"},{"name":"paymentStatus","in":"query","type":"string","required":false,"description":"Describes the current status of the payment order in the payment system"},{"name":"paymentOrderProductId","in":"query","type":"string","required":false,"description":"Indicates the payment order product for which payment is initiated"},{"name":"debitAccountId","in":"query","type":"string","required":false,"description":"Indicates the debit account number of the payment or transaction."},{"name":"orderingCustomerId","in":"query","type":"string","required":false,"description":"Indicates the customer id for the ordering customer"},{"name":"uniqueTransactionReference","in":"query","type":"string","required":false,"description":"Unique transaction reference details"},{"name":"executionDate","in":"query","type":"string","required":false,"description":"Date on which the transaction or payment gets processed, i.e. the processing date of the transaction."},{"name":"bulkReference","in":"query","type":"string","required":false,"description":"Contains bulk master reference for the payment."},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from t24 on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"PaymentOrderResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"PUT","path":"/order/paymentOrders/{paymentOrderId}","fullPath":"/api/v2.2.0/order/paymentOrders/{paymentOrderId}","operationId":"updatePaymentOrder","name":"Updates an existing payment order","summary":"Update payment order details","tags":[],"parameters":[{"name":"paymentOrderId","in":"path","type":"string","required":true,"description":"The unique reference number of payment"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"narratives":[{}],"additionalInformations":[{}],"remittanceInformations":[{}],"beneficiaryAddresses":[{}],"signatories":[{}],"invoiceReferences":[{}],"charges":[{}],"overrides":[{}],"reasons":[{}],"accountWithInstitutionAddresses":[{}],"orderingPostAddrLine":[{}],"contextNames":[{}],"contextValues":[{}],"messageType":[{}],"paymentOrderProductId":"string"}},"responses":{"200":"PaymentOrderResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"DELETE","path":"/order/paymentOrders/{paymentOrderId}","fullPath":"/api/v2.2.0/order/paymentOrders/{paymentOrderId}","operationId":"deletePaymentOrder","name":"Cancel an existing payment order","summary":"Cancel payment order","tags":[],"parameters":[{"name":"paymentOrderId","in":"path","type":"string","required":true,"description":"The unique reference number of payment"},{"name":"payload","in":"body","type":"object","required":false,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}}},"responses":{"200":"PaymentOrderResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"POST","path":"/order/paymentOrders/instantPayments","fullPath":"/api/v2.2.0/order/paymentOrders/instantPayments","operationId":"createInstantPaymentOrder","name":"Create Instant Payment Order","summary":"Create Instant Payment Order","tags":[],"parameters":[{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"benPostSwiftAddr":[{}],"benPostAddressLine":[{}],"remittanceInfo":[{}],"contextField":[{}],"contextFieldValue":[{}],"chargeDetails":[{}],"chargeInfo":[{}],"chargeAmt":[{}],"chargeCurr":[{}],"chargeAccountAmt":[{}],"chargeAcc":[{}],"chargeAccCurr":[{}],"debitAccountId":"Debit Account","debitAccountIBAN":"Debit Account IBAN","debitCurrency":"Debit Currency"}},"responses":{"200":"InstantPaymentOrderResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/order/paymentOrders/recalls/status","fullPath":"/api/v2.2.0/order/paymentOrders/recalls/status","operationId":"getPaymentOrderRecallStatus","name":"Retrieve the recall status of the payment order","summary":"Retrieve the recall status of the payment order for which the recall has been initiated","tags":[],"parameters":[{"name":"paymentOrderId","in":"query","type":"string","required":false,"description":"The unique reference number of payment"},{"name":"paymentOrderProductId","in":"query","type":"string","required":false,"description":"Indicates the payment order product for which payment is initiated"},{"name":"orderingCustomerId","in":"query","type":"string","required":false,"description":"Indicates the customer id for the ordering customer"},{"name":"startDate","in":"query","type":"string","required":false,"description":"Contains the date on which the transaction or payment gets initiated."},{"name":"endDate","in":"query","type":"string","required":false,"description":"Indicates the date till which the transaction history requested. If 20120101 is the start date and 20120201 is the end date, all transactions that are booked between January 1 to February 1 2012 are r"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from t24 on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"PaymentOrderRecallStatusResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"PUT","path":"/order/paymentOrders/paymentOrderApprovals/{paymentOrderId}","fullPath":"/api/v2.2.0/order/paymentOrders/paymentOrderApprovals/{paymentOrderId}","operationId":"approvePaymentOrder","name":" Approve an initiated payment order","summary":"Approve payment order","tags":[],"parameters":[{"name":"paymentOrderId","in":"path","type":"string","required":true,"description":"The unique reference number of payment"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"PaymentOrderResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"POST","path":"/order/paymentOrders/orderSimulation","fullPath":"/api/v2.2.0/order/paymentOrders/orderSimulation","operationId":"createTransparency","name":"Creates transparency check details from payment order to infinity","summary":"Creates transparency check","tags":[],"parameters":[{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"beneficiaryAddresses":[{}],"accountWithInstitutionAddresses":[{}],"narratives":[{}],"charges":[{}],"contextNames":[{}],"contextValues":[{}],"messageType":[{}],"orderInitiationType":"string","beneficiaryId":"string","paymentOrderProductId":"string","debitAccount":"string","beneficiaryAccountId":"string","beneficiaryIBAN":"string","beneficiaryName":"string","beneficiaryCountryCode":"string"}},"responses":{"200":"TransparencyResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}}]},{"key":"order-paymentOrders-service-v2.3.0","title":"Payment Orders","version":"v2.3.0","description":"API for the creation, viewing and management of payment orders","endpointCount":26,"endpoints":[{"method":"GET","path":"/order/paymentOrders/purposes","fullPath":"/api/v2.3.0/order/paymentOrders/purposes","operationId":"getPaymentOrderPurposes","name":"Retrieves the list of payment order purpose code details","summary":"Retrieves payment order purposes details","tags":[],"parameters":[{"name":"paymentOrderPurposeCodeId","in":"query","type":"string","required":false,"description":"Indicates the Id of payment purpose code i.e. purpose of the instruction based on a set of pre-defined categories."},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"PaymentOrderPurposesResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/order/paymentOrders/products","fullPath":"/api/v2.3.0/order/paymentOrders/products","operationId":"getPaymentOrderProducts","name":"Retrieves the list of payment order product details","summary":"Retrieves payment order products details","tags":[],"parameters":[{"name":"paymentProductGroupId","in":"query","type":"string","required":false,"description":"Payment method group details of the payment"},{"name":"paymentOrderProductId","in":"query","type":"string","required":false,"description":"Indicates the payment order product for which payment is initiated"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"PaymentOrderProductsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/order/paymentOrders/countryRules","fullPath":"/api/v2.3.0/order/paymentOrders/countryRules","operationId":"getPaymentOrderCountryRules","name":"Retrieves the list of payment order country rule details","summary":"Retrieves payment order country rules details","tags":[],"parameters":[{"name":"countryId","in":"query","type":"string","required":false,"description":"ISO country code of the financial institution. "},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"PaymentOrderCountryRulesResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"POST","path":"/order/paymentOrders/sepaInstantPayments","fullPath":"/api/v2.3.0/order/paymentOrders/sepaInstantPayments","operationId":"createSepaInstantPayment","name":"Creates a new Sepa Instant payment record","summary":"Create sepa instant payment","tags":[],"parameters":[{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"narratives":[{}],"contexts":[{}],"charges":[{}],"paymentOrderProductId":"string","accountType":"string","debitAccountId":"string","debitCurrency":"string","debitAccountIBAN":"string","paymentCurrencyId":"string","amount":0.0,"beneficiaryIBAN":"string","requestedAmount":"string","requestedCurrency":"string","orderingCustomerId":"string","orderingCustomerName":"string"}},"responses":{"200":"SepaInstantPaymentResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"POST","path":"/order/paymentOrders/sepaInstantTransfers","fullPath":"/api/v2.3.0/order/paymentOrders/sepaInstantTransfers","operationId":"createSepaInstantTransfer","name":"Creates a new Sepa instant transfer record","summary":"Create sepa instant transfer","tags":[],"parameters":[{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"narratives":[{}],"contexts":[{}],"charges":[{}],"paymentOrderProductId":"string","accountType":"string","debitAccountId":"string","debitCurrency":"string","paymentCurrencyId":"string","amount":0.0,"beneficiaryAccountId":"string","beneficiaryName":"string","consent":"string","requestedAmount":"string","requestedCurrency":"string","orderingCustomerId":"string"}},"responses":{"200":"SepaInstantTransferResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"POST","path":"/order/paymentOrders/sepaPayments","fullPath":"/api/v2.3.0/order/paymentOrders/sepaPayments","operationId":"createSepaPayment","name":"Creates a new Sepa payment record for an external account","summary":"Create sepa payment","tags":[],"parameters":[{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"narratives":[{}],"benPostAddrLine":[{}],"acctWithBankPostAddrLn":[{}],"orderingPostAddrLine":[{}],"contexts":[{}],"charges":[{}],"paymentOrderProductId":"string","accountType":"string","debitAccountId":"string","debitCurrency":"string","debitAccountIBAN":"string","paymentCurrencyId":"string","amount":0.0,"beneficiaryIBAN":"string","purpose":"string"}},"responses":{"200":"SepaPaymentResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"POST","path":"/order/paymentOrders/swiftPayments","fullPath":"/api/v2.3.0/order/paymentOrders/swiftPayments","operationId":"createSwiftPayment","name":"Creates a new Swift payment record for an external account","summary":"Create swift payment","tags":[],"parameters":[{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"orderingPostSwiftAddress":[{}],"benPostSwiftAddress":[{}],"acctWithBankPostAddrLn":[{}],"narratives":[{}],"contexts":[{}],"charges":[{}],"paymentOrderProductId":"string","accountType":"string","debitAccountId":"string","debitCurrency":"string","debtorCountryCode":"string","orderingCustomerId":"string","orderingCustomerName":"string","orderingCustomerAddress":"string","orderingPaymentFxCustomerRate":"string"}},"responses":{"200":"SwiftPaymentResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"POST","path":"/order/paymentOrders/fasterPayments","fullPath":"/api/v2.3.0/order/paymentOrders/fasterPayments","operationId":"createFasterPayment","name":"Creates a new fast payment record for an external account","summary":"Create faster payment","tags":[],"parameters":[{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"orderingPostSwiftAddress":[{}],"benPostSwiftAddress":[{}],"acctWithBankPostAddrLn":[{}],"narratives":[{}],"contexts":[{}],"charges":[{}],"paymentOrderProductId":"string","accountType":"string","debitAccountId":"string","debitCurrency":"string","debtorSortCode":"string","debtorCountryCode":"string","orderingCustomerId":"string","orderingCustomerName":"string","orderingCustomerAddress":"string"}},"responses":{"200":"FasterPaymentResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/order/paymentOrders/{paymentOrderId}/cancellations","fullPath":"/api/v2.3.0/order/paymentOrders/{paymentOrderId}/cancellations","operationId":"cancelExternalPaymentOrder","name":"Cancel the existing payment order for external account","summary":"Cancel external payment order","tags":[],"parameters":[{"name":"paymentOrderId","in":"path","type":"string","required":true,"description":"The unique reference number of payment"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"internalStatus":"string","cancellationReason":"string","remarks":"string","initiator":"string"}},"responses":{"200":"ExternalPaymentOrderResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"DELETE","path":"/order/paymentOrders/{paymentOrderId}/cancellations","fullPath":"/api/v2.3.0/order/paymentOrders/{paymentOrderId}/cancellations","operationId":"rejectPaymentOrder","name":"Reject an initiated payment order","summary":"Reject payment order","tags":[],"parameters":[{"name":"paymentOrderId","in":"path","type":"string","required":true,"description":"The unique reference number of payment"},{"name":"payload","in":"body","type":"object","required":false,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}}},"responses":{"200":"PaymentOrderResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/order/paymentOrders/isoClearingCodes","fullPath":"/api/v2.3.0/order/paymentOrders/isoClearingCodes","operationId":"getISOClearingCodes","name":"Retrieves the list of ISO clearing codes","summary":"Retrieves ISO clearing codes details","tags":[],"parameters":[{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"ISOClearingCodesResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"POST","path":"/order/paymentOrders/gpi/payments/{paymentId}/status","fullPath":"/api/v2.3.0/order/paymentOrders/gpi/payments/{paymentId}/status","operationId":"createGPIPaymentStatus","name":"Create a GPI payment status with unique transaction reference","summary":"Create GPI payment status","tags":[],"parameters":[{"name":"paymentId","in":"path","type":"string","required":true,"description":"Indicates the unique reference number of the payment"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"UETRId":"string","paymentReference":"string","requestMessage":"string","responseMessage":"string"}},"responses":{"200":"GPIPaymentStatusResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/order/paymentOrders/gpi/payments/{paymentId}/status","fullPath":"/api/v2.3.0/order/paymentOrders/gpi/payments/{paymentId}/status","operationId":"updateGPIPaymentStatus","name":"Update GPI payment status with unique transaction reference","summary":"Update GPI payment status","tags":[],"parameters":[{"name":"paymentId","in":"path","type":"string","required":true,"description":"Indicates the unique reference number of the payment"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"UETRId":"string","paymentReference":"string","requestMessage":"string","responseMessage":"string"}},"responses":{"200":"GPIPaymentStatusResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/order/paymentOrders/gpi/trackedPayments","fullPath":"/api/v2.3.0/order/paymentOrders/gpi/trackedPayments","operationId":"getGpiPaymentTracking","name":"Retrieves the GPI Tracking information","summary":"Retrieves the GPI tracking details","tags":[],"parameters":[{"name":"paymentId","in":"query","type":"string","required":false,"description":"Indicates the unique reference number of the payment"},{"name":"paymentMethod","in":"query","type":"string","required":false,"description":"Method chosen to make the payment"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"GpiPaymentTrackingResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/order/paymentOrders/recalls/eligibleOrders","fullPath":"/api/v2.3.0/order/paymentOrders/recalls/eligibleOrders","operationId":"getPaymentOrdersForRecall","name":"Retrieves the payment orders for recall","summary":"Retrieves the completed payment orders which are available for recall initiation","tags":[],"parameters":[{"name":"orderingCustomerId","in":"query","type":"string","required":false,"description":"Indicates the customer id for the ordering customer"},{"name":"paymentOrderId","in":"query","type":"string","required":false,"description":"The unique reference number of payment"},{"name":"paymentOrderProductId","in":"query","type":"string","required":false,"description":"Indicates the payment order product for which payment is initiated"},{"name":"startDate","in":"query","type":"string","required":false,"description":"Contains the date on which the transaction or payment gets initiated."},{"name":"endDate","in":"query","type":"string","required":false,"description":"Indicates the date till which the transaction history requested. If 20120101 is the start date and 20120201 is the end date, all transactions that are booked between January 1 to February 1 2012 are r"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"PaymentOrdersForRecallResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/order/paymentOrders/trackedPayments","fullPath":"/api/v2.3.0/order/paymentOrders/trackedPayments","operationId":"getTrackedPaymentOrders","name":"Retrieves the payment order for the given order reference","summary":"Retrieves the payment order in order to track the payment order based on the given order reference or system reference","tags":[],"parameters":[{"name":"paymentOrderId","in":"query","type":"string","required":false,"description":"The unique reference number of payment"},{"name":"paymentSystemId","in":"query","type":"string","required":false,"description":"Payment system id details"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"TrackedPaymentOrdersResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/order/paymentOrders/transactions","fullPath":"/api/v2.3.0/order/paymentOrders/transactions","operationId":"getPaymentOrderTransactions","name":"Retrieves the list of payment order details","summary":"Retrieves the payment order details","tags":[],"parameters":[{"name":"paymentDirection","in":"query","type":"string","required":false,"description":"Indicates the direction of payment i.e. incoming, outgoing, book or redirect"},{"name":"endToEndReference","in":"query","type":"string","required":false,"description":"Indicates the end to end reference for the payment. This field can be provided by the person who instructs the payment and this flows through the lifecycle of the payment."},{"name":"endToEndReferenceNotEqual","in":"query","type":"string","required":false,"description":"Contains the end to end reference for the payment. This field can be provided by the person who instructs the payment and this flows through the lifecycle of the payment which implies the not equals o"},{"name":"serviceIdentifier","in":"query","type":"string","required":false,"description":"Contains the reference number in the user header block of the payment message"},{"name":"serviceIdentifierNotEqual","in":"query","type":"string","required":false,"description":"Contains the reference number in the user header block of the payment message which implies the not equals operand"},{"name":"debitCustomerId","in":"query","type":"string","required":false,"description":"Debtor customer details"},{"name":"creditCustomerId","in":"query","type":"string","required":false,"description":"Creditor customer id details"},{"name":"creditAccountId","in":"query","type":"string","required":false,"description":"Credit account identifier of the payment or transaction"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"PaymentOrderTransactionsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"POST","path":"/order/paymentOrders/instantPayments","fullPath":"/api/v2.3.0/order/paymentOrders/instantPayments","operationId":"createInstantPaymentOrder","name":"Create Instant Payment Order","summary":"Create Instant Payment Order","tags":[],"parameters":[{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"benPostSwiftAddr":[{}],"benPostAddressLine":[{}],"remittanceInfo":[{}],"contextField":[{}],"contextFieldValue":[{}],"chargeDetails":[{}],"chargeInfo":[{}],"chargeAmt":[{}],"chargeCurr":[{}],"chargeAccountAmt":[{}],"chargeAcc":[{}],"chargeAccCurr":[{}],"debitAccountId":"Debit Account","debitAccountIBAN":"Debit Account IBAN","debitCurrency":"Debit Currency"}},"responses":{"200":"InstantPaymentOrderResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/order/paymentOrders/recalls/status","fullPath":"/api/v2.3.0/order/paymentOrders/recalls/status","operationId":"getPaymentOrderRecallStatus","name":"Retrieve the recall status of the payment order","summary":"Retrieve the recall status of the payment order for which the recall has been initiated","tags":[],"parameters":[{"name":"paymentOrderId","in":"query","type":"string","required":false,"description":"The unique reference number of payment"},{"name":"paymentOrderProductId","in":"query","type":"string","required":false,"description":"Indicates the payment order product for which payment is initiated"},{"name":"orderingCustomerId","in":"query","type":"string","required":false,"description":"Indicates the customer id for the ordering customer"},{"name":"startDate","in":"query","type":"string","required":false,"description":"Contains the date on which the transaction or payment gets initiated."},{"name":"endDate","in":"query","type":"string","required":false,"description":"Indicates the date till which the transaction history requested. If 20120101 is the start date and 20120201 is the end date, all transactions that are booked between January 1 to February 1 2012 are r"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"PaymentOrderRecallStatusResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/order/paymentOrders/{paymentOrderId}","fullPath":"/api/v2.3.0/order/paymentOrders/{paymentOrderId}","operationId":"getPaymentOrder","name":"Retrieves the details of a payment order","summary":"Retrieves payment order details","tags":[],"parameters":[{"name":"paymentOrderId","in":"path","type":"string","required":true,"description":"The unique reference number of payment"},{"name":"currentState","in":"query","type":"string","required":false,"description":"Contains the current state of the transaction"},{"name":"paymentStatus","in":"query","type":"string","required":false,"description":"Describes the current status of the payment order in the payment system"},{"name":"paymentOrderProductId","in":"query","type":"string","required":false,"description":"Indicates the payment order product for which payment is initiated"},{"name":"debitAccountId","in":"query","type":"string","required":false,"description":"Indicates the debit account number of the payment or transaction."},{"name":"orderingCustomerId","in":"query","type":"string","required":false,"description":"Indicates the customer id for the ordering customer"},{"name":"uniqueTransactionReference","in":"query","type":"string","required":false,"description":"Unique transaction reference details"},{"name":"executionDate","in":"query","type":"string","required":false,"description":"Date on which the transaction or payment gets processed, i.e. the processing date of the transaction."},{"name":"bulkReference","in":"query","type":"string","required":false,"description":"Contains bulk master reference for the payment."},{"name":"paymentSource","in":"query","type":"string","required":false,"description":"Indicates the source from where the payment is originated"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"PaymentOrderResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"PUT","path":"/order/paymentOrders/{paymentOrderId}","fullPath":"/api/v2.3.0/order/paymentOrders/{paymentOrderId}","operationId":"updatePaymentOrder","name":"Updates an existing payment order","summary":"Update payment order details","tags":[],"parameters":[{"name":"paymentOrderId","in":"path","type":"string","required":true,"description":"The unique reference number of payment"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"narratives":[{}],"additionalInformations":[{}],"remittanceInformations":[{}],"beneficiaryAddresses":[{}],"signatories":[{}],"invoiceReferences":[{}],"charges":[{}],"overrides":[{}],"reasons":[{}],"accountWithInstitutionAddresses":[{}],"orderingPostAddrLine":[{}],"contextNames":[{}],"contextValues":[{}],"messageType":[{}],"paymentOrderProductId":"string"}},"responses":{"200":"PaymentOrderResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"DELETE","path":"/order/paymentOrders/{paymentOrderId}","fullPath":"/api/v2.3.0/order/paymentOrders/{paymentOrderId}","operationId":"deletePaymentOrder","name":"Cancel an existing payment order","summary":"Cancel payment order","tags":[],"parameters":[{"name":"paymentOrderId","in":"path","type":"string","required":true,"description":"The unique reference number of payment"},{"name":"payload","in":"body","type":"object","required":false,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}}},"responses":{"200":"PaymentOrderResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/order/paymentOrders","fullPath":"/api/v2.3.0/order/paymentOrders","operationId":"getPaymentOrders","name":"Retrieves the list of payment orders","summary":"Retrieves the payment orders","tags":[],"parameters":[{"name":"paymentOrderId","in":"query","type":"string","required":false,"description":"The unique reference number of payment"},{"name":"currentState","in":"query","type":"string","required":false,"description":"Contains the current state of the transaction"},{"name":"paymentStatus","in":"query","type":"string","required":false,"description":"Describes the current status of the payment order in the payment system"},{"name":"paymentOrderProductId","in":"query","type":"string","required":false,"description":"Indicates the payment order product for which payment is initiated"},{"name":"debitAccountId","in":"query","type":"string","required":false,"description":"Indicates the debit account number of the payment or transaction."},{"name":"orderingCustomerId","in":"query","type":"string","required":false,"description":"Indicates the customer id for the ordering customer"},{"name":"uniqueTransactionReference","in":"query","type":"string","required":false,"description":"Unique transaction reference details"},{"name":"executionDate","in":"query","type":"string","required":false,"description":"Date on which the transaction or payment gets processed, i.e. the processing date of the transaction."},{"name":"bulkReference","in":"query","type":"string","required":false,"description":"Contains bulk master reference for the payment."},{"name":"paymentSource","in":"query","type":"string","required":false,"description":"Indicates the source from where the payment is originated"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"PaymentOrdersResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"POST","path":"/order/paymentOrders","fullPath":"/api/v2.3.0/order/paymentOrders","operationId":"createPaymentOrder","name":"Creates a new payment order","summary":"Create payment order","tags":[],"parameters":[{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"narratives":[{}],"additionalInformations":[{}],"remittanceInformations":[{}],"beneficiaryAddresses":[{}],"signatories":[{}],"invoiceReferences":[{}],"charges":[{}],"overrides":[{}],"reasons":[{}],"accountWithInstitutionAddresses":[{}],"orderingPostAddrLine":[{}],"contextNames":[{}],"contextValues":[{}],"messageType":[{}],"paymentOrderProductId":"string"}},"responses":{"200":"PaymentOrderResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/order/paymentOrders/paymentOrderApprovals/{paymentOrderId}","fullPath":"/api/v2.3.0/order/paymentOrders/paymentOrderApprovals/{paymentOrderId}","operationId":"approvePaymentOrder","name":" Approve an initiated payment order","summary":"Approve payment order","tags":[],"parameters":[{"name":"paymentOrderId","in":"path","type":"string","required":true,"description":"The unique reference number of payment"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"PaymentOrderResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"POST","path":"/order/paymentOrders/orderSimulation","fullPath":"/api/v2.3.0/order/paymentOrders/orderSimulation","operationId":"createTransparency","name":"Creates transparency check details from payment order to infinity","summary":"Creates transparency check","tags":[],"parameters":[{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"beneficiaryAddresses":[{}],"accountWithInstitutionAddresses":[{}],"narratives":[{}],"charges":[{}],"contextNames":[{}],"contextValues":[{}],"messageType":[{}],"orderInitiationType":"string","beneficiaryId":"string","paymentOrderProductId":"string","debitAccount":"string","beneficiaryAccountId":"string","beneficiaryIBAN":"string","beneficiaryName":"string","beneficiaryCountryCode":"string"}},"responses":{"200":"TransparencyResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}}]},{"key":"order-paymentOrders-service-v2.4.0","title":"Payment Orders","version":"v2.4.0","description":"API for the creation, viewing and management of payment orders","endpointCount":26,"endpoints":[{"method":"GET","path":"/order/paymentOrders/purposes","fullPath":"/api/v2.4.0/order/paymentOrders/purposes","operationId":"getPaymentOrderPurposes","name":"Retrieves the list of payment order purpose code details","summary":"Retrieves payment order purposes details","tags":[],"parameters":[{"name":"paymentOrderPurposeCodeId","in":"query","type":"string","required":false,"description":"Indicates the Id of payment purpose code i.e. purpose of the instruction based on a set of pre-defined categories."},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"PaymentOrderPurposesResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/order/paymentOrders/products","fullPath":"/api/v2.4.0/order/paymentOrders/products","operationId":"getPaymentOrderProducts","name":"Retrieves the list of payment order product details","summary":"Retrieves payment order products details","tags":[],"parameters":[{"name":"paymentProductGroupId","in":"query","type":"string","required":false,"description":"Payment method group details of the payment"},{"name":"paymentOrderProductId","in":"query","type":"string","required":false,"description":"Indicates the payment order product for which payment is initiated"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"PaymentOrderProductsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/order/paymentOrders/countryRules","fullPath":"/api/v2.4.0/order/paymentOrders/countryRules","operationId":"getPaymentOrderCountryRules","name":"Retrieves the list of payment order country rule details","summary":"Retrieves payment order country rules details","tags":[],"parameters":[{"name":"countryId","in":"query","type":"string","required":false,"description":"ISO country code of the financial institution. "},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"PaymentOrderCountryRulesResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"POST","path":"/order/paymentOrders/sepaInstantPayments","fullPath":"/api/v2.4.0/order/paymentOrders/sepaInstantPayments","operationId":"createSepaInstantPayment","name":"Creates a new Sepa Instant payment record","summary":"Create sepa instant payment","tags":[],"parameters":[{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"narratives":[{}],"contexts":[{}],"charges":[{}],"paymentOrderProductId":"string","accountType":"string","debitAccountId":"string","debitCurrency":"string","debitAccountIBAN":"string","paymentCurrencyId":"string","amount":0.0,"beneficiaryIBAN":"string","requestedAmount":"string","requestedCurrency":"string","orderingCustomerId":"string","orderingCustomerName":"string"}},"responses":{"200":"SepaInstantPaymentResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"POST","path":"/order/paymentOrders/sepaInstantTransfers","fullPath":"/api/v2.4.0/order/paymentOrders/sepaInstantTransfers","operationId":"createSepaInstantTransfer","name":"Creates a new Sepa instant transfer record","summary":"Create sepa instant transfer","tags":[],"parameters":[{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"narratives":[{}],"contexts":[{}],"charges":[{}],"paymentOrderProductId":"string","accountType":"string","debitAccountId":"string","debitCurrency":"string","paymentCurrencyId":"string","amount":0.0,"beneficiaryAccountId":"string","beneficiaryName":"string","consent":"string","requestedAmount":"string","requestedCurrency":"string","orderingCustomerId":"string"}},"responses":{"200":"SepaInstantTransferResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"POST","path":"/order/paymentOrders/sepaPayments","fullPath":"/api/v2.4.0/order/paymentOrders/sepaPayments","operationId":"createSepaPayment","name":"Creates a new Sepa payment record for an external account","summary":"Create sepa payment","tags":[],"parameters":[{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"narratives":[{}],"benPostAddrLine":[{}],"acctWithBankPostAddrLn":[{}],"orderingPostAddrLine":[{}],"contexts":[{}],"charges":[{}],"paymentOrderProductId":"string","accountType":"string","debitAccountId":"string","debitCurrency":"string","debitAccountIBAN":"string","paymentCurrencyId":"string","amount":0.0,"beneficiaryIBAN":"string","purpose":"string"}},"responses":{"200":"SepaPaymentResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"POST","path":"/order/paymentOrders/swiftPayments","fullPath":"/api/v2.4.0/order/paymentOrders/swiftPayments","operationId":"createSwiftPayment","name":"Creates a new Swift payment record for an external account","summary":"Create swift payment","tags":[],"parameters":[{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"orderingPostSwiftAddress":[{}],"benPostSwiftAddress":[{}],"acctWithBankPostAddrLn":[{}],"narratives":[{}],"contexts":[{}],"charges":[{}],"paymentOrderProductId":"string","accountType":"string","debitAccountId":"string","debitCurrency":"string","debtorCountryCode":"string","orderingCustomerId":"string","orderingCustomerName":"string","orderingCustomerAddress":"string","orderingPaymentFxCustomerRate":"string"}},"responses":{"200":"SwiftPaymentResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"POST","path":"/order/paymentOrders/fasterPayments","fullPath":"/api/v2.4.0/order/paymentOrders/fasterPayments","operationId":"createFasterPayment","name":"Creates a new fast payment record for an external account","summary":"Create faster payment","tags":[],"parameters":[{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"orderingPostSwiftAddress":[{}],"benPostSwiftAddress":[{}],"acctWithBankPostAddrLn":[{}],"narratives":[{}],"contexts":[{}],"charges":[{}],"paymentOrderProductId":"string","accountType":"string","debitAccountId":"string","debitCurrency":"string","debtorSortCode":"string","debtorCountryCode":"string","orderingCustomerId":"string","orderingCustomerName":"string","orderingCustomerAddress":"string"}},"responses":{"200":"FasterPaymentResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/order/paymentOrders/{paymentOrderId}/cancellations","fullPath":"/api/v2.4.0/order/paymentOrders/{paymentOrderId}/cancellations","operationId":"cancelExternalPaymentOrder","name":"Cancel the existing payment order for external account","summary":"Cancel external payment order","tags":[],"parameters":[{"name":"paymentOrderId","in":"path","type":"string","required":true,"description":"The unique reference number of payment"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"internalStatus":"string","cancellationReason":"string","remarks":"string","initiator":"string"}},"responses":{"200":"ExternalPaymentOrderResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"DELETE","path":"/order/paymentOrders/{paymentOrderId}/cancellations","fullPath":"/api/v2.4.0/order/paymentOrders/{paymentOrderId}/cancellations","operationId":"rejectPaymentOrder","name":"Reject an initiated payment order","summary":"Reject payment order","tags":[],"parameters":[{"name":"paymentOrderId","in":"path","type":"string","required":true,"description":"The unique reference number of payment"},{"name":"payload","in":"body","type":"object","required":false,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}}},"responses":{"200":"PaymentOrderResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/order/paymentOrders/isoClearingCodes","fullPath":"/api/v2.4.0/order/paymentOrders/isoClearingCodes","operationId":"getISOClearingCodes","name":"Retrieves the list of ISO clearing codes","summary":"Retrieves ISO clearing codes details","tags":[],"parameters":[{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"ISOClearingCodesResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"POST","path":"/order/paymentOrders/gpi/payments/{paymentId}/status","fullPath":"/api/v2.4.0/order/paymentOrders/gpi/payments/{paymentId}/status","operationId":"createGPIPaymentStatus","name":"Create a GPI payment status with unique transaction reference","summary":"Create GPI payment status","tags":[],"parameters":[{"name":"paymentId","in":"path","type":"string","required":true,"description":"Indicates the unique reference number of the payment"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"UETRId":"string","paymentReference":"string","requestMessage":"string","responseMessage":"string"}},"responses":{"200":"GPIPaymentStatusResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/order/paymentOrders/gpi/payments/{paymentId}/status","fullPath":"/api/v2.4.0/order/paymentOrders/gpi/payments/{paymentId}/status","operationId":"updateGPIPaymentStatus","name":"Update GPI payment status with unique transaction reference","summary":"Update GPI payment status","tags":[],"parameters":[{"name":"paymentId","in":"path","type":"string","required":true,"description":"Indicates the unique reference number of the payment"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"UETRId":"string","paymentReference":"string","requestMessage":"string","responseMessage":"string"}},"responses":{"200":"GPIPaymentStatusResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/order/paymentOrders/gpi/trackedPayments","fullPath":"/api/v2.4.0/order/paymentOrders/gpi/trackedPayments","operationId":"getGpiPaymentTracking","name":"Retrieves the GPI Tracking information","summary":"Retrieves the GPI tracking details","tags":[],"parameters":[{"name":"paymentId","in":"query","type":"string","required":false,"description":"Indicates the unique reference number of the payment"},{"name":"paymentMethod","in":"query","type":"string","required":false,"description":"Method chosen to make the payment"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"GpiPaymentTrackingResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/order/paymentOrders/recalls/eligibleOrders","fullPath":"/api/v2.4.0/order/paymentOrders/recalls/eligibleOrders","operationId":"getPaymentOrdersForRecall","name":"Retrieves the payment orders for recall","summary":"Retrieves the completed payment orders which are available for recall initiation","tags":[],"parameters":[{"name":"orderingCustomerId","in":"query","type":"string","required":false,"description":"Indicates the customer id for the ordering customer"},{"name":"paymentOrderId","in":"query","type":"string","required":false,"description":"The unique reference number of payment"},{"name":"paymentOrderProductId","in":"query","type":"string","required":false,"description":"Indicates the payment order product for which payment is initiated"},{"name":"startDate","in":"query","type":"string","required":false,"description":"Contains the date on which the transaction or payment gets initiated."},{"name":"endDate","in":"query","type":"string","required":false,"description":"Indicates the date till which the transaction history requested. If 20120101 is the start date and 20120201 is the end date, all transactions that are booked between January 1 to February 1 2012 are r"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"PaymentOrdersForRecallResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/order/paymentOrders/trackedPayments","fullPath":"/api/v2.4.0/order/paymentOrders/trackedPayments","operationId":"getTrackedPaymentOrders","name":"Retrieves the payment order for the given order reference","summary":"Retrieves the payment order in order to track the payment order based on the given order reference or system reference","tags":[],"parameters":[{"name":"paymentOrderId","in":"query","type":"string","required":false,"description":"The unique reference number of payment"},{"name":"paymentSystemId","in":"query","type":"string","required":false,"description":"Payment system id details"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"TrackedPaymentOrdersResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/order/paymentOrders/transactions","fullPath":"/api/v2.4.0/order/paymentOrders/transactions","operationId":"getPaymentOrderTransactions","name":"Retrieves the list of payment order details","summary":"Retrieves the payment order details","tags":[],"parameters":[{"name":"paymentDirection","in":"query","type":"string","required":false,"description":"Indicates the direction of payment i.e. incoming, outgoing, book or redirect"},{"name":"endToEndReference","in":"query","type":"string","required":false,"description":"Indicates the end to end reference for the payment. This field can be provided by the person who instructs the payment and this flows through the lifecycle of the payment."},{"name":"endToEndReferenceNotEqual","in":"query","type":"string","required":false,"description":"Contains the end to end reference for the payment. This field can be provided by the person who instructs the payment and this flows through the lifecycle of the payment which implies the not equals o"},{"name":"serviceIdentifier","in":"query","type":"string","required":false,"description":"Contains the reference number in the user header block of the payment message"},{"name":"serviceIdentifierNotEqual","in":"query","type":"string","required":false,"description":"Contains the reference number in the user header block of the payment message which implies the not equals operand"},{"name":"debitCustomerId","in":"query","type":"string","required":false,"description":"Debtor customer details"},{"name":"creditCustomerId","in":"query","type":"string","required":false,"description":"Creditor customer id details"},{"name":"creditAccountId","in":"query","type":"string","required":false,"description":"Credit account identifier of the payment or transaction"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"PaymentOrderTransactionsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"POST","path":"/order/paymentOrders/instantPayments","fullPath":"/api/v2.4.0/order/paymentOrders/instantPayments","operationId":"createInstantPaymentOrder","name":"Create Instant Payment Order","summary":"Create Instant Payment Order","tags":[],"parameters":[{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"benPostSwiftAddr":[{}],"benPostAddressLine":[{}],"remittanceInfo":[{}],"contextField":[{}],"contextFieldValue":[{}],"chargeDetails":[{}],"chargeInfo":[{}],"chargeAmt":[{}],"chargeCurr":[{}],"chargeAccountAmt":[{}],"chargeAcc":[{}],"chargeAccCurr":[{}],"debitAccountId":"Debit Account","debitAccountIBAN":"Debit Account IBAN","debitCurrency":"Debit Currency"}},"responses":{"200":"InstantPaymentOrderResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/order/paymentOrders/recalls/status","fullPath":"/api/v2.4.0/order/paymentOrders/recalls/status","operationId":"getPaymentOrderRecallStatus","name":"Retrieve the recall status of the payment order","summary":"Retrieve the recall status of the payment order for which the recall has been initiated","tags":[],"parameters":[{"name":"paymentOrderId","in":"query","type":"string","required":false,"description":"The unique reference number of payment"},{"name":"paymentOrderProductId","in":"query","type":"string","required":false,"description":"Indicates the payment order product for which payment is initiated"},{"name":"orderingCustomerId","in":"query","type":"string","required":false,"description":"Indicates the customer id for the ordering customer"},{"name":"startDate","in":"query","type":"string","required":false,"description":"Contains the date on which the transaction or payment gets initiated."},{"name":"endDate","in":"query","type":"string","required":false,"description":"Indicates the date till which the transaction history requested. If 20120101 is the start date and 20120201 is the end date, all transactions that are booked between January 1 to February 1 2012 are r"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"PaymentOrderRecallStatusResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/order/paymentOrders/{paymentOrderId}","fullPath":"/api/v2.4.0/order/paymentOrders/{paymentOrderId}","operationId":"getPaymentOrder","name":"Retrieves the details of a payment order","summary":"Retrieves payment order details","tags":[],"parameters":[{"name":"paymentOrderId","in":"path","type":"string","required":true,"description":"The unique reference number of payment"},{"name":"currentState","in":"query","type":"string","required":false,"description":"Contains the current state of the transaction"},{"name":"paymentStatus","in":"query","type":"string","required":false,"description":"Describes the current status of the payment order in the payment system"},{"name":"paymentOrderProductId","in":"query","type":"string","required":false,"description":"Indicates the payment order product for which payment is initiated"},{"name":"debitAccountId","in":"query","type":"string","required":false,"description":"Indicates the debit account number of the payment or transaction."},{"name":"orderingCustomerId","in":"query","type":"string","required":false,"description":"Indicates the customer id for the ordering customer"},{"name":"uniqueTransactionReference","in":"query","type":"string","required":false,"description":"Unique transaction reference details"},{"name":"executionDate","in":"query","type":"string","required":false,"description":"Date on which the transaction or payment gets processed, i.e. the processing date of the transaction."},{"name":"bulkReference","in":"query","type":"string","required":false,"description":"Contains bulk master reference for the payment."},{"name":"paymentSource","in":"query","type":"string","required":false,"description":"Indicates the source from where the payment is originated"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"PaymentOrderResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"PUT","path":"/order/paymentOrders/{paymentOrderId}","fullPath":"/api/v2.4.0/order/paymentOrders/{paymentOrderId}","operationId":"updatePaymentOrder","name":"Updates an existing payment order","summary":"Update payment order details","tags":[],"parameters":[{"name":"paymentOrderId","in":"path","type":"string","required":true,"description":"The unique reference number of payment"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"narratives":[{}],"additionalInformations":[{}],"remittanceInformations":[{}],"beneficiaryAddresses":[{}],"signatories":[{}],"invoiceReferences":[{}],"charges":[{}],"overrides":[{}],"reasons":[{}],"accountWithInstitutionAddresses":[{}],"orderingPostAddrLine":[{}],"contextNames":[{}],"contextValues":[{}],"messageType":[{}],"paymentOrderProductId":"string"}},"responses":{"200":"PaymentOrderResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"DELETE","path":"/order/paymentOrders/{paymentOrderId}","fullPath":"/api/v2.4.0/order/paymentOrders/{paymentOrderId}","operationId":"deletePaymentOrder","name":"Cancel an existing payment order","summary":"Cancel payment order","tags":[],"parameters":[{"name":"paymentOrderId","in":"path","type":"string","required":true,"description":"The unique reference number of payment"},{"name":"payload","in":"body","type":"object","required":false,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}}},"responses":{"200":"PaymentOrderResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/order/paymentOrders","fullPath":"/api/v2.4.0/order/paymentOrders","operationId":"getPaymentOrders","name":"Retrieves the list of payment orders","summary":"Retrieves the payment orders","tags":[],"parameters":[{"name":"paymentOrderId","in":"query","type":"string","required":false,"description":"The unique reference number of payment"},{"name":"currentState","in":"query","type":"string","required":false,"description":"Contains the current state of the transaction"},{"name":"paymentStatus","in":"query","type":"string","required":false,"description":"Describes the current status of the payment order in the payment system"},{"name":"paymentOrderProductId","in":"query","type":"string","required":false,"description":"Indicates the payment order product for which payment is initiated"},{"name":"debitAccountId","in":"query","type":"string","required":false,"description":"Indicates the debit account number of the payment or transaction."},{"name":"orderingCustomerId","in":"query","type":"string","required":false,"description":"Indicates the customer id for the ordering customer"},{"name":"uniqueTransactionReference","in":"query","type":"string","required":false,"description":"Unique transaction reference details"},{"name":"executionDate","in":"query","type":"string","required":false,"description":"Date on which the transaction or payment gets processed, i.e. the processing date of the transaction."},{"name":"bulkReference","in":"query","type":"string","required":false,"description":"Contains bulk master reference for the payment."},{"name":"paymentSource","in":"query","type":"string","required":false,"description":"Indicates the source from where the payment is originated"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"PaymentOrdersResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"POST","path":"/order/paymentOrders","fullPath":"/api/v2.4.0/order/paymentOrders","operationId":"createPaymentOrder","name":"Creates a new payment order","summary":"Create payment order","tags":[],"parameters":[{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"narratives":[{}],"additionalInformations":[{}],"remittanceInformations":[{}],"beneficiaryAddresses":[{}],"signatories":[{}],"invoiceReferences":[{}],"charges":[{}],"overrides":[{}],"reasons":[{}],"accountWithInstitutionAddresses":[{}],"orderingPostAddrLine":[{}],"contextNames":[{}],"contextValues":[{}],"messageType":[{}],"paymentOrderProductId":"string"}},"responses":{"200":"PaymentOrderResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/order/paymentOrders/paymentOrderApprovals/{paymentOrderId}","fullPath":"/api/v2.4.0/order/paymentOrders/paymentOrderApprovals/{paymentOrderId}","operationId":"approvePaymentOrder","name":" Approve an initiated payment order","summary":"Approve payment order","tags":[],"parameters":[{"name":"paymentOrderId","in":"path","type":"string","required":true,"description":"The unique reference number of payment"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"PaymentOrderResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"POST","path":"/order/paymentOrders/orderSimulation","fullPath":"/api/v2.4.0/order/paymentOrders/orderSimulation","operationId":"createTransparency","name":"Creates transparency check details from payment order to infinity","summary":"Creates transparency check","tags":[],"parameters":[{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"beneficiaryAddresses":[{}],"accountWithInstitutionAddresses":[{}],"narratives":[{}],"charges":[{}],"contextNames":[{}],"contextValues":[{}],"messageType":[{}],"orderInitiationType":"string","beneficiaryId":"string","paymentOrderProductId":"string","debitAccount":"string","beneficiaryAccountId":"string","beneficiaryIBAN":"string","beneficiaryName":"string","beneficiaryCountryCode":"string"}},"responses":{"200":"TransparencyResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}}]},{"key":"order-paymentOrders-service-v3.0.0","title":"Payment Orders","version":"v3.0.0","description":"Payment Order Application (POA) is a Temenos Payments Application that helps bank manage their Payment Orders before they are being sent for payment execution by the bank's payment system. It provides Order Management functionality for Payers to initiate, view and manage their orders from an online ","endpointCount":14,"endpoints":[{"method":"GET","path":"/order/paymentOrders","fullPath":"/api/v3.0.0/order/paymentOrders","operationId":"getPaymentOrders","name":"Retrieve a list of authorised Payment Orders based on a specific criteria","summary":"Retrieve a list of Payment Orders","tags":[],"parameters":[{"name":"paymentOrderId","in":"query","type":"string","required":false,"description":"The unique reference number of payment"},{"name":"currentState","in":"query","type":"string","required":false,"description":"Contains the current state of the transaction"},{"name":"paymentStatus","in":"query","type":"string","required":false,"description":"Describes the current status of the payment order in the payment system"},{"name":"paymentOrderProductId","in":"query","type":"string","required":false,"description":"Indicates the payment order product for which payment is initiated"},{"name":"debitAccountId","in":"query","type":"string","required":false,"description":"Indicates the debit account number of the payment or transaction."},{"name":"orderingCustomerId","in":"query","type":"string","required":false,"description":"Indicates the customer id for the ordering customer"},{"name":"uniqueTransactionReference","in":"query","type":"string","required":false,"description":"Unique transaction reference details"},{"name":"executionDate","in":"query","type":"string","required":false,"description":"Date on which the transaction or payment gets processed, i.e. the processing date of the transaction."},{"name":"bulkReference","in":"query","type":"string","required":false,"description":"Contains bulk master reference for the payment."},{"name":"paymentSource","in":"query","type":"string","required":false,"description":"Indicates the source from where the payment is originated"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"PaymentOrdersResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"POST","path":"/order/paymentOrders","fullPath":"/api/v3.0.0/order/paymentOrders","operationId":"createPaymentOrder","name":"Create a new Payment Order.  This API can be called in validate or commit mode. Former validates and responds back with status (and errors if any). Latter validates and commits if there are no validation errors.  While creating Instant Payment Orders, set teh value of Local Instrument Code to INST.","summary":"Initiate a new Payment Order","tags":[],"parameters":[{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"narratives":[{}],"additionalInformations":[{}],"remittanceInformations":[{}],"beneficiaryAddresses":[{}],"signatories":[{}],"invoiceReferences":[{}],"charges":[{}],"overrides":[{}],"reasons":[{}],"accountWithInstitutionAddresses":[{}],"orderingPostAddrLine":[{}],"contextNames":[{}],"contextValues":[{}],"messageType":[{}],"paymentOrderProductId":"string"}},"responses":{"200":"PaymentOrderResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"POST","path":"/order/paymentOrders/instantPayments","fullPath":"/api/v3.0.0/order/paymentOrders/instantPayments","operationId":"createInstantPaymentOrder","name":"Initate a new instant Payment Order.  This API can be called in validate or commit mode. Former validates and responds back with status (and errors if any). Latter validates and commits if there are no validation errors.","summary":"Initiate a new instant Payment Order","tags":[],"parameters":[{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"benPostSwiftAddr":[{}],"benPostAddressLine":[{}],"remittanceInfo":[{}],"contextField":[{}],"contextFieldValue":[{}],"chargeDetails":[{}],"chargeInfo":[{}],"chargeAmt":[{}],"chargeCurr":[{}],"chargeAccountAmt":[{}],"chargeAcc":[{}],"chargeAccCurr":[{}],"debitAccountId":"Debit Account","debitAccountIBAN":"Debit Account IBAN","debitCurrency":"Debit Currency"}},"responses":{"200":"InstantPaymentOrderResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/order/paymentOrders/{paymentOrderId}/cancellations","fullPath":"/api/v3.0.0/order/paymentOrders/{paymentOrderId}/cancellations","operationId":"cancelExternalPaymentOrder","name":"Delete a Payment Order awaiting supervisor Approval","summary":"Reject an unauthorised Payment Order","tags":[],"parameters":[{"name":"paymentOrderId","in":"path","type":"string","required":true,"description":"The unique reference number of payment"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"internalStatus":"string","cancellationReason":"string","remarks":"string","initiator":"string"}},"responses":{"200":"ExternalPaymentOrderResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/order/paymentOrders/paymentOrderApprovals/{paymentOrderId}","fullPath":"/api/v3.0.0/order/paymentOrders/paymentOrderApprovals/{paymentOrderId}","operationId":"approvePaymentOrder","name":"Approve or reject a payment that is awaiting supervisor approval.","summary":"Authorise a Payment Order","tags":[],"parameters":[{"name":"paymentOrderId","in":"path","type":"string","required":true,"description":"The unique reference number of payment"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"narratives":[{}],"additionalInformations":[{}],"remittanceInformations":[{}],"beneficiaryAddresses":[{}],"signatories":[{}],"invoiceReferences":[{}],"charges":[{}],"overrides":[{}],"reasons":[{}],"accountWithInstitutionAddresses":[{}],"orderingPostAddrLine":[{}],"contextNames":[{}],"contextValues":[{}],"messageType":[{}],"paymentOrderProductId":"string"}},"responses":{"200":"PaymentOrderResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/order/paymentOrders/{paymentOrderId}","fullPath":"/api/v3.0.0/order/paymentOrders/{paymentOrderId}","operationId":"getPaymentOrder","name":"Retrieve a specific Order for a given Payment Order ID","summary":"Retrieve Payment Order for a given ID","tags":[],"parameters":[{"name":"paymentOrderId","in":"path","type":"string","required":true,"description":"The unique reference number of payment"},{"name":"currentState","in":"query","type":"string","required":false,"description":"Contains the current state of the transaction"},{"name":"paymentStatus","in":"query","type":"string","required":false,"description":"Describes the current status of the payment order in the payment system"},{"name":"paymentOrderProductId","in":"query","type":"string","required":false,"description":"Indicates the payment order product for which payment is initiated"},{"name":"debitAccountId","in":"query","type":"string","required":false,"description":"Indicates the debit account number of the payment or transaction."},{"name":"orderingCustomerId","in":"query","type":"string","required":false,"description":"Indicates the customer id for the ordering customer"},{"name":"uniqueTransactionReference","in":"query","type":"string","required":false,"description":"Unique transaction reference details"},{"name":"executionDate","in":"query","type":"string","required":false,"description":"Date on which the transaction or payment gets processed, i.e. the processing date of the transaction."},{"name":"bulkReference","in":"query","type":"string","required":false,"description":"Contains bulk master reference for the payment."},{"name":"paymentSource","in":"query","type":"string","required":false,"description":"Indicates the source from where the payment is originated"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"PaymentOrderResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"PUT","path":"/order/paymentOrders/{paymentOrderId}","fullPath":"/api/v3.0.0/order/paymentOrders/{paymentOrderId}","operationId":"updatePaymentOrder","name":"Amend attributes of a Payment Order that is yet to be approved by supervisor","summary":"Amend an unathorised Payment Order","tags":[],"parameters":[{"name":"paymentOrderId","in":"path","type":"string","required":true,"description":"The unique reference number of payment"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"narratives":[{}],"additionalInformations":[{}],"remittanceInformations":[{}],"beneficiaryAddresses":[{}],"signatories":[{}],"invoiceReferences":[{}],"charges":[{}],"overrides":[{}],"reasons":[{}],"accountWithInstitutionAddresses":[{}],"orderingPostAddrLine":[{}],"contextNames":[{}],"contextValues":[{}],"messageType":[{}],"paymentOrderProductId":"string"}},"responses":{"200":"PaymentOrderResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"DELETE","path":"/order/paymentOrders/{paymentOrderId}","fullPath":"/api/v3.0.0/order/paymentOrders/{paymentOrderId}","operationId":"deletePaymentOrder","name":"Cancel an approved Payment Order that is in an awaiting status viz. Warehouse, Awaiting Funds","summary":"Cancel Payment Order","tags":[],"parameters":[{"name":"paymentOrderId","in":"path","type":"string","required":true,"description":"The unique reference number of payment"},{"name":"payload","in":"body","type":"object","required":false,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}}},"responses":{"200":"PaymentOrderResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/order/paymentOrders/trackedPayments","fullPath":"/api/v3.0.0/order/paymentOrders/trackedPayments","operationId":"getTrackedPaymentOrders","name":"Retrieve the status of Payment Order for a given Order ID","summary":"Retrieve the status of an Order","tags":[],"parameters":[{"name":"paymentOrderId","in":"query","type":"string","required":false,"description":"The unique reference number of payment"},{"name":"paymentSystemId","in":"query","type":"string","required":false,"description":"Payment system id details"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"TrackedPaymentOrdersResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/order/paymentOrders/gpi/trackedPayments","fullPath":"/api/v3.0.0/order/paymentOrders/gpi/trackedPayments","operationId":"getGpiPaymentTracking","name":"Retrieve SWIFT GPI tracker status of a payment. Pre-requisite API must be called before calling this API.","summary":"Retrieve GPI tracking information","tags":[],"parameters":[{"name":"paymentId","in":"query","type":"string","required":false,"description":"Indicates the unique reference number of the payment"},{"name":"paymentMethod","in":"query","type":"string","required":false,"description":"Method chosen to make the payment"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"GpiPaymentTrackingResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/order/paymentOrders/recalls/eligibleOrders","fullPath":"/api/v3.0.0/order/paymentOrders/recalls/eligibleOrders","operationId":"getPaymentOrdersForRecall","name":"Retrieve completed payments that are eligible for recall","summary":"Retrieve the payments eligible for recall","tags":[],"parameters":[{"name":"orderingCustomerId","in":"query","type":"string","required":false,"description":"Indicates the customer id for the ordering customer"},{"name":"paymentOrderId","in":"query","type":"string","required":false,"description":"The unique reference number of payment"},{"name":"paymentOrderProductId","in":"query","type":"string","required":false,"description":"Indicates the payment order product for which payment is initiated"},{"name":"startDate","in":"query","type":"string","required":false,"description":"Contains the date on which the transaction or payment gets initiated."},{"name":"endDate","in":"query","type":"string","required":false,"description":"Indicates the date till which the transaction history requested. If 20120101 is the start date and 20120201 is the end date, all transactions that are booked between January 1 to February 1 2012 are r"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"PaymentOrdersForRecallResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/order/paymentOrders/recalls/status","fullPath":"/api/v3.0.0/order/paymentOrders/recalls/status","operationId":"getPaymentOrderRecallStatus","name":"Retrieve the status of an outward recall requests sent for completed payments","summary":"Retrieve the status of recall request","tags":[],"parameters":[{"name":"paymentOrderId","in":"query","type":"string","required":false,"description":"The unique reference number of payment"},{"name":"paymentOrderProductId","in":"query","type":"string","required":false,"description":"Indicates the payment order product for which payment is initiated"},{"name":"orderingCustomerId","in":"query","type":"string","required":false,"description":"Indicates the customer id for the ordering customer"},{"name":"startDate","in":"query","type":"string","required":false,"description":"Contains the date on which the transaction or payment gets initiated."},{"name":"endDate","in":"query","type":"string","required":false,"description":"Indicates the date till which the transaction history requested. If 20120101 is the start date and 20120201 is the end date, all transactions that are booked between January 1 to February 1 2012 are r"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"PaymentOrderRecallStatusResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"POST","path":"/order/paymentOrders/gpi/payments/{paymentId}/status","fullPath":"/api/v3.0.0/order/paymentOrders/gpi/payments/{paymentId}/status","operationId":"createGPIPaymentStatus","name":"Pre-requisite API to be called by the calling application (before get GPI status API) so as to ensure Temenos GPI tracker process retrieves the latest status from SWIFT GPI Tracker","summary":"Create a reference and update GPI tracker status","tags":[],"parameters":[{"name":"paymentId","in":"path","type":"string","required":true,"description":"Indicates the unique reference number of the payment"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"UETRId":"string","paymentReference":"string","requestMessage":"string","responseMessage":"string"}},"responses":{"200":"GPIPaymentStatusResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/order/paymentOrders/gpi/payments/{paymentId}/status","fullPath":"/api/v3.0.0/order/paymentOrders/gpi/payments/{paymentId}/status","operationId":"updateGPIPaymentStatus","name":"Pre-requisite API to be called by the calling application (before get GPI status API) so as to ensure Temenos GPI tracker process retrieves the latest status from SWIFT GPI Tracker","summary":"Updates GPI tracker status","tags":[],"parameters":[{"name":"paymentId","in":"path","type":"string","required":true,"description":"Indicates the unique reference number of the payment"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"UETRId":"string","paymentReference":"string","requestMessage":"string","responseMessage":"string"}},"responses":{"200":"GPIPaymentStatusResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}}]},{"key":"order-paymentOrders-service-v3.1.0","title":"Payment Orders","version":"v3.1.0","description":"Payment Order Application (POA) is a Temenos Payments Application that helps bank manage their Payment Orders before they are being sent for payment execution by the bank's payment system. It provides Order Management functionality for Payers to initiate, view and manage their orders from an online ","endpointCount":14,"endpoints":[{"method":"GET","path":"/order/paymentOrders","fullPath":"/api/v3.1.0/order/paymentOrders","operationId":"getPaymentOrders","name":"Retrieve list of authorised payment orders based on a specific criteria","summary":"Retrieve list of payment orders","tags":[],"parameters":[{"name":"paymentOrderId","in":"query","type":"string","required":false,"description":"The unique reference number of payment"},{"name":"currentState","in":"query","type":"string","required":false,"description":"Contains the current state of the transaction"},{"name":"paymentStatus","in":"query","type":"string","required":false,"description":"Describes the current status of the payment order in the payment system"},{"name":"paymentOrderProductId","in":"query","type":"string","required":false,"description":"Indicates the payment order product for which payment is initiated"},{"name":"debitAccountId","in":"query","type":"string","required":false,"description":"Indicates the debit account number of the payment or transaction."},{"name":"orderingCustomerId","in":"query","type":"string","required":false,"description":"Indicates the customer id for the ordering customer"},{"name":"uniqueTransactionReference","in":"query","type":"string","required":false,"description":"Unique transaction reference details"},{"name":"executionDate","in":"query","type":"string","required":false,"description":"Date on which the transaction or payment gets processed, i.e. the processing date of the transaction."},{"name":"bulkReference","in":"query","type":"string","required":false,"description":"Contains bulk master reference for the payment."},{"name":"paymentSource","in":"query","type":"string","required":false,"description":"Indicates the source from where the payment is originated"},{"name":"creditAccountId","in":"query","type":"string","required":false,"description":"Credit account identifier of the payment or transaction"},{"name":"beneficiaryAccountId","in":"query","type":"string","required":false,"description":"Unique account identifier of the beneficiary account number."},{"name":"accountWithBankBIC","in":"query","type":"string","required":false,"description":"This is the BIC code of the institution where beneficiary holds an account"},{"name":"accountWithBankClearingCode","in":"query","type":"string","required":false,"description":"This is the national clearing code or sort code of the institution where beneficiary holds an account"},{"name":"historyDetails","in":"query","type":"string","required":false,"description":"Indicates the history details such as history company id , history date, history number"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"PaymentOrdersResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"POST","path":"/order/paymentOrders","fullPath":"/api/v3.1.0/order/paymentOrders","operationId":"createPaymentOrder","name":"Create a new payment order. This API can be called in validate or commit mode. Former validates and responds back with status (and errors if any). Later validates and commits if there are no validation errors.  While creating Instant Payment Orders, set the Local Instrument Code to 'INST'.","summary":"Initiate a new payment order","tags":[],"parameters":[{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"narratives":[{}],"additionalInformations":[{}],"remittanceInformations":[{}],"beneficiaryAddresses":[{}],"signatories":[{}],"invoiceReferences":[{}],"charges":[{}],"overrides":[{}],"reasons":[{}],"accountWithInstitutionAddresses":[{}],"orderingPostAddrLine":[{}],"contextNames":[{}],"contextValues":[{}],"messageType":[{}],"paymentOrderProductId":"string"}},"responses":{"200":"PaymentOrderResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"POST","path":"/order/paymentOrders/instantPayments","fullPath":"/api/v3.1.0/order/paymentOrders/instantPayments","operationId":"createInstantPaymentOrder","name":"Initate a new instant payment order. This API can be called in validate or commit mode. Former validates and responds back with status (and errors if any). Later validates and commits if there are no validation errors.","summary":"Initiate a new instant payment order","tags":[],"parameters":[{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"benPostSwiftAddr":[{}],"benPostAddressLine":[{}],"remittanceInfo":[{}],"contextField":[{}],"contextFieldValue":[{}],"chargeDetails":[{}],"chargeInfo":[{}],"chargeAmt":[{}],"chargeCurr":[{}],"chargeAccountAmt":[{}],"chargeAcc":[{}],"chargeAccCurr":[{}],"debitAccountId":"Debit Account","debitAccountIBAN":"Debit Account IBAN","debitCurrency":"Debit Currency"}},"responses":{"200":"InstantPaymentOrderResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/order/paymentOrders/{paymentOrderId}/cancellations","fullPath":"/api/v3.1.0/order/paymentOrders/{paymentOrderId}/cancellations","operationId":"cancelExternalPaymentOrder","name":"Delete a payment order awaiting supervisor approval","summary":"Reject an unauthorised payment order","tags":[],"parameters":[{"name":"paymentOrderId","in":"path","type":"string","required":true,"description":"The unique reference number of payment"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"internalStatus":"string","cancellationReason":"string","remarks":"string","initiator":"string","extensions":{}}},"responses":{"200":"ExternalPaymentOrderResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/order/paymentOrders/paymentOrderApprovals/{paymentOrderId}","fullPath":"/api/v3.1.0/order/paymentOrders/paymentOrderApprovals/{paymentOrderId}","operationId":"approvePaymentOrder","name":"Approve or reject a payment that is awaiting supervisor approval.","summary":"Authorise a payment order","tags":[],"parameters":[{"name":"paymentOrderId","in":"path","type":"string","required":true,"description":"The unique reference number of payment"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"narratives":[{}],"additionalInformations":[{}],"remittanceInformations":[{}],"beneficiaryAddresses":[{}],"signatories":[{}],"invoiceReferences":[{}],"charges":[{}],"overrides":[{}],"reasons":[{}],"accountWithInstitutionAddresses":[{}],"orderingPostAddrLine":[{}],"contextNames":[{}],"contextValues":[{}],"messageType":[{}],"paymentOrderProductId":"string"}},"responses":{"200":"PaymentOrderResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/order/paymentOrders/{paymentOrderId}","fullPath":"/api/v3.1.0/order/paymentOrders/{paymentOrderId}","operationId":"getPaymentOrder","name":"Retrieve a specific order for a given payment order ID","summary":"Retrieve payment order for a given ID","tags":[],"parameters":[{"name":"paymentOrderId","in":"path","type":"string","required":true,"description":"The unique reference number of payment"},{"name":"currentState","in":"query","type":"string","required":false,"description":"Contains the current state of the transaction"},{"name":"paymentStatus","in":"query","type":"string","required":false,"description":"Describes the current status of the payment order in the payment system"},{"name":"paymentOrderProductId","in":"query","type":"string","required":false,"description":"Indicates the payment order product for which payment is initiated"},{"name":"debitAccountId","in":"query","type":"string","required":false,"description":"Indicates the debit account number of the payment or transaction."},{"name":"orderingCustomerId","in":"query","type":"string","required":false,"description":"Indicates the customer id for the ordering customer"},{"name":"uniqueTransactionReference","in":"query","type":"string","required":false,"description":"Unique transaction reference details"},{"name":"executionDate","in":"query","type":"string","required":false,"description":"Date on which the transaction or payment gets processed, i.e. the processing date of the transaction."},{"name":"bulkReference","in":"query","type":"string","required":false,"description":"Contains bulk master reference for the payment."},{"name":"paymentSource","in":"query","type":"string","required":false,"description":"Indicates the source from where the payment is originated"},{"name":"creditAccountId","in":"query","type":"string","required":false,"description":"Credit account identifier of the payment or transaction"},{"name":"beneficiaryAccountId","in":"query","type":"string","required":false,"description":"Unique account identifier of the beneficiary account number."},{"name":"accountWithBankBIC","in":"query","type":"string","required":false,"description":"This is the BIC code of the institution where beneficiary holds an account"},{"name":"accountWithBankClearingCode","in":"query","type":"string","required":false,"description":"This is the national clearing code or sort code of the institution where beneficiary holds an account"},{"name":"historyDetails","in":"query","type":"string","required":false,"description":"Indicates the history details such as history company id , history date, history number"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"PaymentOrderResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"PUT","path":"/order/paymentOrders/{paymentOrderId}","fullPath":"/api/v3.1.0/order/paymentOrders/{paymentOrderId}","operationId":"updatePaymentOrder","name":"Amend attributes of a payment order that is yet to be approved by supervisor","summary":"Amend an unathorised payment order","tags":[],"parameters":[{"name":"paymentOrderId","in":"path","type":"string","required":true,"description":"The unique reference number of payment"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"narratives":[{}],"additionalInformations":[{}],"remittanceInformations":[{}],"beneficiaryAddresses":[{}],"signatories":[{}],"invoiceReferences":[{}],"charges":[{}],"overrides":[{}],"reasons":[{}],"accountWithInstitutionAddresses":[{}],"orderingPostAddrLine":[{}],"contextNames":[{}],"contextValues":[{}],"messageType":[{}],"paymentOrderProductId":"string"}},"responses":{"200":"PaymentOrderResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"DELETE","path":"/order/paymentOrders/{paymentOrderId}","fullPath":"/api/v3.1.0/order/paymentOrders/{paymentOrderId}","operationId":"deletePaymentOrder","name":"Cancel an approved payment order that is in an awaiting status viz. Warehouse, Awaiting Funds","summary":"Cancel payment order","tags":[],"parameters":[{"name":"paymentOrderId","in":"path","type":"string","required":true,"description":"The unique reference number of payment"},{"name":"payload","in":"body","type":"object","required":false,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}}},"responses":{"200":"PaymentOrderResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/order/paymentOrders/trackedPayments","fullPath":"/api/v3.1.0/order/paymentOrders/trackedPayments","operationId":"getTrackedPaymentOrders","name":"Retrieve the status of payment order for a given order ID","summary":"Retrieve the status of an order","tags":[],"parameters":[{"name":"paymentOrderId","in":"query","type":"string","required":false,"description":"The unique reference number of payment"},{"name":"paymentSystemId","in":"query","type":"string","required":false,"description":"Payment system id details"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"TrackedPaymentOrdersResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/order/paymentOrders/gpi/trackedPayments","fullPath":"/api/v3.1.0/order/paymentOrders/gpi/trackedPayments","operationId":"getGpiPaymentTracking","name":"Retrieve SWIFT GPI tracker status of a payment. Pre-requisite API must be called before calling this API.","summary":"Retrieve GPI tracking information","tags":[],"parameters":[{"name":"paymentId","in":"query","type":"string","required":false,"description":"Indicates the unique reference number of the payment"},{"name":"paymentMethod","in":"query","type":"string","required":false,"description":"Method chosen to make the payment"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"GpiPaymentTrackingResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/order/paymentOrders/recalls/eligibleOrders","fullPath":"/api/v3.1.0/order/paymentOrders/recalls/eligibleOrders","operationId":"getPaymentOrdersForRecall","name":"Retrieve completed payments that are eligible for recall","summary":"Retrieve the payments eligible for recall","tags":[],"parameters":[{"name":"orderingCustomerId","in":"query","type":"string","required":false,"description":"Indicates the customer id for the ordering customer"},{"name":"paymentOrderId","in":"query","type":"string","required":false,"description":"The unique reference number of payment"},{"name":"paymentOrderProductId","in":"query","type":"string","required":false,"description":"Indicates the payment order product for which payment is initiated"},{"name":"startDate","in":"query","type":"string","required":false,"description":"Contains the date on which the transaction or payment gets initiated."},{"name":"endDate","in":"query","type":"string","required":false,"description":"Indicates the date till which the transaction history requested. If 20120101 is the start date and 20120201 is the end date, all transactions that are booked between January 1 to February 1 2012 are r"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"PaymentOrdersForRecallResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/order/paymentOrders/recalls/status","fullPath":"/api/v3.1.0/order/paymentOrders/recalls/status","operationId":"getPaymentOrderRecallStatus","name":"Retrieve the status of an outward recall requests sent for completed payments","summary":"Retrieve the status of recall request","tags":[],"parameters":[{"name":"paymentOrderId","in":"query","type":"string","required":false,"description":"The unique reference number of payment"},{"name":"paymentOrderProductId","in":"query","type":"string","required":false,"description":"Indicates the payment order product for which payment is initiated"},{"name":"orderingCustomerId","in":"query","type":"string","required":false,"description":"Indicates the customer id for the ordering customer"},{"name":"startDate","in":"query","type":"string","required":false,"description":"Contains the date on which the transaction or payment gets initiated."},{"name":"endDate","in":"query","type":"string","required":false,"description":"Indicates the date till which the transaction history requested. If 20120101 is the start date and 20120201 is the end date, all transactions that are booked between January 1 to February 1 2012 are r"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"PaymentOrderRecallStatusResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"POST","path":"/order/paymentOrders/gpi/payments/{paymentId}/status","fullPath":"/api/v3.1.0/order/paymentOrders/gpi/payments/{paymentId}/status","operationId":"createGPIPaymentStatus","name":"Pre-requisite API to be called by the calling application (before get GPI status API) so as to ensure Temenos GPI tracker process creates and updates the latest status from SWIFT GPI tracker","summary":"Create a reference and update GPI tracker status","tags":[],"parameters":[{"name":"paymentId","in":"path","type":"string","required":true,"description":"Indicates the unique reference number of the payment"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"UETRId":"string","paymentReference":"string","requestMessage":"string","responseMessage":"string","extensions":{}}},"responses":{"200":"GPIPaymentStatusResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/order/paymentOrders/gpi/payments/{paymentId}/status","fullPath":"/api/v3.1.0/order/paymentOrders/gpi/payments/{paymentId}/status","operationId":"updateGPIPaymentStatus","name":"Pre-requisite API to be called by the calling application (before get GPI status API) so as to ensure Temenos GPI tracker process retrieves and updates the latest status from SWIFT GPI tracker","summary":"Updates GPI tracker status","tags":[],"parameters":[{"name":"paymentId","in":"path","type":"string","required":true,"description":"Indicates the unique reference number of the payment"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"UETRId":"string","paymentReference":"string","requestMessage":"string","responseMessage":"string","extensions":{}}},"responses":{"200":"GPIPaymentStatusResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}}]},{"key":"order-paymentOrders-service-v3.2.0","title":"Payment Orders","version":"v3.2.0","description":"Payment order application (POA) is a Temenos payments application that helps bank manage their payment orders before they are being sent for payment execution by the bank's payment system. It provides order management functionality for payers to initiate, view and manage their orders from an online ","endpointCount":15,"endpoints":[{"method":"GET","path":"/order/paymentOrders","fullPath":"/api/v3.2.0/order/paymentOrders","operationId":"getPaymentOrders","name":"Retrieve list of authorised payment orders based on a specific criteria","summary":"Retrieve list of payment orders","tags":[],"parameters":[{"name":"paymentOrderId","in":"query","type":"string","required":false,"description":"The unique reference number of payment"},{"name":"currentState","in":"query","type":"string","required":false,"description":"Contains the current state of the transaction"},{"name":"paymentStatus","in":"query","type":"string","required":false,"description":"Describes the current status of the payment order in the payment system"},{"name":"paymentOrderProductId","in":"query","type":"string","required":false,"description":"Indicates the payment order product for which payment is initiated"},{"name":"debitAccountId","in":"query","type":"string","required":false,"description":"Indicates the debit account number of the payment or transaction."},{"name":"orderingCustomerId","in":"query","type":"string","required":false,"description":"Indicates the customer id for the ordering customer"},{"name":"uniqueTransactionReference","in":"query","type":"string","required":false,"description":"Unique transaction reference details"},{"name":"executionDate","in":"query","type":"string","required":false,"description":"Date on which the transaction or payment gets processed, i.e. the processing date of the transaction."},{"name":"bulkReference","in":"query","type":"string","required":false,"description":"Contains bulk master reference for the payment."},{"name":"paymentSource","in":"query","type":"string","required":false,"description":"Indicates the source from where the payment is originated"},{"name":"creditAccountId","in":"query","type":"string","required":false,"description":"Credit account identifier of the payment or transaction"},{"name":"beneficiaryAccountId","in":"query","type":"string","required":false,"description":"Unique account identifier of the beneficiary account number."},{"name":"accountWithBankBIC","in":"query","type":"string","required":false,"description":"This is the BIC code of the institution where beneficiary holds an account"},{"name":"accountWithBankClearingCode","in":"query","type":"string","required":false,"description":"This is the national clearing code or sort code of the institution where beneficiary holds an account"},{"name":"historyDetails","in":"query","type":"string","required":false,"description":"Indicates the history details such as history company id , history date, history number"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying entity/company/branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"PaymentOrdersResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"POST","path":"/order/paymentOrders","fullPath":"/api/v3.2.0/order/paymentOrders","operationId":"createPaymentOrder","name":"Create a new payment order. This API can be called in validate or commit mode. Former validates and responds back with status (and errors if any). Latter validates and commits if there are no validation errors.  While creating instant payment orders, set the local instrument code to 'INST'.","summary":"Initiate a new payment order","tags":[],"parameters":[{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying entity/company/branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"narratives":[{}],"additionalInformations":[{}],"remittanceInformations":[{}],"beneficiaryAddresses":[{}],"signatories":[{}],"invoiceReferences":[{}],"charges":[{}],"overrides":[{}],"reasons":[{}],"accountWithInstitutionAddresses":[{}],"orderingPostAddrLine":[{}],"contextNames":[{}],"contextValues":[{}],"messageType":[{}],"paymentOrderProductId":"string"}},"responses":{"200":"PaymentOrderResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"POST","path":"/order/paymentOrders/instantPayments","fullPath":"/api/v3.2.0/order/paymentOrders/instantPayments","operationId":"createInstantPaymentOrder","name":"Initate a new instant payment order.  This API can be called in validate or commit mode. Former validates and responds back with status (and errors if any). Latter validates and commits if there are no validation errors.","summary":"Initiate a new instant payment order","tags":[],"parameters":[{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"benPostSwiftAddr":[{}],"benPostAddressLine":[{}],"remittanceInfo":[{}],"contextField":[{}],"contextFieldValue":[{}],"chargeDetails":[{}],"chargeInfo":[{}],"chargeAmt":[{}],"chargeCurr":[{}],"chargeAccountAmt":[{}],"chargeAcc":[{}],"chargeAccCurr":[{}],"debitAccountId":"Debit Account","debitAccountIBAN":"Debit Account IBAN","debitCurrency":"Debit Currency"}},"responses":{"200":"InstantPaymentOrderResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/order/paymentOrders/{paymentOrderId}/cancellations","fullPath":"/api/v3.2.0/order/paymentOrders/{paymentOrderId}/cancellations","operationId":"cancelExternalPaymentOrder","name":"Delete a payment order awaiting supervisor approval","summary":"Reject an unauthorised payment order","tags":[],"parameters":[{"name":"paymentOrderId","in":"path","type":"string","required":true,"description":"The unique reference number of payment"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying entity/company/branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"internalStatus":"string","cancellationReason":"string","remarks":"string","initiator":"string","extensions":{}}},"responses":{"200":"ExternalPaymentOrderResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/order/paymentOrders/paymentOrderApprovals/{paymentOrderId}","fullPath":"/api/v3.2.0/order/paymentOrders/paymentOrderApprovals/{paymentOrderId}","operationId":"approvePaymentOrder","name":"Approve or reject a payment that is awaiting supervisor approval.","summary":"Authorise a payment order","tags":[],"parameters":[{"name":"paymentOrderId","in":"path","type":"string","required":true,"description":"The unique reference number of payment"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying entity/company/branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"narratives":[{}],"additionalInformations":[{}],"remittanceInformations":[{}],"beneficiaryAddresses":[{}],"signatories":[{}],"invoiceReferences":[{}],"charges":[{}],"overrides":[{}],"reasons":[{}],"accountWithInstitutionAddresses":[{}],"orderingPostAddrLine":[{}],"contextNames":[{}],"contextValues":[{}],"messageType":[{}],"paymentOrderProductId":"string"}},"responses":{"200":"PaymentOrderResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/order/paymentOrders/{paymentOrderId}","fullPath":"/api/v3.2.0/order/paymentOrders/{paymentOrderId}","operationId":"getPaymentOrder","name":"Retrieve a specific order for a given payment order id","summary":"Retrieve payment order for a given id","tags":[],"parameters":[{"name":"paymentOrderId","in":"path","type":"string","required":true,"description":"The unique reference number of payment"},{"name":"currentState","in":"query","type":"string","required":false,"description":"Contains the current state of the transaction"},{"name":"paymentStatus","in":"query","type":"string","required":false,"description":"Describes the current status of the payment order in the payment system"},{"name":"paymentOrderProductId","in":"query","type":"string","required":false,"description":"Indicates the payment order product for which payment is initiated"},{"name":"debitAccountId","in":"query","type":"string","required":false,"description":"Indicates the debit account number of the payment or transaction."},{"name":"orderingCustomerId","in":"query","type":"string","required":false,"description":"Indicates the customer id for the ordering customer"},{"name":"uniqueTransactionReference","in":"query","type":"string","required":false,"description":"Unique transaction reference details"},{"name":"executionDate","in":"query","type":"string","required":false,"description":"Date on which the transaction or payment gets processed, i.e. the processing date of the transaction."},{"name":"bulkReference","in":"query","type":"string","required":false,"description":"Contains bulk master reference for the payment."},{"name":"paymentSource","in":"query","type":"string","required":false,"description":"Indicates the source from where the payment is originated"},{"name":"creditAccountId","in":"query","type":"string","required":false,"description":"Credit account identifier of the payment or transaction"},{"name":"beneficiaryAccountId","in":"query","type":"string","required":false,"description":"Unique account identifier of the beneficiary account number."},{"name":"accountWithBankBIC","in":"query","type":"string","required":false,"description":"This is the BIC code of the institution where beneficiary holds an account"},{"name":"accountWithBankClearingCode","in":"query","type":"string","required":false,"description":"This is the national clearing code or sort code of the institution where beneficiary holds an account"},{"name":"historyDetails","in":"query","type":"string","required":false,"description":"Indicates the history details such as history company id , history date, history number"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying entity/company/branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"PaymentOrderResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"PUT","path":"/order/paymentOrders/{paymentOrderId}","fullPath":"/api/v3.2.0/order/paymentOrders/{paymentOrderId}","operationId":"updatePaymentOrder","name":"Amend attributes of a payment order that is yet to be approved by supervisor","summary":"Amend an unathorised payment order","tags":[],"parameters":[{"name":"paymentOrderId","in":"path","type":"string","required":true,"description":"The unique reference number of payment"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying entity/company/branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"narratives":[{}],"additionalInformations":[{}],"remittanceInformations":[{}],"beneficiaryAddresses":[{}],"signatories":[{}],"invoiceReferences":[{}],"charges":[{}],"overrides":[{}],"reasons":[{}],"accountWithInstitutionAddresses":[{}],"orderingPostAddrLine":[{}],"contextNames":[{}],"contextValues":[{}],"messageType":[{}],"paymentOrderProductId":"string"}},"responses":{"200":"PaymentOrderResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"DELETE","path":"/order/paymentOrders/{paymentOrderId}","fullPath":"/api/v3.2.0/order/paymentOrders/{paymentOrderId}","operationId":"deletePaymentOrder","name":"Cancel an approved payment order that is in an awaiting status viz. warehouse, awaiting funds","summary":"Cancel payment order","tags":[],"parameters":[{"name":"paymentOrderId","in":"path","type":"string","required":true,"description":"The unique reference number of payment"},{"name":"payload","in":"body","type":"object","required":false,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying entity/company/branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}}},"responses":{"200":"PaymentOrderResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/order/paymentOrders/trackedPayments","fullPath":"/api/v3.2.0/order/paymentOrders/trackedPayments","operationId":"getTrackedPaymentOrders","name":"Retrieve the status of payment order for a given order id","summary":"Retrieve the status of an order","tags":[],"parameters":[{"name":"paymentOrderId","in":"query","type":"string","required":false,"description":"The unique reference number of payment"},{"name":"paymentSystemId","in":"query","type":"string","required":false,"description":"Payment system id details"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying entity/company/branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"TrackedPaymentOrdersResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/order/paymentOrders/gpi/trackedPayments","fullPath":"/api/v3.2.0/order/paymentOrders/gpi/trackedPayments","operationId":"getGpiPaymentTracking","name":"Retrieve SWIFT GPI tracker status of a payment. Pre-requisite API must be called before calling this API.","summary":"Retrieve GPI tracking information","tags":[],"parameters":[{"name":"paymentId","in":"query","type":"string","required":false,"description":"Indicates the unique reference number of the payment"},{"name":"paymentMethod","in":"query","type":"string","required":false,"description":"Method chosen to make the payment"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying entity/company/branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"GpiPaymentTrackingResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/order/paymentOrders/recalls/eligibleOrders","fullPath":"/api/v3.2.0/order/paymentOrders/recalls/eligibleOrders","operationId":"getPaymentOrdersForRecall","name":"Retrieve completed payments that are eligible for recall","summary":"Retrieve the payments eligible for recall","tags":[],"parameters":[{"name":"orderingCustomerId","in":"query","type":"string","required":false,"description":"Indicates the customer id for the ordering customer"},{"name":"paymentOrderId","in":"query","type":"string","required":false,"description":"The unique reference number of payment"},{"name":"paymentOrderProductId","in":"query","type":"string","required":false,"description":"Indicates the payment order product for which payment is initiated"},{"name":"startDate","in":"query","type":"string","required":false,"description":"Contains the date on which the transaction or payment gets initiated."},{"name":"endDate","in":"query","type":"string","required":false,"description":"Indicates the date till which the transaction history requested. If 20120101 is the start date and 20120201 is the end date, all transactions that are booked between January 1 to February 1 2012 are r"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying entity/company/branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"PaymentOrdersForRecallResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/order/paymentOrders/recalls/status","fullPath":"/api/v3.2.0/order/paymentOrders/recalls/status","operationId":"getPaymentOrderRecallStatus","name":"Retrieve the status of an outward recall requests sent for completed payments","summary":"Retrieve the status of recall request","tags":[],"parameters":[{"name":"paymentOrderId","in":"query","type":"string","required":false,"description":"The unique reference number of payment"},{"name":"paymentOrderProductId","in":"query","type":"string","required":false,"description":"Indicates the payment order product for which payment is initiated"},{"name":"orderingCustomerId","in":"query","type":"string","required":false,"description":"Indicates the customer id for the ordering customer"},{"name":"startDate","in":"query","type":"string","required":false,"description":"Contains the date on which the transaction or payment gets initiated."},{"name":"endDate","in":"query","type":"string","required":false,"description":"Indicates the date till which the transaction history requested. If 20120101 is the start date and 20120201 is the end date, all transactions that are booked between January 1 to February 1 2012 are r"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying entity/company/branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"PaymentOrderRecallStatusResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"POST","path":"/order/paymentOrders/gpi/payments/{paymentId}/status","fullPath":"/api/v3.2.0/order/paymentOrders/gpi/payments/{paymentId}/status","operationId":"createGPIPaymentStatus","name":"Pre-requisite API to be called by the calling application (before get GPI status API) so as to ensure Temenos GPI tracker process creates and updates the latest status from SWIFT GPI tracker","summary":"Create a reference and update GPI tracker status","tags":[],"parameters":[{"name":"paymentId","in":"path","type":"string","required":true,"description":"Indicates the unique reference number of the payment"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying entity/company/branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"UETRId":"string","paymentReference":"string","requestMessage":"string","responseMessage":"string","extensions":{}}},"responses":{"200":"GPIPaymentStatusResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/order/paymentOrders/gpi/payments/{paymentId}/status","fullPath":"/api/v3.2.0/order/paymentOrders/gpi/payments/{paymentId}/status","operationId":"updateGPIPaymentStatus","name":"Pre-requisite API to be called by the calling application (before get GPI status API) so as to ensure Temenos GPI tracker process retrieves and updates the latest status from SWIFT GPI tracker","summary":"Updates GPI tracker status","tags":[],"parameters":[{"name":"paymentId","in":"path","type":"string","required":true,"description":"Indicates the unique reference number of the payment"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying entity/company/branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"UETRId":"string","paymentReference":"string","requestMessage":"string","responseMessage":"string","extensions":{}}},"responses":{"200":"GPIPaymentStatusResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/order/paymentOrders/externalCodes","fullPath":"/api/v3.2.0/order/paymentOrders/externalCodes","operationId":"getIsoExternalCodes","name":"Retrieves the list of ISO external codes applicable for different fields in ISO messages","summary":"Retrieve ISO external code lists","tags":[],"parameters":[{"name":"id","in":"query","type":"string","required":false,"description":"Contains the daily position class id."},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying entity/company/branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"IsoExternalCodesResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}}]},{"key":"order-paymentOrders-service-v3.3.0","title":"Payment Orders","version":"v3.3.0","description":"Payment order application (POA) is a Temenos payments application that helps bank manage their payment orders before they are being sent for payment execution by the bank's payment system. It provides order management functionality for payers to initiate, view and manage their orders from an online ","endpointCount":19,"endpoints":[{"method":"GET","path":"/order/paymentOrders","fullPath":"/api/v3.3.0/order/paymentOrders","operationId":"getPaymentOrders","name":"Retrieve list of authorised payment orders based on a specific criteria","summary":"Retrieve list of payment orders","tags":[],"parameters":[{"name":"paymentOrderId","in":"query","type":"string","required":false,"description":"The unique reference number of payment"},{"name":"currentState","in":"query","type":"string","required":false,"description":"Contains the current state of the transaction"},{"name":"paymentStatus","in":"query","type":"string","required":false,"description":"Describes the current status of the payment order in the payment system"},{"name":"paymentOrderProductId","in":"query","type":"string","required":false,"description":"Indicates the payment order product for which payment is initiated"},{"name":"debitAccountId","in":"query","type":"string","required":false,"description":"Indicates the debit account number of the payment or transaction."},{"name":"orderingCustomerId","in":"query","type":"string","required":false,"description":"Indicates the customer id for the ordering customer"},{"name":"uniqueTransactionReference","in":"query","type":"string","required":false,"description":"Unique transaction reference details"},{"name":"executionDate","in":"query","type":"string","required":false,"description":"Date on which the transaction or payment gets processed, i.e. the processing date of the transaction."},{"name":"bulkReference","in":"query","type":"string","required":false,"description":"Contains bulk master reference for the payment."},{"name":"paymentSource","in":"query","type":"string","required":false,"description":"Indicates the source from where the payment is originated"},{"name":"creditAccountId","in":"query","type":"string","required":false,"description":"Credit account identifier of the payment or transaction"},{"name":"beneficiaryAccountId","in":"query","type":"string","required":false,"description":"Unique account identifier of the beneficiary account number."},{"name":"accountWithBankBIC","in":"query","type":"string","required":false,"description":"This is the BIC code of the institution where beneficiary holds an account"},{"name":"accountWithBankClearingCode","in":"query","type":"string","required":false,"description":"This is the national clearing code or sort code of the institution where beneficiary holds an account"},{"name":"historyDetails","in":"query","type":"string","required":false,"description":"Indicates the history details such as history company id , history date, history number"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"PaymentOrdersResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"POST","path":"/order/paymentOrders","fullPath":"/api/v3.3.0/order/paymentOrders","operationId":"createPaymentOrder","name":"Create a new payment order. This API can be called in validate or commit mode. Former validates and responds back with status (and errors if any). Latter validates and commits if there are no validation errors.  While creating instant payment orders, set the local instrument code to 'INST'.","summary":"Initiate a new payment order","tags":[],"parameters":[{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"narratives":[{}],"additionalInformations":[{}],"remittanceInformations":[{}],"beneficiaryAddresses":[{}],"signatories":[{}],"invoiceReferences":[{}],"charges":[{}],"overrides":[{}],"reasons":[{}],"accountWithInstitutionAddresses":[{}],"orderingPostAddrLine":[{}],"contextNames":[{}],"contextValues":[{}],"messageType":[{}],"paymentOrderProductId":"string"}},"responses":{"200":"PaymentOrderResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"POST","path":"/order/paymentOrders/instantPayments","fullPath":"/api/v3.3.0/order/paymentOrders/instantPayments","operationId":"createInstantPaymentOrder","name":"Initate a new instant payment order.  This API can be called in validate or commit mode. Former validates and responds back with status (and errors if any). Latter validates and commits if there are no validation errors.","summary":"Initiate a new instant payment order","tags":[],"parameters":[{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"benPostSwiftAddr":[{}],"benPostAddressLine":[{}],"remittanceInfo":[{}],"contextField":[{}],"contextFieldValue":[{}],"chargeDetails":[{}],"chargeInfo":[{}],"chargeAmt":[{}],"chargeCurr":[{}],"chargeAccountAmt":[{}],"chargeAcc":[{}],"chargeAccCurr":[{}],"debitAccountId":"Debit Account","debitAccountIBAN":"Debit Account IBAN","debitCurrency":"Debit Currency"}},"responses":{"200":"InstantPaymentOrderResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/order/paymentOrders/{paymentOrderId}/cancellations","fullPath":"/api/v3.3.0/order/paymentOrders/{paymentOrderId}/cancellations","operationId":"cancelExternalPaymentOrder","name":"Delete a payment order awaiting supervisor approval","summary":"Reject an unauthorised payment order","tags":[],"parameters":[{"name":"paymentOrderId","in":"path","type":"string","required":true,"description":"The unique reference number of payment"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"internalStatus":"string","cancellationReason":"string","remarks":"string","initiator":"string","extensions":{}}},"responses":{"200":"ExternalPaymentOrderResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/order/paymentOrders/paymentOrderApprovals/{paymentOrderId}","fullPath":"/api/v3.3.0/order/paymentOrders/paymentOrderApprovals/{paymentOrderId}","operationId":"approvePaymentOrder","name":"Approve or reject a payment that is awaiting supervisor approval.","summary":"Authorise a Payment Order","tags":[],"parameters":[{"name":"paymentOrderId","in":"path","type":"string","required":true,"description":"The unique reference number of payment"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"narratives":[{}],"additionalInformations":[{}],"remittanceInformations":[{}],"beneficiaryAddresses":[{}],"signatories":[{}],"invoiceReferences":[{}],"charges":[{}],"overrides":[{}],"reasons":[{}],"accountWithInstitutionAddresses":[{}],"orderingPostAddrLine":[{}],"contextNames":[{}],"contextValues":[{}],"messageType":[{}],"paymentOrderProductId":"string"}},"responses":{"200":"PaymentOrderResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/order/paymentOrders/{paymentOrderId}","fullPath":"/api/v3.3.0/order/paymentOrders/{paymentOrderId}","operationId":"getPaymentOrder","name":"Retrieve a specific order for a given payment order id","summary":"Retrieve payment order for a given ID","tags":[],"parameters":[{"name":"paymentOrderId","in":"path","type":"string","required":true,"description":"The unique reference number of payment"},{"name":"currentState","in":"query","type":"string","required":false,"description":"Contains the current state of the transaction"},{"name":"paymentStatus","in":"query","type":"string","required":false,"description":"Describes the current status of the payment order in the payment system"},{"name":"paymentOrderProductId","in":"query","type":"string","required":false,"description":"Indicates the payment order product for which payment is initiated"},{"name":"debitAccountId","in":"query","type":"string","required":false,"description":"Indicates the debit account number of the payment or transaction."},{"name":"orderingCustomerId","in":"query","type":"string","required":false,"description":"Indicates the customer id for the ordering customer"},{"name":"uniqueTransactionReference","in":"query","type":"string","required":false,"description":"Unique transaction reference details"},{"name":"executionDate","in":"query","type":"string","required":false,"description":"Date on which the transaction or payment gets processed, i.e. the processing date of the transaction."},{"name":"bulkReference","in":"query","type":"string","required":false,"description":"Contains bulk master reference for the payment."},{"name":"paymentSource","in":"query","type":"string","required":false,"description":"Indicates the source from where the payment is originated"},{"name":"creditAccountId","in":"query","type":"string","required":false,"description":"Credit account identifier of the payment or transaction"},{"name":"beneficiaryAccountId","in":"query","type":"string","required":false,"description":"Unique account identifier of the beneficiary account number."},{"name":"accountWithBankBIC","in":"query","type":"string","required":false,"description":"This is the BIC code of the institution where beneficiary holds an account"},{"name":"accountWithBankClearingCode","in":"query","type":"string","required":false,"description":"This is the national clearing code or sort code of the institution where beneficiary holds an account"},{"name":"historyDetails","in":"query","type":"string","required":false,"description":"Indicates the history details such as history company id , history date, history number"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"PaymentOrderResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"PUT","path":"/order/paymentOrders/{paymentOrderId}","fullPath":"/api/v3.3.0/order/paymentOrders/{paymentOrderId}","operationId":"updatePaymentOrder","name":"Amend attributes of a payment order that is yet to be approved by supervisor","summary":"Amend an unathorised payment order","tags":[],"parameters":[{"name":"paymentOrderId","in":"path","type":"string","required":true,"description":"The unique reference number of payment"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"narratives":[{}],"additionalInformations":[{}],"remittanceInformations":[{}],"beneficiaryAddresses":[{}],"signatories":[{}],"invoiceReferences":[{}],"charges":[{}],"overrides":[{}],"reasons":[{}],"accountWithInstitutionAddresses":[{}],"orderingPostAddrLine":[{}],"contextNames":[{}],"contextValues":[{}],"messageType":[{}],"paymentOrderProductId":"string"}},"responses":{"200":"PaymentOrderResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"DELETE","path":"/order/paymentOrders/{paymentOrderId}","fullPath":"/api/v3.3.0/order/paymentOrders/{paymentOrderId}","operationId":"deletePaymentOrder","name":"Cancel an approved payment order that is in an awaiting status viz. Warehouse, Awaiting Funds","summary":"Cancel payment order","tags":[],"parameters":[{"name":"paymentOrderId","in":"path","type":"string","required":true,"description":"The unique reference number of payment"},{"name":"payload","in":"body","type":"object","required":false,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}}},"responses":{"200":"PaymentOrderResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/order/paymentOrders/trackedPayments","fullPath":"/api/v3.3.0/order/paymentOrders/trackedPayments","operationId":"getTrackedPaymentOrders","name":"Retrieve the status of payment order for a given order id","summary":"Retrieve the status of an order","tags":[],"parameters":[{"name":"paymentOrderId","in":"query","type":"string","required":false,"description":"The unique reference number of payment"},{"name":"paymentSystemId","in":"query","type":"string","required":false,"description":"Payment system id details"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"TrackedPaymentOrdersResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/order/paymentOrders/gpi/trackedPayments","fullPath":"/api/v3.3.0/order/paymentOrders/gpi/trackedPayments","operationId":"getGpiPaymentTracking","name":"Retrieve SWIFT GPI tracker status of a payment. Pre-requisite API must be called before calling this API.","summary":"Retrieve GPI tracking information","tags":[],"parameters":[{"name":"paymentId","in":"query","type":"string","required":false,"description":"Indicates the unique reference number of the payment"},{"name":"paymentMethod","in":"query","type":"string","required":false,"description":"Method chosen to make the payment"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"GpiPaymentTrackingResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/order/paymentOrders/recalls/eligibleOrders","fullPath":"/api/v3.3.0/order/paymentOrders/recalls/eligibleOrders","operationId":"getPaymentOrdersForRecall","name":"Retrieve completed payments that are eligible for recall","summary":"Retrieve the payments eligible for recall","tags":[],"parameters":[{"name":"orderingCustomerId","in":"query","type":"string","required":false,"description":"Indicates the customer id for the ordering customer"},{"name":"paymentOrderId","in":"query","type":"string","required":false,"description":"The unique reference number of payment"},{"name":"paymentOrderProductId","in":"query","type":"string","required":false,"description":"Indicates the payment order product for which payment is initiated"},{"name":"startDate","in":"query","type":"string","required":false,"description":"Contains the date on which the transaction or payment gets initiated."},{"name":"endDate","in":"query","type":"string","required":false,"description":"Indicates the date till which the transaction history requested. If 20120101 is the start date and 20120201 is the end date, all transactions that are booked between January 1 to February 1 2012 are r"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"PaymentOrdersForRecallResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/order/paymentOrders/recalls/status","fullPath":"/api/v3.3.0/order/paymentOrders/recalls/status","operationId":"getPaymentOrderRecallStatus","name":"Retrieve the status of an outward recall requests sent for completed payments","summary":"Retrieve the status of recall request","tags":[],"parameters":[{"name":"paymentOrderId","in":"query","type":"string","required":false,"description":"The unique reference number of payment"},{"name":"paymentOrderProductId","in":"query","type":"string","required":false,"description":"Indicates the payment order product for which payment is initiated"},{"name":"orderingCustomerId","in":"query","type":"string","required":false,"description":"Indicates the customer id for the ordering customer"},{"name":"startDate","in":"query","type":"string","required":false,"description":"Contains the date on which the transaction or payment gets initiated."},{"name":"endDate","in":"query","type":"string","required":false,"description":"Indicates the date till which the transaction history requested. If 20120101 is the start date and 20120201 is the end date, all transactions that are booked between January 1 to February 1 2012 are r"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"PaymentOrderRecallStatusResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"POST","path":"/order/paymentOrders/gpi/payments/{paymentId}/status","fullPath":"/api/v3.3.0/order/paymentOrders/gpi/payments/{paymentId}/status","operationId":"createGPIPaymentStatus","name":"Pre-requisite API to be called by the calling application (before get GPI status API) so as to ensure Temenos GPI tracker process creates and updates the latest status from SWIFT GPI Tracker","summary":"Create a reference and update GPI tracker status","tags":[],"parameters":[{"name":"paymentId","in":"path","type":"string","required":true,"description":"Indicates the unique reference number of the payment"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"UETRId":"string","paymentReference":"string","requestMessage":"string","responseMessage":"string","extensions":{}}},"responses":{"200":"GPIPaymentStatusResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/order/paymentOrders/gpi/payments/{paymentId}/status","fullPath":"/api/v3.3.0/order/paymentOrders/gpi/payments/{paymentId}/status","operationId":"updateGPIPaymentStatus","name":"Pre-requisite API to be called by the calling application (before get GPI status API) so as to ensure Temenos GPI tracker process retrieves and updates the latest status from SWIFT GPI tracker","summary":"Updates GPI tracker status","tags":[],"parameters":[{"name":"paymentId","in":"path","type":"string","required":true,"description":"Indicates the unique reference number of the payment"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"UETRId":"string","paymentReference":"string","requestMessage":"string","responseMessage":"string","extensions":{}}},"responses":{"200":"GPIPaymentStatusResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/order/paymentOrders/externalCodes","fullPath":"/api/v3.3.0/order/paymentOrders/externalCodes","operationId":"getIsoExternalCodes","name":"Retrieves the list of ISO external codes applicable for different fields in ISO messages","summary":"Retrieve ISO external code lists","tags":[],"parameters":[{"name":"id","in":"query","type":"string","required":false,"description":"Contains the daily position class id."},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"IsoExternalCodesResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"POST","path":"/order/paymentOrders/pendingApprovals","fullPath":"/api/v3.3.0/order/paymentOrders/pendingApprovals","operationId":"createSingleAuthPaymentOrder","name":"Create a new payment order, this API can be called to validate or commit the orders","summary":"Initiate a new payment order","tags":[],"parameters":[{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"narratives":[{}],"additionalInformations":[{}],"remittanceInformations":[{}],"beneficiaryAddresses":[{}],"signatories":[{}],"invoiceReferences":[{}],"charges":[{}],"overrides":[{}],"reasons":[{}],"accountWithInstitutionAddresses":[{}],"orderingPostAddrLine":[{}],"contextNames":[{}],"contextValues":[{}],"messageType":[{}],"paymentOrderProductId":"string"}},"responses":{"200":"SingleAuthPaymentOrderResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/order/paymentOrders/{paymentOrderId}/pendingApprovals","fullPath":"/api/v3.3.0/order/paymentOrders/{paymentOrderId}/pendingApprovals","operationId":"updateSingleAuthPaymentOrder","name":"Amend attributes of a payment order that is yet to be approved by supervisor","summary":"Amend an unathorised payment order","tags":[],"parameters":[{"name":"paymentOrderId","in":"path","type":"string","required":true,"description":"The unique reference number of payment"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"narratives":[{}],"additionalInformations":[{}],"remittanceInformations":[{}],"beneficiaryAddresses":[{}],"signatories":[{}],"invoiceReferences":[{}],"charges":[{}],"overrides":[{}],"reasons":[{}],"accountWithInstitutionAddresses":[{}],"orderingPostAddrLine":[{}],"contextNames":[{}],"contextValues":[{}],"messageType":[{}],"paymentOrderProductId":"string"}},"responses":{"200":"SingleAuthPaymentOrderResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"DELETE","path":"/order/paymentOrders/{paymentOrderId}/pendingApprovals","fullPath":"/api/v3.3.0/order/paymentOrders/{paymentOrderId}/pendingApprovals","operationId":"deleteSingleAuthPaymentOrder","name":"Cancel an approved payment order that is in an awaiting status viz. Warehouse, Awaiting Funds","summary":"Cancel payment order","tags":[],"parameters":[{"name":"paymentOrderId","in":"path","type":"string","required":true,"description":"The unique reference number of payment"},{"name":"payload","in":"body","type":"object","required":false,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}}},"responses":{"200":"SingleAuthPaymentOrderResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/order/paymentOrders/{paymentOrderId}/approvals","fullPath":"/api/v3.3.0/order/paymentOrders/{paymentOrderId}/approvals","operationId":"approveUnauthPaymentOrder","name":"Approve or reject a payment that is awaiting supervisor approval.","summary":"Authorise a Payment Order","tags":[],"parameters":[{"name":"paymentOrderId","in":"path","type":"string","required":true,"description":"The unique reference number of payment"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"UnauthPaymentOrderResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}}]},{"key":"order-paymentOrders-service-v3.4.0","title":"Payment Orders","version":"v3.4.0","description":"Payment order application (POA) is a Temenos payments application that helps bank manage their payment orders before they are being sent for payment execution by the bank's payment system. It provides order management functionality for payers to initiate, view and manage their orders from an online ","endpointCount":20,"endpoints":[{"method":"POST","path":"/order/paymentOrders/instantPayments","fullPath":"/api/v3.4.0/order/paymentOrders/instantPayments","operationId":"createInstantPaymentOrder","name":"Initate a new instant payment order.  This API can be called in validate or commit mode. Former validates and responds back with status (and errors if any). Latter validates and commits if there are no validation errors.","summary":"Initiate a new instant payment order","tags":[],"parameters":[{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"benPostSwiftAddr":[{}],"benPostAddressLine":[{}],"remittanceInfo":[{}],"contextName":[{}],"contextValue":[{}],"chargeDetails":[{}],"chargeInfo":[{}],"chargeAmt":[{}],"chargeCurr":[{}],"chargeAccountAmt":[{}],"chargeAcc":[{}],"chargeAccCurr":[{}],"debitAccountId":"string","debitAccountIBAN":"string","debitCurrency":"string"}},"responses":{"200":"InstantPaymentOrderResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/order/paymentOrders/{paymentOrderId}/cancellations","fullPath":"/api/v3.4.0/order/paymentOrders/{paymentOrderId}/cancellations","operationId":"cancelExternalPaymentOrder","name":"Delete a payment order awaiting supervisor approval","summary":"Reject an unauthorised payment order","tags":[],"parameters":[{"name":"paymentOrderId","in":"path","type":"string","required":true,"description":"The unique reference number of payment"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"internalStatus":"string","cancellationReason":"string","remarks":"string","initiator":"string","extensions":{}}},"responses":{"200":"ExternalPaymentOrderResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/order/paymentOrders/trackedPayments","fullPath":"/api/v3.4.0/order/paymentOrders/trackedPayments","operationId":"getTrackedPaymentOrders","name":"Retrieve the status of payment order for a given order id","summary":"Retrieve the status of an order","tags":[],"parameters":[{"name":"paymentOrderId","in":"query","type":"string","required":false,"description":"The unique reference number of payment"},{"name":"paymentSystemId","in":"query","type":"string","required":false,"description":"Payment system id details"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"TrackedPaymentOrdersResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/order/paymentOrders/gpi/trackedPayments","fullPath":"/api/v3.4.0/order/paymentOrders/gpi/trackedPayments","operationId":"getGpiPaymentTracking","name":"Retrieve SWIFT GPI tracker status of a payment. Pre-requisite API must be called before calling this API.","summary":"Retrieve GPI tracking information","tags":[],"parameters":[{"name":"paymentId","in":"query","type":"string","required":false,"description":"Indicates the unique reference number of the payment"},{"name":"paymentMethod","in":"query","type":"string","required":false,"description":"Method chosen to make the payment"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"GpiPaymentTrackingResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/order/paymentOrders/recalls/eligibleOrders","fullPath":"/api/v3.4.0/order/paymentOrders/recalls/eligibleOrders","operationId":"getPaymentOrdersForRecall","name":"Retrieve completed payments that are eligible for recall","summary":"Retrieve the payments eligible for recall","tags":[],"parameters":[{"name":"orderingCustomerId","in":"query","type":"string","required":false,"description":"Indicates the customer id for the ordering customer"},{"name":"paymentOrderId","in":"query","type":"string","required":false,"description":"The unique reference number of payment"},{"name":"paymentOrderProductId","in":"query","type":"string","required":false,"description":"Indicates the payment order product for which payment is initiated"},{"name":"startDate","in":"query","type":"string","required":false,"description":"Contains the date on which the transaction or payment gets initiated."},{"name":"endDate","in":"query","type":"string","required":false,"description":"Indicates the date till which the transaction history requested. If 20120101 is the start date and 20120201 is the end date, all transactions that are booked between January 1 to February 1 2012 are r"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"PaymentOrdersForRecallResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/order/paymentOrders/recalls/status","fullPath":"/api/v3.4.0/order/paymentOrders/recalls/status","operationId":"getPaymentOrderRecallStatus","name":"Retrieve the status of an outward recall requests sent for completed payments","summary":"Retrieve the status of recall request","tags":[],"parameters":[{"name":"paymentOrderId","in":"query","type":"string","required":false,"description":"The unique reference number of payment"},{"name":"paymentOrderProductId","in":"query","type":"string","required":false,"description":"Indicates the payment order product for which payment is initiated"},{"name":"orderingCustomerId","in":"query","type":"string","required":false,"description":"Indicates the customer id for the ordering customer"},{"name":"startDate","in":"query","type":"string","required":false,"description":"Contains the date on which the transaction or payment gets initiated."},{"name":"endDate","in":"query","type":"string","required":false,"description":"Indicates the date till which the transaction history requested. If 20120101 is the start date and 20120201 is the end date, all transactions that are booked between January 1 to February 1 2012 are r"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"PaymentOrderRecallStatusResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"POST","path":"/order/paymentOrders/gpi/payments/{paymentId}/status","fullPath":"/api/v3.4.0/order/paymentOrders/gpi/payments/{paymentId}/status","operationId":"createGPIPaymentStatus","name":"Pre-requisite API to be called by the calling application (before get GPI status API) so as to ensure Temenos GPI tracker process creates and updates the latest status from SWIFT GPI Tracker","summary":"Create a reference and update GPI tracker status","tags":[],"parameters":[{"name":"paymentId","in":"path","type":"string","required":true,"description":"Indicates the unique reference number of the payment"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"UETRId":"string","paymentReference":"string","requestMessage":"string","responseMessage":"string","extensions":{}}},"responses":{"200":"GPIPaymentStatusResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/order/paymentOrders/gpi/payments/{paymentId}/status","fullPath":"/api/v3.4.0/order/paymentOrders/gpi/payments/{paymentId}/status","operationId":"updateGPIPaymentStatus","name":"Pre-requisite API to be called by the calling application (before get GPI status API) so as to ensure Temenos GPI tracker process retrieves and updates the latest status from SWIFT GPI tracker","summary":"Updates GPI tracker status","tags":[],"parameters":[{"name":"paymentId","in":"path","type":"string","required":true,"description":"Indicates the unique reference number of the payment"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"UETRId":"string","paymentReference":"string","requestMessage":"string","responseMessage":"string","extensions":{}}},"responses":{"200":"GPIPaymentStatusResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/order/paymentOrders/externalCodes","fullPath":"/api/v3.4.0/order/paymentOrders/externalCodes","operationId":"getIsoExternalCodes","name":"Retrieves the list of ISO external codes applicable for different fields in ISO messages","summary":"Retrieve ISO external code lists","tags":[],"parameters":[{"name":"id","in":"query","type":"string","required":false,"description":"Contains the daily position class id."},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"IsoExternalCodesResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/order/paymentOrders","fullPath":"/api/v3.4.0/order/paymentOrders","operationId":"getPaymentOrders","name":"Retrieve list of authorised payment orders based on a specific criteria","summary":"Retrieve list of payment orders","tags":[],"parameters":[{"name":"paymentOrderId","in":"query","type":"string","required":false,"description":"The unique reference number of payment"},{"name":"currentState","in":"query","type":"string","required":false,"description":"Contains the current state of the transaction"},{"name":"paymentStatus","in":"query","type":"string","required":false,"description":"Describes the current status of the payment order in the payment system"},{"name":"paymentOrderProductId","in":"query","type":"string","required":false,"description":"Indicates the payment order product for which payment is initiated"},{"name":"debitAccountId","in":"query","type":"string","required":false,"description":"Indicates the debit account number of the payment or transaction."},{"name":"orderingCustomerId","in":"query","type":"string","required":false,"description":"Indicates the customer id for the ordering customer"},{"name":"uniqueTransactionReference","in":"query","type":"string","required":false,"description":"Unique transaction reference details"},{"name":"executionDate","in":"query","type":"string","required":false,"description":"Date on which the transaction or payment gets processed, i.e. the processing date of the transaction."},{"name":"bulkReference","in":"query","type":"string","required":false,"description":"Contains bulk master reference for the payment."},{"name":"paymentSource","in":"query","type":"string","required":false,"description":"Indicates the source from where the payment is originated"},{"name":"creditAccountId","in":"query","type":"string","required":false,"description":"Credit account identifier of the payment or transaction"},{"name":"beneficiaryAccountId","in":"query","type":"string","required":false,"description":"Unique account identifier of the beneficiary account number."},{"name":"accountWithBankBIC","in":"query","type":"string","required":false,"description":"This is the BIC code of the institution where beneficiary holds an account"},{"name":"accountWithBankClearingCode","in":"query","type":"string","required":false,"description":"This is the national clearing code or sort code of the institution where beneficiary holds an account"},{"name":"historyDetails","in":"query","type":"string","required":false,"description":"Indicates the history details such as history company id , history date, history number"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"PaymentOrdersResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"POST","path":"/order/paymentOrders","fullPath":"/api/v3.4.0/order/paymentOrders","operationId":"createPaymentOrder","name":"Create a new payment order. This API can be called in validate or commit mode. Former validates and responds back with status (and errors if any). Latter validates and commits if there are no validation errors.  While creating instant payment orders, set the local instrument code to 'INST'.","summary":"Initiate a new payment order","tags":[],"parameters":[{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"narratives":[{}],"additionalInformations":[{}],"remittanceInformations":[{}],"beneficiaryAddresses":[{}],"signatories":[{}],"invoiceReferences":[{}],"charges":[{}],"overrides":[{}],"reasons":[{}],"accountWithInstitutionAddresses":[{}],"orderingPostAddrLine":[{}],"contextName":[{}],"contextValue":[{}],"messageType":[{}],"paymentOrderProductId":"string"}},"responses":{"200":"PaymentOrderResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/order/paymentOrders/paymentOrderApprovals/{paymentOrderId}","fullPath":"/api/v3.4.0/order/paymentOrders/paymentOrderApprovals/{paymentOrderId}","operationId":"approvePaymentOrder","name":"Approve or reject a payment that is awaiting supervisor approval.","summary":"Authorise a Payment Order","tags":[],"parameters":[{"name":"paymentOrderId","in":"path","type":"string","required":true,"description":"The unique reference number of payment"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"narratives":[{}],"additionalInformations":[{}],"remittanceInformations":[{}],"beneficiaryAddresses":[{}],"signatories":[{}],"invoiceReferences":[{}],"charges":[{}],"overrides":[{}],"reasons":[{}],"accountWithInstitutionAddresses":[{}],"orderingPostAddrLine":[{}],"contextName":[{}],"contextValue":[{}],"messageType":[{}],"paymentOrderProductId":"string"}},"responses":{"200":"PaymentOrderResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/order/paymentOrders/{paymentOrderId}","fullPath":"/api/v3.4.0/order/paymentOrders/{paymentOrderId}","operationId":"getPaymentOrder","name":"Retrieve a specific order for a given payment order id","summary":"Retrieve payment order for a given ID","tags":[],"parameters":[{"name":"paymentOrderId","in":"path","type":"string","required":true,"description":"The unique reference number of payment"},{"name":"currentState","in":"query","type":"string","required":false,"description":"Contains the current state of the transaction"},{"name":"paymentStatus","in":"query","type":"string","required":false,"description":"Describes the current status of the payment order in the payment system"},{"name":"paymentOrderProductId","in":"query","type":"string","required":false,"description":"Indicates the payment order product for which payment is initiated"},{"name":"debitAccountId","in":"query","type":"string","required":false,"description":"Indicates the debit account number of the payment or transaction."},{"name":"orderingCustomerId","in":"query","type":"string","required":false,"description":"Indicates the customer id for the ordering customer"},{"name":"uniqueTransactionReference","in":"query","type":"string","required":false,"description":"Unique transaction reference details"},{"name":"executionDate","in":"query","type":"string","required":false,"description":"Date on which the transaction or payment gets processed, i.e. the processing date of the transaction."},{"name":"bulkReference","in":"query","type":"string","required":false,"description":"Contains bulk master reference for the payment."},{"name":"paymentSource","in":"query","type":"string","required":false,"description":"Indicates the source from where the payment is originated"},{"name":"creditAccountId","in":"query","type":"string","required":false,"description":"Credit account identifier of the payment or transaction"},{"name":"beneficiaryAccountId","in":"query","type":"string","required":false,"description":"Unique account identifier of the beneficiary account number."},{"name":"accountWithBankBIC","in":"query","type":"string","required":false,"description":"This is the BIC code of the institution where beneficiary holds an account"},{"name":"accountWithBankClearingCode","in":"query","type":"string","required":false,"description":"This is the national clearing code or sort code of the institution where beneficiary holds an account"},{"name":"historyDetails","in":"query","type":"string","required":false,"description":"Indicates the history details such as history company id , history date, history number"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"PaymentOrderResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"PUT","path":"/order/paymentOrders/{paymentOrderId}","fullPath":"/api/v3.4.0/order/paymentOrders/{paymentOrderId}","operationId":"updatePaymentOrder","name":"Amend attributes of a payment order that is yet to be approved by supervisor","summary":"Amend an unathorised payment order","tags":[],"parameters":[{"name":"paymentOrderId","in":"path","type":"string","required":true,"description":"The unique reference number of payment"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"narratives":[{}],"additionalInformations":[{}],"remittanceInformations":[{}],"beneficiaryAddresses":[{}],"signatories":[{}],"invoiceReferences":[{}],"charges":[{}],"overrides":[{}],"reasons":[{}],"accountWithInstitutionAddresses":[{}],"orderingPostAddrLine":[{}],"contextName":[{}],"contextValue":[{}],"messageType":[{}],"paymentOrderProductId":"string"}},"responses":{"200":"PaymentOrderResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"DELETE","path":"/order/paymentOrders/{paymentOrderId}","fullPath":"/api/v3.4.0/order/paymentOrders/{paymentOrderId}","operationId":"deletePaymentOrder","name":"Cancel an approved payment order that is in an awaiting status viz. Warehouse, Awaiting Funds","summary":"Cancel payment order","tags":[],"parameters":[{"name":"paymentOrderId","in":"path","type":"string","required":true,"description":"The unique reference number of payment"},{"name":"payload","in":"body","type":"object","required":false,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}}},"responses":{"200":"PaymentOrderResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"POST","path":"/order/paymentOrders/pendingApprovals","fullPath":"/api/v3.4.0/order/paymentOrders/pendingApprovals","operationId":"createSingleAuthPaymentOrder","name":"Create a new payment order, this API can be called to validate or commit the orders","summary":"Initiate a new payment order","tags":[],"parameters":[{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"narratives":[{}],"additionalInformations":[{}],"remittanceInformations":[{}],"beneficiaryAddresses":[{}],"signatories":[{}],"invoiceReferences":[{}],"charges":[{}],"overrides":[{}],"reasons":[{}],"accountWithInstitutionAddresses":[{}],"orderingPostAddrLine":[{}],"contextName":[{}],"contextValue":[{}],"messageType":[{}],"paymentOrderProductId":"string"}},"responses":{"200":"SingleAuthPaymentOrderResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/order/paymentOrders/{paymentOrderId}/pendingApprovals","fullPath":"/api/v3.4.0/order/paymentOrders/{paymentOrderId}/pendingApprovals","operationId":"updateSingleAuthPaymentOrder","name":"Amend attributes of a payment order that is yet to be approved by supervisor","summary":"Amend an unathorised payment order","tags":[],"parameters":[{"name":"paymentOrderId","in":"path","type":"string","required":true,"description":"The unique reference number of payment"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"narratives":[{}],"additionalInformations":[{}],"remittanceInformations":[{}],"beneficiaryAddresses":[{}],"signatories":[{}],"invoiceReferences":[{}],"charges":[{}],"overrides":[{}],"reasons":[{}],"accountWithInstitutionAddresses":[{}],"orderingPostAddrLine":[{}],"contextName":[{}],"contextValue":[{}],"messageType":[{}],"paymentOrderProductId":"string"}},"responses":{"200":"SingleAuthPaymentOrderResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"DELETE","path":"/order/paymentOrders/{paymentOrderId}/pendingApprovals","fullPath":"/api/v3.4.0/order/paymentOrders/{paymentOrderId}/pendingApprovals","operationId":"deleteSingleAuthPaymentOrder","name":"Cancel an approved payment order that is in an awaiting status viz. Warehouse, Awaiting Funds","summary":"Cancel payment order","tags":[],"parameters":[{"name":"paymentOrderId","in":"path","type":"string","required":true,"description":"The unique reference number of payment"},{"name":"payload","in":"body","type":"object","required":false,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}}},"responses":{"200":"SingleAuthPaymentOrderResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/order/paymentOrders/{paymentOrderId}/approvals","fullPath":"/api/v3.4.0/order/paymentOrders/{paymentOrderId}/approvals","operationId":"approveUnauthPaymentOrder","name":"Approve or reject a payment that is awaiting supervisor approval.","summary":"Authorise a payment order","tags":[],"parameters":[{"name":"paymentOrderId","in":"path","type":"string","required":true,"description":"The unique reference number of payment"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"UnauthPaymentOrderResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"POST","path":"/order/paymentOrders/{paymentOrderId}/paymentRequests","fullPath":"/api/v3.4.0/order/paymentOrders/{paymentOrderId}/paymentRequests","operationId":"updatePaymentOrderResponse","name":"Update response in payment order received for a request sent to the payment system","summary":"Update response in payment order received for a request sent ","tags":[],"parameters":[{"name":"paymentOrderId","in":"path","type":"string","required":true,"description":"The unique reference number of payment"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"id":"string","status":"string","transactionStatus":"string","uniqueIdentifier":"string","audit":{"T24_time":{},"versionNumber":{},"requestParse_time":{},"responseParse_time":{}}},"body":{"paymentOrderId":"string","status":"string","paymentSystemId":"string","additionalInformation":"string","createdBy":"string","response":"string","isProcessingCompleted":"string","rejectReasonCode":"string","contextName":"string","contextValue":"string","creationDate":"string","sourceSystem":"string","responseType":"string","extensions":{}}},"responses":{"200":"PaymentOrderResponseResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}}]},{"key":"order-paymentOrders-service-v4.0.0","title":"Payment Orders","version":"v4.0.0","description":"Payment order application (POA) is a Temenos payments application that helps bank manage their payment orders before they are being sent for payment execution by the bank's payment system. It provides order management functionality for payers to initiate, view and manage their orders from an online ","endpointCount":20,"endpoints":[{"method":"POST","path":"/order/paymentOrders/instantPayments","fullPath":"/api/v4.0.0/order/paymentOrders/instantPayments","operationId":"createInstantPaymentOrder","name":"Initate a new instant payment order.  This API can be called in validate or commit mode. Former validates and responds back with status (and errors if any). Latter validates and commits if there are no validation errors.","summary":"Initiate a new instant payment order","tags":[],"parameters":[{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"benPostSwiftAddr":[{}],"benPostAddressLine":[{}],"remittanceInfo":[{}],"contextName":[{}],"contextValue":[{}],"chargeDetails":[{}],"chargeInfo":[{}],"chargeAmt":[{}],"chargeCurr":[{}],"chargeAccountAmt":[{}],"chargeAcc":[{}],"chargeAccCurr":[{}],"debitAccountId":"string","debitAccountIBAN":"string","debitCurrency":"string"}},"responses":{"200":"InstantPaymentOrderResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/order/paymentOrders/{paymentOrderId}/cancellations","fullPath":"/api/v4.0.0/order/paymentOrders/{paymentOrderId}/cancellations","operationId":"cancelExternalPaymentOrder","name":"Delete a payment order awaiting supervisor approval","summary":"Reject an unauthorised payment order","tags":[],"parameters":[{"name":"paymentOrderId","in":"path","type":"string","required":true,"description":"The unique reference number of payment"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"internalStatus":"string","cancellationReason":"string","remarks":"string","initiator":"string","extensions":{}}},"responses":{"200":"ExternalPaymentOrderResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/order/paymentOrders/trackedPayments","fullPath":"/api/v4.0.0/order/paymentOrders/trackedPayments","operationId":"getTrackedPaymentOrders","name":"Retrieve the status of payment order for a given order id","summary":"Retrieve the status of an order","tags":[],"parameters":[{"name":"paymentOrderId","in":"query","type":"string","required":false,"description":"The unique reference number of payment"},{"name":"paymentSystemId","in":"query","type":"string","required":false,"description":"Payment system id details"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"TrackedPaymentOrdersResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/order/paymentOrders/gpi/trackedPayments","fullPath":"/api/v4.0.0/order/paymentOrders/gpi/trackedPayments","operationId":"getGpiPaymentTracking","name":"Retrieve SWIFT GPI tracker status of a payment. Pre-requisite API must be called before calling this API.","summary":"Retrieve GPI tracking information","tags":[],"parameters":[{"name":"paymentId","in":"query","type":"string","required":false,"description":"Indicates the unique reference number of the payment"},{"name":"paymentMethod","in":"query","type":"string","required":false,"description":"Method chosen to make the payment"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"GpiPaymentTrackingResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/order/paymentOrders/recalls/eligibleOrders","fullPath":"/api/v4.0.0/order/paymentOrders/recalls/eligibleOrders","operationId":"getPaymentOrdersForRecall","name":"Retrieve completed payments that are eligible for recall","summary":"Retrieve the payments eligible for recall","tags":[],"parameters":[{"name":"orderingCustomerId","in":"query","type":"string","required":false,"description":"Indicates the customer id for the ordering customer"},{"name":"paymentOrderId","in":"query","type":"string","required":false,"description":"The unique reference number of payment"},{"name":"paymentOrderProductId","in":"query","type":"string","required":false,"description":"Indicates the payment order product for which payment is initiated"},{"name":"startDate","in":"query","type":"string","required":false,"description":"Contains the date on which the transaction or payment gets initiated."},{"name":"endDate","in":"query","type":"string","required":false,"description":"Indicates the date till which the transaction history requested. If 20120101 is the start date and 20120201 is the end date, all transactions that are booked between January 1 to February 1 2012 are r"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"PaymentOrdersForRecallResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/order/paymentOrders/recalls/status","fullPath":"/api/v4.0.0/order/paymentOrders/recalls/status","operationId":"getPaymentOrderRecallStatus","name":"Retrieve the status of an outward recall requests sent for completed payments","summary":"Retrieve the status of recall request","tags":[],"parameters":[{"name":"paymentOrderId","in":"query","type":"string","required":false,"description":"The unique reference number of payment"},{"name":"paymentOrderProductId","in":"query","type":"string","required":false,"description":"Indicates the payment order product for which payment is initiated"},{"name":"orderingCustomerId","in":"query","type":"string","required":false,"description":"Indicates the customer id for the ordering customer"},{"name":"startDate","in":"query","type":"string","required":false,"description":"Contains the date on which the transaction or payment gets initiated."},{"name":"endDate","in":"query","type":"string","required":false,"description":"Indicates the date till which the transaction history requested. If 20120101 is the start date and 20120201 is the end date, all transactions that are booked between January 1 to February 1 2012 are r"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"PaymentOrderRecallStatusResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"POST","path":"/order/paymentOrders/gpi/payments/{paymentId}/status","fullPath":"/api/v4.0.0/order/paymentOrders/gpi/payments/{paymentId}/status","operationId":"createGPIPaymentStatus","name":"Pre-requisite API to be called by the calling application (before get GPI status API) so as to ensure Temenos GPI tracker process creates and updates the latest status from SWIFT GPI Tracker","summary":"Create a reference and update GPI tracker status","tags":[],"parameters":[{"name":"paymentId","in":"path","type":"string","required":true,"description":"Indicates the unique reference number of the payment"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"UETRId":"string","paymentReference":"string","requestMessage":"string","responseMessage":"string","extensions":{}}},"responses":{"200":"GPIPaymentStatusResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/order/paymentOrders/gpi/payments/{paymentId}/status","fullPath":"/api/v4.0.0/order/paymentOrders/gpi/payments/{paymentId}/status","operationId":"updateGPIPaymentStatus","name":"Pre-requisite API to be called by the calling application (before get GPI status API) so as to ensure Temenos GPI tracker process retrieves and updates the latest status from SWIFT GPI tracker","summary":"Updates GPI tracker status","tags":[],"parameters":[{"name":"paymentId","in":"path","type":"string","required":true,"description":"Indicates the unique reference number of the payment"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"UETRId":"string","paymentReference":"string","requestMessage":"string","responseMessage":"string","extensions":{}}},"responses":{"200":"GPIPaymentStatusResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/order/paymentOrders/externalCodes","fullPath":"/api/v4.0.0/order/paymentOrders/externalCodes","operationId":"getIsoExternalCodes","name":"Retrieves the list of ISO external codes applicable for different fields in ISO messages","summary":"Retrieve ISO external code lists","tags":[],"parameters":[{"name":"id","in":"query","type":"string","required":false,"description":"Contains the daily position class id."},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"IsoExternalCodesResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/order/paymentOrders","fullPath":"/api/v4.0.0/order/paymentOrders","operationId":"getPaymentOrders","name":"Retrieve list of authorised payment orders based on a specific criteria","summary":"Retrieve list of payment orders","tags":[],"parameters":[{"name":"paymentOrderId","in":"query","type":"string","required":false,"description":"The unique reference number of payment"},{"name":"currentState","in":"query","type":"string","required":false,"description":"Contains the current state of the transaction"},{"name":"paymentStatus","in":"query","type":"string","required":false,"description":"Describes the current status of the payment order in the payment system"},{"name":"paymentOrderProductId","in":"query","type":"string","required":false,"description":"Indicates the payment order product for which payment is initiated"},{"name":"debitAccountId","in":"query","type":"string","required":false,"description":"Indicates the debit account number of the payment or transaction."},{"name":"orderingCustomerId","in":"query","type":"string","required":false,"description":"Indicates the customer id for the ordering customer"},{"name":"uniqueTransactionReference","in":"query","type":"string","required":false,"description":"Unique transaction reference details"},{"name":"executionDate","in":"query","type":"string","required":false,"description":"Date on which the transaction or payment gets processed, i.e. the processing date of the transaction."},{"name":"bulkReference","in":"query","type":"string","required":false,"description":"Contains bulk master reference for the payment."},{"name":"paymentSource","in":"query","type":"string","required":false,"description":"Indicates the source from where the payment is originated"},{"name":"creditAccountId","in":"query","type":"string","required":false,"description":"Credit account identifier of the payment or transaction"},{"name":"beneficiaryAccountId","in":"query","type":"string","required":false,"description":"Unique account identifier of the beneficiary account number."},{"name":"accountWithBankBIC","in":"query","type":"string","required":false,"description":"This is the BIC code of the institution where beneficiary holds an account"},{"name":"accountWithBankClearingCode","in":"query","type":"string","required":false,"description":"This is the national clearing code or sort code of the institution where beneficiary holds an account"},{"name":"historyDetails","in":"query","type":"string","required":false,"description":"Indicates the history details such as history company id , history date, history number"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"PaymentOrdersResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"POST","path":"/order/paymentOrders","fullPath":"/api/v4.0.0/order/paymentOrders","operationId":"createPaymentOrder","name":"Create a new payment order. This API can be called in validate or commit mode. Former validates and responds back with status (and errors if any). Latter validates and commits if there are no validation errors.  While creating instant payment orders, set the local instrument code to 'INST'.","summary":"Initiate a new payment order","tags":[],"parameters":[{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"narratives":[{}],"additionalInformations":[{}],"remittanceInformations":[{}],"beneficiaryAddresses":[{}],"signatories":[{}],"invoiceReferences":[{}],"charges":[{}],"reasons":[{}],"accountWithInstitutionAddresses":[{}],"orderingPostAddrLine":[{}],"contextName":[{}],"contextValue":[{}],"messageType":[{}],"SwiftAddresses":[{}],"instructionCodes":[{}]}},"responses":{"200":"PaymentOrderResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/order/paymentOrders/paymentOrderApprovals/{paymentOrderId}","fullPath":"/api/v4.0.0/order/paymentOrders/paymentOrderApprovals/{paymentOrderId}","operationId":"approvePaymentOrder","name":"Approve or reject a payment that is awaiting supervisor approval.","summary":"Authorise a payment order","tags":[],"parameters":[{"name":"paymentOrderId","in":"path","type":"string","required":true,"description":"The unique reference number of payment"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"narratives":[{}],"additionalInformations":[{}],"remittanceInformations":[{}],"beneficiaryAddresses":[{}],"signatories":[{}],"invoiceReferences":[{}],"charges":[{}],"reasons":[{}],"accountWithInstitutionAddresses":[{}],"orderingPostAddrLine":[{}],"contextName":[{}],"contextValue":[{}],"messageType":[{}],"SwiftAddresses":[{}],"instructionCodes":[{}]}},"responses":{"200":"PaymentOrderResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/order/paymentOrders/{paymentOrderId}","fullPath":"/api/v4.0.0/order/paymentOrders/{paymentOrderId}","operationId":"getPaymentOrder","name":"Retrieve a specific order for a given payment order id","summary":"Retrieve payment order for a given id","tags":[],"parameters":[{"name":"paymentOrderId","in":"path","type":"string","required":true,"description":"The unique reference number of payment"},{"name":"currentState","in":"query","type":"string","required":false,"description":"Contains the current state of the transaction"},{"name":"paymentStatus","in":"query","type":"string","required":false,"description":"Describes the current status of the payment order in the payment system"},{"name":"paymentOrderProductId","in":"query","type":"string","required":false,"description":"Indicates the payment order product for which payment is initiated"},{"name":"debitAccountId","in":"query","type":"string","required":false,"description":"Indicates the debit account number of the payment or transaction."},{"name":"orderingCustomerId","in":"query","type":"string","required":false,"description":"Indicates the customer id for the ordering customer"},{"name":"uniqueTransactionReference","in":"query","type":"string","required":false,"description":"Unique transaction reference details"},{"name":"executionDate","in":"query","type":"string","required":false,"description":"Date on which the transaction or payment gets processed, i.e. the processing date of the transaction."},{"name":"bulkReference","in":"query","type":"string","required":false,"description":"Contains bulk master reference for the payment."},{"name":"paymentSource","in":"query","type":"string","required":false,"description":"Indicates the source from where the payment is originated"},{"name":"creditAccountId","in":"query","type":"string","required":false,"description":"Credit account identifier of the payment or transaction"},{"name":"beneficiaryAccountId","in":"query","type":"string","required":false,"description":"Unique account identifier of the beneficiary account number."},{"name":"accountWithBankBIC","in":"query","type":"string","required":false,"description":"This is the BIC code of the institution where beneficiary holds an account"},{"name":"accountWithBankClearingCode","in":"query","type":"string","required":false,"description":"This is the national clearing code or sort code of the institution where beneficiary holds an account"},{"name":"historyDetails","in":"query","type":"string","required":false,"description":"Indicates the history details such as history company id , history date, history number"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"PaymentOrderResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"PUT","path":"/order/paymentOrders/{paymentOrderId}","fullPath":"/api/v4.0.0/order/paymentOrders/{paymentOrderId}","operationId":"updatePaymentOrder","name":"Amend attributes of a payment order that is yet to be approved by supervisor","summary":"Amend an unathorised payment order","tags":[],"parameters":[{"name":"paymentOrderId","in":"path","type":"string","required":true,"description":"The unique reference number of payment"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"narratives":[{}],"additionalInformations":[{}],"remittanceInformations":[{}],"beneficiaryAddresses":[{}],"signatories":[{}],"invoiceReferences":[{}],"charges":[{}],"reasons":[{}],"accountWithInstitutionAddresses":[{}],"orderingPostAddrLine":[{}],"contextName":[{}],"contextValue":[{}],"messageType":[{}],"SwiftAddresses":[{}],"instructionCodes":[{}]}},"responses":{"200":"PaymentOrderResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"DELETE","path":"/order/paymentOrders/{paymentOrderId}","fullPath":"/api/v4.0.0/order/paymentOrders/{paymentOrderId}","operationId":"deletePaymentOrder","name":"Cancel an approved payment order that is in an awaiting status viz. Warehouse, Awaiting Funds","summary":"Cancel payment order","tags":[],"parameters":[{"name":"paymentOrderId","in":"path","type":"string","required":true,"description":"The unique reference number of payment"},{"name":"payload","in":"body","type":"object","required":false,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}}},"responses":{"200":"PaymentOrderResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"POST","path":"/order/paymentOrders/pendingApprovals","fullPath":"/api/v4.0.0/order/paymentOrders/pendingApprovals","operationId":"createSingleAuthPaymentOrder","name":"Create a new unauthorized payment order, this API can be called to validate or commit the orders","summary":"Initiate a new unauthorized payment order","tags":[],"parameters":[{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"narratives":[{}],"additionalInformations":[{}],"remittanceInformations":[{}],"beneficiaryAddresses":[{}],"signatories":[{}],"invoiceReferences":[{}],"charges":[{}],"overrides":[{}],"reasons":[{}],"accountWithInstitutionAddresses":[{}],"orderingPostAddrLine":[{}],"contextName":[{}],"contextValue":[{}],"messageType":[{}],"paymentOrderProductId":"string"}},"responses":{"200":"SingleAuthPaymentOrderResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/order/paymentOrders/{paymentOrderId}/pendingApprovals","fullPath":"/api/v4.0.0/order/paymentOrders/{paymentOrderId}/pendingApprovals","operationId":"updateSingleAuthPaymentOrder","name":"Amend attributes of an unauthorized payment order that is yet to be approved by supervisor","summary":"Amend an unathorised single authorized version of payment order","tags":[],"parameters":[{"name":"paymentOrderId","in":"path","type":"string","required":true,"description":"The unique reference number of payment"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"narratives":[{}],"additionalInformations":[{}],"remittanceInformations":[{}],"beneficiaryAddresses":[{}],"signatories":[{}],"invoiceReferences":[{}],"charges":[{}],"overrides":[{}],"reasons":[{}],"accountWithInstitutionAddresses":[{}],"orderingPostAddrLine":[{}],"contextName":[{}],"contextValue":[{}],"messageType":[{}],"paymentOrderProductId":"string"}},"responses":{"200":"SingleAuthPaymentOrderResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"DELETE","path":"/order/paymentOrders/{paymentOrderId}/pendingApprovals","fullPath":"/api/v4.0.0/order/paymentOrders/{paymentOrderId}/pendingApprovals","operationId":"deleteSingleAuthPaymentOrder","name":"Cancel an approved single authorized version of payment order that is in an awaiting status viz. Warehouse, Awaiting Funds","summary":"Cancel unauthorized payment order","tags":[],"parameters":[{"name":"paymentOrderId","in":"path","type":"string","required":true,"description":"The unique reference number of payment"},{"name":"payload","in":"body","type":"object","required":false,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}}},"responses":{"200":"SingleAuthPaymentOrderResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/order/paymentOrders/{paymentOrderId}/approvals","fullPath":"/api/v4.0.0/order/paymentOrders/{paymentOrderId}/approvals","operationId":"approveUnauthPaymentOrder","name":"Approve or reject an unauthorized payment that is awaiting supervisor approval.","summary":"Authorise an unauthorized payment order","tags":[],"parameters":[{"name":"paymentOrderId","in":"path","type":"string","required":true,"description":"The unique reference number of payment"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"UnauthPaymentOrderResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"POST","path":"/order/paymentOrders/{paymentOrderId}/paymentRequests","fullPath":"/api/v4.0.0/order/paymentOrders/{paymentOrderId}/paymentRequests","operationId":"updatePaymentOrderResponse","name":"Update response in payment order received for a request sent to the payment system","summary":"Update response in payment order received for a request sent ","tags":[],"parameters":[{"name":"paymentOrderId","in":"path","type":"string","required":true,"description":"The unique reference number of payment"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"id":"string","status":"string","transactionStatus":"string","uniqueIdentifier":"string","audit":{"T24_time":{},"versionNumber":{},"requestParse_time":{},"responseParse_time":{}}},"body":{"paymentOrderId":"string","status":"string","paymentSystemId":"string","additionalInformation":"string","createdBy":"string","response":"string","isProcessingCompleted":"string","rejectReasonCode":"string","contextName":"string","contextValue":"string","creationDate":"string","sourceSystem":"string","responseType":"string","extensions":{}}},"responses":{"200":"PaymentOrderResponseResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}}]},{"key":"order-paymentOrders-service-v4.1.0","title":"Payment Orders","version":"v4.1.0","description":"Payment order application (POA) is a Temenos payments application that helps bank manage their payment orders before they are being sent for payment execution by the bank's payment system. It provides order management functionality for payers to initiate, view and manage their orders from an online ","endpointCount":20,"endpoints":[{"method":"POST","path":"/order/paymentOrders/instantPayments","fullPath":"/api/v4.1.0/order/paymentOrders/instantPayments","operationId":"createInstantPaymentOrder","name":"Initate a new instant payment order.  This API can be called in validate or commit mode. Former validates and responds back with status (and errors if any). Latter validates and commits if there are no validation errors.","summary":"Initiate a new instant payment order","tags":["OTHERS"],"parameters":[{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"benPostSwiftAddr":[{}],"benPostAddressLine":[{}],"remittanceInfo":[{}],"contextName":[{}],"contextValue":[{}],"chargeDetails":[{}],"chargeInfo":[{}],"chargeAmt":[{}],"chargeCurr":[{}],"chargeAccountAmt":[{}],"chargeAcc":[{}],"chargeAccCurr":[{}],"debitAccountId":"string","debitAccountIBAN":"string","debitCurrency":"string"}},"responses":{"200":"InstantPaymentOrderResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/order/paymentOrders/{paymentOrderId}/cancellations","fullPath":"/api/v4.1.0/order/paymentOrders/{paymentOrderId}/cancellations","operationId":"cancelExternalPaymentOrder","name":"Delete a payment order awaiting supervisor approval","summary":"Reject an unauthorised payment order","tags":["OTHERS"],"parameters":[{"name":"paymentOrderId","in":"path","type":"string","required":true,"description":"The unique reference number of payment"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"internalStatus":"string","cancellationReason":"string","remarks":"string","initiator":"string","extensions":{}}},"responses":{"200":"ExternalPaymentOrderResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/order/paymentOrders/trackedPayments","fullPath":"/api/v4.1.0/order/paymentOrders/trackedPayments","operationId":"getTrackedPaymentOrders","name":"Retrieve the status of payment order for a given order id","summary":"Retrieve the status of an order","tags":["OTHERS"],"parameters":[{"name":"paymentOrderId","in":"query","type":"string","required":false,"description":"The unique reference number of payment"},{"name":"paymentSystemId","in":"query","type":"string","required":false,"description":"Payment system id details"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"TrackedPaymentOrdersResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/order/paymentOrders/gpi/trackedPayments","fullPath":"/api/v4.1.0/order/paymentOrders/gpi/trackedPayments","operationId":"getGpiPaymentTracking","name":"Retrieve SWIFT GPI tracker status of a payment. Pre-requisite API must be called before calling this API.","summary":"Retrieve GPI tracking information","tags":["OTHERS"],"parameters":[{"name":"paymentId","in":"query","type":"string","required":false,"description":"Indicates the unique reference number of the payment"},{"name":"paymentMethod","in":"query","type":"string","required":false,"description":"Method chosen to make the payment"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"GpiPaymentTrackingResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/order/paymentOrders/recalls/eligibleOrders","fullPath":"/api/v4.1.0/order/paymentOrders/recalls/eligibleOrders","operationId":"getPaymentOrdersForRecall","name":"Retrieve completed payments that are eligible for recall","summary":"Retrieve the payments eligible for recall","tags":["OTHERS"],"parameters":[{"name":"orderingCustomerId","in":"query","type":"string","required":false,"description":"Indicates the customer id for the ordering customer"},{"name":"paymentOrderId","in":"query","type":"string","required":false,"description":"The unique reference number of payment"},{"name":"paymentOrderProductId","in":"query","type":"string","required":false,"description":"Indicates the payment order product for which payment is initiated"},{"name":"startDate","in":"query","type":"string","required":false,"description":"Contains the date on which the transaction or payment gets initiated."},{"name":"endDate","in":"query","type":"string","required":false,"description":"Indicates the date till which the transaction history requested. If 20120101 is the start date and 20120201 is the end date, all transactions that are booked between January 1 to February 1 2012 are r"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"PaymentOrdersForRecallResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/order/paymentOrders/recalls/status","fullPath":"/api/v4.1.0/order/paymentOrders/recalls/status","operationId":"getPaymentOrderRecallStatus","name":"Retrieve the status of an outward recall requests sent for completed payments","summary":"Retrieve the status of recall request","tags":["OTHERS"],"parameters":[{"name":"paymentOrderId","in":"query","type":"string","required":false,"description":"The unique reference number of payment"},{"name":"paymentOrderProductId","in":"query","type":"string","required":false,"description":"Indicates the payment order product for which payment is initiated"},{"name":"orderingCustomerId","in":"query","type":"string","required":false,"description":"Indicates the customer id for the ordering customer"},{"name":"startDate","in":"query","type":"string","required":false,"description":"Contains the date on which the transaction or payment gets initiated."},{"name":"endDate","in":"query","type":"string","required":false,"description":"Indicates the date till which the transaction history requested. If 20120101 is the start date and 20120201 is the end date, all transactions that are booked between January 1 to February 1 2012 are r"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"PaymentOrderRecallStatusResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"POST","path":"/order/paymentOrders/gpi/payments/{paymentId}/status","fullPath":"/api/v4.1.0/order/paymentOrders/gpi/payments/{paymentId}/status","operationId":"createGPIPaymentStatus","name":"Pre-requisite API to be called by the calling application (before get GPI status API) so as to ensure Temenos GPI tracker process creates and updates the latest status from SWIFT GPI tracker","summary":"Create a reference and update GPI tracker status","tags":["OTHERS"],"parameters":[{"name":"paymentId","in":"path","type":"string","required":true,"description":"Indicates the unique reference number of the payment"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"UETRId":"string","paymentReference":"string","requestMessage":"string","responseMessage":"string","extensions":{}}},"responses":{"200":"GPIPaymentStatusResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/order/paymentOrders/gpi/payments/{paymentId}/status","fullPath":"/api/v4.1.0/order/paymentOrders/gpi/payments/{paymentId}/status","operationId":"updateGPIPaymentStatus","name":"Pre-requisite API to be called by the calling application (before get GPI status API) so as to ensure Temenos GPI tracker process retrieves and updates the latest status from SWIFT GPI tracker","summary":"Updates GPI tracker status","tags":["OTHERS"],"parameters":[{"name":"paymentId","in":"path","type":"string","required":true,"description":"Indicates the unique reference number of the payment"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"UETRId":"string","paymentReference":"string","requestMessage":"string","responseMessage":"string","extensions":{}}},"responses":{"200":"GPIPaymentStatusResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/order/paymentOrders/externalCodes","fullPath":"/api/v4.1.0/order/paymentOrders/externalCodes","operationId":"getIsoExternalCodes","name":"Retrieves the list of ISO external codes applicable for ISO messages","summary":"Retrieve ISO external code lists","tags":["OTHERS"],"parameters":[{"name":"id","in":"query","type":"string","required":false,"description":"Contains the daily position class id."},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"IsoExternalCodesResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/order/paymentOrders","fullPath":"/api/v4.1.0/order/paymentOrders","operationId":"getPaymentOrders","name":"Retrieve list of authorised payment orders based on a specific criteria","summary":"Retrieve list of payment orders","tags":["OTHERS"],"parameters":[{"name":"paymentOrderId","in":"query","type":"string","required":false,"description":"The unique reference number of payment"},{"name":"currentState","in":"query","type":"string","required":false,"description":"Contains the current state of the transaction"},{"name":"paymentStatus","in":"query","type":"string","required":false,"description":"Describes the current status of the payment order in the payment system"},{"name":"paymentOrderProductId","in":"query","type":"string","required":false,"description":"Indicates the payment order product for which payment is initiated"},{"name":"debitAccountId","in":"query","type":"string","required":false,"description":"Indicates the debit account number of the payment or transaction."},{"name":"orderingCustomerId","in":"query","type":"string","required":false,"description":"Indicates the customer id for the ordering customer"},{"name":"uniqueTransactionReference","in":"query","type":"string","required":false,"description":"Unique transaction reference details"},{"name":"executionDate","in":"query","type":"string","required":false,"description":"Date on which the transaction or payment gets processed, i.e. the processing date of the transaction."},{"name":"bulkReference","in":"query","type":"string","required":false,"description":"Contains bulk master reference for the payment."},{"name":"paymentSource","in":"query","type":"string","required":false,"description":"Indicates the source from where the payment is originated"},{"name":"creditAccountId","in":"query","type":"string","required":false,"description":"Credit account identifier of the payment or transaction"},{"name":"beneficiaryAccountId","in":"query","type":"string","required":false,"description":"Unique account identifier of the beneficiary account number."},{"name":"accountWithBankBIC","in":"query","type":"string","required":false,"description":"This is the BIC code of the institution where beneficiary holds an account"},{"name":"accountWithBankClearingCode","in":"query","type":"string","required":false,"description":"This is the national clearing code or sort code of the institution where beneficiary holds an account"},{"name":"historyDetails","in":"query","type":"string","required":false,"description":"Indicates the history details such as history company id , history date, history number"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"PaymentOrdersResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"POST","path":"/order/paymentOrders","fullPath":"/api/v4.1.0/order/paymentOrders","operationId":"createPaymentOrder","name":"Create a new payment order. This API can be called in validate or commit mode. Former validates and responds back with status (and errors if any). Latter validates and commits if there are no validation errors.  While creating instant payment orders, set the local instrument code to 'INST'.","summary":"Initiate a new payment order","tags":["OTHERS"],"parameters":[{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"narratives":[{}],"additionalInformations":[{}],"remittanceInformations":[{}],"beneficiaryAddresses":[{}],"signatories":[{}],"invoiceReferences":[{}],"charges":[{}],"reasons":[{}],"accountWithInstitutionAddresses":[{}],"orderingPostAddrLine":[{}],"contextName":[{}],"contextValue":[{}],"messageType":[{}],"SwiftAddresses":[{}],"instructionCodes":[{}]}},"responses":{"200":"PaymentOrderResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/order/paymentOrders/paymentOrderApprovals/{paymentOrderId}","fullPath":"/api/v4.1.0/order/paymentOrders/paymentOrderApprovals/{paymentOrderId}","operationId":"approvePaymentOrder","name":"Approve or reject a payment that is awaiting supervisor approval.","summary":"Authorise a payment order","tags":["OTHERS"],"parameters":[{"name":"paymentOrderId","in":"path","type":"string","required":true,"description":"The unique reference number of payment"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"narratives":[{}],"additionalInformations":[{}],"remittanceInformations":[{}],"beneficiaryAddresses":[{}],"signatories":[{}],"invoiceReferences":[{}],"charges":[{}],"reasons":[{}],"accountWithInstitutionAddresses":[{}],"orderingPostAddrLine":[{}],"contextName":[{}],"contextValue":[{}],"messageType":[{}],"SwiftAddresses":[{}],"instructionCodes":[{}]}},"responses":{"200":"PaymentOrderResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/order/paymentOrders/{paymentOrderId}","fullPath":"/api/v4.1.0/order/paymentOrders/{paymentOrderId}","operationId":"getPaymentOrder","name":"Retrieve a specific order for a given payment order id","summary":"Retrieve payment order for a given id","tags":["OTHERS"],"parameters":[{"name":"paymentOrderId","in":"path","type":"string","required":true,"description":"The unique reference number of payment"},{"name":"currentState","in":"query","type":"string","required":false,"description":"Contains the current state of the transaction"},{"name":"paymentStatus","in":"query","type":"string","required":false,"description":"Describes the current status of the payment order in the payment system"},{"name":"paymentOrderProductId","in":"query","type":"string","required":false,"description":"Indicates the payment order product for which payment is initiated"},{"name":"debitAccountId","in":"query","type":"string","required":false,"description":"Indicates the debit account number of the payment or transaction."},{"name":"orderingCustomerId","in":"query","type":"string","required":false,"description":"Indicates the customer id for the ordering customer"},{"name":"uniqueTransactionReference","in":"query","type":"string","required":false,"description":"Unique transaction reference details"},{"name":"executionDate","in":"query","type":"string","required":false,"description":"Date on which the transaction or payment gets processed, i.e. the processing date of the transaction."},{"name":"bulkReference","in":"query","type":"string","required":false,"description":"Contains bulk master reference for the payment."},{"name":"paymentSource","in":"query","type":"string","required":false,"description":"Indicates the source from where the payment is originated"},{"name":"creditAccountId","in":"query","type":"string","required":false,"description":"Credit account identifier of the payment or transaction"},{"name":"beneficiaryAccountId","in":"query","type":"string","required":false,"description":"Unique account identifier of the beneficiary account number."},{"name":"accountWithBankBIC","in":"query","type":"string","required":false,"description":"This is the BIC code of the institution where beneficiary holds an account"},{"name":"accountWithBankClearingCode","in":"query","type":"string","required":false,"description":"This is the national clearing code or sort code of the institution where beneficiary holds an account"},{"name":"historyDetails","in":"query","type":"string","required":false,"description":"Indicates the history details such as history company id , history date, history number"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"PaymentOrderResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"PUT","path":"/order/paymentOrders/{paymentOrderId}","fullPath":"/api/v4.1.0/order/paymentOrders/{paymentOrderId}","operationId":"updatePaymentOrder","name":"Amend attributes of a payment order that is yet to be approved by supervisor","summary":"Amend an unathorised payment order","tags":["OTHERS"],"parameters":[{"name":"paymentOrderId","in":"path","type":"string","required":true,"description":"The unique reference number of payment"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"narratives":[{}],"additionalInformations":[{}],"remittanceInformations":[{}],"beneficiaryAddresses":[{}],"signatories":[{}],"invoiceReferences":[{}],"charges":[{}],"reasons":[{}],"accountWithInstitutionAddresses":[{}],"orderingPostAddrLine":[{}],"contextName":[{}],"contextValue":[{}],"messageType":[{}],"SwiftAddresses":[{}],"instructionCodes":[{}]}},"responses":{"200":"PaymentOrderResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"DELETE","path":"/order/paymentOrders/{paymentOrderId}","fullPath":"/api/v4.1.0/order/paymentOrders/{paymentOrderId}","operationId":"deletePaymentOrder","name":"Cancel an approved payment order that is in an awaiting status viz. Warehouse, Awaiting Funds","summary":"Cancel payment order","tags":["OTHERS"],"parameters":[{"name":"paymentOrderId","in":"path","type":"string","required":true,"description":"The unique reference number of payment"},{"name":"payload","in":"body","type":"object","required":false,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}}},"responses":{"200":"PaymentOrderResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"POST","path":"/order/paymentOrders/pendingApprovals","fullPath":"/api/v4.1.0/order/paymentOrders/pendingApprovals","operationId":"createSingleAuthPaymentOrder","name":"Create a new unauthorized payment order, this API can be called to validate or commit the orders","summary":"Initiate a new unauthorized payment order","tags":["OTHERS"],"parameters":[{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"narratives":[{}],"additionalInformations":[{}],"remittanceInformations":[{}],"beneficiaryAddresses":[{}],"signatories":[{}],"invoiceReferences":[{}],"charges":[{}],"overrides":[{}],"reasons":[{}],"accountWithInstitutionAddresses":[{}],"orderingPostAddrLine":[{}],"contextName":[{}],"contextValue":[{}],"messageType":[{}],"paymentOrderProductId":"string"}},"responses":{"200":"SingleAuthPaymentOrderResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/order/paymentOrders/{paymentOrderId}/pendingApprovals","fullPath":"/api/v4.1.0/order/paymentOrders/{paymentOrderId}/pendingApprovals","operationId":"updateSingleAuthPaymentOrder","name":"Amend attributes of an unauthorized payment order that is yet to be approved by supervisor","summary":"Amend an unathorised single authorized version of payment order","tags":["OTHERS"],"parameters":[{"name":"paymentOrderId","in":"path","type":"string","required":true,"description":"The unique reference number of payment"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"narratives":[{}],"additionalInformations":[{}],"remittanceInformations":[{}],"beneficiaryAddresses":[{}],"signatories":[{}],"invoiceReferences":[{}],"charges":[{}],"overrides":[{}],"reasons":[{}],"accountWithInstitutionAddresses":[{}],"orderingPostAddrLine":[{}],"contextName":[{}],"contextValue":[{}],"messageType":[{}],"paymentOrderProductId":"string"}},"responses":{"200":"SingleAuthPaymentOrderResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"DELETE","path":"/order/paymentOrders/{paymentOrderId}/pendingApprovals","fullPath":"/api/v4.1.0/order/paymentOrders/{paymentOrderId}/pendingApprovals","operationId":"deleteSingleAuthPaymentOrder","name":"Cancel an approved single authorized version of payment order that is in an awaiting status viz. Warehouse, Awaiting Funds","summary":"Cancel unauthorized payment order","tags":["OTHERS"],"parameters":[{"name":"paymentOrderId","in":"path","type":"string","required":true,"description":"The unique reference number of payment"},{"name":"payload","in":"body","type":"object","required":false,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}}},"responses":{"200":"SingleAuthPaymentOrderResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/order/paymentOrders/{paymentOrderId}/approvals","fullPath":"/api/v4.1.0/order/paymentOrders/{paymentOrderId}/approvals","operationId":"approveUnauthPaymentOrder","name":"Approve or reject an unauthorized payment that is awaiting supervisor approval.","summary":"Authorize an unauthorized payment order","tags":["OTHERS"],"parameters":[{"name":"paymentOrderId","in":"path","type":"string","required":true,"description":"The unique reference number of payment"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"UnauthPaymentOrderResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"POST","path":"/order/paymentOrders/{paymentOrderId}/paymentRequests","fullPath":"/api/v4.1.0/order/paymentOrders/{paymentOrderId}/paymentRequests","operationId":"updatePaymentOrderResponse","name":"Update response in payment order received for a request sent to the payment system","summary":"Update response in payment order received for a request sent ","tags":["OTHERS"],"parameters":[{"name":"paymentOrderId","in":"path","type":"string","required":true,"description":"The unique reference number of payment"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"id":"string","status":"string","transactionStatus":"string","uniqueIdentifier":"string","audit":{"T24_time":{},"versionNumber":{},"requestParse_time":{},"responseParse_time":{}}},"body":{"paymentOrderId":"string","status":"string","paymentSystemId":"string","additionalInformation":"string","createdBy":"string","response":"string","isProcessingCompleted":"string","rejectReasonCode":"string","contextName":"string","contextValue":"string","creationDate":"string","sourceSystem":"string","responseType":"string","extensions":{}}},"responses":{"200":"PaymentOrderResponseResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}}]},{"key":"order-paymentOrders-service-v5.0.0","title":"Payment Orders","version":"v5.0.0","description":"API for the creation, viewing and management of payment orders","endpointCount":18,"endpoints":[{"method":"POST","path":"/order/paymentOrders","fullPath":"/api/v5.0.0/order/paymentOrders","operationId":"createPaymentOrder","name":"Create the payment order in Transact for various scnearios like loan disbursement, merchant fee processing, prepay and loan repayment","summary":"Creates the payment order","tags":["RETAIL"],"parameters":[{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"narratives":[{}],"additionalInformations":[{}],"remittanceInformations":[{}],"beneficiaryAddresses":[{}],"signatories":[{}],"invoiceReferences":[{}],"charges":[{}],"overrides":[{}],"reasons":[{}],"accountWithInstitutionAddresses":[{}],"orderingPostAddrLine":[{}],"contextNames":[{}],"contextValues":[{}],"messageType":[{}],"paymentOrderProductId":"string"}},"responses":{"200":"PaymentOrderResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"POST","path":"/order/paymentOrders/instantPayments","fullPath":"/api/v5.0.0/order/paymentOrders/instantPayments","operationId":"createInstantPaymentOrder","name":"Initate a new instant payment order.  This API can be called in validate or commit mode. Former validates and responds back with status (and errors if any). Latter validates and commits if there are no validation errors.","summary":"Initiate a new instant payment order","tags":[],"parameters":[{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"benPostSwiftAddr":[{}],"benPostAddressLine":[{}],"remittanceInfo":[{}],"contextName":[{}],"contextValue":[{}],"chargeDetails":[{}],"chargeInfo":[{}],"chargeAmt":[{}],"chargeCurr":[{}],"chargeAccountAmt":[{}],"chargeAcc":[{}],"chargeAccCurr":[{}],"debitAccountId":"string","debitAccountIBAN":"string","debitCurrency":"string"}},"responses":{"200":"InstantPaymentOrderResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/order/paymentOrders/{paymentOrderId}/cancellations","fullPath":"/api/v5.0.0/order/paymentOrders/{paymentOrderId}/cancellations","operationId":"cancelExternalPaymentOrder","name":"Delete a payment order awaiting supervisor approval","summary":"Reject an unauthorised payment order","tags":[],"parameters":[{"name":"paymentOrderId","in":"path","type":"string","required":true,"description":"The unique reference number of payment"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"internalStatus":"string","cancellationReason":"string","remarks":"string","initiator":"string","extensions":{}}},"responses":{"200":"ExternalPaymentOrderResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/order/paymentOrders/paymentOrderApprovals/{paymentOrderId}","fullPath":"/api/v5.0.0/order/paymentOrders/paymentOrderApprovals/{paymentOrderId}","operationId":"approvePaymentOrder","name":"Approve or reject a payment that is awaiting supervisor approval.","summary":"Authorise a payment order","tags":[],"parameters":[{"name":"paymentOrderId","in":"path","type":"string","required":true,"description":"The unique reference number of payment"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"narratives":[{}],"additionalInformations":[{}],"remittanceInformations":[{}],"beneficiaryAddresses":[{}],"signatories":[{}],"invoiceReferences":[{}],"charges":[{}],"overrides":[{}],"reasons":[{}],"accountWithInstitutionAddresses":[{}],"orderingPostAddrLine":[{}],"contextNames":[{}],"contextValues":[{}],"messageType":[{}],"paymentOrderProductId":"string"}},"responses":{"200":"PaymentOrderResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/order/paymentOrders/{paymentOrderId}","fullPath":"/api/v5.0.0/order/paymentOrders/{paymentOrderId}","operationId":"getPaymentOrder","name":"Retrieve a specific order for a given payment order id","summary":"Retrieve payment order for a given id","tags":[],"parameters":[{"name":"paymentOrderId","in":"path","type":"string","required":true,"description":"The unique reference number of payment"},{"name":"currentState","in":"query","type":"string","required":false,"description":"Contains the current state of the transaction"},{"name":"paymentStatus","in":"query","type":"string","required":false,"description":"Describes the current status of the payment order in the payment system"},{"name":"paymentOrderProductId","in":"query","type":"string","required":false,"description":"Indicates the payment order product for which payment is initiated"},{"name":"debitAccountId","in":"query","type":"string","required":false,"description":"Indicates the debit account number of the payment or transaction."},{"name":"orderingCustomerId","in":"query","type":"string","required":false,"description":"Indicates the customer id for the ordering customer"},{"name":"uniqueTransactionReference","in":"query","type":"string","required":false,"description":"Unique transaction reference details"},{"name":"executionDate","in":"query","type":"string","required":false,"description":"Date on which the transaction or payment gets processed, i.e. the processing date of the transaction."},{"name":"bulkReference","in":"query","type":"string","required":false,"description":"Contains bulk master reference for the payment."},{"name":"paymentSource","in":"query","type":"string","required":false,"description":"Indicates the source from where the payment is originated"},{"name":"creditAccountId","in":"query","type":"string","required":false,"description":"Credit account identifier of the payment or transaction"},{"name":"beneficiaryAccountId","in":"query","type":"string","required":false,"description":"Unique account identifier of the beneficiary account number."},{"name":"accountWithBankBIC","in":"query","type":"string","required":false,"description":"This is the BIC code of the institution where beneficiary holds an account"},{"name":"accountWithBankClearingCode","in":"query","type":"string","required":false,"description":"This is the national clearing code or sort code of the institution where beneficiary holds an account"},{"name":"historyDetails","in":"query","type":"string","required":false,"description":"Indicates the history details such as history company id , history date, history number"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"PaymentOrderResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"PUT","path":"/order/paymentOrders/{paymentOrderId}","fullPath":"/api/v5.0.0/order/paymentOrders/{paymentOrderId}","operationId":"updatePaymentOrder","name":"Amend attributes of a payment order that is yet to be approved by supervisor","summary":"Amend an unathorised payment order","tags":[],"parameters":[{"name":"paymentOrderId","in":"path","type":"string","required":true,"description":"The unique reference number of payment"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"narratives":[{}],"additionalInformations":[{}],"remittanceInformations":[{}],"beneficiaryAddresses":[{}],"signatories":[{}],"invoiceReferences":[{}],"charges":[{}],"overrides":[{}],"reasons":[{}],"accountWithInstitutionAddresses":[{}],"orderingPostAddrLine":[{}],"contextNames":[{}],"contextValues":[{}],"messageType":[{}],"paymentOrderProductId":"string"}},"responses":{"200":"PaymentOrderResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"DELETE","path":"/order/paymentOrders/{paymentOrderId}","fullPath":"/api/v5.0.0/order/paymentOrders/{paymentOrderId}","operationId":"deletePaymentOrder","name":"Cancel an approved payment order that is in an awaiting status viz. Warehouse, Awaiting Funds","summary":"Cancel payment order","tags":[],"parameters":[{"name":"paymentOrderId","in":"path","type":"string","required":true,"description":"The unique reference number of payment"},{"name":"payload","in":"body","type":"object","required":false,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}}},"responses":{"200":"PaymentOrderResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/order/paymentOrders/trackedPayments","fullPath":"/api/v5.0.0/order/paymentOrders/trackedPayments","operationId":"getTrackedPaymentOrders","name":"Retrieve the status of payment order for a given order id","summary":"Retrieve the status of an order","tags":[],"parameters":[{"name":"paymentOrderId","in":"query","type":"string","required":false,"description":"The unique reference number of payment"},{"name":"paymentSystemId","in":"query","type":"string","required":false,"description":"Payment system id details"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"TrackedPaymentOrdersResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/order/paymentOrders/gpi/trackedPayments","fullPath":"/api/v5.0.0/order/paymentOrders/gpi/trackedPayments","operationId":"getGpiPaymentTracking","name":"Retrieve SWIFT GPI tracker status of a payment. Pre-requisite API must be called before calling this API.","summary":"Retrieve GPI tracking information","tags":[],"parameters":[{"name":"paymentId","in":"query","type":"string","required":false,"description":"Indicates the unique reference number of the payment"},{"name":"paymentMethod","in":"query","type":"string","required":false,"description":"Method chosen to make the payment"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"GpiPaymentTrackingResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/order/paymentOrders/recalls/eligibleOrders","fullPath":"/api/v5.0.0/order/paymentOrders/recalls/eligibleOrders","operationId":"getPaymentOrdersForRecall","name":"Retrieve completed payments that are eligible for recall","summary":"Retrieve the payments eligible for recall","tags":[],"parameters":[{"name":"orderingCustomerId","in":"query","type":"string","required":false,"description":"Indicates the customer id for the ordering customer"},{"name":"paymentOrderId","in":"query","type":"string","required":false,"description":"The unique reference number of payment"},{"name":"paymentOrderProductId","in":"query","type":"string","required":false,"description":"Indicates the payment order product for which payment is initiated"},{"name":"startDate","in":"query","type":"string","required":false,"description":"Contains the date on which the transaction or payment gets initiated."},{"name":"endDate","in":"query","type":"string","required":false,"description":"Indicates the date till which the transaction history requested. If 20120101 is the start date and 20120201 is the end date, all transactions that are booked between January 1 to February 1 2012 are r"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"PaymentOrdersForRecallResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/order/paymentOrders/recalls/status","fullPath":"/api/v5.0.0/order/paymentOrders/recalls/status","operationId":"getPaymentOrderRecallStatus","name":"Retrieve the status of an outward recall requests sent for completed payments","summary":"Retrieve the status of recall request","tags":[],"parameters":[{"name":"paymentOrderId","in":"query","type":"string","required":false,"description":"The unique reference number of payment"},{"name":"paymentOrderProductId","in":"query","type":"string","required":false,"description":"Indicates the payment order product for which payment is initiated"},{"name":"orderingCustomerId","in":"query","type":"string","required":false,"description":"Indicates the customer id for the ordering customer"},{"name":"startDate","in":"query","type":"string","required":false,"description":"Contains the date on which the transaction or payment gets initiated."},{"name":"endDate","in":"query","type":"string","required":false,"description":"Indicates the date till which the transaction history requested. If 20120101 is the start date and 20120201 is the end date, all transactions that are booked between January 1 to February 1 2012 are r"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"PaymentOrderRecallStatusResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"POST","path":"/order/paymentOrders/gpi/payments/{paymentId}/status","fullPath":"/api/v5.0.0/order/paymentOrders/gpi/payments/{paymentId}/status","operationId":"createGPIPaymentStatus","name":"Pre-requisite API to be called by the calling application (before get GPI status API) so as to ensure Temenos GPI tracker process creates and updates the latest status from SWIFT GPI Tracker","summary":"Create a reference and update GPI tracker status","tags":[],"parameters":[{"name":"paymentId","in":"path","type":"string","required":true,"description":"Indicates the unique reference number of the payment"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"UETRId":"string","paymentReference":"string","requestMessage":"string","responseMessage":"string","extensions":{}}},"responses":{"200":"GPIPaymentStatusResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/order/paymentOrders/gpi/payments/{paymentId}/status","fullPath":"/api/v5.0.0/order/paymentOrders/gpi/payments/{paymentId}/status","operationId":"updateGPIPaymentStatus","name":"Pre-requisite API to be called by the calling application (before get GPI status API) so as to ensure Temenos GPI tracker process retrieves and updates the latest status from SWIFT GPI tracker","summary":"Updates GPI tracker status","tags":[],"parameters":[{"name":"paymentId","in":"path","type":"string","required":true,"description":"Indicates the unique reference number of the payment"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"UETRId":"string","paymentReference":"string","requestMessage":"string","responseMessage":"string","extensions":{}}},"responses":{"200":"GPIPaymentStatusResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/order/paymentOrders/externalCodes","fullPath":"/api/v5.0.0/order/paymentOrders/externalCodes","operationId":"getIsoExternalCodes","name":"Retrieves the list of ISO external codes applicable for different fields in ISO messages","summary":"Retrieve ISO external code lists","tags":[],"parameters":[{"name":"id","in":"query","type":"string","required":false,"description":"Contains the daily position class id."},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"IsoExternalCodesResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"POST","path":"/order/paymentOrders/pendingApprovals","fullPath":"/api/v5.0.0/order/paymentOrders/pendingApprovals","operationId":"createSingleAuthPaymentOrder","name":"Create a new payment order, this API can be called to validate or commit the orders","summary":"Initiate a new payment order","tags":[],"parameters":[{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"narratives":[{}],"additionalInformations":[{}],"remittanceInformations":[{}],"beneficiaryAddresses":[{}],"signatories":[{}],"invoiceReferences":[{}],"charges":[{}],"overrides":[{}],"reasons":[{}],"accountWithInstitutionAddresses":[{}],"orderingPostAddrLine":[{}],"contextNames":[{}],"contextValues":[{}],"messageType":[{}],"paymentOrderProductId":"string"}},"responses":{"200":"SingleAuthPaymentOrderResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/order/paymentOrders/{paymentOrderId}/pendingApprovals","fullPath":"/api/v5.0.0/order/paymentOrders/{paymentOrderId}/pendingApprovals","operationId":"updateSingleAuthPaymentOrder","name":"Amend attributes of a payment order that is yet to be approved by supervisor","summary":"Amend an unathorised payment order","tags":[],"parameters":[{"name":"paymentOrderId","in":"path","type":"string","required":true,"description":"The unique reference number of payment"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"narratives":[{}],"additionalInformations":[{}],"remittanceInformations":[{}],"beneficiaryAddresses":[{}],"signatories":[{}],"invoiceReferences":[{}],"charges":[{}],"overrides":[{}],"reasons":[{}],"accountWithInstitutionAddresses":[{}],"orderingPostAddrLine":[{}],"contextNames":[{}],"contextValues":[{}],"messageType":[{}],"paymentOrderProductId":"string"}},"responses":{"200":"SingleAuthPaymentOrderResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"DELETE","path":"/order/paymentOrders/{paymentOrderId}/pendingApprovals","fullPath":"/api/v5.0.0/order/paymentOrders/{paymentOrderId}/pendingApprovals","operationId":"deleteSingleAuthPaymentOrder","name":"Cancel an approved payment order that is in an awaiting status viz. Warehouse, Awaiting Funds","summary":"Cancel payment order","tags":[],"parameters":[{"name":"paymentOrderId","in":"path","type":"string","required":true,"description":"The unique reference number of payment"},{"name":"payload","in":"body","type":"object","required":false,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}}},"responses":{"200":"SingleAuthPaymentOrderResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/order/paymentOrders/{paymentOrderId}/approvals","fullPath":"/api/v5.0.0/order/paymentOrders/{paymentOrderId}/approvals","operationId":"approveUnauthPaymentOrder","name":"Approve or reject a payment that is awaiting supervisor approval.","summary":"Authorise a payment order","tags":[],"parameters":[{"name":"paymentOrderId","in":"path","type":"string","required":true,"description":"The unique reference number of payment"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"UnauthPaymentOrderResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}}]},{"key":"order-paymentOrders-service-v5.1.0","title":"Payment Orders","version":"v5.1.0","description":"Payment order application (POA) is a Temenos payments application that helps bank manage their payment orders before they are being sent for payment execution by the bank's payment system. It provides order management functionality for payers to initiate, view and manage their orders from an online ","endpointCount":19,"endpoints":[{"method":"POST","path":"/order/paymentOrders/instantPayments","fullPath":"/api/v5.1.0/order/paymentOrders/instantPayments","operationId":"createInstantPaymentOrder","name":"Initate a new instant payment order.  This API can be called in validate or commit mode. Former validates and responds back with status (and errors if any). Latter validates and commits if there are no validation errors.","summary":"Initiate a new instant payment order","tags":["OTHERS"],"parameters":[{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"benPostSwiftAddr":[{}],"benPostAddressLine":[{}],"remittanceInfo":[{}],"contextName":[{}],"contextValue":[{}],"chargeDetails":[{}],"chargeInfo":[{}],"chargeAmt":[{}],"chargeCurr":[{}],"chargeAccountAmt":[{}],"chargeAcc":[{}],"chargeAccCurr":[{}],"debitAccountId":"string","debitAccountIBAN":"string","debitCurrency":"string"}},"responses":{"200":"InstantPaymentOrderResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/order/paymentOrders/{paymentOrderId}/cancellations","fullPath":"/api/v5.1.0/order/paymentOrders/{paymentOrderId}/cancellations","operationId":"cancelExternalPaymentOrder","name":"Delete a payment order awaiting supervisor approval","summary":"Reject an unauthorised payment order","tags":["OTHERS"],"parameters":[{"name":"paymentOrderId","in":"path","type":"string","required":true,"description":"The unique reference number of payment"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"internalStatus":"string","cancellationReason":"string","remarks":"string","initiator":"string","extensions":{}}},"responses":{"200":"ExternalPaymentOrderResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/order/paymentOrders/trackedPayments","fullPath":"/api/v5.1.0/order/paymentOrders/trackedPayments","operationId":"getTrackedPaymentOrders","name":"Retrieve the status of payment order for a given order id","summary":"Retrieve the status of an order","tags":["OTHERS"],"parameters":[{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"TrackedPaymentOrdersResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/order/paymentOrders/gpi/trackedPayments","fullPath":"/api/v5.1.0/order/paymentOrders/gpi/trackedPayments","operationId":"getGpiPaymentTracking","name":"Retrieve SWIFT GPI tracker status of a payment. Pre-requisite API must be called before calling this API.","summary":"Retrieve GPI tracking information","tags":["OTHERS"],"parameters":[{"name":"paymentId","in":"query","type":"string","required":false,"description":"Indicates the unique reference number of the payment"},{"name":"paymentMethod","in":"query","type":"string","required":false,"description":"Method chosen to make the payment"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"GpiPaymentTrackingResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/order/paymentOrders/recalls/eligibleOrders","fullPath":"/api/v5.1.0/order/paymentOrders/recalls/eligibleOrders","operationId":"getPaymentOrdersForRecall","name":"Retrieve completed payments that are eligible for recall","summary":"Retrieve the payments eligible for recall","tags":["OTHERS"],"parameters":[{"name":"orderingCustomerId","in":"query","type":"string","required":false,"description":"Indicates the customer id for the ordering customer"},{"name":"paymentOrderId","in":"query","type":"string","required":false,"description":"The unique reference number of payment"},{"name":"paymentOrderProductId","in":"query","type":"string","required":false,"description":"Indicates the payment order product for which payment is initiated"},{"name":"startDate","in":"query","type":"string","required":false,"description":"Contains the date on which the transaction or payment gets initiated."},{"name":"endDate","in":"query","type":"string","required":false,"description":"Indicates the date till which the transaction history requested. If 20120101 is the start date and 20120201 is the end date, all transactions that are booked between January 1 to February 1 2012 are r"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"PaymentOrdersForRecallResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/order/paymentOrders/recalls/status","fullPath":"/api/v5.1.0/order/paymentOrders/recalls/status","operationId":"getPaymentOrderRecallStatus","name":"Retrieve the status of an outward recall requests sent for completed payments","summary":"Retrieve the status of recall request","tags":["OTHERS"],"parameters":[{"name":"paymentOrderId","in":"query","type":"string","required":false,"description":"The unique reference number of payment"},{"name":"paymentOrderProductId","in":"query","type":"string","required":false,"description":"Indicates the payment order product for which payment is initiated"},{"name":"orderingCustomerId","in":"query","type":"string","required":false,"description":"Indicates the customer id for the ordering customer"},{"name":"startDate","in":"query","type":"string","required":false,"description":"Contains the date on which the transaction or payment gets initiated."},{"name":"endDate","in":"query","type":"string","required":false,"description":"Indicates the date till which the transaction history requested. If 20120101 is the start date and 20120201 is the end date, all transactions that are booked between January 1 to February 1 2012 are r"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"PaymentOrderRecallStatusResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"POST","path":"/order/paymentOrders/gpi/payments/{paymentId}/status","fullPath":"/api/v5.1.0/order/paymentOrders/gpi/payments/{paymentId}/status","operationId":"createGPIPaymentStatus","name":"Pre-requisite API to be called by the calling application (before get GPI status API) so as to ensure Temenos GPI tracker process creates and updates the latest status from SWIFT GPI Tracker","summary":"Create a reference and update GPI tracker status","tags":["OTHERS"],"parameters":[{"name":"paymentId","in":"path","type":"string","required":true,"description":"Indicates the unique reference number of the payment"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"UETRId":"string","paymentReference":"string","requestMessage":"string","responseMessage":"string","extensions":{}}},"responses":{"200":"GPIPaymentStatusResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/order/paymentOrders/gpi/payments/{paymentId}/status","fullPath":"/api/v5.1.0/order/paymentOrders/gpi/payments/{paymentId}/status","operationId":"updateGPIPaymentStatus","name":"Pre-requisite API to be called by the calling application (before get GPI status API) so as to ensure Temenos GPI tracker process retrieves and updates the latest status from SWIFT GPI tracker","summary":"Updates GPI tracker status","tags":["OTHERS"],"parameters":[{"name":"paymentId","in":"path","type":"string","required":true,"description":"Indicates the unique reference number of the payment"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"UETRId":"string","paymentReference":"string","requestMessage":"string","responseMessage":"string","extensions":{}}},"responses":{"200":"GPIPaymentStatusResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/order/paymentOrders/externalCodes","fullPath":"/api/v5.1.0/order/paymentOrders/externalCodes","operationId":"getIsoExternalCodes","name":"Retrieves the list of ISO external codes applicable for different fields in ISO messages","summary":"Retrieve ISO external code lists","tags":["OTHERS"],"parameters":[{"name":"id","in":"query","type":"string","required":false,"description":"Contains the daily position class id."},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"IsoExternalCodesResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"POST","path":"/order/paymentOrders/pendingApprovals","fullPath":"/api/v5.1.0/order/paymentOrders/pendingApprovals","operationId":"createSingleAuthPaymentOrder","name":"Create a new payment order, this API can be called to validate or commit the orders","summary":"Initiate a new payment order","tags":["OTHERS"],"parameters":[{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"narratives":[{}],"additionalInformations":[{}],"remittanceInformations":[{}],"beneficiaryAddresses":[{}],"signatories":[{}],"invoiceReferences":[{}],"charges":[{}],"overrides":[{}],"reasons":[{}],"accountWithInstitutionAddresses":[{}],"orderingPostAddrLine":[{}],"contextNames":[{}],"contextValues":[{}],"messageType":[{}],"paymentOrderProductId":"string"}},"responses":{"200":"SingleAuthPaymentOrderResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/order/paymentOrders/{paymentOrderId}/pendingApprovals","fullPath":"/api/v5.1.0/order/paymentOrders/{paymentOrderId}/pendingApprovals","operationId":"updateSingleAuthPaymentOrder","name":"Amend attributes of a payment order that is yet to be approved by supervisor","summary":"Amend an unathorised payment order","tags":["OTHERS"],"parameters":[{"name":"paymentOrderId","in":"path","type":"string","required":true,"description":"The unique reference number of payment"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"narratives":[{}],"additionalInformations":[{}],"remittanceInformations":[{}],"beneficiaryAddresses":[{}],"signatories":[{}],"invoiceReferences":[{}],"charges":[{}],"overrides":[{}],"reasons":[{}],"accountWithInstitutionAddresses":[{}],"orderingPostAddrLine":[{}],"contextNames":[{}],"contextValues":[{}],"messageType":[{}],"paymentOrderProductId":"string"}},"responses":{"200":"SingleAuthPaymentOrderResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"DELETE","path":"/order/paymentOrders/{paymentOrderId}/pendingApprovals","fullPath":"/api/v5.1.0/order/paymentOrders/{paymentOrderId}/pendingApprovals","operationId":"deleteSingleAuthPaymentOrder","name":"Cancel an approved payment order that is in an awaiting status viz. Warehouse, Awaiting Funds","summary":"Cancel payment order","tags":["OTHERS"],"parameters":[{"name":"paymentOrderId","in":"path","type":"string","required":true,"description":"The unique reference number of payment"},{"name":"payload","in":"body","type":"object","required":false,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}}},"responses":{"200":"SingleAuthPaymentOrderResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/order/paymentOrders/{paymentOrderId}/approvals","fullPath":"/api/v5.1.0/order/paymentOrders/{paymentOrderId}/approvals","operationId":"approveUnauthPaymentOrder","name":"Approve or reject a payment that is awaiting supervisor approval.","summary":"Authorise a payment order","tags":["OTHERS"],"parameters":[{"name":"paymentOrderId","in":"path","type":"string","required":true,"description":"The unique reference number of payment"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"UnauthPaymentOrderResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/order/paymentOrders","fullPath":"/api/v5.1.0/order/paymentOrders","operationId":"getPaymentOrders","name":"Retrieve list of authorised payment orders based on a specific criteria","summary":"Retrieve list of payment orders","tags":["OTHERS"],"parameters":[{"name":"paymentOrderId","in":"query","type":"string","required":false,"description":"The unique reference number of payment"},{"name":"currentState","in":"query","type":"string","required":false,"description":"Contains the current state of the transaction"},{"name":"paymentStatus","in":"query","type":"string","required":false,"description":"Describes the current status of the payment order in the payment system"},{"name":"paymentOrderProductId","in":"query","type":"string","required":false,"description":"Indicates the payment order product for which payment is initiated"},{"name":"debitAccountId","in":"query","type":"string","required":false,"description":"Indicates the debit account number of the payment or transaction."},{"name":"orderingCustomerId","in":"query","type":"string","required":false,"description":"Indicates the customer id for the ordering customer"},{"name":"uniqueTransactionReference","in":"query","type":"string","required":false,"description":"Unique transaction reference details"},{"name":"executionDate","in":"query","type":"string","required":false,"description":"Date on which the transaction or payment gets processed, i.e. the processing date of the transaction."},{"name":"bulkReference","in":"query","type":"string","required":false,"description":"Contains bulk master reference for the payment."},{"name":"paymentSource","in":"query","type":"string","required":false,"description":"Indicates the source from where the payment is originated"},{"name":"creditAccountId","in":"query","type":"string","required":false,"description":"Credit account identifier of the payment or transaction"},{"name":"beneficiaryAccountId","in":"query","type":"string","required":false,"description":"Unique account identifier of the beneficiary account number."},{"name":"accountWithBankBIC","in":"query","type":"string","required":false,"description":"This is the BIC code of the institution where beneficiary holds an account"},{"name":"accountWithBankClearingCode","in":"query","type":"string","required":false,"description":"This is the national clearing code or sort code of the institution where beneficiary holds an account"},{"name":"historyDetails","in":"query","type":"string","required":false,"description":"Indicates the history details such as history company id , history date, history number"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"PaymentOrdersResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"POST","path":"/order/paymentOrders","fullPath":"/api/v5.1.0/order/paymentOrders","operationId":"createPaymentOrder","name":"Create the payment order in Transact for various scenarios like loan disbursement, merchant fee processing, prepay and loan repayment","summary":"Creates the payment order","tags":["RETAIL"],"parameters":[{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"narratives":[{}],"additionalInformations":[{}],"remittanceInformations":[{}],"beneficiaryAddresses":[{}],"signatories":[{}],"invoiceReferences":[{}],"charges":[{}],"reasons":[{}],"accountWithInstitutionAddresses":[{}],"orderingPostAddrLine":[{}],"contextName":[{}],"contextValue":[{}],"messageType":[{}],"SwiftAddresses":[{}],"instructionCodes":[{}]}},"responses":{"200":"PaymentOrderResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/order/paymentOrders/{paymentOrderId}","fullPath":"/api/v5.1.0/order/paymentOrders/{paymentOrderId}","operationId":"getPaymentOrder","name":"Retrieve a specific order for a given payment order id","summary":"Retrieve payment order for a given id","tags":["OTHERS"],"parameters":[{"name":"paymentOrderId","in":"path","type":"string","required":true,"description":"The unique reference number of payment"},{"name":"currentState","in":"query","type":"string","required":false,"description":"Contains the current state of the transaction"},{"name":"paymentStatus","in":"query","type":"string","required":false,"description":"Describes the current status of the payment order in the payment system"},{"name":"paymentOrderProductId","in":"query","type":"string","required":false,"description":"Indicates the payment order product for which payment is initiated"},{"name":"debitAccountId","in":"query","type":"string","required":false,"description":"Indicates the debit account number of the payment or transaction."},{"name":"orderingCustomerId","in":"query","type":"string","required":false,"description":"Indicates the customer id for the ordering customer"},{"name":"uniqueTransactionReference","in":"query","type":"string","required":false,"description":"Unique transaction reference details"},{"name":"executionDate","in":"query","type":"string","required":false,"description":"Date on which the transaction or payment gets processed, i.e. the processing date of the transaction."},{"name":"bulkReference","in":"query","type":"string","required":false,"description":"Contains bulk master reference for the payment."},{"name":"paymentSource","in":"query","type":"string","required":false,"description":"Indicates the source from where the payment is originated"},{"name":"creditAccountId","in":"query","type":"string","required":false,"description":"Credit account identifier of the payment or transaction"},{"name":"beneficiaryAccountId","in":"query","type":"string","required":false,"description":"Unique account identifier of the beneficiary account number."},{"name":"accountWithBankBIC","in":"query","type":"string","required":false,"description":"This is the BIC code of the institution where beneficiary holds an account"},{"name":"accountWithBankClearingCode","in":"query","type":"string","required":false,"description":"This is the national clearing code or sort code of the institution where beneficiary holds an account"},{"name":"historyDetails","in":"query","type":"string","required":false,"description":"Indicates the history details such as history company id , history date, history number"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"PaymentOrderResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"PUT","path":"/order/paymentOrders/{paymentOrderId}","fullPath":"/api/v5.1.0/order/paymentOrders/{paymentOrderId}","operationId":"updatePaymentOrder","name":"Amend attributes of a payment order that is yet to be approved by supervisor","summary":"Amend an unathorised payment order","tags":["OTHERS"],"parameters":[{"name":"paymentOrderId","in":"path","type":"string","required":true,"description":""},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"narratives":[{}],"additionalInformations":[{}],"remittanceInformations":[{}],"beneficiaryAddresses":[{}],"signatories":[{}],"invoiceReferences":[{}],"charges":[{}],"reasons":[{}],"accountWithInstitutionAddresses":[{}],"orderingPostAddrLine":[{}],"contextName":[{}],"contextValue":[{}],"messageType":[{}],"SwiftAddresses":[{}],"instructionCodes":[{}]}},"responses":{"200":"PaymentOrderResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"DELETE","path":"/order/paymentOrders/{paymentOrderId}","fullPath":"/api/v5.1.0/order/paymentOrders/{paymentOrderId}","operationId":"deletePaymentOrder","name":"Cancel an approved payment order that is in an awaiting status viz. Warehouse, Awaiting Funds","summary":"Cancel payment order","tags":["OTHERS"],"parameters":[{"name":"paymentOrderId","in":"path","type":"string","required":true,"description":""},{"name":"payload","in":"body","type":"object","required":false,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}}},"responses":{"200":"PaymentOrderResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/order/paymentOrders/paymentOrderApprovals/{paymentOrderId}","fullPath":"/api/v5.1.0/order/paymentOrders/paymentOrderApprovals/{paymentOrderId}","operationId":"approvePaymentOrder","name":"Approve or reject a payment that is awaiting supervisor approval.","summary":"Authorise a payment order","tags":["OTHERS"],"parameters":[{"name":"paymentOrderId","in":"path","type":"string","required":true,"description":""},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"narratives":[{}],"additionalInformations":[{}],"remittanceInformations":[{}],"beneficiaryAddresses":[{}],"signatories":[{}],"invoiceReferences":[{}],"charges":[{}],"reasons":[{}],"accountWithInstitutionAddresses":[{}],"orderingPostAddrLine":[{}],"contextName":[{}],"contextValue":[{}],"messageType":[{}],"SwiftAddresses":[{}],"instructionCodes":[{}]}},"responses":{"200":"PaymentOrderResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}}]},{"key":"order-paymentOrdersConfiguration-service-v3.0.0","title":"Payment Orders Configuration","version":"v3.0.0","description":"Payment Order Application (POA) is a Temenos Payments Application that helps bank manage their Payment Orders before they are being sent for payment execution by the bank's payment system. It provides Order Management functionality for Payers to initiate, view and manage their orders from an online ","endpointCount":4,"endpoints":[{"method":"GET","path":"/order/paymentOrders/purposes","fullPath":"/api/v3.0.0/order/paymentOrders/purposes","operationId":"getPaymentOrderPurposes","name":"Retrieve all the Purpose codes configured in POA. Can be used in channels to list down possible purpose codes for end customer to choose while initiating an Order","summary":"Retrieve payment purpose code details","tags":[],"parameters":[{"name":"paymentOrderPurposeCodeId","in":"query","type":"string","required":false,"description":"Indicates the Id of payment purpose code i.e. purpose of the instruction based on a set of pre-defined categories."},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"PaymentOrderPurposesResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/order/paymentOrders/products","fullPath":"/api/v3.0.0/order/paymentOrders/products","operationId":"getPaymentOrderProducts","name":"Retrieve all the payment products configured in POA. Can be used in channels to list down possible business products while initiating a payment","summary":"Retrieve payment product details","tags":[],"parameters":[{"name":"paymentProductGroupId","in":"query","type":"string","required":false,"description":"Payment method group details of the payment"},{"name":"paymentOrderProductId","in":"query","type":"string","required":false,"description":"Indicates the payment order product for which payment is initiated"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"PaymentOrderProductsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/order/paymentOrders/countryRules","fullPath":"/api/v3.0.0/order/paymentOrders/countryRules","operationId":"getPaymentOrderCountryRules","name":"Retrieve Country specific rules configured for a given country. This can be used by an external application capturing orders to validate the payment using these rules before submitting.","summary":"Retrieve payment country rule details","tags":[],"parameters":[{"name":"countryId","in":"query","type":"string","required":false,"description":"ISO country code of the financial institution. "},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"PaymentOrderCountryRulesResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/order/paymentOrders/isoClearingCodes","fullPath":"/api/v3.0.0/order/paymentOrders/isoClearingCodes","operationId":"getISOClearingCodes","name":"Retrieve the list of ISO clearing codes for a given Clearing. This information can be used while submitting Orders from the channel.","summary":"Retrieve ISO clearing codes","tags":[],"parameters":[{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"ISOClearingCodesResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}}]},{"key":"order-paymentStops-service-v1.0.0","title":"Management of Payment stop requests","version":"v1.0.0","description":"API to create, update and manage Payment Stop instructions for an account based on the Cheque details or Transaction Amount","endpointCount":4,"endpoints":[{"method":"GET","path":"/order/paymentStops/{accountId}","fullPath":"/api/v1.0.0/order/paymentStops/{accountId}","operationId":"getPaymentStop","name":"Retrieves the list of Payment Stop requests  details such Cheque nos, Amount range, Beneficiary, Period and Charge details available for a specific account","summary":"Retrieves list of Payment Stop requests for an Account","tags":[],"parameters":[{"name":"accountId","in":"path","type":"string","required":true,"description":"Identifier of the account. Often referred to as the account number, yet for consistency this is always referred to as accountId. Accepts both IBAN & BBAN"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"PaymentStopResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"POST","path":"/order/paymentStops/{accountId}","fullPath":"/api/v1.0.0/order/paymentStops/{accountId}","operationId":"createPaymentStop","name":"Create a Payment Stop Request for an Account with details such as Cheque number range, amount range, period & Charges for blocking the transaction","summary":"Create Payment Stop request","tags":[],"parameters":[{"name":"accountId","in":"path","type":"string","required":true,"description":"Identifier of the account. Often referred to as the account number, yet for consistency this is always referred to as accountId. Accepts both IBAN & BBAN"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"stops":[{}],"currencyId":"string"}},"responses":{"200":"PaymentStopResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/order/paymentStops/{accountId}","fullPath":"/api/v1.0.0/order/paymentStops/{accountId}","operationId":"updatePaymentStop","name":"Update a Payment Stop Request for an Account with details such as Cheque nos range, amount range, period & Charges","summary":"Update Payment Stop request","tags":[],"parameters":[{"name":"accountId","in":"path","type":"string","required":true,"description":"Identifier of the account. Often referred to as the account number, yet for consistency this is always referred to as accountId. Accepts both IBAN & BBAN"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"stops":[{}],"currencyId":"string"}},"responses":{"200":"PaymentStopResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/order/paymentStops","fullPath":"/api/v1.0.0/order/paymentStops","operationId":"getPaymentStops","name":"Retrieves the list of Payment Stop requests available in the system with details such as Account Reference, Cheque nos, Amount range, Beneficiary, Period and Charge details","summary":"Retrieves all the Payment Stop requests","tags":[],"parameters":[{"name":"accountId","in":"query","type":"string","required":false,"description":"Identifier of the account. Often referred to as the account number, yet for consistency this is always referred to as accountId. Accepts both IBAN & BBAN"},{"name":"customerId","in":"query","type":"string","required":false,"description":"Identifier of the customer"},{"name":"stopTypeId","in":"query","type":"string","required":false,"description":"Indicates the reason why a Payment Stop is requested for e.g. Cheque lost, funds not available etc. "},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from t24 on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"PaymentStopsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}}]},{"key":"order-paymentStops-service-v2.0.0","title":"Payment Stop Service","version":"v2.0.0","description":"API to create, update and manage Payment Stop instructions for an account based on the Cheque details or Transaction Amount","endpointCount":4,"endpoints":[{"method":"GET","path":"/order/paymentStops/{accountId}","fullPath":"/api/v2.0.0/order/paymentStops/{accountId}","operationId":"getPaymentStop","name":"Retrieves the list of Payment Stop requests  details such Cheque nos, Amount range, Beneficiary, Period and Charge details available for a specific account","summary":"Retrieves list of Payment Stop requests for an Account","tags":[],"parameters":[{"name":"accountId","in":"path","type":"string","required":true,"description":"Identifier of the account. Often referred to as the account number, yet for consistency this is always referred to as accountId. Accepts both IBAN & BBAN"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"The identifier of the underlying Entity/Company/Branch."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"PaymentStopResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"POST","path":"/order/paymentStops/{accountId}","fullPath":"/api/v2.0.0/order/paymentStops/{accountId}","operationId":"createPaymentStop","name":"Create a Payment Stop Request for an Account with details such as Cheque number range, amount range, period & Charges for blocking the transaction","summary":"Create Payment Stop request","tags":[],"parameters":[{"name":"accountId","in":"path","type":"string","required":true,"description":"Identifier of the account. Often referred to as the account number, yet for consistency this is always referred to as accountId. Accepts both IBAN & BBAN"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"The identifier of the underlying Entity/Company/Branch."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"stops":[{}],"currencyId":"string","issueDate":"string"}},"responses":{"200":"PaymentStopResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/order/paymentStops/{accountId}","fullPath":"/api/v2.0.0/order/paymentStops/{accountId}","operationId":"updatePaymentStop","name":"Update a Payment Stop Request for an Account with details such as Cheque nos range, amount range, period & Charges","summary":"Update Payment Stop request","tags":[],"parameters":[{"name":"accountId","in":"path","type":"string","required":true,"description":"Identifier of the account. Often referred to as the account number, yet for consistency this is always referred to as accountId. Accepts both IBAN & BBAN"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"The identifier of the underlying Entity/Company/Branch."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"stops":[{}],"currencyId":"string","issueDate":"string"}},"responses":{"200":"PaymentStopResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/order/paymentStops","fullPath":"/api/v2.0.0/order/paymentStops","operationId":"getPaymentStops","name":"Retrieves the list of Payment Stop requests available in the system with details such as Account Reference, Cheque nos, Amount range, Beneficiary, Period and Charge details","summary":"Retrieves all the Payment Stop requests","tags":[],"parameters":[{"name":"accountId","in":"query","type":"string","required":false,"description":"Identifier of the account. Often referred to as the account number, yet for consistency this is always referred to as accountId. Accepts both IBAN & BBAN"},{"name":"customerId","in":"query","type":"string","required":false,"description":"Identifier of the customer"},{"name":"stopTypeId","in":"query","type":"string","required":false,"description":"Indicates the reason why a Payment Stop is requested for e.g. Cheque lost, funds not available etc. "},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from t24 on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"The identifier of the underlying Entity/Company/Branch."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"PaymentStopsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}}]},{"key":"order-paymentUserAgents-service-v3.0.0","title":"Payment User Agents Management","version":"v3.0.0","description":"Allows the creation, viewing and management of payments and transfers","endpointCount":12,"endpoints":[{"method":"GET","path":"/order/payments/cutoffs","fullPath":"/api/v3.0.0/order/payments/cutoffs","operationId":"getPaymentCutoffs","name":"Retrieves the cutoff based payment details ","summary":"Retrieves the Channel cutoff and Currency cutoff based payment details","tags":[],"parameters":[{"name":"company","in":"query","type":"string","required":false,"description":"The company code"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"PaymentCutoffsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/order/payments/transactions/status/itemCount","fullPath":"/api/v3.0.0/order/payments/transactions/status/itemCount","operationId":"getPaymentsCount","name":"Retrieves the payment transactions count","summary":"Retrieves the payment transactions count for various payment types","tags":[],"parameters":[{"name":"tabView","in":"query","type":"string","required":false,"description":"Indicates the payment tab view"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"PaymentsCountResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/order/payments/{paymentId}/errors","fullPath":"/api/v3.0.0/order/payments/{paymentId}/errors","operationId":"getPaymentsInError","name":"Retrieves the payment transaction content","summary":"Retrieves the payment transaction content for a payment","tags":[],"parameters":[{"name":"paymentId","in":"path","type":"string","required":true,"description":"Indicates the unique reference number of the payment"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"PaymentsInErrorResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/order/payments/{paymentId}/sepaPayments","fullPath":"/api/v3.0.0/order/payments/{paymentId}/sepaPayments","operationId":"getSepaPayment","name":"Retrieves the sepa payment transaction content","summary":"Retrieves the sepa payment transaction content for a given payment","tags":[],"parameters":[{"name":"paymentId","in":"path","type":"string","required":true,"description":"Indicates the unique reference number of the payment"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"SepaPaymentResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/order/payments/{paymentId}","fullPath":"/api/v3.0.0/order/payments/{paymentId}","operationId":"getPayment","name":"Retrieves the payment transaction ","summary":"Retrieves the payment transaction without the extended details","tags":[],"parameters":[{"name":"paymentId","in":"path","type":"string","required":true,"description":"Indicates the unique reference number of the payment"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"PaymentResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/order/payments/instantPayments","fullPath":"/api/v3.0.0/order/payments/instantPayments","operationId":"getInstantPayments","name":"Retrieves the instant payment transactions","summary":"Retrieves the instant payment transactions along with timed out details","tags":[],"parameters":[{"name":"transactionReference","in":"query","type":"string","required":false,"description":"Contains the identifier for the transaction in the core system"},{"name":"messageType","in":"query","type":"string","required":false,"description":"Defines the type of swift messages that are sent or received for a transaction"},{"name":"customerReference","in":"query","type":"string","required":false,"description":"The reference which is provided to the beneficiary/ creditor by the originator of payment"},{"name":"partySendersReferenceIncoming","in":"query","type":"string","required":false,"description":"Debtor payment reference details of incoming"},{"name":"paymentType","in":"query","type":"string","required":false,"description":"Indicates if the payment is Customer (C) type or Bank (B) type"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"InstantPaymentsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/order/payments/transactions","fullPath":"/api/v3.0.0/order/payments/transactions","operationId":"getPendingAndProcessedPayments","name":"Retrieves all type of payment transactions","summary":"Retrieves the payment transactions by using the query filters retrieved from meta api queryFilters","tags":[],"parameters":[{"name":"companyName","in":"query","type":"string","required":false,"description":"The company in which payment is processed"},{"name":"paymentType","in":"query","type":"string","required":false,"description":"Indicates if the payment is Customer (C) type or Bank (B) type"},{"name":"clearingId","in":"query","type":"string","required":false,"description":"Clearing channel specific details"},{"name":"processingDate","in":"query","type":"string","required":false,"description":"The date when payment instruction is processed in system."},{"name":"transactionReference","in":"query","type":"string","required":false,"description":"Contains the identifier for the transaction in the core system"},{"name":"direction","in":"query","type":"string","required":false,"description":"Indicates the direction of the Direct debit claim for which mandate is received. The claim can be 'Outward' i.e. Claim is sent to the other bank or 'Inward'  i.e. other bank submit their claim to debi"},{"name":"transactionCurrency","in":"query","type":"string","required":false,"description":"Indicates the currency of the transaction. For example GBP, USD etc."},{"name":"transactionAmount","in":"query","type":"string","required":false,"description":"Contains the transaction amount. This is based on the currency, either local or foreign currency"},{"name":"statusCode","in":"query","type":"string","required":false,"description":"Status code, as defined by the institution"},{"name":"messageType","in":"query","type":"string","required":false,"description":"Defines the type of swift messages that are sent or received for a transaction"},{"name":"debitCurrency","in":"query","type":"string","required":false,"description":"Currency of the debit account. For example: USD, EUR etc."},{"name":"debitAccountId","in":"query","type":"string","required":false,"description":"Indicates the debit account number of the payment or transaction."},{"name":"creditAccountCompany","in":"query","type":"string","required":false,"description":"Contains the company of the credit party"},{"name":"creditCurrency","in":"query","type":"string","required":false,"description":"Currency of the account which funds will be transferred to."},{"name":"creditAccountId","in":"query","type":"string","required":false,"description":"Credit account identifier of the payment or transaction"},{"name":"channel","in":"query","type":"string","required":false,"description":"Contains the channel in which the activity was performed. If pricing is not determined based on channel, then this is not significant"},{"name":"paymentSource","in":"query","type":"string","required":false,"description":"Indicates the source from where the payment is originated"},{"name":"partySendersReferenceIncoming","in":"query","type":"string","required":false,"description":"Debtor payment reference details of incoming"},{"name":"partySendersReferenceOutgoing","in":"query","type":"string","required":false,"description":"Debtor payment reference details of outgoing"},{"name":"customerReference","in":"query","type":"string","required":false,"description":"The reference which is provided to the beneficiary/ creditor by the originator of payment"},{"name":"entryReference","in":"query","type":"string","required":false,"description":"It is the transaction reference. This is the identifier of the transaction on Temenos Core Banking system."},{"name":"customerOrBankTransfer","in":"query","type":"string","required":false,"description":"Indicates if the payment was initiated by Customer or the financial institution"},{"name":"creditValueDate","in":"query","type":"string","required":false,"description":"Reference quoted by the credit account for a payment"},{"name":"debitValueDate","in":"query","type":"string","required":false,"description":"Date on which the amount will be debited for settlement"},{"name":"endToEndReference","in":"query","type":"string","required":false,"description":"Indicates the end to end reference for the payment. This field can be provided by the person who instructs the payment and this flows through the lifecycle of the payment."},{"name":"transactionType","in":"query","type":"string","required":false,"description":"Identifies the transaction type applicable to the transaction being processed, i.e. outward or inward payment. For example: ACPX, OTPX etc."},{"name":"tabView","in":"query","type":"string","required":false,"description":"Indicates the payment tab view"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"PendingAndProcessedPaymentsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/order/payments/swiftQueries","fullPath":"/api/v3.0.0/order/payments/swiftQueries","operationId":"getSwiftQueries","name":"Retrieves the list of sent swift queries","summary":"Retrieves the list of sent swift queries","tags":[],"parameters":[{"name":"entryReference","in":"query","type":"string","required":false,"description":"It is the transaction reference. This is the identifier of the transaction on Temenos Core Banking system."},{"name":"beneficiaryBank","in":"query","type":"string","required":false,"description":"Bank for the beneficiary"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"SwiftQueriesResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/order/payments/sepaPayments","fullPath":"/api/v3.0.0/order/payments/sepaPayments","operationId":"getSepaPayments","name":"Retrieves the sepa payment transactions","summary":"Retrieves the sepa payment transactions such as status, transaction amount, transaction currency, etc ","tags":[],"parameters":[{"name":"clearingId","in":"query","type":"string","required":false,"description":"Clearing channel specific details"},{"name":"originalTransactionReference","in":"query","type":"string","required":false,"description":"Identifies the Original Transaction Reference that created the Funds Authorisation request"},{"name":"transactionAmount","in":"query","type":"string","required":false,"description":"Contains the transaction amount. This is based on the currency, either local or foreign currency"},{"name":"transactionCurrency","in":"query","type":"string","required":false,"description":"Indicates the currency of the transaction. For example GBP, USD etc."},{"name":"statusCode","in":"query","type":"string","required":false,"description":"Status code, as defined by the institution"},{"name":"direction","in":"query","type":"string","required":false,"description":"Indicates the direction of the Direct debit claim for which mandate is received. The claim can be 'Outward' i.e. Claim is sent to the other bank or 'Inward'  i.e. other bank submit their claim to debi"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"SepaPaymentsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/order/payments/{paymentId}/isoCustomerPayments","fullPath":"/api/v3.0.0/order/payments/{paymentId}/isoCustomerPayments","operationId":"getIsoCustomerPayments","name":"Retrieves ISO customer payments transaction content","summary":"Retrieves ISO customer payments transaction content for a given payment","tags":[],"parameters":[{"name":"paymentId","in":"path","type":"string","required":true,"description":"Indicates the unique reference number of the payment"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"IsoCustomerPaymentsResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/order/payments/{paymentId}/isoBankPayments","fullPath":"/api/v3.0.0/order/payments/{paymentId}/isoBankPayments","operationId":"getIsoBankPayments","name":"Retrieves ISO bank payments transaction content for a given payment","summary":"Retrieves ISO bank payments transaction content for a given payment","tags":[],"parameters":[{"name":"paymentId","in":"path","type":"string","required":true,"description":"Indicates the unique reference number of the payment"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"IsoBankPaymentsResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/order/payments/swiftPayments/{swiftPaymentId}/acknowledgements","fullPath":"/api/v3.0.0/order/payments/swiftPayments/{swiftPaymentId}/acknowledgements","operationId":"updatePaymentSwiftOutTransaction","name":"Update payment status based on the acknowledgement or negative acknowledgement received from SWIFT","summary":"Update payment status based on the acknowledgement from SWIFT","tags":[],"parameters":[{"name":"swiftPaymentId","in":"path","type":"string","required":true,"description":"Contains the swift payment reference as generated by the system"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"company":"string","paymentReference":"string","statusCode":"string","paymentStatus":"string","statusChangeReason":"string","override":"string","extensionData":{}}},"responses":{"200":"PaymentSwiftOutTransactionResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}}]},{"key":"order-payments-cases-v1.0.0","title":"Case Management","version":"v1.0.0","description":"Retrieves the case management details and its related details","endpointCount":6,"endpoints":[{"method":"GET","path":"/order/payments/cases","fullPath":"/api/v1.0.0/order/payments/cases","operationId":"getPaymentsCases","name":"Retrieves all cases related to payments. Cases refer to the issues, disputes, or incidents related to payments that require further investigation or resolution. If no parameter values are supplied, all cases will be included in the output","summary":"Retrieves the list of cases related to payments","tags":["OTHERS"],"parameters":[{"name":"applicationName","in":"query","type":"string","required":false,"description":"Specifies the name of the application to be considered for erasure of details for customer data protection purposes"},{"name":"cardTypeName","in":"query","type":"string","required":false,"description":"Identifies the bank ID, if different from the Receiver, through which the Letter of Credit is to be advised/confirmed to the beneficiary."},{"name":"conditionName","in":"query","type":"string","required":false,"description":"Contains the condition name of the product condition"},{"name":"direction","in":"query","type":"string","required":false,"description":"Indicates the direction of the Direct debit claim for which mandate is received. The claim can be 'Outward' i.e. Claim is sent to the other bank or 'Inward'  i.e. other bank submit their claim to debi"},{"name":"messageType","in":"query","type":"string","required":false,"description":"Defines the type of swift messages that are sent or received for a transaction"},{"name":"clearingId","in":"query","type":"string","required":false,"description":"Clearing channel specific details"},{"name":"recordId","in":"query","type":"string","required":false,"description":"record Id name for NOFILE enquiry for online upgrade"},{"name":"relatedReference","in":"query","type":"string","required":false,"description":"An external reference id for the transaction."},{"name":"endToEndId","in":"query","type":"string","required":false,"description":"Contains the unique end to end processing chain reference of the transactions."},{"name":"cancelRequestId","in":"query","type":"string","required":false,"description":"Indicates the reference to track the initiation of payment cancellation"},{"name":"referenceId","in":"query","type":"string","required":false,"description":"Identifies the unique identifier of the activity."},{"name":"investigationCaseId","in":"query","type":"string","required":false,"description":"To unambiquously identify the case"},{"name":"UETRId","in":"query","type":"string","required":false,"description":"Unique transaction reference details for payments"},{"name":"cancellationStatus","in":"query","type":"string","required":false,"description":"Contains the current status of the payment order cancellation request"},{"name":"settlementDate","in":"query","type":"string","required":false,"description":"Indicates the settlement date of the payment transaction"},{"name":"transactionAmount","in":"query","type":"string","required":false,"description":"Contains the transaction amount. This is based on the currency, either local or foreign currency"},{"name":"transactionCurrency","in":"query","type":"string","required":false,"description":"Indicates the currency of the transaction. For example GBP, USD etc."},{"name":"debitAccount","in":"query","type":"string","required":false,"description":" Identifier of the debitAccounts."},{"name":"creditAccount","in":"query","type":"string","required":false,"description":"Identifier of the creditAccounts."},{"name":"creationDate","in":"query","type":"string","required":false,"description":"Contains the creation date."},{"name":"lastUpdateDate","in":"query","type":"string","required":false,"description":"Specifies the date of last update to the record."},{"name":"inputter","in":"query","type":"string","required":false,"description":"The user identifier who input the transaction"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"PaymentsCasesResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/order/payments/caseCategories/itemCounts","fullPath":"/api/v1.0.0/order/payments/caseCategories/itemCounts","operationId":"getPaymentsCasesCategoriesCount","name":"Retrieves the number of cases across various categories related to payments processed within the configured number of days. The various case categories are Pending Action, Pending approval, Awaiting response and Unmatched.","summary":"Retrieves the count of various payment cases grouped by status for configured number of days","tags":["OTHERS"],"parameters":[{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"PaymentsCasesCategoriesCountResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/order/payments/cases/history","fullPath":"/api/v1.0.0/order/payments/cases/history","operationId":"getPaymentsCasesHistory","name":"Retrieves the history of all cases associated with\u00c2\u00a0a specific payment","summary":"Retrieves payment case history","tags":["OTHERS"],"parameters":[{"name":"reference","in":"query","type":"string","required":false,"description":"Indicates the transaction reference for which the history of transactions is requested. It is steered by the attribute 'booked' given the start date and end date or the entry from which the history is"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"PaymentsCasesHistoryResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/order/payments/linkedPayments","fullPath":"/api/v1.0.0/order/payments/linkedPayments","operationId":"getLinkedPayments","name":"Retrieves the linked payment details of the payment referred i.e. when a transaction is referred, it will check if any return transaction is associated with the transaction and if found the return transaction details will be retrieved. Similarly if return transaction is referred then the original transaction details will be retrieved","summary":"Retrieves linked payment details of a payment","tags":["OTHERS"],"parameters":[{"name":"reference","in":"query","type":"string","required":false,"description":"Indicates the transaction reference for which the history of transactions is requested. It is steered by the attribute 'booked' given the start date and end date or the entry from which the history is"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"LinkedPaymentsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/order/payments/caseTypes","fullPath":"/api/v1.0.0/order/payments/caseTypes","operationId":"getPaymentsCaseTypes","name":"Retrieves the list of case types that can be created for the payment. Case types can be a investigation, customer cancellation, Bank cancellation, query, answer a query, claim of non-receipt, payment modification, free format message","summary":"Retrieves case types that can be created for the payment","tags":["OTHERS"],"parameters":[{"name":"reference","in":"query","type":"string","required":false,"description":"Indicates the transaction reference for which the history of transactions is requested. It is steered by the attribute 'booked' given the start date and end date or the entry from which the history is"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"PaymentsCaseTypesResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/order/payments/cases/pendingApprovals","fullPath":"/api/v1.0.0/order/payments/cases/pendingApprovals","operationId":"getPaymentsCasesPendingApprovals","name":"Retrieves the list of all unapproved cases for a\u00c2\u00a0specific payment","summary":"Retrieves unapproved cases for a specific payment","tags":["OTHERS"],"parameters":[{"name":"reference","in":"query","type":"string","required":false,"description":"Indicates the transaction reference for which the history of transactions is requested. It is steered by the attribute 'booked' given the start date and end date or the entry from which the history is"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"PaymentsCasesPendingApprovalsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}}]},{"key":"order-payments-cases-v1.1.0","title":"Case Management","version":"v1.1.0","description":"Retrieves the case management details and its related details","endpointCount":6,"endpoints":[{"method":"GET","path":"/order/payments/cases","fullPath":"/api/v1.1.0/order/payments/cases","operationId":"getPaymentsCases","name":"Retrieves all cases related to payments. Cases refer to the issues, disputes, or incidents related to payments that require further investigation or resolution. If no parameter values are supplied, all cases will be included in the output","summary":"Retrieves the list of cases related to payments","tags":["OTHERS"],"parameters":[{"name":"applicationName","in":"query","type":"string","required":false,"description":"Specifies the name of the application to be considered for erasure of details for customer data protection purposes"},{"name":"cardTypeName","in":"query","type":"string","required":false,"description":"Identifies the bank ID, if different from the Receiver, through which the Letter of Credit is to be advised/confirmed to the beneficiary."},{"name":"conditionName","in":"query","type":"string","required":false,"description":"Contains the condition name of the product condition"},{"name":"direction","in":"query","type":"string","required":false,"description":"Contains the direction of the information request. Value of 'Outward' indicates that the information request is sent by the Bank. Value of 'Inward' indicates that the request for information is receiv"},{"name":"messageType","in":"query","type":"string","required":false,"description":"Contains the message type of the information request."},{"name":"clearingId","in":"query","type":"string","required":false,"description":"Contains the identifier of the RTP scheme in case information request is for a RTP request. If the information request is for a credit transfer transaction, it contains the identifier of the clearing."},{"name":"recordId","in":"query","type":"string","required":false,"description":"record Id name for NOFILE enquiry for online upgrade"},{"name":"relatedReference","in":"query","type":"string","required":false,"description":"An external reference id for the transaction."},{"name":"endToEndId","in":"query","type":"string","required":false,"description":"Contains the unique end to end processing chain reference of the transactions."},{"name":"cancelRequestId","in":"query","type":"string","required":false,"description":"Indicates the reference to track the initiation of payment cancellation"},{"name":"referenceId","in":"query","type":"string","required":false,"description":"Identifies the unique identifier of the activity."},{"name":"investigationCaseId","in":"query","type":"string","required":false,"description":"To unambiquously identify the case"},{"name":"UETRId","in":"query","type":"string","required":false,"description":"Contains the unique end-to-end transaction reference of the underlying payment request (RTP) or credit transfer transaction for which information request is to be raised."},{"name":"cancellationStatus","in":"query","type":"string","required":false,"description":"Contains the current status of the payment order cancellation request"},{"name":"settlementDate","in":"query","type":"string","required":false,"description":"Indicates the settlement date of the payment transaction"},{"name":"transactionAmount","in":"query","type":"string","required":false,"description":"Contains the transaction amount. This is based on the currency, either local or foreign currency"},{"name":"transactionCurrency","in":"query","type":"string","required":false,"description":"Indicates the currency of the transaction. For example GBP, USD etc."},{"name":"debitAccount","in":"query","type":"string","required":false,"description":" Identifier of the debitAccounts."},{"name":"creditAccount","in":"query","type":"string","required":false,"description":"Identifier of the creditAccounts."},{"name":"creationDate","in":"query","type":"string","required":false,"description":"Contains the creation date."},{"name":"lastUpdateDate","in":"query","type":"string","required":false,"description":"Specifies the date of last update to the record."},{"name":"inputter","in":"query","type":"string","required":false,"description":"The user identifier who input the transaction"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"PaymentsCasesResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/order/payments/caseCategories/itemCounts","fullPath":"/api/v1.1.0/order/payments/caseCategories/itemCounts","operationId":"getPaymentsCasesCategoriesCount","name":"Retrieves the number of cases across various categories related to payments processed within the configured number of days. The various case categories are Pending Action, Pending approval, Awaiting response and Unmatched.","summary":"Retrieves the count of various payment cases grouped by status for configured number of days","tags":["OTHERS"],"parameters":[{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"PaymentsCasesCategoriesCountResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/order/payments/cases/history","fullPath":"/api/v1.1.0/order/payments/cases/history","operationId":"getPaymentsCasesHistory","name":"Retrieves the history of all cases associated with\u00c2\u00a0a specific payment","summary":"Retrieves payment case history","tags":["OTHERS"],"parameters":[{"name":"reference","in":"query","type":"string","required":false,"description":"Indicates the transaction reference for which the history of transactions is requested. It is steered by the attribute 'booked' given the start date and end date or the entry from which the history is"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"PaymentsCasesHistoryResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/order/payments/linkedPayments","fullPath":"/api/v1.1.0/order/payments/linkedPayments","operationId":"getLinkedPayments","name":"Retrieves the linked payment details of the payment referred i.e. when a transaction is referred, it will check if any return transaction is associated with the transaction and if found the return transaction details will be retrieved. Similarly if return transaction is referred then the original transaction details will be retrieved","summary":"Retrieves linked payment details of a payment","tags":["OTHERS"],"parameters":[{"name":"reference","in":"query","type":"string","required":false,"description":"Indicates the transaction reference for which the history of transactions is requested. It is steered by the attribute 'booked' given the start date and end date or the entry from which the history is"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"LinkedPaymentsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/order/payments/caseTypes","fullPath":"/api/v1.1.0/order/payments/caseTypes","operationId":"getPaymentsCaseTypes","name":"Retrieves the list of case types that can be created for the payment. Case types can be a investigation, customer cancellation, Bank cancellation, query, answer a query, claim of non-receipt, payment modification, free format message","summary":"Retrieves case types that can be created for the payment","tags":["OTHERS"],"parameters":[{"name":"reference","in":"query","type":"string","required":false,"description":"Indicates the transaction reference for which the history of transactions is requested. It is steered by the attribute 'booked' given the start date and end date or the entry from which the history is"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"PaymentsCaseTypesResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/order/payments/cases/pendingApprovals","fullPath":"/api/v1.1.0/order/payments/cases/pendingApprovals","operationId":"getPaymentsCasesPendingApprovals","name":"Retrieves the list of all unapproved cases for a\u00c2\u00a0specific payment","summary":"Retrieves unapproved cases for a specific payment","tags":["OTHERS"],"parameters":[{"name":"reference","in":"query","type":"string","required":false,"description":"Indicates the transaction reference for which the history of transactions is requested. It is steered by the attribute 'booked' given the start date and end date or the entry from which the history is"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"PaymentsCasesPendingApprovalsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}}]},{"key":"order-payments-cases-v1.2.0","title":"Case Management","version":"v1.2.0","description":"Retrieves the case management details and its related details","endpointCount":6,"endpoints":[{"method":"GET","path":"/order/payments/caseCategories/itemCounts","fullPath":"/api/v1.2.0/order/payments/caseCategories/itemCounts","operationId":"getPaymentsCasesCategoriesCount","name":"Retrieves the number of cases across various categories related to payments processed within the configured number of days. The various case categories are Pending Action, Pending approval, Awaiting response and Unmatched.","summary":"Retrieves the count of various payment cases grouped by status for configured number of days","tags":["OTHERS"],"parameters":[{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"PaymentsCasesCategoriesCountResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/order/payments/cases/history","fullPath":"/api/v1.2.0/order/payments/cases/history","operationId":"getPaymentsCasesHistory","name":"Retrieves the history of all cases associated with\u00c2\u00a0a specific payment","summary":"Retrieves payment case history","tags":["OTHERS"],"parameters":[{"name":"reference","in":"query","type":"string","required":false,"description":"Indicates the transaction reference for which the history of transactions is requested. It is steered by the attribute 'booked' given the start date and end date or the entry from which the history is"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"PaymentsCasesHistoryResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/order/payments/linkedPayments","fullPath":"/api/v1.2.0/order/payments/linkedPayments","operationId":"getLinkedPayments","name":"Retrieves the linked payment details of the payment referred i.e. when a transaction is referred, it will check if any return transaction is associated with the transaction and if found the return transaction details will be retrieved. Similarly if return transaction is referred then the original transaction details will be retrieved","summary":"Retrieves linked payment details of a payment","tags":["OTHERS"],"parameters":[{"name":"reference","in":"query","type":"string","required":false,"description":"Indicates the transaction reference for which the history of transactions is requested. It is steered by the attribute 'booked' given the start date and end date or the entry from which the history is"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"LinkedPaymentsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/order/payments/caseTypes","fullPath":"/api/v1.2.0/order/payments/caseTypes","operationId":"getPaymentsCaseTypes","name":"Retrieves the list of case types that can be created for the payment. Case types can be an investigation, customer cancellation, Bank cancellation, query, answer a query, claim of non-receipt, payment modification, free format message","summary":"Retrieves case types that can be created for the payment","tags":["OTHERS"],"parameters":[{"name":"reference","in":"query","type":"string","required":false,"description":"Indicates the transaction reference for which the history of transactions is requested. It is steered by the attribute 'booked' given the start date and end date or the entry from which the history is"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"PaymentsCaseTypesResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/order/payments/cases/pendingApprovals","fullPath":"/api/v1.2.0/order/payments/cases/pendingApprovals","operationId":"getPaymentsCasesPendingApprovals","name":"Retrieves the list of all unapproved cases for a\u00c2\u00a0specific payment","summary":"Retrieves unapproved cases for a specific payment","tags":["OTHERS"],"parameters":[{"name":"reference","in":"query","type":"string","required":false,"description":"Indicates the transaction reference for which the history of transactions is requested. It is steered by the attribute 'booked' given the start date and end date or the entry from which the history is"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"PaymentsCasesPendingApprovalsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/order/payments/cases","fullPath":"/api/v1.2.0/order/payments/cases","operationId":"getPaymentsCases","name":"Retrieves all cases related to payments. Cases refer to the issues, disputes, or incidents related to payments that require further investigation or resolution. If no parameter values are supplied, all cases will be included in the output","summary":"Retrieves the list of cases related to payments","tags":["OTHERS"],"parameters":[{"name":"applicationName","in":"query","type":"string","required":false,"description":"Specifies the name of the application to be considered for erasure of details for customer data protection purposes"},{"name":"cardTypeName","in":"query","type":"string","required":false,"description":"Identifies the bank ID, if different from the Receiver, through which the Letter of Credit is to be advised/confirmed to the beneficiary."},{"name":"conditionName","in":"query","type":"string","required":false,"description":"Contains the condition name of the product condition"},{"name":"direction","in":"query","type":"string","required":false,"description":"Contains the direction of the information request. Value of 'Outward' indicates that the information request is sent by the Bank. Value of 'Inward' indicates that the request for information is receiv"},{"name":"messageType","in":"query","type":"string","required":false,"description":"Contains the message type of the information request."},{"name":"clearingId","in":"query","type":"string","required":false,"description":"Contains the identifier of the RTP scheme in case information request is for a RTP request. If the information request is for a credit transfer transaction, it contains the identifier of the clearing."},{"name":"recordId","in":"query","type":"string","required":false,"description":"record Id name for NOFILE enquiry for online upgrade"},{"name":"relatedReference","in":"query","type":"string","required":false,"description":"An external reference id for the transaction."},{"name":"endToEndId","in":"query","type":"string","required":false,"description":"Contains the unique end to end processing chain reference of the transactions."},{"name":"cancelRequestId","in":"query","type":"string","required":false,"description":"Indicates the reference to track the initiation of payment cancellation"},{"name":"referenceId","in":"query","type":"string","required":false,"description":"Identifies the unique identifier of the activity."},{"name":"investigationCaseId","in":"query","type":"string","required":false,"description":"To unambiquously identify the case"},{"name":"UETRId","in":"query","type":"string","required":false,"description":"Contains the unique end-to-end transaction reference of the underlying payment request (RTP) or credit transfer transaction for which information request is to be raised."},{"name":"cancellationStatus","in":"query","type":"string","required":false,"description":"Contains the current status of the payment order cancellation request"},{"name":"settlementDate","in":"query","type":"string","required":false,"description":"Indicates the settlement date of the payment transaction"},{"name":"transactionAmount","in":"query","type":"string","required":false,"description":"Contains the transaction amount. This is based on the currency, either local or foreign currency"},{"name":"transactionCurrency","in":"query","type":"string","required":false,"description":"Indicates the currency of the transaction. For example GBP, USD etc."},{"name":"debitAccount","in":"query","type":"string","required":false,"description":" Identifier of the debitAccounts."},{"name":"creditAccount","in":"query","type":"string","required":false,"description":"Identifier of the creditAccounts."},{"name":"creationDate","in":"query","type":"string","required":false,"description":"Contains the creation date."},{"name":"lastUpdateDate","in":"query","type":"string","required":false,"description":"Specifies the date of last update to the record."},{"name":"inputter","in":"query","type":"string","required":false,"description":"The user identifier who input the transaction"},{"name":"clearingTransactionType","in":"query","type":"string","required":false,"description":"Indicates the Clearing transaction type."},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"PaymentsCasesResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}}]},{"key":"order-payments-cutoffs-v4.0.0","title":"Payments CutoffTime Monitor","version":"v4.0.0","description":"Retrieves payments list for which cutoff time is assigned and pending to be processed.","endpointCount":1,"endpoints":[{"method":"GET","path":"/order/payments/cutoffs","fullPath":"/api/v4.0.0/order/payments/cutoffs","operationId":"getPaymentCutoffs","name":"Retrieves the list of unprocessed payments count for which cutoff time is assigned and displays the payments grouped by channel, currency, direction & cutoff time that helps user to action payments on time. The possible values for statusValue are AtRisk, PaymentsinProgress, MissedCutoff.\u00c2\u00a0","summary":"Retrieves count of payments list for which cutoff time is assigned and pending to be processed.","tags":["OTHERS"],"parameters":[{"name":"company","in":"query","type":"string","required":false,"description":"The company code"},{"name":"currentWorkingDate","in":"query","type":"string","required":false,"description":"Date of the current business day for all online activities in the selected Company. This field is updated automatically with the date from 'nextWorkingDay' during the Close of Business processing."},{"name":"statusValue","in":"query","type":"string","required":false,"description":"Indicates status for which cutoff time monitor data is required. Status values are 'AtRisk', 'PaymentsinProgress' and 'MissedCutoff'"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"PaymentCutoffsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}}]},{"key":"order-payments-operationalQueueCounts-v1.0.0","title":"Operational Queue Counts","version":"v1.0.0","description":"Retrieves the number of payments that are available in operational queues","endpointCount":7,"endpoints":[{"method":"GET","path":"/order/payments/pendingApprovals/itemCounts","fullPath":"/api/v1.0.0/order/payments/pendingApprovals/itemCounts","operationId":"getPendingApprovalPaymentsCount","name":"Retrieves count of payment initiations that are waiting for approval, payments waiting for first level and second level approval of risk filter breach, payments waiting for approval hit in screening. Also retrieves count of unapproved received messages/files, received bulks in repair, received claims, future dated payments, parked payments released and parent parked payments released","summary":"Retrieves count of payments pending approval","tags":["OTHERS"],"parameters":[{"name":"alternateKey","in":"query","type":"string","required":false,"description":"Indicates the alternate identifier of transaction/contract"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"PendingApprovalPaymentsCountResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/order/payments/externalSystems/pendings/itemCounts","fullPath":"/api/v1.0.0/order/payments/externalSystems/pendings/itemCounts","operationId":"getPaymentsCountPendingExternalSystemResponse","name":"Retrieves count of payments that are pending auto-repair, pending screening request, pending balance check & reservation, pending exchange rate, parked payments pending exchange rate, waiting to be sent to clearing, cover message to be sent, pending account validation, pending funds reservation, pending cancel reservation, pending posting account entries and pending reversal account entries queues","summary":"Retrieves count of payments waiting for response from external system","tags":["OTHERS"],"parameters":[{"name":"alternateKey","in":"query","type":"string","required":false,"description":"Indicates the alternate identifier of transaction/contract"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"PaymentsCountPendingExternalSystemResponseResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/order/payments/instantAndSwift/pendings/itemCounts","fullPath":"/api/v1.0.0/order/payments/instantAndSwift/pendings/itemCounts","operationId":"getSwiftInstantsPaymentsPendingCount","name":"Retrieves count of instant payments that have timed out confirmation and SWIFT payments pending for cover & acknowledgement","summary":"Retrieves the count of pending SWIFT and instant payments","tags":["OTHERS"],"parameters":[{"name":"alternateKey","in":"query","type":"string","required":false,"description":"Indicates the alternate identifier of transaction/contract"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"SwiftInstantsPaymentsPendingCountResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/order/payments/exceptions/itemCounts","fullPath":"/api/v1.0.0/order/payments/exceptions/itemCounts","operationId":"getExceptionPaymentsCount","name":"Retrieves count of payments that are in manual repair, exceptions from SWIFT out queue, pending from SWIFT out queue, technical and business exceptions of ISO payments, unmatched cover payments, payments waiting for FX limit status update, waiting for treasury rate request, waiting in screening hit queue, clearing file level exception, clearing bulk level exception, clearing transaction level exception and received MT019","summary":"Retrieves the count of exception payments","tags":["OTHERS"],"parameters":[{"name":"alternateKey","in":"query","type":"string","required":false,"description":"Indicates the alternate identifier of transaction/contract"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"ExceptionPaymentsCountResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/order/payments/futureDatedAndParkedPayments/pendings/itemCounts","fullPath":"/api/v1.0.0/order/payments/futureDatedAndParkedPayments/pendings/itemCounts","operationId":"getFutureDatesPaymentsCount","name":"Retrieves count of payments and parent payments that are warehoused and parked","summary":"Retrieves the count of future dated and parked payments","tags":["OTHERS"],"parameters":[{"name":"alternateKey","in":"query","type":"string","required":false,"description":"Indicates the alternate identifier of transaction/contract"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"FutureDatesPaymentsCountResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/order/payments/exceptions/pendingApprovals/itemCounts","fullPath":"/api/v1.0.0/order/payments/exceptions/pendingApprovals/itemCounts","operationId":"getExceptionsPendingApprovalPaymentsCount","name":"Retrieves count of unapproved payments that are in clearing file level exception, clearing bulk level exception, clearing transaction level exception queues. Also retrieves count of payment pending approval after manual filter, repair, cancellation, return & reject, actioning ISO and SWIFTout exceptions","summary":"Retrieves the count of exception payments pending approval","tags":["OTHERS"],"parameters":[{"name":"alternateKey","in":"query","type":"string","required":false,"description":"Indicates the alternate identifier of transaction/contract"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"ExceptionsPendingApprovalPaymentsCountResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/order/payments/swift/returns/itemCounts","fullPath":"/api/v1.0.0/order/payments/swift/returns/itemCounts","operationId":"getSwiftReturnPaymentsCount","name":"Retrieves count of inward returns of redirect payments received via cover, payments settled via cover for which return can be initiated and returns & reversals of inward SWIFT MT return","summary":"Retrieves count of SWIFT return payments and SWIFT payments eligible for return","tags":["OTHERS"],"parameters":[{"name":"alternateKey","in":"query","type":"string","required":false,"description":"Indicates the alternate identifier of transaction/contract"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"SwiftReturnPaymentsCountResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}}]},{"key":"order-payments-operationalQueueListingAuthorisation-v1.0.0","title":"Operational Queue Listing Approval","version":"v1.0.0","description":"Retrieves the list of payments that are available in the approval queue.","endpointCount":23,"endpoints":[{"method":"GET","path":"/order/payments/sentFiles/transactions/pendingApprovals","fullPath":"/api/v1.0.0/order/payments/sentFiles/transactions/pendingApprovals","operationId":"getPaymentSentFilesTransactionsPendingApproval","name":"Retrieves the list of transactions modified due to clearing reject and waiting for approval","summary":"Retrieves clearing rejected payments transactions modified and waiting for approval","tags":["OTHERS"],"parameters":[{"name":"id","in":"query","type":"string","required":false,"description":"Contains the daily position class id."},{"name":"company","in":"query","type":"string","required":false,"description":"The company code"},{"name":"transactionReference","in":"query","type":"string","required":false,"description":"Contains the identifier for the transaction in the core system"},{"name":"sendersReference","in":"query","type":"string","required":false,"description":"Indicates the incoming sender's reference i.e. tag 20 of incoming SWIFT or in case when transaction is received from other system/ application, this can also indicate the reference number of that syst"},{"name":"dateTime","in":"query","type":"string","required":false,"description":"Contains the date and time separated by '-'"},{"name":"messageType","in":"query","type":"string","required":false,"description":"Defines the type of swift messages that are sent or received for a transaction"},{"name":"messageContent","in":"query","type":"string","required":false,"description":"It indicates whether only the current information or previous and current information needs to be passed to form the message."},{"name":"acknowledgementStatus","in":"query","type":"string","required":false,"description":"Contains the code for ack/nack - accepted or rejected by the clearing. For example: 0 - success acknowledegement , 1 - failure negative acknowledgement"},{"name":"acceptMessage","in":"query","type":"string","required":false,"description":"Indicates whether the account officer will accept secure message."},{"name":"message","in":"query","type":"string","required":false,"description":"The actual Transact error message "},{"name":"deliveryReference","in":"query","type":"string","required":false,"description":"Indicates the delivery reference Id generated for the activity"},{"name":"originalfilereference","in":"query","type":"string","required":false,"description":"Indicates reference of the incoming file for which response is being sent"},{"name":"bulkReference","in":"query","type":"string","required":false,"description":"Contains bulk master reference for the payment."},{"name":"reasonCode","in":"query","type":"string","required":false,"description":"Contains the code of the direct debit collection's status applicable to clearing system"},{"name":"proprietaryTransactionCode","in":"query","type":"string","required":false,"description":"Contains the proprietary bank transaction code to identify the underlying transaction."},{"name":"statusCode","in":"query","type":"string","required":false,"description":"Status code, as defined by the institution"},{"name":"clearingDate","in":"query","type":"string","required":false,"description":"Contains the date from which the payment is expected and is used to indicate the exposure date for the payment."},{"name":"action","in":"query","type":"string","required":false,"description":"Refers to view or cancel options."},{"name":"settlementDate","in":"query","type":"string","required":false,"description":"Indicates the settlement date of the payment transaction"},{"name":"sendersBic","in":"query","type":"string","required":false,"description":"Deprecated - Sender's Bic code"},{"name":"sourceType","in":"query","type":"string","required":false,"description":"Indicates source type to determine base amount. Possible values are BALANCE (base amount of a property), ACTIVITY ( transaction amount against an activity) or PROPERTY (this type is currently not supp"},{"name":"messageId","in":"query","type":"string","required":false,"description":"The holds the record key of the message ID."},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"PaymentSentFilesTransactionsPendingApprovalResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/order/payments/clearings/cancellations/pendingApprovals","fullPath":"/api/v1.0.0/order/payments/clearings/cancellations/pendingApprovals","operationId":"getPendingClearingCancellationApprovals","name":"Retrieves the list of payments that are cancelled before distribution to clearing and waiting for approval","summary":"Retrieves unapproved payments cancelled before distribution to clearing","tags":["OTHERS"],"parameters":[{"name":"clearingTransactionType","in":"query","type":"string","required":false,"description":"Indicates the Clearing transaction type."},{"name":"creditCustomerId","in":"query","type":"string","required":false,"description":"Creditor customer id details"},{"name":"customerOrBankTransfer","in":"query","type":"string","required":false,"description":"Indicates if the payment was initiated by Customer or the financial institution"},{"name":"customerSpecifiedReference","in":"query","type":"string","required":false,"description":"Deprecated - Customer specified reference"},{"name":"debitCustomerId","in":"query","type":"string","required":false,"description":"Debtor customer details"},{"name":"paymentDirection","in":"query","type":"string","required":false,"description":"Indicates the direction of payment i.e. incoming, outgoing, book or redirect"},{"name":"endToEndReference","in":"query","type":"string","required":false,"description":"Indicates the end to end reference for the payment. This field can be provided by the person who instructs the payment and this flows through the lifecycle of the payment."},{"name":"entryDateTime","in":"query","type":"string","required":false,"description":"Contains the payment creation time"},{"name":"fileSendersReference","in":"query","type":"string","required":false,"description":"Indicates the sender reference that comes from the inward payment file"},{"name":"paymentId","in":"query","type":"string","required":false,"description":"Indicates the unique reference number of the payment"},{"name":"incomingMessageType","in":"query","type":"string","required":false,"description":"Indicates the supported message type to be received from the clearing house or the direct participant."},{"name":"company","in":"query","type":"string","required":false,"description":"The company code"},{"name":"processingDate","in":"query","type":"string","required":false,"description":"The date when payment instruction is processed in system."},{"name":"partySendersReferenceIncoming","in":"query","type":"string","required":false,"description":"Debtor payment reference details of incoming"},{"name":"partySendersReferenceOutgoing","in":"query","type":"string","required":false,"description":"Debtor payment reference details of outgoing"},{"name":"statusCode","in":"query","type":"string","required":false,"description":"Status code, as defined by the institution"},{"name":"transactionAmount","in":"query","type":"string","required":false,"description":"Contains the transaction amount. This is based on the currency, either local or foreign currency"},{"name":"transactionCurrency","in":"query","type":"string","required":false,"description":"Indicates the currency of the transaction. For example GBP, USD etc."},{"name":"transactionReference","in":"query","type":"string","required":false,"description":"Contains the identifier for the transaction in the core system"},{"name":"paymentSource","in":"query","type":"string","required":false,"description":"Indicates the source from where the payment is originated"},{"name":"channel","in":"query","type":"string","required":false,"description":"Contains the channel in which the activity was performed. If pricing is not determined based on channel, then this is not significant"},{"name":"senderBankBic","in":"query","type":"string","required":false,"description":"Indicates the sending bank BIC Code"},{"name":"receiver","in":"query","type":"string","required":false,"description":"Identifies the receiver of the message"},{"name":"debtorAccountId","in":"query","type":"string","required":false,"description":"Contains the identification assigned by an institution to identify a debtor account by the account owner."},{"name":"beneficiaryAccountId","in":"query","type":"string","required":false,"description":"Unique account identifier of the beneficiary account number."},{"name":"scheme","in":"query","type":"string","required":false,"description":"Represents the scheme (a synonym for the National ID type) under which the National ID is defined"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"PendingClearingCancellationApprovalsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/order/payments/receivedFiles/pendingApprovals","fullPath":"/api/v1.0.0/order/payments/receivedFiles/pendingApprovals","operationId":"getReceivedFilesPendingApproval","name":"Retrieves the list of files modified due to mapping issue and waiting for approval","summary":"Retrieves repaired received files waiting first level approval","tags":["OTHERS"],"parameters":[{"name":"originalFileReference","in":"query","type":"string","required":false,"description":"Indicates reference of the incoming file for which response is being sent"},{"name":"queueName","in":"query","type":"string","required":false,"description":"For queue to queue configuration this field can be used to specify appropriate queue name with a prefix as CFNAME-queueName."},{"name":"receivedDateTime","in":"query","type":"string","required":false,"description":"Indicates the date and time when the request to pay message is received for payer and requestor"},{"name":"company","in":"query","type":"string","required":false,"description":"The company code"},{"name":"paymentStatus","in":"query","type":"string","required":false,"description":"Describes the current status of the payment order in the payment system"},{"name":"partyName","in":"query","type":"string","required":false,"description":"Specifies the short name of the customer in CUSTOMER.GROUP"},{"name":"partyDetail","in":"query","type":"string","required":false,"description":"Indicates the identifier for party details in which party id and party owner are defined"},{"name":"maximumBulksPerFile","in":"query","type":"string","required":false,"description":"Indicates the maximum number of bulks that can be added in a clearing file."},{"name":"inputter","in":"query","type":"string","required":false,"description":"The user identifier who input the transaction"},{"name":"recordStatus","in":"query","type":"string","required":false,"description":"General status of the record. Possible values: - null - authorised - IHLD - input, on hold - INAU - input, not authorised - INA2 - input, authorised, pending second authorisation - INAO - input, not a"},{"name":"channel","in":"query","type":"string","required":false,"description":"Contains the channel in which the activity was performed. If pricing is not determined based on channel, then this is not significant"},{"name":"optionIndicator","in":"query","type":"string","required":false,"description":"This holds the indicator of  option for the corporate action event and should be as per swift standards."},{"name":"outgoingMessageFormat","in":"query","type":"string","required":false,"description":"Indicates the format in which the outgoing message must be sent"},{"name":"paymentType","in":"query","type":"string","required":false,"description":"Indicates if the payment is Customer (C) type or Bank (B) type"},{"name":"fileName","in":"query","type":"string","required":false,"description":"Identifies the type of methods to be listed. Possible values are FX.DEAL.METHOD, BROKER or blank."},{"name":"typeIndicator","in":"query","type":"string","required":false,"description":"Indicates if the record is an Income or Expense"},{"name":"countOfRecords","in":"query","type":"string","required":false,"description":"Total count of records information for NOFILE (an enquiry does not exist in a single file) enquiry for online upgrade"},{"name":"errorCode","in":"query","type":"string","required":false,"description":"Indicates the error code which is encountered during payment processing as returned by payment system "},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"ReceivedFilesPendingApprovalResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/order/payments/swift/returns/settlements/pendingApprovals","fullPath":"/api/v1.0.0/order/payments/swift/returns/settlements/pendingApprovals","operationId":"getRetunReversalSwiftPaymentsPendingApproval","name":"Retrieves the list of return or reversal inward SWIFT MT return waiting for approval","summary":"Retrieves  SWIFT return or reversal received and awaiting approval","tags":["OTHERS"],"parameters":[{"name":"clearingTransactionType","in":"query","type":"string","required":false,"description":"Indicates the Clearing transaction type."},{"name":"creditCustomerId","in":"query","type":"string","required":false,"description":"Creditor customer id details"},{"name":"customerOrBankTransfer","in":"query","type":"string","required":false,"description":"Indicates if the payment was initiated by Customer or the financial institution"},{"name":"customerSpecifiedReference","in":"query","type":"string","required":false,"description":"Deprecated - Customer specified reference"},{"name":"debitCustomerId","in":"query","type":"string","required":false,"description":"Debtor customer details"},{"name":"paymentDirection","in":"query","type":"string","required":false,"description":"Indicates the direction of payment i.e. incoming, outgoing, book or redirect"},{"name":"endToEndReference","in":"query","type":"string","required":false,"description":"Indicates the end to end reference for the payment. This field can be provided by the person who instructs the payment and this flows through the lifecycle of the payment."},{"name":"entryDateTime","in":"query","type":"string","required":false,"description":"Contains the payment creation time"},{"name":"fileSendersReference","in":"query","type":"string","required":false,"description":"Indicates the sender reference that comes from the inward payment file"},{"name":"paymentId","in":"query","type":"string","required":false,"description":"Indicates the unique reference number of the payment"},{"name":"incomingMessageType","in":"query","type":"string","required":false,"description":"Indicates the supported message type to be received from the clearing house or the direct participant."},{"name":"company","in":"query","type":"string","required":false,"description":"The company code"},{"name":"processingDate","in":"query","type":"string","required":false,"description":"The date when payment instruction is processed in system."},{"name":"partySendersReferenceIncoming","in":"query","type":"string","required":false,"description":"Debtor payment reference details of incoming"},{"name":"partySendersReferenceOutgoing","in":"query","type":"string","required":false,"description":"Debtor payment reference details of outgoing"},{"name":"statusCode","in":"query","type":"string","required":false,"description":"Status code, as defined by the institution"},{"name":"transactionAmount","in":"query","type":"string","required":false,"description":"Contains the transaction amount. This is based on the currency, either local or foreign currency"},{"name":"transactionCurrency","in":"query","type":"string","required":false,"description":"Indicates the currency of the transaction. For example GBP, USD etc."},{"name":"transactionReference","in":"query","type":"string","required":false,"description":"Contains the identifier for the transaction in the core system"},{"name":"paymentSource","in":"query","type":"string","required":false,"description":"Indicates the source from where the payment is originated"},{"name":"channel","in":"query","type":"string","required":false,"description":"Contains the channel in which the activity was performed. If pricing is not determined based on channel, then this is not significant"},{"name":"senderBankBic","in":"query","type":"string","required":false,"description":"Indicates the sending bank BIC Code"},{"name":"receiver","in":"query","type":"string","required":false,"description":"Identifies the receiver of the message"},{"name":"debtorAccountId","in":"query","type":"string","required":false,"description":"Contains the identification assigned by an institution to identify a debtor account by the account owner."},{"name":"beneficiaryAccountId","in":"query","type":"string","required":false,"description":"Unique account identifier of the beneficiary account number."},{"name":"scheme","in":"query","type":"string","required":false,"description":"Represents the scheme (a synonym for the National ID type) under which the National ID is defined"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"RetunReversalSwiftPaymentsPendingApprovalResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/order/payments/parent/technicalExceptions/pendingApprovals","fullPath":"/api/v1.0.0/order/payments/parent/technicalExceptions/pendingApprovals","operationId":"getParentParkedPaymentsReleasedPendingApproval","name":"Retrieves the list of payments modified due to technical failure from the parked payment queue and waiting for approvals.","summary":"Retrieves the modified parent parked payments released and waiting for approvals","tags":["OTHERS"],"parameters":[{"name":"clearingTransactionType","in":"query","type":"string","required":false,"description":"Indicates the Clearing transaction type."},{"name":"creditCustomerId","in":"query","type":"string","required":false,"description":"Creditor customer id details"},{"name":"customerOrBankTransfer","in":"query","type":"string","required":false,"description":"Indicates if the payment was initiated by Customer or the financial institution"},{"name":"customerSpecifiedReference","in":"query","type":"string","required":false,"description":"Deprecated - Customer specified reference"},{"name":"debitCustomerId","in":"query","type":"string","required":false,"description":"Debtor customer details"},{"name":"paymentDirection","in":"query","type":"string","required":false,"description":"Indicates the direction of payment i.e. incoming, outgoing, book or redirect"},{"name":"endToEndReference","in":"query","type":"string","required":false,"description":"Indicates the end to end reference for the payment. This field can be provided by the person who instructs the payment and this flows through the lifecycle of the payment."},{"name":"entryDateTime","in":"query","type":"string","required":false,"description":"Contains the payment creation time"},{"name":"fileSendersReference","in":"query","type":"string","required":false,"description":"Indicates the sender reference that comes from the inward payment file"},{"name":"paymentId","in":"query","type":"string","required":false,"description":"Indicates the unique reference number of the payment"},{"name":"incomingMessageType","in":"query","type":"string","required":false,"description":"Indicates the supported message type to be received from the clearing house or the direct participant."},{"name":"company","in":"query","type":"string","required":false,"description":"The company code"},{"name":"processingDate","in":"query","type":"string","required":false,"description":"The date when payment instruction is processed in system."},{"name":"partySendersReferenceIncoming","in":"query","type":"string","required":false,"description":"Debtor payment reference details of incoming"},{"name":"partySendersReferenceOutgoing","in":"query","type":"string","required":false,"description":"Debtor payment reference details of outgoing"},{"name":"statusCode","in":"query","type":"string","required":false,"description":"Status code, as defined by the institution"},{"name":"transactionAmount","in":"query","type":"string","required":false,"description":"Contains the transaction amount. This is based on the currency, either local or foreign currency"},{"name":"transactionCurrency","in":"query","type":"string","required":false,"description":"Indicates the currency of the transaction. For example GBP, USD etc."},{"name":"transactionReference","in":"query","type":"string","required":false,"description":"Contains the identifier for the transaction in the core system"},{"name":"valueDate","in":"query","type":"string","required":false,"description":"Contains the value date of the claim or the date on which the amount to be claimed"},{"name":"paymentSource","in":"query","type":"string","required":false,"description":"Indicates the source from where the payment is originated"},{"name":"channel","in":"query","type":"string","required":false,"description":"Contains the channel in which the activity was performed. If pricing is not determined based on channel, then this is not significant"},{"name":"senderBankBic","in":"query","type":"string","required":false,"description":"Indicates the sending bank BIC Code"},{"name":"receiver","in":"query","type":"string","required":false,"description":"Identifies the receiver of the message"},{"name":"debtorAccountId","in":"query","type":"string","required":false,"description":"Contains the identification assigned by an institution to identify a debtor account by the account owner."},{"name":"beneficiaryAccountId","in":"query","type":"string","required":false,"description":"Unique account identifier of the beneficiary account number."},{"name":"scheme","in":"query","type":"string","required":false,"description":"Represents the scheme (a synonym for the National ID type) under which the National ID is defined"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"ParentParkedPaymentsReleasedPendingApprovalResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/order/payments/paymentOrders/pendingApprovals","fullPath":"/api/v1.0.0/order/payments/paymentOrders/pendingApprovals","operationId":"getPaymentOrdersPendingApproval","name":"Retrieves the list of payments submitted or repaired and waiting for approvals","summary":"Retrieves initiated/repaired payment orders that are pending approvals","tags":["OTHERS"],"parameters":[{"name":"clearingTransactionType","in":"query","type":"string","required":false,"description":"Indicates the Clearing transaction type."},{"name":"creditCustomerId","in":"query","type":"string","required":false,"description":"Creditor customer id details"},{"name":"customerOrBankTransfer","in":"query","type":"string","required":false,"description":"Indicates if the payment was initiated by Customer or the financial institution"},{"name":"customerSpecifiedReference","in":"query","type":"string","required":false,"description":"Deprecated - Customer specified reference"},{"name":"debitCustomerId","in":"query","type":"string","required":false,"description":"Debtor customer details"},{"name":"paymentDirection","in":"query","type":"string","required":false,"description":"Indicates the direction of payment i.e. incoming, outgoing, book or redirect"},{"name":"endToEndReference","in":"query","type":"string","required":false,"description":"Indicates the end to end reference for the payment. This field can be provided by the person who instructs the payment and this flows through the lifecycle of the payment."},{"name":"entryDateTime","in":"query","type":"string","required":false,"description":"Contains the payment creation time"},{"name":"fileSendersReference","in":"query","type":"string","required":false,"description":"Indicates the sender reference that comes from the inward payment file"},{"name":"paymentId","in":"query","type":"string","required":false,"description":"Indicates the unique reference number of the payment"},{"name":"paymentOrderId","in":"query","type":"string","required":false,"description":"The unique reference number of payment"},{"name":"incomingMessageType","in":"query","type":"string","required":false,"description":"Indicates the supported message type to be received from the clearing house or the direct participant."},{"name":"company","in":"query","type":"string","required":false,"description":"The company code"},{"name":"processingDate","in":"query","type":"string","required":false,"description":"The date when payment instruction is processed in system."},{"name":"partySendersReferenceIncoming","in":"query","type":"string","required":false,"description":"Debtor payment reference details of incoming"},{"name":"partySendersReferenceOutgoing","in":"query","type":"string","required":false,"description":"Debtor payment reference details of outgoing"},{"name":"statusCode","in":"query","type":"string","required":false,"description":"Status code, as defined by the institution"},{"name":"transactionAmount","in":"query","type":"string","required":false,"description":"Contains the transaction amount. This is based on the currency, either local or foreign currency"},{"name":"transactionCurrency","in":"query","type":"string","required":false,"description":"Indicates the currency of the transaction. For example GBP, USD etc."},{"name":"valueDate","in":"query","type":"string","required":false,"description":"Contains the value date of the claim or the date on which the amount to be claimed"},{"name":"transactionReference","in":"query","type":"string","required":false,"description":"Contains the identifier for the transaction in the core system"},{"name":"paymentSource","in":"query","type":"string","required":false,"description":"Indicates the source from where the payment is originated"},{"name":"channel","in":"query","type":"string","required":false,"description":"Contains the channel in which the activity was performed. If pricing is not determined based on channel, then this is not significant"},{"name":"senderBankBic","in":"query","type":"string","required":false,"description":"Indicates the sending bank BIC Code"},{"name":"receiver","in":"query","type":"string","required":false,"description":"Identifies the receiver of the message"},{"name":"debtorAccountId","in":"query","type":"string","required":false,"description":"Contains the identification assigned by an institution to identify a debtor account by the account owner."},{"name":"beneficiaryAccountId","in":"query","type":"string","required":false,"description":"Unique account identifier of the beneficiary account number."},{"name":"scheme","in":"query","type":"string","required":false,"description":"Represents the scheme (a synonym for the National ID type) under which the National ID is defined"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"PaymentOrdersPendingApprovalResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/order/payments/screenings/pendingApprovals/levelOne","fullPath":"/api/v1.0.0/order/payments/screenings/pendingApprovals/levelOne","operationId":"getReleasedScreeningRequestsPendingLeveloneAuth","name":"Retrieves the list of transactions released from the screening queue by an operator and waiting for the first level of approval.","summary":"Retrieves released screening requests waiting first level approval","tags":["OTHERS"],"parameters":[{"name":"transactionReference","in":"query","type":"string","required":false,"description":"Contains the identifier for the transaction in the core system"},{"name":"dateSent","in":"query","type":"string","required":false,"description":"The date when the message is sent."},{"name":"timeStamp","in":"query","type":"string","required":false,"description":"Deprecated - Time Stamp"},{"name":"startTimestamp","in":"query","type":"string","required":false,"description":"Contains the timestamp at which the statement period starts."},{"name":"PaymentStatus","in":"query","type":"string","required":false,"description":"Describes the current status of the payment order in the payment system"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"ReleasedScreeningRequestsPendingLeveloneAuthResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/order/payments/cancellations/pendingApprovals","fullPath":"/api/v1.0.0/order/payments/cancellations/pendingApprovals","operationId":"getReversalPaymentsPendingApproval","name":"Retrieves the list of payments cancelled by an operator and waiting for approvals","summary":"Retrieves unapproved payment cancellations","tags":["OTHERS"],"parameters":[{"name":"clearingTransactionType","in":"query","type":"string","required":false,"description":"Indicates the Clearing transaction type."},{"name":"creditCustomerId","in":"query","type":"string","required":false,"description":"Creditor customer id details"},{"name":"customerOrBankTransfer","in":"query","type":"string","required":false,"description":"Indicates if the payment was initiated by Customer or the financial institution"},{"name":"customerSpecifiedReference","in":"query","type":"string","required":false,"description":"Deprecated - Customer specified reference"},{"name":"debitCustomerId","in":"query","type":"string","required":false,"description":"Debtor customer details"},{"name":"paymentDirection","in":"query","type":"string","required":false,"description":"Indicates the direction of payment i.e. incoming, outgoing, book or redirect"},{"name":"endToEndReference","in":"query","type":"string","required":false,"description":"Indicates the end to end reference for the payment. This field can be provided by the person who instructs the payment and this flows through the lifecycle of the payment."},{"name":"entryDateTime","in":"query","type":"string","required":false,"description":"Contains the payment creation time"},{"name":"fileSendersReference","in":"query","type":"string","required":false,"description":"Indicates the sender reference that comes from the inward payment file"},{"name":"paymentId","in":"query","type":"string","required":false,"description":"Indicates the unique reference number of the payment"},{"name":"incomingMessageType","in":"query","type":"string","required":false,"description":"Indicates the supported message type to be received from the clearing house or the direct participant."},{"name":"company","in":"query","type":"string","required":false,"description":"The company code"},{"name":"processingDate","in":"query","type":"string","required":false,"description":"The date when payment instruction is processed in system."},{"name":"partySendersReferenceIncoming","in":"query","type":"string","required":false,"description":"Debtor payment reference details of incoming"},{"name":"partySendersReferenceOutgoing","in":"query","type":"string","required":false,"description":"Debtor payment reference details of outgoing"},{"name":"statusCode","in":"query","type":"string","required":false,"description":"Status code, as defined by the institution"},{"name":"transactionAmount","in":"query","type":"string","required":false,"description":"Contains the transaction amount. This is based on the currency, either local or foreign currency"},{"name":"transactionCurrency","in":"query","type":"string","required":false,"description":"Indicates the currency of the transaction. For example GBP, USD etc."},{"name":"transactionReference","in":"query","type":"string","required":false,"description":"Contains the identifier for the transaction in the core system"},{"name":"valueDate","in":"query","type":"string","required":false,"description":"Contains the value date of the claim or the date on which the amount to be claimed"},{"name":"paymentSource","in":"query","type":"string","required":false,"description":"Indicates the source from where the payment is originated"},{"name":"channel","in":"query","type":"string","required":false,"description":"Contains the channel in which the activity was performed. If pricing is not determined based on channel, then this is not significant"},{"name":"senderBankBic","in":"query","type":"string","required":false,"description":"Indicates the sending bank BIC Code"},{"name":"receiver","in":"query","type":"string","required":false,"description":"Identifies the receiver of the message"},{"name":"debtorAccountId","in":"query","type":"string","required":false,"description":"Contains the identification assigned by an institution to identify a debtor account by the account owner."},{"name":"beneficiaryAccountId","in":"query","type":"string","required":false,"description":"Unique account identifier of the beneficiary account number."},{"name":"scheme","in":"query","type":"string","required":false,"description":"Represents the scheme (a synonym for the National ID type) under which the National ID is defined"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"ReversalPaymentsPendingApprovalResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/order/payments/cover/redirects/returns/pendingApprovals","fullPath":"/api/v1.0.0/order/payments/cover/redirects/returns/pendingApprovals","operationId":"getInwardReturnRedirectCoverPaymentsPendingAuth","name":"Retrieves the list of return transactions settled via cover(redirected) which is actioned and waiting for approvals","summary":"Retrieves return transactions settled via cover(redirected) which is actioned and waiting for approvals","tags":["OTHERS"],"parameters":[{"name":"clearingTransactionType","in":"query","type":"string","required":false,"description":"Indicates the Clearing transaction type."},{"name":"creditCustomerId","in":"query","type":"string","required":false,"description":"Creditor customer id details"},{"name":"customerOrBankTransfer","in":"query","type":"string","required":false,"description":"Indicates if the payment was initiated by Customer or the financial institution"},{"name":"customerSpecifiedReference","in":"query","type":"string","required":false,"description":"Deprecated - Customer specified reference"},{"name":"debitCustomerId","in":"query","type":"string","required":false,"description":"Debtor customer details"},{"name":"paymentDirection","in":"query","type":"string","required":false,"description":"Indicates the direction of payment i.e. incoming, outgoing, book or redirect"},{"name":"endToEndReference","in":"query","type":"string","required":false,"description":"Indicates the end to end reference for the payment. This field can be provided by the person who instructs the payment and this flows through the lifecycle of the payment."},{"name":"entryDateTime","in":"query","type":"string","required":false,"description":"Contains the payment creation time"},{"name":"fileSendersReference","in":"query","type":"string","required":false,"description":"Indicates the sender reference that comes from the inward payment file"},{"name":"paymentId","in":"query","type":"string","required":false,"description":"Indicates the unique reference number of the payment"},{"name":"incomingMessageType","in":"query","type":"string","required":false,"description":"Indicates the supported message type to be received from the clearing house or the direct participant."},{"name":"company","in":"query","type":"string","required":false,"description":"The company code"},{"name":"processingDate","in":"query","type":"string","required":false,"description":"The date when payment instruction is processed in system."},{"name":"partySendersReferenceIncoming","in":"query","type":"string","required":false,"description":"Debtor payment reference details of incoming"},{"name":"partySendersReferenceOutgoing","in":"query","type":"string","required":false,"description":"Debtor payment reference details of outgoing"},{"name":"statusCode","in":"query","type":"string","required":false,"description":"Status code, as defined by the institution"},{"name":"transactionAmount","in":"query","type":"string","required":false,"description":"Contains the transaction amount. This is based on the currency, either local or foreign currency"},{"name":"transactionCurrency","in":"query","type":"string","required":false,"description":"Indicates the currency of the transaction. For example GBP, USD etc."},{"name":"transactionReference","in":"query","type":"string","required":false,"description":"Contains the identifier for the transaction in the core system"},{"name":"paymentSource","in":"query","type":"string","required":false,"description":"Indicates the source from where the payment is originated"},{"name":"channel","in":"query","type":"string","required":false,"description":"Contains the channel in which the activity was performed. If pricing is not determined based on channel, then this is not significant"},{"name":"senderBankBic","in":"query","type":"string","required":false,"description":"Indicates the sending bank BIC Code"},{"name":"receiver","in":"query","type":"string","required":false,"description":"Identifies the receiver of the message"},{"name":"debtorAccountId","in":"query","type":"string","required":false,"description":"Contains the identification assigned by an institution to identify a debtor account by the account owner."},{"name":"beneficiaryAccountId","in":"query","type":"string","required":false,"description":"Unique account identifier of the beneficiary account number."},{"name":"scheme","in":"query","type":"string","required":false,"description":"Represents the scheme (a synonym for the National ID type) under which the National ID is defined"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"InwardReturnRedirectCoverPaymentsPendingAuthResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/order/payments/claims/pendingApprovals","fullPath":"/api/v1.0.0/order/payments/claims/pendingApprovals","operationId":"getReceivedClaimsPendingApproval","name":"Retrieves SWIFT claims received that are pending for approval","summary":"Retrieves received claims","tags":["OTHERS"],"parameters":[{"name":"deliveryReference","in":"query","type":"string","required":false,"description":"Indicates the delivery reference Id generated for the activity"},{"name":"sendersReference","in":"query","type":"string","required":false,"description":"Indicates the incoming sender's reference i.e. tag 20 of incoming SWIFT or in case when transaction is received from other system/ application, this can also indicate the reference number of that syst"},{"name":"relatedReference","in":"query","type":"string","required":false,"description":"An external reference id for the transaction."},{"name":"transactionAmount","in":"query","type":"string","required":false,"description":"Contains the transaction amount. This is based on the currency, either local or foreign currency"},{"name":"orderingInstitutionAccount","in":"query","type":"string","required":false,"description":"Contains the National Clearing Code (NCC) or account number of the ordering institution."},{"name":"senderInstitutionBIC","in":"query","type":"string","required":false,"description":"Contains the bank identification code of the sender institution"},{"name":"accountWithInstitutionCode","in":"query","type":"string","required":false,"description":"Contains the Business Identifier Code (BIC) of the account with institution."},{"name":"statusCode","in":"query","type":"string","required":false,"description":"Status code, as defined by the institution"},{"name":"rejectRemark","in":"query","type":"string","required":false,"description":"Contains the remarks given for rejection."},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"ReceivedClaimsPendingApprovalResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/order/payments/cover/pendingApprovals","fullPath":"/api/v1.0.0/order/payments/cover/pendingApprovals","operationId":"getCoverPaymentsPendingApproval","name":"Retrieves announcement message that are manually matched with cover and  awaiting approval","summary":"Retrieves pending payments for cover that are awaiting approval","tags":["OTHERS"],"parameters":[{"name":"clearingTransactionType","in":"query","type":"string","required":false,"description":"Indicates the Clearing transaction type."},{"name":"creditCustomerId","in":"query","type":"string","required":false,"description":"Creditor customer id details"},{"name":"customerOrBankTransfer","in":"query","type":"string","required":false,"description":"Indicates if the payment was initiated by Customer or the financial institution"},{"name":"customerSpecifiedReference","in":"query","type":"string","required":false,"description":"Deprecated - Customer specified reference"},{"name":"debitCustomerId","in":"query","type":"string","required":false,"description":"Debtor customer details"},{"name":"paymentDirection","in":"query","type":"string","required":false,"description":"Indicates the direction of payment i.e. incoming, outgoing, book or redirect"},{"name":"endToEndReference","in":"query","type":"string","required":false,"description":"Indicates the end to end reference for the payment. This field can be provided by the person who instructs the payment and this flows through the lifecycle of the payment."},{"name":"entryDateTime","in":"query","type":"string","required":false,"description":"Contains the payment creation time"},{"name":"fileSendersReference","in":"query","type":"string","required":false,"description":"Indicates the sender reference that comes from the inward payment file"},{"name":"paymentId","in":"query","type":"string","required":false,"description":"Indicates the unique reference number of the payment"},{"name":"incomingMessageType","in":"query","type":"string","required":false,"description":"Indicates the supported message type to be received from the clearing house or the direct participant."},{"name":"company","in":"query","type":"string","required":false,"description":"The company code"},{"name":"processingDate","in":"query","type":"string","required":false,"description":"The date when payment instruction is processed in system."},{"name":"partySendersReferenceIncoming","in":"query","type":"string","required":false,"description":"Debtor payment reference details of incoming"},{"name":"partySendersReferenceOutgoing","in":"query","type":"string","required":false,"description":"Debtor payment reference details of outgoing"},{"name":"statusCode","in":"query","type":"string","required":false,"description":"Status code, as defined by the institution"},{"name":"transactionAmount","in":"query","type":"string","required":false,"description":"Contains the transaction amount. This is based on the currency, either local or foreign currency"},{"name":"transactionCurrency","in":"query","type":"string","required":false,"description":"Indicates the currency of the transaction. For example GBP, USD etc."},{"name":"transactionReference","in":"query","type":"string","required":false,"description":"Contains the identifier for the transaction in the core system"},{"name":"paymentSource","in":"query","type":"string","required":false,"description":"Indicates the source from where the payment is originated"},{"name":"channel","in":"query","type":"string","required":false,"description":"Contains the channel in which the activity was performed. If pricing is not determined based on channel, then this is not significant"},{"name":"senderBankBic","in":"query","type":"string","required":false,"description":"Indicates the sending bank BIC Code"},{"name":"receiver","in":"query","type":"string","required":false,"description":"Identifies the receiver of the message"},{"name":"debtorAccountId","in":"query","type":"string","required":false,"description":"Contains the identification assigned by an institution to identify a debtor account by the account owner."},{"name":"beneficiaryAccountId","in":"query","type":"string","required":false,"description":"Unique account identifier of the beneficiary account number."},{"name":"scheme","in":"query","type":"string","required":false,"description":"Represents the scheme (a synonym for the National ID type) under which the National ID is defined"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"CoverPaymentsPendingApprovalResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/order/payments/swift/exceptions/pendingApprovals","fullPath":"/api/v1.0.0/order/payments/swift/exceptions/pendingApprovals","operationId":"getSwiftOutExceptionPaymentsPendingApproval","name":"Retrieves outward SWIFT payments which went into exception due to reject/nacks, have been manually actioned and  awaiting approval","summary":"Retrieves modified SWIFT out exception payments awaiting approval","tags":["OTHERS"],"parameters":[{"name":"clearingTransactionType","in":"query","type":"string","required":false,"description":"Indicates the Clearing transaction type."},{"name":"creditCustomerId","in":"query","type":"string","required":false,"description":"Creditor customer id details"},{"name":"customerOrBankTransfer","in":"query","type":"string","required":false,"description":"Indicates if the payment was initiated by Customer or the financial institution"},{"name":"customerSpecifiedReference","in":"query","type":"string","required":false,"description":"Deprecated - Customer specified reference"},{"name":"debitCustomerId","in":"query","type":"string","required":false,"description":"Debtor customer details"},{"name":"paymentDirection","in":"query","type":"string","required":false,"description":"Indicates the direction of payment i.e. incoming, outgoing, book or redirect"},{"name":"endToEndReference","in":"query","type":"string","required":false,"description":"Indicates the end to end reference for the payment. This field can be provided by the person who instructs the payment and this flows through the lifecycle of the payment."},{"name":"entryDateTime","in":"query","type":"string","required":false,"description":"Contains the payment creation time"},{"name":"fileSendersReference","in":"query","type":"string","required":false,"description":"Indicates the sender reference that comes from the inward payment file"},{"name":"paymentId","in":"query","type":"string","required":false,"description":"Indicates the unique reference number of the payment"},{"name":"incomingMessageType","in":"query","type":"string","required":false,"description":"Indicates the supported message type to be received from the clearing house or the direct participant."},{"name":"company","in":"query","type":"string","required":false,"description":"The company code"},{"name":"processingDate","in":"query","type":"string","required":false,"description":"The date when payment instruction is processed in system."},{"name":"partySendersReferenceIncoming","in":"query","type":"string","required":false,"description":"Debtor payment reference details of incoming"},{"name":"partySendersReferenceOutgoing","in":"query","type":"string","required":false,"description":"Debtor payment reference details of outgoing"},{"name":"statusCode","in":"query","type":"string","required":false,"description":"Status code, as defined by the institution"},{"name":"transactionAmount","in":"query","type":"string","required":false,"description":"Contains the transaction amount. This is based on the currency, either local or foreign currency"},{"name":"transactionCurrency","in":"query","type":"string","required":false,"description":"Indicates the currency of the transaction. For example GBP, USD etc."},{"name":"transactionReference","in":"query","type":"string","required":false,"description":"Contains the identifier for the transaction in the core system"},{"name":"paymentSource","in":"query","type":"string","required":false,"description":"Indicates the source from where the payment is originated"},{"name":"channel","in":"query","type":"string","required":false,"description":"Contains the channel in which the activity was performed. If pricing is not determined based on channel, then this is not significant"},{"name":"senderBankBic","in":"query","type":"string","required":false,"description":"Indicates the sending bank BIC Code"},{"name":"receiver","in":"query","type":"string","required":false,"description":"Identifies the receiver of the message"},{"name":"debtorAccountId","in":"query","type":"string","required":false,"description":"Contains the identification assigned by an institution to identify a debtor account by the account owner."},{"name":"beneficiaryAccountId","in":"query","type":"string","required":false,"description":"Unique account identifier of the beneficiary account number."},{"name":"scheme","in":"query","type":"string","required":false,"description":"Represents the scheme (a synonym for the National ID type) under which the National ID is defined"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"SwiftOutExceptionPaymentsPendingApprovalResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/order/payments/screenings/pendingApprovals","fullPath":"/api/v1.0.0/order/payments/screenings/pendingApprovals","operationId":"getScreeningHitPaymentsPendingApproval","name":"Retrieves payments which were sent to screening, were considered a hit,  manually actioned and hence awaiting approval","summary":"Retrieves released screening hit payments that are awaiting approval","tags":["OTHERS"],"parameters":[{"name":"clearingTransactionType","in":"query","type":"string","required":false,"description":"Indicates the Clearing transaction type."},{"name":"creditCustomerId","in":"query","type":"string","required":false,"description":"Creditor customer id details"},{"name":"customerOrBankTransfer","in":"query","type":"string","required":false,"description":"Indicates if the payment was initiated by Customer or the financial institution"},{"name":"customerSpecifiedReference","in":"query","type":"string","required":false,"description":"Deprecated - Customer specified reference"},{"name":"debitCustomerId","in":"query","type":"string","required":false,"description":"Debtor customer details"},{"name":"paymentDirection","in":"query","type":"string","required":false,"description":"Indicates the direction of payment i.e. incoming, outgoing, book or redirect"},{"name":"endToEndReference","in":"query","type":"string","required":false,"description":"Indicates the end to end reference for the payment. This field can be provided by the person who instructs the payment and this flows through the lifecycle of the payment."},{"name":"entryDateTime","in":"query","type":"string","required":false,"description":"Contains the payment creation time"},{"name":"fileSendersReference","in":"query","type":"string","required":false,"description":"Indicates the sender reference that comes from the inward payment file"},{"name":"paymentId","in":"query","type":"string","required":false,"description":"Indicates the unique reference number of the payment"},{"name":"incomingMessageType","in":"query","type":"string","required":false,"description":"Indicates the supported message type to be received from the clearing house or the direct participant."},{"name":"company","in":"query","type":"string","required":false,"description":"The company code"},{"name":"processingDate","in":"query","type":"string","required":false,"description":"The date when payment instruction is processed in system."},{"name":"partySendersReferenceIncoming","in":"query","type":"string","required":false,"description":"Debtor payment reference details of incoming"},{"name":"partySendersReferenceOutgoing","in":"query","type":"string","required":false,"description":"Debtor payment reference details of outgoing"},{"name":"statusCode","in":"query","type":"string","required":false,"description":"Status code, as defined by the institution"},{"name":"transactionAmount","in":"query","type":"string","required":false,"description":"Contains the transaction amount. This is based on the currency, either local or foreign currency"},{"name":"transactionCurrency","in":"query","type":"string","required":false,"description":"Indicates the currency of the transaction. For example GBP, USD etc."},{"name":"transactionReference","in":"query","type":"string","required":false,"description":"Contains the identifier for the transaction in the core system"},{"name":"valueDate","in":"query","type":"string","required":false,"description":"Contains the value date of the claim or the date on which the amount to be claimed"},{"name":"paymentSource","in":"query","type":"string","required":false,"description":"Indicates the source from where the payment is originated"},{"name":"channel","in":"query","type":"string","required":false,"description":"Contains the channel in which the activity was performed. If pricing is not determined based on channel, then this is not significant"},{"name":"senderBankBic","in":"query","type":"string","required":false,"description":"Indicates the sending bank BIC Code"},{"name":"receiver","in":"query","type":"string","required":false,"description":"Identifies the receiver of the message"},{"name":"debtorAccountId","in":"query","type":"string","required":false,"description":"Contains the identification assigned by an institution to identify a debtor account by the account owner."},{"name":"beneficiaryAccountId","in":"query","type":"string","required":false,"description":"Unique account identifier of the beneficiary account number."},{"name":"scheme","in":"query","type":"string","required":false,"description":"Represents the scheme (a synonym for the National ID type) under which the National ID is defined"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"ScreeningHitPaymentsPendingApprovalResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/order/payments/technicalExceptions/pendingApprovals","fullPath":"/api/v1.0.0/order/payments/technicalExceptions/pendingApprovals","operationId":"getParkedPaymentsReleasedPendingApproval","name":"Retrieves payments which were parked due to technical exceptions,   manually actioned and hence awaiting approval","summary":"Retrieves the modified parked payments to release awaiting approval","tags":["OTHERS"],"parameters":[{"name":"clearingTransactionType","in":"query","type":"string","required":false,"description":"Indicates the Clearing transaction type."},{"name":"creditCustomerId","in":"query","type":"string","required":false,"description":"Creditor customer id details"},{"name":"customerOrBankTransfer","in":"query","type":"string","required":false,"description":"Indicates if the payment was initiated by Customer or the financial institution"},{"name":"customerSpecifiedReference","in":"query","type":"string","required":false,"description":"Deprecated - Customer specified reference"},{"name":"debitCustomerId","in":"query","type":"string","required":false,"description":"Debtor customer details"},{"name":"paymentDirection","in":"query","type":"string","required":false,"description":"Indicates the direction of payment i.e. incoming, outgoing, book or redirect"},{"name":"endToEndReference","in":"query","type":"string","required":false,"description":"Indicates the end to end reference for the payment. This field can be provided by the person who instructs the payment and this flows through the lifecycle of the payment."},{"name":"entryDateTime","in":"query","type":"string","required":false,"description":"Contains the payment creation time"},{"name":"fileSendersReference","in":"query","type":"string","required":false,"description":"Indicates the sender reference that comes from the inward payment file"},{"name":"paymentId","in":"query","type":"string","required":false,"description":"Indicates the unique reference number of the payment"},{"name":"incomingMessageType","in":"query","type":"string","required":false,"description":"Indicates the supported message type to be received from the clearing house or the direct participant."},{"name":"company","in":"query","type":"string","required":false,"description":"The company code"},{"name":"processingDate","in":"query","type":"string","required":false,"description":"The date when payment instruction is processed in system."},{"name":"partySendersReferenceIncoming","in":"query","type":"string","required":false,"description":"Debtor payment reference details of incoming"},{"name":"partySendersReferenceOutgoing","in":"query","type":"string","required":false,"description":"Debtor payment reference details of outgoing"},{"name":"statusCode","in":"query","type":"string","required":false,"description":"Status code, as defined by the institution"},{"name":"transactionAmount","in":"query","type":"string","required":false,"description":"Contains the transaction amount. This is based on the currency, either local or foreign currency"},{"name":"transactionCurrency","in":"query","type":"string","required":false,"description":"Indicates the currency of the transaction. For example GBP, USD etc."},{"name":"transactionReference","in":"query","type":"string","required":false,"description":"Contains the identifier for the transaction in the core system"},{"name":"valueDate","in":"query","type":"string","required":false,"description":"Contains the value date of the claim or the date on which the amount to be claimed"},{"name":"paymentSource","in":"query","type":"string","required":false,"description":"Indicates the source from where the payment is originated"},{"name":"channel","in":"query","type":"string","required":false,"description":"Contains the channel in which the activity was performed. If pricing is not determined based on channel, then this is not significant"},{"name":"senderBankBic","in":"query","type":"string","required":false,"description":"Indicates the sending bank BIC Code"},{"name":"receiver","in":"query","type":"string","required":false,"description":"Identifies the receiver of the message"},{"name":"debtorAccountId","in":"query","type":"string","required":false,"description":"Contains the identification assigned by an institution to identify a debtor account by the account owner."},{"name":"beneficiaryAccountId","in":"query","type":"string","required":false,"description":"Unique account identifier of the beneficiary account number."},{"name":"scheme","in":"query","type":"string","required":false,"description":"Represents the scheme (a synonym for the National ID type) under which the National ID is defined"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"ParkedPaymentsReleasedPendingApprovalResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/order/payments/screenings/pendingApprovals/levelTwo","fullPath":"/api/v1.0.0/order/payments/screenings/pendingApprovals/levelTwo","operationId":"getReleasedScreeningPendingLeveltwoApproval","name":"Retrieves payments which were sent to screening, were considered a hit,  manually actioned, approved once  and awaiting second level approval","summary":"Retrieves released screening requests awaiting second level approval","tags":["OTHERS"],"parameters":[{"name":"transactionReference","in":"query","type":"string","required":false,"description":"Contains the identifier for the transaction in the core system"},{"name":"dateSent","in":"query","type":"string","required":false,"description":"The date when the message is sent."},{"name":"timeStamp","in":"query","type":"string","required":false,"description":"Deprecated - Time Stamp"},{"name":"startTimestamp","in":"query","type":"string","required":false,"description":"Contains the timestamp at which the statement period starts."},{"name":"PaymentStatus","in":"query","type":"string","required":false,"description":"Describes the current status of the payment order in the payment system"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"ReleasedScreeningPendingLeveltwoApprovalResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/order/payments/swift/iso/exceptions/pendingApprovals","fullPath":"/api/v1.0.0/order/payments/swift/iso/exceptions/pendingApprovals","operationId":"getSwiftISOExceptionsPaymentsPendingApprovals","name":"Retrieves SWIFT MX payments that were sent but rejected by SWIFT and then modified to be resent. They await approval as they were manually actioned","summary":"Retrieves SWIFT MX payments modified due to rejects from SWIFT and awaiting approval","tags":["OTHERS"],"parameters":[{"name":"company","in":"query","type":"string","required":false,"description":"The company code"},{"name":"paymentId","in":"query","type":"string","required":false,"description":"Indicates the unique reference number of the payment"},{"name":"sendersReference","in":"query","type":"string","required":false,"description":"Indicates the incoming sender's reference i.e. tag 20 of incoming SWIFT or in case when transaction is received from other system/ application, this can also indicate the reference number of that syst"},{"name":"bulkReference","in":"query","type":"string","required":false,"description":"Contains bulk master reference for the payment."},{"name":"negativeAcknowledgementReason","in":"query","type":"string","required":false,"description":"Contains the  ISO reason code received in technical ack/nack messages"},{"name":"messageType","in":"query","type":"string","required":false,"description":"Defines the type of swift messages that are sent or received for a transaction"},{"name":"transactionAmount","in":"query","type":"string","required":false,"description":"Contains the transaction amount. This is based on the currency, either local or foreign currency"},{"name":"transactionCurrency","in":"query","type":"string","required":false,"description":"Indicates the currency of the transaction. For example GBP, USD etc."},{"name":"paymentMsgSentDate","in":"query","type":"string","required":false,"description":"Indicates the date on which payment message (MT103, MT202) is sent out to the receiving bank or clearing."},{"name":"errorCode","in":"query","type":"string","required":false,"description":"Indicates the error code which is encountered during payment processing as returned by payment system "},{"name":"statusCode","in":"query","type":"string","required":false,"description":"Status code, as defined by the institution"},{"name":"channel","in":"query","type":"string","required":false,"description":"Contains the channel in which the activity was performed. If pricing is not determined based on channel, then this is not significant"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"SwiftISOExceptionsPaymentsPendingApprovalsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/order/payments/futureDatedPayments/pendingApprovals","fullPath":"/api/v1.0.0/order/payments/futureDatedPayments/pendingApprovals","operationId":"getFutureDatedPaymentsPendingApproval","name":"Retrieves future dated payments which were manually released from warehouse queue and hence awaiting approval","summary":"Retrieves future dated payments released from warehouse queue and awaiting approval","tags":["OTHERS"],"parameters":[{"name":"clearingTransactionType","in":"query","type":"string","required":false,"description":"Indicates the Clearing transaction type."},{"name":"creditCustomerId","in":"query","type":"string","required":false,"description":"Creditor customer id details"},{"name":"customerOrBankTransfer","in":"query","type":"string","required":false,"description":"Indicates if the payment was initiated by Customer or the financial institution"},{"name":"customerSpecifiedReference","in":"query","type":"string","required":false,"description":"Deprecated - Customer specified reference"},{"name":"debitCustomerId","in":"query","type":"string","required":false,"description":"Debtor customer details"},{"name":"paymentDirection","in":"query","type":"string","required":false,"description":"Indicates the direction of payment i.e. incoming, outgoing, book or redirect"},{"name":"endToEndReference","in":"query","type":"string","required":false,"description":"Indicates the end to end reference for the payment. This field can be provided by the person who instructs the payment and this flows through the lifecycle of the payment."},{"name":"entryDateTime","in":"query","type":"string","required":false,"description":"Contains the payment creation time"},{"name":"fileSendersReference","in":"query","type":"string","required":false,"description":"Indicates the sender reference that comes from the inward payment file"},{"name":"paymentId","in":"query","type":"string","required":false,"description":"Indicates the unique reference number of the payment"},{"name":"paymentOrderId","in":"query","type":"string","required":false,"description":"The unique reference number of payment"},{"name":"incomingMessageType","in":"query","type":"string","required":false,"description":"Indicates the supported message type to be received from the clearing house or the direct participant."},{"name":"company","in":"query","type":"string","required":false,"description":"The company code"},{"name":"processingDate","in":"query","type":"string","required":false,"description":"The date when payment instruction is processed in system."},{"name":"partySendersReferenceIncoming","in":"query","type":"string","required":false,"description":"Debtor payment reference details of incoming"},{"name":"partySendersReferenceOutgoing","in":"query","type":"string","required":false,"description":"Debtor payment reference details of outgoing"},{"name":"statusCode","in":"query","type":"string","required":false,"description":"Status code, as defined by the institution"},{"name":"transactionAmount","in":"query","type":"string","required":false,"description":"Contains the transaction amount. This is based on the currency, either local or foreign currency"},{"name":"transactionCurrency","in":"query","type":"string","required":false,"description":"Indicates the currency of the transaction. For example GBP, USD etc."},{"name":"valueDate","in":"query","type":"string","required":false,"description":"Contains the value date of the claim or the date on which the amount to be claimed"},{"name":"transactionReference","in":"query","type":"string","required":false,"description":"Contains the identifier for the transaction in the core system"},{"name":"paymentSource","in":"query","type":"string","required":false,"description":"Indicates the source from where the payment is originated"},{"name":"channel","in":"query","type":"string","required":false,"description":"Contains the channel in which the activity was performed. If pricing is not determined based on channel, then this is not significant"},{"name":"senderBankBic","in":"query","type":"string","required":false,"description":"Indicates the sending bank BIC Code"},{"name":"receiver","in":"query","type":"string","required":false,"description":"Identifies the receiver of the message"},{"name":"debtorAccountId","in":"query","type":"string","required":false,"description":"Contains the identification assigned by an institution to identify a debtor account by the account owner."},{"name":"beneficiaryAccountId","in":"query","type":"string","required":false,"description":"Unique account identifier of the beneficiary account number."},{"name":"scheme","in":"query","type":"string","required":false,"description":"Represents the scheme (a synonym for the National ID type) under which the National ID is defined"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"FutureDatedPaymentsPendingApprovalResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/order/payments/receivedFiles/bulks/pendingApprovals","fullPath":"/api/v1.0.0/order/payments/receivedFiles/bulks/pendingApprovals","operationId":"getReceivedBulksPendingApproval","name":"Retrieves payment file received and their bulk repaired manually and hence awaiting approval","summary":"Retrieves repaired  bulks awaiting approvals","tags":["OTHERS"],"parameters":[{"name":"recordId","in":"query","type":"string","required":false,"description":"record Id name for NOFILE enquiry for online upgrade"},{"name":"company","in":"query","type":"string","required":false,"description":"The company code"},{"name":"originalFileReference","in":"query","type":"string","required":false,"description":"Indicates reference of the incoming file for which response is being sent"},{"name":"bulkReference","in":"query","type":"string","required":false,"description":"Contains bulk master reference for the payment."},{"name":"bulkFileReferenceApi","in":"query","type":"string","required":false,"description":"Indicates the API that will be invoked to derive at the bulk and file reference if the clearing has a specific requirement."},{"name":"creationDateTime","in":"query","type":"string","required":false,"description":"Date and Time of the message creation."},{"name":"bulkTypeId","in":"query","type":"string","required":false,"description":"Identifier of the bulk update type record that holds default conditions required for Bulk Master creation. SINGLE and MULTI are two record references used by payment order application for processing p"},{"name":"bulkItemId","in":"query","type":"string","required":false,"description":"contains individual payment id of the Bulk upload"},{"name":"sendersCorrespondentAddress","in":"query","type":"string","required":false,"description":"Contains additional address lines of the sender correspondent institution."},{"name":"receiversCorrespondentCountry","in":"query","type":"string","required":false,"description":"Identifies the country of the receiver's correspondent"},{"name":"numberOfTransaction","in":"query","type":"string","required":false,"description":"Indicates the number of transactions performed on the contract or the account"},{"name":"settlementAmount","in":"query","type":"string","required":false,"description":"Amount of settlement"},{"name":"settlementCurrency","in":"query","type":"string","required":false,"description":"The currency of the trade settlement"},{"name":"settlementDate","in":"query","type":"string","required":false,"description":"Indicates the settlement date of the payment transaction"},{"name":"bulkMasterId","in":"query","type":"string","required":false,"description":"Uniquely identifies each bulk payment request.The reference number is automatically generated by the system."},{"name":"bulkReferenceId","in":"query","type":"string","required":false,"description":"Contains the bulk master reference for the payment."},{"name":"errorCode","in":"query","type":"string","required":false,"description":"Indicates the error code which is encountered during payment processing as returned by payment system "},{"name":"errorInfo","in":"query","type":"string","required":false,"description":"Contains the details of the error such as error source and error message"},{"name":"batchBookingPreferred","in":"query","type":"string","required":false,"description":"If batchBookingPrefered is set to true, then bulkType is defaulted to SINGLE (Single consolidated accounting entry on the debtor account). If set to false, then bulkType is defaulted to MULTI(Individu"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"ReceivedBulksPendingApprovalResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/order/payments/riskFilters/pendingApprovals/levelTwo","fullPath":"/api/v1.0.0/order/payments/riskFilters/pendingApprovals/levelTwo","operationId":"getRiskFilterPendingLeveltwoApproval","name":"Retrieves payment which have breached counter party/currency threshold, manually released and  awaiting level two approval","summary":"Retrieves released risk filter breach payments awaiting level two approvals","tags":["OTHERS"],"parameters":[{"name":"recordId","in":"query","type":"string","required":false,"description":"record Id name for NOFILE enquiry for online upgrade"},{"name":"company","in":"query","type":"string","required":false,"description":"The company code"},{"name":"transactionReference","in":"query","type":"string","required":false,"description":"Contains the identifier for the transaction in the core system"},{"name":"filteringId","in":"query","type":"string","required":false,"description":"Indicates the filtering product of a payment. Examples: BKINCSKIP, AMTLT1000, INCOMING"},{"name":"transactionLimitAmount","in":"query","type":"string","required":false,"description":"Defines the limit amount at which each transaction will be monitored."},{"name":"breachInformation","in":"query","type":"string","required":false,"description":"Contains the information about any breach on Collateral"},{"name":"dailylimits","in":"query","type":"string","required":false,"description":"Name of the LookupsResponse Code"},{"name":"dueAmount","in":"query","type":"string","required":false,"description":"Indicates the amount which was made due for a period"},{"name":"limitAmount","in":"query","type":"string","required":false,"description":"The Limit amount that is actually available for use. The system limit checks are preformed against the online limit"},{"name":"limitExceed","in":"query","type":"string","required":false,"description":"Whether the total cash deposits or withdrawals has exceeded the threshold amount set."},{"name":"secondaryLimitAmount","in":"query","type":"string","required":false,"description":"Contains the secondary limit amount to be used for the purpose of secondary limit check"},{"name":"limitExcess","in":"query","type":"string","required":false,"description":"An indicator to show that a credit limit has been exceeded"},{"name":"cutOffDay","in":"query","type":"string","required":false,"description":"Indicates the last day for Global Payment Initiative (GPI) payments in a given currency"},{"name":"transactionAmount","in":"query","type":"string","required":false,"description":"Contains the transaction amount. This is based on the currency, either local or foreign currency"},{"name":"transactionCurrency","in":"query","type":"string","required":false,"description":"Indicates the currency of the transaction. For example GBP, USD etc."},{"name":"debitValueDate","in":"query","type":"string","required":false,"description":"Date on which the amount will be debited for settlement"},{"name":"creditValueDate","in":"query","type":"string","required":false,"description":"Reference quoted by the credit account for a payment"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"RiskFilterPendingLeveltwoApprovalResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/order/payments/riskFilters/pendingApprovals/levelOne","fullPath":"/api/v1.0.0/order/payments/riskFilters/pendingApprovals/levelOne","operationId":"getRiskFilterPendingLevelOneApproval","name":"Retrieves payment which have breached counter party/currency threshold, manually released and  awaiting level one approval","summary":"Retrieves released risk filter breach payments awaiting level one approvals","tags":["OTHERS"],"parameters":[{"name":"company","in":"query","type":"string","required":false,"description":"The company code"},{"name":"transactionReference","in":"query","type":"string","required":false,"description":"Contains the identifier for the transaction in the core system"},{"name":"transactionAmount","in":"query","type":"string","required":false,"description":"Contains the transaction amount. This is based on the currency, either local or foreign currency"},{"name":"transactionCurrency","in":"query","type":"string","required":false,"description":"Indicates the currency of the transaction. For example GBP, USD etc."},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"RiskFilterPendingLevelOneApprovalResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/order/payments/sentFiles/bulks/pendingApprovals","fullPath":"/api/v1.0.0/order/payments/sentFiles/bulks/pendingApprovals","operationId":"getPaymentSentBulksPendingApproval","name":"Retrieves bulks that were rejected and modified to be sent and are awaiting approval.","summary":"Retrieves bulks modified to be sent and awaiting approval","tags":["OTHERS"],"parameters":[{"name":"id","in":"query","type":"string","required":false,"description":"Contains the daily position class id."},{"name":"company","in":"query","type":"string","required":false,"description":"The company code"},{"name":"originalfilereference","in":"query","type":"string","required":false,"description":"Indicates reference of the incoming file for which response is being sent"},{"name":"bulkReference","in":"query","type":"string","required":false,"description":"Contains bulk master reference for the payment."},{"name":"format","in":"query","type":"string","required":false,"description":"Indicates the formatting version to be used for the delivery message"},{"name":"paymentType","in":"query","type":"string","required":false,"description":"Indicates if the payment is Customer (C) type or Bank (B) type"},{"name":"sendersCorrespondentAddress","in":"query","type":"string","required":false,"description":"Contains additional address lines of the sender correspondent institution."},{"name":"receiversCorrespondentAddress","in":"query","type":"string","required":false,"description":"Contains additional address lines of the receiver correspondent institution."},{"name":"numberOfTransaction","in":"query","type":"string","required":false,"description":"Indicates the number of transactions performed on the contract or the account"},{"name":"settlementAmount","in":"query","type":"string","required":false,"description":"Amount of settlement"},{"name":"settlementCurrency","in":"query","type":"string","required":false,"description":"The currency of the trade settlement"},{"name":"settlementDate","in":"query","type":"string","required":false,"description":"Indicates the settlement date of the payment transaction"},{"name":"status","in":"query","type":"string","required":false,"description":"The status of the early maturity request"},{"name":"bulkReferenceId","in":"query","type":"string","required":false,"description":"Contains the bulk master reference for the payment."},{"name":"reasonCode","in":"query","type":"string","required":false,"description":"Contains the code of the direct debit collection's status applicable to clearing system"},{"name":"proprietaryTransactionCode","in":"query","type":"string","required":false,"description":"Contains the proprietary bank transaction code to identify the underlying transaction."},{"name":"statusCode","in":"query","type":"string","required":false,"description":"Status code, as defined by the institution"},{"name":"dateTime","in":"query","type":"string","required":false,"description":"Contains the date and time separated by '-'"},{"name":"action","in":"query","type":"string","required":false,"description":"Refers to view or cancel options."},{"name":"sourceType","in":"query","type":"string","required":false,"description":"Indicates source type to determine base amount. Possible values are BALANCE (base amount of a property), ACTIVITY ( transaction amount against an activity) or PROPERTY (this type is currently not supp"},{"name":"coverControl","in":"query","type":"string","required":false,"description":"Indicates whether the limit is applicable for the virtual accounts or not"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"PaymentSentBulksPendingApprovalResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/order/payments/sentFiles/files/pendingApprovals","fullPath":"/api/v1.0.0/order/payments/sentFiles/files/pendingApprovals","operationId":"getPaymentSentFilesPendingApproval","name":"Retrieves files that were rejected and  modified to be sent and are  awaiting approval","summary":"Retrieves files modified to be sent and awaiting approval","tags":["OTHERS"],"parameters":[{"name":"id","in":"query","type":"string","required":false,"description":"Contains the daily position class id."},{"name":"company","in":"query","type":"string","required":false,"description":"The company code"},{"name":"fileSendersReference","in":"query","type":"string","required":false,"description":"Indicates the sender reference that comes from the inward payment file"},{"name":"dateSent","in":"query","type":"string","required":false,"description":"The date when the message is sent."},{"name":"fileName","in":"query","type":"string","required":false,"description":"Identifies the type of methods to be listed. Possible values are FX.DEAL.METHOD, BROKER or blank."},{"name":"type","in":"query","type":"string","required":false,"description":"The product condition has an activity type associated that drives an action."},{"name":"typeIndicator","in":"query","type":"string","required":false,"description":"Indicates if the record is an Income or Expense"},{"name":"outputChannel","in":"query","type":"string","required":false,"description":"Contains the channel that will be used to send the outward payment message"},{"name":"creationDateTime","in":"query","type":"string","required":false,"description":"Date and Time of the message creation."},{"name":"status","in":"query","type":"string","required":false,"description":"The status of the early maturity request"},{"name":"numberOfTransaction","in":"query","type":"string","required":false,"description":"Indicates the number of transactions performed on the contract or the account"},{"name":"clearingStatus","in":"query","type":"string","required":false,"description":"Indicates if the status of the Clearing is Active, temporarily suspended or is altogether blocked."},{"name":"reasonCode","in":"query","type":"string","required":false,"description":"Contains the code of the direct debit collection's status applicable to clearing system"},{"name":"statusCode","in":"query","type":"string","required":false,"description":"Status code, as defined by the institution"},{"name":"dateTime","in":"query","type":"string","required":false,"description":"Contains the date and time separated by '-'"},{"name":"originalfilereference","in":"query","type":"string","required":false,"description":"Indicates reference of the incoming file for which response is being sent"},{"name":"sourceType","in":"query","type":"string","required":false,"description":"Indicates source type to determine base amount. Possible values are BALANCE (base amount of a property), ACTIVITY ( transaction amount against an activity) or PROPERTY (this type is currently not supp"},{"name":"clearingDate","in":"query","type":"string","required":false,"description":"Contains the date from which the payment is expected and is used to indicate the exposure date for the payment."},{"name":"receiversCorrespondentAddress","in":"query","type":"string","required":false,"description":"Contains additional address lines of the receiver correspondent institution."},{"name":"errorInfo","in":"query","type":"string","required":false,"description":"Contains the details of the error such as error source and error message"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"PaymentSentFilesPendingApprovalResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/order/payments/swift/returns/pendingApprovals","fullPath":"/api/v1.0.0/order/payments/swift/returns/pendingApprovals","operationId":"getReturnSettledSwiftPaymentsPendingApproval","name":"Retrieves the list of SWIFT return trasaction and awaiting approval","summary":"Retrieves returns of completed SWIFT transactions  that are awaiting approval","tags":["OTHERS"],"parameters":[{"name":"clearingTransactionType","in":"query","type":"string","required":false,"description":"Indicates the Clearing transaction type."},{"name":"creditCustomerId","in":"query","type":"string","required":false,"description":"Creditor customer id details"},{"name":"customerOrBankTransfer","in":"query","type":"string","required":false,"description":"Indicates if the payment was initiated by Customer or the financial institution"},{"name":"customerSpecifiedReference","in":"query","type":"string","required":false,"description":"Deprecated - Customer specified reference"},{"name":"debitCustomerId","in":"query","type":"string","required":false,"description":"Debtor customer details"},{"name":"paymentDirection","in":"query","type":"string","required":false,"description":"Indicates the direction of payment i.e. incoming, outgoing, book or redirect"},{"name":"endToEndReference","in":"query","type":"string","required":false,"description":"Indicates the end to end reference for the payment. This field can be provided by the person who instructs the payment and this flows through the lifecycle of the payment."},{"name":"entryDateTime","in":"query","type":"string","required":false,"description":"Contains the payment creation time"},{"name":"fileSendersReference","in":"query","type":"string","required":false,"description":"Indicates the sender reference that comes from the inward payment file"},{"name":"paymentId","in":"query","type":"string","required":false,"description":"Indicates the unique reference number of the payment"},{"name":"incomingMessageType","in":"query","type":"string","required":false,"description":"Indicates the supported message type to be received from the clearing house or the direct participant."},{"name":"company","in":"query","type":"string","required":false,"description":"The company code"},{"name":"processingDate","in":"query","type":"string","required":false,"description":"The date when payment instruction is processed in system."},{"name":"partySendersReferenceIncoming","in":"query","type":"string","required":false,"description":"Debtor payment reference details of incoming"},{"name":"partySendersReferenceOutgoing","in":"query","type":"string","required":false,"description":"Debtor payment reference details of outgoing"},{"name":"statusCode","in":"query","type":"string","required":false,"description":"Status code, as defined by the institution"},{"name":"transactionAmount","in":"query","type":"string","required":false,"description":"Contains the transaction amount. This is based on the currency, either local or foreign currency"},{"name":"transactionCurrency","in":"query","type":"string","required":false,"description":"Indicates the currency of the transaction. For example GBP, USD etc."},{"name":"transactionReference","in":"query","type":"string","required":false,"description":"Contains the identifier for the transaction in the core system"},{"name":"paymentSource","in":"query","type":"string","required":false,"description":"Indicates the source from where the payment is originated"},{"name":"channel","in":"query","type":"string","required":false,"description":"Contains the channel in which the activity was performed. If pricing is not determined based on channel, then this is not significant"},{"name":"senderBankBic","in":"query","type":"string","required":false,"description":"Indicates the sending bank BIC Code"},{"name":"receiver","in":"query","type":"string","required":false,"description":"Identifies the receiver of the message"},{"name":"debtorAccountId","in":"query","type":"string","required":false,"description":"Contains the identification assigned by an institution to identify a debtor account by the account owner."},{"name":"beneficiaryAccountId","in":"query","type":"string","required":false,"description":"Unique account identifier of the beneficiary account number."},{"name":"scheme","in":"query","type":"string","required":false,"description":"Represents the scheme (a synonym for the National ID type) under which the National ID is defined"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"ReturnSettledSwiftPaymentsPendingApprovalResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}}]},{"key":"order-payments-operationalQueueListingAuthorisation-v1.1.0","title":"Operational Queue Listing Approval","version":"v1.1.0","description":"Retrieves the list of payments that are available in the approval queue.","endpointCount":23,"endpoints":[{"method":"GET","path":"/order/payments/sentFiles/transactions/pendingApprovals","fullPath":"/api/v1.1.0/order/payments/sentFiles/transactions/pendingApprovals","operationId":"getPaymentSentFilesTransactionsPendingApproval","name":"Retrieves the list of transactions modified due to clearing reject and waiting for approval","summary":"Retrieves clearing rejected payments transactions modified and waiting for approval","tags":["OTHERS"],"parameters":[{"name":"id","in":"query","type":"string","required":false,"description":"Contains the daily position class id."},{"name":"company","in":"query","type":"string","required":false,"description":"The company code"},{"name":"transactionReference","in":"query","type":"string","required":false,"description":"Contains the identifier for the transaction in the core system"},{"name":"sendersReference","in":"query","type":"string","required":false,"description":"Indicates the incoming sender's reference i.e. tag 20 of incoming SWIFT or in case when transaction is received from other system/ application, this can also indicate the reference number of that syst"},{"name":"dateTime","in":"query","type":"string","required":false,"description":"Contains the date and time separated by '-'"},{"name":"messageType","in":"query","type":"string","required":false,"description":"Contains the message type of the information request."},{"name":"messageContent","in":"query","type":"string","required":false,"description":"It indicates whether only the current information or previous and current information needs to be passed to form the message."},{"name":"acknowledgementStatus","in":"query","type":"string","required":false,"description":"Contains the code for ack/nack - accepted or rejected by the clearing. For example: 0 - success acknowledegement , 1 - failure negative acknowledgement"},{"name":"acceptMessage","in":"query","type":"string","required":false,"description":"Indicates whether the account officer will accept secure message."},{"name":"message","in":"query","type":"string","required":false,"description":"The actual Transact error message "},{"name":"deliveryReference","in":"query","type":"string","required":false,"description":"Indicates the delivery reference Id generated for the activity"},{"name":"originalFileReference","in":"query","type":"string","required":false,"description":"Indicates reference of the incoming file for which response is being sent"},{"name":"bulkReference","in":"query","type":"string","required":false,"description":"Contains bulk master reference for the payment."},{"name":"reasonCode","in":"query","type":"string","required":false,"description":"Contains the reason for raising the information request in a coded form."},{"name":"proprietaryTransactionCode","in":"query","type":"string","required":false,"description":"Contains the proprietary bank transaction code to identify the underlying transaction."},{"name":"statusCode","in":"query","type":"string","required":false,"description":"Status code, as defined by the institution"},{"name":"clearingDate","in":"query","type":"string","required":false,"description":"Contains the date from which the payment is expected and is used to indicate the exposure date for the payment."},{"name":"action","in":"query","type":"string","required":false,"description":"Refers to view or cancel options."},{"name":"settlementDate","in":"query","type":"string","required":false,"description":"Indicates the settlement date of the payment transaction"},{"name":"sendersBic","in":"query","type":"string","required":false,"description":"Deprecated - Sender's Bic code"},{"name":"sourceType","in":"query","type":"string","required":false,"description":"Indicates source type to determine base amount. Possible values are BALANCE (base amount of a property), ACTIVITY ( transaction amount against an activity) or PROPERTY (this type is currently not supp"},{"name":"messageId","in":"query","type":"string","required":false,"description":"The holds the record key of the message ID."},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"PaymentSentFilesTransactionsPendingApprovalResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/order/payments/clearings/cancellations/pendingApprovals","fullPath":"/api/v1.1.0/order/payments/clearings/cancellations/pendingApprovals","operationId":"getPendingClearingCancellationApprovals","name":"Retrieves the list of payments that are cancelled before distribution to clearing and waiting for approval","summary":"Retrieves unapproved payments cancelled before distribution to clearing","tags":["OTHERS"],"parameters":[{"name":"clearingTransactionType","in":"query","type":"string","required":false,"description":"Indicates the Clearing transaction type."},{"name":"creditCustomerId","in":"query","type":"string","required":false,"description":"Creditor customer id details"},{"name":"customerOrBankTransfer","in":"query","type":"string","required":false,"description":"Indicates if the payment was initiated by Customer or the financial institution"},{"name":"customerSpecifiedReference","in":"query","type":"string","required":false,"description":"Deprecated - Customer specified reference"},{"name":"debitCustomerId","in":"query","type":"string","required":false,"description":"Debtor customer details"},{"name":"paymentDirection","in":"query","type":"string","required":false,"description":"Indicates the direction of payment i.e. incoming, outgoing, book or redirect"},{"name":"endToEndReference","in":"query","type":"string","required":false,"description":"Indicates the end to end reference for the payment. This field can be provided by the person who instructs the payment and this flows through the lifecycle of the payment."},{"name":"entryDateTime","in":"query","type":"string","required":false,"description":"Contains the payment creation time"},{"name":"fileSendersReference","in":"query","type":"string","required":false,"description":"Indicates the sender reference that comes from the inward payment file"},{"name":"paymentId","in":"query","type":"string","required":false,"description":"Indicates the unique reference number of the payment"},{"name":"incomingMessageType","in":"query","type":"string","required":false,"description":"Indicates the supported message type to be received from the clearing house or the direct participant."},{"name":"company","in":"query","type":"string","required":false,"description":"The company code"},{"name":"processingDate","in":"query","type":"string","required":false,"description":"The date when payment instruction is processed in system."},{"name":"partySendersReferenceIncoming","in":"query","type":"string","required":false,"description":"Debtor payment reference details of incoming"},{"name":"partySendersReferenceOutgoing","in":"query","type":"string","required":false,"description":"Debtor payment reference details of outgoing"},{"name":"statusCode","in":"query","type":"string","required":false,"description":"Status code, as defined by the institution"},{"name":"transactionAmount","in":"query","type":"string","required":false,"description":"Contains the transaction amount. This is based on the currency, either local or foreign currency"},{"name":"transactionCurrency","in":"query","type":"string","required":false,"description":"Indicates the currency of the transaction. For example GBP, USD etc."},{"name":"transactionReference","in":"query","type":"string","required":false,"description":"Contains the identifier for the transaction in the core system"},{"name":"paymentSource","in":"query","type":"string","required":false,"description":"Indicates the source from where the payment is originated"},{"name":"channel","in":"query","type":"string","required":false,"description":"Contains the channel in which the activity was performed. If pricing is not determined based on channel, then this is not significant"},{"name":"senderBankBic","in":"query","type":"string","required":false,"description":"Indicates the sending bank BIC Code"},{"name":"receiver","in":"query","type":"string","required":false,"description":"Identifies the receiver of the message"},{"name":"debtorAccountId","in":"query","type":"string","required":false,"description":"Contains the identification assigned by an institution to identify a debtor account by the account owner."},{"name":"beneficiaryAccountId","in":"query","type":"string","required":false,"description":"Unique account identifier of the beneficiary account number."},{"name":"scheme","in":"query","type":"string","required":false,"description":"Represents the scheme (a synonym for the National ID type) under which the National ID is defined"},{"name":"valueDate","in":"query","type":"string","required":false,"description":"Contains the value date of the claim or the date on which the amount to be claimed"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"PendingClearingCancellationApprovalsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/order/payments/receivedFiles/pendingApprovals","fullPath":"/api/v1.1.0/order/payments/receivedFiles/pendingApprovals","operationId":"getReceivedFilesPendingApproval","name":"Retrieves the list of files modified due to mapping issue and waiting for approval","summary":"Retrieves repaired received files waiting first level approval","tags":["OTHERS"],"parameters":[{"name":"originalFileReference","in":"query","type":"string","required":false,"description":"Indicates reference of the incoming file for which response is being sent"},{"name":"queueName","in":"query","type":"string","required":false,"description":"For queue to queue configuration this field can be used to specify appropriate queue name with a prefix as CFNAME-queueName."},{"name":"receivedDateTime","in":"query","type":"string","required":false,"description":"Indicates the date and time when the request to pay message is received for payer and requestor"},{"name":"company","in":"query","type":"string","required":false,"description":"The company code"},{"name":"paymentStatus","in":"query","type":"string","required":false,"description":"Describes the current status of the payment order in the payment system"},{"name":"partyName","in":"query","type":"string","required":false,"description":"Specifies the short name of the customer in CUSTOMER.GROUP"},{"name":"partyDetail","in":"query","type":"string","required":false,"description":"Indicates the identifier for party details in which party id and party owner are defined"},{"name":"maximumBulksPerFile","in":"query","type":"string","required":false,"description":"Indicates the maximum number of bulks that can be added in a clearing file."},{"name":"inputter","in":"query","type":"string","required":false,"description":"The user identifier who input the transaction"},{"name":"recordStatus","in":"query","type":"string","required":false,"description":"General status of the record. Possible values: - null - authorised - IHLD - input, on hold - INAU - input, not authorised - INA2 - input, authorised, pending second authorisation - INAO - input, not a"},{"name":"channel","in":"query","type":"string","required":false,"description":"Contains the channel in which the activity was performed. If pricing is not determined based on channel, then this is not significant"},{"name":"optionIndicator","in":"query","type":"string","required":false,"description":"This holds the indicator of  option for the corporate action event and should be as per swift standards."},{"name":"outgoingMessageFormat","in":"query","type":"string","required":false,"description":"Indicates the format in which the outgoing message must be sent"},{"name":"paymentType","in":"query","type":"string","required":false,"description":"Indicates if the payment is Customer (C) type or Bank (B) type"},{"name":"fileName","in":"query","type":"string","required":false,"description":"Identifies the type of methods to be listed. Possible values are FX.DEAL.METHOD, BROKER or blank."},{"name":"typeIndicator","in":"query","type":"string","required":false,"description":"Indicates if the record is an Income or Expense"},{"name":"countOfRecords","in":"query","type":"string","required":false,"description":"Total count of records information for NOFILE (an enquiry does not exist in a single file) enquiry for online upgrade"},{"name":"errorCode","in":"query","type":"string","required":false,"description":"Indicates the error code which is encountered during payment processing as returned by payment system "},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"ReceivedFilesPendingApprovalResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/order/payments/swift/returns/settlements/pendingApprovals","fullPath":"/api/v1.1.0/order/payments/swift/returns/settlements/pendingApprovals","operationId":"getRetunReversalSwiftPaymentsPendingApproval","name":"Retrieves the list of return or reversal inward SWIFT MT return waiting for approval","summary":"Retrieves  SWIFT return or reversal received and awaiting approval","tags":["OTHERS"],"parameters":[{"name":"clearingTransactionType","in":"query","type":"string","required":false,"description":"Indicates the Clearing transaction type."},{"name":"creditCustomerId","in":"query","type":"string","required":false,"description":"Creditor customer id details"},{"name":"customerOrBankTransfer","in":"query","type":"string","required":false,"description":"Indicates if the payment was initiated by Customer or the financial institution"},{"name":"customerSpecifiedReference","in":"query","type":"string","required":false,"description":"Deprecated - Customer specified reference"},{"name":"debitCustomerId","in":"query","type":"string","required":false,"description":"Debtor customer details"},{"name":"paymentDirection","in":"query","type":"string","required":false,"description":"Indicates the direction of payment i.e. incoming, outgoing, book or redirect"},{"name":"endToEndReference","in":"query","type":"string","required":false,"description":"Indicates the end to end reference for the payment. This field can be provided by the person who instructs the payment and this flows through the lifecycle of the payment."},{"name":"entryDateTime","in":"query","type":"string","required":false,"description":"Contains the payment creation time"},{"name":"fileSendersReference","in":"query","type":"string","required":false,"description":"Indicates the sender reference that comes from the inward payment file"},{"name":"paymentId","in":"query","type":"string","required":false,"description":"Indicates the unique reference number of the payment"},{"name":"incomingMessageType","in":"query","type":"string","required":false,"description":"Indicates the supported message type to be received from the clearing house or the direct participant."},{"name":"company","in":"query","type":"string","required":false,"description":"The company code"},{"name":"processingDate","in":"query","type":"string","required":false,"description":"The date when payment instruction is processed in system."},{"name":"partySendersReferenceIncoming","in":"query","type":"string","required":false,"description":"Debtor payment reference details of incoming"},{"name":"partySendersReferenceOutgoing","in":"query","type":"string","required":false,"description":"Debtor payment reference details of outgoing"},{"name":"statusCode","in":"query","type":"string","required":false,"description":"Status code, as defined by the institution"},{"name":"transactionAmount","in":"query","type":"string","required":false,"description":"Contains the transaction amount. This is based on the currency, either local or foreign currency"},{"name":"transactionCurrency","in":"query","type":"string","required":false,"description":"Indicates the currency of the transaction. For example GBP, USD etc."},{"name":"transactionReference","in":"query","type":"string","required":false,"description":"Contains the identifier for the transaction in the core system"},{"name":"paymentSource","in":"query","type":"string","required":false,"description":"Indicates the source from where the payment is originated"},{"name":"channel","in":"query","type":"string","required":false,"description":"Contains the channel in which the activity was performed. If pricing is not determined based on channel, then this is not significant"},{"name":"senderBankBic","in":"query","type":"string","required":false,"description":"Indicates the sending bank BIC Code"},{"name":"receiver","in":"query","type":"string","required":false,"description":"Identifies the receiver of the message"},{"name":"debtorAccountId","in":"query","type":"string","required":false,"description":"Contains the identification assigned by an institution to identify a debtor account by the account owner."},{"name":"beneficiaryAccountId","in":"query","type":"string","required":false,"description":"Unique account identifier of the beneficiary account number."},{"name":"scheme","in":"query","type":"string","required":false,"description":"Represents the scheme (a synonym for the National ID type) under which the National ID is defined"},{"name":"valueDate","in":"query","type":"string","required":false,"description":"Contains the value date of the claim or the date on which the amount to be claimed"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"RetunReversalSwiftPaymentsPendingApprovalResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/order/payments/parent/technicalExceptions/pendingApprovals","fullPath":"/api/v1.1.0/order/payments/parent/technicalExceptions/pendingApprovals","operationId":"getParentParkedPaymentsReleasedPendingApproval","name":"Retrieves the list of payments modified due to technical failure from the parked payment queue and waiting for approvals.","summary":"Retrieves the modified parent parked payments released and waiting for approvals","tags":["OTHERS"],"parameters":[{"name":"clearingTransactionType","in":"query","type":"string","required":false,"description":"Indicates the Clearing transaction type."},{"name":"creditCustomerId","in":"query","type":"string","required":false,"description":"Creditor customer id details"},{"name":"customerOrBankTransfer","in":"query","type":"string","required":false,"description":"Indicates if the payment was initiated by Customer or the financial institution"},{"name":"customerSpecifiedReference","in":"query","type":"string","required":false,"description":"Deprecated - Customer specified reference"},{"name":"debitCustomerId","in":"query","type":"string","required":false,"description":"Debtor customer details"},{"name":"paymentDirection","in":"query","type":"string","required":false,"description":"Indicates the direction of payment i.e. incoming, outgoing, book or redirect"},{"name":"endToEndReference","in":"query","type":"string","required":false,"description":"Indicates the end to end reference for the payment. This field can be provided by the person who instructs the payment and this flows through the lifecycle of the payment."},{"name":"entryDateTime","in":"query","type":"string","required":false,"description":"Contains the payment creation time"},{"name":"fileSendersReference","in":"query","type":"string","required":false,"description":"Indicates the sender reference that comes from the inward payment file"},{"name":"paymentId","in":"query","type":"string","required":false,"description":"Indicates the unique reference number of the payment"},{"name":"incomingMessageType","in":"query","type":"string","required":false,"description":"Indicates the supported message type to be received from the clearing house or the direct participant."},{"name":"company","in":"query","type":"string","required":false,"description":"The company code"},{"name":"processingDate","in":"query","type":"string","required":false,"description":"The date when payment instruction is processed in system."},{"name":"partySendersReferenceIncoming","in":"query","type":"string","required":false,"description":"Debtor payment reference details of incoming"},{"name":"partySendersReferenceOutgoing","in":"query","type":"string","required":false,"description":"Debtor payment reference details of outgoing"},{"name":"statusCode","in":"query","type":"string","required":false,"description":"Status code, as defined by the institution"},{"name":"transactionAmount","in":"query","type":"string","required":false,"description":"Contains the transaction amount. This is based on the currency, either local or foreign currency"},{"name":"transactionCurrency","in":"query","type":"string","required":false,"description":"Indicates the currency of the transaction. For example GBP, USD etc."},{"name":"transactionReference","in":"query","type":"string","required":false,"description":"Contains the identifier for the transaction in the core system"},{"name":"valueDate","in":"query","type":"string","required":false,"description":"Contains the value date of the claim or the date on which the amount to be claimed"},{"name":"paymentSource","in":"query","type":"string","required":false,"description":"Indicates the source from where the payment is originated"},{"name":"channel","in":"query","type":"string","required":false,"description":"Contains the channel in which the activity was performed. If pricing is not determined based on channel, then this is not significant"},{"name":"senderBankBic","in":"query","type":"string","required":false,"description":"Indicates the sending bank BIC Code"},{"name":"receiver","in":"query","type":"string","required":false,"description":"Identifies the receiver of the message"},{"name":"debtorAccountId","in":"query","type":"string","required":false,"description":"Contains the identification assigned by an institution to identify a debtor account by the account owner."},{"name":"beneficiaryAccountId","in":"query","type":"string","required":false,"description":"Unique account identifier of the beneficiary account number."},{"name":"scheme","in":"query","type":"string","required":false,"description":"Represents the scheme (a synonym for the National ID type) under which the National ID is defined"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"ParentParkedPaymentsReleasedPendingApprovalResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/order/payments/paymentOrders/pendingApprovals","fullPath":"/api/v1.1.0/order/payments/paymentOrders/pendingApprovals","operationId":"getPaymentOrdersPendingApproval","name":"Retrieves the list of payments submitted or repaired and waiting for approvals","summary":"Retrieves initiated/repaired payment orders that are pending approvals","tags":["OTHERS"],"parameters":[{"name":"clearingTransactionType","in":"query","type":"string","required":false,"description":"Indicates the Clearing transaction type."},{"name":"creditCustomerId","in":"query","type":"string","required":false,"description":"Creditor customer id details"},{"name":"customerOrBankTransfer","in":"query","type":"string","required":false,"description":"Indicates if the payment was initiated by Customer or the financial institution"},{"name":"customerSpecifiedReference","in":"query","type":"string","required":false,"description":"Deprecated - Customer specified reference"},{"name":"debitCustomerId","in":"query","type":"string","required":false,"description":"Debtor customer details"},{"name":"paymentDirection","in":"query","type":"string","required":false,"description":"Indicates the direction of payment i.e. incoming, outgoing, book or redirect"},{"name":"endToEndReference","in":"query","type":"string","required":false,"description":"Indicates the end to end reference for the payment. This field can be provided by the person who instructs the payment and this flows through the lifecycle of the payment."},{"name":"entryDateTime","in":"query","type":"string","required":false,"description":"Contains the payment creation time"},{"name":"fileSendersReference","in":"query","type":"string","required":false,"description":"Indicates the sender reference that comes from the inward payment file"},{"name":"paymentId","in":"query","type":"string","required":false,"description":"Indicates the unique reference number of the payment"},{"name":"paymentOrderId","in":"query","type":"string","required":false,"description":"The unique reference number of payment"},{"name":"incomingMessageType","in":"query","type":"string","required":false,"description":"Indicates the supported message type to be received from the clearing house or the direct participant."},{"name":"company","in":"query","type":"string","required":false,"description":"The company code"},{"name":"processingDate","in":"query","type":"string","required":false,"description":"The date when payment instruction is processed in system."},{"name":"partySendersReferenceIncoming","in":"query","type":"string","required":false,"description":"Debtor payment reference details of incoming"},{"name":"partySendersReferenceOutgoing","in":"query","type":"string","required":false,"description":"Debtor payment reference details of outgoing"},{"name":"statusCode","in":"query","type":"string","required":false,"description":"Status code, as defined by the institution"},{"name":"transactionAmount","in":"query","type":"string","required":false,"description":"Contains the transaction amount. This is based on the currency, either local or foreign currency"},{"name":"transactionCurrency","in":"query","type":"string","required":false,"description":"Indicates the currency of the transaction. For example GBP, USD etc."},{"name":"valueDate","in":"query","type":"string","required":false,"description":"Contains the value date of the claim or the date on which the amount to be claimed"},{"name":"transactionReference","in":"query","type":"string","required":false,"description":"Contains the identifier for the transaction in the core system"},{"name":"paymentSource","in":"query","type":"string","required":false,"description":"Indicates the source from where the payment is originated"},{"name":"channel","in":"query","type":"string","required":false,"description":"Contains the channel in which the activity was performed. If pricing is not determined based on channel, then this is not significant"},{"name":"senderBankBic","in":"query","type":"string","required":false,"description":"Indicates the sending bank BIC Code"},{"name":"receiver","in":"query","type":"string","required":false,"description":"Identifies the receiver of the message"},{"name":"debtorAccountId","in":"query","type":"string","required":false,"description":"Contains the identification assigned by an institution to identify a debtor account by the account owner."},{"name":"beneficiaryAccountId","in":"query","type":"string","required":false,"description":"Unique account identifier of the beneficiary account number."},{"name":"scheme","in":"query","type":"string","required":false,"description":"Represents the scheme (a synonym for the National ID type) under which the National ID is defined"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"PaymentOrdersPendingApprovalResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/order/payments/screenings/pendingApprovals/levelOne","fullPath":"/api/v1.1.0/order/payments/screenings/pendingApprovals/levelOne","operationId":"getReleasedScreeningRequestsPendingLeveloneAuth","name":"Retrieves the list of transactions released from the screening queue by an operator and waiting for the first level of approval.","summary":"Retrieves released screening requests waiting first level approval","tags":["OTHERS"],"parameters":[{"name":"transactionReference","in":"query","type":"string","required":false,"description":"Contains the identifier for the transaction in the core system"},{"name":"dateSent","in":"query","type":"string","required":false,"description":"The date when the message is sent."},{"name":"timeStamp","in":"query","type":"string","required":false,"description":"Deprecated - Time Stamp"},{"name":"startTimestamp","in":"query","type":"string","required":false,"description":"Contains the timestamp at which the statement period starts."},{"name":"PaymentStatus","in":"query","type":"string","required":false,"description":"Describes the current status of the payment order in the payment system"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"ReleasedScreeningRequestsPendingLeveloneAuthResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/order/payments/cancellations/pendingApprovals","fullPath":"/api/v1.1.0/order/payments/cancellations/pendingApprovals","operationId":"getReversalPaymentsPendingApproval","name":"Retrieves the list of payments cancelled by an operator and waiting for approvals","summary":"Retrieves unapproved payment cancellations","tags":["OTHERS"],"parameters":[{"name":"clearingTransactionType","in":"query","type":"string","required":false,"description":"Indicates the Clearing transaction type."},{"name":"creditCustomerId","in":"query","type":"string","required":false,"description":"Creditor customer id details"},{"name":"customerOrBankTransfer","in":"query","type":"string","required":false,"description":"Indicates if the payment was initiated by Customer or the financial institution"},{"name":"customerSpecifiedReference","in":"query","type":"string","required":false,"description":"Deprecated - Customer specified reference"},{"name":"debitCustomerId","in":"query","type":"string","required":false,"description":"Debtor customer details"},{"name":"paymentDirection","in":"query","type":"string","required":false,"description":"Indicates the direction of payment i.e. incoming, outgoing, book or redirect"},{"name":"endToEndReference","in":"query","type":"string","required":false,"description":"Indicates the end to end reference for the payment. This field can be provided by the person who instructs the payment and this flows through the lifecycle of the payment."},{"name":"entryDateTime","in":"query","type":"string","required":false,"description":"Contains the payment creation time"},{"name":"fileSendersReference","in":"query","type":"string","required":false,"description":"Indicates the sender reference that comes from the inward payment file"},{"name":"paymentId","in":"query","type":"string","required":false,"description":"Indicates the unique reference number of the payment"},{"name":"incomingMessageType","in":"query","type":"string","required":false,"description":"Indicates the supported message type to be received from the clearing house or the direct participant."},{"name":"company","in":"query","type":"string","required":false,"description":"The company code"},{"name":"processingDate","in":"query","type":"string","required":false,"description":"The date when payment instruction is processed in system."},{"name":"partySendersReferenceIncoming","in":"query","type":"string","required":false,"description":"Debtor payment reference details of incoming"},{"name":"partySendersReferenceOutgoing","in":"query","type":"string","required":false,"description":"Debtor payment reference details of outgoing"},{"name":"statusCode","in":"query","type":"string","required":false,"description":"Status code, as defined by the institution"},{"name":"transactionAmount","in":"query","type":"string","required":false,"description":"Contains the transaction amount. This is based on the currency, either local or foreign currency"},{"name":"transactionCurrency","in":"query","type":"string","required":false,"description":"Indicates the currency of the transaction. For example GBP, USD etc."},{"name":"transactionReference","in":"query","type":"string","required":false,"description":"Contains the identifier for the transaction in the core system"},{"name":"valueDate","in":"query","type":"string","required":false,"description":"Contains the value date of the claim or the date on which the amount to be claimed"},{"name":"paymentSource","in":"query","type":"string","required":false,"description":"Indicates the source from where the payment is originated"},{"name":"channel","in":"query","type":"string","required":false,"description":"Contains the channel in which the activity was performed. If pricing is not determined based on channel, then this is not significant"},{"name":"senderBankBic","in":"query","type":"string","required":false,"description":"Indicates the sending bank BIC Code"},{"name":"receiver","in":"query","type":"string","required":false,"description":"Identifies the receiver of the message"},{"name":"debtorAccountId","in":"query","type":"string","required":false,"description":"Contains the identification assigned by an institution to identify a debtor account by the account owner."},{"name":"beneficiaryAccountId","in":"query","type":"string","required":false,"description":"Unique account identifier of the beneficiary account number."},{"name":"scheme","in":"query","type":"string","required":false,"description":"Represents the scheme (a synonym for the National ID type) under which the National ID is defined"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"ReversalPaymentsPendingApprovalResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/order/payments/cover/redirects/returns/pendingApprovals","fullPath":"/api/v1.1.0/order/payments/cover/redirects/returns/pendingApprovals","operationId":"getInwardReturnRedirectCoverPaymentsPendingAuth","name":"Retrieves the list of return transactions settled via cover(redirected) which is actioned and waiting for approvals","summary":"Retrieves return transactions settled via cover(redirected) which is actioned and waiting for approvals","tags":["OTHERS"],"parameters":[{"name":"clearingTransactionType","in":"query","type":"string","required":false,"description":"Indicates the Clearing transaction type."},{"name":"creditCustomerId","in":"query","type":"string","required":false,"description":"Creditor customer id details"},{"name":"customerOrBankTransfer","in":"query","type":"string","required":false,"description":"Indicates if the payment was initiated by Customer or the financial institution"},{"name":"customerSpecifiedReference","in":"query","type":"string","required":false,"description":"Deprecated - Customer specified reference"},{"name":"debitCustomerId","in":"query","type":"string","required":false,"description":"Debtor customer details"},{"name":"paymentDirection","in":"query","type":"string","required":false,"description":"Indicates the direction of payment i.e. incoming, outgoing, book or redirect"},{"name":"endToEndReference","in":"query","type":"string","required":false,"description":"Indicates the end to end reference for the payment. This field can be provided by the person who instructs the payment and this flows through the lifecycle of the payment."},{"name":"entryDateTime","in":"query","type":"string","required":false,"description":"Contains the payment creation time"},{"name":"fileSendersReference","in":"query","type":"string","required":false,"description":"Indicates the sender reference that comes from the inward payment file"},{"name":"paymentId","in":"query","type":"string","required":false,"description":"Indicates the unique reference number of the payment"},{"name":"incomingMessageType","in":"query","type":"string","required":false,"description":"Indicates the supported message type to be received from the clearing house or the direct participant."},{"name":"company","in":"query","type":"string","required":false,"description":"The company code"},{"name":"processingDate","in":"query","type":"string","required":false,"description":"The date when payment instruction is processed in system."},{"name":"partySendersReferenceIncoming","in":"query","type":"string","required":false,"description":"Debtor payment reference details of incoming"},{"name":"partySendersReferenceOutgoing","in":"query","type":"string","required":false,"description":"Debtor payment reference details of outgoing"},{"name":"statusCode","in":"query","type":"string","required":false,"description":"Status code, as defined by the institution"},{"name":"transactionAmount","in":"query","type":"string","required":false,"description":"Contains the transaction amount. This is based on the currency, either local or foreign currency"},{"name":"transactionCurrency","in":"query","type":"string","required":false,"description":"Indicates the currency of the transaction. For example GBP, USD etc."},{"name":"transactionReference","in":"query","type":"string","required":false,"description":"Contains the identifier for the transaction in the core system"},{"name":"paymentSource","in":"query","type":"string","required":false,"description":"Indicates the source from where the payment is originated"},{"name":"channel","in":"query","type":"string","required":false,"description":"Contains the channel in which the activity was performed. If pricing is not determined based on channel, then this is not significant"},{"name":"senderBankBic","in":"query","type":"string","required":false,"description":"Indicates the sending bank BIC Code"},{"name":"receiver","in":"query","type":"string","required":false,"description":"Identifies the receiver of the message"},{"name":"debtorAccountId","in":"query","type":"string","required":false,"description":"Contains the identification assigned by an institution to identify a debtor account by the account owner."},{"name":"beneficiaryAccountId","in":"query","type":"string","required":false,"description":"Unique account identifier of the beneficiary account number."},{"name":"scheme","in":"query","type":"string","required":false,"description":"Represents the scheme (a synonym for the National ID type) under which the National ID is defined"},{"name":"valueDate","in":"query","type":"string","required":false,"description":"Contains the value date of the claim or the date on which the amount to be claimed"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"InwardReturnRedirectCoverPaymentsPendingAuthResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/order/payments/claims/pendingApprovals","fullPath":"/api/v1.1.0/order/payments/claims/pendingApprovals","operationId":"getReceivedClaimsPendingApproval","name":"Retrieves SWIFT claims received that are pending for approval","summary":"Retrieves received claims","tags":["OTHERS"],"parameters":[{"name":"deliveryReference","in":"query","type":"string","required":false,"description":"Indicates the delivery reference Id generated for the activity"},{"name":"sendersReference","in":"query","type":"string","required":false,"description":"Indicates the incoming sender's reference i.e. tag 20 of incoming SWIFT or in case when transaction is received from other system/ application, this can also indicate the reference number of that syst"},{"name":"relatedReference","in":"query","type":"string","required":false,"description":"An external reference id for the transaction."},{"name":"transactionAmount","in":"query","type":"string","required":false,"description":"Contains the transaction amount. This is based on the currency, either local or foreign currency"},{"name":"orderingInstitutionAccount","in":"query","type":"string","required":false,"description":"Contains the National Clearing Code (NCC) or account number of the ordering institution."},{"name":"senderInstitutionBIC","in":"query","type":"string","required":false,"description":"Contains the Bank Identifier Code(BIC) of the bank which is sending the information request."},{"name":"accountWithInstitutionCode","in":"query","type":"string","required":false,"description":"Contains the Business Identifier Code (BIC) of the account with institution."},{"name":"statusCode","in":"query","type":"string","required":false,"description":"Status code, as defined by the institution"},{"name":"rejectRemark","in":"query","type":"string","required":false,"description":"Contains the remarks given for rejection."},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"ReceivedClaimsPendingApprovalResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/order/payments/cover/pendingApprovals","fullPath":"/api/v1.1.0/order/payments/cover/pendingApprovals","operationId":"getCoverPaymentsPendingApproval","name":"Retrieves announcement message that are manually matched with cover and  awaiting approval","summary":"Retrieves pending payments for cover that are awaiting approval","tags":["OTHERS"],"parameters":[{"name":"clearingTransactionType","in":"query","type":"string","required":false,"description":"Indicates the Clearing transaction type."},{"name":"creditCustomerId","in":"query","type":"string","required":false,"description":"Creditor customer id details"},{"name":"customerOrBankTransfer","in":"query","type":"string","required":false,"description":"Indicates if the payment was initiated by Customer or the financial institution"},{"name":"customerSpecifiedReference","in":"query","type":"string","required":false,"description":"Deprecated - Customer specified reference"},{"name":"debitCustomerId","in":"query","type":"string","required":false,"description":"Debtor customer details"},{"name":"paymentDirection","in":"query","type":"string","required":false,"description":"Indicates the direction of payment i.e. incoming, outgoing, book or redirect"},{"name":"endToEndReference","in":"query","type":"string","required":false,"description":"Indicates the end to end reference for the payment. This field can be provided by the person who instructs the payment and this flows through the lifecycle of the payment."},{"name":"entryDateTime","in":"query","type":"string","required":false,"description":"Contains the payment creation time"},{"name":"fileSendersReference","in":"query","type":"string","required":false,"description":"Indicates the sender reference that comes from the inward payment file"},{"name":"paymentId","in":"query","type":"string","required":false,"description":"Indicates the unique reference number of the payment"},{"name":"incomingMessageType","in":"query","type":"string","required":false,"description":"Indicates the supported message type to be received from the clearing house or the direct participant."},{"name":"company","in":"query","type":"string","required":false,"description":"The company code"},{"name":"processingDate","in":"query","type":"string","required":false,"description":"The date when payment instruction is processed in system."},{"name":"partySendersReferenceIncoming","in":"query","type":"string","required":false,"description":"Debtor payment reference details of incoming"},{"name":"partySendersReferenceOutgoing","in":"query","type":"string","required":false,"description":"Debtor payment reference details of outgoing"},{"name":"statusCode","in":"query","type":"string","required":false,"description":"Status code, as defined by the institution"},{"name":"transactionAmount","in":"query","type":"string","required":false,"description":"Contains the transaction amount. This is based on the currency, either local or foreign currency"},{"name":"transactionCurrency","in":"query","type":"string","required":false,"description":"Indicates the currency of the transaction. For example GBP, USD etc."},{"name":"transactionReference","in":"query","type":"string","required":false,"description":"Contains the identifier for the transaction in the core system"},{"name":"paymentSource","in":"query","type":"string","required":false,"description":"Indicates the source from where the payment is originated"},{"name":"channel","in":"query","type":"string","required":false,"description":"Contains the channel in which the activity was performed. If pricing is not determined based on channel, then this is not significant"},{"name":"senderBankBic","in":"query","type":"string","required":false,"description":"Indicates the sending bank BIC Code"},{"name":"receiver","in":"query","type":"string","required":false,"description":"Identifies the receiver of the message"},{"name":"debtorAccountId","in":"query","type":"string","required":false,"description":"Contains the identification assigned by an institution to identify a debtor account by the account owner."},{"name":"beneficiaryAccountId","in":"query","type":"string","required":false,"description":"Unique account identifier of the beneficiary account number."},{"name":"scheme","in":"query","type":"string","required":false,"description":"Represents the scheme (a synonym for the National ID type) under which the National ID is defined"},{"name":"valueDate","in":"query","type":"string","required":false,"description":"Contains the value date of the claim or the date on which the amount to be claimed"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"CoverPaymentsPendingApprovalResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/order/payments/swift/exceptions/pendingApprovals","fullPath":"/api/v1.1.0/order/payments/swift/exceptions/pendingApprovals","operationId":"getSwiftOutExceptionPaymentsPendingApproval","name":"Retrieves outward SWIFT payments which went into exception due to reject/nacks, have been manually actioned and  awaiting approval","summary":"Retrieves modified SWIFT out exception payments awaiting approval","tags":["OTHERS"],"parameters":[{"name":"clearingTransactionType","in":"query","type":"string","required":false,"description":"Indicates the Clearing transaction type."},{"name":"creditCustomerId","in":"query","type":"string","required":false,"description":"Creditor customer id details"},{"name":"customerOrBankTransfer","in":"query","type":"string","required":false,"description":"Indicates if the payment was initiated by Customer or the financial institution"},{"name":"customerSpecifiedReference","in":"query","type":"string","required":false,"description":"Deprecated - Customer specified reference"},{"name":"debitCustomerId","in":"query","type":"string","required":false,"description":"Debtor customer details"},{"name":"paymentDirection","in":"query","type":"string","required":false,"description":"Indicates the direction of payment i.e. incoming, outgoing, book or redirect"},{"name":"endToEndReference","in":"query","type":"string","required":false,"description":"Indicates the end to end reference for the payment. This field can be provided by the person who instructs the payment and this flows through the lifecycle of the payment."},{"name":"entryDateTime","in":"query","type":"string","required":false,"description":"Contains the payment creation time"},{"name":"fileSendersReference","in":"query","type":"string","required":false,"description":"Indicates the sender reference that comes from the inward payment file"},{"name":"paymentId","in":"query","type":"string","required":false,"description":"Indicates the unique reference number of the payment"},{"name":"incomingMessageType","in":"query","type":"string","required":false,"description":"Indicates the supported message type to be received from the clearing house or the direct participant."},{"name":"company","in":"query","type":"string","required":false,"description":"The company code"},{"name":"processingDate","in":"query","type":"string","required":false,"description":"The date when payment instruction is processed in system."},{"name":"partySendersReferenceIncoming","in":"query","type":"string","required":false,"description":"Debtor payment reference details of incoming"},{"name":"partySendersReferenceOutgoing","in":"query","type":"string","required":false,"description":"Debtor payment reference details of outgoing"},{"name":"statusCode","in":"query","type":"string","required":false,"description":"Status code, as defined by the institution"},{"name":"transactionAmount","in":"query","type":"string","required":false,"description":"Contains the transaction amount. This is based on the currency, either local or foreign currency"},{"name":"transactionCurrency","in":"query","type":"string","required":false,"description":"Indicates the currency of the transaction. For example GBP, USD etc."},{"name":"transactionReference","in":"query","type":"string","required":false,"description":"Contains the identifier for the transaction in the core system"},{"name":"paymentSource","in":"query","type":"string","required":false,"description":"Indicates the source from where the payment is originated"},{"name":"channel","in":"query","type":"string","required":false,"description":"Contains the channel in which the activity was performed. If pricing is not determined based on channel, then this is not significant"},{"name":"senderBankBic","in":"query","type":"string","required":false,"description":"Indicates the sending bank BIC Code"},{"name":"receiver","in":"query","type":"string","required":false,"description":"Identifies the receiver of the message"},{"name":"debtorAccountId","in":"query","type":"string","required":false,"description":"Contains the identification assigned by an institution to identify a debtor account by the account owner."},{"name":"beneficiaryAccountId","in":"query","type":"string","required":false,"description":"Unique account identifier of the beneficiary account number."},{"name":"scheme","in":"query","type":"string","required":false,"description":"Represents the scheme (a synonym for the National ID type) under which the National ID is defined"},{"name":"valueDate","in":"query","type":"string","required":false,"description":"Contains the value date of the claim or the date on which the amount to be claimed"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"SwiftOutExceptionPaymentsPendingApprovalResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/order/payments/screenings/pendingApprovals","fullPath":"/api/v1.1.0/order/payments/screenings/pendingApprovals","operationId":"getScreeningHitPaymentsPendingApproval","name":"Retrieves payments which were sent to screening, were considered a hit,  manually actioned and hence awaiting approval","summary":"Retrieves released screening hit payments that are awaiting approval","tags":["OTHERS"],"parameters":[{"name":"clearingTransactionType","in":"query","type":"string","required":false,"description":"Indicates the Clearing transaction type."},{"name":"creditCustomerId","in":"query","type":"string","required":false,"description":"Creditor customer id details"},{"name":"customerOrBankTransfer","in":"query","type":"string","required":false,"description":"Indicates if the payment was initiated by Customer or the financial institution"},{"name":"customerSpecifiedReference","in":"query","type":"string","required":false,"description":"Deprecated - Customer specified reference"},{"name":"debitCustomerId","in":"query","type":"string","required":false,"description":"Debtor customer details"},{"name":"paymentDirection","in":"query","type":"string","required":false,"description":"Indicates the direction of payment i.e. incoming, outgoing, book or redirect"},{"name":"endToEndReference","in":"query","type":"string","required":false,"description":"Indicates the end to end reference for the payment. This field can be provided by the person who instructs the payment and this flows through the lifecycle of the payment."},{"name":"entryDateTime","in":"query","type":"string","required":false,"description":"Contains the payment creation time"},{"name":"fileSendersReference","in":"query","type":"string","required":false,"description":"Indicates the sender reference that comes from the inward payment file"},{"name":"paymentId","in":"query","type":"string","required":false,"description":"Indicates the unique reference number of the payment"},{"name":"incomingMessageType","in":"query","type":"string","required":false,"description":"Indicates the supported message type to be received from the clearing house or the direct participant."},{"name":"company","in":"query","type":"string","required":false,"description":"The company code"},{"name":"processingDate","in":"query","type":"string","required":false,"description":"The date when payment instruction is processed in system."},{"name":"partySendersReferenceIncoming","in":"query","type":"string","required":false,"description":"Debtor payment reference details of incoming"},{"name":"partySendersReferenceOutgoing","in":"query","type":"string","required":false,"description":"Debtor payment reference details of outgoing"},{"name":"statusCode","in":"query","type":"string","required":false,"description":"Status code, as defined by the institution"},{"name":"transactionAmount","in":"query","type":"string","required":false,"description":"Contains the transaction amount. This is based on the currency, either local or foreign currency"},{"name":"transactionCurrency","in":"query","type":"string","required":false,"description":"Indicates the currency of the transaction. For example GBP, USD etc."},{"name":"transactionReference","in":"query","type":"string","required":false,"description":"Contains the identifier for the transaction in the core system"},{"name":"valueDate","in":"query","type":"string","required":false,"description":"Contains the value date of the claim or the date on which the amount to be claimed"},{"name":"paymentSource","in":"query","type":"string","required":false,"description":"Indicates the source from where the payment is originated"},{"name":"channel","in":"query","type":"string","required":false,"description":"Contains the channel in which the activity was performed. If pricing is not determined based on channel, then this is not significant"},{"name":"senderBankBic","in":"query","type":"string","required":false,"description":"Indicates the sending bank BIC Code"},{"name":"receiver","in":"query","type":"string","required":false,"description":"Identifies the receiver of the message"},{"name":"debtorAccountId","in":"query","type":"string","required":false,"description":"Contains the identification assigned by an institution to identify a debtor account by the account owner."},{"name":"beneficiaryAccountId","in":"query","type":"string","required":false,"description":"Unique account identifier of the beneficiary account number."},{"name":"scheme","in":"query","type":"string","required":false,"description":"Represents the scheme (a synonym for the National ID type) under which the National ID is defined"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"ScreeningHitPaymentsPendingApprovalResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/order/payments/technicalExceptions/pendingApprovals","fullPath":"/api/v1.1.0/order/payments/technicalExceptions/pendingApprovals","operationId":"getParkedPaymentsReleasedPendingApproval","name":"Retrieves payments which were parked due to technical exceptions,   manually actioned and hence awaiting approval","summary":"Retrieves the modified parked payments to release awaiting approval","tags":["OTHERS"],"parameters":[{"name":"clearingTransactionType","in":"query","type":"string","required":false,"description":"Indicates the Clearing transaction type."},{"name":"creditCustomerId","in":"query","type":"string","required":false,"description":"Creditor customer id details"},{"name":"customerOrBankTransfer","in":"query","type":"string","required":false,"description":"Indicates if the payment was initiated by Customer or the financial institution"},{"name":"customerSpecifiedReference","in":"query","type":"string","required":false,"description":"Deprecated - Customer specified reference"},{"name":"debitCustomerId","in":"query","type":"string","required":false,"description":"Debtor customer details"},{"name":"paymentDirection","in":"query","type":"string","required":false,"description":"Indicates the direction of payment i.e. incoming, outgoing, book or redirect"},{"name":"endToEndReference","in":"query","type":"string","required":false,"description":"Indicates the end to end reference for the payment. This field can be provided by the person who instructs the payment and this flows through the lifecycle of the payment."},{"name":"entryDateTime","in":"query","type":"string","required":false,"description":"Contains the payment creation time"},{"name":"fileSendersReference","in":"query","type":"string","required":false,"description":"Indicates the sender reference that comes from the inward payment file"},{"name":"paymentId","in":"query","type":"string","required":false,"description":"Indicates the unique reference number of the payment"},{"name":"incomingMessageType","in":"query","type":"string","required":false,"description":"Indicates the supported message type to be received from the clearing house or the direct participant."},{"name":"company","in":"query","type":"string","required":false,"description":"The company code"},{"name":"processingDate","in":"query","type":"string","required":false,"description":"The date when payment instruction is processed in system."},{"name":"partySendersReferenceIncoming","in":"query","type":"string","required":false,"description":"Debtor payment reference details of incoming"},{"name":"partySendersReferenceOutgoing","in":"query","type":"string","required":false,"description":"Debtor payment reference details of outgoing"},{"name":"statusCode","in":"query","type":"string","required":false,"description":"Status code, as defined by the institution"},{"name":"transactionAmount","in":"query","type":"string","required":false,"description":"Contains the transaction amount. This is based on the currency, either local or foreign currency"},{"name":"transactionCurrency","in":"query","type":"string","required":false,"description":"Indicates the currency of the transaction. For example GBP, USD etc."},{"name":"transactionReference","in":"query","type":"string","required":false,"description":"Contains the identifier for the transaction in the core system"},{"name":"valueDate","in":"query","type":"string","required":false,"description":"Contains the value date of the claim or the date on which the amount to be claimed"},{"name":"paymentSource","in":"query","type":"string","required":false,"description":"Indicates the source from where the payment is originated"},{"name":"channel","in":"query","type":"string","required":false,"description":"Contains the channel in which the activity was performed. If pricing is not determined based on channel, then this is not significant"},{"name":"senderBankBic","in":"query","type":"string","required":false,"description":"Indicates the sending bank BIC Code"},{"name":"receiver","in":"query","type":"string","required":false,"description":"Identifies the receiver of the message"},{"name":"debtorAccountId","in":"query","type":"string","required":false,"description":"Contains the identification assigned by an institution to identify a debtor account by the account owner."},{"name":"beneficiaryAccountId","in":"query","type":"string","required":false,"description":"Unique account identifier of the beneficiary account number."},{"name":"scheme","in":"query","type":"string","required":false,"description":"Represents the scheme (a synonym for the National ID type) under which the National ID is defined"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"ParkedPaymentsReleasedPendingApprovalResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/order/payments/screenings/pendingApprovals/levelTwo","fullPath":"/api/v1.1.0/order/payments/screenings/pendingApprovals/levelTwo","operationId":"getReleasedScreeningPendingLeveltwoApproval","name":"Retrieves payments which were sent to screening, were considered a hit,  manually actioned, approved once  and awaiting second level approval","summary":"Retrieves released screening requests awaiting second level approval","tags":["OTHERS"],"parameters":[{"name":"transactionReference","in":"query","type":"string","required":false,"description":"Contains the identifier for the transaction in the core system"},{"name":"dateSent","in":"query","type":"string","required":false,"description":"The date when the message is sent."},{"name":"timeStamp","in":"query","type":"string","required":false,"description":"Deprecated - Time Stamp"},{"name":"startTimestamp","in":"query","type":"string","required":false,"description":"Contains the timestamp at which the statement period starts."},{"name":"PaymentStatus","in":"query","type":"string","required":false,"description":"Describes the current status of the payment order in the payment system"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"ReleasedScreeningPendingLeveltwoApprovalResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/order/payments/swift/iso/exceptions/pendingApprovals","fullPath":"/api/v1.1.0/order/payments/swift/iso/exceptions/pendingApprovals","operationId":"getSwiftISOExceptionsPaymentsPendingApprovals","name":"Retrieves SWIFT MX payments that were sent but rejected by SWIFT and then modified to be resent. They await approval as they were manually actioned","summary":"Retrieves SWIFT MX payments modified due to rejects from SWIFT and awaiting approval","tags":["OTHERS"],"parameters":[{"name":"company","in":"query","type":"string","required":false,"description":"The company code"},{"name":"paymentId","in":"query","type":"string","required":false,"description":"Indicates the unique reference number of the payment"},{"name":"sendersReference","in":"query","type":"string","required":false,"description":"Indicates the incoming sender's reference i.e. tag 20 of incoming SWIFT or in case when transaction is received from other system/ application, this can also indicate the reference number of that syst"},{"name":"bulkReference","in":"query","type":"string","required":false,"description":"Contains bulk master reference for the payment."},{"name":"negativeAcknowledgementReason","in":"query","type":"string","required":false,"description":"Contains the  ISO reason code received in technical ack/nack messages"},{"name":"messageType","in":"query","type":"string","required":false,"description":"Contains the message type of the information request."},{"name":"transactionAmount","in":"query","type":"string","required":false,"description":"Contains the transaction amount. This is based on the currency, either local or foreign currency"},{"name":"transactionCurrency","in":"query","type":"string","required":false,"description":"Indicates the currency of the transaction. For example GBP, USD etc."},{"name":"paymentMsgSentDate","in":"query","type":"string","required":false,"description":"Indicates the date on which payment message (MT103, MT202) is sent out to the receiving bank or clearing."},{"name":"errorCode","in":"query","type":"string","required":false,"description":"Indicates the error code which is encountered during payment processing as returned by payment system "},{"name":"statusCode","in":"query","type":"string","required":false,"description":"Status code, as defined by the institution"},{"name":"channel","in":"query","type":"string","required":false,"description":"Contains the channel in which the activity was performed. If pricing is not determined based on channel, then this is not significant"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"SwiftISOExceptionsPaymentsPendingApprovalsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/order/payments/futureDatedPayments/pendingApprovals","fullPath":"/api/v1.1.0/order/payments/futureDatedPayments/pendingApprovals","operationId":"getFutureDatedPaymentsPendingApproval","name":"Retrieves future dated payments which were manually released from warehouse queue and hence awaiting approval","summary":"Retrieves future dated payments released from warehouse queue and awaiting approval","tags":["OTHERS"],"parameters":[{"name":"clearingTransactionType","in":"query","type":"string","required":false,"description":"Indicates the Clearing transaction type."},{"name":"creditCustomerId","in":"query","type":"string","required":false,"description":"Creditor customer id details"},{"name":"customerOrBankTransfer","in":"query","type":"string","required":false,"description":"Indicates if the payment was initiated by Customer or the financial institution"},{"name":"customerSpecifiedReference","in":"query","type":"string","required":false,"description":"Deprecated - Customer specified reference"},{"name":"debitCustomerId","in":"query","type":"string","required":false,"description":"Debtor customer details"},{"name":"paymentDirection","in":"query","type":"string","required":false,"description":"Indicates the direction of payment i.e. incoming, outgoing, book or redirect"},{"name":"endToEndReference","in":"query","type":"string","required":false,"description":"Indicates the end to end reference for the payment. This field can be provided by the person who instructs the payment and this flows through the lifecycle of the payment."},{"name":"entryDateTime","in":"query","type":"string","required":false,"description":"Contains the payment creation time"},{"name":"fileSendersReference","in":"query","type":"string","required":false,"description":"Indicates the sender reference that comes from the inward payment file"},{"name":"paymentId","in":"query","type":"string","required":false,"description":"Indicates the unique reference number of the payment"},{"name":"paymentOrderId","in":"query","type":"string","required":false,"description":"The unique reference number of payment"},{"name":"incomingMessageType","in":"query","type":"string","required":false,"description":"Indicates the supported message type to be received from the clearing house or the direct participant."},{"name":"company","in":"query","type":"string","required":false,"description":"The company code"},{"name":"processingDate","in":"query","type":"string","required":false,"description":"The date when payment instruction is processed in system."},{"name":"partySendersReferenceIncoming","in":"query","type":"string","required":false,"description":"Debtor payment reference details of incoming"},{"name":"partySendersReferenceOutgoing","in":"query","type":"string","required":false,"description":"Debtor payment reference details of outgoing"},{"name":"statusCode","in":"query","type":"string","required":false,"description":"Status code, as defined by the institution"},{"name":"transactionAmount","in":"query","type":"string","required":false,"description":"Contains the transaction amount. This is based on the currency, either local or foreign currency"},{"name":"transactionCurrency","in":"query","type":"string","required":false,"description":"Indicates the currency of the transaction. For example GBP, USD etc."},{"name":"valueDate","in":"query","type":"string","required":false,"description":"Contains the value date of the claim or the date on which the amount to be claimed"},{"name":"transactionReference","in":"query","type":"string","required":false,"description":"Contains the identifier for the transaction in the core system"},{"name":"paymentSource","in":"query","type":"string","required":false,"description":"Indicates the source from where the payment is originated"},{"name":"channel","in":"query","type":"string","required":false,"description":"Contains the channel in which the activity was performed. If pricing is not determined based on channel, then this is not significant"},{"name":"senderBankBic","in":"query","type":"string","required":false,"description":"Indicates the sending bank BIC Code"},{"name":"receiver","in":"query","type":"string","required":false,"description":"Identifies the receiver of the message"},{"name":"debtorAccountId","in":"query","type":"string","required":false,"description":"Contains the identification assigned by an institution to identify a debtor account by the account owner."},{"name":"beneficiaryAccountId","in":"query","type":"string","required":false,"description":"Unique account identifier of the beneficiary account number."},{"name":"scheme","in":"query","type":"string","required":false,"description":"Represents the scheme (a synonym for the National ID type) under which the National ID is defined"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"FutureDatedPaymentsPendingApprovalResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/order/payments/receivedFiles/bulks/pendingApprovals","fullPath":"/api/v1.1.0/order/payments/receivedFiles/bulks/pendingApprovals","operationId":"getReceivedBulksPendingApproval","name":"Retrieves payment file received and their bulk repaired manually and hence awaiting approval","summary":"Retrieves repaired  bulks awaiting approvals","tags":["OTHERS"],"parameters":[{"name":"recordId","in":"query","type":"string","required":false,"description":"record Id name for NOFILE enquiry for online upgrade"},{"name":"company","in":"query","type":"string","required":false,"description":"The company code"},{"name":"originalFileReference","in":"query","type":"string","required":false,"description":"Indicates reference of the incoming file for which response is being sent"},{"name":"bulkReference","in":"query","type":"string","required":false,"description":"Contains bulk master reference for the payment."},{"name":"bulkFileReferenceApi","in":"query","type":"string","required":false,"description":"Indicates the API that will be invoked to derive at the bulk and file reference if the clearing has a specific requirement."},{"name":"creationDateTime","in":"query","type":"string","required":false,"description":"Date and Time of the message creation."},{"name":"bulkTypeId","in":"query","type":"string","required":false,"description":"Identifier of the bulk update type record that holds default conditions required for Bulk Master creation. SINGLE and MULTI are two record references used by payment order application for processing p"},{"name":"bulkItemId","in":"query","type":"string","required":false,"description":"contains individual payment id of the Bulk upload"},{"name":"sendersCorrespondentAddress","in":"query","type":"string","required":false,"description":"Contains additional address lines of the sender correspondent institution."},{"name":"receiversCorrespondentCountry","in":"query","type":"string","required":false,"description":"Identifies the country of the receiver's correspondent"},{"name":"numberOfTransaction","in":"query","type":"string","required":false,"description":"Indicates the number of transactions performed on the contract or the account"},{"name":"settlementAmount","in":"query","type":"string","required":false,"description":"Amount of settlement"},{"name":"settlementCurrency","in":"query","type":"string","required":false,"description":"The currency of the trade settlement"},{"name":"settlementDate","in":"query","type":"string","required":false,"description":"Indicates the settlement date of the payment transaction"},{"name":"bulkMasterId","in":"query","type":"string","required":false,"description":"Uniquely identifies each bulk payment request.The reference number is automatically generated by the system."},{"name":"bulkReferenceId","in":"query","type":"string","required":false,"description":"Contains the bulk master reference for the payment."},{"name":"errorCode","in":"query","type":"string","required":false,"description":"Indicates the error code which is encountered during payment processing as returned by payment system "},{"name":"errorInfo","in":"query","type":"string","required":false,"description":"Contains the details of the error such as error source and error message"},{"name":"batchBookingPreferred","in":"query","type":"string","required":false,"description":"If batchBookingPrefered is set to true, then bulkType is defaulted to SINGLE (Single consolidated accounting entry on the debtor account). If set to false, then bulkType is defaulted to MULTI(Individu"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"ReceivedBulksPendingApprovalResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/order/payments/riskFilters/pendingApprovals/levelTwo","fullPath":"/api/v1.1.0/order/payments/riskFilters/pendingApprovals/levelTwo","operationId":"getRiskFilterPendingLeveltwoApproval","name":"Retrieves payment which have breached counter party/currency threshold, manually released and  awaiting level two approval","summary":"Retrieves released risk filter breach payments awaiting level two approvals","tags":["OTHERS"],"parameters":[{"name":"recordId","in":"query","type":"string","required":false,"description":"record Id name for NOFILE enquiry for online upgrade"},{"name":"company","in":"query","type":"string","required":false,"description":"The company code"},{"name":"transactionReference","in":"query","type":"string","required":false,"description":"Contains the identifier for the transaction in the core system"},{"name":"filteringId","in":"query","type":"string","required":false,"description":"Indicates the filtering product of a payment. Examples: BKINCSKIP, AMTLT1000, INCOMING"},{"name":"transactionLimitAmount","in":"query","type":"string","required":false,"description":"Defines the limit amount at which each transaction will be monitored."},{"name":"breachInformation","in":"query","type":"string","required":false,"description":"Contains the information about any breach on Collateral"},{"name":"dailylimits","in":"query","type":"string","required":false,"description":"Name of the LookupsResponse Code"},{"name":"dueAmount","in":"query","type":"string","required":false,"description":"Indicates the amount which was made due for a period"},{"name":"limitAmount","in":"query","type":"string","required":false,"description":"The Limit amount that is actually available for use. The system limit checks are preformed against the online limit"},{"name":"limitExceed","in":"query","type":"string","required":false,"description":"Whether the total cash deposits or withdrawals has exceeded the threshold amount set."},{"name":"secondaryLimitAmount","in":"query","type":"string","required":false,"description":"Contains the secondary limit amount to be used for the purpose of secondary limit check"},{"name":"limitExcess","in":"query","type":"string","required":false,"description":"An indicator to show that a credit limit has been exceeded"},{"name":"cutOffDay","in":"query","type":"string","required":false,"description":"Indicates the last day for Global Payment Initiative (GPI) payments in a given currency"},{"name":"transactionAmount","in":"query","type":"string","required":false,"description":"Contains the transaction amount. This is based on the currency, either local or foreign currency"},{"name":"transactionCurrency","in":"query","type":"string","required":false,"description":"Indicates the currency of the transaction. For example GBP, USD etc."},{"name":"debitValueDate","in":"query","type":"string","required":false,"description":"Date on which the amount will be debited for settlement"},{"name":"creditValueDate","in":"query","type":"string","required":false,"description":"Reference quoted by the credit account for a payment"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"RiskFilterPendingLeveltwoApprovalResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/order/payments/riskFilters/pendingApprovals/levelOne","fullPath":"/api/v1.1.0/order/payments/riskFilters/pendingApprovals/levelOne","operationId":"getRiskFilterPendingLevelOneApproval","name":"Retrieves payment which have breached counter party/currency threshold, manually released and  awaiting level one approval","summary":"Retrieves released risk filter breach payments awaiting level one approvals","tags":["OTHERS"],"parameters":[{"name":"company","in":"query","type":"string","required":false,"description":"The company code"},{"name":"transactionReference","in":"query","type":"string","required":false,"description":"Contains the identifier for the transaction in the core system"},{"name":"transactionAmount","in":"query","type":"string","required":false,"description":"Contains the transaction amount. This is based on the currency, either local or foreign currency"},{"name":"transactionCurrency","in":"query","type":"string","required":false,"description":"Indicates the currency of the transaction. For example GBP, USD etc."},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"RiskFilterPendingLevelOneApprovalResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/order/payments/sentFiles/bulks/pendingApprovals","fullPath":"/api/v1.1.0/order/payments/sentFiles/bulks/pendingApprovals","operationId":"getPaymentSentBulksPendingApproval","name":"Retrieves bulks that were rejected and modified to be sent and are awaiting approval.","summary":"Retrieves bulks modified to be sent and awaiting approval","tags":["OTHERS"],"parameters":[{"name":"id","in":"query","type":"string","required":false,"description":"Contains the daily position class id."},{"name":"company","in":"query","type":"string","required":false,"description":"The company code"},{"name":"originalFileReference","in":"query","type":"string","required":false,"description":"Indicates reference of the incoming file for which response is being sent"},{"name":"bulkReference","in":"query","type":"string","required":false,"description":"Contains bulk master reference for the payment."},{"name":"format","in":"query","type":"string","required":false,"description":"Indicates the formatting version to be used for the delivery message"},{"name":"paymentType","in":"query","type":"string","required":false,"description":"Indicates if the payment is Customer (C) type or Bank (B) type"},{"name":"sendersCorrespondentAddress","in":"query","type":"string","required":false,"description":"Contains additional address lines of the sender correspondent institution."},{"name":"receiversCorrespondentAddress","in":"query","type":"string","required":false,"description":"Contains additional address lines of the receiver correspondent institution."},{"name":"numberOfTransaction","in":"query","type":"string","required":false,"description":"Indicates the number of transactions performed on the contract or the account"},{"name":"settlementAmount","in":"query","type":"string","required":false,"description":"Amount of settlement"},{"name":"settlementCurrency","in":"query","type":"string","required":false,"description":"The currency of the trade settlement"},{"name":"settlementDate","in":"query","type":"string","required":false,"description":"Indicates the settlement date of the payment transaction"},{"name":"status","in":"query","type":"string","required":false,"description":"The status of the early maturity request"},{"name":"bulkReferenceId","in":"query","type":"string","required":false,"description":"Contains the bulk master reference for the payment."},{"name":"reasonCode","in":"query","type":"string","required":false,"description":"Contains the reason for raising the information request in a coded form."},{"name":"proprietaryTransactionCode","in":"query","type":"string","required":false,"description":"Contains the proprietary bank transaction code to identify the underlying transaction."},{"name":"statusCode","in":"query","type":"string","required":false,"description":"Status code, as defined by the institution"},{"name":"dateTime","in":"query","type":"string","required":false,"description":"Contains the date and time separated by '-'"},{"name":"action","in":"query","type":"string","required":false,"description":"Refers to view or cancel options."},{"name":"sourceType","in":"query","type":"string","required":false,"description":"Indicates source type to determine base amount. Possible values are BALANCE (base amount of a property), ACTIVITY ( transaction amount against an activity) or PROPERTY (this type is currently not supp"},{"name":"coverControl","in":"query","type":"string","required":false,"description":"Indicates whether the limit is applicable for the virtual accounts or not"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"PaymentSentBulksPendingApprovalResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/order/payments/sentFiles/files/pendingApprovals","fullPath":"/api/v1.1.0/order/payments/sentFiles/files/pendingApprovals","operationId":"getPaymentSentFilesPendingApproval","name":"Retrieves files that were rejected and  modified to be sent and are  awaiting approval","summary":"Retrieves files modified to be sent and awaiting approval","tags":["OTHERS"],"parameters":[{"name":"id","in":"query","type":"string","required":false,"description":"Contains the daily position class id."},{"name":"company","in":"query","type":"string","required":false,"description":"The company code"},{"name":"fileSendersReference","in":"query","type":"string","required":false,"description":"Indicates the sender reference that comes from the inward payment file"},{"name":"dateSent","in":"query","type":"string","required":false,"description":"The date when the message is sent."},{"name":"fileName","in":"query","type":"string","required":false,"description":"Identifies the type of methods to be listed. Possible values are FX.DEAL.METHOD, BROKER or blank."},{"name":"type","in":"query","type":"string","required":false,"description":"The product condition has an activity type associated that drives an action."},{"name":"typeIndicator","in":"query","type":"string","required":false,"description":"Indicates if the record is an Income or Expense"},{"name":"outputChannel","in":"query","type":"string","required":false,"description":"Contains the channel that will be used to send the outward payment message"},{"name":"creationDateTime","in":"query","type":"string","required":false,"description":"Date and Time of the message creation."},{"name":"status","in":"query","type":"string","required":false,"description":"The status of the early maturity request"},{"name":"numberOfTransaction","in":"query","type":"string","required":false,"description":"Indicates the number of transactions performed on the contract or the account"},{"name":"clearingStatus","in":"query","type":"string","required":false,"description":"Indicates if the status of the Clearing is Active, temporarily suspended or is altogether blocked."},{"name":"reasonCode","in":"query","type":"string","required":false,"description":"Contains the reason for raising the information request in a coded form."},{"name":"statusCode","in":"query","type":"string","required":false,"description":"Status code, as defined by the institution"},{"name":"dateTime","in":"query","type":"string","required":false,"description":"Contains the date and time separated by '-'"},{"name":"originalFileReference","in":"query","type":"string","required":false,"description":"Indicates reference of the incoming file for which response is being sent"},{"name":"sourceType","in":"query","type":"string","required":false,"description":"Indicates source type to determine base amount. Possible values are BALANCE (base amount of a property), ACTIVITY ( transaction amount against an activity) or PROPERTY (this type is currently not supp"},{"name":"clearingDate","in":"query","type":"string","required":false,"description":"Contains the date from which the payment is expected and is used to indicate the exposure date for the payment."},{"name":"receiversCorrespondentAddress","in":"query","type":"string","required":false,"description":"Contains additional address lines of the receiver correspondent institution."},{"name":"errorInfo","in":"query","type":"string","required":false,"description":"Contains the details of the error such as error source and error message"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"PaymentSentFilesPendingApprovalResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/order/payments/swift/returns/pendingApprovals","fullPath":"/api/v1.1.0/order/payments/swift/returns/pendingApprovals","operationId":"getReturnSettledSwiftPaymentsPendingApproval","name":"Retrieves the list of SWIFT return transaction and awaiting approval","summary":"Retrieves returns of completed SWIFT transactions  that are awaiting approval","tags":["OTHERS"],"parameters":[{"name":"clearingTransactionType","in":"query","type":"string","required":false,"description":"Indicates the Clearing transaction type."},{"name":"creditCustomerId","in":"query","type":"string","required":false,"description":"Creditor customer id details"},{"name":"customerOrBankTransfer","in":"query","type":"string","required":false,"description":"Indicates if the payment was initiated by Customer or the financial institution"},{"name":"customerSpecifiedReference","in":"query","type":"string","required":false,"description":"Deprecated - Customer specified reference"},{"name":"debitCustomerId","in":"query","type":"string","required":false,"description":"Debtor customer details"},{"name":"paymentDirection","in":"query","type":"string","required":false,"description":"Indicates the direction of payment i.e. incoming, outgoing, book or redirect"},{"name":"endToEndReference","in":"query","type":"string","required":false,"description":"Indicates the end to end reference for the payment. This field can be provided by the person who instructs the payment and this flows through the lifecycle of the payment."},{"name":"entryDateTime","in":"query","type":"string","required":false,"description":"Contains the payment creation time"},{"name":"fileSendersReference","in":"query","type":"string","required":false,"description":"Indicates the sender reference that comes from the inward payment file"},{"name":"paymentId","in":"query","type":"string","required":false,"description":"Indicates the unique reference number of the payment"},{"name":"incomingMessageType","in":"query","type":"string","required":false,"description":"Indicates the supported message type to be received from the clearing house or the direct participant."},{"name":"company","in":"query","type":"string","required":false,"description":"The company code"},{"name":"processingDate","in":"query","type":"string","required":false,"description":"The date when payment instruction is processed in system."},{"name":"partySendersReferenceIncoming","in":"query","type":"string","required":false,"description":"Debtor payment reference details of incoming"},{"name":"partySendersReferenceOutgoing","in":"query","type":"string","required":false,"description":"Debtor payment reference details of outgoing"},{"name":"statusCode","in":"query","type":"string","required":false,"description":"Status code, as defined by the institution"},{"name":"transactionAmount","in":"query","type":"string","required":false,"description":"Contains the transaction amount. This is based on the currency, either local or foreign currency"},{"name":"transactionCurrency","in":"query","type":"string","required":false,"description":"Indicates the currency of the transaction. For example GBP, USD etc."},{"name":"transactionReference","in":"query","type":"string","required":false,"description":"Contains the identifier for the transaction in the core system"},{"name":"paymentSource","in":"query","type":"string","required":false,"description":"Indicates the source from where the payment is originated"},{"name":"channel","in":"query","type":"string","required":false,"description":"Contains the channel in which the activity was performed. If pricing is not determined based on channel, then this is not significant"},{"name":"senderBankBic","in":"query","type":"string","required":false,"description":"Indicates the sending bank BIC Code"},{"name":"receiver","in":"query","type":"string","required":false,"description":"Identifies the receiver of the message"},{"name":"debtorAccountId","in":"query","type":"string","required":false,"description":"Contains the identification assigned by an institution to identify a debtor account by the account owner."},{"name":"beneficiaryAccountId","in":"query","type":"string","required":false,"description":"Unique account identifier of the beneficiary account number."},{"name":"scheme","in":"query","type":"string","required":false,"description":"Represents the scheme (a synonym for the National ID type) under which the National ID is defined"},{"name":"valueDate","in":"query","type":"string","required":false,"description":"Contains the value date of the claim or the date on which the amount to be claimed"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"ReturnSettledSwiftPaymentsPendingApprovalResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}}]},{"key":"order-payments-operationalQueueListingAuthorisation-v1.2.0","title":"Operational Queue Listing Approval","version":"v1.2.0","description":"Retrieves the list of payments that are available in the approval queue.","endpointCount":23,"endpoints":[{"method":"GET","path":"/order/payments/receivedFiles/pendingApprovals","fullPath":"/api/v1.2.0/order/payments/receivedFiles/pendingApprovals","operationId":"getReceivedFilesPendingApproval","name":"Retrieves the list of files modified due to mapping issue and waiting for approval","summary":"Retrieves repaired received files waiting first level approval","tags":["OTHERS"],"parameters":[{"name":"originalFileReference","in":"query","type":"string","required":false,"description":"Indicates reference of the incoming file for which response is being sent"},{"name":"queueName","in":"query","type":"string","required":false,"description":"For queue to queue configuration this field can be used to specify appropriate queue name with a prefix as CFNAME-queueName."},{"name":"receivedDateTime","in":"query","type":"string","required":false,"description":"Indicates the date and time when the request to pay message is received for payer and requestor"},{"name":"company","in":"query","type":"string","required":false,"description":"The company code"},{"name":"paymentStatus","in":"query","type":"string","required":false,"description":"Describes the current status of the payment order in the payment system"},{"name":"partyName","in":"query","type":"string","required":false,"description":"Specifies the short name of the customer in CUSTOMER.GROUP"},{"name":"partyDetail","in":"query","type":"string","required":false,"description":"Indicates the identifier for party details in which party id and party owner are defined"},{"name":"maximumBulksPerFile","in":"query","type":"string","required":false,"description":"Indicates the maximum number of bulks that can be added in a clearing file."},{"name":"inputter","in":"query","type":"string","required":false,"description":"The user identifier who input the transaction"},{"name":"recordStatus","in":"query","type":"string","required":false,"description":"General status of the record. Possible values: - null - authorised - IHLD - input, on hold - INAU - input, not authorised - INA2 - input, authorised, pending second authorisation - INAO - input, not a"},{"name":"channel","in":"query","type":"string","required":false,"description":"Contains the channel in which the activity was performed. If pricing is not determined based on channel, then this is not significant"},{"name":"optionIndicator","in":"query","type":"string","required":false,"description":"This holds the indicator of  option for the corporate action event and should be as per swift standards."},{"name":"outgoingMessageFormat","in":"query","type":"string","required":false,"description":"Indicates the format in which the outgoing message must be sent"},{"name":"paymentType","in":"query","type":"string","required":false,"description":"Indicates if the payment is Customer (C) type or Bank (B) type"},{"name":"fileName","in":"query","type":"string","required":false,"description":"Identifies the type of methods to be listed. Possible values are FX.DEAL.METHOD, BROKER or blank."},{"name":"typeIndicator","in":"query","type":"string","required":false,"description":"Indicates if the record is an Income or Expense"},{"name":"countOfRecords","in":"query","type":"string","required":false,"description":"Total count of records information for NOFILE (an enquiry does not exist in a single file) enquiry for online upgrade"},{"name":"errorCode","in":"query","type":"string","required":false,"description":"Indicates the error code which is encountered during payment processing as returned by payment system "},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"ReceivedFilesPendingApprovalResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/order/payments/screenings/pendingApprovals","fullPath":"/api/v1.2.0/order/payments/screenings/pendingApprovals","operationId":"getScreeningHitPaymentsPendingApproval","name":"Retrieves payments which were sent to screening, were considered a hit,  manually actioned and hence awaiting approval","summary":"Retrieves released screening hit payments that are awaiting approval","tags":["OTHERS"],"parameters":[{"name":"clearingTransactionType","in":"query","type":"string","required":false,"description":"Indicates the Clearing transaction type."},{"name":"creditCustomerId","in":"query","type":"string","required":false,"description":"Creditor customer id details"},{"name":"customerOrBankTransfer","in":"query","type":"string","required":false,"description":"Indicates if the payment was initiated by Customer or the financial institution"},{"name":"customerSpecifiedReference","in":"query","type":"string","required":false,"description":"Deprecated - Customer specified reference"},{"name":"debitCustomerId","in":"query","type":"string","required":false,"description":"Debtor customer details"},{"name":"paymentDirection","in":"query","type":"string","required":false,"description":"Indicates the direction of payment i.e. incoming, outgoing, book or redirect"},{"name":"endToEndReference","in":"query","type":"string","required":false,"description":"Indicates the end to end reference for the payment. This field can be provided by the person who instructs the payment and this flows through the lifecycle of the payment."},{"name":"entryDateTime","in":"query","type":"string","required":false,"description":"Contains the payment creation time"},{"name":"fileSendersReference","in":"query","type":"string","required":false,"description":"Indicates the sender reference that comes from the inward payment file"},{"name":"paymentId","in":"query","type":"string","required":false,"description":"Indicates the unique reference number of the payment"},{"name":"incomingMessageType","in":"query","type":"string","required":false,"description":"Indicates the supported message type to be received from the clearing house or the direct participant."},{"name":"company","in":"query","type":"string","required":false,"description":"The company code"},{"name":"processingDate","in":"query","type":"string","required":false,"description":"The date when payment instruction is processed in system."},{"name":"partySendersReferenceIncoming","in":"query","type":"string","required":false,"description":"Debtor payment reference details of incoming"},{"name":"partySendersReferenceOutgoing","in":"query","type":"string","required":false,"description":"Debtor payment reference details of outgoing"},{"name":"statusCode","in":"query","type":"string","required":false,"description":"Status code, as defined by the institution"},{"name":"transactionAmount","in":"query","type":"string","required":false,"description":"Contains the transaction amount. This is based on the currency, either local or foreign currency"},{"name":"transactionCurrency","in":"query","type":"string","required":false,"description":"Indicates the currency of the transaction. For example GBP, USD etc."},{"name":"transactionReference","in":"query","type":"string","required":false,"description":"Contains the identifier for the transaction in the core system"},{"name":"valueDate","in":"query","type":"string","required":false,"description":"Contains the value date of the claim or the date on which the amount to be claimed"},{"name":"paymentSource","in":"query","type":"string","required":false,"description":"Indicates the source from where the payment is originated"},{"name":"channel","in":"query","type":"string","required":false,"description":"Contains the channel in which the activity was performed. If pricing is not determined based on channel, then this is not significant"},{"name":"senderBankBic","in":"query","type":"string","required":false,"description":"Indicates the sending bank BIC Code"},{"name":"receiver","in":"query","type":"string","required":false,"description":"Identifies the receiver of the message"},{"name":"debtorAccountId","in":"query","type":"string","required":false,"description":"Contains the identification assigned by an institution to identify a debtor account by the account owner."},{"name":"beneficiaryAccountId","in":"query","type":"string","required":false,"description":"Unique account identifier of the beneficiary account number."},{"name":"scheme","in":"query","type":"string","required":false,"description":"Represents the scheme (a synonym for the National ID type) under which the National ID is defined"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"ScreeningHitPaymentsPendingApprovalResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/order/payments/paymentOrders/pendingApprovals","fullPath":"/api/v1.2.0/order/payments/paymentOrders/pendingApprovals","operationId":"getPaymentOrdersPendingApproval","name":"Retrieves the list of payments submitted or repaired and waiting for approvals","summary":"Retrieves initiated/repaired payment orders that are pending approvals","tags":["OTHERS"],"parameters":[{"name":"clearingTransactionType","in":"query","type":"string","required":false,"description":"Indicates the Clearing transaction type."},{"name":"creditCustomerId","in":"query","type":"string","required":false,"description":"Creditor customer id details"},{"name":"customerOrBankTransfer","in":"query","type":"string","required":false,"description":"Indicates if the payment was initiated by Customer or the financial institution"},{"name":"customerSpecifiedReference","in":"query","type":"string","required":false,"description":"Deprecated - Customer specified reference"},{"name":"debitCustomerId","in":"query","type":"string","required":false,"description":"Debtor customer details"},{"name":"paymentDirection","in":"query","type":"string","required":false,"description":"Indicates the direction of payment i.e. incoming, outgoing, book or redirect"},{"name":"endToEndReference","in":"query","type":"string","required":false,"description":"Indicates the end to end reference for the payment. This field can be provided by the person who instructs the payment and this flows through the lifecycle of the payment."},{"name":"entryDateTime","in":"query","type":"string","required":false,"description":"Contains the payment creation time"},{"name":"fileSendersReference","in":"query","type":"string","required":false,"description":"Indicates the sender reference that comes from the inward payment file"},{"name":"paymentId","in":"query","type":"string","required":false,"description":"Indicates the unique reference number of the payment"},{"name":"paymentOrderId","in":"query","type":"string","required":false,"description":"The unique reference number of payment"},{"name":"incomingMessageType","in":"query","type":"string","required":false,"description":"Indicates the supported message type to be received from the clearing house or the direct participant."},{"name":"company","in":"query","type":"string","required":false,"description":"The company code"},{"name":"processingDate","in":"query","type":"string","required":false,"description":"The date when payment instruction is processed in system."},{"name":"partySendersReferenceIncoming","in":"query","type":"string","required":false,"description":"Debtor payment reference details of incoming"},{"name":"partySendersReferenceOutgoing","in":"query","type":"string","required":false,"description":"Debtor payment reference details of outgoing"},{"name":"statusCode","in":"query","type":"string","required":false,"description":"Status code, as defined by the institution"},{"name":"transactionAmount","in":"query","type":"string","required":false,"description":"Contains the transaction amount. This is based on the currency, either local or foreign currency"},{"name":"transactionCurrency","in":"query","type":"string","required":false,"description":"Indicates the currency of the transaction. For example GBP, USD etc."},{"name":"valueDate","in":"query","type":"string","required":false,"description":"Contains the value date of the claim or the date on which the amount to be claimed"},{"name":"transactionReference","in":"query","type":"string","required":false,"description":"Contains the identifier for the transaction in the core system"},{"name":"paymentSource","in":"query","type":"string","required":false,"description":"Indicates the source from where the payment is originated"},{"name":"channel","in":"query","type":"string","required":false,"description":"Contains the channel in which the activity was performed. If pricing is not determined based on channel, then this is not significant"},{"name":"senderBankBic","in":"query","type":"string","required":false,"description":"Indicates the sending bank BIC Code"},{"name":"receiver","in":"query","type":"string","required":false,"description":"Identifies the receiver of the message"},{"name":"debtorAccountId","in":"query","type":"string","required":false,"description":"Contains the identification assigned by an institution to identify a debtor account by the account owner."},{"name":"beneficiaryAccountId","in":"query","type":"string","required":false,"description":"Unique account identifier of the beneficiary account number."},{"name":"scheme","in":"query","type":"string","required":false,"description":"Represents the scheme (a synonym for the National ID type) under which the National ID is defined"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"PaymentOrdersPendingApprovalResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/order/payments/futureDatedPayments/pendingApprovals","fullPath":"/api/v1.2.0/order/payments/futureDatedPayments/pendingApprovals","operationId":"getFutureDatedPaymentsPendingApproval","name":"Retrieves future dated payments which were manually released from warehouse queue and hence awaiting approval","summary":"Retrieves future dated payments released from warehouse queue and awaiting approval","tags":["OTHERS"],"parameters":[{"name":"clearingTransactionType","in":"query","type":"string","required":false,"description":"Indicates the Clearing transaction type."},{"name":"creditCustomerId","in":"query","type":"string","required":false,"description":"Creditor customer id details"},{"name":"customerOrBankTransfer","in":"query","type":"string","required":false,"description":"Indicates if the payment was initiated by Customer or the financial institution"},{"name":"customerSpecifiedReference","in":"query","type":"string","required":false,"description":"Deprecated - Customer specified reference"},{"name":"debitCustomerId","in":"query","type":"string","required":false,"description":"Debtor customer details"},{"name":"paymentDirection","in":"query","type":"string","required":false,"description":"Indicates the direction of payment i.e. incoming, outgoing, book or redirect"},{"name":"endToEndReference","in":"query","type":"string","required":false,"description":"Indicates the end to end reference for the payment. This field can be provided by the person who instructs the payment and this flows through the lifecycle of the payment."},{"name":"entryDateTime","in":"query","type":"string","required":false,"description":"Contains the payment creation time"},{"name":"fileSendersReference","in":"query","type":"string","required":false,"description":"Indicates the sender reference that comes from the inward payment file"},{"name":"paymentId","in":"query","type":"string","required":false,"description":"Indicates the unique reference number of the payment"},{"name":"paymentOrderId","in":"query","type":"string","required":false,"description":"The unique reference number of payment"},{"name":"incomingMessageType","in":"query","type":"string","required":false,"description":"Indicates the supported message type to be received from the clearing house or the direct participant."},{"name":"company","in":"query","type":"string","required":false,"description":"The company code"},{"name":"processingDate","in":"query","type":"string","required":false,"description":"The date when payment instruction is processed in system."},{"name":"partySendersReferenceIncoming","in":"query","type":"string","required":false,"description":"Debtor payment reference details of incoming"},{"name":"partySendersReferenceOutgoing","in":"query","type":"string","required":false,"description":"Debtor payment reference details of outgoing"},{"name":"statusCode","in":"query","type":"string","required":false,"description":"Status code, as defined by the institution"},{"name":"transactionAmount","in":"query","type":"string","required":false,"description":"Contains the transaction amount. This is based on the currency, either local or foreign currency"},{"name":"transactionCurrency","in":"query","type":"string","required":false,"description":"Indicates the currency of the transaction. For example GBP, USD etc."},{"name":"valueDate","in":"query","type":"string","required":false,"description":"Contains the value date of the claim or the date on which the amount to be claimed"},{"name":"transactionReference","in":"query","type":"string","required":false,"description":"Contains the identifier for the transaction in the core system"},{"name":"paymentSource","in":"query","type":"string","required":false,"description":"Indicates the source from where the payment is originated"},{"name":"channel","in":"query","type":"string","required":false,"description":"Contains the channel in which the activity was performed. If pricing is not determined based on channel, then this is not significant"},{"name":"senderBankBic","in":"query","type":"string","required":false,"description":"Indicates the sending bank BIC Code"},{"name":"receiver","in":"query","type":"string","required":false,"description":"Identifies the receiver of the message"},{"name":"debtorAccountId","in":"query","type":"string","required":false,"description":"Contains the identification assigned by an institution to identify a debtor account by the account owner."},{"name":"beneficiaryAccountId","in":"query","type":"string","required":false,"description":"Unique account identifier of the beneficiary account number."},{"name":"scheme","in":"query","type":"string","required":false,"description":"Represents the scheme (a synonym for the National ID type) under which the National ID is defined"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"FutureDatedPaymentsPendingApprovalResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/order/payments/technicalExceptions/pendingApprovals","fullPath":"/api/v1.2.0/order/payments/technicalExceptions/pendingApprovals","operationId":"getParkedPaymentsReleasedPendingApproval","name":"Retrieves payments which were parked due to technical exceptions, manually actioned and hence awaiting approval","summary":"Retrieves the modified parked payments to release awaiting approval","tags":["OTHERS"],"parameters":[{"name":"clearingTransactionType","in":"query","type":"string","required":false,"description":"Indicates the Clearing transaction type."},{"name":"creditCustomerId","in":"query","type":"string","required":false,"description":"Creditor customer id details"},{"name":"customerOrBankTransfer","in":"query","type":"string","required":false,"description":"Indicates if the payment was initiated by Customer or the financial institution"},{"name":"customerSpecifiedReference","in":"query","type":"string","required":false,"description":"Deprecated - Customer specified reference"},{"name":"debitCustomerId","in":"query","type":"string","required":false,"description":"Debtor customer details"},{"name":"paymentDirection","in":"query","type":"string","required":false,"description":"Indicates the direction of payment i.e. incoming, outgoing, book or redirect"},{"name":"endToEndReference","in":"query","type":"string","required":false,"description":"Indicates the end to end reference for the payment. This field can be provided by the person who instructs the payment and this flows through the lifecycle of the payment."},{"name":"entryDateTime","in":"query","type":"string","required":false,"description":"Contains the payment creation time"},{"name":"fileSendersReference","in":"query","type":"string","required":false,"description":"Indicates the sender reference that comes from the inward payment file"},{"name":"paymentId","in":"query","type":"string","required":false,"description":"Indicates the unique reference number of the payment"},{"name":"incomingMessageType","in":"query","type":"string","required":false,"description":"Indicates the supported message type to be received from the clearing house or the direct participant."},{"name":"company","in":"query","type":"string","required":false,"description":"The company code"},{"name":"processingDate","in":"query","type":"string","required":false,"description":"The date when payment instruction is processed in system."},{"name":"partySendersReferenceIncoming","in":"query","type":"string","required":false,"description":"Debtor payment reference details of incoming"},{"name":"partySendersReferenceOutgoing","in":"query","type":"string","required":false,"description":"Debtor payment reference details of outgoing"},{"name":"statusCode","in":"query","type":"string","required":false,"description":"Status code, as defined by the institution"},{"name":"transactionAmount","in":"query","type":"string","required":false,"description":"Contains the transaction amount. This is based on the currency, either local or foreign currency"},{"name":"transactionCurrency","in":"query","type":"string","required":false,"description":"Indicates the currency of the transaction. For example GBP, USD etc."},{"name":"transactionReference","in":"query","type":"string","required":false,"description":"Contains the identifier for the transaction in the core system"},{"name":"valueDate","in":"query","type":"string","required":false,"description":"Contains the value date of the claim or the date on which the amount to be claimed"},{"name":"paymentSource","in":"query","type":"string","required":false,"description":"Indicates the source from where the payment is originated"},{"name":"channel","in":"query","type":"string","required":false,"description":"Contains the channel in which the activity was performed. If pricing is not determined based on channel, then this is not significant"},{"name":"senderBankBic","in":"query","type":"string","required":false,"description":"Indicates the sending bank BIC Code"},{"name":"receiver","in":"query","type":"string","required":false,"description":"Identifies the receiver of the message"},{"name":"debtorAccountId","in":"query","type":"string","required":false,"description":"Contains the identification assigned by an institution to identify a debtor account by the account owner."},{"name":"beneficiaryAccountId","in":"query","type":"string","required":false,"description":"Unique account identifier of the beneficiary account number."},{"name":"scheme","in":"query","type":"string","required":false,"description":"Represents the scheme (a synonym for the National ID type) under which the National ID is defined"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"ParkedPaymentsReleasedPendingApprovalResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/order/payments/parent/technicalExceptions/pendingApprovals","fullPath":"/api/v1.2.0/order/payments/parent/technicalExceptions/pendingApprovals","operationId":"getParentParkedPaymentsReleasedPendingApproval","name":"Retrieves the list of payments modified due to technical failure from the parked payment queue and waiting for approvals.","summary":"Retrieves the modified parent parked payments released and waiting for approvals","tags":["OTHERS"],"parameters":[{"name":"clearingTransactionType","in":"query","type":"string","required":false,"description":"Indicates the Clearing transaction type."},{"name":"creditCustomerId","in":"query","type":"string","required":false,"description":"Creditor customer id details"},{"name":"customerOrBankTransfer","in":"query","type":"string","required":false,"description":"Indicates if the payment was initiated by Customer or the financial institution"},{"name":"customerSpecifiedReference","in":"query","type":"string","required":false,"description":"Deprecated - Customer specified reference"},{"name":"debitCustomerId","in":"query","type":"string","required":false,"description":"Debtor customer details"},{"name":"paymentDirection","in":"query","type":"string","required":false,"description":"Indicates the direction of payment i.e. incoming, outgoing, book or redirect"},{"name":"endToEndReference","in":"query","type":"string","required":false,"description":"Indicates the end to end reference for the payment. This field can be provided by the person who instructs the payment and this flows through the lifecycle of the payment."},{"name":"entryDateTime","in":"query","type":"string","required":false,"description":"Contains the payment creation time"},{"name":"fileSendersReference","in":"query","type":"string","required":false,"description":"Indicates the sender reference that comes from the inward payment file"},{"name":"paymentId","in":"query","type":"string","required":false,"description":"Indicates the unique reference number of the payment"},{"name":"incomingMessageType","in":"query","type":"string","required":false,"description":"Indicates the supported message type to be received from the clearing house or the direct participant."},{"name":"company","in":"query","type":"string","required":false,"description":"The company code"},{"name":"processingDate","in":"query","type":"string","required":false,"description":"The date when payment instruction is processed in system."},{"name":"partySendersReferenceIncoming","in":"query","type":"string","required":false,"description":"Debtor payment reference details of incoming"},{"name":"partySendersReferenceOutgoing","in":"query","type":"string","required":false,"description":"Debtor payment reference details of outgoing"},{"name":"statusCode","in":"query","type":"string","required":false,"description":"Status code, as defined by the institution"},{"name":"transactionAmount","in":"query","type":"string","required":false,"description":"Contains the transaction amount. This is based on the currency, either local or foreign currency"},{"name":"transactionCurrency","in":"query","type":"string","required":false,"description":"Indicates the currency of the transaction. For example GBP, USD etc."},{"name":"transactionReference","in":"query","type":"string","required":false,"description":"Contains the identifier for the transaction in the core system"},{"name":"valueDate","in":"query","type":"string","required":false,"description":"Contains the value date of the claim or the date on which the amount to be claimed"},{"name":"paymentSource","in":"query","type":"string","required":false,"description":"Indicates the source from where the payment is originated"},{"name":"channel","in":"query","type":"string","required":false,"description":"Contains the channel in which the activity was performed. If pricing is not determined based on channel, then this is not significant"},{"name":"senderBankBic","in":"query","type":"string","required":false,"description":"Indicates the sending bank BIC Code"},{"name":"receiver","in":"query","type":"string","required":false,"description":"Identifies the receiver of the message"},{"name":"debtorAccountId","in":"query","type":"string","required":false,"description":"Contains the identification assigned by an institution to identify a debtor account by the account owner."},{"name":"beneficiaryAccountId","in":"query","type":"string","required":false,"description":"Unique account identifier of the beneficiary account number."},{"name":"scheme","in":"query","type":"string","required":false,"description":"Represents the scheme (a synonym for the National ID type) under which the National ID is defined"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"ParentParkedPaymentsReleasedPendingApprovalResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/order/payments/cancellations/pendingApprovals","fullPath":"/api/v1.2.0/order/payments/cancellations/pendingApprovals","operationId":"getReversalPaymentsPendingApproval","name":"Retrieves the list of payments cancelled by an operator and waiting for approvals","summary":"Retrieves unapproved payment cancellations","tags":["OTHERS"],"parameters":[{"name":"clearingTransactionType","in":"query","type":"string","required":false,"description":"Indicates the Clearing transaction type."},{"name":"creditCustomerId","in":"query","type":"string","required":false,"description":"Creditor customer id details"},{"name":"customerOrBankTransfer","in":"query","type":"string","required":false,"description":"Indicates if the payment was initiated by Customer or the financial institution"},{"name":"customerSpecifiedReference","in":"query","type":"string","required":false,"description":"Deprecated - Customer specified reference"},{"name":"debitCustomerId","in":"query","type":"string","required":false,"description":"Debtor customer details"},{"name":"paymentDirection","in":"query","type":"string","required":false,"description":"Indicates the direction of payment i.e. incoming, outgoing, book or redirect"},{"name":"endToEndReference","in":"query","type":"string","required":false,"description":"Indicates the end to end reference for the payment. This field can be provided by the person who instructs the payment and this flows through the lifecycle of the payment."},{"name":"entryDateTime","in":"query","type":"string","required":false,"description":"Contains the payment creation time"},{"name":"fileSendersReference","in":"query","type":"string","required":false,"description":"Indicates the sender reference that comes from the inward payment file"},{"name":"paymentId","in":"query","type":"string","required":false,"description":"Indicates the unique reference number of the payment"},{"name":"incomingMessageType","in":"query","type":"string","required":false,"description":"Indicates the supported message type to be received from the clearing house or the direct participant."},{"name":"company","in":"query","type":"string","required":false,"description":"The company code"},{"name":"processingDate","in":"query","type":"string","required":false,"description":"The date when payment instruction is processed in system."},{"name":"partySendersReferenceIncoming","in":"query","type":"string","required":false,"description":"Debtor payment reference details of incoming"},{"name":"partySendersReferenceOutgoing","in":"query","type":"string","required":false,"description":"Debtor payment reference details of outgoing"},{"name":"statusCode","in":"query","type":"string","required":false,"description":"Status code, as defined by the institution"},{"name":"transactionAmount","in":"query","type":"string","required":false,"description":"Contains the transaction amount. This is based on the currency, either local or foreign currency"},{"name":"transactionCurrency","in":"query","type":"string","required":false,"description":"Indicates the currency of the transaction. For example GBP, USD etc."},{"name":"transactionReference","in":"query","type":"string","required":false,"description":"Contains the identifier for the transaction in the core system"},{"name":"valueDate","in":"query","type":"string","required":false,"description":"Contains the value date of the claim or the date on which the amount to be claimed"},{"name":"paymentSource","in":"query","type":"string","required":false,"description":"Indicates the source from where the payment is originated"},{"name":"channel","in":"query","type":"string","required":false,"description":"Contains the channel in which the activity was performed. If pricing is not determined based on channel, then this is not significant"},{"name":"senderBankBic","in":"query","type":"string","required":false,"description":"Indicates the sending bank BIC Code"},{"name":"receiver","in":"query","type":"string","required":false,"description":"Identifies the receiver of the message"},{"name":"debtorAccountId","in":"query","type":"string","required":false,"description":"Contains the identification assigned by an institution to identify a debtor account by the account owner."},{"name":"beneficiaryAccountId","in":"query","type":"string","required":false,"description":"Unique account identifier of the beneficiary account number."},{"name":"scheme","in":"query","type":"string","required":false,"description":"Represents the scheme (a synonym for the National ID type) under which the National ID is defined"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"ReversalPaymentsPendingApprovalResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/order/payments/cover/redirects/returns/pendingApprovals","fullPath":"/api/v1.2.0/order/payments/cover/redirects/returns/pendingApprovals","operationId":"getInwardReturnRedirectCoverPaymentsPendingAuth","name":"Retrieves the list of return transactions settled via cover(redirected) which is actioned and waiting for approvals","summary":"Retrieves return transactions settled via cover(redirected) which is actioned and waiting for approvals","tags":["OTHERS"],"parameters":[{"name":"clearingTransactionType","in":"query","type":"string","required":false,"description":"Indicates the Clearing transaction type."},{"name":"creditCustomerId","in":"query","type":"string","required":false,"description":"Creditor customer id details"},{"name":"customerOrBankTransfer","in":"query","type":"string","required":false,"description":"Indicates if the payment was initiated by Customer or the financial institution"},{"name":"customerSpecifiedReference","in":"query","type":"string","required":false,"description":"Deprecated - Customer specified reference"},{"name":"debitCustomerId","in":"query","type":"string","required":false,"description":"Debtor customer details"},{"name":"paymentDirection","in":"query","type":"string","required":false,"description":"Indicates the direction of payment i.e. incoming, outgoing, book or redirect"},{"name":"endToEndReference","in":"query","type":"string","required":false,"description":"Indicates the end to end reference for the payment. This field can be provided by the person who instructs the payment and this flows through the lifecycle of the payment."},{"name":"entryDateTime","in":"query","type":"string","required":false,"description":"Contains the payment creation time"},{"name":"fileSendersReference","in":"query","type":"string","required":false,"description":"Indicates the sender reference that comes from the inward payment file"},{"name":"paymentId","in":"query","type":"string","required":false,"description":"Indicates the unique reference number of the payment"},{"name":"incomingMessageType","in":"query","type":"string","required":false,"description":"Indicates the supported message type to be received from the clearing house or the direct participant."},{"name":"company","in":"query","type":"string","required":false,"description":"The company code"},{"name":"processingDate","in":"query","type":"string","required":false,"description":"The date when payment instruction is processed in system."},{"name":"partySendersReferenceIncoming","in":"query","type":"string","required":false,"description":"Debtor payment reference details of incoming"},{"name":"partySendersReferenceOutgoing","in":"query","type":"string","required":false,"description":"Debtor payment reference details of outgoing"},{"name":"statusCode","in":"query","type":"string","required":false,"description":"Status code, as defined by the institution"},{"name":"transactionAmount","in":"query","type":"string","required":false,"description":"Contains the transaction amount. This is based on the currency, either local or foreign currency"},{"name":"transactionCurrency","in":"query","type":"string","required":false,"description":"Indicates the currency of the transaction. For example GBP, USD etc."},{"name":"transactionReference","in":"query","type":"string","required":false,"description":"Contains the identifier for the transaction in the core system"},{"name":"paymentSource","in":"query","type":"string","required":false,"description":"Indicates the source from where the payment is originated"},{"name":"channel","in":"query","type":"string","required":false,"description":"Contains the channel in which the activity was performed. If pricing is not determined based on channel, then this is not significant"},{"name":"senderBankBic","in":"query","type":"string","required":false,"description":"Indicates the sending bank BIC Code"},{"name":"receiver","in":"query","type":"string","required":false,"description":"Identifies the receiver of the message"},{"name":"debtorAccountId","in":"query","type":"string","required":false,"description":"Contains the identification assigned by an institution to identify a debtor account by the account owner."},{"name":"beneficiaryAccountId","in":"query","type":"string","required":false,"description":"Unique account identifier of the beneficiary account number."},{"name":"scheme","in":"query","type":"string","required":false,"description":"Represents the scheme (a synonym for the National ID type) under which the National ID is defined"},{"name":"valueDate","in":"query","type":"string","required":false,"description":"Contains the value date of the claim or the date on which the amount to be claimed"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"InwardReturnRedirectCoverPaymentsPendingAuthResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/order/payments/clearings/cancellations/pendingApprovals","fullPath":"/api/v1.2.0/order/payments/clearings/cancellations/pendingApprovals","operationId":"getPendingClearingCancellationApprovals","name":"Retrieves the list of payments that are cancelled before distribution to clearing and waiting for approval","summary":"Retrieves unapproved payments cancelled before distribution to clearing","tags":["OTHERS"],"parameters":[{"name":"clearingTransactionType","in":"query","type":"string","required":false,"description":"Indicates the Clearing transaction type."},{"name":"creditCustomerId","in":"query","type":"string","required":false,"description":"Creditor customer id details"},{"name":"customerOrBankTransfer","in":"query","type":"string","required":false,"description":"Indicates if the payment was initiated by Customer or the financial institution"},{"name":"customerSpecifiedReference","in":"query","type":"string","required":false,"description":"Deprecated - Customer specified reference"},{"name":"debitCustomerId","in":"query","type":"string","required":false,"description":"Debtor customer details"},{"name":"paymentDirection","in":"query","type":"string","required":false,"description":"Indicates the direction of payment i.e. incoming, outgoing, book or redirect"},{"name":"endToEndReference","in":"query","type":"string","required":false,"description":"Indicates the end to end reference for the payment. This field can be provided by the person who instructs the payment and this flows through the lifecycle of the payment."},{"name":"entryDateTime","in":"query","type":"string","required":false,"description":"Contains the payment creation time"},{"name":"fileSendersReference","in":"query","type":"string","required":false,"description":"Indicates the sender reference that comes from the inward payment file"},{"name":"paymentId","in":"query","type":"string","required":false,"description":"Indicates the unique reference number of the payment"},{"name":"incomingMessageType","in":"query","type":"string","required":false,"description":"Indicates the supported message type to be received from the clearing house or the direct participant."},{"name":"company","in":"query","type":"string","required":false,"description":"The company code"},{"name":"processingDate","in":"query","type":"string","required":false,"description":"The date when payment instruction is processed in system."},{"name":"partySendersReferenceIncoming","in":"query","type":"string","required":false,"description":"Debtor payment reference details of incoming"},{"name":"partySendersReferenceOutgoing","in":"query","type":"string","required":false,"description":"Debtor payment reference details of outgoing"},{"name":"statusCode","in":"query","type":"string","required":false,"description":"Status code, as defined by the institution"},{"name":"transactionAmount","in":"query","type":"string","required":false,"description":"Contains the transaction amount. This is based on the currency, either local or foreign currency"},{"name":"transactionCurrency","in":"query","type":"string","required":false,"description":"Indicates the currency of the transaction. For example GBP, USD etc."},{"name":"transactionReference","in":"query","type":"string","required":false,"description":"Contains the identifier for the transaction in the core system"},{"name":"paymentSource","in":"query","type":"string","required":false,"description":"Indicates the source from where the payment is originated"},{"name":"channel","in":"query","type":"string","required":false,"description":"Contains the channel in which the activity was performed. If pricing is not determined based on channel, then this is not significant"},{"name":"senderBankBic","in":"query","type":"string","required":false,"description":"Indicates the sending bank BIC Code"},{"name":"receiver","in":"query","type":"string","required":false,"description":"Identifies the receiver of the message"},{"name":"debtorAccountId","in":"query","type":"string","required":false,"description":"Contains the identification assigned by an institution to identify a debtor account by the account owner."},{"name":"beneficiaryAccountId","in":"query","type":"string","required":false,"description":"Unique account identifier of the beneficiary account number."},{"name":"scheme","in":"query","type":"string","required":false,"description":"Represents the scheme (a synonym for the National ID type) under which the National ID is defined"},{"name":"valueDate","in":"query","type":"string","required":false,"description":"Contains the value date of the claim or the date on which the amount to be claimed"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"PendingClearingCancellationApprovalsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/order/payments/swift/exceptions/pendingApprovals","fullPath":"/api/v1.2.0/order/payments/swift/exceptions/pendingApprovals","operationId":"getSwiftOutExceptionPaymentsPendingApproval","name":"Retrieves outward SWIFT payments which went into exception due to reject/nacks, have been manually actioned and  awaiting approval","summary":"Retrieves modified SWIFT out exception payments awaiting approval","tags":["OTHERS"],"parameters":[{"name":"clearingTransactionType","in":"query","type":"string","required":false,"description":"Indicates the Clearing transaction type."},{"name":"creditCustomerId","in":"query","type":"string","required":false,"description":"Creditor customer id details"},{"name":"customerOrBankTransfer","in":"query","type":"string","required":false,"description":"Indicates if the payment was initiated by Customer or the financial institution"},{"name":"customerSpecifiedReference","in":"query","type":"string","required":false,"description":"Deprecated - Customer specified reference"},{"name":"debitCustomerId","in":"query","type":"string","required":false,"description":"Debtor customer details"},{"name":"paymentDirection","in":"query","type":"string","required":false,"description":"Indicates the direction of payment i.e. incoming, outgoing, book or redirect"},{"name":"endToEndReference","in":"query","type":"string","required":false,"description":"Indicates the end to end reference for the payment. This field can be provided by the person who instructs the payment and this flows through the lifecycle of the payment."},{"name":"entryDateTime","in":"query","type":"string","required":false,"description":"Contains the payment creation time"},{"name":"fileSendersReference","in":"query","type":"string","required":false,"description":"Indicates the sender reference that comes from the inward payment file"},{"name":"paymentId","in":"query","type":"string","required":false,"description":"Indicates the unique reference number of the payment"},{"name":"incomingMessageType","in":"query","type":"string","required":false,"description":"Indicates the supported message type to be received from the clearing house or the direct participant."},{"name":"company","in":"query","type":"string","required":false,"description":"The company code"},{"name":"processingDate","in":"query","type":"string","required":false,"description":"The date when payment instruction is processed in system."},{"name":"partySendersReferenceIncoming","in":"query","type":"string","required":false,"description":"Debtor payment reference details of incoming"},{"name":"partySendersReferenceOutgoing","in":"query","type":"string","required":false,"description":"Debtor payment reference details of outgoing"},{"name":"statusCode","in":"query","type":"string","required":false,"description":"Status code, as defined by the institution"},{"name":"transactionAmount","in":"query","type":"string","required":false,"description":"Contains the transaction amount. This is based on the currency, either local or foreign currency"},{"name":"transactionCurrency","in":"query","type":"string","required":false,"description":"Indicates the currency of the transaction. For example GBP, USD etc."},{"name":"transactionReference","in":"query","type":"string","required":false,"description":"Contains the identifier for the transaction in the core system"},{"name":"paymentSource","in":"query","type":"string","required":false,"description":"Indicates the source from where the payment is originated"},{"name":"channel","in":"query","type":"string","required":false,"description":"Contains the channel in which the activity was performed. If pricing is not determined based on channel, then this is not significant"},{"name":"senderBankBic","in":"query","type":"string","required":false,"description":"Indicates the sending bank BIC Code"},{"name":"receiver","in":"query","type":"string","required":false,"description":"Identifies the receiver of the message"},{"name":"debtorAccountId","in":"query","type":"string","required":false,"description":"Contains the identification assigned by an institution to identify a debtor account by the account owner."},{"name":"beneficiaryAccountId","in":"query","type":"string","required":false,"description":"Unique account identifier of the beneficiary account number."},{"name":"scheme","in":"query","type":"string","required":false,"description":"Represents the scheme (a synonym for the National ID type) under which the National ID is defined"},{"name":"valueDate","in":"query","type":"string","required":false,"description":"Contains the value date of the claim or the date on which the amount to be claimed"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"SwiftOutExceptionPaymentsPendingApprovalResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/order/payments/swift/returns/pendingApprovals","fullPath":"/api/v1.2.0/order/payments/swift/returns/pendingApprovals","operationId":"getReturnSettledSwiftPaymentsPendingApproval","name":"Retrieves the list of SWIFT return transaction and awaiting approval","summary":"Retrieves returns of completed SWIFT transactions  that are awaiting approval","tags":["OTHERS"],"parameters":[{"name":"clearingTransactionType","in":"query","type":"string","required":false,"description":"Indicates the Clearing transaction type."},{"name":"creditCustomerId","in":"query","type":"string","required":false,"description":"Creditor customer id details"},{"name":"customerOrBankTransfer","in":"query","type":"string","required":false,"description":"Indicates if the payment was initiated by Customer or the financial institution"},{"name":"customerSpecifiedReference","in":"query","type":"string","required":false,"description":"Deprecated - Customer specified reference"},{"name":"debitCustomerId","in":"query","type":"string","required":false,"description":"Debtor customer details"},{"name":"paymentDirection","in":"query","type":"string","required":false,"description":"Indicates the direction of payment i.e. incoming, outgoing, book or redirect"},{"name":"endToEndReference","in":"query","type":"string","required":false,"description":"Indicates the end to end reference for the payment. This field can be provided by the person who instructs the payment and this flows through the lifecycle of the payment."},{"name":"entryDateTime","in":"query","type":"string","required":false,"description":"Contains the payment creation time"},{"name":"fileSendersReference","in":"query","type":"string","required":false,"description":"Indicates the sender reference that comes from the inward payment file"},{"name":"paymentId","in":"query","type":"string","required":false,"description":"Indicates the unique reference number of the payment"},{"name":"incomingMessageType","in":"query","type":"string","required":false,"description":"Indicates the supported message type to be received from the clearing house or the direct participant."},{"name":"company","in":"query","type":"string","required":false,"description":"The company code"},{"name":"processingDate","in":"query","type":"string","required":false,"description":"The date when payment instruction is processed in system."},{"name":"partySendersReferenceIncoming","in":"query","type":"string","required":false,"description":"Debtor payment reference details of incoming"},{"name":"partySendersReferenceOutgoing","in":"query","type":"string","required":false,"description":"Debtor payment reference details of outgoing"},{"name":"statusCode","in":"query","type":"string","required":false,"description":"Status code, as defined by the institution"},{"name":"transactionAmount","in":"query","type":"string","required":false,"description":"Contains the transaction amount. This is based on the currency, either local or foreign currency"},{"name":"transactionCurrency","in":"query","type":"string","required":false,"description":"Indicates the currency of the transaction. For example GBP, USD etc."},{"name":"transactionReference","in":"query","type":"string","required":false,"description":"Contains the identifier for the transaction in the core system"},{"name":"paymentSource","in":"query","type":"string","required":false,"description":"Indicates the source from where the payment is originated"},{"name":"channel","in":"query","type":"string","required":false,"description":"Contains the channel in which the activity was performed. If pricing is not determined based on channel, then this is not significant"},{"name":"senderBankBic","in":"query","type":"string","required":false,"description":"Indicates the sending bank BIC Code"},{"name":"receiver","in":"query","type":"string","required":false,"description":"Identifies the receiver of the message"},{"name":"debtorAccountId","in":"query","type":"string","required":false,"description":"Contains the identification assigned by an institution to identify a debtor account by the account owner."},{"name":"beneficiaryAccountId","in":"query","type":"string","required":false,"description":"Unique account identifier of the beneficiary account number."},{"name":"scheme","in":"query","type":"string","required":false,"description":"Represents the scheme (a synonym for the National ID type) under which the National ID is defined"},{"name":"valueDate","in":"query","type":"string","required":false,"description":"Contains the value date of the claim or the date on which the amount to be claimed"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"ReturnSettledSwiftPaymentsPendingApprovalResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/order/payments/cover/pendingApprovals","fullPath":"/api/v1.2.0/order/payments/cover/pendingApprovals","operationId":"getCoverPaymentsPendingApproval","name":"Retrieves announcement message that are manually matched with cover and  awaiting approval","summary":"Retrieves pending payments for cover that are awaiting approval","tags":["OTHERS"],"parameters":[{"name":"clearingTransactionType","in":"query","type":"string","required":false,"description":"Indicates the Clearing transaction type."},{"name":"creditCustomerId","in":"query","type":"string","required":false,"description":"Creditor customer id details"},{"name":"customerOrBankTransfer","in":"query","type":"string","required":false,"description":"Indicates if the payment was initiated by Customer or the financial institution"},{"name":"customerSpecifiedReference","in":"query","type":"string","required":false,"description":"Deprecated - Customer specified reference"},{"name":"debitCustomerId","in":"query","type":"string","required":false,"description":"Debtor customer details"},{"name":"paymentDirection","in":"query","type":"string","required":false,"description":"Indicates the direction of payment i.e. incoming, outgoing, book or redirect"},{"name":"endToEndReference","in":"query","type":"string","required":false,"description":"Indicates the end to end reference for the payment. This field can be provided by the person who instructs the payment and this flows through the lifecycle of the payment."},{"name":"entryDateTime","in":"query","type":"string","required":false,"description":"Contains the payment creation time"},{"name":"fileSendersReference","in":"query","type":"string","required":false,"description":"Indicates the sender reference that comes from the inward payment file"},{"name":"paymentId","in":"query","type":"string","required":false,"description":"Indicates the unique reference number of the payment"},{"name":"incomingMessageType","in":"query","type":"string","required":false,"description":"Indicates the supported message type to be received from the clearing house or the direct participant."},{"name":"company","in":"query","type":"string","required":false,"description":"The company code"},{"name":"processingDate","in":"query","type":"string","required":false,"description":"The date when payment instruction is processed in system."},{"name":"partySendersReferenceIncoming","in":"query","type":"string","required":false,"description":"Debtor payment reference details of incoming"},{"name":"partySendersReferenceOutgoing","in":"query","type":"string","required":false,"description":"Debtor payment reference details of outgoing"},{"name":"statusCode","in":"query","type":"string","required":false,"description":"Status code, as defined by the institution"},{"name":"transactionAmount","in":"query","type":"string","required":false,"description":"Contains the transaction amount. This is based on the currency, either local or foreign currency"},{"name":"transactionCurrency","in":"query","type":"string","required":false,"description":"Indicates the currency of the transaction. For example GBP, USD etc."},{"name":"transactionReference","in":"query","type":"string","required":false,"description":"Contains the identifier for the transaction in the core system"},{"name":"paymentSource","in":"query","type":"string","required":false,"description":"Indicates the source from where the payment is originated"},{"name":"channel","in":"query","type":"string","required":false,"description":"Contains the channel in which the activity was performed. If pricing is not determined based on channel, then this is not significant"},{"name":"senderBankBic","in":"query","type":"string","required":false,"description":"Indicates the sending bank BIC Code"},{"name":"receiver","in":"query","type":"string","required":false,"description":"Identifies the receiver of the message"},{"name":"debtorAccountId","in":"query","type":"string","required":false,"description":"Contains the identification assigned by an institution to identify a debtor account by the account owner."},{"name":"beneficiaryAccountId","in":"query","type":"string","required":false,"description":"Unique account identifier of the beneficiary account number."},{"name":"scheme","in":"query","type":"string","required":false,"description":"Represents the scheme (a synonym for the National ID type) under which the National ID is defined"},{"name":"valueDate","in":"query","type":"string","required":false,"description":"Contains the value date of the claim or the date on which the amount to be claimed"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"CoverPaymentsPendingApprovalResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/order/payments/swift/returns/settlements/pendingApprovals","fullPath":"/api/v1.2.0/order/payments/swift/returns/settlements/pendingApprovals","operationId":"getRetunReversalSwiftPaymentsPendingApproval","name":"Retrieves the list of return or reversal inward SWIFT MT return waiting for approval","summary":"Retrieves  SWIFT return or reversal received and awaiting approval","tags":["OTHERS"],"parameters":[{"name":"clearingTransactionType","in":"query","type":"string","required":false,"description":"Indicates the Clearing transaction type."},{"name":"creditCustomerId","in":"query","type":"string","required":false,"description":"Creditor customer id details"},{"name":"customerOrBankTransfer","in":"query","type":"string","required":false,"description":"Indicates if the payment was initiated by Customer or the financial institution"},{"name":"customerSpecifiedReference","in":"query","type":"string","required":false,"description":"Deprecated - Customer specified reference"},{"name":"debitCustomerId","in":"query","type":"string","required":false,"description":"Debtor customer details"},{"name":"paymentDirection","in":"query","type":"string","required":false,"description":"Indicates the direction of payment i.e. incoming, outgoing, book or redirect"},{"name":"endToEndReference","in":"query","type":"string","required":false,"description":"Indicates the end to end reference for the payment. This field can be provided by the person who instructs the payment and this flows through the lifecycle of the payment."},{"name":"entryDateTime","in":"query","type":"string","required":false,"description":"Contains the payment creation time"},{"name":"fileSendersReference","in":"query","type":"string","required":false,"description":"Indicates the sender reference that comes from the inward payment file"},{"name":"paymentId","in":"query","type":"string","required":false,"description":"Indicates the unique reference number of the payment"},{"name":"incomingMessageType","in":"query","type":"string","required":false,"description":"Indicates the supported message type to be received from the clearing house or the direct participant."},{"name":"company","in":"query","type":"string","required":false,"description":"The company code"},{"name":"processingDate","in":"query","type":"string","required":false,"description":"The date when payment instruction is processed in system."},{"name":"partySendersReferenceIncoming","in":"query","type":"string","required":false,"description":"Debtor payment reference details of incoming"},{"name":"partySendersReferenceOutgoing","in":"query","type":"string","required":false,"description":"Debtor payment reference details of outgoing"},{"name":"statusCode","in":"query","type":"string","required":false,"description":"Status code, as defined by the institution"},{"name":"transactionAmount","in":"query","type":"string","required":false,"description":"Contains the transaction amount. This is based on the currency, either local or foreign currency"},{"name":"transactionCurrency","in":"query","type":"string","required":false,"description":"Indicates the currency of the transaction. For example GBP, USD etc."},{"name":"transactionReference","in":"query","type":"string","required":false,"description":"Contains the identifier for the transaction in the core system"},{"name":"paymentSource","in":"query","type":"string","required":false,"description":"Indicates the source from where the payment is originated"},{"name":"channel","in":"query","type":"string","required":false,"description":"Contains the channel in which the activity was performed. If pricing is not determined based on channel, then this is not significant"},{"name":"senderBankBic","in":"query","type":"string","required":false,"description":"Indicates the sending bank BIC Code"},{"name":"receiver","in":"query","type":"string","required":false,"description":"Identifies the receiver of the message"},{"name":"debtorAccountId","in":"query","type":"string","required":false,"description":"Contains the identification assigned by an institution to identify a debtor account by the account owner."},{"name":"beneficiaryAccountId","in":"query","type":"string","required":false,"description":"Unique account identifier of the beneficiary account number."},{"name":"scheme","in":"query","type":"string","required":false,"description":"Represents the scheme (a synonym for the National ID type) under which the National ID is defined"},{"name":"valueDate","in":"query","type":"string","required":false,"description":"Contains the value date of the claim or the date on which the amount to be claimed"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"RetunReversalSwiftPaymentsPendingApprovalResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/order/payments/swift/iso/exceptions/pendingApprovals","fullPath":"/api/v1.2.0/order/payments/swift/iso/exceptions/pendingApprovals","operationId":"getSwiftISOExceptionsPaymentsPendingApprovals","name":"Retrieves SWIFT MX payments that were sent but rejected by SWIFT and then modified to be resent. They await approval as they were manually actioned","summary":"Retrieves SWIFT MX payments modified due to rejects from SWIFT and awaiting approval","tags":["OTHERS"],"parameters":[{"name":"company","in":"query","type":"string","required":false,"description":"The company code"},{"name":"paymentId","in":"query","type":"string","required":false,"description":"Indicates the unique reference number of the payment"},{"name":"sendersReference","in":"query","type":"string","required":false,"description":"Indicates the incoming sender's reference i.e. tag 20 of incoming SWIFT or in case when transaction is received from other system/ application, this can also indicate the reference number of that syst"},{"name":"bulkReference","in":"query","type":"string","required":false,"description":"Contains bulk master reference for the payment."},{"name":"negativeAcknowledgementReason","in":"query","type":"string","required":false,"description":"Contains the  ISO reason code received in technical ack/nack messages"},{"name":"messageType","in":"query","type":"string","required":false,"description":"Contains the message type of the information request."},{"name":"transactionAmount","in":"query","type":"string","required":false,"description":"Contains the transaction amount. This is based on the currency, either local or foreign currency"},{"name":"transactionCurrency","in":"query","type":"string","required":false,"description":"Indicates the currency of the transaction. For example GBP, USD etc."},{"name":"paymentMsgSentDate","in":"query","type":"string","required":false,"description":"Indicates the date on which payment message (MT103, MT202) is sent out to the receiving bank or clearing."},{"name":"errorCode","in":"query","type":"string","required":false,"description":"Indicates the error code which is encountered during payment processing as returned by payment system "},{"name":"statusCode","in":"query","type":"string","required":false,"description":"Status code, as defined by the institution"},{"name":"channel","in":"query","type":"string","required":false,"description":"Contains the channel in which the activity was performed. If pricing is not determined based on channel, then this is not significant"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"SwiftISOExceptionsPaymentsPendingApprovalsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/order/payments/claims/pendingApprovals","fullPath":"/api/v1.2.0/order/payments/claims/pendingApprovals","operationId":"getReceivedClaimsPendingApproval","name":"Retrieves SWIFT claims received that are pending for approval","summary":"Retrieves received claims","tags":["OTHERS"],"parameters":[{"name":"deliveryReference","in":"query","type":"string","required":false,"description":"Indicates the delivery reference Id generated for the activity"},{"name":"sendersReference","in":"query","type":"string","required":false,"description":"Indicates the incoming sender's reference i.e. tag 20 of incoming SWIFT or in case when transaction is received from other system/ application, this can also indicate the reference number of that syst"},{"name":"relatedReference","in":"query","type":"string","required":false,"description":"An external reference id for the transaction."},{"name":"transactionAmount","in":"query","type":"string","required":false,"description":"Contains the transaction amount. This is based on the currency, either local or foreign currency"},{"name":"orderingInstitutionAccount","in":"query","type":"string","required":false,"description":"Contains the National Clearing Code (NCC) or account number of the ordering institution."},{"name":"senderInstitutionBIC","in":"query","type":"string","required":false,"description":"Contains the Bank Identifier Code(BIC) of the bank which is sending the information request."},{"name":"accountWithInstitutionCode","in":"query","type":"string","required":false,"description":"Contains the Business Identifier Code (BIC) of the account with institution."},{"name":"statusCode","in":"query","type":"string","required":false,"description":"Status code, as defined by the institution"},{"name":"rejectRemark","in":"query","type":"string","required":false,"description":"Contains the remarks given for rejection."},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"ReceivedClaimsPendingApprovalResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/order/payments/riskFilters/pendingApprovals/levelTwo","fullPath":"/api/v1.2.0/order/payments/riskFilters/pendingApprovals/levelTwo","operationId":"getRiskFilterPendingLeveltwoApproval","name":"Retrieves payment which have breached counter party/currency threshold, manually released and  awaiting level two approval","summary":"Retrieves released risk filter breach payments awaiting level two approvals","tags":["OTHERS"],"parameters":[{"name":"recordId","in":"query","type":"string","required":false,"description":"record Id name for NOFILE enquiry for online upgrade"},{"name":"company","in":"query","type":"string","required":false,"description":"The company code"},{"name":"transactionReference","in":"query","type":"string","required":false,"description":"Contains the identifier for the transaction in the core system"},{"name":"filteringId","in":"query","type":"string","required":false,"description":"Indicates the filtering product of a payment. Examples: BKINCSKIP, AMTLT1000, INCOMING"},{"name":"transactionLimitAmount","in":"query","type":"string","required":false,"description":"Defines the limit amount at which each transaction will be monitored."},{"name":"breachInformation","in":"query","type":"string","required":false,"description":"Contains the information about any breach on Collateral"},{"name":"dailylimits","in":"query","type":"string","required":false,"description":"Name of the LookupsResponse Code"},{"name":"dueAmount","in":"query","type":"string","required":false,"description":"Indicates the amount which was made due for a period"},{"name":"limitAmount","in":"query","type":"string","required":false,"description":"The Limit amount that is actually available for use. The system limit checks are preformed against the online limit"},{"name":"limitExceed","in":"query","type":"string","required":false,"description":"Whether the total cash deposits or withdrawals has exceeded the threshold amount set."},{"name":"secondaryLimitAmount","in":"query","type":"string","required":false,"description":"Contains the secondary limit amount to be used for the purpose of secondary limit check"},{"name":"limitExcess","in":"query","type":"string","required":false,"description":"An indicator to show that a credit limit has been exceeded"},{"name":"cutOffDay","in":"query","type":"string","required":false,"description":"Indicates the last day for Global Payment Initiative (GPI) payments in a given currency"},{"name":"transactionAmount","in":"query","type":"string","required":false,"description":"Contains the transaction amount. This is based on the currency, either local or foreign currency"},{"name":"transactionCurrency","in":"query","type":"string","required":false,"description":"Indicates the currency of the transaction. For example GBP, USD etc."},{"name":"debitValueDate","in":"query","type":"string","required":false,"description":"Date on which the amount will be debited for settlement"},{"name":"creditValueDate","in":"query","type":"string","required":false,"description":"Reference quoted by the credit account for a payment"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"RiskFilterPendingLeveltwoApprovalResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/order/payments/sentFiles/transactions/pendingApprovals","fullPath":"/api/v1.2.0/order/payments/sentFiles/transactions/pendingApprovals","operationId":"getPaymentSentFilesTransactionsPendingApproval","name":"Retrieves the list of transactions modified due to clearing reject and waiting for approval","summary":"Retrieves clearing rejected payments transactions modified and waiting for approval","tags":["OTHERS"],"parameters":[{"name":"id","in":"query","type":"string","required":false,"description":"Contains the daily position class id."},{"name":"company","in":"query","type":"string","required":false,"description":"The company code"},{"name":"transactionReference","in":"query","type":"string","required":false,"description":"Contains the identifier for the transaction in the core system"},{"name":"sendersReference","in":"query","type":"string","required":false,"description":"Indicates the incoming sender's reference i.e. tag 20 of incoming SWIFT or in case when transaction is received from other system/ application, this can also indicate the reference number of that syst"},{"name":"dateTime","in":"query","type":"string","required":false,"description":"Contains the date and time separated by '-'"},{"name":"messageType","in":"query","type":"string","required":false,"description":"Contains the message type of the information request."},{"name":"messageContent","in":"query","type":"string","required":false,"description":"It indicates whether only the current information or previous and current information needs to be passed to form the message."},{"name":"acknowledgementStatus","in":"query","type":"string","required":false,"description":"Contains the code for ack/nack - accepted or rejected by the clearing. For example: 0 - success acknowledegement , 1 - failure negative acknowledgement"},{"name":"acceptMessage","in":"query","type":"string","required":false,"description":"Indicates whether the account officer will accept secure message."},{"name":"message","in":"query","type":"string","required":false,"description":"The actual Transact error message "},{"name":"deliveryReference","in":"query","type":"string","required":false,"description":"Indicates the delivery reference Id generated for the activity"},{"name":"originalfilereference","in":"query","type":"string","required":false,"description":"Indicates reference of the incoming file for which response is being sent"},{"name":"bulkReference","in":"query","type":"string","required":false,"description":"Contains bulk master reference for the payment."},{"name":"reasonCode","in":"query","type":"string","required":false,"description":"Contains the reason for raising the information request in a coded form."},{"name":"proprietaryTransactionCode","in":"query","type":"string","required":false,"description":"Contains the proprietary bank transaction code to identify the underlying transaction."},{"name":"statusCode","in":"query","type":"string","required":false,"description":"Status code, as defined by the institution"},{"name":"clearingDate","in":"query","type":"string","required":false,"description":"Contains the date from which the payment is expected and is used to indicate the exposure date for the payment."},{"name":"action","in":"query","type":"string","required":false,"description":"Refers to view or cancel options."},{"name":"settlementDate","in":"query","type":"string","required":false,"description":"Indicates the settlement date of the payment transaction"},{"name":"sendersBic","in":"query","type":"string","required":false,"description":"Deprecated - Sender's Bic code"},{"name":"sourceType","in":"query","type":"string","required":false,"description":"Indicates source type to determine base amount. Possible values are BALANCE (base amount of a property), ACTIVITY ( transaction amount against an activity) or PROPERTY (this type is currently not supp"},{"name":"messageId","in":"query","type":"string","required":false,"description":"The holds the record key of the message ID."},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"PaymentSentFilesTransactionsPendingApprovalResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/order/payments/screenings/pendingApprovals/levelOne","fullPath":"/api/v1.2.0/order/payments/screenings/pendingApprovals/levelOne","operationId":"getReleasedScreeningRequestsPendingLeveloneAuth","name":"Retrieves the list of transactions released from the screening queue by an operator and waiting for the first level of approval.","summary":"Retrieves released screening requests waiting first level approval","tags":["OTHERS"],"parameters":[{"name":"transactionReference","in":"query","type":"string","required":false,"description":"Contains the identifier for the transaction in the core system"},{"name":"dateSent","in":"query","type":"string","required":false,"description":"The date when the message is sent."},{"name":"timeStamp","in":"query","type":"string","required":false,"description":"Deprecated - Time Stamp"},{"name":"startTimestamp","in":"query","type":"string","required":false,"description":"Contains the timestamp at which the statement period starts."},{"name":"PaymentStatus","in":"query","type":"string","required":false,"description":"Describes the current status of the payment order in the payment system"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"ReleasedScreeningRequestsPendingLeveloneAuthResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/order/payments/screenings/pendingApprovals/levelTwo","fullPath":"/api/v1.2.0/order/payments/screenings/pendingApprovals/levelTwo","operationId":"getReleasedScreeningPendingLeveltwoApproval","name":"Retrieves payments which were sent to screening, were considered a hit,  manually actioned, approved once  and awaiting second level approval","summary":"Retrieves released screening requests awaiting second level approval","tags":["OTHERS"],"parameters":[{"name":"transactionReference","in":"query","type":"string","required":false,"description":"Contains the identifier for the transaction in the core system"},{"name":"dateSent","in":"query","type":"string","required":false,"description":"The date when the message is sent."},{"name":"timeStamp","in":"query","type":"string","required":false,"description":"Deprecated - Time Stamp"},{"name":"startTimestamp","in":"query","type":"string","required":false,"description":"Contains the timestamp at which the statement period starts."},{"name":"PaymentStatus","in":"query","type":"string","required":false,"description":"Describes the current status of the payment order in the payment system"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"ReleasedScreeningPendingLeveltwoApprovalResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/order/payments/sentFiles/bulks/pendingApprovals","fullPath":"/api/v1.2.0/order/payments/sentFiles/bulks/pendingApprovals","operationId":"getPaymentSentBulksPendingApproval","name":"Retrieves bulks that were rejected and modified to be sent and are awaiting approval.","summary":"Retrieves bulks modified to be sent and awaiting approval","tags":["OTHERS"],"parameters":[{"name":"id","in":"query","type":"string","required":false,"description":"Contains the daily position class id."},{"name":"company","in":"query","type":"string","required":false,"description":"The company code"},{"name":"originalfilereference","in":"query","type":"string","required":false,"description":"Indicates reference of the incoming file for which response is being sent"},{"name":"bulkReference","in":"query","type":"string","required":false,"description":"Contains bulk master reference for the payment."},{"name":"format","in":"query","type":"string","required":false,"description":"Indicates the formatting version to be used for the delivery message"},{"name":"paymentType","in":"query","type":"string","required":false,"description":"Indicates if the payment is Customer (C) type or Bank (B) type"},{"name":"sendersCorrespondentAddress","in":"query","type":"string","required":false,"description":"Contains additional address lines of the sender correspondent institution."},{"name":"receiversCorrespondentAddress","in":"query","type":"string","required":false,"description":"Contains additional address lines of the receiver correspondent institution."},{"name":"numberOfTransaction","in":"query","type":"string","required":false,"description":"Indicates the number of transactions performed on the contract or the account"},{"name":"settlementAmount","in":"query","type":"string","required":false,"description":"Amount of settlement"},{"name":"settlementCurrency","in":"query","type":"string","required":false,"description":"The currency of the trade settlement"},{"name":"settlementDate","in":"query","type":"string","required":false,"description":"Indicates the settlement date of the payment transaction"},{"name":"status","in":"query","type":"string","required":false,"description":"The status of the early maturity request"},{"name":"bulkReferenceId","in":"query","type":"string","required":false,"description":"Contains the bulk master reference for the payment."},{"name":"reasonCode","in":"query","type":"string","required":false,"description":"Contains the reason for raising the information request in a coded form."},{"name":"proprietaryTransactionCode","in":"query","type":"string","required":false,"description":"Contains the proprietary bank transaction code to identify the underlying transaction."},{"name":"statusCode","in":"query","type":"string","required":false,"description":"Status code, as defined by the institution"},{"name":"dateTime","in":"query","type":"string","required":false,"description":"Contains the date and time separated by '-'"},{"name":"action","in":"query","type":"string","required":false,"description":"Refers to view or cancel options."},{"name":"sourceType","in":"query","type":"string","required":false,"description":"Indicates source type to determine base amount. Possible values are BALANCE (base amount of a property), ACTIVITY ( transaction amount against an activity) or PROPERTY (this type is currently not supp"},{"name":"coverControl","in":"query","type":"string","required":false,"description":"Indicates whether the limit is applicable for the virtual accounts or not"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"PaymentSentBulksPendingApprovalResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/order/payments/sentFiles/files/pendingApprovals","fullPath":"/api/v1.2.0/order/payments/sentFiles/files/pendingApprovals","operationId":"getPaymentSentFilesPendingApproval","name":"Retrieves files that were rejected and  modified to be sent and are  awaiting approval","summary":"Retrieves files modified to be sent and awaiting approval","tags":["OTHERS"],"parameters":[{"name":"id","in":"query","type":"string","required":false,"description":"Contains the daily position class id."},{"name":"company","in":"query","type":"string","required":false,"description":"The company code"},{"name":"fileSendersReference","in":"query","type":"string","required":false,"description":"Indicates the sender reference that comes from the inward payment file"},{"name":"dateSent","in":"query","type":"string","required":false,"description":"The date when the message is sent."},{"name":"fileName","in":"query","type":"string","required":false,"description":"Identifies the type of methods to be listed. Possible values are FX.DEAL.METHOD, BROKER or blank."},{"name":"type","in":"query","type":"string","required":false,"description":"The product condition has an activity type associated that drives an action."},{"name":"typeIndicator","in":"query","type":"string","required":false,"description":"Indicates if the record is an Income or Expense"},{"name":"outputChannel","in":"query","type":"string","required":false,"description":"Contains the channel that will be used to send the outward payment message"},{"name":"creationDateTime","in":"query","type":"string","required":false,"description":"Date and Time of the message creation."},{"name":"status","in":"query","type":"string","required":false,"description":"The status of the early maturity request"},{"name":"numberOfTransaction","in":"query","type":"string","required":false,"description":"Indicates the number of transactions performed on the contract or the account"},{"name":"clearingStatus","in":"query","type":"string","required":false,"description":"Indicates if the status of the Clearing is Active, temporarily suspended or is altogether blocked."},{"name":"reasonCode","in":"query","type":"string","required":false,"description":"Contains the reason for raising the information request in a coded form."},{"name":"statusCode","in":"query","type":"string","required":false,"description":"Status code, as defined by the institution"},{"name":"dateTime","in":"query","type":"string","required":false,"description":"Contains the date and time separated by '-'"},{"name":"originalfilereference","in":"query","type":"string","required":false,"description":"Indicates reference of the incoming file for which response is being sent"},{"name":"sourceType","in":"query","type":"string","required":false,"description":"Indicates source type to determine base amount. Possible values are BALANCE (base amount of a property), ACTIVITY ( transaction amount against an activity) or PROPERTY (this type is currently not supp"},{"name":"clearingDate","in":"query","type":"string","required":false,"description":"Contains the date from which the payment is expected and is used to indicate the exposure date for the payment."},{"name":"receiversCorrespondentAddress","in":"query","type":"string","required":false,"description":"Contains additional address lines of the receiver correspondent institution."},{"name":"errorInfo","in":"query","type":"string","required":false,"description":"Contains the details of the error such as error source and error message"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"PaymentSentFilesPendingApprovalResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/order/payments/receivedFiles/bulks/pendingApprovals","fullPath":"/api/v1.2.0/order/payments/receivedFiles/bulks/pendingApprovals","operationId":"getReceivedBulksPendingApproval","name":"Retrieves payment file received and their bulk repaired manually and hence awaiting approval","summary":"Retrieves repaired  bulks awaiting approvals","tags":["OTHERS"],"parameters":[{"name":"recordId","in":"query","type":"string","required":false,"description":"record Id name for NOFILE enquiry for online upgrade"},{"name":"company","in":"query","type":"string","required":false,"description":"The company code"},{"name":"originalFileReference","in":"query","type":"string","required":false,"description":"Indicates reference of the incoming file for which response is being sent"},{"name":"bulkReference","in":"query","type":"string","required":false,"description":"Contains bulk master reference for the payment."},{"name":"bulkFileReferenceApi","in":"query","type":"string","required":false,"description":"Indicates the API that will be invoked to derive at the bulk and file reference if the clearing has a specific requirement."},{"name":"creationDateTime","in":"query","type":"string","required":false,"description":"Date and Time of the message creation."},{"name":"bulkTypeId","in":"query","type":"string","required":false,"description":"Identifier of the bulk update type record that holds default conditions required for Bulk Master creation. SINGLE and MULTI are two record references used by payment order application for processing p"},{"name":"bulkItemId","in":"query","type":"string","required":false,"description":"contains individual payment id of the Bulk upload"},{"name":"sendersCorrespondentAddress","in":"query","type":"string","required":false,"description":"Contains additional address lines of the sender correspondent institution."},{"name":"receiversCorrespondentCountry","in":"query","type":"string","required":false,"description":"Identifies the country of the receiver's correspondent"},{"name":"numberOfTransaction","in":"query","type":"string","required":false,"description":"Indicates the number of transactions performed on the contract or the account"},{"name":"settlementAmount","in":"query","type":"string","required":false,"description":"Amount of settlement"},{"name":"settlementCurrency","in":"query","type":"string","required":false,"description":"The currency of the trade settlement"},{"name":"settlementDate","in":"query","type":"string","required":false,"description":"Indicates the settlement date of the payment transaction"},{"name":"bulkMasterId","in":"query","type":"string","required":false,"description":"Uniquely identifies each bulk payment request.The reference number is automatically generated by the system."},{"name":"bulkReferenceId","in":"query","type":"string","required":false,"description":"Contains the bulk master reference for the payment."},{"name":"errorCode","in":"query","type":"string","required":false,"description":"Indicates the error code which is encountered during payment processing as returned by payment system "},{"name":"errorInfo","in":"query","type":"string","required":false,"description":"Contains the details of the error such as error source and error message"},{"name":"batchBookingPreferred","in":"query","type":"string","required":false,"description":"If batchBookingPrefered is set to true, then bulkType is defaulted to SINGLE (Single consolidated accounting entry on the debtor account). If set to false, then bulkType is defaulted to MULTI(Individu"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"ReceivedBulksPendingApprovalResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/order/payments/riskFilters/pendingApprovals/levelOne","fullPath":"/api/v1.2.0/order/payments/riskFilters/pendingApprovals/levelOne","operationId":"getRiskFilterPendingLevelOneApproval","name":"Retrieves payment which have breached counter party/currency threshold, manually released and  awaiting level one approval","summary":"Retrieves released risk filter breach payments awaiting level one approvals","tags":["OTHERS"],"parameters":[{"name":"company","in":"query","type":"string","required":false,"description":"The company code"},{"name":"transactionReference","in":"query","type":"string","required":false,"description":"Contains the identifier for the transaction in the core system"},{"name":"transactionAmount","in":"query","type":"string","required":false,"description":"Contains the transaction amount. This is based on the currency, either local or foreign currency"},{"name":"transactionCurrency","in":"query","type":"string","required":false,"description":"Indicates the currency of the transaction. For example GBP, USD etc."},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"RiskFilterPendingLevelOneApprovalResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}}]},{"key":"order-payments-operationalQueueListingClearings-v1.0.0","title":"Operational Queue Listing Clearings","version":"v1.0.0","description":"Retrieve the list of payments that are pending for acknowledment or cover from clearing or SWIFT","endpointCount":3,"endpoints":[{"method":"GET","path":"/order/payments/instant/clearingAcknowledgements/pendings","fullPath":"/api/v1.0.0/order/payments/instant/clearingAcknowledgements/pendings","operationId":"getUnconfirmedInstantPayments","name":"Retrieves the list of instant payments that are awaiting acknowledgement from clearing","summary":"Retrieves instant payments waiting for confirmation","tags":["OTHERS"],"parameters":[{"name":"clearingTransactionType","in":"query","type":"string","required":false,"description":"Indicates the Clearing transaction type."},{"name":"creditCustomerId","in":"query","type":"string","required":false,"description":"Creditor customer id details"},{"name":"customerOrBankTransfer","in":"query","type":"string","required":false,"description":"Indicates if the payment was initiated by Customer or the financial institution"},{"name":"customerSpecifiedReference","in":"query","type":"string","required":false,"description":"Deprecated - Customer specified reference"},{"name":"debitCustomerId","in":"query","type":"string","required":false,"description":"Debtor customer details"},{"name":"paymentDirection","in":"query","type":"string","required":false,"description":"Indicates the direction of payment i.e. incoming, outgoing, book or redirect"},{"name":"endToEndReference","in":"query","type":"string","required":false,"description":"Indicates the end to end reference for the payment. This field can be provided by the person who instructs the payment and this flows through the lifecycle of the payment."},{"name":"entryDateTime","in":"query","type":"string","required":false,"description":"Contains the payment creation time"},{"name":"fileSendersReference","in":"query","type":"string","required":false,"description":"Indicates the sender reference that comes from the inward payment file"},{"name":"paymentId","in":"query","type":"string","required":false,"description":"Indicates the unique reference number of the payment"},{"name":"incomingMessageType","in":"query","type":"string","required":false,"description":"Indicates the supported message type to be received from the clearing house or the direct participant."},{"name":"company","in":"query","type":"string","required":false,"description":"The company code"},{"name":"processingDate","in":"query","type":"string","required":false,"description":"The date when payment instruction is processed in system."},{"name":"partySendersReferenceIncoming","in":"query","type":"string","required":false,"description":"Debtor payment reference details of incoming"},{"name":"partySendersReferenceOutgoing","in":"query","type":"string","required":false,"description":"Debtor payment reference details of outgoing"},{"name":"statusCode","in":"query","type":"string","required":false,"description":"Status code, as defined by the institution"},{"name":"transactionAmount","in":"query","type":"string","required":false,"description":"Contains the transaction amount. This is based on the currency, either local or foreign currency"},{"name":"transactionCurrency","in":"query","type":"string","required":false,"description":"Indicates the currency of the transaction. For example GBP, USD etc."},{"name":"transactionReference","in":"query","type":"string","required":false,"description":"Contains the identifier for the transaction in the core system"},{"name":"valueDate","in":"query","type":"string","required":false,"description":"Contains the value date of the claim or the date on which the amount to be claimed"},{"name":"paymentSource","in":"query","type":"string","required":false,"description":"Indicates the source from where the payment is originated"},{"name":"channel","in":"query","type":"string","required":false,"description":"Contains the channel in which the activity was performed. If pricing is not determined based on channel, then this is not significant"},{"name":"senderBankBic","in":"query","type":"string","required":false,"description":"Indicates the sending bank BIC Code"},{"name":"receiver","in":"query","type":"string","required":false,"description":"Identifies the receiver of the message"},{"name":"debtorAccountId","in":"query","type":"string","required":false,"description":"Contains the identification assigned by an institution to identify a debtor account by the account owner."},{"name":"beneficiaryAccountId","in":"query","type":"string","required":false,"description":"Unique account identifier of the beneficiary account number."},{"name":"scheme","in":"query","type":"string","required":false,"description":"Represents the scheme (a synonym for the National ID type) under which the National ID is defined"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"UnconfirmedInstantPaymentsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/order/payments/swift/acknowledgements/pendings","fullPath":"/api/v1.0.0/order/payments/swift/acknowledgements/pendings","operationId":"getPaymentsPendingSwiftAcknowledgement","name":"Retrieves the list of payments that are waiting for acknowledgement from SWIFT","summary":"Retrieves payments waiting for SWIFT acknowledgement","tags":["OTHERS"],"parameters":[{"name":"clearingTransactionType","in":"query","type":"string","required":false,"description":"Indicates the Clearing transaction type."},{"name":"creditCustomerId","in":"query","type":"string","required":false,"description":"Creditor customer id details"},{"name":"customerOrBankTransfer","in":"query","type":"string","required":false,"description":"Indicates if the payment was initiated by Customer or the financial institution"},{"name":"customerSpecifiedReference","in":"query","type":"string","required":false,"description":"Deprecated - Customer specified reference"},{"name":"debitCustomerId","in":"query","type":"string","required":false,"description":"Debtor customer details"},{"name":"paymentDirection","in":"query","type":"string","required":false,"description":"Indicates the direction of payment i.e. incoming, outgoing, book or redirect"},{"name":"endToEndReference","in":"query","type":"string","required":false,"description":"Indicates the end to end reference for the payment. This field can be provided by the person who instructs the payment and this flows through the lifecycle of the payment."},{"name":"entryDateTime","in":"query","type":"string","required":false,"description":"Contains the payment creation time"},{"name":"fileSendersReference","in":"query","type":"string","required":false,"description":"Indicates the sender reference that comes from the inward payment file"},{"name":"paymentId","in":"query","type":"string","required":false,"description":"Indicates the unique reference number of the payment"},{"name":"incomingMessageType","in":"query","type":"string","required":false,"description":"Indicates the supported message type to be received from the clearing house or the direct participant."},{"name":"company","in":"query","type":"string","required":false,"description":"The company code"},{"name":"processingDate","in":"query","type":"string","required":false,"description":"The date when payment instruction is processed in system."},{"name":"partySendersReferenceIncoming","in":"query","type":"string","required":false,"description":"Debtor payment reference details of incoming"},{"name":"partySendersReferenceOutgoing","in":"query","type":"string","required":false,"description":"Debtor payment reference details of outgoing"},{"name":"statusCode","in":"query","type":"string","required":false,"description":"Status code, as defined by the institution"},{"name":"transactionAmount","in":"query","type":"string","required":false,"description":"Contains the transaction amount. This is based on the currency, either local or foreign currency"},{"name":"transactionCurrency","in":"query","type":"string","required":false,"description":"Indicates the currency of the transaction. For example GBP, USD etc."},{"name":"transactionReference","in":"query","type":"string","required":false,"description":"Contains the identifier for the transaction in the core system"},{"name":"valueDate","in":"query","type":"string","required":false,"description":"Contains the value date of the claim or the date on which the amount to be claimed"},{"name":"paymentSource","in":"query","type":"string","required":false,"description":"Indicates the source from where the payment is originated"},{"name":"channel","in":"query","type":"string","required":false,"description":"Contains the channel in which the activity was performed. If pricing is not determined based on channel, then this is not significant"},{"name":"senderBankBic","in":"query","type":"string","required":false,"description":"Indicates the sending bank BIC Code"},{"name":"receiver","in":"query","type":"string","required":false,"description":"Identifies the receiver of the message"},{"name":"debtorAccountId","in":"query","type":"string","required":false,"description":"Contains the identification assigned by an institution to identify a debtor account by the account owner."},{"name":"beneficiaryAccountId","in":"query","type":"string","required":false,"description":"Unique account identifier of the beneficiary account number."},{"name":"scheme","in":"query","type":"string","required":false,"description":"Represents the scheme (a synonym for the National ID type) under which the National ID is defined"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"PaymentsPendingSwiftAcknowledgementResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/order/payments/swift/inwardTransfers/cover/pendings","fullPath":"/api/v1.0.0/order/payments/swift/inwardTransfers/cover/pendings","operationId":"getPaymentsPendingCoverOrAnnouncements","name":"Retrieves the list of transaction that are waiting for announcement or cover message","summary":"Retrieves pending payments for cover or announcement message","tags":["OTHERS"],"parameters":[{"name":"clearingTransactionType","in":"query","type":"string","required":false,"description":"Indicates the Clearing transaction type."},{"name":"creditCustomerId","in":"query","type":"string","required":false,"description":"Creditor customer id details"},{"name":"customerOrBankTransfer","in":"query","type":"string","required":false,"description":"Indicates if the payment was initiated by Customer or the financial institution"},{"name":"customerSpecifiedReference","in":"query","type":"string","required":false,"description":"Deprecated - Customer specified reference"},{"name":"debitCustomerId","in":"query","type":"string","required":false,"description":"Debtor customer details"},{"name":"paymentDirection","in":"query","type":"string","required":false,"description":"Indicates the direction of payment i.e. incoming, outgoing, book or redirect"},{"name":"endToEndReference","in":"query","type":"string","required":false,"description":"Indicates the end to end reference for the payment. This field can be provided by the person who instructs the payment and this flows through the lifecycle of the payment."},{"name":"entryDateTime","in":"query","type":"string","required":false,"description":"Contains the payment creation time"},{"name":"fileSendersReference","in":"query","type":"string","required":false,"description":"Indicates the sender reference that comes from the inward payment file"},{"name":"paymentId","in":"query","type":"string","required":false,"description":"Indicates the unique reference number of the payment"},{"name":"incomingMessageType","in":"query","type":"string","required":false,"description":"Indicates the supported message type to be received from the clearing house or the direct participant."},{"name":"company","in":"query","type":"string","required":false,"description":"The company code"},{"name":"processingDate","in":"query","type":"string","required":false,"description":"The date when payment instruction is processed in system."},{"name":"partySendersReferenceIncoming","in":"query","type":"string","required":false,"description":"Debtor payment reference details of incoming"},{"name":"partySendersReferenceOutgoing","in":"query","type":"string","required":false,"description":"Debtor payment reference details of outgoing"},{"name":"statusCode","in":"query","type":"string","required":false,"description":"Status code, as defined by the institution"},{"name":"transactionAmount","in":"query","type":"string","required":false,"description":"Contains the transaction amount. This is based on the currency, either local or foreign currency"},{"name":"transactionCurrency","in":"query","type":"string","required":false,"description":"Indicates the currency of the transaction. For example GBP, USD etc."},{"name":"transactionReference","in":"query","type":"string","required":false,"description":"Contains the identifier for the transaction in the core system"},{"name":"paymentSource","in":"query","type":"string","required":false,"description":"Indicates the source from where the payment is originated"},{"name":"channel","in":"query","type":"string","required":false,"description":"Contains the channel in which the activity was performed. If pricing is not determined based on channel, then this is not significant"},{"name":"senderBankBic","in":"query","type":"string","required":false,"description":"Indicates the sending bank BIC Code"},{"name":"receiver","in":"query","type":"string","required":false,"description":"Identifies the receiver of the message"},{"name":"debtorAccountId","in":"query","type":"string","required":false,"description":"Contains the identification assigned by an institution to identify a debtor account by the account owner."},{"name":"beneficiaryAccountId","in":"query","type":"string","required":false,"description":"Unique account identifier of the beneficiary account number."},{"name":"scheme","in":"query","type":"string","required":false,"description":"Represents the scheme (a synonym for the National ID type) under which the National ID is defined"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"PaymentsPendingCoverOrAnnouncementsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}}]},{"key":"order-payments-operationalQueueListingClearings-v1.1.0","title":"Operational Queue Listing Clearings","version":"v1.1.0","description":"Retrieve the list of payments that are pending for acknowledgment or cover from clearing or SWIFT","endpointCount":3,"endpoints":[{"method":"GET","path":"/order/payments/instant/clearingAcknowledgements/pendings","fullPath":"/api/v1.1.0/order/payments/instant/clearingAcknowledgements/pendings","operationId":"getUnconfirmedInstantPayments","name":"Retrieves the list of instant payments that are awaiting acknowledgement from clearing","summary":"Retrieves instant payments waiting for confirmation","tags":["OTHERS"],"parameters":[{"name":"clearingTransactionType","in":"query","type":"string","required":false,"description":"Indicates the Clearing transaction type."},{"name":"creditCustomerId","in":"query","type":"string","required":false,"description":"Creditor customer id details"},{"name":"customerOrBankTransfer","in":"query","type":"string","required":false,"description":"Indicates if the payment was initiated by Customer or the financial institution"},{"name":"customerSpecifiedReference","in":"query","type":"string","required":false,"description":"Deprecated - Customer specified reference"},{"name":"debitCustomerId","in":"query","type":"string","required":false,"description":"Debtor customer details"},{"name":"paymentDirection","in":"query","type":"string","required":false,"description":"Indicates the direction of payment i.e. incoming, outgoing, book or redirect"},{"name":"endToEndReference","in":"query","type":"string","required":false,"description":"Indicates the end to end reference for the payment. This field can be provided by the person who instructs the payment and this flows through the lifecycle of the payment."},{"name":"entryDateTime","in":"query","type":"string","required":false,"description":"Contains the payment creation time"},{"name":"fileSendersReference","in":"query","type":"string","required":false,"description":"Indicates the sender reference that comes from the inward payment file"},{"name":"paymentId","in":"query","type":"string","required":false,"description":"Indicates the unique reference number of the payment"},{"name":"incomingMessageType","in":"query","type":"string","required":false,"description":"Indicates the supported message type to be received from the clearing house or the direct participant."},{"name":"company","in":"query","type":"string","required":false,"description":"The company code"},{"name":"processingDate","in":"query","type":"string","required":false,"description":"The date when payment instruction is processed in system."},{"name":"partySendersReferenceIncoming","in":"query","type":"string","required":false,"description":"Debtor payment reference details of incoming"},{"name":"partySendersReferenceOutgoing","in":"query","type":"string","required":false,"description":"Debtor payment reference details of outgoing"},{"name":"statusCode","in":"query","type":"string","required":false,"description":"Status code, as defined by the institution"},{"name":"transactionAmount","in":"query","type":"string","required":false,"description":"Contains the transaction amount. This is based on the currency, either local or foreign currency"},{"name":"transactionCurrency","in":"query","type":"string","required":false,"description":"Indicates the currency of the transaction. For example GBP, USD etc."},{"name":"transactionReference","in":"query","type":"string","required":false,"description":"Contains the identifier for the transaction in the core system"},{"name":"valueDate","in":"query","type":"string","required":false,"description":"Contains the value date of the claim or the date on which the amount to be claimed"},{"name":"paymentSource","in":"query","type":"string","required":false,"description":"Indicates the source from where the payment is originated"},{"name":"channel","in":"query","type":"string","required":false,"description":"Contains the channel in which the activity was performed. If pricing is not determined based on channel, then this is not significant"},{"name":"senderBankBic","in":"query","type":"string","required":false,"description":"Indicates the sending bank BIC Code"},{"name":"receiver","in":"query","type":"string","required":false,"description":"Identifies the receiver of the message"},{"name":"debtorAccountId","in":"query","type":"string","required":false,"description":"Contains the identification assigned by an institution to identify a debtor account by the account owner."},{"name":"beneficiaryAccountId","in":"query","type":"string","required":false,"description":"Unique account identifier of the beneficiary account number."},{"name":"scheme","in":"query","type":"string","required":false,"description":"Represents the scheme (a synonym for the National ID type) under which the National ID is defined"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"UnconfirmedInstantPaymentsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/order/payments/swift/acknowledgements/pendings","fullPath":"/api/v1.1.0/order/payments/swift/acknowledgements/pendings","operationId":"getPaymentsPendingSwiftAcknowledgement","name":"Retrieves the list of payments that are waiting for acknowledgement from SWIFT","summary":"Retrieves payments waiting for SWIFT acknowledgement","tags":["OTHERS"],"parameters":[{"name":"clearingTransactionType","in":"query","type":"string","required":false,"description":"Indicates the Clearing transaction type."},{"name":"creditCustomerId","in":"query","type":"string","required":false,"description":"Creditor customer id details"},{"name":"customerOrBankTransfer","in":"query","type":"string","required":false,"description":"Indicates if the payment was initiated by Customer or the financial institution"},{"name":"customerSpecifiedReference","in":"query","type":"string","required":false,"description":"Deprecated - Customer specified reference"},{"name":"debitCustomerId","in":"query","type":"string","required":false,"description":"Debtor customer details"},{"name":"paymentDirection","in":"query","type":"string","required":false,"description":"Indicates the direction of payment i.e. incoming, outgoing, book or redirect"},{"name":"endToEndReference","in":"query","type":"string","required":false,"description":"Indicates the end to end reference for the payment. This field can be provided by the person who instructs the payment and this flows through the lifecycle of the payment."},{"name":"entryDateTime","in":"query","type":"string","required":false,"description":"Contains the payment creation time"},{"name":"fileSendersReference","in":"query","type":"string","required":false,"description":"Indicates the sender reference that comes from the inward payment file"},{"name":"paymentId","in":"query","type":"string","required":false,"description":"Indicates the unique reference number of the payment"},{"name":"incomingMessageType","in":"query","type":"string","required":false,"description":"Indicates the supported message type to be received from the clearing house or the direct participant."},{"name":"company","in":"query","type":"string","required":false,"description":"The company code"},{"name":"processingDate","in":"query","type":"string","required":false,"description":"The date when payment instruction is processed in system."},{"name":"partySendersReferenceIncoming","in":"query","type":"string","required":false,"description":"Debtor payment reference details of incoming"},{"name":"partySendersReferenceOutgoing","in":"query","type":"string","required":false,"description":"Debtor payment reference details of outgoing"},{"name":"statusCode","in":"query","type":"string","required":false,"description":"Status code, as defined by the institution"},{"name":"transactionAmount","in":"query","type":"string","required":false,"description":"Contains the transaction amount. This is based on the currency, either local or foreign currency"},{"name":"transactionCurrency","in":"query","type":"string","required":false,"description":"Indicates the currency of the transaction. For example GBP, USD etc."},{"name":"transactionReference","in":"query","type":"string","required":false,"description":"Contains the identifier for the transaction in the core system"},{"name":"valueDate","in":"query","type":"string","required":false,"description":"Contains the value date of the claim or the date on which the amount to be claimed"},{"name":"paymentSource","in":"query","type":"string","required":false,"description":"Indicates the source from where the payment is originated"},{"name":"channel","in":"query","type":"string","required":false,"description":"Contains the channel in which the activity was performed. If pricing is not determined based on channel, then this is not significant"},{"name":"senderBankBic","in":"query","type":"string","required":false,"description":"Indicates the sending bank BIC Code"},{"name":"receiver","in":"query","type":"string","required":false,"description":"Identifies the receiver of the message"},{"name":"debtorAccountId","in":"query","type":"string","required":false,"description":"Contains the identification assigned by an institution to identify a debtor account by the account owner."},{"name":"beneficiaryAccountId","in":"query","type":"string","required":false,"description":"Unique account identifier of the beneficiary account number."},{"name":"scheme","in":"query","type":"string","required":false,"description":"Represents the scheme (a synonym for the National ID type) under which the National ID is defined"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"PaymentsPendingSwiftAcknowledgementResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/order/payments/swift/inwardTransfers/cover/pendings","fullPath":"/api/v1.1.0/order/payments/swift/inwardTransfers/cover/pendings","operationId":"getPaymentsPendingCoverOrAnnouncements","name":"Retrieves the list of transaction that are waiting for announcement or cover message","summary":"Retrieves pending payments for cover or announcement message","tags":["OTHERS"],"parameters":[{"name":"clearingTransactionType","in":"query","type":"string","required":false,"description":"Indicates the Clearing transaction type."},{"name":"creditCustomerId","in":"query","type":"string","required":false,"description":"Creditor customer id details"},{"name":"customerOrBankTransfer","in":"query","type":"string","required":false,"description":"Indicates if the payment was initiated by Customer or the financial institution"},{"name":"customerSpecifiedReference","in":"query","type":"string","required":false,"description":"Deprecated - Customer specified reference"},{"name":"debitCustomerId","in":"query","type":"string","required":false,"description":"Debtor customer details"},{"name":"paymentDirection","in":"query","type":"string","required":false,"description":"Indicates the direction of payment i.e. incoming, outgoing, book or redirect"},{"name":"endToEndReference","in":"query","type":"string","required":false,"description":"Indicates the end to end reference for the payment. This field can be provided by the person who instructs the payment and this flows through the lifecycle of the payment."},{"name":"entryDateTime","in":"query","type":"string","required":false,"description":"Contains the payment creation time"},{"name":"fileSendersReference","in":"query","type":"string","required":false,"description":"Indicates the sender reference that comes from the inward payment file"},{"name":"paymentId","in":"query","type":"string","required":false,"description":"Indicates the unique reference number of the payment"},{"name":"incomingMessageType","in":"query","type":"string","required":false,"description":"Indicates the supported message type to be received from the clearing house or the direct participant."},{"name":"company","in":"query","type":"string","required":false,"description":"The company code"},{"name":"processingDate","in":"query","type":"string","required":false,"description":"The date when payment instruction is processed in system."},{"name":"partySendersReferenceIncoming","in":"query","type":"string","required":false,"description":"Debtor payment reference details of incoming"},{"name":"partySendersReferenceOutgoing","in":"query","type":"string","required":false,"description":"Debtor payment reference details of outgoing"},{"name":"statusCode","in":"query","type":"string","required":false,"description":"Status code, as defined by the institution"},{"name":"transactionAmount","in":"query","type":"string","required":false,"description":"Contains the transaction amount. This is based on the currency, either local or foreign currency"},{"name":"transactionCurrency","in":"query","type":"string","required":false,"description":"Indicates the currency of the transaction. For example GBP, USD etc."},{"name":"transactionReference","in":"query","type":"string","required":false,"description":"Contains the identifier for the transaction in the core system"},{"name":"paymentSource","in":"query","type":"string","required":false,"description":"Indicates the source from where the payment is originated"},{"name":"channel","in":"query","type":"string","required":false,"description":"Contains the channel in which the activity was performed. If pricing is not determined based on channel, then this is not significant"},{"name":"senderBankBic","in":"query","type":"string","required":false,"description":"Indicates the sending bank BIC Code"},{"name":"receiver","in":"query","type":"string","required":false,"description":"Identifies the receiver of the message"},{"name":"debtorAccountId","in":"query","type":"string","required":false,"description":"Contains the identification assigned by an institution to identify a debtor account by the account owner."},{"name":"beneficiaryAccountId","in":"query","type":"string","required":false,"description":"Unique account identifier of the beneficiary account number."},{"name":"scheme","in":"query","type":"string","required":false,"description":"Represents the scheme (a synonym for the National ID type) under which the National ID is defined"},{"name":"valueDate","in":"query","type":"string","required":false,"description":"Contains the value date of the claim or the date on which the amount to be claimed"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"PaymentsPendingCoverOrAnnouncementsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}}]},{"key":"order-payments-operationalQueueListingClearings-v1.2.0","title":"Operational Queue Listing Clearings","version":"v1.2.0","description":"Retrieve the list of payments that are pending for acknowledgment or cover from clearing or SWIFT","endpointCount":3,"endpoints":[{"method":"GET","path":"/order/payments/instant/clearingAcknowledgements/pendings","fullPath":"/api/v1.2.0/order/payments/instant/clearingAcknowledgements/pendings","operationId":"getUnconfirmedInstantPayments","name":"Retrieves the list of instant payments that are awaiting acknowledgement from clearing","summary":"Retrieves instant payments waiting for confirmation","tags":["OTHERS"],"parameters":[{"name":"clearingTransactionType","in":"query","type":"string","required":false,"description":"Indicates the Clearing transaction type."},{"name":"creditCustomerId","in":"query","type":"string","required":false,"description":"Creditor customer id details"},{"name":"customerOrBankTransfer","in":"query","type":"string","required":false,"description":"Indicates if the payment was initiated by Customer or the financial institution"},{"name":"customerSpecifiedReference","in":"query","type":"string","required":false,"description":"Deprecated - Customer specified reference"},{"name":"debitCustomerId","in":"query","type":"string","required":false,"description":"Debtor customer details"},{"name":"paymentDirection","in":"query","type":"string","required":false,"description":"Indicates the direction of payment i.e. incoming, outgoing, book or redirect"},{"name":"endToEndReference","in":"query","type":"string","required":false,"description":"Indicates the end to end reference for the payment. This field can be provided by the person who instructs the payment and this flows through the lifecycle of the payment."},{"name":"entryDateTime","in":"query","type":"string","required":false,"description":"Contains the payment creation time"},{"name":"fileSendersReference","in":"query","type":"string","required":false,"description":"Indicates the sender reference that comes from the inward payment file"},{"name":"paymentId","in":"query","type":"string","required":false,"description":"Indicates the unique reference number of the payment"},{"name":"incomingMessageType","in":"query","type":"string","required":false,"description":"Indicates the supported message type to be received from the clearing house or the direct participant."},{"name":"company","in":"query","type":"string","required":false,"description":"The company code"},{"name":"processingDate","in":"query","type":"string","required":false,"description":"The date when payment instruction is processed in system."},{"name":"partySendersReferenceIncoming","in":"query","type":"string","required":false,"description":"Debtor payment reference details of incoming"},{"name":"partySendersReferenceOutgoing","in":"query","type":"string","required":false,"description":"Debtor payment reference details of outgoing"},{"name":"statusCode","in":"query","type":"string","required":false,"description":"Status code, as defined by the institution"},{"name":"transactionAmount","in":"query","type":"string","required":false,"description":"Contains the transaction amount. This is based on the currency, either local or foreign currency"},{"name":"transactionCurrency","in":"query","type":"string","required":false,"description":"Indicates the currency of the transaction. For example GBP, USD etc."},{"name":"transactionReference","in":"query","type":"string","required":false,"description":"Contains the identifier for the transaction in the core system"},{"name":"valueDate","in":"query","type":"string","required":false,"description":"Contains the value date of the claim or the date on which the amount to be claimed"},{"name":"paymentSource","in":"query","type":"string","required":false,"description":"Indicates the source from where the payment is originated"},{"name":"channel","in":"query","type":"string","required":false,"description":"Contains the channel in which the activity was performed. If pricing is not determined based on channel, then this is not significant"},{"name":"senderBankBic","in":"query","type":"string","required":false,"description":"Indicates the sending bank BIC Code"},{"name":"receiver","in":"query","type":"string","required":false,"description":"Identifies the receiver of the message"},{"name":"debtorAccountId","in":"query","type":"string","required":false,"description":"Contains the identification assigned by an institution to identify a debtor account by the account owner."},{"name":"beneficiaryAccountId","in":"query","type":"string","required":false,"description":"Unique account identifier of the beneficiary account number."},{"name":"scheme","in":"query","type":"string","required":false,"description":"Represents the scheme (a synonym for the National ID type) under which the National ID is defined"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"UnconfirmedInstantPaymentsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/order/payments/swift/acknowledgements/pendings","fullPath":"/api/v1.2.0/order/payments/swift/acknowledgements/pendings","operationId":"getPaymentsPendingSwiftAcknowledgement","name":"Retrieves the list of payments that are waiting for acknowledgement from SWIFT","summary":"Retrieves payments waiting for SWIFT acknowledgement","tags":["OTHERS"],"parameters":[{"name":"clearingTransactionType","in":"query","type":"string","required":false,"description":"Indicates the Clearing transaction type."},{"name":"creditCustomerId","in":"query","type":"string","required":false,"description":"Creditor customer id details"},{"name":"customerOrBankTransfer","in":"query","type":"string","required":false,"description":"Indicates if the payment was initiated by Customer or the financial institution"},{"name":"customerSpecifiedReference","in":"query","type":"string","required":false,"description":"Deprecated - Customer specified reference"},{"name":"debitCustomerId","in":"query","type":"string","required":false,"description":"Debtor customer details"},{"name":"paymentDirection","in":"query","type":"string","required":false,"description":"Indicates the direction of payment i.e. incoming, outgoing, book or redirect"},{"name":"endToEndReference","in":"query","type":"string","required":false,"description":"Indicates the end to end reference for the payment. This field can be provided by the person who instructs the payment and this flows through the lifecycle of the payment."},{"name":"entryDateTime","in":"query","type":"string","required":false,"description":"Contains the payment creation time"},{"name":"fileSendersReference","in":"query","type":"string","required":false,"description":"Indicates the sender reference that comes from the inward payment file"},{"name":"paymentId","in":"query","type":"string","required":false,"description":"Indicates the unique reference number of the payment"},{"name":"incomingMessageType","in":"query","type":"string","required":false,"description":"Indicates the supported message type to be received from the clearing house or the direct participant."},{"name":"company","in":"query","type":"string","required":false,"description":"The company code"},{"name":"processingDate","in":"query","type":"string","required":false,"description":"The date when payment instruction is processed in system."},{"name":"partySendersReferenceIncoming","in":"query","type":"string","required":false,"description":"Debtor payment reference details of incoming"},{"name":"partySendersReferenceOutgoing","in":"query","type":"string","required":false,"description":"Debtor payment reference details of outgoing"},{"name":"statusCode","in":"query","type":"string","required":false,"description":"Status code, as defined by the institution"},{"name":"transactionAmount","in":"query","type":"string","required":false,"description":"Contains the transaction amount. This is based on the currency, either local or foreign currency"},{"name":"transactionCurrency","in":"query","type":"string","required":false,"description":"Indicates the currency of the transaction. For example GBP, USD etc."},{"name":"transactionReference","in":"query","type":"string","required":false,"description":"Contains the identifier for the transaction in the core system"},{"name":"valueDate","in":"query","type":"string","required":false,"description":"Contains the value date of the claim or the date on which the amount to be claimed"},{"name":"paymentSource","in":"query","type":"string","required":false,"description":"Indicates the source from where the payment is originated"},{"name":"channel","in":"query","type":"string","required":false,"description":"Contains the channel in which the activity was performed. If pricing is not determined based on channel, then this is not significant"},{"name":"senderBankBic","in":"query","type":"string","required":false,"description":"Indicates the sending bank BIC Code"},{"name":"receiver","in":"query","type":"string","required":false,"description":"Identifies the receiver of the message"},{"name":"debtorAccountId","in":"query","type":"string","required":false,"description":"Contains the identification assigned by an institution to identify a debtor account by the account owner."},{"name":"beneficiaryAccountId","in":"query","type":"string","required":false,"description":"Unique account identifier of the beneficiary account number."},{"name":"scheme","in":"query","type":"string","required":false,"description":"Represents the scheme (a synonym for the National ID type) under which the National ID is defined"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"PaymentsPendingSwiftAcknowledgementResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/order/payments/swift/inwardTransfers/cover/pendings","fullPath":"/api/v1.2.0/order/payments/swift/inwardTransfers/cover/pendings","operationId":"getPaymentsPendingCoverOrAnnouncements","name":"Retrieves the list of transaction that are waiting for announcement or cover message","summary":"Retrieves pending payments for cover or announcement message","tags":["OTHERS"],"parameters":[{"name":"clearingTransactionType","in":"query","type":"string","required":false,"description":"Indicates the Clearing transaction type."},{"name":"creditCustomerId","in":"query","type":"string","required":false,"description":"Creditor customer id details"},{"name":"customerOrBankTransfer","in":"query","type":"string","required":false,"description":"Indicates if the payment was initiated by Customer or the financial institution"},{"name":"customerSpecifiedReference","in":"query","type":"string","required":false,"description":"Deprecated - Customer specified reference"},{"name":"debitCustomerId","in":"query","type":"string","required":false,"description":"Debtor customer details"},{"name":"paymentDirection","in":"query","type":"string","required":false,"description":"Indicates the direction of payment i.e. incoming, outgoing, book or redirect"},{"name":"endToEndReference","in":"query","type":"string","required":false,"description":"Indicates the end to end reference for the payment. This field can be provided by the person who instructs the payment and this flows through the lifecycle of the payment."},{"name":"entryDateTime","in":"query","type":"string","required":false,"description":"Contains the payment creation time"},{"name":"fileSendersReference","in":"query","type":"string","required":false,"description":"Indicates the sender reference that comes from the inward payment file"},{"name":"paymentId","in":"query","type":"string","required":false,"description":"Indicates the unique reference number of the payment"},{"name":"incomingMessageType","in":"query","type":"string","required":false,"description":"Indicates the supported message type to be received from the clearing house or the direct participant."},{"name":"company","in":"query","type":"string","required":false,"description":"The company code"},{"name":"processingDate","in":"query","type":"string","required":false,"description":"The date when payment instruction is processed in system."},{"name":"partySendersReferenceIncoming","in":"query","type":"string","required":false,"description":"Debtor payment reference details of incoming"},{"name":"partySendersReferenceOutgoing","in":"query","type":"string","required":false,"description":"Debtor payment reference details of outgoing"},{"name":"statusCode","in":"query","type":"string","required":false,"description":"Status code, as defined by the institution"},{"name":"transactionAmount","in":"query","type":"string","required":false,"description":"Contains the transaction amount. This is based on the currency, either local or foreign currency"},{"name":"transactionCurrency","in":"query","type":"string","required":false,"description":"Indicates the currency of the transaction. For example GBP, USD etc."},{"name":"transactionReference","in":"query","type":"string","required":false,"description":"Contains the identifier for the transaction in the core system"},{"name":"paymentSource","in":"query","type":"string","required":false,"description":"Indicates the source from where the payment is originated"},{"name":"channel","in":"query","type":"string","required":false,"description":"Contains the channel in which the activity was performed. If pricing is not determined based on channel, then this is not significant"},{"name":"senderBankBic","in":"query","type":"string","required":false,"description":"Indicates the sending bank BIC Code"},{"name":"receiver","in":"query","type":"string","required":false,"description":"Identifies the receiver of the message"},{"name":"debtorAccountId","in":"query","type":"string","required":false,"description":"Contains the identification assigned by an institution to identify a debtor account by the account owner."},{"name":"beneficiaryAccountId","in":"query","type":"string","required":false,"description":"Unique account identifier of the beneficiary account number."},{"name":"scheme","in":"query","type":"string","required":false,"description":"Represents the scheme (a synonym for the National ID type) under which the National ID is defined"},{"name":"valueDate","in":"query","type":"string","required":false,"description":"Contains the value date of the claim or the date on which the amount to be claimed"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"PaymentsPendingCoverOrAnnouncementsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}}]},{"key":"order-payments-operationalQueueListingExceptions-v1.0.0","title":"Operational Queue Listing Exceptions","version":"v1.0.0","description":"Retrieve the list of payments that are available in the exception queue for manual action.","endpointCount":15,"endpoints":[{"method":"GET","path":"/order/payments/swift/pendings","fullPath":"/api/v1.0.0/order/payments/swift/pendings","operationId":"getSwiftMessageWaitingToBeSent","name":"Retrieves the list of SWIFT payment awaiting to be sent to SWIFT","summary":"Retrieves SWIFT payments waiting to be sent.","tags":["OTHERS"],"parameters":[{"name":"clearingTransactionType","in":"query","type":"string","required":false,"description":"Indicates the Clearing transaction type."},{"name":"creditCustomerId","in":"query","type":"string","required":false,"description":"Creditor customer id details"},{"name":"customerOrBankTransfer","in":"query","type":"string","required":false,"description":"Indicates if the payment was initiated by Customer or the financial institution"},{"name":"customerSpecifiedReference","in":"query","type":"string","required":false,"description":"Deprecated - Customer specified reference"},{"name":"debitCustomerId","in":"query","type":"string","required":false,"description":"Debtor customer details"},{"name":"paymentDirection","in":"query","type":"string","required":false,"description":"Indicates the direction of payment i.e. incoming, outgoing, book or redirect"},{"name":"endToEndReference","in":"query","type":"string","required":false,"description":"Indicates the end to end reference for the payment. This field can be provided by the person who instructs the payment and this flows through the lifecycle of the payment."},{"name":"entryDateTime","in":"query","type":"string","required":false,"description":"Contains the payment creation time"},{"name":"fileSendersReference","in":"query","type":"string","required":false,"description":"Indicates the sender reference that comes from the inward payment file"},{"name":"paymentId","in":"query","type":"string","required":false,"description":"Indicates the unique reference number of the payment"},{"name":"incomingMessageType","in":"query","type":"string","required":false,"description":"Indicates the supported message type to be received from the clearing house or the direct participant."},{"name":"company","in":"query","type":"string","required":false,"description":"The company code"},{"name":"processingDate","in":"query","type":"string","required":false,"description":"The date when payment instruction is processed in system."},{"name":"partySendersReferenceIncoming","in":"query","type":"string","required":false,"description":"Debtor payment reference details of incoming"},{"name":"partySendersReferenceOutgoing","in":"query","type":"string","required":false,"description":"Debtor payment reference details of outgoing"},{"name":"statusCode","in":"query","type":"string","required":false,"description":"Status code, as defined by the institution"},{"name":"transactionAmount","in":"query","type":"string","required":false,"description":"Contains the transaction amount. This is based on the currency, either local or foreign currency"},{"name":"transactionCurrency","in":"query","type":"string","required":false,"description":"Indicates the currency of the transaction. For example GBP, USD etc."},{"name":"transactionReference","in":"query","type":"string","required":false,"description":"Contains the identifier for the transaction in the core system"},{"name":"paymentSource","in":"query","type":"string","required":false,"description":"Indicates the source from where the payment is originated"},{"name":"channel","in":"query","type":"string","required":false,"description":"Contains the channel in which the activity was performed. If pricing is not determined based on channel, then this is not significant"},{"name":"senderBankBic","in":"query","type":"string","required":false,"description":"Indicates the sending bank BIC Code"},{"name":"receiver","in":"query","type":"string","required":false,"description":"Identifies the receiver of the message"},{"name":"debtorAccountId","in":"query","type":"string","required":false,"description":"Contains the identification assigned by an institution to identify a debtor account by the account owner."},{"name":"beneficiaryAccountId","in":"query","type":"string","required":false,"description":"Unique account identifier of the beneficiary account number."},{"name":"scheme","in":"query","type":"string","required":false,"description":"Represents the scheme (a synonym for the National ID type) under which the National ID is defined"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"SwiftMessageWaitingToBeSentResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/order/payments/forexLimitStatus/pendings","fullPath":"/api/v1.0.0/order/payments/forexLimitStatus/pendings","operationId":"getPaymentsPendingForexLimitUpdate","name":"Retrieves the list of payments special rate from treasury and can be manually actioned","summary":"Retrieves payments awaiting forex limit status update","tags":["OTHERS"],"parameters":[{"name":"transactionref","in":"query","type":"string","required":false,"description":"Deprecated - Transaction reference"},{"name":"counterparty","in":"query","type":"string","required":false,"description":"The counterparty ID  for the  deal."},{"name":"internalReference","in":"query","type":"string","required":false,"description":"Another ID for the transaction for retrieval purposes or it can be used for the bank to use a unique guarantee number rather than the system generated ID"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"PaymentsPendingForexLimitUpdateResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/order/payments/highValues/exchangeRates/pendings","fullPath":"/api/v1.0.0/order/payments/highValues/exchangeRates/pendings","operationId":"getPaymentsPendingTreasuryRate","name":"Retrieves the list of payment waiting for treasury rate from treasury","summary":"Retrieves high value payments awaiting special rate from treasury","tags":["OTHERS"],"parameters":[{"name":"id","in":"query","type":"string","required":false,"description":"Contains the daily position class id."},{"name":"dealType","in":"query","type":"string","required":false,"description":"Foreign Exchange deal type. Allowed values: - SP(spot) - FW(forward) - SW(Swap)"},{"name":"orderType","in":"query","type":"string","required":false,"description":"Identifies the type of the order. Possible values are Single, Ifdone, Revol, oco. Single order - only one order item may be input. If done order -  If one order gets executed, the other order is also "},{"name":"internalReference","in":"query","type":"string","required":false,"description":"Another ID for the transaction for retrieval purposes or it can be used for the bank to use a unique guarantee number rather than the system generated ID"},{"name":"rate","in":"query","type":"string","required":false,"description":"The rate applied"},{"name":"currency","in":"query","type":"string","required":false,"description":"Contains the currency of the mandate account"},{"name":"orderAmount","in":"query","type":"string","required":false,"description":"The amount of the order"},{"name":"expiryDate","in":"query","type":"string","required":false,"description":"This indicates the  date  on which the offer or privilege terminates for the event."},{"name":"buyRate","in":"query","type":"string","required":false,"description":"The exchange rate at which is currency is bought."},{"name":"submitOrder","in":"query","type":"string","required":false,"description":"Contains the options yes or no to submit a payment order for execution."},{"name":"cancelOrder","in":"query","type":"string","required":false,"description":"Option to cancel an order."},{"name":"orderToClose","in":"query","type":"string","required":false,"description":"Defines whether the trade order is to be Closed or not. When set to CLOSE the order is considered as a square-off order."},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"PaymentsPendingTreasuryRateResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/order/payments/swift/negativeAcknowledgements/pendings","fullPath":"/api/v1.0.0/order/payments/swift/negativeAcknowledgements/pendings","operationId":"getSwiftOutException","name":"Retrieves the list of SWIFT payments that are in exception queue for an operator to action","summary":"Retrieves SWIFT out payments that are in exception","tags":["OTHERS"],"parameters":[{"name":"company","in":"query","type":"string","required":false,"description":"The company code"},{"name":"paymentId","in":"query","type":"string","required":false,"description":"Indicates the unique reference number of the payment"},{"name":"transactionAmount","in":"query","type":"string","required":false,"description":"Contains the transaction amount. This is based on the currency, either local or foreign currency"},{"name":"transactionCurrency","in":"query","type":"string","required":false,"description":"Indicates the currency of the transaction. For example GBP, USD etc."},{"name":"paymentMsgSentDate","in":"query","type":"string","required":false,"description":"Indicates the date on which payment message (MT103, MT202) is sent out to the receiving bank or clearing."},{"name":"statusCode","in":"query","type":"string","required":false,"description":"Status code, as defined by the institution"},{"name":"channel","in":"query","type":"string","required":false,"description":"Contains the channel in which the activity was performed. If pricing is not determined based on channel, then this is not significant"},{"name":"errorCode","in":"query","type":"string","required":false,"description":"Indicates the error code which is encountered during payment processing as returned by payment system "},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"SwiftOutExceptionResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/order/payments/screenings/exceptions","fullPath":"/api/v1.0.0/order/payments/screenings/exceptions","operationId":"getScreeningHitPayments","name":"Retrieves the list of payment for which true hit response have been received","summary":"Retrieves screening hit payments","tags":["OTHERS"],"parameters":[{"name":"clearingTransactionType","in":"query","type":"string","required":false,"description":"Indicates the Clearing transaction type."},{"name":"creditCustomerId","in":"query","type":"string","required":false,"description":"Creditor customer id details"},{"name":"customerOrBankTransfer","in":"query","type":"string","required":false,"description":"Indicates if the payment was initiated by Customer or the financial institution"},{"name":"customerSpecifiedReference","in":"query","type":"string","required":false,"description":"Deprecated - Customer specified reference"},{"name":"debitCustomerId","in":"query","type":"string","required":false,"description":"Debtor customer details"},{"name":"paymentDirection","in":"query","type":"string","required":false,"description":"Indicates the direction of payment i.e. incoming, outgoing, book or redirect"},{"name":"endToEndReference","in":"query","type":"string","required":false,"description":"Indicates the end to end reference for the payment. This field can be provided by the person who instructs the payment and this flows through the lifecycle of the payment."},{"name":"entryDateTime","in":"query","type":"string","required":false,"description":"Contains the payment creation time"},{"name":"fileSendersReference","in":"query","type":"string","required":false,"description":"Indicates the sender reference that comes from the inward payment file"},{"name":"paymentId","in":"query","type":"string","required":false,"description":"Indicates the unique reference number of the payment"},{"name":"incomingMessageType","in":"query","type":"string","required":false,"description":"Indicates the supported message type to be received from the clearing house or the direct participant."},{"name":"company","in":"query","type":"string","required":false,"description":"The company code"},{"name":"processingDate","in":"query","type":"string","required":false,"description":"The date when payment instruction is processed in system."},{"name":"partySendersReferenceIncoming","in":"query","type":"string","required":false,"description":"Debtor payment reference details of incoming"},{"name":"partySendersReferenceOutgoing","in":"query","type":"string","required":false,"description":"Debtor payment reference details of outgoing"},{"name":"statusCode","in":"query","type":"string","required":false,"description":"Status code, as defined by the institution"},{"name":"transactionAmount","in":"query","type":"string","required":false,"description":"Contains the transaction amount. This is based on the currency, either local or foreign currency"},{"name":"transactionCurrency","in":"query","type":"string","required":false,"description":"Indicates the currency of the transaction. For example GBP, USD etc."},{"name":"transactionReference","in":"query","type":"string","required":false,"description":"Contains the identifier for the transaction in the core system"},{"name":"valueDate","in":"query","type":"string","required":false,"description":"Contains the value date of the claim or the date on which the amount to be claimed"},{"name":"paymentSource","in":"query","type":"string","required":false,"description":"Indicates the source from where the payment is originated"},{"name":"channel","in":"query","type":"string","required":false,"description":"Contains the channel in which the activity was performed. If pricing is not determined based on channel, then this is not significant"},{"name":"senderBankBic","in":"query","type":"string","required":false,"description":"Indicates the sending bank BIC Code"},{"name":"receiver","in":"query","type":"string","required":false,"description":"Identifies the receiver of the message"},{"name":"debtorAccountId","in":"query","type":"string","required":false,"description":"Contains the identification assigned by an institution to identify a debtor account by the account owner."},{"name":"beneficiaryAccountId","in":"query","type":"string","required":false,"description":"Unique account identifier of the beneficiary account number."},{"name":"scheme","in":"query","type":"string","required":false,"description":"Represents the scheme (a synonym for the National ID type) under which the National ID is defined"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"ScreeningHitPaymentsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/order/payments/repairs/pendings","fullPath":"/api/v1.0.0/order/payments/repairs/pendings","operationId":"getPaymentPendingManualRepair","name":"Retrieves the list of payments parked in the repair queue for an operator to review and take necessary action.","summary":"Retrieves payment transactions awaiting manual repair","tags":["OTHERS"],"parameters":[{"name":"clearingTransactionType","in":"query","type":"string","required":false,"description":"Indicates the Clearing transaction type."},{"name":"creditCustomerId","in":"query","type":"string","required":false,"description":"Creditor customer id details"},{"name":"customerOrBankTransfer","in":"query","type":"string","required":false,"description":"Indicates if the payment was initiated by Customer or the financial institution"},{"name":"customerSpecifiedReference","in":"query","type":"string","required":false,"description":"Deprecated - Customer specified reference"},{"name":"debitCustomerId","in":"query","type":"string","required":false,"description":"Debtor customer details"},{"name":"paymentDirection","in":"query","type":"string","required":false,"description":"Indicates the direction of payment i.e. incoming, outgoing, book or redirect"},{"name":"endToEndReference","in":"query","type":"string","required":false,"description":"Indicates the end to end reference for the payment. This field can be provided by the person who instructs the payment and this flows through the lifecycle of the payment."},{"name":"entryDateTime","in":"query","type":"string","required":false,"description":"Contains the payment creation time"},{"name":"fileSendersReference","in":"query","type":"string","required":false,"description":"Indicates the sender reference that comes from the inward payment file"},{"name":"paymentId","in":"query","type":"string","required":false,"description":"Indicates the unique reference number of the payment"},{"name":"incomingMessageType","in":"query","type":"string","required":false,"description":"Indicates the supported message type to be received from the clearing house or the direct participant."},{"name":"company","in":"query","type":"string","required":false,"description":"The company code"},{"name":"processingDate","in":"query","type":"string","required":false,"description":"The date when payment instruction is processed in system."},{"name":"partySendersReferenceIncoming","in":"query","type":"string","required":false,"description":"Debtor payment reference details of incoming"},{"name":"partySendersReferenceOutgoing","in":"query","type":"string","required":false,"description":"Debtor payment reference details of outgoing"},{"name":"statusCode","in":"query","type":"string","required":false,"description":"Status code, as defined by the institution"},{"name":"transactionAmount","in":"query","type":"string","required":false,"description":"Contains the transaction amount. This is based on the currency, either local or foreign currency"},{"name":"transactionCurrency","in":"query","type":"string","required":false,"description":"Indicates the currency of the transaction. For example GBP, USD etc."},{"name":"transactionReference","in":"query","type":"string","required":false,"description":"Contains the identifier for the transaction in the core system"},{"name":"paymentSource","in":"query","type":"string","required":false,"description":"Indicates the source from where the payment is originated"},{"name":"channel","in":"query","type":"string","required":false,"description":"Contains the channel in which the activity was performed. If pricing is not determined based on channel, then this is not significant"},{"name":"senderBankBic","in":"query","type":"string","required":false,"description":"Indicates the sending bank BIC Code"},{"name":"receiver","in":"query","type":"string","required":false,"description":"Identifies the receiver of the message"},{"name":"debtorAccountId","in":"query","type":"string","required":false,"description":"Contains the identification assigned by an institution to identify a debtor account by the account owner."},{"name":"beneficiaryAccountId","in":"query","type":"string","required":false,"description":"Unique account identifier of the beneficiary account number."},{"name":"scheme","in":"query","type":"string","required":false,"description":"Represents the scheme (a synonym for the National ID type) under which the National ID is defined"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"PaymentPendingManualRepairResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/order/payments/receivedFiles/files/exceptions","fullPath":"/api/v1.0.0/order/payments/receivedFiles/files/exceptions","operationId":"getReceivedFileException","name":"Retrieves the list of files placed in repair due to transformation issues and awaiting manual action.","summary":"Retrieves files received and waiting in repair","tags":["OTHERS"],"parameters":[{"name":"originalfilereference","in":"query","type":"string","required":false,"description":"Indicates reference of the incoming file for which response is being sent"},{"name":"queueName","in":"query","type":"string","required":false,"description":"For queue to queue configuration this field can be used to specify appropriate queue name with a prefix as CFNAME-queueName."},{"name":"receivedDateTime","in":"query","type":"string","required":false,"description":"Indicates the date and time when the request to pay message is received for payer and requestor"},{"name":"company","in":"query","type":"string","required":false,"description":"The company code"},{"name":"status","in":"query","type":"string","required":false,"description":"The status of the early maturity request"},{"name":"party","in":"query","type":"string","required":false,"description":"Specifies customer information."},{"name":"additionalInformation","in":"query","type":"string","required":false,"description":"Indicates the additional name and value pair information"},{"name":"numberOfItems","in":"query","type":"string","required":false,"description":"Contains the total number of items, as captured during bulk creation."},{"name":"inputter","in":"query","type":"string","required":false,"description":"The user identifier who input the transaction"},{"name":"recordStatus","in":"query","type":"string","required":false,"description":"General status of the record. Possible values: - null - authorised - IHLD - input, on hold - INAU - input, not authorised - INA2 - input, authorised, pending second authorisation - INAO - input, not a"},{"name":"channel","in":"query","type":"string","required":false,"description":"Contains the channel in which the activity was performed. If pricing is not determined based on channel, then this is not significant"},{"name":"paymentIndicator","in":"query","type":"string","required":false,"description":"Indicates whether its a credit/debit type of bill"},{"name":"format","in":"query","type":"string","required":false,"description":"Indicates the formatting version to be used for the delivery message"},{"name":"type","in":"query","type":"string","required":false,"description":"The product condition has an activity type associated that drives an action."},{"name":"fileName","in":"query","type":"string","required":false,"description":"Identifies the type of methods to be listed. Possible values are FX.DEAL.METHOD, BROKER or blank."},{"name":"typeIndicator","in":"query","type":"string","required":false,"description":"Indicates if the record is an Income or Expense"},{"name":"numberOfItems","in":"query","type":"string","required":false,"description":"Contains the total number of items, as captured during bulk creation."},{"name":"errorCode","in":"query","type":"string","required":false,"description":"Indicates the error code which is encountered during payment processing as returned by payment system "},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"ReceivedFileExceptionResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/order/payments/receivedFiles/bulks/exceptions","fullPath":"/api/v1.0.0/order/payments/receivedFiles/bulks/exceptions","operationId":"getReceivedBulkException","name":"Retrieves the list of bulk placed in repair due to mapping issues and awaiting manual action.","summary":"Retrieves bulks received and waiting in repair","tags":["OTHERS"],"parameters":[{"name":"id","in":"query","type":"string","required":false,"description":"Contains the daily position class id."},{"name":"company","in":"query","type":"string","required":false,"description":"The company code"},{"name":"originalfilereference","in":"query","type":"string","required":false,"description":"Indicates reference of the incoming file for which response is being sent"},{"name":"bulkReference","in":"query","type":"string","required":false,"description":"Contains bulk master reference for the payment."},{"name":"bulkFileReferenceApi","in":"query","type":"string","required":false,"description":"Indicates the API that will be invoked to derive at the bulk and file reference if the clearing has a specific requirement."},{"name":"creationDateTime","in":"query","type":"string","required":false,"description":"Date and Time of the message creation."},{"name":"format","in":"query","type":"string","required":false,"description":"Indicates the formatting version to be used for the delivery message"},{"name":"paymentType","in":"query","type":"string","required":false,"description":"Indicates if the payment is Customer (C) type or Bank (B) type"},{"name":"sendersCorrespondentAddress","in":"query","type":"string","required":false,"description":"Contains additional address lines of the sender correspondent institution."},{"name":"receiversCorrespondentAddress","in":"query","type":"string","required":false,"description":"Contains additional address lines of the receiver correspondent institution."},{"name":"numberOfTransaction","in":"query","type":"string","required":false,"description":"Indicates the number of transactions performed on the contract or the account"},{"name":"settlementAmount","in":"query","type":"string","required":false,"description":"Amount of settlement"},{"name":"settlementCurrency","in":"query","type":"string","required":false,"description":"The currency of the trade settlement"},{"name":"settlementDate","in":"query","type":"string","required":false,"description":"Indicates the settlement date of the payment transaction"},{"name":"bulkReferenceId","in":"query","type":"string","required":false,"description":"Contains the bulk master reference for the payment."},{"name":"bulkMasterId","in":"query","type":"string","required":false,"description":"Uniquely identifies each bulk payment request.The reference number is automatically generated by the system."},{"name":"errorCode","in":"query","type":"string","required":false,"description":"Indicates the error code which is encountered during payment processing as returned by payment system "},{"name":"errorInfo","in":"query","type":"string","required":false,"description":"Contains the details of the error such as error source and error message"},{"name":"batchBookingPreferred","in":"query","type":"string","required":false,"description":"If batchBookingPrefered is set to true, then bulkType is defaulted to SINGLE (Single consolidated accounting entry on the debtor account). If set to false, then bulkType is defaulted to MULTI(Individu"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"ReceivedBulkExceptionResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/order/payments/sentFiles/bulks/exceptions","fullPath":"/api/v1.0.0/order/payments/sentFiles/bulks/exceptions","operationId":"getSentBulksExceptions","name":"Retrieves the list of  bulks that are rejected by clearing and awaiting manual action","summary":"Retrieves bulk sent and waiting in repair","tags":["OTHERS"],"parameters":[{"name":"id","in":"query","type":"string","required":false,"description":"Contains the daily position class id."},{"name":"company","in":"query","type":"string","required":false,"description":"The company code"},{"name":"fileSendersReference","in":"query","type":"string","required":false,"description":"Indicates the sender reference that comes from the inward payment file"},{"name":"bulkReference","in":"query","type":"string","required":false,"description":"Contains bulk master reference for the payment."},{"name":"format","in":"query","type":"string","required":false,"description":"Indicates the formatting version to be used for the delivery message"},{"name":"paymentType","in":"query","type":"string","required":false,"description":"Indicates if the payment is Customer (C) type or Bank (B) type"},{"name":"applicantAddress","in":"query","type":"string","required":false,"description":"Indicates the name and address of the applicant of the Letter of Credit"},{"name":"beneficiaryAddress","in":"query","type":"string","required":false,"description":"The address of the Beneficiary if the customer number of the Beneficiary is not known"},{"name":"numberOfTransaction","in":"query","type":"string","required":false,"description":"Indicates the number of transactions performed on the contract or the account"},{"name":"settlementAmount","in":"query","type":"string","required":false,"description":"Amount of settlement"},{"name":"settlementCurrency","in":"query","type":"string","required":false,"description":"The currency of the trade settlement"},{"name":"settlementDate","in":"query","type":"string","required":false,"description":"Indicates the settlement date of the payment transaction"},{"name":"eventStatus","in":"query","type":"string","required":false,"description":"Specifies the status of the request.Allowed values are - With Bank_With Customer_Approved_Rejected."},{"name":"bulkReferenceId","in":"query","type":"string","required":false,"description":"Contains the bulk master reference for the payment."},{"name":"reasonCode","in":"query","type":"string","required":false,"description":"Contains the code of the direct debit collection's status applicable to clearing system"},{"name":"proprietaryTransactionCode","in":"query","type":"string","required":false,"description":"Contains the proprietary bank transaction code to identify the underlying transaction."},{"name":"statusCode","in":"query","type":"string","required":false,"description":"Status code, as defined by the institution"},{"name":"clearingDate","in":"query","type":"string","required":false,"description":"Contains the date from which the payment is expected and is used to indicate the exposure date for the payment."},{"name":"userActivity","in":"query","type":"string","required":false,"description":"Indicates the activity which was triggered by User"},{"name":"sourceType","in":"query","type":"string","required":false,"description":"Indicates source type to determine base amount. Possible values are BALANCE (base amount of a property), ACTIVITY ( transaction amount against an activity) or PROPERTY (this type is currently not supp"},{"name":"uniqueFlag","in":"query","type":"string","required":false,"description":"Flag to indicate unique row"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"SentBulksExceptionsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/order/payments/sentFiles/files/exceptions","fullPath":"/api/v1.0.0/order/payments/sentFiles/files/exceptions","operationId":"getSentFilesExceptions","name":"Retrieves the list of payment files that are rejected by clearing and awaiting manual action","summary":"Retrieves file sent and wating in repair","tags":["OTHERS"],"parameters":[{"name":"id","in":"query","type":"string","required":false,"description":"Contains the daily position class id."},{"name":"company","in":"query","type":"string","required":false,"description":"The company code"},{"name":"fileSendersReference","in":"query","type":"string","required":false,"description":"Indicates the sender reference that comes from the inward payment file"},{"name":"date","in":"query","type":"string","required":false,"description":"Indicates the date on which activity was performed"},{"name":"fileName","in":"query","type":"string","required":false,"description":"Identifies the type of methods to be listed. Possible values are FX.DEAL.METHOD, BROKER or blank."},{"name":"fileExtension","in":"query","type":"string","required":false,"description":"Specifies the upload file extension type. For example CSV, XML or PDF etc."},{"name":"typeIndicator","in":"query","type":"string","required":false,"description":"Indicates if the record is an Income or Expense"},{"name":"outputChannel","in":"query","type":"string","required":false,"description":"Contains the channel that will be used to send the outward payment message"},{"name":"creationDateTime","in":"query","type":"string","required":false,"description":"Date and Time of the message creation."},{"name":"acknowledgementStatus","in":"query","type":"string","required":false,"description":"Contains the code for ack/nack - accepted or rejected by the clearing. For example: 0 - success acknowledegement , 1 - failure negative acknowledgement"},{"name":"noOfEntries","in":"query","type":"string","required":false,"description":"Indicates the number of entries to be retrieved when transaction history for an account is requested."},{"name":"dealReference","in":"query","type":"string","required":false,"description":"Identifies the transaction reference of the Deal"},{"name":"reasonCode","in":"query","type":"string","required":false,"description":"Contains the code of the direct debit collection's status applicable to clearing system"},{"name":"statusCode","in":"query","type":"string","required":false,"description":"Status code, as defined by the institution"},{"name":"clearingDate","in":"query","type":"string","required":false,"description":"Contains the date from which the payment is expected and is used to indicate the exposure date for the payment."},{"name":"originalFileReference","in":"query","type":"string","required":false,"description":"Indicates reference of the incoming file for which response is being sent"},{"name":"sourceType","in":"query","type":"string","required":false,"description":"Indicates source type to determine base amount. Possible values are BALANCE (base amount of a property), ACTIVITY ( transaction amount against an activity) or PROPERTY (this type is currently not supp"},{"name":"processingDate","in":"query","type":"string","required":false,"description":"The date when payment instruction is processed in system."},{"name":"beneficiaryAddress","in":"query","type":"string","required":false,"description":"The address of the Beneficiary if the customer number of the Beneficiary is not known"},{"name":"errorInfo","in":"query","type":"string","required":false,"description":"Contains the details of the error such as error source and error message"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"SentFilesExceptionsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/order/payments/swift/abortNotifications","fullPath":"/api/v1.0.0/order/payments/swift/abortNotifications","operationId":"getSwiftAbortNotificationsReceived","name":"Retrieves the list of payments for which SWIFT abort notifications have been received","summary":"Retrieves received SWIFT abort notifications","tags":["OTHERS"],"parameters":[{"name":"company","in":"query","type":"string","required":false,"description":"The company code"},{"name":"sendersReference","in":"query","type":"string","required":false,"description":"Indicates the incoming sender's reference i.e. tag 20 of incoming SWIFT or in case when transaction is received from other system/ application, this can also indicate the reference number of that syst"},{"name":"receiver","in":"query","type":"string","required":false,"description":"Identifies the receiver of the message"},{"name":"errorCode","in":"query","type":"string","required":false,"description":"Indicates the error code which is encountered during payment processing as returned by payment system "},{"name":"errorInfo","in":"query","type":"string","required":false,"description":"Contains the details of the error such as error source and error message"},{"name":"messageType","in":"query","type":"string","required":false,"description":"Defines the type of swift messages that are sent or received for a transaction"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"SwiftAbortNotificationsReceivedResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/order/payments/swift/iso/exceptions","fullPath":"/api/v1.0.0/order/payments/swift/iso/exceptions","operationId":"getSwiftISOExceptionPayments","name":"Retrieves the list of ISO business exception payments which are pending for manual action","summary":"Retrieves ISO business exception payments","tags":["OTHERS"],"parameters":[{"name":"ftnumber","in":"query","type":"string","required":false,"description":"Deprecated - Transaction reference"},{"name":"sendersReference","in":"query","type":"string","required":false,"description":"Indicates the incoming sender's reference i.e. tag 20 of incoming SWIFT or in case when transaction is received from other system/ application, this can also indicate the reference number of that syst"},{"name":"bulkReference","in":"query","type":"string","required":false,"description":"Contains bulk master reference for the payment."},{"name":"acknowledgementType","in":"query","type":"string","required":false,"description":"Contains the ack/nack message type name. For example: admi.007."},{"name":"messageType","in":"query","type":"string","required":false,"description":"Defines the type of swift messages that are sent or received for a transaction"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"SwiftISOExceptionPaymentsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/order/payments/sentFiles/transactions/exceptions","fullPath":"/api/v1.0.0/order/payments/sentFiles/transactions/exceptions","operationId":"getPaymentSentFilesTransactionsExceptions","name":"Retrieves the list of transactions that are rejected by clearing and awaiting manual action","summary":"Retrieves  transaction sent and waiting in repair","tags":["OTHERS"],"parameters":[{"name":"id","in":"query","type":"string","required":false,"description":"Contains the daily position class id."},{"name":"company","in":"query","type":"string","required":false,"description":"The company code"},{"name":"ftnumber","in":"query","type":"string","required":false,"description":"Deprecated - Transaction reference"},{"name":"sendersReference","in":"query","type":"string","required":false,"description":"Indicates the incoming sender's reference i.e. tag 20 of incoming SWIFT or in case when transaction is received from other system/ application, this can also indicate the reference number of that syst"},{"name":"dateTime","in":"query","type":"string","required":false,"description":"Contains the date and time separated by '-'"},{"name":"messageType","in":"query","type":"string","required":false,"description":"Defines the type of swift messages that are sent or received for a transaction"},{"name":"messageContent","in":"query","type":"string","required":false,"description":"It indicates whether only the current information or previous and current information needs to be passed to form the message."},{"name":"ackStatus","in":"query","type":"string","required":false,"description":"Deprecated - Acknowledgement status"},{"name":"acceptMessage","in":"query","type":"string","required":false,"description":"Indicates whether the account officer will accept secure message."},{"name":"message","in":"query","type":"string","required":false,"description":"The actual Transact error message "},{"name":"deliveryReference","in":"query","type":"string","required":false,"description":"Indicates the delivery reference Id generated for the activity"},{"name":"fileSendersReference","in":"query","type":"string","required":false,"description":"Indicates the sender reference that comes from the inward payment file"},{"name":"bulkReference","in":"query","type":"string","required":false,"description":"Contains bulk master reference for the payment."},{"name":"reasonCode","in":"query","type":"string","required":false,"description":"Contains the code of the direct debit collection's status applicable to clearing system"},{"name":"proprietaryTransactionCode","in":"query","type":"string","required":false,"description":"Contains the proprietary bank transaction code to identify the underlying transaction."},{"name":"statusCode","in":"query","type":"string","required":false,"description":"Status code, as defined by the institution"},{"name":"clearingDate","in":"query","type":"string","required":false,"description":"Contains the date from which the payment is expected and is used to indicate the exposure date for the payment."},{"name":"userActivity","in":"query","type":"string","required":false,"description":"Indicates the activity which was triggered by User"},{"name":"settlementDate","in":"query","type":"string","required":false,"description":"Indicates the settlement date of the payment transaction"},{"name":"senderBankBic","in":"query","type":"string","required":false,"description":"Indicates the sending bank BIC Code"},{"name":"sourceType","in":"query","type":"string","required":false,"description":"Indicates source type to determine base amount. Possible values are BALANCE (base amount of a property), ACTIVITY ( transaction amount against an activity) or PROPERTY (this type is currently not supp"},{"name":"messageId","in":"query","type":"string","required":false,"description":"The holds the record key of the message ID."},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"PaymentSentFilesTransactionsExceptionsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/order/payments/swift/iso/technicalExceptions","fullPath":"/api/v1.0.0/order/payments/swift/iso/technicalExceptions","operationId":"getSwiftIsoTechnicalExceptionPayments","name":"Retrieves the list of SWIFT ISO technical exception payments which are pending for manual action","summary":"Retrieves SWIFT ISO technical exception payments","tags":["OTHERS"],"parameters":[{"name":"channel","in":"query","type":"string","required":false,"description":"Contains the channel in which the activity was performed. If pricing is not determined based on channel, then this is not significant"},{"name":"company","in":"query","type":"string","required":false,"description":"The company code"},{"name":"ftnumber","in":"query","type":"string","required":false,"description":"Deprecated - Transaction reference"},{"name":"amount","in":"query","type":"string","required":false,"description":"Contains the direct debit claim amount"},{"name":"currency","in":"query","type":"string","required":false,"description":"Contains the currency of the mandate account"},{"name":"date","in":"query","type":"string","required":false,"description":"Indicates the date on which activity was performed"},{"name":"statusCode","in":"query","type":"string","required":false,"description":"Status code, as defined by the institution"},{"name":"errorCode","in":"query","type":"string","required":false,"description":"Indicates the error code which is encountered during payment processing as returned by payment system "},{"name":"uniqueFlag","in":"query","type":"string","required":false,"description":"Flag to indicate unique row"},{"name":"coverControl","in":"query","type":"string","required":false,"description":"Indicates whether the limit is applicable for the virtual accounts or not"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"SwiftIsoTechnicalExceptionPaymentsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/order/payments/cover/exceptions","fullPath":"/api/v1.0.0/order/payments/cover/exceptions","operationId":"getExceptionCoverPayments","name":"Retrieves the list of unmatched cover payments, which have to be manually matched by an operator.","summary":"Retrieves unmatched cover payments","tags":["OTHERS"],"parameters":[{"name":"clearingTransactionType","in":"query","type":"string","required":false,"description":"Indicates the Clearing transaction type."},{"name":"creditCustomerId","in":"query","type":"string","required":false,"description":"Creditor customer id details"},{"name":"customerOrBankTransfer","in":"query","type":"string","required":false,"description":"Indicates if the payment was initiated by Customer or the financial institution"},{"name":"customerSpecifiedReference","in":"query","type":"string","required":false,"description":"Deprecated - Customer specified reference"},{"name":"debitCustomerId","in":"query","type":"string","required":false,"description":"Debtor customer details"},{"name":"paymentDirection","in":"query","type":"string","required":false,"description":"Indicates the direction of payment i.e. incoming, outgoing, book or redirect"},{"name":"endToEndReference","in":"query","type":"string","required":false,"description":"Indicates the end to end reference for the payment. This field can be provided by the person who instructs the payment and this flows through the lifecycle of the payment."},{"name":"entryDateTime","in":"query","type":"string","required":false,"description":"Contains the payment creation time"},{"name":"fileSendersReference","in":"query","type":"string","required":false,"description":"Indicates the sender reference that comes from the inward payment file"},{"name":"paymentId","in":"query","type":"string","required":false,"description":"Indicates the unique reference number of the payment"},{"name":"incomingMessageType","in":"query","type":"string","required":false,"description":"Indicates the supported message type to be received from the clearing house or the direct participant."},{"name":"company","in":"query","type":"string","required":false,"description":"The company code"},{"name":"processingDate","in":"query","type":"string","required":false,"description":"The date when payment instruction is processed in system."},{"name":"partySendersReferenceIncoming","in":"query","type":"string","required":false,"description":"Debtor payment reference details of incoming"},{"name":"partySendersReferenceOutgoing","in":"query","type":"string","required":false,"description":"Debtor payment reference details of outgoing"},{"name":"statusCode","in":"query","type":"string","required":false,"description":"Status code, as defined by the institution"},{"name":"transactionAmount","in":"query","type":"string","required":false,"description":"Contains the transaction amount. This is based on the currency, either local or foreign currency"},{"name":"transactionCurrency","in":"query","type":"string","required":false,"description":"Indicates the currency of the transaction. For example GBP, USD etc."},{"name":"transactionReference","in":"query","type":"string","required":false,"description":"Contains the identifier for the transaction in the core system"},{"name":"valueDate","in":"query","type":"string","required":false,"description":"Contains the value date of the claim or the date on which the amount to be claimed"},{"name":"paymentSource","in":"query","type":"string","required":false,"description":"Indicates the source from where the payment is originated"},{"name":"channel","in":"query","type":"string","required":false,"description":"Contains the channel in which the activity was performed. If pricing is not determined based on channel, then this is not significant"},{"name":"senderBankBic","in":"query","type":"string","required":false,"description":"Indicates the sending bank BIC Code"},{"name":"receiver","in":"query","type":"string","required":false,"description":"Identifies the receiver of the message"},{"name":"debtorAccountId","in":"query","type":"string","required":false,"description":"Contains the identification assigned by an institution to identify a debtor account by the account owner."},{"name":"beneficiaryAccountId","in":"query","type":"string","required":false,"description":"Unique account identifier of the beneficiary account number."},{"name":"scheme","in":"query","type":"string","required":false,"description":"Represents the scheme (a synonym for the National ID type) under which the National ID is defined"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"ExceptionCoverPaymentsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}}]},{"key":"order-payments-operationalQueueListingExceptions-v1.1.0","title":"Operational Queue Listing Exceptions","version":"v1.1.0","description":"Retrieve the list of payments that are available in the exception queue for manual action.","endpointCount":15,"endpoints":[{"method":"GET","path":"/order/payments/swift/pendings","fullPath":"/api/v1.1.0/order/payments/swift/pendings","operationId":"getSwiftMessageWaitingToBeSent","name":"Retrieves the list of SWIFT payment awaiting to be sent to SWIFT","summary":"Retrieves SWIFT payments waiting to be sent.","tags":["OTHERS"],"parameters":[{"name":"clearingTransactionType","in":"query","type":"string","required":false,"description":"Indicates the Clearing transaction type."},{"name":"creditCustomerId","in":"query","type":"string","required":false,"description":"Creditor customer id details"},{"name":"customerOrBankTransfer","in":"query","type":"string","required":false,"description":"Indicates if the payment was initiated by Customer or the financial institution"},{"name":"customerSpecifiedReference","in":"query","type":"string","required":false,"description":"Deprecated - Customer specified reference"},{"name":"debitCustomerId","in":"query","type":"string","required":false,"description":"Debtor customer details"},{"name":"paymentDirection","in":"query","type":"string","required":false,"description":"Indicates the direction of payment i.e. incoming, outgoing, book or redirect"},{"name":"endToEndReference","in":"query","type":"string","required":false,"description":"Indicates the end to end reference for the payment. This field can be provided by the person who instructs the payment and this flows through the lifecycle of the payment."},{"name":"entryDateTime","in":"query","type":"string","required":false,"description":"Contains the payment creation time"},{"name":"fileSendersReference","in":"query","type":"string","required":false,"description":"Indicates the sender reference that comes from the inward payment file"},{"name":"paymentId","in":"query","type":"string","required":false,"description":"Indicates the unique reference number of the payment"},{"name":"incomingMessageType","in":"query","type":"string","required":false,"description":"Indicates the supported message type to be received from the clearing house or the direct participant."},{"name":"company","in":"query","type":"string","required":false,"description":"The company code"},{"name":"processingDate","in":"query","type":"string","required":false,"description":"The date when payment instruction is processed in system."},{"name":"partySendersReferenceIncoming","in":"query","type":"string","required":false,"description":"Debtor payment reference details of incoming"},{"name":"partySendersReferenceOutgoing","in":"query","type":"string","required":false,"description":"Debtor payment reference details of outgoing"},{"name":"statusCode","in":"query","type":"string","required":false,"description":"Status code, as defined by the institution"},{"name":"transactionAmount","in":"query","type":"string","required":false,"description":"Contains the transaction amount. This is based on the currency, either local or foreign currency"},{"name":"transactionCurrency","in":"query","type":"string","required":false,"description":"Indicates the currency of the transaction. For example GBP, USD etc."},{"name":"transactionReference","in":"query","type":"string","required":false,"description":"Contains the identifier for the transaction in the core system"},{"name":"paymentSource","in":"query","type":"string","required":false,"description":"Indicates the source from where the payment is originated"},{"name":"channel","in":"query","type":"string","required":false,"description":"Contains the channel in which the activity was performed. If pricing is not determined based on channel, then this is not significant"},{"name":"senderBankBic","in":"query","type":"string","required":false,"description":"Indicates the sending bank BIC Code"},{"name":"receiver","in":"query","type":"string","required":false,"description":"Identifies the receiver of the message"},{"name":"debtorAccountId","in":"query","type":"string","required":false,"description":"Contains the identification assigned by an institution to identify a debtor account by the account owner."},{"name":"beneficiaryAccountId","in":"query","type":"string","required":false,"description":"Unique account identifier of the beneficiary account number."},{"name":"scheme","in":"query","type":"string","required":false,"description":"Represents the scheme (a synonym for the National ID type) under which the National ID is defined"},{"name":"valueDate","in":"query","type":"string","required":false,"description":"Contains the value date of the claim or the date on which the amount to be claimed"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"SwiftMessageWaitingToBeSentResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/order/payments/forexLimitStatus/pendings","fullPath":"/api/v1.1.0/order/payments/forexLimitStatus/pendings","operationId":"getPaymentsPendingForexLimitUpdate","name":"Retrieves the list of payments special rate from treasury and can be manually actioned","summary":"Retrieves payments awaiting forex limit status update","tags":["OTHERS"],"parameters":[{"name":"transactionref","in":"query","type":"string","required":false,"description":"Deprecated - Transaction reference"},{"name":"counterparty","in":"query","type":"string","required":false,"description":"The counterparty ID  for the  deal."},{"name":"internalReference","in":"query","type":"string","required":false,"description":"Another ID for the transaction for retrieval purposes or it can be used for the bank to use a unique guarantee number rather than the system generated ID"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"PaymentsPendingForexLimitUpdateResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/order/payments/highValues/exchangeRates/pendings","fullPath":"/api/v1.1.0/order/payments/highValues/exchangeRates/pendings","operationId":"getPaymentsPendingTreasuryRate","name":"Retrieves the list of payment waiting for treasury rate from treasury","summary":"Retrieves high value payments awaiting special rate from treasury","tags":["OTHERS"],"parameters":[{"name":"id","in":"query","type":"string","required":false,"description":"Contains the daily position class id."},{"name":"dealType","in":"query","type":"string","required":false,"description":"Foreign Exchange deal type. Allowed values: - SP(spot) - FW(forward) - SW(Swap)"},{"name":"orderType","in":"query","type":"string","required":false,"description":"Identifies the type of the order. Possible values are Single, Ifdone, Revol, oco. Single order - only one order item may be input. If done order -  If one order gets executed, the other order is also "},{"name":"internalReference","in":"query","type":"string","required":false,"description":"Another ID for the transaction for retrieval purposes or it can be used for the bank to use a unique guarantee number rather than the system generated ID"},{"name":"rate","in":"query","type":"string","required":false,"description":"The rate applied"},{"name":"currency","in":"query","type":"string","required":false,"description":"Contains the currency of the mandate account"},{"name":"orderAmount","in":"query","type":"string","required":false,"description":"The amount of the order"},{"name":"expiryDate","in":"query","type":"string","required":false,"description":"This indicates the  date  on which the offer or privilege terminates for the event."},{"name":"buyRate","in":"query","type":"string","required":false,"description":"The exchange rate at which is currency is bought."},{"name":"submitOrder","in":"query","type":"string","required":false,"description":"Contains the options yes or no to submit a payment order for execution."},{"name":"cancelOrder","in":"query","type":"string","required":false,"description":"Option to cancel an order."},{"name":"orderToClose","in":"query","type":"string","required":false,"description":"Defines whether the trade order is to be Closed or not. When set to CLOSE the order is considered as a square-off order."},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"PaymentsPendingTreasuryRateResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/order/payments/swift/negativeAcknowledgements/pendings","fullPath":"/api/v1.1.0/order/payments/swift/negativeAcknowledgements/pendings","operationId":"getSwiftOutException","name":"Retrieves the list of SWIFT payments that are in exception queue for an operator to action","summary":"Retrieves SWIFT out payments that are in exception","tags":["OTHERS"],"parameters":[{"name":"company","in":"query","type":"string","required":false,"description":"The company code"},{"name":"paymentId","in":"query","type":"string","required":false,"description":"Indicates the unique reference number of the payment"},{"name":"transactionAmount","in":"query","type":"string","required":false,"description":"Contains the transaction amount. This is based on the currency, either local or foreign currency"},{"name":"transactionCurrency","in":"query","type":"string","required":false,"description":"Indicates the currency of the transaction. For example GBP, USD etc."},{"name":"paymentMsgSentDate","in":"query","type":"string","required":false,"description":"Indicates the date on which payment message (MT103, MT202) is sent out to the receiving bank or clearing."},{"name":"statusCode","in":"query","type":"string","required":false,"description":"Status code, as defined by the institution"},{"name":"channel","in":"query","type":"string","required":false,"description":"Contains the channel in which the activity was performed. If pricing is not determined based on channel, then this is not significant"},{"name":"errorCode","in":"query","type":"string","required":false,"description":"Indicates the error code which is encountered during payment processing as returned by payment system "},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"SwiftOutExceptionResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/order/payments/screenings/exceptions","fullPath":"/api/v1.1.0/order/payments/screenings/exceptions","operationId":"getScreeningHitPayments","name":"Retrieves the list of payment for which true hit response have been received","summary":"Retrieves screening hit payments","tags":["OTHERS"],"parameters":[{"name":"clearingTransactionType","in":"query","type":"string","required":false,"description":"Indicates the Clearing transaction type."},{"name":"creditCustomerId","in":"query","type":"string","required":false,"description":"Creditor customer id details"},{"name":"customerOrBankTransfer","in":"query","type":"string","required":false,"description":"Indicates if the payment was initiated by Customer or the financial institution"},{"name":"customerSpecifiedReference","in":"query","type":"string","required":false,"description":"Deprecated - Customer specified reference"},{"name":"debitCustomerId","in":"query","type":"string","required":false,"description":"Debtor customer details"},{"name":"paymentDirection","in":"query","type":"string","required":false,"description":"Indicates the direction of payment i.e. incoming, outgoing, book or redirect"},{"name":"endToEndReference","in":"query","type":"string","required":false,"description":"Indicates the end to end reference for the payment. This field can be provided by the person who instructs the payment and this flows through the lifecycle of the payment."},{"name":"entryDateTime","in":"query","type":"string","required":false,"description":"Contains the payment creation time"},{"name":"fileSendersReference","in":"query","type":"string","required":false,"description":"Indicates the sender reference that comes from the inward payment file"},{"name":"paymentId","in":"query","type":"string","required":false,"description":"Indicates the unique reference number of the payment"},{"name":"incomingMessageType","in":"query","type":"string","required":false,"description":"Indicates the supported message type to be received from the clearing house or the direct participant."},{"name":"company","in":"query","type":"string","required":false,"description":"The company code"},{"name":"processingDate","in":"query","type":"string","required":false,"description":"The date when payment instruction is processed in system."},{"name":"partySendersReferenceIncoming","in":"query","type":"string","required":false,"description":"Debtor payment reference details of incoming"},{"name":"partySendersReferenceOutgoing","in":"query","type":"string","required":false,"description":"Debtor payment reference details of outgoing"},{"name":"statusCode","in":"query","type":"string","required":false,"description":"Status code, as defined by the institution"},{"name":"transactionAmount","in":"query","type":"string","required":false,"description":"Contains the transaction amount. This is based on the currency, either local or foreign currency"},{"name":"transactionCurrency","in":"query","type":"string","required":false,"description":"Indicates the currency of the transaction. For example GBP, USD etc."},{"name":"transactionReference","in":"query","type":"string","required":false,"description":"Contains the identifier for the transaction in the core system"},{"name":"valueDate","in":"query","type":"string","required":false,"description":"Contains the value date of the claim or the date on which the amount to be claimed"},{"name":"paymentSource","in":"query","type":"string","required":false,"description":"Indicates the source from where the payment is originated"},{"name":"channel","in":"query","type":"string","required":false,"description":"Contains the channel in which the activity was performed. If pricing is not determined based on channel, then this is not significant"},{"name":"senderBankBic","in":"query","type":"string","required":false,"description":"Indicates the sending bank BIC Code"},{"name":"receiver","in":"query","type":"string","required":false,"description":"Identifies the receiver of the message"},{"name":"debtorAccountId","in":"query","type":"string","required":false,"description":"Contains the identification assigned by an institution to identify a debtor account by the account owner."},{"name":"beneficiaryAccountId","in":"query","type":"string","required":false,"description":"Unique account identifier of the beneficiary account number."},{"name":"scheme","in":"query","type":"string","required":false,"description":"Represents the scheme (a synonym for the National ID type) under which the National ID is defined"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"ScreeningHitPaymentsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/order/payments/repairs/pendings","fullPath":"/api/v1.1.0/order/payments/repairs/pendings","operationId":"getPaymentPendingManualRepair","name":"Retrieves the list of payments parked in the repair queue for an operator to review and take necessary action.","summary":"Retrieves payment transactions awaiting manual repair","tags":["OTHERS"],"parameters":[{"name":"clearingTransactionType","in":"query","type":"string","required":false,"description":"Indicates the Clearing transaction type."},{"name":"creditCustomerId","in":"query","type":"string","required":false,"description":"Creditor customer id details"},{"name":"customerOrBankTransfer","in":"query","type":"string","required":false,"description":"Indicates if the payment was initiated by Customer or the financial institution"},{"name":"customerSpecifiedReference","in":"query","type":"string","required":false,"description":"Deprecated - Customer specified reference"},{"name":"debitCustomerId","in":"query","type":"string","required":false,"description":"Debtor customer details"},{"name":"paymentDirection","in":"query","type":"string","required":false,"description":"Indicates the direction of payment i.e. incoming, outgoing, book or redirect"},{"name":"endToEndReference","in":"query","type":"string","required":false,"description":"Indicates the end to end reference for the payment. This field can be provided by the person who instructs the payment and this flows through the lifecycle of the payment."},{"name":"entryDateTime","in":"query","type":"string","required":false,"description":"Contains the payment creation time"},{"name":"fileSendersReference","in":"query","type":"string","required":false,"description":"Indicates the sender reference that comes from the inward payment file"},{"name":"paymentId","in":"query","type":"string","required":false,"description":"Indicates the unique reference number of the payment"},{"name":"incomingMessageType","in":"query","type":"string","required":false,"description":"Indicates the supported message type to be received from the clearing house or the direct participant."},{"name":"company","in":"query","type":"string","required":false,"description":"The company code"},{"name":"processingDate","in":"query","type":"string","required":false,"description":"The date when payment instruction is processed in system."},{"name":"partySendersReferenceIncoming","in":"query","type":"string","required":false,"description":"Debtor payment reference details of incoming"},{"name":"partySendersReferenceOutgoing","in":"query","type":"string","required":false,"description":"Debtor payment reference details of outgoing"},{"name":"statusCode","in":"query","type":"string","required":false,"description":"Status code, as defined by the institution"},{"name":"transactionAmount","in":"query","type":"string","required":false,"description":"Contains the transaction amount. This is based on the currency, either local or foreign currency"},{"name":"transactionCurrency","in":"query","type":"string","required":false,"description":"Indicates the currency of the transaction. For example GBP, USD etc."},{"name":"transactionReference","in":"query","type":"string","required":false,"description":"Contains the identifier for the transaction in the core system"},{"name":"paymentSource","in":"query","type":"string","required":false,"description":"Indicates the source from where the payment is originated"},{"name":"channel","in":"query","type":"string","required":false,"description":"Contains the channel in which the activity was performed. If pricing is not determined based on channel, then this is not significant"},{"name":"senderBankBic","in":"query","type":"string","required":false,"description":"Indicates the sending bank BIC Code"},{"name":"receiver","in":"query","type":"string","required":false,"description":"Identifies the receiver of the message"},{"name":"debtorAccountId","in":"query","type":"string","required":false,"description":"Contains the identification assigned by an institution to identify a debtor account by the account owner."},{"name":"beneficiaryAccountId","in":"query","type":"string","required":false,"description":"Unique account identifier of the beneficiary account number."},{"name":"scheme","in":"query","type":"string","required":false,"description":"Represents the scheme (a synonym for the National ID type) under which the National ID is defined"},{"name":"valueDate","in":"query","type":"string","required":false,"description":"Contains the value date of the claim or the date on which the amount to be claimed"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"PaymentPendingManualRepairResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/order/payments/receivedFiles/files/exceptions","fullPath":"/api/v1.1.0/order/payments/receivedFiles/files/exceptions","operationId":"getReceivedFileException","name":"Retrieves the list of files placed in repair due to transformation issues and awaiting manual action.","summary":"Retrieves files received and waiting in repair","tags":["OTHERS"],"parameters":[{"name":"originalFileReference","in":"query","type":"string","required":false,"description":"Indicates reference of the incoming file for which response is being sent"},{"name":"queueName","in":"query","type":"string","required":false,"description":"For queue to queue configuration this field can be used to specify appropriate queue name with a prefix as CFNAME-queueName."},{"name":"receivedDateTime","in":"query","type":"string","required":false,"description":"Indicates the date and time when the request to pay message is received for payer and requestor"},{"name":"company","in":"query","type":"string","required":false,"description":"The company code"},{"name":"status","in":"query","type":"string","required":false,"description":"The status of the early maturity request"},{"name":"party","in":"query","type":"string","required":false,"description":"Specifies customer information."},{"name":"additionalInformation","in":"query","type":"string","required":false,"description":"Contains additional information for raising the information request in free text form."},{"name":"numberOfItems","in":"query","type":"string","required":false,"description":"Contains the total number of items, as captured during bulk creation."},{"name":"inputter","in":"query","type":"string","required":false,"description":"The user identifier who input the transaction"},{"name":"recordStatus","in":"query","type":"string","required":false,"description":"General status of the record. Possible values: - null - authorised - IHLD - input, on hold - INAU - input, not authorised - INA2 - input, authorised, pending second authorisation - INAO - input, not a"},{"name":"channel","in":"query","type":"string","required":false,"description":"Contains the channel in which the activity was performed. If pricing is not determined based on channel, then this is not significant"},{"name":"paymentIndicator","in":"query","type":"string","required":false,"description":"Indicates whether its a credit/debit type of bill"},{"name":"format","in":"query","type":"string","required":false,"description":"Indicates the formatting version to be used for the delivery message"},{"name":"type","in":"query","type":"string","required":false,"description":"The product condition has an activity type associated that drives an action."},{"name":"fileName","in":"query","type":"string","required":false,"description":"Identifies the type of methods to be listed. Possible values are FX.DEAL.METHOD, BROKER or blank."},{"name":"typeIndicator","in":"query","type":"string","required":false,"description":"Indicates if the record is an Income or Expense"},{"name":"numberOfItems","in":"query","type":"string","required":false,"description":"Contains the total number of items, as captured during bulk creation."},{"name":"errorCode","in":"query","type":"string","required":false,"description":"Indicates the error code which is encountered during payment processing as returned by payment system "},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"ReceivedFileExceptionResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/order/payments/receivedFiles/bulks/exceptions","fullPath":"/api/v1.1.0/order/payments/receivedFiles/bulks/exceptions","operationId":"getReceivedBulkException","name":"Retrieves the list of bulk placed in repair due to mapping issues and awaiting manual action.","summary":"Retrieves bulks received and waiting in repair","tags":["OTHERS"],"parameters":[{"name":"id","in":"query","type":"string","required":false,"description":"Contains the daily position class id."},{"name":"company","in":"query","type":"string","required":false,"description":"The company code"},{"name":"originalFileReference","in":"query","type":"string","required":false,"description":"Indicates reference of the incoming file for which response is being sent"},{"name":"bulkReference","in":"query","type":"string","required":false,"description":"Contains bulk master reference for the payment."},{"name":"bulkFileReferenceApi","in":"query","type":"string","required":false,"description":"Indicates the API that will be invoked to derive at the bulk and file reference if the clearing has a specific requirement."},{"name":"creationDateTime","in":"query","type":"string","required":false,"description":"Date and Time of the message creation."},{"name":"format","in":"query","type":"string","required":false,"description":"Indicates the formatting version to be used for the delivery message"},{"name":"paymentType","in":"query","type":"string","required":false,"description":"Indicates if the payment is Customer (C) type or Bank (B) type"},{"name":"sendersCorrespondentAddress","in":"query","type":"string","required":false,"description":"Contains additional address lines of the sender correspondent institution."},{"name":"receiversCorrespondentAddress","in":"query","type":"string","required":false,"description":"Contains additional address lines of the receiver correspondent institution."},{"name":"numberOfTransaction","in":"query","type":"string","required":false,"description":"Indicates the number of transactions performed on the contract or the account"},{"name":"settlementAmount","in":"query","type":"string","required":false,"description":"Amount of settlement"},{"name":"settlementCurrency","in":"query","type":"string","required":false,"description":"The currency of the trade settlement"},{"name":"settlementDate","in":"query","type":"string","required":false,"description":"Indicates the settlement date of the payment transaction"},{"name":"bulkReferenceId","in":"query","type":"string","required":false,"description":"Contains the bulk master reference for the payment."},{"name":"bulkMasterId","in":"query","type":"string","required":false,"description":"Uniquely identifies each bulk payment request.The reference number is automatically generated by the system."},{"name":"errorCode","in":"query","type":"string","required":false,"description":"Indicates the error code which is encountered during payment processing as returned by payment system "},{"name":"errorInfo","in":"query","type":"string","required":false,"description":"Contains the details of the error such as error source and error message"},{"name":"batchBookingPreferred","in":"query","type":"string","required":false,"description":"If batchBookingPrefered is set to true, then bulkType is defaulted to SINGLE (Single consolidated accounting entry on the debtor account). If set to false, then bulkType is defaulted to MULTI(Individu"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"ReceivedBulkExceptionResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/order/payments/sentFiles/bulks/exceptions","fullPath":"/api/v1.1.0/order/payments/sentFiles/bulks/exceptions","operationId":"getSentBulksExceptions","name":"Retrieves the list of  bulks that are rejected by clearing and awaiting manual action","summary":"Retrieves bulk sent and waiting in repair","tags":["OTHERS"],"parameters":[{"name":"id","in":"query","type":"string","required":false,"description":"Contains the daily position class id."},{"name":"company","in":"query","type":"string","required":false,"description":"The company code"},{"name":"fileSendersReference","in":"query","type":"string","required":false,"description":"Indicates the sender reference that comes from the inward payment file"},{"name":"bulkReference","in":"query","type":"string","required":false,"description":"Contains bulk master reference for the payment."},{"name":"format","in":"query","type":"string","required":false,"description":"Indicates the formatting version to be used for the delivery message"},{"name":"paymentType","in":"query","type":"string","required":false,"description":"Indicates if the payment is Customer (C) type or Bank (B) type"},{"name":"applicantAddress","in":"query","type":"string","required":false,"description":"Indicates the name and address of the applicant of the Letter of Credit"},{"name":"beneficiaryAddress","in":"query","type":"string","required":false,"description":"The address of the Beneficiary if the customer number of the Beneficiary is not known"},{"name":"numberOfTransaction","in":"query","type":"string","required":false,"description":"Indicates the number of transactions performed on the contract or the account"},{"name":"settlementAmount","in":"query","type":"string","required":false,"description":"Amount of settlement"},{"name":"settlementCurrency","in":"query","type":"string","required":false,"description":"The currency of the trade settlement"},{"name":"settlementDate","in":"query","type":"string","required":false,"description":"Indicates the settlement date of the payment transaction"},{"name":"eventStatus","in":"query","type":"string","required":false,"description":"Specifies the status of the request.Allowed values are - With Bank_With Customer_Approved_Rejected."},{"name":"bulkReferenceId","in":"query","type":"string","required":false,"description":"Contains the bulk master reference for the payment."},{"name":"reasonCode","in":"query","type":"string","required":false,"description":"Contains the reason for raising the information request in a coded form."},{"name":"proprietaryTransactionCode","in":"query","type":"string","required":false,"description":"Contains the proprietary bank transaction code to identify the underlying transaction."},{"name":"statusCode","in":"query","type":"string","required":false,"description":"Status code, as defined by the institution"},{"name":"clearingDate","in":"query","type":"string","required":false,"description":"Contains the date from which the payment is expected and is used to indicate the exposure date for the payment."},{"name":"userActivity","in":"query","type":"string","required":false,"description":"Indicates the activity which was triggered by User"},{"name":"sourceType","in":"query","type":"string","required":false,"description":"Indicates source type to determine base amount. Possible values are BALANCE (base amount of a property), ACTIVITY ( transaction amount against an activity) or PROPERTY (this type is currently not supp"},{"name":"uniqueFlag","in":"query","type":"string","required":false,"description":"Flag to indicate unique row"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"SentBulksExceptionsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/order/payments/sentFiles/files/exceptions","fullPath":"/api/v1.1.0/order/payments/sentFiles/files/exceptions","operationId":"getSentFilesExceptions","name":"Retrieves the list of payment files that are rejected by clearing and awaiting manual action","summary":"Retrieves file sent and waiting in repair","tags":["OTHERS"],"parameters":[{"name":"id","in":"query","type":"string","required":false,"description":"Contains the daily position class id."},{"name":"company","in":"query","type":"string","required":false,"description":"The company code"},{"name":"fileSendersReference","in":"query","type":"string","required":false,"description":"Indicates the sender reference that comes from the inward payment file"},{"name":"date","in":"query","type":"string","required":false,"description":"Indicates the date on which activity was performed"},{"name":"fileName","in":"query","type":"string","required":false,"description":"Identifies the type of methods to be listed. Possible values are FX.DEAL.METHOD, BROKER or blank."},{"name":"fileExtension","in":"query","type":"string","required":false,"description":"Specifies the upload file extension type. For example CSV, XML or PDF etc."},{"name":"typeIndicator","in":"query","type":"string","required":false,"description":"Indicates if the record is an Income or Expense"},{"name":"outputChannel","in":"query","type":"string","required":false,"description":"Contains the channel that will be used to send the outward payment message"},{"name":"creationDateTime","in":"query","type":"string","required":false,"description":"Date and Time of the message creation."},{"name":"acknowledgementStatus","in":"query","type":"string","required":false,"description":"Contains the code for ack/nack - accepted or rejected by the clearing. For example: 0 - success acknowledegement , 1 - failure negative acknowledgement"},{"name":"noOfEntries","in":"query","type":"string","required":false,"description":"Indicates the number of entries to be retrieved when transaction history for an account is requested."},{"name":"dealReference","in":"query","type":"string","required":false,"description":"Identifies the transaction reference of the Deal"},{"name":"reasonCode","in":"query","type":"string","required":false,"description":"Contains the reason for raising the information request in a coded form."},{"name":"statusCode","in":"query","type":"string","required":false,"description":"Status code, as defined by the institution"},{"name":"clearingDate","in":"query","type":"string","required":false,"description":"Contains the date from which the payment is expected and is used to indicate the exposure date for the payment."},{"name":"originalFileReference","in":"query","type":"string","required":false,"description":"Indicates reference of the incoming file for which response is being sent"},{"name":"sourceType","in":"query","type":"string","required":false,"description":"Indicates source type to determine base amount. Possible values are BALANCE (base amount of a property), ACTIVITY ( transaction amount against an activity) or PROPERTY (this type is currently not supp"},{"name":"processingDate","in":"query","type":"string","required":false,"description":"The date when payment instruction is processed in system."},{"name":"beneficiaryAddress","in":"query","type":"string","required":false,"description":"The address of the Beneficiary if the customer number of the Beneficiary is not known"},{"name":"errorInfo","in":"query","type":"string","required":false,"description":"Contains the details of the error such as error source and error message"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"SentFilesExceptionsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/order/payments/swift/abortNotifications","fullPath":"/api/v1.1.0/order/payments/swift/abortNotifications","operationId":"getSwiftAbortNotificationsReceived","name":"Retrieves the list of payments for which SWIFT abort notifications have been received","summary":"Retrieves received SWIFT abort notifications","tags":["OTHERS"],"parameters":[{"name":"company","in":"query","type":"string","required":false,"description":"The company code"},{"name":"sendersReference","in":"query","type":"string","required":false,"description":"Indicates the incoming sender's reference i.e. tag 20 of incoming SWIFT or in case when transaction is received from other system/ application, this can also indicate the reference number of that syst"},{"name":"receiver","in":"query","type":"string","required":false,"description":"Identifies the receiver of the message"},{"name":"errorCode","in":"query","type":"string","required":false,"description":"Indicates the error code which is encountered during payment processing as returned by payment system "},{"name":"errorInfo","in":"query","type":"string","required":false,"description":"Contains the details of the error such as error source and error message"},{"name":"messageType","in":"query","type":"string","required":false,"description":"Contains the message type of the information request."},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"SwiftAbortNotificationsReceivedResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/order/payments/swift/iso/exceptions","fullPath":"/api/v1.1.0/order/payments/swift/iso/exceptions","operationId":"getSwiftISOExceptionPayments","name":"Retrieves the list of ISO business exception payments which are pending for manual action","summary":"Retrieves ISO business exception payments","tags":["OTHERS"],"parameters":[{"name":"ftnumber","in":"query","type":"string","required":false,"description":"Deprecated - Transaction reference"},{"name":"sendersReference","in":"query","type":"string","required":false,"description":"Indicates the incoming sender's reference i.e. tag 20 of incoming SWIFT or in case when transaction is received from other system/ application, this can also indicate the reference number of that syst"},{"name":"bulkReference","in":"query","type":"string","required":false,"description":"Contains bulk master reference for the payment."},{"name":"acknowledgementType","in":"query","type":"string","required":false,"description":"Contains the ack/nack message type name. For example: admi.007."},{"name":"messageType","in":"query","type":"string","required":false,"description":"Contains the message type of the information request."},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"SwiftISOExceptionPaymentsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/order/payments/sentFiles/transactions/exceptions","fullPath":"/api/v1.1.0/order/payments/sentFiles/transactions/exceptions","operationId":"getPaymentSentFilesTransactionsExceptions","name":"Retrieves the list of transactions that are rejected by clearing and awaiting manual action","summary":"Retrieves  transaction sent and waiting in repair","tags":["OTHERS"],"parameters":[{"name":"id","in":"query","type":"string","required":false,"description":"Contains the daily position class id."},{"name":"company","in":"query","type":"string","required":false,"description":"The company code"},{"name":"ftnumber","in":"query","type":"string","required":false,"description":"Deprecated - Transaction reference"},{"name":"sendersReference","in":"query","type":"string","required":false,"description":"Indicates the incoming sender's reference i.e. tag 20 of incoming SWIFT or in case when transaction is received from other system/ application, this can also indicate the reference number of that syst"},{"name":"dateTime","in":"query","type":"string","required":false,"description":"Contains the date and time separated by '-'"},{"name":"messageType","in":"query","type":"string","required":false,"description":"Contains the message type of the information request."},{"name":"messageContent","in":"query","type":"string","required":false,"description":"It indicates whether only the current information or previous and current information needs to be passed to form the message."},{"name":"ackStatus","in":"query","type":"string","required":false,"description":"Deprecated - Acknowledgement status"},{"name":"acceptMessage","in":"query","type":"string","required":false,"description":"Indicates whether the account officer will accept secure message."},{"name":"message","in":"query","type":"string","required":false,"description":"The actual Transact error message "},{"name":"deliveryReference","in":"query","type":"string","required":false,"description":"Indicates the delivery reference Id generated for the activity"},{"name":"fileSendersReference","in":"query","type":"string","required":false,"description":"Indicates the sender reference that comes from the inward payment file"},{"name":"bulkReference","in":"query","type":"string","required":false,"description":"Contains bulk master reference for the payment."},{"name":"reasonCode","in":"query","type":"string","required":false,"description":"Contains the reason for raising the information request in a coded form."},{"name":"proprietaryTransactionCode","in":"query","type":"string","required":false,"description":"Contains the proprietary bank transaction code to identify the underlying transaction."},{"name":"statusCode","in":"query","type":"string","required":false,"description":"Status code, as defined by the institution"},{"name":"clearingDate","in":"query","type":"string","required":false,"description":"Contains the date from which the payment is expected and is used to indicate the exposure date for the payment."},{"name":"userActivity","in":"query","type":"string","required":false,"description":"Indicates the activity which was triggered by User"},{"name":"settlementDate","in":"query","type":"string","required":false,"description":"Indicates the settlement date of the payment transaction"},{"name":"senderBankBic","in":"query","type":"string","required":false,"description":"Indicates the sending bank BIC Code"},{"name":"sourceType","in":"query","type":"string","required":false,"description":"Indicates source type to determine base amount. Possible values are BALANCE (base amount of a property), ACTIVITY ( transaction amount against an activity) or PROPERTY (this type is currently not supp"},{"name":"messageId","in":"query","type":"string","required":false,"description":"The holds the record key of the message ID."},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"PaymentSentFilesTransactionsExceptionsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/order/payments/swift/iso/technicalExceptions","fullPath":"/api/v1.1.0/order/payments/swift/iso/technicalExceptions","operationId":"getSwiftIsoTechnicalExceptionPayments","name":"Retrieves the list of SWIFT ISO technical exception payments which are pending for manual action","summary":"Retrieves SWIFT ISO technical exception payments","tags":["OTHERS"],"parameters":[{"name":"channel","in":"query","type":"string","required":false,"description":"Contains the channel in which the activity was performed. If pricing is not determined based on channel, then this is not significant"},{"name":"company","in":"query","type":"string","required":false,"description":"The company code"},{"name":"ftnumber","in":"query","type":"string","required":false,"description":"Deprecated - Transaction reference"},{"name":"amount","in":"query","type":"string","required":false,"description":"Contains the direct debit claim amount"},{"name":"currency","in":"query","type":"string","required":false,"description":"Contains the currency of the mandate account"},{"name":"date","in":"query","type":"string","required":false,"description":"Indicates the date on which activity was performed"},{"name":"statusCode","in":"query","type":"string","required":false,"description":"Status code, as defined by the institution"},{"name":"errorCode","in":"query","type":"string","required":false,"description":"Indicates the error code which is encountered during payment processing as returned by payment system "},{"name":"uniqueFlag","in":"query","type":"string","required":false,"description":"Flag to indicate unique row"},{"name":"coverControl","in":"query","type":"string","required":false,"description":"Indicates whether the limit is applicable for the virtual accounts or not"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"SwiftIsoTechnicalExceptionPaymentsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/order/payments/cover/exceptions","fullPath":"/api/v1.1.0/order/payments/cover/exceptions","operationId":"getExceptionCoverPayments","name":"Retrieves the list of unmatched cover payments, which have to be manually matched by an operator.","summary":"Retrieves unmatched cover payments","tags":["OTHERS"],"parameters":[{"name":"clearingTransactionType","in":"query","type":"string","required":false,"description":"Indicates the Clearing transaction type."},{"name":"creditCustomerId","in":"query","type":"string","required":false,"description":"Creditor customer id details"},{"name":"customerOrBankTransfer","in":"query","type":"string","required":false,"description":"Indicates if the payment was initiated by Customer or the financial institution"},{"name":"customerSpecifiedReference","in":"query","type":"string","required":false,"description":"Deprecated - Customer specified reference"},{"name":"debitCustomerId","in":"query","type":"string","required":false,"description":"Debtor customer details"},{"name":"paymentDirection","in":"query","type":"string","required":false,"description":"Indicates the direction of payment i.e. incoming, outgoing, book or redirect"},{"name":"endToEndReference","in":"query","type":"string","required":false,"description":"Indicates the end to end reference for the payment. This field can be provided by the person who instructs the payment and this flows through the lifecycle of the payment."},{"name":"entryDateTime","in":"query","type":"string","required":false,"description":"Contains the payment creation time"},{"name":"fileSendersReference","in":"query","type":"string","required":false,"description":"Indicates the sender reference that comes from the inward payment file"},{"name":"paymentId","in":"query","type":"string","required":false,"description":"Indicates the unique reference number of the payment"},{"name":"incomingMessageType","in":"query","type":"string","required":false,"description":"Indicates the supported message type to be received from the clearing house or the direct participant."},{"name":"company","in":"query","type":"string","required":false,"description":"The company code"},{"name":"processingDate","in":"query","type":"string","required":false,"description":"The date when payment instruction is processed in system."},{"name":"partySendersReferenceIncoming","in":"query","type":"string","required":false,"description":"Debtor payment reference details of incoming"},{"name":"partySendersReferenceOutgoing","in":"query","type":"string","required":false,"description":"Debtor payment reference details of outgoing"},{"name":"statusCode","in":"query","type":"string","required":false,"description":"Status code, as defined by the institution"},{"name":"transactionAmount","in":"query","type":"string","required":false,"description":"Contains the transaction amount. This is based on the currency, either local or foreign currency"},{"name":"transactionCurrency","in":"query","type":"string","required":false,"description":"Indicates the currency of the transaction. For example GBP, USD etc."},{"name":"transactionReference","in":"query","type":"string","required":false,"description":"Contains the identifier for the transaction in the core system"},{"name":"valueDate","in":"query","type":"string","required":false,"description":"Contains the value date of the claim or the date on which the amount to be claimed"},{"name":"paymentSource","in":"query","type":"string","required":false,"description":"Indicates the source from where the payment is originated"},{"name":"channel","in":"query","type":"string","required":false,"description":"Contains the channel in which the activity was performed. If pricing is not determined based on channel, then this is not significant"},{"name":"senderBankBic","in":"query","type":"string","required":false,"description":"Indicates the sending bank BIC Code"},{"name":"receiver","in":"query","type":"string","required":false,"description":"Identifies the receiver of the message"},{"name":"debtorAccountId","in":"query","type":"string","required":false,"description":"Contains the identification assigned by an institution to identify a debtor account by the account owner."},{"name":"beneficiaryAccountId","in":"query","type":"string","required":false,"description":"Unique account identifier of the beneficiary account number."},{"name":"scheme","in":"query","type":"string","required":false,"description":"Represents the scheme (a synonym for the National ID type) under which the National ID is defined"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"ExceptionCoverPaymentsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}}]},{"key":"order-payments-operationalQueueListingExceptions-v1.2.0","title":"Operational Queue Listing Exceptions","version":"v1.2.0","description":"Retrieve the list of payments that are available in the exception queue for manual action.","endpointCount":15,"endpoints":[{"method":"GET","path":"/order/payments/swift/pendings","fullPath":"/api/v1.2.0/order/payments/swift/pendings","operationId":"getSwiftMessageWaitingToBeSent","name":"Retrieves the list of SWIFT payment awaiting to be sent to SWIFT","summary":"Retrieves SWIFT payments waiting to be sent.","tags":["OTHERS"],"parameters":[{"name":"clearingTransactionType","in":"query","type":"string","required":false,"description":"Indicates the Clearing transaction type."},{"name":"creditCustomerId","in":"query","type":"string","required":false,"description":"Creditor customer id details"},{"name":"customerOrBankTransfer","in":"query","type":"string","required":false,"description":"Indicates if the payment was initiated by Customer or the financial institution"},{"name":"customerSpecifiedReference","in":"query","type":"string","required":false,"description":"Deprecated - Customer specified reference"},{"name":"debitCustomerId","in":"query","type":"string","required":false,"description":"Debtor customer details"},{"name":"paymentDirection","in":"query","type":"string","required":false,"description":"Indicates the direction of payment i.e. incoming, outgoing, book or redirect"},{"name":"endToEndReference","in":"query","type":"string","required":false,"description":"Indicates the end to end reference for the payment. This field can be provided by the person who instructs the payment and this flows through the lifecycle of the payment."},{"name":"entryDateTime","in":"query","type":"string","required":false,"description":"Contains the payment creation time"},{"name":"fileSendersReference","in":"query","type":"string","required":false,"description":"Indicates the sender reference that comes from the inward payment file"},{"name":"paymentId","in":"query","type":"string","required":false,"description":"Indicates the unique reference number of the payment"},{"name":"incomingMessageType","in":"query","type":"string","required":false,"description":"Indicates the supported message type to be received from the clearing house or the direct participant."},{"name":"company","in":"query","type":"string","required":false,"description":"The company code"},{"name":"processingDate","in":"query","type":"string","required":false,"description":"The date when payment instruction is processed in system."},{"name":"partySendersReferenceIncoming","in":"query","type":"string","required":false,"description":"Debtor payment reference details of incoming"},{"name":"partySendersReferenceOutgoing","in":"query","type":"string","required":false,"description":"Debtor payment reference details of outgoing"},{"name":"statusCode","in":"query","type":"string","required":false,"description":"Status code, as defined by the institution"},{"name":"transactionAmount","in":"query","type":"string","required":false,"description":"Contains the transaction amount. This is based on the currency, either local or foreign currency"},{"name":"transactionCurrency","in":"query","type":"string","required":false,"description":"Indicates the currency of the transaction. For example GBP, USD etc."},{"name":"transactionReference","in":"query","type":"string","required":false,"description":"Contains the identifier for the transaction in the core system"},{"name":"paymentSource","in":"query","type":"string","required":false,"description":"Indicates the source from where the payment is originated"},{"name":"channel","in":"query","type":"string","required":false,"description":"Contains the channel in which the activity was performed. If pricing is not determined based on channel, then this is not significant"},{"name":"senderBankBic","in":"query","type":"string","required":false,"description":"Indicates the sending bank BIC Code"},{"name":"receiver","in":"query","type":"string","required":false,"description":"Identifies the receiver of the message"},{"name":"debtorAccountId","in":"query","type":"string","required":false,"description":"Contains the identification assigned by an institution to identify a debtor account by the account owner."},{"name":"beneficiaryAccountId","in":"query","type":"string","required":false,"description":"Unique account identifier of the beneficiary account number."},{"name":"scheme","in":"query","type":"string","required":false,"description":"Represents the scheme (a synonym for the National ID type) under which the National ID is defined"},{"name":"valueDate","in":"query","type":"string","required":false,"description":"Contains the value date of the claim or the date on which the amount to be claimed"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"SwiftMessageWaitingToBeSentResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/order/payments/forexLimitStatus/pendings","fullPath":"/api/v1.2.0/order/payments/forexLimitStatus/pendings","operationId":"getPaymentsPendingForexLimitUpdate","name":"Retrieves the list of payments special rate from treasury and can be manually actioned","summary":"Retrieves payments awaiting forex limit status update","tags":["OTHERS"],"parameters":[{"name":"transactionref","in":"query","type":"string","required":false,"description":"Deprecated - Transaction reference"},{"name":"counterparty","in":"query","type":"string","required":false,"description":"The counterparty ID  for the  deal."},{"name":"internalReference","in":"query","type":"string","required":false,"description":"Another ID for the transaction for retrieval purposes or it can be used for the bank to use a unique guarantee number rather than the system generated ID"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"PaymentsPendingForexLimitUpdateResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/order/payments/highValues/exchangeRates/pendings","fullPath":"/api/v1.2.0/order/payments/highValues/exchangeRates/pendings","operationId":"getPaymentsPendingTreasuryRate","name":"Retrieves the list of payment waiting for treasury rate from treasury","summary":"Retrieves high value payments awaiting special rate from treasury","tags":["OTHERS"],"parameters":[{"name":"id","in":"query","type":"string","required":false,"description":"Contains the daily position class id."},{"name":"dealType","in":"query","type":"string","required":false,"description":"Foreign Exchange deal type. Allowed values: - SP(spot) - FW(forward) - SW(Swap)"},{"name":"orderType","in":"query","type":"string","required":false,"description":"Identifies the type of the order. Possible values are Single, Ifdone, Revol, oco. Single order - only one order item may be input. If done order -  If one order gets executed, the other order is also "},{"name":"internalReference","in":"query","type":"string","required":false,"description":"Another ID for the transaction for retrieval purposes or it can be used for the bank to use a unique guarantee number rather than the system generated ID"},{"name":"rate","in":"query","type":"string","required":false,"description":"The rate applied"},{"name":"currency","in":"query","type":"string","required":false,"description":"Contains the currency of the mandate account"},{"name":"orderAmount","in":"query","type":"string","required":false,"description":"The amount of the order"},{"name":"expiryDate","in":"query","type":"string","required":false,"description":"This indicates the  date  on which the offer or privilege terminates for the event."},{"name":"buyRate","in":"query","type":"string","required":false,"description":"The exchange rate at which is currency is bought."},{"name":"submitOrder","in":"query","type":"string","required":false,"description":"Contains the options yes or no to submit a payment order for execution."},{"name":"cancelOrder","in":"query","type":"string","required":false,"description":"Option to cancel an order."},{"name":"orderToClose","in":"query","type":"string","required":false,"description":"Defines whether the trade order is to be Closed or not. When set to CLOSE the order is considered as a square-off order."},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"PaymentsPendingTreasuryRateResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/order/payments/swift/negativeAcknowledgements/pendings","fullPath":"/api/v1.2.0/order/payments/swift/negativeAcknowledgements/pendings","operationId":"getSwiftOutException","name":"Retrieves the list of SWIFT payments that are in exception queue for an operator to action","summary":"Retrieves SWIFT out payments that are in exception","tags":["OTHERS"],"parameters":[{"name":"company","in":"query","type":"string","required":false,"description":"The company code"},{"name":"paymentId","in":"query","type":"string","required":false,"description":"Indicates the unique reference number of the payment"},{"name":"transactionAmount","in":"query","type":"string","required":false,"description":"Contains the transaction amount. This is based on the currency, either local or foreign currency"},{"name":"transactionCurrency","in":"query","type":"string","required":false,"description":"Indicates the currency of the transaction. For example GBP, USD etc."},{"name":"paymentMsgSentDate","in":"query","type":"string","required":false,"description":"Indicates the date on which payment message (MT103, MT202) is sent out to the receiving bank or clearing."},{"name":"statusCode","in":"query","type":"string","required":false,"description":"Status code, as defined by the institution"},{"name":"channel","in":"query","type":"string","required":false,"description":"Contains the channel in which the activity was performed. If pricing is not determined based on channel, then this is not significant"},{"name":"errorCode","in":"query","type":"string","required":false,"description":"Indicates the error code which is encountered during payment processing as returned by payment system "},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"SwiftOutExceptionResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/order/payments/screenings/exceptions","fullPath":"/api/v1.2.0/order/payments/screenings/exceptions","operationId":"getScreeningHitPayments","name":"Retrieves the list of payment for which true hit response have been received","summary":"Retrieves screening hit payments","tags":["OTHERS"],"parameters":[{"name":"clearingTransactionType","in":"query","type":"string","required":false,"description":"Indicates the Clearing transaction type."},{"name":"creditCustomerId","in":"query","type":"string","required":false,"description":"Creditor customer id details"},{"name":"customerOrBankTransfer","in":"query","type":"string","required":false,"description":"Indicates if the payment was initiated by Customer or the financial institution"},{"name":"customerSpecifiedReference","in":"query","type":"string","required":false,"description":"Deprecated - Customer specified reference"},{"name":"debitCustomerId","in":"query","type":"string","required":false,"description":"Debtor customer details"},{"name":"paymentDirection","in":"query","type":"string","required":false,"description":"Indicates the direction of payment i.e. incoming, outgoing, book or redirect"},{"name":"endToEndReference","in":"query","type":"string","required":false,"description":"Indicates the end to end reference for the payment. This field can be provided by the person who instructs the payment and this flows through the lifecycle of the payment."},{"name":"entryDateTime","in":"query","type":"string","required":false,"description":"Contains the payment creation time"},{"name":"fileSendersReference","in":"query","type":"string","required":false,"description":"Indicates the sender reference that comes from the inward payment file"},{"name":"paymentId","in":"query","type":"string","required":false,"description":"Indicates the unique reference number of the payment"},{"name":"incomingMessageType","in":"query","type":"string","required":false,"description":"Indicates the supported message type to be received from the clearing house or the direct participant."},{"name":"company","in":"query","type":"string","required":false,"description":"The company code"},{"name":"processingDate","in":"query","type":"string","required":false,"description":"The date when payment instruction is processed in system."},{"name":"partySendersReferenceIncoming","in":"query","type":"string","required":false,"description":"Debtor payment reference details of incoming"},{"name":"partySendersReferenceOutgoing","in":"query","type":"string","required":false,"description":"Debtor payment reference details of outgoing"},{"name":"statusCode","in":"query","type":"string","required":false,"description":"Status code, as defined by the institution"},{"name":"transactionAmount","in":"query","type":"string","required":false,"description":"Contains the transaction amount. This is based on the currency, either local or foreign currency"},{"name":"transactionCurrency","in":"query","type":"string","required":false,"description":"Indicates the currency of the transaction. For example GBP, USD etc."},{"name":"transactionReference","in":"query","type":"string","required":false,"description":"Contains the identifier for the transaction in the core system"},{"name":"valueDate","in":"query","type":"string","required":false,"description":"Contains the value date of the claim or the date on which the amount to be claimed"},{"name":"paymentSource","in":"query","type":"string","required":false,"description":"Indicates the source from where the payment is originated"},{"name":"channel","in":"query","type":"string","required":false,"description":"Contains the channel in which the activity was performed. If pricing is not determined based on channel, then this is not significant"},{"name":"senderBankBic","in":"query","type":"string","required":false,"description":"Indicates the sending bank BIC Code"},{"name":"receiver","in":"query","type":"string","required":false,"description":"Identifies the receiver of the message"},{"name":"debtorAccountId","in":"query","type":"string","required":false,"description":"Contains the identification assigned by an institution to identify a debtor account by the account owner."},{"name":"beneficiaryAccountId","in":"query","type":"string","required":false,"description":"Unique account identifier of the beneficiary account number."},{"name":"scheme","in":"query","type":"string","required":false,"description":"Represents the scheme (a synonym for the National ID type) under which the National ID is defined"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"ScreeningHitPaymentsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/order/payments/repairs/pendings","fullPath":"/api/v1.2.0/order/payments/repairs/pendings","operationId":"getPaymentPendingManualRepair","name":"Retrieves the list of payments parked in the repair queue for an operator to review and take necessary action.","summary":"Retrieves payment transactions awaiting manual repair","tags":["OTHERS"],"parameters":[{"name":"clearingTransactionType","in":"query","type":"string","required":false,"description":"Indicates the Clearing transaction type."},{"name":"creditCustomerId","in":"query","type":"string","required":false,"description":"Creditor customer id details"},{"name":"customerOrBankTransfer","in":"query","type":"string","required":false,"description":"Indicates if the payment was initiated by Customer or the financial institution"},{"name":"customerSpecifiedReference","in":"query","type":"string","required":false,"description":"Deprecated - Customer specified reference"},{"name":"debitCustomerId","in":"query","type":"string","required":false,"description":"Debtor customer details"},{"name":"paymentDirection","in":"query","type":"string","required":false,"description":"Indicates the direction of payment i.e. incoming, outgoing, book or redirect"},{"name":"endToEndReference","in":"query","type":"string","required":false,"description":"Indicates the end to end reference for the payment. This field can be provided by the person who instructs the payment and this flows through the lifecycle of the payment."},{"name":"entryDateTime","in":"query","type":"string","required":false,"description":"Contains the payment creation time"},{"name":"fileSendersReference","in":"query","type":"string","required":false,"description":"Indicates the sender reference that comes from the inward payment file"},{"name":"paymentId","in":"query","type":"string","required":false,"description":"Indicates the unique reference number of the payment"},{"name":"incomingMessageType","in":"query","type":"string","required":false,"description":"Indicates the supported message type to be received from the clearing house or the direct participant."},{"name":"company","in":"query","type":"string","required":false,"description":"The company code"},{"name":"processingDate","in":"query","type":"string","required":false,"description":"The date when payment instruction is processed in system."},{"name":"partySendersReferenceIncoming","in":"query","type":"string","required":false,"description":"Debtor payment reference details of incoming"},{"name":"partySendersReferenceOutgoing","in":"query","type":"string","required":false,"description":"Debtor payment reference details of outgoing"},{"name":"statusCode","in":"query","type":"string","required":false,"description":"Status code, as defined by the institution"},{"name":"transactionAmount","in":"query","type":"string","required":false,"description":"Contains the transaction amount. This is based on the currency, either local or foreign currency"},{"name":"transactionCurrency","in":"query","type":"string","required":false,"description":"Indicates the currency of the transaction. For example GBP, USD etc."},{"name":"transactionReference","in":"query","type":"string","required":false,"description":"Contains the identifier for the transaction in the core system"},{"name":"paymentSource","in":"query","type":"string","required":false,"description":"Indicates the source from where the payment is originated"},{"name":"channel","in":"query","type":"string","required":false,"description":"Contains the channel in which the activity was performed. If pricing is not determined based on channel, then this is not significant"},{"name":"senderBankBic","in":"query","type":"string","required":false,"description":"Indicates the sending bank BIC Code"},{"name":"receiver","in":"query","type":"string","required":false,"description":"Identifies the receiver of the message"},{"name":"debtorAccountId","in":"query","type":"string","required":false,"description":"Contains the identification assigned by an institution to identify a debtor account by the account owner."},{"name":"beneficiaryAccountId","in":"query","type":"string","required":false,"description":"Unique account identifier of the beneficiary account number."},{"name":"scheme","in":"query","type":"string","required":false,"description":"Represents the scheme (a synonym for the National ID type) under which the National ID is defined"},{"name":"valueDate","in":"query","type":"string","required":false,"description":"Contains the value date of the claim or the date on which the amount to be claimed"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"PaymentPendingManualRepairResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/order/payments/receivedFiles/files/exceptions","fullPath":"/api/v1.2.0/order/payments/receivedFiles/files/exceptions","operationId":"getReceivedFileException","name":"Retrieves the list of files placed in repair due to transformation issues and awaiting manual action.","summary":"Retrieves files received and waiting in repair","tags":["OTHERS"],"parameters":[{"name":"originalFileReference","in":"query","type":"string","required":false,"description":"Indicates reference of the incoming file for which response is being sent"},{"name":"queueName","in":"query","type":"string","required":false,"description":"For queue to queue configuration this field can be used to specify appropriate queue name with a prefix as CFNAME-queueName."},{"name":"receivedDateTime","in":"query","type":"string","required":false,"description":"Indicates the date and time when the request to pay message is received for payer and requestor"},{"name":"company","in":"query","type":"string","required":false,"description":"The company code"},{"name":"status","in":"query","type":"string","required":false,"description":"The status of the early maturity request"},{"name":"party","in":"query","type":"string","required":false,"description":"Specifies customer information."},{"name":"additionalInformation","in":"query","type":"string","required":false,"description":"Contains additional information for raising the information request in free text form."},{"name":"numberOfItems","in":"query","type":"string","required":false,"description":"Contains the total number of items, as captured during bulk creation."},{"name":"inputter","in":"query","type":"string","required":false,"description":"The user identifier who input the transaction"},{"name":"recordStatus","in":"query","type":"string","required":false,"description":"General status of the record. Possible values: - null - authorised - IHLD - input, on hold - INAU - input, not authorised - INA2 - input, authorised, pending second authorisation - INAO - input, not a"},{"name":"channel","in":"query","type":"string","required":false,"description":"Contains the channel in which the activity was performed. If pricing is not determined based on channel, then this is not significant"},{"name":"paymentIndicator","in":"query","type":"string","required":false,"description":"Indicates whether its a credit/debit type of bill"},{"name":"format","in":"query","type":"string","required":false,"description":"Indicates the formatting version to be used for the delivery message"},{"name":"type","in":"query","type":"string","required":false,"description":"The product condition has an activity type associated that drives an action."},{"name":"fileName","in":"query","type":"string","required":false,"description":"Identifies the type of methods to be listed. Possible values are FX.DEAL.METHOD, BROKER or blank."},{"name":"typeIndicator","in":"query","type":"string","required":false,"description":"Indicates if the record is an Income or Expense"},{"name":"numberOfItems","in":"query","type":"string","required":false,"description":"Contains the total number of items, as captured during bulk creation."},{"name":"errorCode","in":"query","type":"string","required":false,"description":"Indicates the error code which is encountered during payment processing as returned by payment system "},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"ReceivedFileExceptionResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/order/payments/receivedFiles/bulks/exceptions","fullPath":"/api/v1.2.0/order/payments/receivedFiles/bulks/exceptions","operationId":"getReceivedBulkException","name":"Retrieves the list of bulk placed in repair due to mapping issues and awaiting manual action.","summary":"Retrieves bulks received and waiting in repair","tags":["OTHERS"],"parameters":[{"name":"id","in":"query","type":"string","required":false,"description":"Contains the daily position class id."},{"name":"company","in":"query","type":"string","required":false,"description":"The company code"},{"name":"originalFileReference","in":"query","type":"string","required":false,"description":"Indicates reference of the incoming file for which response is being sent"},{"name":"bulkReference","in":"query","type":"string","required":false,"description":"Contains bulk master reference for the payment."},{"name":"bulkFileReferenceApi","in":"query","type":"string","required":false,"description":"Indicates the API that will be invoked to derive at the bulk and file reference if the clearing has a specific requirement."},{"name":"creationDateTime","in":"query","type":"string","required":false,"description":"Date and Time of the message creation."},{"name":"format","in":"query","type":"string","required":false,"description":"Indicates the formatting version to be used for the delivery message"},{"name":"paymentType","in":"query","type":"string","required":false,"description":"Indicates if the payment is Customer (C) type or Bank (B) type"},{"name":"sendersCorrespondentAddress","in":"query","type":"string","required":false,"description":"Contains additional address lines of the sender correspondent institution."},{"name":"receiversCorrespondentAddress","in":"query","type":"string","required":false,"description":"Contains additional address lines of the receiver correspondent institution."},{"name":"numberOfTransaction","in":"query","type":"string","required":false,"description":"Indicates the number of transactions performed on the contract or the account"},{"name":"settlementAmount","in":"query","type":"string","required":false,"description":"Amount of settlement"},{"name":"settlementCurrency","in":"query","type":"string","required":false,"description":"The currency of the trade settlement"},{"name":"settlementDate","in":"query","type":"string","required":false,"description":"Indicates the settlement date of the payment transaction"},{"name":"bulkReferenceId","in":"query","type":"string","required":false,"description":"Contains the bulk master reference for the payment."},{"name":"bulkMasterId","in":"query","type":"string","required":false,"description":"Uniquely identifies each bulk payment request.The reference number is automatically generated by the system."},{"name":"errorCode","in":"query","type":"string","required":false,"description":"Indicates the error code which is encountered during payment processing as returned by payment system "},{"name":"errorInfo","in":"query","type":"string","required":false,"description":"Contains the details of the error such as error source and error message"},{"name":"batchBookingPreferred","in":"query","type":"string","required":false,"description":"If batchBookingPrefered is set to true, then bulkType is defaulted to SINGLE (Single consolidated accounting entry on the debtor account). If set to false, then bulkType is defaulted to MULTI(Individu"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"ReceivedBulkExceptionResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/order/payments/sentFiles/bulks/exceptions","fullPath":"/api/v1.2.0/order/payments/sentFiles/bulks/exceptions","operationId":"getSentBulksExceptions","name":"Retrieves the list of  bulks that are rejected by clearing and awaiting manual action","summary":"Retrieves bulk sent and waiting in repair","tags":["OTHERS"],"parameters":[{"name":"id","in":"query","type":"string","required":false,"description":"Contains the daily position class id."},{"name":"company","in":"query","type":"string","required":false,"description":"The company code"},{"name":"fileSendersReference","in":"query","type":"string","required":false,"description":"Indicates the sender reference that comes from the inward payment file"},{"name":"bulkReference","in":"query","type":"string","required":false,"description":"Contains bulk master reference for the payment."},{"name":"format","in":"query","type":"string","required":false,"description":"Indicates the formatting version to be used for the delivery message"},{"name":"paymentType","in":"query","type":"string","required":false,"description":"Indicates if the payment is Customer (C) type or Bank (B) type"},{"name":"applicantAddress","in":"query","type":"string","required":false,"description":"Indicates the name and address of the applicant of the Letter of Credit"},{"name":"beneficiaryAddress","in":"query","type":"string","required":false,"description":"The address of the Beneficiary if the customer number of the Beneficiary is not known"},{"name":"numberOfTransaction","in":"query","type":"string","required":false,"description":"Indicates the number of transactions performed on the contract or the account"},{"name":"settlementAmount","in":"query","type":"string","required":false,"description":"Amount of settlement"},{"name":"settlementCurrency","in":"query","type":"string","required":false,"description":"The currency of the trade settlement"},{"name":"settlementDate","in":"query","type":"string","required":false,"description":"Indicates the settlement date of the payment transaction"},{"name":"eventStatus","in":"query","type":"string","required":false,"description":"Specifies the status of the request.Allowed values are - With Bank_With Customer_Approved_Rejected."},{"name":"bulkReferenceId","in":"query","type":"string","required":false,"description":"Contains the bulk master reference for the payment."},{"name":"reasonCode","in":"query","type":"string","required":false,"description":"Contains the reason for raising the information request in a coded form."},{"name":"proprietaryTransactionCode","in":"query","type":"string","required":false,"description":"Contains the proprietary bank transaction code to identify the underlying transaction."},{"name":"statusCode","in":"query","type":"string","required":false,"description":"Status code, as defined by the institution"},{"name":"clearingDate","in":"query","type":"string","required":false,"description":"Contains the date from which the payment is expected and is used to indicate the exposure date for the payment."},{"name":"userActivity","in":"query","type":"string","required":false,"description":"Indicates the activity which was triggered by User"},{"name":"sourceType","in":"query","type":"string","required":false,"description":"Indicates source type to determine base amount. Possible values are BALANCE (base amount of a property), ACTIVITY ( transaction amount against an activity) or PROPERTY (this type is currently not supp"},{"name":"uniqueFlag","in":"query","type":"string","required":false,"description":"Flag to indicate unique row"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"SentBulksExceptionsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/order/payments/sentFiles/files/exceptions","fullPath":"/api/v1.2.0/order/payments/sentFiles/files/exceptions","operationId":"getSentFilesExceptions","name":"Retrieves the list of payment files that are rejected by clearing and awaiting manual action","summary":"Retrieves file sent and waiting in repair","tags":["OTHERS"],"parameters":[{"name":"id","in":"query","type":"string","required":false,"description":"Contains the daily position class id."},{"name":"company","in":"query","type":"string","required":false,"description":"The company code"},{"name":"fileSendersReference","in":"query","type":"string","required":false,"description":"Indicates the sender reference that comes from the inward payment file"},{"name":"date","in":"query","type":"string","required":false,"description":"Indicates the date on which activity was performed"},{"name":"fileName","in":"query","type":"string","required":false,"description":"Identifies the type of methods to be listed. Possible values are FX.DEAL.METHOD, BROKER or blank."},{"name":"fileExtension","in":"query","type":"string","required":false,"description":"Specifies the upload file extension type. For example CSV, XML or PDF etc."},{"name":"typeIndicator","in":"query","type":"string","required":false,"description":"Indicates if the record is an Income or Expense"},{"name":"outputChannel","in":"query","type":"string","required":false,"description":"Contains the channel that will be used to send the outward payment message"},{"name":"creationDateTime","in":"query","type":"string","required":false,"description":"Date and Time of the message creation."},{"name":"acknowledgementStatus","in":"query","type":"string","required":false,"description":"Contains the code for ack/nack - accepted or rejected by the clearing. For example: 0 - success acknowledegement , 1 - failure negative acknowledgement"},{"name":"noOfEntries","in":"query","type":"string","required":false,"description":"Indicates the number of entries to be retrieved when transaction history for an account is requested."},{"name":"dealReference","in":"query","type":"string","required":false,"description":"Identifies the transaction reference of the Deal"},{"name":"reasonCode","in":"query","type":"string","required":false,"description":"Contains the reason for raising the information request in a coded form."},{"name":"statusCode","in":"query","type":"string","required":false,"description":"Status code, as defined by the institution"},{"name":"clearingDate","in":"query","type":"string","required":false,"description":"Contains the date from which the payment is expected and is used to indicate the exposure date for the payment."},{"name":"originalFileReference","in":"query","type":"string","required":false,"description":"Indicates reference of the incoming file for which response is being sent"},{"name":"sourceType","in":"query","type":"string","required":false,"description":"Indicates source type to determine base amount. Possible values are BALANCE (base amount of a property), ACTIVITY ( transaction amount against an activity) or PROPERTY (this type is currently not supp"},{"name":"processingDate","in":"query","type":"string","required":false,"description":"The date when payment instruction is processed in system."},{"name":"beneficiaryAddress","in":"query","type":"string","required":false,"description":"The address of the Beneficiary if the customer number of the Beneficiary is not known"},{"name":"errorInfo","in":"query","type":"string","required":false,"description":"Contains the details of the error such as error source and error message"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"SentFilesExceptionsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/order/payments/swift/abortNotifications","fullPath":"/api/v1.2.0/order/payments/swift/abortNotifications","operationId":"getSwiftAbortNotificationsReceived","name":"Retrieves the list of payments for which SWIFT abort notifications have been received","summary":"Retrieves received SWIFT abort notifications","tags":["OTHERS"],"parameters":[{"name":"company","in":"query","type":"string","required":false,"description":"The company code"},{"name":"sendersReference","in":"query","type":"string","required":false,"description":"Indicates the incoming sender's reference i.e. tag 20 of incoming SWIFT or in case when transaction is received from other system/ application, this can also indicate the reference number of that syst"},{"name":"receiver","in":"query","type":"string","required":false,"description":"Identifies the receiver of the message"},{"name":"errorCode","in":"query","type":"string","required":false,"description":"Indicates the error code which is encountered during payment processing as returned by payment system "},{"name":"errorInfo","in":"query","type":"string","required":false,"description":"Contains the details of the error such as error source and error message"},{"name":"messageType","in":"query","type":"string","required":false,"description":"Contains the message type of the information request."},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"SwiftAbortNotificationsReceivedResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/order/payments/swift/iso/exceptions","fullPath":"/api/v1.2.0/order/payments/swift/iso/exceptions","operationId":"getSwiftISOExceptionPayments","name":"Retrieves the list of ISO business exception payments which are pending for manual action","summary":"Retrieves ISO business exception payments","tags":["OTHERS"],"parameters":[{"name":"ftnumber","in":"query","type":"string","required":false,"description":"Deprecated - Transaction reference"},{"name":"sendersReference","in":"query","type":"string","required":false,"description":"Indicates the incoming sender's reference i.e. tag 20 of incoming SWIFT or in case when transaction is received from other system/ application, this can also indicate the reference number of that syst"},{"name":"bulkReference","in":"query","type":"string","required":false,"description":"Contains bulk master reference for the payment."},{"name":"acknowledgementType","in":"query","type":"string","required":false,"description":"Contains the ack/nack message type name. For example: admi.007."},{"name":"messageType","in":"query","type":"string","required":false,"description":"Contains the message type of the information request."},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"SwiftISOExceptionPaymentsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/order/payments/sentFiles/transactions/exceptions","fullPath":"/api/v1.2.0/order/payments/sentFiles/transactions/exceptions","operationId":"getPaymentSentFilesTransactionsExceptions","name":"Retrieves the list of transactions that are rejected by clearing and awaiting manual action","summary":"Retrieves  transaction sent and waiting in repair","tags":["OTHERS"],"parameters":[{"name":"id","in":"query","type":"string","required":false,"description":"Contains the daily position class id."},{"name":"company","in":"query","type":"string","required":false,"description":"The company code"},{"name":"ftnumber","in":"query","type":"string","required":false,"description":"Deprecated - Transaction reference"},{"name":"sendersReference","in":"query","type":"string","required":false,"description":"Indicates the incoming sender's reference i.e. tag 20 of incoming SWIFT or in case when transaction is received from other system/ application, this can also indicate the reference number of that syst"},{"name":"dateTime","in":"query","type":"string","required":false,"description":"Contains the date and time separated by '-'"},{"name":"messageType","in":"query","type":"string","required":false,"description":"Contains the message type of the information request."},{"name":"messageContent","in":"query","type":"string","required":false,"description":"It indicates whether only the current information or previous and current information needs to be passed to form the message."},{"name":"ackStatus","in":"query","type":"string","required":false,"description":"Deprecated - Acknowledgement status"},{"name":"acceptMessage","in":"query","type":"string","required":false,"description":"Indicates whether the account officer will accept secure message."},{"name":"message","in":"query","type":"string","required":false,"description":"The actual Transact error message "},{"name":"deliveryReference","in":"query","type":"string","required":false,"description":"Indicates the delivery reference Id generated for the activity"},{"name":"fileSendersReference","in":"query","type":"string","required":false,"description":"Indicates the sender reference that comes from the inward payment file"},{"name":"bulkReference","in":"query","type":"string","required":false,"description":"Contains bulk master reference for the payment."},{"name":"reasonCode","in":"query","type":"string","required":false,"description":"Contains the reason for raising the information request in a coded form."},{"name":"proprietaryTransactionCode","in":"query","type":"string","required":false,"description":"Contains the proprietary bank transaction code to identify the underlying transaction."},{"name":"statusCode","in":"query","type":"string","required":false,"description":"Status code, as defined by the institution"},{"name":"clearingDate","in":"query","type":"string","required":false,"description":"Contains the date from which the payment is expected and is used to indicate the exposure date for the payment."},{"name":"userActivity","in":"query","type":"string","required":false,"description":"Indicates the activity which was triggered by User"},{"name":"settlementDate","in":"query","type":"string","required":false,"description":"Indicates the settlement date of the payment transaction"},{"name":"senderBankBic","in":"query","type":"string","required":false,"description":"Indicates the sending bank BIC Code"},{"name":"sourceType","in":"query","type":"string","required":false,"description":"Indicates source type to determine base amount. Possible values are BALANCE (base amount of a property), ACTIVITY ( transaction amount against an activity) or PROPERTY (this type is currently not supp"},{"name":"messageId","in":"query","type":"string","required":false,"description":"The holds the record key of the message ID."},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"PaymentSentFilesTransactionsExceptionsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/order/payments/swift/iso/technicalExceptions","fullPath":"/api/v1.2.0/order/payments/swift/iso/technicalExceptions","operationId":"getSwiftIsoTechnicalExceptionPayments","name":"Retrieves the list of SWIFT ISO technical exception payments which are pending for manual action","summary":"Retrieves SWIFT ISO technical exception payments","tags":["OTHERS"],"parameters":[{"name":"channel","in":"query","type":"string","required":false,"description":"Contains the channel in which the activity was performed. If pricing is not determined based on channel, then this is not significant"},{"name":"company","in":"query","type":"string","required":false,"description":"The company code"},{"name":"ftnumber","in":"query","type":"string","required":false,"description":"Deprecated - Transaction reference"},{"name":"amount","in":"query","type":"string","required":false,"description":"Contains the direct debit claim amount"},{"name":"currency","in":"query","type":"string","required":false,"description":"Contains the currency of the mandate account"},{"name":"date","in":"query","type":"string","required":false,"description":"Indicates the date on which activity was performed"},{"name":"statusCode","in":"query","type":"string","required":false,"description":"Status code, as defined by the institution"},{"name":"errorCode","in":"query","type":"string","required":false,"description":"Indicates the error code which is encountered during payment processing as returned by payment system "},{"name":"uniqueFlag","in":"query","type":"string","required":false,"description":"Flag to indicate unique row"},{"name":"coverControl","in":"query","type":"string","required":false,"description":"Indicates whether the limit is applicable for the virtual accounts or not"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"SwiftIsoTechnicalExceptionPaymentsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/order/payments/cover/exceptions","fullPath":"/api/v1.2.0/order/payments/cover/exceptions","operationId":"getExceptionCoverPayments","name":"Retrieves the list of unmatched cover payments, which have to be manually matched by an operator.","summary":"Retrieves unmatched cover payments","tags":["OTHERS"],"parameters":[{"name":"clearingTransactionType","in":"query","type":"string","required":false,"description":"Indicates the Clearing transaction type."},{"name":"creditCustomerId","in":"query","type":"string","required":false,"description":"Creditor customer id details"},{"name":"customerOrBankTransfer","in":"query","type":"string","required":false,"description":"Indicates if the payment was initiated by Customer or the financial institution"},{"name":"customerSpecifiedReference","in":"query","type":"string","required":false,"description":"Deprecated - Customer specified reference"},{"name":"debitCustomerId","in":"query","type":"string","required":false,"description":"Debtor customer details"},{"name":"paymentDirection","in":"query","type":"string","required":false,"description":"Indicates the direction of payment i.e. incoming, outgoing, book or redirect"},{"name":"endToEndReference","in":"query","type":"string","required":false,"description":"Indicates the end to end reference for the payment. This field can be provided by the person who instructs the payment and this flows through the lifecycle of the payment."},{"name":"entryDateTime","in":"query","type":"string","required":false,"description":"Contains the payment creation time"},{"name":"fileSendersReference","in":"query","type":"string","required":false,"description":"Indicates the sender reference that comes from the inward payment file"},{"name":"paymentId","in":"query","type":"string","required":false,"description":"Indicates the unique reference number of the payment"},{"name":"incomingMessageType","in":"query","type":"string","required":false,"description":"Indicates the supported message type to be received from the clearing house or the direct participant."},{"name":"company","in":"query","type":"string","required":false,"description":"The company code"},{"name":"processingDate","in":"query","type":"string","required":false,"description":"The date when payment instruction is processed in system."},{"name":"partySendersReferenceIncoming","in":"query","type":"string","required":false,"description":"Debtor payment reference details of incoming"},{"name":"partySendersReferenceOutgoing","in":"query","type":"string","required":false,"description":"Debtor payment reference details of outgoing"},{"name":"statusCode","in":"query","type":"string","required":false,"description":"Status code, as defined by the institution"},{"name":"transactionAmount","in":"query","type":"string","required":false,"description":"Contains the transaction amount. This is based on the currency, either local or foreign currency"},{"name":"transactionCurrency","in":"query","type":"string","required":false,"description":"Indicates the currency of the transaction. For example GBP, USD etc."},{"name":"transactionReference","in":"query","type":"string","required":false,"description":"Contains the identifier for the transaction in the core system"},{"name":"valueDate","in":"query","type":"string","required":false,"description":"Contains the value date of the claim or the date on which the amount to be claimed"},{"name":"paymentSource","in":"query","type":"string","required":false,"description":"Indicates the source from where the payment is originated"},{"name":"channel","in":"query","type":"string","required":false,"description":"Contains the channel in which the activity was performed. If pricing is not determined based on channel, then this is not significant"},{"name":"senderBankBic","in":"query","type":"string","required":false,"description":"Indicates the sending bank BIC Code"},{"name":"receiver","in":"query","type":"string","required":false,"description":"Identifies the receiver of the message"},{"name":"debtorAccountId","in":"query","type":"string","required":false,"description":"Contains the identification assigned by an institution to identify a debtor account by the account owner."},{"name":"beneficiaryAccountId","in":"query","type":"string","required":false,"description":"Unique account identifier of the beneficiary account number."},{"name":"scheme","in":"query","type":"string","required":false,"description":"Represents the scheme (a synonym for the National ID type) under which the National ID is defined"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"ExceptionCoverPaymentsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}}]},{"key":"order-payments-operationalQueueListingExternalSystems-v1.0.0","title":"Operational Queue Listing External Systems","version":"v1.0.0","description":"Retrieves the list of payments awaiting response from external systems","endpointCount":12,"endpoints":[{"method":"GET","path":"/order/payments/swift/acknowledgements/pendings/cover","fullPath":"/api/v1.0.0/order/payments/swift/acknowledgements/pendings/cover","operationId":"getSwiftAcknowlegementPaymentPending","name":"Retrieves the list of\u00c2\u00a0payments that are awaiting acknowledgment from SWIFT to release cover message","summary":"Retrieves payments waiting for SWIFT acknowledgement to release cover","tags":["OTHERS"],"parameters":[{"name":"clearingTransactionType","in":"query","type":"string","required":false,"description":"Indicates the Clearing transaction type."},{"name":"creditCustomerId","in":"query","type":"string","required":false,"description":"Creditor customer id details"},{"name":"customerOrBankTransfer","in":"query","type":"string","required":false,"description":"Indicates if the payment was initiated by Customer or the financial institution"},{"name":"customerSpecifiedReference","in":"query","type":"string","required":false,"description":"Deprecated - Customer specified reference"},{"name":"debitCustomerId","in":"query","type":"string","required":false,"description":"Debtor customer details"},{"name":"paymentDirection","in":"query","type":"string","required":false,"description":"Indicates the direction of payment i.e. incoming, outgoing, book or redirect"},{"name":"endToEndReference","in":"query","type":"string","required":false,"description":"Indicates the end to end reference for the payment. This field can be provided by the person who instructs the payment and this flows through the lifecycle of the payment."},{"name":"entryDateTime","in":"query","type":"string","required":false,"description":"Contains the payment creation time"},{"name":"fileSendersReference","in":"query","type":"string","required":false,"description":"Indicates the sender reference that comes from the inward payment file"},{"name":"paymentId","in":"query","type":"string","required":false,"description":"Indicates the unique reference number of the payment"},{"name":"incomingMessageType","in":"query","type":"string","required":false,"description":"Indicates the supported message type to be received from the clearing house or the direct participant."},{"name":"company","in":"query","type":"string","required":false,"description":"The company code"},{"name":"processingDate","in":"query","type":"string","required":false,"description":"The date when payment instruction is processed in system."},{"name":"partySendersReferenceIncoming","in":"query","type":"string","required":false,"description":"Debtor payment reference details of incoming"},{"name":"partySendersReferenceOutgoing","in":"query","type":"string","required":false,"description":"Debtor payment reference details of outgoing"},{"name":"statusCode","in":"query","type":"string","required":false,"description":"Status code, as defined by the institution"},{"name":"transactionAmount","in":"query","type":"string","required":false,"description":"Contains the transaction amount. This is based on the currency, either local or foreign currency"},{"name":"transactionCurrency","in":"query","type":"string","required":false,"description":"Indicates the currency of the transaction. For example GBP, USD etc."},{"name":"transactionReference","in":"query","type":"string","required":false,"description":"Contains the identifier for the transaction in the core system"},{"name":"valueDate","in":"query","type":"string","required":false,"description":"Contains the value date of the claim or the date on which the amount to be claimed"},{"name":"paymentSource","in":"query","type":"string","required":false,"description":"Indicates the source from where the payment is originated"},{"name":"channel","in":"query","type":"string","required":false,"description":"Contains the channel in which the activity was performed. If pricing is not determined based on channel, then this is not significant"},{"name":"senderBankBic","in":"query","type":"string","required":false,"description":"Indicates the sending bank BIC Code"},{"name":"receiver","in":"query","type":"string","required":false,"description":"Identifies the receiver of the message"},{"name":"debtorAccountId","in":"query","type":"string","required":false,"description":"Contains the identification assigned by an institution to identify a debtor account by the account owner."},{"name":"beneficiaryAccountId","in":"query","type":"string","required":false,"description":"Unique account identifier of the beneficiary account number."},{"name":"scheme","in":"query","type":"string","required":false,"description":"Represents the scheme (a synonym for the National ID type) under which the National ID is defined"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"SwiftAcknowlegementPaymentPendingResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/order/payments/externalSystems/postings/cancellations/pendings","fullPath":"/api/v1.0.0/order/payments/externalSystems/postings/cancellations/pendings","operationId":"getExternalSystemPaymentReversalsPending","name":"Retrieves the list of payments for which reversal requests have been sent and awaiting responses from external core banking system","summary":"Retrieves payments pending reversal posting request","tags":["OTHERS"],"parameters":[{"name":"processingCompany","in":"query","type":"string","required":false,"description":"Deprecated - Processing company code"},{"name":"transactionReference","in":"query","type":"string","required":false,"description":"Contains the identifier for the transaction in the core system"},{"name":"duplicateCheck","in":"query","type":"string","required":false,"description":"Indicates if a duplicate check on the incoming request has to be performed"},{"name":"requestStatus","in":"query","type":"string","required":false,"description":"The current status of the request. The possible values includes New, send to printer, cancelled and processed."},{"name":"dateTime","in":"query","type":"string","required":false,"description":"Contains the date and time separated by '-'"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"ExternalSystemPaymentReversalsPendingResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/order/payments/externalSystems/postings/pendings","fullPath":"/api/v1.0.0/order/payments/externalSystems/postings/pendings","operationId":"getExternalSystemPaymentPostingPending","name":"Retrieves the list of payments for which posting requests have been sent and awaiting responses from external core banking system","summary":"Retrieves payments pending posting request","tags":["OTHERS"],"parameters":[{"name":"company","in":"query","type":"string","required":false,"description":"The company code"},{"name":"transactionReference","in":"query","type":"string","required":false,"description":"Contains the identifier for the transaction in the core system"},{"name":"duplicateCheck","in":"query","type":"string","required":false,"description":"Indicates if a duplicate check on the incoming request has to be performed"},{"name":"requestStatus","in":"query","type":"string","required":false,"description":"The current status of the request. The possible values includes New, send to printer, cancelled and processed."},{"name":"dateTime","in":"query","type":"string","required":false,"description":"Contains the date and time separated by '-'"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"ExternalSystemPaymentPostingPendingResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/order/payments/externalSystems/accountValidations/pendings","fullPath":"/api/v1.0.0/order/payments/externalSystems/accountValidations/pendings","operationId":"getExternalSystemPaymentAccountValidationPending","name":"Retrieves the list of payments for which account validation requests have been sent and awaiting responses from external core banking system","summary":"Retrieves payments pending account validation request","tags":["OTHERS"],"parameters":[{"name":"company","in":"query","type":"string","required":false,"description":"The company code"},{"name":"transactionReference","in":"query","type":"string","required":false,"description":"Contains the identifier for the transaction in the core system"},{"name":"duplicateCheck","in":"query","type":"string","required":false,"description":"Indicates if a duplicate check on the incoming request has to be performed"},{"name":"requestStatus","in":"query","type":"string","required":false,"description":"The current status of the request. The possible values includes New, send to printer, cancelled and processed."},{"name":"dateTime","in":"query","type":"string","required":false,"description":"Contains the date and time separated by '-'"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"ExternalSystemPaymentAccountValidationPendingResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/order/payments/externalSystems/reservations/cancellations/pendings","fullPath":"/api/v1.0.0/order/payments/externalSystems/reservations/cancellations/pendings","operationId":"getExternalSystemCancelReservationPaymentsPending","name":"Retrieves the list of payments for which cancel reservation requests have been sent and awaiting responses from external core banking system","summary":"Retrieves payments pending cancellation of reservation request","tags":["OTHERS"],"parameters":[{"name":"company","in":"query","type":"string","required":false,"description":"The company code"},{"name":"transactionReference","in":"query","type":"string","required":false,"description":"Contains the identifier for the transaction in the core system"},{"name":"duplicateCheck","in":"query","type":"string","required":false,"description":"Indicates if a duplicate check on the incoming request has to be performed"},{"name":"requestStatus","in":"query","type":"string","required":false,"description":"The current status of the request. The possible values includes New, send to printer, cancelled and processed."},{"name":"dateTime","in":"query","type":"string","required":false,"description":"Contains the date and time separated by '-'"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"ExternalSystemCancelReservationPaymentsPendingResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/order/payments/fundsReservations/pendings","fullPath":"/api/v1.0.0/order/payments/fundsReservations/pendings","operationId":"getExternalSystemFundsReservationPaymentsPending","name":"Retrieves the list of payments for which funds reservation requests have been sent and awaiting responses from external core banking system","summary":"Retrieves payments pending funds reservation request","tags":["OTHERS"],"parameters":[{"name":"company","in":"query","type":"string","required":false,"description":"The company code"},{"name":"transactionReference","in":"query","type":"string","required":false,"description":"Contains the identifier for the transaction in the core system"},{"name":"duplicateCheck","in":"query","type":"string","required":false,"description":"Indicates if a duplicate check on the incoming request has to be performed"},{"name":"requestStatus","in":"query","type":"string","required":false,"description":"The current status of the request. The possible values includes New, send to printer, cancelled and processed."},{"name":"dateTime","in":"query","type":"string","required":false,"description":"Contains the date and time separated by '-'"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"ExternalSystemFundsReservationPaymentsPendingResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/order/payments/highValues/externalSystems/exchangeRates/pendings","fullPath":"/api/v1.0.0/order/payments/highValues/externalSystems/exchangeRates/pendings","operationId":"getPaymentsPendingTreasuryRateFromExternalSystem","name":"Retrieves the list of payments for which rate requests have been sent and awaiting responses from external core banking system","summary":"Retrieves high value payments awaiting special rate from external treasury system","tags":["OTHERS"],"parameters":[{"name":"clearingTransactionType","in":"query","type":"string","required":false,"description":"Indicates the Clearing transaction type."},{"name":"creditCustomerId","in":"query","type":"string","required":false,"description":"Creditor customer id details"},{"name":"customerOrBankTransfer","in":"query","type":"string","required":false,"description":"Indicates if the payment was initiated by Customer or the financial institution"},{"name":"customerSpecifiedReference","in":"query","type":"string","required":false,"description":"Deprecated - Customer specified reference"},{"name":"debitCustomerId","in":"query","type":"string","required":false,"description":"Debtor customer details"},{"name":"paymentDirection","in":"query","type":"string","required":false,"description":"Indicates the direction of payment i.e. incoming, outgoing, book or redirect"},{"name":"endToEndReference","in":"query","type":"string","required":false,"description":"Indicates the end to end reference for the payment. This field can be provided by the person who instructs the payment and this flows through the lifecycle of the payment."},{"name":"entryDateTime","in":"query","type":"string","required":false,"description":"Contains the payment creation time"},{"name":"fileSendersReference","in":"query","type":"string","required":false,"description":"Indicates the sender reference that comes from the inward payment file"},{"name":"paymentId","in":"query","type":"string","required":false,"description":"Indicates the unique reference number of the payment"},{"name":"incomingMessageType","in":"query","type":"string","required":false,"description":"Indicates the supported message type to be received from the clearing house or the direct participant."},{"name":"company","in":"query","type":"string","required":false,"description":"The company code"},{"name":"processingDate","in":"query","type":"string","required":false,"description":"The date when payment instruction is processed in system."},{"name":"partySendersReferenceIncoming","in":"query","type":"string","required":false,"description":"Debtor payment reference details of incoming"},{"name":"partySendersReferenceOutgoing","in":"query","type":"string","required":false,"description":"Debtor payment reference details of outgoing"},{"name":"statusCode","in":"query","type":"string","required":false,"description":"Status code, as defined by the institution"},{"name":"transactionAmount","in":"query","type":"string","required":false,"description":"Contains the transaction amount. This is based on the currency, either local or foreign currency"},{"name":"transactionCurrency","in":"query","type":"string","required":false,"description":"Indicates the currency of the transaction. For example GBP, USD etc."},{"name":"transactionReference","in":"query","type":"string","required":false,"description":"Contains the identifier for the transaction in the core system"},{"name":"valueDate","in":"query","type":"string","required":false,"description":"Contains the value date of the claim or the date on which the amount to be claimed"},{"name":"paymentSource","in":"query","type":"string","required":false,"description":"Indicates the source from where the payment is originated"},{"name":"channel","in":"query","type":"string","required":false,"description":"Contains the channel in which the activity was performed. If pricing is not determined based on channel, then this is not significant"},{"name":"senderBankBic","in":"query","type":"string","required":false,"description":"Indicates the sending bank BIC Code"},{"name":"receiver","in":"query","type":"string","required":false,"description":"Identifies the receiver of the message"},{"name":"debtorAccountId","in":"query","type":"string","required":false,"description":"Contains the identification assigned by an institution to identify a debtor account by the account owner."},{"name":"beneficiaryAccountId","in":"query","type":"string","required":false,"description":"Unique account identifier of the beneficiary account number."},{"name":"scheme","in":"query","type":"string","required":false,"description":"Represents the scheme (a synonym for the National ID type) under which the National ID is defined"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"PaymentsPendingTreasuryRateFromExternalSystemResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/order/payments/externalSystems/screenings/pendings","fullPath":"/api/v1.0.0/order/payments/externalSystems/screenings/pendings","operationId":"getScreeningRequestsPaymentsPending","name":"Retrieves the list of payments for which screening requests have been sent and awaiting response","summary":"Retrieves payments waiting for screening","tags":["OTHERS"],"parameters":[{"name":"transactionReference","in":"query","type":"string","required":false,"description":"Contains the identifier for the transaction in the core system"},{"name":"dateSent","in":"query","type":"string","required":false,"description":"The date when the message is sent."},{"name":"activityDateTimeStamp","in":"query","type":"string","required":false,"description":"Contains the date and time of activity triggered."},{"name":"receivedDateTime","in":"query","type":"string","required":false,"description":"Indicates the date and time when the request to pay message is received for payer and requestor"},{"name":"paymentStatus","in":"query","type":"string","required":false,"description":"Describes the current status of the payment order in the payment system"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"ScreeningRequestsPaymentsPendingResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/order/payments/exchangeRates/pendings","fullPath":"/api/v1.0.0/order/payments/exchangeRates/pendings","operationId":"getPaymentsAwaitingRateFixing","name":"Retrieves the list of payments waiting for today's FX rate","summary":"Retrieves payments awaiting today's exchange rate","tags":["OTHERS"],"parameters":[{"name":"clearingTransactionType","in":"query","type":"string","required":false,"description":"Indicates the Clearing transaction type."},{"name":"creditCustomerId","in":"query","type":"string","required":false,"description":"Creditor customer id details"},{"name":"customerOrBankTransfer","in":"query","type":"string","required":false,"description":"Indicates if the payment was initiated by Customer or the financial institution"},{"name":"customerSpecifiedReference","in":"query","type":"string","required":false,"description":"Deprecated - Customer specified reference"},{"name":"debitCustomerId","in":"query","type":"string","required":false,"description":"Debtor customer details"},{"name":"paymentDirection","in":"query","type":"string","required":false,"description":"Indicates the direction of payment i.e. incoming, outgoing, book or redirect"},{"name":"endToEndReference","in":"query","type":"string","required":false,"description":"Indicates the end to end reference for the payment. This field can be provided by the person who instructs the payment and this flows through the lifecycle of the payment."},{"name":"entryDateTime","in":"query","type":"string","required":false,"description":"Contains the payment creation time"},{"name":"fileSendersReference","in":"query","type":"string","required":false,"description":"Indicates the sender reference that comes from the inward payment file"},{"name":"paymentId","in":"query","type":"string","required":false,"description":"Indicates the unique reference number of the payment"},{"name":"incomingMessageType","in":"query","type":"string","required":false,"description":"Indicates the supported message type to be received from the clearing house or the direct participant."},{"name":"company","in":"query","type":"string","required":false,"description":"The company code"},{"name":"processingDate","in":"query","type":"string","required":false,"description":"The date when payment instruction is processed in system."},{"name":"partySendersReferenceIncoming","in":"query","type":"string","required":false,"description":"Debtor payment reference details of incoming"},{"name":"partySendersReferenceOutgoing","in":"query","type":"string","required":false,"description":"Debtor payment reference details of outgoing"},{"name":"statusCode","in":"query","type":"string","required":false,"description":"Status code, as defined by the institution"},{"name":"transactionAmount","in":"query","type":"string","required":false,"description":"Contains the transaction amount. This is based on the currency, either local or foreign currency"},{"name":"transactionCurrency","in":"query","type":"string","required":false,"description":"Indicates the currency of the transaction. For example GBP, USD etc."},{"name":"transactionReference","in":"query","type":"string","required":false,"description":"Contains the identifier for the transaction in the core system"},{"name":"valueDate","in":"query","type":"string","required":false,"description":"Contains the value date of the claim or the date on which the amount to be claimed"},{"name":"paymentSource","in":"query","type":"string","required":false,"description":"Indicates the source from where the payment is originated"},{"name":"channel","in":"query","type":"string","required":false,"description":"Contains the channel in which the activity was performed. If pricing is not determined based on channel, then this is not significant"},{"name":"senderBankBic","in":"query","type":"string","required":false,"description":"Indicates the sending bank BIC Code"},{"name":"receiver","in":"query","type":"string","required":false,"description":"Identifies the receiver of the message"},{"name":"debtorAccountId","in":"query","type":"string","required":false,"description":"Contains the identification assigned by an institution to identify a debtor account by the account owner."},{"name":"beneficiaryAccountId","in":"query","type":"string","required":false,"description":"Unique account identifier of the beneficiary account number."},{"name":"scheme","in":"query","type":"string","required":false,"description":"Represents the scheme (a synonym for the National ID type) under which the National ID is defined"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"PaymentsAwaitingRateFixingResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/order/payments/externalSystems/autoRepairs/pendings","fullPath":"/api/v1.0.0/order/payments/externalSystems/autoRepairs/pendings","operationId":"getPendingAutoRepairPaymentsPending","name":"Retrieves the list of payments that are waiting for response from auto repair system","summary":"Retrieves payments pending auto repair request","tags":["OTHERS"],"parameters":[{"name":"clearingTransactionType","in":"query","type":"string","required":false,"description":"Indicates the Clearing transaction type."},{"name":"creditCustomerId","in":"query","type":"string","required":false,"description":"Creditor customer id details"},{"name":"customerOrBankTransfer","in":"query","type":"string","required":false,"description":"Indicates if the payment was initiated by Customer or the financial institution"},{"name":"customerSpecifiedReference","in":"query","type":"string","required":false,"description":"Deprecated - Customer specified reference"},{"name":"debitCustomerId","in":"query","type":"string","required":false,"description":"Debtor customer details"},{"name":"paymentDirection","in":"query","type":"string","required":false,"description":"Indicates the direction of payment i.e. incoming, outgoing, book or redirect"},{"name":"endToEndReference","in":"query","type":"string","required":false,"description":"Indicates the end to end reference for the payment. This field can be provided by the person who instructs the payment and this flows through the lifecycle of the payment."},{"name":"entryDateTime","in":"query","type":"string","required":false,"description":"Contains the payment creation time"},{"name":"fileSendersReference","in":"query","type":"string","required":false,"description":"Indicates the sender reference that comes from the inward payment file"},{"name":"paymentId","in":"query","type":"string","required":false,"description":"Indicates the unique reference number of the payment"},{"name":"incomingMessageType","in":"query","type":"string","required":false,"description":"Indicates the supported message type to be received from the clearing house or the direct participant."},{"name":"company","in":"query","type":"string","required":false,"description":"The company code"},{"name":"processingDate","in":"query","type":"string","required":false,"description":"The date when payment instruction is processed in system."},{"name":"partySendersReferenceIncoming","in":"query","type":"string","required":false,"description":"Debtor payment reference details of incoming"},{"name":"partySendersReferenceOutgoing","in":"query","type":"string","required":false,"description":"Debtor payment reference details of outgoing"},{"name":"statusCode","in":"query","type":"string","required":false,"description":"Status code, as defined by the institution"},{"name":"transactionAmount","in":"query","type":"string","required":false,"description":"Contains the transaction amount. This is based on the currency, either local or foreign currency"},{"name":"transactionCurrency","in":"query","type":"string","required":false,"description":"Indicates the currency of the transaction. For example GBP, USD etc."},{"name":"transactionReference","in":"query","type":"string","required":false,"description":"Contains the identifier for the transaction in the core system"},{"name":"valueDate","in":"query","type":"string","required":false,"description":"Contains the value date of the claim or the date on which the amount to be claimed"},{"name":"paymentSource","in":"query","type":"string","required":false,"description":"Indicates the source from where the payment is originated"},{"name":"channel","in":"query","type":"string","required":false,"description":"Contains the channel in which the activity was performed. If pricing is not determined based on channel, then this is not significant"},{"name":"senderBankBic","in":"query","type":"string","required":false,"description":"Indicates the sending bank BIC Code"},{"name":"receiver","in":"query","type":"string","required":false,"description":"Identifies the receiver of the message"},{"name":"debtorAccountId","in":"query","type":"string","required":false,"description":"Contains the identification assigned by an institution to identify a debtor account by the account owner."},{"name":"beneficiaryAccountId","in":"query","type":"string","required":false,"description":"Unique account identifier of the beneficiary account number."},{"name":"scheme","in":"query","type":"string","required":false,"description":"Represents the scheme (a synonym for the National ID type) under which the National ID is defined"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"PendingAutoRepairPaymentsPendingResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/order/payments/externalSystems/balanceCheck/pendings","fullPath":"/api/v1.0.0/order/payments/externalSystems/balanceCheck/pendings","operationId":"getExternalSystemBalanceCheckPaymentsPending","name":"Retrieves the list of payments for which balance  requests have been sent and awaiting responses from external core banking system","summary":"Retrieves payments pending balance check and reservation request","tags":["OTHERS"],"parameters":[{"name":"clearingTransactionType","in":"query","type":"string","required":false,"description":"Indicates the Clearing transaction type."},{"name":"creditCustomerId","in":"query","type":"string","required":false,"description":"Creditor customer id details"},{"name":"customerOrBankTransfer","in":"query","type":"string","required":false,"description":"Indicates if the payment was initiated by Customer or the financial institution"},{"name":"customerSpecifiedReference","in":"query","type":"string","required":false,"description":"Deprecated - Customer specified reference"},{"name":"debitCustomerId","in":"query","type":"string","required":false,"description":"Debtor customer details"},{"name":"paymentDirection","in":"query","type":"string","required":false,"description":"Indicates the direction of payment i.e. incoming, outgoing, book or redirect"},{"name":"endToEndReference","in":"query","type":"string","required":false,"description":"Indicates the end to end reference for the payment. This field can be provided by the person who instructs the payment and this flows through the lifecycle of the payment."},{"name":"entryDateTime","in":"query","type":"string","required":false,"description":"Contains the payment creation time"},{"name":"fileSendersReference","in":"query","type":"string","required":false,"description":"Indicates the sender reference that comes from the inward payment file"},{"name":"paymentId","in":"query","type":"string","required":false,"description":"Indicates the unique reference number of the payment"},{"name":"incomingMessageType","in":"query","type":"string","required":false,"description":"Indicates the supported message type to be received from the clearing house or the direct participant."},{"name":"company","in":"query","type":"string","required":false,"description":"The company code"},{"name":"processingDate","in":"query","type":"string","required":false,"description":"The date when payment instruction is processed in system."},{"name":"partySendersReferenceIncoming","in":"query","type":"string","required":false,"description":"Debtor payment reference details of incoming"},{"name":"partySendersReferenceOutgoing","in":"query","type":"string","required":false,"description":"Debtor payment reference details of outgoing"},{"name":"statusCode","in":"query","type":"string","required":false,"description":"Status code, as defined by the institution"},{"name":"transactionAmount","in":"query","type":"string","required":false,"description":"Contains the transaction amount. This is based on the currency, either local or foreign currency"},{"name":"transactionCurrency","in":"query","type":"string","required":false,"description":"Indicates the currency of the transaction. For example GBP, USD etc."},{"name":"transactionReference","in":"query","type":"string","required":false,"description":"Contains the identifier for the transaction in the core system"},{"name":"valueDate","in":"query","type":"string","required":false,"description":"Contains the value date of the claim or the date on which the amount to be claimed"},{"name":"paymentSource","in":"query","type":"string","required":false,"description":"Indicates the source from where the payment is originated"},{"name":"channel","in":"query","type":"string","required":false,"description":"Contains the channel in which the activity was performed. If pricing is not determined based on channel, then this is not significant"},{"name":"senderBankBic","in":"query","type":"string","required":false,"description":"Indicates the sending bank BIC Code"},{"name":"receiver","in":"query","type":"string","required":false,"description":"Identifies the receiver of the message"},{"name":"debtorAccountId","in":"query","type":"string","required":false,"description":"Contains the identification assigned by an institution to identify a debtor account by the account owner."},{"name":"beneficiaryAccountId","in":"query","type":"string","required":false,"description":"Unique account identifier of the beneficiary account number."},{"name":"scheme","in":"query","type":"string","required":false,"description":"Represents the scheme (a synonym for the National ID type) under which the National ID is defined"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"ExternalSystemBalanceCheckPaymentsPendingResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/order/payments/clearings/files/pendings","fullPath":"/api/v1.0.0/order/payments/clearings/files/pendings","operationId":"getClearingPaymentsPendingDistribution","name":"Retrieves the list of procesed payment for which file has to be generated and sent to clearing","summary":"Retrieves processed payments that are yet to be sent to clearing","tags":["OTHERS"],"parameters":[{"name":"clearingTransactionType","in":"query","type":"string","required":false,"description":"Indicates the Clearing transaction type."},{"name":"creditCustomerId","in":"query","type":"string","required":false,"description":"Creditor customer id details"},{"name":"customerOrBankTransfer","in":"query","type":"string","required":false,"description":"Indicates if the payment was initiated by Customer or the financial institution"},{"name":"customerSpecifiedReference","in":"query","type":"string","required":false,"description":"Deprecated - Customer specified reference"},{"name":"debitCustomerId","in":"query","type":"string","required":false,"description":"Debtor customer details"},{"name":"paymentDirection","in":"query","type":"string","required":false,"description":"Indicates the direction of payment i.e. incoming, outgoing, book or redirect"},{"name":"endToEndReference","in":"query","type":"string","required":false,"description":"Indicates the end to end reference for the payment. This field can be provided by the person who instructs the payment and this flows through the lifecycle of the payment."},{"name":"entryDateTime","in":"query","type":"string","required":false,"description":"Contains the payment creation time"},{"name":"fileSendersReference","in":"query","type":"string","required":false,"description":"Indicates the sender reference that comes from the inward payment file"},{"name":"paymentId","in":"query","type":"string","required":false,"description":"Indicates the unique reference number of the payment"},{"name":"incomingMessageType","in":"query","type":"string","required":false,"description":"Indicates the supported message type to be received from the clearing house or the direct participant."},{"name":"company","in":"query","type":"string","required":false,"description":"The company code"},{"name":"processingDate","in":"query","type":"string","required":false,"description":"The date when payment instruction is processed in system."},{"name":"partySendersReferenceIncoming","in":"query","type":"string","required":false,"description":"Debtor payment reference details of incoming"},{"name":"partySendersReferenceOutgoing","in":"query","type":"string","required":false,"description":"Debtor payment reference details of outgoing"},{"name":"statusCode","in":"query","type":"string","required":false,"description":"Status code, as defined by the institution"},{"name":"transactionAmount","in":"query","type":"string","required":false,"description":"Contains the transaction amount. This is based on the currency, either local or foreign currency"},{"name":"transactionCurrency","in":"query","type":"string","required":false,"description":"Indicates the currency of the transaction. For example GBP, USD etc."},{"name":"transactionReference","in":"query","type":"string","required":false,"description":"Contains the identifier for the transaction in the core system"},{"name":"valueDate","in":"query","type":"string","required":false,"description":"Contains the value date of the claim or the date on which the amount to be claimed"},{"name":"paymentSource","in":"query","type":"string","required":false,"description":"Indicates the source from where the payment is originated"},{"name":"channel","in":"query","type":"string","required":false,"description":"Contains the channel in which the activity was performed. If pricing is not determined based on channel, then this is not significant"},{"name":"senderBankBic","in":"query","type":"string","required":false,"description":"Indicates the sending bank BIC Code"},{"name":"receiver","in":"query","type":"string","required":false,"description":"Identifies the receiver of the message"},{"name":"debtorAccountId","in":"query","type":"string","required":false,"description":"Contains the identification assigned by an institution to identify a debtor account by the account owner."},{"name":"beneficiaryAccountId","in":"query","type":"string","required":false,"description":"Unique account identifier of the beneficiary account number."},{"name":"scheme","in":"query","type":"string","required":false,"description":"Represents the scheme (a synonym for the National ID type) under which the National ID is defined"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"ClearingPaymentsPendingDistributionResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}}]},{"key":"order-payments-operationalQueueListingExternalSystems-v1.1.0","title":"Operational Queue Listing External Systems","version":"v1.1.0","description":"Retrieve the list of payments awaiting response from external systems","endpointCount":12,"endpoints":[{"method":"GET","path":"/order/payments/swift/acknowledgements/pendings/cover","fullPath":"/api/v1.1.0/order/payments/swift/acknowledgements/pendings/cover","operationId":"getSwiftAcknowlegementPaymentPending","name":"Retrieves the list of\u00c2\u00a0payments that are awaiting acknowledgment from SWIFT to release cover message","summary":"Retrieves payments waiting for SWIFT acknowledgement to release cover","tags":["OTHERS"],"parameters":[{"name":"clearingTransactionType","in":"query","type":"string","required":false,"description":"Indicates the Clearing transaction type."},{"name":"creditCustomerId","in":"query","type":"string","required":false,"description":"Creditor customer id details"},{"name":"customerOrBankTransfer","in":"query","type":"string","required":false,"description":"Indicates if the payment was initiated by Customer or the financial institution"},{"name":"customerSpecifiedReference","in":"query","type":"string","required":false,"description":"Deprecated - Customer specified reference"},{"name":"debitCustomerId","in":"query","type":"string","required":false,"description":"Debtor customer details"},{"name":"paymentDirection","in":"query","type":"string","required":false,"description":"Indicates the direction of payment i.e. incoming, outgoing, book or redirect"},{"name":"endToEndReference","in":"query","type":"string","required":false,"description":"Indicates the end to end reference for the payment. This field can be provided by the person who instructs the payment and this flows through the lifecycle of the payment."},{"name":"entryDateTime","in":"query","type":"string","required":false,"description":"Contains the payment creation time"},{"name":"fileSendersReference","in":"query","type":"string","required":false,"description":"Indicates the sender reference that comes from the inward payment file"},{"name":"paymentId","in":"query","type":"string","required":false,"description":"Indicates the unique reference number of the payment"},{"name":"incomingMessageType","in":"query","type":"string","required":false,"description":"Indicates the supported message type to be received from the clearing house or the direct participant."},{"name":"company","in":"query","type":"string","required":false,"description":"The company code"},{"name":"processingDate","in":"query","type":"string","required":false,"description":"The date when payment instruction is processed in system."},{"name":"partySendersReferenceIncoming","in":"query","type":"string","required":false,"description":"Debtor payment reference details of incoming"},{"name":"partySendersReferenceOutgoing","in":"query","type":"string","required":false,"description":"Debtor payment reference details of outgoing"},{"name":"statusCode","in":"query","type":"string","required":false,"description":"Status code, as defined by the institution"},{"name":"transactionAmount","in":"query","type":"string","required":false,"description":"Contains the transaction amount. This is based on the currency, either local or foreign currency"},{"name":"transactionCurrency","in":"query","type":"string","required":false,"description":"Indicates the currency of the transaction. For example GBP, USD etc."},{"name":"transactionReference","in":"query","type":"string","required":false,"description":"Contains the identifier for the transaction in the core system"},{"name":"valueDate","in":"query","type":"string","required":false,"description":"Contains the value date of the claim or the date on which the amount to be claimed"},{"name":"paymentSource","in":"query","type":"string","required":false,"description":"Indicates the source from where the payment is originated"},{"name":"channel","in":"query","type":"string","required":false,"description":"Contains the channel in which the activity was performed. If pricing is not determined based on channel, then this is not significant"},{"name":"senderBankBic","in":"query","type":"string","required":false,"description":"Indicates the sending bank BIC Code"},{"name":"receiver","in":"query","type":"string","required":false,"description":"Identifies the receiver of the message"},{"name":"debtorAccountId","in":"query","type":"string","required":false,"description":"Contains the identification assigned by an institution to identify a debtor account by the account owner."},{"name":"beneficiaryAccountId","in":"query","type":"string","required":false,"description":"Unique account identifier of the beneficiary account number."},{"name":"scheme","in":"query","type":"string","required":false,"description":"Represents the scheme (a synonym for the National ID type) under which the National ID is defined"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"SwiftAcknowlegementPaymentPendingResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/order/payments/externalSystems/postings/cancellations/pendings","fullPath":"/api/v1.1.0/order/payments/externalSystems/postings/cancellations/pendings","operationId":"getExternalSystemPaymentReversalsPending","name":"Retrieves the list of payments for which reversal requests have been sent and awaiting responses from external core banking system","summary":"Retrieves payments pending reversal posting request","tags":["OTHERS"],"parameters":[{"name":"processingCompany","in":"query","type":"string","required":false,"description":"Deprecated - Processing company code"},{"name":"transactionReference","in":"query","type":"string","required":false,"description":"Contains the identifier for the transaction in the core system"},{"name":"duplicateCheck","in":"query","type":"string","required":false,"description":"Indicates if a duplicate check on the incoming request has to be performed"},{"name":"requestStatus","in":"query","type":"string","required":false,"description":"Indicates the status when the book entries are reversed or when exceptions as part of booking request is addressed."},{"name":"dateTime","in":"query","type":"string","required":false,"description":"Contains the date and time separated by '-'"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"ExternalSystemPaymentReversalsPendingResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/order/payments/externalSystems/postings/pendings","fullPath":"/api/v1.1.0/order/payments/externalSystems/postings/pendings","operationId":"getExternalSystemPaymentPostingPending","name":"Retrieves the list of payments for which posting requests have been sent and awaiting responses from external core banking system","summary":"Retrieves payments pending posting request","tags":["OTHERS"],"parameters":[{"name":"company","in":"query","type":"string","required":false,"description":"The company code"},{"name":"transactionReference","in":"query","type":"string","required":false,"description":"Contains the identifier for the transaction in the core system"},{"name":"duplicateCheck","in":"query","type":"string","required":false,"description":"Indicates if a duplicate check on the incoming request has to be performed"},{"name":"requestStatus","in":"query","type":"string","required":false,"description":"Indicates the status when the book entries are reversed or when exceptions as part of booking request is addressed."},{"name":"dateTime","in":"query","type":"string","required":false,"description":"Contains the date and time separated by '-'"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"ExternalSystemPaymentPostingPendingResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/order/payments/externalSystems/accountValidations/pendings","fullPath":"/api/v1.1.0/order/payments/externalSystems/accountValidations/pendings","operationId":"getExternalSystemPaymentAccountValidationPending","name":"Retrieves the list of payments for which account validation requests have been sent and awaiting responses from external core banking system","summary":"Retrieves payments pending account validation request","tags":["OTHERS"],"parameters":[{"name":"company","in":"query","type":"string","required":false,"description":"The company code"},{"name":"transactionReference","in":"query","type":"string","required":false,"description":"Contains the identifier for the transaction in the core system"},{"name":"duplicateCheck","in":"query","type":"string","required":false,"description":"Indicates if a duplicate check on the incoming request has to be performed"},{"name":"requestStatus","in":"query","type":"string","required":false,"description":"Indicates the status when the book entries are reversed or when exceptions as part of booking request is addressed."},{"name":"dateTime","in":"query","type":"string","required":false,"description":"Contains the date and time separated by '-'"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"ExternalSystemPaymentAccountValidationPendingResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/order/payments/externalSystems/reservations/cancellations/pendings","fullPath":"/api/v1.1.0/order/payments/externalSystems/reservations/cancellations/pendings","operationId":"getExternalSystemCancelReservationPaymentsPending","name":"Retrieves the list of payments for which cancel reservation requests have been sent and awaiting responses from external core banking system","summary":"Retrieves payments pending cancellation of reservation request","tags":["OTHERS"],"parameters":[{"name":"company","in":"query","type":"string","required":false,"description":"The company code"},{"name":"transactionReference","in":"query","type":"string","required":false,"description":"Contains the identifier for the transaction in the core system"},{"name":"duplicateCheck","in":"query","type":"string","required":false,"description":"Indicates if a duplicate check on the incoming request has to be performed"},{"name":"requestStatus","in":"query","type":"string","required":false,"description":"Indicates the status when the book entries are reversed or when exceptions as part of booking request is addressed."},{"name":"dateTime","in":"query","type":"string","required":false,"description":"Contains the date and time separated by '-'"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"ExternalSystemCancelReservationPaymentsPendingResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/order/payments/fundsReservations/pendings","fullPath":"/api/v1.1.0/order/payments/fundsReservations/pendings","operationId":"getExternalSystemFundsReservationPaymentsPending","name":"Retrieves the list of payments for which funds reservation requests have been sent and awaiting responses from external core banking system","summary":"Retrieves payments pending funds reservation request","tags":["OTHERS"],"parameters":[{"name":"company","in":"query","type":"string","required":false,"description":"The company code"},{"name":"transactionReference","in":"query","type":"string","required":false,"description":"Contains the identifier for the transaction in the core system"},{"name":"duplicateCheck","in":"query","type":"string","required":false,"description":"Indicates if a duplicate check on the incoming request has to be performed"},{"name":"requestStatus","in":"query","type":"string","required":false,"description":"Indicates the status when the book entries are reversed or when exceptions as part of booking request is addressed."},{"name":"dateTime","in":"query","type":"string","required":false,"description":"Contains the date and time separated by '-'"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"ExternalSystemFundsReservationPaymentsPendingResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/order/payments/highValues/externalSystems/exchangeRates/pendings","fullPath":"/api/v1.1.0/order/payments/highValues/externalSystems/exchangeRates/pendings","operationId":"getPaymentsPendingTreasuryRateFromExternalSystem","name":"Retrieves the list of payments for which rate requests have been sent and awaiting responses from external core banking system","summary":"Retrieves high value payments awaiting special rate from external treasury system","tags":["OTHERS"],"parameters":[{"name":"clearingTransactionType","in":"query","type":"string","required":false,"description":"Indicates the Clearing transaction type."},{"name":"creditCustomerId","in":"query","type":"string","required":false,"description":"Creditor customer id details"},{"name":"customerOrBankTransfer","in":"query","type":"string","required":false,"description":"Indicates if the payment was initiated by Customer or the financial institution"},{"name":"customerSpecifiedReference","in":"query","type":"string","required":false,"description":"Deprecated - Customer specified reference"},{"name":"debitCustomerId","in":"query","type":"string","required":false,"description":"Debtor customer details"},{"name":"paymentDirection","in":"query","type":"string","required":false,"description":"Indicates the direction of payment i.e. incoming, outgoing, book or redirect"},{"name":"endToEndReference","in":"query","type":"string","required":false,"description":"Indicates the end to end reference for the payment. This field can be provided by the person who instructs the payment and this flows through the lifecycle of the payment."},{"name":"entryDateTime","in":"query","type":"string","required":false,"description":"Contains the payment creation time"},{"name":"fileSendersReference","in":"query","type":"string","required":false,"description":"Indicates the sender reference that comes from the inward payment file"},{"name":"paymentId","in":"query","type":"string","required":false,"description":"Indicates the unique reference number of the payment"},{"name":"incomingMessageType","in":"query","type":"string","required":false,"description":"Indicates the supported message type to be received from the clearing house or the direct participant."},{"name":"company","in":"query","type":"string","required":false,"description":"The company code"},{"name":"processingDate","in":"query","type":"string","required":false,"description":"The date when payment instruction is processed in system."},{"name":"partySendersReferenceIncoming","in":"query","type":"string","required":false,"description":"Debtor payment reference details of incoming"},{"name":"partySendersReferenceOutgoing","in":"query","type":"string","required":false,"description":"Debtor payment reference details of outgoing"},{"name":"statusCode","in":"query","type":"string","required":false,"description":"Status code, as defined by the institution"},{"name":"transactionAmount","in":"query","type":"string","required":false,"description":"Contains the transaction amount. This is based on the currency, either local or foreign currency"},{"name":"transactionCurrency","in":"query","type":"string","required":false,"description":"Indicates the currency of the transaction. For example GBP, USD etc."},{"name":"transactionReference","in":"query","type":"string","required":false,"description":"Contains the identifier for the transaction in the core system"},{"name":"valueDate","in":"query","type":"string","required":false,"description":"Contains the value date of the claim or the date on which the amount to be claimed"},{"name":"paymentSource","in":"query","type":"string","required":false,"description":"Indicates the source from where the payment is originated"},{"name":"channel","in":"query","type":"string","required":false,"description":"Contains the channel in which the activity was performed. If pricing is not determined based on channel, then this is not significant"},{"name":"senderBankBic","in":"query","type":"string","required":false,"description":"Indicates the sending bank BIC Code"},{"name":"receiver","in":"query","type":"string","required":false,"description":"Identifies the receiver of the message"},{"name":"debtorAccountId","in":"query","type":"string","required":false,"description":"Contains the identification assigned by an institution to identify a debtor account by the account owner."},{"name":"beneficiaryAccountId","in":"query","type":"string","required":false,"description":"Unique account identifier of the beneficiary account number."},{"name":"scheme","in":"query","type":"string","required":false,"description":"Represents the scheme (a synonym for the National ID type) under which the National ID is defined"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"PaymentsPendingTreasuryRateFromExternalSystemResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/order/payments/externalSystems/screenings/pendings","fullPath":"/api/v1.1.0/order/payments/externalSystems/screenings/pendings","operationId":"getScreeningRequestsPaymentsPending","name":"Retrieves the list of payments for which screening requests have been sent and awaiting response","summary":"Retrieves payments waiting for screening","tags":["OTHERS"],"parameters":[{"name":"transactionReference","in":"query","type":"string","required":false,"description":"Contains the identifier for the transaction in the core system"},{"name":"dateSent","in":"query","type":"string","required":false,"description":"The date when the message is sent."},{"name":"activityDateTimeStamp","in":"query","type":"string","required":false,"description":"Contains the date and time of activity triggered."},{"name":"receivedDateTime","in":"query","type":"string","required":false,"description":"Indicates the date and time when the request to pay message is received for payer and requestor"},{"name":"paymentStatus","in":"query","type":"string","required":false,"description":"Describes the current status of the payment order in the payment system"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"ScreeningRequestsPaymentsPendingResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/order/payments/exchangeRates/pendings","fullPath":"/api/v1.1.0/order/payments/exchangeRates/pendings","operationId":"getPaymentsAwaitingRateFixing","name":"Retrieves the list of payments waiting for today's FX rate","summary":"Retrieves payments awaiting today's exchange rate","tags":["OTHERS"],"parameters":[{"name":"clearingTransactionType","in":"query","type":"string","required":false,"description":"Indicates the Clearing transaction type."},{"name":"creditCustomerId","in":"query","type":"string","required":false,"description":"Creditor customer id details"},{"name":"customerOrBankTransfer","in":"query","type":"string","required":false,"description":"Indicates if the payment was initiated by Customer or the financial institution"},{"name":"customerSpecifiedReference","in":"query","type":"string","required":false,"description":"Deprecated - Customer specified reference"},{"name":"debitCustomerId","in":"query","type":"string","required":false,"description":"Debtor customer details"},{"name":"paymentDirection","in":"query","type":"string","required":false,"description":"Indicates the direction of payment i.e. incoming, outgoing, book or redirect"},{"name":"endToEndReference","in":"query","type":"string","required":false,"description":"Indicates the end to end reference for the payment. This field can be provided by the person who instructs the payment and this flows through the lifecycle of the payment."},{"name":"entryDateTime","in":"query","type":"string","required":false,"description":"Contains the payment creation time"},{"name":"fileSendersReference","in":"query","type":"string","required":false,"description":"Indicates the sender reference that comes from the inward payment file"},{"name":"paymentId","in":"query","type":"string","required":false,"description":"Indicates the unique reference number of the payment"},{"name":"incomingMessageType","in":"query","type":"string","required":false,"description":"Indicates the supported message type to be received from the clearing house or the direct participant."},{"name":"company","in":"query","type":"string","required":false,"description":"The company code"},{"name":"processingDate","in":"query","type":"string","required":false,"description":"The date when payment instruction is processed in system."},{"name":"partySendersReferenceIncoming","in":"query","type":"string","required":false,"description":"Debtor payment reference details of incoming"},{"name":"partySendersReferenceOutgoing","in":"query","type":"string","required":false,"description":"Debtor payment reference details of outgoing"},{"name":"statusCode","in":"query","type":"string","required":false,"description":"Status code, as defined by the institution"},{"name":"transactionAmount","in":"query","type":"string","required":false,"description":"Contains the transaction amount. This is based on the currency, either local or foreign currency"},{"name":"transactionCurrency","in":"query","type":"string","required":false,"description":"Indicates the currency of the transaction. For example GBP, USD etc."},{"name":"transactionReference","in":"query","type":"string","required":false,"description":"Contains the identifier for the transaction in the core system"},{"name":"valueDate","in":"query","type":"string","required":false,"description":"Contains the value date of the claim or the date on which the amount to be claimed"},{"name":"paymentSource","in":"query","type":"string","required":false,"description":"Indicates the source from where the payment is originated"},{"name":"channel","in":"query","type":"string","required":false,"description":"Contains the channel in which the activity was performed. If pricing is not determined based on channel, then this is not significant"},{"name":"senderBankBic","in":"query","type":"string","required":false,"description":"Indicates the sending bank BIC Code"},{"name":"receiver","in":"query","type":"string","required":false,"description":"Identifies the receiver of the message"},{"name":"debtorAccountId","in":"query","type":"string","required":false,"description":"Contains the identification assigned by an institution to identify a debtor account by the account owner."},{"name":"beneficiaryAccountId","in":"query","type":"string","required":false,"description":"Unique account identifier of the beneficiary account number."},{"name":"scheme","in":"query","type":"string","required":false,"description":"Represents the scheme (a synonym for the National ID type) under which the National ID is defined"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"PaymentsAwaitingRateFixingResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/order/payments/externalSystems/autoRepairs/pendings","fullPath":"/api/v1.1.0/order/payments/externalSystems/autoRepairs/pendings","operationId":"getPendingAutoRepairPaymentsPending","name":"Retrieves the list of payments that are waiting for response from auto repair system","summary":"Retrieves payments pending auto repair request","tags":["OTHERS"],"parameters":[{"name":"clearingTransactionType","in":"query","type":"string","required":false,"description":"Indicates the Clearing transaction type."},{"name":"creditCustomerId","in":"query","type":"string","required":false,"description":"Creditor customer id details"},{"name":"customerOrBankTransfer","in":"query","type":"string","required":false,"description":"Indicates if the payment was initiated by Customer or the financial institution"},{"name":"customerSpecifiedReference","in":"query","type":"string","required":false,"description":"Deprecated - Customer specified reference"},{"name":"debitCustomerId","in":"query","type":"string","required":false,"description":"Debtor customer details"},{"name":"paymentDirection","in":"query","type":"string","required":false,"description":"Indicates the direction of payment i.e. incoming, outgoing, book or redirect"},{"name":"endToEndReference","in":"query","type":"string","required":false,"description":"Indicates the end to end reference for the payment. This field can be provided by the person who instructs the payment and this flows through the lifecycle of the payment."},{"name":"entryDateTime","in":"query","type":"string","required":false,"description":"Contains the payment creation time"},{"name":"fileSendersReference","in":"query","type":"string","required":false,"description":"Indicates the sender reference that comes from the inward payment file"},{"name":"paymentId","in":"query","type":"string","required":false,"description":"Indicates the unique reference number of the payment"},{"name":"incomingMessageType","in":"query","type":"string","required":false,"description":"Indicates the supported message type to be received from the clearing house or the direct participant."},{"name":"company","in":"query","type":"string","required":false,"description":"The company code"},{"name":"processingDate","in":"query","type":"string","required":false,"description":"The date when payment instruction is processed in system."},{"name":"partySendersReferenceIncoming","in":"query","type":"string","required":false,"description":"Debtor payment reference details of incoming"},{"name":"partySendersReferenceOutgoing","in":"query","type":"string","required":false,"description":"Debtor payment reference details of outgoing"},{"name":"statusCode","in":"query","type":"string","required":false,"description":"Status code, as defined by the institution"},{"name":"transactionAmount","in":"query","type":"string","required":false,"description":"Contains the transaction amount. This is based on the currency, either local or foreign currency"},{"name":"transactionCurrency","in":"query","type":"string","required":false,"description":"Indicates the currency of the transaction. For example GBP, USD etc."},{"name":"transactionReference","in":"query","type":"string","required":false,"description":"Contains the identifier for the transaction in the core system"},{"name":"valueDate","in":"query","type":"string","required":false,"description":"Contains the value date of the claim or the date on which the amount to be claimed"},{"name":"paymentSource","in":"query","type":"string","required":false,"description":"Indicates the source from where the payment is originated"},{"name":"channel","in":"query","type":"string","required":false,"description":"Contains the channel in which the activity was performed. If pricing is not determined based on channel, then this is not significant"},{"name":"senderBankBic","in":"query","type":"string","required":false,"description":"Indicates the sending bank BIC Code"},{"name":"receiver","in":"query","type":"string","required":false,"description":"Identifies the receiver of the message"},{"name":"debtorAccountId","in":"query","type":"string","required":false,"description":"Contains the identification assigned by an institution to identify a debtor account by the account owner."},{"name":"beneficiaryAccountId","in":"query","type":"string","required":false,"description":"Unique account identifier of the beneficiary account number."},{"name":"scheme","in":"query","type":"string","required":false,"description":"Represents the scheme (a synonym for the National ID type) under which the National ID is defined"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"PendingAutoRepairPaymentsPendingResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/order/payments/externalSystems/balanceCheck/pendings","fullPath":"/api/v1.1.0/order/payments/externalSystems/balanceCheck/pendings","operationId":"getExternalSystemBalanceCheckPaymentsPending","name":"Retrieves the list of payments for which balance  requests have been sent and awaiting responses from external core banking system","summary":"Retrieves payments pending balance check and reservation request","tags":["OTHERS"],"parameters":[{"name":"clearingTransactionType","in":"query","type":"string","required":false,"description":"Indicates the Clearing transaction type."},{"name":"creditCustomerId","in":"query","type":"string","required":false,"description":"Creditor customer id details"},{"name":"customerOrBankTransfer","in":"query","type":"string","required":false,"description":"Indicates if the payment was initiated by Customer or the financial institution"},{"name":"customerSpecifiedReference","in":"query","type":"string","required":false,"description":"Deprecated - Customer specified reference"},{"name":"debitCustomerId","in":"query","type":"string","required":false,"description":"Debtor customer details"},{"name":"paymentDirection","in":"query","type":"string","required":false,"description":"Indicates the direction of payment i.e. incoming, outgoing, book or redirect"},{"name":"endToEndReference","in":"query","type":"string","required":false,"description":"Indicates the end to end reference for the payment. This field can be provided by the person who instructs the payment and this flows through the lifecycle of the payment."},{"name":"entryDateTime","in":"query","type":"string","required":false,"description":"Contains the payment creation time"},{"name":"fileSendersReference","in":"query","type":"string","required":false,"description":"Indicates the sender reference that comes from the inward payment file"},{"name":"paymentId","in":"query","type":"string","required":false,"description":"Indicates the unique reference number of the payment"},{"name":"incomingMessageType","in":"query","type":"string","required":false,"description":"Indicates the supported message type to be received from the clearing house or the direct participant."},{"name":"company","in":"query","type":"string","required":false,"description":"The company code"},{"name":"processingDate","in":"query","type":"string","required":false,"description":"The date when payment instruction is processed in system."},{"name":"partySendersReferenceIncoming","in":"query","type":"string","required":false,"description":"Debtor payment reference details of incoming"},{"name":"partySendersReferenceOutgoing","in":"query","type":"string","required":false,"description":"Debtor payment reference details of outgoing"},{"name":"statusCode","in":"query","type":"string","required":false,"description":"Status code, as defined by the institution"},{"name":"transactionAmount","in":"query","type":"string","required":false,"description":"Contains the transaction amount. This is based on the currency, either local or foreign currency"},{"name":"transactionCurrency","in":"query","type":"string","required":false,"description":"Indicates the currency of the transaction. For example GBP, USD etc."},{"name":"transactionReference","in":"query","type":"string","required":false,"description":"Contains the identifier for the transaction in the core system"},{"name":"valueDate","in":"query","type":"string","required":false,"description":"Contains the value date of the claim or the date on which the amount to be claimed"},{"name":"paymentSource","in":"query","type":"string","required":false,"description":"Indicates the source from where the payment is originated"},{"name":"channel","in":"query","type":"string","required":false,"description":"Contains the channel in which the activity was performed. If pricing is not determined based on channel, then this is not significant"},{"name":"senderBankBic","in":"query","type":"string","required":false,"description":"Indicates the sending bank BIC Code"},{"name":"receiver","in":"query","type":"string","required":false,"description":"Identifies the receiver of the message"},{"name":"debtorAccountId","in":"query","type":"string","required":false,"description":"Contains the identification assigned by an institution to identify a debtor account by the account owner."},{"name":"beneficiaryAccountId","in":"query","type":"string","required":false,"description":"Unique account identifier of the beneficiary account number."},{"name":"scheme","in":"query","type":"string","required":false,"description":"Represents the scheme (a synonym for the National ID type) under which the National ID is defined"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"ExternalSystemBalanceCheckPaymentsPendingResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/order/payments/clearings/files/pendings","fullPath":"/api/v1.1.0/order/payments/clearings/files/pendings","operationId":"getClearingPaymentsPendingDistribution","name":"Retrieves the list of processed payment for which file has to be generated and sent to clearing","summary":"Retrieves processed payments that are yet to be sent to clearing","tags":["OTHERS"],"parameters":[{"name":"clearingTransactionType","in":"query","type":"string","required":false,"description":"Indicates the Clearing transaction type."},{"name":"creditCustomerId","in":"query","type":"string","required":false,"description":"Creditor customer id details"},{"name":"customerOrBankTransfer","in":"query","type":"string","required":false,"description":"Indicates if the payment was initiated by Customer or the financial institution"},{"name":"customerSpecifiedReference","in":"query","type":"string","required":false,"description":"Deprecated - Customer specified reference"},{"name":"debitCustomerId","in":"query","type":"string","required":false,"description":"Debtor customer details"},{"name":"paymentDirection","in":"query","type":"string","required":false,"description":"Indicates the direction of payment i.e. incoming, outgoing, book or redirect"},{"name":"endToEndReference","in":"query","type":"string","required":false,"description":"Indicates the end to end reference for the payment. This field can be provided by the person who instructs the payment and this flows through the lifecycle of the payment."},{"name":"entryDateTime","in":"query","type":"string","required":false,"description":"Contains the payment creation time"},{"name":"fileSendersReference","in":"query","type":"string","required":false,"description":"Indicates the sender reference that comes from the inward payment file"},{"name":"paymentId","in":"query","type":"string","required":false,"description":"Indicates the unique reference number of the payment"},{"name":"incomingMessageType","in":"query","type":"string","required":false,"description":"Indicates the supported message type to be received from the clearing house or the direct participant."},{"name":"company","in":"query","type":"string","required":false,"description":"The company code"},{"name":"processingDate","in":"query","type":"string","required":false,"description":"The date when payment instruction is processed in system."},{"name":"partySendersReferenceIncoming","in":"query","type":"string","required":false,"description":"Debtor payment reference details of incoming"},{"name":"partySendersReferenceOutgoing","in":"query","type":"string","required":false,"description":"Debtor payment reference details of outgoing"},{"name":"statusCode","in":"query","type":"string","required":false,"description":"Status code, as defined by the institution"},{"name":"transactionAmount","in":"query","type":"string","required":false,"description":"Contains the transaction amount. This is based on the currency, either local or foreign currency"},{"name":"transactionCurrency","in":"query","type":"string","required":false,"description":"Indicates the currency of the transaction. For example GBP, USD etc."},{"name":"transactionReference","in":"query","type":"string","required":false,"description":"Contains the identifier for the transaction in the core system"},{"name":"valueDate","in":"query","type":"string","required":false,"description":"Contains the value date of the claim or the date on which the amount to be claimed"},{"name":"paymentSource","in":"query","type":"string","required":false,"description":"Indicates the source from where the payment is originated"},{"name":"channel","in":"query","type":"string","required":false,"description":"Contains the channel in which the activity was performed. If pricing is not determined based on channel, then this is not significant"},{"name":"senderBankBic","in":"query","type":"string","required":false,"description":"Indicates the sending bank BIC Code"},{"name":"receiver","in":"query","type":"string","required":false,"description":"Identifies the receiver of the message"},{"name":"debtorAccountId","in":"query","type":"string","required":false,"description":"Contains the identification assigned by an institution to identify a debtor account by the account owner."},{"name":"beneficiaryAccountId","in":"query","type":"string","required":false,"description":"Unique account identifier of the beneficiary account number."},{"name":"scheme","in":"query","type":"string","required":false,"description":"Represents the scheme (a synonym for the National ID type) under which the National ID is defined"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"ClearingPaymentsPendingDistributionResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}}]},{"key":"order-payments-operationalQueueListingExternalSystems-v1.2.0","title":"Operational Queue Listing External Systems","version":"v1.2.0","description":"Retrieve the list of payments awaiting response from external systems","endpointCount":12,"endpoints":[{"method":"GET","path":"/order/payments/swift/acknowledgements/pendings/cover","fullPath":"/api/v1.2.0/order/payments/swift/acknowledgements/pendings/cover","operationId":"getSwiftAcknowlegementPaymentPending","name":"Retrieves the list of\u00c2\u00a0payments that are awaiting acknowledgment from SWIFT to release cover message","summary":"Retrieves payments waiting for SWIFT acknowledgement to release cover","tags":["OTHERS"],"parameters":[{"name":"clearingTransactionType","in":"query","type":"string","required":false,"description":"Indicates the Clearing transaction type."},{"name":"creditCustomerId","in":"query","type":"string","required":false,"description":"Creditor customer id details"},{"name":"customerOrBankTransfer","in":"query","type":"string","required":false,"description":"Indicates if the payment was initiated by Customer or the financial institution"},{"name":"customerSpecifiedReference","in":"query","type":"string","required":false,"description":"Deprecated - Customer specified reference"},{"name":"debitCustomerId","in":"query","type":"string","required":false,"description":"Debtor customer details"},{"name":"paymentDirection","in":"query","type":"string","required":false,"description":"Indicates the direction of payment i.e. incoming, outgoing, book or redirect"},{"name":"endToEndReference","in":"query","type":"string","required":false,"description":"Indicates the end to end reference for the payment. This field can be provided by the person who instructs the payment and this flows through the lifecycle of the payment."},{"name":"entryDateTime","in":"query","type":"string","required":false,"description":"Contains the payment creation time"},{"name":"fileSendersReference","in":"query","type":"string","required":false,"description":"Indicates the sender reference that comes from the inward payment file"},{"name":"paymentId","in":"query","type":"string","required":false,"description":"Indicates the unique reference number of the payment"},{"name":"incomingMessageType","in":"query","type":"string","required":false,"description":"Indicates the supported message type to be received from the clearing house or the direct participant."},{"name":"company","in":"query","type":"string","required":false,"description":"The company code"},{"name":"processingDate","in":"query","type":"string","required":false,"description":"The date when payment instruction is processed in system."},{"name":"partySendersReferenceIncoming","in":"query","type":"string","required":false,"description":"Debtor payment reference details of incoming"},{"name":"partySendersReferenceOutgoing","in":"query","type":"string","required":false,"description":"Debtor payment reference details of outgoing"},{"name":"statusCode","in":"query","type":"string","required":false,"description":"Status code, as defined by the institution"},{"name":"transactionAmount","in":"query","type":"string","required":false,"description":"Contains the transaction amount. This is based on the currency, either local or foreign currency"},{"name":"transactionCurrency","in":"query","type":"string","required":false,"description":"Indicates the currency of the transaction. For example GBP, USD etc."},{"name":"transactionReference","in":"query","type":"string","required":false,"description":"Contains the identifier for the transaction in the core system"},{"name":"valueDate","in":"query","type":"string","required":false,"description":"Contains the value date of the claim or the date on which the amount to be claimed"},{"name":"paymentSource","in":"query","type":"string","required":false,"description":"Indicates the source from where the payment is originated"},{"name":"channel","in":"query","type":"string","required":false,"description":"Contains the channel in which the activity was performed. If pricing is not determined based on channel, then this is not significant"},{"name":"senderBankBic","in":"query","type":"string","required":false,"description":"Indicates the sending bank BIC Code"},{"name":"receiver","in":"query","type":"string","required":false,"description":"Identifies the receiver of the message"},{"name":"debtorAccountId","in":"query","type":"string","required":false,"description":"Contains the identification assigned by an institution to identify a debtor account by the account owner."},{"name":"beneficiaryAccountId","in":"query","type":"string","required":false,"description":"Unique account identifier of the beneficiary account number."},{"name":"scheme","in":"query","type":"string","required":false,"description":"Represents the scheme (a synonym for the National ID type) under which the National ID is defined"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"SwiftAcknowlegementPaymentPendingResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/order/payments/externalSystems/postings/cancellations/pendings","fullPath":"/api/v1.2.0/order/payments/externalSystems/postings/cancellations/pendings","operationId":"getExternalSystemPaymentReversalsPending","name":"Retrieves the list of payments for which reversal requests have been sent and awaiting responses from external core banking system","summary":"Retrieves payments pending reversal posting request","tags":["OTHERS"],"parameters":[{"name":"processingCompany","in":"query","type":"string","required":false,"description":"Deprecated - Processing company code"},{"name":"transactionReference","in":"query","type":"string","required":false,"description":"Contains the identifier for the transaction in the core system"},{"name":"duplicateCheck","in":"query","type":"string","required":false,"description":"Indicates if a duplicate check on the incoming request has to be performed"},{"name":"requestStatus","in":"query","type":"string","required":false,"description":"Indicates the status when the book entries are reversed or when exceptions as part of booking request is addressed."},{"name":"dateTime","in":"query","type":"string","required":false,"description":"Contains the date and time separated by '-'"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"ExternalSystemPaymentReversalsPendingResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/order/payments/externalSystems/postings/pendings","fullPath":"/api/v1.2.0/order/payments/externalSystems/postings/pendings","operationId":"getExternalSystemPaymentPostingPending","name":"Retrieves the list of payments for which posting requests have been sent and awaiting responses from external core banking system","summary":"Retrieves payments pending posting request","tags":["OTHERS"],"parameters":[{"name":"company","in":"query","type":"string","required":false,"description":"The company code"},{"name":"transactionReference","in":"query","type":"string","required":false,"description":"Contains the identifier for the transaction in the core system"},{"name":"duplicateCheck","in":"query","type":"string","required":false,"description":"Indicates if a duplicate check on the incoming request has to be performed"},{"name":"requestStatus","in":"query","type":"string","required":false,"description":"Indicates the status when the book entries are reversed or when exceptions as part of booking request is addressed."},{"name":"dateTime","in":"query","type":"string","required":false,"description":"Contains the date and time separated by '-'"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"ExternalSystemPaymentPostingPendingResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/order/payments/externalSystems/accountValidations/pendings","fullPath":"/api/v1.2.0/order/payments/externalSystems/accountValidations/pendings","operationId":"getExternalSystemPaymentAccountValidationPending","name":"Retrieves the list of payments for which account validation requests have been sent and awaiting responses from external core banking system","summary":"Retrieves payments pending account validation request","tags":["OTHERS"],"parameters":[{"name":"company","in":"query","type":"string","required":false,"description":"The company code"},{"name":"transactionReference","in":"query","type":"string","required":false,"description":"Contains the identifier for the transaction in the core system"},{"name":"duplicateCheck","in":"query","type":"string","required":false,"description":"Indicates if a duplicate check on the incoming request has to be performed"},{"name":"requestStatus","in":"query","type":"string","required":false,"description":"Indicates the status when the book entries are reversed or when exceptions as part of booking request is addressed."},{"name":"dateTime","in":"query","type":"string","required":false,"description":"Contains the date and time separated by '-'"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"ExternalSystemPaymentAccountValidationPendingResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/order/payments/externalSystems/reservations/cancellations/pendings","fullPath":"/api/v1.2.0/order/payments/externalSystems/reservations/cancellations/pendings","operationId":"getExternalSystemCancelReservationPaymentsPending","name":"Retrieves the list of payments for which cancel reservation requests have been sent and awaiting responses from external core banking system","summary":"Retrieves payments pending cancellation of reservation request","tags":["OTHERS"],"parameters":[{"name":"company","in":"query","type":"string","required":false,"description":"The company code"},{"name":"transactionReference","in":"query","type":"string","required":false,"description":"Contains the identifier for the transaction in the core system"},{"name":"duplicateCheck","in":"query","type":"string","required":false,"description":"Indicates if a duplicate check on the incoming request has to be performed"},{"name":"requestStatus","in":"query","type":"string","required":false,"description":"Indicates the status when the book entries are reversed or when exceptions as part of booking request is addressed."},{"name":"dateTime","in":"query","type":"string","required":false,"description":"Contains the date and time separated by '-'"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"ExternalSystemCancelReservationPaymentsPendingResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/order/payments/fundsReservations/pendings","fullPath":"/api/v1.2.0/order/payments/fundsReservations/pendings","operationId":"getExternalSystemFundsReservationPaymentsPending","name":"Retrieves the list of payments for which funds reservation requests have been sent and awaiting responses from external core banking system","summary":"Retrieves payments pending funds reservation request","tags":["OTHERS"],"parameters":[{"name":"company","in":"query","type":"string","required":false,"description":"The company code"},{"name":"transactionReference","in":"query","type":"string","required":false,"description":"Contains the identifier for the transaction in the core system"},{"name":"duplicateCheck","in":"query","type":"string","required":false,"description":"Indicates if a duplicate check on the incoming request has to be performed"},{"name":"requestStatus","in":"query","type":"string","required":false,"description":"Indicates the status when the book entries are reversed or when exceptions as part of booking request is addressed."},{"name":"dateTime","in":"query","type":"string","required":false,"description":"Contains the date and time separated by '-'"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"ExternalSystemFundsReservationPaymentsPendingResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/order/payments/highValues/externalSystems/exchangeRates/pendings","fullPath":"/api/v1.2.0/order/payments/highValues/externalSystems/exchangeRates/pendings","operationId":"getPaymentsPendingTreasuryRateFromExternalSystem","name":"Retrieves the list of payments for which rate requests have been sent and awaiting responses from external core banking system","summary":"Retrieves high value payments awaiting special rate from external treasury system","tags":["OTHERS"],"parameters":[{"name":"clearingTransactionType","in":"query","type":"string","required":false,"description":"Indicates the Clearing transaction type."},{"name":"creditCustomerId","in":"query","type":"string","required":false,"description":"Creditor customer id details"},{"name":"customerOrBankTransfer","in":"query","type":"string","required":false,"description":"Indicates if the payment was initiated by Customer or the financial institution"},{"name":"customerSpecifiedReference","in":"query","type":"string","required":false,"description":"Deprecated - Customer specified reference"},{"name":"debitCustomerId","in":"query","type":"string","required":false,"description":"Debtor customer details"},{"name":"paymentDirection","in":"query","type":"string","required":false,"description":"Indicates the direction of payment i.e. incoming, outgoing, book or redirect"},{"name":"endToEndReference","in":"query","type":"string","required":false,"description":"Indicates the end to end reference for the payment. This field can be provided by the person who instructs the payment and this flows through the lifecycle of the payment."},{"name":"entryDateTime","in":"query","type":"string","required":false,"description":"Contains the payment creation time"},{"name":"fileSendersReference","in":"query","type":"string","required":false,"description":"Indicates the sender reference that comes from the inward payment file"},{"name":"paymentId","in":"query","type":"string","required":false,"description":"Indicates the unique reference number of the payment"},{"name":"incomingMessageType","in":"query","type":"string","required":false,"description":"Indicates the supported message type to be received from the clearing house or the direct participant."},{"name":"company","in":"query","type":"string","required":false,"description":"The company code"},{"name":"processingDate","in":"query","type":"string","required":false,"description":"The date when payment instruction is processed in system."},{"name":"partySendersReferenceIncoming","in":"query","type":"string","required":false,"description":"Debtor payment reference details of incoming"},{"name":"partySendersReferenceOutgoing","in":"query","type":"string","required":false,"description":"Debtor payment reference details of outgoing"},{"name":"statusCode","in":"query","type":"string","required":false,"description":"Status code, as defined by the institution"},{"name":"transactionAmount","in":"query","type":"string","required":false,"description":"Contains the transaction amount. This is based on the currency, either local or foreign currency"},{"name":"transactionCurrency","in":"query","type":"string","required":false,"description":"Indicates the currency of the transaction. For example GBP, USD etc."},{"name":"transactionReference","in":"query","type":"string","required":false,"description":"Contains the identifier for the transaction in the core system"},{"name":"valueDate","in":"query","type":"string","required":false,"description":"Contains the value date of the claim or the date on which the amount to be claimed"},{"name":"paymentSource","in":"query","type":"string","required":false,"description":"Indicates the source from where the payment is originated"},{"name":"channel","in":"query","type":"string","required":false,"description":"Contains the channel in which the activity was performed. If pricing is not determined based on channel, then this is not significant"},{"name":"senderBankBic","in":"query","type":"string","required":false,"description":"Indicates the sending bank BIC Code"},{"name":"receiver","in":"query","type":"string","required":false,"description":"Identifies the receiver of the message"},{"name":"debtorAccountId","in":"query","type":"string","required":false,"description":"Contains the identification assigned by an institution to identify a debtor account by the account owner."},{"name":"beneficiaryAccountId","in":"query","type":"string","required":false,"description":"Unique account identifier of the beneficiary account number."},{"name":"scheme","in":"query","type":"string","required":false,"description":"Represents the scheme (a synonym for the National ID type) under which the National ID is defined"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"PaymentsPendingTreasuryRateFromExternalSystemResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/order/payments/externalSystems/screenings/pendings","fullPath":"/api/v1.2.0/order/payments/externalSystems/screenings/pendings","operationId":"getScreeningRequestsPaymentsPending","name":"Retrieves the list of payments for which screening requests have been sent and awaiting response","summary":"Retrieves payments waiting for screening","tags":["OTHERS"],"parameters":[{"name":"transactionReference","in":"query","type":"string","required":false,"description":"Contains the identifier for the transaction in the core system"},{"name":"dateSent","in":"query","type":"string","required":false,"description":"The date when the message is sent."},{"name":"activityDateTimeStamp","in":"query","type":"string","required":false,"description":"Contains the date and time of activity triggered."},{"name":"receivedDateTime","in":"query","type":"string","required":false,"description":"Indicates the date and time when the request to pay message is received for payer and requestor"},{"name":"paymentStatus","in":"query","type":"string","required":false,"description":"Describes the current status of the payment order in the payment system"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"ScreeningRequestsPaymentsPendingResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/order/payments/exchangeRates/pendings","fullPath":"/api/v1.2.0/order/payments/exchangeRates/pendings","operationId":"getPaymentsAwaitingRateFixing","name":"Retrieves the list of payments waiting for today's FX rate","summary":"Retrieves payments awaiting today's exchange rate","tags":["OTHERS"],"parameters":[{"name":"clearingTransactionType","in":"query","type":"string","required":false,"description":"Indicates the Clearing transaction type."},{"name":"creditCustomerId","in":"query","type":"string","required":false,"description":"Creditor customer id details"},{"name":"customerOrBankTransfer","in":"query","type":"string","required":false,"description":"Indicates if the payment was initiated by Customer or the financial institution"},{"name":"customerSpecifiedReference","in":"query","type":"string","required":false,"description":"Deprecated - Customer specified reference"},{"name":"debitCustomerId","in":"query","type":"string","required":false,"description":"Debtor customer details"},{"name":"paymentDirection","in":"query","type":"string","required":false,"description":"Indicates the direction of payment i.e. incoming, outgoing, book or redirect"},{"name":"endToEndReference","in":"query","type":"string","required":false,"description":"Indicates the end to end reference for the payment. This field can be provided by the person who instructs the payment and this flows through the lifecycle of the payment."},{"name":"entryDateTime","in":"query","type":"string","required":false,"description":"Contains the payment creation time"},{"name":"fileSendersReference","in":"query","type":"string","required":false,"description":"Indicates the sender reference that comes from the inward payment file"},{"name":"paymentId","in":"query","type":"string","required":false,"description":"Indicates the unique reference number of the payment"},{"name":"incomingMessageType","in":"query","type":"string","required":false,"description":"Indicates the supported message type to be received from the clearing house or the direct participant."},{"name":"company","in":"query","type":"string","required":false,"description":"The company code"},{"name":"processingDate","in":"query","type":"string","required":false,"description":"The date when payment instruction is processed in system."},{"name":"partySendersReferenceIncoming","in":"query","type":"string","required":false,"description":"Debtor payment reference details of incoming"},{"name":"partySendersReferenceOutgoing","in":"query","type":"string","required":false,"description":"Debtor payment reference details of outgoing"},{"name":"statusCode","in":"query","type":"string","required":false,"description":"Status code, as defined by the institution"},{"name":"transactionAmount","in":"query","type":"string","required":false,"description":"Contains the transaction amount. This is based on the currency, either local or foreign currency"},{"name":"transactionCurrency","in":"query","type":"string","required":false,"description":"Indicates the currency of the transaction. For example GBP, USD etc."},{"name":"transactionReference","in":"query","type":"string","required":false,"description":"Contains the identifier for the transaction in the core system"},{"name":"valueDate","in":"query","type":"string","required":false,"description":"Contains the value date of the claim or the date on which the amount to be claimed"},{"name":"paymentSource","in":"query","type":"string","required":false,"description":"Indicates the source from where the payment is originated"},{"name":"channel","in":"query","type":"string","required":false,"description":"Contains the channel in which the activity was performed. If pricing is not determined based on channel, then this is not significant"},{"name":"senderBankBic","in":"query","type":"string","required":false,"description":"Indicates the sending bank BIC Code"},{"name":"receiver","in":"query","type":"string","required":false,"description":"Identifies the receiver of the message"},{"name":"debtorAccountId","in":"query","type":"string","required":false,"description":"Contains the identification assigned by an institution to identify a debtor account by the account owner."},{"name":"beneficiaryAccountId","in":"query","type":"string","required":false,"description":"Unique account identifier of the beneficiary account number."},{"name":"scheme","in":"query","type":"string","required":false,"description":"Represents the scheme (a synonym for the National ID type) under which the National ID is defined"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"PaymentsAwaitingRateFixingResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/order/payments/externalSystems/autoRepairs/pendings","fullPath":"/api/v1.2.0/order/payments/externalSystems/autoRepairs/pendings","operationId":"getPendingAutoRepairPaymentsPending","name":"Retrieves the list of payments that are waiting for response from auto repair system","summary":"Retrieves payments pending auto repair request","tags":["OTHERS"],"parameters":[{"name":"clearingTransactionType","in":"query","type":"string","required":false,"description":"Indicates the Clearing transaction type."},{"name":"creditCustomerId","in":"query","type":"string","required":false,"description":"Creditor customer id details"},{"name":"customerOrBankTransfer","in":"query","type":"string","required":false,"description":"Indicates if the payment was initiated by Customer or the financial institution"},{"name":"customerSpecifiedReference","in":"query","type":"string","required":false,"description":"Deprecated - Customer specified reference"},{"name":"debitCustomerId","in":"query","type":"string","required":false,"description":"Debtor customer details"},{"name":"paymentDirection","in":"query","type":"string","required":false,"description":"Indicates the direction of payment i.e. incoming, outgoing, book or redirect"},{"name":"endToEndReference","in":"query","type":"string","required":false,"description":"Indicates the end to end reference for the payment. This field can be provided by the person who instructs the payment and this flows through the lifecycle of the payment."},{"name":"entryDateTime","in":"query","type":"string","required":false,"description":"Contains the payment creation time"},{"name":"fileSendersReference","in":"query","type":"string","required":false,"description":"Indicates the sender reference that comes from the inward payment file"},{"name":"paymentId","in":"query","type":"string","required":false,"description":"Indicates the unique reference number of the payment"},{"name":"incomingMessageType","in":"query","type":"string","required":false,"description":"Indicates the supported message type to be received from the clearing house or the direct participant."},{"name":"company","in":"query","type":"string","required":false,"description":"The company code"},{"name":"processingDate","in":"query","type":"string","required":false,"description":"The date when payment instruction is processed in system."},{"name":"partySendersReferenceIncoming","in":"query","type":"string","required":false,"description":"Debtor payment reference details of incoming"},{"name":"partySendersReferenceOutgoing","in":"query","type":"string","required":false,"description":"Debtor payment reference details of outgoing"},{"name":"statusCode","in":"query","type":"string","required":false,"description":"Status code, as defined by the institution"},{"name":"transactionAmount","in":"query","type":"string","required":false,"description":"Contains the transaction amount. This is based on the currency, either local or foreign currency"},{"name":"transactionCurrency","in":"query","type":"string","required":false,"description":"Indicates the currency of the transaction. For example GBP, USD etc."},{"name":"transactionReference","in":"query","type":"string","required":false,"description":"Contains the identifier for the transaction in the core system"},{"name":"valueDate","in":"query","type":"string","required":false,"description":"Contains the value date of the claim or the date on which the amount to be claimed"},{"name":"paymentSource","in":"query","type":"string","required":false,"description":"Indicates the source from where the payment is originated"},{"name":"channel","in":"query","type":"string","required":false,"description":"Contains the channel in which the activity was performed. If pricing is not determined based on channel, then this is not significant"},{"name":"senderBankBic","in":"query","type":"string","required":false,"description":"Indicates the sending bank BIC Code"},{"name":"receiver","in":"query","type":"string","required":false,"description":"Identifies the receiver of the message"},{"name":"debtorAccountId","in":"query","type":"string","required":false,"description":"Contains the identification assigned by an institution to identify a debtor account by the account owner."},{"name":"beneficiaryAccountId","in":"query","type":"string","required":false,"description":"Unique account identifier of the beneficiary account number."},{"name":"scheme","in":"query","type":"string","required":false,"description":"Represents the scheme (a synonym for the National ID type) under which the National ID is defined"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"PendingAutoRepairPaymentsPendingResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/order/payments/externalSystems/balanceCheck/pendings","fullPath":"/api/v1.2.0/order/payments/externalSystems/balanceCheck/pendings","operationId":"getExternalSystemBalanceCheckPaymentsPending","name":"Retrieves the list of payments for which balance  requests have been sent and awaiting responses from external core banking system","summary":"Retrieves payments pending balance check and reservation request","tags":["OTHERS"],"parameters":[{"name":"clearingTransactionType","in":"query","type":"string","required":false,"description":"Indicates the Clearing transaction type."},{"name":"creditCustomerId","in":"query","type":"string","required":false,"description":"Creditor customer id details"},{"name":"customerOrBankTransfer","in":"query","type":"string","required":false,"description":"Indicates if the payment was initiated by Customer or the financial institution"},{"name":"customerSpecifiedReference","in":"query","type":"string","required":false,"description":"Deprecated - Customer specified reference"},{"name":"debitCustomerId","in":"query","type":"string","required":false,"description":"Debtor customer details"},{"name":"paymentDirection","in":"query","type":"string","required":false,"description":"Indicates the direction of payment i.e. incoming, outgoing, book or redirect"},{"name":"endToEndReference","in":"query","type":"string","required":false,"description":"Indicates the end to end reference for the payment. This field can be provided by the person who instructs the payment and this flows through the lifecycle of the payment."},{"name":"entryDateTime","in":"query","type":"string","required":false,"description":"Contains the payment creation time"},{"name":"fileSendersReference","in":"query","type":"string","required":false,"description":"Indicates the sender reference that comes from the inward payment file"},{"name":"paymentId","in":"query","type":"string","required":false,"description":"Indicates the unique reference number of the payment"},{"name":"incomingMessageType","in":"query","type":"string","required":false,"description":"Indicates the supported message type to be received from the clearing house or the direct participant."},{"name":"company","in":"query","type":"string","required":false,"description":"The company code"},{"name":"processingDate","in":"query","type":"string","required":false,"description":"The date when payment instruction is processed in system."},{"name":"partySendersReferenceIncoming","in":"query","type":"string","required":false,"description":"Debtor payment reference details of incoming"},{"name":"partySendersReferenceOutgoing","in":"query","type":"string","required":false,"description":"Debtor payment reference details of outgoing"},{"name":"statusCode","in":"query","type":"string","required":false,"description":"Status code, as defined by the institution"},{"name":"transactionAmount","in":"query","type":"string","required":false,"description":"Contains the transaction amount. This is based on the currency, either local or foreign currency"},{"name":"transactionCurrency","in":"query","type":"string","required":false,"description":"Indicates the currency of the transaction. For example GBP, USD etc."},{"name":"transactionReference","in":"query","type":"string","required":false,"description":"Contains the identifier for the transaction in the core system"},{"name":"valueDate","in":"query","type":"string","required":false,"description":"Contains the value date of the claim or the date on which the amount to be claimed"},{"name":"paymentSource","in":"query","type":"string","required":false,"description":"Indicates the source from where the payment is originated"},{"name":"channel","in":"query","type":"string","required":false,"description":"Contains the channel in which the activity was performed. If pricing is not determined based on channel, then this is not significant"},{"name":"senderBankBic","in":"query","type":"string","required":false,"description":"Indicates the sending bank BIC Code"},{"name":"receiver","in":"query","type":"string","required":false,"description":"Identifies the receiver of the message"},{"name":"debtorAccountId","in":"query","type":"string","required":false,"description":"Contains the identification assigned by an institution to identify a debtor account by the account owner."},{"name":"beneficiaryAccountId","in":"query","type":"string","required":false,"description":"Unique account identifier of the beneficiary account number."},{"name":"scheme","in":"query","type":"string","required":false,"description":"Represents the scheme (a synonym for the National ID type) under which the National ID is defined"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"ExternalSystemBalanceCheckPaymentsPendingResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/order/payments/clearings/files/pendings","fullPath":"/api/v1.2.0/order/payments/clearings/files/pendings","operationId":"getClearingPaymentsPendingDistribution","name":"Retrieves the list of processed payment for which file has to be generated and sent to clearing","summary":"Retrieves processed payments that are yet to be sent to clearing","tags":["OTHERS"],"parameters":[{"name":"clearingTransactionType","in":"query","type":"string","required":false,"description":"Indicates the Clearing transaction type."},{"name":"creditCustomerId","in":"query","type":"string","required":false,"description":"Creditor customer id details"},{"name":"customerOrBankTransfer","in":"query","type":"string","required":false,"description":"Indicates if the payment was initiated by Customer or the financial institution"},{"name":"customerSpecifiedReference","in":"query","type":"string","required":false,"description":"Deprecated - Customer specified reference"},{"name":"debitCustomerId","in":"query","type":"string","required":false,"description":"Debtor customer details"},{"name":"paymentDirection","in":"query","type":"string","required":false,"description":"Indicates the direction of payment i.e. incoming, outgoing, book or redirect"},{"name":"endToEndReference","in":"query","type":"string","required":false,"description":"Indicates the end to end reference for the payment. This field can be provided by the person who instructs the payment and this flows through the lifecycle of the payment."},{"name":"entryDateTime","in":"query","type":"string","required":false,"description":"Contains the payment creation time"},{"name":"fileSendersReference","in":"query","type":"string","required":false,"description":"Indicates the sender reference that comes from the inward payment file"},{"name":"paymentId","in":"query","type":"string","required":false,"description":"Indicates the unique reference number of the payment"},{"name":"incomingMessageType","in":"query","type":"string","required":false,"description":"Indicates the supported message type to be received from the clearing house or the direct participant."},{"name":"company","in":"query","type":"string","required":false,"description":"The company code"},{"name":"processingDate","in":"query","type":"string","required":false,"description":"The date when payment instruction is processed in system."},{"name":"partySendersReferenceIncoming","in":"query","type":"string","required":false,"description":"Debtor payment reference details of incoming"},{"name":"partySendersReferenceOutgoing","in":"query","type":"string","required":false,"description":"Debtor payment reference details of outgoing"},{"name":"statusCode","in":"query","type":"string","required":false,"description":"Status code, as defined by the institution"},{"name":"transactionAmount","in":"query","type":"string","required":false,"description":"Contains the transaction amount. This is based on the currency, either local or foreign currency"},{"name":"transactionCurrency","in":"query","type":"string","required":false,"description":"Indicates the currency of the transaction. For example GBP, USD etc."},{"name":"transactionReference","in":"query","type":"string","required":false,"description":"Contains the identifier for the transaction in the core system"},{"name":"valueDate","in":"query","type":"string","required":false,"description":"Contains the value date of the claim or the date on which the amount to be claimed"},{"name":"paymentSource","in":"query","type":"string","required":false,"description":"Indicates the source from where the payment is originated"},{"name":"channel","in":"query","type":"string","required":false,"description":"Contains the channel in which the activity was performed. If pricing is not determined based on channel, then this is not significant"},{"name":"senderBankBic","in":"query","type":"string","required":false,"description":"Indicates the sending bank BIC Code"},{"name":"receiver","in":"query","type":"string","required":false,"description":"Identifies the receiver of the message"},{"name":"debtorAccountId","in":"query","type":"string","required":false,"description":"Contains the identification assigned by an institution to identify a debtor account by the account owner."},{"name":"beneficiaryAccountId","in":"query","type":"string","required":false,"description":"Unique account identifier of the beneficiary account number."},{"name":"scheme","in":"query","type":"string","required":false,"description":"Represents the scheme (a synonym for the National ID type) under which the National ID is defined"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"ClearingPaymentsPendingDistributionResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}}]},{"key":"order-payments-operationalQueueListingReturns-v1.0.0","title":"Operational Queue Listing Returns","version":"v1.0.0","description":"Retrieve the list of return payments that requires manual action","endpointCount":3,"endpoints":[{"method":"GET","path":"/order/payments/cover/redirects/returns/pendings","fullPath":"/api/v1.0.0/order/payments/cover/redirects/returns/pendings","operationId":"getPendingInwardReturnRedirectPaymentRcvdViaCover","name":"Retrieves the list of inward return and redirect payments received via cover awaiting manual action","summary":"Retrieves inward return and redirect payments received via cover","tags":["OTHERS"],"parameters":[{"name":"clearingTransactionType","in":"query","type":"string","required":false,"description":"Indicates the Clearing transaction type."},{"name":"creditCustomerId","in":"query","type":"string","required":false,"description":"Creditor customer id details"},{"name":"customerOrBankTransfer","in":"query","type":"string","required":false,"description":"Indicates if the payment was initiated by Customer or the financial institution"},{"name":"customerSpecifiedReference","in":"query","type":"string","required":false,"description":"Deprecated - Customer specified reference"},{"name":"debitCustomerId","in":"query","type":"string","required":false,"description":"Debtor customer details"},{"name":"paymentDirection","in":"query","type":"string","required":false,"description":"Indicates the direction of payment i.e. incoming, outgoing, book or redirect"},{"name":"endToEndReference","in":"query","type":"string","required":false,"description":"Indicates the end to end reference for the payment. This field can be provided by the person who instructs the payment and this flows through the lifecycle of the payment."},{"name":"entryDateTime","in":"query","type":"string","required":false,"description":"Contains the payment creation time"},{"name":"fileSendersReference","in":"query","type":"string","required":false,"description":"Indicates the sender reference that comes from the inward payment file"},{"name":"paymentId","in":"query","type":"string","required":false,"description":"Indicates the unique reference number of the payment"},{"name":"incomingMessageType","in":"query","type":"string","required":false,"description":"Indicates the supported message type to be received from the clearing house or the direct participant."},{"name":"company","in":"query","type":"string","required":false,"description":"The company code"},{"name":"processingDate","in":"query","type":"string","required":false,"description":"The date when payment instruction is processed in system."},{"name":"partySendersReferenceIncoming","in":"query","type":"string","required":false,"description":"Debtor payment reference details of incoming"},{"name":"partySendersReferenceOutgoing","in":"query","type":"string","required":false,"description":"Debtor payment reference details of outgoing"},{"name":"statusCode","in":"query","type":"string","required":false,"description":"Status code, as defined by the institution"},{"name":"transactionAmount","in":"query","type":"string","required":false,"description":"Contains the transaction amount. This is based on the currency, either local or foreign currency"},{"name":"transactionCurrency","in":"query","type":"string","required":false,"description":"Indicates the currency of the transaction. For example GBP, USD etc."},{"name":"transactionReference","in":"query","type":"string","required":false,"description":"Contains the identifier for the transaction in the core system"},{"name":"valueDate","in":"query","type":"string","required":false,"description":"Contains the value date of the claim or the date on which the amount to be claimed"},{"name":"paymentSource","in":"query","type":"string","required":false,"description":"Indicates the source from where the payment is originated"},{"name":"channel","in":"query","type":"string","required":false,"description":"Contains the channel in which the activity was performed. If pricing is not determined based on channel, then this is not significant"},{"name":"senderBankBic","in":"query","type":"string","required":false,"description":"Indicates the sending bank BIC Code"},{"name":"receiver","in":"query","type":"string","required":false,"description":"Identifies the receiver of the message"},{"name":"debtorAccountId","in":"query","type":"string","required":false,"description":"Contains the identification assigned by an institution to identify a debtor account by the account owner."},{"name":"beneficiaryAccountId","in":"query","type":"string","required":false,"description":"Unique account identifier of the beneficiary account number."},{"name":"scheme","in":"query","type":"string","required":false,"description":"Represents the scheme (a synonym for the National ID type) under which the National ID is defined"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"PendingInwardReturnRedirectPaymentRcvdViaCoverResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/order/payments/settled/cover/returns/pendings","fullPath":"/api/v1.0.0/order/payments/settled/cover/returns/pendings","operationId":"getInwardReturnRedirectCoverPaymentsPending","name":"Retrieves the list of return transactions originally settled via cover method(redirected) requiring manual action","summary":"Retrieves return transactions settled via cover(redirected)","tags":["OTHERS"],"parameters":[{"name":"clearingTransactionType","in":"query","type":"string","required":false,"description":"Indicates the Clearing transaction type."},{"name":"creditCustomerId","in":"query","type":"string","required":false,"description":"Creditor customer id details"},{"name":"customerOrBankTransfer","in":"query","type":"string","required":false,"description":"Indicates if the payment was initiated by Customer or the financial institution"},{"name":"customerSpecifiedReference","in":"query","type":"string","required":false,"description":"Deprecated - Customer specified reference"},{"name":"debitCustomerId","in":"query","type":"string","required":false,"description":"Debtor customer details"},{"name":"paymentDirection","in":"query","type":"string","required":false,"description":"Indicates the direction of payment i.e. incoming, outgoing, book or redirect"},{"name":"endToEndReference","in":"query","type":"string","required":false,"description":"Indicates the end to end reference for the payment. This field can be provided by the person who instructs the payment and this flows through the lifecycle of the payment."},{"name":"entryDateTime","in":"query","type":"string","required":false,"description":"Contains the payment creation time"},{"name":"fileSendersReference","in":"query","type":"string","required":false,"description":"Indicates the sender reference that comes from the inward payment file"},{"name":"paymentId","in":"query","type":"string","required":false,"description":"Indicates the unique reference number of the payment"},{"name":"incomingMessageType","in":"query","type":"string","required":false,"description":"Indicates the supported message type to be received from the clearing house or the direct participant."},{"name":"company","in":"query","type":"string","required":false,"description":"The company code"},{"name":"processingDate","in":"query","type":"string","required":false,"description":"The date when payment instruction is processed in system."},{"name":"partySendersReferenceIncoming","in":"query","type":"string","required":false,"description":"Debtor payment reference details of incoming"},{"name":"partySendersReferenceOutgoing","in":"query","type":"string","required":false,"description":"Debtor payment reference details of outgoing"},{"name":"statusCode","in":"query","type":"string","required":false,"description":"Status code, as defined by the institution"},{"name":"transactionAmount","in":"query","type":"string","required":false,"description":"Contains the transaction amount. This is based on the currency, either local or foreign currency"},{"name":"transactionCurrency","in":"query","type":"string","required":false,"description":"Indicates the currency of the transaction. For example GBP, USD etc."},{"name":"transactionReference","in":"query","type":"string","required":false,"description":"Contains the identifier for the transaction in the core system"},{"name":"valueDate","in":"query","type":"string","required":false,"description":"Contains the value date of the claim or the date on which the amount to be claimed"},{"name":"paymentSource","in":"query","type":"string","required":false,"description":"Indicates the source from where the payment is originated"},{"name":"channel","in":"query","type":"string","required":false,"description":"Contains the channel in which the activity was performed. If pricing is not determined based on channel, then this is not significant"},{"name":"senderBankBic","in":"query","type":"string","required":false,"description":"Indicates the sending bank BIC Code"},{"name":"receiver","in":"query","type":"string","required":false,"description":"Identifies the receiver of the message"},{"name":"debtorAccountId","in":"query","type":"string","required":false,"description":"Contains the identification assigned by an institution to identify a debtor account by the account owner."},{"name":"beneficiaryAccountId","in":"query","type":"string","required":false,"description":"Unique account identifier of the beneficiary account number."},{"name":"scheme","in":"query","type":"string","required":false,"description":"Represents the scheme (a synonym for the National ID type) under which the National ID is defined"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"InwardReturnRedirectCoverPaymentsPendingResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/order/payments/swift/returns/settlements/pendings","fullPath":"/api/v1.0.0/order/payments/swift/returns/settlements/pendings","operationId":"getPendingReturnReversalInwardSwiftPayments","name":"Retrieves the list of return or reversal SWIFT MT payments that are in repair queue awaiting manual action","summary":"Retrieves returns or reversals of SWIFT MT payments ","tags":["OTHERS"],"parameters":[{"name":"clearingTransactionType","in":"query","type":"string","required":false,"description":"Indicates the Clearing transaction type."},{"name":"creditCustomerId","in":"query","type":"string","required":false,"description":"Creditor customer id details"},{"name":"customerOrBankTransfer","in":"query","type":"string","required":false,"description":"Indicates if the payment was initiated by Customer or the financial institution"},{"name":"customerSpecifiedReference","in":"query","type":"string","required":false,"description":"Deprecated - Customer specified reference"},{"name":"debitCustomerId","in":"query","type":"string","required":false,"description":"Debtor customer details"},{"name":"paymentDirection","in":"query","type":"string","required":false,"description":"Indicates the direction of payment i.e. incoming, outgoing, book or redirect"},{"name":"endToEndReference","in":"query","type":"string","required":false,"description":"Indicates the end to end reference for the payment. This field can be provided by the person who instructs the payment and this flows through the lifecycle of the payment."},{"name":"entryDateTime","in":"query","type":"string","required":false,"description":"Contains the payment creation time"},{"name":"fileSendersReference","in":"query","type":"string","required":false,"description":"Indicates the sender reference that comes from the inward payment file"},{"name":"paymentId","in":"query","type":"string","required":false,"description":"Indicates the unique reference number of the payment"},{"name":"incomingMessageType","in":"query","type":"string","required":false,"description":"Indicates the supported message type to be received from the clearing house or the direct participant."},{"name":"company","in":"query","type":"string","required":false,"description":"The company code"},{"name":"processingDate","in":"query","type":"string","required":false,"description":"The date when payment instruction is processed in system."},{"name":"partySendersReferenceIncoming","in":"query","type":"string","required":false,"description":"Debtor payment reference details of incoming"},{"name":"partySendersReferenceOutgoing","in":"query","type":"string","required":false,"description":"Debtor payment reference details of outgoing"},{"name":"statusCode","in":"query","type":"string","required":false,"description":"Status code, as defined by the institution"},{"name":"transactionAmount","in":"query","type":"string","required":false,"description":"Contains the transaction amount. This is based on the currency, either local or foreign currency"},{"name":"transactionCurrency","in":"query","type":"string","required":false,"description":"Indicates the currency of the transaction. For example GBP, USD etc."},{"name":"transactionReference","in":"query","type":"string","required":false,"description":"Contains the identifier for the transaction in the core system"},{"name":"valueDate","in":"query","type":"string","required":false,"description":"Contains the value date of the claim or the date on which the amount to be claimed"},{"name":"paymentSource","in":"query","type":"string","required":false,"description":"Indicates the source from where the payment is originated"},{"name":"channel","in":"query","type":"string","required":false,"description":"Contains the channel in which the activity was performed. If pricing is not determined based on channel, then this is not significant"},{"name":"senderBankBic","in":"query","type":"string","required":false,"description":"Indicates the sending bank BIC Code"},{"name":"receiver","in":"query","type":"string","required":false,"description":"Identifies the receiver of the message"},{"name":"debtorAccountId","in":"query","type":"string","required":false,"description":"Contains the identification assigned by an institution to identify a debtor account by the account owner."},{"name":"beneficiaryAccountId","in":"query","type":"string","required":false,"description":"Unique account identifier of the beneficiary account number."},{"name":"scheme","in":"query","type":"string","required":false,"description":"Represents the scheme (a synonym for the National ID type) under which the National ID is defined"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"PendingReturnReversalInwardSwiftPaymentsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}}]},{"key":"order-payments-operationalQueueListingReturns-v1.1.0","title":"Operational Queue Listing Returns","version":"v1.1.0","description":"Retrieve the list of return payments that requires manual action","endpointCount":3,"endpoints":[{"method":"GET","path":"/order/payments/cover/redirects/returns/pendings","fullPath":"/api/v1.1.0/order/payments/cover/redirects/returns/pendings","operationId":"getPendingInwardReturnRedirectPaymentRcvdViaCover","name":"Retrieves the list of inward return and redirect payments received via cover awaiting manual action","summary":"Retrieves inward return and redirect payments received via cover","tags":["OTHERS"],"parameters":[{"name":"clearingTransactionType","in":"query","type":"string","required":false,"description":"Indicates the Clearing transaction type."},{"name":"creditCustomerId","in":"query","type":"string","required":false,"description":"Creditor customer id details"},{"name":"customerOrBankTransfer","in":"query","type":"string","required":false,"description":"Indicates if the payment was initiated by Customer or the financial institution"},{"name":"customerSpecifiedReference","in":"query","type":"string","required":false,"description":"Deprecated - Customer specified reference"},{"name":"debitCustomerId","in":"query","type":"string","required":false,"description":"Debtor customer details"},{"name":"paymentDirection","in":"query","type":"string","required":false,"description":"Indicates the direction of payment i.e. incoming, outgoing, book or redirect"},{"name":"endToEndReference","in":"query","type":"string","required":false,"description":"Indicates the end to end reference for the payment. This field can be provided by the person who instructs the payment and this flows through the lifecycle of the payment."},{"name":"entryDateTime","in":"query","type":"string","required":false,"description":"Contains the payment creation time"},{"name":"fileSendersReference","in":"query","type":"string","required":false,"description":"Indicates the sender reference that comes from the inward payment file"},{"name":"paymentId","in":"query","type":"string","required":false,"description":"Indicates the unique reference number of the payment"},{"name":"incomingMessageType","in":"query","type":"string","required":false,"description":"Indicates the supported message type to be received from the clearing house or the direct participant."},{"name":"company","in":"query","type":"string","required":false,"description":"The company code"},{"name":"processingDate","in":"query","type":"string","required":false,"description":"The date when payment instruction is processed in system."},{"name":"partySendersReferenceIncoming","in":"query","type":"string","required":false,"description":"Debtor payment reference details of incoming"},{"name":"partySendersReferenceOutgoing","in":"query","type":"string","required":false,"description":"Debtor payment reference details of outgoing"},{"name":"statusCode","in":"query","type":"string","required":false,"description":"Status code, as defined by the institution"},{"name":"transactionAmount","in":"query","type":"string","required":false,"description":"Contains the transaction amount. This is based on the currency, either local or foreign currency"},{"name":"transactionCurrency","in":"query","type":"string","required":false,"description":"Indicates the currency of the transaction. For example GBP, USD etc."},{"name":"transactionReference","in":"query","type":"string","required":false,"description":"Contains the identifier for the transaction in the core system"},{"name":"valueDate","in":"query","type":"string","required":false,"description":"Contains the value date of the claim or the date on which the amount to be claimed"},{"name":"paymentSource","in":"query","type":"string","required":false,"description":"Indicates the source from where the payment is originated"},{"name":"channel","in":"query","type":"string","required":false,"description":"Contains the channel in which the activity was performed. If pricing is not determined based on channel, then this is not significant"},{"name":"senderBankBic","in":"query","type":"string","required":false,"description":"Indicates the sending bank BIC Code"},{"name":"receiver","in":"query","type":"string","required":false,"description":"Identifies the receiver of the message"},{"name":"debtorAccountId","in":"query","type":"string","required":false,"description":"Contains the identification assigned by an institution to identify a debtor account by the account owner."},{"name":"beneficiaryAccountId","in":"query","type":"string","required":false,"description":"Unique account identifier of the beneficiary account number."},{"name":"scheme","in":"query","type":"string","required":false,"description":"Represents the scheme (a synonym for the National ID type) under which the National ID is defined"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"PendingInwardReturnRedirectPaymentRcvdViaCoverResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/order/payments/settled/cover/returns/pendings","fullPath":"/api/v1.1.0/order/payments/settled/cover/returns/pendings","operationId":"getInwardReturnRedirectCoverPaymentsPending","name":"Retrieves the list of return transactions originally settled via cover method(redirected) requiring manual action","summary":"Retrieves return transactions settled via cover(redirected)","tags":["OTHERS"],"parameters":[{"name":"clearingTransactionType","in":"query","type":"string","required":false,"description":"Indicates the Clearing transaction type."},{"name":"creditCustomerId","in":"query","type":"string","required":false,"description":"Creditor customer id details"},{"name":"customerOrBankTransfer","in":"query","type":"string","required":false,"description":"Indicates if the payment was initiated by Customer or the financial institution"},{"name":"customerSpecifiedReference","in":"query","type":"string","required":false,"description":"Deprecated - Customer specified reference"},{"name":"debitCustomerId","in":"query","type":"string","required":false,"description":"Debtor customer details"},{"name":"paymentDirection","in":"query","type":"string","required":false,"description":"Indicates the direction of payment i.e. incoming, outgoing, book or redirect"},{"name":"endToEndReference","in":"query","type":"string","required":false,"description":"Indicates the end to end reference for the payment. This field can be provided by the person who instructs the payment and this flows through the lifecycle of the payment."},{"name":"entryDateTime","in":"query","type":"string","required":false,"description":"Contains the payment creation time"},{"name":"fileSendersReference","in":"query","type":"string","required":false,"description":"Indicates the sender reference that comes from the inward payment file"},{"name":"paymentId","in":"query","type":"string","required":false,"description":"Indicates the unique reference number of the payment"},{"name":"incomingMessageType","in":"query","type":"string","required":false,"description":"Indicates the supported message type to be received from the clearing house or the direct participant."},{"name":"company","in":"query","type":"string","required":false,"description":"The company code"},{"name":"processingDate","in":"query","type":"string","required":false,"description":"The date when payment instruction is processed in system."},{"name":"partySendersReferenceIncoming","in":"query","type":"string","required":false,"description":"Debtor payment reference details of incoming"},{"name":"partySendersReferenceOutgoing","in":"query","type":"string","required":false,"description":"Debtor payment reference details of outgoing"},{"name":"statusCode","in":"query","type":"string","required":false,"description":"Status code, as defined by the institution"},{"name":"transactionAmount","in":"query","type":"string","required":false,"description":"Contains the transaction amount. This is based on the currency, either local or foreign currency"},{"name":"transactionCurrency","in":"query","type":"string","required":false,"description":"Indicates the currency of the transaction. For example GBP, USD etc."},{"name":"transactionReference","in":"query","type":"string","required":false,"description":"Contains the identifier for the transaction in the core system"},{"name":"valueDate","in":"query","type":"string","required":false,"description":"Contains the value date of the claim or the date on which the amount to be claimed"},{"name":"paymentSource","in":"query","type":"string","required":false,"description":"Indicates the source from where the payment is originated"},{"name":"channel","in":"query","type":"string","required":false,"description":"Contains the channel in which the activity was performed. If pricing is not determined based on channel, then this is not significant"},{"name":"senderBankBic","in":"query","type":"string","required":false,"description":"Indicates the sending bank BIC Code"},{"name":"receiver","in":"query","type":"string","required":false,"description":"Identifies the receiver of the message"},{"name":"debtorAccountId","in":"query","type":"string","required":false,"description":"Contains the identification assigned by an institution to identify a debtor account by the account owner."},{"name":"beneficiaryAccountId","in":"query","type":"string","required":false,"description":"Unique account identifier of the beneficiary account number."},{"name":"scheme","in":"query","type":"string","required":false,"description":"Represents the scheme (a synonym for the National ID type) under which the National ID is defined"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"InwardReturnRedirectCoverPaymentsPendingResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/order/payments/swift/returns/settlements/pendings","fullPath":"/api/v1.1.0/order/payments/swift/returns/settlements/pendings","operationId":"getPendingReturnReversalInwardSwiftPayments","name":"Retrieves the list of return or reversal SWIFT MT payments that are in repair queue awaiting manual action","summary":"Retrieves returns or reversals of SWIFT MT payments ","tags":["OTHERS"],"parameters":[{"name":"clearingTransactionType","in":"query","type":"string","required":false,"description":"Indicates the Clearing transaction type."},{"name":"creditCustomerId","in":"query","type":"string","required":false,"description":"Creditor customer id details"},{"name":"customerOrBankTransfer","in":"query","type":"string","required":false,"description":"Indicates if the payment was initiated by Customer or the financial institution"},{"name":"customerSpecifiedReference","in":"query","type":"string","required":false,"description":"Deprecated - Customer specified reference"},{"name":"debitCustomerId","in":"query","type":"string","required":false,"description":"Debtor customer details"},{"name":"paymentDirection","in":"query","type":"string","required":false,"description":"Indicates the direction of payment i.e. incoming, outgoing, book or redirect"},{"name":"endToEndReference","in":"query","type":"string","required":false,"description":"Indicates the end to end reference for the payment. This field can be provided by the person who instructs the payment and this flows through the lifecycle of the payment."},{"name":"entryDateTime","in":"query","type":"string","required":false,"description":"Contains the payment creation time"},{"name":"fileSendersReference","in":"query","type":"string","required":false,"description":"Indicates the sender reference that comes from the inward payment file"},{"name":"paymentId","in":"query","type":"string","required":false,"description":"Indicates the unique reference number of the payment"},{"name":"incomingMessageType","in":"query","type":"string","required":false,"description":"Indicates the supported message type to be received from the clearing house or the direct participant."},{"name":"company","in":"query","type":"string","required":false,"description":"The company code"},{"name":"processingDate","in":"query","type":"string","required":false,"description":"The date when payment instruction is processed in system."},{"name":"partySendersReferenceIncoming","in":"query","type":"string","required":false,"description":"Debtor payment reference details of incoming"},{"name":"partySendersReferenceOutgoing","in":"query","type":"string","required":false,"description":"Debtor payment reference details of outgoing"},{"name":"statusCode","in":"query","type":"string","required":false,"description":"Status code, as defined by the institution"},{"name":"transactionAmount","in":"query","type":"string","required":false,"description":"Contains the transaction amount. This is based on the currency, either local or foreign currency"},{"name":"transactionCurrency","in":"query","type":"string","required":false,"description":"Indicates the currency of the transaction. For example GBP, USD etc."},{"name":"transactionReference","in":"query","type":"string","required":false,"description":"Contains the identifier for the transaction in the core system"},{"name":"valueDate","in":"query","type":"string","required":false,"description":"Contains the value date of the claim or the date on which the amount to be claimed"},{"name":"paymentSource","in":"query","type":"string","required":false,"description":"Indicates the source from where the payment is originated"},{"name":"channel","in":"query","type":"string","required":false,"description":"Contains the channel in which the activity was performed. If pricing is not determined based on channel, then this is not significant"},{"name":"senderBankBic","in":"query","type":"string","required":false,"description":"Indicates the sending bank BIC Code"},{"name":"receiver","in":"query","type":"string","required":false,"description":"Identifies the receiver of the message"},{"name":"debtorAccountId","in":"query","type":"string","required":false,"description":"Contains the identification assigned by an institution to identify a debtor account by the account owner."},{"name":"beneficiaryAccountId","in":"query","type":"string","required":false,"description":"Unique account identifier of the beneficiary account number."},{"name":"scheme","in":"query","type":"string","required":false,"description":"Represents the scheme (a synonym for the National ID type) under which the National ID is defined"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"PendingReturnReversalInwardSwiftPaymentsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}}]},{"key":"order-payments-operationalQueueListingReturns-v1.2.0","title":"Operational Queue Listing Returns","version":"v1.2.0","description":"Retrieve the list of return payments that requires manual action","endpointCount":3,"endpoints":[{"method":"GET","path":"/order/payments/cover/redirects/returns/pendings","fullPath":"/api/v1.2.0/order/payments/cover/redirects/returns/pendings","operationId":"getPendingInwardReturnRedirectPaymentRcvdViaCover","name":"Retrieves the list of inward return and redirect payments received via cover awaiting manual action","summary":"Retrieves inward return and redirect payments received via cover","tags":["OTHERS"],"parameters":[{"name":"clearingTransactionType","in":"query","type":"string","required":false,"description":"Indicates the Clearing transaction type."},{"name":"creditCustomerId","in":"query","type":"string","required":false,"description":"Creditor customer id details"},{"name":"customerOrBankTransfer","in":"query","type":"string","required":false,"description":"Indicates if the payment was initiated by Customer or the financial institution"},{"name":"customerSpecifiedReference","in":"query","type":"string","required":false,"description":"Deprecated - Customer specified reference"},{"name":"debitCustomerId","in":"query","type":"string","required":false,"description":"Debtor customer details"},{"name":"paymentDirection","in":"query","type":"string","required":false,"description":"Indicates the direction of payment i.e. incoming, outgoing, book or redirect"},{"name":"endToEndReference","in":"query","type":"string","required":false,"description":"Indicates the end to end reference for the payment. This field can be provided by the person who instructs the payment and this flows through the lifecycle of the payment."},{"name":"entryDateTime","in":"query","type":"string","required":false,"description":"Contains the payment creation time"},{"name":"fileSendersReference","in":"query","type":"string","required":false,"description":"Indicates the sender reference that comes from the inward payment file"},{"name":"paymentId","in":"query","type":"string","required":false,"description":"Indicates the unique reference number of the payment"},{"name":"incomingMessageType","in":"query","type":"string","required":false,"description":"Indicates the supported message type to be received from the clearing house or the direct participant."},{"name":"company","in":"query","type":"string","required":false,"description":"The company code"},{"name":"processingDate","in":"query","type":"string","required":false,"description":"The date when payment instruction is processed in system."},{"name":"partySendersReferenceIncoming","in":"query","type":"string","required":false,"description":"Debtor payment reference details of incoming"},{"name":"partySendersReferenceOutgoing","in":"query","type":"string","required":false,"description":"Debtor payment reference details of outgoing"},{"name":"statusCode","in":"query","type":"string","required":false,"description":"Status code, as defined by the institution"},{"name":"transactionAmount","in":"query","type":"string","required":false,"description":"Contains the transaction amount. This is based on the currency, either local or foreign currency"},{"name":"transactionCurrency","in":"query","type":"string","required":false,"description":"Indicates the currency of the transaction. For example GBP, USD etc."},{"name":"transactionReference","in":"query","type":"string","required":false,"description":"Contains the identifier for the transaction in the core system"},{"name":"valueDate","in":"query","type":"string","required":false,"description":"Contains the value date of the claim or the date on which the amount to be claimed"},{"name":"paymentSource","in":"query","type":"string","required":false,"description":"Indicates the source from where the payment is originated"},{"name":"channel","in":"query","type":"string","required":false,"description":"Contains the channel in which the activity was performed. If pricing is not determined based on channel, then this is not significant"},{"name":"senderBankBic","in":"query","type":"string","required":false,"description":"Indicates the sending bank BIC Code"},{"name":"receiver","in":"query","type":"string","required":false,"description":"Identifies the receiver of the message"},{"name":"debtorAccountId","in":"query","type":"string","required":false,"description":"Contains the identification assigned by an institution to identify a debtor account by the account owner."},{"name":"beneficiaryAccountId","in":"query","type":"string","required":false,"description":"Unique account identifier of the beneficiary account number."},{"name":"scheme","in":"query","type":"string","required":false,"description":"Represents the scheme (a synonym for the National ID type) under which the National ID is defined"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"PendingInwardReturnRedirectPaymentRcvdViaCoverResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/order/payments/settled/cover/returns/pendings","fullPath":"/api/v1.2.0/order/payments/settled/cover/returns/pendings","operationId":"getInwardReturnRedirectCoverPaymentsPending","name":"Retrieves the list of return transactions originally settled via cover method(redirected) requiring manual action","summary":"Retrieves return transactions settled via cover(redirected)","tags":["OTHERS"],"parameters":[{"name":"clearingTransactionType","in":"query","type":"string","required":false,"description":"Indicates the Clearing transaction type."},{"name":"creditCustomerId","in":"query","type":"string","required":false,"description":"Creditor customer id details"},{"name":"customerOrBankTransfer","in":"query","type":"string","required":false,"description":"Indicates if the payment was initiated by Customer or the financial institution"},{"name":"customerSpecifiedReference","in":"query","type":"string","required":false,"description":"Deprecated - Customer specified reference"},{"name":"debitCustomerId","in":"query","type":"string","required":false,"description":"Debtor customer details"},{"name":"paymentDirection","in":"query","type":"string","required":false,"description":"Indicates the direction of payment i.e. incoming, outgoing, book or redirect"},{"name":"endToEndReference","in":"query","type":"string","required":false,"description":"Indicates the end to end reference for the payment. This field can be provided by the person who instructs the payment and this flows through the lifecycle of the payment."},{"name":"entryDateTime","in":"query","type":"string","required":false,"description":"Contains the payment creation time"},{"name":"fileSendersReference","in":"query","type":"string","required":false,"description":"Indicates the sender reference that comes from the inward payment file"},{"name":"paymentId","in":"query","type":"string","required":false,"description":"Indicates the unique reference number of the payment"},{"name":"incomingMessageType","in":"query","type":"string","required":false,"description":"Indicates the supported message type to be received from the clearing house or the direct participant."},{"name":"company","in":"query","type":"string","required":false,"description":"The company code"},{"name":"processingDate","in":"query","type":"string","required":false,"description":"The date when payment instruction is processed in system."},{"name":"partySendersReferenceIncoming","in":"query","type":"string","required":false,"description":"Debtor payment reference details of incoming"},{"name":"partySendersReferenceOutgoing","in":"query","type":"string","required":false,"description":"Debtor payment reference details of outgoing"},{"name":"statusCode","in":"query","type":"string","required":false,"description":"Status code, as defined by the institution"},{"name":"transactionAmount","in":"query","type":"string","required":false,"description":"Contains the transaction amount. This is based on the currency, either local or foreign currency"},{"name":"transactionCurrency","in":"query","type":"string","required":false,"description":"Indicates the currency of the transaction. For example GBP, USD etc."},{"name":"transactionReference","in":"query","type":"string","required":false,"description":"Contains the identifier for the transaction in the core system"},{"name":"valueDate","in":"query","type":"string","required":false,"description":"Contains the value date of the claim or the date on which the amount to be claimed"},{"name":"paymentSource","in":"query","type":"string","required":false,"description":"Indicates the source from where the payment is originated"},{"name":"channel","in":"query","type":"string","required":false,"description":"Contains the channel in which the activity was performed. If pricing is not determined based on channel, then this is not significant"},{"name":"senderBankBic","in":"query","type":"string","required":false,"description":"Indicates the sending bank BIC Code"},{"name":"receiver","in":"query","type":"string","required":false,"description":"Identifies the receiver of the message"},{"name":"debtorAccountId","in":"query","type":"string","required":false,"description":"Contains the identification assigned by an institution to identify a debtor account by the account owner."},{"name":"beneficiaryAccountId","in":"query","type":"string","required":false,"description":"Unique account identifier of the beneficiary account number."},{"name":"scheme","in":"query","type":"string","required":false,"description":"Represents the scheme (a synonym for the National ID type) under which the National ID is defined"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"InwardReturnRedirectCoverPaymentsPendingResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/order/payments/swift/returns/settlements/pendings","fullPath":"/api/v1.2.0/order/payments/swift/returns/settlements/pendings","operationId":"getPendingReturnReversalInwardSwiftPayments","name":"Retrieves the list of return or reversal SWIFT MT payments that are in repair queue awaiting manual action","summary":"Retrieves returns or reversals of SWIFT MT payments ","tags":["OTHERS"],"parameters":[{"name":"clearingTransactionType","in":"query","type":"string","required":false,"description":"Indicates the Clearing transaction type."},{"name":"creditCustomerId","in":"query","type":"string","required":false,"description":"Creditor customer id details"},{"name":"customerOrBankTransfer","in":"query","type":"string","required":false,"description":"Indicates if the payment was initiated by Customer or the financial institution"},{"name":"customerSpecifiedReference","in":"query","type":"string","required":false,"description":"Deprecated - Customer specified reference"},{"name":"debitCustomerId","in":"query","type":"string","required":false,"description":"Debtor customer details"},{"name":"paymentDirection","in":"query","type":"string","required":false,"description":"Indicates the direction of payment i.e. incoming, outgoing, book or redirect"},{"name":"endToEndReference","in":"query","type":"string","required":false,"description":"Indicates the end to end reference for the payment. This field can be provided by the person who instructs the payment and this flows through the lifecycle of the payment."},{"name":"entryDateTime","in":"query","type":"string","required":false,"description":"Contains the payment creation time"},{"name":"fileSendersReference","in":"query","type":"string","required":false,"description":"Indicates the sender reference that comes from the inward payment file"},{"name":"paymentId","in":"query","type":"string","required":false,"description":"Indicates the unique reference number of the payment"},{"name":"incomingMessageType","in":"query","type":"string","required":false,"description":"Indicates the supported message type to be received from the clearing house or the direct participant."},{"name":"company","in":"query","type":"string","required":false,"description":"The company code"},{"name":"processingDate","in":"query","type":"string","required":false,"description":"The date when payment instruction is processed in system."},{"name":"partySendersReferenceIncoming","in":"query","type":"string","required":false,"description":"Debtor payment reference details of incoming"},{"name":"partySendersReferenceOutgoing","in":"query","type":"string","required":false,"description":"Debtor payment reference details of outgoing"},{"name":"statusCode","in":"query","type":"string","required":false,"description":"Status code, as defined by the institution"},{"name":"transactionAmount","in":"query","type":"string","required":false,"description":"Contains the transaction amount. This is based on the currency, either local or foreign currency"},{"name":"transactionCurrency","in":"query","type":"string","required":false,"description":"Indicates the currency of the transaction. For example GBP, USD etc."},{"name":"transactionReference","in":"query","type":"string","required":false,"description":"Contains the identifier for the transaction in the core system"},{"name":"valueDate","in":"query","type":"string","required":false,"description":"Contains the value date of the claim or the date on which the amount to be claimed"},{"name":"paymentSource","in":"query","type":"string","required":false,"description":"Indicates the source from where the payment is originated"},{"name":"channel","in":"query","type":"string","required":false,"description":"Contains the channel in which the activity was performed. If pricing is not determined based on channel, then this is not significant"},{"name":"senderBankBic","in":"query","type":"string","required":false,"description":"Indicates the sending bank BIC Code"},{"name":"receiver","in":"query","type":"string","required":false,"description":"Identifies the receiver of the message"},{"name":"debtorAccountId","in":"query","type":"string","required":false,"description":"Contains the identification assigned by an institution to identify a debtor account by the account owner."},{"name":"beneficiaryAccountId","in":"query","type":"string","required":false,"description":"Unique account identifier of the beneficiary account number."},{"name":"scheme","in":"query","type":"string","required":false,"description":"Represents the scheme (a synonym for the National ID type) under which the National ID is defined"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"PendingReturnReversalInwardSwiftPaymentsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}}]},{"key":"order-payments-operationalQueueListingWarehouse-v1.0.0","title":"Operational Queue Listing Warehouse","version":"v1.0.0","description":"Retrieve the list of payments that are available in ware house and parked payments queue","endpointCount":4,"endpoints":[{"method":"GET","path":"/order/payments/technicalExceptions/pendings","fullPath":"/api/v1.0.0/order/payments/technicalExceptions/pendings","operationId":"getParkedPaymentsPendingRelease","name":"Retrieves the list of parked payments awaiting manual action","summary":"Retrieves parked payments ","tags":["OTHERS"],"parameters":[{"name":"clearingTransactionType","in":"query","type":"string","required":false,"description":"Indicates the Clearing transaction type."},{"name":"creditCustomerId","in":"query","type":"string","required":false,"description":"Creditor customer id details"},{"name":"customerOrBankTransfer","in":"query","type":"string","required":false,"description":"Indicates if the payment was initiated by Customer or the financial institution"},{"name":"customerSpecifiedReference","in":"query","type":"string","required":false,"description":"Deprecated - Customer specified reference"},{"name":"debitCustomerId","in":"query","type":"string","required":false,"description":"Debtor customer details"},{"name":"paymentDirection","in":"query","type":"string","required":false,"description":"Indicates the direction of payment i.e. incoming, outgoing, book or redirect"},{"name":"endToEndReference","in":"query","type":"string","required":false,"description":"Indicates the end to end reference for the payment. This field can be provided by the person who instructs the payment and this flows through the lifecycle of the payment."},{"name":"entryDateTime","in":"query","type":"string","required":false,"description":"Contains the payment creation time"},{"name":"fileSendersReference","in":"query","type":"string","required":false,"description":"Indicates the sender reference that comes from the inward payment file"},{"name":"paymentId","in":"query","type":"string","required":false,"description":"Indicates the unique reference number of the payment"},{"name":"incomingMessageType","in":"query","type":"string","required":false,"description":"Indicates the supported message type to be received from the clearing house or the direct participant."},{"name":"company","in":"query","type":"string","required":false,"description":"The company code"},{"name":"processingDate","in":"query","type":"string","required":false,"description":"The date when payment instruction is processed in system."},{"name":"partySendersReferenceIncoming","in":"query","type":"string","required":false,"description":"Debtor payment reference details of incoming"},{"name":"partySendersReferenceOutgoing","in":"query","type":"string","required":false,"description":"Debtor payment reference details of outgoing"},{"name":"statusCode","in":"query","type":"string","required":false,"description":"Status code, as defined by the institution"},{"name":"transactionAmount","in":"query","type":"string","required":false,"description":"Contains the transaction amount. This is based on the currency, either local or foreign currency"},{"name":"transactionCurrency","in":"query","type":"string","required":false,"description":"Indicates the currency of the transaction. For example GBP, USD etc."},{"name":"transactionReference","in":"query","type":"string","required":false,"description":"Contains the identifier for the transaction in the core system"},{"name":"valueDate","in":"query","type":"string","required":false,"description":"Contains the value date of the claim or the date on which the amount to be claimed"},{"name":"paymentSource","in":"query","type":"string","required":false,"description":"Indicates the source from where the payment is originated"},{"name":"channel","in":"query","type":"string","required":false,"description":"Contains the channel in which the activity was performed. If pricing is not determined based on channel, then this is not significant"},{"name":"senderBankBic","in":"query","type":"string","required":false,"description":"Indicates the sending bank BIC Code"},{"name":"receiver","in":"query","type":"string","required":false,"description":"Identifies the receiver of the message"},{"name":"debtorAccountId","in":"query","type":"string","required":false,"description":"Contains the identification assigned by an institution to identify a debtor account by the account owner."},{"name":"beneficiaryAccountId","in":"query","type":"string","required":false,"description":"Unique account identifier of the beneficiary account number."},{"name":"scheme","in":"query","type":"string","required":false,"description":"Represents the scheme (a synonym for the National ID type) under which the National ID is defined"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"ParkedPaymentsPendingReleaseResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/order/payments/parent/technicalExceptions/pendings","fullPath":"/api/v1.0.0/order/payments/parent/technicalExceptions/pendings","operationId":"getParentParkedPaymentsPendingRelease","name":"Retrieves the list of parent parked payments awaiting manual action","summary":"Retrieves parent parked payments","tags":["OTHERS"],"parameters":[{"name":"clearingTransactionType","in":"query","type":"string","required":false,"description":"Indicates the Clearing transaction type."},{"name":"creditCustomerId","in":"query","type":"string","required":false,"description":"Creditor customer id details"},{"name":"customerOrBankTransfer","in":"query","type":"string","required":false,"description":"Indicates if the payment was initiated by Customer or the financial institution"},{"name":"customerSpecifiedReference","in":"query","type":"string","required":false,"description":"Deprecated - Customer specified reference"},{"name":"debitCustomerId","in":"query","type":"string","required":false,"description":"Debtor customer details"},{"name":"paymentDirection","in":"query","type":"string","required":false,"description":"Indicates the direction of payment i.e. incoming, outgoing, book or redirect"},{"name":"endToEndReference","in":"query","type":"string","required":false,"description":"Indicates the end to end reference for the payment. This field can be provided by the person who instructs the payment and this flows through the lifecycle of the payment."},{"name":"entryDateTime","in":"query","type":"string","required":false,"description":"Contains the payment creation time"},{"name":"fileSendersReference","in":"query","type":"string","required":false,"description":"Indicates the sender reference that comes from the inward payment file"},{"name":"paymentId","in":"query","type":"string","required":false,"description":"Indicates the unique reference number of the payment"},{"name":"incomingMessageType","in":"query","type":"string","required":false,"description":"Indicates the supported message type to be received from the clearing house or the direct participant."},{"name":"company","in":"query","type":"string","required":false,"description":"The company code"},{"name":"processingDate","in":"query","type":"string","required":false,"description":"The date when payment instruction is processed in system."},{"name":"partySendersReferenceIncoming","in":"query","type":"string","required":false,"description":"Debtor payment reference details of incoming"},{"name":"partySendersReferenceOutgoing","in":"query","type":"string","required":false,"description":"Debtor payment reference details of outgoing"},{"name":"statusCode","in":"query","type":"string","required":false,"description":"Status code, as defined by the institution"},{"name":"transactionAmount","in":"query","type":"string","required":false,"description":"Contains the transaction amount. This is based on the currency, either local or foreign currency"},{"name":"transactionCurrency","in":"query","type":"string","required":false,"description":"Indicates the currency of the transaction. For example GBP, USD etc."},{"name":"transactionReference","in":"query","type":"string","required":false,"description":"Contains the identifier for the transaction in the core system"},{"name":"valueDate","in":"query","type":"string","required":false,"description":"Contains the value date of the claim or the date on which the amount to be claimed"},{"name":"paymentSource","in":"query","type":"string","required":false,"description":"Indicates the source from where the payment is originated"},{"name":"channel","in":"query","type":"string","required":false,"description":"Contains the channel in which the activity was performed. If pricing is not determined based on channel, then this is not significant"},{"name":"senderBankBic","in":"query","type":"string","required":false,"description":"Indicates the sending bank BIC Code"},{"name":"receiver","in":"query","type":"string","required":false,"description":"Identifies the receiver of the message"},{"name":"debtorAccountId","in":"query","type":"string","required":false,"description":"Contains the identification assigned by an institution to identify a debtor account by the account owner."},{"name":"beneficiaryAccountId","in":"query","type":"string","required":false,"description":"Unique account identifier of the beneficiary account number."},{"name":"scheme","in":"query","type":"string","required":false,"description":"Represents the scheme (a synonym for the National ID type) under which the National ID is defined"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"ParentParkedPaymentsPendingReleaseResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/order/payments/scheduledPayments/pendings","fullPath":"/api/v1.0.0/order/payments/scheduledPayments/pendings","operationId":"getPaymentsScheduledForRelease","name":"Retrieves the list of payments in the scheduled release queue awaiting manual action","summary":"Retrieves payments scheduled for release","tags":["OTHERS"],"parameters":[{"name":"clearingTransactionType","in":"query","type":"string","required":false,"description":"Indicates the Clearing transaction type."},{"name":"creditCustomerId","in":"query","type":"string","required":false,"description":"Creditor customer id details"},{"name":"customerOrBankTransfer","in":"query","type":"string","required":false,"description":"Indicates if the payment was initiated by Customer or the financial institution"},{"name":"customerSpecifiedReference","in":"query","type":"string","required":false,"description":"Deprecated - Customer specified reference"},{"name":"debitCustomerId","in":"query","type":"string","required":false,"description":"Debtor customer details"},{"name":"paymentDirection","in":"query","type":"string","required":false,"description":"Indicates the direction of payment i.e. incoming, outgoing, book or redirect"},{"name":"endToEndReference","in":"query","type":"string","required":false,"description":"Indicates the end to end reference for the payment. This field can be provided by the person who instructs the payment and this flows through the lifecycle of the payment."},{"name":"entryDateTime","in":"query","type":"string","required":false,"description":"Contains the payment creation time"},{"name":"fileSendersReference","in":"query","type":"string","required":false,"description":"Indicates the sender reference that comes from the inward payment file"},{"name":"paymentId","in":"query","type":"string","required":false,"description":"Indicates the unique reference number of the payment"},{"name":"incomingMessageType","in":"query","type":"string","required":false,"description":"Indicates the supported message type to be received from the clearing house or the direct participant."},{"name":"company","in":"query","type":"string","required":false,"description":"The company code"},{"name":"processingDate","in":"query","type":"string","required":false,"description":"The date when payment instruction is processed in system."},{"name":"partySendersReferenceIncoming","in":"query","type":"string","required":false,"description":"Debtor payment reference details of incoming"},{"name":"partySendersReferenceOutgoing","in":"query","type":"string","required":false,"description":"Debtor payment reference details of outgoing"},{"name":"statusCode","in":"query","type":"string","required":false,"description":"Status code, as defined by the institution"},{"name":"transactionAmount","in":"query","type":"string","required":false,"description":"Contains the transaction amount. This is based on the currency, either local or foreign currency"},{"name":"transactionCurrency","in":"query","type":"string","required":false,"description":"Indicates the currency of the transaction. For example GBP, USD etc."},{"name":"transactionReference","in":"query","type":"string","required":false,"description":"Contains the identifier for the transaction in the core system"},{"name":"valueDate","in":"query","type":"string","required":false,"description":"Contains the value date of the claim or the date on which the amount to be claimed"},{"name":"paymentSource","in":"query","type":"string","required":false,"description":"Indicates the source from where the payment is originated"},{"name":"channel","in":"query","type":"string","required":false,"description":"Contains the channel in which the activity was performed. If pricing is not determined based on channel, then this is not significant"},{"name":"senderBankBic","in":"query","type":"string","required":false,"description":"Indicates the sending bank BIC Code"},{"name":"receiver","in":"query","type":"string","required":false,"description":"Identifies the receiver of the message"},{"name":"debtorAccountId","in":"query","type":"string","required":false,"description":"Contains the identification assigned by an institution to identify a debtor account by the account owner."},{"name":"beneficiaryAccountId","in":"query","type":"string","required":false,"description":"Unique account identifier of the beneficiary account number."},{"name":"scheme","in":"query","type":"string","required":false,"description":"Represents the scheme (a synonym for the National ID type) under which the National ID is defined"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"PaymentsScheduledForReleaseResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/order/payments/futureDatedPayments/pendings","fullPath":"/api/v1.0.0/order/payments/futureDatedPayments/pendings","operationId":"getFuturedDatedPaymentsInWarehouse","name":"Retrieves the list of future dated payments in warehouse, that can be released, modified or cancelled ","summary":"Retrieves future dated payments","tags":["OTHERS"],"parameters":[{"name":"clearingTransactionType","in":"query","type":"string","required":false,"description":"Indicates the Clearing transaction type."},{"name":"creditCustomerId","in":"query","type":"string","required":false,"description":"Creditor customer id details"},{"name":"customerOrBankTransfer","in":"query","type":"string","required":false,"description":"Indicates if the payment was initiated by Customer or the financial institution"},{"name":"customerSpecifiedReference","in":"query","type":"string","required":false,"description":"Deprecated - Customer specified reference"},{"name":"debitCustomerId","in":"query","type":"string","required":false,"description":"Debtor customer details"},{"name":"paymentDirection","in":"query","type":"string","required":false,"description":"Indicates the direction of payment i.e. incoming, outgoing, book or redirect"},{"name":"endToEndReference","in":"query","type":"string","required":false,"description":"Indicates the end to end reference for the payment. This field can be provided by the person who instructs the payment and this flows through the lifecycle of the payment."},{"name":"entryDateTime","in":"query","type":"string","required":false,"description":"Contains the payment creation time"},{"name":"fileSendersReference","in":"query","type":"string","required":false,"description":"Indicates the sender reference that comes from the inward payment file"},{"name":"paymentId","in":"query","type":"string","required":false,"description":"Indicates the unique reference number of the payment"},{"name":"paymentOrderId","in":"query","type":"string","required":false,"description":"The unique reference number of payment"},{"name":"incomingMessageType","in":"query","type":"string","required":false,"description":"Indicates the supported message type to be received from the clearing house or the direct participant."},{"name":"company","in":"query","type":"string","required":false,"description":"The company code"},{"name":"processingDate","in":"query","type":"string","required":false,"description":"The date when payment instruction is processed in system."},{"name":"partySendersReferenceIncoming","in":"query","type":"string","required":false,"description":"Debtor payment reference details of incoming"},{"name":"partySendersReferenceOutgoing","in":"query","type":"string","required":false,"description":"Debtor payment reference details of outgoing"},{"name":"statusCode","in":"query","type":"string","required":false,"description":"Status code, as defined by the institution"},{"name":"transactionAmount","in":"query","type":"string","required":false,"description":"Contains the transaction amount. This is based on the currency, either local or foreign currency"},{"name":"transactionCurrency","in":"query","type":"string","required":false,"description":"Indicates the currency of the transaction. For example GBP, USD etc."},{"name":"transactionReference","in":"query","type":"string","required":false,"description":"Contains the identifier for the transaction in the core system"},{"name":"valueDate","in":"query","type":"string","required":false,"description":"Contains the value date of the claim or the date on which the amount to be claimed"},{"name":"paymentSource","in":"query","type":"string","required":false,"description":"Indicates the source from where the payment is originated"},{"name":"channel","in":"query","type":"string","required":false,"description":"Contains the channel in which the activity was performed. If pricing is not determined based on channel, then this is not significant"},{"name":"senderBankBic","in":"query","type":"string","required":false,"description":"Indicates the sending bank BIC Code"},{"name":"receiver","in":"query","type":"string","required":false,"description":"Identifies the receiver of the message"},{"name":"debtorAccountId","in":"query","type":"string","required":false,"description":"Contains the identification assigned by an institution to identify a debtor account by the account owner."},{"name":"beneficiaryAccountId","in":"query","type":"string","required":false,"description":"Unique account identifier of the beneficiary account number."},{"name":"scheme","in":"query","type":"string","required":false,"description":"Represents the scheme (a synonym for the National ID type) under which the National ID is defined"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"FuturedDatedPaymentsInWarehouseResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}}]},{"key":"order-payments-operationalQueueListingWarehouse-v1.1.0","title":"Operational Queue Listing Warehouse","version":"v1.1.0","description":"Retrieve the list of payments that are available in ware house and parked payments queue","endpointCount":4,"endpoints":[{"method":"GET","path":"/order/payments/technicalExceptions/pendings","fullPath":"/api/v1.1.0/order/payments/technicalExceptions/pendings","operationId":"getParkedPaymentsPendingRelease","name":"Retrieves the list of parked payments awaiting manual action","summary":"Retrieves parked payments ","tags":["OTHERS"],"parameters":[{"name":"clearingTransactionType","in":"query","type":"string","required":false,"description":"Indicates the Clearing transaction type."},{"name":"creditCustomerId","in":"query","type":"string","required":false,"description":"Creditor customer id details"},{"name":"customerOrBankTransfer","in":"query","type":"string","required":false,"description":"Indicates if the payment was initiated by Customer or the financial institution"},{"name":"customerSpecifiedReference","in":"query","type":"string","required":false,"description":"Deprecated - Customer specified reference"},{"name":"debitCustomerId","in":"query","type":"string","required":false,"description":"Debtor customer details"},{"name":"paymentDirection","in":"query","type":"string","required":false,"description":"Indicates the direction of payment i.e. incoming, outgoing, book or redirect"},{"name":"endToEndReference","in":"query","type":"string","required":false,"description":"Indicates the end to end reference for the payment. This field can be provided by the person who instructs the payment and this flows through the lifecycle of the payment."},{"name":"entryDateTime","in":"query","type":"string","required":false,"description":"Contains the payment creation time"},{"name":"fileSendersReference","in":"query","type":"string","required":false,"description":"Indicates the sender reference that comes from the inward payment file"},{"name":"paymentId","in":"query","type":"string","required":false,"description":"Indicates the unique reference number of the payment"},{"name":"incomingMessageType","in":"query","type":"string","required":false,"description":"Indicates the supported message type to be received from the clearing house or the direct participant."},{"name":"company","in":"query","type":"string","required":false,"description":"The company code"},{"name":"processingDate","in":"query","type":"string","required":false,"description":"The date when payment instruction is processed in system."},{"name":"partySendersReferenceIncoming","in":"query","type":"string","required":false,"description":"Debtor payment reference details of incoming"},{"name":"partySendersReferenceOutgoing","in":"query","type":"string","required":false,"description":"Debtor payment reference details of outgoing"},{"name":"statusCode","in":"query","type":"string","required":false,"description":"Status code, as defined by the institution"},{"name":"transactionAmount","in":"query","type":"string","required":false,"description":"Contains the transaction amount. This is based on the currency, either local or foreign currency"},{"name":"transactionCurrency","in":"query","type":"string","required":false,"description":"Indicates the currency of the transaction. For example GBP, USD etc."},{"name":"transactionReference","in":"query","type":"string","required":false,"description":"Contains the identifier for the transaction in the core system"},{"name":"valueDate","in":"query","type":"string","required":false,"description":"Contains the value date of the claim or the date on which the amount to be claimed"},{"name":"paymentSource","in":"query","type":"string","required":false,"description":"Indicates the source from where the payment is originated"},{"name":"channel","in":"query","type":"string","required":false,"description":"Contains the channel in which the activity was performed. If pricing is not determined based on channel, then this is not significant"},{"name":"senderBankBic","in":"query","type":"string","required":false,"description":"Indicates the sending bank BIC Code"},{"name":"receiver","in":"query","type":"string","required":false,"description":"Identifies the receiver of the message"},{"name":"debtorAccountId","in":"query","type":"string","required":false,"description":"Contains the identification assigned by an institution to identify a debtor account by the account owner."},{"name":"beneficiaryAccountId","in":"query","type":"string","required":false,"description":"Unique account identifier of the beneficiary account number."},{"name":"scheme","in":"query","type":"string","required":false,"description":"Represents the scheme (a synonym for the National ID type) under which the National ID is defined"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"ParkedPaymentsPendingReleaseResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/order/payments/parent/technicalExceptions/pendings","fullPath":"/api/v1.1.0/order/payments/parent/technicalExceptions/pendings","operationId":"getParentParkedPaymentsPendingRelease","name":"Retrieves the list of parent parked payments awaiting manual action","summary":"Retrieves parent parked payments","tags":["OTHERS"],"parameters":[{"name":"clearingTransactionType","in":"query","type":"string","required":false,"description":"Indicates the Clearing transaction type."},{"name":"creditCustomerId","in":"query","type":"string","required":false,"description":"Creditor customer id details"},{"name":"customerOrBankTransfer","in":"query","type":"string","required":false,"description":"Indicates if the payment was initiated by Customer or the financial institution"},{"name":"customerSpecifiedReference","in":"query","type":"string","required":false,"description":"Deprecated - Customer specified reference"},{"name":"debitCustomerId","in":"query","type":"string","required":false,"description":"Debtor customer details"},{"name":"paymentDirection","in":"query","type":"string","required":false,"description":"Indicates the direction of payment i.e. incoming, outgoing, book or redirect"},{"name":"endToEndReference","in":"query","type":"string","required":false,"description":"Indicates the end to end reference for the payment. This field can be provided by the person who instructs the payment and this flows through the lifecycle of the payment."},{"name":"entryDateTime","in":"query","type":"string","required":false,"description":"Contains the payment creation time"},{"name":"fileSendersReference","in":"query","type":"string","required":false,"description":"Indicates the sender reference that comes from the inward payment file"},{"name":"paymentId","in":"query","type":"string","required":false,"description":"Indicates the unique reference number of the payment"},{"name":"incomingMessageType","in":"query","type":"string","required":false,"description":"Indicates the supported message type to be received from the clearing house or the direct participant."},{"name":"company","in":"query","type":"string","required":false,"description":"The company code"},{"name":"processingDate","in":"query","type":"string","required":false,"description":"The date when payment instruction is processed in system."},{"name":"partySendersReferenceIncoming","in":"query","type":"string","required":false,"description":"Debtor payment reference details of incoming"},{"name":"partySendersReferenceOutgoing","in":"query","type":"string","required":false,"description":"Debtor payment reference details of outgoing"},{"name":"statusCode","in":"query","type":"string","required":false,"description":"Status code, as defined by the institution"},{"name":"transactionAmount","in":"query","type":"string","required":false,"description":"Contains the transaction amount. This is based on the currency, either local or foreign currency"},{"name":"transactionCurrency","in":"query","type":"string","required":false,"description":"Indicates the currency of the transaction. For example GBP, USD etc."},{"name":"transactionReference","in":"query","type":"string","required":false,"description":"Contains the identifier for the transaction in the core system"},{"name":"valueDate","in":"query","type":"string","required":false,"description":"Contains the value date of the claim or the date on which the amount to be claimed"},{"name":"paymentSource","in":"query","type":"string","required":false,"description":"Indicates the source from where the payment is originated"},{"name":"channel","in":"query","type":"string","required":false,"description":"Contains the channel in which the activity was performed. If pricing is not determined based on channel, then this is not significant"},{"name":"senderBankBic","in":"query","type":"string","required":false,"description":"Indicates the sending bank BIC Code"},{"name":"receiver","in":"query","type":"string","required":false,"description":"Identifies the receiver of the message"},{"name":"debtorAccountId","in":"query","type":"string","required":false,"description":"Contains the identification assigned by an institution to identify a debtor account by the account owner."},{"name":"beneficiaryAccountId","in":"query","type":"string","required":false,"description":"Unique account identifier of the beneficiary account number."},{"name":"scheme","in":"query","type":"string","required":false,"description":"Represents the scheme (a synonym for the National ID type) under which the National ID is defined"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"ParentParkedPaymentsPendingReleaseResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/order/payments/scheduledPayments/pendings","fullPath":"/api/v1.1.0/order/payments/scheduledPayments/pendings","operationId":"getPaymentsScheduledForRelease","name":"Retrieves the list of payments in the scheduled release queue awaiting manual action","summary":"Retrieves payments scheduled for release","tags":["OTHERS"],"parameters":[{"name":"clearingTransactionType","in":"query","type":"string","required":false,"description":"Indicates the Clearing transaction type."},{"name":"creditCustomerId","in":"query","type":"string","required":false,"description":"Creditor customer id details"},{"name":"customerOrBankTransfer","in":"query","type":"string","required":false,"description":"Indicates if the payment was initiated by Customer or the financial institution"},{"name":"customerSpecifiedReference","in":"query","type":"string","required":false,"description":"Deprecated - Customer specified reference"},{"name":"debitCustomerId","in":"query","type":"string","required":false,"description":"Debtor customer details"},{"name":"paymentDirection","in":"query","type":"string","required":false,"description":"Indicates the direction of payment i.e. incoming, outgoing, book or redirect"},{"name":"endToEndReference","in":"query","type":"string","required":false,"description":"Indicates the end to end reference for the payment. This field can be provided by the person who instructs the payment and this flows through the lifecycle of the payment."},{"name":"entryDateTime","in":"query","type":"string","required":false,"description":"Contains the payment creation time"},{"name":"fileSendersReference","in":"query","type":"string","required":false,"description":"Indicates the sender reference that comes from the inward payment file"},{"name":"paymentId","in":"query","type":"string","required":false,"description":"Indicates the unique reference number of the payment"},{"name":"incomingMessageType","in":"query","type":"string","required":false,"description":"Indicates the supported message type to be received from the clearing house or the direct participant."},{"name":"company","in":"query","type":"string","required":false,"description":"The company code"},{"name":"processingDate","in":"query","type":"string","required":false,"description":"The date when payment instruction is processed in system."},{"name":"partySendersReferenceIncoming","in":"query","type":"string","required":false,"description":"Debtor payment reference details of incoming"},{"name":"partySendersReferenceOutgoing","in":"query","type":"string","required":false,"description":"Debtor payment reference details of outgoing"},{"name":"statusCode","in":"query","type":"string","required":false,"description":"Status code, as defined by the institution"},{"name":"transactionAmount","in":"query","type":"string","required":false,"description":"Contains the transaction amount. This is based on the currency, either local or foreign currency"},{"name":"transactionCurrency","in":"query","type":"string","required":false,"description":"Indicates the currency of the transaction. For example GBP, USD etc."},{"name":"transactionReference","in":"query","type":"string","required":false,"description":"Contains the identifier for the transaction in the core system"},{"name":"valueDate","in":"query","type":"string","required":false,"description":"Contains the value date of the claim or the date on which the amount to be claimed"},{"name":"paymentSource","in":"query","type":"string","required":false,"description":"Indicates the source from where the payment is originated"},{"name":"channel","in":"query","type":"string","required":false,"description":"Contains the channel in which the activity was performed. If pricing is not determined based on channel, then this is not significant"},{"name":"senderBankBic","in":"query","type":"string","required":false,"description":"Indicates the sending bank BIC Code"},{"name":"receiver","in":"query","type":"string","required":false,"description":"Identifies the receiver of the message"},{"name":"debtorAccountId","in":"query","type":"string","required":false,"description":"Contains the identification assigned by an institution to identify a debtor account by the account owner."},{"name":"beneficiaryAccountId","in":"query","type":"string","required":false,"description":"Unique account identifier of the beneficiary account number."},{"name":"scheme","in":"query","type":"string","required":false,"description":"Represents the scheme (a synonym for the National ID type) under which the National ID is defined"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"PaymentsScheduledForReleaseResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/order/payments/futureDatedPayments/pendings","fullPath":"/api/v1.1.0/order/payments/futureDatedPayments/pendings","operationId":"getFuturedDatedPaymentsInWarehouse","name":"Retrieves the list of future dated payments in warehouse, that can be released, modified or cancelled ","summary":"Retrieves future dated payments","tags":["OTHERS"],"parameters":[{"name":"clearingTransactionType","in":"query","type":"string","required":false,"description":"Indicates the Clearing transaction type."},{"name":"creditCustomerId","in":"query","type":"string","required":false,"description":"Creditor customer id details"},{"name":"customerOrBankTransfer","in":"query","type":"string","required":false,"description":"Indicates if the payment was initiated by Customer or the financial institution"},{"name":"customerSpecifiedReference","in":"query","type":"string","required":false,"description":"Deprecated - Customer specified reference"},{"name":"debitCustomerId","in":"query","type":"string","required":false,"description":"Debtor customer details"},{"name":"paymentDirection","in":"query","type":"string","required":false,"description":"Indicates the direction of payment i.e. incoming, outgoing, book or redirect"},{"name":"endToEndReference","in":"query","type":"string","required":false,"description":"Indicates the end to end reference for the payment. This field can be provided by the person who instructs the payment and this flows through the lifecycle of the payment."},{"name":"entryDateTime","in":"query","type":"string","required":false,"description":"Contains the payment creation time"},{"name":"fileSendersReference","in":"query","type":"string","required":false,"description":"Indicates the sender reference that comes from the inward payment file"},{"name":"paymentId","in":"query","type":"string","required":false,"description":"Indicates the unique reference number of the payment"},{"name":"paymentOrderId","in":"query","type":"string","required":false,"description":"The unique reference number of payment"},{"name":"incomingMessageType","in":"query","type":"string","required":false,"description":"Indicates the supported message type to be received from the clearing house or the direct participant."},{"name":"company","in":"query","type":"string","required":false,"description":"The company code"},{"name":"processingDate","in":"query","type":"string","required":false,"description":"The date when payment instruction is processed in system."},{"name":"partySendersReferenceIncoming","in":"query","type":"string","required":false,"description":"Debtor payment reference details of incoming"},{"name":"partySendersReferenceOutgoing","in":"query","type":"string","required":false,"description":"Debtor payment reference details of outgoing"},{"name":"statusCode","in":"query","type":"string","required":false,"description":"Status code, as defined by the institution"},{"name":"transactionAmount","in":"query","type":"string","required":false,"description":"Contains the transaction amount. This is based on the currency, either local or foreign currency"},{"name":"transactionCurrency","in":"query","type":"string","required":false,"description":"Indicates the currency of the transaction. For example GBP, USD etc."},{"name":"transactionReference","in":"query","type":"string","required":false,"description":"Contains the identifier for the transaction in the core system"},{"name":"valueDate","in":"query","type":"string","required":false,"description":"Contains the value date of the claim or the date on which the amount to be claimed"},{"name":"paymentSource","in":"query","type":"string","required":false,"description":"Indicates the source from where the payment is originated"},{"name":"channel","in":"query","type":"string","required":false,"description":"Contains the channel in which the activity was performed. If pricing is not determined based on channel, then this is not significant"},{"name":"senderBankBic","in":"query","type":"string","required":false,"description":"Indicates the sending bank BIC Code"},{"name":"receiver","in":"query","type":"string","required":false,"description":"Identifies the receiver of the message"},{"name":"debtorAccountId","in":"query","type":"string","required":false,"description":"Contains the identification assigned by an institution to identify a debtor account by the account owner."},{"name":"beneficiaryAccountId","in":"query","type":"string","required":false,"description":"Unique account identifier of the beneficiary account number."},{"name":"scheme","in":"query","type":"string","required":false,"description":"Represents the scheme (a synonym for the National ID type) under which the National ID is defined"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"FuturedDatedPaymentsInWarehouseResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}}]},{"key":"order-payments-operationalQueueListingWarehouse-v1.2.0","title":"Operational Queue Listing Warehouse","version":"v1.2.0","description":"Retrieve the list of payments that are available in ware house and parked payments queue","endpointCount":4,"endpoints":[{"method":"GET","path":"/order/payments/technicalExceptions/pendings","fullPath":"/api/v1.2.0/order/payments/technicalExceptions/pendings","operationId":"getParkedPaymentsPendingRelease","name":"Retrieves the list of parked payments awaiting manual action","summary":"Retrieves parked payments ","tags":["OTHERS"],"parameters":[{"name":"clearingTransactionType","in":"query","type":"string","required":false,"description":"Indicates the Clearing transaction type."},{"name":"creditCustomerId","in":"query","type":"string","required":false,"description":"Creditor customer id details"},{"name":"customerOrBankTransfer","in":"query","type":"string","required":false,"description":"Indicates if the payment was initiated by Customer or the financial institution"},{"name":"customerSpecifiedReference","in":"query","type":"string","required":false,"description":"Deprecated - Customer specified reference"},{"name":"debitCustomerId","in":"query","type":"string","required":false,"description":"Debtor customer details"},{"name":"paymentDirection","in":"query","type":"string","required":false,"description":"Indicates the direction of payment i.e. incoming, outgoing, book or redirect"},{"name":"endToEndReference","in":"query","type":"string","required":false,"description":"Indicates the end to end reference for the payment. This field can be provided by the person who instructs the payment and this flows through the lifecycle of the payment."},{"name":"entryDateTime","in":"query","type":"string","required":false,"description":"Contains the payment creation time"},{"name":"fileSendersReference","in":"query","type":"string","required":false,"description":"Indicates the sender reference that comes from the inward payment file"},{"name":"paymentId","in":"query","type":"string","required":false,"description":"Indicates the unique reference number of the payment"},{"name":"incomingMessageType","in":"query","type":"string","required":false,"description":"Indicates the supported message type to be received from the clearing house or the direct participant."},{"name":"company","in":"query","type":"string","required":false,"description":"The company code"},{"name":"processingDate","in":"query","type":"string","required":false,"description":"The date when payment instruction is processed in system."},{"name":"partySendersReferenceIncoming","in":"query","type":"string","required":false,"description":"Debtor payment reference details of incoming"},{"name":"partySendersReferenceOutgoing","in":"query","type":"string","required":false,"description":"Debtor payment reference details of outgoing"},{"name":"statusCode","in":"query","type":"string","required":false,"description":"Status code, as defined by the institution"},{"name":"transactionAmount","in":"query","type":"string","required":false,"description":"Contains the transaction amount. This is based on the currency, either local or foreign currency"},{"name":"transactionCurrency","in":"query","type":"string","required":false,"description":"Indicates the currency of the transaction. For example GBP, USD etc."},{"name":"transactionReference","in":"query","type":"string","required":false,"description":"Contains the identifier for the transaction in the core system"},{"name":"valueDate","in":"query","type":"string","required":false,"description":"Contains the value date of the claim or the date on which the amount to be claimed"},{"name":"paymentSource","in":"query","type":"string","required":false,"description":"Indicates the source from where the payment is originated"},{"name":"channel","in":"query","type":"string","required":false,"description":"Contains the channel in which the activity was performed. If pricing is not determined based on channel, then this is not significant"},{"name":"senderBankBic","in":"query","type":"string","required":false,"description":"Indicates the sending bank BIC Code"},{"name":"receiver","in":"query","type":"string","required":false,"description":"Identifies the receiver of the message"},{"name":"debtorAccountId","in":"query","type":"string","required":false,"description":"Contains the identification assigned by an institution to identify a debtor account by the account owner."},{"name":"beneficiaryAccountId","in":"query","type":"string","required":false,"description":"Unique account identifier of the beneficiary account number."},{"name":"scheme","in":"query","type":"string","required":false,"description":"Represents the scheme (a synonym for the National ID type) under which the National ID is defined"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"ParkedPaymentsPendingReleaseResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/order/payments/parent/technicalExceptions/pendings","fullPath":"/api/v1.2.0/order/payments/parent/technicalExceptions/pendings","operationId":"getParentParkedPaymentsPendingRelease","name":"Retrieves the list of parent parked payments awaiting manual action","summary":"Retrieves parent parked payments","tags":["OTHERS"],"parameters":[{"name":"clearingTransactionType","in":"query","type":"string","required":false,"description":"Indicates the Clearing transaction type."},{"name":"creditCustomerId","in":"query","type":"string","required":false,"description":"Creditor customer id details"},{"name":"customerOrBankTransfer","in":"query","type":"string","required":false,"description":"Indicates if the payment was initiated by Customer or the financial institution"},{"name":"customerSpecifiedReference","in":"query","type":"string","required":false,"description":"Deprecated - Customer specified reference"},{"name":"debitCustomerId","in":"query","type":"string","required":false,"description":"Debtor customer details"},{"name":"paymentDirection","in":"query","type":"string","required":false,"description":"Indicates the direction of payment i.e. incoming, outgoing, book or redirect"},{"name":"endToEndReference","in":"query","type":"string","required":false,"description":"Indicates the end to end reference for the payment. This field can be provided by the person who instructs the payment and this flows through the lifecycle of the payment."},{"name":"entryDateTime","in":"query","type":"string","required":false,"description":"Contains the payment creation time"},{"name":"fileSendersReference","in":"query","type":"string","required":false,"description":"Indicates the sender reference that comes from the inward payment file"},{"name":"paymentId","in":"query","type":"string","required":false,"description":"Indicates the unique reference number of the payment"},{"name":"incomingMessageType","in":"query","type":"string","required":false,"description":"Indicates the supported message type to be received from the clearing house or the direct participant."},{"name":"company","in":"query","type":"string","required":false,"description":"The company code"},{"name":"processingDate","in":"query","type":"string","required":false,"description":"The date when payment instruction is processed in system."},{"name":"partySendersReferenceIncoming","in":"query","type":"string","required":false,"description":"Debtor payment reference details of incoming"},{"name":"partySendersReferenceOutgoing","in":"query","type":"string","required":false,"description":"Debtor payment reference details of outgoing"},{"name":"statusCode","in":"query","type":"string","required":false,"description":"Status code, as defined by the institution"},{"name":"transactionAmount","in":"query","type":"string","required":false,"description":"Contains the transaction amount. This is based on the currency, either local or foreign currency"},{"name":"transactionCurrency","in":"query","type":"string","required":false,"description":"Indicates the currency of the transaction. For example GBP, USD etc."},{"name":"transactionReference","in":"query","type":"string","required":false,"description":"Contains the identifier for the transaction in the core system"},{"name":"valueDate","in":"query","type":"string","required":false,"description":"Contains the value date of the claim or the date on which the amount to be claimed"},{"name":"paymentSource","in":"query","type":"string","required":false,"description":"Indicates the source from where the payment is originated"},{"name":"channel","in":"query","type":"string","required":false,"description":"Contains the channel in which the activity was performed. If pricing is not determined based on channel, then this is not significant"},{"name":"senderBankBic","in":"query","type":"string","required":false,"description":"Indicates the sending bank BIC Code"},{"name":"receiver","in":"query","type":"string","required":false,"description":"Identifies the receiver of the message"},{"name":"debtorAccountId","in":"query","type":"string","required":false,"description":"Contains the identification assigned by an institution to identify a debtor account by the account owner."},{"name":"beneficiaryAccountId","in":"query","type":"string","required":false,"description":"Unique account identifier of the beneficiary account number."},{"name":"scheme","in":"query","type":"string","required":false,"description":"Represents the scheme (a synonym for the National ID type) under which the National ID is defined"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"ParentParkedPaymentsPendingReleaseResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/order/payments/scheduledPayments/pendings","fullPath":"/api/v1.2.0/order/payments/scheduledPayments/pendings","operationId":"getPaymentsScheduledForRelease","name":"Retrieves the list of payments in the scheduled release queue awaiting manual action","summary":"Retrieves payments scheduled for release","tags":["OTHERS"],"parameters":[{"name":"clearingTransactionType","in":"query","type":"string","required":false,"description":"Indicates the Clearing transaction type."},{"name":"creditCustomerId","in":"query","type":"string","required":false,"description":"Creditor customer id details"},{"name":"customerOrBankTransfer","in":"query","type":"string","required":false,"description":"Indicates if the payment was initiated by Customer or the financial institution"},{"name":"customerSpecifiedReference","in":"query","type":"string","required":false,"description":"Deprecated - Customer specified reference"},{"name":"debitCustomerId","in":"query","type":"string","required":false,"description":"Debtor customer details"},{"name":"paymentDirection","in":"query","type":"string","required":false,"description":"Indicates the direction of payment i.e. incoming, outgoing, book or redirect"},{"name":"endToEndReference","in":"query","type":"string","required":false,"description":"Indicates the end to end reference for the payment. This field can be provided by the person who instructs the payment and this flows through the lifecycle of the payment."},{"name":"entryDateTime","in":"query","type":"string","required":false,"description":"Contains the payment creation time"},{"name":"fileSendersReference","in":"query","type":"string","required":false,"description":"Indicates the sender reference that comes from the inward payment file"},{"name":"paymentId","in":"query","type":"string","required":false,"description":"Indicates the unique reference number of the payment"},{"name":"incomingMessageType","in":"query","type":"string","required":false,"description":"Indicates the supported message type to be received from the clearing house or the direct participant."},{"name":"company","in":"query","type":"string","required":false,"description":"The company code"},{"name":"processingDate","in":"query","type":"string","required":false,"description":"The date when payment instruction is processed in system."},{"name":"partySendersReferenceIncoming","in":"query","type":"string","required":false,"description":"Debtor payment reference details of incoming"},{"name":"partySendersReferenceOutgoing","in":"query","type":"string","required":false,"description":"Debtor payment reference details of outgoing"},{"name":"statusCode","in":"query","type":"string","required":false,"description":"Status code, as defined by the institution"},{"name":"transactionAmount","in":"query","type":"string","required":false,"description":"Contains the transaction amount. This is based on the currency, either local or foreign currency"},{"name":"transactionCurrency","in":"query","type":"string","required":false,"description":"Indicates the currency of the transaction. For example GBP, USD etc."},{"name":"transactionReference","in":"query","type":"string","required":false,"description":"Contains the identifier for the transaction in the core system"},{"name":"valueDate","in":"query","type":"string","required":false,"description":"Contains the value date of the claim or the date on which the amount to be claimed"},{"name":"paymentSource","in":"query","type":"string","required":false,"description":"Indicates the source from where the payment is originated"},{"name":"channel","in":"query","type":"string","required":false,"description":"Contains the channel in which the activity was performed. If pricing is not determined based on channel, then this is not significant"},{"name":"senderBankBic","in":"query","type":"string","required":false,"description":"Indicates the sending bank BIC Code"},{"name":"receiver","in":"query","type":"string","required":false,"description":"Identifies the receiver of the message"},{"name":"debtorAccountId","in":"query","type":"string","required":false,"description":"Contains the identification assigned by an institution to identify a debtor account by the account owner."},{"name":"beneficiaryAccountId","in":"query","type":"string","required":false,"description":"Unique account identifier of the beneficiary account number."},{"name":"scheme","in":"query","type":"string","required":false,"description":"Represents the scheme (a synonym for the National ID type) under which the National ID is defined"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"PaymentsScheduledForReleaseResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/order/payments/futureDatedPayments/pendings","fullPath":"/api/v1.2.0/order/payments/futureDatedPayments/pendings","operationId":"getFuturedDatedPaymentsInWarehouse","name":"Retrieves the list of future dated payments in warehouse, that can be released, modified or cancelled ","summary":"Retrieves future dated payments","tags":["OTHERS"],"parameters":[{"name":"clearingTransactionType","in":"query","type":"string","required":false,"description":"Indicates the Clearing transaction type."},{"name":"creditCustomerId","in":"query","type":"string","required":false,"description":"Creditor customer id details"},{"name":"customerOrBankTransfer","in":"query","type":"string","required":false,"description":"Indicates if the payment was initiated by Customer or the financial institution"},{"name":"customerSpecifiedReference","in":"query","type":"string","required":false,"description":"Deprecated - Customer specified reference"},{"name":"debitCustomerId","in":"query","type":"string","required":false,"description":"Debtor customer details"},{"name":"paymentDirection","in":"query","type":"string","required":false,"description":"Indicates the direction of payment i.e. incoming, outgoing, book or redirect"},{"name":"endToEndReference","in":"query","type":"string","required":false,"description":"Indicates the end to end reference for the payment. This field can be provided by the person who instructs the payment and this flows through the lifecycle of the payment."},{"name":"entryDateTime","in":"query","type":"string","required":false,"description":"Contains the payment creation time"},{"name":"fileSendersReference","in":"query","type":"string","required":false,"description":"Indicates the sender reference that comes from the inward payment file"},{"name":"paymentId","in":"query","type":"string","required":false,"description":"Indicates the unique reference number of the payment"},{"name":"paymentOrderId","in":"query","type":"string","required":false,"description":"The unique reference number of payment"},{"name":"incomingMessageType","in":"query","type":"string","required":false,"description":"Indicates the supported message type to be received from the clearing house or the direct participant."},{"name":"company","in":"query","type":"string","required":false,"description":"The company code"},{"name":"processingDate","in":"query","type":"string","required":false,"description":"The date when payment instruction is processed in system."},{"name":"partySendersReferenceIncoming","in":"query","type":"string","required":false,"description":"Debtor payment reference details of incoming"},{"name":"partySendersReferenceOutgoing","in":"query","type":"string","required":false,"description":"Debtor payment reference details of outgoing"},{"name":"statusCode","in":"query","type":"string","required":false,"description":"Status code, as defined by the institution"},{"name":"transactionAmount","in":"query","type":"string","required":false,"description":"Contains the transaction amount. This is based on the currency, either local or foreign currency"},{"name":"transactionCurrency","in":"query","type":"string","required":false,"description":"Indicates the currency of the transaction. For example GBP, USD etc."},{"name":"transactionReference","in":"query","type":"string","required":false,"description":"Contains the identifier for the transaction in the core system"},{"name":"valueDate","in":"query","type":"string","required":false,"description":"Contains the value date of the claim or the date on which the amount to be claimed"},{"name":"paymentSource","in":"query","type":"string","required":false,"description":"Indicates the source from where the payment is originated"},{"name":"channel","in":"query","type":"string","required":false,"description":"Contains the channel in which the activity was performed. If pricing is not determined based on channel, then this is not significant"},{"name":"senderBankBic","in":"query","type":"string","required":false,"description":"Indicates the sending bank BIC Code"},{"name":"receiver","in":"query","type":"string","required":false,"description":"Identifies the receiver of the message"},{"name":"debtorAccountId","in":"query","type":"string","required":false,"description":"Contains the identification assigned by an institution to identify a debtor account by the account owner."},{"name":"beneficiaryAccountId","in":"query","type":"string","required":false,"description":"Unique account identifier of the beneficiary account number."},{"name":"scheme","in":"query","type":"string","required":false,"description":"Represents the scheme (a synonym for the National ID type) under which the National ID is defined"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"FuturedDatedPaymentsInWarehouseResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}}]},{"key":"order-payments-service-v1.0.0","title":"Order Payments APIs","version":"v1.0.0","description":"Allows the creation, viewing and management of payments and transfers","endpointCount":16,"endpoints":[{"method":"GET","path":"/order/payments/fees","fullPath":"/api/v1.0.0/order/payments/fees","operationId":"getPaymentFeesAndCharges","name":"","summary":"","tags":[],"parameters":[{"name":"transactionReference","in":"query","type":"string","required":false,"description":"Contains the identifier for the transaction in the core system"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"PaymentFeesAndChargesResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/order/payments/paymentStatus","fullPath":"/api/v1.0.0/order/payments/paymentStatus","operationId":"getPaymentsAuditTrail","name":"","summary":"","tags":[],"parameters":[{"name":"transactionReference","in":"query","type":"string","required":false,"description":"Contains the identifier for the transaction in the core system"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"PaymentsAuditTrailResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/order/payments/{paymentId}/paymentStatus","fullPath":"/api/v1.0.0/order/payments/{paymentId}/paymentStatus","operationId":"getPaymentAuditTrail","name":"","summary":"","tags":[],"parameters":[{"name":"paymentId","in":"path","type":"string","required":true,"description":"Indicates the unique reference number of the payment"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"PaymentAuditTrailResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/order/payments/pendingOrders","fullPath":"/api/v1.0.0/order/payments/pendingOrders","operationId":"getPendingPayments","name":"","summary":"","tags":[],"parameters":[{"name":"companyId","in":"query","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"processingDate","in":"query","type":"string","required":false,"description":"The date when payment instruction is processed in system."},{"name":"transactionReference","in":"query","type":"string","required":false,"description":"Contains the identifier for the transaction in the core system"},{"name":"direction","in":"query","type":"string","required":false,"description":"Indicates the direction of the Direct debit claim for which mandate is received. The claim can be 'Outward' i.e. Claim is sent to the other bank or 'Inward'  i.e. other bank submit their claim to debi"},{"name":"paymentCurrency","in":"query","type":"string","required":false,"description":"This field holds the transaction currency or currency in which payment is initiated. "},{"name":"toAmount","in":"query","type":"number","required":false,"description":"Holds the ending amount range."},{"name":"debitCustomerId","in":"query","type":"string","required":false,"description":"Debtor customer details"},{"name":"creditCustomerId","in":"query","type":"string","required":false,"description":"Creditor customer id details"},{"name":"debitCurrency","in":"query","type":"string","required":false,"description":"Currency of the debit account. For example: USD, EUR etc."},{"name":"debitAccountId","in":"query","type":"string","required":false,"description":"Indicates the debit account number of the payment or transaction."},{"name":"creditAccountId","in":"query","type":"string","required":false,"description":"Credit account identifier of the payment or transaction"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"PendingPaymentsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/order/payments/pendingRepairOrders","fullPath":"/api/v1.0.0/order/payments/pendingRepairOrders","operationId":"getPendingRepairPayments","name":"","summary":"","tags":[],"parameters":[{"name":"processingDate","in":"query","type":"string","required":false,"description":"The date when payment instruction is processed in system."},{"name":"direction","in":"query","type":"string","required":false,"description":"Indicates the direction of the Direct debit claim for which mandate is received. The claim can be 'Outward' i.e. Claim is sent to the other bank or 'Inward'  i.e. other bank submit their claim to debi"},{"name":"transactionCurrency","in":"query","type":"string","required":false,"description":"Indicates the currency of the transaction. For example GBP, USD etc."},{"name":"transactionAmount","in":"query","type":"string","required":false,"description":"Contains the transaction amount. This is based on the currency, either local or foreign currency"},{"name":"debitCurrencyId","in":"query","type":"string","required":false,"description":"The currency of the debit side in payment transaction. "},{"name":"debitAccountId","in":"query","type":"string","required":false,"description":"Indicates the debit account number of the payment or transaction."},{"name":"creditCurrencyId","in":"query","type":"string","required":false,"description":"Specifies the credit currency. For example: USD, EUR etc."},{"name":"creditAccountId","in":"query","type":"string","required":false,"description":"Credit account identifier of the payment or transaction"},{"name":"sendersReference","in":"query","type":"string","required":false,"description":"Indicates the incoming sender's reference i.e. tag 20 of incoming SWIFT or in case when transaction is received from other system/ application, this can also indicate the reference number of that syst"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"PendingRepairPaymentsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/order/payments/cutoffs","fullPath":"/api/v1.0.0/order/payments/cutoffs","operationId":"getCutoffGraphs","name":"Retrieves the cutoff based payment details ","summary":"Retrieves the Channel cutoff and Currency cutoff based payment details","tags":[],"parameters":[{"name":"company","in":"query","type":"string","required":false,"description":"The company code"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"CutoffGraphsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/meta/payments/queryFilters","fullPath":"/api/v1.0.0/meta/payments/queryFilters","operationId":"getQueryFilters","name":"Retrieves the payment transaction api query filters - This API is deprecated and moved to the following URL : meta/payments/queryFilters","summary":"Retrieves the query filters which can be applied on payment transaction api","tags":[],"parameters":[{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"QueryFiltersResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/order/payments/transactions","fullPath":"/api/v1.0.0/order/payments/transactions","operationId":"getPendingAndProcessedPayments","name":"Retrieves all type of payment transactions","summary":"Retrieves the payment transactions by using the query filters retrieved from meta api queryFilters","tags":[],"parameters":[{"name":"processingCompany","in":"query","type":"string","required":false,"description":"Deprecated - Processing company code"},{"name":"paymentType","in":"query","type":"string","required":false,"description":"Indicates if the payment is Customer (C) type or Bank (B) type"},{"name":"clearingName","in":"query","type":"string","required":false,"description":"Describes the clearing that is defined."},{"name":"processingDate","in":"query","type":"string","required":false,"description":"The date when payment instruction is processed in system."},{"name":"fTNumber","in":"query","type":"string","required":false,"description":"Deprecated - Transaction reference"},{"name":"direction","in":"query","type":"string","required":false,"description":"Indicates the direction of the Direct debit claim for which mandate is received. The claim can be 'Outward' i.e. Claim is sent to the other bank or 'Inward'  i.e. other bank submit their claim to debi"},{"name":"transactionCurrency","in":"query","type":"string","required":false,"description":"Indicates the currency of the transaction. For example GBP, USD etc."},{"name":"transactionAmount","in":"query","type":"string","required":false,"description":"Contains the transaction amount. This is based on the currency, either local or foreign currency"},{"name":"statusCode","in":"query","type":"string","required":false,"description":"Status code, as defined by the institution"},{"name":"messageType","in":"query","type":"string","required":false,"description":"Defines the type of swift messages that are sent or received for a transaction"},{"name":"debitAccountCurrency","in":"query","type":"string","required":false,"description":"Deprecated - Debit account currency"},{"name":"debitAccountNumber","in":"query","type":"string","required":false,"description":"Deprecated - Debit account number"},{"name":"creditAccCompany","in":"query","type":"string","required":false,"description":"Deprecated - Credit account company"},{"name":"creditAccountCurrency","in":"query","type":"string","required":false,"description":"Deprecated - Credit account currency"},{"name":"creditAccountNumber","in":"query","type":"string","required":false,"description":"Deprecated - credit account number"},{"name":"channel","in":"query","type":"string","required":false,"description":"Contains the channel in which the activity was performed. If pricing is not determined based on channel, then this is not significant"},{"name":"originatingSource","in":"query","type":"string","required":false,"description":"Deprecated - Originating source of the payment"},{"name":"sendersReferenceIncoming","in":"query","type":"string","required":false,"description":"Deprecated - Sender reference incoming"},{"name":"sendersReferenceOutgoing","in":"query","type":"string","required":false,"description":"Deprecated - sender reference outgoing"},{"name":"customer_Specified_Reference","in":"query","type":"string","required":false,"description":"Deprecated - Customer specified reference"},{"name":"transactionReference","in":"query","type":"string","required":false,"description":"Contains the identifier for the transaction in the core system"},{"name":"cTRBTRIndicator","in":"query","type":"string","required":false,"description":"Deprecated - Customer or bank transfer indicator"},{"name":"creditValueDate","in":"query","type":"string","required":false,"description":"Reference quoted by the credit account for a payment"},{"name":"debitValueDate","in":"query","type":"string","required":false,"description":"Date on which the amount will be debited for settlement"},{"name":"endToEndReference","in":"query","type":"string","required":false,"description":"Indicates the end to end reference for the payment. This field can be provided by the person who instructs the payment and this flows through the lifecycle of the payment."},{"name":"clearingTransactionType","in":"query","type":"string","required":false,"description":"Indicates the Clearing transaction type."},{"name":"tabView","in":"query","type":"string","required":false,"description":"Indicates the payment tab view"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"PendingAndProcessedPaymentsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/order/payments/swiftQueries","fullPath":"/api/v1.0.0/order/payments/swiftQueries","operationId":"getSwiftQueries","name":"Retrieves the list of sent swift queries","summary":"Retrieves the list of sent swift queries","tags":[],"parameters":[{"name":"transactionRef","in":"query","type":"string","required":false,"description":"Deprecated - Transaction reference"},{"name":"receiverBank","in":"query","type":"string","required":false,"description":"T24_PP.API.SWIFT.QUERIES.ANSWERS.1.0.0_receiverBank"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"SwiftQueriesResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/order/payments/instantPayments/transactions","fullPath":"/api/v1.0.0/order/payments/instantPayments/transactions","operationId":"getPendingAndProcessedPaymentsOthers","name":"Retrieves instant payment transactions","summary":"Retrieves timeout and unconfirmed instant payment transactions","tags":[],"parameters":[{"name":"fTNumber","in":"query","type":"string","required":false,"description":"Deprecated - Transaction reference"},{"name":"messageType","in":"query","type":"string","required":false,"description":"Defines the type of swift messages that are sent or received for a transaction"},{"name":"customerSpecifiedReference","in":"query","type":"string","required":false,"description":"Deprecated - Customer specified reference"},{"name":"sendersReferenceIncoming","in":"query","type":"string","required":false,"description":"Deprecated - Sender reference incoming"},{"name":"paymentType","in":"query","type":"string","required":false,"description":"Indicates if the payment is Customer (C) type or Bank (B) type"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"PendingAndProcessedPaymentsOthersResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/order/payments/summary/transactions","fullPath":"/api/v1.0.0/order/payments/summary/transactions","operationId":"getStatusMonitor","name":"Retrieves the payment transactions count","summary":"Retrieves the payment transactions count for various payment types","tags":[],"parameters":[{"name":"tabView","in":"query","type":"string","required":false,"description":"Indicates the payment tab view"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"StatusMonitorResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/order/payments/investigation/transactions","fullPath":"/api/v1.0.0/order/payments/investigation/transactions","operationId":"getPaymentsSepaInvestigations","name":"Retrieves the outward cancellation and claim payment requests for non receipt","summary":"Retrieves the outward cancellation and claim payment requests for non receipt","tags":[],"parameters":[{"name":"ClearingName","in":"query","type":"string","required":false,"description":"Describes the clearing that is defined."},{"name":"OriginalTrnReference","in":"query","type":"string","required":false,"description":"Deprecated - Original transaction reference"},{"name":"TransactionAmount","in":"query","type":"string","required":false,"description":"Contains the transaction amount. This is based on the currency, either local or foreign currency"},{"name":"TransactionAmountCurrency","in":"query","type":"string","required":false,"description":"Deprecated - Transaction amount currency"},{"name":"Status","in":"query","type":"string","required":false,"description":"The status of the early maturity request"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"PaymentsSepaInvestigationsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/order/payments/{id}/repairTransaction","fullPath":"/api/v1.0.0/order/payments/{id}/repairTransaction","operationId":"getRepairViewScreen","name":"Retrieves the payment transaction content - This API is deprecated and moved to the following URL : payments/{paymentId}/errors","summary":"Retrieves the payment transaction content for a payment","tags":[],"parameters":[{"name":"id","in":"path","type":"string","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"RepairViewScreenResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/order/payments/{id}/sepaTransaction","fullPath":"/api/v1.0.0/order/payments/{id}/sepaTransaction","operationId":"getSepaViewScreen","name":"Retrieves the sepa payment transaction content","summary":"Retrieves the sepa payment transaction content for a given payment","tags":[],"parameters":[{"name":"id","in":"path","type":"string","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"SepaViewScreenResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/order/payments/{id}/transaction","fullPath":"/api/v1.0.0/order/payments/{id}/transaction","operationId":"getViewScreen","name":"Retrieves the payment transaction ","summary":"Retrieves the payment transaction without the extended details","tags":[],"parameters":[{"name":"id","in":"path","type":"string","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"ViewScreenResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/order/payments/reasons","fullPath":"/api/v1.0.0/order/payments/reasons","operationId":"getPaymentReasonCode","name":"Retrieves the payment clearing reason code list","summary":"Retrieves the ISO and proprietary payment clearing reason code list","tags":[],"parameters":[{"name":"optionSelected","in":"query","type":"string","required":false,"description":"The option selected from the total number of options available"},{"name":"transactionType","in":"query","type":"string","required":false,"description":"Identifies the transaction type applicable to the transaction being processed, i.e. outward or inward payment. For example: ACPX, OTPX etc."},{"name":"receiver","in":"query","type":"string","required":false,"description":"Identifies the receiver of the message"},{"name":"clearingId","in":"query","type":"string","required":false,"description":"Clearing channel specific details"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"PaymentReasonCodeResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}}]},{"key":"order-payments-service-v2.0.0","title":"Payments Management","version":"v2.0.0","description":"Allows the creation, viewing and management of payments and transfers","endpointCount":18,"endpoints":[{"method":"GET","path":"/order/payments/fees","fullPath":"/api/v2.0.0/order/payments/fees","operationId":"getPaymentFeesAndCharges","name":"Retrieves the payment fee details","summary":"Retrieves the payment fee and charge details","tags":[],"parameters":[{"name":"transactionReference","in":"query","type":"string","required":false,"description":"Contains the identifier for the transaction in the core system"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from t24 on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"PaymentFeesAndChargesResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/order/payments/transactionLog","fullPath":"/api/v2.0.0/order/payments/transactionLog","operationId":"getAllPaymentsTransactionLogs","name":"Retrieves the payment tracking status","summary":"Retrieves the payment tracking details from initial payment mapping state to payment end state","tags":[],"parameters":[{"name":"transactionReference","in":"query","type":"string","required":false,"description":"Contains the identifier for the transaction in the core system"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from t24 on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"AllPaymentsTransactionLogsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/order/payments/{paymentId}/transactionLog","fullPath":"/api/v2.0.0/order/payments/{paymentId}/transactionLog","operationId":"getPaymentTransactionLog","name":"Retrieves the payment tracking status for the given payment id","summary":"Retrieves the payment tracking details from initial payment mapping state to payment end state for the given payment id","tags":[],"parameters":[{"name":"paymentId","in":"path","type":"string","required":true,"description":"Indicates the unique reference number of the payment"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from t24 on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"PaymentTransactionLogResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/order/payments/cutoffs","fullPath":"/api/v2.0.0/order/payments/cutoffs","operationId":"getPaymentCutoffs","name":"Retrieves the cutoff based payment details ","summary":"Retrieves the Channel cutoff and Currency cutoff based payment details","tags":[],"parameters":[{"name":"company","in":"query","type":"string","required":false,"description":"The company code"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from t24 on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"PaymentCutoffsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/order/payments/transactions/status/itemCount","fullPath":"/api/v2.0.0/order/payments/transactions/status/itemCount","operationId":"getPaymentsCount","name":"Retrieves the payment transactions count","summary":"Retrieves the payment transactions count for various payment types","tags":[],"parameters":[{"name":"tabView","in":"query","type":"string","required":false,"description":"Indicates the payment tab view"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from t24 on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"PaymentsCountResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/order/payments/{paymentId}/errors","fullPath":"/api/v2.0.0/order/payments/{paymentId}/errors","operationId":"getPaymentsInError","name":"Retrieves the payment transaction content","summary":"Retrieves the payment transaction content for a payment","tags":[],"parameters":[{"name":"paymentId","in":"path","type":"string","required":true,"description":"Indicates the unique reference number of the payment"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"PaymentsInErrorResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/order/payments/{paymentId}/sepaPayments","fullPath":"/api/v2.0.0/order/payments/{paymentId}/sepaPayments","operationId":"getSepaPayment","name":"Retrieves the sepa payment transaction content","summary":"Retrieves the sepa payment transaction content for a given payment","tags":[],"parameters":[{"name":"paymentId","in":"path","type":"string","required":true,"description":"Indicates the unique reference number of the payment"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"SepaPaymentResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/order/payments/{paymentId}","fullPath":"/api/v2.0.0/order/payments/{paymentId}","operationId":"getPayment","name":"Retrieves the payment transaction ","summary":"Retrieves the payment transaction without the extended details","tags":[],"parameters":[{"name":"paymentId","in":"path","type":"string","required":true,"description":"Indicates the unique reference number of the payment"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"PaymentResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/order/payments/instantPayments","fullPath":"/api/v2.0.0/order/payments/instantPayments","operationId":"getInstantPayments","name":"Retrieves the instant payment transactions","summary":"Retrieves the instant payment transactions along with timed out details","tags":[],"parameters":[{"name":"transactionReference","in":"query","type":"string","required":false,"description":"Contains the identifier for the transaction in the core system"},{"name":"messageType","in":"query","type":"string","required":false,"description":"Defines the type of swift messages that are sent or received for a transaction"},{"name":"customerReference","in":"query","type":"string","required":false,"description":"The reference which is provided to the beneficiary/ creditor by the originator of payment"},{"name":"partySendersReferenceIncoming","in":"query","type":"string","required":false,"description":"Debtor payment reference details of incoming"},{"name":"paymentType","in":"query","type":"string","required":false,"description":"Indicates if the payment is Customer (C) type or Bank (B) type"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from t24 on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"InstantPaymentsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/order/payments/transactions","fullPath":"/api/v2.0.0/order/payments/transactions","operationId":"getPendingAndProcessedPayments","name":"Retrieves all type of payment transactions","summary":"Retrieves the payment transactions by using the query filters retrieved from meta api queryFilters","tags":[],"parameters":[{"name":"companyName","in":"query","type":"string","required":false,"description":"The company in which payment is processed"},{"name":"paymentType","in":"query","type":"string","required":false,"description":"Indicates if the payment is Customer (C) type or Bank (B) type"},{"name":"clearingId","in":"query","type":"string","required":false,"description":"Clearing channel specific details"},{"name":"processingDate","in":"query","type":"string","required":false,"description":"The date when payment instruction is processed in system."},{"name":"transactionReference","in":"query","type":"string","required":false,"description":"Contains the identifier for the transaction in the core system"},{"name":"direction","in":"query","type":"string","required":false,"description":"Indicates the direction of the Direct debit claim for which mandate is received. The claim can be 'Outward' i.e. Claim is sent to the other bank or 'Inward'  i.e. other bank submit their claim to debi"},{"name":"transactionCurrency","in":"query","type":"string","required":false,"description":"Indicates the currency of the transaction. For example GBP, USD etc."},{"name":"transactionAmount","in":"query","type":"string","required":false,"description":"Contains the transaction amount. This is based on the currency, either local or foreign currency"},{"name":"statusCode","in":"query","type":"string","required":false,"description":"Status code, as defined by the institution"},{"name":"messageType","in":"query","type":"string","required":false,"description":"Defines the type of swift messages that are sent or received for a transaction"},{"name":"debitCurrency","in":"query","type":"string","required":false,"description":"Currency of the debit account. For example: USD, EUR etc."},{"name":"debitAccountId","in":"query","type":"string","required":false,"description":"Indicates the debit account number of the payment or transaction."},{"name":"creditAccountCompany","in":"query","type":"string","required":false,"description":"Contains the company of the credit party"},{"name":"creditCurrency","in":"query","type":"string","required":false,"description":"Currency of the account which funds will be transferred to."},{"name":"creditAccountId","in":"query","type":"string","required":false,"description":"Credit account identifier of the payment or transaction"},{"name":"channel","in":"query","type":"string","required":false,"description":"Contains the channel in which the activity was performed. If pricing is not determined based on channel, then this is not significant"},{"name":"paymentSource","in":"query","type":"string","required":false,"description":"Indicates the source from where the payment is originated"},{"name":"partySendersReferenceIncoming","in":"query","type":"string","required":false,"description":"Debtor payment reference details of incoming"},{"name":"partySendersReferenceOutgoing","in":"query","type":"string","required":false,"description":"Debtor payment reference details of outgoing"},{"name":"customerReference","in":"query","type":"string","required":false,"description":"The reference which is provided to the beneficiary/ creditor by the originator of payment"},{"name":"entryReference","in":"query","type":"string","required":false,"description":"It is the transaction reference. This is the identifier of the transaction on Temenos Core Banking system."},{"name":"customerOrBankTransfer","in":"query","type":"string","required":false,"description":"Indicates if the payment was initiated by Customer or the financial institution"},{"name":"creditValueDate","in":"query","type":"string","required":false,"description":"Reference quoted by the credit account for a payment"},{"name":"debitValueDate","in":"query","type":"string","required":false,"description":"Date on which the amount will be debited for settlement"},{"name":"endToEndReference","in":"query","type":"string","required":false,"description":"Indicates the end to end reference for the payment. This field can be provided by the person who instructs the payment and this flows through the lifecycle of the payment."},{"name":"transactionType","in":"query","type":"string","required":false,"description":"Identifies the transaction type applicable to the transaction being processed, i.e. outward or inward payment. For example: ACPX, OTPX etc."},{"name":"tabView","in":"query","type":"string","required":false,"description":"Indicates the payment tab view"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from t24 on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"PendingAndProcessedPaymentsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/order/payments/swiftQueries","fullPath":"/api/v2.0.0/order/payments/swiftQueries","operationId":"getSwiftQueries","name":"Retrieves the list of sent swift queries","summary":"Retrieves the list of sent swift queries","tags":[],"parameters":[{"name":"entryReference","in":"query","type":"string","required":false,"description":"It is the transaction reference. This is the identifier of the transaction on Temenos Core Banking system."},{"name":"beneficiaryBank","in":"query","type":"string","required":false,"description":"Bank for the beneficiary"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from t24 on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"SwiftQueriesResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/order/payments/status","fullPath":"/api/v2.0.0/order/payments/status","operationId":"getPaymentsStatus","name":"Retrieves the payments based on status. status can be \"completed\", \"excludingCompleted\", \"repair\" or \"all\"","summary":"Retrieves the payments based on status","tags":[],"parameters":[{"name":"fromDate","in":"query","type":"string","required":false,"description":"Indicates the business date from when the balance reservation event is active."},{"name":"status","in":"query","type":"string","required":false,"description":"The status of the early maturity request"},{"name":"debitCustomerId","in":"query","type":"string","required":false,"description":"Debtor customer details"},{"name":"creditCustomerId","in":"query","type":"string","required":false,"description":"Creditor customer id details"},{"name":"debitAccountId","in":"query","type":"string","required":false,"description":"Indicates the debit account number of the payment or transaction."},{"name":"creditAccountId","in":"query","type":"string","required":false,"description":"Credit account identifier of the payment or transaction"},{"name":"outputChannel","in":"query","type":"string","required":false,"description":"Contains the channel that will be used to send the outward payment message"},{"name":"paymentSource","in":"query","type":"string","required":false,"description":"Indicates the source from where the payment is originated"},{"name":"fileSendersReference","in":"query","type":"string","required":false,"description":"Indicates the sender reference that comes from the inward payment file"},{"name":"fundsTransferId","in":"query","type":"string","required":false,"description":"Identifier of the Funds Transfer"},{"name":"statusCode","in":"query","type":"string","required":false,"description":"Status code, as defined by the institution"},{"name":"toDate","in":"query","type":"string","required":false,"description":"Indicates the business date until when the balance reservation event is active."},{"name":"beneficiaryId","in":"query","type":"string","required":false,"description":"Indicates the reference of the financial institution that allows access to the beneficiary information"},{"name":"beneficiaryAccountId","in":"query","type":"string","required":false,"description":"Unique account identifier of the beneficiary account number."},{"name":"direction","in":"query","type":"string","required":false,"description":"Indicates the direction of the Direct debit claim for which mandate is received. The claim can be 'Outward' i.e. Claim is sent to the other bank or 'Inward'  i.e. other bank submit their claim to debi"},{"name":"transactionAmount","in":"query","type":"string","required":false,"description":"Contains the transaction amount. This is based on the currency, either local or foreign currency"},{"name":"messageType","in":"query","type":"string","required":false,"description":"Defines the type of swift messages that are sent or received for a transaction"},{"name":"processingDate","in":"query","type":"string","required":false,"description":"The date when payment instruction is processed in system."},{"name":"customerReference","in":"query","type":"string","required":false,"description":"The reference which is provided to the beneficiary/ creditor by the originator of payment"},{"name":"companyId","in":"query","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"debitCurrency","in":"query","type":"string","required":false,"description":"Currency of the debit account. For example: USD, EUR etc."},{"name":"debitAccountCompany","in":"query","type":"string","required":false,"description":"Contains the company of the debit party"},{"name":"creditCurrency","in":"query","type":"string","required":false,"description":"Currency of the account which funds will be transferred to."},{"name":"creditAccountCompany","in":"query","type":"string","required":false,"description":"Contains the company of the credit party"},{"name":"partySendersReferenceIncoming","in":"query","type":"string","required":false,"description":"Debtor payment reference details of incoming"},{"name":"transactionReference","in":"query","type":"string","required":false,"description":"Contains the identifier for the transaction in the core system"},{"name":"sendersCorrespondentAddress","in":"query","type":"string","required":false,"description":"Contains additional address lines of the sender correspondent institution."},{"name":"receiversCorrespondentAddress","in":"query","type":"string","required":false,"description":"Contains additional address lines of the receiver correspondent institution."},{"name":"bulkReference","in":"query","type":"string","required":false,"description":"Contains bulk master reference for the payment."},{"name":"customerOrBankTransfer","in":"query","type":"string","required":false,"description":"Indicates if the payment was initiated by Customer or the financial institution"},{"name":"creditValueDate","in":"query","type":"string","required":false,"description":"Reference quoted by the credit account for a payment"},{"name":"debitValueDate","in":"query","type":"string","required":false,"description":"Date on which the amount will be debited for settlement"},{"name":"settlementTransactionIndicator","in":"query","type":"string","required":false,"description":"Indicates whether the payment is settlement transaction or not"},{"name":"settlementClaimId","in":"query","type":"string","required":false,"description":"Indicates the settlement claim reference of the payment transaction"},{"name":"entryDateTime","in":"query","type":"string","required":false,"description":"Contains the payment creation time"},{"name":"approvedDateTime","in":"query","type":"string","required":false,"description":"Contains the time when payment got approved"},{"name":"clearingNatureCode","in":"query","type":"string","required":false,"description":"Contains the nature of the payment transaction"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from t24 on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"PaymentsStatusResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"POST","path":"/order/payments/recalls/bankInitiations","fullPath":"/api/v2.0.0/order/payments/recalls/bankInitiations","operationId":"createBankInitiatedPaymentRecall","name":"Creates bank initiated recall or cancellation request for a payment with transaction reference and the reason for cancellation. This request would be processed and responded by the Beneficiary Bank","summary":"Creates a recall request initiated by bank","tags":[],"parameters":[{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"transactionReference":"string","isoCancelReasonCode":"string","cancelReason":"string","additionalInformation":"string","waiveCharge":"string"}},"responses":{"200":"BankInitiatedPaymentRecallResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"POST","path":"/order/payments/recalls/customerInitiations","fullPath":"/api/v2.0.0/order/payments/recalls/customerInitiations","operationId":"createCustomerInitiatedPaymentRecall","name":"Creates customer initiated recall or cancellation request for a payment with transaction reference and the reason for cancellation. This request would be processed and responded by the Beneficiary Bank","summary":"Creates a recall request initiated by customer","tags":[],"parameters":[{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"transactionReference":"string","isoCancelReasonCode":"string","cancelReason":"string","additionalInformation":"string","waiveCharge":"string"}},"responses":{"200":"CustomerInitiatedPaymentRecallResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/order/payments/recalls/{recallId}/responses","fullPath":"/api/v2.0.0/order/payments/recalls/{recallId}/responses","operationId":"updateResponseToPaymentRecall","name":"Updates response for the recall request provided by beneficiary bank. The response can be either Acceptance or Rejection along with the reason. The response to the recall request should be recorded in the cancellation request record for further action.","summary":"Updates response to recall request initiated by bank or customer","tags":[],"parameters":[{"name":"recallId","in":"path","type":"string","required":true,"description":"Defines the ID to identify the payment which has to be recalled"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"id":"string","status":"string","transactionStatus":"string","uniqueIdentifier":"string","audit":{"T24_time":{},"versionNumber":{},"requestParse_time":{},"responseParse_time":{}}},"body":{"rejectAdditionalInfos":[{}],"acceptOrReject":"string","acceptedReason":"string","authorisationReason":"string","isoRejectReasonCode":"string","rejectReasonCode":"string","waiveCharge":"string"}},"responses":{"200":"ResponseToPaymentRecallResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/order/payments/swiftPayments/{swiftPaymentId}/acknowledgements","fullPath":"/api/v2.0.0/order/payments/swiftPayments/{swiftPaymentId}/acknowledgements","operationId":"updatePaymentSwiftOutTransaction","name":"Update payment status based on the acknowledgement or negative acknowledgement received from SWIFT","summary":"Update payment status based on the acknowledgement from SWIFT","tags":[],"parameters":[{"name":"swiftPaymentId","in":"path","type":"string","required":true,"description":"Contains the swift payment reference as generated by the system"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"company":"string","paymentReference":"string","statusCode":"string","paymentStatus":"string","statusChangeReason":"string","override":"string"}},"responses":{"200":"PaymentSwiftOutTransactionResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/order/payments/logs/sentMessages/{sentMessageId}","fullPath":"/api/v2.0.0/order/payments/logs/sentMessages/{sentMessageId}","operationId":"updatePaymentSentMessage","name":"Update the details like acknowledgement status, negative acknowledgement reason and time stamp on the payment sent message file","summary":"Update the payment sent details on payment sent message file","tags":[],"parameters":[{"name":"sentMessageId","in":"path","type":"string","required":true,"description":"Contains the sent message reference as generated by the system"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"ackDetails":[{}],"paymentReference":"string","messageId":"string"}},"responses":{"200":"PaymentSentMessageResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/order/payments/sepaPayments","fullPath":"/api/v2.0.0/order/payments/sepaPayments","operationId":"getSepaPayments","name":"Retrieves the sepa payment transactions","summary":"Retrieves the sepa payment transactions such as status, transaction amount, transaction currency, etc ","tags":[],"parameters":[{"name":"clearingId","in":"query","type":"string","required":false,"description":"Clearing channel specific details"},{"name":"originalTransactionReference","in":"query","type":"string","required":false,"description":"Identifies the Original Transaction Reference that created the Funds Authorisation request"},{"name":"transactionAmount","in":"query","type":"string","required":false,"description":"Contains the transaction amount. This is based on the currency, either local or foreign currency"},{"name":"transactionCurrency","in":"query","type":"string","required":false,"description":"Indicates the currency of the transaction. For example GBP, USD etc."},{"name":"statusCode","in":"query","type":"string","required":false,"description":"Status code, as defined by the institution"},{"name":"direction","in":"query","type":"string","required":false,"description":"Indicates the direction of the Direct debit claim for which mandate is received. The claim can be 'Outward' i.e. Claim is sent to the other bank or 'Inward'  i.e. other bank submit their claim to debi"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from t24 on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"SepaPaymentsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}}]},{"key":"order-payments-service-v3.0.0","title":"Payment Execution","version":"v3.0.0","description":"Temenos Payments Hub (TPH) is a Temenos Payments Application that executes payment orders that are received from front office or back office applications. TPH processes the orders until they are being account posted or cleared with an external clearing. The APIs listed in this page can be used by on","endpointCount":8,"endpoints":[{"method":"GET","path":"/order/payments/status","fullPath":"/api/v3.0.0/order/payments/status","operationId":"getPaymentsStatus","name":"Retrieves the payment details based on status. status can be \"completed\", \"excludingCompleted\", \"repair\" or \"all\"","summary":"Retrieves the payment details based on status","tags":[],"parameters":[{"name":"fromDate","in":"query","type":"string","required":true,"description":"Indicates the business date from when the balance reservation event is active."},{"name":"status","in":"query","type":"string","required":true,"description":"The status of the early maturity request"},{"name":"debitCustomerId","in":"query","type":"string","required":false,"description":"Debtor customer details"},{"name":"creditCustomerId","in":"query","type":"string","required":false,"description":"Creditor customer id details"},{"name":"debitAccountId","in":"query","type":"string","required":false,"description":"Indicates the debit account number of the payment or transaction."},{"name":"creditAccountId","in":"query","type":"string","required":false,"description":"Credit account identifier of the payment or transaction"},{"name":"outputChannel","in":"query","type":"string","required":false,"description":"Contains the channel that will be used to send the outward payment message"},{"name":"paymentSource","in":"query","type":"string","required":false,"description":"Indicates the source from where the payment is originated"},{"name":"fileSendersReference","in":"query","type":"string","required":false,"description":"Indicates the sender reference that comes from the inward payment file"},{"name":"fundsTransferId","in":"query","type":"string","required":false,"description":"Identifier of the Funds Transfer"},{"name":"statusCode","in":"query","type":"string","required":false,"description":"Status code, as defined by the institution"},{"name":"toDate","in":"query","type":"string","required":false,"description":"Indicates the business date until when the balance reservation event is active."},{"name":"beneficiaryId","in":"query","type":"string","required":false,"description":"Indicates the reference of the financial institution that allows access to the beneficiary information"},{"name":"beneficiaryAccountId","in":"query","type":"string","required":false,"description":"Unique account identifier of the beneficiary account number."},{"name":"direction","in":"query","type":"string","required":false,"description":"Indicates the direction of the Direct debit claim for which mandate is received. The claim can be 'Outward' i.e. Claim is sent to the other bank or 'Inward'  i.e. other bank submit their claim to debi"},{"name":"transactionAmount","in":"query","type":"string","required":false,"description":"Contains the transaction amount. This is based on the currency, either local or foreign currency"},{"name":"messageType","in":"query","type":"string","required":false,"description":"Defines the type of swift messages that are sent or received for a transaction"},{"name":"processingDate","in":"query","type":"string","required":false,"description":"The date when payment instruction is processed in system."},{"name":"customerReference","in":"query","type":"string","required":false,"description":"The reference which is provided to the beneficiary/ creditor by the originator of payment"},{"name":"companyId","in":"query","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"debitCurrency","in":"query","type":"string","required":false,"description":"Currency of the debit account. For example: USD, EUR etc."},{"name":"debitAccountCompany","in":"query","type":"string","required":false,"description":"Contains the company of the debit party"},{"name":"creditCurrency","in":"query","type":"string","required":false,"description":"Currency of the account which funds will be transferred to."},{"name":"creditAccountCompany","in":"query","type":"string","required":false,"description":"Contains the company of the credit party"},{"name":"partySendersReferenceIncoming","in":"query","type":"string","required":false,"description":"Debtor payment reference details of incoming"},{"name":"transactionReference","in":"query","type":"string","required":false,"description":"Contains the identifier for the transaction in the core system"},{"name":"sendersCorrespondentAddress","in":"query","type":"string","required":false,"description":"Contains additional address lines of the sender correspondent institution."},{"name":"receiversCorrespondentAddress","in":"query","type":"string","required":false,"description":"Contains additional address lines of the receiver correspondent institution."},{"name":"bulkReference","in":"query","type":"string","required":false,"description":"Contains bulk master reference for the payment."},{"name":"customerOrBankTransfer","in":"query","type":"string","required":false,"description":"Indicates if the payment was initiated by Customer or the financial institution"},{"name":"creditValueDate","in":"query","type":"string","required":false,"description":"Reference quoted by the credit account for a payment"},{"name":"debitValueDate","in":"query","type":"string","required":false,"description":"Date on which the amount will be debited for settlement"},{"name":"settlementTransactionIndicator","in":"query","type":"string","required":false,"description":"Indicates whether the payment is settlement transaction or not"},{"name":"settlementClaimId","in":"query","type":"string","required":false,"description":"Indicates the settlement claim reference of the payment transaction"},{"name":"entryDateTime","in":"query","type":"string","required":false,"description":"Contains the payment creation time"},{"name":"approvedDateTime","in":"query","type":"string","required":false,"description":"Contains the time when payment got approved"},{"name":"clearingNatureCode","in":"query","type":"string","required":false,"description":"Contains the nature of the payment transaction"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"PaymentsStatusResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/order/payments/fees","fullPath":"/api/v3.0.0/order/payments/fees","operationId":"getPaymentFeesAndCharges","name":"Retrieves the payment fee and tax for both the debit and credit leg of the payment. Details can be retrieved for a specific payment or all payments in the system.","summary":"Retrieves the payment fee and tax ","tags":[],"parameters":[{"name":"transactionReference","in":"query","type":"string","required":false,"description":"Contains the identifier for the transaction in the core system"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"PaymentFeesAndChargesResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/order/payments/transactionLog","fullPath":"/api/v3.0.0/order/payments/transactionLog","operationId":"getAllPaymentsTransactionLogs","name":"Retrieves audit trail which contains information on the lifecycle of a payment. Details can be retrieved for a specific payment or for all payments in the system.","summary":"Retrieves payment audit trail","tags":[],"parameters":[{"name":"transactionReference","in":"query","type":"string","required":false,"description":"Contains the identifier for the transaction in the core system"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"AllPaymentsTransactionLogsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"POST","path":"/order/payments/recalls/bankInitiations","fullPath":"/api/v3.0.0/order/payments/recalls/bankInitiations","operationId":"createBankInitiatedPaymentRecall","name":"Create a recall in response to a bank operator's request for a payment that has been previously sent out. Recall can be initoated for a specific payment reference and requires reason (code) for recall.","summary":"Create a recall in response to a bank operator's request","tags":[],"parameters":[{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"transactionReference":"string","isoCancelReasonCode":"string","cancelReason":"string","additionalInformation":"string","waiveCharge":"string"}},"responses":{"200":"BankInitiatedPaymentRecallResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"POST","path":"/order/payments/recalls/customerInitiations","fullPath":"/api/v3.0.0/order/payments/recalls/customerInitiations","operationId":"createCustomerInitiatedPaymentRecall","name":"Create a recall in response to a customer's request for a payment that has been previously sent out. Recall can be initoated for a specific payment reference and requires reason (code) for recall.","summary":"Create a recall in response to a customer's request","tags":[],"parameters":[{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"transactionReference":"string","isoCancelReasonCode":"string","cancelReason":"string","additionalInformation":"string","waiveCharge":"string"}},"responses":{"200":"CustomerInitiatedPaymentRecallResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/order/payments/recalls/{recallId}/responses","fullPath":"/api/v3.0.0/order/payments/recalls/{recallId}/responses","operationId":"updateResponseToPaymentRecall","name":"Respond to a recall request for a payment that was made previously.  Positive (Acceptance - Willing to Return Funds) or  Negative (Rejection - Unwilling to Return Funds) responses are acceptable, but they must be accompanied by a reason (code).","summary":"Respond to a request for recall","tags":[],"parameters":[{"name":"recallId","in":"path","type":"string","required":true,"description":"Defines the ID to identify the payment which has to be recalled"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"id":"string","status":"string","transactionStatus":"string","uniqueIdentifier":"string","audit":{"T24_time":{},"versionNumber":{},"requestParse_time":{},"responseParse_time":{}}},"body":{"rejectAdditionalInfos":[{}],"acceptOrReject":"string","acceptedReason":"string","authorisationReason":"string","isoRejectReasonCode":"string","rejectReasonCode":"string","waiveCharge":"string"}},"responses":{"200":"ResponseToPaymentRecallResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/order/payments/logs/sentMessages/{sentMessageId}","fullPath":"/api/v3.0.0/order/payments/logs/sentMessages/{sentMessageId}","operationId":"updatePaymentSentMessage","name":"Update the payment with the information from the payment acknowledgement. It is possible to update information such as acknowledgement status, reason(in the case of a negative acknowledgement), and the time stamp when the acknowledgement was received.","summary":"Update the status of a received acknowledgement","tags":[],"parameters":[{"name":"sentMessageId","in":"path","type":"string","required":true,"description":"Contains the sent message reference as generated by the system"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"ackDetails":[{}],"paymentReference":"string","messageId":"string"}},"responses":{"200":"PaymentSentMessageResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/order/payments/reasons","fullPath":"/api/v3.0.0/order/payments/reasons","operationId":"getPaymentCancelReasonCode","name":"When a customer to initiates a recall, list of recall reason codes to be displayed so that the appropriate one is chosen and place in the recall request. Use this API to fetch the list of reason codes and display to the customer.","summary":"Retrieve the clearing reason codes to place in the recall request","tags":[],"parameters":[{"name":"optionSelected","in":"query","type":"string","required":false,"description":"The option selected from the total number of options available"},{"name":"transactionType","in":"query","type":"string","required":false,"description":"Identifies the transaction type applicable to the transaction being processed, i.e. outward or inward payment. For example: ACPX, OTPX etc."},{"name":"receiver","in":"query","type":"string","required":false,"description":"Identifies the receiver of the message"},{"name":"clearingId","in":"query","type":"string","required":false,"description":"Clearing channel specific details"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"PaymentCancelReasonCodeResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}}]},{"key":"order-payments-service-v3.1.0","title":"Payment Execution","version":"v3.1.0","description":"Temenos Payments Hub (TPH) is a Temenos Payments Application that executes payment orders that are received from front office or back office applications. TPH processes the orders until they are being account posted or cleared with an external clearing. The APIs listed in this page can be used by on","endpointCount":9,"endpoints":[{"method":"GET","path":"/order/payments/status","fullPath":"/api/v3.1.0/order/payments/status","operationId":"getPaymentsStatus","name":"Retrieves the payment details based on status. Status can be \"completed\", \"excludingCompleted\", \"repair\" or \"all\"","summary":"Retrieves the payment details based on status","tags":[],"parameters":[{"name":"fromDate","in":"query","type":"string","required":true,"description":"Indicates the business date from when the balance reservation event is active."},{"name":"status","in":"query","type":"string","required":true,"description":"The status of the early maturity request"},{"name":"debitCustomerId","in":"query","type":"string","required":false,"description":"Debtor customer details"},{"name":"creditCustomerId","in":"query","type":"string","required":false,"description":"Creditor customer id details"},{"name":"debitAccountId","in":"query","type":"string","required":false,"description":"Indicates the debit account number of the payment or transaction."},{"name":"creditAccountId","in":"query","type":"string","required":false,"description":"Credit account identifier of the payment or transaction"},{"name":"outputChannel","in":"query","type":"string","required":false,"description":"Contains the channel that will be used to send the outward payment message"},{"name":"paymentSource","in":"query","type":"string","required":false,"description":"Indicates the source from where the payment is originated"},{"name":"fileSendersReference","in":"query","type":"string","required":false,"description":"Indicates the sender reference that comes from the inward payment file"},{"name":"fundsTransferId","in":"query","type":"string","required":false,"description":"Identifier of the Funds Transfer"},{"name":"statusCode","in":"query","type":"string","required":false,"description":"Status code, as defined by the institution"},{"name":"toDate","in":"query","type":"string","required":false,"description":"Indicates the business date until when the balance reservation event is active."},{"name":"beneficiaryId","in":"query","type":"string","required":false,"description":"Indicates the reference of the financial institution that allows access to the beneficiary information"},{"name":"beneficiaryAccountId","in":"query","type":"string","required":false,"description":"Unique account identifier of the beneficiary account number."},{"name":"direction","in":"query","type":"string","required":false,"description":"Indicates the direction of the Direct debit claim for which mandate is received. The claim can be 'Outward' i.e. Claim is sent to the other bank or 'Inward'  i.e. other bank submit their claim to debi"},{"name":"transactionAmount","in":"query","type":"string","required":false,"description":"Contains the transaction amount. This is based on the currency, either local or foreign currency"},{"name":"messageType","in":"query","type":"string","required":false,"description":"Defines the type of swift messages that are sent or received for a transaction"},{"name":"processingDate","in":"query","type":"string","required":false,"description":"The date when payment instruction is processed in system."},{"name":"customerReference","in":"query","type":"string","required":false,"description":"The reference which is provided to the beneficiary/ creditor by the originator of payment"},{"name":"companyId","in":"query","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"debitCurrency","in":"query","type":"string","required":false,"description":"Currency of the debit account. For example: USD, EUR etc."},{"name":"debitAccountCompany","in":"query","type":"string","required":false,"description":"Contains the company of the debit party"},{"name":"creditCurrency","in":"query","type":"string","required":false,"description":"Currency of the account which funds will be transferred to."},{"name":"creditAccountCompany","in":"query","type":"string","required":false,"description":"Contains the company of the credit party"},{"name":"partySendersReferenceIncoming","in":"query","type":"string","required":false,"description":"Debtor payment reference details of incoming"},{"name":"transactionReference","in":"query","type":"string","required":false,"description":"Contains the identifier for the transaction in the core system"},{"name":"sendersCorrespondentAddress","in":"query","type":"string","required":false,"description":"Contains additional address lines of the sender correspondent institution."},{"name":"receiversCorrespondentAddress","in":"query","type":"string","required":false,"description":"Contains additional address lines of the receiver correspondent institution."},{"name":"bulkReference","in":"query","type":"string","required":false,"description":"Contains bulk master reference for the payment."},{"name":"customerOrBankTransfer","in":"query","type":"string","required":false,"description":"Indicates if the payment was initiated by Customer or the financial institution"},{"name":"creditValueDate","in":"query","type":"string","required":false,"description":"Reference quoted by the credit account for a payment"},{"name":"debitValueDate","in":"query","type":"string","required":false,"description":"Date on which the amount will be debited for settlement"},{"name":"settlementTransactionIndicator","in":"query","type":"string","required":false,"description":"Indicates whether the payment is settlement transaction or not"},{"name":"settlementClaimId","in":"query","type":"string","required":false,"description":"Indicates the settlement claim reference of the payment transaction"},{"name":"entryDateTime","in":"query","type":"string","required":false,"description":"Contains the payment creation time"},{"name":"approvedDateTime","in":"query","type":"string","required":false,"description":"Contains the time when payment got approved"},{"name":"clearingNatureCode","in":"query","type":"string","required":false,"description":"Contains the nature of the payment transaction"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"PaymentsStatusResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/order/payments/fees","fullPath":"/api/v3.1.0/order/payments/fees","operationId":"getPaymentFeesAndCharges","name":"Retrieves the payment fee and tax for both the debit and credit leg of the payment. Details can be retrieved for a specific payment or all payments in the system.","summary":"Retrieves the payment fee and tax ","tags":[],"parameters":[{"name":"transactionReference","in":"query","type":"string","required":false,"description":"Contains the identifier for the transaction in the core system"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"PaymentFeesAndChargesResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/order/payments/transactionLog","fullPath":"/api/v3.1.0/order/payments/transactionLog","operationId":"getAllPaymentsTransactionLogs","name":"Retrieves audit trail which contains information on the lifecycle of a payment. Details can be retrieved for a specific payment or for all payments in the system.","summary":"Retrieves payment audit trail","tags":[],"parameters":[{"name":"transactionReference","in":"query","type":"string","required":false,"description":"Contains the identifier for the transaction in the core system"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"AllPaymentsTransactionLogsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"POST","path":"/order/payments/recalls/bankInitiations","fullPath":"/api/v3.1.0/order/payments/recalls/bankInitiations","operationId":"createBankInitiatedPaymentRecall","name":"Create a recall in response to a bank operator's request for a payment that has been previously sent out. Recall can be initiated for a specific payment reference and requires reason (code) for recall.","summary":"Create a recall in response to a bank operator's request","tags":[],"parameters":[{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"transactionReference":"string","isoCancelReasonCode":"string","cancelReason":"string","additionalInformation":"string","waiveCharge":"string","extensionData":{}}},"responses":{"200":"BankInitiatedPaymentRecallResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"POST","path":"/order/payments/recalls/customerInitiations","fullPath":"/api/v3.1.0/order/payments/recalls/customerInitiations","operationId":"createCustomerInitiatedPaymentRecall","name":"Create a recall in response to a customer's request for a payment that has been previously sent out. Recall can be initoated for a specific payment reference and requires reason (code) for recall.","summary":"Create a recall in response to a customer's request","tags":[],"parameters":[{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"transactionReference":"string","isoCancelReasonCode":"string","cancelReason":"string","additionalInformation":"string","waiveCharge":"string","extensionData":{}}},"responses":{"200":"CustomerInitiatedPaymentRecallResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/order/payments/recalls/{recallId}/responses","fullPath":"/api/v3.1.0/order/payments/recalls/{recallId}/responses","operationId":"updateResponseToPaymentRecall","name":"Respond to a recall request for a payment that was made previously.  Positive (Acceptance - Willing to Return Funds) or  Negative (Rejection - Unwilling to Return Funds) responses are acceptable, but they must be accompanied by a reason (code).","summary":"Respond to a request for recall","tags":[],"parameters":[{"name":"recallId","in":"path","type":"string","required":true,"description":"Defines the ID to identify the payment which has to be recalled"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"id":"string","status":"string","transactionStatus":"string","uniqueIdentifier":"string","audit":{"T24_time":{},"versionNumber":{},"requestParse_time":{},"responseParse_time":{}}},"body":{"rejectAdditionalInfos":[{}],"additionalInformation":"string","acceptOrReject":"string","acceptedReason":"string","authorisationReason":"string","isoRejectReasonCode":"string","rejectReasonCode":"string","waiveCharge":"string","extensionData":{}}},"responses":{"200":"ResponseToPaymentRecallResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/order/payments/logs/sentMessages/{sentMessageId}","fullPath":"/api/v3.1.0/order/payments/logs/sentMessages/{sentMessageId}","operationId":"updatePaymentSentMessage","name":"Update the payment with the information from the payment acknowledgement. It is possible to update information such as acknowledgement status, reason(in the case of a negative acknowledgement), and the time stamp when the acknowledgement was received.","summary":"Update the status of a received acknowledgement","tags":[],"parameters":[{"name":"sentMessageId","in":"path","type":"string","required":true,"description":"Contains the sent message reference as generated by the system"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"ackDetails":[{}],"paymentReference":"string","messageId":"string","extensionData":{}}},"responses":{"200":"PaymentSentMessageResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/order/payments/reasons","fullPath":"/api/v3.1.0/order/payments/reasons","operationId":"getPaymentCancelReasonCode","name":"When a customer to initiates a recall, list of recall reason codes to be displayed so that the appropriate one is chosen and place in the recall request. Use this API to fetch the list of reason codes and display to the customer.","summary":"Retrieve the clearing reason codes to place in the recall request","tags":[],"parameters":[{"name":"optionSelected","in":"query","type":"string","required":false,"description":"The option selected from the total number of options available"},{"name":"transactionType","in":"query","type":"string","required":false,"description":"Identifies the transaction type applicable to the transaction being processed, i.e. outward or inward payment. For example: ACPX, OTPX etc."},{"name":"receiver","in":"query","type":"string","required":false,"description":"Identifies the receiver of the message"},{"name":"clearingId","in":"query","type":"string","required":false,"description":"Clearing channel specific details"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"PaymentCancelReasonCodeResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/order/payments/clearingReachability/status","fullPath":"/api/v3.1.0/order/payments/clearingReachability/status","operationId":"getClearingReachability","name":"Check Clearing Reachability Enquiry/ API","summary":"An API to check the Clearing reachability status of the participant PSP","tags":[],"parameters":[{"name":"BIC","in":"query","type":"string","required":false,"description":"The BIC code of the Beneficiary bank"},{"name":"ncc","in":"query","type":"string","required":false,"description":"Indicates the National Clearing Code of the beneficiary bank"},{"name":"isoNccCode","in":"query","type":"string","required":false,"description":"Indicates the ISO National Clearing Code of the beneficiary bank"},{"name":"IBAN","in":"query","type":"string","required":false,"description":"International Bank Account number, an identifier of the account. E.g. GB29 NWBK 6016 1331 9268 19"},{"name":"outputChannel","in":"query","type":"string","required":true,"description":"Contains the channel that will be used to send the outward payment message"},{"name":"clearingTransactionType","in":"query","type":"string","required":true,"description":"Indicates the Clearing transaction type."},{"name":"localInstrument","in":"query","type":"string","required":false,"description":"Indicates the local instrument of the payment, used to identify the payment scheme for which the bank is reachable. For example : B2B, CORE etc"},{"name":"paymentDate","in":"query","type":"string","required":true,"description":"Contains the date in which the payment will be sent out.\u00c2\u00a0Date in the format YYYYMMDD. E.g. 20191231"},{"name":"paymentSourceTransactionId","in":"query","type":"string","required":false,"description":"Indicates the transaction identifier of the payment received from originating source"},{"name":"companyName","in":"query","type":"string","required":false,"description":"The company in which payment is processed"},{"name":"bankOfficeType","in":"query","type":"string","required":false,"description":"Indicates the bank office type. Possible values: M(Main bank office),S(Sub Bank office),L(Linked Bank Office)"},{"name":"transactionDetail","in":"query","type":"string","required":false,"description":"Contains the details of the transaction, which will be used\u00c2\u00a0to determine reachability of the BIC/NCC."},{"name":"electronicMandateCheck","in":"query","type":"string","required":false,"description":"Indicates whether electronic mandates are accepted by beneficiary bank"},{"name":"purposeProprietary","in":"query","type":"string","required":false,"description":"Contains additional details related to purpose of payment which is specific to Clearing"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"ClearingReachabilityResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}}]},{"key":"order-payments-service-v3.2.0","title":"Payment Execution","version":"v3.2.0","description":"Temenos Payments Hub (TPH) is a Temenos Payments Application that executes payment orders that are received from front office or back office applications. TPH processes the orders until they are being account posted or cleared with an external clearing. The APIs listed in this page can be used by on","endpointCount":9,"endpoints":[{"method":"GET","path":"/order/payments/status","fullPath":"/api/v3.2.0/order/payments/status","operationId":"getPaymentsStatus","name":"Retrieves the payment details based on status. Status can be \"completed\", \"excludingCompleted\", \"repair\" or \"all\"","summary":"Retrieves the payment details based on status","tags":[],"parameters":[{"name":"fromDate","in":"query","type":"string","required":true,"description":"Indicates the business date from when the balance reservation event is active."},{"name":"status","in":"query","type":"string","required":true,"description":"The status of the early maturity request"},{"name":"debitCustomerId","in":"query","type":"string","required":false,"description":"Debtor customer details"},{"name":"creditCustomerId","in":"query","type":"string","required":false,"description":"Creditor customer id details"},{"name":"debitAccountId","in":"query","type":"string","required":false,"description":"Indicates the debit account number of the payment or transaction."},{"name":"creditAccountId","in":"query","type":"string","required":false,"description":"Credit account identifier of the payment or transaction"},{"name":"outputChannel","in":"query","type":"string","required":false,"description":"Contains the channel that will be used to send the outward payment message"},{"name":"paymentSource","in":"query","type":"string","required":false,"description":"Indicates the source from where the payment is originated"},{"name":"fileSendersReference","in":"query","type":"string","required":false,"description":"Indicates the sender reference that comes from the inward payment file"},{"name":"fundsTransferId","in":"query","type":"string","required":false,"description":"Identifier of the Funds Transfer"},{"name":"statusCode","in":"query","type":"string","required":false,"description":"Status code, as defined by the institution"},{"name":"toDate","in":"query","type":"string","required":false,"description":"Indicates the business date until when the balance reservation event is active."},{"name":"beneficiaryId","in":"query","type":"string","required":false,"description":"Indicates the reference of the financial institution that allows access to the beneficiary information"},{"name":"beneficiaryAccountId","in":"query","type":"string","required":false,"description":"Unique account identifier of the beneficiary account number."},{"name":"direction","in":"query","type":"string","required":false,"description":"Indicates the direction of the Direct debit claim for which mandate is received. The claim can be 'Outward' i.e. Claim is sent to the other bank or 'Inward'  i.e. other bank submit their claim to debi"},{"name":"transactionAmount","in":"query","type":"string","required":false,"description":"Contains the transaction amount. This is based on the currency, either local or foreign currency"},{"name":"messageType","in":"query","type":"string","required":false,"description":"Defines the type of swift messages that are sent or received for a transaction"},{"name":"processingDate","in":"query","type":"string","required":false,"description":"The date when payment instruction is processed in system."},{"name":"customerReference","in":"query","type":"string","required":false,"description":"The reference which is provided to the beneficiary/ creditor by the originator of payment"},{"name":"companyId","in":"query","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"debitCurrency","in":"query","type":"string","required":false,"description":"Currency of the debit account. For example: USD, EUR etc."},{"name":"debitAccountCompany","in":"query","type":"string","required":false,"description":"Contains the company of the debit party"},{"name":"creditCurrency","in":"query","type":"string","required":false,"description":"Currency of the account which funds will be transferred to."},{"name":"creditAccountCompany","in":"query","type":"string","required":false,"description":"Contains the company of the credit party"},{"name":"partySendersReferenceIncoming","in":"query","type":"string","required":false,"description":"Debtor payment reference details of incoming"},{"name":"transactionReference","in":"query","type":"string","required":false,"description":"Contains the identifier for the transaction in the core system"},{"name":"sendersCorrespondentAddress","in":"query","type":"string","required":false,"description":"Contains additional address lines of the sender correspondent institution."},{"name":"receiversCorrespondentAddress","in":"query","type":"string","required":false,"description":"Contains additional address lines of the receiver correspondent institution."},{"name":"bulkReference","in":"query","type":"string","required":false,"description":"Contains bulk master reference for the payment."},{"name":"customerOrBankTransfer","in":"query","type":"string","required":false,"description":"Indicates if the payment was initiated by Customer or the financial institution"},{"name":"creditValueDate","in":"query","type":"string","required":false,"description":"Reference quoted by the credit account for a payment"},{"name":"debitValueDate","in":"query","type":"string","required":false,"description":"Date on which the amount will be debited for settlement"},{"name":"settlementTransactionIndicator","in":"query","type":"string","required":false,"description":"Indicates whether the payment is settlement transaction or not"},{"name":"settlementClaimId","in":"query","type":"string","required":false,"description":"Indicates the settlement claim reference of the payment transaction"},{"name":"entryDateTime","in":"query","type":"string","required":false,"description":"Contains the payment creation time"},{"name":"approvedDateTime","in":"query","type":"string","required":false,"description":"Contains the time when payment got approved"},{"name":"clearingNatureCode","in":"query","type":"string","required":false,"description":"Contains the nature of the payment transaction"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"PaymentsStatusResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/order/payments/fees","fullPath":"/api/v3.2.0/order/payments/fees","operationId":"getPaymentFeesAndCharges","name":"Retrieves the payment fee and tax for both the debit and credit leg of the payment. Details can be retrieved for a specific payment or all payments in the system.","summary":"Retrieves the payment fee and tax ","tags":[],"parameters":[{"name":"transactionReference","in":"query","type":"string","required":false,"description":"Contains the identifier for the transaction in the core system"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"PaymentFeesAndChargesResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/order/payments/transactionLog","fullPath":"/api/v3.2.0/order/payments/transactionLog","operationId":"getAllPaymentsTransactionLogs","name":"Retrieves audit trail which contains information on the lifecycle of a payment. Details can be retrieved for a specific payment or for all payments in the system.","summary":"Retrieves payment audit trail","tags":[],"parameters":[{"name":"transactionReference","in":"query","type":"string","required":false,"description":"Contains the identifier for the transaction in the core system"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"AllPaymentsTransactionLogsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"POST","path":"/order/payments/recalls/bankInitiations","fullPath":"/api/v3.2.0/order/payments/recalls/bankInitiations","operationId":"createBankInitiatedPaymentRecall","name":"Create a recall in response to a bank operator's request for a payment that has been previously sent out. Recall can be initiated for a specific payment reference and requires reason (code) for recall.","summary":"Create a recall in response to a bank operator's request","tags":[],"parameters":[{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"additionalInformations":[{}],"transactionReference":"string","isoCancelReasonCode":"string","cancelReason":"string","waiveCharge":"string","InvestigationCaseID":"string","cancelInitiatedBy":"string","extensions":{}}},"responses":{"200":"BankInitiatedPaymentRecallResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"POST","path":"/order/payments/recalls/customerInitiations","fullPath":"/api/v3.2.0/order/payments/recalls/customerInitiations","operationId":"createCustomerInitiatedPaymentRecall","name":"Create a recall in response to a customer's request for a payment that has been previously sent out. Recall can be initiated for a specific payment reference and requires reason (code) for recall.","summary":"Create a recall in response to a customer's request","tags":[],"parameters":[{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"additionalInformations":[{}],"originatorOrgOtherIds":[{}],"originatorOrgOtherSchemeCodes":[{}],"originatorOrgOtherIssuers":[{}],"originatorOrgOtherSchemeProps":[{}],"originatorUnstructuredAddressLines":[{}],"originatorPvtOtherIdentifications":[{}],"OriginatorPvtOtherSchemeCodes":[{}],"OriginatorPvtOtherIssuers":[{}],"originatorPvtOtherSchemeProps":[{}],"transactionReference":"string","isoCancelReasonCode":"string","cancelReason":"string","waiveCharge":"string","BIC":"string"}},"responses":{"200":"CustomerInitiatedPaymentRecallResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/order/payments/recalls/{recallId}/responses","fullPath":"/api/v3.2.0/order/payments/recalls/{recallId}/responses","operationId":"updateResponseToPaymentRecall","name":"Respond to a recall request for a payment that was made previously.  Positive (Acceptance - Willing to Return Funds) or  Negative (Rejection - Unwilling to Return Funds) responses are acceptable, but they must be accompanied by a reason (code).","summary":"Respond to a request for recall","tags":[],"parameters":[{"name":"recallId","in":"path","type":"string","required":true,"description":"Defines the ID to identify the payment which has to be recalled"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"id":"string","status":"string","transactionStatus":"string","uniqueIdentifier":"string","audit":{"T24_time":{},"versionNumber":{},"requestParse_time":{},"responseParse_time":{}}},"body":{"rejectAdditionalInfos":[{}],"additionalInformation":"string","acceptOrReject":"string","acceptedReason":"string","authorisationReason":"string","isoRejectReasonCode":"string","rejectReasonCode":"string","waiveCharge":"string","extensions":{}}},"responses":{"200":"ResponseToPaymentRecallResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/order/payments/logs/sentMessages/{sentMessageId}","fullPath":"/api/v3.2.0/order/payments/logs/sentMessages/{sentMessageId}","operationId":"updatePaymentSentMessage","name":"Update the payment with the information from the payment acknowledgement. It is possible to update information such as acknowledgement status, reason(in the case of a negative acknowledgement), and the time stamp when the acknowledgement was received.","summary":"Update the status of a received acknowledgement","tags":[],"parameters":[{"name":"sentMessageId","in":"path","type":"string","required":true,"description":"Contains the sent message reference as generated by the system"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"ackDetails":[{}],"paymentReference":"string","messageId":"string","extensions":{}}},"responses":{"200":"PaymentSentMessageResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/order/payments/reasons","fullPath":"/api/v3.2.0/order/payments/reasons","operationId":"getPaymentCancelReasonCode","name":"When a customer initiates a recall, a list of recall reason codes to be displayed so that the appropriate one is chosen and placed in the recall request. This API retrieves the list of reason codes and displayed to the customer.","summary":"Retrieve the clearing reason codes to place in the recall request","tags":[],"parameters":[{"name":"optionSelected","in":"query","type":"string","required":false,"description":"The option selected from the total number of options available"},{"name":"transactionType","in":"query","type":"string","required":false,"description":"Identifies the transaction type applicable to the transaction being processed, i.e. outward or inward payment. For example: ACPX, OTPX etc."},{"name":"receiver","in":"query","type":"string","required":false,"description":"Identifies the receiver of the message"},{"name":"clearingId","in":"query","type":"string","required":false,"description":"Clearing channel specific details"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"PaymentCancelReasonCodeResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/order/payments/clearingReachability/status","fullPath":"/api/v3.2.0/order/payments/clearingReachability/status","operationId":"getClearingReachability","name":"Check Clearing Reachability Enquiry/ API","summary":"Retrieves the status of Clearing reachability of the participant PSP (Payments service provider)","tags":[],"parameters":[{"name":"BIC","in":"query","type":"string","required":false,"description":"The BIC code of the Beneficiary bank"},{"name":"ncc","in":"query","type":"string","required":false,"description":"Indicates the National Clearing Code of the beneficiary bank"},{"name":"isoNccCode","in":"query","type":"string","required":false,"description":"Indicates the ISO National Clearing Code of the beneficiary bank"},{"name":"IBAN","in":"query","type":"string","required":false,"description":"International Bank Account number, an identifier of the account. E.g. GB29 NWBK 6016 1331 9268 19"},{"name":"outputChannel","in":"query","type":"string","required":true,"description":"Contains the channel that will be used to send the outward payment message"},{"name":"clearingTransactionType","in":"query","type":"string","required":true,"description":"Indicates the Clearing transaction type."},{"name":"localInstrument","in":"query","type":"string","required":false,"description":"Indicates the local instrument of the payment, used to identify the payment scheme for which the bank is reachable. For example : B2B, CORE etc"},{"name":"paymentDate","in":"query","type":"string","required":true,"description":"Contains the date in which the payment will be sent out. Date in the format YYYYMMDD. E.g. 20191231"},{"name":"paymentSourceTransactionId","in":"query","type":"string","required":false,"description":"Indicates the transaction identifier of the payment received from originating source"},{"name":"companyName","in":"query","type":"string","required":false,"description":"The company in which payment is processed"},{"name":"bankOfficeType","in":"query","type":"string","required":false,"description":"Indicates the bank office type. Possible values: M(Main bank office),S(Sub Bank office),L(Linked Bank Office)"},{"name":"transactionDetail","in":"query","type":"string","required":false,"description":"Contains the details of the transaction, which will be used to determine reachability of the BIC/NCC."},{"name":"electronicMandateCheck","in":"query","type":"string","required":false,"description":"Indicates whether electronic mandates are accepted by beneficiary bank"},{"name":"purposeProprietary","in":"query","type":"string","required":false,"description":"Contains additional details related to purpose of payment which is specific to Clearing"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"ClearingReachabilityResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}}]},{"key":"order-payments-service-v3.3.0","title":"Payment Execution","version":"v3.3.0","description":"Temenos Payments Hub (TPH) is a Temenos Payments Application that executes payment orders that are received from front office or back office applications. TPH processes the orders until they are being account posted or cleared with an external clearing. The APIs listed in this page can be used by on","endpointCount":11,"endpoints":[{"method":"GET","path":"/order/payments/status","fullPath":"/api/v3.3.0/order/payments/status","operationId":"getPaymentsStatus","name":"Retrieves the payment details based on status. Status can be \"completed\", \"excludingCompleted\", \"repair\" or \"all\"","summary":"Retrieves the payment details based on status","tags":[],"parameters":[{"name":"fromDate","in":"query","type":"string","required":true,"description":"Indicates the business date from when the balance reservation event is active."},{"name":"status","in":"query","type":"string","required":true,"description":"The status of the early maturity request"},{"name":"debitCustomerId","in":"query","type":"string","required":false,"description":"Debtor customer details"},{"name":"creditCustomerId","in":"query","type":"string","required":false,"description":"Creditor customer id details"},{"name":"debitAccountId","in":"query","type":"string","required":false,"description":"Indicates the debit account number of the payment or transaction."},{"name":"creditAccountId","in":"query","type":"string","required":false,"description":"Credit account identifier of the payment or transaction"},{"name":"outputChannel","in":"query","type":"string","required":false,"description":"Contains the channel that will be used to send the outward payment message"},{"name":"paymentSource","in":"query","type":"string","required":false,"description":"Indicates the source from where the payment is originated"},{"name":"fileSendersReference","in":"query","type":"string","required":false,"description":"Indicates the sender reference that comes from the inward payment file"},{"name":"fundsTransferId","in":"query","type":"string","required":false,"description":"Identifier of the Funds Transfer"},{"name":"statusCode","in":"query","type":"string","required":false,"description":"Status code, as defined by the institution"},{"name":"toDate","in":"query","type":"string","required":false,"description":"Indicates the business date until when the balance reservation event is active."},{"name":"beneficiaryId","in":"query","type":"string","required":false,"description":"Indicates the reference of the financial institution that allows access to the beneficiary information"},{"name":"beneficiaryAccountId","in":"query","type":"string","required":false,"description":"Unique account identifier of the beneficiary account number."},{"name":"direction","in":"query","type":"string","required":false,"description":"Indicates the direction of the Direct debit claim for which mandate is received. The claim can be 'Outward' i.e. Claim is sent to the other bank or 'Inward'  i.e. other bank submit their claim to debi"},{"name":"transactionAmount","in":"query","type":"string","required":false,"description":"Contains the transaction amount. This is based on the currency, either local or foreign currency"},{"name":"messageType","in":"query","type":"string","required":false,"description":"Defines the type of swift messages that are sent or received for a transaction"},{"name":"processingDate","in":"query","type":"string","required":false,"description":"The date when payment instruction is processed in system."},{"name":"customerReference","in":"query","type":"string","required":false,"description":"The reference which is provided to the beneficiary/ creditor by the originator of payment"},{"name":"companyId","in":"query","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"debitCurrency","in":"query","type":"string","required":false,"description":"Currency of the debit account. For example: USD, EUR etc."},{"name":"debitAccountCompany","in":"query","type":"string","required":false,"description":"Contains the company of the debit party"},{"name":"creditCurrency","in":"query","type":"string","required":false,"description":"Currency of the account which funds will be transferred to."},{"name":"creditAccountCompany","in":"query","type":"string","required":false,"description":"Contains the company of the credit party"},{"name":"partySendersReferenceIncoming","in":"query","type":"string","required":false,"description":"Debtor payment reference details of incoming"},{"name":"transactionReference","in":"query","type":"string","required":false,"description":"Contains the identifier for the transaction in the core system"},{"name":"sendersCorrespondentAddress","in":"query","type":"string","required":false,"description":"Contains additional address lines of the sender correspondent institution."},{"name":"receiversCorrespondentAddress","in":"query","type":"string","required":false,"description":"Contains additional address lines of the receiver correspondent institution."},{"name":"bulkReference","in":"query","type":"string","required":false,"description":"Contains bulk master reference for the payment."},{"name":"customerOrBankTransfer","in":"query","type":"string","required":false,"description":"Indicates if the payment was initiated by Customer or the financial institution"},{"name":"creditValueDate","in":"query","type":"string","required":false,"description":"Reference quoted by the credit account for a payment"},{"name":"debitValueDate","in":"query","type":"string","required":false,"description":"Date on which the amount will be debited for settlement"},{"name":"settlementTransactionIndicator","in":"query","type":"string","required":false,"description":"Indicates whether the payment is settlement transaction or not"},{"name":"settlementClaimId","in":"query","type":"string","required":false,"description":"Indicates the settlement claim reference of the payment transaction"},{"name":"entryDateTime","in":"query","type":"string","required":false,"description":"Contains the payment creation time"},{"name":"approvedDateTime","in":"query","type":"string","required":false,"description":"Contains the time when payment got approved"},{"name":"clearingNatureCode","in":"query","type":"string","required":false,"description":"Contains the nature of the payment transaction"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"PaymentsStatusResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/order/payments/fees","fullPath":"/api/v3.3.0/order/payments/fees","operationId":"getPaymentFeesAndCharges","name":"Retrieves the payment fee and tax for both the debit and credit leg of the payment. Details can be retrieved for a specific payment or all payments in the system.","summary":"Retrieves the payment fee and tax ","tags":[],"parameters":[{"name":"transactionReference","in":"query","type":"string","required":false,"description":"Contains the identifier for the transaction in the core system"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"PaymentFeesAndChargesResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/order/payments/transactionLog","fullPath":"/api/v3.3.0/order/payments/transactionLog","operationId":"getAllPaymentsTransactionLogs","name":"Retrieves audit trail which contains information on the lifecycle of a payment. Details can be retrieved for a specific payment or for all payments in the system.","summary":"Retrieves payment audit trail","tags":[],"parameters":[{"name":"transactionReference","in":"query","type":"string","required":false,"description":"Contains the identifier for the transaction in the core system"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"AllPaymentsTransactionLogsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"POST","path":"/order/payments/recalls/bankInitiations","fullPath":"/api/v3.3.0/order/payments/recalls/bankInitiations","operationId":"createBankInitiatedPaymentRecall","name":"Create a recall in response to a bank operator's request for a payment that has been previously sent out. Recall can be initiated for a specific payment reference and requires reason (code) for recall.","summary":"Create a recall in response to a bank operator's request","tags":[],"parameters":[{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"additionalInformations":[{}],"transactionReference":"string","isoCancelReasonCode":"string","cancelReason":"string","waiveCharge":"string","InvestigationCaseID":"string","cancelInitiatedBy":"string","extensions":{}}},"responses":{"200":"BankInitiatedPaymentRecallResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"POST","path":"/order/payments/recalls/customerInitiations","fullPath":"/api/v3.3.0/order/payments/recalls/customerInitiations","operationId":"createCustomerInitiatedPaymentRecall","name":"Create a recall in response to a customer's request for a payment that has been previously sent out. Recall can be initiated for a specific payment reference and requires reason (code) for recall.","summary":"Create a recall in response to a customer's request","tags":[],"parameters":[{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"additionalInformations":[{}],"originatorOrgOtherIds":[{}],"originatorOrgOtherSchemeCodes":[{}],"originatorOrgOtherIssuers":[{}],"originatorOrgOtherSchemeProps":[{}],"originatorUnstructuredAddressLines":[{}],"originatorPvtOtherIdentifications":[{}],"OriginatorPvtOtherSchemeCodes":[{}],"OriginatorPvtOtherIssuers":[{}],"originatorPvtOtherSchemeProps":[{}],"transactionReference":"string","isoCancelReasonCode":"string","cancelReason":"string","waiveCharge":"string","BIC":"string"}},"responses":{"200":"CustomerInitiatedPaymentRecallResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/order/payments/recalls/{recallId}/responses","fullPath":"/api/v3.3.0/order/payments/recalls/{recallId}/responses","operationId":"updateResponseToPaymentRecall","name":"Respond to a recall request for a payment that was made previously.  Positive (Acceptance - Willing to Return Funds) or  Negative (Rejection - Unwilling to Return Funds) responses are acceptable, but they must be accompanied by a reason (code).","summary":"Respond to a request for recall","tags":[],"parameters":[{"name":"recallId","in":"path","type":"string","required":true,"description":"Defines the ID to identify the payment which has to be recalled"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"id":"string","status":"string","transactionStatus":"string","uniqueIdentifier":"string","audit":{"T24_time":{},"versionNumber":{},"requestParse_time":{},"responseParse_time":{}}},"body":{"rejectAdditionalInfos":[{}],"additionalInformation":"string","acceptOrReject":"string","acceptedReason":"string","authorisationReason":"string","isoRejectReasonCode":"string","rejectReasonCode":"string","waiveCharge":"string","extensions":{}}},"responses":{"200":"ResponseToPaymentRecallResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/order/payments/logs/sentMessages/{sentMessageId}","fullPath":"/api/v3.3.0/order/payments/logs/sentMessages/{sentMessageId}","operationId":"updatePaymentSentMessage","name":"Update the payment with the information from the payment acknowledgement. It is possible to update information such as acknowledgement status, reason(in the case of a negative acknowledgement), and the time stamp when the acknowledgement was received.","summary":"Update the status of a received acknowledgement","tags":[],"parameters":[{"name":"sentMessageId","in":"path","type":"string","required":true,"description":"Contains the sent message reference as generated by the system"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"ackDetails":[{}],"paymentReference":"string","messageId":"string","extensions":{}}},"responses":{"200":"PaymentSentMessageResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/order/payments/reasons","fullPath":"/api/v3.3.0/order/payments/reasons","operationId":"getPaymentCancelReasonCode","name":"When a customer initiates a recall, the list of recall reason codes to be displayed so that the appropriate one is chosen and the payment is placed in the recall request. This API retrieves the list of reason codes to be displayed to the customer.","summary":"Retrieve the clearing reason codes to place in the recall request","tags":[],"parameters":[{"name":"optionSelected","in":"query","type":"string","required":false,"description":"The option selected from the total number of options available"},{"name":"transactionType","in":"query","type":"string","required":false,"description":"Identifies the transaction type applicable to the transaction being processed, i.e. outward or inward payment. For example: ACPX, OTPX etc."},{"name":"receiver","in":"query","type":"string","required":false,"description":"Identifies the receiver of the message"},{"name":"clearingId","in":"query","type":"string","required":false,"description":"Clearing channel specific details"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"PaymentCancelReasonCodeResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/order/payments/clearingReachability/status","fullPath":"/api/v3.3.0/order/payments/clearingReachability/status","operationId":"getClearingReachability","name":"Retrieves reachability status of the beneficiary/ receiving agent in a Clearing.","summary":"Retrieve clearing reachability status of the beneficiary agent","tags":[],"parameters":[{"name":"BIC","in":"query","type":"string","required":false,"description":"The BIC code of the Beneficiary bank"},{"name":"ncc","in":"query","type":"string","required":false,"description":"Indicates the National Clearing Code of the beneficiary bank"},{"name":"isoNccCode","in":"query","type":"string","required":false,"description":"Indicates the ISO National Clearing Code of the beneficiary bank"},{"name":"IBAN","in":"query","type":"string","required":false,"description":"International Bank Account number, an identifier of the account. E.g. GB29 NWBK 6016 1331 9268 19"},{"name":"outputChannel","in":"query","type":"string","required":true,"description":"Contains the channel that will be used to send the outward payment message"},{"name":"clearingTransactionType","in":"query","type":"string","required":true,"description":"Indicates the Clearing transaction type."},{"name":"localInstrument","in":"query","type":"string","required":false,"description":"Indicates the local instrument of the payment, used to identify the payment scheme for which the bank is reachable. For example : B2B, CORE etc"},{"name":"paymentDate","in":"query","type":"string","required":true,"description":"Contains the date in which the payment will be sent out. Date in the format YYYYMMDD. E.g. 20191231"},{"name":"paymentSourceTransactionId","in":"query","type":"string","required":false,"description":"Indicates the transaction identifier of the payment received from originating source"},{"name":"companyName","in":"query","type":"string","required":false,"description":"The company in which payment is processed"},{"name":"bankOfficeType","in":"query","type":"string","required":false,"description":"Indicates the bank office type. Possible values: M(Main bank office),S(Sub Bank office),L(Linked Bank Office)"},{"name":"transactionDetail","in":"query","type":"string","required":false,"description":"Contains the details of the transaction, which will be used to determine reachability of the BIC/NCC."},{"name":"electronicMandateCheck","in":"query","type":"string","required":false,"description":"Indicates whether electronic mandates are accepted by beneficiary bank"},{"name":"purposeProprietary","in":"query","type":"string","required":false,"description":"Contains additional details related to purpose of payment which is specific to Clearing"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"ClearingReachabilityResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/order/payments/customers/recalls","fullPath":"/api/v3.3.0/order/payments/customers/recalls","operationId":"getCustomerInitiatedCancellationRequests","name":"Retrieves the status of customers initiated recalls","summary":"Retrieve status of customer initiated recalls","tags":[],"parameters":[{"name":"cancelRequestId","in":"query","type":"string","required":false,"description":"Indicates the reference to track the initiation of payment cancellation"},{"name":"investigationCaseId","in":"query","type":"string","required":false,"description":"To unambiquously identify the case"},{"name":"senderInstitutionBIC","in":"query","type":"string","required":false,"description":"Contains the bank identification code of the sender institution"},{"name":"requestedExecutionDate","in":"query","type":"string","required":false,"description":"Contains the date on which payment has to be executed"},{"name":"paymentStatus","in":"query","type":"string","required":false,"description":"Describes the current status of the payment order in the payment system"},{"name":"processingIndicator","in":"query","type":"string","required":false,"description":"Indicates the processing mode of the request"},{"name":"UETRId","in":"query","type":"string","required":false,"description":"Unique transaction reference details for payments"},{"name":"settlementDate","in":"query","type":"string","required":false,"description":"Indicates the settlement date of the payment transaction"},{"name":"originalTransactionAmount","in":"query","type":"string","required":false,"description":"Contains the original transaction amount for the activity. This is based on the currrency either local or foreign currency"},{"name":"transactionCurrency","in":"query","type":"string","required":false,"description":"Indicates the currency of the transaction. For example GBP, USD etc."},{"name":"ftnumber","in":"query","type":"string","required":false,"description":"Deprecated - Transaction reference"},{"name":"originalMessageType","in":"query","type":"string","required":false,"description":"Indicates the outgoing message type of the payment"},{"name":"endToEndId","in":"query","type":"string","required":false,"description":"Contains the unique end to end processing chain reference of the transactions."},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"CustomerInitiatedCancellationRequestsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"POST","path":"/order/payments/customers/recalls","fullPath":"/api/v3.3.0/order/payments/customers/recalls","operationId":"createCustomerRecall","name":"Create a customer cancellation request for the already sent customer payment initiation message","summary":"Create a customer payment cancellation","tags":[],"parameters":[{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"ReqAssignmentIDs":[{}],"investigationCaseIds":[{}],"creatorunstructuredaddresses":[{}],"creatorOrgOtherIds":[{}],"creatorOrgOtherIssuers":[{}],"creatorOrgOtherSchemeCodes":[{}],"creatorOrgOtherSchemeProprietaries":[{}],"creatorPvtOtherIdentifications":[{}],"creatorPvtOtherIssuers":[{}],"creatorPvtOtherSchemeCodes":[{}],"creatorPvtOtherSchemeProprietaries":[{}],"customerNames":[{}],"originatorUnstructuredAddressLines":[{}],"originatorOrgOtherIds":[{}],"originatorOrgOtherIssuers":[{}]}},"responses":{"200":"CustomerRecallResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}}]},{"key":"order-payments-service-v3.4.0","title":"Payment Execution","version":"v3.4.0","description":"Temenos Payments Hub (TPH) is a Temenos Payments Application that executes payment orders that are received from front office or back office applications. TPH processes the orders until they are being account posted or cleared with an external clearing. The APIs listed in this page can be used by on","endpointCount":16,"endpoints":[{"method":"GET","path":"/order/payments/status","fullPath":"/api/v3.4.0/order/payments/status","operationId":"getPaymentsStatus","name":"Retrieves the payment details based on status. Status can be \"completed\", \"excludingCompleted\", \"repair\" or \"all\"","summary":"Retrieves the payment details based on status","tags":["OTHERS"],"parameters":[{"name":"fromDate","in":"query","type":"string","required":true,"description":"Indicates the business date from when the balance reservation event is active."},{"name":"status","in":"query","type":"string","required":true,"description":"The status of the early maturity request"},{"name":"debitCustomerId","in":"query","type":"string","required":false,"description":"Debtor customer details"},{"name":"creditCustomerId","in":"query","type":"string","required":false,"description":"Creditor customer id details"},{"name":"debitAccountId","in":"query","type":"string","required":false,"description":"Indicates the debit account number of the payment or transaction."},{"name":"creditAccountId","in":"query","type":"string","required":false,"description":"Credit account identifier of the payment or transaction"},{"name":"outputChannel","in":"query","type":"string","required":false,"description":"Contains the channel that will be used to send the outward payment message"},{"name":"paymentSource","in":"query","type":"string","required":false,"description":"Indicates the source from where the payment is originated"},{"name":"fileSendersReference","in":"query","type":"string","required":false,"description":"Indicates the sender reference that comes from the inward payment file"},{"name":"fundsTransferId","in":"query","type":"string","required":false,"description":"Identifier of the Funds Transfer"},{"name":"statusCode","in":"query","type":"string","required":false,"description":"Status code, as defined by the institution"},{"name":"toDate","in":"query","type":"string","required":false,"description":"Indicates the business date until when the balance reservation event is active."},{"name":"beneficiaryId","in":"query","type":"string","required":false,"description":"Indicates the reference of the financial institution that allows access to the beneficiary information"},{"name":"beneficiaryAccountId","in":"query","type":"string","required":false,"description":"Unique account identifier of the beneficiary account number."},{"name":"direction","in":"query","type":"string","required":false,"description":"Contains the direction of the information request. Value of 'Outward' indicates that the information request is sent by the Bank. Value of 'Inward' indicates that the request for information is receiv"},{"name":"transactionAmount","in":"query","type":"string","required":false,"description":"Contains the transaction amount. This is based on the currency, either local or foreign currency"},{"name":"messageType","in":"query","type":"string","required":false,"description":"Contains the message type of the information request."},{"name":"processingDate","in":"query","type":"string","required":false,"description":"The date when payment instruction is processed in system."},{"name":"customerReference","in":"query","type":"string","required":false,"description":"The reference which is provided to the beneficiary/ creditor by the originator of payment"},{"name":"companyId","in":"query","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"debitCurrency","in":"query","type":"string","required":false,"description":"Currency of the debit account. For example: USD, EUR etc."},{"name":"debitAccountCompany","in":"query","type":"string","required":false,"description":"Contains the company of the debit party"},{"name":"creditCurrency","in":"query","type":"string","required":false,"description":"Currency of the account which funds will be transferred to."},{"name":"creditAccountCompany","in":"query","type":"string","required":false,"description":"Contains the company of the credit party"},{"name":"partySendersReferenceIncoming","in":"query","type":"string","required":false,"description":"Debtor payment reference details of incoming"},{"name":"transactionReference","in":"query","type":"string","required":false,"description":"Contains the identifier for the transaction in the core system"},{"name":"sendersCorrespondentAddress","in":"query","type":"string","required":false,"description":"Contains additional address lines of the sender correspondent institution."},{"name":"receiversCorrespondentAddress","in":"query","type":"string","required":false,"description":"Contains additional address lines of the receiver correspondent institution."},{"name":"bulkReference","in":"query","type":"string","required":false,"description":"Contains bulk master reference for the payment."},{"name":"customerOrBankTransfer","in":"query","type":"string","required":false,"description":"Indicates if the payment was initiated by Customer or the financial institution"},{"name":"creditValueDate","in":"query","type":"string","required":false,"description":"Reference quoted by the credit account for a payment"},{"name":"debitValueDate","in":"query","type":"string","required":false,"description":"Date on which the amount will be debited for settlement"},{"name":"settlementTransactionIndicator","in":"query","type":"string","required":false,"description":"Indicates whether the payment is settlement transaction or not"},{"name":"settlementClaimId","in":"query","type":"string","required":false,"description":"Indicates the settlement claim reference of the payment transaction"},{"name":"entryDateTime","in":"query","type":"string","required":false,"description":"Contains the payment creation time"},{"name":"approvedDateTime","in":"query","type":"string","required":false,"description":"Contains the time when payment got approved"},{"name":"clearingNatureCode","in":"query","type":"string","required":false,"description":"Contains the nature of the payment transaction"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"PaymentsStatusResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/order/payments/fees","fullPath":"/api/v3.4.0/order/payments/fees","operationId":"getPaymentFeesAndCharges","name":"Retrieves the payment fee and tax for both the debit and credit leg of the payment. Details can be retrieved for a specific payment or all payments in the system.","summary":"Retrieves the payment fee and tax ","tags":["OTHERS"],"parameters":[{"name":"transactionReference","in":"query","type":"string","required":false,"description":"Contains the identifier for the transaction in the core system"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"PaymentFeesAndChargesResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/order/payments/transactionLog","fullPath":"/api/v3.4.0/order/payments/transactionLog","operationId":"getAllPaymentsTransactionLogs","name":"Retrieves audit trail which contains information on the lifecycle of a payment. Details can be retrieved for a specific payment or for all payments in the system.","summary":"Retrieves payment audit trail","tags":["OTHERS"],"parameters":[{"name":"transactionReference","in":"query","type":"string","required":false,"description":"Contains the identifier for the transaction in the core system"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"AllPaymentsTransactionLogsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"POST","path":"/order/payments/recalls/bankInitiations","fullPath":"/api/v3.4.0/order/payments/recalls/bankInitiations","operationId":"createBankInitiatedPaymentRecall","name":"Create a recall in response to a bank operator's request for a payment that has been previously sent out. Recall can be initiated for a specific payment reference and requires reason (code) for recall.","summary":"Create a recall in response to a bank operator's request","tags":["OTHERS"],"parameters":[{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"additionalInformations":[{}],"transactionReference":"string","isoCancelReasonCode":"string","cancelReason":"string","waiveCharge":"string","InvestigationCaseID":"string","cancelInitiatedBy":"string","extensions":{}}},"responses":{"200":"BankInitiatedPaymentRecallResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"POST","path":"/order/payments/recalls/customerInitiations","fullPath":"/api/v3.4.0/order/payments/recalls/customerInitiations","operationId":"createCustomerInitiatedPaymentRecall","name":"Create a recall in response to a customer's request for a payment that has been previously sent out. Recall can be initiated for a specific payment reference and requires reason (code) for recall.","summary":"Create a recall in response to a customer's request","tags":["OTHERS"],"parameters":[{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"additionalInformations":[{}],"originatorOrgOtherIds":[{}],"originatorOrgOtherSchemeCodes":[{}],"originatorOrgOtherIssuers":[{}],"originatorOrgOtherSchemeProps":[{}],"originatorUnstructuredAddressLines":[{}],"originatorPvtOtherIdentifications":[{}],"OriginatorPvtOtherSchemeCodes":[{}],"OriginatorPvtOtherIssuers":[{}],"originatorPvtOtherSchemeProps":[{}],"transactionReference":"string","isoCancelReasonCode":"string","cancelReason":"string","waiveCharge":"string","BIC":"string"}},"responses":{"200":"CustomerInitiatedPaymentRecallResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/order/payments/recalls/{recallId}/responses","fullPath":"/api/v3.4.0/order/payments/recalls/{recallId}/responses","operationId":"updateResponseToPaymentRecall","name":"Respond to a recall request for a payment that was made previously.  Positive (Acceptance - Willing to Return Funds) or  Negative (Rejection - Unwilling to Return Funds) responses are acceptable, but they must be accompanied by a reason (code).","summary":"Respond to a request for recall","tags":["OTHERS"],"parameters":[{"name":"recallId","in":"path","type":"string","required":true,"description":"Defines the ID to identify the payment which has to be recalled"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"id":"string","status":"string","transactionStatus":"string","uniqueIdentifier":"string","audit":{"T24_time":{},"versionNumber":{},"requestParse_time":{},"responseParse_time":{}}},"body":{"rejectAdditionalInfos":[{}],"additionalInformation":"string","acceptOrReject":"string","acceptedReason":"string","authorisationReason":"string","isoRejectReasonCode":"string","rejectReasonCode":"string","waiveCharge":"string","extensions":{}}},"responses":{"200":"ResponseToPaymentRecallResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/order/payments/logs/sentMessages/{sentMessageId}","fullPath":"/api/v3.4.0/order/payments/logs/sentMessages/{sentMessageId}","operationId":"updatePaymentSentMessage","name":"Update the payment with the information from the payment acknowledgement. It is possible to update information such as acknowledgement status, reason(in the case of a negative acknowledgement), and the time stamp when the acknowledgement was received.","summary":"Update the status of a received acknowledgement","tags":["OTHERS"],"parameters":[{"name":"sentMessageId","in":"path","type":"string","required":true,"description":"Contains the sent message reference as generated by the system"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"ackDetails":[{}],"paymentReference":"string","messageId":"string","extensions":{}}},"responses":{"200":"PaymentSentMessageResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/order/payments/reasons","fullPath":"/api/v3.4.0/order/payments/reasons","operationId":"getPaymentCancelReasonCode","name":"When a customer initiates a recall, the list of recall reason codes to be displayed so that the appropriate one is chosen and the payment is placed in the recall request. This API retrieves the list of reason codes to be displayed to the customer.","summary":"Retrieve the clearing reason codes to place in the recall request","tags":["OTHERS"],"parameters":[{"name":"optionSelected","in":"query","type":"string","required":false,"description":"The option selected from the total number of options available"},{"name":"transactionType","in":"query","type":"string","required":false,"description":"Identifies the transaction type applicable to the transaction being processed, i.e. outward or inward payment. For example: ACPX, OTPX etc."},{"name":"receiver","in":"query","type":"string","required":false,"description":"Identifies the receiver of the message"},{"name":"clearingId","in":"query","type":"string","required":false,"description":"Contains the identifier of the RTP scheme in case information request is for a RTP request. If the information request is for a credit transfer transaction, it contains the identifier of the clearing."},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"PaymentCancelReasonCodeResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/order/payments/clearingReachability/status","fullPath":"/api/v3.4.0/order/payments/clearingReachability/status","operationId":"getClearingReachability","name":"Retrieves reachability status of the beneficiary/ receiving agent in a Clearing.","summary":"Retrieve clearing reachability status of the beneficiary agent","tags":["OTHERS"],"parameters":[{"name":"BIC","in":"query","type":"string","required":false,"description":"The BIC code of the Beneficiary bank"},{"name":"ncc","in":"query","type":"string","required":false,"description":"Indicates the National Clearing Code of the beneficiary bank"},{"name":"isoNccCode","in":"query","type":"string","required":false,"description":"Indicates the ISO National Clearing Code of the beneficiary bank"},{"name":"IBAN","in":"query","type":"string","required":false,"description":"International Bank Account number, an identifier of the account. E.g. GB29 NWBK 6016 1331 9268 19"},{"name":"outputChannel","in":"query","type":"string","required":true,"description":"Contains the channel that will be used to send the outward payment message"},{"name":"clearingTransactionType","in":"query","type":"string","required":true,"description":"Indicates the Clearing transaction type."},{"name":"localInstrument","in":"query","type":"string","required":false,"description":"Indicates the local instrument of the payment, used to identify the payment scheme for which the bank is reachable. For example : B2B, CORE etc"},{"name":"paymentDate","in":"query","type":"string","required":true,"description":"Contains the date in which the payment will be sent out. Date in the format YYYYMMDD. E.g. 20191231"},{"name":"paymentSourceTransactionId","in":"query","type":"string","required":false,"description":"Indicates the transaction identifier of the payment received from originating source"},{"name":"companyName","in":"query","type":"string","required":false,"description":"The company in which payment is processed"},{"name":"bankOfficeType","in":"query","type":"string","required":false,"description":"Indicates the bank office type. Possible values: M(Main bank office),S(Sub Bank office),L(Linked Bank Office)"},{"name":"transactionDetail","in":"query","type":"string","required":false,"description":"Contains the details of the transaction, which will be used to determine reachability of the BIC/NCC."},{"name":"electronicMandateCheck","in":"query","type":"string","required":false,"description":"Indicates whether electronic mandates are accepted by beneficiary bank"},{"name":"purposeProprietary","in":"query","type":"string","required":false,"description":"Contains additional details related to purpose of payment which is specific to Clearing"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"ClearingReachabilityResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/order/payments/customers/recalls","fullPath":"/api/v3.4.0/order/payments/customers/recalls","operationId":"getCustomerInitiatedCancellationRequests","name":"Retrieves the status of customers initiated recalls","summary":"Retrieve status of customer initiated recalls","tags":["OTHERS"],"parameters":[{"name":"cancelRequestId","in":"query","type":"string","required":false,"description":"Indicates the reference to track the initiation of payment cancellation"},{"name":"investigationCaseId","in":"query","type":"string","required":false,"description":"To unambiquously identify the case"},{"name":"senderInstitutionBIC","in":"query","type":"string","required":false,"description":"Contains the Bank Identifier Code(BIC) of the bank which is sending the information request."},{"name":"requestedExecutionDate","in":"query","type":"string","required":false,"description":"Contains the date on which payment has to be executed"},{"name":"paymentStatus","in":"query","type":"string","required":false,"description":"Describes the current status of the payment order in the payment system"},{"name":"processingIndicator","in":"query","type":"string","required":false,"description":"Indicates the processing mode of the request"},{"name":"UETRId","in":"query","type":"string","required":false,"description":"Contains the unique end-to-end transaction reference of the underlying payment request (RTP) or credit transfer transaction for which information request is to be raised."},{"name":"settlementDate","in":"query","type":"string","required":false,"description":"Indicates the settlement date of the payment transaction"},{"name":"originalTransactionAmount","in":"query","type":"string","required":false,"description":"Contains the original transaction amount for the activity. This is based on the currrency either local or foreign currency"},{"name":"transactionCurrency","in":"query","type":"string","required":false,"description":"Indicates the currency of the transaction. For example GBP, USD etc."},{"name":"ftnumber","in":"query","type":"string","required":false,"description":"Deprecated - Transaction reference"},{"name":"originalMessageType","in":"query","type":"string","required":false,"description":"Contains the message type of the underlying payment request (RTP) or credit transfer transaction for which information request is raised."},{"name":"endToEndId","in":"query","type":"string","required":false,"description":"Contains the unique end to end processing chain reference of the transactions."},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"CustomerInitiatedCancellationRequestsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"POST","path":"/order/payments/customers/recalls","fullPath":"/api/v3.4.0/order/payments/customers/recalls","operationId":"createCustomerRecall","name":"Create a customer cancellation request for the already sent customer payment initiation message","summary":"Create a customer payment cancellation","tags":["OTHERS"],"parameters":[{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"ReqAssignmentIDs":[{}],"investigationCaseIds":[{}],"creatorunstructuredaddresses":[{}],"creatorOrgOtherIds":[{}],"creatorOrgOtherIssuers":[{}],"creatorOrgOtherSchemeCodes":[{}],"creatorOrgOtherSchemeProprietaries":[{}],"creatorPvtOtherIdentifications":[{}],"creatorPvtOtherIssuers":[{}],"creatorPvtOtherSchemeCodes":[{}],"creatorPvtOtherSchemeProprietaries":[{}],"customerNames":[{}],"originatorUnstructuredAddressLines":[{}],"originatorOrgOtherIds":[{}],"originatorOrgOtherIssuers":[{}]}},"responses":{"200":"CustomerRecallResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/order/payments/extensions/messages","fullPath":"/api/v3.4.0/order/payments/extensions/messages","operationId":"getPaymentExtensionMessage","name":"To get the details of payment extension message from the periphery","summary":"Retrieves the details of payment extension message from the periphery","tags":["OTHERS"],"parameters":[{"name":"ftnumber","in":"query","type":"string","required":false,"description":"Deprecated - Transaction reference"},{"name":"creditAccountCompany","in":"query","type":"string","required":false,"description":"Contains the company of the credit party"},{"name":"creditAccNumber","in":"query","type":"string","required":false,"description":"Deprecated - Credit account number"},{"name":"creditAccCurrency","in":"query","type":"string","required":false,"description":"Deprecated - Credit account currency"},{"name":"debitAccountCompany","in":"query","type":"string","required":false,"description":"Contains the company of the debit party"},{"name":"debitAccNumber","in":"query","type":"string","required":false,"description":"Deprecated - Debit account number"},{"name":"debitAccCurrency","in":"query","type":"string","required":false,"description":"Deprecated - Debit account currency"},{"name":"processingDate","in":"query","type":"string","required":false,"description":"The date when payment instruction is processed in system."},{"name":"creditValueDate","in":"query","type":"string","required":false,"description":"Reference quoted by the credit account for a payment"},{"name":"debitValueDate","in":"query","type":"string","required":false,"description":"Date on which the amount will be debited for settlement"},{"name":"clearingNatureCode","in":"query","type":"string","required":false,"description":"Contains the nature of the payment transaction"},{"name":"waiveCharge","in":"query","type":"string","required":false,"description":"Indicates if the charges are to be waived for the instruction"},{"name":"typeIndicator","in":"query","type":"string","required":false,"description":"Indicates if the record is an Income or Expense"},{"name":"ddaStatus","in":"query","type":"string","required":false,"description":"Indicates Online (or Blank) or Offline"},{"name":"stage","in":"query","type":"string","required":false,"description":"Indicates the current stage of the contract based on the IFRS9 classification"},{"name":"errorCode","in":"query","type":"string","required":false,"description":"Indicates the error code which is encountered during payment processing as returned by payment system "},{"name":"errorDetail","in":"query","type":"string","required":false,"description":"Error details of the Bundle account"},{"name":"errorType","in":"query","type":"string","required":false,"description":"Error types of the Bundle account"},{"name":"additionalInformation","in":"query","type":"string","required":false,"description":"Contains additional information for raising the information request in free text form."},{"name":"feeType","in":"query","type":"string","required":false,"description":"Indicates the type of fee which is applied for payment instruction"},{"name":"chargeAmount","in":"query","type":"string","required":false,"description":"Retrieves the charge amount after redeem"},{"name":"statementTextToken","in":"query","type":"string","required":false,"description":"Specifies the tokens from either Amount Token, Date Token or Statement Text Token"},{"name":"narrative","in":"query","type":"string","required":false,"description":"The additional text printed on descriptive statements in addition to the standard narrative and/or reference"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"PaymentExtensionMessageResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"POST","path":"/order/payments/extensions/messages/{ftnumber}","fullPath":"/api/v3.4.0/order/payments/extensions/messages/{ftnumber}","operationId":"createPaymentExtensionMessage","name":"To create payment extension message from the periphery and will be referred during payment workflow to override core enriched value for a single payment","summary":"Create payment extension message from the periphery","tags":["OTHERS"],"parameters":[{"name":"ftnumber","in":"path","type":"string","required":true,"description":"Deprecated - Transaction reference"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"typeIndicators":[{}],"stages":[{}],"errorCodes":[{}],"errorDetails":[{}],"errorTypes":[{}],"additionalInformations":[{}],"feeTypes":[{}],"chargeAmounts":[{}],"statementTextTokens":[{}],"narratives":[{}],"creditAccountCompany":"string","creditAccNumber":"string","creditAccCurrency":"string","debitAccountCompany":"string","debitAccNumber":"string"}},"responses":{"200":"PaymentExtensionMessageResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/order/payments/extensions/messages/{ftnumber}","fullPath":"/api/v3.4.0/order/payments/extensions/messages/{ftnumber}","operationId":"amendPaymentExtensionMessage","name":"To update payment extension message from the periphery into the application which got already updated from periphery","summary":"Amend payment extension message from the periphery","tags":["OTHERS"],"parameters":[{"name":"ftnumber","in":"path","type":"string","required":true,"description":"Deprecated - Transaction reference"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"typeIndicators":[{}],"stages":[{}],"errorCodes":[{}],"errorDetails":[{}],"errorTypes":[{}],"additionalInformations":[{}],"feeTypes":[{}],"chargeAmounts":[{}],"statementTextTokens":[{}],"narratives":[{}],"creditAccountCompany":"string","creditAccNumber":"string","creditAccCurrency":"string","debitAccountCompany":"string","debitAccNumber":"string"}},"responses":{"200":"PaymentExtensionMessageResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/order/payments/{paymentId}/pendings","fullPath":"/api/v3.4.0/order/payments/{paymentId}/pendings","operationId":"amendOrderEntry","name":"Updates order entry of a payment with the transaction, customer and account details","summary":"Updates order entry with transaction details","tags":["OTHERS"],"parameters":[{"name":"paymentId","in":"path","type":"string","required":true,"description":"Indicates the unique reference number of the payment"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"informations":[{}],"warnings":[{}],"functionalErrors":[{}],"creditorOrganisationIds":[{}],"creditorOrganisationSchemeCodes":[{}],"originatorOrgOtherSchemeProps":[{}],"creditorOrganisationIssuers":[{}],"creditorPrivateIds":[{}],"creditorPrivateSchemeNames":[{}],"originatorPvtOtherSchemeProps":[{}],"creditorPrivateIssuers":[{}],"debtorOrganisationIds":[{}],"debtorOrganisationSchemeIds":[{}],"debtorOrganisationSchemeNames":[{}],"debtorOrganisationIssuers":[{}]}},"responses":{"200":"OrderEntryResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/order/payments/pendings","fullPath":"/api/v3.4.0/order/payments/pendings","operationId":"getOrderEntry","name":"Retrieves the transaction, customer, account details of all payments pending for action","summary":"Retrieves the transaction details of all payments pending for action","tags":["OTHERS"],"parameters":[{"name":"debitAccountCompany","in":"query","type":"string","required":false,"description":"Contains the company of the debit party"},{"name":"creditAccountCompany","in":"query","type":"string","required":false,"description":"Contains the company of the credit party"},{"name":"debitAccountNumber","in":"query","type":"string","required":false,"description":"Deprecated - Debit account number"},{"name":"debitAccountNumberImposed","in":"query","type":"string","required":false,"description":"Indicates whether the debit account number is imposed on the payment engine. Possible values are yes and blank. If yes, the field value for debit account number will not be overriden by the payment en"},{"name":"creditAccountNumber","in":"query","type":"string","required":false,"description":"Contains the International Bank Account Number(IBAN) for which the camt message is sent."},{"name":"creditAccountNumberImposed","in":"query","type":"string","required":false,"description":"Indicates whether the credit account number is imposed on the payment engine."},{"name":"debitAccountCurrency","in":"query","type":"string","required":false,"description":"Deprecated - Debit account currency"},{"name":"creditAccountCurrency","in":"query","type":"string","required":false,"description":"Deprecated - Credit account currency"},{"name":"debitAmount","in":"query","type":"string","required":false,"description":"Amount to be debited in a payment transaction"},{"name":"creditAmount","in":"query","type":"string","required":false,"description":"Amount to be credited in a payment transaction"},{"name":"debitValueDate","in":"query","type":"string","required":false,"description":"Date on which the amount will be debited for settlement"},{"name":"debitValueDateImposed","in":"query","type":"string","required":false,"description":"Indicates whether the debit value date is imposed or can be overwritten by the payment engine."},{"name":"creditValueDate","in":"query","type":"string","required":false,"description":"Reference quoted by the credit account for a payment"},{"name":"creditValueDateImposed","in":"query","type":"string","required":false,"description":"Indicates whether the credit value date is imposed or can be overwritten by the payment engine."},{"name":"returnOrRejectDescription","in":"query","type":"string","required":false,"description":"Contains short additional information on the reason why the payment was returned, refunded or rejected."},{"name":"cancelDescription","in":"query","type":"string","required":false,"description":"Contains the reason for cancellation of a payment."},{"name":"returnOrRejectPayment","in":"query","type":"string","required":false,"description":"Identifies whether the payment should be returned or rejected. Possible values are return, reject and blank."},{"name":"returnCode","in":"query","type":"string","required":false,"description":"Deprecated - Return reason code"},{"name":"paymentReturnDescription","in":"query","type":"string","required":false,"description":"Indicates a description of the reason for the return of the payment."},{"name":"debitInstruction","in":"query","type":"string","required":false,"description":"Contains any debit instructions to process the payment."},{"name":"creditInstruction","in":"query","type":"string","required":false,"description":"Contains any credit instructions to process the payment."},{"name":"information","in":"query","type":"string","required":false,"description":"Contains informational errors if any."},{"name":"warning","in":"query","type":"string","required":false,"description":"Contains warning errors if any."},{"name":"acceptWarning","in":"query","type":"string","required":false,"description":"Indicates whether any warning type of errors encountered by the system have to be mandatorily accepted for further payment processing."},{"name":"functionalError","in":"query","type":"string","required":false,"description":"Contains functional errors if any."},{"name":"fatalError","in":"query","type":"string","required":false,"description":"Indicates the fatal error that stopped the payment transaction"},{"name":"creditorSchemeCode","in":"query","type":"string","required":false,"description":"Contains the code of the scheme which issued the identifier of the creditor"},{"name":"creditorSchemeProprietary","in":"query","type":"string","required":false,"description":"Contains the proprietary code of the scheme which issued the identifier of the creditor"},{"name":"creditorSchemeIssuer","in":"query","type":"string","required":false,"description":"Contains the issuer code of the scheme which issued the identifier of the creditor."},{"name":"creditorDepartmentId","in":"query","type":"string","required":false,"description":"Identifier of the department of creditor."},{"name":"creditorSubDepartmentId","in":"query","type":"string","required":false,"description":"Contains the sub-division identifier of a large organisation or building, of a creditor."},{"name":"creditorFloorNumber","in":"query","type":"string","required":false,"description":"Contains the floor number of the creditor address"},{"name":"creditorPostBoxNumber","in":"query","type":"string","required":false,"description":"Contains the Post Office Box (POB) number that relates to creditor financial institution"},{"name":"creditorRoom","in":"query","type":"string","required":false,"description":"Indicates the room number/name of the creditor's residing building"},{"name":"creditorTown","in":"query","type":"string","required":false,"description":"Contains the name of the town of the creditor."},{"name":"creditorDistrictName","in":"query","type":"string","required":false,"description":"Contains the district name of the creditor."},{"name":"creditorCountrySubDivision","in":"query","type":"string","required":false,"description":"Indicates the country sub division such as state, region, county of the creditor"},{"name":"beneficiaryAddressLine1","in":"query","type":"string","required":false,"description":"Line 1 of address of beneficiary to whom the payment is initiated"},{"name":"beneficiaryAddressLine2","in":"query","type":"string","required":false,"description":"Line 2 of address of beneficiary to whom the payment is initiated"},{"name":"creditorAddress3","in":"query","type":"string","required":false,"description":"Contains the line 3 of address details of the creditor."},{"name":"creditorLEI","in":"query","type":"string","required":false,"description":"Contains the Legal Entity Identifier of the creditor"},{"name":"creditorOrganisationId","in":"query","type":"string","required":false,"description":"Contains the unique identification of the organisation of the creditor."},{"name":"creditorOrganisationSchemeCode","in":"query","type":"string","required":false,"description":"Contains the name of the identification scheme of the creditor in coded format. For example, BANK (bank party identification), EMPL (employer identification number)."},{"name":"originatorOrgOtherSchemeProp","in":"query","type":"string","required":false,"description":"Indicates the originator organisation scheme proprietary details. Originator is the party who requests the payment cancellation. It accepts free text which can be of alphanumeric characters."},{"name":"creditorOrganisationIssuer","in":"query","type":"string","required":false,"description":"Contains the entity of the creditor which assigns the identification when creditor is an organization."},{"name":"creditorBirthDate","in":"query","type":"string","required":false,"description":"Contains the birth date of the creditor in case the person is an individual."},{"name":"creditorProvinceOfBirth","in":"query","type":"string","required":false,"description":"Contains the province of birth of the creditor in case the person is an individual."},{"name":"creditorCityOfBirth","in":"query","type":"string","required":false,"description":"Contains the city of birth of the creditor in case the person is an individual."},{"name":"creditorCountryOfBirth","in":"query","type":"string","required":false,"description":"Contains the country of birth of the creditor in case the person is an individual."},{"name":"creditorPrivateId","in":"query","type":"string","required":false,"description":"Contains the unique identification of the creditor as a person, as assigned by his institution. For example, the identification could be passport number or driving license number issued by the governm"},{"name":"creditorPrivateSchemeName","in":"query","type":"string","required":false,"description":"Contains the proprietary name of the identification scheme of the creditor as an individual."},{"name":"originatorPvtOtherSchemeProp","in":"query","type":"string","required":false,"description":"Indicates the originator private scheme proprietary details. Originator is the party who requests the payment cancellation. It accepts free text which can be of alphanumeric characters."},{"name":"creditorPrivateIssuer","in":"query","type":"string","required":false,"description":"Contains the creditor entity which assigns the identification when the creditor is an individual."},{"name":"debtorDepartmentId","in":"query","type":"string","required":false,"description":"Identifier of the department of debtor."},{"name":"debtorSubDepartmentId","in":"query","type":"string","required":false,"description":"Contains the sub-division identifier of a large organisation or building, of a debtor."},{"name":"debtorFloorNumber","in":"query","type":"string","required":false,"description":"Contains the floor number of the debtor address"},{"name":"debtorPostBoxNumber","in":"query","type":"string","required":false,"description":"Contains the Post Office Box (POB) number that relates to debitor financial institution"},{"name":"debtorRoom","in":"query","type":"string","required":false,"description":"Indicates the room number/name of the debtor's residing building."},{"name":"debtorTown","in":"query","type":"string","required":false,"description":"Contains the name of the town of the debtor."},{"name":"debtorDistrictName","in":"query","type":"string","required":false,"description":"Contains the district name of the debtor."},{"name":"debtorCountrySubDivision","in":"query","type":"string","required":false,"description":"Indicates the country sub division such as state, region, county of the debtor"},{"name":"debtorAddress1","in":"query","type":"string","required":false,"description":"Contains the line 1 of address details of the debtor."},{"name":"debtorAddress2","in":"query","type":"string","required":false,"description":"Contains the line 2 of address details of the debtor."},{"name":"debtorAddress3","in":"query","type":"string","required":false,"description":"Contains the line 3 of address details of the debtor."},{"name":"debtorLEI","in":"query","type":"string","required":false,"description":"Contains the Legal Entity Identifier of debtor"},{"name":"debtorOrganisationId","in":"query","type":"string","required":false,"description":"Contains the unique identification of the organisation of the debtor when the debtor is an organisation."},{"name":"debtorOrganisationSchemeId","in":"query","type":"string","required":false,"description":"Contains the name of the identification scheme of the debtor in a coded format when the debtor is an organisation. For example, BANK (bank party identification), EMPL (employer identification number)."},{"name":"debtorOrganisationSchemeName","in":"query","type":"string","required":false,"description":"Contains the name of the identification scheme of the debtor in a free text format when the debtor is an organisation."},{"name":"debtorOrganisationIssuer","in":"query","type":"string","required":false,"description":"Contains the entity of the debtor which assigns the identification in case debtor is an organisation."},{"name":"debtorBirthDate","in":"query","type":"string","required":false,"description":"Contains the birth date of the debtor in case the person is an individual."},{"name":"debtorProvinceOfBirth","in":"query","type":"string","required":false,"description":"Contains the province of birth of the debtor in case the person is an individual."},{"name":"debtorCityOfBirth","in":"query","type":"string","required":false,"description":"Contains the city of birth of the debtor in case the person is an individual."},{"name":"debtorCountryOfBirth","in":"query","type":"string","required":false,"description":"Contains the country of birth of the debtor in case the person is an individual."},{"name":"debtorPrivateId","in":"query","type":"string","required":false,"description":"Contains the unique identification of the debtor as a person, as assigned by his institution, using identificaiton scheme. For example, the identification could be passport number or driving license n"},{"name":"debtorPrivateSchemeCode","in":"query","type":"string","required":false,"description":"Contains the external person identification scheme name code of the debtor as a person. For example, CCPT (passport number), DRLC (drivers license number)."},{"name":"DebtorProprietaryScheme","in":"query","type":"string","required":false,"description":"Contains the proprietary code of the scheme which issued the identifier for the debtor"},{"name":"debtorPrivateIssuer","in":"query","type":"string","required":false,"description":"Contains entity of the debtor which assigns the identification when the debtor is an individual."},{"name":"statusCode","in":"query","type":"string","required":false,"description":"Status code, as defined by the institution"},{"name":"processingCompany","in":"query","type":"string","required":false,"description":"Deprecated - Processing company code"},{"name":"transactionReference","in":"query","type":"string","required":true,"description":"Contains the identifier for the transaction in the core system"},{"name":"processingDate","in":"query","type":"string","required":false,"description":"The date when payment instruction is processed in system."},{"name":"processingDateImposed","in":"query","type":"string","required":false,"description":"Indicates whether the processing date is imposed on the payment engine. Possible values are yes and blank. If yes, the field value for processing date will not be overriden by the payment engine."},{"name":"sendersReference","in":"query","type":"string","required":false,"description":"Indicates the incoming sender's reference i.e. tag 20 of incoming SWIFT or in case when transaction is received from other system/ application, this can also indicate the reference number of that syst"},{"name":"messagePriority","in":"query","type":"string","required":false,"description":"Contains the priority code of the payment message"},{"name":"relatedReference","in":"query","type":"string","required":false,"description":"An external reference id for the transaction."},{"name":"requestedCollectionDate","in":"query","type":"string","required":false,"description":"Indicates the date on which the creditor requests the transaction amount to be collected from the debtor."},{"name":"paymentSource","in":"query","type":"string","required":false,"description":"Indicates the source from where the payment is originated"},{"name":"outputChannel","in":"query","type":"string","required":false,"description":"Contains the channel that will be used to send the outward payment message"},{"name":"outputChannelImposed","in":"query","type":"string","required":false,"description":"Indicates whether the channel is imposed on the payment engine. Possible values are yes and blank. If yes, the field value for channel will not be overriden by the payment engine."},{"name":"paymentDirection","in":"query","type":"string","required":false,"description":"Indicates the direction of payment i.e. incoming, outgoing, book or redirect"},{"name":"transactionCurrency","in":"query","type":"string","required":false,"description":"Indicates the currency of the transaction. For example GBP, USD etc."},{"name":"ctrbtrIndicator","in":"query","type":"string","required":false,"description":"Deprecated - Customer or bank transfer indicator"},{"name":"transactionAmount","in":"query","type":"string","required":false,"description":"Contains the transaction amount. This is based on the currency, either local or foreign currency"},{"name":"incomingMessageType","in":"query","type":"string","required":false,"description":"Indicates the supported message type to be received from the clearing house or the direct participant."},{"name":"settlementPriority","in":"query","type":"string","required":false,"description":"Indicates the settlement priority of the message"},{"name":"senderInstitutionBIC","in":"query","type":"string","required":false,"description":"Contains the Bank Identifier Code(BIC) of the bank which is sending the information request."},{"name":"receiverClearingSystemId","in":"query","type":"string","required":false,"description":"Contains the ISO clearing system code of receiver financial institution"},{"name":"orderingCustomerId","in":"query","type":"string","required":false,"description":"Indicates the customer id for the ordering customer"},{"name":"receiverInstitutionNcc","in":"query","type":"string","required":false,"description":"Contains the unique identifier(within a clearing system) or National Clearing Code (NCC) of the bank which is receiving the information request."},{"name":"paymentDetail","in":"query","type":"string","required":false,"description":"Indicates the payment details for the beneficiary to apply the payment."},{"name":"defaultChargeOption","in":"query","type":"string","required":false,"description":"Indicates the charge option which will be defaulted at the time of payment initiation for specific payment order product i.e. Recipient To Pay All Charges, Pay My Bank's Charges or Pay My Bank Charges"},{"name":"paymentProduct","in":"query","type":"string","required":false,"description":"Preferred payment product can be specified for Beneficiary. This will be used for defaulting the payment product for specific beneficiary."},{"name":"endToEndReference","in":"query","type":"string","required":false,"description":"Indicates the end to end reference for the payment. This field can be provided by the person who instructs the payment and this flows through the lifecycle of the payment."},{"name":"serviceLevelCode","in":"query","type":"string","required":false,"description":"Indicates the agreed service or level of service between the parties, in a coded form such as such as URGP - Urgent payment, BKTR - Book transaction,etc"},{"name":"serviceLevelProprietary","in":"query","type":"string","required":false,"description":"Indicates the agreed service or level of service between the parties, in a proprietary form such as URGP - Urgent payment, BKTR - Book transaction,etc"},{"name":"localInstrumentCode","in":"query","type":"string","required":false,"description":"List of transfer type has been mentioned locally in a record"},{"name":"localInstrumentName","in":"query","type":"string","required":false,"description":"Contains proprietary name of the local instrument."},{"name":"categoryPurposeCode","in":"query","type":"string","required":false,"description":"Contains the category purpose in the form of the clearing system identification code."},{"name":"proprietaryCategoryPurpose","in":"query","type":"string","required":false,"description":"Contains the category proprietary code of the payments,example : direct debit for loan repayment"},{"name":"transactionPurposeCode","in":"query","type":"string","required":false,"description":"Contains the underlying reason for the transaction in coded form such as BKFE - Bank loan fees, ADVA - Advance payment,etc."},{"name":"purposeProprietary","in":"query","type":"string","required":false,"description":"Contains additional details related to purpose of payment which is specific to Clearing"},{"name":"instruction","in":"query","type":"string","required":false,"description":"Contains the instruction control for the current service. Allowed values: - START: to start the current service. - STOP: to stop the current service - AUTO: to start the current service automatically "},{"name":"creditorAgentInstructionInformation","in":"query","type":"string","required":false,"description":"Contains the additional information relating to the processing of the payment instruction, provided by the initiating party, and intended for the creditor agent."},{"name":"NextAgentInstructionInformation","in":"query","type":"string","required":false,"description":"Contains the additional information relating to the processing of the payment instruction that may need to be acted upon by the next agent"},{"name":"clearingSettlementTime","in":"query","type":"string","required":false,"description":"Indicates the clearing and settlement time of the payment instruction."},{"name":"dateTimeTo","in":"query","type":"string","required":false,"description":"Contains the to value of date and time to be specified in a range."},{"name":"dateTimeFrom","in":"query","type":"string","required":false,"description":"Contains the from value of date and time to be specified in a range."},{"name":"rejectTime","in":"query","type":"string","required":false,"description":"Indicates the time within which the payment should be settled to avoid rejection by the clearing."},{"name":"additionalDetail","in":"query","type":"string","required":false,"description":"Additional details provided to add context. Closure notes for closed accounts, positing restriction details for restricted accounts & joint holder notes or account title for active accounts"},{"name":"auditTrail","in":"query","type":"string","required":false,"description":"Contains additional information for user regarding the RTP during exceptional scenarios"},{"name":"action","in":"query","type":"string","required":false,"description":"Refers to view or cancel options."},{"name":"clearingSystem","in":"query","type":"string","required":false,"description":"The clearing system defined here will customize the funds transfer field specifications for BC transactions"},{"name":"intraCompanyPayment","in":"query","type":"string","required":false,"description":"Indicates whether the transaction is for first party payment."},{"name":"accountWithInstitutionCode","in":"query","type":"string","required":false,"description":"Contains the Business Identifier Code (BIC) of the account with institution."},{"name":"sendersCorrespondentCode","in":"query","type":"string","required":false,"description":"Contains the Business Identifier Code (BIC) of the sender correspondent institution."},{"name":"sendersCorrespondentAccount","in":"query","type":"string","required":false,"description":"Contains the National Clearing Code (NCC) or account number of the sender correspondent institution."},{"name":"intermediaryInstitutionCode","in":"query","type":"string","required":false,"description":"Contains the Business Identifier Code (BIC) of the intermediary institution."},{"name":"intermediaryAgent1ClearingSystemId","in":"query","type":"string","required":false,"description":"Contains the intermediary agent1 clearing system identification code"},{"name":"intermediaryAgent1ClearingMemberId","in":"query","type":"string","required":false,"description":"Contains the intermediary agent1 clearing member identifier"},{"name":"intermediaryAgent1LEI","in":"query","type":"string","required":false,"description":"Contains the Legal Entity Identifier for intermediary agent1"},{"name":"intermediaryInstitutionAccount","in":"query","type":"string","required":false,"description":"Contains the intermediate account which will be used to hold the funds if the bulk processing is set to receive only single debit or credit."},{"name":"intermediaryAgent1Name","in":"query","type":"string","required":false,"description":"Contains the name of intermediary agent1"},{"name":"intermediaryAgent1PostCode","in":"query","type":"string","required":false,"description":"Identifies the address postal code for the Intermediary Agent1."},{"name":"intermediaryAgent1Town","in":"query","type":"string","required":false,"description":"Contains the name of the town of the Intermediary Agent1."},{"name":"intermediaryAgent1Country","in":"query","type":"string","required":false,"description":"Identifies the country of the Intermediary Agent1."},{"name":"intermediaryAgent1Address","in":"query","type":"string","required":false,"description":"Contains the communication address of the Intermediary Agent1."},{"name":"intermediaryAgent2BIC","in":"query","type":"string","required":false,"description":"Contains the BIC value for intermediary agent2"},{"name":"intermediaryAgent2ClearingSystemId","in":"query","type":"string","required":false,"description":"Contains the intermediary agent2 clearing system identification code"},{"name":"intermediaryAgent2ClearingMemberId","in":"query","type":"string","required":false,"description":"Contains the intermediary agent2 clearing member identifier"},{"name":"intermediaryAgent2LEI","in":"query","type":"string","required":false,"description":"Contains the Legal Entity Identifier for intermediary agent2"},{"name":"intermediaryAgent2AccountNumber","in":"query","type":"string","required":false,"description":"Identifies the unique account Id of the Intermediary Agent2, for the payment entered."},{"name":"intermediaryAgent2Name","in":"query","type":"string","required":false,"description":"Contains the name of intermediary agent2"},{"name":"intermediaryAgent2PostCode","in":"query","type":"string","required":false,"description":"Identifies the address postal code for the Intermediary Agent2."},{"name":"intermediaryAgent2Town","in":"query","type":"string","required":false,"description":"Contains the name of the town of the Intermediary Agent2."},{"name":"intermediaryAgent2Country","in":"query","type":"string","required":false,"description":"Identifies the country of the Intermediary Agent2."},{"name":"intermediaryAgent2Address","in":"query","type":"string","required":false,"description":"Contains the communication address of the Intermediary Agent2."},{"name":"intermediaryAgent3BIC","in":"query","type":"string","required":false,"description":"Contains the BIC value for intermediary agent3"},{"name":"intermediaryAgent3ClearingSystemId","in":"query","type":"string","required":false,"description":"Contains the intermediary agent3 clearing system identification code"},{"name":"intermediaryAgent3ClearingMemberId","in":"query","type":"string","required":false,"description":"Contains the intermediary agent3 clearing member identifier"},{"name":"intermediaryAgent3LEI","in":"query","type":"string","required":false,"description":"Contains the Legal Entity Identifier for intermediary agent3"},{"name":"intermediaryAgent3AccountNumber","in":"query","type":"string","required":false,"description":"Identifies the unique account id of the Intermediary Agent3, for the payment entered."},{"name":"intermediaryAgent3Name","in":"query","type":"string","required":false,"description":"Contains the name of intermediary agent3"},{"name":"intermediaryAgent3PostCode","in":"query","type":"string","required":false,"description":"Identifies the address postal code for the Intermediary Agent3."},{"name":"intermediaryAgent3Town","in":"query","type":"string","required":false,"description":"Contains the name of the town of the Intermediary Agent3."},{"name":"intermediaryAgent3Country","in":"query","type":"string","required":false,"description":"Identifies the country of the Intermediary Agent3"},{"name":"intermediaryAgent3Address","in":"query","type":"string","required":false,"description":"Contains the communication address of the Intermediary Agent3."},{"name":"waiveDebitCharges","in":"query","type":"string","required":false,"description":"Indicates whether the debit side charges or fees can be waived or not."},{"name":"repairFee","in":"query","type":"string","required":false,"description":"Indicates whether there are any repair fees associated with this payment."},{"name":"debitChargeImposed","in":"query","type":"string","required":false,"description":"Indicates whether a charge has been provided to skip calculation of default charges."},{"name":"debitChargeComponent","in":"query","type":"string","required":false,"description":"Contains the type of charge that is to be debited. Multiple charges can be debited. For example, transaction fee, repair fee, etc."},{"name":"debitChargeCurrency","in":"query","type":"string","required":false,"description":"Contains the currency code of the charge that is to be debited."},{"name":"debitChargeAmount","in":"query","type":"string","required":false,"description":"Contains the charge amount that is to be debited."},{"name":"debitChargeAccountCompany","in":"query","type":"string","required":false,"description":"Contains the company code where the debit charge account is maintained."},{"name":"debitChargeAccount","in":"query","type":"string","required":false,"description":"The account from which the Charges will be debited"},{"name":"debitChargeAccountImposed","in":"query","type":"string","required":false,"description":"Indicates whether the debit charge account number is imposed on payment engine."},{"name":"debitChargeAccountCurrency","in":"query","type":"string","required":false,"description":"Contains the currency code of the debit charge account."},{"name":"outgoingReceiverCharge","in":"query","type":"string","required":false,"description":"Contains the outgoing receiver charge value."},{"name":"debitReceiverChargeImposed","in":"query","type":"string","required":false,"description":"Indicates whether the outgoing receiver charge is imposed on the payment engine."},{"name":"chargeOption","in":"query","type":"string","required":false,"description":"This field will hold the charge applicable for the order"},{"name":"percentageDebitAmount","in":"query","type":"string","required":false,"description":"This field specifies the negative tolerance relative to the documentary credit amount as a percentage."},{"name":"waiveCreditCharges","in":"query","type":"string","required":false,"description":"Indicates whether the credit side charges or fees can be waived or not."},{"name":"fee","in":"query","type":"string","required":false,"description":"The charge or fee collected for an account."},{"name":"creditChargeImposed","in":"query","type":"string","required":false,"description":"Indicates whether a charge has been provided  to skip calculation of default charges."},{"name":"creditChargeComponent","in":"query","type":"string","required":false,"description":"Contains the type of charge that is to be collected. Multiple charges can be credited. For example, transaction fee, repair fee, etc."},{"name":"creditChargeCurrency","in":"query","type":"string","required":false,"description":"Contains the currency code of the charge that is to be collected."},{"name":"creditChargeAmount","in":"query","type":"string","required":false,"description":"Contains the charge amount that is to be collected."},{"name":"creditChargeAccountCompany","in":"query","type":"string","required":false,"description":"Contains the company code where the charge account is maintained."},{"name":"creditChargeAccount","in":"query","type":"string","required":false,"description":"Contains the account number where the charges will be credited."},{"name":"creditChargeAccountImposed","in":"query","type":"string","required":false,"description":"Indicates whether the credit charge account number is imposed on the payment engine."},{"name":"creditChargeAccountCurrency","in":"query","type":"string","required":false,"description":"Contains the currency code of the charge account."},{"name":"incomingReceiverCharge","in":"query","type":"string","required":false,"description":"Contains incoming receivers charge."},{"name":"calculateCharge","in":"query","type":"string","required":false,"description":"Indicates whether charges will be calculated.  Allowed values: - YES - null (default)"},{"name":"percentageCreditAmount","in":"query","type":"string","required":false,"description":"Used to define the percentage to be added to the letter of credit amount (LC.AMOUNT) to calculate the full liability amount or maximum amount that can be drawn."},{"name":"aaChargeAccountType","in":"query","type":"string","required":false,"description":"Indicates whether arrangement charges are applicable to debit or credit main account."},{"name":"aaChargeAmount","in":"query","type":"string","required":false,"description":"Indicates the arrangement charge amount applicable for the account."},{"name":"taxAmount","in":"query","type":"string","required":false,"description":"Total amount of taxes applicable on all commission or charges calculated for the transaction/payment."},{"name":"taxCurrency","in":"query","type":"string","required":false,"description":"Contains the currency that tax is to be levied in. Example USD, GBP etc."},{"name":"taxIndicator","in":"query","type":"string","required":false,"description":"Indicates whether tax is computed for principal or charge amount"},{"name":"taxPartyIndicator","in":"query","type":"string","required":false,"description":"Indicates whether the taxes are applicable to the debit party or credit party or both."},{"name":"taxType","in":"query","type":"string","required":false,"description":"Indicates the tax identification type for the customer, ex-SSN, TIN, FTIN etc."},{"name":"inExchangeRate","in":"query","type":"string","required":false,"description":"Specifies the exchange rate applicable between the Local Currency and the Portfolio Reference Currency of the portfolio that the position has been transferred in to"},{"name":"debitExchangeRateImposed","in":"query","type":"string","required":false,"description":"Indicates whether the debit exchange rate is imposed."},{"name":"outExchangeRate","in":"query","type":"string","required":false,"description":"Specifies the exchange rate applicable between the Local Currency and the Portfolio Reference Currency of the portfolio from where the position has been transferred out"},{"name":"creditExchangeRateImposed","in":"query","type":"string","required":false,"description":"Indicates whether the credit exchange rate is imposed on the payment engine."},{"name":"debitCustomerSpread","in":"query","type":"string","required":false,"description":"Contains customers exchange spread which is applied to the treasury rate to generate the applicable exchange rate."},{"name":"debitCustomerSpreadImposed","in":"query","type":"string","required":false,"description":"Indicates whether the debit customer spread is imposed on the payment engine."},{"name":"creditCustomerSpread","in":"query","type":"string","required":false,"description":"Contains the customer exchange spread to be applied."},{"name":"creditCustomerSpreadImposed","in":"query","type":"string","required":false,"description":"Indicates whether the value for credit customer spread is imposed on the payment engine."},{"name":"debitTreasuryRate","in":"query","type":"string","required":false,"description":"Contains the rate at which the treasury unit will buy or sell foreign currency from or to the marketing units. Final customer rate will be determined by the addition or subtraction of the appropriate "},{"name":"debitTreasuryRateImposed","in":"query","type":"string","required":false,"description":"Indicates whether the value for debit treasury rate is imposed on payment engine."},{"name":"creditTreasuryRate","in":"query","type":"string","required":false,"description":"Contains the rate at which treasury unit will buy or sell foreign currency from or to the marketing units. Final customer rate will be determined by the addition or subtraction of the appropriate cust"},{"name":"creditTreasuryRateImposed","in":"query","type":"string","required":false,"description":"Indicates whether the credit treasury rate is imposed on the payment engine."},{"name":"debitExchangeRateReference","in":"query","type":"string","required":false,"description":"Contains the treasury contract number which relates to the buy of a foreign currency by the treasury department."},{"name":"creditExchangeRateReference","in":"query","type":"string","required":false,"description":"Contains the treasury contract number which relates to the buy of a foreign currency by the treasury department."},{"name":"orderPartyTagOption","in":"query","type":"string","required":false,"description":"Indicates order entry mode for outgoing credit transfer payments."},{"name":"beneficiaryId","in":"query","type":"string","required":false,"description":"Indicates the reference of the financial institution that allows access to the beneficiary information"},{"name":"orderingAccount","in":"query","type":"string","required":false,"description":"Contains the National Clearing Code (NCC) or account number of the ordering party."},{"name":"beneficiaryAccountId","in":"query","type":"string","required":false,"description":"Unique account identifier of the beneficiary account number."},{"name":"orderingBIC","in":"query","type":"string","required":false,"description":"Contains the Business Identfier Code (BIC) of the ordering party."},{"name":"partyIdentifier","in":"query","type":"string","required":false,"description":"Specifies the identifier of a party."},{"name":"orderingName","in":"query","type":"string","required":false,"description":"Ordering customer name details"},{"name":"beneficiaryName","in":"query","type":"string","required":false,"description":"Short title or short name of the beneficiary"},{"name":"debtorAgentStreetName","in":"query","type":"string","required":false,"description":"Contains the name of a street or thoroughfare of a debtor agent."},{"name":"creditorAgentStreetName","in":"query","type":"string","required":false,"description":"Contains the name of a street or thoroughfare of a creditor agent."},{"name":"debtorBuildingNumber","in":"query","type":"string","required":false,"description":"Identifies the building number where debtor resides"},{"name":"creditorBuildingNumber","in":"query","type":"string","required":false,"description":"Identifies the building number where creditor resides"},{"name":"debtorBuildingName","in":"query","type":"string","required":false,"description":"Identifies the name of the building where debtor resides"},{"name":"creditorBuildingName","in":"query","type":"string","required":false,"description":"Identifies the name of the building where creditor resides"},{"name":"debtorPostCode","in":"query","type":"string","required":false,"description":"Identifies the address postal code for the debtor"},{"name":"creditorPostCode","in":"query","type":"string","required":false,"description":"Identifies the address postal code for the creditor"},{"name":"town","in":"query","type":"string","required":false,"description":"Contains the town associated with the address of the customer or property"},{"name":"townCity","in":"query","type":"string","required":false,"description":"Specifies town name of the Ultimate Creditor"},{"name":"debtorCountryCode","in":"query","type":"string","required":false,"description":"Debtor country code details"},{"name":"beneficiaryCountryCode","in":"query","type":"string","required":false,"description":"Creditor country code details"},{"name":"orderingPartyResidentType","in":"query","type":"string","required":false,"description":"Indicates the Resident type of the Ordering party."},{"name":"residenceName","in":"query","type":"string","required":false,"description":"Name of the residence country."},{"name":"vatDebitMainAmountIndicator","in":"query","type":"string","required":false,"description":"Indicates whether the value for Value Added Tax (VAT) debit main amount percentage will overwrite the defined or derived value from the payment engine. Possibe values are yes and blank."},{"name":"vatCreditMainAmountIndicator","in":"query","type":"string","required":false,"description":"Indicates whether the value for Value Added Tax (VAT) credit main amount percentage will overwrite the defined or derived value from the payment engine. Possible values are yes and blank."},{"name":"vatDebitMainAmountPercentage","in":"query","type":"string","required":false,"description":"Contains the Value Added Tax (VAT) percentage on debit main amount."},{"name":"vatCreditMainAmountPercentage","in":"query","type":"string","required":false,"description":"Contains the Value Added Tax (VAT) percentage on credit main amount."},{"name":"paymentReturnType","in":"query","type":"string","required":false,"description":"Indicates partial or incomplete type of payment return."},{"name":"returnOrRejectOriginatedBy","in":"query","type":"string","required":false,"description":"Identifies whether the return or rejection was originated by the bank or by the debtor."},{"name":"accountWithInstitutionLEI","in":"query","type":"string","required":false,"description":"Contains the Legal Entity Identifier for account with institution"},{"name":"accountWithInstitutionAccount","in":"query","type":"string","required":false,"description":"Contains the National Clearing Code (NCC) or account number of the account with institution."},{"name":"accountWithInstitutionClearingMemberId","in":"query","type":"string","required":false,"description":"Contains the account with institution clearing member identifier"},{"name":"accountWithClearingCode","in":"query","type":"string","required":false,"description":"Contains the ISO clearing system code of the account with institution."},{"name":"accountWithBankName","in":"query","type":"string","required":false,"description":"Indicates name of the beneficiary bank"},{"name":"accountWithInstitutionpostCode","in":"query","type":"string","required":false,"description":"Identifies the address postal code for the account with institution."},{"name":"accountWithInstitutiontown","in":"query","type":"string","required":false,"description":"Contains the name of the town of the ordering Institution."},{"name":"accountWithInstitutioncountry","in":"query","type":"string","required":false,"description":"Identifies the country of the account with institution."},{"name":"accountWithInstitutionAddress","in":"query","type":"string","required":false,"description":"Contains the additional address lines of the account with institution."},{"name":"orderingInstitutionCode","in":"query","type":"string","required":false,"description":"Contains the Business Identifier Code (BIC) of the ordering institution."},{"name":"orderingInstitutionLEI","in":"query","type":"string","required":false,"description":"Contains the Legal Entity Identifier for ordering institution"},{"name":"orderingInstitutionAccount","in":"query","type":"string","required":false,"description":"Contains the National Clearing Code (NCC) or account number of the ordering institution."},{"name":"orderingInstitutionClearingMemberId","in":"query","type":"string","required":false,"description":"Contains the ordering institution clearing member identifier"},{"name":"orderingInstitutionClearingSystemId","in":"query","type":"string","required":false,"description":"Contains the ordering institution clearing system identification code"},{"name":"institutionName","in":"query","type":"string","required":false,"description":"Indicates the name of the institution"},{"name":"orderingInstitutionpostCode","in":"query","type":"string","required":false,"description":"Identifies the address postal code for the ordering Institution."},{"name":"originatorTownName","in":"query","type":"string","required":false,"description":"Indicates the originator town name. Originator is the party who requests the payment cancellation. It accepts free text which can be of alphanumeric characters."},{"name":"orderingInstitutioncountry","in":"query","type":"string","required":false,"description":"Identifies the country of the ordering institution."},{"name":"orderingInstitutionAddress","in":"query","type":"string","required":false,"description":"Contains any additional address lines of the ordering institution."},{"name":"sendersCorrespondentLEI","in":"query","type":"string","required":false,"description":"Contains the Legal Entity Identifier for sender's correspondent"},{"name":"sendersCorrespondentClearingMemberId","in":"query","type":"string","required":false,"description":"Contains the sender's correspondent clearing member identifier"},{"name":"sendersCorrespondentClearingSystemId","in":"query","type":"string","required":false,"description":"Contains the sender's correspondent clearing system identification code"},{"name":"sendersCorrespondentName","in":"query","type":"string","required":false,"description":"Contains the name of sender's correspondent"},{"name":"sendersCorrespondentPostCode","in":"query","type":"string","required":false,"description":"Identifies the address postal code for the sender's correspondent."},{"name":"sendersCorrespondentTown","in":"query","type":"string","required":false,"description":"Contains the name of the town of the sender's correspondent."},{"name":"sendersCorrespondentCountry","in":"query","type":"string","required":false,"description":"Identifies the country of the sender's correspondent"},{"name":"sendersCorrespondentAddress","in":"query","type":"string","required":false,"description":"Contains additional address lines of the sender correspondent institution."},{"name":"receiversCorrespondentCode","in":"query","type":"string","required":false,"description":"Contains Business Identfier Code (BIC) of the receiver correspondent institution."},{"name":"receiversCorrespondentLEI","in":"query","type":"string","required":false,"description":"Contains the Legal Entity Identifier for receiver's correspondent"},{"name":"receiversCorrespondentAccount","in":"query","type":"string","required":false,"description":"Contains National Clearing Code (NCC) or account number of the receiver correspondent institution."},{"name":"receiversCorrespondentClearingMemberId","in":"query","type":"string","required":false,"description":"Contains the receiver's correspondent clearing member identifier"},{"name":"receiversCorrespondentClearingSystemId","in":"query","type":"string","required":false,"description":"Contains the receiver's correspondent clearing system identification code"},{"name":"receiversCorrespondentName","in":"query","type":"string","required":false,"description":"Contains the name of receiver's correspondent"},{"name":"receiversCorrespondentPostCode","in":"query","type":"string","required":false,"description":"Identifies the address postal code for the receiver's correspondent."},{"name":"receiversCorrespondentTown","in":"query","type":"string","required":false,"description":"Contains the name of the town of the receiver's correspondent."},{"name":"receiversCorrespondentCountry","in":"query","type":"string","required":false,"description":"Identifies the country of the receiver's correspondent"},{"name":"receiversCorrespondentAddress","in":"query","type":"string","required":false,"description":"Contains additional address lines of the receiver correspondent institution."},{"name":"thirdReimburseInstitutionCode","in":"query","type":"string","required":false,"description":"Contains Business Identifier Code (BIC) of the third reimbursement institution."},{"name":"thirdReimbursementAgentLEI","in":"query","type":"string","required":false,"description":"Contains the Legal Entity Identifier for third reimbursement agent"},{"name":"thirdReimburseInstitutionAccount","in":"query","type":"string","required":false,"description":"Contains National Clearing Code (NCC) or account number of the third reimbursement institution."},{"name":"thirdReimbursementAgentClearingMemberId","in":"query","type":"string","required":false,"description":"Contains the third reimbursement agent clearing member identifier"},{"name":"thirdReimbursementAgentClearingSystemId","in":"query","type":"string","required":false,"description":"Contains the third reimbursement agent clearing system identification code"},{"name":"thirdReimbursementAgentName","in":"query","type":"string","required":false,"description":"Contains the name of third reimbursement agent"},{"name":"thirdReimbursementAgentPostCode","in":"query","type":"string","required":false,"description":"Identifies the address postal code for the third reimbursement agent."},{"name":"thirdReimbursementAgentTown","in":"query","type":"string","required":false,"description":"Contains the name of the town of the third reimbursement agent."},{"name":"thirdReimbursementAgentCountry","in":"query","type":"string","required":false,"description":"Identifies the country of the third reimbursement agent"},{"name":"thirdReimburseInstitutionAddress","in":"query","type":"string","required":false,"description":"Contains additional address lines of the third reimbursement institution."},{"name":"structure","in":"query","type":"string","required":false,"description":"Contains the information supplied to enable the reconciliation of an entry with the items that the payment is intended to settle, such as commercial invoices in an accounts' receivable system, in a st"},{"name":"referredDocumentInfoTypeCode","in":"query","type":"string","required":false,"description":"Specifies the type of referred documentation a coded form such as CINV - Commercial Invoice, CREN - CreditNote,etc."},{"name":"referredDocumentInfoNumber","in":"query","type":"string","required":false,"description":"Contains the unique and unambiguous identification of the referred document"},{"name":"referredDocumentCreditNoteAmount","in":"query","type":"string","required":false,"description":"Contains the details on the credit note amount specified for the referred document"},{"name":"referredDocumentRemittedAmount","in":"query","type":"string","required":false,"description":"Contains the details on the amount of money remitted for the referred document."},{"name":"referredDocumentRemittedAmountCurrency","in":"query","type":"string","required":false,"description":"Contains the details on the currency of the remitted amount"},{"name":"creditorReferenceCode","in":"query","type":"string","required":false,"description":"Contains the reference information code provided by the creditor to identify underlying documents."},{"name":"creditorReferenceInformationProprietary","in":"query","type":"string","required":false,"description":"Contains the reference information provided by the creditor to identify underlying documents in proprietary form."},{"name":"creditorReferenceIssuer","in":"query","type":"string","required":false,"description":"Contains a reference to the entity which assigns the credit reference type in credit transfer payments."},{"name":"creditorReference","in":"query","type":"string","required":false,"description":"1) The real or unique creditor reference for which the structured creditor reference need to be generated if the refOption is GENERATE. 2) The structured creditor reference for which the validation sh"},{"name":"additionalRemittanceInformation1","in":"query","type":"string","required":false,"description":"Contains line 1 of additional information in free text form, to complement the structured remittance information"},{"name":"additionalRemittanceInformation2","in":"query","type":"string","required":false,"description":"Contains line 2 of additional information in free text form, to complement the structured remittance information"},{"name":"additionalRemittanceInformation3","in":"query","type":"string","required":false,"description":"Contains line 3 of additional information in free text form, to complement the structured remittance information"},{"name":"previousInstructingAgent1BIC","in":"query","type":"string","required":false,"description":"Indicates the BIC values of the previous payment instructing agent 1 in the payment chain"},{"name":"previousInstructingAgent1LEI","in":"query","type":"string","required":false,"description":"Contains the Legal Entity Identifier for previous instructing agent1"},{"name":"previousInstructingAgent1AccountNumber","in":"query","type":"string","required":false,"description":"Identifies the unique account id of the Previous Instructing Agent1, for the payment entered."},{"name":"previousInstructingAgent1Name","in":"query","type":"string","required":false,"description":"Contains the name of previous instructing agent1"},{"name":"previousInstructingAgent1PostCode","in":"query","type":"string","required":false,"description":"Identifies the address postal code for the Previous Instructing Agent1."},{"name":"previousInstructingAgent1Town","in":"query","type":"string","required":false,"description":"Contains the name of the town of the Previous Instructing Agent1."},{"name":"previousInstructingAgent1Country","in":"query","type":"string","required":false,"description":"Identifies the country of the Previous Instructing Agent1."},{"name":"previousInstructingAgent1Address","in":"query","type":"string","required":false,"description":"Contains the communication address of the Previous Instructing Agent1."},{"name":"previousInstructingAgent2BIC","in":"query","type":"string","required":false,"description":"Contains BIC value for previous instructing agent2"},{"name":"previousInstructingAgent2LEI","in":"query","type":"string","required":false,"description":"Contains Legal Entity Identifier for previous instructing agent2"},{"name":"previousInstructingAgent2AccountNumber","in":"query","type":"string","required":false,"description":"Identifies the unique account id of the Previous Instructing Agent2, for the payment entered."},{"name":"previousInstructingAgent2Name","in":"query","type":"string","required":false,"description":"Contains name of previous instructing agent2"},{"name":"previousInstructingAgent2PostCode","in":"query","type":"string","required":false,"description":"Identifies the address postal code for the Previous Instructing Agent2."},{"name":"previousInstructingAgent2Town","in":"query","type":"string","required":false,"description":"Contains the name of the town of the Previous Instructing agent2."},{"name":"previousInstructingAgent2Country","in":"query","type":"string","required":false,"description":"Identifies the country of the Previous Instructing Agent2."},{"name":"previousInstructingAgent2Address","in":"query","type":"string","required":false,"description":"Contains the communication address of the Previous Instructing Agent2."},{"name":"previousInstructingAgent3BIC","in":"query","type":"string","required":false,"description":"Contains BIC value for previous instructing agent3"},{"name":"previousInstructingAgent3LEI","in":"query","type":"string","required":false,"description":"Contains Legal Entity Identifier for previous instructing agent3"},{"name":"previousInstructingAgent3AccountNumber","in":"query","type":"string","required":false,"description":"Identifies the unique account id of the Previous Instructing Agent3, for the payment entered."},{"name":"previousInstructingAgent3Name","in":"query","type":"string","required":false,"description":"Contains the name of previous instructing agent3"},{"name":"previousInstructingAgent3PostCode","in":"query","type":"string","required":false,"description":"Identifies the address postal code for the Previous Instructing Agent3."},{"name":"previousInstructingAgent3Town","in":"query","type":"string","required":false,"description":"Contains the name of the town of the Previous Instructing Agent3."},{"name":"previousInstructingAgent3Country","in":"query","type":"string","required":false,"description":"Identifies the country of the Previous Instructing Agent3."},{"name":"previousInstructingAgent3Address","in":"query","type":"string","required":false,"description":"Contains the communication address of the Previous Instructing Agent3."},{"name":"regulatorydebtorCreditorReporting","in":"query","type":"string","required":false,"description":"identifies whether the regulatory reporting information applies to the debit side, to the credit side or to both sides of the transaction"},{"name":"regulatoryReportingAuthorityName","in":"query","type":"string","required":false,"description":"Contains the name of regulatory reporting authority"},{"name":"regulatoryReportingAuthorityCountry","in":"query","type":"string","required":false,"description":"Contains the regulatory reporting authority country"},{"name":"relation","in":"query","type":"string","required":false,"description":"Identifies the inter-relationship between customer with other customers"},{"name":"type","in":"query","type":"string","required":false,"description":"The product condition has an activity type associated that drives an action."},{"name":"date","in":"query","type":"string","required":false,"description":"Indicates the date on which activity was performed"},{"name":"regulatoryReportingAuthorityCountryCode","in":"query","type":"string","required":false,"description":"Contains the regulatory reporting authority country code."},{"name":"code","in":"query","type":"string","required":false,"description":"The identifier of the error message"},{"name":"amount","in":"query","type":"string","required":false,"description":"Contains the direct debit claim amount"},{"name":"regulatoryReportingAmountCurrency","in":"query","type":"string","required":false,"description":"Contains the regulatory reporting amount currency"},{"name":"regulatoryReportText","in":"query","type":"string","required":false,"description":"Contains the details that will be mapped in SWIFT messages for regulatory reports"},{"name":"instructionCode","in":"query","type":"string","required":false,"description":"Contains the instruction code for the payment."},{"name":"settlementDate","in":"query","type":"string","required":false,"description":"Indicates the settlement date of the payment transaction"},{"name":"chequeDate","in":"query","type":"string","required":false,"description":"Contains the date on which the cheque was issued"},{"name":"sendersReferenceOutgoing","in":"query","type":"string","required":false,"description":"Deprecated - sender reference outgoing"},{"name":"instructedCurrencyCode","in":"query","type":"string","required":false,"description":"Instructed currency code details"},{"name":"instructedAmount","in":"query","type":"string","required":false,"description":"Specifies the amount which is allocated or instructed for the account reference included in the selection for a specific transaction."},{"name":"receiverInstitutionBIC","in":"query","type":"string","required":false,"description":"Contains the Bank Identifier Code(BIC) of the bank which is receiving the information request."},{"name":"senderInstitutionNcc","in":"query","type":"string","required":false,"description":"Contains the unique identifier(within a clearing system) or National Clearing Code (NCC) of the bank which is sending the information request."},{"name":"senderClearingSystemId","in":"query","type":"string","required":false,"description":"Contains the ISO clearing system code of sender financial institution"},{"name":"balanceReservation","in":"query","type":"string","required":false,"description":"Contains the nature of the balance reservation received from channel. For example, C (Channel has already done the reservation), S (Skipped)."},{"name":"balanceReservationReference","in":"query","type":"string","required":false,"description":"Contains the balance reservation reference received from channel or an external system."},{"name":"balanceReservationChargeAccount","in":"query","type":"string","required":false,"description":"Contains the balance reservation reference of the debit charge account."},{"name":"preAuthorizationReference","in":"query","type":"string","required":false,"description":"Contains the pre authorization reference for manually authorized funds."},{"name":"contractId","in":"query","type":"string","required":false,"description":"The contract reference of the associated fiduciary placement"},{"name":"debitAccountNumberBIC","in":"query","type":"string","required":false,"description":"Contains the bank identification code of the debit party"},{"name":"BIC","in":"query","type":"string","required":false,"description":"The BIC code of the Beneficiary bank"},{"name":"instructionIdentification","in":"query","type":"string","required":false,"description":"Contains the instruction reference"},{"name":"nickName","in":"query","type":"string","required":false,"description":"Nickname of the beneficiary"},{"name":"receiverMemberId","in":"query","type":"string","required":false,"description":"Contains the ISO clearing member identifier of receiver financial institution"},{"name":"senderClearingMemberId","in":"query","type":"string","required":false,"description":"Contains the sender clearing member identifier to identify it as a member within a clearing system"},{"name":"remittanceInformation","in":"query","type":"string","required":false,"description":"Indicates the remittance information that is supplied to enable the matching/reconciliation of an entry with the items that the payment is intended to settle, such as commercial invoices in an account"},{"name":"clearingTransactionType","in":"query","type":"string","required":false,"description":"Indicates the Clearing transaction type."},{"name":"chequeNumber","in":"query","type":"string","required":false,"description":"Cheque number associated with the transaction or accounting entry."},{"name":"transactionref","in":"query","type":"string","required":false,"description":"Deprecated - Transaction reference"},{"name":"chargeType","in":"query","type":"string","required":false,"description":"Indicates the charge types which are applicable for the transaction. Example: CORRBKCHG"},{"name":"optionIndicator","in":"query","type":"string","required":false,"description":"This holds the indicator of  option for the corporate action event and should be as per swift standards."},{"name":"beneficiaryClearingSystemId","in":"query","type":"string","required":false,"description":"Indicates the beneficiary clearing system identification code"},{"name":"beneficiaryClearingMemberId","in":"query","type":"string","required":false,"description":"Indicates the beneficiary clearing system member identifier"},{"name":"messageContent","in":"query","type":"string","required":false,"description":"It indicates whether only the current information or previous and current information needs to be passed to form the message."},{"name":"mandateId","in":"query","type":"string","required":false,"description":"Contains the mandatory SEPA(Single Euro Payment Area) payment identifier from the transaction"},{"name":"signatureDate","in":"query","type":"string","required":false,"description":"The date when the document was signed"},{"name":"mandateAmendmentIndicator","in":"query","type":"string","required":false,"description":"Indicates if the amended mandate details mentioned as part of the direct debit collection must be reflected in the DD management system when the DD is successfully processed."},{"name":"originalMandateId","in":"query","type":"string","required":false,"description":"Contains the original emandate ID of the eMandate to be amended."},{"name":"mandate","in":"query","type":"string","required":false,"description":"Contains mandate details of an account"},{"name":"creditorMandateId","in":"query","type":"string","required":false,"description":"Contains the creditor mandate identifier"},{"name":"mandateScheme","in":"query","type":"string","required":false,"description":"The Payment scheme and service level under which the mandate can be used (e.g SEPA*CORE)"},{"name":"creditAccountIBAN","in":"query","type":"string","required":false,"description":"Indicates the IBAN of the credit account"},{"name":"financialCompany","in":"query","type":"string","required":false,"description":"Indicates the financial lead company of the bank."},{"name":"electronicMandateCheck","in":"query","type":"string","required":false,"description":"Indicates whether electronic mandates are accepted by beneficiary bank"},{"name":"creditorOtherId","in":"query","type":"string","required":false,"description":"Contains the other identification of the requestor, it could be an alias or proxy or merchant category code."},{"name":"debtorOtherId","in":"query","type":"string","required":false,"description":"Contains other debtor identifier, example: passport number, driving license number."},{"name":"ultimateDebtorName","in":"query","type":"string","required":false,"description":"Contains the name of the ultimate debit party that owes an amount of money to the ultimate creditor."},{"name":"ultimateDebtorBIC","in":"query","type":"string","required":false,"description":"Contains the Business Identifier Code (BIC) of the ultimate debit party in case the ultimate debit party is an organisation."},{"name":"ultimateDebtorOrganisationId","in":"query","type":"string","required":false,"description":"Contains the unique identification of the organisation, as assigned by the institution, using an identification scheme when the ultimate debit party is an organisation."},{"name":"ultimateDebtorOrganisationSchemeCode","in":"query","type":"string","required":false,"description":"Contains the name of the identification scheme of the ultimate debit party in a coded format when the ultimate debit party is an organisation. For example, BANK (bank party identification), EMPL (empl"},{"name":"ultimateDebtorOrganisationSchemeName","in":"query","type":"string","required":false,"description":"Contains the name of the identification scheme of the ultimate debit party in a free text format when the ultimate debit party is an organisation."},{"name":"ultimateDebtorOrganisationIssuer","in":"query","type":"string","required":false,"description":"Contains the entity of the ultimate debit party who assigns the identification when the ultimate debit party is an organisation."},{"name":"ultimateDebtorBirthDate","in":"query","type":"string","required":false,"description":"Contains the birth date of the ultimate debit party in case the party is an individual."},{"name":"ultimateDebtorProvinceOfBirth","in":"query","type":"string","required":false,"description":"Contains the province of birth of the ultimate debit party in case the party is an individual."},{"name":"ultimateDebtorCityOfBirth","in":"query","type":"string","required":false,"description":"Contains the city of birth of the ultimate debit party in case the party is an individual."},{"name":"ultimateDebtorCountryOfBirth","in":"query","type":"string","required":false,"description":"Contains the country of birth of the ultimate debit party in case the party is an individual."},{"name":"ultimateDebtorPrivateReference","in":"query","type":"string","required":false,"description":"Contains the unique identification of the ultimate debit party as a person, as assigned by his institution, using identificaiton scheme. For example, the identification could be passport number or dri"},{"name":"ultimateDebtorPrivateSchemeCode","in":"query","type":"string","required":false,"description":"Contains the external person identification scheme name code of the ultimate debit party as a person. For example, CCPT (passport number), DRLC (drivers license number)."},{"name":"ultimateDebtorPrivateSchemeName","in":"query","type":"string","required":false,"description":"Contains the name of the identification scheme of the ultimate debit party as an individual."},{"name":"ultimateDebtorPrivateIssuer","in":"query","type":"string","required":false,"description":"Contains the entity of the ultimate debit party who assigns the identification when the ultimate debit party is an individual."},{"name":"ultimateDebtorAddressLine","in":"query","type":"string","required":false,"description":"Contains the address line of ultimate debit party."},{"name":"ultimateDebtorCountry","in":"query","type":"string","required":false,"description":"Contains the country of ultimate debit party."},{"name":"ultimateCreditorName","in":"query","type":"string","required":false,"description":"Contains the name of the ultimate creditor"},{"name":"ultimateCreditorBic","in":"query","type":"string","required":false,"description":"Contains ultimate creditor Business Identifier Code (BIC) or Business Entity Identifier (BEI) if any, When ultimate creditor is an organisation."},{"name":"ultimateCreditorOtherId","in":"query","type":"string","required":false,"description":"This is the other identifier of ultimate creditor, e.g. could be a Social Security Number, a Tax Identification Number, Passport Number, a Clearing Id etc."},{"name":"ultimateCreditorSchemeCode","in":"query","type":"string","required":false,"description":"This indicates the scheme code for the ultimate creditor"},{"name":"ultimateCreditorSchemeProprietary","in":"query","type":"string","required":false,"description":"The proprietary code of the scheme which issued the identifier for the ultimate creditor"},{"name":"ultimateCreditorSchemeIssuer","in":"query","type":"string","required":false,"description":"Indicates the issuer of other id of the ultimate creditor"},{"name":"ultimateCreditorBirthDate","in":"query","type":"string","required":false,"description":"Contains the date of birth of ultimate creditor"},{"name":"ultimateCreditorBirthProvince","in":"query","type":"string","required":false,"description":"It indicates the place of birth for ultimate creditor"},{"name":"ultimateCreditorBirthCity","in":"query","type":"string","required":false,"description":"It indicates the birth city of ultimate creditor"},{"name":"ultimateCreditorBirthCountry","in":"query","type":"string","required":false,"description":"It indicates the country of birth for the ultimate creditor"},{"name":"ultimateCreditorPrivateId","in":"query","type":"string","required":false,"description":"Contains the unique identification of the ultimate credit party as a person, as assigned by his institution, using identificaiton scheme."},{"name":"ultimateCreditorPrivateSchemeCode","in":"query","type":"string","required":false,"description":"Contains the external person identification scheme name code of the ultimate credit party as a person."},{"name":"ultimateCreditorPrivateSchemeName","in":"query","type":"string","required":false,"description":"Contains the name of the identification scheme of the ultimate credit party as an individual."},{"name":"ultimateCreditorPrivateIssuer","in":"query","type":"string","required":false,"description":"Contains the entity which assigns the identification for ultimate credit party when the ultimate credit party is an individual."},{"name":"ultimateCreditorAddressLine","in":"query","type":"string","required":false,"description":"It specifies the address fields to be used for the Ultimate creditor of payment"},{"name":"ultimateCreditorCountry","in":"query","type":"string","required":false,"description":"It specifies the Country of Ultimate creditor of payment"},{"name":"originalTransactionReference","in":"query","type":"string","required":false,"description":"Identifies the Original Transaction Reference that created the Funds Authorisation request"},{"name":"ultimateCreditorDepartment","in":"query","type":"string","required":false,"description":"Indicates department of the ultimate creditor"},{"name":"ultimateCreditorSubDepartment","in":"query","type":"string","required":false,"description":"Indicates sub department of the ultimate creditor"},{"name":"ultimateCreditorStreetAddress","in":"query","type":"string","required":false,"description":"Indicates street of the ultimate creditor"},{"name":"ultimateCreditorbuildingNumber","in":"query","type":"string","required":false,"description":"Indicates building number of the ultimate creditor"},{"name":"ultimateCreditorbuildingName","in":"query","type":"string","required":false,"description":"Indicates building name of the ultimate creditor"},{"name":"ultimateCreditorFloor","in":"query","type":"string","required":false,"description":"Indicates building floor of the ultimate creditor"},{"name":"ultimateCreditorPostBoxNumber","in":"query","type":"string","required":false,"description":"Indicates post box number of the ultimate creditor"},{"name":"ultimateCreditorRoom","in":"query","type":"string","required":false,"description":"Contains the room number of ultimate creditor's residing building"},{"name":"ultimateCreditorPostCode","in":"query","type":"string","required":false,"description":"Indicates the postal code of the ultimate creditor"},{"name":"ultimateCreditorTownName","in":"query","type":"string","required":false,"description":"Indicates town name of the ultimate creditor"},{"name":"ultimateCreditorTownLocation","in":"query","type":"string","required":false,"description":"Indicates town location of the ultimate creditor"},{"name":"ultimateCreditorDistrictName","in":"query","type":"string","required":false,"description":"Indicates district name of the ultimate creditor"},{"name":"ultimateCreditorCountrySubDivision","in":"query","type":"string","required":false,"description":"Indicates country subdivision of the ultimate creditor"},{"name":"ultimateCreditorResidenceName","in":"query","type":"string","required":false,"description":"Contains the name of the residence country of the ultimate creditor."},{"name":"ultimateCreditorLEI","in":"query","type":"string","required":false,"description":"Contains the Legal Entity Identifier of ultimate creditor"},{"name":"ultimateDebtorDepartmentId","in":"query","type":"string","required":false,"description":"Identifier of the department of ultimate debtor."},{"name":"ultimateDebtorSubDepartmentId","in":"query","type":"string","required":false,"description":"Contains the sub-division identifier of a large organisation or building, of the ultimate debtor."},{"name":"ultimateDebtorStreetName","in":"query","type":"string","required":false,"description":"Indicates the ultimate debtor's street name or thoroughfare"},{"name":"ultimateDebtorBuildingNumber","in":"query","type":"string","required":false,"description":"Identifies the building number where the ultimate debtor resides"},{"name":"ultimateDebtorBuildingName","in":"query","type":"string","required":false,"description":"Identifies the name of the building where the ultimate debtor resides"},{"name":"ultimateDebtorFloorNumber","in":"query","type":"string","required":false,"description":"Contains the floor number of the ultimate debtor address"},{"name":"ultimateDebtorPostBoxNumber","in":"query","type":"string","required":false,"description":"Contains the Post Office Box (POB) number that relates to the ultimate debtor financial institution"},{"name":"ultimateDebtorRoom","in":"query","type":"string","required":false,"description":"Contains the room number of ultimate debtor's residing building"},{"name":"ultimateDebtorPostCode","in":"query","type":"string","required":false,"description":"Identifies the address postal code for the ultimate debtor."},{"name":"ultimateDebtorPayerTownName","in":"query","type":"string","required":false,"description":"Contains the name of the town of the ultimate debtor."},{"name":"ultimateDebtorTownLocation","in":"query","type":"string","required":false,"description":"Indicates the town location of the ultimate debtor"},{"name":"ultimateDebtorDistrictName","in":"query","type":"string","required":false,"description":"Contains the district name of the ultimate debtor."},{"name":"ultimateDebtorCountrySubDivision","in":"query","type":"string","required":false,"description":"Contains the country subdivision of ultimate debtor such as state, region, county"},{"name":"ultimateDebtorResidenceName","in":"query","type":"string","required":false,"description":"Contains the name of the residence country of the ultimate debtor."},{"name":"ultimateDebtorLEI","in":"query","type":"string","required":false,"description":"Contains the Legal Entity Identifier of ultimate debtor"},{"name":"id","in":"query","type":"string","required":false,"description":"Contains the daily position class id."},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"OrderEntryResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}}]},{"key":"order-payments-summary-v1.0.0","title":"Payments Summary","version":"v1.0.0","description":"Retrieves details of a specific transaction or file","endpointCount":1,"endpoints":[{"method":"GET","path":"/order/payments/transactions/summary","fullPath":"/api/v1.0.0/order/payments/transactions/summary","operationId":"getPaymentTransactionSummary","name":"Retrieves the details of a specific transaction/file. The details returned may include the payment id, order id, file reference when received via a file, processing date, value date, transfer type, currency, amount, source from where the payment is received, sender, receiver, status, priority, direction, charge details, output channel to which the payment is sent and other relevant details.","summary":"Retrieves details of a specific transaction/file\u00c2\u00a0","tags":["OTHERS"],"parameters":[{"name":"company","in":"query","type":"string","required":false,"description":"The company code"},{"name":"transactionRef","in":"query","type":"string","required":false,"description":"Deprecated - Transaction reference"},{"name":"queueName","in":"query","type":"string","required":false,"description":"For queue to queue configuration this field can be used to specify appropriate queue name with a prefix as CFNAME-queueName."},{"name":"queryId","in":"query","type":"string","required":false,"description":"The query identifier"},{"name":"messageId","in":"query","type":"string","required":false,"description":"The holds the record key of the message ID."},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"PaymentTransactionSummaryResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}}]},{"key":"order-paymentsConfiguration-service-v1.0.0","title":"Payments Configuration","version":"v1.0.0","description":"API to manage the Payments settings related to local clearing payments","endpointCount":3,"endpoints":[{"method":"PUT","path":"/order/payments/localClearings/{systemId}","fullPath":"/api/v1.0.0/order/payments/localClearings/{systemId}","operationId":"updateLocalClearing","name":"Update the parameters required by Funds Transfer for control of local clearing payments. This parameters will be used for BC, BI and BD transaction types within FUNDS.TRANSFER.","summary":"Update local clearing parameters","tags":[],"parameters":[{"name":"systemId","in":"path","type":"string","required":true,"description":"The system application identifier that could be used as entry reference or used as prefix in unique transaction identifiers"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"clearingTypes":[{}],"clearingSystem":"string"}},"responses":{"200":"LocalClearingResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/order/payments/parameters/{companyId}","fullPath":"/api/v1.0.0/order/payments/parameters/{companyId}","operationId":"updatePaymentOrderParameter","name":"Update the parameter which connects Payment Order and Payment System - This API is deprecated and moved to the following URL :/settings/configuration/payments/paymentOrders/{paymentOrderId}","summary":"Update the payment order parameter","tags":[],"parameters":[{"name":"companyId","in":"path","type":"string","required":true,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"poParam":[{}],"paymentConnectionMethod":"string","warehouseRequired":"string","archiveDays":"archiveDays","mappingRoutine":"mappingRoutine","mappingRecord":"mappingRecord","connectionRule":"connectionRule","connectionApi":"connectionApi","simulationExpiryTime":"simulationExpiryTime","purgeAwaitSubmitPrd":"purgeAwaitSubmitPrd","defaultProductRule":"defaultProductRule","defaultProductApi":"defaultProductApi","fraudRoutine":"fraudRoutine","accountLocatorApi":"accountLocatorApi","accountLocatorRule":"accountLocatorRule"}},"responses":{"200":"PaymentOrderParameterResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/order/payments/products/{productId}","fullPath":"/api/v1.0.0/order/payments/products/{productId}","operationId":"updatePaymentOrderProduct","name":"Update the Payment features that are specific to a product - This API is deprecated and moved to the following URL:/settings/configuration/payments/products/{productId}","summary":"Update the payment order product","tags":[],"parameters":[{"name":"productId","in":"path","type":"string","required":true,"description":"Contains the unique identifier of the product, e.g. the product id of the arrangement account."},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"payments":[{}],"orders":[{}],"chargeOptions":[{}],"clearingChannelIds":[{}],"additionalInformations":[{}],"weblinks":[{}],"payThroughBeneficiary":"string","futureDate":"string","defaultChargeOption":"string","allowFx":"string","FXRate":"string","IBAN":"string","BIC":"string","sortCode":"string","warehouseRequired":"string"}},"responses":{"200":"PaymentOrderProductResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}}]},{"key":"order-positionTransferOrdersRequest-service-v1.0.0","title":"Security Postion Transfers","version":"v1.0.0","description":"Allows the viewing and management of the Security Position Transfers","endpointCount":2,"endpoints":[{"method":"POST","path":"/order/securityPositionTransferOrders","fullPath":"/api/v1.0.0/order/securityPositionTransferOrders","operationId":"createSecurityPositionTransferOrder","name":"Creates the position transfer","summary":"Creates the position transfer","tags":[],"parameters":[{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":""},{"name":"companyId","in":"header","type":"string","required":false,"description":""}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"instruments":[{}],"narratives":[{}],"securityPositions":[{}],"transferDate":"2024-01-01","valueDate":"2024-01-01","fromPortfolio":"string","fromCustodian":"string","nomineeFrom":"string","fromSubAccount":"string","toPortfolio":"string","toCustodian":"string","nomineeTo":"string","selectMovements":"string","numberOfPositions":0.0,"fundPosition":true}},"responses":{"200":"SecurityPositionTransferOrderResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/order/securityPositionTransferOrders/{positionTransferOrderId}","fullPath":"/api/v1.0.0/order/securityPositionTransferOrders/{positionTransferOrderId}","operationId":"updateSecurityPositionTransferOrder","name":"Updates the position transfer","summary":"Updates the position transfer","tags":[],"parameters":[{"name":"positionTransferOrderId","in":"path","type":"string","required":true,"description":""},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":""},{"name":"companyId","in":"header","type":"string","required":false,"description":""}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"instruments":[{}],"narratives":[{}],"securityPositions":[{}],"transferDate":"2024-01-01","valueDate":"2024-01-01","fromPortfolio":"string","fromCustodian":"string","nomineeFrom":"string","fromSubAccount":"string","toPortfolio":"string","toCustodian":"string","nomineeTo":"string","selectMovements":"string","numberOfPositions":0.0,"fundPosition":true}},"responses":{"200":"SecurityPositionTransferOrderResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}}]},{"key":"order-positionTransferOrdersRequest-service-v2.0.0","title":"Security Position Transfers","version":"v2.0.0","description":"Allows the viewing and management of the position transfer","endpointCount":4,"endpoints":[{"method":"POST","path":"/order/securityPositionTransferOrdersInitiation","fullPath":"/api/v2.0.0/order/securityPositionTransferOrdersInitiation","operationId":"createSecurityPositionTransferOrdersInitiation","name":"Create Position transfer order Initiation","summary":"Create Position transfer order Initiation","tags":[],"parameters":[{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"The identifier of the underlying Entity/Company/Branch."}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"instruments":[{}],"narratives":[{}],"securityPositions":[{}],"transferDate":"2024-01-01","valueDate":"2024-01-01","fromPortfolio":"string","fromCustodian":"string","nomineeFrom":"string","fromSubAccount":"string","toPortfolio":"string","toCustodian":"string","nomineeTo":"string","selectMovements":"string","numberOfPositions":0.0,"fundPosition":true}},"responses":{"200":"SecurityPositionTransferOrdersInitiationResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/order/securityPositionTransferOrdersInitiation/{positionTransferOrderId}","fullPath":"/api/v2.0.0/order/securityPositionTransferOrdersInitiation/{positionTransferOrderId}","operationId":"updateSecurityPositionTransferOrdersInitiation","name":"Update Position transfer order Initiation","summary":"Update Position transfer order Initiation","tags":[],"parameters":[{"name":"positionTransferOrderId","in":"path","type":"string","required":true,"description":""},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"The identifier of the underlying Entity/Company/Branch."}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"instruments":[{}],"narratives":[{}],"securityPositions":[{}],"transferDate":"2024-01-01","valueDate":"2024-01-01","fromPortfolio":"string","fromCustodian":"string","nomineeFrom":"string","fromSubAccount":"string","toPortfolio":"string","toCustodian":"string","nomineeTo":"string","selectMovements":"string","numberOfPositions":0.0,"fundPosition":true}},"responses":{"200":"SecurityPositionTransferOrdersInitiationResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"DELETE","path":"/order/securityPositionTransferOrdersInitiation/{positionTransferOrderId}","fullPath":"/api/v2.0.0/order/securityPositionTransferOrdersInitiation/{positionTransferOrderId}","operationId":"deleteSecurityPositionTransferOrdersInitiation","name":"Delete Position transfer order Initiation","summary":"Delete Position transfer order Initiation","tags":[],"parameters":[{"name":"positionTransferOrderId","in":"path","type":"string","required":true,"description":""},{"name":"payload","in":"body","type":"object","required":false,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"The identifier of the underlying Entity/Company/Branch."}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}}},"responses":{"200":"SecurityPositionTransferOrdersInitiationResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/order/securityPositionTransferOrdersApprovals/{positionTransferOrderId}","fullPath":"/api/v2.0.0/order/securityPositionTransferOrdersApprovals/{positionTransferOrderId}","operationId":"approvePositionTransferRequest","name":"Approve Position transfer order Initiation","summary":"Approve Position transfer order Initiation","tags":[],"parameters":[{"name":"positionTransferOrderId","in":"path","type":"string","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"The identifier of the underlying Entity/Company/Branch."}],"requestBodyExample":null,"responses":{"200":"PositionTransferRequestResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}}]},{"key":"order-privateEquityOrders-service-v1.0.0","title":"Private Equity Orders","version":"v1.0.0","description":"Allows the creation, viewing and management of private equity orders","endpointCount":3,"endpoints":[{"method":"GET","path":"/order/privateEquityOrders/{privateEquityOrderId}","fullPath":"/api/v1.0.0/order/privateEquityOrders/{privateEquityOrderId}","operationId":"getPrivateEquityOrder","name":"Retrieves the private equity order","summary":"Retrieves the private equity order","tags":[],"parameters":[{"name":"privateEquityOrderId","in":"path","type":"string","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":""},{"name":"companyId","in":"header","type":"string","required":false,"description":""}],"requestBodyExample":null,"responses":{"200":"PrivateEquityOrderResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"POST","path":"/order/privateEquityOrders/{privateEquityOrderId}","fullPath":"/api/v1.0.0/order/privateEquityOrders/{privateEquityOrderId}","operationId":"createPrivateEquityOrder","name":"Creates an initial commitment of private equity order","summary":"Creates an initial commitment","tags":[],"parameters":[{"name":"privateEquityOrderId","in":"path","type":"string","required":true,"description":""},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":""},{"name":"companyId","in":"header","type":"string","required":false,"description":""}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"customerId":0.0,"portfolioId":"string","accountId":0.0,"instrumentId":"string","currencyId":"string","depositoryId":0.0,"counterpartyId":0.0,"counterPartyAccountId":0.0,"date":"2024-01-01","amount":0.0,"status":"string","adviceRequired":true,"commissionRate":0.0,"commissionAmount":0.0,"taxAmount":0.0}},"responses":{"200":"PrivateEquityOrderResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/order/privateEquityOrders/{privateEquityOrderId}","fullPath":"/api/v1.0.0/order/privateEquityOrders/{privateEquityOrderId}","operationId":"updatePrivateEquityOrder","name":"Updates the private equity order","summary":"Updates the private equity order","tags":[],"parameters":[{"name":"privateEquityOrderId","in":"path","type":"string","required":true,"description":""},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":""},{"name":"companyId","in":"header","type":"string","required":false,"description":""}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"customerId":0.0,"portfolioId":"string","accountId":0.0,"instrumentId":"string","currencyId":"string","depositoryId":0.0,"counterpartyId":0.0,"counterPartyAccountId":0.0,"date":"2024-01-01","amount":0.0,"status":"string","adviceRequired":true,"commissionRate":0.0,"commissionAmount":0.0,"taxAmount":0.0}},"responses":{"200":"PrivateEquityOrderResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}}]},{"key":"order-securityOrders-service-v1.0.0","title":"Security Orders","version":"v1.0.0","description":"Allows the creation, viewing and management of security orders","endpointCount":6,"endpoints":[{"method":"POST","path":"/order/securityOrders/","fullPath":"/api/v1.0.0/v1.0.0/order/securityOrders/","operationId":"createSecurityOrder","name":"Creates a security order with the transaction channel","summary":"Creates a security order","tags":[],"parameters":[{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"The identifier of the underlying Entity/Company/Branch."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"brokers":[{}],"customers":[{}],"transactionChannel":"string","instrumentId":"string","tradeCurrency":"string","stockExchange":"string","transactionType":"string","orderDate":"2024-01-01","valueDate":"2024-01-01","orderedAt":"string","orderType":"string","tradeType":"string","switchMethod":"string","switchSpecification":"string","masterOrderOfSwitch":"string"}},"responses":{"200":"SecurityOrderResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/order/securityOrders/{securityOrderId}","fullPath":"/api/v1.0.0/v1.0.0/order/securityOrders/{securityOrderId}","operationId":"getSecurityOrder","name":"Retrieves the security order","summary":"Retrieves the security order","tags":[],"parameters":[{"name":"securityOrderId","in":"path","type":"string","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"The identifier of the underlying Entity/Company/Branch."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"SecurityOrderResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/order/securityOrders/{securityOrderId}","fullPath":"/api/v1.0.0/v1.0.0/order/securityOrders/{securityOrderId}","operationId":"updateSecurityOrder","name":"Updates the security order","summary":"Updates the security order","tags":[],"parameters":[{"name":"securityOrderId","in":"path","type":"string","required":true,"description":""},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"The identifier of the underlying Entity/Company/Branch."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"brokers":[{}],"customers":[{}],"transactionChannel":"string","instrumentId":"string","tradeCurrency":"string","stockExchange":"string","transactionType":"string","orderDate":"2024-01-01","valueDate":"2024-01-01","orderedAt":"string","orderType":"string","tradeType":"string","switchMethod":"string","switchSpecification":"string","masterOrderOfSwitch":"string"}},"responses":{"200":"SecurityOrderResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/order/securityOrders/periodicFeeEstimates","fullPath":"/api/v1.0.0/v1.0.0/order/securityOrders/periodicFeeEstimates","operationId":"getPeriodicFeeEstimates","name":"Get Estimated Periodic Fees and charges for the deal","summary":"Get Estimated Periodic Fees and charges for the deal","tags":[],"parameters":[{"name":"customerId","in":"query","type":"string","required":true,"description":"Identifier of the customer"},{"name":"portfolioId","in":"query","type":"string","required":true,"description":"Id of the portfolio or security account"},{"name":"instrumentId","in":"query","type":"string","required":true,"description":"The identifier of the instrument"},{"name":"depositoryId","in":"query","type":"string","required":false,"description":"Id of the securities depository."},{"name":"tradeCurrency","in":"query","type":"string","required":true,"description":"The trade currency is the settlement currency for the trade"},{"name":"quantity","in":"query","type":"string","required":true,"description":"The nominal quantity"},{"name":"amount","in":"query","type":"string","required":true,"description":"This is the payment amount"},{"name":"price","in":"query","type":"string","required":false,"description":"The Price at which the nominal amount of the Security is to be valued for the transaction."},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from t24 on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"The identifier of the underlying Entity/Company/Branch."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"PeriodicFeeEstimatesResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"POST","path":"/order/securityOrders/stopPriceOrders","fullPath":"/api/v1.0.0/v1.0.0/order/securityOrders/stopPriceOrders","operationId":"createStopPriceOrder","name":"Creates a stop price order with the transaction channel","summary":"Creates a stop price order","tags":[],"parameters":[{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"The identifier of the underlying Entity/Company/Branch."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"brokers":[{}],"customers":[{}],"transactionChannel":"string","instrumentId":"string","tradeCurrency":"string","stockExchange":"string","transactionType":"string","orderDate":"2024-01-01","valueDate":"2024-01-01","orderedAt":"string","orderType":"string","tradeType":"string","switchMethod":"string","switchSpecification":"string","masterOrderOfSwitch":"string"}},"responses":{"200":"StopPriceOrderResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"POST","path":"/order/securityOrders/stopPriceLimitOrders","fullPath":"/api/v1.0.0/v1.0.0/order/securityOrders/stopPriceLimitOrders","operationId":"createStopPriceLimitOrder","name":"Creates a stop price limit order with the transaction channel","summary":"Creates a stop price limit order","tags":[],"parameters":[{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"The identifier of the underlying Entity/Company/Branch."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"brokers":[{}],"customers":[{}],"transactionChannel":"string","instrumentId":"string","tradeCurrency":"string","stockExchange":"string","transactionType":"string","orderDate":"2024-01-01","valueDate":"2024-01-01","orderedAt":"string","orderType":"string","tradeType":"string","switchMethod":"string","switchSpecification":"string","masterOrderOfSwitch":"string"}},"responses":{"200":"StopPriceLimitOrderResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}}]},{"key":"order-securityOrders-service-v1.0.1","title":"Security Orders","version":"v1.0.1","description":"Allows the creation, viewing and management of security orders","endpointCount":6,"endpoints":[{"method":"POST","path":"/order/securityOrders/","fullPath":"/api/v1.0.1/v1.0.1/order/securityOrders/","operationId":"createSecurityOrder","name":"Creates a security order with the transaction channel","summary":"Creates a security order","tags":[],"parameters":[{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"brokers":[{}],"customers":[{}],"overrides":[{}],"transactionChannel":"string","instrumentId":"string","tradeCurrency":"string","stockExchange":"string","transactionType":"string","orderDate":"2024-01-01","valueDate":"2024-01-01","orderedAt":"string","orderType":"string","tradeType":"string","switchMethod":"string","switchSpecification":"string"}},"responses":{"200":"SecurityOrderResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/order/securityOrders/{securityOrderId}","fullPath":"/api/v1.0.1/v1.0.1/order/securityOrders/{securityOrderId}","operationId":"getSecurityOrder","name":"Retrieves the security order","summary":"Retrieves the security order","tags":[],"parameters":[{"name":"securityOrderId","in":"path","type":"string","required":true,"description":"Identifier of the security order"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"SecurityOrderResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/order/securityOrders/{securityOrderId}","fullPath":"/api/v1.0.1/v1.0.1/order/securityOrders/{securityOrderId}","operationId":"updateSecurityOrder","name":"Updates the security order","summary":"Updates the security order","tags":[],"parameters":[{"name":"securityOrderId","in":"path","type":"string","required":true,"description":"Identifier of the security order"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"brokers":[{}],"customers":[{}],"overrides":[{}],"transactionChannel":"string","instrumentId":"string","tradeCurrency":"string","stockExchange":"string","transactionType":"string","orderDate":"2024-01-01","valueDate":"2024-01-01","orderedAt":"string","orderType":"string","tradeType":"string","switchMethod":"string","switchSpecification":"string"}},"responses":{"200":"SecurityOrderResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/order/securityOrders/periodicFeeEstimates","fullPath":"/api/v1.0.1/v1.0.1/order/securityOrders/periodicFeeEstimates","operationId":"getPeriodicFeeEstimates","name":"Get Estimated Periodic Fees and charges for the deal","summary":"Get Estimated Periodic Fees and charges for the deal","tags":[],"parameters":[{"name":"customerId","in":"query","type":"string","required":true,"description":"Identifier of the customer"},{"name":"portfolioId","in":"query","type":"string","required":true,"description":"Id of the portfolio or security account"},{"name":"instrumentId","in":"query","type":"string","required":true,"description":"The identifier of the instrument"},{"name":"depositoryId","in":"query","type":"string","required":false,"description":"Id of the securities depository."},{"name":"tradeCurrency","in":"query","type":"string","required":true,"description":"The trade currency is the settlement currency for the trade"},{"name":"quantity","in":"query","type":"string","required":true,"description":"The nominal quantity"},{"name":"amount","in":"query","type":"string","required":true,"description":"This is the payment amount"},{"name":"price","in":"query","type":"string","required":false,"description":"The Price at which the nominal amount of the Security is to be valued for the transaction."},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"PeriodicFeeEstimatesResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"POST","path":"/order/securityOrders/stopPriceOrders","fullPath":"/api/v1.0.1/v1.0.1/order/securityOrders/stopPriceOrders","operationId":"createStopPriceOrder","name":"Creates a stop price order with the transaction channel","summary":"Creates a stop price order","tags":[],"parameters":[{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"brokers":[{}],"customers":[{}],"overrides":[{}],"transactionChannel":"string","instrumentId":"string","tradeCurrency":"string","stockExchange":"string","transactionType":"string","orderDate":"2024-01-01","valueDate":"2024-01-01","orderedAt":"string","orderType":"string","tradeType":"string","switchMethod":"string","switchSpecification":"string"}},"responses":{"200":"StopPriceOrderResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"POST","path":"/order/securityOrders/stopPriceLimitOrders","fullPath":"/api/v1.0.1/v1.0.1/order/securityOrders/stopPriceLimitOrders","operationId":"createStopPriceLimitOrder","name":"Creates a stop price limit order with the transaction channel","summary":"Creates a stop price limit order","tags":[],"parameters":[{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"brokers":[{}],"customers":[{}],"overrides":[{}],"transactionChannel":"string","instrumentId":"string","tradeCurrency":"string","stockExchange":"string","transactionType":"string","orderDate":"2024-01-01","valueDate":"2024-01-01","orderedAt":"string","orderType":"string","tradeType":"string","switchMethod":"string","switchSpecification":"string"}},"responses":{"200":"StopPriceLimitOrderResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}}]},{"key":"order-securityOrders-service-v2.0.0","title":"Security Orders","version":"v2.0.0","description":"Allows the creation, viewing and management of security orders","endpointCount":6,"endpoints":[{"method":"POST","path":"/order/securityOrders/","fullPath":"/api/v2.0.0/v2.0.0/order/securityOrders/","operationId":"createSecurityOrder","name":"Creates a security order with the transaction channel","summary":"Creates a security order","tags":[],"parameters":[{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"brokers":[{}],"customers":[{}],"tradeReferences":[{}],"overrides":[{}],"transactionChannel":"string","instrumentId":"string","tradeCurrency":"string","stockExchange":"string","transactionType":"string","orderDate":"2024-01-01","valueDate":"2024-01-01","orderedAt":"string","orderType":"string","tradeType":"string","switchMethod":"string"}},"responses":{"200":"SecurityOrderResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/order/securityOrders/{securityOrderId}","fullPath":"/api/v2.0.0/v2.0.0/order/securityOrders/{securityOrderId}","operationId":"getSecurityOrder","name":"Retrieves the security order","summary":"Retrieves the security order","tags":[],"parameters":[{"name":"securityOrderId","in":"path","type":"string","required":true,"description":"Identifier of the security order"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"SecurityOrderResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/order/securityOrders/{securityOrderId}","fullPath":"/api/v2.0.0/v2.0.0/order/securityOrders/{securityOrderId}","operationId":"updateSecurityOrder","name":"Updates the security order","summary":"Updates the security order","tags":[],"parameters":[{"name":"securityOrderId","in":"path","type":"string","required":true,"description":"Identifier of the security order"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"brokers":[{}],"customers":[{}],"tradeReferences":[{}],"overrides":[{}],"transactionChannel":"string","instrumentId":"string","tradeCurrency":"string","stockExchange":"string","transactionType":"string","orderDate":"2024-01-01","valueDate":"2024-01-01","orderedAt":"string","orderType":"string","tradeType":"string","switchMethod":"string"}},"responses":{"200":"SecurityOrderResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/order/securityOrders/periodicFeeEstimates","fullPath":"/api/v2.0.0/v2.0.0/order/securityOrders/periodicFeeEstimates","operationId":"getPeriodicFeeEstimates","name":"Get estimated periodic fees and charges for the deal","summary":"Get estimated periodic fees and charges for the deal","tags":[],"parameters":[{"name":"customerId","in":"query","type":"string","required":false,"description":"Identifier of the customer"},{"name":"portfolioId","in":"query","type":"string","required":false,"description":"Id of the portfolio or security account"},{"name":"instrumentId","in":"query","type":"string","required":false,"description":"The identifier of the instrument"},{"name":"depositoryId","in":"query","type":"string","required":false,"description":"Id of the securities depository."},{"name":"tradeCurrency","in":"query","type":"string","required":false,"description":"The trade currency is the settlement currency for the trade"},{"name":"quantity","in":"query","type":"string","required":false,"description":"The nominal quantity"},{"name":"amount","in":"query","type":"string","required":false,"description":"Contains the direct debit claim amount"},{"name":"price","in":"query","type":"string","required":false,"description":"The price at which the nominal amount of the security is to be valued for the transaction."},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"PeriodicFeeEstimatesResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"POST","path":"/order/securityOrders/stopPriceOrders","fullPath":"/api/v2.0.0/v2.0.0/order/securityOrders/stopPriceOrders","operationId":"createStopPriceOrder","name":"Creates a stop price order with the transaction channel","summary":"Creates a stop price order","tags":[],"parameters":[{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"brokers":[{}],"customers":[{}],"tradeReferences":[{}],"overrides":[{}],"transactionChannel":"string","instrumentId":"string","tradeCurrency":"string","stockExchange":"string","transactionType":"string","orderDate":"2024-01-01","valueDate":"2024-01-01","orderedAt":"string","orderType":"string","tradeType":"string","switchMethod":"string"}},"responses":{"200":"StopPriceOrderResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"POST","path":"/order/securityOrders/stopPriceLimitOrders","fullPath":"/api/v2.0.0/v2.0.0/order/securityOrders/stopPriceLimitOrders","operationId":"createStopPriceLimitOrder","name":"Creates a stop price limit order with the transaction channel","summary":"Creates a stop price limit order","tags":[],"parameters":[{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"brokers":[{}],"customers":[{}],"tradeReferences":[{}],"overrides":[{}],"transactionChannel":"string","instrumentId":"string","tradeCurrency":"string","stockExchange":"string","transactionType":"string","orderDate":"2024-01-01","valueDate":"2024-01-01","orderedAt":"string","orderType":"string","tradeType":"string","switchMethod":"string"}},"responses":{"200":"StopPriceLimitOrderResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}}]},{"key":"order-securityTransferOrders-service-v1.0.0","title":"Security Transfers","version":"v1.0.0","description":"Allows the creation, viewing and management of security transfer orders, view the inbound and outbound security transfer orders and creation of orders through channels","endpointCount":7,"endpoints":[{"method":"GET","path":"/order/securityTransferOrders/inboundOrders","fullPath":"/api/v1.0.0/order/securityTransferOrders/inboundOrders","operationId":"getInboundSecurityTransferOrders","name":"Retrieves the inbound free of payment security transfers","summary":"Retrieves the inbound security transfers","tags":[],"parameters":[{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from t24 on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":""},{"name":"companyId","in":"header","type":"string","required":false,"description":""}],"requestBodyExample":null,"responses":{"200":"InboundSecurityTransferOrdersResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/order/securityTransferOrders/outboundOrders","fullPath":"/api/v1.0.0/order/securityTransferOrders/outboundOrders","operationId":"getOutboundSecurityTransferOrders","name":"Retrieves the outbound free of payment security transfers","summary":"Retrieves the outbound security transfers","tags":[],"parameters":[{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from t24 on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":""},{"name":"companyId","in":"header","type":"string","required":false,"description":""}],"requestBodyExample":null,"responses":{"200":"OutboundSecurityTransferOrdersResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"POST","path":"/order/securityTransferOrders","fullPath":"/api/v1.0.0/order/securityTransferOrders","operationId":"createSecurityTransferOrder","name":"Creates a security transfer order","summary":"Creates a security transfer order","tags":[],"parameters":[{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":""},{"name":"companyId","in":"header","type":"string","required":false,"description":""}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"taxes":[{}],"instructions":[{}],"capitalGainTaxes":[{}],"taxesInTradeCurrency":[{}],"transactionType":"string","instrumentId":"string","instrumentCurrencyId":"string","transferDate":"2024-01-01","valueDate":"2024-01-01","depositoryId":"string","deliveryInstruction":"string","customerId":"string","portfolioId":"string","quantity":"string","price":0.0}},"responses":{"200":"SecurityTransferOrderResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/order/securityTransferOrders/{securityTransferOrderId}","fullPath":"/api/v1.0.0/order/securityTransferOrders/{securityTransferOrderId}","operationId":"getSecurityTransferOrder","name":"Retreives the security transfer order","summary":"Retreives the security transfer order","tags":[],"parameters":[{"name":"securityTransferOrderId","in":"path","type":"string","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":""},{"name":"companyId","in":"header","type":"string","required":false,"description":""}],"requestBodyExample":null,"responses":{"200":"SecurityTransferOrderResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/order/securityTransferOrders/{securityTransferOrderId}","fullPath":"/api/v1.0.0/order/securityTransferOrders/{securityTransferOrderId}","operationId":"updateSecurityTransferOrder","name":"Updates the security transfer order","summary":"Updates the security transfer order","tags":[],"parameters":[{"name":"securityTransferOrderId","in":"path","type":"string","required":true,"description":""},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":""},{"name":"companyId","in":"header","type":"string","required":false,"description":""}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"taxes":[{}],"instructions":[{}],"capitalGainTaxes":[{}],"taxesInTradeCurrency":[{}],"transactionType":"string","instrumentId":"string","instrumentCurrencyId":"string","transferDate":"2024-01-01","valueDate":"2024-01-01","depositoryId":"string","deliveryInstruction":"string","customerId":"string","portfolioId":"string","quantity":"string","price":0.0}},"responses":{"200":"SecurityTransferOrderResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"POST","path":"/order/securityTransferOrders/drafts","fullPath":"/api/v1.0.0/order/securityTransferOrders/drafts","operationId":"createSecurityTransferDraftOrder","name":"Creates a security transfer order draft","summary":"Creates a security transfer order draft","tags":[],"parameters":[{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":""},{"name":"companyId","in":"header","type":"string","required":false,"description":""}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"taxes":[{}],"instructions":[{}],"capitalGainTaxes":[{}],"taxesInTradeCurrency":[{}],"transactionType":"string","instrumentId":"string","instrumentCurrencyId":"string","transferDate":"2024-01-01","valueDate":"2024-01-01","depositoryId":"string","deliveryInstruction":"string","customerId":"string","portfolioId":"string","quantity":"string","price":0.0}},"responses":{"200":"SecurityTransferDraftOrderResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"POST","path":"/order/securityTransferOrders/requests/","fullPath":"/api/v1.0.0/order/securityTransferOrders/requests/","operationId":"createSecurityTransferRequest","name":"Creates the security transfer request","summary":"Creates the security transfer request","tags":[],"parameters":[{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":""},{"name":"companyId","in":"header","type":"string","required":false,"description":""}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"taxes":[{}],"instructions":[{}],"transactionType":"string","instrumentId":"string","instrumentCurrencyId":"string","transferDate":"2024-01-01","valueDate":"2024-01-01","depositoryId":"string","deliveryInstruction":"string","customerId":"string","portfolioId":"string","quantity":0.0,"price":0.0,"nominee":"string","grossCost":0.0}},"responses":{"200":"SecurityTransferRequestResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}}]},{"key":"order-securityTransferOrders-service-v2.0.0","title":"Security Transfers","version":"v2.0.0","description":"Allows the creation, viewing and management of security transfer orders, view the inbound and outbound security transfer orders and creation of orders through channels","endpointCount":7,"endpoints":[{"method":"GET","path":"/order/securityTransferOrders/inboundOrders","fullPath":"/api/v2.0.0/order/securityTransferOrders/inboundOrders","operationId":"getInboundSecurityTransferOrders","name":"Retrieves the inbound free of payment security transfers","summary":"Retrieves the inbound security transfers","tags":[],"parameters":[{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from t24 on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"The identifier of the underlying Entity/Company/Branch."}],"requestBodyExample":null,"responses":{"200":"InboundSecurityTransferOrdersResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/order/securityTransferOrders/outboundOrders","fullPath":"/api/v2.0.0/order/securityTransferOrders/outboundOrders","operationId":"getOutboundSecurityTransferOrders","name":"Retrieves the outbound free of payment security transfers","summary":"Retrieves the outbound security transfers","tags":[],"parameters":[{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from t24 on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"The identifier of the underlying Entity/Company/Branch."}],"requestBodyExample":null,"responses":{"200":"OutboundSecurityTransferOrdersResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"POST","path":"/order/securityTransferOrders","fullPath":"/api/v2.0.0/order/securityTransferOrders","operationId":"createSecurityTransferOrder","name":"Creates a security transfer order","summary":"Creates a security transfer order","tags":[],"parameters":[{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"The identifier of the underlying Entity/Company/Branch."}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"taxes":[{}],"instructions":[{}],"capitalGainTaxes":[{}],"taxesInTradeCurrency":[{}],"transactionType":"string","instrumentId":"string","instrumentCurrencyId":"string","transferDate":"2024-01-01","valueDate":"2024-01-01","depositoryId":"string","deliveryInstruction":"string","customerId":"string","portfolioId":"string","quantity":"string","price":0.0}},"responses":{"200":"SecurityTransferOrderResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/order/securityTransferOrders/{securityTransferOrderId}","fullPath":"/api/v2.0.0/order/securityTransferOrders/{securityTransferOrderId}","operationId":"getSecurityTransferOrders","name":"Allows to view the Security Transfer Order details along with the delivery message information","summary":"Allows to view the Security Transfer Order details","tags":[],"parameters":[{"name":"securityTransferOrderId","in":"path","type":"string","required":true,"description":""},{"name":"customerId","in":"query","type":"string","required":false,"description":"Identifier of the customer"},{"name":"instrumentId","in":"query","type":"string","required":false,"description":"The identifier of the instrument"},{"name":"depositoryId","in":"query","type":"string","required":false,"description":"Id of the securities depository."},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from t24 on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"The identifier of the underlying Entity/Company/Branch."}],"requestBodyExample":null,"responses":{"200":"SecurityTransferOrdersResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"PUT","path":"/order/securityTransferOrders/{securityTransferOrderId}","fullPath":"/api/v2.0.0/order/securityTransferOrders/{securityTransferOrderId}","operationId":"updateSecurityTransferOrder","name":"Updates the security transfer order","summary":"Updates the security transfer order","tags":[],"parameters":[{"name":"securityTransferOrderId","in":"path","type":"string","required":true,"description":""},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"The identifier of the underlying Entity/Company/Branch."}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"taxes":[{}],"instructions":[{}],"capitalGainTaxes":[{}],"taxesInTradeCurrency":[{}],"transactionType":"string","instrumentId":"string","instrumentCurrencyId":"string","transferDate":"2024-01-01","valueDate":"2024-01-01","depositoryId":"string","deliveryInstruction":"string","customerId":"string","portfolioId":"string","quantity":"string","price":0.0}},"responses":{"200":"SecurityTransferOrderResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"POST","path":"/order/securityTransferOrders/drafts","fullPath":"/api/v2.0.0/order/securityTransferOrders/drafts","operationId":"createSecurityTransferDraftOrder","name":"Creates a security transfer order draft","summary":"Creates a security transfer order draft","tags":[],"parameters":[{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"The identifier of the underlying Entity/Company/Branch."}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"taxes":[{}],"instructions":[{}],"capitalGainTaxes":[{}],"taxesInTradeCurrency":[{}],"transactionType":"string","instrumentId":"string","instrumentCurrencyId":"string","transferDate":"2024-01-01","valueDate":"2024-01-01","depositoryId":"string","deliveryInstruction":"string","customerId":"string","portfolioId":"string","quantity":"string","price":0.0}},"responses":{"200":"SecurityTransferDraftOrderResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"POST","path":"/order/securityTransferOrders/requests/","fullPath":"/api/v2.0.0/order/securityTransferOrders/requests/","operationId":"createSecurityTransferRequest","name":"Creates the security transfer request","summary":"Creates the security transfer request","tags":[],"parameters":[{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"The identifier of the underlying Entity/Company/Branch."}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"taxes":[{}],"instructions":[{}],"transactionType":"string","instrumentId":"string","instrumentCurrencyId":"string","transferDate":"2024-01-01","valueDate":"2024-01-01","depositoryId":"string","deliveryInstruction":"string","customerId":"string","portfolioId":"string","quantity":0.0,"price":0.0,"nominee":"string","grossCost":0.0}},"responses":{"200":"SecurityTransferRequestResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}}]},{"key":"order-standingOrders-service-v1.0.0","title":"Management of Standing Order instructions","version":"v1.0.0","description":"API to create, update and manage the Standing Instructions of an Account to pay a set amount at regular intervals to another's account.","endpointCount":7,"endpoints":[{"method":"GET","path":"/order/standingOrders/failedTransactions","fullPath":"/api/v1.0.0/order/standingOrders/failedTransactions","operationId":"getFailedTransactions","name":"Retrieves the list of failed Standing Instructions details such as Accounts involved, payment type & reason of failure","summary":"Retrieves failed transactions of standing Instructions","tags":[],"parameters":[{"name":"debitCustomerId","in":"query","type":"string","required":false,"description":"Debtor customer details"},{"name":"debitAccountId","in":"query","type":"string","required":false,"description":"Indicates the debit account number of the payment or transaction."},{"name":"creditAccountId","in":"query","type":"string","required":false,"description":"Credit account identifier of the payment or transaction"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from t24 on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"FailedTransactionsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/order/standingOrders","fullPath":"/api/v1.0.0/order/standingOrders","operationId":"getStandingOrders","name":"Retrieves the list of Standing Instructions details such as Instruction reference, mode of Payment, payment frequency, amount, accounts & Customers involved","summary":"Retrieves list of standing Instructions","tags":[],"parameters":[{"name":"debitCustomerId","in":"query","type":"string","required":false,"description":"Debtor customer details"},{"name":"standingOrderId","in":"query","type":"string","required":false,"description":"The unique standing order identifier"},{"name":"accountId","in":"query","type":"string","required":false,"description":"Identifier of the account. Often referred to as the account number, yet for consistency this is always referred to as accountId. Accepts both IBAN & BBAN"},{"name":"orderingCustomerId","in":"query","type":"string","required":false,"description":"Indicates the customer id for the ordering customer"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from t24 on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"StandingOrdersResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"POST","path":"/order/standingOrders/{standingOrderId}","fullPath":"/api/v1.0.0/order/standingOrders/{standingOrderId}","operationId":"createStandingOrder","name":"Create Standing Instructions with payment type, payment frequency, ordering customer or bank information and Accounts involved","summary":"Creates a new standing Instruction","tags":[],"parameters":[{"name":"standingOrderId","in":"path","type":"string","required":true,"description":"The unique standing order identifier"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"beneficiaryNames":[{}],"accountWithBanks":[{}],"displayNames":[{}],"beneficiaryBICNames":[{}],"overrides":[{}],"paymentMethod":"string","currentFrequency":"string","currentEndDate":"2024-01-01","futureNotice":"string","counterPartyAccountId":"string","startDate":"2024-01-01","frequency":"string","beneficiaryAccountId":"string","beneficiaryId":"string","beneficiaryReference":"string"}},"responses":{"200":"StandingOrderResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/order/standingOrders/{standingOrderId}","fullPath":"/api/v1.0.0/order/standingOrders/{standingOrderId}","operationId":"updateStandingOrder","name":"Update Standing Instructions with payment type, payment frequency, ordering customer or bank information and Accounts involved","summary":"Updates a standing Instruction","tags":[],"parameters":[{"name":"standingOrderId","in":"path","type":"string","required":true,"description":"The unique standing order identifier"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"beneficiaryNames":[{}],"accountWithBanks":[{}],"displayNames":[{}],"beneficiaryBICNames":[{}],"overrides":[{}],"paymentMethod":"string","currentFrequency":"string","currentEndDate":"2024-01-01","futureNotice":"string","counterPartyAccountId":"string","startDate":"2024-01-01","frequency":"string","beneficiaryAccountId":"string","beneficiaryId":"string","beneficiaryReference":"string"}},"responses":{"200":"StandingOrderResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"DELETE","path":"/order/standingOrders/{standingOrderId}","fullPath":"/api/v1.0.0/order/standingOrders/{standingOrderId}","operationId":"deleteStandingOrder","name":"Delete or Revoke Standing Instructions for a Customer","summary":"Cancels a Standing Instruction","tags":[],"parameters":[{"name":"standingOrderId","in":"path","type":"string","required":true,"description":"The unique standing order identifier"},{"name":"payload","in":"body","type":"object","required":false,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}}},"responses":{"200":"StandingOrderResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/order/standingOrders/standingOrderApprovals/{standingOrderId}","fullPath":"/api/v1.0.0/order/standingOrders/standingOrderApprovals/{standingOrderId}","operationId":"approveStandingOrder","name":"Approve Standing Instructions that are sent for second or third level approvals","summary":"Approves the standing Instruction request","tags":[],"parameters":[{"name":"standingOrderId","in":"path","type":"string","required":true,"description":"The unique standing order identifier"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"StandingOrderResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"DELETE","path":"/order/standingOrders/cancellations/{standingOrderId}","fullPath":"/api/v1.0.0/order/standingOrders/cancellations/{standingOrderId}","operationId":"rejectStandingOrder","name":"Reject Standing Instructions that are sent for Approvals","summary":"Rejects a standing Instruction request","tags":[],"parameters":[{"name":"standingOrderId","in":"path","type":"string","required":true,"description":"The unique standing order identifier"},{"name":"payload","in":"body","type":"object","required":false,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}}},"responses":{"200":"StandingOrderResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}}]},{"key":"order-sweeps-service-v1.0.1","title":"Management of Account Sweeps","version":"v1.0.1","description":"API to create, update and retrieve the details of account sweep services","endpointCount":8,"endpoints":[{"method":"GET","path":"/order/sweeps","fullPath":"/api/v1.0.1/order/sweeps","operationId":"getSweeps","name":"Retrieves the list of account links for a sweep to occur.","summary":"Retrieves the sweep transactions","tags":[],"parameters":[{"name":"toAccountId","in":"query","type":"string","required":false,"description":"Account number of the Payee or Beneficiary of the transaction"},{"name":"fromAccountId","in":"query","type":"string","required":false,"description":"For surplus this refers to the account which will be credited and for maintenance this account from where the funds are debited."},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"SweepsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"POST","path":"/order/sweeps","fullPath":"/api/v1.0.1/order/sweeps","operationId":"createSweep","name":"Initiate  a new sweep transaction for a specific account","summary":"Initiate a sweep transaction","tags":[],"parameters":[{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"fromAccountDetails":[{}],"toAccountDetails":[{}],"overrides":[{}],"sweepType":"string","sweepName":"string","frequency":"string","nextRunDate":"2024-01-01","recordStatus":"string"}},"responses":{"200":"SweepResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/order/sweeps/{sweepId}","fullPath":"/api/v1.0.1/order/sweeps/{sweepId}","operationId":"getSweep","name":"Retrieves the details of specific sweep transaction","summary":"Overview of sweep transaction","tags":[],"parameters":[{"name":"sweepId","in":"path","type":"string","required":true,"description":"Identifier of the Retail account sweep"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"SweepResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/order/sweeps/{sweepId}","fullPath":"/api/v1.0.1/order/sweeps/{sweepId}","operationId":"updateSweep","name":"Updates an existing sweep transaction for specific account","summary":"Update a sweep transaction","tags":[],"parameters":[{"name":"sweepId","in":"path","type":"string","required":true,"description":"Identifier of the Retail account sweep"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"fromAccountDetails":[{}],"toAccountDetails":[{}],"overrides":[{}],"sweepType":"string","sweepName":"string","frequency":"string","nextRunDate":"2024-01-01","recordStatus":"string"}},"responses":{"200":"SweepResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"DELETE","path":"/order/sweeps/{sweepId}","fullPath":"/api/v1.0.1/order/sweeps/{sweepId}","operationId":"deleteSweep","name":"Remove an existing sweep transaction for specific account","summary":"Remove a sweep transaction","tags":[],"parameters":[{"name":"sweepId","in":"path","type":"string","required":true,"description":"Identifier of the Retail account sweep"},{"name":"payload","in":"body","type":"object","required":false,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}}},"responses":{"200":"SweepResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"DELETE","path":"/order/sweeps/cancellations/{sweepId}","fullPath":"/api/v1.0.1/order/sweeps/cancellations/{sweepId}","operationId":"rejectSweep","name":"Cancel a sweep transaction for specific account","summary":"Cancel a sweep transaction","tags":[],"parameters":[{"name":"sweepId","in":"path","type":"string","required":true,"description":"Identifier of the Retail account sweep"},{"name":"payload","in":"body","type":"object","required":false,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}}},"responses":{"200":"SweepResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/order/sweepsApprovals/{sweepId}","fullPath":"/api/v1.0.1/order/sweepsApprovals/{sweepId}","operationId":"approveSweep","name":"Approves a sweep transaction for specific account ","summary":"Approve a sweep transaction ","tags":[],"parameters":[{"name":"sweepId","in":"path","type":"string","required":true,"description":"Identifier of the Retail account sweep"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"SweepResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/order/sweeps/cancellations","fullPath":"/api/v1.0.1/order/sweeps/cancellations","operationId":"getSweepCancellations","name":"Retrieves the list of cancelled sweeps","summary":"Retrieves cancelled sweeps","tags":[],"parameters":[{"name":"sweepId","in":"query","type":"string","required":false,"description":"Identifier of the Retail account sweep"},{"name":"creditAccountId","in":"query","type":"string","required":false,"description":"Credit account identifier of the payment or transaction"},{"name":"debitAccountId","in":"query","type":"string","required":false,"description":"Indicates the debit account number of the payment or transaction."},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"SweepCancellationsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}}]},{"key":"order-sweeps-v1.0.0","title":"Order Sweeps Deprecated","version":"v1.0.0","description":"Create/View/Update/Delete Retail Sweep","endpointCount":5,"endpoints":[{"method":"POST","path":"/order/sweeps","fullPath":"/api/v1.0.0/order/sweeps","operationId":"createSweepTransaction","name":"Initiate  a new sweep transaction for a specific account - Deprecated. order-sweeps-service-v1.0.1 instead","summary":"Initiate a sweep transaction","tags":[],"parameters":[{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"creditAccountSweeps":[{}],"debitAccountSweeps":[{}],"sweepType":"string","displayName":"string","frequency":"string","nextRunDate":"2024-01-01"}},"responses":{"200":"SweepTransactionResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/order/sweeps/{sweepId}","fullPath":"/api/v1.0.0/order/sweeps/{sweepId}","operationId":"getSweepTransaction","name":"Retrieves the details of specific sweep transaction - Deprecated. order-sweeps-service-v1.0.1 instead","summary":"Overview of sweep transaction","tags":[],"parameters":[{"name":"sweepId","in":"path","type":"string","required":true,"description":"Identifier of the Retail account sweep"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"SweepTransactionResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/order/sweeps/{sweepId}","fullPath":"/api/v1.0.0/order/sweeps/{sweepId}","operationId":"updateSweepTransaction","name":"Updates an existing sweep transaction for specific account - Deprecated. order-sweeps-service-v1.0.1 instead","summary":"Update a sweep transaction","tags":[],"parameters":[{"name":"sweepId","in":"path","type":"string","required":true,"description":"Identifier of the Retail account sweep"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"creditAccountSweeps":[{}],"debitAccountSweeps":[{}],"sweepType":"string","displayName":"string","frequency":"string","nextRunDate":"2024-01-01"}},"responses":{"200":"SweepTransactionResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"DELETE","path":"/order/sweeps/{sweepId}","fullPath":"/api/v1.0.0/order/sweeps/{sweepId}","operationId":"reverseSweepTransaction","name":"Remove an existing sweep transaction for specific account - Deprecated. order-sweeps-service-v1.0.1 instead","summary":"Remove a sweep transaction","tags":[],"parameters":[{"name":"sweepId","in":"path","type":"string","required":true,"description":"Identifier of the Retail account sweep"},{"name":"payload","in":"body","type":"object","required":false,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}}},"responses":{"200":"SweepTransactionResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"DELETE","path":"/order/sweeps/cancellations/{sweepId}","fullPath":"/api/v1.0.0/order/sweeps/cancellations/{sweepId}","operationId":"deleteSweepTransaction","name":"Cancel a sweep transaction for specific account - Deprecated. order-sweeps-service-v1.0.1 instead","summary":"Cancel a sweep transaction","tags":[],"parameters":[{"name":"sweepId","in":"path","type":"string","required":true,"description":"Identifier of the Retail account sweep"},{"name":"payload","in":"body","type":"object","required":false,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}}},"responses":{"200":"SweepTransactionResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}}]},{"key":"order-transactionstop-v1.0.0","title":"Management of Transaction stops","version":"v1.0.0","description":"API to create, update and manage transaction stop instructions based on the on the nature of the transaction and any associated fund authorisation requests ","endpointCount":5,"endpoints":[{"method":"POST","path":"/order/transactionStops","fullPath":"/api/v1.0.0/order/transactionStops","operationId":"createTransactionStop","name":"Create Transaction Stop Instruction specific to a Customer or Account to stop the Transactions matching the Instructions","summary":"Create Transaction Stop Instruction","tags":[],"parameters":[{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"attributes":[{}],"customerId":0.0,"accountId":0.0,"transactionStopConditionId":"string","transactionStopChannel":"string","stopInstructionChannel":"string","stopReason":"string","description":"string","cancelInstruction":"string","issueDate":"string","stopInstructionAppliesTo":"string"}},"responses":{"200":"TransactionStopResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/order/transactionStops/{transactionStopId}","fullPath":"/api/v1.0.0/order/transactionStops/{transactionStopId}","operationId":"getStopInstructions","name":"Retrieves the list of Stop Instruction Details for a specific Account based on which the Transactions are stopped","summary":"Retrieves list of transaction stop instruction details","tags":[],"parameters":[{"name":"transactionStopId","in":"path","type":"string","required":true,"description":"Identifier  of the Transaction Stops."},{"name":"customerId","in":"query","type":"string","required":false,"description":"Identifier of the customer"},{"name":"transactionChannel","in":"query","type":"string","required":false,"description":"The channel through which the transaction has been placed"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from t24 on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"StopInstructionsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"PUT","path":"/order/transactionStops/{transactionStopId}","fullPath":"/api/v1.0.0/order/transactionStops/{transactionStopId}","operationId":"updateTransactionStop","name":"Update or Cancel the Transaction Stop Instruction for a specific Customer or Account","summary":"Amend Transaction Stop Instruction","tags":[],"parameters":[{"name":"transactionStopId","in":"path","type":"string","required":true,"description":"Identifier  of the Transaction Stops."},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"attributes":[{}],"customerId":0.0,"accountId":0.0,"transactionStopConditionId":"string","transactionStopChannel":"string","stopInstructionChannel":"string","stopReason":"string","description":"string","cancelInstruction":"string","issueDate":"string","stopInstructionAppliesTo":"string"}},"responses":{"200":"TransactionStopResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/order/transactionStops/investigations","fullPath":"/api/v1.0.0/order/transactionStops/investigations","operationId":"getInvestigationItems","name":"Retrieves the list of Funds Authorisation requests that are pending for approvals related to the Account or Customer Stop Instructions","summary":"Retrieves list of Pending Funds Authorisation Requests","tags":[],"parameters":[{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from t24 on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"InvestigationItemsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"PUT","path":"/order/transactionStops/{transactionStopId}/investigations","fullPath":"/api/v1.0.0/order/transactionStops/{transactionStopId}/investigations","operationId":"updateTransactionStopInvestigations","name":"Update Approval decision on Pending Funds Authorisation requests for a Transaction stopped by the Stop Instruction","summary":"Update the Status of Pending Funds Authorisation Request","tags":[],"parameters":[{"name":"transactionStopId","in":"path","type":"string","required":true,"description":"Identifier  of the Transaction Stops."},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"decisionReasons":[{}],"transactionStopInstruction":[{}],"debitAccount":"string","accountCurrency":"string","requestedCurrency":"string","requestedAmount":"string","fundsDecision":"string","transactionReference":"string","fundsAuthorisationStatus":"string"}},"responses":{"200":"TransactionStopInvestigationsResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}}]},{"key":"order-us-genericAccountingService-v1.0.0","title":"API for teller and branch processing systems","version":"v1.0.0","description":"API manages the accounting requests from teller or branch transaction processing systems for supporting single and multi-transaction, teller transactions and bulk checks deposits. A branch transaction with one entry (single transaction) or more(multi-transaction), may be posted to one more of the ac","endpointCount":11,"endpoints":[{"method":"POST","path":"/order/us/payments/branchEntries","fullPath":"/api/v1.0.0/order/us/payments/branchEntries","operationId":"createUsBranchEntries","name":"Validates the account, posting restrictions on accounts, balance availability before processing a branch entry request. Once validation is successful, accounting is posted in Transact and the transaction information like transaction type for each entry, check information(Check number, routing number, check amount, check image reference, check hold date and amounts) are recorded in Transact. When there are more than one check involved in a check deposit or other check transactions, the correspond","summary":"Validates a branch transaction and posts accounting entries.","tags":[],"parameters":[{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."}],"requestBodyExample":{"header":{},"body":{"csmApplication":"string","csmAction":"string","transactionInput":[{}]}},"responses":{"200":"UsBranchEntriesResponse","default":"GAIErrorResponse","400":"BusinessGAIErrorResponse","500":"SystemGAIErrorResponse"}},{"method":"POST","path":"/order/us/payments/branchEntries/bulkChecks","fullPath":"/api/v1.0.0/order/us/payments/branchEntries/bulkChecks","operationId":"createUsInterimEntries","name":"Allows to post accounting for a bulk check deposit made in a branch. This bulk check deposit transaction is an interim transaction at this stage as the checks will not have been scanned, proofed and updated in Transact. The Teller or branch transaction processing systems will send request to apply holds on the funds until scanning and proofing is completed. After checks are scanned and proofed, if there are an changes to the original amount booked in interim transaction, a correction entry will ","summary":"Posts accounting for a bulk check deposit transaction.","tags":[],"parameters":[{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."}],"requestBodyExample":{"header":{},"body":{"csmApplication":"string","csmAction":"string","transactionInput":[{}]}},"responses":{"200":"UsInterimEntriesResponse","default":"GAIErrorResponse","400":"BusinessGAIErrorResponse","500":"SystemGAIErrorResponse"}},{"method":"POST","path":"/order/us/payments/branchEntries/bulkChecks/adjustments","fullPath":"/api/v1.0.0/order/us/payments/branchEntries/bulkChecks/adjustments","operationId":"createUsAdjustmentEntries","name":"Posts an adjustment entry for a bulk check deposit transaction if there is a difference in the original entry posted as part of interim transaction and the check amount amounts after scanning and proofing is completed.","summary":"Post an adjustment entry for a bulk check deposit transaction where an entry was posted previously.","tags":[],"parameters":[{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."}],"requestBodyExample":{"header":{},"body":{"csmApplication":"string","csmAction":"string","transactionInput":[{}]}},"responses":{"200":"UsAdjustmentEntriesResponse","default":"GAIErrorResponse","400":"BusinessGAIErrorResponse","500":"SystemGAIErrorResponse"}},{"method":"POST","path":"/order/us/payments/branchEntries/bulkChecks/pendings","fullPath":"/api/v1.0.0/order/us/payments/branchEntries/bulkChecks/pendings","operationId":"createUsProofedEntries","name":"Posts accounting entries for a bulk check transaction after check scanning and proofing process is complete. Check information would have been captured already in Transact. Accounting and funds availability can be managed as part of this request. ","summary":"Posts accounting entries for a bulk check transaction.","tags":[],"parameters":[{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."}],"requestBodyExample":{"header":{},"body":{"csmApplication":"string","csmAction":"string","transactionInput":[{}]}},"responses":{"200":"UsProofedEntriesResponse","default":"GAIErrorResponse","400":"BusinessGAIErrorResponse","500":"SystemGAIErrorResponse"}},{"method":"PUT","path":"/order/us/payments/branchEntries/{transactionId}/bulkChecks","fullPath":"/api/v1.0.0/order/us/payments/branchEntries/{transactionId}/bulkChecks","operationId":"updateUsBulkChecks","name":"Updates the check information for a bulk check deposit transaction. After scanning and proofing process is completed, the check information sent in the request for the original transaction reference(transactionId) is captured in Transact.","summary":"Update the check information related to a bulk check deposit transaction.","tags":["RETAIL"],"parameters":[{"name":"transactionId","in":"path","type":"string","required":true,"description":"Unique transaction identifier for retrieving the details of the transaction. For example: FT0102030333 etc."},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{},"body":{"transactionDetails":[{}],"checkExposureDetails":[{}],"cashBoxOne":"string","branchId":"string","extensions":{}}},"responses":{"200":"UsBulkChecksResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/order/us/payments/branchEntries/pendings/accounts/{accountId}/dates/{processingDate}/exceptions","fullPath":"/api/v1.0.0/order/us/payments/branchEntries/pendings/accounts/{accountId}/dates/{processingDate}/exceptions","operationId":"getUsCorrectionsBranchEntriesByAccountId","name":"Retrieves the list of transactions where accounting was posted as part of interim transaction, but the check amounts do not match the original entry posted by account id and processing date.","summary":"Retrieve the list of checks pending for correction by account id","tags":["RETAIL"],"parameters":[{"name":"accountId","in":"path","type":"string","required":true,"description":"Identifier of the account. Often referred to as the account number, yet for consistency this is always referred to as accountId. Accepts both IBAN & BBAN"},{"name":"processingDate","in":"path","type":"string","required":true,"description":"The date when payment instruction is processed in system."},{"name":"transactionId","in":"query","type":"string","required":false,"description":"Unique transaction identifier for retrieving the details of the transaction. For example: FT0102030333 etc."},{"name":"branchId","in":"query","type":"string","required":false,"description":"Unique and unambiguous identification of a branch of a financial institution."},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"UsCorrectionsBranchEntriesByAccountIdResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/order/us/payments/branchEntries/pendings/transactions/{transactionId}/dates/{processingDate}/exceptions","fullPath":"/api/v1.0.0/order/us/payments/branchEntries/pendings/transactions/{transactionId}/dates/{processingDate}/exceptions","operationId":"getUsCorrectionsBranchEntriesByTransactionId","name":"Retrieves the list of transactions where accounting was posted as part of interim transaction, but the check amounts do not match the original entry posted by transaction id and processing date.","summary":"Retrieve the list of checks pending for correction by transaction id","tags":["RETAIL"],"parameters":[{"name":"transactionId","in":"path","type":"string","required":true,"description":"Unique transaction identifier for retrieving the details of the transaction. For example: FT0102030333 etc."},{"name":"processingDate","in":"path","type":"string","required":true,"description":"The date when payment instruction is processed in system."},{"name":"accountId","in":"query","type":"string","required":false,"description":"Identifier of the account. Often referred to as the account number, yet for consistency this is always referred to as accountId. Accepts both IBAN & BBAN"},{"name":"branchId","in":"query","type":"string","required":false,"description":"Unique and unambiguous identification of a branch of a financial institution."},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"UsCorrectionsBranchEntriesByTransactionIdResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/order/us/payments/branchEntries/pendings/accounts/{accountId}/dates/{processingDate}","fullPath":"/api/v1.0.0/order/us/payments/branchEntries/pendings/accounts/{accountId}/dates/{processingDate}","operationId":"getUsPendingBranchEntriesByAccountId","name":"Retrieves the list of bulk check deposit transactions for an account where accounting was not posted during interim transaction and the scanning and proofing of checks is completed by account id and processing date.","summary":"Retrieve the list of bulk check transactions for an account where accounting is yet to be posted by account id","tags":["RETAIL"],"parameters":[{"name":"accountId","in":"path","type":"string","required":true,"description":"Identifier of the account. Often referred to as the account number, yet for consistency this is always referred to as accountId. Accepts both IBAN & BBAN"},{"name":"processingDate","in":"path","type":"string","required":true,"description":"The date when payment instruction is processed in system."},{"name":"transactionId","in":"query","type":"string","required":false,"description":"Unique transaction identifier for retrieving the details of the transaction. For example: FT0102030333 etc."},{"name":"branchId","in":"query","type":"string","required":false,"description":"Unique and unambiguous identification of a branch of a financial institution."},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"UsPendingBranchEntriesByAccountIdResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/order/us/payments/branchEntries/pendings/transactions/{transactionId}/dates/{processingDate}","fullPath":"/api/v1.0.0/order/us/payments/branchEntries/pendings/transactions/{transactionId}/dates/{processingDate}","operationId":"getUsPendingBranchEntriesByTransactionId","name":"Retrieves the list of bulk check deposit transactions for an account where accounting was not posted during interim transaction and the scanning and proofing of checks is completed by transaction id and processing date.","summary":"Retrieve the list of bulk check transactions for an account where accounting is yet to be posted by transaction id","tags":["RETAIL"],"parameters":[{"name":"transactionId","in":"path","type":"string","required":true,"description":"Unique transaction identifier for retrieving the details of the transaction. For example: FT0102030333 etc."},{"name":"processingDate","in":"path","type":"string","required":true,"description":"The date when payment instruction is processed in system."},{"name":"accountId","in":"query","type":"string","required":false,"description":"Identifier of the account. Often referred to as the account number, yet for consistency this is always referred to as accountId. Accepts both IBAN & BBAN"},{"name":"branchId","in":"query","type":"string","required":false,"description":"Unique and unambiguous identification of a branch of a financial institution."},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"UsPendingBranchEntriesByTransactionIdResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/order/us/payments/branchEntries/accounts/{accountId}/dates/{processingDate}","fullPath":"/api/v1.0.0/order/us/payments/branchEntries/accounts/{accountId}/dates/{processingDate}","operationId":"getUsBranchEntriesByAccountId","name":"Retrieves the branch entry details like transaction types, account numbers, amounts, check numbers, routing numbers for the checks, check image reference, status etc,. by account id and processing date","summary":"Retrieve the branch transaction entry details by account id","tags":["RETAIL"],"parameters":[{"name":"accountId","in":"path","type":"string","required":true,"description":"Identifier of the account. Often referred to as the account number, yet for consistency this is always referred to as accountId. Accepts both IBAN & BBAN"},{"name":"processingDate","in":"path","type":"string","required":true,"description":"The date when payment instruction is processed in system."},{"name":"transactionId","in":"query","type":"string","required":false,"description":"Unique transaction identifier for retrieving the details of the transaction. For example: FT0102030333 etc."},{"name":"branchId","in":"query","type":"string","required":false,"description":"Unique and unambiguous identification of a branch of a financial institution."},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"UsBranchEntriesByAccountIdResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/order/us/payments/branchEntries/transactions/{transactionId}/dates/{processingDate}","fullPath":"/api/v1.0.0/order/us/payments/branchEntries/transactions/{transactionId}/dates/{processingDate}","operationId":"getUsBranchEntriesByTransactionId","name":"Retrieves the branch entry details like transaction types, account numbers, amounts, check numbers, routing numbers for the checks, check image reference, status etc,. by transaction id and processing date","summary":"Retrieve the branch transaction entry details by transaction id","tags":["RETAIL"],"parameters":[{"name":"transactionId","in":"path","type":"string","required":true,"description":"Unique transaction identifier for retrieving the details of the transaction. For example: FT0102030333 etc."},{"name":"processingDate","in":"path","type":"string","required":true,"description":"The date when payment instruction is processed in system."},{"name":"accountId","in":"query","type":"string","required":false,"description":"Identifier of the account. Often referred to as the account number, yet for consistency this is always referred to as accountId. Accepts both IBAN & BBAN"},{"name":"branchId","in":"query","type":"string","required":false,"description":"Unique and unambiguous identification of a branch of a financial institution."},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"UsBranchEntriesByTransactionIdResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}}]},{"key":"order-us-genericAccountingService-v2.0.0","title":"API for teller and branch processing systems","version":"v2.0.0","description":"API manages the accounting requests from teller or branch transaction processing systems for supporting single and multi-transaction, teller transactions and bulk checks deposits. A branch transaction with one entry (single transaction) or more(multi-transaction), may be posted to one more of the ac","endpointCount":12,"endpoints":[{"method":"POST","path":"/order/us/payments/branchEntries","fullPath":"/api/v2.0.0/order/us/payments/branchEntries","operationId":"createUsBranchEntries","name":"Validates the account, posting restrictions on accounts, balance availability before processing a branch entry request. Once validation is successful, accounting is posted in Transact and the transaction information like transaction type for each entry, check information(Check number, routing number, check amount, check image reference, check hold date and amounts) are recorded in Transact. When there are more than one check involved in a check deposit or other check transactions, the correspond","summary":"Validates a branch transaction and posts accounting entries.","tags":[],"parameters":[{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."}],"requestBodyExample":{"header":{},"body":{"csmApplication":"string","csmAction":"string","transactionInput":[{}]}},"responses":{"200":"UsBranchEntriesResponse","default":"GAIErrorResponse","400":"BusinessGAIErrorResponse","500":"SystemGAIErrorResponse"}},{"method":"POST","path":"/order/us/payments/branchEntries/bulkChecks","fullPath":"/api/v2.0.0/order/us/payments/branchEntries/bulkChecks","operationId":"createUsInterimEntries","name":"Creates accounting entries for a bulk check deposit made in a branch. This bulk check deposit transaction is an interim transaction at this stage as the checks will not have been scanned, proofed and updated in Transact. The Teller or branch transaction processing systems will send request to apply holds on the funds until scanning and proofing is completed. After checks are scanned and proofed, if there are an changes to the original amount booked in interim transaction, a correction entry will","summary":"Creates accounting entries for a bulk check deposit transaction.","tags":[],"parameters":[{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."}],"requestBodyExample":{"header":{},"body":{"csmApplication":"string","csmAction":"string","transactionInput":[{}]}},"responses":{"200":"UsInterimEntriesResponse","default":"GAIErrorResponse","400":"BusinessGAIErrorResponse","500":"SystemGAIErrorResponse"}},{"method":"POST","path":"/order/us/payments/branchEntries/bulkChecks/adjustments","fullPath":"/api/v2.0.0/order/us/payments/branchEntries/bulkChecks/adjustments","operationId":"createUsAdjustmentEntries","name":"Creates an adjustment entry for a bulk check deposit transaction if there is a difference in the original entry posted as part of interim transaction and the check amount amounts after scanning and proofing is completed.","summary":"Creates an adjustment entry for a bulk check deposit transaction where an entry was posted previously.","tags":[],"parameters":[{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."}],"requestBodyExample":{"header":{},"body":{"csmApplication":"string","csmAction":"string","transactionInput":[{}]}},"responses":{"200":"UsAdjustmentEntriesResponse","default":"GAIErrorResponse","400":"BusinessGAIErrorResponse","500":"SystemGAIErrorResponse"}},{"method":"POST","path":"/order/us/payments/branchEntries/bulkChecks/pendings","fullPath":"/api/v2.0.0/order/us/payments/branchEntries/bulkChecks/pendings","operationId":"createUsProofedEntries","name":"Creates accounting entries for a bulk check transaction after check scanning and proofing process is complete. Check information would have been captured already in Transact. Accounting and funds availability can be managed as part of this request. ","summary":"Creates accounting entries for a bulk check transaction.","tags":[],"parameters":[{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."}],"requestBodyExample":{"header":{},"body":{"csmApplication":"string","csmAction":"string","transactionInput":[{}]}},"responses":{"200":"UsProofedEntriesResponse","default":"GAIErrorResponse","400":"BusinessGAIErrorResponse","500":"SystemGAIErrorResponse"}},{"method":"PUT","path":"/order/us/payments/branchEntries/{transactionId}/bulkChecks","fullPath":"/api/v2.0.0/order/us/payments/branchEntries/{transactionId}/bulkChecks","operationId":"updateUsBulkChecks","name":"Updates the check information for a bulk check deposit transaction. After scanning and proofing process is completed, the check information sent in the request for the original transaction reference(transactionId) is captured in Transact.","summary":"Update the check information related to a bulk check deposit transaction.","tags":["RETAIL"],"parameters":[{"name":"transactionId","in":"path","type":"string","required":true,"description":"Unique transaction identifier for retrieving the details of the transaction. For example: FT0102030333 etc."},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{},"body":{"transactionDetails":[{}],"checkExposureDetails":[{}],"cashBoxOne":"string","branchId":"string","extensions":{}}},"responses":{"200":"UsBulkChecksResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/order/us/payments/branchEntries/pendings/accounts/{accountId}/dates/{processingDate}/exceptions","fullPath":"/api/v2.0.0/order/us/payments/branchEntries/pendings/accounts/{accountId}/dates/{processingDate}/exceptions","operationId":"getUsCorrectionsBranchEntriesByAccountId","name":"Retrieves the list of transactions where accounting was posted as part of interim transaction, but the check amounts do not match the original entry posted by account id and processing date.","summary":"Retrieve the list of checks pending for correction by account id","tags":["RETAIL"],"parameters":[{"name":"accountId","in":"path","type":"string","required":true,"description":"Identifier of the account. Often referred to as the account number, yet for consistency this is always referred to as accountId. Accepts both IBAN & BBAN"},{"name":"processingDate","in":"path","type":"string","required":true,"description":"The date when payment instruction is processed in system."},{"name":"transactionId","in":"query","type":"string","required":false,"description":"Unique transaction identifier for retrieving the details of the transaction. For example: FT0102030333 etc."},{"name":"branchId","in":"query","type":"string","required":false,"description":"Unique and unambiguous identification of a branch of a financial institution."},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"UsCorrectionsBranchEntriesByAccountIdResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/order/us/payments/branchEntries/pendings/transactions/{transactionId}/dates/{processingDate}/exceptions","fullPath":"/api/v2.0.0/order/us/payments/branchEntries/pendings/transactions/{transactionId}/dates/{processingDate}/exceptions","operationId":"getUsCorrectionsBranchEntriesByTransactionId","name":"Retrieves the list of transactions where accounting was posted as part of interim transaction, but the check amounts do not match the original entry posted by transaction id and processing date.","summary":"Retrieve the list of checks pending for correction by transaction id","tags":["RETAIL"],"parameters":[{"name":"transactionId","in":"path","type":"string","required":true,"description":"Unique transaction identifier for retrieving the details of the transaction. For example: FT0102030333 etc."},{"name":"processingDate","in":"path","type":"string","required":true,"description":"The date when payment instruction is processed in system."},{"name":"accountId","in":"query","type":"string","required":false,"description":"Identifier of the account. Often referred to as the account number, yet for consistency this is always referred to as accountId. Accepts both IBAN & BBAN"},{"name":"branchId","in":"query","type":"string","required":false,"description":"Unique and unambiguous identification of a branch of a financial institution."},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"UsCorrectionsBranchEntriesByTransactionIdResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/order/us/payments/branchEntries/pendings/accounts/{accountId}/dates/{processingDate}","fullPath":"/api/v2.0.0/order/us/payments/branchEntries/pendings/accounts/{accountId}/dates/{processingDate}","operationId":"getUsPendingBranchEntriesByAccountId","name":"Retrieves the list of bulk check deposit transactions for an account where accounting was not posted during interim transaction and the scanning and proofing of checks is completed by account id and processing date.","summary":"Retrieve the list of bulk check transactions for an account where accounting is yet to be posted by account id","tags":["RETAIL"],"parameters":[{"name":"accountId","in":"path","type":"string","required":true,"description":"Identifier of the account. Often referred to as the account number, yet for consistency this is always referred to as accountId. Accepts both IBAN & BBAN"},{"name":"processingDate","in":"path","type":"string","required":true,"description":"The date when payment instruction is processed in system."},{"name":"transactionId","in":"query","type":"string","required":false,"description":"Unique transaction identifier for retrieving the details of the transaction. For example: FT0102030333 etc."},{"name":"branchId","in":"query","type":"string","required":false,"description":"Unique and unambiguous identification of a branch of a financial institution."},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"UsPendingBranchEntriesByAccountIdResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/order/us/payments/branchEntries/pendings/transactions/{transactionId}/dates/{processingDate}","fullPath":"/api/v2.0.0/order/us/payments/branchEntries/pendings/transactions/{transactionId}/dates/{processingDate}","operationId":"getUsPendingBranchEntriesByTransactionId","name":"Retrieves the list of bulk check deposit transactions for an account where accounting was not posted during interim transaction and the scanning and proofing of checks is completed by transaction id and processing date.","summary":"Retrieve the list of bulk check transactions for an account where accounting is yet to be posted by transaction id","tags":["RETAIL"],"parameters":[{"name":"transactionId","in":"path","type":"string","required":true,"description":"Unique transaction identifier for retrieving the details of the transaction. For example: FT0102030333 etc."},{"name":"processingDate","in":"path","type":"string","required":true,"description":"The date when payment instruction is processed in system."},{"name":"accountId","in":"query","type":"string","required":false,"description":"Identifier of the account. Often referred to as the account number, yet for consistency this is always referred to as accountId. Accepts both IBAN & BBAN"},{"name":"branchId","in":"query","type":"string","required":false,"description":"Unique and unambiguous identification of a branch of a financial institution."},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"UsPendingBranchEntriesByTransactionIdResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/order/us/payments/branchEntries/accounts/{accountId}/dates/{processingDate}","fullPath":"/api/v2.0.0/order/us/payments/branchEntries/accounts/{accountId}/dates/{processingDate}","operationId":"getUsBranchEntriesByAccountId","name":"Retrieves the branch entry details like transaction types, account numbers, amounts, check numbers, routing numbers for the checks, check image reference, status etc,. by account id and processing date","summary":"Retrieve the branch transaction entry details by account id","tags":["RETAIL"],"parameters":[{"name":"accountId","in":"path","type":"string","required":true,"description":"Identifier of the account. Often referred to as the account number, yet for consistency this is always referred to as accountId. Accepts both IBAN & BBAN"},{"name":"processingDate","in":"path","type":"string","required":true,"description":"The date when payment instruction is processed in system."},{"name":"transactionId","in":"query","type":"string","required":false,"description":"Unique transaction identifier for retrieving the details of the transaction. For example: FT0102030333 etc."},{"name":"branchId","in":"query","type":"string","required":false,"description":"Unique and unambiguous identification of a branch of a financial institution."},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"UsBranchEntriesByAccountIdResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/order/us/payments/branchEntries/transactions/{transactionId}/dates/{processingDate}","fullPath":"/api/v2.0.0/order/us/payments/branchEntries/transactions/{transactionId}/dates/{processingDate}","operationId":"getUsBranchEntriesByTransactionId","name":"Retrieves the branch entry details like transaction types, account numbers, amounts, check numbers, routing numbers for the checks, check image reference, status etc,. by transaction id and processing date","summary":"Retrieve the branch transaction entry details by transaction id","tags":["RETAIL"],"parameters":[{"name":"transactionId","in":"path","type":"string","required":true,"description":"Unique transaction identifier for retrieving the details of the transaction. For example: FT0102030333 etc."},{"name":"processingDate","in":"path","type":"string","required":true,"description":"The date when payment instruction is processed in system."},{"name":"accountId","in":"query","type":"string","required":false,"description":"Identifier of the account. Often referred to as the account number, yet for consistency this is always referred to as accountId. Accepts both IBAN & BBAN"},{"name":"branchId","in":"query","type":"string","required":false,"description":"Unique and unambiguous identification of a branch of a financial institution."},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"UsBranchEntriesByTransactionIdResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"POST","path":"/order/us/payments/pointOfSale","fullPath":"/api/v2.0.0/order/us/payments/pointOfSale","operationId":"createPointOfSaleTransactions","name":"Create point of sale payment transaction with details such as account, currency, transaction codes, etc. Any third party system with which the bank integrates for point of sale transactions can use this API.","summary":"Create point of sale payment transaction.","tags":[],"parameters":[{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."}],"requestBodyExample":{"header":{},"body":{"csmApplication":"string","csmAction":"string","transactionInput":[{}]}},"responses":{"200":"PointOfSaleTransactionsResponse","default":"GAIErrorResponse","400":"BusinessGAIErrorResponse","500":"SystemGAIErrorResponse"}}]},{"key":"order-us-genericAccountingService-v2.1.0","title":"API for teller and branch processing systems","version":"v2.1.0","description":"API manages the accounting requests from teller or branch transaction processing systems for supporting single and multi-transaction, teller transactions and bulk checks deposits. A branch transaction with one entry (single transaction) or more(multi-transaction), may be posted to one more of the ac","endpointCount":12,"endpoints":[{"method":"POST","path":"/order/us/payments/branchEntries","fullPath":"/api/v2.1.0/order/us/payments/branchEntries","operationId":"createUsBranchEntries","name":"Validates the account, posting restrictions on accounts, balance availability before processing a branch entries request. Once validation is successful, accounting is posted in Transact and the Transact information like transaction type for each entry, check information(Check number, routing number, check amount, check image reference, check hold date and amounts) are recorded in Transact. When there are more than one check involved in a check deposit or other check transactions, the correspondi","summary":"Validates a branch transaction and posts accounting entries.","tags":[],"parameters":[{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."}],"requestBodyExample":{"header":{},"body":{"csmApplication":"string","csmAction":"string","transactionInput":[{}]}},"responses":{"200":"UsBranchEntriesResponse","default":"GAIErrorResponse","400":"BusinessGAIErrorResponse","500":"SystemGAIErrorResponse"}},{"method":"POST","path":"/order/us/payments/branchEntries/bulkChecks","fullPath":"/api/v2.1.0/order/us/payments/branchEntries/bulkChecks","operationId":"createUsInterimEntries","name":"Creates accounting entries for a bulk check deposit made in a branch. This bulk check deposit transaction is an interim transaction at this stage as the checks will not have been scanned, proofed and updated in Transact. The Teller or branch transaction processing systems will send request to apply holds on the funds until scanning and proofing is completed. After checks are scanned and proofed, if there are an changes to the original amount booked in interim transaction, a correction entry will","summary":"Creates accounting entries for a bulk check deposit transaction.","tags":[],"parameters":[{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."}],"requestBodyExample":{"header":{},"body":{"csmApplication":"string","csmAction":"string","transactionInput":[{}]}},"responses":{"200":"UsInterimEntriesResponse","default":"GAIErrorResponse","400":"BusinessGAIErrorResponse","500":"SystemGAIErrorResponse"}},{"method":"POST","path":"/order/us/payments/branchEntries/bulkChecks/adjustments","fullPath":"/api/v2.1.0/order/us/payments/branchEntries/bulkChecks/adjustments","operationId":"createUsAdjustmentEntries","name":"Creates an adjustment entry for a bulk check deposit transaction if there is a difference in the original entry posted as part of interim transaction and the check amount amounts after scanning and proofing is completed.","summary":"Creates an adjustment entry for a bulk check deposit transaction where an entry was posted previously.","tags":[],"parameters":[{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."}],"requestBodyExample":{"header":{},"body":{"csmApplication":"string","csmAction":"string","transactionInput":[{}]}},"responses":{"200":"UsAdjustmentEntriesResponse","default":"GAIErrorResponse","400":"BusinessGAIErrorResponse","500":"SystemGAIErrorResponse"}},{"method":"POST","path":"/order/us/payments/branchEntries/bulkChecks/pendings","fullPath":"/api/v2.1.0/order/us/payments/branchEntries/bulkChecks/pendings","operationId":"createUsProofedEntries","name":"Posts accounting entries for a bulk check transaction after check scanning and proofing process is complete. Check information would have been captured already in Transact. Accounting and funds availability can be managed as part of this request. ","summary":"Posts accounting entries for a bulk check transaction","tags":[],"parameters":[{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."}],"requestBodyExample":{"header":{},"body":{"csmApplication":"string","csmAction":"string","transactionInput":[{}]}},"responses":{"200":"UsProofedEntriesResponse","default":"GAIErrorResponse","400":"BusinessGAIErrorResponse","500":"SystemGAIErrorResponse"}},{"method":"PUT","path":"/order/us/payments/branchEntries/{transactionId}/bulkChecks","fullPath":"/api/v2.1.0/order/us/payments/branchEntries/{transactionId}/bulkChecks","operationId":"updateUsBulkChecks","name":"Updates the check information for a bulk check deposit transaction. After scanning and proofing process is completed, the check information sent in the request for the original transaction reference(transactionId) is captured in Transact.","summary":"Update the check information related to a bulk check deposit transaction.","tags":["RETAIL"],"parameters":[{"name":"transactionId","in":"path","type":"string","required":true,"description":"Unique transaction identifier for retrieving the details of the transaction. For example: FT0102030333 etc."},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{},"body":{"transactionDetails":[{}],"checkExposureDetails":[{}],"cashBoxOne":"string","branchId":"string","extensions":{}}},"responses":{"200":"UsBulkChecksResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/order/us/payments/branchEntries/pendings/accounts/{accountId}/dates/{processingDate}/exceptions","fullPath":"/api/v2.1.0/order/us/payments/branchEntries/pendings/accounts/{accountId}/dates/{processingDate}/exceptions","operationId":"getUsCorrectionsBranchEntriesByAccountId","name":"Retrieves the list of transactions where accounting was posted as part of interim transaction, but the check amounts do not match the original entry posted by account id and processing date.","summary":"Retrieve the list of checks pending for correction by account id","tags":["RETAIL"],"parameters":[{"name":"accountId","in":"path","type":"string","required":true,"description":"Identifier of the account. Often referred to as the account number, yet for consistency this is always referred to as accountId. Accepts both IBAN & BBAN"},{"name":"processingDate","in":"path","type":"string","required":true,"description":"The date when payment instruction is processed in system."},{"name":"transactionId","in":"query","type":"string","required":false,"description":"Unique transaction identifier for retrieving the details of the transaction. For example: FT0102030333 etc."},{"name":"branchId","in":"query","type":"string","required":false,"description":"Unique and unambiguous identification of a branch of a financial institution."},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"UsCorrectionsBranchEntriesByAccountIdResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/order/us/payments/branchEntries/pendings/transactions/{transactionId}/dates/{processingDate}/exceptions","fullPath":"/api/v2.1.0/order/us/payments/branchEntries/pendings/transactions/{transactionId}/dates/{processingDate}/exceptions","operationId":"getUsCorrectionsBranchEntriesByTransactionId","name":"Retrieves the list of transactions where accounting was posted as part of interim transaction, but the check amounts do not match the original entry posted by transaction id and processing date.","summary":"Retrieve the list of checks pending for correction by transaction id","tags":["RETAIL"],"parameters":[{"name":"transactionId","in":"path","type":"string","required":true,"description":"Unique transaction identifier for retrieving the details of the transaction. For example: FT0102030333 etc."},{"name":"processingDate","in":"path","type":"string","required":true,"description":"The date when payment instruction is processed in system."},{"name":"accountId","in":"query","type":"string","required":false,"description":"Identifier of the account. Often referred to as the account number, yet for consistency this is always referred to as accountId. Accepts both IBAN & BBAN"},{"name":"branchId","in":"query","type":"string","required":false,"description":"Unique and unambiguous identification of a branch of a financial institution."},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"UsCorrectionsBranchEntriesByTransactionIdResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/order/us/payments/branchEntries/pendings/accounts/{accountId}/dates/{processingDate}","fullPath":"/api/v2.1.0/order/us/payments/branchEntries/pendings/accounts/{accountId}/dates/{processingDate}","operationId":"getUsPendingBranchEntriesByAccountId","name":"Retrieves the list of bulk check deposit transactions for an account where accounting was not posted during interim transaction and the scanning and proofing of checks is completed by account id and processing date.","summary":"Retrieve the list of bulk check transactions for an account where accounting is yet to be posted by account id","tags":["RETAIL"],"parameters":[{"name":"accountId","in":"path","type":"string","required":true,"description":"Identifier of the account. Often referred to as the account number, yet for consistency this is always referred to as accountId. Accepts both IBAN & BBAN"},{"name":"processingDate","in":"path","type":"string","required":true,"description":"The date when payment instruction is processed in system."},{"name":"transactionId","in":"query","type":"string","required":false,"description":"Unique transaction identifier for retrieving the details of the transaction. For example: FT0102030333 etc."},{"name":"branchId","in":"query","type":"string","required":false,"description":"Unique and unambiguous identification of a branch of a financial institution."},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"UsPendingBranchEntriesByAccountIdResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/order/us/payments/branchEntries/pendings/transactions/{transactionId}/dates/{processingDate}","fullPath":"/api/v2.1.0/order/us/payments/branchEntries/pendings/transactions/{transactionId}/dates/{processingDate}","operationId":"getUsPendingBranchEntriesByTransactionId","name":"Retrieves the list of bulk check deposit transactions for an account where accounting was not posted during interim transaction and the scanning and proofing of checks is completed by transaction id and processing date.","summary":"Retrieve the list of bulk check transactions for an account where accounting is yet to be posted by transaction id","tags":["RETAIL"],"parameters":[{"name":"transactionId","in":"path","type":"string","required":true,"description":"Unique transaction identifier for retrieving the details of the transaction. For example: FT0102030333 etc."},{"name":"processingDate","in":"path","type":"string","required":true,"description":"The date when payment instruction is processed in system."},{"name":"accountId","in":"query","type":"string","required":false,"description":"Identifier of the account. Often referred to as the account number, yet for consistency this is always referred to as accountId. Accepts both IBAN & BBAN"},{"name":"branchId","in":"query","type":"string","required":false,"description":"Unique and unambiguous identification of a branch of a financial institution."},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"UsPendingBranchEntriesByTransactionIdResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/order/us/payments/branchEntries/accounts/{accountId}/dates/{processingDate}","fullPath":"/api/v2.1.0/order/us/payments/branchEntries/accounts/{accountId}/dates/{processingDate}","operationId":"getUsBranchEntriesByAccountId","name":"Retrieves the branch entry details like transaction types, account numbers, amounts, check numbers, routing numbers for the checks, check image reference, status etc,. by account id and processing date","summary":"Retrieve the branch transaction entry details by account id","tags":["RETAIL"],"parameters":[{"name":"accountId","in":"path","type":"string","required":true,"description":"Identifier of the account. Often referred to as the account number, yet for consistency this is always referred to as accountId. Accepts both IBAN & BBAN"},{"name":"processingDate","in":"path","type":"string","required":true,"description":"The date when payment instruction is processed in system."},{"name":"transactionId","in":"query","type":"string","required":false,"description":"Unique transaction identifier for retrieving the details of the transaction. For example: FT0102030333 etc."},{"name":"branchId","in":"query","type":"string","required":false,"description":"Unique and unambiguous identification of a branch of a financial institution."},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"UsBranchEntriesByAccountIdResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/order/us/payments/branchEntries/transactions/{transactionId}/dates/{processingDate}","fullPath":"/api/v2.1.0/order/us/payments/branchEntries/transactions/{transactionId}/dates/{processingDate}","operationId":"getUsBranchEntriesByTransactionId","name":"Retrieves the branch entry details like transaction types, account numbers, amounts, check numbers, routing numbers for the checks, check image reference, status etc,. by transaction id and processing date","summary":"Retrieve the branch transaction entry details by transaction id","tags":["RETAIL"],"parameters":[{"name":"transactionId","in":"path","type":"string","required":true,"description":"Unique transaction identifier for retrieving the details of the transaction. For example: FT0102030333 etc."},{"name":"processingDate","in":"path","type":"string","required":true,"description":"The date when payment instruction is processed in system."},{"name":"accountId","in":"query","type":"string","required":false,"description":"Identifier of the account. Often referred to as the account number, yet for consistency this is always referred to as accountId. Accepts both IBAN & BBAN"},{"name":"branchId","in":"query","type":"string","required":false,"description":"Unique and unambiguous identification of a branch of a financial institution."},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"UsBranchEntriesByTransactionIdResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"POST","path":"/order/us/payments/pointOfSale","fullPath":"/api/v2.1.0/order/us/payments/pointOfSale","operationId":"createPointOfSaleTransactions","name":"Create point of sale payment transaction with details such as account, currency, transaction codes, etc. Any third party system with which the bank integrates for point of sale transactions can use this API.","summary":"Create point of sale payment transaction.","tags":[],"parameters":[{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."}],"requestBodyExample":{"header":{},"body":{"csmApplication":"string","csmAction":"string","transactionInput":[{}]}},"responses":{"200":"PointOfSaleTransactionsResponse","default":"GAIErrorResponse","400":"BusinessGAIErrorResponse","500":"SystemGAIErrorResponse"}}]},{"key":"order-us-payments-service-v1.0.0","title":"US Model Bank Payment services","version":"v1.0.0","description":"API to create ACH and Wire payments, standing orders, Automatic debit instructions, place holds on account, stop checks","endpointCount":16,"endpoints":[{"method":"POST","path":"/order/us/payment/escrows","fullPath":"/api/v1.0.0/order/us/payment/escrows","operationId":"createEscrowAdhocDeposit","name":"Initiates an Escrow payment transaction","summary":"Escrow Payment","tags":["RETAIL"],"parameters":[{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"overrideDetails":[{}],"creditAccountId":"@ref:product-accountOperationalDate-service-v1.0.0","creditValueDate":"2024-01-01","creditCurrencyId":"string","creditAmount":0.0,"debitAccountId":"@ref:product-accountOperationalDate-service-v1.0.0","debitValueDate":"2024-01-01","debitCurrencyId":"string","debitAmount":0.0,"treasuryRate":0.0,"processingDate":"2024-01-01","customerRate":0.0,"customerSpread":0.0,"recordStatus":"string","currNo":0.0}},"responses":{"200":"EscrowAdhocDepositResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"POST","path":"/order/us/accounts/{accountId}/reservedFunds","fullPath":"/api/v1.0.0/order/us/accounts/{accountId}/reservedFunds","operationId":"createAccountBalanceHold","name":"Create a hold transaction to lock the funds in an account","summary":"Create account Hold","tags":["RETAIL"],"parameters":[{"name":"accountId","in":"path","type":"string","required":true,"description":"Identifier of the account. Often referred to as the account number, yet for consistency this is always referred to as accountId. Accepts both IBAN & BBAN"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"overrides":[{}],"holdTypeId":"/v1.0.0/reference/us/accountHoldTypes","description":"string","fromDate":"2024-01-01","toDate":"2024-01-01","lockedAmount":0.0,"blockPriorityId":"string","recordStatus":"string","currNo":0.0,"inputter":"string","dateTime":0.0,"authoriser":"string","companyId":"@ref:reference-companies-service-v1.0.0","deptCode":"@ref:reference-accountOfficers-service-v1.0.0","auditorCode":"string"}},"responses":{"200":"AccountBalanceHoldResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/order/us/accounts/{holdId}/reservedFunds","fullPath":"/api/v1.0.0/order/us/accounts/{holdId}/reservedFunds","operationId":"getAccountBalanceHold","name":"Retrieves information the amount locked, lock type and the validity for a hold transaction","summary":"Retrieve hold funds detail","tags":["RETAIL"],"parameters":[{"name":"holdId","in":"path","type":"string","required":true,"description":"The transaction reference through which the specified amount in the transaction has been locked in an account"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"AccountBalanceHoldResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/order/us/payment/holds/{holdId}","fullPath":"/api/v1.0.0/order/us/payment/holds/{holdId}","operationId":"updateAccountBalanceHold","name":"Update amount or validity date of an existing hold","summary":"Update existing hold","tags":["RETAIL"],"parameters":[{"name":"holdId","in":"path","type":"string","required":true,"description":"The transaction reference through which the specified amount in the transaction has been locked in an account"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"overrides":[{}],"holdTypeId":"/v1.0.0/reference/us/accountHoldTypes","description":"string","fromDate":"2024-01-01","toDate":"2024-01-01","lockedAmount":0.0,"blockPriorityId":"string","recordStatus":"string","currNo":0.0,"inputter":"string","dateTime":0.0,"authoriser":"string","companyId":"@ref:reference-companies-service-v1.0.0","deptCode":"@ref:reference-accountOfficers-service-v1.0.0","auditorCode":"string"}},"responses":{"200":"AccountBalanceHoldResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/order/us/payment/accounts/{accountId}/holdSummary","fullPath":"/api/v1.0.0/order/us/payment/accounts/{accountId}/holdSummary","operationId":"getAccountHoldDetails","name":"Retrieves details of all holds placed on an account","summary":"Get hold summary","tags":["RETAIL"],"parameters":[{"name":"accountId","in":"path","type":"string","required":true,"description":"Identifier of the account. Often referred to as the account number, yet for consistency this is always referred to as accountId. Accepts both IBAN & BBAN"},{"name":"holdTypeId","in":"query","type":"string","required":false,"description":"Purpose or the type of hold placed on the account  The available list of hold types can be retrieved through getHoldTypes"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from t24 on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"AccountHoldDetailsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"POST","path":"/order/us/payment/transactionStops","fullPath":"/api/v1.0.0/order/us/payment/transactionStops","operationId":"createUsTransactionStop","name":"Create Transaction Stops","summary":"Create Transaction Stops","tags":["RETAIL"],"parameters":[{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"stopCondition":[{}],"accountId":"@ref:product-accountOperationalDate-service-v1.0.0","stopTypeId":"string","transactionChannel":"string","stopInstructionChannel":"BANK","stopReason":"CHKDES","issueDate":"string","replacementCheck":"string","replacementCheckIssueDate":"string","expiryDate":"string","waiveCharge":"string","transactionStopStatus":"ACTIVE","suppressNotice":"string","cancelInstruction":"YES","override":"string"}},"responses":{"200":"UsTransactionStopResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"DELETE","path":"/order/us/payment/transactionStops/{stopInstructionId}","fullPath":"/api/v1.0.0/order/us/payment/transactionStops/{stopInstructionId}","operationId":"deleteUsTransactionStop","name":"Delete Transaction Stop","summary":"Delete Transaction Stop","tags":["RETAIL"],"parameters":[{"name":"stopInstructionId","in":"path","type":"string","required":true,"description":"ID of stop instruction"},{"name":"payload","in":"body","type":"object","required":false,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}}},"responses":{"200":"UsTransactionStopResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"POST","path":"/order/us/payments/wireTransfers","fullPath":"/api/v1.0.0/order/us/payments/wireTransfers","operationId":"createFedwire-CTR","name":"Creates a Fedwire CTR payment","summary":"Posts a CTR wire transaction","tags":["RETAIL"],"parameters":[{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"orderingCustomerAddressLines":[{}],"beneficiaryInstituteAddressLines":[{}],"beneficiaryAddressLines":[{}],"intermediaryFiNameAddressLines":[{}],"OriginatorToBeneficiaryLines":[{}],"receiverFiAndIntermediaryFiLines":[{}],"adviceInformation":[{}],"InformationLines":[{}],"charges":[{}],"overrides":[{}],"paymentPriority":"/v1.0.0/reference/lookups?virtualTableName=PAYMENT.SERVICE.LEVEL.CODE","orderingCustomerId":"string","debitAccountId":"string","schedulePaymentAmount":0.0,"debitValueDate":"2024-01-01"}},"responses":{"200":"Fedwire-CTRResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"POST","path":"/order/us/payments/paymentOrders","fullPath":"/api/v1.0.0/order/us/payments/paymentOrders","operationId":"createUsDomesticTransfer","name":"Create one-time domestic account transfers and bill payments","summary":"Create ACH Domestic Transfer","tags":["RETAIL"],"parameters":[{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"standardEntryClassCode":"CIE","companyEntryDescription":"string","debitAccountId":"string","transactionAmount":0.0,"requiredCreditValueDate":"2024-01-01","beneficiaryId":"/v1.0.0/party/us/customers/{customerId}/beneficiaries","transactionCode":0.0,"beneficiaryOtherId":"string","accountWithBankClearingCode":"string","beneficiaryAccountId":"string","beneficiaryName":"string","narrative":"string","paymentCurrency":"string","paymentOrderProductId":"string","recordStatus":"Status of record -authorised/on hold/unauth etc"}},"responses":{"200":"UsDomesticTransferResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"POST","path":"/order/us/payments/standingOrders/{accountId}","fullPath":"/api/v1.0.0/order/us/payments/standingOrders/{accountId}","operationId":"createUsRecurringTransfers","name":"API to create a Beneficiary for account transfers or bill payment","summary":"Create recurring Transfer","tags":["RETAIL"],"parameters":[{"name":"accountId","in":"path","type":"string","required":true,"description":"Identifier of the account. Often referred to as the account number, yet for consistency this is always referred to as accountId. Accepts both IBAN & BBAN"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"beneficiaries":[{}],"currentFrequency":"string","standardEntryClassCode":"CIE","startDate":"2024-01-01","companyEntryDescription":"string","currentEndDate":"2024-01-01","currentAmountBalance":0.0,"beneficiaryId":"/v1.0.0/party/us/customers/{customerId}/beneficiaries","transactionCode":0.0,"beneficiaryOtherId":"string","accountWithBankClearingCode":"string","beneficiaryAccountId":"string","paymentDetail":"string","recordStatus":"Status of record -authorised/on hold/unauth etc","currNo":"No of times record has been changed"}},"responses":{"200":"UsRecurringTransfersResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"POST","path":"/order/us/payments/directDebits/{accountId}","fullPath":"/api/v1.0.0/order/us/payments/directDebits/{accountId}","operationId":"createUsDirectDebits","name":"Create direct debit instructions for repayment of loans or bill payment through external accounts","summary":"Create Direct Debit","tags":["RETAIL"],"parameters":[{"name":"accountId","in":"path","type":"string","required":true,"description":"Identifier of the account. Often referred to as the account number, yet for consistency this is always referred to as accountId. Accepts both IBAN & BBAN"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"displayName":"string","directDebitParameterId":"string","serviceClassCode":0.0,"standardEntryClassCode":"PPD","debitAccountType":"string","debitBankClearingCode":"string","destinationAccountId":"string","debitorName":"string","frequency":"string","paymentDetail":"string","currencyMarket":"string","terminationDate":"2024-01-01","direction":"string","standAloneDdi":"string","standaloneAmount":0.0}},"responses":{"200":"UsDirectDebitsResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/order/us/payments/directDebits","fullPath":"/api/v1.0.0/order/us/payments/directDebits","operationId":"getUsDirectDebits","name":"API to get the list of direct debits initiated for repayment of bills or loans from external accounts","summary":"Retrieve Direct debits setup for an account","tags":["RETAIL"],"parameters":[{"name":"customerId","in":"query","type":"string","required":false,"description":"Identifier of the customer"},{"name":"directDebitParameterId","in":"query","type":"string","required":false,"description":"Reference to the parameter which holds details relating to clearing accounts, number of days before which the claim has to be submitted or resubmitted"},{"name":"frequency","in":"query","type":"string","required":false,"description":"Specifies the frequency in which the payment application(periodic payments) execute the payment instruction."},{"name":"accountId","in":"query","type":"string","required":false,"description":"Identifier of the account. Often referred to as the account number, yet for consistency this is always referred to as accountId. Accepts both IBAN & BBAN"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from t24 on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"UsDirectDebitsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/order/us/payments/standingOrders","fullPath":"/api/v1.0.0/order/us/payments/standingOrders","operationId":"getUsRecurringTransfers","name":"Retrieve recurring payments setup for account transfers and bill payments","summary":"Get Recurring Transfer details","tags":["RETAIL"],"parameters":[{"name":"orderingCustomerId","in":"query","type":"string","required":false,"description":"Indicates the customer id for the ordering customer"},{"name":"paymentOrderProductName","in":"query","type":"string","required":false,"description":"Indicates the name of payment order product "},{"name":"accountId","in":"query","type":"string","required":false,"description":"Identifier of the account. Often referred to as the account number, yet for consistency this is always referred to as accountId. Accepts both IBAN & BBAN"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from t24 on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"UsRecurringTransfersResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/order/us/payments/transactions/wires","fullPath":"/api/v1.0.0/order/us/payments/transactions/wires","operationId":"getUsWireTransfers","name":"Retrieve wire initiated by customer using customerId, accountId, payment date and payment status.","summary":"Customer initiated wire payments","tags":[],"parameters":[{"name":"orderingCustomerId","in":"query","type":"string","required":false,"description":"Indicates the customer id for the ordering customer"},{"name":"deliveryByDate","in":"query","type":"string","required":false,"description":"Indicates the date by when the payment should be settled to the beneficiary"},{"name":"paymentOrderProductId","in":"query","type":"string","required":false,"description":"Indicates the payment order product for which payment is initiated"},{"name":"paymentStatus","in":"query","type":"string","required":false,"description":"Describes the current status of the payment order in the payment system"},{"name":"debitAccountId","in":"query","type":"string","required":false,"description":"Indicates the debit account number of the payment or transaction."},{"name":"customerOrBankTransfer","in":"query","type":"string","required":false,"description":"Indicates if the payment was initiated by Customer or the financial institution"},{"name":"beneficiaryAccountId","in":"query","type":"string","required":false,"description":"Unique account identifier of the beneficiary account number."},{"name":"beneficiaryId","in":"query","type":"string","required":false,"description":"Indicates the reference of the financial institution that allows access to the beneficiary information"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from t24 on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"UsWireTransfersResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/order/us/payments/transactions","fullPath":"/api/v1.0.0/order/us/payments/transactions","operationId":"getUsDomesticTransfers","name":"API to retrieve domestic account transfers or bill payment","summary":"Get domestic transfer details","tags":["RETAIL"],"parameters":[{"name":"orderingCustomerId","in":"query","type":"string","required":false,"description":"Indicates the customer id for the ordering customer"},{"name":"deliveryByDate","in":"query","type":"string","required":false,"description":"Indicates the date by when the payment should be settled to the beneficiary"},{"name":"paymentOrderProductId","in":"query","type":"string","required":false,"description":"Indicates the payment order product for which payment is initiated"},{"name":"paymentStatus","in":"query","type":"string","required":false,"description":"Describes the current status of the payment order in the payment system"},{"name":"debitAccountId","in":"query","type":"string","required":false,"description":"Indicates the debit account number of the payment or transaction."},{"name":"customerOrBankTransfer","in":"query","type":"string","required":false,"description":"Indicates if the payment was initiated by Customer or the financial institution"},{"name":"beneficiaryAccountId","in":"query","type":"string","required":false,"description":"Unique account identifier of the beneficiary account number."},{"name":"beneficiaryId","in":"query","type":"string","required":false,"description":"Indicates the reference of the financial institution that allows access to the beneficiary information"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from t24 on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"UsDomesticTransfersResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"POST","path":"/order/us/payments/wireTransfers/simulate","fullPath":"/api/v1.0.0/order/us/payments/wireTransfers/simulate","operationId":"simulateFedwire-CTR","name":"Validate Payment order transaction to verify the information provided and to retreive the applicable charges","summary":"Validate Payment order transaction ","tags":["RETAIL"],"parameters":[{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"orderingCustomerAddressLines":[{}],"beneficiaryInstituteAddressLines":[{}],"beneficiaryAddressLines":[{}],"intermediaryFiNameAddressLines":[{}],"OriginatorToBeneficiaryLines":[{}],"receiverFiAndIntermediaryFiLines":[{}],"adviceInformation":[{}],"InformationLines":[{}],"charges":[{}],"overrides":[{}],"paymentPriority":"/v1.0.0/reference/lookups?virtualTableName=PAYMENT.SERVICE.LEVEL.CODE","orderingCustomerId":"string","debitAccountId":"string","schedulePaymentAmount":0.0,"debitValueDate":"2024-01-01"}},"responses":{"200":"Fedwire-CTRResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}}]},{"key":"order-us-payments-service-v10.0.0","title":"Same day debits","version":"v10.0.0","description":"Initiates same day debit transfers","endpointCount":28,"endpoints":[{"method":"POST","path":"/order/us/payments/escrows","fullPath":"/api/v10.0.0/order/us/payments/escrows","operationId":"createEscrowAdhocDeposit","name":"Initiates an escrow payment transaction","summary":"Escrow payment","tags":["RETAIL"],"parameters":[{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"overrideDetails":[{}],"creditAccountId":"@ref:product-accountOperationalDate-service-v1.0.0","creditValueDate":"2024-01-01","creditCurrencyId":"string","creditAmount":0.0,"debitAccountId":"@ref:product-accountOperationalDate-service-v1.0.0","debitValueDate":"2024-01-01","debitCurrencyId":"string","debitAmount":0.0,"treasuryRate":0.0,"processingDate":"2024-01-01","customerRate":0.0,"customerSpread":0.0,"recordStatus":"string","currNo":0.0}},"responses":{"200":"EscrowAdhocDepositResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"POST","path":"/order/us/accounts/{accountId}/reservedFunds","fullPath":"/api/v10.0.0/order/us/accounts/{accountId}/reservedFunds","operationId":"createAccountBalanceHold","name":"Create a hold transaction to lock the funds in an account","summary":"Create account hold","tags":["RETAIL"],"parameters":[{"name":"accountId","in":"path","type":"string","required":true,"description":"Identifier of the account. Often referred to as the account number, yet for consistency this is always referred to as accountId. Accepts both IBAN & BBAN"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"overrides":[{}],"holdTypeId":"/v1.0.0/reference/us/accountHoldTypes","description":"string","fromDate":"2024-01-01","toDate":"2024-01-01","lockedAmount":0.0,"blockPriorityId":"string","recordStatus":"string","currNo":0.0,"inputter":"string","dateTime":0.0,"authoriser":"string","companyId":"@ref:reference-companies-service-v1.0.0","deptCode":"@ref:reference-accountOfficers-service-v1.0.0","auditorCode":"string"}},"responses":{"200":"AccountBalanceHoldResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/order/us/accounts/reservedFunds/{holdId}","fullPath":"/api/v10.0.0/order/us/accounts/reservedFunds/{holdId}","operationId":"getAccountBalanceHold","name":"Retrieves information of the amount locked, lock type and the validity for a hold transaction","summary":"Retrieve hold funds detail","tags":["RETAIL"],"parameters":[{"name":"holdId","in":"path","type":"string","required":true,"description":"The transaction reference through which the specified amount in the transaction has been locked in an account"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"AccountBalanceHoldResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/order/us/payments/holds/{holdId}","fullPath":"/api/v10.0.0/order/us/payments/holds/{holdId}","operationId":"updateAccountBalanceHold","name":"Update amount or validity date of an existing hold","summary":"Update existing hold","tags":["RETAIL"],"parameters":[{"name":"holdId","in":"path","type":"string","required":true,"description":"The transaction reference through which the specified amount in the transaction has been locked in an account"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"overrides":[{}],"holdTypeId":"/v1.0.0/reference/us/accountHoldTypes","description":"string","fromDate":"2024-01-01","toDate":"2024-01-01","lockedAmount":0.0,"blockPriorityId":"string","recordStatus":"string","currNo":0.0,"inputter":"string","dateTime":0.0,"authoriser":"string","companyId":"@ref:reference-companies-service-v1.0.0","deptCode":"@ref:reference-accountOfficers-service-v1.0.0","auditorCode":"string"}},"responses":{"200":"AccountBalanceHoldResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/order/us/payments/accounts/{accountId}/holdSummary","fullPath":"/api/v10.0.0/order/us/payments/accounts/{accountId}/holdSummary","operationId":"getAccountHoldDetails","name":"Retrieves details of all holds placed on an account","summary":"Get hold summary","tags":["RETAIL"],"parameters":[{"name":"accountId","in":"path","type":"string","required":true,"description":"Identifier of the account. Often referred to as the account number, yet for consistency this is always referred to as accountId. Accepts both IBAN & BBAN"},{"name":"holdTypeId","in":"query","type":"string","required":false,"description":"Purpose or the type of hold placed on the account  The available list of hold types can be retrieved through getHoldTypes"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"AccountHoldDetailsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"POST","path":"/order/us/payments/transactionStops","fullPath":"/api/v10.0.0/order/us/payments/transactionStops","operationId":"createUsTransactionStop","name":"Create transaction stop instruction to capture instructions to stop a payment based on the payment type, recipient or amount","summary":"Create transaction stop instruction","tags":["RETAIL"],"parameters":[{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"stopCondition":[{}],"accountId":"@ref:product-accountOperationalDate-service-v1.0.0","stopTypeId":"string","transactionChannel":"string","stopInstructionChannel":"BANK","stopReason":"CHKDES","issueDate":"string","replacementCheck":"string","replacementCheckIssueDate":"string","expiryDate":"string","waiveCharge":"string","transactionStopStatus":"ACTIVE","suppressNotice":"string","cancelInstruction":"YES","override":"string"}},"responses":{"200":"UsTransactionStopResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"DELETE","path":"/order/us/payments/transactionStops/{stopInstructionId}","fullPath":"/api/v10.0.0/order/us/payments/transactionStops/{stopInstructionId}","operationId":"deleteUsTransactionStop","name":"Deletes a transaction stop instruction capturing with instructions to stop a payment","summary":"Delete transaction stop","tags":["RETAIL"],"parameters":[{"name":"stopInstructionId","in":"path","type":"string","required":true,"description":"ID of stop instruction"},{"name":"payload","in":"body","type":"object","required":false,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}}},"responses":{"200":"UsTransactionStopResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"POST","path":"/order/us/payments/wireTransfers","fullPath":"/api/v10.0.0/order/us/payments/wireTransfers","operationId":"createFedwireCTR","name":"Creates an instant payment through  fedwire of payment type CTR, customer transfer","summary":"Creates a customer transfer through wire payment","tags":["RETAIL"],"parameters":[{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"orderingCustomerAddressLines":[{}],"ultimateDebtorAddressLines":[{}],"beneficiaryInstituteAddressLines":[{}],"beneficiaryAddressLines":[{}],"intermediaryFiNameAddressLines":[{}],"intermediary2FiNameAddressLines":[{}],"OriginatorToBeneficiaryLines":[{}],"receiverFiAndIntermediaryFiLines":[{}],"adviceInformation":[{}],"InformationLines":[{}],"charges":[{}],"overrides":[{}],"paymentPriority":"/v1.0.0/reference/lookups?virtualTableName=PAYMENT.SERVICE.LEVEL.CODE","orderingCustomerId":"string","debitAccountId":"string"}},"responses":{"200":"FedwireCTRResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"POST","path":"/order/us/payments/paymentOrders","fullPath":"/api/v10.0.0/order/us/payments/paymentOrders","operationId":"createUsDomesticTransfer","name":"Create one-time domestic account transfers and bill payments through ACH Clearing and the interbank automated clearing house","summary":"Create domestic transfer","tags":["RETAIL"],"parameters":[{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"standardEntryClassCode":"CIE","companyEntryDescription":"string","debitAccountId":"string","transactionAmount":0.0,"requiredCreditValueDate":"2024-01-01","beneficiaryId":"/v1.0.0/party/us/customers/{customerId}/beneficiaries","transactionCode":0.0,"beneficiaryOtherId":"string","accountWithBankClearingCode":"string","beneficiaryAccountId":"string","beneficiaryName":"string","narrative":"string","paymentCurrency":"string","paymentOrderProductId":"string","recordStatus":"string"}},"responses":{"200":"UsDomesticTransferResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"POST","path":"/order/us/payments/standingOrders/{accountId}","fullPath":"/api/v10.0.0/order/us/payments/standingOrders/{accountId}","operationId":"createUsRecurringTransfers","name":"Create a recurring account transfer","summary":"Create recurring transfer","tags":["RETAIL"],"parameters":[{"name":"accountId","in":"path","type":"string","required":true,"description":"Identifier of the account. Often referred to as the account number, yet for consistency this is always referred to as accountId. Accepts both IBAN & BBAN"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"beneficiaries":[{}],"currentFrequency":"string","standardEntryClassCode":"CIE","startDate":"2024-01-01","companyEntryDescription":"string","currentEndDate":"2024-01-01","currentAmountBalance":0.0,"beneficiaryId":"/v1.0.0/party/us/customers/{customerId}/beneficiaries","transactionCode":0.0,"beneficiaryOtherId":"string","accountWithBankClearingCode":"string","beneficiaryAccountId":"string","paymentDetail":"string","currency":"string","recordStatus":"string"}},"responses":{"200":"UsRecurringTransfersResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"POST","path":"/order/us/payments/directDebits/{accountId}","fullPath":"/api/v10.0.0/order/us/payments/directDebits/{accountId}","operationId":"createUsDirectDebits","name":"Create direct debit instructions for repayment of loans or bill payment through external accounts","summary":"Create direct debit instruction","tags":["RETAIL"],"parameters":[{"name":"accountId","in":"path","type":"string","required":true,"description":"Identifier of the account. Often referred to as the account number, yet for consistency this is always referred to as accountId. Accepts both IBAN & BBAN"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"displayName":"string","directDebitParameterId":"string","serviceClassCode":0.0,"standardEntryClassCode":"PPD","debitAccountType":"string","debitBankClearingCode":"string","destinationAccountId":"string","debitorName":"string","frequency":"string","paymentDetail":"string","currencyMarket":"string","terminationDate":"2024-01-01","direction":"string","standAloneDdi":"string","standaloneAmount":0.0}},"responses":{"200":"UsDirectDebitsResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/order/us/payments/directDebits","fullPath":"/api/v10.0.0/order/us/payments/directDebits","operationId":"getUsDirectDebits","name":"Retrieve the list of direct debits initiated for repayment of bills or loans from external accounts","summary":"Retrieve direct debits setup for an account","tags":["RETAIL"],"parameters":[{"name":"customerId","in":"query","type":"string","required":false,"description":"Identifier of the customer"},{"name":"directDebitParameterId","in":"query","type":"string","required":false,"description":"Reference to the parameter which holds details relating to clearing accounts, number of days before which the claim has to be submitted or resubmitted"},{"name":"frequency","in":"query","type":"string","required":false,"description":"Specifies the frequency in which the payment application(periodic payments) execute the payment instruction."},{"name":"accountId","in":"query","type":"string","required":false,"description":"Identifier of the account. Often referred to as the account number, yet for consistency this is always referred to as accountId. Accepts both IBAN & BBAN"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"UsDirectDebitsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/order/us/payments/standingOrders","fullPath":"/api/v10.0.0/order/us/payments/standingOrders","operationId":"getUsRecurringTransfers","name":"Retrieve recurring payments setup for account transfers and bill payments","summary":"Get recurring transfer details","tags":["RETAIL"],"parameters":[{"name":"orderingCustomerId","in":"query","type":"string","required":false,"description":"Indicates the customer id for the ordering customer"},{"name":"paymentOrderProductName","in":"query","type":"string","required":false,"description":"Indicates the name of payment order product "},{"name":"accountId","in":"query","type":"string","required":false,"description":"Identifier of the account. Often referred to as the account number, yet for consistency this is always referred to as accountId. Accepts both IBAN & BBAN"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"UsRecurringTransfersResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"POST","path":"/order/us/payments/wireTransfers/simulate","fullPath":"/api/v10.0.0/order/us/payments/wireTransfers/simulate","operationId":"simulateFedwireCTR","name":"Validate payment order transaction to verify the information provided and to retrieve the applicable charges","summary":"Validate payment order transaction ","tags":["RETAIL"],"parameters":[{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"orderingCustomerAddressLines":[{}],"ultimateDebtorAddressLines":[{}],"beneficiaryInstituteAddressLines":[{}],"beneficiaryAddressLines":[{}],"intermediaryFiNameAddressLines":[{}],"intermediary2FiNameAddressLines":[{}],"OriginatorToBeneficiaryLines":[{}],"receiverFiAndIntermediaryFiLines":[{}],"adviceInformation":[{}],"InformationLines":[{}],"charges":[{}],"overrides":[{}],"paymentPriority":"/v1.0.0/reference/lookups?virtualTableName=PAYMENT.SERVICE.LEVEL.CODE","orderingCustomerId":"string","debitAccountId":"string"}},"responses":{"200":"FedwireCTRResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/order/us/payments/paymentStatus","fullPath":"/api/v10.0.0/order/us/payments/paymentStatus","operationId":"getUsPaymentsStatus","name":"Retrieve payment status and transaction history for an account along with beneficiary details and beneficiary status","summary":"Retrieve payment history","tags":["RETAIL"],"parameters":[{"name":"fromDate","in":"query","type":"string","required":false,"description":"Indicates the business date from when the balance reservation event is active."},{"name":"status","in":"query","type":"string","required":false,"description":"The status of the early maturity request"},{"name":"orderingCustomerId","in":"query","type":"string","required":false,"description":"Indicates the customer id for the ordering customer"},{"name":"debitAccountId","in":"query","type":"string","required":false,"description":"Indicates the debit account number of the payment or transaction."},{"name":"paymentOrderId","in":"query","type":"string","required":false,"description":"The unique reference number of payment"},{"name":"transactionReference","in":"query","type":"string","required":false,"description":"Contains the identifier for the transaction in the core system"},{"name":"paymentStatus","in":"query","type":"string","required":false,"description":"Describes the current status of the payment order in the payment system"},{"name":"toDate","in":"query","type":"string","required":false,"description":"Indicates the business date until when the balance reservation event is active."},{"name":"beneficiaryId","in":"query","type":"string","required":false,"description":"Indicates the reference of the financial institution that allows access to the beneficiary information"},{"name":"beneficiaryAccountId","in":"query","type":"string","required":false,"description":"Unique account identifier of the beneficiary account number."},{"name":"direction","in":"query","type":"string","required":false,"description":"Indicates the direction of the Direct debit claim for which mandate is received. The claim can be 'Outward' i.e. Claim is sent to the other bank or 'Inward'  i.e. other bank submit their claim to debi"},{"name":"paymentOrderProductId","in":"query","type":"string","required":false,"description":"Indicates the payment order product for which payment is initiated"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"UsPaymentsStatusResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"POST","path":"/order/us/payments/microDeposits","fullPath":"/api/v10.0.0/order/us/payments/microDeposits","operationId":"createUsACHBatchMicroDeposits","name":"Create a microdeposit batch to validate external account for a new beneficiary added by customer","summary":"Create a microdeposit batch to validate external account","tags":["RETAIL"],"parameters":[{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"entryDetails":[{}],"accountType":"string","recordStatus":"string","currNo":"string","inputter":"string","dateTime":"string","authoriser":"string","companyId":"string","deptCOde":"string","auditorCode":"string","auditTimeDate":"string","extensions":{}}},"responses":{"200":"UsACHBatchMicroDepositsResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/order/us/payments/customers/{orderingCustomerId}/directDebits/achDebits","fullPath":"/api/v10.0.0/order/us/payments/customers/{orderingCustomerId}/directDebits/achDebits","operationId":"getUsACHBatchAchDebits","name":"Retrieve list of customer initiated debit request to external accounts processed through ACH clearing and the interbank automated clearing house","summary":"Retrieve list of customer initiated debit request to external accounts","tags":["RETAIL"],"parameters":[{"name":"orderingCustomerId","in":"path","type":"string","required":true,"description":"Indicates the customer id for the ordering customer"},{"name":"effectiveDate","in":"query","type":"string","required":false,"description":"Contains the identifier for the transaction date. Dates are expected in \u00e2\u20ac\u02dcYYYYMMDD\u00e2\u20ac\u2122 format"},{"name":"creditAccountId","in":"query","type":"string","required":false,"description":"Credit account identifier of the payment or transaction"},{"name":"transactionCode","in":"query","type":"string","required":false,"description":"Identifies the system internal transaction code applicable to the transaction"},{"name":"amount","in":"query","type":"string","required":false,"description":"Contains the direct debit claim amount"},{"name":"beneficiaryInstituteRoutingNo","in":"query","type":"string","required":false,"description":"Routing number of DDA number of the Financial institution where the beneficiary account exists"},{"name":"debitAccountId","in":"query","type":"string","required":false,"description":"Indicates the debit account number of the payment or transaction."},{"name":"debitorName","in":"query","type":"string","required":false,"description":"The name of the customer who owns the destination account or the debit account used to collect payments"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"UsACHBatchAchDebitsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"POST","path":"/order/us/payments/wireTransfers/cancel/{transactionReference}","fullPath":"/api/v10.0.0/order/us/payments/wireTransfers/cancel/{transactionReference}","operationId":"reverseUsWireTransfer","name":"Request can be sent to initiate cancellation for a wire transfer within 30 minutes of submitting the wire payment","summary":"Initiate request to cancel wire transfer","tags":["RETAIL"],"parameters":[{"name":"transactionReference","in":"path","type":"string","required":true,"description":"Contains the identifier for the transaction in the core system"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"overrideDetails":[{}],"inputter":[{}],"dateTime":[{}],"transactionReference":"string","processingDate":"2024-01-01","statusCode":0.0,"sendersReference":"string","orderingAccount":"string","orderingName":"string","debitCustomerId":0.0,"recordStatus":"string","currNo":0.0,"authoriser":"string","companyCode":"string","deptCode":"string"}},"responses":{"200":"UsWireTransferResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"POST","path":"/order/us/payments/swiftTransfers/cancel/{transactionReference}","fullPath":"/api/v10.0.0/order/us/payments/swiftTransfers/cancel/{transactionReference}","operationId":"cancelSwiftTransaction","name":"Request to cancel international payments initiated within 30 minutes of submitting the payment","summary":"Initiate request to cancel international transfers","tags":["RETAIL"],"parameters":[{"name":"transactionReference","in":"path","type":"string","required":true,"description":"Contains the identifier for the transaction in the core system"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"inputter":[{}],"dateTime":[{}],"companyId":"string","transactionReference":"string","amount":0.0,"currencyId":"string","paymentMsgSentDate":"2024-01-01","outputChannel":"string","statusCode":"string","recordStatus":"string","currNo":0.0,"authoriser":"string","companyCode":"string","deptCode":"string","auditorCode":"string"}},"responses":{"200":"SwiftTransactionResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/order/us/payments/achEntry/{achEntryId}/achEntryStatus","fullPath":"/api/v10.0.0/order/us/payments/achEntry/{achEntryId}/achEntryStatus","operationId":"updateAchNOCEntriesStatus","name":"Allows to update the ACH entries status to processed","summary":"Allows to update the ACH entries status to processed","tags":["RETAIL"],"parameters":[{"name":"achEntryId","in":"path","type":"string","required":true,"description":""},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"achEntryStatus":"string","paymentOrderId":"string","transactionReference":"string","executionDate":"string","deliveryByDate":"string","creditDebitIndicator":"string","beneficiaryInstituteRoutingNo":"string","beneficiaryName":"string","beneficiaryOtherId":"string","accountId":"string","paymentAmount":"string","standardEntryClassCode":"string","extensions":{}}},"responses":{"200":"AchNOCEntriesStatusResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"POST","path":"/order/us/payments/directDebits/achDebits","fullPath":"/api/v10.0.0/order/us/payments/directDebits/achDebits","operationId":"createUsAchSameDayDebits","name":"Initiates same day ACH debit collection transaction","summary":"Initiates same day debit transfers","tags":["RETAIL"],"parameters":[{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"creditAccountId":"string","amount":"string","effectiveDate":"string","debitBankClearingCode":"string","debitAccountId":"string","debitorName":"string","additionalInformation":"string","standardEntryClassCode":"CCD","debitAccountType":"Checking","customerType":"Business","companyEntryDescription":"string","extensions":{}}},"responses":{"200":"UsAchSameDayDebitsResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/order/us/payments/wireTransfers/accounts/{debitAccountId}/mandates","fullPath":"/api/v10.0.0/order/us/payments/wireTransfers/accounts/{debitAccountId}/mandates","operationId":"getUsDrawdownMandates","name":"Retrieves all the available drawdown authorization or mandates for an account.","summary":"Retrieves drawdown mandates ","tags":["RETAIL"],"parameters":[{"name":"debitAccountId","in":"path","type":"string","required":true,"description":"Indicates the debit account number of the payment or transaction."},{"name":"beneficiaryAccountId","in":"query","type":"string","required":false,"description":"Unique account identifier of the beneficiary account number."},{"name":"routingNumber","in":"query","type":"string","required":false,"description":"Indicates the routing number of the bank where the account is held"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"UsDrawdownMandatesResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"POST","path":"/order/us/payments/wireTransfers/mandates","fullPath":"/api/v10.0.0/order/us/payments/wireTransfers/mandates","operationId":"createUsDrawdownMandate","name":"Allows to create a drawdown authorization for a customer for approving automatic drawdown transfer via wire payment to debit their account based on a drawdown request (1031 or 1631) received from the creditor's financial institution. The authorization form or the mandate form captures the credit account number, the financial institution where the creditor account is held, the purpose for which the debit request will be sent, the maximum amount allowed to be debited upon a drawdown request and th","summary":"Allows to create a drawdown authorization","tags":["RETAIL"],"parameters":[{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"debitAccountId":"string","debitAccountName":"string","beneficiaryAccountId":"string","drawdownAmount":0.0,"beneficiaryInstituteName":"string","routingNumber":"string","beneficiaryName":"string","accountType":"/v1.0.0/reference/lookups?virtualTableName=USRTGS.ACCT.TYPE","beneficiaryAddress":"string","receiverFiAndIntermediaryFiInfo":"string","effectiveFromDate":"2024-01-01","effectiveToDate":"2024-01-01","extensions":{}}},"responses":{"200":"UsDrawdownMandateResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/order/us/payments/wireTransfers/{mandateId}/mandates","fullPath":"/api/v10.0.0/order/us/payments/wireTransfers/{mandateId}/mandates","operationId":"updateUsDrawdownMandate","name":"Allows to update existing drawdown authorization or mandate created for a customer to approve automatic drawdown transfer via wire payment to debit their account and crediting an external account","summary":"Allows to update existing drawdown authorization","tags":["RETAIL"],"parameters":[{"name":"mandateId","in":"path","type":"string","required":true,"description":""},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"debitAccountId":"string","debitAccountName":"string","beneficiaryAccountId":"string","drawdownAmount":0.0,"beneficiaryInstituteName":"string","routingNumber":"string","beneficiaryName":"string","accountType":"/v1.0.0/reference/lookups?virtualTableName=USRTGS.ACCT.TYPE","beneficiaryAddress":"string","receiverFiAndIntermediaryFiInfo":"string","effectiveFromDate":"2024-01-01","effectiveToDate":"2024-01-01","extensions":{}}},"responses":{"200":"UsDrawdownMandateResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"POST","path":"/order/us/payments/wireTransfers/surplusSweep","fullPath":"/api/v10.0.0/order/us/payments/wireTransfers/surplusSweep","operationId":"createFedwireETI","name":"Creates Fedwire fund transfer to manage their excess funds","summary":"Creates fund transfer for excess funds","tags":["RETAIL"],"parameters":[{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"orderingCustomerAddresses":[{}],"beneficiaryInstituteAddresses":[{}],"beneficiaryAddresses":[{}],"paymentPriority":"string","senderRoutingNo":"string","orderingCustomerId":"string","debitAccountId":"string","schedulePaymentAmount":"string","accountWithBankSortCode":"string","beneficiaryId":"string","beneficiaryName":"string","beneficiaryAccountId":"string","extensions":{}}},"responses":{"200":"FedwireETIResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"POST","path":"/order/us/payments/wires/customerTransfers","fullPath":"/api/v10.0.0/order/us/payments/wires/customerTransfers","operationId":"createFedwire-CTR","name":"Creates an instant payment through  fedwire payment type of  customer transfer (CTR, CTP)","summary":"Creates a customer transfer through wire payment","tags":["RETAIL"],"parameters":[{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"orderingCustomerAddressLines":[{}],"ultimateDebtorAddressLines":[{}],"beneficiaryInstituteAddressLines":[{}],"beneficiaryAddressLines":[{}],"intermediaryFiNameAddressLines":[{}],"intermediary2FiNameAddressLines":[{}],"OriginatorToBeneficiaryLines":[{}],"receiverFiAndIntermediaryFiLines":[{}],"adviceInformation":[{}],"InformationLines":[{}],"charges":[{}],"overrides":[{}],"paymentPriority":"/v1.0.0/reference/lookups?virtualTableName=PAYMENT.SERVICE.LEVEL.CODE","orderingCustomerId":"string","debitAccountId":"string"}},"responses":{"200":"Fedwire-CTRResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"POST","path":"/order/us/payments/wires/bankTransfers","fullPath":"/api/v10.0.0/order/us/payments/wires/bankTransfers","operationId":"createFedwireBankTransfer","name":"Creates an instant payment through fedwire of bank transfer payment type (BTR,FFS,FFR,CKS and DEP)","summary":"Creates a bank transfer through wire payment","tags":["RETAIL"],"parameters":[{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"orderingCustomerAddressLines":[{}],"ultimateDebtorAddressLines":[{}],"beneficiaryInstituteAddressLines":[{}],"intermediaryFiNameAddressLines":[{}],"intermediary2FiNameAddressLines":[{}],"OriginatorToBeneficiaryLines":[{}],"receiverFiAndIntermediaryFiLines":[{}],"adviceInformation":[{}],"InformationLines":[{}],"charges":[{}],"overrides":[{}],"paymentPriority":"/v1.0.0/reference/lookups?virtualTableName=PAYMENT.SERVICE.LEVEL.CODE","orderingCustomerId":"string","debitAccountId":"string","schedulePaymentAmount":0.0}},"responses":{"200":"FedwireBankTransferResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/order/us/payments/ach/{achReference}","fullPath":"/api/v10.0.0/order/us/payments/ach/{achReference}","operationId":"getUsACHTraceNumber","name":"Retrieve automated clearing house(ACH) trace number","summary":"Retrieve automated clearing house(ACH) outgoing file trace number","tags":["RETAIL"],"parameters":[{"name":"achReference","in":"path","type":"string","required":true,"description":""},{"name":"captureId","in":"query","type":"string","required":false,"description":"Deprecated - Capture reference"},{"name":"paymentOrderId","in":"query","type":"string","required":false,"description":"The unique reference number of payment"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"UsACHTraceNumberResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}}]},{"key":"order-us-payments-service-v11.0.0","title":"US Model Bank Payment services","version":"v11.0.0","description":"API to create ACH (Automated Clearing House) and wire payments, standing orders, automatic debit instructions, place holds on account and stop checks.","endpointCount":33,"endpoints":[{"method":"POST","path":"/order/us/payments/escrows","fullPath":"/api/v11.0.0/order/us/payments/escrows","operationId":"createEscrowAdhocDeposit","name":"Initiates an escrow payment transaction","summary":"Escrow payment","tags":["RETAIL"],"parameters":[{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"overrideDetails":[{}],"creditAccountId":"@ref:product-accountOperationalDate-service-v1.0.0","creditValueDate":"2024-01-01","creditCurrencyId":"string","creditAmount":0.0,"debitAccountId":"@ref:product-accountOperationalDate-service-v1.0.0","debitValueDate":"2024-01-01","debitCurrencyId":"string","debitAmount":0.0,"treasuryRate":0.0,"processingDate":"2024-01-01","customerRate":0.0,"customerSpread":0.0,"recordStatus":"string","currNo":0.0}},"responses":{"200":"EscrowAdhocDepositResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"POST","path":"/order/us/accounts/{accountId}/reservedFunds","fullPath":"/api/v11.0.0/order/us/accounts/{accountId}/reservedFunds","operationId":"createAccountBalanceHold","name":"Create a hold transaction to lock the funds in an account","summary":"Create account hold","tags":["RETAIL"],"parameters":[{"name":"accountId","in":"path","type":"string","required":true,"description":"Identifier of the account. Often referred to as the account number, yet for consistency this is always referred to as accountId. Accepts both IBAN & BBAN"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"overrides":[{}],"holdTypeId":"/v1.0.0/reference/us/accountHoldTypes","description":"string","fromDate":"2024-01-01","toDate":"2024-01-01","lockedAmount":0.0,"blockPriorityId":"string","recordStatus":"string","currNo":0.0,"inputter":"string","dateTime":0.0,"authoriser":"string","companyId":"@ref:reference-companies-service-v1.0.0","deptCode":"@ref:reference-accountOfficers-service-v1.0.0","auditorCode":"string"}},"responses":{"200":"AccountBalanceHoldResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/order/us/accounts/reservedFunds/{holdId}","fullPath":"/api/v11.0.0/order/us/accounts/reservedFunds/{holdId}","operationId":"getAccountBalanceHold","name":"Retrieves information of the amount locked, lock type and the validity for a hold transaction","summary":"Retrieve hold funds detail","tags":["RETAIL"],"parameters":[{"name":"holdId","in":"path","type":"string","required":true,"description":"The transaction reference through which the specified amount in the transaction has been locked in an account"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"AccountBalanceHoldResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/order/us/payments/holds/{holdId}","fullPath":"/api/v11.0.0/order/us/payments/holds/{holdId}","operationId":"updateAccountBalanceHold","name":"Update amount or validity date of an existing hold","summary":"Update existing hold","tags":["RETAIL"],"parameters":[{"name":"holdId","in":"path","type":"string","required":true,"description":"The transaction reference through which the specified amount in the transaction has been locked in an account"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"overrides":[{}],"holdTypeId":"/v1.0.0/reference/us/accountHoldTypes","description":"string","fromDate":"2024-01-01","toDate":"2024-01-01","lockedAmount":0.0,"blockPriorityId":"string","recordStatus":"string","currNo":0.0,"inputter":"string","dateTime":0.0,"authoriser":"string","companyId":"@ref:reference-companies-service-v1.0.0","deptCode":"@ref:reference-accountOfficers-service-v1.0.0","auditorCode":"string"}},"responses":{"200":"AccountBalanceHoldResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/order/us/payments/accounts/{accountId}/holdSummary","fullPath":"/api/v11.0.0/order/us/payments/accounts/{accountId}/holdSummary","operationId":"getAccountHoldDetails","name":"Retrieves details of all holds placed on an account","summary":"Get hold summary","tags":["RETAIL"],"parameters":[{"name":"accountId","in":"path","type":"string","required":true,"description":"Identifier of the account. Often referred to as the account number, yet for consistency this is always referred to as accountId. Accepts both IBAN & BBAN"},{"name":"holdTypeId","in":"query","type":"string","required":false,"description":"Purpose or the type of hold placed on the account  The available list of hold types can be retrieved through getHoldTypes"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"AccountHoldDetailsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"POST","path":"/order/us/payments/transactionStops","fullPath":"/api/v11.0.0/order/us/payments/transactionStops","operationId":"createUsTransactionStop","name":"Create transaction stop instruction to capture instructions to stop a payment based on the payment type, recipient or amount","summary":"Create transaction stop instruction","tags":["RETAIL"],"parameters":[{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"stopCondition":[{}],"accountId":"@ref:product-accountOperationalDate-service-v1.0.0","stopTypeId":"string","transactionChannel":"string","stopInstructionChannel":"BANK","stopReason":"CHKDES","issueDate":"string","replacementCheck":"string","replacementCheckIssueDate":"string","expiryDate":"string","waiveCharge":"string","transactionStopStatus":"ACTIVE","suppressNotice":"string","cancelInstruction":"YES","override":"string"}},"responses":{"200":"UsTransactionStopResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"DELETE","path":"/order/us/payments/transactionStops/{stopInstructionId}","fullPath":"/api/v11.0.0/order/us/payments/transactionStops/{stopInstructionId}","operationId":"deleteUsTransactionStop","name":"Deletes a transaction stop instruction capturing with instructions to stop a payment","summary":"Delete transaction stop","tags":["RETAIL"],"parameters":[{"name":"stopInstructionId","in":"path","type":"string","required":true,"description":"ID of stop instruction"},{"name":"payload","in":"body","type":"object","required":false,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}}},"responses":{"200":"UsTransactionStopResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"POST","path":"/order/us/payments/wireTransfers","fullPath":"/api/v11.0.0/order/us/payments/wireTransfers","operationId":"createFedwireCTR","name":"Creates an instant payment through  fedwire of payment type CTR, customer transfer","summary":"Creates a customer transfer through wire payment","tags":["RETAIL"],"parameters":[{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"orderingCustomerAddressLines":[{}],"ultimateDebtorAddressLines":[{}],"beneficiaryInstituteAddressLines":[{}],"beneficiaryAddressLines":[{}],"intermediaryFiNameAddressLines":[{}],"intermediary2FiNameAddressLines":[{}],"OriginatorToBeneficiaryLines":[{}],"receiverFiAndIntermediaryFiLines":[{}],"adviceInformation":[{}],"InformationLines":[{}],"charges":[{}],"overrides":[{}],"paymentPriority":"/v1.0.0/reference/lookups?virtualTableName=PAYMENT.SERVICE.LEVEL.CODE","orderingCustomerId":"string","debitAccountId":"string"}},"responses":{"200":"FedwireCTRResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"POST","path":"/order/us/payments/paymentOrders","fullPath":"/api/v11.0.0/order/us/payments/paymentOrders","operationId":"createUsDomesticTransfer","name":"Create one-time domestic account transfers and bill payments through ACH Clearing and the interbank automated clearing house","summary":"Create domestic transfer","tags":["RETAIL"],"parameters":[{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"standardEntryClassCode":"CIE","companyEntryDescription":"string","debitAccountId":"string","transactionAmount":0.0,"requiredCreditValueDate":"2024-01-01","beneficiaryId":"/v1.0.0/party/us/customers/{customerId}/beneficiaries","transactionCode":0.0,"beneficiaryOtherId":"string","accountWithBankClearingCode":"string","beneficiaryAccountId":"string","beneficiaryName":"string","narrative":"string","paymentCurrency":"string","paymentOrderProductId":"string","recordStatus":"string"}},"responses":{"200":"UsDomesticTransferResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"POST","path":"/order/us/payments/standingOrders/{accountId}","fullPath":"/api/v11.0.0/order/us/payments/standingOrders/{accountId}","operationId":"createUsRecurringTransfers","name":"Create a recurring account transfer","summary":"Create recurring transfer","tags":["RETAIL"],"parameters":[{"name":"accountId","in":"path","type":"string","required":true,"description":"Identifier of the account. Often referred to as the account number, yet for consistency this is always referred to as accountId. Accepts both IBAN & BBAN"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"beneficiaries":[{}],"currentFrequency":"string","standardEntryClassCode":"CIE","startDate":"2024-01-01","companyEntryDescription":"string","currentEndDate":"2024-01-01","currentAmountBalance":0.0,"beneficiaryId":"/v1.0.0/party/us/customers/{customerId}/beneficiaries","transactionCode":0.0,"beneficiaryOtherId":"string","accountWithBankClearingCode":"string","beneficiaryAccountId":"string","paymentDetail":"string","currency":"string","recordStatus":"string"}},"responses":{"200":"UsRecurringTransfersResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"POST","path":"/order/us/payments/directDebits/{accountId}","fullPath":"/api/v11.0.0/order/us/payments/directDebits/{accountId}","operationId":"createUsDirectDebits","name":"Create direct debit instructions for repayment of loans or bill payment through external accounts","summary":"Create direct debit instruction","tags":["RETAIL"],"parameters":[{"name":"accountId","in":"path","type":"string","required":true,"description":"Identifier of the account. Often referred to as the account number, yet for consistency this is always referred to as accountId. Accepts both IBAN & BBAN"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"displayName":"string","directDebitParameterId":"string","serviceClassCode":0.0,"standardEntryClassCode":"PPD","debitAccountType":"string","debitBankClearingCode":"string","destinationAccountId":"string","debitorName":"string","frequency":"string","paymentDetail":"string","currencyMarket":"string","terminationDate":"2024-01-01","direction":"string","standAloneDdi":"string","standaloneAmount":0.0}},"responses":{"200":"UsDirectDebitsResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/order/us/payments/directDebits","fullPath":"/api/v11.0.0/order/us/payments/directDebits","operationId":"getUsDirectDebits","name":"Retrieve the list of direct debits initiated for repayment of bills or loans from external accounts","summary":"Retrieve direct debits setup for an account","tags":["RETAIL"],"parameters":[{"name":"customerId","in":"query","type":"string","required":false,"description":"Contains the unique identifier of the customer who has received the payment request (RTP) or credit transfer for which the information request is to be raised."},{"name":"directDebitParameterId","in":"query","type":"string","required":false,"description":"Reference to the parameter which holds details relating to clearing accounts, number of days before which the claim has to be submitted or resubmitted"},{"name":"frequency","in":"query","type":"string","required":false,"description":"Specifies the frequency in which the payment application(periodic payments) execute the payment instruction."},{"name":"accountId","in":"query","type":"string","required":false,"description":"Identifier of the account. Often referred to as the account number, yet for consistency this is always referred to as accountId. Accepts both IBAN & BBAN"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"UsDirectDebitsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/order/us/payments/standingOrders","fullPath":"/api/v11.0.0/order/us/payments/standingOrders","operationId":"getUsRecurringTransfers","name":"Retrieve recurring payments setup for account transfers and bill payments","summary":"Get recurring transfer details","tags":["RETAIL"],"parameters":[{"name":"orderingCustomerId","in":"query","type":"string","required":false,"description":"Indicates the customer id for the ordering customer"},{"name":"paymentOrderProductName","in":"query","type":"string","required":false,"description":"Indicates the name of payment order product "},{"name":"accountId","in":"query","type":"string","required":false,"description":"Identifier of the account. Often referred to as the account number, yet for consistency this is always referred to as accountId. Accepts both IBAN & BBAN"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"UsRecurringTransfersResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"POST","path":"/order/us/payments/wireTransfers/simulate","fullPath":"/api/v11.0.0/order/us/payments/wireTransfers/simulate","operationId":"simulateFedwireCTR","name":"Validate payment order transaction to verify the information provided and to retrieve the applicable charges","summary":"Validate payment order transaction ","tags":["RETAIL"],"parameters":[{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"orderingCustomerAddressLines":[{}],"ultimateDebtorAddressLines":[{}],"beneficiaryInstituteAddressLines":[{}],"beneficiaryAddressLines":[{}],"intermediaryFiNameAddressLines":[{}],"intermediary2FiNameAddressLines":[{}],"OriginatorToBeneficiaryLines":[{}],"receiverFiAndIntermediaryFiLines":[{}],"adviceInformation":[{}],"InformationLines":[{}],"charges":[{}],"overrides":[{}],"paymentPriority":"/v1.0.0/reference/lookups?virtualTableName=PAYMENT.SERVICE.LEVEL.CODE","orderingCustomerId":"string","debitAccountId":"string"}},"responses":{"200":"FedwireCTRResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/order/us/payments/paymentStatus","fullPath":"/api/v11.0.0/order/us/payments/paymentStatus","operationId":"getUsPaymentsStatus","name":"Retrieve payment status and transaction history for an account along with beneficiary details and beneficiary status","summary":"Retrieve payment history","tags":["RETAIL"],"parameters":[{"name":"fromDate","in":"query","type":"string","required":false,"description":"Indicates the business date from when the balance reservation event is active."},{"name":"status","in":"query","type":"string","required":false,"description":"The status of the early maturity request"},{"name":"orderingCustomerId","in":"query","type":"string","required":false,"description":"Indicates the customer id for the ordering customer"},{"name":"debitAccountId","in":"query","type":"string","required":false,"description":"Indicates the debit account number of the payment or transaction."},{"name":"paymentOrderId","in":"query","type":"string","required":false,"description":"The unique reference number of payment"},{"name":"transactionReference","in":"query","type":"string","required":false,"description":"Contains the identifier for the transaction in the core system"},{"name":"paymentStatus","in":"query","type":"string","required":false,"description":"Describes the current status of the payment order in the payment system"},{"name":"toDate","in":"query","type":"string","required":false,"description":"Indicates the business date until when the balance reservation event is active."},{"name":"beneficiaryId","in":"query","type":"string","required":false,"description":"Indicates the reference of the financial institution that allows access to the beneficiary information"},{"name":"beneficiaryAccountId","in":"query","type":"string","required":false,"description":"Unique account identifier of the beneficiary account number."},{"name":"direction","in":"query","type":"string","required":false,"description":"Contains the direction of the information request. Value of 'Outward' indicates that the information request is sent by the Bank. Value of 'Inward' indicates that the request for information is receiv"},{"name":"paymentOrderProductId","in":"query","type":"string","required":false,"description":"Indicates the payment order product for which payment is initiated"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"UsPaymentsStatusResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"POST","path":"/order/us/payments/microDeposits","fullPath":"/api/v11.0.0/order/us/payments/microDeposits","operationId":"createUsACHBatchMicroDeposits","name":"Create a microdeposit batch to validate external account for a new beneficiary added by customer","summary":"Create a microdeposit batch to validate external account","tags":["RETAIL"],"parameters":[{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"entryDetails":[{}],"accountType":"string","recordStatus":"string","currNo":"string","inputter":"string","dateTime":"string","authoriser":"string","companyId":"string","deptCOde":"string","auditorCode":"string","auditTimeDate":"string","extensions":{}}},"responses":{"200":"UsACHBatchMicroDepositsResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/order/us/payments/customers/{orderingCustomerId}/directDebits/achDebits","fullPath":"/api/v11.0.0/order/us/payments/customers/{orderingCustomerId}/directDebits/achDebits","operationId":"getUsACHBatchAchDebits","name":"Retrieve list of customer initiated debit request to external accounts processed through ACH clearing and the interbank automated clearing house","summary":"Retrieve list of customer initiated debit request to external accounts","tags":["RETAIL"],"parameters":[{"name":"orderingCustomerId","in":"path","type":"string","required":true,"description":"Indicates the customer id for the ordering customer"},{"name":"effectiveDate","in":"query","type":"string","required":false,"description":"Contains the identifier for the transaction date. Dates are expected in \u00e2\u20ac\u02dcYYYYMMDD\u00e2\u20ac\u2122 format"},{"name":"creditAccountId","in":"query","type":"string","required":false,"description":"Credit account identifier of the payment or transaction"},{"name":"transactionCode","in":"query","type":"string","required":false,"description":"Identifies the system internal transaction code applicable to the transaction"},{"name":"amount","in":"query","type":"string","required":false,"description":"Contains the direct debit claim amount"},{"name":"beneficiaryInstituteRoutingNo","in":"query","type":"string","required":false,"description":"Routing number of DDA number of the Financial institution where the beneficiary account exists"},{"name":"debitAccountId","in":"query","type":"string","required":false,"description":"Indicates the debit account number of the payment or transaction."},{"name":"debitorName","in":"query","type":"string","required":false,"description":"The name of the customer who owns the destination account or the debit account used to collect payments"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"UsACHBatchAchDebitsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"POST","path":"/order/us/payments/wireTransfers/cancel/{transactionReference}","fullPath":"/api/v11.0.0/order/us/payments/wireTransfers/cancel/{transactionReference}","operationId":"reverseUsWireTransfer","name":"Request can be sent to initiate cancellation for a wire transfer within 30 minutes of submitting the wire payment","summary":"Initiate request to cancel wire transfer","tags":["RETAIL"],"parameters":[{"name":"transactionReference","in":"path","type":"string","required":true,"description":"Contains the identifier for the transaction in the core system"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"overrideDetails":[{}],"inputter":[{}],"dateTime":[{}],"transactionReference":"string","processingDate":"2024-01-01","statusCode":0.0,"sendersReference":"string","orderingAccount":"string","orderingName":"string","debitCustomerId":0.0,"recordStatus":"string","currNo":0.0,"authoriser":"string","companyCode":"string","deptCode":"string"}},"responses":{"200":"UsWireTransferResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"POST","path":"/order/us/payments/swiftTransfers/cancel/{transactionReference}","fullPath":"/api/v11.0.0/order/us/payments/swiftTransfers/cancel/{transactionReference}","operationId":"cancelSwiftTransaction","name":"Request to cancel international payments initiated within 30 minutes of submitting the payment","summary":"Initiate request to cancel international transfers","tags":["RETAIL"],"parameters":[{"name":"transactionReference","in":"path","type":"string","required":true,"description":"Contains the identifier for the transaction in the core system"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"inputter":[{}],"dateTime":[{}],"companyId":"string","transactionReference":"string","amount":0.0,"currencyId":"string","paymentMsgSentDate":"2024-01-01","outputChannel":"string","statusCode":"string","recordStatus":"string","currNo":0.0,"authoriser":"string","companyCode":"string","deptCode":"string","auditorCode":"string"}},"responses":{"200":"SwiftTransactionResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/order/us/payments/achEntry/{achEntryId}/achEntryStatus","fullPath":"/api/v11.0.0/order/us/payments/achEntry/{achEntryId}/achEntryStatus","operationId":"updateAchNOCEntriesStatus","name":"Allows to update the ACH entries status to processed","summary":"Allows to update the ACH entries status to processed","tags":["RETAIL"],"parameters":[{"name":"achEntryId","in":"path","type":"string","required":true,"description":""},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"achEntryStatus":"string","paymentOrderId":"string","transactionReference":"string","executionDate":"string","deliveryByDate":"string","creditDebitIndicator":"string","beneficiaryInstituteRoutingNo":"string","beneficiaryName":"string","beneficiaryOtherId":"string","accountId":"string","paymentAmount":"string","standardEntryClassCode":"string","extensions":{}}},"responses":{"200":"AchNOCEntriesStatusResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"POST","path":"/order/us/payments/directDebits/achDebits","fullPath":"/api/v11.0.0/order/us/payments/directDebits/achDebits","operationId":"createUsAchSameDayDebits","name":"Initiates same day ACH debit collection transaction","summary":"Initiates same day debit transfers","tags":["RETAIL"],"parameters":[{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"creditAccountId":"string","amount":"string","effectiveDate":"string","debitBankClearingCode":"string","debitAccountId":"string","debitorName":"string","additionalInformation":"string","standardEntryClassCode":"CCD","debitAccountType":"Checking","customerType":"Business","companyEntryDescription":"string","extensions":{}}},"responses":{"200":"UsAchSameDayDebitsResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/order/us/payments/wireTransfers/accounts/{debitAccountId}/mandates","fullPath":"/api/v11.0.0/order/us/payments/wireTransfers/accounts/{debitAccountId}/mandates","operationId":"getUsDrawdownMandates","name":"Retrieves all the available drawdown authorization or mandates for an account.","summary":"Retrieves drawdown mandates ","tags":["RETAIL"],"parameters":[{"name":"debitAccountId","in":"path","type":"string","required":true,"description":"Indicates the debit account number of the payment or transaction."},{"name":"beneficiaryAccountId","in":"query","type":"string","required":false,"description":"Unique account identifier of the beneficiary account number."},{"name":"routingNumber","in":"query","type":"string","required":false,"description":"Indicates the routing number of the bank where the account is held"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"UsDrawdownMandatesResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"POST","path":"/order/us/payments/wireTransfers/mandates","fullPath":"/api/v11.0.0/order/us/payments/wireTransfers/mandates","operationId":"createUsDrawdownMandate","name":"Allows to create a drawdown authorization for a customer for approving automatic drawdown transfer via wire payment to debit their account based on a drawdown request (1031 or 1631) received from the creditor's financial institution. The authorization form or the mandate form captures the credit account number, the financial institution where the creditor account is held, the purpose for which the debit request will be sent, the maximum amount allowed to be debited upon a drawdown request and th","summary":"Allows to create a drawdown authorization","tags":["RETAIL"],"parameters":[{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"debitAccountId":"string","debitAccountName":"string","beneficiaryAccountId":"string","drawdownAmount":0.0,"beneficiaryInstituteName":"string","routingNumber":"string","beneficiaryName":"string","accountType":"/v1.0.0/reference/lookups?virtualTableName=USRTGS.ACCT.TYPE","beneficiaryAddress":"string","receiverFiAndIntermediaryFiInfo":"string","effectiveFromDate":"2024-01-01","effectiveToDate":"2024-01-01","extensions":{}}},"responses":{"200":"UsDrawdownMandateResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/order/us/payments/wireTransfers/{mandateId}/mandates","fullPath":"/api/v11.0.0/order/us/payments/wireTransfers/{mandateId}/mandates","operationId":"updateUsDrawdownMandate","name":"Allows to update existing drawdown authorization or mandate created for a customer to approve automatic drawdown transfer via wire payment to debit their account and crediting an external account","summary":"Allows to update existing drawdown authorization","tags":["RETAIL"],"parameters":[{"name":"mandateId","in":"path","type":"string","required":true,"description":""},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"debitAccountId":"string","debitAccountName":"string","beneficiaryAccountId":"string","drawdownAmount":0.0,"beneficiaryInstituteName":"string","routingNumber":"string","beneficiaryName":"string","accountType":"/v1.0.0/reference/lookups?virtualTableName=USRTGS.ACCT.TYPE","beneficiaryAddress":"string","receiverFiAndIntermediaryFiInfo":"string","effectiveFromDate":"2024-01-01","effectiveToDate":"2024-01-01","extensions":{}}},"responses":{"200":"UsDrawdownMandateResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"POST","path":"/order/us/payments/wireTransfers/surplusSweep","fullPath":"/api/v11.0.0/order/us/payments/wireTransfers/surplusSweep","operationId":"createFedwireETI","name":"Creates Fedwire fund transfer to manage their excess funds","summary":"Creates fund transfer for excess funds","tags":["RETAIL"],"parameters":[{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"orderingCustomerAddresses":[{}],"beneficiaryInstituteAddresses":[{}],"beneficiaryAddresses":[{}],"paymentPriority":"string","senderRoutingNo":"string","orderingCustomerId":"string","debitAccountId":"string","schedulePaymentAmount":"string","accountWithBankSortCode":"string","beneficiaryId":"string","beneficiaryName":"string","beneficiaryAccountId":"string","extensions":{}}},"responses":{"200":"FedwireETIResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"POST","path":"/order/us/payments/wires/customerTransfers","fullPath":"/api/v11.0.0/order/us/payments/wires/customerTransfers","operationId":"createFedwire-CTR","name":"Creates an instant payment through  fedwire payment type of  customer transfer (CTR, CTP)","summary":"Creates a customer transfer through wire payment","tags":["RETAIL"],"parameters":[{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"orderingCustomerAddressLines":[{}],"ultimateDebtorAddressLines":[{}],"beneficiaryInstituteAddressLines":[{}],"beneficiaryAddressLines":[{}],"intermediaryFiNameAddressLines":[{}],"intermediary2FiNameAddressLines":[{}],"OriginatorToBeneficiaryLines":[{}],"receiverFiAndIntermediaryFiLines":[{}],"adviceInformation":[{}],"InformationLines":[{}],"charges":[{}],"overrides":[{}],"paymentPriority":"/v1.0.0/reference/lookups?virtualTableName=PAYMENT.SERVICE.LEVEL.CODE","orderingCustomerId":"string","debitAccountId":"string"}},"responses":{"200":"Fedwire-CTRResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"POST","path":"/order/us/payments/wires/bankTransfers","fullPath":"/api/v11.0.0/order/us/payments/wires/bankTransfers","operationId":"createFedwireBankTransfer","name":"Creates an instant payment through fedwire of bank transfer payment type (BTR,FFS,FFR,CKS and DEP)","summary":"Creates a bank transfer through wire payment","tags":["RETAIL"],"parameters":[{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"orderingCustomerAddressLines":[{}],"ultimateDebtorAddressLines":[{}],"beneficiaryInstituteAddressLines":[{}],"intermediaryFiNameAddressLines":[{}],"intermediary2FiNameAddressLines":[{}],"OriginatorToBeneficiaryLines":[{}],"receiverFiAndIntermediaryFiLines":[{}],"adviceInformation":[{}],"InformationLines":[{}],"charges":[{}],"overrides":[{}],"paymentPriority":"/v1.0.0/reference/lookups?virtualTableName=PAYMENT.SERVICE.LEVEL.CODE","orderingCustomerId":"string","debitAccountId":"string","schedulePaymentAmount":0.0}},"responses":{"200":"FedwireBankTransferResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/order/us/payments/ach/{achReference}","fullPath":"/api/v11.0.0/order/us/payments/ach/{achReference}","operationId":"getUsACHTraceNumber","name":"Retrieve automated clearing house(ACH) trace number","summary":"Retrieve automated clearing house(ACH) outgoing file trace number","tags":["RETAIL"],"parameters":[{"name":"achReference","in":"path","type":"string","required":true,"description":""},{"name":"captureId","in":"query","type":"string","required":false,"description":"Deprecated - Capture reference"},{"name":"paymentOrderId","in":"query","type":"string","required":false,"description":"The unique reference number of payment"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"UsACHTraceNumberResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"POST","path":"/order/us/payments/coverdellEducationSavings/contributions","fullPath":"/api/v11.0.0/order/us/payments/coverdellEducationSavings/contributions","operationId":"createESAContribution","name":"A contribution transaction is basically depositing funds into ESA (Education savings account). Three types of contributions are possible. Regular contribution, rollover contribution and trustee-to-trustee contribution. Regular contribution denotes funds deposited into the account. Rollover contribution means transfer of funds from one ESA to another ESA for the benefit of the same beneficiary or a member of the beneficiary's family. Trustee-to-trustee contribution denotes a transfer of funds dir","summary":"Create a new education savings account contribution","tags":["RETAIL"],"parameters":[{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"orderingCompany":"orderingCompany","paymentExecutionDate":"2024-01-01","contributionType":"/v1.0.0/reference/lookups/?virtualTableName=IRA.CONTRIBUTION.TYPE","paymentCurrencyId":"Payment Currency","paymentAmount":0.0,"orderingCustomerId":"string","debitAccount":"debitAccount","creditAccount":"creditAccount","debitAmount":0.0,"creditAmount":0.0,"debitValueDate":"2024-01-01","creditValueDate":"2024-01-01","previousYearContribution":"Y","extensions":{}}},"responses":{"200":"ESAContributionResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"POST","path":"/order/us/payments/coverdellEducationSavings/reinvestments","fullPath":"/api/v11.0.0/order/us/payments/coverdellEducationSavings/reinvestments","operationId":"createESAReinvestment","name":"Creating a new education savings account reinvestment transaction. A reinvestment transaction is transfer of funds between two ESA (Education savings account) type of accounts. Reinvestment transaction will not appear on the year end tax generated for the ESA beneficiary.","summary":"Create a new education savings account reinvestment","tags":["RETAIL"],"parameters":[{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"orderingCompany":"orderingCompany","paymentExecutionDate":"2024-01-01","paymentCurrencyId":"Payment Currency","paymentAmount":0.0,"orderingCustomerId":"string","debitAccount":"debitAccount","creditAccount":"creditAccount","debitAmount":0.0,"creditAmount":0.0,"debitValueDate":"2024-01-01","creditValueDate":"2024-01-01","previousYearContribution":"Y","extensions":{}}},"responses":{"200":"ESAReinvestmentResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"POST","path":"/order/us/payments/coverdellEducationSavings/distributions","fullPath":"/api/v11.0.0/order/us/payments/coverdellEducationSavings/distributions","operationId":"createESADistribution","name":"Creating a new ESA distribution. A distribution transaction is a withdrawal of funds from an ESA (Education savings account). There are different types of distribution from ESA are possible - Regular distribution, Rollover distribution and Trustee-to-trustee distribution. Regular distribution denotes funds withdrawn to pay for eligible educational expenses. Rollover distribution denotes funds are moved out of the Bank for the purpose of creating ESA account in another Bank. Trustee-to-trustee di","summary":"Create a new education savings account distribution","tags":["RETAIL"],"parameters":[{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"orderingCompany":"orderingCompany","paymentExecutionDate":"2024-01-01","distributionType":"/v1.0.0/reference/lookups/?virtualTableName=IRA.DISTRIBUTION.TYPE","paymentCurrencyId":"Payment Currency","paymentAmount":0.0,"orderingCustomerId":"string","debitAccount":"debitAccount","creditAccount":"creditAccount","debitAmount":0.0,"creditAmount":0.0,"debitValueDate":"2024-01-01","creditValueDate":"2024-01-01","extensions":{}}},"responses":{"200":"ESADistributionResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"POST","path":"/order/us/payments/coverdellEducationSavings/corrections/contributions","fullPath":"/api/v11.0.0/order/us/payments/coverdellEducationSavings/corrections/contributions","operationId":"createESAContributionCorrection","name":"A contribution correction is a provision to perform correction on the past contribution transaction. When a correction contribution is performed, system reverts the contribution amount to that extent. For example, on an account with $10,000 in gross contribution in tax year 2023, when a correction contribution transaction for $900 is performed, system will debit the account and the balance as well as the gross contribution amount will be reduced to $9,100.","summary":"Create a new education savings account contribution correction","tags":["RETAIL"],"parameters":[{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"orderingCompany":"orderingCompany","paymentExecutionDate":"2024-01-01","contributionType":"/v1.0.0/reference/lookups/?virtualTableName=IRA.CONTRIBUTION.TYPE","paymentCurrencyId":"Payment Currency","paymentAmount":0.0,"orderingCustomerId":"string","debitAccount":"debitAccount","creditAccount":"creditAccount","debitAmount":0.0,"creditAmount":0.0,"debitValueDate":"2024-01-01","creditValueDate":"2024-01-01","previousYearContribution":"Y","extensions":{}}},"responses":{"200":"ESAContributionCorrectionResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"POST","path":"/order/us/payments/coverdellEducationSavings/corrections/distributions","fullPath":"/api/v11.0.0/order/us/payments/coverdellEducationSavings/corrections/distributions","operationId":"createESADistributionCorrection","name":"A distribution correction is a provision to perform correction on the past distributions. When a correction distribution is performed, system reverts the gross distribution amount to that extent. For example, an account has $10,000 in gross contribution and $1,200 in gross distribution in tax year 2023; with a balance of $8,800. When a correction distribution for $200 is performed on that account, system will credit the account, resulting in the balance being increased to $9,000 and the gross di","summary":"Create a new education savings account distribution correction","tags":["RETAIL"],"parameters":[{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"orderingCompany":"orderingCompany","paymentExecutionDate":"2024-01-01","distributionType":"/v1.0.0/reference/lookups/?virtualTableName=IRA.DISTRIBUTION.TYPE","paymentCurrencyId":"Payment Currency","paymentAmount":0.0,"orderingCustomerId":"string","debitAccount":"debitAccount","creditAccount":"creditAccount","debitAmount":0.0,"creditAmount":0.0,"debitValueDate":"2024-01-01","creditValueDate":"2024-01-01","extensions":{}}},"responses":{"200":"ESADistributionCorrectionResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}}]},{"key":"order-us-payments-service-v2.0.0","title":"US Model Bank Payment services","version":"v2.0.0","description":"API to create ACH and Wire payments, standing orders, Automatic debit instructions, place holds on account, stop checks","endpointCount":15,"endpoints":[{"method":"POST","path":"/order/us/payment/escrows","fullPath":"/api/v2.0.0/order/us/payment/escrows","operationId":"createEscrowAdhocDeposit","name":"Initiates an Escrow payment transaction","summary":"Escrow Payment","tags":["RETAIL"],"parameters":[{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"overrideDetails":[{}],"creditAccountId":"@ref:product-accountOperationalDate-service-v1.0.0","creditValueDate":"2024-01-01","creditCurrencyId":"string","creditAmount":0.0,"debitAccountId":"@ref:product-accountOperationalDate-service-v1.0.0","debitValueDate":"2024-01-01","debitCurrencyId":"string","debitAmount":0.0,"treasuryRate":0.0,"processingDate":"2024-01-01","customerRate":0.0,"customerSpread":0.0,"recordStatus":"string","currNo":0.0}},"responses":{"200":"EscrowAdhocDepositResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"POST","path":"/order/us/accounts/{accountId}/reservedFunds","fullPath":"/api/v2.0.0/order/us/accounts/{accountId}/reservedFunds","operationId":"createAccountBalanceHold","name":"Create a hold transaction to lock the funds in an account","summary":"Create account Hold","tags":["RETAIL"],"parameters":[{"name":"accountId","in":"path","type":"string","required":true,"description":"Identifier of the account. Often referred to as the account number, yet for consistency this is always referred to as accountId. Accepts both IBAN & BBAN"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"overrides":[{}],"holdTypeId":"/v1.0.0/reference/us/accountHoldTypes","description":"string","fromDate":"2024-01-01","toDate":"2024-01-01","lockedAmount":0.0,"blockPriorityId":"string","recordStatus":"string","currNo":0.0,"inputter":"string","dateTime":0.0,"authoriser":"string","companyId":"@ref:reference-companies-service-v1.0.0","deptCode":"@ref:reference-accountOfficers-service-v1.0.0","auditorCode":"string"}},"responses":{"200":"AccountBalanceHoldResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/order/us/accounts/{holdId}/reservedFunds","fullPath":"/api/v2.0.0/order/us/accounts/{holdId}/reservedFunds","operationId":"getAccountBalanceHold","name":"Retrieves information the amount locked, lock type and the validity for a hold transaction","summary":"Retrieve hold funds detail","tags":["RETAIL"],"parameters":[{"name":"holdId","in":"path","type":"string","required":true,"description":"The transaction reference through which the specified amount in the transaction has been locked in an account"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"AccountBalanceHoldResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/order/us/payment/holds/{holdId}","fullPath":"/api/v2.0.0/order/us/payment/holds/{holdId}","operationId":"updateAccountBalanceHold","name":"Update amount or validity date of an existing hold","summary":"Update existing hold","tags":["RETAIL"],"parameters":[{"name":"holdId","in":"path","type":"string","required":true,"description":"The transaction reference through which the specified amount in the transaction has been locked in an account"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"overrides":[{}],"holdTypeId":"/v1.0.0/reference/us/accountHoldTypes","description":"string","fromDate":"2024-01-01","toDate":"2024-01-01","lockedAmount":0.0,"blockPriorityId":"string","recordStatus":"string","currNo":0.0,"inputter":"string","dateTime":0.0,"authoriser":"string","companyId":"@ref:reference-companies-service-v1.0.0","deptCode":"@ref:reference-accountOfficers-service-v1.0.0","auditorCode":"string"}},"responses":{"200":"AccountBalanceHoldResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/order/us/payment/accounts/{accountId}/holdSummary","fullPath":"/api/v2.0.0/order/us/payment/accounts/{accountId}/holdSummary","operationId":"getAccountHoldDetails","name":"Retrieves details of all holds placed on an account","summary":"Get hold summary","tags":["RETAIL"],"parameters":[{"name":"accountId","in":"path","type":"string","required":true,"description":"Identifier of the account. Often referred to as the account number, yet for consistency this is always referred to as accountId. Accepts both IBAN & BBAN"},{"name":"holdTypeId","in":"query","type":"string","required":false,"description":"Purpose or the type of hold placed on the account  The available list of hold types can be retrieved through getHoldTypes"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"AccountHoldDetailsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"POST","path":"/order/us/payment/transactionStops","fullPath":"/api/v2.0.0/order/us/payment/transactionStops","operationId":"createUsTransactionStop","name":"Create Transaction Stops","summary":"Create Transaction Stops","tags":["RETAIL"],"parameters":[{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"stopCondition":[{}],"accountId":"@ref:product-accountOperationalDate-service-v1.0.0","stopTypeId":"string","transactionChannel":"string","stopInstructionChannel":"BANK","stopReason":"CHKDES","issueDate":"string","replacementCheck":"string","replacementCheckIssueDate":"string","expiryDate":"string","waiveCharge":"string","transactionStopStatus":"ACTIVE","suppressNotice":"string","cancelInstruction":"YES","override":"string"}},"responses":{"200":"UsTransactionStopResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"DELETE","path":"/order/us/payment/transactionStops/{stopInstructionId}","fullPath":"/api/v2.0.0/order/us/payment/transactionStops/{stopInstructionId}","operationId":"deleteUsTransactionStop","name":"Delete Transaction Stop","summary":"Delete Transaction Stop","tags":["RETAIL"],"parameters":[{"name":"stopInstructionId","in":"path","type":"string","required":true,"description":"ID of stop instruction"},{"name":"payload","in":"body","type":"object","required":false,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}}},"responses":{"200":"UsTransactionStopResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"POST","path":"/order/us/payments/wireTransfers","fullPath":"/api/v2.0.0/order/us/payments/wireTransfers","operationId":"createFedwire-CTR","name":"Creates a Fedwire CTR payment","summary":"Posts a CTR wire transaction","tags":["RETAIL"],"parameters":[{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"orderingCustomerAddressLines":[{}],"beneficiaryInstituteAddressLines":[{}],"beneficiaryAddressLines":[{}],"intermediaryFiNameAddressLines":[{}],"OriginatorToBeneficiaryLines":[{}],"receiverFiAndIntermediaryFiLines":[{}],"adviceInformation":[{}],"InformationLines":[{}],"charges":[{}],"overrides":[{}],"paymentPriority":"/v1.0.0/reference/lookups?virtualTableName=PAYMENT.SERVICE.LEVEL.CODE","orderingCustomerId":"string","debitAccountId":"string","schedulePaymentAmount":0.0,"debitValueDate":"2024-01-01"}},"responses":{"200":"Fedwire-CTRResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"POST","path":"/order/us/payments/paymentOrders","fullPath":"/api/v2.0.0/order/us/payments/paymentOrders","operationId":"createUsDomesticTransfer","name":"Create one-time domestic account transfers and bill payments","summary":"Create ACH Domestic Transfer","tags":["RETAIL"],"parameters":[{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"standardEntryClassCode":"CIE","companyEntryDescription":"string","debitAccountId":"string","transactionAmount":0.0,"requiredCreditValueDate":"2024-01-01","beneficiaryId":"/v1.0.0/party/us/customers/{customerId}/beneficiaries","transactionCode":0.0,"beneficiaryOtherId":"string","accountWithBankClearingCode":"string","beneficiaryAccountId":"string","beneficiaryName":"string","narrative":"string","paymentCurrency":"string","paymentOrderProductId":"string","recordStatus":"Status of record -authorised/on hold/unauth etc"}},"responses":{"200":"UsDomesticTransferResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"POST","path":"/order/us/payments/standingOrders/{accountId}","fullPath":"/api/v2.0.0/order/us/payments/standingOrders/{accountId}","operationId":"createUsRecurringTransfers","name":"API to create a Beneficiary for account transfers or bill payment","summary":"Create recurring Transfer","tags":["RETAIL"],"parameters":[{"name":"accountId","in":"path","type":"string","required":true,"description":"Identifier of the account. Often referred to as the account number, yet for consistency this is always referred to as accountId. Accepts both IBAN & BBAN"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"beneficiaries":[{}],"currentFrequency":"string","standardEntryClassCode":"CIE","startDate":"2024-01-01","companyEntryDescription":"string","currentEndDate":"2024-01-01","currentAmountBalance":0.0,"beneficiaryId":"/v1.0.0/party/us/customers/{customerId}/beneficiaries","transactionCode":0.0,"beneficiaryOtherId":"string","accountWithBankClearingCode":"string","beneficiaryAccountId":"string","paymentDetail":"string","recordStatus":"Status of record -authorised/on hold/unauth etc","currNo":"No of times record has been changed"}},"responses":{"200":"UsRecurringTransfersResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"POST","path":"/order/us/payments/directDebits/{accountId}","fullPath":"/api/v2.0.0/order/us/payments/directDebits/{accountId}","operationId":"createUsDirectDebits","name":"Create direct debit instructions for repayment of loans or bill payment through external accounts","summary":"Create Direct Debit","tags":["RETAIL"],"parameters":[{"name":"accountId","in":"path","type":"string","required":true,"description":"Identifier of the account. Often referred to as the account number, yet for consistency this is always referred to as accountId. Accepts both IBAN & BBAN"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"displayName":"string","directDebitParameterId":"string","serviceClassCode":0.0,"standardEntryClassCode":"PPD","debitAccountType":"string","debitBankClearingCode":"string","destinationAccountId":"string","debitorName":"string","frequency":"string","paymentDetail":"string","currencyMarket":"string","terminationDate":"2024-01-01","direction":"string","standAloneDdi":"string","standaloneAmount":0.0}},"responses":{"200":"UsDirectDebitsResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/order/us/payments/directDebits","fullPath":"/api/v2.0.0/order/us/payments/directDebits","operationId":"getUsDirectDebits","name":"API to get the list of direct debits initiated for repayment of bills or loans from external accounts","summary":"Retrieve Direct debits setup for an account","tags":["RETAIL"],"parameters":[{"name":"customerId","in":"query","type":"string","required":false,"description":"Identifier of the customer"},{"name":"directDebitParameterId","in":"query","type":"string","required":false,"description":"Reference to the parameter which holds details relating to clearing accounts, number of days before which the claim has to be submitted or resubmitted"},{"name":"frequency","in":"query","type":"string","required":false,"description":"Specifies the frequency in which the payment application(periodic payments) execute the payment instruction."},{"name":"accountId","in":"query","type":"string","required":false,"description":"Identifier of the account. Often referred to as the account number, yet for consistency this is always referred to as accountId. Accepts both IBAN & BBAN"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"UsDirectDebitsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/order/us/payments/standingOrders","fullPath":"/api/v2.0.0/order/us/payments/standingOrders","operationId":"getUsRecurringTransfers","name":"Retrieve recurring payments setup for account transfers and bill payments","summary":"Get Recurring Transfer details","tags":["RETAIL"],"parameters":[{"name":"orderingCustomerId","in":"query","type":"string","required":false,"description":"Indicates the customer id for the ordering customer"},{"name":"paymentOrderProductName","in":"query","type":"string","required":false,"description":"Indicates the name of payment order product "},{"name":"accountId","in":"query","type":"string","required":false,"description":"Identifier of the account. Often referred to as the account number, yet for consistency this is always referred to as accountId. Accepts both IBAN & BBAN"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"UsRecurringTransfersResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"POST","path":"/order/us/payments/wireTransfers/simulate","fullPath":"/api/v2.0.0/order/us/payments/wireTransfers/simulate","operationId":"simulateFedwire-CTR","name":"Validate Payment order transaction to verify the information provided and to retreive the applicable charges","summary":"Validate Payment order transaction ","tags":["RETAIL"],"parameters":[{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"orderingCustomerAddressLines":[{}],"beneficiaryInstituteAddressLines":[{}],"beneficiaryAddressLines":[{}],"intermediaryFiNameAddressLines":[{}],"OriginatorToBeneficiaryLines":[{}],"receiverFiAndIntermediaryFiLines":[{}],"adviceInformation":[{}],"InformationLines":[{}],"charges":[{}],"overrides":[{}],"paymentPriority":"/v1.0.0/reference/lookups?virtualTableName=PAYMENT.SERVICE.LEVEL.CODE","orderingCustomerId":"string","debitAccountId":"string","schedulePaymentAmount":0.0,"debitValueDate":"2024-01-01"}},"responses":{"200":"Fedwire-CTRResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/order/us/payments/{debitAccountId}/paymentStatus","fullPath":"/api/v2.0.0/order/us/payments/{debitAccountId}/paymentStatus","operationId":"getUsPaymentsStatus","name":"Retrieve payment history","summary":"Retrieve payment status and transaction history for an account along with beneficiary details and beneficiary status","tags":["RETAIL"],"parameters":[{"name":"debitAccountId","in":"path","type":"string","required":true,"description":"Indicates the debit account number of the payment or transaction."},{"name":"fromDate","in":"query","type":"string","required":false,"description":"Indicates the business date from when the balance reservation event is active."},{"name":"status","in":"query","type":"string","required":false,"description":"The status of the early maturity request"},{"name":"orderingCustomerId","in":"query","type":"string","required":false,"description":"Indicates the customer id for the ordering customer"},{"name":"paymentOrderId","in":"query","type":"string","required":false,"description":"The unique reference number of payment"},{"name":"transactionReference","in":"query","type":"string","required":false,"description":"Contains the identifier for the transaction in the core system"},{"name":"paymentStatus","in":"query","type":"string","required":false,"description":"Describes the current status of the payment order in the payment system"},{"name":"toDate","in":"query","type":"string","required":false,"description":"Indicates the business date until when the balance reservation event is active."},{"name":"beneficiaryId","in":"query","type":"string","required":false,"description":"Indicates the reference of the financial institution that allows access to the beneficiary information"},{"name":"beneficiaryAccountId","in":"query","type":"string","required":false,"description":"Unique account identifier of the beneficiary account number."},{"name":"direction","in":"query","type":"string","required":false,"description":"Indicates the direction of the Direct debit claim for which mandate is received. The claim can be 'Outward' i.e. Claim is sent to the other bank or 'Inward'  i.e. other bank submit their claim to debi"},{"name":"paymentOrderProductId","in":"query","type":"string","required":false,"description":"Indicates the payment order product for which payment is initiated"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from t24 on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"UsPaymentsStatusResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}}]},{"key":"order-us-payments-service-v2.1.0","title":"US Model Bank Payment services","version":"v2.1.0","description":"API to create ACH and Wire payments, standing orders, Automatic debit instructions, place holds on account, stop checks","endpointCount":18,"endpoints":[{"method":"POST","path":"/order/us/payment/escrows","fullPath":"/api/v2.1.0/order/us/payment/escrows","operationId":"createEscrowAdhocDeposit","name":"Initiates an escrow payment transaction","summary":"Escrow payment","tags":["RETAIL"],"parameters":[{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"overrideDetails":[{}],"creditAccountId":"@ref:product-accountOperationalDate-service-v1.0.0","creditValueDate":"2024-01-01","creditCurrencyId":"string","creditAmount":0.0,"debitAccountId":"@ref:product-accountOperationalDate-service-v1.0.0","debitValueDate":"2024-01-01","debitCurrencyId":"string","debitAmount":0.0,"treasuryRate":0.0,"processingDate":"2024-01-01","customerRate":0.0,"customerSpread":0.0,"recordStatus":"string","currNo":0.0}},"responses":{"200":"EscrowAdhocDepositResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"POST","path":"/order/us/accounts/{accountId}/reservedFunds","fullPath":"/api/v2.1.0/order/us/accounts/{accountId}/reservedFunds","operationId":"createAccountBalanceHold","name":"Create a hold transaction to lock the funds in an account","summary":"Create account hold","tags":["RETAIL"],"parameters":[{"name":"accountId","in":"path","type":"string","required":true,"description":"Identifier of the account. Often referred to as the account number, yet for consistency this is always referred to as accountId. Accepts both IBAN & BBAN"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"overrides":[{}],"holdTypeId":"/v1.0.0/reference/us/accountHoldTypes","description":"string","fromDate":"2024-01-01","toDate":"2024-01-01","lockedAmount":0.0,"blockPriorityId":"string","recordStatus":"string","currNo":0.0,"inputter":"string","dateTime":0.0,"authoriser":"string","companyId":"@ref:reference-companies-service-v1.0.0","deptCode":"@ref:reference-accountOfficers-service-v1.0.0","auditorCode":"string"}},"responses":{"200":"AccountBalanceHoldResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/order/us/accounts/{holdId}/reservedFunds","fullPath":"/api/v2.1.0/order/us/accounts/{holdId}/reservedFunds","operationId":"getAccountBalanceHold","name":"Retrieves information the amount locked, lock type and the validity for a hold transaction","summary":"Retrieve hold funds detail","tags":["RETAIL"],"parameters":[{"name":"holdId","in":"path","type":"string","required":true,"description":"The transaction reference through which the specified amount in the transaction has been locked in an account"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"AccountBalanceHoldResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/order/us/payment/holds/{holdId}","fullPath":"/api/v2.1.0/order/us/payment/holds/{holdId}","operationId":"updateAccountBalanceHold","name":"Update amount or validity date of an existing hold","summary":"Update existing hold","tags":["RETAIL"],"parameters":[{"name":"holdId","in":"path","type":"string","required":true,"description":"The transaction reference through which the specified amount in the transaction has been locked in an account"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"overrides":[{}],"holdTypeId":"/v1.0.0/reference/us/accountHoldTypes","description":"string","fromDate":"2024-01-01","toDate":"2024-01-01","lockedAmount":0.0,"blockPriorityId":"string","recordStatus":"string","currNo":0.0,"inputter":"string","dateTime":0.0,"authoriser":"string","companyId":"@ref:reference-companies-service-v1.0.0","deptCode":"@ref:reference-accountOfficers-service-v1.0.0","auditorCode":"string"}},"responses":{"200":"AccountBalanceHoldResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/order/us/payment/accounts/{accountId}/holdSummary","fullPath":"/api/v2.1.0/order/us/payment/accounts/{accountId}/holdSummary","operationId":"getAccountHoldDetails","name":"Retrieves details of all holds placed on an account","summary":"Get hold summary","tags":["RETAIL"],"parameters":[{"name":"accountId","in":"path","type":"string","required":true,"description":"Identifier of the account. Often referred to as the account number, yet for consistency this is always referred to as accountId. Accepts both IBAN & BBAN"},{"name":"holdTypeId","in":"query","type":"string","required":false,"description":"Purpose or the type of hold placed on the account  The available list of hold types can be retrieved through getHoldTypes"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"AccountHoldDetailsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"POST","path":"/order/us/payment/transactionStops","fullPath":"/api/v2.1.0/order/us/payment/transactionStops","operationId":"createUsTransactionStop","name":"Create transaction stop instruction to capture instructions to stop a payment based on the payment type, recipient or amount","summary":"Create transaction stop instruction","tags":["RETAIL"],"parameters":[{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"stopCondition":[{}],"accountId":"@ref:product-accountOperationalDate-service-v1.0.0","stopTypeId":"string","transactionChannel":"string","stopInstructionChannel":"BANK","stopReason":"CHKDES","issueDate":"string","replacementCheck":"string","replacementCheckIssueDate":"string","expiryDate":"string","waiveCharge":"string","transactionStopStatus":"ACTIVE","suppressNotice":"string","cancelInstruction":"YES","override":"string"}},"responses":{"200":"UsTransactionStopResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"DELETE","path":"/order/us/payment/transactionStops/{stopInstructionId}","fullPath":"/api/v2.1.0/order/us/payment/transactionStops/{stopInstructionId}","operationId":"deleteUsTransactionStop","name":"Deletes a transaction stop instruction capturing with instructions to stop a payment","summary":"Delete transaction stop","tags":["RETAIL"],"parameters":[{"name":"stopInstructionId","in":"path","type":"string","required":true,"description":"ID of stop instruction"},{"name":"payload","in":"body","type":"object","required":false,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}}},"responses":{"200":"UsTransactionStopResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"POST","path":"/order/us/payments/wireTransfers","fullPath":"/api/v2.1.0/order/us/payments/wireTransfers","operationId":"createFedwireCTR","name":"Creates an instant payment through  fedwire of payment type CTR, customer transfer","summary":"Posts a customer transfer through wire payment","tags":["RETAIL"],"parameters":[{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"orderingCustomerAddressLines":[{}],"beneficiaryInstituteAddressLines":[{}],"beneficiaryAddressLines":[{}],"intermediaryFiNameAddressLines":[{}],"OriginatorToBeneficiaryLines":[{}],"receiverFiAndIntermediaryFiLines":[{}],"adviceInformation":[{}],"InformationLines":[{}],"charges":[{}],"overrides":[{}],"paymentPriority":"/v1.0.0/reference/lookups?virtualTableName=PAYMENT.SERVICE.LEVEL.CODE","orderingCustomerId":"string","debitAccountId":"string","schedulePaymentAmount":0.0,"debitValueDate":"2024-01-01"}},"responses":{"200":"FedwireCTRResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"POST","path":"/order/us/payments/paymentOrders","fullPath":"/api/v2.1.0/order/us/payments/paymentOrders","operationId":"createUsDomesticTransfer","name":"Create one-time domestic account transfers and bill payments through ACH Clearing and the interbank automated clearing house","summary":"Create domestic transfer","tags":["RETAIL"],"parameters":[{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"standardEntryClassCode":"CIE","companyEntryDescription":"string","debitAccountId":"string","transactionAmount":0.0,"requiredCreditValueDate":"2024-01-01","beneficiaryId":"/v1.0.0/party/us/customers/{customerId}/beneficiaries","transactionCode":0.0,"beneficiaryOtherId":"string","accountWithBankClearingCode":"string","beneficiaryAccountId":"string","beneficiaryName":"string","narrative":"string","paymentCurrency":"string","paymentOrderProductId":"string","recordStatus":"string"}},"responses":{"200":"UsDomesticTransferResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"POST","path":"/order/us/payments/standingOrders/{accountId}","fullPath":"/api/v2.1.0/order/us/payments/standingOrders/{accountId}","operationId":"createUsRecurringTransfers","name":"API to create a recurring account transfers","summary":"Create recurring transfer","tags":["RETAIL"],"parameters":[{"name":"accountId","in":"path","type":"string","required":true,"description":"Identifier of the account. Often referred to as the account number, yet for consistency this is always referred to as accountId. Accepts both IBAN & BBAN"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"beneficiaries":[{}],"currentFrequency":"string","standardEntryClassCode":"CIE","startDate":"2024-01-01","companyEntryDescription":"string","currentEndDate":"2024-01-01","currentAmountBalance":0.0,"beneficiaryId":"/v1.0.0/party/us/customers/{customerId}/beneficiaries","transactionCode":0.0,"beneficiaryOtherId":"string","accountWithBankClearingCode":"string","beneficiaryAccountId":"string","paymentDetail":"string","recordStatus":"string","currNo":"string"}},"responses":{"200":"UsRecurringTransfersResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"POST","path":"/order/us/payments/directDebits/{accountId}","fullPath":"/api/v2.1.0/order/us/payments/directDebits/{accountId}","operationId":"createUsDirectDebits","name":"Create direct debit instructions for repayment of loans or bill payment through external accounts","summary":"Create direct debit instruction","tags":["RETAIL"],"parameters":[{"name":"accountId","in":"path","type":"string","required":true,"description":"Identifier of the account. Often referred to as the account number, yet for consistency this is always referred to as accountId. Accepts both IBAN & BBAN"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"displayName":"string","directDebitParameterId":"string","serviceClassCode":0.0,"standardEntryClassCode":"PPD","debitAccountType":"string","debitBankClearingCode":"string","destinationAccountId":"string","debitorName":"string","frequency":"string","paymentDetail":"string","currencyMarket":"string","terminationDate":"2024-01-01","direction":"string","standAloneDdi":"string","standaloneAmount":0.0}},"responses":{"200":"UsDirectDebitsResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/order/us/payments/directDebits","fullPath":"/api/v2.1.0/order/us/payments/directDebits","operationId":"getUsDirectDebits","name":"Retrieve the list of direct debits initiated for repayment of bills or loans from external accounts","summary":"Retrieve direct debits setup for an account","tags":["RETAIL"],"parameters":[{"name":"customerId","in":"query","type":"string","required":false,"description":"Identifier of the customer"},{"name":"directDebitParameterId","in":"query","type":"string","required":false,"description":"Reference to the parameter which holds details relating to clearing accounts, number of days before which the claim has to be submitted or resubmitted"},{"name":"frequency","in":"query","type":"string","required":false,"description":"Specifies the frequency in which the payment application(periodic payments) execute the payment instruction."},{"name":"accountId","in":"query","type":"string","required":false,"description":"Identifier of the account. Often referred to as the account number, yet for consistency this is always referred to as accountId. Accepts both IBAN & BBAN"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"UsDirectDebitsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/order/us/payments/standingOrders","fullPath":"/api/v2.1.0/order/us/payments/standingOrders","operationId":"getUsRecurringTransfers","name":"Retrieve recurring payments setup for account transfers and bill payments","summary":"Get recurring transfer details","tags":["RETAIL"],"parameters":[{"name":"orderingCustomerId","in":"query","type":"string","required":false,"description":"Indicates the customer id for the ordering customer"},{"name":"paymentOrderProductName","in":"query","type":"string","required":false,"description":"Indicates the name of payment order product "},{"name":"accountId","in":"query","type":"string","required":false,"description":"Identifier of the account. Often referred to as the account number, yet for consistency this is always referred to as accountId. Accepts both IBAN & BBAN"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"UsRecurringTransfersResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"POST","path":"/order/us/payments/wireTransfers/simulate","fullPath":"/api/v2.1.0/order/us/payments/wireTransfers/simulate","operationId":"simulateFedwireCTR","name":"Validate payment order transaction to verify the information provided and to retrieve the applicable charges","summary":"Validate payment order transaction ","tags":["RETAIL"],"parameters":[{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"orderingCustomerAddressLines":[{}],"beneficiaryInstituteAddressLines":[{}],"beneficiaryAddressLines":[{}],"intermediaryFiNameAddressLines":[{}],"OriginatorToBeneficiaryLines":[{}],"receiverFiAndIntermediaryFiLines":[{}],"adviceInformation":[{}],"InformationLines":[{}],"charges":[{}],"overrides":[{}],"paymentPriority":"/v1.0.0/reference/lookups?virtualTableName=PAYMENT.SERVICE.LEVEL.CODE","orderingCustomerId":"string","debitAccountId":"string","schedulePaymentAmount":0.0,"debitValueDate":"2024-01-01"}},"responses":{"200":"FedwireCTRResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/order/us/payments/paymentStatus","fullPath":"/api/v2.1.0/order/us/payments/paymentStatus","operationId":"getUsPaymentsStatus","name":"Retrieve payment status and transaction history for an account along with beneficiary details and beneficiary status","summary":"Retrieve payment history","tags":["RETAIL"],"parameters":[{"name":"fromDate","in":"query","type":"string","required":false,"description":"Indicates the business date from when the balance reservation event is active."},{"name":"status","in":"query","type":"string","required":false,"description":"The status of the early maturity request"},{"name":"orderingCustomerId","in":"query","type":"string","required":false,"description":"Indicates the customer id for the ordering customer"},{"name":"debitAccountId","in":"query","type":"string","required":false,"description":"Indicates the debit account number of the payment or transaction."},{"name":"paymentOrderId","in":"query","type":"string","required":false,"description":"The unique reference number of payment"},{"name":"transactionReference","in":"query","type":"string","required":false,"description":"Contains the identifier for the transaction in the core system"},{"name":"paymentStatus","in":"query","type":"string","required":false,"description":"Describes the current status of the payment order in the payment system"},{"name":"toDate","in":"query","type":"string","required":false,"description":"Indicates the business date until when the balance reservation event is active."},{"name":"beneficiaryId","in":"query","type":"string","required":false,"description":"Indicates the reference of the financial institution that allows access to the beneficiary information"},{"name":"beneficiaryAccountId","in":"query","type":"string","required":false,"description":"Unique account identifier of the beneficiary account number."},{"name":"direction","in":"query","type":"string","required":false,"description":"Indicates the direction of the Direct debit claim for which mandate is received. The claim can be 'Outward' i.e. Claim is sent to the other bank or 'Inward'  i.e. other bank submit their claim to debi"},{"name":"paymentOrderProductId","in":"query","type":"string","required":false,"description":"Indicates the payment order product for which payment is initiated"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"UsPaymentsStatusResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"POST","path":"/order/us/payments/microDeposits","fullPath":"/api/v2.1.0/order/us/payments/microDeposits","operationId":"createUsACHBatchMicroDeposits","name":"Create a microdeposit batch to validate external account for a new beneficiary added by customer","summary":"Create a microdeposit batch to validate external account","tags":["RETAIL"],"parameters":[{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"entryDetails":[{}],"accountType":"string","recordStatus":"string","currNo":"string","inputter":"string","dateTime":"string","authoriser":"string","companyId":"string","deptCOde":"string","auditorCode":"string","auditTimeDate":"string"}},"responses":{"200":"UsACHBatchMicroDepositsResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"POST","path":"/order/us/payments/directDebits/achDebits","fullPath":"/api/v2.1.0/order/us/payments/directDebits/achDebits","operationId":"createUsACHBatchAchDebits","name":"Request payment from external account through online channels. The request will be processed through ACH clearing and the interbank automated clearing house","summary":"Request debit from external account","tags":["RETAIL"],"parameters":[{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"overrides":[{}],"accountType":"string","effectiveDate":"2024-01-01","orderingCustomerId":"string","creditAccountId":"string","transactionCode":0.0,"amount":0.0,"beneficiaryInstituteRoutingNo":0.0,"debitAccountId":"string","debitorName":"string","frequency":"string","terminationDate":"2024-01-01","paymentMethod":"RECURRING.PAYMENTS","recordStatus":"string","currNo":"string"}},"responses":{"200":"UsACHBatchAchDebitsResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/order/us/payments/customers/{orderingCustomerId}/directDebits/achDebits","fullPath":"/api/v2.1.0/order/us/payments/customers/{orderingCustomerId}/directDebits/achDebits","operationId":"getUsACHBatchAchDebits","name":"Retrieve list of customer initiated debit request to external accounts processed through ACH clearing and the interbank automated clearing house","summary":"Retrieve list of customer initiated debit request to external accounts","tags":["RETAIL"],"parameters":[{"name":"orderingCustomerId","in":"path","type":"string","required":true,"description":"Indicates the customer id for the ordering customer"},{"name":"effectiveDate","in":"query","type":"string","required":false,"description":"Contains the identifier for the transaction date. Dates are expected in \u00e2\u20ac\u02dcYYYYMMDD\u00e2\u20ac\u2122 format"},{"name":"creditAccountId","in":"query","type":"string","required":false,"description":"Credit account identifier of the payment or transaction"},{"name":"transactionCode","in":"query","type":"string","required":false,"description":"Identifies the system internal transaction code applicable to the transaction"},{"name":"amount","in":"query","type":"string","required":false,"description":"This is the payment amount"},{"name":"beneficiaryInstituteRoutingNo","in":"query","type":"string","required":false,"description":"Routing number of DDA number of the Financial institution where the beneficiary account exists"},{"name":"debitAccountId","in":"query","type":"string","required":false,"description":"Indicates the debit account number of the payment or transaction."},{"name":"debitorName","in":"query","type":"string","required":false,"description":"The name of the customer who owns the destination account or the debit account used to collect payments"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"UsACHBatchAchDebitsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}}]},{"key":"order-us-payments-service-v3.0.0","title":"US Model Bank Payment services","version":"v3.0.0","description":"API to create ACH and Wire payments, standing orders, Automatic debit instructions, place holds on account, stop checks","endpointCount":21,"endpoints":[{"method":"POST","path":"/order/us/payments/escrows","fullPath":"/api/v3.0.0/order/us/payments/escrows","operationId":"createEscrowAdhocDeposit","name":"Initiates an escrow payment transaction","summary":"Escrow payment","tags":["RETAIL"],"parameters":[{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"overrideDetails":[{}],"creditAccountId":"@ref:product-accountOperationalDate-service-v1.0.0","creditValueDate":"2024-01-01","creditCurrencyId":"string","creditAmount":0.0,"debitAccountId":"@ref:product-accountOperationalDate-service-v1.0.0","debitValueDate":"2024-01-01","debitCurrencyId":"string","debitAmount":0.0,"treasuryRate":0.0,"processingDate":"2024-01-01","customerRate":0.0,"customerSpread":0.0,"recordStatus":"string","currNo":0.0}},"responses":{"200":"EscrowAdhocDepositResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"POST","path":"/order/us/accounts/{accountId}/reservedFunds","fullPath":"/api/v3.0.0/order/us/accounts/{accountId}/reservedFunds","operationId":"createAccountBalanceHold","name":"Create a hold transaction to lock the funds in an account","summary":"Create account hold","tags":["RETAIL"],"parameters":[{"name":"accountId","in":"path","type":"string","required":true,"description":"Identifier of the account. Often referred to as the account number, yet for consistency this is always referred to as accountId. Accepts both IBAN & BBAN"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"overrides":[{}],"holdTypeId":"/v1.0.0/reference/us/accountHoldTypes","description":"string","fromDate":"2024-01-01","toDate":"2024-01-01","lockedAmount":0.0,"blockPriorityId":"string","recordStatus":"string","currNo":0.0,"inputter":"string","dateTime":0.0,"authoriser":"string","companyId":"@ref:reference-companies-service-v1.0.0","deptCode":"@ref:reference-accountOfficers-service-v1.0.0","auditorCode":"string"}},"responses":{"200":"AccountBalanceHoldResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/order/us/accounts/reservedFunds/{holdId}","fullPath":"/api/v3.0.0/order/us/accounts/reservedFunds/{holdId}","operationId":"getAccountBalanceHold","name":"Retrieves information of the amount locked, lock type and the validity for a hold transaction","summary":"Retrieve hold funds detail","tags":["RETAIL"],"parameters":[{"name":"holdId","in":"path","type":"string","required":true,"description":"The transaction reference through which the specified amount in the transaction has been locked in an account"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"AccountBalanceHoldResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/order/us/payments/holds/{holdId}","fullPath":"/api/v3.0.0/order/us/payments/holds/{holdId}","operationId":"updateAccountBalanceHold","name":"Update amount or validity date of an existing hold","summary":"Update existing hold","tags":["RETAIL"],"parameters":[{"name":"holdId","in":"path","type":"string","required":true,"description":"The transaction reference through which the specified amount in the transaction has been locked in an account"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"overrides":[{}],"holdTypeId":"/v1.0.0/reference/us/accountHoldTypes","description":"string","fromDate":"2024-01-01","toDate":"2024-01-01","lockedAmount":0.0,"blockPriorityId":"string","recordStatus":"string","currNo":0.0,"inputter":"string","dateTime":0.0,"authoriser":"string","companyId":"@ref:reference-companies-service-v1.0.0","deptCode":"@ref:reference-accountOfficers-service-v1.0.0","auditorCode":"string"}},"responses":{"200":"AccountBalanceHoldResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/order/us/payments/accounts/{accountId}/holdSummary","fullPath":"/api/v3.0.0/order/us/payments/accounts/{accountId}/holdSummary","operationId":"getAccountHoldDetails","name":"Retrieves details of all holds placed on an account","summary":"Get hold summary","tags":["RETAIL"],"parameters":[{"name":"accountId","in":"path","type":"string","required":true,"description":"Identifier of the account. Often referred to as the account number, yet for consistency this is always referred to as accountId. Accepts both IBAN & BBAN"},{"name":"holdTypeId","in":"query","type":"string","required":false,"description":"Purpose or the type of hold placed on the account  The available list of hold types can be retrieved through getHoldTypes"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"AccountHoldDetailsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"POST","path":"/order/us/payments/transactionStops","fullPath":"/api/v3.0.0/order/us/payments/transactionStops","operationId":"createUsTransactionStop","name":"Create transaction stop instruction to capture instructions to stop a payment based on the payment type, recipient or amount","summary":"Create transaction stop instruction","tags":["RETAIL"],"parameters":[{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"stopCondition":[{}],"accountId":"@ref:product-accountOperationalDate-service-v1.0.0","stopTypeId":"string","transactionChannel":"string","stopInstructionChannel":"BANK","stopReason":"CHKDES","issueDate":"string","replacementCheck":"string","replacementCheckIssueDate":"string","expiryDate":"string","waiveCharge":"string","transactionStopStatus":"ACTIVE","suppressNotice":"string","cancelInstruction":"YES","override":"string"}},"responses":{"200":"UsTransactionStopResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"DELETE","path":"/order/us/payments/transactionStops/{stopInstructionId}","fullPath":"/api/v3.0.0/order/us/payments/transactionStops/{stopInstructionId}","operationId":"deleteUsTransactionStop","name":"Deletes a transaction stop instruction capturing with instructions to stop a payment","summary":"Delete transaction stop","tags":["RETAIL"],"parameters":[{"name":"stopInstructionId","in":"path","type":"string","required":true,"description":"ID of stop instruction"},{"name":"payload","in":"body","type":"object","required":false,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}}},"responses":{"200":"UsTransactionStopResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"POST","path":"/order/us/payments/wireTransfers","fullPath":"/api/v3.0.0/order/us/payments/wireTransfers","operationId":"createFedwireCTR","name":"Creates an instant payment through  fedwire of payment type CTR, customer transfer","summary":"Posts a customer transfer through wire payment","tags":["RETAIL"],"parameters":[{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"orderingCustomerAddressLines":[{}],"beneficiaryInstituteAddressLines":[{}],"beneficiaryAddressLines":[{}],"intermediaryFiNameAddressLines":[{}],"OriginatorToBeneficiaryLines":[{}],"receiverFiAndIntermediaryFiLines":[{}],"adviceInformation":[{}],"InformationLines":[{}],"charges":[{}],"overrides":[{}],"paymentPriority":"/v1.0.0/reference/lookups?virtualTableName=PAYMENT.SERVICE.LEVEL.CODE","orderingCustomerId":"string","debitAccountId":"string","schedulePaymentAmount":0.0,"debitValueDate":"2024-01-01"}},"responses":{"200":"FedwireCTRResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"POST","path":"/order/us/payments/paymentOrders","fullPath":"/api/v3.0.0/order/us/payments/paymentOrders","operationId":"createUsDomesticTransfer","name":"Create one-time domestic account transfers and bill payments through ACH Clearing and the interbank automated clearing house","summary":"Create domestic transfer","tags":["RETAIL"],"parameters":[{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"standardEntryClassCode":"CIE","companyEntryDescription":"string","debitAccountId":"string","transactionAmount":0.0,"requiredCreditValueDate":"2024-01-01","beneficiaryId":"/v1.0.0/party/us/customers/{customerId}/beneficiaries","transactionCode":0.0,"beneficiaryOtherId":"string","accountWithBankClearingCode":"string","beneficiaryAccountId":"string","beneficiaryName":"string","narrative":"string","paymentCurrency":"string","paymentOrderProductId":"string","recordStatus":"string"}},"responses":{"200":"UsDomesticTransferResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"POST","path":"/order/us/payments/standingOrders/{accountId}","fullPath":"/api/v3.0.0/order/us/payments/standingOrders/{accountId}","operationId":"createUsRecurringTransfers","name":"Create a recurring account transfer","summary":"Create recurring transfer","tags":["RETAIL"],"parameters":[{"name":"accountId","in":"path","type":"string","required":true,"description":"Identifier of the account. Often referred to as the account number, yet for consistency this is always referred to as accountId. Accepts both IBAN & BBAN"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"beneficiaries":[{}],"currentFrequency":"string","standardEntryClassCode":"CIE","startDate":"2024-01-01","companyEntryDescription":"string","currentEndDate":"2024-01-01","currentAmountBalance":0.0,"beneficiaryId":"/v1.0.0/party/us/customers/{customerId}/beneficiaries","transactionCode":0.0,"beneficiaryOtherId":"string","accountWithBankClearingCode":"string","beneficiaryAccountId":"string","paymentDetail":"string","recordStatus":"string","currNo":"string"}},"responses":{"200":"UsRecurringTransfersResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"POST","path":"/order/us/payments/directDebits/{accountId}","fullPath":"/api/v3.0.0/order/us/payments/directDebits/{accountId}","operationId":"createUsDirectDebits","name":"Create direct debit instructions for repayment of loans or bill payment through external accounts","summary":"Create direct debit instruction","tags":["RETAIL"],"parameters":[{"name":"accountId","in":"path","type":"string","required":true,"description":"Identifier of the account. Often referred to as the account number, yet for consistency this is always referred to as accountId. Accepts both IBAN & BBAN"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"displayName":"string","directDebitParameterId":"string","serviceClassCode":0.0,"standardEntryClassCode":"PPD","debitAccountType":"string","debitBankClearingCode":"string","destinationAccountId":"string","debitorName":"string","frequency":"string","paymentDetail":"string","currencyMarket":"string","terminationDate":"2024-01-01","direction":"string","standAloneDdi":"string","standaloneAmount":0.0}},"responses":{"200":"UsDirectDebitsResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/order/us/payments/directDebits","fullPath":"/api/v3.0.0/order/us/payments/directDebits","operationId":"getUsDirectDebits","name":"Retrieve the list of direct debits initiated for repayment of bills or loans from external accounts","summary":"Retrieve direct debits setup for an account","tags":["RETAIL"],"parameters":[{"name":"customerId","in":"query","type":"string","required":false,"description":"Identifier of the customer"},{"name":"directDebitParameterId","in":"query","type":"string","required":false,"description":"Reference to the parameter which holds details relating to clearing accounts, number of days before which the claim has to be submitted or resubmitted"},{"name":"frequency","in":"query","type":"string","required":false,"description":"Specifies the frequency in which the payment application(periodic payments) execute the payment instruction."},{"name":"accountId","in":"query","type":"string","required":false,"description":"Identifier of the account. Often referred to as the account number, yet for consistency this is always referred to as accountId. Accepts both IBAN & BBAN"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"UsDirectDebitsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/order/us/payments/standingOrders","fullPath":"/api/v3.0.0/order/us/payments/standingOrders","operationId":"getUsRecurringTransfers","name":"Retrieve recurring payments setup for account transfers and bill payments","summary":"Get recurring transfer details","tags":["RETAIL"],"parameters":[{"name":"orderingCustomerId","in":"query","type":"string","required":false,"description":"Indicates the customer id for the ordering customer"},{"name":"paymentOrderProductName","in":"query","type":"string","required":false,"description":"Indicates the name of payment order product "},{"name":"accountId","in":"query","type":"string","required":false,"description":"Identifier of the account. Often referred to as the account number, yet for consistency this is always referred to as accountId. Accepts both IBAN & BBAN"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"UsRecurringTransfersResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"POST","path":"/order/us/payments/wireTransfers/simulate","fullPath":"/api/v3.0.0/order/us/payments/wireTransfers/simulate","operationId":"simulateFedwireCTR","name":"Validate payment order transaction to verify the information provided and to retrieve the applicable charges","summary":"Validate payment order transaction ","tags":["RETAIL"],"parameters":[{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"orderingCustomerAddressLines":[{}],"beneficiaryInstituteAddressLines":[{}],"beneficiaryAddressLines":[{}],"intermediaryFiNameAddressLines":[{}],"OriginatorToBeneficiaryLines":[{}],"receiverFiAndIntermediaryFiLines":[{}],"adviceInformation":[{}],"InformationLines":[{}],"charges":[{}],"overrides":[{}],"paymentPriority":"/v1.0.0/reference/lookups?virtualTableName=PAYMENT.SERVICE.LEVEL.CODE","orderingCustomerId":"string","debitAccountId":"string","schedulePaymentAmount":0.0,"debitValueDate":"2024-01-01"}},"responses":{"200":"FedwireCTRResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/order/us/payments/paymentStatus","fullPath":"/api/v3.0.0/order/us/payments/paymentStatus","operationId":"getUsPaymentsStatus","name":"Retrieve payment status and transaction history for an account along with beneficiary details and beneficiary status","summary":"Retrieve payment history","tags":["RETAIL"],"parameters":[{"name":"fromDate","in":"query","type":"string","required":false,"description":"Indicates the business date from when the balance reservation event is active."},{"name":"status","in":"query","type":"string","required":false,"description":"The status of the early maturity request"},{"name":"orderingCustomerId","in":"query","type":"string","required":false,"description":"Indicates the customer id for the ordering customer"},{"name":"debitAccountId","in":"query","type":"string","required":false,"description":"Indicates the debit account number of the payment or transaction."},{"name":"paymentOrderId","in":"query","type":"string","required":false,"description":"The unique reference number of payment"},{"name":"transactionReference","in":"query","type":"string","required":false,"description":"Contains the identifier for the transaction in the core system"},{"name":"paymentStatus","in":"query","type":"string","required":false,"description":"Describes the current status of the payment order in the payment system"},{"name":"toDate","in":"query","type":"string","required":false,"description":"Indicates the business date until when the balance reservation event is active."},{"name":"beneficiaryId","in":"query","type":"string","required":false,"description":"Indicates the reference of the financial institution that allows access to the beneficiary information"},{"name":"beneficiaryAccountId","in":"query","type":"string","required":false,"description":"Unique account identifier of the beneficiary account number."},{"name":"direction","in":"query","type":"string","required":false,"description":"Indicates the direction of the Direct debit claim for which mandate is received. The claim can be 'Outward' i.e. Claim is sent to the other bank or 'Inward'  i.e. other bank submit their claim to debi"},{"name":"paymentOrderProductId","in":"query","type":"string","required":false,"description":"Indicates the payment order product for which payment is initiated"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"UsPaymentsStatusResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"POST","path":"/order/us/payments/microDeposits","fullPath":"/api/v3.0.0/order/us/payments/microDeposits","operationId":"createUsACHBatchMicroDeposits","name":"Create a microdeposit batch to validate external account for a new beneficiary added by customer","summary":"Create a microdeposit batch to validate external account","tags":["RETAIL"],"parameters":[{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"entryDetails":[{}],"accountType":"string","recordStatus":"string","currNo":"string","inputter":"string","dateTime":"string","authoriser":"string","companyId":"string","deptCOde":"string","auditorCode":"string","auditTimeDate":"string","extensionData":{}}},"responses":{"200":"UsACHBatchMicroDepositsResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"POST","path":"/order/us/payments/directDebits/achDebits","fullPath":"/api/v3.0.0/order/us/payments/directDebits/achDebits","operationId":"createUsACHBatchAchDebits","name":"Request payment from external account through online channels. The request will be processed through ACH clearing and the interbank automated clearing house","summary":"Request debit from external account","tags":["RETAIL"],"parameters":[{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"overrides":[{}],"accountType":"string","effectiveDate":"2024-01-01","orderingCustomerId":"string","creditAccountId":"string","transactionCode":0.0,"amount":0.0,"beneficiaryInstituteRoutingNo":0.0,"debitAccountId":"string","debitorName":"string","frequency":"string","terminationDate":"2024-01-01","paymentMethod":"RECURRING.PAYMENTS","recordStatus":"string","currNo":"string"}},"responses":{"200":"UsACHBatchAchDebitsResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/order/us/payments/customers/{orderingCustomerId}/directDebits/achDebits","fullPath":"/api/v3.0.0/order/us/payments/customers/{orderingCustomerId}/directDebits/achDebits","operationId":"getUsACHBatchAchDebits","name":"Retrieve list of customer initiated debit request to external accounts processed through ACH clearing and the interbank automated clearing house","summary":"Retrieve list of customer initiated debit request to external accounts","tags":["RETAIL"],"parameters":[{"name":"orderingCustomerId","in":"path","type":"string","required":true,"description":"Indicates the customer id for the ordering customer"},{"name":"effectiveDate","in":"query","type":"string","required":false,"description":"Contains the identifier for the transaction date. Dates are expected in \u00e2\u20ac\u02dcYYYYMMDD\u00e2\u20ac\u2122 format"},{"name":"creditAccountId","in":"query","type":"string","required":false,"description":"Credit account identifier of the payment or transaction"},{"name":"transactionCode","in":"query","type":"string","required":false,"description":"Identifies the system internal transaction code applicable to the transaction"},{"name":"amount","in":"query","type":"string","required":false,"description":"This is the payment amount"},{"name":"beneficiaryInstituteRoutingNo","in":"query","type":"string","required":false,"description":"Routing number of DDA number of the Financial institution where the beneficiary account exists"},{"name":"debitAccountId","in":"query","type":"string","required":false,"description":"Indicates the debit account number of the payment or transaction."},{"name":"debitorName","in":"query","type":"string","required":false,"description":"The name of the customer who owns the destination account or the debit account used to collect payments"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"UsACHBatchAchDebitsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"POST","path":"/order/us/payments/wireTransfers/cancel/{transactionReference}","fullPath":"/api/v3.0.0/order/us/payments/wireTransfers/cancel/{transactionReference}","operationId":"reverseUsWireTransfer","name":"Request can be sent to initiate cancellation for a wire transfer within 30 minutes of submitting the wire payment","summary":"Initiate request to cancel wire transfer","tags":["RETAIL"],"parameters":[{"name":"transactionReference","in":"path","type":"string","required":true,"description":"Contains the identifier for the transaction in the core system"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"overrideDetails":[{}],"inputter":[{}],"dateTime":[{}],"transactionReference":"string","processingDate":"2024-01-01","statusCode":0.0,"sendersReference":"string","orderingAccount":"string","orderingName":"string","debitCustomerId":0.0,"recordStatus":"string","currNo":0.0,"authoriser":"string","companyCode":"string","deptCode":"string"}},"responses":{"200":"UsWireTransferResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"POST","path":"/order/us/payments/swiftTransfers/cancel/{transactionReference}","fullPath":"/api/v3.0.0/order/us/payments/swiftTransfers/cancel/{transactionReference}","operationId":"cancelSwiftTransaction","name":"Request to cancel international payments initiated within 30 minutes of submitting the payment","summary":"Initiate request to cancel international transfers","tags":["RETAIL"],"parameters":[{"name":"transactionReference","in":"path","type":"string","required":true,"description":"Contains the identifier for the transaction in the core system"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"inputter":[{}],"dateTime":[{}],"companyId":"string","transactionReference":"string","amount":0.0,"currencyId":"string","paymentMsgSentDate":"2024-01-01","outputChannel":"string","statusCode":"string","recordStatus":"string","currNo":0.0,"authoriser":"string","companyCode":"string","deptCode":"string","auditorCode":"string"}},"responses":{"200":"SwiftTransactionResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/order/us/payments/achEntry/{achEntryId}/achEntryStatus","fullPath":"/api/v3.0.0/order/us/payments/achEntry/{achEntryId}/achEntryStatus","operationId":"updateAchNOCEntriesStatus","name":"Allows to update the status to processed ","summary":"Allows to update the status to processed","tags":["RETAIL"],"parameters":[{"name":"achEntryId","in":"path","type":"string","required":true,"description":""},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"achEntryStatus":"PROCESSED","paymentOrderId":"string","transactionReference":"string","executionDate":"string","deliveryByDate":"string","creditDebitIndicator":"string","beneficiaryInstituteRoutingNo":"string","beneficiaryName":"string","beneficiaryOtherId":"string","accountId":"string","paymentAmount":"string","standardEntryClassCode":"string","extensionData":{}}},"responses":{"200":"AchNOCEntriesStatusResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}}]},{"key":"order-us-payments-service-v4.0.0","title":"US Model Bank Payment services","version":"v4.0.0","description":"API to create ACH and Wire payments, standing orders, Automatic debit instructions, place holds on account, stop checks","endpointCount":21,"endpoints":[{"method":"POST","path":"/order/us/payments/escrows","fullPath":"/api/v4.0.0/order/us/payments/escrows","operationId":"createEscrowAdhocDeposit","name":"Initiates an escrow payment transaction","summary":"Escrow payment","tags":["RETAIL"],"parameters":[{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"overrideDetails":[{}],"creditAccountId":"@ref:product-accountOperationalDate-service-v1.0.0","creditValueDate":"2024-01-01","creditCurrencyId":"string","creditAmount":0.0,"debitAccountId":"@ref:product-accountOperationalDate-service-v1.0.0","debitValueDate":"2024-01-01","debitCurrencyId":"string","debitAmount":0.0,"treasuryRate":0.0,"processingDate":"2024-01-01","customerRate":0.0,"customerSpread":0.0,"recordStatus":"string","currNo":0.0}},"responses":{"200":"EscrowAdhocDepositResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"POST","path":"/order/us/accounts/{accountId}/reservedFunds","fullPath":"/api/v4.0.0/order/us/accounts/{accountId}/reservedFunds","operationId":"createAccountBalanceHold","name":"Create a hold transaction to lock the funds in an account","summary":"Create account hold","tags":["RETAIL"],"parameters":[{"name":"accountId","in":"path","type":"string","required":true,"description":"Identifier of the account. Often referred to as the account number, yet for consistency this is always referred to as accountId. Accepts both IBAN & BBAN"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"overrides":[{}],"holdTypeId":"/v1.0.0/reference/us/accountHoldTypes","description":"string","fromDate":"2024-01-01","toDate":"2024-01-01","lockedAmount":0.0,"blockPriorityId":"string","recordStatus":"string","currNo":0.0,"inputter":"string","dateTime":0.0,"authoriser":"string","companyId":"@ref:reference-companies-service-v1.0.0","deptCode":"@ref:reference-accountOfficers-service-v1.0.0","auditorCode":"string"}},"responses":{"200":"AccountBalanceHoldResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/order/us/accounts/reservedFunds/{holdId}","fullPath":"/api/v4.0.0/order/us/accounts/reservedFunds/{holdId}","operationId":"getAccountBalanceHold","name":"Retrieves information of the amount locked, lock type and the validity for a hold transaction","summary":"Retrieve hold funds detail","tags":["RETAIL"],"parameters":[{"name":"holdId","in":"path","type":"string","required":true,"description":"The transaction reference through which the specified amount in the transaction has been locked in an account"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"AccountBalanceHoldResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/order/us/payments/holds/{holdId}","fullPath":"/api/v4.0.0/order/us/payments/holds/{holdId}","operationId":"updateAccountBalanceHold","name":"Update amount or validity date of an existing hold","summary":"Update existing hold","tags":["RETAIL"],"parameters":[{"name":"holdId","in":"path","type":"string","required":true,"description":"The transaction reference through which the specified amount in the transaction has been locked in an account"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"overrides":[{}],"holdTypeId":"/v1.0.0/reference/us/accountHoldTypes","description":"string","fromDate":"2024-01-01","toDate":"2024-01-01","lockedAmount":0.0,"blockPriorityId":"string","recordStatus":"string","currNo":0.0,"inputter":"string","dateTime":0.0,"authoriser":"string","companyId":"@ref:reference-companies-service-v1.0.0","deptCode":"@ref:reference-accountOfficers-service-v1.0.0","auditorCode":"string"}},"responses":{"200":"AccountBalanceHoldResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/order/us/payments/accounts/{accountId}/holdSummary","fullPath":"/api/v4.0.0/order/us/payments/accounts/{accountId}/holdSummary","operationId":"getAccountHoldDetails","name":"Retrieves details of all holds placed on an account","summary":"Get hold summary","tags":["RETAIL"],"parameters":[{"name":"accountId","in":"path","type":"string","required":true,"description":"Identifier of the account. Often referred to as the account number, yet for consistency this is always referred to as accountId. Accepts both IBAN & BBAN"},{"name":"holdTypeId","in":"query","type":"string","required":false,"description":"Purpose or the type of hold placed on the account  The available list of hold types can be retrieved through getHoldTypes"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"AccountHoldDetailsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"POST","path":"/order/us/payments/transactionStops","fullPath":"/api/v4.0.0/order/us/payments/transactionStops","operationId":"createUsTransactionStop","name":"Create transaction stop instruction to capture instructions to stop a payment based on the payment type, recipient or amount","summary":"Create transaction stop instruction","tags":["RETAIL"],"parameters":[{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"stopCondition":[{}],"accountId":"@ref:product-accountOperationalDate-service-v1.0.0","stopTypeId":"string","transactionChannel":"string","stopInstructionChannel":"BANK","stopReason":"CHKDES","issueDate":"string","replacementCheck":"string","replacementCheckIssueDate":"string","expiryDate":"string","waiveCharge":"string","transactionStopStatus":"ACTIVE","suppressNotice":"string","cancelInstruction":"YES","override":"string"}},"responses":{"200":"UsTransactionStopResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"DELETE","path":"/order/us/payments/transactionStops/{stopInstructionId}","fullPath":"/api/v4.0.0/order/us/payments/transactionStops/{stopInstructionId}","operationId":"deleteUsTransactionStop","name":"Deletes a transaction stop instruction capturing with instructions to stop a payment","summary":"Delete transaction stop","tags":["RETAIL"],"parameters":[{"name":"stopInstructionId","in":"path","type":"string","required":true,"description":"ID of stop instruction"},{"name":"payload","in":"body","type":"object","required":false,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}}},"responses":{"200":"UsTransactionStopResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"POST","path":"/order/us/payments/wireTransfers","fullPath":"/api/v4.0.0/order/us/payments/wireTransfers","operationId":"createFedwireCTR","name":"Creates an instant payment through  fedwire of payment type CTR, customer transfer","summary":"Posts a customer transfer through wire payment","tags":["RETAIL"],"parameters":[{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"orderingCustomerAddressLines":[{}],"beneficiaryInstituteAddressLines":[{}],"beneficiaryAddressLines":[{}],"intermediaryFiNameAddressLines":[{}],"OriginatorToBeneficiaryLines":[{}],"receiverFiAndIntermediaryFiLines":[{}],"adviceInformation":[{}],"InformationLines":[{}],"charges":[{}],"overrides":[{}],"paymentPriority":"/v1.0.0/reference/lookups?virtualTableName=PAYMENT.SERVICE.LEVEL.CODE","orderingCustomerId":"string","debitAccountId":"string","schedulePaymentAmount":0.0,"debitValueDate":"2024-01-01"}},"responses":{"200":"FedwireCTRResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"POST","path":"/order/us/payments/paymentOrders","fullPath":"/api/v4.0.0/order/us/payments/paymentOrders","operationId":"createUsDomesticTransfer","name":"Create one-time domestic account transfers and bill payments through ACH Clearing and the interbank automated clearing house","summary":"Create domestic transfer","tags":["RETAIL"],"parameters":[{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"standardEntryClassCode":"CIE","companyEntryDescription":"string","debitAccountId":"string","transactionAmount":0.0,"requiredCreditValueDate":"2024-01-01","beneficiaryId":"/v1.0.0/party/us/customers/{customerId}/beneficiaries","transactionCode":0.0,"beneficiaryOtherId":"string","accountWithBankClearingCode":"string","beneficiaryAccountId":"string","beneficiaryName":"string","narrative":"string","paymentCurrency":"string","paymentOrderProductId":"string","recordStatus":"string"}},"responses":{"200":"UsDomesticTransferResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"POST","path":"/order/us/payments/standingOrders/{accountId}","fullPath":"/api/v4.0.0/order/us/payments/standingOrders/{accountId}","operationId":"createUsRecurringTransfers","name":"Create a recurring account transfer","summary":"Create recurring transfer","tags":["RETAIL"],"parameters":[{"name":"accountId","in":"path","type":"string","required":true,"description":"Identifier of the account. Often referred to as the account number, yet for consistency this is always referred to as accountId. Accepts both IBAN & BBAN"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"beneficiaries":[{}],"currentFrequency":"string","standardEntryClassCode":"CIE","startDate":"2024-01-01","companyEntryDescription":"string","currentEndDate":"2024-01-01","currentAmountBalance":0.0,"beneficiaryId":"/v1.0.0/party/us/customers/{customerId}/beneficiaries","transactionCode":0.0,"beneficiaryOtherId":"string","accountWithBankClearingCode":"string","beneficiaryAccountId":"string","paymentDetail":"string","recordStatus":"string","currNo":"string"}},"responses":{"200":"UsRecurringTransfersResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"POST","path":"/order/us/payments/directDebits/{accountId}","fullPath":"/api/v4.0.0/order/us/payments/directDebits/{accountId}","operationId":"createUsDirectDebits","name":"Create direct debit instructions for repayment of loans or bill payment through external accounts","summary":"Create direct debit instruction","tags":["RETAIL"],"parameters":[{"name":"accountId","in":"path","type":"string","required":true,"description":"Identifier of the account. Often referred to as the account number, yet for consistency this is always referred to as accountId. Accepts both IBAN & BBAN"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"displayName":"string","directDebitParameterId":"string","serviceClassCode":0.0,"standardEntryClassCode":"PPD","debitAccountType":"string","debitBankClearingCode":"string","destinationAccountId":"string","debitorName":"string","frequency":"string","paymentDetail":"string","currencyMarket":"string","terminationDate":"2024-01-01","direction":"string","standAloneDdi":"string","standaloneAmount":0.0}},"responses":{"200":"UsDirectDebitsResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/order/us/payments/directDebits","fullPath":"/api/v4.0.0/order/us/payments/directDebits","operationId":"getUsDirectDebits","name":"Retrieve the list of direct debits initiated for repayment of bills or loans from external accounts","summary":"Retrieve direct debits setup for an account","tags":["RETAIL"],"parameters":[{"name":"customerId","in":"query","type":"string","required":false,"description":"Identifier of the customer"},{"name":"directDebitParameterId","in":"query","type":"string","required":false,"description":"Reference to the parameter which holds details relating to clearing accounts, number of days before which the claim has to be submitted or resubmitted"},{"name":"frequency","in":"query","type":"string","required":false,"description":"Specifies the frequency in which the payment application(periodic payments) execute the payment instruction."},{"name":"accountId","in":"query","type":"string","required":false,"description":"Identifier of the account. Often referred to as the account number, yet for consistency this is always referred to as accountId. Accepts both IBAN & BBAN"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"UsDirectDebitsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/order/us/payments/standingOrders","fullPath":"/api/v4.0.0/order/us/payments/standingOrders","operationId":"getUsRecurringTransfers","name":"Retrieve recurring payments setup for account transfers and bill payments","summary":"Get recurring transfer details","tags":["RETAIL"],"parameters":[{"name":"orderingCustomerId","in":"query","type":"string","required":false,"description":"Indicates the customer id for the ordering customer"},{"name":"paymentOrderProductName","in":"query","type":"string","required":false,"description":"Indicates the name of payment order product "},{"name":"accountId","in":"query","type":"string","required":false,"description":"Identifier of the account. Often referred to as the account number, yet for consistency this is always referred to as accountId. Accepts both IBAN & BBAN"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"UsRecurringTransfersResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"POST","path":"/order/us/payments/wireTransfers/simulate","fullPath":"/api/v4.0.0/order/us/payments/wireTransfers/simulate","operationId":"simulateFedwireCTR","name":"Validate payment order transaction to verify the information provided and to retrieve the applicable charges","summary":"Validate payment order transaction ","tags":["RETAIL"],"parameters":[{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"orderingCustomerAddressLines":[{}],"beneficiaryInstituteAddressLines":[{}],"beneficiaryAddressLines":[{}],"intermediaryFiNameAddressLines":[{}],"OriginatorToBeneficiaryLines":[{}],"receiverFiAndIntermediaryFiLines":[{}],"adviceInformation":[{}],"InformationLines":[{}],"charges":[{}],"overrides":[{}],"paymentPriority":"/v1.0.0/reference/lookups?virtualTableName=PAYMENT.SERVICE.LEVEL.CODE","orderingCustomerId":"string","debitAccountId":"string","schedulePaymentAmount":0.0,"debitValueDate":"2024-01-01"}},"responses":{"200":"FedwireCTRResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/order/us/payments/paymentStatus","fullPath":"/api/v4.0.0/order/us/payments/paymentStatus","operationId":"getUsPaymentsStatus","name":"Retrieve payment status and transaction history for an account along with beneficiary details and beneficiary status","summary":"Retrieve payment history","tags":["RETAIL"],"parameters":[{"name":"fromDate","in":"query","type":"string","required":false,"description":"Indicates the business date from when the balance reservation event is active."},{"name":"status","in":"query","type":"string","required":false,"description":"The status of the early maturity request"},{"name":"orderingCustomerId","in":"query","type":"string","required":false,"description":"Indicates the customer id for the ordering customer"},{"name":"debitAccountId","in":"query","type":"string","required":false,"description":"Indicates the debit account number of the payment or transaction."},{"name":"paymentOrderId","in":"query","type":"string","required":false,"description":"The unique reference number of payment"},{"name":"transactionReference","in":"query","type":"string","required":false,"description":"Contains the identifier for the transaction in the core system"},{"name":"paymentStatus","in":"query","type":"string","required":false,"description":"Describes the current status of the payment order in the payment system"},{"name":"toDate","in":"query","type":"string","required":false,"description":"Indicates the business date until when the balance reservation event is active."},{"name":"beneficiaryId","in":"query","type":"string","required":false,"description":"Indicates the reference of the financial institution that allows access to the beneficiary information"},{"name":"beneficiaryAccountId","in":"query","type":"string","required":false,"description":"Unique account identifier of the beneficiary account number."},{"name":"direction","in":"query","type":"string","required":false,"description":"Indicates the direction of the Direct debit claim for which mandate is received. The claim can be 'Outward' i.e. Claim is sent to the other bank or 'Inward'  i.e. other bank submit their claim to debi"},{"name":"paymentOrderProductId","in":"query","type":"string","required":false,"description":"Indicates the payment order product for which payment is initiated"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"UsPaymentsStatusResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"POST","path":"/order/us/payments/microDeposits","fullPath":"/api/v4.0.0/order/us/payments/microDeposits","operationId":"createUsACHBatchMicroDeposits","name":"Create a microdeposit batch to validate external account for a new beneficiary added by customer","summary":"Create a microdeposit batch to validate external account","tags":["RETAIL"],"parameters":[{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"entryDetails":[{}],"accountType":"string","recordStatus":"string","currNo":"string","inputter":"string","dateTime":"string","authoriser":"string","companyId":"string","deptCOde":"string","auditorCode":"string","auditTimeDate":"string","extensionData":{}}},"responses":{"200":"UsACHBatchMicroDepositsResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"POST","path":"/order/us/payments/directDebits/achDebits","fullPath":"/api/v4.0.0/order/us/payments/directDebits/achDebits","operationId":"createUsACHBatchAchDebits","name":"Request payment from external account through online channels. The request will be processed through ACH clearing and the interbank automated clearing house","summary":"Request debit from external account","tags":["RETAIL"],"parameters":[{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"overrides":[{}],"accountType":"string","effectiveDate":"2024-01-01","orderingCustomerId":"string","creditAccountId":"string","transactionCode":0.0,"amount":0.0,"beneficiaryInstituteRoutingNo":0.0,"debitAccountId":"string","debitorName":"string","frequency":"string","terminationDate":"2024-01-01","paymentMethod":"RECURRING.PAYMENTS","recordStatus":"string","currNo":"string"}},"responses":{"200":"UsACHBatchAchDebitsResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/order/us/payments/customers/{orderingCustomerId}/directDebits/achDebits","fullPath":"/api/v4.0.0/order/us/payments/customers/{orderingCustomerId}/directDebits/achDebits","operationId":"getUsACHBatchAchDebits","name":"Retrieve list of customer initiated debit request to external accounts processed through ACH clearing and the interbank automated clearing house","summary":"Retrieve list of customer initiated debit request to external accounts","tags":["RETAIL"],"parameters":[{"name":"orderingCustomerId","in":"path","type":"string","required":true,"description":"Indicates the customer id for the ordering customer"},{"name":"effectiveDate","in":"query","type":"string","required":false,"description":"Contains the identifier for the transaction date. Dates are expected in \u00e2\u20ac\u02dcYYYYMMDD\u00e2\u20ac\u2122 format"},{"name":"creditAccountId","in":"query","type":"string","required":false,"description":"Credit account identifier of the payment or transaction"},{"name":"transactionCode","in":"query","type":"string","required":false,"description":"Identifies the system internal transaction code applicable to the transaction"},{"name":"amount","in":"query","type":"string","required":false,"description":"This is the payment amount"},{"name":"beneficiaryInstituteRoutingNo","in":"query","type":"string","required":false,"description":"Routing number of DDA number of the Financial institution where the beneficiary account exists"},{"name":"debitAccountId","in":"query","type":"string","required":false,"description":"Indicates the debit account number of the payment or transaction."},{"name":"debitorName","in":"query","type":"string","required":false,"description":"The name of the customer who owns the destination account or the debit account used to collect payments"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"UsACHBatchAchDebitsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"POST","path":"/order/us/payments/wireTransfers/cancel/{transactionReference}","fullPath":"/api/v4.0.0/order/us/payments/wireTransfers/cancel/{transactionReference}","operationId":"reverseUsWireTransfer","name":"Request can be sent to initiate cancellation for a wire transfer within 30 minutes of submitting the wire payment","summary":"Initiate request to cancel wire transfer","tags":["RETAIL"],"parameters":[{"name":"transactionReference","in":"path","type":"string","required":true,"description":"Contains the identifier for the transaction in the core system"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"overrideDetails":[{}],"inputter":[{}],"dateTime":[{}],"transactionReference":"string","processingDate":"2024-01-01","statusCode":0.0,"sendersReference":"string","orderingAccount":"string","orderingName":"string","debitCustomerId":0.0,"recordStatus":"string","currNo":0.0,"authoriser":"string","companyCode":"string","deptCode":"string"}},"responses":{"200":"UsWireTransferResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"POST","path":"/order/us/payments/swiftTransfers/cancel/{transactionReference}","fullPath":"/api/v4.0.0/order/us/payments/swiftTransfers/cancel/{transactionReference}","operationId":"cancelSwiftTransaction","name":"Request to cancel international payments initiated within 30 minutes of submitting the payment","summary":"Initiate request to cancel international transfers","tags":["RETAIL"],"parameters":[{"name":"transactionReference","in":"path","type":"string","required":true,"description":"Contains the identifier for the transaction in the core system"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"inputter":[{}],"dateTime":[{}],"companyId":"string","transactionReference":"string","amount":0.0,"currencyId":"string","paymentMsgSentDate":"2024-01-01","outputChannel":"string","statusCode":"string","recordStatus":"string","currNo":0.0,"authoriser":"string","companyCode":"string","deptCode":"string","auditorCode":"string"}},"responses":{"200":"SwiftTransactionResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/order/us/payments/exceptions/achPayments/{paymentId}/accountMatches","fullPath":"/api/v4.0.0/order/us/payments/exceptions/achPayments/{paymentId}/accountMatches","operationId":"updateUsAccountMatch","name":"Allows to update the matched accounts and the customer names.","summary":"Allows to update the matched accounts and the customer names.","tags":[],"parameters":[{"name":"paymentId","in":"path","type":"string","required":true,"description":"Indicates the unique reference number of the payment"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"matchedaccounts":[{}],"accountId":"string","customerName":"string","matchStatus":"MATCH.COMPLETED","extensionData":{}}},"responses":{"200":"UsAccountMatchResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}}]},{"key":"order-us-payments-service-v5.0.0","title":"Same day debits","version":"v5.0.0","description":"Initiates same day debit transfers","endpointCount":21,"endpoints":[{"method":"POST","path":"/order/us/payments/escrows","fullPath":"/api/v5.0.0/order/us/payments/escrows","operationId":"createEscrowAdhocDeposit","name":"Initiates an escrow payment transaction","summary":"Escrow payment","tags":["RETAIL"],"parameters":[{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"overrideDetails":[{}],"creditAccountId":"@ref:product-accountOperationalDate-service-v1.0.0","creditValueDate":"2024-01-01","creditCurrencyId":"string","creditAmount":0.0,"debitAccountId":"@ref:product-accountOperationalDate-service-v1.0.0","debitValueDate":"2024-01-01","debitCurrencyId":"string","debitAmount":0.0,"treasuryRate":0.0,"processingDate":"2024-01-01","customerRate":0.0,"customerSpread":0.0,"recordStatus":"string","currNo":0.0}},"responses":{"200":"EscrowAdhocDepositResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"POST","path":"/order/us/accounts/{accountId}/reservedFunds","fullPath":"/api/v5.0.0/order/us/accounts/{accountId}/reservedFunds","operationId":"createAccountBalanceHold","name":"Create a hold transaction to lock the funds in an account","summary":"Create account hold","tags":["RETAIL"],"parameters":[{"name":"accountId","in":"path","type":"string","required":true,"description":"Identifier of the account. Often referred to as the account number, yet for consistency this is always referred to as accountId. Accepts both IBAN & BBAN"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"overrides":[{}],"holdTypeId":"/v1.0.0/reference/us/accountHoldTypes","description":"string","fromDate":"2024-01-01","toDate":"2024-01-01","lockedAmount":0.0,"blockPriorityId":"string","recordStatus":"string","currNo":0.0,"inputter":"string","dateTime":0.0,"authoriser":"string","companyId":"@ref:reference-companies-service-v1.0.0","deptCode":"@ref:reference-accountOfficers-service-v1.0.0","auditorCode":"string"}},"responses":{"200":"AccountBalanceHoldResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/order/us/accounts/reservedFunds/{holdId}","fullPath":"/api/v5.0.0/order/us/accounts/reservedFunds/{holdId}","operationId":"getAccountBalanceHold","name":"Retrieves information of the amount locked, lock type and the validity for a hold transaction","summary":"Retrieve hold funds detail","tags":["RETAIL"],"parameters":[{"name":"holdId","in":"path","type":"string","required":true,"description":"The transaction reference through which the specified amount in the transaction has been locked in an account"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"AccountBalanceHoldResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/order/us/payments/holds/{holdId}","fullPath":"/api/v5.0.0/order/us/payments/holds/{holdId}","operationId":"updateAccountBalanceHold","name":"Update amount or validity date of an existing hold","summary":"Update existing hold","tags":["RETAIL"],"parameters":[{"name":"holdId","in":"path","type":"string","required":true,"description":"The transaction reference through which the specified amount in the transaction has been locked in an account"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"overrides":[{}],"holdTypeId":"/v1.0.0/reference/us/accountHoldTypes","description":"string","fromDate":"2024-01-01","toDate":"2024-01-01","lockedAmount":0.0,"blockPriorityId":"string","recordStatus":"string","currNo":0.0,"inputter":"string","dateTime":0.0,"authoriser":"string","companyId":"@ref:reference-companies-service-v1.0.0","deptCode":"@ref:reference-accountOfficers-service-v1.0.0","auditorCode":"string"}},"responses":{"200":"AccountBalanceHoldResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/order/us/payments/accounts/{accountId}/holdSummary","fullPath":"/api/v5.0.0/order/us/payments/accounts/{accountId}/holdSummary","operationId":"getAccountHoldDetails","name":"Retrieves details of all holds placed on an account","summary":"Get hold summary","tags":["RETAIL"],"parameters":[{"name":"accountId","in":"path","type":"string","required":true,"description":"Identifier of the account. Often referred to as the account number, yet for consistency this is always referred to as accountId. Accepts both IBAN & BBAN"},{"name":"holdTypeId","in":"query","type":"string","required":false,"description":"Purpose or the type of hold placed on the account  The available list of hold types can be retrieved through getHoldTypes"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"AccountHoldDetailsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"POST","path":"/order/us/payments/transactionStops","fullPath":"/api/v5.0.0/order/us/payments/transactionStops","operationId":"createUsTransactionStop","name":"Create transaction stop instruction to capture instructions to stop a payment based on the payment type, recipient or amount","summary":"Create transaction stop instruction","tags":["RETAIL"],"parameters":[{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"stopCondition":[{}],"accountId":"@ref:product-accountOperationalDate-service-v1.0.0","stopTypeId":"string","transactionChannel":"string","stopInstructionChannel":"BANK","stopReason":"CHKDES","issueDate":"string","replacementCheck":"string","replacementCheckIssueDate":"string","expiryDate":"string","waiveCharge":"string","transactionStopStatus":"ACTIVE","suppressNotice":"string","cancelInstruction":"YES","override":"string"}},"responses":{"200":"UsTransactionStopResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"DELETE","path":"/order/us/payments/transactionStops/{stopInstructionId}","fullPath":"/api/v5.0.0/order/us/payments/transactionStops/{stopInstructionId}","operationId":"deleteUsTransactionStop","name":"Deletes a transaction stop instruction capturing with instructions to stop a payment","summary":"Delete transaction stop","tags":["RETAIL"],"parameters":[{"name":"stopInstructionId","in":"path","type":"string","required":true,"description":"ID of stop instruction"},{"name":"payload","in":"body","type":"object","required":false,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}}},"responses":{"200":"UsTransactionStopResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"POST","path":"/order/us/payments/wireTransfers","fullPath":"/api/v5.0.0/order/us/payments/wireTransfers","operationId":"createFedwireCTR","name":"Creates an instant payment through  fedwire of payment type CTR, customer transfer","summary":"Posts a customer transfer through wire payment","tags":["RETAIL"],"parameters":[{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"orderingCustomerAddressLines":[{}],"beneficiaryInstituteAddressLines":[{}],"beneficiaryAddressLines":[{}],"intermediaryFiNameAddressLines":[{}],"OriginatorToBeneficiaryLines":[{}],"receiverFiAndIntermediaryFiLines":[{}],"adviceInformation":[{}],"InformationLines":[{}],"charges":[{}],"overrides":[{}],"paymentPriority":"/v1.0.0/reference/lookups?virtualTableName=PAYMENT.SERVICE.LEVEL.CODE","orderingCustomerId":"string","debitAccountId":"string","schedulePaymentAmount":0.0,"debitValueDate":"2024-01-01"}},"responses":{"200":"FedwireCTRResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"POST","path":"/order/us/payments/paymentOrders","fullPath":"/api/v5.0.0/order/us/payments/paymentOrders","operationId":"createUsDomesticTransfer","name":"Create one-time domestic account transfers and bill payments through ACH Clearing and the interbank automated clearing house","summary":"Create domestic transfer","tags":["RETAIL"],"parameters":[{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"standardEntryClassCode":"CIE","companyEntryDescription":"string","debitAccountId":"string","transactionAmount":0.0,"requiredCreditValueDate":"2024-01-01","beneficiaryId":"/v1.0.0/party/us/customers/{customerId}/beneficiaries","transactionCode":0.0,"beneficiaryOtherId":"string","accountWithBankClearingCode":"string","beneficiaryAccountId":"string","beneficiaryName":"string","narrative":"string","paymentCurrency":"string","paymentOrderProductId":"string","recordStatus":"string"}},"responses":{"200":"UsDomesticTransferResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"POST","path":"/order/us/payments/standingOrders/{accountId}","fullPath":"/api/v5.0.0/order/us/payments/standingOrders/{accountId}","operationId":"createUsRecurringTransfers","name":"Create a recurring account transfer","summary":"Create recurring transfer","tags":["RETAIL"],"parameters":[{"name":"accountId","in":"path","type":"string","required":true,"description":"Identifier of the account. Often referred to as the account number, yet for consistency this is always referred to as accountId. Accepts both IBAN & BBAN"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"beneficiaries":[{}],"currentFrequency":"string","standardEntryClassCode":"CIE","startDate":"2024-01-01","companyEntryDescription":"string","currentEndDate":"2024-01-01","currentAmountBalance":0.0,"beneficiaryId":"/v1.0.0/party/us/customers/{customerId}/beneficiaries","transactionCode":0.0,"beneficiaryOtherId":"string","accountWithBankClearingCode":"string","beneficiaryAccountId":"string","paymentDetail":"string","recordStatus":"string","currNo":"string"}},"responses":{"200":"UsRecurringTransfersResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"POST","path":"/order/us/payments/directDebits/{accountId}","fullPath":"/api/v5.0.0/order/us/payments/directDebits/{accountId}","operationId":"createUsDirectDebits","name":"Create direct debit instructions for repayment of loans or bill payment through external accounts","summary":"Create direct debit instruction","tags":["RETAIL"],"parameters":[{"name":"accountId","in":"path","type":"string","required":true,"description":"Identifier of the account. Often referred to as the account number, yet for consistency this is always referred to as accountId. Accepts both IBAN & BBAN"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"displayName":"string","directDebitParameterId":"string","serviceClassCode":0.0,"standardEntryClassCode":"PPD","debitAccountType":"string","debitBankClearingCode":"string","destinationAccountId":"string","debitorName":"string","frequency":"string","paymentDetail":"string","currencyMarket":"string","terminationDate":"2024-01-01","direction":"string","standAloneDdi":"string","standaloneAmount":0.0}},"responses":{"200":"UsDirectDebitsResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/order/us/payments/directDebits","fullPath":"/api/v5.0.0/order/us/payments/directDebits","operationId":"getUsDirectDebits","name":"Retrieve the list of direct debits initiated for repayment of bills or loans from external accounts","summary":"Retrieve direct debits setup for an account","tags":["RETAIL"],"parameters":[{"name":"customerId","in":"query","type":"string","required":false,"description":"Identifier of the customer"},{"name":"directDebitParameterId","in":"query","type":"string","required":false,"description":"Reference to the parameter which holds details relating to clearing accounts, number of days before which the claim has to be submitted or resubmitted"},{"name":"frequency","in":"query","type":"string","required":false,"description":"Specifies the frequency in which the payment application(periodic payments) execute the payment instruction."},{"name":"accountId","in":"query","type":"string","required":false,"description":"Identifier of the account. Often referred to as the account number, yet for consistency this is always referred to as accountId. Accepts both IBAN & BBAN"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"UsDirectDebitsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/order/us/payments/standingOrders","fullPath":"/api/v5.0.0/order/us/payments/standingOrders","operationId":"getUsRecurringTransfers","name":"Retrieve recurring payments setup for account transfers and bill payments","summary":"Get recurring transfer details","tags":["RETAIL"],"parameters":[{"name":"orderingCustomerId","in":"query","type":"string","required":false,"description":"Indicates the customer id for the ordering customer"},{"name":"paymentOrderProductName","in":"query","type":"string","required":false,"description":"Indicates the name of payment order product "},{"name":"accountId","in":"query","type":"string","required":false,"description":"Identifier of the account. Often referred to as the account number, yet for consistency this is always referred to as accountId. Accepts both IBAN & BBAN"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"UsRecurringTransfersResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"POST","path":"/order/us/payments/wireTransfers/simulate","fullPath":"/api/v5.0.0/order/us/payments/wireTransfers/simulate","operationId":"simulateFedwireCTR","name":"Validate payment order transaction to verify the information provided and to retrieve the applicable charges","summary":"Validate payment order transaction ","tags":["RETAIL"],"parameters":[{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"orderingCustomerAddressLines":[{}],"beneficiaryInstituteAddressLines":[{}],"beneficiaryAddressLines":[{}],"intermediaryFiNameAddressLines":[{}],"OriginatorToBeneficiaryLines":[{}],"receiverFiAndIntermediaryFiLines":[{}],"adviceInformation":[{}],"InformationLines":[{}],"charges":[{}],"overrides":[{}],"paymentPriority":"/v1.0.0/reference/lookups?virtualTableName=PAYMENT.SERVICE.LEVEL.CODE","orderingCustomerId":"string","debitAccountId":"string","schedulePaymentAmount":0.0,"debitValueDate":"2024-01-01"}},"responses":{"200":"FedwireCTRResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/order/us/payments/paymentStatus","fullPath":"/api/v5.0.0/order/us/payments/paymentStatus","operationId":"getUsPaymentsStatus","name":"Retrieve payment status and transaction history for an account along with beneficiary details and beneficiary status","summary":"Retrieve payment history","tags":["RETAIL"],"parameters":[{"name":"fromDate","in":"query","type":"string","required":false,"description":"Indicates the business date from when the balance reservation event is active."},{"name":"status","in":"query","type":"string","required":false,"description":"The status of the early maturity request"},{"name":"orderingCustomerId","in":"query","type":"string","required":false,"description":"Indicates the customer id for the ordering customer"},{"name":"debitAccountId","in":"query","type":"string","required":false,"description":"Indicates the debit account number of the payment or transaction."},{"name":"paymentOrderId","in":"query","type":"string","required":false,"description":"The unique reference number of payment"},{"name":"transactionReference","in":"query","type":"string","required":false,"description":"Contains the identifier for the transaction in the core system"},{"name":"paymentStatus","in":"query","type":"string","required":false,"description":"Describes the current status of the payment order in the payment system"},{"name":"toDate","in":"query","type":"string","required":false,"description":"Indicates the business date until when the balance reservation event is active."},{"name":"beneficiaryId","in":"query","type":"string","required":false,"description":"Indicates the reference of the financial institution that allows access to the beneficiary information"},{"name":"beneficiaryAccountId","in":"query","type":"string","required":false,"description":"Unique account identifier of the beneficiary account number."},{"name":"direction","in":"query","type":"string","required":false,"description":"Indicates the direction of the Direct debit claim for which mandate is received. The claim can be 'Outward' i.e. Claim is sent to the other bank or 'Inward'  i.e. other bank submit their claim to debi"},{"name":"paymentOrderProductId","in":"query","type":"string","required":false,"description":"Indicates the payment order product for which payment is initiated"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"UsPaymentsStatusResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"POST","path":"/order/us/payments/microDeposits","fullPath":"/api/v5.0.0/order/us/payments/microDeposits","operationId":"createUsACHBatchMicroDeposits","name":"Create a microdeposit batch to validate external account for a new beneficiary added by customer","summary":"Create a microdeposit batch to validate external account","tags":["RETAIL"],"parameters":[{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"entryDetails":[{}],"accountType":"string","recordStatus":"string","currNo":"string","inputter":"string","dateTime":"string","authoriser":"string","companyId":"string","deptCOde":"string","auditorCode":"string","auditTimeDate":"string","extensions":{}}},"responses":{"200":"UsACHBatchMicroDepositsResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/order/us/payments/customers/{orderingCustomerId}/directDebits/achDebits","fullPath":"/api/v5.0.0/order/us/payments/customers/{orderingCustomerId}/directDebits/achDebits","operationId":"getUsACHBatchAchDebits","name":"Retrieve list of customer initiated debit request to external accounts processed through ACH clearing and the interbank automated clearing house","summary":"Retrieve list of customer initiated debit request to external accounts","tags":["RETAIL"],"parameters":[{"name":"orderingCustomerId","in":"path","type":"string","required":true,"description":"Indicates the customer id for the ordering customer"},{"name":"effectiveDate","in":"query","type":"string","required":false,"description":"Contains the identifier for the transaction date. Dates are expected in \u00e2\u20ac\u02dcYYYYMMDD\u00e2\u20ac\u2122 format"},{"name":"creditAccountId","in":"query","type":"string","required":false,"description":"Credit account identifier of the payment or transaction"},{"name":"transactionCode","in":"query","type":"string","required":false,"description":"Identifies the system internal transaction code applicable to the transaction"},{"name":"amount","in":"query","type":"string","required":false,"description":"This is the payment amount"},{"name":"beneficiaryInstituteRoutingNo","in":"query","type":"string","required":false,"description":"Routing number of DDA number of the Financial institution where the beneficiary account exists"},{"name":"debitAccountId","in":"query","type":"string","required":false,"description":"Indicates the debit account number of the payment or transaction."},{"name":"debitorName","in":"query","type":"string","required":false,"description":"The name of the customer who owns the destination account or the debit account used to collect payments"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"UsACHBatchAchDebitsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"POST","path":"/order/us/payments/wireTransfers/cancel/{transactionReference}","fullPath":"/api/v5.0.0/order/us/payments/wireTransfers/cancel/{transactionReference}","operationId":"reverseUsWireTransfer","name":"Request can be sent to initiate cancellation for a wire transfer within 30 minutes of submitting the wire payment","summary":"Initiate request to cancel wire transfer","tags":["RETAIL"],"parameters":[{"name":"transactionReference","in":"path","type":"string","required":true,"description":"Contains the identifier for the transaction in the core system"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"overrideDetails":[{}],"inputter":[{}],"dateTime":[{}],"transactionReference":"string","processingDate":"2024-01-01","statusCode":0.0,"sendersReference":"string","orderingAccount":"string","orderingName":"string","debitCustomerId":0.0,"recordStatus":"string","currNo":0.0,"authoriser":"string","companyCode":"string","deptCode":"string"}},"responses":{"200":"UsWireTransferResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"POST","path":"/order/us/payments/swiftTransfers/cancel/{transactionReference}","fullPath":"/api/v5.0.0/order/us/payments/swiftTransfers/cancel/{transactionReference}","operationId":"cancelSwiftTransaction","name":"Request to cancel international payments initiated within 30 minutes of submitting the payment","summary":"Initiate request to cancel international transfers","tags":["RETAIL"],"parameters":[{"name":"transactionReference","in":"path","type":"string","required":true,"description":"Contains the identifier for the transaction in the core system"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"inputter":[{}],"dateTime":[{}],"companyId":"string","transactionReference":"string","amount":0.0,"currencyId":"string","paymentMsgSentDate":"2024-01-01","outputChannel":"string","statusCode":"string","recordStatus":"string","currNo":0.0,"authoriser":"string","companyCode":"string","deptCode":"string","auditorCode":"string"}},"responses":{"200":"SwiftTransactionResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/order/us/payments/achEntry/{achEntryId}/achEntryStatus","fullPath":"/api/v5.0.0/order/us/payments/achEntry/{achEntryId}/achEntryStatus","operationId":"updateAchNOCEntriesStatus","name":"Allows to update the status to processed ","summary":"Allows to update the status to processed","tags":["RETAIL"],"parameters":[{"name":"achEntryId","in":"path","type":"string","required":true,"description":""},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"achEntryStatus":"string","paymentOrderId":"string","transactionReference":"string","executionDate":"string","deliveryByDate":"string","creditDebitIndicator":"string","beneficiaryInstituteRoutingNo":"string","beneficiaryName":"string","beneficiaryOtherId":"string","accountId":"string","paymentAmount":"string","standardEntryClassCode":"string","extensions":{}}},"responses":{"200":"AchNOCEntriesStatusResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"POST","path":"/order/us/payments/directDebits/achDebits","fullPath":"/api/v5.0.0/order/us/payments/directDebits/achDebits","operationId":"createUsAchSameDayDebits","name":"Initiates same day debit transfers","summary":"Initiates same day ACH debit collection transaction","tags":["RETAIL"],"parameters":[{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"creditAccountId":"string","amount":"string","effectiveDate":"string","debitBankClearingCode":"string","debitAccountId":"string","debitorName":"string","additionalInformation":"string","standardEntryClassCode":"CCD","debitAccountType":"Checking","customerType":"Business","companyEntryDescription":"string","extensions":{}}},"responses":{"200":"UsAchSameDayDebitsResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}}]},{"key":"order-us-payments-service-v6.0.0","title":"Same day debits","version":"v6.0.0","description":"Initiates same day debit transfers","endpointCount":21,"endpoints":[{"method":"POST","path":"/order/us/payments/escrows","fullPath":"/api/v6.0.0/order/us/payments/escrows","operationId":"createEscrowAdhocDeposit","name":"Initiates an escrow payment transaction","summary":"Escrow payment","tags":["RETAIL"],"parameters":[{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"overrideDetails":[{}],"creditAccountId":"@ref:product-accountOperationalDate-service-v1.0.0","creditValueDate":"2024-01-01","creditCurrencyId":"string","creditAmount":0.0,"debitAccountId":"@ref:product-accountOperationalDate-service-v1.0.0","debitValueDate":"2024-01-01","debitCurrencyId":"string","debitAmount":0.0,"treasuryRate":0.0,"processingDate":"2024-01-01","customerRate":0.0,"customerSpread":0.0,"recordStatus":"string","currNo":0.0}},"responses":{"200":"EscrowAdhocDepositResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"POST","path":"/order/us/accounts/{accountId}/reservedFunds","fullPath":"/api/v6.0.0/order/us/accounts/{accountId}/reservedFunds","operationId":"createAccountBalanceHold","name":"Create a hold transaction to lock the funds in an account","summary":"Create account hold","tags":["RETAIL"],"parameters":[{"name":"accountId","in":"path","type":"string","required":true,"description":"Identifier of the account. Often referred to as the account number, yet for consistency this is always referred to as accountId. Accepts both IBAN & BBAN"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"overrides":[{}],"holdTypeId":"/v1.0.0/reference/us/accountHoldTypes","description":"string","fromDate":"2024-01-01","toDate":"2024-01-01","lockedAmount":0.0,"blockPriorityId":"string","recordStatus":"string","currNo":0.0,"inputter":"string","dateTime":0.0,"authoriser":"string","companyId":"@ref:reference-companies-service-v1.0.0","deptCode":"@ref:reference-accountOfficers-service-v1.0.0","auditorCode":"string"}},"responses":{"200":"AccountBalanceHoldResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/order/us/accounts/reservedFunds/{holdId}","fullPath":"/api/v6.0.0/order/us/accounts/reservedFunds/{holdId}","operationId":"getAccountBalanceHold","name":"Retrieves information of the amount locked, lock type and the validity for a hold transaction","summary":"Retrieve hold funds detail","tags":["RETAIL"],"parameters":[{"name":"holdId","in":"path","type":"string","required":true,"description":"The transaction reference through which the specified amount in the transaction has been locked in an account"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"AccountBalanceHoldResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/order/us/payments/holds/{holdId}","fullPath":"/api/v6.0.0/order/us/payments/holds/{holdId}","operationId":"updateAccountBalanceHold","name":"Update amount or validity date of an existing hold","summary":"Update existing hold","tags":["RETAIL"],"parameters":[{"name":"holdId","in":"path","type":"string","required":true,"description":"The transaction reference through which the specified amount in the transaction has been locked in an account"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"overrides":[{}],"holdTypeId":"/v1.0.0/reference/us/accountHoldTypes","description":"string","fromDate":"2024-01-01","toDate":"2024-01-01","lockedAmount":0.0,"blockPriorityId":"string","recordStatus":"string","currNo":0.0,"inputter":"string","dateTime":0.0,"authoriser":"string","companyId":"@ref:reference-companies-service-v1.0.0","deptCode":"@ref:reference-accountOfficers-service-v1.0.0","auditorCode":"string"}},"responses":{"200":"AccountBalanceHoldResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/order/us/payments/accounts/{accountId}/holdSummary","fullPath":"/api/v6.0.0/order/us/payments/accounts/{accountId}/holdSummary","operationId":"getAccountHoldDetails","name":"Retrieves details of all holds placed on an account","summary":"Get hold summary","tags":["RETAIL"],"parameters":[{"name":"accountId","in":"path","type":"string","required":true,"description":"Identifier of the account. Often referred to as the account number, yet for consistency this is always referred to as accountId. Accepts both IBAN & BBAN"},{"name":"holdTypeId","in":"query","type":"string","required":false,"description":"Purpose or the type of hold placed on the account  The available list of hold types can be retrieved through getHoldTypes"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"AccountHoldDetailsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"POST","path":"/order/us/payments/transactionStops","fullPath":"/api/v6.0.0/order/us/payments/transactionStops","operationId":"createUsTransactionStop","name":"Create transaction stop instruction to capture instructions to stop a payment based on the payment type, recipient or amount","summary":"Create transaction stop instruction","tags":["RETAIL"],"parameters":[{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"stopCondition":[{}],"accountId":"@ref:product-accountOperationalDate-service-v1.0.0","stopTypeId":"string","transactionChannel":"string","stopInstructionChannel":"BANK","stopReason":"CHKDES","issueDate":"string","replacementCheck":"string","replacementCheckIssueDate":"string","expiryDate":"string","waiveCharge":"string","transactionStopStatus":"ACTIVE","suppressNotice":"string","cancelInstruction":"YES","override":"string"}},"responses":{"200":"UsTransactionStopResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"DELETE","path":"/order/us/payments/transactionStops/{stopInstructionId}","fullPath":"/api/v6.0.0/order/us/payments/transactionStops/{stopInstructionId}","operationId":"deleteUsTransactionStop","name":"Deletes a transaction stop instruction capturing with instructions to stop a payment","summary":"Delete transaction stop","tags":["RETAIL"],"parameters":[{"name":"stopInstructionId","in":"path","type":"string","required":true,"description":"ID of stop instruction"},{"name":"payload","in":"body","type":"object","required":false,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}}},"responses":{"200":"UsTransactionStopResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"POST","path":"/order/us/payments/wireTransfers","fullPath":"/api/v6.0.0/order/us/payments/wireTransfers","operationId":"createFedwireCTR","name":"Creates an instant payment through  fedwire of payment type CTR, customer transfer","summary":"Posts a customer transfer through wire payment","tags":["RETAIL"],"parameters":[{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"orderingCustomerAddressLines":[{}],"beneficiaryInstituteAddressLines":[{}],"beneficiaryAddressLines":[{}],"intermediaryFiNameAddressLines":[{}],"OriginatorToBeneficiaryLines":[{}],"receiverFiAndIntermediaryFiLines":[{}],"adviceInformation":[{}],"InformationLines":[{}],"charges":[{}],"overrides":[{}],"paymentPriority":"/v1.0.0/reference/lookups?virtualTableName=PAYMENT.SERVICE.LEVEL.CODE","orderingCustomerId":"string","debitAccountId":"string","schedulePaymentAmount":0.0,"debitValueDate":"2024-01-01"}},"responses":{"200":"FedwireCTRResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"POST","path":"/order/us/payments/paymentOrders","fullPath":"/api/v6.0.0/order/us/payments/paymentOrders","operationId":"createUsDomesticTransfer","name":"Create one-time domestic account transfers and bill payments through ACH Clearing and the interbank automated clearing house","summary":"Create domestic transfer","tags":["RETAIL"],"parameters":[{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"standardEntryClassCode":"CIE","companyEntryDescription":"string","debitAccountId":"string","transactionAmount":0.0,"requiredCreditValueDate":"2024-01-01","beneficiaryId":"/v1.0.0/party/us/customers/{customerId}/beneficiaries","transactionCode":0.0,"beneficiaryOtherId":"string","accountWithBankClearingCode":"string","beneficiaryAccountId":"string","beneficiaryName":"string","narrative":"string","paymentCurrency":"string","paymentOrderProductId":"string","recordStatus":"string"}},"responses":{"200":"UsDomesticTransferResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"POST","path":"/order/us/payments/standingOrders/{accountId}","fullPath":"/api/v6.0.0/order/us/payments/standingOrders/{accountId}","operationId":"createUsRecurringTransfers","name":"Create a recurring account transfer","summary":"Create recurring transfer","tags":["RETAIL"],"parameters":[{"name":"accountId","in":"path","type":"string","required":true,"description":"Identifier of the account. Often referred to as the account number, yet for consistency this is always referred to as accountId. Accepts both IBAN & BBAN"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"beneficiaries":[{}],"currentFrequency":"string","standardEntryClassCode":"CIE","startDate":"2024-01-01","companyEntryDescription":"string","currentEndDate":"2024-01-01","currentAmountBalance":0.0,"beneficiaryId":"/v1.0.0/party/us/customers/{customerId}/beneficiaries","transactionCode":0.0,"beneficiaryOtherId":"string","accountWithBankClearingCode":"string","beneficiaryAccountId":"string","paymentDetail":"string","recordStatus":"string","currNo":"string"}},"responses":{"200":"UsRecurringTransfersResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"POST","path":"/order/us/payments/directDebits/{accountId}","fullPath":"/api/v6.0.0/order/us/payments/directDebits/{accountId}","operationId":"createUsDirectDebits","name":"Create direct debit instructions for repayment of loans or bill payment through external accounts","summary":"Create direct debit instruction","tags":["RETAIL"],"parameters":[{"name":"accountId","in":"path","type":"string","required":true,"description":"Identifier of the account. Often referred to as the account number, yet for consistency this is always referred to as accountId. Accepts both IBAN & BBAN"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"displayName":"string","directDebitParameterId":"string","serviceClassCode":0.0,"standardEntryClassCode":"PPD","debitAccountType":"string","debitBankClearingCode":"string","destinationAccountId":"string","debitorName":"string","frequency":"string","paymentDetail":"string","currencyMarket":"string","terminationDate":"2024-01-01","direction":"string","standAloneDdi":"string","standaloneAmount":0.0}},"responses":{"200":"UsDirectDebitsResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/order/us/payments/directDebits","fullPath":"/api/v6.0.0/order/us/payments/directDebits","operationId":"getUsDirectDebits","name":"Retrieve the list of direct debits initiated for repayment of bills or loans from external accounts","summary":"Retrieve direct debits setup for an account","tags":["RETAIL"],"parameters":[{"name":"customerId","in":"query","type":"string","required":false,"description":"Identifier of the customer"},{"name":"directDebitParameterId","in":"query","type":"string","required":false,"description":"Reference to the parameter which holds details relating to clearing accounts, number of days before which the claim has to be submitted or resubmitted"},{"name":"frequency","in":"query","type":"string","required":false,"description":"Specifies the frequency in which the payment application(periodic payments) execute the payment instruction."},{"name":"accountId","in":"query","type":"string","required":false,"description":"Identifier of the account. Often referred to as the account number, yet for consistency this is always referred to as accountId. Accepts both IBAN & BBAN"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"UsDirectDebitsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/order/us/payments/standingOrders","fullPath":"/api/v6.0.0/order/us/payments/standingOrders","operationId":"getUsRecurringTransfers","name":"Retrieve recurring payments setup for account transfers and bill payments","summary":"Get recurring transfer details","tags":["RETAIL"],"parameters":[{"name":"orderingCustomerId","in":"query","type":"string","required":false,"description":"Indicates the customer id for the ordering customer"},{"name":"paymentOrderProductName","in":"query","type":"string","required":false,"description":"Indicates the name of payment order product "},{"name":"accountId","in":"query","type":"string","required":false,"description":"Identifier of the account. Often referred to as the account number, yet for consistency this is always referred to as accountId. Accepts both IBAN & BBAN"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"UsRecurringTransfersResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"POST","path":"/order/us/payments/wireTransfers/simulate","fullPath":"/api/v6.0.0/order/us/payments/wireTransfers/simulate","operationId":"simulateFedwireCTR","name":"Validate payment order transaction to verify the information provided and to retrieve the applicable charges","summary":"Validate payment order transaction ","tags":["RETAIL"],"parameters":[{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"orderingCustomerAddressLines":[{}],"beneficiaryInstituteAddressLines":[{}],"beneficiaryAddressLines":[{}],"intermediaryFiNameAddressLines":[{}],"OriginatorToBeneficiaryLines":[{}],"receiverFiAndIntermediaryFiLines":[{}],"adviceInformation":[{}],"InformationLines":[{}],"charges":[{}],"overrides":[{}],"paymentPriority":"/v1.0.0/reference/lookups?virtualTableName=PAYMENT.SERVICE.LEVEL.CODE","orderingCustomerId":"string","debitAccountId":"string","schedulePaymentAmount":0.0,"debitValueDate":"2024-01-01"}},"responses":{"200":"FedwireCTRResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/order/us/payments/paymentStatus","fullPath":"/api/v6.0.0/order/us/payments/paymentStatus","operationId":"getUsPaymentsStatus","name":"Retrieve payment status and transaction history for an account along with beneficiary details and beneficiary status","summary":"Retrieve payment history","tags":["RETAIL"],"parameters":[{"name":"fromDate","in":"query","type":"string","required":false,"description":"Indicates the business date from when the balance reservation event is active."},{"name":"status","in":"query","type":"string","required":false,"description":"The status of the early maturity request"},{"name":"orderingCustomerId","in":"query","type":"string","required":false,"description":"Indicates the customer id for the ordering customer"},{"name":"debitAccountId","in":"query","type":"string","required":false,"description":"Indicates the debit account number of the payment or transaction."},{"name":"paymentOrderId","in":"query","type":"string","required":false,"description":"The unique reference number of payment"},{"name":"transactionReference","in":"query","type":"string","required":false,"description":"Contains the identifier for the transaction in the core system"},{"name":"paymentStatus","in":"query","type":"string","required":false,"description":"Describes the current status of the payment order in the payment system"},{"name":"toDate","in":"query","type":"string","required":false,"description":"Indicates the business date until when the balance reservation event is active."},{"name":"beneficiaryId","in":"query","type":"string","required":false,"description":"Indicates the reference of the financial institution that allows access to the beneficiary information"},{"name":"beneficiaryAccountId","in":"query","type":"string","required":false,"description":"Unique account identifier of the beneficiary account number."},{"name":"direction","in":"query","type":"string","required":false,"description":"Indicates the direction of the Direct debit claim for which mandate is received. The claim can be 'Outward' i.e. Claim is sent to the other bank or 'Inward'  i.e. other bank submit their claim to debi"},{"name":"paymentOrderProductId","in":"query","type":"string","required":false,"description":"Indicates the payment order product for which payment is initiated"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"UsPaymentsStatusResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"POST","path":"/order/us/payments/microDeposits","fullPath":"/api/v6.0.0/order/us/payments/microDeposits","operationId":"createUsACHBatchMicroDeposits","name":"Create a microdeposit batch to validate external account for a new beneficiary added by customer","summary":"Create a microdeposit batch to validate external account","tags":["RETAIL"],"parameters":[{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"entryDetails":[{}],"accountType":"string","recordStatus":"string","currNo":"string","inputter":"string","dateTime":"string","authoriser":"string","companyId":"string","deptCOde":"string","auditorCode":"string","auditTimeDate":"string","extensions":{}}},"responses":{"200":"UsACHBatchMicroDepositsResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/order/us/payments/customers/{orderingCustomerId}/directDebits/achDebits","fullPath":"/api/v6.0.0/order/us/payments/customers/{orderingCustomerId}/directDebits/achDebits","operationId":"getUsACHBatchAchDebits","name":"Retrieve list of customer initiated debit request to external accounts processed through ACH clearing and the interbank automated clearing house","summary":"Retrieve list of customer initiated debit request to external accounts","tags":["RETAIL"],"parameters":[{"name":"orderingCustomerId","in":"path","type":"string","required":true,"description":"Indicates the customer id for the ordering customer"},{"name":"effectiveDate","in":"query","type":"string","required":false,"description":"Contains the identifier for the transaction date. Dates are expected in \u00e2\u20ac\u02dcYYYYMMDD\u00e2\u20ac\u2122 format"},{"name":"creditAccountId","in":"query","type":"string","required":false,"description":"Credit account identifier of the payment or transaction"},{"name":"transactionCode","in":"query","type":"string","required":false,"description":"Identifies the system internal transaction code applicable to the transaction"},{"name":"amount","in":"query","type":"string","required":false,"description":"Contains the direct debit claim amount"},{"name":"beneficiaryInstituteRoutingNo","in":"query","type":"string","required":false,"description":"Routing number of DDA number of the Financial institution where the beneficiary account exists"},{"name":"debitAccountId","in":"query","type":"string","required":false,"description":"Indicates the debit account number of the payment or transaction."},{"name":"debitorName","in":"query","type":"string","required":false,"description":"The name of the customer who owns the destination account or the debit account used to collect payments"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"UsACHBatchAchDebitsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"POST","path":"/order/us/payments/wireTransfers/cancel/{transactionReference}","fullPath":"/api/v6.0.0/order/us/payments/wireTransfers/cancel/{transactionReference}","operationId":"reverseUsWireTransfer","name":"Request can be sent to initiate cancellation for a wire transfer within 30 minutes of submitting the wire payment","summary":"Initiate request to cancel wire transfer","tags":["RETAIL"],"parameters":[{"name":"transactionReference","in":"path","type":"string","required":true,"description":"Contains the identifier for the transaction in the core system"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"overrideDetails":[{}],"inputter":[{}],"dateTime":[{}],"transactionReference":"string","processingDate":"2024-01-01","statusCode":0.0,"sendersReference":"string","orderingAccount":"string","orderingName":"string","debitCustomerId":0.0,"recordStatus":"string","currNo":0.0,"authoriser":"string","companyCode":"string","deptCode":"string"}},"responses":{"200":"UsWireTransferResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"POST","path":"/order/us/payments/swiftTransfers/cancel/{transactionReference}","fullPath":"/api/v6.0.0/order/us/payments/swiftTransfers/cancel/{transactionReference}","operationId":"cancelSwiftTransaction","name":"Request to cancel international payments initiated within 30 minutes of submitting the payment","summary":"Initiate request to cancel international transfers","tags":["RETAIL"],"parameters":[{"name":"transactionReference","in":"path","type":"string","required":true,"description":"Contains the identifier for the transaction in the core system"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"inputter":[{}],"dateTime":[{}],"companyId":"string","transactionReference":"string","amount":0.0,"currencyId":"string","paymentMsgSentDate":"2024-01-01","outputChannel":"string","statusCode":"string","recordStatus":"string","currNo":0.0,"authoriser":"string","companyCode":"string","deptCode":"string","auditorCode":"string"}},"responses":{"200":"SwiftTransactionResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/order/us/payments/achEntry/{achEntryId}/achEntryStatus","fullPath":"/api/v6.0.0/order/us/payments/achEntry/{achEntryId}/achEntryStatus","operationId":"updateAchNOCEntriesStatus","name":"Allows to update the status to processed ","summary":"Allows to update the status to processed","tags":["RETAIL"],"parameters":[{"name":"achEntryId","in":"path","type":"string","required":true,"description":""},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"achEntryStatus":"string","paymentOrderId":"string","transactionReference":"string","executionDate":"string","deliveryByDate":"string","creditDebitIndicator":"string","beneficiaryInstituteRoutingNo":"string","beneficiaryName":"string","beneficiaryOtherId":"string","accountId":"string","paymentAmount":"string","standardEntryClassCode":"string","extensions":{}}},"responses":{"200":"AchNOCEntriesStatusResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"POST","path":"/order/us/payments/directDebits/achDebits","fullPath":"/api/v6.0.0/order/us/payments/directDebits/achDebits","operationId":"createUsAchSameDayDebits","name":"Initiates same day debit transfers","summary":"Initiates same day ACH debit collection transaction","tags":["RETAIL"],"parameters":[{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"creditAccountId":"string","amount":"string","effectiveDate":"string","debitBankClearingCode":"string","debitAccountId":"string","debitorName":"string","additionalInformation":"string","standardEntryClassCode":"CCD","debitAccountType":"Checking","customerType":"Business","companyEntryDescription":"string","extensions":{}}},"responses":{"200":"UsAchSameDayDebitsResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}}]},{"key":"order-us-payments-service-v7.0.0","title":"Same day debits","version":"v7.0.0","description":"Initiates same day debit transfers","endpointCount":24,"endpoints":[{"method":"POST","path":"/order/us/payments/escrows","fullPath":"/api/v7.0.0/order/us/payments/escrows","operationId":"createEscrowAdhocDeposit","name":"Initiates an escrow payment transaction","summary":"Escrow payment","tags":["RETAIL"],"parameters":[{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"overrideDetails":[{}],"creditAccountId":"@ref:product-accountOperationalDate-service-v1.0.0","creditValueDate":"2024-01-01","creditCurrencyId":"string","creditAmount":0.0,"debitAccountId":"@ref:product-accountOperationalDate-service-v1.0.0","debitValueDate":"2024-01-01","debitCurrencyId":"string","debitAmount":0.0,"treasuryRate":0.0,"processingDate":"2024-01-01","customerRate":0.0,"customerSpread":0.0,"recordStatus":"string","currNo":0.0}},"responses":{"200":"EscrowAdhocDepositResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"POST","path":"/order/us/accounts/{accountId}/reservedFunds","fullPath":"/api/v7.0.0/order/us/accounts/{accountId}/reservedFunds","operationId":"createAccountBalanceHold","name":"Create a hold transaction to lock the funds in an account","summary":"Create account hold","tags":["RETAIL"],"parameters":[{"name":"accountId","in":"path","type":"string","required":true,"description":"Identifier of the account. Often referred to as the account number, yet for consistency this is always referred to as accountId. Accepts both IBAN & BBAN"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"overrides":[{}],"holdTypeId":"/v1.0.0/reference/us/accountHoldTypes","description":"string","fromDate":"2024-01-01","toDate":"2024-01-01","lockedAmount":0.0,"blockPriorityId":"string","recordStatus":"string","currNo":0.0,"inputter":"string","dateTime":0.0,"authoriser":"string","companyId":"@ref:reference-companies-service-v1.0.0","deptCode":"@ref:reference-accountOfficers-service-v1.0.0","auditorCode":"string"}},"responses":{"200":"AccountBalanceHoldResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/order/us/accounts/reservedFunds/{holdId}","fullPath":"/api/v7.0.0/order/us/accounts/reservedFunds/{holdId}","operationId":"getAccountBalanceHold","name":"Retrieves information of the amount locked, lock type and the validity for a hold transaction","summary":"Retrieve hold funds detail","tags":["RETAIL"],"parameters":[{"name":"holdId","in":"path","type":"string","required":true,"description":"The transaction reference through which the specified amount in the transaction has been locked in an account"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"AccountBalanceHoldResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/order/us/payments/holds/{holdId}","fullPath":"/api/v7.0.0/order/us/payments/holds/{holdId}","operationId":"updateAccountBalanceHold","name":"Update amount or validity date of an existing hold","summary":"Update existing hold","tags":["RETAIL"],"parameters":[{"name":"holdId","in":"path","type":"string","required":true,"description":"The transaction reference through which the specified amount in the transaction has been locked in an account"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"overrides":[{}],"holdTypeId":"/v1.0.0/reference/us/accountHoldTypes","description":"string","fromDate":"2024-01-01","toDate":"2024-01-01","lockedAmount":0.0,"blockPriorityId":"string","recordStatus":"string","currNo":0.0,"inputter":"string","dateTime":0.0,"authoriser":"string","companyId":"@ref:reference-companies-service-v1.0.0","deptCode":"@ref:reference-accountOfficers-service-v1.0.0","auditorCode":"string"}},"responses":{"200":"AccountBalanceHoldResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/order/us/payments/accounts/{accountId}/holdSummary","fullPath":"/api/v7.0.0/order/us/payments/accounts/{accountId}/holdSummary","operationId":"getAccountHoldDetails","name":"Retrieves details of all holds placed on an account","summary":"Get hold summary","tags":["RETAIL"],"parameters":[{"name":"accountId","in":"path","type":"string","required":true,"description":"Identifier of the account. Often referred to as the account number, yet for consistency this is always referred to as accountId. Accepts both IBAN & BBAN"},{"name":"holdTypeId","in":"query","type":"string","required":false,"description":"Purpose or the type of hold placed on the account  The available list of hold types can be retrieved through getHoldTypes"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"AccountHoldDetailsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"POST","path":"/order/us/payments/transactionStops","fullPath":"/api/v7.0.0/order/us/payments/transactionStops","operationId":"createUsTransactionStop","name":"Create transaction stop instruction to capture instructions to stop a payment based on the payment type, recipient or amount","summary":"Create transaction stop instruction","tags":["RETAIL"],"parameters":[{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"stopCondition":[{}],"accountId":"@ref:product-accountOperationalDate-service-v1.0.0","stopTypeId":"string","transactionChannel":"string","stopInstructionChannel":"BANK","stopReason":"CHKDES","issueDate":"string","replacementCheck":"string","replacementCheckIssueDate":"string","expiryDate":"string","waiveCharge":"string","transactionStopStatus":"ACTIVE","suppressNotice":"string","cancelInstruction":"YES","override":"string"}},"responses":{"200":"UsTransactionStopResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"DELETE","path":"/order/us/payments/transactionStops/{stopInstructionId}","fullPath":"/api/v7.0.0/order/us/payments/transactionStops/{stopInstructionId}","operationId":"deleteUsTransactionStop","name":"Deletes a transaction stop instruction capturing with instructions to stop a payment","summary":"Delete transaction stop","tags":["RETAIL"],"parameters":[{"name":"stopInstructionId","in":"path","type":"string","required":true,"description":"ID of stop instruction"},{"name":"payload","in":"body","type":"object","required":false,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}}},"responses":{"200":"UsTransactionStopResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"POST","path":"/order/us/payments/wireTransfers","fullPath":"/api/v7.0.0/order/us/payments/wireTransfers","operationId":"createFedwireCTR","name":"Creates an instant payment through  fedwire of payment type CTR, customer transfer","summary":"Creates a customer transfer through wire payment","tags":["RETAIL"],"parameters":[{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"orderingCustomerAddressLines":[{}],"beneficiaryInstituteAddressLines":[{}],"beneficiaryAddressLines":[{}],"intermediaryFiNameAddressLines":[{}],"OriginatorToBeneficiaryLines":[{}],"receiverFiAndIntermediaryFiLines":[{}],"adviceInformation":[{}],"InformationLines":[{}],"charges":[{}],"overrides":[{}],"paymentPriority":"/v1.0.0/reference/lookups?virtualTableName=PAYMENT.SERVICE.LEVEL.CODE","orderingCustomerId":"string","debitAccountId":"string","schedulePaymentAmount":0.0,"debitValueDate":"2024-01-01"}},"responses":{"200":"FedwireCTRResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"POST","path":"/order/us/payments/paymentOrders","fullPath":"/api/v7.0.0/order/us/payments/paymentOrders","operationId":"createUsDomesticTransfer","name":"Create one-time domestic account transfers and bill payments through ACH Clearing and the interbank automated clearing house","summary":"Create domestic transfer","tags":["RETAIL"],"parameters":[{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"standardEntryClassCode":"CIE","companyEntryDescription":"string","debitAccountId":"string","transactionAmount":0.0,"requiredCreditValueDate":"2024-01-01","beneficiaryId":"/v1.0.0/party/us/customers/{customerId}/beneficiaries","transactionCode":0.0,"beneficiaryOtherId":"string","accountWithBankClearingCode":"string","beneficiaryAccountId":"string","beneficiaryName":"string","narrative":"string","paymentCurrency":"string","paymentOrderProductId":"string","recordStatus":"string"}},"responses":{"200":"UsDomesticTransferResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"POST","path":"/order/us/payments/standingOrders/{accountId}","fullPath":"/api/v7.0.0/order/us/payments/standingOrders/{accountId}","operationId":"createUsRecurringTransfers","name":"Create a recurring account transfer","summary":"Create recurring transfer","tags":["RETAIL"],"parameters":[{"name":"accountId","in":"path","type":"string","required":true,"description":"Identifier of the account. Often referred to as the account number, yet for consistency this is always referred to as accountId. Accepts both IBAN & BBAN"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"beneficiaries":[{}],"currentFrequency":"string","standardEntryClassCode":"CIE","startDate":"2024-01-01","companyEntryDescription":"string","currentEndDate":"2024-01-01","currentAmountBalance":0.0,"beneficiaryId":"/v1.0.0/party/us/customers/{customerId}/beneficiaries","transactionCode":0.0,"beneficiaryOtherId":"string","accountWithBankClearingCode":"string","beneficiaryAccountId":"string","paymentDetail":"string","recordStatus":"string","currNo":"string"}},"responses":{"200":"UsRecurringTransfersResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"POST","path":"/order/us/payments/directDebits/{accountId}","fullPath":"/api/v7.0.0/order/us/payments/directDebits/{accountId}","operationId":"createUsDirectDebits","name":"Create direct debit instructions for repayment of loans or bill payment through external accounts","summary":"Create direct debit instruction","tags":["RETAIL"],"parameters":[{"name":"accountId","in":"path","type":"string","required":true,"description":"Identifier of the account. Often referred to as the account number, yet for consistency this is always referred to as accountId. Accepts both IBAN & BBAN"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"displayName":"string","directDebitParameterId":"string","serviceClassCode":0.0,"standardEntryClassCode":"PPD","debitAccountType":"string","debitBankClearingCode":"string","destinationAccountId":"string","debitorName":"string","frequency":"string","paymentDetail":"string","currencyMarket":"string","terminationDate":"2024-01-01","direction":"string","standAloneDdi":"string","standaloneAmount":0.0}},"responses":{"200":"UsDirectDebitsResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/order/us/payments/directDebits","fullPath":"/api/v7.0.0/order/us/payments/directDebits","operationId":"getUsDirectDebits","name":"Retrieve the list of direct debits initiated for repayment of bills or loans from external accounts","summary":"Retrieve direct debits setup for an account","tags":["RETAIL"],"parameters":[{"name":"customerId","in":"query","type":"string","required":false,"description":"Identifier of the customer"},{"name":"directDebitParameterId","in":"query","type":"string","required":false,"description":"Reference to the parameter which holds details relating to clearing accounts, number of days before which the claim has to be submitted or resubmitted"},{"name":"frequency","in":"query","type":"string","required":false,"description":"Specifies the frequency in which the payment application(periodic payments) execute the payment instruction."},{"name":"accountId","in":"query","type":"string","required":false,"description":"Identifier of the account. Often referred to as the account number, yet for consistency this is always referred to as accountId. Accepts both IBAN & BBAN"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"UsDirectDebitsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/order/us/payments/standingOrders","fullPath":"/api/v7.0.0/order/us/payments/standingOrders","operationId":"getUsRecurringTransfers","name":"Retrieve recurring payments setup for account transfers and bill payments","summary":"Get recurring transfer details","tags":["RETAIL"],"parameters":[{"name":"orderingCustomerId","in":"query","type":"string","required":false,"description":"Indicates the customer id for the ordering customer"},{"name":"paymentOrderProductName","in":"query","type":"string","required":false,"description":"Indicates the name of payment order product "},{"name":"accountId","in":"query","type":"string","required":false,"description":"Identifier of the account. Often referred to as the account number, yet for consistency this is always referred to as accountId. Accepts both IBAN & BBAN"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"UsRecurringTransfersResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"POST","path":"/order/us/payments/wireTransfers/simulate","fullPath":"/api/v7.0.0/order/us/payments/wireTransfers/simulate","operationId":"simulateFedwireCTR","name":"Validate payment order transaction to verify the information provided and to retrieve the applicable charges","summary":"Validate payment order transaction ","tags":["RETAIL"],"parameters":[{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"orderingCustomerAddressLines":[{}],"beneficiaryInstituteAddressLines":[{}],"beneficiaryAddressLines":[{}],"intermediaryFiNameAddressLines":[{}],"OriginatorToBeneficiaryLines":[{}],"receiverFiAndIntermediaryFiLines":[{}],"adviceInformation":[{}],"InformationLines":[{}],"charges":[{}],"overrides":[{}],"paymentPriority":"/v1.0.0/reference/lookups?virtualTableName=PAYMENT.SERVICE.LEVEL.CODE","orderingCustomerId":"string","debitAccountId":"string","schedulePaymentAmount":0.0,"debitValueDate":"2024-01-01"}},"responses":{"200":"FedwireCTRResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/order/us/payments/paymentStatus","fullPath":"/api/v7.0.0/order/us/payments/paymentStatus","operationId":"getUsPaymentsStatus","name":"Retrieve payment status and transaction history for an account along with beneficiary details and beneficiary status","summary":"Retrieve payment history","tags":["RETAIL"],"parameters":[{"name":"fromDate","in":"query","type":"string","required":false,"description":"Indicates the business date from when the balance reservation event is active."},{"name":"status","in":"query","type":"string","required":false,"description":"The status of the early maturity request"},{"name":"orderingCustomerId","in":"query","type":"string","required":false,"description":"Indicates the customer id for the ordering customer"},{"name":"debitAccountId","in":"query","type":"string","required":false,"description":"Indicates the debit account number of the payment or transaction."},{"name":"paymentOrderId","in":"query","type":"string","required":false,"description":"The unique reference number of payment"},{"name":"transactionReference","in":"query","type":"string","required":false,"description":"Contains the identifier for the transaction in the core system"},{"name":"paymentStatus","in":"query","type":"string","required":false,"description":"Describes the current status of the payment order in the payment system"},{"name":"toDate","in":"query","type":"string","required":false,"description":"Indicates the business date until when the balance reservation event is active."},{"name":"beneficiaryId","in":"query","type":"string","required":false,"description":"Indicates the reference of the financial institution that allows access to the beneficiary information"},{"name":"beneficiaryAccountId","in":"query","type":"string","required":false,"description":"Unique account identifier of the beneficiary account number."},{"name":"direction","in":"query","type":"string","required":false,"description":"Indicates the direction of the Direct debit claim for which mandate is received. The claim can be 'Outward' i.e. Claim is sent to the other bank or 'Inward'  i.e. other bank submit their claim to debi"},{"name":"paymentOrderProductId","in":"query","type":"string","required":false,"description":"Indicates the payment order product for which payment is initiated"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"UsPaymentsStatusResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"POST","path":"/order/us/payments/microDeposits","fullPath":"/api/v7.0.0/order/us/payments/microDeposits","operationId":"createUsACHBatchMicroDeposits","name":"Create a microdeposit batch to validate external account for a new beneficiary added by customer","summary":"Create a microdeposit batch to validate external account","tags":["RETAIL"],"parameters":[{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"entryDetails":[{}],"accountType":"string","recordStatus":"string","currNo":"string","inputter":"string","dateTime":"string","authoriser":"string","companyId":"string","deptCOde":"string","auditorCode":"string","auditTimeDate":"string","extensions":{}}},"responses":{"200":"UsACHBatchMicroDepositsResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/order/us/payments/customers/{orderingCustomerId}/directDebits/achDebits","fullPath":"/api/v7.0.0/order/us/payments/customers/{orderingCustomerId}/directDebits/achDebits","operationId":"getUsACHBatchAchDebits","name":"Retrieve list of customer initiated debit request to external accounts processed through ACH clearing and the interbank automated clearing house","summary":"Retrieve list of customer initiated debit request to external accounts","tags":["RETAIL"],"parameters":[{"name":"orderingCustomerId","in":"path","type":"string","required":true,"description":"Indicates the customer id for the ordering customer"},{"name":"effectiveDate","in":"query","type":"string","required":false,"description":"Contains the identifier for the transaction date. Dates are expected in \u00e2\u20ac\u02dcYYYYMMDD\u00e2\u20ac\u2122 format"},{"name":"creditAccountId","in":"query","type":"string","required":false,"description":"Credit account identifier of the payment or transaction"},{"name":"transactionCode","in":"query","type":"string","required":false,"description":"Identifies the system internal transaction code applicable to the transaction"},{"name":"amount","in":"query","type":"string","required":false,"description":"Contains the direct debit claim amount"},{"name":"beneficiaryInstituteRoutingNo","in":"query","type":"string","required":false,"description":"Routing number of DDA number of the Financial institution where the beneficiary account exists"},{"name":"debitAccountId","in":"query","type":"string","required":false,"description":"Indicates the debit account number of the payment or transaction."},{"name":"debitorName","in":"query","type":"string","required":false,"description":"The name of the customer who owns the destination account or the debit account used to collect payments"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"UsACHBatchAchDebitsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"POST","path":"/order/us/payments/wireTransfers/cancel/{transactionReference}","fullPath":"/api/v7.0.0/order/us/payments/wireTransfers/cancel/{transactionReference}","operationId":"reverseUsWireTransfer","name":"Request can be sent to initiate cancellation for a wire transfer within 30 minutes of submitting the wire payment","summary":"Initiate request to cancel wire transfer","tags":["RETAIL"],"parameters":[{"name":"transactionReference","in":"path","type":"string","required":true,"description":"Contains the identifier for the transaction in the core system"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"overrideDetails":[{}],"inputter":[{}],"dateTime":[{}],"transactionReference":"string","processingDate":"2024-01-01","statusCode":0.0,"sendersReference":"string","orderingAccount":"string","orderingName":"string","debitCustomerId":0.0,"recordStatus":"string","currNo":0.0,"authoriser":"string","companyCode":"string","deptCode":"string"}},"responses":{"200":"UsWireTransferResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"POST","path":"/order/us/payments/swiftTransfers/cancel/{transactionReference}","fullPath":"/api/v7.0.0/order/us/payments/swiftTransfers/cancel/{transactionReference}","operationId":"cancelSwiftTransaction","name":"Request to cancel international payments initiated within 30 minutes of submitting the payment","summary":"Initiate request to cancel international transfers","tags":["RETAIL"],"parameters":[{"name":"transactionReference","in":"path","type":"string","required":true,"description":"Contains the identifier for the transaction in the core system"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"inputter":[{}],"dateTime":[{}],"companyId":"string","transactionReference":"string","amount":0.0,"currencyId":"string","paymentMsgSentDate":"2024-01-01","outputChannel":"string","statusCode":"string","recordStatus":"string","currNo":0.0,"authoriser":"string","companyCode":"string","deptCode":"string","auditorCode":"string"}},"responses":{"200":"SwiftTransactionResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/order/us/payments/achEntry/{achEntryId}/achEntryStatus","fullPath":"/api/v7.0.0/order/us/payments/achEntry/{achEntryId}/achEntryStatus","operationId":"updateAchNOCEntriesStatus","name":"Allows to update the ACH entries status to processed","summary":"Allows to update the ACH entries status to processed","tags":["RETAIL"],"parameters":[{"name":"achEntryId","in":"path","type":"string","required":true,"description":""},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"achEntryStatus":"string","paymentOrderId":"string","transactionReference":"string","executionDate":"string","deliveryByDate":"string","creditDebitIndicator":"string","beneficiaryInstituteRoutingNo":"string","beneficiaryName":"string","beneficiaryOtherId":"string","accountId":"string","paymentAmount":"string","standardEntryClassCode":"string","extensions":{}}},"responses":{"200":"AchNOCEntriesStatusResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"POST","path":"/order/us/payments/directDebits/achDebits","fullPath":"/api/v7.0.0/order/us/payments/directDebits/achDebits","operationId":"createUsAchSameDayDebits","name":"Initiates same day ACH debit collection transaction","summary":"Initiates same day debit transfers","tags":["RETAIL"],"parameters":[{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"creditAccountId":"string","amount":"string","effectiveDate":"string","debitBankClearingCode":"string","debitAccountId":"string","debitorName":"string","additionalInformation":"string","standardEntryClassCode":"CCD","debitAccountType":"Checking","customerType":"Business","companyEntryDescription":"string","extensions":{}}},"responses":{"200":"UsAchSameDayDebitsResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/order/us/payments/wireTransfers/accounts/{debitAccountId}/mandates","fullPath":"/api/v7.0.0/order/us/payments/wireTransfers/accounts/{debitAccountId}/mandates","operationId":"getUsDrawdownMandates","name":"Retrieves all the available drawdown authorization or mandates for an account.","summary":"Retrieves drawdown mandates ","tags":["RETAIL"],"parameters":[{"name":"debitAccountId","in":"path","type":"string","required":true,"description":"Indicates the debit account number of the payment or transaction."},{"name":"beneficiaryAccountId","in":"query","type":"string","required":false,"description":"Unique account identifier of the beneficiary account number."},{"name":"routingNumber","in":"query","type":"string","required":false,"description":"Indicates the routing number of the bank where the account is held"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"UsDrawdownMandatesResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"POST","path":"/order/us/payments/wireTransfers/mandates","fullPath":"/api/v7.0.0/order/us/payments/wireTransfers/mandates","operationId":"createUsDrawdownMandate","name":"Allows to create a drawdown authorization for a customer for approving automatic drawdown transfer via wire payment to debit their account based on a drawdown request (1031 or 1631) received from the creditor's financial institution. The authorization form or the mandate form captures the credit account number, the financial institution where the creditor account is held, the purpose for which the debit request will be sent, the maximum amount allowed to be debited upon a drawdown request and th","summary":"Allows to create a drawdown authorization","tags":["RETAIL"],"parameters":[{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"debitAccountId":"string","debitAccountName":"string","beneficiaryAccountId":"string","drawdownAmount":0.0,"beneficiaryInstituteName":"string","routingNumber":"string","beneficiaryName":"string","accountType":"/v1.0.0/reference/lookups?virtualTableName=USRTGS.ACCT.TYPE","beneficiaryAddress":"string","receiverFiAndIntermediaryFiInfo":"string","effectiveFromDate":"2024-01-01","effectiveToDate":"2024-01-01","extensions":{}}},"responses":{"200":"UsDrawdownMandateResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/order/us/payments/wireTransfers/{mandateId}/mandates","fullPath":"/api/v7.0.0/order/us/payments/wireTransfers/{mandateId}/mandates","operationId":"updateUsDrawdownMandate","name":"Allows to update existing drawdown authorization or mandate created for a customer to approve automatic drawdown transfer via wire payment to debit their account and crediting an external account","summary":"Allows to update existing drawdown authorization","tags":["RETAIL"],"parameters":[{"name":"mandateId","in":"path","type":"string","required":true,"description":""},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"debitAccountId":"string","debitAccountName":"string","beneficiaryAccountId":"string","drawdownAmount":0.0,"beneficiaryInstituteName":"string","routingNumber":"string","beneficiaryName":"string","accountType":"/v1.0.0/reference/lookups?virtualTableName=USRTGS.ACCT.TYPE","beneficiaryAddress":"string","receiverFiAndIntermediaryFiInfo":"string","effectiveFromDate":"2024-01-01","effectiveToDate":"2024-01-01","extensions":{}}},"responses":{"200":"UsDrawdownMandateResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}}]},{"key":"order-us-payments-service-v7.1.0","title":"Same day debits","version":"v7.1.0","description":"Initiates same day debit transfers","endpointCount":24,"endpoints":[{"method":"POST","path":"/order/us/payments/escrows","fullPath":"/api/v7.1.0/order/us/payments/escrows","operationId":"createEscrowAdhocDeposit","name":"Initiates an escrow payment transaction","summary":"Escrow payment","tags":["RETAIL"],"parameters":[{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"overrideDetails":[{}],"creditAccountId":"@ref:product-accountOperationalDate-service-v1.0.0","creditValueDate":"2024-01-01","creditCurrencyId":"string","creditAmount":0.0,"debitAccountId":"@ref:product-accountOperationalDate-service-v1.0.0","debitValueDate":"2024-01-01","debitCurrencyId":"string","debitAmount":0.0,"treasuryRate":0.0,"processingDate":"2024-01-01","customerRate":0.0,"customerSpread":0.0,"recordStatus":"string","currNo":0.0}},"responses":{"200":"EscrowAdhocDepositResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"POST","path":"/order/us/accounts/{accountId}/reservedFunds","fullPath":"/api/v7.1.0/order/us/accounts/{accountId}/reservedFunds","operationId":"createAccountBalanceHold","name":"Create a hold transaction to lock the funds in an account","summary":"Create account hold","tags":["RETAIL"],"parameters":[{"name":"accountId","in":"path","type":"string","required":true,"description":"Identifier of the account. Often referred to as the account number, yet for consistency this is always referred to as accountId. Accepts both IBAN & BBAN"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"overrides":[{}],"holdTypeId":"/v1.0.0/reference/us/accountHoldTypes","description":"string","fromDate":"2024-01-01","toDate":"2024-01-01","lockedAmount":0.0,"blockPriorityId":"string","recordStatus":"string","currNo":0.0,"inputter":"string","dateTime":0.0,"authoriser":"string","companyId":"@ref:reference-companies-service-v1.0.0","deptCode":"@ref:reference-accountOfficers-service-v1.0.0","auditorCode":"string"}},"responses":{"200":"AccountBalanceHoldResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/order/us/accounts/reservedFunds/{holdId}","fullPath":"/api/v7.1.0/order/us/accounts/reservedFunds/{holdId}","operationId":"getAccountBalanceHold","name":"Retrieves information of the amount locked, lock type and the validity for a hold transaction","summary":"Retrieve hold funds detail","tags":["RETAIL"],"parameters":[{"name":"holdId","in":"path","type":"string","required":true,"description":"The transaction reference through which the specified amount in the transaction has been locked in an account"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"AccountBalanceHoldResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/order/us/payments/holds/{holdId}","fullPath":"/api/v7.1.0/order/us/payments/holds/{holdId}","operationId":"updateAccountBalanceHold","name":"Update amount or validity date of an existing hold","summary":"Update existing hold","tags":["RETAIL"],"parameters":[{"name":"holdId","in":"path","type":"string","required":true,"description":"The transaction reference through which the specified amount in the transaction has been locked in an account"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"overrides":[{}],"holdTypeId":"/v1.0.0/reference/us/accountHoldTypes","description":"string","fromDate":"2024-01-01","toDate":"2024-01-01","lockedAmount":0.0,"blockPriorityId":"string","recordStatus":"string","currNo":0.0,"inputter":"string","dateTime":0.0,"authoriser":"string","companyId":"@ref:reference-companies-service-v1.0.0","deptCode":"@ref:reference-accountOfficers-service-v1.0.0","auditorCode":"string"}},"responses":{"200":"AccountBalanceHoldResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/order/us/payments/accounts/{accountId}/holdSummary","fullPath":"/api/v7.1.0/order/us/payments/accounts/{accountId}/holdSummary","operationId":"getAccountHoldDetails","name":"Retrieves details of all holds placed on an account","summary":"Get hold summary","tags":["RETAIL"],"parameters":[{"name":"accountId","in":"path","type":"string","required":true,"description":"Identifier of the account. Often referred to as the account number, yet for consistency this is always referred to as accountId. Accepts both IBAN & BBAN"},{"name":"holdTypeId","in":"query","type":"string","required":false,"description":"Purpose or the type of hold placed on the account  The available list of hold types can be retrieved through getHoldTypes"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"AccountHoldDetailsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"POST","path":"/order/us/payments/transactionStops","fullPath":"/api/v7.1.0/order/us/payments/transactionStops","operationId":"createUsTransactionStop","name":"Create transaction stop instruction to capture instructions to stop a payment based on the payment type, recipient or amount","summary":"Create transaction stop instruction","tags":["RETAIL"],"parameters":[{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"stopCondition":[{}],"accountId":"@ref:product-accountOperationalDate-service-v1.0.0","stopTypeId":"string","transactionChannel":"string","stopInstructionChannel":"BANK","stopReason":"CHKDES","issueDate":"string","replacementCheck":"string","replacementCheckIssueDate":"string","expiryDate":"string","waiveCharge":"string","transactionStopStatus":"ACTIVE","suppressNotice":"string","cancelInstruction":"YES","override":"string"}},"responses":{"200":"UsTransactionStopResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"DELETE","path":"/order/us/payments/transactionStops/{stopInstructionId}","fullPath":"/api/v7.1.0/order/us/payments/transactionStops/{stopInstructionId}","operationId":"deleteUsTransactionStop","name":"Deletes a transaction stop instruction capturing with instructions to stop a payment","summary":"Delete transaction stop","tags":["RETAIL"],"parameters":[{"name":"stopInstructionId","in":"path","type":"string","required":true,"description":"ID of stop instruction"},{"name":"payload","in":"body","type":"object","required":false,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}}},"responses":{"200":"UsTransactionStopResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"POST","path":"/order/us/payments/wireTransfers","fullPath":"/api/v7.1.0/order/us/payments/wireTransfers","operationId":"createFedwireCTR","name":"Creates an instant payment through  fedwire of payment type CTR, customer transfer","summary":"Creates a customer transfer through wire payment","tags":["RETAIL"],"parameters":[{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"orderingCustomerAddressLines":[{}],"ultimateDebtorAddressLines":[{}],"beneficiaryInstituteAddressLines":[{}],"beneficiaryAddressLines":[{}],"intermediaryFiNameAddressLines":[{}],"intermediary2FiNameAddressLines":[{}],"OriginatorToBeneficiaryLines":[{}],"receiverFiAndIntermediaryFiLines":[{}],"adviceInformation":[{}],"InformationLines":[{}],"charges":[{}],"overrides":[{}],"paymentPriority":"/v1.0.0/reference/lookups?virtualTableName=PAYMENT.SERVICE.LEVEL.CODE","orderingCustomerId":"string","debitAccountId":"string"}},"responses":{"200":"FedwireCTRResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"POST","path":"/order/us/payments/paymentOrders","fullPath":"/api/v7.1.0/order/us/payments/paymentOrders","operationId":"createUsDomesticTransfer","name":"Create one-time domestic account transfers and bill payments through ACH Clearing and the interbank automated clearing house","summary":"Create domestic transfer","tags":["RETAIL"],"parameters":[{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"standardEntryClassCode":"CIE","companyEntryDescription":"string","debitAccountId":"string","transactionAmount":0.0,"requiredCreditValueDate":"2024-01-01","beneficiaryId":"/v1.0.0/party/us/customers/{customerId}/beneficiaries","transactionCode":0.0,"beneficiaryOtherId":"string","accountWithBankClearingCode":"string","beneficiaryAccountId":"string","beneficiaryName":"string","narrative":"string","paymentCurrency":"string","paymentOrderProductId":"string","recordStatus":"string"}},"responses":{"200":"UsDomesticTransferResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"POST","path":"/order/us/payments/standingOrders/{accountId}","fullPath":"/api/v7.1.0/order/us/payments/standingOrders/{accountId}","operationId":"createUsRecurringTransfers","name":"Create a recurring account transfer","summary":"Create recurring transfer","tags":["RETAIL"],"parameters":[{"name":"accountId","in":"path","type":"string","required":true,"description":"Identifier of the account. Often referred to as the account number, yet for consistency this is always referred to as accountId. Accepts both IBAN & BBAN"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"beneficiaries":[{}],"currentFrequency":"string","standardEntryClassCode":"CIE","startDate":"2024-01-01","companyEntryDescription":"string","currentEndDate":"2024-01-01","currentAmountBalance":0.0,"beneficiaryId":"/v1.0.0/party/us/customers/{customerId}/beneficiaries","transactionCode":0.0,"beneficiaryOtherId":"string","accountWithBankClearingCode":"string","beneficiaryAccountId":"string","paymentDetail":"string","recordStatus":"string","currNo":"string"}},"responses":{"200":"UsRecurringTransfersResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"POST","path":"/order/us/payments/directDebits/{accountId}","fullPath":"/api/v7.1.0/order/us/payments/directDebits/{accountId}","operationId":"createUsDirectDebits","name":"Create direct debit instructions for repayment of loans or bill payment through external accounts","summary":"Create direct debit instruction","tags":["RETAIL"],"parameters":[{"name":"accountId","in":"path","type":"string","required":true,"description":"Identifier of the account. Often referred to as the account number, yet for consistency this is always referred to as accountId. Accepts both IBAN & BBAN"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"displayName":"string","directDebitParameterId":"string","serviceClassCode":0.0,"standardEntryClassCode":"PPD","debitAccountType":"string","debitBankClearingCode":"string","destinationAccountId":"string","debitorName":"string","frequency":"string","paymentDetail":"string","currencyMarket":"string","terminationDate":"2024-01-01","direction":"string","standAloneDdi":"string","standaloneAmount":0.0}},"responses":{"200":"UsDirectDebitsResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/order/us/payments/directDebits","fullPath":"/api/v7.1.0/order/us/payments/directDebits","operationId":"getUsDirectDebits","name":"Retrieve the list of direct debits initiated for repayment of bills or loans from external accounts","summary":"Retrieve direct debits setup for an account","tags":["RETAIL"],"parameters":[{"name":"customerId","in":"query","type":"string","required":false,"description":"Identifier of the customer"},{"name":"directDebitParameterId","in":"query","type":"string","required":false,"description":"Reference to the parameter which holds details relating to clearing accounts, number of days before which the claim has to be submitted or resubmitted"},{"name":"frequency","in":"query","type":"string","required":false,"description":"Specifies the frequency in which the payment application(periodic payments) execute the payment instruction."},{"name":"accountId","in":"query","type":"string","required":false,"description":"Identifier of the account. Often referred to as the account number, yet for consistency this is always referred to as accountId. Accepts both IBAN & BBAN"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"UsDirectDebitsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/order/us/payments/standingOrders","fullPath":"/api/v7.1.0/order/us/payments/standingOrders","operationId":"getUsRecurringTransfers","name":"Retrieve recurring payments setup for account transfers and bill payments","summary":"Retrieve recurring transfer details","tags":["RETAIL"],"parameters":[{"name":"orderingCustomerId","in":"query","type":"string","required":false,"description":"Indicates the customer id for the ordering customer"},{"name":"paymentOrderProductName","in":"query","type":"string","required":false,"description":"Indicates the name of payment order product "},{"name":"accountId","in":"query","type":"string","required":false,"description":"Identifier of the account. Often referred to as the account number, yet for consistency this is always referred to as accountId. Accepts both IBAN & BBAN"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"UsRecurringTransfersResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"POST","path":"/order/us/payments/wireTransfers/simulate","fullPath":"/api/v7.1.0/order/us/payments/wireTransfers/simulate","operationId":"simulateFedwireCTR","name":"Validate payment order transaction to verify the information provided and to retrieve the applicable charges","summary":"Validate payment order transaction ","tags":["RETAIL"],"parameters":[{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"orderingCustomerAddressLines":[{}],"ultimateDebtorAddressLines":[{}],"beneficiaryInstituteAddressLines":[{}],"beneficiaryAddressLines":[{}],"intermediaryFiNameAddressLines":[{}],"intermediary2FiNameAddressLines":[{}],"OriginatorToBeneficiaryLines":[{}],"receiverFiAndIntermediaryFiLines":[{}],"adviceInformation":[{}],"InformationLines":[{}],"charges":[{}],"overrides":[{}],"paymentPriority":"/v1.0.0/reference/lookups?virtualTableName=PAYMENT.SERVICE.LEVEL.CODE","orderingCustomerId":"string","debitAccountId":"string"}},"responses":{"200":"FedwireCTRResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/order/us/payments/paymentStatus","fullPath":"/api/v7.1.0/order/us/payments/paymentStatus","operationId":"getUsPaymentsStatus","name":"Retrieve payment status and transaction history for an account along with beneficiary details and beneficiary status","summary":"Retrieve payment history","tags":["RETAIL"],"parameters":[{"name":"fromDate","in":"query","type":"string","required":false,"description":"Indicates the business date from when the balance reservation event is active."},{"name":"status","in":"query","type":"string","required":false,"description":"The status of the early maturity request"},{"name":"orderingCustomerId","in":"query","type":"string","required":false,"description":"Indicates the customer id for the ordering customer"},{"name":"debitAccountId","in":"query","type":"string","required":false,"description":"Indicates the debit account number of the payment or transaction."},{"name":"paymentOrderId","in":"query","type":"string","required":false,"description":"The unique reference number of payment"},{"name":"transactionReference","in":"query","type":"string","required":false,"description":"Contains the identifier for the transaction in the core system"},{"name":"paymentStatus","in":"query","type":"string","required":false,"description":"Describes the current status of the payment order in the payment system"},{"name":"toDate","in":"query","type":"string","required":false,"description":"Indicates the business date until when the balance reservation event is active."},{"name":"beneficiaryId","in":"query","type":"string","required":false,"description":"Indicates the reference of the financial institution that allows access to the beneficiary information"},{"name":"beneficiaryAccountId","in":"query","type":"string","required":false,"description":"Unique account identifier of the beneficiary account number."},{"name":"direction","in":"query","type":"string","required":false,"description":"Indicates the direction of the Direct debit claim for which mandate is received. The claim can be 'Outward' i.e. Claim is sent to the other bank or 'Inward'  i.e. other bank submit their claim to debi"},{"name":"paymentOrderProductId","in":"query","type":"string","required":false,"description":"Indicates the payment order product for which payment is initiated"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"UsPaymentsStatusResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"POST","path":"/order/us/payments/microDeposits","fullPath":"/api/v7.1.0/order/us/payments/microDeposits","operationId":"createUsACHBatchMicroDeposits","name":"Create a microdeposit batch to validate external account for a new beneficiary added by customer","summary":"Create a microdeposit batch to validate external account","tags":["RETAIL"],"parameters":[{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"entryDetails":[{}],"accountType":"string","recordStatus":"string","currNo":"string","inputter":"string","dateTime":"string","authoriser":"string","companyId":"string","deptCOde":"string","auditorCode":"string","auditTimeDate":"string","extensions":{}}},"responses":{"200":"UsACHBatchMicroDepositsResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/order/us/payments/customers/{orderingCustomerId}/directDebits/achDebits","fullPath":"/api/v7.1.0/order/us/payments/customers/{orderingCustomerId}/directDebits/achDebits","operationId":"getUsACHBatchAchDebits","name":"Retrieve list of customer initiated debit request to external accounts processed through ACH clearing and the interbank automated clearing house","summary":"Retrieve list of customer initiated debit request to external accounts","tags":["RETAIL"],"parameters":[{"name":"orderingCustomerId","in":"path","type":"string","required":true,"description":"Indicates the customer id for the ordering customer"},{"name":"effectiveDate","in":"query","type":"string","required":false,"description":"Contains the identifier for the transaction date. Dates are expected in \u00e2\u20ac\u02dcYYYYMMDD\u00e2\u20ac\u2122 format"},{"name":"creditAccountId","in":"query","type":"string","required":false,"description":"Credit account identifier of the payment or transaction"},{"name":"transactionCode","in":"query","type":"string","required":false,"description":"Identifies the system internal transaction code applicable to the transaction"},{"name":"amount","in":"query","type":"string","required":false,"description":"Contains the direct debit claim amount"},{"name":"beneficiaryInstituteRoutingNo","in":"query","type":"string","required":false,"description":"Routing number of DDA number of the Financial institution where the beneficiary account exists"},{"name":"debitAccountId","in":"query","type":"string","required":false,"description":"Indicates the debit account number of the payment or transaction."},{"name":"debitorName","in":"query","type":"string","required":false,"description":"The name of the customer who owns the destination account or the debit account used to collect payments"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"UsACHBatchAchDebitsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"POST","path":"/order/us/payments/wireTransfers/cancel/{transactionReference}","fullPath":"/api/v7.1.0/order/us/payments/wireTransfers/cancel/{transactionReference}","operationId":"reverseUsWireTransfer","name":"Request can be sent to initiate cancellation for a wire transfer within 30 minutes of submitting the wire payment","summary":"Initiate request to cancel wire transfer","tags":["RETAIL"],"parameters":[{"name":"transactionReference","in":"path","type":"string","required":true,"description":"Contains the identifier for the transaction in the core system"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"overrideDetails":[{}],"inputter":[{}],"dateTime":[{}],"transactionReference":"string","processingDate":"2024-01-01","statusCode":0.0,"sendersReference":"string","orderingAccount":"string","orderingName":"string","debitCustomerId":0.0,"recordStatus":"string","currNo":0.0,"authoriser":"string","companyCode":"string","deptCode":"string"}},"responses":{"200":"UsWireTransferResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"POST","path":"/order/us/payments/swiftTransfers/cancel/{transactionReference}","fullPath":"/api/v7.1.0/order/us/payments/swiftTransfers/cancel/{transactionReference}","operationId":"cancelSwiftTransaction","name":"Request to cancel international payments initiated within 30 minutes of submitting the payment","summary":"Initiate request to cancel international transfers","tags":["RETAIL"],"parameters":[{"name":"transactionReference","in":"path","type":"string","required":true,"description":"Contains the identifier for the transaction in the core system"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"inputter":[{}],"dateTime":[{}],"companyId":"string","transactionReference":"string","amount":0.0,"currencyId":"string","paymentMsgSentDate":"2024-01-01","outputChannel":"string","statusCode":"string","recordStatus":"string","currNo":0.0,"authoriser":"string","companyCode":"string","deptCode":"string","auditorCode":"string"}},"responses":{"200":"SwiftTransactionResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/order/us/payments/achEntry/{achEntryId}/achEntryStatus","fullPath":"/api/v7.1.0/order/us/payments/achEntry/{achEntryId}/achEntryStatus","operationId":"updateAchNOCEntriesStatus","name":"Allows to update the ACH entries status to processed","summary":"Allows to update the ACH entries status to processed","tags":["RETAIL"],"parameters":[{"name":"achEntryId","in":"path","type":"string","required":true,"description":""},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"achEntryStatus":"string","paymentOrderId":"string","transactionReference":"string","executionDate":"string","deliveryByDate":"string","creditDebitIndicator":"string","beneficiaryInstituteRoutingNo":"string","beneficiaryName":"string","beneficiaryOtherId":"string","accountId":"string","paymentAmount":"string","standardEntryClassCode":"string","extensions":{}}},"responses":{"200":"AchNOCEntriesStatusResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"POST","path":"/order/us/payments/directDebits/achDebits","fullPath":"/api/v7.1.0/order/us/payments/directDebits/achDebits","operationId":"createUsAchSameDayDebits","name":"Initiates same day ACH debit collection transaction","summary":"Initiates same day debit transfers","tags":["RETAIL"],"parameters":[{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"creditAccountId":"string","amount":"string","effectiveDate":"string","debitBankClearingCode":"string","debitAccountId":"string","debitorName":"string","additionalInformation":"string","standardEntryClassCode":"CCD","debitAccountType":"Checking","customerType":"Business","companyEntryDescription":"string","extensions":{}}},"responses":{"200":"UsAchSameDayDebitsResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/order/us/payments/wireTransfers/accounts/{debitAccountId}/mandates","fullPath":"/api/v7.1.0/order/us/payments/wireTransfers/accounts/{debitAccountId}/mandates","operationId":"getUsDrawdownMandates","name":"Retrieves all the available drawdown authorization or mandates for an account.","summary":"Retrieves drawdown mandates ","tags":["RETAIL"],"parameters":[{"name":"debitAccountId","in":"path","type":"string","required":true,"description":"Indicates the debit account number of the payment or transaction."},{"name":"beneficiaryAccountId","in":"query","type":"string","required":false,"description":"Unique account identifier of the beneficiary account number."},{"name":"routingNumber","in":"query","type":"string","required":false,"description":"Indicates the routing number of the bank where the account is held"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"UsDrawdownMandatesResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"POST","path":"/order/us/payments/wireTransfers/mandates","fullPath":"/api/v7.1.0/order/us/payments/wireTransfers/mandates","operationId":"createUsDrawdownMandate","name":"Allows to create a drawdown authorization for a customer for approving automatic drawdown transfer via wire payment to debit their account based on a drawdown request (1031 or 1631) received from the creditor's financial institution. The authorization form or the mandate form captures the credit account number, the financial institution where the creditor account is held, the purpose for which the debit request will be sent, the maximum amount allowed to be debited upon a drawdown request and th","summary":"Allows to create a drawdown authorization","tags":["RETAIL"],"parameters":[{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"debitAccountId":"string","debitAccountName":"string","beneficiaryAccountId":"string","drawdownAmount":0.0,"beneficiaryInstituteName":"string","routingNumber":"string","beneficiaryName":"string","accountType":"/v1.0.0/reference/lookups?virtualTableName=USRTGS.ACCT.TYPE","beneficiaryAddress":"string","receiverFiAndIntermediaryFiInfo":"string","effectiveFromDate":"2024-01-01","effectiveToDate":"2024-01-01","extensions":{}}},"responses":{"200":"UsDrawdownMandateResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/order/us/payments/wireTransfers/{mandateId}/mandates","fullPath":"/api/v7.1.0/order/us/payments/wireTransfers/{mandateId}/mandates","operationId":"updateUsDrawdownMandate","name":"Allows to update existing drawdown authorization or mandate created for a customer to approve automatic drawdown transfer via wire payment to debit their account and credit an external account","summary":"Allows to update existing drawdown authorization","tags":["RETAIL"],"parameters":[{"name":"mandateId","in":"path","type":"string","required":true,"description":""},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"debitAccountId":"string","debitAccountName":"string","beneficiaryAccountId":"string","drawdownAmount":0.0,"beneficiaryInstituteName":"string","routingNumber":"string","beneficiaryName":"string","accountType":"/v1.0.0/reference/lookups?virtualTableName=USRTGS.ACCT.TYPE","beneficiaryAddress":"string","receiverFiAndIntermediaryFiInfo":"string","effectiveFromDate":"2024-01-01","effectiveToDate":"2024-01-01","extensions":{}}},"responses":{"200":"UsDrawdownMandateResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}}]},{"key":"order-us-payments-service-v7.2.0","title":"Same day debits","version":"v7.2.0","description":"Initiates same day debit transfers","endpointCount":24,"endpoints":[{"method":"POST","path":"/order/us/payments/escrows","fullPath":"/api/v7.2.0/order/us/payments/escrows","operationId":"createEscrowAdhocDeposit","name":"Initiates an escrow payment transaction","summary":"Escrow payment","tags":["RETAIL"],"parameters":[{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"overrideDetails":[{}],"creditAccountId":"@ref:product-accountOperationalDate-service-v1.0.0","creditValueDate":"2024-01-01","creditCurrencyId":"string","creditAmount":0.0,"debitAccountId":"@ref:product-accountOperationalDate-service-v1.0.0","debitValueDate":"2024-01-01","debitCurrencyId":"string","debitAmount":0.0,"treasuryRate":0.0,"processingDate":"2024-01-01","customerRate":0.0,"customerSpread":0.0,"recordStatus":"string","currNo":0.0}},"responses":{"200":"EscrowAdhocDepositResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"POST","path":"/order/us/accounts/{accountId}/reservedFunds","fullPath":"/api/v7.2.0/order/us/accounts/{accountId}/reservedFunds","operationId":"createAccountBalanceHold","name":"Create a hold transaction to lock the funds in an account","summary":"Create account hold","tags":["RETAIL"],"parameters":[{"name":"accountId","in":"path","type":"string","required":true,"description":"Identifier of the account. Often referred to as the account number, yet for consistency this is always referred to as accountId. Accepts both IBAN & BBAN"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"overrides":[{}],"holdTypeId":"/v1.0.0/reference/us/accountHoldTypes","description":"string","fromDate":"2024-01-01","toDate":"2024-01-01","lockedAmount":0.0,"blockPriorityId":"string","recordStatus":"string","currNo":0.0,"inputter":"string","dateTime":0.0,"authoriser":"string","companyId":"@ref:reference-companies-service-v1.0.0","deptCode":"@ref:reference-accountOfficers-service-v1.0.0","auditorCode":"string"}},"responses":{"200":"AccountBalanceHoldResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/order/us/accounts/reservedFunds/{holdId}","fullPath":"/api/v7.2.0/order/us/accounts/reservedFunds/{holdId}","operationId":"getAccountBalanceHold","name":"Retrieves information of the amount locked, lock type and the validity for a hold transaction","summary":"Retrieve hold funds detail","tags":["RETAIL"],"parameters":[{"name":"holdId","in":"path","type":"string","required":true,"description":"The transaction reference through which the specified amount in the transaction has been locked in an account"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"AccountBalanceHoldResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/order/us/payments/holds/{holdId}","fullPath":"/api/v7.2.0/order/us/payments/holds/{holdId}","operationId":"updateAccountBalanceHold","name":"Update amount or validity date of an existing hold","summary":"Update existing hold","tags":["RETAIL"],"parameters":[{"name":"holdId","in":"path","type":"string","required":true,"description":"The transaction reference through which the specified amount in the transaction has been locked in an account"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"overrides":[{}],"holdTypeId":"/v1.0.0/reference/us/accountHoldTypes","description":"string","fromDate":"2024-01-01","toDate":"2024-01-01","lockedAmount":0.0,"blockPriorityId":"string","recordStatus":"string","currNo":0.0,"inputter":"string","dateTime":0.0,"authoriser":"string","companyId":"@ref:reference-companies-service-v1.0.0","deptCode":"@ref:reference-accountOfficers-service-v1.0.0","auditorCode":"string"}},"responses":{"200":"AccountBalanceHoldResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/order/us/payments/accounts/{accountId}/holdSummary","fullPath":"/api/v7.2.0/order/us/payments/accounts/{accountId}/holdSummary","operationId":"getAccountHoldDetails","name":"Retrieves details of all holds placed on an account","summary":"Get hold summary","tags":["RETAIL"],"parameters":[{"name":"accountId","in":"path","type":"string","required":true,"description":"Identifier of the account. Often referred to as the account number, yet for consistency this is always referred to as accountId. Accepts both IBAN & BBAN"},{"name":"holdTypeId","in":"query","type":"string","required":false,"description":"Purpose or the type of hold placed on the account  The available list of hold types can be retrieved through getHoldTypes"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"AccountHoldDetailsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"POST","path":"/order/us/payments/transactionStops","fullPath":"/api/v7.2.0/order/us/payments/transactionStops","operationId":"createUsTransactionStop","name":"Create transaction stop instruction to capture instructions to stop a payment based on the payment type, recipient or amount","summary":"Create transaction stop instruction","tags":["RETAIL"],"parameters":[{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"stopCondition":[{}],"accountId":"@ref:product-accountOperationalDate-service-v1.0.0","stopTypeId":"string","transactionChannel":"string","stopInstructionChannel":"BANK","stopReason":"CHKDES","issueDate":"string","replacementCheck":"string","replacementCheckIssueDate":"string","expiryDate":"string","waiveCharge":"string","transactionStopStatus":"ACTIVE","suppressNotice":"string","cancelInstruction":"YES","override":"string"}},"responses":{"200":"UsTransactionStopResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"DELETE","path":"/order/us/payments/transactionStops/{stopInstructionId}","fullPath":"/api/v7.2.0/order/us/payments/transactionStops/{stopInstructionId}","operationId":"deleteUsTransactionStop","name":"Deletes a transaction stop instruction capturing with instructions to stop a payment","summary":"Delete transaction stop","tags":["RETAIL"],"parameters":[{"name":"stopInstructionId","in":"path","type":"string","required":true,"description":"ID of stop instruction"},{"name":"payload","in":"body","type":"object","required":false,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}}},"responses":{"200":"UsTransactionStopResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"POST","path":"/order/us/payments/wireTransfers","fullPath":"/api/v7.2.0/order/us/payments/wireTransfers","operationId":"createFedwireCTR","name":"Creates an instant payment through  fedwire of payment type CTR, customer transfer","summary":"Creates a customer transfer through wire payment","tags":["RETAIL"],"parameters":[{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"orderingCustomerAddressLines":[{}],"ultimateDebtorAddressLines":[{}],"beneficiaryInstituteAddressLines":[{}],"beneficiaryAddressLines":[{}],"intermediaryFiNameAddressLines":[{}],"intermediary2FiNameAddressLines":[{}],"OriginatorToBeneficiaryLines":[{}],"receiverFiAndIntermediaryFiLines":[{}],"adviceInformation":[{}],"InformationLines":[{}],"charges":[{}],"overrides":[{}],"paymentPriority":"/v1.0.0/reference/lookups?virtualTableName=PAYMENT.SERVICE.LEVEL.CODE","orderingCustomerId":"string","debitAccountId":"string"}},"responses":{"200":"FedwireCTRResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"POST","path":"/order/us/payments/paymentOrders","fullPath":"/api/v7.2.0/order/us/payments/paymentOrders","operationId":"createUsDomesticTransfer","name":"Create one-time domestic account transfers and bill payments through ACH Clearing and the interbank automated clearing house","summary":"Create domestic transfer","tags":["RETAIL"],"parameters":[{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"standardEntryClassCode":"CIE","companyEntryDescription":"string","debitAccountId":"string","transactionAmount":0.0,"requiredCreditValueDate":"2024-01-01","beneficiaryId":"/v1.0.0/party/us/customers/{customerId}/beneficiaries","transactionCode":0.0,"beneficiaryOtherId":"string","accountWithBankClearingCode":"string","beneficiaryAccountId":"string","beneficiaryName":"string","narrative":"string","paymentCurrency":"string","paymentOrderProductId":"string","recordStatus":"string"}},"responses":{"200":"UsDomesticTransferResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"POST","path":"/order/us/payments/standingOrders/{accountId}","fullPath":"/api/v7.2.0/order/us/payments/standingOrders/{accountId}","operationId":"createUsRecurringTransfers","name":"Create a recurring account transfer","summary":"Create recurring transfer","tags":["RETAIL"],"parameters":[{"name":"accountId","in":"path","type":"string","required":true,"description":"Identifier of the account. Often referred to as the account number, yet for consistency this is always referred to as accountId. Accepts both IBAN & BBAN"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"beneficiaries":[{}],"currentFrequency":"string","standardEntryClassCode":"CIE","startDate":"2024-01-01","companyEntryDescription":"string","currentEndDate":"2024-01-01","currentAmountBalance":0.0,"beneficiaryId":"/v1.0.0/party/us/customers/{customerId}/beneficiaries","transactionCode":0.0,"beneficiaryOtherId":"string","accountWithBankClearingCode":"string","beneficiaryAccountId":"string","paymentDetail":"string","recordStatus":"string","currNo":"string"}},"responses":{"200":"UsRecurringTransfersResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"POST","path":"/order/us/payments/directDebits/{accountId}","fullPath":"/api/v7.2.0/order/us/payments/directDebits/{accountId}","operationId":"createUsDirectDebits","name":"Create direct debit instructions for repayment of loans or bill payment through external accounts","summary":"Create direct debit instruction","tags":["RETAIL"],"parameters":[{"name":"accountId","in":"path","type":"string","required":true,"description":"Identifier of the account. Often referred to as the account number, yet for consistency this is always referred to as accountId. Accepts both IBAN & BBAN"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"displayName":"string","directDebitParameterId":"string","serviceClassCode":0.0,"standardEntryClassCode":"PPD","debitAccountType":"string","debitBankClearingCode":"string","destinationAccountId":"string","debitorName":"string","frequency":"string","paymentDetail":"string","currencyMarket":"string","terminationDate":"2024-01-01","direction":"string","standAloneDdi":"string","standaloneAmount":0.0}},"responses":{"200":"UsDirectDebitsResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/order/us/payments/directDebits","fullPath":"/api/v7.2.0/order/us/payments/directDebits","operationId":"getUsDirectDebits","name":"Retrieve the list of direct debits initiated for repayment of bills or loans from external accounts","summary":"Retrieve direct debits setup for an account","tags":["RETAIL"],"parameters":[{"name":"customerId","in":"query","type":"string","required":false,"description":"Identifier of the customer"},{"name":"directDebitParameterId","in":"query","type":"string","required":false,"description":"Reference to the parameter which holds details relating to clearing accounts, number of days before which the claim has to be submitted or resubmitted"},{"name":"frequency","in":"query","type":"string","required":false,"description":"Specifies the frequency in which the payment application(periodic payments) execute the payment instruction."},{"name":"accountId","in":"query","type":"string","required":false,"description":"Identifier of the account. Often referred to as the account number, yet for consistency this is always referred to as accountId. Accepts both IBAN & BBAN"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"UsDirectDebitsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/order/us/payments/standingOrders","fullPath":"/api/v7.2.0/order/us/payments/standingOrders","operationId":"getUsRecurringTransfers","name":"Retrieve recurring payments setup for account transfers and bill payments","summary":"Get recurring transfer details","tags":["RETAIL"],"parameters":[{"name":"orderingCustomerId","in":"query","type":"string","required":false,"description":"Indicates the customer id for the ordering customer"},{"name":"paymentOrderProductName","in":"query","type":"string","required":false,"description":"Indicates the name of payment order product "},{"name":"accountId","in":"query","type":"string","required":false,"description":"Identifier of the account. Often referred to as the account number, yet for consistency this is always referred to as accountId. Accepts both IBAN & BBAN"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"UsRecurringTransfersResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"POST","path":"/order/us/payments/wireTransfers/simulate","fullPath":"/api/v7.2.0/order/us/payments/wireTransfers/simulate","operationId":"simulateFedwireCTR","name":"Validate payment order transaction to verify the information provided and to retrieve the applicable charges","summary":"Validate payment order transaction ","tags":["RETAIL"],"parameters":[{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"orderingCustomerAddressLines":[{}],"ultimateDebtorAddressLines":[{}],"beneficiaryInstituteAddressLines":[{}],"beneficiaryAddressLines":[{}],"intermediaryFiNameAddressLines":[{}],"intermediary2FiNameAddressLines":[{}],"OriginatorToBeneficiaryLines":[{}],"receiverFiAndIntermediaryFiLines":[{}],"adviceInformation":[{}],"InformationLines":[{}],"charges":[{}],"overrides":[{}],"paymentPriority":"/v1.0.0/reference/lookups?virtualTableName=PAYMENT.SERVICE.LEVEL.CODE","orderingCustomerId":"string","debitAccountId":"string"}},"responses":{"200":"FedwireCTRResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/order/us/payments/paymentStatus","fullPath":"/api/v7.2.0/order/us/payments/paymentStatus","operationId":"getUsPaymentsStatus","name":"Retrieve payment status and transaction history for an account along with beneficiary details and beneficiary status","summary":"Retrieve payment history","tags":["RETAIL"],"parameters":[{"name":"fromDate","in":"query","type":"string","required":false,"description":"Indicates the business date from when the balance reservation event is active."},{"name":"status","in":"query","type":"string","required":false,"description":"The status of the early maturity request"},{"name":"orderingCustomerId","in":"query","type":"string","required":false,"description":"Indicates the customer id for the ordering customer"},{"name":"debitAccountId","in":"query","type":"string","required":false,"description":"Indicates the debit account number of the payment or transaction."},{"name":"paymentOrderId","in":"query","type":"string","required":false,"description":"The unique reference number of payment"},{"name":"transactionReference","in":"query","type":"string","required":false,"description":"Contains the identifier for the transaction in the core system"},{"name":"paymentStatus","in":"query","type":"string","required":false,"description":"Describes the current status of the payment order in the payment system"},{"name":"toDate","in":"query","type":"string","required":false,"description":"Indicates the business date until when the balance reservation event is active."},{"name":"beneficiaryId","in":"query","type":"string","required":false,"description":"Indicates the reference of the financial institution that allows access to the beneficiary information"},{"name":"beneficiaryAccountId","in":"query","type":"string","required":false,"description":"Unique account identifier of the beneficiary account number."},{"name":"direction","in":"query","type":"string","required":false,"description":"Indicates the direction of the Direct debit claim for which mandate is received. The claim can be 'Outward' i.e. Claim is sent to the other bank or 'Inward'  i.e. other bank submit their claim to debi"},{"name":"paymentOrderProductId","in":"query","type":"string","required":false,"description":"Indicates the payment order product for which payment is initiated"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"UsPaymentsStatusResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"POST","path":"/order/us/payments/microDeposits","fullPath":"/api/v7.2.0/order/us/payments/microDeposits","operationId":"createUsACHBatchMicroDeposits","name":"Create a microdeposit batch to validate external account for a new beneficiary added by customer","summary":"Create a microdeposit batch to validate external account","tags":["RETAIL"],"parameters":[{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"entryDetails":[{}],"accountType":"string","recordStatus":"string","currNo":"string","inputter":"string","dateTime":"string","authoriser":"string","companyId":"string","deptCOde":"string","auditorCode":"string","auditTimeDate":"string","extensions":{}}},"responses":{"200":"UsACHBatchMicroDepositsResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/order/us/payments/customers/{orderingCustomerId}/directDebits/achDebits","fullPath":"/api/v7.2.0/order/us/payments/customers/{orderingCustomerId}/directDebits/achDebits","operationId":"getUsACHBatchAchDebits","name":"Retrieve list of customer initiated debit request to external accounts processed through ACH clearing and the interbank automated clearing house","summary":"Retrieve list of customer initiated debit request to external accounts","tags":["RETAIL"],"parameters":[{"name":"orderingCustomerId","in":"path","type":"string","required":true,"description":"Indicates the customer id for the ordering customer"},{"name":"effectiveDate","in":"query","type":"string","required":false,"description":"Contains the identifier for the transaction date. Dates are expected in \u00e2\u20ac\u02dcYYYYMMDD\u00e2\u20ac\u2122 format"},{"name":"creditAccountId","in":"query","type":"string","required":false,"description":"Credit account identifier of the payment or transaction"},{"name":"transactionCode","in":"query","type":"string","required":false,"description":"Identifies the system internal transaction code applicable to the transaction"},{"name":"amount","in":"query","type":"string","required":false,"description":"Contains the direct debit claim amount"},{"name":"beneficiaryInstituteRoutingNo","in":"query","type":"string","required":false,"description":"Routing number of DDA number of the Financial institution where the beneficiary account exists"},{"name":"debitAccountId","in":"query","type":"string","required":false,"description":"Indicates the debit account number of the payment or transaction."},{"name":"debitorName","in":"query","type":"string","required":false,"description":"The name of the customer who owns the destination account or the debit account used to collect payments"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"UsACHBatchAchDebitsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"POST","path":"/order/us/payments/wireTransfers/cancel/{transactionReference}","fullPath":"/api/v7.2.0/order/us/payments/wireTransfers/cancel/{transactionReference}","operationId":"reverseUsWireTransfer","name":"Request can be sent to initiate cancellation for a wire transfer within 30 minutes of submitting the wire payment","summary":"Initiate request to cancel wire transfer","tags":["RETAIL"],"parameters":[{"name":"transactionReference","in":"path","type":"string","required":true,"description":"Contains the identifier for the transaction in the core system"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"overrideDetails":[{}],"inputter":[{}],"dateTime":[{}],"transactionReference":"string","processingDate":"2024-01-01","statusCode":0.0,"sendersReference":"string","orderingAccount":"string","orderingName":"string","debitCustomerId":0.0,"recordStatus":"string","currNo":0.0,"authoriser":"string","companyCode":"string","deptCode":"string"}},"responses":{"200":"UsWireTransferResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"POST","path":"/order/us/payments/swiftTransfers/cancel/{transactionReference}","fullPath":"/api/v7.2.0/order/us/payments/swiftTransfers/cancel/{transactionReference}","operationId":"cancelSwiftTransaction","name":"Request to cancel international payments initiated within 30 minutes of submitting the payment","summary":"Initiate request to cancel international transfers","tags":["RETAIL"],"parameters":[{"name":"transactionReference","in":"path","type":"string","required":true,"description":"Contains the identifier for the transaction in the core system"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"inputter":[{}],"dateTime":[{}],"companyId":"string","transactionReference":"string","amount":0.0,"currencyId":"string","paymentMsgSentDate":"2024-01-01","outputChannel":"string","statusCode":"string","recordStatus":"string","currNo":0.0,"authoriser":"string","companyCode":"string","deptCode":"string","auditorCode":"string"}},"responses":{"200":"SwiftTransactionResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/order/us/payments/achEntry/{achEntryId}/achEntryStatus","fullPath":"/api/v7.2.0/order/us/payments/achEntry/{achEntryId}/achEntryStatus","operationId":"updateAchNOCEntriesStatus","name":"Allows to update the ACH entries status to processed","summary":"Allows to update the ACH entries status to processed","tags":["RETAIL"],"parameters":[{"name":"achEntryId","in":"path","type":"string","required":true,"description":""},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"achEntryStatus":"string","paymentOrderId":"string","transactionReference":"string","executionDate":"string","deliveryByDate":"string","creditDebitIndicator":"string","beneficiaryInstituteRoutingNo":"string","beneficiaryName":"string","beneficiaryOtherId":"string","accountId":"string","paymentAmount":"string","standardEntryClassCode":"string","extensions":{}}},"responses":{"200":"AchNOCEntriesStatusResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"POST","path":"/order/us/payments/directDebits/achDebits","fullPath":"/api/v7.2.0/order/us/payments/directDebits/achDebits","operationId":"createUsAchSameDayDebits","name":"Initiates same day ACH debit collection transaction","summary":"Initiates same day debit transfers","tags":["RETAIL"],"parameters":[{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"creditAccountId":"string","amount":"string","effectiveDate":"string","debitBankClearingCode":"string","debitAccountId":"string","debitorName":"string","additionalInformation":"string","standardEntryClassCode":"CCD","debitAccountType":"Checking","customerType":"Business","companyEntryDescription":"string","extensions":{}}},"responses":{"200":"UsAchSameDayDebitsResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/order/us/payments/wireTransfers/accounts/{debitAccountId}/mandates","fullPath":"/api/v7.2.0/order/us/payments/wireTransfers/accounts/{debitAccountId}/mandates","operationId":"getUsDrawdownMandates","name":"Retrieves all the available drawdown authorization or mandates for an account.","summary":"Retrieves drawdown mandates ","tags":["RETAIL"],"parameters":[{"name":"debitAccountId","in":"path","type":"string","required":true,"description":"Indicates the debit account number of the payment or transaction."},{"name":"beneficiaryAccountId","in":"query","type":"string","required":false,"description":"Unique account identifier of the beneficiary account number."},{"name":"routingNumber","in":"query","type":"string","required":false,"description":"Indicates the routing number of the bank where the account is held"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"UsDrawdownMandatesResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"POST","path":"/order/us/payments/wireTransfers/mandates","fullPath":"/api/v7.2.0/order/us/payments/wireTransfers/mandates","operationId":"createUsDrawdownMandate","name":"Allows to create a drawdown authorization for a customer for approving automatic drawdown transfer via wire payment to debit their account based on a drawdown request (1031 or 1631) received from the creditor's financial institution. The authorization form or the mandate form captures the credit account number, the financial institution where the creditor account is held, the purpose for which the debit request will be sent, the maximum amount allowed to be debited upon a drawdown request and th","summary":"Allows to create a drawdown authorization","tags":["RETAIL"],"parameters":[{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"debitAccountId":"string","debitAccountName":"string","beneficiaryAccountId":"string","drawdownAmount":0.0,"beneficiaryInstituteName":"string","routingNumber":"string","beneficiaryName":"string","accountType":"/v1.0.0/reference/lookups?virtualTableName=USRTGS.ACCT.TYPE","beneficiaryAddress":"string","receiverFiAndIntermediaryFiInfo":"string","effectiveFromDate":"2024-01-01","effectiveToDate":"2024-01-01","extensions":{}}},"responses":{"200":"UsDrawdownMandateResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/order/us/payments/wireTransfers/{mandateId}/mandates","fullPath":"/api/v7.2.0/order/us/payments/wireTransfers/{mandateId}/mandates","operationId":"updateUsDrawdownMandate","name":"Allows to update existing drawdown authorization or mandate created for a customer to approve automatic drawdown transfer via wire payment to debit their account and crediting an external account","summary":"Allows to update existing drawdown authorization","tags":["RETAIL"],"parameters":[{"name":"mandateId","in":"path","type":"string","required":true,"description":""},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"debitAccountId":"string","debitAccountName":"string","beneficiaryAccountId":"string","drawdownAmount":0.0,"beneficiaryInstituteName":"string","routingNumber":"string","beneficiaryName":"string","accountType":"/v1.0.0/reference/lookups?virtualTableName=USRTGS.ACCT.TYPE","beneficiaryAddress":"string","receiverFiAndIntermediaryFiInfo":"string","effectiveFromDate":"2024-01-01","effectiveToDate":"2024-01-01","extensions":{}}},"responses":{"200":"UsDrawdownMandateResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}}]},{"key":"order-us-payments-service-v8.0.0","title":"Same day debits","version":"v8.0.0","description":"Initiates same day debit transfers","endpointCount":25,"endpoints":[{"method":"POST","path":"/order/us/payments/escrows","fullPath":"/api/v8.0.0/order/us/payments/escrows","operationId":"createEscrowAdhocDeposit","name":"Initiates an escrow payment transaction","summary":"Escrow payment","tags":["RETAIL"],"parameters":[{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"overrideDetails":[{}],"creditAccountId":"@ref:product-accountOperationalDate-service-v1.0.0","creditValueDate":"2024-01-01","creditCurrencyId":"string","creditAmount":0.0,"debitAccountId":"@ref:product-accountOperationalDate-service-v1.0.0","debitValueDate":"2024-01-01","debitCurrencyId":"string","debitAmount":0.0,"treasuryRate":0.0,"processingDate":"2024-01-01","customerRate":0.0,"customerSpread":0.0,"recordStatus":"string","currNo":0.0}},"responses":{"200":"EscrowAdhocDepositResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"POST","path":"/order/us/accounts/{accountId}/reservedFunds","fullPath":"/api/v8.0.0/order/us/accounts/{accountId}/reservedFunds","operationId":"createAccountBalanceHold","name":"Create a hold transaction to lock the funds in an account","summary":"Create account hold","tags":["RETAIL"],"parameters":[{"name":"accountId","in":"path","type":"string","required":true,"description":"Identifier of the account. Often referred to as the account number, yet for consistency this is always referred to as accountId. Accepts both IBAN & BBAN"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"overrides":[{}],"holdTypeId":"/v1.0.0/reference/us/accountHoldTypes","description":"string","fromDate":"2024-01-01","toDate":"2024-01-01","lockedAmount":0.0,"blockPriorityId":"string","recordStatus":"string","currNo":0.0,"inputter":"string","dateTime":0.0,"authoriser":"string","companyId":"@ref:reference-companies-service-v1.0.0","deptCode":"@ref:reference-accountOfficers-service-v1.0.0","auditorCode":"string"}},"responses":{"200":"AccountBalanceHoldResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/order/us/accounts/reservedFunds/{holdId}","fullPath":"/api/v8.0.0/order/us/accounts/reservedFunds/{holdId}","operationId":"getAccountBalanceHold","name":"Retrieves information of the amount locked, lock type and the validity for a hold transaction","summary":"Retrieve hold funds detail","tags":["RETAIL"],"parameters":[{"name":"holdId","in":"path","type":"string","required":true,"description":"The transaction reference through which the specified amount in the transaction has been locked in an account"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"AccountBalanceHoldResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/order/us/payments/holds/{holdId}","fullPath":"/api/v8.0.0/order/us/payments/holds/{holdId}","operationId":"updateAccountBalanceHold","name":"Update amount or validity date of an existing hold","summary":"Update existing hold","tags":["RETAIL"],"parameters":[{"name":"holdId","in":"path","type":"string","required":true,"description":"The transaction reference through which the specified amount in the transaction has been locked in an account"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"overrides":[{}],"holdTypeId":"/v1.0.0/reference/us/accountHoldTypes","description":"string","fromDate":"2024-01-01","toDate":"2024-01-01","lockedAmount":0.0,"blockPriorityId":"string","recordStatus":"string","currNo":0.0,"inputter":"string","dateTime":0.0,"authoriser":"string","companyId":"@ref:reference-companies-service-v1.0.0","deptCode":"@ref:reference-accountOfficers-service-v1.0.0","auditorCode":"string"}},"responses":{"200":"AccountBalanceHoldResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/order/us/payments/accounts/{accountId}/holdSummary","fullPath":"/api/v8.0.0/order/us/payments/accounts/{accountId}/holdSummary","operationId":"getAccountHoldDetails","name":"Retrieves details of all holds placed on an account","summary":"Get hold summary","tags":["RETAIL"],"parameters":[{"name":"accountId","in":"path","type":"string","required":true,"description":"Identifier of the account. Often referred to as the account number, yet for consistency this is always referred to as accountId. Accepts both IBAN & BBAN"},{"name":"holdTypeId","in":"query","type":"string","required":false,"description":"Purpose or the type of hold placed on the account  The available list of hold types can be retrieved through getHoldTypes"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"AccountHoldDetailsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"POST","path":"/order/us/payments/transactionStops","fullPath":"/api/v8.0.0/order/us/payments/transactionStops","operationId":"createUsTransactionStop","name":"Create transaction stop instruction to capture instructions to stop a payment based on the payment type, recipient or amount","summary":"Create transaction stop instruction","tags":["RETAIL"],"parameters":[{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"stopCondition":[{}],"accountId":"@ref:product-accountOperationalDate-service-v1.0.0","stopTypeId":"string","transactionChannel":"string","stopInstructionChannel":"BANK","stopReason":"CHKDES","issueDate":"string","replacementCheck":"string","replacementCheckIssueDate":"string","expiryDate":"string","waiveCharge":"string","transactionStopStatus":"ACTIVE","suppressNotice":"string","cancelInstruction":"YES","override":"string"}},"responses":{"200":"UsTransactionStopResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"DELETE","path":"/order/us/payments/transactionStops/{stopInstructionId}","fullPath":"/api/v8.0.0/order/us/payments/transactionStops/{stopInstructionId}","operationId":"deleteUsTransactionStop","name":"Deletes a transaction stop instruction capturing with instructions to stop a payment","summary":"Delete transaction stop","tags":["RETAIL"],"parameters":[{"name":"stopInstructionId","in":"path","type":"string","required":true,"description":"ID of stop instruction"},{"name":"payload","in":"body","type":"object","required":false,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}}},"responses":{"200":"UsTransactionStopResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"POST","path":"/order/us/payments/wireTransfers","fullPath":"/api/v8.0.0/order/us/payments/wireTransfers","operationId":"createFedwireCTR","name":"Creates an instant payment through  fedwire of payment type CTR, customer transfer","summary":"Creates a customer transfer through wire payment","tags":["RETAIL"],"parameters":[{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"orderingCustomerAddressLines":[{}],"ultimateDebtorAddressLines":[{}],"beneficiaryInstituteAddressLines":[{}],"beneficiaryAddressLines":[{}],"intermediaryFiNameAddressLines":[{}],"intermediary2FiNameAddressLines":[{}],"OriginatorToBeneficiaryLines":[{}],"receiverFiAndIntermediaryFiLines":[{}],"adviceInformation":[{}],"InformationLines":[{}],"charges":[{}],"overrides":[{}],"paymentPriority":"/v1.0.0/reference/lookups?virtualTableName=PAYMENT.SERVICE.LEVEL.CODE","orderingCustomerId":"string","debitAccountId":"string"}},"responses":{"200":"FedwireCTRResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"POST","path":"/order/us/payments/paymentOrders","fullPath":"/api/v8.0.0/order/us/payments/paymentOrders","operationId":"createUsDomesticTransfer","name":"Create one-time domestic account transfers and bill payments through ACH Clearing and the interbank automated clearing house","summary":"Create domestic transfer","tags":["RETAIL"],"parameters":[{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"standardEntryClassCode":"CIE","companyEntryDescription":"string","debitAccountId":"string","transactionAmount":0.0,"requiredCreditValueDate":"2024-01-01","beneficiaryId":"/v1.0.0/party/us/customers/{customerId}/beneficiaries","transactionCode":0.0,"beneficiaryOtherId":"string","accountWithBankClearingCode":"string","beneficiaryAccountId":"string","beneficiaryName":"string","narrative":"string","paymentCurrency":"string","paymentOrderProductId":"string","recordStatus":"string"}},"responses":{"200":"UsDomesticTransferResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"POST","path":"/order/us/payments/standingOrders/{accountId}","fullPath":"/api/v8.0.0/order/us/payments/standingOrders/{accountId}","operationId":"createUsRecurringTransfers","name":"Create a recurring account transfer","summary":"Create recurring transfer","tags":["RETAIL"],"parameters":[{"name":"accountId","in":"path","type":"string","required":true,"description":"Identifier of the account. Often referred to as the account number, yet for consistency this is always referred to as accountId. Accepts both IBAN & BBAN"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"beneficiaries":[{}],"currentFrequency":"string","standardEntryClassCode":"CIE","startDate":"2024-01-01","companyEntryDescription":"string","currentEndDate":"2024-01-01","currentAmountBalance":0.0,"beneficiaryId":"/v1.0.0/party/us/customers/{customerId}/beneficiaries","transactionCode":0.0,"beneficiaryOtherId":"string","accountWithBankClearingCode":"string","beneficiaryAccountId":"string","paymentDetail":"string","recordStatus":"string","currNo":"string"}},"responses":{"200":"UsRecurringTransfersResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"POST","path":"/order/us/payments/directDebits/{accountId}","fullPath":"/api/v8.0.0/order/us/payments/directDebits/{accountId}","operationId":"createUsDirectDebits","name":"Create direct debit instructions for repayment of loans or bill payment through external accounts","summary":"Create direct debit instruction","tags":["RETAIL"],"parameters":[{"name":"accountId","in":"path","type":"string","required":true,"description":"Identifier of the account. Often referred to as the account number, yet for consistency this is always referred to as accountId. Accepts both IBAN & BBAN"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"displayName":"string","directDebitParameterId":"string","serviceClassCode":0.0,"standardEntryClassCode":"PPD","debitAccountType":"string","debitBankClearingCode":"string","destinationAccountId":"string","debitorName":"string","frequency":"string","paymentDetail":"string","currencyMarket":"string","terminationDate":"2024-01-01","direction":"string","standAloneDdi":"string","standaloneAmount":0.0}},"responses":{"200":"UsDirectDebitsResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/order/us/payments/directDebits","fullPath":"/api/v8.0.0/order/us/payments/directDebits","operationId":"getUsDirectDebits","name":"Retrieve the list of direct debits initiated for repayment of bills or loans from external accounts","summary":"Retrieve direct debits setup for an account","tags":["RETAIL"],"parameters":[{"name":"customerId","in":"query","type":"string","required":false,"description":"Identifier of the customer"},{"name":"directDebitParameterId","in":"query","type":"string","required":false,"description":"Reference to the parameter which holds details relating to clearing accounts, number of days before which the claim has to be submitted or resubmitted"},{"name":"frequency","in":"query","type":"string","required":false,"description":"Specifies the frequency in which the payment application(periodic payments) execute the payment instruction."},{"name":"accountId","in":"query","type":"string","required":false,"description":"Identifier of the account. Often referred to as the account number, yet for consistency this is always referred to as accountId. Accepts both IBAN & BBAN"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"UsDirectDebitsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/order/us/payments/standingOrders","fullPath":"/api/v8.0.0/order/us/payments/standingOrders","operationId":"getUsRecurringTransfers","name":"Retrieve recurring payments setup for account transfers and bill payments","summary":"Get recurring transfer details","tags":["RETAIL"],"parameters":[{"name":"orderingCustomerId","in":"query","type":"string","required":false,"description":"Indicates the customer id for the ordering customer"},{"name":"paymentOrderProductName","in":"query","type":"string","required":false,"description":"Indicates the name of payment order product "},{"name":"accountId","in":"query","type":"string","required":false,"description":"Identifier of the account. Often referred to as the account number, yet for consistency this is always referred to as accountId. Accepts both IBAN & BBAN"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"UsRecurringTransfersResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"POST","path":"/order/us/payments/wireTransfers/simulate","fullPath":"/api/v8.0.0/order/us/payments/wireTransfers/simulate","operationId":"simulateFedwireCTR","name":"Validate payment order transaction to verify the information provided and to retrieve the applicable charges","summary":"Validate payment order transaction ","tags":["RETAIL"],"parameters":[{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"orderingCustomerAddressLines":[{}],"ultimateDebtorAddressLines":[{}],"beneficiaryInstituteAddressLines":[{}],"beneficiaryAddressLines":[{}],"intermediaryFiNameAddressLines":[{}],"intermediary2FiNameAddressLines":[{}],"OriginatorToBeneficiaryLines":[{}],"receiverFiAndIntermediaryFiLines":[{}],"adviceInformation":[{}],"InformationLines":[{}],"charges":[{}],"overrides":[{}],"paymentPriority":"/v1.0.0/reference/lookups?virtualTableName=PAYMENT.SERVICE.LEVEL.CODE","orderingCustomerId":"string","debitAccountId":"string"}},"responses":{"200":"FedwireCTRResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/order/us/payments/paymentStatus","fullPath":"/api/v8.0.0/order/us/payments/paymentStatus","operationId":"getUsPaymentsStatus","name":"Retrieve payment status and transaction history for an account along with beneficiary details and beneficiary status","summary":"Retrieve payment history","tags":["RETAIL"],"parameters":[{"name":"fromDate","in":"query","type":"string","required":false,"description":"Indicates the business date from when the balance reservation event is active."},{"name":"status","in":"query","type":"string","required":false,"description":"The status of the early maturity request"},{"name":"orderingCustomerId","in":"query","type":"string","required":false,"description":"Indicates the customer id for the ordering customer"},{"name":"debitAccountId","in":"query","type":"string","required":false,"description":"Indicates the debit account number of the payment or transaction."},{"name":"paymentOrderId","in":"query","type":"string","required":false,"description":"The unique reference number of payment"},{"name":"transactionReference","in":"query","type":"string","required":false,"description":"Contains the identifier for the transaction in the core system"},{"name":"paymentStatus","in":"query","type":"string","required":false,"description":"Describes the current status of the payment order in the payment system"},{"name":"toDate","in":"query","type":"string","required":false,"description":"Indicates the business date until when the balance reservation event is active."},{"name":"beneficiaryId","in":"query","type":"string","required":false,"description":"Indicates the reference of the financial institution that allows access to the beneficiary information"},{"name":"beneficiaryAccountId","in":"query","type":"string","required":false,"description":"Unique account identifier of the beneficiary account number."},{"name":"direction","in":"query","type":"string","required":false,"description":"Indicates the direction of the Direct debit claim for which mandate is received. The claim can be 'Outward' i.e. Claim is sent to the other bank or 'Inward'  i.e. other bank submit their claim to debi"},{"name":"paymentOrderProductId","in":"query","type":"string","required":false,"description":"Indicates the payment order product for which payment is initiated"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"UsPaymentsStatusResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"POST","path":"/order/us/payments/microDeposits","fullPath":"/api/v8.0.0/order/us/payments/microDeposits","operationId":"createUsACHBatchMicroDeposits","name":"Create a microdeposit batch to validate external account for a new beneficiary added by customer","summary":"Create a microdeposit batch to validate external account","tags":["RETAIL"],"parameters":[{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"entryDetails":[{}],"accountType":"string","recordStatus":"string","currNo":"string","inputter":"string","dateTime":"string","authoriser":"string","companyId":"string","deptCOde":"string","auditorCode":"string","auditTimeDate":"string","extensions":{}}},"responses":{"200":"UsACHBatchMicroDepositsResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/order/us/payments/customers/{orderingCustomerId}/directDebits/achDebits","fullPath":"/api/v8.0.0/order/us/payments/customers/{orderingCustomerId}/directDebits/achDebits","operationId":"getUsACHBatchAchDebits","name":"Retrieve list of customer initiated debit request to external accounts processed through ACH clearing and the interbank automated clearing house","summary":"Retrieve list of customer initiated debit request to external accounts","tags":["RETAIL"],"parameters":[{"name":"orderingCustomerId","in":"path","type":"string","required":true,"description":"Indicates the customer id for the ordering customer"},{"name":"effectiveDate","in":"query","type":"string","required":false,"description":"Contains the identifier for the transaction date. Dates are expected in \u00e2\u20ac\u02dcYYYYMMDD\u00e2\u20ac\u2122 format"},{"name":"creditAccountId","in":"query","type":"string","required":false,"description":"Credit account identifier of the payment or transaction"},{"name":"transactionCode","in":"query","type":"string","required":false,"description":"Identifies the system internal transaction code applicable to the transaction"},{"name":"amount","in":"query","type":"string","required":false,"description":"Contains the direct debit claim amount"},{"name":"beneficiaryInstituteRoutingNo","in":"query","type":"string","required":false,"description":"Routing number of DDA number of the Financial institution where the beneficiary account exists"},{"name":"debitAccountId","in":"query","type":"string","required":false,"description":"Indicates the debit account number of the payment or transaction."},{"name":"debitorName","in":"query","type":"string","required":false,"description":"The name of the customer who owns the destination account or the debit account used to collect payments"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"UsACHBatchAchDebitsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"POST","path":"/order/us/payments/wireTransfers/cancel/{transactionReference}","fullPath":"/api/v8.0.0/order/us/payments/wireTransfers/cancel/{transactionReference}","operationId":"reverseUsWireTransfer","name":"Request can be sent to initiate cancellation for a wire transfer within 30 minutes of submitting the wire payment","summary":"Initiate request to cancel wire transfer","tags":["RETAIL"],"parameters":[{"name":"transactionReference","in":"path","type":"string","required":true,"description":"Contains the identifier for the transaction in the core system"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"overrideDetails":[{}],"inputter":[{}],"dateTime":[{}],"transactionReference":"string","processingDate":"2024-01-01","statusCode":0.0,"sendersReference":"string","orderingAccount":"string","orderingName":"string","debitCustomerId":0.0,"recordStatus":"string","currNo":0.0,"authoriser":"string","companyCode":"string","deptCode":"string"}},"responses":{"200":"UsWireTransferResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"POST","path":"/order/us/payments/swiftTransfers/cancel/{transactionReference}","fullPath":"/api/v8.0.0/order/us/payments/swiftTransfers/cancel/{transactionReference}","operationId":"cancelSwiftTransaction","name":"Request to cancel international payments initiated within 30 minutes of submitting the payment","summary":"Initiate request to cancel international transfers","tags":["RETAIL"],"parameters":[{"name":"transactionReference","in":"path","type":"string","required":true,"description":"Contains the identifier for the transaction in the core system"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"inputter":[{}],"dateTime":[{}],"companyId":"string","transactionReference":"string","amount":0.0,"currencyId":"string","paymentMsgSentDate":"2024-01-01","outputChannel":"string","statusCode":"string","recordStatus":"string","currNo":0.0,"authoriser":"string","companyCode":"string","deptCode":"string","auditorCode":"string"}},"responses":{"200":"SwiftTransactionResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/order/us/payments/achEntry/{achEntryId}/achEntryStatus","fullPath":"/api/v8.0.0/order/us/payments/achEntry/{achEntryId}/achEntryStatus","operationId":"updateAchNOCEntriesStatus","name":"Allows to update the ACH entries status to processed","summary":"Allows to update the ACH entries status to processed","tags":["RETAIL"],"parameters":[{"name":"achEntryId","in":"path","type":"string","required":true,"description":""},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"achEntryStatus":"string","paymentOrderId":"string","transactionReference":"string","executionDate":"string","deliveryByDate":"string","creditDebitIndicator":"string","beneficiaryInstituteRoutingNo":"string","beneficiaryName":"string","beneficiaryOtherId":"string","accountId":"string","paymentAmount":"string","standardEntryClassCode":"string","extensions":{}}},"responses":{"200":"AchNOCEntriesStatusResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"POST","path":"/order/us/payments/directDebits/achDebits","fullPath":"/api/v8.0.0/order/us/payments/directDebits/achDebits","operationId":"createUsAchSameDayDebits","name":"Initiates same day ACH debit collection transaction","summary":"Initiates same day debit transfers","tags":["RETAIL"],"parameters":[{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"creditAccountId":"string","amount":"string","effectiveDate":"string","debitBankClearingCode":"string","debitAccountId":"string","debitorName":"string","additionalInformation":"string","standardEntryClassCode":"CCD","debitAccountType":"Checking","customerType":"Business","companyEntryDescription":"string","extensions":{}}},"responses":{"200":"UsAchSameDayDebitsResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/order/us/payments/wireTransfers/accounts/{debitAccountId}/mandates","fullPath":"/api/v8.0.0/order/us/payments/wireTransfers/accounts/{debitAccountId}/mandates","operationId":"getUsDrawdownMandates","name":"Retrieves all the available drawdown authorization or mandates for an account.","summary":"Retrieves drawdown mandates ","tags":["RETAIL"],"parameters":[{"name":"debitAccountId","in":"path","type":"string","required":true,"description":"Indicates the debit account number of the payment or transaction."},{"name":"beneficiaryAccountId","in":"query","type":"string","required":false,"description":"Unique account identifier of the beneficiary account number."},{"name":"routingNumber","in":"query","type":"string","required":false,"description":"Indicates the routing number of the bank where the account is held"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"UsDrawdownMandatesResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"POST","path":"/order/us/payments/wireTransfers/mandates","fullPath":"/api/v8.0.0/order/us/payments/wireTransfers/mandates","operationId":"createUsDrawdownMandate","name":"Allows to create a drawdown authorization for a customer for approving automatic drawdown transfer via wire payment to debit their account based on a drawdown request (1031 or 1631) received from the creditor's financial institution. The authorization form or the mandate form captures the credit account number, the financial institution where the creditor account is held, the purpose for which the debit request will be sent, the maximum amount allowed to be debited upon a drawdown request and th","summary":"Allows to create a drawdown authorization","tags":["RETAIL"],"parameters":[{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"debitAccountId":"string","debitAccountName":"string","beneficiaryAccountId":"string","drawdownAmount":0.0,"beneficiaryInstituteName":"string","routingNumber":"string","beneficiaryName":"string","accountType":"/v1.0.0/reference/lookups?virtualTableName=USRTGS.ACCT.TYPE","beneficiaryAddress":"string","receiverFiAndIntermediaryFiInfo":"string","effectiveFromDate":"2024-01-01","effectiveToDate":"2024-01-01","extensions":{}}},"responses":{"200":"UsDrawdownMandateResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/order/us/payments/wireTransfers/{mandateId}/mandates","fullPath":"/api/v8.0.0/order/us/payments/wireTransfers/{mandateId}/mandates","operationId":"updateUsDrawdownMandate","name":"Allows to update existing drawdown authorization or mandate created for a customer to approve automatic drawdown transfer via wire payment to debit their account and crediting an external account","summary":"Allows to update existing drawdown authorization","tags":["RETAIL"],"parameters":[{"name":"mandateId","in":"path","type":"string","required":true,"description":""},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"debitAccountId":"string","debitAccountName":"string","beneficiaryAccountId":"string","drawdownAmount":0.0,"beneficiaryInstituteName":"string","routingNumber":"string","beneficiaryName":"string","accountType":"/v1.0.0/reference/lookups?virtualTableName=USRTGS.ACCT.TYPE","beneficiaryAddress":"string","receiverFiAndIntermediaryFiInfo":"string","effectiveFromDate":"2024-01-01","effectiveToDate":"2024-01-01","extensions":{}}},"responses":{"200":"UsDrawdownMandateResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"POST","path":"/order/us/payments/wireTransfers/surplusSweep","fullPath":"/api/v8.0.0/order/us/payments/wireTransfers/surplusSweep","operationId":"createFedwireETI","name":"Creates Fedwire fund transfer to manage their excess funds","summary":"Creates fund transfer for excess funds","tags":[],"parameters":[{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"orderingCustomerAddresses":[{}],"beneficiaryInstituteAddresses":[{}],"beneficiaryAddresses":[{}],"paymentPriority":"string","senderRoutingNo":"string","orderingCustomerId":"string","debitAccountId":"string","schedulePaymentAmount":"string","accountWithBankSortCode":"string","beneficiaryId":"string","beneficiaryName":"string","beneficiaryAccountId":"string","extensions":{}}},"responses":{"200":"FedwireETIResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}}]},{"key":"order-us-payments-service-v8.1.0","title":"Same day debits","version":"v8.1.0","description":"Initiates same day debit transfers","endpointCount":25,"endpoints":[{"method":"POST","path":"/order/us/payments/escrows","fullPath":"/api/v8.1.0/order/us/payments/escrows","operationId":"createEscrowAdhocDeposit","name":"Initiates an escrow payment transaction","summary":"Escrow payment","tags":["RETAIL"],"parameters":[{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"overrideDetails":[{}],"creditAccountId":"@ref:product-accountOperationalDate-service-v1.0.0","creditValueDate":"2024-01-01","creditCurrencyId":"string","creditAmount":0.0,"debitAccountId":"@ref:product-accountOperationalDate-service-v1.0.0","debitValueDate":"2024-01-01","debitCurrencyId":"string","debitAmount":0.0,"treasuryRate":0.0,"processingDate":"2024-01-01","customerRate":0.0,"customerSpread":0.0,"recordStatus":"string","currNo":0.0}},"responses":{"200":"EscrowAdhocDepositResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"POST","path":"/order/us/accounts/{accountId}/reservedFunds","fullPath":"/api/v8.1.0/order/us/accounts/{accountId}/reservedFunds","operationId":"createAccountBalanceHold","name":"Create a hold transaction to lock the funds in an account","summary":"Create account hold","tags":["RETAIL"],"parameters":[{"name":"accountId","in":"path","type":"string","required":true,"description":"Identifier of the account. Often referred to as the account number, yet for consistency this is always referred to as accountId. Accepts both IBAN & BBAN"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"overrides":[{}],"holdTypeId":"/v1.0.0/reference/us/accountHoldTypes","description":"string","fromDate":"2024-01-01","toDate":"2024-01-01","lockedAmount":0.0,"blockPriorityId":"string","recordStatus":"string","currNo":0.0,"inputter":"string","dateTime":0.0,"authoriser":"string","companyId":"@ref:reference-companies-service-v1.0.0","deptCode":"@ref:reference-accountOfficers-service-v1.0.0","auditorCode":"string"}},"responses":{"200":"AccountBalanceHoldResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/order/us/accounts/reservedFunds/{holdId}","fullPath":"/api/v8.1.0/order/us/accounts/reservedFunds/{holdId}","operationId":"getAccountBalanceHold","name":"Retrieves information of the amount locked, lock type and the validity for a hold transaction","summary":"Retrieve hold funds detail","tags":["RETAIL"],"parameters":[{"name":"holdId","in":"path","type":"string","required":true,"description":"The transaction reference through which the specified amount in the transaction has been locked in an account"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"AccountBalanceHoldResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/order/us/payments/holds/{holdId}","fullPath":"/api/v8.1.0/order/us/payments/holds/{holdId}","operationId":"updateAccountBalanceHold","name":"Update amount or validity date of an existing hold","summary":"Update existing hold","tags":["RETAIL"],"parameters":[{"name":"holdId","in":"path","type":"string","required":true,"description":"The transaction reference through which the specified amount in the transaction has been locked in an account"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"overrides":[{}],"holdTypeId":"/v1.0.0/reference/us/accountHoldTypes","description":"string","fromDate":"2024-01-01","toDate":"2024-01-01","lockedAmount":0.0,"blockPriorityId":"string","recordStatus":"string","currNo":0.0,"inputter":"string","dateTime":0.0,"authoriser":"string","companyId":"@ref:reference-companies-service-v1.0.0","deptCode":"@ref:reference-accountOfficers-service-v1.0.0","auditorCode":"string"}},"responses":{"200":"AccountBalanceHoldResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/order/us/payments/accounts/{accountId}/holdSummary","fullPath":"/api/v8.1.0/order/us/payments/accounts/{accountId}/holdSummary","operationId":"getAccountHoldDetails","name":"Retrieves details of all holds placed on an account","summary":"Get hold summary","tags":["RETAIL"],"parameters":[{"name":"accountId","in":"path","type":"string","required":true,"description":"Identifier of the account. Often referred to as the account number, yet for consistency this is always referred to as accountId. Accepts both IBAN & BBAN"},{"name":"holdTypeId","in":"query","type":"string","required":false,"description":"Purpose or the type of hold placed on the account  The available list of hold types can be retrieved through getHoldTypes"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"AccountHoldDetailsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"POST","path":"/order/us/payments/transactionStops","fullPath":"/api/v8.1.0/order/us/payments/transactionStops","operationId":"createUsTransactionStop","name":"Create transaction stop instruction to capture instructions to stop a payment based on the payment type, recipient or amount","summary":"Create transaction stop instruction","tags":["RETAIL"],"parameters":[{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"stopCondition":[{}],"accountId":"@ref:product-accountOperationalDate-service-v1.0.0","stopTypeId":"string","transactionChannel":"string","stopInstructionChannel":"BANK","stopReason":"CHKDES","issueDate":"string","replacementCheck":"string","replacementCheckIssueDate":"string","expiryDate":"string","waiveCharge":"string","transactionStopStatus":"ACTIVE","suppressNotice":"string","cancelInstruction":"YES","override":"string"}},"responses":{"200":"UsTransactionStopResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"DELETE","path":"/order/us/payments/transactionStops/{stopInstructionId}","fullPath":"/api/v8.1.0/order/us/payments/transactionStops/{stopInstructionId}","operationId":"deleteUsTransactionStop","name":"Deletes a transaction stop instruction capturing with instructions to stop a payment","summary":"Delete transaction stop","tags":["RETAIL"],"parameters":[{"name":"stopInstructionId","in":"path","type":"string","required":true,"description":"ID of stop instruction"},{"name":"payload","in":"body","type":"object","required":false,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}}},"responses":{"200":"UsTransactionStopResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"POST","path":"/order/us/payments/wireTransfers","fullPath":"/api/v8.1.0/order/us/payments/wireTransfers","operationId":"createFedwireCTR","name":"Creates an instant payment through  fedwire of payment type CTR, customer transfer","summary":"Creates a customer transfer through wire payment","tags":["RETAIL"],"parameters":[{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"orderingCustomerAddressLines":[{}],"ultimateDebtorAddressLines":[{}],"beneficiaryInstituteAddressLines":[{}],"beneficiaryAddressLines":[{}],"intermediaryFiNameAddressLines":[{}],"intermediary2FiNameAddressLines":[{}],"OriginatorToBeneficiaryLines":[{}],"receiverFiAndIntermediaryFiLines":[{}],"adviceInformation":[{}],"InformationLines":[{}],"charges":[{}],"overrides":[{}],"paymentPriority":"/v1.0.0/reference/lookups?virtualTableName=PAYMENT.SERVICE.LEVEL.CODE","orderingCustomerId":"string","debitAccountId":"string"}},"responses":{"200":"FedwireCTRResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"POST","path":"/order/us/payments/paymentOrders","fullPath":"/api/v8.1.0/order/us/payments/paymentOrders","operationId":"createUsDomesticTransfer","name":"Create one-time domestic account transfers and bill payments through ACH Clearing and the interbank automated clearing house","summary":"Create domestic transfer","tags":["RETAIL"],"parameters":[{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"standardEntryClassCode":"CIE","companyEntryDescription":"string","debitAccountId":"string","transactionAmount":0.0,"requiredCreditValueDate":"2024-01-01","beneficiaryId":"/v1.0.0/party/us/customers/{customerId}/beneficiaries","transactionCode":0.0,"beneficiaryOtherId":"string","accountWithBankClearingCode":"string","beneficiaryAccountId":"string","beneficiaryName":"string","narrative":"string","paymentCurrency":"string","paymentOrderProductId":"string","recordStatus":"string"}},"responses":{"200":"UsDomesticTransferResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"POST","path":"/order/us/payments/standingOrders/{accountId}","fullPath":"/api/v8.1.0/order/us/payments/standingOrders/{accountId}","operationId":"createUsRecurringTransfers","name":"Create a recurring account transfer","summary":"Create recurring transfer","tags":["RETAIL"],"parameters":[{"name":"accountId","in":"path","type":"string","required":true,"description":"Identifier of the account. Often referred to as the account number, yet for consistency this is always referred to as accountId. Accepts both IBAN & BBAN"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"beneficiaries":[{}],"currentFrequency":"string","standardEntryClassCode":"CIE","startDate":"2024-01-01","companyEntryDescription":"string","currentEndDate":"2024-01-01","currentAmountBalance":0.0,"beneficiaryId":"/v1.0.0/party/us/customers/{customerId}/beneficiaries","transactionCode":0.0,"beneficiaryOtherId":"string","accountWithBankClearingCode":"string","beneficiaryAccountId":"string","paymentDetail":"string","currency":"string","recordStatus":"string"}},"responses":{"200":"UsRecurringTransfersResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"POST","path":"/order/us/payments/directDebits/{accountId}","fullPath":"/api/v8.1.0/order/us/payments/directDebits/{accountId}","operationId":"createUsDirectDebits","name":"Create direct debit instructions for repayment of loans or bill payment through external accounts","summary":"Create direct debit instruction","tags":["RETAIL"],"parameters":[{"name":"accountId","in":"path","type":"string","required":true,"description":"Identifier of the account. Often referred to as the account number, yet for consistency this is always referred to as accountId. Accepts both IBAN & BBAN"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"displayName":"string","directDebitParameterId":"string","serviceClassCode":0.0,"standardEntryClassCode":"PPD","debitAccountType":"string","debitBankClearingCode":"string","destinationAccountId":"string","debitorName":"string","frequency":"string","paymentDetail":"string","currencyMarket":"string","terminationDate":"2024-01-01","direction":"string","standAloneDdi":"string","standaloneAmount":0.0}},"responses":{"200":"UsDirectDebitsResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/order/us/payments/directDebits","fullPath":"/api/v8.1.0/order/us/payments/directDebits","operationId":"getUsDirectDebits","name":"Retrieve the list of direct debits initiated for repayment of bills or loans from external accounts","summary":"Retrieve direct debits setup for an account","tags":["RETAIL"],"parameters":[{"name":"customerId","in":"query","type":"string","required":false,"description":"Identifier of the customer"},{"name":"directDebitParameterId","in":"query","type":"string","required":false,"description":"Reference to the parameter which holds details relating to clearing accounts, number of days before which the claim has to be submitted or resubmitted"},{"name":"frequency","in":"query","type":"string","required":false,"description":"Specifies the frequency in which the payment application(periodic payments) execute the payment instruction."},{"name":"accountId","in":"query","type":"string","required":false,"description":"Identifier of the account. Often referred to as the account number, yet for consistency this is always referred to as accountId. Accepts both IBAN & BBAN"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"UsDirectDebitsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/order/us/payments/standingOrders","fullPath":"/api/v8.1.0/order/us/payments/standingOrders","operationId":"getUsRecurringTransfers","name":"Retrieve recurring payments setup for account transfers and bill payments","summary":"Get recurring transfer details","tags":["RETAIL"],"parameters":[{"name":"orderingCustomerId","in":"query","type":"string","required":false,"description":"Indicates the customer id for the ordering customer"},{"name":"paymentOrderProductName","in":"query","type":"string","required":false,"description":"Indicates the name of payment order product "},{"name":"accountId","in":"query","type":"string","required":false,"description":"Identifier of the account. Often referred to as the account number, yet for consistency this is always referred to as accountId. Accepts both IBAN & BBAN"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"UsRecurringTransfersResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"POST","path":"/order/us/payments/wireTransfers/simulate","fullPath":"/api/v8.1.0/order/us/payments/wireTransfers/simulate","operationId":"simulateFedwireCTR","name":"Validate payment order transaction to verify the information provided and to retrieve the applicable charges","summary":"Validate payment order transaction ","tags":["RETAIL"],"parameters":[{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"orderingCustomerAddressLines":[{}],"ultimateDebtorAddressLines":[{}],"beneficiaryInstituteAddressLines":[{}],"beneficiaryAddressLines":[{}],"intermediaryFiNameAddressLines":[{}],"intermediary2FiNameAddressLines":[{}],"OriginatorToBeneficiaryLines":[{}],"receiverFiAndIntermediaryFiLines":[{}],"adviceInformation":[{}],"InformationLines":[{}],"charges":[{}],"overrides":[{}],"paymentPriority":"/v1.0.0/reference/lookups?virtualTableName=PAYMENT.SERVICE.LEVEL.CODE","orderingCustomerId":"string","debitAccountId":"string"}},"responses":{"200":"FedwireCTRResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/order/us/payments/paymentStatus","fullPath":"/api/v8.1.0/order/us/payments/paymentStatus","operationId":"getUsPaymentsStatus","name":"Retrieve payment status and transaction history for an account along with beneficiary details and beneficiary status","summary":"Retrieve payment history","tags":["RETAIL"],"parameters":[{"name":"fromDate","in":"query","type":"string","required":false,"description":"Indicates the business date from when the balance reservation event is active."},{"name":"status","in":"query","type":"string","required":false,"description":"The status of the early maturity request"},{"name":"orderingCustomerId","in":"query","type":"string","required":false,"description":"Indicates the customer id for the ordering customer"},{"name":"debitAccountId","in":"query","type":"string","required":false,"description":"Indicates the debit account number of the payment or transaction."},{"name":"paymentOrderId","in":"query","type":"string","required":false,"description":"The unique reference number of payment"},{"name":"transactionReference","in":"query","type":"string","required":false,"description":"Contains the identifier for the transaction in the core system"},{"name":"paymentStatus","in":"query","type":"string","required":false,"description":"Describes the current status of the payment order in the payment system"},{"name":"toDate","in":"query","type":"string","required":false,"description":"Indicates the business date until when the balance reservation event is active."},{"name":"beneficiaryId","in":"query","type":"string","required":false,"description":"Indicates the reference of the financial institution that allows access to the beneficiary information"},{"name":"beneficiaryAccountId","in":"query","type":"string","required":false,"description":"Unique account identifier of the beneficiary account number."},{"name":"direction","in":"query","type":"string","required":false,"description":"Indicates the direction of the Direct debit claim for which mandate is received. The claim can be 'Outward' i.e. Claim is sent to the other bank or 'Inward'  i.e. other bank submit their claim to debi"},{"name":"paymentOrderProductId","in":"query","type":"string","required":false,"description":"Indicates the payment order product for which payment is initiated"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"UsPaymentsStatusResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"POST","path":"/order/us/payments/microDeposits","fullPath":"/api/v8.1.0/order/us/payments/microDeposits","operationId":"createUsACHBatchMicroDeposits","name":"Create a microdeposit batch to validate external account for a new beneficiary added by customer","summary":"Create a microdeposit batch to validate external account","tags":["RETAIL"],"parameters":[{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"entryDetails":[{}],"accountType":"string","recordStatus":"string","currNo":"string","inputter":"string","dateTime":"string","authoriser":"string","companyId":"string","deptCOde":"string","auditorCode":"string","auditTimeDate":"string","extensions":{}}},"responses":{"200":"UsACHBatchMicroDepositsResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/order/us/payments/customers/{orderingCustomerId}/directDebits/achDebits","fullPath":"/api/v8.1.0/order/us/payments/customers/{orderingCustomerId}/directDebits/achDebits","operationId":"getUsACHBatchAchDebits","name":"Retrieve list of customer initiated debit request to external accounts processed through ACH clearing and the interbank automated clearing house","summary":"Retrieve list of customer initiated debit request to external accounts","tags":["RETAIL"],"parameters":[{"name":"orderingCustomerId","in":"path","type":"string","required":true,"description":"Indicates the customer id for the ordering customer"},{"name":"effectiveDate","in":"query","type":"string","required":false,"description":"Contains the identifier for the transaction date. Dates are expected in \u00e2\u20ac\u02dcYYYYMMDD\u00e2\u20ac\u2122 format"},{"name":"creditAccountId","in":"query","type":"string","required":false,"description":"Credit account identifier of the payment or transaction"},{"name":"transactionCode","in":"query","type":"string","required":false,"description":"Identifies the system internal transaction code applicable to the transaction"},{"name":"amount","in":"query","type":"string","required":false,"description":"Contains the direct debit claim amount"},{"name":"beneficiaryInstituteRoutingNo","in":"query","type":"string","required":false,"description":"Routing number of DDA number of the Financial institution where the beneficiary account exists"},{"name":"debitAccountId","in":"query","type":"string","required":false,"description":"Indicates the debit account number of the payment or transaction."},{"name":"debitorName","in":"query","type":"string","required":false,"description":"The name of the customer who owns the destination account or the debit account used to collect payments"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"UsACHBatchAchDebitsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"POST","path":"/order/us/payments/wireTransfers/cancel/{transactionReference}","fullPath":"/api/v8.1.0/order/us/payments/wireTransfers/cancel/{transactionReference}","operationId":"reverseUsWireTransfer","name":"Request can be sent to initiate cancellation for a wire transfer within 30 minutes of submitting the wire payment","summary":"Initiate request to cancel wire transfer","tags":["RETAIL"],"parameters":[{"name":"transactionReference","in":"path","type":"string","required":true,"description":"Contains the identifier for the transaction in the core system"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"overrideDetails":[{}],"inputter":[{}],"dateTime":[{}],"transactionReference":"string","processingDate":"2024-01-01","statusCode":0.0,"sendersReference":"string","orderingAccount":"string","orderingName":"string","debitCustomerId":0.0,"recordStatus":"string","currNo":0.0,"authoriser":"string","companyCode":"string","deptCode":"string"}},"responses":{"200":"UsWireTransferResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"POST","path":"/order/us/payments/swiftTransfers/cancel/{transactionReference}","fullPath":"/api/v8.1.0/order/us/payments/swiftTransfers/cancel/{transactionReference}","operationId":"cancelSwiftTransaction","name":"Request to cancel international payments initiated within 30 minutes of submitting the payment","summary":"Initiate request to cancel international transfers","tags":["RETAIL"],"parameters":[{"name":"transactionReference","in":"path","type":"string","required":true,"description":"Contains the identifier for the transaction in the core system"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"inputter":[{}],"dateTime":[{}],"companyId":"string","transactionReference":"string","amount":0.0,"currencyId":"string","paymentMsgSentDate":"2024-01-01","outputChannel":"string","statusCode":"string","recordStatus":"string","currNo":0.0,"authoriser":"string","companyCode":"string","deptCode":"string","auditorCode":"string"}},"responses":{"200":"SwiftTransactionResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/order/us/payments/achEntry/{achEntryId}/achEntryStatus","fullPath":"/api/v8.1.0/order/us/payments/achEntry/{achEntryId}/achEntryStatus","operationId":"updateAchNOCEntriesStatus","name":"Allows to update the ACH entries status to processed","summary":"Allows to update the ACH entries status to processed","tags":["RETAIL"],"parameters":[{"name":"achEntryId","in":"path","type":"string","required":true,"description":""},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"achEntryStatus":"string","paymentOrderId":"string","transactionReference":"string","executionDate":"string","deliveryByDate":"string","creditDebitIndicator":"string","beneficiaryInstituteRoutingNo":"string","beneficiaryName":"string","beneficiaryOtherId":"string","accountId":"string","paymentAmount":"string","standardEntryClassCode":"string","extensions":{}}},"responses":{"200":"AchNOCEntriesStatusResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"POST","path":"/order/us/payments/directDebits/achDebits","fullPath":"/api/v8.1.0/order/us/payments/directDebits/achDebits","operationId":"createUsAchSameDayDebits","name":"Initiates same day ACH debit collection transaction","summary":"Initiates same day debit transfers","tags":["RETAIL"],"parameters":[{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"creditAccountId":"string","amount":"string","effectiveDate":"string","debitBankClearingCode":"string","debitAccountId":"string","debitorName":"string","additionalInformation":"string","standardEntryClassCode":"CCD","debitAccountType":"Checking","customerType":"Business","companyEntryDescription":"string","extensions":{}}},"responses":{"200":"UsAchSameDayDebitsResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/order/us/payments/wireTransfers/accounts/{debitAccountId}/mandates","fullPath":"/api/v8.1.0/order/us/payments/wireTransfers/accounts/{debitAccountId}/mandates","operationId":"getUsDrawdownMandates","name":"Retrieves all the available drawdown authorization or mandates for an account.","summary":"Retrieves drawdown mandates ","tags":["RETAIL"],"parameters":[{"name":"debitAccountId","in":"path","type":"string","required":true,"description":"Indicates the debit account number of the payment or transaction."},{"name":"beneficiaryAccountId","in":"query","type":"string","required":false,"description":"Unique account identifier of the beneficiary account number."},{"name":"routingNumber","in":"query","type":"string","required":false,"description":"Indicates the routing number of the bank where the account is held"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"UsDrawdownMandatesResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"POST","path":"/order/us/payments/wireTransfers/mandates","fullPath":"/api/v8.1.0/order/us/payments/wireTransfers/mandates","operationId":"createUsDrawdownMandate","name":"Allows to create a drawdown authorization for a customer for approving automatic drawdown transfer via wire payment to debit their account based on a drawdown request (1031 or 1631) received from the creditor's financial institution. The authorization form or the mandate form captures the credit account number, the financial institution where the creditor account is held, the purpose for which the debit request will be sent, the maximum amount allowed to be debited upon a drawdown request and th","summary":"Allows to create a drawdown authorization","tags":["RETAIL"],"parameters":[{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"debitAccountId":"string","debitAccountName":"string","beneficiaryAccountId":"string","drawdownAmount":0.0,"beneficiaryInstituteName":"string","routingNumber":"string","beneficiaryName":"string","accountType":"/v1.0.0/reference/lookups?virtualTableName=USRTGS.ACCT.TYPE","beneficiaryAddress":"string","receiverFiAndIntermediaryFiInfo":"string","effectiveFromDate":"2024-01-01","effectiveToDate":"2024-01-01","extensions":{}}},"responses":{"200":"UsDrawdownMandateResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/order/us/payments/wireTransfers/{mandateId}/mandates","fullPath":"/api/v8.1.0/order/us/payments/wireTransfers/{mandateId}/mandates","operationId":"updateUsDrawdownMandate","name":"Allows to update existing drawdown authorization or mandate created for a customer to approve automatic drawdown transfer via wire payment to debit their account and crediting an external account","summary":"Allows to update existing drawdown authorization","tags":["RETAIL"],"parameters":[{"name":"mandateId","in":"path","type":"string","required":true,"description":""},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"debitAccountId":"string","debitAccountName":"string","beneficiaryAccountId":"string","drawdownAmount":0.0,"beneficiaryInstituteName":"string","routingNumber":"string","beneficiaryName":"string","accountType":"/v1.0.0/reference/lookups?virtualTableName=USRTGS.ACCT.TYPE","beneficiaryAddress":"string","receiverFiAndIntermediaryFiInfo":"string","effectiveFromDate":"2024-01-01","effectiveToDate":"2024-01-01","extensions":{}}},"responses":{"200":"UsDrawdownMandateResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"POST","path":"/order/us/payments/wireTransfers/surplusSweep","fullPath":"/api/v8.1.0/order/us/payments/wireTransfers/surplusSweep","operationId":"createFedwireETI","name":"Creates Fedwire fund transfer to manage their excess funds","summary":"Creates fund transfer for excess funds","tags":["RETAIL"],"parameters":[{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"orderingCustomerAddresses":[{}],"beneficiaryInstituteAddresses":[{}],"beneficiaryAddresses":[{}],"paymentPriority":"string","senderRoutingNo":"string","orderingCustomerId":"string","debitAccountId":"string","schedulePaymentAmount":"string","accountWithBankSortCode":"string","beneficiaryId":"string","beneficiaryName":"string","beneficiaryAccountId":"string","extensions":{}}},"responses":{"200":"FedwireETIResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}}]},{"key":"order-us-payments-service-v9.0.0","title":"Same day debits","version":"v9.0.0","description":"Initiates same day debit transfers","endpointCount":27,"endpoints":[{"method":"POST","path":"/order/us/payments/escrows","fullPath":"/api/v9.0.0/order/us/payments/escrows","operationId":"createEscrowAdhocDeposit","name":"Initiates an escrow payment transaction","summary":"Escrow payment","tags":["RETAIL"],"parameters":[{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"overrideDetails":[{}],"creditAccountId":"@ref:product-accountOperationalDate-service-v1.0.0","creditValueDate":"2024-01-01","creditCurrencyId":"string","creditAmount":0.0,"debitAccountId":"@ref:product-accountOperationalDate-service-v1.0.0","debitValueDate":"2024-01-01","debitCurrencyId":"string","debitAmount":0.0,"treasuryRate":0.0,"processingDate":"2024-01-01","customerRate":0.0,"customerSpread":0.0,"recordStatus":"string","currNo":0.0}},"responses":{"200":"EscrowAdhocDepositResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"POST","path":"/order/us/accounts/{accountId}/reservedFunds","fullPath":"/api/v9.0.0/order/us/accounts/{accountId}/reservedFunds","operationId":"createAccountBalanceHold","name":"Create a hold transaction to lock the funds in an account","summary":"Create account hold","tags":["RETAIL"],"parameters":[{"name":"accountId","in":"path","type":"string","required":true,"description":"Identifier of the account. Often referred to as the account number, yet for consistency this is always referred to as accountId. Accepts both IBAN & BBAN"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"overrides":[{}],"holdTypeId":"/v1.0.0/reference/us/accountHoldTypes","description":"string","fromDate":"2024-01-01","toDate":"2024-01-01","lockedAmount":0.0,"blockPriorityId":"string","recordStatus":"string","currNo":0.0,"inputter":"string","dateTime":0.0,"authoriser":"string","companyId":"@ref:reference-companies-service-v1.0.0","deptCode":"@ref:reference-accountOfficers-service-v1.0.0","auditorCode":"string"}},"responses":{"200":"AccountBalanceHoldResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/order/us/accounts/reservedFunds/{holdId}","fullPath":"/api/v9.0.0/order/us/accounts/reservedFunds/{holdId}","operationId":"getAccountBalanceHold","name":"Retrieves information of the amount locked, lock type and the validity for a hold transaction","summary":"Retrieve hold funds detail","tags":["RETAIL"],"parameters":[{"name":"holdId","in":"path","type":"string","required":true,"description":"The transaction reference through which the specified amount in the transaction has been locked in an account"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"AccountBalanceHoldResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/order/us/payments/holds/{holdId}","fullPath":"/api/v9.0.0/order/us/payments/holds/{holdId}","operationId":"updateAccountBalanceHold","name":"Update amount or validity date of an existing hold","summary":"Update existing hold","tags":["RETAIL"],"parameters":[{"name":"holdId","in":"path","type":"string","required":true,"description":"The transaction reference through which the specified amount in the transaction has been locked in an account"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"overrides":[{}],"holdTypeId":"/v1.0.0/reference/us/accountHoldTypes","description":"string","fromDate":"2024-01-01","toDate":"2024-01-01","lockedAmount":0.0,"blockPriorityId":"string","recordStatus":"string","currNo":0.0,"inputter":"string","dateTime":0.0,"authoriser":"string","companyId":"@ref:reference-companies-service-v1.0.0","deptCode":"@ref:reference-accountOfficers-service-v1.0.0","auditorCode":"string"}},"responses":{"200":"AccountBalanceHoldResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/order/us/payments/accounts/{accountId}/holdSummary","fullPath":"/api/v9.0.0/order/us/payments/accounts/{accountId}/holdSummary","operationId":"getAccountHoldDetails","name":"Retrieves details of all holds placed on an account","summary":"Get hold summary","tags":["RETAIL"],"parameters":[{"name":"accountId","in":"path","type":"string","required":true,"description":"Identifier of the account. Often referred to as the account number, yet for consistency this is always referred to as accountId. Accepts both IBAN & BBAN"},{"name":"holdTypeId","in":"query","type":"string","required":false,"description":"Purpose or the type of hold placed on the account  The available list of hold types can be retrieved through getHoldTypes"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"AccountHoldDetailsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"POST","path":"/order/us/payments/transactionStops","fullPath":"/api/v9.0.0/order/us/payments/transactionStops","operationId":"createUsTransactionStop","name":"Create transaction stop instruction to capture instructions to stop a payment based on the payment type, recipient or amount","summary":"Create transaction stop instruction","tags":["RETAIL"],"parameters":[{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"stopCondition":[{}],"accountId":"@ref:product-accountOperationalDate-service-v1.0.0","stopTypeId":"string","transactionChannel":"string","stopInstructionChannel":"BANK","stopReason":"CHKDES","issueDate":"string","replacementCheck":"string","replacementCheckIssueDate":"string","expiryDate":"string","waiveCharge":"string","transactionStopStatus":"ACTIVE","suppressNotice":"string","cancelInstruction":"YES","override":"string"}},"responses":{"200":"UsTransactionStopResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"DELETE","path":"/order/us/payments/transactionStops/{stopInstructionId}","fullPath":"/api/v9.0.0/order/us/payments/transactionStops/{stopInstructionId}","operationId":"deleteUsTransactionStop","name":"Deletes a transaction stop instruction capturing with instructions to stop a payment","summary":"Delete transaction stop","tags":["RETAIL"],"parameters":[{"name":"stopInstructionId","in":"path","type":"string","required":true,"description":"ID of stop instruction"},{"name":"payload","in":"body","type":"object","required":false,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}}},"responses":{"200":"UsTransactionStopResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"POST","path":"/order/us/payments/wireTransfers","fullPath":"/api/v9.0.0/order/us/payments/wireTransfers","operationId":"createFedwireCTR","name":"Creates an instant payment through  fedwire of payment type CTR, customer transfer","summary":"Creates a customer transfer through wire payment","tags":["RETAIL"],"parameters":[{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"orderingCustomerAddressLines":[{}],"ultimateDebtorAddressLines":[{}],"beneficiaryInstituteAddressLines":[{}],"beneficiaryAddressLines":[{}],"intermediaryFiNameAddressLines":[{}],"intermediary2FiNameAddressLines":[{}],"OriginatorToBeneficiaryLines":[{}],"receiverFiAndIntermediaryFiLines":[{}],"adviceInformation":[{}],"InformationLines":[{}],"charges":[{}],"overrides":[{}],"paymentPriority":"/v1.0.0/reference/lookups?virtualTableName=PAYMENT.SERVICE.LEVEL.CODE","orderingCustomerId":"string","debitAccountId":"string"}},"responses":{"200":"FedwireCTRResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"POST","path":"/order/us/payments/paymentOrders","fullPath":"/api/v9.0.0/order/us/payments/paymentOrders","operationId":"createUsDomesticTransfer","name":"Create one-time domestic account transfers and bill payments through ACH Clearing and the interbank automated clearing house","summary":"Create domestic transfer","tags":["RETAIL"],"parameters":[{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"standardEntryClassCode":"CIE","companyEntryDescription":"string","debitAccountId":"string","transactionAmount":0.0,"requiredCreditValueDate":"2024-01-01","beneficiaryId":"/v1.0.0/party/us/customers/{customerId}/beneficiaries","transactionCode":0.0,"beneficiaryOtherId":"string","accountWithBankClearingCode":"string","beneficiaryAccountId":"string","beneficiaryName":"string","narrative":"string","paymentCurrency":"string","paymentOrderProductId":"string","recordStatus":"string"}},"responses":{"200":"UsDomesticTransferResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"POST","path":"/order/us/payments/standingOrders/{accountId}","fullPath":"/api/v9.0.0/order/us/payments/standingOrders/{accountId}","operationId":"createUsRecurringTransfers","name":"Create a recurring account transfer","summary":"Create recurring transfer","tags":["RETAIL"],"parameters":[{"name":"accountId","in":"path","type":"string","required":true,"description":"Identifier of the account. Often referred to as the account number, yet for consistency this is always referred to as accountId. Accepts both IBAN & BBAN"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"beneficiaries":[{}],"currentFrequency":"string","standardEntryClassCode":"CIE","startDate":"2024-01-01","companyEntryDescription":"string","currentEndDate":"2024-01-01","currentAmountBalance":0.0,"beneficiaryId":"/v1.0.0/party/us/customers/{customerId}/beneficiaries","transactionCode":0.0,"beneficiaryOtherId":"string","accountWithBankClearingCode":"string","beneficiaryAccountId":"string","paymentDetail":"string","currency":"string","recordStatus":"string"}},"responses":{"200":"UsRecurringTransfersResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"POST","path":"/order/us/payments/directDebits/{accountId}","fullPath":"/api/v9.0.0/order/us/payments/directDebits/{accountId}","operationId":"createUsDirectDebits","name":"Create direct debit instructions for repayment of loans or bill payment through external accounts","summary":"Create direct debit instruction","tags":["RETAIL"],"parameters":[{"name":"accountId","in":"path","type":"string","required":true,"description":"Identifier of the account. Often referred to as the account number, yet for consistency this is always referred to as accountId. Accepts both IBAN & BBAN"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"displayName":"string","directDebitParameterId":"string","serviceClassCode":0.0,"standardEntryClassCode":"PPD","debitAccountType":"string","debitBankClearingCode":"string","destinationAccountId":"string","debitorName":"string","frequency":"string","paymentDetail":"string","currencyMarket":"string","terminationDate":"2024-01-01","direction":"string","standAloneDdi":"string","standaloneAmount":0.0}},"responses":{"200":"UsDirectDebitsResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/order/us/payments/directDebits","fullPath":"/api/v9.0.0/order/us/payments/directDebits","operationId":"getUsDirectDebits","name":"Retrieve the list of direct debits initiated for repayment of bills or loans from external accounts","summary":"Retrieve direct debits setup for an account","tags":["RETAIL"],"parameters":[{"name":"customerId","in":"query","type":"string","required":false,"description":"Identifier of the customer"},{"name":"directDebitParameterId","in":"query","type":"string","required":false,"description":"Reference to the parameter which holds details relating to clearing accounts, number of days before which the claim has to be submitted or resubmitted"},{"name":"frequency","in":"query","type":"string","required":false,"description":"Specifies the frequency in which the payment application(periodic payments) execute the payment instruction."},{"name":"accountId","in":"query","type":"string","required":false,"description":"Identifier of the account. Often referred to as the account number, yet for consistency this is always referred to as accountId. Accepts both IBAN & BBAN"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"UsDirectDebitsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/order/us/payments/standingOrders","fullPath":"/api/v9.0.0/order/us/payments/standingOrders","operationId":"getUsRecurringTransfers","name":"Retrieve recurring payments setup for account transfers and bill payments","summary":"Get recurring transfer details","tags":["RETAIL"],"parameters":[{"name":"orderingCustomerId","in":"query","type":"string","required":false,"description":"Indicates the customer id for the ordering customer"},{"name":"paymentOrderProductName","in":"query","type":"string","required":false,"description":"Indicates the name of payment order product "},{"name":"accountId","in":"query","type":"string","required":false,"description":"Identifier of the account. Often referred to as the account number, yet for consistency this is always referred to as accountId. Accepts both IBAN & BBAN"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"UsRecurringTransfersResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"POST","path":"/order/us/payments/wireTransfers/simulate","fullPath":"/api/v9.0.0/order/us/payments/wireTransfers/simulate","operationId":"simulateFedwireCTR","name":"Validate payment order transaction to verify the information provided and to retrieve the applicable charges","summary":"Validate payment order transaction ","tags":["RETAIL"],"parameters":[{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"orderingCustomerAddressLines":[{}],"ultimateDebtorAddressLines":[{}],"beneficiaryInstituteAddressLines":[{}],"beneficiaryAddressLines":[{}],"intermediaryFiNameAddressLines":[{}],"intermediary2FiNameAddressLines":[{}],"OriginatorToBeneficiaryLines":[{}],"receiverFiAndIntermediaryFiLines":[{}],"adviceInformation":[{}],"InformationLines":[{}],"charges":[{}],"overrides":[{}],"paymentPriority":"/v1.0.0/reference/lookups?virtualTableName=PAYMENT.SERVICE.LEVEL.CODE","orderingCustomerId":"string","debitAccountId":"string"}},"responses":{"200":"FedwireCTRResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/order/us/payments/paymentStatus","fullPath":"/api/v9.0.0/order/us/payments/paymentStatus","operationId":"getUsPaymentsStatus","name":"Retrieve payment status and transaction history for an account along with beneficiary details and beneficiary status","summary":"Retrieve payment history","tags":["RETAIL"],"parameters":[{"name":"fromDate","in":"query","type":"string","required":false,"description":"Indicates the business date from when the balance reservation event is active."},{"name":"status","in":"query","type":"string","required":false,"description":"The status of the early maturity request"},{"name":"orderingCustomerId","in":"query","type":"string","required":false,"description":"Indicates the customer id for the ordering customer"},{"name":"debitAccountId","in":"query","type":"string","required":false,"description":"Indicates the debit account number of the payment or transaction."},{"name":"paymentOrderId","in":"query","type":"string","required":false,"description":"The unique reference number of payment"},{"name":"transactionReference","in":"query","type":"string","required":false,"description":"Contains the identifier for the transaction in the core system"},{"name":"paymentStatus","in":"query","type":"string","required":false,"description":"Describes the current status of the payment order in the payment system"},{"name":"toDate","in":"query","type":"string","required":false,"description":"Indicates the business date until when the balance reservation event is active."},{"name":"beneficiaryId","in":"query","type":"string","required":false,"description":"Indicates the reference of the financial institution that allows access to the beneficiary information"},{"name":"beneficiaryAccountId","in":"query","type":"string","required":false,"description":"Unique account identifier of the beneficiary account number."},{"name":"direction","in":"query","type":"string","required":false,"description":"Indicates the direction of the Direct debit claim for which mandate is received. The claim can be 'Outward' i.e. Claim is sent to the other bank or 'Inward'  i.e. other bank submit their claim to debi"},{"name":"paymentOrderProductId","in":"query","type":"string","required":false,"description":"Indicates the payment order product for which payment is initiated"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"UsPaymentsStatusResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"POST","path":"/order/us/payments/microDeposits","fullPath":"/api/v9.0.0/order/us/payments/microDeposits","operationId":"createUsACHBatchMicroDeposits","name":"Create a microdeposit batch to validate external account for a new beneficiary added by customer","summary":"Create a microdeposit batch to validate external account","tags":["RETAIL"],"parameters":[{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"entryDetails":[{}],"accountType":"string","recordStatus":"string","currNo":"string","inputter":"string","dateTime":"string","authoriser":"string","companyId":"string","deptCOde":"string","auditorCode":"string","auditTimeDate":"string","extensions":{}}},"responses":{"200":"UsACHBatchMicroDepositsResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/order/us/payments/customers/{orderingCustomerId}/directDebits/achDebits","fullPath":"/api/v9.0.0/order/us/payments/customers/{orderingCustomerId}/directDebits/achDebits","operationId":"getUsACHBatchAchDebits","name":"Retrieve list of customer initiated debit request to external accounts processed through ACH clearing and the interbank automated clearing house","summary":"Retrieve list of customer initiated debit request to external accounts","tags":["RETAIL"],"parameters":[{"name":"orderingCustomerId","in":"path","type":"string","required":true,"description":"Indicates the customer id for the ordering customer"},{"name":"effectiveDate","in":"query","type":"string","required":false,"description":"Contains the identifier for the transaction date. Dates are expected in \u00e2\u20ac\u02dcYYYYMMDD\u00e2\u20ac\u2122 format"},{"name":"creditAccountId","in":"query","type":"string","required":false,"description":"Credit account identifier of the payment or transaction"},{"name":"transactionCode","in":"query","type":"string","required":false,"description":"Identifies the system internal transaction code applicable to the transaction"},{"name":"amount","in":"query","type":"string","required":false,"description":"Contains the direct debit claim amount"},{"name":"beneficiaryInstituteRoutingNo","in":"query","type":"string","required":false,"description":"Routing number of DDA number of the Financial institution where the beneficiary account exists"},{"name":"debitAccountId","in":"query","type":"string","required":false,"description":"Indicates the debit account number of the payment or transaction."},{"name":"debitorName","in":"query","type":"string","required":false,"description":"The name of the customer who owns the destination account or the debit account used to collect payments"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"UsACHBatchAchDebitsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"POST","path":"/order/us/payments/wireTransfers/cancel/{transactionReference}","fullPath":"/api/v9.0.0/order/us/payments/wireTransfers/cancel/{transactionReference}","operationId":"reverseUsWireTransfer","name":"Request can be sent to initiate cancellation for a wire transfer within 30 minutes of submitting the wire payment","summary":"Initiate request to cancel wire transfer","tags":["RETAIL"],"parameters":[{"name":"transactionReference","in":"path","type":"string","required":true,"description":"Contains the identifier for the transaction in the core system"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"overrideDetails":[{}],"inputter":[{}],"dateTime":[{}],"transactionReference":"string","processingDate":"2024-01-01","statusCode":0.0,"sendersReference":"string","orderingAccount":"string","orderingName":"string","debitCustomerId":0.0,"recordStatus":"string","currNo":0.0,"authoriser":"string","companyCode":"string","deptCode":"string"}},"responses":{"200":"UsWireTransferResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"POST","path":"/order/us/payments/swiftTransfers/cancel/{transactionReference}","fullPath":"/api/v9.0.0/order/us/payments/swiftTransfers/cancel/{transactionReference}","operationId":"cancelSwiftTransaction","name":"Request to cancel international payments initiated within 30 minutes of submitting the payment","summary":"Initiate request to cancel international transfers","tags":["RETAIL"],"parameters":[{"name":"transactionReference","in":"path","type":"string","required":true,"description":"Contains the identifier for the transaction in the core system"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"inputter":[{}],"dateTime":[{}],"companyId":"string","transactionReference":"string","amount":0.0,"currencyId":"string","paymentMsgSentDate":"2024-01-01","outputChannel":"string","statusCode":"string","recordStatus":"string","currNo":0.0,"authoriser":"string","companyCode":"string","deptCode":"string","auditorCode":"string"}},"responses":{"200":"SwiftTransactionResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/order/us/payments/achEntry/{achEntryId}/achEntryStatus","fullPath":"/api/v9.0.0/order/us/payments/achEntry/{achEntryId}/achEntryStatus","operationId":"updateAchNOCEntriesStatus","name":"Allows to update the ACH entries status to processed","summary":"Allows to update the ACH entries status to processed","tags":["RETAIL"],"parameters":[{"name":"achEntryId","in":"path","type":"string","required":true,"description":""},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"achEntryStatus":"string","paymentOrderId":"string","transactionReference":"string","executionDate":"string","deliveryByDate":"string","creditDebitIndicator":"string","beneficiaryInstituteRoutingNo":"string","beneficiaryName":"string","beneficiaryOtherId":"string","accountId":"string","paymentAmount":"string","standardEntryClassCode":"string","extensions":{}}},"responses":{"200":"AchNOCEntriesStatusResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"POST","path":"/order/us/payments/directDebits/achDebits","fullPath":"/api/v9.0.0/order/us/payments/directDebits/achDebits","operationId":"createUsAchSameDayDebits","name":"Initiates same day ACH debit collection transaction","summary":"Initiates same day debit transfers","tags":["RETAIL"],"parameters":[{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"creditAccountId":"string","amount":"string","effectiveDate":"string","debitBankClearingCode":"string","debitAccountId":"string","debitorName":"string","additionalInformation":"string","standardEntryClassCode":"CCD","debitAccountType":"Checking","customerType":"Business","companyEntryDescription":"string","extensions":{}}},"responses":{"200":"UsAchSameDayDebitsResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/order/us/payments/wireTransfers/accounts/{debitAccountId}/mandates","fullPath":"/api/v9.0.0/order/us/payments/wireTransfers/accounts/{debitAccountId}/mandates","operationId":"getUsDrawdownMandates","name":"Retrieves all the available drawdown authorization or mandates for an account.","summary":"Retrieves drawdown mandates ","tags":["RETAIL"],"parameters":[{"name":"debitAccountId","in":"path","type":"string","required":true,"description":"Indicates the debit account number of the payment or transaction."},{"name":"beneficiaryAccountId","in":"query","type":"string","required":false,"description":"Unique account identifier of the beneficiary account number."},{"name":"routingNumber","in":"query","type":"string","required":false,"description":"Indicates the routing number of the bank where the account is held"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"UsDrawdownMandatesResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"POST","path":"/order/us/payments/wireTransfers/mandates","fullPath":"/api/v9.0.0/order/us/payments/wireTransfers/mandates","operationId":"createUsDrawdownMandate","name":"Allows to create a drawdown authorization for a customer for approving automatic drawdown transfer via wire payment to debit their account based on a drawdown request (1031 or 1631) received from the creditor's financial institution. The authorization form or the mandate form captures the credit account number, the financial institution where the creditor account is held, the purpose for which the debit request will be sent, the maximum amount allowed to be debited upon a drawdown request and th","summary":"Allows to create a drawdown authorization","tags":["RETAIL"],"parameters":[{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"debitAccountId":"string","debitAccountName":"string","beneficiaryAccountId":"string","drawdownAmount":0.0,"beneficiaryInstituteName":"string","routingNumber":"string","beneficiaryName":"string","accountType":"/v1.0.0/reference/lookups?virtualTableName=USRTGS.ACCT.TYPE","beneficiaryAddress":"string","receiverFiAndIntermediaryFiInfo":"string","effectiveFromDate":"2024-01-01","effectiveToDate":"2024-01-01","extensions":{}}},"responses":{"200":"UsDrawdownMandateResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/order/us/payments/wireTransfers/{mandateId}/mandates","fullPath":"/api/v9.0.0/order/us/payments/wireTransfers/{mandateId}/mandates","operationId":"updateUsDrawdownMandate","name":"Allows to update existing drawdown authorization or mandate created for a customer to approve automatic drawdown transfer via wire payment to debit their account and crediting an external account","summary":"Allows to update existing drawdown authorization","tags":["RETAIL"],"parameters":[{"name":"mandateId","in":"path","type":"string","required":true,"description":""},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"debitAccountId":"string","debitAccountName":"string","beneficiaryAccountId":"string","drawdownAmount":0.0,"beneficiaryInstituteName":"string","routingNumber":"string","beneficiaryName":"string","accountType":"/v1.0.0/reference/lookups?virtualTableName=USRTGS.ACCT.TYPE","beneficiaryAddress":"string","receiverFiAndIntermediaryFiInfo":"string","effectiveFromDate":"2024-01-01","effectiveToDate":"2024-01-01","extensions":{}}},"responses":{"200":"UsDrawdownMandateResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"POST","path":"/order/us/payments/wireTransfers/surplusSweep","fullPath":"/api/v9.0.0/order/us/payments/wireTransfers/surplusSweep","operationId":"createFedwireETI","name":"Creates Fedwire fund transfer to manage their excess funds","summary":"Creates fund transfer for excess funds","tags":["RETAIL"],"parameters":[{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"orderingCustomerAddresses":[{}],"beneficiaryInstituteAddresses":[{}],"beneficiaryAddresses":[{}],"paymentPriority":"string","senderRoutingNo":"string","orderingCustomerId":"string","debitAccountId":"string","schedulePaymentAmount":"string","accountWithBankSortCode":"string","beneficiaryId":"string","beneficiaryName":"string","beneficiaryAccountId":"string","extensions":{}}},"responses":{"200":"FedwireETIResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"POST","path":"/order/us/payments/wires/customerTransfers","fullPath":"/api/v9.0.0/order/us/payments/wires/customerTransfers","operationId":"createFedwire-CTR","name":"Creates an instant payment through  fedwire payment type of  customer transfer (CTR, CTP)","summary":"Creates a customer transfer through wire payment","tags":["RETAIL"],"parameters":[{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"orderingCustomerAddressLines":[{}],"ultimateDebtorAddressLines":[{}],"beneficiaryInstituteAddressLines":[{}],"beneficiaryAddressLines":[{}],"intermediaryFiNameAddressLines":[{}],"intermediary2FiNameAddressLines":[{}],"OriginatorToBeneficiaryLines":[{}],"receiverFiAndIntermediaryFiLines":[{}],"adviceInformation":[{}],"InformationLines":[{}],"charges":[{}],"overrides":[{}],"paymentPriority":"/v1.0.0/reference/lookups?virtualTableName=PAYMENT.SERVICE.LEVEL.CODE","orderingCustomerId":"string","debitAccountId":"string"}},"responses":{"200":"Fedwire-CTRResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"POST","path":"/order/us/payments/wires/bankTransfers","fullPath":"/api/v9.0.0/order/us/payments/wires/bankTransfers","operationId":"createFedwireBankTransfer","name":"Creates an instant payment through fedwire of bank transfer payment type (BTR,FFS,FFR,CKS and DEP)","summary":"Creates a bank transfer through wire payment","tags":["RETAIL"],"parameters":[{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"orderingCustomerAddressLines":[{}],"ultimateDebtorAddressLines":[{}],"beneficiaryInstituteAddressLines":[{}],"intermediaryFiNameAddressLines":[{}],"intermediary2FiNameAddressLines":[{}],"OriginatorToBeneficiaryLines":[{}],"receiverFiAndIntermediaryFiLines":[{}],"adviceInformation":[{}],"InformationLines":[{}],"charges":[{}],"overrides":[{}],"paymentPriority":"/v1.0.0/reference/lookups?virtualTableName=PAYMENT.SERVICE.LEVEL.CODE","orderingCustomerId":"string","debitAccountId":"string","schedulePaymentAmount":0.0}},"responses":{"200":"FedwireBankTransferResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}}]},{"key":"order-us-payments-service-v9.1.0","title":"Same day debits","version":"v9.1.0","description":"Initiates same day debit transfers","endpointCount":27,"endpoints":[{"method":"POST","path":"/order/us/payments/escrows","fullPath":"/api/v9.1.0/order/us/payments/escrows","operationId":"createEscrowAdhocDeposit","name":"Initiates an escrow payment transaction","summary":"Escrow payment","tags":["RETAIL"],"parameters":[{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"overrideDetails":[{}],"creditAccountId":"@ref:product-accountOperationalDate-service-v1.0.0","creditValueDate":"2024-01-01","creditCurrencyId":"string","creditAmount":0.0,"debitAccountId":"@ref:product-accountOperationalDate-service-v1.0.0","debitValueDate":"2024-01-01","debitCurrencyId":"string","debitAmount":0.0,"treasuryRate":0.0,"processingDate":"2024-01-01","customerRate":0.0,"customerSpread":0.0,"recordStatus":"string","currNo":0.0}},"responses":{"200":"EscrowAdhocDepositResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"POST","path":"/order/us/accounts/{accountId}/reservedFunds","fullPath":"/api/v9.1.0/order/us/accounts/{accountId}/reservedFunds","operationId":"createAccountBalanceHold","name":"Create a hold transaction to lock the funds in an account","summary":"Create account hold","tags":["RETAIL"],"parameters":[{"name":"accountId","in":"path","type":"string","required":true,"description":"Identifier of the account. Often referred to as the account number, yet for consistency this is always referred to as accountId. Accepts both IBAN & BBAN"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"overrides":[{}],"holdTypeId":"/v1.0.0/reference/us/accountHoldTypes","description":"string","fromDate":"2024-01-01","toDate":"2024-01-01","lockedAmount":0.0,"blockPriorityId":"string","recordStatus":"string","currNo":0.0,"inputter":"string","dateTime":0.0,"authoriser":"string","companyId":"@ref:reference-companies-service-v1.0.0","deptCode":"@ref:reference-accountOfficers-service-v1.0.0","auditorCode":"string"}},"responses":{"200":"AccountBalanceHoldResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/order/us/accounts/reservedFunds/{holdId}","fullPath":"/api/v9.1.0/order/us/accounts/reservedFunds/{holdId}","operationId":"getAccountBalanceHold","name":"Retrieves information of the amount locked, lock type and the validity for a hold transaction","summary":"Retrieve hold funds detail","tags":["RETAIL"],"parameters":[{"name":"holdId","in":"path","type":"string","required":true,"description":"The transaction reference through which the specified amount in the transaction has been locked in an account"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"AccountBalanceHoldResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/order/us/payments/holds/{holdId}","fullPath":"/api/v9.1.0/order/us/payments/holds/{holdId}","operationId":"updateAccountBalanceHold","name":"Update amount or validity date of an existing hold","summary":"Update existing hold","tags":["RETAIL"],"parameters":[{"name":"holdId","in":"path","type":"string","required":true,"description":"The transaction reference through which the specified amount in the transaction has been locked in an account"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"overrides":[{}],"holdTypeId":"/v1.0.0/reference/us/accountHoldTypes","description":"string","fromDate":"2024-01-01","toDate":"2024-01-01","lockedAmount":0.0,"blockPriorityId":"string","recordStatus":"string","currNo":0.0,"inputter":"string","dateTime":0.0,"authoriser":"string","companyId":"@ref:reference-companies-service-v1.0.0","deptCode":"@ref:reference-accountOfficers-service-v1.0.0","auditorCode":"string"}},"responses":{"200":"AccountBalanceHoldResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/order/us/payments/accounts/{accountId}/holdSummary","fullPath":"/api/v9.1.0/order/us/payments/accounts/{accountId}/holdSummary","operationId":"getAccountHoldDetails","name":"Retrieves details of all holds placed on an account","summary":"Get hold summary","tags":["RETAIL"],"parameters":[{"name":"accountId","in":"path","type":"string","required":true,"description":"Identifier of the account. Often referred to as the account number, yet for consistency this is always referred to as accountId. Accepts both IBAN & BBAN"},{"name":"holdTypeId","in":"query","type":"string","required":false,"description":"Purpose or the type of hold placed on the account  The available list of hold types can be retrieved through getHoldTypes"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"AccountHoldDetailsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"POST","path":"/order/us/payments/transactionStops","fullPath":"/api/v9.1.0/order/us/payments/transactionStops","operationId":"createUsTransactionStop","name":"Create transaction stop instruction to capture instructions to stop a payment based on the payment type, recipient or amount","summary":"Create transaction stop instruction","tags":["RETAIL"],"parameters":[{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"stopCondition":[{}],"accountId":"@ref:product-accountOperationalDate-service-v1.0.0","stopTypeId":"string","transactionChannel":"string","stopInstructionChannel":"BANK","stopReason":"CHKDES","issueDate":"string","replacementCheck":"string","replacementCheckIssueDate":"string","expiryDate":"string","waiveCharge":"string","transactionStopStatus":"ACTIVE","suppressNotice":"string","cancelInstruction":"YES","override":"string"}},"responses":{"200":"UsTransactionStopResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"DELETE","path":"/order/us/payments/transactionStops/{stopInstructionId}","fullPath":"/api/v9.1.0/order/us/payments/transactionStops/{stopInstructionId}","operationId":"deleteUsTransactionStop","name":"Deletes a transaction stop instruction capturing with instructions to stop a payment","summary":"Delete transaction stop","tags":["RETAIL"],"parameters":[{"name":"stopInstructionId","in":"path","type":"string","required":true,"description":"ID of stop instruction"},{"name":"payload","in":"body","type":"object","required":false,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}}},"responses":{"200":"UsTransactionStopResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"POST","path":"/order/us/payments/wireTransfers","fullPath":"/api/v9.1.0/order/us/payments/wireTransfers","operationId":"createFedwireCTR","name":"Creates an instant payment through  fedwire of payment type CTR, customer transfer","summary":"Creates a customer transfer through wire payment","tags":["RETAIL"],"parameters":[{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"orderingCustomerAddressLines":[{}],"ultimateDebtorAddressLines":[{}],"beneficiaryInstituteAddressLines":[{}],"beneficiaryAddressLines":[{}],"intermediaryFiNameAddressLines":[{}],"intermediary2FiNameAddressLines":[{}],"OriginatorToBeneficiaryLines":[{}],"receiverFiAndIntermediaryFiLines":[{}],"adviceInformation":[{}],"InformationLines":[{}],"charges":[{}],"overrides":[{}],"paymentPriority":"/v1.0.0/reference/lookups?virtualTableName=PAYMENT.SERVICE.LEVEL.CODE","orderingCustomerId":"string","debitAccountId":"string"}},"responses":{"200":"FedwireCTRResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"POST","path":"/order/us/payments/paymentOrders","fullPath":"/api/v9.1.0/order/us/payments/paymentOrders","operationId":"createUsDomesticTransfer","name":"Create one-time domestic account transfers and bill payments through ACH Clearing and the interbank automated clearing house","summary":"Create domestic transfer","tags":["RETAIL"],"parameters":[{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"standardEntryClassCode":"CIE","companyEntryDescription":"string","debitAccountId":"string","transactionAmount":0.0,"requiredCreditValueDate":"2024-01-01","beneficiaryId":"/v1.0.0/party/us/customers/{customerId}/beneficiaries","transactionCode":0.0,"beneficiaryOtherId":"string","accountWithBankClearingCode":"string","beneficiaryAccountId":"string","beneficiaryName":"string","narrative":"string","paymentCurrency":"string","paymentOrderProductId":"string","recordStatus":"string"}},"responses":{"200":"UsDomesticTransferResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"POST","path":"/order/us/payments/standingOrders/{accountId}","fullPath":"/api/v9.1.0/order/us/payments/standingOrders/{accountId}","operationId":"createUsRecurringTransfers","name":"Create a recurring account transfer","summary":"Create recurring transfer","tags":["RETAIL"],"parameters":[{"name":"accountId","in":"path","type":"string","required":true,"description":"Identifier of the account. Often referred to as the account number, yet for consistency this is always referred to as accountId. Accepts both IBAN & BBAN"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"beneficiaries":[{}],"currentFrequency":"string","standardEntryClassCode":"CIE","startDate":"2024-01-01","companyEntryDescription":"string","currentEndDate":"2024-01-01","currentAmountBalance":0.0,"beneficiaryId":"/v1.0.0/party/us/customers/{customerId}/beneficiaries","transactionCode":0.0,"beneficiaryOtherId":"string","accountWithBankClearingCode":"string","beneficiaryAccountId":"string","paymentDetail":"string","currency":"string","recordStatus":"string"}},"responses":{"200":"UsRecurringTransfersResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"POST","path":"/order/us/payments/directDebits/{accountId}","fullPath":"/api/v9.1.0/order/us/payments/directDebits/{accountId}","operationId":"createUsDirectDebits","name":"Create direct debit instructions for repayment of loans or bill payment through external accounts","summary":"Create direct debit instruction","tags":["RETAIL"],"parameters":[{"name":"accountId","in":"path","type":"string","required":true,"description":"Identifier of the account. Often referred to as the account number, yet for consistency this is always referred to as accountId. Accepts both IBAN & BBAN"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"displayName":"string","directDebitParameterId":"string","serviceClassCode":0.0,"standardEntryClassCode":"PPD","debitAccountType":"string","debitBankClearingCode":"string","destinationAccountId":"string","debitorName":"string","frequency":"string","paymentDetail":"string","currencyMarket":"string","terminationDate":"2024-01-01","direction":"string","standAloneDdi":"string","standaloneAmount":0.0}},"responses":{"200":"UsDirectDebitsResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/order/us/payments/directDebits","fullPath":"/api/v9.1.0/order/us/payments/directDebits","operationId":"getUsDirectDebits","name":"Retrieve the list of direct debits initiated for repayment of bills or loans from external accounts","summary":"Retrieve direct debits setup for an account","tags":["RETAIL"],"parameters":[{"name":"customerId","in":"query","type":"string","required":false,"description":"Identifier of the customer"},{"name":"directDebitParameterId","in":"query","type":"string","required":false,"description":"Reference to the parameter which holds details relating to clearing accounts, number of days before which the claim has to be submitted or resubmitted"},{"name":"frequency","in":"query","type":"string","required":false,"description":"Specifies the frequency in which the payment application(periodic payments) execute the payment instruction."},{"name":"accountId","in":"query","type":"string","required":false,"description":"Identifier of the account. Often referred to as the account number, yet for consistency this is always referred to as accountId. Accepts both IBAN & BBAN"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"UsDirectDebitsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/order/us/payments/standingOrders","fullPath":"/api/v9.1.0/order/us/payments/standingOrders","operationId":"getUsRecurringTransfers","name":"Retrieve recurring payments setup for account transfers and bill payments","summary":"Get recurring transfer details","tags":["RETAIL"],"parameters":[{"name":"orderingCustomerId","in":"query","type":"string","required":false,"description":"Indicates the customer id for the ordering customer"},{"name":"paymentOrderProductName","in":"query","type":"string","required":false,"description":"Indicates the name of payment order product "},{"name":"accountId","in":"query","type":"string","required":false,"description":"Identifier of the account. Often referred to as the account number, yet for consistency this is always referred to as accountId. Accepts both IBAN & BBAN"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"UsRecurringTransfersResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"POST","path":"/order/us/payments/wireTransfers/simulate","fullPath":"/api/v9.1.0/order/us/payments/wireTransfers/simulate","operationId":"simulateFedwireCTR","name":"Validate payment order transaction to verify the information provided and to retrieve the applicable charges","summary":"Validate payment order transaction ","tags":["RETAIL"],"parameters":[{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"orderingCustomerAddressLines":[{}],"ultimateDebtorAddressLines":[{}],"beneficiaryInstituteAddressLines":[{}],"beneficiaryAddressLines":[{}],"intermediaryFiNameAddressLines":[{}],"intermediary2FiNameAddressLines":[{}],"OriginatorToBeneficiaryLines":[{}],"receiverFiAndIntermediaryFiLines":[{}],"adviceInformation":[{}],"InformationLines":[{}],"charges":[{}],"overrides":[{}],"paymentPriority":"/v1.0.0/reference/lookups?virtualTableName=PAYMENT.SERVICE.LEVEL.CODE","orderingCustomerId":"string","debitAccountId":"string"}},"responses":{"200":"FedwireCTRResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/order/us/payments/paymentStatus","fullPath":"/api/v9.1.0/order/us/payments/paymentStatus","operationId":"getUsPaymentsStatus","name":"Retrieve payment status and transaction history for an account along with beneficiary details and beneficiary status","summary":"Retrieve payment history","tags":["RETAIL"],"parameters":[{"name":"fromDate","in":"query","type":"string","required":false,"description":"Indicates the business date from when the balance reservation event is active."},{"name":"status","in":"query","type":"string","required":false,"description":"The status of the early maturity request"},{"name":"orderingCustomerId","in":"query","type":"string","required":false,"description":"Indicates the customer id for the ordering customer"},{"name":"debitAccountId","in":"query","type":"string","required":false,"description":"Indicates the debit account number of the payment or transaction."},{"name":"paymentOrderId","in":"query","type":"string","required":false,"description":"The unique reference number of payment"},{"name":"transactionReference","in":"query","type":"string","required":false,"description":"Contains the identifier for the transaction in the core system"},{"name":"paymentStatus","in":"query","type":"string","required":false,"description":"Describes the current status of the payment order in the payment system"},{"name":"toDate","in":"query","type":"string","required":false,"description":"Indicates the business date until when the balance reservation event is active."},{"name":"beneficiaryId","in":"query","type":"string","required":false,"description":"Indicates the reference of the financial institution that allows access to the beneficiary information"},{"name":"beneficiaryAccountId","in":"query","type":"string","required":false,"description":"Unique account identifier of the beneficiary account number."},{"name":"direction","in":"query","type":"string","required":false,"description":"Indicates the direction of the Direct debit claim for which mandate is received. The claim can be 'Outward' i.e. Claim is sent to the other bank or 'Inward'  i.e. other bank submit their claim to debi"},{"name":"paymentOrderProductId","in":"query","type":"string","required":false,"description":"Indicates the payment order product for which payment is initiated"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"UsPaymentsStatusResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"POST","path":"/order/us/payments/microDeposits","fullPath":"/api/v9.1.0/order/us/payments/microDeposits","operationId":"createUsACHBatchMicroDeposits","name":"Create a microdeposit batch to validate external account for a new beneficiary added by customer","summary":"Create a microdeposit batch to validate external account","tags":["RETAIL"],"parameters":[{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"entryDetails":[{}],"accountType":"string","recordStatus":"string","currNo":"string","inputter":"string","dateTime":"string","authoriser":"string","companyId":"string","deptCOde":"string","auditorCode":"string","auditTimeDate":"string","extensions":{}}},"responses":{"200":"UsACHBatchMicroDepositsResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/order/us/payments/customers/{orderingCustomerId}/directDebits/achDebits","fullPath":"/api/v9.1.0/order/us/payments/customers/{orderingCustomerId}/directDebits/achDebits","operationId":"getUsACHBatchAchDebits","name":"Retrieve list of customer initiated debit request to external accounts processed through ACH clearing and the interbank automated clearing house","summary":"Retrieve list of customer initiated debit request to external accounts","tags":["RETAIL"],"parameters":[{"name":"orderingCustomerId","in":"path","type":"string","required":true,"description":"Indicates the customer id for the ordering customer"},{"name":"effectiveDate","in":"query","type":"string","required":false,"description":"Contains the identifier for the transaction date. Dates are expected in \u00e2\u20ac\u02dcYYYYMMDD\u00e2\u20ac\u2122 format"},{"name":"creditAccountId","in":"query","type":"string","required":false,"description":"Credit account identifier of the payment or transaction"},{"name":"transactionCode","in":"query","type":"string","required":false,"description":"Identifies the system internal transaction code applicable to the transaction"},{"name":"amount","in":"query","type":"string","required":false,"description":"Contains the direct debit claim amount"},{"name":"beneficiaryInstituteRoutingNo","in":"query","type":"string","required":false,"description":"Routing number of DDA number of the Financial institution where the beneficiary account exists"},{"name":"debitAccountId","in":"query","type":"string","required":false,"description":"Indicates the debit account number of the payment or transaction."},{"name":"debitorName","in":"query","type":"string","required":false,"description":"The name of the customer who owns the destination account or the debit account used to collect payments"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"UsACHBatchAchDebitsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"POST","path":"/order/us/payments/wireTransfers/cancel/{transactionReference}","fullPath":"/api/v9.1.0/order/us/payments/wireTransfers/cancel/{transactionReference}","operationId":"reverseUsWireTransfer","name":"Request can be sent to initiate cancellation for a wire transfer within 30 minutes of submitting the wire payment","summary":"Initiate request to cancel wire transfer","tags":["RETAIL"],"parameters":[{"name":"transactionReference","in":"path","type":"string","required":true,"description":"Contains the identifier for the transaction in the core system"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"overrideDetails":[{}],"inputter":[{}],"dateTime":[{}],"transactionReference":"string","processingDate":"2024-01-01","statusCode":0.0,"sendersReference":"string","orderingAccount":"string","orderingName":"string","debitCustomerId":0.0,"recordStatus":"string","currNo":0.0,"authoriser":"string","companyCode":"string","deptCode":"string"}},"responses":{"200":"UsWireTransferResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"POST","path":"/order/us/payments/swiftTransfers/cancel/{transactionReference}","fullPath":"/api/v9.1.0/order/us/payments/swiftTransfers/cancel/{transactionReference}","operationId":"cancelSwiftTransaction","name":"Request to cancel international payments initiated within 30 minutes of submitting the payment","summary":"Initiate request to cancel international transfers","tags":["RETAIL"],"parameters":[{"name":"transactionReference","in":"path","type":"string","required":true,"description":"Contains the identifier for the transaction in the core system"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"inputter":[{}],"dateTime":[{}],"companyId":"string","transactionReference":"string","amount":0.0,"currencyId":"string","paymentMsgSentDate":"2024-01-01","outputChannel":"string","statusCode":"string","recordStatus":"string","currNo":0.0,"authoriser":"string","companyCode":"string","deptCode":"string","auditorCode":"string"}},"responses":{"200":"SwiftTransactionResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/order/us/payments/achEntry/{achEntryId}/achEntryStatus","fullPath":"/api/v9.1.0/order/us/payments/achEntry/{achEntryId}/achEntryStatus","operationId":"updateAchNOCEntriesStatus","name":"Allows to update the ACH entries status to processed","summary":"Allows to update the ACH entries status to processed","tags":["RETAIL"],"parameters":[{"name":"achEntryId","in":"path","type":"string","required":true,"description":""},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"achEntryStatus":"string","paymentOrderId":"string","transactionReference":"string","executionDate":"string","deliveryByDate":"string","creditDebitIndicator":"string","beneficiaryInstituteRoutingNo":"string","beneficiaryName":"string","beneficiaryOtherId":"string","accountId":"string","paymentAmount":"string","standardEntryClassCode":"string","extensions":{}}},"responses":{"200":"AchNOCEntriesStatusResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"POST","path":"/order/us/payments/directDebits/achDebits","fullPath":"/api/v9.1.0/order/us/payments/directDebits/achDebits","operationId":"createUsAchSameDayDebits","name":"Initiates same day ACH debit collection transaction","summary":"Initiates same day debit transfers","tags":["RETAIL"],"parameters":[{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"creditAccountId":"string","amount":"string","effectiveDate":"string","debitBankClearingCode":"string","debitAccountId":"string","debitorName":"string","additionalInformation":"string","standardEntryClassCode":"CCD","debitAccountType":"Checking","customerType":"Business","companyEntryDescription":"string","extensions":{}}},"responses":{"200":"UsAchSameDayDebitsResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/order/us/payments/wireTransfers/accounts/{debitAccountId}/mandates","fullPath":"/api/v9.1.0/order/us/payments/wireTransfers/accounts/{debitAccountId}/mandates","operationId":"getUsDrawdownMandates","name":"Retrieves all the available drawdown authorization or mandates for an account.","summary":"Retrieves drawdown mandates ","tags":["RETAIL"],"parameters":[{"name":"debitAccountId","in":"path","type":"string","required":true,"description":"Indicates the debit account number of the payment or transaction."},{"name":"beneficiaryAccountId","in":"query","type":"string","required":false,"description":"Unique account identifier of the beneficiary account number."},{"name":"routingNumber","in":"query","type":"string","required":false,"description":"Indicates the routing number of the bank where the account is held"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"UsDrawdownMandatesResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"POST","path":"/order/us/payments/wireTransfers/mandates","fullPath":"/api/v9.1.0/order/us/payments/wireTransfers/mandates","operationId":"createUsDrawdownMandate","name":"Allows to create a drawdown authorization for a customer for approving automatic drawdown transfer via wire payment to debit their account based on a drawdown request (1031 or 1631) received from the creditor's financial institution. The authorization form or the mandate form captures the credit account number, the financial institution where the creditor account is held, the purpose for which the debit request will be sent, the maximum amount allowed to be debited upon a drawdown request and th","summary":"Allows to create a drawdown authorization","tags":["RETAIL"],"parameters":[{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"debitAccountId":"string","debitAccountName":"string","beneficiaryAccountId":"string","drawdownAmount":0.0,"beneficiaryInstituteName":"string","routingNumber":"string","beneficiaryName":"string","accountType":"/v1.0.0/reference/lookups?virtualTableName=USRTGS.ACCT.TYPE","beneficiaryAddress":"string","receiverFiAndIntermediaryFiInfo":"string","effectiveFromDate":"2024-01-01","effectiveToDate":"2024-01-01","extensions":{}}},"responses":{"200":"UsDrawdownMandateResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/order/us/payments/wireTransfers/{mandateId}/mandates","fullPath":"/api/v9.1.0/order/us/payments/wireTransfers/{mandateId}/mandates","operationId":"updateUsDrawdownMandate","name":"Allows to update existing drawdown authorization or mandate created for a customer to approve automatic drawdown transfer via wire payment to debit their account and crediting an external account","summary":"Allows to update existing drawdown authorization","tags":["RETAIL"],"parameters":[{"name":"mandateId","in":"path","type":"string","required":true,"description":""},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"debitAccountId":"string","debitAccountName":"string","beneficiaryAccountId":"string","drawdownAmount":0.0,"beneficiaryInstituteName":"string","routingNumber":"string","beneficiaryName":"string","accountType":"/v1.0.0/reference/lookups?virtualTableName=USRTGS.ACCT.TYPE","beneficiaryAddress":"string","receiverFiAndIntermediaryFiInfo":"string","effectiveFromDate":"2024-01-01","effectiveToDate":"2024-01-01","extensions":{}}},"responses":{"200":"UsDrawdownMandateResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"POST","path":"/order/us/payments/wireTransfers/surplusSweep","fullPath":"/api/v9.1.0/order/us/payments/wireTransfers/surplusSweep","operationId":"createFedwireETI","name":"Creates Fedwire fund transfer to manage their excess funds","summary":"Creates fund transfer for excess funds","tags":["RETAIL"],"parameters":[{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"orderingCustomerAddresses":[{}],"beneficiaryInstituteAddresses":[{}],"beneficiaryAddresses":[{}],"paymentPriority":"string","senderRoutingNo":"string","orderingCustomerId":"string","debitAccountId":"string","schedulePaymentAmount":"string","accountWithBankSortCode":"string","beneficiaryId":"string","beneficiaryName":"string","beneficiaryAccountId":"string","extensions":{}}},"responses":{"200":"FedwireETIResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"POST","path":"/order/us/payments/wires/customerTransfers","fullPath":"/api/v9.1.0/order/us/payments/wires/customerTransfers","operationId":"createFedwire-CTR","name":"Creates an instant payment through  fedwire payment type of  customer transfer (CTR, CTP)","summary":"Creates a customer transfer through wire payment","tags":["RETAIL"],"parameters":[{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"orderingCustomerAddressLines":[{}],"ultimateDebtorAddressLines":[{}],"beneficiaryInstituteAddressLines":[{}],"beneficiaryAddressLines":[{}],"intermediaryFiNameAddressLines":[{}],"intermediary2FiNameAddressLines":[{}],"OriginatorToBeneficiaryLines":[{}],"receiverFiAndIntermediaryFiLines":[{}],"adviceInformation":[{}],"InformationLines":[{}],"charges":[{}],"overrides":[{}],"paymentPriority":"/v1.0.0/reference/lookups?virtualTableName=PAYMENT.SERVICE.LEVEL.CODE","orderingCustomerId":"string","debitAccountId":"string"}},"responses":{"200":"Fedwire-CTRResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"POST","path":"/order/us/payments/wires/bankTransfers","fullPath":"/api/v9.1.0/order/us/payments/wires/bankTransfers","operationId":"createFedwireBankTransfer","name":"Creates an instant payment through fedwire of bank transfer payment type (BTR,FFS,FFR,CKS and DEP)","summary":"Creates a bank transfer through wire payment","tags":["RETAIL"],"parameters":[{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"orderingCustomerAddressLines":[{}],"ultimateDebtorAddressLines":[{}],"beneficiaryInstituteAddressLines":[{}],"intermediaryFiNameAddressLines":[{}],"intermediary2FiNameAddressLines":[{}],"OriginatorToBeneficiaryLines":[{}],"receiverFiAndIntermediaryFiLines":[{}],"adviceInformation":[{}],"InformationLines":[{}],"charges":[{}],"overrides":[{}],"paymentPriority":"/v1.0.0/reference/lookups?virtualTableName=PAYMENT.SERVICE.LEVEL.CODE","orderingCustomerId":"string","debitAccountId":"string","schedulePaymentAmount":0.0}},"responses":{"200":"FedwireBankTransferResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}}]},{"key":"order-us-reports-service-v1.0.0","title":"Service APIs for Currency Transaction Reporting","version":"v1.0.0","description":"APIs updates and retrieves information on cash transactions performed by a customer ","endpointCount":4,"endpoints":[{"method":"GET","path":"/order/us/reports/customers/{ctrId}/payment/cashTransactions","fullPath":"/api/v1.0.0/order/us/reports/customers/{ctrId}/payment/cashTransactions","operationId":"getCTRDetails","name":"Retrieve Currency Transaction details","summary":"Retrieves the currency transaction details for the customer","tags":["RETAIL"],"parameters":[{"name":"ctrId","in":"path","type":"string","required":true,"description":"Currency Transaction Reference, it is a combination of customer Id and date in YYYYMMDD separated by a hyphen(-)"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"CTRDetailsResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"POST","path":"/order/us/reports/customers/{ctrId}/payment/cashTransactions","fullPath":"/api/v1.0.0/order/us/reports/customers/{ctrId}/payment/cashTransactions","operationId":"createCTRdetails","name":"Capture customer currency transactions performed in a day","summary":"Record currency transactions performed by customer for the business day carried out in external teller system.","tags":["RETAIL"],"parameters":[{"name":"ctrId","in":"path","type":"string","required":true,"description":"Currency Transaction Reference, it is a combination of customer Id and date in YYYYMMDD separated by a hyphen(-)"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"transactionIds":[{}],"overrides":[{}],"inputters":[{}],"dateTimes":[{}],"customerName":"string","ctrExempt":"Yes","foreignCurrencyCashWithdrawal":0.0,"totalDepositAmount":0.0,"totalWithdrawalAmount":0.0,"limitExceed":"Yes","reportCTR":"YES","transactionDate":"2024-01-01","recordStatus":"string","currNo":0.0,"authoriser":"string"}},"responses":{"200":"CTRdetailsResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/order/us/reports/customers/{ctrId}/payment/cashTransactions","fullPath":"/api/v1.0.0/order/us/reports/customers/{ctrId}/payment/cashTransactions","operationId":"updateCTRDetails","name":"Update Currency Transaction details","summary":"Updates the currency transaction information performed by a Customer for the day. Consolidated transaction wise details should be updated by Customer. To add more transaction information, retrieved existing updates and append new transaction information","tags":["RETAIL"],"parameters":[{"name":"ctrId","in":"path","type":"string","required":true,"description":"Currency Transaction Reference, it is a combination of customer Id and date in YYYYMMDD separated by a hyphen(-)"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"transactionIds":[{}],"overrides":[{}],"inputters":[{}],"dateTimes":[{}],"customerName":"string","ctrExempt":"Yes","foreignCurrencyCashWithdrawal":0.0,"totalDepositAmount":0.0,"totalWithdrawalAmount":0.0,"limitExceed":"Yes","reportCTR":"YES","transactionDate":"2024-01-01","recordStatus":"string","currNo":0.0,"authoriser":"string"}},"responses":{"200":"CTRDetailsResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"DELETE","path":"/order/us/reports/customers/{ctrId}/payment/cashTransactions","fullPath":"/api/v1.0.0/order/us/reports/customers/{ctrId}/payment/cashTransactions","operationId":"deleteCTRdetails","name":"Reverse an existing currency transaction record","summary":"To reverse all entries of customer currency transaction details for a given business day that was earlier created.","tags":["RETAIL"],"parameters":[{"name":"ctrId","in":"path","type":"string","required":true,"description":"Currency Transaction Reference, it is a combination of customer Id and date in YYYYMMDD separated by a hyphen(-)"},{"name":"payload","in":"body","type":"object","required":false,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}}},"responses":{"200":"CTRdetailsResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}}]}]},{"name":"Origination","serviceCount":7,"endpointCount":32,"services":[{"key":"origination-currentAccountOpeningPurpose-service-v1.0.0","title":"Current Account Opening","version":"v1.0.0","description":"Current Account Activities","endpointCount":3,"endpoints":[{"method":"POST","path":"/origination/accounts/currentAccounts","fullPath":"/api/v1.0.0/origination/accounts/currentAccounts","operationId":"createCurrentAccount","name":"post request for account opening purpose","summary":"This end point contains all the formlets related to the purpose account opening and user can submit the form as well","tags":[],"parameters":[{"name":"credentials","in":"header","type":"string","required":false,"description":""},{"name":"companyId","in":"header","type":"string","required":false,"description":""},{"name":"payload","in":"body","type":"object","required":true,"description":""}],"requestBodyExample":null,"responses":{"200":"createCurrentAccountResponse","default":"createCurrentAccounterrorResponse"}},{"method":"GET","path":"/origination/accounts/currentAccounts/{dossierId}","fullPath":"/api/v1.0.0/origination/accounts/currentAccounts/{dossierId}","operationId":"getCurrentAccount","name":"Get request for account opening purpose","summary":"This end point contains all the formlets related to the purpose account opening ","tags":[],"parameters":[{"name":"credentials","in":"header","type":"string","required":false,"description":""},{"name":"companyId","in":"header","type":"string","required":false,"description":""},{"name":"dossierId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":null,"responses":{"200":"getCurrentAccountResponse","default":"Missing resource response"}},{"method":"PUT","path":"/origination/accounts/currentAccounts/{dossierId}","fullPath":"/api/v1.0.0/origination/accounts/currentAccounts/{dossierId}","operationId":"updateCurrentAccount","name":"Put request for account opening purpose","summary":"This end point contains all the formlets related to the purpose account opening and user can submit the form as well","tags":[],"parameters":[{"name":"credentials","in":"header","type":"string","required":false,"description":""},{"name":"companyId","in":"header","type":"string","required":false,"description":""},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"dossierId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":null,"responses":{"200":"updateCurrentAccountResponse","default":"updateCurrentAccounterrorResponse"}}]},{"key":"origination-customerOnboardingPurpose-service-v1.0.0","title":"customer onboarding","version":"v1.0.0","description":"purpose api for customer onboarding","endpointCount":3,"endpoints":[{"method":"POST","path":"/origination/customers","fullPath":"/api/v1.0.0/origination/customers","operationId":"createCustomerOnboarding","name":"post request for customer onboarding purpose","summary":"This end point contains all the formlets related to customer onboarding and user can submit the form as well","tags":[],"parameters":[{"name":"credentials","in":"header","type":"string","required":false,"description":""},{"name":"companyId","in":"header","type":"string","required":false,"description":""},{"name":"payload","in":"body","type":"object","required":true,"description":""}],"requestBodyExample":null,"responses":{"200":"createCustomerOnboardingResponse","default":"createCustomerOnboardingerrorResponse"}},{"method":"GET","path":"/origination/customers/{dossierId}","fullPath":"/api/v1.0.0/origination/customers/{dossierId}","operationId":"getCustomerOnboarding","name":"Get request for customer onboarding purpose","summary":"post request for customer onboarding purpose","tags":[],"parameters":[{"name":"credentials","in":"header","type":"string","required":false,"description":""},{"name":"companyId","in":"header","type":"string","required":false,"description":""},{"name":"dossierId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":null,"responses":{"200":"getCustomerOnboardingResponse","default":"Missing resource response"}},{"method":"PUT","path":"/origination/customers/{dossierId}","fullPath":"/api/v1.0.0/origination/customers/{dossierId}","operationId":"updateCustomerOnboarding","name":"put request for customer onboarding purpose","summary":"This end point contains all the formlets related to customer onboarding and user can submit the form as well","tags":[],"parameters":[{"name":"credentials","in":"header","type":"string","required":false,"description":""},{"name":"companyId","in":"header","type":"string","required":false,"description":""},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"dossierId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":null,"responses":{"200":"updateCustomerOnboardingResponse","default":"updateCustomerOnboardingerrorResponse"}}]},{"key":"origination-evidence-service-v1.0.0","title":"evidence api","version":"v1.0.0","description":"bulk api for evidence application","endpointCount":5,"endpoints":[{"method":"POST","path":"/origination/evidence/bankStatements","fullPath":"/api/v1.0.0/origination/evidence/bankStatements","operationId":"acceptBankStatement","name":"","summary":"","tags":[],"parameters":[{"name":"credentials","in":"header","type":"string","required":false,"description":""},{"name":"companyId","in":"header","type":"string","required":false,"description":""},{"name":"payload","in":"body","type":"object","required":true,"description":""}],"requestBodyExample":null,"responses":{"200":"bankStatementResponse","default":"bankStatementError"}},{"method":"POST","path":"/origination/evidence/driverLicences","fullPath":"/api/v1.0.0/origination/evidence/driverLicences","operationId":"acceptDriverLicence","name":"","summary":"","tags":[],"parameters":[{"name":"credentials","in":"header","type":"string","required":false,"description":""},{"name":"companyId","in":"header","type":"string","required":false,"description":""},{"name":"payload","in":"body","type":"object","required":true,"description":""}],"requestBodyExample":null,"responses":{"200":"driverLicenceResponse","default":"driverLicenceError"}},{"method":"POST","path":"/origination/evidence/passports","fullPath":"/api/v1.0.0/origination/evidence/passports","operationId":"acceptPassport","name":"","summary":"","tags":[],"parameters":[{"name":"credentials","in":"header","type":"string","required":false,"description":""},{"name":"companyId","in":"header","type":"string","required":false,"description":""},{"name":"payload","in":"body","type":"object","required":true,"description":""}],"requestBodyExample":null,"responses":{"200":"passportResponse","default":"passportError"}},{"method":"POST","path":"/origination/evidence/payslips","fullPath":"/api/v1.0.0/origination/evidence/payslips","operationId":"acceptPayslip","name":"","summary":"","tags":[],"parameters":[{"name":"credentials","in":"header","type":"string","required":false,"description":""},{"name":"companyId","in":"header","type":"string","required":false,"description":""},{"name":"payload","in":"body","type":"object","required":true,"description":""}],"requestBodyExample":null,"responses":{"200":"payslipResponse","default":"payslipError"}},{"method":"POST","path":"/origination/evidence/utilityBills","fullPath":"/api/v1.0.0/origination/evidence/utilityBills","operationId":"acceptUtilityBill","name":"","summary":"","tags":[],"parameters":[{"name":"credentials","in":"header","type":"string","required":false,"description":""},{"name":"companyId","in":"header","type":"string","required":false,"description":""},{"name":"payload","in":"body","type":"object","required":true,"description":""}],"requestBodyExample":null,"responses":{"200":"utilityBillResponse","default":"utilityBillError"}}]},{"key":"origination-genericServices-service-v1.0.0","title":"Origination Generic apis","version":"v1.0.0","description":"Generic apis for Origination","endpointCount":9,"endpoints":[{"method":"PUT","path":"/origination/dossiers/applicationForms/{applicationFormId}/","fullPath":"/api/v1.0.0/origination/dossiers/applicationForms/{applicationFormId}/","operationId":"updateDossiersForm","name":"provider api for oa application form","summary":"This api is used to update dossier form application","tags":[],"parameters":[{"name":"applicationFormId","in":"path","type":"string","required":true,"description":""},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":""},{"name":"companyId","in":"header","type":"string","required":false,"description":""}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"customers":[{}],"instances":[{}],"purposes":[{}],"owners":[{}],"inputters":[{}],"viewers":[{}],"overrides":[{}],"definitionId":"string","version":"string","activityId":"string","effectiveDate":"2024-01-01","linkedApplication":"string","linkedApplicationId":"string"}},"responses":{"200":"DossiersFormResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/origination/dossiers/{applicationFormId}/dynamicTexts","fullPath":"/api/v1.0.0/origination/dossiers/{applicationFormId}/dynamicTexts","operationId":"getClassTypes","name":"provider api for oa application details","summary":"this api is used to retrieve details from oa application details. This is a dynamic text application","tags":[],"parameters":[{"name":"applicationFormId","in":"path","type":"string","required":true,"description":""},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from t24 on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":""},{"name":"companyId","in":"header","type":"string","required":false,"description":""}],"requestBodyExample":null,"responses":{"200":"ClassTypesResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"POST","path":"/origination/dossiers","fullPath":"/api/v1.0.0/origination/dossiers","operationId":"createDossier","name":"provider api for create dossier","summary":"This is a post API for dossier application","tags":[],"parameters":[{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":""},{"name":"companyId","in":"header","type":"string","required":false,"description":""}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"purposes":[{}],"links":[{}],"domains":[{}],"activity":"string","activityPurpose":"string"}},"responses":{"200":"DossierResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/origination/dossiers/{dossierId}","fullPath":"/api/v1.0.0/origination/dossiers/{dossierId}","operationId":"getDossier","name":"provider api for dossier application","summary":"This is an get request api for dossier application","tags":[],"parameters":[{"name":"dossierId","in":"path","type":"string","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":""},{"name":"companyId","in":"header","type":"string","required":false,"description":""}],"requestBodyExample":null,"responses":{"200":"DossierResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/origination/dossiers/{dossierId}","fullPath":"/api/v1.0.0/origination/dossiers/{dossierId}","operationId":"updateDossier","name":"provider api for dossier update","summary":"This api is used for updating dossier application","tags":[],"parameters":[{"name":"dossierId","in":"path","type":"string","required":true,"description":""},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":""},{"name":"companyId","in":"header","type":"string","required":false,"description":""}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"purposes":[{}],"links":[{}],"domains":[{}],"activity":"string","activityPurpose":"string"}},"responses":{"200":"DossierResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/origination/needs/{needsId}/recommendations","fullPath":"/api/v1.0.0/origination/needs/{needsId}/recommendations","operationId":"getProductRecommendations","name":"provider api for product recommendations","summary":"This api is used to retrieving products based on the needs id for product recommendation","tags":[],"parameters":[{"name":"needsId","in":"path","type":"string","required":true,"description":""},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from t24 on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":""},{"name":"companyId","in":"header","type":"string","required":false,"description":""}],"requestBodyExample":null,"responses":{"200":"ProductRecommendationsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/origination/customers/{customerId}/dossiers","fullPath":"/api/v1.0.0/origination/customers/{customerId}/dossiers","operationId":"getDossiers","name":"Provider api for listing dossiers","summary":"This api provides the list of dossiers linked to the customer id passed in the Api","tags":[],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"The identifier of the customer"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from t24 on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":""},{"name":"companyId","in":"header","type":"string","required":false,"description":""}],"requestBodyExample":null,"responses":{"200":"DossiersResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/origination/dossiers/{statusId}/status","fullPath":"/api/v1.0.0/origination/dossiers/{statusId}/status","operationId":"getDossierStatus","name":"Provider api for dossier status application","summary":"This api is used for fetching the details from dossier status application","tags":[],"parameters":[{"name":"statusId","in":"path","type":"string","required":true,"description":""},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from t24 on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":""},{"name":"companyId","in":"header","type":"string","required":false,"description":""}],"requestBodyExample":null,"responses":{"200":"DossierStatusResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/origination/purposeTypes","fullPath":"/api/v1.0.0/origination/purposeTypes","operationId":"getPurposeTypes","name":"provider api for purpose type","summary":"This api is used for listing AA purpose types","tags":[],"parameters":[{"name":"purposeId","in":"query","type":"string","required":false,"description":"Purpose identifier of the payment or transaction"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from t24 on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":""},{"name":"companyId","in":"header","type":"string","required":false,"description":""}],"requestBodyExample":null,"responses":{"200":"PurposeTypesResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}}]},{"key":"origination-needsAnalysis-service-v1.0.0","title":"Needs Analysis Apis","version":"v1.0.0","description":"Needs analysis bulk Api's collection","endpointCount":6,"endpoints":[{"method":"POST","path":"/origination/accounts/currentAccounts/needs","fullPath":"/api/v1.0.0/origination/accounts/currentAccounts/needs","operationId":"createCurrentAccountsQuestionnaire","name":"","summary":"","tags":[],"parameters":[{"name":"credentials","in":"query","type":"string","required":false,"description":""},{"name":"companyId","in":"query","type":"string","required":false,"description":""},{"name":"payload","in":"body","type":"object","required":true,"description":""}],"requestBodyExample":null,"responses":{"200":"accountOpeningResponse","default":"accountOpeningError"}},{"method":"PUT","path":"/origination/accounts/currentAccounts/needs/{needsId}","fullPath":"/api/v1.0.0/origination/accounts/currentAccounts/needs/{needsId}","operationId":"updateCurrentAccountsQuestionnaire","name":"","summary":"","tags":[],"parameters":[{"name":"credentials","in":"query","type":"string","required":false,"description":""},{"name":"companyId","in":"query","type":"string","required":false,"description":""},{"name":"payload","in":"body","type":"object","required":true,"description":""}],"requestBodyExample":null,"responses":{"200":"accountOpeningResponse","default":"accountOpeningError"}},{"method":"POST","path":"/origination/accounts/savingsAccounts/needs","fullPath":"/api/v1.0.0/origination/accounts/savingsAccounts/needs","operationId":"createSavingsAccountsQuestionnaire","name":"","summary":"","tags":[],"parameters":[{"name":"credentials","in":"query","type":"string","required":false,"description":""},{"name":"companyId","in":"query","type":"string","required":false,"description":""},{"name":"payload","in":"body","type":"object","required":true,"description":""}],"requestBodyExample":null,"responses":{"200":"saveMoneyResponse","default":"saveMoneyError"}},{"method":"PUT","path":"/origination/accounts/savingsAccounts/needs/{needsId}","fullPath":"/api/v1.0.0/origination/accounts/savingsAccounts/needs/{needsId}","operationId":"updateSavingsAccountsQuestionnaire","name":"","summary":"","tags":[],"parameters":[{"name":"credentials","in":"query","type":"string","required":false,"description":""},{"name":"companyId","in":"query","type":"string","required":false,"description":""},{"name":"payload","in":"body","type":"object","required":true,"description":""}],"requestBodyExample":null,"responses":{"200":"saveMoneyResponse","default":"saveMoneyError"}},{"method":"POST","path":"/origination/loans/shortTermLoans/needs","fullPath":"/api/v1.0.0/origination/loans/shortTermLoans/needs","operationId":"createShortTermLoansQuestionnaire","name":"","summary":"","tags":[],"parameters":[{"name":"credentials","in":"query","type":"string","required":false,"description":""},{"name":"companyId","in":"query","type":"string","required":false,"description":""},{"name":"payload","in":"body","type":"object","required":true,"description":""}],"requestBodyExample":null,"responses":{"200":"shortTermFinanceResponse","default":"shortTermFinanceError"}},{"method":"PUT","path":"/origination/loans/shortTermLoans/needs/{needsId}","fullPath":"/api/v1.0.0/origination/loans/shortTermLoans/needs/{needsId}","operationId":"updateShortTermLoansQuestionnaire","name":"","summary":"","tags":[],"parameters":[{"name":"credentials","in":"query","type":"string","required":false,"description":""},{"name":"companyId","in":"query","type":"string","required":false,"description":""},{"name":"payload","in":"body","type":"object","required":true,"description":""}],"requestBodyExample":null,"responses":{"200":"shortTermFinanceResponse","default":"shortTermFinanceError"}}]},{"key":"origination-saveMoneyPurpose-service-v1.0.0","title":"Savings Account Opening","version":"v1.0.0","description":"Savings Account Activities","endpointCount":3,"endpoints":[{"method":"POST","path":"/origination/accounts/savingsAccounts","fullPath":"/api/v1.0.0/origination/accounts/savingsAccounts","operationId":"createSavingsAccount","name":"Post request for save money purpose","summary":"This end point contains all the formlets related to the purpose save money and user can submit the form as well","tags":[],"parameters":[{"name":"credentials","in":"header","type":"string","required":false,"description":""},{"name":"companyId","in":"header","type":"string","required":false,"description":""},{"name":"payload","in":"body","type":"object","required":true,"description":""}],"requestBodyExample":null,"responses":{"200":"createSavingsAccountResponse","default":"createSavingsAccounterrorResponse"}},{"method":"GET","path":"/origination/accounts/savingsAccounts/{dossierId}","fullPath":"/api/v1.0.0/origination/accounts/savingsAccounts/{dossierId}","operationId":"getSavingsAccount","name":"Get request for the purpose save money","summary":"This end point contains all the formlets related to the purpose save money and user can submit the form as well","tags":[],"parameters":[{"name":"credentials","in":"header","type":"string","required":false,"description":""},{"name":"companyId","in":"header","type":"string","required":false,"description":""},{"name":"dossierId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":null,"responses":{"200":"getSavingsAccountResponse","default":"Missing resource response"}},{"method":"PUT","path":"/origination/accounts/savingsAccounts/{dossierId}","fullPath":"/api/v1.0.0/origination/accounts/savingsAccounts/{dossierId}","operationId":"updateSavingsAccount","name":"Update request for save money purpose","summary":"This end point contains all the formlets related to the purpose save money and user can submit the form as well","tags":[],"parameters":[{"name":"credentials","in":"header","type":"string","required":false,"description":""},{"name":"companyId","in":"header","type":"string","required":false,"description":""},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"dossierId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":null,"responses":{"200":"updateSavingsAccountResponse","default":"updateSavingsAccounterrorResponse"}}]},{"key":"origination-shortTermFinancePurpose-service-v1.0.0","title":"Short Term Finance Purpose","version":"v1.0.0","description":"purpose api for personal loans and line of credit","endpointCount":3,"endpoints":[{"method":"POST","path":"/origination/loans/shortTermLoans","fullPath":"/api/v1.0.0/origination/loans/shortTermLoans","operationId":"createShortTermLoan","name":"post api for purpose short term loan","summary":"this end point contains all the formlets related to the purpose short term finance and user can submit the form as well","tags":[],"parameters":[{"name":"credentials","in":"header","type":"string","required":false,"description":""},{"name":"companyId","in":"header","type":"string","required":false,"description":""},{"name":"payload","in":"body","type":"object","required":true,"description":""}],"requestBodyExample":null,"responses":{"200":"createShortTermLoanResponse","default":"createShortTermLoanerrorResponse"}},{"method":"GET","path":"/origination/loans/shortTermLoans/{dossierId}","fullPath":"/api/v1.0.0/origination/loans/shortTermLoans/{dossierId}","operationId":"getShortTermLoan","name":"Get request for the short term finance purpose","summary":"this end point contains all the formlets related to the purpose short term finance and user can submit the form as well","tags":[],"parameters":[{"name":"credentials","in":"header","type":"string","required":false,"description":""},{"name":"companyId","in":"header","type":"string","required":false,"description":""},{"name":"dossierId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":null,"responses":{"200":"getShortTermLoanResponse","default":"Missing resource response"}},{"method":"PUT","path":"/origination/loans/shortTermLoans/{dossierId}","fullPath":"/api/v1.0.0/origination/loans/shortTermLoans/{dossierId}","operationId":"updateShortTermLoan","name":"Update request for the short term loan","summary":"this end point contains all the formlets related to the purpose short term finance and user can submit the form as well","tags":[],"parameters":[{"name":"credentials","in":"header","type":"string","required":false,"description":""},{"name":"companyId","in":"header","type":"string","required":false,"description":""},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"dossierId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":null,"responses":{"200":"updateShortTermLoanResponse","default":"updateShortTermLoanerrorResponse"}}]}]},{"name":"Participantlist","serviceCount":1,"endpointCount":1,"services":[{"key":"participantList-service-v1.0.0","title":"Participant List","version":"v1.0.0","description":"Participant List","endpointCount":1,"endpoints":[{"method":"GET","path":"/party/participants","fullPath":"/api/v1.0.0/party/participants","operationId":"getParticipantList","name":"Get the participant list","summary":"","tags":[],"parameters":[{"name":"participantId","in":"query","type":"string","required":false,"description":"Participant ID"},{"name":"accountOfficer","in":"query","type":"string","required":false,"description":""},{"name":"user","in":"query","type":"string","required":false,"description":""},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from t24 on every enquiry request."},{"name":"credentials","in":"query","type":"string","required":false,"description":""},{"name":"companyId","in":"query","type":"string","required":false,"description":""}],"requestBodyExample":null,"responses":{"200":"getParticipantListResponse","default":"getParticipantListErrorResponse"}}]}]},{"name":"Party","serviceCount":91,"endpointCount":1622,"services":[{"key":"party-CDP-v1.0.0","title":"Capture customer activity","version":"v1.0.0","description":"Capture customer activity from an external system","endpointCount":1,"endpoints":[{"method":"PUT","path":"/party/dataProtection/customers/enterpriseActivities/{enterpriseActivityId}","fullPath":"/api/v1.0.0/party/dataProtection/customers/enterpriseActivities/{enterpriseActivityId}","operationId":"updateCustomerActivity","name":"Updates customer activities captured in an external system. The status of customer activity is captured as 'Active' or 'Inactive' from the external system","summary":"Update customer activity captured from an external system","tags":[],"parameters":[{"name":"enterpriseActivityId","in":"path","type":"string","required":true,"description":""},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"externalSystemInfo":[{}],"extensions":{}}},"responses":{"200":"CustomerActivityResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}}]},{"key":"party-beneficiaries-service-v1.0.0","title":"Management of Beneficiaries","version":"v1.0.0","description":"API to allow the creation, viewing and management of beneficiaries","endpointCount":7,"endpoints":[{"method":"PUT","path":"/party/beneficiaries/{beneficiaryId}","fullPath":"/api/v1.0.0/party/beneficiaries/{beneficiaryId}","operationId":"updateBeneficiary","name":"Updates an existing beneficiary","summary":"Update beneficiary details","tags":[],"parameters":[{"name":"beneficiaryId","in":"path","type":"string","required":true,"description":"Indicates the Id of beneficiary when beneficiary details are stored"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"The identifier of the underlying Entity/Company/Branch."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"beneficiaryNickNames":[{}],"beneficiaryBICIBANNames":[{}],"paymentDetails":[{}],"overrides":[{}],"transactionType":"string","beneficiaryCustomerId":"string","beneficiaryAddress":"string","customerId":"string","beneficiaryAccountId":"string","bankSortCode":"string","customerReference":"string","beneficiaryBIC":"string","defaultNarrative":"string","linkToBeneficiaryId":"string","beneficiaryIBAN":"string"}},"responses":{"200":"BeneficiaryResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"DELETE","path":"/party/beneficiaries/{beneficiaryId}","fullPath":"/api/v1.0.0/party/beneficiaries/{beneficiaryId}","operationId":"deleteBeneficiary","name":"Delete an existing beneficiary record","summary":"Remove beneficiary","tags":[],"parameters":[{"name":"beneficiaryId","in":"path","type":"string","required":true,"description":"Indicates the Id of beneficiary when beneficiary details are stored"},{"name":"payload","in":"body","type":"object","required":false,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"The identifier of the underlying Entity/Company/Branch."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}}},"responses":{"200":"BeneficiaryResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"POST","path":"/party/beneficiaries","fullPath":"/api/v1.0.0/party/beneficiaries","operationId":"createBeneficiary","name":"Create a new beneficiary","summary":"Create beneficiary","tags":[],"parameters":[{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"The identifier of the underlying Entity/Company/Branch."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"beneficiaryNickNames":[{}],"beneficiaryBICIBANNames":[{}],"paymentDetails":[{}],"overrides":[{}],"transactionType":"string","beneficiaryCustomerId":"string","beneficiaryAddress":"string","customerId":"string","beneficiaryAccountId":"string","bankSortCode":"string","customerReference":"string","beneficiaryBIC":"string","defaultNarrative":"string","linkToBeneficiaryId":"string","beneficiaryIBAN":"string"}},"responses":{"200":"BeneficiaryResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/party/beneficiaries/beneficiariesApprovals/{beneficiaryId}","fullPath":"/api/v1.0.0/party/beneficiaries/beneficiariesApprovals/{beneficiaryId}","operationId":"approveBeneficiary","name":"Approve an existing beneficiary record","summary":"Approve beneficiary","tags":[],"parameters":[{"name":"beneficiaryId","in":"path","type":"string","required":true,"description":"Indicates the Id of beneficiary when beneficiary details are stored"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"The identifier of the underlying Entity/Company/Branch."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"BeneficiaryResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"DELETE","path":"/party/beneficiaries/cancellations/{beneficiaryId}","fullPath":"/api/v1.0.0/party/beneficiaries/cancellations/{beneficiaryId}","operationId":"rejectBeneficiary","name":"Reject an existing beneficiary record","summary":"Reject beneficiary","tags":[],"parameters":[{"name":"beneficiaryId","in":"path","type":"string","required":true,"description":"Indicates the Id of beneficiary when beneficiary details are stored"},{"name":"payload","in":"body","type":"object","required":false,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"The identifier of the underlying Entity/Company/Branch."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}}},"responses":{"200":"BeneficiaryResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/party/customers/{customerId}/beneficiaries","fullPath":"/api/v1.0.0/party/customers/{customerId}/beneficiaries","operationId":"getCustomerBeneficiary","name":"Retrieves customer beneficiary details","summary":"Retrieves the list of beneficiary record details for a customers","tags":[],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"Identifier of the customer"},{"name":"nickName","in":"query","type":"string","required":false,"description":"Nickname of the beneficiary"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from t24 on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"The identifier of the underlying Entity/Company/Branch."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"CustomerBeneficiaryResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/party/customers/{customerId}/onlineBeneficiaries","fullPath":"/api/v1.0.0/party/customers/{customerId}/onlineBeneficiaries","operationId":"getCustomerBeneficiaries","name":"Retrieves customer beneficiaries details","summary":"Retrieves the list of beneficiaries details for specific customer","tags":[],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"Identifier of the customer"},{"name":"externalBeneficiaryFlag","in":"query","type":"string","required":false,"description":"Flag to identify if the beneficiary is external"},{"name":"paymentScheme","in":"query","type":"string","required":false,"description":"Payment scheme details"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from t24 on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"The identifier of the underlying Entity/Company/Branch."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"CustomerBeneficiariesResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}}]},{"key":"party-beneficiaries-service-v1.1.0","title":"Management of Beneficiaries","version":"v1.1.0","description":"API to allow the creation, viewing and management of beneficiaries","endpointCount":7,"endpoints":[{"method":"PUT","path":"/party/beneficiaries/{beneficiaryId}","fullPath":"/api/v1.1.0/party/beneficiaries/{beneficiaryId}","operationId":"updateBeneficiary","name":"Updates an existing beneficiary","summary":"Update beneficiary details","tags":[],"parameters":[{"name":"beneficiaryId","in":"path","type":"string","required":true,"description":"Indicates the reference of the financial institution that allows access to the beneficiary information"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"beneficiaryNickNames":[{}],"beneficiaryBICIBANNames":[{}],"paymentDetails":[{}],"overrides":[{}],"transactionType":"string","beneficiaryCustomerId":"string","beneficiaryAddress":"string","customerId":"string","beneficiaryAccountId":"string","bankSortCode":"string","customerReference":"string","beneficiaryBIC":"string","defaultNarrative":"string","linkToBeneficiaryId":"string","beneficiaryIBAN":"string"}},"responses":{"200":"BeneficiaryResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"DELETE","path":"/party/beneficiaries/{beneficiaryId}","fullPath":"/api/v1.1.0/party/beneficiaries/{beneficiaryId}","operationId":"deleteBeneficiary","name":"Delete an existing beneficiary","summary":"Remove beneficiary","tags":[],"parameters":[{"name":"beneficiaryId","in":"path","type":"string","required":true,"description":"Indicates the reference of the financial institution that allows access to the beneficiary information"},{"name":"payload","in":"body","type":"object","required":false,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}}},"responses":{"200":"BeneficiaryResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"POST","path":"/party/beneficiaries","fullPath":"/api/v1.1.0/party/beneficiaries","operationId":"createBeneficiary","name":"Create a new beneficiary","summary":"Create beneficiary","tags":[],"parameters":[{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"beneficiaryNickNames":[{}],"beneficiaryBICIBANNames":[{}],"paymentDetails":[{}],"overrides":[{}],"transactionType":"string","beneficiaryCustomerId":"string","beneficiaryAddress":"string","customerId":"string","beneficiaryAccountId":"string","bankSortCode":"string","customerReference":"string","beneficiaryBIC":"string","defaultNarrative":"string","linkToBeneficiaryId":"string","beneficiaryIBAN":"string"}},"responses":{"200":"BeneficiaryResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/party/beneficiaries/beneficiariesApprovals/{beneficiaryId}","fullPath":"/api/v1.1.0/party/beneficiaries/beneficiariesApprovals/{beneficiaryId}","operationId":"approveBeneficiary","name":"Approve an existing beneficiary","summary":"Approve beneficiary","tags":[],"parameters":[{"name":"beneficiaryId","in":"path","type":"string","required":true,"description":"Indicates the reference of the financial institution that allows access to the beneficiary information"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"BeneficiaryResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"DELETE","path":"/party/beneficiaries/cancellations/{beneficiaryId}","fullPath":"/api/v1.1.0/party/beneficiaries/cancellations/{beneficiaryId}","operationId":"rejectBeneficiary","name":"Reject an existing beneficiary","summary":"Reject beneficiary","tags":[],"parameters":[{"name":"beneficiaryId","in":"path","type":"string","required":true,"description":"Indicates the reference of the financial institution that allows access to the beneficiary information"},{"name":"payload","in":"body","type":"object","required":false,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}}},"responses":{"200":"BeneficiaryResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/party/customers/{customerId}/beneficiaries","fullPath":"/api/v1.1.0/party/customers/{customerId}/beneficiaries","operationId":"getCustomerBeneficiary","name":"Retrieves customer beneficiary details","summary":"Retrieves the list of beneficiary details for a customers","tags":[],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"Identifier of the customer"},{"name":"nickName","in":"query","type":"string","required":false,"description":"Nickname of the beneficiary"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from t24 on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"CustomerBeneficiaryResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/party/customers/{customerId}/onlineBeneficiaries","fullPath":"/api/v1.1.0/party/customers/{customerId}/onlineBeneficiaries","operationId":"getCustomerBeneficiaries","name":"Retrieves customer beneficiaries details","summary":"Retrieves the list of beneficiaries details for specific customer","tags":[],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"Identifier of the customer"},{"name":"externalBeneficiaryFlag","in":"query","type":"string","required":false,"description":"Flag to identify if the beneficiary is external"},{"name":"paymentScheme","in":"query","type":"string","required":false,"description":"Payment scheme details"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from t24 on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"CustomerBeneficiariesResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}}]},{"key":"party-beneficiaries-service-v2.0.0","title":"Management of Beneficiaries","version":"v2.0.0","description":"API to allow the creation, viewing and management of beneficiaries","endpointCount":8,"endpoints":[{"method":"GET","path":"/party/beneficiaries/{beneficiaryId}","fullPath":"/api/v2.0.0/party/beneficiaries/{beneficiaryId}","operationId":"getBeneficiaryDetails","name":"Retrieves details such as beneficiary, bank and ultimate creditors details","summary":"Retrieves beneficiary ","tags":[],"parameters":[{"name":"beneficiaryId","in":"path","type":"string","required":true,"description":"Indicates the reference of the financial institution that allows access to the beneficiary information"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"BeneficiaryDetailsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"PUT","path":"/party/beneficiaries/{beneficiaryId}","fullPath":"/api/v2.0.0/party/beneficiaries/{beneficiaryId}","operationId":"updateBeneficiary","name":"Updates an existing beneficiary","summary":"Update beneficiary details","tags":[],"parameters":[{"name":"beneficiaryId","in":"path","type":"string","required":true,"description":"Indicates the reference of the financial institution that allows access to the beneficiary information"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"beneficiaryNickNames":[{}],"beneficiaryBICIBANNames":[{}],"paymentDetails":[{}],"overrides":[{}],"transactionType":"string","beneficiaryCustomerId":"string","beneficiaryAddress":"string","customerId":"string","beneficiaryAccountId":"string","bankSortCode":"string","customerReference":"string","beneficiaryBIC":"string","defaultNarrative":"string","linkToBeneficiaryId":"string","beneficiaryIBAN":"string"}},"responses":{"200":"BeneficiaryResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"DELETE","path":"/party/beneficiaries/{beneficiaryId}","fullPath":"/api/v2.0.0/party/beneficiaries/{beneficiaryId}","operationId":"deleteBeneficiary","name":"Delete an existing beneficiary","summary":"Remove beneficiary","tags":[],"parameters":[{"name":"beneficiaryId","in":"path","type":"string","required":true,"description":"Indicates the reference of the financial institution that allows access to the beneficiary information"},{"name":"payload","in":"body","type":"object","required":false,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}}},"responses":{"200":"BeneficiaryResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"POST","path":"/party/beneficiaries","fullPath":"/api/v2.0.0/party/beneficiaries","operationId":"createBeneficiary","name":"Create a new beneficiary","summary":"Create beneficiary","tags":[],"parameters":[{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"beneficiaryNickNames":[{}],"beneficiaryBICIBANNames":[{}],"paymentDetails":[{}],"overrides":[{}],"transactionType":"string","beneficiaryCustomerId":"string","beneficiaryAddress":"string","customerId":"string","beneficiaryAccountId":"string","bankSortCode":"string","customerReference":"string","beneficiaryBIC":"string","defaultNarrative":"string","linkToBeneficiaryId":"string","beneficiaryIBAN":"string"}},"responses":{"200":"BeneficiaryResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/party/beneficiaries/beneficiariesApprovals/{beneficiaryId}","fullPath":"/api/v2.0.0/party/beneficiaries/beneficiariesApprovals/{beneficiaryId}","operationId":"approveBeneficiary","name":"Approve the creation of a beneficiary","summary":"Approve beneficiary","tags":[],"parameters":[{"name":"beneficiaryId","in":"path","type":"string","required":true,"description":"Indicates the reference of the financial institution that allows access to the beneficiary information"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"BeneficiaryResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"DELETE","path":"/party/beneficiaries/cancellations/{beneficiaryId}","fullPath":"/api/v2.0.0/party/beneficiaries/cancellations/{beneficiaryId}","operationId":"rejectBeneficiary","name":"Reject the beneficiary","summary":"Reject beneficiary","tags":[],"parameters":[{"name":"beneficiaryId","in":"path","type":"string","required":true,"description":"Indicates the reference of the financial institution that allows access to the beneficiary information"},{"name":"payload","in":"body","type":"object","required":false,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}}},"responses":{"200":"BeneficiaryResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/party/customers/{customerId}/beneficiaries","fullPath":"/api/v2.0.0/party/customers/{customerId}/beneficiaries","operationId":"getCustomerBeneficiary","name":"Retrieves customer beneficiary details","summary":"Retrieves the list of beneficiary details for a customers","tags":[],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"Identifier of the customer"},{"name":"nickName","in":"query","type":"string","required":false,"description":"Nickname of the beneficiary"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from t24 on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"CustomerBeneficiaryResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/party/customers/{customerId}/onlineBeneficiaries","fullPath":"/api/v2.0.0/party/customers/{customerId}/onlineBeneficiaries","operationId":"getCustomerBeneficiaries","name":"Retrieves customer beneficiaries details such as beneficiary account number, transaction and payment details","summary":"Retrieves the list of beneficiaries details for specific customer updated through Temenos connector","tags":[],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"Identifier of the customer"},{"name":"externalBeneficiaryFlag","in":"query","type":"string","required":false,"description":"Flag to identify if the beneficiary is external"},{"name":"paymentScheme","in":"query","type":"string","required":false,"description":"Payment scheme details"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from t24 on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"CustomerBeneficiariesResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}}]},{"key":"party-beneficiaries-service-v2.1.0","title":"Management of beneficiaries","version":"v2.1.0","description":"API to manage the beneficiary information","endpointCount":4,"endpoints":[{"method":"GET","path":"/party/beneficiaries/{beneficiaryId}","fullPath":"/api/v1.0.0/party/beneficiaries/{beneficiaryId}","operationId":"getBeneficiaryDetails","name":"Retrieves details such as ultimate debitor and intermed bank details","summary":"Retrieves beneficiary ","tags":["OTHERS"],"parameters":[{"name":"beneficiaryId","in":"path","type":"string","required":true,"description":"Indicates the reference of the financial institution that allows access to the beneficiary information"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"","default":"","400":"","500":""}},{"method":"PUT","path":"/party/beneficiaries/{beneficiaryId}","fullPath":"/api/v1.0.0/party/beneficiaries/{beneficiaryId}","operationId":"updateBeneficiary","name":"Update existing beneficiary details such as ultimate debitor and intermed bank details","summary":"Update beneficiary details","tags":["OTHERS"],"parameters":[{"name":"beneficiaryId","in":"path","type":"string","required":true,"description":""},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"","default":"","400":"","500":""}},{"method":"POST","path":"/party/beneficiaries","fullPath":"/api/v1.0.0/party/beneficiaries","operationId":"createBeneficiary","name":"Create a new beneficiary with details such as ultimate debitor and intermed bank details","summary":"Create beneficiary","tags":["OTHERS"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"","default":"","400":"","500":""}},{"method":"PUT","path":"/party/beneficiaries/{beneficiaryId}/approvals","fullPath":"/api/v1.0.0/party/beneficiaries/{beneficiaryId}/approvals","operationId":"approveBeneficiary","name":"Approve the creation of a beneficiary with details such as ultimate debitor and intermed bank details","summary":"Approve beneficiary","tags":["OTHERS"],"parameters":[{"name":"beneficiaryId","in":"path","type":"string","required":true,"description":""},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"","default":"","400":"","500":""}}]},{"key":"party-beneficiaries-service-v2.1.1","title":"Management of beneficiaries","version":"v2.1.1","description":"API to manage beneficiary information","endpointCount":6,"endpoints":[{"method":"GET","path":"/party/beneficiaries/{beneficiaryId}","fullPath":"/api/v1.0.0/party/beneficiaries/{beneficiaryId}","operationId":"getBeneficiaryDetails","name":"Retrieves details such as ultimate debitor and intermed bank details","summary":"Retrieves beneficiary ","tags":["OTHERS"],"parameters":[{"name":"beneficiaryId","in":"path","type":"string","required":true,"description":"Indicates the reference of the financial institution that allows access to the beneficiary information"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"","default":"","400":"","500":""}},{"method":"PUT","path":"/party/beneficiaries/{beneficiaryId}","fullPath":"/api/v1.0.0/party/beneficiaries/{beneficiaryId}","operationId":"updateBeneficiary","name":"Update existing beneficiary details such as ultimate debitor and intermed bank details","summary":"Update beneficiary details","tags":["OTHERS"],"parameters":[{"name":"beneficiaryId","in":"path","type":"string","required":true,"description":""},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"","default":"","400":"","500":""}},{"method":"POST","path":"/party/beneficiaries","fullPath":"/api/v1.0.0/party/beneficiaries","operationId":"createBeneficiary","name":"Create a new beneficiary with details such as ultimate debitor and intermed bank details","summary":"Create beneficiary","tags":["OTHERS"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"","default":"","400":"","500":""}},{"method":"PUT","path":"/party/beneficiaries/{beneficiaryId}/approvals","fullPath":"/api/v1.0.0/party/beneficiaries/{beneficiaryId}/approvals","operationId":"approveBeneficiary","name":"Approve the creation of a beneficiary with details such as ultimate debitor and intermed bank details","summary":"Approve beneficiary","tags":["OTHERS"],"parameters":[{"name":"beneficiaryId","in":"path","type":"string","required":true,"description":""},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"","default":"","400":"","500":""}},{"method":"GET","path":"/party/customers/{customerId}/beneficiaries","fullPath":"/api/v1.0.0/party/customers/{customerId}/beneficiaries","operationId":"getCustomerBeneficiary","name":"Retrieves the list of beneficiary details for a customer","summary":"Retrieves customer beneficiary details such as ultimate debitor and intermed bank details for a customer","tags":["OTHERS"],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"Identifier of the customer"},{"name":"nickName","in":"query","type":"string","required":false,"description":"Nickname of the beneficiary"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"","default":"","400":"","500":""}},{"method":"GET","path":"/party/customers/{customerId}/onlineBeneficiaries","fullPath":"/api/v1.0.0/party/customers/{customerId}/onlineBeneficiaries","operationId":"getCustomerBeneficiaries","name":"Retrieves the list of beneficiaries details for a specific customer updated through temenos connector","summary":"Retrieves customer beneficiaries details such as ultimate debitor and intermed bank details for a specific customer updated through temenos connector","tags":["OTHERS"],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"Identifier of the customer"},{"name":"externalBeneficiaryFlag","in":"query","type":"string","required":false,"description":"Flag to identify if the beneficiary is external"},{"name":"paymentScheme","in":"query","type":"string","required":false,"description":"Payment scheme details"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"","default":"","400":"","500":""}}]},{"key":"party-beneficiaries-service-v2.1.2","title":"Management of beneficiaries","version":"v2.1.2","description":"API to manage beneficiary information","endpointCount":5,"endpoints":[{"method":"GET","path":"/party/beneficiaries/{beneficiaryId}","fullPath":"/api/v1.0.0/party/beneficiaries/{beneficiaryId}","operationId":"getBeneficiaryDetails","name":"Retrieves details such as ultimate debitor and intermed bank details","summary":"Retrieves beneficiary","tags":["OTHERS"],"parameters":[{"name":"beneficiaryId","in":"path","type":"string","required":true,"description":"Indicates the reference of the financial institution that allows access to the beneficiary information"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"","default":"","400":"","500":""}},{"method":"PUT","path":"/party/beneficiaries/{beneficiaryId}","fullPath":"/api/v1.0.0/party/beneficiaries/{beneficiaryId}","operationId":"updateBeneficiary","name":"Update existing beneficiary details such as ultimate debitor and intermed bank details","summary":"Update beneficiary details","tags":["OTHERS"],"parameters":[{"name":"beneficiaryId","in":"path","type":"string","required":true,"description":""},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"","default":"","400":"","500":""}},{"method":"POST","path":"/party/beneficiaries","fullPath":"/api/v1.0.0/party/beneficiaries","operationId":"createBeneficiary","name":"Create a new beneficiary with details such as ultimate debitor and intermed bank details","summary":"Create beneficiary","tags":["OTHERS"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"","default":"","400":"","500":""}},{"method":"PUT","path":"/party/beneficiaries/{beneficiaryId}/approvals","fullPath":"/api/v1.0.0/party/beneficiaries/{beneficiaryId}/approvals","operationId":"approveBeneficiary","name":"Approve the creation of a beneficiary with details such as ultimate debitor and intermed bank details","summary":"Approve beneficiary","tags":["OTHERS"],"parameters":[{"name":"beneficiaryId","in":"path","type":"string","required":true,"description":""},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"","default":"","400":"","500":""}},{"method":"GET","path":"/party/customers/{customerId}/beneficiaries","fullPath":"/api/v1.0.0/party/customers/{customerId}/beneficiaries","operationId":"getCustomerBeneficiary","name":"Retrieves the list of beneficiary details for a customer","summary":"Retrieves customer beneficiary details such as ultimate debitor and intermed bank details for a customer","tags":["OTHERS"],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"Identifier of the customer"},{"name":"nickName","in":"query","type":"string","required":false,"description":"Nickname of the beneficiary"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"","default":"","400":"","500":""}}]},{"key":"party-ca-billPayment-service-v1.0.0","title":"Bill payments","version":"v1.0.0","description":"API to manage (add/remove) payee details with registered payer and retrieves the payee details associated with payer","endpointCount":4,"endpoints":[{"method":"POST","path":"/party/ca/customers/{customerId}/billPayments/registrations","fullPath":"/api/v1.0.0/party/ca/customers/{customerId}/billPayments/registrations","operationId":"createCaBillRegistration","name":"Register the given customer for bill payment process such as paying utility bills and recurring bill payments","summary":"Register the given customer for bill payment process ","tags":["RETAIL"],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"Identifier of the customer"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"payer":[{}],"extensions":{}}},"responses":{"200":"CaBillRegistrationResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/party/ca/customers/{customerId}/billPayments/payees/registrations","fullPath":"/api/v1.0.0/party/ca/customers/{customerId}/billPayments/payees/registrations","operationId":"addCaBillPayeeRegistration","name":"Register the payee details for given customer. This includes adding new set of payee and payee account number.","summary":"Register the payee details for given customer","tags":["RETAIL"],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"Identifier of the customer"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"payer":[{}],"extensions":{}}},"responses":{"200":"CaBillPayeeRegistrationResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/party/ca/customers/{customerId}/billPayments/payees/cancellations","fullPath":"/api/v1.0.0/party/ca/customers/{customerId}/billPayments/payees/cancellations","operationId":"deleteCaBillPayeeCancellation","name":"Cancel payee details for given Customer. This includes removing existing set of payee and payee account number","summary":"Cancel payee details for given customer","tags":["RETAIL"],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"Identifier of the customer"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"payer":[{}],"extensions":{}}},"responses":{"200":"CaBillPayeeCancellationResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/party/ca/customers/{customerId}/billPayments/payees","fullPath":"/api/v1.0.0/party/ca/customers/{customerId}/billPayments/payees","operationId":"getCaCustomerBillPayee","name":"Retrieves the bill payment payee details for the given customer with details such as payee, payee name and payee account number.","summary":"Retrieves the bill payment payee details for the given customer","tags":["RETAIL"],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"Identifier of the customer"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"CaCustomerBillPayeeResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}}]},{"key":"party-ca-customer-service-v1.0.0","title":"Customer profile management","version":"v1.0.0","description":"API to create, update and retrieves customer profile details","endpointCount":3,"endpoints":[{"method":"GET","path":"/party/ca/customers/profiles","fullPath":"/api/v1.0.0/party/ca/customers/profiles","operationId":"getCaCustomerProfiles","name":"Retrieve the customer profiles information based on sin number, given name, family name, customer id.","summary":"Retrieve the customer profiles information","tags":["RETAIL"],"parameters":[{"name":"beneficiarySocialInsuranceNumber","in":"query","type":"string","required":false,"description":"Contains the beneficiary social insurance number "},{"name":"customerId","in":"query","type":"string","required":false,"description":"Identifier of the customer"},{"name":"customerName","in":"query","type":"string","required":false,"description":"Name of the customer"},{"name":"street","in":"query","type":"string","required":false,"description":"Contains the street name of the customer or the property"},{"name":"addressCity","in":"query","type":"string","required":false,"description":"The town and/or city component of the base address of a customer"},{"name":"countryId","in":"query","type":"string","required":false,"description":"ISO country code of the financial institution. "},{"name":"postCode","in":"query","type":"string","required":false,"description":"Identifies the address postal code for the customer or the property"},{"name":"dateOfBirth","in":"query","type":"string","required":false,"description":"The date of birth of an individual customer"},{"name":"customerStatus","in":"query","type":"string","required":false,"description":"The internal bank status of a customer"},{"name":"sectorId","in":"query","type":"string","required":false,"description":"An institution-defined identifier of the type of customer"},{"name":"accountOfficerId","in":"query","type":"string","required":false,"description":"The identifier of the department head or specific account officer responsible for the customer"},{"name":"industryId","in":"query","type":"string","required":false,"description":"An institution-defined identifier of the industry in which the customer is trading, operating or is associated with"},{"name":"nationalityId","in":"query","type":"string","required":false,"description":"The identifier of the nationality of a customer"},{"name":"residenceId","in":"query","type":"string","required":false,"description":"The identifier of the country of residence of a customer"},{"name":"lastName","in":"query","type":"string","required":false,"description":"The last name of an individual customer"},{"name":"phoneNumber","in":"query","type":"string","required":false,"description":"The phone number of the customer or prospect"},{"name":"customerMnemonic","in":"query","type":"string","required":false,"description":"Specifies an alternative easy means of referencing the Customer"},{"name":"firstName","in":"query","type":"string","required":false,"description":"Specifies customer's first name"},{"name":"customerType","in":"query","type":"string","required":false,"description":"Contains the type of customer, for example ACTIVE, PROSPECT."},{"name":"email","in":"query","type":"string","required":false,"description":"Email Identifier of the Customer"},{"name":"mobilePhoneNumber","in":"query","type":"string","required":false,"description":"Represents the phone number of a customer"},{"name":"taxId","in":"query","type":"string","required":false,"description":"Holds the Customer's TAX/SSN Id."},{"name":"shortName","in":"query","type":"string","required":false,"description":"Contains the name of the account, basically the short title of the account."},{"name":"officePhoneNumber","in":"query","type":"string","required":false,"description":"The office phone number of the customer"},{"name":"faxId","in":"query","type":"string","required":false,"description":"The fax (facsimile) number of the customer"},{"name":"address","in":"query","type":"string","required":false,"description":"Contains the communication address of the customer or full address of the property"},{"name":"relCustomer","in":"query","type":"string","required":false,"description":"Customers linked or related to the arrangement owner"},{"name":"relationshipCode","in":"query","type":"string","required":false,"description":"Relationship identifier between the partyType and relatedPartyType"},{"name":"legalId","in":"query","type":"string","required":false,"description":"Unique reference number of the legal documents submitted as identification proof"},{"name":"legalDocumentName","in":"query","type":"string","required":false,"description":"Name of the legal documents such as passport, driving licence etc., provided as identification proof"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"CaCustomerProfilesResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"POST","path":"/party/ca/customers","fullPath":"/api/v1.0.0/party/ca/customers","operationId":"createCaCustomerProfile","name":"Create new customer profiles (CIF) such as personal, business, etc from digital channels with customer information","summary":"Create new customer profile","tags":["RETAIL"],"parameters":[{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"communication":[{}],"idDocument":[{}],"garnishmentReferences":[{}],"displayNames":[{}],"customerNames":[{}],"communicationDevices":[{}],"faxIds":[{}],"officePhoneNumbers":[{}],"streets":[{}],"addresses":[{}],"addressCities":[{}],"countries":[{}],"legalDetails":[{}],"otherNationalityIds":[{}],"employDetails":[{}]}},"responses":{"200":"CaCustomerProfileResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/party/ca/customers/{customerId}","fullPath":"/api/v1.0.0/party/ca/customers/{customerId}","operationId":"updateCaCustomerProfile","name":"Update customer profile to change name, address, phone and email etc.","summary":"Update customer profile","tags":["RETAIL"],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"Identifier of the customer"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"communication":[{}],"idDocument":[{}],"garnishmentReferences":[{}],"displayNames":[{}],"customerNames":[{}],"communicationDevices":[{}],"faxIds":[{}],"officePhoneNumbers":[{}],"streets":[{}],"addresses":[{}],"addressCities":[{}],"countries":[{}],"legalDetails":[{}],"otherNationalityIds":[{}],"employDetails":[{}]}},"responses":{"200":"CaCustomerProfileResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}}]},{"key":"party-ca-customer-service-v1.1.0","title":"Customer management","version":"v1.1.0","description":"API to create, update and retrieve customer profile details","endpointCount":7,"endpoints":[{"method":"GET","path":"/party/ca/customers/profiles","fullPath":"/api/v1.1.0/party/ca/customers/profiles","operationId":"getCaCustomerProfile","name":"Retrieve the customer profile information based on sin number, given name, family name, customer id.","summary":"Retrieve the customer profile information","tags":["RETAIL"],"parameters":[{"name":"beneficiarySocialInsuranceNumber","in":"query","type":"string","required":false,"description":"Contains the beneficiary social insurance number "},{"name":"customerId","in":"query","type":"string","required":false,"description":"Identifier of the customer"},{"name":"customerName","in":"query","type":"string","required":false,"description":"Name of the customer"},{"name":"lastName","in":"query","type":"string","required":false,"description":"The last name of an individual customer"},{"name":"firstName","in":"query","type":"string","required":false,"description":"Specifies customer's first name"},{"name":"shortName","in":"query","type":"string","required":false,"description":"Contains the name of the account, basically the short title of the account."},{"name":"street","in":"query","type":"string","required":false,"description":"Contains the street name of the customer or the property"},{"name":"addressCity","in":"query","type":"string","required":false,"description":"The town and/or city component of the base address of a customer"},{"name":"countryId","in":"query","type":"string","required":false,"description":"ISO country code of the financial institution. "},{"name":"postCode","in":"query","type":"string","required":false,"description":"Identifies the address postal code for the customer or the property"},{"name":"dateOfBirth","in":"query","type":"string","required":false,"description":"The date of birth of an individual customer"},{"name":"customerStatus","in":"query","type":"string","required":false,"description":"The internal bank status of a customer"},{"name":"sectorId","in":"query","type":"string","required":false,"description":"An institution-defined identifier of the type of customer"},{"name":"accountOfficerId","in":"query","type":"string","required":false,"description":"The identifier of the department head or specific account officer responsible for the customer"},{"name":"industryId","in":"query","type":"string","required":false,"description":"An institution-defined identifier of the industry in which the customer is trading, operating or is associated with"},{"name":"nationalityId","in":"query","type":"string","required":false,"description":"The identifier of the nationality of a customer"},{"name":"residenceId","in":"query","type":"string","required":false,"description":"The identifier of the country of residence of a customer"},{"name":"phoneNumber","in":"query","type":"string","required":false,"description":"The phone number of the customer or prospect"},{"name":"customerMnemonic","in":"query","type":"string","required":false,"description":"Specifies an alternative easy means of referencing the Customer"},{"name":"customerType","in":"query","type":"string","required":false,"description":"Contains the type of customer, for example ACTIVE, PROSPECT."},{"name":"email","in":"query","type":"string","required":false,"description":"Email Identifier of the Customer"},{"name":"mobilePhoneNumber","in":"query","type":"string","required":false,"description":"Represents the phone number of a customer"},{"name":"faxId","in":"query","type":"string","required":false,"description":"The fax (facsimile) number of the customer"},{"name":"address","in":"query","type":"string","required":false,"description":"Contains the communication address of the customer or full address of the property"},{"name":"relCustomer","in":"query","type":"string","required":false,"description":"Customers linked or related to the arrangement owner"},{"name":"relationshipCode","in":"query","type":"string","required":false,"description":"Relationship identifier between the partyType and relatedPartyType"},{"name":"legalId","in":"query","type":"string","required":false,"description":"Unique reference number of the legal documents submitted as identification proof"},{"name":"legalDocumentName","in":"query","type":"string","required":false,"description":"Name of the legal documents such as passport, driving licence etc., provided as identification proof"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"CaCustomerProfileResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"POST","path":"/party/ca/customers","fullPath":"/api/v1.1.0/party/ca/customers","operationId":"createCaCustomerProfiles","name":"Create new customer profiles (CIF) such as personal, business, etc from digital channels with customer information","summary":"Create new customer profile","tags":["RETAIL"],"parameters":[{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"communication":[{}],"idDocument":[{}],"garnishmentReferences":[{}],"displayNames":[{}],"customerNames":[{}],"communicationDevices":[{}],"faxIds":[{}],"officePhoneNumbers":[{}],"streets":[{}],"addresses":[{}],"addressCities":[{}],"countries":[{}],"legalDetails":[{}],"otherNationalityIds":[{}],"employDetails":[{}]}},"responses":{"200":"CaCustomerProfilesResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/party/ca/customers/{customerId}","fullPath":"/api/v1.1.0/party/ca/customers/{customerId}","operationId":"updateCaCustomerProfile","name":"Update customer profile to change name, address, phone and email etc.","summary":"Update customer profile","tags":["RETAIL"],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"Identifier of the customer"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"communication":[{}],"idDocument":[{}],"garnishmentReferences":[{}],"displayNames":[{}],"customerNames":[{}],"communicationDevices":[{}],"faxIds":[{}],"officePhoneNumbers":[{}],"streets":[{}],"addresses":[{}],"addressCities":[{}],"countries":[{}],"legalDetails":[{}],"otherNationalityIds":[{}],"employDetails":[{}]}},"responses":{"200":"CaCustomerProfileResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"POST","path":"/party/ca/customers/membership","fullPath":"/api/v1.1.0/party/ca/customers/membership","operationId":"createCaMembershipProfile","name":"Create new membership profiles such as personal, business, etc from digital channels with customer information","summary":"Create new membership profile","tags":["RETAIL"],"parameters":[{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"displayNames":[{}],"customerNames":[{}],"communicationDevices":[{}],"faxIds":[{}],"officePhoneNumbers":[{}],"streets":[{}],"addresses":[{}],"addressCities":[{}],"countries":[{}],"legalDetails":[{}],"otherNationalityIds":[{}],"employDetails":[{}],"residenceDetails":[{}],"relationshipDetails":[{}],"postingRestrictIds":[{}]}},"responses":{"200":"CaMembershipProfileResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/party/ca/customers/{customerId}/membership","fullPath":"/api/v1.1.0/party/ca/customers/{customerId}/membership","operationId":"updateCaMembershipProfile","name":"Update membership profile to amend name, address, phone and email etc.","summary":"Update membership profile","tags":["RETAIL"],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"Identifier of the customer"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"displayNames":[{}],"customerNames":[{}],"communicationDevices":[{}],"faxIds":[{}],"officePhoneNumbers":[{}],"streets":[{}],"addresses":[{}],"addressCities":[{}],"countries":[{}],"legalDetails":[{}],"otherNationalityIds":[{}],"employDetails":[{}],"residenceDetails":[{}],"relationshipDetails":[{}],"postingRestrictIds":[{}]}},"responses":{"200":"CaMembershipProfileResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/party/ca/customers/{customerId}/owners/signers","fullPath":"/api/v1.1.0/party/ca/customers/{customerId}/owners/signers","operationId":"getCaOwnersSignersByCustomer","name":"Retrieves the owner and signer details for a specific customer such as account number, customer id, owner flag, signer flag, etc\"","summary":"Retrieves the owner and signer details for a specific customer","tags":["RETAIL"],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"Identifier of the customer"},{"name":"accountId","in":"query","type":"string","required":false,"description":"Identifier of the account. Often referred to as the account number, yet for consistency this is always referred to as accountId. Accepts both IBAN & BBAN"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"CaOwnersSignersByCustomerResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/party/ca/accounts/{accountId}/owners/signers","fullPath":"/api/v1.1.0/party/ca/accounts/{accountId}/owners/signers","operationId":"getCaOwnersSignersByAccount","name":"Retrieves the owner and signer details for a specific account such as account number, customer id, owner flag, signer flag, etc","summary":"Retrieves the owner and signer details for a specific account","tags":["RETAIL"],"parameters":[{"name":"accountId","in":"path","type":"string","required":true,"description":"Identifier of the account. Often referred to as the account number, yet for consistency this is always referred to as accountId. Accepts both IBAN & BBAN"},{"name":"customerId","in":"query","type":"string","required":false,"description":"Identifier of the customer"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"CaOwnersSignersByAccountResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}}]},{"key":"party-ca-customer-service-v2.2.0","title":"Customer management","version":"v2.2.0","description":"API to create, update and retrieve customer profile details","endpointCount":7,"endpoints":[{"method":"GET","path":"/party/ca/customers/profiles","fullPath":"/api/v2.2.0/party/ca/customers/profiles","operationId":"getCaCustomerProfile","name":"Retrieve the customer profile information based on sin number, given name, family name, customer id.","summary":"Retrieve the customer profile information","tags":["RETAIL"],"parameters":[{"name":"beneficiarySocialInsuranceNumber","in":"query","type":"string","required":false,"description":"Contains the beneficiary social insurance number "},{"name":"customerId","in":"query","type":"string","required":false,"description":"Identifier of the customer"},{"name":"customerName","in":"query","type":"string","required":false,"description":"Indicates the name of the customer. Originator is the party who requests the payment cancellation."},{"name":"lastName","in":"query","type":"string","required":false,"description":"The last name of an individual customer"},{"name":"firstName","in":"query","type":"string","required":false,"description":"Specifies customer's first name"},{"name":"shortName","in":"query","type":"string","required":false,"description":"Contains the name of the account, basically the short title of the account."},{"name":"street","in":"query","type":"string","required":false,"description":"Contains the street name of the customer or the property"},{"name":"addressCity","in":"query","type":"string","required":false,"description":"The town and/or city component of the base address of a customer"},{"name":"countryId","in":"query","type":"string","required":false,"description":"ISO country code of the financial institution. "},{"name":"postCode","in":"query","type":"string","required":false,"description":"Identifies the address postal code for the customer or the property"},{"name":"dateOfBirth","in":"query","type":"string","required":false,"description":"The date of birth of an individual customer"},{"name":"customerStatus","in":"query","type":"string","required":false,"description":"The internal bank status of a customer"},{"name":"sectorId","in":"query","type":"string","required":false,"description":"An institution-defined identifier of the type of customer"},{"name":"accountOfficerId","in":"query","type":"string","required":false,"description":"The identifier of the department head or specific account officer responsible for the customer"},{"name":"industryId","in":"query","type":"string","required":false,"description":"An institution-defined identifier of the industry in which the customer is trading, operating or is associated with"},{"name":"nationalityId","in":"query","type":"string","required":false,"description":"The identifier of the nationality of a customer"},{"name":"residenceId","in":"query","type":"string","required":false,"description":"The identifier of the country of residence of a customer"},{"name":"phoneNumber","in":"query","type":"string","required":false,"description":"The phone number of the customer or prospect"},{"name":"customerMnemonic","in":"query","type":"string","required":false,"description":"Specifies an alternative easy means of referencing the Customer"},{"name":"customerType","in":"query","type":"string","required":false,"description":"Identifies the type of customers. Example Personal, Business, Corporate, etc."},{"name":"email","in":"query","type":"string","required":false,"description":"Email Identifier of the Customer"},{"name":"mobileNumber","in":"query","type":"string","required":false,"description":"Mobile number of the customer"},{"name":"faxId","in":"query","type":"string","required":false,"description":"The fax (facsimile) number of the customer"},{"name":"address","in":"query","type":"string","required":false,"description":"Contains the communication address of the customer or full address of the property"},{"name":"relCustomer","in":"query","type":"string","required":false,"description":"Customers linked or related to the arrangement owner"},{"name":"relationshipCode","in":"query","type":"string","required":false,"description":"Relationship identifier between the partyType and relatedPartyType"},{"name":"id","in":"query","type":"string","required":false,"description":"Contains the daily position class id."},{"name":"idType","in":"query","type":"string","required":false,"description":"Specifies the type of the identifier used for the participant ID such as the BIC or NATIONAL.ID of a non-financial Payments Market Infrastructures (PMI)"},{"name":"mobilePhoneNumber","in":"query","type":"string","required":false,"description":"Represents the phone number of a customer"},{"name":"taxId","in":"query","type":"string","required":false,"description":"Holds the Customer's TAX/SSN Id."},{"name":"officePhoneNumber","in":"query","type":"string","required":false,"description":"The office phone number of the customer"},{"name":"legalId","in":"query","type":"string","required":false,"description":"Unique reference number of the legal documents submitted as identification proof"},{"name":"legalDocumentName","in":"query","type":"string","required":false,"description":"Name of the legal documents such as passport, driving licence etc., provided as identification proof"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"CaCustomerProfileResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"POST","path":"/party/ca/customers","fullPath":"/api/v2.2.0/party/ca/customers","operationId":"createCaCustomerProfiles","name":"Create new customer profiles (CIF) such as personal, business, etc from digital channels with customer information","summary":"Create new customer profile","tags":["RETAIL"],"parameters":[{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"communication":[{}],"idDocument":[{}],"garnishmentReferences":[{}],"displayNames":[{}],"customerNames":[{}],"communicationDevices":[{}],"faxIds":[{}],"officePhoneNumbers":[{}],"streets":[{}],"addresses":[{}],"addressCities":[{}],"countries":[{}],"legalDetails":[{}],"otherNationalityIds":[{}],"employDetails":[{}]}},"responses":{"200":"CaCustomerProfilesResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/party/ca/customers/{customerId}","fullPath":"/api/v2.2.0/party/ca/customers/{customerId}","operationId":"updateCaCustomerProfile","name":"Update customer profile to change name, address, phone and email etc.","summary":"Update customer profile","tags":["RETAIL"],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"Identifier of the customer"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"communication":[{}],"idDocument":[{}],"garnishmentReferences":[{}],"displayNames":[{}],"customerNames":[{}],"communicationDevices":[{}],"faxIds":[{}],"officePhoneNumbers":[{}],"streets":[{}],"addresses":[{}],"addressCities":[{}],"countries":[{}],"legalDetails":[{}],"otherNationalityIds":[{}],"employDetails":[{}]}},"responses":{"200":"CaCustomerProfileResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"POST","path":"/party/ca/customers/membership","fullPath":"/api/v2.2.0/party/ca/customers/membership","operationId":"createCaMembershipProfile","name":"Create new membership profiles such as personal, business, etc from digital channels with customer information","summary":"Create new membership profile","tags":["RETAIL"],"parameters":[{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"displayNames":[{}],"customerNames":[{}],"communicationDevices":[{}],"faxIds":[{}],"officePhoneNumbers":[{}],"streets":[{}],"addresses":[{}],"addressCities":[{}],"countries":[{}],"legalDetails":[{}],"otherNationalityIds":[{}],"employDetails":[{}],"residenceDetails":[{}],"relationshipDetails":[{}],"postingRestrictIds":[{}]}},"responses":{"200":"CaMembershipProfileResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/party/ca/customers/{customerId}/membership","fullPath":"/api/v2.2.0/party/ca/customers/{customerId}/membership","operationId":"updateCaMembershipProfile","name":"Update membership profile to amend name, address, phone and email etc.","summary":"Update membership profile","tags":["RETAIL"],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"Identifier of the customer"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"displayNames":[{}],"customerNames":[{}],"communicationDevices":[{}],"faxIds":[{}],"officePhoneNumbers":[{}],"streets":[{}],"addresses":[{}],"addressCities":[{}],"countries":[{}],"legalDetails":[{}],"otherNationalityIds":[{}],"employDetails":[{}],"residenceDetails":[{}],"relationshipDetails":[{}],"postingRestrictIds":[{}]}},"responses":{"200":"CaMembershipProfileResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/party/ca/customers/{customerId}/owners/signers","fullPath":"/api/v2.2.0/party/ca/customers/{customerId}/owners/signers","operationId":"getCaOwnersSignersByCustomer","name":"Retrieves the owner and signer details for a specific customer such as account number, customer id, owner flag, signer flag, etc\"","summary":"Retrieves the owner and signer details for a specific customer","tags":["RETAIL"],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"Identifier of the customer"},{"name":"accountId","in":"query","type":"string","required":false,"description":"Identifier of the account. Often referred to as the account number, yet for consistency this is always referred to as accountId. Accepts both IBAN & BBAN"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"CaOwnersSignersByCustomerResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/party/ca/accounts/{accountId}/owners/signers","fullPath":"/api/v2.2.0/party/ca/accounts/{accountId}/owners/signers","operationId":"getCaOwnersSignersByAccount","name":"Retrieves the owner and signer details for a specific account such as account number, customer id, owner flag, signer flag, etc","summary":"Retrieves the owner and signer details for a specific account","tags":["RETAIL"],"parameters":[{"name":"accountId","in":"path","type":"string","required":true,"description":"Identifier of the account. Often referred to as the account number, yet for consistency this is always referred to as accountId. Accepts both IBAN & BBAN"},{"name":"customerId","in":"query","type":"string","required":false,"description":"Identifier of the customer"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"CaOwnersSignersByAccountResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}}]},{"key":"party-ca-customer-service-v2.3.0","title":"Customer management","version":"v2.3.0","description":"API to create, update and retrieve customer profile details","endpointCount":7,"endpoints":[{"method":"POST","path":"/party/ca/customers/membership","fullPath":"/api/v2.3.0/party/ca/customers/membership","operationId":"createCaMembershipProfile","name":"Create new membership profiles such as personal, business, etc from digital channels with customer information","summary":"Create new membership profile","tags":["RETAIL"],"parameters":[{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"displayNames":[{}],"customerNames":[{}],"communicationDevices":[{}],"faxIds":[{}],"officePhoneNumbers":[{}],"streets":[{}],"addresses":[{}],"addressCities":[{}],"countries":[{}],"legalDetails":[{}],"otherNationalityIds":[{}],"employDetails":[{}],"residenceDetails":[{}],"relationshipDetails":[{}],"postingRestrictIds":[{}]}},"responses":{"200":"CaMembershipProfileResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/party/ca/customers/{customerId}/membership","fullPath":"/api/v2.3.0/party/ca/customers/{customerId}/membership","operationId":"updateCaMembershipProfile","name":"Update membership profile to amend name, address, phone and email etc.","summary":"Update membership profile","tags":["RETAIL"],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"Identifier of the customer"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"displayNames":[{}],"customerNames":[{}],"communicationDevices":[{}],"faxIds":[{}],"officePhoneNumbers":[{}],"streets":[{}],"addresses":[{}],"addressCities":[{}],"countries":[{}],"legalDetails":[{}],"otherNationalityIds":[{}],"employDetails":[{}],"residenceDetails":[{}],"relationshipDetails":[{}],"postingRestrictIds":[{}]}},"responses":{"200":"CaMembershipProfileResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/party/ca/customers/{customerId}/owners/signers","fullPath":"/api/v2.3.0/party/ca/customers/{customerId}/owners/signers","operationId":"getCaOwnersSignersByCustomer","name":"Retrieves the owner and signer details for a specific customer such as account number, customer id, owner flag, signer flag, etc\"","summary":"Retrieves the owner and signer details for a specific customer","tags":["RETAIL"],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"Identifier of the customer"},{"name":"accountId","in":"query","type":"string","required":false,"description":"Identifier of the account. Often referred to as the account number, yet for consistency this is always referred to as accountId. Accepts both IBAN & BBAN"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"CaOwnersSignersByCustomerResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/party/ca/accounts/{accountId}/owners/signers","fullPath":"/api/v2.3.0/party/ca/accounts/{accountId}/owners/signers","operationId":"getCaOwnersSignersByAccount","name":"Retrieves the owner and signer details for a specific account such as account number, customer id, owner flag, signer flag, etc","summary":"Retrieves the owner and signer details for a specific account","tags":["RETAIL"],"parameters":[{"name":"accountId","in":"path","type":"string","required":true,"description":"Identifier of the account. Often referred to as the account number, yet for consistency this is always referred to as accountId. Accepts both IBAN & BBAN"},{"name":"customerId","in":"query","type":"string","required":false,"description":"Identifier of the customer"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"CaOwnersSignersByAccountResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"POST","path":"/party/ca/customers","fullPath":"/api/v2.3.0/party/ca/customers","operationId":"createCaCustomerProfiles","name":"Create new customer profiles (CIF) such as personal, business, etc from digital channels with customer information","summary":"Create new customer profile","tags":["RETAIL"],"parameters":[{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"communication":[{}],"idDocument":[{}],"garnishmentReferences":[{}],"externalId":[{}],"displayNames":[{}],"customerNames":[{}],"communicationDevices":[{}],"faxIds":[{}],"officePhoneNumbers":[{}],"streets":[{}],"addresses":[{}],"addressCities":[{}],"countries":[{}],"legalDetails":[{}],"otherNationalityIds":[{}]}},"responses":{"200":"CaCustomerProfilesResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/party/ca/customers/{customerId}","fullPath":"/api/v2.3.0/party/ca/customers/{customerId}","operationId":"updateCaCustomerProfile","name":"Update customer profile to change name, address, phone and email etc.","summary":"Update customer profile","tags":["RETAIL"],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"Identifier of the customer"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"communication":[{}],"idDocument":[{}],"garnishmentReferences":[{}],"externalId":[{}],"displayNames":[{}],"customerNames":[{}],"communicationDevices":[{}],"faxIds":[{}],"officePhoneNumbers":[{}],"streets":[{}],"addresses":[{}],"addressCities":[{}],"countries":[{}],"legalDetails":[{}],"otherNationalityIds":[{}]}},"responses":{"200":"CaCustomerProfileResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/party/ca/customers/profiles","fullPath":"/api/v2.3.0/party/ca/customers/profiles","operationId":"getCaCustomerProfile","name":"Retrieve the customer profile information based on sin number, given name, family name, customer id.","summary":"Retrieve the customer profile information","tags":["RETAIL"],"parameters":[{"name":"beneficiarySocialInsuranceNumber","in":"query","type":"string","required":false,"description":"Contains the beneficiary social insurance number "},{"name":"customerId","in":"query","type":"string","required":false,"description":"Identifier of the customer"},{"name":"customerName","in":"query","type":"string","required":false,"description":"Indicates the name of the customer. Originator is the party who requests the payment cancellation."},{"name":"lastName","in":"query","type":"string","required":false,"description":"The last name of an individual customer"},{"name":"firstName","in":"query","type":"string","required":false,"description":"Specifies customer's first name"},{"name":"shortName","in":"query","type":"string","required":false,"description":"Contains the name of the account, basically the short title of the account."},{"name":"street","in":"query","type":"string","required":false,"description":"Contains the street name of the customer or the property"},{"name":"addressCity","in":"query","type":"string","required":false,"description":"The town and/or city component of the base address of a customer"},{"name":"countryId","in":"query","type":"string","required":false,"description":"ISO country code of the financial institution. "},{"name":"postCode","in":"query","type":"string","required":false,"description":"Identifies the address postal code for the customer or the property"},{"name":"dateOfBirth","in":"query","type":"string","required":false,"description":"The date of birth of an individual customer"},{"name":"customerStatus","in":"query","type":"string","required":false,"description":"The internal bank status of a customer"},{"name":"sectorId","in":"query","type":"string","required":false,"description":"An institution-defined identifier of the type of customer"},{"name":"accountOfficerId","in":"query","type":"string","required":false,"description":"The identifier of the department head or specific account officer responsible for the customer"},{"name":"industryId","in":"query","type":"string","required":false,"description":"An institution-defined identifier of the industry in which the customer is trading, operating or is associated with"},{"name":"nationalityId","in":"query","type":"string","required":false,"description":"The identifier of the nationality of a customer"},{"name":"residenceId","in":"query","type":"string","required":false,"description":"The identifier of the country of residence of a customer"},{"name":"phoneNumber","in":"query","type":"string","required":false,"description":"The phone number of the customer or prospect"},{"name":"customerMnemonic","in":"query","type":"string","required":false,"description":"Specifies an alternative easy means of referencing the Customer"},{"name":"customerType","in":"query","type":"string","required":false,"description":"Identifies the type of customers. Example Personal, Business, Corporate, etc."},{"name":"email","in":"query","type":"string","required":false,"description":"Email Identifier of the Customer"},{"name":"mobilePhoneNumber","in":"query","type":"string","required":false,"description":"Represents the phone number of a customer"},{"name":"faxId","in":"query","type":"string","required":false,"description":"The fax (facsimile) number of the customer"},{"name":"address","in":"query","type":"string","required":false,"description":"Contains the communication address of the customer or full address of the property"},{"name":"relCustomer","in":"query","type":"string","required":false,"description":"Customers linked or related to the arrangement owner"},{"name":"relationshipCode","in":"query","type":"string","required":false,"description":"Relationship identifier between the partyType and relatedPartyType"},{"name":"id","in":"query","type":"string","required":false,"description":"Contains the daily position class id."},{"name":"idType","in":"query","type":"string","required":false,"description":"Specifies the type of the identifier used for the participant ID such as the BIC or NATIONAL.ID of a non-financial Payments Market Infrastructures (PMI)"},{"name":"taxId","in":"query","type":"string","required":false,"description":"Holds the Customer's TAX/SSN Id."},{"name":"officePhoneNumber","in":"query","type":"string","required":false,"description":"The office phone number of the customer"},{"name":"legalId","in":"query","type":"string","required":false,"description":"Unique reference number of the legal documents submitted as identification proof"},{"name":"legalDocumentName","in":"query","type":"string","required":false,"description":"Name of the legal documents such as passport, driving licence etc., provided as identification proof"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"CaCustomerProfileResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}}]},{"key":"party-ca-customers-service-v1.1.0","title":"Customer Management","version":"v1.1.0","description":"API to retrieve the list of customers","endpointCount":1,"endpoints":[{"method":"GET","path":"/party/ca/customers","fullPath":"/api/v1.1.0/party/ca/customers","operationId":"getCaCustomerList","name":"Retrieves the list of all customers","summary":"Retrieves the list of customers","tags":["RETAIL"],"parameters":[{"name":"customerId","in":"query","type":"string","required":false,"description":"Identifier of the customer"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"CaCustomerListResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}}]},{"key":"party-ca-payment-service-v1.0.0","title":"Payment management","version":"v1.0.0","description":"Canadian region APIs to create, update and retrieve external payments, payment orders and recurring order instructions for payments","endpointCount":4,"endpoints":[{"method":"POST","path":"/party/ca/beneficiaries","fullPath":"/api/v1.0.0/party/ca/beneficiaries","operationId":"createCaBeneficiaries","name":"Creates beneficiary with details such as beneficial account, address, beneficiary bank and other preferred options for payment processing","summary":"Create a beneficiary for payment processing","tags":["RETAIL"],"parameters":[{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"beneficiaryNickNames":[{}],"beneficiaryBICIBANNames":[{}],"paymentDetails":[{}],"overrides":[{}],"addressDetail":"string","city":"string","country":"string","stateId":"string","ownAccount":"string","cardNumber":"string","categoryId":"string","beneficiaryName":"string","lastName":"string","transactionType":"string","beneficiaryCustomerId":"string"}},"responses":{"200":"CaBeneficiariesResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/party/ca/beneficiaries/{beneficiaryId}","fullPath":"/api/v1.0.0/party/ca/beneficiaries/{beneficiaryId}","operationId":"updateCaBeneficiaries","name":"Update beneficiary details such as beneficial account, address, beneficiary bank and other preferred options for payment processing","summary":"Update a beneficiary details for payment processing","tags":["RETAIL"],"parameters":[{"name":"beneficiaryId","in":"path","type":"string","required":true,"description":"Indicates the reference of the financial institution that allows access to the beneficiary information"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"beneficiaryNickNames":[{}],"beneficiaryBICIBANNames":[{}],"paymentDetails":[{}],"overrides":[{}],"addressDetail":"string","city":"string","country":"string","stateId":"string","ownAccount":"string","cardNumber":"string","categoryId":"string","beneficiaryName":"string","lastName":"string","transactionType":"string","beneficiaryCustomerId":"string"}},"responses":{"200":"CaBeneficiariesResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/party/ca/customers/{customerId}/externalAccounts","fullPath":"/api/v1.0.0/party/ca/customers/{customerId}/externalAccounts","operationId":"getCaCustomerExternalAccounts","name":"Retrieve the beneficiary details such as beneficial account, address, beneficiary bank and other preferred options for intermember setup based on customer id","summary":"Retrieve the beneficiary details for intermember setup based on customer id ","tags":["RETAIL"],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"Identifier of the customer"},{"name":"cardId","in":"query","type":"string","required":false,"description":"Contains the card identification number which consists of card type and unique card number. example MEMC-12345678."},{"name":"beneficiaryId","in":"query","type":"string","required":false,"description":"Indicates the reference of the financial institution that allows access to the beneficiary information"},{"name":"ownAccount","in":"query","type":"string","required":false,"description":"Indicates the transfer of funds between accounts of same member"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"CaCustomerExternalAccountsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/party/ca/cards/{cardId}/externalAccounts","fullPath":"/api/v1.0.0/party/ca/cards/{cardId}/externalAccounts","operationId":"getCaCardExternalAccounts","name":"Retrieve the beneficiary details such as beneficial account, address, beneficiary bank and other preferred options for intermember setup based on card id","summary":"Retrieve the beneficiary details for intermember setup based on card id","tags":["RETAIL"],"parameters":[{"name":"cardId","in":"path","type":"string","required":true,"description":"Contains the card identification number which consists of card type and unique card number. example MEMC-12345678."},{"name":"customerId","in":"query","type":"string","required":false,"description":"Identifier of the customer"},{"name":"beneficiaryId","in":"query","type":"string","required":false,"description":"Indicates the reference of the financial institution that allows access to the beneficiary information"},{"name":"ownAccount","in":"query","type":"string","required":false,"description":"Indicates the transfer of funds between accounts of same member"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"CaCardExternalAccountsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}}]},{"key":"party-customer-arrangements-v1.0.0","title":"Customer product list","version":"v1.0.0","description":"Retrieves the list of accounts(Accounts,Deposits,Loans) available for a customer","endpointCount":4,"endpoints":[{"method":"GET","path":"/party/customers/{customerId}/arrangements","fullPath":"/api/v1.0.0/party/customers/{customerId}/arrangements","operationId":"getArrangementList","name":"Retrieves the list of accounts(Accounts,Deposits,Loans) available for a customer","summary":"Retrieves the list of accounts(Accounts,Deposits,Loans) available for a customer","tags":[],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"The identifier of the customer"},{"name":"arrangementId","in":"query","type":"string","required":false,"description":"The unique identifiier of an arrangement contract. The format of the ID is YYDDDXXXXX prefixed with AA. YYDDD is the year and date of input in julian date format, XXXXX - is a random generated string."},{"name":"productGroup","in":"query","type":"string","required":false,"description":""},{"name":"product","in":"query","type":"string","required":false,"description":""},{"name":"currency","in":"query","type":"string","required":false,"description":""},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from t24 on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":""},{"name":"companyId","in":"header","type":"string","required":false,"description":"The identifier of the company, following the format CCGGGLLLL, where: CC is the country code, GGG is Company Group Code and LLLL is the Local Code. Country Code must be a valid countryCode, Company Gr"}],"requestBodyExample":null,"responses":{"200":"ArrangementListResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/party/customers/{customerId}/accounts","fullPath":"/api/v1.0.0/party/customers/{customerId}/accounts","operationId":"getArrangementAccounts","name":"Retrieves the list of accounts available for a customer(Only from Accounts Product)","summary":"Retrieves the list of accounts available for a customer(Only from Accounts Product)","tags":[],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"The identifier of the customer"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from t24 on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":""},{"name":"companyId","in":"header","type":"string","required":false,"description":"The identifier of the company, following the format CCGGGLLLL, where: CC is the country code, GGG is Company Group Code and LLLL is the Local Code. Country Code must be a valid countryCode, Company Gr"}],"requestBodyExample":null,"responses":{"200":"ArrangementAccountsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/party/customers/{customerId}/productBundles","fullPath":"/api/v1.0.0/party/customers/{customerId}/productBundles","operationId":"getProductBundles","name":"Retrieves the list of Bundle accounts available for a customer","summary":"Retrieves the list of Bundle accounts available for a customer","tags":[],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"The identifier of the customer"},{"name":"arrangementId","in":"query","type":"string","required":false,"description":"The unique identifiier of an arrangement contract. The format of the ID is YYDDDXXXXX prefixed with AA. YYDDD is the year and date of input in julian date format, XXXXX - is a random generated string."},{"name":"productGroupId","in":"query","type":"string","required":false,"description":"The identifier of the product group"},{"name":"productId","in":"query","type":"string","required":false,"description":"The identifier of the product"},{"name":"currencyId","in":"query","type":"string","required":false,"description":"The identifier of the curreny. The is the 3 letter ISO 4217 code of the currency."},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from t24 on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":""},{"name":"companyId","in":"header","type":"string","required":false,"description":"The identifier of the company, following the format CCGGGLLLL, where: CC is the country code, GGG is Company Group Code and LLLL is the Local Code. Country Code must be a valid countryCode, Company Gr"}],"requestBodyExample":null,"responses":{"200":"ProductBundlesResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/party/customers/{customerId}/preferentialPricing","fullPath":"/api/v1.0.0/party/customers/{customerId}/preferentialPricing","operationId":"getPreferentialPricing","name":"Retrieves the Pricing Condition related to a customer","summary":"Retrieves the Pricing Condition related to a customer","tags":[],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"The identifier of the customer"},{"name":"arrangementId","in":"query","type":"string","required":false,"description":"The unique identifiier of an arrangement contract. The format of the ID is YYDDDXXXXX prefixed with AA. YYDDD is the year and date of input in julian date format, XXXXX - is a random generated string."},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from t24 on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":""},{"name":"companyId","in":"header","type":"string","required":false,"description":"The identifier of the company, following the format CCGGGLLLL, where: CC is the country code, GGG is Company Group Code and LLLL is the Local Code. Country Code must be a valid countryCode, Company Gr"}],"requestBodyExample":null,"responses":{"200":"PreferentialPricingResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}}]},{"key":"party-customer-ifrs-v1.0.0","title":"IFRS Customer Default Probability","version":"v1.0.0","description":"API to update probability of default (the probability that the asset will default) at customer level to calculate the expected credit loss based on their stages under IFRS 9 impairment model","endpointCount":1,"endpoints":[{"method":"PUT","path":"/party/customer/{customerId}/ifrs/lossProbabilities","fullPath":"/api/v1.0.0/party/customer/{customerId}/ifrs/lossProbabilities","operationId":"updateCustomerLossProbability","name":"API to update Probability of Default (PD) at the customer level to calculate the expected credit loss (ECL) provisioning in IFRS 9 impairment model","summary":"Update probability of default on customer","tags":[],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"Identifier of the customer"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"probabilityOfDefaults":[{}]}},"responses":{"200":"CustomerLossProbabilityResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}}]},{"key":"party-customer-ifrs-v1.1.0","title":"IFRS Customer Default Probability","version":"v1.1.0","description":"Update probability of default (the probability that the asset will default) and loss given default (the loss percentage given that when the asset default) at customer level to calculate the expected credit loss based on their stages under IFRS 9 impairment model.","endpointCount":1,"endpoints":[{"method":"PUT","path":"/party/customer/{customerId}/ifrs/lossProbabilities","fullPath":"/api/v1.1.0/party/customer/{customerId}/ifrs/lossProbabilities","operationId":"updateCustomerLossProbability","name":"Update probability of default(PD) and loss given default(LGD) at the customer level to calculate the expected credit loss (ECL) provisioning in IFRS 9 Impairment Model","summary":"Update probability of default and loss given default on customer","tags":[],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"Identifier of the customer"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"probabilityOfDefaults":[{}],"lossGivenDefault":"string","extensions":{}}},"responses":{"200":"CustomerLossProbabilityResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}}]},{"key":"party-customerAdverts-service-v1.0.0","title":"Customer Campaign Management","version":"v1.0.0","description":"API to create, view and manage customer campaigns","endpointCount":3,"endpoints":[{"method":"GET","path":"/party/customers/{customerId}/adverts","fullPath":"/api/v1.0.0/party/customers/{customerId}/adverts","operationId":"getCustomerAdverts","name":"Retrieves the list of customer opportunities generated by the marketing campaigns,Propensity Engine to identify products which are likely to be of interest to specific customers.","summary":"Retrieves the details of opportunities/ campaigns that have been specifically targeted towards the  needs of customers","tags":[],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"Identifier of the customer"},{"name":"languageId","in":"query","type":"string","required":false,"description":"Represents the language code of the underlying Entity/Company/Branch."},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"CustomerAdvertsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"PUT","path":"/party/customers/adverts/{advertId}","fullPath":"/api/v1.0.0/party/customers/adverts/{advertId}","operationId":"updateAdvert","name":"Update campaign details","summary":"Update existing opportunities/adverts records for a customer","tags":[],"parameters":[{"name":"advertId","in":"path","type":"string","required":true,"description":"Contains the identifier associated to the advertisement respective to the customer of the account"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"customerId":"string","opportunityProductId":"string","opportunityDirection":"string","opportunityTemplateId":"string","startDate":"2024-01-01","opportunityStatus":"string","transactionApplication":"string","transactionId":"string"}},"responses":{"200":"AdvertResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"POST","path":"/party/customers/adverts","fullPath":"/api/v1.0.0/party/customers/adverts","operationId":"createAdvert","name":"Create campaign for customer","summary":"Create new opportunities/adverts for a customer","tags":[],"parameters":[{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"customerId":"string","opportunityProductId":"string","opportunityDirection":"string","opportunityTemplateId":"string","startDate":"2024-01-01","opportunityStatus":"string","transactionApplication":"string","transactionId":"string"}},"responses":{"200":"AdvertResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}}]},{"key":"party-customerAlerts-service-v1.0.0","title":"Party Customer Alerts APIs","version":"v1.0.0","description":"Retrieves the information about the customer alerts.","endpointCount":1,"endpoints":[{"method":"GET","path":"/party/customers/{customerId}/alertRequests","fullPath":"/api/v1.0.0/party/customers/{customerId}/alertRequests","operationId":"getAlertRequests","name":"Retrieves alert requests details.Refer the existing URI from the party-customerServices-v4.0.0","summary":"Retrieves the alert subscription details for specific customer","tags":[],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"Identifier of the customer"},{"name":"contractReference","in":"query","type":"string","required":false,"description":"Contains the contract reference"},{"name":"subscribe","in":"query","type":"string","required":false,"description":"Enables an alert service"},{"name":"alertRequestId","in":"query","type":"string","required":false,"description":"The unique identifier of the alert request."},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"AlertRequestsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}}]},{"key":"party-customerConsents-service-v1.0.0","title":"Customer Consents APIs","version":"v1.0.0","description":"Party customer consents APIs - Deprecated. Use getConsent API of party-dataProtection-customers-v1.3.0 instead","endpointCount":1,"endpoints":[{"method":"GET","path":"/party/customers/{customerId}/consents","fullPath":"/api/v1.0.0/party/customers/{customerId}/consents","operationId":"getCustomerConsents","name":"Retrieves customer consents details","summary":"Retrieves the list of consent details for specific customer","tags":[],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"Identifier of the customer"},{"name":"propertyClassId","in":"query","type":"string","required":false,"description":"The identifier of a condition that is used to build a product"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from t24 on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"CustomerConsentsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}}]},{"key":"party-customerDeliveryPreferences-service-v1.0.0","title":"Management of Customer communication preferences","version":"v1.0.0","description":"Allows the creation, viewing and management of customer delivery preferences.","endpointCount":4,"endpoints":[{"method":"GET","path":"/party/customers/{customerId}/deliveryPreferences","fullPath":"/api/v1.0.0/party/customers/{customerId}/deliveryPreferences","operationId":"getCustomerDeliveryPreferences","name":"Retrieves customer delivery preferences details","summary":"Retrieves the list of delivery channel details for specific customer","tags":[],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"Identifier of the customer"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from t24 on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"CustomerDeliveryPreferencesResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"POST","path":"/party/customers/{customerId}/deliveryPreferences","fullPath":"/api/v1.0.0/party/customers/{customerId}/deliveryPreferences","operationId":"createCustomerDeliveryPreference","name":"Create customer delivery preference","summary":"Create a new delivery channel for specific customer","tags":[],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"Identifier of the customer"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"groups":[{}]}},"responses":{"200":"CustomerDeliveryPreferenceResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/party/customers/{customerId}/deliveryPreferences","fullPath":"/api/v1.0.0/party/customers/{customerId}/deliveryPreferences","operationId":"updateCustomerDeliveryPreference","name":"Update customer delivery preference details","summary":"Update existing delivery channel details for specific customer","tags":[],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"Identifier of the customer"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"groups":[{}]}},"responses":{"200":"CustomerDeliveryPreferenceResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"DELETE","path":"/party/customers/{customerId}/deliveryPreferences","fullPath":"/api/v1.0.0/party/customers/{customerId}/deliveryPreferences","operationId":"deleteCustomerDeliveryPreference","name":"Remove customer delivery preference","summary":"Remove an existing delivery channel record details for specific customer","tags":[],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"Identifier of the customer"},{"name":"payload","in":"body","type":"object","required":false,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}}},"responses":{"200":"CustomerDeliveryPreferenceResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}}]},{"key":"party-customerMandates-service-v1.0.0","title":"Management of signatory mandates","version":"v1.0.0","description":"API to create, update and manage signatory mandates and perform mandate check simulation for a transaction. Mandates are configurable settings in the system for financial or non financial transactions that require a set of valid signatories approvals before transactions can be authorized","endpointCount":4,"endpoints":[{"method":"PUT","path":"/party/customers/mandates/{customerId}","fullPath":"/api/v1.0.0/party/customers/mandates/{customerId}","operationId":"updateMandate","name":"Update the existing mandate details for specific customer","summary":"Update the mandate details for customer","tags":[],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"Identifier of the customer"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"mandates":[{}],"rules":[{}],"displayName":"string","limitCurrencyId":"string"}},"responses":{"200":"MandateResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/party/mandates/parameters/{applicationId}","fullPath":"/api/v1.0.0/party/mandates/parameters/{applicationId}","operationId":"updateMandateParameter","name":"Update the existing mandate parameter details for specific application","summary":"Update the mandate parameter details","tags":[],"parameters":[{"name":"applicationId","in":"path","type":"string","required":true,"description":"Contains the application id of the service that has crashed due to error."},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"fieldIds":[{}],"displayName":"string","raiseAlert":"string"}},"responses":{"200":"MandateParameterResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/party/customers/signatories/{signatoryGroupId}","fullPath":"/api/v1.0.0/party/customers/signatories/{signatoryGroupId}","operationId":"updateSignatoryGroup","name":"Update the existing signatory details for specific customer group","summary":"Update the signatory group details","tags":[],"parameters":[{"name":"signatoryGroupId","in":"path","type":"string","required":true,"description":"Specifies the minimum signatory group id"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"signatories":[{}],"displayName":"string"}},"responses":{"200":"SignatoryGroupResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/party/mandates/signatories/transactionSimulations/{transactionSimulationId}","fullPath":"/api/v1.0.0/party/mandates/signatories/transactionSimulations/{transactionSimulationId}","operationId":"simulateSignatoryMandateProcessing","name":"Simulate mandate processing for a transaction based on the transaction account, customer or portfolio, transaction amount, currency and list of signatories.","summary":"Simulate Mandate Processing for a Transaction","tags":[],"parameters":[{"name":"transactionSimulationId","in":"path","type":"string","required":true,"description":"Indicates the application or version reference on which the transaction simulation is being performed"},{"name":"customerId","in":"query","type":"string","required":false,"description":"Identifier of the customer"},{"name":"accountId","in":"query","type":"string","required":false,"description":"Identifier of the account. Often referred to as the account number, yet for consistency this is always referred to as accountId. Accepts both IBAN & BBAN"},{"name":"portfolioId","in":"query","type":"string","required":false,"description":"Id of the portfolio or security account"},{"name":"amount","in":"query","type":"string","required":false,"description":"This is the payment amount"},{"name":"currencyId","in":"query","type":"string","required":false,"description":"Identifier of the currency. This is the 3-letter ISO 4217 code of the currency."},{"name":"signatory","in":"query","type":"string","required":false,"description":"The authorised signatories for the payments can be specified here. More applicable in case of corporate payments where multiple signatories are required to sign a payment instruction"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from t24 on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"SignatoryMandateProcessingResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}}]},{"key":"party-customerOpenBankingConnections-service-v1.0.0","title":"Customer Open Banking Connections","version":"v1.0.0","description":"API to create, view and manage the customer external account aggregation connections","endpointCount":5,"endpoints":[{"method":"POST","path":"/party/customers/openBankingConnections/{connectionId}","fullPath":"/api/v1.0.0/party/customers/openBankingConnections/{connectionId}","operationId":"createOpenBankingConnection","name":"Create open banking connection","summary":"Initiate a request to map a new external account into customer profile","tags":[],"parameters":[{"name":"connectionId","in":"path","type":"string","required":true,"description":"Contains the id associated to the connect reference respective to a transaction of the account"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"otherBankConsentTypes":[{}],"consents":[{}],"customerId":"string","bankId":"string","bankName":"string","bankCode":"string","countryId":"string","obcpId":"string","obcpConnectionId":"string","connectionStatus":"string","subStatus":"string","currentState":"string","latestToken":"string","latestRedirectUrl":"string","defaultConsentArrangementId":"string"}},"responses":{"200":"OpenBankingConnectionResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/party/customers/openBankingConnections/{connectionId}","fullPath":"/api/v1.0.0/party/customers/openBankingConnections/{connectionId}","operationId":"removeOpenBankingConnection","name":"Remove open banking connection","summary":"Revoke the access of existing external accounts for a customer","tags":[],"parameters":[{"name":"connectionId","in":"path","type":"string","required":true,"description":"Contains the id associated to the connect reference respective to a transaction of the account"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"otherBankConsentTypes":[{}],"consents":[{}],"obcp":[{}],"customerId":"string","bankId":"string","bankCode":"string","bankName":"string","countryId":"string","obcpId":"string","obcpConnectionId":"string","obcpBankId":"string","obcpCustomerId":"string","connectionStatus":"string","subStatus":"string","currentState":"string"}},"responses":{"200":"OpenBankingConnectionResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/party/customers/connectionReconnections/{connectionId}","fullPath":"/api/v1.0.0/party/customers/connectionReconnections/{connectionId}","operationId":"reconnectOpenBankingConnection","name":"This API is used to Renew or reconnect the access of existing external accounts for a customer","summary":"Renew the access of existing external accounts for a customer","tags":[],"parameters":[{"name":"connectionId","in":"path","type":"string","required":true,"description":"Contains the id associated to the connect reference respective to a transaction of the account"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"otherBankConsentTypes":[{}],"consents":[{}],"customerId":"string","bankId":"string","bankName":"string","bankCode":"string","countryId":"string","obcpId":"string","obcpConnectionId":"string","connectionStatus":"string","subStatus":"string","currentState":"string","latestToken":"string","latestRedirectUrl":"string","defaultConsentArrangementId":"string"}},"responses":{"200":"OpenBankingConnectionResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/party/customers/connectionRefreshes/{connectionId}","fullPath":"/api/v1.0.0/party/customers/connectionRefreshes/{connectionId}","operationId":"refreshOpenBankingConnection","name":"Refresh open banking connection","summary":"Refresh the existing external accounts to get the up to date details","tags":[],"parameters":[{"name":"connectionId","in":"path","type":"string","required":true,"description":"Contains the id associated to the connect reference respective to a transaction of the account"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"customerId":"string","defaultConsentArrangementId":"string","connectionStatus":"string","subStatus":"string","currentState":"string","updatedAt":"string"}},"responses":{"200":"OpenBankingConnectionResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/party/customers/consents/thirdPartyProviderConsents","fullPath":"/api/v1.0.0/party/customers/consents/thirdPartyProviderConsents","operationId":"getThirdPartyProviderConsents","name":"Retrieves third party provider consents details","summary":"Retrieves the list of details on third parties, banks and customers","tags":[],"parameters":[{"name":"connectionId","in":"query","type":"string","required":false,"description":"Contains the id associated to the connect reference respective to a transaction of the account"},{"name":"customerId","in":"query","type":"string","required":false,"description":"Identifier of the customer"},{"name":"currentState","in":"query","type":"string","required":false,"description":"Contains the current state of the transaction"},{"name":"connectionStatus","in":"query","type":"string","required":false,"description":"Contains the connection status of the transaction"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"ThirdPartyProviderConsentsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}}]},{"key":"party-customerSecureMessages-service-v1.0.0","title":"Party Customer Secure Messages APIs Deprecated","version":"v1.0.0","description":"Allows the creation, viewing and management of customer secure messages.","endpointCount":3,"endpoints":[{"method":"GET","path":"/party/customers/secureMessages","fullPath":"/api/v1.0.0/party/customers/secureMessages","operationId":"readSecureMessages","name":"Retrieves secure messages details - Deprecated. party-customers-messages-service-v1.1.0 instead","summary":"Retrieves the list of messages from Bank to Customer and from customer to Bank","tags":[],"parameters":[{"name":"messageId","in":"query","type":"string","required":false,"description":"The holds the record key of the message ID."},{"name":"parentMessageIdNE","in":"query","type":"string","required":false,"description":"Parent message id not equal to"},{"name":"parentMessageId","in":"query","type":"string","required":false,"description":"Identifier of the parent message."},{"name":"toCustomerId","in":"query","type":"string","required":false,"description":"The unique customer identifier of the Payee, to whom the payment message is to be sent"},{"name":"fromCustomerId","in":"query","type":"string","required":false,"description":"The Customer ID from which the message is triggered."},{"name":"messageStatus","in":"query","type":"string","required":false,"description":"Status of the message"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"SecureMessagesResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"POST","path":"/party/customers/secureMessages","fullPath":"/api/v1.0.0/party/customers/secureMessages","operationId":"createSecureMessage","name":"Create secure message - Deprecated. party-customers-messages-service-v1.1.0 instead","summary":"Initiate a new secure message by customer to bank","tags":[],"parameters":[{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"messages":[{}],"subject":"string","parentMessageId":"string","fromCustomerId":"string","messageStatus":"string","toDepartmentId":"string","uploadId":"string","uploadPath":"string"}},"responses":{"200":"SecureMessageResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/party/customers/secureMessages/{secureMessageId}","fullPath":"/api/v1.0.0/party/customers/secureMessages/{secureMessageId}","operationId":"getSecureMessage","name":"Read secure message details - Deprecated. party-customers-messages-service-v1.1.0 instead","summary":"Retrieves the secure message details for a specific message id","tags":[],"parameters":[{"name":"secureMessageId","in":"path","type":"string","required":true,"description":"Contains the usable amount in the balance"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"SecureMessageResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}}]},{"key":"party-customerServices-v1.0.0","title":"Customer management","version":"v1.0.0","description":"API to create, update and manage Customer details such as delivery preferences, joint customer details, party relationships, KYC details & posting restrictions","endpointCount":25,"endpoints":[{"method":"GET","path":"/party/customers/{customerId}","fullPath":"/api/v1.0.0/party/customers/{customerId}","operationId":"getCustomer","name":"Retrieves the Customer details such as Customer Contact Infromation, Residence details, Legal document details, Occupation details and Relationship details for the Specific Customer","summary":"Retrieves list of Customer details","tags":[],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"Identifier of the customer"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"The identifier of the underlying Entity/Company/Branch."}],"requestBodyExample":null,"responses":{"200":"CustomerResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/party/customers/{customerId}","fullPath":"/api/v1.0.0/party/customers/{customerId}","operationId":"updateCustomer","name":"Update Customer details with the Information such as Customer Contact Infromation, Residence details, Legal document details, Occupation details and Relationship details, etc provided by the User","summary":"Update Customer details","tags":[],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"Identifier of the customer"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"The identifier of the underlying Entity/Company/Branch."}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"displayNames":[{}],"customerNames":[{}],"communicationDevices":[{}],"faxIds":[{}],"officePhoneNumbers":[{}],"streets":[{}],"addresses":[{}],"addressCities":[{}],"countries":[{}],"legalDetails":[{}],"otherNationalityIds":[{}],"employDetails":[{}],"residenceDetails":[{}],"relationshipDetails":[{}],"postingRestrictIds":[{}]}},"responses":{"200":"CustomerResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/party/customers","fullPath":"/api/v1.0.0/party/customers","operationId":"getCustomers","name":"Retrieves the Customer details such as Delivery or Postal details, Contact Infromation, Residence details, Customer Profile, Legal document details, Occupation details and Status of Customer","summary":"Retrieves list of Customer basic details","tags":[],"parameters":[{"name":"customerId","in":"query","type":"string","required":false,"description":"Identifier of the customer"},{"name":"customerName","in":"query","type":"string","required":false,"description":"Name of the customer"},{"name":"street","in":"query","type":"string","required":false,"description":"Contains the first line of customer's base address, example building number, street number etc."},{"name":"town","in":"query","type":"string","required":false,"description":"The town associated with the address of Customer or Party"},{"name":"countryId","in":"query","type":"string","required":false,"description":"ISO country code of the financial institution. "},{"name":"postCode","in":"query","type":"string","required":false,"description":"Identifies the address postal code for the customer."},{"name":"dateOfBirth","in":"query","type":"string","required":false,"description":"The date of birth of an individual customer"},{"name":"status","in":"query","type":"string","required":false,"description":"Status identifier of the account. The values are 'DELETED' if the account is closed, 'BLOCKED' is there are any posting restrictions & 'ENABLED' for active accounts."},{"name":"sectorId","in":"query","type":"string","required":false,"description":"An institution-defined identifier of the type of customer"},{"name":"accountOfficerId","in":"query","type":"string","required":false,"description":"The identifier of the department head or specific account officer responsible for the customer"},{"name":"industryId","in":"query","type":"string","required":false,"description":"An institution-defined identifier of the industry in which the customer is trading, operating or is associated with"},{"name":"nationalityId","in":"query","type":"string","required":false,"description":"The identifier of the nationality of a customer"},{"name":"residenceId","in":"query","type":"string","required":false,"description":"The identifier of the country of residence of a customer"},{"name":"lastName","in":"query","type":"string","required":false,"description":"The last name of an individual customer"},{"name":"phoneNumber","in":"query","type":"string","required":false,"description":"The phone number of the customer or prospect"},{"name":"socialSecurityId","in":"query","type":"string","required":false,"description":"This field can contain the social security numbers of the customer."},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from t24 on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"The identifier of the underlying Entity/Company/Branch."}],"requestBodyExample":null,"responses":{"200":"CustomersResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"POST","path":"/party/customers","fullPath":"/api/v1.0.0/party/customers","operationId":"createCustomer","name":"Create a Customer with the Information such as Customer Contact Infromation, Residence details, Legal document details, Occupation details and Relationship details, etc provided by the User","summary":"Create a Customer","tags":[],"parameters":[{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"The identifier of the underlying Entity/Company/Branch."}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"displayNames":[{}],"customerNames":[{}],"communicationDevices":[{}],"faxIds":[{}],"officePhoneNumbers":[{}],"streets":[{}],"addresses":[{}],"addressCities":[{}],"countries":[{}],"legalDetails":[{}],"otherNationalityIds":[{}],"employDetails":[{}],"residenceDetails":[{}],"relationshipDetails":[{}],"postingRestrictIds":[{}]}},"responses":{"200":"CustomerResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/party/customers/relationships","fullPath":"/api/v1.0.0/party/customers/relationships","operationId":"getCustomerRelationship","name":"Retrieves customer relationship details such as Type of Relationship, Party Information, RelatedAs details, Owning details, Role & Purpose of Relationship for specific party or Customer","summary":"Retrieves list of Customer Relationships","tags":[],"parameters":[{"name":"customerRelationGroupId","in":"query","type":"string","required":false,"description":"Identifies the key to Customer Relationship Group to form a relation"},{"name":"partyId","in":"query","type":"string","required":false,"description":"Allows capturing of customers or person entities to be part of the relationship. If partyType is selected as Customer, then the system will allow only customer Ids to be captured into this field. If p"},{"name":"relatedPartyId","in":"query","type":"string","required":false,"description":"Identifier of the Related Party"},{"name":"relationId","in":"query","type":"string","required":false,"description":"Identifier of the Customer Relationship and Party Relationship"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from t24 on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"The identifier of the underlying Entity/Company/Branch."}],"requestBodyExample":null,"responses":{"200":"CustomerRelationshipResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"POST","path":"/party/customers/relationships","fullPath":"/api/v1.0.0/party/customers/relationships","operationId":"createCustomerRelationship","name":"Create a Customer Relationship for a Customer with details such as Type of Relationship, Party Information, RelatedAs details, Owning details, Role & Purpose of Relationship","summary":"Create Customer Relationship with other customers","tags":[],"parameters":[{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"The identifier of the underlying Entity/Company/Branch."}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"originatingRelation":[{}],"customerRelationGroupId":0.0,"customerRelationGroupName":"string","purposeOfRelationship":"string"}},"responses":{"200":"CustomerRelationshipResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/party/customers/relationships/{relationId}","fullPath":"/api/v1.0.0/party/customers/relationships/{relationId}","operationId":"updateCustomerRelationship","name":"Update Customer Relationship for a Customer with details such as Type of Relationship, Party Information, Related details, Owning details, Role & Purpose of Relationship","summary":"Update Customer Relationship","tags":[],"parameters":[{"name":"relationId","in":"path","type":"string","required":true,"description":"Identifier of the Customer Relationship and Party Relationship"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"The identifier of the underlying Entity/Company/Branch."}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"originatingRelation":[{}],"customerRelationGroupId":0.0,"customerRelationGroupName":"string","purposeOfRelationship":"string"}},"responses":{"200":"CustomerRelationshipResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/party/customers/reportingStatus","fullPath":"/api/v1.0.0/party/customers/reportingStatus","operationId":"getCustomerReportingStatus","name":"Retrieves the FATCA/CRS Reporting status and Reporting Jurisdiction of the Customer","summary":"Retrieves reporting status of the customer","tags":[],"parameters":[{"name":"customerId","in":"query","type":"string","required":true,"description":"Identifier of the customer"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from t24 on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"The identifier of the underlying Entity/Company/Branch."}],"requestBodyExample":null,"responses":{"200":"CustomerReportingStatusResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/party/customers/{customerId}/sweeps","fullPath":"/api/v1.0.0/party/customers/{customerId}/sweeps","operationId":"getCustomerSweeps","name":"Retrieves Account Sweep details such as Sweep reference, Type, Balance requirements for Sweep & Frequency of Sweep for the list of accounts available to a Customer","summary":"Retrieves Account Sweep details of the specific customer","tags":[],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"Identifier of the customer"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from t24 on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"The identifier of the underlying Entity/Company/Branch."}],"requestBodyExample":null,"responses":{"200":"CustomerSweepsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/party/customers/{customerId}/deliveryOptions","fullPath":"/api/v1.0.0/party/customers/{customerId}/deliveryOptions","operationId":"getCustomerDeliveryOptions","name":"Retrieves the Delivery Preferences of the Customer such as the Message group, carrier and address.","summary":"Retrieves Delivery Preferences of the Customer","tags":[],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"Identifier of the customer"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from t24 on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"The identifier of the underlying Entity/Company/Branch."}],"requestBodyExample":null,"responses":{"200":"CustomerDeliveryOptionsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/party/customers/{customerId}/channels","fullPath":"/api/v1.0.0/party/customers/{customerId}/channels","operationId":"getCustomerDigitalChannels","name":"Retrieves the list of message channels such as Internet Banking, Mobile Banking, ATM, etc available for the specific customer","summary":"Retrieves list of message channels","tags":[],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"Identifier of the customer"},{"name":"channelName","in":"query","type":"string","required":false,"description":"Name of the (digital) channel registered by the Customer"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from t24 on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"The identifier of the underlying Entity/Company/Branch."}],"requestBodyExample":null,"responses":{"200":"CustomerDigitalChannelsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"POST","path":"/party/customers/messages","fullPath":"/api/v1.0.0/party/customers/messages","operationId":"createMessages","name":"Create a new secure message for a Customer to be sent by bank","summary":"Create a new secure message for a Customer","tags":[],"parameters":[{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"The identifier of the underlying Entity/Company/Branch."}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"messages":[{}],"subject":"string","toCustomerId":"string"}},"responses":{"200":"MessagesResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/party/customers/{customerId}/jointCustomers","fullPath":"/api/v1.0.0/party/customers/{customerId}/jointCustomers","operationId":"getJointCustomerDetails","name":"Retrieves details such as Joint Relation code, Name, Joint Customer details and reverse relationships for a specific Customer","summary":"Retrieves Joint Customer details for a specific Customer","tags":[],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"Identifier of the customer"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from t24 on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"The identifier of the underlying Entity/Company/Branch."}],"requestBodyExample":null,"responses":{"200":"JointCustomerDetailsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/party/customers/{customerId}/KYC","fullPath":"/api/v1.0.0/party/customers/{customerId}/KYC","operationId":"getCustomerKYCDetails","name":"Retrieves the KYC details such as Contact Date, Introducer, Last and Next Review date, KYC and AML Status of a Customer","summary":"Retrieves KYC details for a specific Customer","tags":[],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"Identifier of the customer"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from t24 on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"The identifier of the underlying Entity/Company/Branch."}],"requestBodyExample":null,"responses":{"200":"CustomerKYCDetailsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/party/customers/{customerId}/personalProfiles","fullPath":"/api/v1.0.0/party/customers/{customerId}/personalProfiles","operationId":"getCustomerPersonalDetails","name":"Retrieves Personal details such as Residence, Communication details, Occupation details, Asset & Liability information","summary":"Retrieves Personal details of Customer","tags":[],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"Identifier of the customer"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from t24 on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"The identifier of the underlying Entity/Company/Branch."}],"requestBodyExample":null,"responses":{"200":"CustomerPersonalDetailsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/party/customers/postingRestrictions","fullPath":"/api/v1.0.0/party/customers/postingRestrictions","operationId":"getCustomerPostingRestrictions","name":"Retrieves the Credit and Debit Posting Restriction details such as Restriction Reference and name of restriction set for a Customer","summary":"Retrieves Posting Restriction details","tags":[],"parameters":[{"name":"customerId","in":"query","type":"string","required":false,"description":"Identifier of the customer"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from t24 on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"The identifier of the underlying Entity/Company/Branch."}],"requestBodyExample":null,"responses":{"200":"CustomerPostingRestrictionsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"POST","path":"/party/relationships/{relationId}","fullPath":"/api/v1.0.0/party/relationships/{relationId}","operationId":"createPartyRelationship","name":"Create a Party Relationship between a Person, Entity or Customer with details such as Party Name, Type, RelatedAs, Relation Code and Owning details","summary":"Create Party Relationship details","tags":[],"parameters":[{"name":"relationId","in":"path","type":"string","required":true,"description":"Identifier of the Customer Relationship and Party Relationship"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"The identifier of the underlying Entity/Company/Branch."}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"partyDisplayNames":[{}],"partyRelationships":[{}]}},"responses":{"200":"PartyRelationshipResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/party/relationships/{relationId}","fullPath":"/api/v1.0.0/party/relationships/{relationId}","operationId":"updatePartyRelationship","name":"Update Party Relationship between a Person, Entity or Customer with details such as Party Name, Type, RelatedAs, Relation Code and Owning details","summary":"Update Party Relationship details","tags":[],"parameters":[{"name":"relationId","in":"path","type":"string","required":true,"description":"Identifier of the Customer Relationship and Party Relationship"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"The identifier of the underlying Entity/Company/Branch."}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"partyDisplayNames":[{}],"partyRelationships":[{}]}},"responses":{"200":"PartyRelationshipResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/party/relationships/{partyId}","fullPath":"/api/v1.0.0/party/relationships/{partyId}","operationId":"getPartyRelationship","name":"Retrieves the relationship details such as Party Name, Type, RelatedAs, Relation Code of a customers involved in a Relationship","summary":"Retrieves list of Party relationship details","tags":[],"parameters":[{"name":"partyId","in":"path","type":"string","required":true,"description":"Allows capturing of customers or person entities to be part of the relationship. If partyType is selected as Customer, then the system will allow only customer Ids to be captured into this field. If p"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from t24 on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"The identifier of the underlying Entity/Company/Branch."}],"requestBodyExample":null,"responses":{"200":"PartyRelationshipResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/party/customers/{customerId}/cards","fullPath":"/api/v1.0.0/party/customers/{customerId}/cards","operationId":"getCustomerCreditCards","name":"Retrieves the Card details such as Card Number, Card Type and Status, linked account and its balances of a customer","summary":"Retrieves Card details of a customer","tags":[],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"Identifier of the customer"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from t24 on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"The identifier of the underlying Entity/Company/Branch."}],"requestBodyExample":null,"responses":{"200":"CustomerCreditCardsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/party/customers/{customerId}/standingOrders","fullPath":"/api/v1.0.0/party/customers/{customerId}/standingOrders","operationId":"getStandingOrders","name":"Retrieves the list of  Standing Instructions for a Customer with details such as Instruction Reference, Order Type, frequency of Payments, Mode of Payment and Credit & Debit Parties involved","summary":"Retrieves Standing Instruction details of a customer","tags":[],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"Identifier of the customer"},{"name":"standingOrderId","in":"query","type":"string","required":false,"description":"The unique standing order identifier"},{"name":"accountId","in":"query","type":"string","required":false,"description":"Identifier of the account. Often referred to as the account number, yet for consistency this is always referred to as accountId. Accepts both IBAN & BBAN"},{"name":"orderingCustomerId","in":"query","type":"string","required":false,"description":"Indicates the customer id for the ordering customer"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from t24 on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"The identifier of the underlying Entity/Company/Branch."}],"requestBodyExample":null,"responses":{"200":"StandingOrdersResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/party/customers/{customerId}/directDebits","fullPath":"/api/v1.0.0/party/customers/{customerId}/directDebits","operationId":"getDirectDebits","name":"Retrieves the list of direct debits for a Customer with details such as Direct Debit Reference, debit & credit Accounts, transaction amount, payment frequency, next payment date and direction of payment","summary":"Retrieves Direct Debits details of a Customer","tags":[],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"Identifier of the customer"},{"name":"directDebitId","in":"query","type":"string","required":false,"description":"The unique identifier of the direct debit mandate. "},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from t24 on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"The identifier of the underlying Entity/Company/Branch."}],"requestBodyExample":null,"responses":{"200":"DirectDebitsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"POST","path":"/party/customers/{deliveryPreferenceId}/customerDeliveryPreferences","fullPath":"/api/v1.0.0/party/customers/{deliveryPreferenceId}/customerDeliveryPreferences","operationId":"createDeliveryPreference","name":"Creates delivery preferences for a customer or account with Message Group, Carrier, Role, Address, Email details and Format of messages","summary":"Create Customer Delivery Preferences","tags":[],"parameters":[{"name":"deliveryPreferenceId","in":"path","type":"string","required":true,"description":""},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"The identifier of the underlying Entity/Company/Branch."}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"messageGroup":[{}],"otherMessagesDetail":[{}],"applyOtherMessages":"string"}},"responses":{"200":"DeliveryPreferenceResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/party/customers/{deliveryPreferenceId}/customerDeliveryPreferences","fullPath":"/api/v1.0.0/party/customers/{deliveryPreferenceId}/customerDeliveryPreferences","operationId":"updateDeliveryPreference","name":"Update delivery preferences for a  customer or account with Message Group, Carrier, Role, Address & Email details, Format of messages","summary":"Update Customer Deliver Preferences","tags":[],"parameters":[{"name":"deliveryPreferenceId","in":"path","type":"string","required":true,"description":""},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"The identifier of the underlying Entity/Company/Branch."}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"messageGroup":[{}],"otherMessagesDetail":[{}],"applyOtherMessages":"string"}},"responses":{"200":"DeliveryPreferenceResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/party/customers/limits/{limitId}","fullPath":"/api/v1.0.0/party/customers/limits/{limitId}","operationId":"updateLimit","name":"Updates the limit details such as currency, limit grade, commodity, country and limit product details","summary":"Update Credit Limit details for customer","tags":[],"parameters":[{"name":"limitId","in":"path","type":"string","required":true,"description":"The identifier of credit limit"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"The identifier of the underlying Entity/Company/Branch."}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"countries":[{}],"grades":[{}],"commodities":[{}],"currencyId":"string","onlineLimitDate":"2024-01-01","availableMarker":"string","allowNetting":"string","onlineUpdate":"string","limitProductId":"string","checkLimit":"string","band":"string","reducingLimit":"string","internalAmount":"string"}},"responses":{"200":"LimitResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}}]},{"key":"party-customerServices-v2.0.0","title":"Customer management","version":"v2.0.0","description":"API to create, update and manage Customer details such as delivery preferences, joint customer details, party relationships, KYC details, customer exit status, customer address formats & posting restrictions","endpointCount":32,"endpoints":[{"method":"GET","path":"/party/customers/{customerId}","fullPath":"/api/v2.0.0/party/customers/{customerId}","operationId":"getCustomer","name":"Retrieves the Customer details such as Customer Contact Infromation, Residence details, Legal document details, Occupation details and Relationship details for the Specific Customer","summary":"Retrieves list of Customer details","tags":[],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"Identifier of the customer"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"The identifier of the underlying Entity/Company/Branch."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"CustomerResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/party/customers/{customerId}","fullPath":"/api/v2.0.0/party/customers/{customerId}","operationId":"updateCustomer","name":"Update Customer details with the Information such as Customer Contact Infromation, Residence details, Legal document details, Occupation details and Relationship details, etc provided by the User","summary":"Update Customer details","tags":[],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"Identifier of the customer"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"The identifier of the underlying Entity/Company/Branch."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"displayNames":[{}],"customerNames":[{}],"communicationDevices":[{}],"faxIds":[{}],"officePhoneNumbers":[{}],"streets":[{}],"addresses":[{}],"addressCities":[{}],"countries":[{}],"legalDetails":[{}],"otherNationalityIds":[{}],"employDetails":[{}],"residenceDetails":[{}],"relationshipDetails":[{}],"postingRestrictIds":[{}]}},"responses":{"200":"CustomerResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/party/customers","fullPath":"/api/v2.0.0/party/customers","operationId":"getCustomerInformation","name":"Retrieves the Customer details such as Delivery or Postal details, Contact Infromation, Residence details, Customer Profile, Legal document details, Occupation details and Status of Customer","summary":"Retrieves list of Customer Basic details","tags":[],"parameters":[{"name":"customerId","in":"query","type":"string","required":false,"description":"Identifier of the customer"},{"name":"customerIdCT","in":"query","type":"string","required":false,"description":""},{"name":"customerIdBW","in":"query","type":"string","required":false,"description":""},{"name":"customerIdMT","in":"query","type":"string","required":false,"description":""},{"name":"customerName","in":"query","type":"string","required":false,"description":"Name of the customer"},{"name":"customerNameCT","in":"query","type":"string","required":false,"description":""},{"name":"customerNameBW","in":"query","type":"string","required":false,"description":""},{"name":"customerNameMT","in":"query","type":"string","required":false,"description":""},{"name":"street","in":"query","type":"string","required":false,"description":"Contains the first line of customer's base address, example building number, street number etc."},{"name":"streetCT","in":"query","type":"string","required":false,"description":""},{"name":"streetBW","in":"query","type":"string","required":false,"description":""},{"name":"streetMT","in":"query","type":"string","required":false,"description":""},{"name":"addressCity","in":"query","type":"string","required":false,"description":"The town and/or city component of the base address of a customer"},{"name":"addressCityCT","in":"query","type":"string","required":false,"description":""},{"name":"addressCityBW","in":"query","type":"string","required":false,"description":""},{"name":"addressCityMT","in":"query","type":"string","required":false,"description":""},{"name":"countryId","in":"query","type":"string","required":false,"description":"ISO country code of the financial institution. "},{"name":"countryIdCT","in":"query","type":"string","required":false,"description":""},{"name":"countryIdBW","in":"query","type":"string","required":false,"description":""},{"name":"countryIdMT","in":"query","type":"string","required":false,"description":""},{"name":"postCode","in":"query","type":"string","required":false,"description":"Identifies the address postal code for the customer."},{"name":"postCodeCT","in":"query","type":"string","required":false,"description":""},{"name":"postCodeBW","in":"query","type":"string","required":false,"description":""},{"name":"postCodeMT","in":"query","type":"string","required":false,"description":""},{"name":"dateOfBirth","in":"query","type":"string","required":false,"description":"The date of birth of an individual customer"},{"name":"dateOfBirthCT","in":"query","type":"string","required":false,"description":""},{"name":"dateOfBirthBW","in":"query","type":"string","required":false,"description":""},{"name":"dateOfBirthMT","in":"query","type":"string","required":false,"description":""},{"name":"customerStatus","in":"query","type":"string","required":false,"description":"The internal bank status of a customer"},{"name":"customerStatusCT","in":"query","type":"string","required":false,"description":""},{"name":"customerStatusBW","in":"query","type":"string","required":false,"description":""},{"name":"customerStatusMT","in":"query","type":"string","required":false,"description":""},{"name":"sectorId","in":"query","type":"string","required":false,"description":"An institution-defined identifier of the type of customer"},{"name":"sectorIdCT","in":"query","type":"string","required":false,"description":""},{"name":"sectorIdBW","in":"query","type":"string","required":false,"description":""},{"name":"sectorIdMT","in":"query","type":"string","required":false,"description":""},{"name":"accountOfficerId","in":"query","type":"string","required":false,"description":"The identifier of the department head or specific account officer responsible for the customer"},{"name":"accountOfficerIdBW","in":"query","type":"string","required":false,"description":""},{"name":"accountOfficerIdCT","in":"query","type":"string","required":false,"description":""},{"name":"accountOfficerIdMT","in":"query","type":"string","required":false,"description":""},{"name":"industryId","in":"query","type":"string","required":false,"description":"An institution-defined identifier of the industry in which the customer is trading, operating or is associated with"},{"name":"industryIdBW","in":"query","type":"string","required":false,"description":""},{"name":"industryIdCT","in":"query","type":"string","required":false,"description":""},{"name":"industryIdMT","in":"query","type":"string","required":false,"description":""},{"name":"nationalityId","in":"query","type":"string","required":false,"description":"The identifier of the nationality of a customer"},{"name":"nationalityIdBW","in":"query","type":"string","required":false,"description":""},{"name":"nationalityIdCT","in":"query","type":"string","required":false,"description":""},{"name":"nationalityIdMT","in":"query","type":"string","required":false,"description":""},{"name":"residenceId","in":"query","type":"string","required":false,"description":"The identifier of the country of residence of a customer"},{"name":"residenceIdMT","in":"query","type":"string","required":false,"description":""},{"name":"residenceIdCT","in":"query","type":"string","required":false,"description":""},{"name":"residenceIdBW","in":"query","type":"string","required":false,"description":""},{"name":"lastName","in":"query","type":"string","required":false,"description":"The last name of an individual customer"},{"name":"lastNameCT","in":"query","type":"string","required":false,"description":""},{"name":"lastNameBW","in":"query","type":"string","required":false,"description":""},{"name":"lastNameMT","in":"query","type":"string","required":false,"description":""},{"name":"phoneNumber","in":"query","type":"string","required":false,"description":"The phone number of the customer or prospect"},{"name":"phoneNumberCT","in":"query","type":"string","required":false,"description":""},{"name":"phoneNumberMT","in":"query","type":"string","required":false,"description":""},{"name":"phoneNumberBW","in":"query","type":"string","required":false,"description":""},{"name":"customerMnemonic","in":"query","type":"string","required":false,"description":"Specifies an alternative easy means of referencing the Customer"},{"name":"customerMnemonicCT","in":"query","type":"string","required":false,"description":""},{"name":"customerMnemonicBW","in":"query","type":"string","required":false,"description":""},{"name":"customerMnemonicMT","in":"query","type":"string","required":false,"description":""},{"name":"firstName","in":"query","type":"string","required":false,"description":"Specifies customer's first name"},{"name":"firstNameBW","in":"query","type":"string","required":false,"description":""},{"name":"firstNameMT","in":"query","type":"string","required":false,"description":""},{"name":"firstNameCT","in":"query","type":"string","required":false,"description":""},{"name":"customerType","in":"query","type":"string","required":false,"description":"Illustrates the capacity in which a client is acting.Possible Values : Customer, Broker, Depository, Client, Counterparty, External Account Manager, Active, Prospect, NULL"},{"name":"customerTypeCT","in":"query","type":"string","required":false,"description":""},{"name":"customerTypeBW","in":"query","type":"string","required":false,"description":""},{"name":"customerTypeMT","in":"query","type":"string","required":false,"description":""},{"name":"email","in":"query","type":"string","required":false,"description":"Email Identifier of the Customer"},{"name":"emailCT","in":"query","type":"string","required":false,"description":""},{"name":"emailMT","in":"query","type":"string","required":false,"description":""},{"name":"emailBW","in":"query","type":"string","required":false,"description":""},{"name":"mobilePhoneNumber","in":"query","type":"string","required":false,"description":"Represents the phone number of a customer"},{"name":"mobilePhoneNumberCT","in":"query","type":"string","required":false,"description":""},{"name":"mobilePhoneNumberBW","in":"query","type":"string","required":false,"description":""},{"name":"mobilePhoneNumberMT","in":"query","type":"string","required":false,"description":""},{"name":"taxId","in":"query","type":"string","required":false,"description":"Holds the Customer's TAX/SSN Id."},{"name":"taxIdCT","in":"query","type":"string","required":false,"description":""},{"name":"taxIdBW","in":"query","type":"string","required":false,"description":""},{"name":"taxIdMT","in":"query","type":"string","required":false,"description":""},{"name":"shortName","in":"query","type":"string","required":false,"description":"Contains the name of the account, basically the short title of the account."},{"name":"shortNameCT","in":"query","type":"string","required":false,"description":""},{"name":"shortNameBW","in":"query","type":"string","required":false,"description":""},{"name":"shortNameMT","in":"query","type":"string","required":false,"description":""},{"name":"officePhoneNumber","in":"query","type":"string","required":false,"description":"The office phone number of the customer"},{"name":"officePhoneNumberCT","in":"query","type":"string","required":false,"description":""},{"name":"officePhoneNumberBW","in":"query","type":"string","required":false,"description":""},{"name":"officePhoneNumberMT","in":"query","type":"string","required":false,"description":""},{"name":"faxId","in":"query","type":"string","required":false,"description":"The fax (facsimile) number of the customer"},{"name":"faxIdBW","in":"query","type":"string","required":false,"description":""},{"name":"faxIdCT","in":"query","type":"string","required":false,"description":""},{"name":"faxIdMT","in":"query","type":"string","required":false,"description":""},{"name":"address","in":"query","type":"string","required":false,"description":"Communication Address of the Customer"},{"name":"addressCT","in":"query","type":"string","required":false,"description":""},{"name":"addressBW","in":"query","type":"string","required":false,"description":""},{"name":"addressMT","in":"query","type":"string","required":false,"description":""},{"name":"relCustomer","in":"query","type":"string","required":false,"description":"Customers linked or related to the arrangement owner"},{"name":"relCustomerBW","in":"query","type":"string","required":false,"description":""},{"name":"relCustomerCT","in":"query","type":"string","required":false,"description":""},{"name":"relCustomerMT","in":"query","type":"string","required":false,"description":""},{"name":"relationshipCode","in":"query","type":"string","required":false,"description":"Relationship identifier between the partyType and relatedPartyType"},{"name":"relationshipCodeBW","in":"query","type":"string","required":false,"description":""},{"name":"relationshipCodeMT","in":"query","type":"string","required":false,"description":""},{"name":"relationshipCodeCT","in":"query","type":"string","required":false,"description":""},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from t24 on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"The identifier of the underlying Entity/Company/Branch."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"CustomerInformationResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"POST","path":"/party/customers","fullPath":"/api/v2.0.0/party/customers","operationId":"createCustomer","name":"Create a Customer with the Information such as Customer Contact Infromation, Residence details, Legal document details, Occupation details and Relationship details, etc provided by the User","summary":"Create a Customer","tags":[],"parameters":[{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"The identifier of the underlying Entity/Company/Branch."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"displayNames":[{}],"customerNames":[{}],"communicationDevices":[{}],"faxIds":[{}],"officePhoneNumbers":[{}],"streets":[{}],"addresses":[{}],"addressCities":[{}],"countries":[{}],"legalDetails":[{}],"otherNationalityIds":[{}],"employDetails":[{}],"residenceDetails":[{}],"relationshipDetails":[{}],"postingRestrictIds":[{}]}},"responses":{"200":"CustomerResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/party/customers/relationships","fullPath":"/api/v2.0.0/party/customers/relationships","operationId":"getCustomerRelationship","name":"Retrieves customer relationship details such as Type of Relationship, Party Information, RelatedAs details, Owning details, Role & Purpose of Relationship for specific party or Customer","summary":"Retrieves list of Customer Relationships","tags":[],"parameters":[{"name":"customerRelationGroupId","in":"query","type":"string","required":false,"description":"Identifies the key to Customer Relationship Group to form a relation"},{"name":"partyId","in":"query","type":"string","required":false,"description":"Allows capturing of customers or person entities to be part of the relationship. If partyType is selected as Customer, then the system will allow only customer Ids to be captured into this field. If p"},{"name":"relatedPartyId","in":"query","type":"string","required":false,"description":"Identifier of the Related Party"},{"name":"relationId","in":"query","type":"string","required":false,"description":"Identifier of the Customer Relationship and Party Relationship"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from t24 on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"The identifier of the underlying Entity/Company/Branch."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"CustomerRelationshipResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"POST","path":"/party/customers/relationships","fullPath":"/api/v2.0.0/party/customers/relationships","operationId":"createCustomerRelationship","name":"Create a Customer Relationship for a Customer with details such as Type of Relationship, Party Information, RelatedAs details, Owning details, Role & Purpose of Relationship","summary":"Create Customer Relationship with other customers","tags":[],"parameters":[{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"The identifier of the underlying Entity/Company/Branch."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"originatingRelation":[{}],"customerRelationGroupId":0.0,"customerRelationGroupName":"string","purposeOfRelationship":"string"}},"responses":{"200":"CustomerRelationshipResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/party/customers/relationships/{relationId}","fullPath":"/api/v2.0.0/party/customers/relationships/{relationId}","operationId":"updateCustomerRelationship","name":"Update Customer Relationship for a Customer with details such as Type of Relationship, Party Information, Related details, Owning details, Role & Purpose of Relationship","summary":"Update Customer Relationship","tags":[],"parameters":[{"name":"relationId","in":"path","type":"string","required":true,"description":"Identifier of the Customer Relationship and Party Relationship"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"The identifier of the underlying Entity/Company/Branch."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"originatingRelation":[{}],"customerRelationGroupId":0.0,"customerRelationGroupName":"string","purposeOfRelationship":"string"}},"responses":{"200":"CustomerRelationshipResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/party/customers/reportingStatus","fullPath":"/api/v2.0.0/party/customers/reportingStatus","operationId":"getCustomerReportingStatus","name":"Retrieves the FATCA/CRS Reporting status and Reporting Jurisdiction of the Customer","summary":"Retrieves reporting status of the customer","tags":[],"parameters":[{"name":"customerId","in":"query","type":"string","required":true,"description":"Identifier of the customer"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from t24 on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"The identifier of the underlying Entity/Company/Branch."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"CustomerReportingStatusResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/party/customers/{customerId}/sweeps","fullPath":"/api/v2.0.0/party/customers/{customerId}/sweeps","operationId":"getCustomerSweeps","name":"Retrieves Account Sweep details such as Sweep reference, Type, Balance requirements for Sweep & Frequency of Sweep for the list of accounts available to a Customer","summary":"Retrieves Account Sweep details of the specific customer","tags":[],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"Identifier of the customer"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from t24 on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"The identifier of the underlying Entity/Company/Branch."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"CustomerSweepsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/party/customers/{customerId}/deliveryOptions","fullPath":"/api/v2.0.0/party/customers/{customerId}/deliveryOptions","operationId":"getCustomerDeliveryOptions","name":"Retrieves the Delivery Preferences of the Customer such as the Message group, carrier and address.","summary":"Retrieves Delivery Preferences of the Customer","tags":[],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"Identifier of the customer"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from t24 on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"The identifier of the underlying Entity/Company/Branch."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"CustomerDeliveryOptionsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/party/customers/{customerId}/channels","fullPath":"/api/v2.0.0/party/customers/{customerId}/channels","operationId":"getCustomerDigitalChannels","name":"Retrieves the list of message channels such as Internet Banking, Mobile Banking, ATM, etc available for the specific customer","summary":"Retrieves list of message channels","tags":[],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"Identifier of the customer"},{"name":"channelName","in":"query","type":"string","required":false,"description":"Name of the (digital) channel registered by the Customer"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from t24 on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"The identifier of the underlying Entity/Company/Branch."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"CustomerDigitalChannelsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"POST","path":"/party/customers/messages","fullPath":"/api/v2.0.0/party/customers/messages","operationId":"createMessages","name":"Create a new secure message for a Customer to be sent by bank","summary":"Create a new secure message for a Customer","tags":[],"parameters":[{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"The identifier of the underlying Entity/Company/Branch."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"messages":[{}],"subject":"string","toCustomerId":"string"}},"responses":{"200":"MessagesResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/party/customers/{customerId}/jointCustomers","fullPath":"/api/v2.0.0/party/customers/{customerId}/jointCustomers","operationId":"getJointCustomerDetails","name":"Retrieves details such as Joint Relation code, Name, Joint Customer details and reverse relationships for a specific Customer","summary":"Retrieves Joint Customer details for a specific Customer","tags":[],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"Identifier of the customer"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from t24 on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"The identifier of the underlying Entity/Company/Branch."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"JointCustomerDetailsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/party/customers/{customerId}/KYC","fullPath":"/api/v2.0.0/party/customers/{customerId}/KYC","operationId":"getCustomerKYCDetails","name":"Retrieves the KYC details such as Contact Date, Introducer, Last and Next Review date, KYC and AML Status of a Customer","summary":"Retrieves KYC details for a specific Customer","tags":[],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"Identifier of the customer"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from t24 on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"The identifier of the underlying Entity/Company/Branch."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"CustomerKYCDetailsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/party/customers/{customerId}/personalProfiles","fullPath":"/api/v2.0.0/party/customers/{customerId}/personalProfiles","operationId":"getCustomerPersonalDetails","name":"Retrieves Personal details such as Residence, Communication details, Occupation details, Asset & Liability information","summary":"Retrieves Personal details of Customer","tags":[],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"Identifier of the customer"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from t24 on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"The identifier of the underlying Entity/Company/Branch."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"CustomerPersonalDetailsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/party/customers/postingRestrictions","fullPath":"/api/v2.0.0/party/customers/postingRestrictions","operationId":"getCustomerPostingRestrictions","name":"Retrieves the Credit and Debit Posting Restriction details such as Restriction Reference and name of restriction set for a Customer","summary":"Retrieves Posting Restriction details","tags":[],"parameters":[{"name":"customerId","in":"query","type":"string","required":false,"description":"Identifier of the customer"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from t24 on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"The identifier of the underlying Entity/Company/Branch."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"CustomerPostingRestrictionsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"POST","path":"/party/relationships/{relationId}","fullPath":"/api/v2.0.0/party/relationships/{relationId}","operationId":"createPartyRelationship","name":"Create a Party Relationship between a Person, Entity or Customer with details such as Party Name, Type, RelatedAs, Relation Code and Owning details","summary":"Create Party Relationship details","tags":[],"parameters":[{"name":"relationId","in":"path","type":"string","required":true,"description":"Identifier of the Customer Relationship and Party Relationship"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"The identifier of the underlying Entity/Company/Branch."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"partyDisplayNames":[{}],"partyRelationships":[{}]}},"responses":{"200":"PartyRelationshipResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/party/relationships/{relationId}","fullPath":"/api/v2.0.0/party/relationships/{relationId}","operationId":"updatePartyRelationship","name":"Update Party Relationship between a Person, Entity or Customer with details such as Party Name, Type, RelatedAs, Relation Code and Owning details","summary":"Update Party Relationship details","tags":[],"parameters":[{"name":"relationId","in":"path","type":"string","required":true,"description":"Identifier of the Customer Relationship and Party Relationship"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"The identifier of the underlying Entity/Company/Branch."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"partyDisplayNames":[{}],"partyRelationships":[{}]}},"responses":{"200":"PartyRelationshipResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/party/relationships/{partyId}","fullPath":"/api/v2.0.0/party/relationships/{partyId}","operationId":"getPartyRelationship","name":"Retrieves the relationship details such as Party Name, Type, RelatedAs, Relation Code of a customers involved in a Relationship","summary":"Retrieves list of Party relationship details","tags":[],"parameters":[{"name":"partyId","in":"path","type":"string","required":true,"description":"Allows capturing of customers or person entities to be part of the relationship. If partyType is selected as Customer, then the system will allow only customer Ids to be captured into this field. If p"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from t24 on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"The identifier of the underlying Entity/Company/Branch."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"PartyRelationshipResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/party/customers/{customerId}/cards","fullPath":"/api/v2.0.0/party/customers/{customerId}/cards","operationId":"getCustomerCreditCards","name":"Retrieves the Card details such as Card Number, Card Type and Status, linked account and its balances of a customer","summary":"Retrieves Card details of a customer","tags":[],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"Identifier of the customer"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from t24 on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"The identifier of the underlying Entity/Company/Branch."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"CustomerCreditCardsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/party/customers/{customerId}/standingOrders","fullPath":"/api/v2.0.0/party/customers/{customerId}/standingOrders","operationId":"getStandingOrders","name":"Retrieves the list of  Standing Instructions for a Customer with details such as Instruction Reference, Order Type, frequency of Payments, Mode of Payment and Credit & Debit Parties involved","summary":"Retrieves Standing Instruction details of a customer","tags":[],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"Identifier of the customer"},{"name":"standingOrderId","in":"query","type":"string","required":false,"description":"The unique standing order identifier"},{"name":"accountId","in":"query","type":"string","required":false,"description":"Identifier of the account. Often referred to as the account number, yet for consistency this is always referred to as accountId. Accepts both IBAN & BBAN"},{"name":"orderingCustomerId","in":"query","type":"string","required":false,"description":"Indicates the customer id for the ordering customer"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from t24 on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"The identifier of the underlying Entity/Company/Branch."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"StandingOrdersResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/party/customers/{customerId}/directDebits","fullPath":"/api/v2.0.0/party/customers/{customerId}/directDebits","operationId":"getDirectDebits","name":"Retrieves the list of direct debits for a Customer with details such as Direct Debit Reference, debit & credit Accounts, transaction amount, payment frequency, next payment date and direction of payment","summary":"Retrieves Direct Debits details of a Customer","tags":[],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"Identifier of the customer"},{"name":"directDebitId","in":"query","type":"string","required":false,"description":"The unique identifier of the direct debit mandate. "},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from t24 on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"The identifier of the underlying Entity/Company/Branch."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"DirectDebitsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"POST","path":"/party/customers/{deliveryPreferenceId}/customerDeliveryPreferences","fullPath":"/api/v2.0.0/party/customers/{deliveryPreferenceId}/customerDeliveryPreferences","operationId":"createDeliveryPreference","name":"Creates delivery preferences for a customer or account with Message Group, Carrier, Role, Address, Email details and Format of messages","summary":"Create Customer Delivery Preferences","tags":[],"parameters":[{"name":"deliveryPreferenceId","in":"path","type":"string","required":true,"description":""},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"The identifier of the underlying Entity/Company/Branch."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"messageGroup":[{}],"otherMessagesDetail":[{}],"applyOtherMessages":"string"}},"responses":{"200":"DeliveryPreferenceResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/party/customers/{deliveryPreferenceId}/customerDeliveryPreferences","fullPath":"/api/v2.0.0/party/customers/{deliveryPreferenceId}/customerDeliveryPreferences","operationId":"updateDeliveryPreference","name":"Update delivery preferences for a  customer or account with Message Group, Carrier, Role, Address & Email details, Format of messages","summary":"Update Customer Deliver Preferences","tags":[],"parameters":[{"name":"deliveryPreferenceId","in":"path","type":"string","required":true,"description":""},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"The identifier of the underlying Entity/Company/Branch."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"messageGroup":[{}],"otherMessagesDetail":[{}],"applyOtherMessages":"string"}},"responses":{"200":"DeliveryPreferenceResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/party/customers/limits/{limitId}","fullPath":"/api/v2.0.0/party/customers/limits/{limitId}","operationId":"updateLimit","name":"Updates the limit details such as currency, limit grade, commodity, country and limit product details","summary":"Update Credit Limit details for customer","tags":[],"parameters":[{"name":"limitId","in":"path","type":"string","required":true,"description":"The identifier of credit limit"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"The identifier of the underlying Entity/Company/Branch."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"countries":[{}],"grades":[{}],"commodities":[{}],"currencyId":"string","onlineLimitDate":"2024-01-01","availableMarker":"string","allowNetting":"string","onlineUpdate":"string","limitProductId":"string","checkLimit":"string","band":"string","reducingLimit":"string","internalAmount":"string"}},"responses":{"200":"LimitResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/party/customers/customerExitStatus/{customerId}","fullPath":"/api/v2.0.0/party/customers/customerExitStatus/{customerId}","operationId":"getCustomerExitStatus","name":"Retrieves customer exit status details such as customer type, exit date, status and reason","summary":"Retrieves customer exit status details of Customer","tags":[],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"Identifier of the customer"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from t24 on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"The identifier of the underlying Entity/Company/Branch."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"CustomerExitStatusResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"PUT","path":"/party/customers/{customerId}/customerExitStatus","fullPath":"/api/v2.0.0/party/customers/{customerId}/customerExitStatus","operationId":"updateCustomerExitStatus","name":"Update a customer record with exit status and exit reason marking the customer as blocked or rejected or closed","summary":"Update customer exit status details of Customers","tags":[],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"Identifier of the customer"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"The identifier of the underlying Entity/Company/Branch."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"exitStatus":"string","exitReason":"string"}},"responses":{"200":"CustomerExitStatusResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/party/customers/settings/customerExitStatus","fullPath":"/api/v2.0.0/party/customers/settings/customerExitStatus","operationId":"getCustomerExitStatusParam","name":"Retrieves available conditions such as customer exit setup reference, allowed reasons and allowed re-open details to update customer exit status of Customers","summary":"Retrieves conditions to update customer exit status of Customer","tags":[],"parameters":[{"name":"customerType","in":"query","type":"string","required":false,"description":"Illustrates the capacity in which a client is acting.Possible Values : Customer, Broker, Depository, Client, Counterparty, External Account Manager, Active, Prospect, NULL"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from t24 on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"The identifier of the underlying Entity/Company/Branch."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"CustomerExitStatusParamResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"POST","path":"/party/customers/settings/{customerExitStatusId}/customerExitStatus","fullPath":"/api/v2.0.0/party/customers/settings/{customerExitStatusId}/customerExitStatus","operationId":"createCustomerExitStatusParam","name":"Create conditions such as applicable customer type and allowed reasons to update the customer exit status details of Customers","summary":"Create conditions to update customer exit status of Customer","tags":[],"parameters":[{"name":"customerExitStatusId","in":"path","type":"string","required":true,"description":"The field reflects the exit status ID of a customer or prospect from the parameterization table CUSTOMER.EXIT.STATUS"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"The identifier of the underlying Entity/Company/Branch."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"allowedExitReasons":[{}],"exitStatusDescription":"string","customerType":"string","allowRemoveExitStatus":"string"}},"responses":{"200":"CustomerExitStatusParamResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/party/customers/settings/{customerExitStatusId}/customerExitStatus","fullPath":"/api/v2.0.0/party/customers/settings/{customerExitStatusId}/customerExitStatus","operationId":"updateCustomerExitStatusParam","name":"Create conditions such as applicable customer type and allowed reasons to update the customer exit status details of Customers","summary":"Create conditions to update customer exit status of Customer","tags":[],"parameters":[{"name":"customerExitStatusId","in":"path","type":"string","required":true,"description":"The field reflects the exit status ID of a customer or prospect from the parameterization table CUSTOMER.EXIT.STATUS"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"The identifier of the underlying Entity/Company/Branch."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"allowedExitReasons":[{}],"exitStatusDescription":"string","customerType":"string","allowRemoveExitStatus":"string"}},"responses":{"200":"CustomerExitStatusParamResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/party/customers/{customerId}/addressOutput","fullPath":"/api/v2.0.0/party/customers/{customerId}/addressOutput","operationId":"getCustomerAddressOutput","name":"Returns structured/unstructured address details of specified customer based on address option in request. When structured format is requested, the values are returned in format of structured data name combined with corresponding customer address value. When unstructured format is requested, the address details are returned based on configured unstructured address format.","summary":"Retrieves structured/ unstructured address format of Customer","tags":[],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"Identifier of the customer"},{"name":"addressOption","in":"query","type":"string","required":false,"description":"It reflects the preference for the customer address format, respective structured, unstructured or both"},{"name":"addressOutputFormat","in":"query","type":"string","required":false,"description":"It identifies the address output format for the unstructured address"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from t24 on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"The identifier of the underlying Entity/Company/Branch."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"CustomerAddressOutputResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/party/customers/{customerId}/shortNames","fullPath":"/api/v2.0.0/party/customers/{customerId}/shortNames","operationId":"getCustomerShortNames","name":"API to get the customer short name that can be used as customer enrichment by any application","summary":"Retrieves customer short name","tags":[],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"Identifier of the customer"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"The identifier of the underlying Entity/Company/Branch."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"CustomerShortNamesResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}}]},{"key":"party-customerServices-v3.0.0","title":"Customer management","version":"v3.0.0","description":"API to create, update and manage Customer details such as delivery preferences, joint customer details, party relationships, KYC details, customer exit status, customer address formats & posting restrictions","endpointCount":56,"endpoints":[{"method":"GET","path":"/party/customers/{customerId}","fullPath":"/api/v3.0.0/party/customers/{customerId}","operationId":"getCustomer","name":"Retrieves the Customer details such as Customer Contact Infromation, Residence details, Legal document details, Occupation details and Relationship details for the Specific Customer","summary":"Retrieves list of Customer details","tags":[],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"Identifier of the customer"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"CustomerResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/party/customers/{customerId}","fullPath":"/api/v3.0.0/party/customers/{customerId}","operationId":"updateCustomer","name":"Update Customer details with the Information such as Customer Contact Infromation, Residence details, Legal document details, Occupation details and Relationship details, etc provided by the User","summary":"Update Customer details","tags":[],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"Identifier of the customer"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"displayNames":[{}],"customerNames":[{}],"communicationDevices":[{}],"faxIds":[{}],"officePhoneNumbers":[{}],"streets":[{}],"addresses":[{}],"addressCities":[{}],"countries":[{}],"legalDetails":[{}],"otherNationalityIds":[{}],"employDetails":[{}],"residenceDetails":[{}],"relationshipDetails":[{}],"postingRestrictIds":[{}]}},"responses":{"200":"CustomerResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/party/customers","fullPath":"/api/v3.0.0/party/customers","operationId":"getCustomerInformation","name":"Retrieves the Customer details such as Delivery or Postal details, Contact Infromation, Residence details, Customer Profile, Legal document details, Occupation details and Status of Customer","summary":"Retrieves list of Customer Basic details","tags":[],"parameters":[{"name":"customerId","in":"query","type":"string","required":false,"description":"Identifier of the customer"},{"name":"customerIdCT","in":"query","type":"string","required":false,"description":"Indicates the criteria for the contains operation on the customer Id"},{"name":"customerIdBW","in":"query","type":"string","required":false,"description":"Indicates the criteria for the between operation on the customer Id"},{"name":"customerIdMT","in":"query","type":"string","required":false,"description":"Indicates the criteria for the matches operation on the customer Id"},{"name":"customerName","in":"query","type":"string","required":false,"description":"Name of the customer"},{"name":"customerNameCT","in":"query","type":"string","required":false,"description":"Indicates the criteria for the contains operation on the customer name"},{"name":"customerNameBW","in":"query","type":"string","required":false,"description":"Indicates the criteria for the between operation on the customer name"},{"name":"customerNameMT","in":"query","type":"string","required":false,"description":"Indicates the criteria for the matches operation on the customer name"},{"name":"street","in":"query","type":"string","required":false,"description":"Contains the first line of customer's base address, example building number, street number etc."},{"name":"streetCT","in":"query","type":"string","required":false,"description":"Indicates the criteria for the contains operation on the street"},{"name":"streetBW","in":"query","type":"string","required":false,"description":"Indicates the criteria for the between operation on the street"},{"name":"streetMT","in":"query","type":"string","required":false,"description":"Indicates the criteria for the matches operation on the street"},{"name":"addressCity","in":"query","type":"string","required":false,"description":"The town and/or city component of the base address of a customer"},{"name":"addressCityCT","in":"query","type":"string","required":false,"description":"Indicates the criteria for the contains operation on the town country"},{"name":"addressCityBW","in":"query","type":"string","required":false,"description":"Indicates the criteria for the between operation on the town country"},{"name":"addressCityMT","in":"query","type":"string","required":false,"description":"Indicates the criteria for the matches operation on the town country"},{"name":"countryId","in":"query","type":"string","required":false,"description":"ISO country code of the financial institution. "},{"name":"countryIdCT","in":"query","type":"string","required":false,"description":"Indicates the criteria for the contains operation on the country"},{"name":"countryIdBW","in":"query","type":"string","required":false,"description":"Indicates the criteria for the between operation on the country"},{"name":"countryIdMT","in":"query","type":"string","required":false,"description":"Indicates the criteria for the matches operation on the country"},{"name":"postCode","in":"query","type":"string","required":false,"description":"Identifies the address postal code for the customer."},{"name":"postCodeCT","in":"query","type":"string","required":false,"description":"Indicates the criteria for the contains operation on the post code"},{"name":"postCodeBW","in":"query","type":"string","required":false,"description":"Indicates the criteria for the between operation on the post code"},{"name":"postCodeMT","in":"query","type":"string","required":false,"description":"Indicates the criteria for the matches operation on the post code"},{"name":"dateOfBirth","in":"query","type":"string","required":false,"description":"The date of birth of an individual customer"},{"name":"dateOfBirthCT","in":"query","type":"string","required":false,"description":"Indicates the criteria for the contains operation on the date of birth"},{"name":"dateOfBirthBW","in":"query","type":"string","required":false,"description":"Indicates the criteria for the between operation on the date of birth"},{"name":"dateOfBirthMT","in":"query","type":"string","required":false,"description":"Indicates the criteria for the matches operation on the date of birth"},{"name":"customerStatus","in":"query","type":"string","required":false,"description":"The internal bank status of a customer"},{"name":"customerStatusCT","in":"query","type":"string","required":false,"description":"Indicates the criteria for the contains operation on the customer status"},{"name":"customerStatusBW","in":"query","type":"string","required":false,"description":"Indicates the criteria for the between operation on the customer status"},{"name":"customerStatusMT","in":"query","type":"string","required":false,"description":"Indicates the criteria for the matches operation on the customer status"},{"name":"sectorId","in":"query","type":"string","required":false,"description":"An institution-defined identifier of the type of customer"},{"name":"sectorIdCT","in":"query","type":"string","required":false,"description":"Indicates the criteria for the contains operation on the sector"},{"name":"sectorIdBW","in":"query","type":"string","required":false,"description":"Indicates the criteria for the between operation on the sector"},{"name":"sectorIdMT","in":"query","type":"string","required":false,"description":"Indicates the criteria for the matches operation on the sector"},{"name":"accountOfficerId","in":"query","type":"string","required":false,"description":"The identifier of the department head or specific account officer responsible for the customer"},{"name":"accountOfficerIdBW","in":"query","type":"string","required":false,"description":"Indicates the criteria for the between operation on the account officer"},{"name":"accountOfficerIdCT","in":"query","type":"string","required":false,"description":"Indicates the criteria for the contains operation on the account officer"},{"name":"accountOfficerIdMT","in":"query","type":"string","required":false,"description":"Indicates the criteria for the matches operation on the account officer"},{"name":"industryId","in":"query","type":"string","required":false,"description":"An institution-defined identifier of the industry in which the customer is trading, operating or is associated with"},{"name":"industryIdBW","in":"query","type":"string","required":false,"description":"Indicates the criteria for the between operation on the industry"},{"name":"industryIdCT","in":"query","type":"string","required":false,"description":"Indicates the criteria for the contains operation on the industry"},{"name":"industryIdMT","in":"query","type":"string","required":false,"description":"Indicates the criteria for the matches operation on the industry"},{"name":"nationalityId","in":"query","type":"string","required":false,"description":"The identifier of the nationality of a customer"},{"name":"nationalityIdBW","in":"query","type":"string","required":false,"description":"Indicates the criteria for the between operation on the nationality"},{"name":"nationalityIdCT","in":"query","type":"string","required":false,"description":"Indicates the criteria for the contains operation on the nationality"},{"name":"nationalityIdMT","in":"query","type":"string","required":false,"description":"Indicates the criteria for the matches operation on the nationality"},{"name":"residenceId","in":"query","type":"string","required":false,"description":"The identifier of the country of residence of a customer"},{"name":"residenceIdMT","in":"query","type":"string","required":false,"description":"Indicates the criteria for the matches operation on the residence"},{"name":"residenceIdCT","in":"query","type":"string","required":false,"description":"Indicates the criteria for the contains operation on the residence"},{"name":"residenceIdBW","in":"query","type":"string","required":false,"description":"Indicates the criteria for the between operation on the residence"},{"name":"lastName","in":"query","type":"string","required":false,"description":"The last name of an individual customer"},{"name":"lastNameCT","in":"query","type":"string","required":false,"description":"Indicates the criteria for the contains operation on the family name"},{"name":"lastNameBW","in":"query","type":"string","required":false,"description":"Indicates the criteria for the between operation on the family name"},{"name":"lastNameMT","in":"query","type":"string","required":false,"description":"Indicates the criteria for the matches operation on the family name"},{"name":"phoneNumber","in":"query","type":"string","required":false,"description":"The phone number of the customer or prospect"},{"name":"phoneNumberCT","in":"query","type":"string","required":false,"description":"Indicates the criteria for the contains operation on the phone number"},{"name":"phoneNumberMT","in":"query","type":"string","required":false,"description":"Indicates the criteria for the matches operation on the phone number"},{"name":"phoneNumberBW","in":"query","type":"string","required":false,"description":"Indicates the criteria for the between operation on the phone number"},{"name":"customerMnemonic","in":"query","type":"string","required":false,"description":"Specifies an alternative easy means of referencing the Customer"},{"name":"customerMnemonicCT","in":"query","type":"string","required":false,"description":"Indicates the criteria for the contains operation on the customer mnemonic"},{"name":"customerMnemonicBW","in":"query","type":"string","required":false,"description":"Indicates the criteria for the between operation on the customer mnemonic"},{"name":"customerMnemonicMT","in":"query","type":"string","required":false,"description":"Indicates the criteria for the matches operation on the customer mnemonic"},{"name":"firstName","in":"query","type":"string","required":false,"description":"Specifies customer's first name"},{"name":"firstNameBW","in":"query","type":"string","required":false,"description":"Indicates the criteria for the between operation on the first name"},{"name":"firstNameMT","in":"query","type":"string","required":false,"description":"Indicates the criteria for the matches operation on the first name"},{"name":"firstNameCT","in":"query","type":"string","required":false,"description":"Indicates the criteria for the contains operation on the first name"},{"name":"customerType","in":"query","type":"string","required":false,"description":"Contains the type of customer, for example ACTIVE, PROSPECT."},{"name":"customerTypeCT","in":"query","type":"string","required":false,"description":"Indicates the criteria for the contains operation on the customer type"},{"name":"customerTypeBW","in":"query","type":"string","required":false,"description":"Indicates the criteria for the between operation on the customer type"},{"name":"customerTypeMT","in":"query","type":"string","required":false,"description":"Indicates the criteria for the matches operation on the customer type"},{"name":"email","in":"query","type":"string","required":false,"description":"Email Identifier of the Customer"},{"name":"emailCT","in":"query","type":"string","required":false,"description":"Indicates the criteria for the contains operation on the emails"},{"name":"emailMT","in":"query","type":"string","required":false,"description":"Indicates the criteria for the matches operation on the emails"},{"name":"emailBW","in":"query","type":"string","required":false,"description":"Indicates the criteria for the between operation on the emails"},{"name":"mobilePhoneNumber","in":"query","type":"string","required":false,"description":"Represents the phone number of a customer"},{"name":"mobilePhoneNumberCT","in":"query","type":"string","required":false,"description":"Indicates the criteria for the contains operation on the mobile numbers"},{"name":"mobilePhoneNumberBW","in":"query","type":"string","required":false,"description":"Indicates the criteria for the between operation on the mobile numbers"},{"name":"mobilePhoneNumberMT","in":"query","type":"string","required":false,"description":"Indicates the criteria for the matches operation on the mobile numbers"},{"name":"taxId","in":"query","type":"string","required":false,"description":"Holds the Customer's TAX/SSN Id."},{"name":"taxIdCT","in":"query","type":"string","required":false,"description":"Indicates the criteria for the contains operation on the tax Id"},{"name":"taxIdBW","in":"query","type":"string","required":false,"description":"Indicates the criteria for the between operation on the tax Id"},{"name":"taxIdMT","in":"query","type":"string","required":false,"description":"Indicates the criteria for the matches operation on the tax Id"},{"name":"shortName","in":"query","type":"string","required":false,"description":"Contains the name of the account, basically the short title of the account."},{"name":"shortNameCT","in":"query","type":"string","required":false,"description":"Indicates the criteria for the contains operation on the short name"},{"name":"shortNameBW","in":"query","type":"string","required":false,"description":"Indicates the criteria for the between operation on the short name"},{"name":"shortNameMT","in":"query","type":"string","required":false,"description":"Indicates the criteria for the matches operation on the short name"},{"name":"officePhoneNumber","in":"query","type":"string","required":false,"description":"The office phone number of the customer"},{"name":"officePhoneNumberCT","in":"query","type":"string","required":false,"description":"Indicates the criteria for the contains operation on the office phone numbers"},{"name":"officePhoneNumberBW","in":"query","type":"string","required":false,"description":"Indicates the criteria for the between operation on the office phone numbers"},{"name":"officePhoneNumberMT","in":"query","type":"string","required":false,"description":"Indicates the criteria for the matches operation on the office phone numbers"},{"name":"faxId","in":"query","type":"string","required":false,"description":"The fax (facsimile) number of the customer"},{"name":"faxIdBW","in":"query","type":"string","required":false,"description":"Indicates the criteria for the between operation on the fax Id"},{"name":"faxIdCT","in":"query","type":"string","required":false,"description":"Indicates the criteria for the contains operation on the fax Id"},{"name":"faxIdMT","in":"query","type":"string","required":false,"description":"Indicates the criteria for the matches operation on the fax Id"},{"name":"address","in":"query","type":"string","required":false,"description":"Communication Address of the Customer"},{"name":"addressCT","in":"query","type":"string","required":false,"description":"Indicates the criteria for the contains operation on the address"},{"name":"addressBW","in":"query","type":"string","required":false,"description":"Indicates the criteria for the between operation on the address"},{"name":"addressMT","in":"query","type":"string","required":false,"description":"Indicates the criteria for the matches operation on the address"},{"name":"relCustomer","in":"query","type":"string","required":false,"description":"Customers linked or related to the arrangement owner"},{"name":"relCustomerBW","in":"query","type":"string","required":false,"description":"Indicates the criteria for the between operation on the related customer Id"},{"name":"relCustomerCT","in":"query","type":"string","required":false,"description":"Indicates the criteria for the contains operation on the related customer Id"},{"name":"relCustomerMT","in":"query","type":"string","required":false,"description":"Indicates the criteria for the matches operation on the related customer Id"},{"name":"relationshipCode","in":"query","type":"string","required":false,"description":"Relationship identifier between the partyType and relatedPartyType"},{"name":"relationshipCodeBW","in":"query","type":"string","required":false,"description":"Indicates the criteria for the between operation on the relationship code"},{"name":"relationshipCodeMT","in":"query","type":"string","required":false,"description":"Indicates the criteria for the matches operation on the relationship code"},{"name":"relationshipCodeCT","in":"query","type":"string","required":false,"description":"Indicates the criteria for the contains operation on the relationship code"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from t24 on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"CustomerInformationResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"POST","path":"/party/customers","fullPath":"/api/v3.0.0/party/customers","operationId":"createCustomer","name":"Create a Customer with the Information such as Customer Contact Infromation, Residence details, Legal document details, Occupation details and Relationship details, etc provided by the User","summary":"Create a Customer","tags":[],"parameters":[{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"displayNames":[{}],"customerNames":[{}],"communicationDevices":[{}],"faxIds":[{}],"officePhoneNumbers":[{}],"streets":[{}],"addresses":[{}],"addressCities":[{}],"countries":[{}],"legalDetails":[{}],"otherNationalityIds":[{}],"employDetails":[{}],"residenceDetails":[{}],"relationshipDetails":[{}],"postingRestrictIds":[{}]}},"responses":{"200":"CustomerResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/party/customers/relationships","fullPath":"/api/v3.0.0/party/customers/relationships","operationId":"getCustomerRelationship","name":"Retrieves customer relationship details such as Type of Relationship, Party Information, RelatedAs details, Owning details, Role & Purpose of Relationship for specific party or Customer","summary":"Retrieves list of Customer Relationships","tags":[],"parameters":[{"name":"customerRelationGroupId","in":"query","type":"string","required":false,"description":"Identifies the key to Customer Relationship Group to form a relation"},{"name":"partyId","in":"query","type":"string","required":false,"description":"Allows capturing of customers or person entities to be part of the relationship. If partyType is selected as Customer, then the system will allow only customer Ids to be captured into this field. If p"},{"name":"relatedPartyId","in":"query","type":"string","required":false,"description":"Identifier of the Related Party"},{"name":"relationId","in":"query","type":"string","required":false,"description":"Identifier of the Customer Relationship and Party Relationship"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from t24 on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"CustomerRelationshipResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"POST","path":"/party/customers/relationships","fullPath":"/api/v3.0.0/party/customers/relationships","operationId":"createCustomerRelationship","name":"Create a Customer Relationship for a Customer with details such as Type of Relationship, Party Information, RelatedAs details, Owning details, Role & Purpose of Relationship","summary":"Create Customer Relationship with other customers","tags":[],"parameters":[{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"originatingRelation":[{}],"customerRelationGroupId":0.0,"customerRelationGroupName":"string","purposeOfRelationship":"string"}},"responses":{"200":"CustomerRelationshipResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/party/customers/relationships/{relationId}","fullPath":"/api/v3.0.0/party/customers/relationships/{relationId}","operationId":"updateCustomerRelationship","name":"Update Customer Relationship for a Customer with details such as Type of Relationship, Party Information, Related details, Owning details, Role & Purpose of Relationship","summary":"Update Customer Relationship","tags":[],"parameters":[{"name":"relationId","in":"path","type":"string","required":true,"description":"Identifier of the Customer Relationship and Party Relationship"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"originatingRelation":[{}],"customerRelationGroupId":0.0,"customerRelationGroupName":"string","purposeOfRelationship":"string"}},"responses":{"200":"CustomerRelationshipResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/party/customers/reportingStatus","fullPath":"/api/v3.0.0/party/customers/reportingStatus","operationId":"getCustomerReportingStatus","name":"Retrieves the FATCA/CRS Reporting status and Reporting Jurisdiction of the Customer","summary":"Retrieves reporting status of the customer","tags":[],"parameters":[{"name":"customerId","in":"query","type":"string","required":true,"description":"Identifier of the customer"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from t24 on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"CustomerReportingStatusResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/party/customers/{customerId}/sweeps","fullPath":"/api/v3.0.0/party/customers/{customerId}/sweeps","operationId":"getCustomerSweeps","name":"Retrieves Account Sweep details such as Sweep reference, Type, Balance requirements for Sweep & Frequency of Sweep for the list of accounts available to a Customer","summary":"Retrieves Account Sweep details of the specific customer","tags":[],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"Identifier of the customer"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from t24 on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"CustomerSweepsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/party/customers/{customerId}/deliveryOptions","fullPath":"/api/v3.0.0/party/customers/{customerId}/deliveryOptions","operationId":"getCustomerDeliveryOptions","name":"Retrieves the Delivery Preferences of the Customer such as the Message group, carrier and address.","summary":"Retrieves Delivery Preferences of the Customer","tags":[],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"Identifier of the customer"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from t24 on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"CustomerDeliveryOptionsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/party/customers/{customerId}/channels","fullPath":"/api/v3.0.0/party/customers/{customerId}/channels","operationId":"getCustomerDigitalChannels","name":"Retrieves the list of message channels such as Internet Banking, Mobile Banking, ATM, etc available for the specific customer","summary":"Retrieves list of message channels","tags":[],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"Identifier of the customer"},{"name":"channelName","in":"query","type":"string","required":false,"description":"Name of the (digital) channel registered by the Customer"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from t24 on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"CustomerDigitalChannelsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"POST","path":"/party/customers/messages","fullPath":"/api/v3.0.0/party/customers/messages","operationId":"createMessages","name":"Create a new secure message for a Customer to be sent by bank","summary":"Create a new secure message for a Customer","tags":[],"parameters":[{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"messages":[{}],"subject":"string","toCustomerId":"string"}},"responses":{"200":"MessagesResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/party/customers/{customerId}/jointCustomers","fullPath":"/api/v3.0.0/party/customers/{customerId}/jointCustomers","operationId":"getJointCustomerDetails","name":"Retrieves details such as Joint Relation code, Name, Joint Customer details and reverse relationships for a specific Customer","summary":"Retrieves Joint Customer details for a specific Customer","tags":[],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"Identifier of the customer"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from t24 on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"JointCustomerDetailsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/party/customers/{customerId}/KYC","fullPath":"/api/v3.0.0/party/customers/{customerId}/KYC","operationId":"getCustomerKYCDetails","name":"Retrieves the KYC details such as Contact Date, Introducer, Last and Next Review date, KYC and AML Status of a Customer","summary":"Retrieves KYC details for a specific Customer","tags":[],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"Identifier of the customer"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from t24 on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"CustomerKYCDetailsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/party/customers/{customerId}/personalProfiles","fullPath":"/api/v3.0.0/party/customers/{customerId}/personalProfiles","operationId":"getCustomerPersonalDetails","name":"Retrieves Personal details such as Residence, Communication details, Occupation details, Asset & Liability information","summary":"Retrieves Personal details of Customer","tags":[],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"Identifier of the customer"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from t24 on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"CustomerPersonalDetailsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/party/customers/postingRestrictions","fullPath":"/api/v3.0.0/party/customers/postingRestrictions","operationId":"getCustomerPostingRestrictions","name":"Retrieves the Credit and Debit Posting Restriction details such as Restriction Reference and name of restriction set for a Customer","summary":"Retrieves Posting Restriction details","tags":[],"parameters":[{"name":"customerId","in":"query","type":"string","required":false,"description":"Identifier of the customer"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from t24 on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"CustomerPostingRestrictionsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"POST","path":"/party/relationships/{relationId}","fullPath":"/api/v3.0.0/party/relationships/{relationId}","operationId":"createPartyRelationship","name":"Create a Party Relationship between a Person, Entity or Customer with details such as Party Name, Type, RelatedAs, Relation Code and Owning details","summary":"Create Party Relationship details","tags":[],"parameters":[{"name":"relationId","in":"path","type":"string","required":true,"description":"Identifier of the Customer Relationship and Party Relationship"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"partyDisplayNames":[{}],"partyRelationships":[{}]}},"responses":{"200":"PartyRelationshipResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/party/relationships/{relationId}","fullPath":"/api/v3.0.0/party/relationships/{relationId}","operationId":"updatePartyRelationship","name":"Update Party Relationship between a Person, Entity or Customer with details such as Party Name, Type, RelatedAs, Relation Code and Owning details","summary":"Update Party Relationship details","tags":[],"parameters":[{"name":"relationId","in":"path","type":"string","required":true,"description":"Identifier of the Customer Relationship and Party Relationship"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"partyDisplayNames":[{}],"partyRelationships":[{}]}},"responses":{"200":"PartyRelationshipResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/party/customers/{customerId}/cards","fullPath":"/api/v3.0.0/party/customers/{customerId}/cards","operationId":"getCustomerCreditCards","name":"Retrieves the Card details such as Card Number, Card Type and Status, linked account and its balances of a customer","summary":"Retrieves Card details of a customer","tags":[],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"Identifier of the customer"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from t24 on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"CustomerCreditCardsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/party/customers/{customerId}/standingOrders","fullPath":"/api/v3.0.0/party/customers/{customerId}/standingOrders","operationId":"getStandingOrders","name":"Retrieves the list of  Standing Instructions for a Customer with details such as Instruction Reference, Order Type, frequency of Payments, Mode of Payment and Credit & Debit Parties involved","summary":"Retrieves Standing Instruction details of a customer","tags":[],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"Identifier of the customer"},{"name":"standingOrderId","in":"query","type":"string","required":false,"description":"The unique standing order identifier"},{"name":"accountId","in":"query","type":"string","required":false,"description":"Identifier of the account. Often referred to as the account number, yet for consistency this is always referred to as accountId. Accepts both IBAN & BBAN"},{"name":"orderingCustomerId","in":"query","type":"string","required":false,"description":"Indicates the customer id for the ordering customer"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from t24 on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"StandingOrdersResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/party/customers/{customerId}/directDebits","fullPath":"/api/v3.0.0/party/customers/{customerId}/directDebits","operationId":"getDirectDebits","name":"Retrieves the list of direct debits for a Customer with details such as Direct Debit Reference, debit & credit Accounts, transaction amount, payment frequency, next payment date and direction of payment","summary":"Retrieves Direct Debits details of a Customer","tags":[],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"Identifier of the customer"},{"name":"directDebitId","in":"query","type":"string","required":false,"description":"The unique identifier of the direct debit mandate. "},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from t24 on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"DirectDebitsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"POST","path":"/party/customers/{deliveryPreferenceId}/customerDeliveryPreferences","fullPath":"/api/v3.0.0/party/customers/{deliveryPreferenceId}/customerDeliveryPreferences","operationId":"createDeliveryPreference","name":"Creates delivery preferences for a customer or account with Message Group, Carrier, Role, Address, Email details and Format of messages","summary":"Create Customer Delivery Preferences","tags":[],"parameters":[{"name":"deliveryPreferenceId","in":"path","type":"string","required":true,"description":"Identifier of the customer delivery preferences"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"messageGroup":[{}],"otherMessagesDetail":[{}],"applyOtherMessages":"string"}},"responses":{"200":"DeliveryPreferenceResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/party/customers/{deliveryPreferenceId}/customerDeliveryPreferences","fullPath":"/api/v3.0.0/party/customers/{deliveryPreferenceId}/customerDeliveryPreferences","operationId":"updateDeliveryPreference","name":"Update delivery preferences for a  customer or account with Message Group, Carrier, Role, Address & Email details, Format of messages","summary":"Update Customer Deliver Preferences","tags":[],"parameters":[{"name":"deliveryPreferenceId","in":"path","type":"string","required":true,"description":"Identifier of the customer delivery preferences"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"messageGroup":[{}],"otherMessagesDetail":[{}],"applyOtherMessages":"string"}},"responses":{"200":"DeliveryPreferenceResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/party/customers/limits/{limitId}","fullPath":"/api/v3.0.0/party/customers/limits/{limitId}","operationId":"updateLimit","name":"Updates the limit details such as currency, limit grade, commodity, country and limit product details","summary":"Update Credit Limit details for customer","tags":[],"parameters":[{"name":"limitId","in":"path","type":"string","required":true,"description":"The identifier of credit limit"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"countries":[{}],"grades":[{}],"commodities":[{}],"currencyId":"string","onlineLimitDate":"2024-01-01","availableMarker":"string","allowNetting":"string","onlineUpdate":"string","limitProductId":"string","checkLimit":"string","band":"string","reducingLimit":"string","internalAmount":"string"}},"responses":{"200":"LimitResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/party/customers/customerExitStatus/{customerId}","fullPath":"/api/v3.0.0/party/customers/customerExitStatus/{customerId}","operationId":"getCustomerExitStatus","name":"Retrieves customer exit status details such as customer type, exit date, status and reason","summary":"Retrieves customer exit status details of Customer","tags":[],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"Identifier of the customer"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from t24 on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"CustomerExitStatusResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"PUT","path":"/party/customers/{customerId}/customerExitStatus","fullPath":"/api/v3.0.0/party/customers/{customerId}/customerExitStatus","operationId":"updateCustomerExitStatus","name":"Update a customer record with exit status and exit reason marking the customer as blocked or rejected or closed","summary":"Update customer exit status details of Customers","tags":[],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"Identifier of the customer"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"exitStatus":"string","exitReason":"string"}},"responses":{"200":"CustomerExitStatusResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/party/customers/settings/customerExitStatus","fullPath":"/api/v3.0.0/party/customers/settings/customerExitStatus","operationId":"getCustomerExitStatusParam","name":"Retrieves available conditions such as customer exit setup reference, allowed reasons and allowed re-open details to update customer exit status of Customers","summary":"Retrieves conditions to update customer exit status of Customer","tags":[],"parameters":[{"name":"customerType","in":"query","type":"string","required":false,"description":"Contains the type of customer, for example ACTIVE, PROSPECT."},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from t24 on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"CustomerExitStatusParamResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"POST","path":"/party/customers/settings/{customerExitStatusId}/customerExitStatus","fullPath":"/api/v3.0.0/party/customers/settings/{customerExitStatusId}/customerExitStatus","operationId":"createCustomerExitStatusParam","name":"Create conditions such as applicable customer type and allowed reasons to update the customer exit status details of Customers","summary":"Create conditions to update customer exit status of Customer","tags":[],"parameters":[{"name":"customerExitStatusId","in":"path","type":"string","required":true,"description":"The field reflects the exit status ID of a customer or prospect from the parameterization table CUSTOMER.EXIT.STATUS"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"allowedExitReasons":[{}],"exitStatusDescription":"string","customerType":"string","allowRemoveExitStatus":"string"}},"responses":{"200":"CustomerExitStatusParamResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/party/customers/settings/{customerExitStatusId}/customerExitStatus","fullPath":"/api/v3.0.0/party/customers/settings/{customerExitStatusId}/customerExitStatus","operationId":"updateCustomerExitStatusParam","name":"Create conditions such as applicable customer type and allowed reasons to update the customer exit status details of Customers","summary":"Create conditions to update customer exit status of Customer","tags":[],"parameters":[{"name":"customerExitStatusId","in":"path","type":"string","required":true,"description":"The field reflects the exit status ID of a customer or prospect from the parameterization table CUSTOMER.EXIT.STATUS"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"allowedExitReasons":[{}],"exitStatusDescription":"string","customerType":"string","allowRemoveExitStatus":"string"}},"responses":{"200":"CustomerExitStatusParamResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/party/customers/{customerId}/addressOutput","fullPath":"/api/v3.0.0/party/customers/{customerId}/addressOutput","operationId":"getCustomerAddressOutput","name":"Returns structured/unstructured address details of specified customer based on address option in request. When structured format is requested, the values are returned in format of structured data name combined with corresponding customer address value. When unstructured format is requested, the address details are returned based on configured unstructured address format.","summary":"Retrieves structured/ unstructured address format of Customer","tags":[],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"Identifier of the customer"},{"name":"addressOption","in":"query","type":"string","required":false,"description":"It reflects the preference for the customer address format, respective structured, unstructured or both"},{"name":"addressOutputFormat","in":"query","type":"string","required":false,"description":"It identifies the address output format for the unstructured address"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from t24 on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"CustomerAddressOutputResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/party/customers/{customerId}/shortNames","fullPath":"/api/v3.0.0/party/customers/{customerId}/shortNames","operationId":"getCustomerShortNames","name":"API to get the customer short name that can be used as customer enrichment by any application","summary":"Retrieves customer short name","tags":[],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"CustomerShortNamesResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/party/customers/{customerId}/mandates","fullPath":"/api/v3.0.0/party/customers/{customerId}/mandates","operationId":"getCustomerMandates","name":"Retrieves the mandate instruction details such as application eligible for mandate process and the corresponding mandate rule that is being applied to check mandates for transactions involving the specified customer.","summary":"Retrieves mandate instruction applicable for the requested customer","tags":[],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"CustomerMandatesResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/party/customers/{customerId}/documents","fullPath":"/api/v3.0.0/party/customers/{customerId}/documents","operationId":"getCustomerLegalDocuments","name":"Retrieves the details of legal document provided by the customer such as document name, document id, issue date, expiry date and authority who issued the document.","summary":"Retrieves the customer legal document details","tags":[],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"Identifier of the customer"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"CustomerLegalDocumentsResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/party/customers/{customerId}/profiles","fullPath":"/api/v3.0.0/party/customers/{customerId}/profiles","operationId":"getCustomerProfile","name":"Retrieves the customer basic details such as personal information, address location, basic contact details and other general information.","summary":"Retrieves profile details of the requested customer","tags":[],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"Identifier of the customer"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"CustomerProfileResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/party/customers/alternateReferences/{alternateReference}","fullPath":"/api/v3.0.0/party/customers/alternateReferences/{alternateReference}","operationId":"getCustomerId","name":"Retrieves the customer identifier for the provided alternate reference of the customer","summary":"Retrieves customer id for the given alternate reference","tags":[],"parameters":[{"name":"alternateReference","in":"path","type":"string","required":true,"description":"If the new Account to be created is a shadow of another Account already exisitng in another system, then the Account reference of that system can be specified here. The value given in this field will "},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from t24 on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"CustomerIdResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/party/customers/{customerId}/restrictions","fullPath":"/api/v3.0.0/party/customers/{customerId}/restrictions","operationId":"getCustomerRestrictions","name":"Retrieves the transaction restrictions imposed on the customer specified. Restrictions can be Post No Entries, Black listed customer, Pending KYC due reasons for restricting transactions on this customer","summary":"Retrieves the restriction details","tags":[],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"Identifier of the customer"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"CustomerRestrictionsResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/party/customers/{customerId}/contacts","fullPath":"/api/v3.0.0/party/customers/{customerId}/contacts","operationId":"getCustomerContacts","name":"Retrieves the contact details such as phone number, mobile numbers, fax and email address specific to the requested customer","summary":"Retrieves the customer contact details","tags":[],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"Identifier of the customer"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from t24 on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"CustomerContactsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/party/customers/{customerId}/relationships","fullPath":"/api/v3.0.0/party/customers/{customerId}/relationships","operationId":"getCustomerRelationships","name":"Retrieves the relationship details such as related customer and the relationship that exists with the requested customer","summary":"Retrieves the relation customers","tags":[],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"Identifier of the customer"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"CustomerRelationshipsResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/party/customers/{customerId}/payments","fullPath":"/api/v3.0.0/party/customers/{customerId}/payments","operationId":"getPartyBasicDetails","name":"Retrieves the customer information that are required for processing or validating the customer involved in a payment transaction. Provides the information such as customer name details, birth details, address details,  market sector, target, nationality, residence country and preferred language for communication.","summary":"Retrieves customer details required for payment processing","tags":[],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"Identifier of the customer"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from t24 on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"PartyBasicDetailsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/party/customers/{customerId}/addresses/swiftAddresses/{addressId}","fullPath":"/api/v3.0.0/party/customers/{customerId}/addresses/swiftAddresses/{addressId}","operationId":"getCustomerSwiftAddress","name":"Retrieves the SWIFT address details such as delivery address, short name & tag25 Indicator for the customer.","summary":"Retrieves the SWIFT address details for the customer.","tags":[],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"Identifier of the customer"},{"name":"addressId","in":"path","type":"string","required":true,"description":"Reference Id of address record"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from t24 on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"CustomerSwiftAddressResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/party/relationships/{partyId}/relations","fullPath":"/api/v3.0.0/party/relationships/{partyId}/relations","operationId":"getPartyRelationship","name":"Retrieves the relationship details such as Party Name, Type, Relation Code of a customers involved in a Relationship","summary":"Retrieves list of Party relationship details","tags":[],"parameters":[{"name":"partyId","in":"path","type":"string","required":true,"description":"Allows capturing of customers or person entities to be part of the relationship. If partyType is selected as Customer, then the system will allow only customer Ids to be captured into this field. If p"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from t24 on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"PartyRelationshipResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/party/customers/{customerId}/charges","fullPath":"/api/v3.0.0/party/customers/{customerId}/charges","operationId":"getCustomerCharge","name":"Retrieves customer charge for a customer with details such as tax type and tax group.","summary":"Retrieves customer charge for a specific customer.","tags":[],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"Identifier of the customer"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"CustomerChargeResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"POST","path":"/party/customers/{customerId}/charges","fullPath":"/api/v3.0.0/party/customers/{customerId}/charges","operationId":"createCustomerCharge","name":"Creates customer charge for a customer with details such as tax type and tax group.","summary":"Creates customer charge for a specific customer.","tags":[],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"Identifier of the customer"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"taxGroups":[{}]}},"responses":{"200":"CustomerChargeResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/party/customers/{customerId}/charges","fullPath":"/api/v3.0.0/party/customers/{customerId}/charges","operationId":"updateCustomerCharge","name":"Updates customer charge for a customer with details such as tax type and tax group.","summary":"Updates customer charge for a specific customer.","tags":[],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"Identifier of the customer"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"taxGroups":[{}]}},"responses":{"200":"CustomerChargeResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/party/customers/{customerId}/addresses/smsAddresses","fullPath":"/api/v3.0.0/party/customers/{customerId}/addresses/smsAddresses","operationId":"getCustomerPhoneAddress","name":"Retrieves the list of customer sms communication address with details such as name, idd prefix and mobile number.","summary":"Retrieves available list of customer sms communication addresses","tags":[],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"Identifier of the customer"},{"name":"addressId","in":"query","type":"string","required":false,"description":"Reference Id of address record"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from t24 on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"CustomerPhoneAddressResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"POST","path":"/party/customers/{customerId}/addresses/smsAddresses","fullPath":"/api/v3.0.0/party/customers/{customerId}/addresses/smsAddresses","operationId":"createCustomerPhoneAddress","name":"Create customer sms communication address with details such as name, idd prefix and mobile number.","summary":"Creates customer sms communication address","tags":[],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"Identifier of the customer"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"customerShortNames":[{}],"iddPrefixMobile":"string","mobileNumber":"string"}},"responses":{"200":"CustomerPhoneAddressResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/party/customers/{customerId}/addresses/emailAddresses","fullPath":"/api/v3.0.0/party/customers/{customerId}/addresses/emailAddresses","operationId":"getCustomerEmailAddress","name":"Retrieves the list of customer email communication address with details such as customer name and email references.","summary":"Retrieves available list of customer email communication addresses","tags":[],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"Identifier of the customer"},{"name":"addressId","in":"query","type":"string","required":false,"description":"Reference Id of address record"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from t24 on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"CustomerEmailAddressResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"POST","path":"/party/customers/{customerId}/addresses/emailAddresses","fullPath":"/api/v3.0.0/party/customers/{customerId}/addresses/emailAddresses","operationId":"createCustomerEmailAddress","name":"Create customer email communication address with details such as customer name and email references.","summary":"Creates customer email communication address","tags":[],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"Identifier of the customer"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"customerShortNames":[{}],"email":"string"}},"responses":{"200":"CustomerEmailAddressResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/party/customers/{customerId}/addresses/printAddresses","fullPath":"/api/v3.0.0/party/customers/{customerId}/addresses/printAddresses","operationId":"getCustomerPrintAddress","name":"Retrieves the list of customer print communication addresses with details such as name, address, postcode and phone number.","summary":"Retrieves available list of customer print communication addresses","tags":[],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"Identifier of the customer"},{"name":"addressId","in":"query","type":"string","required":false,"description":"Reference Id of address record"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from t24 on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"CustomerPrintAddressResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"POST","path":"/party/customers/{customerId}/addresses/printAddresses","fullPath":"/api/v3.0.0/party/customers/{customerId}/addresses/printAddresses","operationId":"createCustomerPrintAddress","name":"Create customer print communication address with details such as name, address, postcode and phone number.","summary":"Creates customer print communication address","tags":[],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"Identifier of the customer"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"customerShortNames":[{}],"customerNames":[{}],"addresses":[{}],"streets":[{}],"towns":[{}],"postCodes":[{}],"addressPurpose":"string","addressLocation":"string","addressVerifier":"string","countryCode":"string","departmentId":"string","subDepartmentId":"string","flatNumber":"string","buildingName":"string","buildingNumber":"string"}},"responses":{"200":"CustomerPrintAddressResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/party/customers/addresses/{customerAddressId}/smsAddresses","fullPath":"/api/v3.0.0/party/customers/addresses/{customerAddressId}/smsAddresses","operationId":"updateCustomerPhoneAddress","name":"Update customer sms communication address with details such as name, idd prefix and mobile number.","summary":"Updates customer sms communication address","tags":[],"parameters":[{"name":"customerAddressId","in":"path","type":"string","required":true,"description":"Identifier of the customer address table."},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"customerShortNames":[{}],"iddPrefixMobile":"string","mobileNumber":"string"}},"responses":{"200":"CustomerPhoneAddressResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"DELETE","path":"/party/customers/addresses/{customerAddressId}/smsAddresses","fullPath":"/api/v3.0.0/party/customers/addresses/{customerAddressId}/smsAddresses","operationId":"deleteCustomerPhoneAddress","name":"Delete the specified customer sms communication address that are no longer used.","summary":"Deletes customer sms communication address","tags":[],"parameters":[{"name":"customerAddressId","in":"path","type":"string","required":true,"description":"Identifier of the customer address table."},{"name":"payload","in":"body","type":"object","required":false,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}}},"responses":{"200":"CustomerPhoneAddressResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/party/customers/addresses/{customerAddressId}/emailAddresses","fullPath":"/api/v3.0.0/party/customers/addresses/{customerAddressId}/emailAddresses","operationId":"updateCustomerEmailAddress","name":"Update customer email communication address with details such as customer name and email references.","summary":"Updates customer email communication address","tags":[],"parameters":[{"name":"customerAddressId","in":"path","type":"string","required":true,"description":"Identifier of the customer address table."},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"customerShortNames":[{}],"email":"string"}},"responses":{"200":"CustomerEmailAddressResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"DELETE","path":"/party/customers/addresses/{customerAddressId}/emailAddresses","fullPath":"/api/v3.0.0/party/customers/addresses/{customerAddressId}/emailAddresses","operationId":"deleteCustomerEmailAddress","name":"Delete the specified customer email communication address that are no longer used.","summary":"Deletes customer email communication address","tags":[],"parameters":[{"name":"customerAddressId","in":"path","type":"string","required":true,"description":"Identifier of the customer address table."},{"name":"payload","in":"body","type":"object","required":false,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}}},"responses":{"200":"CustomerEmailAddressResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/party/customers/addresses/{customerAddressId}/printAddresses","fullPath":"/api/v3.0.0/party/customers/addresses/{customerAddressId}/printAddresses","operationId":"updateCustomerPrintAddress","name":"Update customer print communication address with details such as name, address, postcode and phone number.","summary":"Updates customer print communication address","tags":[],"parameters":[{"name":"customerAddressId","in":"path","type":"string","required":true,"description":"Identifier of the customer address table."},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"customerShortNames":[{}],"customerNames":[{}],"addresses":[{}],"streets":[{}],"towns":[{}],"postCodes":[{}],"addressPurpose":"string","addressLocation":"string","addressVerifier":"string","countryCode":"string","departmentId":"string","subDepartmentId":"string","flatNumber":"string","buildingName":"string","buildingNumber":"string"}},"responses":{"200":"CustomerPrintAddressResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"DELETE","path":"/party/customers/addresses/{customerAddressId}/printAddresses","fullPath":"/api/v3.0.0/party/customers/addresses/{customerAddressId}/printAddresses","operationId":"deleteCustomerPrintAddress","name":"Delete the specified customer print communication address that are no longer used.","summary":"Deletes customer print communication address","tags":[],"parameters":[{"name":"customerAddressId","in":"path","type":"string","required":true,"description":"Identifier of the customer address table."},{"name":"payload","in":"body","type":"object","required":false,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}}},"responses":{"200":"CustomerPrintAddressResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}}]},{"key":"party-customerServices-v4.0.0","title":"Customer management","version":"v4.0.0","description":"API to create, update and manage customer details such as delivery preferences, joint customer details, party relationships, KYC details, customer exit status, customer address formats & posting restrictions","endpointCount":67,"endpoints":[{"method":"GET","path":"/party/customers/{customerId}","fullPath":"/api/v4.0.0/party/customers/{customerId}","operationId":"getCustomer","name":"Retrieves the customer details such as customer contact information, residence details, legal document details, occupation details and relationship details for the specific customer","summary":"Retrieves list of customer details","tags":[],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"Identifier of the customer"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"CustomerResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/party/customers/{customerId}","fullPath":"/api/v4.0.0/party/customers/{customerId}","operationId":"updateCustomer","name":"Update customer details with the information such as customer contact information, residence details, legal document details, occupation details and relationship details, etc provided by the user","summary":"Update customer details","tags":[],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"Identifier of the customer"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"displayNames":[{}],"customerNames":[{}],"communicationDevices":[{}],"faxIds":[{}],"officePhoneNumbers":[{}],"streets":[{}],"addresses":[{}],"addressCities":[{}],"countries":[{}],"legalDetails":[{}],"otherNationalityIds":[{}],"employDetails":[{}],"residenceDetails":[{}],"relationshipDetails":[{}],"postingRestrictIds":[{}]}},"responses":{"200":"CustomerResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/party/customers","fullPath":"/api/v4.0.0/party/customers","operationId":"getCustomerInformation","name":"Retrieves the customer details such as delivery or postal details, contact information, residence details, customer profile, legal document details, occupation details and status of customer","summary":"Retrieves list of customer basic details","tags":[],"parameters":[{"name":"customerId","in":"query","type":"string","required":false,"description":"Identifier of the customer"},{"name":"customerIdCT","in":"query","type":"string","required":false,"description":"Indicates the criteria for the contains operation on the customer Id"},{"name":"customerIdBW","in":"query","type":"string","required":false,"description":"Indicates the criteria for the between operation on the customer Id"},{"name":"customerIdMT","in":"query","type":"string","required":false,"description":"Indicates the criteria for the matches operation on the customer Id"},{"name":"customerName","in":"query","type":"string","required":false,"description":"Name of the customer"},{"name":"customerNameCT","in":"query","type":"string","required":false,"description":"Indicates the criteria for the contains operation on the customer name"},{"name":"customerNameBW","in":"query","type":"string","required":false,"description":"Indicates the criteria for the between operation on the customer name"},{"name":"customerNameMT","in":"query","type":"string","required":false,"description":"Indicates the criteria for the matches operation on the customer name"},{"name":"street","in":"query","type":"string","required":false,"description":"Contains the first line of customer's base address, example building number, street number etc."},{"name":"streetCT","in":"query","type":"string","required":false,"description":"Indicates the criteria for the contains operation on the street"},{"name":"streetBW","in":"query","type":"string","required":false,"description":"Indicates the criteria for the between operation on the street"},{"name":"streetMT","in":"query","type":"string","required":false,"description":"Indicates the criteria for the matches operation on the street"},{"name":"addressCity","in":"query","type":"string","required":false,"description":"The town and/or city component of the base address of a customer"},{"name":"addressCityCT","in":"query","type":"string","required":false,"description":"Indicates the criteria for the contains operation on the town country"},{"name":"addressCityBW","in":"query","type":"string","required":false,"description":"Indicates the criteria for the between operation on the town country"},{"name":"addressCityMT","in":"query","type":"string","required":false,"description":"Indicates the criteria for the matches operation on the town country"},{"name":"countryId","in":"query","type":"string","required":false,"description":"ISO country code of the financial institution. "},{"name":"countryIdCT","in":"query","type":"string","required":false,"description":"Indicates the criteria for the contains operation on the country"},{"name":"countryIdBW","in":"query","type":"string","required":false,"description":"Indicates the criteria for the between operation on the country"},{"name":"countryIdMT","in":"query","type":"string","required":false,"description":"Indicates the criteria for the matches operation on the country"},{"name":"postCode","in":"query","type":"string","required":false,"description":"Identifies the address postal code for the customer."},{"name":"postCodeCT","in":"query","type":"string","required":false,"description":"Indicates the criteria for the contains operation on the post code"},{"name":"postCodeBW","in":"query","type":"string","required":false,"description":"Indicates the criteria for the between operation on the post code"},{"name":"postCodeMT","in":"query","type":"string","required":false,"description":"Indicates the criteria for the matches operation on the post code"},{"name":"dateOfBirth","in":"query","type":"string","required":false,"description":"The date of birth of an individual customer"},{"name":"dateOfBirthCT","in":"query","type":"string","required":false,"description":"Indicates the criteria for the contains operation on the date of birth"},{"name":"dateOfBirthBW","in":"query","type":"string","required":false,"description":"Indicates the criteria for the between operation on the date of birth"},{"name":"dateOfBirthMT","in":"query","type":"string","required":false,"description":"Indicates the criteria for the matches operation on the date of birth"},{"name":"customerStatus","in":"query","type":"string","required":false,"description":"The internal bank status of a customer"},{"name":"customerStatusCT","in":"query","type":"string","required":false,"description":"Indicates the criteria for the contains operation on the customer status"},{"name":"customerStatusBW","in":"query","type":"string","required":false,"description":"Indicates the criteria for the between operation on the customer status"},{"name":"customerStatusMT","in":"query","type":"string","required":false,"description":"Indicates the criteria for the matches operation on the customer status"},{"name":"sectorId","in":"query","type":"string","required":false,"description":"An institution-defined identifier of the type of customer"},{"name":"sectorIdCT","in":"query","type":"string","required":false,"description":"Indicates the criteria for the contains operation on the sector"},{"name":"sectorIdBW","in":"query","type":"string","required":false,"description":"Indicates the criteria for the between operation on the sector"},{"name":"sectorIdMT","in":"query","type":"string","required":false,"description":"Indicates the criteria for the matches operation on the sector"},{"name":"accountOfficerId","in":"query","type":"string","required":false,"description":"The identifier of the department head or specific account officer responsible for the customer"},{"name":"accountOfficerIdBW","in":"query","type":"string","required":false,"description":"Indicates the criteria for the between operation on the account officer"},{"name":"accountOfficerIdCT","in":"query","type":"string","required":false,"description":"Indicates the criteria for the contains operation on the account officer"},{"name":"accountOfficerIdMT","in":"query","type":"string","required":false,"description":"Indicates the criteria for the matches operation on the account officer"},{"name":"industryId","in":"query","type":"string","required":false,"description":"An institution-defined identifier of the industry in which the customer is trading, operating or is associated with"},{"name":"industryIdBW","in":"query","type":"string","required":false,"description":"Indicates the criteria for the between operation on the industry"},{"name":"industryIdCT","in":"query","type":"string","required":false,"description":"Indicates the criteria for the contains operation on the industry"},{"name":"industryIdMT","in":"query","type":"string","required":false,"description":"Indicates the criteria for the matches operation on the industry"},{"name":"nationalityId","in":"query","type":"string","required":false,"description":"The identifier of the nationality of a customer"},{"name":"nationalityIdBW","in":"query","type":"string","required":false,"description":"Indicates the criteria for the between operation on the nationality"},{"name":"nationalityIdCT","in":"query","type":"string","required":false,"description":"Indicates the criteria for the contains operation on the nationality"},{"name":"nationalityIdMT","in":"query","type":"string","required":false,"description":"Indicates the criteria for the matches operation on the nationality"},{"name":"residenceId","in":"query","type":"string","required":false,"description":"The identifier of the country of residence of a customer"},{"name":"residenceIdMT","in":"query","type":"string","required":false,"description":"Indicates the criteria for the matches operation on the residence"},{"name":"residenceIdCT","in":"query","type":"string","required":false,"description":"Indicates the criteria for the contains operation on the residence"},{"name":"residenceIdBW","in":"query","type":"string","required":false,"description":"Indicates the criteria for the between operation on the residence"},{"name":"lastName","in":"query","type":"string","required":false,"description":"The last name of an individual customer"},{"name":"lastNameCT","in":"query","type":"string","required":false,"description":"Indicates the criteria for the contains operation on the family name"},{"name":"lastNameBW","in":"query","type":"string","required":false,"description":"Indicates the criteria for the between operation on the family name"},{"name":"lastNameMT","in":"query","type":"string","required":false,"description":"Indicates the criteria for the matches operation on the family name"},{"name":"phoneNumber","in":"query","type":"string","required":false,"description":"The phone number of the customer or prospect"},{"name":"phoneNumberCT","in":"query","type":"string","required":false,"description":"Indicates the criteria for the contains operation on the phone number"},{"name":"phoneNumberMT","in":"query","type":"string","required":false,"description":"Indicates the criteria for the matches operation on the phone number"},{"name":"phoneNumberBW","in":"query","type":"string","required":false,"description":"Indicates the criteria for the between operation on the phone number"},{"name":"customerMnemonic","in":"query","type":"string","required":false,"description":"Specifies an alternative easy means of referencing the Customer"},{"name":"customerMnemonicCT","in":"query","type":"string","required":false,"description":"Indicates the criteria for the contains operation on the customer mnemonic"},{"name":"customerMnemonicBW","in":"query","type":"string","required":false,"description":"Indicates the criteria for the between operation on the customer mnemonic"},{"name":"customerMnemonicMT","in":"query","type":"string","required":false,"description":"Indicates the criteria for the matches operation on the customer mnemonic"},{"name":"firstName","in":"query","type":"string","required":false,"description":"Specifies customer's first name"},{"name":"firstNameBW","in":"query","type":"string","required":false,"description":"Indicates the criteria for the between operation on the first name"},{"name":"firstNameMT","in":"query","type":"string","required":false,"description":"Indicates the criteria for the matches operation on the first name"},{"name":"firstNameCT","in":"query","type":"string","required":false,"description":"Indicates the criteria for the contains operation on the first name"},{"name":"customerType","in":"query","type":"string","required":false,"description":"Contains the type of customer, for example ACTIVE, PROSPECT."},{"name":"customerTypeCT","in":"query","type":"string","required":false,"description":"Indicates the criteria for the contains operation on the customer type"},{"name":"customerTypeBW","in":"query","type":"string","required":false,"description":"Indicates the criteria for the between operation on the customer type"},{"name":"customerTypeMT","in":"query","type":"string","required":false,"description":"Indicates the criteria for the matches operation on the customer type"},{"name":"email","in":"query","type":"string","required":false,"description":"Email Identifier of the Customer"},{"name":"emailCT","in":"query","type":"string","required":false,"description":"Indicates the criteria for the contains operation on the emails"},{"name":"emailMT","in":"query","type":"string","required":false,"description":"Indicates the criteria for the matches operation on the emails"},{"name":"emailBW","in":"query","type":"string","required":false,"description":"Indicates the criteria for the between operation on the emails"},{"name":"mobilePhoneNumber","in":"query","type":"string","required":false,"description":"Represents the phone number of a customer"},{"name":"mobilePhoneNumberCT","in":"query","type":"string","required":false,"description":"Indicates the criteria for the contains operation on the mobile numbers"},{"name":"mobilePhoneNumberBW","in":"query","type":"string","required":false,"description":"Indicates the criteria for the between operation on the mobile numbers"},{"name":"mobilePhoneNumberMT","in":"query","type":"string","required":false,"description":"Indicates the criteria for the matches operation on the mobile numbers"},{"name":"taxId","in":"query","type":"string","required":false,"description":"Holds the Customer's TAX/SSN Id."},{"name":"taxIdCT","in":"query","type":"string","required":false,"description":"Indicates the criteria for the contains operation on the tax Id"},{"name":"taxIdBW","in":"query","type":"string","required":false,"description":"Indicates the criteria for the between operation on the tax Id"},{"name":"taxIdMT","in":"query","type":"string","required":false,"description":"Indicates the criteria for the matches operation on the tax Id"},{"name":"shortName","in":"query","type":"string","required":false,"description":"Contains the name of the account, basically the short title of the account."},{"name":"shortNameCT","in":"query","type":"string","required":false,"description":"Indicates the criteria for the contains operation on the short name"},{"name":"shortNameBW","in":"query","type":"string","required":false,"description":"Indicates the criteria for the between operation on the short name"},{"name":"shortNameMT","in":"query","type":"string","required":false,"description":"Indicates the criteria for the matches operation on the short name"},{"name":"officePhoneNumber","in":"query","type":"string","required":false,"description":"The office phone number of the customer"},{"name":"officePhoneNumberCT","in":"query","type":"string","required":false,"description":"Indicates the criteria for the contains operation on the office phone numbers"},{"name":"officePhoneNumberBW","in":"query","type":"string","required":false,"description":"Indicates the criteria for the between operation on the office phone numbers"},{"name":"officePhoneNumberMT","in":"query","type":"string","required":false,"description":"Indicates the criteria for the matches operation on the office phone numbers"},{"name":"faxId","in":"query","type":"string","required":false,"description":"The fax (facsimile) number of the customer"},{"name":"faxIdBW","in":"query","type":"string","required":false,"description":"Indicates the criteria for the between operation on the fax Id"},{"name":"faxIdCT","in":"query","type":"string","required":false,"description":"Indicates the criteria for the contains operation on the fax Id"},{"name":"faxIdMT","in":"query","type":"string","required":false,"description":"Indicates the criteria for the matches operation on the fax Id"},{"name":"address","in":"query","type":"string","required":false,"description":"Communication Address of the Customer"},{"name":"addressCT","in":"query","type":"string","required":false,"description":"Indicates the criteria for the contains operation on the address"},{"name":"addressBW","in":"query","type":"string","required":false,"description":"Indicates the criteria for the between operation on the address"},{"name":"addressMT","in":"query","type":"string","required":false,"description":"Indicates the criteria for the matches operation on the address"},{"name":"relCustomer","in":"query","type":"string","required":false,"description":"Customers linked or related to the arrangement owner"},{"name":"relCustomerBW","in":"query","type":"string","required":false,"description":"Indicates the criteria for the between operation on the related customer Id"},{"name":"relCustomerCT","in":"query","type":"string","required":false,"description":"Indicates the criteria for the contains operation on the related customer Id"},{"name":"relCustomerMT","in":"query","type":"string","required":false,"description":"Indicates the criteria for the matches operation on the related customer Id"},{"name":"relationshipCode","in":"query","type":"string","required":false,"description":"Relationship identifier between the partyType and relatedPartyType"},{"name":"relationshipCodeBW","in":"query","type":"string","required":false,"description":"Indicates the criteria for the between operation on the relationship code"},{"name":"relationshipCodeMT","in":"query","type":"string","required":false,"description":"Indicates the criteria for the matches operation on the relationship code"},{"name":"relationshipCodeCT","in":"query","type":"string","required":false,"description":"Indicates the criteria for the contains operation on the relationship code"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"CustomerInformationResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"POST","path":"/party/customers","fullPath":"/api/v4.0.0/party/customers","operationId":"createCustomer","name":"Create a customer with the information such as customer contact information, residence details, legal document details, occupation details and relationship details, etc provided by the user","summary":"Create a customer","tags":[],"parameters":[{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"displayNames":[{}],"customerNames":[{}],"communicationDevices":[{}],"faxIds":[{}],"officePhoneNumbers":[{}],"streets":[{}],"addresses":[{}],"addressCities":[{}],"countries":[{}],"legalDetails":[{}],"otherNationalityIds":[{}],"employDetails":[{}],"residenceDetails":[{}],"relationshipDetails":[{}],"postingRestrictIds":[{}]}},"responses":{"200":"CustomerResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/party/customers/relationships","fullPath":"/api/v4.0.0/party/customers/relationships","operationId":"getCustomerRelationship","name":"Retrieves customer relationship details such as type of relationship, party information, relatedAs details, owning details, role & purpose of relationship for specific party or customer","summary":"Retrieves list of customer relationships","tags":[],"parameters":[{"name":"customerRelationGroupId","in":"query","type":"string","required":false,"description":"Identifies the key to Customer Relationship Group to form a relation"},{"name":"partyId","in":"query","type":"string","required":false,"description":"Allows capturing of customers or person entities to be part of the relationship. If partyType is selected as Customer, then the system will allow only customer Ids to be captured into this field. If p"},{"name":"relatedPartyId","in":"query","type":"string","required":false,"description":"Identifier of the Related Party"},{"name":"relationId","in":"query","type":"string","required":false,"description":"Identifier of the Customer Relationship and Party Relationship"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"CustomerRelationshipResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"POST","path":"/party/customers/relationships","fullPath":"/api/v4.0.0/party/customers/relationships","operationId":"createCustomerRelationship","name":"Create a customer relationship for a customer with details such as type of relationship, party information, relatedAs details, owning details, role & purpose of relationship","summary":"Create customer relationship with other customers","tags":[],"parameters":[{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"originatingRelation":[{}],"customerRelationGroupId":0.0,"customerRelationGroupName":"string","purposeOfRelationship":"string"}},"responses":{"200":"CustomerRelationshipResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/party/customers/relationships/{relationId}","fullPath":"/api/v4.0.0/party/customers/relationships/{relationId}","operationId":"updateCustomerRelationship","name":"Update customer relationship for a customer with details such as type of relationship, party information, related details, owning details, role & purpose of relationship","summary":"Update customer relationship","tags":[],"parameters":[{"name":"relationId","in":"path","type":"string","required":true,"description":"Identifier of the Customer Relationship and Party Relationship"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"originatingRelation":[{}],"customerRelationGroupId":0.0,"customerRelationGroupName":"string","purposeOfRelationship":"string"}},"responses":{"200":"CustomerRelationshipResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/party/customers/reportingStatus","fullPath":"/api/v4.0.0/party/customers/reportingStatus","operationId":"getCustomerReportingStatus","name":"Retrieves the FATCA/CRS reporting status and reporting jurisdiction of the customer","summary":"Retrieves reporting status of the customer","tags":[],"parameters":[{"name":"customerId","in":"query","type":"string","required":true,"description":"Identifier of the customer"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"CustomerReportingStatusResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/party/customers/{customerId}/sweeps","fullPath":"/api/v4.0.0/party/customers/{customerId}/sweeps","operationId":"getCustomerSweeps","name":"Retrieves account sweep details such as sweep reference, type, balance requirements for sweep & frequency of sweep for the list of accounts available to a customer","summary":"Retrieves account sweep details of the specific customer","tags":[],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"Identifier of the customer"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"CustomerSweepsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/party/customers/{customerId}/deliveryOptions","fullPath":"/api/v4.0.0/party/customers/{customerId}/deliveryOptions","operationId":"getCustomerDeliveryOptions","name":"Retrieves the delivery preferences of the customer such as the message group, carrier and address.","summary":"Retrieves delivery preferences of the customer","tags":[],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"Identifier of the customer"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"CustomerDeliveryOptionsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/party/customers/{customerId}/channels","fullPath":"/api/v4.0.0/party/customers/{customerId}/channels","operationId":"getCustomerDigitalChannels","name":"Retrieves the list of message channels such as internet banking, mobile banking, ATM, etc available for the specific customer","summary":"Retrieves list of message channels","tags":[],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"Identifier of the customer"},{"name":"channelName","in":"query","type":"string","required":false,"description":"Name of the (digital) channel registered by the Customer"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"CustomerDigitalChannelsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"POST","path":"/party/customers/messages","fullPath":"/api/v4.0.0/party/customers/messages","operationId":"createMessages","name":"Create a new secure message for a customer to be sent by bank","summary":"Create a new secure message for a customer","tags":[],"parameters":[{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"messages":[{}],"subject":"string","toCustomerId":"string"}},"responses":{"200":"MessagesResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/party/customers/{customerId}/jointCustomers","fullPath":"/api/v4.0.0/party/customers/{customerId}/jointCustomers","operationId":"getJointCustomerDetails","name":"Retrieves details such as joint relation code, name, joint customer details and reverse relationships for a specific customer","summary":"Retrieves joint customer details for a specific customer","tags":[],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"Identifier of the customer"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"JointCustomerDetailsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/party/customers/{customerId}/KYC","fullPath":"/api/v4.0.0/party/customers/{customerId}/KYC","operationId":"getCustomerKYCDetails","name":"Retrieves the KYC details such as contact date, introducer, last and next review date, KYC and AML status of a customer","summary":"Retrieves KYC details for a specific customer","tags":[],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"Identifier of the customer"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"CustomerKYCDetailsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/party/customers/{customerId}/personalProfiles","fullPath":"/api/v4.0.0/party/customers/{customerId}/personalProfiles","operationId":"getCustomerPersonalDetails","name":"Retrieves personal details such as residence, communication details, occupation details, asset & liability information","summary":"Retrieves Personal details of customer","tags":[],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"Identifier of the customer"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"CustomerPersonalDetailsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/party/customers/postingRestrictions","fullPath":"/api/v4.0.0/party/customers/postingRestrictions","operationId":"getCustomerPostingRestrictions","name":"Retrieves the credit and debit posting restriction details such as restriction reference and name of restriction set for a customer","summary":"Retrieves posting restriction details","tags":[],"parameters":[{"name":"customerId","in":"query","type":"string","required":false,"description":"Identifier of the customer"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"CustomerPostingRestrictionsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"POST","path":"/party/relationships/{relationId}","fullPath":"/api/v4.0.0/party/relationships/{relationId}","operationId":"createPartyRelationship","name":"Create a party relationship between a person, entity or customer with details such as party name, type, relatedAs, relation code and owning details","summary":"Create party relationship details","tags":[],"parameters":[{"name":"relationId","in":"path","type":"string","required":true,"description":"Identifier of the Customer Relationship and Party Relationship"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"partyDisplayNames":[{}],"partyRelationships":[{}]}},"responses":{"200":"PartyRelationshipResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/party/relationships/{relationId}","fullPath":"/api/v4.0.0/party/relationships/{relationId}","operationId":"updatePartyRelationship","name":"Update party relationship between a person, entity or customer with details such as party name, type, relatedAs, relation code and owning details","summary":"Update party relationship details","tags":[],"parameters":[{"name":"relationId","in":"path","type":"string","required":true,"description":"Identifier of the Customer Relationship and Party Relationship"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"partyDisplayNames":[{}],"partyRelationships":[{}]}},"responses":{"200":"PartyRelationshipResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/party/customers/{customerId}/cards","fullPath":"/api/v4.0.0/party/customers/{customerId}/cards","operationId":"getCustomerCreditCards","name":"Retrieves the card details such as card Number, card type and status, linked account and its balances of a customer","summary":"Retrieves card details of a customer","tags":[],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"Identifier of the customer"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"CustomerCreditCardsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/party/customers/{customerId}/standingOrders","fullPath":"/api/v4.0.0/party/customers/{customerId}/standingOrders","operationId":"getStandingOrders","name":"Retrieves the list of standing instructions for a customer with details such as instruction reference, order type, frequency of payments, mode of payment and credit & debit parties involved","summary":"Retrieves standing instruction details of a customer","tags":[],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"Identifier of the customer"},{"name":"standingOrderId","in":"query","type":"string","required":false,"description":"The unique standing order identifier"},{"name":"accountId","in":"query","type":"string","required":false,"description":"Identifier of the account. Often referred to as the account number, yet for consistency this is always referred to as accountId. Accepts both IBAN & BBAN"},{"name":"orderingCustomerId","in":"query","type":"string","required":false,"description":"Indicates the customer id for the ordering customer"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"StandingOrdersResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/party/customers/{customerId}/directDebits","fullPath":"/api/v4.0.0/party/customers/{customerId}/directDebits","operationId":"getDirectDebits","name":"Retrieves the list of direct debits for a customer with details such as direct debit reference, debit & credit accounts, transaction amount, payment frequency, next payment date and direction of payment","summary":"Retrieves direct debits details of a customer","tags":[],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"Identifier of the customer"},{"name":"directDebitId","in":"query","type":"string","required":false,"description":"The unique identifier of the direct debit mandate. "},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"DirectDebitsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"POST","path":"/party/customers/deliveryPreferences/{deliveryPreferenceId}","fullPath":"/api/v4.0.0/party/customers/deliveryPreferences/{deliveryPreferenceId}","operationId":"createDeliveryPreference","name":"Creates delivery preferences for a customer or account with message group, carrier, role, address, email details and format of messages","summary":"Create customer delivery preferences","tags":[],"parameters":[{"name":"deliveryPreferenceId","in":"path","type":"string","required":true,"description":"Identifier of the customer delivery preferences"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"messageGroup":[{}],"otherMessagesDetail":[{}],"applyOtherMessages":"string"}},"responses":{"200":"DeliveryPreferenceResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/party/customers/deliveryPreferences/{deliveryPreferenceId}","fullPath":"/api/v4.0.0/party/customers/deliveryPreferences/{deliveryPreferenceId}","operationId":"updateDeliveryPreference","name":"Update delivery preferences for a  customer or account with message group, carrier, role, address & email details, format of messages","summary":"Update customer deliver preferences","tags":[],"parameters":[{"name":"deliveryPreferenceId","in":"path","type":"string","required":true,"description":"Identifier of the customer delivery preferences"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"messageGroup":[{}],"otherMessagesDetail":[{}],"applyOtherMessages":"string"}},"responses":{"200":"DeliveryPreferenceResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/party/customers/limits/{limitId}","fullPath":"/api/v4.0.0/party/customers/limits/{limitId}","operationId":"updateLimit","name":"Updates the limit details such as currency, limit grade, commodity, country and limit product details","summary":"Update credit limit details for customer","tags":[],"parameters":[{"name":"limitId","in":"path","type":"string","required":true,"description":"The identifier of credit limit"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"countries":[{}],"grades":[{}],"commodities":[{}],"currencyId":"string","onlineLimitDate":"2024-01-01","availableMarker":"string","allowNetting":"string","onlineUpdate":"string","limitProductId":"string","checkLimit":"string","band":"string","reducingLimit":"string","internalAmount":"string"}},"responses":{"200":"LimitResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/party/customers/{customerId}/customerExitStatus","fullPath":"/api/v4.0.0/party/customers/{customerId}/customerExitStatus","operationId":"getCustomerExitStatus","name":"Retrieves customer exit status details such as customer type, exit date, status and reason","summary":"Retrieves customer exit status details of customer","tags":[],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"Identifier of the customer"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"CustomerExitStatusResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"PUT","path":"/party/customers/{customerId}/customerExitStatus","fullPath":"/api/v4.0.0/party/customers/{customerId}/customerExitStatus","operationId":"updateCustomerExitStatus","name":"Update a customer record with exit status and exit reason marking the customer as blocked or rejected or closed","summary":"Update customer exit status details of customers","tags":[],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"Identifier of the customer"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"exitStatus":"string","exitReason":"string"}},"responses":{"200":"CustomerExitStatusResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/party/customers/settings/customerExitStatus/{customerExitStatusId}","fullPath":"/api/v4.0.0/party/customers/settings/customerExitStatus/{customerExitStatusId}","operationId":"getCustomerExitStatusParam","name":"Retrieves available conditions such as customer exit setup reference, allowed reasons and allowed re-open details to update customer exit status of customers","summary":"Retrieves conditions to update customer exit status of customer","tags":[],"parameters":[{"name":"customerExitStatusId","in":"path","type":"string","required":true,"description":"The field reflects the exit status ID of a customer or prospect from the parameterization table CUSTOMER.EXIT.STATUS"},{"name":"customerType","in":"query","type":"string","required":false,"description":"Contains the type of customer, for example ACTIVE, PROSPECT."},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"CustomerExitStatusParamResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"POST","path":"/party/customers/settings/customerExitStatus/{customerExitStatusId}","fullPath":"/api/v4.0.0/party/customers/settings/customerExitStatus/{customerExitStatusId}","operationId":"createCustomerExitStatusParam","name":"Create conditions such as applicable customer type and allowed reasons to update the customer exit status details of customers","summary":"Create conditions to update customer exit status of customer","tags":[],"parameters":[{"name":"customerExitStatusId","in":"path","type":"string","required":true,"description":"The field reflects the exit status ID of a customer or prospect from the parameterization table CUSTOMER.EXIT.STATUS"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"allowedExitReasons":[{}],"exitStatusDescription":"string","customerType":"string","allowRemoveExitStatus":"string"}},"responses":{"200":"CustomerExitStatusParamResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/party/customers/settings/{customerExitStatusId}/customerExitStatus","fullPath":"/api/v4.0.0/party/customers/settings/{customerExitStatusId}/customerExitStatus","operationId":"updateCustomerExitStatusParam","name":"Create conditions such as applicable customer type and allowed reasons to update the customer exit status details of customers","summary":"Create conditions to update customer exit status of customer","tags":[],"parameters":[{"name":"customerExitStatusId","in":"path","type":"string","required":true,"description":"The field reflects the exit status ID of a customer or prospect from the parameterization table CUSTOMER.EXIT.STATUS"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"allowedExitReasons":[{}],"exitStatusDescription":"string","customerType":"string","allowRemoveExitStatus":"string"}},"responses":{"200":"CustomerExitStatusParamResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/party/customers/{customerId}/addresses","fullPath":"/api/v4.0.0/party/customers/{customerId}/addresses","operationId":"getCustomerAddressOutput","name":"Returns structured/unstructured address details of specified customer based on address option in request. When structured format is requested, the values are returned in format of structured data name combined with corresponding customer address value. When unstructured format is requested, the address details are returned based on configured unstructured address format.","summary":"Retrieves structured/ unstructured address format of customer","tags":[],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"Identifier of the customer"},{"name":"addressOption","in":"query","type":"string","required":false,"description":"It reflects the preference for the customer address format, respective structured, unstructured or both"},{"name":"addressOutputFormat","in":"query","type":"string","required":false,"description":"It identifies the address output format for the unstructured address"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"CustomerAddressOutputResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/party/customers/{customerId}/shortNames","fullPath":"/api/v4.0.0/party/customers/{customerId}/shortNames","operationId":"getCustomerShortNames","name":"API to get the customer short name that can be used as customer enrichment by any application","summary":"Retrieves customer short name","tags":[],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"Identifier of the customer"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"CustomerShortNamesResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/party/customers/{customerId}/mandates","fullPath":"/api/v4.0.0/party/customers/{customerId}/mandates","operationId":"getCustomerMandates","name":"Retrieves the mandate instruction details such as application eligible for mandate process and the corresponding mandate rule that is being applied to check mandates for transactions involving the specified customer.","summary":"Retrieves mandate instruction applicable for the requested customer","tags":[],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"Identifier of the customer"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"CustomerMandatesResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/party/customers/{customerId}/documents","fullPath":"/api/v4.0.0/party/customers/{customerId}/documents","operationId":"getCustomerLegalDocuments","name":"Retrieves the details of legal document provided by the customer such as document name, document id, issue date, expiry date and authority who issued the document.","summary":"Retrieves the customer legal document details","tags":[],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"Identifier of the customer"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"CustomerLegalDocumentsResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/party/customers/{customerId}/profiles","fullPath":"/api/v4.0.0/party/customers/{customerId}/profiles","operationId":"getCustomerProfile","name":"Retrieves the customer basic details such as personal information, address location, basic contact details and other general information.","summary":"Retrieves profile details of the requested customer","tags":[],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"CustomerProfileResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/party/customers/alternateReferences/{alternateReference}","fullPath":"/api/v4.0.0/party/customers/alternateReferences/{alternateReference}","operationId":"getCustomerId","name":"Retrieves the customer identifier for the provided alternate reference of the customer","summary":"Retrieves customer id for the given alternate reference","tags":[],"parameters":[{"name":"alternateReference","in":"path","type":"string","required":true,"description":"If the new Account to be created is a shadow of another Account already exisitng in another system, then the Account reference of that system can be specified here. The value given in this field will "},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"CustomerIdResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/party/customers/{customerId}/restrictions","fullPath":"/api/v4.0.0/party/customers/{customerId}/restrictions","operationId":"getCustomerRestrictions","name":"Retrieves the transaction restrictions imposed on the customer specified. Restrictions can be post no entries, black listed customer, pending KYC due reasons for restricting transactions on this customer","summary":"Retrieves the restriction details","tags":[],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"CustomerRestrictionsResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/party/customers/{customerId}/contacts","fullPath":"/api/v4.0.0/party/customers/{customerId}/contacts","operationId":"getCustomerContacts","name":"Retrieves the contact details such as phone number, mobile numbers, fax and email address specific to the requested customer","summary":"Retrieves the customer contact details","tags":[],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"Identifier of the customer"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"CustomerContactsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/party/customers/{customerId}/relationships","fullPath":"/api/v4.0.0/party/customers/{customerId}/relationships","operationId":"getCustomerRelationships","name":"Retrieves the relationship details such as related customer and the relationship that exists with the requested customer","summary":"Retrieves the relation customers","tags":[],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"CustomerRelationshipsResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/party/customers/{customerId}/payments","fullPath":"/api/v4.0.0/party/customers/{customerId}/payments","operationId":"getPartyBasicDetails","name":"Retrieves the customer information that are required for processing or validating the customer involved in a payment transaction. Provides the information such as customer name details, birth details, address details,  market sector, target, nationality, residence country and preferred language for communication.","summary":"Retrieves customer details required for payment processing","tags":[],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"Identifier of the customer"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"PartyBasicDetailsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/party/customers/{customerId}/addresses/swiftAddresses/{addressId}","fullPath":"/api/v4.0.0/party/customers/{customerId}/addresses/swiftAddresses/{addressId}","operationId":"getCustomerSwiftAddress","name":"Retrieves the SWIFT address details such as delivery address, short name & tag25 indicator for the customer.","summary":"Retrieves the SWIFT address details for the customer.","tags":[],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"Identifier of the customer"},{"name":"addressId","in":"path","type":"string","required":true,"description":"Reference Id of address record"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"CustomerSwiftAddressResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/party/relationships/{partyId}/relations","fullPath":"/api/v4.0.0/party/relationships/{partyId}/relations","operationId":"getPartyRelationship","name":"Retrieves the relationship details such as party name, type, relation code of a customers involved in a relationship","summary":"Retrieves list of party relationship details","tags":[],"parameters":[{"name":"partyId","in":"path","type":"string","required":true,"description":"Allows capturing of customers or person entities to be part of the relationship. If partyType is selected as Customer, then the system will allow only customer Ids to be captured into this field. If p"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"PartyRelationshipResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/party/customers/{customerId}/charges","fullPath":"/api/v4.0.0/party/customers/{customerId}/charges","operationId":"getCustomerCharge","name":"Retrieves customer charge for a customer with details such as tax type and tax group.","summary":"Retrieves customer charge for a specific customer.","tags":[],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"Identifier of the customer"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"CustomerChargeResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"POST","path":"/party/customers/{customerId}/charges","fullPath":"/api/v4.0.0/party/customers/{customerId}/charges","operationId":"createCustomerCharge","name":"Creates customer charge for a customer with details such as tax type and tax group.","summary":"Creates customer charge for a specific customer.","tags":[],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"Identifier of the customer"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"taxGroups":[{}]}},"responses":{"200":"CustomerChargeResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/party/customers/{customerId}/charges","fullPath":"/api/v4.0.0/party/customers/{customerId}/charges","operationId":"updateCustomerCharge","name":"Updates customer charge for a customer with details such as tax type and tax group.","summary":"Updates customer charge for a specific customer.","tags":[],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"Identifier of the customer"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"taxGroups":[{}]}},"responses":{"200":"CustomerChargeResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/party/customers/{customerId}/addresses/smsAddresses","fullPath":"/api/v4.0.0/party/customers/{customerId}/addresses/smsAddresses","operationId":"getCustomerPhoneAddress","name":"Retrieves the list of customer sms communication address with details such as name, idd prefix and mobile number.","summary":"Retrieves available list of customer sms communication addresses","tags":[],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"Identifier of the customer"},{"name":"addressId","in":"query","type":"string","required":false,"description":"Reference Id of address record"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"CustomerPhoneAddressResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"POST","path":"/party/customers/{customerId}/addresses/smsAddresses","fullPath":"/api/v4.0.0/party/customers/{customerId}/addresses/smsAddresses","operationId":"createCustomerPhoneAddress","name":"Create customer sms communication address with details such as name, idd prefix and mobile number.","summary":"Creates customer sms communication address","tags":[],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"Identifier of the customer"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"customerShortNames":[{}],"iddPrefixMobile":"string","mobileNumber":"string"}},"responses":{"200":"CustomerPhoneAddressResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/party/customers/{customerId}/addresses/emailAddresses","fullPath":"/api/v4.0.0/party/customers/{customerId}/addresses/emailAddresses","operationId":"getCustomerEmailAddress","name":"Retrieves the list of customer email communication address with details such as customer name and email references.","summary":"Retrieves available list of customer email communication addresses","tags":[],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"Identifier of the customer"},{"name":"addressId","in":"query","type":"string","required":false,"description":"Reference Id of address record"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"CustomerEmailAddressResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"POST","path":"/party/customers/{customerId}/addresses/emailAddresses","fullPath":"/api/v4.0.0/party/customers/{customerId}/addresses/emailAddresses","operationId":"createCustomerEmailAddress","name":"Create customer email communication address with details such as customer name and email references.","summary":"Creates customer email communication address","tags":[],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"Identifier of the customer"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"customerShortNames":[{}],"email":"string"}},"responses":{"200":"CustomerEmailAddressResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/party/customers/{customerId}/addresses/printAddresses","fullPath":"/api/v4.0.0/party/customers/{customerId}/addresses/printAddresses","operationId":"getCustomerPrintAddress","name":"Retrieves the list of customer print communication addresses with details such as name, address, postcode and phone number.","summary":"Retrieves available list of customer print communication addresses","tags":[],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"Identifier of the customer"},{"name":"addressId","in":"query","type":"string","required":false,"description":"Reference Id of address record"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"CustomerPrintAddressResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"POST","path":"/party/customers/{customerId}/addresses/printAddresses","fullPath":"/api/v4.0.0/party/customers/{customerId}/addresses/printAddresses","operationId":"createCustomerPrintAddress","name":"Create customer print communication address with details such as name, address, postcode and phone number.","summary":"Creates customer print communication address","tags":[],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"Identifier of the customer"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"customerShortNames":[{}],"customerNames":[{}],"addresses":[{}],"streets":[{}],"towns":[{}],"postCodes":[{}],"addressPurpose":"string","addressLocation":"string","addressVerifier":"string","countryCode":"string","departmentId":"string","subDepartmentId":"string","flatNumber":"string","buildingName":"string","buildingNumber":"string"}},"responses":{"200":"CustomerPrintAddressResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/party/customers/addresses/{customerAddressId}/smsAddresses","fullPath":"/api/v4.0.0/party/customers/addresses/{customerAddressId}/smsAddresses","operationId":"updateCustomerPhoneAddress","name":"Update customer sms communication address with details such as name, idd prefix and mobile number.","summary":"Updates customer sms communication address","tags":[],"parameters":[{"name":"customerAddressId","in":"path","type":"string","required":true,"description":"Identifier of the customer address table."},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"customerShortNames":[{}],"iddPrefixMobile":"string","mobileNumber":"string"}},"responses":{"200":"CustomerPhoneAddressResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"DELETE","path":"/party/customers/addresses/{customerAddressId}/smsAddresses","fullPath":"/api/v4.0.0/party/customers/addresses/{customerAddressId}/smsAddresses","operationId":"deleteCustomerPhoneAddress","name":"Delete the specified customer sms communication address that are no longer used.","summary":"Deletes customer sms communication address","tags":[],"parameters":[{"name":"customerAddressId","in":"path","type":"string","required":true,"description":"Identifier of the customer address table."},{"name":"payload","in":"body","type":"object","required":false,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}}},"responses":{"200":"CustomerPhoneAddressResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/party/customers/addresses/{customerAddressId}/emailAddresses","fullPath":"/api/v4.0.0/party/customers/addresses/{customerAddressId}/emailAddresses","operationId":"updateCustomerEmailAddress","name":"Update customer email communication address with details such as customer name and email references.","summary":"Updates customer email communication address","tags":[],"parameters":[{"name":"customerAddressId","in":"path","type":"string","required":true,"description":"Identifier of the customer address table."},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"customerShortNames":[{}],"email":"string"}},"responses":{"200":"CustomerEmailAddressResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"DELETE","path":"/party/customers/addresses/{customerAddressId}/emailAddresses","fullPath":"/api/v4.0.0/party/customers/addresses/{customerAddressId}/emailAddresses","operationId":"deleteCustomerEmailAddress","name":"Delete the specified customer email communication address that are no longer used.","summary":"Deletes customer email communication address","tags":[],"parameters":[{"name":"customerAddressId","in":"path","type":"string","required":true,"description":"Identifier of the customer address table."},{"name":"payload","in":"body","type":"object","required":false,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}}},"responses":{"200":"CustomerEmailAddressResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/party/customers/addresses/{customerAddressId}/printAddresses","fullPath":"/api/v4.0.0/party/customers/addresses/{customerAddressId}/printAddresses","operationId":"updateCustomerPrintAddress","name":"Update customer print communication address with details such as name, address, postcode and phone number.","summary":"Updates customer print communication address","tags":[],"parameters":[{"name":"customerAddressId","in":"path","type":"string","required":true,"description":"Identifier of the customer address table."},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"customerShortNames":[{}],"customerNames":[{}],"addresses":[{}],"streets":[{}],"towns":[{}],"postCodes":[{}],"addressPurpose":"string","addressLocation":"string","addressVerifier":"string","countryCode":"string","departmentId":"string","subDepartmentId":"string","flatNumber":"string","buildingName":"string","buildingNumber":"string"}},"responses":{"200":"CustomerPrintAddressResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"DELETE","path":"/party/customers/addresses/{customerAddressId}/printAddresses","fullPath":"/api/v4.0.0/party/customers/addresses/{customerAddressId}/printAddresses","operationId":"deleteCustomerPrintAddress","name":"Delete the specified customer print communication address that are no longer used.","summary":"Deletes customer print communication address","tags":[],"parameters":[{"name":"customerAddressId","in":"path","type":"string","required":true,"description":"Identifier of the customer address table."},{"name":"payload","in":"body","type":"object","required":false,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}}},"responses":{"200":"CustomerPrintAddressResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/party/customers/{customerId}/consents","fullPath":"/api/v4.0.0/party/customers/{customerId}/consents","operationId":"getCustomerConsents","name":"Retrieves the list of consent details for specific customer","summary":"Retrieves customer consents details","tags":[],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"Identifier of the customer"},{"name":"propertyClassId","in":"query","type":"string","required":false,"description":"The identifier of a condition that is used to build a product"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"CustomerConsentsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"POST","path":"/party/customers/{customerId}/fatca","fullPath":"/api/v4.0.0/party/customers/{customerId}/fatca","operationId":"createFatcaCustomer","name":"Creates the FATCA customer supplementary information record that stores the related FATCA details for the customer","summary":"Create FATCA customer supplementary information details","tags":[],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"Identifier of the customer"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"citizenships":[{}],"tinDetails":[{}],"Owner":[{}],"JointOwner":[{}],"fatcaClientType":"string","isPlaceOfBirthUs":"string","domicile":"string","greencardDetails":"string","residenceId":"string","isPoa":"string","standingInstructionOnUsAccount":"string","accountInstructionfromUs":"string","socialSecurityNumber":"string","phoneNumber":"string","isDormantAccount":"string"}},"responses":{"200":"FatcaCustomerResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/party/customers/{customerId}/fatca","fullPath":"/api/v4.0.0/party/customers/{customerId}/fatca","operationId":"updateFatcaCustomer","name":"Update the FATCA customer supplementary information record that stores the related FATCA details for the customer","summary":"Update FATCA customer supplementary information details","tags":[],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"Identifier of the customer"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"citizenships":[{}],"tinDetails":[{}],"Owner":[{}],"JointOwner":[{}],"fatcaClientType":"string","isPlaceOfBirthUs":"string","domicile":"string","greencardDetails":"string","residenceId":"string","isPoa":"string","standingInstructionOnUsAccount":"string","accountInstructionfromUs":"string","socialSecurityNumber":"string","phoneNumber":"string","isDormantAccount":"string"}},"responses":{"200":"FatcaCustomerResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/party/customers/{customerId}/portfolios/{portfolioId}/overdueSettlements","fullPath":"/api/v4.0.0/party/customers/{customerId}/portfolios/{portfolioId}/overdueSettlements","operationId":"getOverdueSettlements","name":"Get overdue settlement","summary":"Get overdue settlement","tags":[],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"Identifier of the customer"},{"name":"portfolioId","in":"path","type":"string","required":true,"description":"Id of the portfolio or security account"},{"name":"transactionId","in":"query","type":"string","required":false,"description":"Unique transaction identifier for retrieving the details of the transaction. For example: FT0102030333 etc."},{"name":"brokerId","in":"query","type":"string","required":false,"description":"The identifier of the broker"},{"name":"tradeDate","in":"query","type":"string","required":false,"description":"Standard date field which records trade date of the account"},{"name":"valueDate","in":"query","type":"string","required":false,"description":"Indicates the value date on which the underlying accounting entry is to be given value (for interest purposes)"},{"name":"depository","in":"query","type":"string","required":false,"description":"Person designated as depository by the company in or pursuant to this Indenture, and, unless otherwise provided with respect to any security, any successor to such person"},{"name":"currency","in":"query","type":"string","required":false,"description":"Identifies the currency. E.g. USD, GBP etc"},{"name":"instrumentId","in":"query","type":"string","required":false,"description":"The identifier of the instrument"},{"name":"deliveryInstruction","in":"query","type":"string","required":false,"description":"Customer's directions to a bank as to the disposition of funds and securities in the customer's account"},{"name":"transactionType","in":"query","type":"string","required":false,"description":"Identifies the transaction type applicable to the transaction being processed, i.e. outward or inward payment. For example: ACPX, OTPX etc."},{"name":"quantity","in":"query","type":"string","required":false,"description":"The nominal quantity"},{"name":"stockExchange","in":"query","type":"string","required":false,"description":"The stock exchange identifier"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"OverdueSettlementsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/party/customers/accountServicingProviders/","fullPath":"/api/v4.0.0/party/customers/accountServicingProviders/","operationId":"getOtherBanksToConnectTo","name":"Retrieves the list of other/external bank details","summary":"Retrieves other banks to connect to details","tags":[],"parameters":[{"name":"openBankingId","in":"query","type":"string","required":false,"description":"Identifies the open banking number of the customer"},{"name":"countryId","in":"query","type":"string","required":false,"description":"ISO country code of the financial institution. "},{"name":"setActive","in":"query","type":"string","required":false,"description":"Flag to set the connection status to active"},{"name":"status","in":"query","type":"string","required":false,"description":"Contains status of the data rights request.Allowed values are INITIATED, INPROGESS, EXTENDED, COMPLETED, REJECTED."},{"name":"extSourceProvider","in":"query","type":"string","required":false,"description":"Contains the name of the external source provider for the customer"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"OtherBanksToConnectToResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/party/customers/prospects","fullPath":"/api/v4.0.0/party/customers/prospects","operationId":"getProspectCustomers","name":"Retrieves the details such as contact information, residence details, personal details and prospect legal details of a prospect customer","summary":"Retrieves prospect customer details of a customer","tags":[],"parameters":[{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"ProspectCustomersResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"POST","path":"/party/customers/prospects","fullPath":"/api/v4.0.0/party/customers/prospects","operationId":"createProspectCustomer","name":"Create a prospect customer with basic details such as contact information, residence details and prospect legal details","summary":"Create a prospect customer","tags":[],"parameters":[{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"customerNames":[{}],"streets":[{}],"addresses":[{}],"townCountries":[{}],"postCodes":[{}],"countries":[{}],"phoneNumbers":[{}],"emails":[{}],"socialNetworkIds":[{}],"prospectLegalDetails":[{}],"personEntity":"string","departmentId":"string","subDepartmentId":"string","floorNumber":"string","locationName":"string"}},"responses":{"200":"ProspectCustomerResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/party/customers/{customerId}/opportunities","fullPath":"/api/v4.0.0/party/customers/{customerId}/opportunities","operationId":"getCustomerOpportunities","name":"Retrieves the details of sales opportunities such as score, status and product details which are likely to be of interest to specific customers","summary":"Retrieves the sales opportunities for specific customers","tags":[],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"Identifier of the customer"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"CustomerOpportunitiesResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/party/customers/{customerId}/requests","fullPath":"/api/v4.0.0/party/customers/{customerId}/requests","operationId":"getCustomerRequests","name":"Retrieves process workflow details such as process name, activity details and status for a specific customer","summary":"Retrieves process workflows for a specific customer","tags":[],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"Identifier of the customer"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"CustomerRequestsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"PUT","path":"/party/customers/prospects/{prospectId}","fullPath":"/api/v4.0.0/party/customers/prospects/{prospectId}","operationId":"updateProspectCustomer","name":"Update a prospect customer with basic details such as contact information, residence details and prospect legal details","summary":"Update the details of the prospect customer","tags":[],"parameters":[{"name":"prospectId","in":"path","type":"string","required":true,"description":"Indicates the status of an onboarding customer. Status can be PROSPECT while onboarding and ACTIVE when the prospect becomes a Customer."},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"customerNames":[{}],"streets":[{}],"addresses":[{}],"townCountries":[{}],"postCodes":[{}],"countries":[{}],"phoneNumbers":[{}],"emails":[{}],"socialNetworkIds":[{}],"prospectLegalDetails":[{}],"personEntity":"string","departmentId":"string","subDepartmentId":"string","floorNumber":"string","locationName":"string"}},"responses":{"200":"ProspectCustomerResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/party/customers/{customerId}/alertRequests","fullPath":"/api/v4.0.0/party/customers/{customerId}/alertRequests","operationId":"getAlertRequests","name":"Retrieves the alert subscription details for specific customer","summary":"Retrieves alert requests details","tags":[],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"Identifier of the customer"},{"name":"contractReference","in":"query","type":"string","required":false,"description":"Contains the contract reference"},{"name":"subscribe","in":"query","type":"string","required":false,"description":"Enables an alert service"},{"name":"alertRequestId","in":"query","type":"string","required":false,"description":"The unique identifier of the alert request."},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"AlertRequestsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}}]},{"key":"party-customerServices-v4.1.0","title":"Customer management","version":"v4.1.0","description":"API to create, update and manage customer details such as delivery preferences, joint customer details, party relationships, KYC details, customer exit status, customer address formats & posting restrictions","endpointCount":67,"endpoints":[{"method":"GET","path":"/party/customers/{customerId}","fullPath":"/api/v4.1.0/party/customers/{customerId}","operationId":"getCustomer","name":"Retrieves the customer details such as customer contact information, residence details, legal document details, occupation details and relationship details for the specific customer","summary":"Retrieves list of customer details","tags":[],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"Identifier of the customer"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"CustomerResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/party/customers/{customerId}","fullPath":"/api/v4.1.0/party/customers/{customerId}","operationId":"updateCustomer","name":"Update customer details with the information such as customer contact information, residence details, legal document details, occupation details and relationship details, etc provided by the user","summary":"Update customer details","tags":[],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"Identifier of the customer"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"displayNames":[{}],"customerNames":[{}],"communicationDevices":[{}],"faxIds":[{}],"officePhoneNumbers":[{}],"streets":[{}],"addresses":[{}],"addressCities":[{}],"countries":[{}],"legalDetails":[{}],"otherNationalityIds":[{}],"employDetails":[{}],"residenceDetails":[{}],"relationshipDetails":[{}],"postingRestrictIds":[{}]}},"responses":{"200":"CustomerResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/party/customers","fullPath":"/api/v4.1.0/party/customers","operationId":"getCustomerInformation","name":"Retrieves the customer details such as delivery or postal details, contact information, residence details, customer profile, legal document details, occupation details and status of customer","summary":"Retrieves list of customer basic details","tags":[],"parameters":[{"name":"customerId","in":"query","type":"string","required":false,"description":"Identifier of the customer"},{"name":"customerIdCT","in":"query","type":"string","required":false,"description":"Indicates the criteria for the contains operation on the customer Id"},{"name":"customerIdBW","in":"query","type":"string","required":false,"description":"Indicates the criteria for the between operation on the customer Id"},{"name":"customerIdMT","in":"query","type":"string","required":false,"description":"Indicates the criteria for the matches operation on the customer Id"},{"name":"customerName","in":"query","type":"string","required":false,"description":"Name of the customer"},{"name":"customerNameCT","in":"query","type":"string","required":false,"description":"Indicates the criteria for the contains operation on the customer name"},{"name":"customerNameBW","in":"query","type":"string","required":false,"description":"Indicates the criteria for the between operation on the customer name"},{"name":"customerNameMT","in":"query","type":"string","required":false,"description":"Indicates the criteria for the matches operation on the customer name"},{"name":"street","in":"query","type":"string","required":false,"description":"Contains the first line of customer's base address, example building number, street number etc."},{"name":"streetCT","in":"query","type":"string","required":false,"description":"Indicates the criteria for the contains operation on the street"},{"name":"streetBW","in":"query","type":"string","required":false,"description":"Indicates the criteria for the between operation on the street"},{"name":"streetMT","in":"query","type":"string","required":false,"description":"Indicates the criteria for the matches operation on the street"},{"name":"addressCity","in":"query","type":"string","required":false,"description":"The town and/or city component of the base address of a customer"},{"name":"addressCityCT","in":"query","type":"string","required":false,"description":"Indicates the criteria for the contains operation on the town country"},{"name":"addressCityBW","in":"query","type":"string","required":false,"description":"Indicates the criteria for the between operation on the town country"},{"name":"addressCityMT","in":"query","type":"string","required":false,"description":"Indicates the criteria for the matches operation on the town country"},{"name":"countryId","in":"query","type":"string","required":false,"description":"ISO country code of the financial institution. "},{"name":"countryIdCT","in":"query","type":"string","required":false,"description":"Indicates the criteria for the contains operation on the country"},{"name":"countryIdBW","in":"query","type":"string","required":false,"description":"Indicates the criteria for the between operation on the country"},{"name":"countryIdMT","in":"query","type":"string","required":false,"description":"Indicates the criteria for the matches operation on the country"},{"name":"postCode","in":"query","type":"string","required":false,"description":"Identifies the address postal code for the customer."},{"name":"postCodeCT","in":"query","type":"string","required":false,"description":"Indicates the criteria for the contains operation on the post code"},{"name":"postCodeBW","in":"query","type":"string","required":false,"description":"Indicates the criteria for the between operation on the post code"},{"name":"postCodeMT","in":"query","type":"string","required":false,"description":"Indicates the criteria for the matches operation on the post code"},{"name":"dateOfBirth","in":"query","type":"string","required":false,"description":"The date of birth of an individual customer"},{"name":"dateOfBirthCT","in":"query","type":"string","required":false,"description":"Indicates the criteria for the contains operation on the date of birth"},{"name":"dateOfBirthBW","in":"query","type":"string","required":false,"description":"Indicates the criteria for the between operation on the date of birth"},{"name":"dateOfBirthMT","in":"query","type":"string","required":false,"description":"Indicates the criteria for the matches operation on the date of birth"},{"name":"customerStatus","in":"query","type":"string","required":false,"description":"The internal bank status of a customer"},{"name":"customerStatusCT","in":"query","type":"string","required":false,"description":"Indicates the criteria for the contains operation on the customer status"},{"name":"customerStatusBW","in":"query","type":"string","required":false,"description":"Indicates the criteria for the between operation on the customer status"},{"name":"customerStatusMT","in":"query","type":"string","required":false,"description":"Indicates the criteria for the matches operation on the customer status"},{"name":"sectorId","in":"query","type":"string","required":false,"description":"An institution-defined identifier of the type of customer"},{"name":"sectorIdCT","in":"query","type":"string","required":false,"description":"Indicates the criteria for the contains operation on the sector"},{"name":"sectorIdBW","in":"query","type":"string","required":false,"description":"Indicates the criteria for the between operation on the sector"},{"name":"sectorIdMT","in":"query","type":"string","required":false,"description":"Indicates the criteria for the matches operation on the sector"},{"name":"accountOfficerId","in":"query","type":"string","required":false,"description":"The identifier of the department head or specific account officer responsible for the customer"},{"name":"accountOfficerIdBW","in":"query","type":"string","required":false,"description":"Indicates the criteria for the between operation on the account officer"},{"name":"accountOfficerIdCT","in":"query","type":"string","required":false,"description":"Indicates the criteria for the contains operation on the account officer"},{"name":"accountOfficerIdMT","in":"query","type":"string","required":false,"description":"Indicates the criteria for the matches operation on the account officer"},{"name":"industryId","in":"query","type":"string","required":false,"description":"An institution-defined identifier of the industry in which the customer is trading, operating or is associated with"},{"name":"industryIdBW","in":"query","type":"string","required":false,"description":"Indicates the criteria for the between operation on the industry"},{"name":"industryIdCT","in":"query","type":"string","required":false,"description":"Indicates the criteria for the contains operation on the industry"},{"name":"industryIdMT","in":"query","type":"string","required":false,"description":"Indicates the criteria for the matches operation on the industry"},{"name":"nationalityId","in":"query","type":"string","required":false,"description":"The identifier of the nationality of a customer"},{"name":"nationalityIdBW","in":"query","type":"string","required":false,"description":"Indicates the criteria for the between operation on the nationality"},{"name":"nationalityIdCT","in":"query","type":"string","required":false,"description":"Indicates the criteria for the contains operation on the nationality"},{"name":"nationalityIdMT","in":"query","type":"string","required":false,"description":"Indicates the criteria for the matches operation on the nationality"},{"name":"residenceId","in":"query","type":"string","required":false,"description":"The identifier of the country of residence of a customer"},{"name":"residenceIdMT","in":"query","type":"string","required":false,"description":"Indicates the criteria for the matches operation on the residence"},{"name":"residenceIdCT","in":"query","type":"string","required":false,"description":"Indicates the criteria for the contains operation on the residence"},{"name":"residenceIdBW","in":"query","type":"string","required":false,"description":"Indicates the criteria for the between operation on the residence"},{"name":"lastName","in":"query","type":"string","required":false,"description":"The last name of an individual customer"},{"name":"lastNameCT","in":"query","type":"string","required":false,"description":"Indicates the criteria for the contains operation on the family name"},{"name":"lastNameBW","in":"query","type":"string","required":false,"description":"Indicates the criteria for the between operation on the family name"},{"name":"lastNameMT","in":"query","type":"string","required":false,"description":"Indicates the criteria for the matches operation on the family name"},{"name":"phoneNumber","in":"query","type":"string","required":false,"description":"The phone number of the customer or prospect"},{"name":"phoneNumberCT","in":"query","type":"string","required":false,"description":"Indicates the criteria for the contains operation on the phone number"},{"name":"phoneNumberMT","in":"query","type":"string","required":false,"description":"Indicates the criteria for the matches operation on the phone number"},{"name":"phoneNumberBW","in":"query","type":"string","required":false,"description":"Indicates the criteria for the between operation on the phone number"},{"name":"customerMnemonic","in":"query","type":"string","required":false,"description":"Specifies an alternative easy means of referencing the Customer"},{"name":"customerMnemonicCT","in":"query","type":"string","required":false,"description":"Indicates the criteria for the contains operation on the customer mnemonic"},{"name":"customerMnemonicBW","in":"query","type":"string","required":false,"description":"Indicates the criteria for the between operation on the customer mnemonic"},{"name":"customerMnemonicMT","in":"query","type":"string","required":false,"description":"Indicates the criteria for the matches operation on the customer mnemonic"},{"name":"firstName","in":"query","type":"string","required":false,"description":"Specifies customer's first name"},{"name":"firstNameBW","in":"query","type":"string","required":false,"description":"Indicates the criteria for the between operation on the first name"},{"name":"firstNameMT","in":"query","type":"string","required":false,"description":"Indicates the criteria for the matches operation on the first name"},{"name":"firstNameCT","in":"query","type":"string","required":false,"description":"Indicates the criteria for the contains operation on the first name"},{"name":"customerType","in":"query","type":"string","required":false,"description":"Contains the type of customer, for example ACTIVE, PROSPECT."},{"name":"customerTypeCT","in":"query","type":"string","required":false,"description":"Indicates the criteria for the contains operation on the customer type"},{"name":"customerTypeBW","in":"query","type":"string","required":false,"description":"Indicates the criteria for the between operation on the customer type"},{"name":"customerTypeMT","in":"query","type":"string","required":false,"description":"Indicates the criteria for the matches operation on the customer type"},{"name":"email","in":"query","type":"string","required":false,"description":"Email Identifier of the Customer"},{"name":"emailCT","in":"query","type":"string","required":false,"description":"Indicates the criteria for the contains operation on the emails"},{"name":"emailMT","in":"query","type":"string","required":false,"description":"Indicates the criteria for the matches operation on the emails"},{"name":"emailBW","in":"query","type":"string","required":false,"description":"Indicates the criteria for the between operation on the emails"},{"name":"mobilePhoneNumber","in":"query","type":"string","required":false,"description":"Represents the phone number of a customer"},{"name":"mobilePhoneNumberCT","in":"query","type":"string","required":false,"description":"Indicates the criteria for the contains operation on the mobile numbers"},{"name":"mobilePhoneNumberBW","in":"query","type":"string","required":false,"description":"Indicates the criteria for the between operation on the mobile numbers"},{"name":"mobilePhoneNumberMT","in":"query","type":"string","required":false,"description":"Indicates the criteria for the matches operation on the mobile numbers"},{"name":"taxId","in":"query","type":"string","required":false,"description":"Holds the Customer's TAX/SSN Id."},{"name":"taxIdCT","in":"query","type":"string","required":false,"description":"Indicates the criteria for the contains operation on the tax Id"},{"name":"taxIdBW","in":"query","type":"string","required":false,"description":"Indicates the criteria for the between operation on the tax Id"},{"name":"taxIdMT","in":"query","type":"string","required":false,"description":"Indicates the criteria for the matches operation on the tax Id"},{"name":"shortName","in":"query","type":"string","required":false,"description":"Contains the name of the account, basically the short title of the account."},{"name":"shortNameCT","in":"query","type":"string","required":false,"description":"Indicates the criteria for the contains operation on the short name"},{"name":"shortNameBW","in":"query","type":"string","required":false,"description":"Indicates the criteria for the between operation on the short name"},{"name":"shortNameMT","in":"query","type":"string","required":false,"description":"Indicates the criteria for the matches operation on the short name"},{"name":"officePhoneNumber","in":"query","type":"string","required":false,"description":"The office phone number of the customer"},{"name":"officePhoneNumberCT","in":"query","type":"string","required":false,"description":"Indicates the criteria for the contains operation on the office phone numbers"},{"name":"officePhoneNumberBW","in":"query","type":"string","required":false,"description":"Indicates the criteria for the between operation on the office phone numbers"},{"name":"officePhoneNumberMT","in":"query","type":"string","required":false,"description":"Indicates the criteria for the matches operation on the office phone numbers"},{"name":"faxId","in":"query","type":"string","required":false,"description":"The fax (facsimile) number of the customer"},{"name":"faxIdBW","in":"query","type":"string","required":false,"description":"Indicates the criteria for the between operation on the fax Id"},{"name":"faxIdCT","in":"query","type":"string","required":false,"description":"Indicates the criteria for the contains operation on the fax Id"},{"name":"faxIdMT","in":"query","type":"string","required":false,"description":"Indicates the criteria for the matches operation on the fax Id"},{"name":"address","in":"query","type":"string","required":false,"description":"Communication Address of the Customer"},{"name":"addressCT","in":"query","type":"string","required":false,"description":"Indicates the criteria for the contains operation on the address"},{"name":"addressBW","in":"query","type":"string","required":false,"description":"Indicates the criteria for the between operation on the address"},{"name":"addressMT","in":"query","type":"string","required":false,"description":"Indicates the criteria for the matches operation on the address"},{"name":"relCustomer","in":"query","type":"string","required":false,"description":"Customers linked or related to the arrangement owner"},{"name":"relCustomerBW","in":"query","type":"string","required":false,"description":"Indicates the criteria for the between operation on the related customer Id"},{"name":"relCustomerCT","in":"query","type":"string","required":false,"description":"Indicates the criteria for the contains operation on the related customer Id"},{"name":"relCustomerMT","in":"query","type":"string","required":false,"description":"Indicates the criteria for the matches operation on the related customer Id"},{"name":"relationshipCode","in":"query","type":"string","required":false,"description":"Relationship identifier between the partyType and relatedPartyType"},{"name":"relationshipCodeBW","in":"query","type":"string","required":false,"description":"Indicates the criteria for the between operation on the relationship code"},{"name":"relationshipCodeMT","in":"query","type":"string","required":false,"description":"Indicates the criteria for the matches operation on the relationship code"},{"name":"relationshipCodeCT","in":"query","type":"string","required":false,"description":"Indicates the criteria for the contains operation on the relationship code"},{"name":"legalId","in":"query","type":"string","required":false,"description":"Unique reference number of the legal documents submitted as identification proof"},{"name":"legalDocumentName","in":"query","type":"string","required":false,"description":"Name of the legal documents such as passport, driving licence etc., provided as identification proof"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"CustomerInformationResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"POST","path":"/party/customers","fullPath":"/api/v4.1.0/party/customers","operationId":"createCustomer","name":"Create a customer with the information such as customer contact information, residence details, legal document details, occupation details and relationship details, etc provided by the user","summary":"Create a customer","tags":[],"parameters":[{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"displayNames":[{}],"customerNames":[{}],"communicationDevices":[{}],"faxIds":[{}],"officePhoneNumbers":[{}],"streets":[{}],"addresses":[{}],"addressCities":[{}],"countries":[{}],"legalDetails":[{}],"otherNationalityIds":[{}],"employDetails":[{}],"residenceDetails":[{}],"relationshipDetails":[{}],"postingRestrictIds":[{}]}},"responses":{"200":"CustomerResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/party/customers/relationships","fullPath":"/api/v4.1.0/party/customers/relationships","operationId":"getCustomerRelationship","name":"Retrieves customer relationship details such as type of relationship, party information, relatedAs details, owning details, role & purpose of relationship for specific party or customer","summary":"Retrieves list of customer relationships","tags":[],"parameters":[{"name":"customerRelationGroupId","in":"query","type":"string","required":false,"description":"Identifies the key to Customer Relationship Group to form a relation"},{"name":"partyId","in":"query","type":"string","required":false,"description":"Allows capturing of customers or person entities to be part of the relationship. If partyType is selected as Customer, then the system will allow only customer Ids to be captured into this field. If p"},{"name":"relatedPartyId","in":"query","type":"string","required":false,"description":"Identifier of the Related Party"},{"name":"relationId","in":"query","type":"string","required":false,"description":"Identifier of the Customer Relationship and Party Relationship"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"CustomerRelationshipResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"POST","path":"/party/customers/relationships","fullPath":"/api/v4.1.0/party/customers/relationships","operationId":"createCustomerRelationship","name":"Create a customer relationship for a customer with details such as type of relationship, party information, relatedAs details, owning details, role & purpose of relationship","summary":"Create customer relationship with other customers","tags":[],"parameters":[{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"originatingRelation":[{}],"customerRelationGroupId":0.0,"customerRelationGroupName":"string","purposeOfRelationship":"string"}},"responses":{"200":"CustomerRelationshipResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/party/customers/relationships/{relationId}","fullPath":"/api/v4.1.0/party/customers/relationships/{relationId}","operationId":"updateCustomerRelationship","name":"Update customer relationship for a customer with details such as type of relationship, party information, related details, owning details, role & purpose of relationship","summary":"Update customer relationship","tags":[],"parameters":[{"name":"relationId","in":"path","type":"string","required":true,"description":"Identifier of the Customer Relationship and Party Relationship"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"originatingRelation":[{}],"customerRelationGroupId":0.0,"customerRelationGroupName":"string","purposeOfRelationship":"string"}},"responses":{"200":"CustomerRelationshipResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/party/customers/reportingStatus","fullPath":"/api/v4.1.0/party/customers/reportingStatus","operationId":"getCustomerReportingStatus","name":"Retrieves the FATCA/CRS reporting status and reporting jurisdiction of the customer","summary":"Retrieves reporting status of the customer","tags":[],"parameters":[{"name":"customerId","in":"query","type":"string","required":true,"description":"Identifier of the customer"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"CustomerReportingStatusResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/party/customers/{customerId}/sweeps","fullPath":"/api/v4.1.0/party/customers/{customerId}/sweeps","operationId":"getCustomerSweeps","name":"Retrieves account sweep details such as sweep reference, type, balance requirements for sweep & frequency of sweep for the list of accounts available to a customer","summary":"Retrieves account sweep details of the specific customer","tags":[],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"Identifier of the customer"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"CustomerSweepsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/party/customers/{customerId}/deliveryOptions","fullPath":"/api/v4.1.0/party/customers/{customerId}/deliveryOptions","operationId":"getCustomerDeliveryOptions","name":"Retrieves the delivery preferences of the customer such as the message group, carrier and address.","summary":"Retrieves delivery preferences of the customer","tags":[],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"Identifier of the customer"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"CustomerDeliveryOptionsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/party/customers/{customerId}/channels","fullPath":"/api/v4.1.0/party/customers/{customerId}/channels","operationId":"getCustomerDigitalChannels","name":"Retrieves the list of message channels such as internet banking, mobile banking, ATM, etc available for the specific customer","summary":"Retrieves list of message channels","tags":[],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"Identifier of the customer"},{"name":"channelName","in":"query","type":"string","required":false,"description":"Name of the (digital) channel registered by the Customer"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"CustomerDigitalChannelsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"POST","path":"/party/customers/messages","fullPath":"/api/v4.1.0/party/customers/messages","operationId":"createMessages","name":"Create a new secure message for a customer to be sent by bank","summary":"Create a new secure message for a customer","tags":[],"parameters":[{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"messages":[{}],"subject":"string","toCustomerId":"string"}},"responses":{"200":"MessagesResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/party/customers/{customerId}/jointCustomers","fullPath":"/api/v4.1.0/party/customers/{customerId}/jointCustomers","operationId":"getJointCustomerDetails","name":"Retrieves details such as joint relation code, name, joint customer details and reverse relationships for a specific customer","summary":"Retrieves joint customer details for a specific customer","tags":[],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"Identifier of the customer"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"JointCustomerDetailsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/party/customers/{customerId}/KYC","fullPath":"/api/v4.1.0/party/customers/{customerId}/KYC","operationId":"getCustomerKYCDetails","name":"Retrieves the KYC details such as contact date, introducer, last and next review date, KYC and AML status of a customer","summary":"Retrieves KYC details for a specific customer","tags":[],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"Identifier of the customer"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"CustomerKYCDetailsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/party/customers/{customerId}/personalProfiles","fullPath":"/api/v4.1.0/party/customers/{customerId}/personalProfiles","operationId":"getCustomerPersonalDetails","name":"Retrieves personal details such as residence, communication details, occupation details, asset & liability information","summary":"Retrieves personal details of customer","tags":[],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"Identifier of the customer"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"CustomerPersonalDetailsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/party/customers/postingRestrictions","fullPath":"/api/v4.1.0/party/customers/postingRestrictions","operationId":"getCustomerPostingRestrictions","name":"Retrieves the credit and debit posting restriction details such as restriction reference and name of restriction set for a customer","summary":"Retrieves posting restriction details","tags":[],"parameters":[{"name":"customerId","in":"query","type":"string","required":false,"description":"Identifier of the customer"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"CustomerPostingRestrictionsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"POST","path":"/party/relationships/{relationId}","fullPath":"/api/v4.1.0/party/relationships/{relationId}","operationId":"createPartyRelationship","name":"Create a party relationship between a person, entity or customer with details such as party name, type, relatedAs, relation code and owning details","summary":"Create party relationship details","tags":[],"parameters":[{"name":"relationId","in":"path","type":"string","required":true,"description":"Identifier of the Customer Relationship and Party Relationship"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"partyDisplayNames":[{}],"partyRelationships":[{}]}},"responses":{"200":"PartyRelationshipResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/party/relationships/{relationId}","fullPath":"/api/v4.1.0/party/relationships/{relationId}","operationId":"updatePartyRelationship","name":"Update party relationship between a person, entity or customer with details such as party name, type, relatedAs, relation code and owning details","summary":"Update party relationship details","tags":[],"parameters":[{"name":"relationId","in":"path","type":"string","required":true,"description":"Identifier of the Customer Relationship and Party Relationship"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"partyDisplayNames":[{}],"partyRelationships":[{}]}},"responses":{"200":"PartyRelationshipResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/party/customers/{customerId}/cards","fullPath":"/api/v4.1.0/party/customers/{customerId}/cards","operationId":"getCustomerCreditCards","name":"Retrieves the card details such as card number, card type and status, linked account and its balances of a customer","summary":"Retrieves card details of a customer","tags":[],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"Identifier of the customer"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"CustomerCreditCardsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/party/customers/{customerId}/standingOrders","fullPath":"/api/v4.1.0/party/customers/{customerId}/standingOrders","operationId":"getStandingOrders","name":"Retrieves the list of standing instructions for a customer with details such as instruction reference, order type, frequency of payments, mode of payment and credit & debit parties involved","summary":"Retrieves standing instruction details of a customer","tags":[],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"Identifier of the customer"},{"name":"standingOrderId","in":"query","type":"string","required":false,"description":"The unique standing order identifier"},{"name":"accountId","in":"query","type":"string","required":false,"description":"Identifier of the account. Often referred to as the account number, yet for consistency this is always referred to as accountId. Accepts both IBAN & BBAN"},{"name":"orderingCustomerId","in":"query","type":"string","required":false,"description":"Indicates the customer id for the ordering customer"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"StandingOrdersResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/party/customers/{customerId}/directDebits","fullPath":"/api/v4.1.0/party/customers/{customerId}/directDebits","operationId":"getDirectDebits","name":"Retrieves the list of direct debits for a customer with details such as direct debit reference, debit & credit accounts, transaction amount, payment frequency, next payment date and direction of payment","summary":"Retrieves direct debits details of a customer","tags":[],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"Identifier of the customer"},{"name":"directDebitId","in":"query","type":"string","required":false,"description":"The unique identifier of the direct debit mandate. "},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"DirectDebitsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"POST","path":"/party/customers/deliveryPreferences/{deliveryPreferenceId}","fullPath":"/api/v4.1.0/party/customers/deliveryPreferences/{deliveryPreferenceId}","operationId":"createDeliveryPreference","name":"Creates delivery preferences for a customer or account with message group, carrier, role, address, email details and format of messages","summary":"Create customer delivery preferences","tags":[],"parameters":[{"name":"deliveryPreferenceId","in":"path","type":"string","required":true,"description":"Identifier of the customer delivery preferences"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"messageGroup":[{}],"otherMessagesDetail":[{}],"applyOtherMessages":"string"}},"responses":{"200":"DeliveryPreferenceResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/party/customers/deliveryPreferences/{deliveryPreferenceId}","fullPath":"/api/v4.1.0/party/customers/deliveryPreferences/{deliveryPreferenceId}","operationId":"updateDeliveryPreference","name":"Update delivery preferences for a  customer or account with message group, carrier, role, address & email details, format of messages","summary":"Update customer deliver preferences","tags":[],"parameters":[{"name":"deliveryPreferenceId","in":"path","type":"string","required":true,"description":"Identifier of the customer delivery preferences"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"messageGroup":[{}],"otherMessagesDetail":[{}],"applyOtherMessages":"string"}},"responses":{"200":"DeliveryPreferenceResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/party/customers/limits/{limitId}","fullPath":"/api/v4.1.0/party/customers/limits/{limitId}","operationId":"updateLimit","name":"Updates the limit details such as currency, limit grade, commodity, country and limit product details","summary":"Update credit limit details for customer","tags":[],"parameters":[{"name":"limitId","in":"path","type":"string","required":true,"description":"The identifier of credit limit"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"countries":[{}],"grades":[{}],"commodities":[{}],"currencyId":"string","onlineLimitDate":"2024-01-01","availableMarker":"string","allowNetting":"string","onlineUpdate":"string","limitProductId":"string","checkLimit":"string","band":"string","reducingLimit":"string","internalAmount":"string"}},"responses":{"200":"LimitResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/party/customers/{customerId}/customerExitStatus","fullPath":"/api/v4.1.0/party/customers/{customerId}/customerExitStatus","operationId":"getCustomerExitStatus","name":"Retrieves customer exit status details such as customer type, exit date, status and reason","summary":"Retrieves customer exit status details of customer","tags":[],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"Identifier of the customer"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"CustomerExitStatusResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"PUT","path":"/party/customers/{customerId}/customerExitStatus","fullPath":"/api/v4.1.0/party/customers/{customerId}/customerExitStatus","operationId":"updateCustomerExitStatus","name":"Update a customer record with exit status and exit reason marking the customer as blocked or rejected or closed","summary":"Update customer exit status details of customers","tags":[],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"Identifier of the customer"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"exitStatus":"string","exitReason":"string"}},"responses":{"200":"CustomerExitStatusResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/party/customers/settings/customerExitStatus/{customerExitStatusId}","fullPath":"/api/v4.1.0/party/customers/settings/customerExitStatus/{customerExitStatusId}","operationId":"getCustomerExitStatusParam","name":"Retrieves available conditions such as customer exit setup reference, allowed reasons and allowed re-open details to update customer exit status of customers","summary":"Retrieves conditions to update customer exit status of customer","tags":[],"parameters":[{"name":"customerExitStatusId","in":"path","type":"string","required":true,"description":"The field reflects the exit status ID of a customer or prospect from the parameterization table CUSTOMER.EXIT.STATUS"},{"name":"customerType","in":"query","type":"string","required":false,"description":"Contains the type of customer, for example ACTIVE, PROSPECT."},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"CustomerExitStatusParamResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"POST","path":"/party/customers/settings/customerExitStatus/{customerExitStatusId}","fullPath":"/api/v4.1.0/party/customers/settings/customerExitStatus/{customerExitStatusId}","operationId":"createCustomerExitStatusParam","name":"Create conditions such as applicable customer type and allowed reasons to update the customer exit status details of customers","summary":"Create conditions to update customer exit status of customer","tags":[],"parameters":[{"name":"customerExitStatusId","in":"path","type":"string","required":true,"description":"The field reflects the exit status ID of a customer or prospect from the parameterization table CUSTOMER.EXIT.STATUS"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"allowedExitReasons":[{}],"exitStatusDescription":"string","customerType":"string","allowRemoveExitStatus":"string"}},"responses":{"200":"CustomerExitStatusParamResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/party/customers/settings/{customerExitStatusId}/customerExitStatus","fullPath":"/api/v4.1.0/party/customers/settings/{customerExitStatusId}/customerExitStatus","operationId":"updateCustomerExitStatusParam","name":"Create conditions such as applicable customer type and allowed reasons to update the customer exit status details of customers","summary":"Create conditions to update customer exit status of customer","tags":[],"parameters":[{"name":"customerExitStatusId","in":"path","type":"string","required":true,"description":"The field reflects the exit status ID of a customer or prospect from the parameterization table CUSTOMER.EXIT.STATUS"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"allowedExitReasons":[{}],"exitStatusDescription":"string","customerType":"string","allowRemoveExitStatus":"string"}},"responses":{"200":"CustomerExitStatusParamResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/party/customers/{customerId}/addresses","fullPath":"/api/v4.1.0/party/customers/{customerId}/addresses","operationId":"getCustomerAddressOutput","name":"Returns structured/unstructured address details of specified customer based on address option in request. When structured format is requested, the values are returned in format of structured data name combined with corresponding customer address value. When unstructured format is requested, the address details are returned based on configured unstructured address format.","summary":"Retrieves structured/ unstructured address format of customer","tags":[],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"Identifier of the customer"},{"name":"addressOption","in":"query","type":"string","required":false,"description":"It reflects the preference for the customer address format, respective structured, unstructured or both"},{"name":"addressOutputFormat","in":"query","type":"string","required":false,"description":"It identifies the address output format for the unstructured address"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"CustomerAddressOutputResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/party/customers/{customerId}/shortNames","fullPath":"/api/v4.1.0/party/customers/{customerId}/shortNames","operationId":"getCustomerShortNames","name":"API to get the customer short name that can be used as customer enrichment by any application","summary":"Retrieves customer short name","tags":[],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"Identifier of the customer"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"CustomerShortNamesResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/party/customers/{customerId}/mandates","fullPath":"/api/v4.1.0/party/customers/{customerId}/mandates","operationId":"getCustomerMandates","name":"Retrieves the mandate instruction details such as application eligible for mandate process and the corresponding mandate rule that is being applied to check mandates for transactions involving the specified customer.","summary":"Retrieves mandate instruction applicable for the requested customer","tags":[],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"Identifier of the customer"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"CustomerMandatesResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/party/customers/{customerId}/documents","fullPath":"/api/v4.1.0/party/customers/{customerId}/documents","operationId":"getCustomerLegalDocuments","name":"Retrieves the details of legal document provided by the customer such as document name, document id, issue date, expiry date and authority who issued the document.","summary":"Retrieves the customer legal document details","tags":[],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"Identifier of the customer"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"CustomerLegalDocumentsResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/party/customers/{customerId}/profiles","fullPath":"/api/v4.1.0/party/customers/{customerId}/profiles","operationId":"getCustomerProfile","name":"Retrieves the customer basic details such as personal information, address location, basic contact details and other general information.","summary":"Retrieves profile details of the requested customer","tags":[],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"CustomerProfileResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/party/customers/alternateReferences/{alternateReference}","fullPath":"/api/v4.1.0/party/customers/alternateReferences/{alternateReference}","operationId":"getCustomerId","name":"Retrieves the customer identifier for the provided alternate reference of the customer","summary":"Retrieves customer id for the given alternate reference","tags":[],"parameters":[{"name":"alternateReference","in":"path","type":"string","required":true,"description":"If the new Account to be created is a shadow of another Account already exisitng in another system, then the Account reference of that system can be specified here. The value given in this field will "},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"CustomerIdResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/party/customers/{customerId}/restrictions","fullPath":"/api/v4.1.0/party/customers/{customerId}/restrictions","operationId":"getCustomerRestrictions","name":"Retrieves the transaction restrictions imposed on the customer specified. Restrictions can be post no entries, black listed customer, pending KYC due reasons for restricting transactions on this customer","summary":"Retrieves the restriction details","tags":[],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"CustomerRestrictionsResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/party/customers/{customerId}/contacts","fullPath":"/api/v4.1.0/party/customers/{customerId}/contacts","operationId":"getCustomerContacts","name":"Retrieves the contact details such as phone number, mobile numbers, fax and email address specific to the requested customer","summary":"Retrieves the customer contact details","tags":[],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"Identifier of the customer"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"CustomerContactsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/party/customers/{customerId}/relationships","fullPath":"/api/v4.1.0/party/customers/{customerId}/relationships","operationId":"getCustomerRelationships","name":"Retrieves the relationship details such as related customer and the relationship that exists with the requested customer","summary":"Retrieves the relation customers","tags":[],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"CustomerRelationshipsResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/party/customers/{customerId}/payments","fullPath":"/api/v4.1.0/party/customers/{customerId}/payments","operationId":"getPartyBasicDetails","name":"Retrieves the customer information that are required for processing or validating the customer involved in a payment transaction. Provides the information such as customer name details, birth details, address details,  market sector, target, nationality, residence country and preferred language for communication.","summary":"Retrieves customer details required for payment processing","tags":[],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"Identifier of the customer"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"PartyBasicDetailsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/party/customers/{customerId}/addresses/swiftAddresses/{addressId}","fullPath":"/api/v4.1.0/party/customers/{customerId}/addresses/swiftAddresses/{addressId}","operationId":"getCustomerSwiftAddress","name":"Retrieves the SWIFT address details such as delivery address, short name & tag25 indicator for the customer.","summary":"Retrieves the SWIFT address details for the customer.","tags":[],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"Identifier of the customer"},{"name":"addressId","in":"path","type":"string","required":true,"description":"Reference Id of address record"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"CustomerSwiftAddressResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/party/relationships/{partyId}/relations","fullPath":"/api/v4.1.0/party/relationships/{partyId}/relations","operationId":"getPartyRelationship","name":"Retrieves the relationship details such as party name, type, relation code of a customers involved in a relationship","summary":"Retrieves list of party relationship details","tags":[],"parameters":[{"name":"partyId","in":"path","type":"string","required":true,"description":"Allows capturing of customers or person entities to be part of the relationship. If partyType is selected as Customer, then the system will allow only customer Ids to be captured into this field. If p"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"PartyRelationshipResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/party/customers/{customerId}/charges","fullPath":"/api/v4.1.0/party/customers/{customerId}/charges","operationId":"getCustomerCharge","name":"Retrieves customer charge for a customer with details such as tax type and tax group.","summary":"Retrieves customer charge for a specific customer.","tags":[],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"Identifier of the customer"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"CustomerChargeResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"POST","path":"/party/customers/{customerId}/charges","fullPath":"/api/v4.1.0/party/customers/{customerId}/charges","operationId":"createCustomerCharge","name":"Creates customer charge for a customer with details such as tax type and tax group.","summary":"Creates customer charge for a specific customer.","tags":[],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"Identifier of the customer"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"taxGroups":[{}]}},"responses":{"200":"CustomerChargeResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/party/customers/{customerId}/charges","fullPath":"/api/v4.1.0/party/customers/{customerId}/charges","operationId":"updateCustomerCharge","name":"Updates customer charge for a customer with details such as tax type and tax group.","summary":"Updates customer charge for a specific customer.","tags":[],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"Identifier of the customer"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"taxGroups":[{}]}},"responses":{"200":"CustomerChargeResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/party/customers/{customerId}/addresses/smsAddresses","fullPath":"/api/v4.1.0/party/customers/{customerId}/addresses/smsAddresses","operationId":"getCustomerPhoneAddress","name":"Retrieves the list of customer sms communication address with details such as name, idd prefix and mobile number.","summary":"Retrieves available list of customer sms communication addresses","tags":[],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"Identifier of the customer"},{"name":"addressId","in":"query","type":"string","required":false,"description":"Reference Id of address record"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"CustomerPhoneAddressResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"POST","path":"/party/customers/{customerId}/addresses/smsAddresses","fullPath":"/api/v4.1.0/party/customers/{customerId}/addresses/smsAddresses","operationId":"createCustomerPhoneAddress","name":"Create customer sms communication address with details such as name, idd prefix and mobile number.","summary":"Creates customer sms communication address","tags":[],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"Identifier of the customer"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"customerShortNames":[{}],"iddPrefixMobile":"string","mobileNumber":"string"}},"responses":{"200":"CustomerPhoneAddressResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/party/customers/{customerId}/addresses/emailAddresses","fullPath":"/api/v4.1.0/party/customers/{customerId}/addresses/emailAddresses","operationId":"getCustomerEmailAddress","name":"Retrieves the list of customer email communication address with details such as customer name and email references.","summary":"Retrieves available list of customer email communication addresses","tags":[],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"Identifier of the customer"},{"name":"addressId","in":"query","type":"string","required":false,"description":"Reference Id of address record"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"CustomerEmailAddressResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"POST","path":"/party/customers/{customerId}/addresses/emailAddresses","fullPath":"/api/v4.1.0/party/customers/{customerId}/addresses/emailAddresses","operationId":"createCustomerEmailAddress","name":"Create customer email communication address with details such as customer name and email references.","summary":"Creates customer email communication address","tags":[],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"Identifier of the customer"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"customerShortNames":[{}],"email":"string"}},"responses":{"200":"CustomerEmailAddressResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/party/customers/{customerId}/addresses/printAddresses","fullPath":"/api/v4.1.0/party/customers/{customerId}/addresses/printAddresses","operationId":"getCustomerPrintAddress","name":"Retrieves the list of customer print communication addresses with details such as name, address, postcode and phone number.","summary":"Retrieves available list of customer print communication addresses","tags":[],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"Identifier of the customer"},{"name":"addressId","in":"query","type":"string","required":false,"description":"Reference Id of address record"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"CustomerPrintAddressResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"POST","path":"/party/customers/{customerId}/addresses/printAddresses","fullPath":"/api/v4.1.0/party/customers/{customerId}/addresses/printAddresses","operationId":"createCustomerPrintAddress","name":"Create customer print communication address with details such as name, address, postcode and phone number.","summary":"Creates customer print communication address","tags":[],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"Identifier of the customer"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"customerShortNames":[{}],"customerNames":[{}],"addresses":[{}],"streets":[{}],"towns":[{}],"postCodes":[{}],"addressPurpose":"string","addressLocation":"string","addressVerifier":"string","countryCode":"string","departmentId":"string","subDepartmentId":"string","flatNumber":"string","buildingName":"string","buildingNumber":"string"}},"responses":{"200":"CustomerPrintAddressResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/party/customers/addresses/{customerAddressId}/smsAddresses","fullPath":"/api/v4.1.0/party/customers/addresses/{customerAddressId}/smsAddresses","operationId":"updateCustomerPhoneAddress","name":"Update customer sms communication address with details such as name, idd prefix and mobile number.","summary":"Updates customer sms communication address","tags":[],"parameters":[{"name":"customerAddressId","in":"path","type":"string","required":true,"description":"Identifier of the customer address table."},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"customerShortNames":[{}],"iddPrefixMobile":"string","mobileNumber":"string"}},"responses":{"200":"CustomerPhoneAddressResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"DELETE","path":"/party/customers/addresses/{customerAddressId}/smsAddresses","fullPath":"/api/v4.1.0/party/customers/addresses/{customerAddressId}/smsAddresses","operationId":"deleteCustomerPhoneAddress","name":"Delete the specified customer sms communication address that are no longer used.","summary":"Deletes customer sms communication address","tags":[],"parameters":[{"name":"customerAddressId","in":"path","type":"string","required":true,"description":"Identifier of the customer address table."},{"name":"payload","in":"body","type":"object","required":false,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}}},"responses":{"200":"CustomerPhoneAddressResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/party/customers/addresses/{customerAddressId}/emailAddresses","fullPath":"/api/v4.1.0/party/customers/addresses/{customerAddressId}/emailAddresses","operationId":"updateCustomerEmailAddress","name":"Update customer email communication address with details such as customer name and email references.","summary":"Updates customer email communication address","tags":[],"parameters":[{"name":"customerAddressId","in":"path","type":"string","required":true,"description":"Identifier of the customer address table."},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"customerShortNames":[{}],"email":"string"}},"responses":{"200":"CustomerEmailAddressResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"DELETE","path":"/party/customers/addresses/{customerAddressId}/emailAddresses","fullPath":"/api/v4.1.0/party/customers/addresses/{customerAddressId}/emailAddresses","operationId":"deleteCustomerEmailAddress","name":"Delete the specified customer email communication address that are no longer used.","summary":"Deletes customer email communication address","tags":[],"parameters":[{"name":"customerAddressId","in":"path","type":"string","required":true,"description":"Identifier of the customer address table."},{"name":"payload","in":"body","type":"object","required":false,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}}},"responses":{"200":"CustomerEmailAddressResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/party/customers/addresses/{customerAddressId}/printAddresses","fullPath":"/api/v4.1.0/party/customers/addresses/{customerAddressId}/printAddresses","operationId":"updateCustomerPrintAddress","name":"Update customer print communication address with details such as name, address, postcode and phone number.","summary":"Updates customer print communication address","tags":[],"parameters":[{"name":"customerAddressId","in":"path","type":"string","required":true,"description":"Identifier of the customer address table."},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"customerShortNames":[{}],"customerNames":[{}],"addresses":[{}],"streets":[{}],"towns":[{}],"postCodes":[{}],"addressPurpose":"string","addressLocation":"string","addressVerifier":"string","countryCode":"string","departmentId":"string","subDepartmentId":"string","flatNumber":"string","buildingName":"string","buildingNumber":"string"}},"responses":{"200":"CustomerPrintAddressResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"DELETE","path":"/party/customers/addresses/{customerAddressId}/printAddresses","fullPath":"/api/v4.1.0/party/customers/addresses/{customerAddressId}/printAddresses","operationId":"deleteCustomerPrintAddress","name":"Delete the specified customer print communication address that are no longer used.","summary":"Deletes customer print communication address","tags":[],"parameters":[{"name":"customerAddressId","in":"path","type":"string","required":true,"description":"Identifier of the customer address table."},{"name":"payload","in":"body","type":"object","required":false,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}}},"responses":{"200":"CustomerPrintAddressResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/party/customers/{customerId}/consents","fullPath":"/api/v4.1.0/party/customers/{customerId}/consents","operationId":"getCustomerConsents","name":"Retrieves the list of consent details for specific customer","summary":"Retrieves customer consents details","tags":[],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"Identifier of the customer"},{"name":"propertyClassId","in":"query","type":"string","required":false,"description":"The identifier of a condition that is used to build a product"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"CustomerConsentsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"POST","path":"/party/customers/{customerId}/fatca","fullPath":"/api/v4.1.0/party/customers/{customerId}/fatca","operationId":"createFatcaCustomer","name":"Creates the FATCA customer supplementary information record that stores the related FATCA details for the customer","summary":"Create FATCA customer supplementary information details","tags":[],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"Identifier of the customer"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"citizenships":[{}],"tinDetails":[{}],"Owner":[{}],"JointOwner":[{}],"fatcaClientType":"string","isPlaceOfBirthUs":"string","domicile":"string","greencardDetails":"string","residenceId":"string","isPoa":"string","standingInstructionOnUsAccount":"string","accountInstructionfromUs":"string","socialSecurityNumber":"string","phoneNumber":"string","isDormantAccount":"string"}},"responses":{"200":"FatcaCustomerResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/party/customers/{customerId}/fatca","fullPath":"/api/v4.1.0/party/customers/{customerId}/fatca","operationId":"updateFatcaCustomer","name":"Update the FATCA customer supplementary information record that stores the related FATCA details for the customer","summary":"Update FATCA customer supplementary information details","tags":[],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"Identifier of the customer"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"citizenships":[{}],"tinDetails":[{}],"Owner":[{}],"JointOwner":[{}],"fatcaClientType":"string","isPlaceOfBirthUs":"string","domicile":"string","greencardDetails":"string","residenceId":"string","isPoa":"string","standingInstructionOnUsAccount":"string","accountInstructionfromUs":"string","socialSecurityNumber":"string","phoneNumber":"string","isDormantAccount":"string"}},"responses":{"200":"FatcaCustomerResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/party/customers/{customerId}/portfolios/{portfolioId}/overdueSettlements","fullPath":"/api/v4.1.0/party/customers/{customerId}/portfolios/{portfolioId}/overdueSettlements","operationId":"getOverdueSettlements","name":"Get overdue settlement","summary":"Get overdue settlement","tags":[],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"Identifier of the customer"},{"name":"portfolioId","in":"path","type":"string","required":true,"description":"Id of the portfolio or security account"},{"name":"transactionId","in":"query","type":"string","required":false,"description":"Unique transaction identifier for retrieving the details of the transaction. For example: FT0102030333 etc."},{"name":"brokerId","in":"query","type":"string","required":false,"description":"The identifier of the broker"},{"name":"tradeDate","in":"query","type":"string","required":false,"description":"Standard date field which records trade date of the account"},{"name":"valueDate","in":"query","type":"string","required":false,"description":"Indicates the value date on which the underlying accounting entry is to be given value (for interest purposes)"},{"name":"depository","in":"query","type":"string","required":false,"description":"Person designated as depository by the company in or pursuant to this Indenture, and, unless otherwise provided with respect to any security, any successor to such person"},{"name":"currency","in":"query","type":"string","required":false,"description":"Identifies the currency. E.g. USD, GBP etc"},{"name":"instrumentId","in":"query","type":"string","required":false,"description":"The identifier of the instrument"},{"name":"deliveryInstruction","in":"query","type":"string","required":false,"description":"Customer's directions to a bank as to the disposition of funds and securities in the customer's account"},{"name":"transactionType","in":"query","type":"string","required":false,"description":"Identifies the transaction type applicable to the transaction being processed, i.e. outward or inward payment. For example: ACPX, OTPX etc."},{"name":"quantity","in":"query","type":"string","required":false,"description":"The nominal quantity"},{"name":"stockExchange","in":"query","type":"string","required":false,"description":"The stock exchange identifier"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"OverdueSettlementsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/party/customers/accountServicingProviders/","fullPath":"/api/v4.1.0/party/customers/accountServicingProviders/","operationId":"getOtherBanksToConnectTo","name":"Retrieves the list of other/external bank details","summary":"Retrieves other banks to connect to details","tags":[],"parameters":[{"name":"openBankingId","in":"query","type":"string","required":false,"description":"Identifies the open banking number of the customer"},{"name":"countryId","in":"query","type":"string","required":false,"description":"ISO country code of the financial institution. "},{"name":"setActive","in":"query","type":"string","required":false,"description":"Flag to set the connection status to active"},{"name":"status","in":"query","type":"string","required":false,"description":"Contains status of the data rights request.Allowed values are INITIATED, INPROGESS, EXTENDED, COMPLETED, REJECTED."},{"name":"extSourceProvider","in":"query","type":"string","required":false,"description":"Contains the name of the external source provider for the customer"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"OtherBanksToConnectToResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/party/customers/prospects","fullPath":"/api/v4.1.0/party/customers/prospects","operationId":"getProspectCustomers","name":"Retrieves the details such as contact information, residence details, personal details and prospect legal details of a prospect customer","summary":"Retrieves prospect customer details of a customer","tags":[],"parameters":[{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"ProspectCustomersResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"POST","path":"/party/customers/prospects","fullPath":"/api/v4.1.0/party/customers/prospects","operationId":"createProspectCustomer","name":"Create a prospect customer with basic details such as contact information, residence details and prospect legal details","summary":"Create a prospect customer","tags":[],"parameters":[{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"customerNames":[{}],"streets":[{}],"addresses":[{}],"townCountries":[{}],"postCodes":[{}],"countries":[{}],"phoneNumbers":[{}],"emails":[{}],"socialNetworkIds":[{}],"prospectLegalDetails":[{}],"personEntity":"string","departmentId":"string","subDepartmentId":"string","floorNumber":"string","locationName":"string"}},"responses":{"200":"ProspectCustomerResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/party/customers/{customerId}/opportunities","fullPath":"/api/v4.1.0/party/customers/{customerId}/opportunities","operationId":"getCustomerOpportunities","name":"Retrieves the details of sales opportunities such as score, status and product details which are likely to be of interest to specific customers","summary":"Retrieves the sales opportunities for specific customers","tags":[],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"Identifier of the customer"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"CustomerOpportunitiesResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/party/customers/{customerId}/requests","fullPath":"/api/v4.1.0/party/customers/{customerId}/requests","operationId":"getCustomerRequests","name":"Retrieves process workflow details such as process name, activity details and status for a specific customer","summary":"Retrieves process workflows for a specific customer","tags":[],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"Identifier of the customer"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"CustomerRequestsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"PUT","path":"/party/customers/prospects/{prospectId}","fullPath":"/api/v4.1.0/party/customers/prospects/{prospectId}","operationId":"updateProspectCustomer","name":"Update a prospect customer with basic details such as contact information, residence details and prospect legal details","summary":"Update the details of the prospect customer","tags":[],"parameters":[{"name":"prospectId","in":"path","type":"string","required":true,"description":"Indicates the status of an onboarding customer. Status can be PROSPECT while onboarding and ACTIVE when the prospect becomes a Customer."},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"customerNames":[{}],"streets":[{}],"addresses":[{}],"townCountries":[{}],"postCodes":[{}],"countries":[{}],"phoneNumbers":[{}],"emails":[{}],"socialNetworkIds":[{}],"prospectLegalDetails":[{}],"personEntity":"string","departmentId":"string","subDepartmentId":"string","floorNumber":"string","locationName":"string"}},"responses":{"200":"ProspectCustomerResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/party/customers/{customerId}/alertRequests","fullPath":"/api/v4.1.0/party/customers/{customerId}/alertRequests","operationId":"getAlertRequests","name":"Retrieves the alert subscription details for specific customer","summary":"Retrieves alert requests details","tags":[],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"Identifier of the customer"},{"name":"contractReference","in":"query","type":"string","required":false,"description":"Contains the contract reference"},{"name":"subscribe","in":"query","type":"string","required":false,"description":"Enables an alert service"},{"name":"alertRequestId","in":"query","type":"string","required":false,"description":"The unique identifier of the alert request."},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"AlertRequestsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}}]},{"key":"party-customerServices-v4.2.0","title":"Customer management","version":"v4.2.0","description":"API to create, update and manage customer details such as delivery preferences, joint customer details, party relationships, KYC details, customer exit status, customer address formats & posting restrictions","endpointCount":67,"endpoints":[{"method":"GET","path":"/party/customers/{customerId}","fullPath":"/api/v4.2.0/party/customers/{customerId}","operationId":"getCustomer","name":"Retrieves the customer details such as customer contact information, residence details, legal document details, occupation details and relationship details for the specific customer","summary":"Retrieves list of customer details","tags":[],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"Identifier of the customer"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"CustomerResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/party/customers/{customerId}","fullPath":"/api/v4.2.0/party/customers/{customerId}","operationId":"updateCustomer","name":"Update customer details with the information such as customer contact information, residence details, legal document details, occupation details and relationship details, etc provided by the user","summary":"Update customer details","tags":[],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"Identifier of the customer"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"displayNames":[{}],"customerNames":[{}],"communicationDevices":[{}],"faxIds":[{}],"officePhoneNumbers":[{}],"streets":[{}],"addresses":[{}],"addressCities":[{}],"countries":[{}],"legalDetails":[{}],"otherNationalityIds":[{}],"employDetails":[{}],"residenceDetails":[{}],"relationshipDetails":[{}],"postingRestrictIds":[{}]}},"responses":{"200":"CustomerResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/party/customers","fullPath":"/api/v4.2.0/party/customers","operationId":"getCustomerInformation","name":"Retrieves the customer details such as delivery or postal details, contact information, residence details, customer profile, legal document details, occupation details and status of customer","summary":"Retrieves list of customer basic details","tags":[],"parameters":[{"name":"customerId","in":"query","type":"string","required":false,"description":"Identifier of the customer"},{"name":"customerIdCT","in":"query","type":"string","required":false,"description":"Indicates the criteria for the contains operation on the customer Id"},{"name":"customerIdBW","in":"query","type":"string","required":false,"description":"Indicates the criteria for the between operation on the customer Id"},{"name":"customerIdMT","in":"query","type":"string","required":false,"description":"Indicates the criteria for the matches operation on the customer Id"},{"name":"customerName","in":"query","type":"string","required":false,"description":"Name of the customer"},{"name":"customerNameCT","in":"query","type":"string","required":false,"description":"Indicates the criteria for the contains operation on the customer name"},{"name":"customerNameBW","in":"query","type":"string","required":false,"description":"Indicates the criteria for the between operation on the customer name"},{"name":"customerNameMT","in":"query","type":"string","required":false,"description":"Indicates the criteria for the matches operation on the customer name"},{"name":"customerNameSAID","in":"query","type":"string","required":false,"description":"Indicates the criteria for the sounds like operation on the customer name"},{"name":"street","in":"query","type":"string","required":false,"description":"Contains the first line of customer's base address, example building number, street number etc."},{"name":"streetCT","in":"query","type":"string","required":false,"description":"Indicates the criteria for the contains operation on the street"},{"name":"streetBW","in":"query","type":"string","required":false,"description":"Indicates the criteria for the between operation on the street"},{"name":"streetMT","in":"query","type":"string","required":false,"description":"Indicates the criteria for the matches operation on the street"},{"name":"streetSAID","in":"query","type":"string","required":false,"description":"Indicates the criteria for the sounds like operation on the street"},{"name":"addressCity","in":"query","type":"string","required":false,"description":"The town and/or city component of the base address of a customer"},{"name":"addressCityCT","in":"query","type":"string","required":false,"description":"Indicates the criteria for the contains operation on the town country"},{"name":"addressCityBW","in":"query","type":"string","required":false,"description":"Indicates the criteria for the between operation on the town country"},{"name":"addressCityMT","in":"query","type":"string","required":false,"description":"Indicates the criteria for the matches operation on the town country"},{"name":"addressCitySAID","in":"query","type":"string","required":false,"description":"Indicates the criteria for the sounds like operation on the town country"},{"name":"countryId","in":"query","type":"string","required":false,"description":"ISO country code of the financial institution. "},{"name":"countryIdCT","in":"query","type":"string","required":false,"description":"Indicates the criteria for the contains operation on the country"},{"name":"countryIdBW","in":"query","type":"string","required":false,"description":"Indicates the criteria for the between operation on the country"},{"name":"countryIdMT","in":"query","type":"string","required":false,"description":"Indicates the criteria for the matches operation on the country"},{"name":"countryIdSAID","in":"query","type":"string","required":false,"description":"Indicates the criteria for the sounds like operation on the country"},{"name":"postCode","in":"query","type":"string","required":false,"description":"Identifies the address postal code for the customer."},{"name":"postCodeCT","in":"query","type":"string","required":false,"description":"Indicates the criteria for the contains operation on the post code"},{"name":"postCodeBW","in":"query","type":"string","required":false,"description":"Indicates the criteria for the between operation on the post code"},{"name":"postCodeMT","in":"query","type":"string","required":false,"description":"Indicates the criteria for the matches operation on the post code"},{"name":"dateOfBirth","in":"query","type":"string","required":false,"description":"The date of birth of an individual customer"},{"name":"dateOfBirthCT","in":"query","type":"string","required":false,"description":"Indicates the criteria for the contains operation on the date of birth"},{"name":"dateOfBirthBW","in":"query","type":"string","required":false,"description":"Indicates the criteria for the between operation on the date of birth"},{"name":"dateOfBirthMT","in":"query","type":"string","required":false,"description":"Indicates the criteria for the matches operation on the date of birth"},{"name":"customerStatus","in":"query","type":"string","required":false,"description":"The internal bank status of a customer"},{"name":"customerStatusCT","in":"query","type":"string","required":false,"description":"Indicates the criteria for the contains operation on the customer status"},{"name":"customerStatusBW","in":"query","type":"string","required":false,"description":"Indicates the criteria for the between operation on the customer status"},{"name":"customerStatusMT","in":"query","type":"string","required":false,"description":"Indicates the criteria for the matches operation on the customer status"},{"name":"sectorId","in":"query","type":"string","required":false,"description":"An institution-defined identifier of the type of customer"},{"name":"sectorIdCT","in":"query","type":"string","required":false,"description":"Indicates the criteria for the contains operation on the sector"},{"name":"sectorIdBW","in":"query","type":"string","required":false,"description":"Indicates the criteria for the between operation on the sector"},{"name":"sectorIdMT","in":"query","type":"string","required":false,"description":"Indicates the criteria for the matches operation on the sector"},{"name":"accountOfficerId","in":"query","type":"string","required":false,"description":"The identifier of the department head or specific account officer responsible for the customer"},{"name":"accountOfficerIdBW","in":"query","type":"string","required":false,"description":"Indicates the criteria for the between operation on the account officer"},{"name":"accountOfficerIdCT","in":"query","type":"string","required":false,"description":"Indicates the criteria for the contains operation on the account officer"},{"name":"accountOfficerIdMT","in":"query","type":"string","required":false,"description":"Indicates the criteria for the matches operation on the account officer"},{"name":"industryId","in":"query","type":"string","required":false,"description":"An institution-defined identifier of the industry in which the customer is trading, operating or is associated with"},{"name":"industryIdBW","in":"query","type":"string","required":false,"description":"Indicates the criteria for the between operation on the industry"},{"name":"industryIdCT","in":"query","type":"string","required":false,"description":"Indicates the criteria for the contains operation on the industry"},{"name":"industryIdMT","in":"query","type":"string","required":false,"description":"Indicates the criteria for the matches operation on the industry"},{"name":"nationalityId","in":"query","type":"string","required":false,"description":"The identifier of the nationality of a customer"},{"name":"nationalityIdBW","in":"query","type":"string","required":false,"description":"Indicates the criteria for the between operation on the nationality"},{"name":"nationalityIdCT","in":"query","type":"string","required":false,"description":"Indicates the criteria for the contains operation on the nationality"},{"name":"nationalityIdMT","in":"query","type":"string","required":false,"description":"Indicates the criteria for the matches operation on the nationality"},{"name":"nationalityIdSAID","in":"query","type":"string","required":false,"description":"Indicates the criteria for the sounds like operation on the nationality"},{"name":"residenceId","in":"query","type":"string","required":false,"description":"The identifier of the country of residence of a customer"},{"name":"residenceIdMT","in":"query","type":"string","required":false,"description":"Indicates the criteria for the matches operation on the residence"},{"name":"residenceIdCT","in":"query","type":"string","required":false,"description":"Indicates the criteria for the contains operation on the residence"},{"name":"residenceIdBW","in":"query","type":"string","required":false,"description":"Indicates the criteria for the between operation on the residence"},{"name":"residenceIdSAID","in":"query","type":"string","required":false,"description":"Indicates the criteria for the sounds like operation on the residence"},{"name":"lastName","in":"query","type":"string","required":false,"description":"The last name of an individual customer"},{"name":"lastNameCT","in":"query","type":"string","required":false,"description":"Indicates the criteria for the contains operation on the family name"},{"name":"lastNameBW","in":"query","type":"string","required":false,"description":"Indicates the criteria for the between operation on the family name"},{"name":"lastNameMT","in":"query","type":"string","required":false,"description":"Indicates the criteria for the matches operation on the family name"},{"name":"lastNameSAID","in":"query","type":"string","required":false,"description":"Indicates the criteria for the sounds like operation on the family name"},{"name":"phoneNumber","in":"query","type":"string","required":false,"description":"The phone number of the customer or prospect"},{"name":"phoneNumberCT","in":"query","type":"string","required":false,"description":"Indicates the criteria for the contains operation on the phone number"},{"name":"phoneNumberMT","in":"query","type":"string","required":false,"description":"Indicates the criteria for the matches operation on the phone number"},{"name":"phoneNumberBW","in":"query","type":"string","required":false,"description":"Indicates the criteria for the between operation on the phone number"},{"name":"customerMnemonic","in":"query","type":"string","required":false,"description":"Specifies an alternative easy means of referencing the Customer"},{"name":"customerMnemonicCT","in":"query","type":"string","required":false,"description":"Indicates the criteria for the contains operation on the customer mnemonic"},{"name":"customerMnemonicBW","in":"query","type":"string","required":false,"description":"Indicates the criteria for the between operation on the customer mnemonic"},{"name":"customerMnemonicMT","in":"query","type":"string","required":false,"description":"Indicates the criteria for the matches operation on the customer mnemonic"},{"name":"customerMnemonicSAID","in":"query","type":"string","required":false,"description":"Indicates the criteria for the sounds like operation on the customer mnemonic"},{"name":"firstName","in":"query","type":"string","required":false,"description":"Specifies customer's first name"},{"name":"firstNameBW","in":"query","type":"string","required":false,"description":"Indicates the criteria for the between operation on the first name"},{"name":"firstNameMT","in":"query","type":"string","required":false,"description":"Indicates the criteria for the matches operation on the first name"},{"name":"firstNameCT","in":"query","type":"string","required":false,"description":"Indicates the criteria for the contains operation on the first name"},{"name":"firstNameSAID","in":"query","type":"string","required":false,"description":"Indicates the criteria for the sounds like operation on the first name"},{"name":"customerType","in":"query","type":"string","required":false,"description":"Contains the type of customer, for example ACTIVE, PROSPECT."},{"name":"customerTypeCT","in":"query","type":"string","required":false,"description":"Indicates the criteria for the contains operation on the customer type"},{"name":"customerTypeBW","in":"query","type":"string","required":false,"description":"Indicates the criteria for the between operation on the customer type"},{"name":"customerTypeMT","in":"query","type":"string","required":false,"description":"Indicates the criteria for the matches operation on the customer type"},{"name":"customerTypeSAID","in":"query","type":"string","required":false,"description":"Indicates the criteria for the sounds like operation on the customer type"},{"name":"email","in":"query","type":"string","required":false,"description":"Email Identifier of the Customer"},{"name":"emailCT","in":"query","type":"string","required":false,"description":"Indicates the criteria for the contains operation on the emails"},{"name":"emailMT","in":"query","type":"string","required":false,"description":"Indicates the criteria for the matches operation on the emails"},{"name":"emailBW","in":"query","type":"string","required":false,"description":"Indicates the criteria for the between operation on the emails"},{"name":"emailSAID","in":"query","type":"string","required":false,"description":"Indicates the criteria for the sounds like operation on the emails"},{"name":"mobilePhoneNumber","in":"query","type":"string","required":false,"description":"Represents the phone number of a customer"},{"name":"mobilePhoneNumberCT","in":"query","type":"string","required":false,"description":"Indicates the criteria for the contains operation on the mobile numbers"},{"name":"mobilePhoneNumberBW","in":"query","type":"string","required":false,"description":"Indicates the criteria for the between operation on the mobile numbers"},{"name":"mobilePhoneNumberMT","in":"query","type":"string","required":false,"description":"Indicates the criteria for the matches operation on the mobile numbers"},{"name":"taxId","in":"query","type":"string","required":false,"description":"Holds the Customer's TAX/SSN Id."},{"name":"taxIdCT","in":"query","type":"string","required":false,"description":"Indicates the criteria for the contains operation on the tax Id"},{"name":"taxIdBW","in":"query","type":"string","required":false,"description":"Indicates the criteria for the between operation on the tax Id"},{"name":"taxIdMT","in":"query","type":"string","required":false,"description":"Indicates the criteria for the matches operation on the tax Id"},{"name":"shortName","in":"query","type":"string","required":false,"description":"Contains the name of the account, basically the short title of the account."},{"name":"shortNameCT","in":"query","type":"string","required":false,"description":"Indicates the criteria for the contains operation on the short name"},{"name":"shortNameBW","in":"query","type":"string","required":false,"description":"Indicates the criteria for the between operation on the short name"},{"name":"shortNameMT","in":"query","type":"string","required":false,"description":"Indicates the criteria for the matches operation on the short name"},{"name":"shortNameSAID","in":"query","type":"string","required":false,"description":"Indicates the criteria for the sounds like operation on the short name"},{"name":"officePhoneNumber","in":"query","type":"string","required":false,"description":"The office phone number of the customer"},{"name":"officePhoneNumberCT","in":"query","type":"string","required":false,"description":"Indicates the criteria for the contains operation on the office phone numbers"},{"name":"officePhoneNumberBW","in":"query","type":"string","required":false,"description":"Indicates the criteria for the between operation on the office phone numbers"},{"name":"officePhoneNumberMT","in":"query","type":"string","required":false,"description":"Indicates the criteria for the matches operation on the office phone numbers"},{"name":"faxId","in":"query","type":"string","required":false,"description":"The fax (facsimile) number of the customer"},{"name":"faxIdBW","in":"query","type":"string","required":false,"description":"Indicates the criteria for the between operation on the fax Id"},{"name":"faxIdCT","in":"query","type":"string","required":false,"description":"Indicates the criteria for the contains operation on the fax Id"},{"name":"faxIdMT","in":"query","type":"string","required":false,"description":"Indicates the criteria for the matches operation on the fax Id"},{"name":"address","in":"query","type":"string","required":false,"description":"Communication Address of the Customer"},{"name":"addressCT","in":"query","type":"string","required":false,"description":"Indicates the criteria for the contains operation on the address"},{"name":"addressBW","in":"query","type":"string","required":false,"description":"Indicates the criteria for the between operation on the address"},{"name":"addressMT","in":"query","type":"string","required":false,"description":"Indicates the criteria for the matches operation on the address"},{"name":"addressSAID","in":"query","type":"string","required":false,"description":"Indicates the criteria for the sounds like operation on the address"},{"name":"relCustomer","in":"query","type":"string","required":false,"description":"Customers linked or related to the arrangement owner"},{"name":"relCustomerBW","in":"query","type":"string","required":false,"description":"Indicates the criteria for the between operation on the related customer Id"},{"name":"relCustomerCT","in":"query","type":"string","required":false,"description":"Indicates the criteria for the contains operation on the related customer Id"},{"name":"relCustomerMT","in":"query","type":"string","required":false,"description":"Indicates the criteria for the matches operation on the related customer Id"},{"name":"relationshipCode","in":"query","type":"string","required":false,"description":"Relationship identifier between the partyType and relatedPartyType"},{"name":"relationshipCodeBW","in":"query","type":"string","required":false,"description":"Indicates the criteria for the between operation on the relationship code"},{"name":"relationshipCodeMT","in":"query","type":"string","required":false,"description":"Indicates the criteria for the matches operation on the relationship code"},{"name":"relationshipCodeCT","in":"query","type":"string","required":false,"description":"Indicates the criteria for the contains operation on the relationship code"},{"name":"legalId","in":"query","type":"string","required":false,"description":"Unique reference number of the legal documents submitted as identification proof"},{"name":"legalDocumentName","in":"query","type":"string","required":false,"description":"Name of the legal documents such as passport, driving licence etc., provided as identification proof"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"CustomerInformationResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"POST","path":"/party/customers","fullPath":"/api/v4.2.0/party/customers","operationId":"createCustomer","name":"Create a customer with the information such as customer contact information, residence details, legal document details, occupation details and relationship details, etc provided by the user","summary":"Create a customer","tags":[],"parameters":[{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"displayNames":[{}],"customerNames":[{}],"communicationDevices":[{}],"faxIds":[{}],"officePhoneNumbers":[{}],"streets":[{}],"addresses":[{}],"addressCities":[{}],"countries":[{}],"legalDetails":[{}],"otherNationalityIds":[{}],"employDetails":[{}],"residenceDetails":[{}],"relationshipDetails":[{}],"postingRestrictIds":[{}]}},"responses":{"200":"CustomerResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/party/customers/relationships","fullPath":"/api/v4.2.0/party/customers/relationships","operationId":"getCustomerRelationship","name":"Retrieves customer relationship details such as type of relationship, party information, relatedAs details, owning details, role & purpose of relationship for specific party or customer","summary":"Retrieves list of customer relationships","tags":[],"parameters":[{"name":"customerRelationGroupId","in":"query","type":"string","required":false,"description":"Identifies the key to Customer Relationship Group to form a relation"},{"name":"partyId","in":"query","type":"string","required":false,"description":"Allows capturing of customers or person entities to be part of the relationship. If partyType is selected as Customer, then the system will allow only customer Ids to be captured into this field. If p"},{"name":"relatedPartyId","in":"query","type":"string","required":false,"description":"Identifier of the Related Party"},{"name":"relationId","in":"query","type":"string","required":false,"description":"Identifier of the Customer Relationship and Party Relationship"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"CustomerRelationshipResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"POST","path":"/party/customers/relationships","fullPath":"/api/v4.2.0/party/customers/relationships","operationId":"createCustomerRelationship","name":"Create a customer relationship for a customer with details such as type of relationship, party information, relatedAs details, owning details, role & purpose of relationship","summary":"Create customer relationship with other customers","tags":[],"parameters":[{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"originatingRelation":[{}],"customerRelationGroupId":0.0,"customerRelationGroupName":"string","purposeOfRelationship":"string"}},"responses":{"200":"CustomerRelationshipResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/party/customers/relationships/{relationId}","fullPath":"/api/v4.2.0/party/customers/relationships/{relationId}","operationId":"updateCustomerRelationship","name":"Update customer relationship for a customer with details such as type of relationship, party information, related details, owning details, role & purpose of relationship","summary":"Update customer relationship","tags":[],"parameters":[{"name":"relationId","in":"path","type":"string","required":true,"description":"Identifier of the Customer Relationship and Party Relationship"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"originatingRelation":[{}],"customerRelationGroupId":0.0,"customerRelationGroupName":"string","purposeOfRelationship":"string"}},"responses":{"200":"CustomerRelationshipResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/party/customers/reportingStatus","fullPath":"/api/v4.2.0/party/customers/reportingStatus","operationId":"getCustomerReportingStatus","name":"Retrieves the FATCA/CRS reporting status and reporting jurisdiction of the customer","summary":"Retrieves reporting status of the customer","tags":[],"parameters":[{"name":"customerId","in":"query","type":"string","required":true,"description":"Identifier of the customer"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"CustomerReportingStatusResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/party/customers/{customerId}/sweeps","fullPath":"/api/v4.2.0/party/customers/{customerId}/sweeps","operationId":"getCustomerSweeps","name":"Retrieves account sweep details such as sweep reference, type, balance requirements for sweep & frequency of sweep for the list of accounts available to a customer","summary":"Retrieves account sweep details of the specific customer","tags":[],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"Identifier of the customer"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"CustomerSweepsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/party/customers/{customerId}/deliveryOptions","fullPath":"/api/v4.2.0/party/customers/{customerId}/deliveryOptions","operationId":"getCustomerDeliveryOptions","name":"Retrieves the delivery preferences of the customer such as the message group, carrier and address.","summary":"Retrieves delivery preferences of the customer","tags":[],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"Identifier of the customer"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"CustomerDeliveryOptionsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/party/customers/{customerId}/channels","fullPath":"/api/v4.2.0/party/customers/{customerId}/channels","operationId":"getCustomerDigitalChannels","name":"Retrieves the list of message channels such as internet banking, mobile banking, ATM, etc available for the specific customer","summary":"Retrieves list of message channels","tags":[],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"Identifier of the customer"},{"name":"channelName","in":"query","type":"string","required":false,"description":"Name of the (digital) channel registered by the Customer"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"CustomerDigitalChannelsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"POST","path":"/party/customers/messages","fullPath":"/api/v4.2.0/party/customers/messages","operationId":"createMessages","name":"Create a new secure message for a customer to be sent by bank","summary":"Create a new secure message for a customer","tags":[],"parameters":[{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"messages":[{}],"subject":"string","toCustomerId":"string"}},"responses":{"200":"MessagesResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/party/customers/{customerId}/jointCustomers","fullPath":"/api/v4.2.0/party/customers/{customerId}/jointCustomers","operationId":"getJointCustomerDetails","name":"Retrieves details such as joint relation code, name, joint customer details and reverse relationships for a specific customer","summary":"Retrieves joint customer details for a specific customer","tags":[],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"Identifier of the customer"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"JointCustomerDetailsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/party/customers/{customerId}/KYC","fullPath":"/api/v4.2.0/party/customers/{customerId}/KYC","operationId":"getCustomerKYCDetails","name":"Retrieves the KYC details such as contact date, introducer, last and next review date, KYC and AML status of a customer","summary":"Retrieves KYC details for a specific customer","tags":[],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"Identifier of the customer"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"CustomerKYCDetailsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/party/customers/{customerId}/personalProfiles","fullPath":"/api/v4.2.0/party/customers/{customerId}/personalProfiles","operationId":"getCustomerPersonalDetails","name":"Retrieves personal details such as residence, communication details, occupation details, asset & liability information","summary":"Retrieves personal details of customer","tags":[],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"Identifier of the customer"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"CustomerPersonalDetailsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/party/customers/postingRestrictions","fullPath":"/api/v4.2.0/party/customers/postingRestrictions","operationId":"getCustomerPostingRestrictions","name":"Retrieves the credit and debit posting restriction details such as restriction reference and name of restriction set for a customer","summary":"Retrieves posting restriction details","tags":[],"parameters":[{"name":"customerId","in":"query","type":"string","required":false,"description":"Identifier of the customer"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"CustomerPostingRestrictionsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"POST","path":"/party/relationships/{relationId}","fullPath":"/api/v4.2.0/party/relationships/{relationId}","operationId":"createPartyRelationship","name":"Create a party relationship between a person, entity or customer with details such as party name, type, relatedAs, relation code and owning details","summary":"Create party relationship details","tags":[],"parameters":[{"name":"relationId","in":"path","type":"string","required":true,"description":"Identifier of the Customer Relationship and Party Relationship"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"partyDisplayNames":[{}],"partyRelationships":[{}]}},"responses":{"200":"PartyRelationshipResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/party/relationships/{relationId}","fullPath":"/api/v4.2.0/party/relationships/{relationId}","operationId":"updatePartyRelationship","name":"Update party relationship between a person, entity or customer with details such as party name, type, relatedAs, relation code and owning details","summary":"Update party relationship details","tags":[],"parameters":[{"name":"relationId","in":"path","type":"string","required":true,"description":"Identifier of the Customer Relationship and Party Relationship"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"partyDisplayNames":[{}],"partyRelationships":[{}]}},"responses":{"200":"PartyRelationshipResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/party/customers/{customerId}/cards","fullPath":"/api/v4.2.0/party/customers/{customerId}/cards","operationId":"getCustomerCreditCards","name":"Retrieves the card details such as card number, card type and status, linked account and its balances of a customer","summary":"Retrieves card details of a customer","tags":[],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"Identifier of the customer"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"CustomerCreditCardsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/party/customers/{customerId}/standingOrders","fullPath":"/api/v4.2.0/party/customers/{customerId}/standingOrders","operationId":"getStandingOrders","name":"Retrieves the list of standing instructions for a customer with details such as instruction reference, order type, frequency of payments, mode of payment and credit & debit parties involved","summary":"Retrieves standing instruction details of a customer","tags":[],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"Identifier of the customer"},{"name":"standingOrderId","in":"query","type":"string","required":false,"description":"The unique standing order identifier"},{"name":"accountId","in":"query","type":"string","required":false,"description":"Identifier of the account. Often referred to as the account number, yet for consistency this is always referred to as accountId. Accepts both IBAN & BBAN"},{"name":"orderingCustomerId","in":"query","type":"string","required":false,"description":"Indicates the customer id for the ordering customer"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"StandingOrdersResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/party/customers/{customerId}/directDebits","fullPath":"/api/v4.2.0/party/customers/{customerId}/directDebits","operationId":"getDirectDebits","name":"Retrieves the list of direct debits for a customer with details such as direct debit reference, debit & credit accounts, transaction amount, payment frequency, next payment date and direction of payment","summary":"Retrieves direct debits details of a customer","tags":[],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"Identifier of the customer"},{"name":"directDebitId","in":"query","type":"string","required":false,"description":"The unique identifier of the direct debit mandate. "},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"DirectDebitsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"POST","path":"/party/customers/deliveryPreferences/{deliveryPreferenceId}","fullPath":"/api/v4.2.0/party/customers/deliveryPreferences/{deliveryPreferenceId}","operationId":"createDeliveryPreference","name":"Creates delivery preferences for a customer or account with message group, carrier, role, address, email details and format of messages","summary":"Create customer delivery preferences","tags":[],"parameters":[{"name":"deliveryPreferenceId","in":"path","type":"string","required":true,"description":"Identifier of the customer delivery preferences"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"messageGroup":[{}],"otherMessagesDetail":[{}],"applyOtherMessages":"string"}},"responses":{"200":"DeliveryPreferenceResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/party/customers/deliveryPreferences/{deliveryPreferenceId}","fullPath":"/api/v4.2.0/party/customers/deliveryPreferences/{deliveryPreferenceId}","operationId":"updateDeliveryPreference","name":"Update delivery preferences for a  customer or account with message group, carrier, role, address & email details, format of messages","summary":"Update customer deliver preferences","tags":[],"parameters":[{"name":"deliveryPreferenceId","in":"path","type":"string","required":true,"description":"Identifier of the customer delivery preferences"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"messageGroup":[{}],"otherMessagesDetail":[{}],"applyOtherMessages":"string"}},"responses":{"200":"DeliveryPreferenceResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/party/customers/limits/{limitId}","fullPath":"/api/v4.2.0/party/customers/limits/{limitId}","operationId":"updateLimit","name":"Updates the limit details such as currency, limit grade, commodity, country and limit product details","summary":"Update credit limit details for customer","tags":[],"parameters":[{"name":"limitId","in":"path","type":"string","required":true,"description":"The identifier of credit limit"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"countries":[{}],"grades":[{}],"commodities":[{}],"currencyId":"string","onlineLimitDate":"2024-01-01","availableMarker":"string","allowNetting":"string","onlineUpdate":"string","limitProductId":"string","checkLimit":"string","band":"string","reducingLimit":"string","internalAmount":"string"}},"responses":{"200":"LimitResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/party/customers/{customerId}/customerExitStatus","fullPath":"/api/v4.2.0/party/customers/{customerId}/customerExitStatus","operationId":"getCustomerExitStatus","name":"Retrieves customer exit status details such as customer type, exit date, status and reason","summary":"Retrieves customer exit status details of customer","tags":[],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"Identifier of the customer"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"CustomerExitStatusResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"PUT","path":"/party/customers/{customerId}/customerExitStatus","fullPath":"/api/v4.2.0/party/customers/{customerId}/customerExitStatus","operationId":"updateCustomerExitStatus","name":"Update a customer record with exit status and exit reason marking the customer as blocked or rejected or closed","summary":"Update customer exit status details of customers","tags":[],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"Identifier of the customer"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"exitStatus":"string","exitReason":"string"}},"responses":{"200":"CustomerExitStatusResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/party/customers/settings/customerExitStatus/{customerExitStatusId}","fullPath":"/api/v4.2.0/party/customers/settings/customerExitStatus/{customerExitStatusId}","operationId":"getCustomerExitStatusParam","name":"Retrieves available conditions such as customer exit setup reference, allowed reasons and allowed re-open details to update customer exit status of customers","summary":"Retrieves conditions to update customer exit status of customer","tags":[],"parameters":[{"name":"customerExitStatusId","in":"path","type":"string","required":true,"description":"The field reflects the exit status ID of a customer or prospect from the parameterization table CUSTOMER.EXIT.STATUS"},{"name":"customerType","in":"query","type":"string","required":false,"description":"Contains the type of customer, for example ACTIVE, PROSPECT."},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"CustomerExitStatusParamResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"POST","path":"/party/customers/settings/customerExitStatus/{customerExitStatusId}","fullPath":"/api/v4.2.0/party/customers/settings/customerExitStatus/{customerExitStatusId}","operationId":"createCustomerExitStatusParam","name":"Create conditions such as applicable customer type and allowed reasons to update the customer exit status details of customers","summary":"Create conditions to update customer exit status of customer","tags":[],"parameters":[{"name":"customerExitStatusId","in":"path","type":"string","required":true,"description":"The field reflects the exit status ID of a customer or prospect from the parameterization table CUSTOMER.EXIT.STATUS"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"allowedExitReasons":[{}],"exitStatusDescription":"string","customerType":"string","allowRemoveExitStatus":"string"}},"responses":{"200":"CustomerExitStatusParamResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/party/customers/settings/{customerExitStatusId}/customerExitStatus","fullPath":"/api/v4.2.0/party/customers/settings/{customerExitStatusId}/customerExitStatus","operationId":"updateCustomerExitStatusParam","name":"Create conditions such as applicable customer type and allowed reasons to update the customer exit status details of customers","summary":"Create conditions to update customer exit status of customer","tags":[],"parameters":[{"name":"customerExitStatusId","in":"path","type":"string","required":true,"description":"The field reflects the exit status ID of a customer or prospect from the parameterization table CUSTOMER.EXIT.STATUS"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"allowedExitReasons":[{}],"exitStatusDescription":"string","customerType":"string","allowRemoveExitStatus":"string"}},"responses":{"200":"CustomerExitStatusParamResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/party/customers/{customerId}/addresses","fullPath":"/api/v4.2.0/party/customers/{customerId}/addresses","operationId":"getCustomerAddressOutput","name":"Returns structured/unstructured address details of specified customer based on address option in request. When structured format is requested, the values are returned in format of structured data name combined with corresponding customer address value. When unstructured format is requested, the address details are returned based on configured unstructured address format.","summary":"Retrieves structured/ unstructured address format of customer","tags":[],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"Identifier of the customer"},{"name":"addressOption","in":"query","type":"string","required":false,"description":"It reflects the preference for the customer address format, respective structured, unstructured or both"},{"name":"addressOutputFormat","in":"query","type":"string","required":false,"description":"It identifies the address output format for the unstructured address"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"CustomerAddressOutputResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/party/customers/{customerId}/shortNames","fullPath":"/api/v4.2.0/party/customers/{customerId}/shortNames","operationId":"getCustomerShortNames","name":"API to get the customer short name that can be used as customer enrichment by any application","summary":"Retrieves customer short name","tags":[],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"Identifier of the customer"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"CustomerShortNamesResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/party/customers/{customerId}/mandates","fullPath":"/api/v4.2.0/party/customers/{customerId}/mandates","operationId":"getCustomerMandates","name":"Retrieves the mandate instruction details such as application eligible for mandate process and the corresponding mandate rule that is being applied to check mandates for transactions involving the specified customer.","summary":"Retrieves mandate instruction applicable for the requested customer","tags":[],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"Identifier of the customer"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"CustomerMandatesResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/party/customers/{customerId}/documents","fullPath":"/api/v4.2.0/party/customers/{customerId}/documents","operationId":"getCustomerLegalDocuments","name":"Retrieves the details of legal document provided by the customer such as document name, document id, issue date, expiry date and authority who issued the document.","summary":"Retrieves the customer legal document details","tags":[],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"Identifier of the customer"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"CustomerLegalDocumentsResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/party/customers/{customerId}/profiles","fullPath":"/api/v4.2.0/party/customers/{customerId}/profiles","operationId":"getCustomerProfile","name":"Retrieves the customer basic details such as personal information, address location, basic contact details and other general information.","summary":"Retrieves profile details of the requested customer","tags":[],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"CustomerProfileResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/party/customers/alternateReferences/{alternateReference}","fullPath":"/api/v4.2.0/party/customers/alternateReferences/{alternateReference}","operationId":"getCustomerId","name":"Retrieves the customer identifier for the provided alternate reference of the customer","summary":"Retrieves customer id for the given alternate reference","tags":[],"parameters":[{"name":"alternateReference","in":"path","type":"string","required":true,"description":"If the new Account to be created is a shadow of another Account already exisitng in another system, then the Account reference of that system can be specified here. The value given in this field will "},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"CustomerIdResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/party/customers/{customerId}/restrictions","fullPath":"/api/v4.2.0/party/customers/{customerId}/restrictions","operationId":"getCustomerRestrictions","name":"Retrieves the transaction restrictions imposed on the customer specified. Restrictions can be post no entries, black listed customer, pending KYC due reasons for restricting transactions on this customer","summary":"Retrieves the restriction details","tags":[],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"CustomerRestrictionsResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/party/customers/{customerId}/contacts","fullPath":"/api/v4.2.0/party/customers/{customerId}/contacts","operationId":"getCustomerContacts","name":"Retrieves the contact details such as phone number, mobile numbers, fax and email address specific to the requested customer","summary":"Retrieves the customer contact details","tags":[],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"Identifier of the customer"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"CustomerContactsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/party/customers/{customerId}/relationships","fullPath":"/api/v4.2.0/party/customers/{customerId}/relationships","operationId":"getCustomerRelationships","name":"Retrieves the relationship details such as related customer and the relationship that exists with the requested customer","summary":"Retrieves the relation customers","tags":[],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"CustomerRelationshipsResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/party/customers/{customerId}/payments","fullPath":"/api/v4.2.0/party/customers/{customerId}/payments","operationId":"getPartyBasicDetails","name":"Retrieves the customer information that are required for processing or validating the customer involved in a payment transaction. Provides the information such as customer name details, birth details, address details,  market sector, target, nationality, residence country and preferred language for communication.","summary":"Retrieves customer details required for payment processing","tags":[],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"Identifier of the customer"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"PartyBasicDetailsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/party/customers/{customerId}/addresses/swiftAddresses/{addressId}","fullPath":"/api/v4.2.0/party/customers/{customerId}/addresses/swiftAddresses/{addressId}","operationId":"getCustomerSwiftAddress","name":"Retrieves the SWIFT address details such as delivery address, short name & tag25 indicator for the customer.","summary":"Retrieves the SWIFT address details for the customer.","tags":[],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"Identifier of the customer"},{"name":"addressId","in":"path","type":"string","required":true,"description":"Reference Id of address record"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"CustomerSwiftAddressResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/party/relationships/{partyId}/relations","fullPath":"/api/v4.2.0/party/relationships/{partyId}/relations","operationId":"getPartyRelationship","name":"Retrieves the relationship details such as party name, type, relation code of a customers involved in a relationship","summary":"Retrieves list of party relationship details","tags":[],"parameters":[{"name":"partyId","in":"path","type":"string","required":true,"description":"Allows capturing of customers or person entities to be part of the relationship. If partyType is selected as Customer, then the system will allow only customer Ids to be captured into this field. If p"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"PartyRelationshipResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/party/customers/{customerId}/charges","fullPath":"/api/v4.2.0/party/customers/{customerId}/charges","operationId":"getCustomerCharge","name":"Retrieves customer charge for a customer with details such as tax type and tax group.","summary":"Retrieves customer charge for a specific customer.","tags":[],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"Identifier of the customer"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"CustomerChargeResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"POST","path":"/party/customers/{customerId}/charges","fullPath":"/api/v4.2.0/party/customers/{customerId}/charges","operationId":"createCustomerCharge","name":"Creates customer charge for a customer with details such as tax type and tax group.","summary":"Creates customer charge for a specific customer.","tags":[],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"Identifier of the customer"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"taxGroups":[{}]}},"responses":{"200":"CustomerChargeResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/party/customers/{customerId}/charges","fullPath":"/api/v4.2.0/party/customers/{customerId}/charges","operationId":"updateCustomerCharge","name":"Updates customer charge for a customer with details such as tax type and tax group.","summary":"Updates customer charge for a specific customer.","tags":[],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"Identifier of the customer"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"taxGroups":[{}]}},"responses":{"200":"CustomerChargeResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/party/customers/{customerId}/addresses/smsAddresses","fullPath":"/api/v4.2.0/party/customers/{customerId}/addresses/smsAddresses","operationId":"getCustomerPhoneAddress","name":"Retrieves the list of customer sms communication address with details such as name, idd prefix and mobile number.","summary":"Retrieves available list of customer sms communication addresses","tags":[],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"Identifier of the customer"},{"name":"addressId","in":"query","type":"string","required":false,"description":"Reference Id of address record"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"CustomerPhoneAddressResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"POST","path":"/party/customers/{customerId}/addresses/smsAddresses","fullPath":"/api/v4.2.0/party/customers/{customerId}/addresses/smsAddresses","operationId":"createCustomerPhoneAddress","name":"Create customer sms communication address with details such as name, idd prefix and mobile number.","summary":"Creates customer sms communication address","tags":[],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"Identifier of the customer"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"customerShortNames":[{}],"iddPrefixMobile":"string","mobileNumber":"string"}},"responses":{"200":"CustomerPhoneAddressResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/party/customers/{customerId}/addresses/emailAddresses","fullPath":"/api/v4.2.0/party/customers/{customerId}/addresses/emailAddresses","operationId":"getCustomerEmailAddress","name":"Retrieves the list of customer email communication address with details such as customer name and email references.","summary":"Retrieves available list of customer email communication addresses","tags":[],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"Identifier of the customer"},{"name":"addressId","in":"query","type":"string","required":false,"description":"Reference Id of address record"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"CustomerEmailAddressResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"POST","path":"/party/customers/{customerId}/addresses/emailAddresses","fullPath":"/api/v4.2.0/party/customers/{customerId}/addresses/emailAddresses","operationId":"createCustomerEmailAddress","name":"Create customer email communication address with details such as customer name and email references.","summary":"Creates customer email communication address","tags":[],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"Identifier of the customer"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"customerShortNames":[{}],"email":"string"}},"responses":{"200":"CustomerEmailAddressResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/party/customers/{customerId}/addresses/printAddresses","fullPath":"/api/v4.2.0/party/customers/{customerId}/addresses/printAddresses","operationId":"getCustomerPrintAddress","name":"Retrieves the list of customer print communication addresses with details such as name, address, postcode and phone number.","summary":"Retrieves available list of customer print communication addresses","tags":[],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"Identifier of the customer"},{"name":"addressId","in":"query","type":"string","required":false,"description":"Reference Id of address record"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"CustomerPrintAddressResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"POST","path":"/party/customers/{customerId}/addresses/printAddresses","fullPath":"/api/v4.2.0/party/customers/{customerId}/addresses/printAddresses","operationId":"createCustomerPrintAddress","name":"Create customer print communication address with details such as name, address, postcode and phone number.","summary":"Creates customer print communication address","tags":[],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"Identifier of the customer"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"customerShortNames":[{}],"customerNames":[{}],"addresses":[{}],"streets":[{}],"towns":[{}],"postCodes":[{}],"addressPurpose":"string","addressLocation":"string","addressVerifier":"string","countryCode":"string","departmentId":"string","subDepartmentId":"string","flatNumber":"string","buildingName":"string","buildingNumber":"string"}},"responses":{"200":"CustomerPrintAddressResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/party/customers/addresses/{customerAddressId}/smsAddresses","fullPath":"/api/v4.2.0/party/customers/addresses/{customerAddressId}/smsAddresses","operationId":"updateCustomerPhoneAddress","name":"Update customer sms communication address with details such as name, idd prefix and mobile number.","summary":"Updates customer sms communication address","tags":[],"parameters":[{"name":"customerAddressId","in":"path","type":"string","required":true,"description":"Identifier of the customer address table."},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"customerShortNames":[{}],"iddPrefixMobile":"string","mobileNumber":"string"}},"responses":{"200":"CustomerPhoneAddressResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"DELETE","path":"/party/customers/addresses/{customerAddressId}/smsAddresses","fullPath":"/api/v4.2.0/party/customers/addresses/{customerAddressId}/smsAddresses","operationId":"deleteCustomerPhoneAddress","name":"Delete the specified customer sms communication address that are no longer used.","summary":"Deletes customer sms communication address","tags":[],"parameters":[{"name":"customerAddressId","in":"path","type":"string","required":true,"description":"Identifier of the customer address table."},{"name":"payload","in":"body","type":"object","required":false,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}}},"responses":{"200":"CustomerPhoneAddressResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/party/customers/addresses/{customerAddressId}/emailAddresses","fullPath":"/api/v4.2.0/party/customers/addresses/{customerAddressId}/emailAddresses","operationId":"updateCustomerEmailAddress","name":"Update customer email communication address with details such as customer name and email references.","summary":"Updates customer email communication address","tags":[],"parameters":[{"name":"customerAddressId","in":"path","type":"string","required":true,"description":"Identifier of the customer address table."},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"customerShortNames":[{}],"email":"string"}},"responses":{"200":"CustomerEmailAddressResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"DELETE","path":"/party/customers/addresses/{customerAddressId}/emailAddresses","fullPath":"/api/v4.2.0/party/customers/addresses/{customerAddressId}/emailAddresses","operationId":"deleteCustomerEmailAddress","name":"Delete the specified customer email communication address that are no longer used.","summary":"Deletes customer email communication address","tags":[],"parameters":[{"name":"customerAddressId","in":"path","type":"string","required":true,"description":"Identifier of the customer address table."},{"name":"payload","in":"body","type":"object","required":false,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}}},"responses":{"200":"CustomerEmailAddressResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/party/customers/addresses/{customerAddressId}/printAddresses","fullPath":"/api/v4.2.0/party/customers/addresses/{customerAddressId}/printAddresses","operationId":"updateCustomerPrintAddress","name":"Update customer print communication address with details such as name, address, postcode and phone number.","summary":"Updates customer print communication address","tags":[],"parameters":[{"name":"customerAddressId","in":"path","type":"string","required":true,"description":"Identifier of the customer address table."},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"customerShortNames":[{}],"customerNames":[{}],"addresses":[{}],"streets":[{}],"towns":[{}],"postCodes":[{}],"addressPurpose":"string","addressLocation":"string","addressVerifier":"string","countryCode":"string","departmentId":"string","subDepartmentId":"string","flatNumber":"string","buildingName":"string","buildingNumber":"string"}},"responses":{"200":"CustomerPrintAddressResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"DELETE","path":"/party/customers/addresses/{customerAddressId}/printAddresses","fullPath":"/api/v4.2.0/party/customers/addresses/{customerAddressId}/printAddresses","operationId":"deleteCustomerPrintAddress","name":"Delete the specified customer print communication address that are no longer used.","summary":"Deletes customer print communication address","tags":[],"parameters":[{"name":"customerAddressId","in":"path","type":"string","required":true,"description":"Identifier of the customer address table."},{"name":"payload","in":"body","type":"object","required":false,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}}},"responses":{"200":"CustomerPrintAddressResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/party/customers/{customerId}/consents","fullPath":"/api/v4.2.0/party/customers/{customerId}/consents","operationId":"getCustomerConsents","name":"Retrieves the list of consent details for specific customer","summary":"Retrieves customer consents details","tags":[],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"Identifier of the customer"},{"name":"propertyClassId","in":"query","type":"string","required":false,"description":"The identifier of a condition that is used to build a product"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"CustomerConsentsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"POST","path":"/party/customers/{customerId}/fatca","fullPath":"/api/v4.2.0/party/customers/{customerId}/fatca","operationId":"createFatcaCustomer","name":"Creates the FATCA customer supplementary information record that stores the related FATCA details for the customer","summary":"Create FATCA customer supplementary information details","tags":[],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"Identifier of the customer"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"citizenships":[{}],"tinDetails":[{}],"Owner":[{}],"JointOwner":[{}],"fatcaClientType":"string","isPlaceOfBirthUs":"string","domicile":"string","greencardDetails":"string","residenceId":"string","isPoa":"string","standingInstructionOnUsAccount":"string","accountInstructionfromUs":"string","socialSecurityNumber":"string","phoneNumber":"string","isDormantAccount":"string"}},"responses":{"200":"FatcaCustomerResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/party/customers/{customerId}/fatca","fullPath":"/api/v4.2.0/party/customers/{customerId}/fatca","operationId":"updateFatcaCustomer","name":"Update the FATCA customer supplementary information record that stores the related FATCA details for the customer","summary":"Update FATCA customer supplementary information details","tags":[],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"Identifier of the customer"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"citizenships":[{}],"tinDetails":[{}],"Owner":[{}],"JointOwner":[{}],"fatcaClientType":"string","isPlaceOfBirthUs":"string","domicile":"string","greencardDetails":"string","residenceId":"string","isPoa":"string","standingInstructionOnUsAccount":"string","accountInstructionfromUs":"string","socialSecurityNumber":"string","phoneNumber":"string","isDormantAccount":"string"}},"responses":{"200":"FatcaCustomerResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/party/customers/{customerId}/portfolios/{portfolioId}/overdueSettlements","fullPath":"/api/v4.2.0/party/customers/{customerId}/portfolios/{portfolioId}/overdueSettlements","operationId":"getOverdueSettlements","name":"Get overdue settlement","summary":"Get overdue settlement","tags":[],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"Identifier of the customer"},{"name":"portfolioId","in":"path","type":"string","required":true,"description":"Id of the portfolio or security account"},{"name":"transactionId","in":"query","type":"string","required":false,"description":"Unique transaction identifier for retrieving the details of the transaction. For example: FT0102030333 etc."},{"name":"brokerId","in":"query","type":"string","required":false,"description":"The identifier of the broker"},{"name":"tradeDate","in":"query","type":"string","required":false,"description":"Standard date field which records trade date of the account"},{"name":"valueDate","in":"query","type":"string","required":false,"description":"Indicates the value date on which the underlying accounting entry is to be given value (for interest purposes)"},{"name":"depository","in":"query","type":"string","required":false,"description":"Person designated as depository by the company in or pursuant to this Indenture, and, unless otherwise provided with respect to any security, any successor to such person"},{"name":"currency","in":"query","type":"string","required":false,"description":"Identifies the currency. E.g. USD, GBP etc"},{"name":"instrumentId","in":"query","type":"string","required":false,"description":"The identifier of the instrument"},{"name":"deliveryInstruction","in":"query","type":"string","required":false,"description":"Customer's directions to a bank as to the disposition of funds and securities in the customer's account"},{"name":"transactionType","in":"query","type":"string","required":false,"description":"Identifies the transaction type applicable to the transaction being processed, i.e. outward or inward payment. For example: ACPX, OTPX etc."},{"name":"quantity","in":"query","type":"string","required":false,"description":"The nominal quantity"},{"name":"stockExchange","in":"query","type":"string","required":false,"description":"The stock exchange identifier"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"OverdueSettlementsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/party/customers/accountServicingProviders/","fullPath":"/api/v4.2.0/party/customers/accountServicingProviders/","operationId":"getOtherBanksToConnectTo","name":"Retrieves the list of other/external bank details","summary":"Retrieves other banks to connect to details","tags":[],"parameters":[{"name":"openBankingId","in":"query","type":"string","required":false,"description":"Identifies the open banking number of the customer"},{"name":"countryId","in":"query","type":"string","required":false,"description":"ISO country code of the financial institution. "},{"name":"setActive","in":"query","type":"string","required":false,"description":"Flag to set the connection status to active"},{"name":"status","in":"query","type":"string","required":false,"description":"Contains status of the data rights request.Allowed values are INITIATED, INPROGESS, EXTENDED, COMPLETED, REJECTED."},{"name":"extSourceProvider","in":"query","type":"string","required":false,"description":"Contains the name of the external source provider for the customer"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"OtherBanksToConnectToResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/party/customers/prospects","fullPath":"/api/v4.2.0/party/customers/prospects","operationId":"getProspectCustomers","name":"Retrieves the details such as contact information, residence details, personal details and prospect legal details of a prospect customer","summary":"Retrieves prospect customer details of a customer","tags":[],"parameters":[{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"ProspectCustomersResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"POST","path":"/party/customers/prospects","fullPath":"/api/v4.2.0/party/customers/prospects","operationId":"createProspectCustomer","name":"Create a prospect customer with basic details such as contact information, residence details and prospect legal details","summary":"Create a prospect customer","tags":[],"parameters":[{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"customerNames":[{}],"streets":[{}],"addresses":[{}],"townCountries":[{}],"postCodes":[{}],"countries":[{}],"phoneNumbers":[{}],"emails":[{}],"socialNetworkIds":[{}],"prospectLegalDetails":[{}],"personEntity":"string","departmentId":"string","subDepartmentId":"string","floorNumber":"string","locationName":"string"}},"responses":{"200":"ProspectCustomerResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/party/customers/{customerId}/opportunities","fullPath":"/api/v4.2.0/party/customers/{customerId}/opportunities","operationId":"getCustomerOpportunities","name":"Retrieves the details of sales opportunities such as score, status and product details which are likely to be of interest to specific customers","summary":"Retrieves the sales opportunities for specific customers","tags":[],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"Identifier of the customer"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"CustomerOpportunitiesResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/party/customers/{customerId}/requests","fullPath":"/api/v4.2.0/party/customers/{customerId}/requests","operationId":"getCustomerRequests","name":"Retrieves process workflow details such as process name, activity details and status for a specific customer","summary":"Retrieves process workflows for a specific customer","tags":[],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"Identifier of the customer"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"CustomerRequestsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"PUT","path":"/party/customers/prospects/{prospectId}","fullPath":"/api/v4.2.0/party/customers/prospects/{prospectId}","operationId":"updateProspectCustomer","name":"Update a prospect customer with basic details such as contact information, residence details and prospect legal details","summary":"Update the details of the prospect customer","tags":[],"parameters":[{"name":"prospectId","in":"path","type":"string","required":true,"description":"Indicates the status of an onboarding customer. Status can be PROSPECT while onboarding and ACTIVE when the prospect becomes a Customer."},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"customerNames":[{}],"streets":[{}],"addresses":[{}],"townCountries":[{}],"postCodes":[{}],"countries":[{}],"phoneNumbers":[{}],"emails":[{}],"socialNetworkIds":[{}],"prospectLegalDetails":[{}],"personEntity":"string","departmentId":"string","subDepartmentId":"string","floorNumber":"string","locationName":"string"}},"responses":{"200":"ProspectCustomerResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/party/customers/{customerId}/alertRequests","fullPath":"/api/v4.2.0/party/customers/{customerId}/alertRequests","operationId":"getAlertRequests","name":"Retrieves the alert subscription details for specific customer","summary":"Retrieves alert requests details","tags":[],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"Identifier of the customer"},{"name":"contractReference","in":"query","type":"string","required":false,"description":"Contains the contract reference"},{"name":"subscribe","in":"query","type":"string","required":false,"description":"Enables an alert service"},{"name":"alertRequestId","in":"query","type":"string","required":false,"description":"The unique identifier of the alert request."},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"AlertRequestsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}}]},{"key":"party-customerServices-v5.0.0","title":"Customer management","version":"v5.0.0","description":"API to create, update and manage customer details such as delivery preferences, joint customer details, party relationships, KYC details, customer exit status, customer address formats & posting restrictions","endpointCount":68,"endpoints":[{"method":"GET","path":"/party/customers/{customerId}","fullPath":"/api/v5.0.0/party/customers/{customerId}","operationId":"getCustomer","name":"Retrieves the customer details such as customer contact information, residence details, legal document details, occupation details and relationship details for the specific customer","summary":"Retrieves list of customer details","tags":[],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"Identifier of the customer"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"CustomerResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/party/customers/{customerId}","fullPath":"/api/v5.0.0/party/customers/{customerId}","operationId":"updateCustomer","name":"Update customer details with the information such as customer contact information, residence details, legal document details, occupation details and relationship details, etc provided by the user","summary":"Update customer details","tags":[],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"Identifier of the customer"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"displayNames":[{}],"customerNames":[{}],"communicationDevices":[{}],"faxIds":[{}],"officePhoneNumbers":[{}],"streets":[{}],"addresses":[{}],"addressCities":[{}],"countries":[{}],"legalDetails":[{}],"otherNationalityIds":[{}],"employDetails":[{}],"residenceDetails":[{}],"relationshipDetails":[{}],"postingRestrictIds":[{}]}},"responses":{"200":"CustomerResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/party/customers","fullPath":"/api/v5.0.0/party/customers","operationId":"getCustomerInformation","name":"Retrieves the customer details such as delivery or postal details, contact information, residence details, customer profile, legal document details, occupation details and status of customer","summary":"Retrieves list of customer basic details","tags":[],"parameters":[{"name":"customerId","in":"query","type":"string","required":false,"description":"Identifier of the customer"},{"name":"customerName","in":"query","type":"string","required":false,"description":"Name of the customer"},{"name":"street","in":"query","type":"string","required":false,"description":"Contains the first line of customer's base address, example building number, street number etc."},{"name":"addressCity","in":"query","type":"string","required":false,"description":"The town and/or city component of the base address of a customer"},{"name":"countryId","in":"query","type":"string","required":false,"description":"ISO country code of the financial institution. "},{"name":"postCode","in":"query","type":"string","required":false,"description":"Identifies the address postal code for the customer."},{"name":"dateOfBirth","in":"query","type":"string","required":false,"description":"The date of birth of an individual customer"},{"name":"dateOfBirthBW","in":"query","type":"string","required":false,"description":"Indicates the criteria for the between operation on the date of birth"},{"name":"customerStatus","in":"query","type":"string","required":false,"description":"The internal bank status of a customer"},{"name":"sectorId","in":"query","type":"string","required":false,"description":"An institution-defined identifier of the type of customer"},{"name":"sectorIdBW","in":"query","type":"string","required":false,"description":"Indicates the criteria for the between operation on the sector"},{"name":"accountOfficerId","in":"query","type":"string","required":false,"description":"The identifier of the department head or specific account officer responsible for the customer"},{"name":"industryId","in":"query","type":"string","required":false,"description":"An institution-defined identifier of the industry in which the customer is trading, operating or is associated with"},{"name":"nationalityId","in":"query","type":"string","required":false,"description":"The identifier of the nationality of a customer"},{"name":"residenceId","in":"query","type":"string","required":false,"description":"The identifier of the country of residence of a customer"},{"name":"lastName","in":"query","type":"string","required":false,"description":"The last name of an individual customer"},{"name":"phoneNumber","in":"query","type":"string","required":false,"description":"The phone number of the customer or prospect"},{"name":"customerMnemonic","in":"query","type":"string","required":false,"description":"Specifies an alternative easy means of referencing the Customer"},{"name":"firstName","in":"query","type":"string","required":false,"description":"Specifies customer's first name"},{"name":"customerType","in":"query","type":"string","required":false,"description":"Contains the type of customer, for example ACTIVE, PROSPECT."},{"name":"email","in":"query","type":"string","required":false,"description":"Email Identifier of the Customer"},{"name":"mobilePhoneNumber","in":"query","type":"string","required":false,"description":"Represents the phone number of a customer"},{"name":"taxId","in":"query","type":"string","required":false,"description":"Holds the Customer's TAX/SSN Id."},{"name":"shortName","in":"query","type":"string","required":false,"description":"Contains the name of the account, basically the short title of the account."},{"name":"officePhoneNumber","in":"query","type":"string","required":false,"description":"The office phone number of the customer"},{"name":"faxId","in":"query","type":"string","required":false,"description":"The fax (facsimile) number of the customer"},{"name":"address","in":"query","type":"string","required":false,"description":"Communication Address of the Customer"},{"name":"relCustomer","in":"query","type":"string","required":false,"description":"Customers linked or related to the arrangement owner"},{"name":"relationshipCode","in":"query","type":"string","required":false,"description":"Relationship identifier between the partyType and relatedPartyType"},{"name":"legalId","in":"query","type":"string","required":false,"description":"Unique reference number of the legal documents submitted as identification proof"},{"name":"legalDocumentName","in":"query","type":"string","required":false,"description":"Name of the legal documents such as passport, driving licence etc., provided as identification proof"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"CustomerInformationResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"POST","path":"/party/customers","fullPath":"/api/v5.0.0/party/customers","operationId":"createCustomer","name":"Create a customer with the information such as customer contact information, residence details, legal document details, occupation details and relationship details, etc provided by the user","summary":"Create a customer","tags":[],"parameters":[{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"displayNames":[{}],"customerNames":[{}],"communicationDevices":[{}],"faxIds":[{}],"officePhoneNumbers":[{}],"streets":[{}],"addresses":[{}],"addressCities":[{}],"countries":[{}],"legalDetails":[{}],"otherNationalityIds":[{}],"employDetails":[{}],"residenceDetails":[{}],"relationshipDetails":[{}],"postingRestrictIds":[{}]}},"responses":{"200":"CustomerResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/party/customers/relationships","fullPath":"/api/v5.0.0/party/customers/relationships","operationId":"getCustomerRelationship","name":"Retrieves customer relationship details such as type of relationship, party information, relatedAs details, owning details, role & purpose of relationship for specific party or customer","summary":"Retrieves list of customer relationships","tags":[],"parameters":[{"name":"customerRelationGroupId","in":"query","type":"string","required":false,"description":"Identifies the key to Customer Relationship Group to form a relation"},{"name":"partyId","in":"query","type":"string","required":false,"description":"Allows capturing of customers or person entities to be part of the relationship. If partyType is selected as Customer, then the system will allow only customer Ids to be captured into this field. If p"},{"name":"relatedPartyId","in":"query","type":"string","required":false,"description":"Identifier of the Related Party"},{"name":"relationId","in":"query","type":"string","required":false,"description":"Identifier of the Customer Relationship and Party Relationship"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"CustomerRelationshipResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"POST","path":"/party/customers/relationships","fullPath":"/api/v5.0.0/party/customers/relationships","operationId":"createCustomerRelationship","name":"Create a customer relationship for a customer with details such as type of relationship, party information, relatedAs details, owning details, role & purpose of relationship","summary":"Create customer relationship with other customers","tags":[],"parameters":[{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"originatingRelation":[{}],"customerRelationGroupId":0.0,"customerRelationGroupName":"string","purposeOfRelationship":"string"}},"responses":{"200":"CustomerRelationshipResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/party/customers/relationships/{relationId}","fullPath":"/api/v5.0.0/party/customers/relationships/{relationId}","operationId":"updateCustomerRelationship","name":"Update customer relationship for a customer with details such as type of relationship, party information, related details, owning details, role & purpose of relationship","summary":"Update customer relationship","tags":[],"parameters":[{"name":"relationId","in":"path","type":"string","required":true,"description":"Identifier of the Customer Relationship and Party Relationship"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"originatingRelation":[{}],"customerRelationGroupId":0.0,"customerRelationGroupName":"string","purposeOfRelationship":"string"}},"responses":{"200":"CustomerRelationshipResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/party/customers/reportingStatus","fullPath":"/api/v5.0.0/party/customers/reportingStatus","operationId":"getCustomerReportingStatus","name":"Retrieves the FATCA/CRS reporting status and reporting jurisdiction of the customer","summary":"Retrieves reporting status of the customer","tags":[],"parameters":[{"name":"customerId","in":"query","type":"string","required":true,"description":"Identifier of the customer"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"CustomerReportingStatusResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/party/customers/{customerId}/sweeps","fullPath":"/api/v5.0.0/party/customers/{customerId}/sweeps","operationId":"getCustomerSweeps","name":"Retrieves account sweep details such as sweep reference, type, balance requirements for sweep & frequency of sweep for the list of accounts available to a customer","summary":"Retrieves account sweep details of the specific customer","tags":[],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"Identifier of the customer"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"CustomerSweepsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/party/customers/{customerId}/deliveryOptions","fullPath":"/api/v5.0.0/party/customers/{customerId}/deliveryOptions","operationId":"getCustomerDeliveryOptions","name":"Retrieves the delivery preferences of the customer such as the message group, carrier and address.","summary":"Retrieves delivery preferences of the customer","tags":[],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"Identifier of the customer"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"CustomerDeliveryOptionsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/party/customers/{customerId}/channels","fullPath":"/api/v5.0.0/party/customers/{customerId}/channels","operationId":"getCustomerDigitalChannels","name":"Retrieves the list of message channels such as internet banking, mobile banking, ATM, etc available for the specific customer","summary":"Retrieves list of message channels","tags":[],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"Identifier of the customer"},{"name":"channelName","in":"query","type":"string","required":false,"description":"Name of the (digital) channel registered by the Customer"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"CustomerDigitalChannelsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"POST","path":"/party/customers/messages","fullPath":"/api/v5.0.0/party/customers/messages","operationId":"createMessages","name":"Create a new secure message for a customer to be sent by bank","summary":"Create a new secure message for a customer","tags":[],"parameters":[{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"messages":[{}],"subject":"string","toCustomerId":"string"}},"responses":{"200":"MessagesResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/party/customers/{customerId}/jointCustomers","fullPath":"/api/v5.0.0/party/customers/{customerId}/jointCustomers","operationId":"getJointCustomerDetails","name":"Retrieves details such as joint relation code, name, joint customer details and reverse relationships for a specific customer","summary":"Retrieves joint customer details for a specific customer","tags":[],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"Identifier of the customer"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"JointCustomerDetailsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/party/customers/{customerId}/KYC","fullPath":"/api/v5.0.0/party/customers/{customerId}/KYC","operationId":"getCustomerKYCDetails","name":"Retrieves the KYC details such as contact date, introducer, last and next review date, KYC and AML status of a customer","summary":"Retrieves KYC details for a specific customer","tags":[],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"Identifier of the customer"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"CustomerKYCDetailsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/party/customers/{customerId}/personalProfiles","fullPath":"/api/v5.0.0/party/customers/{customerId}/personalProfiles","operationId":"getCustomerPersonalDetails","name":"Retrieves personal details such as residence, communication details, occupation details, asset & liability information","summary":"Retrieves personal details of customer","tags":[],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"Identifier of the customer"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"CustomerPersonalDetailsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/party/customers/postingRestrictions","fullPath":"/api/v5.0.0/party/customers/postingRestrictions","operationId":"getCustomerPostingRestrictions","name":"Retrieves the credit and debit posting restriction details such as restriction reference and name of restriction set for a customer","summary":"Retrieves posting restriction details","tags":[],"parameters":[{"name":"customerId","in":"query","type":"string","required":false,"description":"Identifier of the customer"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"CustomerPostingRestrictionsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"POST","path":"/party/relationships/{relationId}","fullPath":"/api/v5.0.0/party/relationships/{relationId}","operationId":"createPartyRelationship","name":"Create a party relationship between a person, entity or customer with details such as party name, type, relatedAs, relation code and owning details","summary":"Create party relationship details","tags":[],"parameters":[{"name":"relationId","in":"path","type":"string","required":true,"description":"Identifier of the Customer Relationship and Party Relationship"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"partyDisplayNames":[{}],"partyRelationships":[{}]}},"responses":{"200":"PartyRelationshipResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/party/relationships/{relationId}","fullPath":"/api/v5.0.0/party/relationships/{relationId}","operationId":"updatePartyRelationship","name":"Update party relationship between a person, entity or customer with details such as party name, type, relatedAs, relation code and owning details","summary":"Update party relationship details","tags":[],"parameters":[{"name":"relationId","in":"path","type":"string","required":true,"description":"Identifier of the Customer Relationship and Party Relationship"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"partyDisplayNames":[{}],"partyRelationships":[{}]}},"responses":{"200":"PartyRelationshipResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/party/customers/{customerId}/cards","fullPath":"/api/v5.0.0/party/customers/{customerId}/cards","operationId":"getCustomerCreditCards","name":"Retrieves the card details such as card number, card type and status, linked account and its balances of a customer","summary":"Retrieves card details of a customer","tags":[],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"Identifier of the customer"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"CustomerCreditCardsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/party/customers/{customerId}/standingOrders","fullPath":"/api/v5.0.0/party/customers/{customerId}/standingOrders","operationId":"getStandingOrders","name":"Retrieves the list of standing instructions for a customer with details such as instruction reference, order type, frequency of payments, mode of payment and credit & debit parties involved","summary":"Retrieves standing instruction details of a customer","tags":[],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"Identifier of the customer"},{"name":"standingOrderId","in":"query","type":"string","required":false,"description":"The unique standing order identifier"},{"name":"accountId","in":"query","type":"string","required":false,"description":"Identifier of the account. Often referred to as the account number, yet for consistency this is always referred to as accountId. Accepts both IBAN & BBAN"},{"name":"orderingCustomerId","in":"query","type":"string","required":false,"description":"Indicates the customer id for the ordering customer"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"StandingOrdersResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/party/customers/{customerId}/directDebits","fullPath":"/api/v5.0.0/party/customers/{customerId}/directDebits","operationId":"getDirectDebits","name":"Retrieves the list of direct debits for a customer with details such as direct debit reference, debit & credit accounts, transaction amount, payment frequency, next payment date and direction of payment","summary":"Retrieves direct debits details of a customer","tags":[],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"Identifier of the customer"},{"name":"directDebitId","in":"query","type":"string","required":false,"description":"The unique identifier of the direct debit mandate. "},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"DirectDebitsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"POST","path":"/party/customers/deliveryPreferences/{deliveryPreferenceId}","fullPath":"/api/v5.0.0/party/customers/deliveryPreferences/{deliveryPreferenceId}","operationId":"createDeliveryPreference","name":"Creates delivery preferences for a customer or account with message group, carrier, role, address, email details and format of messages","summary":"Create customer delivery preferences","tags":[],"parameters":[{"name":"deliveryPreferenceId","in":"path","type":"string","required":true,"description":"Identifier of the customer delivery preferences"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"messageGroup":[{}],"otherMessagesDetail":[{}],"applyOtherMessages":"string"}},"responses":{"200":"DeliveryPreferenceResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/party/customers/deliveryPreferences/{deliveryPreferenceId}","fullPath":"/api/v5.0.0/party/customers/deliveryPreferences/{deliveryPreferenceId}","operationId":"updateDeliveryPreference","name":"Update delivery preferences for a  customer or account with message group, carrier, role, address & email details, format of messages","summary":"Update customer delivery preferences","tags":[],"parameters":[{"name":"deliveryPreferenceId","in":"path","type":"string","required":true,"description":"Identifier of the customer delivery preferences"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"messageGroup":[{}],"otherMessagesDetail":[{}],"applyOtherMessages":"string"}},"responses":{"200":"DeliveryPreferenceResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/party/customers/limits/{limitId}","fullPath":"/api/v5.0.0/party/customers/limits/{limitId}","operationId":"updateLimit","name":"Updates the limit details such as currency, limit grade, commodity, country and limit product details","summary":"Update credit limit details for customer","tags":[],"parameters":[{"name":"limitId","in":"path","type":"string","required":true,"description":"The identifier of credit limit"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"countries":[{}],"grades":[{}],"commodities":[{}],"currencyId":"string","onlineLimitDate":"2024-01-01","availableMarker":"string","allowNetting":"string","onlineUpdate":"string","limitProductId":"string","checkLimit":"string","band":"string","reducingLimit":"string","internalAmount":"string"}},"responses":{"200":"LimitResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/party/customers/{customerId}/customerExitStatus","fullPath":"/api/v5.0.0/party/customers/{customerId}/customerExitStatus","operationId":"getCustomerExitStatus","name":"Retrieves customer exit status details such as customer type, exit date, status and reason","summary":"Retrieves customer exit status details of customer","tags":[],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"Identifier of the customer"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"CustomerExitStatusResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"PUT","path":"/party/customers/{customerId}/customerExitStatus","fullPath":"/api/v5.0.0/party/customers/{customerId}/customerExitStatus","operationId":"updateCustomerExitStatus","name":"Update a customer record with exit status and exit reason marking the customer as blocked or rejected or closed","summary":"Update customer exit status details of customers","tags":[],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"Identifier of the customer"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"exitStatus":"string","exitReason":"string"}},"responses":{"200":"CustomerExitStatusResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/party/customers/settings/customerExitStatus/{customerExitStatusId}","fullPath":"/api/v5.0.0/party/customers/settings/customerExitStatus/{customerExitStatusId}","operationId":"getCustomerExitStatusParam","name":"Retrieves available conditions such as customer exit setup reference, allowed reasons and allowed re-open details to update customer exit status of customers","summary":"Retrieves conditions to update customer exit status of customer","tags":[],"parameters":[{"name":"customerExitStatusId","in":"path","type":"string","required":true,"description":"The field reflects the exit status ID of a customer or prospect from the parameterization table CUSTOMER.EXIT.STATUS"},{"name":"customerType","in":"query","type":"string","required":false,"description":"Contains the type of customer, for example ACTIVE, PROSPECT."},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"CustomerExitStatusParamResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"POST","path":"/party/customers/settings/customerExitStatus/{customerExitStatusId}","fullPath":"/api/v5.0.0/party/customers/settings/customerExitStatus/{customerExitStatusId}","operationId":"createCustomerExitStatusParam","name":"Create conditions such as applicable customer type and allowed reasons to update the customer exit status details of customers","summary":"Create conditions to update customer exit status of customer","tags":[],"parameters":[{"name":"customerExitStatusId","in":"path","type":"string","required":true,"description":"The field reflects the exit status ID of a customer or prospect from the parameterization table CUSTOMER.EXIT.STATUS"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"allowedExitReasons":[{}],"exitStatusDescription":"string","customerType":"string","allowRemoveExitStatus":"string"}},"responses":{"200":"CustomerExitStatusParamResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/party/customers/settings/{customerExitStatusId}/customerExitStatus","fullPath":"/api/v5.0.0/party/customers/settings/{customerExitStatusId}/customerExitStatus","operationId":"updateCustomerExitStatusParam","name":"Create conditions such as applicable customer type and allowed reasons to update the customer exit status details of customers","summary":"Create conditions to update customer exit status of customer","tags":[],"parameters":[{"name":"customerExitStatusId","in":"path","type":"string","required":true,"description":"The field reflects the exit status ID of a customer or prospect from the parameterization table CUSTOMER.EXIT.STATUS"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"allowedExitReasons":[{}],"exitStatusDescription":"string","customerType":"string","allowRemoveExitStatus":"string"}},"responses":{"200":"CustomerExitStatusParamResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/party/customers/{customerId}/addresses","fullPath":"/api/v5.0.0/party/customers/{customerId}/addresses","operationId":"getCustomerAddressOutput","name":"Returns structured/unstructured address details of specified customer based on address option in request. When structured format is requested, the values are returned in format of structured data name combined with corresponding customer address value. When unstructured format is requested, the address details are returned based on configured unstructured address format.","summary":"Retrieves structured/ unstructured address format of customer","tags":[],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"Identifier of the customer"},{"name":"addressOption","in":"query","type":"string","required":false,"description":"It reflects the preference for the customer address format, respective structured, unstructured or both"},{"name":"addressOutputFormat","in":"query","type":"string","required":false,"description":"It identifies the address output format for the unstructured address"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"CustomerAddressOutputResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/party/customers/{customerId}/shortNames","fullPath":"/api/v5.0.0/party/customers/{customerId}/shortNames","operationId":"getCustomerShortNames","name":"Retrieves customer short name that can be used as customer enrichment by any application","summary":"Retrieves customer short name","tags":[],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"Identifier of the customer"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"CustomerShortNamesResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/party/customers/{customerId}/mandates","fullPath":"/api/v5.0.0/party/customers/{customerId}/mandates","operationId":"getCustomerMandates","name":"Retrieves the mandate instruction details such as application eligible for mandate process and the corresponding mandate rule that is being applied to check mandates for transactions involving the specified customer.","summary":"Retrieves mandate instruction applicable for the requested customer","tags":[],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"Identifier of the customer"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"CustomerMandatesResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/party/customers/{customerId}/documents","fullPath":"/api/v5.0.0/party/customers/{customerId}/documents","operationId":"getCustomerLegalDocuments","name":"Retrieves the details of legal document provided by the customer such as document name, document id, issue date, expiry date and authority who issued the document.","summary":"Retrieves the customer legal document details","tags":[],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"Identifier of the customer"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"CustomerLegalDocumentsResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/party/customers/{customerId}/profiles","fullPath":"/api/v5.0.0/party/customers/{customerId}/profiles","operationId":"getCustomerProfile","name":"Retrieves the customer basic details such as personal information, address location, basic contact details and other general information.","summary":"Retrieves profile details of the requested customer","tags":[],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"CustomerProfileResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/party/customers/alternateReferences/{alternateReference}","fullPath":"/api/v5.0.0/party/customers/alternateReferences/{alternateReference}","operationId":"getCustomerId","name":"Retrieves the customer identifier for the provided alternate reference of the customer","summary":"Retrieves customer id for the given alternate reference","tags":[],"parameters":[{"name":"alternateReference","in":"path","type":"string","required":true,"description":"If the new Account to be created is a shadow of another Account already exisitng in another system, then the Account reference of that system can be specified here. The value given in this field will "},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"CustomerIdResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/party/customers/{customerId}/restrictions","fullPath":"/api/v5.0.0/party/customers/{customerId}/restrictions","operationId":"getCustomerRestrictions","name":"Retrieves the transaction restrictions imposed on the customer specified. Restrictions can be post no entries, black listed customer, pending KYC due reasons for restricting transactions on this customer","summary":"Retrieves the restriction details","tags":[],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"CustomerRestrictionsResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/party/customers/{customerId}/contacts","fullPath":"/api/v5.0.0/party/customers/{customerId}/contacts","operationId":"getCustomerContacts","name":"Retrieves the contact details such as phone number, mobile numbers, fax and email address specific to the requested customer","summary":"Retrieves the customer contact details","tags":[],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"Identifier of the customer"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"CustomerContactsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/party/customers/{customerId}/relationships","fullPath":"/api/v5.0.0/party/customers/{customerId}/relationships","operationId":"getCustomerRelationships","name":"Retrieves the relationship details such as related customer and the relationship that exists with the requested customer","summary":"Retrieves the relation customers","tags":[],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"CustomerRelationshipsResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/party/customers/{customerId}/payments","fullPath":"/api/v5.0.0/party/customers/{customerId}/payments","operationId":"getPartyBasicDetails","name":"Retrieves the customer information that are required for processing or validating the customer involved in a payment transaction. Provides the information such as customer name details, birth details, address details,  market sector, target, nationality, residence country and preferred language for communication.","summary":"Retrieves customer details required for payment processing","tags":[],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"Identifier of the customer"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"PartyBasicDetailsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/party/customers/{customerId}/addresses/swiftAddresses/{addressId}","fullPath":"/api/v5.0.0/party/customers/{customerId}/addresses/swiftAddresses/{addressId}","operationId":"getCustomerSwiftAddress","name":"Retrieves the SWIFT address details such as delivery address, short name & tag25 indicator for the customer.","summary":"Retrieves the SWIFT address details for the customer.","tags":[],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"Identifier of the customer"},{"name":"addressId","in":"path","type":"string","required":true,"description":"Reference Id of address record"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"CustomerSwiftAddressResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/party/customers/{customerId}/charges","fullPath":"/api/v5.0.0/party/customers/{customerId}/charges","operationId":"getCustomerCharge","name":"Retrieves customer charge for a customer with details such as tax type and tax group.","summary":"Retrieves customer charge for a specific customer.","tags":[],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"Identifier of the customer"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"CustomerChargeResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"POST","path":"/party/customers/{customerId}/charges","fullPath":"/api/v5.0.0/party/customers/{customerId}/charges","operationId":"createCustomerCharge","name":"Creates customer charge for a customer with details such as tax type and tax group.","summary":"Creates customer charge for a specific customer.","tags":[],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"Identifier of the customer"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"taxGroups":[{}]}},"responses":{"200":"CustomerChargeResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/party/customers/{customerId}/charges","fullPath":"/api/v5.0.0/party/customers/{customerId}/charges","operationId":"updateCustomerCharge","name":"Updates customer charge for a customer with details such as tax type and tax group.","summary":"Updates customer charge for a specific customer.","tags":[],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"Identifier of the customer"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"taxGroups":[{}]}},"responses":{"200":"CustomerChargeResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/party/customers/{customerId}/addresses/smsAddresses","fullPath":"/api/v5.0.0/party/customers/{customerId}/addresses/smsAddresses","operationId":"getCustomerPhoneAddress","name":"Retrieves the list of customer sms communication address with details such as name, idd prefix and mobile number.","summary":"Retrieves available list of customer sms communication addresses","tags":[],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"Identifier of the customer"},{"name":"addressId","in":"query","type":"string","required":false,"description":"Reference Id of address record"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"CustomerPhoneAddressResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"POST","path":"/party/customers/{customerId}/addresses/smsAddresses","fullPath":"/api/v5.0.0/party/customers/{customerId}/addresses/smsAddresses","operationId":"createCustomerPhoneAddress","name":"Create customer sms communication address with details such as name, idd prefix and mobile number.","summary":"Creates customer sms communication address","tags":[],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"Identifier of the customer"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"customerShortNames":[{}],"iddPrefixMobile":"string","mobileNumber":"string"}},"responses":{"200":"CustomerPhoneAddressResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/party/customers/{customerId}/addresses/emailAddresses","fullPath":"/api/v5.0.0/party/customers/{customerId}/addresses/emailAddresses","operationId":"getCustomerEmailAddress","name":"Retrieves the list of customer email communication address with details such as customer name and email references.","summary":"Retrieves available list of customer email communication addresses","tags":[],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"Identifier of the customer"},{"name":"addressId","in":"query","type":"string","required":false,"description":"Reference Id of address record"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"CustomerEmailAddressResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"POST","path":"/party/customers/{customerId}/addresses/emailAddresses","fullPath":"/api/v5.0.0/party/customers/{customerId}/addresses/emailAddresses","operationId":"createCustomerEmailAddress","name":"Create customer email communication address with details such as customer name and email references.","summary":"Creates customer email communication address","tags":[],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"Identifier of the customer"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"customerShortNames":[{}],"email":"string"}},"responses":{"200":"CustomerEmailAddressResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/party/customers/{customerId}/addresses/printAddresses","fullPath":"/api/v5.0.0/party/customers/{customerId}/addresses/printAddresses","operationId":"getCustomerPrintAddress","name":"Retrieves the list of customer print communication addresses with details such as name, address, postcode and phone number.","summary":"Retrieves available list of customer print communication addresses","tags":[],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"Identifier of the customer"},{"name":"addressId","in":"query","type":"string","required":false,"description":"Reference Id of address record"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"CustomerPrintAddressResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"POST","path":"/party/customers/{customerId}/addresses/printAddresses","fullPath":"/api/v5.0.0/party/customers/{customerId}/addresses/printAddresses","operationId":"createCustomerPrintAddress","name":"Create customer print communication address with details such as name, address, postcode and phone number.","summary":"Creates customer print communication address","tags":[],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"Identifier of the customer"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"customerShortNames":[{}],"customerNames":[{}],"addresses":[{}],"streets":[{}],"towns":[{}],"postCodes":[{}],"addressPurpose":"string","addressLocation":"string","addressVerifier":"string","countryCode":"string","departmentId":"string","subDepartmentId":"string","flatNumber":"string","buildingName":"string","buildingNumber":"string"}},"responses":{"200":"CustomerPrintAddressResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/party/customers/addresses/{customerAddressId}/smsAddresses","fullPath":"/api/v5.0.0/party/customers/addresses/{customerAddressId}/smsAddresses","operationId":"updateCustomerPhoneAddress","name":"Update customer sms communication address with details such as name, idd prefix and mobile number.","summary":"Updates customer sms communication address","tags":[],"parameters":[{"name":"customerAddressId","in":"path","type":"string","required":true,"description":"Identifier of the customer address table."},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"customerShortNames":[{}],"iddPrefixMobile":"string","mobileNumber":"string"}},"responses":{"200":"CustomerPhoneAddressResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"DELETE","path":"/party/customers/addresses/{customerAddressId}/smsAddresses","fullPath":"/api/v5.0.0/party/customers/addresses/{customerAddressId}/smsAddresses","operationId":"deleteCustomerPhoneAddress","name":"Delete the specified customer sms communication address that are no longer used.","summary":"Deletes customer sms communication address","tags":[],"parameters":[{"name":"customerAddressId","in":"path","type":"string","required":true,"description":"Identifier of the customer address table."},{"name":"payload","in":"body","type":"object","required":false,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}}},"responses":{"200":"CustomerPhoneAddressResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/party/customers/addresses/{customerAddressId}/emailAddresses","fullPath":"/api/v5.0.0/party/customers/addresses/{customerAddressId}/emailAddresses","operationId":"updateCustomerEmailAddress","name":"Update customer email communication address with details such as customer name and email references.","summary":"Updates customer email communication address","tags":[],"parameters":[{"name":"customerAddressId","in":"path","type":"string","required":true,"description":"Identifier of the customer address table."},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"customerShortNames":[{}],"email":"string"}},"responses":{"200":"CustomerEmailAddressResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"DELETE","path":"/party/customers/addresses/{customerAddressId}/emailAddresses","fullPath":"/api/v5.0.0/party/customers/addresses/{customerAddressId}/emailAddresses","operationId":"deleteCustomerEmailAddress","name":"Delete the specified customer email communication address that are no longer used.","summary":"Deletes customer email communication address","tags":[],"parameters":[{"name":"customerAddressId","in":"path","type":"string","required":true,"description":"Identifier of the customer address table."},{"name":"payload","in":"body","type":"object","required":false,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}}},"responses":{"200":"CustomerEmailAddressResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/party/customers/addresses/{customerAddressId}/printAddresses","fullPath":"/api/v5.0.0/party/customers/addresses/{customerAddressId}/printAddresses","operationId":"updateCustomerPrintAddress","name":"Update customer print communication address with details such as name, address, postcode and phone number.","summary":"Updates customer print communication address","tags":[],"parameters":[{"name":"customerAddressId","in":"path","type":"string","required":true,"description":"Identifier of the customer address table."},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"customerShortNames":[{}],"customerNames":[{}],"addresses":[{}],"streets":[{}],"towns":[{}],"postCodes":[{}],"addressPurpose":"string","addressLocation":"string","addressVerifier":"string","countryCode":"string","departmentId":"string","subDepartmentId":"string","flatNumber":"string","buildingName":"string","buildingNumber":"string"}},"responses":{"200":"CustomerPrintAddressResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"DELETE","path":"/party/customers/addresses/{customerAddressId}/printAddresses","fullPath":"/api/v5.0.0/party/customers/addresses/{customerAddressId}/printAddresses","operationId":"deleteCustomerPrintAddress","name":"Delete the specified customer print communication address that are no longer used.","summary":"Deletes customer print communication address","tags":[],"parameters":[{"name":"customerAddressId","in":"path","type":"string","required":true,"description":"Identifier of the customer address table."},{"name":"payload","in":"body","type":"object","required":false,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}}},"responses":{"200":"CustomerPrintAddressResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/party/customers/{customerId}/consents","fullPath":"/api/v5.0.0/party/customers/{customerId}/consents","operationId":"getCustomerConsents","name":"Retrieves the list of consent details for specific customer","summary":"Retrieves customer consents details","tags":[],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"Identifier of the customer"},{"name":"propertyClassId","in":"query","type":"string","required":false,"description":"The identifier of a condition that is used to build a product"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"CustomerConsentsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"POST","path":"/party/customers/{customerId}/fatca","fullPath":"/api/v5.0.0/party/customers/{customerId}/fatca","operationId":"createFatcaCustomer","name":"Creates the FATCA customer supplementary information record that stores the related FATCA details for the customer","summary":"Create FATCA customer supplementary information details","tags":[],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"Identifier of the customer"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"citizenships":[{}],"tinDetails":[{}],"Owner":[{}],"JointOwner":[{}],"fatcaClientType":"string","isPlaceOfBirthUs":"string","domicile":"string","greencardDetails":"string","residenceId":"string","isPoa":"string","standingInstructionOnUsAccount":"string","accountInstructionfromUs":"string","socialSecurityNumber":"string","phoneNumber":"string","isDormantAccount":"string"}},"responses":{"200":"FatcaCustomerResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/party/customers/{customerId}/fatca","fullPath":"/api/v5.0.0/party/customers/{customerId}/fatca","operationId":"updateFatcaCustomer","name":"Update the FATCA customer supplementary information record that stores the related FATCA details for the customer","summary":"Update FATCA customer supplementary information details","tags":[],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"Identifier of the customer"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"citizenships":[{}],"tinDetails":[{}],"Owner":[{}],"JointOwner":[{}],"fatcaClientType":"string","isPlaceOfBirthUs":"string","domicile":"string","greencardDetails":"string","residenceId":"string","isPoa":"string","standingInstructionOnUsAccount":"string","accountInstructionfromUs":"string","socialSecurityNumber":"string","phoneNumber":"string","isDormantAccount":"string"}},"responses":{"200":"FatcaCustomerResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/party/customers/{customerId}/portfolios/{portfolioId}/overdueSettlements","fullPath":"/api/v5.0.0/party/customers/{customerId}/portfolios/{portfolioId}/overdueSettlements","operationId":"getOverdueSettlements","name":"Get overdue settlement","summary":"Get overdue settlement","tags":[],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"Identifier of the customer"},{"name":"portfolioId","in":"path","type":"string","required":true,"description":"Id of the portfolio or security account"},{"name":"transactionId","in":"query","type":"string","required":false,"description":"Unique transaction identifier for retrieving the details of the transaction. For example: FT0102030333 etc."},{"name":"brokerId","in":"query","type":"string","required":false,"description":"The identifier of the broker"},{"name":"tradeDate","in":"query","type":"string","required":false,"description":"Standard date field which records trade date of the account"},{"name":"valueDate","in":"query","type":"string","required":false,"description":"Indicates the value date on which the underlying accounting entry is to be given value (for interest purposes)"},{"name":"depository","in":"query","type":"string","required":false,"description":"Person designated as depository by the company in or pursuant to this Indenture, and, unless otherwise provided with respect to any security, any successor to such person"},{"name":"currency","in":"query","type":"string","required":false,"description":"Identifies the currency. E.g. USD, GBP etc"},{"name":"instrumentId","in":"query","type":"string","required":false,"description":"The identifier of the instrument"},{"name":"deliveryInstruction","in":"query","type":"string","required":false,"description":"Customer's directions to a bank as to the disposition of funds and securities in the customer's account"},{"name":"transactionType","in":"query","type":"string","required":false,"description":"Identifies the transaction type applicable to the transaction being processed, i.e. outward or inward payment. For example: ACPX, OTPX etc."},{"name":"quantity","in":"query","type":"string","required":false,"description":"The nominal quantity"},{"name":"stockExchange","in":"query","type":"string","required":false,"description":"The stock exchange identifier"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"OverdueSettlementsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/party/customers/accountServicingProviders","fullPath":"/api/v5.0.0/party/customers/accountServicingProviders","operationId":"getOtherBanksToConnectTo","name":"Retrieves the list of other/external bank details","summary":"Retrieves other banks to connect to details","tags":[],"parameters":[{"name":"openBankingId","in":"query","type":"string","required":false,"description":"Identifies the open banking number of the customer"},{"name":"countryId","in":"query","type":"string","required":false,"description":"ISO country code of the financial institution. "},{"name":"setActive","in":"query","type":"string","required":false,"description":"Flag to set the connection status to active"},{"name":"status","in":"query","type":"string","required":false,"description":"Contains status of the data rights request.Allowed values are INITIATED, INPROGESS, EXTENDED, COMPLETED, REJECTED."},{"name":"extSourceProvider","in":"query","type":"string","required":false,"description":"Contains the name of the external source provider for the customer"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"OtherBanksToConnectToResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/party/customers/prospects","fullPath":"/api/v5.0.0/party/customers/prospects","operationId":"getProspectCustomers","name":"Retrieves the details such as contact information, residence details, personal details and prospect legal details of a prospect customer","summary":"Retrieves prospect customer details of a customer","tags":[],"parameters":[{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"ProspectCustomersResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"POST","path":"/party/customers/prospects","fullPath":"/api/v5.0.0/party/customers/prospects","operationId":"createProspectCustomer","name":"Create a prospect customer with basic details such as contact information, residence details and prospect legal details","summary":"Create a prospect customer","tags":[],"parameters":[{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"customerNames":[{}],"streets":[{}],"addresses":[{}],"townCountries":[{}],"postCodes":[{}],"countries":[{}],"phoneNumbers":[{}],"emails":[{}],"socialNetworkIds":[{}],"prospectLegalDetails":[{}],"personEntity":"string","departmentId":"string","subDepartmentId":"string","floorNumber":"string","locationName":"string"}},"responses":{"200":"ProspectCustomerResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/party/customers/{customerId}/opportunities","fullPath":"/api/v5.0.0/party/customers/{customerId}/opportunities","operationId":"getCustomerOpportunities","name":"Retrieves the details of sales opportunities such as score, status and product details which are likely to be of interest to specific customers","summary":"Retrieves the sales opportunities for specific customers","tags":[],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"Identifier of the customer"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"CustomerOpportunitiesResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/party/customers/{customerId}/requests","fullPath":"/api/v5.0.0/party/customers/{customerId}/requests","operationId":"getCustomerRequests","name":"Retrieves process workflow details such as process name, activity details and status for a specific customer","summary":"Retrieves process workflows for a specific customer","tags":[],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"Identifier of the customer"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"CustomerRequestsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"PUT","path":"/party/customers/prospects/{prospectId}","fullPath":"/api/v5.0.0/party/customers/prospects/{prospectId}","operationId":"updateProspectCustomer","name":"Update a prospect customer with basic details such as contact information, residence details and prospect legal details","summary":"Update the details of the prospect customer","tags":[],"parameters":[{"name":"prospectId","in":"path","type":"string","required":true,"description":"Indicates the status of an onboarding customer. Status can be PROSPECT while onboarding and ACTIVE when the prospect becomes a Customer."},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"customerNames":[{}],"streets":[{}],"addresses":[{}],"townCountries":[{}],"postCodes":[{}],"countries":[{}],"phoneNumbers":[{}],"emails":[{}],"socialNetworkIds":[{}],"prospectLegalDetails":[{}],"personEntity":"string","departmentId":"string","subDepartmentId":"string","floorNumber":"string","locationName":"string"}},"responses":{"200":"ProspectCustomerResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/party/customers/{customerId}/alertRequests","fullPath":"/api/v5.0.0/party/customers/{customerId}/alertRequests","operationId":"getAlertRequests","name":"Retrieves the alert subscription details for specific customer","summary":"Retrieves alert requests details","tags":[],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"Identifier of the customer"},{"name":"contractReference","in":"query","type":"string","required":false,"description":"Contains the contract reference"},{"name":"subscribe","in":"query","type":"string","required":false,"description":"Enables an alert service"},{"name":"alertRequestId","in":"query","type":"string","required":false,"description":"The unique identifier of the alert request."},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"AlertRequestsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/party/relationships/{partyId}/relations","fullPath":"/api/v5.0.0/party/relationships/{partyId}/relations","operationId":"getPartyRelationship","name":"Retrieves the relationship details such as party name, type, relation code, status and owning percentage of a customers involved in a relationship","summary":"Retrieves list of party relationship details","tags":[],"parameters":[{"name":"partyId","in":"path","type":"string","required":true,"description":"Allows capturing of customers or person entities to be part of the relationship. If partyType is selected as Customer, then the system will allow only customer Ids to be captured into this field. If p"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"PartyRelationshipResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"POST","path":"/party/customers/staticDataUpdateEvents","fullPath":"/api/v5.0.0/party/customers/staticDataUpdateEvents","operationId":"createCustomerStaticChange","name":"Creates log of customer static  data update events for customer that has undergone static data updates from external party systems","summary":"Creates log of customer static data update event from external party systems","tags":[],"parameters":[{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"creationDate":"string","requestTime":"string","eventName":"string","customerId":"string"}},"responses":{"200":"CustomerStaticChangeResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}}]},{"key":"party-customerServices-v5.1.0","title":"Customer management","version":"v5.1.0","description":"API to create, update and manage customer details such as delivery preferences, joint customer details, party relationships, KYC details, alert subscriptions, customer exit status, customer address formats & posting restrictions","endpointCount":68,"endpoints":[{"method":"GET","path":"/party/customers/{customerId}","fullPath":"/api/v5.1.0/party/customers/{customerId}","operationId":"getCustomer","name":"Retrieves the customer details such as customer contact information, residence details, legal document details, occupation details and relationship details for the specific customer","summary":"Retrieves customer details","tags":[],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"Identifier of the customer"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"CustomerResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/party/customers/{customerId}","fullPath":"/api/v5.1.0/party/customers/{customerId}","operationId":"updateCustomer","name":"Update customer details with the information such as customer contact information, residence details, legal document details, occupation details and relationship details, etc provided by the user","summary":"Update customer details","tags":[],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"Identifier of the customer"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"displayNames":[{}],"customerNames":[{}],"communicationDevices":[{}],"faxIds":[{}],"officePhoneNumbers":[{}],"streets":[{}],"addresses":[{}],"addressCities":[{}],"countries":[{}],"legalDetails":[{}],"otherNationalityIds":[{}],"employDetails":[{}],"residenceDetails":[{}],"relationshipDetails":[{}],"postingRestrictIds":[{}]}},"responses":{"200":"CustomerResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/party/customers","fullPath":"/api/v5.1.0/party/customers","operationId":"getCustomerInformation","name":"Retrieves the customer details such as delivery or postal details, contact information, residence details, customer profile, legal document details, occupation details and status of customer","summary":"Retrieves list of customer basic details","tags":[],"parameters":[{"name":"customerId","in":"query","type":"string","required":false,"description":"Identifier of the customer"},{"name":"customerName","in":"query","type":"string","required":false,"description":"Name of the customer"},{"name":"street","in":"query","type":"string","required":false,"description":"Contains the first line of customer's base address, example building number, street number etc."},{"name":"addressCity","in":"query","type":"string","required":false,"description":"The town and/or city component of the base address of a customer"},{"name":"countryId","in":"query","type":"string","required":false,"description":"ISO country code of the financial institution. "},{"name":"postCode","in":"query","type":"string","required":false,"description":"Identifies the address postal code for the customer."},{"name":"dateOfBirth","in":"query","type":"string","required":false,"description":"The date of birth of an individual customer"},{"name":"dateOfBirthBW","in":"query","type":"string","required":false,"description":"Indicates the criteria for the between operation on the date of birth"},{"name":"customerStatus","in":"query","type":"string","required":false,"description":"The internal bank status of a customer"},{"name":"sectorId","in":"query","type":"string","required":false,"description":"An institution-defined identifier of the type of customer"},{"name":"sectorIdBW","in":"query","type":"string","required":false,"description":"Indicates the criteria for the between operation on the sector"},{"name":"accountOfficerId","in":"query","type":"string","required":false,"description":"The identifier of the department head or specific account officer responsible for the customer"},{"name":"industryId","in":"query","type":"string","required":false,"description":"An institution-defined identifier of the industry in which the customer is trading, operating or is associated with"},{"name":"nationalityId","in":"query","type":"string","required":false,"description":"The identifier of the nationality of a customer"},{"name":"residenceId","in":"query","type":"string","required":false,"description":"The identifier of the country of residence of a customer"},{"name":"lastName","in":"query","type":"string","required":false,"description":"The last name of an individual customer"},{"name":"phoneNumber","in":"query","type":"string","required":false,"description":"The phone number of the customer or prospect"},{"name":"customerMnemonic","in":"query","type":"string","required":false,"description":"Specifies an alternative easy means of referencing the Customer"},{"name":"firstName","in":"query","type":"string","required":false,"description":"Specifies customer's first name"},{"name":"customerType","in":"query","type":"string","required":false,"description":"Contains the type of customer, for example ACTIVE, PROSPECT."},{"name":"email","in":"query","type":"string","required":false,"description":"Email Identifier of the Customer"},{"name":"mobilePhoneNumber","in":"query","type":"string","required":false,"description":"Represents the phone number of a customer"},{"name":"taxId","in":"query","type":"string","required":false,"description":"Holds the Customer's TAX/SSN Id."},{"name":"shortName","in":"query","type":"string","required":false,"description":"Contains the name of the account, basically the short title of the account."},{"name":"officePhoneNumber","in":"query","type":"string","required":false,"description":"The office phone number of the customer"},{"name":"faxId","in":"query","type":"string","required":false,"description":"The fax (facsimile) number of the customer"},{"name":"address","in":"query","type":"string","required":false,"description":"Communication Address of the Customer"},{"name":"relCustomer","in":"query","type":"string","required":false,"description":"Customers linked or related to the arrangement owner"},{"name":"relationshipCode","in":"query","type":"string","required":false,"description":"Relationship identifier between the partyType and relatedPartyType"},{"name":"legalId","in":"query","type":"string","required":false,"description":"Unique reference number of the legal documents submitted as identification proof"},{"name":"legalDocumentName","in":"query","type":"string","required":false,"description":"Name of the legal documents such as passport, driving licence etc., provided as identification proof"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"CustomerInformationResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"POST","path":"/party/customers","fullPath":"/api/v5.1.0/party/customers","operationId":"createCustomer","name":"Create a customer with the information such as customer contact information, residence details, legal document details, occupation details and relationship details, etc provided by the user","summary":"Create a customer","tags":[],"parameters":[{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"displayNames":[{}],"customerNames":[{}],"communicationDevices":[{}],"faxIds":[{}],"officePhoneNumbers":[{}],"streets":[{}],"addresses":[{}],"addressCities":[{}],"countries":[{}],"legalDetails":[{}],"otherNationalityIds":[{}],"employDetails":[{}],"residenceDetails":[{}],"relationshipDetails":[{}],"postingRestrictIds":[{}]}},"responses":{"200":"CustomerResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/party/customers/relationships","fullPath":"/api/v5.1.0/party/customers/relationships","operationId":"getCustomerRelationship","name":"Retrieves customer relationship details such as type of relationship, party information, related as, owning details, role & purpose of relationship for specific party or customer","summary":"Retrieves list of customer relationships","tags":[],"parameters":[{"name":"customerRelationGroupId","in":"query","type":"string","required":false,"description":"Identifies the key to Customer Relationship Group to form a relation"},{"name":"partyId","in":"query","type":"string","required":false,"description":"Allows capturing of customers or person entities to be part of the relationship. If partyType is selected as Customer, then the system will allow only customer Ids to be captured into this field. If p"},{"name":"relatedPartyId","in":"query","type":"string","required":false,"description":"Identifier of the Related Party"},{"name":"relationId","in":"query","type":"string","required":false,"description":"Identifier of the Customer Relationship and Party Relationship"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"CustomerRelationshipResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"POST","path":"/party/customers/relationships","fullPath":"/api/v5.1.0/party/customers/relationships","operationId":"createCustomerRelationship","name":"Create a customer relationship for a customer with details such as type of relationship, party information, related as, owning details, role & purpose of relationship","summary":"Create customer relationship with other customers","tags":[],"parameters":[{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"originatingRelation":[{}],"customerRelationGroupId":0.0,"customerRelationGroupName":"string","purposeOfRelationship":"string","extensions":{}}},"responses":{"200":"CustomerRelationshipResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/party/customers/relationships/{relationId}","fullPath":"/api/v5.1.0/party/customers/relationships/{relationId}","operationId":"updateCustomerRelationship","name":"Update customer relationship for a customer with details such as type of relationship, party information, related as, owning details, role & purpose of relationship","summary":"Update customer relationship","tags":[],"parameters":[{"name":"relationId","in":"path","type":"string","required":true,"description":"Identifier of the Customer Relationship and Party Relationship"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"originatingRelation":[{}],"customerRelationGroupId":0.0,"customerRelationGroupName":"string","purposeOfRelationship":"string","extensions":{}}},"responses":{"200":"CustomerRelationshipResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/party/customers/reportingStatus","fullPath":"/api/v5.1.0/party/customers/reportingStatus","operationId":"getCustomerReportingStatus","name":"Retrieves the FATCA/CRS reporting status and reporting jurisdiction of the customer","summary":"Retrieves reporting status of the customer","tags":[],"parameters":[{"name":"customerId","in":"query","type":"string","required":true,"description":"Identifier of the customer"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"CustomerReportingStatusResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/party/customers/{customerId}/sweeps","fullPath":"/api/v5.1.0/party/customers/{customerId}/sweeps","operationId":"getCustomerSweeps","name":"Retrieves account sweep details such as sweep reference, type, balance requirements for sweep and frequency of sweep for the list of accounts available to a customer","summary":"Retrieves account sweep details of the specific customer","tags":[],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"Identifier of the customer"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"CustomerSweepsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/party/customers/{customerId}/deliveryOptions","fullPath":"/api/v5.1.0/party/customers/{customerId}/deliveryOptions","operationId":"getCustomerDeliveryOptions","name":"Retrieves the delivery preferences of the customer such as the message group, carrier and address.","summary":"Retrieves delivery preferences of the customer","tags":[],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"Identifier of the customer"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"CustomerDeliveryOptionsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/party/customers/{customerId}/channels","fullPath":"/api/v5.1.0/party/customers/{customerId}/channels","operationId":"getCustomerDigitalChannels","name":"Retrieves the list of message channels such as internet banking, mobile banking, ATM, etc available for the specific customer","summary":"Retrieves list of message channels","tags":[],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"Identifier of the customer"},{"name":"channelName","in":"query","type":"string","required":false,"description":"Name of the (digital) channel registered by the Customer"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"CustomerDigitalChannelsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"POST","path":"/party/customers/messages","fullPath":"/api/v5.1.0/party/customers/messages","operationId":"createMessages","name":"Create a new secure message for a customer to be sent by bank","summary":"Create a new secure message for a customer","tags":[],"parameters":[{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"messages":[{}],"subject":"string","toCustomerId":"string","extensions":{}}},"responses":{"200":"MessagesResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/party/customers/{customerId}/jointCustomers","fullPath":"/api/v5.1.0/party/customers/{customerId}/jointCustomers","operationId":"getJointCustomerDetails","name":"Retrieves details such as joint relation code, name, joint customer details and reverse relationships for a specific customer","summary":"Retrieves joint customer details for a specific customer","tags":[],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"Identifier of the customer"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"JointCustomerDetailsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/party/customers/{customerId}/KYC","fullPath":"/api/v5.1.0/party/customers/{customerId}/KYC","operationId":"getCustomerKYCDetails","name":"Retrieves the KYC details such as contact date, introducer, last and next review date, KYC and AML status of a customer","summary":"Retrieves KYC details for a specific customer","tags":[],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"Identifier of the customer"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"CustomerKYCDetailsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/party/customers/{customerId}/personalProfiles","fullPath":"/api/v5.1.0/party/customers/{customerId}/personalProfiles","operationId":"getCustomerPersonalDetails","name":"Retrieves personal details such as residence, communication details, occupation details, asset and liability information","summary":"Retrieves personal details of customer","tags":[],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"Identifier of the customer"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"CustomerPersonalDetailsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/party/customers/postingRestrictions","fullPath":"/api/v5.1.0/party/customers/postingRestrictions","operationId":"getCustomerPostingRestrictions","name":"Retrieves the credit and debit posting restriction details such as restriction reference and name of restriction set for a customer","summary":"Retrieves posting restriction details","tags":[],"parameters":[{"name":"customerId","in":"query","type":"string","required":false,"description":"Identifier of the customer"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"CustomerPostingRestrictionsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"POST","path":"/party/relationships/{relationId}","fullPath":"/api/v5.1.0/party/relationships/{relationId}","operationId":"createPartyRelationship","name":"Create a party relationship between a person, entity or customer with details such as party name, relation type, related as, relation code and owning details","summary":"Create party relationship details","tags":[],"parameters":[{"name":"relationId","in":"path","type":"string","required":true,"description":"Identifier of the Customer Relationship and Party Relationship"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"partyDisplayNames":[{}],"partyRelationships":[{}],"extensions":{}}},"responses":{"200":"PartyRelationshipResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/party/relationships/{relationId}","fullPath":"/api/v5.1.0/party/relationships/{relationId}","operationId":"updatePartyRelationship","name":"Update party relationship between a person, entity or customer with details such as party name, relation type, related as, relation code and owning details","summary":"Update party relationship details","tags":[],"parameters":[{"name":"relationId","in":"path","type":"string","required":true,"description":"Identifier of the Customer Relationship and Party Relationship"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"partyDisplayNames":[{}],"partyRelationships":[{}],"extensions":{}}},"responses":{"200":"PartyRelationshipResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/party/customers/{customerId}/cards","fullPath":"/api/v5.1.0/party/customers/{customerId}/cards","operationId":"getCustomerCreditCards","name":"Retrieves the card details such as card number, card type and status, linked account and its balances of a customer","summary":"Retrieves card details of a customer","tags":[],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"Identifier of the customer"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"CustomerCreditCardsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/party/customers/{customerId}/standingOrders","fullPath":"/api/v5.1.0/party/customers/{customerId}/standingOrders","operationId":"getStandingOrders","name":"Retrieves the list of standing instructions for a customer with details such as instruction reference, order type, frequency of payments, mode of payment and credit & debit parties involved","summary":"Retrieves standing instruction details of a customer","tags":[],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"Identifier of the customer"},{"name":"standingOrderId","in":"query","type":"string","required":false,"description":"The unique standing order identifier"},{"name":"accountId","in":"query","type":"string","required":false,"description":"Identifier of the account. Often referred to as the account number, yet for consistency this is always referred to as accountId. Accepts both IBAN & BBAN"},{"name":"orderingCustomerId","in":"query","type":"string","required":false,"description":"Indicates the customer id for the ordering customer"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"StandingOrdersResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/party/customers/{customerId}/directDebits","fullPath":"/api/v5.1.0/party/customers/{customerId}/directDebits","operationId":"getDirectDebits","name":"Retrieves the list of direct debits for a customer with details such as direct debit reference, debit and credit accounts, transaction amount, payment frequency, next payment date and direction of payment","summary":"Retrieves direct debits details of a customer","tags":[],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"Identifier of the customer"},{"name":"directDebitId","in":"query","type":"string","required":false,"description":"The unique identifier of the direct debit mandate. "},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"DirectDebitsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"POST","path":"/party/customers/deliveryPreferences/{deliveryPreferenceId}","fullPath":"/api/v5.1.0/party/customers/deliveryPreferences/{deliveryPreferenceId}","operationId":"createDeliveryPreference","name":"Create customer delivery preferences with details such as message group, carrier, role, address, email details and format of messages","summary":"Create customer delivery preferences","tags":[],"parameters":[{"name":"deliveryPreferenceId","in":"path","type":"string","required":true,"description":"Identifier of the customer delivery preferences"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"messageGroup":[{}],"otherMessagesDetail":[{}],"applyOtherMessages":"string","extensions":{}}},"responses":{"200":"DeliveryPreferenceResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/party/customers/deliveryPreferences/{deliveryPreferenceId}","fullPath":"/api/v5.1.0/party/customers/deliveryPreferences/{deliveryPreferenceId}","operationId":"updateDeliveryPreference","name":"Update customer delivery preferences with details such as message group, carrier, role, address, email details and format of messages","summary":"Update customer delivery preferences","tags":[],"parameters":[{"name":"deliveryPreferenceId","in":"path","type":"string","required":true,"description":"Identifier of the customer delivery preferences"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"messageGroup":[{}],"otherMessagesDetail":[{}],"applyOtherMessages":"string","extensions":{}}},"responses":{"200":"DeliveryPreferenceResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/party/customers/limits/{limitId}","fullPath":"/api/v5.1.0/party/customers/limits/{limitId}","operationId":"updateLimit","name":"Updates the limit details such as currency, limit grade, commodity, country and limit product details","summary":"Update credit limit details for customer","tags":[],"parameters":[{"name":"limitId","in":"path","type":"string","required":true,"description":"The identifier of credit limit"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"countries":[{}],"grades":[{}],"commodities":[{}],"currencyId":"string","onlineLimitDate":"2024-01-01","availableMarker":"string","allowNetting":"string","onlineUpdate":"string","limitProductId":"string","checkLimit":"string","band":"string","reducingLimit":"string","internalAmount":"string","extensions":{}}},"responses":{"200":"LimitResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/party/customers/{customerId}/customerExitStatus","fullPath":"/api/v5.1.0/party/customers/{customerId}/customerExitStatus","operationId":"getCustomerExitStatus","name":"Retrieves customer exit status details such as customer type, exit date, status and reason","summary":"Retrieves customer exit status details of customer","tags":[],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"Identifier of the customer"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"CustomerExitStatusResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"PUT","path":"/party/customers/{customerId}/customerExitStatus","fullPath":"/api/v5.1.0/party/customers/{customerId}/customerExitStatus","operationId":"updateCustomerExitStatus","name":"Update a customer record with exit status and exit reason marking the customer as blocked or rejected or closed","summary":"Update customer exit status details of customers","tags":[],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"Identifier of the customer"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"exitStatus":"string","exitReason":"string","extensions":{}}},"responses":{"200":"CustomerExitStatusResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/party/customers/settings/customerExitStatus/{customerExitStatusId}","fullPath":"/api/v5.1.0/party/customers/settings/customerExitStatus/{customerExitStatusId}","operationId":"getCustomerExitStatusParam","name":"Retrieves available conditions such as customer exit setup reference, allowed reasons and allowed re-open details to update customer exit status of customers","summary":"Retrieves conditions to update customer exit status of customer","tags":[],"parameters":[{"name":"customerExitStatusId","in":"path","type":"string","required":true,"description":""},{"name":"customerType","in":"query","type":"string","required":false,"description":"Contains the type of customer, for example ACTIVE, PROSPECT."},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"CustomerExitStatusParamResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"POST","path":"/party/customers/settings/customerExitStatus/{customerExitStatusId}","fullPath":"/api/v5.1.0/party/customers/settings/customerExitStatus/{customerExitStatusId}","operationId":"createCustomerExitStatusParam","name":"Create conditions such as applicable customer type and allowed reasons to update the customer exit status details of customers","summary":"Create conditions to update customer exit status of customer","tags":[],"parameters":[{"name":"customerExitStatusId","in":"path","type":"string","required":true,"description":"The field reflects the exit status ID of a customer or prospect from the parameterization table CUSTOMER.EXIT.STATUS"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"allowedExitReasons":[{}],"exitStatusDescription":"string","customerType":"string","allowRemoveExitStatus":"string","extensions":{}}},"responses":{"200":"CustomerExitStatusParamResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/party/customers/settings/{customerExitStatusId}/customerExitStatus","fullPath":"/api/v5.1.0/party/customers/settings/{customerExitStatusId}/customerExitStatus","operationId":"updateCustomerExitStatusParam","name":"Create conditions such as applicable customer type and allowed reasons to update the customer exit status details of customers","summary":"Create conditions to update customer exit status of customer","tags":[],"parameters":[{"name":"customerExitStatusId","in":"path","type":"string","required":true,"description":"The field reflects the exit status ID of a customer or prospect from the parameterization table CUSTOMER.EXIT.STATUS"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"allowedExitReasons":[{}],"exitStatusDescription":"string","customerType":"string","allowRemoveExitStatus":"string","extensions":{}}},"responses":{"200":"CustomerExitStatusParamResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/party/customers/{customerId}/addresses","fullPath":"/api/v5.1.0/party/customers/{customerId}/addresses","operationId":"getCustomerAddressOutput","name":"Returns structured/unstructured address details of specified customer based on address option in request. When structured format is requested, the values are returned in format of structured data name combined with corresponding customer address value. When unstructured format is requested, the address details are returned based on configured unstructured address format.","summary":"Retrieves structured/ unstructured address format of customer","tags":[],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"Identifier of the customer"},{"name":"addressOption","in":"query","type":"string","required":false,"description":"It reflects the preference for the customer address format, respective structured, unstructured or both"},{"name":"addressOutputFormat","in":"query","type":"string","required":false,"description":"It identifies the address output format for the unstructured address"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"CustomerAddressOutputResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/party/customers/{customerId}/shortNames","fullPath":"/api/v5.1.0/party/customers/{customerId}/shortNames","operationId":"getCustomerShortNames","name":"Retrieves customer short name that can be used as customer enrichment by any application","summary":"Retrieves customer short name","tags":[],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"CustomerShortNamesResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/party/customers/{customerId}/mandates","fullPath":"/api/v5.1.0/party/customers/{customerId}/mandates","operationId":"getCustomerMandates","name":"Retrieves the mandate instruction details such as application eligible for mandate process and the corresponding mandate rule that is being applied to check mandates for transactions involving the specified customer.","summary":"Retrieves mandate instruction applicable for the requested customer","tags":[],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"CustomerMandatesResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/party/customers/{customerId}/documents","fullPath":"/api/v5.1.0/party/customers/{customerId}/documents","operationId":"getCustomerLegalDocuments","name":"Retrieves the details of legal document provided by the customer such as document name, document id, issue date, expiry date and authority who issued the document.","summary":"Retrieves the customer legal document details","tags":[],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"CustomerLegalDocumentsResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/party/customers/{customerId}/profiles","fullPath":"/api/v5.1.0/party/customers/{customerId}/profiles","operationId":"getCustomerProfile","name":"Retrieves the customer basic details such as personal information, address location, basic contact details and other general information.","summary":"Retrieves profile details of the requested customer","tags":[],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"CustomerProfileResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/party/customers/alternateReferences/{alternateReference}","fullPath":"/api/v5.1.0/party/customers/alternateReferences/{alternateReference}","operationId":"getCustomerId","name":"Retrieves the customer identifier for the provided alternate reference of the customer","summary":"Retrieves customer id for the given alternate reference","tags":[],"parameters":[{"name":"alternateReference","in":"path","type":"string","required":true,"description":"If the new Account to be created is a shadow of another Account already exisitng in another system, then the Account reference of that system can be specified here. The value given in this field will "},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"CustomerIdResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/party/customers/{customerId}/restrictions","fullPath":"/api/v5.1.0/party/customers/{customerId}/restrictions","operationId":"getCustomerRestrictions","name":"Retrieves the transaction restrictions imposed on the customer specified. Restrictions can be post no entries, black listed customer, pending KYC due reasons for restricting transactions on this customer","summary":"Retrieves the restriction details","tags":[],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"CustomerRestrictionsResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/party/customers/{customerId}/contacts","fullPath":"/api/v5.1.0/party/customers/{customerId}/contacts","operationId":"getCustomerContacts","name":"Retrieves the contact details such as phone number, mobile numbers, fax and email address specific to the requested customer","summary":"Retrieves the customer contact details","tags":[],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"Identifier of the customer"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"CustomerContactsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/party/customers/{customerId}/relationships","fullPath":"/api/v5.1.0/party/customers/{customerId}/relationships","operationId":"getCustomerRelationships","name":"Retrieves the relationship details such as related customer and the relationship that exists with the requested customer","summary":"Retrieves the relation customers","tags":[],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"CustomerRelationshipsResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/party/customers/{customerId}/payments","fullPath":"/api/v5.1.0/party/customers/{customerId}/payments","operationId":"getPartyBasicDetails","name":"Retrieves the customer information that are required for processing or validating the customer involved in a payment transaction. Provides the information such as customer name details, birth details, address details,  market sector, target, nationality, residence country and preferred language for communication.","summary":"Retrieves customer details required for payment processing","tags":[],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"Identifier of the customer"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"PartyBasicDetailsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/party/customers/{customerId}/addresses/swiftAddresses/{addressId}","fullPath":"/api/v5.1.0/party/customers/{customerId}/addresses/swiftAddresses/{addressId}","operationId":"getCustomerSwiftAddress","name":"Retrieves the SWIFT address details such as delivery address, short name and tag25 indicator for the customer.","summary":"Retrieves the SWIFT address details for the customer.","tags":[],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"Identifier of the customer"},{"name":"addressId","in":"path","type":"string","required":true,"description":"Reference Id of address record"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"CustomerSwiftAddressResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/party/customers/{customerId}/charges","fullPath":"/api/v5.1.0/party/customers/{customerId}/charges","operationId":"getCustomerCharge","name":"Retrieves customer charge for a customer with details such as tax type and tax group.","summary":"Retrieves customer charge for a specific customer.","tags":[],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"Identifier of the customer"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"CustomerChargeResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"POST","path":"/party/customers/{customerId}/charges","fullPath":"/api/v5.1.0/party/customers/{customerId}/charges","operationId":"createCustomerCharge","name":"Creates customer charge for a customer with details such as tax type and tax group.","summary":"Creates customer charge for a specific customer.","tags":[],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"Identifier of the customer"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"taxGroups":[{}],"extensions":{}}},"responses":{"200":"CustomerChargeResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/party/customers/{customerId}/charges","fullPath":"/api/v5.1.0/party/customers/{customerId}/charges","operationId":"updateCustomerCharge","name":"Updates customer charge for a customer with details such as tax type and tax group.","summary":"Updates customer charge for a specific customer.","tags":[],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"Identifier of the customer"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"taxGroups":[{}],"extensions":{}}},"responses":{"200":"CustomerChargeResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/party/customers/{customerId}/addresses/smsAddresses","fullPath":"/api/v5.1.0/party/customers/{customerId}/addresses/smsAddresses","operationId":"getCustomerPhoneAddress","name":"Retrieves the list of customer sms communication address with details such as name, idd prefix and mobile number.","summary":"Retrieves available list of customer sms communication addresses","tags":[],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"Identifier of the customer"},{"name":"addressId","in":"query","type":"string","required":false,"description":"Reference Id of address record"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"CustomerPhoneAddressResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"POST","path":"/party/customers/{customerId}/addresses/smsAddresses","fullPath":"/api/v5.1.0/party/customers/{customerId}/addresses/smsAddresses","operationId":"createCustomerPhoneAddress","name":"Create customer sms communication address with details such as name, idd prefix and mobile number.","summary":"Creates customer sms communication address","tags":[],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"Identifier of the customer"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"customerShortNames":[{}],"iddPrefixMobile":"string","mobileNumber":"string","extensions":{}}},"responses":{"200":"CustomerPhoneAddressResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/party/customers/{customerId}/addresses/emailAddresses","fullPath":"/api/v5.1.0/party/customers/{customerId}/addresses/emailAddresses","operationId":"getCustomerEmailAddress","name":"Retrieves the list of customer email communication address with details such as customer name and email references.","summary":"Retrieves available list of customer email communication addresses","tags":[],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"Identifier of the customer"},{"name":"addressId","in":"query","type":"string","required":false,"description":"Reference Id of address record"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"CustomerEmailAddressResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"POST","path":"/party/customers/{customerId}/addresses/emailAddresses","fullPath":"/api/v5.1.0/party/customers/{customerId}/addresses/emailAddresses","operationId":"createCustomerEmailAddress","name":"Create customer email communication address with details such as customer name and email references.","summary":"Creates customer email communication address","tags":[],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"Identifier of the customer"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"customerShortNames":[{}],"email":"string","extensions":{}}},"responses":{"200":"CustomerEmailAddressResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/party/customers/{customerId}/addresses/printAddresses","fullPath":"/api/v5.1.0/party/customers/{customerId}/addresses/printAddresses","operationId":"getCustomerPrintAddress","name":"Retrieves the list of customer print communication addresses with details such as name, address, postcode and phone number.","summary":"Retrieves available list of customer print communication addresses","tags":[],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"Identifier of the customer"},{"name":"addressId","in":"query","type":"string","required":false,"description":"Reference Id of address record"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"CustomerPrintAddressResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"POST","path":"/party/customers/{customerId}/addresses/printAddresses","fullPath":"/api/v5.1.0/party/customers/{customerId}/addresses/printAddresses","operationId":"createCustomerPrintAddress","name":"Create customer print communication address with details such as name, address, postcode and phone number.","summary":"Creates customer print communication address","tags":[],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"Identifier of the customer"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"customerShortNames":[{}],"customerNames":[{}],"addresses":[{}],"streets":[{}],"towns":[{}],"postCodes":[{}],"addressPurpose":"string","addressLocation":"string","addressVerifier":"string","countryCode":"string","departmentId":"string","subDepartmentId":"string","flatNumber":"string","buildingName":"string","buildingNumber":"string"}},"responses":{"200":"CustomerPrintAddressResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/party/customers/addresses/{customerAddressId}/smsAddresses","fullPath":"/api/v5.1.0/party/customers/addresses/{customerAddressId}/smsAddresses","operationId":"updateCustomerPhoneAddress","name":"Update customer sms communication address with details such as name, idd prefix and mobile number.","summary":"Updates customer sms communication address","tags":[],"parameters":[{"name":"customerAddressId","in":"path","type":"string","required":true,"description":"Identifier of the customer address table."},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"customerShortNames":[{}],"iddPrefixMobile":"string","mobileNumber":"string","extensions":{}}},"responses":{"200":"CustomerPhoneAddressResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"DELETE","path":"/party/customers/addresses/{customerAddressId}/smsAddresses","fullPath":"/api/v5.1.0/party/customers/addresses/{customerAddressId}/smsAddresses","operationId":"deleteCustomerPhoneAddress","name":"Delete the specified customer sms communication address that are no longer used.","summary":"Deletes customer sms communication address","tags":[],"parameters":[{"name":"customerAddressId","in":"path","type":"string","required":true,"description":"Identifier of the customer address table."},{"name":"payload","in":"body","type":"object","required":false,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}}},"responses":{"200":"CustomerPhoneAddressResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/party/customers/addresses/{customerAddressId}/emailAddresses","fullPath":"/api/v5.1.0/party/customers/addresses/{customerAddressId}/emailAddresses","operationId":"updateCustomerEmailAddress","name":"Update customer email communication address with details such as customer name and email references.","summary":"Updates customer email communication address","tags":[],"parameters":[{"name":"customerAddressId","in":"path","type":"string","required":true,"description":"Identifier of the customer address table."},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"customerShortNames":[{}],"email":"string","extensions":{}}},"responses":{"200":"CustomerEmailAddressResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"DELETE","path":"/party/customers/addresses/{customerAddressId}/emailAddresses","fullPath":"/api/v5.1.0/party/customers/addresses/{customerAddressId}/emailAddresses","operationId":"deleteCustomerEmailAddress","name":"Delete the specified customer email communication address that are no longer used.","summary":"Deletes customer email communication address","tags":[],"parameters":[{"name":"customerAddressId","in":"path","type":"string","required":true,"description":"Identifier of the customer address table."},{"name":"payload","in":"body","type":"object","required":false,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}}},"responses":{"200":"CustomerEmailAddressResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/party/customers/addresses/{customerAddressId}/printAddresses","fullPath":"/api/v5.1.0/party/customers/addresses/{customerAddressId}/printAddresses","operationId":"updateCustomerPrintAddress","name":"Update customer print communication address with details such as name, address, postcode and phone number.","summary":"Updates customer print communication address","tags":[],"parameters":[{"name":"customerAddressId","in":"path","type":"string","required":true,"description":"Identifier of the customer address table."},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"customerShortNames":[{}],"customerNames":[{}],"addresses":[{}],"streets":[{}],"towns":[{}],"postCodes":[{}],"addressPurpose":"string","addressLocation":"string","addressVerifier":"string","countryCode":"string","departmentId":"string","subDepartmentId":"string","flatNumber":"string","buildingName":"string","buildingNumber":"string"}},"responses":{"200":"CustomerPrintAddressResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"DELETE","path":"/party/customers/addresses/{customerAddressId}/printAddresses","fullPath":"/api/v5.1.0/party/customers/addresses/{customerAddressId}/printAddresses","operationId":"deleteCustomerPrintAddress","name":"Delete the specified customer print communication address that are no longer used.","summary":"Deletes customer print communication address","tags":[],"parameters":[{"name":"customerAddressId","in":"path","type":"string","required":true,"description":"Identifier of the customer address table."},{"name":"payload","in":"body","type":"object","required":false,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}}},"responses":{"200":"CustomerPrintAddressResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/party/customers/{customerId}/consents","fullPath":"/api/v5.1.0/party/customers/{customerId}/consents","operationId":"getCustomerConsents","name":"Retrieves the list of consent details for specific customer","summary":"Retrieves customer consents details","tags":[],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"Identifier of the customer"},{"name":"propertyClassId","in":"query","type":"string","required":false,"description":"The identifier of a condition that is used to build a product"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"CustomerConsentsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"POST","path":"/party/customers/{customerId}/fatca","fullPath":"/api/v5.1.0/party/customers/{customerId}/fatca","operationId":"createFatcaCustomer","name":"Creates the FATCA customer supplementary information record that stores the related FATCA details for the customer","summary":"Create FATCA customer supplementary information details","tags":[],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"Identifier of the customer"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"citizenships":[{}],"tinDetails":[{}],"Owner":[{}],"JointOwner":[{}],"fatcaClientType":"string","isPlaceOfBirthUs":"string","domicile":"string","greencardDetails":"string","residenceId":"string","isPoa":"string","standingInstructionOnUsAccount":"string","accountInstructionfromUs":"string","socialSecurityNumber":"string","phoneNumber":"string","isDormantAccount":"string"}},"responses":{"200":"FatcaCustomerResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/party/customers/{customerId}/fatca","fullPath":"/api/v5.1.0/party/customers/{customerId}/fatca","operationId":"updateFatcaCustomer","name":"Update the FATCA customer supplementary information record that stores the related FATCA details for the customer","summary":"Update FATCA customer supplementary information details","tags":[],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"Identifier of the customer"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"citizenships":[{}],"tinDetails":[{}],"Owner":[{}],"JointOwner":[{}],"fatcaClientType":"string","isPlaceOfBirthUs":"string","domicile":"string","greencardDetails":"string","residenceId":"string","isPoa":"string","standingInstructionOnUsAccount":"string","accountInstructionfromUs":"string","socialSecurityNumber":"string","phoneNumber":"string","isDormantAccount":"string"}},"responses":{"200":"FatcaCustomerResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/party/customers/{customerId}/portfolios/{portfolioId}/overdueSettlements","fullPath":"/api/v5.1.0/party/customers/{customerId}/portfolios/{portfolioId}/overdueSettlements","operationId":"getOverdueSettlements","name":"Retrieves overdue settlements of customer or portfolio with details such as transaction reference, instrument reference , instrument name, depository and broker involved, trade date, trade currency, trade quantity, current customer and broker outstandings","summary":"Retrieves overdue settlements of customer or portfolio","tags":[],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"Identifier of the customer"},{"name":"portfolioId","in":"path","type":"string","required":true,"description":"Id of the portfolio or security account"},{"name":"transactionId","in":"query","type":"string","required":false,"description":"Unique transaction identifier for retrieving the details of the transaction. For example: FT0102030333 etc."},{"name":"brokerId","in":"query","type":"string","required":false,"description":"The identifier of the broker"},{"name":"tradeDate","in":"query","type":"string","required":false,"description":"Standard date field which records trade date of the account"},{"name":"valueDate","in":"query","type":"string","required":false,"description":"Indicates the value date on which the underlying accounting entry is to be given value (for interest purposes)"},{"name":"depository","in":"query","type":"string","required":false,"description":"Person designated as depository by the company in or pursuant to this Indenture, and, unless otherwise provided with respect to any security, any successor to such person"},{"name":"currency","in":"query","type":"string","required":false,"description":"Identifies the currency. E.g. USD, GBP etc"},{"name":"instrumentId","in":"query","type":"string","required":false,"description":"The identifier of the instrument"},{"name":"deliveryInstruction","in":"query","type":"string","required":false,"description":"Customer's directions to a bank as to the disposition of funds and securities in the customer's account"},{"name":"transactionType","in":"query","type":"string","required":false,"description":"Identifies the transaction type applicable to the transaction being processed, i.e. outward or inward payment. For example: ACPX, OTPX etc."},{"name":"quantity","in":"query","type":"string","required":false,"description":"The nominal quantity"},{"name":"stockExchange","in":"query","type":"string","required":false,"description":"Contains the stock exchange details where a particular security is usually dealt"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"OverdueSettlementsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/party/customers/accountServicingProviders","fullPath":"/api/v5.1.0/party/customers/accountServicingProviders","operationId":"getOtherBanksToConnectTo","name":"Retrieves the third party providers that are allowed to interact with the bank or entity with details such as global unique reference number, provider country,provider name and national competent authority register code","summary":"Retrieves details of third party providers","tags":[],"parameters":[{"name":"openBankingId","in":"query","type":"string","required":false,"description":"Identifies the open banking number of the customer"},{"name":"countryId","in":"query","type":"string","required":false,"description":"ISO country code of the financial institution. "},{"name":"setActive","in":"query","type":"string","required":false,"description":"Flag to set the connection status to active"},{"name":"status","in":"query","type":"string","required":false,"description":"Contains status of the data rights request.Allowed values are INITIATED, INPROGESS, EXTENDED, COMPLETED, REJECTED."},{"name":"extSourceProvider","in":"query","type":"string","required":false,"description":"Contains the name of the external source provider for the customer"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"OtherBanksToConnectToResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/party/customers/prospects","fullPath":"/api/v5.1.0/party/customers/prospects","operationId":"getProspectCustomers","name":"Retrieves the list of prospect customers with details such as contact information, residence details, personal details and prospect legal details","summary":"Retrieves prospect details of customers","tags":[],"parameters":[{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"ProspectCustomersResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"POST","path":"/party/customers/prospects","fullPath":"/api/v5.1.0/party/customers/prospects","operationId":"createProspectCustomer","name":"Create a prospect customer with basic details such as contact information, residence details and prospect legal details","summary":"Create a prospect customer","tags":[],"parameters":[{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"customerNames":[{}],"streets":[{}],"addresses":[{}],"townCountries":[{}],"postCodes":[{}],"countries":[{}],"phoneNumbers":[{}],"emails":[{}],"socialNetworkIds":[{}],"prospectLegalDetails":[{}],"personEntity":"string","departmentId":"string","subDepartmentId":"string","floorNumber":"string","locationName":"string"}},"responses":{"200":"ProspectCustomerResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/party/customers/{customerId}/opportunities","fullPath":"/api/v5.1.0/party/customers/{customerId}/opportunities","operationId":"getCustomerOpportunities","name":"Retrieves the details of sales opportunities such as score, status and product details which are likely to be of interest to specific customers","summary":"Retrieves the sales opportunities for specific customers","tags":[],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"Identifier of the customer"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"CustomerOpportunitiesResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/party/customers/{customerId}/requests","fullPath":"/api/v5.1.0/party/customers/{customerId}/requests","operationId":"getCustomerRequests","name":"Retrieves process workflow details such as process name, activity details and status for a specific customer","summary":"Retrieves process workflows for a specific customer","tags":[],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"Identifier of the customer"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"CustomerRequestsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"PUT","path":"/party/customers/prospects/{prospectId}","fullPath":"/api/v5.1.0/party/customers/prospects/{prospectId}","operationId":"updateProspectCustomer","name":"Update a prospect customer with basic details such as contact information, residence details and prospect legal details","summary":"Update a prospect customer","tags":[],"parameters":[{"name":"prospectId","in":"path","type":"string","required":true,"description":"Indicates the status of an onboarding customer. Status can be PROSPECT while onboarding and ACTIVE when the prospect becomes a Customer."},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"customerNames":[{}],"streets":[{}],"addresses":[{}],"townCountries":[{}],"postCodes":[{}],"countries":[{}],"phoneNumbers":[{}],"emails":[{}],"socialNetworkIds":[{}],"prospectLegalDetails":[{}],"personEntity":"string","departmentId":"string","subDepartmentId":"string","floorNumber":"string","locationName":"string"}},"responses":{"200":"ProspectCustomerResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/party/customers/{customerId}/alertRequests","fullPath":"/api/v5.1.0/party/customers/{customerId}/alertRequests","operationId":"getAlertRequests","name":"Retrieves the alert subscription details such as alert reference, alert name and condition for alerts of a customer","summary":"Retrieves alert requests details","tags":[],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"Identifier of the customer"},{"name":"contractReference","in":"query","type":"string","required":false,"description":"Contains the contract reference"},{"name":"subscribe","in":"query","type":"string","required":false,"description":"Enables an alert service"},{"name":"alertRequestId","in":"query","type":"string","required":false,"description":"The unique identifier of the alert request."},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"AlertRequestsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/party/relationships/{partyId}/relations","fullPath":"/api/v5.1.0/party/relationships/{partyId}/relations","operationId":"getPartyRelationship","name":"Retrieves the relationship details such as party name, type, relation code, status and owning percentage of customers involved in a relationship","summary":"Retrieves list of party relationship details","tags":[],"parameters":[{"name":"partyId","in":"path","type":"string","required":true,"description":"Allows capturing of customers or person entities to be part of the relationship. If partyType is selected as Customer, then the system will allow only customer Ids to be captured into this field. If p"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"PartyRelationshipResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"POST","path":"/party/customers/staticDataUpdateEvents","fullPath":"/api/v5.1.0/party/customers/staticDataUpdateEvents","operationId":"createCustomerStaticChange","name":"Create data log with details such as event name, event creation date and time for customer that has undergone static data updates from external party systems","summary":"Create log of customer static data update event from external party systems","tags":[],"parameters":[{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"creationDate":"string","requestTime":"string","eventName":"string","customerId":"string","extensions":{}}},"responses":{"200":"CustomerStaticChangeResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}}]},{"key":"party-customerServices-v5.2.0","title":"Customer management","version":"v5.2.0","description":"API to create, update and manage customer details such as delivery preferences, joint customer details, party relationships, KYC details, alert subscriptions, customer exit status, customer address formats & posting restrictions","endpointCount":69,"endpoints":[{"method":"GET","path":"/party/customers/{customerId}","fullPath":"/api/v5.2.0/party/customers/{customerId}","operationId":"getCustomer","name":"Retrieves the customer details such as customer contact information, residence details, legal document details, occupation details and relationship details for the specific customer","summary":"Retrieves customer details","tags":[],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"Identifier of the customer"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"CustomerResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/party/customers/{customerId}","fullPath":"/api/v5.2.0/party/customers/{customerId}","operationId":"updateCustomer","name":"Update customer details with the information such as customer contact information, residence details, legal document details, occupation details and relationship details, etc provided by the user","summary":"Update customer details","tags":[],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"Identifier of the customer"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"displayNames":[{}],"customerNames":[{}],"communicationDevices":[{}],"faxIds":[{}],"officePhoneNumbers":[{}],"streets":[{}],"addresses":[{}],"addressCities":[{}],"countries":[{}],"legalDetails":[{}],"otherNationalityIds":[{}],"employDetails":[{}],"residenceDetails":[{}],"relationshipDetails":[{}],"postingRestrictIds":[{}]}},"responses":{"200":"CustomerResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/party/customers","fullPath":"/api/v5.2.0/party/customers","operationId":"getCustomerInformation","name":"Retrieves the customer details such as delivery or postal details, contact information, residence details, customer profile, legal document details, occupation details and status of customer","summary":"Retrieves list of customer basic details","tags":[],"parameters":[{"name":"customerId","in":"query","type":"string","required":false,"description":"Identifier of the customer"},{"name":"customerName","in":"query","type":"string","required":false,"description":"Name of the customer"},{"name":"street","in":"query","type":"string","required":false,"description":"Contains the street name of the customer or the property"},{"name":"addressCity","in":"query","type":"string","required":false,"description":"The town and/or city component of the base address of a customer"},{"name":"countryId","in":"query","type":"string","required":false,"description":"ISO country code of the financial institution. "},{"name":"postCode","in":"query","type":"string","required":false,"description":"Identifies the address postal code for the customer or the property"},{"name":"dateOfBirth","in":"query","type":"string","required":false,"description":"The date of birth of an individual customer"},{"name":"dateOfBirthBW","in":"query","type":"string","required":false,"description":"Indicates the criteria for the between operation on the date of birth"},{"name":"customerStatus","in":"query","type":"string","required":false,"description":"The internal bank status of a customer"},{"name":"sectorId","in":"query","type":"string","required":false,"description":"An institution-defined identifier of the type of customer"},{"name":"sectorIdBW","in":"query","type":"string","required":false,"description":"Indicates the criteria for the between operation on the sector"},{"name":"accountOfficerId","in":"query","type":"string","required":false,"description":"The identifier of the department head or specific account officer responsible for the customer"},{"name":"industryId","in":"query","type":"string","required":false,"description":"An institution-defined identifier of the industry in which the customer is trading, operating or is associated with"},{"name":"nationalityId","in":"query","type":"string","required":false,"description":"The identifier of the nationality of a customer"},{"name":"residenceId","in":"query","type":"string","required":false,"description":"The identifier of the country of residence of a customer"},{"name":"lastName","in":"query","type":"string","required":false,"description":"The last name of an individual customer"},{"name":"phoneNumber","in":"query","type":"string","required":false,"description":"The phone number of the customer or prospect"},{"name":"customerMnemonic","in":"query","type":"string","required":false,"description":"Specifies an alternative easy means of referencing the Customer"},{"name":"firstName","in":"query","type":"string","required":false,"description":"Specifies customer's first name"},{"name":"customerType","in":"query","type":"string","required":false,"description":"Identifies the type of customers. Example Personal, Business, Corporate, etc."},{"name":"email","in":"query","type":"string","required":false,"description":"Email Identifier of the Customer"},{"name":"mobilePhoneNumber","in":"query","type":"string","required":false,"description":"Represents the phone number of a customer"},{"name":"taxId","in":"query","type":"string","required":false,"description":"Holds the Customer's TAX/SSN Id."},{"name":"shortName","in":"query","type":"string","required":false,"description":"Contains the name of the account, basically the short title of the account."},{"name":"officePhoneNumber","in":"query","type":"string","required":false,"description":"The office phone number of the customer"},{"name":"faxId","in":"query","type":"string","required":false,"description":"The fax (facsimile) number of the customer"},{"name":"address","in":"query","type":"string","required":false,"description":"Contains the communication address of the customer or full address of the property"},{"name":"relCustomer","in":"query","type":"string","required":false,"description":"Customers linked or related to the arrangement owner"},{"name":"relationshipCode","in":"query","type":"string","required":false,"description":"Relationship identifier between the partyType and relatedPartyType"},{"name":"legalId","in":"query","type":"string","required":false,"description":"Unique reference number of the legal documents submitted as identification proof"},{"name":"legalDocumentName","in":"query","type":"string","required":false,"description":"Name of the legal documents such as passport, driving licence etc., provided as identification proof"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"CustomerInformationResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"POST","path":"/party/customers","fullPath":"/api/v5.2.0/party/customers","operationId":"createCustomer","name":"Create a customer with the information such as customer contact information, residence details, legal document details, occupation details and relationship details, etc provided by the user","summary":"Create a customer","tags":[],"parameters":[{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"displayNames":[{}],"customerNames":[{}],"communicationDevices":[{}],"faxIds":[{}],"officePhoneNumbers":[{}],"streets":[{}],"addresses":[{}],"addressCities":[{}],"countries":[{}],"legalDetails":[{}],"otherNationalityIds":[{}],"employDetails":[{}],"residenceDetails":[{}],"relationshipDetails":[{}],"postingRestrictIds":[{}]}},"responses":{"200":"CustomerResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/party/customers/relationships","fullPath":"/api/v5.2.0/party/customers/relationships","operationId":"getCustomerRelationship","name":"Retrieves customer relationship details such as type of relationship, party information, related as, owning details, role & purpose of relationship for specific party or customer","summary":"Retrieves list of customer relationships","tags":[],"parameters":[{"name":"customerRelationGroupId","in":"query","type":"string","required":false,"description":"Identifies the key to Customer Relationship Group to form a relation"},{"name":"partyId","in":"query","type":"string","required":false,"description":"Allows capturing of customers or person entities to be part of the relationship. If partyType is selected as Customer, then the system will allow only customer Ids to be captured into this field. If p"},{"name":"relatedPartyId","in":"query","type":"string","required":false,"description":"Identifier of the Related Party"},{"name":"relationId","in":"query","type":"string","required":false,"description":"Identifier of the Customer Relationship and Party Relationship"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"CustomerRelationshipResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"POST","path":"/party/customers/relationships","fullPath":"/api/v5.2.0/party/customers/relationships","operationId":"createCustomerRelationship","name":"Create a customer relationship for a customer with details such as type of relationship, party information, related as, owning details, role & purpose of relationship","summary":"Create customer relationship with other customers","tags":[],"parameters":[{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"originatingRelation":[{}],"customerRelationGroupId":0.0,"customerRelationGroupName":"string","purposeOfRelationship":"string","extensions":{}}},"responses":{"200":"CustomerRelationshipResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/party/customers/relationships/{relationId}","fullPath":"/api/v5.2.0/party/customers/relationships/{relationId}","operationId":"updateCustomerRelationship","name":"Update customer relationship for a customer with details such as type of relationship, party information, related as, owning details, role & purpose of relationship","summary":"Update customer relationship","tags":[],"parameters":[{"name":"relationId","in":"path","type":"string","required":true,"description":"Identifier of the Customer Relationship and Party Relationship"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"originatingRelation":[{}],"customerRelationGroupId":0.0,"customerRelationGroupName":"string","purposeOfRelationship":"string","extensions":{}}},"responses":{"200":"CustomerRelationshipResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/party/customers/reportingStatus","fullPath":"/api/v5.2.0/party/customers/reportingStatus","operationId":"getCustomerReportingStatus","name":"Retrieves the FATCA/CRS reporting status and reporting jurisdiction of the customer","summary":"Retrieves reporting status of the customer","tags":[],"parameters":[{"name":"customerId","in":"query","type":"string","required":true,"description":"Identifier of the customer"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"CustomerReportingStatusResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/party/customers/{customerId}/sweeps","fullPath":"/api/v5.2.0/party/customers/{customerId}/sweeps","operationId":"getCustomerSweeps","name":"Retrieves account sweep details such as sweep reference, type, balance requirements for sweep and frequency of sweep for the list of accounts available to a customer","summary":"Retrieves account sweep details of the specific customer","tags":[],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"Identifier of the customer"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"CustomerSweepsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/party/customers/{customerId}/deliveryOptions","fullPath":"/api/v5.2.0/party/customers/{customerId}/deliveryOptions","operationId":"getCustomerDeliveryOptions","name":"Retrieves the delivery preferences of the customer such as the message group, carrier and address.","summary":"Retrieves delivery preferences of the customer","tags":[],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"Identifier of the customer"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"CustomerDeliveryOptionsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/party/customers/{customerId}/channels","fullPath":"/api/v5.2.0/party/customers/{customerId}/channels","operationId":"getCustomerDigitalChannels","name":"Retrieves the list of message channels such as internet banking, mobile banking, ATM, etc available for the specific customer","summary":"Retrieves list of message channels","tags":[],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"Identifier of the customer"},{"name":"channelName","in":"query","type":"string","required":false,"description":"Name of the (digital) channel registered by the Customer"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"CustomerDigitalChannelsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"POST","path":"/party/customers/messages","fullPath":"/api/v5.2.0/party/customers/messages","operationId":"createMessages","name":"Create a new secure message for a customer to be sent by bank","summary":"Create a new secure message for a customer","tags":[],"parameters":[{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"messages":[{}],"subject":"string","toCustomerId":"string","extensions":{}}},"responses":{"200":"MessagesResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/party/customers/{customerId}/jointCustomers","fullPath":"/api/v5.2.0/party/customers/{customerId}/jointCustomers","operationId":"getJointCustomerDetails","name":"Retrieves details such as joint relation code, name, joint customer details and reverse relationships for a specific customer","summary":"Retrieves joint customer details for a specific customer","tags":[],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"Identifier of the customer"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"JointCustomerDetailsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/party/customers/{customerId}/KYC","fullPath":"/api/v5.2.0/party/customers/{customerId}/KYC","operationId":"getCustomerKYCDetails","name":"Retrieves the KYC details such as contact date, introducer, last and next review date, KYC and AML status of a customer","summary":"Retrieves KYC details for a specific customer","tags":[],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"Identifier of the customer"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"CustomerKYCDetailsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/party/customers/{customerId}/personalProfiles","fullPath":"/api/v5.2.0/party/customers/{customerId}/personalProfiles","operationId":"getCustomerPersonalDetails","name":"Retrieves personal details such as residence, communication details, occupation details, asset and liability information","summary":"Retrieves personal details of customer","tags":[],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"Identifier of the customer"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"CustomerPersonalDetailsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/party/customers/postingRestrictions","fullPath":"/api/v5.2.0/party/customers/postingRestrictions","operationId":"getCustomerPostingRestrictions","name":"Retrieves the credit and debit posting restriction details such as restriction reference and name of restriction set for a customer","summary":"Retrieves posting restriction details","tags":[],"parameters":[{"name":"customerId","in":"query","type":"string","required":false,"description":"Identifier of the customer"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"CustomerPostingRestrictionsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"POST","path":"/party/relationships/{relationId}","fullPath":"/api/v5.2.0/party/relationships/{relationId}","operationId":"createPartyRelationship","name":"Create a party relationship between a person, entity or customer with details such as party name, relation type, related as, relation code and owning details","summary":"Create party relationship details","tags":[],"parameters":[{"name":"relationId","in":"path","type":"string","required":true,"description":"Identifier of the Customer Relationship and Party Relationship"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"partyDisplayNames":[{}],"partyRelationships":[{}],"extensions":{}}},"responses":{"200":"PartyRelationshipResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/party/relationships/{relationId}","fullPath":"/api/v5.2.0/party/relationships/{relationId}","operationId":"updatePartyRelationship","name":"Update party relationship between a person, entity or customer with details such as party name, relation type, related as, relation code and owning details","summary":"Update party relationship details","tags":[],"parameters":[{"name":"relationId","in":"path","type":"string","required":true,"description":"Identifier of the Customer Relationship and Party Relationship"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"partyDisplayNames":[{}],"partyRelationships":[{}],"extensions":{}}},"responses":{"200":"PartyRelationshipResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/party/customers/{customerId}/cards","fullPath":"/api/v5.2.0/party/customers/{customerId}/cards","operationId":"getCustomerCreditCards","name":"Retrieves the card details such as card number, card type and status, linked account and its balances of a customer","summary":"Retrieves card details of a customer","tags":[],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"Identifier of the customer"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"CustomerCreditCardsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/party/customers/{customerId}/standingOrders","fullPath":"/api/v5.2.0/party/customers/{customerId}/standingOrders","operationId":"getStandingOrders","name":"Retrieves the list of standing instructions for a customer with details such as instruction reference, order type, frequency of payments, mode of payment and credit & debit parties involved","summary":"Retrieves standing instruction details of a customer","tags":[],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"Identifier of the customer"},{"name":"standingOrderId","in":"query","type":"string","required":false,"description":"The unique standing order identifier"},{"name":"accountId","in":"query","type":"string","required":false,"description":"Identifier of the account. Often referred to as the account number, yet for consistency this is always referred to as accountId. Accepts both IBAN & BBAN"},{"name":"orderingCustomerId","in":"query","type":"string","required":false,"description":"Indicates the customer id for the ordering customer"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"StandingOrdersResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/party/customers/{customerId}/directDebits","fullPath":"/api/v5.2.0/party/customers/{customerId}/directDebits","operationId":"getDirectDebits","name":"Retrieves the list of direct debits for a customer with details such as direct debit reference, debit and credit accounts, transaction amount, payment frequency, next payment date and direction of payment","summary":"Retrieves direct debits details of a customer","tags":[],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"Identifier of the customer"},{"name":"directDebitId","in":"query","type":"string","required":false,"description":"The unique identifier of the direct debit mandate. "},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"DirectDebitsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"POST","path":"/party/customers/deliveryPreferences/{deliveryPreferenceId}","fullPath":"/api/v5.2.0/party/customers/deliveryPreferences/{deliveryPreferenceId}","operationId":"createDeliveryPreference","name":"Create customer delivery preferences with details such as message group, carrier, role, address, email details and format of messages","summary":"Create customer delivery preferences","tags":[],"parameters":[{"name":"deliveryPreferenceId","in":"path","type":"string","required":true,"description":"Identifier of the customer delivery preferences"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"messageGroup":[{}],"otherMessagesDetail":[{}],"applyOtherMessages":"string","extensions":{}}},"responses":{"200":"DeliveryPreferenceResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/party/customers/deliveryPreferences/{deliveryPreferenceId}","fullPath":"/api/v5.2.0/party/customers/deliveryPreferences/{deliveryPreferenceId}","operationId":"updateDeliveryPreference","name":"Update customer delivery preferences with details such as message group, carrier, role, address, email details and format of messages","summary":"Update customer delivery preferences","tags":[],"parameters":[{"name":"deliveryPreferenceId","in":"path","type":"string","required":true,"description":"Identifier of the customer delivery preferences"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"messageGroup":[{}],"otherMessagesDetail":[{}],"applyOtherMessages":"string","extensions":{}}},"responses":{"200":"DeliveryPreferenceResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/party/customers/limits/{limitId}","fullPath":"/api/v5.2.0/party/customers/limits/{limitId}","operationId":"updateLimit","name":"Updates the limit details such as currency, limit grade, commodity, country and limit product details","summary":"Update credit limit details for customer","tags":[],"parameters":[{"name":"limitId","in":"path","type":"string","required":true,"description":"The identifier of credit limit"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"countries":[{}],"grades":[{}],"commodities":[{}],"currencyId":"string","onlineLimitDate":"2024-01-01","availableMarker":"string","allowNetting":"string","onlineUpdate":"string","limitProductId":"string","checkLimit":"string","band":"string","reducingLimit":"string","internalAmount":"string","extensions":{}}},"responses":{"200":"LimitResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/party/customers/{customerId}/customerExitStatus","fullPath":"/api/v5.2.0/party/customers/{customerId}/customerExitStatus","operationId":"getCustomerExitStatus","name":"Retrieves customer exit status details such as customer type, exit date, status and reason","summary":"Retrieves customer exit status details of customer","tags":[],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"Identifier of the customer"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"CustomerExitStatusResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"PUT","path":"/party/customers/{customerId}/customerExitStatus","fullPath":"/api/v5.2.0/party/customers/{customerId}/customerExitStatus","operationId":"updateCustomerExitStatus","name":"Update a customer record with exit status and exit reason marking the customer as blocked or rejected or closed","summary":"Update customer exit status details of customers","tags":[],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"Identifier of the customer"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"exitStatus":"string","exitReason":"string","extensions":{}}},"responses":{"200":"CustomerExitStatusResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/party/customers/settings/customerExitStatus/{customerExitStatusId}","fullPath":"/api/v5.2.0/party/customers/settings/customerExitStatus/{customerExitStatusId}","operationId":"getCustomerExitStatusParam","name":"Retrieves available conditions such as customer exit setup reference, allowed reasons and allowed re-open details to update customer exit status of customers","summary":"Retrieves conditions to update customer exit status of customer","tags":[],"parameters":[{"name":"customerExitStatusId","in":"path","type":"string","required":true,"description":""},{"name":"customerType","in":"query","type":"string","required":false,"description":"Identifies the type of customers. Example Personal, Business, Corporate, etc."},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"CustomerExitStatusParamResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"POST","path":"/party/customers/settings/customerExitStatus/{customerExitStatusId}","fullPath":"/api/v5.2.0/party/customers/settings/customerExitStatus/{customerExitStatusId}","operationId":"createCustomerExitStatusParam","name":"Create conditions such as applicable customer type and allowed reasons to update the customer exit status details of customers","summary":"Create conditions to update customer exit status of customer","tags":[],"parameters":[{"name":"customerExitStatusId","in":"path","type":"string","required":true,"description":"The field reflects the exit status ID of a customer or prospect from the parameterization table CUSTOMER.EXIT.STATUS"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"allowedExitReasons":[{}],"exitStatusDescription":"string","customerType":"string","allowRemoveExitStatus":"string","extensions":{}}},"responses":{"200":"CustomerExitStatusParamResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/party/customers/settings/{customerExitStatusId}/customerExitStatus","fullPath":"/api/v5.2.0/party/customers/settings/{customerExitStatusId}/customerExitStatus","operationId":"updateCustomerExitStatusParam","name":"Create conditions such as applicable customer type and allowed reasons to update the customer exit status details of customers","summary":"Create conditions to update customer exit status of customer","tags":[],"parameters":[{"name":"customerExitStatusId","in":"path","type":"string","required":true,"description":"The field reflects the exit status ID of a customer or prospect from the parameterization table CUSTOMER.EXIT.STATUS"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"allowedExitReasons":[{}],"exitStatusDescription":"string","customerType":"string","allowRemoveExitStatus":"string","extensions":{}}},"responses":{"200":"CustomerExitStatusParamResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/party/customers/{customerId}/addresses","fullPath":"/api/v5.2.0/party/customers/{customerId}/addresses","operationId":"getCustomerAddressOutput","name":"Returns structured/unstructured address details of specified customer based on address option in request. When structured format is requested, the values are returned in format of structured data name combined with corresponding customer address value. When unstructured format is requested, the address details are returned based on configured unstructured address format.","summary":"Retrieves structured/ unstructured address format of customer","tags":[],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"Identifier of the customer"},{"name":"addressOption","in":"query","type":"string","required":false,"description":"It reflects the preference for the customer address format, respective structured, unstructured or both"},{"name":"addressOutputFormat","in":"query","type":"string","required":false,"description":"It identifies the address output format for the unstructured address"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"CustomerAddressOutputResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/party/customers/{customerId}/shortNames","fullPath":"/api/v5.2.0/party/customers/{customerId}/shortNames","operationId":"getCustomerShortNames","name":"Retrieves customer short name that can be used as customer enrichment by any application","summary":"Retrieves customer short name","tags":[],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"CustomerShortNamesResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/party/customers/{customerId}/mandates","fullPath":"/api/v5.2.0/party/customers/{customerId}/mandates","operationId":"getCustomerMandates","name":"Retrieves the mandate instruction details such as application eligible for mandate process and the corresponding mandate rule that is being applied to check mandates for transactions involving the specified customer.","summary":"Retrieves mandate instruction applicable for the requested customer","tags":[],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"CustomerMandatesResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/party/customers/{customerId}/documents","fullPath":"/api/v5.2.0/party/customers/{customerId}/documents","operationId":"getCustomerLegalDocuments","name":"Retrieves the details of legal document provided by the customer such as document name, document id, issue date, expiry date and authority who issued the document.","summary":"Retrieves the customer legal document details","tags":[],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"CustomerLegalDocumentsResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/party/customers/{customerId}/profiles","fullPath":"/api/v5.2.0/party/customers/{customerId}/profiles","operationId":"getCustomerProfile","name":"Retrieves the customer basic details such as personal information, address location, basic contact details and other general information.","summary":"Retrieves profile details of the requested customer","tags":[],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"CustomerProfileResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/party/customers/alternateReferences/{alternateReference}","fullPath":"/api/v5.2.0/party/customers/alternateReferences/{alternateReference}","operationId":"getCustomerId","name":"Retrieves the customer identifier for the provided alternate reference of the customer","summary":"Retrieves customer id for the given alternate reference","tags":[],"parameters":[{"name":"alternateReference","in":"path","type":"string","required":true,"description":"If the new Account to be created is a shadow of another Account already exisitng in another system, then the Account reference of that system can be specified here. The value given in this field will "},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"CustomerIdResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/party/customers/{customerId}/restrictions","fullPath":"/api/v5.2.0/party/customers/{customerId}/restrictions","operationId":"getCustomerRestrictions","name":"Retrieves the transaction restrictions imposed on the customer specified. Restrictions can be post no entries, black listed customer, pending KYC due reasons for restricting transactions on this customer","summary":"Retrieves the restriction details","tags":[],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"CustomerRestrictionsResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/party/customers/{customerId}/contacts","fullPath":"/api/v5.2.0/party/customers/{customerId}/contacts","operationId":"getCustomerContacts","name":"Retrieves the contact details such as phone number, mobile numbers, fax and email address specific to the requested customer","summary":"Retrieves the customer contact details","tags":[],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"Identifier of the customer"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"CustomerContactsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/party/customers/{customerId}/relationships","fullPath":"/api/v5.2.0/party/customers/{customerId}/relationships","operationId":"getCustomerRelationships","name":"Retrieves the relationship details such as related customer and the relationship that exists with the requested customer","summary":"Retrieves the relation customers","tags":[],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"CustomerRelationshipsResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/party/customers/{customerId}/payments","fullPath":"/api/v5.2.0/party/customers/{customerId}/payments","operationId":"getPartyBasicDetails","name":"Retrieves the customer information that are required for processing or validating the customer involved in a payment transaction. Provides the information such as customer name details, birth details, address details,  market sector, target, nationality, residence country and preferred language for communication.","summary":"Retrieves customer details required for payment processing","tags":[],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"Identifier of the customer"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"PartyBasicDetailsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/party/customers/{customerId}/addresses/swiftAddresses/{addressId}","fullPath":"/api/v5.2.0/party/customers/{customerId}/addresses/swiftAddresses/{addressId}","operationId":"getCustomerSwiftAddress","name":"Retrieves the SWIFT address details such as delivery address, short name and tag25 indicator for the customer.","summary":"Retrieves the SWIFT address details for the customer.","tags":[],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"Identifier of the customer"},{"name":"addressId","in":"path","type":"string","required":true,"description":"Reference Id of address record"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"CustomerSwiftAddressResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/party/customers/{customerId}/charges","fullPath":"/api/v5.2.0/party/customers/{customerId}/charges","operationId":"getCustomerCharge","name":"Retrieves customer charge for a customer with details such as tax type and tax group.","summary":"Retrieves customer charge for a specific customer.","tags":[],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"Identifier of the customer"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"CustomerChargeResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"POST","path":"/party/customers/{customerId}/charges","fullPath":"/api/v5.2.0/party/customers/{customerId}/charges","operationId":"createCustomerCharge","name":"Creates customer charge for a customer with details such as tax type and tax group.","summary":"Creates customer charge for a specific customer.","tags":[],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"Identifier of the customer"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"taxGroups":[{}],"extensions":{}}},"responses":{"200":"CustomerChargeResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/party/customers/{customerId}/charges","fullPath":"/api/v5.2.0/party/customers/{customerId}/charges","operationId":"updateCustomerCharge","name":"Updates customer charge for a customer with details such as tax type and tax group.","summary":"Updates customer charge for a specific customer.","tags":[],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"Identifier of the customer"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"taxGroups":[{}],"extensions":{}}},"responses":{"200":"CustomerChargeResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/party/customers/{customerId}/addresses/smsAddresses","fullPath":"/api/v5.2.0/party/customers/{customerId}/addresses/smsAddresses","operationId":"getCustomerPhoneAddress","name":"Retrieves the list of customer sms communication address with details such as name, idd prefix and mobile number.","summary":"Retrieves available list of customer sms communication addresses","tags":[],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"Identifier of the customer"},{"name":"addressId","in":"query","type":"string","required":false,"description":"Reference Id of address record"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"CustomerPhoneAddressResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"POST","path":"/party/customers/{customerId}/addresses/smsAddresses","fullPath":"/api/v5.2.0/party/customers/{customerId}/addresses/smsAddresses","operationId":"createCustomerPhoneAddress","name":"Create customer sms communication address with details such as name, idd prefix and mobile number.","summary":"Creates customer sms communication address","tags":[],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"Identifier of the customer"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"customerShortNames":[{}],"iddPrefixMobile":"string","mobileNumber":"string","extensions":{}}},"responses":{"200":"CustomerPhoneAddressResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/party/customers/{customerId}/addresses/emailAddresses","fullPath":"/api/v5.2.0/party/customers/{customerId}/addresses/emailAddresses","operationId":"getCustomerEmailAddress","name":"Retrieves the list of customer email communication address with details such as customer name and email references.","summary":"Retrieves available list of customer email communication addresses","tags":[],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"Identifier of the customer"},{"name":"addressId","in":"query","type":"string","required":false,"description":"Reference Id of address record"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"CustomerEmailAddressResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"POST","path":"/party/customers/{customerId}/addresses/emailAddresses","fullPath":"/api/v5.2.0/party/customers/{customerId}/addresses/emailAddresses","operationId":"createCustomerEmailAddress","name":"Create customer email communication address with details such as customer name and email references.","summary":"Creates customer email communication address","tags":[],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"Identifier of the customer"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"customerShortNames":[{}],"email":"string","extensions":{}}},"responses":{"200":"CustomerEmailAddressResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/party/customers/{customerId}/addresses/printAddresses","fullPath":"/api/v5.2.0/party/customers/{customerId}/addresses/printAddresses","operationId":"getCustomerPrintAddress","name":"Retrieves the list of customer print communication addresses with details such as name, address, postcode and phone number.","summary":"Retrieves available list of customer print communication addresses","tags":[],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"Identifier of the customer"},{"name":"addressId","in":"query","type":"string","required":false,"description":"Reference Id of address record"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"CustomerPrintAddressResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"POST","path":"/party/customers/{customerId}/addresses/printAddresses","fullPath":"/api/v5.2.0/party/customers/{customerId}/addresses/printAddresses","operationId":"createCustomerPrintAddress","name":"Create customer print communication address with details such as name, address, postcode and phone number.","summary":"Creates customer print communication address","tags":[],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"Identifier of the customer"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"customerShortNames":[{}],"customerNames":[{}],"addresses":[{}],"streets":[{}],"towns":[{}],"postCodes":[{}],"addressPurpose":"string","addressLocation":"string","addressVerifier":"string","countryCode":"string","departmentId":"string","subDepartmentId":"string","flatNumber":"string","buildingName":"string","buildingNumber":"string"}},"responses":{"200":"CustomerPrintAddressResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/party/customers/addresses/{customerAddressId}/smsAddresses","fullPath":"/api/v5.2.0/party/customers/addresses/{customerAddressId}/smsAddresses","operationId":"updateCustomerPhoneAddress","name":"Update customer sms communication address with details such as name, idd prefix and mobile number.","summary":"Updates customer sms communication address","tags":[],"parameters":[{"name":"customerAddressId","in":"path","type":"string","required":true,"description":"Identifier of the customer address table."},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"customerShortNames":[{}],"iddPrefixMobile":"string","mobileNumber":"string","extensions":{}}},"responses":{"200":"CustomerPhoneAddressResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"DELETE","path":"/party/customers/addresses/{customerAddressId}/smsAddresses","fullPath":"/api/v5.2.0/party/customers/addresses/{customerAddressId}/smsAddresses","operationId":"deleteCustomerPhoneAddress","name":"Delete the specified customer sms communication address that are no longer used.","summary":"Deletes customer sms communication address","tags":[],"parameters":[{"name":"customerAddressId","in":"path","type":"string","required":true,"description":"Identifier of the customer address table."},{"name":"payload","in":"body","type":"object","required":false,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}}},"responses":{"200":"CustomerPhoneAddressResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/party/customers/addresses/{customerAddressId}/emailAddresses","fullPath":"/api/v5.2.0/party/customers/addresses/{customerAddressId}/emailAddresses","operationId":"updateCustomerEmailAddress","name":"Update customer email communication address with details such as customer name and email references.","summary":"Updates customer email communication address","tags":[],"parameters":[{"name":"customerAddressId","in":"path","type":"string","required":true,"description":"Identifier of the customer address table."},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"customerShortNames":[{}],"email":"string","extensions":{}}},"responses":{"200":"CustomerEmailAddressResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"DELETE","path":"/party/customers/addresses/{customerAddressId}/emailAddresses","fullPath":"/api/v5.2.0/party/customers/addresses/{customerAddressId}/emailAddresses","operationId":"deleteCustomerEmailAddress","name":"Delete the specified customer email communication address that are no longer used.","summary":"Deletes customer email communication address","tags":[],"parameters":[{"name":"customerAddressId","in":"path","type":"string","required":true,"description":"Identifier of the customer address table."},{"name":"payload","in":"body","type":"object","required":false,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}}},"responses":{"200":"CustomerEmailAddressResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/party/customers/addresses/{customerAddressId}/printAddresses","fullPath":"/api/v5.2.0/party/customers/addresses/{customerAddressId}/printAddresses","operationId":"updateCustomerPrintAddress","name":"Update customer print communication address with details such as name, address, postcode and phone number.","summary":"Updates customer print communication address","tags":[],"parameters":[{"name":"customerAddressId","in":"path","type":"string","required":true,"description":"Identifier of the customer address table."},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"customerShortNames":[{}],"customerNames":[{}],"addresses":[{}],"streets":[{}],"towns":[{}],"postCodes":[{}],"addressPurpose":"string","addressLocation":"string","addressVerifier":"string","countryCode":"string","departmentId":"string","subDepartmentId":"string","flatNumber":"string","buildingName":"string","buildingNumber":"string"}},"responses":{"200":"CustomerPrintAddressResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"DELETE","path":"/party/customers/addresses/{customerAddressId}/printAddresses","fullPath":"/api/v5.2.0/party/customers/addresses/{customerAddressId}/printAddresses","operationId":"deleteCustomerPrintAddress","name":"Delete the specified customer print communication address that are no longer used.","summary":"Deletes customer print communication address","tags":[],"parameters":[{"name":"customerAddressId","in":"path","type":"string","required":true,"description":"Identifier of the customer address table."},{"name":"payload","in":"body","type":"object","required":false,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}}},"responses":{"200":"CustomerPrintAddressResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/party/customers/{customerId}/consents","fullPath":"/api/v5.2.0/party/customers/{customerId}/consents","operationId":"getCustomerConsents","name":"Retrieves the list of consent details for specific customer","summary":"Retrieves customer consents details","tags":[],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"Identifier of the customer"},{"name":"propertyClassId","in":"query","type":"string","required":false,"description":"The identifier of a condition that is used to build a product"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"CustomerConsentsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"POST","path":"/party/customers/{customerId}/fatca","fullPath":"/api/v5.2.0/party/customers/{customerId}/fatca","operationId":"createFatcaCustomer","name":"Creates the FATCA customer supplementary information record that stores the related FATCA details for the customer","summary":"Create FATCA customer supplementary information details","tags":[],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"Identifier of the customer"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"citizenships":[{}],"tinDetails":[{}],"Owner":[{}],"JointOwner":[{}],"fatcaClientType":"string","isPlaceOfBirthUs":"string","domicile":"string","greencardDetails":"string","residenceId":"string","isPoa":"string","standingInstructionOnUsAccount":"string","accountInstructionfromUs":"string","socialSecurityNumber":"string","phoneNumber":"string","isDormantAccount":"string"}},"responses":{"200":"FatcaCustomerResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/party/customers/{customerId}/fatca","fullPath":"/api/v5.2.0/party/customers/{customerId}/fatca","operationId":"updateFatcaCustomer","name":"Update the FATCA customer supplementary information record that stores the related FATCA details for the customer","summary":"Update FATCA customer supplementary information details","tags":[],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"Identifier of the customer"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"citizenships":[{}],"tinDetails":[{}],"Owner":[{}],"JointOwner":[{}],"fatcaClientType":"string","isPlaceOfBirthUs":"string","domicile":"string","greencardDetails":"string","residenceId":"string","isPoa":"string","standingInstructionOnUsAccount":"string","accountInstructionfromUs":"string","socialSecurityNumber":"string","phoneNumber":"string","isDormantAccount":"string"}},"responses":{"200":"FatcaCustomerResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/party/customers/{customerId}/portfolios/{portfolioId}/overdueSettlements","fullPath":"/api/v5.2.0/party/customers/{customerId}/portfolios/{portfolioId}/overdueSettlements","operationId":"getOverdueSettlements","name":"Retrieves overdue settlements of customer or portfolio with details such as transaction reference, instrument reference , instrument name, depository and broker involved, trade date, trade currency, trade quantity, current customer and broker outstandings","summary":"Retrieves overdue settlements of customer or portfolio","tags":[],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"Identifier of the customer"},{"name":"portfolioId","in":"path","type":"string","required":true,"description":"Id of the portfolio or security account"},{"name":"transactionId","in":"query","type":"string","required":false,"description":"Unique transaction identifier for retrieving the details of the transaction. For example: FT0102030333 etc."},{"name":"brokerId","in":"query","type":"string","required":false,"description":"The identifier of the broker"},{"name":"tradeDate","in":"query","type":"string","required":false,"description":"Standard date field which records trade date of the account"},{"name":"valueDate","in":"query","type":"string","required":false,"description":"Indicates the value date on which the underlying accounting entry is to be given value (for interest purposes)"},{"name":"depository","in":"query","type":"string","required":false,"description":"Person designated as depository by the company in or pursuant to this Indenture, and, unless otherwise provided with respect to any security, any successor to such person"},{"name":"currency","in":"query","type":"string","required":false,"description":"Identifies the currency. E.g. USD, GBP etc"},{"name":"instrumentId","in":"query","type":"string","required":false,"description":"The identifier of the instrument"},{"name":"deliveryInstruction","in":"query","type":"string","required":false,"description":"Customer's directions to a bank as to the disposition of funds and securities in the customer's account"},{"name":"transactionType","in":"query","type":"string","required":false,"description":"Identifies the transaction type applicable to the transaction being processed, i.e. outward or inward payment. For example: ACPX, OTPX etc."},{"name":"quantity","in":"query","type":"string","required":false,"description":"The nominal quantity"},{"name":"stockExchange","in":"query","type":"string","required":false,"description":"Contains the stock exchange details where a particular security is usually dealt"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"OverdueSettlementsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/party/customers/accountServicingProviders","fullPath":"/api/v5.2.0/party/customers/accountServicingProviders","operationId":"getOtherBanksToConnectTo","name":"Retrieves the third party providers that are allowed to interact with the bank or entity with details such as global unique reference number, provider country,provider name and national competent authority register code","summary":"Retrieves details of third party providers","tags":[],"parameters":[{"name":"openBankingId","in":"query","type":"string","required":false,"description":"Identifies the open banking number of the customer"},{"name":"countryId","in":"query","type":"string","required":false,"description":"ISO country code of the financial institution. "},{"name":"setActive","in":"query","type":"string","required":false,"description":"Flag to set the connection status to active"},{"name":"status","in":"query","type":"string","required":false,"description":"Contains status of the data rights request.Allowed values are INITIATED, INPROGESS, EXTENDED, COMPLETED, REJECTED."},{"name":"extSourceProvider","in":"query","type":"string","required":false,"description":"Contains the name of the external source provider for the customer"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"OtherBanksToConnectToResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/party/customers/prospects","fullPath":"/api/v5.2.0/party/customers/prospects","operationId":"getProspectCustomers","name":"Retrieves the list of prospect customers with details such as contact information, residence details, personal details and prospect legal details","summary":"Retrieves prospect details of customers","tags":[],"parameters":[{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"ProspectCustomersResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"POST","path":"/party/customers/prospects","fullPath":"/api/v5.2.0/party/customers/prospects","operationId":"createProspectCustomer","name":"Create a prospect customer with basic details such as contact information, residence details and prospect legal details","summary":"Create a prospect customer","tags":[],"parameters":[{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"customerNames":[{}],"streets":[{}],"addresses":[{}],"townCountries":[{}],"postCodes":[{}],"countries":[{}],"phoneNumbers":[{}],"emails":[{}],"socialNetworkIds":[{}],"prospectLegalDetails":[{}],"personEntity":"string","departmentId":"string","subDepartmentId":"string","floorNumber":"string","locationName":"string"}},"responses":{"200":"ProspectCustomerResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/party/customers/{customerId}/opportunities","fullPath":"/api/v5.2.0/party/customers/{customerId}/opportunities","operationId":"getCustomerOpportunities","name":"Retrieves the details of sales opportunities such as score, status and product details which are likely to be of interest to specific customers","summary":"Retrieves the sales opportunities for specific customers","tags":[],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"Identifier of the customer"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"CustomerOpportunitiesResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/party/customers/{customerId}/requests","fullPath":"/api/v5.2.0/party/customers/{customerId}/requests","operationId":"getCustomerRequests","name":"Retrieves process workflow details such as process name, activity details and status for a specific customer","summary":"Retrieves process workflows for a specific customer","tags":[],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"Identifier of the customer"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"CustomerRequestsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"PUT","path":"/party/customers/prospects/{prospectId}","fullPath":"/api/v5.2.0/party/customers/prospects/{prospectId}","operationId":"updateProspectCustomer","name":"Update a prospect customer with basic details such as contact information, residence details and prospect legal details","summary":"Update a prospect customer","tags":[],"parameters":[{"name":"prospectId","in":"path","type":"string","required":true,"description":"Indicates the status of an onboarding customer. Status can be PROSPECT while onboarding and ACTIVE when the prospect becomes a Customer."},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"customerNames":[{}],"streets":[{}],"addresses":[{}],"townCountries":[{}],"postCodes":[{}],"countries":[{}],"phoneNumbers":[{}],"emails":[{}],"socialNetworkIds":[{}],"prospectLegalDetails":[{}],"personEntity":"string","departmentId":"string","subDepartmentId":"string","floorNumber":"string","locationName":"string"}},"responses":{"200":"ProspectCustomerResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/party/customers/{customerId}/alertRequests","fullPath":"/api/v5.2.0/party/customers/{customerId}/alertRequests","operationId":"getAlertRequests","name":"Retrieves the alert subscription details such as alert reference, alert name and condition for alerts of a customer","summary":"Retrieves alert requests details","tags":[],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"Identifier of the customer"},{"name":"contractReference","in":"query","type":"string","required":false,"description":"Contains the contract reference"},{"name":"subscribe","in":"query","type":"string","required":false,"description":"Enables an alert service"},{"name":"alertRequestId","in":"query","type":"string","required":false,"description":"The unique identifier of the alert request."},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"AlertRequestsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/party/relationships/{partyId}/relations","fullPath":"/api/v5.2.0/party/relationships/{partyId}/relations","operationId":"getPartyRelationship","name":"Retrieves the relationship details such as party name, type, relation code, status and owning percentage of customers involved in a relationship","summary":"Retrieves list of party relationship details","tags":[],"parameters":[{"name":"partyId","in":"path","type":"string","required":true,"description":"Allows capturing of customers or person entities to be part of the relationship. If partyType is selected as Customer, then the system will allow only customer Ids to be captured into this field. If p"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"PartyRelationshipResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"POST","path":"/party/customers/staticDataUpdateEvents","fullPath":"/api/v5.2.0/party/customers/staticDataUpdateEvents","operationId":"createCustomerStaticChange","name":"Create data log with details such as event name, event creation date and time for customer that has undergone static data updates from external party systems","summary":"Create log of customer static data update event from external party systems","tags":[],"parameters":[{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"creationDate":"string","requestTime":"string","eventName":"string","customerId":"string","extensions":{}}},"responses":{"200":"CustomerStaticChangeResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/party/customers/bankCodes/BICs/{bicId}/owners","fullPath":"/api/v5.2.0/party/customers/bankCodes/BICs/{bicId}/owners","operationId":"getBicOwners","name":"Retrieves the owner of the BIC and the channel through which this BIC is used. If a company code is returned without a customer id this indicates the entity of the current financial institution. If a company code is returned along with a customer number, this indicates the customer identified by the respective BIC and the entity of the current financial institution that maintains the main relationship with the customer. The address type returned represent the context in which the BIC can be used","summary":"Retrieves the owner of the BIC and the channel through which this BIC is used.","tags":[],"parameters":[{"name":"bicId","in":"path","type":"string","required":true,"description":"Bank Identifier Code (BIC) of the financial institution"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"BicOwnersResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}}]},{"key":"party-customerServices-v5.3.0","title":"Customer management","version":"v5.3.0","description":"API to create, update and manage customer details such as delivery preferences, joint customer details, party relationships, KYC details, alert subscriptions, customer exit status, customer address formats & posting restrictions","endpointCount":70,"endpoints":[{"method":"GET","path":"/party/customers/{customerId}","fullPath":"/api/v5.3.0/party/customers/{customerId}","operationId":"getCustomer","name":"Retrieves the customer details such as customer contact information, residence details, legal document details, occupation details and relationship details for the specific customer","summary":"Retrieves customer details","tags":["RETAIL"],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"Identifier of the customer"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"CustomerResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"POST","path":"/party/customers/{customerId}","fullPath":"/api/v5.3.0/party/customers/{customerId}","operationId":"createCustomerWithId","name":"Create a customer with the information such as customer contact information, residence details, legal document details, occupation details and relationship details, etc provided by the user. It allows to create a customer with the provided id.","summary":"Create a customer by providing an Id","tags":["RETAIL"],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"Identifier of the customer"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"displayNames":[{}],"customerNames":[{}],"communicationDevices":[{}],"faxIds":[{}],"officePhoneNumbers":[{}],"streets":[{}],"addresses":[{}],"addressCities":[{}],"countries":[{}],"legalDetails":[{}],"otherNationalityIds":[{}],"employDetails":[{}],"residenceDetails":[{}],"relationshipDetails":[{}],"postingRestrictIds":[{}]}},"responses":{"200":"CustomerWithIdResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/party/customers/{customerId}","fullPath":"/api/v5.3.0/party/customers/{customerId}","operationId":"updateCustomer","name":"Update customer details with the information such as customer contact information, residence details, legal document details, occupation details and relationship details, etc provided by the user","summary":"Update customer details","tags":["RETAIL"],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"Identifier of the customer"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"displayNames":[{}],"customerNames":[{}],"communicationDevices":[{}],"faxIds":[{}],"officePhoneNumbers":[{}],"streets":[{}],"addresses":[{}],"addressCities":[{}],"countries":[{}],"legalDetails":[{}],"otherNationalityIds":[{}],"employDetails":[{}],"residenceDetails":[{}],"relationshipDetails":[{}],"postingRestrictIds":[{}]}},"responses":{"200":"CustomerResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/party/customers","fullPath":"/api/v5.3.0/party/customers","operationId":"getCustomerInformation","name":"Retrieves the customer details such as delivery or postal details, contact information, residence details, customer profile, legal document details, occupation details and status of customer","summary":"Retrieves list of customer basic details","tags":["RETAIL"],"parameters":[{"name":"customerId","in":"query","type":"string","required":false,"description":"Identifier of the customer"},{"name":"customerName","in":"query","type":"string","required":false,"description":"Indicates the name of the customer. Originator is the party who requests the payment cancellation."},{"name":"street","in":"query","type":"string","required":false,"description":"Contains the street name of the customer or the property"},{"name":"addressCity","in":"query","type":"string","required":false,"description":"The town and/or city component of the base address of a customer"},{"name":"countryId","in":"query","type":"string","required":false,"description":"ISO country code of the financial institution. "},{"name":"postCode","in":"query","type":"string","required":false,"description":"Identifies the address postal code for the customer or the property"},{"name":"dateOfBirth","in":"query","type":"string","required":false,"description":"The date of birth of an individual customer"},{"name":"dateOfBirthBW","in":"query","type":"string","required":false,"description":"Indicates the criteria for the between operation on the date of birth"},{"name":"customerStatus","in":"query","type":"string","required":false,"description":"The internal bank status of a customer"},{"name":"sectorId","in":"query","type":"string","required":false,"description":"An institution-defined identifier of the type of customer"},{"name":"sectorIdBW","in":"query","type":"string","required":false,"description":"Indicates the criteria for the between operation on the sector"},{"name":"accountOfficerId","in":"query","type":"string","required":false,"description":"The identifier of the department head or specific account officer responsible for the customer"},{"name":"industryId","in":"query","type":"string","required":false,"description":"An institution-defined identifier of the industry in which the customer is trading, operating or is associated with"},{"name":"nationalityId","in":"query","type":"string","required":false,"description":"The identifier of the nationality of a customer"},{"name":"residenceId","in":"query","type":"string","required":false,"description":"The identifier of the country of residence of a customer"},{"name":"lastName","in":"query","type":"string","required":false,"description":"The last name of an individual customer"},{"name":"phoneNumber","in":"query","type":"string","required":false,"description":"The phone number of the customer or prospect"},{"name":"customerMnemonic","in":"query","type":"string","required":false,"description":"Specifies an alternative easy means of referencing the Customer"},{"name":"firstName","in":"query","type":"string","required":false,"description":"Specifies customer's first name"},{"name":"customerType","in":"query","type":"string","required":false,"description":"Identifies the type of customers. Example Personal, Business, Corporate, etc."},{"name":"email","in":"query","type":"string","required":false,"description":"Email Identifier of the Customer"},{"name":"mobilePhoneNumber","in":"query","type":"string","required":false,"description":"Represents the phone number of a customer"},{"name":"taxId","in":"query","type":"string","required":false,"description":"Holds the Customer's TAX/SSN Id."},{"name":"shortName","in":"query","type":"string","required":false,"description":"Contains the name of the account, basically the short title of the account."},{"name":"officePhoneNumber","in":"query","type":"string","required":false,"description":"The office phone number of the customer"},{"name":"faxId","in":"query","type":"string","required":false,"description":"The fax (facsimile) number of the customer"},{"name":"address","in":"query","type":"string","required":false,"description":"Contains the communication address of the customer or full address of the property"},{"name":"relCustomer","in":"query","type":"string","required":false,"description":"Customers linked or related to the arrangement owner"},{"name":"relationshipCode","in":"query","type":"string","required":false,"description":"Relationship identifier between the partyType and relatedPartyType"},{"name":"legalId","in":"query","type":"string","required":false,"description":"Unique reference number of the legal documents submitted as identification proof"},{"name":"legalDocumentName","in":"query","type":"string","required":false,"description":"Name of the legal documents such as passport, driving licence etc., provided as identification proof"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"CustomerInformationResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"POST","path":"/party/customers","fullPath":"/api/v5.3.0/party/customers","operationId":"createCustomer","name":"Create a customer with the information such as customer contact information, residence details, legal document details, occupation details and relationship details, etc provided by the user. It allows to create a customer with system generated id.","summary":"Create a customer","tags":["RETAIL"],"parameters":[{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"displayNames":[{}],"customerNames":[{}],"communicationDevices":[{}],"faxIds":[{}],"officePhoneNumbers":[{}],"streets":[{}],"addresses":[{}],"addressCities":[{}],"countries":[{}],"legalDetails":[{}],"otherNationalityIds":[{}],"employDetails":[{}],"residenceDetails":[{}],"relationshipDetails":[{}],"postingRestrictIds":[{}]}},"responses":{"200":"CustomerResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/party/customers/relationships","fullPath":"/api/v5.3.0/party/customers/relationships","operationId":"getCustomerRelationship","name":"Retrieves customer relationship details such as type of relationship, party information, related as, owning details, role & purpose of relationship for specific party or customer","summary":"Retrieves list of customer relationships","tags":["RETAIL"],"parameters":[{"name":"customerRelationGroupId","in":"query","type":"string","required":false,"description":"Identifies the key to Customer Relationship Group to form a relation"},{"name":"partyId","in":"query","type":"string","required":false,"description":"Allows capturing of customers or person entities to be part of the relationship. If partyType is selected as Customer, then the system will allow only customer Ids to be captured into this field. If p"},{"name":"relatedPartyId","in":"query","type":"string","required":false,"description":"Identifier of the Related Party"},{"name":"relationId","in":"query","type":"string","required":false,"description":"Identifier of the Customer Relationship and Party Relationship"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"CustomerRelationshipResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"POST","path":"/party/customers/relationships","fullPath":"/api/v5.3.0/party/customers/relationships","operationId":"createCustomerRelationship","name":"Create a customer relationship for a customer with details such as type of relationship, party information, related as, owning details, role & purpose of relationship","summary":"Create customer relationship with other customers","tags":["RETAIL"],"parameters":[{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"originatingRelation":[{}],"customerRelationGroupId":0.0,"customerRelationGroupName":"string","purposeOfRelationship":"string","extensions":{}}},"responses":{"200":"CustomerRelationshipResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/party/customers/relationships/{relationId}","fullPath":"/api/v5.3.0/party/customers/relationships/{relationId}","operationId":"updateCustomerRelationship","name":"Update customer relationship for a customer with details such as type of relationship, party information, related as, owning details, role & purpose of relationship","summary":"Update customer relationship","tags":["RETAIL"],"parameters":[{"name":"relationId","in":"path","type":"string","required":true,"description":"Identifier of the Customer Relationship and Party Relationship"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"originatingRelation":[{}],"customerRelationGroupId":0.0,"customerRelationGroupName":"string","purposeOfRelationship":"string","extensions":{}}},"responses":{"200":"CustomerRelationshipResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/party/customers/reportingStatus","fullPath":"/api/v5.3.0/party/customers/reportingStatus","operationId":"getCustomerReportingStatus","name":"Retrieves the FATCA/CRS reporting status and reporting jurisdiction of the customer","summary":"Retrieves reporting status of the customer","tags":["RETAIL"],"parameters":[{"name":"customerId","in":"query","type":"string","required":true,"description":"Identifier of the customer"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"CustomerReportingStatusResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/party/customers/{customerId}/sweeps","fullPath":"/api/v5.3.0/party/customers/{customerId}/sweeps","operationId":"getCustomerSweeps","name":"Retrieves account sweep details such as sweep reference, type, balance requirements for sweep and frequency of sweep for the list of accounts available to a customer","summary":"Retrieves account sweep details of the specific customer","tags":["RETAIL"],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"Identifier of the customer"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"CustomerSweepsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/party/customers/{customerId}/deliveryOptions","fullPath":"/api/v5.3.0/party/customers/{customerId}/deliveryOptions","operationId":"getCustomerDeliveryOptions","name":"Retrieves the delivery preferences of the customer such as the message group, carrier and address.","summary":"Retrieves delivery preferences of the customer","tags":["RETAIL"],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"Identifier of the customer"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"CustomerDeliveryOptionsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/party/customers/{customerId}/channels","fullPath":"/api/v5.3.0/party/customers/{customerId}/channels","operationId":"getCustomerDigitalChannels","name":"Retrieves the list of message channels such as internet banking, mobile banking, ATM, etc available for the specific customer","summary":"Retrieves list of message channels","tags":["RETAIL"],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"Identifier of the customer"},{"name":"channelName","in":"query","type":"string","required":false,"description":"Name of the (digital) channel registered by the Customer"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"CustomerDigitalChannelsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"POST","path":"/party/customers/messages","fullPath":"/api/v5.3.0/party/customers/messages","operationId":"createMessages","name":"Create a new secure message for a customer to be sent by bank","summary":"Create a new secure message for a customer","tags":["RETAIL"],"parameters":[{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"messages":[{}],"subject":"string","toCustomerId":"string","extensions":{}}},"responses":{"200":"MessagesResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/party/customers/{customerId}/jointCustomers","fullPath":"/api/v5.3.0/party/customers/{customerId}/jointCustomers","operationId":"getJointCustomerDetails","name":"Retrieves details such as joint relation code, name, joint customer details and reverse relationships for a specific customer","summary":"Retrieves joint customer details for a specific customer","tags":["RETAIL"],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"Identifier of the customer"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"JointCustomerDetailsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/party/customers/{customerId}/KYC","fullPath":"/api/v5.3.0/party/customers/{customerId}/KYC","operationId":"getCustomerKYCDetails","name":"Retrieves the KYC details such as contact date, introducer, last and next review date, KYC and AML status of a customer","summary":"Retrieves KYC details for a specific customer","tags":["RETAIL"],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"Identifier of the customer"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"CustomerKYCDetailsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/party/customers/{customerId}/personalProfiles","fullPath":"/api/v5.3.0/party/customers/{customerId}/personalProfiles","operationId":"getCustomerPersonalDetails","name":"Retrieves personal details such as residence, communication details, occupation details, asset and liability information","summary":"Retrieves personal details of customer","tags":["RETAIL"],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"Identifier of the customer"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"CustomerPersonalDetailsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/party/customers/postingRestrictions","fullPath":"/api/v5.3.0/party/customers/postingRestrictions","operationId":"getCustomerPostingRestrictions","name":"Retrieves the credit and debit posting restriction details such as restriction reference and name of restriction set for a customer","summary":"Retrieves posting restriction details","tags":["RETAIL"],"parameters":[{"name":"customerId","in":"query","type":"string","required":false,"description":"Identifier of the customer"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"CustomerPostingRestrictionsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"POST","path":"/party/relationships/{relationId}","fullPath":"/api/v5.3.0/party/relationships/{relationId}","operationId":"createPartyRelationship","name":"Create a party relationship between a person, entity or customer with details such as party name, relation type, related as, relation code and owning details","summary":"Create party relationship details","tags":["RETAIL"],"parameters":[{"name":"relationId","in":"path","type":"string","required":true,"description":"Identifier of the Customer Relationship and Party Relationship"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"partyDisplayNames":[{}],"partyRelationships":[{}],"extensions":{}}},"responses":{"200":"PartyRelationshipResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/party/relationships/{relationId}","fullPath":"/api/v5.3.0/party/relationships/{relationId}","operationId":"updatePartyRelationship","name":"Update party relationship between a person, entity or customer with details such as party name, relation type, related as, relation code and owning details","summary":"Update party relationship details","tags":["RETAIL"],"parameters":[{"name":"relationId","in":"path","type":"string","required":true,"description":"Identifier of the Customer Relationship and Party Relationship"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"partyDisplayNames":[{}],"partyRelationships":[{}],"extensions":{}}},"responses":{"200":"PartyRelationshipResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/party/customers/{customerId}/cards","fullPath":"/api/v5.3.0/party/customers/{customerId}/cards","operationId":"getCustomerCreditCards","name":"Retrieves the card details such as card number, card type and status, linked account and its balances of a customer","summary":"Retrieves card details of a customer","tags":["RETAIL"],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"Identifier of the customer"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"CustomerCreditCardsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/party/customers/{customerId}/standingOrders","fullPath":"/api/v5.3.0/party/customers/{customerId}/standingOrders","operationId":"getStandingOrders","name":"Retrieves the list of standing instructions for a customer with details such as instruction reference, order type, frequency of payments, mode of payment and credit & debit parties involved","summary":"Retrieves standing instruction details of a customer","tags":["RETAIL"],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"Identifier of the customer"},{"name":"standingOrderId","in":"query","type":"string","required":false,"description":"The unique standing order identifier"},{"name":"accountId","in":"query","type":"string","required":false,"description":"Identifier of the account. Often referred to as the account number, yet for consistency this is always referred to as accountId. Accepts both IBAN & BBAN"},{"name":"orderingCustomerId","in":"query","type":"string","required":false,"description":"Indicates the customer id for the ordering customer"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"StandingOrdersResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/party/customers/{customerId}/directDebits","fullPath":"/api/v5.3.0/party/customers/{customerId}/directDebits","operationId":"getDirectDebits","name":"Retrieves the list of direct debits for a customer with details such as direct debit reference, debit and credit accounts, transaction amount, payment frequency, next payment date and direction of payment","summary":"Retrieves direct debits details of a customer","tags":["RETAIL"],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"Identifier of the customer"},{"name":"directDebitId","in":"query","type":"string","required":false,"description":"The unique identifier of the direct debit mandate. "},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"DirectDebitsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"POST","path":"/party/customers/deliveryPreferences/{deliveryPreferenceId}","fullPath":"/api/v5.3.0/party/customers/deliveryPreferences/{deliveryPreferenceId}","operationId":"createDeliveryPreference","name":"Create customer delivery preferences with details such as message group, carrier, role, address, email details and format of messages","summary":"Create customer delivery preferences","tags":["RETAIL"],"parameters":[{"name":"deliveryPreferenceId","in":"path","type":"string","required":true,"description":"Identifier of the customer delivery preferences"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"messageGroup":[{}],"otherMessagesDetail":[{}],"applyOtherMessages":"string","extensions":{}}},"responses":{"200":"DeliveryPreferenceResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/party/customers/deliveryPreferences/{deliveryPreferenceId}","fullPath":"/api/v5.3.0/party/customers/deliveryPreferences/{deliveryPreferenceId}","operationId":"updateDeliveryPreference","name":"Update customer delivery preferences with details such as message group, carrier, role, address, email details and format of messages","summary":"Update customer delivery preferences","tags":["RETAIL"],"parameters":[{"name":"deliveryPreferenceId","in":"path","type":"string","required":true,"description":"Identifier of the customer delivery preferences"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"messageGroup":[{}],"otherMessagesDetail":[{}],"applyOtherMessages":"string","extensions":{}}},"responses":{"200":"DeliveryPreferenceResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/party/customers/limits/{limitId}","fullPath":"/api/v5.3.0/party/customers/limits/{limitId}","operationId":"updateLimit","name":"Updates the limit details such as currency, limit grade, commodity, country and limit product details","summary":"Update credit limit details for customer","tags":["RETAIL"],"parameters":[{"name":"limitId","in":"path","type":"string","required":true,"description":"The identifier of credit limit"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"countries":[{}],"grades":[{}],"commodities":[{}],"currencyId":"string","onlineLimitDate":"2024-01-01","availableMarker":"string","allowNetting":"string","onlineUpdate":"string","limitProductId":"string","checkLimit":"string","band":"string","reducingLimit":"string","internalAmount":"string","extensions":{}}},"responses":{"200":"LimitResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/party/customers/{customerId}/customerExitStatus","fullPath":"/api/v5.3.0/party/customers/{customerId}/customerExitStatus","operationId":"getCustomerExitStatus","name":"Retrieves customer exit status details such as customer type, exit date, status and reason","summary":"Retrieves customer exit status details of customer","tags":["RETAIL"],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"Identifier of the customer"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"CustomerExitStatusResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"PUT","path":"/party/customers/{customerId}/customerExitStatus","fullPath":"/api/v5.3.0/party/customers/{customerId}/customerExitStatus","operationId":"updateCustomerExitStatus","name":"Update a customer record with exit status and exit reason marking the customer as blocked or rejected or closed","summary":"Update customer exit status details of customers","tags":["RETAIL"],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"Identifier of the customer"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"exitStatus":"string","exitReason":"string","extensions":{}}},"responses":{"200":"CustomerExitStatusResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/party/customers/settings/customerExitStatus/{customerExitStatusId}","fullPath":"/api/v5.3.0/party/customers/settings/customerExitStatus/{customerExitStatusId}","operationId":"getCustomerExitStatusParam","name":"Retrieves available conditions such as customer exit setup reference, allowed reasons and allowed re-open details to update customer exit status of customers","summary":"Retrieves conditions to update customer exit status of customer","tags":["RETAIL"],"parameters":[{"name":"customerExitStatusId","in":"path","type":"string","required":true,"description":""},{"name":"customerType","in":"query","type":"string","required":false,"description":"Identifies the type of customers. Example Personal, Business, Corporate, etc."},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"CustomerExitStatusParamResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"POST","path":"/party/customers/settings/customerExitStatus/{customerExitStatusId}","fullPath":"/api/v5.3.0/party/customers/settings/customerExitStatus/{customerExitStatusId}","operationId":"createCustomerExitStatusParam","name":"Create conditions such as applicable customer type and allowed reasons to update the customer exit status details of customers","summary":"Create conditions to update customer exit status of customer","tags":["RETAIL"],"parameters":[{"name":"customerExitStatusId","in":"path","type":"string","required":true,"description":"The field reflects the exit status ID of a customer or prospect from the parameterization table CUSTOMER.EXIT.STATUS"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"allowedExitReasons":[{}],"exitStatusDescription":"string","customerType":"string","allowRemoveExitStatus":"string","extensions":{}}},"responses":{"200":"CustomerExitStatusParamResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/party/customers/settings/{customerExitStatusId}/customerExitStatus","fullPath":"/api/v5.3.0/party/customers/settings/{customerExitStatusId}/customerExitStatus","operationId":"updateCustomerExitStatusParam","name":"Create conditions such as applicable customer type and allowed reasons to update the customer exit status details of customers","summary":"Create conditions to update customer exit status of customer","tags":["RETAIL"],"parameters":[{"name":"customerExitStatusId","in":"path","type":"string","required":true,"description":"The field reflects the exit status ID of a customer or prospect from the parameterization table CUSTOMER.EXIT.STATUS"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"allowedExitReasons":[{}],"exitStatusDescription":"string","customerType":"string","allowRemoveExitStatus":"string","extensions":{}}},"responses":{"200":"CustomerExitStatusParamResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/party/customers/{customerId}/addresses","fullPath":"/api/v5.3.0/party/customers/{customerId}/addresses","operationId":"getCustomerAddressOutput","name":"Returns structured/unstructured address details of specified customer based on address option in request. When structured format is requested, the values are returned in format of structured data name combined with corresponding customer address value. When unstructured format is requested, the address details are returned based on configured unstructured address format.","summary":"Retrieves structured/ unstructured address format of customer","tags":["RETAIL"],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"Identifier of the customer"},{"name":"addressOption","in":"query","type":"string","required":false,"description":"It reflects the preference for the customer address format, respective structured, unstructured or both"},{"name":"addressOutputFormat","in":"query","type":"string","required":false,"description":"It identifies the address output format for the unstructured address"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"CustomerAddressOutputResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/party/customers/{customerId}/shortNames","fullPath":"/api/v5.3.0/party/customers/{customerId}/shortNames","operationId":"getCustomerShortNames","name":"Retrieves customer short name that can be used as customer enrichment by any application","summary":"Retrieves customer short name","tags":["RETAIL"],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"CustomerShortNamesResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/party/customers/{customerId}/mandates","fullPath":"/api/v5.3.0/party/customers/{customerId}/mandates","operationId":"getCustomerMandates","name":"Retrieves the mandate instruction details such as application eligible for mandate process and the corresponding mandate rule that is being applied to check mandates for transactions involving the specified customer.","summary":"Retrieves mandate instruction applicable for the requested customer","tags":["RETAIL"],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"CustomerMandatesResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/party/customers/{customerId}/documents","fullPath":"/api/v5.3.0/party/customers/{customerId}/documents","operationId":"getCustomerLegalDocuments","name":"Retrieves the details of legal document provided by the customer such as document name, document id, issue date, expiry date and authority who issued the document.","summary":"Retrieves the customer legal document details","tags":["RETAIL"],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"CustomerLegalDocumentsResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/party/customers/{customerId}/profiles","fullPath":"/api/v5.3.0/party/customers/{customerId}/profiles","operationId":"getCustomerProfile","name":"Retrieves the customer basic details such as personal information, address location, basic contact details and other general information.","summary":"Retrieves profile details of the requested customer","tags":["RETAIL"],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"CustomerProfileResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/party/customers/alternateReferences/{alternateReference}","fullPath":"/api/v5.3.0/party/customers/alternateReferences/{alternateReference}","operationId":"getCustomerId","name":"Retrieves the customer identifier for the provided alternate reference of the customer","summary":"Retrieves customer id for the given alternate reference","tags":["RETAIL"],"parameters":[{"name":"alternateReference","in":"path","type":"string","required":true,"description":"If the new Account to be created is a shadow of another Account already exisitng in another system, then the Account reference of that system can be specified here. The value given in this field will "},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"CustomerIdResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/party/customers/{customerId}/restrictions","fullPath":"/api/v5.3.0/party/customers/{customerId}/restrictions","operationId":"getCustomerRestrictions","name":"Retrieves the transaction restrictions imposed on the customer specified. Restrictions can be post no entries, black listed customer, pending KYC due reasons for restricting transactions on this customer","summary":"Retrieves the restriction details","tags":["RETAIL"],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"CustomerRestrictionsResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/party/customers/{customerId}/contacts","fullPath":"/api/v5.3.0/party/customers/{customerId}/contacts","operationId":"getCustomerContacts","name":"Retrieves the contact details such as phone number, mobile numbers, fax and email address specific to the requested customer","summary":"Retrieves the customer contact details","tags":["RETAIL"],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"Identifier of the customer"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"CustomerContactsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/party/customers/{customerId}/relationships","fullPath":"/api/v5.3.0/party/customers/{customerId}/relationships","operationId":"getCustomerRelationships","name":"Retrieves the relationship details such as related customer and the relationship that exists with the requested customer","summary":"Retrieves the relation customers","tags":["RETAIL"],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"CustomerRelationshipsResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/party/customers/{customerId}/payments","fullPath":"/api/v5.3.0/party/customers/{customerId}/payments","operationId":"getPartyBasicDetails","name":"Retrieves the customer information that are required for processing or validating the customer involved in a payment transaction. Provides the information such as customer name details, birth details, address details,  market sector, target, nationality, residence country and preferred language for communication.","summary":"Retrieves customer details required for payment processing","tags":["RETAIL"],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"Identifier of the customer"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"PartyBasicDetailsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/party/customers/{customerId}/addresses/swiftAddresses/{addressId}","fullPath":"/api/v5.3.0/party/customers/{customerId}/addresses/swiftAddresses/{addressId}","operationId":"getCustomerSwiftAddress","name":"Retrieves the SWIFT address details such as delivery address, short name and tag25 indicator for the customer.","summary":"Retrieves the SWIFT address details for the customer.","tags":["RETAIL"],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"Identifier of the customer"},{"name":"addressId","in":"path","type":"string","required":true,"description":"Reference Id of address record"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"CustomerSwiftAddressResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/party/customers/{customerId}/charges","fullPath":"/api/v5.3.0/party/customers/{customerId}/charges","operationId":"getCustomerCharge","name":"Retrieves customer charge for a customer with details such as tax type and tax group.","summary":"Retrieves customer charge for a specific customer.","tags":["RETAIL"],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"Identifier of the customer"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"CustomerChargeResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"POST","path":"/party/customers/{customerId}/charges","fullPath":"/api/v5.3.0/party/customers/{customerId}/charges","operationId":"createCustomerCharge","name":"Creates customer charge for a customer with details such as tax type and tax group.","summary":"Creates customer charge for a specific customer.","tags":["RETAIL"],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"Identifier of the customer"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"taxGroups":[{}],"extensions":{}}},"responses":{"200":"CustomerChargeResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/party/customers/{customerId}/charges","fullPath":"/api/v5.3.0/party/customers/{customerId}/charges","operationId":"updateCustomerCharge","name":"Updates customer charge for a customer with details such as tax type and tax group.","summary":"Updates customer charge for a specific customer.","tags":["RETAIL"],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"Identifier of the customer"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"taxGroups":[{}],"extensions":{}}},"responses":{"200":"CustomerChargeResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/party/customers/{customerId}/addresses/smsAddresses","fullPath":"/api/v5.3.0/party/customers/{customerId}/addresses/smsAddresses","operationId":"getCustomerPhoneAddress","name":"Retrieves the list of customer sms communication address with details such as name, idd prefix and mobile number.","summary":"Retrieves available list of customer sms communication addresses","tags":["RETAIL"],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"Identifier of the customer"},{"name":"addressId","in":"query","type":"string","required":false,"description":"Reference Id of address record"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"CustomerPhoneAddressResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"POST","path":"/party/customers/{customerId}/addresses/smsAddresses","fullPath":"/api/v5.3.0/party/customers/{customerId}/addresses/smsAddresses","operationId":"createCustomerPhoneAddress","name":"Create customer sms communication address with details such as name, idd prefix and mobile number.","summary":"Creates customer sms communication address","tags":["RETAIL"],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"Identifier of the customer"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"customerShortNames":[{}],"iddPrefixMobile":"string","mobileNumber":"string","extensions":{}}},"responses":{"200":"CustomerPhoneAddressResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/party/customers/{customerId}/addresses/emailAddresses","fullPath":"/api/v5.3.0/party/customers/{customerId}/addresses/emailAddresses","operationId":"getCustomerEmailAddress","name":"Retrieves the list of customer email communication address with details such as customer name and email references.","summary":"Retrieves available list of customer email communication addresses","tags":["RETAIL"],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"Identifier of the customer"},{"name":"addressId","in":"query","type":"string","required":false,"description":"Reference Id of address record"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"CustomerEmailAddressResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"POST","path":"/party/customers/{customerId}/addresses/emailAddresses","fullPath":"/api/v5.3.0/party/customers/{customerId}/addresses/emailAddresses","operationId":"createCustomerEmailAddress","name":"Create customer email communication address with details such as customer name and email references.","summary":"Creates customer email communication address","tags":["RETAIL"],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"Identifier of the customer"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"customerShortNames":[{}],"email":"string","extensions":{}}},"responses":{"200":"CustomerEmailAddressResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/party/customers/{customerId}/addresses/printAddresses","fullPath":"/api/v5.3.0/party/customers/{customerId}/addresses/printAddresses","operationId":"getCustomerPrintAddress","name":"Retrieves the list of customer print communication addresses with details such as name, address, postcode and phone number.","summary":"Retrieves available list of customer print communication addresses","tags":["RETAIL"],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"Identifier of the customer"},{"name":"addressId","in":"query","type":"string","required":false,"description":"Reference Id of address record"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"CustomerPrintAddressResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"POST","path":"/party/customers/{customerId}/addresses/printAddresses","fullPath":"/api/v5.3.0/party/customers/{customerId}/addresses/printAddresses","operationId":"createCustomerPrintAddress","name":"Create customer print communication address with details such as name, address, postcode and phone number.","summary":"Creates customer print communication address","tags":["RETAIL"],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"Identifier of the customer"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"customerShortNames":[{}],"customerNames":[{}],"addresses":[{}],"streets":[{}],"towns":[{}],"postCodes":[{}],"addressPurpose":"string","addressLocation":"string","addressVerifier":"string","countryCode":"string","departmentId":"string","subDepartmentId":"string","flatNumber":"string","buildingName":"string","buildingNumber":"string"}},"responses":{"200":"CustomerPrintAddressResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/party/customers/addresses/{customerAddressId}/smsAddresses","fullPath":"/api/v5.3.0/party/customers/addresses/{customerAddressId}/smsAddresses","operationId":"updateCustomerPhoneAddress","name":"Update customer sms communication address with details such as name, idd prefix and mobile number.","summary":"Updates customer sms communication address","tags":["RETAIL"],"parameters":[{"name":"customerAddressId","in":"path","type":"string","required":true,"description":"Identifier of the customer address table."},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"customerShortNames":[{}],"iddPrefixMobile":"string","mobileNumber":"string","extensions":{}}},"responses":{"200":"CustomerPhoneAddressResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"DELETE","path":"/party/customers/addresses/{customerAddressId}/smsAddresses","fullPath":"/api/v5.3.0/party/customers/addresses/{customerAddressId}/smsAddresses","operationId":"deleteCustomerPhoneAddress","name":"Delete the specified customer sms communication address that are no longer used.","summary":"Deletes customer sms communication address","tags":["RETAIL"],"parameters":[{"name":"customerAddressId","in":"path","type":"string","required":true,"description":"Identifier of the customer address table."},{"name":"payload","in":"body","type":"object","required":false,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}}},"responses":{"200":"CustomerPhoneAddressResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/party/customers/addresses/{customerAddressId}/emailAddresses","fullPath":"/api/v5.3.0/party/customers/addresses/{customerAddressId}/emailAddresses","operationId":"updateCustomerEmailAddress","name":"Update customer email communication address with details such as customer name and email references.","summary":"Updates customer email communication address","tags":["RETAIL"],"parameters":[{"name":"customerAddressId","in":"path","type":"string","required":true,"description":"Identifier of the customer address table."},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"customerShortNames":[{}],"email":"string","extensions":{}}},"responses":{"200":"CustomerEmailAddressResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"DELETE","path":"/party/customers/addresses/{customerAddressId}/emailAddresses","fullPath":"/api/v5.3.0/party/customers/addresses/{customerAddressId}/emailAddresses","operationId":"deleteCustomerEmailAddress","name":"Delete the specified customer email communication address that are no longer used.","summary":"Deletes customer email communication address","tags":["RETAIL"],"parameters":[{"name":"customerAddressId","in":"path","type":"string","required":true,"description":"Identifier of the customer address table."},{"name":"payload","in":"body","type":"object","required":false,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}}},"responses":{"200":"CustomerEmailAddressResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/party/customers/addresses/{customerAddressId}/printAddresses","fullPath":"/api/v5.3.0/party/customers/addresses/{customerAddressId}/printAddresses","operationId":"updateCustomerPrintAddress","name":"Update customer print communication address with details such as name, address, postcode and phone number.","summary":"Updates customer print communication address","tags":["RETAIL"],"parameters":[{"name":"customerAddressId","in":"path","type":"string","required":true,"description":"Identifier of the customer address table."},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"customerShortNames":[{}],"customerNames":[{}],"addresses":[{}],"streets":[{}],"towns":[{}],"postCodes":[{}],"addressPurpose":"string","addressLocation":"string","addressVerifier":"string","countryCode":"string","departmentId":"string","subDepartmentId":"string","flatNumber":"string","buildingName":"string","buildingNumber":"string"}},"responses":{"200":"CustomerPrintAddressResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"DELETE","path":"/party/customers/addresses/{customerAddressId}/printAddresses","fullPath":"/api/v5.3.0/party/customers/addresses/{customerAddressId}/printAddresses","operationId":"deleteCustomerPrintAddress","name":"Delete the specified customer print communication address that are no longer used.","summary":"Deletes customer print communication address","tags":["RETAIL"],"parameters":[{"name":"customerAddressId","in":"path","type":"string","required":true,"description":"Identifier of the customer address table."},{"name":"payload","in":"body","type":"object","required":false,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}}},"responses":{"200":"CustomerPrintAddressResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/party/customers/{customerId}/consents","fullPath":"/api/v5.3.0/party/customers/{customerId}/consents","operationId":"getCustomerConsents","name":"Retrieves the list of consent details for specific customer","summary":"Retrieves customer consents details","tags":["RETAIL"],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"Identifier of the customer"},{"name":"propertyClassId","in":"query","type":"string","required":false,"description":"The identifier of a condition that is used to build a product"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"CustomerConsentsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"POST","path":"/party/customers/{customerId}/fatca","fullPath":"/api/v5.3.0/party/customers/{customerId}/fatca","operationId":"createFatcaCustomer","name":"Creates the FATCA customer supplementary information record that stores the related FATCA details for the customer","summary":"Create FATCA customer supplementary information details","tags":["RETAIL"],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"Identifier of the customer"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"citizenships":[{}],"tinDetails":[{}],"Owner":[{}],"JointOwner":[{}],"fatcaClientType":"string","isPlaceOfBirthUs":"string","domicile":"string","greencardDetails":"string","residenceId":"string","isPoa":"string","standingInstructionOnUsAccount":"string","accountInstructionfromUs":"string","socialSecurityNumber":"string","phoneNumber":"string","isDormantAccount":"string"}},"responses":{"200":"FatcaCustomerResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/party/customers/{customerId}/fatca","fullPath":"/api/v5.3.0/party/customers/{customerId}/fatca","operationId":"updateFatcaCustomer","name":"Update the FATCA customer supplementary information record that stores the related FATCA details for the customer","summary":"Update FATCA customer supplementary information details","tags":["RETAIL"],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"Identifier of the customer"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"citizenships":[{}],"tinDetails":[{}],"Owner":[{}],"JointOwner":[{}],"fatcaClientType":"string","isPlaceOfBirthUs":"string","domicile":"string","greencardDetails":"string","residenceId":"string","isPoa":"string","standingInstructionOnUsAccount":"string","accountInstructionfromUs":"string","socialSecurityNumber":"string","phoneNumber":"string","isDormantAccount":"string"}},"responses":{"200":"FatcaCustomerResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/party/customers/{customerId}/portfolios/{portfolioId}/overdueSettlements","fullPath":"/api/v5.3.0/party/customers/{customerId}/portfolios/{portfolioId}/overdueSettlements","operationId":"getOverdueSettlements","name":"Retrieves overdue settlements of customer or portfolio with details such as transaction reference, instrument reference , instrument name, depository and broker involved, trade date, trade currency, trade quantity, current customer and broker outstandings","summary":"Retrieves overdue settlements of customer or portfolio","tags":["RETAIL"],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"Identifier of the customer"},{"name":"portfolioId","in":"path","type":"string","required":true,"description":"Id of the portfolio or security account"},{"name":"transactionId","in":"query","type":"string","required":false,"description":"Unique transaction identifier for retrieving the details of the transaction. For example: FT0102030333 etc."},{"name":"brokerId","in":"query","type":"string","required":false,"description":"The identifier of the broker"},{"name":"tradeDate","in":"query","type":"string","required":false,"description":"Standard date field which records trade date of the account"},{"name":"valueDate","in":"query","type":"string","required":false,"description":"Indicates the value date on which the underlying accounting entry is to be given value (for interest purposes)"},{"name":"depository","in":"query","type":"string","required":false,"description":"Person designated as depository by the company in or pursuant to this Indenture, and, unless otherwise provided with respect to any security, any successor to such person"},{"name":"currency","in":"query","type":"string","required":false,"description":"Identifies the currency. E.g. USD, GBP etc"},{"name":"instrumentId","in":"query","type":"string","required":false,"description":"The identifier of the instrument"},{"name":"deliveryInstruction","in":"query","type":"string","required":false,"description":"Customer's directions to a bank as to the disposition of funds and securities in the customer's account"},{"name":"transactionType","in":"query","type":"string","required":false,"description":"Identifies the transaction type applicable to the transaction being processed, i.e. outward or inward payment. For example: ACPX, OTPX etc."},{"name":"quantity","in":"query","type":"string","required":false,"description":"The nominal quantity"},{"name":"stockExchange","in":"query","type":"string","required":false,"description":"Contains the stock exchange details where a particular security is usually dealt"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"OverdueSettlementsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/party/customers/accountServicingProviders","fullPath":"/api/v5.3.0/party/customers/accountServicingProviders","operationId":"getOtherBanksToConnectTo","name":"Retrieves the third party providers that are allowed to interact with the bank or entity with details such as global unique reference number, provider country,provider name and national competent authority register code","summary":"Retrieves details of third party providers","tags":["RETAIL"],"parameters":[{"name":"openBankingId","in":"query","type":"string","required":false,"description":"Identifies the open banking number of the customer"},{"name":"countryId","in":"query","type":"string","required":false,"description":"ISO country code of the financial institution. "},{"name":"setActive","in":"query","type":"string","required":false,"description":"Flag to set the connection status to active"},{"name":"status","in":"query","type":"string","required":false,"description":"Contains status of the data rights request.Allowed values are INITIATED, INPROGESS, EXTENDED, COMPLETED, REJECTED."},{"name":"extSourceProvider","in":"query","type":"string","required":false,"description":"Contains the name of the external source provider for the customer"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"OtherBanksToConnectToResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/party/customers/prospects","fullPath":"/api/v5.3.0/party/customers/prospects","operationId":"getProspectCustomers","name":"Retrieves the list of prospect customers with details such as contact information, residence details, personal details and prospect legal details","summary":"Retrieves prospect details of customers","tags":["RETAIL"],"parameters":[{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"ProspectCustomersResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"POST","path":"/party/customers/prospects","fullPath":"/api/v5.3.0/party/customers/prospects","operationId":"createProspectCustomer","name":"Create a prospect customer with basic details such as contact information, residence details and prospect legal details","summary":"Create a prospect customer","tags":["RETAIL"],"parameters":[{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"customerNames":[{}],"streets":[{}],"addresses":[{}],"townCountries":[{}],"postCodes":[{}],"countries":[{}],"phoneNumbers":[{}],"emails":[{}],"socialNetworkIds":[{}],"prospectLegalDetails":[{}],"personEntity":"string","departmentId":"string","subDepartmentId":"string","floorNumber":"string","locationName":"string"}},"responses":{"200":"ProspectCustomerResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/party/customers/{customerId}/opportunities","fullPath":"/api/v5.3.0/party/customers/{customerId}/opportunities","operationId":"getCustomerOpportunities","name":"Retrieves the details of sales opportunities such as score, status and product details which are likely to be of interest to specific customers","summary":"Retrieves the sales opportunities for specific customers","tags":["RETAIL"],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"Identifier of the customer"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"CustomerOpportunitiesResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/party/customers/{customerId}/requests","fullPath":"/api/v5.3.0/party/customers/{customerId}/requests","operationId":"getCustomerRequests","name":"Retrieves process workflow details such as process name, activity details and status for a specific customer","summary":"Retrieves process workflows for a specific customer","tags":["RETAIL"],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"Identifier of the customer"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"CustomerRequestsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"PUT","path":"/party/customers/prospects/{prospectId}","fullPath":"/api/v5.3.0/party/customers/prospects/{prospectId}","operationId":"updateProspectCustomer","name":"Update a prospect customer with basic details such as contact information, residence details and prospect legal details","summary":"Update a prospect customer","tags":["RETAIL"],"parameters":[{"name":"prospectId","in":"path","type":"string","required":true,"description":"Indicates the status of an onboarding customer. Status can be PROSPECT while onboarding and ACTIVE when the prospect becomes a Customer."},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"customerNames":[{}],"streets":[{}],"addresses":[{}],"townCountries":[{}],"postCodes":[{}],"countries":[{}],"phoneNumbers":[{}],"emails":[{}],"socialNetworkIds":[{}],"prospectLegalDetails":[{}],"personEntity":"string","departmentId":"string","subDepartmentId":"string","floorNumber":"string","locationName":"string"}},"responses":{"200":"ProspectCustomerResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/party/customers/{customerId}/alertRequests","fullPath":"/api/v5.3.0/party/customers/{customerId}/alertRequests","operationId":"getAlertRequests","name":"Retrieves the alert subscription details such as alert reference, alert name and condition for alerts of a customer","summary":"Retrieves alert requests details","tags":["RETAIL"],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"Identifier of the customer"},{"name":"contractReference","in":"query","type":"string","required":false,"description":"Contains the contract reference"},{"name":"subscribe","in":"query","type":"string","required":false,"description":"Enables an alert service"},{"name":"alertRequestId","in":"query","type":"string","required":false,"description":"The unique identifier of the alert request."},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"AlertRequestsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/party/relationships/{partyId}/relations","fullPath":"/api/v5.3.0/party/relationships/{partyId}/relations","operationId":"getPartyRelationship","name":"Retrieves the relationship details such as party name, type, relation code, status and owning percentage of customers involved in a relationship","summary":"Retrieves list of party relationship details","tags":["RETAIL"],"parameters":[{"name":"partyId","in":"path","type":"string","required":true,"description":"Allows capturing of customers or person entities to be part of the relationship. If partyType is selected as Customer, then the system will allow only customer Ids to be captured into this field. If p"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"PartyRelationshipResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"POST","path":"/party/customers/staticDataUpdateEvents","fullPath":"/api/v5.3.0/party/customers/staticDataUpdateEvents","operationId":"createCustomerStaticChange","name":"Create data log with details such as event name, event creation date and time for customer that has undergone static data updates from external party systems","summary":"Create log of customer static data update event from external party systems","tags":["RETAIL"],"parameters":[{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"creationDate":"string","requestTime":"string","eventName":"string","customerId":"string","extensions":{}}},"responses":{"200":"CustomerStaticChangeResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/party/customers/bankCodes/BICs/{bicId}/owners","fullPath":"/api/v5.3.0/party/customers/bankCodes/BICs/{bicId}/owners","operationId":"getBicOwners","name":"Returns the owner of the BIC and the channel through which this BIC is used. If a company code is returned without a customer ID this indicates the entity of the current financial institution. If a company code is returned along with a customer number, this indicates the customer identified by the respective BIC and the entity of the current financial institution that maintains the main relationship with the customer. The address type returned represent the context in which the BIC can be used.","summary":"Returns the owner of the BIC and the channel through which this BIC is used.","tags":["RETAIL"],"parameters":[{"name":"bicId","in":"path","type":"string","required":true,"description":"Bank Identifier Code (BIC) of the financial institution"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"BicOwnersResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}}]},{"key":"party-customerServices-v5.4.0","title":"Customer management","version":"v5.4.0","description":"API to create, update and manage customer details such as delivery preferences, joint customer details, party relationships, KYC details, alert subscriptions, customer exit status, customer address formats & posting restrictions","endpointCount":82,"endpoints":[{"method":"GET","path":"/party/customers/{customerId}","fullPath":"/api/v1.0.0/party/customers/{customerId}","operationId":"getCustomer","name":"Retrieves the customer details such as customer contact information, residence details, legal document details, occupation details and relationship details for the specific customer","summary":"Retrieves customer details","tags":["RETAIL"],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"Identifier of the customer"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"","default":"","400":"","500":""}},{"method":"PUT","path":"/party/customers/{customerId}","fullPath":"/api/v1.0.0/party/customers/{customerId}","operationId":"updateCustomer","name":"Update customer details with the information such as customer contact information, residence details, legal document details, occupation details and relationship details, etc provided by the user","summary":"Update customer details","tags":["RETAIL"],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"Identifier of the customer"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"","default":"","400":"","500":""}},{"method":"POST","path":"/party/customers/{customerId}","fullPath":"/api/v1.0.0/party/customers/{customerId}","operationId":"createCustomerWithId","name":"Create a customer with the information such as customer contact information, residence details, legal document details, occupation details and relationship details, etc provided by the user. It allows to create a customer with the provided id.","summary":"Create a customer by providing an Id","tags":["RETAIL"],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"Identifier of the customer"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"","default":"","400":"","500":""}},{"method":"GET","path":"/party/customers","fullPath":"/api/v1.0.0/party/customers","operationId":"getCustomerInformation","name":"Retrieves the customer details such as delivery or postal details, contact information, residence details, customer profile, legal document details, occupation details and status of customer","summary":"Retrieves list of customer basic details","tags":["RETAIL"],"parameters":[{"name":"customerId","in":"query","type":"string","required":false,"description":"Identifier of the customer"},{"name":"customerName","in":"query","type":"string","required":false,"description":"Indicates the name of the customer. Originator is the party who requests the payment cancellation."},{"name":"street","in":"query","type":"string","required":false,"description":"Contains the street name of the customer or the property"},{"name":"addressCity","in":"query","type":"string","required":false,"description":"The town and/or city component of the base address of a customer"},{"name":"countryId","in":"query","type":"string","required":false,"description":"ISO country code of the financial institution. "},{"name":"postCode","in":"query","type":"string","required":false,"description":"Identifies the address postal code for the customer or the property"},{"name":"dateOfBirth","in":"query","type":"string","required":false,"description":"The date of birth of an individual customer"},{"name":"dateOfBirthBW","in":"query","type":"string","required":false,"description":"Indicates the criteria for the between operation on the date of birth"},{"name":"customerStatus","in":"query","type":"string","required":false,"description":"The internal bank status of a customer"},{"name":"sectorId","in":"query","type":"string","required":false,"description":"An institution-defined identifier of the type of customer"},{"name":"sectorIdBW","in":"query","type":"string","required":false,"description":"Indicates the criteria for the between operation on the sector"},{"name":"accountOfficerId","in":"query","type":"string","required":false,"description":"The identifier of the department head or specific account officer responsible for the customer"},{"name":"industryId","in":"query","type":"string","required":false,"description":"An institution-defined identifier of the industry in which the customer is trading, operating or is associated with"},{"name":"nationalityId","in":"query","type":"string","required":false,"description":"The identifier of the nationality of a customer"},{"name":"residenceId","in":"query","type":"string","required":false,"description":"The identifier of the country of residence of a customer"},{"name":"lastName","in":"query","type":"string","required":false,"description":"The last name of an individual customer"},{"name":"phoneNumber","in":"query","type":"string","required":false,"description":"The phone number of the customer or prospect"},{"name":"customerMnemonic","in":"query","type":"string","required":false,"description":"Specifies an alternative easy means of referencing the Customer"},{"name":"firstName","in":"query","type":"string","required":false,"description":"Specifies customer's first name"},{"name":"customerType","in":"query","type":"string","required":false,"description":"Identifies the type of customers. Example Personal, Business, Corporate, etc."},{"name":"email","in":"query","type":"string","required":false,"description":"Email Identifier of the Customer"},{"name":"mobilePhoneNumber","in":"query","type":"string","required":false,"description":"Represents the phone number of a customer"},{"name":"taxId","in":"query","type":"string","required":false,"description":"Holds the Customer's TAX/SSN Id."},{"name":"shortName","in":"query","type":"string","required":false,"description":"Contains the name of the account, basically the short title of the account."},{"name":"officePhoneNumber","in":"query","type":"string","required":false,"description":"The office phone number of the customer"},{"name":"faxId","in":"query","type":"string","required":false,"description":"The fax (facsimile) number of the customer"},{"name":"address","in":"query","type":"string","required":false,"description":"Contains the communication address of the customer or full address of the property"},{"name":"relCustomer","in":"query","type":"string","required":false,"description":"Customers linked or related to the arrangement owner"},{"name":"relationshipCode","in":"query","type":"string","required":false,"description":"Relationship identifier between the partyType and relatedPartyType"},{"name":"legalId","in":"query","type":"string","required":false,"description":"Unique reference number of the legal documents submitted as identification proof"},{"name":"legalDocumentName","in":"query","type":"string","required":false,"description":"Name of the legal documents such as passport, driving licence etc., provided as identification proof"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"","default":"","400":"","500":""}},{"method":"POST","path":"/party/customers","fullPath":"/api/v1.0.0/party/customers","operationId":"createCustomer","name":"Create a customer with the information such as customer contact information, residence details, legal document details, occupation details and relationship details, etc provided by the user. It allows to create a customer with system generated id.","summary":"Create a customer","tags":["RETAIL"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"","default":"","400":"","500":""}},{"method":"GET","path":"/party/customers/relationships","fullPath":"/api/v1.0.0/party/customers/relationships","operationId":"getCustomerRelationship","name":"Retrieves customer relationship details such as type of relationship, party information, related as, owning details, role & purpose of relationship for specific party or customer","summary":"Retrieves list of customer relationships","tags":["RETAIL"],"parameters":[{"name":"customerRelationGroupId","in":"query","type":"string","required":false,"description":"Identifies the key to Customer Relationship Group to form a relation"},{"name":"partyId","in":"query","type":"string","required":false,"description":"Allows capturing of customers or person entities to be part of the relationship. If partyType is selected as Customer, then the system will allow only customer Ids to be captured into this field. If p"},{"name":"relatedPartyId","in":"query","type":"string","required":false,"description":"Identifier of the Related Party"},{"name":"relationId","in":"query","type":"string","required":false,"description":"Identifier of the Customer Relationship and Party Relationship"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"","default":"","400":"","500":""}},{"method":"POST","path":"/party/customers/relationships","fullPath":"/api/v1.0.0/party/customers/relationships","operationId":"createCustomerRelationship","name":"Create a customer relationship for a customer with details such as type of relationship, party information, related as, owning details, role & purpose of relationship","summary":"Create customer relationship with other customers","tags":["RETAIL"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"","default":"","400":"","500":""}},{"method":"PUT","path":"/party/customers/relationships/{relationId}","fullPath":"/api/v1.0.0/party/customers/relationships/{relationId}","operationId":"updateCustomerRelationship","name":"Update customer relationship for a customer with details such as type of relationship, party information, related as, owning details, role & purpose of relationship","summary":"Update customer relationship","tags":["RETAIL"],"parameters":[{"name":"relationId","in":"path","type":"string","required":true,"description":"Identifier of the Customer Relationship and Party Relationship"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"","default":"","400":"","500":""}},{"method":"GET","path":"/party/customers/reportingStatus","fullPath":"/api/v1.0.0/party/customers/reportingStatus","operationId":"getCustomerReportingStatus","name":"Retrieves the FATCA/CRS reporting status and reporting jurisdiction of the customer","summary":"Retrieves reporting status of the customer","tags":["RETAIL"],"parameters":[{"name":"customerId","in":"query","type":"string","required":true,"description":"Identifier of the customer"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"","default":"","400":"","500":""}},{"method":"GET","path":"/party/customers/{customerId}/sweeps","fullPath":"/api/v1.0.0/party/customers/{customerId}/sweeps","operationId":"getCustomerSweeps","name":"Retrieves account sweep details such as sweep reference, type, balance requirements for sweep and frequency of sweep for the list of accounts available to a customer","summary":"Retrieves account sweep details of the specific customer","tags":["RETAIL"],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"Identifier of the customer"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"","default":"","400":"","500":""}},{"method":"GET","path":"/party/customers/{customerId}/deliveryOptions","fullPath":"/api/v1.0.0/party/customers/{customerId}/deliveryOptions","operationId":"getCustomerDeliveryOptions","name":"Retrieves the delivery preferences of the customer such as the message group, carrier and address.","summary":"Retrieves delivery preferences of the customer","tags":["RETAIL"],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"Identifier of the customer"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"","default":"","400":"","500":""}},{"method":"GET","path":"/party/customers/{customerId}/channels","fullPath":"/api/v1.0.0/party/customers/{customerId}/channels","operationId":"getCustomerDigitalChannels","name":"Retrieves the list of message channels such as internet banking, mobile banking, ATM, etc available for the specific customer","summary":"Retrieves list of message channels","tags":["RETAIL"],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"Identifier of the customer"},{"name":"channelName","in":"query","type":"string","required":false,"description":"Name of the (digital) channel registered by the Customer"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"","default":"","400":"","500":""}},{"method":"POST","path":"/party/customers/messages","fullPath":"/api/v1.0.0/party/customers/messages","operationId":"createMessages","name":"Create a new secure message for a customer to be sent by bank","summary":"Create a new secure message for a customer","tags":["RETAIL"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"","default":"","400":"","500":""}},{"method":"GET","path":"/party/customers/{customerId}/jointCustomers","fullPath":"/api/v1.0.0/party/customers/{customerId}/jointCustomers","operationId":"getJointCustomerDetails","name":"Retrieves details such as joint relation code, name, joint customer details and reverse relationships for a specific customer","summary":"Retrieves joint customer details for a specific customer","tags":["RETAIL"],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"Identifier of the customer"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"","default":"","400":"","500":""}},{"method":"GET","path":"/party/customers/{customerId}/KYC","fullPath":"/api/v1.0.0/party/customers/{customerId}/KYC","operationId":"getCustomerKYCDetails","name":"Retrieves the KYC details such as contact date, introducer, last and next review date, KYC and AML status of a customer","summary":"Retrieves KYC details for a specific customer","tags":["RETAIL"],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"Identifier of the customer"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"","default":"","400":"","500":""}},{"method":"GET","path":"/party/customers/{customerId}/personalProfiles","fullPath":"/api/v1.0.0/party/customers/{customerId}/personalProfiles","operationId":"getCustomerPersonalDetails","name":"Retrieves personal details such as residence, communication details, occupation details, asset and liability information","summary":"Retrieves personal details of customer","tags":["RETAIL"],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"Identifier of the customer"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"","default":"","400":"","500":""}},{"method":"GET","path":"/party/customers/postingRestrictions","fullPath":"/api/v1.0.0/party/customers/postingRestrictions","operationId":"getCustomerPostingRestrictions","name":"Retrieves the credit and debit posting restriction details such as restriction reference and name of restriction set for a customer","summary":"Retrieves posting restriction details","tags":["RETAIL"],"parameters":[{"name":"customerId","in":"query","type":"string","required":false,"description":"Identifier of the customer"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"","default":"","400":"","500":""}},{"method":"PUT","path":"/party/relationships/{relationId}","fullPath":"/api/v1.0.0/party/relationships/{relationId}","operationId":"updatePartyRelationship","name":"Update party relationship between a person, entity or customer with details such as party name, relation type, related as, relation code and owning details","summary":"Update party relationship details","tags":["RETAIL"],"parameters":[{"name":"relationId","in":"path","type":"string","required":true,"description":"Identifier of the Customer Relationship and Party Relationship"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"","default":"","400":"","500":""}},{"method":"POST","path":"/party/relationships/{relationId}","fullPath":"/api/v1.0.0/party/relationships/{relationId}","operationId":"createPartyRelationship","name":"Create a party relationship between a person, entity or customer with details such as party name, relation type, related as, relation code and owning details","summary":"Create party relationship details","tags":["RETAIL"],"parameters":[{"name":"relationId","in":"path","type":"string","required":true,"description":"Identifier of the Customer Relationship and Party Relationship"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"","default":"","400":"","500":""}},{"method":"GET","path":"/party/customers/{customerId}/cards","fullPath":"/api/v1.0.0/party/customers/{customerId}/cards","operationId":"getCustomerCreditCards","name":"Retrieves the card details such as card number, card type and status, linked account and its balances of a customer","summary":"Retrieves card details of a customer","tags":["RETAIL"],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"Identifier of the customer"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"","default":"","400":"","500":""}},{"method":"GET","path":"/party/customers/{customerId}/standingOrders","fullPath":"/api/v1.0.0/party/customers/{customerId}/standingOrders","operationId":"getStandingOrders","name":"Retrieves the list of standing instructions for a customer with details such as instruction reference, order type, frequency of payments, mode of payment and credit & debit parties involved","summary":"Retrieves standing instruction details of a customer","tags":["RETAIL"],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"Identifier of the customer"},{"name":"standingOrderId","in":"query","type":"string","required":false,"description":"The unique standing order identifier"},{"name":"accountId","in":"query","type":"string","required":false,"description":"Identifier of the account. Often referred to as the account number, yet for consistency this is always referred to as accountId. Accepts both IBAN & BBAN"},{"name":"orderingCustomerId","in":"query","type":"string","required":false,"description":"Indicates the customer id for the ordering customer"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"","default":"","400":"","500":""}},{"method":"GET","path":"/party/customers/{customerId}/directDebits","fullPath":"/api/v1.0.0/party/customers/{customerId}/directDebits","operationId":"getDirectDebits","name":"Retrieves the list of direct debits for a customer with details such as direct debit reference, debit and credit accounts, transaction amount, payment frequency, next payment date and direction of payment","summary":"Retrieves direct debits details of a customer","tags":["RETAIL"],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"Identifier of the customer"},{"name":"directDebitId","in":"query","type":"string","required":false,"description":"The unique identifier of the direct debit mandate. "},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"","default":"","400":"","500":""}},{"method":"PUT","path":"/party/customers/deliveryPreferences/{deliveryPreferenceId}","fullPath":"/api/v1.0.0/party/customers/deliveryPreferences/{deliveryPreferenceId}","operationId":"updateDeliveryPreference","name":"Update customer delivery preferences with details such as message group, carrier, role, address, email details and format of messages","summary":"Update customer delivery preferences","tags":["RETAIL"],"parameters":[{"name":"deliveryPreferenceId","in":"path","type":"string","required":true,"description":"Identifier of the customer delivery preferences"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"","default":"","400":"","500":""}},{"method":"POST","path":"/party/customers/deliveryPreferences/{deliveryPreferenceId}","fullPath":"/api/v1.0.0/party/customers/deliveryPreferences/{deliveryPreferenceId}","operationId":"createDeliveryPreference","name":"Create customer delivery preferences with details such as message group, carrier, role, address, email details and format of messages","summary":"Create customer delivery preferences","tags":["RETAIL"],"parameters":[{"name":"deliveryPreferenceId","in":"path","type":"string","required":true,"description":"Identifier of the customer delivery preferences"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"","default":"","400":"","500":""}},{"method":"GET","path":"/party/customers/{customerId}/customerExitStatus","fullPath":"/api/v1.0.0/party/customers/{customerId}/customerExitStatus","operationId":"getCustomerExitStatus","name":"Retrieves customer exit status details such as customer type, exit date, status and reason","summary":"Retrieves customer exit status details of customer","tags":["RETAIL"],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"Identifier of the customer"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"","default":"","400":"","500":""}},{"method":"PUT","path":"/party/customers/{customerId}/customerExitStatus","fullPath":"/api/v1.0.0/party/customers/{customerId}/customerExitStatus","operationId":"updateCustomerExitStatus","name":"Update a customer with exit status and exit reason marking the customer as blocked or rejected or closed","summary":"Update customer exit status details of customers","tags":["RETAIL"],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"Identifier of the customer"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"","default":"","400":"","500":""}},{"method":"GET","path":"/party/customers/settings/customerExitStatus/{customerExitStatusId}","fullPath":"/api/v1.0.0/party/customers/settings/customerExitStatus/{customerExitStatusId}","operationId":"getCustomerExitStatusParam","name":"Retrieves available conditions such as customer exit setup reference, allowed reasons and allowed re-open details to update customer exit status of customers","summary":"Retrieves conditions to update customer exit status of customer","tags":["RETAIL"],"parameters":[{"name":"customerExitStatusId","in":"path","type":"string","required":true,"description":""},{"name":"customerType","in":"query","type":"string","required":false,"description":"Identifies the type of customers. Example Personal, Business, Corporate, etc."},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"","default":"","400":"","500":""}},{"method":"POST","path":"/party/customers/settings/customerExitStatus/{customerExitStatusId}","fullPath":"/api/v1.0.0/party/customers/settings/customerExitStatus/{customerExitStatusId}","operationId":"createCustomerExitStatusParam","name":"Create conditions such as applicable customer type and allowed reasons to update the customer exit status details of customers","summary":"Create conditions to update customer exit status of customer","tags":["RETAIL"],"parameters":[{"name":"customerExitStatusId","in":"path","type":"string","required":true,"description":"The field reflects the exit status ID of a customer or prospect from the parameterization table CUSTOMER.EXIT.STATUS"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"","default":"","400":"","500":""}},{"method":"PUT","path":"/party/customers/settings/{customerExitStatusId}/customerExitStatus","fullPath":"/api/v1.0.0/party/customers/settings/{customerExitStatusId}/customerExitStatus","operationId":"updateCustomerExitStatusParam","name":"Create conditions such as applicable customer type and allowed reasons to update the customer exit status details of customers","summary":"Create conditions to update customer exit status of customer","tags":["RETAIL"],"parameters":[{"name":"customerExitStatusId","in":"path","type":"string","required":true,"description":"The field reflects the exit status ID of a customer or prospect from the parameterization table CUSTOMER.EXIT.STATUS"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"","default":"","400":"","500":""}},{"method":"GET","path":"/party/customers/{customerId}/addresses","fullPath":"/api/v1.0.0/party/customers/{customerId}/addresses","operationId":"getCustomerAddressOutput","name":"Returns structured/unstructured address details of specified customer based on address option in request. When structured format is requested, the values are returned in format of structured data name combined with corresponding customer address value. When unstructured format is requested, the address details are returned based on configured unstructured address format.","summary":"Retrieves structured/ unstructured address format of customer","tags":["RETAIL"],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"Identifier of the customer"},{"name":"addressOption","in":"query","type":"string","required":false,"description":"It reflects the preference for the customer address format, respective structured, unstructured or both"},{"name":"addressOutputFormat","in":"query","type":"string","required":false,"description":"It identifies the address output format for the unstructured address"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"","default":"","400":"","500":""}},{"method":"GET","path":"/party/customers/{customerId}/shortNames","fullPath":"/api/v1.0.0/party/customers/{customerId}/shortNames","operationId":"getCustomerShortNames","name":"Retrieves customer short name that can be used as customer enrichment by any application","summary":"Retrieves customer short name","tags":["RETAIL"],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"","default":"","400":"","500":""}},{"method":"GET","path":"/party/customers/{customerId}/mandates","fullPath":"/api/v1.0.0/party/customers/{customerId}/mandates","operationId":"getCustomerMandates","name":"Retrieves the mandate instruction details such as application eligible for mandate process and the corresponding mandate rule that is being applied to check mandates for transactions involving the specified customer.","summary":"Retrieves mandate instruction applicable for the requested customer","tags":["RETAIL"],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"","default":"","400":"","500":""}},{"method":"GET","path":"/party/customers/{customerId}/documents","fullPath":"/api/v1.0.0/party/customers/{customerId}/documents","operationId":"getCustomerLegalDocuments","name":"Retrieves the details of legal document provided by the customer such as document name, document id, issue date, expiry date and authority who issued the document.","summary":"Retrieves the customer legal document details","tags":["RETAIL"],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"","default":"","400":"","500":""}},{"method":"GET","path":"/party/customers/{customerId}/profiles","fullPath":"/api/v1.0.0/party/customers/{customerId}/profiles","operationId":"getCustomerProfile","name":"Retrieves the customer basic details such as personal information, address location, basic contact details and other general information.","summary":"Retrieves profile details of the requested customer","tags":["RETAIL"],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"","default":"","400":"","500":""}},{"method":"GET","path":"/party/customers/alternateReferences/{alternateReference}","fullPath":"/api/v1.0.0/party/customers/alternateReferences/{alternateReference}","operationId":"getCustomerId","name":"Retrieves the customer identifier for the provided alternate reference of the customer","summary":"Retrieves customer id for the given alternate reference","tags":["RETAIL"],"parameters":[{"name":"alternateReference","in":"path","type":"string","required":true,"description":"If the new Account to be created is a shadow of another Account already exisitng in another system, then the Account reference of that system can be specified here. The value given in this field will "},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"","default":"","400":"","500":""}},{"method":"GET","path":"/party/customers/{customerId}/restrictions","fullPath":"/api/v1.0.0/party/customers/{customerId}/restrictions","operationId":"getCustomerRestrictions","name":"Retrieves the transaction restrictions imposed on the customer specified. Restrictions can be post no entries, black listed customer, pending KYC due reasons for restricting transactions on this customer","summary":"Retrieves the restriction details","tags":["RETAIL"],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"","default":"","400":"","500":""}},{"method":"GET","path":"/party/customers/{customerId}/contacts","fullPath":"/api/v1.0.0/party/customers/{customerId}/contacts","operationId":"getCustomerContacts","name":"Retrieves the contact details such as phone number, mobile numbers, fax and email address specific to the requested customer","summary":"Retrieves the customer contact details","tags":["RETAIL"],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"Identifier of the customer"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"","default":"","400":"","500":""}},{"method":"GET","path":"/party/customers/{customerId}/relationships","fullPath":"/api/v1.0.0/party/customers/{customerId}/relationships","operationId":"getCustomerRelationships","name":"Retrieves the relationship details such as related customer and the relationship that exists with the requested customer","summary":"Retrieves the relation customers","tags":["RETAIL"],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"","default":"","400":"","500":""}},{"method":"GET","path":"/party/customers/{customerId}/payments","fullPath":"/api/v1.0.0/party/customers/{customerId}/payments","operationId":"getPartyBasicDetails","name":"Retrieves the customer information that are required for processing or validating the customer involved in a payment transaction. Provides the information such as customer name details, birth details, address details,  market sector, target, nationality, residence country and preferred language for communication.","summary":"Retrieves customer details required for payment processing","tags":["RETAIL"],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"Identifier of the customer"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"","default":"","400":"","500":""}},{"method":"GET","path":"/party/customers/{customerId}/addresses/swiftAddresses/{addressId}","fullPath":"/api/v1.0.0/party/customers/{customerId}/addresses/swiftAddresses/{addressId}","operationId":"getCustomerSwiftAddress","name":"Retrieves the SWIFT address details such as delivery address, short name and tag25 indicator for the customer.","summary":"Retrieves the SWIFT address details for the customer.","tags":["RETAIL"],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"Identifier of the customer"},{"name":"addressId","in":"path","type":"string","required":true,"description":"Reference Id of address record"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"","default":"","400":"","500":""}},{"method":"GET","path":"/party/customers/{customerId}/charges","fullPath":"/api/v1.0.0/party/customers/{customerId}/charges","operationId":"getCustomerCharge","name":"Retrieves customer charge for a customer with details such as tax type and tax group.","summary":"Retrieves customer charge for a specific customer.","tags":["RETAIL"],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"Identifier of the customer"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"","default":"","400":"","500":""}},{"method":"PUT","path":"/party/customers/{customerId}/charges","fullPath":"/api/v1.0.0/party/customers/{customerId}/charges","operationId":"updateCustomerCharge","name":"Updates customer charge for a customer with details such as tax type and tax group.","summary":"Updates customer charge for a specific customer.","tags":["RETAIL"],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"Identifier of the customer"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"","default":"","400":"","500":""}},{"method":"POST","path":"/party/customers/{customerId}/charges","fullPath":"/api/v1.0.0/party/customers/{customerId}/charges","operationId":"createCustomerCharge","name":"Creates customer charge for a customer with details such as tax type and tax group.","summary":"Creates customer charge for a specific customer.","tags":["RETAIL"],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"Identifier of the customer"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"","default":"","400":"","500":""}},{"method":"GET","path":"/party/customers/{customerId}/addresses/smsAddresses","fullPath":"/api/v1.0.0/party/customers/{customerId}/addresses/smsAddresses","operationId":"getCustomerPhoneAddress","name":"Retrieves the list of customer sms communication address with details such as name, idd prefix and mobile number.","summary":"Retrieves available list of customer sms communication addresses","tags":["RETAIL"],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"Identifier of the customer"},{"name":"addressId","in":"query","type":"string","required":false,"description":"Reference Id of address record"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"","default":"","400":"","500":""}},{"method":"POST","path":"/party/customers/{customerId}/addresses/smsAddresses","fullPath":"/api/v1.0.0/party/customers/{customerId}/addresses/smsAddresses","operationId":"createCustomerPhoneAddress","name":"Create customer sms communication address with details such as name, idd prefix and mobile number.","summary":"Creates customer sms communication address","tags":["RETAIL"],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"Identifier of the customer"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"","default":"","400":"","500":""}},{"method":"GET","path":"/party/customers/{customerId}/addresses/emailAddresses","fullPath":"/api/v1.0.0/party/customers/{customerId}/addresses/emailAddresses","operationId":"getCustomerEmailAddress","name":"Retrieves the list of customer email communication address with details such as customer name and email references.","summary":"Retrieves available list of customer email communication addresses","tags":["RETAIL"],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"Identifier of the customer"},{"name":"addressId","in":"query","type":"string","required":false,"description":"Reference Id of address record"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"","default":"","400":"","500":""}},{"method":"POST","path":"/party/customers/{customerId}/addresses/emailAddresses","fullPath":"/api/v1.0.0/party/customers/{customerId}/addresses/emailAddresses","operationId":"createCustomerEmailAddress","name":"Create customer email communication address with details such as customer name and email references.","summary":"Creates customer email communication address","tags":["RETAIL"],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"Identifier of the customer"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"","default":"","400":"","500":""}},{"method":"GET","path":"/party/customers/{customerId}/addresses/printAddresses","fullPath":"/api/v1.0.0/party/customers/{customerId}/addresses/printAddresses","operationId":"getCustomerPrintAddress","name":"Retrieves the list of customer print communication addresses with details such as name, address, postcode and phone number.","summary":"Retrieves available list of customer print communication addresses","tags":["RETAIL"],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"Identifier of the customer"},{"name":"addressId","in":"query","type":"string","required":false,"description":"Reference Id of address record"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"","default":"","400":"","500":""}},{"method":"POST","path":"/party/customers/{customerId}/addresses/printAddresses","fullPath":"/api/v1.0.0/party/customers/{customerId}/addresses/printAddresses","operationId":"createCustomerPrintAddress","name":"Create customer print communication address with details such as name, address, postcode and phone number.","summary":"Creates customer print communication address","tags":["RETAIL"],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"Identifier of the customer"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"","default":"","400":"","500":""}},{"method":"PUT","path":"/party/customers/addresses/{customerAddressId}/smsAddresses","fullPath":"/api/v1.0.0/party/customers/addresses/{customerAddressId}/smsAddresses","operationId":"updateCustomerPhoneAddress","name":"Update customer sms communication address with details such as name, idd prefix and mobile number.","summary":"Updates customer sms communication address","tags":["RETAIL"],"parameters":[{"name":"customerAddressId","in":"path","type":"string","required":true,"description":"Identifier of the customer address table."},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"","default":"","400":"","500":""}},{"method":"DELETE","path":"/party/customers/addresses/{customerAddressId}/smsAddresses","fullPath":"/api/v1.0.0/party/customers/addresses/{customerAddressId}/smsAddresses","operationId":"deleteCustomerPhoneAddress","name":"Delete the specified customer sms communication address that are no longer used.","summary":"Deletes customer sms communication address","tags":["RETAIL"],"parameters":[{"name":"customerAddressId","in":"path","type":"string","required":true,"description":"Identifier of the customer address table."},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"","default":"","400":"","500":""}},{"method":"PUT","path":"/party/customers/addresses/{customerAddressId}/emailAddresses","fullPath":"/api/v1.0.0/party/customers/addresses/{customerAddressId}/emailAddresses","operationId":"updateCustomerEmailAddress","name":"Update customer email communication address with details such as customer name and email references.","summary":"Updates customer email communication address","tags":["RETAIL"],"parameters":[{"name":"customerAddressId","in":"path","type":"string","required":true,"description":"Identifier of the customer address table."},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"","default":"","400":"","500":""}},{"method":"DELETE","path":"/party/customers/addresses/{customerAddressId}/emailAddresses","fullPath":"/api/v1.0.0/party/customers/addresses/{customerAddressId}/emailAddresses","operationId":"deleteCustomerEmailAddress","name":"Delete the specified customer email communication address that are no longer used.","summary":"Deletes customer email communication address","tags":["RETAIL"],"parameters":[{"name":"customerAddressId","in":"path","type":"string","required":true,"description":"Identifier of the customer address table."},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"","default":"","400":"","500":""}},{"method":"PUT","path":"/party/customers/addresses/{customerAddressId}/printAddresses","fullPath":"/api/v1.0.0/party/customers/addresses/{customerAddressId}/printAddresses","operationId":"updateCustomerPrintAddress","name":"Update customer print communication address with details such as name, address, postcode and phone number.","summary":"Updates customer print communication address","tags":["RETAIL"],"parameters":[{"name":"customerAddressId","in":"path","type":"string","required":true,"description":"Identifier of the customer address table."},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"","default":"","400":"","500":""}},{"method":"DELETE","path":"/party/customers/addresses/{customerAddressId}/printAddresses","fullPath":"/api/v1.0.0/party/customers/addresses/{customerAddressId}/printAddresses","operationId":"deleteCustomerPrintAddress","name":"Delete the specified customer print communication address that are no longer used.","summary":"Deletes customer print communication address","tags":["RETAIL"],"parameters":[{"name":"customerAddressId","in":"path","type":"string","required":true,"description":"Identifier of the customer address table."},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"","default":"","400":"","500":""}},{"method":"GET","path":"/party/customers/{customerId}/consents","fullPath":"/api/v1.0.0/party/customers/{customerId}/consents","operationId":"getCustomerConsents","name":"Retrieves the list of consent details for specific customer","summary":"Retrieves customer consents details","tags":["RETAIL"],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"Identifier of the customer"},{"name":"propertyClassId","in":"query","type":"string","required":false,"description":"The identifier of a condition that is used to build a product"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"","default":"","400":"","500":""}},{"method":"PUT","path":"/party/customers/{customerId}/fatca","fullPath":"/api/v1.0.0/party/customers/{customerId}/fatca","operationId":"updateFatcaCustomer","name":"Update the FATCA customer supplementary information that stores the related FATCA details for the customer","summary":"Update FATCA customer supplementary information details","tags":["RETAIL"],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"Identifier of the customer"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"","default":"","400":"","500":""}},{"method":"POST","path":"/party/customers/{customerId}/fatca","fullPath":"/api/v1.0.0/party/customers/{customerId}/fatca","operationId":"createFatcaCustomer","name":"Creates the FATCA customer supplementary information that stores the related FATCA details for the customer","summary":"Create FATCA customer supplementary information details","tags":["RETAIL"],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"Identifier of the customer"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"","default":"","400":"","500":""}},{"method":"GET","path":"/party/customers/{customerId}/portfolios/{portfolioId}/overdueSettlements","fullPath":"/api/v1.0.0/party/customers/{customerId}/portfolios/{portfolioId}/overdueSettlements","operationId":"getOverdueSettlements","name":"Retrieves overdue settlements of customer or portfolio with details such as transaction reference, instrument reference , instrument name, depository and broker involved, trade date, trade currency, trade quantity, current customer and broker outstandings","summary":"Retrieves overdue settlements of customer or portfolio","tags":["RETAIL"],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"Identifier of the customer"},{"name":"portfolioId","in":"path","type":"string","required":true,"description":"Id of the portfolio or security account"},{"name":"transactionId","in":"query","type":"string","required":false,"description":"Unique transaction identifier for retrieving the details of the transaction. For example: FT0102030333 etc."},{"name":"brokerId","in":"query","type":"string","required":false,"description":"The identifier of the broker"},{"name":"tradeDate","in":"query","type":"string","required":false,"description":"Standard date field which records trade date of the account"},{"name":"valueDate","in":"query","type":"string","required":false,"description":"Indicates the value date on which the underlying accounting entry is to be given value (for interest purposes)"},{"name":"depository","in":"query","type":"string","required":false,"description":"Person designated as depository by the company in or pursuant to this Indenture, and, unless otherwise provided with respect to any security, any successor to such person"},{"name":"currency","in":"query","type":"string","required":false,"description":"Identifies the currency. E.g. USD, GBP etc"},{"name":"instrumentId","in":"query","type":"string","required":false,"description":"The identifier of the instrument"},{"name":"deliveryInstruction","in":"query","type":"string","required":false,"description":"Customer's directions to a bank as to the disposition of funds and securities in the customer's account"},{"name":"transactionType","in":"query","type":"string","required":false,"description":"Identifies the transaction type applicable to the transaction being processed, i.e. outward or inward payment. For example: ACPX, OTPX etc."},{"name":"quantity","in":"query","type":"string","required":false,"description":"The nominal quantity"},{"name":"stockExchange","in":"query","type":"string","required":false,"description":"Contains the stock exchange details where a particular security is usually dealt"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"","default":"","400":"","500":""}},{"method":"GET","path":"/party/customers/accountServicingProviders","fullPath":"/api/v1.0.0/party/customers/accountServicingProviders","operationId":"getOtherBanksToConnectTo","name":"Retrieves the third party providers that are allowed to interact with the bank or entity with details such as global unique reference number, provider country,provider name and national competent authority register code","summary":"Retrieves details of third party providers","tags":["RETAIL"],"parameters":[{"name":"openBankingId","in":"query","type":"string","required":false,"description":"Identifies the open banking number of the customer"},{"name":"countryId","in":"query","type":"string","required":false,"description":"ISO country code of the financial institution. "},{"name":"setActive","in":"query","type":"string","required":false,"description":"Flag to set the connection status to active"},{"name":"status","in":"query","type":"string","required":false,"description":"Contains status of the data rights request.Allowed values are INITIATED, INPROGESS, EXTENDED, COMPLETED, REJECTED."},{"name":"extSourceProvider","in":"query","type":"string","required":false,"description":"Contains the name of the external source provider for the customer"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"","default":"","400":"","500":""}},{"method":"GET","path":"/party/customers/prospects","fullPath":"/api/v1.0.0/party/customers/prospects","operationId":"getProspectCustomers","name":"Retrieves the list of prospect customers with details such as contact information, residence details, personal details and prospect legal details","summary":"Retrieves prospect details of customers","tags":["RETAIL"],"parameters":[{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"","default":"","400":"","500":""}},{"method":"POST","path":"/party/customers/prospects","fullPath":"/api/v1.0.0/party/customers/prospects","operationId":"createProspectCustomer","name":"Create a prospect customer with basic details such as contact information, residence details and prospect legal details","summary":"Create a prospect customer","tags":["RETAIL"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"","default":"","400":"","500":""}},{"method":"GET","path":"/party/customers/{customerId}/opportunities","fullPath":"/api/v1.0.0/party/customers/{customerId}/opportunities","operationId":"getCustomerOpportunities","name":"Retrieves the details of sales opportunities such as score, status and product details which are likely to be of interest to specific customers","summary":"Retrieves the sales opportunities for specific customers","tags":["RETAIL"],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"Identifier of the customer"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"","default":"","400":"","500":""}},{"method":"GET","path":"/party/customers/{customerId}/requests","fullPath":"/api/v1.0.0/party/customers/{customerId}/requests","operationId":"getCustomerRequests","name":"Retrieves process workflow details such as process name, activity details and status for a specific customer","summary":"Retrieves process workflows for a specific customer","tags":["RETAIL"],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"Identifier of the customer"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"","default":"","400":"","500":""}},{"method":"PUT","path":"/party/customers/prospects/{prospectId}","fullPath":"/api/v1.0.0/party/customers/prospects/{prospectId}","operationId":"updateProspectCustomer","name":"Update a prospect customer with basic details such as contact information, residence details and prospect legal details","summary":"Update a prospect customer","tags":["RETAIL"],"parameters":[{"name":"prospectId","in":"path","type":"string","required":true,"description":"Indicates the status of an onboarding customer. Status can be PROSPECT while onboarding and ACTIVE when the prospect becomes a Customer."},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"","default":"","400":"","500":""}},{"method":"GET","path":"/party/customers/{customerId}/alertRequests","fullPath":"/api/v1.0.0/party/customers/{customerId}/alertRequests","operationId":"getAlertRequests","name":"Retrieves the alert subscription details such as alert reference, alert name and condition for alerts of a customer","summary":"Retrieves alert requests details","tags":["RETAIL"],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"Identifier of the customer"},{"name":"contractReference","in":"query","type":"string","required":false,"description":"Contains the contract reference"},{"name":"subscribe","in":"query","type":"string","required":false,"description":"Enables an alert service"},{"name":"alertRequestId","in":"query","type":"string","required":false,"description":"The unique identifier of the alert request."},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"","default":"","400":"","500":""}},{"method":"GET","path":"/party/relationships/{partyId}/relations","fullPath":"/api/v1.0.0/party/relationships/{partyId}/relations","operationId":"getPartyRelationship","name":"Retrieves the relationship details such as party name, type, relation code, status and owning percentage of customers involved in a relationship","summary":"Retrieves list of party relationship details","tags":["RETAIL"],"parameters":[{"name":"partyId","in":"path","type":"string","required":true,"description":"Allows capturing of customers or person entities to be part of the relationship. If partyType is selected as Customer, then the system will allow only customer Ids to be captured into this field. If p"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"","default":"","400":"","500":""}},{"method":"POST","path":"/party/customers/staticDataUpdateEvents","fullPath":"/api/v1.0.0/party/customers/staticDataUpdateEvents","operationId":"createCustomerStaticChange","name":"Create data log with details such as event name, event creation date and time for customer that has undergone static data updates from external party systems","summary":"Create log of customer static data update event from external party systems","tags":["RETAIL"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"","default":"","400":"","500":""}},{"method":"GET","path":"/party/customers/bankCodes/BICs/{bicId}/owners","fullPath":"/api/v1.0.0/party/customers/bankCodes/BICs/{bicId}/owners","operationId":"getBicOwners","name":"Returns the owner of the BIC and the channel through which this BIC is used. If a company code is returned without a customer ID this indicates the entity of the current financial institution. If a company code is returned along with a customer number, this indicates the customer identified by the respective BIC and the entity of the current financial institution that maintains the main relationship with the customer. The address type returned represent the context in which the BIC can be used.","summary":"Returns the owner of the BIC and the channel through which this BIC is used.","tags":["RETAIL"],"parameters":[{"name":"bicId","in":"path","type":"string","required":true,"description":"Bank Identifier Code (BIC) of the financial institution"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"","default":"","400":"","500":""}},{"method":"PUT","path":"/party/customers/groupPurposes/{groupPurposeId}","fullPath":"/api/v1.0.0/party/customers/groupPurposes/{groupPurposeId}","operationId":"updateCustomerGroupPurpose","name":"Allows amendment of customer group purpose with details such as group purpose, type of group relationships - individual or group, allowed list of individual, aggregate and group relationships","summary":"Allows amendment of customer group purpose","tags":["RETAIL"],"parameters":[{"name":"groupPurposeId","in":"path","type":"string","required":true,"description":"Identifier of customer group purpose"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"","default":"","400":"","500":""}},{"method":"POST","path":"/party/customers/groupPurposes/{groupPurposeId}","fullPath":"/api/v1.0.0/party/customers/groupPurposes/{groupPurposeId}","operationId":"createCustomerGroupPurpose","name":"Allows creation of customer group purpose with details such as group purpose, type of group relationships - individual or group, allowed list of individual, aggregate and group relationships.","summary":"Allows creation of customer group purpose.","tags":["RETAIL"],"parameters":[{"name":"groupPurposeId","in":"path","type":"string","required":true,"description":"Identifier of customer group purpose"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"","default":"","400":"","500":""}},{"method":"DELETE","path":"/party/customers/groupPurposes/{groupPurposeId}","fullPath":"/api/v1.0.0/party/customers/groupPurposes/{groupPurposeId}","operationId":"deleteCustomerGroupPurpose","name":"Allows deletion of unapproved customer group purpose that is no longer required","summary":"Allows deletion of unapproved customer group purpose","tags":["RETAIL"],"parameters":[{"name":"groupPurposeId","in":"path","type":"string","required":true,"description":"Identifier of customer group purpose"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"","default":"","400":"","500":""}},{"method":"PUT","path":"/party/customers/groupPurposes/{groupPurposeId}/approvals","fullPath":"/api/v1.0.0/party/customers/groupPurposes/{groupPurposeId}/approvals","operationId":"approveCustomerGroupPurpose","name":"Allows authorization of customer group purpose with modified details such as type of group relationships - individual or group, allowed list of individual, aggregate and group relationships","summary":"Allows authorization of customer group purpose","tags":["RETAIL"],"parameters":[{"name":"groupPurposeId","in":"path","type":"string","required":true,"description":"Identifier of customer group purpose"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"","default":"","400":"","500":""}},{"method":"DELETE","path":"/party/customers/groupPurposes/{groupPurposeId}/cancellations","fullPath":"/api/v1.0.0/party/customers/groupPurposes/{groupPurposeId}/cancellations","operationId":"cancelCustomerGroupPurpose","name":"Allows cancellations of approved customer group purpose that is no longer required","summary":"Allows cancellation of customer group purpose","tags":["RETAIL"],"parameters":[{"name":"groupPurposeId","in":"path","type":"string","required":true,"description":"Identifier of customer group purpose"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"","default":"","400":"","500":""}},{"method":"PUT","path":"/party/customers/groups/{groupId}","fullPath":"/api/v1.0.0/party/customers/groups/{groupId}","operationId":"updateCustomerGroup","name":"Allows amendment of customer group with details such as group name, purpose, group type, company reference, account officer, closure date, customer and their relationships that can be either individual or group, liability customer and the ownership percentage of each customers in the group","summary":"Allows amendment of customer group","tags":["RETAIL"],"parameters":[{"name":"groupId","in":"path","type":"string","required":true,"description":"Unique ID of the group"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"","default":"","400":"","500":""}},{"method":"POST","path":"/party/customers/groups/{groupId}","fullPath":"/api/v1.0.0/party/customers/groups/{groupId}","operationId":"createCustomerGroup","name":"Allows creation of customer group with details such as group name, purpose, group type, company reference, account officer, closure date, customer and their relationships that can be either individual or group, liability customer and the ownership percentage of each customers in the group","summary":"Allows creation of customer group","tags":["RETAIL"],"parameters":[{"name":"groupId","in":"path","type":"string","required":true,"description":"Unique ID of the group"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"","default":"","400":"","500":""}},{"method":"DELETE","path":"/party/customers/groups/{groupId}","fullPath":"/api/v1.0.0/party/customers/groups/{groupId}","operationId":"deleteCustomerGroup","name":"Allows deletion of unapproved customer group that is no longer required","summary":"Allows deletion of unapproved customer group","tags":["RETAIL"],"parameters":[{"name":"groupId","in":"path","type":"string","required":true,"description":"Unique ID of the group"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"","default":"","400":"","500":""}},{"method":"PUT","path":"/party/customers/groups/{groupId}/approvals","fullPath":"/api/v1.0.0/party/customers/groups/{groupId}/approvals","operationId":"approveCustomerGroup","name":"Allows authorization of customer group with details such as group name, purpose, group type, company reference, account officer, closure date, customer and their relationships that can be either individual or group, liability customer and the ownership percentage of each customers in the group","summary":"Allows authorization of customer group","tags":["RETAIL"],"parameters":[{"name":"groupId","in":"path","type":"string","required":true,"description":"Unique ID of the group"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"","default":"","400":"","500":""}},{"method":"GET","path":"/party/customers/groupPurposes/pendingApprovals","fullPath":"/api/v1.0.0/party/customers/groupPurposes/pendingApprovals","operationId":"getUnapprovedCustomerGroupPurpose","name":"Retrieves the list of unapproved customer group purposes with details such as group purpose, type of group relationships - individual or group, allowed list of individual, aggregate and group relationships","summary":"Retrieves the list of unapproved customer group purposes","tags":["RETAIL"],"parameters":[{"name":"groupPurposeId","in":"query","type":"string","required":false,"description":"Identifier of customer group purpose"},{"name":"groupPurpose","in":"query","type":"string","required":false,"description":"Indicates the type of customer group. Allowed values are RISK ,LIABILITY or Blank."},{"name":"groupLevelUniqueCustomer","in":"query","type":"string","required":false,"description":"Indicates whether customers in a group are to be restricted from being defined in another customer group with same group purpose. YES - will restrict the customer from being defined in another group, "},{"name":"allowGroupRelationship","in":"query","type":"string","required":false,"description":"Indicates whether group relations have to be defaulted in customer group from party relationship. Allowed values are YES, NO or Blank."},{"name":"allowRelationship","in":"query","type":"string","required":false,"description":"Indicates whether customer relations have to be defaulted in customer group from party relationship. Allowed values are YES, NO or Blank."},{"name":"subGroupLevelUniqueCustomer","in":"query","type":"string","required":false,"description":"Indicates whether a customer is allowed to be part of multiple sub groups. Allowed values are UNIQUE, MULTIPLE, NONE or Blank."},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"","default":"","400":"","500":""}},{"method":"GET","path":"/party/customers/groupPurposes","fullPath":"/api/v1.0.0/party/customers/groupPurposes","operationId":"getCustomerGroupPurpose","name":"Retrieves the list of customer group purposes with details such as group purpose, type of group relationships - individual or group, allowed list of individual, aggregate and group relationships","summary":"Retrieves the list of customer group purposes","tags":["RETAIL"],"parameters":[{"name":"groupPurposeId","in":"query","type":"string","required":false,"description":"Identifier of customer group purpose"},{"name":"groupPurpose","in":"query","type":"string","required":false,"description":"Indicates the type of customer group. Allowed values are RISK ,LIABILITY or Blank."},{"name":"groupLevelUniqueCustomer","in":"query","type":"string","required":false,"description":"Indicates whether customers in a group are to be restricted from being defined in another customer group with same group purpose. YES - will restrict the customer from being defined in another group, "},{"name":"allowGroupRelationship","in":"query","type":"string","required":false,"description":"Indicates whether group relations have to be defaulted in customer group from party relationship. Allowed values are YES, NO or Blank."},{"name":"allowRelationship","in":"query","type":"string","required":false,"description":"Indicates whether customer relations have to be defaulted in customer group from party relationship. Allowed values are YES, NO or Blank."},{"name":"subGroupLevelUniqueCustomer","in":"query","type":"string","required":false,"description":"Indicates whether a customer is allowed to be part of multiple sub groups. Allowed values are UNIQUE, MULTIPLE, NONE or Blank."},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"","default":"","400":"","500":""}},{"method":"GET","path":"/party/customers/groups/pendingApprovals","fullPath":"/api/v1.0.0/party/customers/groups/pendingApprovals","operationId":"getUnapprovedCustomerGroup","name":"Retrieves the list of unapproved customer group with details such as group name, purpose, group type, company reference, account officer, closure date, customer and their relationships that can be either individual or group, liability customer and the ownership percentage of each customers in the group","summary":"Retrieves the list of unapproved customer groups","tags":["RETAIL"],"parameters":[{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"","default":"","400":"","500":""}},{"method":"GET","path":"/party/customers/groups","fullPath":"/api/v1.0.0/party/customers/groups","operationId":"getCustomerGroups","name":"Retrieves list of customer groups or specified customer group with details such as group name, purpose, group type, company reference, account officer, closure date, customer and their relationships that can be either individual or group, liability customer and the ownership percentage of each customers in the group","summary":"Retrieves the details of customer group","tags":["RETAIL"],"parameters":[{"name":"groupId","in":"query","type":"string","required":false,"description":"Unique ID of the group"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"","default":"","400":"","500":""}}]},{"key":"party-customerServices-v5.5.0","title":"Customer management","version":"v5.5.0","description":"API to create, update and manage customer details such as delivery preferences, joint customer details, party relationships, KYC details, alert subscriptions, customer exit status, customer address formats & posting restrictions","endpointCount":84,"endpoints":[{"method":"GET","path":"/party/customers/{customerId}","fullPath":"/api/v5.5.0/party/customers/{customerId}","operationId":"getCustomer","name":"Retrieves the customer details such as customer contact information, residence details, legal document details, occupation details and relationship details for the specific customer","summary":"Retrieves customer details","tags":["RETAIL"],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"Identifier of the customer"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"CustomerResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"POST","path":"/party/customers/{customerId}","fullPath":"/api/v5.5.0/party/customers/{customerId}","operationId":"createCustomerWithId","name":"Create a customer with the information such as customer contact information, residence details, legal document details, occupation details and relationship details, etc provided by the user. It allows to create a customer with the provided id.","summary":"Create a customer by providing an Id","tags":["RETAIL"],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"Identifier of the customer"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"displayNames":[{}],"customerNames":[{}],"communicationDevices":[{}],"faxIds":[{}],"officePhoneNumbers":[{}],"streets":[{}],"addresses":[{}],"addressCities":[{}],"countries":[{}],"legalDetails":[{}],"otherNationalityIds":[{}],"employDetails":[{}],"residenceDetails":[{}],"relationshipDetails":[{}],"postingRestrictIds":[{}]}},"responses":{"200":"CustomerWithIdResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/party/customers/{customerId}","fullPath":"/api/v5.5.0/party/customers/{customerId}","operationId":"updateCustomer","name":"Update customer details with the information such as customer contact information, residence details, legal document details, occupation details and relationship details, etc provided by the user","summary":"Update customer details","tags":["RETAIL"],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"Identifier of the customer"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"displayNames":[{}],"customerNames":[{}],"communicationDevices":[{}],"faxIds":[{}],"officePhoneNumbers":[{}],"streets":[{}],"addresses":[{}],"addressCities":[{}],"countries":[{}],"legalDetails":[{}],"otherNationalityIds":[{}],"employDetails":[{}],"residenceDetails":[{}],"relationshipDetails":[{}],"postingRestrictIds":[{}]}},"responses":{"200":"CustomerResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/party/customers","fullPath":"/api/v5.5.0/party/customers","operationId":"getCustomerInformation","name":"Retrieves the customer details such as delivery or postal details, contact information, residence details, customer profile, legal document details, occupation details and status of customer","summary":"Retrieves list of customer basic details","tags":["RETAIL"],"parameters":[{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"CustomerInformationResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"POST","path":"/party/customers","fullPath":"/api/v5.5.0/party/customers","operationId":"createCustomer","name":"Create a customer with the information such as customer contact information, residence details, legal document details, occupation details and relationship details, etc provided by the user. It allows to create a customer with system generated id.","summary":"Create a customer","tags":["RETAIL"],"parameters":[{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"displayNames":[{}],"customerNames":[{}],"communicationDevices":[{}],"faxIds":[{}],"officePhoneNumbers":[{}],"streets":[{}],"addresses":[{}],"addressCities":[{}],"countries":[{}],"legalDetails":[{}],"otherNationalityIds":[{}],"employDetails":[{}],"residenceDetails":[{}],"relationshipDetails":[{}],"postingRestrictIds":[{}]}},"responses":{"200":"CustomerResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/party/customers/relationships","fullPath":"/api/v5.5.0/party/customers/relationships","operationId":"getCustomerRelationship","name":"Retrieves customer relationship details such as type of relationship, party information, related as, owning details, role & purpose of relationship for specific party or customer","summary":"Retrieves list of customer relationships","tags":["RETAIL"],"parameters":[{"name":"customerRelationGroupId","in":"query","type":"string","required":false,"description":"Identifies the key to Customer Relationship Group to form a relation"},{"name":"partyId","in":"query","type":"string","required":false,"description":"Allows capturing of customers or person entities to be part of the relationship. If partyType is selected as Customer, then the system will allow only customer Ids to be captured into this field. If p"},{"name":"relatedPartyId","in":"query","type":"string","required":false,"description":"Identifier of the Related Party"},{"name":"relationId","in":"query","type":"string","required":false,"description":"Identifier of the Customer Relationship and Party Relationship"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"CustomerRelationshipResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"POST","path":"/party/customers/relationships","fullPath":"/api/v5.5.0/party/customers/relationships","operationId":"createCustomerRelationship","name":"Create a customer relationship for a customer with details such as type of relationship, party information, related as, owning details, role & purpose of relationship","summary":"Create customer relationship with other customers","tags":["RETAIL"],"parameters":[{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"originatingRelation":[{}],"customerRelationGroupId":0.0,"customerRelationGroupName":"string","purposeOfRelationship":"string","extensions":{}}},"responses":{"200":"CustomerRelationshipResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/party/customers/relationships/{relationId}","fullPath":"/api/v5.5.0/party/customers/relationships/{relationId}","operationId":"updateCustomerRelationship","name":"Update customer relationship for a customer with details such as type of relationship, party information, related as, owning details, role & purpose of relationship","summary":"Update customer relationship","tags":["RETAIL"],"parameters":[{"name":"relationId","in":"path","type":"string","required":true,"description":"Identifier of the Customer Relationship and Party Relationship"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"originatingRelation":[{}],"customerRelationGroupId":0.0,"customerRelationGroupName":"string","purposeOfRelationship":"string","extensions":{}}},"responses":{"200":"CustomerRelationshipResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/party/customers/reportingStatus","fullPath":"/api/v5.5.0/party/customers/reportingStatus","operationId":"getCustomerReportingStatus","name":"Retrieves the FATCA/CRS reporting status and reporting jurisdiction of the customer","summary":"Retrieves reporting status of the customer","tags":["RETAIL"],"parameters":[{"name":"customerId","in":"query","type":"string","required":true,"description":"Identifier of the customer"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"CustomerReportingStatusResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/party/customers/{customerId}/sweeps","fullPath":"/api/v5.5.0/party/customers/{customerId}/sweeps","operationId":"getCustomerSweeps","name":"Retrieves account sweep details such as sweep reference, type, balance requirements for sweep and frequency of sweep for the list of accounts available to a customer","summary":"Retrieves account sweep details of the specific customer","tags":["RETAIL"],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"Identifier of the customer"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"CustomerSweepsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/party/customers/{customerId}/deliveryOptions","fullPath":"/api/v5.5.0/party/customers/{customerId}/deliveryOptions","operationId":"getCustomerDeliveryOptions","name":"Retrieves the delivery preferences of the customer such as the message group, carrier and address.","summary":"Retrieves delivery preferences of the customer","tags":["RETAIL"],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"Identifier of the customer"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"CustomerDeliveryOptionsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/party/customers/{customerId}/channels","fullPath":"/api/v5.5.0/party/customers/{customerId}/channels","operationId":"getCustomerDigitalChannels","name":"Retrieves the list of message channels such as internet banking, mobile banking, ATM, etc available for the specific customer","summary":"Retrieves list of message channels","tags":["RETAIL"],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"Identifier of the customer"},{"name":"channelName","in":"query","type":"string","required":false,"description":"Name of the (digital) channel registered by the Customer"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"CustomerDigitalChannelsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"POST","path":"/party/customers/messages","fullPath":"/api/v5.5.0/party/customers/messages","operationId":"createMessages","name":"Create a new secure message for a customer to be sent by bank","summary":"Create a new secure message for a customer","tags":["RETAIL"],"parameters":[{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"messages":[{}],"subject":"string","toCustomerId":"string","extensions":{}}},"responses":{"200":"MessagesResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/party/customers/{customerId}/jointCustomers","fullPath":"/api/v5.5.0/party/customers/{customerId}/jointCustomers","operationId":"getJointCustomerDetails","name":"Retrieves details such as joint relation code, name, joint customer details and reverse relationships for a specific customer","summary":"Retrieves joint customer details for a specific customer","tags":["RETAIL"],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"Identifier of the customer"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"JointCustomerDetailsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/party/customers/{customerId}/KYC","fullPath":"/api/v5.5.0/party/customers/{customerId}/KYC","operationId":"getCustomerKYCDetails","name":"Retrieves the KYC details such as contact date, introducer, last and next review date, KYC and AML status of a customer","summary":"Retrieves KYC details for a specific customer","tags":["RETAIL"],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"Identifier of the customer"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"CustomerKYCDetailsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/party/customers/{customerId}/personalProfiles","fullPath":"/api/v5.5.0/party/customers/{customerId}/personalProfiles","operationId":"getCustomerPersonalDetails","name":"Retrieves personal details such as residence, communication details, occupation details, asset and liability information","summary":"Retrieves personal details of customer","tags":["RETAIL"],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"Identifier of the customer"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"CustomerPersonalDetailsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/party/customers/postingRestrictions","fullPath":"/api/v5.5.0/party/customers/postingRestrictions","operationId":"getCustomerPostingRestrictions","name":"Retrieves the credit and debit posting restriction details such as restriction reference and name of restriction set for a customer","summary":"Retrieves posting restriction details","tags":["RETAIL"],"parameters":[{"name":"customerId","in":"query","type":"string","required":false,"description":"Identifier of the customer"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"CustomerPostingRestrictionsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"POST","path":"/party/relationships/{relationId}","fullPath":"/api/v5.5.0/party/relationships/{relationId}","operationId":"createPartyRelationship","name":"Create a party relationship between a person, entity or customer with details such as party name, relation type, related as, relation code and owning details","summary":"Create party relationship details","tags":["RETAIL"],"parameters":[{"name":"relationId","in":"path","type":"string","required":true,"description":"Identifier of the Customer Relationship and Party Relationship"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"partyDisplayNames":[{}],"partyRelationships":[{}],"extensions":{}}},"responses":{"200":"PartyRelationshipResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/party/relationships/{relationId}","fullPath":"/api/v5.5.0/party/relationships/{relationId}","operationId":"updatePartyRelationship","name":"Update party relationship between a person, entity or customer with details such as party name, relation type, related as, relation code and owning details","summary":"Update party relationship details","tags":["RETAIL"],"parameters":[{"name":"relationId","in":"path","type":"string","required":true,"description":"Identifier of the Customer Relationship and Party Relationship"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"partyDisplayNames":[{}],"partyRelationships":[{}],"extensions":{}}},"responses":{"200":"PartyRelationshipResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/party/customers/{customerId}/cards","fullPath":"/api/v5.5.0/party/customers/{customerId}/cards","operationId":"getCustomerCreditCards","name":"Retrieves the card details such as card number, card type and status, linked account and its balances of a customer","summary":"Retrieves card details of a customer","tags":["RETAIL"],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"Identifier of the customer"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"CustomerCreditCardsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/party/customers/{customerId}/standingOrders","fullPath":"/api/v5.5.0/party/customers/{customerId}/standingOrders","operationId":"getStandingOrders","name":"Retrieves the list of standing instructions for a customer with details such as instruction reference, order type, frequency of payments, mode of payment and credit & debit parties involved","summary":"Retrieves standing instruction details of a customer","tags":["RETAIL"],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"Identifier of the customer"},{"name":"standingOrderId","in":"query","type":"string","required":false,"description":"The unique standing order identifier"},{"name":"accountId","in":"query","type":"string","required":false,"description":"Identifier of the account. Often referred to as the account number, yet for consistency this is always referred to as accountId. Accepts both IBAN & BBAN"},{"name":"orderingCustomerId","in":"query","type":"string","required":false,"description":"Indicates the customer id for the ordering customer"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"StandingOrdersResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/party/customers/{customerId}/directDebits","fullPath":"/api/v5.5.0/party/customers/{customerId}/directDebits","operationId":"getDirectDebits","name":"Retrieves the list of direct debits for a customer with details such as direct debit reference, debit and credit accounts, transaction amount, payment frequency, next payment date and direction of payment","summary":"Retrieves direct debits details of a customer","tags":["RETAIL"],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"Identifier of the customer"},{"name":"directDebitId","in":"query","type":"string","required":false,"description":"The unique identifier of the direct debit mandate. "},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"DirectDebitsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"POST","path":"/party/customers/deliveryPreferences/{deliveryPreferenceId}","fullPath":"/api/v5.5.0/party/customers/deliveryPreferences/{deliveryPreferenceId}","operationId":"createDeliveryPreference","name":"Create customer delivery preferences with details such as message group, carrier, role, address, email details and format of messages","summary":"Create customer delivery preferences","tags":["RETAIL"],"parameters":[{"name":"deliveryPreferenceId","in":"path","type":"string","required":true,"description":"Identifier of the customer delivery preferences"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"messageGroup":[{}],"otherMessagesDetail":[{}],"applyOtherMessages":"string","extensions":{}}},"responses":{"200":"DeliveryPreferenceResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/party/customers/deliveryPreferences/{deliveryPreferenceId}","fullPath":"/api/v5.5.0/party/customers/deliveryPreferences/{deliveryPreferenceId}","operationId":"updateDeliveryPreference","name":"Update customer delivery preferences with details such as message group, carrier, role, address, email details and format of messages","summary":"Update customer delivery preferences","tags":["RETAIL"],"parameters":[{"name":"deliveryPreferenceId","in":"path","type":"string","required":true,"description":"Identifier of the customer delivery preferences"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"messageGroup":[{}],"otherMessagesDetail":[{}],"applyOtherMessages":"string","extensions":{}}},"responses":{"200":"DeliveryPreferenceResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/party/customers/{customerId}/customerExitStatus","fullPath":"/api/v5.5.0/party/customers/{customerId}/customerExitStatus","operationId":"getCustomerExitStatus","name":"Retrieves customer exit status details such as customer type, exit date, status and reason","summary":"Retrieves customer exit status details of customer","tags":["RETAIL"],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"Identifier of the customer"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"CustomerExitStatusResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"PUT","path":"/party/customers/{customerId}/customerExitStatus","fullPath":"/api/v5.5.0/party/customers/{customerId}/customerExitStatus","operationId":"updateCustomerExitStatus","name":"Update a customer with exit status and exit reason marking the customer as blocked or rejected or closed","summary":"Update customer exit status details of customers","tags":["RETAIL"],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"Identifier of the customer"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"exitStatus":"string","exitReason":"string","extensions":{}}},"responses":{"200":"CustomerExitStatusResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/party/customers/settings/customerExitStatus/{customerExitStatusId}","fullPath":"/api/v5.5.0/party/customers/settings/customerExitStatus/{customerExitStatusId}","operationId":"getCustomerExitStatusParam","name":"Retrieves available conditions such as customer exit setup reference, allowed reasons and allowed re-open details to update customer exit status of customers","summary":"Retrieves conditions to update customer exit status of customer","tags":["RETAIL"],"parameters":[{"name":"customerExitStatusId","in":"path","type":"string","required":true,"description":""},{"name":"customerType","in":"query","type":"string","required":false,"description":"Identifies the type of customers. Example Personal, Business, Corporate, etc."},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"CustomerExitStatusParamResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"POST","path":"/party/customers/settings/customerExitStatus/{customerExitStatusId}","fullPath":"/api/v5.5.0/party/customers/settings/customerExitStatus/{customerExitStatusId}","operationId":"createCustomerExitStatusParam","name":"Create conditions such as applicable customer type and allowed reasons to update the customer exit status details of customers","summary":"Create conditions to update customer exit status of customer","tags":["RETAIL"],"parameters":[{"name":"customerExitStatusId","in":"path","type":"string","required":true,"description":"The field reflects the exit status ID of a customer or prospect from the parameterization table CUSTOMER.EXIT.STATUS"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"allowedExitReasons":[{}],"exitStatusDescription":"string","customerType":"string","allowRemoveExitStatus":"string","extensions":{}}},"responses":{"200":"CustomerExitStatusParamResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/party/customers/settings/{customerExitStatusId}/customerExitStatus","fullPath":"/api/v5.5.0/party/customers/settings/{customerExitStatusId}/customerExitStatus","operationId":"updateCustomerExitStatusParam","name":"Create conditions such as applicable customer type and allowed reasons to update the customer exit status details of customers","summary":"Create conditions to update customer exit status of customer","tags":["RETAIL"],"parameters":[{"name":"customerExitStatusId","in":"path","type":"string","required":true,"description":"The field reflects the exit status ID of a customer or prospect from the parameterization table CUSTOMER.EXIT.STATUS"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"allowedExitReasons":[{}],"exitStatusDescription":"string","customerType":"string","allowRemoveExitStatus":"string","extensions":{}}},"responses":{"200":"CustomerExitStatusParamResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/party/customers/{customerId}/addresses","fullPath":"/api/v5.5.0/party/customers/{customerId}/addresses","operationId":"getCustomerAddressOutput","name":"Returns structured/unstructured address details of specified customer based on address option in request. When structured format is requested, the values are returned in format of structured data name combined with corresponding customer address value. When unstructured format is requested, the address details are returned based on configured unstructured address format.","summary":"Retrieves structured/ unstructured address format of customer","tags":["RETAIL"],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"Identifier of the customer"},{"name":"addressOption","in":"query","type":"string","required":false,"description":"It reflects the preference for the customer address format, respective structured, unstructured or both"},{"name":"addressOutputFormat","in":"query","type":"string","required":false,"description":"It identifies the address output format for the unstructured address"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"CustomerAddressOutputResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/party/customers/{customerId}/shortNames","fullPath":"/api/v5.5.0/party/customers/{customerId}/shortNames","operationId":"getCustomerShortNames","name":"Retrieves customer short name that can be used as customer enrichment by any application","summary":"Retrieves customer short name","tags":["RETAIL"],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"CustomerShortNamesResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/party/customers/{customerId}/mandates","fullPath":"/api/v5.5.0/party/customers/{customerId}/mandates","operationId":"getCustomerMandates","name":"Retrieves the mandate instruction details such as application eligible for mandate process and the corresponding mandate rule that is being applied to check mandates for transactions involving the specified customer.","summary":"Retrieves mandate instruction applicable for the requested customer","tags":["RETAIL"],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"CustomerMandatesResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/party/customers/{customerId}/documents","fullPath":"/api/v5.5.0/party/customers/{customerId}/documents","operationId":"getCustomerLegalDocuments","name":"Retrieves the details of legal document provided by the customer such as document name, document id, issue date, expiry date and authority who issued the document.","summary":"Retrieves the customer legal document details","tags":["RETAIL"],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"CustomerLegalDocumentsResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/party/customers/{customerId}/profiles","fullPath":"/api/v5.5.0/party/customers/{customerId}/profiles","operationId":"getCustomerProfile","name":"Retrieves the customer basic details such as personal information, address location, basic contact details and other general information.","summary":"Retrieves profile details of the requested customer","tags":["RETAIL"],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"CustomerProfileResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/party/customers/alternateReferences/{alternateReference}","fullPath":"/api/v5.5.0/party/customers/alternateReferences/{alternateReference}","operationId":"getCustomerId","name":"Retrieves the customer identifier for the provided alternate reference of the customer","summary":"Retrieves customer id for the given alternate reference","tags":["RETAIL"],"parameters":[{"name":"alternateReference","in":"path","type":"string","required":true,"description":"If the new Account to be created is a shadow of another Account already exisitng in another system, then the Account reference of that system can be specified here. The value given in this field will "},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"CustomerIdResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/party/customers/{customerId}/restrictions","fullPath":"/api/v5.5.0/party/customers/{customerId}/restrictions","operationId":"getCustomerRestrictions","name":"Retrieves the transaction restrictions imposed on the customer specified. Restrictions can be post no entries, black listed customer, pending KYC due reasons for restricting transactions on this customer","summary":"Retrieves the restriction details","tags":["RETAIL"],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"CustomerRestrictionsResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/party/customers/{customerId}/contacts","fullPath":"/api/v5.5.0/party/customers/{customerId}/contacts","operationId":"getCustomerContacts","name":"Retrieves the contact details such as phone number, mobile numbers, fax and email address specific to the requested customer","summary":"Retrieves the customer contact details","tags":["RETAIL"],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"Identifier of the customer"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"CustomerContactsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/party/customers/{customerId}/relationships","fullPath":"/api/v5.5.0/party/customers/{customerId}/relationships","operationId":"getCustomerRelationships","name":"Retrieves the relationship details such as related customer and the relationship that exists with the requested customer","summary":"Retrieves the relation customers","tags":["RETAIL"],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"CustomerRelationshipsResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/party/customers/{customerId}/payments","fullPath":"/api/v5.5.0/party/customers/{customerId}/payments","operationId":"getPartyBasicDetails","name":"Retrieves the customer information that are required for processing or validating the customer involved in a payment transaction. Provides the information such as customer name details, birth details, address details,  market sector, target, nationality, residence country and preferred language for communication.","summary":"Retrieves customer details required for payment processing","tags":["RETAIL"],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"Identifier of the customer"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"PartyBasicDetailsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/party/customers/{customerId}/addresses/swiftAddresses/{addressId}","fullPath":"/api/v5.5.0/party/customers/{customerId}/addresses/swiftAddresses/{addressId}","operationId":"getCustomerSwiftAddress","name":"Retrieves the SWIFT address details such as delivery address, short name and tag25 indicator for the customer.","summary":"Retrieves the SWIFT address details for the customer.","tags":["RETAIL"],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"Identifier of the customer"},{"name":"addressId","in":"path","type":"string","required":true,"description":"Reference Id of address record"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"CustomerSwiftAddressResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/party/customers/{customerId}/charges","fullPath":"/api/v5.5.0/party/customers/{customerId}/charges","operationId":"getCustomerCharge","name":"Retrieves customer charge for a customer with details such as tax type and tax group.","summary":"Retrieves customer charge for a specific customer.","tags":["RETAIL"],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"Identifier of the customer"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"CustomerChargeResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"POST","path":"/party/customers/{customerId}/charges","fullPath":"/api/v5.5.0/party/customers/{customerId}/charges","operationId":"createCustomerCharge","name":"Creates customer charge for a customer with details such as tax type and tax group.","summary":"Creates customer charge for a specific customer.","tags":["RETAIL"],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"Identifier of the customer"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"taxGroups":[{}],"extensions":{}}},"responses":{"200":"CustomerChargeResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/party/customers/{customerId}/charges","fullPath":"/api/v5.5.0/party/customers/{customerId}/charges","operationId":"updateCustomerCharge","name":"Updates customer charge for a customer with details such as tax type and tax group.","summary":"Updates customer charge for a specific customer.","tags":["RETAIL"],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"Identifier of the customer"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"taxGroups":[{}],"extensions":{}}},"responses":{"200":"CustomerChargeResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/party/customers/{customerId}/addresses/smsAddresses","fullPath":"/api/v5.5.0/party/customers/{customerId}/addresses/smsAddresses","operationId":"getCustomerPhoneAddress","name":"Retrieves the list of customer sms communication address with details such as name, idd prefix and mobile number.","summary":"Retrieves available list of customer sms communication addresses","tags":["RETAIL"],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"Identifier of the customer"},{"name":"addressId","in":"query","type":"string","required":false,"description":"Reference Id of address record"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"CustomerPhoneAddressResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"POST","path":"/party/customers/{customerId}/addresses/smsAddresses","fullPath":"/api/v5.5.0/party/customers/{customerId}/addresses/smsAddresses","operationId":"createCustomerPhoneAddress","name":"Create customer sms communication address with details such as name, idd prefix and mobile number.","summary":"Creates customer sms communication address","tags":["RETAIL"],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"Identifier of the customer"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"customerShortNames":[{}],"iddPrefixMobile":"string","mobileNumber":"string","extensions":{}}},"responses":{"200":"CustomerPhoneAddressResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/party/customers/{customerId}/addresses/emailAddresses","fullPath":"/api/v5.5.0/party/customers/{customerId}/addresses/emailAddresses","operationId":"getCustomerEmailAddress","name":"Retrieves the list of customer email communication address with details such as customer name and email references.","summary":"Retrieves available list of customer email communication addresses","tags":["RETAIL"],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"Identifier of the customer"},{"name":"addressId","in":"query","type":"string","required":false,"description":"Reference Id of address record"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"CustomerEmailAddressResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"POST","path":"/party/customers/{customerId}/addresses/emailAddresses","fullPath":"/api/v5.5.0/party/customers/{customerId}/addresses/emailAddresses","operationId":"createCustomerEmailAddress","name":"Create customer email communication address with details such as customer name and email references.","summary":"Creates customer email communication address","tags":["RETAIL"],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"Identifier of the customer"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"customerShortNames":[{}],"email":"string","extensions":{}}},"responses":{"200":"CustomerEmailAddressResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/party/customers/{customerId}/addresses/printAddresses","fullPath":"/api/v5.5.0/party/customers/{customerId}/addresses/printAddresses","operationId":"getCustomerPrintAddress","name":"Retrieves the list of customer print communication addresses with details such as name, address, postcode and phone number.","summary":"Retrieves available list of customer print communication addresses","tags":["RETAIL"],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"Identifier of the customer"},{"name":"addressId","in":"query","type":"string","required":false,"description":"Reference Id of address record"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"CustomerPrintAddressResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"POST","path":"/party/customers/{customerId}/addresses/printAddresses","fullPath":"/api/v5.5.0/party/customers/{customerId}/addresses/printAddresses","operationId":"createCustomerPrintAddress","name":"Create customer print communication address with details such as name, address, postcode and phone number.","summary":"Creates customer print communication address","tags":["RETAIL"],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"Identifier of the customer"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"customerShortNames":[{}],"customerNames":[{}],"addresses":[{}],"streets":[{}],"towns":[{}],"postCodes":[{}],"addressPurpose":"string","addressLocation":"string","addressVerifier":"string","countryCode":"string","departmentId":"string","subDepartmentId":"string","flatNumber":"string","buildingName":"string","buildingNumber":"string"}},"responses":{"200":"CustomerPrintAddressResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/party/customers/addresses/{customerAddressId}/smsAddresses","fullPath":"/api/v5.5.0/party/customers/addresses/{customerAddressId}/smsAddresses","operationId":"updateCustomerPhoneAddress","name":"Update customer sms communication address with details such as name, idd prefix and mobile number.","summary":"Updates customer sms communication address","tags":["RETAIL"],"parameters":[{"name":"customerAddressId","in":"path","type":"string","required":true,"description":"Identifier of the customer address table."},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"customerShortNames":[{}],"iddPrefixMobile":"string","mobileNumber":"string","extensions":{}}},"responses":{"200":"CustomerPhoneAddressResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"DELETE","path":"/party/customers/addresses/{customerAddressId}/smsAddresses","fullPath":"/api/v5.5.0/party/customers/addresses/{customerAddressId}/smsAddresses","operationId":"deleteCustomerPhoneAddress","name":"Delete the specified customer sms communication address that are no longer used.","summary":"Deletes customer sms communication address","tags":["RETAIL"],"parameters":[{"name":"customerAddressId","in":"path","type":"string","required":true,"description":"Identifier of the customer address table."},{"name":"payload","in":"body","type":"object","required":false,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}}},"responses":{"200":"CustomerPhoneAddressResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/party/customers/addresses/{customerAddressId}/emailAddresses","fullPath":"/api/v5.5.0/party/customers/addresses/{customerAddressId}/emailAddresses","operationId":"updateCustomerEmailAddress","name":"Update customer email communication address with details such as customer name and email references.","summary":"Updates customer email communication address","tags":["RETAIL"],"parameters":[{"name":"customerAddressId","in":"path","type":"string","required":true,"description":"Identifier of the customer address table."},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"customerShortNames":[{}],"email":"string","extensions":{}}},"responses":{"200":"CustomerEmailAddressResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"DELETE","path":"/party/customers/addresses/{customerAddressId}/emailAddresses","fullPath":"/api/v5.5.0/party/customers/addresses/{customerAddressId}/emailAddresses","operationId":"deleteCustomerEmailAddress","name":"Delete the specified customer email communication address that are no longer used.","summary":"Deletes customer email communication address","tags":["RETAIL"],"parameters":[{"name":"customerAddressId","in":"path","type":"string","required":true,"description":"Identifier of the customer address table."},{"name":"payload","in":"body","type":"object","required":false,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}}},"responses":{"200":"CustomerEmailAddressResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/party/customers/addresses/{customerAddressId}/printAddresses","fullPath":"/api/v5.5.0/party/customers/addresses/{customerAddressId}/printAddresses","operationId":"updateCustomerPrintAddress","name":"Update customer print communication address with details such as name, address, postcode and phone number.","summary":"Updates customer print communication address","tags":["RETAIL"],"parameters":[{"name":"customerAddressId","in":"path","type":"string","required":true,"description":"Identifier of the customer address table."},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"customerShortNames":[{}],"customerNames":[{}],"addresses":[{}],"streets":[{}],"towns":[{}],"postCodes":[{}],"addressPurpose":"string","addressLocation":"string","addressVerifier":"string","countryCode":"string","departmentId":"string","subDepartmentId":"string","flatNumber":"string","buildingName":"string","buildingNumber":"string"}},"responses":{"200":"CustomerPrintAddressResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"DELETE","path":"/party/customers/addresses/{customerAddressId}/printAddresses","fullPath":"/api/v5.5.0/party/customers/addresses/{customerAddressId}/printAddresses","operationId":"deleteCustomerPrintAddress","name":"Delete the specified customer print communication address that are no longer used.","summary":"Deletes customer print communication address","tags":["RETAIL"],"parameters":[{"name":"customerAddressId","in":"path","type":"string","required":true,"description":"Identifier of the customer address table."},{"name":"payload","in":"body","type":"object","required":false,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}}},"responses":{"200":"CustomerPrintAddressResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/party/customers/{customerId}/consents","fullPath":"/api/v5.5.0/party/customers/{customerId}/consents","operationId":"getCustomerConsents","name":"Retrieves the list of consent details for specific customer","summary":"Retrieves customer consents details","tags":["RETAIL"],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"Identifier of the customer"},{"name":"propertyClassId","in":"query","type":"string","required":false,"description":"The identifier of a condition that is used to build a product"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"CustomerConsentsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"POST","path":"/party/customers/{customerId}/fatca","fullPath":"/api/v5.5.0/party/customers/{customerId}/fatca","operationId":"createFatcaCustomer","name":"Creates the FATCA customer supplementary information that stores the related FATCA details for the customer","summary":"Create FATCA customer supplementary information details","tags":["RETAIL"],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"Identifier of the customer"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"citizenships":[{}],"tinDetails":[{}],"Owner":[{}],"JointOwner":[{}],"fatcaClientType":"string","isPlaceOfBirthUs":"string","domicile":"string","greencardDetails":"string","residenceId":"string","isPoa":"string","standingInstructionOnUsAccount":"string","accountInstructionfromUs":"string","socialSecurityNumber":"string","phoneNumber":"string","isDormantAccount":"string"}},"responses":{"200":"FatcaCustomerResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/party/customers/{customerId}/fatca","fullPath":"/api/v5.5.0/party/customers/{customerId}/fatca","operationId":"updateFatcaCustomer","name":"Update the FATCA customer supplementary information that stores the related FATCA details for the customer","summary":"Update FATCA customer supplementary information details","tags":["RETAIL"],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"Identifier of the customer"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"citizenships":[{}],"tinDetails":[{}],"Owner":[{}],"JointOwner":[{}],"fatcaClientType":"string","isPlaceOfBirthUs":"string","domicile":"string","greencardDetails":"string","residenceId":"string","isPoa":"string","standingInstructionOnUsAccount":"string","accountInstructionfromUs":"string","socialSecurityNumber":"string","phoneNumber":"string","isDormantAccount":"string"}},"responses":{"200":"FatcaCustomerResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/party/customers/{customerId}/portfolios/{portfolioId}/overdueSettlements","fullPath":"/api/v5.5.0/party/customers/{customerId}/portfolios/{portfolioId}/overdueSettlements","operationId":"getOverdueSettlements","name":"Retrieves overdue settlements of customer or portfolio with details such as transaction reference, instrument reference , instrument name, depository and broker involved, trade date, trade currency, trade quantity, current customer and broker outstandings","summary":"Retrieves overdue settlements of customer or portfolio","tags":["RETAIL"],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"Identifier of the customer"},{"name":"portfolioId","in":"path","type":"string","required":true,"description":"Id of the portfolio or security account"},{"name":"transactionId","in":"query","type":"string","required":false,"description":"Unique transaction identifier for retrieving the details of the transaction. For example: FT0102030333 etc."},{"name":"brokerId","in":"query","type":"string","required":false,"description":"The identifier of the broker"},{"name":"tradeDate","in":"query","type":"string","required":false,"description":"Standard date field which records trade date of the account"},{"name":"valueDate","in":"query","type":"string","required":false,"description":"Indicates the value date on which the underlying accounting entry is to be given value (for interest purposes)"},{"name":"depository","in":"query","type":"string","required":false,"description":"Person designated as depository by the company in or pursuant to this Indenture, and, unless otherwise provided with respect to any security, any successor to such person"},{"name":"currency","in":"query","type":"string","required":false,"description":"Identifies the currency. E.g. USD, GBP etc"},{"name":"instrumentId","in":"query","type":"string","required":false,"description":"The identifier of the instrument"},{"name":"deliveryInstruction","in":"query","type":"string","required":false,"description":"Customer's directions to a bank as to the disposition of funds and securities in the customer's account"},{"name":"transactionType","in":"query","type":"string","required":false,"description":"Identifies the transaction type applicable to the transaction being processed, i.e. outward or inward payment. For example: ACPX, OTPX etc."},{"name":"quantity","in":"query","type":"string","required":false,"description":"The nominal quantity"},{"name":"stockExchange","in":"query","type":"string","required":false,"description":"Contains the stock exchange details where a particular security is usually dealt"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"OverdueSettlementsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/party/customers/accountServicingProviders","fullPath":"/api/v5.5.0/party/customers/accountServicingProviders","operationId":"getOtherBanksToConnectTo","name":"Retrieves the third party providers that are allowed to interact with the bank or entity with details such as global unique reference number, provider country,provider name and national competent authority register code","summary":"Retrieves details of third party providers","tags":["RETAIL"],"parameters":[{"name":"openBankingId","in":"query","type":"string","required":false,"description":"Identifies the open banking number of the customer"},{"name":"countryId","in":"query","type":"string","required":false,"description":"ISO country code of the financial institution. "},{"name":"setActive","in":"query","type":"string","required":false,"description":"Flag to set the connection status to active"},{"name":"status","in":"query","type":"string","required":false,"description":"Contains status of the data rights request.Allowed values are INITIATED, INPROGESS, EXTENDED, COMPLETED, REJECTED."},{"name":"extSourceProvider","in":"query","type":"string","required":false,"description":"Contains the name of the external source provider for the customer"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"OtherBanksToConnectToResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/party/customers/prospects","fullPath":"/api/v5.5.0/party/customers/prospects","operationId":"getProspectCustomers","name":"Retrieves the list of prospect customers with details such as contact information, residence details, personal details and prospect legal details","summary":"Retrieves prospect details of customers","tags":["RETAIL"],"parameters":[{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"ProspectCustomersResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"POST","path":"/party/customers/prospects","fullPath":"/api/v5.5.0/party/customers/prospects","operationId":"createProspectCustomer","name":"Create a prospect customer with basic details such as contact information, residence details and prospect legal details","summary":"Create a prospect customer","tags":["RETAIL"],"parameters":[{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"customerNames":[{}],"streets":[{}],"addresses":[{}],"townCountries":[{}],"postCodes":[{}],"countries":[{}],"phoneNumbers":[{}],"emails":[{}],"socialNetworkIds":[{}],"prospectLegalDetails":[{}],"personEntity":"string","departmentId":"string","subDepartmentId":"string","floorNumber":"string","locationName":"string"}},"responses":{"200":"ProspectCustomerResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/party/customers/{customerId}/opportunities","fullPath":"/api/v5.5.0/party/customers/{customerId}/opportunities","operationId":"getCustomerOpportunities","name":"Retrieves the details of sales opportunities such as score, status and product details which are likely to be of interest to specific customers","summary":"Retrieves the sales opportunities for specific customers","tags":["RETAIL"],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"Identifier of the customer"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"CustomerOpportunitiesResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/party/customers/{customerId}/requests","fullPath":"/api/v5.5.0/party/customers/{customerId}/requests","operationId":"getCustomerRequests","name":"Retrieves process workflow details such as process name, activity details and status for a specific customer","summary":"Retrieves process workflows for a specific customer","tags":["RETAIL"],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"Identifier of the customer"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"CustomerRequestsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"PUT","path":"/party/customers/prospects/{prospectId}","fullPath":"/api/v5.5.0/party/customers/prospects/{prospectId}","operationId":"updateProspectCustomer","name":"Update a prospect customer with basic details such as contact information, residence details and prospect legal details","summary":"Update a prospect customer","tags":["RETAIL"],"parameters":[{"name":"prospectId","in":"path","type":"string","required":true,"description":"Indicates the status of an onboarding customer. Status can be PROSPECT while onboarding and ACTIVE when the prospect becomes a Customer."},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"customerNames":[{}],"streets":[{}],"addresses":[{}],"townCountries":[{}],"postCodes":[{}],"countries":[{}],"phoneNumbers":[{}],"emails":[{}],"socialNetworkIds":[{}],"prospectLegalDetails":[{}],"personEntity":"string","departmentId":"string","subDepartmentId":"string","floorNumber":"string","locationName":"string"}},"responses":{"200":"ProspectCustomerResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/party/customers/{customerId}/alertRequests","fullPath":"/api/v5.5.0/party/customers/{customerId}/alertRequests","operationId":"getAlertRequests","name":"Retrieves the alert subscription details such as alert reference, alert name and condition for alerts of a customer","summary":"Retrieves alert requests details","tags":["RETAIL"],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"Identifier of the customer"},{"name":"contractReference","in":"query","type":"string","required":false,"description":"Contains the contract reference"},{"name":"subscribe","in":"query","type":"string","required":false,"description":"Enables an alert service"},{"name":"alertRequestId","in":"query","type":"string","required":false,"description":"The unique identifier of the alert request."},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"AlertRequestsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/party/relationships/{partyId}/relations","fullPath":"/api/v5.5.0/party/relationships/{partyId}/relations","operationId":"getPartyRelationship","name":"Retrieves the relationship details such as party name, type, relation code, status and owning percentage of customers involved in a relationship","summary":"Retrieves list of party relationship details","tags":["RETAIL"],"parameters":[{"name":"partyId","in":"path","type":"string","required":true,"description":"Allows capturing of customers or person entities to be part of the relationship. If partyType is selected as Customer, then the system will allow only customer Ids to be captured into this field. If p"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"PartyRelationshipResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"POST","path":"/party/customers/staticDataUpdateEvents","fullPath":"/api/v5.5.0/party/customers/staticDataUpdateEvents","operationId":"createCustomerStaticChange","name":"Create data log with details such as event name, event creation date and time for customer that has undergone static data updates from external party systems","summary":"Create log of customer static data update event from external party systems","tags":["RETAIL"],"parameters":[{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"creationDate":"string","requestTime":"string","eventName":"string","customerId":"string","extensions":{}}},"responses":{"200":"CustomerStaticChangeResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/party/customers/bankCodes/BICs/{bicId}/owners","fullPath":"/api/v5.5.0/party/customers/bankCodes/BICs/{bicId}/owners","operationId":"getBicOwners","name":"Returns the owner of the BIC and the channel through which this BIC is used. If a company code is returned without a customer ID this indicates the entity of the current financial institution. If a company code is returned along with a customer number, this indicates the customer identified by the respective BIC and the entity of the current financial institution that maintains the main relationship with the customer. The address type returned represent the context in which the BIC can be used.","summary":"Returns the owner of the BIC and the channel through which this BIC is used.","tags":["RETAIL"],"parameters":[{"name":"bicId","in":"path","type":"string","required":true,"description":"Bank Identifier Code (BIC) of the financial institution"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"BicOwnersResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"POST","path":"/party/customers/groupPurposes/{groupPurposeId}","fullPath":"/api/v5.5.0/party/customers/groupPurposes/{groupPurposeId}","operationId":"createCustomerGroupPurpose","name":"Allows creation of customer group purpose with details such as group purpose, type of group relationships - individual or group, allowed list of individual, aggregate and group relationships.","summary":"Allows creation of customer group purpose.","tags":["RETAIL"],"parameters":[{"name":"groupPurposeId","in":"path","type":"string","required":true,"description":"Identifier of customer group purpose"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"groupTypes":[{}],"description":"string","groupPurpose":"string","groupLevelUniqueCustomer":"string","allowGroupRelationship":"string","allowRelationship":"string","subGroupLevelUniqueCustomer":"string","extensions":{}}},"responses":{"200":"CustomerGroupPurposeResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/party/customers/groupPurposes/{groupPurposeId}","fullPath":"/api/v5.5.0/party/customers/groupPurposes/{groupPurposeId}","operationId":"updateCustomerGroupPurpose","name":"Allows amendment of customer group purpose with details such as group purpose, type of group relationships - individual or group, allowed list of individual, aggregate and group relationships","summary":"Allows amendment of customer group purpose","tags":["RETAIL"],"parameters":[{"name":"groupPurposeId","in":"path","type":"string","required":true,"description":"Identifier of customer group purpose"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"groupTypes":[{}],"description":"string","groupPurpose":"string","groupLevelUniqueCustomer":"string","allowGroupRelationship":"string","allowRelationship":"string","subGroupLevelUniqueCustomer":"string","extensions":{}}},"responses":{"200":"CustomerGroupPurposeResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"DELETE","path":"/party/customers/groupPurposes/{groupPurposeId}","fullPath":"/api/v5.5.0/party/customers/groupPurposes/{groupPurposeId}","operationId":"deleteCustomerGroupPurpose","name":"Allows deletion of unapproved customer group purpose that is no longer required","summary":"Allows deletion of unapproved customer group purpose","tags":["RETAIL"],"parameters":[{"name":"groupPurposeId","in":"path","type":"string","required":true,"description":"Identifier of customer group purpose"},{"name":"payload","in":"body","type":"object","required":false,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}}},"responses":{"200":"CustomerGroupPurposeResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/party/customers/groupPurposes/{groupPurposeId}/approvals","fullPath":"/api/v5.5.0/party/customers/groupPurposes/{groupPurposeId}/approvals","operationId":"approveCustomerGroupPurpose","name":"Allows authorization of customer group purpose with modified details such as type of group relationships - individual or group, allowed list of individual, aggregate and group relationships","summary":"Allows authorization of customer group purpose","tags":["RETAIL"],"parameters":[{"name":"groupPurposeId","in":"path","type":"string","required":true,"description":"Identifier of customer group purpose"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"CustomerGroupPurposeResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"DELETE","path":"/party/customers/groupPurposes/{groupPurposeId}/cancellations","fullPath":"/api/v5.5.0/party/customers/groupPurposes/{groupPurposeId}/cancellations","operationId":"cancelCustomerGroupPurpose","name":"Allows cancellations of approved customer group purpose that is no longer required","summary":"Allows cancellation of customer group purpose","tags":["RETAIL"],"parameters":[{"name":"groupPurposeId","in":"path","type":"string","required":true,"description":"Identifier of customer group purpose"},{"name":"payload","in":"body","type":"object","required":false,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}}},"responses":{"200":"CustomerGroupPurposeResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"POST","path":"/party/customers/groups/{groupId}","fullPath":"/api/v5.5.0/party/customers/groups/{groupId}","operationId":"createCustomerGroup","name":"Allows creation of customer group with details such as group name, purpose, group type, company reference, account officer, closure date, customer and their relationships that can be either individual or group, liability customer and the ownership percentage of each customers in the group","summary":"Allows creation of customer group","tags":["RETAIL"],"parameters":[{"name":"groupId","in":"path","type":"string","required":true,"description":"Unique ID of the group"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"relationshipDetails":[{}],"subGroupDetails":[{}],"primaryPartyDetails":[{}],"description":"string","groupName":"string","groupPurposeId":"string","groupType":"string","companyId":"string","accountOfficer":"string","closureDate":"string","liabilityNumber":"string","extensions":{}}},"responses":{"200":"CustomerGroupResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/party/customers/groups/{groupId}","fullPath":"/api/v5.5.0/party/customers/groups/{groupId}","operationId":"updateCustomerGroup","name":"Allows amendment of customer group with details such as group name, purpose, group type, company reference, account officer, closure date, customer and their relationships that can be either individual or group, liability customer and the ownership percentage of each customers in the group","summary":"Allows amendment of customer group","tags":["RETAIL"],"parameters":[{"name":"groupId","in":"path","type":"string","required":true,"description":"Unique ID of the group"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"relationshipDetails":[{}],"subGroupDetails":[{}],"primaryPartyDetails":[{}],"description":"string","groupName":"string","groupPurposeId":"string","groupType":"string","companyId":"string","accountOfficer":"string","closureDate":"string","liabilityNumber":"string","extensions":{}}},"responses":{"200":"CustomerGroupResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"DELETE","path":"/party/customers/groups/{groupId}","fullPath":"/api/v5.5.0/party/customers/groups/{groupId}","operationId":"deleteCustomerGroup","name":"Allows deletion of unapproved customer group that is no longer required","summary":"Allows deletion of unapproved customer group","tags":["RETAIL"],"parameters":[{"name":"groupId","in":"path","type":"string","required":true,"description":"Unique ID of the group"},{"name":"payload","in":"body","type":"object","required":false,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}}},"responses":{"200":"CustomerGroupResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/party/customers/groups/{groupId}/approvals","fullPath":"/api/v5.5.0/party/customers/groups/{groupId}/approvals","operationId":"approveCustomerGroup","name":"Allows authorization of customer group with details such as group name, purpose, group type, company reference, account officer, closure date, customer and their relationships that can be either individual or group, liability customer and the ownership percentage of each customers in the group","summary":"Allows authorization of customer group","tags":["RETAIL"],"parameters":[{"name":"groupId","in":"path","type":"string","required":true,"description":"Unique ID of the group"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"CustomerGroupResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/party/customers/groupPurposes/pendingApprovals","fullPath":"/api/v5.5.0/party/customers/groupPurposes/pendingApprovals","operationId":"getUnapprovedCustomerGroupPurpose","name":"Retrieves the list of unapproved customer group purposes with details such as group purpose, type of group relationships - individual or group, allowed list of individual, aggregate and group relationships","summary":"Retrieves the list of unapproved customer group purposes","tags":["RETAIL"],"parameters":[{"name":"groupPurposeId","in":"query","type":"string","required":false,"description":"Identifier of customer group purpose"},{"name":"groupPurpose","in":"query","type":"string","required":false,"description":"Indicates the type of customer group. Allowed values are RISK ,LIABILITY or Blank."},{"name":"groupLevelUniqueCustomer","in":"query","type":"string","required":false,"description":"Indicates whether customers in a group are to be restricted from being defined in another customer group with same group purpose. YES - will restrict the customer from being defined in another group, "},{"name":"allowGroupRelationship","in":"query","type":"string","required":false,"description":"Indicates whether group relations have to be defaulted in customer group from party relationship. Allowed values are YES, NO or Blank."},{"name":"allowRelationship","in":"query","type":"string","required":false,"description":"Indicates whether customer relations have to be defaulted in customer group from party relationship. Allowed values are YES, NO or Blank."},{"name":"subGroupLevelUniqueCustomer","in":"query","type":"string","required":false,"description":"Indicates whether a customer is allowed to be part of multiple sub groups. Allowed values are UNIQUE, MULTIPLE, NONE or Blank."},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"UnapprovedCustomerGroupPurposeResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/party/customers/groupPurposes","fullPath":"/api/v5.5.0/party/customers/groupPurposes","operationId":"getCustomerGroupPurpose","name":"Retrieves the list of customer group purposes with details such as group purpose, type of group relationships - individual or group, allowed list of individual, aggregate and group relationships","summary":"Retrieves the list of customer group purposes","tags":["RETAIL"],"parameters":[{"name":"groupPurposeId","in":"query","type":"string","required":false,"description":"Identifier of customer group purpose"},{"name":"groupPurpose","in":"query","type":"string","required":false,"description":"Indicates the type of customer group. Allowed values are RISK ,LIABILITY or Blank."},{"name":"groupLevelUniqueCustomer","in":"query","type":"string","required":false,"description":"Indicates whether customers in a group are to be restricted from being defined in another customer group with same group purpose. YES - will restrict the customer from being defined in another group, "},{"name":"allowGroupRelationship","in":"query","type":"string","required":false,"description":"Indicates whether group relations have to be defaulted in customer group from party relationship. Allowed values are YES, NO or Blank."},{"name":"allowRelationship","in":"query","type":"string","required":false,"description":"Indicates whether customer relations have to be defaulted in customer group from party relationship. Allowed values are YES, NO or Blank."},{"name":"subGroupLevelUniqueCustomer","in":"query","type":"string","required":false,"description":"Indicates whether a customer is allowed to be part of multiple sub groups. Allowed values are UNIQUE, MULTIPLE, NONE or Blank."},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"CustomerGroupPurposeResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/party/customers/groups/pendingApprovals","fullPath":"/api/v5.5.0/party/customers/groups/pendingApprovals","operationId":"getUnapprovedCustomerGroup","name":"Retrieves the list of unapproved customer group with details such as group name, purpose, group type, company reference, account officer, closure date, customer and their relationships that can be either individual or group, liability customer and the ownership percentage of each customers in the group","summary":"Retrieves the list of unapproved customer groups","tags":["RETAIL"],"parameters":[{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"UnapprovedCustomerGroupResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/party/customers/groups","fullPath":"/api/v5.5.0/party/customers/groups","operationId":"getCustomerGroups","name":"Retrieves list of customer groups or specified customer group with details such as group name, purpose, group type, company reference, account officer, closure date, customer and their relationships that can be either individual or group, liability customer and the ownership percentage of each customers in the group","summary":"Retrieves the details of customer group","tags":["RETAIL"],"parameters":[{"name":"groupId","in":"query","type":"string","required":false,"description":"Unique ID of the group"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"CustomerGroupsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"POST","path":"/party/customers/customerClosures","fullPath":"/api/v5.5.0/party/customers/customerClosures","operationId":"createCustomerClosure","name":"Creates customer closure request with information such as customer id, exit status, exit reason and remarks.","summary":"Creates customer closure request","tags":["OTHERS"],"parameters":[{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"customerId":"string","exitStatus":"string","exitReason":"string","remarks":"string","requestStatus":"string","exitDate":"string","reopenedDate":"string","extensions":{}}},"responses":{"200":"CustomerClosureResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/party/customers/customerClosures/{customerClosureId}","fullPath":"/api/v5.5.0/party/customers/customerClosures/{customerClosureId}","operationId":"updateCustomerClosure","name":"Update customer closure request with information such as exit status, exit reason and remarks.","summary":"Allows amendment of customer closure request","tags":["OTHERS"],"parameters":[{"name":"customerClosureId","in":"path","type":"string","required":true,"description":"Identifier of customer closure request."},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"customerId":"string","exitStatus":"string","exitReason":"string","remarks":"string","requestStatus":"string","exitDate":"string","reopenedDate":"string","extensions":{}}},"responses":{"200":"CustomerClosureResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}}]},{"key":"party-customerServices-v5.6.0","title":"Customer management","version":"v5.6.0","description":"API to create, update and manage customer details such as delivery preferences, joint customer details, party relationships, KYC details, alert subscriptions, customer exit status, customer address formats & posting restrictions","endpointCount":85,"endpoints":[{"method":"GET","path":"/party/customers/{customerId}","fullPath":"/api/v5.6.0/party/customers/{customerId}","operationId":"getCustomer","name":"Retrieves the customer details such as customer contact information, residence details, legal document details, occupation details and relationship details for the specific customer","summary":"Retrieves customer details","tags":["RETAIL"],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"Identifier of the customer"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"CustomerResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"POST","path":"/party/customers/{customerId}","fullPath":"/api/v5.6.0/party/customers/{customerId}","operationId":"createCustomerWithId","name":"Create a customer with the information such as customer contact information, residence details, legal document details, occupation details and relationship details, etc provided by the user. It allows to create a customer with the provided id.","summary":"Create a customer by providing an Id","tags":["RETAIL"],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"Identifier of the customer"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"displayNames":[{}],"customerNames":[{}],"communicationDevices":[{}],"faxIds":[{}],"officePhoneNumbers":[{}],"streets":[{}],"addresses":[{}],"addressCities":[{}],"countries":[{}],"legalDetails":[{}],"otherNationalityIds":[{}],"employDetails":[{}],"residenceDetails":[{}],"relationshipDetails":[{}],"postingRestrictIds":[{}]}},"responses":{"200":"CustomerWithIdResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/party/customers/{customerId}","fullPath":"/api/v5.6.0/party/customers/{customerId}","operationId":"updateCustomer","name":"Update customer details with the information such as customer contact information, residence details, legal document details, occupation details and relationship details, etc provided by the user","summary":"Update customer details","tags":["RETAIL"],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"Identifier of the customer"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"displayNames":[{}],"customerNames":[{}],"communicationDevices":[{}],"faxIds":[{}],"officePhoneNumbers":[{}],"streets":[{}],"addresses":[{}],"addressCities":[{}],"countries":[{}],"legalDetails":[{}],"otherNationalityIds":[{}],"employDetails":[{}],"residenceDetails":[{}],"relationshipDetails":[{}],"postingRestrictIds":[{}]}},"responses":{"200":"CustomerResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/party/customers","fullPath":"/api/v5.6.0/party/customers","operationId":"getCustomerInformation","name":"Retrieves the customer details such as delivery or postal details, contact information, residence details, customer profile, legal document details, occupation details and status of customer","summary":"Retrieves list of customer basic details","tags":["RETAIL"],"parameters":[{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"CustomerInformationResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"POST","path":"/party/customers","fullPath":"/api/v5.6.0/party/customers","operationId":"createCustomer","name":"Create a customer with the information such as customer contact information, residence details, legal document details, occupation details and relationship details, etc provided by the user. It allows to create a customer with system generated id.","summary":"Create a customer","tags":["RETAIL"],"parameters":[{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"displayNames":[{}],"customerNames":[{}],"communicationDevices":[{}],"faxIds":[{}],"officePhoneNumbers":[{}],"streets":[{}],"addresses":[{}],"addressCities":[{}],"countries":[{}],"legalDetails":[{}],"otherNationalityIds":[{}],"employDetails":[{}],"residenceDetails":[{}],"relationshipDetails":[{}],"postingRestrictIds":[{}]}},"responses":{"200":"CustomerResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/party/customers/relationships","fullPath":"/api/v5.6.0/party/customers/relationships","operationId":"getCustomerRelationship","name":"Retrieves customer relationship details such as type of relationship, party information, related as, owning details, role & purpose of relationship for specific party or customer","summary":"Retrieves list of customer relationships","tags":["RETAIL"],"parameters":[{"name":"customerRelationGroupId","in":"query","type":"string","required":false,"description":"Identifies the key to Customer Relationship Group to form a relation"},{"name":"partyId","in":"query","type":"string","required":false,"description":"Allows capturing of customers or person entities to be part of the relationship. If partyType is selected as Customer, then the system will allow only customer Ids to be captured into this field. If p"},{"name":"relatedPartyId","in":"query","type":"string","required":false,"description":"Identifier of the Related Party"},{"name":"relationId","in":"query","type":"string","required":false,"description":"Identifier of the Customer Relationship and Party Relationship"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"CustomerRelationshipResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"POST","path":"/party/customers/relationships","fullPath":"/api/v5.6.0/party/customers/relationships","operationId":"createCustomerRelationship","name":"Create a customer relationship for a customer with details such as type of relationship, party information, related as, owning details, role & purpose of relationship","summary":"Create customer relationship with other customers","tags":["RETAIL"],"parameters":[{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"originatingRelation":[{}],"customerRelationGroupId":0.0,"customerRelationGroupName":"string","purposeOfRelationship":"string","extensions":{}}},"responses":{"200":"CustomerRelationshipResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/party/customers/relationships/{relationId}","fullPath":"/api/v5.6.0/party/customers/relationships/{relationId}","operationId":"updateCustomerRelationship","name":"Update customer relationship for a customer with details such as type of relationship, party information, related as, owning details, role & purpose of relationship","summary":"Update customer relationship","tags":["RETAIL"],"parameters":[{"name":"relationId","in":"path","type":"string","required":true,"description":"Identifier of the Customer Relationship and Party Relationship"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"originatingRelation":[{}],"customerRelationGroupId":0.0,"customerRelationGroupName":"string","purposeOfRelationship":"string","extensions":{}}},"responses":{"200":"CustomerRelationshipResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/party/customers/reportingStatus","fullPath":"/api/v5.6.0/party/customers/reportingStatus","operationId":"getCustomerReportingStatus","name":"Retrieves the FATCA/CRS reporting status and reporting jurisdiction of the customer","summary":"Retrieves reporting status of the customer","tags":["RETAIL"],"parameters":[{"name":"customerId","in":"query","type":"string","required":true,"description":"Identifier of the customer"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"CustomerReportingStatusResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/party/customers/{customerId}/sweeps","fullPath":"/api/v5.6.0/party/customers/{customerId}/sweeps","operationId":"getCustomerSweeps","name":"Retrieves account sweep details such as sweep reference, type, balance requirements for sweep and frequency of sweep for the list of accounts available to a customer","summary":"Retrieves account sweep details of the specific customer","tags":["RETAIL"],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"Identifier of the customer"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"CustomerSweepsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/party/customers/{customerId}/deliveryOptions","fullPath":"/api/v5.6.0/party/customers/{customerId}/deliveryOptions","operationId":"getCustomerDeliveryOptions","name":"Retrieves the delivery preferences of the customer such as the message group, carrier and address.","summary":"Retrieves delivery preferences of the customer","tags":["RETAIL"],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"Identifier of the customer"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"CustomerDeliveryOptionsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/party/customers/{customerId}/channels","fullPath":"/api/v5.6.0/party/customers/{customerId}/channels","operationId":"getCustomerDigitalChannels","name":"Retrieves the list of message channels such as internet banking, mobile banking, ATM, etc available for the specific customer","summary":"Retrieves list of message channels","tags":["RETAIL"],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"Identifier of the customer"},{"name":"channelName","in":"query","type":"string","required":false,"description":"Name of the (digital) channel registered by the Customer"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"CustomerDigitalChannelsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"POST","path":"/party/customers/messages","fullPath":"/api/v5.6.0/party/customers/messages","operationId":"createMessages","name":"Create a new secure message for a customer to be sent by bank","summary":"Create a new secure message for a customer","tags":["RETAIL"],"parameters":[{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"messages":[{}],"subject":"string","toCustomerId":"string","extensions":{}}},"responses":{"200":"MessagesResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/party/customers/{customerId}/jointCustomers","fullPath":"/api/v5.6.0/party/customers/{customerId}/jointCustomers","operationId":"getJointCustomerDetails","name":"Retrieves details such as joint relation code, name, joint customer details and reverse relationships for a specific customer","summary":"Retrieves joint customer details for a specific customer","tags":["RETAIL"],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"Identifier of the customer"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"JointCustomerDetailsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/party/customers/{customerId}/KYC","fullPath":"/api/v5.6.0/party/customers/{customerId}/KYC","operationId":"getCustomerKYCDetails","name":"Retrieves the KYC details such as contact date, introducer, last and next review date, KYC and AML status of a customer","summary":"Retrieves KYC details for a specific customer","tags":["RETAIL"],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"Identifier of the customer"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"CustomerKYCDetailsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/party/customers/{customerId}/personalProfiles","fullPath":"/api/v5.6.0/party/customers/{customerId}/personalProfiles","operationId":"getCustomerPersonalDetails","name":"Retrieves personal details such as residence, communication details, occupation details, asset and liability information","summary":"Retrieves personal details of customer","tags":["RETAIL"],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"Identifier of the customer"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"CustomerPersonalDetailsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/party/customers/postingRestrictions","fullPath":"/api/v5.6.0/party/customers/postingRestrictions","operationId":"getCustomerPostingRestrictions","name":"Retrieves the credit and debit posting restriction details such as restriction reference and name of restriction set for a customer","summary":"Retrieves posting restriction details","tags":["RETAIL"],"parameters":[{"name":"customerId","in":"query","type":"string","required":false,"description":"Identifier of the customer"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"CustomerPostingRestrictionsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"POST","path":"/party/relationships/{relationId}","fullPath":"/api/v5.6.0/party/relationships/{relationId}","operationId":"createPartyRelationship","name":"Create a party relationship between a person, entity or customer with details such as party name, relation type, related as, relation code and owning details","summary":"Create party relationship details","tags":["RETAIL"],"parameters":[{"name":"relationId","in":"path","type":"string","required":true,"description":"Identifier of the Customer Relationship and Party Relationship"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"partyDisplayNames":[{}],"partyRelationships":[{}],"extensions":{}}},"responses":{"200":"PartyRelationshipResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/party/relationships/{relationId}","fullPath":"/api/v5.6.0/party/relationships/{relationId}","operationId":"updatePartyRelationship","name":"Update party relationship between a person, entity or customer with details such as party name, relation type, related as, relation code and owning details","summary":"Update party relationship details","tags":["RETAIL"],"parameters":[{"name":"relationId","in":"path","type":"string","required":true,"description":"Identifier of the Customer Relationship and Party Relationship"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"partyDisplayNames":[{}],"partyRelationships":[{}],"extensions":{}}},"responses":{"200":"PartyRelationshipResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/party/customers/{customerId}/cards","fullPath":"/api/v5.6.0/party/customers/{customerId}/cards","operationId":"getCustomerCreditCards","name":"Retrieves the card details such as card number, card type and status, linked account and its balances of a customer","summary":"Retrieves card details of a customer","tags":["RETAIL"],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"Identifier of the customer"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"CustomerCreditCardsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/party/customers/{customerId}/standingOrders","fullPath":"/api/v5.6.0/party/customers/{customerId}/standingOrders","operationId":"getStandingOrders","name":"Retrieves the list of standing instructions for a customer with details such as instruction reference, order type, frequency of payments, mode of payment and credit & debit parties involved","summary":"Retrieves standing instruction details of a customer","tags":["RETAIL"],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"Identifier of the customer"},{"name":"standingOrderId","in":"query","type":"string","required":false,"description":"The unique standing order identifier"},{"name":"accountId","in":"query","type":"string","required":false,"description":"Identifier of the account. Often referred to as the account number, yet for consistency this is always referred to as accountId. Accepts both IBAN & BBAN"},{"name":"orderingCustomerId","in":"query","type":"string","required":false,"description":"Indicates the customer id for the ordering customer"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"StandingOrdersResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/party/customers/{customerId}/directDebits","fullPath":"/api/v5.6.0/party/customers/{customerId}/directDebits","operationId":"getDirectDebits","name":"Retrieves the list of direct debits for a customer with details such as direct debit reference, debit and credit accounts, transaction amount, payment frequency, next payment date and direction of payment","summary":"Retrieves direct debits details of a customer","tags":["RETAIL"],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"Identifier of the customer"},{"name":"directDebitId","in":"query","type":"string","required":false,"description":"The unique identifier of the direct debit mandate. "},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"DirectDebitsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"POST","path":"/party/customers/deliveryPreferences/{deliveryPreferenceId}","fullPath":"/api/v5.6.0/party/customers/deliveryPreferences/{deliveryPreferenceId}","operationId":"createDeliveryPreference","name":"Create customer delivery preferences with details such as message group, carrier, role, address, email details and format of messages","summary":"Create customer delivery preferences","tags":["RETAIL"],"parameters":[{"name":"deliveryPreferenceId","in":"path","type":"string","required":true,"description":"Identifier of the customer delivery preferences"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"messageGroup":[{}],"otherMessagesDetail":[{}],"applyOtherMessages":"string","extensions":{}}},"responses":{"200":"DeliveryPreferenceResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/party/customers/deliveryPreferences/{deliveryPreferenceId}","fullPath":"/api/v5.6.0/party/customers/deliveryPreferences/{deliveryPreferenceId}","operationId":"updateDeliveryPreference","name":"Update customer delivery preferences with details such as message group, carrier, role, address, email details and format of messages","summary":"Update customer delivery preferences","tags":["RETAIL"],"parameters":[{"name":"deliveryPreferenceId","in":"path","type":"string","required":true,"description":"Identifier of the customer delivery preferences"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"messageGroup":[{}],"otherMessagesDetail":[{}],"applyOtherMessages":"string","extensions":{}}},"responses":{"200":"DeliveryPreferenceResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/party/customers/{customerId}/customerExitStatus","fullPath":"/api/v5.6.0/party/customers/{customerId}/customerExitStatus","operationId":"getCustomerExitStatus","name":"Retrieves customer exit status details such as customer type, exit date, status and reason","summary":"Retrieves customer exit status details of customer","tags":["RETAIL"],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"Identifier of the customer"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"CustomerExitStatusResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"PUT","path":"/party/customers/{customerId}/customerExitStatus","fullPath":"/api/v5.6.0/party/customers/{customerId}/customerExitStatus","operationId":"updateCustomerExitStatus","name":"Update a customer with exit status and exit reason marking the customer as blocked or rejected or closed","summary":"Update customer exit status details of customers","tags":["RETAIL"],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"Identifier of the customer"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"exitStatus":"string","exitReason":"string","extensions":{}}},"responses":{"200":"CustomerExitStatusResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/party/customers/settings/customerExitStatus/{customerExitStatusId}","fullPath":"/api/v5.6.0/party/customers/settings/customerExitStatus/{customerExitStatusId}","operationId":"getCustomerExitStatusParam","name":"Retrieves available conditions such as customer exit setup reference, allowed reasons and allowed re-open details to update customer exit status of customers","summary":"Retrieves conditions to update customer exit status of customer","tags":["RETAIL"],"parameters":[{"name":"customerExitStatusId","in":"path","type":"string","required":true,"description":""},{"name":"customerType","in":"query","type":"string","required":false,"description":"Identifies the type of customers. Example Personal, Business, Corporate, etc."},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"CustomerExitStatusParamResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"POST","path":"/party/customers/settings/customerExitStatus/{customerExitStatusId}","fullPath":"/api/v5.6.0/party/customers/settings/customerExitStatus/{customerExitStatusId}","operationId":"createCustomerExitStatusParam","name":"Create conditions such as applicable customer type and allowed reasons to update the customer exit status details of customers","summary":"Create conditions to update customer exit status of customer","tags":["RETAIL"],"parameters":[{"name":"customerExitStatusId","in":"path","type":"string","required":true,"description":"The field reflects the exit status ID of a customer or prospect from the parameterization table CUSTOMER.EXIT.STATUS"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"allowedExitReasons":[{}],"exitStatusDescription":"string","customerType":"string","allowRemoveExitStatus":"string","extensions":{}}},"responses":{"200":"CustomerExitStatusParamResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/party/customers/settings/{customerExitStatusId}/customerExitStatus","fullPath":"/api/v5.6.0/party/customers/settings/{customerExitStatusId}/customerExitStatus","operationId":"updateCustomerExitStatusParam","name":"Create conditions such as applicable customer type and allowed reasons to update the customer exit status details of customers","summary":"Create conditions to update customer exit status of customer","tags":["RETAIL"],"parameters":[{"name":"customerExitStatusId","in":"path","type":"string","required":true,"description":"The field reflects the exit status ID of a customer or prospect from the parameterization table CUSTOMER.EXIT.STATUS"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"allowedExitReasons":[{}],"exitStatusDescription":"string","customerType":"string","allowRemoveExitStatus":"string","extensions":{}}},"responses":{"200":"CustomerExitStatusParamResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/party/customers/{customerId}/addresses","fullPath":"/api/v5.6.0/party/customers/{customerId}/addresses","operationId":"getCustomerAddressOutput","name":"Returns structured/unstructured address details of specified customer based on address option in request. When structured format is requested, the values are returned in format of structured data name combined with corresponding customer address value. When unstructured format is requested, the address details are returned based on configured unstructured address format.","summary":"Retrieves structured/ unstructured address format of customer","tags":["RETAIL"],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"Identifier of the customer"},{"name":"addressOption","in":"query","type":"string","required":false,"description":"It reflects the preference for the customer address format, respective structured, unstructured or both"},{"name":"addressOutputFormat","in":"query","type":"string","required":false,"description":"It identifies the address output format for the unstructured address"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"CustomerAddressOutputResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/party/customers/{customerId}/shortNames","fullPath":"/api/v5.6.0/party/customers/{customerId}/shortNames","operationId":"getCustomerShortNames","name":"Retrieves customer short name that can be used as customer enrichment by any application","summary":"Retrieves customer short name","tags":["RETAIL"],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"CustomerShortNamesResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/party/customers/{customerId}/mandates","fullPath":"/api/v5.6.0/party/customers/{customerId}/mandates","operationId":"getCustomerMandates","name":"Retrieves the mandate instruction details such as application eligible for mandate process and the corresponding mandate rule that is being applied to check mandates for transactions involving the specified customer.","summary":"Retrieves mandate instruction applicable for the requested customer","tags":["RETAIL"],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"CustomerMandatesResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/party/customers/{customerId}/documents","fullPath":"/api/v5.6.0/party/customers/{customerId}/documents","operationId":"getCustomerLegalDocuments","name":"Retrieves the details of legal document provided by the customer such as document name, document id, issue date, expiry date and authority who issued the document.","summary":"Retrieves the customer legal document details","tags":["RETAIL"],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"CustomerLegalDocumentsResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/party/customers/{customerId}/profiles","fullPath":"/api/v5.6.0/party/customers/{customerId}/profiles","operationId":"getCustomerProfile","name":"Retrieves the customer basic details such as personal information, address location, basic contact details and other general information.","summary":"Retrieves profile details of the requested customer","tags":["RETAIL"],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"CustomerProfileResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/party/customers/alternateReferences/{alternateReference}","fullPath":"/api/v5.6.0/party/customers/alternateReferences/{alternateReference}","operationId":"getCustomerId","name":"Retrieves the customer identifier for the provided alternate reference of the customer","summary":"Retrieves customer id for the given alternate reference","tags":["RETAIL"],"parameters":[{"name":"alternateReference","in":"path","type":"string","required":true,"description":"If the new Account to be created is a shadow of another Account already exisitng in another system, then the Account reference of that system can be specified here. The value given in this field will "},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"CustomerIdResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/party/customers/{customerId}/restrictions","fullPath":"/api/v5.6.0/party/customers/{customerId}/restrictions","operationId":"getCustomerRestrictions","name":"Retrieves the transaction restrictions imposed on the customer specified. Restrictions can be post no entries, black listed customer, pending KYC due reasons for restricting transactions on this customer","summary":"Retrieves the restriction details","tags":["RETAIL"],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"CustomerRestrictionsResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/party/customers/{customerId}/contacts","fullPath":"/api/v5.6.0/party/customers/{customerId}/contacts","operationId":"getCustomerContacts","name":"Retrieves the contact details such as phone number, mobile numbers, fax and email address specific to the requested customer","summary":"Retrieves the customer contact details","tags":["RETAIL"],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"Identifier of the customer"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"CustomerContactsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/party/customers/{customerId}/relationships","fullPath":"/api/v5.6.0/party/customers/{customerId}/relationships","operationId":"getCustomerRelationships","name":"Retrieves the relationship details such as related customer and the relationship that exists with the requested customer","summary":"Retrieves the relation customers","tags":["RETAIL"],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"CustomerRelationshipsResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/party/customers/{customerId}/payments","fullPath":"/api/v5.6.0/party/customers/{customerId}/payments","operationId":"getPartyBasicDetails","name":"Retrieves the customer information that are required for processing or validating the customer involved in a payment transaction. Provides the information such as customer name details, birth details, address details,  market sector, target, nationality, residence country and preferred language for communication.","summary":"Retrieves customer details required for payment processing","tags":["RETAIL"],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"Identifier of the customer"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"PartyBasicDetailsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/party/customers/{customerId}/addresses/swiftAddresses/{addressId}","fullPath":"/api/v5.6.0/party/customers/{customerId}/addresses/swiftAddresses/{addressId}","operationId":"getCustomerSwiftAddress","name":"Retrieves the SWIFT address details such as delivery address, short name and tag25 indicator for the customer.","summary":"Retrieves the SWIFT address details for the customer.","tags":["RETAIL"],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"Identifier of the customer"},{"name":"addressId","in":"path","type":"string","required":true,"description":"Reference Id of address record"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"CustomerSwiftAddressResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/party/customers/{customerId}/charges","fullPath":"/api/v5.6.0/party/customers/{customerId}/charges","operationId":"getCustomerCharge","name":"Retrieves customer charge for a customer with details such as tax type and tax group.","summary":"Retrieves customer charge for a specific customer.","tags":["RETAIL"],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"Identifier of the customer"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"CustomerChargeResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"POST","path":"/party/customers/{customerId}/charges","fullPath":"/api/v5.6.0/party/customers/{customerId}/charges","operationId":"createCustomerCharge","name":"Creates customer charge for a customer with details such as tax type and tax group.","summary":"Creates customer charge for a specific customer.","tags":["RETAIL"],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"Identifier of the customer"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"taxGroups":[{}],"extensions":{}}},"responses":{"200":"CustomerChargeResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/party/customers/{customerId}/charges","fullPath":"/api/v5.6.0/party/customers/{customerId}/charges","operationId":"updateCustomerCharge","name":"Updates customer charge for a customer with details such as tax type and tax group.","summary":"Updates customer charge for a specific customer.","tags":["RETAIL"],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"Identifier of the customer"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"taxGroups":[{}],"extensions":{}}},"responses":{"200":"CustomerChargeResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/party/customers/{customerId}/addresses/smsAddresses","fullPath":"/api/v5.6.0/party/customers/{customerId}/addresses/smsAddresses","operationId":"getCustomerPhoneAddress","name":"Retrieves the list of customer sms communication address with details such as name, idd prefix and mobile number.","summary":"Retrieves available list of customer sms communication addresses","tags":["RETAIL"],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"Identifier of the customer"},{"name":"addressId","in":"query","type":"string","required":false,"description":"Reference Id of address record"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"CustomerPhoneAddressResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"POST","path":"/party/customers/{customerId}/addresses/smsAddresses","fullPath":"/api/v5.6.0/party/customers/{customerId}/addresses/smsAddresses","operationId":"createCustomerPhoneAddress","name":"Create customer sms communication address with details such as name, idd prefix and mobile number.","summary":"Creates customer sms communication address","tags":["RETAIL"],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"Identifier of the customer"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"customerShortNames":[{}],"iddPrefixMobile":"string","mobileNumber":"string","extensions":{}}},"responses":{"200":"CustomerPhoneAddressResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/party/customers/{customerId}/addresses/emailAddresses","fullPath":"/api/v5.6.0/party/customers/{customerId}/addresses/emailAddresses","operationId":"getCustomerEmailAddress","name":"Retrieves the list of customer email communication address with details such as customer name and email references.","summary":"Retrieves available list of customer email communication addresses","tags":["RETAIL"],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"Identifier of the customer"},{"name":"addressId","in":"query","type":"string","required":false,"description":"Reference Id of address record"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"CustomerEmailAddressResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"POST","path":"/party/customers/{customerId}/addresses/emailAddresses","fullPath":"/api/v5.6.0/party/customers/{customerId}/addresses/emailAddresses","operationId":"createCustomerEmailAddress","name":"Create customer email communication address with details such as customer name and email references.","summary":"Creates customer email communication address","tags":["RETAIL"],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"Identifier of the customer"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"customerShortNames":[{}],"email":"string","extensions":{}}},"responses":{"200":"CustomerEmailAddressResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/party/customers/{customerId}/addresses/printAddresses","fullPath":"/api/v5.6.0/party/customers/{customerId}/addresses/printAddresses","operationId":"getCustomerPrintAddress","name":"Retrieves the list of customer print communication addresses with details such as name, address, postcode and phone number.","summary":"Retrieves available list of customer print communication addresses","tags":["RETAIL"],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"Identifier of the customer"},{"name":"addressId","in":"query","type":"string","required":false,"description":"Reference Id of address record"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"CustomerPrintAddressResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"POST","path":"/party/customers/{customerId}/addresses/printAddresses","fullPath":"/api/v5.6.0/party/customers/{customerId}/addresses/printAddresses","operationId":"createCustomerPrintAddress","name":"Create customer print communication address with details such as name, address, postcode and phone number.","summary":"Creates customer print communication address","tags":["RETAIL"],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"Identifier of the customer"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"customerShortNames":[{}],"customerNames":[{}],"addresses":[{}],"streets":[{}],"towns":[{}],"postCodes":[{}],"addressPurpose":"string","addressLocation":"string","addressVerifier":"string","countryCode":"string","departmentId":"string","subDepartmentId":"string","flatNumber":"string","buildingName":"string","buildingNumber":"string"}},"responses":{"200":"CustomerPrintAddressResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/party/customers/addresses/{customerAddressId}/smsAddresses","fullPath":"/api/v5.6.0/party/customers/addresses/{customerAddressId}/smsAddresses","operationId":"updateCustomerPhoneAddress","name":"Update customer sms communication address with details such as name, idd prefix and mobile number.","summary":"Updates customer sms communication address","tags":["RETAIL"],"parameters":[{"name":"customerAddressId","in":"path","type":"string","required":true,"description":"Identifier of the customer address table."},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"customerShortNames":[{}],"iddPrefixMobile":"string","mobileNumber":"string","extensions":{}}},"responses":{"200":"CustomerPhoneAddressResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"DELETE","path":"/party/customers/addresses/{customerAddressId}/smsAddresses","fullPath":"/api/v5.6.0/party/customers/addresses/{customerAddressId}/smsAddresses","operationId":"deleteCustomerPhoneAddress","name":"Delete the specified customer sms communication address that are no longer used.","summary":"Deletes customer sms communication address","tags":["RETAIL"],"parameters":[{"name":"customerAddressId","in":"path","type":"string","required":true,"description":"Identifier of the customer address table."},{"name":"payload","in":"body","type":"object","required":false,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}}},"responses":{"200":"CustomerPhoneAddressResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/party/customers/addresses/{customerAddressId}/emailAddresses","fullPath":"/api/v5.6.0/party/customers/addresses/{customerAddressId}/emailAddresses","operationId":"updateCustomerEmailAddress","name":"Update customer email communication address with details such as customer name and email references.","summary":"Updates customer email communication address","tags":["RETAIL"],"parameters":[{"name":"customerAddressId","in":"path","type":"string","required":true,"description":"Identifier of the customer address table."},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"customerShortNames":[{}],"email":"string","extensions":{}}},"responses":{"200":"CustomerEmailAddressResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"DELETE","path":"/party/customers/addresses/{customerAddressId}/emailAddresses","fullPath":"/api/v5.6.0/party/customers/addresses/{customerAddressId}/emailAddresses","operationId":"deleteCustomerEmailAddress","name":"Delete the specified customer email communication address that are no longer used.","summary":"Deletes customer email communication address","tags":["RETAIL"],"parameters":[{"name":"customerAddressId","in":"path","type":"string","required":true,"description":"Identifier of the customer address table."},{"name":"payload","in":"body","type":"object","required":false,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}}},"responses":{"200":"CustomerEmailAddressResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/party/customers/addresses/{customerAddressId}/printAddresses","fullPath":"/api/v5.6.0/party/customers/addresses/{customerAddressId}/printAddresses","operationId":"updateCustomerPrintAddress","name":"Update customer print communication address with details such as name, address, postcode and phone number.","summary":"Updates customer print communication address","tags":["RETAIL"],"parameters":[{"name":"customerAddressId","in":"path","type":"string","required":true,"description":"Identifier of the customer address table."},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"customerShortNames":[{}],"customerNames":[{}],"addresses":[{}],"streets":[{}],"towns":[{}],"postCodes":[{}],"addressPurpose":"string","addressLocation":"string","addressVerifier":"string","countryCode":"string","departmentId":"string","subDepartmentId":"string","flatNumber":"string","buildingName":"string","buildingNumber":"string"}},"responses":{"200":"CustomerPrintAddressResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"DELETE","path":"/party/customers/addresses/{customerAddressId}/printAddresses","fullPath":"/api/v5.6.0/party/customers/addresses/{customerAddressId}/printAddresses","operationId":"deleteCustomerPrintAddress","name":"Delete the specified customer print communication address that are no longer used.","summary":"Deletes customer print communication address","tags":["RETAIL"],"parameters":[{"name":"customerAddressId","in":"path","type":"string","required":true,"description":"Identifier of the customer address table."},{"name":"payload","in":"body","type":"object","required":false,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}}},"responses":{"200":"CustomerPrintAddressResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/party/customers/{customerId}/consents","fullPath":"/api/v5.6.0/party/customers/{customerId}/consents","operationId":"getCustomerConsents","name":"Retrieves the list of consent details for specific customer","summary":"Retrieves customer consents details","tags":["RETAIL"],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"Identifier of the customer"},{"name":"propertyClassId","in":"query","type":"string","required":false,"description":"The identifier of a condition that is used to build a product"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"CustomerConsentsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"POST","path":"/party/customers/{customerId}/fatca","fullPath":"/api/v5.6.0/party/customers/{customerId}/fatca","operationId":"createFatcaCustomer","name":"Creates the FATCA customer supplementary information that stores the related FATCA details for the customer","summary":"Create FATCA customer supplementary information details","tags":["RETAIL"],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"Identifier of the customer"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"citizenships":[{}],"tinDetails":[{}],"Owner":[{}],"JointOwner":[{}],"fatcaClientType":"string","isPlaceOfBirthUs":"string","domicile":"string","greencardDetails":"string","residenceId":"string","isPoa":"string","standingInstructionOnUsAccount":"string","accountInstructionfromUs":"string","socialSecurityNumber":"string","phoneNumber":"string","isDormantAccount":"string"}},"responses":{"200":"FatcaCustomerResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/party/customers/{customerId}/fatca","fullPath":"/api/v5.6.0/party/customers/{customerId}/fatca","operationId":"updateFatcaCustomer","name":"Update the FATCA customer supplementary information that stores the related FATCA details for the customer","summary":"Update FATCA customer supplementary information details","tags":["RETAIL"],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"Identifier of the customer"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"citizenships":[{}],"tinDetails":[{}],"Owner":[{}],"JointOwner":[{}],"fatcaClientType":"string","isPlaceOfBirthUs":"string","domicile":"string","greencardDetails":"string","residenceId":"string","isPoa":"string","standingInstructionOnUsAccount":"string","accountInstructionfromUs":"string","socialSecurityNumber":"string","phoneNumber":"string","isDormantAccount":"string"}},"responses":{"200":"FatcaCustomerResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/party/customers/{customerId}/portfolios/{portfolioId}/overdueSettlements","fullPath":"/api/v5.6.0/party/customers/{customerId}/portfolios/{portfolioId}/overdueSettlements","operationId":"getOverdueSettlements","name":"Retrieves overdue settlements of customer or portfolio with details such as transaction reference, instrument reference , instrument name, depository and broker involved, trade date, trade currency, trade quantity, current customer and broker outstandings","summary":"Retrieves overdue settlements of customer or portfolio","tags":["RETAIL"],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"Identifier of the customer"},{"name":"portfolioId","in":"path","type":"string","required":true,"description":"Id of the portfolio or security account"},{"name":"transactionId","in":"query","type":"string","required":false,"description":"Unique transaction identifier for retrieving the details of the transaction. For example: FT0102030333 etc."},{"name":"brokerId","in":"query","type":"string","required":false,"description":"The identifier of the broker"},{"name":"tradeDate","in":"query","type":"string","required":false,"description":"Standard date field which records trade date of the account"},{"name":"valueDate","in":"query","type":"string","required":false,"description":"Indicates the value date on which the underlying accounting entry is to be given value (for interest purposes)"},{"name":"depository","in":"query","type":"string","required":false,"description":"Person designated as depository by the company in or pursuant to this Indenture, and, unless otherwise provided with respect to any security, any successor to such person"},{"name":"currency","in":"query","type":"string","required":false,"description":"Identifies the currency. E.g. USD, GBP etc"},{"name":"instrumentId","in":"query","type":"string","required":false,"description":"The identifier of the instrument"},{"name":"deliveryInstruction","in":"query","type":"string","required":false,"description":"Customer's directions to a bank as to the disposition of funds and securities in the customer's account"},{"name":"transactionType","in":"query","type":"string","required":false,"description":"Identifies the transaction type applicable to the transaction being processed, i.e. outward or inward payment. For example: ACPX, OTPX etc."},{"name":"quantity","in":"query","type":"string","required":false,"description":"The nominal quantity"},{"name":"stockExchange","in":"query","type":"string","required":false,"description":"Contains the stock exchange details where a particular security is usually dealt"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"OverdueSettlementsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/party/customers/accountServicingProviders","fullPath":"/api/v5.6.0/party/customers/accountServicingProviders","operationId":"getOtherBanksToConnectTo","name":"Retrieves the third party providers that are allowed to interact with the bank or entity with details such as global unique reference number, provider country,provider name and national competent authority register code","summary":"Retrieves details of third party providers","tags":["RETAIL"],"parameters":[{"name":"openBankingId","in":"query","type":"string","required":false,"description":"Identifies the open banking number of the customer"},{"name":"countryId","in":"query","type":"string","required":false,"description":"ISO country code of the financial institution. "},{"name":"setActive","in":"query","type":"string","required":false,"description":"Flag to set the connection status to active"},{"name":"status","in":"query","type":"string","required":false,"description":"Contains status of the data rights request.Allowed values are INITIATED, INPROGESS, EXTENDED, COMPLETED, REJECTED."},{"name":"extSourceProvider","in":"query","type":"string","required":false,"description":"Contains the name of the external source provider for the customer"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"OtherBanksToConnectToResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/party/customers/prospects","fullPath":"/api/v5.6.0/party/customers/prospects","operationId":"getProspectCustomers","name":"Retrieves the list of prospect customers with details such as contact information, residence details, personal details and prospect legal details","summary":"Retrieves prospect details of customers","tags":["RETAIL"],"parameters":[{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"ProspectCustomersResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"POST","path":"/party/customers/prospects","fullPath":"/api/v5.6.0/party/customers/prospects","operationId":"createProspectCustomer","name":"Create a prospect customer with basic details such as contact information, residence details and prospect legal details","summary":"Create a prospect customer","tags":["RETAIL"],"parameters":[{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"customerNames":[{}],"streets":[{}],"addresses":[{}],"townCountries":[{}],"postCodes":[{}],"countries":[{}],"phoneNumbers":[{}],"emails":[{}],"socialNetworkIds":[{}],"prospectLegalDetails":[{}],"personEntity":"string","departmentId":"string","subDepartmentId":"string","floorNumber":"string","locationName":"string"}},"responses":{"200":"ProspectCustomerResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/party/customers/{customerId}/opportunities","fullPath":"/api/v5.6.0/party/customers/{customerId}/opportunities","operationId":"getCustomerOpportunities","name":"Retrieves the details of sales opportunities such as score, status and product details which are likely to be of interest to specific customers","summary":"Retrieves the sales opportunities for specific customers","tags":["RETAIL"],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"Identifier of the customer"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"CustomerOpportunitiesResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/party/customers/{customerId}/requests","fullPath":"/api/v5.6.0/party/customers/{customerId}/requests","operationId":"getCustomerRequests","name":"Retrieves process workflow details such as process name, activity details and status for a specific customer","summary":"Retrieves process workflows for a specific customer","tags":["RETAIL"],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"Identifier of the customer"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"CustomerRequestsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"PUT","path":"/party/customers/prospects/{prospectId}","fullPath":"/api/v5.6.0/party/customers/prospects/{prospectId}","operationId":"updateProspectCustomer","name":"Update a prospect customer with basic details such as contact information, residence details and prospect legal details","summary":"Update a prospect customer","tags":["RETAIL"],"parameters":[{"name":"prospectId","in":"path","type":"string","required":true,"description":"Indicates the status of an onboarding customer. Status can be PROSPECT while onboarding and ACTIVE when the prospect becomes a Customer."},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"customerNames":[{}],"streets":[{}],"addresses":[{}],"townCountries":[{}],"postCodes":[{}],"countries":[{}],"phoneNumbers":[{}],"emails":[{}],"socialNetworkIds":[{}],"prospectLegalDetails":[{}],"personEntity":"string","departmentId":"string","subDepartmentId":"string","floorNumber":"string","locationName":"string"}},"responses":{"200":"ProspectCustomerResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/party/customers/{customerId}/alertRequests","fullPath":"/api/v5.6.0/party/customers/{customerId}/alertRequests","operationId":"getAlertRequests","name":"Retrieves the alert subscription details such as alert reference, alert name and condition for alerts of a customer","summary":"Retrieves alert requests details","tags":["RETAIL"],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"Identifier of the customer"},{"name":"contractReference","in":"query","type":"string","required":false,"description":"Contains the contract reference"},{"name":"subscribe","in":"query","type":"string","required":false,"description":"Enables an alert service"},{"name":"alertRequestId","in":"query","type":"string","required":false,"description":"The unique identifier of the alert request."},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"AlertRequestsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/party/relationships/{partyId}/relations","fullPath":"/api/v5.6.0/party/relationships/{partyId}/relations","operationId":"getPartyRelationship","name":"Retrieves the relationship details such as party name, type, relation code, status and owning percentage of customers involved in a relationship","summary":"Retrieves list of party relationship details","tags":["RETAIL"],"parameters":[{"name":"partyId","in":"path","type":"string","required":true,"description":"Allows capturing of customers or person entities to be part of the relationship. If partyType is selected as Customer, then the system will allow only customer Ids to be captured into this field. If p"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"PartyRelationshipResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"POST","path":"/party/customers/staticDataUpdateEvents","fullPath":"/api/v5.6.0/party/customers/staticDataUpdateEvents","operationId":"createCustomerStaticChange","name":"Create data log with details such as event name, event creation date and time for customer that has undergone static data updates from external party systems","summary":"Create log of customer static data update event from external party systems","tags":["RETAIL"],"parameters":[{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"creationDate":"string","requestTime":"string","eventName":"string","customerId":"string","extensions":{}}},"responses":{"200":"CustomerStaticChangeResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/party/customers/bankCodes/BICs/{bicId}/owners","fullPath":"/api/v5.6.0/party/customers/bankCodes/BICs/{bicId}/owners","operationId":"getBicOwners","name":"Returns the owner of the BIC and the channel through which this BIC is used. If a company code is returned without a customer ID this indicates the entity of the current financial institution. If a company code is returned along with a customer number, this indicates the customer identified by the respective BIC and the entity of the current financial institution that maintains the main relationship with the customer. The address type returned represent the context in which the BIC can be used.","summary":"Returns the owner of the BIC and the channel through which this BIC is used.","tags":["RETAIL"],"parameters":[{"name":"bicId","in":"path","type":"string","required":true,"description":"Bank Identifier Code (BIC) of the financial institution"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"BicOwnersResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"POST","path":"/party/customers/groupPurposes/{groupPurposeId}","fullPath":"/api/v5.6.0/party/customers/groupPurposes/{groupPurposeId}","operationId":"createCustomerGroupPurpose","name":"Allows creation of customer group purpose with details such as group purpose, type of group relationships - individual or group, allowed list of individual, aggregate and group relationships.","summary":"Allows creation of customer group purpose.","tags":["RETAIL"],"parameters":[{"name":"groupPurposeId","in":"path","type":"string","required":true,"description":"Identifier of customer group purpose"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"groupTypes":[{}],"description":"string","groupPurpose":"string","groupLevelUniqueCustomer":"string","allowGroupRelationship":"string","allowRelationship":"string","subGroupLevelUniqueCustomer":"string","extensions":{}}},"responses":{"200":"CustomerGroupPurposeResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/party/customers/groupPurposes/{groupPurposeId}","fullPath":"/api/v5.6.0/party/customers/groupPurposes/{groupPurposeId}","operationId":"updateCustomerGroupPurpose","name":"Allows amendment of customer group purpose with details such as group purpose, type of group relationships - individual or group, allowed list of individual, aggregate and group relationships","summary":"Allows amendment of customer group purpose","tags":["RETAIL"],"parameters":[{"name":"groupPurposeId","in":"path","type":"string","required":true,"description":"Identifier of customer group purpose"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"groupTypes":[{}],"description":"string","groupPurpose":"string","groupLevelUniqueCustomer":"string","allowGroupRelationship":"string","allowRelationship":"string","subGroupLevelUniqueCustomer":"string","extensions":{}}},"responses":{"200":"CustomerGroupPurposeResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"DELETE","path":"/party/customers/groupPurposes/{groupPurposeId}","fullPath":"/api/v5.6.0/party/customers/groupPurposes/{groupPurposeId}","operationId":"deleteCustomerGroupPurpose","name":"Allows deletion of unapproved customer group purpose that is no longer required","summary":"Allows deletion of unapproved customer group purpose","tags":["RETAIL"],"parameters":[{"name":"groupPurposeId","in":"path","type":"string","required":true,"description":"Identifier of customer group purpose"},{"name":"payload","in":"body","type":"object","required":false,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}}},"responses":{"200":"CustomerGroupPurposeResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/party/customers/groupPurposes/{groupPurposeId}/approvals","fullPath":"/api/v5.6.0/party/customers/groupPurposes/{groupPurposeId}/approvals","operationId":"approveCustomerGroupPurpose","name":"Allows authorization of customer group purpose with modified details such as type of group relationships - individual or group, allowed list of individual, aggregate and group relationships","summary":"Allows authorization of customer group purpose","tags":["RETAIL"],"parameters":[{"name":"groupPurposeId","in":"path","type":"string","required":true,"description":"Identifier of customer group purpose"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"CustomerGroupPurposeResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"DELETE","path":"/party/customers/groupPurposes/{groupPurposeId}/cancellations","fullPath":"/api/v5.6.0/party/customers/groupPurposes/{groupPurposeId}/cancellations","operationId":"cancelCustomerGroupPurpose","name":"Allows cancellations of approved customer group purpose that is no longer required","summary":"Allows cancellation of customer group purpose","tags":["RETAIL"],"parameters":[{"name":"groupPurposeId","in":"path","type":"string","required":true,"description":"Identifier of customer group purpose"},{"name":"payload","in":"body","type":"object","required":false,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}}},"responses":{"200":"CustomerGroupPurposeResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"POST","path":"/party/customers/groups/{groupId}","fullPath":"/api/v5.6.0/party/customers/groups/{groupId}","operationId":"createCustomerGroup","name":"Allows creation of customer group with details such as group name, purpose, group type, company reference, account officer, closure date, customer and their relationships that can be either individual or group, liability customer and the ownership percentage of each customers in the group","summary":"Allows creation of customer group","tags":["RETAIL"],"parameters":[{"name":"groupId","in":"path","type":"string","required":true,"description":"Unique ID of the group"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"relationshipDetails":[{}],"subGroupDetails":[{}],"primaryPartyDetails":[{}],"description":"string","groupName":"string","groupPurposeId":"string","groupType":"string","companyId":"string","accountOfficer":"string","closureDate":"string","liabilityNumber":"string","extensions":{}}},"responses":{"200":"CustomerGroupResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/party/customers/groups/{groupId}","fullPath":"/api/v5.6.0/party/customers/groups/{groupId}","operationId":"updateCustomerGroup","name":"Allows amendment of customer group with details such as group name, purpose, group type, company reference, account officer, closure date, customer and their relationships that can be either individual or group, liability customer and the ownership percentage of each customers in the group","summary":"Allows amendment of customer group","tags":["RETAIL"],"parameters":[{"name":"groupId","in":"path","type":"string","required":true,"description":"Unique ID of the group"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"relationshipDetails":[{}],"subGroupDetails":[{}],"primaryPartyDetails":[{}],"description":"string","groupName":"string","groupPurposeId":"string","groupType":"string","companyId":"string","accountOfficer":"string","closureDate":"string","liabilityNumber":"string","extensions":{}}},"responses":{"200":"CustomerGroupResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"DELETE","path":"/party/customers/groups/{groupId}","fullPath":"/api/v5.6.0/party/customers/groups/{groupId}","operationId":"deleteCustomerGroup","name":"Allows deletion of unapproved customer group that is no longer required","summary":"Allows deletion of unapproved customer group","tags":["RETAIL"],"parameters":[{"name":"groupId","in":"path","type":"string","required":true,"description":"Unique ID of the group"},{"name":"payload","in":"body","type":"object","required":false,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}}},"responses":{"200":"CustomerGroupResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/party/customers/groups/{groupId}/approvals","fullPath":"/api/v5.6.0/party/customers/groups/{groupId}/approvals","operationId":"approveCustomerGroup","name":"Allows authorization of customer group with details such as group name, purpose, group type, company reference, account officer, closure date, customer and their relationships that can be either individual or group, liability customer and the ownership percentage of each customers in the group","summary":"Allows authorization of customer group","tags":["RETAIL"],"parameters":[{"name":"groupId","in":"path","type":"string","required":true,"description":"Unique ID of the group"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"CustomerGroupResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/party/customers/groupPurposes/pendingApprovals","fullPath":"/api/v5.6.0/party/customers/groupPurposes/pendingApprovals","operationId":"getUnapprovedCustomerGroupPurpose","name":"Retrieves the list of unapproved customer group purposes with details such as group purpose, type of group relationships - individual or group, allowed list of individual, aggregate and group relationships","summary":"Retrieves the list of unapproved customer group purposes","tags":["RETAIL"],"parameters":[{"name":"groupPurposeId","in":"query","type":"string","required":false,"description":"Identifier of customer group purpose"},{"name":"groupPurpose","in":"query","type":"string","required":false,"description":"Indicates the type of customer group. Allowed values are RISK ,LIABILITY or Blank."},{"name":"groupLevelUniqueCustomer","in":"query","type":"string","required":false,"description":"Indicates whether customers in a group are to be restricted from being defined in another customer group with same group purpose. YES - will restrict the customer from being defined in another group, "},{"name":"allowGroupRelationship","in":"query","type":"string","required":false,"description":"Indicates whether group relations have to be defaulted in customer group from party relationship. Allowed values are YES, NO or Blank."},{"name":"allowRelationship","in":"query","type":"string","required":false,"description":"Indicates whether customer relations have to be defaulted in customer group from party relationship. Allowed values are YES, NO or Blank."},{"name":"subGroupLevelUniqueCustomer","in":"query","type":"string","required":false,"description":"Indicates whether a customer is allowed to be part of multiple sub groups. Allowed values are UNIQUE, MULTIPLE, NONE or Blank."},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"UnapprovedCustomerGroupPurposeResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/party/customers/groupPurposes","fullPath":"/api/v5.6.0/party/customers/groupPurposes","operationId":"getCustomerGroupPurpose","name":"Retrieves the list of customer group purposes with details such as group purpose, type of group relationships - individual or group, allowed list of individual, aggregate and group relationships","summary":"Retrieves the list of customer group purposes","tags":["RETAIL"],"parameters":[{"name":"groupPurposeId","in":"query","type":"string","required":false,"description":"Identifier of customer group purpose"},{"name":"groupPurpose","in":"query","type":"string","required":false,"description":"Indicates the type of customer group. Allowed values are RISK ,LIABILITY or Blank."},{"name":"groupLevelUniqueCustomer","in":"query","type":"string","required":false,"description":"Indicates whether customers in a group are to be restricted from being defined in another customer group with same group purpose. YES - will restrict the customer from being defined in another group, "},{"name":"allowGroupRelationship","in":"query","type":"string","required":false,"description":"Indicates whether group relations have to be defaulted in customer group from party relationship. Allowed values are YES, NO or Blank."},{"name":"allowRelationship","in":"query","type":"string","required":false,"description":"Indicates whether customer relations have to be defaulted in customer group from party relationship. Allowed values are YES, NO or Blank."},{"name":"subGroupLevelUniqueCustomer","in":"query","type":"string","required":false,"description":"Indicates whether a customer is allowed to be part of multiple sub groups. Allowed values are UNIQUE, MULTIPLE, NONE or Blank."},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"CustomerGroupPurposeResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/party/customers/groups/pendingApprovals","fullPath":"/api/v5.6.0/party/customers/groups/pendingApprovals","operationId":"getUnapprovedCustomerGroup","name":"Retrieves the list of unapproved customer group with details such as group name, purpose, group type, company reference, account officer, closure date, customer and their relationships that can be either individual or group, liability customer and the ownership percentage of each customers in the group","summary":"Retrieves the list of unapproved customer groups","tags":["RETAIL"],"parameters":[{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"UnapprovedCustomerGroupResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/party/customers/groups","fullPath":"/api/v5.6.0/party/customers/groups","operationId":"getCustomerGroups","name":"Retrieves list of customer groups or specified customer group with details such as group name, purpose, group type, company reference, account officer, closure date, customer and their relationships that can be either individual or group, liability customer and the ownership percentage of each customers in the group","summary":"Retrieves the details of customer group","tags":["RETAIL"],"parameters":[{"name":"groupId","in":"query","type":"string","required":false,"description":"Unique ID of the group"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"CustomerGroupsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/party/customers/customerClosures","fullPath":"/api/v5.6.0/party/customers/customerClosures","operationId":"getCustomerClosure","name":"Retrieves customer closure request with information such as customer id, exit status, exit reason , remarks, closure date and reopened date.","summary":"Retrieves customer closure request.","tags":["OTHERS"],"parameters":[{"name":"customerClosureId","in":"query","type":"string","required":false,"description":"Identifier of customer closure request."},{"name":"customerId","in":"query","type":"string","required":false,"description":"Identifier of the customer"},{"name":"requestStatus","in":"query","type":"string","required":false,"description":"The current status of the request. The possible values includes New, send to printer, cancelled and processed."},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"CustomerClosureResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"POST","path":"/party/customers/customerClosures","fullPath":"/api/v5.6.0/party/customers/customerClosures","operationId":"createCustomerClosure","name":"Creates customer closure request with information such as customer id, exit status, exit reason and remarks.","summary":"Creates customer closure request","tags":["OTHERS"],"parameters":[{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"customerId":"string","exitStatus":"string","exitReason":"string","remarks":"string","requestStatus":"string","exitDate":"string","reopenedDate":"string","extensions":{}}},"responses":{"200":"CustomerClosureResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/party/customers/customerClosures/{customerClosureId}","fullPath":"/api/v5.6.0/party/customers/customerClosures/{customerClosureId}","operationId":"updateCustomerClosure","name":"Update customer closure request with information such as exit status, exit reason and remarks.","summary":"Allows amendment of customer closure request","tags":["OTHERS"],"parameters":[{"name":"customerClosureId","in":"path","type":"string","required":true,"description":"Identifier of customer closure request."},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"customerId":"string","exitStatus":"string","exitReason":"string","remarks":"string","requestStatus":"string","exitDate":"string","reopenedDate":"string","extensions":{}}},"responses":{"200":"CustomerClosureResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}}]},{"key":"party-customers-contactHistory-v1.0.0","title":"Customer Contact Log","version":"v1.0.0","description":"Customer Contact Log","endpointCount":4,"endpoints":[{"method":"POST","path":"/party/customers/contactHistory","fullPath":"/api/v1.0.0/party/customers/contactHistory","operationId":"createCustomerContactLog","name":"","summary":"","tags":[],"parameters":[{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"query","type":"string","required":false,"description":""},{"name":"companyId","in":"query","type":"string","required":false,"description":""}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"notes":[{}],"staffs":[{}],"overrides":[{}],"customerId":"string","contactType":"string","contactStatus":"string","contactDescription":"string","contactChannel":"string","contactDate":"2024-01-01","contactTime":"string","companyId":"string","contactDirection":"string","customerMood":"string","isWalkInCustomer":"string","currNo":"string"}},"responses":{"200":"CustomerContactLogResponse","default":"ScreenErrorResponse"}},{"method":"GET","path":"/party/customers/contactHistory/{contactHistoryId}","fullPath":"/api/v1.0.0/party/customers/contactHistory/{contactHistoryId}","operationId":"getCustomerContactLog","name":"","summary":"","tags":[],"parameters":[{"name":"contactHistoryId","in":"path","type":"string","required":true,"description":""},{"name":"credentials","in":"query","type":"string","required":false,"description":""},{"name":"companyId","in":"query","type":"string","required":false,"description":""}],"requestBodyExample":null,"responses":{"200":"CustomerContactLogResponse","default":"ScreenErrorResponse"}},{"method":"PUT","path":"/party/customers/contactHistory/{contactHistoryId}","fullPath":"/api/v1.0.0/party/customers/contactHistory/{contactHistoryId}","operationId":"updateCustomerContactLog","name":"","summary":"","tags":[],"parameters":[{"name":"contactHistoryId","in":"path","type":"string","required":true,"description":""},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"query","type":"string","required":false,"description":""},{"name":"companyId","in":"query","type":"string","required":false,"description":""}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"notes":[{}],"staffs":[{}],"overrides":[{}],"customerId":"string","contactType":"string","contactStatus":"string","contactDescription":"string","contactChannel":"string","contactDate":"2024-01-01","contactTime":"string","companyId":"string","contactDirection":"string","customerMood":"string","isWalkInCustomer":"string","currNo":"string"}},"responses":{"200":"CustomerContactLogResponse","default":"ScreenErrorResponse"}},{"method":"GET","path":"/party/customers/{customerId}/contactHistory","fullPath":"/api/v1.0.0/party/customers/{customerId}/contactHistory","operationId":"getCustomerContactHistory","name":"","summary":"","tags":[],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"The identifier of the customer"},{"name":"staffId","in":"query","type":"string","required":false,"description":""},{"name":"date","in":"query","type":"string","required":false,"description":""},{"name":"type","in":"query","type":"string","required":false,"description":"Activity Type"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from t24 on every enquiry request."},{"name":"credentials","in":"query","type":"string","required":false,"description":""},{"name":"companyId","in":"query","type":"string","required":false,"description":""}],"requestBodyExample":null,"responses":{"200":"CustomerContactHistoryResponse","default":"QueryErrorResponse"}}]},{"key":"party-customers-documents-service-v1.0.0","title":"Customer documents and images","version":"v1.0.0","description":"Allows the creation, viewing and management of customer documents and images.","endpointCount":16,"endpoints":[{"method":"GET","path":"/party/customers/{customerId}/documents","fullPath":"/api/v1.0.0/party/customers/{customerId}/documents","operationId":"getCustomerDocuments","name":"Retrieves Customer Documents","summary":"Retrieves Customer Documents","tags":[],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"Identifier of the customer"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from t24 on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"CustomerDocumentsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/party/customers/{customerId}/images/{imageId}","fullPath":"/api/v1.0.0/party/customers/{customerId}/images/{imageId}","operationId":"getDocumentImage","name":"Retrieves Document Image","summary":"Retrieves Document Image","tags":[],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":""},{"name":"imageId","in":"path","type":"string","required":true,"description":"A system generated unique identifier for the image record"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"DocumentImageResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/party/customers/{customerId}/images/{imageId}","fullPath":"/api/v1.0.0/party/customers/{customerId}/images/{imageId}","operationId":"updateDocumentImage","name":"Updates Document Images","summary":"Updates Document Images","tags":[],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"Identifier of the customer"},{"name":"imageId","in":"path","type":"string","required":true,"description":"A system generated unique identifier for the image record"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"description":[{}],"imageType":"string","imageApplication":"string","companyMnemonic":"string","displayName":"string","mediaType":"IMAGE"}},"responses":{"200":"DocumentImageResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/party/customers/{customerId}/images","fullPath":"/api/v1.0.0/party/customers/{customerId}/images","operationId":"getCustomerImages","name":"Retrieves Customer Images","summary":"Retrieves Customer Images","tags":[],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"Identifier of the customer"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from t24 on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"CustomerImagesResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"POST","path":"/party/customers/{customerId}/images","fullPath":"/api/v1.0.0/party/customers/{customerId}/images","operationId":"createDocumentImage","name":"Create document status for tracking","summary":"Create document status for tracking","tags":[],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"Identifier of the customer"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"description":[{}],"imageType":"string","imageApplication":"string","companyMnemonic":"string","displayName":"string","mediaType":"IMAGE"}},"responses":{"200":"DocumentImageResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/party/customers/documents/{customerDocumentId}/status","fullPath":"/api/v1.0.0/party/customers/documents/{customerDocumentId}/status","operationId":"getCustomerDocument","name":"Retrieves document tracking status","summary":"Retrieves document tracking status","tags":[],"parameters":[{"name":"customerDocumentId","in":"path","type":"string","required":true,"description":"Defines the unique identifier for the customer document"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from t24 on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"CustomerDocumentResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"POST","path":"/party/customers/documents/{customerDocumentId}/status","fullPath":"/api/v1.0.0/party/customers/documents/{customerDocumentId}/status","operationId":"createCustomerDocument","name":"Create document status for tracking","summary":"Create document status for tracking","tags":[],"parameters":[{"name":"customerDocumentId","in":"path","type":"string","required":true,"description":"Defines the unique identifier for the customer document"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"referenceNumber":"string","status":"string","statusDate":"string","endDate":"string","documentSequence":"string","documentNature":"string"}},"responses":{"200":"CustomerDocumentResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/party/customers/documents/{customerDocumentId}/status","fullPath":"/api/v1.0.0/party/customers/documents/{customerDocumentId}/status","operationId":"amendCustomerDocument","name":"Update current document status","summary":"Update current document status","tags":[],"parameters":[{"name":"customerDocumentId","in":"path","type":"string","required":true,"description":"Defines the unique identifier for the customer document"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"referenceNumber":"string","status":"string","statusDate":"string","endDate":"string","documentSequence":"string","documentNature":"string"}},"responses":{"200":"CustomerDocumentResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"DELETE","path":"/party/customers/documents/{customerDocumentId}/status","fullPath":"/api/v1.0.0/party/customers/documents/{customerDocumentId}/status","operationId":"deleteCustomerDocument","name":"Delete document status","summary":"Delete document status","tags":[],"parameters":[{"name":"customerDocumentId","in":"path","type":"string","required":true,"description":"Defines the unique identifier for the customer document"},{"name":"payload","in":"body","type":"object","required":false,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}}},"responses":{"200":"CustomerDocumentResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/party/customers/documents/{documentId}","fullPath":"/api/v1.0.0/party/customers/documents/{documentId}","operationId":"updateDocumentandImage","name":"Update document and image details","summary":"Update an existing document/image record for specific document id","tags":[],"parameters":[{"name":"documentId","in":"path","type":"string","required":true,"description":"Based on documentCode, the field defaults the required document codes"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"descriptions":[{}],"imageType":"string","imageApplication":"string","companyMnemonic":"string","imageReference":"string","displayName":"string","multiMediaType":"string","imagePath":"string","notes":"string"}},"responses":{"200":"DocumentandImageResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"DELETE","path":"/party/customers/documents/{documentId}","fullPath":"/api/v1.0.0/party/customers/documents/{documentId}","operationId":"deleteDocumentandImage","name":"Remove document and image","summary":"Remove document/image for specific document id","tags":[],"parameters":[{"name":"documentId","in":"path","type":"string","required":true,"description":"Based on documentCode, the field defaults the required document codes"},{"name":"payload","in":"body","type":"object","required":false,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}}},"responses":{"200":"DocumentandImageResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"POST","path":"/party/customers/documents/fileUploads/{uploadId}","fullPath":"/api/v1.0.0/party/customers/documents/fileUploads/{uploadId}","operationId":"createProfilePictureUpload","name":"Create profile picture upload","summary":"Initiate a new profile picture upload request for a customer","tags":[],"parameters":[{"name":"uploadId","in":"path","type":"string","required":true,"description":"The unique identifier of the uploaded file"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"uploadId":"string","fileUpload":"string"}},"responses":{"200":"ProfilePictureUploadResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/party/customers/documents/fileUploads/{uploadId}","fullPath":"/api/v1.0.0/party/customers/documents/fileUploads/{uploadId}","operationId":"updateProfilePictureUpload","name":"Update profile picture upload details","summary":"Update an existing uploaded profile picture record for a customer","tags":[],"parameters":[{"name":"uploadId","in":"path","type":"string","required":true,"description":"The unique identifier of the uploaded file"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"uploadId":"string","fileUpload":"string"}},"responses":{"200":"ProfilePictureUploadResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"DELETE","path":"/party/customers/documents/fileUploads/{uploadId}","fullPath":"/api/v1.0.0/party/customers/documents/fileUploads/{uploadId}","operationId":"deleteProfilePictureUpload","name":"Remove profile picture upload","summary":"Remove an existing profile picture record for a customer","tags":[],"parameters":[{"name":"uploadId","in":"path","type":"string","required":true,"description":"The unique identifier of the uploaded file"},{"name":"payload","in":"body","type":"object","required":false,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}}},"responses":{"200":"ProfilePictureUploadResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"POST","path":"/party/customers/documents","fullPath":"/api/v1.0.0/party/customers/documents","operationId":"createDocumentandImage","name":"Retrieves document and Images details","summary":"Initiate a new request for document and image","tags":[],"parameters":[{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"descriptions":[{}],"imageType":"string","imageApplication":"string","companyMnemonic":"string","imageReference":"string","displayName":"string","multiMediaType":"string","imagePath":"string","notes":"string"}},"responses":{"200":"DocumentandImageResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/party/customers/images/{imageReference}","fullPath":"/api/v1.0.0/party/customers/images/{imageReference}","operationId":"getDocumentandImages","name":"Retrieves document and Images details","summary":"Retrieves the list of image records for specific id","tags":[],"parameters":[{"name":"imageReference","in":"path","type":"string","required":true,"description":"Indicates the reference no. E.g. contract no./customer no./payments no. to which the image/document is attached to"},{"name":"imageApplication","in":"query","type":"string","required":false,"description":"Indicates the domain name (technical identifier) the image/document is attached to. E.g., Customer, Payments, Loans, Deposits, etc..,"},{"name":"imageType","in":"query","type":"string","required":false,"description":"Indicates the internal classification of images - such as Photographs, Documents, Passports, etc..,"},{"name":"imageReferenceId","in":"query","type":"string","required":false,"description":"Contains the identifier associated to the image reference"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from t24 on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"DocumentandImagesResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}}]},{"key":"party-customers-documents-service-v1.0.1","title":"Customer documents and images","version":"v1.0.1","description":"Allows the creation, viewing and management of customer documents and images.","endpointCount":17,"endpoints":[{"method":"GET","path":"/party/customers/{customerId}/images/{imageId}","fullPath":"/api/v1.0.1/party/customers/{customerId}/images/{imageId}","operationId":"getDocumentImage","name":"Retrieves Document Image","summary":"Retrieves Document Image","tags":[],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"Identifier of the customer"},{"name":"imageId","in":"path","type":"string","required":true,"description":"A system generated unique identifier for the image record"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"DocumentImageResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/party/customers/{customerId}/images/{imageId}","fullPath":"/api/v1.0.1/party/customers/{customerId}/images/{imageId}","operationId":"updateDocumentImage","name":"Updates Document Images","summary":"Updates Document Images","tags":[],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"Identifier of the customer"},{"name":"imageId","in":"path","type":"string","required":true,"description":"A system generated unique identifier for the image record"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"description":[{}],"imageType":"string","imageApplication":"string","companyMnemonic":"string","displayName":"string","mediaType":"IMAGE"}},"responses":{"200":"DocumentImageResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/party/customers/{customerId}/images","fullPath":"/api/v1.0.1/party/customers/{customerId}/images","operationId":"getCustomerImages","name":"Retrieves Customer Images","summary":"Retrieves Customer Images","tags":[],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"Identifier of the customer"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from t24 on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"CustomerImagesResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"POST","path":"/party/customers/{customerId}/images","fullPath":"/api/v1.0.1/party/customers/{customerId}/images","operationId":"createDocumentImage","name":"create document images","summary":"create document images","tags":[],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"Identifier of the customer"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"description":[{}],"imageType":"string","imageApplication":"string","companyMnemonic":"string","displayName":"string","mediaType":"IMAGE"}},"responses":{"200":"DocumentImageResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/party/customers/documents/{customerDocumentId}/status","fullPath":"/api/v1.0.1/party/customers/documents/{customerDocumentId}/status","operationId":"getCustomerDocument","name":"Retrieves document tracking status including status of the document whether received or not,the date on which it is recieved and the expiry date of the document and nature of the document.","summary":"Retrieves document tracking status","tags":[],"parameters":[{"name":"customerDocumentId","in":"path","type":"string","required":true,"description":"Defines the unique identifier for the customer document"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from t24 on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"CustomerDocumentResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"POST","path":"/party/customers/documents/{customerDocumentId}/status","fullPath":"/api/v1.0.1/party/customers/documents/{customerDocumentId}/status","operationId":"createCustomerDocument","name":"Create document status for tracking","summary":"Create document status for tracking","tags":[],"parameters":[{"name":"customerDocumentId","in":"path","type":"string","required":true,"description":"Defines the unique identifier for the customer document"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"referenceNumber":"string","status":"string","statusDate":"string","endDate":"string","documentSequence":"string","documentNature":"string"}},"responses":{"200":"CustomerDocumentResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/party/customers/documents/{customerDocumentId}/status","fullPath":"/api/v1.0.1/party/customers/documents/{customerDocumentId}/status","operationId":"amendCustomerDocument","name":"Update current document status","summary":"Update current document status","tags":[],"parameters":[{"name":"customerDocumentId","in":"path","type":"string","required":true,"description":"Defines the unique identifier for the customer document"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"referenceNumber":"string","status":"string","statusDate":"string","endDate":"string","documentSequence":"string","documentNature":"string"}},"responses":{"200":"CustomerDocumentResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"DELETE","path":"/party/customers/documents/{customerDocumentId}/status","fullPath":"/api/v1.0.1/party/customers/documents/{customerDocumentId}/status","operationId":"deleteCustomerDocument","name":"Delete document status","summary":"Delete document status","tags":[],"parameters":[{"name":"customerDocumentId","in":"path","type":"string","required":true,"description":"Defines the unique identifier for the customer document"},{"name":"payload","in":"body","type":"object","required":false,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}}},"responses":{"200":"CustomerDocumentResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/party/customers/{customerId}/documents","fullPath":"/api/v1.0.1/party/customers/{customerId}/documents","operationId":"getCustomerDocuments","name":"Retrieves the document image details which includes document type,path where it is stored,date on which it is received and last updated.","summary":"Retrieves the document image details","tags":[],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"Identifier of the customer"},{"name":"imageApplication","in":"query","type":"string","required":false,"description":"Indicates the domain name (technical identifier) the image/document is attached to. E.g., Customer, Payments, Loans, Deposits, etc..,"},{"name":"imageType","in":"query","type":"string","required":false,"description":"Indicates the internal classification of images - such as Photographs, Documents, Passports, etc..,"},{"name":"imageReferenceId","in":"query","type":"string","required":false,"description":"Contains the identifier associated to the image reference"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from t24 on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"CustomerDocumentsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/party/customers/documents/locations","fullPath":"/api/v1.0.1/party/customers/documents/locations","operationId":"getDocumentsLocation","name":"Retrieves document location for particular image type","summary":"Retrieves document location","tags":[],"parameters":[{"name":"imageType","in":"query","type":"string","required":false,"description":"Indicates the internal classification of images - such as Photographs, Documents, Passports, etc..,"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from t24 on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"DocumentsLocationResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/party/customers/images/{imageReference}","fullPath":"/api/v1.0.1/party/customers/images/{imageReference}","operationId":"getDocumentandImages","name":"Retrieves document and Images details","summary":"Retrieves the list of image records for specific id","tags":[],"parameters":[{"name":"imageReference","in":"path","type":"string","required":true,"description":"Indicates the reference no. E.g. contract no./customer no./payments no. to which the image/document is attached to"},{"name":"imageApplication","in":"query","type":"string","required":false,"description":"Indicates the domain name (technical identifier) the image/document is attached to. E.g., Customer, Payments, Loans, Deposits, etc..,"},{"name":"imageType","in":"query","type":"string","required":false,"description":"Indicates the internal classification of images - such as Photographs, Documents, Passports, etc..,"},{"name":"imageReferenceId","in":"query","type":"string","required":false,"description":"Contains the identifier associated to the image reference"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from t24 on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"DocumentandImagesResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"POST","path":"/party/customers/documents/fileUploads/{uploadId}","fullPath":"/api/v1.0.1/party/customers/documents/fileUploads/{uploadId}","operationId":"createProfilePictureUpload","name":"Create profile picture upload","summary":"Initiate a new profile picture upload request for a customer","tags":[],"parameters":[{"name":"uploadId","in":"path","type":"string","required":true,"description":"The unique identifier of the uploaded file"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"uploadId":"string","fileUpload":"string"}},"responses":{"200":"ProfilePictureUploadResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/party/customers/documents/fileUploads/{uploadId}","fullPath":"/api/v1.0.1/party/customers/documents/fileUploads/{uploadId}","operationId":"updateProfilePictureUpload","name":"Update profile picture upload details","summary":"Update an existing uploaded profile picture record for a customer","tags":[],"parameters":[{"name":"uploadId","in":"path","type":"string","required":true,"description":"The unique identifier of the uploaded file"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"uploadId":"string","fileUpload":"string"}},"responses":{"200":"ProfilePictureUploadResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"DELETE","path":"/party/customers/documents/fileUploads/{uploadId}","fullPath":"/api/v1.0.1/party/customers/documents/fileUploads/{uploadId}","operationId":"deleteProfilePictureUpload","name":"Remove profile picture upload","summary":"Remove an existing profile picture record fo","tags":[],"parameters":[{"name":"uploadId","in":"path","type":"string","required":true,"description":"The unique identifier of the uploaded file"},{"name":"payload","in":"body","type":"object","required":false,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}}},"responses":{"200":"ProfilePictureUploadResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"POST","path":"/party/customers/documents","fullPath":"/api/v1.0.1/party/customers/documents","operationId":"createDocumentandImage","name":"Retrieves document and Images details","summary":"Initiate a new request for document and image","tags":[],"parameters":[{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"descriptions":[{}],"imageType":"string","imageApplication":"string","companyMnemonic":"string","imageReference":"string","displayName":"string","multiMediaType":"string","imagePath":"string","notes":"string"}},"responses":{"200":"DocumentandImageResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/party/customers/documents/{documentId}","fullPath":"/api/v1.0.1/party/customers/documents/{documentId}","operationId":"updateDocumentandImage","name":"Update document and image details","summary":"Update an existing document/image record for specific document id","tags":[],"parameters":[{"name":"documentId","in":"path","type":"string","required":true,"description":"Based on documentCode, the field defaults the required document codes"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"descriptions":[{}],"imageType":"string","imageApplication":"string","companyMnemonic":"string","imageReference":"string","displayName":"string","multiMediaType":"string","imagePath":"string","notes":"string"}},"responses":{"200":"DocumentandImageResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"DELETE","path":"/party/customers/documents/{documentId}","fullPath":"/api/v1.0.1/party/customers/documents/{documentId}","operationId":"deleteDocumentandImage","name":"Remove document and image","summary":"Remove document/image for specific document id","tags":[],"parameters":[{"name":"documentId","in":"path","type":"string","required":true,"description":"Based on documentCode, the field defaults the required document codes"},{"name":"payload","in":"body","type":"object","required":false,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}}},"responses":{"200":"DocumentandImageResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}}]},{"key":"party-customers-messages-service-v1.0.0","title":"Party Customers Messages APIs Deprecated","version":"v1.0.0","description":"Allows the creation, viewing and management of messages to and from customers.","endpointCount":7,"endpoints":[{"method":"GET","path":"/party/customers/secureMessages/{messageId}","fullPath":"/api/v1.0.0/party/customers/secureMessages/{messageId}","operationId":"getMessage","name":"Retrieves the secure message by message id - Deprecated. party-customers-messages-service-v1.1.0 instead","summary":"Retrieves the secure message","tags":[],"parameters":[{"name":"messageId","in":"path","type":"string","required":true,"description":"The holds the record key of the message ID."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"MessageResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/party/customers/secureMessages/{messageId}","fullPath":"/api/v1.0.0/party/customers/secureMessages/{messageId}","operationId":"updateMessage","name":"Update secure message for the customer - Deprecated. party-customers-messages-service-v1.1.0 instead","summary":"Update secure message","tags":[],"parameters":[{"name":"messageId","in":"path","type":"string","required":true,"description":"The holds the record key of the message ID."},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"messages":[{}],"subject":"string","parentMessageId":"string","fromCustomerId":"string","messageStatus":"string","toAccountOfficerId":"string","uploadId":"string","uploadPath":"string"}},"responses":{"200":"MessageResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/party/customers/{customerId}/secureMessages/{messageId}","fullPath":"/api/v1.0.0/party/customers/{customerId}/secureMessages/{messageId}","operationId":"getMessageByCustomer","name":"Retrieves secure messages for the customer - Deprecated. party-customers-messages-service-v1.1.0 instead","summary":"Retrieves secure messages","tags":[],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":""},{"name":"messageId","in":"path","type":"string","required":true,"description":"The holds the record key of the message ID."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"MessageByCustomerResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/party/customers/{customerId}/secureMessages/{messageId}","fullPath":"/api/v1.0.0/party/customers/{customerId}/secureMessages/{messageId}","operationId":"updateMessageByCustomer","name":"Updates the secure message by the customer id - Deprecated. party-customers-messages-service-v1.1.0 instead","summary":"Updates the secure message","tags":[],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"Identifier of the customer"},{"name":"messageId","in":"path","type":"string","required":true,"description":"The holds the record key of the message ID."},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"messages":[{}],"subject":"string","parentMessageId":"string","fromCustomerId":"string","messageStatus":"string","toAccountOfficerId":"string","uploadId":"string","uploadPath":"string"}},"responses":{"200":"MessageByCustomerResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"POST","path":"/party/customers/secureMessages","fullPath":"/api/v1.0.0/party/customers/secureMessages","operationId":"createMessage","name":"Creates secure message for the customer - Deprecated. party-customers-messages-service-v1.1.0 instead","summary":"This API is used to create secure message ","tags":[],"parameters":[{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"messages":[{}],"subject":"string","parentMessageId":"string","fromCustomerId":"string","messageStatus":"string","toAccountOfficerId":"string","uploadId":"string","uploadPath":"string"}},"responses":{"200":"MessageResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/party/customers/{customerId}/secureMessages","fullPath":"/api/v1.0.0/party/customers/{customerId}/secureMessages","operationId":"getSecureMessagesForCustomer","name":"Retrieves secure messages for the customer - Deprecated. party-customers-messages-service-v1.1.0 instead","summary":"Retrieves secure messages ","tags":[],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"Identifier of the customer"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"SecureMessagesForCustomerResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"POST","path":"/party/customers/{customerId}/secureMessages","fullPath":"/api/v1.0.0/party/customers/{customerId}/secureMessages","operationId":"createMessageForCustomer","name":"Creates the secure message for the customer - Deprecated. party-customers-messages-service-v1.1.0 instead","summary":"This API is used to create the secure message","tags":[],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"Identifier of the customer"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"messages":[{}],"subject":"string","parentMessageId":"string","fromCustomerId":"string","messageStatus":"string","toAccountOfficerId":"string","uploadId":"string","uploadPath":"string"}},"responses":{"200":"MessageForCustomerResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}}]},{"key":"party-customers-messages-service-v1.1.0","title":"Customer secure messages","version":"v1.1.0","description":"Allows the creation, viewing and management of messages to and from customers.","endpointCount":9,"endpoints":[{"method":"GET","path":"/party/customers/secureMessages/{messageId}","fullPath":"/api/v1.1.0/party/customers/secureMessages/{messageId}","operationId":"getMessage","name":"Retrieves the secure message by message id","summary":"Retrieves the secure message","tags":[],"parameters":[{"name":"messageId","in":"path","type":"string","required":true,"description":"The holds the record key of the message ID."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"MessageResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/party/customers/secureMessages/{messageId}","fullPath":"/api/v1.1.0/party/customers/secureMessages/{messageId}","operationId":"updateMessage","name":"Update secure message for the customer","summary":"Update secure message","tags":[],"parameters":[{"name":"messageId","in":"path","type":"string","required":true,"description":"The holds the record key of the message ID."},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"messages":[{}],"subject":"string","parentMessageId":"string","fromCustomerId":"string","messageStatus":"string","toAccountOfficerId":"string","uploadId":"string","uploadPath":"string"}},"responses":{"200":"MessageResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/party/customers/{customerId}/secureMessages/{messageId}","fullPath":"/api/v1.1.0/party/customers/{customerId}/secureMessages/{messageId}","operationId":"getMessageByCustomer","name":"Retrieves secure messages for the customer","summary":"Retrieves secure messages","tags":[],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":""},{"name":"messageId","in":"path","type":"string","required":true,"description":"The holds the record key of the message ID."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"MessageByCustomerResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/party/customers/{customerId}/secureMessages/{messageId}","fullPath":"/api/v1.1.0/party/customers/{customerId}/secureMessages/{messageId}","operationId":"updateMessageByCustomer","name":"Updates the secure message by the customer id","summary":"Updates the secure message","tags":[],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"Identifier of the customer"},{"name":"messageId","in":"path","type":"string","required":true,"description":"The holds the record key of the message ID."},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"messages":[{}],"subject":"string","parentMessageId":"string","fromCustomerId":"string","messageStatus":"string","toAccountOfficerId":"string","uploadId":"string","uploadPath":"string"}},"responses":{"200":"MessageByCustomerResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/party/customers/secureMessages","fullPath":"/api/v1.1.0/party/customers/secureMessages","operationId":"getSecureMessages","name":"Retrieves secure messages details","summary":"Retrieves the list of messages from Bank to Customer and from customer to Bank","tags":[],"parameters":[{"name":"messageId","in":"query","type":"string","required":false,"description":"The holds the record key of the message ID."},{"name":"parentMessageId","in":"query","type":"string","required":false,"description":"Identifier of the parent message."},{"name":"parentMessageIdNE","in":"query","type":"string","required":false,"description":"Parent message id not equal to"},{"name":"toCustomerId","in":"query","type":"string","required":false,"description":"The unique customer identifier of the Payee, to whom the payment message is to be sent"},{"name":"fromCustomerId","in":"query","type":"string","required":false,"description":"The Customer ID from which the message is triggered."},{"name":"messageStatus","in":"query","type":"string","required":false,"description":"Status of the message"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"SecureMessagesResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"POST","path":"/party/customers/secureMessages","fullPath":"/api/v1.1.0/party/customers/secureMessages","operationId":"createSecureMessage","name":"Create secure message","summary":"Initiate a new secure message by customer to bank","tags":[],"parameters":[{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"messages":[{}],"subject":"string","parentMessageId":"string","fromCustomerId":"string","messageStatus":"string","toDepartmentId":"string","uploadId":"string","uploadPath":"string"}},"responses":{"200":"SecureMessageResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/party/customers/{customerId}/secureMessages","fullPath":"/api/v1.1.0/party/customers/{customerId}/secureMessages","operationId":"getSecureMessagesForCustomer","name":"Retrieves the list of bank initiated secure messages for the customer","summary":"Retrieves secure messages ","tags":[],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"Identifier of the customer"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"SecureMessagesForCustomerResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"POST","path":"/party/customers/{customerId}/secureMessages","fullPath":"/api/v1.1.0/party/customers/{customerId}/secureMessages","operationId":"createMessageForCustomer","name":"Creates the secure message for the customer","summary":"This API is used to create the secure message","tags":[],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"Identifier of the customer"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"messages":[{}],"subject":"string","parentMessageId":"string","fromCustomerId":"string","messageStatus":"string","toAccountOfficerId":"string","uploadId":"string","uploadPath":"string"}},"responses":{"200":"MessageForCustomerResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/party/customers/secureMessages/{secureMessageId}","fullPath":"/api/v1.1.0/party/customers/secureMessages/{secureMessageId}","operationId":"readSecureMessage","name":"Read secure message details","summary":"Retrieves the secure message details for a specific message id","tags":[],"parameters":[{"name":"secureMessageId","in":"path","type":"string","required":true,"description":"Contains the usable amount in the balance"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"SecureMessageResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}}]},{"key":"party-customers-opportunities-v1.0.0","title":"Opportunities","version":"v1.0.0","description":"Opportunities","endpointCount":1,"endpoints":[{"method":"GET","path":"/party/customers/{customerId}/opportunities","fullPath":"/api/v1.0.0/party/customers/{customerId}/opportunities","operationId":"getCustomerOpportunities","name":"Use \"/party/customers/{customerId}/opportunities\" as URI from party-customerServices-v4.0.0","summary":"","tags":[],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"Identifier of the customer"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from t24 on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"CustomerOpportunitiesResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}}]},{"key":"party-customers-requests-v1.0.0","title":"Customer Requests","version":"v1.0.0","description":"Customer Requests","endpointCount":1,"endpoints":[{"method":"GET","path":"/party/customers/{customerId}/requests","fullPath":"/api/v1.0.0/party/customers/{customerId}/requests","operationId":"getCustomerRequests","name":"Use \"/party/customers/{customerId}/requests\" as URI from party-customerServices-v4.0.0","summary":"","tags":[],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"Identifier of the customer"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from t24 on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"CustomerRequestsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}}]},{"key":"party-customers-service-v1.0.0","title":"Party Customers APIs","version":"v1.0.0","description":"Allows the creation, viewing and management of customers.","endpointCount":4,"endpoints":[{"method":"GET","path":"/party/customers/{customerId}/contactDetails","fullPath":"/api/v1.0.0/party/customers/{customerId}/contactDetails","operationId":"getCustomerContactDetails","name":"Retrieves customer contact details.Use \"/party/customers/{customerId}/contacts\" as URI from party-customerServices-v4.0.0","summary":"Retrieves the list of contact details(Email/Phone) for specific customer","tags":[],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"Identifier of the customer"},{"name":"customerName","in":"query","type":"string","required":false,"description":"Name of the customer"},{"name":"street","in":"query","type":"string","required":false,"description":"Contains the first line of customer's base address, example building number, street number etc."},{"name":"town","in":"query","type":"string","required":false,"description":"Contains the name of the town in which the travel has taken place"},{"name":"countryId","in":"query","type":"string","required":false,"description":"ISO country code of the financial institution. "},{"name":"postcode","in":"query","type":"string","required":false,"description":"Identifies the address postal code for the customer."},{"name":"dateOfBirth","in":"query","type":"string","required":false,"description":"The date of birth of an individual customer"},{"name":"customerStatus","in":"query","type":"string","required":false,"description":"The internal bank status of a customer"},{"name":"customerType","in":"query","type":"string","required":false,"description":"Contains the type of customer, for example ACTIVE, PROSPECT."},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from t24 on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"CustomerContactDetailsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"PUT","path":"/party/customers/{customerId}/contactDetails","fullPath":"/api/v1.0.0/party/customers/{customerId}/contactDetails","operationId":"updateCustomerContactDetail","name":"Update customer contact details.Use \"/party/customers/{customerId}\" as URI from party-customerServices-v4.0.0","summary":"Updates the contact details for specific customer","tags":[],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"Identifier of the customer"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"contactDetails":[{}],"officePhoneNumbers":[{}],"faxNumbers":[{}],"overrides":[{}],"addressDetails":[{}],"street":"string","addressCity":"string","postCode":"string","country":"string"}},"responses":{"200":"CustomerContactDetailResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/party/customers/{customerId}/portfolios/{portfolioId}/overdueSettlements","fullPath":"/api/v1.0.0/party/customers/{customerId}/portfolios/{portfolioId}/overdueSettlements","operationId":"getOverdueSettlements","name":"Get Overdue settlement.Use \"/party/customers/{customerId}/portfolios/{portfolioId}/overdueSettlements\" as URI from party-customerServices-v4.0.0","summary":"Get Overdue settlement","tags":[],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"Identifier of the customer"},{"name":"portfolioId","in":"path","type":"string","required":true,"description":"Id of the portfolio or security account"},{"name":"transactionId","in":"query","type":"string","required":false,"description":"Unique transaction identifier for retrieving the details of the transaction. For example: FT0102030333 etc."},{"name":"brokerId","in":"query","type":"string","required":false,"description":"The identifier of the broker"},{"name":"tradeDate","in":"query","type":"string","required":false,"description":"Standard date field which records trade date of the account"},{"name":"valueDate","in":"query","type":"string","required":false,"description":"Indicates the value date on which the underlying accounting entry is to be given value (for interest purposes)"},{"name":"depository","in":"query","type":"string","required":false,"description":"Person designated as depository by the company in or pursuant to this Indenture, and, unless otherwise provided with respect to any security, any successor to such person"},{"name":"currency","in":"query","type":"string","required":false,"description":"Identifies the currency. E.g. USD, GBP etc"},{"name":"instrumentId","in":"query","type":"string","required":false,"description":"The identifier of the instrument"},{"name":"deliveryInstruction","in":"query","type":"string","required":false,"description":"Customer's directions to a bank as to the disposition of funds and securities in the customer's account"},{"name":"transactionType","in":"query","type":"string","required":false,"description":"Identifies the transaction type applicable to the transaction being processed, i.e. outward or inward payment. For example: ACPX, OTPX etc."},{"name":"quantity","in":"query","type":"string","required":false,"description":"The nominal quantity"},{"name":"stockExchange","in":"query","type":"string","required":false,"description":"The stock exchange identifier"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from t24 on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"OverdueSettlementsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/party/customers/accountServicingProviders/","fullPath":"/api/v1.0.0/party/customers/accountServicingProviders/","operationId":"getOtherBanksToConnectTo","name":"Retrieves other banks to connect to details.Use \"/party/customers/accountServicingProviders/\" as URI from party-customerServices-v4.0.0","summary":"Retrieves the list of other/external bank details","tags":[],"parameters":[{"name":"openBankingId","in":"query","type":"string","required":false,"description":"Identifies the open banking number of the customer"},{"name":"countryId","in":"query","type":"string","required":false,"description":"ISO country code of the financial institution. "},{"name":"setActive","in":"query","type":"string","required":false,"description":"Flag to set the connection status to active"},{"name":"status","in":"query","type":"string","required":false,"description":"Contains status of the data rights request.Allowed values are INITIATED, INPROGESS, EXTENDED, COMPLETED, REJECTED."},{"name":"extSourceProvider","in":"query","type":"string","required":false,"description":"Contains the name of the external source provider for the customer"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from t24 on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"OtherBanksToConnectToResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}}]},{"key":"party-customersMiFID-service-v1.0.0","title":"Customer MIFID Management","version":"v1.0.0","description":"Allows the viewing, creation and management of MiFID client information","endpointCount":3,"endpoints":[{"method":"GET","path":"/party/customers/{customerId}/MiFID","fullPath":"/api/v1.0.0/party/customers/{customerId}/MiFID","operationId":"getMiFIDClientInformation","name":"Retrieves the MiFiD client information","summary":"Retrieves the MiFiD client information","tags":[],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"Identifier of the customer"},{"name":"credentials","in":"header","type":"string","required":false,"description":""},{"name":"companyId","in":"header","type":"string","required":false,"description":""}],"requestBodyExample":null,"responses":{"200":"MiFIDClientInformationResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"POST","path":"/party/customers/{customerId}/MiFID","fullPath":"/api/v1.0.0/party/customers/{customerId}/MiFID","operationId":"createMiFIDClientInformation","name":"Creates the MiFiD client information","summary":"Creates the MiFiD client information","tags":[],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"Identifier of the customer"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":""},{"name":"companyId","in":"header","type":"string","required":false,"description":""}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"classification":"string","requestDate":"2024-01-01","MiFIDRequired":"string","reviewDate":"2024-01-01","educationLevel":"string","knowledgeInHedgeFunds":"string","knowledgeInPrivateEquity":"string","knowledgeInStructuredProducts":"string","knowledgeInDerivatives":"string"}},"responses":{"200":"MiFIDClientInformationResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/party/customers/{customerId}/MiFID","fullPath":"/api/v1.0.0/party/customers/{customerId}/MiFID","operationId":"updateMiFIDClientInformation","name":"Updates the MiFiD client information","summary":"Updates the MiFiD client information","tags":[],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"Identifier of the customer"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":""},{"name":"companyId","in":"header","type":"string","required":false,"description":""}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"classification":"string","requestDate":"2024-01-01","MiFIDRequired":"string","reviewDate":"2024-01-01","educationLevel":"string","knowledgeInHedgeFunds":"string","knowledgeInPrivateEquity":"string","knowledgeInStructuredProducts":"string","knowledgeInDerivatives":"string"}},"responses":{"200":"MiFIDClientInformationResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}}]},{"key":"party-dataProtection-customers-v1.3.0","title":"Customer Data protection rights management","version":"v1.3.0","description":"API to create, update and manage the customers' (data subjects') data protection consent and rights for the processing of their personal data. It defines a set of enhanced rights for individuals over the collection, usage of their personal data and the right to restrict processing.","endpointCount":10,"endpoints":[{"method":"PUT","path":"/party/dataProtection/customers/consentApprovals/{consentId}","fullPath":"/api/v1.3.0/party/dataProtection/customers/consentApprovals/{consentId}","operationId":"approveConsent","name":"Approves the consent request of the customer for processing of personal data which contains type of a consent, subtype of a type entered, consent withdraw etc.","summary":"Approves customer consent request","tags":[],"parameters":[{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001"},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"consentId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":null,"responses":{"200":"approveConsentResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"GET","path":"/party/dataProtection/customers/consents","fullPath":"/api/v1.3.0/party/dataProtection/customers/consents","operationId":"getConsent","name":"Retrieves the details of the consent recorded in system for processing of personal data For example - consentType, consentSubType, consentGiven etc. details of the customer consent can be fetched.. For example - the details include consent type, consent sub type, withdrawal of consent, to check whether the consent is given for a type, for a sub type etc.","summary":"Retrieves customer consent details","tags":[],"parameters":[{"name":"customerId","in":"query","type":"string","required":true,"description":"Identifier of the customer"},{"name":"consentId","in":"query","type":"string","required":true,"description":"Identifier of the corresponding consent object as retrieved by an account Information consent Request."},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from t24 on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001"},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"ConsentResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"PUT","path":"/party/dataProtection/customers/consents","fullPath":"/api/v1.3.0/party/dataProtection/customers/consents","operationId":"updateConsent","name":"Updates the consent details of the customer for processing of personal data. For example - consentType, consentSubType, consentWithdrawn etc. details of the customer consent will be updated.","summary":"Updates customer consent details","tags":[],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001"},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"customers":[{}],"arrangement":"string","product":"string","arrangementEffectiveDate":"string","activity":"string","reason":"string","cdpConsent":{"consentTypes":{},"expiryDate":{}}}},"responses":{"200":"updateConsentResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"PUT","path":"/party/dataProtection/customers/consents/revocations","fullPath":"/api/v1.3.0/party/dataProtection/customers/consents/revocations","operationId":"withdrawConsent","name":"Allows the revocation of the consent provided by the customer so as to stop any further processing of personal data. The consent cannot be processed further once it is revoked.","summary":"Revokes the consent provided by the customer","tags":[],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001"},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"customers":[{}],"arrangement":"string","product":"string","arrangementEffectiveDate":"string","activity":"string","reason":"string"}},"responses":{"200":"withdrawConsentResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"POST","path":"/party/dataProtection/customers/consentInitiation","fullPath":"/api/v1.3.0/party/dataProtection/customers/consentInitiation","operationId":"createConsent","name":"Initiates the consent request of the customer for processing of personal data. The details used to initiate a consent are consent type, sub type of a consent type, to check whether the consent is provided, consent withdrawal etc.","summary":"Initiates customer consent request","tags":[],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001"},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"customers":[{}],"arrangement":"string","product":"string","arrangementEffectiveDate":"string","activity":"string","reason":"string","cdpConsent":{"consentTypes":{},"expiryDate":{}}}},"responses":{"200":"createConsentResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"GET","path":"/party/dataProtection/consents","fullPath":"/api/v1.3.0/party/dataProtection/consents","operationId":"getCdpConsentStatus","name":"API to return the validity of a customer consent by returning the status of customer consent.","summary":"Returns the status of a customer Consent. i.e., if the consent is valid or not ","tags":[],"parameters":[{"name":"customerId","in":"query","type":"string","required":false,"description":"Identifier of the customer"},{"name":"arrangement","in":"query","type":"string","required":false,"description":"Unique identifier for the arrangement contract"},{"name":"consentType","in":"query","type":"string","required":false,"description":"Consent Type for which the consent is given"},{"name":"consentSubType","in":"query","type":"string","required":false,"description":"Indicates the consent sub type linked to corresponding consent type."},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from t24 on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001"},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"CdpConsentStatusResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"POST","path":"/party/dataProtection/customers/dataRightsInitiation","fullPath":"/api/v1.3.0/party/dataProtection/customers/dataRightsInitiation","operationId":"createDataRightsRequest","name":"Initiates the data rights management request of the customer for exercising the various rights under the data protection rules, which defines significant new privacy requirements for companies and provides rights for individuals over the collection and usage of their personal data and the right to restrict processing. It creates a request with following details of a customer. For example - request type, request status, original expiry date of request etc.","summary":"Initiates the data rights request","tags":[],"parameters":[{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001"},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"purposeDetails":[{}],"partyId":"string","partyType":"string","requestType":"string","newExpiryDate":"string","status":"string","requestNewAction":"string","newAmendmentNotes":"string","approveRequest":"string","channelId":"string","accountOfficer":"string","applicationName":"string","contractId":"string","companyId":"string"}},"responses":{"200":"DataRightsRequestResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/party/dataProtection/customers/dataRightsApprovals/{dataRightsId}","fullPath":"/api/v1.3.0/party/dataProtection/customers/dataRightsApprovals/{dataRightsId}","operationId":"approveDataRightsRequest","name":"Approves the data rights management request of the customer for exercising the various rights under the data protection rules, which has significant enhanced rights for individuals over the collection and usage of their personal data and the right to restrict processing.It approves a request with following details of a customer. For example - request type, request status, original expiry date of request etc.","summary":"Approves data rights details","tags":[],"parameters":[{"name":"dataRightsId","in":"path","type":"string","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001"},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"DataRightsRequestResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/party/dataProtection/customers/dataRights/{dataRightsId}","fullPath":"/api/v1.3.0/party/dataProtection/customers/dataRights/{dataRightsId}","operationId":"updateDataRightsRequest","name":"Updates the data rights management details of the customer for processing of personal data. It has significantly enhanced rights for individuals over the collection and usage of their personal data and the right to restrict processing. It updates a request with following details of a customer. For example - request type, request status, original expiry date of request etc.","summary":"Updates data rights details","tags":[],"parameters":[{"name":"dataRightsId","in":"path","type":"string","required":true,"description":""},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001"},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"purposeDetails":[{}],"partyId":"string","partyType":"string","requestType":"string","newExpiryDate":"string","status":"string","requestNewAction":"string","newAmendmentNotes":"string","accountOfficer":"string","isReqComplete":"string","approveRequest":"string","channelId":"string","internalAction":"string","applicationName":"string","contractId":"string"}},"responses":{"200":"DataRightsRequestResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/party/dataProtection/customers/dataRights","fullPath":"/api/v1.3.0/party/dataProtection/customers/dataRights","operationId":"getDataRightsRequest","name":"Retrieves the data rights details of the customer for processing of personal data. It has significantly enhanced rights for individuals over the collection and usage of their personal data and the right to restrict processing. It returns significant details of request of a customer. For example - request type, request status, original expiry date of request etc.","summary":"Retrieves data rights details.","tags":[],"parameters":[{"name":"dataRightsId","in":"query","type":"string","required":false,"description":""},{"name":"partyId","in":"query","type":"string","required":false,"description":"Allows capturing of customers or person entities to be part of the relationship. If partyType is selected as Customer, then the system will allow only customer Ids to be captured into this field. If p"},{"name":"status","in":"query","type":"string","required":false,"description":"Contains status of the data rights request.Allowed values are INITIATED, INPROGESS, EXTENDED, COMPLETED, REJECTED."},{"name":"currExpiryDate","in":"query","type":"string","required":false,"description":"Contains the current expiry date of the data rights request."},{"name":"requestType","in":"query","type":"string","required":false,"description":"Contains customer data rights request type. Example: ERASURE/DATAPORTABILITY."},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from t24 on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001"},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"DataRightsRequestResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}}]},{"key":"party-dataProtection-customers-v1.4.0","title":"Customer Data protection rights management","version":"v1.4.0","description":"API to create, update and manage the customers' (data subjects') data protection consent and rights for the processing of their personal data. It defines a set of enhanced rights for individuals over the collection, usage of their personal data and the right to restrict processing.","endpointCount":10,"endpoints":[{"method":"PUT","path":"/party/dataProtection/customers/consentApprovals/{consentId}","fullPath":"/api/v1.4.0/party/dataProtection/customers/consentApprovals/{consentId}","operationId":"approveConsent","name":"Approves the consent request of the customer for processing of personal data which contains type of a consent, subtype of a type entered, consent withdraw etc.","summary":"Approves customer consent request","tags":[],"parameters":[{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"consentId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":null,"responses":{"200":"approveConsentResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"GET","path":"/party/dataProtection/customers/consents","fullPath":"/api/v1.4.0/party/dataProtection/customers/consents","operationId":"getConsent","name":"Retrieves the details of the consent recorded in system for processing of personal data such as consent type, consent sub type and whether consent given","summary":"Retrieves customer consent details","tags":[],"parameters":[{"name":"customerId","in":"query","type":"string","required":false,"description":"Identifier of the customer"},{"name":"consentId","in":"query","type":"string","required":false,"description":"Identifier of the corresponding consent object as retrieved by an account Information consent Request."},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"ConsentResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"PUT","path":"/party/dataProtection/customers/consents","fullPath":"/api/v1.4.0/party/dataProtection/customers/consents","operationId":"updateConsent","name":"It updates the customer consent for processing of personal data such as consent type, consent sub type and whether consent withdrawn","summary":"Updates customer consent details","tags":[],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"customers":[{}],"arrangement":"string","product":"string","arrangementEffectiveDate":"string","activity":"string","reason":"string","extensions":{},"cdpConsent":[{}]}},"responses":{"200":"updateConsentResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"PUT","path":"/party/dataProtection/customers/consents/revocations","fullPath":"/api/v1.4.0/party/dataProtection/customers/consents/revocations","operationId":"withdrawConsent","name":"Allows the revocation of the consent provided by the customer so as to stop any further processing of personal data. The consent cannot be processed further once it is revoked.","summary":"Revokes the consent provided by the customer","tags":[],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"customers":[{}],"arrangement":"string","product":"string","arrangementEffectiveDate":"string","activity":"string","reason":"string","extensions":{}}},"responses":{"200":"withdrawConsentResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"POST","path":"/party/dataProtection/customers/consentInitiation","fullPath":"/api/v1.4.0/party/dataProtection/customers/consentInitiation","operationId":"createConsent","name":"Initiates the consent request of the customer for processing of personal data using details like consent type, sub type of a consent type, consent withdrawal.","summary":"Initiates customer consent request","tags":[],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"customers":[{}],"arrangement":"string","product":"string","arrangementEffectiveDate":"string","activity":"string","reason":"string","extensions":{},"cdpConsent":[{}]}},"responses":{"200":"createConsentResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"GET","path":"/party/dataProtection/consents","fullPath":"/api/v1.4.0/party/dataProtection/consents","operationId":"getCdpConsentStatus","name":"API to return the validity of a customer consent by returning the status of customer consent.","summary":"It provides the status of a customer consent","tags":[],"parameters":[{"name":"customerId","in":"query","type":"string","required":false,"description":"Identifier of the customer"},{"name":"arrangement","in":"query","type":"string","required":false,"description":"Unique identifier for the arrangement contract"},{"name":"consentType","in":"query","type":"string","required":false,"description":"Consent Type for which the consent is given"},{"name":"consentSubType","in":"query","type":"string","required":false,"description":"Indicates the consent sub type linked to corresponding consent type."},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"CdpConsentStatusResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"POST","path":"/party/dataProtection/customers/dataRightsInitiation","fullPath":"/api/v1.4.0/party/dataProtection/customers/dataRightsInitiation","operationId":"createDataRightsRequest","name":"Initiates the data rights management request for a customer using details like request type, request status, original expiry date of request ","summary":"Initiates the data rights request","tags":[],"parameters":[{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"purposeDetails":[{}],"partyId":"string","partyType":"string","requestType":"string","newExpiryDate":"string","status":"string","requestNewAction":"string","newAmendmentNotes":"string","approveRequest":"string","channelId":"string","accountOfficer":"string","applicationName":"string","contractId":"string","companyId":"string","extensions":{}}},"responses":{"200":"DataRightsRequestResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/party/dataProtection/customers/dataRightsApprovals/{dataRightsId}","fullPath":"/api/v1.4.0/party/dataProtection/customers/dataRightsApprovals/{dataRightsId}","operationId":"approveDataRightsRequest","name":"It approves a request with customer request type, request status, original expiry date of request","summary":"Approves data rights details","tags":[],"parameters":[{"name":"dataRightsId","in":"path","type":"string","required":true,"description":"Identifier of the data rights management request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"DataRightsRequestResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/party/dataProtection/customers/dataRights","fullPath":"/api/v1.4.0/party/dataProtection/customers/dataRights","operationId":"getDataRightsRequest","name":"It provides significant details of request of a customer like request type, request status, and original expiry date of request","summary":"Retrieves data rights details.","tags":[],"parameters":[{"name":"dataRightsId","in":"query","type":"string","required":false,"description":"Identifier of the data rights management request"},{"name":"partyId","in":"query","type":"string","required":false,"description":"Allows capturing of customers or person entities to be part of the relationship. If partyType is selected as Customer, then the system will allow only customer Ids to be captured into this field. If p"},{"name":"status","in":"query","type":"string","required":false,"description":"Contains status of the data rights request.Allowed values are INITIATED, INPROGESS, EXTENDED, COMPLETED, REJECTED."},{"name":"currExpiryDate","in":"query","type":"string","required":false,"description":"Contains the current expiry date of the data rights request."},{"name":"requestType","in":"query","type":"string","required":false,"description":"Contains customer data rights request type. Example: ERASURE/DATAPORTABILITY."},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"DataRightsRequestResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"PUT","path":"/party/dataProtection/customers/dataRights/{dataRightsId}","fullPath":"/api/v1.4.0/party/dataProtection/customers/dataRights/{dataRightsId}","operationId":"updateDataRightsRequest","name":"It updates a request with customer details like request type, request status, original expiry date of request ","summary":"Updates data rights details","tags":[],"parameters":[{"name":"dataRightsId","in":"path","type":"string","required":true,"description":""},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"purposeDetails":[{}],"externalSystemInfo":[{}],"partyId":"string","partyType":"string","requestType":"string","newExpiryDate":"string","status":"string","requestNewAction":"string","newAmendmentNotes":"string","accountOfficer":"string","isReqComplete":"string","approveRequest":"string","channelId":"string","internalAction":"string","applicationName":"string"}},"responses":{"200":"DataRightsRequestResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}}]},{"key":"party-dataProtectionConsent-v1.1.0","title":"Create and manage customer consent - Deprecated. Use party-dataProtection-customers-v1.3.0 instead","version":"v1.1.0","description":"Create and manage customer consent","endpointCount":6,"endpoints":[{"method":"PUT","path":"/party/dataProtection/customers/consentApprovals/{consentId}","fullPath":"/api/v1.1.0/party/dataProtection/customers/consentApprovals/{consentId}","operationId":"approveConsent","name":"Approve consent","summary":"Approval of customer consent.","tags":[],"parameters":[{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"The identifier of the underlying Entity/Company/Branch."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"consentId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":null,"responses":{"200":"approveConsentResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"GET","path":"/party/dataProtection/customers/consents","fullPath":"/api/v1.1.0/party/dataProtection/customers/consents","operationId":"getConsent","name":"Retrieves consent details","summary":"Retrieval of customer consent details.","tags":[],"parameters":[{"name":"customerId","in":"query","type":"string","required":true,"description":"Identifier of the customer"},{"name":"consentId","in":"query","type":"string","required":true,"description":"Identifier of the corresponding consent object as retrieved by an account Information consent Request."},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from t24 on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"The identifier of the underlying Entity/Company/Branch."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"ConsentResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"PUT","path":"/party/dataProtection/customers/consents","fullPath":"/api/v1.1.0/party/dataProtection/customers/consents","operationId":"updateConsent","name":"Update consent","summary":"Update of customer consent details.","tags":[],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"The identifier of the underlying Entity/Company/Branch."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"customers":[{}],"arrangement":"string","product":"string","arrangementEffectiveDate":"string","activity":"string","reason":"string","cdpConsent":{"consentTypes":{},"expiryDate":{}}}},"responses":{"200":"updateConsentResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"PUT","path":"/party/dataProtection/customers/consents/revocations","fullPath":"/api/v1.1.0/party/dataProtection/customers/consents/revocations","operationId":"withdrawConsent","name":"Revokes consent.","summary":"Revokes customer consent details from system.","tags":[],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"The identifier of the underlying Entity/Company/Branch."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"customers":[{}],"arrangement":"string","product":"string","arrangementEffectiveDate":"string","activity":"string","reason":"string"}},"responses":{"200":"withdrawConsentResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"POST","path":"/party/dataProtection/customers/consentInitiation","fullPath":"/api/v1.1.0/party/dataProtection/customers/consentInitiation","operationId":"createConsent","name":"Initiate consent","summary":"Initiation of customer consent","tags":[],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"The identifier of the underlying Entity/Company/Branch."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"customers":[{}],"arrangement":"string","product":"string","arrangementEffectiveDate":"string","activity":"string","reason":"string","cdpConsent":{"consentTypes":{},"expiryDate":{}}}},"responses":{"200":"createConsentResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"GET","path":"/party/dataProtection/consents","fullPath":"/api/v1.1.0/party/dataProtection/consents","operationId":"getCdpConsentStatus","name":"API to return the validity of a CDP consent","summary":"Returns the status of a CDP Consent. i.e., if the consent is valid or not ","tags":[],"parameters":[{"name":"customerId","in":"query","type":"string","required":false,"description":"Identifier of the customer"},{"name":"arrangement","in":"query","type":"string","required":false,"description":"Unique identifier for the arrangement contract"},{"name":"consentType","in":"query","type":"string","required":false,"description":"Consent Type for which the consent is given"},{"name":"consentSubType","in":"query","type":"string","required":false,"description":"Indicates the consent sub type linked to corresponding consent type."},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from t24 on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"The identifier of the underlying Entity/Company/Branch."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"CdpConsentStatusResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}}]},{"key":"party-dataProtectionConsent-v1.2.0","title":"Create and manage customer consent - Deprecated. Use party-dataProtection-customers-v1.3.0 instead","version":"v1.2.0","description":"Create and manage customer consent","endpointCount":6,"endpoints":[{"method":"PUT","path":"/party/dataProtection/customers/consentApprovals/{consentId}","fullPath":"/api/v1.2.0/party/dataProtection/customers/consentApprovals/{consentId}","operationId":"approveConsent","name":"Approve consent","summary":"Approval of customer consent.","tags":[],"parameters":[{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001"},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"consentId","in":"path","type":"string","required":true,"description":""}],"requestBodyExample":null,"responses":{"200":"approveConsentResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"GET","path":"/party/dataProtection/customers/consents","fullPath":"/api/v1.2.0/party/dataProtection/customers/consents","operationId":"getConsent","name":"Retrieves consent details","summary":"Retrieval of customer consent details.","tags":[],"parameters":[{"name":"customerId","in":"query","type":"string","required":true,"description":"Identifier of the customer"},{"name":"consentId","in":"query","type":"string","required":true,"description":"Identifier of the corresponding consent object as retrieved by an account Information consent Request."},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from t24 on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001"},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"ConsentResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"PUT","path":"/party/dataProtection/customers/consents","fullPath":"/api/v1.2.0/party/dataProtection/customers/consents","operationId":"updateConsent","name":"Update consent","summary":"Update of customer consent details.","tags":[],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001"},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"customers":[{}],"arrangement":"string","product":"string","arrangementEffectiveDate":"string","activity":"string","reason":"string","cdpConsent":{"consentTypes":{},"expiryDate":{}}}},"responses":{"200":"updateConsentResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"PUT","path":"/party/dataProtection/customers/consents/revocations","fullPath":"/api/v1.2.0/party/dataProtection/customers/consents/revocations","operationId":"withdrawConsent","name":"Revokes consent.","summary":"Revokes customer consent details from system.","tags":[],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001"},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"customers":[{}],"arrangement":"string","product":"string","arrangementEffectiveDate":"string","activity":"string","reason":"string"}},"responses":{"200":"withdrawConsentResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"POST","path":"/party/dataProtection/customers/consentInitiation","fullPath":"/api/v1.2.0/party/dataProtection/customers/consentInitiation","operationId":"createConsent","name":"Initiate consent","summary":"Initiation of customer consent","tags":[],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001"},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"customers":[{}],"arrangement":"string","product":"string","arrangementEffectiveDate":"string","activity":"string","reason":"string","cdpConsent":{"consentTypes":{},"expiryDate":{}}}},"responses":{"200":"createConsentResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"GET","path":"/party/dataProtection/consents","fullPath":"/api/v1.2.0/party/dataProtection/consents","operationId":"getCdpConsentStatus","name":"API to return the validity of a CDP consent","summary":"Returns the status of a CDP Consent. i.e., if the consent is valid or not ","tags":[],"parameters":[{"name":"customerId","in":"query","type":"string","required":false,"description":"Identifier of the customer"},{"name":"arrangement","in":"query","type":"string","required":false,"description":"Unique identifier for the arrangement contract"},{"name":"consentType","in":"query","type":"string","required":false,"description":"Consent Type for which the consent is given"},{"name":"consentSubType","in":"query","type":"string","required":false,"description":"Indicates the consent sub type linked to corresponding consent type."},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from t24 on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001"},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"CdpConsentStatusResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}}]},{"key":"party-dataProtectionReports-customers-v1.0.0","title":"Customer Data protection reports management","version":"v1.0.0","description":"API to create data rights management report  for customer","endpointCount":1,"endpoints":[{"method":"POST","path":"/party/dataProtection/customers/dataRightsReports/{dataRightsReportId}","fullPath":"/api/v1.0.0/party/dataProtection/customers/dataRightsReports/{dataRightsReportId}","operationId":"createDataRightsReport","name":"Creates the data rights management report of the customer which provides information on the various rights under the data protection rules that meets the privacy requirements for companies and provides rights for individuals over the collection and usage of their personal data and the right to restrict processing.","summary":"Creates data rights management report for a customer ","tags":[],"parameters":[{"name":"dataRightsReportId","in":"path","type":"string","required":true,"description":"Identifier of the data rights report"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"contractDetails":[{}],"partyId":"string","partyType":"string","dataRightsId":"string","requestType":"string","applicationName":"string","creationDate":"string","customerCompany":"string","extensions":{}}},"responses":{"200":"DataRightsReportResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}}]},{"key":"party-externalUsers-service-v1.0.0","title":"Management of external users","version":"v1.0.0","description":"API to retrieve and manage external user preferences and profiles","endpointCount":7,"endpoints":[{"method":"GET","path":"/party/externalUsers/userProfiles","fullPath":"/api/v1.0.0/party/externalUsers/userProfiles","operationId":"getExternalUserProfile","name":"Retrieves the details of logged in external user.","summary":"Retrieves the external user details","tags":[],"parameters":[{"name":"channelId","in":"query","type":"string","required":false,"description":"Id of the (digital) channel"},{"name":"arrangementId","in":"query","type":"string","required":false,"description":"Indicates an unique identifier of an account"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"ExternalUserProfileResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/party/externalUsers/externalUserPreferences","fullPath":"/api/v1.0.0/party/externalUsers/externalUserPreferences","operationId":"getExternalUserPreferences","name":"Retrieves the list of external user preferences for logged in user","summary":"Retrieves the external user preferences","tags":[],"parameters":[{"name":"externalUserPreferencesId","in":"query","type":"string","required":false,"description":"Denotes the preference identifier for the external user"},{"name":"externalUserPreferencesIdBW","in":"query","type":"string","required":false,"description":""},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"ExternalUserPreferencesResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"PUT","path":"/party/externalUsers/{externalUserId}/status","fullPath":"/api/v1.0.0/party/externalUsers/{externalUserId}/status","operationId":"updateExternalUserStatus","name":"This API is used to update the external user status, Such as ACTIVE, INITIATED ,etc. And also used to update the terms and condition information and language for the external user","summary":"Update external user status","tags":[],"parameters":[{"name":"externalUserId","in":"path","type":"string","required":true,"description":"Contains the external user identifier for which the consent is created."},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"channels":[{}],"languageId":"string"}},"responses":{"200":"ExternalUserStatusResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"POST","path":"/party/externalUsers/externalUserPreferences/{externalUserPreferencesId}","fullPath":"/api/v1.0.0/party/externalUsers/externalUserPreferences/{externalUserPreferencesId}","operationId":"createExternalUserPreference","name":"Create a new external user preferences for logged in user","summary":"Create new external user preferences","tags":[],"parameters":[{"name":"externalUserPreferencesId","in":"path","type":"string","required":true,"description":"Denotes the preference identifier for the external user"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"customers":[{}],"balanceCustomers":[{}],"serviceNames":[{}],"groupName":"string","groupDisplayName":"string","groupPosition":"string","favouriteGroup":"string"}},"responses":{"200":"ExternalUserPreferenceResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/party/externalUsers/externalUserPreferences/{externalUserPreferencesId}","fullPath":"/api/v1.0.0/party/externalUsers/externalUserPreferences/{externalUserPreferencesId}","operationId":"updateExternalUserPreference","name":"Update an existing external user preferences","summary":"Update the external user preferences","tags":[],"parameters":[{"name":"externalUserPreferencesId","in":"path","type":"string","required":true,"description":"Denotes the preference identifier for the external user"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"customers":[{}],"balanceCustomers":[{}],"serviceNames":[{}],"groupName":"string","groupDisplayName":"string","groupPosition":"string","favouriteGroup":"string"}},"responses":{"200":"ExternalUserPreferenceResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"DELETE","path":"/party/externalUsers/externalUserPreferences/{externalUserPreferencesId}","fullPath":"/api/v1.0.0/party/externalUsers/externalUserPreferences/{externalUserPreferencesId}","operationId":"deleteExternalUserPreference","name":"Remove an existing external user preference for logged in user","summary":"Remove external user preferences","tags":[],"parameters":[{"name":"externalUserPreferencesId","in":"path","type":"string","required":true,"description":"Denotes the preference identifier for the external user"},{"name":"payload","in":"body","type":"object","required":false,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}}},"responses":{"200":"ExternalUserPreferenceResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/party/externalUsers/externalUserPreference/{externalUserPreferencesId}","fullPath":"/api/v1.0.0/party/externalUsers/externalUserPreference/{externalUserPreferencesId}","operationId":"getExternalUserPreference","name":"Retrieves the overview of external user preference for logged in user","summary":"Overview of external user preferences","tags":[],"parameters":[{"name":"externalUserPreferencesId","in":"path","type":"string","required":true,"description":"Denotes the preference identifier for the external user"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"ExternalUserPreferenceResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}}]},{"key":"party-fatcacustomer-v1.0.0","title":"FATCA Customer","version":"v1.0.0","description":"API to Create and update the Foreign Account Tax Compliance Act (FATCA) reporting information for a Customer - Deprecated. Use party-customerServices-v4.0.0 instead","endpointCount":2,"endpoints":[{"method":"POST","path":"/party/customers/fatca/{customerId}","fullPath":"/api/v1.0.0/party/customers/fatca/{customerId}","operationId":"createFatcaCustomer","name":"Creates the FATCA Customer Supplementary information record that stores the related FATCA details for the customer","summary":"Create FATCA Customer Supplementary Information details","tags":[],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"The identifier of the customer"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"The identifier of the underlying Entity/Company/Branch."},{"name":"deviceId","in":"header","type":"string","required":false,"description":""},{"name":"userRole","in":"header","type":"string","required":false,"description":""}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"citizenships":[{}],"tinDetails":[{}],"Owner":[{}],"JointOwner":[{}],"fatcaClientType":"string","isPlaceOfBirthUs":"string","domicile":"string","greencardDetails":"string","residenceId":"string","isPoa":"string","standingInstructionOnUsAccount":"string","accountInstructionfromUs":"string","socialSecurityNumber":"string","phoneNumber":"string","isDormantAccount":"string"}},"responses":{"200":"FatcaCustomerResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/party/customers/fatca/{customerId}","fullPath":"/api/v1.0.0/party/customers/fatca/{customerId}","operationId":"updateFatcaCustomer","name":"Update the FATCA Customer Supplementary information record that stores the related FATCA details for the customer","summary":"Update FATCA Customer Supplementary Information details","tags":[],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"The identifier of the customer"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"The identifier of the underlying Entity/Company/Branch."},{"name":"deviceId","in":"header","type":"string","required":false,"description":""},{"name":"userRole","in":"header","type":"string","required":false,"description":""}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"citizenships":[{}],"tinDetails":[{}],"Owner":[{}],"JointOwner":[{}],"fatcaClientType":"string","isPlaceOfBirthUs":"string","domicile":"string","greencardDetails":"string","residenceId":"string","isPoa":"string","standingInstructionOnUsAccount":"string","accountInstructionfromUs":"string","socialSecurityNumber":"string","phoneNumber":"string","isDormantAccount":"string"}},"responses":{"200":"FatcaCustomerResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}}]},{"key":"party-mdal-v1.0.0","title":"Get Party Details For MDAL","version":"v1.0.0","description":"Get Party Details For MDAL(Deprecated- A newer version V2.0.0 available).","endpointCount":1,"endpoints":[{"method":"GET","path":"/party/customer/{partyId}/details","fullPath":"/irf-provider-container/api/v1.0.0/party/customer/{partyId}/details","operationId":"getPartyDetailsForMDAL","name":"getPartyDetails","summary":"getPartyDetails","tags":[],"parameters":[{"name":"partyId","in":"path","type":"string","required":true,"description":"Allows capturing of customers or person entities to be part of the relationship. If partyType is selected as Customer, then the system will allow only customer Ids to be captured into this field. If p"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"PartyDetailsForMDALResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}}]},{"key":"party-mdal-v2.0.0","title":"Get Party Details For MDAL","version":"v2.0.0","description":"Get party details for MDAL","endpointCount":1,"endpoints":[{"method":"GET","path":"/party/customers/{partyId}","fullPath":"/api/v2.0.0/party/customers/{partyId}","operationId":"getPartyDetailsForMDAL","name":"getPartyDetails","summary":"getPartyDetails","tags":[],"parameters":[{"name":"partyId","in":"path","type":"string","required":true,"description":"Allows capturing of customers or person entities to be part of the relationship. If partyType is selected as Customer, then the system will allow only customer Ids to be captured into this field. If p"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"PartyDetailsForMDALResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}}]},{"key":"party-onboarding-customer-v1.0.0","title":"Customer Onboarding","version":"v1.0.0","description":"API to create, update and view the customer onboarding details","endpointCount":3,"endpoints":[{"method":"GET","path":"/party/onboarding/customers/{customerId}","fullPath":"/api/v1.0.0/party/onboarding/customers/{customerId}","operationId":"getOnboardingCustomer","name":"Retrieve Customer Information","summary":"Customer Information for specific customer.","tags":[],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"Identifier of the customer"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"OnboardingCustomerResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/party/onboarding/customers/{customerId}","fullPath":"/api/v1.0.0/party/onboarding/customers/{customerId}","operationId":"updateOnboardingCustomer","name":"Customer Updation","summary":"update the customer information","tags":[],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"Identifier of the customer"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"displayNames":[{}],"customerNames":[{}],"communicationDevices":[{}],"faxIds":[{}],"officePhoneNumbers":[{}],"streets":[{}],"addresses":[{}],"addressCities":[{}],"countries":[{}],"legalDetails":[{}],"otherNationalityIds":[{}],"employDetails":[{}],"residenceDetails":[{}],"relationshipDetails":[{}],"postingRestrictIds":[{}]}},"responses":{"200":"OnboardingCustomerResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"POST","path":"/party/onboarding/customers","fullPath":"/api/v1.0.0/party/onboarding/customers","operationId":"createOnboardingCustomer","name":"Creates a Customer base record for correspondent banks, brokers, guarantors etc. as well as for current and savings account holders.","summary":"Create the customer","tags":[],"parameters":[{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"displayNames":[{}],"customerNames":[{}],"communicationDevices":[{}],"faxIds":[{}],"officePhoneNumbers":[{}],"streets":[{}],"addresses":[{}],"addressCities":[{}],"countries":[{}],"legalDetails":[{}],"otherNationalityIds":[{}],"employDetails":[{}],"residenceDetails":[{}],"relationshipDetails":[{}],"postingRestrictIds":[{}]}},"responses":{"200":"OnboardingCustomerResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}}]},{"key":"party-onboarding-customer-v1.1.0","title":"Customer Onboarding","version":"v1.1.0","description":"API to create, update and view the customer onboarding details","endpointCount":3,"endpoints":[{"method":"GET","path":"/party/onboarding/customers/{customerId}","fullPath":"/api/v1.1.0/party/onboarding/customers/{customerId}","operationId":"getOnboardingCustomer","name":"Retrieve customer information","summary":"Customer information for specific customer.","tags":[],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"Identifier of the customer"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"OnboardingCustomerResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/party/onboarding/customers/{customerId}","fullPath":"/api/v1.1.0/party/onboarding/customers/{customerId}","operationId":"updateOnboardingCustomer","name":"Update the customer information","summary":"Update the customer information","tags":[],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"Identifier of the customer"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"displayNames":[{}],"customerNames":[{}],"communicationDevices":[{}],"faxIds":[{}],"officePhoneNumbers":[{}],"streets":[{}],"addresses":[{}],"addressCities":[{}],"countries":[{}],"legalDetails":[{}],"otherNationalityIds":[{}],"employDetails":[{}],"residenceDetails":[{}],"relationshipDetails":[{}],"postingRestrictIds":[{}]}},"responses":{"200":"OnboardingCustomerResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"POST","path":"/party/onboarding/customers","fullPath":"/api/v1.1.0/party/onboarding/customers","operationId":"createOnboardingCustomer","name":"Creates a customer for correspondent banks, brokers, guarantors etc. as well as for current and savings account holders.","summary":"Create the customer","tags":[],"parameters":[{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"displayNames":[{}],"customerNames":[{}],"communicationDevices":[{}],"faxIds":[{}],"officePhoneNumbers":[{}],"streets":[{}],"addresses":[{}],"addressCities":[{}],"countries":[{}],"legalDetails":[{}],"otherNationalityIds":[{}],"employDetails":[{}],"residenceDetails":[{}],"relationshipDetails":[{}],"postingRestrictIds":[{}]}},"responses":{"200":"OnboardingCustomerResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}}]},{"key":"party-onboarding-customer-v2.0.0","title":"Customer Onboarding","version":"v2.0.0","description":"API to create, update and view the customer onboarding details","endpointCount":3,"endpoints":[{"method":"GET","path":"/party/onboarding/customers/{customerId}","fullPath":"/api/v2.0.0/party/onboarding/customers/{customerId}","operationId":"getOnboardingCustomer","name":"Retrieve customer information","summary":"Retrieve customer information for specific customer.","tags":["OTHERS"],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"Identifier of the customer"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"OnboardingCustomerResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/party/onboarding/customers/{customerId}","fullPath":"/api/v2.0.0/party/onboarding/customers/{customerId}","operationId":"updateOnboardingCustomer","name":"Update the customer information","summary":"Update the customer information","tags":["OTHERS"],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"Identifier of the customer"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"displayNames":[{}],"customerNames":[{}],"communicationDevices":[{}],"faxIds":[{}],"officePhoneNumbers":[{}],"streets":[{}],"addresses":[{}],"addressCities":[{}],"countries":[{}],"legalDetails":[{}],"otherNationalityIds":[{}],"employDetails":[{}],"residenceDetails":[{}],"relationshipDetails":[{}],"postingRestrictIds":[{}]}},"responses":{"200":"OnboardingCustomerResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"POST","path":"/party/onboarding/customers","fullPath":"/api/v2.0.0/party/onboarding/customers","operationId":"createOnboardingCustomer","name":"Creates a customer for correspondent banks, brokers, guarantors etc. as well as for current and savings account holders.","summary":"Create the customer","tags":["OTHERS"],"parameters":[{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"displayNames":[{}],"customerNames":[{}],"communicationDevices":[{}],"faxIds":[{}],"officePhoneNumbers":[{}],"streets":[{}],"addresses":[{}],"addressCities":[{}],"countries":[{}],"legalDetails":[{}],"otherNationalityIds":[{}],"employDetails":[{}],"residenceDetails":[{}],"relationshipDetails":[{}],"postingRestrictIds":[{}]}},"responses":{"200":"OnboardingCustomerResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}}]},{"key":"party-personalconsents-v1.0.0","title":"Party Personal Consents","version":"v1.0.0","description":"Customer Personal Consent - Deprecated. Use getConsent API of party-dataProtection-customers-v1.3.0 instead","endpointCount":1,"endpoints":[{"method":"GET","path":"/party/customers/{customerId}/personalConsents","fullPath":"/api/v1.0.0/party/customers/{customerId}/personalConsents","operationId":"getCustomerPersonalConsents","name":"","summary":"","tags":[],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"The identifier of the customer"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from t24 on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"CustomerPersonalConsentsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}}]},{"key":"party-prospectcustomers-v1.0.0","title":"Prospect Customer","version":"v1.0.0","description":"Prospect Customer Management for onboarding potential new Customers","endpointCount":3,"endpoints":[{"method":"GET","path":"/party/customers/prospects","fullPath":"/api/v1.0.0/party/customers/prospects","operationId":"getProspectCustomers","name":"Retrieves the details such as contact information, residence details, personal details and prospect legal details of a prospect customer.Use \"/party/customers/prospects\" as URI from party-customerServices-v4.0.0","summary":"Retrieves prospect customer details of a customer","tags":[],"parameters":[{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from t24 on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"ProspectCustomersResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"POST","path":"/party/customers/prospects","fullPath":"/api/v1.0.0/party/customers/prospects","operationId":"createProspectCustomer","name":"Create a prospect customer with basic details such as contact information, residence details and prospect legal details.Use \"/party/customers/prospects\" as URI from party-customerServices-v4.0.0","summary":"Create a prospect customer","tags":[],"parameters":[{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"customerNames":[{}],"streets":[{}],"addresses":[{}],"townCountries":[{}],"postCodes":[{}],"countries":[{}],"phoneNumbers":[{}],"emails":[{}],"socialNetworkIds":[{}],"prospectLegalDetails":[{}],"personEntity":"string","Department":"Department","Sub_Department":"Sub Department","Floor":"Floor number","townLocationName":"Specific location name within the town"}},"responses":{"200":"ProspectCustomerResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/party/customers/prospects/{prospectId}","fullPath":"/api/v1.0.0/party/customers/prospects/{prospectId}","operationId":"updateProspectCustomer","name":"Update a prospect customer with basic details such as contact information, residence details and prospect legal details.Use \"/party/customers/prospects/{prospectId}\" as URI from party-customerServices-v4.0.0","summary":"Update the details of the prospect customer","tags":[],"parameters":[{"name":"prospectId","in":"path","type":"string","required":true,"description":"Indicates the status of an onboarding customer. Status can be PROSPECT while onboarding and ACTIVE when the prospect becomes a Customer."},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"customerNames":[{}],"streets":[{}],"addresses":[{}],"townCountries":[{}],"postCodes":[{}],"countries":[{}],"phoneNumbers":[{}],"emails":[{}],"socialNetworkIds":[{}],"prospectLegalDetails":[{}],"personEntity":"string","Department":"Department","Sub_Department":"Sub Department","Floor":"Floor number","townLocationName":"Specific location name within the town"}},"responses":{"200":"ProspectCustomerResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}}]},{"key":"party-saas-beneficiary-service-v1.0.0","title":"Management of Payments beneficiaries","version":"v1.0.0","description":"API to create, update and manage beneficiary details related to payment processing","endpointCount":4,"endpoints":[{"method":"POST","path":"/party/payments/beneficiaries","fullPath":"/api/v1.0.0/party/payments/beneficiaries","operationId":"createBeneficiary","name":"Creates beneficiary with details such as beneficial account, address, beneficiary bank and other preferred options for payment processing","summary":"Creates Payments beneficiary details","tags":[],"parameters":[{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"The identifier of the underlying Entity/Company/Branch."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"nickNames":[{}],"beneficiaryNames":[{}],"lastNames":[{}],"streets":[{}],"addressCities":[{}],"postCodes":[{}],"beneficiaryCountries":[{}],"ultimateCreditorAddressLines":[{}],"accountWithBankDisplayNames":[{}],"accountWithBankStreets":[{}],"accountWithBankCities":[{}],"accountWithBankPostCodes":[{}],"accountWithBankCountryIds":[{}],"paymentDetails":[{}],"beneficiaryId":"string"}},"responses":{"200":"BeneficiaryResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/party/payments/beneficiaries/{beneficiaryId}","fullPath":"/api/v1.0.0/party/payments/beneficiaries/{beneficiaryId}","operationId":"getBeneficiary","name":"Retrieves existing beneficiary details such as beneficial account, address, beneficiary bank and other preferred options for payment processing","summary":"Retrieves Payments beneficiary details","tags":[],"parameters":[{"name":"beneficiaryId","in":"path","type":"string","required":true,"description":"Indicates the Id of beneficiary when beneficiary details are stored"},{"name":"customerId","in":"query","type":"string","required":false,"description":"Identifier of the customer"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from t24 on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"The identifier of the underlying Entity/Company/Branch."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"BeneficiaryResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"PUT","path":"/party/payments/beneficiaries/{beneficiaryId}","fullPath":"/api/v1.0.0/party/payments/beneficiaries/{beneficiaryId}","operationId":"updateBeneficiary","name":"Updates an existing beneficiary with details such as beneficial account, address, beneficiary bank and other preferred options for payment processing","summary":"Updates Payments beneficiary details","tags":[],"parameters":[{"name":"beneficiaryId","in":"path","type":"string","required":true,"description":""},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"The identifier of the underlying Entity/Company/Branch."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"nickNames":[{}],"beneficiaryNames":[{}],"lastNames":[{}],"streets":[{}],"addressCities":[{}],"postCodes":[{}],"beneficiaryCountries":[{}],"ultimateCreditorAddressLines":[{}],"accountWithBankDisplayNames":[{}],"accountWithBankStreets":[{}],"accountWithBankCities":[{}],"accountWithBankPostCodes":[{}],"accountWithBankCountryIds":[{}],"paymentDetails":[{}],"beneficiaryId":"string"}},"responses":{"200":"BeneficiaryResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"DELETE","path":"/party/payments/beneficiaries/{beneficiaryId}","fullPath":"/api/v1.0.0/party/payments/beneficiaries/{beneficiaryId}","operationId":"deleteBeneficiary","name":"Deletes existing beneficiary of a customer defined for payment processing","summary":"Deletes Payments beneficiary details","tags":[],"parameters":[{"name":"beneficiaryId","in":"path","type":"string","required":true,"description":""},{"name":"payload","in":"body","type":"object","required":false,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"The identifier of the underlying Entity/Company/Branch."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}}},"responses":{"200":"BeneficiaryResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}}]},{"key":"party-saas-beneficiary-service-v1.1.0","title":"Management of Payments beneficiaries","version":"v1.1.0","description":"API to create, update and manage beneficiary details related to payment processing","endpointCount":4,"endpoints":[{"method":"POST","path":"/party/payments/beneficiaries","fullPath":"/api/v1.1.0/party/payments/beneficiaries","operationId":"createPaymentsBeneficiary","name":"Creates beneficiary with details such as beneficial account, address, beneficiary bank and other preferred options for payment processing","summary":"Creates Payments beneficiary details","tags":[],"parameters":[{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"nickNames":[{}],"beneficiaryNames":[{}],"lastNames":[{}],"streets":[{}],"addressCities":[{}],"postCodes":[{}],"beneficiaryCountries":[{}],"ultimateCreditorAddressLines":[{}],"accountWithBankDisplayNames":[{}],"accountWithBankStreets":[{}],"accountWithBankCities":[{}],"accountWithBankPostCodes":[{}],"accountWithBankCountryIds":[{}],"paymentDetails":[{}],"beneficiaryDetails":[{}]}},"responses":{"200":"PaymentsBeneficiaryResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/party/payments/beneficiaries/{beneficiaryId}","fullPath":"/api/v1.1.0/party/payments/beneficiaries/{beneficiaryId}","operationId":"getBeneficiary","name":"Retrieves existing beneficiary details such as beneficial account, address, beneficiary bank and other preferred options for payment processing","summary":"Retrieves Payments beneficiary details","tags":[],"parameters":[{"name":"beneficiaryId","in":"path","type":"string","required":true,"description":"Indicates the reference of the financial institution that allows access to the beneficiary information"},{"name":"customerId","in":"query","type":"string","required":false,"description":"Identifier of the customer"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from t24 on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"BeneficiaryResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"PUT","path":"/party/payments/beneficiaries/{beneficiaryId}","fullPath":"/api/v1.1.0/party/payments/beneficiaries/{beneficiaryId}","operationId":"updatePaymentsBeneficiary","name":"Updates an existing beneficiary with details such as beneficial account, address, beneficiary bank and other preferred options for payment processing","summary":"Updates Payments beneficiary details","tags":[],"parameters":[{"name":"beneficiaryId","in":"path","type":"string","required":true,"description":""},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"nickNames":[{}],"beneficiaryNames":[{}],"lastNames":[{}],"streets":[{}],"addressCities":[{}],"postCodes":[{}],"beneficiaryCountries":[{}],"ultimateCreditorAddressLines":[{}],"accountWithBankDisplayNames":[{}],"accountWithBankStreets":[{}],"accountWithBankCities":[{}],"accountWithBankPostCodes":[{}],"accountWithBankCountryIds":[{}],"paymentDetails":[{}],"beneficiaryDetails":[{}]}},"responses":{"200":"PaymentsBeneficiaryResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"DELETE","path":"/party/payments/beneficiaries/{beneficiaryId}","fullPath":"/api/v1.1.0/party/payments/beneficiaries/{beneficiaryId}","operationId":"deletePaymentsBeneficiary","name":"Deletes existing beneficiary of a customer defined for payment processing","summary":"Deletes Payments beneficiary details","tags":[],"parameters":[{"name":"beneficiaryId","in":"path","type":"string","required":true,"description":""},{"name":"payload","in":"body","type":"object","required":false,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}}},"responses":{"200":"PaymentsBeneficiaryResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}}]},{"key":"party-securitiesCustomer-service-v1.0.0","title":"Security Customer Management","version":"v1.0.0","description":"Allows to create,view or manage a Securities Customer","endpointCount":3,"endpoints":[{"method":"GET","path":"/party/securitiesCustomers/{customerId}/","fullPath":"/api/v1.0.0/party/securitiesCustomers/{customerId}/","operationId":"getSecuritiesCustomer","name":"Retrieves the security customer","summary":"Retrieves the security customer","tags":[],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"Identifier of the customer"},{"name":"credentials","in":"header","type":"string","required":false,"description":""},{"name":"companyId","in":"header","type":"string","required":false,"description":""}],"requestBodyExample":null,"responses":{"200":"SecuritiesCustomerResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"POST","path":"/party/securitiesCustomers/{customerId}/","fullPath":"/api/v1.0.0/party/securitiesCustomers/{customerId}/","operationId":"createSecuritiesCustomer","name":"Creates a security customer","summary":"Creates a security customer","tags":[],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"Identifier of the customer"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":""},{"name":"companyId","in":"header","type":"string","required":false,"description":""}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"customerTypes":[{}]}},"responses":{"200":"SecuritiesCustomerResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/party/securitiesCustomers/{customerId}/","fullPath":"/api/v1.0.0/party/securitiesCustomers/{customerId}/","operationId":"updateSecuritiesCustomer","name":"Updates the security customer","summary":"Updates the security customer","tags":[],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"Identifier of the customer"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":""},{"name":"companyId","in":"header","type":"string","required":false,"description":""}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"customerTypes":[{}]}},"responses":{"200":"SecuritiesCustomerResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}}]},{"key":"party-securitiesCustomer-service-v2.0.0","title":"Security Customer Management","version":"v2.0.0","description":"Allows to create,view or manage a Securities Customer and block chain id","endpointCount":6,"endpoints":[{"method":"GET","path":"/party/securitiesCustomers/{customerId}/","fullPath":"/api/v2.0.0/party/securitiesCustomers/{customerId}/","operationId":"getSecuritiesCustomer","name":"Retrieves the security customer","summary":"Retrieves the security customer","tags":["WEALTH"],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"Identifier of the customer"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"SecuritiesCustomerResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"POST","path":"/party/securitiesCustomers/{customerId}/","fullPath":"/api/v2.0.0/party/securitiesCustomers/{customerId}/","operationId":"createSecuritiesCustomer","name":"Creates a security customer","summary":"Creates a security customer","tags":["WEALTH"],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"Identifier of the customer"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"customerTypes":[{}],"blockChain":"string","extensions":{}}},"responses":{"200":"SecuritiesCustomerResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/party/securitiesCustomers/{customerId}/","fullPath":"/api/v2.0.0/party/securitiesCustomers/{customerId}/","operationId":"updateSecuritiesCustomer","name":"Updates the security customer","summary":"Updates the security customer","tags":["WEALTH"],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"Identifier of the customer"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"customerTypes":[{}],"blockChain":"string","extensions":{}}},"responses":{"200":"SecuritiesCustomerResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/party/blockChain/{customerId}/","fullPath":"/api/v2.0.0/party/blockChain/{customerId}/","operationId":"getBlockChain","name":"Retrieves the block chain","summary":"Retrieves the details of block chain for crypto transaction","tags":["WEALTH"],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"Identifier of the customer"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"BlockChainResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"POST","path":"/party/blockChain/{customerId}/","fullPath":"/api/v2.0.0/party/blockChain/{customerId}/","operationId":"createBlockChain","name":"Creates a block chain","summary":"Create a block chain for crypto transaction","tags":["WEALTH"],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"Identifier of the customer"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"blockChain":"string","extensions":{}}},"responses":{"200":"BlockChainResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/party/blockChain/{customerId}/","fullPath":"/api/v2.0.0/party/blockChain/{customerId}/","operationId":"updateBlockChain","name":"Updates a block chain","summary":"Updates a block chain for crypto transaction","tags":["WEALTH"],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"Identifier of the customer"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"blockChain":"string","extensions":{}}},"responses":{"200":"BlockChainResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}}]},{"key":"party-securitiesCustomer-service-v3.0.0","title":"Security Customer Management","version":"v3.0.0","description":"Allows to create,view or manage a Securities Customer and block chain id","endpointCount":6,"endpoints":[{"method":"GET","path":"/party/blockChain/{customerId}/","fullPath":"/api/v3.0.0/party/blockChain/{customerId}/","operationId":"getBlockChain","name":"Retrieves the block chain","summary":"Retrieves the details of block chain for crypto transaction","tags":["WEALTH"],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"Identifier of the customer"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"BlockChainResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"POST","path":"/party/blockChain/{customerId}/","fullPath":"/api/v3.0.0/party/blockChain/{customerId}/","operationId":"createBlockChain","name":"Creates a block chain","summary":"Create a block chain for crypto transaction","tags":["WEALTH"],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"Identifier of the customer"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"blockChain":"string","extensions":{}}},"responses":{"200":"BlockChainResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/party/blockChain/{customerId}/","fullPath":"/api/v3.0.0/party/blockChain/{customerId}/","operationId":"updateBlockChain","name":"Updates a block chain","summary":"Updates a block chain for crypto transaction","tags":["WEALTH"],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"Identifier of the customer"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"blockChain":"string","extensions":{}}},"responses":{"200":"BlockChainResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/party/securitiesCustomers/{customerId}/","fullPath":"/api/v3.0.0/party/securitiesCustomers/{customerId}/","operationId":"getSecuritiesCustomer","name":"Retrieves the security customer","summary":"Retrieves the security customer","tags":["WEALTH"],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"Identifier of the customer"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"SecuritiesCustomerResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"POST","path":"/party/securitiesCustomers/{customerId}/","fullPath":"/api/v3.0.0/party/securitiesCustomers/{customerId}/","operationId":"createSecuritiesCustomer","name":"Creates a security customer","summary":"Creates a security customer","tags":["WEALTH"],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"Identifier of the customer"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"customerTypes":[{}],"statementFreqency":"string","depository":"string","automaticCustomerSettlement":"string","extensions":{}}},"responses":{"200":"SecuritiesCustomerResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/party/securitiesCustomers/{customerId}/","fullPath":"/api/v3.0.0/party/securitiesCustomers/{customerId}/","operationId":"updateSecuritiesCustomer","name":"Updates the security customer","summary":"Updates the security customer","tags":["WEALTH"],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"Identifier of the customer"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"customerTypes":[{}],"statementFreqency":"string","depository":"string","automaticCustomerSettlement":"string","extensions":{}}},"responses":{"200":"SecuritiesCustomerResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}}]},{"key":"party-travelNotifications-service-v1.0.0","title":"Management of travel notifications","version":"v1.0.0","description":"Management of Travel Notifications","endpointCount":4,"endpoints":[{"method":"PUT","path":"/party/travelNotifications/{travelNotificationId}","fullPath":"/api/v1.0.0/party/travelNotifications/{travelNotificationId}","operationId":"updateTravelNotification","name":"Update travel notification details","summary":"Updates an existing travel notification record for a customer","tags":[],"parameters":[{"name":"travelNotificationId","in":"path","type":"string","required":true,"description":"Denotes the identifier associated with the travel for notifications"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"travelNotifications":[{}],"overrides":[{}],"customerId":"string","overallStatus":"string","cancelRequest":"string"}},"responses":{"200":"TravelNotificationResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"DELETE","path":"/party/travelNotifications/{travelNotificationId}","fullPath":"/api/v1.0.0/party/travelNotifications/{travelNotificationId}","operationId":"deleteTravelNotification","name":"Remove travel notification","summary":"Remove an existing travel notification record  for a customer","tags":[],"parameters":[{"name":"travelNotificationId","in":"path","type":"string","required":true,"description":"Denotes the identifier associated with the travel for notifications"},{"name":"payload","in":"body","type":"object","required":false,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}}},"responses":{"200":"TravelNotificationResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"POST","path":"/party/travelNotifications","fullPath":"/api/v1.0.0/party/travelNotifications","operationId":"createTravelNotification","name":"Create travel notification","summary":"Creates a new travel notification record for a customers","tags":[],"parameters":[{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"travelNotifications":[{}],"overrides":[{}],"customerId":"string","overallStatus":"string","cancelRequest":"string"}},"responses":{"200":"TravelNotificationResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/party/customers/{customerId}/travelNotifications","fullPath":"/api/v1.0.0/party/customers/{customerId}/travelNotifications","operationId":"getCustomerTravelNotifications","name":"Retrieves customer travel notifications details","summary":"Retrieves the list of travel notification details for specific customer","tags":[],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"Identifier of the customer"},{"name":"overallStatus","in":"query","type":"string","required":false,"description":"Contains the overall status"},{"name":"overallStatusNE","in":"query","type":"string","required":false,"description":"Overall status not equal to"},{"name":"travelNotificationId","in":"query","type":"string","required":false,"description":"Denotes the identifier associated with the travel for notifications"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from t24 on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"CustomerTravelNotificationsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}}]},{"key":"party-us-collections-service-v1.0.0","title":"US Model Bank Infinity Collection Integration","version":"v1.0.0","description":"Customer collection notes API","endpointCount":3,"endpoints":[{"method":"GET","path":"/party/collections/customers/{customerId}/notes","fullPath":"/api/v1.0.0/party/collections/customers/{customerId}/notes","operationId":"getCustomerNotes","name":"Retrieve notes related to a customer","summary":"Retrieve notes related to a customer","tags":["RETAIL"],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"Identifier of the customer"},{"name":"notesId","in":"query","type":"string","required":false,"description":"Identifier of notes recorded for a given customer or account"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"CustomerNotesResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"POST","path":"/party/collections/customers/{customerId}/notes","fullPath":"/api/v1.0.0/party/collections/customers/{customerId}/notes","operationId":"createCustomerNotes","name":"Create collection notes related to a customer","summary":"Create customer notes","tags":["RETAIL"],"parameters":[{"name":"customerId","in":"path","type":"number","required":true,"description":"Identifier of the customer"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"notesType":"/v1.0.0/reference/lookups?virtualTableName=NOTES.TYPE","placementDate":"2024-01-01","placementTime":"string","userId":"string","lastModifiedDate":"2024-01-01","expiryDate":"2024-01-01","notes":"string"}},"responses":{"200":"CustomerNotesResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/party/collections/customers/notes/{notesId}","fullPath":"/api/v1.0.0/party/collections/customers/notes/{notesId}","operationId":"updateCustomerNotes","name":"Update previously added notes related to a customer","summary":"Update customer notes","tags":["RETAIL"],"parameters":[{"name":"notesId","in":"path","type":"string","required":true,"description":"Identifier of notes recorded for a given customer or account"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"notesType":"/v1.0.0/reference/lookups?virtualTableName=NOTES.TYPE","placementDate":"2024-01-01","placementTime":"string","userId":"string","lastModifiedDate":"2024-01-01","expiryDate":"2024-01-01","notes":"string"}},"responses":{"200":"CustomerNotesResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}}]},{"key":"party-us-customerInformation-v1.0.0","title":"US Model Bank - Customer Information","version":"v1.0.0","description":"Retrieve customer address details and details that can be used for customer identification by a online services or call center, like DOB, SSN, Phone number","endpointCount":1,"endpoints":[{"method":"GET","path":"/party/us/customers/customerInformation","fullPath":"/api/v1.0.0/party/us/customers/customerInformation","operationId":"getUsCustomerInformation","name":"search and retrieve Customer Information","summary":"Retrieve customer information service required for infinity integration","tags":[],"parameters":[{"name":"customerId","in":"query","type":"string","required":false,"description":"Identifier of the customer"},{"name":"customerName","in":"query","type":"string","required":false,"description":"Name of the customer"},{"name":"addressLine1","in":"query","type":"string","required":false,"description":"Indicates first line of the address of the BIC"},{"name":"addressCity","in":"query","type":"string","required":false,"description":"The town and/or city component of the base address of a customer"},{"name":"countryId","in":"query","type":"string","required":false,"description":"ISO country code of the financial institution. "},{"name":"zipCode","in":"query","type":"string","required":false,"description":"Zip code"},{"name":"dateOfBirth","in":"query","type":"string","required":false,"description":"The date of birth of an individual customer"},{"name":"lastName","in":"query","type":"string","required":false,"description":"The last name of an individual customer"},{"name":"phoneNumber","in":"query","type":"string","required":false,"description":"The phone number of the customer or prospect"},{"name":"firstName","in":"query","type":"string","required":false,"description":"Specifies customer's first name"},{"name":"email","in":"query","type":"string","required":false,"description":"Email Identifier of the Customer"},{"name":"mobilePhoneNumber","in":"query","type":"string","required":false,"description":"Represents the phone number of a customer"},{"name":"taxId","in":"query","type":"string","required":false,"description":"Holds the Customer's TAX/SSN Id."},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from t24 on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"The identifier of the underlying Entity/Company/Branch."}],"requestBodyExample":null,"responses":{"200":"UsCustomerInformationResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}}]},{"key":"party-us-customerInformation-v1.1.0","title":"Retrieve Customer Information","version":"v1.1.0","description":"Retrieve customer information service required for infinity integration","endpointCount":2,"endpoints":[{"method":"GET","path":"/party/us/customers/customerInformation","fullPath":"/api/v1.1.0/party/us/customers/customerInformation","operationId":"getUsCustomerInformation","name":"search and retrieve Customer Information","summary":"Retrieve customer information service required for infinity integration","tags":[],"parameters":[{"name":"customerId","in":"query","type":"string","required":false,"description":"Identifier of the customer"},{"name":"customerName","in":"query","type":"string","required":false,"description":"Name of the customer"},{"name":"addressLine1","in":"query","type":"string","required":false,"description":"Indicates first line of the address of the BIC"},{"name":"addressCity","in":"query","type":"string","required":false,"description":"The town and/or city component of the base address of a customer"},{"name":"countryId","in":"query","type":"string","required":false,"description":"ISO country code of the financial institution. "},{"name":"zipCode","in":"query","type":"string","required":false,"description":"Zip code"},{"name":"dateOfBirth","in":"query","type":"string","required":false,"description":"The date of birth of an individual customer"},{"name":"lastName","in":"query","type":"string","required":false,"description":"The last name of an individual customer"},{"name":"phoneNumber","in":"query","type":"string","required":false,"description":"The phone number of the customer or prospect"},{"name":"firstName","in":"query","type":"string","required":false,"description":"Specifies customer's first name"},{"name":"email","in":"query","type":"string","required":false,"description":"Email Identifier of the Customer"},{"name":"mobilePhoneNumber","in":"query","type":"string","required":false,"description":"Represents the phone number of a customer"},{"name":"taxId","in":"query","type":"string","required":false,"description":"Holds the Customer's TAX/SSN Id."},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"UsCustomerInformationResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/party/us/customers/{customerId}/contactDetails","fullPath":"/api/v1.1.0/party/us/customers/{customerId}/contactDetails","operationId":"getUsCustomerAddresses","name":"Retrieve customer and address","summary":"Retrieve customer and address","tags":[],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"Identifier of the customer"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"UsCustomerAddressesResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}}]},{"key":"party-us-customerInformation-v1.2.0","title":"Retrieve Customer Information","version":"v1.2.0","description":"Retrieve customer information service required for infinity integration","endpointCount":2,"endpoints":[{"method":"GET","path":"/party/us/customers/customerInformation","fullPath":"/api/v1.2.0/party/us/customers/customerInformation","operationId":"getUsCustomerInformation","name":"Search and retrieve customer information","summary":"Retrieve customer information service required for infinity integration","tags":[],"parameters":[{"name":"customerId","in":"query","type":"string","required":false,"description":"Identifier of the customer"},{"name":"customerName","in":"query","type":"string","required":false,"description":"Name of the customer"},{"name":"addressLine1","in":"query","type":"string","required":false,"description":"Indicates first line of the address of the BIC"},{"name":"addressCity","in":"query","type":"string","required":false,"description":"The town and/or city component of the base address of a customer"},{"name":"countryId","in":"query","type":"string","required":false,"description":"ISO country code of the financial institution. "},{"name":"zipCode","in":"query","type":"string","required":false,"description":"Zip code"},{"name":"dateOfBirth","in":"query","type":"string","required":false,"description":"The date of birth of an individual customer"},{"name":"lastName","in":"query","type":"string","required":false,"description":"The last name of an individual customer"},{"name":"phoneNumber","in":"query","type":"string","required":false,"description":"The phone number of the customer or prospect"},{"name":"firstName","in":"query","type":"string","required":false,"description":"Specifies customer's first name"},{"name":"email","in":"query","type":"string","required":false,"description":"Email Identifier of the Customer"},{"name":"mobilePhoneNumber","in":"query","type":"string","required":false,"description":"Represents the phone number of a customer"},{"name":"taxId","in":"query","type":"string","required":false,"description":"Holds the Customer's TAX/SSN Id."},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"UsCustomerInformationResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/party/us/customers/{customerId}/contactDetails","fullPath":"/api/v1.2.0/party/us/customers/{customerId}/contactDetails","operationId":"getUsCustomerAddresses","name":"Retrieve customer and address","summary":"Retrieve customer and address","tags":[],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"Identifier of the customer"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"UsCustomerAddressesResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}}]},{"key":"party-us-customerInformation-v1.3.0","title":"Retrieve Customer Information","version":"v1.3.0","description":"Retrieve customer information service required for infinity integration","endpointCount":2,"endpoints":[{"method":"GET","path":"/party/us/customers/customerInformation","fullPath":"/api/v1.3.0/party/us/customers/customerInformation","operationId":"getUsCustomerInformation","name":"Search and retrieve customer information","summary":"Retrieve customer information service required for Infinity integration","tags":["RETAIL"],"parameters":[{"name":"customerId","in":"query","type":"string","required":false,"description":"Identifier of the customer"},{"name":"customerName","in":"query","type":"string","required":false,"description":"Indicates the name of the customer. Originator is the party who requests the payment cancellation."},{"name":"addressLine1","in":"query","type":"string","required":false,"description":"Indicates first line of the address of the BIC"},{"name":"addressCity","in":"query","type":"string","required":false,"description":"The town and/or city component of the base address of a customer"},{"name":"countryId","in":"query","type":"string","required":false,"description":"ISO country code of the financial institution. "},{"name":"zipCode","in":"query","type":"string","required":false,"description":"Zip code"},{"name":"dateOfBirth","in":"query","type":"string","required":false,"description":"The date of birth of an individual customer"},{"name":"lastName","in":"query","type":"string","required":false,"description":"The last name of an individual customer"},{"name":"phoneNumber","in":"query","type":"string","required":false,"description":"The phone number of the customer or prospect"},{"name":"firstName","in":"query","type":"string","required":false,"description":"Specifies customer's first name"},{"name":"email","in":"query","type":"string","required":false,"description":"Email Identifier of the Customer"},{"name":"mobilePhoneNumber","in":"query","type":"string","required":false,"description":"Represents the phone number of a customer"},{"name":"taxId","in":"query","type":"string","required":false,"description":"Holds the Customer's TAX/SSN Id."},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"UsCustomerInformationResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/party/us/customers/{customerId}/contactDetails","fullPath":"/api/v1.3.0/party/us/customers/{customerId}/contactDetails","operationId":"getUsCustomerAddresses","name":"Retrieve customer and address","summary":"Retrieve customer and address","tags":["RETAIL"],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"Identifier of the customer"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"UsCustomerAddressesResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}}]},{"key":"party-us-customerInformation-v1.4.0","title":"Retrieve Customer Information","version":"v1.4.0","description":"Retrieve customer information required for infinity integration","endpointCount":2,"endpoints":[{"method":"GET","path":"/party/us/customers/{customerId}/contactDetails","fullPath":"/api/v1.4.0/party/us/customers/{customerId}/contactDetails","operationId":"getUsCustomerAddresses","name":"Retrieve customer and address","summary":"Retrieve customer and address","tags":["RETAIL"],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"Identifier of the customer"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"UsCustomerAddressesResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/party/us/customers/customerInformation","fullPath":"/api/v1.4.0/party/us/customers/customerInformation","operationId":"getUsCustomerInformation","name":"Search and retrieve customer information","summary":"Search and retrieve customer information","tags":["RETAIL"],"parameters":[{"name":"customerId","in":"query","type":"string","required":false,"description":"Identifier of the customer"},{"name":"customerName","in":"query","type":"string","required":false,"description":"Indicates the name of the customer. Originator is the party who requests the payment cancellation."},{"name":"addressLine1","in":"query","type":"string","required":false,"description":"Indicates first line of the address of the BIC"},{"name":"addressCity","in":"query","type":"string","required":false,"description":"The town and/or city component of the base address of a customer"},{"name":"countryId","in":"query","type":"string","required":false,"description":"ISO country code of the financial institution. "},{"name":"zipCode","in":"query","type":"string","required":false,"description":"Zip code"},{"name":"dateOfBirth","in":"query","type":"string","required":false,"description":"The date of birth of an individual customer"},{"name":"lastName","in":"query","type":"string","required":false,"description":"The last name of an individual customer"},{"name":"phoneNumber","in":"query","type":"string","required":false,"description":"The phone number of the customer or prospect"},{"name":"firstName","in":"query","type":"string","required":false,"description":"Specifies customer's first name"},{"name":"email","in":"query","type":"string","required":false,"description":"Email Identifier of the Customer"},{"name":"mobilePhoneNumber","in":"query","type":"string","required":false,"description":"Represents the phone number of a customer"},{"name":"taxId","in":"query","type":"string","required":false,"description":"Holds the Customer's TAX/SSN Id."},{"name":"customerMnemonic","in":"query","type":"string","required":false,"description":"Specifies an alternative easy means of referencing the Customer"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"UsCustomerInformationResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}}]},{"key":"party-us-customerservice-v1.0.0","title":"US Model Bank Customer management","version":"v1.0.0","description":"The Customer service APIs allows modification of Customer, with specific APIs for Corporate or Individual Customers, update and information retrieval APIs for specific information like Address, secondary address, credit score, KYC, relation, beneficial ownership information for corporates, etc,.","endpointCount":27,"endpoints":[{"method":"GET","path":"/party/us/customers","fullPath":"/api/v1.0.0/party/us/customers","operationId":"searchUsCustomer","name":"API to search and retreive Customer information based on customerName, date of birth, date of incorporation, SSN or TIN, and Mobile number","summary":"Search Customer","tags":["RETAIL"],"parameters":[{"name":"customerId","in":"query","type":"string","required":false,"description":"Identifier of the customer"},{"name":"customerName","in":"query","type":"string","required":false,"description":"Name of the customer"},{"name":"taxId","in":"query","type":"string","required":false,"description":"Holds the Customer's TAX/SSN Id."},{"name":"dateOfBirth","in":"query","type":"string","required":false,"description":"The date of birth of an individual customer"},{"name":"mobileNumber","in":"query","type":"string","required":false,"description":"Mobile number of the customer"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from t24 on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"UsCustomerResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/party/us/customers/{customerId}/corporates","fullPath":"/api/v1.0.0/party/us/customers/{customerId}/corporates","operationId":"getUsCorporateCustomer","name":"Retrieves Corporate Customer information. Unless there is a specific set of information to be updated for which a separate APIs exists, this generic API can be used where all available information can be retreived.","summary":"Retrieve Corporate Customer information","tags":["RETAIL"],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"Identifier of the customer"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"UsCorporateCustomerResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/party/us/customers/{customerId}/corporates","fullPath":"/api/v1.0.0/party/us/customers/{customerId}/corporates","operationId":"updateUsCorporateCustomer","name":"Updates Corporate Customer information. Unless there is a specific set of information to be updated for which a separate APIs exists, this generic API can be used where all available information can be updated","summary":"Update Corporate Customer information","tags":["RETAIL"],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"Identifier of the customer"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"idDocument":[{}],"relationships":[{}],"relationship":[{}],"PreviousIdentification":[{}],"communication":[{}],"communicationDevice":[{}],"riskClass":[{}],"overrideReason":[{}],"crProfileType":[{}],"otherOfficers":[{}],"overrideDetails":[{}],"inputter":[{}],"dateTime":[{}],"customerName":"string","customerNameAdditional":"Defaulted if Given or family name is mentioned"}},"responses":{"200":"UsCorporateCustomerResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/party/us/customers/{customerId}/individuals","fullPath":"/api/v1.0.0/party/us/customers/{customerId}/individuals","operationId":"getUsIndividualCustomer","name":"Retrieves Individual Customer information. Unless there is a specific set of information to be updated for which a separate APIs exists, this generic API can be used where all available information for an individual Customer can be  retrieved.","summary":"Retrieve Individual Customer information","tags":["RETAIL"],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"Identifier of the customer"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"UsIndividualCustomerResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/party/us/customers/{customerId}/individuals","fullPath":"/api/v1.0.0/party/us/customers/{customerId}/individuals","operationId":"updateUsIndividualCustomer","name":"Updates Individual Customer information. Unless there is a specific set of information to be updated for which a separate APIs exists, this generic API can be used where all information for an individual Customer can be updated.","summary":"Update Individual Customer information","tags":["RETAIL"],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"Identifier of the customer"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"idDocument":[{}],"employment":[{}],"creditScore":[{}],"relationships":[{}],"relation":[{}],"PreviousIdentification":[{}],"residenceInfo":[{}],"communication":[{}],"communicationDevice":[{}],"riskClass":[{}],"overrideReason":[{}],"crProfileType":[{}],"otherOfficers":[{}],"overrideDetails":[{}],"inputter":[{}]}},"responses":{"200":"UsIndividualCustomerResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/party/us/customers/{customerId}/contactDetails","fullPath":"/api/v1.0.0/party/us/customers/{customerId}/contactDetails","operationId":"getUsCustomerAddresslist","name":"Retrieves all available mail addresses for a Customer along with information on the purpose of the address(Primary, office, etc,.), internal address reference. ","summary":"Retrieve Customer mailing addresses","tags":["RETAIL"],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"Identifier of the customer"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from t24 on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"UsCustomerAddresslistResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/party/us/customers/{customerId}/scores","fullPath":"/api/v1.0.0/party/us/customers/{customerId}/scores","operationId":"getUsCustomerCreditscore","name":"Retrieves the credit score information available for a customer. If a credit agency is provided, credit related to that agency alone is provided.","summary":"Retrieve customer credit scores","tags":["RETAIL"],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"Identifier of the customer"},{"name":"agencyId","in":"query","type":"string","required":false,"description":"Name of the agency that provided the credit score. Allowed values can be retrieved through getEbLookups for virtualTableName CREDIT.BUREAU"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from t24 on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"UsCustomerCreditscoreResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/party/us/customers/{customerId}/agencies/{agencyId}/scores","fullPath":"/api/v1.0.0/party/us/customers/{customerId}/agencies/{agencyId}/scores","operationId":"getUsCustomerCreditscoreByAgency","name":"Retrieves the credit score information available for a customer related to that reporting agency provided.","summary":"Retrieve customer credit score by agency","tags":["RETAIL"],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"Identifier of the customer"},{"name":"agencyId","in":"path","type":"string","required":true,"description":"Name of the agency that provided the credit score. Allowed values can be retrieved through getEbLookups for virtualTableName CREDIT.BUREAU"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from t24 on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"UsCustomerCreditscoreByAgencyResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/party/us/customers/{customerId}/documents","fullPath":"/api/v1.0.0/party/us/customers/{customerId}/documents","operationId":"searchUsDocuments","name":"Search documents available for customer identification. Provides information on dDocument reference, status, validity, issuer details, and version information.","summary":"Search customer documents","tags":["RETAIL"],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"Identifier of the customer"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from t24 on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"UsDocumentsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/party/us/customers/{customerId}/kycs","fullPath":"/api/v1.0.0/party/us/customers/{customerId}/kycs","operationId":"getUsCustomerKycandTax","name":"Retrieves KYC and Tax information for a customer","summary":"Retrieve customer KYC and tax information","tags":["RETAIL"],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"Identifier of the customer"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"UsCustomerKycandTaxResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/party/us/customers/{customerId}/kycs","fullPath":"/api/v1.0.0/party/us/customers/{customerId}/kycs","operationId":"updateUsCustomerKycandTax","name":"Allows update to KYC and Tax information for a customer","summary":"Update customer KYC and tax information","tags":["RETAIL"],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"Identifier of the customer"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"riskClass":[{}],"introducer":"string","contactDate":"2024-01-01","kycRelationship":"string","kycLastReviewDate":"2024-01-01","amlCheck":"NULL","amlResult":"NULL","amlLastResultDate":"2024-01-01","manualRiskClass":"string","overrideReason":"string","isKycComplete":"YES","taxCertificationType":"/v1.0.0/reference/lookups?virtualTableName=TAX.CERT.TYPE","foreignTin":"string","taxCertificationDate":"2024-01-01","reasonForMissingFtin":"/v1.0.0/reference/lookups?virtualTableName=FTIN.MIS.REASON"}},"responses":{"200":"UsCustomerKycandTaxResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/party/us/customers/{customerId}/primaryAddresses","fullPath":"/api/v1.0.0/party/us/customers/{customerId}/primaryAddresses","operationId":"getUsCustomerPrimaryAddress","name":"Retrieve Customer Primary Address","summary":"Retrieve Customer Primary Address","tags":["RETAIL"],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"Identifier of the customer"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"UsCustomerPrimaryAddressResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/party/us/customers/{customerId}/primaryAddresses","fullPath":"/api/v1.0.0/party/us/customers/{customerId}/primaryAddresses","operationId":"updateUsCustomerPrimaryAddress","name":"Update Customer Primary Address","summary":"Update Customer Primary Address","tags":["RETAIL"],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"Identifier of the customer"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"overrideDetails":[{}],"inputter":[{}],"dateTime":[{}],"addressLine1":"Specifies the first line of Customer's address.","addressLine2":"Specifies the second line of Customer's address.","city":"string","stateId":"/v1.0.0/reference/us/states","countyId":"/v1.0.0/reference/us/states/{stateId}/counties","zipCode":0.0,"zipPlusFour":0.0,"country":"/v1.0.0/reference/countries","addressStatus":"B","addressLocation":"string","addressPurpose":"CTC","recordStatus":"string"}},"responses":{"200":"UsCustomerPrimaryAddressResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/party/us/customers/{customerId}/relations","fullPath":"/api/v1.0.0/party/us/customers/{customerId}/relations","operationId":"updateUsCustomerRelation","name":"Update Relationship information for Individual Customer or update Beneficial ownership details for a Corporate Customer","summary":"Update Customer Relation","tags":["RETAIL"],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"Identifier of the customer"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"relationships":[{}],"relationship":[{}],"ownershipRuleId":"/v1.0.0/reference/us/beneficialOwnerTypes","noOwnerGt25Percent":"YES","otherOwnersLt25PercentFlag":"YES","certifierName":"string","certifierTitle":"string","additionalTitle":"string","certificationDate":"2024-01-01"}},"responses":{"200":"UsCustomerRelationResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/party/us/customers/secondaryAddresses/{addressReference}","fullPath":"/api/v1.0.0/party/us/customers/secondaryAddresses/{addressReference}","operationId":"updateUsCustomerSecondaryAddress","name":"Update existing address information for the customer.","summary":"Update secondary Address","tags":["RETAIL"],"parameters":[{"name":"addressReference","in":"path","type":"string","required":true,"description":"Reference Id of address record"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"addressLine1":"string","addressLine2":"string","shortName":"string","city":"string","stateId":"/v1.0.0/reference/us/states","countyId":"/v1.0.0/reference/us/states/{stateId}/counties","zipCode":0.0,"zipPlusFour":0.0,"country":"/v1.0.0/reference/countries","customerContactIndicator":"YES","addressStatus":"B","taxAddressType":"/v1.0.0/reference/lookups?virtualTableName=IRS.ADDRESS.TYPE","addressPurpose":"CTC"}},"responses":{"200":"UsCustomerSecondaryAddressResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"DELETE","path":"/party/us/customers/secondaryAddresses/{addressReference}","fullPath":"/api/v1.0.0/party/us/customers/secondaryAddresses/{addressReference}","operationId":"deleteUsCustomerSecondaryAddress","name":"Reverse customer's secondary address information","summary":"Reverse customer's secondary address","tags":["RETAIL"],"parameters":[{"name":"addressReference","in":"path","type":"string","required":true,"description":"Reference Id of address record"},{"name":"payload","in":"body","type":"object","required":false,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}}},"responses":{"200":"UsCustomerSecondaryAddressResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"POST","path":"/party/us/customers/{customerId}/secondaryAddresses","fullPath":"/api/v1.0.0/party/us/customers/{customerId}/secondaryAddresses","operationId":"createUsCustomerSecondaryAddress","name":"Add new customer address information","summary":"Create secondary Address","tags":["RETAIL"],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"Identifier of the customer"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"addressLine1":"string","addressLine2":"string","shortName":"string","name":"string","city":"string","stateId":"/v1.0.0/reference/us/states","countyId":"/v1.0.0/reference/us/states/{stateId}/counties","zipCode":0.0,"zipPlusFour":0.0,"country":"/v1.0.0/reference/countries","customerContactIndicator":"YES","addressStatus":"B","taxAddressType":"/v1.0.0/reference/lookups?virtualTableName=IRS.ADDRESS.TYPE","addressPurpose":"CTC"}},"responses":{"200":"UsCustomerSecondaryAddressResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"POST","path":"/party/us/customers/corporates","fullPath":"/api/v1.0.0/party/us/customers/corporates","operationId":"createUsCorporateCustomer","name":"Allows creation of a corporate customer","summary":"create Corporate Customer","tags":["RETAIL"],"parameters":[{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"idDocument":[{}],"relationships":[{}],"relationship":[{}],"PreviousIdentification":[{}],"communication":[{}],"communicationDevice":[{}],"riskClass":[{}],"overrideReason":[{}],"crProfileType":[{}],"otherOfficers":[{}],"overrideDetails":[{}],"inputter":[{}],"dateTime":[{}],"customerName":"string","customerNameAdditional":"Defaulted if Given or family name is mentioned"}},"responses":{"200":"UsCorporateCustomerResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"POST","path":"/party/us/customers/individuals","fullPath":"/api/v1.0.0/party/us/customers/individuals","operationId":"createUsIndividualCustomer","name":"Allows creation of an Individual customer","summary":"create Individual Customer","tags":["RETAIL"],"parameters":[{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"idDocument":[{}],"employment":[{}],"creditScore":[{}],"relationships":[{}],"relation":[{}],"PreviousIdentification":[{}],"residenceInfo":[{}],"communication":[{}],"communicationDevice":[{}],"riskClass":[{}],"overrideReason":[{}],"crProfileType":[{}],"otherOfficers":[{}],"overrideDetails":[{}],"inputter":[{}]}},"responses":{"200":"UsIndividualCustomerResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/party/us/customer/{customerId}/addressPreferences","fullPath":"/api/v1.0.0/party/us/customer/{customerId}/addressPreferences","operationId":"getAddressPreferences","name":"Retrieves alternate address preferences set customer","summary":"Alternate address details","tags":["RETAIL"],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"Identifier of the customer"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"AddressPreferencesResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"POST","path":"/party/us/customer/{customerId}/addressPreferences","fullPath":"/api/v1.0.0/party/us/customer/{customerId}/addressPreferences","operationId":"createAddressPreference","name":"Allows capturing alternate address for a customer to be used for mails during specific periods each year","summary":"Create alternate address ","tags":["RETAIL"],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"Identifier of the customer"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"alternateaddressperiod":[{}],"carrier":"string","defaultCarrier":"string"}},"responses":{"200":"AddressPreferenceResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/party/us/customer/{customerId}/addressPreferences","fullPath":"/api/v1.0.0/party/us/customer/{customerId}/addressPreferences","operationId":"updateAddressPreference","name":"Updates alternate address information for a customer","summary":"Update alternate address","tags":["RETAIL"],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"Identifier of the customer"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"alternateaddressperiod":[{}],"carrier":"string","defaultCarrier":"string"}},"responses":{"200":"AddressPreferenceResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/party/us/customers/{customerId}/beneficiaries","fullPath":"/api/v1.0.0/party/us/customers/{customerId}/beneficiaries","operationId":"getUsBeneficiary","name":"Retrieve list of beneficiaries created for a customer to perform  account transfer, bill payments or wires. Information can be retrieved using customerId, debitAccountId, beneficiaryNickName, accountType etc,.","summary":"Retrieve beneficiary information for a customer","tags":["RETAIL"],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"Identifier of the customer"},{"name":"beneficiaryInstituteName","in":"query","type":"string","required":false,"description":"Indicates the name of financial institution where the beneficiary account is held"},{"name":"beneficiaryAccountId","in":"query","type":"string","required":false,"description":"Unique account identifier of the beneficiary account number."},{"name":"beneficiaryNickName","in":"query","type":"string","required":false,"description":"Nickname of the beneficiary"},{"name":"accountWithBankSortCode","in":"query","type":"string","required":false,"description":"Bank sort code details with account"},{"name":"accountType","in":"query","type":"string","required":false,"description":"Groups the products based on their type, eg, Checking, Savings, CD etc,."},{"name":"beneficiaryCustomerId","in":"query","type":"string","required":false,"description":"Identifies the Customer who is to be the ultimate receiver of the funds transferred by the sending bank when this Beneficiary is not a bank."},{"name":"beneficiaryId","in":"query","type":"string","required":false,"description":"Indicates the reference of the financial institution that allows access to the beneficiary information"},{"name":"transactionType","in":"query","type":"string","required":false,"description":"Identifies the transaction type applicable to the transaction being processed, i.e. outward or inward payment. For example: ACPX, OTPX etc."},{"name":"preferredPaymentProduct","in":"query","type":"string","required":false,"description":"Preferred payment product can be specified for Beneficiary. This will be used for defaulting the payment product for specific beneficiary. "},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from t24 on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"UsBeneficiaryResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"POST","path":"/party/us/customers/{customerId}/beneficiaries","fullPath":"/api/v1.0.0/party/us/customers/{customerId}/beneficiaries","operationId":"createUsBeneficiary","name":"API to create a Beneficiary for account transfers or bill payment","summary":"Create an ACH beneficiary","tags":["RETAIL"],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"Identifier of the customer"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"beneficiaryAccountId":"string","beneficiaryNickName":"string","accountWithBankSortCode":"string","accountType":"string","beneficiaryCustomerId":"string","paymentDetails":"string","beneficiaryOtherIdType":"string","beneficiaryOtherId":"string","preferredPaymentProduct":"string","recordStatus":"Status of record -authorised/on hold/unauth etc","currNo":"No of times record has been changed","inputter":"User who has input or changed the record","dateTime":"2024-01-01","authoriser":"User who has authorised the input or change","deptCode":"Department handling the record"}},"responses":{"200":"UsBeneficiaryResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/party/us/customers/beneficiaries/{beneficiaryId}","fullPath":"/api/v1.0.0/party/us/customers/beneficiaries/{beneficiaryId}","operationId":"updateUsBeneficiary","name":"API to update a beneficiary created for account transfers or bill payment","summary":"Update ACH beneficiary","tags":["RETAIL"],"parameters":[{"name":"beneficiaryId","in":"path","type":"string","required":true,"description":"Indicates the reference of the financial institution that allows access to the beneficiary information"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"beneficiaryAccountId":"string","beneficiaryNickName":"string","accountWithBankSortCode":"string","accountType":"string","beneficiaryCustomerId":"string","paymentDetails":"string","beneficiaryOtherIdType":"string","beneficiaryOtherId":"string","preferredPaymentProduct":"string","recordStatus":"Status of record -authorised/on hold/unauth etc","currNo":"No of times record has been changed","inputter":"User who has input or changed the record","dateTime":"2024-01-01","authoriser":"User who has authorised the input or change","deptCode":"Department handling the record"}},"responses":{"200":"UsBeneficiaryResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"POST","path":"/party/us/customers/{customerId}/beneficiaries/wires","fullPath":"/api/v1.0.0/party/us/customers/{customerId}/beneficiaries/wires","operationId":"createUsWiresBeneficiary","name":"create beneficiary information for generating a wire transfer","summary":"creates beneficiary for wire transfers","tags":["RETAIL"],"parameters":[{"name":"customerId","in":"path","type":"number","required":true,"description":"Identifier of the customer"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"beneficiaryNickNames":[{}],"beneficiaryAccountId":"string","accountWithBankSortCode":"string","accountType":"@ref:reference-us-sortcodes-services","beneficiaryInstituteName":"string","beneficiaryInstituteBranchName":"string","beneficiaryInstituteAddressLine1":"string","beneficiaryInstituteAddressLine2":"string","beneficiaryInstituteAddressLine3":0.0,"beneficiaryInstituteCountryCode":"string","beneficiaryCustomerId":"string","beneficiaryShortName":"string","beneficiaryAddressLine1":"string","beneficiaryAddressLine2":"string","beneficiaryAddressCity":"string"}},"responses":{"200":"UsWiresBeneficiaryResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/party/us/customers/beneficiaries/{beneficiaryId}/wires","fullPath":"/api/v1.0.0/party/us/customers/beneficiaries/{beneficiaryId}/wires","operationId":"updateUsWiresBeneficiary","name":"updates routing number, bank details or the payee details of a beneficiary set up for wire transfers","summary":"updates existing wire payment beneficiary","tags":["RETAIL"],"parameters":[{"name":"beneficiaryId","in":"path","type":"string","required":true,"description":"Indicates the reference of the financial institution that allows access to the beneficiary information"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"beneficiaryNickNames":[{}],"beneficiaryAccountId":"string","accountWithBankSortCode":"string","accountType":"@ref:reference-us-sortcodes-services","beneficiaryInstituteName":"string","beneficiaryInstituteBranchName":"string","beneficiaryInstituteAddressLine1":"string","beneficiaryInstituteAddressLine2":"string","beneficiaryInstituteAddressLine3":0.0,"beneficiaryInstituteCountryCode":"string","beneficiaryCustomerId":"string","beneficiaryShortName":"string","beneficiaryAddressLine1":"string","beneficiaryAddressLine2":"string","beneficiaryAddressCity":"string"}},"responses":{"200":"UsWiresBeneficiaryResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}}]},{"key":"party-us-customerservice-v2.0.0","title":"US Model Bank Customer management","version":"v2.0.0","description":"The Customer service APIs allows modification of Customer, with specific APIs for Corporate or Individual Customers, update and information retrieval APIs for specific information like Address, secondary address, credit score, KYC, relation, beneficial ownership information for corporates, etc,.","endpointCount":27,"endpoints":[{"method":"GET","path":"/party/us/customers","fullPath":"/api/v2.0.0/party/us/customers","operationId":"searchUsCustomer","name":"API to search and retreive Customer information based on customerName, date of birth, date of incorporation, SSN or TIN, and Mobile number","summary":"Search Customer","tags":["RETAIL"],"parameters":[{"name":"customerId","in":"query","type":"string","required":false,"description":"Identifier of the customer"},{"name":"customerName","in":"query","type":"string","required":false,"description":"Name of the customer"},{"name":"taxId","in":"query","type":"string","required":false,"description":"Holds the Customer's TAX/SSN Id."},{"name":"dateOfBirth","in":"query","type":"string","required":false,"description":"The date of birth of an individual customer"},{"name":"mobileNumber","in":"query","type":"string","required":false,"description":"Mobile number of the customer"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from t24 on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"UsCustomerResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/party/us/customers/{customerId}/corporates","fullPath":"/api/v2.0.0/party/us/customers/{customerId}/corporates","operationId":"getUsCorporateCustomer","name":"Retrieves Corporate Customer information. Unless there is a specific set of information to be updated for which a separate APIs exists, this generic API can be used where all available information can be retreived.","summary":"Retrieve Corporate Customer information","tags":["RETAIL"],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"Identifier of the customer"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"UsCorporateCustomerResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/party/us/customers/{customerId}/corporates","fullPath":"/api/v2.0.0/party/us/customers/{customerId}/corporates","operationId":"updateUsCorporateCustomer","name":"Updates Corporate Customer information. Unless there is a specific set of information to be updated for which a separate APIs exists, this generic API can be used where all available information can be updated","summary":"Update Corporate Customer information","tags":["RETAIL"],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"Identifier of the customer"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"idDocument":[{}],"relationships":[{}],"relationship":[{}],"PreviousIdentification":[{}],"communication":[{}],"communicationDevice":[{}],"riskClass":[{}],"overrideReason":[{}],"crProfileType":[{}],"otherOfficers":[{}],"overrideDetails":[{}],"inputter":[{}],"dateTime":[{}],"customerName":"string","customerNameAdditional":"Defaulted if Given or family name is mentioned"}},"responses":{"200":"UsCorporateCustomerResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/party/us/customers/{customerId}/individuals","fullPath":"/api/v2.0.0/party/us/customers/{customerId}/individuals","operationId":"getUsIndividualCustomer","name":"Retrieves Individual Customer information. Unless there is a specific set of information to be updated for which a separate APIs exists, this generic API can be used where all available information for an individual Customer can be  retrieved.","summary":"Retrieve Individual Customer information","tags":["RETAIL"],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"Identifier of the customer"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"UsIndividualCustomerResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/party/us/customers/{customerId}/individuals","fullPath":"/api/v2.0.0/party/us/customers/{customerId}/individuals","operationId":"updateUsIndividualCustomer","name":"Updates Individual Customer information. Unless there is a specific set of information to be updated for which a separate APIs exists, this generic API can be used where all information for an individual Customer can be updated.","summary":"Update Individual Customer information","tags":["RETAIL"],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"Identifier of the customer"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"idDocument":[{}],"employment":[{}],"creditScore":[{}],"relationships":[{}],"relation":[{}],"PreviousIdentification":[{}],"residenceInfo":[{}],"communication":[{}],"communicationDevice":[{}],"riskClass":[{}],"overrideReason":[{}],"crProfileType":[{}],"otherOfficers":[{}],"overrideDetails":[{}],"inputter":[{}]}},"responses":{"200":"UsIndividualCustomerResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/party/us/customers/{customerId}/contacts","fullPath":"/api/v2.0.0/party/us/customers/{customerId}/contacts","operationId":"getUsCustomerAddresslist","name":"Retrieves all available mail addresses for a Customer along with information on the purpose of the address(Primary, office, etc,.), internal address reference. ","summary":"Retrieve Customer mailing addresses","tags":["RETAIL"],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"Identifier of the customer"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from t24 on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"UsCustomerAddresslistResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/party/us/customers/{customerId}/scores","fullPath":"/api/v2.0.0/party/us/customers/{customerId}/scores","operationId":"getUsCustomerCreditscore","name":"Retrieves the credit score information available for a customer. If a credit agency is provided, credit related to that agency alone is provided.","summary":"Retrieve customer credit scores","tags":["RETAIL"],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"Identifier of the customer"},{"name":"agencyId","in":"query","type":"string","required":false,"description":"Name of the agency that provided the credit score. Allowed values can be retrieved through getEbLookups for virtualTableName CREDIT.BUREAU"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from t24 on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"UsCustomerCreditscoreResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/party/us/customers/{customerId}/agencies/{agencyId}/scores","fullPath":"/api/v2.0.0/party/us/customers/{customerId}/agencies/{agencyId}/scores","operationId":"getUsCustomerCreditscoreByAgency","name":"Retrieves the credit score information available for a customer related to that reporting agency provided.","summary":"Retrieve customer credit score by agency","tags":["RETAIL"],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"Identifier of the customer"},{"name":"agencyId","in":"path","type":"string","required":true,"description":"Name of the agency that provided the credit score. Allowed values can be retrieved through getEbLookups for virtualTableName CREDIT.BUREAU"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from t24 on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"UsCustomerCreditscoreByAgencyResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/party/us/customers/{customerId}/documents","fullPath":"/api/v2.0.0/party/us/customers/{customerId}/documents","operationId":"searchUsDocuments","name":"Search documents available for customer identification. Provides information on dDocument reference, status, validity, issuer details, and version information.","summary":"Search customer documents","tags":["RETAIL"],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"Identifier of the customer"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from t24 on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"UsDocumentsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/party/us/customers/{customerId}/kyc","fullPath":"/api/v2.0.0/party/us/customers/{customerId}/kyc","operationId":"getUsCustomerKycandTax","name":"Retrieves KYC and Tax information for a customer","summary":"Retrieve customer KYC and tax information","tags":["RETAIL"],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"Identifier of the customer"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"UsCustomerKycandTaxResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/party/us/customers/{customerId}/kyc","fullPath":"/api/v2.0.0/party/us/customers/{customerId}/kyc","operationId":"updateUsCustomerKycandTax","name":"Allows update to KYC and Tax information for a customer","summary":"Update customer KYC and tax information","tags":["RETAIL"],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"Identifier of the customer"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"riskClass":[{}],"introducer":"string","contactDate":"2024-01-01","kycRelationship":"string","kycLastReviewDate":"2024-01-01","amlCheck":"NULL","amlResult":"NULL","amlLastResultDate":"2024-01-01","manualRiskClass":"string","overrideReason":"string","isKycComplete":"YES","taxCertificationType":"/v1.0.0/reference/lookups?virtualTableName=TAX.CERT.TYPE","foreignTin":"string","taxCertificationDate":"2024-01-01","reasonForMissingFtin":"/v1.0.0/reference/lookups?virtualTableName=FTIN.MIS.REASON"}},"responses":{"200":"UsCustomerKycandTaxResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/party/us/customers/{customerId}/primaryAddresses","fullPath":"/api/v2.0.0/party/us/customers/{customerId}/primaryAddresses","operationId":"getUsCustomerPrimaryAddress","name":"Retrieve Customer Primary Address","summary":"Retrieve Customer Primary Address","tags":["RETAIL"],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"Identifier of the customer"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"UsCustomerPrimaryAddressResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/party/us/customers/{customerId}/primaryAddresses","fullPath":"/api/v2.0.0/party/us/customers/{customerId}/primaryAddresses","operationId":"updateUsCustomerPrimaryAddress","name":"Update Customer Primary Address","summary":"Update Customer Primary Address","tags":["RETAIL"],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"Identifier of the customer"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"overrideDetails":[{}],"inputter":[{}],"dateTime":[{}],"addressLine1":"Specifies the first line of Customer's address.","addressLine2":"Specifies the second line of Customer's address.","city":"string","stateId":"/v1.0.0/reference/us/states","countyId":"/v1.0.0/reference/us/states/{stateId}/counties","zipCode":0.0,"zipPlusFour":0.0,"country":"/v1.0.0/reference/countries","addressStatus":"B","addressLocation":"string","addressPurpose":"CTC","recordStatus":"string"}},"responses":{"200":"UsCustomerPrimaryAddressResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/party/us/customers/{customerId}/relations","fullPath":"/api/v2.0.0/party/us/customers/{customerId}/relations","operationId":"updateUsCustomerRelation","name":"Update Relationship information for Individual Customer or update Beneficial ownership details for a Corporate Customer","summary":"Update Customer Relation","tags":["RETAIL"],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"Identifier of the customer"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"relationships":[{}],"relationship":[{}],"ownershipRuleId":"/v1.0.0/reference/us/beneficialOwnerTypes","noOwnerGt25Percent":"YES","otherOwnersLt25PercentFlag":"YES","certifierName":"string","certifierTitle":"string","additionalTitle":"string","certificationDate":"2024-01-01"}},"responses":{"200":"UsCustomerRelationResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/party/us/customers/secondaryAddresses/{addressReference}","fullPath":"/api/v2.0.0/party/us/customers/secondaryAddresses/{addressReference}","operationId":"updateUsCustomerSecondaryAddress","name":"Update existing address information for the customer.","summary":"Update secondary Address","tags":["RETAIL"],"parameters":[{"name":"addressReference","in":"path","type":"string","required":true,"description":"Reference Id of address record"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"addressLine1":"string","addressLine2":"string","shortName":"string","city":"string","stateId":"/v1.0.0/reference/us/states","countyId":"/v1.0.0/reference/us/states/{stateId}/counties","zipCode":0.0,"zipPlusFour":0.0,"country":"/v1.0.0/reference/countries","customerContactIndicator":"YES","addressStatus":"B","taxAddressType":"/v1.0.0/reference/lookups?virtualTableName=IRS.ADDRESS.TYPE","addressPurpose":"CTC"}},"responses":{"200":"UsCustomerSecondaryAddressResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"DELETE","path":"/party/us/customers/secondaryAddresses/{addressReference}","fullPath":"/api/v2.0.0/party/us/customers/secondaryAddresses/{addressReference}","operationId":"deleteUsCustomerSecondaryAddress","name":"Reverse customer's secondary address information","summary":"Reverse customer's secondary address","tags":["RETAIL"],"parameters":[{"name":"addressReference","in":"path","type":"string","required":true,"description":"Reference Id of address record"},{"name":"payload","in":"body","type":"object","required":false,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}}},"responses":{"200":"UsCustomerSecondaryAddressResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"POST","path":"/party/us/customers/{customerId}/secondaryAddresses","fullPath":"/api/v2.0.0/party/us/customers/{customerId}/secondaryAddresses","operationId":"createUsCustomerSecondaryAddress","name":"Add new customer address information","summary":"Create secondary Address","tags":["RETAIL"],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"Identifier of the customer"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"addressLine1":"string","addressLine2":"string","shortName":"string","name":"string","city":"string","stateId":"/v1.0.0/reference/us/states","countyId":"/v1.0.0/reference/us/states/{stateId}/counties","zipCode":0.0,"zipPlusFour":0.0,"country":"/v1.0.0/reference/countries","customerContactIndicator":"YES","addressStatus":"B","taxAddressType":"/v1.0.0/reference/lookups?virtualTableName=IRS.ADDRESS.TYPE","addressPurpose":"CTC"}},"responses":{"200":"UsCustomerSecondaryAddressResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"POST","path":"/party/us/customers/corporates","fullPath":"/api/v2.0.0/party/us/customers/corporates","operationId":"createUsCorporateCustomer","name":"Allows creation of a corporate customer","summary":"create Corporate Customer","tags":["RETAIL"],"parameters":[{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"idDocument":[{}],"relationships":[{}],"relationship":[{}],"PreviousIdentification":[{}],"communication":[{}],"communicationDevice":[{}],"riskClass":[{}],"overrideReason":[{}],"crProfileType":[{}],"otherOfficers":[{}],"overrideDetails":[{}],"inputter":[{}],"dateTime":[{}],"customerName":"string","customerNameAdditional":"Defaulted if Given or family name is mentioned"}},"responses":{"200":"UsCorporateCustomerResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"POST","path":"/party/us/customers/individuals","fullPath":"/api/v2.0.0/party/us/customers/individuals","operationId":"createUsIndividualCustomer","name":"Allows creation of an Individual customer","summary":"create Individual Customer","tags":["RETAIL"],"parameters":[{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"idDocument":[{}],"employment":[{}],"creditScore":[{}],"relationships":[{}],"relation":[{}],"PreviousIdentification":[{}],"residenceInfo":[{}],"communication":[{}],"communicationDevice":[{}],"riskClass":[{}],"overrideReason":[{}],"crProfileType":[{}],"otherOfficers":[{}],"overrideDetails":[{}],"inputter":[{}]}},"responses":{"200":"UsIndividualCustomerResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/party/us/customer/{customerId}/addressPreferences","fullPath":"/api/v2.0.0/party/us/customer/{customerId}/addressPreferences","operationId":"getAddressPreferences","name":"Retrieves alternate address preferences set customer","summary":"Alternate address details","tags":["RETAIL"],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"Identifier of the customer"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"AddressPreferencesResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"POST","path":"/party/us/customer/{customerId}/addressPreferences","fullPath":"/api/v2.0.0/party/us/customer/{customerId}/addressPreferences","operationId":"createAddressPreference","name":"Allows capturing alternate address for a customer to be used for mails during specific periods each year","summary":"Create alternate address ","tags":["RETAIL"],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"Identifier of the customer"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"alternateaddressperiod":[{}],"carrier":"string","defaultCarrier":"string"}},"responses":{"200":"AddressPreferenceResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/party/us/customer/{customerId}/addressPreferences","fullPath":"/api/v2.0.0/party/us/customer/{customerId}/addressPreferences","operationId":"updateAddressPreference","name":"Updates alternate address information for a customer","summary":"Update alternate address","tags":["RETAIL"],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"Identifier of the customer"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"alternateaddressperiod":[{}],"carrier":"string","defaultCarrier":"string"}},"responses":{"200":"AddressPreferenceResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/party/us/customers/{customerId}/beneficiaries","fullPath":"/api/v2.0.0/party/us/customers/{customerId}/beneficiaries","operationId":"getUsBeneficiary","name":"Retrieve list of beneficiaries created for a customer to perform  account transfer, bill payments or wires. Information can be retrieved using customerId, debitAccountId, beneficiaryNickName, accountType etc,.","summary":"Retrieve beneficiary information for a customer","tags":["RETAIL"],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"Identifier of the customer"},{"name":"beneficiaryInstituteName","in":"query","type":"string","required":false,"description":"Indicates the name of financial institution where the beneficiary account is held"},{"name":"beneficiaryAccountId","in":"query","type":"string","required":false,"description":"Unique account identifier of the beneficiary account number."},{"name":"beneficiaryNickName","in":"query","type":"string","required":false,"description":"Nickname of the beneficiary"},{"name":"accountWithBankSortCode","in":"query","type":"string","required":false,"description":"Bank sort code details with account"},{"name":"accountType","in":"query","type":"string","required":false,"description":"Groups the products based on their type, eg, Checking, Savings, CD etc,."},{"name":"beneficiaryCustomerId","in":"query","type":"string","required":false,"description":"Identifies the Customer who is to be the ultimate receiver of the funds transferred by the sending bank when this Beneficiary is not a bank."},{"name":"beneficiaryId","in":"query","type":"string","required":false,"description":"Indicates the reference of the financial institution that allows access to the beneficiary information"},{"name":"transactionType","in":"query","type":"string","required":false,"description":"Identifies the transaction type applicable to the transaction being processed, i.e. outward or inward payment. For example: ACPX, OTPX etc."},{"name":"preferredPaymentProduct","in":"query","type":"string","required":false,"description":"Preferred payment product can be specified for Beneficiary. This will be used for defaulting the payment product for specific beneficiary. "},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from t24 on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"UsBeneficiaryResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"POST","path":"/party/us/customers/{customerId}/beneficiaries","fullPath":"/api/v2.0.0/party/us/customers/{customerId}/beneficiaries","operationId":"createUsBeneficiary","name":"API to create a Beneficiary for account transfers or bill payment","summary":"Create an ACH beneficiary","tags":["RETAIL"],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"Identifier of the customer"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"beneficiaryAccountId":"string","beneficiaryNickName":"string","accountWithBankSortCode":"string","accountType":"string","beneficiaryCustomerId":"string","paymentDetails":"string","beneficiaryOtherIdType":"string","beneficiaryOtherId":"string","preferredPaymentProduct":"string","recordStatus":"Status of record -authorised/on hold/unauth etc","currNo":"No of times record has been changed","inputter":"User who has input or changed the record","dateTime":"2024-01-01","authoriser":"User who has authorised the input or change","deptCode":"Department handling the record"}},"responses":{"200":"UsBeneficiaryResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/party/us/customers/beneficiaries/{beneficiaryId}","fullPath":"/api/v2.0.0/party/us/customers/beneficiaries/{beneficiaryId}","operationId":"updateUsBeneficiary","name":"API to update a beneficiary created for account transfers or bill payment","summary":"Update ACH beneficiary","tags":["RETAIL"],"parameters":[{"name":"beneficiaryId","in":"path","type":"string","required":true,"description":"Indicates the reference of the financial institution that allows access to the beneficiary information"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"beneficiaryAccountId":"string","beneficiaryNickName":"string","accountWithBankSortCode":"string","accountType":"string","beneficiaryCustomerId":"string","paymentDetails":"string","beneficiaryOtherIdType":"string","beneficiaryOtherId":"string","preferredPaymentProduct":"string","recordStatus":"Status of record -authorised/on hold/unauth etc","currNo":"No of times record has been changed","inputter":"User who has input or changed the record","dateTime":"2024-01-01","authoriser":"User who has authorised the input or change","deptCode":"Department handling the record"}},"responses":{"200":"UsBeneficiaryResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"POST","path":"/party/us/customers/{customerId}/beneficiaries/wires","fullPath":"/api/v2.0.0/party/us/customers/{customerId}/beneficiaries/wires","operationId":"createUsWiresBeneficiary","name":"create beneficiary information for generating a wire transfer","summary":"creates beneficiary for wire transfers","tags":["RETAIL"],"parameters":[{"name":"customerId","in":"path","type":"number","required":true,"description":"Identifier of the customer"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"beneficiaryNickNames":[{}],"beneficiaryAccountId":"string","accountWithBankSortCode":"string","accountType":"@ref:reference-us-sortcodes-services","beneficiaryInstituteName":"string","beneficiaryInstituteBranchName":"string","beneficiaryInstituteAddressLine1":"string","beneficiaryInstituteAddressLine2":"string","beneficiaryInstituteAddressLine3":0.0,"beneficiaryInstituteCountryCode":"string","beneficiaryCustomerId":"string","beneficiaryShortName":"string","beneficiaryAddressLine1":"string","beneficiaryAddressLine2":"string","beneficiaryAddressCity":"string"}},"responses":{"200":"UsWiresBeneficiaryResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/party/us/customers/beneficiaries/{beneficiaryId}/wires","fullPath":"/api/v2.0.0/party/us/customers/beneficiaries/{beneficiaryId}/wires","operationId":"updateUsWiresBeneficiary","name":"updates routing number, bank details or the payee details of a beneficiary set up for wire transfers","summary":"updates existing wire payment beneficiary","tags":["RETAIL"],"parameters":[{"name":"beneficiaryId","in":"path","type":"string","required":true,"description":"Indicates the reference of the financial institution that allows access to the beneficiary information"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"beneficiaryNickNames":[{}],"beneficiaryAccountId":"string","accountWithBankSortCode":"string","accountType":"@ref:reference-us-sortcodes-services","beneficiaryInstituteName":"string","beneficiaryInstituteBranchName":"string","beneficiaryInstituteAddressLine1":"string","beneficiaryInstituteAddressLine2":"string","beneficiaryInstituteAddressLine3":0.0,"beneficiaryInstituteCountryCode":"string","beneficiaryCustomerId":"string","beneficiaryShortName":"string","beneficiaryAddressLine1":"string","beneficiaryAddressLine2":"string","beneficiaryAddressCity":"string"}},"responses":{"200":"UsWiresBeneficiaryResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}}]},{"key":"party-us-customerservice-v2.1.0","title":"US Model Bank Customer management","version":"v2.1.0","description":"The customer service API allows modification of customer, with specific APIs for corporate or individual customers, update and information retrieval APIs for specific information like address, secondary address, credit score, KYC, relation, beneficial ownership information for corporates, etc.","endpointCount":27,"endpoints":[{"method":"GET","path":"/party/us/customers","fullPath":"/api/v2.1.0/party/us/customers","operationId":"searchUsCustomer","name":"Retrieves and search customer information based on customer name, date of birth, date of incorporation and mobile number","summary":"Search customer information","tags":["RETAIL"],"parameters":[{"name":"customerId","in":"query","type":"string","required":false,"description":"Identifier of the customer"},{"name":"customerName","in":"query","type":"string","required":false,"description":"Name of the customer"},{"name":"taxId","in":"query","type":"string","required":false,"description":"Holds the Customer's TAX/SSN Id."},{"name":"dateOfBirth","in":"query","type":"string","required":false,"description":"The date of birth of an individual customer"},{"name":"mobileNumber","in":"query","type":"string","required":false,"description":"Mobile number of the customer"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"UsCustomerResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/party/us/customers/{customerId}/corporates","fullPath":"/api/v2.1.0/party/us/customers/{customerId}/corporates","operationId":"getUsCorporateCustomer","name":"Retrieves corporate customer information","summary":"Retrieve corporate customer information","tags":["RETAIL"],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"Identifier of the customer"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"UsCorporateCustomerResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/party/us/customers/{customerId}/corporates","fullPath":"/api/v2.1.0/party/us/customers/{customerId}/corporates","operationId":"updateUsCorporateCustomer","name":"Enables update to customer information for a corporate customer.","summary":"Update corporate customer information","tags":["RETAIL"],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"Identifier of the customer"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"idDocument":[{}],"relationships":[{}],"relationship":[{}],"PreviousIdentification":[{}],"communication":[{}],"communicationDevice":[{}],"riskClass":[{}],"overrideReason":[{}],"crProfileType":[{}],"otherOfficers":[{}],"overrideDetails":[{}],"inputter":[{}],"dateTime":[{}],"customerName":"string","customerNameAdditional":"string"}},"responses":{"200":"UsCorporateCustomerResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/party/us/customers/{customerId}/individuals","fullPath":"/api/v2.1.0/party/us/customers/{customerId}/individuals","operationId":"getUsIndividualCustomer","name":"Retrieves customer, name, date of birth, primary address, employment, tax and other other details captured as part of customer information file for an individual customer.","summary":"Retrieve individual customer information","tags":["RETAIL"],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"Identifier of the customer"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"UsIndividualCustomerResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/party/us/customers/{customerId}/individuals","fullPath":"/api/v2.1.0/party/us/customers/{customerId}/individuals","operationId":"updateUsIndividualCustomer","name":"Enables update to customer information for a individual customer.","summary":"Update individual customer information","tags":["RETAIL"],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"Identifier of the customer"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"idDocument":[{}],"employment":[{}],"creditScore":[{}],"relationships":[{}],"relation":[{}],"PreviousIdentification":[{}],"residenceInfo":[{}],"communication":[{}],"communicationDevice":[{}],"riskClass":[{}],"overrideReason":[{}],"crProfileType":[{}],"otherOfficers":[{}],"overrideDetails":[{}],"inputter":[{}]}},"responses":{"200":"UsIndividualCustomerResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/party/us/customers/{customerId}/contacts","fullPath":"/api/v2.1.0/party/us/customers/{customerId}/contacts","operationId":"getUsCustomerAddresslist","name":"Retrieves all the available mailing addresses for a customer along with information on the purpose of the address (primary, office, etc.,.), internal address reference. ","summary":"Retrieve customer mailing addresses","tags":["RETAIL"],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"Identifier of the customer"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"UsCustomerAddresslistResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/party/us/customers/{customerId}/scores","fullPath":"/api/v2.1.0/party/us/customers/{customerId}/scores","operationId":"getUsCustomerCreditscore","name":"Retrieves the credit score information available for a customer. If a credit agency is provided, credit related to that agency alone is provided.","summary":"Retrieve customer credit scores","tags":["RETAIL"],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"Identifier of the customer"},{"name":"agencyId","in":"query","type":"string","required":false,"description":"Name of the agency that provided the credit score. Allowed values can be retrieved through getEbLookups for virtualTableName CREDIT.BUREAU"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"UsCustomerCreditscoreResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/party/us/customers/{customerId}/agencies/{agencyId}/scores","fullPath":"/api/v2.1.0/party/us/customers/{customerId}/agencies/{agencyId}/scores","operationId":"getUsCustomerCreditscoreByAgency","name":"Retrieves the credit score information available for a customer related to that reporting agency provided.","summary":"Retrieve customer credit score by agency","tags":["RETAIL"],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"Identifier of the customer"},{"name":"agencyId","in":"path","type":"string","required":true,"description":"Name of the agency that provided the credit score. Allowed values can be retrieved through getEbLookups for virtualTableName CREDIT.BUREAU"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"UsCustomerCreditscoreByAgencyResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/party/us/customers/{customerId}/documents","fullPath":"/api/v2.1.0/party/us/customers/{customerId}/documents","operationId":"searchUsDocuments","name":"Search documents available for customer identification. Provides information on document reference, status, validity, issuer details, and version information.","summary":"Search customer documents","tags":["RETAIL"],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"Identifier of the customer"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"UsDocumentsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/party/us/customers/{customerId}/kyc","fullPath":"/api/v2.1.0/party/us/customers/{customerId}/kyc","operationId":"getUsCustomerKycandTax","name":"Retrieves KYC and tax information for a customer","summary":"Retrieve customer KYC and tax information","tags":["RETAIL"],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"Identifier of the customer"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"UsCustomerKycandTaxResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/party/us/customers/{customerId}/kyc","fullPath":"/api/v2.1.0/party/us/customers/{customerId}/kyc","operationId":"updateUsCustomerKycandTax","name":"Allows update to KYC and tax information for a customer","summary":"Update customer KYC and tax information","tags":["RETAIL"],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"Identifier of the customer"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"riskClass":[{}],"introducer":"string","contactDate":"2024-01-01","kycRelationship":"string","kycLastReviewDate":"2024-01-01","amlCheck":"NULL","amlResult":"NULL","amlLastResultDate":"2024-01-01","manualRiskClass":"string","overrideReason":"string","isKycComplete":"YES","taxCertificationType":"/v1.0.0/reference/lookups?virtualTableName=TAX.CERT.TYPE","foreignTin":"string","taxCertificationDate":"2024-01-01","reasonForMissingFtin":"/v1.0.0/reference/lookups?virtualTableName=FTIN.MIS.REASON"}},"responses":{"200":"UsCustomerKycandTaxResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/party/us/customers/{customerId}/primaryAddresses","fullPath":"/api/v2.1.0/party/us/customers/{customerId}/primaryAddresses","operationId":"getUsCustomerPrimaryAddress","name":"Retrieve customer primary address","summary":"Retrieve customer primary address","tags":["RETAIL"],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"Identifier of the customer"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"UsCustomerPrimaryAddressResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/party/us/customers/{customerId}/primaryAddresses","fullPath":"/api/v2.1.0/party/us/customers/{customerId}/primaryAddresses","operationId":"updateUsCustomerPrimaryAddress","name":"Update customer primary address","summary":"Update customer primary address","tags":["RETAIL"],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"Identifier of the customer"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"overrideDetails":[{}],"inputter":[{}],"dateTime":[{}],"addressLine1":"string","addressLine2":"string","city":"string","stateId":"/v1.0.0/reference/us/states","countyId":"/v1.0.0/reference/us/states/{stateId}/counties","zipCode":0.0,"zipPlusFour":0.0,"country":"/v1.0.0/reference/countries","addressStatus":"B","addressLocation":"string","addressPurpose":"CTC","recordStatus":"string"}},"responses":{"200":"UsCustomerPrimaryAddressResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/party/us/customers/{customerId}/relations","fullPath":"/api/v2.1.0/party/us/customers/{customerId}/relations","operationId":"updateUsCustomerRelation","name":"Updates relationship information for individual customer or update beneficial ownership details for a corporate customer","summary":"Updates customer relation","tags":["RETAIL"],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"Identifier of the customer"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"relationships":[{}],"relationship":[{}],"ownershipRuleId":"/v1.0.0/reference/us/beneficialOwnerTypes","noOwnerGt25Percent":"YES","otherOwnersLt25PercentFlag":"YES","certifierName":"string","certifierTitle":"string","additionalTitle":"string","certificationDate":"2024-01-01"}},"responses":{"200":"UsCustomerRelationResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/party/us/customers/secondaryAddresses/{addressReference}","fullPath":"/api/v2.1.0/party/us/customers/secondaryAddresses/{addressReference}","operationId":"updateUsCustomerSecondaryAddress","name":"Update existing address information for the customer.","summary":"Update secondary address","tags":["RETAIL"],"parameters":[{"name":"addressReference","in":"path","type":"string","required":true,"description":"Reference Id of address record"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"addressLine1":"string","addressLine2":"string","shortName":"string","city":"string","stateId":"/v1.0.0/reference/us/states","countyId":"/v1.0.0/reference/us/states/{stateId}/counties","zipCode":0.0,"zipPlusFour":0.0,"country":"/v1.0.0/reference/countries","customerContactIndicator":"YES","addressStatus":"B","taxAddressType":"/v1.0.0/reference/lookups?virtualTableName=IRS.ADDRESS.TYPE","addressPurpose":"CTC"}},"responses":{"200":"UsCustomerSecondaryAddressResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"DELETE","path":"/party/us/customers/secondaryAddresses/{addressReference}","fullPath":"/api/v2.1.0/party/us/customers/secondaryAddresses/{addressReference}","operationId":"deleteUsCustomerSecondaryAddress","name":"Reverse customer's secondary address information","summary":"Reverse customer's secondary address","tags":["RETAIL"],"parameters":[{"name":"addressReference","in":"path","type":"string","required":true,"description":"Reference Id of address record"},{"name":"payload","in":"body","type":"object","required":false,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}}},"responses":{"200":"UsCustomerSecondaryAddressResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"POST","path":"/party/us/customers/{customerId}/secondaryAddresses","fullPath":"/api/v2.1.0/party/us/customers/{customerId}/secondaryAddresses","operationId":"createUsCustomerSecondaryAddress","name":"Add new customer address information","summary":"Create secondary address","tags":["RETAIL"],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"Identifier of the customer"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"addressLine1":"string","addressLine2":"string","shortName":"string","name":"string","city":"string","stateId":"/v1.0.0/reference/us/states","countyId":"/v1.0.0/reference/us/states/{stateId}/counties","zipCode":0.0,"zipPlusFour":0.0,"country":"/v1.0.0/reference/countries","customerContactIndicator":"YES","addressStatus":"B","taxAddressType":"/v1.0.0/reference/lookups?virtualTableName=IRS.ADDRESS.TYPE","addressPurpose":"CTC"}},"responses":{"200":"UsCustomerSecondaryAddressResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"POST","path":"/party/us/customers/corporates","fullPath":"/api/v2.1.0/party/us/customers/corporates","operationId":"createUsCorporateCustomer","name":"Allows creation of a corporate customer","summary":"Create corporate customer","tags":["RETAIL"],"parameters":[{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"idDocument":[{}],"relationships":[{}],"relationship":[{}],"PreviousIdentification":[{}],"communication":[{}],"communicationDevice":[{}],"riskClass":[{}],"overrideReason":[{}],"crProfileType":[{}],"otherOfficers":[{}],"overrideDetails":[{}],"inputter":[{}],"dateTime":[{}],"customerName":"string","customerNameAdditional":"string"}},"responses":{"200":"UsCorporateCustomerResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"POST","path":"/party/us/customers/individuals","fullPath":"/api/v2.1.0/party/us/customers/individuals","operationId":"createUsIndividualCustomer","name":"Allows creation of an individual customer","summary":"Create individual customer","tags":["RETAIL"],"parameters":[{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"idDocument":[{}],"employment":[{}],"creditScore":[{}],"relationships":[{}],"relation":[{}],"PreviousIdentification":[{}],"residenceInfo":[{}],"communication":[{}],"communicationDevice":[{}],"riskClass":[{}],"overrideReason":[{}],"crProfileType":[{}],"otherOfficers":[{}],"overrideDetails":[{}],"inputter":[{}]}},"responses":{"200":"UsIndividualCustomerResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/party/us/customer/{customerId}/addressPreferences","fullPath":"/api/v2.1.0/party/us/customer/{customerId}/addressPreferences","operationId":"getAddressPreferences","name":"Retrieves the alternate address preferences set for a customer","summary":"Alternate address details","tags":["RETAIL"],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"Identifier of the customer"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"AddressPreferencesResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"POST","path":"/party/us/customer/{customerId}/addressPreferences","fullPath":"/api/v2.1.0/party/us/customer/{customerId}/addressPreferences","operationId":"createAddressPreference","name":"Allows capturing alternate address for a customer to be used for mails during specific periods each year","summary":"Create alternate address ","tags":["RETAIL"],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"Identifier of the customer"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"alternateaddressperiod":[{}],"carrier":"string","defaultCarrier":"string"}},"responses":{"200":"AddressPreferenceResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/party/us/customer/{customerId}/addressPreferences","fullPath":"/api/v2.1.0/party/us/customer/{customerId}/addressPreferences","operationId":"updateAddressPreference","name":"Updates alternate address information for a customer","summary":"Update alternate address","tags":["RETAIL"],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"Identifier of the customer"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"alternateaddressperiod":[{}],"carrier":"string","defaultCarrier":"string"}},"responses":{"200":"AddressPreferenceResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/party/us/customers/{customerId}/beneficiaries","fullPath":"/api/v2.1.0/party/us/customers/{customerId}/beneficiaries","operationId":"getUsBeneficiary","name":"Retrieve list of beneficiaries created for a customer to perform  account transfer, bill payments or wires. Information can be retrieved using customer identifier, debit account, beneficiary nick name, type of account etc.","summary":"Retrieve beneficiary information for a customer","tags":["RETAIL"],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"Identifier of the customer"},{"name":"beneficiaryInstituteName","in":"query","type":"string","required":false,"description":"Indicates the name of financial institution where the beneficiary account is held"},{"name":"beneficiaryAccountId","in":"query","type":"string","required":false,"description":"Unique account identifier of the beneficiary account number."},{"name":"beneficiaryNickName","in":"query","type":"string","required":false,"description":"Nickname of the beneficiary"},{"name":"accountWithBankSortCode","in":"query","type":"string","required":false,"description":"Bank sort code details with account"},{"name":"accountType","in":"query","type":"string","required":false,"description":"Groups the products based on their type, eg, Checking, Savings, CD etc,."},{"name":"beneficiaryCustomerId","in":"query","type":"string","required":false,"description":"Identifies the Customer who is to be the ultimate receiver of the funds transferred by the sending bank when this Beneficiary is not a bank."},{"name":"beneficiaryId","in":"query","type":"string","required":false,"description":"Indicates the reference of the financial institution that allows access to the beneficiary information"},{"name":"transactionType","in":"query","type":"string","required":false,"description":"Identifies the transaction type applicable to the transaction being processed, i.e. outward or inward payment. For example: ACPX, OTPX etc."},{"name":"preferredPaymentProduct","in":"query","type":"string","required":false,"description":"Preferred payment product can be specified for Beneficiary. This will be used for defaulting the payment product for specific beneficiary. "},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"UsBeneficiaryResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"POST","path":"/party/us/customers/{customerId}/beneficiaries","fullPath":"/api/v2.1.0/party/us/customers/{customerId}/beneficiaries","operationId":"createUsBeneficiary","name":"Create a beneficiary for account transfers or bill payment","summary":"Create an ACH (automated clearing house) beneficiary","tags":["RETAIL"],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"Identifier of the customer"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"beneficiaryAccountId":"string","beneficiaryNickName":"string","accountWithBankSortCode":"string","accountType":"CHECKING","beneficiaryCustomerId":"string","paymentDetails":"string","beneficiaryOtherIdType":"ORGANISATION","beneficiaryOtherId":"string","preferredPaymentProduct":"string","recordStatus":"string","currNo":"string","inputter":"string","dateTime":"2024-01-01","authoriser":"string","deptCode":"string"}},"responses":{"200":"UsBeneficiaryResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/party/us/customers/beneficiaries/{beneficiaryId}","fullPath":"/api/v2.1.0/party/us/customers/beneficiaries/{beneficiaryId}","operationId":"updateUsBeneficiary","name":"Update a beneficiary created for account transfers or bill payment","summary":"Update an ACH (automated clearing house) beneficiary","tags":["RETAIL"],"parameters":[{"name":"beneficiaryId","in":"path","type":"string","required":true,"description":"Indicates the reference of the financial institution that allows access to the beneficiary information"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"beneficiaryAccountId":"string","beneficiaryNickName":"string","accountWithBankSortCode":"string","accountType":"CHECKING","beneficiaryCustomerId":"string","paymentDetails":"string","beneficiaryOtherIdType":"ORGANISATION","beneficiaryOtherId":"string","preferredPaymentProduct":"string","recordStatus":"string","currNo":"string","inputter":"string","dateTime":"2024-01-01","authoriser":"string","deptCode":"string"}},"responses":{"200":"UsBeneficiaryResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"POST","path":"/party/us/customers/{customerId}/beneficiaries/wires","fullPath":"/api/v2.1.0/party/us/customers/{customerId}/beneficiaries/wires","operationId":"createUsWiresBeneficiary","name":"Creates beneficiary information for generating a wire transfer","summary":"Creates beneficiary for wire transfer","tags":["RETAIL"],"parameters":[{"name":"customerId","in":"path","type":"number","required":true,"description":"Identifier of the customer"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"beneficiaryNickNames":[{}],"beneficiaryAccountId":"string","accountWithBankSortCode":"string","accountType":"@ref:reference-us-sortcodes-services","beneficiaryInstituteName":"string","beneficiaryInstituteBranchName":"string","beneficiaryInstituteAddressLine1":"string","beneficiaryInstituteAddressLine2":"string","beneficiaryInstituteAddressLine3":0.0,"beneficiaryInstituteCountryCode":"string","beneficiaryCustomerId":"string","beneficiaryShortName":"string","beneficiaryAddressLine1":"string","beneficiaryAddressLine2":"string","beneficiaryAddressCity":"string"}},"responses":{"200":"UsWiresBeneficiaryResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/party/us/customers/beneficiaries/{beneficiaryId}/wires","fullPath":"/api/v2.1.0/party/us/customers/beneficiaries/{beneficiaryId}/wires","operationId":"updateUsWiresBeneficiary","name":"Updates routing number, bank details or the payee details of a beneficiary set up for wire transfers","summary":"Updates existing wire payment beneficiary","tags":["RETAIL"],"parameters":[{"name":"beneficiaryId","in":"path","type":"string","required":true,"description":"Indicates the reference of the financial institution that allows access to the beneficiary information"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"beneficiaryNickNames":[{}],"beneficiaryAccountId":"string","accountWithBankSortCode":"string","accountType":"@ref:reference-us-sortcodes-services","beneficiaryInstituteName":"string","beneficiaryInstituteBranchName":"string","beneficiaryInstituteAddressLine1":"string","beneficiaryInstituteAddressLine2":"string","beneficiaryInstituteAddressLine3":0.0,"beneficiaryInstituteCountryCode":"string","beneficiaryCustomerId":"string","beneficiaryShortName":"string","beneficiaryAddressLine1":"string","beneficiaryAddressLine2":"string","beneficiaryAddressCity":"string"}},"responses":{"200":"UsWiresBeneficiaryResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}}]},{"key":"party-us-customerservice-v3.0.0","title":"US Model Bank Customer management","version":"v3.0.0","description":"The customer service API allows to create, update and modify customer, contact details, address and beneficiary. Separate URIs are available for corporate and individual customers to update or retrieve specific information like Address, secondary address, credit score, KYC, relation, beneficial owne","endpointCount":29,"endpoints":[{"method":"GET","path":"/party/us/customers","fullPath":"/api/v3.0.0/party/us/customers","operationId":"searchUsCustomer","name":"API to search and retrieve customer information based on customerName, date of birth, date of incorporation, SSN or TIN, and mobile number","summary":"Search Customer","tags":["RETAIL"],"parameters":[{"name":"customerId","in":"query","type":"string","required":false,"description":"Identifier of the customer"},{"name":"customerName","in":"query","type":"string","required":false,"description":"Name of the customer"},{"name":"taxId","in":"query","type":"string","required":false,"description":"Holds the Customer's TAX/SSN Id."},{"name":"dateOfBirth","in":"query","type":"string","required":false,"description":"The date of birth of an individual customer"},{"name":"mobileNumber","in":"query","type":"string","required":false,"description":"Mobile number of the customer"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"UsCustomerResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/party/us/customers/{customerId}/corporates","fullPath":"/api/v3.0.0/party/us/customers/{customerId}/corporates","operationId":"getUsCorporateCustomer","name":"Retrieves corporate customer information. Unless there is a specific set of information to be updated for which a separate APIs exists, this generic API can be used where all available information can be retrieved.","summary":"Retrieve corporate customer information","tags":["RETAIL"],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"Identifier of the customer"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"UsCorporateCustomerResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/party/us/customers/{customerId}/corporates","fullPath":"/api/v3.0.0/party/us/customers/{customerId}/corporates","operationId":"updateUsCorporateCustomer","name":"Updates corporate customer information. Unless there is a specific set of information to be updated for which a separate URIs exists, this generic URI can be used where all available information can be updated","summary":"Update corporate customer information","tags":["RETAIL"],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"Identifier of the customer"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"idDocument":[{}],"relationships":[{}],"relationship":[{}],"PreviousIdentification":[{}],"communication":[{}],"riskClass":[{}],"overrideReason":[{}],"crProfileType":[{}],"otherOfficers":[{}],"overrideDetails":[{}],"inputter":[{}],"dateTime":[{}],"customerName":"string","customerNameAdditional":"Defaulted if Given or family name is mentioned","shortName":"Short name of the customer"}},"responses":{"200":"UsCorporateCustomerResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/party/us/customers/{customerId}/individuals","fullPath":"/api/v3.0.0/party/us/customers/{customerId}/individuals","operationId":"getUsIndividualCustomer","name":"Retrieves individual customer information. Unless there is a specific set of information to be updated for which a separate URIs exists, this generic URI can be used where all available information for an individual Customer can be  retrieved.","summary":"Retrieve individual customer information","tags":["RETAIL"],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"Identifier of the customer"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"UsIndividualCustomerResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/party/us/customers/{customerId}/individuals","fullPath":"/api/v3.0.0/party/us/customers/{customerId}/individuals","operationId":"updateUsIndividualCustomer","name":"Updates individual customer information. Unless there is a specific set of information to be updated for which a separate URIs exists, this generic URI can be used where all information for an individual customer can be updated.","summary":"Update individual customer information","tags":["RETAIL"],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"Identifier of the customer"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"idDocument":[{}],"employment":[{}],"creditScore":[{}],"relationships":[{}],"relation":[{}],"PreviousIdentification":[{}],"residenceInfo":[{}],"communication":[{}],"riskClass":[{}],"overrideReason":[{}],"crProfileType":[{}],"otherOfficers":[{}],"overrideDetails":[{}],"inputter":[{}],"dateTime":[{}]}},"responses":{"200":"UsIndividualCustomerResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/party/us/customers/{customerId}/contacts","fullPath":"/api/v3.0.0/party/us/customers/{customerId}/contacts","operationId":"getUsCustomerAddresslist","name":"Retrieves all available mail addresses for a customer along with information on the purpose of the address(Primary, office, etc,.), internal address reference. ","summary":"Retrieve customer mailing addresses","tags":["RETAIL"],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"Identifier of the customer"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"UsCustomerAddresslistResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/party/us/customers/{customerId}/scores","fullPath":"/api/v3.0.0/party/us/customers/{customerId}/scores","operationId":"getUsCustomerCreditscore","name":"Retrieves customers credit score information received from credit agencies.","summary":"Retrieve customer credit scores","tags":["RETAIL"],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"Identifier of the customer"},{"name":"agencyId","in":"query","type":"string","required":false,"description":"Name of the agency that provided the credit score. Allowed values can be retrieved through getEbLookups for virtualTableName CREDIT.BUREAU"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"UsCustomerCreditscoreResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/party/us/customers/{customerId}/agencies/{agencyId}/scores","fullPath":"/api/v3.0.0/party/us/customers/{customerId}/agencies/{agencyId}/scores","operationId":"getUsCustomerCreditscoreByAgency","name":"Retrieves the credit score information available for a customer from the specific reporting agency provided in the URI.","summary":"Retrieve customer credit score by agency","tags":["RETAIL"],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"Identifier of the customer"},{"name":"agencyId","in":"path","type":"string","required":true,"description":"Name of the agency that provided the credit score. Allowed values can be retrieved through getEbLookups for virtualTableName CREDIT.BUREAU"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"UsCustomerCreditscoreByAgencyResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/party/us/customers/{customerId}/documents","fullPath":"/api/v3.0.0/party/us/customers/{customerId}/documents","operationId":"searchUsDocuments","name":"Search documents available for customer identification. Provides information on document reference, status, validity, issuer details, and version information.","summary":"Search customer documents","tags":["RETAIL"],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"Identifier of the customer"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"UsDocumentsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/party/us/customers/{customerId}/kyc","fullPath":"/api/v3.0.0/party/us/customers/{customerId}/kyc","operationId":"getUsCustomerKycandTax","name":"Retrieves KYC and tax information for a customer","summary":"Retrieve customer KYC and tax information","tags":["RETAIL"],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"Identifier of the customer"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"UsCustomerKycandTaxResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/party/us/customers/{customerId}/kyc","fullPath":"/api/v3.0.0/party/us/customers/{customerId}/kyc","operationId":"updateUsCustomerKycandTax","name":"Allows update to KYC and tax information for a customer","summary":"Update customer KYC and tax information","tags":["RETAIL"],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"Identifier of the customer"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"riskClass":[{}],"introducer":"string","contactDate":"2024-01-01","kycRelationship":"string","kycLastReviewDate":"2024-01-01","amlCheck":"NULL","amlResult":"NULL","amlLastResultDate":"2024-01-01","manualRiskClass":"string","overrideReason":"string","isKycComplete":"YES","taxCertificationType":"/v1.0.0/reference/lookups?virtualTableName=TAX.CERT.TYPE","foreignTin":"string","taxCertificationDate":"2024-01-01","reasonForMissingFtin":"/v1.0.0/reference/lookups?virtualTableName=FTIN.MIS.REASON"}},"responses":{"200":"UsCustomerKycandTaxResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/party/us/customers/{customerId}/primaryAddresses","fullPath":"/api/v3.0.0/party/us/customers/{customerId}/primaryAddresses","operationId":"getUsCustomerPrimaryAddress","name":"Retrieve Customer Primary Address","summary":"Retrieve Customer Primary Address","tags":["RETAIL"],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"Identifier of the customer"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"UsCustomerPrimaryAddressResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/party/us/customers/{customerId}/primaryAddresses","fullPath":"/api/v3.0.0/party/us/customers/{customerId}/primaryAddresses","operationId":"updateUsCustomerPrimaryAddress","name":"Update Customer Primary Address","summary":"Update Customer Primary Address","tags":["RETAIL"],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"Identifier of the customer"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"overrideDetails":[{}],"inputter":[{}],"dateTime":[{}],"addressLine1":"Specifies the first line of Customer's address.","addressLine2":"Specifies the second line of Customer's address.","city":"string","stateId":"/v1.0.0/reference/us/states","countyId":"/v1.0.0/reference/us/states/{stateId}/counties","zipCode":0.0,"zipPlusFour":0.0,"country":"/v1.0.0/reference/countries","addressStatus":"B","addressLocation":"string","addressPurpose":"CTC","recordStatus":"string"}},"responses":{"200":"UsCustomerPrimaryAddressResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/party/us/customers/{customerId}/relations","fullPath":"/api/v3.0.0/party/us/customers/{customerId}/relations","operationId":"updateUsCustomerRelation","name":"Update relationship information for an individual customer or update beneficial ownership details for a corporate customer","summary":"Update Customer Relation","tags":["RETAIL"],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"Identifier of the customer"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"relationships":[{}],"relationship":[{}],"ownershipRuleId":"/v1.0.0/reference/us/beneficialOwnerTypes","noOwnerGt25Percent":"YES","otherOwnersLt25PercentFlag":"YES","certifierName":"string","certifierTitle":"string","additionalTitle":"string","certificationDate":"2024-01-01"}},"responses":{"200":"UsCustomerRelationResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/party/us/customers/secondaryAddresses/{addressReference}","fullPath":"/api/v3.0.0/party/us/customers/secondaryAddresses/{addressReference}","operationId":"updateUsCustomerSecondaryAddress","name":"Update existing address information for the customer.","summary":"Update secondary Address","tags":["RETAIL"],"parameters":[{"name":"addressReference","in":"path","type":"string","required":true,"description":"Reference Id of address record"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"addressLine1":"string","addressLine2":"string","shortName":"string","city":"string","stateId":"/v1.0.0/reference/us/states","countyId":"/v1.0.0/reference/us/states/{stateId}/counties","zipCode":0.0,"zipPlusFour":0.0,"country":"/v1.0.0/reference/countries","customerContactIndicator":"YES","addressStatus":"B","taxAddressType":"/v1.0.0/reference/lookups?virtualTableName=IRS.ADDRESS.TYPE","addressPurpose":"CTC"}},"responses":{"200":"UsCustomerSecondaryAddressResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"DELETE","path":"/party/us/customers/secondaryAddresses/{addressReference}","fullPath":"/api/v3.0.0/party/us/customers/secondaryAddresses/{addressReference}","operationId":"deleteUsCustomerSecondaryAddress","name":"Remove customer's secondary address information","summary":"Remove customer's secondary address","tags":["RETAIL"],"parameters":[{"name":"addressReference","in":"path","type":"string","required":true,"description":"Reference Id of address record"},{"name":"payload","in":"body","type":"object","required":false,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}}},"responses":{"200":"UsCustomerSecondaryAddressResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"POST","path":"/party/us/customers/{customerId}/secondaryAddresses","fullPath":"/api/v3.0.0/party/us/customers/{customerId}/secondaryAddresses","operationId":"createUsCustomerSecondaryAddress","name":"Add new customer address information","summary":"Create secondary Address","tags":["RETAIL"],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"Identifier of the customer"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"addressLine1":"string","addressLine2":"string","shortName":"string","name":"string","city":"string","stateId":"/v1.0.0/reference/us/states","countyId":"/v1.0.0/reference/us/states/{stateId}/counties","zipCode":0.0,"zipPlusFour":0.0,"country":"/v1.0.0/reference/countries","customerContactIndicator":"YES","addressStatus":"B","taxAddressType":"/v1.0.0/reference/lookups?virtualTableName=IRS.ADDRESS.TYPE","addressPurpose":"CTC"}},"responses":{"200":"UsCustomerSecondaryAddressResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"POST","path":"/party/us/customers/corporates","fullPath":"/api/v3.0.0/party/us/customers/corporates","operationId":"createUsCorporateCustomer","name":"Allows creation of a corporate customer","summary":"Create corporate customer","tags":["RETAIL"],"parameters":[{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"idDocument":[{}],"relationships":[{}],"relationship":[{}],"PreviousIdentification":[{}],"communication":[{}],"communicationDevices":[{}],"officePhoneNumbers":[{}],"faxIds":[{}],"riskClass":[{}],"overrideReason":[{}],"crProfileType":[{}],"otherOfficers":[{}],"overrideDetails":[{}],"inputter":[{}],"dateTime":[{}]}},"responses":{"200":"UsCorporateCustomerResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"POST","path":"/party/us/customers/individuals","fullPath":"/api/v3.0.0/party/us/customers/individuals","operationId":"createUsIndividualCustomer","name":"Allows creation of an Individual customer","summary":"create individual customer","tags":["RETAIL"],"parameters":[{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"idDocument":[{}],"employment":[{}],"creditScore":[{}],"relationships":[{}],"relation":[{}],"PreviousIdentification":[{}],"residenceInfo":[{}],"communication":[{}],"communicationDevices":[{}],"officePhoneNumbers":[{}],"faxIds":[{}],"riskClass":[{}],"overrideReason":[{}],"crProfileType":[{}],"otherOfficers":[{}]}},"responses":{"200":"UsIndividualCustomerResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/party/us/customer/{customerId}/addressPreferences","fullPath":"/api/v3.0.0/party/us/customer/{customerId}/addressPreferences","operationId":"getAddressPreferences","name":"Retrieves seasonal address preferences set customer. Provides the address carrier and the duration for which an address should be used as the primary address","summary":"Seasonal address details","tags":["RETAIL"],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"Identifier of the customer"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"AddressPreferencesResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"POST","path":"/party/us/customer/{customerId}/addressPreferences","fullPath":"/api/v3.0.0/party/us/customer/{customerId}/addressPreferences","operationId":"createAddressPreference","name":"Allows capturing alternate address for a customer to be used for mails during specific periods each year","summary":"Create alternate address ","tags":["RETAIL"],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"Identifier of the customer"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"alternateaddressperiod":[{}],"carrier":"string","defaultCarrier":"string"}},"responses":{"200":"AddressPreferenceResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/party/us/customer/{customerId}/addressPreferences","fullPath":"/api/v3.0.0/party/us/customer/{customerId}/addressPreferences","operationId":"updateAddressPreference","name":"Updates alternate address information for a customer","summary":"Update alternate address","tags":["RETAIL"],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"Identifier of the customer"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"alternateaddressperiod":[{}],"carrier":"string","defaultCarrier":"string"}},"responses":{"200":"AddressPreferenceResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/party/us/customers/{customerId}/beneficiaries","fullPath":"/api/v3.0.0/party/us/customers/{customerId}/beneficiaries","operationId":"getUsBeneficiary","name":"Retrieve list of beneficiaries created for a customer to perform  account transfer, bill payments or wires. Information can be retrieved using customerId, debitAccountId, beneficiaryNickName, accountType etc,.","summary":"Retrieve beneficiary information for a customer","tags":["RETAIL"],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"Identifier of the customer"},{"name":"beneficiaryInstituteName","in":"query","type":"string","required":false,"description":"Indicates the name of financial institution where the beneficiary account is held"},{"name":"beneficiaryAccountId","in":"query","type":"string","required":false,"description":"Unique account identifier of the beneficiary account number."},{"name":"beneficiaryNickName","in":"query","type":"string","required":false,"description":"Nickname of the beneficiary"},{"name":"accountWithBankSortCode","in":"query","type":"string","required":false,"description":"Bank sort code details with account"},{"name":"accountType","in":"query","type":"string","required":false,"description":"Groups the products based on their type, eg, Checking, Savings, CD etc,."},{"name":"beneficiaryCustomerId","in":"query","type":"string","required":false,"description":"Identifies the Customer who is to be the ultimate receiver of the funds transferred by the sending bank when this Beneficiary is not a bank."},{"name":"beneficiaryId","in":"query","type":"string","required":false,"description":"Indicates the reference of the financial institution that allows access to the beneficiary information"},{"name":"transactionType","in":"query","type":"string","required":false,"description":"Identifies the transaction type applicable to the transaction being processed, i.e. outward or inward payment. For example: ACPX, OTPX etc."},{"name":"preferredPaymentProduct","in":"query","type":"string","required":false,"description":"Preferred payment product can be specified for Beneficiary. This will be used for defaulting the payment product for specific beneficiary. "},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"UsBeneficiaryResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"POST","path":"/party/us/customers/{customerId}/beneficiaries","fullPath":"/api/v3.0.0/party/us/customers/{customerId}/beneficiaries","operationId":"createUsBeneficiary","name":"API to create a beneficiary for account transfers or bill payment","summary":"Create an ACH beneficiary","tags":["RETAIL"],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"Identifier of the customer"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"beneficiaryAccountId":"string","beneficiaryNickName":"string","accountWithBankSortCode":"string","accountType":"string","beneficiaryCustomerId":"string","paymentDetails":"string","beneficiaryOtherIdType":"string","beneficiaryOtherId":"string","preferredPaymentProduct":"string","recordStatus":"Status of record -authorised/on hold/unauth etc","currNo":"No of times record has been changed","inputter":"User who has input or changed the record","dateTime":"2024-01-01","authoriser":"User who has authorised the input or change","deptCode":"Department handling the record"}},"responses":{"200":"UsBeneficiaryResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/party/us/customers/beneficiaries/{beneficiaryId}","fullPath":"/api/v3.0.0/party/us/customers/beneficiaries/{beneficiaryId}","operationId":"updateUsBeneficiary","name":"API to update a beneficiary created for account transfers or bill payment","summary":"Update ACH beneficiary","tags":["RETAIL"],"parameters":[{"name":"beneficiaryId","in":"path","type":"string","required":true,"description":"Indicates the reference of the financial institution that allows access to the beneficiary information"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"beneficiaryAccountId":"string","beneficiaryNickName":"string","accountWithBankSortCode":"string","accountType":"string","beneficiaryCustomerId":"string","paymentDetails":"string","beneficiaryOtherIdType":"string","beneficiaryOtherId":"string","preferredPaymentProduct":"string","recordStatus":"Status of record -authorised/on hold/unauth etc","currNo":"No of times record has been changed","inputter":"User who has input or changed the record","dateTime":"2024-01-01","authoriser":"User who has authorised the input or change","deptCode":"Department handling the record"}},"responses":{"200":"UsBeneficiaryResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"POST","path":"/party/us/customers/{customerId}/beneficiaries/wires","fullPath":"/api/v3.0.0/party/us/customers/{customerId}/beneficiaries/wires","operationId":"createUsWiresBeneficiary","name":"create beneficiary information for generating a wire transfer","summary":"Creates beneficiary for wire transfers","tags":["RETAIL"],"parameters":[{"name":"customerId","in":"path","type":"number","required":true,"description":"Identifier of the customer"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"beneficiaryNickNames":[{}],"beneficiaryAccountId":"string","accountWithBankSortCode":"string","accountType":"@ref:reference-us-sortcodes-services","beneficiaryInstituteName":"string","beneficiaryInstituteBranchName":"string","beneficiaryInstituteAddressLine1":"string","beneficiaryInstituteAddressLine2":"string","beneficiaryInstituteAddressLine3":0.0,"beneficiaryInstituteCountryCode":"string","beneficiaryCustomerId":"string","beneficiaryShortName":"string","beneficiaryAddressLine1":"string","beneficiaryAddressLine2":"string","beneficiaryAddressCity":"string"}},"responses":{"200":"UsWiresBeneficiaryResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/party/us/customers/beneficiaries/{beneficiaryId}/wires","fullPath":"/api/v3.0.0/party/us/customers/beneficiaries/{beneficiaryId}/wires","operationId":"updateUsWiresBeneficiary","name":"Updates routing number, bank details or the payee details of a beneficiary set up for wire transfers","summary":"Updates existing wire payment beneficiary","tags":["RETAIL"],"parameters":[{"name":"beneficiaryId","in":"path","type":"string","required":true,"description":"Indicates the reference of the financial institution that allows access to the beneficiary information"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"beneficiaryNickNames":[{}],"beneficiaryAccountId":"string","accountWithBankSortCode":"string","accountType":"@ref:reference-us-sortcodes-services","beneficiaryInstituteName":"string","beneficiaryInstituteBranchName":"string","beneficiaryInstituteAddressLine1":"string","beneficiaryInstituteAddressLine2":"string","beneficiaryInstituteAddressLine3":0.0,"beneficiaryInstituteCountryCode":"string","beneficiaryCustomerId":"string","beneficiaryShortName":"string","beneficiaryAddressLine1":"string","beneficiaryAddressLine2":"string","beneficiaryAddressCity":"string"}},"responses":{"200":"UsWiresBeneficiaryResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/party/us/customers/{customerId}/contactDetails","fullPath":"/api/v3.0.0/party/us/customers/{customerId}/contactDetails","operationId":"createUsCustomerGetContactDetail","name":"Retrieves customers phone, office phone, mobile, email or fax numbers and the consent for sharing contact information with financial institutes marketing partners.","summary":"Retrieve customer contact and consent information","tags":[],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"UsCustomerGetContactDetailResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/party/us/customers/{customerId}/contactDetails","fullPath":"/api/v3.0.0/party/us/customers/{customerId}/contactDetails","operationId":"createUsCustomerContactDetail","name":"Create or update customer phone, office phone, mobile, email or fax numbers and the consent for sharing contact information with financial institutes marketing partners.","summary":"Create or update customer contact and consent information","tags":[],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":""},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"contactDetails":[{}],"consentDetails":[{}],"customerContactFlag":"string"}},"responses":{"200":"UsCustomerContactDetailResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}}]},{"key":"party-us-customerservice-v3.1.0","title":"US Model Bank Customer management","version":"v3.1.0","description":"The customer service API allows to create, update and modify customer, contact details, address and beneficiary. Separate URIs are available for corporate and individual customers to update or retrieve specific information like Address, secondary address, credit score, KYC, relation, beneficial owne","endpointCount":28,"endpoints":[{"method":"GET","path":"/party/us/customers","fullPath":"/api/v3.1.0/party/us/customers","operationId":"searchUsCustomer","name":"Search and retrieve customer information based on customerName, date of birth, date of incorporation, SSN or TIN, and mobile number","summary":"Search Customer","tags":["RETAIL"],"parameters":[{"name":"customerId","in":"query","type":"string","required":false,"description":"Identifier of the customer"},{"name":"customerName","in":"query","type":"string","required":false,"description":"Name of the customer"},{"name":"taxId","in":"query","type":"string","required":false,"description":"Holds the Customer's TAX/SSN Id."},{"name":"dateOfBirth","in":"query","type":"string","required":false,"description":"The date of birth of an individual customer"},{"name":"mobileNumber","in":"query","type":"string","required":false,"description":"Mobile number of the customer"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"UsCustomerResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/party/us/customers/{customerId}/corporates","fullPath":"/api/v3.1.0/party/us/customers/{customerId}/corporates","operationId":"getUsCorporateCustomer","name":"Retrieves corporate customer information. Unless there is a specific set of information to be updated for which a separate APIs exists, this generic API can be used where all available information can be retrieved.","summary":"Retrieve corporate customer information","tags":["RETAIL"],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"Identifier of the customer"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"UsCorporateCustomerResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/party/us/customers/{customerId}/corporates","fullPath":"/api/v3.1.0/party/us/customers/{customerId}/corporates","operationId":"updateUsCorporateCustomer","name":"Updates corporate customer information. Unless there is a specific set of information to be updated for which a separate URIs exists, this generic URI can be used where all available information can be updated","summary":"Update corporate customer information","tags":["RETAIL"],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"Identifier of the customer"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"idDocument":[{}],"relationships":[{}],"relationship":[{}],"PreviousIdentification":[{}],"communication":[{}],"riskClass":[{}],"overrideReason":[{}],"crProfileType":[{}],"otherOfficers":[{}],"overrideDetails":[{}],"inputter":[{}],"dateTime":[{}],"customerName":"string","customerNameAdditional":"string","shortName":"string"}},"responses":{"200":"UsCorporateCustomerResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/party/us/customers/{customerId}/individuals","fullPath":"/api/v3.1.0/party/us/customers/{customerId}/individuals","operationId":"getUsIndividualCustomer","name":"Retrieves individual customer information. Unless there is a specific set of information to be updated for which a separate URIs exists, this generic URI can be used where all available information for an individual Customer can be  retrieved.","summary":"Retrieve individual customer information","tags":["RETAIL"],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"Identifier of the customer"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"UsIndividualCustomerResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/party/us/customers/{customerId}/individuals","fullPath":"/api/v3.1.0/party/us/customers/{customerId}/individuals","operationId":"updateUsIndividualCustomer","name":"Updates individual customer information. Unless there is a specific set of information to be updated for which a separate URIs exists, this generic URI can be used where all information for an individual customer can be updated.","summary":"Update individual customer information","tags":["RETAIL"],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"Identifier of the customer"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"idDocument":[{}],"employment":[{}],"creditScore":[{}],"relationships":[{}],"relation":[{}],"PreviousIdentification":[{}],"residenceInfo":[{}],"communication":[{}],"riskClass":[{}],"overrideReason":[{}],"crProfileType":[{}],"otherOfficers":[{}],"overrideDetails":[{}],"inputter":[{}],"dateTime":[{}]}},"responses":{"200":"UsIndividualCustomerResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/party/us/customers/{customerId}/contacts","fullPath":"/api/v3.1.0/party/us/customers/{customerId}/contacts","operationId":"getUsCustomerAddresslist","name":"Retrieves all available mail addresses for a customer along with information on the purpose of the address(Primary, office, etc,.), internal address reference. ","summary":"Retrieve customer mailing addresses","tags":["RETAIL"],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"UsCustomerAddresslistResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/party/us/customers/{customerId}/contacts","fullPath":"/api/v3.1.0/party/us/customers/{customerId}/contacts","operationId":"createUsCustomerContactDetail","name":"Create or update customer phone, office phone, mobile, email or fax numbers and the consent for sharing contact information with financial institutes marketing partners.","summary":"Create or update customer contact and consent information","tags":[],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":""},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"contactDetails":[{}],"consentDetails":[{}],"customercontactflag":"string"}},"responses":{"200":"UsCustomerContactDetailResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/party/us/customers/{customerId}/scores","fullPath":"/api/v3.1.0/party/us/customers/{customerId}/scores","operationId":"getUsCustomerCreditscore","name":"Retrieves customers credit score information received from credit agencies.","summary":"Retrieve customer credit scores","tags":["RETAIL"],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"Identifier of the customer"},{"name":"agencyId","in":"query","type":"string","required":false,"description":"Name of the agency that provided the credit score. Allowed values can be retrieved through getEbLookups for virtualTableName CREDIT.BUREAU"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"UsCustomerCreditscoreResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/party/us/customers/{customerId}/agencies/{agencyId}/scores","fullPath":"/api/v3.1.0/party/us/customers/{customerId}/agencies/{agencyId}/scores","operationId":"getUsCustomerCreditscoreByAgency","name":"Retrieves the credit score information available for a customer from the specific reporting agency provided in the URI.","summary":"Retrieve customer credit score by agency","tags":["RETAIL"],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"Identifier of the customer"},{"name":"agencyId","in":"path","type":"string","required":true,"description":"Name of the agency that provided the credit score. Allowed values can be retrieved through getEbLookups for virtualTableName CREDIT.BUREAU"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"UsCustomerCreditscoreByAgencyResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/party/us/customers/{customerId}/documents","fullPath":"/api/v3.1.0/party/us/customers/{customerId}/documents","operationId":"searchUsDocuments","name":"Search documents available for customer identification. Provides information on document reference, status, validity, issuer details, and version information.","summary":"Search customer documents","tags":["RETAIL"],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"Identifier of the customer"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"UsDocumentsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/party/us/customers/{customerId}/kyc","fullPath":"/api/v3.1.0/party/us/customers/{customerId}/kyc","operationId":"getUsCustomerKycandTax","name":"Retrieves KYC and tax information for a customer","summary":"Retrieve customer KYC and tax information","tags":["RETAIL"],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"Identifier of the customer"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"UsCustomerKycandTaxResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/party/us/customers/{customerId}/kyc","fullPath":"/api/v3.1.0/party/us/customers/{customerId}/kyc","operationId":"updateUsCustomerKycandTax","name":"Allows update to KYC and tax information for a customer","summary":"Update customer KYC and tax information","tags":["RETAIL"],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"Identifier of the customer"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"riskClass":[{}],"introducer":"string","contactDate":"2024-01-01","kycRelationship":"string","kycLastReviewDate":"2024-01-01","amlCheck":"NULL","amlResult":"NULL","amlLastResultDate":"2024-01-01","manualRiskClass":"string","overrideReason":"string","isKycComplete":"YES","taxCertificationType":"/v1.0.0/reference/lookups?virtualTableName=TAX.CERT.TYPE","foreignTin":"string","taxCertificationDate":"2024-01-01","reasonForMissingFtin":"/v1.0.0/reference/lookups?virtualTableName=FTIN.MIS.REASON"}},"responses":{"200":"UsCustomerKycandTaxResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/party/us/customers/{customerId}/primaryAddresses","fullPath":"/api/v3.1.0/party/us/customers/{customerId}/primaryAddresses","operationId":"getUsCustomerPrimaryAddress","name":"Retrieve Customer Primary Address","summary":"Retrieve Customer Primary Address","tags":["RETAIL"],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"Identifier of the customer"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"UsCustomerPrimaryAddressResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/party/us/customers/{customerId}/primaryAddresses","fullPath":"/api/v3.1.0/party/us/customers/{customerId}/primaryAddresses","operationId":"updateUsCustomerPrimaryAddress","name":"Update Customer Primary Address","summary":"Update Customer Primary Address","tags":["RETAIL"],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"Identifier of the customer"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"overrideDetails":[{}],"inputter":[{}],"dateTime":[{}],"addressLine1":"string","addressLine2":"string","city":"string","stateId":"/v1.0.0/reference/us/states","countyId":"/v1.0.0/reference/us/states/{stateId}/counties","zipCode":0.0,"zipPlusFour":0.0,"country":"/v1.0.0/reference/countries","addressStatus":"B","addressLocation":"string","addressPurpose":"CTC","recordStatus":"string"}},"responses":{"200":"UsCustomerPrimaryAddressResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/party/us/customers/{customerId}/relations","fullPath":"/api/v3.1.0/party/us/customers/{customerId}/relations","operationId":"updateUsCustomerRelation","name":"Update relationship information for an individual customer or update beneficial ownership details for a corporate customer","summary":"Update Customer Relation","tags":["RETAIL"],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"Identifier of the customer"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"relationships":[{}],"relationship":[{}],"ownershipRuleId":"/v1.0.0/reference/us/beneficialOwnerTypes","noOwnerGt25Percent":"YES","otherOwnersLt25PercentFlag":"YES","certifierName":"string","certifierTitle":"string","additionalTitle":"string","certificationDate":"2024-01-01"}},"responses":{"200":"UsCustomerRelationResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/party/us/customers/secondaryAddresses/{addressReference}","fullPath":"/api/v3.1.0/party/us/customers/secondaryAddresses/{addressReference}","operationId":"updateUsCustomerSecondaryAddress","name":"Update existing address information for the customer.","summary":"Update secondary Address","tags":["RETAIL"],"parameters":[{"name":"addressReference","in":"path","type":"string","required":true,"description":"Reference Id of address record"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"addressLine1":"string","addressLine2":"string","shortName":"string","city":"string","stateId":"/v1.0.0/reference/us/states","countyId":"/v1.0.0/reference/us/states/{stateId}/counties","zipCode":0.0,"zipPlusFour":0.0,"country":"/v1.0.0/reference/countries","customerContactIndicator":"YES","addressStatus":"B","taxAddressType":"/v1.0.0/reference/lookups?virtualTableName=IRS.ADDRESS.TYPE","addressPurpose":"CTC"}},"responses":{"200":"UsCustomerSecondaryAddressResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"DELETE","path":"/party/us/customers/secondaryAddresses/{addressReference}","fullPath":"/api/v3.1.0/party/us/customers/secondaryAddresses/{addressReference}","operationId":"deleteUsCustomerSecondaryAddress","name":"Remove customer's secondary address information","summary":"Remove customer's secondary address","tags":["RETAIL"],"parameters":[{"name":"addressReference","in":"path","type":"string","required":true,"description":"Reference Id of address record"},{"name":"payload","in":"body","type":"object","required":false,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}}},"responses":{"200":"UsCustomerSecondaryAddressResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"POST","path":"/party/us/customers/{customerId}/secondaryAddresses","fullPath":"/api/v3.1.0/party/us/customers/{customerId}/secondaryAddresses","operationId":"createUsCustomerSecondaryAddress","name":"Add new customer address information","summary":"Create secondary Address","tags":["RETAIL"],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"Identifier of the customer"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"addressLine1":"string","addressLine2":"string","shortName":"string","name":"string","city":"string","stateId":"/v1.0.0/reference/us/states","countyId":"/v1.0.0/reference/us/states/{stateId}/counties","zipCode":0.0,"zipPlusFour":0.0,"country":"/v1.0.0/reference/countries","customerContactIndicator":"YES","addressStatus":"B","taxAddressType":"/v1.0.0/reference/lookups?virtualTableName=IRS.ADDRESS.TYPE","addressPurpose":"CTC"}},"responses":{"200":"UsCustomerSecondaryAddressResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"POST","path":"/party/us/customers/corporates","fullPath":"/api/v3.1.0/party/us/customers/corporates","operationId":"createUsCorporateCustomer","name":"Allows creation of a corporate customer","summary":"Create corporate customer","tags":["RETAIL"],"parameters":[{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"idDocument":[{}],"relationships":[{}],"relationship":[{}],"PreviousIdentification":[{}],"communication":[{}],"communicationDevices":[{}],"officePhoneNumbers":[{}],"faxIds":[{}],"riskClass":[{}],"overrideReason":[{}],"crProfileType":[{}],"otherOfficers":[{}],"overrideDetails":[{}],"inputter":[{}],"dateTime":[{}]}},"responses":{"200":"UsCorporateCustomerResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"POST","path":"/party/us/customers/individuals","fullPath":"/api/v3.1.0/party/us/customers/individuals","operationId":"createUsIndividualCustomer","name":"Allows creation of an Individual customer","summary":"create individual customer","tags":["RETAIL"],"parameters":[{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"idDocument":[{}],"employment":[{}],"creditScore":[{}],"relationships":[{}],"relation":[{}],"PreviousIdentification":[{}],"residenceInfo":[{}],"communication":[{}],"communicationDevices":[{}],"officePhoneNumbers":[{}],"faxIds":[{}],"riskClass":[{}],"overrideReason":[{}],"crProfileType":[{}],"otherOfficers":[{}]}},"responses":{"200":"UsIndividualCustomerResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/party/us/customer/{customerId}/addressPreferences","fullPath":"/api/v3.1.0/party/us/customer/{customerId}/addressPreferences","operationId":"getAddressPreferences","name":"Retrieves seasonal address preferences set for the customer. Provides the address carrier and the duration for which an address should be used as the primary address","summary":"Seasonal address details","tags":["RETAIL"],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"Identifier of the customer"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"AddressPreferencesResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"POST","path":"/party/us/customer/{customerId}/addressPreferences","fullPath":"/api/v3.1.0/party/us/customer/{customerId}/addressPreferences","operationId":"createAddressPreference","name":"Allows capturing alternate address for a customer to be used for mails during specific periods each year","summary":"Create alternate address ","tags":["RETAIL"],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"Identifier of the customer"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"alternateaddressperiod":[{}],"carrier":"string","defaultCarrier":"string"}},"responses":{"200":"AddressPreferenceResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/party/us/customer/{customerId}/addressPreferences","fullPath":"/api/v3.1.0/party/us/customer/{customerId}/addressPreferences","operationId":"updateAddressPreference","name":"Updates alternate address information for a customer","summary":"Update alternate address","tags":["RETAIL"],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"Identifier of the customer"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"alternateaddressperiod":[{}],"carrier":"string","defaultCarrier":"string"}},"responses":{"200":"AddressPreferenceResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/party/us/customers/{customerId}/beneficiaries","fullPath":"/api/v3.1.0/party/us/customers/{customerId}/beneficiaries","operationId":"getUsBeneficiary","name":"Retrieve list of beneficiaries created for a customer to perform  account transfer, bill payments or wires. Information can be retrieved using customer id, account number, beneficiary name, account type etc,.","summary":"Retrieve beneficiary information for a customer","tags":["RETAIL"],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"Identifier of the customer"},{"name":"beneficiaryInstituteName","in":"query","type":"string","required":false,"description":"Indicates the name of financial institution where the beneficiary account is held"},{"name":"beneficiaryAccountId","in":"query","type":"string","required":false,"description":"Unique account identifier of the beneficiary account number."},{"name":"beneficiaryNickName","in":"query","type":"string","required":false,"description":"Nickname of the beneficiary"},{"name":"accountWithBankSortCode","in":"query","type":"string","required":false,"description":"Bank sort code details with account"},{"name":"accountType","in":"query","type":"string","required":false,"description":"Groups the products based on their type, eg, Checking, Savings, CD etc,."},{"name":"beneficiaryCustomerId","in":"query","type":"string","required":false,"description":"Identifies the Customer who is to be the ultimate receiver of the funds transferred by the sending bank when this Beneficiary is not a bank."},{"name":"beneficiaryId","in":"query","type":"string","required":false,"description":"Indicates the reference of the financial institution that allows access to the beneficiary information"},{"name":"transactionType","in":"query","type":"string","required":false,"description":"Identifies the transaction type applicable to the transaction being processed, i.e. outward or inward payment. For example: ACPX, OTPX etc."},{"name":"preferredPaymentProduct","in":"query","type":"string","required":false,"description":"Preferred payment product can be specified for Beneficiary. This will be used for defaulting the payment product for specific beneficiary. "},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"UsBeneficiaryResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"POST","path":"/party/us/customers/{customerId}/beneficiaries","fullPath":"/api/v3.1.0/party/us/customers/{customerId}/beneficiaries","operationId":"createUsBeneficiary","name":"API to create a beneficiary for account transfers or bill payment","summary":"Create an ACH beneficiary","tags":["RETAIL"],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"Identifier of the customer"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"beneficiaryAccountId":"string","beneficiaryNickName":"string","accountWithBankSortCode":"string","accountType":"CHECKING","beneficiaryCustomerId":"string","paymentDetails":"string","beneficiaryOtherIdType":"ORGANISATION","beneficiaryOtherId":"string","preferredPaymentProduct":"string","recordStatus":"string","currNo":"string","inputter":"string","dateTime":"2024-01-01","authoriser":"string","deptCode":"string"}},"responses":{"200":"UsBeneficiaryResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/party/us/customers/beneficiaries/{beneficiaryId}","fullPath":"/api/v3.1.0/party/us/customers/beneficiaries/{beneficiaryId}","operationId":"updateUsBeneficiary","name":"Update beneficiary created for account transfers or bill payment","summary":"Update ACH beneficiary","tags":["RETAIL"],"parameters":[{"name":"beneficiaryId","in":"path","type":"string","required":true,"description":"Indicates the reference of the financial institution that allows access to the beneficiary information"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"beneficiaryAccountId":"string","beneficiaryNickName":"string","accountWithBankSortCode":"string","accountType":"CHECKING","beneficiaryCustomerId":"string","paymentDetails":"string","beneficiaryOtherIdType":"ORGANISATION","beneficiaryOtherId":"string","preferredPaymentProduct":"string","recordStatus":"string","currNo":"string","inputter":"string","dateTime":"2024-01-01","authoriser":"string","deptCode":"string"}},"responses":{"200":"UsBeneficiaryResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"POST","path":"/party/us/customers/{customerId}/beneficiaries/wires","fullPath":"/api/v3.1.0/party/us/customers/{customerId}/beneficiaries/wires","operationId":"createUsWiresBeneficiary","name":"Create beneficiary information for generating a wire transfer","summary":"Creates beneficiary for wire transfers","tags":["RETAIL"],"parameters":[{"name":"customerId","in":"path","type":"number","required":true,"description":"Identifier of the customer"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"beneficiaryNickNames":[{}],"beneficiaryAccountId":"string","accountWithBankSortCode":"string","accountType":"@ref:reference-us-sortcodes-services","beneficiaryInstituteName":"string","beneficiaryInstituteBranchName":"string","beneficiaryInstituteAddressLine1":"string","beneficiaryInstituteAddressLine2":"string","beneficiaryInstituteAddressLine3":0.0,"beneficiaryInstituteCountryCode":"string","beneficiaryCustomerId":"string","beneficiaryShortName":"string","beneficiaryAddressLine1":"string","beneficiaryAddressLine2":"string","beneficiaryAddressCity":"string"}},"responses":{"200":"UsWiresBeneficiaryResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/party/us/customers/beneficiaries/{beneficiaryId}/wires","fullPath":"/api/v3.1.0/party/us/customers/beneficiaries/{beneficiaryId}/wires","operationId":"updateUsWiresBeneficiary","name":"Updates routing number, bank details or the payee details of a beneficiary set up for wire transfers","summary":"Updates existing wire payment beneficiary","tags":["RETAIL"],"parameters":[{"name":"beneficiaryId","in":"path","type":"string","required":true,"description":"Indicates the reference of the financial institution that allows access to the beneficiary information"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"beneficiaryNickNames":[{}],"beneficiaryAccountId":"string","accountWithBankSortCode":"string","accountType":"@ref:reference-us-sortcodes-services","beneficiaryInstituteName":"string","beneficiaryInstituteBranchName":"string","beneficiaryInstituteAddressLine1":"string","beneficiaryInstituteAddressLine2":"string","beneficiaryInstituteAddressLine3":0.0,"beneficiaryInstituteCountryCode":"string","beneficiaryCustomerId":"string","beneficiaryShortName":"string","beneficiaryAddressLine1":"string","beneficiaryAddressLine2":"string","beneficiaryAddressCity":"string"}},"responses":{"200":"UsWiresBeneficiaryResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}}]},{"key":"party-us-customerservice-v3.2.0","title":"US Model Bank Customer management","version":"v3.2.0","description":"The customer service API allows to create, update and modify customer, contact details, address and beneficiary. Separate URIs are available for corporate and individual customers to update or retrieve specific information like Address, secondary address, credit score, KYC, relation, beneficial owne","endpointCount":29,"endpoints":[{"method":"GET","path":"/party/us/customers","fullPath":"/api/v3.2.0/party/us/customers","operationId":"searchUsCustomer","name":"Search and retrieve customer information based on customerName, date of birth, date of incorporation, SSN or TIN, and mobile number","summary":"Search Customer","tags":["RETAIL"],"parameters":[{"name":"customerId","in":"query","type":"string","required":false,"description":"Identifier of the customer"},{"name":"customerName","in":"query","type":"string","required":false,"description":"Name of the customer"},{"name":"taxId","in":"query","type":"string","required":false,"description":"Holds the Customer's TAX/SSN Id."},{"name":"dateOfBirth","in":"query","type":"string","required":false,"description":"The date of birth of an individual customer"},{"name":"mobileNumber","in":"query","type":"string","required":false,"description":"Mobile number of the customer"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"UsCustomerResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/party/us/customers/{customerId}/corporates","fullPath":"/api/v3.2.0/party/us/customers/{customerId}/corporates","operationId":"getUsCorporateCustomer","name":"Retrieves corporate customer information. Unless there is a specific set of information to be updated for which separate APIs exists, this generic API can be used where all available information can be retrieved.","summary":"Retrieve corporate customer information","tags":["RETAIL"],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"Identifier of the customer"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"UsCorporateCustomerResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/party/us/customers/{customerId}/corporates","fullPath":"/api/v3.2.0/party/us/customers/{customerId}/corporates","operationId":"updateUsCorporateCustomer","name":"Updates corporate customer information. Unless there is a specific set of information to be updated for which separate URIs exists, this generic URI can be used where all available information can be updated","summary":"Update corporate customer information","tags":["RETAIL"],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"Identifier of the customer"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"idDocument":[{}],"relationships":[{}],"relationship":[{}],"PreviousIdentification":[{}],"communication":[{}],"riskClass":[{}],"overrideReason":[{}],"crProfileType":[{}],"otherOfficers":[{}],"overrideDetails":[{}],"inputter":[{}],"dateTime":[{}],"customerName":"string","customerNameAdditional":"string","shortName":"string"}},"responses":{"200":"UsCorporateCustomerResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/party/us/customers/{customerId}/individuals","fullPath":"/api/v3.2.0/party/us/customers/{customerId}/individuals","operationId":"getUsIndividualCustomer","name":"Retrieves individual customer information. Unless there is a specific set of information to be updated for which separate URIs exists, this generic URI can be used where all available information for an individual Customer can be  retrieved.","summary":"Retrieve individual customer information","tags":["RETAIL"],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"Identifier of the customer"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"UsIndividualCustomerResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/party/us/customers/{customerId}/individuals","fullPath":"/api/v3.2.0/party/us/customers/{customerId}/individuals","operationId":"updateUsIndividualCustomer","name":"Updates individual customer information. Unless there is a specific set of information to be updated for which separate URIs exists, this generic URI can be used where all information for an individual customer can be updated.","summary":"Update individual customer information","tags":["RETAIL"],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"Identifier of the customer"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"idDocument":[{}],"employment":[{}],"creditScore":[{}],"relationships":[{}],"relation":[{}],"PreviousIdentification":[{}],"residenceInfo":[{}],"communication":[{}],"riskClass":[{}],"overrideReason":[{}],"crProfileType":[{}],"otherOfficers":[{}],"overrideDetails":[{}],"inputter":[{}],"dateTime":[{}]}},"responses":{"200":"UsIndividualCustomerResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/party/us/customers/{customerId}/contacts","fullPath":"/api/v3.2.0/party/us/customers/{customerId}/contacts","operationId":"getUsCustomerAddresslist","name":"Retrieves all available mail addresses for a customer along with information on the purpose of the address(Primary, office, etc,.), internal address reference. ","summary":"Retrieve customer mailing addresses","tags":["RETAIL"],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"UsCustomerAddresslistResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/party/us/customers/{customerId}/contacts","fullPath":"/api/v3.2.0/party/us/customers/{customerId}/contacts","operationId":"createUsCustomerContactDetail","name":"Create or update customer phone, office phone, mobile, email or fax numbers and the consent for sharing contact information with financial institutes marketing partners.","summary":"Create or update customer contact and consent information","tags":[],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":""},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"contactDetails":[{}],"consentDetails":[{}],"customercontactflag":"string","extensionData":{}}},"responses":{"200":"UsCustomerContactDetailResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/party/us/customers/{customerId}/scores","fullPath":"/api/v3.2.0/party/us/customers/{customerId}/scores","operationId":"getUsCustomerCreditscore","name":"Retrieves customers credit score information received from credit agencies.","summary":"Retrieve customer credit scores","tags":["RETAIL"],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"Identifier of the customer"},{"name":"agencyId","in":"query","type":"string","required":false,"description":"Name of the agency that provided the credit score. Allowed values can be retrieved through getEbLookups for virtualTableName CREDIT.BUREAU"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"UsCustomerCreditscoreResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/party/us/customers/{customerId}/agencies/{agencyId}/scores","fullPath":"/api/v3.2.0/party/us/customers/{customerId}/agencies/{agencyId}/scores","operationId":"getUsCustomerCreditscoreByAgency","name":"Retrieves the credit score information available for a customer from the specific reporting agency provided in the URI.","summary":"Retrieve customer credit score by agency","tags":["RETAIL"],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"Identifier of the customer"},{"name":"agencyId","in":"path","type":"string","required":true,"description":"Name of the agency that provided the credit score. Allowed values can be retrieved through getEbLookups for virtualTableName CREDIT.BUREAU"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"UsCustomerCreditscoreByAgencyResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/party/us/customers/{customerId}/documents","fullPath":"/api/v3.2.0/party/us/customers/{customerId}/documents","operationId":"searchUsDocuments","name":"Search documents available for customer identification. Provides information on document reference, status, validity, issuer details, and version information.","summary":"Search customer documents","tags":["RETAIL"],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"Identifier of the customer"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"UsDocumentsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/party/us/customers/{customerId}/kyc","fullPath":"/api/v3.2.0/party/us/customers/{customerId}/kyc","operationId":"getUsCustomerKycandTax","name":"Retrieves KYC and tax information for a customer","summary":"Retrieve customer KYC and tax information","tags":["RETAIL"],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"Identifier of the customer"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"UsCustomerKycandTaxResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/party/us/customers/{customerId}/kyc","fullPath":"/api/v3.2.0/party/us/customers/{customerId}/kyc","operationId":"updateUsCustomerKycandTax","name":"Allows update to KYC and tax information for a customer","summary":"Update customer KYC and tax information","tags":["RETAIL"],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"Identifier of the customer"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"riskClass":[{}],"introducer":"string","contactDate":"2024-01-01","kycRelationship":"string","kycLastReviewDate":"2024-01-01","amlCheck":"NULL","amlResult":"NULL","amlLastResultDate":"2024-01-01","manualRiskClass":"string","overrideReason":"string","isKycComplete":"YES","taxCertificationType":"/v1.0.0/reference/lookups?virtualTableName=TAX.CERT.TYPE","foreignTin":"string","taxCertificationDate":"2024-01-01","reasonForMissingFtin":"/v1.0.0/reference/lookups?virtualTableName=FTIN.MIS.REASON"}},"responses":{"200":"UsCustomerKycandTaxResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/party/us/customers/{customerId}/primaryAddresses","fullPath":"/api/v3.2.0/party/us/customers/{customerId}/primaryAddresses","operationId":"getUsCustomerPrimaryAddress","name":"Retrieve customer primary address","summary":"Retrieve customer primary address","tags":["RETAIL"],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"Identifier of the customer"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"UsCustomerPrimaryAddressResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/party/us/customers/{customerId}/primaryAddresses","fullPath":"/api/v3.2.0/party/us/customers/{customerId}/primaryAddresses","operationId":"updateUsCustomerPrimaryAddress","name":"Update customer primary address","summary":"Update customer primary address","tags":["RETAIL"],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"Identifier of the customer"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"overrideDetails":[{}],"inputter":[{}],"dateTime":[{}],"addressLine1":"string","addressLine2":"string","city":"string","stateId":"/v1.0.0/reference/us/states","countyId":"/v1.0.0/reference/us/states/{stateId}/counties","zipCode":0.0,"zipPlusFour":0.0,"country":"/v1.0.0/reference/countries","addressStatus":"B","addressLocation":"string","addressPurpose":"CTC","recordStatus":"string"}},"responses":{"200":"UsCustomerPrimaryAddressResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/party/us/customers/{customerId}/relations","fullPath":"/api/v3.2.0/party/us/customers/{customerId}/relations","operationId":"updateUsCustomerRelation","name":"Update relationship information for an individual customer or update beneficial ownership details for a corporate customer","summary":"Update customer relation","tags":["RETAIL"],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"Identifier of the customer"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"relationships":[{}],"relationship":[{}],"ownershipRuleId":"/v1.0.0/reference/us/beneficialOwnerTypes","noOwnerGt25Percent":"YES","otherOwnersLt25PercentFlag":"YES","certifierName":"string","certifierTitle":"string","additionalTitle":"string","certificationDate":"2024-01-01","extensionData":{}}},"responses":{"200":"UsCustomerRelationResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/party/us/customers/secondaryAddresses/{addressReference}","fullPath":"/api/v3.2.0/party/us/customers/secondaryAddresses/{addressReference}","operationId":"updateUsCustomerSecondaryAddress","name":"Update existing address information for the customer.","summary":"Update secondary Address","tags":["RETAIL"],"parameters":[{"name":"addressReference","in":"path","type":"string","required":true,"description":"Reference Id of address record"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"addressLine1":"string","addressLine2":"string","shortName":"string","city":"string","stateId":"/v1.0.0/reference/us/states","countyId":"/v1.0.0/reference/us/states/{stateId}/counties","zipCode":0.0,"zipPlusFour":0.0,"country":"/v1.0.0/reference/countries","customerContactIndicator":"YES","addressStatus":"B","taxAddressType":"/v1.0.0/reference/lookups?virtualTableName=IRS.ADDRESS.TYPE","addressPurpose":"CTC","extensionData":{}}},"responses":{"200":"UsCustomerSecondaryAddressResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"DELETE","path":"/party/us/customers/secondaryAddresses/{addressReference}","fullPath":"/api/v3.2.0/party/us/customers/secondaryAddresses/{addressReference}","operationId":"deleteUsCustomerSecondaryAddress","name":"Remove customer's secondary address information","summary":"Remove customer's secondary address","tags":["RETAIL"],"parameters":[{"name":"addressReference","in":"path","type":"string","required":true,"description":"Reference Id of address record"},{"name":"payload","in":"body","type":"object","required":false,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}}},"responses":{"200":"UsCustomerSecondaryAddressResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"POST","path":"/party/us/customers/{customerId}/secondaryAddresses","fullPath":"/api/v3.2.0/party/us/customers/{customerId}/secondaryAddresses","operationId":"createUsCustomerSecondaryAddress","name":"Add new customer address information","summary":"Create secondary Address","tags":["RETAIL"],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"Identifier of the customer"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"addressLine1":"string","addressLine2":"string","shortName":"string","name":"string","city":"string","stateId":"/v1.0.0/reference/us/states","countyId":"/v1.0.0/reference/us/states/{stateId}/counties","zipCode":0.0,"zipPlusFour":0.0,"country":"/v1.0.0/reference/countries","customerContactIndicator":"YES","addressStatus":"B","taxAddressType":"/v1.0.0/reference/lookups?virtualTableName=IRS.ADDRESS.TYPE","addressPurpose":"CTC","extensionData":{}}},"responses":{"200":"UsCustomerSecondaryAddressResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"POST","path":"/party/us/customers/corporates","fullPath":"/api/v3.2.0/party/us/customers/corporates","operationId":"createUsCorporateCustomer","name":"Allows creation of a corporate customer","summary":"Create corporate customer","tags":["RETAIL"],"parameters":[{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"idDocument":[{}],"relationships":[{}],"relationship":[{}],"PreviousIdentification":[{}],"communication":[{}],"communicationDevices":[{}],"officePhoneNumbers":[{}],"faxIds":[{}],"riskClass":[{}],"overrideReason":[{}],"crProfileType":[{}],"otherOfficers":[{}],"overrideDetails":[{}],"inputter":[{}],"dateTime":[{}]}},"responses":{"200":"UsCorporateCustomerResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"POST","path":"/party/us/customers/individuals","fullPath":"/api/v3.2.0/party/us/customers/individuals","operationId":"createUsIndividualCustomer","name":"Allows creation of an Individual customer","summary":"create individual customer","tags":["RETAIL"],"parameters":[{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"idDocument":[{}],"employment":[{}],"creditScore":[{}],"relationships":[{}],"relation":[{}],"PreviousIdentification":[{}],"residenceInfo":[{}],"communication":[{}],"communicationDevices":[{}],"officePhoneNumbers":[{}],"faxIds":[{}],"riskClass":[{}],"overrideReason":[{}],"crProfileType":[{}],"otherOfficers":[{}]}},"responses":{"200":"UsIndividualCustomerResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/party/us/customer/{customerId}/addressPreferences","fullPath":"/api/v3.2.0/party/us/customer/{customerId}/addressPreferences","operationId":"getAddressPreferences","name":"Retrieves seasonal address preferences set for the customer. Provides the address carrier and the duration for which an address should be used as the primary address","summary":"Seasonal address details","tags":["RETAIL"],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"Identifier of the customer"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"AddressPreferencesResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"POST","path":"/party/us/customer/{customerId}/addressPreferences","fullPath":"/api/v3.2.0/party/us/customer/{customerId}/addressPreferences","operationId":"createAddressPreference","name":"Allows capturing alternate address for a customer to be used for mails during specific periods each year","summary":"Create alternate address ","tags":["RETAIL"],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"Identifier of the customer"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"alternateaddressperiod":[{}],"carrier":"string","defaultCarrier":"string","extensionData":{}}},"responses":{"200":"AddressPreferenceResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/party/us/customer/{customerId}/addressPreferences","fullPath":"/api/v3.2.0/party/us/customer/{customerId}/addressPreferences","operationId":"updateAddressPreference","name":"Updates alternate address information for a customer","summary":"Update alternate address","tags":["RETAIL"],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"Identifier of the customer"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"alternateaddressperiod":[{}],"carrier":"string","defaultCarrier":"string","extensionData":{}}},"responses":{"200":"AddressPreferenceResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/party/us/customers/{customerId}/beneficiaries","fullPath":"/api/v3.2.0/party/us/customers/{customerId}/beneficiaries","operationId":"getUsBeneficiary","name":"Retrieve list of beneficiaries created for a customer to perform  account transfer, bill payments or wires. Information can be retrieved using customerId, debitAccountId, beneficiaryNickName, accountType etc,.","summary":"Retrieve beneficiary information for a customer","tags":["RETAIL"],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"Identifier of the customer"},{"name":"beneficiaryInstituteName","in":"query","type":"string","required":false,"description":"Indicates the name of financial institution where the beneficiary account is held"},{"name":"beneficiaryAccountId","in":"query","type":"string","required":false,"description":"Unique account identifier of the beneficiary account number."},{"name":"beneficiaryNickName","in":"query","type":"string","required":false,"description":"Nickname of the beneficiary"},{"name":"accountWithBankSortCode","in":"query","type":"string","required":false,"description":"Bank sort code details with account"},{"name":"accountType","in":"query","type":"string","required":false,"description":"Groups the products based on their type, eg, Checking, Savings, CD etc,."},{"name":"beneficiaryCustomerId","in":"query","type":"string","required":false,"description":"Identifies the Customer who is to be the ultimate receiver of the funds transferred by the sending bank when this Beneficiary is not a bank."},{"name":"beneficiaryId","in":"query","type":"string","required":false,"description":"Indicates the reference of the financial institution that allows access to the beneficiary information"},{"name":"transactionType","in":"query","type":"string","required":false,"description":"Identifies the transaction type applicable to the transaction being processed, i.e. outward or inward payment. For example: ACPX, OTPX etc."},{"name":"preferredPaymentProduct","in":"query","type":"string","required":false,"description":"Preferred payment product can be specified for Beneficiary. This will be used for defaulting the payment product for specific beneficiary. "},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"UsBeneficiaryResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"POST","path":"/party/us/customers/{customerId}/beneficiaries","fullPath":"/api/v3.2.0/party/us/customers/{customerId}/beneficiaries","operationId":"createUsBeneficiary","name":"Create a beneficiary for account transfers or bill payment","summary":"Create an ACH beneficiary","tags":["RETAIL"],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"Identifier of the customer"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"beneficiaryAccountId":"string","beneficiaryNickName":"string","accountWithBankSortCode":"string","accountType":"CHECKING","beneficiaryCustomerId":"string","paymentDetails":"string","beneficiaryOtherIdType":"ORGANISATION","beneficiaryOtherId":"string","preferredPaymentProduct":"string","recordStatus":"string","currNo":"string","inputter":"string","dateTime":"2024-01-01","authoriser":"string","deptCode":"string"}},"responses":{"200":"UsBeneficiaryResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/party/us/customers/beneficiaries/{beneficiaryId}","fullPath":"/api/v3.2.0/party/us/customers/beneficiaries/{beneficiaryId}","operationId":"updateUsBeneficiary","name":"Update beneficiary created for account transfers or bill payment","summary":"Update ACH beneficiary","tags":["RETAIL"],"parameters":[{"name":"beneficiaryId","in":"path","type":"string","required":true,"description":"Indicates the reference of the financial institution that allows access to the beneficiary information"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"beneficiaryAccountId":"string","beneficiaryNickName":"string","accountWithBankSortCode":"string","accountType":"CHECKING","beneficiaryCustomerId":"string","paymentDetails":"string","beneficiaryOtherIdType":"ORGANISATION","beneficiaryOtherId":"string","preferredPaymentProduct":"string","recordStatus":"string","currNo":"string","inputter":"string","dateTime":"2024-01-01","authoriser":"string","deptCode":"string"}},"responses":{"200":"UsBeneficiaryResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"POST","path":"/party/us/customers/{customerId}/beneficiaries/wires","fullPath":"/api/v3.2.0/party/us/customers/{customerId}/beneficiaries/wires","operationId":"createUsWiresBeneficiary","name":"create beneficiary information for generating a wire transfer","summary":"Creates beneficiary for wire transfers","tags":["RETAIL"],"parameters":[{"name":"customerId","in":"path","type":"number","required":true,"description":"Identifier of the customer"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"beneficiaryNickNames":[{}],"beneficiaryAccountId":"string","accountWithBankSortCode":"string","accountType":"@ref:reference-us-sortcodes-services","beneficiaryInstituteName":"string","beneficiaryInstituteBranchName":"string","beneficiaryInstituteAddressLine1":"string","beneficiaryInstituteAddressLine2":"string","beneficiaryInstituteAddressLine3":0.0,"beneficiaryInstituteCountryCode":"string","beneficiaryCustomerId":"string","beneficiaryShortName":"string","beneficiaryAddressLine1":"string","beneficiaryAddressLine2":"string","beneficiaryAddressCity":"string"}},"responses":{"200":"UsWiresBeneficiaryResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/party/us/customers/beneficiaries/{beneficiaryId}/wires","fullPath":"/api/v3.2.0/party/us/customers/beneficiaries/{beneficiaryId}/wires","operationId":"updateUsWiresBeneficiary","name":"Updates routing number, bank details or the payee details of a beneficiary set up for wire transfers","summary":"Updates existing wire payment beneficiary","tags":["RETAIL"],"parameters":[{"name":"beneficiaryId","in":"path","type":"string","required":true,"description":"Indicates the reference of the financial institution that allows access to the beneficiary information"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"beneficiaryNickNames":[{}],"beneficiaryAccountId":"string","accountWithBankSortCode":"string","accountType":"@ref:reference-us-sortcodes-services","beneficiaryInstituteName":"string","beneficiaryInstituteBranchName":"string","beneficiaryInstituteAddressLine1":"string","beneficiaryInstituteAddressLine2":"string","beneficiaryInstituteAddressLine3":0.0,"beneficiaryInstituteCountryCode":"string","beneficiaryCustomerId":"string","beneficiaryShortName":"string","beneficiaryAddressLine1":"string","beneficiaryAddressLine2":"string","beneficiaryAddressCity":"string"}},"responses":{"200":"UsWiresBeneficiaryResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/party/us/customers/deliveryPreferences/{customerId}","fullPath":"/api/v3.2.0/party/us/customers/deliveryPreferences/{customerId}","operationId":"getUsDeliveryPreference","name":"Retrieves all available mail addresses for a customer along with information on the purpose of the address(Primary, office, etc,.), internal address reference.","summary":"Retrieves all available mail addresses for a customer along with information on the purpose of the address(Primary, office, etc,.), internal address reference.","tags":[],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"UsDeliveryPreferenceResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}}]},{"key":"party-us-customerservice-v3.3.0","title":"US Model Bank Customer management","version":"v3.3.0","description":"The customer service API allows to create, update and modify customer, contact details, address and beneficiary. Separate URIs are available for corporate and individual customers to update or retrieve specific information like address, secondary address, credit score, KYC, relation, beneficial owne","endpointCount":29,"endpoints":[{"method":"GET","path":"/party/us/customers","fullPath":"/api/v3.3.0/party/us/customers","operationId":"searchUsCustomer","name":"Search and retrieve customer information based on customer name, date of birth, date of incorporation, SSN or TIN, and mobile number","summary":"Search customer","tags":["RETAIL"],"parameters":[{"name":"customerId","in":"query","type":"string","required":false,"description":"Identifier of the customer"},{"name":"customerName","in":"query","type":"string","required":false,"description":"Name of the customer"},{"name":"taxId","in":"query","type":"string","required":false,"description":"Holds the Customer's TAX/SSN Id."},{"name":"dateOfBirth","in":"query","type":"string","required":false,"description":"The date of birth of an individual customer"},{"name":"mobileNumber","in":"query","type":"string","required":false,"description":"Mobile number of the customer"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"UsCustomerResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/party/us/customers/{customerId}/corporates","fullPath":"/api/v3.3.0/party/us/customers/{customerId}/corporates","operationId":"getUsCorporateCustomer","name":"Retrieves corporate customer information. Unless there is a specific set of information to be updated for which a separate APIs exists, this generic API can be used where all available information can be retrieved.","summary":"Retrieve corporate customer information","tags":["RETAIL"],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"Identifier of the customer"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"UsCorporateCustomerResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/party/us/customers/{customerId}/corporates","fullPath":"/api/v3.3.0/party/us/customers/{customerId}/corporates","operationId":"updateUsCorporateCustomer","name":"Updates corporate customer information. Unless there is a specific set of information to be updated for which a separate URIs exists, this generic URI can be used where all available information can be updated","summary":"Update corporate customer information","tags":["RETAIL"],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"Identifier of the customer"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"idDocument":[{}],"relationships":[{}],"relationship":[{}],"PreviousIdentification":[{}],"communication":[{}],"riskClass":[{}],"overrideReason":[{}],"crProfileType":[{}],"otherOfficers":[{}],"overrideDetails":[{}],"inputter":[{}],"dateTime":[{}],"customerName":"string","customerNameAdditional":"string","shortName":"string"}},"responses":{"200":"UsCorporateCustomerResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/party/us/customers/{customerId}/individuals","fullPath":"/api/v3.3.0/party/us/customers/{customerId}/individuals","operationId":"getUsIndividualCustomer","name":"Retrieves individual customer information. Unless there is a specific set of information to be updated for which a separate URIs exists, this generic URI can be used where all available information for an individual customer can be retrieved.","summary":"Retrieve individual customer information","tags":["RETAIL"],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"Identifier of the customer"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"UsIndividualCustomerResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/party/us/customers/{customerId}/individuals","fullPath":"/api/v3.3.0/party/us/customers/{customerId}/individuals","operationId":"updateUsIndividualCustomer","name":"Updates individual customer information. Unless there is a specific set of information to be updated for which a separate URIs exists, this generic URI can be used where all information for an individual customer can be updated.","summary":"Update individual customer information","tags":["RETAIL"],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"Identifier of the customer"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"idDocument":[{}],"employment":[{}],"creditScore":[{}],"relationships":[{}],"relation":[{}],"PreviousIdentification":[{}],"residenceInfo":[{}],"communication":[{}],"riskClass":[{}],"overrideReason":[{}],"crProfileType":[{}],"otherOfficers":[{}],"overrideDetails":[{}],"inputter":[{}],"dateTime":[{}]}},"responses":{"200":"UsIndividualCustomerResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/party/us/customers/{customerId}/contacts","fullPath":"/api/v3.3.0/party/us/customers/{customerId}/contacts","operationId":"getUsCustomerAddresslist","name":"Retrieves all available mail addresses for a customer along with information on the purpose of the address(Primary, office, etc,.), internal address reference. ","summary":"Retrieve customer mailing addresses","tags":["RETAIL"],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"UsCustomerAddresslistResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/party/us/customers/{customerId}/contacts","fullPath":"/api/v3.3.0/party/us/customers/{customerId}/contacts","operationId":"createUsCustomerContactDetail","name":"Create or update customer phone, office phone, mobile, email or fax numbers and the consent for sharing contact information with financial institute's marketing partners.","summary":"Create or update customer contact and consent information","tags":[],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":""},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"contactDetails":[{}],"consentDetails":[{}],"customercontactflag":"string","extensions":{}}},"responses":{"200":"UsCustomerContactDetailResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/party/us/customers/{customerId}/scores","fullPath":"/api/v3.3.0/party/us/customers/{customerId}/scores","operationId":"getUsCustomerCreditscore","name":"Retrieve customer's credit score information received from credit agencies.","summary":"Retrieve customer credit scores","tags":["RETAIL"],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"Identifier of the customer"},{"name":"agencyId","in":"query","type":"string","required":false,"description":"Name of the agency that provided the credit score. Allowed values can be retrieved through getEbLookups for virtualTableName CREDIT.BUREAU"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"UsCustomerCreditscoreResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/party/us/customers/{customerId}/agencies/{agencyId}/scores","fullPath":"/api/v3.3.0/party/us/customers/{customerId}/agencies/{agencyId}/scores","operationId":"getUsCustomerCreditscoreByAgency","name":"Retrieves the credit score information available for a customer from the specific reporting agency provided in the URI.","summary":"Retrieve customer credit score by agency","tags":["RETAIL"],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"Identifier of the customer"},{"name":"agencyId","in":"path","type":"string","required":true,"description":"Name of the agency that provided the credit score. Allowed values can be retrieved through getEbLookups for virtualTableName CREDIT.BUREAU"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"UsCustomerCreditscoreByAgencyResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/party/us/customers/{customerId}/documents","fullPath":"/api/v3.3.0/party/us/customers/{customerId}/documents","operationId":"searchUsDocuments","name":"Search documents available for customer identification. Provides information on document reference, status, validity, issuer details, and version information.","summary":"Search customer documents","tags":["RETAIL"],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"Identifier of the customer"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"UsDocumentsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/party/us/customers/{customerId}/kyc","fullPath":"/api/v3.3.0/party/us/customers/{customerId}/kyc","operationId":"getUsCustomerKycandTax","name":"Retrieves KYC and tax information for a customer","summary":"Retrieve customer KYC and tax information","tags":["RETAIL"],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"Identifier of the customer"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"UsCustomerKycandTaxResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/party/us/customers/{customerId}/kyc","fullPath":"/api/v3.3.0/party/us/customers/{customerId}/kyc","operationId":"updateUsCustomerKycandTax","name":"Allows update to KYC and tax information for a customer","summary":"Update customer KYC and tax information","tags":["RETAIL"],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"Identifier of the customer"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"riskClass":[{}],"introducer":"string","contactDate":"2024-01-01","kycRelationship":"string","kycLastReviewDate":"2024-01-01","amlCheck":"NULL","amlResult":"NULL","amlLastResultDate":"2024-01-01","manualRiskClass":"string","overrideReason":"string","isKycComplete":"YES","taxCertificationType":"/v1.0.0/reference/lookups?virtualTableName=TAX.CERT.TYPE","foreignTin":"string","taxCertificationDate":"2024-01-01","reasonForMissingFtin":"/v1.0.0/reference/lookups?virtualTableName=FTIN.MIS.REASON"}},"responses":{"200":"UsCustomerKycandTaxResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/party/us/customers/{customerId}/primaryAddresses","fullPath":"/api/v3.3.0/party/us/customers/{customerId}/primaryAddresses","operationId":"getUsCustomerPrimaryAddress","name":"Retrieve customer primary address","summary":"Retrieve customer primary address","tags":["RETAIL"],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"Identifier of the customer"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"UsCustomerPrimaryAddressResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/party/us/customers/{customerId}/primaryAddresses","fullPath":"/api/v3.3.0/party/us/customers/{customerId}/primaryAddresses","operationId":"updateUsCustomerPrimaryAddress","name":"Update customer primary address","summary":"Update customer primary address","tags":["RETAIL"],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"Identifier of the customer"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"overrideDetails":[{}],"inputter":[{}],"dateTime":[{}],"addressLine1":"string","addressLine2":"string","city":"string","stateId":"/v1.0.0/reference/us/states","countyId":"/v1.0.0/reference/us/states/{stateId}/counties","zipCode":0.0,"zipPlusFour":0.0,"country":"/v1.0.0/reference/countries","addressStatus":"B","addressLocation":"string","addressPurpose":"CTC","recordStatus":"string"}},"responses":{"200":"UsCustomerPrimaryAddressResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/party/us/customers/{customerId}/relations","fullPath":"/api/v3.3.0/party/us/customers/{customerId}/relations","operationId":"updateUsCustomerRelation","name":"Update relationship information for an individual customer or update beneficial ownership details for a corporate customer","summary":"Update customer relation","tags":["RETAIL"],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"Identifier of the customer"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"relationships":[{}],"relationship":[{}],"ownershipRuleId":"/v1.0.0/reference/us/beneficialOwnerTypes","noOwnerGt25Percent":"YES","otherOwnersLt25PercentFlag":"YES","certifierName":"string","certifierTitle":"string","additionalTitle":"string","certificationDate":"2024-01-01","extensions":{}}},"responses":{"200":"UsCustomerRelationResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/party/us/customers/secondaryAddresses/{addressReference}","fullPath":"/api/v3.3.0/party/us/customers/secondaryAddresses/{addressReference}","operationId":"updateUsCustomerSecondaryAddress","name":"Update existing address information for the customer.","summary":"Update secondary address","tags":["RETAIL"],"parameters":[{"name":"addressReference","in":"path","type":"string","required":true,"description":"Reference Id of address record"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"addressLine1":"string","addressLine2":"string","shortName":"string","city":"string","stateId":"/v1.0.0/reference/us/states","countyId":"/v1.0.0/reference/us/states/{stateId}/counties","zipCode":0.0,"zipPlusFour":0.0,"country":"/v1.0.0/reference/countries","customerContactIndicator":"YES","addressStatus":"B","taxAddressType":"/v1.0.0/reference/lookups?virtualTableName=IRS.ADDRESS.TYPE","addressPurpose":"CTC","extensions":{}}},"responses":{"200":"UsCustomerSecondaryAddressResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"DELETE","path":"/party/us/customers/secondaryAddresses/{addressReference}","fullPath":"/api/v3.3.0/party/us/customers/secondaryAddresses/{addressReference}","operationId":"deleteUsCustomerSecondaryAddress","name":"Remove customer's secondary address information","summary":"Remove customer's secondary address","tags":["RETAIL"],"parameters":[{"name":"addressReference","in":"path","type":"string","required":true,"description":"Reference Id of address record"},{"name":"payload","in":"body","type":"object","required":false,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}}},"responses":{"200":"UsCustomerSecondaryAddressResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"POST","path":"/party/us/customers/{customerId}/secondaryAddresses","fullPath":"/api/v3.3.0/party/us/customers/{customerId}/secondaryAddresses","operationId":"createUsCustomerSecondaryAddress","name":"Add new customer address information","summary":"Create secondary address","tags":["RETAIL"],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"Identifier of the customer"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"addressLine1":"string","addressLine2":"string","shortName":"string","name":"string","city":"string","stateId":"/v1.0.0/reference/us/states","countyId":"/v1.0.0/reference/us/states/{stateId}/counties","zipCode":0.0,"zipPlusFour":0.0,"country":"/v1.0.0/reference/countries","customerContactIndicator":"YES","addressStatus":"B","taxAddressType":"/v1.0.0/reference/lookups?virtualTableName=IRS.ADDRESS.TYPE","addressPurpose":"CTC","extensions":{}}},"responses":{"200":"UsCustomerSecondaryAddressResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"POST","path":"/party/us/customers/corporates","fullPath":"/api/v3.3.0/party/us/customers/corporates","operationId":"createUsCorporateCustomer","name":"Allows creation of a corporate customer","summary":"Create corporate customer","tags":["RETAIL"],"parameters":[{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"idDocument":[{}],"relationships":[{}],"relationship":[{}],"PreviousIdentification":[{}],"communication":[{}],"communicationDevices":[{}],"officePhoneNumbers":[{}],"faxIds":[{}],"riskClass":[{}],"overrideReason":[{}],"crProfileType":[{}],"otherOfficers":[{}],"overrideDetails":[{}],"inputter":[{}],"dateTime":[{}]}},"responses":{"200":"UsCorporateCustomerResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"POST","path":"/party/us/customers/individuals","fullPath":"/api/v3.3.0/party/us/customers/individuals","operationId":"createUsIndividualCustomer","name":"Allows creation of an individual customer","summary":"Create individual customer","tags":["RETAIL"],"parameters":[{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"idDocument":[{}],"employment":[{}],"creditScore":[{}],"relationships":[{}],"relation":[{}],"PreviousIdentification":[{}],"residenceInfo":[{}],"communication":[{}],"communicationDevices":[{}],"officePhoneNumbers":[{}],"faxIds":[{}],"riskClass":[{}],"overrideReason":[{}],"crProfileType":[{}],"otherOfficers":[{}]}},"responses":{"200":"UsIndividualCustomerResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/party/us/customer/{customerId}/addressPreferences","fullPath":"/api/v3.3.0/party/us/customer/{customerId}/addressPreferences","operationId":"getAddressPreferences","name":"Retrieves seasonal address preferences set for the customer. Provides the address carrier and the duration for which an address should be used as the primary address","summary":"Seasonal address details","tags":["RETAIL"],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"Identifier of the customer"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"AddressPreferencesResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"POST","path":"/party/us/customer/{customerId}/addressPreferences","fullPath":"/api/v3.3.0/party/us/customer/{customerId}/addressPreferences","operationId":"createAddressPreference","name":"Allows capturing alternate address for a customer to be used for mails during specific periods each year","summary":"Create alternate address ","tags":["RETAIL"],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"Identifier of the customer"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"alternateaddressperiod":[{}],"carrier":"string","defaultCarrier":"string","extensions":{}}},"responses":{"200":"AddressPreferenceResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/party/us/customer/{customerId}/addressPreferences","fullPath":"/api/v3.3.0/party/us/customer/{customerId}/addressPreferences","operationId":"updateAddressPreference","name":"Updates alternate address information for a customer","summary":"Update alternate address","tags":["RETAIL"],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"Identifier of the customer"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"alternateaddressperiod":[{}],"carrier":"string","defaultCarrier":"string","extensions":{}}},"responses":{"200":"AddressPreferenceResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/party/us/customers/{customerId}/beneficiaries","fullPath":"/api/v3.3.0/party/us/customers/{customerId}/beneficiaries","operationId":"getUsBeneficiary","name":"Retrieve list of beneficiaries created for a customer to perform account transfer, bill payments or wires. Information can be retrieved using customerId, debitAccountId, beneficiaryNickName, accountType etc,.","summary":"Retrieve beneficiary information for a customer","tags":["RETAIL"],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"Identifier of the customer"},{"name":"beneficiaryInstituteName","in":"query","type":"string","required":false,"description":"Indicates the name of financial institution where the beneficiary account is held"},{"name":"beneficiaryAccountId","in":"query","type":"string","required":false,"description":"Unique account identifier of the beneficiary account number."},{"name":"beneficiaryNickName","in":"query","type":"string","required":false,"description":"Nickname of the beneficiary"},{"name":"accountWithBankSortCode","in":"query","type":"string","required":false,"description":"Bank sort code details with account"},{"name":"accountType","in":"query","type":"string","required":false,"description":"Groups the products based on their type, eg, Checking, Savings, CD etc,."},{"name":"beneficiaryCustomerId","in":"query","type":"string","required":false,"description":"Identifies the Customer who is to be the ultimate receiver of the funds transferred by the sending bank when this Beneficiary is not a bank."},{"name":"beneficiaryId","in":"query","type":"string","required":false,"description":"Indicates the reference of the financial institution that allows access to the beneficiary information"},{"name":"transactionType","in":"query","type":"string","required":false,"description":"Identifies the transaction type applicable to the transaction being processed, i.e. outward or inward payment. For example: ACPX, OTPX etc."},{"name":"preferredPaymentProduct","in":"query","type":"string","required":false,"description":"Preferred payment product can be specified for Beneficiary. This will be used for defaulting the payment product for specific beneficiary. "},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"UsBeneficiaryResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"POST","path":"/party/us/customers/{customerId}/beneficiaries","fullPath":"/api/v3.3.0/party/us/customers/{customerId}/beneficiaries","operationId":"createUsBeneficiary","name":"Create a beneficiary for account transfers or bill payment","summary":"Create an ACH beneficiary","tags":["RETAIL"],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"Identifier of the customer"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"beneficiaryAccountId":"string","beneficiaryNickName":"string","accountWithBankSortCode":"string","accountType":"CHECKING","beneficiaryCustomerId":"string","paymentDetails":"string","beneficiaryOtherIdType":"ORGANISATION","beneficiaryOtherId":"string","preferredPaymentProduct":"string","recordStatus":"string","currNo":"string","inputter":"string","dateTime":"2024-01-01","authoriser":"string","deptCode":"string"}},"responses":{"200":"UsBeneficiaryResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/party/us/customers/beneficiaries/{beneficiaryId}","fullPath":"/api/v3.3.0/party/us/customers/beneficiaries/{beneficiaryId}","operationId":"updateUsBeneficiary","name":"Update beneficiary created for account transfers or bill payment","summary":"Update ACH beneficiary","tags":["RETAIL"],"parameters":[{"name":"beneficiaryId","in":"path","type":"string","required":true,"description":"Indicates the reference of the financial institution that allows access to the beneficiary information"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"beneficiaryAccountId":"string","beneficiaryNickName":"string","accountWithBankSortCode":"string","accountType":"CHECKING","beneficiaryCustomerId":"string","paymentDetails":"string","beneficiaryOtherIdType":"ORGANISATION","beneficiaryOtherId":"string","preferredPaymentProduct":"string","recordStatus":"string","currNo":"string","inputter":"string","dateTime":"2024-01-01","authoriser":"string","deptCode":"string"}},"responses":{"200":"UsBeneficiaryResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"POST","path":"/party/us/customers/{customerId}/beneficiaries/wires","fullPath":"/api/v3.3.0/party/us/customers/{customerId}/beneficiaries/wires","operationId":"createUsWiresBeneficiary","name":"Create beneficiary information for generating a wire transfer","summary":"Creates beneficiary for wire transfers","tags":["RETAIL"],"parameters":[{"name":"customerId","in":"path","type":"number","required":true,"description":"Identifier of the customer"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"beneficiaryNickNames":[{}],"beneficiaryPaymentCountryId":"string","beneficiaryAccountId":"string","accountWithBankSortCode":"string","accountType":"@ref:reference-us-sortcodes-services","beneficiaryInstituteName":"string","beneficiaryInstituteBranchName":"string","beneficiaryInstituteAddressLine1":"string","beneficiaryInstituteAddressLine2":"string","beneficiaryInstituteAddressLine3":0.0,"beneficiaryInstituteCountryCode":"string","beneficiaryCustomerId":"string","beneficiaryShortName":"string","beneficiaryAddressLine1":"string","beneficiaryAddressLine2":"string"}},"responses":{"200":"UsWiresBeneficiaryResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/party/us/customers/beneficiaries/{beneficiaryId}/wires","fullPath":"/api/v3.3.0/party/us/customers/beneficiaries/{beneficiaryId}/wires","operationId":"updateUsWiresBeneficiary","name":"Updates routing number, bank details or the payee details of a beneficiary set up for wire transfers","summary":"Updates existing wire payment beneficiary","tags":["RETAIL"],"parameters":[{"name":"beneficiaryId","in":"path","type":"string","required":true,"description":"Indicates the reference of the financial institution that allows access to the beneficiary information"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"beneficiaryNickNames":[{}],"beneficiaryPaymentCountryId":"string","beneficiaryAccountId":"string","accountWithBankSortCode":"string","accountType":"@ref:reference-us-sortcodes-services","beneficiaryInstituteName":"string","beneficiaryInstituteBranchName":"string","beneficiaryInstituteAddressLine1":"string","beneficiaryInstituteAddressLine2":"string","beneficiaryInstituteAddressLine3":0.0,"beneficiaryInstituteCountryCode":"string","beneficiaryCustomerId":"string","beneficiaryShortName":"string","beneficiaryAddressLine1":"string","beneficiaryAddressLine2":"string"}},"responses":{"200":"UsWiresBeneficiaryResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/party/us/customers/deliveryPreferences/{customerId}","fullPath":"/api/v3.3.0/party/us/customers/deliveryPreferences/{customerId}","operationId":"getUsDeliveryPreference","name":"Retrieves all available mail addresses for a customer along with information on the purpose of the address (Primary, office, etc,.), internal address reference.","summary":"Retrieves all available mail addresses for a customer along with information on the purpose of the address (Primary, office, etc,.), internal address reference.","tags":[],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"UsDeliveryPreferenceResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}}]},{"key":"party-us-customerservice-v3.4.0","title":"US Model Bank Customer management","version":"v3.4.0","description":"The customer service API allows to create, update and modify customer, contact details, address and beneficiary. Separate URIs are available for corporate and individual customers to update or retrieve specific information like address, secondary address, credit score, KYC, relation, beneficial owne","endpointCount":29,"endpoints":[{"method":"GET","path":"/party/us/customers","fullPath":"/api/v3.4.0/party/us/customers","operationId":"searchUsCustomer","name":"Search and retrieve customer information based on customer name, date of birth, date of incorporation, SSN or TIN, and mobile number","summary":"Search customer","tags":["RETAIL"],"parameters":[{"name":"customerId","in":"query","type":"string","required":false,"description":"Identifier of the customer"},{"name":"customerName","in":"query","type":"string","required":false,"description":"Indicates the name of the customer. Originator is the party who requests the payment cancellation."},{"name":"taxId","in":"query","type":"string","required":false,"description":"Holds the Customer's TAX/SSN Id."},{"name":"dateOfBirth","in":"query","type":"string","required":false,"description":"The date of birth of an individual customer"},{"name":"mobileNumber","in":"query","type":"string","required":false,"description":"Mobile number of the customer"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"UsCustomerResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/party/us/customers/{customerId}/corporates","fullPath":"/api/v3.4.0/party/us/customers/{customerId}/corporates","operationId":"getUsCorporateCustomer","name":"Retrieves corporate customer information. Unless there is a specific set of information to be retrieved for which a separate APIs exists, this generic API can be used where all available information can be retrieved.","summary":"Retrieve corporate customer information","tags":["RETAIL"],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"Identifier of the customer"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"UsCorporateCustomerResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/party/us/customers/{customerId}/corporates","fullPath":"/api/v3.4.0/party/us/customers/{customerId}/corporates","operationId":"updateUsCorporateCustomer","name":"Updates corporate customer information. Unless there is a specific set of information to be updated for which a separate URIs exists, this generic URI can be used where all available information can be updated","summary":"Update corporate customer information","tags":["RETAIL"],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"Identifier of the customer"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"legalStatusGRP":[{}],"idDocument":[{}],"relationships":[{}],"relationship":[{}],"PreviousIdentification":[{}],"communication":[{}],"riskClass":[{}],"overrideReason":[{}],"crProfileType":[{}],"otherOfficers":[{}],"overrideDetails":[{}],"inputter":[{}],"dateTime":[{}],"customerName":"string","customerNameAdditional":"string"}},"responses":{"200":"UsCorporateCustomerResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/party/us/customers/{customerId}/individuals","fullPath":"/api/v3.4.0/party/us/customers/{customerId}/individuals","operationId":"getUsIndividualCustomer","name":"Retrieves individual customer information. Unless there is a specific set of information to be  retrieved  for which a separate URIs exists, this generic URI can be used where all available information for an individual customer can be retrieved.","summary":"Retrieve individual customer information","tags":["RETAIL"],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"Identifier of the customer"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"UsIndividualCustomerResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/party/us/customers/{customerId}/individuals","fullPath":"/api/v3.4.0/party/us/customers/{customerId}/individuals","operationId":"updateUsIndividualCustomer","name":"Updates individual customer information. Unless there is a specific set of information to be updated for which a separate URIs exists, this generic URI can be used where all information for an individual customer can be updated.","summary":"Update individual customer information","tags":["RETAIL"],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"Identifier of the customer"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"legalStatusGRP":[{}],"idDocument":[{}],"employment":[{}],"creditScore":[{}],"relationships":[{}],"relation":[{}],"PreviousIdentification":[{}],"residenceInfo":[{}],"communication":[{}],"riskClass":[{}],"overrideReason":[{}],"crProfileType":[{}],"otherOfficers":[{}],"overrideDetails":[{}],"inputter":[{}]}},"responses":{"200":"UsIndividualCustomerResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/party/us/customers/{customerId}/contacts","fullPath":"/api/v3.4.0/party/us/customers/{customerId}/contacts","operationId":"getUsCustomerAddresslist","name":"Retrieves all available mail addresses for a customer along with information on the purpose of the address(Primary, office, etc,.), internal address reference. ","summary":"Retrieve customer mailing addresses","tags":["RETAIL"],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"UsCustomerAddresslistResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/party/us/customers/{customerId}/contacts","fullPath":"/api/v3.4.0/party/us/customers/{customerId}/contacts","operationId":"createUsCustomerContactDetail","name":"Create or update customer phone, office phone, mobile, email or fax numbers and the consent for sharing contact information with financial institute's marketing partners.","summary":"Create or update customer contact and consent information","tags":["RETAIL"],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":""},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"contactDetails":[{}],"consentDetails":[{}],"customercontactflag":"string","extensions":{}}},"responses":{"200":"UsCustomerContactDetailResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/party/us/customers/{customerId}/scores","fullPath":"/api/v3.4.0/party/us/customers/{customerId}/scores","operationId":"getUsCustomerCreditscore","name":"Retrieve customer's credit score information received from credit agencies.","summary":"Retrieve customer credit scores","tags":["RETAIL"],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"Identifier of the customer"},{"name":"agencyId","in":"query","type":"string","required":false,"description":"Name of the agency that provided the credit score. Allowed values can be retrieved through getEbLookups for virtualTableName CREDIT.BUREAU"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"UsCustomerCreditscoreResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/party/us/customers/{customerId}/agencies/{agencyId}/scores","fullPath":"/api/v3.4.0/party/us/customers/{customerId}/agencies/{agencyId}/scores","operationId":"getUsCustomerCreditscoreByAgency","name":"Retrieves the credit score information available for a customer from the specific reporting agency provided in the URI.","summary":"Retrieve customer credit score by agency","tags":["RETAIL"],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"Identifier of the customer"},{"name":"agencyId","in":"path","type":"string","required":true,"description":"Name of the agency that provided the credit score. Allowed values can be retrieved through getEbLookups for virtualTableName CREDIT.BUREAU"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"UsCustomerCreditscoreByAgencyResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/party/us/customers/{customerId}/documents","fullPath":"/api/v3.4.0/party/us/customers/{customerId}/documents","operationId":"searchUsDocuments","name":"Search documents available for customer identification. Provides information on document reference, status, validity, issuer details, and version information.","summary":"Search customer documents","tags":["RETAIL"],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"Identifier of the customer"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"UsDocumentsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/party/us/customers/{customerId}/kyc","fullPath":"/api/v3.4.0/party/us/customers/{customerId}/kyc","operationId":"getUsCustomerKycandTax","name":"Retrieves KYC and tax information for a customer","summary":"Retrieve customer KYC and tax information","tags":["RETAIL"],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"Identifier of the customer"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"UsCustomerKycandTaxResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/party/us/customers/{customerId}/kyc","fullPath":"/api/v3.4.0/party/us/customers/{customerId}/kyc","operationId":"updateUsCustomerKycandTax","name":"Allows update to KYC and tax information for a customer","summary":"Update customer KYC and tax information","tags":["RETAIL"],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"Identifier of the customer"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"riskClass":[{}],"introducer":"string","contactDate":"2024-01-01","kycRelationship":"string","kycLastReviewDate":"2024-01-01","amlCheck":"NULL","amlResult":"NULL","amlLastResultDate":"2024-01-01","manualRiskClass":"string","overrideReason":"string","isKycComplete":"YES","taxCertificationType":"/v1.0.0/reference/lookups?virtualTableName=TAX.CERT.TYPE","foreignTin":"string","taxCertificationDate":"2024-01-01","reasonForMissingFtin":"/v1.0.0/reference/lookups?virtualTableName=FTIN.MIS.REASON"}},"responses":{"200":"UsCustomerKycandTaxResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/party/us/customers/{customerId}/primaryAddresses","fullPath":"/api/v3.4.0/party/us/customers/{customerId}/primaryAddresses","operationId":"getUsCustomerPrimaryAddress","name":"Retrieve customer primary address","summary":"Retrieve customer primary address","tags":["RETAIL"],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"Identifier of the customer"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"UsCustomerPrimaryAddressResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/party/us/customers/{customerId}/primaryAddresses","fullPath":"/api/v3.4.0/party/us/customers/{customerId}/primaryAddresses","operationId":"updateUsCustomerPrimaryAddress","name":"Update customer primary address","summary":"Update customer primary address","tags":["RETAIL"],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"Identifier of the customer"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"overrideDetails":[{}],"inputter":[{}],"dateTime":[{}],"addressLine1":"string","addressLine2":"string","city":"string","stateId":"/v1.0.0/reference/us/states","countyId":"/v1.0.0/reference/us/states/{stateId}/counties","zipCode":0.0,"zipPlusFour":0.0,"country":"/v1.0.0/reference/countries","addressStatus":"B","addressLocation":"string","addressPurpose":"CTC","recordStatus":"string"}},"responses":{"200":"UsCustomerPrimaryAddressResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/party/us/customers/{customerId}/relations","fullPath":"/api/v3.4.0/party/us/customers/{customerId}/relations","operationId":"updateUsCustomerRelation","name":"Update relationship information for an individual customer or update beneficial ownership details for a corporate customer","summary":"Update customer relation","tags":["RETAIL"],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"Identifier of the customer"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"relationships":[{}],"relationship":[{}],"ownershipRuleId":"/v1.0.0/reference/us/beneficialOwnerTypes","noOwnerGt25Percent":"YES","otherOwnersLt25PercentFlag":"YES","certifierName":"string","certifierTitle":"string","additionalTitle":"string","certificationDate":"2024-01-01","extensions":{}}},"responses":{"200":"UsCustomerRelationResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/party/us/customers/secondaryAddresses/{addressReference}","fullPath":"/api/v3.4.0/party/us/customers/secondaryAddresses/{addressReference}","operationId":"updateUsCustomerSecondaryAddress","name":"Update existing address information for the customer.","summary":"Update secondary address","tags":["RETAIL"],"parameters":[{"name":"addressReference","in":"path","type":"string","required":true,"description":"Reference Id of address record"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"addressLine1":"string","addressLine2":"string","shortName":"string","city":"string","stateId":"/v1.0.0/reference/us/states","countyId":"/v1.0.0/reference/us/states/{stateId}/counties","zipCode":0.0,"zipPlusFour":0.0,"country":"/v1.0.0/reference/countries","customerContactIndicator":"YES","addressStatus":"B","taxAddressType":"/v1.0.0/reference/lookups?virtualTableName=IRS.ADDRESS.TYPE","addressPurpose":"CTC","extensions":{}}},"responses":{"200":"UsCustomerSecondaryAddressResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"DELETE","path":"/party/us/customers/secondaryAddresses/{addressReference}","fullPath":"/api/v3.4.0/party/us/customers/secondaryAddresses/{addressReference}","operationId":"deleteUsCustomerSecondaryAddress","name":"Remove customer's secondary address information","summary":"Remove customer's secondary address","tags":["RETAIL"],"parameters":[{"name":"addressReference","in":"path","type":"string","required":true,"description":"Reference Id of address record"},{"name":"payload","in":"body","type":"object","required":false,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}}},"responses":{"200":"UsCustomerSecondaryAddressResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"POST","path":"/party/us/customers/{customerId}/secondaryAddresses","fullPath":"/api/v3.4.0/party/us/customers/{customerId}/secondaryAddresses","operationId":"createUsCustomerSecondaryAddress","name":"Add new customer address information","summary":"Create secondary address","tags":["RETAIL"],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"Identifier of the customer"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"addressLine1":"string","addressLine2":"string","shortName":"string","name":"string","city":"string","stateId":"/v1.0.0/reference/us/states","countyId":"/v1.0.0/reference/us/states/{stateId}/counties","zipCode":0.0,"zipPlusFour":0.0,"country":"/v1.0.0/reference/countries","customerContactIndicator":"YES","addressStatus":"B","taxAddressType":"/v1.0.0/reference/lookups?virtualTableName=IRS.ADDRESS.TYPE","addressPurpose":"CTC","extensions":{}}},"responses":{"200":"UsCustomerSecondaryAddressResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"POST","path":"/party/us/customers/corporates","fullPath":"/api/v3.4.0/party/us/customers/corporates","operationId":"createUsCorporateCustomer","name":"Allows creation of a corporate customer","summary":"Create corporate customer","tags":["RETAIL"],"parameters":[{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"legalStatusGRP":[{}],"idDocument":[{}],"relationships":[{}],"relationship":[{}],"PreviousIdentification":[{}],"communication":[{}],"communicationDevices":[{}],"officePhoneNumbers":[{}],"faxIds":[{}],"riskClass":[{}],"overrideReason":[{}],"crProfileType":[{}],"otherOfficers":[{}],"overrideDetails":[{}],"inputter":[{}]}},"responses":{"200":"UsCorporateCustomerResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"POST","path":"/party/us/customers/individuals","fullPath":"/api/v3.4.0/party/us/customers/individuals","operationId":"createUsIndividualCustomer","name":"Allows creation of an individual customer","summary":"Create individual customer","tags":["RETAIL"],"parameters":[{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"legalStatusGRP":[{}],"idDocument":[{}],"employment":[{}],"creditScore":[{}],"relationships":[{}],"relation":[{}],"PreviousIdentification":[{}],"residenceInfo":[{}],"communication":[{}],"communicationDevices":[{}],"officePhoneNumbers":[{}],"faxIds":[{}],"riskClass":[{}],"overrideReason":[{}],"crProfileType":[{}]}},"responses":{"200":"UsIndividualCustomerResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/party/us/customer/{customerId}/addressPreferences","fullPath":"/api/v3.4.0/party/us/customer/{customerId}/addressPreferences","operationId":"getAddressPreferences","name":"Retrieves seasonal address preferences set for the customer. Provides the address carrier and the duration for which an address should be used as the primary address","summary":"Seasonal address details","tags":["RETAIL"],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"Identifier of the customer"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"AddressPreferencesResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"POST","path":"/party/us/customer/{customerId}/addressPreferences","fullPath":"/api/v3.4.0/party/us/customer/{customerId}/addressPreferences","operationId":"createAddressPreference","name":"Allows capturing alternate address for a customer to be used for mails during specific periods each year","summary":"Create alternate address ","tags":["RETAIL"],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"Identifier of the customer"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"alternateaddressperiod":[{}],"carrier":"string","defaultCarrier":"string","extensions":{}}},"responses":{"200":"AddressPreferenceResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/party/us/customer/{customerId}/addressPreferences","fullPath":"/api/v3.4.0/party/us/customer/{customerId}/addressPreferences","operationId":"updateAddressPreference","name":"Updates alternate address information for a customer","summary":"Update alternate address","tags":["RETAIL"],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"Identifier of the customer"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"alternateaddressperiod":[{}],"carrier":"string","defaultCarrier":"string","extensions":{}}},"responses":{"200":"AddressPreferenceResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/party/us/customers/{customerId}/beneficiaries","fullPath":"/api/v3.4.0/party/us/customers/{customerId}/beneficiaries","operationId":"getUsBeneficiary","name":"Retrieve list of beneficiaries created for a customer to perform account transfer, bill payments or wires. Information can be retrieved using customerId, debitAccountId, beneficiaryNickName, accountType etc,.","summary":"Retrieve beneficiary information for a customer","tags":["RETAIL"],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"Identifier of the customer"},{"name":"beneficiaryInstituteName","in":"query","type":"string","required":false,"description":"Indicates the name of financial institution where the beneficiary account is held"},{"name":"beneficiaryAccountId","in":"query","type":"string","required":false,"description":"Unique account identifier of the beneficiary account number."},{"name":"beneficiaryNickName","in":"query","type":"string","required":false,"description":"Nickname of the beneficiary"},{"name":"accountWithBankSortCode","in":"query","type":"string","required":false,"description":"Bank sort code details with account"},{"name":"accountType","in":"query","type":"string","required":false,"description":"Groups the products based on their type, eg, Checking, Savings, CD etc,."},{"name":"beneficiaryCustomerId","in":"query","type":"string","required":false,"description":"Identifies the Customer who is to be the ultimate receiver of the funds transferred by the sending bank when this Beneficiary is not a bank."},{"name":"beneficiaryId","in":"query","type":"string","required":false,"description":"Indicates the reference of the financial institution that allows access to the beneficiary information"},{"name":"transactionType","in":"query","type":"string","required":false,"description":"Identifies the transaction type applicable to the transaction being processed, i.e. outward or inward payment. For example: ACPX, OTPX etc."},{"name":"preferredPaymentProduct","in":"query","type":"string","required":false,"description":"Preferred payment product can be specified for Beneficiary. This will be used for defaulting the payment product for specific beneficiary. "},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"UsBeneficiaryResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"POST","path":"/party/us/customers/{customerId}/beneficiaries","fullPath":"/api/v3.4.0/party/us/customers/{customerId}/beneficiaries","operationId":"createUsBeneficiary","name":"Create a beneficiary for account transfers or bill payment","summary":"Create an ACH beneficiary","tags":["RETAIL"],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"Identifier of the customer"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"beneficiaryAccountId":"string","beneficiaryNickName":"string","accountWithBankSortCode":"string","accountType":"CHECKING","beneficiaryCustomerId":"string","paymentDetails":"string","beneficiaryOtherIdType":"ORGANISATION","beneficiaryOtherId":"string","preferredPaymentProduct":"string","recordStatus":"string","currNo":"string","inputter":"string","dateTime":"2024-01-01","authoriser":"string","deptCode":"string"}},"responses":{"200":"UsBeneficiaryResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/party/us/customers/beneficiaries/{beneficiaryId}","fullPath":"/api/v3.4.0/party/us/customers/beneficiaries/{beneficiaryId}","operationId":"updateUsBeneficiary","name":"Update beneficiary created for account transfers or bill payment","summary":"Update ACH beneficiary","tags":["RETAIL"],"parameters":[{"name":"beneficiaryId","in":"path","type":"string","required":true,"description":"Indicates the reference of the financial institution that allows access to the beneficiary information"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"beneficiaryAccountId":"string","beneficiaryNickName":"string","accountWithBankSortCode":"string","accountType":"CHECKING","beneficiaryCustomerId":"string","paymentDetails":"string","beneficiaryOtherIdType":"ORGANISATION","beneficiaryOtherId":"string","preferredPaymentProduct":"string","recordStatus":"string","currNo":"string","inputter":"string","dateTime":"2024-01-01","authoriser":"string","deptCode":"string"}},"responses":{"200":"UsBeneficiaryResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"POST","path":"/party/us/customers/{customerId}/beneficiaries/wires","fullPath":"/api/v3.4.0/party/us/customers/{customerId}/beneficiaries/wires","operationId":"createUsWiresBeneficiary","name":"Create beneficiary information for generating a wire transfer","summary":"Creates beneficiary for wire transfers","tags":["RETAIL"],"parameters":[{"name":"customerId","in":"path","type":"number","required":true,"description":"Identifier of the customer"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"beneficiaryNickNames":[{}],"beneficiaryPaymentCountryId":"string","beneficiaryAccountId":"string","accountWithBankSortCode":"string","accountType":"@ref:reference-us-sortcodes-services","beneficiaryInstituteName":"string","beneficiaryInstituteBranchName":"string","beneficiaryInstituteAddressLine1":"string","beneficiaryInstituteAddressLine2":"string","beneficiaryInstituteAddressLine3":0.0,"beneficiaryInstituteCountryCode":"string","beneficiaryCustomerId":"string","beneficiaryShortName":"string","beneficiaryAddressLine1":"string","beneficiaryAddressLine2":"string"}},"responses":{"200":"UsWiresBeneficiaryResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/party/us/customers/beneficiaries/{beneficiaryId}/wires","fullPath":"/api/v3.4.0/party/us/customers/beneficiaries/{beneficiaryId}/wires","operationId":"updateUsWiresBeneficiary","name":"Updates routing number, bank details or the payee details of a beneficiary set up for wire transfers","summary":"Updates existing wire payment beneficiary","tags":["RETAIL"],"parameters":[{"name":"beneficiaryId","in":"path","type":"string","required":true,"description":"Indicates the reference of the financial institution that allows access to the beneficiary information"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"beneficiaryNickNames":[{}],"beneficiaryPaymentCountryId":"string","beneficiaryAccountId":"string","accountWithBankSortCode":"string","accountType":"@ref:reference-us-sortcodes-services","beneficiaryInstituteName":"string","beneficiaryInstituteBranchName":"string","beneficiaryInstituteAddressLine1":"string","beneficiaryInstituteAddressLine2":"string","beneficiaryInstituteAddressLine3":0.0,"beneficiaryInstituteCountryCode":"string","beneficiaryCustomerId":"string","beneficiaryShortName":"string","beneficiaryAddressLine1":"string","beneficiaryAddressLine2":"string"}},"responses":{"200":"UsWiresBeneficiaryResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/party/us/customers/deliveryPreferences/{customerId}","fullPath":"/api/v3.4.0/party/us/customers/deliveryPreferences/{customerId}","operationId":"getUsDeliveryPreference","name":"Retrieves all available mail addresses for a customer along with information on the purpose of the address (Primary, office, etc,.), internal address reference.","summary":"Retrieves all available mail addresses for a customer along with information on the purpose of the address (Primary, office, etc,.), internal address reference.","tags":["RETAIL"],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"UsDeliveryPreferenceResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}}]},{"key":"party-us-customerservice-v4.0.0","title":"US Model Bank Customer management","version":"v4.0.0","description":"The customer service API allows to create, update and modify customer, contact details, address and beneficiary. Separate URIs are available for corporate and individual customers to update or retrieve specific information like address, secondary address, credit score, KYC, relation, beneficial owne","endpointCount":29,"endpoints":[{"method":"GET","path":"/party/us/customers","fullPath":"/api/v4.0.0/party/us/customers","operationId":"searchUsCustomer","name":"Search and retrieve customer information based on customer name, date of birth, date of incorporation, SSN or TIN, and mobile number","summary":"Search customer","tags":["RETAIL"],"parameters":[{"name":"customerId","in":"query","type":"string","required":false,"description":"Identifier of the customer"},{"name":"customerName","in":"query","type":"string","required":false,"description":"Indicates the name of the customer. Originator is the party who requests the payment cancellation."},{"name":"taxId","in":"query","type":"string","required":false,"description":"Holds the Customer's TAX/SSN Id."},{"name":"dateOfBirth","in":"query","type":"string","required":false,"description":"The date of birth of an individual customer"},{"name":"mobileNumber","in":"query","type":"string","required":false,"description":"Mobile number of the customer"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"UsCustomerResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/party/us/customers/{customerId}/corporates","fullPath":"/api/v4.0.0/party/us/customers/{customerId}/corporates","operationId":"getUsCorporateCustomer","name":"Retrieves corporate customer information. Unless there is a specific set of information to be updated for which a separate APIs exists, this generic API can be used where all available information can be retrieved.","summary":"Retrieve corporate customer information","tags":["RETAIL"],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"Identifier of the customer"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"UsCorporateCustomerResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/party/us/customers/{customerId}/corporates","fullPath":"/api/v4.0.0/party/us/customers/{customerId}/corporates","operationId":"updateUsCorporateCustomer","name":"Updates corporate customer information. Unless there is a specific set of information to be updated for which a separate URIs exists, this generic URI can be used where all available information can be updated","summary":"Update corporate customer information","tags":["RETAIL"],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"Identifier of the customer"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"idDocument":[{}],"PreviousIdentification":[{}],"communication":[{}],"riskClass":[{}],"overrideReason":[{}],"crProfileType":[{}],"otherOfficers":[{}],"overrideDetails":[{}],"inputter":[{}],"dateTime":[{}],"customerName":"string","customerNameAdditional":"string","shortName":"string","birthIncorpDate":"string","taxId":"string"}},"responses":{"200":"UsCorporateCustomerResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/party/us/customers/{customerId}/individuals","fullPath":"/api/v4.0.0/party/us/customers/{customerId}/individuals","operationId":"getUsIndividualCustomer","name":"Retrieves individual customer information. Unless there is a specific set of information to be updated for which a separate URIs exists, this generic URI can be used where all available information for an individual customer can be retrieved.","summary":"Retrieve individual customer information","tags":["RETAIL"],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"Identifier of the customer"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"UsIndividualCustomerResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/party/us/customers/{customerId}/individuals","fullPath":"/api/v4.0.0/party/us/customers/{customerId}/individuals","operationId":"updateUsIndividualCustomer","name":"Updates individual customer information. Unless there is a specific set of information to be updated for which a separate URIs exists, this generic URI can be used where all information for an individual customer can be updated.","summary":"Update individual customer information","tags":["RETAIL"],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"Identifier of the customer"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"idDocument":[{}],"employment":[{}],"creditScore":[{}],"PreviousIdentification":[{}],"residenceInfo":[{}],"communication":[{}],"riskClass":[{}],"overrideReason":[{}],"crProfileType":[{}],"otherOfficers":[{}],"overrideDetails":[{}],"inputter":[{}],"dateTime":[{}],"title":"string","givenName":"string"}},"responses":{"200":"UsIndividualCustomerResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/party/us/customers/{customerId}/contacts","fullPath":"/api/v4.0.0/party/us/customers/{customerId}/contacts","operationId":"getUsCustomerAddresslist","name":"Retrieves all available mail addresses for a customer along with information on the purpose of the address(Primary, office, etc,.), internal address reference. ","summary":"Retrieve customer mailing addresses","tags":["RETAIL"],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"UsCustomerAddresslistResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/party/us/customers/{customerId}/contacts","fullPath":"/api/v4.0.0/party/us/customers/{customerId}/contacts","operationId":"createUsCustomerContactDetail","name":"Create or update customer phone, office phone, mobile, email or fax numbers and the consent for sharing contact information with financial institute's marketing partners.","summary":"Create or update customer contact and consent information","tags":["RETAIL"],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":""},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"contactDetails":[{}],"consentDetails":[{}],"customercontactflag":"string","extensions":{}}},"responses":{"200":"UsCustomerContactDetailResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/party/us/customers/{customerId}/scores","fullPath":"/api/v4.0.0/party/us/customers/{customerId}/scores","operationId":"getUsCustomerCreditscore","name":"Retrieve customer's credit score information received from credit agencies.","summary":"Retrieve customer credit scores","tags":["RETAIL"],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"Identifier of the customer"},{"name":"agencyId","in":"query","type":"string","required":false,"description":"Name of the agency that provided the credit score. Allowed values can be retrieved through getEbLookups for virtualTableName CREDIT.BUREAU"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"UsCustomerCreditscoreResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/party/us/customers/{customerId}/agencies/{agencyId}/scores","fullPath":"/api/v4.0.0/party/us/customers/{customerId}/agencies/{agencyId}/scores","operationId":"getUsCustomerCreditscoreByAgency","name":"Retrieves the credit score information available for a customer from the specific reporting agency provided in the URI.","summary":"Retrieve customer credit score by agency","tags":["RETAIL"],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"Identifier of the customer"},{"name":"agencyId","in":"path","type":"string","required":true,"description":"Name of the agency that provided the credit score. Allowed values can be retrieved through getEbLookups for virtualTableName CREDIT.BUREAU"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"UsCustomerCreditscoreByAgencyResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/party/us/customers/{customerId}/documents","fullPath":"/api/v4.0.0/party/us/customers/{customerId}/documents","operationId":"searchUsDocuments","name":"Search documents available for customer identification. Provides information on document reference, status, validity, issuer details, and version information.","summary":"Search customer documents","tags":["RETAIL"],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"Identifier of the customer"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"UsDocumentsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/party/us/customers/{customerId}/kyc","fullPath":"/api/v4.0.0/party/us/customers/{customerId}/kyc","operationId":"getUsCustomerKycandTax","name":"Retrieves KYC and tax information for a customer","summary":"Retrieve customer KYC and tax information","tags":["RETAIL"],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"Identifier of the customer"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"UsCustomerKycandTaxResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/party/us/customers/{customerId}/kyc","fullPath":"/api/v4.0.0/party/us/customers/{customerId}/kyc","operationId":"updateUsCustomerKycandTax","name":"Allows update to KYC and tax information for a customer","summary":"Update customer KYC and tax information","tags":["RETAIL"],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"Identifier of the customer"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"riskClass":[{}],"introducer":"string","contactDate":"2024-01-01","kycRelationship":"string","kycLastReviewDate":"2024-01-01","amlCheck":"NULL","amlResult":"NULL","amlLastResultDate":"2024-01-01","manualRiskClass":"string","overrideReason":"string","isKycComplete":"YES","taxCertificationType":"/v1.0.0/reference/lookups?virtualTableName=TAX.CERT.TYPE","foreignTin":"string","taxCertificationDate":"2024-01-01","reasonForMissingFtin":"/v1.0.0/reference/lookups?virtualTableName=FTIN.MIS.REASON"}},"responses":{"200":"UsCustomerKycandTaxResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/party/us/customers/{customerId}/primaryAddresses","fullPath":"/api/v4.0.0/party/us/customers/{customerId}/primaryAddresses","operationId":"getUsCustomerPrimaryAddress","name":"Retrieve customer primary address","summary":"Retrieve customer primary address","tags":["RETAIL"],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"Identifier of the customer"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"UsCustomerPrimaryAddressResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/party/us/customers/{customerId}/primaryAddresses","fullPath":"/api/v4.0.0/party/us/customers/{customerId}/primaryAddresses","operationId":"updateUsCustomerPrimaryAddress","name":"Update customer primary address","summary":"Update customer primary address","tags":["RETAIL"],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"Identifier of the customer"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"overrideDetails":[{}],"inputter":[{}],"dateTime":[{}],"addressLine1":"string","addressLine2":"string","city":"string","stateId":"/v1.0.0/reference/us/states","countyId":"/v1.0.0/reference/us/states/{stateId}/counties","zipCode":0.0,"zipPlusFour":0.0,"country":"/v1.0.0/reference/countries","addressStatus":"B","addressLocation":"string","addressPurpose":"CTC","recordStatus":"string"}},"responses":{"200":"UsCustomerPrimaryAddressResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/party/us/customers/{customerId}/relations","fullPath":"/api/v4.0.0/party/us/customers/{customerId}/relations","operationId":"updateUsCustomerRelation","name":"Update relationship information for an individual customer or update beneficial ownership details for a corporate customer","summary":"Update customer relation","tags":["RETAIL"],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"Identifier of the customer"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"relationships":[{}],"relationship":[{}],"ownershipRuleId":"/v1.0.0/reference/us/beneficialOwnerTypes","noOwnerGt25Percent":"YES","otherOwnersLt25PercentFlag":"YES","certifierName":"string","certifierTitle":"string","additionalTitle":"string","certificationDate":"2024-01-01","extensions":{}}},"responses":{"200":"UsCustomerRelationResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/party/us/customers/secondaryAddresses/{addressReference}","fullPath":"/api/v4.0.0/party/us/customers/secondaryAddresses/{addressReference}","operationId":"updateUsCustomerSecondaryAddress","name":"Update existing address information for the customer.","summary":"Update secondary address","tags":["RETAIL"],"parameters":[{"name":"addressReference","in":"path","type":"string","required":true,"description":"Reference Id of address record"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"addressLine1":"string","addressLine2":"string","shortName":"string","city":"string","stateId":"/v1.0.0/reference/us/states","countyId":"/v1.0.0/reference/us/states/{stateId}/counties","zipCode":0.0,"zipPlusFour":0.0,"country":"/v1.0.0/reference/countries","customerContactIndicator":"YES","addressStatus":"B","taxAddressType":"/v1.0.0/reference/lookups?virtualTableName=IRS.ADDRESS.TYPE","addressPurpose":"CTC","extensions":{}}},"responses":{"200":"UsCustomerSecondaryAddressResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"DELETE","path":"/party/us/customers/secondaryAddresses/{addressReference}","fullPath":"/api/v4.0.0/party/us/customers/secondaryAddresses/{addressReference}","operationId":"deleteUsCustomerSecondaryAddress","name":"Remove customer's secondary address information","summary":"Remove customer's secondary address","tags":["RETAIL"],"parameters":[{"name":"addressReference","in":"path","type":"string","required":true,"description":"Reference Id of address record"},{"name":"payload","in":"body","type":"object","required":false,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}}},"responses":{"200":"UsCustomerSecondaryAddressResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"POST","path":"/party/us/customers/{customerId}/secondaryAddresses","fullPath":"/api/v4.0.0/party/us/customers/{customerId}/secondaryAddresses","operationId":"createUsCustomerSecondaryAddress","name":"Add new customer address information","summary":"Create secondary address","tags":["RETAIL"],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"Identifier of the customer"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"addressLine1":"string","addressLine2":"string","shortName":"string","name":"string","city":"string","stateId":"/v1.0.0/reference/us/states","countyId":"/v1.0.0/reference/us/states/{stateId}/counties","zipCode":0.0,"zipPlusFour":0.0,"country":"/v1.0.0/reference/countries","customerContactIndicator":"YES","addressStatus":"B","taxAddressType":"/v1.0.0/reference/lookups?virtualTableName=IRS.ADDRESS.TYPE","addressPurpose":"CTC","extensions":{}}},"responses":{"200":"UsCustomerSecondaryAddressResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"POST","path":"/party/us/customers/corporates","fullPath":"/api/v4.0.0/party/us/customers/corporates","operationId":"createUsCorporateCustomer","name":"Allows creation of a corporate customer","summary":"Create corporate customer","tags":["RETAIL"],"parameters":[{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"idDocument":[{}],"PreviousIdentification":[{}],"communication":[{}],"communicationDevices":[{}],"officePhoneNumbers":[{}],"faxIds":[{}],"riskClass":[{}],"overrideReason":[{}],"crProfileType":[{}],"otherOfficers":[{}],"overrideDetails":[{}],"inputter":[{}],"dateTime":[{}],"customerName":"string","customerNameAdditional":"string"}},"responses":{"200":"UsCorporateCustomerResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"POST","path":"/party/us/customers/individuals","fullPath":"/api/v4.0.0/party/us/customers/individuals","operationId":"createUsIndividualCustomer","name":"Allows creation of an individual customer","summary":"Create individual customer","tags":["RETAIL"],"parameters":[{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"idDocument":[{}],"employment":[{}],"creditScore":[{}],"PreviousIdentification":[{}],"residenceInfo":[{}],"communication":[{}],"communicationDevices":[{}],"officePhoneNumbers":[{}],"faxIds":[{}],"riskClass":[{}],"overrideReason":[{}],"crProfileType":[{}],"otherOfficers":[{}],"overrideDetails":[{}],"inputter":[{}]}},"responses":{"200":"UsIndividualCustomerResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/party/us/customer/{customerId}/addressPreferences","fullPath":"/api/v4.0.0/party/us/customer/{customerId}/addressPreferences","operationId":"getAddressPreferences","name":"Retrieves seasonal address preferences set for the customer. Provides the address carrier and the duration for which an address should be used as the primary address","summary":"Seasonal address details","tags":["RETAIL"],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"Identifier of the customer"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"AddressPreferencesResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"POST","path":"/party/us/customer/{customerId}/addressPreferences","fullPath":"/api/v4.0.0/party/us/customer/{customerId}/addressPreferences","operationId":"createAddressPreference","name":"Allows capturing alternate address for a customer to be used for mails during specific periods each year","summary":"Create alternate address ","tags":["RETAIL"],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"Identifier of the customer"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"alternateaddressperiod":[{}],"carrier":"string","defaultCarrier":"string","extensions":{}}},"responses":{"200":"AddressPreferenceResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/party/us/customer/{customerId}/addressPreferences","fullPath":"/api/v4.0.0/party/us/customer/{customerId}/addressPreferences","operationId":"updateAddressPreference","name":"Updates alternate address information for a customer","summary":"Update alternate address","tags":["RETAIL"],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"Identifier of the customer"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"alternateaddressperiod":[{}],"carrier":"string","defaultCarrier":"string","extensions":{}}},"responses":{"200":"AddressPreferenceResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/party/us/customers/{customerId}/beneficiaries","fullPath":"/api/v4.0.0/party/us/customers/{customerId}/beneficiaries","operationId":"getUsBeneficiary","name":"Retrieve list of beneficiaries created for a customer to perform account transfer, bill payments or wires. Information can be retrieved using customerId, debitAccountId, beneficiaryNickName, accountType etc,.","summary":"Retrieve beneficiary information for a customer","tags":["RETAIL"],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"Identifier of the customer"},{"name":"beneficiaryInstituteName","in":"query","type":"string","required":false,"description":"Indicates the name of financial institution where the beneficiary account is held"},{"name":"beneficiaryAccountId","in":"query","type":"string","required":false,"description":"Unique account identifier of the beneficiary account number."},{"name":"beneficiaryNickName","in":"query","type":"string","required":false,"description":"Nickname of the beneficiary"},{"name":"accountWithBankSortCode","in":"query","type":"string","required":false,"description":"Bank sort code details with account"},{"name":"accountType","in":"query","type":"string","required":false,"description":"Groups the products based on their type, eg, Checking, Savings, CD etc,."},{"name":"beneficiaryCustomerId","in":"query","type":"string","required":false,"description":"Identifies the Customer who is to be the ultimate receiver of the funds transferred by the sending bank when this Beneficiary is not a bank."},{"name":"beneficiaryId","in":"query","type":"string","required":false,"description":"Indicates the reference of the financial institution that allows access to the beneficiary information"},{"name":"transactionType","in":"query","type":"string","required":false,"description":"Identifies the transaction type applicable to the transaction being processed, i.e. outward or inward payment. For example: ACPX, OTPX etc."},{"name":"preferredPaymentProduct","in":"query","type":"string","required":false,"description":"Preferred payment product can be specified for Beneficiary. This will be used for defaulting the payment product for specific beneficiary. "},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"UsBeneficiaryResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"POST","path":"/party/us/customers/{customerId}/beneficiaries","fullPath":"/api/v4.0.0/party/us/customers/{customerId}/beneficiaries","operationId":"createUsBeneficiary","name":"Create a beneficiary for account transfers or bill payment","summary":"Create an ACH beneficiary","tags":["RETAIL"],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"Identifier of the customer"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"beneficiaryAccountId":"string","beneficiaryNickName":"string","accountWithBankSortCode":"string","accountType":"CHECKING","beneficiaryCustomerId":"string","paymentDetails":"string","beneficiaryOtherIdType":"ORGANISATION","beneficiaryOtherId":"string","preferredPaymentProduct":"string","recordStatus":"string","currNo":"string","inputter":"string","dateTime":"2024-01-01","authoriser":"string","deptCode":"string"}},"responses":{"200":"UsBeneficiaryResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/party/us/customers/beneficiaries/{beneficiaryId}","fullPath":"/api/v4.0.0/party/us/customers/beneficiaries/{beneficiaryId}","operationId":"updateUsBeneficiary","name":"Update beneficiary created for account transfers or bill payment","summary":"Update ACH beneficiary","tags":["RETAIL"],"parameters":[{"name":"beneficiaryId","in":"path","type":"string","required":true,"description":"Indicates the reference of the financial institution that allows access to the beneficiary information"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"beneficiaryAccountId":"string","beneficiaryNickName":"string","accountWithBankSortCode":"string","accountType":"CHECKING","beneficiaryCustomerId":"string","paymentDetails":"string","beneficiaryOtherIdType":"ORGANISATION","beneficiaryOtherId":"string","preferredPaymentProduct":"string","recordStatus":"string","currNo":"string","inputter":"string","dateTime":"2024-01-01","authoriser":"string","deptCode":"string"}},"responses":{"200":"UsBeneficiaryResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"POST","path":"/party/us/customers/{customerId}/beneficiaries/wires","fullPath":"/api/v4.0.0/party/us/customers/{customerId}/beneficiaries/wires","operationId":"createUsWiresBeneficiary","name":"Create beneficiary information for generating a wire transfer","summary":"Creates beneficiary for wire transfers","tags":["RETAIL"],"parameters":[{"name":"customerId","in":"path","type":"number","required":true,"description":"Identifier of the customer"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"beneficiaryNickNames":[{}],"beneficiaryPaymentCountryId":"string","beneficiaryAccountId":"string","accountWithBankSortCode":"string","accountType":"@ref:reference-us-sortcodes-services","beneficiaryInstituteName":"string","beneficiaryInstituteBranchName":"string","beneficiaryInstituteAddressLine1":"string","beneficiaryInstituteAddressLine2":"string","beneficiaryInstituteAddressLine3":0.0,"beneficiaryInstituteCountryCode":"string","beneficiaryCustomerId":"string","beneficiaryShortName":"string","beneficiaryAddressLine1":"string","beneficiaryAddressLine2":"string"}},"responses":{"200":"UsWiresBeneficiaryResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/party/us/customers/beneficiaries/{beneficiaryId}/wires","fullPath":"/api/v4.0.0/party/us/customers/beneficiaries/{beneficiaryId}/wires","operationId":"updateUsWiresBeneficiary","name":"Updates routing number, bank details or the payee details of a beneficiary set up for wire transfers","summary":"Updates existing wire payment beneficiary","tags":["RETAIL"],"parameters":[{"name":"beneficiaryId","in":"path","type":"string","required":true,"description":"Indicates the reference of the financial institution that allows access to the beneficiary information"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"beneficiaryNickNames":[{}],"beneficiaryPaymentCountryId":"string","beneficiaryAccountId":"string","accountWithBankSortCode":"string","accountType":"@ref:reference-us-sortcodes-services","beneficiaryInstituteName":"string","beneficiaryInstituteBranchName":"string","beneficiaryInstituteAddressLine1":"string","beneficiaryInstituteAddressLine2":"string","beneficiaryInstituteAddressLine3":0.0,"beneficiaryInstituteCountryCode":"string","beneficiaryCustomerId":"string","beneficiaryShortName":"string","beneficiaryAddressLine1":"string","beneficiaryAddressLine2":"string"}},"responses":{"200":"UsWiresBeneficiaryResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/party/us/customers/deliveryPreferences/{customerId}","fullPath":"/api/v4.0.0/party/us/customers/deliveryPreferences/{customerId}","operationId":"getUsDeliveryPreference","name":"Retrieves all available mail addresses for a customer along with information on the purpose of the address (Primary, office, etc,.), internal address reference.","summary":"Retrieves all available mail addresses for a customer along with information on the purpose of the address (Primary, office, etc,.), internal address reference.","tags":["RETAIL"],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"UsDeliveryPreferenceResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}}]},{"key":"party-us-customerservice-v4.1.0","title":"US Model Bank Customer management","version":"v4.1.0","description":"The customer service API allows to create, update and modify customer, contact details, address and beneficiary. Separate URIs are available for corporate and individual customers to update or retrieve specific information like address, secondary address, credit score, KYC, relation, beneficial owne","endpointCount":31,"endpoints":[{"method":"GET","path":"/party/us/customers","fullPath":"/api/v4.1.0/party/us/customers","operationId":"searchUsCustomer","name":"Search and retrieve customer information based on customer name, date of birth, date of incorporation, SSN or TIN, and mobile number","summary":"Search customer","tags":["RETAIL"],"parameters":[{"name":"customerId","in":"query","type":"string","required":false,"description":"Identifier of the customer"},{"name":"customerName","in":"query","type":"string","required":false,"description":"Indicates the name of the customer. Originator is the party who requests the payment cancellation."},{"name":"taxId","in":"query","type":"string","required":false,"description":"Holds the Customer's TAX/SSN Id."},{"name":"dateOfBirth","in":"query","type":"string","required":false,"description":"The date of birth of an individual customer"},{"name":"mobileNumber","in":"query","type":"string","required":false,"description":"Mobile number of the customer"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"UsCustomerResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/party/us/customers/{customerId}/corporates","fullPath":"/api/v4.1.0/party/us/customers/{customerId}/corporates","operationId":"getUsCorporateCustomer","name":"Retrieves corporate customer information. Unless there is a specific set of information to be updated for which a separate APIs exists, this generic API can be used where all available information can be retrieved.","summary":"Retrieve corporate customer information","tags":["RETAIL"],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"Identifier of the customer"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"UsCorporateCustomerResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/party/us/customers/{customerId}/corporates","fullPath":"/api/v4.1.0/party/us/customers/{customerId}/corporates","operationId":"updateUsCorporateCustomer","name":"Updates corporate customer information. Unless there is a specific set of information to be updated for which a separate URIs exists, this generic URI can be used where all available information can be updated","summary":"Update corporate customer information","tags":["RETAIL"],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"Identifier of the customer"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"idDocument":[{}],"relationships":[{}],"relationship":[{}],"PreviousIdentification":[{}],"communication":[{}],"riskClass":[{}],"overrideReason":[{}],"crProfileType":[{}],"otherOfficers":[{}],"overrideDetails":[{}],"inputter":[{}],"dateTime":[{}],"customerName":"string","customerNameAdditional":"string","shortName":"string"}},"responses":{"200":"UsCorporateCustomerResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/party/us/customers/{customerId}/individuals","fullPath":"/api/v4.1.0/party/us/customers/{customerId}/individuals","operationId":"getUsIndividualCustomer","name":"Retrieves individual customer information. Unless there is a specific set of information to be updated for which a separate URIs exists, this generic URI can be used where all available information for an individual customer can be retrieved.","summary":"Retrieve individual customer information","tags":["RETAIL"],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"Identifier of the customer"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"UsIndividualCustomerResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/party/us/customers/{customerId}/individuals","fullPath":"/api/v4.1.0/party/us/customers/{customerId}/individuals","operationId":"updateUsIndividualCustomer","name":"Updates individual customer information. Unless there is a specific set of information to be updated for which a separate URIs exists, this generic URI can be used where all information for an individual customer can be updated.","summary":"Update individual customer information","tags":["RETAIL"],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"Identifier of the customer"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"idDocument":[{}],"employment":[{}],"creditScore":[{}],"relationships":[{}],"relation":[{}],"PreviousIdentification":[{}],"residenceInfo":[{}],"communication":[{}],"riskClass":[{}],"overrideReason":[{}],"crProfileType":[{}],"otherOfficers":[{}],"overrideDetails":[{}],"inputter":[{}],"dateTime":[{}]}},"responses":{"200":"UsIndividualCustomerResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/party/us/customers/{customerId}/contacts","fullPath":"/api/v4.1.0/party/us/customers/{customerId}/contacts","operationId":"getUsCustomerAddresslist","name":"Retrieves all available mail addresses for a customer along with information on the purpose of the address(Primary, office, etc,.), internal address reference. ","summary":"Retrieve customer mailing addresses","tags":["RETAIL"],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"UsCustomerAddresslistResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/party/us/customers/{customerId}/contacts","fullPath":"/api/v4.1.0/party/us/customers/{customerId}/contacts","operationId":"createUsCustomerContactDetail","name":"Create or update customer phone, office phone, mobile, email or fax numbers and the consent for sharing contact information with financial institute's marketing partners.","summary":"Create or update customer contact and consent information","tags":["RETAIL"],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":""},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"contactDetails":[{}],"consentDetails":[{}],"customercontactflag":"string","extensions":{}}},"responses":{"200":"UsCustomerContactDetailResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/party/us/customers/{customerId}/scores","fullPath":"/api/v4.1.0/party/us/customers/{customerId}/scores","operationId":"getUsCustomerCreditscore","name":"Retrieve customer's credit score information received from credit agencies.","summary":"Retrieve customer credit scores","tags":["RETAIL"],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"Identifier of the customer"},{"name":"agencyId","in":"query","type":"string","required":false,"description":"Name of the agency that provided the credit score. Allowed values can be retrieved through getEbLookups for virtualTableName CREDIT.BUREAU"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"UsCustomerCreditscoreResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/party/us/customers/{customerId}/agencies/{agencyId}/scores","fullPath":"/api/v4.1.0/party/us/customers/{customerId}/agencies/{agencyId}/scores","operationId":"getUsCustomerCreditscoreByAgency","name":"Retrieves the credit score information available for a customer from the specific reporting agency provided in the URI.","summary":"Retrieve customer credit score by agency","tags":["RETAIL"],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"Identifier of the customer"},{"name":"agencyId","in":"path","type":"string","required":true,"description":"Name of the agency that provided the credit score. Allowed values can be retrieved through getEbLookups for virtualTableName CREDIT.BUREAU"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"UsCustomerCreditscoreByAgencyResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/party/us/customers/{customerId}/documents","fullPath":"/api/v4.1.0/party/us/customers/{customerId}/documents","operationId":"searchUsDocuments","name":"Search documents available for customer identification. Provides information on document reference, status, validity, issuer details, and version information.","summary":"Search customer documents","tags":["RETAIL"],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"Identifier of the customer"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"UsDocumentsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/party/us/customers/{customerId}/kyc","fullPath":"/api/v4.1.0/party/us/customers/{customerId}/kyc","operationId":"getUsCustomerKycandTax","name":"Retrieves KYC and tax information for a customer","summary":"Retrieve customer KYC and tax information","tags":["RETAIL"],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"Identifier of the customer"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"UsCustomerKycandTaxResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/party/us/customers/{customerId}/kyc","fullPath":"/api/v4.1.0/party/us/customers/{customerId}/kyc","operationId":"updateUsCustomerKycandTax","name":"Allows update to KYC and tax information for a customer","summary":"Update customer KYC and tax information","tags":["RETAIL"],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"Identifier of the customer"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"riskClass":[{}],"introducer":"string","contactDate":"2024-01-01","kycRelationship":"string","kycLastReviewDate":"2024-01-01","amlCheck":"NULL","amlResult":"NULL","amlLastResultDate":"2024-01-01","manualRiskClass":"string","overrideReason":"string","isKycComplete":"YES","taxCertificationType":"/v1.0.0/reference/lookups?virtualTableName=TAX.CERT.TYPE","foreignTin":"string","taxCertificationDate":"2024-01-01","reasonForMissingFtin":"/v1.0.0/reference/lookups?virtualTableName=FTIN.MIS.REASON"}},"responses":{"200":"UsCustomerKycandTaxResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/party/us/customers/{customerId}/primaryAddresses","fullPath":"/api/v4.1.0/party/us/customers/{customerId}/primaryAddresses","operationId":"getUsCustomerPrimaryAddress","name":"Retrieve customer primary address","summary":"Retrieve customer primary address","tags":["RETAIL"],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"Identifier of the customer"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"UsCustomerPrimaryAddressResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/party/us/customers/{customerId}/primaryAddresses","fullPath":"/api/v4.1.0/party/us/customers/{customerId}/primaryAddresses","operationId":"updateUsCustomerPrimaryAddress","name":"Update customer primary address","summary":"Update customer primary address","tags":["RETAIL"],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"Identifier of the customer"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"overrideDetails":[{}],"inputter":[{}],"dateTime":[{}],"addressLine1":"string","addressLine2":"string","city":"string","stateId":"/v1.0.0/reference/us/states","countyId":"/v1.0.0/reference/us/states/{stateId}/counties","zipCode":0.0,"zipPlusFour":0.0,"country":"/v1.0.0/reference/countries","addressStatus":"B","addressLocation":"string","addressPurpose":"CTC","recordStatus":"string"}},"responses":{"200":"UsCustomerPrimaryAddressResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/party/us/customers/{customerId}/relations","fullPath":"/api/v4.1.0/party/us/customers/{customerId}/relations","operationId":"updateUsCustomerRelation","name":"Update relationship information for an individual customer or update beneficial ownership details for a corporate customer","summary":"Update customer relation","tags":["RETAIL"],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"Identifier of the customer"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"relationships":[{}],"relationship":[{}],"ownershipRuleId":"/v1.0.0/reference/us/beneficialOwnerTypes","noOwnerGt25Percent":"YES","otherOwnersLt25PercentFlag":"YES","certifierName":"string","certifierTitle":"string","additionalTitle":"string","certificationDate":"2024-01-01","extensions":{}}},"responses":{"200":"UsCustomerRelationResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/party/us/customers/secondaryAddresses/{addressReference}","fullPath":"/api/v4.1.0/party/us/customers/secondaryAddresses/{addressReference}","operationId":"updateUsCustomerSecondaryAddress","name":"Update existing address information for the customer.","summary":"Update secondary address","tags":["RETAIL"],"parameters":[{"name":"addressReference","in":"path","type":"string","required":true,"description":"Reference Id of address record"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"addressLine1":"string","addressLine2":"string","shortName":"string","city":"string","stateId":"/v1.0.0/reference/us/states","countyId":"/v1.0.0/reference/us/states/{stateId}/counties","zipCode":0.0,"zipPlusFour":0.0,"country":"/v1.0.0/reference/countries","customerContactIndicator":"YES","addressStatus":"B","taxAddressType":"/v1.0.0/reference/lookups?virtualTableName=IRS.ADDRESS.TYPE","addressPurpose":"CTC","extensions":{}}},"responses":{"200":"UsCustomerSecondaryAddressResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"DELETE","path":"/party/us/customers/secondaryAddresses/{addressReference}","fullPath":"/api/v4.1.0/party/us/customers/secondaryAddresses/{addressReference}","operationId":"deleteUsCustomerSecondaryAddress","name":"Remove customer's secondary address information","summary":"Remove customer's secondary address","tags":["RETAIL"],"parameters":[{"name":"addressReference","in":"path","type":"string","required":true,"description":"Reference Id of address record"},{"name":"payload","in":"body","type":"object","required":false,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}}},"responses":{"200":"UsCustomerSecondaryAddressResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"POST","path":"/party/us/customers/{customerId}/secondaryAddresses","fullPath":"/api/v4.1.0/party/us/customers/{customerId}/secondaryAddresses","operationId":"createUsCustomerSecondaryAddress","name":"Add new customer address information","summary":"Create secondary address","tags":["RETAIL"],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"Identifier of the customer"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"addressLine1":"string","addressLine2":"string","shortName":"string","name":"string","city":"string","stateId":"/v1.0.0/reference/us/states","countyId":"/v1.0.0/reference/us/states/{stateId}/counties","zipCode":0.0,"zipPlusFour":0.0,"country":"/v1.0.0/reference/countries","customerContactIndicator":"YES","addressStatus":"B","taxAddressType":"/v1.0.0/reference/lookups?virtualTableName=IRS.ADDRESS.TYPE","addressPurpose":"CTC","extensions":{}}},"responses":{"200":"UsCustomerSecondaryAddressResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"POST","path":"/party/us/customers/corporates","fullPath":"/api/v4.1.0/party/us/customers/corporates","operationId":"createUsCorporateCustomer","name":"Allows creation of a corporate customer","summary":"Create corporate customer","tags":["RETAIL"],"parameters":[{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"idDocument":[{}],"relationships":[{}],"relationship":[{}],"PreviousIdentification":[{}],"communication":[{}],"communicationDevices":[{}],"officePhoneNumbers":[{}],"faxIds":[{}],"riskClass":[{}],"overrideReason":[{}],"crProfileType":[{}],"otherOfficers":[{}],"overrideDetails":[{}],"inputter":[{}],"dateTime":[{}]}},"responses":{"200":"UsCorporateCustomerResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"POST","path":"/party/us/customers/individuals","fullPath":"/api/v4.1.0/party/us/customers/individuals","operationId":"createUsIndividualCustomer","name":"Allows creation of an individual customer","summary":"Create individual customer","tags":["RETAIL"],"parameters":[{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"idDocument":[{}],"employment":[{}],"creditScore":[{}],"relationships":[{}],"relation":[{}],"PreviousIdentification":[{}],"residenceInfo":[{}],"communication":[{}],"communicationDevices":[{}],"officePhoneNumbers":[{}],"faxIds":[{}],"riskClass":[{}],"overrideReason":[{}],"crProfileType":[{}],"otherOfficers":[{}]}},"responses":{"200":"UsIndividualCustomerResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/party/us/customer/{customerId}/addressPreferences","fullPath":"/api/v4.1.0/party/us/customer/{customerId}/addressPreferences","operationId":"getAddressPreferences","name":"Retrieves seasonal address preferences set for the customer. Provides the address carrier and the duration for which an address should be used as the primary address","summary":"Seasonal address details","tags":["RETAIL"],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"Identifier of the customer"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"AddressPreferencesResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"POST","path":"/party/us/customer/{customerId}/addressPreferences","fullPath":"/api/v4.1.0/party/us/customer/{customerId}/addressPreferences","operationId":"createAddressPreference","name":"Allows capturing alternate address for a customer to be used for mails during specific periods each year","summary":"Create alternate address ","tags":["RETAIL"],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"Identifier of the customer"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"alternateaddressperiod":[{}],"carrier":"string","defaultCarrier":"string","extensions":{}}},"responses":{"200":"AddressPreferenceResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/party/us/customer/{customerId}/addressPreferences","fullPath":"/api/v4.1.0/party/us/customer/{customerId}/addressPreferences","operationId":"updateAddressPreference","name":"Updates alternate address information for a customer","summary":"Update alternate address","tags":["RETAIL"],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"Identifier of the customer"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"alternateaddressperiod":[{}],"carrier":"string","defaultCarrier":"string","extensions":{}}},"responses":{"200":"AddressPreferenceResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/party/us/customers/{customerId}/beneficiaries","fullPath":"/api/v4.1.0/party/us/customers/{customerId}/beneficiaries","operationId":"getUsBeneficiary","name":"Retrieve list of beneficiaries created for a customer to perform account transfer, bill payments or wires. Information can be retrieved using customerId, debitAccountId, beneficiaryNickName, accountType etc,.","summary":"Retrieve beneficiary information for a customer","tags":["RETAIL"],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"Identifier of the customer"},{"name":"beneficiaryInstituteName","in":"query","type":"string","required":false,"description":"Indicates the name of financial institution where the beneficiary account is held"},{"name":"beneficiaryAccountId","in":"query","type":"string","required":false,"description":"Unique account identifier of the beneficiary account number."},{"name":"beneficiaryNickName","in":"query","type":"string","required":false,"description":"Nickname of the beneficiary"},{"name":"accountWithBankSortCode","in":"query","type":"string","required":false,"description":"Bank sort code details with account"},{"name":"accountType","in":"query","type":"string","required":false,"description":"Groups the products based on their type, eg, Checking, Savings, CD etc,."},{"name":"beneficiaryCustomerId","in":"query","type":"string","required":false,"description":"Identifies the Customer who is to be the ultimate receiver of the funds transferred by the sending bank when this Beneficiary is not a bank."},{"name":"beneficiaryId","in":"query","type":"string","required":false,"description":"Indicates the reference of the financial institution that allows access to the beneficiary information"},{"name":"transactionType","in":"query","type":"string","required":false,"description":"Identifies the transaction type applicable to the transaction being processed, i.e. outward or inward payment. For example: ACPX, OTPX etc."},{"name":"preferredPaymentProduct","in":"query","type":"string","required":false,"description":"Preferred payment product can be specified for Beneficiary. This will be used for defaulting the payment product for specific beneficiary. "},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"UsBeneficiaryResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"POST","path":"/party/us/customers/{customerId}/beneficiaries","fullPath":"/api/v4.1.0/party/us/customers/{customerId}/beneficiaries","operationId":"createUsBeneficiary","name":"Create a beneficiary for account transfers or bill payment","summary":"Create an ACH beneficiary","tags":["RETAIL"],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"Identifier of the customer"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"beneficiaryAccountId":"string","beneficiaryNickName":"string","accountWithBankSortCode":"string","accountType":"CHECKING","beneficiaryCustomerId":"string","paymentDetails":"string","beneficiaryOtherIdType":"ORGANISATION","beneficiaryOtherId":"string","preferredPaymentProduct":"string","recordStatus":"string","currNo":"string","inputter":"string","dateTime":"2024-01-01","authoriser":"string","deptCode":"string"}},"responses":{"200":"UsBeneficiaryResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/party/us/customers/beneficiaries/{beneficiaryId}","fullPath":"/api/v4.1.0/party/us/customers/beneficiaries/{beneficiaryId}","operationId":"updateUsBeneficiary","name":"Update beneficiary created for account transfers or bill payment","summary":"Update ACH beneficiary","tags":["RETAIL"],"parameters":[{"name":"beneficiaryId","in":"path","type":"string","required":true,"description":"Indicates the reference of the financial institution that allows access to the beneficiary information"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"beneficiaryAccountId":"string","beneficiaryNickName":"string","accountWithBankSortCode":"string","accountType":"CHECKING","beneficiaryCustomerId":"string","paymentDetails":"string","beneficiaryOtherIdType":"ORGANISATION","beneficiaryOtherId":"string","preferredPaymentProduct":"string","recordStatus":"string","currNo":"string","inputter":"string","dateTime":"2024-01-01","authoriser":"string","deptCode":"string"}},"responses":{"200":"UsBeneficiaryResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"POST","path":"/party/us/customers/{customerId}/beneficiaries/wires","fullPath":"/api/v4.1.0/party/us/customers/{customerId}/beneficiaries/wires","operationId":"createUsWiresBeneficiary","name":"Create beneficiary information for generating a wire transfer","summary":"Creates beneficiary for wire transfers","tags":["RETAIL"],"parameters":[{"name":"customerId","in":"path","type":"number","required":true,"description":"Identifier of the customer"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"beneficiaryNickNames":[{}],"beneficiaryPaymentCountryId":"string","beneficiaryAccountId":"string","accountWithBankSortCode":"string","accountType":"@ref:reference-us-sortcodes-services","beneficiaryInstituteName":"string","beneficiaryInstituteBranchName":"string","beneficiaryInstituteAddressLine1":"string","beneficiaryInstituteAddressLine2":"string","beneficiaryInstituteAddressLine3":0.0,"beneficiaryInstituteCountryCode":"string","beneficiaryCustomerId":"string","beneficiaryShortName":"string","beneficiaryAddressLine1":"string","beneficiaryAddressLine2":"string"}},"responses":{"200":"UsWiresBeneficiaryResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/party/us/customers/beneficiaries/{beneficiaryId}/wires","fullPath":"/api/v4.1.0/party/us/customers/beneficiaries/{beneficiaryId}/wires","operationId":"updateUsWiresBeneficiary","name":"Updates routing number, bank details or the payee details of a beneficiary set up for wire transfers","summary":"Updates existing wire payment beneficiary","tags":["RETAIL"],"parameters":[{"name":"beneficiaryId","in":"path","type":"string","required":true,"description":"Indicates the reference of the financial institution that allows access to the beneficiary information"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"beneficiaryNickNames":[{}],"beneficiaryPaymentCountryId":"string","beneficiaryAccountId":"string","accountWithBankSortCode":"string","accountType":"@ref:reference-us-sortcodes-services","beneficiaryInstituteName":"string","beneficiaryInstituteBranchName":"string","beneficiaryInstituteAddressLine1":"string","beneficiaryInstituteAddressLine2":"string","beneficiaryInstituteAddressLine3":0.0,"beneficiaryInstituteCountryCode":"string","beneficiaryCustomerId":"string","beneficiaryShortName":"string","beneficiaryAddressLine1":"string","beneficiaryAddressLine2":"string"}},"responses":{"200":"UsWiresBeneficiaryResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/party/us/customers/{customerId}/deliveryPreferences","fullPath":"/api/v4.1.0/party/us/customers/{customerId}/deliveryPreferences","operationId":"getUsDeliveryPreference","name":"Retrieves all available mail addresses for a customer along with information on the purpose of the address (Primary, office, etc,.), internal address reference.","summary":"Retrieves all available mail addresses for a customer along with information on the purpose of the address (Primary, office, etc,.), internal address reference.","tags":["RETAIL"],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"UsDeliveryPreferenceResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/party/us/customers/{customerId}/kyc/dueDiligence","fullPath":"/api/v4.1.0/party/us/customers/{customerId}/kyc/dueDiligence","operationId":"getUsPoliticalCustomer","name":"Retrieves the list of customers who are exposed as politically person.","summary":"Retrieves the list of customers who are exposed as politically person.","tags":["RETAIL"],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"Identifier of the customer"},{"name":"customerName","in":"query","type":"string","required":false,"description":"Indicates the name of the customer. Originator is the party who requests the payment cancellation."},{"name":"dateOfBirth","in":"query","type":"string","required":false,"description":"The date of birth of an individual customer"},{"name":"mobileNumber","in":"query","type":"string","required":false,"description":"Mobile number of the customer"},{"name":"emailId","in":"query","type":"string","required":false,"description":"Contains the email identifier of the customer"},{"name":"taxId","in":"query","type":"string","required":false,"description":"Holds the Customer's TAX/SSN Id."},{"name":"customerStatus","in":"query","type":"string","required":false,"description":"The internal bank status of a customer"},{"name":"accountOfficer","in":"query","type":"string","required":false,"description":"Identifier of Department Account Officer"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"UsPoliticalCustomerResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"PUT","path":"/party/us/customers/{customerId}/kyc/dueDiligence","fullPath":"/api/v4.1.0/party/us/customers/{customerId}/kyc/dueDiligence","operationId":"updateUsceddKyc","name":"Update enhanced due diligence and political information about any \"Customer\" which the bank has dealings.","summary":"Update enhanced due diligence and political information about any \"Customer\" which the bank has dealings.","tags":["RETAIL"],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"Identifier of the customer"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"accountTypes":[{}],"incomingTransactionCountries":[{}],"outgoingTransactionCountries":[{}],"lendingLinesOfCreditCountries":[{}],"lettersOfCreditCountries":[{}],"exportCreditCountries":[{}],"cashCollateralLoanCountries":[{}],"sourceOfFunds":[{}],"overrideDetails":[{}],"inputter":[{}],"dateTime":[{}],"politicallyExposedForeignPerson":"string","politicalPosition":"string","kycExempt":"string","kycExemptReason":"string"}},"responses":{"200":"UsceddKycResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}}]},{"key":"party-us-customerservice-v5.0.0","title":"US Model Bank Customer management","version":"v5.0.0","description":"The customer service API allows to create, update and modify customer, contact details, address and beneficiary. Separate URIs are available for corporate and individual customers to update or retrieve specific information like address, secondary address, credit score, KYC, relation, beneficial owne","endpointCount":34,"endpoints":[{"method":"GET","path":"/party/us/customers","fullPath":"/api/v5.0.0/party/us/customers","operationId":"searchUsCustomer","name":"Search and retrieve customer information based on customer name, date of birth, date of incorporation, SSN or TIN, and mobile number","summary":"Search customer","tags":["RETAIL"],"parameters":[{"name":"customerId","in":"query","type":"string","required":false,"description":"Identifier of the customer"},{"name":"customerName","in":"query","type":"string","required":false,"description":"Indicates the name of the customer. Originator is the party who requests the payment cancellation."},{"name":"taxId","in":"query","type":"string","required":false,"description":"Holds the Customer's TAX/SSN Id."},{"name":"dateOfBirth","in":"query","type":"string","required":false,"description":"The date of birth of an individual customer"},{"name":"mobileNumber","in":"query","type":"string","required":false,"description":"Mobile number of the customer"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"UsCustomerResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/party/us/customers/{customerId}/contacts","fullPath":"/api/v5.0.0/party/us/customers/{customerId}/contacts","operationId":"getUsCustomerAddresslist","name":"Retrieves all available mail addresses for a customer along with information on the purpose of the address(Primary, office, etc,.), internal address reference. ","summary":"Retrieve customer mailing addresses","tags":["RETAIL"],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"UsCustomerAddresslistResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/party/us/customers/{customerId}/contacts","fullPath":"/api/v5.0.0/party/us/customers/{customerId}/contacts","operationId":"createUsCustomerContactDetail","name":"Create or update customer phone, office phone, mobile, email or fax numbers and the consent for sharing contact information with financial institute's marketing partners.","summary":"Create or update customer contact and consent information","tags":["RETAIL"],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":""},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"contactDetails":[{}],"consentDetails":[{}],"customercontactflag":"string","extensions":{}}},"responses":{"200":"UsCustomerContactDetailResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/party/us/customers/{customerId}/scores","fullPath":"/api/v5.0.0/party/us/customers/{customerId}/scores","operationId":"getUsCustomerCreditscore","name":"Retrieve customer's credit score information received from credit agencies.","summary":"Retrieve customer credit scores","tags":["RETAIL"],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"Identifier of the customer"},{"name":"agencyId","in":"query","type":"string","required":false,"description":"Name of the agency that provided the credit score. Allowed values can be retrieved through getEbLookups for virtualTableName CREDIT.BUREAU"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"UsCustomerCreditscoreResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/party/us/customers/{customerId}/agencies/{agencyId}/scores","fullPath":"/api/v5.0.0/party/us/customers/{customerId}/agencies/{agencyId}/scores","operationId":"getUsCustomerCreditscoreByAgency","name":"Retrieves the credit score information available for a customer from the specific reporting agency provided in the URI.","summary":"Retrieve customer credit score by agency","tags":["RETAIL"],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"Identifier of the customer"},{"name":"agencyId","in":"path","type":"string","required":true,"description":"Name of the agency that provided the credit score. Allowed values can be retrieved through getEbLookups for virtualTableName CREDIT.BUREAU"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"UsCustomerCreditscoreByAgencyResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/party/us/customers/{customerId}/documents","fullPath":"/api/v5.0.0/party/us/customers/{customerId}/documents","operationId":"searchUsDocuments","name":"Search documents available for customer identification. Provides information on document reference, status, validity, issuer details, and version information.","summary":"Search customer documents","tags":["RETAIL"],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"Identifier of the customer"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"UsDocumentsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/party/us/customers/{customerId}/kyc","fullPath":"/api/v5.0.0/party/us/customers/{customerId}/kyc","operationId":"getUsCustomerKycandTax","name":"Retrieves KYC and tax information for a customer","summary":"Retrieve customer KYC and tax information","tags":["RETAIL"],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"Identifier of the customer"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"UsCustomerKycandTaxResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/party/us/customers/{customerId}/kyc","fullPath":"/api/v5.0.0/party/us/customers/{customerId}/kyc","operationId":"updateUsCustomerKycandTax","name":"Allows update to KYC and tax information for a customer","summary":"Update customer KYC and tax information","tags":["RETAIL"],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"Identifier of the customer"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"riskClass":[{}],"introducer":"string","contactDate":"2024-01-01","kycRelationship":"string","kycLastReviewDate":"2024-01-01","amlCheck":"NULL","amlResult":"NULL","amlLastResultDate":"2024-01-01","manualRiskClass":"string","overrideReason":"string","isKycComplete":"YES","taxCertificationType":"/v1.0.0/reference/lookups?virtualTableName=TAX.CERT.TYPE","foreignTin":"string","taxCertificationDate":"2024-01-01","reasonForMissingFtin":"/v1.0.0/reference/lookups?virtualTableName=FTIN.MIS.REASON"}},"responses":{"200":"UsCustomerKycandTaxResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/party/us/customers/{customerId}/primaryAddresses","fullPath":"/api/v5.0.0/party/us/customers/{customerId}/primaryAddresses","operationId":"getUsCustomerPrimaryAddress","name":"Retrieve customer primary address","summary":"Retrieve customer primary address","tags":["RETAIL"],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"Identifier of the customer"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"UsCustomerPrimaryAddressResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/party/us/customers/{customerId}/primaryAddresses","fullPath":"/api/v5.0.0/party/us/customers/{customerId}/primaryAddresses","operationId":"updateUsCustomerPrimaryAddress","name":"Update customer primary address","summary":"Update customer primary address","tags":["RETAIL"],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"Identifier of the customer"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"overrideDetails":[{}],"inputter":[{}],"dateTime":[{}],"addressLine1":"string","addressLine2":"string","city":"string","stateId":"/v1.0.0/reference/us/states","countyId":"/v1.0.0/reference/us/states/{stateId}/counties","zipCode":0.0,"zipPlusFour":0.0,"country":"/v1.0.0/reference/countries","addressStatus":"B","addressLocation":"string","addressPurpose":"CTC","recordStatus":"string"}},"responses":{"200":"UsCustomerPrimaryAddressResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/party/us/customers/secondaryAddresses/{addressReference}","fullPath":"/api/v5.0.0/party/us/customers/secondaryAddresses/{addressReference}","operationId":"updateUsCustomerSecondaryAddress","name":"Update existing address information for the customer.","summary":"Update secondary address","tags":["RETAIL"],"parameters":[{"name":"addressReference","in":"path","type":"string","required":true,"description":"Reference Id of address record"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"addressLine1":"string","addressLine2":"string","shortName":"string","city":"string","stateId":"/v1.0.0/reference/us/states","countyId":"/v1.0.0/reference/us/states/{stateId}/counties","zipCode":0.0,"zipPlusFour":0.0,"country":"/v1.0.0/reference/countries","customerContactIndicator":"YES","addressStatus":"B","taxAddressType":"/v1.0.0/reference/lookups?virtualTableName=IRS.ADDRESS.TYPE","addressPurpose":"CTC","extensions":{}}},"responses":{"200":"UsCustomerSecondaryAddressResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"DELETE","path":"/party/us/customers/secondaryAddresses/{addressReference}","fullPath":"/api/v5.0.0/party/us/customers/secondaryAddresses/{addressReference}","operationId":"deleteUsCustomerSecondaryAddress","name":"Remove customer's secondary address information","summary":"Remove customer's secondary address","tags":["RETAIL"],"parameters":[{"name":"addressReference","in":"path","type":"string","required":true,"description":"Reference Id of address record"},{"name":"payload","in":"body","type":"object","required":false,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}}},"responses":{"200":"UsCustomerSecondaryAddressResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"POST","path":"/party/us/customers/{customerId}/secondaryAddresses","fullPath":"/api/v5.0.0/party/us/customers/{customerId}/secondaryAddresses","operationId":"createUsCustomerSecondaryAddress","name":"Add new customer address information","summary":"Create secondary address","tags":["RETAIL"],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"Identifier of the customer"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"addressLine1":"string","addressLine2":"string","shortName":"string","name":"string","city":"string","stateId":"/v1.0.0/reference/us/states","countyId":"/v1.0.0/reference/us/states/{stateId}/counties","zipCode":0.0,"zipPlusFour":0.0,"country":"/v1.0.0/reference/countries","customerContactIndicator":"YES","addressStatus":"B","taxAddressType":"/v1.0.0/reference/lookups?virtualTableName=IRS.ADDRESS.TYPE","addressPurpose":"CTC","extensions":{}}},"responses":{"200":"UsCustomerSecondaryAddressResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/party/us/customer/{customerId}/addressPreferences","fullPath":"/api/v5.0.0/party/us/customer/{customerId}/addressPreferences","operationId":"getAddressPreferences","name":"Retrieves seasonal address preferences set for the customer. Provides the address carrier and the duration for which an address should be used as the primary address","summary":"Seasonal address details","tags":["RETAIL"],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"Identifier of the customer"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"AddressPreferencesResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"POST","path":"/party/us/customer/{customerId}/addressPreferences","fullPath":"/api/v5.0.0/party/us/customer/{customerId}/addressPreferences","operationId":"createAddressPreference","name":"Allows capturing alternate address for a customer to be used for mails during specific periods each year","summary":"Create alternate address ","tags":["RETAIL"],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"Identifier of the customer"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"alternateaddressperiod":[{}],"carrier":"string","defaultCarrier":"string","extensions":{}}},"responses":{"200":"AddressPreferenceResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/party/us/customer/{customerId}/addressPreferences","fullPath":"/api/v5.0.0/party/us/customer/{customerId}/addressPreferences","operationId":"updateAddressPreference","name":"Updates alternate address information for a customer","summary":"Update alternate address","tags":["RETAIL"],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"Identifier of the customer"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"alternateaddressperiod":[{}],"carrier":"string","defaultCarrier":"string","extensions":{}}},"responses":{"200":"AddressPreferenceResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/party/us/customers/{customerId}/beneficiaries","fullPath":"/api/v5.0.0/party/us/customers/{customerId}/beneficiaries","operationId":"getUsBeneficiary","name":"Retrieve list of beneficiaries created for a customer to perform account transfer, bill payments or wires. Information can be retrieved using customerId, debitAccountId, beneficiaryNickName, accountType etc,.","summary":"Retrieve beneficiary information for a customer","tags":["RETAIL"],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"Identifier of the customer"},{"name":"beneficiaryInstituteName","in":"query","type":"string","required":false,"description":"Indicates the name of financial institution where the beneficiary account is held"},{"name":"beneficiaryAccountId","in":"query","type":"string","required":false,"description":"Unique account identifier of the beneficiary account number."},{"name":"beneficiaryNickName","in":"query","type":"string","required":false,"description":"Nickname of the beneficiary"},{"name":"accountWithBankSortCode","in":"query","type":"string","required":false,"description":"Bank sort code details with account"},{"name":"accountType","in":"query","type":"string","required":false,"description":"Groups the products based on their type, eg, Checking, Savings, CD etc,."},{"name":"beneficiaryCustomerId","in":"query","type":"string","required":false,"description":"Identifies the Customer who is to be the ultimate receiver of the funds transferred by the sending bank when this Beneficiary is not a bank."},{"name":"beneficiaryId","in":"query","type":"string","required":false,"description":"Indicates the reference of the financial institution that allows access to the beneficiary information"},{"name":"transactionType","in":"query","type":"string","required":false,"description":"Identifies the transaction type applicable to the transaction being processed, i.e. outward or inward payment. For example: ACPX, OTPX etc."},{"name":"preferredPaymentProduct","in":"query","type":"string","required":false,"description":"Preferred payment product can be specified for Beneficiary. This will be used for defaulting the payment product for specific beneficiary. "},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"UsBeneficiaryResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"POST","path":"/party/us/customers/{customerId}/beneficiaries","fullPath":"/api/v5.0.0/party/us/customers/{customerId}/beneficiaries","operationId":"createUsBeneficiary","name":"Create a beneficiary for account transfers or bill payment","summary":"Create an ACH beneficiary","tags":["RETAIL"],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"Identifier of the customer"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"beneficiaryAccountId":"string","beneficiaryNickName":"string","accountWithBankSortCode":"string","accountType":"CHECKING","beneficiaryCustomerId":"string","paymentDetails":"string","beneficiaryOtherIdType":"ORGANISATION","beneficiaryOtherId":"string","preferredPaymentProduct":"string","recordStatus":"string","currNo":"string","inputter":"string","dateTime":"2024-01-01","authoriser":"string","deptCode":"string"}},"responses":{"200":"UsBeneficiaryResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/party/us/customers/beneficiaries/{beneficiaryId}","fullPath":"/api/v5.0.0/party/us/customers/beneficiaries/{beneficiaryId}","operationId":"updateUsBeneficiary","name":"Update beneficiary created for account transfers or bill payment","summary":"Update ACH beneficiary","tags":["RETAIL"],"parameters":[{"name":"beneficiaryId","in":"path","type":"string","required":true,"description":"Indicates the reference of the financial institution that allows access to the beneficiary information"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"beneficiaryAccountId":"string","beneficiaryNickName":"string","accountWithBankSortCode":"string","accountType":"CHECKING","beneficiaryCustomerId":"string","paymentDetails":"string","beneficiaryOtherIdType":"ORGANISATION","beneficiaryOtherId":"string","preferredPaymentProduct":"string","recordStatus":"string","currNo":"string","inputter":"string","dateTime":"2024-01-01","authoriser":"string","deptCode":"string"}},"responses":{"200":"UsBeneficiaryResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"POST","path":"/party/us/customers/{customerId}/beneficiaries/wires","fullPath":"/api/v5.0.0/party/us/customers/{customerId}/beneficiaries/wires","operationId":"createUsWiresBeneficiary","name":"Create beneficiary information for generating a wire transfer","summary":"Creates beneficiary for wire transfers","tags":["RETAIL"],"parameters":[{"name":"customerId","in":"path","type":"number","required":true,"description":"Identifier of the customer"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"beneficiaryNickNames":[{}],"beneficiaryPaymentCountryId":"string","beneficiaryAccountId":"string","accountWithBankSortCode":"string","accountType":"@ref:reference-us-sortcodes-services","beneficiaryInstituteName":"string","beneficiaryInstituteBranchName":"string","beneficiaryInstituteAddressLine1":"string","beneficiaryInstituteAddressLine2":"string","beneficiaryInstituteAddressLine3":0.0,"beneficiaryInstituteCountryCode":"string","beneficiaryCustomerId":"string","beneficiaryShortName":"string","beneficiaryAddressLine1":"string","beneficiaryAddressLine2":"string"}},"responses":{"200":"UsWiresBeneficiaryResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/party/us/customers/beneficiaries/{beneficiaryId}/wires","fullPath":"/api/v5.0.0/party/us/customers/beneficiaries/{beneficiaryId}/wires","operationId":"updateUsWiresBeneficiary","name":"Updates routing number, bank details or the payee details of a beneficiary set up for wire transfers","summary":"Updates existing wire payment beneficiary","tags":["RETAIL"],"parameters":[{"name":"beneficiaryId","in":"path","type":"string","required":true,"description":"Indicates the reference of the financial institution that allows access to the beneficiary information"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"beneficiaryNickNames":[{}],"beneficiaryPaymentCountryId":"string","beneficiaryAccountId":"string","accountWithBankSortCode":"string","accountType":"@ref:reference-us-sortcodes-services","beneficiaryInstituteName":"string","beneficiaryInstituteBranchName":"string","beneficiaryInstituteAddressLine1":"string","beneficiaryInstituteAddressLine2":"string","beneficiaryInstituteAddressLine3":0.0,"beneficiaryInstituteCountryCode":"string","beneficiaryCustomerId":"string","beneficiaryShortName":"string","beneficiaryAddressLine1":"string","beneficiaryAddressLine2":"string"}},"responses":{"200":"UsWiresBeneficiaryResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/party/us/customers/{customerId}/deliveryPreferences","fullPath":"/api/v5.0.0/party/us/customers/{customerId}/deliveryPreferences","operationId":"getUsDeliveryPreference","name":"Retrieves all available mail addresses for a customer along with information on the purpose of the address (Primary, office, etc,.), internal address reference.","summary":"Retrieves all available mail addresses for a customer along with information on the purpose of the address (Primary, office, etc,.), internal address reference.","tags":["RETAIL"],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"UsDeliveryPreferenceResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/party/us/customers/{customerId}/kyc/dueDiligence","fullPath":"/api/v5.0.0/party/us/customers/{customerId}/kyc/dueDiligence","operationId":"getUsPoliticalCustomer","name":"Retrieves the list of customers who are exposed as politically person.","summary":"Retrieves the list of customers who are exposed as politically person.","tags":["RETAIL"],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"Identifier of the customer"},{"name":"customerName","in":"query","type":"string","required":false,"description":"Indicates the name of the customer. Originator is the party who requests the payment cancellation."},{"name":"dateOfBirth","in":"query","type":"string","required":false,"description":"The date of birth of an individual customer"},{"name":"mobileNumber","in":"query","type":"string","required":false,"description":"Mobile number of the customer"},{"name":"emailId","in":"query","type":"string","required":false,"description":"Contains the email identifier of the customer"},{"name":"taxId","in":"query","type":"string","required":false,"description":"Holds the Customer's TAX/SSN Id."},{"name":"customerStatus","in":"query","type":"string","required":false,"description":"The internal bank status of a customer"},{"name":"accountOfficer","in":"query","type":"string","required":false,"description":"Identifier of Department Account Officer"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"UsPoliticalCustomerResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"PUT","path":"/party/us/customers/{customerId}/kyc/dueDiligence","fullPath":"/api/v5.0.0/party/us/customers/{customerId}/kyc/dueDiligence","operationId":"updateUsceddKyc","name":"Update enhanced due diligence and political information about any \"Customer\" which the bank has dealings.","summary":"Update enhanced due diligence and political information about any \"Customer\" which the bank has dealings.","tags":["RETAIL"],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"Identifier of the customer"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"accountTypes":[{}],"incomingTransactionCountries":[{}],"outgoingTransactionCountries":[{}],"lendingLinesOfCreditCountries":[{}],"lettersOfCreditCountries":[{}],"exportCreditCountries":[{}],"cashCollateralLoanCountries":[{}],"sourceOfFunds":[{}],"overrideDetails":[{}],"inputter":[{}],"dateTime":[{}],"politicallyExposedForeignPerson":"string","politicalPosition":"string","kycExempt":"string","kycExemptReason":"string"}},"responses":{"200":"UsceddKycResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/party/us/customers/{customerId}/corporates","fullPath":"/api/v5.0.0/party/us/customers/{customerId}/corporates","operationId":"getUsCorporateCustomer","name":"Retrieves corporate customer information. Unless there is a specific set of information to be updated for which a separate APIs exists, this generic API can be used where all available information can be retrieved.","summary":"Retrieve corporate customer information","tags":["RETAIL"],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"Identifier of the customer"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"UsCorporateCustomerResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/party/us/customers/{customerId}/corporates","fullPath":"/api/v5.0.0/party/us/customers/{customerId}/corporates","operationId":"updateUsCorporateCustomer","name":"Updates corporate customer information. Unless there is a specific set of information to be updated for which a separate URIs exists, this generic URI can be used where all available information can be updated","summary":"Update corporate customer information","tags":["RETAIL"],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"Identifier of the customer"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"idDocument":[{}],"PreviousIdentification":[{}],"communication":[{}],"riskClass":[{}],"overrideReason":[{}],"crProfileType":[{}],"otherOfficers":[{}],"overrideDetails":[{}],"inputter":[{}],"dateTime":[{}],"customerName":"string","customerNameAdditional":"string","shortName":"string","birthIncorpDate":"string","taxId":"string"}},"responses":{"200":"UsCorporateCustomerResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/party/us/customers/{customerId}/individuals","fullPath":"/api/v5.0.0/party/us/customers/{customerId}/individuals","operationId":"getUsIndividualCustomer","name":"Retrieves individual customer information. Unless there is a specific set of information to be updated for which a separate URIs exists, this generic URI can be used where all available information for an individual customer can be retrieved.","summary":"Retrieve individual customer information","tags":["RETAIL"],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"Identifier of the customer"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"UsIndividualCustomerResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/party/us/customers/{customerId}/individuals","fullPath":"/api/v5.0.0/party/us/customers/{customerId}/individuals","operationId":"updateUsIndividualCustomer","name":"Updates individual customer information. Unless there is a specific set of information to be updated for which a separate URIs exists, this generic URI can be used where all information for an individual customer can be updated.","summary":"Update individual customer information","tags":["RETAIL"],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"Identifier of the customer"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"idDocument":[{}],"employment":[{}],"creditScore":[{}],"PreviousIdentification":[{}],"residenceInfo":[{}],"communication":[{}],"riskClass":[{}],"overrideReason":[{}],"crProfileType":[{}],"otherOfficers":[{}],"overrideDetails":[{}],"inputter":[{}],"dateTime":[{}],"title":"string","givenName":"string"}},"responses":{"200":"UsIndividualCustomerResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"POST","path":"/party/us/customers/corporates","fullPath":"/api/v5.0.0/party/us/customers/corporates","operationId":"createUsCorporateCustomer","name":"Allows creation of a corporate customer","summary":"Create corporate customer","tags":["RETAIL"],"parameters":[{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"idDocument":[{}],"PreviousIdentification":[{}],"communication":[{}],"communicationDevices":[{}],"officePhoneNumbers":[{}],"faxIds":[{}],"riskClass":[{}],"overrideReason":[{}],"crProfileType":[{}],"otherOfficers":[{}],"overrideDetails":[{}],"inputter":[{}],"dateTime":[{}],"customerName":"string","customerNameAdditional":"string"}},"responses":{"200":"UsCorporateCustomerResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"POST","path":"/party/us/customers/individuals","fullPath":"/api/v5.0.0/party/us/customers/individuals","operationId":"createUsIndividualCustomer","name":"Allows creation of an individual customer","summary":"Create individual customer","tags":["RETAIL"],"parameters":[{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"idDocument":[{}],"employment":[{}],"creditScore":[{}],"PreviousIdentification":[{}],"residenceInfo":[{}],"communication":[{}],"communicationDevices":[{}],"officePhoneNumbers":[{}],"faxIds":[{}],"riskClass":[{}],"overrideReason":[{}],"crProfileType":[{}],"otherOfficers":[{}],"overrideDetails":[{}],"inputter":[{}]}},"responses":{"200":"UsIndividualCustomerResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"POST","path":"/party/us/customers/corporates/relations","fullPath":"/api/v5.0.0/party/us/customers/corporates/relations","operationId":"createUsCorporateCustomerRelation","name":"Allows to create a new party relationship for the corporate customer","summary":"Allows to create a new party relationship for the corporate customer","tags":["RETAIL"],"parameters":[{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"partyDisplayNames":[{}],"partyRelationships":[{}],"customerGroupId":"string","ownershipRuleId":"/v1.0.0/reference/us/beneficialOwnerTypes","noOwnerGt25Percent":"YES","otherOwnersLt25PercentFlag":"YES","certifierName":"string","certifierTitle":"string","additionalTitle":"string","certificationDate":"string","customerContactIndicator":"YES","extensions":{}}},"responses":{"200":"UsCorporateCustomerRelationResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"POST","path":"/party/us/customers/individuals/relations","fullPath":"/api/v5.0.0/party/us/customers/individuals/relations","operationId":"createUsIndividualCustomerRelation","name":"Allows to create a new party relationship for the individual customer","summary":"Allows to create a new party relationship for the individual customer","tags":["RETAIL"],"parameters":[{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"partyDisplayNames":[{}],"partyRelationships":[{}],"customerGroupId":"string","ownershipRuleId":"/v1.0.0/reference/us/beneficialOwnerTypes","noOwnerGt25Percent":"YES","otherOwnersLt25PercentFlag":"YES","certifierName":"string","certifierTitle":"string","additionalTitle":"string","certificationDate":"string","customerContactIndicator":"YES","extensions":{}}},"responses":{"200":"UsIndividualCustomerRelationResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/party/us/customers/relations/{relationId}","fullPath":"/api/v5.0.0/party/us/customers/relations/{relationId}","operationId":"updateUsCustomerRelation","name":"Allows to update the party relationship for the customer","summary":"Allows to update the party relationship for the customer","tags":["RETAIL"],"parameters":[{"name":"relationId","in":"path","type":"string","required":true,"description":""},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"partyDisplayNames":[{}],"partyRelationships":[{}],"customerGroupId":"string","ownershipRuleId":"/v1.0.0/reference/us/beneficialOwnerTypes","noOwnerGt25Percent":"YES","otherOwnersLt25PercentFlag":"YES","certifierName":"string","certifierTitle":"string","additionalTitle":"string","certificationDate":"string","customerContactIndicator":"YES","extensions":{}}},"responses":{"200":"UsCustomerRelationResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/party/us/customers/{customerId}/relations","fullPath":"/api/v5.0.0/party/us/customers/{customerId}/relations","operationId":"getUsCustomerRelation","name":"Retrieves the relationship details for a given customer","summary":"Retrieves the relationship details for a given customer","tags":["RETAIL"],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"Identifier of the customer"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"UsCustomerRelationResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}}]},{"key":"party-us-customerservice-v6.0.0","title":"US Model Bank Customer management","version":"v6.0.0","description":"The customer service API allows to create, update and modify customer, contact details, address and beneficiary. Separate URIs are available for corporate and individual customers to update or retrieve specific information like address, secondary address, credit score, KYC, relation, beneficial owne","endpointCount":36,"endpoints":[{"method":"GET","path":"/party/us/customers","fullPath":"/api/v6.0.0/party/us/customers","operationId":"searchUsCustomer","name":"Search and retrieve customer information based on customer name, date of birth, date of incorporation, SSN or TIN, and mobile number","summary":"Search customer","tags":["RETAIL"],"parameters":[{"name":"customerId","in":"query","type":"string","required":false,"description":"Identifier of the customer"},{"name":"customerName","in":"query","type":"string","required":false,"description":"Indicates the name of the customer. Originator is the party who requests the payment cancellation."},{"name":"taxId","in":"query","type":"string","required":false,"description":"Holds the Customer's TAX/SSN Id."},{"name":"dateOfBirth","in":"query","type":"string","required":false,"description":"The date of birth of an individual customer"},{"name":"mobileNumber","in":"query","type":"string","required":false,"description":"Mobile number of the customer"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"UsCustomerResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/party/us/customers/{customerId}/scores","fullPath":"/api/v6.0.0/party/us/customers/{customerId}/scores","operationId":"getUsCustomerCreditscore","name":"Retrieve customer's credit score information received from credit agencies.","summary":"Retrieve customer credit scores","tags":["RETAIL"],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"Identifier of the customer"},{"name":"agencyId","in":"query","type":"string","required":false,"description":"Name of the agency that provided the credit score. Allowed values can be retrieved through getEbLookups for virtualTableName CREDIT.BUREAU"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"UsCustomerCreditscoreResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/party/us/customers/{customerId}/agencies/{agencyId}/scores","fullPath":"/api/v6.0.0/party/us/customers/{customerId}/agencies/{agencyId}/scores","operationId":"getUsCustomerCreditscoreByAgency","name":"Retrieves the credit score information available for a customer from the specific reporting agency provided in the URI.","summary":"Retrieve customer credit score by agency","tags":["RETAIL"],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"Identifier of the customer"},{"name":"agencyId","in":"path","type":"string","required":true,"description":"Name of the agency that provided the credit score. Allowed values can be retrieved through getEbLookups for virtualTableName CREDIT.BUREAU"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"UsCustomerCreditscoreByAgencyResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/party/us/customers/{customerId}/documents","fullPath":"/api/v6.0.0/party/us/customers/{customerId}/documents","operationId":"searchUsDocuments","name":"Search documents available for customer identification. Provides information on document reference, status, validity, issuer details, and version information.","summary":"Search customer documents","tags":["RETAIL"],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"Identifier of the customer"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"UsDocumentsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/party/us/customers/{customerId}/kyc","fullPath":"/api/v6.0.0/party/us/customers/{customerId}/kyc","operationId":"getUsCustomerKycandTax","name":"Retrieves KYC and tax information for a customer","summary":"Retrieve customer KYC and tax information","tags":["RETAIL"],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"Identifier of the customer"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"UsCustomerKycandTaxResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/party/us/customers/{customerId}/kyc","fullPath":"/api/v6.0.0/party/us/customers/{customerId}/kyc","operationId":"updateUsCustomerKycandTax","name":"Allows update to KYC and tax information for a customer","summary":"Update customer KYC and tax information","tags":["RETAIL"],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"Identifier of the customer"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"riskClass":[{}],"introducer":"string","contactDate":"2024-01-01","kycRelationship":"string","kycLastReviewDate":"2024-01-01","amlCheck":"NULL","amlResult":"NULL","amlLastResultDate":"2024-01-01","manualRiskClass":"string","overrideReason":"string","isKycComplete":"YES","taxCertificationType":"/v1.0.0/reference/lookups?virtualTableName=TAX.CERT.TYPE","foreignTin":"string","taxCertificationDate":"2024-01-01","reasonForMissingFtin":"/v1.0.0/reference/lookups?virtualTableName=FTIN.MIS.REASON"}},"responses":{"200":"UsCustomerKycandTaxResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/party/us/customers/{customerId}/primaryAddresses","fullPath":"/api/v6.0.0/party/us/customers/{customerId}/primaryAddresses","operationId":"getUsCustomerPrimaryAddress","name":"Retrieve customer primary address","summary":"Retrieve customer primary address","tags":["RETAIL"],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"Identifier of the customer"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"UsCustomerPrimaryAddressResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/party/us/customers/{customerId}/primaryAddresses","fullPath":"/api/v6.0.0/party/us/customers/{customerId}/primaryAddresses","operationId":"updateUsCustomerPrimaryAddress","name":"Update customer primary address","summary":"Update customer primary address","tags":["RETAIL"],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"Identifier of the customer"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"overrideDetails":[{}],"inputter":[{}],"dateTime":[{}],"addressLine1":"string","addressLine2":"string","city":"string","stateId":"/v1.0.0/reference/us/states","countyId":"/v1.0.0/reference/us/states/{stateId}/counties","zipCode":0.0,"zipPlusFour":0.0,"country":"/v1.0.0/reference/countries","addressStatus":"B","addressLocation":"string","addressPurpose":"CTC","recordStatus":"string"}},"responses":{"200":"UsCustomerPrimaryAddressResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/party/us/customers/secondaryAddresses/{addressReference}","fullPath":"/api/v6.0.0/party/us/customers/secondaryAddresses/{addressReference}","operationId":"updateUsCustomerSecondaryAddress","name":"Update existing address information for the customer.","summary":"Update secondary address","tags":["RETAIL"],"parameters":[{"name":"addressReference","in":"path","type":"string","required":true,"description":"Reference Id of address record"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"addressLine1":"string","addressLine2":"string","shortName":"string","city":"string","stateId":"/v1.0.0/reference/us/states","countyId":"/v1.0.0/reference/us/states/{stateId}/counties","zipCode":0.0,"zipPlusFour":0.0,"country":"/v1.0.0/reference/countries","customerContactIndicator":"YES","addressStatus":"B","taxAddressType":"/v1.0.0/reference/lookups?virtualTableName=IRS.ADDRESS.TYPE","addressPurpose":"CTC","extensions":{}}},"responses":{"200":"UsCustomerSecondaryAddressResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"DELETE","path":"/party/us/customers/secondaryAddresses/{addressReference}","fullPath":"/api/v6.0.0/party/us/customers/secondaryAddresses/{addressReference}","operationId":"deleteUsCustomerSecondaryAddress","name":"Remove customer's secondary address information","summary":"Remove customer's secondary address","tags":["RETAIL"],"parameters":[{"name":"addressReference","in":"path","type":"string","required":true,"description":"Reference Id of address record"},{"name":"payload","in":"body","type":"object","required":false,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}}},"responses":{"200":"UsCustomerSecondaryAddressResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"POST","path":"/party/us/customers/{customerId}/secondaryAddresses","fullPath":"/api/v6.0.0/party/us/customers/{customerId}/secondaryAddresses","operationId":"createUsCustomerSecondaryAddress","name":"Add new customer address information","summary":"Create secondary address","tags":["RETAIL"],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"Identifier of the customer"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"addressLine1":"string","addressLine2":"string","shortName":"string","name":"string","city":"string","stateId":"/v1.0.0/reference/us/states","countyId":"/v1.0.0/reference/us/states/{stateId}/counties","zipCode":0.0,"zipPlusFour":0.0,"country":"/v1.0.0/reference/countries","customerContactIndicator":"YES","addressStatus":"B","taxAddressType":"/v1.0.0/reference/lookups?virtualTableName=IRS.ADDRESS.TYPE","addressPurpose":"CTC","extensions":{}}},"responses":{"200":"UsCustomerSecondaryAddressResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/party/us/customer/{customerId}/addressPreferences","fullPath":"/api/v6.0.0/party/us/customer/{customerId}/addressPreferences","operationId":"getAddressPreferences","name":"Retrieves seasonal address preferences set for the customer. Provides the address carrier and the duration for which an address should be used as the primary address","summary":"Seasonal address details","tags":["RETAIL"],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"Identifier of the customer"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"AddressPreferencesResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"POST","path":"/party/us/customer/{customerId}/addressPreferences","fullPath":"/api/v6.0.0/party/us/customer/{customerId}/addressPreferences","operationId":"createAddressPreference","name":"Allows capturing alternate address for a customer to be used for mails during specific periods each year","summary":"Create alternate address ","tags":["RETAIL"],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"Identifier of the customer"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"alternateaddressperiod":[{}],"carrier":"string","defaultCarrier":"string","extensions":{}}},"responses":{"200":"AddressPreferenceResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/party/us/customer/{customerId}/addressPreferences","fullPath":"/api/v6.0.0/party/us/customer/{customerId}/addressPreferences","operationId":"updateAddressPreference","name":"Updates alternate address information for a customer","summary":"Update alternate address","tags":["RETAIL"],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"Identifier of the customer"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"alternateaddressperiod":[{}],"carrier":"string","defaultCarrier":"string","extensions":{}}},"responses":{"200":"AddressPreferenceResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/party/us/customers/{customerId}/beneficiaries","fullPath":"/api/v6.0.0/party/us/customers/{customerId}/beneficiaries","operationId":"getUsBeneficiary","name":"Retrieve list of beneficiaries created for a customer to perform account transfer, bill payments or wires. Information can be retrieved using customer id, debit account id, beneficiary nickname, account type, etc","summary":"Retrieve beneficiary information for a customer","tags":["RETAIL"],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"Identifier of the customer"},{"name":"beneficiaryInstituteName","in":"query","type":"string","required":false,"description":"Indicates the name of financial institution where the beneficiary account is held"},{"name":"beneficiaryAccountId","in":"query","type":"string","required":false,"description":"Unique account identifier of the beneficiary account number."},{"name":"beneficiaryNickName","in":"query","type":"string","required":false,"description":"Nickname of the beneficiary"},{"name":"accountWithBankSortCode","in":"query","type":"string","required":false,"description":"Bank sort code details with account"},{"name":"accountType","in":"query","type":"string","required":false,"description":"Groups the products based on their type, eg, Checking, Savings, CD etc,."},{"name":"beneficiaryCustomerId","in":"query","type":"string","required":false,"description":"Identifies the Customer who is to be the ultimate receiver of the funds transferred by the sending bank when this Beneficiary is not a bank."},{"name":"beneficiaryId","in":"query","type":"string","required":false,"description":"Indicates the reference of the financial institution that allows access to the beneficiary information"},{"name":"transactionType","in":"query","type":"string","required":false,"description":"Identifies the transaction type applicable to the transaction being processed, i.e. outward or inward payment. For example: ACPX, OTPX etc."},{"name":"preferredPaymentProduct","in":"query","type":"string","required":false,"description":"Preferred payment product can be specified for Beneficiary. This will be used for defaulting the payment product for specific beneficiary. "},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"UsBeneficiaryResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"POST","path":"/party/us/customers/{customerId}/beneficiaries","fullPath":"/api/v6.0.0/party/us/customers/{customerId}/beneficiaries","operationId":"createUsBeneficiary","name":"Create a beneficiary for account transfers or bill payment","summary":"Create an ACH beneficiary","tags":["RETAIL"],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"Identifier of the customer"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"beneficiaryAccountId":"string","beneficiaryNickName":"string","accountWithBankSortCode":"string","accountType":"CHECKING","beneficiaryCustomerId":"string","paymentDetails":"string","beneficiaryOtherIdType":"ORGANISATION","beneficiaryOtherId":"string","preferredPaymentProduct":"string","recordStatus":"string","currNo":"string","inputter":"string","dateTime":"2024-01-01","authoriser":"string","deptCode":"string"}},"responses":{"200":"UsBeneficiaryResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/party/us/customers/beneficiaries/{beneficiaryId}","fullPath":"/api/v6.0.0/party/us/customers/beneficiaries/{beneficiaryId}","operationId":"updateUsBeneficiary","name":"Update beneficiary created for account transfers or bill payment","summary":"Update ACH beneficiary","tags":["RETAIL"],"parameters":[{"name":"beneficiaryId","in":"path","type":"string","required":true,"description":"Indicates the reference of the financial institution that allows access to the beneficiary information"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"beneficiaryAccountId":"string","beneficiaryNickName":"string","accountWithBankSortCode":"string","accountType":"CHECKING","beneficiaryCustomerId":"string","paymentDetails":"string","beneficiaryOtherIdType":"ORGANISATION","beneficiaryOtherId":"string","preferredPaymentProduct":"string","recordStatus":"string","currNo":"string","inputter":"string","dateTime":"2024-01-01","authoriser":"string","deptCode":"string"}},"responses":{"200":"UsBeneficiaryResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"POST","path":"/party/us/customers/{customerId}/beneficiaries/wires","fullPath":"/api/v6.0.0/party/us/customers/{customerId}/beneficiaries/wires","operationId":"createUsWiresBeneficiary","name":"Create beneficiary information for generating a wire transfer","summary":"Creates beneficiary for wire transfers","tags":["RETAIL"],"parameters":[{"name":"customerId","in":"path","type":"number","required":true,"description":"Identifier of the customer"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"beneficiaryNickNames":[{}],"beneficiaryPaymentCountryId":"string","beneficiaryAccountId":"string","accountWithBankSortCode":"string","accountType":"@ref:reference-us-sortcodes-services","beneficiaryInstituteName":"string","beneficiaryInstituteBranchName":"string","beneficiaryInstituteAddressLine1":"string","beneficiaryInstituteAddressLine2":"string","beneficiaryInstituteAddressLine3":0.0,"beneficiaryInstituteCountryCode":"string","beneficiaryCustomerId":"string","beneficiaryShortName":"string","beneficiaryAddressLine1":"string","beneficiaryAddressLine2":"string"}},"responses":{"200":"UsWiresBeneficiaryResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/party/us/customers/beneficiaries/{beneficiaryId}/wires","fullPath":"/api/v6.0.0/party/us/customers/beneficiaries/{beneficiaryId}/wires","operationId":"updateUsWiresBeneficiary","name":"Updates routing number, bank details or the payee details of a beneficiary set up for wire transfers","summary":"Updates existing wire payment beneficiary","tags":["RETAIL"],"parameters":[{"name":"beneficiaryId","in":"path","type":"string","required":true,"description":"Indicates the reference of the financial institution that allows access to the beneficiary information"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"beneficiaryNickNames":[{}],"beneficiaryPaymentCountryId":"string","beneficiaryAccountId":"string","accountWithBankSortCode":"string","accountType":"@ref:reference-us-sortcodes-services","beneficiaryInstituteName":"string","beneficiaryInstituteBranchName":"string","beneficiaryInstituteAddressLine1":"string","beneficiaryInstituteAddressLine2":"string","beneficiaryInstituteAddressLine3":0.0,"beneficiaryInstituteCountryCode":"string","beneficiaryCustomerId":"string","beneficiaryShortName":"string","beneficiaryAddressLine1":"string","beneficiaryAddressLine2":"string"}},"responses":{"200":"UsWiresBeneficiaryResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/party/us/customers/{customerId}/deliveryPreferences","fullPath":"/api/v6.0.0/party/us/customers/{customerId}/deliveryPreferences","operationId":"getUsDeliveryPreference","name":"Retrieves all available mail addresses for a customer along with information on the purpose of the address (primary, office, etc,.), internal address reference.","summary":"Retrieves all available mail addresses for a customer along with information on the purpose of the address (primary, office, etc,.), internal address reference.","tags":["RETAIL"],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"UsDeliveryPreferenceResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/party/us/customers/{customerId}/kyc/dueDiligence","fullPath":"/api/v6.0.0/party/us/customers/{customerId}/kyc/dueDiligence","operationId":"getUsPoliticalCustomer","name":"Retrieves the list of customers who are exposed as political person.","summary":"Retrieves the list of customers who are exposed as political person.","tags":["RETAIL"],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"Identifier of the customer"},{"name":"customerName","in":"query","type":"string","required":false,"description":"Indicates the name of the customer. Originator is the party who requests the payment cancellation."},{"name":"dateOfBirth","in":"query","type":"string","required":false,"description":"The date of birth of an individual customer"},{"name":"mobileNumber","in":"query","type":"string","required":false,"description":"Mobile number of the customer"},{"name":"emailId","in":"query","type":"string","required":false,"description":"Contains the email identifier of the customer"},{"name":"taxId","in":"query","type":"string","required":false,"description":"Holds the Customer's TAX/SSN Id."},{"name":"customerStatus","in":"query","type":"string","required":false,"description":"The internal bank status of a customer"},{"name":"accountOfficer","in":"query","type":"string","required":false,"description":"Identifier of Department Account Officer"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"UsPoliticalCustomerResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"PUT","path":"/party/us/customers/{customerId}/kyc/dueDiligence","fullPath":"/api/v6.0.0/party/us/customers/{customerId}/kyc/dueDiligence","operationId":"updateUsceddKyc","name":"Update enhanced due diligence and political information about any \"Customer\" which the bank has dealings.","summary":"Update enhanced due diligence and political information about any \"Customer\" which the bank has dealings.","tags":["RETAIL"],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"Identifier of the customer"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"accountTypes":[{}],"incomingTransactionCountries":[{}],"outgoingTransactionCountries":[{}],"lendingLinesOfCreditCountries":[{}],"lettersOfCreditCountries":[{}],"exportCreditCountries":[{}],"cashCollateralLoanCountries":[{}],"sourceOfFunds":[{}],"overrideDetails":[{}],"inputter":[{}],"dateTime":[{}],"politicallyExposedForeignPerson":"string","politicalPosition":"string","kycExempt":"string","kycExemptReason":"string"}},"responses":{"200":"UsceddKycResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/party/us/customers/{customerId}/corporates","fullPath":"/api/v6.0.0/party/us/customers/{customerId}/corporates","operationId":"getUsCorporateCustomer","name":"Retrieves corporate customer information. Unless there is a specific set of information to be updated for which a separate APIs exists, this generic API can be used where all available information can be retrieved.","summary":"Retrieve corporate customer information","tags":["RETAIL"],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"Identifier of the customer"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"UsCorporateCustomerResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/party/us/customers/{customerId}/corporates","fullPath":"/api/v6.0.0/party/us/customers/{customerId}/corporates","operationId":"updateUsCorporateCustomer","name":"Updates corporate customer information. Unless there is a specific set of information to be updated for which a separate URIs exists, this generic URI can be used where all available information can be updated","summary":"Update corporate customer information","tags":["RETAIL"],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"Identifier of the customer"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"idDocument":[{}],"PreviousIdentification":[{}],"communication":[{}],"riskClass":[{}],"overrideReason":[{}],"crProfileType":[{}],"otherOfficers":[{}],"overrideDetails":[{}],"inputter":[{}],"dateTime":[{}],"customerName":"string","customerNameAdditional":"string","shortName":"string","birthIncorpDate":"string","taxId":"string"}},"responses":{"200":"UsCorporateCustomerResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/party/us/customers/{customerId}/individuals","fullPath":"/api/v6.0.0/party/us/customers/{customerId}/individuals","operationId":"getUsIndividualCustomer","name":"Retrieves individual customer information. Unless there is a specific set of information to be updated for which a separate URIs exists, this generic URI can be used where all available information for an individual customer can be retrieved.","summary":"Retrieve individual customer information","tags":["RETAIL"],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"Identifier of the customer"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"UsIndividualCustomerResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/party/us/customers/{customerId}/individuals","fullPath":"/api/v6.0.0/party/us/customers/{customerId}/individuals","operationId":"updateUsIndividualCustomer","name":"Updates individual customer information. Unless there is a specific set of information to be updated for which a separate URIs exists, this generic URI can be used where all information for an individual customer can be updated.","summary":"Update individual customer information","tags":["RETAIL"],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"Identifier of the customer"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"idDocument":[{}],"employment":[{}],"creditScore":[{}],"PreviousIdentification":[{}],"residenceInfo":[{}],"communication":[{}],"riskClass":[{}],"overrideReason":[{}],"crProfileType":[{}],"otherOfficers":[{}],"overrideDetails":[{}],"inputter":[{}],"dateTime":[{}],"title":"string","givenName":"string"}},"responses":{"200":"UsIndividualCustomerResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"POST","path":"/party/us/customers/corporates","fullPath":"/api/v6.0.0/party/us/customers/corporates","operationId":"createUsCorporateCustomer","name":"Allows creation of a corporate customer","summary":"Create corporate customer","tags":["RETAIL"],"parameters":[{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"idDocument":[{}],"PreviousIdentification":[{}],"communication":[{}],"communicationDevices":[{}],"officePhoneNumbers":[{}],"faxIds":[{}],"riskClass":[{}],"overrideReason":[{}],"crProfileType":[{}],"otherOfficers":[{}],"overrideDetails":[{}],"inputter":[{}],"dateTime":[{}],"customerName":"string","customerNameAdditional":"string"}},"responses":{"200":"UsCorporateCustomerResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"POST","path":"/party/us/customers/individuals","fullPath":"/api/v6.0.0/party/us/customers/individuals","operationId":"createUsIndividualCustomer","name":"Allows creation of an individual customer","summary":"Create individual customer","tags":["RETAIL"],"parameters":[{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"idDocument":[{}],"employment":[{}],"creditScore":[{}],"PreviousIdentification":[{}],"residenceInfo":[{}],"communication":[{}],"communicationDevices":[{}],"officePhoneNumbers":[{}],"faxIds":[{}],"riskClass":[{}],"overrideReason":[{}],"crProfileType":[{}],"otherOfficers":[{}],"overrideDetails":[{}],"inputter":[{}]}},"responses":{"200":"UsIndividualCustomerResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"POST","path":"/party/us/customers/corporates/relations","fullPath":"/api/v6.0.0/party/us/customers/corporates/relations","operationId":"createUsCorporateCustomerRelation","name":"Allows to create a new party relationship for the corporate customer","summary":"Allows to create a new party relationship for the corporate customer","tags":["RETAIL"],"parameters":[{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"partyDisplayNames":[{}],"partyRelationships":[{}],"customerGroupId":"string","ownershipRuleId":"/v1.0.0/reference/us/beneficialOwnerTypes","noOwnerGt25Percent":"YES","otherOwnersLt25PercentFlag":"YES","certifierName":"string","certifierTitle":"string","additionalTitle":"string","certificationDate":"string","customerContactIndicator":"YES","extensions":{}}},"responses":{"200":"UsCorporateCustomerRelationResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"POST","path":"/party/us/customers/individuals/relations","fullPath":"/api/v6.0.0/party/us/customers/individuals/relations","operationId":"createUsIndividualCustomerRelation","name":"Allows to create a new party relationship for the individual customer","summary":"Allows to create a new party relationship for the individual customer","tags":["RETAIL"],"parameters":[{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"partyDisplayNames":[{}],"partyRelationships":[{}],"customerGroupId":"string","ownershipRuleId":"/v1.0.0/reference/us/beneficialOwnerTypes","noOwnerGt25Percent":"YES","otherOwnersLt25PercentFlag":"YES","certifierName":"string","certifierTitle":"string","additionalTitle":"string","certificationDate":"string","customerContactIndicator":"YES","extensions":{}}},"responses":{"200":"UsIndividualCustomerRelationResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/party/us/customers/relations/{relationId}","fullPath":"/api/v6.0.0/party/us/customers/relations/{relationId}","operationId":"updateUsCustomerRelation","name":"Allows to update the party relationship for the customer","summary":"Allows to update the party relationship for the customer","tags":["RETAIL"],"parameters":[{"name":"relationId","in":"path","type":"string","required":true,"description":""},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"partyDisplayNames":[{}],"partyRelationships":[{}],"customerGroupId":"string","ownershipRuleId":"/v1.0.0/reference/us/beneficialOwnerTypes","noOwnerGt25Percent":"YES","otherOwnersLt25PercentFlag":"YES","certifierName":"string","certifierTitle":"string","additionalTitle":"string","certificationDate":"string","customerContactIndicator":"YES","extensions":{}}},"responses":{"200":"UsCustomerRelationResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/party/us/customers/{customerId}/relations","fullPath":"/api/v6.0.0/party/us/customers/{customerId}/relations","operationId":"getUsCustomerRelation","name":"Retrieves the relationship details for a given customer","summary":"Retrieves the relationship details for a given customer","tags":["RETAIL"],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"Identifier of the customer"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"UsCustomerRelationResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/party/us/customers/{customerId}/contacts","fullPath":"/api/v6.0.0/party/us/customers/{customerId}/contacts","operationId":"getUsCustomerAddresslist","name":"Retrieves all available mail addresses for a customer along with information on the purpose of the address(primary, office, etc,.), internal address reference.","summary":"Retrieve customer mailing addresses","tags":["RETAIL"],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"UsCustomerAddresslistResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/party/us/customers/{customerId}/contacts","fullPath":"/api/v6.0.0/party/us/customers/{customerId}/contacts","operationId":"createUsCustomerContactDetail","name":"Create or update customer phone, office phone, mobile, email or fax numbers and the consent for sharing contact information with financial institute's marketing partners.","summary":"Create or update customer contact and consent information","tags":["RETAIL"],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":""},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"contactDetails":[{}],"customercontactflag":"string","extensions":{}}},"responses":{"200":"UsCustomerContactDetailResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/party/us/customers/contacts/{contactId}/consents","fullPath":"/api/v6.0.0/party/us/customers/contacts/{contactId}/consents","operationId":"getUsDeviceConsent","name":"Retrieve customer consent for the requested contact information.","summary":"Retrieve consent information for contacts.","tags":["RETAIL"],"parameters":[{"name":"contactId","in":"path","type":"string","required":true,"description":"Indicates the reference number/text for the contacting customer. Can be phone number, telephone, fax, email or mobile linked to a customer."},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"UsDeviceConsentResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"PUT","path":"/party/us/customers/contacts/{contactId}/consents","fullPath":"/api/v6.0.0/party/us/customers/contacts/{contactId}/consents","operationId":"updateUsDeviceConsent","name":"Update consent information like marketing consent, do not call and general consent. As part of consent, preferred time to call, consent log like the method how the consent was collected, the customer who gave the consent and the date when consent was received is also captured.","summary":"Update consent information for contact devices.","tags":["RETAIL"],"parameters":[{"name":"contactId","in":"path","type":"string","required":true,"description":""},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"consentDetails":[{}],"consentMethod":"/v1.0.0/reference/lookups?virtualTableName=TCPA.CONSENT.METHOD","consentParty":"string","consentDate":"2024-01-01","extensions":{}}},"responses":{"200":"UsDeviceConsentResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}}]},{"key":"party-us-customerservice-v6.1.0","title":"US Model Bank Customer management","version":"v6.1.0","description":"The customer service API allows to create, update and modify customer, contact details, address and beneficiary. Separate URIs are available for corporate and individual customers to update or retrieve specific information like address, secondary address, credit score, KYC, relation, beneficial owne","endpointCount":36,"endpoints":[{"method":"GET","path":"/party/us/customers","fullPath":"/api/v6.1.0/party/us/customers","operationId":"searchUsCustomer","name":"Search and retrieve customer information based on customer name, date of birth, date of incorporation, SSN or TIN, and mobile number","summary":"Search customer","tags":["RETAIL"],"parameters":[{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"UsCustomerResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/party/us/customers/{customerId}/scores","fullPath":"/api/v6.1.0/party/us/customers/{customerId}/scores","operationId":"getUsCustomerCreditscore","name":"Retrieve customer's credit score information received from credit agencies.","summary":"Retrieve customer credit scores","tags":["RETAIL"],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"Identifier of the customer"},{"name":"agencyId","in":"query","type":"string","required":false,"description":"Name of the agency that provided the credit score. Allowed values can be retrieved through getEbLookups for virtualTableName CREDIT.BUREAU"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"UsCustomerCreditscoreResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/party/us/customers/{customerId}/agencies/{agencyId}/scores","fullPath":"/api/v6.1.0/party/us/customers/{customerId}/agencies/{agencyId}/scores","operationId":"getUsCustomerCreditscoreByAgency","name":"Retrieves the credit score information available for a customer from the specific reporting agency provided in the URI.","summary":"Retrieve customer credit score by agency","tags":["RETAIL"],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"Identifier of the customer"},{"name":"agencyId","in":"path","type":"string","required":true,"description":"Name of the agency that provided the credit score. Allowed values can be retrieved through getEbLookups for virtualTableName CREDIT.BUREAU"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"UsCustomerCreditscoreByAgencyResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/party/us/customers/{customerId}/documents","fullPath":"/api/v6.1.0/party/us/customers/{customerId}/documents","operationId":"searchUsDocuments","name":"Search documents available for customer identification. Provides information on document reference, status, validity, issuer details, and version information.","summary":"Search customer documents","tags":["RETAIL"],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"Identifier of the customer"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"UsDocumentsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/party/us/customers/{customerId}/kyc","fullPath":"/api/v6.1.0/party/us/customers/{customerId}/kyc","operationId":"getUsCustomerKycandTax","name":"Retrieves KYC and tax information for a customer","summary":"Retrieve customer KYC and tax information","tags":["RETAIL"],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"Identifier of the customer"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"UsCustomerKycandTaxResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/party/us/customers/{customerId}/kyc","fullPath":"/api/v6.1.0/party/us/customers/{customerId}/kyc","operationId":"updateUsCustomerKycandTax","name":"Allows update to KYC and tax information for a customer","summary":"Update customer KYC and tax information","tags":["RETAIL"],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"Identifier of the customer"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"riskClass":[{}],"introducer":"string","contactDate":"2024-01-01","kycRelationship":"string","kycLastReviewDate":"2024-01-01","amlCheck":"NULL","amlResult":"NULL","amlLastResultDate":"2024-01-01","manualRiskClass":"string","overrideReason":"string","isKycComplete":"YES","taxCertificationType":"/v1.0.0/reference/lookups?virtualTableName=TAX.CERT.TYPE","foreignTin":"string","taxCertificationDate":"2024-01-01","reasonForMissingFtin":"/v1.0.0/reference/lookups?virtualTableName=FTIN.MIS.REASON"}},"responses":{"200":"UsCustomerKycandTaxResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/party/us/customers/{customerId}/primaryAddresses","fullPath":"/api/v6.1.0/party/us/customers/{customerId}/primaryAddresses","operationId":"getUsCustomerPrimaryAddress","name":"Retrieve customer primary address","summary":"Retrieve customer primary address","tags":["RETAIL"],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"Identifier of the customer"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"UsCustomerPrimaryAddressResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/party/us/customers/{customerId}/primaryAddresses","fullPath":"/api/v6.1.0/party/us/customers/{customerId}/primaryAddresses","operationId":"updateUsCustomerPrimaryAddress","name":"Update customer primary address","summary":"Update customer primary address","tags":["RETAIL"],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"Identifier of the customer"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"overrideDetails":[{}],"inputter":[{}],"dateTime":[{}],"addressLine1":"string","addressLine2":"string","city":"string","stateId":"/v1.0.0/reference/us/states","countyId":"/v1.0.0/reference/us/states/{stateId}/counties","zipCode":0.0,"zipPlusFour":0.0,"country":"/v1.0.0/reference/countries","addressStatus":"B","addressLocation":"string","addressPurpose":"CTC","recordStatus":"string"}},"responses":{"200":"UsCustomerPrimaryAddressResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/party/us/customers/secondaryAddresses/{addressReference}","fullPath":"/api/v6.1.0/party/us/customers/secondaryAddresses/{addressReference}","operationId":"updateUsCustomerSecondaryAddress","name":"Update existing address information for the customer.","summary":"Update secondary address","tags":["RETAIL"],"parameters":[{"name":"addressReference","in":"path","type":"string","required":true,"description":"Reference Id of address record"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"addressLine1":"string","addressLine2":"string","shortName":"string","city":"string","stateId":"/v1.0.0/reference/us/states","countyId":"/v1.0.0/reference/us/states/{stateId}/counties","zipCode":0.0,"zipPlusFour":0.0,"country":"/v1.0.0/reference/countries","customerContactIndicator":"YES","addressStatus":"B","taxAddressType":"/v1.0.0/reference/lookups?virtualTableName=IRS.ADDRESS.TYPE","addressPurpose":"CTC","extensions":{}}},"responses":{"200":"UsCustomerSecondaryAddressResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"DELETE","path":"/party/us/customers/secondaryAddresses/{addressReference}","fullPath":"/api/v6.1.0/party/us/customers/secondaryAddresses/{addressReference}","operationId":"deleteUsCustomerSecondaryAddress","name":"Remove customer's secondary address information","summary":"Remove customer's secondary address","tags":["RETAIL"],"parameters":[{"name":"addressReference","in":"path","type":"string","required":true,"description":"Reference Id of address record"},{"name":"payload","in":"body","type":"object","required":false,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}}},"responses":{"200":"UsCustomerSecondaryAddressResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"POST","path":"/party/us/customers/{customerId}/secondaryAddresses","fullPath":"/api/v6.1.0/party/us/customers/{customerId}/secondaryAddresses","operationId":"createUsCustomerSecondaryAddress","name":"Add new customer address information","summary":"Create secondary address","tags":["RETAIL"],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"Identifier of the customer"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"addressLine1":"string","addressLine2":"string","shortName":"string","name":"string","city":"string","stateId":"/v1.0.0/reference/us/states","countyId":"/v1.0.0/reference/us/states/{stateId}/counties","zipCode":0.0,"zipPlusFour":0.0,"country":"/v1.0.0/reference/countries","customerContactIndicator":"YES","addressStatus":"B","taxAddressType":"/v1.0.0/reference/lookups?virtualTableName=IRS.ADDRESS.TYPE","addressPurpose":"CTC","extensions":{}}},"responses":{"200":"UsCustomerSecondaryAddressResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/party/us/customers/{customerId}/addressPreferences","fullPath":"/api/v6.1.0/party/us/customers/{customerId}/addressPreferences","operationId":"getAddressPreferences","name":"Retrieves seasonal address preferences set for the customer. Provides the address carrier and the duration for which an address should be used as the primary address","summary":"Seasonal address details","tags":["RETAIL"],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"Identifier of the customer"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"AddressPreferencesResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"POST","path":"/party/us/customers/{customerId}/addressPreferences","fullPath":"/api/v6.1.0/party/us/customers/{customerId}/addressPreferences","operationId":"createAddressPreference","name":"Allows capturing alternate address for a customer to be used for mails during specific periods each year","summary":"Create alternate address ","tags":["RETAIL"],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"Identifier of the customer"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"alternateaddressperiod":[{}],"carrier":"string","defaultCarrier":"string","extensions":{}}},"responses":{"200":"AddressPreferenceResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/party/us/customers/{customerId}/addressPreferences","fullPath":"/api/v6.1.0/party/us/customers/{customerId}/addressPreferences","operationId":"updateAddressPreference","name":"Updates alternate address information for a customer","summary":"Update alternate address","tags":["RETAIL"],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"Identifier of the customer"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"alternateaddressperiod":[{}],"carrier":"string","defaultCarrier":"string","extensions":{}}},"responses":{"200":"AddressPreferenceResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/party/us/customers/{customerId}/beneficiaries","fullPath":"/api/v6.1.0/party/us/customers/{customerId}/beneficiaries","operationId":"getUsBeneficiary","name":"Retrieve list of beneficiaries created for a customer to perform account transfer, bill payments or wires. Information can be retrieved using customer id, debit account id, beneficiary nickname, account type, etc","summary":"Retrieve beneficiary information for a customer","tags":["RETAIL"],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"Identifier of the customer"},{"name":"beneficiaryInstituteName","in":"query","type":"string","required":false,"description":"Indicates the name of financial institution where the beneficiary account is held"},{"name":"beneficiaryAccountId","in":"query","type":"string","required":false,"description":"Unique account identifier of the beneficiary account number."},{"name":"beneficiaryNickName","in":"query","type":"string","required":false,"description":"Nickname of the beneficiary"},{"name":"accountWithBankSortCode","in":"query","type":"string","required":false,"description":"Bank sort code details with account"},{"name":"accountType","in":"query","type":"string","required":false,"description":"Groups the products based on their type, eg, Checking, Savings, CD etc,."},{"name":"beneficiaryCustomerId","in":"query","type":"string","required":false,"description":"Identifies the Customer who is to be the ultimate receiver of the funds transferred by the sending bank when this Beneficiary is not a bank."},{"name":"beneficiaryId","in":"query","type":"string","required":false,"description":"Indicates the reference of the financial institution that allows access to the beneficiary information"},{"name":"transactionType","in":"query","type":"string","required":false,"description":"Identifies the transaction type applicable to the transaction being processed, i.e. outward or inward payment. For example: ACPX, OTPX etc."},{"name":"preferredPaymentProduct","in":"query","type":"string","required":false,"description":"Preferred payment product can be specified for Beneficiary. This will be used for defaulting the payment product for specific beneficiary. "},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"UsBeneficiaryResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"POST","path":"/party/us/customers/{customerId}/beneficiaries","fullPath":"/api/v6.1.0/party/us/customers/{customerId}/beneficiaries","operationId":"createUsBeneficiary","name":"Create a beneficiary for account transfers or bill payment","summary":"Create an ACH beneficiary","tags":["RETAIL"],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"Identifier of the customer"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"beneficiaryAccountId":"string","beneficiaryNickName":"string","accountWithBankSortCode":"string","accountType":"CHECKING","beneficiaryCustomerId":"string","paymentDetails":"string","beneficiaryOtherIdType":"ORGANISATION","beneficiaryOtherId":"string","preferredPaymentProduct":"string","recordStatus":"string","currNo":"string","inputter":"string","dateTime":"2024-01-01","authoriser":"string","deptCode":"string"}},"responses":{"200":"UsBeneficiaryResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/party/us/customers/beneficiaries/{beneficiaryId}","fullPath":"/api/v6.1.0/party/us/customers/beneficiaries/{beneficiaryId}","operationId":"updateUsBeneficiary","name":"Update beneficiary created for account transfers or bill payment","summary":"Update ACH beneficiary","tags":["RETAIL"],"parameters":[{"name":"beneficiaryId","in":"path","type":"string","required":true,"description":"Indicates the reference of the financial institution that allows access to the beneficiary information"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"beneficiaryAccountId":"string","beneficiaryNickName":"string","accountWithBankSortCode":"string","accountType":"CHECKING","beneficiaryCustomerId":"string","paymentDetails":"string","beneficiaryOtherIdType":"ORGANISATION","beneficiaryOtherId":"string","preferredPaymentProduct":"string","recordStatus":"string","currNo":"string","inputter":"string","dateTime":"2024-01-01","authoriser":"string","deptCode":"string"}},"responses":{"200":"UsBeneficiaryResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"POST","path":"/party/us/customers/{customerId}/beneficiaries/wires","fullPath":"/api/v6.1.0/party/us/customers/{customerId}/beneficiaries/wires","operationId":"createUsWiresBeneficiary","name":"Create beneficiary information for generating a wire transfer","summary":"Creates beneficiary for wire transfers","tags":["RETAIL"],"parameters":[{"name":"customerId","in":"path","type":"number","required":true,"description":"Identifier of the customer"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"beneficiaryNickNames":[{}],"beneficiaryPaymentCountryId":"string","beneficiaryAccountId":"string","accountWithBankSortCode":"string","accountType":"@ref:reference-us-sortcodes-services","beneficiaryInstituteName":"string","beneficiaryInstituteBranchName":"string","beneficiaryInstituteAddressLine1":"string","beneficiaryInstituteAddressLine2":"string","beneficiaryInstituteAddressLine3":0.0,"beneficiaryInstituteCountryCode":"string","beneficiaryCustomerId":"string","beneficiaryShortName":"string","beneficiaryAddressLine1":"string","beneficiaryAddressLine2":"string"}},"responses":{"200":"UsWiresBeneficiaryResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/party/us/customers/beneficiaries/{beneficiaryId}/wires","fullPath":"/api/v6.1.0/party/us/customers/beneficiaries/{beneficiaryId}/wires","operationId":"updateUsWiresBeneficiary","name":"Updates routing number, bank details or the payee details of a beneficiary set up for wire transfers","summary":"Updates existing wire payment beneficiary","tags":["RETAIL"],"parameters":[{"name":"beneficiaryId","in":"path","type":"string","required":true,"description":"Indicates the reference of the financial institution that allows access to the beneficiary information"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"beneficiaryNickNames":[{}],"beneficiaryPaymentCountryId":"string","beneficiaryAccountId":"string","accountWithBankSortCode":"string","accountType":"@ref:reference-us-sortcodes-services","beneficiaryInstituteName":"string","beneficiaryInstituteBranchName":"string","beneficiaryInstituteAddressLine1":"string","beneficiaryInstituteAddressLine2":"string","beneficiaryInstituteAddressLine3":0.0,"beneficiaryInstituteCountryCode":"string","beneficiaryCustomerId":"string","beneficiaryShortName":"string","beneficiaryAddressLine1":"string","beneficiaryAddressLine2":"string"}},"responses":{"200":"UsWiresBeneficiaryResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/party/us/customers/{customerId}/deliveryPreferences","fullPath":"/api/v6.1.0/party/us/customers/{customerId}/deliveryPreferences","operationId":"getUsDeliveryPreference","name":"Retrieves all available mail addresses for a customer along with information on the purpose of the address (primary, office, etc,.), internal address reference.","summary":"Retrieves all available mail addresses for a customer along with information on the purpose of the address (primary, office, etc,.), internal address reference.","tags":["RETAIL"],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"UsDeliveryPreferenceResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/party/us/customers/{customerId}/kyc/dueDiligences","fullPath":"/api/v6.1.0/party/us/customers/{customerId}/kyc/dueDiligences","operationId":"getUsPoliticalCustomer","name":"Retrieves the list of customers who are exposed as political person.","summary":"Retrieves the list of customers who are exposed as political person.","tags":["RETAIL"],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"Identifier of the customer"},{"name":"customerName","in":"query","type":"string","required":false,"description":"Indicates the name of the customer. Originator is the party who requests the payment cancellation."},{"name":"dateOfBirth","in":"query","type":"string","required":false,"description":"The date of birth of an individual customer"},{"name":"mobileNumber","in":"query","type":"string","required":false,"description":"Mobile number of the customer"},{"name":"emailId","in":"query","type":"string","required":false,"description":"Contains the email identifier of the customer"},{"name":"taxId","in":"query","type":"string","required":false,"description":"Holds the Customer's TAX/SSN Id."},{"name":"customerStatus","in":"query","type":"string","required":false,"description":"The internal bank status of a customer"},{"name":"accountOfficer","in":"query","type":"string","required":false,"description":"Identifier of Department Account Officer"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"UsPoliticalCustomerResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"PUT","path":"/party/us/customers/{customerId}/kyc/dueDiligences","fullPath":"/api/v6.1.0/party/us/customers/{customerId}/kyc/dueDiligences","operationId":"updateUsceddKyc","name":"Update enhanced due diligence and political information about any \"Customer\" which the bank has dealings.","summary":"Update enhanced due diligence and political information about any \"Customer\" which the bank has dealings.","tags":["RETAIL"],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"Identifier of the customer"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"accountTypes":[{}],"incomingTransactionCountries":[{}],"outgoingTransactionCountries":[{}],"lendingLinesOfCreditCountries":[{}],"lettersOfCreditCountries":[{}],"exportCreditCountries":[{}],"cashCollateralLoanCountries":[{}],"sourceOfFunds":[{}],"overrideDetails":[{}],"inputter":[{}],"dateTime":[{}],"politicallyExposedForeignPerson":"string","politicalPosition":"string","kycExempt":"string","kycExemptReason":"string"}},"responses":{"200":"UsceddKycResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/party/us/customers/{customerId}/corporates","fullPath":"/api/v6.1.0/party/us/customers/{customerId}/corporates","operationId":"getUsCorporateCustomer","name":"Retrieves corporate customer information. Unless there is a specific set of information to be updated for which a separate APIs exists, this generic API can be used where all available information can be retrieved.","summary":"Retrieve corporate customer information","tags":["RETAIL"],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"Identifier of the customer"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"UsCorporateCustomerResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/party/us/customers/{customerId}/corporates","fullPath":"/api/v6.1.0/party/us/customers/{customerId}/corporates","operationId":"updateUsCorporateCustomer","name":"Updates corporate customer information. Unless there is a specific set of information to be updated for which a separate URIs exists, this generic URI can be used where all available information can be updated","summary":"Update corporate customer information","tags":["RETAIL"],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"Identifier of the customer"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"idDocument":[{}],"PreviousIdentification":[{}],"communication":[{}],"riskClass":[{}],"overrideReason":[{}],"crProfileType":[{}],"otherOfficers":[{}],"overrideDetails":[{}],"inputter":[{}],"dateTime":[{}],"customerName":"string","customerNameAdditional":"string","shortName":"string","birthIncorpDate":"string","taxId":"string"}},"responses":{"200":"UsCorporateCustomerResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/party/us/customers/{customerId}/individuals","fullPath":"/api/v6.1.0/party/us/customers/{customerId}/individuals","operationId":"getUsIndividualCustomer","name":"Retrieves individual customer information. Unless there is a specific set of information to be updated for which a separate URIs exists, this generic URI can be used where all available information for an individual customer can be retrieved.","summary":"Retrieve individual customer information","tags":["RETAIL"],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"Identifier of the customer"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"UsIndividualCustomerResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/party/us/customers/{customerId}/individuals","fullPath":"/api/v6.1.0/party/us/customers/{customerId}/individuals","operationId":"updateUsIndividualCustomer","name":"Updates individual customer. Unless there is specific set of information to be updated for which a separate URIs exists, this generic URI can be used where all information for an individual customer can be updated.","summary":"Update individual customer. ","tags":["RETAIL"],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"Identifier of the customer"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"idDocument":[{}],"employment":[{}],"creditScore":[{}],"PreviousIdentification":[{}],"residenceInfo":[{}],"communication":[{}],"riskClass":[{}],"overrideReason":[{}],"crProfileType":[{}],"otherOfficers":[{}],"overrideDetails":[{}],"inputter":[{}],"dateTime":[{}],"title":"string","givenName":"string"}},"responses":{"200":"UsIndividualCustomerResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"POST","path":"/party/us/customers/corporates","fullPath":"/api/v6.1.0/party/us/customers/corporates","operationId":"createUsCorporateCustomer","name":"Allows creation of a corporate customer","summary":"Create corporate customer","tags":["RETAIL"],"parameters":[{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"idDocument":[{}],"PreviousIdentification":[{}],"communication":[{}],"communicationDevices":[{}],"officePhoneNumbers":[{}],"faxIds":[{}],"riskClass":[{}],"overrideReason":[{}],"crProfileType":[{}],"otherOfficers":[{}],"overrideDetails":[{}],"inputter":[{}],"dateTime":[{}],"customerName":"string","customerNameAdditional":"string"}},"responses":{"200":"UsCorporateCustomerResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"POST","path":"/party/us/customers/corporates/relations","fullPath":"/api/v6.1.0/party/us/customers/corporates/relations","operationId":"createUsCorporateCustomerRelation","name":"Allows to create a new party relationship for the corporate customer","summary":"Allows to create a new party relationship for the corporate customer","tags":["RETAIL"],"parameters":[{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"partyDisplayNames":[{}],"partyRelationships":[{}],"customerGroupId":"string","ownershipRuleId":"/v1.0.0/reference/us/beneficialOwnerTypes","noOwnerGt25Percent":"YES","otherOwnersLt25PercentFlag":"YES","certifierName":"string","certifierTitle":"string","additionalTitle":"string","certificationDate":"string","customerContactIndicator":"YES","extensions":{}}},"responses":{"200":"UsCorporateCustomerRelationResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"POST","path":"/party/us/customers/individuals/relations","fullPath":"/api/v6.1.0/party/us/customers/individuals/relations","operationId":"createUsIndividualCustomerRelation","name":"Allows to create a new party relationship for the individual customer","summary":"Allows to create a new party relationship for the individual customer","tags":["RETAIL"],"parameters":[{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"partyDisplayNames":[{}],"partyRelationships":[{}],"customerGroupId":"string","ownershipRuleId":"/v1.0.0/reference/us/beneficialOwnerTypes","noOwnerGt25Percent":"YES","otherOwnersLt25PercentFlag":"YES","certifierName":"string","certifierTitle":"string","additionalTitle":"string","certificationDate":"string","customerContactIndicator":"YES","extensions":{}}},"responses":{"200":"UsIndividualCustomerRelationResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/party/us/customers/relations/{relationId}","fullPath":"/api/v6.1.0/party/us/customers/relations/{relationId}","operationId":"updateUsCustomerRelation","name":"Allows to update the party relationship for the customer","summary":"Allows to update the party relationship for the customer","tags":["RETAIL"],"parameters":[{"name":"relationId","in":"path","type":"string","required":true,"description":""},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"partyDisplayNames":[{}],"partyRelationships":[{}],"customerGroupId":"string","ownershipRuleId":"/v1.0.0/reference/us/beneficialOwnerTypes","noOwnerGt25Percent":"YES","otherOwnersLt25PercentFlag":"YES","certifierName":"string","certifierTitle":"string","additionalTitle":"string","certificationDate":"string","customerContactIndicator":"YES","extensions":{}}},"responses":{"200":"UsCustomerRelationResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/party/us/customers/{customerId}/relations","fullPath":"/api/v6.1.0/party/us/customers/{customerId}/relations","operationId":"getUsCustomerRelation","name":"Retrieves the relationship details for a given customer","summary":"Retrieves the relationship details for a given customer","tags":["RETAIL"],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"Identifier of the customer"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"UsCustomerRelationResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/party/us/customers/{customerId}/contacts","fullPath":"/api/v6.1.0/party/us/customers/{customerId}/contacts","operationId":"getUsCustomerAddresslist","name":"Retrieves all available mail addresses for a customer along with information on the purpose of the address(primary, office, etc,.), internal address reference.","summary":"Retrieve customer mailing addresses","tags":["RETAIL"],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"UsCustomerAddresslistResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/party/us/customers/{customerId}/contacts","fullPath":"/api/v6.1.0/party/us/customers/{customerId}/contacts","operationId":"createUsCustomerContactDetail","name":"Create or update customer phone, office phone, mobile, email or fax numbers and the consent for sharing contact information with financial institute's marketing partners.","summary":"Create or update customer contact and consent information","tags":["RETAIL"],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":""},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"contactDetails":[{}],"customercontactflag":"string","extensions":{}}},"responses":{"200":"UsCustomerContactDetailResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/party/us/customers/contacts/{contactId}/consents","fullPath":"/api/v6.1.0/party/us/customers/contacts/{contactId}/consents","operationId":"getUsDeviceConsent","name":"Retrieve customer consent for the requested contact information.","summary":"Retrieve consent information for contacts.","tags":["RETAIL"],"parameters":[{"name":"contactId","in":"path","type":"string","required":true,"description":"Indicates the reference number/text for the contacting customer. Can be phone number, telephone, fax, email or mobile linked to a customer."},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"UsDeviceConsentResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"PUT","path":"/party/us/customers/contacts/{contactId}/consents","fullPath":"/api/v6.1.0/party/us/customers/contacts/{contactId}/consents","operationId":"updateUsDeviceConsent","name":"Update consent information like marketing consent, do not call and general consent. As part of consent, preferred time to call, consent log like the method how the consent was collected, the customer who gave the consent and the date when consent was received is also captured.","summary":"Update consent information for contact devices.","tags":["RETAIL"],"parameters":[{"name":"contactId","in":"path","type":"string","required":true,"description":""},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"consentDetails":[{}],"consentMethod":"/v1.0.0/reference/lookups?virtualTableName=TCPA.CONSENT.METHOD","consentParty":"string","consentDate":"2024-01-01","extensions":{}}},"responses":{"200":"UsDeviceConsentResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"POST","path":"/party/us/customers/individuals","fullPath":"/api/v6.1.0/party/us/customers/individuals","operationId":"createUsIndividualCustomer","name":"Allows creation of an individual customer.","summary":"Create individual customer.","tags":["RETAIL"],"parameters":[{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"idDocument":[{}],"employment":[{}],"creditScore":[{}],"PreviousIdentification":[{}],"residenceInfo":[{}],"communication":[{}],"communicationDevices":[{}],"officePhoneNumbers":[{}],"faxIds":[{}],"riskClass":[{}],"overrideReason":[{}],"crProfileType":[{}],"otherOfficers":[{}],"overrideDetails":[{}],"inputter":[{}]}},"responses":{"200":"UsIndividualCustomerResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}}]},{"key":"party-us-customerservice-v6.2.0","title":"US Model Bank Customer management","version":"v6.2.0","description":"The customer service API allows to create, update and modify customer, contact details, address and beneficiary. Separate URIs are available for corporate and individual customers to update or retrieve specific information like address, secondary address, credit score, KYC, relation, beneficial owne","endpointCount":36,"endpoints":[{"method":"GET","path":"/party/us/customers","fullPath":"/api/v6.2.0/party/us/customers","operationId":"searchUsCustomer","name":"Search and retrieve customer information based on customer name, date of birth, date of incorporation, SSN or TIN, and mobile number","summary":"Search customer","tags":["RETAIL"],"parameters":[{"name":"customerId","in":"query","type":"string","required":false,"description":"Identifier of the customer"},{"name":"customerName","in":"query","type":"string","required":false,"description":"Indicates the name of the customer. Originator is the party who requests the payment cancellation."},{"name":"taxId","in":"query","type":"string","required":false,"description":"Holds the Customer's TAX/SSN Id."},{"name":"dateOfBirth","in":"query","type":"string","required":false,"description":"The date of birth of an individual customer"},{"name":"mobileNumber","in":"query","type":"string","required":false,"description":"Mobile number of the customer"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"UsCustomerResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/party/us/customers/{customerId}/scores","fullPath":"/api/v6.2.0/party/us/customers/{customerId}/scores","operationId":"getUsCustomerCreditscore","name":"Retrieve customer's credit score information received from credit agencies.","summary":"Retrieve customer credit scores","tags":["RETAIL"],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"Identifier of the customer"},{"name":"agencyId","in":"query","type":"string","required":false,"description":"Name of the agency that provided the credit score. Allowed values can be retrieved through getEbLookups for virtualTableName CREDIT.BUREAU"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"UsCustomerCreditscoreResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/party/us/customers/{customerId}/agencies/{agencyId}/scores","fullPath":"/api/v6.2.0/party/us/customers/{customerId}/agencies/{agencyId}/scores","operationId":"getUsCustomerCreditscoreByAgency","name":"Retrieves the credit score information available for a customer from the specific reporting agency provided in the URI.","summary":"Retrieve customer credit score by agency","tags":["RETAIL"],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"Identifier of the customer"},{"name":"agencyId","in":"path","type":"string","required":true,"description":"Name of the agency that provided the credit score. Allowed values can be retrieved through getEbLookups for virtualTableName CREDIT.BUREAU"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"UsCustomerCreditscoreByAgencyResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/party/us/customers/{customerId}/documents","fullPath":"/api/v6.2.0/party/us/customers/{customerId}/documents","operationId":"searchUsDocuments","name":"Search documents available for customer identification. Provides information on document reference, status, validity, issuer details, and version information.","summary":"Search customer documents","tags":["RETAIL"],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"Identifier of the customer"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"UsDocumentsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/party/us/customers/{customerId}/kyc","fullPath":"/api/v6.2.0/party/us/customers/{customerId}/kyc","operationId":"getUsCustomerKycandTax","name":"Retrieves KYC and tax information for a customer","summary":"Retrieve customer KYC and tax information","tags":["RETAIL"],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"Identifier of the customer"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"UsCustomerKycandTaxResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/party/us/customers/{customerId}/kyc","fullPath":"/api/v6.2.0/party/us/customers/{customerId}/kyc","operationId":"updateUsCustomerKycandTax","name":"Allows update to KYC and tax information for a customer","summary":"Update customer KYC and tax information","tags":["RETAIL"],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"Identifier of the customer"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"riskClass":[{}],"introducer":"string","contactDate":"2024-01-01","kycRelationship":"string","kycLastReviewDate":"2024-01-01","amlCheck":"NULL","amlResult":"NULL","amlLastResultDate":"2024-01-01","manualRiskClass":"string","overrideReason":"string","isKycComplete":"YES","taxCertificationType":"/v1.0.0/reference/lookups?virtualTableName=TAX.CERT.TYPE","foreignTin":"string","taxCertificationDate":"2024-01-01","reasonForMissingFtin":"/v1.0.0/reference/lookups?virtualTableName=FTIN.MIS.REASON"}},"responses":{"200":"UsCustomerKycandTaxResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/party/us/customers/{customerId}/primaryAddresses","fullPath":"/api/v6.2.0/party/us/customers/{customerId}/primaryAddresses","operationId":"getUsCustomerPrimaryAddress","name":"Retrieve customer primary address","summary":"Retrieve customer primary address","tags":["RETAIL"],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"Identifier of the customer"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"UsCustomerPrimaryAddressResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/party/us/customers/{customerId}/primaryAddresses","fullPath":"/api/v6.2.0/party/us/customers/{customerId}/primaryAddresses","operationId":"updateUsCustomerPrimaryAddress","name":"Update customer primary address","summary":"Update customer primary address","tags":["RETAIL"],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"Identifier of the customer"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"overrideDetails":[{}],"inputter":[{}],"dateTime":[{}],"addressLine1":"string","addressLine2":"string","city":"string","stateId":"/v1.0.0/reference/us/states","countyId":"/v1.0.0/reference/us/states/{stateId}/counties","zipCode":0.0,"zipPlusFour":0.0,"country":"/v1.0.0/reference/countries","addressStatus":"B","addressLocation":"string","addressPurpose":"CTC","recordStatus":"string"}},"responses":{"200":"UsCustomerPrimaryAddressResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/party/us/customers/secondaryAddresses/{addressReference}","fullPath":"/api/v6.2.0/party/us/customers/secondaryAddresses/{addressReference}","operationId":"updateUsCustomerSecondaryAddress","name":"Update existing address information for the customer.","summary":"Update secondary address","tags":["RETAIL"],"parameters":[{"name":"addressReference","in":"path","type":"string","required":true,"description":"Reference Id of address record"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"addressLine1":"string","addressLine2":"string","shortName":"string","city":"string","stateId":"/v1.0.0/reference/us/states","countyId":"/v1.0.0/reference/us/states/{stateId}/counties","zipCode":0.0,"zipPlusFour":0.0,"country":"/v1.0.0/reference/countries","customerContactIndicator":"YES","addressStatus":"B","taxAddressType":"/v1.0.0/reference/lookups?virtualTableName=IRS.ADDRESS.TYPE","addressPurpose":"CTC","extensions":{}}},"responses":{"200":"UsCustomerSecondaryAddressResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"DELETE","path":"/party/us/customers/secondaryAddresses/{addressReference}","fullPath":"/api/v6.2.0/party/us/customers/secondaryAddresses/{addressReference}","operationId":"deleteUsCustomerSecondaryAddress","name":"Remove customer's secondary address information","summary":"Remove customer's secondary address","tags":["RETAIL"],"parameters":[{"name":"addressReference","in":"path","type":"string","required":true,"description":"Reference Id of address record"},{"name":"payload","in":"body","type":"object","required":false,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}}},"responses":{"200":"UsCustomerSecondaryAddressResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"POST","path":"/party/us/customers/{customerId}/secondaryAddresses","fullPath":"/api/v6.2.0/party/us/customers/{customerId}/secondaryAddresses","operationId":"createUsCustomerSecondaryAddress","name":"Add new customer address information","summary":"Create secondary address","tags":["RETAIL"],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"Identifier of the customer"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"addressLine1":"string","addressLine2":"string","shortName":"string","name":"string","city":"string","stateId":"/v1.0.0/reference/us/states","countyId":"/v1.0.0/reference/us/states/{stateId}/counties","zipCode":0.0,"zipPlusFour":0.0,"country":"/v1.0.0/reference/countries","customerContactIndicator":"YES","addressStatus":"B","taxAddressType":"/v1.0.0/reference/lookups?virtualTableName=IRS.ADDRESS.TYPE","addressPurpose":"CTC","extensions":{}}},"responses":{"200":"UsCustomerSecondaryAddressResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/party/us/customers/{customerId}/addressPreferences","fullPath":"/api/v6.2.0/party/us/customers/{customerId}/addressPreferences","operationId":"getAddressPreferences","name":"Retrieves seasonal address preferences set for the customer. Provides the address carrier and the duration for which an address should be used as the primary address","summary":"Seasonal address details","tags":["RETAIL"],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"Identifier of the customer"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"AddressPreferencesResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"POST","path":"/party/us/customers/{customerId}/addressPreferences","fullPath":"/api/v6.2.0/party/us/customers/{customerId}/addressPreferences","operationId":"createAddressPreference","name":"Allows capturing alternate address for a customer to be used for mails during specific periods each year","summary":"Create alternate address ","tags":["RETAIL"],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"Identifier of the customer"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"alternateaddressperiod":[{}],"carrier":"string","defaultCarrier":"string","extensions":{}}},"responses":{"200":"AddressPreferenceResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/party/us/customers/{customerId}/addressPreferences","fullPath":"/api/v6.2.0/party/us/customers/{customerId}/addressPreferences","operationId":"updateAddressPreference","name":"Updates alternate address information for a customer","summary":"Update alternate address","tags":["RETAIL"],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"Identifier of the customer"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"alternateaddressperiod":[{}],"carrier":"string","defaultCarrier":"string","extensions":{}}},"responses":{"200":"AddressPreferenceResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/party/us/customers/{customerId}/beneficiaries","fullPath":"/api/v6.2.0/party/us/customers/{customerId}/beneficiaries","operationId":"getUsBeneficiary","name":"Retrieve list of beneficiaries created for a customer to perform account transfer, bill payments or wires. Information can be retrieved using customer id, debit account id, beneficiary nickname, account type, etc","summary":"Retrieve beneficiary information for a customer","tags":["RETAIL"],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"Identifier of the customer"},{"name":"beneficiaryInstituteName","in":"query","type":"string","required":false,"description":"Indicates the name of financial institution where the beneficiary account is held"},{"name":"beneficiaryAccountId","in":"query","type":"string","required":false,"description":"Unique account identifier of the beneficiary account number."},{"name":"beneficiaryNickName","in":"query","type":"string","required":false,"description":"Nickname of the beneficiary"},{"name":"accountWithBankSortCode","in":"query","type":"string","required":false,"description":"Bank sort code details with account"},{"name":"accountType","in":"query","type":"string","required":false,"description":"Groups the products based on their type, eg, Checking, Savings, CD etc,."},{"name":"beneficiaryCustomerId","in":"query","type":"string","required":false,"description":"Identifies the Customer who is to be the ultimate receiver of the funds transferred by the sending bank when this Beneficiary is not a bank."},{"name":"beneficiaryId","in":"query","type":"string","required":false,"description":"Indicates the reference of the financial institution that allows access to the beneficiary information"},{"name":"transactionType","in":"query","type":"string","required":false,"description":"Identifies the transaction type applicable to the transaction being processed, i.e. outward or inward payment. For example: ACPX, OTPX etc."},{"name":"preferredPaymentProduct","in":"query","type":"string","required":false,"description":"Preferred payment product can be specified for Beneficiary. This will be used for defaulting the payment product for specific beneficiary. "},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"UsBeneficiaryResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"POST","path":"/party/us/customers/{customerId}/beneficiaries","fullPath":"/api/v6.2.0/party/us/customers/{customerId}/beneficiaries","operationId":"createUsBeneficiary","name":"Create a beneficiary for account transfers or bill payment","summary":"Create an ACH beneficiary","tags":["RETAIL"],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"Identifier of the customer"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"beneficiaryAccountId":"string","beneficiaryNickName":"string","accountWithBankSortCode":"string","accountType":"CHECKING","beneficiaryCustomerId":"string","paymentDetails":"string","beneficiaryOtherIdType":"ORGANISATION","beneficiaryOtherId":"string","preferredPaymentProduct":"string","recordStatus":"string","currNo":"string","inputter":"string","dateTime":"2024-01-01","authoriser":"string","deptCode":"string"}},"responses":{"200":"UsBeneficiaryResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/party/us/customers/beneficiaries/{beneficiaryId}","fullPath":"/api/v6.2.0/party/us/customers/beneficiaries/{beneficiaryId}","operationId":"updateUsBeneficiary","name":"Update beneficiary created for account transfers or bill payment","summary":"Update ACH beneficiary","tags":["RETAIL"],"parameters":[{"name":"beneficiaryId","in":"path","type":"string","required":true,"description":"Indicates the reference of the financial institution that allows access to the beneficiary information"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"beneficiaryAccountId":"string","beneficiaryNickName":"string","accountWithBankSortCode":"string","accountType":"CHECKING","beneficiaryCustomerId":"string","paymentDetails":"string","beneficiaryOtherIdType":"ORGANISATION","beneficiaryOtherId":"string","preferredPaymentProduct":"string","recordStatus":"string","currNo":"string","inputter":"string","dateTime":"2024-01-01","authoriser":"string","deptCode":"string"}},"responses":{"200":"UsBeneficiaryResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"POST","path":"/party/us/customers/{customerId}/beneficiaries/wires","fullPath":"/api/v6.2.0/party/us/customers/{customerId}/beneficiaries/wires","operationId":"createUsWiresBeneficiary","name":"Create beneficiary information for generating a wire transfer","summary":"Creates beneficiary for wire transfers","tags":["RETAIL"],"parameters":[{"name":"customerId","in":"path","type":"number","required":true,"description":"Identifier of the customer"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"beneficiaryNickNames":[{}],"beneficiaryPaymentCountryId":"string","beneficiaryAccountId":"string","accountWithBankSortCode":"string","accountType":"@ref:reference-us-sortcodes-services","beneficiaryInstituteName":"string","beneficiaryInstituteBranchName":"string","beneficiaryInstituteAddressLine1":"string","beneficiaryInstituteAddressLine2":"string","beneficiaryInstituteAddressLine3":0.0,"beneficiaryInstituteCountryCode":"string","beneficiaryCustomerId":"string","beneficiaryShortName":"string","beneficiaryAddressLine1":"string","beneficiaryAddressLine2":"string"}},"responses":{"200":"UsWiresBeneficiaryResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/party/us/customers/beneficiaries/{beneficiaryId}/wires","fullPath":"/api/v6.2.0/party/us/customers/beneficiaries/{beneficiaryId}/wires","operationId":"updateUsWiresBeneficiary","name":"Updates routing number, bank details or the payee details of a beneficiary set up for wire transfers","summary":"Updates existing wire payment beneficiary","tags":["RETAIL"],"parameters":[{"name":"beneficiaryId","in":"path","type":"string","required":true,"description":"Indicates the reference of the financial institution that allows access to the beneficiary information"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"beneficiaryNickNames":[{}],"beneficiaryPaymentCountryId":"string","beneficiaryAccountId":"string","accountWithBankSortCode":"string","accountType":"@ref:reference-us-sortcodes-services","beneficiaryInstituteName":"string","beneficiaryInstituteBranchName":"string","beneficiaryInstituteAddressLine1":"string","beneficiaryInstituteAddressLine2":"string","beneficiaryInstituteAddressLine3":0.0,"beneficiaryInstituteCountryCode":"string","beneficiaryCustomerId":"string","beneficiaryShortName":"string","beneficiaryAddressLine1":"string","beneficiaryAddressLine2":"string"}},"responses":{"200":"UsWiresBeneficiaryResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/party/us/customers/{customerId}/deliveryPreferences","fullPath":"/api/v6.2.0/party/us/customers/{customerId}/deliveryPreferences","operationId":"getUsDeliveryPreference","name":"Retrieves all available mail addresses for a customer along with information on the purpose of the address (primary, office, etc,.), internal address reference.","summary":"Retrieves all available mail addresses for a customer along with information on the purpose of the address (primary, office, etc,.), internal address reference.","tags":["RETAIL"],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"UsDeliveryPreferenceResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/party/us/customers/{customerId}/kyc/dueDiligences","fullPath":"/api/v6.2.0/party/us/customers/{customerId}/kyc/dueDiligences","operationId":"getUsPoliticalCustomer","name":"Retrieves the list of customers who are exposed as political person.","summary":"Retrieves the list of customers who are exposed as political person.","tags":["RETAIL"],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"Identifier of the customer"},{"name":"customerName","in":"query","type":"string","required":false,"description":"Indicates the name of the customer. Originator is the party who requests the payment cancellation."},{"name":"dateOfBirth","in":"query","type":"string","required":false,"description":"The date of birth of an individual customer"},{"name":"mobileNumber","in":"query","type":"string","required":false,"description":"Mobile number of the customer"},{"name":"emailId","in":"query","type":"string","required":false,"description":"Contains the email identifier of the customer"},{"name":"taxId","in":"query","type":"string","required":false,"description":"Holds the Customer's TAX/SSN Id."},{"name":"customerStatus","in":"query","type":"string","required":false,"description":"The internal bank status of a customer"},{"name":"accountOfficer","in":"query","type":"string","required":false,"description":"Identifier of Department Account Officer"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"UsPoliticalCustomerResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"PUT","path":"/party/us/customers/{customerId}/kyc/dueDiligences","fullPath":"/api/v6.2.0/party/us/customers/{customerId}/kyc/dueDiligences","operationId":"updateUsceddKyc","name":"Update enhanced due diligence and political information about any \"Customer\" which the bank has dealings.","summary":"Update enhanced due diligence and political information about any \"Customer\" which the bank has dealings.","tags":["RETAIL"],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"Identifier of the customer"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"accountTypes":[{}],"incomingTransactionCountries":[{}],"outgoingTransactionCountries":[{}],"lendingLinesOfCreditCountries":[{}],"lettersOfCreditCountries":[{}],"exportCreditCountries":[{}],"cashCollateralLoanCountries":[{}],"sourceOfFunds":[{}],"overrideDetails":[{}],"inputter":[{}],"dateTime":[{}],"politicallyExposedForeignPerson":"string","politicalPosition":"string","kycExempt":"string","kycExemptReason":"string"}},"responses":{"200":"UsceddKycResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/party/us/customers/{customerId}/corporates","fullPath":"/api/v6.2.0/party/us/customers/{customerId}/corporates","operationId":"getUsCorporateCustomer","name":"Retrieves corporate customer information. Unless there is a specific set of information to be updated for which a separate APIs exists, this generic API can be used where all available information can be retrieved.","summary":"Retrieve corporate customer information","tags":["RETAIL"],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"Identifier of the customer"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"UsCorporateCustomerResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/party/us/customers/{customerId}/corporates","fullPath":"/api/v6.2.0/party/us/customers/{customerId}/corporates","operationId":"updateUsCorporateCustomer","name":"Updates corporate customer information. Unless there is a specific set of information to be updated for which a separate URIs exists, this generic URI can be used where all available information can be updated","summary":"Update corporate customer information","tags":["RETAIL"],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"Identifier of the customer"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"idDocument":[{}],"PreviousIdentification":[{}],"communication":[{}],"riskClass":[{}],"overrideReason":[{}],"crProfileType":[{}],"otherOfficers":[{}],"overrideDetails":[{}],"inputter":[{}],"dateTime":[{}],"customerName":"string","customerNameAdditional":"string","shortName":"string","birthIncorpDate":"string","taxId":"string"}},"responses":{"200":"UsCorporateCustomerResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/party/us/customers/{customerId}/individuals","fullPath":"/api/v6.2.0/party/us/customers/{customerId}/individuals","operationId":"getUsIndividualCustomer","name":"Retrieves individual customer information. Unless there is a specific set of information to be updated for which a separate URIs exists, this generic URI can be used where all available information for an individual customer can be retrieved.","summary":"Retrieve individual customer information","tags":["RETAIL"],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"Identifier of the customer"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"UsIndividualCustomerResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/party/us/customers/{customerId}/individuals","fullPath":"/api/v6.2.0/party/us/customers/{customerId}/individuals","operationId":"updateUsIndividualCustomer","name":"Updates individual customer. Unless there is specific set of information to be updated for which a separate URIs exists, this generic URI can be used where all information for an individual customer can be updated.","summary":"Update individual customer. ","tags":["RETAIL"],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"Identifier of the customer"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"idDocument":[{}],"employment":[{}],"creditScore":[{}],"PreviousIdentification":[{}],"residenceInfo":[{}],"communication":[{}],"riskClass":[{}],"overrideReason":[{}],"crProfileType":[{}],"otherOfficers":[{}],"overrideDetails":[{}],"inputter":[{}],"dateTime":[{}],"specialNeed":"Y","title":"string"}},"responses":{"200":"UsIndividualCustomerResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"POST","path":"/party/us/customers/corporates","fullPath":"/api/v6.2.0/party/us/customers/corporates","operationId":"createUsCorporateCustomer","name":"Allows creation of a corporate customer","summary":"Create corporate customer","tags":["RETAIL"],"parameters":[{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"idDocument":[{}],"PreviousIdentification":[{}],"communication":[{}],"communicationDevices":[{}],"officePhoneNumbers":[{}],"faxIds":[{}],"riskClass":[{}],"overrideReason":[{}],"crProfileType":[{}],"otherOfficers":[{}],"overrideDetails":[{}],"inputter":[{}],"dateTime":[{}],"customerName":"string","customerNameAdditional":"string"}},"responses":{"200":"UsCorporateCustomerResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"POST","path":"/party/us/customers/corporates/relations","fullPath":"/api/v6.2.0/party/us/customers/corporates/relations","operationId":"createUsCorporateCustomerRelation","name":"Allows to create a new party relationship for the corporate customer","summary":"Allows to create a new party relationship for the corporate customer","tags":["RETAIL"],"parameters":[{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"partyDisplayNames":[{}],"partyRelationships":[{}],"customerGroupId":"string","ownershipRuleId":"/v1.0.0/reference/us/beneficialOwnerTypes","noOwnerGt25Percent":"YES","otherOwnersLt25PercentFlag":"YES","certifierName":"string","certifierTitle":"string","additionalTitle":"string","certificationDate":"string","customerContactIndicator":"YES","extensions":{}}},"responses":{"200":"UsCorporateCustomerRelationResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"POST","path":"/party/us/customers/individuals/relations","fullPath":"/api/v6.2.0/party/us/customers/individuals/relations","operationId":"createUsIndividualCustomerRelation","name":"Allows to create a new party relationship for the individual customer","summary":"Allows to create a new party relationship for the individual customer","tags":["RETAIL"],"parameters":[{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"partyDisplayNames":[{}],"partyRelationships":[{}],"customerGroupId":"string","ownershipRuleId":"/v1.0.0/reference/us/beneficialOwnerTypes","noOwnerGt25Percent":"YES","otherOwnersLt25PercentFlag":"YES","certifierName":"string","certifierTitle":"string","additionalTitle":"string","certificationDate":"string","customerContactIndicator":"YES","extensions":{}}},"responses":{"200":"UsIndividualCustomerRelationResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/party/us/customers/relations/{relationId}","fullPath":"/api/v6.2.0/party/us/customers/relations/{relationId}","operationId":"updateUsCustomerRelation","name":"Allows to update the party relationship for the customer","summary":"Allows to update the party relationship for the customer","tags":["RETAIL"],"parameters":[{"name":"relationId","in":"path","type":"string","required":true,"description":""},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"partyDisplayNames":[{}],"partyRelationships":[{}],"customerGroupId":"string","ownershipRuleId":"/v1.0.0/reference/us/beneficialOwnerTypes","noOwnerGt25Percent":"YES","otherOwnersLt25PercentFlag":"YES","certifierName":"string","certifierTitle":"string","additionalTitle":"string","certificationDate":"string","customerContactIndicator":"YES","extensions":{}}},"responses":{"200":"UsCustomerRelationResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/party/us/customers/{customerId}/relations","fullPath":"/api/v6.2.0/party/us/customers/{customerId}/relations","operationId":"getUsCustomerRelation","name":"Retrieves the relationship details for a given customer","summary":"Retrieves the relationship details for a given customer","tags":["RETAIL"],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"Identifier of the customer"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"UsCustomerRelationResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/party/us/customers/{customerId}/contacts","fullPath":"/api/v6.2.0/party/us/customers/{customerId}/contacts","operationId":"getUsCustomerAddresslist","name":"Retrieves all available mail addresses for a customer along with information on the purpose of the address(primary, office, etc,.), internal address reference.","summary":"Retrieve customer mailing addresses","tags":["RETAIL"],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"UsCustomerAddresslistResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/party/us/customers/{customerId}/contacts","fullPath":"/api/v6.2.0/party/us/customers/{customerId}/contacts","operationId":"createUsCustomerContactDetail","name":"Create or update customer phone, office phone, mobile, email or fax numbers and the consent for sharing contact information with financial institute's marketing partners.","summary":"Create or update customer contact and consent information","tags":["RETAIL"],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":""},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"contactDetails":[{}],"customercontactflag":"string","extensions":{}}},"responses":{"200":"UsCustomerContactDetailResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/party/us/customers/contacts/{contactId}/consents","fullPath":"/api/v6.2.0/party/us/customers/contacts/{contactId}/consents","operationId":"getUsDeviceConsent","name":"Retrieve customer consent for the requested contact information.","summary":"Retrieve consent information for contacts.","tags":["RETAIL"],"parameters":[{"name":"contactId","in":"path","type":"string","required":true,"description":"Indicates the reference number/text for the contacting customer. Can be phone number, telephone, fax, email or mobile linked to a customer."},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"UsDeviceConsentResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"PUT","path":"/party/us/customers/contacts/{contactId}/consents","fullPath":"/api/v6.2.0/party/us/customers/contacts/{contactId}/consents","operationId":"updateUsDeviceConsent","name":"Update consent information like marketing consent, do not call and general consent. As part of consent, preferred time to call, consent log like the method how the consent was collected, the customer who gave the consent and the date when consent was received is also captured.","summary":"Update consent information for contact devices.","tags":["RETAIL"],"parameters":[{"name":"contactId","in":"path","type":"string","required":true,"description":""},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"consentDetails":[{}],"consentMethod":"/v1.0.0/reference/lookups?virtualTableName=TCPA.CONSENT.METHOD","consentParty":"string","consentDate":"2024-01-01","extensions":{}}},"responses":{"200":"UsDeviceConsentResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"POST","path":"/party/us/customers/individuals","fullPath":"/api/v6.2.0/party/us/customers/individuals","operationId":"createUsIndividualCustomer","name":"Allows creation of an individual customer.","summary":"Create individual customer.","tags":["RETAIL"],"parameters":[{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"idDocument":[{}],"employment":[{}],"creditScore":[{}],"PreviousIdentification":[{}],"residenceInfo":[{}],"communication":[{}],"communicationDevices":[{}],"officePhoneNumbers":[{}],"faxIds":[{}],"riskClass":[{}],"overrideReason":[{}],"crProfileType":[{}],"otherOfficers":[{}],"overrideDetails":[{}],"inputter":[{}]}},"responses":{"200":"UsIndividualCustomerResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}}]},{"key":"party-us-customerservice-v6.3.0","title":"US Model Bank Customer management","version":"v6.3.0","description":"The customer service API allows to create, update and modify customer, contact details, address and beneficiary. Separate URIs are available for corporate and individual customers to update or retrieve specific information like address, secondary address, credit score, KYC, relation, beneficial owne","endpointCount":36,"endpoints":[{"method":"GET","path":"/party/us/customers","fullPath":"/api/v6.3.0/party/us/customers","operationId":"searchUsCustomer","name":"Search and retrieve customer information based on customer name, date of birth, date of incorporation, SSN or TIN, and mobile number","summary":"Search customer","tags":["RETAIL"],"parameters":[{"name":"customerId","in":"query","type":"string","required":false,"description":"Identifier of the customer"},{"name":"customerName","in":"query","type":"string","required":false,"description":"Indicates the name of the customer. Originator is the party who requests the payment cancellation."},{"name":"taxId","in":"query","type":"string","required":false,"description":"Holds the Customer's TAX/SSN Id."},{"name":"dateOfBirth","in":"query","type":"string","required":false,"description":"The date of birth of an individual customer"},{"name":"mobileNumber","in":"query","type":"string","required":false,"description":"Mobile number of the customer"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"UsCustomerResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/party/us/customers/{customerId}/scores","fullPath":"/api/v6.3.0/party/us/customers/{customerId}/scores","operationId":"getUsCustomerCreditscore","name":"Retrieve customer's credit score information received from credit agencies.","summary":"Retrieve customer credit scores","tags":["RETAIL"],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"Identifier of the customer"},{"name":"agencyId","in":"query","type":"string","required":false,"description":"Name of the agency that provided the credit score. Allowed values can be retrieved through getEbLookups for virtualTableName CREDIT.BUREAU"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"UsCustomerCreditscoreResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/party/us/customers/{customerId}/agencies/{agencyId}/scores","fullPath":"/api/v6.3.0/party/us/customers/{customerId}/agencies/{agencyId}/scores","operationId":"getUsCustomerCreditscoreByAgency","name":"Retrieves the credit score information available for a customer from the specific reporting agency provided in the URI.","summary":"Retrieve customer credit score by agency","tags":["RETAIL"],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"Identifier of the customer"},{"name":"agencyId","in":"path","type":"string","required":true,"description":"Name of the agency that provided the credit score. Allowed values can be retrieved through getEbLookups for virtualTableName CREDIT.BUREAU"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"UsCustomerCreditscoreByAgencyResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/party/us/customers/{customerId}/documents","fullPath":"/api/v6.3.0/party/us/customers/{customerId}/documents","operationId":"searchUsDocuments","name":"Search documents available for customer identification. Provides information on document reference, status, validity, issuer details, and version information.","summary":"Search customer documents","tags":["RETAIL"],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"Identifier of the customer"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"UsDocumentsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/party/us/customers/{customerId}/kyc","fullPath":"/api/v6.3.0/party/us/customers/{customerId}/kyc","operationId":"getUsCustomerKycandTax","name":"Retrieves KYC and tax information for a customer","summary":"Retrieve customer KYC and tax information","tags":["RETAIL"],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"Identifier of the customer"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"UsCustomerKycandTaxResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/party/us/customers/{customerId}/kyc","fullPath":"/api/v6.3.0/party/us/customers/{customerId}/kyc","operationId":"updateUsCustomerKycandTax","name":"Allows update to KYC and tax information for a customer","summary":"Update customer KYC and tax information","tags":["RETAIL"],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"Identifier of the customer"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"riskClass":[{}],"introducer":"string","contactDate":"2024-01-01","kycRelationship":"string","kycLastReviewDate":"2024-01-01","amlCheck":"NULL","amlResult":"NULL","amlLastResultDate":"2024-01-01","manualRiskClass":"string","overrideReason":"string","isKycComplete":"YES","taxCertificationType":"/v1.0.0/reference/lookups?virtualTableName=TAX.CERT.TYPE","foreignTin":"string","taxCertificationDate":"2024-01-01","reasonForMissingFtin":"/v1.0.0/reference/lookups?virtualTableName=FTIN.MIS.REASON"}},"responses":{"200":"UsCustomerKycandTaxResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/party/us/customers/{customerId}/primaryAddresses","fullPath":"/api/v6.3.0/party/us/customers/{customerId}/primaryAddresses","operationId":"getUsCustomerPrimaryAddress","name":"Retrieve customer primary address","summary":"Retrieve customer primary address","tags":["RETAIL"],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"Identifier of the customer"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"UsCustomerPrimaryAddressResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/party/us/customers/{customerId}/primaryAddresses","fullPath":"/api/v6.3.0/party/us/customers/{customerId}/primaryAddresses","operationId":"updateUsCustomerPrimaryAddress","name":"Update customer primary address","summary":"Update customer primary address","tags":["RETAIL"],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"Identifier of the customer"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"overrideDetails":[{}],"inputter":[{}],"dateTime":[{}],"addressLine1":"string","addressLine2":"string","city":"string","stateId":"/v1.0.0/reference/us/states","countyId":"/v1.0.0/reference/us/states/{stateId}/counties","zipCode":0.0,"zipPlusFour":0.0,"country":"/v1.0.0/reference/countries","addressStatus":"B","addressLocation":"string","addressPurpose":"CTC","recordStatus":"string"}},"responses":{"200":"UsCustomerPrimaryAddressResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/party/us/customers/secondaryAddresses/{addressReference}","fullPath":"/api/v6.3.0/party/us/customers/secondaryAddresses/{addressReference}","operationId":"updateUsCustomerSecondaryAddress","name":"Update existing address information for the customer.","summary":"Update secondary address","tags":["RETAIL"],"parameters":[{"name":"addressReference","in":"path","type":"string","required":true,"description":"Reference Id of address record"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"addressLine1":"string","addressLine2":"string","shortName":"string","city":"string","stateId":"/v1.0.0/reference/us/states","countyId":"/v1.0.0/reference/us/states/{stateId}/counties","zipCode":0.0,"zipPlusFour":0.0,"country":"/v1.0.0/reference/countries","customerContactIndicator":"YES","addressStatus":"B","taxAddressType":"/v1.0.0/reference/lookups?virtualTableName=IRS.ADDRESS.TYPE","addressPurpose":"CTC","extensions":{}}},"responses":{"200":"UsCustomerSecondaryAddressResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"DELETE","path":"/party/us/customers/secondaryAddresses/{addressReference}","fullPath":"/api/v6.3.0/party/us/customers/secondaryAddresses/{addressReference}","operationId":"deleteUsCustomerSecondaryAddress","name":"Remove customer's secondary address information","summary":"Remove customer's secondary address","tags":["RETAIL"],"parameters":[{"name":"addressReference","in":"path","type":"string","required":true,"description":"Reference Id of address record"},{"name":"payload","in":"body","type":"object","required":false,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}}},"responses":{"200":"UsCustomerSecondaryAddressResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"POST","path":"/party/us/customers/{customerId}/secondaryAddresses","fullPath":"/api/v6.3.0/party/us/customers/{customerId}/secondaryAddresses","operationId":"createUsCustomerSecondaryAddress","name":"Add new customer address information","summary":"Create secondary address","tags":["RETAIL"],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"Identifier of the customer"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"addressLine1":"string","addressLine2":"string","shortName":"string","name":"string","city":"string","stateId":"/v1.0.0/reference/us/states","countyId":"/v1.0.0/reference/us/states/{stateId}/counties","zipCode":0.0,"zipPlusFour":0.0,"country":"/v1.0.0/reference/countries","customerContactIndicator":"YES","addressStatus":"B","taxAddressType":"/v1.0.0/reference/lookups?virtualTableName=IRS.ADDRESS.TYPE","addressPurpose":"CTC","extensions":{}}},"responses":{"200":"UsCustomerSecondaryAddressResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/party/us/customers/{customerId}/addressPreferences","fullPath":"/api/v6.3.0/party/us/customers/{customerId}/addressPreferences","operationId":"getAddressPreferences","name":"Retrieves seasonal address preferences set for the customer. Provides the address carrier and the duration for which an address should be used as the primary address","summary":"Seasonal address details","tags":["RETAIL"],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"Identifier of the customer"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"AddressPreferencesResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"POST","path":"/party/us/customers/{customerId}/addressPreferences","fullPath":"/api/v6.3.0/party/us/customers/{customerId}/addressPreferences","operationId":"createAddressPreference","name":"Allows capturing alternate address for a customer to be used for mails during specific periods each year","summary":"Create alternate address ","tags":["RETAIL"],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"Identifier of the customer"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"alternateaddressperiod":[{}],"carrier":"string","defaultCarrier":"string","extensions":{}}},"responses":{"200":"AddressPreferenceResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/party/us/customers/{customerId}/addressPreferences","fullPath":"/api/v6.3.0/party/us/customers/{customerId}/addressPreferences","operationId":"updateAddressPreference","name":"Updates alternate address information for a customer","summary":"Update alternate address","tags":["RETAIL"],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"Identifier of the customer"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"alternateaddressperiod":[{}],"carrier":"string","defaultCarrier":"string","extensions":{}}},"responses":{"200":"AddressPreferenceResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/party/us/customers/{customerId}/beneficiaries","fullPath":"/api/v6.3.0/party/us/customers/{customerId}/beneficiaries","operationId":"getUsBeneficiary","name":"Retrieve list of beneficiaries created for a customer to perform account transfer, bill payments or wires. Information can be retrieved using customer id, debit account id, beneficiary nickname, account type, etc","summary":"Retrieve beneficiary information for a customer","tags":["RETAIL"],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"Identifier of the customer"},{"name":"beneficiaryInstituteName","in":"query","type":"string","required":false,"description":"Indicates the name of financial institution where the beneficiary account is held"},{"name":"beneficiaryAccountId","in":"query","type":"string","required":false,"description":"Unique account identifier of the beneficiary account number."},{"name":"beneficiaryNickName","in":"query","type":"string","required":false,"description":"Nickname of the beneficiary"},{"name":"accountWithBankSortCode","in":"query","type":"string","required":false,"description":"Bank sort code details with account"},{"name":"accountType","in":"query","type":"string","required":false,"description":"Groups the products based on their type, eg, Checking, Savings, CD etc,."},{"name":"beneficiaryCustomerId","in":"query","type":"string","required":false,"description":"Identifies the Customer who is to be the ultimate receiver of the funds transferred by the sending bank when this Beneficiary is not a bank."},{"name":"beneficiaryId","in":"query","type":"string","required":false,"description":"Indicates the reference of the financial institution that allows access to the beneficiary information"},{"name":"transactionType","in":"query","type":"string","required":false,"description":"Identifies the transaction type applicable to the transaction being processed, i.e. outward or inward payment. For example: ACPX, OTPX etc."},{"name":"preferredPaymentProduct","in":"query","type":"string","required":false,"description":"Preferred payment product can be specified for Beneficiary. This will be used for defaulting the payment product for specific beneficiary. "},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"UsBeneficiaryResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"POST","path":"/party/us/customers/{customerId}/beneficiaries","fullPath":"/api/v6.3.0/party/us/customers/{customerId}/beneficiaries","operationId":"createUsBeneficiary","name":"Create a beneficiary for account transfers or bill payment","summary":"Create an ACH beneficiary","tags":["RETAIL"],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"Identifier of the customer"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"beneficiaryAccountId":"string","beneficiaryNickName":"string","accountWithBankSortCode":"string","accountType":"CHECKING","beneficiaryCustomerId":"string","paymentDetails":"string","beneficiaryOtherIdType":"ORGANISATION","beneficiaryOtherId":"string","preferredPaymentProduct":"string","recordStatus":"string","currNo":"string","inputter":"string","dateTime":"2024-01-01","authoriser":"string","deptCode":"string"}},"responses":{"200":"UsBeneficiaryResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/party/us/customers/beneficiaries/{beneficiaryId}","fullPath":"/api/v6.3.0/party/us/customers/beneficiaries/{beneficiaryId}","operationId":"updateUsBeneficiary","name":"Update beneficiary created for account transfers or bill payment","summary":"Update ACH beneficiary","tags":["RETAIL"],"parameters":[{"name":"beneficiaryId","in":"path","type":"string","required":true,"description":"Indicates the reference of the financial institution that allows access to the beneficiary information"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"beneficiaryAccountId":"string","beneficiaryNickName":"string","accountWithBankSortCode":"string","accountType":"CHECKING","beneficiaryCustomerId":"string","paymentDetails":"string","beneficiaryOtherIdType":"ORGANISATION","beneficiaryOtherId":"string","preferredPaymentProduct":"string","recordStatus":"string","currNo":"string","inputter":"string","dateTime":"2024-01-01","authoriser":"string","deptCode":"string"}},"responses":{"200":"UsBeneficiaryResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"POST","path":"/party/us/customers/{customerId}/beneficiaries/wires","fullPath":"/api/v6.3.0/party/us/customers/{customerId}/beneficiaries/wires","operationId":"createUsWiresBeneficiary","name":"Create beneficiary information for generating a wire transfer","summary":"Creates beneficiary for wire transfers","tags":["RETAIL"],"parameters":[{"name":"customerId","in":"path","type":"number","required":true,"description":"Identifier of the customer"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"beneficiaryNickNames":[{}],"beneficiaryPaymentCountryId":"string","beneficiaryAccountId":"string","accountWithBankSortCode":"string","accountType":"@ref:reference-us-sortcodes-services","beneficiaryInstituteName":"string","beneficiaryInstituteBranchName":"string","beneficiaryInstituteAddressLine1":"string","beneficiaryInstituteAddressLine2":"string","beneficiaryInstituteAddressLine3":0.0,"beneficiaryInstituteCountryCode":"string","beneficiaryCustomerId":"string","beneficiaryShortName":"string","beneficiaryAddressLine1":"string","beneficiaryAddressLine2":"string"}},"responses":{"200":"UsWiresBeneficiaryResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/party/us/customers/beneficiaries/{beneficiaryId}/wires","fullPath":"/api/v6.3.0/party/us/customers/beneficiaries/{beneficiaryId}/wires","operationId":"updateUsWiresBeneficiary","name":"Updates routing number, bank details or the payee details of a beneficiary set up for wire transfers","summary":"Updates existing wire payment beneficiary","tags":["RETAIL"],"parameters":[{"name":"beneficiaryId","in":"path","type":"string","required":true,"description":"Indicates the reference of the financial institution that allows access to the beneficiary information"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"beneficiaryNickNames":[{}],"beneficiaryPaymentCountryId":"string","beneficiaryAccountId":"string","accountWithBankSortCode":"string","accountType":"@ref:reference-us-sortcodes-services","beneficiaryInstituteName":"string","beneficiaryInstituteBranchName":"string","beneficiaryInstituteAddressLine1":"string","beneficiaryInstituteAddressLine2":"string","beneficiaryInstituteAddressLine3":0.0,"beneficiaryInstituteCountryCode":"string","beneficiaryCustomerId":"string","beneficiaryShortName":"string","beneficiaryAddressLine1":"string","beneficiaryAddressLine2":"string"}},"responses":{"200":"UsWiresBeneficiaryResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/party/us/customers/{customerId}/deliveryPreferences","fullPath":"/api/v6.3.0/party/us/customers/{customerId}/deliveryPreferences","operationId":"getUsDeliveryPreference","name":"Retrieves all available mail addresses for a customer along with information on the purpose of the address (primary, office, etc,.), internal address reference.","summary":"Retrieves all available mail addresses for a customer along with information on the purpose of the address (primary, office, etc,.), internal address reference.","tags":["RETAIL"],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"UsDeliveryPreferenceResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/party/us/customers/{customerId}/kyc/dueDiligences","fullPath":"/api/v6.3.0/party/us/customers/{customerId}/kyc/dueDiligences","operationId":"getUsPoliticalCustomer","name":"Retrieves the list of customers who are exposed as political person.","summary":"Retrieves the list of customers who are exposed as political person.","tags":["RETAIL"],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"Identifier of the customer"},{"name":"customerName","in":"query","type":"string","required":false,"description":"Indicates the name of the customer. Originator is the party who requests the payment cancellation."},{"name":"dateOfBirth","in":"query","type":"string","required":false,"description":"The date of birth of an individual customer"},{"name":"mobileNumber","in":"query","type":"string","required":false,"description":"Mobile number of the customer"},{"name":"emailId","in":"query","type":"string","required":false,"description":"Contains the email identifier of the customer"},{"name":"taxId","in":"query","type":"string","required":false,"description":"Holds the Customer's TAX/SSN Id."},{"name":"customerStatus","in":"query","type":"string","required":false,"description":"The internal bank status of a customer"},{"name":"accountOfficer","in":"query","type":"string","required":false,"description":"Identifier of Department Account Officer"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"UsPoliticalCustomerResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"PUT","path":"/party/us/customers/{customerId}/kyc/dueDiligences","fullPath":"/api/v6.3.0/party/us/customers/{customerId}/kyc/dueDiligences","operationId":"updateUsceddKyc","name":"Update enhanced due diligence and political information about any \"Customer\" which the bank has dealings.","summary":"Update enhanced due diligence and political information about any \"Customer\" which the bank has dealings.","tags":["RETAIL"],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"Identifier of the customer"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"accountTypes":[{}],"incomingTransactionCountries":[{}],"outgoingTransactionCountries":[{}],"lendingLinesOfCreditCountries":[{}],"lettersOfCreditCountries":[{}],"exportCreditCountries":[{}],"cashCollateralLoanCountries":[{}],"sourceOfFunds":[{}],"overrideDetails":[{}],"inputter":[{}],"dateTime":[{}],"politicallyExposedForeignPerson":"string","politicalPosition":"string","kycExempt":"string","kycExemptReason":"string"}},"responses":{"200":"UsceddKycResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/party/us/customers/{customerId}/individuals","fullPath":"/api/v6.3.0/party/us/customers/{customerId}/individuals","operationId":"getUsIndividualCustomer","name":"Retrieves individual customer information. Unless there is a specific set of information to be updated for which a separate URIs exists, this generic URI can be used where all available information for an individual customer can be retrieved.","summary":"Retrieve individual customer information","tags":["RETAIL"],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"Identifier of the customer"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"UsIndividualCustomerResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/party/us/customers/{customerId}/individuals","fullPath":"/api/v6.3.0/party/us/customers/{customerId}/individuals","operationId":"updateUsIndividualCustomer","name":"Updates individual customer. Unless there is specific set of information to be updated for which a separate URIs exists, this generic URI can be used where all information for an individual customer can be updated.","summary":"Update individual customer. ","tags":["RETAIL"],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":""},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"idDocument":[{}],"employment":[{}],"creditScore":[{}],"PreviousIdentification":[{}],"residenceInfo":[{}],"communication":[{}],"riskClass":[{}],"overrideReason":[{}],"crProfileType":[{}],"otherOfficers":[{}],"overrideDetails":[{}],"inputter":[{}],"dateTime":[{}],"specialNeed":"Y","title":"string"}},"responses":{"200":"UsIndividualCustomerResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"POST","path":"/party/us/customers/corporates/relations","fullPath":"/api/v6.3.0/party/us/customers/corporates/relations","operationId":"createUsCorporateCustomerRelation","name":"Allows to create a new party relationship for the corporate customer","summary":"Allows to create a new party relationship for the corporate customer","tags":["RETAIL"],"parameters":[{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"partyDisplayNames":[{}],"partyRelationships":[{}],"customerGroupId":"string","ownershipRuleId":"/v1.0.0/reference/us/beneficialOwnerTypes","noOwnerGt25Percent":"YES","otherOwnersLt25PercentFlag":"YES","certifierName":"string","certifierTitle":"string","additionalTitle":"string","certificationDate":"string","customerContactIndicator":"YES","extensions":{}}},"responses":{"200":"UsCorporateCustomerRelationResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"POST","path":"/party/us/customers/individuals/relations","fullPath":"/api/v6.3.0/party/us/customers/individuals/relations","operationId":"createUsIndividualCustomerRelation","name":"Allows to create a new party relationship for the individual customer","summary":"Allows to create a new party relationship for the individual customer","tags":["RETAIL"],"parameters":[{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"partyDisplayNames":[{}],"partyRelationships":[{}],"customerGroupId":"string","ownershipRuleId":"/v1.0.0/reference/us/beneficialOwnerTypes","noOwnerGt25Percent":"YES","otherOwnersLt25PercentFlag":"YES","certifierName":"string","certifierTitle":"string","additionalTitle":"string","certificationDate":"string","customerContactIndicator":"YES","extensions":{}}},"responses":{"200":"UsIndividualCustomerRelationResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/party/us/customers/relations/{relationId}","fullPath":"/api/v6.3.0/party/us/customers/relations/{relationId}","operationId":"updateUsCustomerRelation","name":"Allows to update the party relationship for the customer","summary":"Allows to update the party relationship for the customer","tags":["RETAIL"],"parameters":[{"name":"relationId","in":"path","type":"string","required":true,"description":""},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"partyDisplayNames":[{}],"partyRelationships":[{}],"customerGroupId":"string","ownershipRuleId":"/v1.0.0/reference/us/beneficialOwnerTypes","noOwnerGt25Percent":"YES","otherOwnersLt25PercentFlag":"YES","certifierName":"string","certifierTitle":"string","additionalTitle":"string","certificationDate":"string","customerContactIndicator":"YES","extensions":{}}},"responses":{"200":"UsCustomerRelationResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/party/us/customers/{customerId}/relations","fullPath":"/api/v6.3.0/party/us/customers/{customerId}/relations","operationId":"getUsCustomerRelation","name":"Retrieves the relationship details for a given customer","summary":"Retrieves the relationship details for a given customer","tags":["RETAIL"],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"Identifier of the customer"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"UsCustomerRelationResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/party/us/customers/{customerId}/contacts","fullPath":"/api/v6.3.0/party/us/customers/{customerId}/contacts","operationId":"getUsCustomerAddresslist","name":"Retrieves all available mail addresses for a customer along with information on the purpose of the address(primary, office, etc,.), internal address reference.","summary":"Retrieve customer mailing addresses","tags":["RETAIL"],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"UsCustomerAddresslistResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/party/us/customers/{customerId}/contacts","fullPath":"/api/v6.3.0/party/us/customers/{customerId}/contacts","operationId":"createUsCustomerContactDetail","name":"Create or update customer phone, office phone, mobile, email or fax numbers and the consent for sharing contact information with financial institute's marketing partners.","summary":"Create or update customer contact and consent information","tags":["RETAIL"],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":""},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"contactDetails":[{}],"customercontactflag":"string","extensions":{}}},"responses":{"200":"UsCustomerContactDetailResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/party/us/customers/contacts/{contactId}/consents","fullPath":"/api/v6.3.0/party/us/customers/contacts/{contactId}/consents","operationId":"getUsDeviceConsent","name":"Retrieve customer consent for the requested contact information.","summary":"Retrieve consent information for contacts.","tags":["RETAIL"],"parameters":[{"name":"contactId","in":"path","type":"string","required":true,"description":"Indicates the reference number/text for the contacting customer. Can be phone number, telephone, fax, email or mobile linked to a customer."},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"UsDeviceConsentResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"PUT","path":"/party/us/customers/contacts/{contactId}/consents","fullPath":"/api/v6.3.0/party/us/customers/contacts/{contactId}/consents","operationId":"updateUsDeviceConsent","name":"Update consent information like marketing consent, do not call and general consent. As part of consent, preferred time to call, consent log like the method how the consent was collected, the customer who gave the consent and the date when consent was received is also captured.","summary":"Update consent information for contact devices.","tags":["RETAIL"],"parameters":[{"name":"contactId","in":"path","type":"string","required":true,"description":""},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"consentDetails":[{}],"consentMethod":"/v1.0.0/reference/lookups?virtualTableName=TCPA.CONSENT.METHOD","consentParty":"string","consentDate":"2024-01-01","extensions":{}}},"responses":{"200":"UsDeviceConsentResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"POST","path":"/party/us/customers/individuals","fullPath":"/api/v6.3.0/party/us/customers/individuals","operationId":"createUsIndividualCustomer","name":"Allows creation of an individual customer.","summary":"Create individual customer.","tags":["RETAIL"],"parameters":[{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"idDocument":[{}],"employment":[{}],"creditScore":[{}],"PreviousIdentification":[{}],"residenceInfo":[{}],"communication":[{}],"communicationDevices":[{}],"officePhoneNumbers":[{}],"faxIds":[{}],"riskClass":[{}],"overrideReason":[{}],"crProfileType":[{}],"otherOfficers":[{}],"overrideDetails":[{}],"inputter":[{}]}},"responses":{"200":"UsIndividualCustomerResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/party/us/customers/{customerId}/corporates","fullPath":"/api/v6.3.0/party/us/customers/{customerId}/corporates","operationId":"getUsCorporateCustomer","name":"Retrieves corporate customer information. Unless there is a specific set of information to be updated for which a separate APIs exists, this generic API can be used where all available information can be retrieved.","summary":"Retrieve corporate customer information","tags":["RETAIL"],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"Identifier of the customer"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"UsCorporateCustomerResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/party/us/customers/{customerId}/corporates","fullPath":"/api/v6.3.0/party/us/customers/{customerId}/corporates","operationId":"updateUsCorporateCustomer","name":"Updates corporate customer information. Unless there is a specific set of information to be updated for which a separate URIs exists, this generic URI can be used where all available information can be updated","summary":"Update corporate customer information","tags":["RETAIL"],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"Identifier of the customer"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"idDocument":[{}],"PreviousIdentification":[{}],"communication":[{}],"riskClass":[{}],"overrideReason":[{}],"crProfileType":[{}],"otherOfficers":[{}],"overrideDetails":[{}],"inputter":[{}],"dateTime":[{}],"nationalityId":"string","customerName":"string","customerNameAdditional":"string","shortName":"string","birthIncorpDate":"2024-01-01"}},"responses":{"200":"UsCorporateCustomerResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"POST","path":"/party/us/customers/corporates","fullPath":"/api/v6.3.0/party/us/customers/corporates","operationId":"createUsCorporateCustomer","name":"Allows creation of a corporate customer","summary":"Create corporate customer","tags":["RETAIL"],"parameters":[{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"idDocument":[{}],"PreviousIdentification":[{}],"communication":[{}],"communicationDevices":[{}],"officePhoneNumbers":[{}],"faxIds":[{}],"riskClass":[{}],"overrideReason":[{}],"crProfileType":[{}],"otherOfficers":[{}],"overrideDetails":[{}],"inputter":[{}],"dateTime":[{}],"nationalityId":"string","customerName":"string"}},"responses":{"200":"UsCorporateCustomerResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}}]},{"key":"party-userAdmin-service-v1.0.0","title":"UserAdministration","version":"v1.0.0","description":"User Administration","endpointCount":18,"endpoints":[{"method":"POST","path":"/party/customers/externalUser","fullPath":"/api/v1.0.0/v1.0.0/party/customers/externalUser","operationId":"createExternalUserCustomer","name":"","summary":"","tags":[],"parameters":[{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":""},{"name":"companyId","in":"header","type":"string","required":false,"description":""}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"email":[{}],"sms":[{}],"legalDoc":[{}],"street":[{}],"postCode":[{}],"townCountry":[{}],"country":[{}],"relation":[{}],"override":[{}],"title":"string","givenName":"string","lastName":"string","gender":"string","languageId":"string","dateOfBirth":"2024-01-01"}},"responses":{"200":"ExternalUserCustomerResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/party/externalUsers","fullPath":"/api/v1.0.0/v1.0.0/party/externalUsers","operationId":"getExternalUsers","name":"","summary":"","tags":[],"parameters":[{"name":"externalUserId","in":"query","type":"string","required":false,"description":"The identifier of the external user"},{"name":"externalUserName","in":"query","type":"string","required":false,"description":"External or Digital Channel User Name"},{"name":"arrangementId","in":"query","type":"string","required":false,"description":"The identifier of the arrangement"},{"name":"subArrangementId","in":"query","type":"string","required":false,"description":"The identifier of the subarrangement"},{"name":"channelId","in":"query","type":"string","required":false,"description":"Id of the (digital) channel"},{"name":"externalUserStatus","in":"query","type":"string","required":false,"description":"External User Access status. Can be Active,  Inactive, Barred, Initiated"},{"name":"customerId","in":"query","type":"string","required":false,"description":"The identifier of the customer"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from t24 on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":""},{"name":"companyId","in":"header","type":"string","required":false,"description":""}],"requestBodyExample":null,"responses":{"200":"ExternalUsersResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"POST","path":"/party/externalUsers","fullPath":"/api/v1.0.0/v1.0.0/party/externalUsers","operationId":"createExternalUser","name":"","summary":"","tags":[],"parameters":[{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":""},{"name":"companyId","in":"header","type":"string","required":false,"description":""}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"channels":[{}],"externalUserName":"string","customerId":"string","companyId":"string","authenticationServerUpdate":true,"externalUserSignMethod":"string","languageId":"string","dateFormat":"2024-01-01","override":"string"}},"responses":{"200":"ExternalUserResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/party/externalUsers/{externalUserId}","fullPath":"/api/v1.0.0/v1.0.0/party/externalUsers/{externalUserId}","operationId":"getExternalUser","name":"","summary":"","tags":[],"parameters":[{"name":"externalUserId","in":"path","type":"string","required":true,"description":"The identifier of the external user"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from t24 on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":""},{"name":"companyId","in":"header","type":"string","required":false,"description":""}],"requestBodyExample":null,"responses":{"200":"ExternalUserResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"PUT","path":"/party/externalUsers/{externalUserId}","fullPath":"/api/v1.0.0/v1.0.0/party/externalUsers/{externalUserId}","operationId":"updateExternalUser","name":"","summary":"","tags":[],"parameters":[{"name":"externalUserId","in":"path","type":"string","required":true,"description":""},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":""},{"name":"companyId","in":"header","type":"string","required":false,"description":""}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"channels":[{}],"externalUserName":"string","customerId":"string","companyId":"string","authenticationServerUpdate":true,"externalUserSignMethod":"string","languageId":"string","dateFormat":"2024-01-01","override":"string"}},"responses":{"200":"ExternalUserResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"DELETE","path":"/party/externalUsers/{externalUserId}","fullPath":"/api/v1.0.0/v1.0.0/party/externalUsers/{externalUserId}","operationId":"deleteExternalUser","name":"","summary":"","tags":[],"parameters":[{"name":"externalUserId","in":"path","type":"string","required":true,"description":""},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":""},{"name":"companyId","in":"header","type":"string","required":false,"description":""}],"requestBodyExample":null,"responses":{"200":"ExternalUserResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"POST","path":"/party/externalUserApprovals","fullPath":"/api/v1.0.0/v1.0.0/party/externalUserApprovals","operationId":"initiateExternalUser","name":"","summary":"","tags":[],"parameters":[{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":""},{"name":"companyId","in":"header","type":"string","required":false,"description":""}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"channels":[{}],"externalUserName":"string","customerId":"string","companyId":"string","authenticationServerUpdate":true,"externalUserSignMethod":"string","languageId":"string","dateFormat":"2024-01-01","override":"string"}},"responses":{"200":"ExternalUserResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/party/externalUserApprovals/amendments/{externalUserId}","fullPath":"/api/v1.0.0/v1.0.0/party/externalUserApprovals/amendments/{externalUserId}","operationId":"amendExternalUser","name":"","summary":"","tags":[],"parameters":[{"name":"externalUserId","in":"path","type":"string","required":true,"description":""},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":""},{"name":"companyId","in":"header","type":"string","required":false,"description":""}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"channels":[{}],"externalUserName":"string","customerId":"string","companyId":"string","authenticationServerUpdate":true,"externalUserSignMethod":"string","languageId":"string","dateFormat":"2024-01-01","override":"string"}},"responses":{"200":"ExternalUserResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/party/externalUserApprovals/{externalUserId}","fullPath":"/api/v1.0.0/v1.0.0/party/externalUserApprovals/{externalUserId}","operationId":"approveExternalUser","name":"","summary":"","tags":[],"parameters":[{"name":"externalUserId","in":"path","type":"string","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":""},{"name":"companyId","in":"header","type":"string","required":false,"description":""}],"requestBodyExample":null,"responses":{"200":"ExternalUserResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"DELETE","path":"/party/externalUserApprovals/{externalUserId}","fullPath":"/api/v1.0.0/v1.0.0/party/externalUserApprovals/{externalUserId}","operationId":"rejectExternalUser","name":"","summary":"","tags":[],"parameters":[{"name":"externalUserId","in":"path","type":"string","required":true,"description":""},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":""},{"name":"companyId","in":"header","type":"string","required":false,"description":""}],"requestBodyExample":null,"responses":{"200":"ExternalUserResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"DELETE","path":"/party/externalUserRequests/{externalUserId}","fullPath":"/api/v1.0.0/v1.0.0/party/externalUserRequests/{externalUserId}","operationId":"initiateExternalUserDelete","name":"","summary":"","tags":[],"parameters":[{"name":"externalUserId","in":"path","type":"string","required":true,"description":""},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":""},{"name":"companyId","in":"header","type":"string","required":false,"description":""}],"requestBodyExample":null,"responses":{"200":"ExternalUserDeleteResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/party/users/userProfiles/","fullPath":"/api/v1.0.0/v1.0.0/party/users/userProfiles/","operationId":"getUserProfile","name":"","summary":"","tags":[],"parameters":[{"name":"userId","in":"query","type":"string","required":false,"description":"The user name to be loaded for reporting jobs during Close of Business If no user name is entered in this field then the default profile for the user 'operator' is used."},{"name":"userSignOnName","in":"query","type":"string","required":false,"description":""},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from t24 on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":""},{"name":"companyId","in":"header","type":"string","required":false,"description":""}],"requestBodyExample":null,"responses":{"200":"UserProfileResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/party/externalUsers/externalUserApprovals","fullPath":"/api/v1.0.0/v1.0.0/party/externalUsers/externalUserApprovals","operationId":"getExternalUserApprovals","name":"","summary":"","tags":[],"parameters":[{"name":"externalUserId","in":"query","type":"string","required":false,"description":"The identifier of the external user"},{"name":"externalUserName","in":"query","type":"string","required":false,"description":"External or Digital Channel User Name"},{"name":"customerId","in":"query","type":"string","required":false,"description":"The identifier of the customer"},{"name":"arrangementId","in":"query","type":"string","required":false,"description":"The identifier of the arrangement"},{"name":"subArrangementId","in":"query","type":"string","required":false,"description":""},{"name":"channelId","in":"query","type":"string","required":false,"description":"Id of the (digital) channel"},{"name":"externalUserStatus","in":"query","type":"string","required":false,"description":"External User Access status. Can be Active,  Inactive, Barred, Initiated"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from t24 on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":""},{"name":"companyId","in":"header","type":"string","required":false,"description":""}],"requestBodyExample":null,"responses":{"200":"ExternalUserApprovalsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/party/customers/{customerId}/externalUsers","fullPath":"/api/v1.0.0/v1.0.0/party/customers/{customerId}/externalUsers","operationId":"getCustomerExternalUsers","name":"","summary":"","tags":[],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"The identifier of the customer"},{"name":"externalUserId","in":"query","type":"string","required":false,"description":"The identifier of the external user"},{"name":"externalUserName","in":"query","type":"string","required":false,"description":"External or Digital Channel User Name"},{"name":"arrangementId","in":"query","type":"string","required":false,"description":"The identifier of the arrangement"},{"name":"channelId","in":"query","type":"string","required":false,"description":"Id of the (digital) channel"},{"name":"externalUserStatus","in":"query","type":"string","required":false,"description":"External User Access status. Can be Active,  Inactive, Barred, Initiated"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from t24 on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":""},{"name":"companyId","in":"header","type":"string","required":false,"description":""}],"requestBodyExample":null,"responses":{"200":"CustomerExternalUsersResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/party/customers/{customerId}/relationships","fullPath":"/api/v1.0.0/v1.0.0/party/customers/{customerId}/relationships","operationId":"getCustomerRelations","name":"","summary":"","tags":[],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"The identifier of the customer"},{"name":"relationType","in":"query","type":"string","required":false,"description":""},{"name":"excludeCustomerType","in":"query","type":"string","required":false,"description":""},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from t24 on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":""},{"name":"companyId","in":"header","type":"string","required":false,"description":""}],"requestBodyExample":null,"responses":{"200":"CustomerRelationsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/party/customers/{customerId}","fullPath":"/api/v1.0.0/v1.0.0/party/customers/{customerId}","operationId":"getCustomer","name":"","summary":"","tags":[],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"The identifier of the customer"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from t24 on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":""},{"name":"companyId","in":"header","type":"string","required":false,"description":""}],"requestBodyExample":null,"responses":{"200":"CustomerResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/party/customers","fullPath":"/api/v1.0.0/v1.0.0/party/customers","operationId":"getCustomers","name":"","summary":"","tags":[],"parameters":[{"name":"customerId","in":"query","type":"string","required":false,"description":"The identifier of the customer"},{"name":"customerMnemonic","in":"query","type":"string","required":false,"description":"Specifies an alternative easy means of referencing the Customer"},{"name":"customerName","in":"query","type":"string","required":false,"description":"Name of the customer"},{"name":"firstName","in":"query","type":"string","required":false,"description":""},{"name":"lastName","in":"query","type":"string","required":false,"description":"The last name of an individual customer"},{"name":"street","in":"query","type":"string","required":false,"description":"The first line of the base address of a customer or prospect"},{"name":"addressCity","in":"query","type":"string","required":false,"description":"The town and/or city component of the base address of a customer"},{"name":"postCode","in":"query","type":"string","required":false,"description":"The postal code of the customer or prospect"},{"name":"country","in":"query","type":"string","required":false,"description":"The country component of the base address of a customer"},{"name":"dateOfBirth","in":"query","type":"string","required":false,"description":"The date of birth of an individual customer"},{"name":"email","in":"query","type":"string","required":false,"description":"Email Identifier of the Customer"},{"name":"phoneNumber","in":"query","type":"string","required":false,"description":"The phone number of the customer or prospect"},{"name":"mobilePhoneNumber","in":"query","type":"string","required":false,"description":""},{"name":"customerType","in":"query","type":"string","required":false,"description":""},{"name":"customerStatus","in":"query","type":"string","required":false,"description":"The internal bank status of a customer"},{"name":"industryId","in":"query","type":"string","required":false,"description":"An institution-defined identifier of the industry in which the customer is trading, operating or is associated with"},{"name":"sectorId","in":"query","type":"string","required":false,"description":"An institution-defined identifier of the type of customer"},{"name":"nationalityId","in":"query","type":"string","required":false,"description":"The identifier of the nationality of a customer"},{"name":"residenceId","in":"query","type":"string","required":false,"description":"The identifier of the country of residence of a customer"},{"name":"accountOfficerId","in":"query","type":"string","required":false,"description":"The identifier of the\u00ef\u00bf\u00bddepartment head or specific account officer responsible for the customer"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from t24 on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":""},{"name":"companyId","in":"header","type":"string","required":false,"description":""}],"requestBodyExample":null,"responses":{"200":"CustomersResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/party/externalUserApprovals/viewExternalUser/{externalUserId}","fullPath":"/api/v1.0.0/v1.0.0/party/externalUserApprovals/viewExternalUser/{externalUserId}","operationId":"viewExternalUser","name":"","summary":"","tags":[],"parameters":[{"name":"externalUserId","in":"path","type":"string","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":""},{"name":"companyId","in":"header","type":"string","required":false,"description":""}],"requestBodyExample":null,"responses":{"200":"ExternalUserResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}}]},{"key":"party-userAdmin-service-v1.0.1","title":"External User Administration","version":"v1.0.1","description":"API to create, update and manage the external user profiles for user administration","endpointCount":15,"endpoints":[{"method":"POST","path":"/party/customers/externalUser","fullPath":"/api/v1.0.1/party/customers/externalUser","operationId":"createExternalUserCustomer","name":"Create an External User for  customer","summary":"Create External User For Customer","tags":[],"parameters":[{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"email":[{}],"sms":[{}],"legalDoc":[{}],"street":[{}],"postCode":[{}],"townCountry":[{}],"country":[{}],"relation":[{}],"override":[{}],"title":"string","givenName":"string","lastName":"string","gender":"string","languageId":"string","dateOfBirth":"2024-01-01"}},"responses":{"200":"ExternalUserCustomerResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/party/externalUsers/{externalUserId}","fullPath":"/api/v1.0.1/party/externalUsers/{externalUserId}","operationId":"getExternalUser","name":"Retrieves an External User","summary":"Retrieve External User","tags":[],"parameters":[{"name":"externalUserId","in":"path","type":"string","required":true,"description":"Contains the external user identifier for which the consent is created."},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"ExternalUserResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"POST","path":"/party/externalUsers/{externalUserId}","fullPath":"/api/v1.0.1/party/externalUsers/{externalUserId}","operationId":"createExternalUser","name":"Create an External User","summary":"Create External User","tags":[],"parameters":[{"name":"externalUserId","in":"path","type":"string","required":true,"description":"Contains the external user identifier for which the consent is created."},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"channels":[{}],"externalUserName":"string","customerId":"string","companyId":"string","authenticationServerUpdate":true,"externalUserSignMethod":"string","languageId":"string","dateFormat":"string","override":"string"}},"responses":{"200":"ExternalUserResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/party/externalUsers/{externalUserId}","fullPath":"/api/v1.0.1/party/externalUsers/{externalUserId}","operationId":"updateExternalUser","name":"Update an External User","summary":"Update External User","tags":[],"parameters":[{"name":"externalUserId","in":"path","type":"string","required":true,"description":"Contains the external user identifier for which the consent is created."},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"channels":[{}],"externalUserName":"string","customerId":"string","companyId":"string","authenticationServerUpdate":true,"externalUserSignMethod":"string","languageId":"string","dateFormat":"string","override":"string"}},"responses":{"200":"ExternalUserResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"DELETE","path":"/party/externalUsers/{externalUserId}","fullPath":"/api/v1.0.1/party/externalUsers/{externalUserId}","operationId":"deleteExternalUser","name":"Delete an External User","summary":"Delete External User","tags":[],"parameters":[{"name":"externalUserId","in":"path","type":"string","required":true,"description":"Contains the external user identifier for which the consent is created."},{"name":"payload","in":"body","type":"object","required":false,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}}},"responses":{"200":"ExternalUserResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"POST","path":"/party/externalUserApprovals","fullPath":"/api/v1.0.1/party/externalUserApprovals","operationId":"initiateExternalUser","name":"Initiate an External User","summary":"Initiate External User","tags":[],"parameters":[{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"channels":[{}],"externalUserName":"string","customerId":"string","companyId":"string","authenticationServerUpdate":true,"externalUserSignMethod":"string","languageId":"string","dateFormat":"string","override":"string"}},"responses":{"200":"ExternalUserResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/party/externalUserApprovals/amendments/{externalUserId}","fullPath":"/api/v1.0.1/party/externalUserApprovals/amendments/{externalUserId}","operationId":"amendExternalUser","name":"Amend an External User","summary":"Amend External User","tags":[],"parameters":[{"name":"externalUserId","in":"path","type":"string","required":true,"description":"Contains the external user identifier for which the consent is created."},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"channels":[{}],"externalUserName":"string","customerId":"string","companyId":"string","authenticationServerUpdate":true,"externalUserSignMethod":"string","languageId":"string","dateFormat":"string","override":"string"}},"responses":{"200":"ExternalUserResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/party/externalUserApprovals/{externalUserId}","fullPath":"/api/v1.0.1/party/externalUserApprovals/{externalUserId}","operationId":"approveExternalUser","name":"Approve an External User","summary":"Approve External User","tags":[],"parameters":[{"name":"externalUserId","in":"path","type":"string","required":true,"description":"Contains the external user identifier for which the consent is created."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"ExternalUserResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"DELETE","path":"/party/externalUserApprovals/{externalUserId}","fullPath":"/api/v1.0.1/party/externalUserApprovals/{externalUserId}","operationId":"rejectExternalUser","name":"Rejects an NAU External User record","summary":"Reject External User","tags":[],"parameters":[{"name":"externalUserId","in":"path","type":"string","required":true,"description":"Contains the external user identifier for which the consent is created."},{"name":"payload","in":"body","type":"object","required":false,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}}},"responses":{"200":"ExternalUserResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"DELETE","path":"/party/externalUserRequests/{externalUserId}","fullPath":"/api/v1.0.1/party/externalUserRequests/{externalUserId}","operationId":"initiateExternalUserDelete","name":"Initiates External User delete by moving it to NAU status","summary":"Initiate External User Delete","tags":[],"parameters":[{"name":"externalUserId","in":"path","type":"string","required":true,"description":"Contains the external user identifier for which the consent is created."},{"name":"payload","in":"body","type":"object","required":false,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}}},"responses":{"200":"ExternalUserDeleteResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/party/externalUsers/externalUserApprovals","fullPath":"/api/v1.0.1/party/externalUsers/externalUserApprovals","operationId":"getExternalUserApprovals","name":"Retrieves NAU External User records","summary":"Retrieve Unauthorised External User","tags":[],"parameters":[{"name":"externalUserId","in":"query","type":"string","required":false,"description":"Contains the external user identifier for which the consent is created."},{"name":"externalUserName","in":"query","type":"string","required":false,"description":"External or Digital Channel User Name"},{"name":"customerId","in":"query","type":"string","required":false,"description":"Identifier of the customer"},{"name":"arrangementId","in":"query","type":"string","required":false,"description":"Indicates an unique identifier of an account"},{"name":"subArrangementId","in":"query","type":"string","required":false,"description":"The subset of Master arrangement."},{"name":"channelId","in":"query","type":"string","required":false,"description":"Id of the (digital) channel"},{"name":"externalUserStatus","in":"query","type":"string","required":false,"description":"External User Access status. Can be Active,  Inactive, Barred, Initiated"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"ExternalUserApprovalsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/party/customers/{customerId}/externalUsers","fullPath":"/api/v1.0.1/party/customers/{customerId}/externalUsers","operationId":"getCustomerExternalUsers","name":"Retrieves the list of attached internet banking or external users for a customer","summary":"Retrieve Customer External Users","tags":[],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"Identifier of the customer"},{"name":"externalUserId","in":"query","type":"string","required":false,"description":"Contains the external user identifier for which the consent is created."},{"name":"externalUserName","in":"query","type":"string","required":false,"description":"External or Digital Channel User Name"},{"name":"arrangementId","in":"query","type":"string","required":false,"description":"Indicates an unique identifier of an account"},{"name":"channelId","in":"query","type":"string","required":false,"description":"Id of the (digital) channel"},{"name":"externalUserStatus","in":"query","type":"string","required":false,"description":"External User Access status. Can be Active,  Inactive, Barred, Initiated"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"CustomerExternalUsersResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/party/externalUsers","fullPath":"/api/v1.0.1/party/externalUsers","operationId":"getExternalUsers","name":"Retrieves the External Users","summary":"Retrieve External Users","tags":[],"parameters":[{"name":"externalUserId","in":"query","type":"string","required":false,"description":"Contains the external user identifier for which the consent is created."},{"name":"externalUserName","in":"query","type":"string","required":false,"description":"External or Digital Channel User Name"},{"name":"arrangementId","in":"query","type":"string","required":false,"description":"Indicates an unique identifier of an account"},{"name":"subArrangementId","in":"query","type":"string","required":false,"description":"The subset of Master arrangement."},{"name":"channelId","in":"query","type":"string","required":false,"description":"Id of the (digital) channel"},{"name":"externalUserStatus","in":"query","type":"string","required":false,"description":"External User Access status. Can be Active,  Inactive, Barred, Initiated"},{"name":"customerId","in":"query","type":"string","required":false,"description":"Identifier of the customer"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"ExternalUsersResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/party/customers/{customerId}/relationships","fullPath":"/api/v1.0.1/party/customers/{customerId}/relationships","operationId":"getCustomerRelations","name":"Retrieves the relations for a customer","summary":"Retrieve Customer Relations","tags":[],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"Identifier of the customer"},{"name":"relationType","in":"query","type":"string","required":false,"description":"The type of relation that is used between customers"},{"name":"excludeCustomerType","in":"query","type":"string","required":false,"description":"The type of the customer to be excluded from the related customers list"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"CustomerRelationsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/party/users/userProfiles/","fullPath":"/api/v1.0.1/party/users/userProfiles/","operationId":"getUserProfile","name":"Retrieves User Profile","summary":"Retrieves User Profile","tags":[],"parameters":[{"name":"userId","in":"query","type":"string","required":false,"description":"The user name to be loaded for reporting jobs during Close of Business If no user name is entered in this field then the default profile for the user 'operator' is used."},{"name":"userSignOnName","in":"query","type":"string","required":false,"description":"This is the name entered by the User to sign on to the System. It is used by the System as an alternative key to access User details"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"UserProfileResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}}]},{"key":"party-userAdmin-service-v2.0.0","title":"External User Administration","version":"v2.0.0","description":"API to create, update and manage the external user profiles for user administration","endpointCount":15,"endpoints":[{"method":"POST","path":"/party/customers/externalUser","fullPath":"/api/v2.0.0/party/customers/externalUser","operationId":"createExternalUserCustomer","name":"Create an external user customer","summary":"Create an external user customer","tags":[],"parameters":[{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"email":[{}],"sms":[{}],"legalDoc":[{}],"street":[{}],"postCode":[{}],"townCountry":[{}],"country":[{}],"relation":[{}],"override":[{}],"title":"string","givenName":"string","lastName":"string","gender":"string","languageId":"string","dateOfBirth":"2024-01-01"}},"responses":{"200":"ExternalUserCustomerResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/party/externalUsers/{externalUserId}","fullPath":"/api/v2.0.0/party/externalUsers/{externalUserId}","operationId":"getExternalUser","name":"Retrieves external user details","summary":"Retrieves external user","tags":[],"parameters":[{"name":"externalUserId","in":"path","type":"string","required":true,"description":"Contains the external user identifier for which the consent is created."},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"ExternalUserResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"POST","path":"/party/externalUsers/{externalUserId}","fullPath":"/api/v2.0.0/party/externalUsers/{externalUserId}","operationId":"createExternalUser","name":"Create an external user","summary":"Create an external user","tags":[],"parameters":[{"name":"externalUserId","in":"path","type":"string","required":true,"description":"Contains the external user identifier for which the consent is created."},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"channels":[{}],"externalUserName":"string","customerId":"string","companyId":"string","authenticationServerUpdate":true,"externalUserSignMethod":"string","languageId":"string","dateFormat":"string","override":"string","extensions":{}}},"responses":{"200":"ExternalUserResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/party/externalUsers/{externalUserId}","fullPath":"/api/v2.0.0/party/externalUsers/{externalUserId}","operationId":"updateExternalUser","name":"Update an external user","summary":"Update an external user","tags":[],"parameters":[{"name":"externalUserId","in":"path","type":"string","required":true,"description":"Contains the external user identifier for which the consent is created."},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"channels":[{}],"externalUserName":"string","customerId":"string","companyId":"string","authenticationServerUpdate":true,"externalUserSignMethod":"string","languageId":"string","dateFormat":"string","override":"string","extensions":{}}},"responses":{"200":"ExternalUserResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"DELETE","path":"/party/externalUsers/{externalUserId}","fullPath":"/api/v2.0.0/party/externalUsers/{externalUserId}","operationId":"deleteExternalUser","name":"Delete an external user","summary":"Delete an external user","tags":[],"parameters":[{"name":"externalUserId","in":"path","type":"string","required":true,"description":"Contains the external user identifier for which the consent is created."},{"name":"payload","in":"body","type":"object","required":false,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}}},"responses":{"200":"ExternalUserResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"POST","path":"/party/externalUserApprovals","fullPath":"/api/v2.0.0/party/externalUserApprovals","operationId":"initiateExternalUser","name":"Initiate an external user","summary":"Initiate an external user","tags":[],"parameters":[{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"channels":[{}],"externalUserName":"string","customerId":"string","companyId":"string","authenticationServerUpdate":true,"externalUserSignMethod":"string","languageId":"string","dateFormat":"string","override":"string","extensions":{}}},"responses":{"200":"ExternalUserResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/party/externalUserApprovals/amendments/{externalUserId}","fullPath":"/api/v2.0.0/party/externalUserApprovals/amendments/{externalUserId}","operationId":"amendExternalUser","name":"Amend an external user","summary":"Amend an external user","tags":[],"parameters":[{"name":"externalUserId","in":"path","type":"string","required":true,"description":"Contains the external user identifier for which the consent is created."},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"channels":[{}],"externalUserName":"string","customerId":"string","companyId":"string","authenticationServerUpdate":true,"externalUserSignMethod":"string","languageId":"string","dateFormat":"string","override":"string","extensions":{}}},"responses":{"200":"ExternalUserResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/party/externalUserApprovals/{externalUserId}","fullPath":"/api/v2.0.0/party/externalUserApprovals/{externalUserId}","operationId":"approveExternalUser","name":"Approve an external user","summary":"Approve an external user","tags":[],"parameters":[{"name":"externalUserId","in":"path","type":"string","required":true,"description":"Contains the external user identifier for which the consent is created."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"ExternalUserResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"DELETE","path":"/party/externalUserApprovals/{externalUserId}","fullPath":"/api/v2.0.0/party/externalUserApprovals/{externalUserId}","operationId":"rejectExternalUser","name":"Rejects an unauthorised external user record","summary":"Reject an external User","tags":[],"parameters":[{"name":"externalUserId","in":"path","type":"string","required":true,"description":"Contains the external user identifier for which the consent is created."},{"name":"payload","in":"body","type":"object","required":false,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}}},"responses":{"200":"ExternalUserResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"DELETE","path":"/party/externalUserRequests/{externalUserId}","fullPath":"/api/v2.0.0/party/externalUserRequests/{externalUserId}","operationId":"initiateExternalUserDelete","name":"Initiates an external user delete by moving it to unauthorised status","summary":"Initiate an external user delete","tags":[],"parameters":[{"name":"externalUserId","in":"path","type":"string","required":true,"description":"Contains the external user identifier for which the consent is created."},{"name":"payload","in":"body","type":"object","required":false,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}}},"responses":{"200":"ExternalUserDeleteResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/party/externalUsers/externalUserApprovals","fullPath":"/api/v2.0.0/party/externalUsers/externalUserApprovals","operationId":"getExternalUserApprovals","name":"Retrieves an unauthorised external user records","summary":"Retrieves an unauthorised external user","tags":[],"parameters":[{"name":"externalUserId","in":"query","type":"string","required":false,"description":"Contains the external user identifier for which the consent is created."},{"name":"externalUserName","in":"query","type":"string","required":false,"description":"External or Digital Channel User Name"},{"name":"customerId","in":"query","type":"string","required":false,"description":"Identifier of the customer"},{"name":"arrangementId","in":"query","type":"string","required":false,"description":"Indicates an unique identifier of an account"},{"name":"subArrangementId","in":"query","type":"string","required":false,"description":"The subset of Master arrangement."},{"name":"channelId","in":"query","type":"string","required":false,"description":"Id of the (digital) channel"},{"name":"externalUserStatus","in":"query","type":"string","required":false,"description":"External User Access status. Can be Active,  Inactive, Barred, Initiated"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"ExternalUserApprovalsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/party/customers/{customerId}/externalUsers","fullPath":"/api/v2.0.0/party/customers/{customerId}/externalUsers","operationId":"getCustomerExternalUsers","name":"Retrieves the list of attached internet banking or external users for a customer","summary":"Retrieves the external user attached to the given customer","tags":[],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"Identifier of the customer"},{"name":"externalUserId","in":"query","type":"string","required":false,"description":"Contains the external user identifier for which the consent is created."},{"name":"externalUserName","in":"query","type":"string","required":false,"description":"External or Digital Channel User Name"},{"name":"arrangementId","in":"query","type":"string","required":false,"description":"Indicates an unique identifier of an account"},{"name":"channelId","in":"query","type":"string","required":false,"description":"Id of the (digital) channel"},{"name":"externalUserStatus","in":"query","type":"string","required":false,"description":"External User Access status. Can be Active,  Inactive, Barred, Initiated"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"CustomerExternalUsersResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/party/externalUsers","fullPath":"/api/v2.0.0/party/externalUsers","operationId":"getExternalUsers","name":"Retrieves the external users","summary":"Retrieves the external users","tags":[],"parameters":[{"name":"externalUserId","in":"query","type":"string","required":false,"description":"Contains the external user identifier for which the consent is created."},{"name":"externalUserName","in":"query","type":"string","required":false,"description":"External or Digital Channel User Name"},{"name":"arrangementId","in":"query","type":"string","required":false,"description":"Indicates an unique identifier of an account"},{"name":"subArrangementId","in":"query","type":"string","required":false,"description":"The subset of Master arrangement."},{"name":"channelId","in":"query","type":"string","required":false,"description":"Id of the (digital) channel"},{"name":"externalUserStatus","in":"query","type":"string","required":false,"description":"External User Access status. Can be Active,  Inactive, Barred, Initiated"},{"name":"customerId","in":"query","type":"string","required":false,"description":"Identifier of the customer"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"ExternalUsersResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/party/customers/{customerId}/relationships","fullPath":"/api/v2.0.0/party/customers/{customerId}/relationships","operationId":"getCustomerRelations","name":"Retrieves the relations for a customer","summary":"Retrieves the customer relations","tags":[],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"Identifier of the customer"},{"name":"relationType","in":"query","type":"string","required":false,"description":"The type of relation that is used between customers"},{"name":"excludeCustomerType","in":"query","type":"string","required":false,"description":"The type of the customer to be excluded from the related customers list"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"CustomerRelationsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/party/users/userProfiles","fullPath":"/api/v2.0.0/party/users/userProfiles","operationId":"getUserProfile","name":"Retrieves the user profile","summary":"Retrieves the user profile","tags":[],"parameters":[{"name":"userId","in":"query","type":"string","required":false,"description":"The user name to be loaded for reporting jobs during Close of Business If no user name is entered in this field then the default profile for the user 'operator' is used."},{"name":"userSignOnName","in":"query","type":"string","required":false,"description":"This is the name entered by the User to sign on to the System. It is used by the System as an alternative key to access User details"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"UserProfileResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}}]},{"key":"party-userAdmin-service-v2.1.0","title":"External User Administration","version":"v2.1.0","description":"API to create, update and manage the external user profiles for user administration","endpointCount":15,"endpoints":[{"method":"POST","path":"/party/customers/externalUser","fullPath":"/api/v2.1.0/party/customers/externalUser","operationId":"createExternalUserCustomer","name":"Create an external user customer","summary":"Create an external user customer","tags":["OTHERS"],"parameters":[{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"email":[{}],"sms":[{}],"legalDoc":[{}],"street":[{}],"postCode":[{}],"townCountry":[{}],"country":[{}],"relation":[{}],"override":[{}],"title":"string","givenName":"string","lastName":"string","gender":"string","languageId":"string","dateOfBirth":"2024-01-01"}},"responses":{"200":"ExternalUserCustomerResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/party/externalUsers/{externalUserId}","fullPath":"/api/v2.1.0/party/externalUsers/{externalUserId}","operationId":"getExternalUser","name":"Retrieves external user details","summary":"Retrieves external user","tags":["OTHERS"],"parameters":[{"name":"externalUserId","in":"path","type":"string","required":true,"description":"Contains the external user identifier for which the consent is created."},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"ExternalUserResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"POST","path":"/party/externalUsers/{externalUserId}","fullPath":"/api/v2.1.0/party/externalUsers/{externalUserId}","operationId":"createExternalUser","name":"Create an external user","summary":"Create an external user","tags":["OTHERS"],"parameters":[{"name":"externalUserId","in":"path","type":"string","required":true,"description":"Contains the external user identifier for which the consent is created."},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"channels":[{}],"externalUserName":"string","customerId":"string","companyId":"string","authenticationServerUpdate":true,"externalUserSignMethod":"string","languageId":"string","dateFormat":"string","override":"string","extensions":{}}},"responses":{"200":"ExternalUserResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/party/externalUsers/{externalUserId}","fullPath":"/api/v2.1.0/party/externalUsers/{externalUserId}","operationId":"updateExternalUser","name":"Update an external user","summary":"Update an external user","tags":["OTHERS"],"parameters":[{"name":"externalUserId","in":"path","type":"string","required":true,"description":"Contains the external user identifier for which the consent is created."},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"channels":[{}],"externalUserName":"string","customerId":"string","companyId":"string","authenticationServerUpdate":true,"externalUserSignMethod":"string","languageId":"string","dateFormat":"string","override":"string","extensions":{}}},"responses":{"200":"ExternalUserResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"DELETE","path":"/party/externalUsers/{externalUserId}","fullPath":"/api/v2.1.0/party/externalUsers/{externalUserId}","operationId":"deleteExternalUser","name":"Delete an external user","summary":"Delete an external user","tags":["OTHERS"],"parameters":[{"name":"externalUserId","in":"path","type":"string","required":true,"description":"Contains the external user identifier for which the consent is created."},{"name":"payload","in":"body","type":"object","required":false,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}}},"responses":{"200":"ExternalUserResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"POST","path":"/party/externalUserApprovals","fullPath":"/api/v2.1.0/party/externalUserApprovals","operationId":"initiateExternalUser","name":"Initiate an external user","summary":"Initiate an external user","tags":["OTHERS"],"parameters":[{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"channels":[{}],"externalUserName":"string","customerId":"string","companyId":"string","authenticationServerUpdate":true,"externalUserSignMethod":"string","languageId":"string","dateFormat":"string","override":"string","extensions":{}}},"responses":{"200":"ExternalUserResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/party/externalUserApprovals/amendments/{externalUserId}","fullPath":"/api/v2.1.0/party/externalUserApprovals/amendments/{externalUserId}","operationId":"amendExternalUser","name":"Amend an external user","summary":"Amend an external user","tags":["OTHERS"],"parameters":[{"name":"externalUserId","in":"path","type":"string","required":true,"description":"Contains the external user identifier for which the consent is created."},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"channels":[{}],"externalUserName":"string","customerId":"string","companyId":"string","authenticationServerUpdate":true,"externalUserSignMethod":"string","languageId":"string","dateFormat":"string","override":"string","extensions":{}}},"responses":{"200":"ExternalUserResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/party/externalUserApprovals/{externalUserId}","fullPath":"/api/v2.1.0/party/externalUserApprovals/{externalUserId}","operationId":"approveExternalUser","name":"Approve an external user","summary":"Approve an external user","tags":["OTHERS"],"parameters":[{"name":"externalUserId","in":"path","type":"string","required":true,"description":"Contains the external user identifier for which the consent is created."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"ExternalUserResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"DELETE","path":"/party/externalUserApprovals/{externalUserId}","fullPath":"/api/v2.1.0/party/externalUserApprovals/{externalUserId}","operationId":"rejectExternalUser","name":"Rejects an unapproved external user","summary":"Reject an external User","tags":["OTHERS"],"parameters":[{"name":"externalUserId","in":"path","type":"string","required":true,"description":"Contains the external user identifier for which the consent is created."},{"name":"payload","in":"body","type":"object","required":false,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}}},"responses":{"200":"ExternalUserResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"DELETE","path":"/party/externalUserRequests/{externalUserId}","fullPath":"/api/v2.1.0/party/externalUserRequests/{externalUserId}","operationId":"initiateExternalUserDelete","name":"Initiates an external user delete by moving it to unapproved status","summary":"Initiate an external user delete","tags":["OTHERS"],"parameters":[{"name":"externalUserId","in":"path","type":"string","required":true,"description":"Contains the external user identifier for which the consent is created."},{"name":"payload","in":"body","type":"object","required":false,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}}},"responses":{"200":"ExternalUserDeleteResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/party/externalUsers/externalUserApprovals","fullPath":"/api/v2.1.0/party/externalUsers/externalUserApprovals","operationId":"getExternalUserApprovals","name":"Retrieves an unapproved external user","summary":"Retrieves an unapproved external user","tags":["OTHERS"],"parameters":[{"name":"externalUserId","in":"query","type":"string","required":false,"description":"Contains the external user identifier for which the consent is created."},{"name":"externalUserName","in":"query","type":"string","required":false,"description":"External or Digital Channel User Name"},{"name":"customerId","in":"query","type":"string","required":false,"description":"Identifier of the customer"},{"name":"arrangementId","in":"query","type":"string","required":false,"description":"Indicates an unique identifier of an account"},{"name":"subArrangementId","in":"query","type":"string","required":false,"description":"The subset of Master arrangement."},{"name":"channelId","in":"query","type":"string","required":false,"description":"Id of the (digital) channel"},{"name":"externalUserStatus","in":"query","type":"string","required":false,"description":"External User Access status. Can be Active,  Inactive, Barred, Initiated"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"ExternalUserApprovalsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/party/customers/{customerId}/externalUsers","fullPath":"/api/v2.1.0/party/customers/{customerId}/externalUsers","operationId":"getCustomerExternalUsers","name":"Retrieves the list of attached internet banking or external users for a customer","summary":"Retrieves the external user attached to the given customer","tags":["OTHERS"],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"Identifier of the customer"},{"name":"externalUserId","in":"query","type":"string","required":false,"description":"Contains the external user identifier for which the consent is created."},{"name":"externalUserName","in":"query","type":"string","required":false,"description":"External or Digital Channel User Name"},{"name":"arrangementId","in":"query","type":"string","required":false,"description":"Indicates an unique identifier of an account"},{"name":"channelId","in":"query","type":"string","required":false,"description":"Id of the (digital) channel"},{"name":"externalUserStatus","in":"query","type":"string","required":false,"description":"External User Access status. Can be Active,  Inactive, Barred, Initiated"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"CustomerExternalUsersResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/party/externalUsers","fullPath":"/api/v2.1.0/party/externalUsers","operationId":"getExternalUsers","name":"Retrieves the external users","summary":"Retrieves the external users","tags":["OTHERS"],"parameters":[{"name":"externalUserId","in":"query","type":"string","required":false,"description":"Contains the external user identifier for which the consent is created."},{"name":"externalUserName","in":"query","type":"string","required":false,"description":"External or Digital Channel User Name"},{"name":"arrangementId","in":"query","type":"string","required":false,"description":"Indicates an unique identifier of an account"},{"name":"subArrangementId","in":"query","type":"string","required":false,"description":"The subset of Master arrangement."},{"name":"channelId","in":"query","type":"string","required":false,"description":"Id of the (digital) channel"},{"name":"externalUserStatus","in":"query","type":"string","required":false,"description":"External User Access status. Can be Active,  Inactive, Barred, Initiated"},{"name":"customerId","in":"query","type":"string","required":false,"description":"Identifier of the customer"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"ExternalUsersResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/party/customers/{customerId}/relationships","fullPath":"/api/v2.1.0/party/customers/{customerId}/relationships","operationId":"getCustomerRelations","name":"Retrieves the relations for a customer","summary":"Retrieves the customer relations","tags":["OTHERS"],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"Identifier of the customer"},{"name":"relationType","in":"query","type":"string","required":false,"description":"The type of relation that is used between customers"},{"name":"excludeCustomerType","in":"query","type":"string","required":false,"description":"The type of the customer to be excluded from the related customers list"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"CustomerRelationsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/party/users/userProfiles","fullPath":"/api/v2.1.0/party/users/userProfiles","operationId":"getUserProfile","name":"Retrieves the user profile","summary":"Retrieves the user profile","tags":["TREASURY"],"parameters":[{"name":"userId","in":"query","type":"string","required":false,"description":"The user name to be loaded for reporting jobs during Close of Business If no user name is entered in this field then the default profile for the user 'operator' is used."},{"name":"userSignOnName","in":"query","type":"string","required":false,"description":"This is the name entered by the User to sign on to the System. It is used by the System as an alternative key to access User details"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"UserProfileResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}}]}]},{"name":"Product","serviceCount":29,"endpointCount":646,"services":[{"key":"product-ca-product-service-v1.0.0","title":"Product Information","version":"v1.0.0","description":"Canadian APIs to retrieve the list of eligible products and interest rate","endpointCount":1,"endpoints":[{"method":"GET","path":"/product/ca/products","fullPath":"/api/v1.0.0/product/ca/products","operationId":"getCaProducts","name":"Retrieve the eligible products available for a customer to create account. Customer id should be an optional selection.","summary":"Retrieve the eligible products available for account creation","tags":["RETAIL"],"parameters":[{"name":"productLineId","in":"query","type":"string","required":false,"description":"The top level product line, which the product is ultimately attached to. May be a Temenos-defined product line such as ACCOUNTS, AGENT, BUNDLE, CONSENT, DEPOSITS, LENDING, REWARDS, etc. or one defined"},{"name":"productGroupId","in":"query","type":"string","required":false,"description":"The group, as defined by the institution, that the product belongs to."},{"name":"eligibilityFilter","in":"query","type":"string","required":false,"description":"Indicates the filter based on the Eligibility options available to the customer"},{"name":"multiBookEligible","in":"query","type":"string","required":false,"description":"Flag which indicates whether multi booking is applicable or not"},{"name":"productId","in":"query","type":"string","required":false,"description":"Contains the unique identifier of the product, e.g. the product id of the arrangement account."},{"name":"customerId","in":"query","type":"string","required":false,"description":"Identifier of the customer"},{"name":"eligibility","in":"query","type":"string","required":false,"description":"Contains the details of rules associated with the customer, rule results, action and variation."},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"CaProductsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}}]},{"key":"product-catalogueDetails-v2.0.0","title":"Retrieve the Catalogued details of a Product","version":"v2.0.0","description":"Retrieve the Catalogued details of a Product","endpointCount":1,"endpoints":[{"method":"GET","path":"/product/marketingCatalogue/{productId}/deposits","fullPath":"/api/v2.0.0/product/marketingCatalogue/{productId}/deposits","operationId":"getTermDepositsCatalogue","name":"Retrieve the Catalogued details of a Product-This API is deprecated as it is a part of Wealth API package which should be deployed locally","summary":"Retrieve the Catalogued details of a Product","tags":[],"parameters":[{"name":"productId","in":"path","type":"string","required":true,"description":"Id of the product."},{"name":"currency","in":"query","type":"string","required":false,"description":"Identifies the currency. E.g. USD, GBP etc"},{"name":"variation","in":"query","type":"string","required":false,"description":"Additional product specification based on particular criteria for example the account was opened on-line and attracted a higher interest rate. Drop down list to select appropriate variation or applied"},{"name":"customerId","in":"query","type":"string","required":false,"description":"Identifier of the customer"},{"name":"availableCompany","in":"query","type":"string","required":false,"description":"Contains the available company defined for the deposit contract"},{"name":"term","in":"query","type":"string","required":false,"description":"Indicates the term for which the contract is booked"},{"name":"amount","in":"query","type":"string","required":false,"description":"This is the payment amount"},{"name":"minTerm","in":"query","type":"string","required":false,"description":"Contains the minimum term defined for the deposit contract"},{"name":"maxTerm","in":"query","type":"string","required":false,"description":"Contains the maximum term defined for the deposit contract"},{"name":"minAmount","in":"query","type":"string","required":false,"description":"Contains the minimum principal amount defined for the deposit contract"},{"name":"interestApplicable","in":"query","type":"string","required":false,"description":"Indicates the interest applicable or not for the deposit contract"},{"name":"rateType","in":"query","type":"string","required":false,"description":"Fixed or floating rate."},{"name":"rate","in":"query","type":"string","required":false,"description":"The rate applied"},{"name":"baseInterestRate","in":"query","type":"string","required":false,"description":"Contains the base rate used for calculating the interest"},{"name":"standardRate","in":"query","type":"string","required":false,"description":"Contains the standard rate defined for the interest calculation"},{"name":"interestMargin","in":"query","type":"string","required":false,"description":"Contains the margin used for calculating the interest"},{"name":"paymentFrequency","in":"query","type":"string","required":false,"description":"The frequency at which a payment is required to be generated"},{"name":"noticeDays","in":"query","type":"string","required":false,"description":"Indicates the number of days prior to rollover or renewal date on which the notice to be sent"},{"name":"productRiskCategory","in":"query","type":"string","required":false,"description":"Contains the product risk category"},{"name":"coolingPeriod","in":"query","type":"string","required":false,"description":"Indicates the number of days to be considered for closure of account after renewal or rollover date"},{"name":"maxAmount","in":"query","type":"string","required":false,"description":"Contains the maximum principal amount defined for the deposit contract"},{"name":"rolloverType","in":"query","type":"string","required":false,"description":"Indicates the type of rollover takes place for the account. During rollover, new interest rate or schedule conditions applied for the payment calculation"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from t24 on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"The identifier of the underlying Entity/Company/Branch."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"TermDepositsCatalogueResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}}]},{"key":"product-customers-service-v1.0.0","title":"Eligible Products for the Customer","version":"v1.0.0","description":"API to identify and retrieve the eligible product details, based on the interest of the customer","endpointCount":3,"endpoints":[{"method":"GET","path":"/product/customers/{customerId}/eligibleProducts","fullPath":"/api/v1.0.0/product/customers/{customerId}/eligibleProducts","operationId":"getEligibleProducts","name":"Retrieves the list of customer eligible products generated by the Propensity Engine to identify products which are likely to be of interest to specific customers.","summary":"Retrieves the eligible product details for a customer","tags":[],"parameters":[{"name":"customerId","in":"path","type":"string","required":true,"description":"Identifier of the customer"},{"name":"productLineId","in":"query","type":"string","required":false,"description":"The top level product line, which the product is ultimately attached to. May be a Temenos-defined product line such as ACCOUNTS, AGENT, BUNDLE, CONSENT, DEPOSITS, LENDING, REWARDS, etc. or one defined"},{"name":"productGroupId","in":"query","type":"string","required":false,"description":"The group, as defined by the institution, that the product belongs to."},{"name":"eligibilityFilter","in":"query","type":"string","required":false,"description":"Indicates the filter based on the Eligibility options available to the customer"},{"name":"multiBookEligible","in":"query","type":"string","required":false,"description":"Flag which indicates whether multi booking is applicable or not"},{"name":"productId","in":"query","type":"string","required":false,"description":"Contains the unique identifier of the product, e.g. the product id of the arrangement account."},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"EligibleProductsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/product/periodicInterests/{periodicInterestId}","fullPath":"/api/v1.0.0/product/periodicInterests/{periodicInterestId}","operationId":"getPeriodicInterests","name":"Retrieves periodic interests details","summary":"Retrieves the periodic interest rate details for specific id","tags":[],"parameters":[{"name":"periodicInterestId","in":"path","type":"string","required":true,"description":"Contains the id of the rate of interest assessed on a loan or investment over a set time period when compounding occurs more than once per year"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"PeriodicInterestsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/product/interestCatalog/{interestCatalogId}","fullPath":"/api/v1.0.0/product/interestCatalog/{interestCatalogId}","operationId":"getInterestCatalog","name":"Retrieves interest catalog details","summary":"Retrieves the interest details for specific interest catalog","tags":[],"parameters":[{"name":"interestCatalogId","in":"path","type":"string","required":true,"description":"Contains the identifier of the catalog for periodic Interest rates"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"InterestCatalogResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}}]},{"key":"product-externalProducts-service-v1.0.0","title":"Import of external products","version":"v1.0.0","description":"Import external products","endpointCount":12,"endpoints":[{"method":"GET","path":"/product/loans/mortgages/externalProducts/{productId}","fullPath":"/api/v1.0.0/product/loans/mortgages/externalProducts/{productId}","operationId":"getExternalMortgageProduct","name":"Retrieves the product details of the given Mortgage product","summary":"Retrieves the product details for the given blueprint of Mortgage product","tags":[],"parameters":[{"name":"productId","in":"path","type":"string","required":true,"description":"Contains the unique identifier of the product, e.g. the product id of the arrangement account."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"ExternalMortgageProductResponse","default":"ScreenErrorResponse"}},{"method":"POST","path":"/product/loans/mortgages/externalProducts/{productId}","fullPath":"/api/v1.0.0/product/loans/mortgages/externalProducts/{productId}","operationId":"createExternalMortgageProduct","name":"Creates a blueprint of Mortgage product","summary":"Creates the blueprint of Mortgage product with the provided details","tags":[],"parameters":[{"name":"productId","in":"path","type":"string","required":true,"description":"Contains the unique identifier of the product, e.g. the product id of the arrangement account."},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"displayNames":[{}],"organizations":[{}],"lineOfBusinesses":[{}],"channels":[{}],"principals":[{}],"schedules":[{}],"optionDescription":"string","product":"string","availableFromDate":"2024-01-01","expiryDate":"2024-01-01","effectiveDate":"2024-01-01","currency":"string","variation":"string","commitmentTerm":"string","commitmentCancelPeriod":"string"}},"responses":{"200":"ExternalMortgageProductResponse","default":"ScreenErrorResponse"}},{"method":"PUT","path":"/product/loans/mortgages/externalProducts/{productId}","fullPath":"/api/v1.0.0/product/loans/mortgages/externalProducts/{productId}","operationId":"updateExternalMortgageProduct","name":"Updates the blueprint of Mortgage product","summary":"Updates the given blueprint of Mortgage product with the specified details","tags":[],"parameters":[{"name":"productId","in":"path","type":"string","required":true,"description":"Contains the unique identifier of the product, e.g. the product id of the arrangement account."},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"displayNames":[{}],"organizations":[{}],"lineOfBusinesses":[{}],"channels":[{}],"principals":[{}],"schedules":[{}],"optionDescription":"string","product":"string","availableFromDate":"2024-01-01","expiryDate":"2024-01-01","effectiveDate":"2024-01-01","currency":"string","variation":"string","commitmentTerm":"string","commitmentCancelPeriod":"string"}},"responses":{"200":"ExternalMortgageProductResponse","default":"ScreenErrorResponse"}},{"method":"GET","path":"/product/accounts/currentAccounts/externalProducts/{productId}","fullPath":"/api/v1.0.0/product/accounts/currentAccounts/externalProducts/{productId}","operationId":"getExternalCurrentAccountProduct","name":"Retrieves the product details of the given Current Account product","summary":"Retrieves the product details for the given blueprint of Current Account product","tags":[],"parameters":[{"name":"productId","in":"path","type":"string","required":true,"description":"Contains the unique identifier of the product, e.g. the product id of the arrangement account."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"ExternalCurrentAccountProductResponse","default":"ScreenErrorResponse"}},{"method":"POST","path":"/product/accounts/currentAccounts/externalProducts/{productId}","fullPath":"/api/v1.0.0/product/accounts/currentAccounts/externalProducts/{productId}","operationId":"createExternalCurrentAccountProduct","name":"Creates a blueprint of Current Account product","summary":"Creates the blueprint of Current Account product with the provided details","tags":[],"parameters":[{"name":"productId","in":"path","type":"string","required":true,"description":"Contains the unique identifier of the product, e.g. the product id of the arrangement account."},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"displayNames":[{}],"organizations":[{}],"lineOfBusinesses":[{}],"channels":[{}],"creditInterests":[{}],"debitInterests":[{}],"schedules":[{}],"periodiccharges":[{}],"optionDescription":"string","product":"string","availableFromDate":"2024-01-01","expiryDate":"2024-01-01","effectiveDate":"2024-01-01","currency":"string","variation":"string"}},"responses":{"200":"ExternalCurrentAccountProductResponse","default":"ScreenErrorResponse"}},{"method":"PUT","path":"/product/accounts/currentAccounts/externalProducts/{productId}","fullPath":"/api/v1.0.0/product/accounts/currentAccounts/externalProducts/{productId}","operationId":"updateExternalCurrentAccountProduct","name":"Updates the blueprint of Current Account product","summary":"Updates the given blueprint of  Current Account product with the specified details","tags":[],"parameters":[{"name":"productId","in":"path","type":"string","required":true,"description":"Contains the unique identifier of the product, e.g. the product id of the arrangement account."},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"displayNames":[{}],"organizations":[{}],"lineOfBusinesses":[{}],"channels":[{}],"creditInterests":[{}],"debitInterests":[{}],"schedules":[{}],"periodiccharges":[{}],"optionDescription":"string","product":"string","availableFromDate":"2024-01-01","expiryDate":"2024-01-01","effectiveDate":"2024-01-01","currency":"string","variation":"string"}},"responses":{"200":"ExternalCurrentAccountProductResponse","default":"ScreenErrorResponse"}},{"method":"GET","path":"/product/accounts/savingsAccounts/externalProducts/{productId}","fullPath":"/api/v1.0.0/product/accounts/savingsAccounts/externalProducts/{productId}","operationId":"getExternalSavingsAccountProduct","name":"Retrieves the product details of the given Savings Account product","summary":"Retrieves the product details for the given blueprint of  Savings Account product","tags":[],"parameters":[{"name":"productId","in":"path","type":"string","required":true,"description":"Contains the unique identifier of the product, e.g. the product id of the arrangement account."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"ExternalSavingsAccountProductResponse","default":"ScreenErrorResponse"}},{"method":"POST","path":"/product/accounts/savingsAccounts/externalProducts/{productId}","fullPath":"/api/v1.0.0/product/accounts/savingsAccounts/externalProducts/{productId}","operationId":"createExternalSavingsAccountProduct","name":"Creates a blueprint of  Savings Account  product","summary":"Creates the blueprint of Savings Account  product with the provided details","tags":[],"parameters":[{"name":"productId","in":"path","type":"string","required":true,"description":"Contains the unique identifier of the product, e.g. the product id of the arrangement account."},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"displayNames":[{}],"organizations":[{}],"lineOfBusinesses":[{}],"channels":[{}],"creditInterests":[{}],"schedules":[{}],"optionDescription":"string","product":"string","availableFromDate":"2024-01-01","expiryDate":"2024-01-01","effectiveDate":"2024-01-01","currency":"string","variation":"string","balanceAvailabilityCreditCheck":"string","balanceAvailabilityAvailBalanceUpdate":"string"}},"responses":{"200":"ExternalSavingsAccountProductResponse","default":"ScreenErrorResponse"}},{"method":"PUT","path":"/product/accounts/savingsAccounts/externalProducts/{productId}","fullPath":"/api/v1.0.0/product/accounts/savingsAccounts/externalProducts/{productId}","operationId":"updateExternalSavingsAccountProduct","name":"Updates the blueprint of Savings Account product","summary":"Updates the given blueprint of Savings Account product with the specified details","tags":[],"parameters":[{"name":"productId","in":"path","type":"string","required":true,"description":"Contains the unique identifier of the product, e.g. the product id of the arrangement account."},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"displayNames":[{}],"organizations":[{}],"lineOfBusinesses":[{}],"channels":[{}],"creditInterests":[{}],"schedules":[{}],"optionDescription":"string","product":"string","availableFromDate":"2024-01-01","expiryDate":"2024-01-01","effectiveDate":"2024-01-01","currency":"string","variation":"string","balanceAvailabilityCreditCheck":"string","balanceAvailabilityAvailBalanceUpdate":"string"}},"responses":{"200":"ExternalSavingsAccountProductResponse","default":"ScreenErrorResponse"}},{"method":"POST","path":"/product/deposits/termDeposits/externalProducts/{productId}","fullPath":"/api/v1.0.0/product/deposits/termDeposits/externalProducts/{productId}","operationId":"createExternalDepositProduct","name":"Creates a blueprint of Deposit  product","summary":"Creates the  blueprint  of Deposit product wih the provided details","tags":[],"parameters":[{"name":"productId","in":"path","type":"string","required":true,"description":"Contains the unique identifier of the product, e.g. the product id of the arrangement account."},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"displayNames":[{}],"organizations":[{}],"lineOfBusinesses":[{}],"channels":[{}],"depositInterests":[{}],"schedules":[{}],"optionDescription":"string","product":"string","availableFromDate":"2024-01-01","expiryDate":"2024-01-01","effectiveDate":"2024-01-01","currency":"string","variation":"string","commitmentAmount":0.0,"commitmentTerm":"string"}},"responses":{"200":"ExternalDepositProductResponse","default":"ScreenErrorResponse"}},{"method":"PUT","path":"/product/deposits/termDeposits/externalProducts/{productId}","fullPath":"/api/v1.0.0/product/deposits/termDeposits/externalProducts/{productId}","operationId":"updateExternalDepositProduct","name":"Updates the blueprint of  Deposit product","summary":"Updates the given blueprint of  Deposit product with specified details","tags":[],"parameters":[{"name":"productId","in":"path","type":"string","required":true,"description":"Contains the unique identifier of the product, e.g. the product id of the arrangement account."},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"displayNames":[{}],"organizations":[{}],"lineOfBusinesses":[{}],"channels":[{}],"depositInterests":[{}],"schedules":[{}],"optionDescription":"string","product":"string","availableFromDate":"2024-01-01","expiryDate":"2024-01-01","effectiveDate":"2024-01-01","currency":"string","variation":"string","commitmentAmount":0.0,"commitmentTerm":"string"}},"responses":{"200":"ExternalDepositProductResponse","default":"ScreenErrorResponse"}},{"method":"GET","path":"/product/deposits/termDepsoits/externalProducts/{productId}","fullPath":"/api/v1.0.0/product/deposits/termDepsoits/externalProducts/{productId}","operationId":"getExternalDepositProduct","name":"Retrieves the product details of the given Deposit product","summary":"Retrieves the product details of the given  blueprint of  Deposit product","tags":[],"parameters":[{"name":"productId","in":"path","type":"string","required":true,"description":"Contains the unique identifier of the product, e.g. the product id of the arrangement account."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"ExternalDepositProductResponse","default":"ScreenErrorResponse"}}]},{"key":"product-interestConditions-v1.0.0","title":"Retrieves interest condition record","version":"v1.0.0","description":"Retrieves the details of interest condition","endpointCount":1,"endpoints":[{"method":"GET","path":"/product/interestConditions","fullPath":"/api/v1.0.0/product/interestConditions","operationId":"getInterestConditions","name":"Retrieves all the available interest conditions-This API is deprecated","summary":"Retrieves all the available interest conditions","tags":[],"parameters":[{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"InterestConditionsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}}]},{"key":"product-limitproducts-service-v1.0.0","title":"Limit Products","version":"v1.0.0","description":"API retrieves the limit products details defined in the system","endpointCount":1,"endpoints":[{"method":"GET","path":"/product/limitProducts/{limitProductId}","fullPath":"/api/v1.0.0/product/limitProducts/{limitProductId}","operationId":"getLimitProduct","name":"Retrieves the details such as shortname, reducing limit, child & parent references for the requested limit product id.","summary":"Retrieves details of limit products","tags":[],"parameters":[{"name":"limitProductId","in":"path","type":"string","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"The identifier of the underlying Entity/Company/Branch."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"LimitProductResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}}]},{"key":"product-limitproducts-service-v1.1.0","title":"Limit Products","version":"v1.1.0","description":"API retrieves the limit products details defined in the system","endpointCount":1,"endpoints":[{"method":"GET","path":"/product/limitProducts/{limitProductId}","fullPath":"/api/v1.0.0/product/limitProducts/{limitProductId}","operationId":"getLimitProduct","name":"Retrieves the details such as shortname, reducing limit, child & parent references for the requested limit product id - Deprecated. Use holdings-creditLimits-service-v1.0.0 instead. New URL - /holdings/creditLimits/products","summary":"Retrieves details of limit products","tags":["RETAIL"],"parameters":[{"name":"limitProductId","in":"path","type":"string","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"","default":"","400":"","500":""}}]},{"key":"product-marketingCatalogue-v1.0.0","title":"Product marketing catalogue","version":"v1.0.0","description":"API to retrieve the list of products under the Marketing Catalogue","endpointCount":8,"endpoints":[{"method":"GET","path":"/product/products","fullPath":"/api/v1.0.0/product/products","operationId":"getProductMarketingCatalogue","name":"Retrieves the list of Products available in Marketing Catalogue","summary":"Retrieves the list of Products available in Marketing Catalogue","tags":[],"parameters":[{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from t24 on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"ProductMarketingCatalogueResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/product/products/savingsAccounts","fullPath":"/api/v1.0.0/product/products/savingsAccounts","operationId":"getSavingsAccountCatalog","name":"Retrieves the List of Savings Accounts related products from Marketing Catalogue","summary":"Retrieves the List of Savings Accounts related products from Marketing Catalogue","tags":[],"parameters":[{"name":"currency","in":"query","type":"string","required":false,"description":"Identifies the currency. E.g. USD, GBP etc"},{"name":"customerId","in":"query","type":"string","required":false,"description":"Identifier of the customer"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from t24 on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"SavingsAccountCatalogResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/product/products/currentAccounts","fullPath":"/api/v1.0.0/product/products/currentAccounts","operationId":"getCurrentAccountCatalog","name":"Retrieves the List of product related to Current Accounts Products","summary":"Retrieves the List of product related to Current Accounts Products","tags":[],"parameters":[{"name":"currency","in":"query","type":"string","required":false,"description":"Identifies the currency. E.g. USD, GBP etc"},{"name":"customerId","in":"query","type":"string","required":false,"description":"Identifier of the customer"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from t24 on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"CurrentAccountCatalogResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/product/products/termDeposits","fullPath":"/api/v1.0.0/product/products/termDeposits","operationId":"getTermDepositsCatalog","name":"Retrieves the List of products related to Term Deposit","summary":"Retrieves the List of products related to Term Deposit","tags":[],"parameters":[{"name":"currency","in":"query","type":"string","required":false,"description":"Identifies the currency. E.g. USD, GBP etc"},{"name":"customerId","in":"query","type":"string","required":false,"description":"Identifier of the customer"},{"name":"minTerm","in":"query","type":"string","required":false,"description":"Contains the minimum term defined for the deposit contract"},{"name":"maxTerm","in":"query","type":"string","required":false,"description":"Contains the maximum term defined for the deposit contract"},{"name":"minAmount","in":"query","type":"string","required":false,"description":"Contains the minimum principal amount defined for the deposit contract"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from t24 on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"TermDepositsCatalogResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/product/products/shortTermFinance","fullPath":"/api/v1.0.0/product/products/shortTermFinance","operationId":"getShortTermFinanceCatalog","name":"Retrieves the List of Short term finance products from Catalogue","summary":"Retrieves the List of Short term finance products from Catalogue","tags":[],"parameters":[{"name":"currency","in":"query","type":"string","required":false,"description":"Identifies the currency. E.g. USD, GBP etc"},{"name":"customerId","in":"query","type":"string","required":false,"description":"Identifier of the customer"},{"name":"minTerm","in":"query","type":"string","required":false,"description":"Contains the minimum term defined for the deposit contract"},{"name":"maxTerm","in":"query","type":"string","required":false,"description":"Contains the maximum term defined for the deposit contract"},{"name":"minAmount","in":"query","type":"string","required":false,"description":"Contains the minimum principal amount defined for the deposit contract"},{"name":"maxAmount","in":"query","type":"string","required":false,"description":"Contains the maximum principal amount defined for the deposit contract"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from t24 on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"ShortTermFinanceCatalogResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/product/products/personalLoans","fullPath":"/api/v1.0.0/product/products/personalLoans","operationId":"getPersonalLoanCatalog","name":"Retrieves the List of Personal Loans Products from marketing catalogue","summary":"Retrieves the List of Personal Loans Products from marketing catalogue","tags":[],"parameters":[{"name":"currency","in":"query","type":"string","required":false,"description":"Identifies the currency. E.g. USD, GBP etc"},{"name":"customerId","in":"query","type":"string","required":false,"description":"Identifier of the customer"},{"name":"minTerm","in":"query","type":"string","required":false,"description":"Contains the minimum term defined for the deposit contract"},{"name":"maxTerm","in":"query","type":"string","required":false,"description":"Contains the maximum term defined for the deposit contract"},{"name":"minAmount","in":"query","type":"string","required":false,"description":"Contains the minimum principal amount defined for the deposit contract"},{"name":"maxAmount","in":"query","type":"string","required":false,"description":"Contains the maximum principal amount defined for the deposit contract"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from t24 on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"PersonalLoanCatalogResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/product/products/mortgages","fullPath":"/api/v1.0.0/product/products/mortgages","operationId":"getMortgageCatalog","name":"Retrieves the List of Mortgage Products available in Marketing Catalogue","summary":"Retrieves the List of Mortgage Products available in Marketing Catalogue","tags":[],"parameters":[{"name":"currency","in":"query","type":"string","required":false,"description":"Identifies the currency. E.g. USD, GBP etc"},{"name":"customerId","in":"query","type":"string","required":false,"description":"Identifier of the customer"},{"name":"minTerm","in":"query","type":"string","required":false,"description":"Contains the minimum term defined for the deposit contract"},{"name":"maxTerm","in":"query","type":"string","required":false,"description":"Contains the maximum term defined for the deposit contract"},{"name":"minAmount","in":"query","type":"string","required":false,"description":"Contains the minimum principal amount defined for the deposit contract"},{"name":"maxAmount","in":"query","type":"string","required":false,"description":"Contains the maximum principal amount defined for the deposit contract"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from t24 on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"MortgageCatalogResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/product/products/homePurchase","fullPath":"/api/v1.0.0/product/products/homePurchase","operationId":"getHomePurchaseCatalog","name":"Retrieves the List of Home Purchase Products available from Marketing Catalogue","summary":"Retrieves the List of Home Purchase Products available from Marketing Catalogue","tags":[],"parameters":[{"name":"currency","in":"query","type":"string","required":false,"description":"Identifies the currency. E.g. USD, GBP etc"},{"name":"customerId","in":"query","type":"string","required":false,"description":"Identifier of the customer"},{"name":"minTerm","in":"query","type":"string","required":false,"description":"Contains the minimum term defined for the deposit contract"},{"name":"maxTerm","in":"query","type":"string","required":false,"description":"Contains the maximum term defined for the deposit contract"},{"name":"minAmount","in":"query","type":"string","required":false,"description":"Contains the minimum principal amount defined for the deposit contract"},{"name":"maxAmount","in":"query","type":"string","required":false,"description":"Contains the maximum principal amount defined for the deposit contract"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from t24 on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"HomePurchaseCatalogResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}}]},{"key":"product-productManagers-service-v1.0.0","title":"Product Manager APIs","version":"v1.0.0","description":"Management of products","endpointCount":1,"endpoints":[{"method":"PUT","path":"/product/productManagers/{productId}","fullPath":"/api/v1.0.0/product/productManagers/{productId}","operationId":"updateProductManager","name":"Update the action such as PROOF and PUBLISH for the specific product-This API is deprecated","summary":"Update the action for product","tags":[],"parameters":[{"name":"productId","in":"path","type":"string","required":true,"description":"Contains the unique identifier of the product, e.g. the product id of the arrangement account."},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"displayName":"string","action":"string","availableDate":"2024-01-01","processMethod":"string"}},"responses":{"200":"ProductManagerResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}}]},{"key":"product-products-v1.0.0","title":"Product Builder","version":"v1.0.0","description":"API to create, update and manage the product definition details, interest conditions, repayment calculator, simulate a loan contract and project the schedules","endpointCount":30,"endpoints":[{"method":"GET","path":"/product/productDetails/productLines/{productLineId}/productGroups/{productGroupId}/products/","fullPath":"/api/v1.0.0/product/productDetails/productLines/{productLineId}/productGroups/{productGroupId}/products/","operationId":"getProductsPerLineAndGroup","name":"Retrieves the details of all the products based on a given Product line and Product group-This API is deprecated and going forward the following URL has to be used.URL:/product/productLines/{productLineId}/productGroups/{productGroupId}/products","summary":"Retrieves the details of all the products based on a given Product line and Product group","tags":[],"parameters":[{"name":"productLineId","in":"path","type":"string","required":true,"description":"The top level product line, which the product is ultimately attached to. May be a Temenos-defined product line such as ACCOUNTS, AGENT, BUNDLE, CONSENT, DEPOSITS, LENDING, REWARDS, etc. or one defined"},{"name":"productGroupId","in":"path","type":"string","required":true,"description":"The group, as defined by the institution, that the product belongs to."},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"ProductsPerLineAndGroupResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/product/productDetails/productLines/{productLineId}/productGroups","fullPath":"/api/v1.0.0/product/productDetails/productLines/{productLineId}/productGroups","operationId":"getProductGroups","name":"Retrieves the details of all the products based on a given Product line-This API is deprecated and going forward the following URL has to be used.URL:/product/productLines/{productLineId}/productGroups","summary":"Retrieves the details of all the products based on a given Product line","tags":[],"parameters":[{"name":"productLineId","in":"path","type":"string","required":true,"description":"The top level product line, which the product is ultimately attached to. May be a Temenos-defined product line such as ACCOUNTS, AGENT, BUNDLE, CONSENT, DEPOSITS, LENDING, REWARDS, etc. or one defined"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"ProductGroupsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/product/productDetails/productLines/{productLineId}/activities","fullPath":"/api/v1.0.0/product/productDetails/productLines/{productLineId}/activities","operationId":"getProductLineActivities","name":"Retrieves the list of activities applicable for a given product line-This API is deprecated and going forward the following URL has to be used.URL:/product/productLines/{productLineId}/activities","summary":"Retrieves the list of activities applicable for a given product line","tags":[],"parameters":[{"name":"productLineId","in":"path","type":"string","required":true,"description":"The top level product line, which the product is ultimately attached to. May be a Temenos-defined product line such as ACCOUNTS, AGENT, BUNDLE, CONSENT, DEPOSITS, LENDING, REWARDS, etc. or one defined"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"ProductLineActivitiesResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/product/productDetails/productLines","fullPath":"/api/v1.0.0/product/productDetails/productLines","operationId":"getProductLines","name":"Retrieves the list of available Product Line-This API is deprecated and going forward the following URL has to be used.URL: /product/productLines","summary":"Retrieves the list of available Product Line","tags":[],"parameters":[{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"ProductLinesResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/product/productDetails/products/","fullPath":"/api/v1.0.0/product/productDetails/products/","operationId":"getAllProducts","name":"Retrieves all the Product available in the Catalogue-This API is deprecated and going forward the following URL has to be used.URL:/product/products","summary":"Retrieves all the Product available in the Catalogue","tags":[],"parameters":[{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"AllProductsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/product/productDetails/products/{productId}","fullPath":"/api/v1.0.0/product/productDetails/products/{productId}","operationId":"getProducts","name":"Retrieves the details of a given Product-This API is deprecated and going forward the following URL has to be used.URL:/product/products/{productId}","summary":"Retrieves the details of a given Product","tags":[],"parameters":[{"name":"productId","in":"path","type":"string","required":true,"description":""},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"ProductsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/product/productDetails/propertyClasses","fullPath":"/api/v1.0.0/product/productDetails/propertyClasses","operationId":"getPropertyClasses","name":"Retrieves the product's property class information, which is used for building products-This API is deprecated and going forward the following URL has to be used.URL:/product/propertyClasses","summary":"Retrieves the product's property class information, which is used for building products","tags":[],"parameters":[{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"PropertyClassesResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/product/productDetails/productGroups","fullPath":"/api/v1.0.0/product/productDetails/productGroups","operationId":"getAllProductGroups","name":"Retrieves the List of Product Group available with its Product Line-This API is deprecated and going forward the following URL has to be used.URL:/product/productGroups","summary":"Retrieves the List of Product Group available with its Product Line","tags":[],"parameters":[{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"AllProductGroupsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/product/{productId}/productDetails","fullPath":"/api/v1.0.0/product/{productId}/productDetails","operationId":"getProductDetails","name":"Retrieve the product details for a catalogued product-This API is deprecated and going forward the following URL has to be used.URL:/product/{productId}","summary":"Retrieve the product details for a catalogued product","tags":[],"parameters":[{"name":"productId","in":"path","type":"string","required":true,"description":"Contains the unique identifier of the product, e.g. the product id of the arrangement account."},{"name":"currency","in":"query","type":"string","required":true,"description":"Identifies the currency. E.g. USD, GBP etc"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"ProductDetailsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/product/productBuilder/interestConditions","fullPath":"/api/v1.0.0/product/productBuilder/interestConditions","operationId":"getAllInterestConditions","name":"Retrieves the list of all the available interest conditions","summary":"Retrieves the list of all the available interest conditions","tags":[],"parameters":[{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"AllInterestConditionsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/product/productBuilder/interestConditions/{interestConditionId}","fullPath":"/api/v1.0.0/product/productBuilder/interestConditions/{interestConditionId}","operationId":"getInterestConditions","name":"Retrieves the details of the given interest condition","summary":"Retrieves the details of the given interest condition","tags":[],"parameters":[{"name":"interestConditionId","in":"path","type":"string","required":true,"description":"The identifier of the product condition used to define the interest rate"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"InterestConditionsResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"POST","path":"/product/productBuilder/interestConditions/{interestConditionId}","fullPath":"/api/v1.0.0/product/productBuilder/interestConditions/{interestConditionId}","operationId":"createInterestCondition","name":"Creates a new interest condition record","summary":"Creates a new interest condition record","tags":[],"parameters":[{"name":"interestConditionId","in":"path","type":"string","required":true,"description":"The identifier of the product condition used to define the interest rate"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"rates":[{}],"displayNames":[{}],"rateTierType":"string","linkedArrangement":"string","defaultNegotiable":"string"}},"responses":{"200":"InterestConditionResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/product/productBuilder/interestConditions/{interestConditionId}","fullPath":"/api/v1.0.0/product/productBuilder/interestConditions/{interestConditionId}","operationId":"updateInterestCondition","name":"Updates an existing interest condition record","summary":"Updates an existing interest condition record","tags":[],"parameters":[{"name":"interestConditionId","in":"path","type":"string","required":true,"description":"The identifier of the product condition used to define the interest rate"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"rates":[{}],"displayNames":[{}],"rateTierType":"string","linkedArrangement":"string","defaultNegotiable":"string"}},"responses":{"200":"InterestConditionResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/product/productBuilder/productConditions","fullPath":"/api/v1.0.0/product/productBuilder/productConditions","operationId":"getProductConditions","name":"Retrieves the list of Product Conditions available","summary":"Retrieves the list of Product Conditions available","tags":[],"parameters":[{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"ProductConditionsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/product/productBuilder/properties/","fullPath":"/api/v1.0.0/product/productBuilder/properties/","operationId":"getProperties","name":"Retrieves the details of all the available properties","summary":"Retrieves the details of all the available properties","tags":[],"parameters":[{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"PropertiesResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/product/productBuilder/projects","fullPath":"/api/v1.0.0/product/productBuilder/projects","operationId":"getProjects","name":"Retrieves the list of available projects created to build a product","summary":"Retrieves the list of available projects created to build a product","tags":[],"parameters":[{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"ProjectsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/product/{productId}/commitment/{amount}/period/{term}","fullPath":"/api/v1.0.0/product/{productId}/commitment/{amount}/period/{term}","operationId":"getRepaymentCalculator","name":"Retrieves the Repayment Details for the given Product, Principal amount and Term","summary":"Retrieves the Repayment Details for the given Product, Principal amount and Term","tags":[],"parameters":[{"name":"productId","in":"path","type":"string","required":true,"description":"Contains the unique identifier of the product, e.g. the product id of the arrangement account."},{"name":"amount","in":"path","type":"string","required":true,"description":"This is the payment amount"},{"name":"term","in":"path","type":"string","required":true,"description":"Indicates the period to which the BID and OFFER rates apply"},{"name":"currencyId","in":"query","type":"string","required":true,"description":"Identifier of the currency. This is the 3-letter ISO 4217 code of the currency."},{"name":"paymentFrequency","in":"query","type":"string","required":true,"description":"The frequency at which a payment is required to be generated"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"RepaymentCalculatorResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"POST","path":"/product/loans/simulations","fullPath":"/api/v1.0.0/product/loans/simulations","operationId":"createSynchronousSimulation","name":"API to simulate a Loan Arrangement for the given principal amount, term, payment frequency and interest rates","summary":"Simulate a Loan Arrangement for the given principal amount, term, payment frequency and interest rates","tags":[],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"customerIds":[{}],"properties":[{}],"overrides":[{}],"productId":"string","masterArrangementId":"string","roleName":"string","currencyId":"string","effectiveDate":"2024-01-01","activityId":"string","transactionAmount":0.0}},"responses":{"200":"createSynchronousSimulationResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"POST","path":"/product/loans/simulations/schedules","fullPath":"/api/v1.0.0/product/loans/simulations/schedules","operationId":"createSynchronousSimulationSchedules","name":"Simulate a loan arrangement for the given Principal amount, Term, Payment frequency and Interest rates. This API allows to retrieve the details of payment schedules for the simulated contract","summary":"Simulate a loan arrangement and retrieve the payment schedule details","tags":[],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"customerIds":[{}],"properties":[{}],"overrides":[{}],"productId":"string","masterArrangementId":"string","roleName":"string","currencyId":"string","effectiveDate":"2024-01-01","activityId":"string","transactionAmount":0.0}},"responses":{"200":"createSynchronousSimulationSchedulesResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"GET","path":"/product/productTypes","fullPath":"/api/v1.0.0/product/productTypes","operationId":"getAllProductTypes","name":"Retrieves the list of product types available in Transact system","summary":"Retrieves the list of product types available in Transact system","tags":[],"parameters":[{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"AllProductTypesResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/product/productTypes/{productType}","fullPath":"/api/v1.0.0/product/productTypes/{productType}","operationId":"getProductType","name":"Retrieves the product type details for a given Product Type","summary":"Retrieves the product type details for a given Product Type","tags":[],"parameters":[{"name":"productType","in":"path","type":"string","required":true,"description":"Indicates the product type for the deal"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"ProductTypeResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/product/productTypes/products/{productId}","fullPath":"/api/v1.0.0/product/productTypes/products/{productId}","operationId":"getProductStatus","name":"Retrieves the basic details such as product details,status,proof and publish errors if any","summary":"Retrieves the basic details of a given product","tags":[],"parameters":[{"name":"productId","in":"path","type":"string","required":true,"description":"Contains the unique identifier of the product, e.g. the product id of the arrangement account."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"ProductStatusResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"POST","path":"/product/productTypes/products/{productId}","fullPath":"/api/v1.0.0/product/productTypes/products/{productId}","operationId":"createProducts","name":"Create a product from a product type","summary":"Create a product using the conditions available from the product type","tags":[],"parameters":[{"name":"productId","in":"path","type":"string","required":true,"description":"Contains the unique identifier of the product, e.g. the product id of the arrangement account."},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"id":"string","status":"string","transactionStatus":"string","uniqueIdentifier":"string","audit":{"T24_time":{},"versionNumber":{},"requestParse_time":{},"responseParse_time":{}}},"body":{"productType":"string","productId":"string","productName":"string","productDescription":"string","availableCurrency":[{}],"effectiveDate":"string","version":"string","productAttributes":[{}],"propertyList":[{}]}},"responses":{"200":"ProductsResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/product/productTypes/products/{productId}","fullPath":"/api/v1.0.0/product/productTypes/products/{productId}","operationId":"updateProducts","name":"Update a product such as property conditions and its condition values","summary":"Update a product such as property conditions and its condition values","tags":[],"parameters":[{"name":"productId","in":"path","type":"string","required":true,"description":"Contains the unique identifier of the product, e.g. the product id of the arrangement account."},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"id":"string","status":"string","transactionStatus":"string","uniqueIdentifier":"string","audit":{"T24_time":{},"versionNumber":{},"requestParse_time":{},"responseParse_time":{}}},"body":{"productType":"string","productId":"string","productName":"string","productDescription":"string","availableCurrency":[{}],"effectiveDate":"string","version":"string","productAttributes":[{}],"propertyList":[{}]}},"responses":{"200":"ProductsResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/product/productFeatures/{productFeatureId}/attributes","fullPath":"/api/v1.0.0/product/productFeatures/{productFeatureId}/attributes","operationId":"getPropertyFields","name":"Retrieves the attribute and the field structure for the given product feature","summary":"Retrieves the attribute and the field structure","tags":[],"parameters":[{"name":"productFeatureId","in":"path","type":"string","required":true,"description":""},{"name":"productConditionId","in":"query","type":"string","required":false,"description":"The identifier of the product condition"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"PropertyFieldsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/product/productGroups/{productGroupId}/productFeatures/productConditions","fullPath":"/api/v1.0.0/product/productGroups/{productGroupId}/productFeatures/productConditions","operationId":"getProductLineFeatureConditions","name":"Retrieves the product conditions for the product features present in the product group","summary":"Retrieves the product conditions for the product features","tags":[],"parameters":[{"name":"productGroupId","in":"path","type":"string","required":true,"description":"The group, as defined by the institution, that the product belongs to."},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"ProductLineFeatureConditionsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"POST","path":"/product/productConditions/{productConditionId}","fullPath":"/api/v1.0.0/product/productConditions/{productConditionId}","operationId":"createConditionGenerator","name":"Create the product condition for the product feature based on the attributes and their field name and values","summary":"Create the product condition for the product feature","tags":[],"parameters":[{"name":"productConditionId","in":"path","type":"string","required":true,"description":"The identifier of the product condition"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"propertyId":"string","conditionName":"string","effectiveDate":"string","currencies":[{}]}},"responses":{"200":"ConditionGeneratorResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/product/productConditions/{productConditionId}","fullPath":"/api/v1.0.0/product/productConditions/{productConditionId}","operationId":"updateConditionGenerator","name":"Update the product condition for the product feature based on the attributes and their field name and values","summary":"Update the product condition for the product feature","tags":[],"parameters":[{"name":"productConditionId","in":"path","type":"string","required":true,"description":"The identifier of the product condition"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"propertyId":"string","conditionName":"string","effectiveDate":"string","currencies":[{}]}},"responses":{"200":"ConditionGeneratorResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/product/productFeatures","fullPath":"/api/v1.0.0/product/productFeatures","operationId":"getProductLineFeatures","name":"Retrieves the list of product features and product line details","summary":"Retrieves the list of features","tags":[],"parameters":[{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"ProductLineFeaturesResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/product/{productId}/productConditions","fullPath":"/api/v1.0.0/product/{productId}/productConditions","operationId":"getProductCatalogue","name":"Retrieves the catalogued conditions of a given product","summary":"Retrieves the catalogued conditions of a given product","tags":["RETAIL"],"parameters":[{"name":"productId","in":"path","type":"string","required":true,"description":"Contains the unique identifier of the product, e.g. the product id of the arrangement account."},{"name":"currency","in":"query","type":"string","required":false,"description":"Identifies the currency. E.g. USD, GBP etc"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"ProductCatalogueResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}}]},{"key":"product-products-v2.0.0","title":"Product Builder","version":"v2.0.0","description":"API to create, update and manage the product definition details, interest conditions, repayment calculator, simulate a loan contract and project the schedules","endpointCount":33,"endpoints":[{"method":"GET","path":"/product/productLines/{productLineId}/productGroups/{productGroupId}/products","fullPath":"/api/v2.0.0/product/productLines/{productLineId}/productGroups/{productGroupId}/products","operationId":"getProductsPerLineAndGroup","name":"Retrieves the details of all the products based on a given Product line and Product group","summary":"Retrieves the details of all the products based on a given Product line and Product group","tags":[],"parameters":[{"name":"productLineId","in":"path","type":"string","required":true,"description":"The top level product line, which the product is ultimately attached to. May be a Temenos-defined product line such as ACCOUNTS, AGENT, BUNDLE, CONSENT, DEPOSITS, LENDING, REWARDS, etc. or one defined"},{"name":"productGroupId","in":"path","type":"string","required":true,"description":"The group, as defined by the institution, that the product belongs to."},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"ProductsPerLineAndGroupResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/product/productLines/{productLineId}/productGroups","fullPath":"/api/v2.0.0/product/productLines/{productLineId}/productGroups","operationId":"getProductGroups","name":"Retrieves the details of all the products based on a given Product line","summary":"Retrieves the details of all the products based on a given Product line","tags":[],"parameters":[{"name":"productLineId","in":"path","type":"string","required":true,"description":"The top level product line, which the product is ultimately attached to. May be a Temenos-defined product line such as ACCOUNTS, AGENT, BUNDLE, CONSENT, DEPOSITS, LENDING, REWARDS, etc. or one defined"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"ProductGroupsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/product/productLines/{productLineId}/activities","fullPath":"/api/v2.0.0/product/productLines/{productLineId}/activities","operationId":"getProductLineActivities","name":"Retrieves the list of activities applicable for a given product line","summary":"Retrieves the list of activities applicable for a given product line","tags":[],"parameters":[{"name":"productLineId","in":"path","type":"string","required":true,"description":"The top level product line, which the product is ultimately attached to. May be a Temenos-defined product line such as ACCOUNTS, AGENT, BUNDLE, CONSENT, DEPOSITS, LENDING, REWARDS, etc. or one defined"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"ProductLineActivitiesResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/product/productLines","fullPath":"/api/v2.0.0/product/productLines","operationId":"getProductLines","name":"Retrieves the list of available Product Line","summary":"Retrieves the list of available Product Line","tags":[],"parameters":[{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"ProductLinesResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/product/products","fullPath":"/api/v2.0.0/product/products","operationId":"getAllProducts","name":"Retrieves all the Product available in the Catalogue","summary":"Retrieves all the Product available in the Catalogue","tags":[],"parameters":[{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"AllProductsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/product/products/{productId}","fullPath":"/api/v2.0.0/product/products/{productId}","operationId":"getProducts","name":"Retrieves the details of a given Product","summary":"Retrieves the details of a given Product","tags":[],"parameters":[{"name":"productId","in":"path","type":"string","required":true,"description":""},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"ProductsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/product/propertyClasses","fullPath":"/api/v2.0.0/product/propertyClasses","operationId":"getPropertyClasses","name":"Retrieves the product's property class information, which is used for building products","summary":"Retrieves the product's property class information, which is used for building products","tags":[],"parameters":[{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"PropertyClassesResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/product/productGroups","fullPath":"/api/v2.0.0/product/productGroups","operationId":"getAllProductGroups","name":"Retrieves the List of Product Group available with its Product Line","summary":"Retrieves the List of Product Group available with its Product Line","tags":[],"parameters":[{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"AllProductGroupsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/product/{productId}","fullPath":"/api/v2.0.0/product/{productId}","operationId":"getProductDetails","name":"Retrieve the product details for a catalogued product","summary":"Retrieve the product details for a catalogued product","tags":[],"parameters":[{"name":"productId","in":"path","type":"string","required":true,"description":"Contains the unique identifier of the product, e.g. the product id of the arrangement account."},{"name":"currency","in":"query","type":"string","required":true,"description":"Identifies the currency. E.g. USD, GBP etc"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"ProductDetailsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/product/productBuilder/interestConditions","fullPath":"/api/v2.0.0/product/productBuilder/interestConditions","operationId":"getAllInterestConditions","name":"Retrieves the list of all the available interest conditions","summary":"Retrieves the list of all the available interest conditions","tags":[],"parameters":[{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"AllInterestConditionsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/product/productBuilder/interestConditions/{interestConditionId}","fullPath":"/api/v2.0.0/product/productBuilder/interestConditions/{interestConditionId}","operationId":"getInterestConditions","name":"Retrieves the details of the given interest condition","summary":"Retrieves the details of the given interest condition","tags":[],"parameters":[{"name":"interestConditionId","in":"path","type":"string","required":true,"description":"The identifier of the product condition used to define the interest rate"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"InterestConditionsResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"POST","path":"/product/productBuilder/interestConditions/{interestConditionId}","fullPath":"/api/v2.0.0/product/productBuilder/interestConditions/{interestConditionId}","operationId":"createInterestCondition","name":"Creates a new interest condition record","summary":"Creates a new interest condition record","tags":[],"parameters":[{"name":"interestConditionId","in":"path","type":"string","required":true,"description":"The identifier of the product condition used to define the interest rate"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"rates":[{}],"displayNames":[{}],"rateTierType":"string","linkedArrangement":"string","defaultNegotiable":"string"}},"responses":{"200":"InterestConditionResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/product/productBuilder/interestConditions/{interestConditionId}","fullPath":"/api/v2.0.0/product/productBuilder/interestConditions/{interestConditionId}","operationId":"updateInterestCondition","name":"Updates an existing interest condition record","summary":"Updates an existing interest condition record","tags":[],"parameters":[{"name":"interestConditionId","in":"path","type":"string","required":true,"description":"The identifier of the product condition used to define the interest rate"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"rates":[{}],"displayNames":[{}],"rateTierType":"string","linkedArrangement":"string","defaultNegotiable":"string"}},"responses":{"200":"InterestConditionResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/product/productBuilder/productConditions","fullPath":"/api/v2.0.0/product/productBuilder/productConditions","operationId":"getProductConditions","name":"Retrieves the list of Product Conditions available","summary":"Retrieves the list of Product Conditions available","tags":[],"parameters":[{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"ProductConditionsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/product/productBuilder/properties","fullPath":"/api/v2.0.0/product/productBuilder/properties","operationId":"getProperties","name":"Retrieves the details of all the available properties","summary":"Retrieves the details of all the available properties","tags":[],"parameters":[{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"PropertiesResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/product/productBuilder/projects","fullPath":"/api/v2.0.0/product/productBuilder/projects","operationId":"getProjects","name":"Retrieves the list of available projects created to build a product","summary":"Retrieves the list of available projects created to build a product","tags":[],"parameters":[{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"ProjectsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/product/{productId}/commitment/{amount}/period/{term}","fullPath":"/api/v2.0.0/product/{productId}/commitment/{amount}/period/{term}","operationId":"getRepaymentCalculator","name":"Retrieves the Repayment Details for the given Product, Principal amount and Term","summary":"Retrieves the Repayment Details for the given Product, Principal amount and Term","tags":[],"parameters":[{"name":"productId","in":"path","type":"string","required":true,"description":"Contains the unique identifier of the product, e.g. the product id of the arrangement account."},{"name":"amount","in":"path","type":"string","required":true,"description":"This is the payment amount"},{"name":"term","in":"path","type":"string","required":true,"description":"Indicates the period to which the BID and OFFER rates apply"},{"name":"currencyId","in":"query","type":"string","required":true,"description":"Identifier of the currency. This is the 3-letter ISO 4217 code of the currency."},{"name":"paymentFrequency","in":"query","type":"string","required":true,"description":"The frequency at which a payment is required to be generated"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"RepaymentCalculatorResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"POST","path":"/product/loans/simulations","fullPath":"/api/v2.0.0/product/loans/simulations","operationId":"createSynchronousSimulation","name":"API to simulate a Loan Arrangement for the given principal amount, term, payment frequency and interest rates","summary":"Simulate a Loan Arrangement for the given principal amount, term, payment frequency and interest rates","tags":[],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"customerIds":[{}],"properties":[{}],"overrides":[{}],"productId":"string","masterArrangementId":"string","roleName":"string","currencyId":"string","effectiveDate":"2024-01-01","activityId":"string","transactionAmount":0.0}},"responses":{"200":"createSynchronousSimulationResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"POST","path":"/product/loans/simulations/schedules","fullPath":"/api/v2.0.0/product/loans/simulations/schedules","operationId":"createSynchronousSimulationSchedules","name":"Simulate a loan arrangement for the given Principal amount, Term, Payment frequency and Interest rates. This API allows to retrieve the details of payment schedules for the simulated contract","summary":"Simulate a loan arrangement and retrieve the payment schedule details","tags":[],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"customerIds":[{}],"properties":[{}],"overrides":[{}],"productId":"string","masterArrangementId":"string","roleName":"string","currencyId":"string","effectiveDate":"2024-01-01","activityId":"string","transactionAmount":0.0}},"responses":{"200":"createSynchronousSimulationSchedulesResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"GET","path":"/product/productTypes","fullPath":"/api/v2.0.0/product/productTypes","operationId":"getAllProductTypes","name":"Retrieves the list of product types available in Transact system","summary":"Retrieves the list of product types available in Transact system","tags":[],"parameters":[{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"AllProductTypesResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/product/productTypes/{productType}","fullPath":"/api/v2.0.0/product/productTypes/{productType}","operationId":"getProductType","name":"Retrieves the product type details for a given Product Type","summary":"Retrieves the product type details for a given Product Type","tags":[],"parameters":[{"name":"productType","in":"path","type":"string","required":true,"description":"Indicates the product type for the deal"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"ProductTypeResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/product/productTypes/products/{productId}","fullPath":"/api/v2.0.0/product/productTypes/products/{productId}","operationId":"getProductStatus","name":"Retrieves the basic details such as product details,status,proof and publish errors if any","summary":"Retrieves the basic details of a given product","tags":[],"parameters":[{"name":"productId","in":"path","type":"string","required":true,"description":"Contains the unique identifier of the product, e.g. the product id of the arrangement account."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"ProductStatusResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"POST","path":"/product/productTypes/products/{productId}","fullPath":"/api/v2.0.0/product/productTypes/products/{productId}","operationId":"createProducts","name":"Create a product from a product type","summary":"Create a product using the conditions available from the product type","tags":[],"parameters":[{"name":"productId","in":"path","type":"string","required":true,"description":"Contains the unique identifier of the product, e.g. the product id of the arrangement account."},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"id":"string","status":"string","transactionStatus":"string","uniqueIdentifier":"string","audit":{"T24_time":{},"versionNumber":{},"requestParse_time":{},"responseParse_time":{}}},"body":{"productType":"string","productId":"string","productName":"string","productDescription":"string","availableCurrency":[{}],"effectiveDate":"string","version":"string","productAttributes":[{}],"propertyList":[{}]}},"responses":{"200":"ProductsResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/product/productTypes/products/{productId}","fullPath":"/api/v2.0.0/product/productTypes/products/{productId}","operationId":"updateProducts","name":"Update a product such as property conditions and its condition values","summary":"Update a product such as property conditions and its condition values","tags":[],"parameters":[{"name":"productId","in":"path","type":"string","required":true,"description":"Contains the unique identifier of the product, e.g. the product id of the arrangement account."},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"id":"string","status":"string","transactionStatus":"string","uniqueIdentifier":"string","audit":{"T24_time":{},"versionNumber":{},"requestParse_time":{},"responseParse_time":{}}},"body":{"productType":"string","productId":"string","productName":"string","productDescription":"string","availableCurrency":[{}],"effectiveDate":"string","version":"string","productAttributes":[{}],"propertyList":[{}]}},"responses":{"200":"ProductsResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/product/productFeatures/{productFeatureId}/attributes","fullPath":"/api/v2.0.0/product/productFeatures/{productFeatureId}/attributes","operationId":"getPropertyFields","name":"Retrieves the attribute and the field structure for the given product feature","summary":"Retrieves the attribute and the field structure","tags":[],"parameters":[{"name":"productFeatureId","in":"path","type":"string","required":true,"description":""},{"name":"productConditionId","in":"query","type":"string","required":false,"description":"The identifier of the product condition"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"PropertyFieldsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/product/productGroups/{productGroupId}/productFeatures/productConditions","fullPath":"/api/v2.0.0/product/productGroups/{productGroupId}/productFeatures/productConditions","operationId":"getProductLineFeatureConditions","name":"Retrieves the product conditions for the product features present in the product group","summary":"Retrieves the product conditions for the product features","tags":[],"parameters":[{"name":"productGroupId","in":"path","type":"string","required":true,"description":"The group, as defined by the institution, that the product belongs to."},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"ProductLineFeatureConditionsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/product/productConditions/{productConditionId}","fullPath":"/api/v2.0.0/product/productConditions/{productConditionId}","operationId":"getConditionGenerator","name":"Retrieves the base condition details of a product feature such as the attributes ,their field name and values,status and validation errors if any","summary":"Retrieves the base condition details of a product feature","tags":[],"parameters":[{"name":"productConditionId","in":"path","type":"string","required":true,"description":"The identifier of the product condition"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"ConditionGeneratorResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"POST","path":"/product/productConditions/{productConditionId}","fullPath":"/api/v2.0.0/product/productConditions/{productConditionId}","operationId":"createConditionGenerator","name":"Create the product condition for the product feature based on the attributes and their field name and values","summary":"Create the product condition for the product feature","tags":[],"parameters":[{"name":"productConditionId","in":"path","type":"string","required":true,"description":"The identifier of the product condition"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"propertyId":"string","conditionName":"string","effectiveDate":"string","currencies":[{}]}},"responses":{"200":"ConditionGeneratorResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/product/productConditions/{productConditionId}","fullPath":"/api/v2.0.0/product/productConditions/{productConditionId}","operationId":"updateConditionGenerator","name":"Update the product condition for the product feature based on the attributes and their field name and values","summary":"Update the product condition for the product feature","tags":[],"parameters":[{"name":"productConditionId","in":"path","type":"string","required":true,"description":"The identifier of the product condition"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"propertyId":"string","conditionName":"string","effectiveDate":"string","currencies":[{}]}},"responses":{"200":"ConditionGeneratorResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/product/productFeatures","fullPath":"/api/v2.0.0/product/productFeatures","operationId":"getProductLineFeatures","name":"Retrieves the list of product features and product line details","summary":"Retrieves the list of features","tags":[],"parameters":[{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"ProductLineFeaturesResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/product/{productId}/productConditions","fullPath":"/api/v2.0.0/product/{productId}/productConditions","operationId":"getProductCatalogue","name":"Retrieves the catalogued conditions of a given product","summary":"Retrieves the catalogued conditions of a given product","tags":["RETAIL"],"parameters":[{"name":"productId","in":"path","type":"string","required":true,"description":"Contains the unique identifier of the product, e.g. the product id of the arrangement account."},{"name":"currency","in":"query","type":"string","required":false,"description":"Identifies the currency. E.g. USD, GBP etc"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"ProductCatalogueResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"PUT","path":"/product/productManagers/{productId}","fullPath":"/api/v2.0.0/product/productManagers/{productId}","operationId":"updateProductManager","name":"Update the action such as PROOF and PUBLISH for the specific product","summary":"Update the action for product","tags":[],"parameters":[{"name":"productId","in":"path","type":"string","required":true,"description":"Contains the unique identifier of the product, e.g. the product id of the arrangement account."},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"displayName":"string","action":"string","availableDate":"2024-01-01","processMethod":"string"}},"responses":{"200":"ProductManagerResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/product/interestConditions","fullPath":"/api/v2.0.0/product/interestConditions","operationId":"getInterestConditionReference","name":"Retrieves all the available interest conditions","summary":"Retrieves all the available interest conditions","tags":[],"parameters":[{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"InterestConditionReferenceResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}}]},{"key":"product-products-v2.1.0","title":"Product Builder","version":"v2.1.0","description":"API to create, update and manage the product definition details, interest conditions, repayment calculator, simulate a loan contract and project the schedules","endpointCount":33,"endpoints":[{"method":"GET","path":"/product/productLines/{productLineId}/productGroups/{productGroupId}/products","fullPath":"/api/v2.1.0/product/productLines/{productLineId}/productGroups/{productGroupId}/products","operationId":"getProductsPerLineAndGroup","name":"Retrieves the details of all the products based on a given Product line and Product group","summary":"Retrieves the details of all the products based on a given Product line and Product group","tags":[],"parameters":[{"name":"productLineId","in":"path","type":"string","required":true,"description":"The top level product line, which the product is ultimately attached to. May be a Temenos-defined product line such as ACCOUNTS, AGENT, BUNDLE, CONSENT, DEPOSITS, LENDING, REWARDS, etc. or one defined"},{"name":"productGroupId","in":"path","type":"string","required":true,"description":"The group, as defined by the institution, that the product belongs to."},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"ProductsPerLineAndGroupResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/product/productLines/{productLineId}/productGroups","fullPath":"/api/v2.1.0/product/productLines/{productLineId}/productGroups","operationId":"getProductGroups","name":"Retrieves the details of all the products based on a given Product line","summary":"Retrieves the details of all the products based on a given Product line","tags":[],"parameters":[{"name":"productLineId","in":"path","type":"string","required":true,"description":"The top level product line, which the product is ultimately attached to. May be a Temenos-defined product line such as ACCOUNTS, AGENT, BUNDLE, CONSENT, DEPOSITS, LENDING, REWARDS, etc. or one defined"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"ProductGroupsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/product/productLines/{productLineId}/activities","fullPath":"/api/v2.1.0/product/productLines/{productLineId}/activities","operationId":"getProductLineActivities","name":"Retrieves the list of activities applicable for a given product line","summary":"Retrieves the list of activities applicable for a given product line","tags":[],"parameters":[{"name":"productLineId","in":"path","type":"string","required":true,"description":"The top level product line, which the product is ultimately attached to. May be a Temenos-defined product line such as ACCOUNTS, AGENT, BUNDLE, CONSENT, DEPOSITS, LENDING, REWARDS, etc. or one defined"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"ProductLineActivitiesResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/product/productLines","fullPath":"/api/v2.1.0/product/productLines","operationId":"getProductLines","name":"Retrieves the list of available Product Line","summary":"Retrieves the list of available Product Line","tags":[],"parameters":[{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"ProductLinesResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/product/products","fullPath":"/api/v2.1.0/product/products","operationId":"getAllProducts","name":"Retrieves all the Product available in the Catalogue","summary":"Retrieves all the Product available in the Catalogue","tags":[],"parameters":[{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"AllProductsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/product/products/{productId}","fullPath":"/api/v2.1.0/product/products/{productId}","operationId":"getProducts","name":"Retrieves the details of a given Product","summary":"Retrieves the details of a given Product","tags":[],"parameters":[{"name":"productId","in":"path","type":"string","required":true,"description":""},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"ProductsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/product/propertyClasses","fullPath":"/api/v2.1.0/product/propertyClasses","operationId":"getPropertyClasses","name":"Retrieves the product's property class information, which is used for building products","summary":"Retrieves the product's property class information, which is used for building products","tags":[],"parameters":[{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"PropertyClassesResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/product/productGroups","fullPath":"/api/v2.1.0/product/productGroups","operationId":"getAllProductGroups","name":"Retrieves the List of Product Group available with its Product Line","summary":"Retrieves the List of Product Group available with its Product Line","tags":[],"parameters":[{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"AllProductGroupsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/product/{productId}","fullPath":"/api/v2.1.0/product/{productId}","operationId":"getProductDetails","name":"Retrieve the product details for a catalogued product","summary":"Retrieve the product details for a catalogued product","tags":[],"parameters":[{"name":"productId","in":"path","type":"string","required":true,"description":"Contains the unique identifier of the product, e.g. the product id of the arrangement account."},{"name":"currency","in":"query","type":"string","required":true,"description":"Identifies the currency. E.g. USD, GBP etc"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"ProductDetailsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/product/productBuilder/interestConditions","fullPath":"/api/v2.1.0/product/productBuilder/interestConditions","operationId":"getAllInterestConditions","name":"Retrieves the list of all the available interest conditions","summary":"Retrieves the list of all the available interest conditions","tags":[],"parameters":[{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"AllInterestConditionsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/product/productBuilder/interestConditions/{interestConditionId}","fullPath":"/api/v2.1.0/product/productBuilder/interestConditions/{interestConditionId}","operationId":"getInterestConditions","name":"Retrieves the details of the given interest condition","summary":"Retrieves the details of the given interest condition","tags":[],"parameters":[{"name":"interestConditionId","in":"path","type":"string","required":true,"description":"The identifier of the product condition used to define the interest rate"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"InterestConditionsResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"POST","path":"/product/productBuilder/interestConditions/{interestConditionId}","fullPath":"/api/v2.1.0/product/productBuilder/interestConditions/{interestConditionId}","operationId":"createInterestCondition","name":"Creates a new interest condition record","summary":"Creates a new interest condition record","tags":[],"parameters":[{"name":"interestConditionId","in":"path","type":"string","required":true,"description":"The identifier of the product condition used to define the interest rate"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"rates":[{}],"displayNames":[{}],"rateTierType":"string","linkedArrangement":"string","defaultNegotiable":"string"}},"responses":{"200":"InterestConditionResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/product/productBuilder/interestConditions/{interestConditionId}","fullPath":"/api/v2.1.0/product/productBuilder/interestConditions/{interestConditionId}","operationId":"updateInterestCondition","name":"Updates an existing interest condition record","summary":"Updates an existing interest condition record","tags":[],"parameters":[{"name":"interestConditionId","in":"path","type":"string","required":true,"description":"The identifier of the product condition used to define the interest rate"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"rates":[{}],"displayNames":[{}],"rateTierType":"string","linkedArrangement":"string","defaultNegotiable":"string"}},"responses":{"200":"InterestConditionResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/product/productBuilder/productConditions","fullPath":"/api/v2.1.0/product/productBuilder/productConditions","operationId":"getProductConditions","name":"Retrieves the list of Product Conditions available","summary":"Retrieves the list of Product Conditions available","tags":[],"parameters":[{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"ProductConditionsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/product/productBuilder/properties","fullPath":"/api/v2.1.0/product/productBuilder/properties","operationId":"getProperties","name":"Retrieves the details of all the available properties","summary":"Retrieves the details of all the available properties","tags":[],"parameters":[{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"PropertiesResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/product/productBuilder/projects","fullPath":"/api/v2.1.0/product/productBuilder/projects","operationId":"getProjects","name":"Retrieves the list of available projects created to build a product","summary":"Retrieves the list of available projects created to build a product","tags":[],"parameters":[{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"ProjectsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/product/{productId}/commitment/{amount}/period/{term}","fullPath":"/api/v2.1.0/product/{productId}/commitment/{amount}/period/{term}","operationId":"getRepaymentCalculator","name":"Retrieves the Repayment Details for the given Product, Principal amount and Term","summary":"Retrieves the Repayment Details for the given Product, Principal amount and Term","tags":[],"parameters":[{"name":"productId","in":"path","type":"string","required":true,"description":"Contains the unique identifier of the product, e.g. the product id of the arrangement account."},{"name":"amount","in":"path","type":"string","required":true,"description":"This is the payment amount"},{"name":"term","in":"path","type":"string","required":true,"description":"Indicates the period to which the BID and OFFER rates apply"},{"name":"currencyId","in":"query","type":"string","required":true,"description":"Identifier of the currency. This is the 3-letter ISO 4217 code of the currency."},{"name":"paymentFrequency","in":"query","type":"string","required":true,"description":"The frequency at which a payment is required to be generated"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"RepaymentCalculatorResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"POST","path":"/product/loans/simulations","fullPath":"/api/v2.1.0/product/loans/simulations","operationId":"createSynchronousSimulation","name":"API to simulate a Loan Arrangement for the given principal amount, term, payment frequency and interest rates","summary":"Simulate a Loan Arrangement for the given principal amount, term, payment frequency and interest rates","tags":[],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"customerIds":[{}],"properties":[{}],"overrides":[{}],"productId":"string","masterArrangementId":"string","roleName":"string","currencyId":"string","effectiveDate":"2024-01-01","activityId":"string","transactionAmount":0.0}},"responses":{"200":"createSynchronousSimulationResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"POST","path":"/product/loans/simulations/schedules","fullPath":"/api/v2.1.0/product/loans/simulations/schedules","operationId":"createSynchronousSimulationSchedules","name":"Simulate a loan arrangement for the given Principal amount, Term, Payment frequency and Interest rates. This API allows to retrieve the details of payment schedules for the simulated contract","summary":"Simulate a loan arrangement and retrieve the payment schedule details","tags":[],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"customerIds":[{}],"properties":[{}],"overrides":[{}],"productId":"string","masterArrangementId":"string","roleName":"string","currencyId":"string","effectiveDate":"2024-01-01","activityId":"string","transactionAmount":0.0}},"responses":{"200":"createSynchronousSimulationSchedulesResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"GET","path":"/product/productTypes","fullPath":"/api/v2.1.0/product/productTypes","operationId":"getAllProductTypes","name":"Retrieves the list of product types available in Transact system","summary":"Retrieves the list of product types available in Transact system","tags":[],"parameters":[{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"AllProductTypesResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/product/productTypes/{productType}","fullPath":"/api/v2.1.0/product/productTypes/{productType}","operationId":"getProductType","name":"Retrieves the product type details for a given Product Type","summary":"Retrieves the product type details for a given Product Type","tags":[],"parameters":[{"name":"productType","in":"path","type":"string","required":true,"description":"Indicates the product type for the deal"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"ProductTypeResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/product/productTypes/products/{productId}","fullPath":"/api/v2.1.0/product/productTypes/products/{productId}","operationId":"getProductStatus","name":"Retrieves the basic details such as product details,status,proof and publish errors if any","summary":"Retrieves the basic details of a given product","tags":[],"parameters":[{"name":"productId","in":"path","type":"string","required":true,"description":"Contains the unique identifier of the product, e.g. the product id of the arrangement account."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"ProductStatusResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"POST","path":"/product/productTypes/products/{productId}","fullPath":"/api/v2.1.0/product/productTypes/products/{productId}","operationId":"createProducts","name":"Create a product from a product type","summary":"Create a product using the conditions available from the product type","tags":[],"parameters":[{"name":"productId","in":"path","type":"string","required":true,"description":"Contains the unique identifier of the product, e.g. the product id of the arrangement account."},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"id":"string","status":"string","transactionStatus":"string","uniqueIdentifier":"string","audit":{"T24_time":{},"versionNumber":{},"requestParse_time":{},"responseParse_time":{}}},"body":{"productType":"string","productId":"string","productName":"string","productDescription":"string","availableCurrency":[{}],"effectiveDate":"string","version":"string","productAttributes":[{}],"propertyList":[{}]}},"responses":{"200":"ProductsResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/product/productTypes/products/{productId}","fullPath":"/api/v2.1.0/product/productTypes/products/{productId}","operationId":"updateProducts","name":"Update a product such as property conditions and its condition values","summary":"Update a product such as property conditions and its condition values","tags":[],"parameters":[{"name":"productId","in":"path","type":"string","required":true,"description":"Contains the unique identifier of the product, e.g. the product id of the arrangement account."},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"id":"string","status":"string","transactionStatus":"string","uniqueIdentifier":"string","audit":{"T24_time":{},"versionNumber":{},"requestParse_time":{},"responseParse_time":{}}},"body":{"productType":"string","productId":"string","productName":"string","productDescription":"string","availableCurrency":[{}],"effectiveDate":"string","version":"string","productAttributes":[{}],"propertyList":[{}]}},"responses":{"200":"ProductsResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/product/productFeatures/{productFeatureId}/attributes","fullPath":"/api/v2.1.0/product/productFeatures/{productFeatureId}/attributes","operationId":"getPropertyFields","name":"Retrieves the attribute and the field structure for the given product feature","summary":"Retrieves the attribute and the field structure","tags":[],"parameters":[{"name":"productFeatureId","in":"path","type":"string","required":true,"description":""},{"name":"productConditionId","in":"query","type":"string","required":false,"description":"The identifier of the product condition"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"PropertyFieldsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/product/productGroups/{productGroupId}/productFeatures/productConditions","fullPath":"/api/v2.1.0/product/productGroups/{productGroupId}/productFeatures/productConditions","operationId":"getProductLineFeatureConditions","name":"Retrieves the product conditions for the product features present in the product group","summary":"Retrieves the product conditions for the product features","tags":[],"parameters":[{"name":"productGroupId","in":"path","type":"string","required":true,"description":"The group, as defined by the institution, that the product belongs to."},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"ProductLineFeatureConditionsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/product/productConditions/{productConditionId}","fullPath":"/api/v2.1.0/product/productConditions/{productConditionId}","operationId":"getConditionGenerator","name":"Retrieves the base condition details of a product feature such as the attributes ,their field name and values,status and validation errors if any","summary":"Retrieves the base condition details of a product feature","tags":[],"parameters":[{"name":"productConditionId","in":"path","type":"string","required":true,"description":"The identifier of the product condition"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"ConditionGeneratorResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"POST","path":"/product/productConditions/{productConditionId}","fullPath":"/api/v2.1.0/product/productConditions/{productConditionId}","operationId":"createConditionGenerator","name":"Create the product condition for the product feature based on the attributes and their field name and values","summary":"Create the product condition for the product feature","tags":[],"parameters":[{"name":"productConditionId","in":"path","type":"string","required":true,"description":"The identifier of the product condition"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"propertyId":"string","conditionName":"string","effectiveDate":"string","currencies":[{}]}},"responses":{"200":"ConditionGeneratorResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/product/productConditions/{productConditionId}","fullPath":"/api/v2.1.0/product/productConditions/{productConditionId}","operationId":"updateConditionGenerator","name":"Update the product condition for the product feature based on the attributes and their field name and values","summary":"Update the product condition for the product feature","tags":[],"parameters":[{"name":"productConditionId","in":"path","type":"string","required":true,"description":"The identifier of the product condition"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"propertyId":"string","conditionName":"string","effectiveDate":"string","currencies":[{}]}},"responses":{"200":"ConditionGeneratorResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/product/productFeatures","fullPath":"/api/v2.1.0/product/productFeatures","operationId":"getProductLineFeatures","name":"Retrieves the list of product features and product line details","summary":"Retrieves the list of features","tags":[],"parameters":[{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"ProductLineFeaturesResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/product/{productId}/productConditions","fullPath":"/api/v2.1.0/product/{productId}/productConditions","operationId":"getProductCatalogue","name":"Retrieves the catalogued conditions of a given product","summary":"Retrieves the catalogued conditions of a given product","tags":["RETAIL"],"parameters":[{"name":"productId","in":"path","type":"string","required":true,"description":"Contains the unique identifier of the product, e.g. the product id of the arrangement account."},{"name":"currency","in":"query","type":"string","required":false,"description":"Identifies the currency. E.g. USD, GBP etc"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"ProductCatalogueResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"PUT","path":"/product/productManagers/{productId}","fullPath":"/api/v2.1.0/product/productManagers/{productId}","operationId":"updateProductManager","name":"Update the action such as PROOF and PUBLISH for the specific product","summary":"Update the action for product","tags":[],"parameters":[{"name":"productId","in":"path","type":"string","required":true,"description":"Contains the unique identifier of the product, e.g. the product id of the arrangement account."},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"displayName":"string","action":"string","availableDate":"2024-01-01","processMethod":"string"}},"responses":{"200":"ProductManagerResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/product/interestConditions","fullPath":"/api/v2.1.0/product/interestConditions","operationId":"getInterestConditionReference","name":"Retrieves all the available interest conditions","summary":"Retrieves all the available interest conditions","tags":[],"parameters":[{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"InterestConditionReferenceResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}}]},{"key":"product-products-v2.2.0","title":"Product Builder","version":"v2.2.0","description":"API to create, update and manage the product definition details, interest conditions, repayment calculator, simulate a loan contract and project the schedules","endpointCount":33,"endpoints":[{"method":"GET","path":"/product/productLines/{productLineId}/productGroups/{productGroupId}/products","fullPath":"/api/v2.2.0/product/productLines/{productLineId}/productGroups/{productGroupId}/products","operationId":"getProductsPerLineAndGroup","name":"Retrieves the details of all the products based on a given Product line and Product group","summary":"Retrieves the details of all the products based on a given Product line and Product group","tags":[],"parameters":[{"name":"productLineId","in":"path","type":"string","required":true,"description":"The top level product line, which the product is ultimately attached to. May be a Temenos-defined product line such as ACCOUNTS, AGENT, BUNDLE, CONSENT, DEPOSITS, LENDING, REWARDS, etc. or one defined"},{"name":"productGroupId","in":"path","type":"string","required":true,"description":"The group, as defined by the institution, that the product belongs to."},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"ProductsPerLineAndGroupResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/product/productLines/{productLineId}/productGroups","fullPath":"/api/v2.2.0/product/productLines/{productLineId}/productGroups","operationId":"getProductGroups","name":"Retrieves the details of all the products based on a given Product line","summary":"Retrieves the details of all the products based on a given Product line","tags":[],"parameters":[{"name":"productLineId","in":"path","type":"string","required":true,"description":"The top level product line, which the product is ultimately attached to. May be a Temenos-defined product line such as ACCOUNTS, AGENT, BUNDLE, CONSENT, DEPOSITS, LENDING, REWARDS, etc. or one defined"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"ProductGroupsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/product/productLines/{productLineId}/activities","fullPath":"/api/v2.2.0/product/productLines/{productLineId}/activities","operationId":"getProductLineActivities","name":"Retrieves the list of activities applicable for a given product line","summary":"Retrieves the list of activities applicable for a given product line","tags":[],"parameters":[{"name":"productLineId","in":"path","type":"string","required":true,"description":"The top level product line, which the product is ultimately attached to. May be a Temenos-defined product line such as ACCOUNTS, AGENT, BUNDLE, CONSENT, DEPOSITS, LENDING, REWARDS, etc. or one defined"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"ProductLineActivitiesResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/product/productLines","fullPath":"/api/v2.2.0/product/productLines","operationId":"getProductLines","name":"Retrieves the list of available Product Line","summary":"Retrieves the list of available Product Line","tags":[],"parameters":[{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"ProductLinesResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/product/products","fullPath":"/api/v2.2.0/product/products","operationId":"getAllProducts","name":"Retrieves all the Product available in the Catalogue","summary":"Retrieves all the Product available in the Catalogue","tags":[],"parameters":[{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"AllProductsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/product/products/{productId}","fullPath":"/api/v2.2.0/product/products/{productId}","operationId":"getProducts","name":"Retrieves the details of a given Product","summary":"Retrieves the details of a given Product","tags":[],"parameters":[{"name":"productId","in":"path","type":"string","required":true,"description":""},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"ProductsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/product/propertyClasses","fullPath":"/api/v2.2.0/product/propertyClasses","operationId":"getPropertyClasses","name":"Retrieves the product's property class information, which is used for building products","summary":"Retrieves the product's property class information, which is used for building products","tags":[],"parameters":[{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"PropertyClassesResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/product/productGroups","fullPath":"/api/v2.2.0/product/productGroups","operationId":"getAllProductGroups","name":"Retrieves the List of Product Group available with its Product Line","summary":"Retrieves the List of Product Group available with its Product Line","tags":[],"parameters":[{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"AllProductGroupsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/product/{productId}","fullPath":"/api/v2.2.0/product/{productId}","operationId":"getProductDetails","name":"Retrieve the product details for a catalogued product","summary":"Retrieve the product details for a catalogued product","tags":[],"parameters":[{"name":"productId","in":"path","type":"string","required":true,"description":"Contains the unique identifier of the product, e.g. the product id of the arrangement account."},{"name":"currency","in":"query","type":"string","required":true,"description":"Identifies the currency. E.g. USD, GBP etc"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"ProductDetailsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/product/productBuilder/interestConditions","fullPath":"/api/v2.2.0/product/productBuilder/interestConditions","operationId":"getAllInterestConditions","name":"Retrieves the list of all the available interest conditions","summary":"Retrieves the list of all the available interest conditions","tags":[],"parameters":[{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"AllInterestConditionsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/product/productBuilder/interestConditions/{interestConditionId}","fullPath":"/api/v2.2.0/product/productBuilder/interestConditions/{interestConditionId}","operationId":"getInterestConditions","name":"Retrieves the details of the given interest condition","summary":"Retrieves the details of the given interest condition","tags":[],"parameters":[{"name":"interestConditionId","in":"path","type":"string","required":true,"description":"The identifier of the product condition used to define the interest rate"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"InterestConditionsResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"POST","path":"/product/productBuilder/interestConditions/{interestConditionId}","fullPath":"/api/v2.2.0/product/productBuilder/interestConditions/{interestConditionId}","operationId":"createInterestCondition","name":"Creates a new interest condition record","summary":"Creates a new interest condition record","tags":[],"parameters":[{"name":"interestConditionId","in":"path","type":"string","required":true,"description":"The identifier of the product condition used to define the interest rate"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"rates":[{}],"displayNames":[{}],"rateTierType":"string","linkedArrangement":"string","defaultNegotiable":"string"}},"responses":{"200":"InterestConditionResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/product/productBuilder/interestConditions/{interestConditionId}","fullPath":"/api/v2.2.0/product/productBuilder/interestConditions/{interestConditionId}","operationId":"updateInterestCondition","name":"Updates an existing interest condition record","summary":"Updates an existing interest condition record","tags":[],"parameters":[{"name":"interestConditionId","in":"path","type":"string","required":true,"description":"The identifier of the product condition used to define the interest rate"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"rates":[{}],"displayNames":[{}],"rateTierType":"string","linkedArrangement":"string","defaultNegotiable":"string"}},"responses":{"200":"InterestConditionResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/product/productBuilder/productConditions","fullPath":"/api/v2.2.0/product/productBuilder/productConditions","operationId":"getProductConditions","name":"Retrieves the list of Product Conditions available","summary":"Retrieves the list of Product Conditions available","tags":[],"parameters":[{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"ProductConditionsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/product/productBuilder/properties","fullPath":"/api/v2.2.0/product/productBuilder/properties","operationId":"getProperties","name":"Retrieves the details of all the available properties","summary":"Retrieves the details of all the available properties","tags":[],"parameters":[{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"PropertiesResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/product/productBuilder/projects","fullPath":"/api/v2.2.0/product/productBuilder/projects","operationId":"getProjects","name":"Retrieves the list of available projects created to build a product","summary":"Retrieves the list of available projects created to build a product","tags":[],"parameters":[{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"ProjectsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/product/{productId}/commitment/{amount}/period/{term}","fullPath":"/api/v2.2.0/product/{productId}/commitment/{amount}/period/{term}","operationId":"getRepaymentCalculator","name":"Retrieves the Repayment Details for the given Product, Principal amount and Term","summary":"Retrieves the Repayment Details for the given Product, Principal amount and Term","tags":[],"parameters":[{"name":"productId","in":"path","type":"string","required":true,"description":"Contains the unique identifier of the product, e.g. the product id of the arrangement account."},{"name":"amount","in":"path","type":"string","required":true,"description":"This is the payment amount"},{"name":"term","in":"path","type":"string","required":true,"description":"Indicates the period to which the BID and OFFER rates apply"},{"name":"currencyId","in":"query","type":"string","required":true,"description":"Identifier of the currency. This is the 3-letter ISO 4217 code of the currency."},{"name":"paymentFrequency","in":"query","type":"string","required":true,"description":"The frequency at which a payment is required to be generated"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"RepaymentCalculatorResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"POST","path":"/product/loans/simulations","fullPath":"/api/v2.2.0/product/loans/simulations","operationId":"createSynchronousSimulation","name":"API to simulate a Loan Arrangement for the given principal amount, term, payment frequency and interest rates","summary":"Simulate a Loan Arrangement for the given principal amount, term, payment frequency and interest rates","tags":[],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"customerIds":[{}],"properties":[{}],"overrides":[{}],"productId":"string","masterArrangementId":"string","roleName":"string","currencyId":"string","effectiveDate":"2024-01-01","activityId":"string","transactionAmount":0.0}},"responses":{"200":"createSynchronousSimulationResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"POST","path":"/product/loans/simulations/schedules","fullPath":"/api/v2.2.0/product/loans/simulations/schedules","operationId":"createSynchronousSimulationSchedules","name":"Simulate a loan arrangement for the given Principal amount, Term, Payment frequency and Interest rates. This API allows to retrieve the details of payment schedules for the simulated contract","summary":"Simulate a loan arrangement and retrieve the payment schedule details","tags":[],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"customerIds":[{}],"properties":[{}],"overrides":[{}],"productId":"string","masterArrangementId":"string","roleName":"string","currencyId":"string","effectiveDate":"2024-01-01","activityId":"string","transactionAmount":0.0}},"responses":{"200":"createSynchronousSimulationSchedulesResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"GET","path":"/product/productTypes","fullPath":"/api/v2.2.0/product/productTypes","operationId":"getAllProductTypes","name":"Retrieves the list of product types available in Transact system","summary":"Retrieves the list of product types available in Transact system","tags":[],"parameters":[{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"AllProductTypesResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/product/productTypes/{productType}","fullPath":"/api/v2.2.0/product/productTypes/{productType}","operationId":"getProductType","name":"Retrieves the product type details for a given Product Type","summary":"Retrieves the product type details for a given Product Type","tags":[],"parameters":[{"name":"productType","in":"path","type":"string","required":true,"description":"Indicates the product type for the deal"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"ProductTypeResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/product/productTypes/products/{productId}","fullPath":"/api/v2.2.0/product/productTypes/products/{productId}","operationId":"getProductStatus","name":"Retrieves the basic details such as product details,status,proof and publish errors if any","summary":"Retrieves the basic details of a given product","tags":[],"parameters":[{"name":"productId","in":"path","type":"string","required":true,"description":"Contains the unique identifier of the product, e.g. the product id of the arrangement account."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"ProductStatusResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"POST","path":"/product/productTypes/products/{productId}","fullPath":"/api/v2.2.0/product/productTypes/products/{productId}","operationId":"createProducts","name":"Create a product from a product type","summary":"Create a product using the conditions available from the product type","tags":[],"parameters":[{"name":"productId","in":"path","type":"string","required":true,"description":"Contains the unique identifier of the product, e.g. the product id of the arrangement account."},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"id":"string","status":"string","transactionStatus":"string","uniqueIdentifier":"string","audit":{"T24_time":{},"versionNumber":{},"requestParse_time":{},"responseParse_time":{}}},"body":{"productType":"string","productId":"string","productGroupId":"string","productLineId":"string","productName":"string","productDescription":"string","availableCurrency":[{}],"effectiveDate":"string","version":"string","productAttributes":[{}],"propertyList":[{}]}},"responses":{"200":"ProductsResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/product/productTypes/products/{productId}","fullPath":"/api/v2.2.0/product/productTypes/products/{productId}","operationId":"updateProducts","name":"Update a product such as property conditions and its condition values","summary":"Update a product such as property conditions and its condition values","tags":[],"parameters":[{"name":"productId","in":"path","type":"string","required":true,"description":"Contains the unique identifier of the product, e.g. the product id of the arrangement account."},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"id":"string","status":"string","transactionStatus":"string","uniqueIdentifier":"string","audit":{"T24_time":{},"versionNumber":{},"requestParse_time":{},"responseParse_time":{}}},"body":{"productType":"string","productId":"string","productGroupId":"string","productLineId":"string","productName":"string","productDescription":"string","availableCurrency":[{}],"effectiveDate":"string","version":"string","productAttributes":[{}],"propertyList":[{}]}},"responses":{"200":"ProductsResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/product/productFeatures/{productFeatureId}/attributes","fullPath":"/api/v2.2.0/product/productFeatures/{productFeatureId}/attributes","operationId":"getPropertyFields","name":"Retrieves the attribute and the field structure for the given product feature","summary":"Retrieves the attribute and the field structure","tags":[],"parameters":[{"name":"productFeatureId","in":"path","type":"string","required":true,"description":""},{"name":"productConditionId","in":"query","type":"string","required":false,"description":"The identifier of the product condition"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"PropertyFieldsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/product/productGroups/{productGroupId}/productFeatures/productConditions","fullPath":"/api/v2.2.0/product/productGroups/{productGroupId}/productFeatures/productConditions","operationId":"getProductLineFeatureConditions","name":"Retrieves the product conditions for the product features present in the product group","summary":"Retrieves the product conditions for the product features","tags":[],"parameters":[{"name":"productGroupId","in":"path","type":"string","required":true,"description":"The group, as defined by the institution, that the product belongs to."},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"ProductLineFeatureConditionsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/product/productConditions/{productConditionId}","fullPath":"/api/v2.2.0/product/productConditions/{productConditionId}","operationId":"getConditionGenerator","name":"Retrieves the base condition details of a product feature such as the attributes ,their field name and values,status and validation errors if any","summary":"Retrieves the base condition details of a product feature","tags":[],"parameters":[{"name":"productConditionId","in":"path","type":"string","required":true,"description":"The identifier of the product condition"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"ConditionGeneratorResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"POST","path":"/product/productConditions/{productConditionId}","fullPath":"/api/v2.2.0/product/productConditions/{productConditionId}","operationId":"createConditionGenerator","name":"Create the product condition for the product feature based on the attributes and their field name and values","summary":"Create the product condition for the product feature","tags":[],"parameters":[{"name":"productConditionId","in":"path","type":"string","required":true,"description":"The identifier of the product condition"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"propertyId":"string","conditionName":"string","effectiveDate":"string","currencies":[{}]}},"responses":{"200":"ConditionGeneratorResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/product/productConditions/{productConditionId}","fullPath":"/api/v2.2.0/product/productConditions/{productConditionId}","operationId":"updateConditionGenerator","name":"Update the product condition for the product feature based on the attributes and their field name and values","summary":"Update the product condition for the product feature","tags":[],"parameters":[{"name":"productConditionId","in":"path","type":"string","required":true,"description":"The identifier of the product condition"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"propertyId":"string","conditionName":"string","effectiveDate":"string","currencies":[{}]}},"responses":{"200":"ConditionGeneratorResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/product/productFeatures","fullPath":"/api/v2.2.0/product/productFeatures","operationId":"getProductLineFeatures","name":"Retrieves the list of product features and product line details","summary":"Retrieves the list of features","tags":[],"parameters":[{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"ProductLineFeaturesResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/product/{productId}/productConditions","fullPath":"/api/v2.2.0/product/{productId}/productConditions","operationId":"getProductCatalogue","name":"Retrieves the catalogued conditions of a given product","summary":"Retrieves the catalogued conditions of a given product","tags":["RETAIL"],"parameters":[{"name":"productId","in":"path","type":"string","required":true,"description":"Contains the unique identifier of the product, e.g. the product id of the arrangement account."},{"name":"currency","in":"query","type":"string","required":false,"description":"Identifies the currency. E.g. USD, GBP etc"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"ProductCatalogueResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"PUT","path":"/product/productManagers/{productId}","fullPath":"/api/v2.2.0/product/productManagers/{productId}","operationId":"updateProductManager","name":"Update the action such as PROOF and PUBLISH for the specific product","summary":"Update the action for product","tags":[],"parameters":[{"name":"productId","in":"path","type":"string","required":true,"description":"Contains the unique identifier of the product, e.g. the product id of the arrangement account."},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"displayName":"string","action":"string","availableDate":"2024-01-01","processMethod":"string"}},"responses":{"200":"ProductManagerResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/product/interestConditions","fullPath":"/api/v2.2.0/product/interestConditions","operationId":"getInterestConditionReference","name":"Retrieves all the available interest conditions","summary":"Retrieves all the available interest conditions","tags":[],"parameters":[{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"InterestConditionReferenceResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}}]},{"key":"product-products-v2.3.0","title":"Product Builder","version":"v2.3.0","description":"API to create, update and manage the product definition details, interest conditions, repayment calculator, simulate a loan contract and project the schedules","endpointCount":33,"endpoints":[{"method":"GET","path":"/product/productLines/{productLineId}/productGroups/{productGroupId}/products","fullPath":"/api/v2.3.0/product/productLines/{productLineId}/productGroups/{productGroupId}/products","operationId":"getProductsPerLineAndGroup","name":"Retrieves the details of all the products based on a given product line and product group","summary":"Retrieves the details of all the products based on a given product line and product group","tags":[],"parameters":[{"name":"productLineId","in":"path","type":"string","required":true,"description":"The top level product line, which the product is ultimately attached to. May be a Temenos-defined product line such as ACCOUNTS, AGENT, BUNDLE, CONSENT, DEPOSITS, LENDING, REWARDS, etc. or one defined"},{"name":"productGroupId","in":"path","type":"string","required":true,"description":"The group, as defined by the institution, that the product belongs to."},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"ProductsPerLineAndGroupResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/product/productLines/{productLineId}/productGroups","fullPath":"/api/v2.3.0/product/productLines/{productLineId}/productGroups","operationId":"getProductGroups","name":"Retrieves the details of all the products based on a given product line","summary":"Retrieves the details of all the products based on a given product line","tags":[],"parameters":[{"name":"productLineId","in":"path","type":"string","required":true,"description":"The top level product line, which the product is ultimately attached to. May be a Temenos-defined product line such as ACCOUNTS, AGENT, BUNDLE, CONSENT, DEPOSITS, LENDING, REWARDS, etc. or one defined"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"ProductGroupsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/product/productLines/{productLineId}/activities","fullPath":"/api/v2.3.0/product/productLines/{productLineId}/activities","operationId":"getProductLineActivities","name":"Retrieves the list of activities applicable for a given product line","summary":"Retrieves the list of activities applicable for a given product line","tags":[],"parameters":[{"name":"productLineId","in":"path","type":"string","required":true,"description":"The top level product line, which the product is ultimately attached to. May be a Temenos-defined product line such as ACCOUNTS, AGENT, BUNDLE, CONSENT, DEPOSITS, LENDING, REWARDS, etc. or one defined"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"ProductLineActivitiesResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/product/productLines","fullPath":"/api/v2.3.0/product/productLines","operationId":"getProductLines","name":"Retrieves the list of available product line","summary":"Retrieves the list of available product line","tags":[],"parameters":[{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"ProductLinesResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/product/products","fullPath":"/api/v2.3.0/product/products","operationId":"getAllProducts","name":"Retrieves all the product available in the catalogue","summary":"Retrieves all the product available in the catalogue","tags":[],"parameters":[{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"AllProductsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/product/products/{productId}","fullPath":"/api/v2.3.0/product/products/{productId}","operationId":"getProducts","name":"Retrieves the details of a given product","summary":"Retrieves the details of a given product","tags":[],"parameters":[{"name":"productId","in":"path","type":"string","required":true,"description":""},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"ProductsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/product/propertyClasses","fullPath":"/api/v2.3.0/product/propertyClasses","operationId":"getPropertyClasses","name":"Retrieves the product's property class information, which is used for building products","summary":"Retrieves the product's property class information, which is used for building products","tags":[],"parameters":[{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"PropertyClassesResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/product/productGroups","fullPath":"/api/v2.3.0/product/productGroups","operationId":"getAllProductGroups","name":"Retrieves the list of product group available with its product line","summary":"Retrieves the list of product group available with its product line","tags":[],"parameters":[{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"AllProductGroupsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/product/{productId}","fullPath":"/api/v2.3.0/product/{productId}","operationId":"getProductDetails","name":"Retrieves the product details for a catalogued product","summary":"Retrieves the product details for a catalogued product","tags":[],"parameters":[{"name":"productId","in":"path","type":"string","required":true,"description":"Contains the unique identifier of the product, e.g. the product id of the arrangement account."},{"name":"currency","in":"query","type":"string","required":false,"description":"Identifies the currency. E.g. USD, GBP etc"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"ProductDetailsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/product/productBuilder/interestConditions","fullPath":"/api/v2.3.0/product/productBuilder/interestConditions","operationId":"getAllInterestConditions","name":"Retrieves the list of all the available interest conditions","summary":"Retrieves the list of all the available interest conditions","tags":[],"parameters":[{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"AllInterestConditionsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/product/productBuilder/interestConditions/{interestConditionId}","fullPath":"/api/v2.3.0/product/productBuilder/interestConditions/{interestConditionId}","operationId":"getInterestConditions","name":"Retrieves the details of the given interest condition","summary":"Retrieves the details of the given interest condition","tags":[],"parameters":[{"name":"interestConditionId","in":"path","type":"string","required":true,"description":"The identifier of the product condition used to define the interest rate"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"InterestConditionsResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"POST","path":"/product/productBuilder/interestConditions/{interestConditionId}","fullPath":"/api/v2.3.0/product/productBuilder/interestConditions/{interestConditionId}","operationId":"createInterestCondition","name":"Creates a new interest condition record","summary":"Creates a new interest condition record","tags":[],"parameters":[{"name":"interestConditionId","in":"path","type":"string","required":true,"description":"The identifier of the product condition used to define the interest rate"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"rates":[{}],"displayNames":[{}],"rateTierType":"string","linkedArrangement":"string","defaultNegotiable":"string"}},"responses":{"200":"InterestConditionResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/product/productBuilder/interestConditions/{interestConditionId}","fullPath":"/api/v2.3.0/product/productBuilder/interestConditions/{interestConditionId}","operationId":"updateInterestCondition","name":"Updates an existing interest condition record","summary":"Updates an existing interest condition record","tags":[],"parameters":[{"name":"interestConditionId","in":"path","type":"string","required":true,"description":"The identifier of the product condition used to define the interest rate"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"rates":[{}],"displayNames":[{}],"rateTierType":"string","linkedArrangement":"string","defaultNegotiable":"string"}},"responses":{"200":"InterestConditionResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/product/productBuilder/productConditions","fullPath":"/api/v2.3.0/product/productBuilder/productConditions","operationId":"getProductConditions","name":"Retrieves the list of product conditions available","summary":"Retrieves the list of product conditions available","tags":[],"parameters":[{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"ProductConditionsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/product/productBuilder/properties","fullPath":"/api/v2.3.0/product/productBuilder/properties","operationId":"getProperties","name":"Retrieves the details of all the available properties","summary":"Retrieves the details of all the available properties","tags":[],"parameters":[{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"PropertiesResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/product/productBuilder/projects","fullPath":"/api/v2.3.0/product/productBuilder/projects","operationId":"getProjects","name":"Retrieves the list of available projects created to build a product","summary":"Retrieves the list of available projects created to build a product","tags":[],"parameters":[{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"ProjectsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/product/{productId}/commitment/{amount}/period/{term}","fullPath":"/api/v2.3.0/product/{productId}/commitment/{amount}/period/{term}","operationId":"getRepaymentCalculator","name":"Retrieves the repayment Details for the given product, principal amount and term","summary":"Retrieves the repayment Details for the given product, principal amount and term","tags":[],"parameters":[{"name":"productId","in":"path","type":"string","required":true,"description":"Contains the unique identifier of the product, e.g. the product id of the arrangement account."},{"name":"amount","in":"path","type":"string","required":true,"description":"This is the payment amount"},{"name":"term","in":"path","type":"string","required":true,"description":"Indicates the period to which the BID and OFFER rates apply"},{"name":"currencyId","in":"query","type":"string","required":false,"description":"Identifier of the currency. This is the 3-letter ISO 4217 code of the currency."},{"name":"paymentFrequency","in":"query","type":"string","required":false,"description":"The frequency at which a payment is required to be generated"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"RepaymentCalculatorResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"POST","path":"/product/loans/simulations","fullPath":"/api/v2.3.0/product/loans/simulations","operationId":"createSynchronousSimulation","name":"Simulate a loan arrangement for the given principal amount, term, payment frequency and interest rates","summary":"Simulate a loan arrangement for the given principal amount, term, payment frequency and interest rates","tags":[],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"customerIds":[{}],"properties":[{}],"overrides":[{}],"productId":"string","masterArrangementId":"string","roleName":"string","currencyId":"string","effectiveDate":"2024-01-01","activityId":"string","transactionAmount":0.0}},"responses":{"200":"createSynchronousSimulationResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"POST","path":"/product/loans/simulations/schedules","fullPath":"/api/v2.3.0/product/loans/simulations/schedules","operationId":"createSynchronousSimulationSchedules","name":"Simulate a loan arrangement for the given principal amount, term, payment frequency and interest rates. It also retrieves the details of payment schedules for the simulated contract","summary":"Simulate a loan arrangement and retrieve the payment schedule details","tags":[],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"customerIds":[{}],"properties":[{}],"overrides":[{}],"productId":"string","masterArrangementId":"string","roleName":"string","currencyId":"string","effectiveDate":"2024-01-01","activityId":"string","transactionAmount":0.0}},"responses":{"200":"createSynchronousSimulationSchedulesResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"GET","path":"/product/productTypes","fullPath":"/api/v2.3.0/product/productTypes","operationId":"getAllProductTypes","name":"Retrieves the list of product types available in the transact system","summary":"Retrieves the list of product types available in the transact system","tags":[],"parameters":[{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"AllProductTypesResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/product/productTypes/{productType}","fullPath":"/api/v2.3.0/product/productTypes/{productType}","operationId":"getProductType","name":"Retrieves the product type details for a given product type","summary":"Retrieves the product type details for a given product type","tags":[],"parameters":[{"name":"productType","in":"path","type":"string","required":true,"description":"Indicates the product type for the deal"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"ProductTypeResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/product/productTypes/products/{productId}","fullPath":"/api/v2.3.0/product/productTypes/products/{productId}","operationId":"getProductStatus","name":"Retrieves the basic details such as product details,status,proof and publish errors if any","summary":"Retrieves the basic details of a given product","tags":[],"parameters":[{"name":"productId","in":"path","type":"string","required":true,"description":"Contains the unique identifier of the product, e.g. the product id of the arrangement account."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"ProductStatusResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"POST","path":"/product/productTypes/products/{productId}","fullPath":"/api/v2.3.0/product/productTypes/products/{productId}","operationId":"createProducts","name":"Create a product from a product type","summary":"Create a product using the conditions available from the product type","tags":[],"parameters":[{"name":"productId","in":"path","type":"string","required":true,"description":"Contains the unique identifier of the product, e.g. the product id of the arrangement account."},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"id":"string","status":"string","transactionStatus":"string","uniqueIdentifier":"string","audit":{"T24_time":{},"versionNumber":{},"requestParse_time":{},"responseParse_time":{}}},"body":{"productType":"string","productId":"string","productGroupId":"string","productLineId":"string","productName":"string","productDescription":"string","availableCurrency":[{}],"effectiveDate":"string","version":"string","productAttributes":[{}],"propertyList":[{}]}},"responses":{"200":"ProductsResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/product/productTypes/products/{productId}","fullPath":"/api/v2.3.0/product/productTypes/products/{productId}","operationId":"updateProducts","name":"Update a product such as property conditions and its condition values","summary":"Update a product such as property conditions and its condition values","tags":[],"parameters":[{"name":"productId","in":"path","type":"string","required":true,"description":"Contains the unique identifier of the product, e.g. the product id of the arrangement account."},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"id":"string","status":"string","transactionStatus":"string","uniqueIdentifier":"string","audit":{"T24_time":{},"versionNumber":{},"requestParse_time":{},"responseParse_time":{}}},"body":{"productType":"string","productId":"string","productGroupId":"string","productLineId":"string","productName":"string","productDescription":"string","availableCurrency":[{}],"effectiveDate":"string","version":"string","productAttributes":[{}],"propertyList":[{}]}},"responses":{"200":"ProductsResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/product/productFeatures/{productFeatureId}/attributes","fullPath":"/api/v2.3.0/product/productFeatures/{productFeatureId}/attributes","operationId":"getPropertyFields","name":"Retrieves the attribute and the field structure for the given product feature","summary":"Retrieves the attribute and the field structure","tags":[],"parameters":[{"name":"productFeatureId","in":"path","type":"string","required":true,"description":""},{"name":"productConditionId","in":"query","type":"string","required":false,"description":"The identifier of the product condition"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"PropertyFieldsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/product/productGroups/{productGroupId}/productFeatures/productConditions","fullPath":"/api/v2.3.0/product/productGroups/{productGroupId}/productFeatures/productConditions","operationId":"getProductLineFeatureConditions","name":"Retrieves the product conditions for the product features present in the product group","summary":"Retrieves the product conditions for the product features","tags":[],"parameters":[{"name":"productGroupId","in":"path","type":"string","required":true,"description":"The group, as defined by the institution, that the product belongs to."},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"ProductLineFeatureConditionsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/product/productConditions/{productConditionId}","fullPath":"/api/v2.3.0/product/productConditions/{productConditionId}","operationId":"getConditionGenerator","name":"Retrieves the base condition details of a product feature such as the attributes ,their field name and values,status and validation errors if any","summary":"Retrieves the base condition details of a product feature","tags":[],"parameters":[{"name":"productConditionId","in":"path","type":"string","required":true,"description":"The identifier of the product condition"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"ConditionGeneratorResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"POST","path":"/product/productConditions/{productConditionId}","fullPath":"/api/v2.3.0/product/productConditions/{productConditionId}","operationId":"createConditionGenerator","name":"Create the product condition for the product feature based on the attributes and their field name and values","summary":"Create the product condition for the product feature","tags":[],"parameters":[{"name":"productConditionId","in":"path","type":"string","required":true,"description":"The identifier of the product condition"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"propertyId":"string","conditionName":"string","effectiveDate":"string","currencies":[{}]}},"responses":{"200":"ConditionGeneratorResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/product/productConditions/{productConditionId}","fullPath":"/api/v2.3.0/product/productConditions/{productConditionId}","operationId":"updateConditionGenerator","name":"Update the product condition for the product feature based on the attributes and their field name and values","summary":"Update the product condition for the product feature","tags":[],"parameters":[{"name":"productConditionId","in":"path","type":"string","required":true,"description":"The identifier of the product condition"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"propertyId":"string","conditionName":"string","effectiveDate":"string","currencies":[{}]}},"responses":{"200":"ConditionGeneratorResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/product/productFeatures","fullPath":"/api/v2.3.0/product/productFeatures","operationId":"getProductLineFeatures","name":"Retrieves the list of product features and product line details","summary":"Retrieves the list of features","tags":[],"parameters":[{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"ProductLineFeaturesResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/product/{productId}/productConditions","fullPath":"/api/v2.3.0/product/{productId}/productConditions","operationId":"getProductCatalogue","name":"Retrieves the catalogued conditions of a given product","summary":"Retrieves the catalogued conditions of a given product","tags":["RETAIL"],"parameters":[{"name":"productId","in":"path","type":"string","required":true,"description":"Contains the unique identifier of the product, e.g. the product id of the arrangement account."},{"name":"currency","in":"query","type":"string","required":false,"description":"Identifies the currency. E.g. USD, GBP etc"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"ProductCatalogueResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"PUT","path":"/product/productManagers/{productId}","fullPath":"/api/v2.3.0/product/productManagers/{productId}","operationId":"updateProductManager","name":"Update the action such as proof or publish for the specific product","summary":"Update the action for product","tags":[],"parameters":[{"name":"productId","in":"path","type":"string","required":true,"description":"Contains the unique identifier of the product, e.g. the product id of the arrangement account."},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"displayName":"string","action":"string","availableDate":"2024-01-01","processMethod":"string"}},"responses":{"200":"ProductManagerResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/product/interestConditions","fullPath":"/api/v2.3.0/product/interestConditions","operationId":"getInterestConditionReference","name":"Retrieves all the available interest conditions","summary":"Retrieves all the available interest conditions","tags":[],"parameters":[{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"InterestConditionReferenceResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}}]},{"key":"product-products-v2.4.0","title":"Product Builder","version":"v2.4.0","description":"API to create, update and manage the product definition details, interest conditions, repayment calculator, simulate a loan contract and project the schedules","endpointCount":33,"endpoints":[{"method":"GET","path":"/product/productLines/{productLineId}/productGroups/{productGroupId}/products","fullPath":"/api/v2.4.0/product/productLines/{productLineId}/productGroups/{productGroupId}/products","operationId":"getProductsPerLineAndGroup","name":"Retrieves the details of all the products based on a given product line and product group","summary":"Retrieves the details of all the products based on a given product line and product group","tags":[],"parameters":[{"name":"productLineId","in":"path","type":"string","required":true,"description":"The top level product line, which the product is ultimately attached to. May be a Temenos-defined product line such as ACCOUNTS, AGENT, BUNDLE, CONSENT, DEPOSITS, LENDING, REWARDS, etc. or one defined"},{"name":"productGroupId","in":"path","type":"string","required":true,"description":"The group, as defined by the institution, that the product belongs to."},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"ProductsPerLineAndGroupResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/product/productLines/{productLineId}/productGroups","fullPath":"/api/v2.4.0/product/productLines/{productLineId}/productGroups","operationId":"getProductGroups","name":"Retrieves the details of all the products based on a given product line","summary":"Retrieves the details of all the products based on a given product line","tags":[],"parameters":[{"name":"productLineId","in":"path","type":"string","required":true,"description":"The top level product line, which the product is ultimately attached to. May be a Temenos-defined product line such as ACCOUNTS, AGENT, BUNDLE, CONSENT, DEPOSITS, LENDING, REWARDS, etc. or one defined"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"ProductGroupsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/product/productLines/{productLineId}/activities","fullPath":"/api/v2.4.0/product/productLines/{productLineId}/activities","operationId":"getProductLineActivities","name":"Retrieves the list of activities applicable for a given product line","summary":"Retrieves the list of activities applicable for a given product line","tags":[],"parameters":[{"name":"productLineId","in":"path","type":"string","required":true,"description":"The top level product line, which the product is ultimately attached to. May be a Temenos-defined product line such as ACCOUNTS, AGENT, BUNDLE, CONSENT, DEPOSITS, LENDING, REWARDS, etc. or one defined"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"ProductLineActivitiesResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/product/productLines","fullPath":"/api/v2.4.0/product/productLines","operationId":"getProductLines","name":"Retrieves the list of available product line","summary":"Retrieves the list of available product line","tags":[],"parameters":[{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"ProductLinesResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/product/products","fullPath":"/api/v2.4.0/product/products","operationId":"getAllProducts","name":"Retrieves all the product available in the catalogue","summary":"Retrieves all the product available in the catalogue","tags":[],"parameters":[{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"AllProductsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/product/products/{productId}","fullPath":"/api/v2.4.0/product/products/{productId}","operationId":"getProducts","name":"Retrieves the details of a given product","summary":"Retrieves the details of a given product","tags":[],"parameters":[{"name":"productId","in":"path","type":"string","required":true,"description":""},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"ProductsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/product/propertyClasses","fullPath":"/api/v2.4.0/product/propertyClasses","operationId":"getPropertyClasses","name":"Retrieves the product's property class information, which is used for building products","summary":"Retrieves the product's property class information, which is used for building products","tags":[],"parameters":[{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"PropertyClassesResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/product/productGroups","fullPath":"/api/v2.4.0/product/productGroups","operationId":"getAllProductGroups","name":"Retrieves the list of product group available with its product line","summary":"Retrieves the list of product group available with its product line","tags":[],"parameters":[{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"AllProductGroupsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/product/{productId}","fullPath":"/api/v2.4.0/product/{productId}","operationId":"getProductDetails","name":"Retrieves the product details for a catalogued product","summary":"Retrieves the product details for a catalogued product","tags":[],"parameters":[{"name":"productId","in":"path","type":"string","required":true,"description":"Contains the unique identifier of the product, e.g. the product id of the arrangement account."},{"name":"currency","in":"query","type":"string","required":false,"description":"Identifies the currency. E.g. USD, GBP etc"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"ProductDetailsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/product/productBuilder/interestConditions","fullPath":"/api/v2.4.0/product/productBuilder/interestConditions","operationId":"getAllInterestConditions","name":"Retrieves the list of all the available interest conditions","summary":"Retrieves the list of all the available interest conditions","tags":[],"parameters":[{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"AllInterestConditionsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/product/productBuilder/interestConditions/{interestConditionId}","fullPath":"/api/v2.4.0/product/productBuilder/interestConditions/{interestConditionId}","operationId":"getInterestConditions","name":"Retrieves the details of the given interest condition","summary":"Retrieves the details of the given interest condition","tags":[],"parameters":[{"name":"interestConditionId","in":"path","type":"string","required":true,"description":"The identifier of the product condition used to define the interest rate"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"InterestConditionsResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"POST","path":"/product/productBuilder/interestConditions/{interestConditionId}","fullPath":"/api/v2.4.0/product/productBuilder/interestConditions/{interestConditionId}","operationId":"createInterestCondition","name":"Creates a new interest condition","summary":"Creates a new interest condition","tags":[],"parameters":[{"name":"interestConditionId","in":"path","type":"string","required":true,"description":"The identifier of the product condition used to define the interest rate"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"rates":[{}],"displayNames":[{}],"rateTierType":"string","linkedArrangement":"string","defaultNegotiable":"string"}},"responses":{"200":"InterestConditionResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/product/productBuilder/interestConditions/{interestConditionId}","fullPath":"/api/v2.4.0/product/productBuilder/interestConditions/{interestConditionId}","operationId":"updateInterestCondition","name":"Updates an existing interest condition","summary":"Updates an existing interest condition","tags":[],"parameters":[{"name":"interestConditionId","in":"path","type":"string","required":true,"description":"The identifier of the product condition used to define the interest rate"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"rates":[{}],"displayNames":[{}],"rateTierType":"string","linkedArrangement":"string","defaultNegotiable":"string"}},"responses":{"200":"InterestConditionResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/product/productBuilder/productConditions","fullPath":"/api/v2.4.0/product/productBuilder/productConditions","operationId":"getProductConditions","name":"Retrieves the list of product conditions available","summary":"Retrieves the list of product conditions available","tags":[],"parameters":[{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"ProductConditionsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/product/productBuilder/properties","fullPath":"/api/v2.4.0/product/productBuilder/properties","operationId":"getProperties","name":"Retrieves the details of all the available properties","summary":"Retrieves the details of all the available properties","tags":[],"parameters":[{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"PropertiesResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/product/productBuilder/projects","fullPath":"/api/v2.4.0/product/productBuilder/projects","operationId":"getProjects","name":"Retrieves the list of available projects created to build a product","summary":"Retrieves the list of available projects created to build a product","tags":[],"parameters":[{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"ProjectsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/product/{productId}/commitment/{amount}/period/{term}","fullPath":"/api/v2.4.0/product/{productId}/commitment/{amount}/period/{term}","operationId":"getRepaymentCalculator","name":"Retrieves the repayment details for the given product, principal amount and term","summary":"Retrieves the repayment details for the given product, principal amount and term","tags":[],"parameters":[{"name":"productId","in":"path","type":"string","required":true,"description":"Contains the unique identifier of the product, e.g. the product id of the arrangement account."},{"name":"amount","in":"path","type":"string","required":true,"description":"This is the payment amount"},{"name":"term","in":"path","type":"string","required":true,"description":"Indicates the period to which the BID and OFFER rates apply"},{"name":"currencyId","in":"query","type":"string","required":false,"description":"Identifier of the currency. This is the 3-letter ISO 4217 code of the currency."},{"name":"paymentFrequency","in":"query","type":"string","required":false,"description":"The frequency at which a payment is required to be generated"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"RepaymentCalculatorResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"POST","path":"/product/loans/simulations","fullPath":"/api/v2.4.0/product/loans/simulations","operationId":"createSynchronousSimulation","name":"Simulate a loan arrangement for the given principal amount, term, payment frequency and interest rates","summary":"Simulate a loan arrangement for the given principal amount, term, payment frequency and interest rates","tags":[],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"customerIds":[{}],"properties":[{}],"overrides":[{}],"productId":"string","masterArrangementId":"string","roleName":"string","currencyId":"string","effectiveDate":"2024-01-01","activityId":"string","transactionAmount":0.0}},"responses":{"200":"createSynchronousSimulationResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"POST","path":"/product/loans/simulations/schedules","fullPath":"/api/v2.4.0/product/loans/simulations/schedules","operationId":"createSynchronousSimulationSchedules","name":"Simulate a loan arrangement for the given principal amount, term, payment frequency and interest rates. It also retrieves the details of payment schedules for the simulated contract","summary":"Simulate a loan arrangement and retrieve the payment schedule details","tags":[],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"customerIds":[{}],"properties":[{}],"overrides":[{}],"productId":"string","masterArrangementId":"string","roleName":"string","currencyId":"string","effectiveDate":"2024-01-01","activityId":"string","transactionAmount":0.0}},"responses":{"200":"createSynchronousSimulationSchedulesResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"GET","path":"/product/productTypes","fullPath":"/api/v2.4.0/product/productTypes","operationId":"getAllProductTypes","name":"Retrieves the list of product types available in the Transact system","summary":"Retrieves the list of product types available in the Transact system","tags":[],"parameters":[{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"AllProductTypesResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/product/productTypes/{productType}","fullPath":"/api/v2.4.0/product/productTypes/{productType}","operationId":"getProductType","name":"Retrieves the product type details for a given product type","summary":"Retrieves the product type details for a given product type","tags":[],"parameters":[{"name":"productType","in":"path","type":"string","required":true,"description":"Indicates the product type for the deal"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"ProductTypeResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/product/productTypes/products/{productId}","fullPath":"/api/v2.4.0/product/productTypes/products/{productId}","operationId":"getProductStatus","name":"Retrieves the basic details such as product details,status,proof and publish errors if any","summary":"Retrieves the basic details of a given product","tags":[],"parameters":[{"name":"productId","in":"path","type":"string","required":true,"description":"Contains the unique identifier of the product, e.g. the product id of the arrangement account."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"ProductStatusResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"POST","path":"/product/productTypes/products/{productId}","fullPath":"/api/v2.4.0/product/productTypes/products/{productId}","operationId":"createProducts","name":"Create a product from a product type","summary":"Create a product using the conditions available from the product type","tags":[],"parameters":[{"name":"productId","in":"path","type":"string","required":true,"description":"Contains the unique identifier of the product, e.g. the product id of the arrangement account."},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"id":"string","status":"string","transactionStatus":"string","uniqueIdentifier":"string","audit":{"T24_time":{},"versionNumber":{},"requestParse_time":{},"responseParse_time":{}}},"body":{"productType":"string","productId":"string","productGroupId":"string","productLineId":"string","productName":"string","productDescription":"string","availableCurrency":[{}],"effectiveDate":"string","version":"string","productAttributes":[{}],"propertyList":[{}]}},"responses":{"200":"ProductsResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/product/productTypes/products/{productId}","fullPath":"/api/v2.4.0/product/productTypes/products/{productId}","operationId":"updateProducts","name":"Update a product such as property conditions and its condition values","summary":"Update a product such as property conditions and its condition values","tags":[],"parameters":[{"name":"productId","in":"path","type":"string","required":true,"description":"Contains the unique identifier of the product, e.g. the product id of the arrangement account."},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"id":"string","status":"string","transactionStatus":"string","uniqueIdentifier":"string","audit":{"T24_time":{},"versionNumber":{},"requestParse_time":{},"responseParse_time":{}}},"body":{"productType":"string","productId":"string","productGroupId":"string","productLineId":"string","productName":"string","productDescription":"string","availableCurrency":[{}],"effectiveDate":"string","version":"string","productAttributes":[{}],"propertyList":[{}]}},"responses":{"200":"ProductsResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/product/productFeatures/{productFeatureId}/attributes","fullPath":"/api/v2.4.0/product/productFeatures/{productFeatureId}/attributes","operationId":"getPropertyFields","name":"Retrieves the attribute and the field structure for the given product feature","summary":"Retrieves the attribute and the field structure","tags":[],"parameters":[{"name":"productFeatureId","in":"path","type":"string","required":true,"description":""},{"name":"productConditionId","in":"query","type":"string","required":false,"description":"The identifier of the product condition"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"PropertyFieldsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/product/productGroups/{productGroupId}/productFeatures/productConditions","fullPath":"/api/v2.4.0/product/productGroups/{productGroupId}/productFeatures/productConditions","operationId":"getProductLineFeatureConditions","name":"Retrieves the product conditions for the product features present in the product group","summary":"Retrieves the product conditions for the product features","tags":[],"parameters":[{"name":"productGroupId","in":"path","type":"string","required":true,"description":"The group, as defined by the institution, that the product belongs to."},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"ProductLineFeatureConditionsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/product/productConditions/{productConditionId}","fullPath":"/api/v2.4.0/product/productConditions/{productConditionId}","operationId":"getConditionGenerator","name":"Retrieves the base condition details of a product feature such as the attributes ,their field name and values,status and validation errors if any","summary":"Retrieves the base condition details of a product feature","tags":[],"parameters":[{"name":"productConditionId","in":"path","type":"string","required":true,"description":"The identifier of the product condition"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"ConditionGeneratorResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"POST","path":"/product/productConditions/{productConditionId}","fullPath":"/api/v2.4.0/product/productConditions/{productConditionId}","operationId":"createConditionGenerator","name":"Create the product condition for the product feature based on the attributes and their field name and values","summary":"Create the product condition for the product feature","tags":[],"parameters":[{"name":"productConditionId","in":"path","type":"string","required":true,"description":"The identifier of the product condition"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"propertyId":"string","conditionName":"string","effectiveDate":"string","currencies":[{}]}},"responses":{"200":"ConditionGeneratorResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/product/productConditions/{productConditionId}","fullPath":"/api/v2.4.0/product/productConditions/{productConditionId}","operationId":"updateConditionGenerator","name":"Update the product condition for the product feature based on the attributes and their field name and values","summary":"Update the product condition for the product feature","tags":[],"parameters":[{"name":"productConditionId","in":"path","type":"string","required":true,"description":"The identifier of the product condition"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"propertyId":"string","conditionName":"string","effectiveDate":"string","currencies":[{}]}},"responses":{"200":"ConditionGeneratorResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/product/productFeatures","fullPath":"/api/v2.4.0/product/productFeatures","operationId":"getProductLineFeatures","name":"Retrieves the list of product features and product line details","summary":"Retrieves the list of features","tags":[],"parameters":[{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"ProductLineFeaturesResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/product/{productId}/productConditions","fullPath":"/api/v2.4.0/product/{productId}/productConditions","operationId":"getProductCatalogue","name":"Retrieves the catalogued conditions of a given product","summary":"Retrieves the catalogued conditions of a given product","tags":["RETAIL"],"parameters":[{"name":"productId","in":"path","type":"string","required":true,"description":"Contains the unique identifier of the product, e.g. the product id of the arrangement account."},{"name":"currency","in":"query","type":"string","required":false,"description":"Identifies the currency. E.g. USD, GBP etc"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"ProductCatalogueResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"PUT","path":"/product/productManagers/{productId}","fullPath":"/api/v2.4.0/product/productManagers/{productId}","operationId":"updateProductManager","name":"Update the action such as proof or publish for the specific product","summary":"Update the action for product","tags":[],"parameters":[{"name":"productId","in":"path","type":"string","required":true,"description":"Contains the unique identifier of the product, e.g. the product id of the arrangement account."},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"displayName":"string","action":"string","availableDate":"2024-01-01","processMethod":"string"}},"responses":{"200":"ProductManagerResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/product/interestConditions","fullPath":"/api/v2.4.0/product/interestConditions","operationId":"getInterestConditionReference","name":"Retrieves all the available interest conditions","summary":"Retrieves all the available interest conditions","tags":[],"parameters":[{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"InterestConditionReferenceResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}}]},{"key":"product-products-v3.0.0","title":"Product Builder","version":"v3.0.0","description":"API to create, update and manage the product definition details, interest conditions, repayment calculator, simulate a loan contract and project the schedules","endpointCount":34,"endpoints":[{"method":"GET","path":"/product/productLines/{productLineId}/productGroups/{productGroupId}/products","fullPath":"/api/v3.0.0/product/productLines/{productLineId}/productGroups/{productGroupId}/products","operationId":"getProductsPerLineAndGroup","name":"Retrieves the details of all the products based on a given product line and product group","summary":"Retrieves the details of all the products based on a given product line and product group","tags":[],"parameters":[{"name":"productLineId","in":"path","type":"string","required":true,"description":"The top level product line, which the product is ultimately attached to. May be a Temenos-defined product line such as ACCOUNTS, AGENT, BUNDLE, CONSENT, DEPOSITS, LENDING, REWARDS, etc. or one defined"},{"name":"productGroupId","in":"path","type":"string","required":true,"description":"The group, as defined by the institution, that the product belongs to."},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"ProductsPerLineAndGroupResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/product/productLines/{productLineId}/productGroups","fullPath":"/api/v3.0.0/product/productLines/{productLineId}/productGroups","operationId":"getProductGroups","name":"Retrieves the details of all the products based on a given product line","summary":"Retrieves the details of all the products based on a given product line","tags":[],"parameters":[{"name":"productLineId","in":"path","type":"string","required":true,"description":"The top level product line, which the product is ultimately attached to. May be a Temenos-defined product line such as ACCOUNTS, AGENT, BUNDLE, CONSENT, DEPOSITS, LENDING, REWARDS, etc. or one defined"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"ProductGroupsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/product/productLines/{productLineId}/activities","fullPath":"/api/v3.0.0/product/productLines/{productLineId}/activities","operationId":"getProductLineActivities","name":"Retrieves the list of activities applicable for a given product line","summary":"Retrieves the list of activities applicable for a given product line","tags":[],"parameters":[{"name":"productLineId","in":"path","type":"string","required":true,"description":"The top level product line, which the product is ultimately attached to. May be a Temenos-defined product line such as ACCOUNTS, AGENT, BUNDLE, CONSENT, DEPOSITS, LENDING, REWARDS, etc. or one defined"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"ProductLineActivitiesResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/product/productLines","fullPath":"/api/v3.0.0/product/productLines","operationId":"getProductLines","name":"Retrieves the list of available product line","summary":"Retrieves the list of available product line","tags":[],"parameters":[{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"ProductLinesResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/product/products","fullPath":"/api/v3.0.0/product/products","operationId":"getAllProducts","name":"Retrieves all the product available in the catalogue","summary":"Retrieves all the product available in the catalogue","tags":[],"parameters":[{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"AllProductsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/product/products/{productId}","fullPath":"/api/v3.0.0/product/products/{productId}","operationId":"getProducts","name":"Retrieves the details of a given product","summary":"Retrieves the details of a given product","tags":[],"parameters":[{"name":"productId","in":"path","type":"string","required":true,"description":""},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"ProductsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/product/propertyClasses","fullPath":"/api/v3.0.0/product/propertyClasses","operationId":"getPropertyClasses","name":"Retrieves the product's property class information, which is used for building products","summary":"Retrieves the product's property class information, which is used for building products","tags":[],"parameters":[{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"PropertyClassesResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/product/productGroups","fullPath":"/api/v3.0.0/product/productGroups","operationId":"getAllProductGroups","name":"Retrieves the list of product groups available with its product line","summary":"Retrieves the list of product groups available with its product line","tags":[],"parameters":[{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"AllProductGroupsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/product/{productId}","fullPath":"/api/v3.0.0/product/{productId}","operationId":"getProductDetails","name":"Retrieves the product details for a catalogued product","summary":"Retrieves the product details for a catalogued product","tags":[],"parameters":[{"name":"productId","in":"path","type":"string","required":true,"description":"Contains the unique identifier of the product, e.g. the product id of the arrangement account."},{"name":"currency","in":"query","type":"string","required":false,"description":"Identifies the currency. E.g. USD, GBP etc"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"ProductDetailsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/product/productBuilder/interestConditions","fullPath":"/api/v3.0.0/product/productBuilder/interestConditions","operationId":"getAllInterestConditions","name":"Retrieves the list of all the available interest conditions","summary":"Retrieves the list of all the available interest conditions","tags":[],"parameters":[{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"AllInterestConditionsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/product/productBuilder/interestConditions/{interestConditionId}","fullPath":"/api/v3.0.0/product/productBuilder/interestConditions/{interestConditionId}","operationId":"getInterestConditions","name":"Retrieves the details of the given interest condition","summary":"Retrieves the details of the given interest condition","tags":[],"parameters":[{"name":"interestConditionId","in":"path","type":"string","required":true,"description":"The identifier of the product condition used to define the interest rate"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"InterestConditionsResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"POST","path":"/product/productBuilder/interestConditions/{interestConditionId}","fullPath":"/api/v3.0.0/product/productBuilder/interestConditions/{interestConditionId}","operationId":"createInterestCondition","name":"Creates a new interest condition","summary":"Creates a new interest condition","tags":[],"parameters":[{"name":"interestConditionId","in":"path","type":"string","required":true,"description":"The identifier of the product condition used to define the interest rate"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"rates":[{}],"displayNames":[{}],"rateTierType":"string","linkedArrangement":"string","defaultNegotiable":"string"}},"responses":{"200":"InterestConditionResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/product/productBuilder/interestConditions/{interestConditionId}","fullPath":"/api/v3.0.0/product/productBuilder/interestConditions/{interestConditionId}","operationId":"updateInterestCondition","name":"Updates an existing interest condition","summary":"Updates an existing interest condition","tags":[],"parameters":[{"name":"interestConditionId","in":"path","type":"string","required":true,"description":"The identifier of the product condition used to define the interest rate"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"rates":[{}],"displayNames":[{}],"rateTierType":"string","linkedArrangement":"string","defaultNegotiable":"string"}},"responses":{"200":"InterestConditionResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/product/productBuilder/productConditions","fullPath":"/api/v3.0.0/product/productBuilder/productConditions","operationId":"getProductConditions","name":"Retrieves the list of product conditions available","summary":"Retrieves the list of product conditions available","tags":[],"parameters":[{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"ProductConditionsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/product/productBuilder/properties","fullPath":"/api/v3.0.0/product/productBuilder/properties","operationId":"getProperties","name":"Retrieves the details of all the available properties","summary":"Retrieves the details of all the available properties","tags":[],"parameters":[{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"PropertiesResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/product/productBuilder/projects","fullPath":"/api/v3.0.0/product/productBuilder/projects","operationId":"getProjects","name":"Retrieves the list of available projects created to build a product","summary":"Retrieves the list of available projects created to build a product","tags":[],"parameters":[{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"ProjectsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/product/{productId}/commitment/{amount}/period/{term}","fullPath":"/api/v3.0.0/product/{productId}/commitment/{amount}/period/{term}","operationId":"getRepaymentCalculator","name":"Retrieves the repayment details for the given product, principal amount and term","summary":"Retrieves the repayment details for the given product, principal amount and term","tags":[],"parameters":[{"name":"productId","in":"path","type":"string","required":true,"description":"Contains the unique identifier of the product, e.g. the product id of the arrangement account."},{"name":"amount","in":"path","type":"string","required":true,"description":"This is the payment amount"},{"name":"term","in":"path","type":"string","required":true,"description":"Indicates the period to which the BID and OFFER rates apply"},{"name":"currencyId","in":"query","type":"string","required":false,"description":"Identifier of the currency. This is the 3-letter ISO 4217 code of the currency."},{"name":"paymentFrequency","in":"query","type":"string","required":false,"description":"The frequency at which a payment is required to be generated"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"RepaymentCalculatorResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"POST","path":"/product/loans/simulations","fullPath":"/api/v3.0.0/product/loans/simulations","operationId":"createSynchronousSimulation","name":"Simulate a loan arrangement for the given principal amount, term, payment frequency and interest rates","summary":"Simulate a loan arrangement for the given principal amount, term, payment frequency and interest rates","tags":[],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"customerIds":[{}],"properties":[{}],"overrides":[{}],"productId":"string","masterArrangementId":"string","roleName":"string","currencyId":"string","effectiveDate":"2024-01-01","activityId":"string","transactionAmount":0.0}},"responses":{"200":"createSynchronousSimulationResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"POST","path":"/product/loans/simulations/schedules","fullPath":"/api/v3.0.0/product/loans/simulations/schedules","operationId":"createSynchronousSimulationSchedules","name":"Simulate a loan arrangement for the given principal amount, term, payment frequency and interest rates. It also retrieves the details of payment schedules for the simulated contract","summary":"Simulate a loan arrangement and retrieve the payment schedule details","tags":[],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"customerIds":[{}],"properties":[{}],"overrides":[{}],"productId":"string","masterArrangementId":"string","roleName":"string","currencyId":"string","effectiveDate":"2024-01-01","activityId":"string","transactionAmount":0.0}},"responses":{"200":"createSynchronousSimulationSchedulesResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"GET","path":"/product/productTypes","fullPath":"/api/v3.0.0/product/productTypes","operationId":"getAllProductTypes","name":"Retrieves the list of product types available in the Transact system","summary":"Retrieves the list of product types available in the Transact system","tags":[],"parameters":[{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"AllProductTypesResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/product/productTypes/{productType}","fullPath":"/api/v3.0.0/product/productTypes/{productType}","operationId":"getProductType","name":"Retrieves the product type details for a given product type","summary":"Retrieves the product type details for a given product type","tags":[],"parameters":[{"name":"productType","in":"path","type":"string","required":true,"description":"Indicates the product type for the deal"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"ProductTypeResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/product/productTypes/products/{productId}","fullPath":"/api/v3.0.0/product/productTypes/products/{productId}","operationId":"getProductStatus","name":"Retrieves the basic details such as product details,status,proof and publish errors if any","summary":"Retrieves the basic details of a given product","tags":[],"parameters":[{"name":"productId","in":"path","type":"string","required":true,"description":"Contains the unique identifier of the product, e.g. the product id of the arrangement account."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"ProductStatusResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"POST","path":"/product/productTypes/products/{productId}","fullPath":"/api/v3.0.0/product/productTypes/products/{productId}","operationId":"createProducts","name":"Create a product using the conditions available from the product type","summary":"Create a product from a product type","tags":[],"parameters":[{"name":"productId","in":"path","type":"string","required":true,"description":"Contains the unique identifier of the product, e.g. the product id of the arrangement account."},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"id":"string","status":"string","transactionStatus":"string","uniqueIdentifier":"string","audit":{"T24_time":{},"versionNumber":{},"requestParse_time":{},"responseParse_time":{}}},"body":{"productType":"string","productId":"string","productGroupId":"string","productLineId":"string","productName":"string","productDescription":"string","availableCurrency":[{}],"effectiveDate":"string","version":"string","productAttributes":[{}],"propertyList":[{}]}},"responses":{"200":"ProductsResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/product/productTypes/products/{productId}","fullPath":"/api/v3.0.0/product/productTypes/products/{productId}","operationId":"updateProducts","name":"Update a product such as property conditions and its condition values","summary":"Update a product such as property conditions and its condition values","tags":[],"parameters":[{"name":"productId","in":"path","type":"string","required":true,"description":"Contains the unique identifier of the product, e.g. the product id of the arrangement account."},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"id":"string","status":"string","transactionStatus":"string","uniqueIdentifier":"string","audit":{"T24_time":{},"versionNumber":{},"requestParse_time":{},"responseParse_time":{}}},"body":{"productType":"string","productId":"string","productGroupId":"string","productLineId":"string","productName":"string","productDescription":"string","availableCurrency":[{}],"effectiveDate":"string","version":"string","productAttributes":[{}],"propertyList":[{}]}},"responses":{"200":"ProductsResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/product/productFeatures/{productFeatureId}/attributes","fullPath":"/api/v3.0.0/product/productFeatures/{productFeatureId}/attributes","operationId":"getPropertyFields","name":"Retrieves the attribute and the field structure for the given product feature","summary":"Retrieves the attribute and the field structure","tags":[],"parameters":[{"name":"productFeatureId","in":"path","type":"string","required":true,"description":""},{"name":"productConditionId","in":"query","type":"string","required":false,"description":"The identifier of the product condition"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"PropertyFieldsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/product/productGroups/{productGroupId}/productFeatures/productConditions","fullPath":"/api/v3.0.0/product/productGroups/{productGroupId}/productFeatures/productConditions","operationId":"getProductLineFeatureConditions","name":"Retrieves the product conditions for the product features present in the product group","summary":"Retrieves the product conditions for the product features","tags":[],"parameters":[{"name":"productGroupId","in":"path","type":"string","required":true,"description":"The group, as defined by the institution, that the product belongs to."},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"ProductLineFeatureConditionsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/product/productConditions/{productConditionId}","fullPath":"/api/v3.0.0/product/productConditions/{productConditionId}","operationId":"getConditionGenerator","name":"Retrieves the base condition details of a product feature such as the attributes ,their field name and values,status and validation errors if any","summary":"Retrieves the base condition details of a product feature","tags":[],"parameters":[{"name":"productConditionId","in":"path","type":"string","required":true,"description":"The identifier of the product condition"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"ConditionGeneratorResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"POST","path":"/product/productConditions/{productConditionId}","fullPath":"/api/v3.0.0/product/productConditions/{productConditionId}","operationId":"createConditionGenerator","name":"Create the product condition for the product feature based on the attributes and their field name and values","summary":"Create the product condition for the product feature","tags":[],"parameters":[{"name":"productConditionId","in":"path","type":"string","required":true,"description":"The identifier of the product condition"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"propertyId":"string","conditionName":"string","effectiveDate":"string","currencies":[{}]}},"responses":{"200":"ConditionGeneratorResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/product/productConditions/{productConditionId}","fullPath":"/api/v3.0.0/product/productConditions/{productConditionId}","operationId":"updateConditionGenerator","name":"Update the product condition for the product feature based on the attributes and their field name and values","summary":"Update the product condition for the product feature","tags":[],"parameters":[{"name":"productConditionId","in":"path","type":"string","required":true,"description":"The identifier of the product condition"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"propertyId":"string","conditionName":"string","effectiveDate":"string","currencies":[{}]}},"responses":{"200":"ConditionGeneratorResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/product/productFeatures","fullPath":"/api/v3.0.0/product/productFeatures","operationId":"getProductLineFeatures","name":"Retrieves the list of product features and product line details","summary":"Retrieves the list of features","tags":[],"parameters":[{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"ProductLineFeaturesResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/product/{productId}/productConditions","fullPath":"/api/v3.0.0/product/{productId}/productConditions","operationId":"getProductCatalogue","name":"Retrieves the catalogued conditions of a given product","summary":"Retrieves the catalogued conditions of a given product","tags":["RETAIL"],"parameters":[{"name":"productId","in":"path","type":"string","required":true,"description":"Contains the unique identifier of the product, e.g. the product id of the arrangement account."},{"name":"currency","in":"query","type":"string","required":false,"description":"Identifies the currency. E.g. USD, GBP etc"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"ProductCatalogueResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"PUT","path":"/product/productManagers/{productId}","fullPath":"/api/v3.0.0/product/productManagers/{productId}","operationId":"updateProductManager","name":"Update the action such as proof or publish for the specific product","summary":"Update the action for product","tags":[],"parameters":[{"name":"productId","in":"path","type":"string","required":true,"description":"Contains the unique identifier of the product, e.g. the product id of the arrangement account."},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"displayName":"string","action":"string","availableDate":"2024-01-01","processMethod":"string"}},"responses":{"200":"ProductManagerResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/product/interestConditions","fullPath":"/api/v3.0.0/product/interestConditions","operationId":"getInterestConditionReference","name":"Retrieves all the available interest conditions","summary":"Retrieves all the available interest conditions","tags":[],"parameters":[{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"InterestConditionReferenceResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/product/products/{productId}/overpaymentRules","fullPath":"/api/v3.0.0/product/products/{productId}/overpaymentRules","operationId":"getProductOverpaymentDetails","name":"Fetch the overpayment rule details like type of overpay, overpay limit and period defined for a product. Overpayment is excess repayments done in addition to mandate payments.","summary":"To fetch the overpayment configurations done in a product","tags":["RETAIL"],"parameters":[{"name":"productId","in":"path","type":"string","required":true,"description":"Contains the unique identifier of the product, e.g. the product id of the arrangement account."},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"ProductOverpaymentDetailsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}}]},{"key":"product-products-v3.1.0","title":"Product Builder","version":"v3.1.0","description":"API to create, update and manage the product definition details, interest conditions, repayment calculator, simulate a loan contract and project the schedules","endpointCount":34,"endpoints":[{"method":"GET","path":"/product/productLines/{productLineId}/productGroups/{productGroupId}/products","fullPath":"/api/v3.1.0/product/productLines/{productLineId}/productGroups/{productGroupId}/products","operationId":"getProductsPerLineAndGroup","name":"Retrieves the details of all the products based on a given product line and product group","summary":"Retrieves the details of all the products based on a given product line and product group","tags":[],"parameters":[{"name":"productLineId","in":"path","type":"string","required":true,"description":"The top level product line, which the product is ultimately attached to. May be a Temenos-defined product line such as ACCOUNTS, AGENT, BUNDLE, CONSENT, DEPOSITS, LENDING, REWARDS, etc. or one defined"},{"name":"productGroupId","in":"path","type":"string","required":true,"description":"The group, as defined by the institution, that the product belongs to."},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"ProductsPerLineAndGroupResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse","default":"QueryErrorResponse"}},{"method":"GET","path":"/product/productLines/{productLineId}/productGroups","fullPath":"/api/v3.1.0/product/productLines/{productLineId}/productGroups","operationId":"getProductGroups","name":"Retrieves the details of all the products based on a given product line","summary":"Retrieves the details of all the products based on a given product line","tags":[],"parameters":[{"name":"productLineId","in":"path","type":"string","required":true,"description":"The top level product line, which the product is ultimately attached to. May be a Temenos-defined product line such as ACCOUNTS, AGENT, BUNDLE, CONSENT, DEPOSITS, LENDING, REWARDS, etc. or one defined"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"ProductGroupsResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse","default":"QueryErrorResponse"}},{"method":"GET","path":"/product/productLines/{productLineId}/activities","fullPath":"/api/v3.1.0/product/productLines/{productLineId}/activities","operationId":"getProductLineActivities","name":"Retrieves the list of activities applicable for a given product line","summary":"Retrieves the list of activities applicable for a given product line","tags":[],"parameters":[{"name":"productLineId","in":"path","type":"string","required":true,"description":"The top level product line, which the product is ultimately attached to. May be a Temenos-defined product line such as ACCOUNTS, AGENT, BUNDLE, CONSENT, DEPOSITS, LENDING, REWARDS, etc. or one defined"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"ProductLineActivitiesResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse","default":"QueryErrorResponse"}},{"method":"GET","path":"/product/productLines","fullPath":"/api/v3.1.0/product/productLines","operationId":"getProductLines","name":"Retrieves the list of available product line","summary":"Retrieves the list of available product line","tags":[],"parameters":[{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"ProductLinesResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse","default":"QueryErrorResponse"}},{"method":"GET","path":"/product/products","fullPath":"/api/v3.1.0/product/products","operationId":"getAllProducts","name":"Retrieves all the product available in the catalogue","summary":"Retrieves all the product available in the catalogue","tags":[],"parameters":[{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"AllProductsResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse","default":"QueryErrorResponse"}},{"method":"GET","path":"/product/products/{productId}","fullPath":"/api/v3.1.0/product/products/{productId}","operationId":"getProducts","name":"Retrieves the details of a given product","summary":"Retrieves the details of a given product","tags":[],"parameters":[{"name":"productId","in":"path","type":"string","required":true,"description":""},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"ProductsResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse","default":"QueryErrorResponse"}},{"method":"GET","path":"/product/propertyClasses","fullPath":"/api/v3.1.0/product/propertyClasses","operationId":"getPropertyClasses","name":"Retrieves the product's property class information, which is used for building products","summary":"Retrieves the product's property class information, which is used for building products","tags":[],"parameters":[{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"PropertyClassesResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse","default":"QueryErrorResponse"}},{"method":"GET","path":"/product/productGroups","fullPath":"/api/v3.1.0/product/productGroups","operationId":"getAllProductGroups","name":"Retrieves the list of product groups available with its product line","summary":"Retrieves the list of product groups available with its product line","tags":[],"parameters":[{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"AllProductGroupsResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse","default":"QueryErrorResponse"}},{"method":"GET","path":"/product/{productId}","fullPath":"/api/v3.1.0/product/{productId}","operationId":"getProductDetails","name":"Retrieves the product details for a catalogued product","summary":"Retrieves the product details for a catalogued product","tags":[],"parameters":[{"name":"productId","in":"path","type":"string","required":true,"description":"Contains the unique identifier of the product, e.g. the product id of the arrangement account."},{"name":"currency","in":"query","type":"string","required":false,"description":"Identifies the currency. E.g. USD, GBP etc"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"ProductDetailsResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse","default":"QueryErrorResponse"}},{"method":"GET","path":"/product/productBuilder/interestConditions","fullPath":"/api/v3.1.0/product/productBuilder/interestConditions","operationId":"getAllInterestConditions","name":"Retrieves the list of all the available interest conditions","summary":"Retrieves the list of all the available interest conditions","tags":[],"parameters":[{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"AllInterestConditionsResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse","default":"QueryErrorResponse"}},{"method":"GET","path":"/product/productBuilder/interestConditions/{interestConditionId}","fullPath":"/api/v3.1.0/product/productBuilder/interestConditions/{interestConditionId}","operationId":"getInterestConditions","name":"Retrieves the details of the given interest condition","summary":"Retrieves the details of the given interest condition","tags":[],"parameters":[{"name":"interestConditionId","in":"path","type":"string","required":true,"description":"The identifier of the product condition used to define the interest rate"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"InterestConditionsResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse","default":"ScreenErrorResponse"}},{"method":"POST","path":"/product/productBuilder/interestConditions/{interestConditionId}","fullPath":"/api/v3.1.0/product/productBuilder/interestConditions/{interestConditionId}","operationId":"createInterestCondition","name":"Creates a new interest condition","summary":"Creates a new interest condition","tags":[],"parameters":[{"name":"interestConditionId","in":"path","type":"string","required":true,"description":"The identifier of the product condition used to define the interest rate"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"rates":[{}],"displayNames":[{}],"rateTierType":"string","linkedArrangement":"string","defaultNegotiable":"string","accrualRule":"string"}},"responses":{"200":"InterestConditionResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse","default":"ScreenErrorResponse"}},{"method":"PUT","path":"/product/productBuilder/interestConditions/{interestConditionId}","fullPath":"/api/v3.1.0/product/productBuilder/interestConditions/{interestConditionId}","operationId":"updateInterestCondition","name":"Updates an existing interest condition","summary":"Updates an existing interest condition","tags":[],"parameters":[{"name":"interestConditionId","in":"path","type":"string","required":true,"description":"The identifier of the product condition used to define the interest rate"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"rates":[{}],"displayNames":[{}],"rateTierType":"string","linkedArrangement":"string","defaultNegotiable":"string","accrualRule":"string"}},"responses":{"200":"InterestConditionResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse","default":"ScreenErrorResponse"}},{"method":"GET","path":"/product/productBuilder/productConditions","fullPath":"/api/v3.1.0/product/productBuilder/productConditions","operationId":"getProductConditions","name":"Retrieves the list of product conditions available","summary":"Retrieves the list of product conditions available","tags":[],"parameters":[{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"ProductConditionsResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse","default":"QueryErrorResponse"}},{"method":"GET","path":"/product/productBuilder/properties","fullPath":"/api/v3.1.0/product/productBuilder/properties","operationId":"getProperties","name":"Retrieves the details of all the available properties","summary":"Retrieves the details of all the available properties","tags":[],"parameters":[{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"PropertiesResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse","default":"QueryErrorResponse"}},{"method":"GET","path":"/product/productBuilder/projects","fullPath":"/api/v3.1.0/product/productBuilder/projects","operationId":"getProjects","name":"Retrieves the list of available projects created to build a product","summary":"Retrieves the list of available projects created to build a product","tags":[],"parameters":[{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"ProjectsResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse","default":"QueryErrorResponse"}},{"method":"GET","path":"/product/{productId}/commitment/{amount}/period/{term}","fullPath":"/api/v3.1.0/product/{productId}/commitment/{amount}/period/{term}","operationId":"getRepaymentCalculator","name":"Retrieves the repayment details for the given product, principal amount and term","summary":"Retrieves the repayment details for the given product, principal amount and term","tags":[],"parameters":[{"name":"productId","in":"path","type":"string","required":true,"description":"Contains the unique identifier of the product, e.g. the product id of the arrangement account."},{"name":"amount","in":"path","type":"string","required":true,"description":"This is the payment amount"},{"name":"term","in":"path","type":"string","required":true,"description":"Indicates the period to which the BID and OFFER rates apply"},{"name":"currencyId","in":"query","type":"string","required":false,"description":"Identifier of the currency. This is the 3-letter ISO 4217 code of the currency."},{"name":"paymentFrequency","in":"query","type":"string","required":false,"description":"The frequency at which a payment is required to be generated"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"RepaymentCalculatorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse","default":"QueryErrorResponse"}},{"method":"POST","path":"/product/loans/simulations","fullPath":"/api/v3.1.0/product/loans/simulations","operationId":"createSynchronousSimulation","name":"Simulate a loan arrangement for the given principal amount, term, payment frequency and interest rates","summary":"Simulate a loan arrangement for the given principal amount, term, payment frequency and interest rates","tags":[],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"customerIds":[{}],"properties":[{}],"overrides":[{}],"productId":"string","masterArrangementId":"string","roleName":"string","currencyId":"string","effectiveDate":"2024-01-01","activityId":"string","transactionAmount":0.0}},"responses":{"200":"createSynchronousSimulationResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse","default":"ArrangementErrorResponse"}},{"method":"POST","path":"/product/loans/simulations/schedules","fullPath":"/api/v3.1.0/product/loans/simulations/schedules","operationId":"createSynchronousSimulationSchedules","name":"Simulate a loan arrangement for the given principal amount, term, payment frequency and interest rates. It also retrieves the details of payment schedules for the simulated contract","summary":"Simulate a loan arrangement and retrieve the payment schedule details","tags":[],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"customerIds":[{}],"properties":[{}],"overrides":[{}],"productId":"string","masterArrangementId":"string","roleName":"string","currencyId":"string","effectiveDate":"2024-01-01","activityId":"string","transactionAmount":0.0}},"responses":{"200":"createSynchronousSimulationSchedulesResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse","default":"ArrangementErrorResponse"}},{"method":"GET","path":"/product/productTypes","fullPath":"/api/v3.1.0/product/productTypes","operationId":"getAllProductTypes","name":"Retrieves the list of product types available in the Transact system","summary":"Retrieves the list of product types available in the Transact system","tags":[],"parameters":[{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"AllProductTypesResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse","default":"QueryErrorResponse"}},{"method":"GET","path":"/product/productTypes/{productType}","fullPath":"/api/v3.1.0/product/productTypes/{productType}","operationId":"getProductType","name":"Retrieves the product type details for a given product type","summary":"Retrieves the product type details for a given product type","tags":[],"parameters":[{"name":"productType","in":"path","type":"string","required":true,"description":"Indicates the product type for the deal"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"ProductTypeResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse","default":"QueryErrorResponse"}},{"method":"GET","path":"/product/productTypes/products/{productId}","fullPath":"/api/v3.1.0/product/productTypes/products/{productId}","operationId":"getProductStatus","name":"Retrieves the basic details such as product details,status,proof and publish errors if any","summary":"Retrieves the basic details of a given product","tags":[],"parameters":[{"name":"productId","in":"path","type":"string","required":true,"description":"Contains the unique identifier of the product, e.g. the product id of the arrangement account."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"ProductStatusResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse","default":"ScreenErrorResponse"}},{"method":"POST","path":"/product/productTypes/products/{productId}","fullPath":"/api/v3.1.0/product/productTypes/products/{productId}","operationId":"createProducts","name":"Create a product using the conditions available from the product type","summary":"Create a product from a product type","tags":[],"parameters":[{"name":"productId","in":"path","type":"string","required":true,"description":"Contains the unique identifier of the product, e.g. the product id of the arrangement account."},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"id":"string","status":"string","transactionStatus":"string","uniqueIdentifier":"string","audit":{"T24_time":{},"versionNumber":{},"requestParse_time":{},"responseParse_time":{}}},"body":{"productType":"string","productId":"string","productGroupId":"string","productLineId":"string","productName":"string","productDescription":"string","availableCurrency":[{}],"effectiveDate":"string","version":"string","productAttributes":[{}],"propertyList":[{}]}},"responses":{"200":"ProductsResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse","default":"ScreenErrorResponse"}},{"method":"PUT","path":"/product/productTypes/products/{productId}","fullPath":"/api/v3.1.0/product/productTypes/products/{productId}","operationId":"updateProducts","name":"Update a product such as property conditions and its condition values","summary":"Update a product such as property conditions and its condition values","tags":[],"parameters":[{"name":"productId","in":"path","type":"string","required":true,"description":"Contains the unique identifier of the product, e.g. the product id of the arrangement account."},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"id":"string","status":"string","transactionStatus":"string","uniqueIdentifier":"string","audit":{"T24_time":{},"versionNumber":{},"requestParse_time":{},"responseParse_time":{}}},"body":{"productType":"string","productId":"string","productGroupId":"string","productLineId":"string","productName":"string","productDescription":"string","availableCurrency":[{}],"effectiveDate":"string","version":"string","productAttributes":[{}],"propertyList":[{}]}},"responses":{"200":"ProductsResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse","default":"ScreenErrorResponse"}},{"method":"GET","path":"/product/productFeatures/{productFeatureId}/attributes","fullPath":"/api/v3.1.0/product/productFeatures/{productFeatureId}/attributes","operationId":"getPropertyFields","name":"Retrieves the attribute and the field structure for the given product feature","summary":"Retrieves the attribute and the field structure","tags":[],"parameters":[{"name":"productFeatureId","in":"path","type":"string","required":true,"description":""},{"name":"productConditionId","in":"query","type":"string","required":false,"description":"The identifier of the product condition"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"PropertyFieldsResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse","default":"QueryErrorResponse"}},{"method":"GET","path":"/product/productGroups/{productGroupId}/productFeatures/productConditions","fullPath":"/api/v3.1.0/product/productGroups/{productGroupId}/productFeatures/productConditions","operationId":"getProductLineFeatureConditions","name":"Retrieves the product conditions for the product features present in the product group","summary":"Retrieves the product conditions for the product features","tags":[],"parameters":[{"name":"productGroupId","in":"path","type":"string","required":true,"description":"The group, as defined by the institution, that the product belongs to."},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"ProductLineFeatureConditionsResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse","default":"QueryErrorResponse"}},{"method":"GET","path":"/product/productConditions/{productConditionId}","fullPath":"/api/v3.1.0/product/productConditions/{productConditionId}","operationId":"getConditionGenerator","name":"Retrieves the base condition details of a product feature such as the attributes ,their field name and values,status and validation errors if any","summary":"Retrieves the base condition details of a product feature","tags":[],"parameters":[{"name":"productConditionId","in":"path","type":"string","required":true,"description":"The identifier of the product condition"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"ConditionGeneratorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse","default":"ScreenErrorResponse"}},{"method":"POST","path":"/product/productConditions/{productConditionId}","fullPath":"/api/v3.1.0/product/productConditions/{productConditionId}","operationId":"createConditionGenerator","name":"Create the product condition for the product feature based on the attributes and their field name and values","summary":"Create the product condition for the product feature","tags":[],"parameters":[{"name":"productConditionId","in":"path","type":"string","required":true,"description":"The identifier of the product condition"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"propertyId":"string","conditionName":"string","effectiveDate":"string","currencies":[{}]}},"responses":{"200":"ConditionGeneratorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse","default":"ScreenErrorResponse"}},{"method":"PUT","path":"/product/productConditions/{productConditionId}","fullPath":"/api/v3.1.0/product/productConditions/{productConditionId}","operationId":"updateConditionGenerator","name":"Update the product condition for the product feature based on the attributes and their field name and values","summary":"Update the product condition for the product feature","tags":[],"parameters":[{"name":"productConditionId","in":"path","type":"string","required":true,"description":"The identifier of the product condition"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"propertyId":"string","conditionName":"string","effectiveDate":"string","currencies":[{}]}},"responses":{"200":"ConditionGeneratorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse","default":"ScreenErrorResponse"}},{"method":"GET","path":"/product/productFeatures","fullPath":"/api/v3.1.0/product/productFeatures","operationId":"getProductLineFeatures","name":"Retrieves the list of product features and product line details","summary":"Retrieves the list of features","tags":[],"parameters":[{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"ProductLineFeaturesResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse","default":"QueryErrorResponse"}},{"method":"GET","path":"/product/{productId}/productConditions","fullPath":"/api/v3.1.0/product/{productId}/productConditions","operationId":"getProductCatalogue","name":"Retrieves the catalogued conditions of a given product","summary":"Retrieves the catalogued conditions of a given product","tags":["RETAIL"],"parameters":[{"name":"productId","in":"path","type":"string","required":true,"description":"Contains the unique identifier of the product, e.g. the product id of the arrangement account."},{"name":"currency","in":"query","type":"string","required":false,"description":"Identifies the currency. E.g. USD, GBP etc"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"ProductCatalogueResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse","default":"QueryErrorResponse"}},{"method":"PUT","path":"/product/productManagers/{productId}","fullPath":"/api/v3.1.0/product/productManagers/{productId}","operationId":"updateProductManager","name":"Update the action such as proof or publish for the specific product","summary":"Update the action for product","tags":[],"parameters":[{"name":"productId","in":"path","type":"string","required":true,"description":"Contains the unique identifier of the product, e.g. the product id of the arrangement account."},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"displayName":"string","action":"string","availableDate":"2024-01-01","processMethod":"string"}},"responses":{"200":"ProductManagerResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse","default":"ScreenErrorResponse"}},{"method":"GET","path":"/product/interestConditions","fullPath":"/api/v3.1.0/product/interestConditions","operationId":"getInterestConditionReference","name":"Retrieves all the available interest conditions","summary":"Retrieves all the available interest conditions","tags":[],"parameters":[{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"InterestConditionReferenceResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse","default":"QueryErrorResponse"}},{"method":"GET","path":"/product/products/{productId}/overpaymentRules","fullPath":"/api/v3.1.0/product/products/{productId}/overpaymentRules","operationId":"getProductOverpaymentDetails","name":"Retrieve the overpayment rule details like type of overpay, overpay limit and period defined for a product. Overpayment is excess repayments done in addition to mandate payments.","summary":"To retrieve the overpayment configurations done in a product","tags":["RETAIL"],"parameters":[{"name":"productId","in":"path","type":"string","required":true,"description":"Contains the unique identifier of the product, e.g. the product id of the arrangement account."},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"ProductOverpaymentDetailsResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse","default":"QueryErrorResponse"}}]},{"key":"product-products-v3.2.0","title":"Product Builder","version":"v3.2.0","description":"API to create, update and manage the product definition details, interest conditions, repayment calculator, simulate a loan contract and project the schedules","endpointCount":34,"endpoints":[{"method":"GET","path":"/product/productLines/{productLineId}/productGroups/{productGroupId}/products","fullPath":"/api/v3.2.0/product/productLines/{productLineId}/productGroups/{productGroupId}/products","operationId":"getProductsPerLineAndGroup","name":"Retrieves the details of all the products based on a given product line and product group","summary":"Retrieves the details of all the products based on a given product line and product group","tags":[],"parameters":[{"name":"productLineId","in":"path","type":"string","required":true,"description":"The top level product line, which the product is ultimately attached to. May be a Temenos-defined product line such as ACCOUNTS, AGENT, BUNDLE, CONSENT, DEPOSITS, LENDING, REWARDS, etc. or one defined"},{"name":"productGroupId","in":"path","type":"string","required":true,"description":"The group, as defined by the institution, that the product belongs to."},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"ProductsPerLineAndGroupResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/product/productLines/{productLineId}/productGroups","fullPath":"/api/v3.2.0/product/productLines/{productLineId}/productGroups","operationId":"getProductGroups","name":"Retrieves the details of all the products based on a given product line","summary":"Retrieves the details of all the products based on a given product line","tags":[],"parameters":[{"name":"productLineId","in":"path","type":"string","required":true,"description":"The top level product line, which the product is ultimately attached to. May be a Temenos-defined product line such as ACCOUNTS, AGENT, BUNDLE, CONSENT, DEPOSITS, LENDING, REWARDS, etc. or one defined"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"ProductGroupsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/product/productLines/{productLineId}/activities","fullPath":"/api/v3.2.0/product/productLines/{productLineId}/activities","operationId":"getProductLineActivities","name":"Retrieves the list of activities applicable for a given product line","summary":"Retrieves the list of activities applicable for a given product line","tags":[],"parameters":[{"name":"productLineId","in":"path","type":"string","required":true,"description":"The top level product line, which the product is ultimately attached to. May be a Temenos-defined product line such as ACCOUNTS, AGENT, BUNDLE, CONSENT, DEPOSITS, LENDING, REWARDS, etc. or one defined"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"ProductLineActivitiesResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/product/productLines","fullPath":"/api/v3.2.0/product/productLines","operationId":"getProductLines","name":"Retrieves the list of available product line","summary":"Retrieves the list of available product line","tags":[],"parameters":[{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"ProductLinesResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/product/products","fullPath":"/api/v3.2.0/product/products","operationId":"getAllProducts","name":"Retrieves all the product available in the catalogue","summary":"Retrieves all the product available in the catalogue","tags":[],"parameters":[{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"AllProductsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/product/products/{productId}","fullPath":"/api/v3.2.0/product/products/{productId}","operationId":"getProducts","name":"Retrieves the details of a given product","summary":"Retrieves the details of a given product","tags":[],"parameters":[{"name":"productId","in":"path","type":"string","required":true,"description":""},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"ProductsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/product/propertyClasses","fullPath":"/api/v3.2.0/product/propertyClasses","operationId":"getPropertyClasses","name":"Retrieves the product's property class information, which is used for building products","summary":"Retrieves the product's property class information, which is used for building products","tags":[],"parameters":[{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"PropertyClassesResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/product/productGroups","fullPath":"/api/v3.2.0/product/productGroups","operationId":"getAllProductGroups","name":"Retrieves the list of product group available with its product line","summary":"Retrieves the list of product group available with its product line","tags":[],"parameters":[{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"AllProductGroupsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/product/{productId}","fullPath":"/api/v3.2.0/product/{productId}","operationId":"getProductDetails","name":"Retrieves the product details for a catalogued product","summary":"Retrieves the product details for a catalogued product","tags":[],"parameters":[{"name":"productId","in":"path","type":"string","required":true,"description":"Contains the unique identifier of the product, e.g. the product id of the arrangement account."},{"name":"currency","in":"query","type":"string","required":false,"description":"Identifies the currency. E.g. USD, GBP etc"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"ProductDetailsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/product/productBuilder/interestConditions","fullPath":"/api/v3.2.0/product/productBuilder/interestConditions","operationId":"getAllInterestConditions","name":"Retrieves the list of all the available interest conditions","summary":"Retrieves the list of all the available interest conditions","tags":[],"parameters":[{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"AllInterestConditionsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/product/productBuilder/interestConditions/{interestConditionId}","fullPath":"/api/v3.2.0/product/productBuilder/interestConditions/{interestConditionId}","operationId":"getInterestConditions","name":"Retrieves the details of the given interest condition","summary":"Retrieves the details of the given interest condition","tags":[],"parameters":[{"name":"interestConditionId","in":"path","type":"string","required":true,"description":"The identifier of the product condition used to define the interest rate"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"InterestConditionsResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"POST","path":"/product/productBuilder/interestConditions/{interestConditionId}","fullPath":"/api/v3.2.0/product/productBuilder/interestConditions/{interestConditionId}","operationId":"createInterestCondition","name":"Creates a new interest condition","summary":"Creates a new interest condition","tags":[],"parameters":[{"name":"interestConditionId","in":"path","type":"string","required":true,"description":"The identifier of the product condition used to define the interest rate"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"rates":[{}],"displayNames":[{}],"rateTierType":"string","linkedArrangement":"string","defaultNegotiable":"string","accrualRule":"string"}},"responses":{"200":"InterestConditionResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/product/productBuilder/interestConditions/{interestConditionId}","fullPath":"/api/v3.2.0/product/productBuilder/interestConditions/{interestConditionId}","operationId":"updateInterestCondition","name":"Updates an existing interest condition","summary":"Updates an existing interest condition","tags":[],"parameters":[{"name":"interestConditionId","in":"path","type":"string","required":true,"description":"The identifier of the product condition used to define the interest rate"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"rates":[{}],"displayNames":[{}],"rateTierType":"string","linkedArrangement":"string","defaultNegotiable":"string","accrualRule":"string"}},"responses":{"200":"InterestConditionResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/product/productBuilder/productConditions","fullPath":"/api/v3.2.0/product/productBuilder/productConditions","operationId":"getProductConditions","name":"Retrieves the list of product conditions available","summary":"Retrieves the list of product conditions available","tags":[],"parameters":[{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"ProductConditionsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/product/productBuilder/properties","fullPath":"/api/v3.2.0/product/productBuilder/properties","operationId":"getProperties","name":"Retrieves the details of all the available properties","summary":"Retrieves the details of all the available properties","tags":[],"parameters":[{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"PropertiesResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/product/productBuilder/projects","fullPath":"/api/v3.2.0/product/productBuilder/projects","operationId":"getProjects","name":"Retrieves the list of available projects created to build a product","summary":"Retrieves the list of available projects created to build a product","tags":[],"parameters":[{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"ProjectsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/product/{productId}/commitment/{amount}/period/{term}","fullPath":"/api/v3.2.0/product/{productId}/commitment/{amount}/period/{term}","operationId":"getRepaymentCalculator","name":"Retrieves the repayment details for the given product, principal amount and term","summary":"Retrieves the repayment details for the given product, principal amount and term","tags":[],"parameters":[{"name":"productId","in":"path","type":"string","required":true,"description":"Contains the unique identifier of the product, e.g. the product id of the arrangement account."},{"name":"amount","in":"path","type":"string","required":true,"description":"This is the payment amount"},{"name":"term","in":"path","type":"string","required":true,"description":"Indicates the period to which the BID and OFFER rates apply"},{"name":"currencyId","in":"query","type":"string","required":false,"description":"Identifier of the currency. This is the 3-letter ISO 4217 code of the currency."},{"name":"paymentFrequency","in":"query","type":"string","required":false,"description":"The frequency at which a payment is required to be generated"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"RepaymentCalculatorResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"POST","path":"/product/loans/simulations","fullPath":"/api/v3.2.0/product/loans/simulations","operationId":"createSynchronousSimulation","name":"Simulate a loan arrangement for the given principal amount, term, payment frequency and interest rates","summary":"Simulate a loan arrangement for the given principal amount, term, payment frequency and interest rates","tags":[],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"customerIds":[{}],"properties":[{}],"overrides":[{}],"productId":"string","masterArrangementId":"string","roleName":"string","currencyId":"string","effectiveDate":"2024-01-01","activityId":"string","transactionAmount":0.0}},"responses":{"200":"createSynchronousSimulationResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"POST","path":"/product/loans/simulations/schedules","fullPath":"/api/v3.2.0/product/loans/simulations/schedules","operationId":"createSynchronousSimulationSchedules","name":"Simulate a loan arrangement for the given principal amount, term, payment frequency and interest rates. It also retrieves the details of payment schedules for the simulated contract","summary":"Simulate a loan arrangement and retrieve the payment schedule details","tags":[],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"customerIds":[{}],"properties":[{}],"overrides":[{}],"productId":"string","masterArrangementId":"string","roleName":"string","currencyId":"string","effectiveDate":"2024-01-01","activityId":"string","transactionAmount":0.0}},"responses":{"200":"createSynchronousSimulationSchedulesResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"GET","path":"/product/productTypes","fullPath":"/api/v3.2.0/product/productTypes","operationId":"getAllProductTypes","name":"Retrieves the list of product types available in the Transact system","summary":"Retrieves the list of product types available in the Transact system","tags":[],"parameters":[{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"AllProductTypesResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/product/productTypes/{productType}","fullPath":"/api/v3.2.0/product/productTypes/{productType}","operationId":"getProductType","name":"Retrieves the product type details for a given product type","summary":"Retrieves the product type details for a given product type","tags":[],"parameters":[{"name":"productType","in":"path","type":"string","required":true,"description":"Deprecated - Indicates the identifier(s) of a Blueprint product from which an actual product can be created"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"ProductTypeResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/product/productTypes/products/{productId}","fullPath":"/api/v3.2.0/product/productTypes/products/{productId}","operationId":"getProductStatus","name":"Retrieves the basic details such as product details,status,proof and publish errors if any","summary":"Retrieves the basic details of a given product","tags":[],"parameters":[{"name":"productId","in":"path","type":"string","required":true,"description":"Contains the unique identifier of the product, e.g. the product id of the arrangement account."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"ProductStatusResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"POST","path":"/product/productTypes/products/{productId}","fullPath":"/api/v3.2.0/product/productTypes/products/{productId}","operationId":"createProducts","name":"Create a product from a product type","summary":"Create a product using the conditions available from the product type","tags":[],"parameters":[{"name":"productId","in":"path","type":"string","required":true,"description":"Contains the unique identifier of the product, e.g. the product id of the arrangement account."},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"id":"string","status":"string","transactionStatus":"string","uniqueIdentifier":"string","audit":{"T24_time":{},"versionNumber":{},"requestParse_time":{},"responseParse_time":{}}},"body":{"productType":"string","productId":"string","productGroupId":"string","productLineId":"string","productName":"string","productDescription":"string","availableCurrency":[{}],"effectiveDate":"string","version":"string","productAttributes":[{}],"propertyList":[{}]}},"responses":{"200":"ProductsResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/product/productTypes/products/{productId}","fullPath":"/api/v3.2.0/product/productTypes/products/{productId}","operationId":"updateProducts","name":"Update a product such as property conditions and its condition values","summary":"Update a product such as property conditions and its condition values","tags":[],"parameters":[{"name":"productId","in":"path","type":"string","required":true,"description":"Contains the unique identifier of the product, e.g. the product id of the arrangement account."},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"id":"string","status":"string","transactionStatus":"string","uniqueIdentifier":"string","audit":{"T24_time":{},"versionNumber":{},"requestParse_time":{},"responseParse_time":{}}},"body":{"productType":"string","productId":"string","productGroupId":"string","productLineId":"string","productName":"string","productDescription":"string","availableCurrency":[{}],"effectiveDate":"string","version":"string","productAttributes":[{}],"propertyList":[{}]}},"responses":{"200":"ProductsResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/product/productFeatures/{productFeatureId}/attributes","fullPath":"/api/v3.2.0/product/productFeatures/{productFeatureId}/attributes","operationId":"getPropertyFields","name":"Retrieves the attribute and the field structure for the given product feature","summary":"Retrieves the attribute and the field structure","tags":[],"parameters":[{"name":"productFeatureId","in":"path","type":"string","required":true,"description":""},{"name":"productConditionId","in":"query","type":"string","required":false,"description":"The identifier of the product condition"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"PropertyFieldsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/product/productGroups/{productGroupId}/productFeatures/productConditions","fullPath":"/api/v3.2.0/product/productGroups/{productGroupId}/productFeatures/productConditions","operationId":"getProductLineFeatureConditions","name":"Retrieves the product conditions for the product features present in the product group","summary":"Retrieves the product conditions for the product features","tags":[],"parameters":[{"name":"productGroupId","in":"path","type":"string","required":true,"description":"The group, as defined by the institution, that the product belongs to."},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"ProductLineFeatureConditionsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/product/productConditions/{productConditionId}","fullPath":"/api/v3.2.0/product/productConditions/{productConditionId}","operationId":"getConditionGenerator","name":"Retrieves the base condition details of a product feature such as the attributes ,their field name and values,status and validation errors if any","summary":"Retrieves the base condition details of a product feature","tags":[],"parameters":[{"name":"productConditionId","in":"path","type":"string","required":true,"description":"The identifier of the product condition"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"ConditionGeneratorResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"POST","path":"/product/productConditions/{productConditionId}","fullPath":"/api/v3.2.0/product/productConditions/{productConditionId}","operationId":"createConditionGenerator","name":"Create the product condition for the product feature based on the attributes and their field name and values","summary":"Create the product condition for the product feature","tags":[],"parameters":[{"name":"productConditionId","in":"path","type":"string","required":true,"description":"The identifier of the product condition"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"propertyId":"string","conditionName":"string","effectiveDate":"string","currencies":[{}]}},"responses":{"200":"ConditionGeneratorResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/product/productConditions/{productConditionId}","fullPath":"/api/v3.2.0/product/productConditions/{productConditionId}","operationId":"updateConditionGenerator","name":"Update the product condition for the product feature based on the attributes and their field name and values","summary":"Update the product condition for the product feature","tags":[],"parameters":[{"name":"productConditionId","in":"path","type":"string","required":true,"description":"The identifier of the product condition"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"propertyId":"string","conditionName":"string","effectiveDate":"string","currencies":[{}]}},"responses":{"200":"ConditionGeneratorResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/product/productFeatures","fullPath":"/api/v3.2.0/product/productFeatures","operationId":"getProductLineFeatures","name":"Retrieves the list of product features and product line details","summary":"Retrieves the list of features","tags":[],"parameters":[{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"ProductLineFeaturesResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/product/{productId}/productConditions","fullPath":"/api/v3.2.0/product/{productId}/productConditions","operationId":"getProductCatalogue","name":"Retrieves the catalogued conditions of a given product","summary":"Retrieves the catalogued conditions of a given product","tags":["RETAIL"],"parameters":[{"name":"productId","in":"path","type":"string","required":true,"description":"Contains the unique identifier of the product, e.g. the product id of the arrangement account."},{"name":"currency","in":"query","type":"string","required":false,"description":"Identifies the currency. E.g. USD, GBP etc"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"ProductCatalogueResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"PUT","path":"/product/productManagers/{productId}","fullPath":"/api/v3.2.0/product/productManagers/{productId}","operationId":"updateProductManager","name":"Update the action such as proof and publish for the specific product","summary":"Update the action for product","tags":[],"parameters":[{"name":"productId","in":"path","type":"string","required":true,"description":"Contains the unique identifier of the product, e.g. the product id of the arrangement account."},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"displayName":"string","action":"string","availableDate":"2024-01-01","processMethod":"string"}},"responses":{"200":"ProductManagerResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/product/interestConditions","fullPath":"/api/v3.2.0/product/interestConditions","operationId":"getInterestConditionReference","name":"Retrieves all the available interest conditions","summary":"Retrieves all the available interest conditions","tags":[],"parameters":[{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"InterestConditionReferenceResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/product/products/{productId}/overpaymentRules","fullPath":"/api/v3.2.0/product/products/{productId}/overpaymentRules","operationId":"getProductOverpaymentDetails","name":"Fetch the overpayment rule details like type of overpay, overpay limit and period defined for a product. Overpayment is excess repayments done in addition to mandate payments.","summary":"To fetch the overpayment configurations done in a product","tags":["RETAIL"],"parameters":[{"name":"productId","in":"path","type":"string","required":true,"description":"Contains the unique identifier of the product, e.g. the product id of the arrangement account."},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"ProductOverpaymentDetailsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}}]},{"key":"product-products-v3.3.0","title":"Product Builder","version":"v3.3.0","description":"API to create, update and manage the product definition details, interest conditions, repayment calculator, simulate a loan contract and project the schedules","endpointCount":34,"endpoints":[{"method":"GET","path":"/product/productLines/{productLineId}/productGroups/{productGroupId}/products","fullPath":"/api/v3.3.0/product/productLines/{productLineId}/productGroups/{productGroupId}/products","operationId":"getProductsPerLineAndGroup","name":"Retrieves the details of all the products based on a given product line and product group","summary":"Retrieves the details of all the products based on a given product line and product group","tags":[],"parameters":[{"name":"productLineId","in":"path","type":"string","required":true,"description":"The top level product line, which the product is ultimately attached to. May be a Temenos-defined product line such as ACCOUNTS, AGENT, BUNDLE, CONSENT, DEPOSITS, LENDING, REWARDS, etc. or one defined"},{"name":"productGroupId","in":"path","type":"string","required":true,"description":"The group, as defined by the institution, that the product belongs to."},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"ProductsPerLineAndGroupResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/product/productLines/{productLineId}/productGroups","fullPath":"/api/v3.3.0/product/productLines/{productLineId}/productGroups","operationId":"getProductGroups","name":"Retrieves the details of all the products based on a given product line","summary":"Retrieves the details of all the products based on a given product line","tags":[],"parameters":[{"name":"productLineId","in":"path","type":"string","required":true,"description":"The top level product line, which the product is ultimately attached to. May be a Temenos-defined product line such as ACCOUNTS, AGENT, BUNDLE, CONSENT, DEPOSITS, LENDING, REWARDS, etc. or one defined"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"ProductGroupsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/product/productLines/{productLineId}/activities","fullPath":"/api/v3.3.0/product/productLines/{productLineId}/activities","operationId":"getProductLineActivities","name":"Retrieves the list of activities applicable for a given product line","summary":"Retrieves the list of activities applicable for a given product line","tags":[],"parameters":[{"name":"productLineId","in":"path","type":"string","required":true,"description":"The top level product line, which the product is ultimately attached to. May be a Temenos-defined product line such as ACCOUNTS, AGENT, BUNDLE, CONSENT, DEPOSITS, LENDING, REWARDS, etc. or one defined"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"ProductLineActivitiesResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/product/productLines","fullPath":"/api/v3.3.0/product/productLines","operationId":"getProductLines","name":"Retrieves the list of available product line","summary":"Retrieves the list of available product line","tags":[],"parameters":[{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"ProductLinesResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/product/products","fullPath":"/api/v3.3.0/product/products","operationId":"getAllProducts","name":"Retrieves all the product available in the catalogue","summary":"Retrieves all the product available in the catalogue","tags":[],"parameters":[{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"AllProductsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/product/products/{productId}","fullPath":"/api/v3.3.0/product/products/{productId}","operationId":"getProducts","name":"Retrieves the details of a given product","summary":"Retrieves the details of a given product","tags":[],"parameters":[{"name":"productId","in":"path","type":"string","required":true,"description":""},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"ProductsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/product/propertyClasses","fullPath":"/api/v3.3.0/product/propertyClasses","operationId":"getPropertyClasses","name":"Retrieves the product's property class information, which is used for building products","summary":"Retrieves the product's property class information, which is used for building products","tags":[],"parameters":[{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"PropertyClassesResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/product/productGroups","fullPath":"/api/v3.3.0/product/productGroups","operationId":"getAllProductGroups","name":"Retrieves the list of product group available with its product line","summary":"Retrieves the list of product group available with its product line","tags":[],"parameters":[{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"AllProductGroupsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/product/{productId}","fullPath":"/api/v3.3.0/product/{productId}","operationId":"getProductDetails","name":"Retrieves the product details for a catalogued product","summary":"Retrieves the product details for a catalogued product","tags":[],"parameters":[{"name":"productId","in":"path","type":"string","required":true,"description":"Contains the unique identifier of the product, e.g. the product id of the arrangement account."},{"name":"currency","in":"query","type":"string","required":false,"description":"Identifies the currency. E.g. USD, GBP etc"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"ProductDetailsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/product/productBuilder/interestConditions","fullPath":"/api/v3.3.0/product/productBuilder/interestConditions","operationId":"getAllInterestConditions","name":"Retrieves the list of all the available interest conditions","summary":"Retrieves the list of all the available interest conditions","tags":[],"parameters":[{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"AllInterestConditionsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/product/productBuilder/interestConditions/{interestConditionId}","fullPath":"/api/v3.3.0/product/productBuilder/interestConditions/{interestConditionId}","operationId":"getInterestConditions","name":"Retrieves the details of the given interest condition","summary":"Retrieves the details of the given interest condition","tags":[],"parameters":[{"name":"interestConditionId","in":"path","type":"string","required":true,"description":"The identifier of the product condition used to define the interest rate"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"InterestConditionsResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"POST","path":"/product/productBuilder/interestConditions/{interestConditionId}","fullPath":"/api/v3.3.0/product/productBuilder/interestConditions/{interestConditionId}","operationId":"createInterestCondition","name":"Creates a new interest condition","summary":"Creates a new interest condition","tags":[],"parameters":[{"name":"interestConditionId","in":"path","type":"string","required":true,"description":"The identifier of the product condition used to define the interest rate"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"rates":[{}],"displayNames":[{}],"rateTierType":"string","linkedArrangement":"string","defaultNegotiable":"string","accrualRule":"string"}},"responses":{"200":"InterestConditionResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/product/productBuilder/interestConditions/{interestConditionId}","fullPath":"/api/v3.3.0/product/productBuilder/interestConditions/{interestConditionId}","operationId":"updateInterestCondition","name":"Updates an existing interest condition","summary":"Updates an existing interest condition","tags":[],"parameters":[{"name":"interestConditionId","in":"path","type":"string","required":true,"description":"The identifier of the product condition used to define the interest rate"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"rates":[{}],"displayNames":[{}],"rateTierType":"string","linkedArrangement":"string","defaultNegotiable":"string","accrualRule":"string"}},"responses":{"200":"InterestConditionResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/product/productBuilder/productConditions","fullPath":"/api/v3.3.0/product/productBuilder/productConditions","operationId":"getProductConditions","name":"Retrieves the list of product conditions available","summary":"Retrieves the list of product conditions available","tags":[],"parameters":[{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"ProductConditionsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/product/productBuilder/properties","fullPath":"/api/v3.3.0/product/productBuilder/properties","operationId":"getProperties","name":"Retrieves the details of all the available properties","summary":"Retrieves the details of all the available properties","tags":[],"parameters":[{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"PropertiesResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/product/productBuilder/projects","fullPath":"/api/v3.3.0/product/productBuilder/projects","operationId":"getProjects","name":"Retrieves the list of available projects created to build a product","summary":"Retrieves the list of available projects created to build a product","tags":[],"parameters":[{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"ProjectsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/product/{productId}/commitment/{amount}/period/{term}","fullPath":"/api/v3.3.0/product/{productId}/commitment/{amount}/period/{term}","operationId":"getRepaymentCalculator","name":"Retrieves the repayment details for the given product, principal amount and term","summary":"Retrieves the repayment details for the given product, principal amount and term","tags":[],"parameters":[{"name":"productId","in":"path","type":"string","required":true,"description":"Contains the unique identifier of the product, e.g. the product id of the arrangement account."},{"name":"amount","in":"path","type":"string","required":true,"description":"This is the payment amount"},{"name":"term","in":"path","type":"string","required":true,"description":"Indicates the period to which the BID and OFFER rates apply"},{"name":"currencyId","in":"query","type":"string","required":false,"description":"Identifier of the currency. This is the 3-letter ISO 4217 code of the currency."},{"name":"paymentFrequency","in":"query","type":"string","required":false,"description":"The frequency at which a payment is required to be generated"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"RepaymentCalculatorResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"POST","path":"/product/loans/simulations","fullPath":"/api/v3.3.0/product/loans/simulations","operationId":"createSynchronousSimulation","name":"Simulate a loan arrangement for the given principal amount, term, payment frequency and interest rates","summary":"Simulate a loan arrangement for the given principal amount, term, payment frequency and interest rates","tags":[],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"customerIds":[{}],"properties":[{}],"overrides":[{}],"productId":"string","masterArrangementId":"string","roleName":"string","currencyId":"string","effectiveDate":"2024-01-01","activityId":"string","transactionAmount":0.0}},"responses":{"200":"createSynchronousSimulationResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"POST","path":"/product/loans/simulations/schedules","fullPath":"/api/v3.3.0/product/loans/simulations/schedules","operationId":"createSynchronousSimulationSchedules","name":"Simulate a loan arrangement for the given principal amount, term, payment frequency and interest rates. It also retrieves the details of payment schedules for the simulated contract","summary":"Simulate a loan arrangement and retrieve the payment schedule details","tags":[],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"customerIds":[{}],"properties":[{}],"overrides":[{}],"productId":"string","masterArrangementId":"string","roleName":"string","currencyId":"string","effectiveDate":"2024-01-01","activityId":"string","transactionAmount":0.0}},"responses":{"200":"createSynchronousSimulationSchedulesResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"GET","path":"/product/productTypes","fullPath":"/api/v3.3.0/product/productTypes","operationId":"getAllProductTypes","name":"Retrieves the list of product types available in the Transact system","summary":"Retrieves the list of product types available in the Transact system","tags":[],"parameters":[{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"AllProductTypesResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/product/productTypes/{productType}","fullPath":"/api/v3.3.0/product/productTypes/{productType}","operationId":"getProductType","name":"Retrieves the product type details for a given product type","summary":"Retrieves the product type details for a given product type","tags":[],"parameters":[{"name":"productType","in":"path","type":"string","required":true,"description":"Deprecated - Indicates the identifier(s) of a Blueprint product from which an actual product can be created"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"ProductTypeResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/product/productTypes/products/{productId}","fullPath":"/api/v3.3.0/product/productTypes/products/{productId}","operationId":"getProductStatus","name":"Retrieves the basic details such as product details,status,proof and publish errors if any","summary":"Retrieves the basic details of a given product","tags":[],"parameters":[{"name":"productId","in":"path","type":"string","required":true,"description":"Contains the unique identifier of the product, e.g. the product id of the arrangement account."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"ProductStatusResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"POST","path":"/product/productTypes/products/{productId}","fullPath":"/api/v3.3.0/product/productTypes/products/{productId}","operationId":"createProducts","name":"Create a product from a product type","summary":"Create a product using the conditions available from the product type","tags":[],"parameters":[{"name":"productId","in":"path","type":"string","required":true,"description":"Contains the unique identifier of the product, e.g. the product id of the arrangement account."},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"id":"string","status":"string","transactionStatus":"string","uniqueIdentifier":"string","audit":{"T24_time":{},"versionNumber":{},"requestParse_time":{},"responseParse_time":{}}},"body":{"productType":"string","productId":"string","productGroupId":"string","productLineId":"string","productName":"string","productDescription":"string","availableCurrency":[{}],"effectiveDate":"string","version":"string","productAttributes":[{}],"propertyList":[{}]}},"responses":{"200":"ProductsResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/product/productTypes/products/{productId}","fullPath":"/api/v3.3.0/product/productTypes/products/{productId}","operationId":"updateProducts","name":"Update a product such as property conditions and its condition values","summary":"Update a product such as property conditions and its condition values","tags":[],"parameters":[{"name":"productId","in":"path","type":"string","required":true,"description":"Contains the unique identifier of the product, e.g. the product id of the arrangement account."},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"id":"string","status":"string","transactionStatus":"string","uniqueIdentifier":"string","audit":{"T24_time":{},"versionNumber":{},"requestParse_time":{},"responseParse_time":{}}},"body":{"productType":"string","productId":"string","productGroupId":"string","productLineId":"string","productName":"string","productDescription":"string","availableCurrency":[{}],"effectiveDate":"string","version":"string","productAttributes":[{}],"propertyList":[{}]}},"responses":{"200":"ProductsResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/product/productFeatures/{productFeatureId}/attributes","fullPath":"/api/v3.3.0/product/productFeatures/{productFeatureId}/attributes","operationId":"getPropertyFields","name":"Retrieves the attribute and the field structure for the given product feature","summary":"Retrieves the attribute and the field structure","tags":[],"parameters":[{"name":"productFeatureId","in":"path","type":"string","required":true,"description":""},{"name":"productConditionId","in":"query","type":"string","required":false,"description":"The identifier of the product condition"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"PropertyFieldsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/product/productGroups/{productGroupId}/productFeatures/productConditions","fullPath":"/api/v3.3.0/product/productGroups/{productGroupId}/productFeatures/productConditions","operationId":"getProductLineFeatureConditions","name":"Retrieves the product conditions for the product features present in the product group","summary":"Retrieves the product conditions for the product features","tags":[],"parameters":[{"name":"productGroupId","in":"path","type":"string","required":true,"description":"The group, as defined by the institution, that the product belongs to."},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"ProductLineFeatureConditionsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/product/productConditions/{productConditionId}","fullPath":"/api/v3.3.0/product/productConditions/{productConditionId}","operationId":"getConditionGenerator","name":"Retrieves the base condition details of a product feature such as the attributes ,their field name and values,status and validation errors if any","summary":"Retrieves the base condition details of a product feature","tags":[],"parameters":[{"name":"productConditionId","in":"path","type":"string","required":true,"description":"The identifier of the product condition"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"ConditionGeneratorResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"POST","path":"/product/productConditions/{productConditionId}","fullPath":"/api/v3.3.0/product/productConditions/{productConditionId}","operationId":"createConditionGenerator","name":"Create the product condition for the product feature based on the attributes and their field name and values","summary":"Create the product condition for the product feature","tags":[],"parameters":[{"name":"productConditionId","in":"path","type":"string","required":true,"description":"The identifier of the product condition"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"propertyId":"string","conditionName":"string","effectiveDate":"string","currencies":[{}]}},"responses":{"200":"ConditionGeneratorResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/product/productConditions/{productConditionId}","fullPath":"/api/v3.3.0/product/productConditions/{productConditionId}","operationId":"updateConditionGenerator","name":"Update the product condition for the product feature based on the attributes and their field name and values","summary":"Update the product condition for the product feature","tags":[],"parameters":[{"name":"productConditionId","in":"path","type":"string","required":true,"description":"The identifier of the product condition"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"propertyId":"string","conditionName":"string","effectiveDate":"string","currencies":[{}]}},"responses":{"200":"ConditionGeneratorResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/product/productFeatures","fullPath":"/api/v3.3.0/product/productFeatures","operationId":"getProductLineFeatures","name":"Returns the list of product features, its currency type and supports base conditions or not","summary":"Returns the list of product features","tags":[],"parameters":[{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"FeatureTypesResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/product/{productId}/productConditions","fullPath":"/api/v3.3.0/product/{productId}/productConditions","operationId":"getProductCatalogue","name":"Retrieves the catalogued conditions of a given product","summary":"Retrieves the catalogued conditions of a given product","tags":["RETAIL"],"parameters":[{"name":"productId","in":"path","type":"string","required":true,"description":"Contains the unique identifier of the product, e.g. the product id of the arrangement account."},{"name":"currency","in":"query","type":"string","required":false,"description":"Identifies the currency. E.g. USD, GBP etc"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"ProductCatalogueResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"PUT","path":"/product/productManagers/{productId}","fullPath":"/api/v3.3.0/product/productManagers/{productId}","operationId":"updateProductManager","name":"Update the action such as proof and publish for the specific product","summary":"Update the action for product","tags":[],"parameters":[{"name":"productId","in":"path","type":"string","required":true,"description":"Contains the unique identifier of the product, e.g. the product id of the arrangement account."},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"displayName":"string","action":"string","availableDate":"2024-01-01","processMethod":"string"}},"responses":{"200":"ProductManagerResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/product/interestConditions","fullPath":"/api/v3.3.0/product/interestConditions","operationId":"getInterestConditionReference","name":"Retrieves all the available interest conditions","summary":"Retrieves all the available interest conditions","tags":[],"parameters":[{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"InterestConditionReferenceResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/product/products/{productId}/overpaymentRules","fullPath":"/api/v3.3.0/product/products/{productId}/overpaymentRules","operationId":"getProductOverpaymentDetails","name":"Fetch the overpayment rule details like type of overpay, overpay limit and period defined for a product. Overpayment is excess repayments done in addition to mandate payments.","summary":"To fetch the overpayment configurations done in a product","tags":["RETAIL"],"parameters":[{"name":"productId","in":"path","type":"string","required":true,"description":"Contains the unique identifier of the product, e.g. the product id of the arrangement account."},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"ProductOverpaymentDetailsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}}]},{"key":"product-products-v3.4.0","title":"Product Builder","version":"v3.4.0","description":"API to create, update and manage the product definition details, interest conditions, repayment calculator, simulate a loan contract and project the schedules","endpointCount":34,"endpoints":[{"method":"GET","path":"/product/productLines/{productLineId}/productGroups/{productGroupId}/products","fullPath":"/api/v3.4.0/product/productLines/{productLineId}/productGroups/{productGroupId}/products","operationId":"getProductsPerLineAndGroup","name":"Retrieves the details of all the products based on a given product line and product group","summary":"Retrieves the details of all the products based on a given product line and product group","tags":[],"parameters":[{"name":"productLineId","in":"path","type":"string","required":true,"description":"The top level product line, which the product is ultimately attached to. May be a Temenos-defined product line such as ACCOUNTS, AGENT, BUNDLE, CONSENT, DEPOSITS, LENDING, REWARDS, etc. or one defined"},{"name":"productGroupId","in":"path","type":"string","required":true,"description":"The group, as defined by the institution, that the product belongs to."},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"ProductsPerLineAndGroupResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/product/productLines/{productLineId}/productGroups","fullPath":"/api/v3.4.0/product/productLines/{productLineId}/productGroups","operationId":"getProductGroups","name":"Retrieves the details of all the products based on a given product line","summary":"Retrieves the details of all the products based on a given product line","tags":[],"parameters":[{"name":"productLineId","in":"path","type":"string","required":true,"description":"The top level product line, which the product is ultimately attached to. May be a Temenos-defined product line such as ACCOUNTS, AGENT, BUNDLE, CONSENT, DEPOSITS, LENDING, REWARDS, etc. or one defined"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"ProductGroupsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/product/productLines/{productLineId}/activities","fullPath":"/api/v3.4.0/product/productLines/{productLineId}/activities","operationId":"getProductLineActivities","name":"Retrieves the list of activities applicable for a given product line","summary":"Retrieves the list of activities applicable for a given product line","tags":[],"parameters":[{"name":"productLineId","in":"path","type":"string","required":true,"description":"The top level product line, which the product is ultimately attached to. May be a Temenos-defined product line such as ACCOUNTS, AGENT, BUNDLE, CONSENT, DEPOSITS, LENDING, REWARDS, etc. or one defined"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"ProductLineActivitiesResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/product/productLines","fullPath":"/api/v3.4.0/product/productLines","operationId":"getProductLines","name":"Retrieves the list of available product line","summary":"Retrieves the list of available product line","tags":[],"parameters":[{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"ProductLinesResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/product/products/{productId}","fullPath":"/api/v3.4.0/product/products/{productId}","operationId":"getProducts","name":"Retrieves the details of a given product","summary":"Retrieves the details of a given product","tags":[],"parameters":[{"name":"productId","in":"path","type":"string","required":true,"description":""},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"ProductsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/product/propertyClasses","fullPath":"/api/v3.4.0/product/propertyClasses","operationId":"getPropertyClasses","name":"Retrieves the product's property class information, which is used for building products","summary":"Retrieves the product's property class information, which is used for building products","tags":[],"parameters":[{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"PropertyClassesResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/product/productGroups","fullPath":"/api/v3.4.0/product/productGroups","operationId":"getAllProductGroups","name":"Retrieves the list of product group available with its product line","summary":"Retrieves the list of product group available with its product line","tags":[],"parameters":[{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"AllProductGroupsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/product/{productId}","fullPath":"/api/v3.4.0/product/{productId}","operationId":"getProductDetails","name":"Retrieves the product details for a catalogued product","summary":"Retrieves the product details for a catalogued product","tags":[],"parameters":[{"name":"productId","in":"path","type":"string","required":true,"description":"Contains the unique identifier of the product, e.g. the product id of the arrangement account."},{"name":"currency","in":"query","type":"string","required":false,"description":"Identifies the currency. E.g. USD, GBP etc"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"ProductDetailsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/product/productBuilder/interestConditions","fullPath":"/api/v3.4.0/product/productBuilder/interestConditions","operationId":"getAllInterestConditions","name":"Retrieves the list of all the available interest conditions","summary":"Retrieves the list of all the available interest conditions","tags":[],"parameters":[{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"AllInterestConditionsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/product/productBuilder/interestConditions/{interestConditionId}","fullPath":"/api/v3.4.0/product/productBuilder/interestConditions/{interestConditionId}","operationId":"getInterestConditions","name":"Retrieves the details of the given interest condition","summary":"Retrieves the details of the given interest condition","tags":[],"parameters":[{"name":"interestConditionId","in":"path","type":"string","required":true,"description":"The identifier of the product condition used to define the interest rate"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"InterestConditionsResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"POST","path":"/product/productBuilder/interestConditions/{interestConditionId}","fullPath":"/api/v3.4.0/product/productBuilder/interestConditions/{interestConditionId}","operationId":"createInterestCondition","name":"Creates a new interest condition","summary":"Creates a new interest condition","tags":[],"parameters":[{"name":"interestConditionId","in":"path","type":"string","required":true,"description":"The identifier of the product condition used to define the interest rate"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"rates":[{}],"displayNames":[{}],"rateTierType":"string","linkedArrangement":"string","defaultNegotiable":"string","accrualRule":"string"}},"responses":{"200":"InterestConditionResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/product/productBuilder/interestConditions/{interestConditionId}","fullPath":"/api/v3.4.0/product/productBuilder/interestConditions/{interestConditionId}","operationId":"updateInterestCondition","name":"Updates an existing interest condition","summary":"Updates an existing interest condition","tags":[],"parameters":[{"name":"interestConditionId","in":"path","type":"string","required":true,"description":"The identifier of the product condition used to define the interest rate"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"rates":[{}],"displayNames":[{}],"rateTierType":"string","linkedArrangement":"string","defaultNegotiable":"string","accrualRule":"string"}},"responses":{"200":"InterestConditionResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/product/productBuilder/productConditions","fullPath":"/api/v3.4.0/product/productBuilder/productConditions","operationId":"getProductConditions","name":"Retrieves the list of product conditions available","summary":"Retrieves the list of product conditions available","tags":[],"parameters":[{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"ProductConditionsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/product/productBuilder/properties","fullPath":"/api/v3.4.0/product/productBuilder/properties","operationId":"getProperties","name":"Retrieves the details of all the available properties","summary":"Retrieves the details of all the available properties","tags":[],"parameters":[{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"PropertiesResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/product/productBuilder/projects","fullPath":"/api/v3.4.0/product/productBuilder/projects","operationId":"getProjects","name":"Retrieves the list of available projects created to build a product","summary":"Retrieves the list of available projects created to build a product","tags":[],"parameters":[{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"ProjectsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/product/{productId}/commitment/{amount}/period/{term}","fullPath":"/api/v3.4.0/product/{productId}/commitment/{amount}/period/{term}","operationId":"getRepaymentCalculator","name":"Retrieves the repayment details for the given product, principal amount and term","summary":"Retrieves the repayment details for the given product, principal amount and term","tags":[],"parameters":[{"name":"productId","in":"path","type":"string","required":true,"description":"Contains the unique identifier of the product, e.g. the product id of the arrangement account."},{"name":"amount","in":"path","type":"string","required":true,"description":"This is the payment amount"},{"name":"term","in":"path","type":"string","required":true,"description":"Indicates the period to which the BID and OFFER rates apply"},{"name":"currencyId","in":"query","type":"string","required":false,"description":"Identifier of the currency. This is the 3-letter ISO 4217 code of the currency."},{"name":"paymentFrequency","in":"query","type":"string","required":false,"description":"The frequency at which a payment is required to be generated"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"RepaymentCalculatorResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"POST","path":"/product/loans/simulations","fullPath":"/api/v3.4.0/product/loans/simulations","operationId":"createSynchronousSimulation","name":"Simulate a loan arrangement for the given principal amount, term, payment frequency and interest rates","summary":"Simulate a loan arrangement for the given principal amount, term, payment frequency and interest rates","tags":[],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"customerIds":[{}],"properties":[{}],"overrides":[{}],"productId":"string","masterArrangementId":"string","roleName":"string","currencyId":"string","effectiveDate":"2024-01-01","activityId":"string","transactionAmount":0.0}},"responses":{"200":"createSynchronousSimulationResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"POST","path":"/product/loans/simulations/schedules","fullPath":"/api/v3.4.0/product/loans/simulations/schedules","operationId":"createSynchronousSimulationSchedules","name":"Simulate a loan arrangement for the given principal amount, term, payment frequency and interest rates. It also retrieves the details of payment schedules for the simulated contract","summary":"Simulate a loan arrangement and retrieve the payment schedule details","tags":[],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"customerIds":[{}],"properties":[{}],"overrides":[{}],"productId":"string","masterArrangementId":"string","roleName":"string","currencyId":"string","effectiveDate":"2024-01-01","activityId":"string","transactionAmount":0.0}},"responses":{"200":"createSynchronousSimulationSchedulesResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"GET","path":"/product/productTypes","fullPath":"/api/v3.4.0/product/productTypes","operationId":"getAllProductTypes","name":"Retrieves the list of product types available in the Transact system","summary":"Retrieves the list of product types available in the Transact system","tags":[],"parameters":[{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"AllProductTypesResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/product/productTypes/{productType}","fullPath":"/api/v3.4.0/product/productTypes/{productType}","operationId":"getProductType","name":"Retrieves the product type details for a given product type","summary":"Retrieves the product type details for a given product type","tags":[],"parameters":[{"name":"productType","in":"path","type":"string","required":true,"description":"Deprecated - Indicates the identifier(s) of a Blueprint product from which an actual product can be created"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"ProductTypeResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/product/productTypes/products/{productId}","fullPath":"/api/v3.4.0/product/productTypes/products/{productId}","operationId":"getProductStatus","name":"Retrieves the basic details such as product details,status,proof and publish errors if any","summary":"Retrieves the basic details of a given product","tags":[],"parameters":[{"name":"productId","in":"path","type":"string","required":true,"description":"Contains the unique identifier of the product, e.g. the product id of the arrangement account."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"ProductStatusResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"POST","path":"/product/productTypes/products/{productId}","fullPath":"/api/v3.4.0/product/productTypes/products/{productId}","operationId":"createProducts","name":"Create a product from a product type","summary":"Create a product using the conditions available from the product type","tags":[],"parameters":[{"name":"productId","in":"path","type":"string","required":true,"description":"Contains the unique identifier of the product, e.g. the product id of the arrangement account."},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"id":"string","status":"string","transactionStatus":"string","uniqueIdentifier":"string","audit":{"T24_time":{},"versionNumber":{},"requestParse_time":{},"responseParse_time":{}}},"body":{"productType":"string","productId":"string","productGroupId":"string","productLineId":"string","productName":"string","productDescription":"string","availableCurrency":[{}],"effectiveDate":"string","version":"string","productAttributes":[{}],"propertyList":[{}]}},"responses":{"200":"ProductsResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/product/productTypes/products/{productId}","fullPath":"/api/v3.4.0/product/productTypes/products/{productId}","operationId":"updateProducts","name":"Update a product such as property conditions and its condition values","summary":"Update a product such as property conditions and its condition values","tags":[],"parameters":[{"name":"productId","in":"path","type":"string","required":true,"description":"Contains the unique identifier of the product, e.g. the product id of the arrangement account."},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"id":"string","status":"string","transactionStatus":"string","uniqueIdentifier":"string","audit":{"T24_time":{},"versionNumber":{},"requestParse_time":{},"responseParse_time":{}}},"body":{"productType":"string","productId":"string","productGroupId":"string","productLineId":"string","productName":"string","productDescription":"string","availableCurrency":[{}],"effectiveDate":"string","version":"string","productAttributes":[{}],"propertyList":[{}]}},"responses":{"200":"ProductsResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/product/productFeatures/{productFeatureId}/attributes","fullPath":"/api/v3.4.0/product/productFeatures/{productFeatureId}/attributes","operationId":"getPropertyFields","name":"Retrieves the attribute and the field structure for the given product feature","summary":"Retrieves the attribute and the field structure","tags":[],"parameters":[{"name":"productFeatureId","in":"path","type":"string","required":true,"description":""},{"name":"productConditionId","in":"query","type":"string","required":false,"description":"The identifier of the product condition"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"PropertyFieldsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/product/productGroups/{productGroupId}/productFeatures/productConditions","fullPath":"/api/v3.4.0/product/productGroups/{productGroupId}/productFeatures/productConditions","operationId":"getProductLineFeatureConditions","name":"Retrieves the product conditions for the product features present in the product group","summary":"Retrieves the product conditions for the product features","tags":[],"parameters":[{"name":"productGroupId","in":"path","type":"string","required":true,"description":"The group, as defined by the institution, that the product belongs to."},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"ProductLineFeatureConditionsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/product/productConditions/{productConditionId}","fullPath":"/api/v3.4.0/product/productConditions/{productConditionId}","operationId":"getConditionGenerator","name":"Retrieves the base condition details of a product feature such as the attributes ,their field name and values,status and validation errors if any","summary":"Retrieves the base condition details of a product feature","tags":[],"parameters":[{"name":"productConditionId","in":"path","type":"string","required":true,"description":"The identifier of the product condition"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"ConditionGeneratorResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"POST","path":"/product/productConditions/{productConditionId}","fullPath":"/api/v3.4.0/product/productConditions/{productConditionId}","operationId":"createConditionGenerator","name":"Create the product condition for the product feature based on the attributes and their field name and values","summary":"Create the product condition for the product feature","tags":[],"parameters":[{"name":"productConditionId","in":"path","type":"string","required":true,"description":"The identifier of the product condition"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"propertyId":"string","conditionName":"string","effectiveDate":"string","currencies":[{}]}},"responses":{"200":"ConditionGeneratorResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/product/productConditions/{productConditionId}","fullPath":"/api/v3.4.0/product/productConditions/{productConditionId}","operationId":"updateConditionGenerator","name":"Update the product condition for the product feature based on the attributes and their field name and values","summary":"Update the product condition for the product feature","tags":[],"parameters":[{"name":"productConditionId","in":"path","type":"string","required":true,"description":"The identifier of the product condition"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"propertyId":"string","conditionName":"string","effectiveDate":"string","currencies":[{}]}},"responses":{"200":"ConditionGeneratorResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/product/productFeatures","fullPath":"/api/v3.4.0/product/productFeatures","operationId":"getProductLineFeatures","name":"Returns the list of product features, its currency type and supports base conditions or not","summary":"Returns the list of product features","tags":[],"parameters":[{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"FeatureTypesResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/product/{productId}/productConditions","fullPath":"/api/v3.4.0/product/{productId}/productConditions","operationId":"getProductCatalogue","name":"Retrieves the catalogued conditions of a given product","summary":"Retrieves the catalogued conditions of a given product","tags":["RETAIL"],"parameters":[{"name":"productId","in":"path","type":"string","required":true,"description":"Contains the unique identifier of the product, e.g. the product id of the arrangement account."},{"name":"currency","in":"query","type":"string","required":false,"description":"Identifies the currency. E.g. USD, GBP etc"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"ProductCatalogueResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"PUT","path":"/product/productManagers/{productId}","fullPath":"/api/v3.4.0/product/productManagers/{productId}","operationId":"updateProductManager","name":"Update the action such as proof and publish for the specific product","summary":"Update the action for product","tags":["RETAIL"],"parameters":[{"name":"productId","in":"path","type":"string","required":true,"description":"Contains the unique identifier of the product, e.g. the product id of the arrangement account."},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"displayName":"string","action":"string","availableDate":"2024-01-01","processingIndicator":"string","directPublish":"string","extensions":{}}},"responses":{"200":"ProductManagerResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/product/interestConditions","fullPath":"/api/v3.4.0/product/interestConditions","operationId":"getInterestConditionReference","name":"Retrieves all the available interest conditions","summary":"Retrieves all the available interest conditions","tags":[],"parameters":[{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"InterestConditionReferenceResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/product/products/{productId}/overpaymentRules","fullPath":"/api/v3.4.0/product/products/{productId}/overpaymentRules","operationId":"getProductOverpaymentDetails","name":"Fetch the overpayment rule details like type of overpay, overpay limit and period defined for a product. Overpayment is excess repayments done in addition to mandate payments.","summary":"To fetch the overpayment configurations done in a product","tags":["RETAIL"],"parameters":[{"name":"productId","in":"path","type":"string","required":true,"description":"Contains the unique identifier of the product, e.g. the product id of the arrangement account."},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"ProductOverpaymentDetailsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/product/products","fullPath":"/api/v3.4.0/product/products","operationId":"getAllProducts","name":"Retrieves all the products available in the catalogue","summary":"Retrieves all the products available in the catalogue","tags":["RETAIL"],"parameters":[{"name":"productLineId","in":"query","type":"string","required":false,"description":"The top level product line, which the product is ultimately attached to. May be a Temenos-defined product line such as ACCOUNTS, AGENT, BUNDLE, CONSENT, DEPOSITS, LENDING, REWARDS, etc. or one defined"},{"name":"productGroupId","in":"query","type":"string","required":false,"description":"The group, as defined by the institution, that the product belongs to."},{"name":"eligibilityFilter","in":"query","type":"string","required":false,"description":"Indicates the filter based on the Eligibility options available to the customer"},{"name":"multiBookEligible","in":"query","type":"string","required":false,"description":"Flag which indicates whether multi booking is applicable or not"},{"name":"productId","in":"query","type":"string","required":false,"description":"Contains the unique identifier of the product, e.g. the product id of the arrangement account."},{"name":"customerId","in":"query","type":"string","required":false,"description":"Identifier of the customer"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"AllProductsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}}]},{"key":"product-products-v3.5.0","title":"Product Builder","version":"v3.5.0","description":"API to create, update and manage the product definition details, interest conditions, repayment calculator, simulate a loan contract and project the schedules","endpointCount":35,"endpoints":[{"method":"GET","path":"/product/productLines/{productLineId}/productGroups/{productGroupId}/products","fullPath":"/api/v3.5.0/product/productLines/{productLineId}/productGroups/{productGroupId}/products","operationId":"getProductsPerLineAndGroup","name":"Retrieves the details of all the products based on a given product line and product group","summary":"Retrieves the details of all the products based on a given product line and product group","tags":[],"parameters":[{"name":"productLineId","in":"path","type":"string","required":true,"description":"The top level product line, which the product is ultimately attached to. May be a Temenos-defined product line such as ACCOUNTS, AGENT, BUNDLE, CONSENT, DEPOSITS, LENDING, REWARDS, etc. or one defined"},{"name":"productGroupId","in":"path","type":"string","required":true,"description":"The group, as defined by the institution, that the product belongs to."},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"ProductsPerLineAndGroupResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/product/productLines/{productLineId}/productGroups","fullPath":"/api/v3.5.0/product/productLines/{productLineId}/productGroups","operationId":"getProductGroups","name":"Retrieves the details of all the products based on a given product line","summary":"Retrieves the details of all the products based on a given product line","tags":[],"parameters":[{"name":"productLineId","in":"path","type":"string","required":true,"description":"The top level product line, which the product is ultimately attached to. May be a Temenos-defined product line such as ACCOUNTS, AGENT, BUNDLE, CONSENT, DEPOSITS, LENDING, REWARDS, etc. or one defined"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"ProductGroupsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/product/productLines/{productLineId}/activities","fullPath":"/api/v3.5.0/product/productLines/{productLineId}/activities","operationId":"getProductLineActivities","name":"Retrieves the list of activities applicable for a given product line","summary":"Retrieves the list of activities applicable for a given product line","tags":[],"parameters":[{"name":"productLineId","in":"path","type":"string","required":true,"description":"The top level product line, which the product is ultimately attached to. May be a Temenos-defined product line such as ACCOUNTS, AGENT, BUNDLE, CONSENT, DEPOSITS, LENDING, REWARDS, etc. or one defined"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"ProductLineActivitiesResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/product/productLines","fullPath":"/api/v3.5.0/product/productLines","operationId":"getProductLines","name":"Retrieves the list of available product line","summary":"Retrieves the list of available product line","tags":[],"parameters":[{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"ProductLinesResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/product/products","fullPath":"/api/v3.5.0/product/products","operationId":"getAllProducts","name":"Retrieves all the products available in the catalogue","summary":"Retrieves all the products available in the catalogue","tags":["RETAIL"],"parameters":[{"name":"productLineId","in":"query","type":"string","required":false,"description":"The top level product line, which the product is ultimately attached to. May be a Temenos-defined product line such as ACCOUNTS, AGENT, BUNDLE, CONSENT, DEPOSITS, LENDING, REWARDS, etc. or one defined"},{"name":"productGroupId","in":"query","type":"string","required":false,"description":"The group, as defined by the institution, that the product belongs to."},{"name":"eligibilityFilter","in":"query","type":"string","required":false,"description":"Indicates the filter based on the Eligibility options available to the customer"},{"name":"multiBookEligible","in":"query","type":"string","required":false,"description":"Flag which indicates whether multi booking is applicable or not"},{"name":"productId","in":"query","type":"string","required":false,"description":"Contains the unique identifier of the product, e.g. the product id of the arrangement account."},{"name":"customerId","in":"query","type":"string","required":false,"description":"Identifier of the customer"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"AllProductsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/product/products/{productId}","fullPath":"/api/v3.5.0/product/products/{productId}","operationId":"getProducts","name":"Retrieves the details of a given product","summary":"Retrieves the details of a given product","tags":[],"parameters":[{"name":"productId","in":"path","type":"string","required":true,"description":""},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"ProductsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/product/propertyClasses","fullPath":"/api/v3.5.0/product/propertyClasses","operationId":"getPropertyClasses","name":"Retrieves the product's property class information, which is used for building products","summary":"Retrieves the product's property class information, which is used for building products","tags":[],"parameters":[{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"PropertyClassesResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/product/productGroups","fullPath":"/api/v3.5.0/product/productGroups","operationId":"getAllProductGroups","name":"Retrieves the list of product group available with its product line","summary":"Retrieves the list of product group available with its product line","tags":[],"parameters":[{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"AllProductGroupsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/product/{productId}","fullPath":"/api/v3.5.0/product/{productId}","operationId":"getProductDetails","name":"Retrieves the product details for a catalogued product","summary":"Retrieves the product details for a catalogued product","tags":[],"parameters":[{"name":"productId","in":"path","type":"string","required":true,"description":"Contains the unique identifier of the product, e.g. the product id of the arrangement account."},{"name":"currency","in":"query","type":"string","required":false,"description":"Identifies the currency. E.g. USD, GBP etc"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"ProductDetailsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/product/productBuilder/interestConditions","fullPath":"/api/v3.5.0/product/productBuilder/interestConditions","operationId":"getAllInterestConditions","name":"Retrieves the list of all the available interest conditions","summary":"Retrieves the list of all the available interest conditions","tags":[],"parameters":[{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"AllInterestConditionsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/product/productBuilder/interestConditions/{interestConditionId}","fullPath":"/api/v3.5.0/product/productBuilder/interestConditions/{interestConditionId}","operationId":"getInterestConditions","name":"Retrieves the details of the given interest condition","summary":"Retrieves the details of the given interest condition","tags":[],"parameters":[{"name":"interestConditionId","in":"path","type":"string","required":true,"description":"The identifier of the product condition used to define the interest rate"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"InterestConditionsResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"POST","path":"/product/productBuilder/interestConditions/{interestConditionId}","fullPath":"/api/v3.5.0/product/productBuilder/interestConditions/{interestConditionId}","operationId":"createInterestCondition","name":"Creates a new interest condition","summary":"Creates a new interest condition","tags":[],"parameters":[{"name":"interestConditionId","in":"path","type":"string","required":true,"description":"The identifier of the product condition used to define the interest rate"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"rates":[{}],"displayNames":[{}],"rateTierType":"string","linkedArrangement":"string","defaultNegotiable":"string","accrualRule":"string"}},"responses":{"200":"InterestConditionResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/product/productBuilder/interestConditions/{interestConditionId}","fullPath":"/api/v3.5.0/product/productBuilder/interestConditions/{interestConditionId}","operationId":"updateInterestCondition","name":"Updates an existing interest condition","summary":"Updates an existing interest condition","tags":[],"parameters":[{"name":"interestConditionId","in":"path","type":"string","required":true,"description":"The identifier of the product condition used to define the interest rate"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"rates":[{}],"displayNames":[{}],"rateTierType":"string","linkedArrangement":"string","defaultNegotiable":"string","accrualRule":"string"}},"responses":{"200":"InterestConditionResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/product/productBuilder/productConditions","fullPath":"/api/v3.5.0/product/productBuilder/productConditions","operationId":"getProductConditions","name":"Retrieves the list of product conditions available","summary":"Retrieves the list of product conditions available","tags":[],"parameters":[{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"ProductConditionsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/product/productBuilder/properties","fullPath":"/api/v3.5.0/product/productBuilder/properties","operationId":"getProperties","name":"Retrieves the details of all the available properties","summary":"Retrieves the details of all the available properties","tags":[],"parameters":[{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"PropertiesResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/product/productBuilder/projects","fullPath":"/api/v3.5.0/product/productBuilder/projects","operationId":"getProjects","name":"Retrieves the list of available projects created to build a product","summary":"Retrieves the list of available projects created to build a product","tags":[],"parameters":[{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"ProjectsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/product/{productId}/commitment/{amount}/period/{term}","fullPath":"/api/v3.5.0/product/{productId}/commitment/{amount}/period/{term}","operationId":"getRepaymentCalculator","name":"Retrieves the repayment details for the given product, principal amount and term","summary":"Retrieves the repayment details for the given product, principal amount and term","tags":[],"parameters":[{"name":"productId","in":"path","type":"string","required":true,"description":"Contains the unique identifier of the product, e.g. the product id of the arrangement account."},{"name":"amount","in":"path","type":"string","required":true,"description":"This is the payment amount"},{"name":"term","in":"path","type":"string","required":true,"description":"Indicates the period to which the BID and OFFER rates apply"},{"name":"currencyId","in":"query","type":"string","required":false,"description":"Identifier of the currency. This is the 3-letter ISO 4217 code of the currency."},{"name":"paymentFrequency","in":"query","type":"string","required":false,"description":"The frequency at which a payment is required to be generated"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"RepaymentCalculatorResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"POST","path":"/product/loans/simulations","fullPath":"/api/v3.5.0/product/loans/simulations","operationId":"createSynchronousSimulation","name":"Simulate a loan arrangement for the given principal amount, term, payment frequency and interest rates","summary":"Simulate a loan arrangement for the given principal amount, term, payment frequency and interest rates","tags":[],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"customerIds":[{}],"properties":[{}],"overrides":[{}],"productId":"string","masterArrangementId":"string","roleName":"string","currencyId":"string","effectiveDate":"2024-01-01","activityId":"string","transactionAmount":0.0}},"responses":{"200":"createSynchronousSimulationResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"POST","path":"/product/loans/simulations/schedules","fullPath":"/api/v3.5.0/product/loans/simulations/schedules","operationId":"createSynchronousSimulationSchedules","name":"Simulate a loan arrangement for the given principal amount, term, payment frequency and interest rates. It also retrieves the details of payment schedules for the simulated contract","summary":"Simulate a loan arrangement and retrieve the payment schedule details","tags":[],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"customerIds":[{}],"properties":[{}],"overrides":[{}],"productId":"string","masterArrangementId":"string","roleName":"string","currencyId":"string","effectiveDate":"2024-01-01","activityId":"string","transactionAmount":0.0}},"responses":{"200":"createSynchronousSimulationSchedulesResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"GET","path":"/product/productTypes","fullPath":"/api/v3.5.0/product/productTypes","operationId":"getAllProductTypes","name":"Retrieves the list of product types available in the Transact system","summary":"Retrieves the list of product types available in the Transact system","tags":[],"parameters":[{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"AllProductTypesResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/product/productTypes/{productType}","fullPath":"/api/v3.5.0/product/productTypes/{productType}","operationId":"getProductType","name":"Retrieves the product type details for a given product type","summary":"Retrieves the product type details for a given product type","tags":[],"parameters":[{"name":"productType","in":"path","type":"string","required":true,"description":"Deprecated - Indicates the identifier(s) of a Blueprint product from which an actual product can be created"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"ProductTypeResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/product/productTypes/products/{productId}","fullPath":"/api/v3.5.0/product/productTypes/products/{productId}","operationId":"getProductStatus","name":"Retrieves the basic details such as product details,status,proof and publish errors if any","summary":"Retrieves the basic details of a given product","tags":[],"parameters":[{"name":"productId","in":"path","type":"string","required":true,"description":"Contains the unique identifier of the product, e.g. the product id of the arrangement account."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"ProductStatusResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"POST","path":"/product/productTypes/products/{productId}","fullPath":"/api/v3.5.0/product/productTypes/products/{productId}","operationId":"createProducts","name":"Create a product from a product type","summary":"Create a product using the conditions available from the product type","tags":[],"parameters":[{"name":"productId","in":"path","type":"string","required":true,"description":"Contains the unique identifier of the product, e.g. the product id of the arrangement account."},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"id":"string","status":"string","transactionStatus":"string","uniqueIdentifier":"string","audit":{"T24_time":{},"versionNumber":{},"requestParse_time":{},"responseParse_time":{}}},"body":{"productType":"string","productId":"string","productGroupId":"string","productLineId":"string","productName":"string","productDescription":"string","availableCurrency":[{}],"effectiveDate":"string","version":"string","productAttributes":[{}],"propertyList":[{}]}},"responses":{"200":"ProductsResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/product/productTypes/products/{productId}","fullPath":"/api/v3.5.0/product/productTypes/products/{productId}","operationId":"updateProducts","name":"Update a product such as property conditions and its condition values","summary":"Update a product such as property conditions and its condition values","tags":[],"parameters":[{"name":"productId","in":"path","type":"string","required":true,"description":"Contains the unique identifier of the product, e.g. the product id of the arrangement account."},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"id":"string","status":"string","transactionStatus":"string","uniqueIdentifier":"string","audit":{"T24_time":{},"versionNumber":{},"requestParse_time":{},"responseParse_time":{}}},"body":{"productType":"string","productId":"string","productGroupId":"string","productLineId":"string","productName":"string","productDescription":"string","availableCurrency":[{}],"effectiveDate":"string","version":"string","productAttributes":[{}],"propertyList":[{}]}},"responses":{"200":"ProductsResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/product/productFeatures/{productFeatureId}/attributes","fullPath":"/api/v3.5.0/product/productFeatures/{productFeatureId}/attributes","operationId":"getPropertyFields","name":"Retrieves the attribute and the field structure for the given product feature","summary":"Retrieves the attribute and the field structure","tags":[],"parameters":[{"name":"productFeatureId","in":"path","type":"string","required":true,"description":""},{"name":"productConditionId","in":"query","type":"string","required":false,"description":"The identifier of the product condition"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"PropertyFieldsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/product/productGroups/{productGroupId}/productFeatures/productConditions","fullPath":"/api/v3.5.0/product/productGroups/{productGroupId}/productFeatures/productConditions","operationId":"getProductLineFeatureConditions","name":"Retrieves the product conditions for the product features present in the product group","summary":"Retrieves the product conditions for the product features","tags":[],"parameters":[{"name":"productGroupId","in":"path","type":"string","required":true,"description":"The group, as defined by the institution, that the product belongs to."},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"ProductLineFeatureConditionsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/product/productConditions/{productConditionId}","fullPath":"/api/v3.5.0/product/productConditions/{productConditionId}","operationId":"getConditionGenerator","name":"Retrieves the base condition details of a product feature such as the attributes ,their field name and values,status and validation errors if any","summary":"Retrieves the base condition details of a product feature","tags":[],"parameters":[{"name":"productConditionId","in":"path","type":"string","required":true,"description":"The identifier of the product condition"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"ConditionGeneratorResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"POST","path":"/product/productConditions/{productConditionId}","fullPath":"/api/v3.5.0/product/productConditions/{productConditionId}","operationId":"createConditionGenerator","name":"Create the product condition for the product feature based on the attributes and their field name and values","summary":"Create the product condition for the product feature","tags":[],"parameters":[{"name":"productConditionId","in":"path","type":"string","required":true,"description":"The identifier of the product condition"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"propertyId":"string","conditionName":"string","effectiveDate":"string","currencies":[{}]}},"responses":{"200":"ConditionGeneratorResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/product/productConditions/{productConditionId}","fullPath":"/api/v3.5.0/product/productConditions/{productConditionId}","operationId":"updateConditionGenerator","name":"Update the product condition for the product feature based on the attributes and their field name and values","summary":"Update the product condition for the product feature","tags":[],"parameters":[{"name":"productConditionId","in":"path","type":"string","required":true,"description":"The identifier of the product condition"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"propertyId":"string","conditionName":"string","effectiveDate":"string","currencies":[{}]}},"responses":{"200":"ConditionGeneratorResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/product/productFeatures","fullPath":"/api/v3.5.0/product/productFeatures","operationId":"getProductLineFeatures","name":"Returns the list of product features, its currency type and supports base conditions or not","summary":"Returns the list of product features","tags":[],"parameters":[{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"FeatureTypesResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/product/{productId}/productConditions","fullPath":"/api/v3.5.0/product/{productId}/productConditions","operationId":"getProductCatalogue","name":"Retrieves the catalogued conditions of a given product","summary":"Retrieves the catalogued conditions of a given product","tags":["RETAIL"],"parameters":[{"name":"productId","in":"path","type":"string","required":true,"description":"Contains the unique identifier of the product, e.g. the product id of the arrangement account."},{"name":"currency","in":"query","type":"string","required":false,"description":"Identifies the currency. E.g. USD, GBP etc"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"ProductCatalogueResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"PUT","path":"/product/productManagers/{productId}","fullPath":"/api/v3.5.0/product/productManagers/{productId}","operationId":"updateProductManager","name":"Update the action such as proof and publish for the specific product","summary":"Update the action for product","tags":["RETAIL"],"parameters":[{"name":"productId","in":"path","type":"string","required":true,"description":"Contains the unique identifier of the product, e.g. the product id of the arrangement account."},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"displayName":"string","action":"string","availableDate":"2024-01-01","processingIndicator":"string","directPublish":"string","extensions":{}}},"responses":{"200":"ProductManagerResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/product/interestConditions","fullPath":"/api/v3.5.0/product/interestConditions","operationId":"getInterestConditionReference","name":"Retrieves all the available interest conditions","summary":"Retrieves all the available interest conditions","tags":[],"parameters":[{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"InterestConditionReferenceResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/product/products/{productId}/overpaymentRules","fullPath":"/api/v3.5.0/product/products/{productId}/overpaymentRules","operationId":"getProductOverpaymentDetails","name":"Fetch the overpayment rule details like type of overpay, overpay limit and period defined for a product. Overpayment is excess repayments done in addition to mandate payments.","summary":"To fetch the overpayment configurations done in a product","tags":["RETAIL"],"parameters":[{"name":"productId","in":"path","type":"string","required":true,"description":"Contains the unique identifier of the product, e.g. the product id of the arrangement account."},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"ProductOverpaymentDetailsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/product/products/buyNowPayLater","fullPath":"/api/v3.5.0/product/products/buyNowPayLater","operationId":"getLoanSimulation","name":"Qualifies and simulates the applicable buy now pay later products for the given amount and currency value and provides the product wise installments simulation results.","summary":"Qualifies the eligible buy now pay later products and perform simulation for the products","tags":["Loan Simulation"],"parameters":[{"name":"currencyId","in":"query","type":"string","required":false,"description":"Identifier of the currency. This is the 3-letter ISO 4217 code of the currency."},{"name":"loanAmount","in":"query","type":"integer","required":false,"description":"Indicates loan amount"},{"name":"productType","in":"query","type":"string","required":false,"description":"Indicates the product type for the deal"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"BnplLoanSimulationResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}}]},{"key":"product-products-v3.6.0","title":"Product Builder","version":"v3.6.0","description":"API to create, update and manage the product definition details, interest conditions, repayment calculator, simulate a loan contract and project the schedules","endpointCount":35,"endpoints":[{"method":"GET","path":"/product/productLines/{productLineId}/productGroups/{productGroupId}/products","fullPath":"/api/v3.6.0/product/productLines/{productLineId}/productGroups/{productGroupId}/products","operationId":"getProductsPerLineAndGroup","name":"Retrieves the details of all the products based on a given product line and product group","summary":"Retrieves the details of all the products based on a given product line and product group","tags":[],"parameters":[{"name":"productLineId","in":"path","type":"string","required":true,"description":"The top level product line, which the product is ultimately attached to. May be a Temenos-defined product line such as ACCOUNTS, AGENT, BUNDLE, CONSENT, DEPOSITS, LENDING, REWARDS, etc. or one defined"},{"name":"productGroupId","in":"path","type":"string","required":true,"description":"The group, as defined by the institution, that the product belongs to."},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"ProductsPerLineAndGroupResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/product/productLines/{productLineId}/productGroups","fullPath":"/api/v3.6.0/product/productLines/{productLineId}/productGroups","operationId":"getProductGroups","name":"Retrieves the details of all the products based on a given product line","summary":"Retrieves the details of all the products based on a given product line","tags":[],"parameters":[{"name":"productLineId","in":"path","type":"string","required":true,"description":"The top level product line, which the product is ultimately attached to. May be a Temenos-defined product line such as ACCOUNTS, AGENT, BUNDLE, CONSENT, DEPOSITS, LENDING, REWARDS, etc. or one defined"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"ProductGroupsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/product/productLines/{productLineId}/activities","fullPath":"/api/v3.6.0/product/productLines/{productLineId}/activities","operationId":"getProductLineActivities","name":"Retrieves the list of activities applicable for a given product line","summary":"Retrieves the list of activities applicable for a given product line","tags":[],"parameters":[{"name":"productLineId","in":"path","type":"string","required":true,"description":"The top level product line, which the product is ultimately attached to. May be a Temenos-defined product line such as ACCOUNTS, AGENT, BUNDLE, CONSENT, DEPOSITS, LENDING, REWARDS, etc. or one defined"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"ProductLineActivitiesResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/product/productLines","fullPath":"/api/v3.6.0/product/productLines","operationId":"getProductLines","name":"Retrieves the list of available product line","summary":"Retrieves the list of available product line","tags":[],"parameters":[{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"ProductLinesResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/product/products","fullPath":"/api/v3.6.0/product/products","operationId":"getAllProducts","name":"Retrieves all the products available in the catalogue","summary":"Retrieves all the products available in the catalogue","tags":["RETAIL"],"parameters":[{"name":"productLineId","in":"query","type":"string","required":false,"description":"The top level product line, which the product is ultimately attached to. May be a Temenos-defined product line such as ACCOUNTS, AGENT, BUNDLE, CONSENT, DEPOSITS, LENDING, REWARDS, etc. or one defined"},{"name":"productGroupId","in":"query","type":"string","required":false,"description":"The group, as defined by the institution, that the product belongs to."},{"name":"eligibilityFilter","in":"query","type":"string","required":false,"description":"Indicates the filter based on the Eligibility options available to the customer"},{"name":"multiBookEligible","in":"query","type":"string","required":false,"description":"Flag which indicates whether multi booking is applicable or not"},{"name":"productId","in":"query","type":"string","required":false,"description":"Contains the unique identifier of the product, e.g. the product id of the arrangement account."},{"name":"customerId","in":"query","type":"string","required":false,"description":"Identifier of the customer"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"AllProductsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/product/products/{productId}","fullPath":"/api/v3.6.0/product/products/{productId}","operationId":"getProducts","name":"Retrieves the details of a given product","summary":"Retrieves the details of a given product","tags":[],"parameters":[{"name":"productId","in":"path","type":"string","required":true,"description":""},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"ProductsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/product/propertyClasses","fullPath":"/api/v3.6.0/product/propertyClasses","operationId":"getPropertyClasses","name":"Retrieves the product's property class information, which is used for building products","summary":"Retrieves the product's property class information, which is used for building products","tags":[],"parameters":[{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"PropertyClassesResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/product/productGroups","fullPath":"/api/v3.6.0/product/productGroups","operationId":"getAllProductGroups","name":"Retrieves the list of product group available with its product line","summary":"Retrieves the list of product group available with its product line","tags":[],"parameters":[{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"AllProductGroupsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/product/{productId}","fullPath":"/api/v3.6.0/product/{productId}","operationId":"getProductDetails","name":"Retrieves the product details for a catalogued product","summary":"Retrieves the product details for a catalogued product","tags":[],"parameters":[{"name":"productId","in":"path","type":"string","required":true,"description":"Contains the unique identifier of the product, e.g. the product id of the arrangement account."},{"name":"currency","in":"query","type":"string","required":false,"description":"Identifies the currency. E.g. USD, GBP etc"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"ProductDetailsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/product/productBuilder/interestConditions","fullPath":"/api/v3.6.0/product/productBuilder/interestConditions","operationId":"getAllInterestConditions","name":"Retrieves the list of all the available interest conditions","summary":"Retrieves the list of all the available interest conditions","tags":[],"parameters":[{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"AllInterestConditionsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/product/productBuilder/interestConditions/{interestConditionId}","fullPath":"/api/v3.6.0/product/productBuilder/interestConditions/{interestConditionId}","operationId":"getInterestConditions","name":"Retrieves the details of the given interest condition","summary":"Retrieves the details of the given interest condition","tags":[],"parameters":[{"name":"interestConditionId","in":"path","type":"string","required":true,"description":"The identifier of the product condition used to define the interest rate"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"InterestConditionsResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"POST","path":"/product/productBuilder/interestConditions/{interestConditionId}","fullPath":"/api/v3.6.0/product/productBuilder/interestConditions/{interestConditionId}","operationId":"createInterestCondition","name":"Creates a new interest condition","summary":"Creates a new interest condition","tags":[],"parameters":[{"name":"interestConditionId","in":"path","type":"string","required":true,"description":"The identifier of the product condition used to define the interest rate"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"rates":[{}],"displayNames":[{}],"rateTierType":"string","linkedArrangement":"string","defaultNegotiable":"string","accrualRule":"string"}},"responses":{"200":"InterestConditionResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/product/productBuilder/interestConditions/{interestConditionId}","fullPath":"/api/v3.6.0/product/productBuilder/interestConditions/{interestConditionId}","operationId":"updateInterestCondition","name":"Updates an existing interest condition","summary":"Updates an existing interest condition","tags":[],"parameters":[{"name":"interestConditionId","in":"path","type":"string","required":true,"description":"The identifier of the product condition used to define the interest rate"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"rates":[{}],"displayNames":[{}],"rateTierType":"string","linkedArrangement":"string","defaultNegotiable":"string","accrualRule":"string"}},"responses":{"200":"InterestConditionResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/product/productBuilder/productConditions","fullPath":"/api/v3.6.0/product/productBuilder/productConditions","operationId":"getProductConditions","name":"Retrieves the list of product conditions available","summary":"Retrieves the list of product conditions available","tags":[],"parameters":[{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"ProductConditionsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/product/productBuilder/properties","fullPath":"/api/v3.6.0/product/productBuilder/properties","operationId":"getProperties","name":"Retrieves the details of all the available properties","summary":"Retrieves the details of all the available properties","tags":[],"parameters":[{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"PropertiesResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/product/productBuilder/projects","fullPath":"/api/v3.6.0/product/productBuilder/projects","operationId":"getProjects","name":"Retrieves the list of available projects created to build a product","summary":"Retrieves the list of available projects created to build a product","tags":[],"parameters":[{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"ProjectsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"POST","path":"/product/loans/simulations","fullPath":"/api/v3.6.0/product/loans/simulations","operationId":"createSynchronousSimulation","name":"Simulate a loan arrangement for the given principal amount, term, payment frequency and interest rates","summary":"Simulate a loan arrangement for the given principal amount, term, payment frequency and interest rates","tags":[],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"customerIds":[{}],"properties":[{}],"overrides":[{}],"productId":"string","masterArrangementId":"string","roleName":"string","currencyId":"string","effectiveDate":"2024-01-01","activityId":"string","transactionAmount":0.0}},"responses":{"200":"createSynchronousSimulationResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"POST","path":"/product/loans/simulations/schedules","fullPath":"/api/v3.6.0/product/loans/simulations/schedules","operationId":"createSynchronousSimulationSchedules","name":"Simulate a loan arrangement for the given principal amount, term, payment frequency and interest rates. It also retrieves the details of payment schedules for the simulated contract","summary":"Simulate a loan arrangement and retrieve the payment schedule details","tags":[],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"customerIds":[{}],"properties":[{}],"overrides":[{}],"productId":"string","masterArrangementId":"string","roleName":"string","currencyId":"string","effectiveDate":"2024-01-01","activityId":"string","transactionAmount":0.0}},"responses":{"200":"createSynchronousSimulationSchedulesResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"GET","path":"/product/productTypes","fullPath":"/api/v3.6.0/product/productTypes","operationId":"getAllProductTypes","name":"Retrieves the list of product types available in the Transact system","summary":"Retrieves the list of product types available in the Transact system","tags":[],"parameters":[{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"AllProductTypesResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/product/productTypes/{productType}","fullPath":"/api/v3.6.0/product/productTypes/{productType}","operationId":"getProductType","name":"Retrieves the product type details for a given product type","summary":"Retrieves the product type details for a given product type","tags":[],"parameters":[{"name":"productType","in":"path","type":"string","required":true,"description":"Deprecated - Indicates the identifier(s) of a Blueprint product from which an actual product can be created"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"ProductTypeResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/product/productTypes/products/{productId}","fullPath":"/api/v3.6.0/product/productTypes/products/{productId}","operationId":"getProductStatus","name":"Retrieves the basic details such as product details,status,proof and publish errors if any","summary":"Retrieves the basic details of a given product","tags":[],"parameters":[{"name":"productId","in":"path","type":"string","required":true,"description":"Contains the unique identifier of the product, e.g. the product id of the arrangement account."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"ProductStatusResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"POST","path":"/product/productTypes/products/{productId}","fullPath":"/api/v3.6.0/product/productTypes/products/{productId}","operationId":"createProducts","name":"Create a product from a product type","summary":"Create a product using the conditions available from the product type","tags":[],"parameters":[{"name":"productId","in":"path","type":"string","required":true,"description":"Contains the unique identifier of the product, e.g. the product id of the arrangement account."},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"id":"string","status":"string","transactionStatus":"string","uniqueIdentifier":"string","audit":{"T24_time":{},"versionNumber":{},"requestParse_time":{},"responseParse_time":{}}},"body":{"productType":"string","productId":"string","productGroupId":"string","productLineId":"string","productName":"string","productDescription":"string","availableCurrency":[{}],"effectiveDate":"string","version":"string","productAttributes":[{}],"propertyList":[{}]}},"responses":{"200":"ProductsResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/product/productTypes/products/{productId}","fullPath":"/api/v3.6.0/product/productTypes/products/{productId}","operationId":"updateProducts","name":"Update a product such as property conditions and its condition values","summary":"Update a product such as property conditions and its condition values","tags":[],"parameters":[{"name":"productId","in":"path","type":"string","required":true,"description":"Contains the unique identifier of the product, e.g. the product id of the arrangement account."},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"id":"string","status":"string","transactionStatus":"string","uniqueIdentifier":"string","audit":{"T24_time":{},"versionNumber":{},"requestParse_time":{},"responseParse_time":{}}},"body":{"productType":"string","productId":"string","productGroupId":"string","productLineId":"string","productName":"string","productDescription":"string","availableCurrency":[{}],"effectiveDate":"string","version":"string","productAttributes":[{}],"propertyList":[{}]}},"responses":{"200":"ProductsResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/product/productFeatures/{productFeatureId}/attributes","fullPath":"/api/v3.6.0/product/productFeatures/{productFeatureId}/attributes","operationId":"getPropertyFields","name":"Retrieves the attribute and the field structure for the given product feature","summary":"Retrieves the attribute and the field structure","tags":[],"parameters":[{"name":"productFeatureId","in":"path","type":"string","required":true,"description":""},{"name":"productConditionId","in":"query","type":"string","required":false,"description":"The identifier of the product condition"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"PropertyFieldsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/product/productGroups/{productGroupId}/productFeatures/productConditions","fullPath":"/api/v3.6.0/product/productGroups/{productGroupId}/productFeatures/productConditions","operationId":"getProductLineFeatureConditions","name":"Retrieves the product conditions for the product features present in the product group","summary":"Retrieves the product conditions for the product features","tags":[],"parameters":[{"name":"productGroupId","in":"path","type":"string","required":true,"description":"The group, as defined by the institution, that the product belongs to."},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"ProductLineFeatureConditionsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/product/productConditions/{productConditionId}","fullPath":"/api/v3.6.0/product/productConditions/{productConditionId}","operationId":"getConditionGenerator","name":"Retrieves the base condition details of a product feature such as the attributes ,their field name and values,status and validation errors if any","summary":"Retrieves the base condition details of a product feature","tags":[],"parameters":[{"name":"productConditionId","in":"path","type":"string","required":true,"description":"The identifier of the product condition"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"ConditionGeneratorResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"POST","path":"/product/productConditions/{productConditionId}","fullPath":"/api/v3.6.0/product/productConditions/{productConditionId}","operationId":"createConditionGenerator","name":"Create the product condition for the product feature based on the attributes and their field name and values","summary":"Create the product condition for the product feature","tags":[],"parameters":[{"name":"productConditionId","in":"path","type":"string","required":true,"description":"The identifier of the product condition"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"propertyId":"string","conditionName":"string","effectiveDate":"string","currencies":[{}]}},"responses":{"200":"ConditionGeneratorResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/product/productConditions/{productConditionId}","fullPath":"/api/v3.6.0/product/productConditions/{productConditionId}","operationId":"updateConditionGenerator","name":"Update the product condition for the product feature based on the attributes and their field name and values","summary":"Update the product condition for the product feature","tags":[],"parameters":[{"name":"productConditionId","in":"path","type":"string","required":true,"description":"The identifier of the product condition"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"propertyId":"string","conditionName":"string","effectiveDate":"string","currencies":[{}]}},"responses":{"200":"ConditionGeneratorResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/product/productFeatures","fullPath":"/api/v3.6.0/product/productFeatures","operationId":"getProductLineFeatures","name":"Returns the list of product features, its currency type and supports base conditions or not","summary":"Returns the list of product features","tags":[],"parameters":[{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"FeatureTypesResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/product/{productId}/productConditions","fullPath":"/api/v3.6.0/product/{productId}/productConditions","operationId":"getProductCatalogue","name":"Retrieves the catalogued conditions of a given product","summary":"Retrieves the catalogued conditions of a given product","tags":["RETAIL"],"parameters":[{"name":"productId","in":"path","type":"string","required":true,"description":"Contains the unique identifier of the product, e.g. the product id of the arrangement account."},{"name":"currency","in":"query","type":"string","required":false,"description":"Identifies the currency. E.g. USD, GBP etc"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"ProductCatalogueResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"PUT","path":"/product/productManagers/{productId}","fullPath":"/api/v3.6.0/product/productManagers/{productId}","operationId":"updateProductManager","name":"Update the action such as proof and publish for the specific product","summary":"Update the action for product","tags":["RETAIL"],"parameters":[{"name":"productId","in":"path","type":"string","required":true,"description":"Contains the unique identifier of the product, e.g. the product id of the arrangement account."},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"displayName":"string","action":"string","availableDate":"2024-01-01","processingIndicator":"string","directPublish":"string","extensions":{}}},"responses":{"200":"ProductManagerResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/product/interestConditions","fullPath":"/api/v3.6.0/product/interestConditions","operationId":"getInterestConditionReference","name":"Retrieves all the available interest conditions","summary":"Retrieves all the available interest conditions","tags":[],"parameters":[{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"InterestConditionReferenceResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/product/products/{productId}/overpaymentRules","fullPath":"/api/v3.6.0/product/products/{productId}/overpaymentRules","operationId":"getProductOverpaymentDetails","name":"Retrieves the overpayment rule details like type of overpay, overpay limit and period defined for a product. Overpayment is excess repayments done in addition to mandate payments.","summary":"Retrieves the overpayment configurations done in a product","tags":["RETAIL"],"parameters":[{"name":"productId","in":"path","type":"string","required":true,"description":"Contains the unique identifier of the product, e.g. the product id of the arrangement account."},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"ProductOverpaymentDetailsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/product/products/buyNowPayLater","fullPath":"/api/v3.6.0/product/products/buyNowPayLater","operationId":"getLoanSimulation","name":"Qualifies and simulates the applicable buy now pay later products for the given amount and currency value and provides the product wise installments simulation results.","summary":"Qualifies the eligible buy now pay later products and perform simulation for the products","tags":["Loan Simulation"],"parameters":[{"name":"currencyId","in":"query","type":"string","required":false,"description":"Identifier of the currency. This is the 3-letter ISO 4217 code of the currency."},{"name":"loanAmount","in":"query","type":"integer","required":false,"description":"Indicates loan amount"},{"name":"productType","in":"query","type":"string","required":false,"description":"Indicates the product type for the deal"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"BnplLoanSimulationResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/product/{productId}/commitment/{amount}/period/{term}","fullPath":"/api/v3.6.0/product/{productId}/commitment/{amount}/period/{term}","operationId":"getRepaymentCalculator","name":"Retrieves the repayment details for the given product, principal amount and term","summary":"Retrieves the repayment details for the given product, principal amount and term","tags":[],"parameters":[{"name":"productId","in":"path","type":"string","required":true,"description":"Contains the unique identifier of the product, e.g. the product id of the arrangement account."},{"name":"amount","in":"path","type":"string","required":true,"description":"This is the payment amount"},{"name":"term","in":"path","type":"string","required":true,"description":"Indicates the period to which the BID and OFFER rates apply"},{"name":"currencyId","in":"query","type":"string","required":false,"description":"Identifier of the currency. This is the 3-letter ISO 4217 code of the currency."},{"name":"paymentFrequency","in":"query","type":"string","required":false,"description":"The frequency at which a payment is required to be generated"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"RepaymentCalculatorResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}}]},{"key":"product-products-v3.7.0","title":"Product Builder","version":"v3.7.0","description":"API to create, update and manage the product definition details, interest conditions, repayment calculator, simulate a loan contract and project the schedules","endpointCount":35,"endpoints":[{"method":"GET","path":"/product/productLines/{productLineId}/productGroups/{productGroupId}/products","fullPath":"/api/v3.7.0/product/productLines/{productLineId}/productGroups/{productGroupId}/products","operationId":"getProductsPerLineAndGroup","name":"Retrieves the details of all the products based on a given product line and product group","summary":"Retrieves the details of all the products based on a given product line and product group","tags":["RETAIL"],"parameters":[{"name":"productLineId","in":"path","type":"string","required":true,"description":"The top level product line, which the product is ultimately attached to. May be a Temenos-defined product line such as ACCOUNTS, AGENT, BUNDLE, CONSENT, DEPOSITS, LENDING, REWARDS, etc. or one defined"},{"name":"productGroupId","in":"path","type":"string","required":true,"description":"The group, as defined by the institution, that the product belongs to."},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"ProductsPerLineAndGroupResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/product/productLines/{productLineId}/productGroups","fullPath":"/api/v3.7.0/product/productLines/{productLineId}/productGroups","operationId":"getProductGroups","name":"Retrieves the details of all the products based on a given product line","summary":"Retrieves the details of all the products based on a given product line","tags":["RETAIL"],"parameters":[{"name":"productLineId","in":"path","type":"string","required":true,"description":"The top level product line, which the product is ultimately attached to. May be a Temenos-defined product line such as ACCOUNTS, AGENT, BUNDLE, CONSENT, DEPOSITS, LENDING, REWARDS, etc. or one defined"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"ProductGroupsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/product/productLines/{productLineId}/activities","fullPath":"/api/v3.7.0/product/productLines/{productLineId}/activities","operationId":"getProductLineActivities","name":"Retrieves the list of activities applicable for a given product line","summary":"Retrieves the list of activities applicable for a given product line","tags":["RETAIL"],"parameters":[{"name":"productLineId","in":"path","type":"string","required":true,"description":"The top level product line, which the product is ultimately attached to. May be a Temenos-defined product line such as ACCOUNTS, AGENT, BUNDLE, CONSENT, DEPOSITS, LENDING, REWARDS, etc. or one defined"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"ProductLineActivitiesResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/product/productLines","fullPath":"/api/v3.7.0/product/productLines","operationId":"getProductLines","name":"Retrieves the list of available product line","summary":"Retrieves the list of available product line","tags":["RETAIL"],"parameters":[{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"ProductLinesResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/product/products","fullPath":"/api/v3.7.0/product/products","operationId":"getAllProducts","name":"Retrieves all the products available in the catalogue","summary":"Retrieves all the products available in the catalogue","tags":["RETAIL"],"parameters":[{"name":"productLineId","in":"query","type":"string","required":false,"description":"The top level product line, which the product is ultimately attached to. May be a Temenos-defined product line such as ACCOUNTS, AGENT, BUNDLE, CONSENT, DEPOSITS, LENDING, REWARDS, etc. or one defined"},{"name":"productGroupId","in":"query","type":"string","required":false,"description":"The group, as defined by the institution, that the product belongs to."},{"name":"eligibilityFilter","in":"query","type":"string","required":false,"description":"Indicates the filter based on the Eligibility options available to the customer"},{"name":"multiBookEligible","in":"query","type":"string","required":false,"description":"Flag which indicates whether multi booking is applicable or not"},{"name":"productId","in":"query","type":"string","required":false,"description":"Contains the unique identifier of the product, e.g. the product id of the arrangement account."},{"name":"customerId","in":"query","type":"string","required":false,"description":"Identifier of the customer"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"AllProductsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/product/products/{productId}","fullPath":"/api/v3.7.0/product/products/{productId}","operationId":"getProducts","name":"Retrieves the details of a given product","summary":"Retrieves the details of a given product","tags":["RETAIL"],"parameters":[{"name":"productId","in":"path","type":"string","required":true,"description":""},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"ProductsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/product/propertyClasses","fullPath":"/api/v3.7.0/product/propertyClasses","operationId":"getPropertyClasses","name":"Retrieves the product's property class information, which is used for building products","summary":"Retrieves the product's property class information, which is used for building products","tags":["RETAIL"],"parameters":[{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"PropertyClassesResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/product/productGroups","fullPath":"/api/v3.7.0/product/productGroups","operationId":"getAllProductGroups","name":"Retrieves the list of product group available with its product line","summary":"Retrieves the list of product group available with its product line","tags":["RETAIL"],"parameters":[{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"AllProductGroupsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/product/{productId}","fullPath":"/api/v3.7.0/product/{productId}","operationId":"getProductDetails","name":"Retrieves the product details for a catalogued product","summary":"Retrieves the product details for a catalogued product","tags":["RETAIL"],"parameters":[{"name":"productId","in":"path","type":"string","required":true,"description":"Contains the unique identifier of the product, e.g. the product id of the arrangement account."},{"name":"currency","in":"query","type":"string","required":false,"description":"Identifies the currency. E.g. USD, GBP etc"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"ProductDetailsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/product/productBuilder/interestConditions","fullPath":"/api/v3.7.0/product/productBuilder/interestConditions","operationId":"getAllInterestConditions","name":"Retrieves the list of all the available interest conditions","summary":"Retrieves the list of all the available interest conditions","tags":["RETAIL"],"parameters":[{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"AllInterestConditionsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/product/productBuilder/interestConditions/{interestConditionId}","fullPath":"/api/v3.7.0/product/productBuilder/interestConditions/{interestConditionId}","operationId":"getInterestConditions","name":"Retrieves the details of the given interest condition","summary":"Retrieves the details of the given interest condition","tags":["RETAIL"],"parameters":[{"name":"interestConditionId","in":"path","type":"string","required":true,"description":"The identifier of the product condition used to define the interest rate"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"InterestConditionsResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"POST","path":"/product/productBuilder/interestConditions/{interestConditionId}","fullPath":"/api/v3.7.0/product/productBuilder/interestConditions/{interestConditionId}","operationId":"createInterestCondition","name":"Creates a new interest condition","summary":"Creates a new interest condition","tags":["RETAIL"],"parameters":[{"name":"interestConditionId","in":"path","type":"string","required":true,"description":"The identifier of the product condition used to define the interest rate"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"rates":[{}],"displayNames":[{}],"rateTierType":"string","linkedArrangement":"string","defaultNegotiable":"string","accrualRule":"string"}},"responses":{"200":"InterestConditionResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/product/productBuilder/interestConditions/{interestConditionId}","fullPath":"/api/v3.7.0/product/productBuilder/interestConditions/{interestConditionId}","operationId":"updateInterestCondition","name":"Updates an existing interest condition","summary":"Updates an existing interest condition","tags":["RETAIL"],"parameters":[{"name":"interestConditionId","in":"path","type":"string","required":true,"description":"The identifier of the product condition used to define the interest rate"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"rates":[{}],"displayNames":[{}],"rateTierType":"string","linkedArrangement":"string","defaultNegotiable":"string","accrualRule":"string"}},"responses":{"200":"InterestConditionResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/product/productBuilder/productConditions","fullPath":"/api/v3.7.0/product/productBuilder/productConditions","operationId":"getProductConditions","name":"Retrieves the list of product conditions available","summary":"Retrieves the list of product conditions available","tags":["RETAIL"],"parameters":[{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"ProductConditionsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/product/productBuilder/properties","fullPath":"/api/v3.7.0/product/productBuilder/properties","operationId":"getProperties","name":"Retrieves the details of all the available properties","summary":"Retrieves the details of all the available properties","tags":["RETAIL"],"parameters":[{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"PropertiesResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/product/productBuilder/projects","fullPath":"/api/v3.7.0/product/productBuilder/projects","operationId":"getProjects","name":"Retrieves the list of available projects created to build a product","summary":"Retrieves the list of available projects created to build a product","tags":["RETAIL"],"parameters":[{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"ProjectsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"POST","path":"/product/loans/simulations","fullPath":"/api/v3.7.0/product/loans/simulations","operationId":"createSynchronousSimulation","name":"Simulate a loan arrangement for the given principal amount, term, payment frequency and interest rates","summary":"Simulate a loan arrangement for the given principal amount, term, payment frequency and interest rates","tags":["RETAIL"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"customerIds":[{}],"properties":[{}],"overrides":[{}],"productId":"string","masterArrangementId":"string","roleName":"string","currencyId":"string","effectiveDate":"2024-01-01","activityId":"string","transactionAmount":0.0}},"responses":{"200":"createSynchronousSimulationResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"POST","path":"/product/loans/simulations/schedules","fullPath":"/api/v3.7.0/product/loans/simulations/schedules","operationId":"createSynchronousSimulationSchedules","name":"Simulate a loan arrangement for the given principal amount, term, payment frequency and interest rates. It also retrieves the details of payment schedules for the simulated contract","summary":"Simulate a loan arrangement and retrieve the payment schedule details","tags":["RETAIL"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"customerIds":[{}],"properties":[{}],"overrides":[{}],"productId":"string","masterArrangementId":"string","roleName":"string","currencyId":"string","effectiveDate":"2024-01-01","activityId":"string","transactionAmount":0.0}},"responses":{"200":"createSynchronousSimulationSchedulesResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"GET","path":"/product/productTypes","fullPath":"/api/v3.7.0/product/productTypes","operationId":"getAllProductTypes","name":"Retrieves the list of product types available in the Transact system","summary":"Retrieves the list of product types available in the Transact system","tags":["RETAIL"],"parameters":[{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"AllProductTypesResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/product/productTypes/{productType}","fullPath":"/api/v3.7.0/product/productTypes/{productType}","operationId":"getProductType","name":"Retrieves the product type details for a given product type","summary":"Retrieves the product type details for a given product type","tags":["RETAIL"],"parameters":[{"name":"productType","in":"path","type":"string","required":true,"description":"Deprecated - Indicates the identifier(s) of a Blueprint product from which an actual product can be created"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"ProductTypeResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/product/productTypes/products/{productId}","fullPath":"/api/v3.7.0/product/productTypes/products/{productId}","operationId":"getProductStatus","name":"Retrieves the basic details such as product details,status,proof and publish errors if any","summary":"Retrieves the basic details of a given product","tags":["RETAIL"],"parameters":[{"name":"productId","in":"path","type":"string","required":true,"description":"Contains the unique identifier of the product, e.g. the product id of the arrangement account."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"ProductStatusResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"POST","path":"/product/productTypes/products/{productId}","fullPath":"/api/v3.7.0/product/productTypes/products/{productId}","operationId":"createProducts","name":"Create a product from a product type","summary":"Create a product using the conditions available from the product type","tags":["RETAIL"],"parameters":[{"name":"productId","in":"path","type":"string","required":true,"description":"Contains the unique identifier of the product, e.g. the product id of the arrangement account."},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"id":"string","status":"string","transactionStatus":"string","uniqueIdentifier":"string","audit":{"T24_time":{},"versionNumber":{},"requestParse_time":{},"responseParse_time":{}}},"body":{"productType":"string","productId":"string","productGroupId":"string","productLineId":"string","productName":"string","applyToAllAccounts":"string","productDescription":"string","availableCurrency":[{}],"effectiveDate":"string","version":"string","productAttributes":[{}],"propertyList":[{}]}},"responses":{"200":"ProductsResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/product/productTypes/products/{productId}","fullPath":"/api/v3.7.0/product/productTypes/products/{productId}","operationId":"updateProducts","name":"Update a product such as property conditions and its condition values","summary":"Update a product such as property conditions and its condition values","tags":["RETAIL"],"parameters":[{"name":"productId","in":"path","type":"string","required":true,"description":"Contains the unique identifier of the product, e.g. the product id of the arrangement account."},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"id":"string","status":"string","transactionStatus":"string","uniqueIdentifier":"string","audit":{"T24_time":{},"versionNumber":{},"requestParse_time":{},"responseParse_time":{}}},"body":{"productType":"string","productId":"string","productGroupId":"string","productLineId":"string","productName":"string","applyToAllAccounts":"string","productDescription":"string","availableCurrency":[{}],"effectiveDate":"string","version":"string","productAttributes":[{}],"propertyList":[{}]}},"responses":{"200":"ProductsResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/product/productFeatures/{productFeatureId}/attributes","fullPath":"/api/v3.7.0/product/productFeatures/{productFeatureId}/attributes","operationId":"getPropertyFields","name":"Retrieves the attribute and the field structure for the given product feature","summary":"Retrieves the attribute and the field structure","tags":["RETAIL"],"parameters":[{"name":"productFeatureId","in":"path","type":"string","required":true,"description":""},{"name":"productConditionId","in":"query","type":"string","required":false,"description":"The identifier of the product condition"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"PropertyFieldsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/product/productGroups/{productGroupId}/productFeatures/productConditions","fullPath":"/api/v3.7.0/product/productGroups/{productGroupId}/productFeatures/productConditions","operationId":"getProductLineFeatureConditions","name":"Retrieves the product conditions for the product features present in the product group","summary":"Retrieves the product conditions for the product features","tags":["RETAIL"],"parameters":[{"name":"productGroupId","in":"path","type":"string","required":true,"description":"The group, as defined by the institution, that the product belongs to."},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"ProductLineFeatureConditionsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/product/productConditions/{productConditionId}","fullPath":"/api/v3.7.0/product/productConditions/{productConditionId}","operationId":"getConditionGenerator","name":"Retrieves the base condition details of a product feature such as the attributes ,their field name and values,status and validation errors if any","summary":"Retrieves the base condition details of a product feature","tags":["RETAIL"],"parameters":[{"name":"productConditionId","in":"path","type":"string","required":true,"description":"The identifier of the product condition"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"ConditionGeneratorResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"POST","path":"/product/productConditions/{productConditionId}","fullPath":"/api/v3.7.0/product/productConditions/{productConditionId}","operationId":"createConditionGenerator","name":"Create the product condition for the product feature based on the attributes and their field name and values","summary":"Create the product condition for the product feature","tags":["RETAIL"],"parameters":[{"name":"productConditionId","in":"path","type":"string","required":true,"description":"The identifier of the product condition"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"propertyId":"string","conditionName":"string","effectiveDate":"string","currencies":[{}]}},"responses":{"200":"ConditionGeneratorResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/product/productConditions/{productConditionId}","fullPath":"/api/v3.7.0/product/productConditions/{productConditionId}","operationId":"updateConditionGenerator","name":"Update the product condition for the product feature based on the attributes and their field name and values","summary":"Update the product condition for the product feature","tags":["RETAIL"],"parameters":[{"name":"productConditionId","in":"path","type":"string","required":true,"description":"The identifier of the product condition"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"propertyId":"string","conditionName":"string","effectiveDate":"string","currencies":[{}]}},"responses":{"200":"ConditionGeneratorResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/product/productFeatures","fullPath":"/api/v3.7.0/product/productFeatures","operationId":"getProductLineFeatures","name":"Returns the list of product features, its currency type and supports base conditions or not","summary":"Returns the list of product features","tags":["RETAIL"],"parameters":[{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"FeatureTypesResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/product/{productId}/productConditions","fullPath":"/api/v3.7.0/product/{productId}/productConditions","operationId":"getProductCatalogue","name":"Retrieves the catalogued conditions of a given product","summary":"Retrieves the catalogued conditions of a given product","tags":["RETAIL"],"parameters":[{"name":"productId","in":"path","type":"string","required":true,"description":"Contains the unique identifier of the product, e.g. the product id of the arrangement account."},{"name":"currency","in":"query","type":"string","required":false,"description":"Identifies the currency. E.g. USD, GBP etc"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"ProductCatalogueResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"PUT","path":"/product/productManagers/{productId}","fullPath":"/api/v3.7.0/product/productManagers/{productId}","operationId":"updateProductManager","name":"Update the action such as proof and publish for the specific product","summary":"Update the action for product","tags":["RETAIL"],"parameters":[{"name":"productId","in":"path","type":"string","required":true,"description":"Contains the unique identifier of the product, e.g. the product id of the arrangement account."},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"displayName":"string","action":"string","availableDate":"2024-01-01","processingIndicator":"string","directPublish":"string","extensions":{}}},"responses":{"200":"ProductManagerResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/product/interestConditions","fullPath":"/api/v3.7.0/product/interestConditions","operationId":"getInterestConditionReference","name":"Retrieves all the available interest conditions","summary":"Retrieves all the available interest conditions","tags":["RETAIL"],"parameters":[{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"InterestConditionReferenceResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/product/products/{productId}/overpaymentRules","fullPath":"/api/v3.7.0/product/products/{productId}/overpaymentRules","operationId":"getProductOverpaymentDetails","name":"Retrieves the overpayment rule details like type of overpay, overpay limit and period defined for a product. Overpayment is excess repayments done in addition to mandate payments.","summary":"Retrieves the overpayment configurations done in a product","tags":["RETAIL"],"parameters":[{"name":"productId","in":"path","type":"string","required":true,"description":"Contains the unique identifier of the product, e.g. the product id of the arrangement account."},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"ProductOverpaymentDetailsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/product/products/buyNowPayLater","fullPath":"/api/v3.7.0/product/products/buyNowPayLater","operationId":"getLoanSimulation","name":"Qualifies and simulates the applicable buy now pay later products for the given amount and currency value and provides the product wise installments simulation results.","summary":"Qualifies the eligible buy now pay later products and perform simulation for the products","tags":["Loan Simulation"],"parameters":[{"name":"currencyId","in":"query","type":"string","required":false,"description":"Identifier of the currency. This is the 3-letter ISO 4217 code of the currency."},{"name":"loanAmount","in":"query","type":"integer","required":false,"description":"Indicates loan amount"},{"name":"productType","in":"query","type":"string","required":false,"description":"Indicates the product type for the deal"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"BnplLoanSimulationResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/product/{productId}/commitment/{amount}/period/{term}","fullPath":"/api/v3.7.0/product/{productId}/commitment/{amount}/period/{term}","operationId":"getRepaymentCalculator","name":"Retrieves the repayment details for the given product, principal amount and term","summary":"Retrieves the repayment details for the given product, principal amount and term","tags":["RETAIL"],"parameters":[{"name":"productId","in":"path","type":"string","required":true,"description":"Contains the unique identifier of the product, e.g. the product id of the arrangement account."},{"name":"amount","in":"path","type":"string","required":true,"description":"This is the payment amount"},{"name":"term","in":"path","type":"string","required":true,"description":"Indicates the period to which the BID and OFFER rates apply"},{"name":"currencyId","in":"query","type":"string","required":false,"description":"Identifier of the currency. This is the 3-letter ISO 4217 code of the currency."},{"name":"paymentFrequency","in":"query","type":"string","required":false,"description":"The frequency at which a payment is required to be generated"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"RepaymentCalculatorResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}}]},{"key":"product-products-v3.8.0","title":"Product Builder","version":"v3.8.0","description":"API to create, update and manage the product definition details, interest conditions, repayment calculator, simulate a loan contract and project the schedules","endpointCount":35,"endpoints":[{"method":"GET","path":"/product/productLines/{productLineId}/productGroups/{productGroupId}/products","fullPath":"/api/v3.8.0/product/productLines/{productLineId}/productGroups/{productGroupId}/products","operationId":"getProductsPerLineAndGroup","name":"Retrieves the details of all the products based on a given product line and product group","summary":"Retrieves the details of all the products based on a given product line and product group","tags":[],"parameters":[{"name":"productLineId","in":"path","type":"string","required":true,"description":"The top level product line, which the product is ultimately attached to. May be a Temenos-defined product line such as ACCOUNTS, AGENT, BUNDLE, CONSENT, DEPOSITS, LENDING, REWARDS, etc. or one defined"},{"name":"productGroupId","in":"path","type":"string","required":true,"description":"The group, as defined by the institution, that the product belongs to."},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"ProductsPerLineAndGroupResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/product/productLines/{productLineId}/productGroups","fullPath":"/api/v3.8.0/product/productLines/{productLineId}/productGroups","operationId":"getProductGroups","name":"Retrieves the details of all the products based on a given product line","summary":"Retrieves the details of all the products based on a given product line","tags":[],"parameters":[{"name":"productLineId","in":"path","type":"string","required":true,"description":"The top level product line, which the product is ultimately attached to. May be a Temenos-defined product line such as ACCOUNTS, AGENT, BUNDLE, CONSENT, DEPOSITS, LENDING, REWARDS, etc. or one defined"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"ProductGroupsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/product/productLines/{productLineId}/activities","fullPath":"/api/v3.8.0/product/productLines/{productLineId}/activities","operationId":"getProductLineActivities","name":"Retrieves the list of activities applicable for a given product line","summary":"Retrieves the list of activities applicable for a given product line","tags":[],"parameters":[{"name":"productLineId","in":"path","type":"string","required":true,"description":"The top level product line, which the product is ultimately attached to. May be a Temenos-defined product line such as ACCOUNTS, AGENT, BUNDLE, CONSENT, DEPOSITS, LENDING, REWARDS, etc. or one defined"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"ProductLineActivitiesResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/product/productLines","fullPath":"/api/v3.8.0/product/productLines","operationId":"getProductLines","name":"Retrieves the list of available product line","summary":"Retrieves the list of available product line","tags":[],"parameters":[{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"ProductLinesResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/product/products","fullPath":"/api/v3.8.0/product/products","operationId":"getAllProducts","name":"Retrieves all the products available in the catalogue","summary":"Retrieves all the products available in the catalogue","tags":["RETAIL"],"parameters":[{"name":"productLineId","in":"query","type":"string","required":false,"description":"The top level product line, which the product is ultimately attached to. May be a Temenos-defined product line such as ACCOUNTS, AGENT, BUNDLE, CONSENT, DEPOSITS, LENDING, REWARDS, etc. or one defined"},{"name":"productGroupId","in":"query","type":"string","required":false,"description":"The group, as defined by the institution, that the product belongs to."},{"name":"eligibilityFilter","in":"query","type":"string","required":false,"description":"Indicates the filter based on the Eligibility options available to the customer"},{"name":"multiBookEligible","in":"query","type":"string","required":false,"description":"Flag which indicates whether multi booking is applicable or not"},{"name":"productId","in":"query","type":"string","required":false,"description":"Contains the unique identifier of the product, e.g. the product id of the arrangement account."},{"name":"customerId","in":"query","type":"string","required":false,"description":"Identifier of the customer"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"AllProductsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/product/products/{productId}","fullPath":"/api/v3.8.0/product/products/{productId}","operationId":"getProducts","name":"Retrieves the details of a given product","summary":"Retrieves the details of a given product","tags":[],"parameters":[{"name":"productId","in":"path","type":"string","required":true,"description":""},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"ProductsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/product/propertyClasses","fullPath":"/api/v3.8.0/product/propertyClasses","operationId":"getPropertyClasses","name":"Retrieves the product's property class information, which is used for building products","summary":"Retrieves the product's property class information, which is used for building products","tags":[],"parameters":[{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"PropertyClassesResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/product/productGroups","fullPath":"/api/v3.8.0/product/productGroups","operationId":"getAllProductGroups","name":"Retrieves the list of product group available with its product line","summary":"Retrieves the list of product group available with its product line","tags":[],"parameters":[{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"AllProductGroupsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/product/{productId}","fullPath":"/api/v3.8.0/product/{productId}","operationId":"getProductDetails","name":"Retrieves the product details for a catalogued product","summary":"Retrieves the product details for a catalogued product","tags":[],"parameters":[{"name":"productId","in":"path","type":"string","required":true,"description":"Contains the unique identifier of the product, e.g. the product id of the arrangement account."},{"name":"currency","in":"query","type":"string","required":false,"description":"Identifies the currency. E.g. USD, GBP etc"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"ProductDetailsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/product/productBuilder/interestConditions","fullPath":"/api/v3.8.0/product/productBuilder/interestConditions","operationId":"getAllInterestConditions","name":"Retrieves the list of all the available interest conditions","summary":"Retrieves the list of all the available interest conditions","tags":[],"parameters":[{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"AllInterestConditionsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/product/productBuilder/interestConditions/{interestConditionId}","fullPath":"/api/v3.8.0/product/productBuilder/interestConditions/{interestConditionId}","operationId":"getInterestConditions","name":"Retrieves the details of the given interest condition","summary":"Retrieves the details of the given interest condition","tags":[],"parameters":[{"name":"interestConditionId","in":"path","type":"string","required":true,"description":"The identifier of the product condition used to define the interest rate"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"InterestConditionsResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"POST","path":"/product/productBuilder/interestConditions/{interestConditionId}","fullPath":"/api/v3.8.0/product/productBuilder/interestConditions/{interestConditionId}","operationId":"createInterestCondition","name":"Creates a new interest condition","summary":"Creates a new interest condition","tags":[],"parameters":[{"name":"interestConditionId","in":"path","type":"string","required":true,"description":"The identifier of the product condition used to define the interest rate"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"rates":[{}],"displayNames":[{}],"rateTierType":"string","linkedArrangement":"string","defaultNegotiable":"string","accrualRule":"string"}},"responses":{"200":"InterestConditionResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/product/productBuilder/interestConditions/{interestConditionId}","fullPath":"/api/v3.8.0/product/productBuilder/interestConditions/{interestConditionId}","operationId":"updateInterestCondition","name":"Updates an existing interest condition","summary":"Updates an existing interest condition","tags":[],"parameters":[{"name":"interestConditionId","in":"path","type":"string","required":true,"description":"The identifier of the product condition used to define the interest rate"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"rates":[{}],"displayNames":[{}],"rateTierType":"string","linkedArrangement":"string","defaultNegotiable":"string","accrualRule":"string"}},"responses":{"200":"InterestConditionResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/product/productBuilder/productConditions","fullPath":"/api/v3.8.0/product/productBuilder/productConditions","operationId":"getProductConditions","name":"Retrieves the list of product conditions available","summary":"Retrieves the list of product conditions available","tags":[],"parameters":[{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"ProductConditionsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/product/productBuilder/properties","fullPath":"/api/v3.8.0/product/productBuilder/properties","operationId":"getProperties","name":"Retrieves the details of all the available properties","summary":"Retrieves the details of all the available properties","tags":[],"parameters":[{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"PropertiesResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/product/productBuilder/projects","fullPath":"/api/v3.8.0/product/productBuilder/projects","operationId":"getProjects","name":"Retrieves the list of available projects created to build a product","summary":"Retrieves the list of available projects created to build a product","tags":[],"parameters":[{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"ProjectsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"POST","path":"/product/loans/simulations","fullPath":"/api/v3.8.0/product/loans/simulations","operationId":"createSynchronousSimulation","name":"Simulate a loan arrangement for the given principal amount, term, payment frequency and interest rates","summary":"Simulate a loan arrangement for the given principal amount, term, payment frequency and interest rates","tags":[],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"customerIds":[{}],"properties":[{}],"overrides":[{}],"productId":"string","masterArrangementId":"string","roleName":"string","currencyId":"string","effectiveDate":"2024-01-01","activityId":"string","transactionAmount":0.0}},"responses":{"200":"createSynchronousSimulationResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"POST","path":"/product/loans/simulations/schedules","fullPath":"/api/v3.8.0/product/loans/simulations/schedules","operationId":"createSynchronousSimulationSchedules","name":"Simulate a loan arrangement for the given principal amount, term, payment frequency and interest rates. It also retrieves the details of payment schedules for the simulated contract","summary":"Simulate a loan arrangement and retrieve the payment schedule details","tags":[],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"customerIds":[{}],"properties":[{}],"overrides":[{}],"productId":"string","masterArrangementId":"string","roleName":"string","currencyId":"string","effectiveDate":"2024-01-01","activityId":"string","transactionAmount":0.0}},"responses":{"200":"createSynchronousSimulationSchedulesResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"GET","path":"/product/productTypes","fullPath":"/api/v3.8.0/product/productTypes","operationId":"getAllProductTypes","name":"Retrieves the list of product types available in the Transact system","summary":"Retrieves the list of product types available in the Transact system","tags":[],"parameters":[{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"AllProductTypesResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/product/productTypes/{productType}","fullPath":"/api/v3.8.0/product/productTypes/{productType}","operationId":"getProductType","name":"Retrieves the product type details for a given product type","summary":"Retrieves the product type details for a given product type","tags":[],"parameters":[{"name":"productType","in":"path","type":"string","required":true,"description":"Deprecated - Indicates the identifier(s) of a Blueprint product from which an actual product can be created"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"ProductTypeResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/product/productTypes/products/{productId}","fullPath":"/api/v3.8.0/product/productTypes/products/{productId}","operationId":"getProductStatus","name":"Retrieves the basic details such as product details,status,proof and publish errors if any","summary":"Retrieves the basic details of a given product","tags":[],"parameters":[{"name":"productId","in":"path","type":"string","required":true,"description":"Contains the unique identifier of the product, e.g. the product id of the arrangement account."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"ProductStatusResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"POST","path":"/product/productTypes/products/{productId}","fullPath":"/api/v3.8.0/product/productTypes/products/{productId}","operationId":"createProducts","name":"Create a product from a product type","summary":"Create a product using the conditions available from the product type","tags":[],"parameters":[{"name":"productId","in":"path","type":"string","required":true,"description":"Contains the unique identifier of the product, e.g. the product id of the arrangement account."},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"id":"string","status":"string","transactionStatus":"string","uniqueIdentifier":"string","audit":{"T24_time":{},"versionNumber":{},"requestParse_time":{},"responseParse_time":{}}},"body":{"productType":"string","productId":"string","productGroupId":"string","productLineId":"string","productName":"string","applyToAllAccounts":"string","productCode":"string","productDescription":"string","availableCurrency":[{}],"effectiveDate":"string","version":"string","productAttributes":[{}],"propertyList":[{}]}},"responses":{"200":"ProductsResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/product/productTypes/products/{productId}","fullPath":"/api/v3.8.0/product/productTypes/products/{productId}","operationId":"updateProducts","name":"Update a product such as property conditions and its condition values","summary":"Update a product such as property conditions and its condition values","tags":[],"parameters":[{"name":"productId","in":"path","type":"string","required":true,"description":"Contains the unique identifier of the product, e.g. the product id of the arrangement account."},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"id":"string","status":"string","transactionStatus":"string","uniqueIdentifier":"string","audit":{"T24_time":{},"versionNumber":{},"requestParse_time":{},"responseParse_time":{}}},"body":{"productType":"string","productId":"string","productGroupId":"string","productLineId":"string","productName":"string","applyToAllAccounts":"string","productCode":"string","productDescription":"string","availableCurrency":[{}],"effectiveDate":"string","version":"string","productAttributes":[{}],"propertyList":[{}]}},"responses":{"200":"ProductsResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/product/productFeatures/{productFeatureId}/attributes","fullPath":"/api/v3.8.0/product/productFeatures/{productFeatureId}/attributes","operationId":"getPropertyFields","name":"Retrieves the attribute and the field structure for the given product feature","summary":"Retrieves the attribute and the field structure","tags":[],"parameters":[{"name":"productFeatureId","in":"path","type":"string","required":true,"description":""},{"name":"productConditionId","in":"query","type":"string","required":false,"description":"The identifier of the product condition"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"PropertyFieldsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/product/productGroups/{productGroupId}/productFeatures/productConditions","fullPath":"/api/v3.8.0/product/productGroups/{productGroupId}/productFeatures/productConditions","operationId":"getProductLineFeatureConditions","name":"Retrieves the product conditions for the product features present in the product group","summary":"Retrieves the product conditions for the product features","tags":[],"parameters":[{"name":"productGroupId","in":"path","type":"string","required":true,"description":"The group, as defined by the institution, that the product belongs to."},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"ProductLineFeatureConditionsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/product/productConditions/{productConditionId}","fullPath":"/api/v3.8.0/product/productConditions/{productConditionId}","operationId":"getConditionGenerator","name":"Retrieves the base condition details of a product feature such as the attributes ,their field name and values,status and validation errors if any","summary":"Retrieves the base condition details of a product feature","tags":[],"parameters":[{"name":"productConditionId","in":"path","type":"string","required":true,"description":"The identifier of the product condition"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"ConditionGeneratorResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"POST","path":"/product/productConditions/{productConditionId}","fullPath":"/api/v3.8.0/product/productConditions/{productConditionId}","operationId":"createConditionGenerator","name":"Create the product condition for the product feature based on the attributes and their field name and values","summary":"Create the product condition for the product feature","tags":[],"parameters":[{"name":"productConditionId","in":"path","type":"string","required":true,"description":"The identifier of the product condition"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"propertyId":"string","conditionName":"string","effectiveDate":"string","currencies":[{}]}},"responses":{"200":"ConditionGeneratorResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/product/productConditions/{productConditionId}","fullPath":"/api/v3.8.0/product/productConditions/{productConditionId}","operationId":"updateConditionGenerator","name":"Update the product condition for the product feature based on the attributes and their field name and values","summary":"Update the product condition for the product feature","tags":[],"parameters":[{"name":"productConditionId","in":"path","type":"string","required":true,"description":"The identifier of the product condition"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"propertyId":"string","conditionName":"string","effectiveDate":"string","currencies":[{}]}},"responses":{"200":"ConditionGeneratorResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/product/productFeatures","fullPath":"/api/v3.8.0/product/productFeatures","operationId":"getProductLineFeatures","name":"Returns the list of product features, its currency type and supports base conditions or not","summary":"Returns the list of product features","tags":[],"parameters":[{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"FeatureTypesResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/product/{productId}/productConditions","fullPath":"/api/v3.8.0/product/{productId}/productConditions","operationId":"getProductCatalogue","name":"Retrieves the catalogued conditions of a given product","summary":"Retrieves the catalogued conditions of a given product","tags":["RETAIL"],"parameters":[{"name":"productId","in":"path","type":"string","required":true,"description":"Contains the unique identifier of the product, e.g. the product id of the arrangement account."},{"name":"currency","in":"query","type":"string","required":false,"description":"Identifies the currency. E.g. USD, GBP etc"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"ProductCatalogueResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"PUT","path":"/product/productManagers/{productId}","fullPath":"/api/v3.8.0/product/productManagers/{productId}","operationId":"updateProductManager","name":"Update the action such as proof and publish for the specific product","summary":"Update the action for product","tags":["RETAIL"],"parameters":[{"name":"productId","in":"path","type":"string","required":true,"description":"Contains the unique identifier of the product, e.g. the product id of the arrangement account."},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"displayName":"string","action":"string","availableDate":"2024-01-01","processingIndicator":"string","directPublish":"string","extensions":{}}},"responses":{"200":"ProductManagerResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/product/interestConditions","fullPath":"/api/v3.8.0/product/interestConditions","operationId":"getInterestConditionReference","name":"Retrieves all the available interest conditions","summary":"Retrieves all the available interest conditions","tags":[],"parameters":[{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"InterestConditionReferenceResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/product/products/{productId}/overpaymentRules","fullPath":"/api/v3.8.0/product/products/{productId}/overpaymentRules","operationId":"getProductOverpaymentDetails","name":"Retrieves the overpayment rule details like type of overpay, overpay limit and period defined for a product. Overpayment is excess repayments done in addition to mandate payments.","summary":"Retrieves the overpayment configurations done in a product","tags":["RETAIL"],"parameters":[{"name":"productId","in":"path","type":"string","required":true,"description":"Contains the unique identifier of the product, e.g. the product id of the arrangement account."},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"ProductOverpaymentDetailsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/product/products/buyNowPayLater","fullPath":"/api/v3.8.0/product/products/buyNowPayLater","operationId":"getLoanSimulation","name":"Qualifies and simulates the applicable buy now pay later products for the given amount and currency value and provides the product wise installments simulation results.","summary":"Qualifies the eligible buy now pay later products and perform simulation for the products","tags":["Loan Simulation"],"parameters":[{"name":"currencyId","in":"query","type":"string","required":false,"description":"Identifier of the currency. This is the 3-letter ISO 4217 code of the currency."},{"name":"loanAmount","in":"query","type":"integer","required":false,"description":"Indicates loan amount"},{"name":"productType","in":"query","type":"string","required":false,"description":"Indicates the product type for the deal"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"BnplLoanSimulationResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/product/{productId}/commitment/{amount}/period/{term}","fullPath":"/api/v3.8.0/product/{productId}/commitment/{amount}/period/{term}","operationId":"getRepaymentCalculator","name":"Retrieves the repayment details for the given product, principal amount and term","summary":"Retrieves the repayment details for the given product, principal amount and term","tags":[],"parameters":[{"name":"productId","in":"path","type":"string","required":true,"description":"Contains the unique identifier of the product, e.g. the product id of the arrangement account."},{"name":"amount","in":"path","type":"string","required":true,"description":"This is the payment amount"},{"name":"term","in":"path","type":"string","required":true,"description":"Indicates the period to which the BID and OFFER rates apply"},{"name":"currencyId","in":"query","type":"string","required":false,"description":"Identifier of the currency. This is the 3-letter ISO 4217 code of the currency."},{"name":"paymentFrequency","in":"query","type":"string","required":false,"description":"The frequency at which a payment is required to be generated"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"RepaymentCalculatorResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}}]},{"key":"product-products-v3.8.1","title":"Product Builder","version":"v3.8.1","description":"API to create, update and manage the product definition details, interest conditions, repayment calculator, simulate a loan contract and project the schedules","endpointCount":35,"endpoints":[{"method":"GET","path":"/product/productLines/{productLineId}/productGroups/{productGroupId}/products","fullPath":"/api/v3.8.1/product/productLines/{productLineId}/productGroups/{productGroupId}/products","operationId":"getProductsPerLineAndGroup","name":"Retrieves the details of all the products based on a given product line and product group","summary":"Retrieves the details of all the products based on a given product line and product group","tags":[],"parameters":[{"name":"productLineId","in":"path","type":"string","required":true,"description":"The top level product line, which the product is ultimately attached to. May be a Temenos-defined product line such as ACCOUNTS, AGENT, BUNDLE, CONSENT, DEPOSITS, LENDING, REWARDS, etc. or one defined"},{"name":"productGroupId","in":"path","type":"string","required":true,"description":"The group, as defined by the institution, that the product belongs to."},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"ProductsPerLineAndGroupResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/product/productLines/{productLineId}/productGroups","fullPath":"/api/v3.8.1/product/productLines/{productLineId}/productGroups","operationId":"getProductGroups","name":"Retrieves the details of all the products based on a given product line","summary":"Retrieves the details of all the products based on a given product line","tags":[],"parameters":[{"name":"productLineId","in":"path","type":"string","required":true,"description":"The top level product line, which the product is ultimately attached to. May be a Temenos-defined product line such as ACCOUNTS, AGENT, BUNDLE, CONSENT, DEPOSITS, LENDING, REWARDS, etc. or one defined"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"ProductGroupsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/product/productLines/{productLineId}/activities","fullPath":"/api/v3.8.1/product/productLines/{productLineId}/activities","operationId":"getProductLineActivities","name":"Retrieves the list of activities applicable for a given product line","summary":"Retrieves the list of activities applicable for a given product line","tags":[],"parameters":[{"name":"productLineId","in":"path","type":"string","required":true,"description":"The top level product line, which the product is ultimately attached to. May be a Temenos-defined product line such as ACCOUNTS, AGENT, BUNDLE, CONSENT, DEPOSITS, LENDING, REWARDS, etc. or one defined"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"ProductLineActivitiesResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/product/productLines","fullPath":"/api/v3.8.1/product/productLines","operationId":"getProductLines","name":"Retrieves the list of available product line","summary":"Retrieves the list of available product line","tags":[],"parameters":[{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"ProductLinesResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/product/products","fullPath":"/api/v3.8.1/product/products","operationId":"getAllProducts","name":"Retrieves all the products available in the catalogue","summary":"Retrieves all the products available in the catalogue","tags":["RETAIL"],"parameters":[{"name":"productLineId","in":"query","type":"string","required":false,"description":"The top level product line, which the product is ultimately attached to. May be a Temenos-defined product line such as ACCOUNTS, AGENT, BUNDLE, CONSENT, DEPOSITS, LENDING, REWARDS, etc. or one defined"},{"name":"productGroupId","in":"query","type":"string","required":false,"description":"The group, as defined by the institution, that the product belongs to."},{"name":"eligibilityFilter","in":"query","type":"string","required":false,"description":"Indicates the filter based on the Eligibility options available to the customer"},{"name":"multiBookEligible","in":"query","type":"string","required":false,"description":"Flag which indicates whether multi booking is applicable or not"},{"name":"productId","in":"query","type":"string","required":false,"description":"Contains the unique identifier of the product, e.g. the product id of the arrangement account."},{"name":"customerId","in":"query","type":"string","required":false,"description":"Identifier of the customer"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"AllProductsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/product/products/{productId}","fullPath":"/api/v3.8.1/product/products/{productId}","operationId":"getProducts","name":"Retrieves the details of a given product","summary":"Retrieves the details of a given product","tags":[],"parameters":[{"name":"productId","in":"path","type":"string","required":true,"description":""},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"ProductsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/product/propertyClasses","fullPath":"/api/v3.8.1/product/propertyClasses","operationId":"getPropertyClasses","name":"Retrieves the product's property class information, which is used for building products","summary":"Retrieves the product's property class information, which is used for building products","tags":[],"parameters":[{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"PropertyClassesResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/product/productGroups","fullPath":"/api/v3.8.1/product/productGroups","operationId":"getAllProductGroups","name":"Retrieves the list of product group available with its product line","summary":"Retrieves the list of product group available with its product line","tags":[],"parameters":[{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"AllProductGroupsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/product/{productId}","fullPath":"/api/v3.8.1/product/{productId}","operationId":"getProductDetails","name":"Retrieves the product details for a catalogued product","summary":"Retrieves the product details for a catalogued product","tags":[],"parameters":[{"name":"productId","in":"path","type":"string","required":true,"description":"Contains the unique identifier of the product, e.g. the product id of the arrangement account."},{"name":"currency","in":"query","type":"string","required":false,"description":"Identifies the currency. E.g. USD, GBP etc"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"ProductDetailsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/product/productBuilder/interestConditions","fullPath":"/api/v3.8.1/product/productBuilder/interestConditions","operationId":"getAllInterestConditions","name":"Retrieves the list of all the available interest conditions","summary":"Retrieves the list of all the available interest conditions","tags":[],"parameters":[{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"AllInterestConditionsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/product/productBuilder/interestConditions/{interestConditionId}","fullPath":"/api/v3.8.1/product/productBuilder/interestConditions/{interestConditionId}","operationId":"getInterestConditions","name":"Retrieves the details of the given interest condition","summary":"Retrieves the details of the given interest condition","tags":[],"parameters":[{"name":"interestConditionId","in":"path","type":"string","required":true,"description":"The identifier of the product condition used to define the interest rate"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"InterestConditionsResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"POST","path":"/product/productBuilder/interestConditions/{interestConditionId}","fullPath":"/api/v3.8.1/product/productBuilder/interestConditions/{interestConditionId}","operationId":"createInterestCondition","name":"Creates a new interest condition","summary":"Creates a new interest condition","tags":[],"parameters":[{"name":"interestConditionId","in":"path","type":"string","required":true,"description":"The identifier of the product condition used to define the interest rate"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"rates":[{}],"displayNames":[{}],"rateTierType":"string","linkedArrangement":"string","defaultNegotiable":"string","accrualRule":"string"}},"responses":{"200":"InterestConditionResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/product/productBuilder/interestConditions/{interestConditionId}","fullPath":"/api/v3.8.1/product/productBuilder/interestConditions/{interestConditionId}","operationId":"updateInterestCondition","name":"Updates an existing interest condition","summary":"Updates an existing interest condition","tags":[],"parameters":[{"name":"interestConditionId","in":"path","type":"string","required":true,"description":"The identifier of the product condition used to define the interest rate"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"rates":[{}],"displayNames":[{}],"rateTierType":"string","linkedArrangement":"string","defaultNegotiable":"string","accrualRule":"string"}},"responses":{"200":"InterestConditionResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/product/productBuilder/productConditions","fullPath":"/api/v3.8.1/product/productBuilder/productConditions","operationId":"getProductConditions","name":"Retrieves the list of product conditions available","summary":"Retrieves the list of product conditions available","tags":[],"parameters":[{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"ProductConditionsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/product/productBuilder/properties","fullPath":"/api/v3.8.1/product/productBuilder/properties","operationId":"getProperties","name":"Retrieves the details of all the available properties","summary":"Retrieves the details of all the available properties","tags":[],"parameters":[{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"PropertiesResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/product/productBuilder/projects","fullPath":"/api/v3.8.1/product/productBuilder/projects","operationId":"getProjects","name":"Retrieves the list of available projects created to build a product","summary":"Retrieves the list of available projects created to build a product","tags":[],"parameters":[{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"ProjectsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"POST","path":"/product/loans/simulations","fullPath":"/api/v3.8.1/product/loans/simulations","operationId":"createSynchronousSimulation","name":"Simulate a loan arrangement for the given principal amount, term, payment frequency and interest rates","summary":"Simulate a loan arrangement for the given principal amount, term, payment frequency and interest rates","tags":[],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"customerIds":[{}],"properties":[{}],"overrides":[{}],"productId":"string","masterArrangementId":"string","roleName":"string","currencyId":"string","effectiveDate":"2024-01-01","activityId":"string","transactionAmount":0.0}},"responses":{"200":"createSynchronousSimulationResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"POST","path":"/product/loans/simulations/schedules","fullPath":"/api/v3.8.1/product/loans/simulations/schedules","operationId":"createSynchronousSimulationSchedules","name":"Simulate a loan arrangement for the given principal amount, term, payment frequency and interest rates. It also retrieves the details of payment schedules for the simulated contract","summary":"Simulate a loan arrangement and retrieve the payment schedule details","tags":[],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"customerIds":[{}],"properties":[{}],"overrides":[{}],"productId":"string","masterArrangementId":"string","roleName":"string","currencyId":"string","effectiveDate":"2024-01-01","activityId":"string","transactionAmount":0.0}},"responses":{"200":"createSynchronousSimulationSchedulesResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"GET","path":"/product/productTypes","fullPath":"/api/v3.8.1/product/productTypes","operationId":"getAllProductTypes","name":"Retrieves the list of product types available in the Transact system","summary":"Retrieves the list of product types available in the Transact system","tags":[],"parameters":[{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"AllProductTypesResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/product/productTypes/{productType}","fullPath":"/api/v3.8.1/product/productTypes/{productType}","operationId":"getProductType","name":"Retrieves the product type details for a given product type","summary":"Retrieves the product type details for a given product type","tags":[],"parameters":[{"name":"productType","in":"path","type":"string","required":true,"description":"Deprecated - Indicates the identifier(s) of a Blueprint product from which an actual product can be created"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"ProductTypeResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/product/productTypes/products/{productId}","fullPath":"/api/v3.8.1/product/productTypes/products/{productId}","operationId":"getProductStatus","name":"Retrieves the basic details such as product details,status,proof and publish errors if any","summary":"Retrieves the basic details of a given product","tags":[],"parameters":[{"name":"productId","in":"path","type":"string","required":true,"description":"Contains the unique identifier of the product, e.g. the product id of the arrangement account."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"ProductStatusResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"POST","path":"/product/productTypes/products/{productId}","fullPath":"/api/v3.8.1/product/productTypes/products/{productId}","operationId":"createProducts","name":"Create a product from a product type","summary":"Create a product using the conditions available from the product type","tags":[],"parameters":[{"name":"productId","in":"path","type":"string","required":true,"description":"Contains the unique identifier of the product, e.g. the product id of the arrangement account."},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"id":"string","status":"string","transactionStatus":"string","uniqueIdentifier":"string","audit":{"T24_time":{},"versionNumber":{},"requestParse_time":{},"responseParse_time":{}}},"body":{"productType":"string","productId":"string","productGroupId":"string","productLineId":"string","productName":"string","applyToAllAccounts":"string","productCode":"string","productDescription":"string","availableCurrency":[{}],"effectiveDate":"string","version":"string","productAttributes":[{}],"propertyList":[{}]}},"responses":{"200":"ProductsResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/product/productTypes/products/{productId}","fullPath":"/api/v3.8.1/product/productTypes/products/{productId}","operationId":"updateProducts","name":"Update a product such as property conditions and its condition values","summary":"Update a product such as property conditions and its condition values","tags":[],"parameters":[{"name":"productId","in":"path","type":"string","required":true,"description":"Contains the unique identifier of the product, e.g. the product id of the arrangement account."},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"id":"string","status":"string","transactionStatus":"string","uniqueIdentifier":"string","audit":{"T24_time":{},"versionNumber":{},"requestParse_time":{},"responseParse_time":{}}},"body":{"productType":"string","productId":"string","productGroupId":"string","productLineId":"string","productName":"string","applyToAllAccounts":"string","productCode":"string","productDescription":"string","availableCurrency":[{}],"effectiveDate":"string","version":"string","productAttributes":[{}],"propertyList":[{}]}},"responses":{"200":"ProductsResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/product/productFeatures/{productFeatureId}/attributes","fullPath":"/api/v3.8.1/product/productFeatures/{productFeatureId}/attributes","operationId":"getPropertyFields","name":"Retrieves the attribute and the field structure for the given product feature","summary":"Retrieves the attribute and the field structure","tags":[],"parameters":[{"name":"productFeatureId","in":"path","type":"string","required":true,"description":""},{"name":"productConditionId","in":"query","type":"string","required":false,"description":"The identifier of the product condition"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"PropertyFieldsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/product/productGroups/{productGroupId}/productFeatures/productConditions","fullPath":"/api/v3.8.1/product/productGroups/{productGroupId}/productFeatures/productConditions","operationId":"getProductLineFeatureConditions","name":"Retrieves the product conditions for the product features present in the product group","summary":"Retrieves the product conditions for the product features","tags":[],"parameters":[{"name":"productGroupId","in":"path","type":"string","required":true,"description":"The group, as defined by the institution, that the product belongs to."},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"ProductLineFeatureConditionsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/product/productConditions/{productConditionId}","fullPath":"/api/v3.8.1/product/productConditions/{productConditionId}","operationId":"getConditionGenerator","name":"Retrieves the base condition details of a product feature such as the attributes ,their field name and values,status and validation errors if any","summary":"Retrieves the base condition details of a product feature","tags":[],"parameters":[{"name":"productConditionId","in":"path","type":"string","required":true,"description":"The identifier of the product condition"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"ConditionGeneratorResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"POST","path":"/product/productConditions/{productConditionId}","fullPath":"/api/v3.8.1/product/productConditions/{productConditionId}","operationId":"createConditionGenerator","name":"Create the product condition for the product feature based on the attributes and their field name and values","summary":"Create the product condition for the product feature","tags":[],"parameters":[{"name":"productConditionId","in":"path","type":"string","required":true,"description":"The identifier of the product condition"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"propertyId":"string","conditionName":"string","effectiveDate":"string","currencies":[{}]}},"responses":{"200":"ConditionGeneratorResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/product/productConditions/{productConditionId}","fullPath":"/api/v3.8.1/product/productConditions/{productConditionId}","operationId":"updateConditionGenerator","name":"Update the product condition for the product feature based on the attributes and their field name and values","summary":"Update the product condition for the product feature","tags":[],"parameters":[{"name":"productConditionId","in":"path","type":"string","required":true,"description":"The identifier of the product condition"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"propertyId":"string","conditionName":"string","effectiveDate":"string","currencies":[{}]}},"responses":{"200":"ConditionGeneratorResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/product/productFeatures","fullPath":"/api/v3.8.1/product/productFeatures","operationId":"getProductLineFeatures","name":"Returns the list of product features, its currency type and supports base conditions or not","summary":"Returns the list of product features","tags":[],"parameters":[{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"FeatureTypesResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/product/{productId}/productConditions","fullPath":"/api/v3.8.1/product/{productId}/productConditions","operationId":"getProductCatalogue","name":"Retrieves the catalogued conditions of a given product","summary":"Retrieves the catalogued conditions of a given product","tags":["RETAIL"],"parameters":[{"name":"productId","in":"path","type":"string","required":true,"description":"Contains the unique identifier of the product, e.g. the product id of the arrangement account."},{"name":"currency","in":"query","type":"string","required":false,"description":"Identifies the currency. E.g. USD, GBP etc"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"ProductCatalogueResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"PUT","path":"/product/productManagers/{productId}","fullPath":"/api/v3.8.1/product/productManagers/{productId}","operationId":"updateProductManager","name":"Update the action such as proof and publish for the specific product","summary":"Update the action for product","tags":["RETAIL"],"parameters":[{"name":"productId","in":"path","type":"string","required":true,"description":"Contains the unique identifier of the product, e.g. the product id of the arrangement account."},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"displayName":"string","action":"string","availableDate":"2024-01-01","processingIndicator":"string","directPublish":"string","extensions":{}}},"responses":{"200":"ProductManagerResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/product/interestConditions","fullPath":"/api/v3.8.1/product/interestConditions","operationId":"getInterestConditionReference","name":"Retrieves all the available interest conditions","summary":"Retrieves all the available interest conditions","tags":[],"parameters":[{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"InterestConditionReferenceResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/product/products/{productId}/overpaymentRules","fullPath":"/api/v3.8.1/product/products/{productId}/overpaymentRules","operationId":"getProductOverpaymentDetails","name":"Retrieves the overpayment rule details like type of overpay, overpay limit and period defined for a product. Overpayment is excess repayments done in addition to mandate payments.","summary":"Retrieves the overpayment configurations done in a product","tags":["RETAIL"],"parameters":[{"name":"productId","in":"path","type":"string","required":true,"description":"Contains the unique identifier of the product, e.g. the product id of the arrangement account."},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"ProductOverpaymentDetailsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/product/products/buyNowPayLater","fullPath":"/api/v3.8.1/product/products/buyNowPayLater","operationId":"getLoanSimulation","name":"Qualifies and simulates the applicable buy now pay later products for the given amount and currency value and provides the product wise installments simulation results.","summary":"Qualifies the eligible buy now pay later products and perform simulation for the products","tags":["Loan Simulation"],"parameters":[{"name":"currencyId","in":"query","type":"string","required":false,"description":"Identifier of the currency. This is the 3-letter ISO 4217 code of the currency."},{"name":"loanAmount","in":"query","type":"integer","required":false,"description":"Indicates loan amount"},{"name":"productType","in":"query","type":"string","required":false,"description":"Indicates the product type for the deal"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"BnplLoanSimulationResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/product/{productId}/commitment/{amount}/period/{term}","fullPath":"/api/v3.8.1/product/{productId}/commitment/{amount}/period/{term}","operationId":"getRepaymentCalculator","name":"Retrieves the repayment details for the given product, principal amount and term","summary":"Retrieves the repayment details for the given product, principal amount and term","tags":[],"parameters":[{"name":"productId","in":"path","type":"string","required":true,"description":"Contains the unique identifier of the product, e.g. the product id of the arrangement account."},{"name":"amount","in":"path","type":"string","required":true,"description":"This is the payment amount"},{"name":"term","in":"path","type":"string","required":true,"description":"Indicates the period to which the BID and OFFER rates apply"},{"name":"currencyId","in":"query","type":"string","required":false,"description":"Identifier of the currency. This is the 3-letter ISO 4217 code of the currency."},{"name":"paymentFrequency","in":"query","type":"string","required":false,"description":"The frequency at which a payment is required to be generated"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"RepaymentCalculatorResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}}]},{"key":"product-products-v3.9.0","title":"Product Builder","version":"v3.9.0","description":"API to create, update and manage the product definition details, interest conditions, repayment calculator, simulate a loan contract and project the schedules","endpointCount":35,"endpoints":[{"method":"GET","path":"/product/productLines/{productLineId}/productGroups/{productGroupId}/products","fullPath":"/api/v3.9.0/product/productLines/{productLineId}/productGroups/{productGroupId}/products","operationId":"getProductsPerLineAndGroup","name":"Retrieves the details of all the products based on a given product line and product group","summary":"Retrieves the details of all the products based on a given product line and product group","tags":[],"parameters":[{"name":"productLineId","in":"path","type":"string","required":true,"description":"The top level product line, which the product is ultimately attached to. May be a Temenos-defined product line such as ACCOUNTS, AGENT, BUNDLE, CONSENT, DEPOSITS, LENDING, REWARDS, etc. or one defined"},{"name":"productGroupId","in":"path","type":"string","required":true,"description":"The group, as defined by the institution, that the product belongs to."},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"ProductsPerLineAndGroupResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/product/productLines/{productLineId}/productGroups","fullPath":"/api/v3.9.0/product/productLines/{productLineId}/productGroups","operationId":"getProductGroups","name":"Retrieves the details of all the products based on a given product line","summary":"Retrieves the details of all the products based on a given product line","tags":[],"parameters":[{"name":"productLineId","in":"path","type":"string","required":true,"description":"The top level product line, which the product is ultimately attached to. May be a Temenos-defined product line such as ACCOUNTS, AGENT, BUNDLE, CONSENT, DEPOSITS, LENDING, REWARDS, etc. or one defined"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"ProductGroupsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/product/productLines/{productLineId}/activities","fullPath":"/api/v3.9.0/product/productLines/{productLineId}/activities","operationId":"getProductLineActivities","name":"Retrieves the list of activities applicable for a given product line","summary":"Retrieves the list of activities applicable for a given product line","tags":[],"parameters":[{"name":"productLineId","in":"path","type":"string","required":true,"description":"The top level product line, which the product is ultimately attached to. May be a Temenos-defined product line such as ACCOUNTS, AGENT, BUNDLE, CONSENT, DEPOSITS, LENDING, REWARDS, etc. or one defined"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"ProductLineActivitiesResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/product/productLines","fullPath":"/api/v3.9.0/product/productLines","operationId":"getProductLines","name":"Retrieves the list of available product line","summary":"Retrieves the list of available product line","tags":[],"parameters":[{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"ProductLinesResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/product/products","fullPath":"/api/v3.9.0/product/products","operationId":"getAllProducts","name":"Retrieves all the products available in the catalogue","summary":"Retrieves all the products available in the catalogue","tags":["RETAIL"],"parameters":[{"name":"productLineId","in":"query","type":"string","required":false,"description":"The top level product line, which the product is ultimately attached to. May be a Temenos-defined product line such as ACCOUNTS, AGENT, BUNDLE, CONSENT, DEPOSITS, LENDING, REWARDS, etc. or one defined"},{"name":"productGroupId","in":"query","type":"string","required":false,"description":"The group, as defined by the institution, that the product belongs to."},{"name":"eligibilityFilter","in":"query","type":"string","required":false,"description":"Indicates the filter based on the Eligibility options available to the customer"},{"name":"multiBookEligible","in":"query","type":"string","required":false,"description":"Flag which indicates whether multi booking is applicable or not"},{"name":"productId","in":"query","type":"string","required":false,"description":"Contains the unique identifier of the product, e.g. the product id of the arrangement account."},{"name":"customerId","in":"query","type":"string","required":false,"description":"Identifier of the customer"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"AllProductsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/product/products/{productId}","fullPath":"/api/v3.9.0/product/products/{productId}","operationId":"getProducts","name":"Retrieves the details of a given product","summary":"Retrieves the details of a given product","tags":[],"parameters":[{"name":"productId","in":"path","type":"string","required":true,"description":""},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"ProductsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/product/propertyClasses","fullPath":"/api/v3.9.0/product/propertyClasses","operationId":"getPropertyClasses","name":"Retrieves the product's property class information, which is used for building products","summary":"Retrieves the product's property class information, which is used for building products","tags":[],"parameters":[{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"PropertyClassesResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/product/productGroups","fullPath":"/api/v3.9.0/product/productGroups","operationId":"getAllProductGroups","name":"Retrieves the list of product group available with its product line","summary":"Retrieves the list of product group available with its product line","tags":[],"parameters":[{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"AllProductGroupsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/product/{productId}","fullPath":"/api/v3.9.0/product/{productId}","operationId":"getProductDetails","name":"Retrieves the product details for a catalogued product","summary":"Retrieves the product details for a catalogued product","tags":[],"parameters":[{"name":"productId","in":"path","type":"string","required":true,"description":"Contains the unique identifier of the product, e.g. the product id of the arrangement account."},{"name":"currency","in":"query","type":"string","required":false,"description":"Identifies the currency. E.g. USD, GBP etc"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"ProductDetailsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/product/productBuilder/interestConditions","fullPath":"/api/v3.9.0/product/productBuilder/interestConditions","operationId":"getAllInterestConditions","name":"Retrieves the list of all the available interest conditions","summary":"Retrieves the list of all the available interest conditions","tags":[],"parameters":[{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"AllInterestConditionsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/product/productBuilder/interestConditions/{interestConditionId}","fullPath":"/api/v3.9.0/product/productBuilder/interestConditions/{interestConditionId}","operationId":"getInterestConditions","name":"Retrieves the details of the given interest condition","summary":"Retrieves the details of the given interest condition","tags":[],"parameters":[{"name":"interestConditionId","in":"path","type":"string","required":true,"description":"The identifier of the product condition used to define the interest rate"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"InterestConditionsResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"POST","path":"/product/productBuilder/interestConditions/{interestConditionId}","fullPath":"/api/v3.9.0/product/productBuilder/interestConditions/{interestConditionId}","operationId":"createInterestCondition","name":"Creates a new interest condition","summary":"Creates a new interest condition","tags":[],"parameters":[{"name":"interestConditionId","in":"path","type":"string","required":true,"description":"The identifier of the product condition used to define the interest rate"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"rates":[{}],"displayNames":[{}],"rateTierType":"string","linkedArrangement":"string","defaultNegotiable":"string","accrualRule":"string"}},"responses":{"200":"InterestConditionResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/product/productBuilder/interestConditions/{interestConditionId}","fullPath":"/api/v3.9.0/product/productBuilder/interestConditions/{interestConditionId}","operationId":"updateInterestCondition","name":"Updates an existing interest condition","summary":"Updates an existing interest condition","tags":[],"parameters":[{"name":"interestConditionId","in":"path","type":"string","required":true,"description":"The identifier of the product condition used to define the interest rate"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"rates":[{}],"displayNames":[{}],"rateTierType":"string","linkedArrangement":"string","defaultNegotiable":"string","accrualRule":"string"}},"responses":{"200":"InterestConditionResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/product/productBuilder/productConditions","fullPath":"/api/v3.9.0/product/productBuilder/productConditions","operationId":"getProductConditions","name":"Retrieves the list of product conditions available","summary":"Retrieves the list of product conditions available","tags":[],"parameters":[{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"ProductConditionsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/product/productBuilder/properties","fullPath":"/api/v3.9.0/product/productBuilder/properties","operationId":"getProperties","name":"Retrieves the details of all the available properties","summary":"Retrieves the details of all the available properties","tags":[],"parameters":[{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"PropertiesResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/product/productBuilder/projects","fullPath":"/api/v3.9.0/product/productBuilder/projects","operationId":"getProjects","name":"Retrieves the list of available projects created to build a product","summary":"Retrieves the list of available projects created to build a product","tags":[],"parameters":[{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"ProjectsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"POST","path":"/product/loans/simulations","fullPath":"/api/v3.9.0/product/loans/simulations","operationId":"createSynchronousSimulation","name":"Simulate a loan arrangement for the given principal amount, term, payment frequency and interest rates","summary":"Simulate a loan arrangement for the given principal amount, term, payment frequency and interest rates","tags":[],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"customerIds":[{}],"properties":[{}],"overrides":[{}],"productId":"string","masterArrangementId":"string","roleName":"string","currencyId":"string","effectiveDate":"2024-01-01","activityId":"string","transactionAmount":0.0}},"responses":{"200":"createSynchronousSimulationResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"POST","path":"/product/loans/simulations/schedules","fullPath":"/api/v3.9.0/product/loans/simulations/schedules","operationId":"createSynchronousSimulationSchedules","name":"Simulate a loan arrangement for the given principal amount, term, payment frequency and interest rates. It also retrieves the details of payment schedules for the simulated contract","summary":"Simulate a loan arrangement and retrieve the payment schedule details","tags":[],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"customerIds":[{}],"properties":[{}],"overrides":[{}],"productId":"string","masterArrangementId":"string","roleName":"string","currencyId":"string","effectiveDate":"2024-01-01","activityId":"string","transactionAmount":0.0}},"responses":{"200":"createSynchronousSimulationSchedulesResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"GET","path":"/product/productTypes","fullPath":"/api/v3.9.0/product/productTypes","operationId":"getAllProductTypes","name":"Retrieves the list of product types available in the Transact system","summary":"Retrieves the list of product types available in the Transact system","tags":[],"parameters":[{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"AllProductTypesResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/product/productTypes/{productType}","fullPath":"/api/v3.9.0/product/productTypes/{productType}","operationId":"getProductType","name":"Retrieves the product type details for a given product type","summary":"Retrieves the product type details for a given product type","tags":[],"parameters":[{"name":"productType","in":"path","type":"string","required":true,"description":"Deprecated - Indicates the identifier(s) of a Blueprint product from which an actual product can be created"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"ProductTypeResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/product/productTypes/products/{productId}","fullPath":"/api/v3.9.0/product/productTypes/products/{productId}","operationId":"getProductStatus","name":"Retrieves the basic details such as product details,status,proof and publish errors if any","summary":"Retrieves the basic details of a given product","tags":[],"parameters":[{"name":"productId","in":"path","type":"string","required":true,"description":"Contains the unique identifier of the product, e.g. the product id of the arrangement account."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"ProductStatusResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"POST","path":"/product/productTypes/products/{productId}","fullPath":"/api/v3.9.0/product/productTypes/products/{productId}","operationId":"createProducts","name":"Create a product from a product type","summary":"Create a product using the conditions available from the product type","tags":[],"parameters":[{"name":"productId","in":"path","type":"string","required":true,"description":"Contains the unique identifier of the product, e.g. the product id of the arrangement account."},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"id":"string","status":"string","transactionStatus":"string","uniqueIdentifier":"string","audit":{"T24_time":{},"versionNumber":{},"requestParse_time":{},"responseParse_time":{}}},"body":{"productType":"string","productId":"string","productGroupId":"string","productLineId":"string","productName":"string","applyToAllAccounts":"string","productCode":"string","productDescription":"string","availableCurrency":[{}],"effectiveDate":"string","version":"string","productAttributes":[{}],"propertyList":[{}]}},"responses":{"200":"ProductsResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/product/productTypes/products/{productId}","fullPath":"/api/v3.9.0/product/productTypes/products/{productId}","operationId":"updateProducts","name":"Update a product such as property conditions and its condition values","summary":"Update a product such as property conditions and its condition values","tags":[],"parameters":[{"name":"productId","in":"path","type":"string","required":true,"description":"Contains the unique identifier of the product, e.g. the product id of the arrangement account."},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"id":"string","status":"string","transactionStatus":"string","uniqueIdentifier":"string","audit":{"T24_time":{},"versionNumber":{},"requestParse_time":{},"responseParse_time":{}}},"body":{"productType":"string","productId":"string","productGroupId":"string","productLineId":"string","productName":"string","applyToAllAccounts":"string","productCode":"string","productDescription":"string","availableCurrency":[{}],"effectiveDate":"string","version":"string","productAttributes":[{}],"propertyList":[{}]}},"responses":{"200":"ProductsResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/product/productFeatures/{productFeatureId}/attributes","fullPath":"/api/v3.9.0/product/productFeatures/{productFeatureId}/attributes","operationId":"getPropertyFields","name":"Retrieves the attribute and the field structure for the given product feature","summary":"Retrieves the attribute and the field structure","tags":[],"parameters":[{"name":"productFeatureId","in":"path","type":"string","required":true,"description":""},{"name":"productConditionId","in":"query","type":"string","required":false,"description":"The identifier of the product condition"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"PropertyFieldsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/product/productGroups/{productGroupId}/productFeatures/productConditions","fullPath":"/api/v3.9.0/product/productGroups/{productGroupId}/productFeatures/productConditions","operationId":"getProductLineFeatureConditions","name":"Retrieves the product conditions for the product features present in the product group","summary":"Retrieves the product conditions for the product features","tags":[],"parameters":[{"name":"productGroupId","in":"path","type":"string","required":true,"description":"The group, as defined by the institution, that the product belongs to."},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"ProductLineFeatureConditionsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/product/productConditions/{productConditionId}","fullPath":"/api/v3.9.0/product/productConditions/{productConditionId}","operationId":"getConditionGenerator","name":"Retrieves the base condition details of a product feature such as the attributes ,their field name and values,status and validation errors if any","summary":"Retrieves the base condition details of a product feature","tags":[],"parameters":[{"name":"productConditionId","in":"path","type":"string","required":true,"description":"The identifier of the product condition"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"ConditionGeneratorResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"POST","path":"/product/productConditions/{productConditionId}","fullPath":"/api/v3.9.0/product/productConditions/{productConditionId}","operationId":"createConditionGenerator","name":"Create the product condition for the product feature based on the attributes and their field name and values","summary":"Create the product condition for the product feature","tags":[],"parameters":[{"name":"productConditionId","in":"path","type":"string","required":true,"description":"The identifier of the product condition"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"propertyId":"string","conditionName":"string","effectiveDate":"string","currencies":[{}]}},"responses":{"200":"ConditionGeneratorResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/product/productConditions/{productConditionId}","fullPath":"/api/v3.9.0/product/productConditions/{productConditionId}","operationId":"updateConditionGenerator","name":"Update the product condition for the product feature based on the attributes and their field name and values","summary":"Update the product condition for the product feature","tags":[],"parameters":[{"name":"productConditionId","in":"path","type":"string","required":true,"description":"The identifier of the product condition"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"propertyId":"string","conditionName":"string","effectiveDate":"string","currencies":[{}]}},"responses":{"200":"ConditionGeneratorResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/product/productFeatures","fullPath":"/api/v3.9.0/product/productFeatures","operationId":"getProductLineFeatures","name":"Returns the list of product features, its currency type and supports base conditions or not","summary":"Returns the list of product features","tags":[],"parameters":[{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"FeatureTypesResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/product/{productId}/productConditions","fullPath":"/api/v3.9.0/product/{productId}/productConditions","operationId":"getProductCatalogue","name":"Retrieves the catalogued conditions of a given product","summary":"Retrieves the catalogued conditions of a given product","tags":["RETAIL"],"parameters":[{"name":"productId","in":"path","type":"string","required":true,"description":"Contains the unique identifier of the product, e.g. the product id of the arrangement account."},{"name":"currency","in":"query","type":"string","required":false,"description":"Identifies the currency. E.g. USD, GBP etc"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"ProductCatalogueResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"PUT","path":"/product/productManagers/{productId}","fullPath":"/api/v3.9.0/product/productManagers/{productId}","operationId":"updateProductManager","name":"Update the action such as proof and publish for the specific product","summary":"Update the action for product","tags":["RETAIL"],"parameters":[{"name":"productId","in":"path","type":"string","required":true,"description":"Contains the unique identifier of the product, e.g. the product id of the arrangement account."},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"displayName":"string","action":"string","availableDate":"2024-01-01","processingIndicator":"string","directPublish":"string","extensions":{}}},"responses":{"200":"ProductManagerResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/product/interestConditions","fullPath":"/api/v3.9.0/product/interestConditions","operationId":"getInterestConditionReference","name":"Retrieves all the available interest conditions","summary":"Retrieves all the available interest conditions","tags":[],"parameters":[{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"InterestConditionReferenceResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/product/products/{productId}/overpaymentRules","fullPath":"/api/v3.9.0/product/products/{productId}/overpaymentRules","operationId":"getProductOverpaymentDetails","name":"Retrieves the overpayment rule details like type of overpay, overpay limit and period defined for a product. Overpayment is excess repayments done in addition to mandate payments.","summary":"Retrieves the overpayment configurations done in a product","tags":["RETAIL"],"parameters":[{"name":"productId","in":"path","type":"string","required":true,"description":"Contains the unique identifier of the product, e.g. the product id of the arrangement account."},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"ProductOverpaymentDetailsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/product/products/buyNowPayLater","fullPath":"/api/v3.9.0/product/products/buyNowPayLater","operationId":"getLoanSimulation","name":"Qualifies and simulates the applicable buy now pay later products for the given amount and currency value and provides the product wise installments simulation results.","summary":"Qualifies the eligible buy now pay later products and perform simulation for the products","tags":["Loan Simulation"],"parameters":[{"name":"currencyId","in":"query","type":"string","required":false,"description":"Identifier of the currency. This is the 3-letter ISO 4217 code of the currency."},{"name":"loanAmount","in":"query","type":"integer","required":false,"description":"Indicates loan amount"},{"name":"productType","in":"query","type":"string","required":false,"description":"Indicates the product type for the deal"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"BnplLoanSimulationResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/product/{productId}/commitment/{amount}/period/{term}","fullPath":"/api/v3.9.0/product/{productId}/commitment/{amount}/period/{term}","operationId":"getRepaymentCalculator","name":"Retrieves the repayment details for the given product, principal amount and term","summary":"Retrieves the repayment details for the given product, principal amount and term","tags":[],"parameters":[{"name":"productId","in":"path","type":"string","required":true,"description":"Contains the unique identifier of the product, e.g. the product id of the arrangement account."},{"name":"amount","in":"path","type":"string","required":true,"description":"This is the payment amount"},{"name":"term","in":"path","type":"string","required":true,"description":"Indicates the period to which the BID and OFFER rates apply"},{"name":"currencyId","in":"query","type":"string","required":false,"description":"Identifier of the currency. This is the 3-letter ISO 4217 code of the currency."},{"name":"paymentFrequency","in":"query","type":"string","required":false,"description":"The frequency at which a payment is required to be generated"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"RepaymentCalculatorResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}}]},{"key":"product-products-v4.0.0","title":"Product Builder","version":"v4.0.0","description":"API to create, update and manage the product definition details, interest conditions, repayment calculator, simulate a loan contract and project the schedules","endpointCount":35,"endpoints":[{"method":"GET","path":"/product/productLines/{productLineId}/productGroups/{productGroupId}/products","fullPath":"/api/v4.0.0/product/productLines/{productLineId}/productGroups/{productGroupId}/products","operationId":"getProductsPerLineAndGroup","name":"Retrieves the details of all the products based on a given product line and product group","summary":"Retrieves the details of all the products based on a given product line and product group","tags":["RETAIL"],"parameters":[{"name":"productLineId","in":"path","type":"string","required":true,"description":"The top level product line, which the product is ultimately attached to. May be a Temenos-defined product line such as ACCOUNTS, AGENT, BUNDLE, CONSENT, DEPOSITS, LENDING, REWARDS, etc. or one defined"},{"name":"productGroupId","in":"path","type":"string","required":true,"description":"The group, as defined by the institution, that the product belongs to."},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"ProductsPerLineAndGroupResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/product/productLines/{productLineId}/productGroups","fullPath":"/api/v4.0.0/product/productLines/{productLineId}/productGroups","operationId":"getProductGroups","name":"Retrieves the details of all the products based on a given product line","summary":"Retrieves the details of all the products based on a given product line","tags":["RETAIL"],"parameters":[{"name":"productLineId","in":"path","type":"string","required":true,"description":"The top level product line, which the product is ultimately attached to. May be a Temenos-defined product line such as ACCOUNTS, AGENT, BUNDLE, CONSENT, DEPOSITS, LENDING, REWARDS, etc. or one defined"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"ProductGroupsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/product/productLines/{productLineId}/activities","fullPath":"/api/v4.0.0/product/productLines/{productLineId}/activities","operationId":"getProductLineActivities","name":"Retrieves the list of activities applicable for a given product line","summary":"Retrieves the list of activities applicable for a given product line","tags":["RETAIL"],"parameters":[{"name":"productLineId","in":"path","type":"string","required":true,"description":"The top level product line, which the product is ultimately attached to. May be a Temenos-defined product line such as ACCOUNTS, AGENT, BUNDLE, CONSENT, DEPOSITS, LENDING, REWARDS, etc. or one defined"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"ProductLineActivitiesResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/product/productLines","fullPath":"/api/v4.0.0/product/productLines","operationId":"getProductLines","name":"Retrieves the list of available product line","summary":"Retrieves the list of available product line","tags":["RETAIL"],"parameters":[{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"ProductLinesResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/product/products","fullPath":"/api/v4.0.0/product/products","operationId":"getAllProducts","name":"Retrieves all the products available in the catalogue","summary":"Retrieves all the products available in the catalogue","tags":["RETAIL"],"parameters":[{"name":"productLineId","in":"query","type":"string","required":false,"description":"The top level product line, which the product is ultimately attached to. May be a Temenos-defined product line such as ACCOUNTS, AGENT, BUNDLE, CONSENT, DEPOSITS, LENDING, REWARDS, etc. or one defined"},{"name":"productGroupId","in":"query","type":"string","required":false,"description":"The group, as defined by the institution, that the product belongs to."},{"name":"eligibilityFilter","in":"query","type":"string","required":false,"description":"Indicates the filter based on the Eligibility options available to the customer"},{"name":"multiBookEligible","in":"query","type":"string","required":false,"description":"Flag which indicates whether multi booking is applicable or not"},{"name":"productId","in":"query","type":"string","required":false,"description":"Contains the unique identifier of the product, e.g. the product id of the arrangement account."},{"name":"customerId","in":"query","type":"string","required":false,"description":"Identifier of the customer"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"AllProductsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/product/products/{productId}","fullPath":"/api/v4.0.0/product/products/{productId}","operationId":"getProducts","name":"Retrieves the details of a given product","summary":"Retrieves the details of a given product","tags":["RETAIL"],"parameters":[{"name":"productId","in":"path","type":"string","required":true,"description":""},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"ProductsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/product/propertyClasses","fullPath":"/api/v4.0.0/product/propertyClasses","operationId":"getPropertyClasses","name":"Retrieves the product's property class information, which is used for building products","summary":"Retrieves the product's property class information, which is used for building products","tags":["RETAIL"],"parameters":[{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"PropertyClassesResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/product/productGroups","fullPath":"/api/v4.0.0/product/productGroups","operationId":"getAllProductGroups","name":"Retrieves the list of product group available with its product line","summary":"Retrieves the list of product group available with its product line","tags":["RETAIL"],"parameters":[{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"AllProductGroupsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/product/{productId}","fullPath":"/api/v4.0.0/product/{productId}","operationId":"getProductDetails","name":"Retrieves the product details for a catalogued product","summary":"Retrieves the product details for a catalogued product","tags":["RETAIL"],"parameters":[{"name":"productId","in":"path","type":"string","required":true,"description":"Contains the unique identifier of the product, e.g. the product id of the arrangement account."},{"name":"currency","in":"query","type":"string","required":false,"description":"Identifies the currency. E.g. USD, GBP etc"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"ProductDetailsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/product/productBuilder/interestConditions","fullPath":"/api/v4.0.0/product/productBuilder/interestConditions","operationId":"getAllInterestConditions","name":"Retrieves the list of all the available interest conditions","summary":"Retrieves the list of all the available interest conditions","tags":["RETAIL"],"parameters":[{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"AllInterestConditionsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/product/productBuilder/interestConditions/{interestConditionId}","fullPath":"/api/v4.0.0/product/productBuilder/interestConditions/{interestConditionId}","operationId":"getInterestConditions","name":"Retrieves the details of the given interest condition","summary":"Retrieves the details of the given interest condition","tags":["RETAIL"],"parameters":[{"name":"interestConditionId","in":"path","type":"string","required":true,"description":"The identifier of the product condition used to define the interest rate"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"InterestConditionsResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"POST","path":"/product/productBuilder/interestConditions/{interestConditionId}","fullPath":"/api/v4.0.0/product/productBuilder/interestConditions/{interestConditionId}","operationId":"createInterestCondition","name":"Creates a new interest condition","summary":"Creates a new interest condition","tags":["RETAIL"],"parameters":[{"name":"interestConditionId","in":"path","type":"string","required":true,"description":"The identifier of the product condition used to define the interest rate"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"rates":[{}],"displayNames":[{}],"rateTierType":"string","linkedArrangement":"string","defaultNegotiable":"string","accrualRule":"string"}},"responses":{"200":"InterestConditionResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/product/productBuilder/interestConditions/{interestConditionId}","fullPath":"/api/v4.0.0/product/productBuilder/interestConditions/{interestConditionId}","operationId":"updateInterestCondition","name":"Updates an existing interest condition","summary":"Updates an existing interest condition","tags":["RETAIL"],"parameters":[{"name":"interestConditionId","in":"path","type":"string","required":true,"description":"The identifier of the product condition used to define the interest rate"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"rates":[{}],"displayNames":[{}],"rateTierType":"string","linkedArrangement":"string","defaultNegotiable":"string","accrualRule":"string"}},"responses":{"200":"InterestConditionResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/product/productBuilder/productConditions","fullPath":"/api/v4.0.0/product/productBuilder/productConditions","operationId":"getProductConditions","name":"Retrieves the list of product conditions available","summary":"Retrieves the list of product conditions available","tags":["RETAIL"],"parameters":[{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"ProductConditionsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/product/productBuilder/properties","fullPath":"/api/v4.0.0/product/productBuilder/properties","operationId":"getProperties","name":"Retrieves the details of all the available properties","summary":"Retrieves the details of all the available properties","tags":["RETAIL"],"parameters":[{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"PropertiesResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/product/productBuilder/projects","fullPath":"/api/v4.0.0/product/productBuilder/projects","operationId":"getProjects","name":"Retrieves the list of available projects created to build a product","summary":"Retrieves the list of available projects created to build a product","tags":["RETAIL"],"parameters":[{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"ProjectsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"POST","path":"/product/loans/simulations","fullPath":"/api/v4.0.0/product/loans/simulations","operationId":"createSynchronousSimulation","name":"Simulate a loan arrangement for the given principal amount, term, payment frequency and interest rates","summary":"Simulate a loan arrangement for the given principal amount, term, payment frequency and interest rates","tags":["RETAIL"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"customerIds":[{}],"properties":[{}],"overrides":[{}],"productId":"string","masterArrangementId":"string","roleName":"string","currencyId":"string","effectiveDate":"2024-01-01","activityId":"string","transactionAmount":0.0}},"responses":{"200":"createSynchronousSimulationResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"POST","path":"/product/loans/simulations/schedules","fullPath":"/api/v4.0.0/product/loans/simulations/schedules","operationId":"createSynchronousSimulationSchedules","name":"Simulate a loan arrangement for the given principal amount, term, payment frequency and interest rates. It also retrieves the details of payment schedules for the simulated contract","summary":"Simulate a loan arrangement and retrieve the payment schedule details","tags":["RETAIL"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"customerIds":[{}],"properties":[{}],"overrides":[{}],"productId":"string","masterArrangementId":"string","roleName":"string","currencyId":"string","effectiveDate":"2024-01-01","activityId":"string","transactionAmount":0.0}},"responses":{"200":"createSynchronousSimulationSchedulesResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"GET","path":"/product/productTypes","fullPath":"/api/v4.0.0/product/productTypes","operationId":"getAllProductTypes","name":"Retrieves the list of product types available in the Transact system","summary":"Retrieves the list of product types available in the Transact system","tags":["RETAIL"],"parameters":[{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"AllProductTypesResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/product/productTypes/{productType}","fullPath":"/api/v4.0.0/product/productTypes/{productType}","operationId":"getProductType","name":"Retrieves the product type details for a given product type","summary":"Retrieves the product type details for a given product type","tags":["RETAIL"],"parameters":[{"name":"productType","in":"path","type":"string","required":true,"description":"Deprecated - Indicates the identifier(s) of a Blueprint product from which an actual product can be created"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"ProductTypeResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/product/productTypes/products/{productId}","fullPath":"/api/v4.0.0/product/productTypes/products/{productId}","operationId":"getProductStatus","name":"Retrieves the basic details such as product details,status,proof and publish errors if any","summary":"Retrieves the basic details of a given product","tags":["RETAIL"],"parameters":[{"name":"productId","in":"path","type":"string","required":true,"description":"Contains the unique identifier of the product, e.g. the product id of the arrangement account."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"ProductStatusResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"POST","path":"/product/productTypes/products/{productId}","fullPath":"/api/v4.0.0/product/productTypes/products/{productId}","operationId":"createProducts","name":"Create a product from a product type","summary":"Create a product using the conditions available from the product type","tags":["RETAIL"],"parameters":[{"name":"productId","in":"path","type":"string","required":true,"description":"Contains the unique identifier of the product, e.g. the product id of the arrangement account."},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"id":"string","status":"string","transactionStatus":"string","uniqueIdentifier":"string","audit":{"T24_time":{},"versionNumber":{},"requestParse_time":{},"responseParse_time":{}}},"body":{"productType":"string","productId":"string","productGroupId":"string","productLineId":"string","productName":"string","applyToAllAccounts":"string","productCode":"string","productDescription":"string","availableCurrency":[{}],"effectiveDate":"string","version":"string","productAttributes":[{}],"propertyList":[{}]}},"responses":{"200":"ProductsResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/product/productTypes/products/{productId}","fullPath":"/api/v4.0.0/product/productTypes/products/{productId}","operationId":"updateProducts","name":"Update a product such as property conditions and its condition values","summary":"Update a product such as property conditions and its condition values","tags":["RETAIL"],"parameters":[{"name":"productId","in":"path","type":"string","required":true,"description":"Contains the unique identifier of the product, e.g. the product id of the arrangement account."},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"id":"string","status":"string","transactionStatus":"string","uniqueIdentifier":"string","audit":{"T24_time":{},"versionNumber":{},"requestParse_time":{},"responseParse_time":{}}},"body":{"productType":"string","productId":"string","productGroupId":"string","productLineId":"string","productName":"string","applyToAllAccounts":"string","productCode":"string","productDescription":"string","availableCurrency":[{}],"effectiveDate":"string","version":"string","productAttributes":[{}],"propertyList":[{}]}},"responses":{"200":"ProductsResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/product/productFeatures/{productFeatureId}/attributes","fullPath":"/api/v4.0.0/product/productFeatures/{productFeatureId}/attributes","operationId":"getPropertyFields","name":"Retrieves the attribute and the field structure for the given product feature","summary":"Retrieves the attribute and the field structure","tags":["RETAIL"],"parameters":[{"name":"productFeatureId","in":"path","type":"string","required":true,"description":""},{"name":"productConditionId","in":"query","type":"string","required":false,"description":"The identifier of the product condition"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"PropertyFieldsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/product/productGroups/{productGroupId}/productFeatures/productConditions","fullPath":"/api/v4.0.0/product/productGroups/{productGroupId}/productFeatures/productConditions","operationId":"getProductLineFeatureConditions","name":"Retrieves the product conditions for the product features present in the product group","summary":"Retrieves the product conditions for the product features","tags":["RETAIL"],"parameters":[{"name":"productGroupId","in":"path","type":"string","required":true,"description":"The group, as defined by the institution, that the product belongs to."},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"ProductLineFeatureConditionsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/product/productConditions/{productConditionId}","fullPath":"/api/v4.0.0/product/productConditions/{productConditionId}","operationId":"getConditionGenerator","name":"Retrieves the base condition details of a product feature such as the attributes ,their field name and values,status and validation errors if any","summary":"Retrieves the base condition details of a product feature","tags":["RETAIL"],"parameters":[{"name":"productConditionId","in":"path","type":"string","required":true,"description":"The identifier of the product condition"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"ConditionGeneratorResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"POST","path":"/product/productConditions/{productConditionId}","fullPath":"/api/v4.0.0/product/productConditions/{productConditionId}","operationId":"createConditionGenerator","name":"Create the product condition for the product feature based on the attributes and their field name and values","summary":"Create the product condition for the product feature","tags":["RETAIL"],"parameters":[{"name":"productConditionId","in":"path","type":"string","required":true,"description":"The identifier of the product condition"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"propertyId":"string","conditionName":"string","effectiveDate":"string","currencies":[{}]}},"responses":{"200":"ConditionGeneratorResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/product/productConditions/{productConditionId}","fullPath":"/api/v4.0.0/product/productConditions/{productConditionId}","operationId":"updateConditionGenerator","name":"Update the product condition for the product feature based on the attributes and their field name and values","summary":"Update the product condition for the product feature","tags":["RETAIL"],"parameters":[{"name":"productConditionId","in":"path","type":"string","required":true,"description":"The identifier of the product condition"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"propertyId":"string","conditionName":"string","effectiveDate":"string","currencies":[{}]}},"responses":{"200":"ConditionGeneratorResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/product/productFeatures","fullPath":"/api/v4.0.0/product/productFeatures","operationId":"getProductLineFeatures","name":"Returns the list of product features, its currency type and supports base conditions or not","summary":"Returns the list of product features","tags":["RETAIL"],"parameters":[{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"FeatureTypesResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/product/{productId}/productConditions","fullPath":"/api/v4.0.0/product/{productId}/productConditions","operationId":"getProductCatalogue","name":"Retrieves the catalogued conditions of a given product","summary":"Retrieves the catalogued conditions of a given product","tags":["RETAIL"],"parameters":[{"name":"productId","in":"path","type":"string","required":true,"description":"Contains the unique identifier of the product, e.g. the product id of the arrangement account."},{"name":"currency","in":"query","type":"string","required":false,"description":"Identifies the currency. E.g. USD, GBP etc"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"ProductCatalogueResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"PUT","path":"/product/productManagers/{productId}","fullPath":"/api/v4.0.0/product/productManagers/{productId}","operationId":"updateProductManager","name":"Update the action such as proof and publish for the specific product","summary":"Update the action for product","tags":["RETAIL"],"parameters":[{"name":"productId","in":"path","type":"string","required":true,"description":"Contains the unique identifier of the product, e.g. the product id of the arrangement account."},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"displayName":"string","action":"string","availableDate":"2024-01-01","processingIndicator":"string","directPublish":"string","extensions":{}}},"responses":{"200":"ProductManagerResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/product/interestConditions","fullPath":"/api/v4.0.0/product/interestConditions","operationId":"getInterestConditionReference","name":"Retrieves all the available interest conditions","summary":"Retrieves all the available interest conditions","tags":["RETAIL"],"parameters":[{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"InterestConditionReferenceResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/product/products/{productId}/overpaymentRules","fullPath":"/api/v4.0.0/product/products/{productId}/overpaymentRules","operationId":"getProductOverpaymentDetails","name":"Retrieves the overpayment rule details like type of overpay, overpay limit and period defined for a product. Overpayment is excess repayments done in addition to mandate payments.","summary":"Retrieves the overpayment configurations done in a product","tags":["RETAIL"],"parameters":[{"name":"productId","in":"path","type":"string","required":true,"description":"Contains the unique identifier of the product, e.g. the product id of the arrangement account."},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"ProductOverpaymentDetailsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/product/products/buyNowPayLater","fullPath":"/api/v4.0.0/product/products/buyNowPayLater","operationId":"getLoanSimulation","name":"Qualifies and simulates the applicable buy now pay later products for the given amount and currency value and provides the product wise installments simulation results.","summary":"Qualifies the eligible buy now pay later products and perform simulation for the products","tags":["RETAIL"],"parameters":[{"name":"currencyId","in":"query","type":"string","required":false,"description":"Identifier of the currency. This is the 3-letter ISO 4217 code of the currency."},{"name":"loanAmount","in":"query","type":"integer","required":false,"description":"Indicates loan amount"},{"name":"productType","in":"query","type":"string","required":false,"description":"Indicates the product type for the deal"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"BnplLoanSimulationResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/product/{productId}/commitment/{amount}/period/{term}","fullPath":"/api/v4.0.0/product/{productId}/commitment/{amount}/period/{term}","operationId":"getRepaymentCalculator","name":"Retrieves the repayment details for the given product, principal amount and term","summary":"Retrieves the repayment details for the given product, principal amount and term","tags":["RETAIL"],"parameters":[{"name":"productId","in":"path","type":"string","required":true,"description":"Contains the unique identifier of the product, e.g. the product id of the arrangement account."},{"name":"amount","in":"path","type":"string","required":true,"description":"This is the payment amount"},{"name":"term","in":"path","type":"string","required":true,"description":"Indicates the period to which the BID and OFFER rates apply"},{"name":"currencyId","in":"query","type":"string","required":false,"description":"Identifier of the currency. This is the 3-letter ISO 4217 code of the currency."},{"name":"paymentFrequency","in":"query","type":"string","required":false,"description":"The frequency at which a payment is required to be generated"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"RepaymentCalculatorResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}}]},{"key":"product-profile-ifrs-v1.0.0","title":"IFRS Product Default Probability","version":"v1.0.0","description":"Update probability of default (the probability that the asset will default) and loss given default (the loss percentage given that when the asset default) at product or group of product level to calculate the expected credit loss based on their stages under IFRS 9 impairment model.","endpointCount":1,"endpoints":[{"method":"PUT","path":"/product/provisioningProfile/{provisioningProfileId}/ifrs/lossProbabilities","fullPath":"/api/v1.0.0/product/provisioningProfile/{provisioningProfileId}/ifrs/lossProbabilities","operationId":"updateProductLossProbability","name":"Update probability of default(PD) and loss given default(LGD) at product or group of product level to calculate the expected credit loss (ECL) provisioning in IFRS 9 Impairment Model","summary":"Update probability of default and loss given default on product","tags":[],"parameters":[{"name":"provisioningProfileId","in":"path","type":"string","required":true,"description":"Unique identifier of the provisioning profile. It will be in the format <Alphanumeric name>-date. Example: LOAN-20220101"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"probabilityOfDefaults":[{}],"lossGivenDefault":"string","extensions":{}}},"responses":{"200":"ProductLossProbabilityResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}}]},{"key":"product-userAdmin-service-v1.0.0","title":"External user product conditions","version":"v1.0.0","description":"API to retrieve the external user specific product conditions like Permissions, privileges, licensing, limits and availability","endpointCount":6,"endpoints":[{"method":"GET","path":"/product/{productId}/protectionLimitConditions","fullPath":"/api/v1.0.0/v1.0.0/product/{productId}/protectionLimitConditions","operationId":"getProtectionLimitConditions","name":"Retrieves the list of protection limit property classess used by products which have daily limits on the cumulative amount of transactions that can be initiated via an external channel.","summary":"Retrieves the limit details","tags":[],"parameters":[{"name":"productId","in":"path","type":"string","required":true,"description":"Contains the unique identifier of the product, e.g. the product id of the arrangement account."},{"name":"propertyId","in":"query","type":"string","required":false,"description":"The identifier of the product condition"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"ProtectionLimitConditionsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/product/{productId}/availabilityConditions","fullPath":"/api/v1.0.0/v1.0.0/product/{productId}/availabilityConditions","operationId":"getAvailabilityConditions","name":"Retrieves the list of published product conditions for the availability property","summary":"Retrieves the availability details","tags":[],"parameters":[{"name":"productId","in":"path","type":"string","required":true,"description":"Contains the unique identifier of the product, e.g. the product id of the arrangement account."},{"name":"propertyId","in":"query","type":"string","required":false,"description":"The identifier of the product condition"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"AvailabilityConditionsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/product/{productLineId}/products","fullPath":"/api/v1.0.0/v1.0.0/product/{productLineId}/products","operationId":"getProductsByProductLine","name":"Retrieves the details of the proofed and published properties of the product on the latest date","summary":"Retrieves the products","tags":[],"parameters":[{"name":"productLineId","in":"path","type":"string","required":true,"description":"The top level product line, which the product is ultimately attached to. May be a Temenos-defined product line such as ACCOUNTS, AGENT, BUNDLE, CONSENT, DEPOSITS, LENDING, REWARDS, etc. or one defined"},{"name":"productGroupId","in":"query","type":"string","required":false,"description":"The group, as defined by the institution, that the product belongs to."},{"name":"eligibilityFilter","in":"query","type":"string","required":false,"description":"Indicates the filter based on the Eligibility options available to the customer"},{"name":"multiBookEligible","in":"query","type":"string","required":false,"description":"Flag which indicates whether multi booking is applicable or not"},{"name":"productId","in":"query","type":"string","required":false,"description":"Contains the unique identifier of the product, e.g. the product id of the arrangement account."},{"name":"customerId","in":"query","type":"string","required":false,"description":"Identifier of the customer"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"ProductsByProductLineResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/product/{productId}/permissionConditions","fullPath":"/api/v1.0.0/v1.0.0/product/{productId}/permissionConditions","operationId":"getPermissionConditions","name":"Retrieves the list of published product conditions for the permissions property","summary":"Retrieves the permissions","tags":[],"parameters":[{"name":"productId","in":"path","type":"string","required":true,"description":"Contains the unique identifier of the product, e.g. the product id of the arrangement account."},{"name":"propertyId","in":"query","type":"string","required":false,"description":"The identifier of the product condition"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"PermissionConditionsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/product/{productId}/licensingConditions","fullPath":"/api/v1.0.0/v1.0.0/product/{productId}/licensingConditions","operationId":"getLicensingConditions","name":"Retrieves the list of published product conditions for the licensing property","summary":"Retrieves the licensing condition","tags":[],"parameters":[{"name":"productId","in":"path","type":"string","required":true,"description":"Contains the unique identifier of the product, e.g. the product id of the arrangement account."},{"name":"propertyId","in":"query","type":"string","required":false,"description":"The identifier of the product condition"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"LicensingConditionsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/product/{productId}/privilegeConditions","fullPath":"/api/v1.0.0/v1.0.0/product/{productId}/privilegeConditions","operationId":"getPrivilegeConditions","name":"Retrieves the list of published product conditions  for the privileges property","summary":"Retrieves the priveleges","tags":[],"parameters":[{"name":"productId","in":"path","type":"string","required":true,"description":"Contains the unique identifier of the product, e.g. the product id of the arrangement account."},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"PrivilegeConditionsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}}]}]},{"name":"Products","serviceCount":1,"endpointCount":23,"services":[{"key":"products-cashmanagement-bundles-v1.0.0","title":"Cash management - Bundle arrangement conditions","version":"v1.0.0","description":"API to create, amend and retrieve the bundle arrangement conditions","endpointCount":23,"endpoints":[{"method":"POST","path":"/product/cashManagement/bundles/accounts/summaryAccounts/debitInterestConditions","fullPath":"/api/v1.0.0/product/cashManagement/bundles/accounts/summaryAccounts/debitInterestConditions","operationId":"updateSummaryAccountDebitInterestConditions","name":"Update Debit Interest condition for Summary Accounts","summary":"Update Debit Interest condition for Summary Accounts","tags":[],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"The identifier of the underlying Entity/Company/Branch."}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"arrangementCustomerIds":[{}],"arrangementEffectiveDate":"string","productId":"string","activityId":"string","drinterest":{"interest":{},"attributes":{},"tiers":{},"linkedProperty":{}}}},"responses":{"200":"updateSummaryAccountDebitInterestConditionsResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"POST","path":"/product/cashManagement/bundles/accounts/currencySummaryAccounts/debitInterestConditions","fullPath":"/api/v1.0.0/product/cashManagement/bundles/accounts/currencySummaryAccounts/debitInterestConditions","operationId":"updateCurrencyAccountDebitInterestConditions","name":"Update Debit Interest condition for Currency Accounts","summary":"Update Debit Interest condition for Currency Accounts","tags":[],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"The identifier of the underlying Entity/Company/Branch."}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"arrangementCustomerIds":[{}],"arrangementEffectiveDate":"string","productId":"string","activityId":"string","drinterest":{"interest":{},"attributes":{},"tiers":{},"linkedProperty":{}}}},"responses":{"200":"updateCurrencyAccountDebitInterestConditionsResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"POST","path":"/product/cashManagement/bundles/accounts/transactionAccounts/debitInterestConditions","fullPath":"/api/v1.0.0/product/cashManagement/bundles/accounts/transactionAccounts/debitInterestConditions","operationId":"updateTransactionAccountDebitInterestConditions","name":"Update Debit Interest condition for Transaction Accounts","summary":"Update Debit Interest condition for Transaction Accounts","tags":[],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"The identifier of the underlying Entity/Company/Branch."}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"arrangementCustomerIds":[{}],"arrangementEffectiveDate":"string","productId":"string","activityId":"string","drinterest":{"interest":{},"attributes":{},"tiers":{},"linkedProperty":{}}}},"responses":{"200":"updateTransactionAccountDebitInterestConditionsResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"POST","path":"/product/cashManagement/bundles/accounts/goLiveDates","fullPath":"/api/v1.0.0/product/cashManagement/bundles/accounts/goLiveDates","operationId":"updateAccountOperationalDate","name":"Set Go-Live date for SA / CS / TR / MTR Accounts","summary":"Set Go-Live date for SA / CS / TR / MTR Accounts","tags":[],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"The identifier of the underlying Entity/Company/Branch."}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"arrangementCustomerIds":[{}],"arrangementEffectiveDate":"string","productId":"string","activityId":"string","bundlehierarchy":{"accountAliases":{},"accountReferences":{},"customerIds":{},"accountCompanies":{},"accountCurrencies":{},"accountProducts":{},"shortNames":{},"alternateReferences":{},"parentAccounts":{},"levels":{},"goLiveDates":{},"linkTypes":{},"keepBalances":{},"newMasters":{},"cancelRestructures":{}}}},"responses":{"200":"updateAccountOperationalDateResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"POST","path":"/product/cashManagement/bundles/accounts/liveAccountClosures","fullPath":"/api/v1.0.0/product/cashManagement/bundles/accounts/liveAccountClosures","operationId":"createBundleLiveAccountClosure","name":"Closure of CS / SA / TR accounts","summary":"Closure of CS / SA / TR accounts","tags":[],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"The identifier of the underlying Entity/Company/Branch."}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"arrangementCustomerIds":[{}],"arrangementEffectiveDate":"string","productId":"string","activityId":"string","bundlehierarchy":{"accountAliases":{},"accountReferences":{},"customerIds":{},"accountCompanies":{},"accountCurrencies":{},"accountProducts":{},"shortNames":{},"alternateReferences":{},"parentAccounts":{},"levels":{},"goLiveDates":{},"linkTypes":{},"keepBalances":{},"newMasters":{},"cancelRestructures":{}}}},"responses":{"200":"createBundleLiveAccountClosureResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"POST","path":"/product/cashManagement/bundles/accounts/preliminaryAccountClosures","fullPath":"/api/v1.0.0/product/cashManagement/bundles/accounts/preliminaryAccountClosures","operationId":"createBundleAccountClosure","name":"Closure of TR / CS / SA Accounts in Prelim","summary":"Closure of TR / CS / SA Accounts in Prelim","tags":[],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"The identifier of the underlying Entity/Company/Branch."}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"arrangementCustomerIds":[{}],"arrangementEffectiveDate":"string","productId":"string","activityId":"string","bundlehierarchy":{"accountAliases":{},"accountReferences":{},"customerIds":{},"accountCompanies":{},"accountCurrencies":{},"accountProducts":{},"shortNames":{},"alternateReferences":{},"parentAccounts":{},"levels":{},"goLiveDates":{},"linkTypes":{},"keepBalances":{},"newMasters":{},"cancelRestructures":{}}}},"responses":{"200":"createBundleAccountClosureResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"GET","path":"/product/cashManagement/bundles/{bundleId}/interestConditions","fullPath":"/api/v1.0.0/product/cashManagement/bundles/{bundleId}/interestConditions","operationId":"getMasterInterestCompensation","name":"List Master Arrangement static information","summary":"List Master Arrangement static information","tags":[],"parameters":[{"name":"bundleId","in":"path","type":"string","required":true,"description":"The field is to specify an arrangement reference which can act as a Master for the arrangement being created"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from t24 on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"The identifier of the underlying Entity/Company/Branch."}],"requestBodyExample":null,"responses":{"200":"MasterInterestCompensationResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"POST","path":"/product/cashManagement/bundles/drafts","fullPath":"/api/v1.0.0/product/cashManagement/bundles/drafts","operationId":"createBundleMasterArrangements","name":"Creation of Master / Bundle Arrangement, SA / CS / TR / MTR","summary":"Creation of Master / Bundle Arrangement, SA / CS / TR / MTR","tags":[],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"The identifier of the underlying Entity/Company/Branch."}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"arrangementCustomerIds":[{}],"arrangementEffectiveDate":"string","productId":"string","activityId":"string","productBundle":{"product":{},"referenceCurrency":{},"limitType":{},"masterAccountName":{}},"bundlehierarchy":{"accountAliases":{},"accountReferences":{},"customerIds":{},"accountCompanies":{},"accountCurrencies":{},"accountProducts":{},"shortNames":{},"alternateReferences":{},"parentAccounts":{},"levels":{},"goLiveDates":{},"linkTypes":{},"keepBalances":{},"newMasters":{},"cancelRestructures":{}}}},"responses":{"200":"createBundleMasterArrangementsResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"POST","path":"/product/cashManagement/bundles/accounts","fullPath":"/api/v1.0.0/product/cashManagement/bundles/accounts","operationId":"updateBundleMasterArrangements","name":"Add New accounts SA / CS / TR / MTR+J16","summary":"Add New accounts SA / CS / TR / MTR+J16","tags":[],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"The identifier of the underlying Entity/Company/Branch."}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"arrangementCustomerIds":[{}],"arrangementEffectiveDate":"string","productId":"string","activityId":"string","bundlehierarchy":{"accountAliases":{},"accountReferences":{},"customerIds":{},"accountCompanies":{},"accountCurrencies":{},"accountProducts":{},"shortNames":{},"alternateReferences":{},"parentAccounts":{},"levels":{},"goLiveDates":{},"linkTypes":{},"keepBalances":{},"newMasters":{},"cancelRestructures":{}}}},"responses":{"200":"updateBundleMasterArrangementsResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"PUT","path":"/product/cashManagement/bundles/accounts","fullPath":"/api/v1.0.0/product/cashManagement/bundles/accounts","operationId":"updateBundleStructureAccounts","name":"Edit / Amend Draft / Prelim structure","summary":"Edit / Amend Draft / Prelim structure","tags":[],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"The identifier of the underlying Entity/Company/Branch."}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"arrangementCustomerIds":[{}],"arrangementEffectiveDate":"string","productId":"string","activityId":"string","bundlehierarchy":{"accountAliases":{},"accountReferences":{},"customerIds":{},"accountCompanies":{},"accountCurrencies":{},"accountProducts":{},"shortNames":{},"alternateReferences":{},"parentAccounts":{},"levels":{},"goLiveDates":{},"linkTypes":{},"keepBalances":{},"newMasters":{},"cancelRestructures":{}}}},"responses":{"200":"updateBundleStructureAccountsResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"POST","path":"/product/cashManagement/bundles/accounts/crossPoolMovements","fullPath":"/api/v1.0.0/product/cashManagement/bundles/accounts/crossPoolMovements","operationId":"updateCrossPoolAccountMovement","name":"Initiate Cross Pool Movement","summary":"Initiate Cross Pool Movement","tags":[],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"The identifier of the underlying Entity/Company/Branch."}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"arrangementCustomerIds":[{}],"arrangementEffectiveDate":"string","productId":"string","activityId":"string","bundlehierarchy":{"accountAliases":{},"accountReferences":{},"customerIds":{},"accountCompanies":{},"accountCurrencies":{},"accountProducts":{},"shortNames":{},"alternateReferences":{},"parentAccounts":{},"levels":{},"goLiveDates":{},"linkTypes":{},"keepBalances":{},"newMasters":{},"cancelRestructures":{}}}},"responses":{"200":"updateCrossPoolAccountMovementResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"POST","path":"/product/cashManagement/bundles/accounts/crossPoolMovements/cancellations","fullPath":"/api/v1.0.0/product/cashManagement/bundles/accounts/crossPoolMovements/cancellations","operationId":"deleteCrossPoolAccountMovement","name":"Edit / Cancel Cross Pool Movement","summary":"Edit / Cancel Cross Pool Movement","tags":[],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"The identifier of the underlying Entity/Company/Branch."}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"arrangementCustomerIds":[{}],"arrangementEffectiveDate":"string","productId":"string","activityId":"string","bundlehierarchy":{"accountAliases":{},"accountReferences":{},"customerIds":{},"accountCompanies":{},"accountCurrencies":{},"accountProducts":{},"shortNames":{},"alternateReferences":{},"parentAccounts":{},"levels":{},"goLiveDates":{},"linkTypes":{},"keepBalances":{},"newMasters":{},"cancelRestructures":{}}}},"responses":{"200":"deleteCrossPoolAccountMovementResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"POST","path":"/product/cashManagement/bundles/restructures","fullPath":"/api/v1.0.0/product/cashManagement/bundles/restructures","operationId":"deleteAccountFromBundle","name":"Conversion of TR accounts to Standalone Accounts","summary":"Conversion of TR accounts to Standalone Accounts","tags":[],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"The identifier of the underlying Entity/Company/Branch."}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"arrangementCustomerIds":[{}],"arrangementEffectiveDate":"string","productId":"string","activityId":"string","bundlehierarchy":{"accountAliases":{},"accountReferences":{},"customerIds":{},"accountCompanies":{},"accountCurrencies":{},"accountProducts":{},"shortNames":{},"alternateReferences":{},"parentAccounts":{},"levels":{},"goLiveDates":{},"linkTypes":{},"keepBalances":{},"newMasters":{},"cancelRestructures":{}}}},"responses":{"200":"deleteAccountFromBundleResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"POST","path":"/product/cashManagement/bundles","fullPath":"/api/v1.0.0/product/cashManagement/bundles","operationId":"updateBundleStructure","name":"Initiate Cashpool Restructure","summary":"Initiate Cashpool Restructure","tags":[],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"The identifier of the underlying Entity/Company/Branch."}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"arrangementCustomerIds":[{}],"arrangementEffectiveDate":"string","productId":"string","activityId":"string","bundlehierarchy":{"accountAliases":{},"accountReferences":{},"customerIds":{},"accountCompanies":{},"accountCurrencies":{},"accountProducts":{},"shortNames":{},"alternateReferences":{},"parentAccounts":{},"levels":{},"goLiveDates":{},"linkTypes":{},"keepBalances":{},"newMasters":{},"cancelRestructures":{}}}},"responses":{"200":"updateBundleStructureResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"POST","path":"/product/cashManagement/bundles/accounts/summaryAccounts/creditInterestConditions","fullPath":"/api/v1.0.0/product/cashManagement/bundles/accounts/summaryAccounts/creditInterestConditions","operationId":"updateSumaryAccountCreditInterestConditions","name":"Update Credit Interest condition for a Summary account","summary":"Update Credit Interest condition for a Summary account","tags":[],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"The identifier of the underlying Entity/Company/Branch."}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"arrangementCustomerIds":[{}],"arrangementEffectiveDate":"string","productId":"string","activityId":"string","drinterest":{"interest":{},"attributes":{},"tiers":{},"linkedProperty":{}}}},"responses":{"200":"updateSumaryAccountCreditInterestConditionsResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"POST","path":"/product/cashManagement/bundles/accounts/currencySummaryAccounts/creditInterestConditions","fullPath":"/api/v1.0.0/product/cashManagement/bundles/accounts/currencySummaryAccounts/creditInterestConditions","operationId":"updateCurrencySummaryAccountCreditInterestConditions","name":"Update Credit Interest condition for a Summary account","summary":"Update Credit Interest condition for a Summary account","tags":[],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"The identifier of the underlying Entity/Company/Branch."}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"arrangementCustomerIds":[{}],"arrangementEffectiveDate":"string","productId":"string","activityId":"string","drinterest":{"interest":{},"attributes":{},"tiers":{},"linkedProperty":{}}}},"responses":{"200":"updateCurrencySummaryAccountCreditInterestConditionsResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"POST","path":"/product/cashManagement/bundles/accounts/transactionAccounts/creditInterestConditions","fullPath":"/api/v1.0.0/product/cashManagement/bundles/accounts/transactionAccounts/creditInterestConditions","operationId":"updateTransactionAccountCreditInterestConditions","name":"Update Credit Interest condition for a Transaction account","summary":"Update Credit Interest condition for a Transaction account","tags":[],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"The identifier of the underlying Entity/Company/Branch."}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"arrangementCustomerIds":[{}],"arrangementEffectiveDate":"string","productId":"string","activityId":"string","drinterest":{"interest":{},"attributes":{},"tiers":{},"linkedProperty":{}}}},"responses":{"200":"updateTransactionAccountCreditInterestConditionsResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"POST","path":"/product/cashManagement/bundles/accounts/summaryAccounts/limits","fullPath":"/api/v1.0.0/product/cashManagement/bundles/accounts/summaryAccounts/limits","operationId":"createSummaryAccountLimitConditions","name":"To Set cover control for Summary accounts","summary":"To Set cover control for Summary accounts","tags":[],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"The identifier of the underlying Entity/Company/Branch."}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"arrangementCustomerIds":[{}],"arrangementEffectiveDate":"string","productId":"string","activityId":"string","limit":{"isCreditCheckCondition":{},"creditCheckTransactionType":{},"internalCreditFacility":{}}}},"responses":{"200":"createSummaryAccountLimitConditionsResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"POST","path":"/product/cashManagement/bundles/accounts/currencySummaryAccounts/limits","fullPath":"/api/v1.0.0/product/cashManagement/bundles/accounts/currencySummaryAccounts/limits","operationId":"createCurrencySummaryAccountLimitConditions","name":"To Set cover control for Currency Summary accounts","summary":"To Set cover control for Currency Summary accounts","tags":[],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"The identifier of the underlying Entity/Company/Branch."}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"arrangementCustomerIds":[{}],"arrangementEffectiveDate":"string","productId":"string","activityId":"string","limit":{"isCreditCheckCondition":{},"creditCheckTransactionType":{},"internalCreditFacility":{}}}},"responses":{"200":"createCurrencySummaryAccountLimitConditionsResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"POST","path":"/product/cashManagement/bundles/accounts/transactionAccounts/limits","fullPath":"/api/v1.0.0/product/cashManagement/bundles/accounts/transactionAccounts/limits","operationId":"createTransactionAccountLimitConditions","name":"To Set cover control for Transaction accounts","summary":"To Set cover control for Transaction accounts","tags":[],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"The identifier of the underlying Entity/Company/Branch."}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"arrangementCustomerIds":[{}],"arrangementEffectiveDate":"string","productId":"string","activityId":"string","limit":{"isCreditCheckCondition":{},"creditCheckTransactionType":{},"internalCreditFacility":{}}}},"responses":{"200":"createTransactionAccountLimitConditionsResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}},{"method":"GET","path":"/product/cashManagement/bundles/accounts/{arrangementId}/inheritanceConditions","fullPath":"/api/v1.0.0/product/cashManagement/bundles/accounts/{arrangementId}/inheritanceConditions","operationId":"getSourceInheritanceDetails","name":"Retrieves the inheritance details of Master/CS/SA/CT Account","summary":"Retrieves the inheritance details of Master/CS/SA/CT Account","tags":[],"parameters":[{"name":"arrangementId","in":"path","type":"string","required":true,"description":"Indicates an unique identifier of an account"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from t24 on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"The identifier of the underlying Entity/Company/Branch."}],"requestBodyExample":null,"responses":{"200":"SourceInheritanceDetailsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/product/cashManagement/bundles/transactionAccounts/{arrangementId}/inheritanceConditions","fullPath":"/api/v1.0.0/product/cashManagement/bundles/transactionAccounts/{arrangementId}/inheritanceConditions","operationId":"getTargetInheritanceDetails","name":"Retrieves the inheritance details of TR Accounts","summary":"Retrieves the inheritance details of TR Accounts","tags":[],"parameters":[{"name":"arrangementId","in":"path","type":"string","required":true,"description":"Indicates an unique identifier of an account"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from t24 on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"The identifier of the underlying Entity/Company/Branch."}],"requestBodyExample":null,"responses":{"200":"TargetInheritanceDetailsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/product/cashManagement/bundles/accounts/{arrangementId}/childAccounts","fullPath":"/api/v1.0.0/product/cashManagement/bundles/accounts/{arrangementId}/childAccounts","operationId":"getChildAccountsDetails","name":"Retrieves the child accounts details under the SA/CS Accounts","summary":"Retrieves the child accounts details under the SA/CS Accounts","tags":[],"parameters":[{"name":"arrangementId","in":"path","type":"string","required":true,"description":"Indicates an unique identifier of an account"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from t24 on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"The identifier of the underlying Entity/Company/Branch."}],"requestBodyExample":null,"responses":{"200":"ChildAccountsDetailsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}}]}]},{"name":"Reference","serviceCount":99,"endpointCount":618,"services":[{"key":"reference-BICs-service-v1.0.0","title":"Reference BICs API","version":"v1.0.0","description":"Get information of BICs ","endpointCount":1,"endpoints":[{"method":"GET","path":"/reference/BICs","fullPath":"/api/v1.0.0/reference/BICs","operationId":"getBICs","name":"Retrieves BIC details.Use /reference/bankCodes/bics/{bicId} from BICS-service-V3.0.0","summary":"Retrieves list of bank identifier codes (BIC)","tags":[],"parameters":[{"name":"BIC","in":"query","type":"string","required":false,"description":"The BIC code of the Beneficiary bank"},{"name":"nationalityId","in":"query","type":"string","required":false,"description":"The identifier of the nationality of a customer"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"BICsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}}]},{"key":"reference-BICs-v2.0.0","title":"Bank Identifier Codes","version":"v2.0.0","description":"API to Validate the Status of the Swift Bank Identifier Code (BIC) Code","endpointCount":1,"endpoints":[{"method":"GET","path":"/reference/BICs/{bicId}","fullPath":"/api/v2.0.0/reference/BICs/{bicId}","operationId":"getBICStatus","name":"Retrieves the status of the validity of the requested BIC.Use /reference/bankCodes/bics/{bicId}/validity from BICS-service-v3.0.0","summary":"Retrieves BIC code Status","tags":[],"parameters":[{"name":"bicId","in":"path","type":"string","required":true,"description":"Bank Identifier Code (BIC) of the Beneficiary bank."},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"BICStatusResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}}]},{"key":"reference-BICs-v3.0.0","title":"Bank Identifier Codes","version":"v3.0.0","description":"API to validate and retrieve the Bank Identifier Code (BIC) related details. The BIC is the SWIFT Address assigned to a bank in order to send automated payments to the banks concerned. It uniquely identifies the name and country of the bank and consists of 8-11 characters. Example format AAAABBCCDDD","endpointCount":4,"endpoints":[{"method":"GET","path":"/reference/bankCodes/bics/{bicId}","fullPath":"/api/v3.0.0/reference/bankCodes/bics/{bicId}","operationId":"getBICStatus","name":"Retrieves the status on the validity of the requested BIC along with its details, such as institution name, address, location etc. ","summary":"Retrieves the status on the validity of the requested BIC along with its details","tags":[],"parameters":[{"name":"bicId","in":"path","type":"string","required":true,"description":"Bank Identifier Code (BIC) of the Beneficiary bank."},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from t24 on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"The identifier of the underlying Entity/Company/Branch."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"BICStatusResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/reference/bankCodes/bics/{bicId}/validity","fullPath":"/api/v3.0.0/reference/bankCodes/bics/{bicId}/validity","operationId":"validateBIC","name":"Retrieves the status on the validity of the BIC code, returns YES if BIC is valid","summary":"Retrieves the status on the validity of the BIC code","tags":[],"parameters":[{"name":"bicId","in":"path","type":"string","required":true,"description":"Bank Identifier Code (BIC) of the Beneficiary bank."},{"name":"effectiveDate","in":"query","type":"string","required":false,"description":"The date on which the principal movement is effected"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from t24 on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"The identifier of the underlying Entity/Company/Branch."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"BICResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/reference/bankCodes/bics/{bicId}/lei","fullPath":"/api/v3.0.0/reference/bankCodes/bics/{bicId}/lei","operationId":"getLEIFromBIC","name":"Retrieves the Bank's Legal Entity Identifier (LEI) of the requested BIC. The LEI is the International ISO standard 17442. LEIs are identification codes that enable consistent and accurate identification of all legal entities that are parties to financial transactions, including non-financial institutions.","summary":"Retrieves the Bank's legal entity identifier of the requested BIC","tags":[],"parameters":[{"name":"bicId","in":"path","type":"string","required":true,"description":"Bank Identifier Code (BIC) of the Beneficiary bank."},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from t24 on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"The identifier of the underlying Entity/Company/Branch."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"LEIFromBICResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/reference/bankCodes/bics","fullPath":"/api/v3.0.0/reference/bankCodes/bics","operationId":"getBICIdentifier","name":"Retrieves the matching bank identification codes available in a country with matching BIC Code or institution name or city.","summary":"Retrieves the matching bank identification codes for the specified search criterions","tags":[],"parameters":[{"name":"countryCode","in":"query","type":"string","required":true,"description":"ISO 3166-1-alpha-2 or alpha-3 country code of financial institution"},{"name":"bicId","in":"query","type":"string","required":false,"description":"Bank Identifier Code (BIC) of the Beneficiary bank."},{"name":"institutionName","in":"query","type":"string","required":false,"description":"Indicates the name of the institution"},{"name":"city","in":"query","type":"string","required":false,"description":"City of residence of customer or the City in which the bank/financial institution is located. For Example LONDON, NEW YORK"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from t24 on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"The identifier of the underlying Entity/Company/Branch."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"BICIdentifierResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}}]},{"key":"reference-BICs-v3.1.0","title":"Bank Identifier Codes","version":"v3.1.0","description":"API to validate and retrieve the Bank Identifier Code (BIC) related details. The BIC is the SWIFT Address assigned to a bank in order to send automated payments to the banks concerned. It uniquely identifies the name and country of the bank and consists of 8-11 characters. Example format AAAABBCCDDD","endpointCount":4,"endpoints":[{"method":"GET","path":"/reference/bankCodes/bics/{bicId}","fullPath":"/api/v3.1.0/reference/bankCodes/bics/{bicId}","operationId":"getBICStatus","name":"Retrieves the status on the validity of the requested BIC along with its details, such as institution name, address, location etc. ","summary":"Retrieves the status on the validity of the requested BIC along with its details","tags":[],"parameters":[{"name":"bicId","in":"path","type":"string","required":true,"description":"Bank Identifier Code (BIC) of the Beneficiary bank."},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from t24 on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"The identifier of the underlying Entity/Company/Branch."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"BICStatusResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/reference/bankCodes/bics/{bicId}/validity","fullPath":"/api/v3.1.0/reference/bankCodes/bics/{bicId}/validity","operationId":"validateBIC","name":"Retrieves the status on the validity of the BIC code, returns YES if BIC is valid","summary":"Retrieves the status on the validity of the BIC code","tags":[],"parameters":[{"name":"bicId","in":"path","type":"string","required":true,"description":"Bank Identifier Code (BIC) of the Beneficiary bank."},{"name":"effectiveDate","in":"query","type":"string","required":false,"description":"The date on which the principal movement is effected"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from t24 on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"The identifier of the underlying Entity/Company/Branch."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"BICResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/reference/bankCodes/bics/{bicId}/lei","fullPath":"/api/v3.1.0/reference/bankCodes/bics/{bicId}/lei","operationId":"getLEIFromBIC","name":"Retrieves the Bank's Legal Entity Identifier (LEI) of the requested BIC. The LEI is the International ISO standard 17442. LEIs are identification codes that enable consistent and accurate identification of all legal entities that are parties to financial transactions, including non-financial institutions.","summary":"Retrieves the Bank's legal entity identifier of the requested BIC","tags":[],"parameters":[{"name":"bicId","in":"path","type":"string","required":true,"description":"Bank Identifier Code (BIC) of the Beneficiary bank."},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from t24 on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"The identifier of the underlying Entity/Company/Branch."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"LEIFromBICResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/reference/bankCodes/bics","fullPath":"/api/v3.1.0/reference/bankCodes/bics","operationId":"getBICIdentifier","name":"Retrieves the matching bank identification codes available in a country with matching BIC Code or institution name or city.","summary":"Retrieves the matching bank identification codes for the specified search criterions","tags":[],"parameters":[{"name":"countryCode","in":"query","type":"string","required":true,"description":"ISO 3166-1-alpha-2 or alpha-3 country code of financial institution"},{"name":"bicId","in":"query","type":"string","required":false,"description":"Bank Identifier Code (BIC) of the Beneficiary bank."},{"name":"institutionName","in":"query","type":"string","required":false,"description":"Indicates the name of the institution"},{"name":"city","in":"query","type":"string","required":false,"description":"City of residence of customer or the City in which the bank/financial institution is located. For Example LONDON, NEW YORK"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from t24 on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"The identifier of the underlying Entity/Company/Branch."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"BICIdentifierResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}}]},{"key":"reference-BICs-v3.2.0","title":"Bank Identifier Codes","version":"v3.2.0","description":"API to validate and retrieve the Bank Identifier Code (BIC) related details. The BIC is the SWIFT Address assigned to a bank in order to send automated payments to the banks concerned. It uniquely identifies the name and country of the bank and consists of 8-11 characters. Example format AAAABBCCDDD","endpointCount":4,"endpoints":[{"method":"GET","path":"/reference/bankCodes/bics/{bicId}","fullPath":"/api/v3.2.0/reference/bankCodes/bics/{bicId}","operationId":"getBICStatus","name":"Retrieves the status on the validity of the requested BIC along with its details, such as institution name, address, location etc. ","summary":"Retrieves the status on the validity of the requested BIC along with its details","tags":[],"parameters":[{"name":"bicId","in":"path","type":"string","required":true,"description":"Bank Identifier Code (BIC) of the Beneficiary bank."},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"BICStatusResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/reference/bankCodes/bics/{bicId}/lei","fullPath":"/api/v3.2.0/reference/bankCodes/bics/{bicId}/lei","operationId":"getLEIFromBIC","name":"Retrieves the Bank's Legal Entity Identifier (LEI) of the requested BIC. The LEI is the International ISO standard 17442. LEIs are identification codes that enable consistent and accurate identification of all legal entities that are parties to financial transactions, including non-financial institutions.","summary":"Retrieves the Bank's legal entity identifier of the requested BIC","tags":[],"parameters":[{"name":"bicId","in":"path","type":"string","required":true,"description":"Bank Identifier Code (BIC) of the Beneficiary bank."},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"LEIFromBICResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/reference/bankCodes/bics","fullPath":"/api/v3.2.0/reference/bankCodes/bics","operationId":"getBICIdentifier","name":"Retrieves the matching bank identification codes available in a country with matching BIC Code or institution name or city.","summary":"Retrieves the matching bank identification codes for the specified search criterions","tags":[],"parameters":[{"name":"countryCode","in":"query","type":"string","required":true,"description":"ISO Country code, IBAN number will be generated based on the structure of this country."},{"name":"bicId","in":"query","type":"string","required":false,"description":"Bank Identifier Code (BIC) of the Beneficiary bank."},{"name":"institutionName","in":"query","type":"string","required":false,"description":"Indicates the name of the institution"},{"name":"city","in":"query","type":"string","required":false,"description":"City address stated on driver licence or utlility bill. For example London, New York etc."},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"BICIdentifierResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/reference/bankCodes/bics/{bicId}/validity","fullPath":"/api/v3.2.0/reference/bankCodes/bics/{bicId}/validity","operationId":"ValidateBIC","name":"Retrieves the status on the validity of the BIC code, returns YES if BIC is valid based on   company code","summary":"Retrieves the status on the validity of the BIC code","tags":[],"parameters":[{"name":"bicId","in":"path","type":"string","required":true,"description":"Bank Identifier Code (BIC) of the Beneficiary bank."},{"name":"effectiveDate","in":"query","type":"string","required":false,"description":"Contains the identifier for the transaction date. Dates are expected in \u00e2\u20ac\u02dcYYYYMMDD\u00e2\u20ac\u2122 format"},{"name":"company","in":"query","type":"string","required":false,"description":"The company code"},{"name":"BICValidation","in":"query","type":"string","required":false,"description":"Checking whether valid Bic or not"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"ValidateBICResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}}]},{"key":"reference-BICs-v3.3.0","title":"Bank Identifier Codes","version":"v3.3.0","description":"API to validate and retrieve the Bank Identifier Code (BIC) related details. The BIC is the SWIFT Address assigned to a bank in order to send automated payments to the banks concerned. It uniquely identifies the name and country of the bank and consists of 8-11 characters. Example format AAAABBCCDDD","endpointCount":4,"endpoints":[{"method":"GET","path":"/reference/bankCodes/bics/{bicId}/lei","fullPath":"/api/v3.3.0/reference/bankCodes/bics/{bicId}/lei","operationId":"getLEIFromBIC","name":"Retrieves the bank's Legal Entity Identifier (LEI) of the requested BIC. The LEI is the International ISO standard 17442. LEIs are identification codes that enable consistent and accurate identification of all legal entities that are parties to financial transactions, including non-financial institutions.","summary":"Retrieves the bank's legal entity identifier of the requested BIC","tags":[],"parameters":[{"name":"bicId","in":"path","type":"string","required":true,"description":"Bank Identifier Code (BIC) of the Beneficiary bank."},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"LEIFromBICResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/reference/bankCodes/bics","fullPath":"/api/v3.3.0/reference/bankCodes/bics","operationId":"getBICIdentifier","name":"Retrieves the matching bank identification codes available in a country with matching BIC Code or institution name or city.","summary":"Retrieves the matching bank identification codes for the specified search criterions","tags":[],"parameters":[{"name":"countryCode","in":"query","type":"string","required":true,"description":"ISO Country code, IBAN number will be generated based on the structure of this country."},{"name":"bicId","in":"query","type":"string","required":false,"description":"Bank Identifier Code (BIC) of the Beneficiary bank."},{"name":"institutionName","in":"query","type":"string","required":false,"description":"Indicates the name of the institution"},{"name":"city","in":"query","type":"string","required":false,"description":"City address stated on driver licence or utlility bill. For example London, New York etc."},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"BICIdentifierResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/reference/bankCodes/bics/{bicId}/validity","fullPath":"/api/v3.3.0/reference/bankCodes/bics/{bicId}/validity","operationId":"ValidateBIC","name":"Retrieves the status on the validity of the BIC code, returns YES if BIC is valid based on   company code","summary":"Retrieves the status on the validity of the BIC code","tags":[],"parameters":[{"name":"bicId","in":"path","type":"string","required":true,"description":"Bank Identifier Code (BIC) of the Beneficiary bank."},{"name":"effectiveDate","in":"query","type":"string","required":false,"description":"Contains the identifier for the transaction date. Dates are expected in \u00e2\u20ac\u02dcYYYYMMDD\u00e2\u20ac\u2122 format"},{"name":"company","in":"query","type":"string","required":false,"description":"The company code"},{"name":"BICValidation","in":"query","type":"string","required":false,"description":"Checking whether valid Bic or not"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"ValidateBICResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/reference/bankCodes/bics/{bicId}","fullPath":"/api/v3.3.0/reference/bankCodes/bics/{bicId}","operationId":"getBICStatus","name":"Retrieves the status on the validity of the requested BIC along with its details, such as institution name, address, location etc. ","summary":"Retrieves the status on the validity of the requested BIC along with its details","tags":[],"parameters":[{"name":"bicId","in":"path","type":"string","required":true,"description":"Bank Identifier Code (BIC) of the Beneficiary bank."},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"BICStatusResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}}]},{"key":"reference-IBANs-service-v1.0.0","title":"Reference IBANs API","version":"v1.0.0","description":"Get information of IBANs","endpointCount":2,"endpoints":[{"method":"GET","path":"/reference/IBANs/{inIBANPlusId}","fullPath":"/api/v1.0.0/reference/IBANs/{inIBANPlusId}","operationId":"getIBANs","name":"Retrieves IBANs details.Use /reference/bankCodes/ibans/{ibanId}/bic from IBANs-v2.0.0","summary":"Retrieves the IBAN details for an account","tags":[],"parameters":[{"name":"inIBANPlusId","in":"path","type":"string","required":true,"description":"Specifies the international bank account number associated with the customer"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"IBANsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/reference/IBANStructures/{countryId}","fullPath":"/api/v1.0.0/reference/IBANStructures/{countryId}","operationId":"getIBANStructures","name":"Retrieves IBAN structures details.Use /reference/bankCodes/countries/{countryId}/ibanStructures from IBANs-v2.0.0","summary":"Retrieves the IBAN details for a specific country","tags":[],"parameters":[{"name":"countryId","in":"path","type":"string","required":true,"description":"ISO country code of the financial institution. "},{"name":"IBANCountryCode","in":"query","type":"string","required":false,"description":"Specifies the country code associated with international bank account number of the beneficiary"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"IBANStructuresResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}}]},{"key":"reference-IBANs-v2.0.0","title":"International Bank Account Number (IBAN)","version":"v2.0.0","description":"API to manage International Bank Account Number (IBAN) related services. The IBAN consists of up to 34 alphanumeric characters comprising a country code; two check digits; and a number that includes the domestic bank account number, branch identifier, and potential routing information. IBAN example:","endpointCount":6,"endpoints":[{"method":"GET","path":"/reference/bankCodes/ibans/{ibanId}/bic","fullPath":"/api/v2.0.0/reference/bankCodes/ibans/{ibanId}/bic","operationId":"getBICfromIBAN","name":"Retrieves the Bank Identifier Code (BIC) for the requested IBAN. The BIC is the SWIFT Address assigned to a bank in order to send automated payments to the banks concerned. It uniquely identifies the name and country of the bank. ","summary":"Retrieves the BIC code for the requested IBAN","tags":[],"parameters":[{"name":"ibanId","in":"path","type":"string","required":true,"description":""},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from t24 on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"The identifier of the underlying Entity/Company/Branch."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"BICfromIBANResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/reference/bankCodes/ibans/{ibanId}","fullPath":"/api/v2.0.0/reference/bankCodes/ibans/{ibanId}","operationId":"getIBANDetails","name":"Retrieves the components of the requested IBAN such as country code, checksum, bank identifier, branch identifier, account number and length","summary":"Retrieves the components of the requested IBAN","tags":[],"parameters":[{"name":"ibanId","in":"path","type":"string","required":true,"description":""},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from t24 on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"The identifier of the underlying Entity/Company/Branch."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"IBANDetailsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/reference/bankCodes/bbans/{bbanId}/iban","fullPath":"/api/v2.0.0/reference/bankCodes/bbans/{bbanId}/iban","operationId":"getIBANFromBBAN","name":"Retrieves the IBAN for a given Basic Bank Account Number (BBAN) and country code. The BBAN can be up to 30 alphanumeric characters that are country-specific. The BBAN is the last part of the IBAN when used for international funds transfers. ","summary":"Retrieves IBAN from a BBAN","tags":[],"parameters":[{"name":"bbanId","in":"path","type":"string","required":true,"description":""},{"name":"countryId","in":"query","type":"string","required":true,"description":"ISO country code of the financial institution. "},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from t24 on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"The identifier of the underlying Entity/Company/Branch."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"IBANFromBBANResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/reference/bankCodes/ibans","fullPath":"/api/v2.0.0/reference/bankCodes/ibans","operationId":"getIBANNumberGenerated","name":"Retrieves the IBAN number generated based on the given components such as country code, account identifier, bank identifier and branch identifier","summary":"Retrieves the generated IBAN number","tags":[],"parameters":[{"name":"accountId","in":"query","type":"string","required":true,"description":"Identifier of the account. Often referred to as the account number, yet for consistency this is always referred to as accountId. Accepts both IBAN & BBAN"},{"name":"bankId","in":"query","type":"string","required":true,"description":"Contains the identifier of the bank with which the transaction is performed"},{"name":"branchId","in":"query","type":"string","required":false,"description":"Unique and unambiguous identification of a branch of a financial institution."},{"name":"countryId","in":"query","type":"string","required":true,"description":"ISO country code of the financial institution. "},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from t24 on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"The identifier of the underlying Entity/Company/Branch."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"IBANNumberGeneratedResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/reference/bankCodes/countries/{countryId}/ibanStructures","fullPath":"/api/v2.0.0/reference/bankCodes/countries/{countryId}/ibanStructures","operationId":"getIBANStructure","name":"Retrieves the country specific structure of an IBAN number","summary":"Retrieves the structure of an IBAN number","tags":[],"parameters":[{"name":"countryId","in":"path","type":"string","required":true,"description":"ISO country code of the financial institution. "},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from t24 on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"The identifier of the underlying Entity/Company/Branch."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"IBANStructureResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/reference/bankCodes/ibans/{ibanId}/validity","fullPath":"/api/v2.0.0/reference/bankCodes/ibans/{ibanId}/validity","operationId":"validateIBAN","name":"Retrieves the status on the validity of the given IBAN number, returns YES if IBAN number is valid","summary":"Retrieves the status on the validity of the given IBAN number","tags":[],"parameters":[{"name":"ibanId","in":"path","type":"string","required":true,"description":""},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from t24 on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"The identifier of the underlying Entity/Company/Branch."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"IBANResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}}]},{"key":"reference-IBANs-v2.1.0","title":"International Bank Account Number (IBAN)","version":"v2.1.0","description":"API to manage International Bank Account Number (IBAN) related services. The IBAN consists of up to 34 alphanumeric characters comprising a country code; two check digits; and a number that includes the domestic bank account number, branch identifier, and potential routing information. IBAN example:","endpointCount":14,"endpoints":[{"method":"GET","path":"/reference/bankCodes/ibans/{ibanId}/bic","fullPath":"/api/v2.1.0/reference/bankCodes/ibans/{ibanId}/bic","operationId":"getBICfromIBAN","name":"Retrieves the Bank Identifier Code (BIC) for the requested IBAN. The BIC is the SWIFT Address assigned to a bank in order to send automated payments to the banks concerned. It uniquely identifies the name and country of the bank. ","summary":"Retrieves the BIC code for the requested IBAN","tags":[],"parameters":[{"name":"ibanId","in":"path","type":"string","required":true,"description":"Identifier of the international bank account number"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from t24 on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"The identifier of the underlying Entity/Company/Branch."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"BICfromIBANResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/reference/bankCodes/ibans/{ibanId}","fullPath":"/api/v2.1.0/reference/bankCodes/ibans/{ibanId}","operationId":"getIBANDetails","name":"Retrieves the components of the requested IBAN such as country code, checksum, bank identifier, branch identifier, account number and length","summary":"Retrieves the components of the requested IBAN","tags":[],"parameters":[{"name":"ibanId","in":"path","type":"string","required":true,"description":"Identifier of the international bank account number"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from t24 on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"The identifier of the underlying Entity/Company/Branch."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"IBANDetailsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/reference/bankCodes/bbans/{bbanId}/iban","fullPath":"/api/v2.1.0/reference/bankCodes/bbans/{bbanId}/iban","operationId":"getIBANFromBBAN","name":"Retrieves the IBAN for a given Basic Bank Account Number (BBAN) and country code. The BBAN can be up to 30 alphanumeric characters that are country-specific. The BBAN is the last part of the IBAN when used for international funds transfers. ","summary":"Retrieves IBAN from a BBAN","tags":[],"parameters":[{"name":"bbanId","in":"path","type":"string","required":true,"description":"Indicates basic bank account number, represents a country specific bank account number"},{"name":"countryId","in":"query","type":"string","required":true,"description":"ISO country code of the financial institution. "},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from t24 on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"The identifier of the underlying Entity/Company/Branch."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"IBANFromBBANResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/reference/bankCodes/ibans","fullPath":"/api/v2.1.0/reference/bankCodes/ibans","operationId":"getIBANNumberGenerated","name":"Retrieves the IBAN number generated based on the given components such as country code, account identifier, bank identifier and branch identifier","summary":"Retrieves the generated IBAN number","tags":[],"parameters":[{"name":"accountId","in":"query","type":"string","required":true,"description":"Identifier of the account. Often referred to as the account number, yet for consistency this is always referred to as accountId. Accepts both IBAN & BBAN"},{"name":"bankId","in":"query","type":"string","required":true,"description":"Contains the identifier of the bank with which the transaction is performed"},{"name":"branchId","in":"query","type":"string","required":false,"description":"Unique and unambiguous identification of a branch of a financial institution."},{"name":"countryId","in":"query","type":"string","required":true,"description":"ISO country code of the financial institution. "},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from t24 on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"The identifier of the underlying Entity/Company/Branch."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"IBANNumberGeneratedResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/reference/bankCodes/countries/{countryId}/ibanStructures","fullPath":"/api/v2.1.0/reference/bankCodes/countries/{countryId}/ibanStructures","operationId":"getIBANStructure","name":"Retrieves the country specific structure of an IBAN number","summary":"Retrieves the structure of an IBAN number","tags":[],"parameters":[{"name":"countryId","in":"path","type":"string","required":true,"description":"ISO country code of the financial institution. "},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from t24 on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"The identifier of the underlying Entity/Company/Branch."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"IBANStructureResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"POST","path":"/reference/bankCodes/countries/{countryId}/ibanStructures","fullPath":"/api/v2.1.0/reference/bankCodes/countries/{countryId}/ibanStructures","operationId":"createIbanStructure","name":"The IBAN International Bank Account Number is used in cross border payment transactions.  The IBAN structure comprises upto 34 digits:  Country Code - 2 digit ISO country code Check Digit - 2 digit Basic Bank Account Number BBAN - upto 30 digits  The BBAN can be country specific. In most cases, the IBAN structure is uploaded from the SWIFT official site.  This endpoint is used to create the country specific IBAN structure.","summary":"Creates the country specific IBAN structure","tags":[],"parameters":[{"name":"countryId","in":"path","type":"string","required":true,"description":"ISO country code of the financial institution. "},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"The identifier of the underlying Entity/Company/Branch."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"countryCode":"string","countryCodePosition":"string","countryCodeLength":"string","checkDigitsPosition":"string","checkDigitsLength":"string","bankIdentifierPosition":"string","bankIdentifierLength":"string","branchIdentifierPosition":"string","branchIdentifierLength":"string","accountNumberPosition":"string","accountNumberLength":"string","totalLength":"string","bankIdApplication":"string","bankIdField":"string","branchIdApplication":"string"}},"responses":{"200":"IbanStructureResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/reference/bankCodes/countries/{countryId}/ibanStructures","fullPath":"/api/v2.1.0/reference/bankCodes/countries/{countryId}/ibanStructures","operationId":"updateIbanStructure","name":"The IBAN (International Bank Account Number) is used in cross border payment transactions.  The IBAN structure comprises upto 34 digits:  Country Code - 2 digit ISO country code Check Digit - 2 digit Basic Bank Account Number (BBAN) - upto 30 digits  The BBAN can be country specific. In most cases, the IBAN structure is uploaded from the SWIFT official site.  This endpoint is used to modify the country specific IBAN structure","summary":"Update the country specific IBAN structure","tags":[],"parameters":[{"name":"countryId","in":"path","type":"string","required":true,"description":""},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"The identifier of the underlying Entity/Company/Branch."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"countryCode":"string","countryCodePosition":"string","countryCodeLength":"string","checkDigitsPosition":"string","checkDigitsLength":"string","bankIdentifierPosition":"string","bankIdentifierLength":"string","branchIdentifierPosition":"string","branchIdentifierLength":"string","accountNumberPosition":"string","accountNumberLength":"string","totalLength":"string","bankIdApplication":"string","bankIdField":"string","branchIdApplication":"string"}},"responses":{"200":"IbanStructureResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"DELETE","path":"/reference/bankCodes/countries/{countryId}/ibanStructures","fullPath":"/api/v2.1.0/reference/bankCodes/countries/{countryId}/ibanStructures","operationId":"deleteIbanStructure","name":"Delete the country specific IBAN structure in cross border payment transactions.  The IBAN structure comprises up to 34 digits:  Country Code - 2 digit ISO country code Check Digit - 2 digit Basic Bank Account Number (BBAN) - up to 30 digits  The BBAN can be country specific. In most cases, the IBAN structure is uploaded from the SWIFT official site.  This endpoint is used to modify the country specific IBAN structure","summary":"Delete the country specific IBAN structure","tags":[],"parameters":[{"name":"countryId","in":"path","type":"string","required":true,"description":""},{"name":"payload","in":"body","type":"object","required":false,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"The identifier of the underlying Entity/Company/Branch."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}}},"responses":{"200":"IbanStructureResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/reference/bankCodes/ibans/{ibanId}/validity","fullPath":"/api/v2.1.0/reference/bankCodes/ibans/{ibanId}/validity","operationId":"validateIBAN","name":"Retrieves the status on the validity of the given IBAN number, returns YES if IBAN number is valid","summary":"Retrieves the status on the validity of the given IBAN number","tags":[],"parameters":[{"name":"ibanId","in":"path","type":"string","required":true,"description":"Identifier of the international bank account number"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from t24 on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"The identifier of the underlying Entity/Company/Branch."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"IBANResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"POST","path":"/reference/bankCodes/ibans/ibanPlusDirectories","fullPath":"/api/v2.1.0/reference/bankCodes/ibans/ibanPlusDirectories","operationId":"createIbanPlusDirectory","name":"IBAN plus provides a worldwide central database that contains IBAN-related data for financial institutions in SEPA and non-SEPA countries that have adopted IBAN. With the IBAN plus, it is possible to validate the IBAN and derive the BIC from IBAN. This endpoint is used to create the client specific IBAN plus directory","summary":"Creates the IBAN plus directory","tags":[],"parameters":[{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"The identifier of the underlying Entity/Company/Branch."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"excludedCompanies":[{}],"allowedCompanies":[{}],"countryId":"string","countryCode":"string","ibanBic":"string","routingBicCode":"string","ibanNationalId":"string","modificationDetail":"string","status":"string"}},"responses":{"200":"IbanPlusDirectoryResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/reference/bankCodes/ibans/ibanPlusDirectories/{ibanPlusDirectoryId}","fullPath":"/api/v2.1.0/reference/bankCodes/ibans/ibanPlusDirectories/{ibanPlusDirectoryId}","operationId":"updateIbanPlusDirectory","name":"IBAN plus provides a worldwide central database that contains IBAN-related data for financial institutions in SEPA and non-SEPA countries that have adopted IBAN. With the IBAN plus, it is possible to validate the IBAN and derive the BIC from IBAN. This endpoint is used to modify the client specific IBAN plus directory","summary":"Update the IBAN Plus directory","tags":[],"parameters":[{"name":"ibanPlusDirectoryId","in":"path","type":"string","required":true,"description":""},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"The identifier of the underlying Entity/Company/Branch."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"excludedCompanies":[{}],"allowedCompanies":[{}],"countryId":"string","countryCode":"string","ibanBic":"string","routingBicCode":"string","ibanNationalId":"string","modificationDetail":"string","status":"string"}},"responses":{"200":"IbanPlusDirectoryResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"POST","path":"/reference/bankCodes/ibans/ibanExclusionLists","fullPath":"/api/v2.1.0/reference/bankCodes/ibans/ibanExclusionLists","operationId":"createIbanExclusionList","name":"An IBAN exclusion list provides a listing of all bank IDs that should not be used in IBANs. The exclusion list allows users to check the validity of a bank id and enables the detection of invalid IBANs in the payment and direct debit processing. This endpoint is used to create the client specific IBAN exclusion list.","summary":"Create the list of bank IDs that are to be excluded in IBAN validations.","tags":[],"parameters":[{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"The identifier of the underlying Entity/Company/Branch."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"excludedCompanies":[{}],"allowedCompanies":[{}],"countryCode":"string","ibanNationalId":"string","bicId":"string","validFrom":"string","status":"string","modificationDetail":"string"}},"responses":{"200":"IbanExclusionListResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/reference/bankCodes/ibans/ibanExclusionLists/{ibanExclusionListId}","fullPath":"/api/v2.1.0/reference/bankCodes/ibans/ibanExclusionLists/{ibanExclusionListId}","operationId":"getIbanExclusionList","name":"An IBAN exclusion list provides a listing of all bank IDs that should not be used in IBANs.The exclusion list allows users to check the validity of a bank id and enables the detection of invalid IBANs in the payment and direct debit processing. This endpoint is used to retrieve the client specific IBAN exclusion list.","summary":"Retrieve the list of bank IDs that are to be excluded in IBAN validations.","tags":[],"parameters":[{"name":"ibanExclusionListId","in":"path","type":"string","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"The identifier of the underlying Entity/Company/Branch."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"IbanExclusionListResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/reference/bankCodes/ibans/ibanExclusionLists/{ibanExclusionListId}","fullPath":"/api/v2.1.0/reference/bankCodes/ibans/ibanExclusionLists/{ibanExclusionListId}","operationId":"updateIbanExclusionList","name":"An IBAN exclusion list provides a listing of all bank IDs that should not be used in IBANs.The exclusion list allows users to check the validity of a bank id and enables the detection of invalid IBANs in the payment and direct debit processing. This endpoint is used to update the client specific IBAN exclusion list.","summary":"Update the list of bank IDs that are to be excluded in IBAN validations.","tags":[],"parameters":[{"name":"ibanExclusionListId","in":"path","type":"string","required":true,"description":""},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"The identifier of the underlying Entity/Company/Branch."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"excludedCompanies":[{}],"allowedCompanies":[{}],"countryCode":"string","ibanNationalId":"string","bicId":"string","validFrom":"string","status":"string","modificationDetail":"string"}},"responses":{"200":"IbanExclusionListResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}}]},{"key":"reference-IBANs-v2.2.0","title":"International Bank Account Number IBAN","version":"v2.2.0","description":"API to manage International Bank Account Number (IBAN) related services. The IBAN consists of up to 34 alphanumeric characters comprising a country code; two check digits; and a number that includes the domestic bank account number, branch identifier, and potential routing information. IBAN example:","endpointCount":16,"endpoints":[{"method":"GET","path":"/reference/bankCodes/ibans/{ibanId}/bic","fullPath":"/api/v2.2.0/reference/bankCodes/ibans/{ibanId}/bic","operationId":"getBICfromIBAN","name":"Retrieves the Bank Identifier Code (BIC) for the requested IBAN. The BIC is the SWIFT Address assigned to a bank in order to send automated payments to the banks concerned. It uniquely identifies the name and country of the bank. ","summary":"Retrieves the BIC code for the requested IBAN","tags":[],"parameters":[{"name":"ibanId","in":"path","type":"string","required":true,"description":"Identifier of the international bank account number"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"BICfromIBANResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/reference/bankCodes/ibans/{ibanId}","fullPath":"/api/v2.2.0/reference/bankCodes/ibans/{ibanId}","operationId":"getIBANDetails","name":"Retrieves the components of the requested IBAN such as country code, checksum, bank identifier, branch identifier, account number and length","summary":"Retrieves the components of the requested IBAN","tags":[],"parameters":[{"name":"ibanId","in":"path","type":"string","required":true,"description":"Identifier of the international bank account number"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"IBANDetailsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/reference/bankCodes/bbans/{bbanId}/iban","fullPath":"/api/v2.2.0/reference/bankCodes/bbans/{bbanId}/iban","operationId":"getIBANFromBBAN","name":"Retrieves the IBAN for a given Basic Bank Account Number (BBAN) and country code. The BBAN can be up to 30 alphanumeric characters that are country-specific. The BBAN is the last part of the IBAN when used for international funds transfers. ","summary":"Retrieves IBAN from a BBAN","tags":[],"parameters":[{"name":"bbanId","in":"path","type":"string","required":true,"description":"Indicates Basic Bank Account Number, represents a country specific bank account number"},{"name":"countryId","in":"query","type":"string","required":true,"description":"ISO country code of the financial institution. "},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"IBANFromBBANResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/reference/bankCodes/ibans","fullPath":"/api/v2.2.0/reference/bankCodes/ibans","operationId":"getIBANNumberGenerated","name":"Retrieves the IBAN number generated based on the given components such as country code, account identifier, bank identifier and branch identifier","summary":"Retrieves the generated IBAN number","tags":[],"parameters":[{"name":"accountId","in":"query","type":"string","required":true,"description":"Identifier of the account. Often referred to as the account number, yet for consistency this is always referred to as accountId. Accepts both IBAN & BBAN"},{"name":"bankId","in":"query","type":"string","required":true,"description":"Contains the identifier of the bank with which the transaction is performed"},{"name":"branchId","in":"query","type":"string","required":false,"description":"Unique and unambiguous identification of a branch of a financial institution."},{"name":"countryId","in":"query","type":"string","required":true,"description":"ISO country code of the financial institution. "},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"IBANNumberGeneratedResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/reference/bankCodes/countries/{countryId}/ibanStructures","fullPath":"/api/v2.2.0/reference/bankCodes/countries/{countryId}/ibanStructures","operationId":"getIBANStructure","name":"Retrieves the country specific structure of an IBAN number","summary":"Retrieves the structure of an IBAN number","tags":[],"parameters":[{"name":"countryId","in":"path","type":"string","required":true,"description":"ISO country code of the financial institution. "},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"IBANStructureResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"POST","path":"/reference/bankCodes/countries/{countryId}/ibanStructures","fullPath":"/api/v2.2.0/reference/bankCodes/countries/{countryId}/ibanStructures","operationId":"createIbanStructure","name":"The IBAN International Bank Account Number is used in cross border payment transactions.  The IBAN structure comprises upto 34 digits:  Country Code - 2 digit ISO country code Check Digit - 2 digit Basic Bank Account Number BBAN - upto 30 digits  The BBAN can be country specific. In most cases, the IBAN structure is uploaded from the SWIFT official site.  This endpoint is used to create the country specific IBAN structure.","summary":"Creates the country specific IBAN structure","tags":[],"parameters":[{"name":"countryId","in":"path","type":"string","required":true,"description":"ISO country code of the financial institution. "},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"countryCode":"string","countryCodePosition":"string","countryCodeLength":"string","checkDigitsPosition":"string","checkDigitsLength":"string","bankIdentifierPosition":"string","bankIdentifierLength":"string","branchIdentifierPosition":"string","branchIdentifierLength":"string","accountNumberPosition":"string","accountNumberLength":"string","totalLength":"string","bankIdApplication":"string","bankIdField":"string","branchIdApplication":"string"}},"responses":{"200":"IbanStructureResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/reference/bankCodes/countries/{countryId}/ibanStructures","fullPath":"/api/v2.2.0/reference/bankCodes/countries/{countryId}/ibanStructures","operationId":"updateIbanStructure","name":"The IBAN (International Bank Account Number) is used in cross border payment transactions.  The IBAN structure comprises upto 34 digits:  Country Code - 2 digit ISO country code Check Digit - 2 digit Basic Bank Account Number (BBAN) - upto 30 digits  The BBAN can be country specific. In most cases, the IBAN structure is uploaded from the SWIFT official site.  This endpoint is used to modify the country specific IBAN structure","summary":"Update the country specific IBAN structure","tags":[],"parameters":[{"name":"countryId","in":"path","type":"string","required":true,"description":""},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"countryCode":"string","countryCodePosition":"string","countryCodeLength":"string","checkDigitsPosition":"string","checkDigitsLength":"string","bankIdentifierPosition":"string","bankIdentifierLength":"string","branchIdentifierPosition":"string","branchIdentifierLength":"string","accountNumberPosition":"string","accountNumberLength":"string","totalLength":"string","bankIdApplication":"string","bankIdField":"string","branchIdApplication":"string"}},"responses":{"200":"IbanStructureResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"DELETE","path":"/reference/bankCodes/countries/{countryId}/ibanStructures","fullPath":"/api/v2.2.0/reference/bankCodes/countries/{countryId}/ibanStructures","operationId":"deleteIbanStructure","name":"Delete the country specific IBAN structure in cross border payment transactions.  The IBAN structure comprises up to 34 digits:  Country Code - 2 digit ISO country code Check Digit - 2 digit Basic Bank Account Number (BBAN) - up to 30 digits  The BBAN can be country specific. In most cases, the IBAN structure is uploaded from the SWIFT official site.  This endpoint is used to modify the country specific IBAN structure","summary":"Delete the country specific IBAN structure","tags":[],"parameters":[{"name":"countryId","in":"path","type":"string","required":true,"description":""},{"name":"payload","in":"body","type":"object","required":false,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}}},"responses":{"200":"IbanStructureResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/reference/bankCodes/ibans/{ibanId}/validity","fullPath":"/api/v2.2.0/reference/bankCodes/ibans/{ibanId}/validity","operationId":"validateIBAN","name":"Retrieves the status on the validity of the given IBAN number, returns YES if IBAN number is valid","summary":"Retrieves the status on the validity of the given IBAN number","tags":[],"parameters":[{"name":"ibanId","in":"path","type":"string","required":true,"description":"Identifier of the international bank account number"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"IBANResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"POST","path":"/reference/bankCodes/ibans/ibanPlusDirectories","fullPath":"/api/v2.2.0/reference/bankCodes/ibans/ibanPlusDirectories","operationId":"createIbanPlusDirectory","name":"IBAN plus provides a worldwide central database that contains IBAN-related data for financial institutions in SEPA and non-SEPA countries that have adopted IBAN. With the IBAN plus, it is possible to validate the IBAN and derive the BIC from IBAN. This endpoint is used to create the client specific IBAN plus directory","summary":"Creates the IBAN plus directory","tags":[],"parameters":[{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"excludedCompanies":[{}],"allowedCompanies":[{}],"countryId":"string","countryCode":"string","ibanBic":"string","routingBicCode":"string","ibanNationalId":"string","modificationDetail":"string","status":"string","extensions":{}}},"responses":{"200":"IbanPlusDirectoryResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/reference/bankCodes/ibans/ibanPlusDirectories/{ibanPlusDirectoryId}","fullPath":"/api/v2.2.0/reference/bankCodes/ibans/ibanPlusDirectories/{ibanPlusDirectoryId}","operationId":"updateIbanPlusDirectory","name":"IBAN plus provides a worldwide central database that contains IBAN-related data for financial institutions in SEPA and non-SEPA countries that have adopted IBAN. With the IBAN plus, it is possible to validate the IBAN and derive the BIC from IBAN. This endpoint is used to modify the client specific IBAN plus directory","summary":"Update the IBAN Plus directory","tags":[],"parameters":[{"name":"ibanPlusDirectoryId","in":"path","type":"string","required":true,"description":""},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"excludedCompanies":[{}],"allowedCompanies":[{}],"countryId":"string","countryCode":"string","ibanBic":"string","routingBicCode":"string","ibanNationalId":"string","modificationDetail":"string","status":"string","extensions":{}}},"responses":{"200":"IbanPlusDirectoryResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"POST","path":"/reference/bankCodes/ibans/ibanExclusionLists","fullPath":"/api/v2.2.0/reference/bankCodes/ibans/ibanExclusionLists","operationId":"createIbanExclusionList","name":"An IBAN exclusion list provides a listing of all bank IDs that should not be used in IBANs. The exclusion list allows users to check the validity of a bank id and enables the detection of invalid IBANs in the payment and direct debit processing. This endpoint is used to create the client specific IBAN exclusion list.","summary":"Create the list of bank IDs that are to be excluded in IBAN validations.","tags":[],"parameters":[{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"excludedCompanies":[{}],"allowedCompanies":[{}],"countryCode":"string","ibanNationalId":"string","bicId":"string","validFrom":"string","status":"string","modificationDetail":"string","extensions":{}}},"responses":{"200":"IbanExclusionListResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/reference/bankCodes/ibans/ibanExclusionLists/{ibanExclusionListId}","fullPath":"/api/v2.2.0/reference/bankCodes/ibans/ibanExclusionLists/{ibanExclusionListId}","operationId":"getIbanExclusionList","name":"An IBAN exclusion list provides a listing of all bank IDs that should not be used in IBANs.The exclusion list allows users to check the validity of a bank id and enables the detection of invalid IBANs in the payment and direct debit processing. This endpoint is used to retrieve the client specific IBAN exclusion list.","summary":"Retrieve the list of bank IDs that are to be excluded in IBAN validations.","tags":[],"parameters":[{"name":"ibanExclusionListId","in":"path","type":"string","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"IbanExclusionListResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/reference/bankCodes/ibans/ibanExclusionLists/{ibanExclusionListId}","fullPath":"/api/v2.2.0/reference/bankCodes/ibans/ibanExclusionLists/{ibanExclusionListId}","operationId":"updateIbanExclusionList","name":"An IBAN exclusion list provides a listing of all bank IDs that should not be used in IBANs.The exclusion list allows users to check the validity of a bank id and enables the detection of invalid IBANs in the payment and direct debit processing. This endpoint is used to update the client specific IBAN exclusion list.","summary":"Update the list of bank IDs that are to be excluded in IBAN validations.","tags":[],"parameters":[{"name":"ibanExclusionListId","in":"path","type":"string","required":true,"description":""},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"excludedCompanies":[{}],"allowedCompanies":[{}],"countryCode":"string","ibanNationalId":"string","bicId":"string","validFrom":"string","status":"string","modificationDetail":"string","extensions":{}}},"responses":{"200":"IbanExclusionListResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/reference/bankCodes/IBANs/ibanPlusDirectories","fullPath":"/api/v2.2.0/reference/bankCodes/IBANs/ibanPlusDirectories","operationId":"getIbanPlusDirectory","name":"IBAN plus provides a worldwide central database that contains IBAN-related data for financial institutions in SEPA and non-SEPA countries that have adopted IBAN. With the IBAN plus, it is possible to validate the IBAN and derive the BIC from IBAN. This endpoint retrieves the IBAN plus details such as country code, IBAN BIC, IBAN National id, IBAN plus directory status, allowed companies, excluded companies, routine BIC code and modification details.","summary":"Retrieves the IBAN Plus directory details","tags":[],"parameters":[{"name":"ibanPlusDirectoryId","in":"query","type":"string","required":false,"description":"Identifier of the IBAN plus directory"},{"name":"bicId","in":"query","type":"string","required":false,"description":"Bank Identifier Code (BIC) of the Beneficiary bank."},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"IbanPlusDirectoryResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/reference/bankCodes/IBANs/ibanCreationCalculator/{bicId}/{accountNumber}","fullPath":"/api/v2.2.0/reference/bankCodes/IBANs/ibanCreationCalculator/{bicId}/{accountNumber}","operationId":"getIBANFromBIC","name":"Retrieves the International Bank Account number (IBAN) for the requested Bank Identifier Code (BIC) and account id. The BIC is the SWIFT Address assigned to a bank in order to send automated payments to the banks concerned. It uniquely identifies the name and country of the bank. The BIC and account id is part of the IBAN when used for international funds transfers.","summary":"Retrieves the IBAN for the requested BIC code","tags":[],"parameters":[{"name":"bicId","in":"path","type":"string","required":true,"description":"Bank Identifier Code (BIC) of the Beneficiary bank."},{"name":"accountNumber","in":"path","type":"string","required":true,"description":"Identifier of the account. Often referred to as the account number, yet for consistency this is always referred to as accountId. Accepts both IBAN & BBAN"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"IBANFromBICResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}}]},{"key":"reference-IBANs-v2.3.0","title":"International Bank Account Number IBAN","version":"v2.3.0","description":"API to manage International Bank Account Number (IBAN) related services. The IBAN consists of up to 34 alphanumeric characters comprising a country code; two check digits; and a number that includes the domestic bank account number, branch identifier, and potential routing information. IBAN example:","endpointCount":17,"endpoints":[{"method":"GET","path":"/reference/bankCodes/ibans/{ibanId}/bic","fullPath":"/api/v2.3.0/reference/bankCodes/ibans/{ibanId}/bic","operationId":"getBICfromIBAN","name":"Retrieves the Bank Identifier Code (BIC) for the requested IBAN. The BIC is the SWIFT Address assigned to a bank in order to send automated payments to the banks concerned. It uniquely identifies the name and country of the bank. ","summary":"Retrieves the BIC code for the requested IBAN","tags":["OTHERS"],"parameters":[{"name":"ibanId","in":"path","type":"string","required":true,"description":"Identifier of the international bank account number"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"BICfromIBANResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/reference/bankCodes/ibans/{ibanId}","fullPath":"/api/v2.3.0/reference/bankCodes/ibans/{ibanId}","operationId":"getIBANDetails","name":"Retrieves the components of the requested IBAN such as country code, checksum, bank identifier, branch identifier, account number and length","summary":"Retrieves the components of the requested IBAN","tags":["OTHERS"],"parameters":[{"name":"ibanId","in":"path","type":"string","required":true,"description":"Identifier of the international bank account number"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"IBANDetailsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/reference/bankCodes/bbans/{bbanId}/iban","fullPath":"/api/v2.3.0/reference/bankCodes/bbans/{bbanId}/iban","operationId":"getIBANFromBBAN","name":"Retrieves the IBAN for a given Basic Bank Account Number (BBAN) and country code. The BBAN can be up to 30 alphanumeric characters that are country-specific. The BBAN is the last part of the IBAN when used for international funds transfers. ","summary":"Retrieves IBAN from a BBAN","tags":["OTHERS"],"parameters":[{"name":"bbanId","in":"path","type":"string","required":true,"description":"Indicates Basic Bank Account Number, represents a country specific bank account number"},{"name":"countryId","in":"query","type":"string","required":true,"description":"ISO country code of the financial institution. "},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"IBANFromBBANResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/reference/bankCodes/ibans","fullPath":"/api/v2.3.0/reference/bankCodes/ibans","operationId":"getIBANNumberGenerated","name":"Retrieves the IBAN number generated based on the given components such as country code, account identifier, bank identifier and branch identifier","summary":"Retrieves the generated IBAN number","tags":["OTHERS"],"parameters":[{"name":"accountId","in":"query","type":"string","required":true,"description":"Identifier of the account. Often referred to as the account number, yet for consistency this is always referred to as accountId. Accepts both IBAN & BBAN"},{"name":"bankId","in":"query","type":"string","required":true,"description":"Contains the identifier of the bank with which the transaction is performed"},{"name":"branchId","in":"query","type":"string","required":false,"description":"Unique and unambiguous identification of a branch of a financial institution."},{"name":"countryId","in":"query","type":"string","required":true,"description":"ISO country code of the financial institution. "},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"IBANNumberGeneratedResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/reference/bankCodes/ibans/{ibanId}/validity","fullPath":"/api/v2.3.0/reference/bankCodes/ibans/{ibanId}/validity","operationId":"validateIBAN","name":"Retrieves the status on the validity of the given IBAN number, returns YES if IBAN number is valid","summary":"Retrieves the status on the validity of the given IBAN number","tags":["OTHERS"],"parameters":[{"name":"ibanId","in":"path","type":"string","required":true,"description":"Identifier of the international bank account number"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"IBANResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/reference/bankCodes/countries/{countryId}/ibanStructures","fullPath":"/api/v2.3.0/reference/bankCodes/countries/{countryId}/ibanStructures","operationId":"getIBANStructure","name":"Retrieves the country specific structure of an IBAN number","summary":"Retrieves the structure of an IBAN number","tags":["OTHERS"],"parameters":[{"name":"countryId","in":"path","type":"string","required":true,"description":"ISO country code of the financial institution. "},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"IBANStructureResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"POST","path":"/reference/bankCodes/countries/{countryId}/ibanStructures","fullPath":"/api/v2.3.0/reference/bankCodes/countries/{countryId}/ibanStructures","operationId":"createIbanStructure","name":"The IBAN International Bank Account Number is used in cross border payment transactions.  The IBAN structure comprises upto 34 digits:  Country Code - 2 digit ISO country code Check Digit - 2 digit Basic Bank Account Number BBAN - upto 30 digits  The BBAN can be country specific. In most cases, the IBAN structure is uploaded from the SWIFT official site.  This endpoint is used to create the country specific IBAN structure.","summary":"Creates the country specific IBAN structure","tags":["OTHERS"],"parameters":[{"name":"countryId","in":"path","type":"string","required":true,"description":"ISO country code of the financial institution. "},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"countryCode":"string","countryCodePosition":"string","countryCodeLength":"string","checkDigitsPosition":"string","checkDigitsLength":"string","bankIdentifierPosition":"string","bankIdentifierLength":"string","branchIdentifierPosition":"string","branchIdentifierLength":"string","accountNumberPosition":"string","accountNumberLength":"string","totalLength":"string","bankIdApplication":"string","bankIdField":"string","branchIdApplication":"string"}},"responses":{"200":"IbanStructureResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/reference/bankCodes/countries/{countryId}/ibanStructures","fullPath":"/api/v2.3.0/reference/bankCodes/countries/{countryId}/ibanStructures","operationId":"updateIbanStructure","name":"The IBAN (International Bank Account Number) is used in cross border payment transactions.  The IBAN structure comprises upto 34 digits:  Country Code - 2 digit ISO country code Check Digit - 2 digit Basic Bank Account Number (BBAN) - upto 30 digits  The BBAN can be country specific. In most cases, the IBAN structure is uploaded from the SWIFT official site.  This endpoint is used to modify the country specific IBAN structure","summary":"Update the country specific IBAN structure","tags":["OTHERS"],"parameters":[{"name":"countryId","in":"path","type":"string","required":true,"description":""},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"countryCode":"string","countryCodePosition":"string","countryCodeLength":"string","checkDigitsPosition":"string","checkDigitsLength":"string","bankIdentifierPosition":"string","bankIdentifierLength":"string","branchIdentifierPosition":"string","branchIdentifierLength":"string","accountNumberPosition":"string","accountNumberLength":"string","totalLength":"string","bankIdApplication":"string","bankIdField":"string","branchIdApplication":"string"}},"responses":{"200":"IbanStructureResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"DELETE","path":"/reference/bankCodes/countries/{countryId}/ibanStructures","fullPath":"/api/v2.3.0/reference/bankCodes/countries/{countryId}/ibanStructures","operationId":"deleteIbanStructure","name":"Delete the country specific IBAN structure in cross border payment transactions.  The IBAN structure comprises up to 34 digits:  Country Code - 2 digit ISO country code Check Digit - 2 digit Basic Bank Account Number (BBAN) - up to 30 digits  The BBAN can be country specific. In most cases, the IBAN structure is uploaded from the SWIFT official site.  This endpoint is used to modify the country specific IBAN structure","summary":"Delete the country specific IBAN structure","tags":["OTHERS"],"parameters":[{"name":"countryId","in":"path","type":"string","required":true,"description":""},{"name":"payload","in":"body","type":"object","required":false,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}}},"responses":{"200":"IbanStructureResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"POST","path":"/reference/bankCodes/ibans/ibanPlusDirectories","fullPath":"/api/v2.3.0/reference/bankCodes/ibans/ibanPlusDirectories","operationId":"createIbanPlusDirectory","name":"IBAN plus provides a worldwide central database that contains IBAN-related data for financial institutions in SEPA and non-SEPA countries that have adopted IBAN. With the IBAN plus, it is possible to validate the IBAN and derive the BIC from IBAN. This endpoint is used to create the client specific IBAN plus directory","summary":"Creates the IBAN plus directory","tags":["OTHERS"],"parameters":[{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"excludedCompanies":[{}],"allowedCompanies":[{}],"countryId":"string","countryCode":"string","ibanBic":"string","routingBicCode":"string","ibanNationalId":"string","modificationDetail":"string","status":"string","extensions":{}}},"responses":{"200":"IbanPlusDirectoryResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/reference/bankCodes/ibans/ibanPlusDirectories/{ibanPlusDirectoryId}","fullPath":"/api/v2.3.0/reference/bankCodes/ibans/ibanPlusDirectories/{ibanPlusDirectoryId}","operationId":"updateIbanPlusDirectory","name":"IBAN plus provides a worldwide central database that contains IBAN-related data for financial institutions in SEPA and non-SEPA countries that have adopted IBAN. With the IBAN plus, it is possible to validate the IBAN and derive the BIC from IBAN. This endpoint is used to modify the client specific IBAN plus directory","summary":"Update the IBAN Plus directory","tags":["OTHERS"],"parameters":[{"name":"ibanPlusDirectoryId","in":"path","type":"string","required":true,"description":""},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"excludedCompanies":[{}],"allowedCompanies":[{}],"countryId":"string","countryCode":"string","ibanBic":"string","routingBicCode":"string","ibanNationalId":"string","modificationDetail":"string","status":"string","extensions":{}}},"responses":{"200":"IbanPlusDirectoryResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"POST","path":"/reference/bankCodes/ibans/ibanExclusionLists","fullPath":"/api/v2.3.0/reference/bankCodes/ibans/ibanExclusionLists","operationId":"createIbanExclusionList","name":"An IBAN exclusion list provides a listing of all bank IDs that should not be used in IBANs. The exclusion list allows users to check the validity of a bank id and enables the detection of invalid IBANs in the payment and direct debit processing. This endpoint is used to create the client specific IBAN exclusion list.","summary":"Create the list of bank IDs that are to be excluded in IBAN validations.","tags":["OTHERS"],"parameters":[{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"excludedCompanies":[{}],"allowedCompanies":[{}],"countryCode":"string","ibanNationalId":"string","bicId":"string","validFrom":"string","status":"string","modificationDetail":"string","extensions":{}}},"responses":{"200":"IbanExclusionListResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/reference/bankCodes/ibans/ibanExclusionLists/{ibanExclusionListId}","fullPath":"/api/v2.3.0/reference/bankCodes/ibans/ibanExclusionLists/{ibanExclusionListId}","operationId":"getIbanExclusionList","name":"An IBAN exclusion list provides a listing of all bank IDs that should not be used in IBANs.The exclusion list allows users to check the validity of a bank id and enables the detection of invalid IBANs in the payment and direct debit processing. This endpoint is used to retrieve the client specific IBAN exclusion list.","summary":"Retrieve the list of bank IDs that are to be excluded in IBAN validations.","tags":["OTHERS"],"parameters":[{"name":"ibanExclusionListId","in":"path","type":"string","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"IbanExclusionListResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/reference/bankCodes/ibans/ibanExclusionLists/{ibanExclusionListId}","fullPath":"/api/v2.3.0/reference/bankCodes/ibans/ibanExclusionLists/{ibanExclusionListId}","operationId":"updateIbanExclusionList","name":"An IBAN exclusion list provides a listing of all bank IDs that should not be used in IBANs.The exclusion list allows users to check the validity of a bank id and enables the detection of invalid IBANs in the payment and direct debit processing. This endpoint is used to update the client specific IBAN exclusion list.","summary":"Update the list of bank IDs that are to be excluded in IBAN validations.","tags":["OTHERS"],"parameters":[{"name":"ibanExclusionListId","in":"path","type":"string","required":true,"description":""},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"excludedCompanies":[{}],"allowedCompanies":[{}],"countryCode":"string","ibanNationalId":"string","bicId":"string","validFrom":"string","status":"string","modificationDetail":"string","extensions":{}}},"responses":{"200":"IbanExclusionListResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/reference/bankCodes/IBANs/ibanPlusDirectories","fullPath":"/api/v2.3.0/reference/bankCodes/IBANs/ibanPlusDirectories","operationId":"getIbanPlusDirectory","name":"IBAN plus provides a worldwide central database that contains IBAN-related data for financial institutions in SEPA and non-SEPA countries that have adopted IBAN. With the IBAN plus, it is possible to validate the IBAN and derive the BIC from IBAN. This endpoint retrieves the IBAN plus details such as country code, IBAN BIC, IBAN National id, IBAN plus directory status, allowed companies, excluded companies, routine BIC code and modification details.","summary":"Retrieves the IBAN Plus directory details","tags":["OTHERS"],"parameters":[{"name":"ibanPlusDirectoryId","in":"query","type":"string","required":false,"description":"Identifier of the IBAN plus directory"},{"name":"bicId","in":"query","type":"string","required":false,"description":"Bank Identifier Code (BIC) of the financial institution"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"IbanPlusDirectoryResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/reference/bankCodes/IBANs/ibanCreationCalculator/{bicId}/{accountNumber}","fullPath":"/api/v2.3.0/reference/bankCodes/IBANs/ibanCreationCalculator/{bicId}/{accountNumber}","operationId":"getIBANFromBIC","name":"Retrieves the International Bank Account number (IBAN) for the requested Bank Identifier Code (BIC) and account id. The BIC is the SWIFT Address assigned to a bank in order to send automated payments to the banks concerned. It uniquely identifies the name and country of the bank. The BIC and account id is part of the IBAN when used for international funds transfers.","summary":"Retrieves the IBAN for the requested BIC code","tags":["OTHERS"],"parameters":[{"name":"bicId","in":"path","type":"string","required":true,"description":"Bank Identifier Code (BIC) of the financial institution"},{"name":"accountNumber","in":"path","type":"string","required":true,"description":"Identifier of the account. Often referred to as the account number, yet for consistency this is always referred to as accountId. Accepts both IBAN & BBAN"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"IBANFromBICResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/reference/bankCodes/ibans/{countryId}/{ibanNationalId}/ibanExclusionLists","fullPath":"/api/v2.3.0/reference/bankCodes/ibans/{countryId}/{ibanNationalId}/ibanExclusionLists","operationId":"getIbanExclusionByCountry","name":"Retrieves the IBAN exclusion details with information such as custom exclusion code, future exclusion code and exclusion code based on which the IBAN exclusion list will be referred to determine list of all bank IDs that should not be used in IBANs.","summary":"Retrieves the IBAN exclusion details based on the country id and national id.","tags":["OTHERS"],"parameters":[{"name":"countryId","in":"path","type":"string","required":true,"description":"ISO country code of the financial institution. "},{"name":"ibanNationalId","in":"path","type":"string","required":true,"description":"Contains the national id that is included in the IBAN in the IBAN Plus directory"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"IbanExclusionByCountryResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}}]},{"key":"reference-accountConfigurations-service-v1.0.0","title":"Account Configurations","version":"v1.0.0","description":"APIs to manage the account and financial accounting configurations with properties such as accounting modes, allowed alternate id types for account, categories of customer and contingent accounts, cashflow days at SYSTEM level.","endpointCount":1,"endpoints":[{"method":"GET","path":"/reference/accounts/alternateIdTypes","fullPath":"/api/v1.0.0/reference/accounts/alternateIdTypes","operationId":"getAlternateIdTypes","name":"Retrieves the list of allowed alternate account id types for an account. References like IBAN, BBAN can be configured as alternate account id types based on which alternate references can be created for the account","summary":"Retrieves the list of alternate account id types","tags":["BUSINESS BANKING"],"parameters":[{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"AlternateIdTypesResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}}]},{"key":"reference-accountOfficers-service-v1.0.0","title":"Department Account Officer","version":"v1.0.0","description":"API to retrieve the list of department or account officers defined in the system used for various purposes such as recording transactions allocated to an account officer or for customer relationship management i.e. an account officer can be assigned to different customers.","endpointCount":7,"endpoints":[{"method":"GET","path":"/reference/accountOfficers","fullPath":"/api/v1.0.0/reference/accountOfficers","operationId":"getAccountOfficers","name":"Retrieves the list of Account Officers available in the system","summary":"Retrieves Account Officers","tags":[],"parameters":[{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from t24 on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"The identifier of the underlying Entity/Company/Branch."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"AccountOfficersResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/reference/accountOfficers/{accountOfficerId}","fullPath":"/api/v1.0.0/reference/accountOfficers/{accountOfficerId}","operationId":"getAccountOfficerDetails","name":"Retrieve the name, area, delivery point, department, department level, allowed or prohibited companies, telephone number and fax number details of Account officer","summary":"Retrieve details of account officer","tags":[],"parameters":[{"name":"accountOfficerId","in":"path","type":"string","required":true,"description":"The identifier of the department head or specific account officer responsible for the customer"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"The identifier of the underlying Entity/Company/Branch."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"AccountOfficerDetailsResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"POST","path":"/reference/accountOfficers/{accountOfficerId}","fullPath":"/api/v1.0.0/reference/accountOfficers/{accountOfficerId}","operationId":"createAccountOfficerDetails","name":"Creates the name, area, delivery point, department, department level, allowed or prohibited companies, telephone number and fax number details of Account officer","summary":"Create details of account officer","tags":[],"parameters":[{"name":"accountOfficerId","in":"path","type":"string","required":true,"description":"The identifier of the department head or specific account officer responsible for the customer"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"The identifier of the underlying Entity/Company/Branch."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"excludedCompanies":[{}],"allowedCompanies":[{}],"accountOfficerName":"string","accountOfficerArea":"string","addressLocation":"string","departmentId":0.0,"level":"string","parent":0.0,"isSecureMessage":"string","phoneNumber":"string","faxId":"string"}},"responses":{"200":"AccountOfficerDetailsResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/reference/accountOfficers/{accountOfficerId}","fullPath":"/api/v1.0.0/reference/accountOfficers/{accountOfficerId}","operationId":"updateAccountOfficerDetails","name":"Update the name, area, delivery point, department, department level, allowed or prohibited companies, telephone number and fax number details of Account officer","summary":"Update details of account officer","tags":[],"parameters":[{"name":"accountOfficerId","in":"path","type":"string","required":true,"description":"The identifier of the department head or specific account officer responsible for the customer"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"The identifier of the underlying Entity/Company/Branch."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"excludedCompanies":[{}],"allowedCompanies":[{}],"accountOfficerName":"string","accountOfficerArea":"string","addressLocation":"string","departmentId":0.0,"level":"string","parent":0.0,"isSecureMessage":"string","phoneNumber":"string","faxId":"string"}},"responses":{"200":"AccountOfficerDetailsResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/reference/accountOfficers/{accountOfficerId}/alertSubscriptions","fullPath":"/api/v1.0.0/reference/accountOfficers/{accountOfficerId}/alertSubscriptions","operationId":"getAccountOfficerAlertSubscription","name":"Retrieves the details such as name, area, event subscribed and its associated alert request for the requested account officer","summary":"Retrieve account officer's alert subscriptions","tags":[],"parameters":[{"name":"accountOfficerId","in":"path","type":"string","required":true,"description":"The identifier of the department head or specific account officer responsible for the customer"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"The identifier of the underlying Entity/Company/Branch."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"AccountOfficerAlertSubscriptionResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"POST","path":"/reference/accountOfficers/{accountOfficerId}/alertSubscriptions","fullPath":"/api/v1.0.0/reference/accountOfficers/{accountOfficerId}/alertSubscriptions","operationId":"createAccountOfficerAlertSubscription","name":"Creates the details such as name, area, event subscribed and its associated alert request for the requested account officer","summary":"Create account officer's alert subscriptions","tags":[],"parameters":[{"name":"accountOfficerId","in":"path","type":"string","required":true,"description":"The identifier of the department head or specific account officer responsible for the customer"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"The identifier of the underlying Entity/Company/Branch."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"alertsSubscribed":[{}],"accountOfficerName":"string","accountOfficerArea":"string","deliveryPoint":"string","departmentId":"string"}},"responses":{"200":"AccountOfficerAlertSubscriptionResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/reference/accountOfficers/{accountOfficerId}/alertSubscriptions","fullPath":"/api/v1.0.0/reference/accountOfficers/{accountOfficerId}/alertSubscriptions","operationId":"updateAccountOfficerAlertSubscription","name":"Updates the details such as name, area, event subscribed and its associated alert request for the requested account officer","summary":"Updates account officer's alert subscriptions","tags":[],"parameters":[{"name":"accountOfficerId","in":"path","type":"string","required":true,"description":"The identifier of the department head or specific account officer responsible for the customer"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"The identifier of the underlying Entity/Company/Branch."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"alertsSubscribed":[{}],"accountOfficerName":"string","accountOfficerArea":"string","deliveryPoint":"string","departmentId":"string"}},"responses":{"200":"AccountOfficerAlertSubscriptionResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}}]},{"key":"reference-balanceTypes-service-v1.0.0","title":"Balance Types","version":"v1.0.0","description":"API to retrieves the details of all the available Balance types","endpointCount":1,"endpoints":[{"method":"GET","path":"/reference/balanceTypes","fullPath":"/api/v1.0.0/reference/balanceTypes","operationId":"getBalanceTypes","name":"Retrieves the details of all the available Balance types","summary":"Retrieves the details of all the available Balance types","tags":[],"parameters":[{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from t24 on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":""},{"name":"companyId","in":"header","type":"string","required":false,"description":""}],"requestBodyExample":null,"responses":{"200":"BalanceTypesResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}}]},{"key":"reference-beneficiaries-service-v1.0.0","title":"Utility Beneficiaries","version":"v1.0.0","description":"Get and process information about Utility Beneficiaries","endpointCount":1,"endpoints":[{"method":"GET","path":"/reference/beneficiaries/utilityBeneficiaries","fullPath":"/api/v1.0.0/reference/beneficiaries/utilityBeneficiaries","operationId":"getUtilityBeneficiaries","name":"Retrieves utility beneficiaries details","summary":"Retrieves the utility beneficiaries details for a customerRetrieves the utility beneficiaries details for a customer","tags":[],"parameters":[{"name":"companyName","in":"query","type":"string","required":false,"description":"The company in which payment is processed"},{"name":"companyNameCT","in":"query","type":"string","required":false,"description":"The company in which payment is processed"},{"name":"beneficiaryId","in":"query","type":"string","required":false,"description":"Indicates the reference of the financial institution that allows access to the beneficiary information"},{"name":"beneficiaryAccountId","in":"query","type":"string","required":false,"description":"Unique account identifier of the beneficiary account number."},{"name":"bankSortCode","in":"query","type":"string","required":false,"description":"The sort code or the national clearing code of the beneficiary bank. "},{"name":"transactionType","in":"query","type":"string","required":false,"description":"Identifies the transaction type applicable to the transaction being processed, i.e. outward or inward payment. For example: ACPX, OTPX etc."},{"name":"preferredPaymentProductId","in":"query","type":"string","required":false,"description":"Denotes the identifier of the preferred payment product "},{"name":"beneficiaryIBAN","in":"query","type":"string","required":false,"description":"International Bank Account Number (IBAN) of the beneficiary account, required only for International transfers/payments outside the Bank. For example: GB98 MIDL07009312345678, FR7630006000011234567890"},{"name":"customerId","in":"query","type":"string","required":false,"description":"Identifier of the customer"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from t24 on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"UtilityBeneficiariesResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}}]},{"key":"reference-brokers-service-v1.0.0","title":"Brokers","version":"v1.0.0","description":"API to retrieve the brokers that are used by the organization","endpointCount":1,"endpoints":[{"method":"GET","path":"/reference/brokers","fullPath":"/api/v1.0.0/reference/brokers","operationId":"getBrokers","name":"Retrieves the list of brokers available in the system","summary":"Retrieves Brokers details","tags":[],"parameters":[{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from t24 on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"The identifier of the underlying Entity/Company/Branch."}],"requestBodyExample":null,"responses":{"200":"BrokersResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}}]},{"key":"reference-bundleRates-v1.0.0","title":"Cash management - Rates for a bundle master account","version":"v1.0.0","description":"Retrieves the Exchange and Internal Rate mapped for a bundle master account","endpointCount":2,"endpoints":[{"method":"GET","path":"/reference/cashManagement/bundles/{bundleId}/currencies/rates","fullPath":"/api/v1.0.0/reference/cashManagement/bundles/{bundleId}/currencies/rates","operationId":"getBundleExchangeRates","name":"Retrieves the Exchange Rate mapped against the given currency for a bundle master account","summary":"Retrieves the Exchange Rate mapped against the given currency for a bundle master account","tags":[],"parameters":[{"name":"bundleId","in":"path","type":"string","required":true,"description":"The field is to specify an arrangement reference which can act as a Master for the arrangement being created"},{"name":"currency","in":"query","type":"string","required":false,"description":"Contains all details of each individual currency, for example, currency name, number of decimal places together with other information such as the buy and sell rates"},{"name":"date","in":"query","type":"string","required":false,"description":"Indicates the date on which activity was performed"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from t24 on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"The identifier of the underlying Entity/Company/Branch."}],"requestBodyExample":null,"responses":{"200":"BundleExchangeRatesResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/reference/cashManagement/bundles/{bundleId}/currencies/cashPoolRates","fullPath":"/api/v1.0.0/reference/cashManagement/bundles/{bundleId}/currencies/cashPoolRates","operationId":"getBundleInternalRates","name":"Retrieves the Rate defined in Relationship accounts Preferential Pricing condition for the master account","summary":"Retrieves the Rate defined in Relationship accounts Preferential Pricing condition for the master account","tags":[],"parameters":[{"name":"bundleId","in":"path","type":"string","required":true,"description":"The field is to specify an arrangement reference which can act as a Master for the arrangement being created"},{"name":"currency","in":"query","type":"string","required":false,"description":"Contains all details of each individual currency, for example, currency name, number of decimal places together with other information such as the buy and sell rates"},{"name":"date","in":"query","type":"string","required":false,"description":"Indicates the date on which activity was performed"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from t24 on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"The identifier of the underlying Entity/Company/Branch."}],"requestBodyExample":null,"responses":{"200":"BundleInternalRatesResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}}]},{"key":"reference-ca-account-service-v1.1.0","title":"Account Management","version":"v1.1.0","description":"API to retrieve the list of account opening purpose codes.","endpointCount":1,"endpoints":[{"method":"GET","path":"/reference/ca/accounts/openingReasons","fullPath":"/api/v1.1.0/reference/ca/accounts/openingReasons","operationId":"getCaAccountOpenReasonCodes","name":"Retrieves the list of unique codes to capture the purpose of account opening","summary":"Retrieves the list of  intended use codes.","tags":["RETAIL"],"parameters":[{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"CaAccountOpenReasonCodesResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}}]},{"key":"reference-ca-billPayments-service-v1.0.0","title":"Bill payments","version":"v1.0.0","description":"API to retrieve the payee classification and payee details for bill payments process","endpointCount":2,"endpoints":[{"method":"GET","path":"/reference/ca/billPayments/payees/classifications","fullPath":"/api/v1.0.0/reference/ca/billPayments/payees/classifications","operationId":"getCaBillPayeeClassification","name":"Retrieves the list of payee classification details for the given groupId and description. ","summary":"Retrieves the list of payee classification details i.e vendor category details","tags":["RETAIL"],"parameters":[{"name":"categoryId","in":"query","type":"string","required":false,"description":"Unique identifier associated with the product name of the account or contract. For example: For customer/counterparty accounts, the identifier would be in the range 1000 to 9999. For ledger accounts, "},{"name":"description","in":"query","type":"string","required":false,"description":"Contains the description of purpose of the payment."},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"CaBillPayeeClassificationResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/reference/ca/billPayments/payees","fullPath":"/api/v1.0.0/reference/ca/billPayments/payees","operationId":"getCaBillPayee","name":"Retrieves the list of payee details for the given payee, groupId and payeeName.","summary":"Retrieves the list of payee details i.e vendor details","tags":["RETAIL"],"parameters":[{"name":"payee","in":"query","type":"string","required":false,"description":"Contains the key for creditor who receives payment from a transaction."},{"name":"groupId","in":"query","type":"string","required":false,"description":"Unique ID of the group"},{"name":"payeeName","in":"query","type":"string","required":false,"description":"Contains the name of payee to whom the money is being transferred"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"CaBillPayeeResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}}]},{"key":"reference-ca-cards-service-v1.1.0","title":"Card Management","version":"v1.1.0","description":"APIs to retrieve the list of card formats, card types and card access types","endpointCount":3,"endpoints":[{"method":"GET","path":"/reference/ca/cards/cardTypes","fullPath":"/api/v1.1.0/reference/ca/cards/cardTypes","operationId":"getCaCardType","name":"Retrieves the list of card types. Possible values of card types are VISA, MASTER, etc","summary":"Retrieves the list of card types","tags":["RETAIL"],"parameters":[{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"CaCardTypeResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/reference/ca/cards/businessAccessTypes","fullPath":"/api/v1.1.0/reference/ca/cards/businessAccessTypes","operationId":"getCaCardAccessType","name":"Retrieves the list of access types available for cards. Possible values of card access are 1 - only deposits. 2 - only withdrawal, 3 - no access. 6 - all access, etc.","summary":"Retrieves the list of access types available for cards ","tags":["RETAIL"],"parameters":[{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"CaCardAccessTypeResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/reference/ca/cards/cardFormats","fullPath":"/api/v1.1.0/reference/ca/cards/cardFormats","operationId":"getCaCardFormat","name":"Retrieves the list of card formats available. Possible values of card formats are BUSINESS, PERSONAL, etc","summary":"Retrieves the list of card formats available","tags":["RETAIL"],"parameters":[{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"CaCardFormatResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}}]},{"key":"reference-ca-cards-service-v1.2.0","title":"Card Management","version":"v1.2.0","description":"APIs to retrieve the list of card formats, card types and card access types","endpointCount":4,"endpoints":[{"method":"GET","path":"/reference/ca/cards/cardTypes","fullPath":"/api/v1.2.0/reference/ca/cards/cardTypes","operationId":"getCaCardType","name":"Retrieves the list of card types. Possible values of card types are VISA, MASTER, etc","summary":"Retrieves the list of card types","tags":["RETAIL"],"parameters":[{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"CaCardTypeResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/reference/ca/cards/businessAccessTypes","fullPath":"/api/v1.2.0/reference/ca/cards/businessAccessTypes","operationId":"getCaCardAccessType","name":"Retrieves the list of access types available for cards. Possible values of card access are 1 - only deposits. 2 - only withdrawal, 3 - no access. 6 - all access, etc.","summary":"Retrieves the list of access types available for cards ","tags":["RETAIL"],"parameters":[{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"CaCardAccessTypeResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/reference/ca/cards/cardFormats","fullPath":"/api/v1.2.0/reference/ca/cards/cardFormats","operationId":"getCaCardFormat","name":"Retrieves the list of card formats available. Possible values of card formats are BUSINESS, PERSONAL, etc","summary":"Retrieves the list of card formats available","tags":["RETAIL"],"parameters":[{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"CaCardFormatResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/reference/ca/cards/cardStatus","fullPath":"/api/v1.2.0/reference/ca/cards/cardStatus","operationId":"getCaCardStatus","name":"Retrieves the list of card status available. Possible values of card ordered, active, inactive, etc","summary":"Retrieves the list of card status available","tags":["RETAIL"],"parameters":[{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"CaCardStatusResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}}]},{"key":"reference-ca-customers-service-v1.1.0","title":"Customer Management","version":"v1.1.0","description":"API to retrieve the list of customer roles, list of document types, customer types, statement options and customer status","endpointCount":5,"endpoints":[{"method":"GET","path":"/reference/ca/signatories","fullPath":"/api/v1.1.0/reference/ca/signatories","operationId":"getCaSignatories","name":"Retrieves the list of signatories to be defined for an account","summary":"Retrieves the list of signatories ","tags":["RETAIL"],"parameters":[{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"CaSignatoriesResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/reference/ca/documentTypes","fullPath":"/api/v1.1.0/reference/ca/documentTypes","operationId":"getCaDocumentType","name":"Retrieves the list of documents to be provided for the customer onboarding ","summary":"Retrieves the list of documents for customer onboarding","tags":["RETAIL"],"parameters":[{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"CaDocumentTypeResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/reference/ca/customers/statuses","fullPath":"/api/v1.1.0/reference/ca/customers/statuses","operationId":"getCaCustomerStatus","name":"Retrieves the list of statuses applicable to a customer","summary":"Retrieves the list of customer statuses","tags":["RETAIL"],"parameters":[{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"CaCustomerStatusResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/reference/ca/customers/roles","fullPath":"/api/v1.1.0/reference/ca/customers/roles","operationId":"getCaCustomerRole","name":"Retrieves the list of customer roles available. Example - owner, spouse, guardian, etc","summary":"Retrieves the list of customer role available ","tags":["RETAIL"],"parameters":[{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"CaCustomerRoleResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/reference/ca/statements/deliveryPreferences","fullPath":"/api/v1.1.0/reference/ca/statements/deliveryPreferences","operationId":"getCaStatementDeliveryPreferences","name":"Retrieves the list of options to receive the customer/account statement. Possbile values print, email, etc","summary":"Retrieves the list of options to receive the customer/account statement","tags":["RETAIL"],"parameters":[{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"CaStatementDeliveryPreferencesResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}}]},{"key":"reference-ca-payment-service-v1.1.0","title":"Payment Management","version":"v1.1.0","description":"APIs to retrieve the list of transaction types used for funds transfer","endpointCount":1,"endpoints":[{"method":"GET","path":"/reference/ca/transactionTypes","fullPath":"/api/v1.1.0/reference/ca/transactionTypes","operationId":"getCaTransactionTypes","name":"Retrieves the list of transactions types used for transfer of funds.","summary":"Retrieves the list of transactions types","tags":["RETAIL"],"parameters":[{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"CaTransactionTypesResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}}]},{"key":"reference-ca-regsiteredPlans-service-v1.0.0","title":"Registered plans","version":"v1.0.0","description":"Canadian reference APIs to retrieve the plan types, plan transaction codes, contributions, withdrawals and reversals","endpointCount":2,"endpoints":[{"method":"GET","path":"/reference/ca/registeredPlans/planGroups/{planGroupId}/planTypes","fullPath":"/api/v1.0.0/reference/ca/registeredPlans/planGroups/{planGroupId}/planTypes","operationId":"getCaPlanTypes","name":"Retrieves the list of registered plan types for a given plan group","summary":"Retrieves the list of registered plan types","tags":[],"parameters":[{"name":"planGroupId","in":"path","type":"string","required":true,"description":"Contains the type of registered plans. Example - RRSP-REG, RRIF-REG, TFSA, etc"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"CaPlanTypesResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/reference/ca/registeredPlans/planTypes/{planTypeId}/transactioncodes","fullPath":"/api/v1.0.0/reference/ca/registeredPlans/planTypes/{planTypeId}/transactioncodes","operationId":"getCaPlanTransactionCodes","name":"Retrieves the list of registered plan transaction codes for a given registered plan type","summary":"Retrieves the list of registered plan transaction codes","tags":[],"parameters":[{"name":"planTypeId","in":"path","type":"string","required":true,"description":"Contains the type of registered plans. Example - RRSP-REG, RRIF-REG, TFSA, etc"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"CaPlanTransactionCodesResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}}]},{"key":"reference-cards-service-v1.0.0","title":"Card Types","version":"v1.0.0","description":"Retrieves information on card types","endpointCount":1,"endpoints":[{"method":"GET","path":"/reference/cards/cardTypes","fullPath":"/api/v1.0.0/reference/cards/cardTypes","operationId":"getCardTypes","name":"Retrieves applicable card types for the specific types of accounts (savings, current, etc) or retrieves account types allowed for a specific type of card.","summary":"Retrieves card type details","tags":[],"parameters":[{"name":"cardType","in":"query","type":"string","required":false,"description":"The type of the card, e.g. Visa, Mastercard, etc."},{"name":"category","in":"query","type":"string","required":false,"description":"Indicates the account or contract product name. For example for an account this maybe current, savings etc."},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"CardTypesResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}}]},{"key":"reference-categories-service-v1.0.0","title":"Category Codes","version":"v1.0.0","description":"API to retrieve the details of category codes used to classify financial transactions on T24 according to the type of business operation or product.","endpointCount":4,"endpoints":[{"method":"GET","path":"/reference/categories","fullPath":"/api/v1.0.0/reference/categories","operationId":"getCategories","name":"Retrieves the list of categories","summary":"Retrieves list of categories","tags":[],"parameters":[{"name":"categoryId","in":"query","type":"string","required":false,"description":"Indicate a category code"},{"name":"categoryIdGE","in":"query","type":"string","required":false,"description":"Indicate a category code"},{"name":"categoryIdLE","in":"query","type":"string","required":false,"description":"Indicate a category code"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from t24 on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"The identifier of the underlying Entity/Company/Branch."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"CategoriesResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/reference/categories/{categoryId}","fullPath":"/api/v1.0.0/reference/categories/{categoryId}","operationId":"getCategoryDetails","name":"Retrieves the details of category such as short name, entry consolidation rule followed, position type and product using this code.","summary":"Retrieves the details of category code","tags":[],"parameters":[{"name":"categoryId","in":"path","type":"string","required":true,"description":"Indicate a category code"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"The identifier of the underlying Entity/Company/Branch."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"CategoryDetailsResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"POST","path":"/reference/categories/{categoryId}","fullPath":"/api/v1.0.0/reference/categories/{categoryId}","operationId":"createCategoryDetails","name":"Creates the details of category such as short name, entry consolidation rule followed, position type and product using this code.","summary":"Create the details of category code","tags":[],"parameters":[{"name":"categoryId","in":"path","type":"string","required":true,"description":"Unique identifier associated with the product name of the account or contract. For example: For customer/counterparty accounts, the identifier would be in the range 1000 to 9999. For ledger accounts, "},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"The identifier of the underlying Entity/Company/Branch."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"descriptions":[{}],"categoryNames":[{}],"productId":"string","reportingType":"string","entryConsolidationId":"string","positionType":"string"}},"responses":{"200":"CategoryDetailsResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/reference/categories/{categoryId}","fullPath":"/api/v1.0.0/reference/categories/{categoryId}","operationId":"updateCategoryDetails","name":"Updates the details of category such as short name, entry consolidation rule followed, position type and product using this code.","summary":"Updates the details of category code","tags":[],"parameters":[{"name":"categoryId","in":"path","type":"string","required":true,"description":"Unique identifier associated with the product name of the account or contract. For example: For customer/counterparty accounts, the identifier would be in the range 1000 to 9999. For ledger accounts, "},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"The identifier of the underlying Entity/Company/Branch."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"descriptions":[{}],"categoryNames":[{}],"productId":"string","reportingType":"string","entryConsolidationId":"string","positionType":"string"}},"responses":{"200":"CategoryDetailsResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}}]},{"key":"reference-chequeTypes-service-v1.0.0","title":"Cheque Types","version":"v1.0.0","description":"Get information about cheque types","endpointCount":1,"endpoints":[{"method":"GET","path":"/reference/chequeTypes","fullPath":"/api/v1.0.0/reference/chequeTypes","operationId":"getChequeTypes","name":"Retrieves cheque types details","summary":"Retrieves the list of cheque type details for an account","tags":[],"parameters":[{"name":"category","in":"query","type":"string","required":false,"description":"Indicates the account or contract product name. For example for an account this maybe current, savings etc."},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from t24 on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"ChequeTypesResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}}]},{"key":"reference-collateralClassifications-service-v1.0.0","title":"Collateral Types and Subtypes","version":"v1.0.0","description":"API to retrieve the list of collateral types and subtypes offered by the system. These classifications are used to categorize the customer collaterals","endpointCount":2,"endpoints":[{"method":"GET","path":"/reference/collaterals/collateralTypes","fullPath":"/api/v1.0.0/reference/collaterals/collateralTypes","operationId":"getCollateralTypes","name":"Retrieves the list of collateral types used to identify an item classified as collateral. Examples - cash deposits, equipment, inventory, real estates or securities","summary":"Retrieves collateral types","tags":[],"parameters":[{"name":"collateralCodeId","in":"query","type":"string","required":false,"description":"The identifier of the collateral type"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from t24 on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"The identifier of the underlying Entity/Company/Branch."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"CollateralTypesResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/reference/collaterals/collateralSubTypes","fullPath":"/api/v1.0.0/reference/collaterals/collateralSubTypes","operationId":"getCollateralSubTypes","name":"Retrieves the list of collateral subtype available under different collateral types. Examples - subtypes of real estates are agriculture, residential, commercial, industrial, mixed use or special","summary":"Retrieves collateral subtypes","tags":[],"parameters":[{"name":"collateralTypeId","in":"query","type":"string","required":false,"description":"Collateral classification Id defined in the system."},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from t24 on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"The identifier of the underlying Entity/Company/Branch."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"CollateralSubTypesResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}}]},{"key":"reference-collateralClassifications-service-v1.1.0","title":"Collateral Types and Subtypes","version":"v1.1.0","description":"API to retrieve the list of collateral types and subtypes offered by the system. These classifications are used to categorize the customer collaterals","endpointCount":2,"endpoints":[{"method":"GET","path":"/reference/collaterals/collateralTypes","fullPath":"/api/v1.1.0/reference/collaterals/collateralTypes","operationId":"getCollateralTypes","name":"Retrieves the list of collateral types used to identify an item classified as collateral. Examples - cash deposits, equipment, inventory, real estates or securities","summary":"Retrieves collateral types","tags":[],"parameters":[{"name":"collateralCodeId","in":"query","type":"string","required":false,"description":"Identifier of the collateral type"},{"name":"collateralTypeId","in":"query","type":"string","required":false,"description":"Collateral classification Id defined in the system."},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"CollateralTypesResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/reference/collaterals/collateralSubTypes","fullPath":"/api/v1.1.0/reference/collaterals/collateralSubTypes","operationId":"getCollateralSubTypes","name":"Retrieves the list of collateral subtype available under different collateral types. Examples - subtypes of real estates are agriculture, residential, commercial, industrial, mixed use or special","summary":"Retrieves collateral subtypes","tags":[],"parameters":[{"name":"collateralTypeId","in":"query","type":"string","required":false,"description":"Collateral classification Id defined in the system."},{"name":"application","in":"query","type":"string","required":false,"description":"Name of the application or virtual table"},{"name":"nominalValue","in":"query","type":"string","required":false,"description":"Indicates the nominal value of the collateral. For collateral types, this nominal value denotes the way it is for underlying collateral with the following options: M=Mandatory - the nominal value of t"},{"name":"executionValue","in":"query","type":"string","required":false,"description":"Denotes the value for signing the document at what is commonly referred to as the closing of the sale"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"CollateralSubTypesResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}}]},{"key":"reference-companies-service-v1.0.0","title":"Financial Companies","version":"v1.0.0","description":"API to retrieve the list of Companies defined in the system","endpointCount":2,"endpoints":[{"method":"GET","path":"/reference/companies","fullPath":"/api/v1.0.0/reference/companies","operationId":"getCompanies","name":"Retrieves list of the Companies that are used by the Bank or a legal entity","summary":"Retrieves Company details","tags":[],"parameters":[{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from t24 on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"The identifier of the underlying Entity/Company/Branch."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"CompaniesResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/reference/companies/{companyCode}/currencies/currencyMarkets/{currencyMarket}/exchangeRates","fullPath":"/api/v1.0.0/reference/companies/{companyCode}/currencies/currencyMarkets/{currencyMarket}/exchangeRates","operationId":"getCompanyCurrencyExchangeRates","name":"Retrieves the base currency of the supplied companyId and the exchange rates of the foreign currencies with respect to the base currency of the requested currency market.","summary":"Retrieves currency exchange rates of a financial institution","tags":[],"parameters":[{"name":"companyCode","in":"path","type":"string","required":true,"description":"The identifier of the underlying Entity/Company/Branch."},{"name":"currencyMarket","in":"path","type":"string","required":true,"description":"Identifies the currency market to be used to get the correct exchange and revaluation rates to be applied to each currency"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from t24 on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"The identifier of the underlying Entity/Company/Branch."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"CompanyCurrencyExchangeRatesResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}}]},{"key":"reference-companies-service-v1.1.0","title":"Financial Companies","version":"v1.1.0","description":"API to retrieve the list of Companies defined in the system","endpointCount":3,"endpoints":[{"method":"GET","path":"/reference/companies","fullPath":"/api/v1.1.0/reference/companies","operationId":"getCompanies","name":"Retrieves list of the Companies that are used by the Bank or a legal entity","summary":"Retrieves Company details","tags":[],"parameters":[{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"CompaniesResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/reference/companies/masterCompanies","fullPath":"/api/v1.1.0/reference/companies/masterCompanies","operationId":"getMasterCompany","name":"Retrieves the Master Company information that is used by the organization","summary":"Retrieves the Master Company","tags":[],"parameters":[{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"MasterCompanyResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/reference/companies/{companyCode}/currencies/currencyMarkets/{currencyMarket}/exchangeRates","fullPath":"/api/v1.1.0/reference/companies/{companyCode}/currencies/currencyMarkets/{currencyMarket}/exchangeRates","operationId":"getCompanyCurrencyExchangeRates","name":"Retrieves the base currency of the supplied companyId and the exchange rates of the foreign currencies with respect to the base currency of the requested currency market.","summary":"Retrieves currency exchange rates of a financial institution","tags":[],"parameters":[{"name":"companyCode","in":"path","type":"string","required":true,"description":"Specifies the company code which will be the master company for this institution. E.g. GB0010001, US0010001."},{"name":"currencyMarket","in":"path","type":"string","required":true,"description":"Identifies the currency market to be used to get the correct exchange and revaluation rates to be applied to each currency"},{"name":"currencyId","in":"query","type":"string","required":false,"description":"Identifier of the currency. This is the 3-letter ISO 4217 code of the currency."},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"CompanyCurrencyExchangeRatesResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}}]},{"key":"reference-companies-service-v2.0.0","title":"Financial Companies","version":"v2.0.0","description":"API to retrieve the list of Companies defined in the system","endpointCount":3,"endpoints":[{"method":"GET","path":"/reference/companies/{companyCode}/currencies/currencyMarkets/{currencyMarket}/exchangeRates","fullPath":"/api/v2.0.0/reference/companies/{companyCode}/currencies/currencyMarkets/{currencyMarket}/exchangeRates","operationId":"getCompanyCurrencyExchangeRates","name":"Retrieves the base currency of the supplied company id and the exchange rates of the foreign currencies with respect to the base currency of the requested currency market.","summary":"Retrieves currency exchange rates of a financial institution","tags":[],"parameters":[{"name":"companyCode","in":"path","type":"string","required":true,"description":"Specifies the company code which will be the master company for this institution. E.g. GB0010001, US0010001."},{"name":"currencyMarket","in":"path","type":"string","required":true,"description":"Identifies the currency market to be used to get the correct exchange and revaluation rates to be applied to each currency"},{"name":"currencyId","in":"query","type":"string","required":false,"description":"Identifier of the currency. This is the 3-letter ISO 4217 code of the currency."},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"CompanyCurrencyExchangeRatesResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/reference/companies/masterCompanies","fullPath":"/api/v2.0.0/reference/companies/masterCompanies","operationId":"getMasterCompany","name":"Retrieves the master company information that is used by the organization","summary":"Retrieves the master company","tags":[],"parameters":[{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"MasterCompanyResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/reference/companies","fullPath":"/api/v2.0.0/reference/companies","operationId":"getCompanyDetails","name":"Retrieves the details of the company including company code, mnemonic, whether a lead company or branch and the group to which the company belongs.","summary":"Retrieves the company details","tags":[],"parameters":[{"name":"groupId","in":"query","type":"string","required":false,"description":"Unique ID of the group"},{"name":"companyCode","in":"query","type":"string","required":false,"description":"Specifies the company code which will be the master company for this institution. E.g. GB0010001, US0010001."},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"CompanyDetailsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}}]},{"key":"reference-companies-service-v2.1.0","title":"Financial Companies","version":"v2.1.0","description":"API to retrieve the list of Companies defined in the system","endpointCount":9,"endpoints":[{"method":"GET","path":"/reference/companies/{companyCode}/currencies/currencyMarkets/{currencyMarket}/exchangeRates","fullPath":"/api/v2.1.0/reference/companies/{companyCode}/currencies/currencyMarkets/{currencyMarket}/exchangeRates","operationId":"getCompanyCurrencyExchangeRates","name":"Retrieves the base currency of the supplied company id and the exchange rates of the foreign currencies with respect to the base currency of the requested currency market.","summary":"Retrieves currency exchange rates of a financial institution","tags":[],"parameters":[{"name":"companyCode","in":"path","type":"string","required":true,"description":"The identifier of the underlying Entity/Company/Branch."},{"name":"currencyMarket","in":"path","type":"string","required":true,"description":"Identifies the currency market to be used to get the correct exchange and revaluation rates to be applied to each currency"},{"name":"currencyId","in":"query","type":"string","required":false,"description":"Identifier of the currency. This is the 3-letter ISO 4217 code of the currency."},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"CompanyCurrencyExchangeRatesResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/reference/companies/masterCompanies","fullPath":"/api/v2.1.0/reference/companies/masterCompanies","operationId":"getMasterCompany","name":"Retrieves the master company information that is used by the organization","summary":"Retrieves the master company","tags":[],"parameters":[{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"MasterCompanyResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/reference/companies","fullPath":"/api/v2.1.0/reference/companies","operationId":"getCompanyDetails","name":"Retrieves the details of the company including company code, mnemonic, whether a lead company or branch and the group to which the company belongs.","summary":"Retrieves the company details","tags":[],"parameters":[{"name":"groupId","in":"query","type":"string","required":false,"description":"Unique ID of the group"},{"name":"companyCode","in":"query","type":"string","required":false,"description":"The identifier of the underlying Entity/Company/Branch."},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"CompanyDetailsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/reference/companyInitiation/{companyCode}","fullPath":"/api/v2.1.0/reference/companyInitiation/{companyCode}","operationId":"getCompanyInitiationDetails","name":"Retrieves the company initiation details such as company address, company mnemonic, financial company, default company, company creation date & subdivision code","summary":"Retrieves the company initiation details.","tags":[],"parameters":[{"name":"companyCode","in":"path","type":"string","required":true,"description":"The identifier of the underlying Entity/Company/Branch."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"CompanyInitiationDetailsResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"POST","path":"/reference/companyInitiation/{companyCode}","fullPath":"/api/v2.1.0/reference/companyInitiation/{companyCode}","operationId":"initiateCompanyCreation","name":"Initiates the company creation process with which a lead company or a branch company can be created in the system.","summary":"Initiates the company creation process","tags":[],"parameters":[{"name":"companyCode","in":"path","type":"string","required":true,"description":"The identifier of the underlying Entity/Company/Branch."},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"bankAddresses":[{}],"companyName":"string","companyMnemonic":"string","financialCompany":"string","financialCompanyMnemonic":"string","subDivisionCode":"string","creationDate":"string","defaultCompany":"string","extensions":{}}},"responses":{"200":"CompanyCreationResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/reference/companyInitiation/{companyCode}","fullPath":"/api/v2.1.0/reference/companyInitiation/{companyCode}","operationId":"updateCompanyCreation","name":"Update company creation with details such as company address, company mnemonic, financial company, default company, company creation date and subdivision code","summary":"Update of company creation.","tags":[],"parameters":[{"name":"companyCode","in":"path","type":"string","required":true,"description":"The identifier of the underlying Entity/Company/Branch."},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"bankAddresses":[{}],"companyName":"string","companyMnemonic":"string","financialCompany":"string","financialCompanyMnemonic":"string","subDivisionCode":"string","creationDate":"string","defaultCompany":"string","extensions":{}}},"responses":{"200":"CompanyCreationResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/reference/companies/companyGroups/{companyGroupId}","fullPath":"/api/v2.1.0/reference/companies/companyGroups/{companyGroupId}","operationId":"getCompanyGroup","name":"Retrieves the company group detail such as company group description.","summary":"Retrieves the company group details.","tags":[],"parameters":[{"name":"companyGroupId","in":"path","type":"string","required":true,"description":"Identifier of the company group based on which the companies will be grouped together."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"CompanyGroupResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"POST","path":"/reference/companies/companyGroups/{companyGroupId}","fullPath":"/api/v2.1.0/reference/companies/companyGroups/{companyGroupId}","operationId":"createCompanyGroup","name":"Creates the company group to group multiple companies. During close of business processing, the grouped companies are processed together.","summary":"Creates the company group.","tags":[],"parameters":[{"name":"companyGroupId","in":"path","type":"string","required":true,"description":"Identifier of the company group based on which the companies will be grouped together."},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"displayName":"string","extensions":{}}},"responses":{"200":"CompanyGroupResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/reference/companies/companyGroups/{companyGroupId}","fullPath":"/api/v2.1.0/reference/companies/companyGroups/{companyGroupId}","operationId":"updateComapanyGroup","name":"Update company group with detail such as company group description","summary":"Update of company group","tags":[],"parameters":[{"name":"companyGroupId","in":"path","type":"string","required":true,"description":"Identifier of the company group based on which the companies will be grouped together."},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"displayName":"string","extensions":{}}},"responses":{"200":"ComapanyGroupResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}}]},{"key":"reference-companies-service-v2.2.0","title":"Financial Companies","version":"v2.2.0","description":"API to retrieve the list of Companies defined in the system","endpointCount":10,"endpoints":[{"method":"GET","path":"/reference/companies/{companyCode}/currencies/currencyMarkets/{currencyMarket}/exchangeRates","fullPath":"/api/v2.2.0/reference/companies/{companyCode}/currencies/currencyMarkets/{currencyMarket}/exchangeRates","operationId":"getCompanyCurrencyExchangeRates","name":"Retrieves the base currency of the supplied company id and the exchange rates of the foreign currencies with respect to the base currency of the requested currency market.","summary":"Retrieves currency exchange rates of a financial institution","tags":[],"parameters":[{"name":"companyCode","in":"path","type":"string","required":true,"description":"The identifier of the underlying Entity/Company/Branch."},{"name":"currencyMarket","in":"path","type":"string","required":true,"description":"Identifies the currency market to be used to get the correct exchange and revaluation rates to be applied to each currency"},{"name":"currencyId","in":"query","type":"string","required":false,"description":"Identifier of the currency. This is the 3-letter ISO 4217 code of the currency."},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"CompanyCurrencyExchangeRatesResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/reference/companies/masterCompanies","fullPath":"/api/v2.2.0/reference/companies/masterCompanies","operationId":"getMasterCompany","name":"Retrieves the master company information that is used by the organization","summary":"Retrieves the master company","tags":[],"parameters":[{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"MasterCompanyResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/reference/companies","fullPath":"/api/v2.2.0/reference/companies","operationId":"getCompanyDetails","name":"Retrieves the details of the company including company code, mnemonic, whether a lead company or branch and the group to which the company belongs.","summary":"Retrieves the company details","tags":[],"parameters":[{"name":"groupId","in":"query","type":"string","required":false,"description":"Unique ID of the group"},{"name":"companyCode","in":"query","type":"string","required":false,"description":"The identifier of the underlying Entity/Company/Branch."},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"CompanyDetailsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/reference/companyInitiation/{companyCode}","fullPath":"/api/v2.2.0/reference/companyInitiation/{companyCode}","operationId":"getCompanyInitiationDetails","name":"Retrieves the company initiation details such as company address, company mnemonic, financial company, default company, company creation date & subdivision code","summary":"Retrieves the company initiation details.","tags":[],"parameters":[{"name":"companyCode","in":"path","type":"string","required":true,"description":"The identifier of the underlying Entity/Company/Branch."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"CompanyInitiationDetailsResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"POST","path":"/reference/companyInitiation/{companyCode}","fullPath":"/api/v2.2.0/reference/companyInitiation/{companyCode}","operationId":"initiateCompanyCreation","name":"Initiates the company creation process with which a lead company or a branch company can be created in the system.","summary":"Initiates the company creation process","tags":[],"parameters":[{"name":"companyCode","in":"path","type":"string","required":true,"description":"The identifier of the underlying Entity/Company/Branch."},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"bankAddresses":[{}],"companyName":"string","companyMnemonic":"string","financialCompany":"string","financialCompanyMnemonic":"string","subDivisionCode":"string","creationDate":"string","defaultCompany":"string","extensions":{}}},"responses":{"200":"CompanyCreationResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/reference/companyInitiation/{companyCode}","fullPath":"/api/v2.2.0/reference/companyInitiation/{companyCode}","operationId":"updateCompanyCreation","name":"Update company creation with details such as company address, company mnemonic, financial company, default company, company creation date and subdivision code","summary":"Update of company creation.","tags":[],"parameters":[{"name":"companyCode","in":"path","type":"string","required":true,"description":"The identifier of the underlying Entity/Company/Branch."},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"bankAddresses":[{}],"companyName":"string","companyMnemonic":"string","financialCompany":"string","financialCompanyMnemonic":"string","subDivisionCode":"string","creationDate":"string","defaultCompany":"string","extensions":{}}},"responses":{"200":"CompanyCreationResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/reference/companies/companyGroups/{companyGroupId}","fullPath":"/api/v2.2.0/reference/companies/companyGroups/{companyGroupId}","operationId":"getCompanyGroup","name":"Retrieves the company group detail such as company group description.","summary":"Retrieves the company group details.","tags":[],"parameters":[{"name":"companyGroupId","in":"path","type":"string","required":true,"description":"Identifier of the company group based on which the companies will be grouped together."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"CompanyGroupResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"POST","path":"/reference/companies/companyGroups/{companyGroupId}","fullPath":"/api/v2.2.0/reference/companies/companyGroups/{companyGroupId}","operationId":"createCompanyGroup","name":"Creates the company group to group multiple companies. During close of business processing, the grouped companies are processed together.","summary":"Creates the company group.","tags":[],"parameters":[{"name":"companyGroupId","in":"path","type":"string","required":true,"description":"Identifier of the company group based on which the companies will be grouped together."},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"displayName":"string","extensions":{}}},"responses":{"200":"CompanyGroupResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/reference/companies/companyGroups/{companyGroupId}","fullPath":"/api/v2.2.0/reference/companies/companyGroups/{companyGroupId}","operationId":"updateComapanyGroup","name":"Update company group with detail such as company group description","summary":"Update of company group","tags":[],"parameters":[{"name":"companyGroupId","in":"path","type":"string","required":true,"description":"Identifier of the company group based on which the companies will be grouped together."},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"displayName":"string","extensions":{}}},"responses":{"200":"ComapanyGroupResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/reference/companyApprovals/{companyCode}","fullPath":"/api/v2.2.0/reference/companyApprovals/{companyCode}","operationId":"approveCompanyInitiation","name":"Update & approve the details of the company being created such as name, address, local currency, company group, branch holiday, official holiday ,batch holiday, etc. The company initiation process is as below: 1. Company creation will be initiated. 2. The Initiated company could be approved with or without amendments to the attributes. 3. Post approval, the new company will be created based on background process. ","summary":"Update and approve the company details.","tags":[],"parameters":[{"name":"companyCode","in":"path","type":"string","required":true,"description":"The identifier of the underlying Entity/Company/Branch."},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"companyNames":[{}],"bankAddresses":[{}],"specialCustomerDetails":[{}],"specialFinancialDetails":[{}],"companyMnemonic":"string","languageId":"string","localCurrency":"string","rateSystem":"string","customerCompany":"string","defaultCustomerCompany":"string","defaultFinancialCompany":"string","currencyCompany":"string","financialConfigurationCompany":"string","nostroCompany":"string","subDivisionCode":"string"}},"responses":{"200":"CompanyInitiationResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}}]},{"key":"reference-companies-service-v2.3.0","title":"Financial Companies","version":"v2.3.0","description":"API to create, approve an entity and create an entity group. Retrieve list of entities, exchange rate of an entity, master entity and list of entity groups.","endpointCount":10,"endpoints":[{"method":"GET","path":"/reference/companies/{companyCode}/currencies/currencyMarkets/{currencyMarket}/exchangeRates","fullPath":"/api/v2.3.0/reference/companies/{companyCode}/currencies/currencyMarkets/{currencyMarket}/exchangeRates","operationId":"getCompanyCurrencyExchangeRates","name":"Retrieves the base currency of the supplied company id and the exchange rates of the foreign currencies with respect to the base currency of the requested currency market.","summary":"Retrieves currency exchange rates of a financial institution","tags":["OTHERS"],"parameters":[{"name":"companyCode","in":"path","type":"string","required":true,"description":"The identifier of the underlying Entity/Company/Branch."},{"name":"currencyMarket","in":"path","type":"string","required":true,"description":"Identifies the currency market to be used to get the correct exchange and revaluation rates to be applied to each currency"},{"name":"currencyId","in":"query","type":"string","required":false,"description":"Identifier of the currency. This is the 3-letter ISO 4217 code of the currency."},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"CompanyCurrencyExchangeRatesResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/reference/companies/masterCompanies","fullPath":"/api/v2.3.0/reference/companies/masterCompanies","operationId":"getMasterCompany","name":"Retrieves the master company information that is used by the organization","summary":"Retrieves the master company","tags":["OTHERS"],"parameters":[{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"MasterCompanyResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/reference/companies","fullPath":"/api/v2.3.0/reference/companies","operationId":"getCompanyDetails","name":"Retrieves the details of the company including company code, mnemonic, whether a lead company or branch and the group to which the company belongs.","summary":"Retrieves the company details","tags":["OTHERS"],"parameters":[{"name":"groupId","in":"query","type":"string","required":false,"description":"Unique ID of the group"},{"name":"companyCode","in":"query","type":"string","required":false,"description":"The identifier of the underlying Entity/Company/Branch."},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"CompanyDetailsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/reference/companyInitiation/{companyCode}","fullPath":"/api/v2.3.0/reference/companyInitiation/{companyCode}","operationId":"getCompanyInitiationDetails","name":"Retrieves the company initiation details such as company address, company mnemonic, financial company, default company, company creation date & subdivision code","summary":"Retrieves the company initiation details.","tags":["OTHERS"],"parameters":[{"name":"companyCode","in":"path","type":"string","required":true,"description":"The identifier of the underlying Entity/Company/Branch."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"CompanyInitiationDetailsResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"POST","path":"/reference/companyInitiation/{companyCode}","fullPath":"/api/v2.3.0/reference/companyInitiation/{companyCode}","operationId":"initiateCompanyCreation","name":"Initiates the company creation process with which a lead company or a branch company can be created in the system.","summary":"Initiates the company creation process","tags":["OTHERS"],"parameters":[{"name":"companyCode","in":"path","type":"string","required":true,"description":"The identifier of the underlying Entity/Company/Branch."},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"bankAddresses":[{}],"companyName":"string","companyMnemonic":"string","financialCompany":"string","financialCompanyMnemonic":"string","subDivisionCode":"string","creationDate":"string","defaultCompany":"string","extensions":{}}},"responses":{"200":"CompanyCreationResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/reference/companyInitiation/{companyCode}","fullPath":"/api/v2.3.0/reference/companyInitiation/{companyCode}","operationId":"updateCompanyCreation","name":"Update company creation with details such as company address, company mnemonic, financial company, default company, company creation date and subdivision code","summary":"Update of company creation.","tags":["OTHERS"],"parameters":[{"name":"companyCode","in":"path","type":"string","required":true,"description":"The identifier of the underlying Entity/Company/Branch."},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"bankAddresses":[{}],"companyName":"string","companyMnemonic":"string","financialCompany":"string","financialCompanyMnemonic":"string","subDivisionCode":"string","creationDate":"string","defaultCompany":"string","extensions":{}}},"responses":{"200":"CompanyCreationResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/reference/companies/companyGroups/{companyGroupId}","fullPath":"/api/v2.3.0/reference/companies/companyGroups/{companyGroupId}","operationId":"getCompanyGroup","name":"Retrieves the company group detail such as company group description.","summary":"Retrieves the company group details.","tags":["OTHERS"],"parameters":[{"name":"companyGroupId","in":"path","type":"string","required":true,"description":"Identifier of the company group based on which the companies will be grouped together."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"CompanyGroupResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"POST","path":"/reference/companies/companyGroups/{companyGroupId}","fullPath":"/api/v2.3.0/reference/companies/companyGroups/{companyGroupId}","operationId":"createCompanyGroup","name":"Creates the company group to group multiple companies. During close of business processing, the grouped companies are processed together.","summary":"Creates the company group.","tags":["OTHERS"],"parameters":[{"name":"companyGroupId","in":"path","type":"string","required":true,"description":"Identifier of the company group based on which the companies will be grouped together."},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"displayName":"string","extensions":{}}},"responses":{"200":"CompanyGroupResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/reference/companies/companyGroups/{companyGroupId}","fullPath":"/api/v2.3.0/reference/companies/companyGroups/{companyGroupId}","operationId":"updateComapanyGroup","name":"Update company group with detail such as company group description","summary":"Update of company group","tags":["OTHERS"],"parameters":[{"name":"companyGroupId","in":"path","type":"string","required":true,"description":"Identifier of the company group based on which the companies will be grouped together."},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"displayName":"string","extensions":{}}},"responses":{"200":"ComapanyGroupResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/reference/companyApprovals/{companyCode}","fullPath":"/api/v2.3.0/reference/companyApprovals/{companyCode}","operationId":"approveCompanyInitiation","name":"Update & approve the details of the company being created such as name, address, local currency, company group, branch holiday, official holiday ,batch holiday, etc. The company initiation process is as below: 1. Company creation will be initiated. 2. The Initiated company could be approved with or without amendments to the attributes. 3. Post approval, the new company will be created based on background process. ","summary":"Update and approve the company details.","tags":["OTHERS"],"parameters":[{"name":"companyCode","in":"path","type":"string","required":true,"description":"The identifier of the underlying Entity/Company/Branch."},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"companyNames":[{}],"bankAddresses":[{}],"specialCustomerDetails":[{}],"specialFinancialDetails":[{}],"companyMnemonic":"string","languageId":"string","localCurrency":"string","rateSystem":"string","customerCompany":"string","defaultCustomerCompany":"string","defaultFinancialCompany":"string","currencyCompany":"string","financialConfigurationCompany":"string","nostroCompany":"string","subDivisionCode":"string"}},"responses":{"200":"CompanyInitiationResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}}]},{"key":"reference-countries-service-v1.0.0","title":"Countries","version":"v1.0.0","description":"API to retrieve the details of countries that are available in the system. Each country is identified by its ISO country code","endpointCount":13,"endpoints":[{"method":"GET","path":"/reference/countries","fullPath":"/api/v1.0.0/reference/countries","operationId":"getCountries","name":"Retrieves the list of country information that is used by the legal entity, either a list of countries or a specific country by ISO 3166-1 alpha-2 code.","summary":"Retrieves Country details","tags":[],"parameters":[{"name":"countryId","in":"query","type":"string","required":false,"description":"ISO country code of the financial institution. "},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from t24 on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"The identifier of the underlying Entity/Company/Branch."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"CountriesResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/reference/country/{countryCode}","fullPath":"/api/v1.0.0/reference/country/{countryCode}","operationId":"getCountryCodes","name":"API to retrieve country codes as per ISO Standards","summary":"Retrieves Country details","tags":[],"parameters":[{"name":"countryCode","in":"path","type":"string","required":true,"description":"ISO 3166-1-alpha-2 or alpha-3 country code of financial institution"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from t24 on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"The identifier of the underlying Entity/Company/Branch."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"CountryCodesResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/reference/countries/{countryId}","fullPath":"/api/v1.0.0/reference/countries/{countryId}","operationId":"getCountryDetails","name":"Retrieve the details of country like country name, currency code, geographical block, business centre and reporting country.","summary":"Retrieve the details of country","tags":[],"parameters":[{"name":"countryId","in":"path","type":"string","required":true,"description":"ISO country code of the financial institution. "},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"The identifier of the underlying Entity/Company/Branch."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"CountryDetailsResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"POST","path":"/reference/countries/{countryId}","fullPath":"/api/v1.0.0/reference/countries/{countryId}","operationId":"createCountryDetails","name":"Create the details of country like country name, currency code, geographical block, business centre and reporting country.","summary":"Create the details of country","tags":[],"parameters":[{"name":"countryId","in":"path","type":"string","required":true,"description":"ISO country code of the financial institution. "},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"The identifier of the underlying Entity/Company/Branch."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"countryNames":[{}],"localCurrencyIds":[{}],"capitalGainsIndexation":[{}],"countryShortNames":[{}],"geographicalBlock":"string","riskLevel":"string","phoneNumber":"string","countryCode":"string","numericCountryCode":0.0}},"responses":{"200":"CountryDetailsResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/reference/countries/{countryId}","fullPath":"/api/v1.0.0/reference/countries/{countryId}","operationId":"updateCountryDetails","name":"Update the details of country like country name, currency code, geographical block, business centre and reporting country.","summary":"Update the details of country","tags":[],"parameters":[{"name":"countryId","in":"path","type":"string","required":true,"description":"ISO country code of the financial institution. "},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"The identifier of the underlying Entity/Company/Branch."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"countryNames":[{}],"localCurrencyIds":[{}],"capitalGainsIndexation":[{}],"countryShortNames":[{}],"geographicalBlock":"string","riskLevel":"string","phoneNumber":"string","countryCode":"string","numericCountryCode":0.0}},"responses":{"200":"CountryDetailsResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/reference/countries/countryGroups/{groupId}","fullPath":"/api/v1.0.0/reference/countries/countryGroups/{groupId}","operationId":"getCountryGroup","name":"Retrieve the description and list of all countries involved in the group","summary":"Retrieve the details of country group","tags":[],"parameters":[{"name":"groupId","in":"path","type":"string","required":true,"description":"Unique ID of the group"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"The identifier of the underlying Entity/Company/Branch."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"CountryGroupResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"POST","path":"/reference/countries/countryGroups/{groupId}","fullPath":"/api/v1.0.0/reference/countries/countryGroups/{groupId}","operationId":"createCountryGroup","name":"Create the description and list of all countries involved in the group","summary":"Create the details of country group","tags":[],"parameters":[{"name":"groupId","in":"path","type":"string","required":true,"description":"Unique ID of the group"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"The identifier of the underlying Entity/Company/Branch."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"groupNames":[{}],"countryIds":[{}]}},"responses":{"200":"CountryGroupResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/reference/countries/countryGroups/{groupId}","fullPath":"/api/v1.0.0/reference/countries/countryGroups/{groupId}","operationId":"updateCountryGroup","name":"Update the description and list of all countries involved in the group","summary":"Update the details of country group","tags":[],"parameters":[{"name":"groupId","in":"path","type":"string","required":true,"description":"Unique ID of the group"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"The identifier of the underlying Entity/Company/Branch."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"groupNames":[{}],"countryIds":[{}]}},"responses":{"200":"CountryGroupResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"DELETE","path":"/reference/countries/countryGroups/{groupId}","fullPath":"/api/v1.0.0/reference/countries/countryGroups/{groupId}","operationId":"deleteCountryGroup","name":"Delete the description and list of all countries involved in the group","summary":"Delete the details of country group","tags":[],"parameters":[{"name":"groupId","in":"path","type":"string","required":true,"description":"Unique ID of the group"},{"name":"payload","in":"body","type":"object","required":false,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"The identifier of the underlying Entity/Company/Branch."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}}},"responses":{"200":"CountryGroupResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/reference/countries/countryGroups","fullPath":"/api/v1.0.0/reference/countries/countryGroups","operationId":"getCountryGroupList","name":"Retrieves the list of all country group in the system with details such as description and countries involved in the group","summary":"Retrieve the list of country groups","tags":[],"parameters":[{"name":"groupId","in":"query","type":"string","required":false,"description":"Unique ID of the group"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from t24 on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"The identifier of the underlying Entity/Company/Branch."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"CountryGroupListResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/reference/countries/regions/{regionId}","fullPath":"/api/v1.0.0/reference/countries/regions/{regionId}","operationId":"getCountryRegion","name":"Retrieve the details of region such as description, inflation index and inflation index applicable date","summary":"Retrieve the details of region","tags":[],"parameters":[{"name":"regionId","in":"path","type":"string","required":true,"description":"Identifier of the region"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"The identifier of the underlying Entity/Company/Branch."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"CountryRegionResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"POST","path":"/reference/countries/regions/{regionId}","fullPath":"/api/v1.0.0/reference/countries/regions/{regionId}","operationId":"createCountryRegion","name":"Creates the details of region such as description, inflation index and inflation index applicable date","summary":"Creates the details of region","tags":[],"parameters":[{"name":"regionId","in":"path","type":"string","required":true,"description":"Identifier of the region"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"The identifier of the underlying Entity/Company/Branch."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"regions":[{}],"capitalGainsIndexation":[{}],"deliveryRegion":"string"}},"responses":{"200":"CountryRegionResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/reference/countries/regions/{regionId}","fullPath":"/api/v1.0.0/reference/countries/regions/{regionId}","operationId":"updateCountryRegion","name":"Update the details of region such as description, inflation index and inflation index applicable date","summary":"Update the details of region","tags":[],"parameters":[{"name":"regionId","in":"path","type":"string","required":true,"description":"Identifier of the region"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"The identifier of the underlying Entity/Company/Branch."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"regions":[{}],"capitalGainsIndexation":[{}],"deliveryRegion":"string"}},"responses":{"200":"CountryRegionResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}}]},{"key":"reference-currencies-service-v1.0.0","title":"Currencies","version":"v1.0.0","description":"API to retrieve the Currencies defined in the system","endpointCount":2,"endpoints":[{"method":"GET","path":"/reference/currencies","fullPath":"/api/v1.0.0/reference/currencies","operationId":"getCurrencies","name":"Retrieves list of the Currencies (ISO 4217 codes) that are defined in the system","summary":"Retrieves Currencies details","tags":[],"parameters":[{"name":"currencyId","in":"query","type":"string","required":false,"description":"Identifier of the currency. This is the 3-letter ISO 4217 code of the currency."},{"name":"currencyIdNE","in":"query","type":"string","required":false,"description":"Identifier of the currency. This is the 3-letter ISO 4217 code of the currency."},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from t24 on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"The identifier of the underlying Entity/Company/Branch."}],"requestBodyExample":null,"responses":{"200":"CurrenciesResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/reference/currencies/{currencyId}","fullPath":"/api/v1.0.0/reference/currencies/{currencyId}","operationId":"getCurrency","name":"Retrieves the detailed information for the currency such as buy/sell exchange rate etc","summary":"Retrieves Currency details of a specific currency","tags":[],"parameters":[{"name":"currencyId","in":"path","type":"string","required":true,"description":"Identifier of the currency. This is the 3-letter ISO 4217 code of the currency."},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from t24 on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"The identifier of the underlying Entity/Company/Branch."}],"requestBodyExample":null,"responses":{"200":"CurrencyResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}}]},{"key":"reference-currencies-service-v2.0.0","title":"Currencies","version":"v2.0.0","description":"API to retrieve the list of currencies that are available in the system including the buy and sell rate defined for each currency. Each currency is identified by its ISO currency code.","endpointCount":15,"endpoints":[{"method":"GET","path":"/reference/currencies","fullPath":"/api/v2.0.0/reference/currencies","operationId":"getCurrencies","name":"Retrieves list of the Currencies (ISO 4217 codes) that are defined in the system","summary":"Retrieves Currencies details","tags":[],"parameters":[{"name":"currencyId","in":"query","type":"string","required":false,"description":"Identifier of the currency. This is the 3-letter ISO 4217 code of the currency."},{"name":"currencyIdNE","in":"query","type":"string","required":false,"description":"Identifier of the currency. This is the 3-letter ISO 4217 code of the currency."},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from t24 on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"The identifier of the underlying Entity/Company/Branch."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"CurrenciesResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/reference/currencies/{currencyId}","fullPath":"/api/v2.0.0/reference/currencies/{currencyId}","operationId":"getCurrencyInfo","name":"Retrieves  details such as currency code, buy rate, sell rate, spread, rank and rounding type","summary":"Retrieves currency details","tags":[],"parameters":[{"name":"currencyId","in":"path","type":"string","required":true,"description":"Identifier of the currency. This is the 3-letter ISO 4217 code of the currency."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"The identifier of the underlying Entity/Company/Branch."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"CurrencyInfoResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"POST","path":"/reference/currencies/{currencyId}","fullPath":"/api/v2.0.0/reference/currencies/{currencyId}","operationId":"createCurrencyInfo","name":"Creates details such as currency code, buy rate, sell rate, spread, rank and rounding type","summary":"Creates currency details","tags":[],"parameters":[{"name":"currencyId","in":"path","type":"string","required":true,"description":"Identifier of the currency. This is the 3-letter ISO 4217 code of the currency."},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"The identifier of the underlying Entity/Company/Branch."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"displayNames":[{}],"markets":[{}],"rateInformation":[{}],"equivalentCurrencies":[{}],"rank":"string","numericCurrencyCode":"string","numberofDecimal":"string","quotationCode":"string","quotationPips":"string","noticeDay":"string","nostroProjectionDay":"string","interestDayBasis":"string","allowedVariance":"string","fixedRateDate":"string","minAmount":"string"}},"responses":{"200":"CurrencyInfoResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/reference/currencies/{currencyId}","fullPath":"/api/v2.0.0/reference/currencies/{currencyId}","operationId":"updateCurrencyInfo","name":"Updates details such as currency code, buy rate, sell rate, spread, rank and rounding type","summary":"Updates currency details","tags":[],"parameters":[{"name":"currencyId","in":"path","type":"string","required":true,"description":"Identifier of the currency. This is the 3-letter ISO 4217 code of the currency."},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"The identifier of the underlying Entity/Company/Branch."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"displayNames":[{}],"markets":[{}],"rateInformation":[{}],"equivalentCurrencies":[{}],"rank":"string","numericCurrencyCode":"string","numberofDecimal":"string","quotationCode":"string","quotationPips":"string","noticeDay":"string","nostroProjectionDay":"string","interestDayBasis":"string","allowedVariance":"string","fixedRateDate":"string","minAmount":"string"}},"responses":{"200":"CurrencyInfoResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"DELETE","path":"/reference/currencies/{currencyId}","fullPath":"/api/v2.0.0/reference/currencies/{currencyId}","operationId":"deleteCurrencyInfo","name":"Deletes details such as currency code, buy rate, sell rate, spread, rank and rounding type","summary":"Deletes currency details","tags":[],"parameters":[{"name":"currencyId","in":"path","type":"string","required":true,"description":"Identifier of the currency. This is the 3-letter ISO 4217 code of the currency."},{"name":"payload","in":"body","type":"object","required":false,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"The identifier of the underlying Entity/Company/Branch."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}}},"responses":{"200":"CurrencyInfoResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/reference/currencies/markets/{currencyMarketId}","fullPath":"/api/v2.0.0/reference/currencies/markets/{currencyMarketId}","operationId":"getCurrencyMarket","name":"Retrieves currency market details such as market name and local spread calculation method details","summary":"Retrieves currency market details","tags":[],"parameters":[{"name":"currencyMarketId","in":"path","type":"string","required":true,"description":"Specifies the code by which the Currency Market can be identified."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"The identifier of the underlying Entity/Company/Branch."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"CurrencyMarketResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"POST","path":"/reference/currencies/markets/{currencyMarketId}","fullPath":"/api/v2.0.0/reference/currencies/markets/{currencyMarketId}","operationId":"createCurrencyMarket","name":"Create currency market with details such as market name and local spread calculation method details","summary":"Creates currency market details","tags":[],"parameters":[{"name":"currencyMarketId","in":"path","type":"string","required":true,"description":"Specifies the code by which the Currency Market can be identified."},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"The identifier of the underlying Entity/Company/Branch."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"currencyMarketNames":[{}],"spreadCalcuationRoutine":"string"}},"responses":{"200":"CurrencyMarketResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/reference/currencies/markets/{currencyMarketId}","fullPath":"/api/v2.0.0/reference/currencies/markets/{currencyMarketId}","operationId":"updateCurrencyMarket","name":"Update currency market details such as market name and local spread calculation method details","summary":"Updates currency market details","tags":[],"parameters":[{"name":"currencyMarketId","in":"path","type":"string","required":true,"description":"Specifies the code by which the Currency Market can be identified."},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"The identifier of the underlying Entity/Company/Branch."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"currencyMarketNames":[{}],"spreadCalcuationRoutine":"string"}},"responses":{"200":"CurrencyMarketResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/reference/currencies/numericCodes/{numericCurrencyCode}","fullPath":"/api/v2.0.0/reference/currencies/numericCodes/{numericCurrencyCode}","operationId":"getCurrencyFromNumericCode","name":"Retrieves ISO code of currency based on numeric currency code","summary":"Retrieves ISO currency code","tags":[],"parameters":[{"name":"numericCurrencyCode","in":"path","type":"string","required":true,"description":"Numeric code for the currency"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from t24 on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"The identifier of the underlying Entity/Company/Branch."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"CurrencyFromNumericCodeResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/reference/currencies/{currencyId}/historicDates/{year}","fullPath":"/api/v2.0.0/reference/currencies/{currencyId}/historicDates/{year}","operationId":"getCurrencyModifications","name":"Retrieves effective date and version number of specified currency","summary":"Retrieves currency historic details","tags":[],"parameters":[{"name":"currencyId","in":"path","type":"string","required":true,"description":"Identifier of the currency. This is the 3-letter ISO 4217 code of the currency."},{"name":"year","in":"path","type":"string","required":true,"description":"Contains the year in a standard ISO format"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from t24 on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"The identifier of the underlying Entity/Company/Branch."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"CurrencyModificationsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/reference/currencies/ranks/{rank}","fullPath":"/api/v2.0.0/reference/currencies/ranks/{rank}","operationId":"getCurrencyForRank","name":"Retrieves ISO code of currency based on currency rank","summary":"Retrieves ISO currency code","tags":[],"parameters":[{"name":"rank","in":"path","type":"string","required":true,"description":"Indicates the rank of the payment order product within the group."},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from t24 on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"The identifier of the underlying Entity/Company/Branch."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"CurrencyForRankResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/reference/currencies/{currencyId}/profiles","fullPath":"/api/v2.0.0/reference/currencies/{currencyId}/profiles","operationId":"getCurrencyBasicInfo","name":"Retrieves basic details like name, numeric code, interest basis and allowed decimals for the specified currency","summary":"Retrieves basic currency details","tags":[],"parameters":[{"name":"currencyId","in":"path","type":"string","required":true,"description":"Identifier of the currency. This is the 3-letter ISO 4217 code of the currency."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"The identifier of the underlying Entity/Company/Branch."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"CurrencyBasicInfoResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"POST","path":"/reference/currencies/{currencyId}/profiles","fullPath":"/api/v2.0.0/reference/currencies/{currencyId}/profiles","operationId":"createCurrencyBasicInfo","name":"Creates basic details like name, numeric code, interest basis and allowed decimals for the specified currency","summary":"Creates basic currency details","tags":[],"parameters":[{"name":"currencyId","in":"path","type":"string","required":true,"description":"Identifier of the currency. This is the 3-letter ISO 4217 code of the currency."},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"The identifier of the underlying Entity/Company/Branch."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"displayNames":[{}],"numberofDecimal":"string","numericCurrencyCode":"string","baseCurrencyRank":"string","interestDayBasis":"string"}},"responses":{"200":"CurrencyBasicInfoResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/reference/currencies/{currencyId}/profiles","fullPath":"/api/v2.0.0/reference/currencies/{currencyId}/profiles","operationId":"updateCurrencyBasicInfo","name":"Updates basic details like name, numeric code, interest basis and allowed decimals for the specified currency","summary":"Updates basic currency details","tags":[],"parameters":[{"name":"currencyId","in":"path","type":"string","required":true,"description":"Identifier of the currency. This is the 3-letter ISO 4217 code of the currency."},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"The identifier of the underlying Entity/Company/Branch."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"displayNames":[{}],"numberofDecimal":"string","numericCurrencyCode":"string","baseCurrencyRank":"string","interestDayBasis":"string"}},"responses":{"200":"CurrencyBasicInfoResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"DELETE","path":"/reference/currencies/{currencyId}/profiles","fullPath":"/api/v2.0.0/reference/currencies/{currencyId}/profiles","operationId":"deleteCurrencyBasicInfo","name":"Delete basic details like name, numeric code, interest basis and allowed decimals for the specified currency","summary":"Delete basic currency details","tags":[],"parameters":[{"name":"currencyId","in":"path","type":"string","required":true,"description":"Identifier of the currency. This is the 3-letter ISO 4217 code of the currency."},{"name":"payload","in":"body","type":"object","required":false,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"The identifier of the underlying Entity/Company/Branch."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}}},"responses":{"200":"CurrencyBasicInfoResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}}]},{"key":"reference-currencies-service-v2.1.0","title":"Currencies","version":"v2.1.0","description":"API to retrieve the list of currencies that are available in the system including the buy and sell rate defined for each currency. Each currency is identified by its ISO currency code.","endpointCount":19,"endpoints":[{"method":"GET","path":"/reference/currencies","fullPath":"/api/v2.1.0/reference/currencies","operationId":"getCurrencies","name":"Retrieves list of the Currencies (ISO 4217 codes) that are defined in the system","summary":"Retrieves details of currencies","tags":[],"parameters":[{"name":"currencyId","in":"query","type":"string","required":false,"description":"Identifier of the currency. This is the 3-letter ISO 4217 code of the currency."},{"name":"currencyIdNE","in":"query","type":"string","required":false,"description":"Identifier of the currency. This is the 3-letter ISO 4217 code of the currency."},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from t24 on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"The identifier of the underlying Entity/Company/Branch."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"CurrenciesResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/reference/currencies/{currencyId}","fullPath":"/api/v2.1.0/reference/currencies/{currencyId}","operationId":"getCurrencyInfo","name":"Retrieves  details such as currency code, buy rate, sell rate, spread, rank and rounding type","summary":"Retrieves details of a currency","tags":[],"parameters":[{"name":"currencyId","in":"path","type":"string","required":true,"description":"Identifier of the currency. This is the 3-letter ISO 4217 code of the currency."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"The identifier of the underlying Entity/Company/Branch."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"CurrencyInfoResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"POST","path":"/reference/currencies/{currencyId}","fullPath":"/api/v2.1.0/reference/currencies/{currencyId}","operationId":"createCurrencyInfo","name":"Creates details such as currency code, buy rate, sell rate, spread, rank and rounding type","summary":"Creates currency details","tags":[],"parameters":[{"name":"currencyId","in":"path","type":"string","required":true,"description":"Identifier of the currency. This is the 3-letter ISO 4217 code of the currency."},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"The identifier of the underlying Entity/Company/Branch."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"displayNames":[{}],"markets":[{}],"rateInformation":[{}],"equivalentCurrencies":[{}],"rank":"string","numericCurrencyCode":"string","numberofDecimal":"string","quotationCode":"string","quotationPips":"string","noticeDay":"string","nostroProjectionDay":"string","interestDayBasis":"string","allowedVariance":"string","fixedRateDate":"string","minAmount":"string"}},"responses":{"200":"CurrencyInfoResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/reference/currencies/{currencyId}","fullPath":"/api/v2.1.0/reference/currencies/{currencyId}","operationId":"updateCurrencyInfo","name":"Updates details such as currency code, buy rate, sell rate, spread, rank and rounding type","summary":"Updates currency details","tags":[],"parameters":[{"name":"currencyId","in":"path","type":"string","required":true,"description":"Identifier of the currency. This is the 3-letter ISO 4217 code of the currency."},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"The identifier of the underlying Entity/Company/Branch."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"displayNames":[{}],"markets":[{}],"rateInformation":[{}],"equivalentCurrencies":[{}],"rank":"string","numericCurrencyCode":"string","numberofDecimal":"string","quotationCode":"string","quotationPips":"string","noticeDay":"string","nostroProjectionDay":"string","interestDayBasis":"string","allowedVariance":"string","fixedRateDate":"string","minAmount":"string"}},"responses":{"200":"CurrencyInfoResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"DELETE","path":"/reference/currencies/{currencyId}","fullPath":"/api/v2.1.0/reference/currencies/{currencyId}","operationId":"deleteCurrencyInfo","name":"Deletes details such as currency code, buy rate, sell rate, spread, rank and rounding type","summary":"Deletes currency details","tags":[],"parameters":[{"name":"currencyId","in":"path","type":"string","required":true,"description":"Identifier of the currency. This is the 3-letter ISO 4217 code of the currency."},{"name":"payload","in":"body","type":"object","required":false,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"The identifier of the underlying Entity/Company/Branch."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}}},"responses":{"200":"CurrencyInfoResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/reference/currencies/markets/{currencyMarketId}","fullPath":"/api/v2.1.0/reference/currencies/markets/{currencyMarketId}","operationId":"getCurrencyMarket","name":"Retrieves currency market details such as market name and local spread calculation method details","summary":"Retrieves currency market details","tags":[],"parameters":[{"name":"currencyMarketId","in":"path","type":"string","required":true,"description":"Specifies the code by which the Currency Market can be identified."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"The identifier of the underlying Entity/Company/Branch."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"CurrencyMarketResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"POST","path":"/reference/currencies/markets/{currencyMarketId}","fullPath":"/api/v2.1.0/reference/currencies/markets/{currencyMarketId}","operationId":"createCurrencyMarket","name":"Create currency market with details such as market name and local spread calculation method details","summary":"Creates currency market details","tags":[],"parameters":[{"name":"currencyMarketId","in":"path","type":"string","required":true,"description":"Specifies the code by which the Currency Market can be identified."},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"The identifier of the underlying Entity/Company/Branch."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"currencyMarketNames":[{}],"spreadCalcuationRoutine":"string"}},"responses":{"200":"CurrencyMarketResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/reference/currencies/markets/{currencyMarketId}","fullPath":"/api/v2.1.0/reference/currencies/markets/{currencyMarketId}","operationId":"updateCurrencyMarket","name":"Update currency market details such as market name and local spread calculation method details","summary":"Updates currency market details","tags":[],"parameters":[{"name":"currencyMarketId","in":"path","type":"string","required":true,"description":"Specifies the code by which the Currency Market can be identified."},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"The identifier of the underlying Entity/Company/Branch."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"currencyMarketNames":[{}],"spreadCalcuationRoutine":"string"}},"responses":{"200":"CurrencyMarketResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/reference/currencies/numericCodes/{numericCurrencyCode}","fullPath":"/api/v2.1.0/reference/currencies/numericCodes/{numericCurrencyCode}","operationId":"getCurrencyFromNumericCode","name":"Retrieves ISO code of currency based on numeric currency code","summary":"Retrieves ISO currency code","tags":[],"parameters":[{"name":"numericCurrencyCode","in":"path","type":"string","required":true,"description":"Numeric code for the currency"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from t24 on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"The identifier of the underlying Entity/Company/Branch."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"CurrencyFromNumericCodeResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/reference/currencies/{currencyId}/historicDates/{year}","fullPath":"/api/v2.1.0/reference/currencies/{currencyId}/historicDates/{year}","operationId":"getCurrencyModifications","name":"Retrieves effective date and version number of specified currency","summary":"Retrieves currency historic details","tags":[],"parameters":[{"name":"currencyId","in":"path","type":"string","required":true,"description":"Identifier of the currency. This is the 3-letter ISO 4217 code of the currency."},{"name":"year","in":"path","type":"string","required":true,"description":"Contains the year in a standard ISO format"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from t24 on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"The identifier of the underlying Entity/Company/Branch."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"CurrencyModificationsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/reference/currencies/ranks/{rank}","fullPath":"/api/v2.1.0/reference/currencies/ranks/{rank}","operationId":"getCurrencyForRank","name":"Retrieves ISO code of currency based on currency rank","summary":"Retrieves ISO currency code","tags":[],"parameters":[{"name":"rank","in":"path","type":"string","required":true,"description":"Indicates the rank of the payment order product within the group."},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from t24 on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"The identifier of the underlying Entity/Company/Branch."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"CurrencyForRankResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/reference/currencies/{currencyId}/profiles","fullPath":"/api/v2.1.0/reference/currencies/{currencyId}/profiles","operationId":"getCurrencyBasicInfo","name":"Retrieves basic details like name, numeric code, interest basis and allowed decimals for the specified currency","summary":"Retrieves basic currency details","tags":[],"parameters":[{"name":"currencyId","in":"path","type":"string","required":true,"description":"Identifier of the currency. This is the 3-letter ISO 4217 code of the currency."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"The identifier of the underlying Entity/Company/Branch."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"CurrencyBasicInfoResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"POST","path":"/reference/currencies/{currencyId}/profiles","fullPath":"/api/v2.1.0/reference/currencies/{currencyId}/profiles","operationId":"createCurrencyBasicInfo","name":"Creates basic details like name, numeric code, interest basis and allowed decimals for the specified currency","summary":"Creates basic currency details","tags":[],"parameters":[{"name":"currencyId","in":"path","type":"string","required":true,"description":"Identifier of the currency. This is the 3-letter ISO 4217 code of the currency."},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"The identifier of the underlying Entity/Company/Branch."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"displayNames":[{}],"numberofDecimal":"string","numericCurrencyCode":"string","baseCurrencyRank":"string","interestDayBasis":"string"}},"responses":{"200":"CurrencyBasicInfoResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/reference/currencies/{currencyId}/profiles","fullPath":"/api/v2.1.0/reference/currencies/{currencyId}/profiles","operationId":"updateCurrencyBasicInfo","name":"Updates basic details like name, numeric code, interest basis and allowed decimals for the specified currency","summary":"Updates basic currency details","tags":[],"parameters":[{"name":"currencyId","in":"path","type":"string","required":true,"description":"Identifier of the currency. This is the 3-letter ISO 4217 code of the currency."},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"The identifier of the underlying Entity/Company/Branch."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"displayNames":[{}],"numberofDecimal":"string","numericCurrencyCode":"string","baseCurrencyRank":"string","interestDayBasis":"string"}},"responses":{"200":"CurrencyBasicInfoResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"DELETE","path":"/reference/currencies/{currencyId}/profiles","fullPath":"/api/v2.1.0/reference/currencies/{currencyId}/profiles","operationId":"deleteCurrencyBasicInfo","name":"Delete basic details like name, numeric code, interest basis and allowed decimals for the specified currency","summary":"Delete basic currency details","tags":[],"parameters":[{"name":"currencyId","in":"path","type":"string","required":true,"description":"Identifier of the currency. This is the 3-letter ISO 4217 code of the currency."},{"name":"payload","in":"body","type":"object","required":false,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"The identifier of the underlying Entity/Company/Branch."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}}},"responses":{"200":"CurrencyBasicInfoResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/reference/currencies/currencyGroups/{currencyGroupId}","fullPath":"/api/v2.1.0/reference/currencies/currencyGroups/{currencyGroupId}","operationId":"getCurrencyGroup","name":"The currencies can be grouped for various business reasons like Credit Reporting, Exposure reporting etc","summary":"Retrieve the Currency Group details","tags":[],"parameters":[{"name":"currencyGroupId","in":"path","type":"string","required":true,"description":"Identifies the currency group"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"The identifier of the underlying Entity/Company/Branch."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"CurrencyGroupResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"POST","path":"/reference/currencies/currencyGroups/{currencyGroupId}","fullPath":"/api/v2.1.0/reference/currencies/currencyGroups/{currencyGroupId}","operationId":"createCurrencyGroup","name":"The currencies can be grouped for various business reasons like Credit Reporting, Exposure reporting etc","summary":"Create the Currency Group to group the currencies based on need","tags":[],"parameters":[{"name":"currencyGroupId","in":"path","type":"string","required":true,"description":"Identifies the currency group"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"The identifier of the underlying Entity/Company/Branch."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"displayNames":[{}],"currencyIds":[{}]}},"responses":{"200":"CurrencyGroupResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/reference/currencies/currencyGroups/{currencyGroupId}","fullPath":"/api/v2.1.0/reference/currencies/currencyGroups/{currencyGroupId}","operationId":"updateCurrencyGroup","name":"The currencies can be grouped for various business reasons like Credit Reporting, Exposure reporting etc","summary":"Update the Currency Group to group the currencies based on need","tags":[],"parameters":[{"name":"currencyGroupId","in":"path","type":"string","required":true,"description":"Identifies the currency group"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"The identifier of the underlying Entity/Company/Branch."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"displayNames":[{}],"currencyIds":[{}]}},"responses":{"200":"CurrencyGroupResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"DELETE","path":"/reference/currencies/currencyGroups/{currencyGroupId}","fullPath":"/api/v2.1.0/reference/currencies/currencyGroups/{currencyGroupId}","operationId":"deleteCurrencyGroup","name":"Delete the currency group details like Credit Reporting, Exposure reporting etc","summary":"Delete the currency group details","tags":[],"parameters":[{"name":"currencyGroupId","in":"path","type":"string","required":true,"description":"Identifies the currency group"},{"name":"payload","in":"body","type":"object","required":false,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"The identifier of the underlying Entity/Company/Branch."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}}},"responses":{"200":"CurrencyGroupResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}}]},{"key":"reference-currencies-service-v2.2.0","title":"Currencies","version":"v2.2.0","description":"API to retrieve the list of currencies that are available in the system including the buy and sell rate defined for each currency. Each currency is identified by its ISO currency code.","endpointCount":19,"endpoints":[{"method":"GET","path":"/reference/currencies","fullPath":"/api/v2.2.0/reference/currencies","operationId":"getCurrencies","name":"Retrieves list of the currencies (ISO 4217 codes) that are defined in the system","summary":"Retrieves details of currencies","tags":[],"parameters":[{"name":"currencyId","in":"query","type":"string","required":false,"description":"Identifier of the currency. This is the 3-letter ISO 4217 code of the currency."},{"name":"currencyIdNE","in":"query","type":"string","required":false,"description":"Identifier of the currency. This is the 3-letter ISO 4217 code of the currency."},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from t24 on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"The identifier of the underlying Entity/Company/Branch."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"CurrenciesResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/reference/currencies/{currencyId}","fullPath":"/api/v2.2.0/reference/currencies/{currencyId}","operationId":"getCurrencyInfo","name":"Retrieves  details such as currency code, buy rate, sell rate, spread, rank and rounding type","summary":"Retrieves details of a currency","tags":[],"parameters":[{"name":"currencyId","in":"path","type":"string","required":true,"description":"Identifier of the currency. This is the 3-letter ISO 4217 code of the currency."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"The identifier of the underlying Entity/Company/Branch."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"CurrencyInfoResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"POST","path":"/reference/currencies/{currencyId}","fullPath":"/api/v2.2.0/reference/currencies/{currencyId}","operationId":"createCurrencyInfo","name":"Creates details such as currency code, buy rate, sell rate, spread, rank and rounding type","summary":"Creates currency details","tags":[],"parameters":[{"name":"currencyId","in":"path","type":"string","required":true,"description":"Identifier of the currency. This is the 3-letter ISO 4217 code of the currency."},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"The identifier of the underlying Entity/Company/Branch."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"displayNames":[{}],"markets":[{}],"rateInformation":[{}],"equivalentCurrencies":[{}],"rank":"string","numericCurrencyCode":"string","numberofDecimal":"string","quotationCode":"string","quotationPips":"string","noticeDay":"string","nostroProjectionDay":"string","interestDayBasis":"string","allowedVariance":"string","fixedRateDate":"string","minAmount":"string"}},"responses":{"200":"CurrencyInfoResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/reference/currencies/{currencyId}","fullPath":"/api/v2.2.0/reference/currencies/{currencyId}","operationId":"updateCurrencyInfo","name":"Updates details such as currency code, buy rate, sell rate, spread, rank and rounding type","summary":"Updates currency details","tags":[],"parameters":[{"name":"currencyId","in":"path","type":"string","required":true,"description":"Identifier of the currency. This is the 3-letter ISO 4217 code of the currency."},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"The identifier of the underlying Entity/Company/Branch."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"displayNames":[{}],"markets":[{}],"rateInformation":[{}],"equivalentCurrencies":[{}],"rank":"string","numericCurrencyCode":"string","numberofDecimal":"string","quotationCode":"string","quotationPips":"string","noticeDay":"string","nostroProjectionDay":"string","interestDayBasis":"string","allowedVariance":"string","fixedRateDate":"string","minAmount":"string"}},"responses":{"200":"CurrencyInfoResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"DELETE","path":"/reference/currencies/{currencyId}","fullPath":"/api/v2.2.0/reference/currencies/{currencyId}","operationId":"deleteCurrencyInfo","name":"Deletes details such as currency code, buy rate, sell rate, spread, rank and rounding type","summary":"Deletes currency details","tags":[],"parameters":[{"name":"currencyId","in":"path","type":"string","required":true,"description":"Identifier of the currency. This is the 3-letter ISO 4217 code of the currency."},{"name":"payload","in":"body","type":"object","required":false,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"The identifier of the underlying Entity/Company/Branch."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}}},"responses":{"200":"CurrencyInfoResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/reference/currencies/markets/{currencyMarketId}","fullPath":"/api/v2.2.0/reference/currencies/markets/{currencyMarketId}","operationId":"getCurrencyMarket","name":"Retrieves currency market details such as market name and local spread calculation method details","summary":"Retrieves currency market details","tags":[],"parameters":[{"name":"currencyMarketId","in":"path","type":"string","required":true,"description":"Specifies the code by which the Currency Market can be identified."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"The identifier of the underlying Entity/Company/Branch."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"CurrencyMarketResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"POST","path":"/reference/currencies/markets/{currencyMarketId}","fullPath":"/api/v2.2.0/reference/currencies/markets/{currencyMarketId}","operationId":"createCurrencyMarket","name":"Create currency market with details such as market name and local spread calculation method details","summary":"Creates currency market details","tags":[],"parameters":[{"name":"currencyMarketId","in":"path","type":"string","required":true,"description":"Specifies the code by which the Currency Market can be identified."},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"The identifier of the underlying Entity/Company/Branch."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"currencyMarketNames":[{}],"spreadCalcuationRoutine":"string"}},"responses":{"200":"CurrencyMarketResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/reference/currencies/markets/{currencyMarketId}","fullPath":"/api/v2.2.0/reference/currencies/markets/{currencyMarketId}","operationId":"updateCurrencyMarket","name":"Update currency market details such as market name and local spread calculation method details","summary":"Updates currency market details","tags":[],"parameters":[{"name":"currencyMarketId","in":"path","type":"string","required":true,"description":"Specifies the code by which the Currency Market can be identified."},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"The identifier of the underlying Entity/Company/Branch."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"currencyMarketNames":[{}],"spreadCalcuationRoutine":"string"}},"responses":{"200":"CurrencyMarketResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/reference/currencies/{currencyId}/historicDates/{year}","fullPath":"/api/v2.2.0/reference/currencies/{currencyId}/historicDates/{year}","operationId":"getCurrencyModifications","name":"Retrieves effective date and version number of specified currency","summary":"Retrieves currency historic details","tags":[],"parameters":[{"name":"currencyId","in":"path","type":"string","required":true,"description":"Identifier of the currency. This is the 3-letter ISO 4217 code of the currency."},{"name":"year","in":"path","type":"string","required":true,"description":"Contains the year in a standard ISO format"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from t24 on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"The identifier of the underlying Entity/Company/Branch."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"CurrencyModificationsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/reference/currencies/{currencyId}/profiles","fullPath":"/api/v2.2.0/reference/currencies/{currencyId}/profiles","operationId":"getCurrencyBasicInfo","name":"Retrieves basic details like name, numeric code, interest basis and allowed decimals for the specified currency","summary":"Retrieves basic currency details","tags":[],"parameters":[{"name":"currencyId","in":"path","type":"string","required":true,"description":"Identifier of the currency. This is the 3-letter ISO 4217 code of the currency."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"The identifier of the underlying Entity/Company/Branch."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"CurrencyBasicInfoResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"POST","path":"/reference/currencies/{currencyId}/profiles","fullPath":"/api/v2.2.0/reference/currencies/{currencyId}/profiles","operationId":"createCurrencyBasicInfo","name":"Creates basic details like name, numeric code, interest basis and allowed decimals for the specified currency","summary":"Creates basic currency details","tags":[],"parameters":[{"name":"currencyId","in":"path","type":"string","required":true,"description":"Identifier of the currency. This is the 3-letter ISO 4217 code of the currency."},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"The identifier of the underlying Entity/Company/Branch."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"displayNames":[{}],"numberofDecimal":"string","numericCurrencyCode":"string","baseCurrencyRank":"string","interestDayBasis":"string"}},"responses":{"200":"CurrencyBasicInfoResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/reference/currencies/{currencyId}/profiles","fullPath":"/api/v2.2.0/reference/currencies/{currencyId}/profiles","operationId":"updateCurrencyBasicInfo","name":"Updates basic details like name, numeric code, interest basis and allowed decimals for the specified currency","summary":"Updates basic currency details","tags":[],"parameters":[{"name":"currencyId","in":"path","type":"string","required":true,"description":"Identifier of the currency. This is the 3-letter ISO 4217 code of the currency."},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"The identifier of the underlying Entity/Company/Branch."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"displayNames":[{}],"numberofDecimal":"string","numericCurrencyCode":"string","baseCurrencyRank":"string","interestDayBasis":"string"}},"responses":{"200":"CurrencyBasicInfoResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"DELETE","path":"/reference/currencies/{currencyId}/profiles","fullPath":"/api/v2.2.0/reference/currencies/{currencyId}/profiles","operationId":"deleteCurrencyBasicInfo","name":"Delete basic details like name, numeric code, interest basis and allowed decimals for the specified currency","summary":"Delete basic currency details","tags":[],"parameters":[{"name":"currencyId","in":"path","type":"string","required":true,"description":"Identifier of the currency. This is the 3-letter ISO 4217 code of the currency."},{"name":"payload","in":"body","type":"object","required":false,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"The identifier of the underlying Entity/Company/Branch."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}}},"responses":{"200":"CurrencyBasicInfoResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/reference/currencies/currencyGroups/{currencyGroupId}","fullPath":"/api/v2.2.0/reference/currencies/currencyGroups/{currencyGroupId}","operationId":"getCurrencyGroup","name":"The currencies can be grouped for various business reasons like Credit Reporting, Exposure reporting etc","summary":"Retrieve the currency group details","tags":[],"parameters":[{"name":"currencyGroupId","in":"path","type":"string","required":true,"description":"Identifies the currency group"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"The identifier of the underlying Entity/Company/Branch."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"CurrencyGroupResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"POST","path":"/reference/currencies/currencyGroups/{currencyGroupId}","fullPath":"/api/v2.2.0/reference/currencies/currencyGroups/{currencyGroupId}","operationId":"createCurrencyGroup","name":"The currencies can be grouped for various business reasons like Credit Reporting, Exposure reporting etc","summary":"Create the currency group to group the currencies based on need","tags":[],"parameters":[{"name":"currencyGroupId","in":"path","type":"string","required":true,"description":"Identifies the currency group"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"The identifier of the underlying Entity/Company/Branch."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"displayNames":[{}],"currencyIds":[{}]}},"responses":{"200":"CurrencyGroupResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/reference/currencies/currencyGroups/{currencyGroupId}","fullPath":"/api/v2.2.0/reference/currencies/currencyGroups/{currencyGroupId}","operationId":"updateCurrencyGroup","name":"The currencies can be grouped for various business reasons like Credit Reporting, Exposure reporting etc","summary":"Update the currency group to group the currencies based on need","tags":[],"parameters":[{"name":"currencyGroupId","in":"path","type":"string","required":true,"description":"Identifies the currency group"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"The identifier of the underlying Entity/Company/Branch."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"displayNames":[{}],"currencyIds":[{}]}},"responses":{"200":"CurrencyGroupResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"DELETE","path":"/reference/currencies/currencyGroups/{currencyGroupId}","fullPath":"/api/v2.2.0/reference/currencies/currencyGroups/{currencyGroupId}","operationId":"deleteCurrencyGroup","name":"Delete the currency group details like Credit Reporting, Exposure reporting etc","summary":"Delete the currency group details","tags":[],"parameters":[{"name":"currencyGroupId","in":"path","type":"string","required":true,"description":"Identifies the currency group"},{"name":"payload","in":"body","type":"object","required":false,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"The identifier of the underlying Entity/Company/Branch."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}}},"responses":{"200":"CurrencyGroupResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/reference/currencies/ranks/{rank}","fullPath":"/api/v2.2.0/reference/currencies/ranks/{rank}","operationId":"getCurrencyForRank","name":"Retrieves ISO code of currency based on currency rank. Each currency can be optionally assigned with a currency rank which specifies the currency order in which the dealer wants the currency positions to be shown on the screen when requesting the display of exchange positions","summary":"Retrieves ISO currency code for a currency rank","tags":[],"parameters":[{"name":"rank","in":"path","type":"string","required":true,"description":"Indicates the rank of the payment order product within the group."},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"The identifier of the underlying Entity/Company/Branch."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"CurrencyForRankResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/reference/currencies/numericCodes/{numericCurrencyCode}","fullPath":"/api/v2.2.0/reference/currencies/numericCodes/{numericCurrencyCode}","operationId":"getCurrencyFromNumericCode","name":"Retrieves ISO code of currency based on numeric currency code. Numeric currency codes are short codes that provides an alternative means of referencing the currency","summary":"Retrieves ISO currency code for a numeric currency code","tags":[],"parameters":[{"name":"numericCurrencyCode","in":"path","type":"string","required":true,"description":"Numeric code for the currency"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"The identifier of the underlying Entity/Company/Branch."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"CurrencyFromNumericCodeResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}}]},{"key":"reference-currencies-service-v2.3.0","title":"Currencies","version":"v2.3.0","description":"API to retrieve the list of currencies that are available in the system including the buy and sell rate defined for each currency. Each currency is identified by its ISO currency code.","endpointCount":20,"endpoints":[{"method":"GET","path":"/reference/currencies","fullPath":"/api/v2.3.0/reference/currencies","operationId":"getCurrencies","name":"Retrieves list of the currencies (ISO 4217 codes) that are defined in the system","summary":"Retrieves details of currencies","tags":[],"parameters":[{"name":"currencyId","in":"query","type":"string","required":false,"description":"Identifier of the currency. This is the 3-letter ISO 4217 code of the currency."},{"name":"currencyIdNE","in":"query","type":"string","required":false,"description":"Identifier of the currency. This is the 3-letter ISO 4217 code of the currency."},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"CurrenciesResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/reference/currencies/{currencyId}","fullPath":"/api/v2.3.0/reference/currencies/{currencyId}","operationId":"getCurrencyInfo","name":"Retrieves  details such as currency code, buy rate, sell rate, spread, rank and rounding type","summary":"Retrieves currency details","tags":[],"parameters":[{"name":"currencyId","in":"path","type":"string","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"CurrencyInfoResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"POST","path":"/reference/currencies/{currencyId}","fullPath":"/api/v2.3.0/reference/currencies/{currencyId}","operationId":"createCurrencyInfo","name":"Creates details such as currency code, buy rate, sell rate, spread, rank and rounding type","summary":"Creates currency details","tags":[],"parameters":[{"name":"currencyId","in":"path","type":"string","required":true,"description":"Identifier of the currency. This is the 3-letter ISO 4217 code of the currency."},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"displayNames":[{}],"markets":[{}],"rateInformation":[{}],"equivalentCurrencies":[{}],"rank":"string","numericCurrencyCode":"string","numberofDecimal":"string","quotationCode":"string","quotationPips":"string","noticeDay":"string","nostroProjectionDay":"string","interestDayBasis":"string","allowedVariance":"string","fixedRateDate":"string","minAmount":"string"}},"responses":{"200":"CurrencyInfoResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/reference/currencies/{currencyId}","fullPath":"/api/v2.3.0/reference/currencies/{currencyId}","operationId":"updateCurrencyInfo","name":"Updates details such as currency code, buy rate, sell rate, spread, rank and rounding type","summary":"Updates currency details","tags":[],"parameters":[{"name":"currencyId","in":"path","type":"string","required":true,"description":"Identifier of the currency. This is the 3-letter ISO 4217 code of the currency."},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"displayNames":[{}],"markets":[{}],"rateInformation":[{}],"equivalentCurrencies":[{}],"rank":"string","numericCurrencyCode":"string","numberofDecimal":"string","quotationCode":"string","quotationPips":"string","noticeDay":"string","nostroProjectionDay":"string","interestDayBasis":"string","allowedVariance":"string","fixedRateDate":"string","minAmount":"string"}},"responses":{"200":"CurrencyInfoResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"DELETE","path":"/reference/currencies/{currencyId}","fullPath":"/api/v2.3.0/reference/currencies/{currencyId}","operationId":"deleteCurrencyInfo","name":"Deletes details such as currency code, buy rate, sell rate, spread, rank and rounding type","summary":"Deletes currency details","tags":[],"parameters":[{"name":"currencyId","in":"path","type":"string","required":true,"description":"Identifier of the currency. This is the 3-letter ISO 4217 code of the currency."},{"name":"payload","in":"body","type":"object","required":false,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}}},"responses":{"200":"CurrencyInfoResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/reference/currencies/markets/{currencyMarketId}","fullPath":"/api/v2.3.0/reference/currencies/markets/{currencyMarketId}","operationId":"getCurrencyMarket","name":"Retrieves currency market details such as market name and local spread calculation method details","summary":"Retrieves currency market details","tags":[],"parameters":[{"name":"currencyMarketId","in":"path","type":"string","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"CurrencyMarketResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"POST","path":"/reference/currencies/markets/{currencyMarketId}","fullPath":"/api/v2.3.0/reference/currencies/markets/{currencyMarketId}","operationId":"createCurrencyMarket","name":"Create currency market with details such as market name and local spread calculation method details","summary":"Creates currency market details","tags":[],"parameters":[{"name":"currencyMarketId","in":"path","type":"string","required":true,"description":"Specifies the code by which the Currency Market can be identified."},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"currencyMarketNames":[{}],"spreadCalcuationRoutine":"string","extensions":{}}},"responses":{"200":"CurrencyMarketResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/reference/currencies/markets/{currencyMarketId}","fullPath":"/api/v2.3.0/reference/currencies/markets/{currencyMarketId}","operationId":"updateCurrencyMarket","name":"Update currency market details such as market name and local spread calculation method details","summary":"Updates currency market details","tags":[],"parameters":[{"name":"currencyMarketId","in":"path","type":"string","required":true,"description":"Specifies the code by which the Currency Market can be identified."},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"currencyMarketNames":[{}],"spreadCalcuationRoutine":"string","extensions":{}}},"responses":{"200":"CurrencyMarketResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/reference/currencies/{currencyId}/historicDates/{year}","fullPath":"/api/v2.3.0/reference/currencies/{currencyId}/historicDates/{year}","operationId":"getCurrencyModifications","name":"Retrieves effective date and version number of specified currency","summary":"Retrieves currency historic details","tags":[],"parameters":[{"name":"currencyId","in":"path","type":"string","required":true,"description":"Identifier of the currency. This is the 3-letter ISO 4217 code of the currency."},{"name":"year","in":"path","type":"string","required":true,"description":"Contains the year in a standard ISO format"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"CurrencyModificationsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/reference/currencies/{currencyId}/profiles","fullPath":"/api/v2.3.0/reference/currencies/{currencyId}/profiles","operationId":"getCurrencyBasicInfo","name":"Retrieves basic details like name, numeric code, interest basis and allowed decimals for the specified currency","summary":"Retrieves basic currency details","tags":[],"parameters":[{"name":"currencyId","in":"path","type":"string","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"CurrencyBasicInfoResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"POST","path":"/reference/currencies/{currencyId}/profiles","fullPath":"/api/v2.3.0/reference/currencies/{currencyId}/profiles","operationId":"createCurrencyBasicInfo","name":"Creates basic details like name, numeric code, interest basis and allowed decimals for the specified currency","summary":"Creates basic currency details","tags":[],"parameters":[{"name":"currencyId","in":"path","type":"string","required":true,"description":"Identifier of the currency. This is the 3-letter ISO 4217 code of the currency."},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"displayNames":[{}],"numberofDecimal":"string","numericCurrencyCode":"string","baseCurrencyRank":"string","interestDayBasis":"string","extensions":{}}},"responses":{"200":"CurrencyBasicInfoResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/reference/currencies/{currencyId}/profiles","fullPath":"/api/v2.3.0/reference/currencies/{currencyId}/profiles","operationId":"updateCurrencyBasicInfo","name":"Updates basic details like name, numeric code, interest basis and allowed decimals for the specified currency","summary":"Updates basic currency details","tags":[],"parameters":[{"name":"currencyId","in":"path","type":"string","required":true,"description":"Identifier of the currency. This is the 3-letter ISO 4217 code of the currency."},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"displayNames":[{}],"numberofDecimal":"string","numericCurrencyCode":"string","baseCurrencyRank":"string","interestDayBasis":"string","extensions":{}}},"responses":{"200":"CurrencyBasicInfoResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"DELETE","path":"/reference/currencies/{currencyId}/profiles","fullPath":"/api/v2.3.0/reference/currencies/{currencyId}/profiles","operationId":"deleteCurrencyBasicInfo","name":"Delete basic details like name, numeric code, interest basis and allowed decimals for the specified currency","summary":"Delete basic currency details","tags":[],"parameters":[{"name":"currencyId","in":"path","type":"string","required":true,"description":"Identifier of the currency. This is the 3-letter ISO 4217 code of the currency."},{"name":"payload","in":"body","type":"object","required":false,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}}},"responses":{"200":"CurrencyBasicInfoResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/reference/currencies/currencyGroups/{currencyGroupId}","fullPath":"/api/v2.3.0/reference/currencies/currencyGroups/{currencyGroupId}","operationId":"getCurrencyGroup","name":"The currencies can be grouped for various business reasons like Credit Reporting, Exposure reporting etc","summary":"Retrieve the currency group details","tags":[],"parameters":[{"name":"currencyGroupId","in":"path","type":"string","required":true,"description":"Identifies the currency group"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"CurrencyGroupResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"POST","path":"/reference/currencies/currencyGroups/{currencyGroupId}","fullPath":"/api/v2.3.0/reference/currencies/currencyGroups/{currencyGroupId}","operationId":"createCurrencyGroup","name":"The currencies can be grouped for various business reasons like Credit Reporting, Exposure reporting etc","summary":"Create the currency group to group the currencies based on need","tags":[],"parameters":[{"name":"currencyGroupId","in":"path","type":"string","required":true,"description":"Identifies the currency group"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"displayNames":[{}],"currencyIds":[{}],"extensions":{}}},"responses":{"200":"CurrencyGroupResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/reference/currencies/currencyGroups/{currencyGroupId}","fullPath":"/api/v2.3.0/reference/currencies/currencyGroups/{currencyGroupId}","operationId":"updateCurrencyGroup","name":"The currencies can be grouped for various business reasons like Credit Reporting, Exposure reporting etc","summary":"Update the currency group to group the currencies based on need","tags":[],"parameters":[{"name":"currencyGroupId","in":"path","type":"string","required":true,"description":"Identifies the currency group"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"displayNames":[{}],"currencyIds":[{}],"extensions":{}}},"responses":{"200":"CurrencyGroupResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"DELETE","path":"/reference/currencies/currencyGroups/{currencyGroupId}","fullPath":"/api/v2.3.0/reference/currencies/currencyGroups/{currencyGroupId}","operationId":"deleteCurrencyGroup","name":"Delete the currency group details like Credit Reporting, Exposure reporting etc","summary":"Delete the currency group details","tags":[],"parameters":[{"name":"currencyGroupId","in":"path","type":"string","required":true,"description":"Identifies the currency group"},{"name":"payload","in":"body","type":"object","required":false,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}}},"responses":{"200":"CurrencyGroupResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/reference/currencies/ranks/{rank}","fullPath":"/api/v2.3.0/reference/currencies/ranks/{rank}","operationId":"getCurrencyForRank","name":"Retrieves ISO code of currency based on currency rank. Each currency can be optionally assigned with a currency rank which specifies the currency order in which the dealer wants the currency positions to be shown on the screen when requesting the display of exchange positions","summary":"Retrieves ISO currency code for a currency rank","tags":[],"parameters":[{"name":"rank","in":"path","type":"string","required":true,"description":"Indicates the rank of the payment order product within the group."},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"CurrencyForRankResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/reference/currencies/numericCodes/{numericCurrencyCode}","fullPath":"/api/v2.3.0/reference/currencies/numericCodes/{numericCurrencyCode}","operationId":"getCurrencyFromNumericCode","name":"Retrieves ISO code of currency based on numeric currency code. Numeric currency codes are short codes that provides an alternative means of referencing the currency","summary":"Retrieves ISO currency code for a numeric currency code","tags":[],"parameters":[{"name":"numericCurrencyCode","in":"path","type":"string","required":true,"description":"Numeric code for the currency"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"CurrencyFromNumericCodeResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/reference/currencies/exchangeRates/{buyCurrency}/{sellCurrency}/{transactionAmount}/{transactionAmountType}","fullPath":"/api/v2.3.0/reference/currencies/exchangeRates/{buyCurrency}/{sellCurrency}/{transactionAmount}/{transactionAmountType}","operationId":"getExchangeRate","name":"Retrieves the exchange rate for the requested buy and sell currency. It also performs currency conversion on the amount if  exchange rate, customer rate and spread or the rates as defined for the currency are supplied. When customer rate or spread has to  be applied for calculation, applyCustomerSpread has to be provided with value as YES in the request.","summary":"Calculate and then return customer and exchange rate for given currency and  amounts","tags":[],"parameters":[{"name":"buyCurrency","in":"path","type":"string","required":true,"description":"ISO Currency code for the bought currency.  "},{"name":"sellCurrency","in":"path","type":"string","required":true,"description":"ISO Currency code for the sold currency.  "},{"name":"transactionAmount","in":"path","type":"string","required":true,"description":"Contains the transaction amount. This is based on the currency, either local or foreign currency"},{"name":"transactionAmountType","in":"path","type":"string","required":true,"description":"Indicates the type of the transaction amount, as either BUY or SELL to be used for exchange rate calculation and currency conversion"},{"name":"currencyMarket","in":"query","type":"string","required":false,"description":"Identifies the currency market to be used to get the correct exchange and revaluation rates to be applied to each currency"},{"name":"baseCurrency","in":"query","type":"string","required":false,"description":"Contains the currency of the arrangement which linked to the package or bundle"},{"name":"treasuryRate","in":"query","type":"string","required":false,"description":"The Treasury rate for the conversion between payment currency and the ordering currency"},{"name":"customerRate","in":"query","type":"string","required":false,"description":"The exchange rate that is actually applied for currency conversion in case of transactions involving FX conversion. "},{"name":"customerSpread","in":"query","type":"string","required":false,"description":"The spread that is applied to the published internal exchange rates to derive the final exchange rate or the customer rate for the transaction"},{"name":"spreadPercentage","in":"query","type":"string","required":false,"description":"Indicates the  percentage of the default customer spread to be used in calculating the customer rate"},{"name":"applyCustomerSpread","in":"query","type":"string","required":false,"description":"Indicates if the currency conversion calculation should apply customer spread or not. Yes- When customer spread to be applied. Null - When customer spread is not required to be applied"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"ExchangeRateResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}}]},{"key":"reference-dates-service-v1.0.0","title":"Organization Dates","version":"v1.0.0","description":"APIs to retrieve the working day and holiday information that is used by the organization, either a list for all legal entities or for a specific legal entity.","endpointCount":5,"endpoints":[{"method":"GET","path":"/reference/dates","fullPath":"/api/v1.0.0/reference/dates","operationId":"getDates","name":"Retrieve list of dates","summary":"Retrieves the list of dates","tags":[],"parameters":[{"name":"companyId","in":"query","type":"string","required":false,"description":"The identifier of the underlying Entity/Company/Branch."},{"name":"today","in":"query","type":"string","required":false,"description":"Date of the current business day for all online activities in the selected Company. This field is updated automatically with the date from 'nextWorkingDay' during the Close of Business processing."},{"name":"lastWorkingDay","in":"query","type":"string","required":false,"description":"Contains the date of the last working day"},{"name":"nextWorkingDay","in":"query","type":"string","required":false,"description":"Date of the next business day which will be processed in this Company."},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from t24 on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"The identifier of the underlying Entity/Company/Branch."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"DatesResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/reference/dates/{companyId}","fullPath":"/api/v1.0.0/reference/dates/{companyId}","operationId":"getDatesByCompany","name":"Retrieves dates for specific legal entity","summary":"Retrieves the details of date for a specific company identifier","tags":[],"parameters":[{"name":"companyId","in":"path","type":"string","required":true,"description":"The identifier of the underlying Entity/Company/Branch."},{"name":"today","in":"query","type":"string","required":false,"description":"Date of the current business day for all online activities in the selected Company. This field is updated automatically with the date from 'nextWorkingDay' during the Close of Business processing."},{"name":"lastWorkingDay","in":"query","type":"string","required":false,"description":"Contains the date of the last working day"},{"name":"nextWorkingDay","in":"query","type":"string","required":false,"description":"Date of the next business day which will be processed in this Company."},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from t24 on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"The identifier of the underlying Entity/Company/Branch."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"DatesByCompanyResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/reference/dates/holidays/{holidayId}","fullPath":"/api/v1.0.0/reference/dates/holidays/{holidayId}","operationId":"getHoliday","name":"Retrieves the weekend days, holidays in a month for specific region and year","summary":"Retrieves the holiday information","tags":[],"parameters":[{"name":"holidayId","in":"path","type":"string","required":true,"description":"Identifier of the holiday record."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"The identifier of the underlying Entity/Company/Branch."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"HolidayResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"POST","path":"/reference/dates/holidays/{holidayId}","fullPath":"/api/v1.0.0/reference/dates/holidays/{holidayId}","operationId":"createHoliday","name":"Creates the weekend days, holidays in a month for specific region and year","summary":"Creates the holiday information","tags":[],"parameters":[{"name":"holidayId","in":"path","type":"string","required":true,"description":"Identifier of the holiday record."},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"The identifier of the underlying Entity/Company/Branch."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"publicHolidays":[{}],"weekendDays":[{}],"workingDaysCalendar":[{}]}},"responses":{"200":"HolidayResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/reference/dates/holidays/{holidayId}","fullPath":"/api/v1.0.0/reference/dates/holidays/{holidayId}","operationId":"updateHoliday","name":"Updates the weekend days, holidays in a month for specific region and year","summary":"Updates the holiday information","tags":[],"parameters":[{"name":"holidayId","in":"path","type":"string","required":true,"description":"Identifier of the holiday record."},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"The identifier of the underlying Entity/Company/Branch."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"publicHolidays":[{}],"weekendDays":[{}],"workingDaysCalendar":[{}]}},"responses":{"200":"HolidayResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}}]},{"key":"reference-dates-service-v1.1.0","title":"Organization Dates","version":"v1.1.0","description":"APIs to retrieve the working day and holiday information that is used by the organization, either a list for all legal entities or for a specific legal entity.","endpointCount":6,"endpoints":[{"method":"GET","path":"/reference/dates","fullPath":"/api/v1.1.0/reference/dates","operationId":"getDates","name":"Retrieve list of dates","summary":"Retrieves the list of dates","tags":[],"parameters":[{"name":"companyId","in":"query","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"today","in":"query","type":"string","required":false,"description":"Date of the current business day for all online activities in the selected Company. This field is updated automatically with the date from 'nextWorkingDay' during the Close of Business processing."},{"name":"lastWorkingDay","in":"query","type":"string","required":false,"description":"Contains the date of the last working day"},{"name":"nextWorkingDay","in":"query","type":"string","required":false,"description":"Date of the next business day which will be processed in this Company."},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"DatesResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/reference/dates/{companyId}","fullPath":"/api/v1.1.0/reference/dates/{companyId}","operationId":"getDatesByCompany","name":"Retrieves dates for specific legal entity","summary":"Retrieves the details of date for a specific company identifier","tags":[],"parameters":[{"name":"companyId","in":"path","type":"string","required":true,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"today","in":"query","type":"string","required":false,"description":"Date of the current business day for all online activities in the selected Company. This field is updated automatically with the date from 'nextWorkingDay' during the Close of Business processing."},{"name":"lastWorkingDate","in":"query","type":"string","required":false,"description":"Date of the last business day processed for this Company. This field will be set with the date from Today table by the batch (overnight) processing system."},{"name":"nextWorkingDate","in":"query","type":"string","required":false,"description":"Date of the next business day which will be processed in this Company."},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"DatesByCompanyResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/reference/dates/holidays/{holidayId}","fullPath":"/api/v1.1.0/reference/dates/holidays/{holidayId}","operationId":"getHoliday","name":"Retrieves the weekend days, holidays in a month for specific region and year","summary":"Retrieves the holiday information","tags":[],"parameters":[{"name":"holidayId","in":"path","type":"string","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"HolidayResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"POST","path":"/reference/dates/holidays/{holidayId}","fullPath":"/api/v1.1.0/reference/dates/holidays/{holidayId}","operationId":"createHoliday","name":"Creates the weekend days, holidays in a month for specific region and year","summary":"Creates the holiday information","tags":[],"parameters":[{"name":"holidayId","in":"path","type":"string","required":true,"description":"Identifier of the holiday record"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"publicHolidays":[{}],"weekendDays":[{}],"workingDaysCalendar":[{}]}},"responses":{"200":"HolidayResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/reference/dates/holidays/{holidayId}","fullPath":"/api/v1.1.0/reference/dates/holidays/{holidayId}","operationId":"updateHoliday","name":"Updates the weekend days, holidays in a month for specific region and year","summary":"Updates the holiday information","tags":[],"parameters":[{"name":"holidayId","in":"path","type":"string","required":true,"description":"Identifier of the holiday record"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"publicHolidays":[{}],"weekendDays":[{}],"workingDaysCalendar":[{}]}},"responses":{"200":"HolidayResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/reference/dates/companies","fullPath":"/api/v1.1.0/reference/dates/companies","operationId":"getAllDates","name":"Retrieves all the dates related information in the system including the Close Of Business specific dates for each company or group of companies. The information include- Current Business date, Next Working date, Previous Working date and the status of the company being online or not.","summary":"Retrieves all the dates related information in the system.","tags":[],"parameters":[{"name":"companyId","in":"query","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"currentWorkingDate","in":"query","type":"string","required":false,"description":"Date of the current business day for all online activities in the selected Company. This field is updated automatically with the date from 'nextWorkingDay' during the Close of Business processing."},{"name":"lastWorkingDate","in":"query","type":"string","required":false,"description":"Date of the last business day processed for this Company. This field will be set with the date from Today table by the batch (overnight) processing system."},{"name":"nextWorkingDate","in":"query","type":"string","required":false,"description":"Date of the next business day which will be processed in this Company."},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"AllDatesResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}}]},{"key":"reference-dealers-service-v1.0.0","title":"Dealers","version":"v1.0.0","description":"API to retrieve the list of Dealers in the Bank","endpointCount":1,"endpoints":[{"method":"GET","path":"/reference/dealers","fullPath":"/api/v1.0.0/v1.0.0/reference/dealers","operationId":"getDealers","name":"Retrieves list of the Dealers available in the system","summary":"Retrieves Dealers details","tags":[],"parameters":[{"name":"dealerId","in":"query","type":"string","required":false,"description":"Identifies the dealer/ desk responsible for monitoring and managing currency positions."},{"name":"displayName","in":"query","type":"string","required":false,"description":"Contains the name used for display or enrichment purposes"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from t24 on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"The identifier of the underlying Entity/Company/Branch."}],"requestBodyExample":null,"responses":{"200":"DealersResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}}]},{"key":"reference-events-v1.0.0","title":"APIs to retrieves topic and event group","version":"v1.0.0","description":"Retrieves the details of events configured for generation along with their respective topic names.","endpointCount":1,"endpoints":[{"method":"GET","path":"/reference/eventTopics","fullPath":"/api/v1.0.0/reference/eventTopics","operationId":"getEventTopics","name":"Retrieves the details of events configured for generation along with their respective topic names.","summary":"Retrieves all possible events configured for generation along with their respective topic.","tags":["SYSTEM"],"parameters":[{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"EventTopicsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}}]},{"key":"reference-financialInstitutions-messageExchanges-service-v1.0.0","title":"Financial institutions message exchange relationship authorisation management","version":"v1.0.0","description":"APIs to create the Agreement that is made between the parties in a business relationship to provide permission to send messages for a specific SWIFT service.","endpointCount":2,"endpoints":[{"method":"POST","path":"/reference/financialInstitutions/relationships/messageExchanges/authorisationFiles/{authorisationFileId}","fullPath":"/api/v1.0.0/reference/financialInstitutions/relationships/messageExchanges/authorisationFiles/{authorisationFileId}","operationId":"createRelationshipAuthorisationFile","name":"Creates or updates the relationship authorisation file details for the company and SWIFT service. User needs to pass the details of the partial or complete file","summary":"Create relationship management authorisation file upload details","tags":[],"parameters":[{"name":"authorisationFileId","in":"path","type":"string","required":true,"description":"Indicates the reference of the relationship authorisation file upload record for the company and the SWIFT service"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"partialFileCreateDateTime":"string","partialFileName":"string","partialFileUploadDateTime":"string","completeFileCreateDateTime":"string","completeFileName":"string","completeFileUploadDateTime":"string","extensions":{}}},"responses":{"200":"RelationshipAuthorisationFileResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"POST","path":"/reference/financialInstitutions/relationships/messageExchanges/authorisations/{authorisationId}","fullPath":"/api/v1.0.0/reference/financialInstitutions/relationships/messageExchanges/authorisations/{authorisationId}","operationId":"createRelationshipAuthorisation","name":"Creates or updates a relationship management authorisations for a specific financial institution's counterparty, identified by its 8 digit Bank Identifier Code (BIC8), SWIFT Service. The company id , the Swift service, the message types which are included and/or excluded, the start date ( issue date), valid from, end date,  status must be provided.","summary":"Create relationship management authorisation","tags":[],"parameters":[{"name":"authorisationId","in":"path","type":"string","required":true,"description":"Contains the authorisation number received from the Central Bank of Tunisia."},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"companyId":"string","swiftService":"string","messageTypeInclude":"string","messageTypeExclude":"string","relationshipAuthorisationStartDate":"string","relationshipAuthorisationValidFrom":"string","relationshipAuthorisationEndDate":"string","relationshipAuthorisationStatus":"string","relationshipAuthorisationType":"string","relationshipAuthorisationIssueDateTime":"string","relationshipAuthorisationIssuer":"string","uploadType":"string","uploadFileName":"string","uploadFileCreateDateTime":"string","extensions":{}}},"responses":{"200":"RelationshipAuthorisationResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}}]},{"key":"reference-financialInstitutions-messageExchanges-service-v1.1.0","title":"Financial institutions message exchange relationship authorisation management","version":"v1.1.0","description":"APIs to create the agreement that is made between the parties in a business relationship to provide permission to send messages for a specific SWIFT service.","endpointCount":3,"endpoints":[{"method":"POST","path":"/reference/financialInstitutions/relationships/messageExchanges/authorisationFiles/{authorisationFileId}","fullPath":"/api/v1.1.0/reference/financialInstitutions/relationships/messageExchanges/authorisationFiles/{authorisationFileId}","operationId":"createRelationshipAuthorisationFile","name":"Creates or updates the relationship authorisation file details for the company and SWIFT service. User needs to pass the details of the partial or complete file","summary":"Create relationship management authorisation file upload details","tags":["OTHERS"],"parameters":[{"name":"authorisationFileId","in":"path","type":"string","required":true,"description":"Indicates the reference of the relationship authorisation file upload record for the company and the SWIFT service"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"partialFileCreateDateTime":"string","partialFileName":"string","partialFileUploadDateTime":"string","completeFileCreateDateTime":"string","completeFileName":"string","completeFileUploadDateTime":"string","extensions":{}}},"responses":{"200":"RelationshipAuthorisationFileResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/reference/financialInstitutions/relationships/messageExchanges/authorisations/{authorisationId}","fullPath":"/api/v1.1.0/reference/financialInstitutions/relationships/messageExchanges/authorisations/{authorisationId}","operationId":"getRelationshipAuthorisation","name":"Retrieves the relationship management authorisations issued by a specific financial institution's counterparty, identified by its 8 digit Bank Identifier Code (BIC8),SWIFT Service and date. The 8 digit Bank Identifier Code, SWIFT Service must be provided. If the date is supplied, it retrieves the authorisation issued by the respective counterparty service for the respective date. If no authorisation is given, it will return the latest active authorisation for the respective counterparty and serv","summary":"Retrieves the details of relationship management authorization","tags":["OTHERS"],"parameters":[{"name":"authorisationId","in":"path","type":"string","required":true,"description":"Contains the authorisation number received from the Central Bank of Tunisia."},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"RelationshipAuthorisationResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"POST","path":"/reference/financialInstitutions/relationships/messageExchanges/authorisations/{authorisationId}","fullPath":"/api/v1.1.0/reference/financialInstitutions/relationships/messageExchanges/authorisations/{authorisationId}","operationId":"createRelationshipAuthorisation","name":"Creates or updates a relationship management authorisations for a specific financial institution's counterparty, identified by its 8 digit Bank Identifier Code (BIC8), SWIFT Service. The company id , the Swift service, the message types which are included and/or excluded, the start date ( issue date), valid from, end date,  status must be provided.","summary":"Create relationship management authorisation","tags":["OTHERS"],"parameters":[{"name":"authorisationId","in":"path","type":"string","required":true,"description":"Contains the authorisation number received from the Central Bank of Tunisia."},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"companyId":"string","swiftService":"string","messageTypeInclude":"string","messageTypeExclude":"string","relationshipAuthorisationStartDate":"string","relationshipAuthorisationValidFrom":"string","relationshipAuthorisationEndDate":"string","relationshipAuthorisationStatus":"string","relationshipAuthorisationType":"string","relationshipAuthorisationIssueDateTime":"string","relationshipAuthorisationIssuer":"string","uploadType":"string","uploadFileName":"string","uploadFileCreateDateTime":"string","extensions":{}}},"responses":{"200":"RelationshipAuthorisationResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}}]},{"key":"reference-instruments-service-v1.0.0","title":"API for security instruments","version":"v1.0.0","description":"Allows the viewing of Instruments - Bonds, Equities, Futures, Options, Active IPOs and Funds","endpointCount":17,"endpoints":[{"method":"GET","path":"/reference/instruments/initialPublicOfferings","fullPath":"/api/v1.0.0/reference/instruments/initialPublicOfferings","operationId":"getActiveIPOs","name":"Retrieves the initial offer IPO instruments filtered based on the instrument id, start and end date of the offering","summary":"Retrieves the intial public offerings","tags":[],"parameters":[{"name":"instrumentId","in":"query","type":"string","required":false,"description":"The identifier of the instrument"},{"name":"startDate","in":"query","type":"string","required":false,"description":"Beginning Date of IPO Subscription"},{"name":"endDate","in":"query","type":"string","required":false,"description":"End Date of IPO Subscription  or Amendment of earlier subscription"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"ActiveIPOsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/reference/instruments/bonds","fullPath":"/api/v1.0.0/reference/instruments/bonds","operationId":"getInstrumentsBonds","name":"Retrieves the bond instruments filtered based on the instrument id and instrument currency","summary":"Retrieves the bond instruments","tags":[],"parameters":[{"name":"instrumentId","in":"query","type":"string","required":false,"description":"The identifier of the instrument"},{"name":"instrumentCurrencyId","in":"query","type":"string","required":false,"description":"The currency of the instrument"},{"name":"mnemonic","in":"query","type":"string","required":false,"description":"Shortcut code for referring an Entity/Company/Branch."},{"name":"subAssetTypeId","in":"query","type":"string","required":false,"description":"Identifies the group of like Securities, which are reported together "},{"name":"priceType","in":"query","type":"string","required":false,"description":"Defines the method to be used when calculating the price of a trade"},{"name":"ISIN","in":"query","type":"string","required":false,"description":"The International Securities Identification Number of the instrument"},{"name":"stockExchange","in":"query","type":"string","required":false,"description":"The stock exchange identifier"},{"name":"depositoryId","in":"query","type":"string","required":false,"description":"Id of the securities depository."},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"InstrumentsBondsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"POST","path":"/reference/instruments/bonds","fullPath":"/api/v1.0.0/reference/instruments/bonds","operationId":"createSecurityBond","name":"Creates the bond skeleton instrument","summary":"Creates the bond skeleton instrument","tags":[],"parameters":[{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"alternateInstrumentDetails":[{}],"displayName":"string","mnemonic":"string","ISIN":"string","subAssetTypeId":0.0,"currencyId":"string","depositoryId":0.0,"priceType":"string","lastPrice":0.0,"companyDomicile":"string","instrumentDomicile":"string","priceUpdateCode":"string","industryId":0.0,"stockExchange":"string","interestRate":0.0}},"responses":{"200":"SecurityBondResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/reference/instruments/shares","fullPath":"/api/v1.0.0/reference/instruments/shares","operationId":"getInstrumentShares","name":"Retrieves the share instruments filtered based on the instrument id and instrument currency","summary":"Retrieves the share instruments","tags":[],"parameters":[{"name":"instrumentId","in":"query","type":"string","required":false,"description":"The identifier of the instrument"},{"name":"instrumentCurrencyId","in":"query","type":"string","required":false,"description":"The currency of the instrument"},{"name":"mnemonic","in":"query","type":"string","required":false,"description":"Shortcut code for referring an Entity/Company/Branch."},{"name":"subAssetTypeId","in":"query","type":"string","required":false,"description":"Identifies the group of like Securities, which are reported together "},{"name":"priceType","in":"query","type":"string","required":false,"description":"Defines the method to be used when calculating the price of a trade"},{"name":"ISIN","in":"query","type":"string","required":false,"description":"The International Securities Identification Number of the instrument"},{"name":"stockExchange","in":"query","type":"string","required":false,"description":"The stock exchange identifier"},{"name":"depositoryId","in":"query","type":"string","required":false,"description":"Id of the securities depository."},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"InstrumentSharesResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"POST","path":"/reference/instruments/shares","fullPath":"/api/v1.0.0/reference/instruments/shares","operationId":"createSecurityShare","name":"Creates the share skeleton instrument","summary":"Creates the share skeleton instrument","tags":[],"parameters":[{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"alternateInstrumentDetails":[{}],"minimumInvestmentDetails":[{}],"displayName":"string","mnemonic":"string","ISIN":"string","subAssetType":0.0,"currencyId":"string","depositoryId":0.0,"priceType":"string","lastPrice":0.0,"companyDomicile":"string","instrumentDomicile":"string","priceUpdateCode":"string","industryId":0.0,"stockExchange":"string"}},"responses":{"200":"SecurityShareResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/reference/instruments/futures","fullPath":"/api/v1.0.0/reference/instruments/futures","operationId":"getFutureContracts","name":"Retrieves the future type contracts filtered based on the contract code","summary":"Retrieves the derivatives futures","tags":[],"parameters":[{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"FutureContractsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/reference/instruments/options","fullPath":"/api/v1.0.0/reference/instruments/options","operationId":"getOptionContracts","name":"Retrieves the option type contracts filtered based on the contract code","summary":"Retrieves the derivatives options","tags":[],"parameters":[{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"OptionContractsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/reference/instruments/{instrumentId}/bonds","fullPath":"/api/v1.0.0/reference/instruments/{instrumentId}/bonds","operationId":"getSecurityBond","name":"Retrieves the bond skeleton instrument","summary":"Retrieves the bond skeleton instrument","tags":[],"parameters":[{"name":"instrumentId","in":"path","type":"string","required":true,"description":"The identifier of the instrument"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"SecurityBondResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/reference/instruments/{instrumentId}/shares","fullPath":"/api/v1.0.0/reference/instruments/{instrumentId}/shares","operationId":"getSecurityShare","name":"Retrieves the share skeleton instrument","summary":"Retrieves the share skeleton instrument","tags":[],"parameters":[{"name":"instrumentId","in":"path","type":"string","required":true,"description":"The identifier of the instrument"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"SecurityShareResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"POST","path":"/reference/instruments/structuredNotes","fullPath":"/api/v1.0.0/reference/instruments/structuredNotes","operationId":"createStructuredNotes","name":"Creates the structured notes instruments","summary":"Creates the structured notes instruments","tags":[],"parameters":[{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"alternateInstrumentDetails":[{}],"interestRates":[{}],"instrumentName":"string","ISIN":"string","structureNote":true,"subAssetTypeId":0.0,"currencyId":"string","priceType":"string","lastPrice":0.0,"companyDomicile":"string","instrumentDomicile":"string","priceUpdateCode":"string","industryId":0.0,"stockExchange":"string","issueDate":"2024-01-01"}},"responses":{"200":"StructuredNotesResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/reference/instruments/{instrumentId}/structuredNotes","fullPath":"/api/v1.0.0/reference/instruments/{instrumentId}/structuredNotes","operationId":"getStructuredNote","name":"Retrieves the structured notes instruments","summary":"Retrieves the structured notes instruments","tags":[],"parameters":[{"name":"instrumentId","in":"path","type":"string","required":true,"description":"The identifier of the instrument"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"StructuredNoteResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/reference/instruments/{instrumentId}/funds","fullPath":"/api/v1.0.0/reference/instruments/{instrumentId}/funds","operationId":"getFundInstrument","name":"Retrieves the fund security","summary":"Retrieves the fund security","tags":[],"parameters":[{"name":"instrumentId","in":"path","type":"string","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"FundInstrumentResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"POST","path":"/reference/instruments/{instrumentId}/funds","fullPath":"/api/v1.0.0/reference/instruments/{instrumentId}/funds","operationId":"createFundInstrument","name":"Creates the mutual fund instrument","summary":"Creates the fund security","tags":[],"parameters":[{"name":"instrumentId","in":"path","type":"string","required":true,"description":""},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"alternateInstrumentDetails":[{}],"interestRates":[{}],"instrumentName":"string","ISIN":"string","structureNote":true,"subAssetTypeId":0.0,"currencyId":"string","priceType":"string","lastPrice":0.0,"companyDomicile":"string","instrumentDomicile":"string","priceUpdateCode":"string","industryId":"string","stockExchange":"string","issueDate":"2024-01-01"}},"responses":{"200":"FundInstrumentResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/reference/instruments","fullPath":"/api/v1.0.0/reference/instruments","operationId":"getInstruments","name":"Allows to retrieve instruments","summary":"Instrument List","tags":[],"parameters":[{"name":"instrumentId","in":"query","type":"string","required":false,"description":"The identifier of the instrument"},{"name":"instrumentName","in":"query","type":"string","required":false,"description":"The name that is displayed for the instrument, taken from the Security Master"},{"name":"instrumentCurrencyId","in":"query","type":"string","required":false,"description":"The currency of the instrument"},{"name":"mnemonic","in":"query","type":"string","required":false,"description":"Shortcut code for referring an Entity/Company/Branch."},{"name":"subAssetTypeId","in":"query","type":"string","required":false,"description":"Identifies the group of like Securities, which are reported together "},{"name":"priceType","in":"query","type":"string","required":false,"description":"Defines the method to be used when calculating the price of a trade"},{"name":"ISIN","in":"query","type":"string","required":false,"description":"The International Securities Identification Number of the instrument"},{"name":"stockExchange","in":"query","type":"string","required":false,"description":"The stock exchange identifier"},{"name":"depositoryId","in":"query","type":"string","required":false,"description":"Id of the securities depository."},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"InstrumentsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"POST","path":"/reference/instruments","fullPath":"/api/v1.0.0/reference/instruments","operationId":"createInstrumentMaster","name":"Creates instrument master","summary":"Creates instrument master","tags":[],"parameters":[{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"alternateInstrumentDetails":[{}],"minimumInvestmentDetails":[{}],"probOfDefts":[{}],"displayName":"string","mnemonic":"string","ISIN":"string","subAssetTypeId":0.0,"currencyId":"string","depositoryId":0.0,"priceType":"string","instrumentType":"string","lastPrice":0.0,"companyDomicile":"string","instrumentDomicile":"string","priceUpdateCode":"string"}},"responses":{"200":"InstrumentMasterResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/reference/instruments/{id}/instrumentDetails","fullPath":"/api/v1.0.0/reference/instruments/{id}/instrumentDetails","operationId":"getInstrumentMaster","name":"Get instrument details for the instrument","summary":"Get instrument details for the instrument","tags":[],"parameters":[{"name":"id","in":"path","type":"string","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"InstrumentMasterResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/reference/instruments/{id}/instrumentDetails","fullPath":"/api/v1.0.0/reference/instruments/{id}/instrumentDetails","operationId":"updateInstrumentMaster","name":"Update instrument master details for the instrument","summary":"Update instrument details for the instrument","tags":[],"parameters":[{"name":"id","in":"path","type":"string","required":true,"description":"Contains the daily position class id."},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"alternateInstrumentDetails":[{}],"minimumInvestmentDetails":[{}],"probOfDefts":[{}],"displayName":"string","mnemonic":"string","ISIN":"string","subAssetTypeId":0.0,"currencyId":"string","depositoryId":0.0,"priceType":"string","instrumentType":"string","lastPrice":0.0,"companyDomicile":"string","instrumentDomicile":"string","priceUpdateCode":"string"}},"responses":{"200":"InstrumentMasterResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}}]},{"key":"reference-instruments-service-v1.1.0","title":"API for security instruments","version":"v1.1.0","description":"Allows the viewing of Instruments - Bonds, Equities, Futures, Options, Active IPOs and Funds","endpointCount":19,"endpoints":[{"method":"GET","path":"/reference/instruments/initialPublicOfferings","fullPath":"/api/v1.1.0/reference/instruments/initialPublicOfferings","operationId":"getActiveIPOs","name":"Retrieves the initial offer IPO instruments filtered based on the instrument id, start and end date of the offering","summary":"Retrieves the intial public offerings","tags":[],"parameters":[{"name":"instrumentId","in":"query","type":"string","required":false,"description":"The identifier of the instrument"},{"name":"startDate","in":"query","type":"string","required":false,"description":"Beginning Date of IPO Subscription"},{"name":"endDate","in":"query","type":"string","required":false,"description":"End Date of IPO Subscription  or Amendment of earlier subscription"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"ActiveIPOsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/reference/instruments/bonds","fullPath":"/api/v1.1.0/reference/instruments/bonds","operationId":"getInstrumentsBonds","name":"Retrieves the bond instruments filtered based on the instrument id and instrument currency","summary":"Retrieves the bond instruments","tags":[],"parameters":[{"name":"instrumentId","in":"query","type":"string","required":false,"description":"The identifier of the instrument"},{"name":"instrumentCurrencyId","in":"query","type":"string","required":false,"description":"The currency of the instrument"},{"name":"mnemonic","in":"query","type":"string","required":false,"description":"Shortcut code for referring an Entity/Company/Branch."},{"name":"subAssetTypeId","in":"query","type":"string","required":false,"description":"Identifies the group of like Securities, which are reported together "},{"name":"priceType","in":"query","type":"string","required":false,"description":"Defines the method to be used when calculating the price of a trade"},{"name":"ISIN","in":"query","type":"string","required":false,"description":"The International Securities Identification Number of the instrument"},{"name":"stockExchange","in":"query","type":"string","required":false,"description":"The stock exchange identifier"},{"name":"depositoryId","in":"query","type":"string","required":false,"description":"Id of the securities depository."},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"InstrumentsBondsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"POST","path":"/reference/instruments/bonds","fullPath":"/api/v1.1.0/reference/instruments/bonds","operationId":"createSecurityBond","name":"Creates the bond skeleton instrument","summary":"Creates the bond skeleton instrument","tags":[],"parameters":[{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"alternateInstrumentDetails":[{}],"displayName":"string","mnemonic":"string","ISIN":"string","subAssetTypeId":0.0,"currencyId":"string","depositoryId":0.0,"priceType":"string","lastPrice":0.0,"companyDomicile":"string","instrumentDomicile":"string","priceUpdateCode":"string","industryId":0.0,"stockExchange":"string","interestRate":0.0}},"responses":{"200":"SecurityBondResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/reference/instruments/shares","fullPath":"/api/v1.1.0/reference/instruments/shares","operationId":"getInstrumentShares","name":"Retrieves the share instruments filtered based on the instrument id and instrument currency","summary":"Retrieves the share instruments","tags":[],"parameters":[{"name":"instrumentId","in":"query","type":"string","required":false,"description":"The identifier of the instrument"},{"name":"instrumentCurrencyId","in":"query","type":"string","required":false,"description":"The currency of the instrument"},{"name":"mnemonic","in":"query","type":"string","required":false,"description":"Shortcut code for referring an Entity/Company/Branch."},{"name":"subAssetTypeId","in":"query","type":"string","required":false,"description":"Identifies the group of like Securities, which are reported together "},{"name":"priceType","in":"query","type":"string","required":false,"description":"Defines the method to be used when calculating the price of a trade"},{"name":"ISIN","in":"query","type":"string","required":false,"description":"The International Securities Identification Number of the instrument"},{"name":"stockExchange","in":"query","type":"string","required":false,"description":"The stock exchange identifier"},{"name":"depositoryId","in":"query","type":"string","required":false,"description":"Id of the securities depository."},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"InstrumentSharesResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"POST","path":"/reference/instruments/shares","fullPath":"/api/v1.1.0/reference/instruments/shares","operationId":"createSecurityShare","name":"Creates the share skeleton instrument","summary":"Creates the share skeleton instrument","tags":[],"parameters":[{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"alternateInstrumentDetails":[{}],"minimumInvestmentDetails":[{}],"displayName":"string","mnemonic":"string","ISIN":"string","subAssetType":0.0,"currencyId":"string","depositoryId":0.0,"priceType":"string","lastPrice":0.0,"companyDomicile":"string","instrumentDomicile":"string","priceUpdateCode":"string","industryId":0.0,"stockExchange":"string"}},"responses":{"200":"SecurityShareResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/reference/instruments/futures","fullPath":"/api/v1.1.0/reference/instruments/futures","operationId":"getFutureContracts","name":"Retrieves the future type contracts filtered based on the contract code","summary":"Retrieves the derivatives futures","tags":[],"parameters":[{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"FutureContractsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/reference/instruments/options","fullPath":"/api/v1.1.0/reference/instruments/options","operationId":"getOptionContracts","name":"Retrieves the option type contracts filtered based on the contract code","summary":"Retrieves the derivatives options","tags":[],"parameters":[{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"OptionContractsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/reference/instruments/{instrumentId}/bonds","fullPath":"/api/v1.1.0/reference/instruments/{instrumentId}/bonds","operationId":"getSecurityBond","name":"Retrieves the bond skeleton instrument","summary":"Retrieves the bond skeleton instrument","tags":[],"parameters":[{"name":"instrumentId","in":"path","type":"string","required":true,"description":"The identifier of the instrument"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"SecurityBondResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/reference/instruments/{instrumentId}/shares","fullPath":"/api/v1.1.0/reference/instruments/{instrumentId}/shares","operationId":"getSecurityShare","name":"Retrieves the share skeleton instrument","summary":"Retrieves the share skeleton instrument","tags":[],"parameters":[{"name":"instrumentId","in":"path","type":"string","required":true,"description":"The identifier of the instrument"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"SecurityShareResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"POST","path":"/reference/instruments/structuredNotes","fullPath":"/api/v1.1.0/reference/instruments/structuredNotes","operationId":"createStructuredNotes","name":"Creates the structured notes instruments","summary":"Creates the structured notes instruments","tags":[],"parameters":[{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"alternateInstrumentDetails":[{}],"interestRates":[{}],"instrumentName":"string","ISIN":"string","structureNote":true,"subAssetTypeId":0.0,"currencyId":"string","priceType":"string","lastPrice":0.0,"companyDomicile":"string","instrumentDomicile":"string","priceUpdateCode":"string","industryId":0.0,"stockExchange":"string","issueDate":"2024-01-01"}},"responses":{"200":"StructuredNotesResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/reference/instruments/{instrumentId}/structuredNotes","fullPath":"/api/v1.1.0/reference/instruments/{instrumentId}/structuredNotes","operationId":"getStructuredNote","name":"Retrieves the structured notes instruments","summary":"Retrieves the structured notes instruments","tags":[],"parameters":[{"name":"instrumentId","in":"path","type":"string","required":true,"description":"The identifier of the instrument"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"StructuredNoteResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/reference/instruments/{instrumentId}/funds","fullPath":"/api/v1.1.0/reference/instruments/{instrumentId}/funds","operationId":"getFundInstrument","name":"Retrieves the fund security","summary":"Retrieves the fund security","tags":[],"parameters":[{"name":"instrumentId","in":"path","type":"string","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"FundInstrumentResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"POST","path":"/reference/instruments/{instrumentId}/funds","fullPath":"/api/v1.1.0/reference/instruments/{instrumentId}/funds","operationId":"createFundInstrument","name":"Creates the mutual fund instrument","summary":"Creates the fund security","tags":[],"parameters":[{"name":"instrumentId","in":"path","type":"string","required":true,"description":""},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"alternateInstrumentDetails":[{}],"interestRates":[{}],"instrumentName":"string","ISIN":"string","structureNote":true,"subAssetTypeId":0.0,"currencyId":"string","priceType":"string","lastPrice":0.0,"companyDomicile":"string","instrumentDomicile":"string","priceUpdateCode":"string","industryId":"string","stockExchange":"string","issueDate":"2024-01-01"}},"responses":{"200":"FundInstrumentResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/reference/instruments","fullPath":"/api/v1.1.0/reference/instruments","operationId":"getInstruments","name":"Retrieves security instruments filtered based on instrument id, instrument name, security currency, ISIN and stock exchange","summary":"Retrieves security instruments such as shares, bonds and funds","tags":[],"parameters":[{"name":"instrumentId","in":"query","type":"string","required":false,"description":"The identifier of the instrument"},{"name":"instrumentName","in":"query","type":"string","required":false,"description":"The name that is displayed for the instrument, taken from the Security Master"},{"name":"instrumentCurrencyId","in":"query","type":"string","required":false,"description":"The currency of the instrument"},{"name":"mnemonic","in":"query","type":"string","required":false,"description":"Shortcut code for referring an Entity/Company/Branch."},{"name":"subAssetTypeId","in":"query","type":"string","required":false,"description":"Identifies the group of like Securities, which are reported together "},{"name":"priceType","in":"query","type":"string","required":false,"description":"Defines the method to be used when calculating the price of a trade"},{"name":"ISIN","in":"query","type":"string","required":false,"description":"The International Securities Identification Number of the instrument"},{"name":"stockExchange","in":"query","type":"string","required":false,"description":"The stock exchange identifier"},{"name":"depositoryId","in":"query","type":"string","required":false,"description":"Id of the securities depository."},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"InstrumentsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"POST","path":"/reference/instruments","fullPath":"/api/v1.1.0/reference/instruments","operationId":"createInstrumentMaster","name":"Creates instrument master","summary":"Creates instrument master","tags":[],"parameters":[{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"alternateInstrumentDetails":[{}],"minimumInvestmentDetails":[{}],"probabilityOfDefaults":[{}],"displayName":"string","mnemonic":"string","ISIN":"string","subAssetTypeId":0.0,"currencyId":"string","depositoryId":0.0,"priceType":"string","instrumentType":"string","lastPrice":0.0,"companyDomicile":"string","instrumentDomicile":"string","priceUpdateCode":"string"}},"responses":{"200":"InstrumentMasterResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/reference/instruments/{id}/instrumentDetails","fullPath":"/api/v1.1.0/reference/instruments/{id}/instrumentDetails","operationId":"getInstrumentMaster","name":"Get instrument details for the instrument","summary":"Get instrument details for the instrument","tags":[],"parameters":[{"name":"id","in":"path","type":"string","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"InstrumentMasterResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/reference/instruments/{id}/instrumentDetails","fullPath":"/api/v1.1.0/reference/instruments/{id}/instrumentDetails","operationId":"updateInstrumentMaster","name":"Update instrument master details for the instrument","summary":"Update instrument details for the instrument","tags":[],"parameters":[{"name":"id","in":"path","type":"string","required":true,"description":"Contains the daily position class id."},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"alternateInstrumentDetails":[{}],"minimumInvestmentDetails":[{}],"probabilityOfDefaults":[{}],"displayName":"string","mnemonic":"string","ISIN":"string","subAssetTypeId":0.0,"currencyId":"string","depositoryId":0.0,"priceType":"string","instrumentType":"string","lastPrice":0.0,"companyDomicile":"string","instrumentDomicile":"string","priceUpdateCode":"string"}},"responses":{"200":"InstrumentMasterResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/reference/instruments/derivativeInstrument","fullPath":"/api/v1.1.0/reference/instruments/derivativeInstrument","operationId":"getDerivativesInstrument","name":"Retrieves derivative instruments filtered based on contract code, instrument name, maturity date,strike price and option type","summary":"Retrieves derivative instruments","tags":[],"parameters":[{"name":"instrumentId","in":"query","type":"string","required":false,"description":"The identifier of the instrument"},{"name":"contractId","in":"query","type":"string","required":false,"description":"Identifies the unique identifier of the transaction or contract."},{"name":"instrumentName","in":"query","type":"string","required":false,"description":"The name that is displayed for the instrument, taken from the Security Master"},{"name":"maturityDate","in":"query","type":"string","required":false,"description":"Indicates maturity date of the contract"},{"name":"strikePrice","in":"query","type":"string","required":false,"description":"The price at which the option holder has the right to buy (Call Options) or sell (Put Options) the underlying instrument, or to cash-settle the option if appropriate"},{"name":"callOrPut","in":"query","type":"string","required":false,"description":"Indicates whether the transaction is a call or put.  Allowed values: - CALL  - PUT"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"DerivativesInstrumentResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/reference/instruments/derivativeContractMaster","fullPath":"/api/v1.1.0/reference/instruments/derivativeContractMaster","operationId":"getDXContracts","name":"Retrieves derivative contracts filtered based on contract code, name and type of contract","summary":"Retrieves derivative contracts","tags":[],"parameters":[{"name":"contractId","in":"query","type":"string","required":false,"description":"Identifies the unique identifier of the transaction or contract."},{"name":"instrumentName","in":"query","type":"string","required":false,"description":"The name that is displayed for the instrument, taken from the Security Master"},{"name":"tradeType","in":"query","type":"string","required":false,"description":"The trade type"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"DXContractsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}}]},{"key":"reference-instruments-service-v2.0.0","title":"API for security instruments","version":"v2.0.0","description":"Allows the viewing of Instruments - Bonds, Equities, Futures, Options, Active IPOs,Funds and Crypto assets","endpointCount":22,"endpoints":[{"method":"GET","path":"/reference/instruments/initialPublicOfferings","fullPath":"/api/v2.0.0/reference/instruments/initialPublicOfferings","operationId":"getActiveIPOs","name":"Retrieves the initial offer IPO instruments filtered based on the instrument id, start and end date of the offering","summary":"Retrieves the intial public offerings","tags":["WEALTH"],"parameters":[{"name":"instrumentId","in":"query","type":"string","required":false,"description":"The identifier of the instrument"},{"name":"startDate","in":"query","type":"string","required":false,"description":"Beginning Date of IPO Subscription"},{"name":"endDate","in":"query","type":"string","required":false,"description":"End Date of IPO Subscription  or Amendment of earlier subscription"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"ActiveIPOsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/reference/instruments/bonds","fullPath":"/api/v2.0.0/reference/instruments/bonds","operationId":"getInstrumentsBonds","name":"Retrieves the bond instruments filtered based on the instrument id and instrument currency","summary":"Retrieves the bond instruments","tags":["WEALTH"],"parameters":[{"name":"instrumentId","in":"query","type":"string","required":false,"description":"The identifier of the instrument"},{"name":"instrumentCurrencyId","in":"query","type":"string","required":false,"description":"The currency of the instrument"},{"name":"mnemonic","in":"query","type":"string","required":false,"description":"Shortcut code for referring an Entity/Company/Branch."},{"name":"subAssetTypeId","in":"query","type":"string","required":false,"description":"Identifies the group of like Securities, which are reported together "},{"name":"priceType","in":"query","type":"string","required":false,"description":"Defines the method to be used when calculating the price of a trade"},{"name":"ISIN","in":"query","type":"string","required":false,"description":"The international securities identification number of the instrument"},{"name":"stockExchange","in":"query","type":"string","required":false,"description":"Contains the stock exchange details where a particular security is usually dealt"},{"name":"depositoryId","in":"query","type":"string","required":false,"description":"Id of the securities depository."},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"InstrumentsBondsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"POST","path":"/reference/instruments/bonds","fullPath":"/api/v2.0.0/reference/instruments/bonds","operationId":"createSecurityBond","name":"Creates the bond skeleton instrument","summary":"Creates the bond skeleton instrument","tags":["WEALTH"],"parameters":[{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"alternateInstrumentDetails":[{}],"displayName":"string","mnemonic":"string","ISIN":"string","subAssetTypeId":0.0,"currencyId":"string","depositoryId":0.0,"priceType":"string","lastPrice":0.0,"companyDomicile":"string","instrumentDomicile":"string","priceUpdateCode":"string","industryId":0.0,"stockExchange":"string","interestRate":0.0}},"responses":{"200":"SecurityBondResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/reference/instruments/shares","fullPath":"/api/v2.0.0/reference/instruments/shares","operationId":"getInstrumentShares","name":"Retrieves the share instruments filtered based on the instrument id and instrument currency","summary":"Retrieves the share instruments","tags":["WEALTH"],"parameters":[{"name":"instrumentId","in":"query","type":"string","required":false,"description":"The identifier of the instrument"},{"name":"instrumentCurrencyId","in":"query","type":"string","required":false,"description":"The currency of the instrument"},{"name":"mnemonic","in":"query","type":"string","required":false,"description":"Shortcut code for referring an Entity/Company/Branch."},{"name":"subAssetTypeId","in":"query","type":"string","required":false,"description":"Identifies the group of like Securities, which are reported together "},{"name":"priceType","in":"query","type":"string","required":false,"description":"Defines the method to be used when calculating the price of a trade"},{"name":"ISIN","in":"query","type":"string","required":false,"description":"The international securities identification number of the instrument"},{"name":"stockExchange","in":"query","type":"string","required":false,"description":"Contains the stock exchange details where a particular security is usually dealt"},{"name":"depositoryId","in":"query","type":"string","required":false,"description":"Id of the securities depository."},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"InstrumentSharesResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"POST","path":"/reference/instruments/shares","fullPath":"/api/v2.0.0/reference/instruments/shares","operationId":"createSecurityShare","name":"Creates the share skeleton instrument","summary":"Creates the share skeleton instrument","tags":["WEALTH"],"parameters":[{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"alternateInstrumentDetails":[{}],"minimumInvestmentDetails":[{}],"displayName":"string","mnemonic":"string","ISIN":"string","subAssetType":0.0,"currencyId":"string","depositoryId":0.0,"priceType":"string","lastPrice":0.0,"companyDomicile":"string","instrumentDomicile":"string","priceUpdateCode":"string","industryId":0.0,"stockExchange":"string"}},"responses":{"200":"SecurityShareResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/reference/instruments/futures","fullPath":"/api/v2.0.0/reference/instruments/futures","operationId":"getFutureContracts","name":"Retrieves the future type contracts filtered based on the contract code","summary":"Retrieves the derivatives futures","tags":["WEALTH"],"parameters":[{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"FutureContractsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/reference/instruments/options","fullPath":"/api/v2.0.0/reference/instruments/options","operationId":"getOptionContracts","name":"Retrieves the option type contracts filtered based on the contract code","summary":"Retrieves the derivatives options","tags":["WEALTH"],"parameters":[{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"OptionContractsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/reference/instruments/{instrumentId}/bonds","fullPath":"/api/v2.0.0/reference/instruments/{instrumentId}/bonds","operationId":"getSecurityBond","name":"Retrieves the bond skeleton instrument","summary":"Retrieves the bond skeleton instrument","tags":["WEALTH"],"parameters":[{"name":"instrumentId","in":"path","type":"string","required":true,"description":"The identifier of the instrument"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"SecurityBondResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/reference/instruments/{instrumentId}/shares","fullPath":"/api/v2.0.0/reference/instruments/{instrumentId}/shares","operationId":"getSecurityShare","name":"Retrieves the share skeleton instrument","summary":"Retrieves the share skeleton instrument","tags":["WEALTH"],"parameters":[{"name":"instrumentId","in":"path","type":"string","required":true,"description":"The identifier of the instrument"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"SecurityShareResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"POST","path":"/reference/instruments/structuredNotes","fullPath":"/api/v2.0.0/reference/instruments/structuredNotes","operationId":"createStructuredNotes","name":"Creates the structured notes instruments","summary":"Creates the structured notes instruments","tags":["WEALTH"],"parameters":[{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"alternateInstrumentDetails":[{}],"interestRates":[{}],"instrumentName":"string","ISIN":"string","structureNote":true,"subAssetTypeId":0.0,"currencyId":"string","priceType":"string","lastPrice":0.0,"companyDomicile":"string","instrumentDomicile":"string","priceUpdateCode":"string","industryId":0.0,"stockExchange":"string","issueDate":"2024-01-01"}},"responses":{"200":"StructuredNotesResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/reference/instruments/{instrumentId}/structuredNotes","fullPath":"/api/v2.0.0/reference/instruments/{instrumentId}/structuredNotes","operationId":"getStructuredNote","name":"Retrieves the structured notes instruments","summary":"Retrieves the structured notes instruments","tags":["WEALTH"],"parameters":[{"name":"instrumentId","in":"path","type":"string","required":true,"description":"The identifier of the instrument"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"StructuredNoteResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/reference/instruments/{instrumentId}/funds","fullPath":"/api/v2.0.0/reference/instruments/{instrumentId}/funds","operationId":"getFundInstrument","name":"Retrieves the fund security","summary":"Retrieves the fund security","tags":["WEALTH"],"parameters":[{"name":"instrumentId","in":"path","type":"string","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"FundInstrumentResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"POST","path":"/reference/instruments/{instrumentId}/funds","fullPath":"/api/v2.0.0/reference/instruments/{instrumentId}/funds","operationId":"createFundInstrument","name":"Creates the mutual fund instrument","summary":"Creates the fund security","tags":["WEALTH"],"parameters":[{"name":"instrumentId","in":"path","type":"string","required":true,"description":""},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"alternateInstrumentDetails":[{}],"interestRates":[{}],"instrumentName":"string","ISIN":"string","structureNote":true,"subAssetTypeId":0.0,"currencyId":"string","priceType":"string","lastPrice":0.0,"companyDomicile":"string","instrumentDomicile":"string","priceUpdateCode":"string","industryId":"string","stockExchange":"string","issueDate":"2024-01-01"}},"responses":{"200":"FundInstrumentResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/reference/instruments","fullPath":"/api/v2.0.0/reference/instruments","operationId":"getInstruments","name":"Retrieves security instruments filtered based on instrument id, instrument name, security currency, ISIN and stock exchange","summary":"Retrieves security instruments such as shares, bonds and funds","tags":["WEALTH"],"parameters":[{"name":"instrumentId","in":"query","type":"string","required":false,"description":"The identifier of the instrument"},{"name":"instrumentName","in":"query","type":"string","required":false,"description":"The name that is displayed for the instrument, taken from the security master"},{"name":"instrumentCurrencyId","in":"query","type":"string","required":false,"description":"The currency of the instrument"},{"name":"mnemonic","in":"query","type":"string","required":false,"description":"Shortcut code for referring an Entity/Company/Branch."},{"name":"subAssetTypeId","in":"query","type":"string","required":false,"description":"Identifies the group of like Securities, which are reported together "},{"name":"priceType","in":"query","type":"string","required":false,"description":"Defines the method to be used when calculating the price of a trade"},{"name":"ISIN","in":"query","type":"string","required":false,"description":"The international securities identification number of the instrument"},{"name":"stockExchange","in":"query","type":"string","required":false,"description":"Contains the stock exchange details where a particular security is usually dealt"},{"name":"depositoryId","in":"query","type":"string","required":false,"description":"Id of the securities depository."},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"InstrumentsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"POST","path":"/reference/instruments","fullPath":"/api/v2.0.0/reference/instruments","operationId":"createInstrumentMaster","name":"Creates instrument master","summary":"Creates instrument master","tags":["WEALTH"],"parameters":[{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"alternateInstrumentDetails":[{}],"minimumInvestmentDetails":[{}],"probabilityOfDefaults":[{}],"displayName":"string","mnemonic":"string","ISIN":"string","subAssetTypeId":0.0,"currencyId":"string","depositoryId":0.0,"priceType":"string","instrumentType":"string","lastPrice":0.0,"companyDomicile":"string","instrumentDomicile":"string","priceUpdateCode":"string"}},"responses":{"200":"InstrumentMasterResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/reference/instruments/{id}/instrumentDetails","fullPath":"/api/v2.0.0/reference/instruments/{id}/instrumentDetails","operationId":"getInstrumentMaster","name":"Get instrument details for the instrument","summary":"Get instrument details for the instrument","tags":["WEALTH"],"parameters":[{"name":"id","in":"path","type":"string","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"InstrumentMasterResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/reference/instruments/{id}/instrumentDetails","fullPath":"/api/v2.0.0/reference/instruments/{id}/instrumentDetails","operationId":"updateInstrumentMaster","name":"Update instrument master details for the instrument","summary":"Update instrument details for the instrument","tags":["WEALTH"],"parameters":[{"name":"id","in":"path","type":"string","required":true,"description":"Contains the daily position class id."},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"alternateInstrumentDetails":[{}],"minimumInvestmentDetails":[{}],"probabilityOfDefaults":[{}],"displayName":"string","mnemonic":"string","ISIN":"string","subAssetTypeId":0.0,"currencyId":"string","depositoryId":0.0,"priceType":"string","instrumentType":"string","lastPrice":0.0,"companyDomicile":"string","instrumentDomicile":"string","priceUpdateCode":"string"}},"responses":{"200":"InstrumentMasterResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/reference/instruments/derivativeInstrument","fullPath":"/api/v2.0.0/reference/instruments/derivativeInstrument","operationId":"getDerivativesInstrument","name":"Retrieves derivative instruments filtered based on contract code, instrument name, maturity date,strike price and option type","summary":"Retrieves derivative instruments","tags":["WEALTH"],"parameters":[{"name":"instrumentId","in":"query","type":"string","required":false,"description":"The identifier of the instrument"},{"name":"contractId","in":"query","type":"string","required":false,"description":"Identifies the unique identifier of the transaction or contract."},{"name":"instrumentName","in":"query","type":"string","required":false,"description":"The name that is displayed for the instrument, taken from the security master"},{"name":"maturityDate","in":"query","type":"string","required":false,"description":"Indicates maturity date of the contract"},{"name":"strikePrice","in":"query","type":"string","required":false,"description":"The price at which the option holder has the right to buy (Call Options) or sell (Put Options) the underlying instrument, or to cash-settle the option if appropriate"},{"name":"callOrPut","in":"query","type":"string","required":false,"description":"Indicates whether the transaction is a call or put.  Allowed values: - CALL  - PUT"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"DerivativesInstrumentResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/reference/instruments/derivativeContractMaster","fullPath":"/api/v2.0.0/reference/instruments/derivativeContractMaster","operationId":"getDXContracts","name":"Retrieves derivative contracts filtered based on contract code, name and type of contract","summary":"Retrieves derivative contracts","tags":["WEALTH"],"parameters":[{"name":"contractId","in":"query","type":"string","required":false,"description":"Identifies the unique identifier of the transaction or contract."},{"name":"instrumentName","in":"query","type":"string","required":false,"description":"The name that is displayed for the instrument, taken from the security master"},{"name":"tradeType","in":"query","type":"string","required":false,"description":"The trade type"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"DXContractsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"POST","path":"/reference/instruments/cryptoAssets","fullPath":"/api/v2.0.0/reference/instruments/cryptoAssets","operationId":"createCryptoAsset","name":"Creates the crypto asset instrument","summary":"Creates the crypto asset instrument","tags":["WEALTH"],"parameters":[{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"alternateInstrumentDetails":[{}],"displayName":"string","mnemonic":"string","ISIN":"string","currencyId":"string","blockChainId":"string","lastPrice":0.0,"instrumentDomicile":"string","parValue":0.0,"tradingUnits":0.0,"brokerTradingUnits":0.0,"cryptoAsset":"string","blacklistingDate":"2024-01-01","blacklistingNarrative":"string","extensions":{}}},"responses":{"200":"CryptoAssetResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/reference/instruments/{id}/cryptoAssets","fullPath":"/api/v2.0.0/reference/instruments/{id}/cryptoAssets","operationId":"getCryptoAsset","name":"Retrieves instrument details of crypto asset","summary":"Retrieves instrument details for the  crypto asset","tags":["WEALTH"],"parameters":[{"name":"id","in":"path","type":"string","required":true,"description":"Contains the daily position class id."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"CryptoAssetResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/reference/instruments/{id}/cryptoAssets","fullPath":"/api/v2.0.0/reference/instruments/{id}/cryptoAssets","operationId":"updateCryptoAsset","name":"Update instrument details for the cryptoasset or blacklisting crypto asset","summary":"Update instrument details for the cryptoasset","tags":["WEALTH"],"parameters":[{"name":"id","in":"path","type":"string","required":true,"description":"Contains the daily position class id."},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"alternateInstrumentDetails":[{}],"displayName":"string","mnemonic":"string","ISIN":"string","currencyId":"string","blockChainId":"string","lastPrice":0.0,"instrumentDomicile":"string","parValue":0.0,"tradingUnits":0.0,"brokerTradingUnits":0.0,"cryptoAsset":"string","blacklistingDate":"2024-01-01","blacklistingNarrative":"string","extensions":{}}},"responses":{"200":"CryptoAssetResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}}]},{"key":"reference-instruments-service-v3.0.0","title":"API for security instruments","version":"v3.0.0","description":"Allows the viewing of Instruments - Bonds, Equities, Futures, Options, Active IPOs,Funds and Crypto assets","endpointCount":22,"endpoints":[{"method":"GET","path":"/reference/instruments/initialPublicOfferings","fullPath":"/api/v3.0.0/reference/instruments/initialPublicOfferings","operationId":"getActiveIPOs","name":"Retrieves the initial offer IPO instruments filtered based on the instrument id, start and end date of the offering","summary":"Retrieves the intial public offerings","tags":["WEALTH"],"parameters":[{"name":"instrumentId","in":"query","type":"string","required":false,"description":"The identifier of the instrument"},{"name":"startDate","in":"query","type":"string","required":false,"description":"Beginning Date of IPO Subscription"},{"name":"endDate","in":"query","type":"string","required":false,"description":"Contains the end date of IPO subscription or amendment of earlier subscription"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"ActiveIPOsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/reference/instruments/bonds","fullPath":"/api/v3.0.0/reference/instruments/bonds","operationId":"getInstrumentsBonds","name":"Retrieves the bond instruments filtered based on the instrument id and instrument currency","summary":"Retrieves the bond instruments","tags":["WEALTH"],"parameters":[{"name":"instrumentId","in":"query","type":"string","required":false,"description":"The identifier of the instrument"},{"name":"instrumentCurrencyId","in":"query","type":"string","required":false,"description":"The currency of the instrument"},{"name":"mnemonic","in":"query","type":"string","required":false,"description":"Shortcut code for referring an Entity/Company/Branch."},{"name":"subAssetTypeId","in":"query","type":"string","required":false,"description":"Identifies the group of like Securities, which are reported together "},{"name":"priceType","in":"query","type":"string","required":false,"description":"Defines the method to be used when calculating the price of a trade"},{"name":"ISIN","in":"query","type":"string","required":false,"description":"The international securities identification number of the instrument"},{"name":"stockExchange","in":"query","type":"string","required":false,"description":"Contains the stock exchange details where a particular security is usually dealt"},{"name":"depositoryId","in":"query","type":"string","required":false,"description":"Id of the securities depository."},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"InstrumentsBondsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"POST","path":"/reference/instruments/bonds","fullPath":"/api/v3.0.0/reference/instruments/bonds","operationId":"createSecurityBond","name":"Creates the bond skeleton instrument","summary":"Creates the bond skeleton instrument","tags":["WEALTH"],"parameters":[{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"alternateInstrumentDetails":[{}],"displayName":"string","mnemonic":"string","ISIN":"string","subAssetTypeId":0.0,"currencyId":"string","depositoryId":0.0,"priceType":"string","lastPrice":0.0,"companyDomicile":"string","instrumentDomicile":"string","priceUpdateCode":"string","industryId":0.0,"stockExchange":"string","interestRate":0.0}},"responses":{"200":"SecurityBondResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/reference/instruments/shares","fullPath":"/api/v3.0.0/reference/instruments/shares","operationId":"getInstrumentShares","name":"Retrieves the share instruments filtered based on the instrument id and instrument currency","summary":"Retrieves the share instruments","tags":["WEALTH"],"parameters":[{"name":"instrumentId","in":"query","type":"string","required":false,"description":"The identifier of the instrument"},{"name":"instrumentCurrencyId","in":"query","type":"string","required":false,"description":"The currency of the instrument"},{"name":"mnemonic","in":"query","type":"string","required":false,"description":"Shortcut code for referring an Entity/Company/Branch."},{"name":"subAssetTypeId","in":"query","type":"string","required":false,"description":"Identifies the group of like Securities, which are reported together "},{"name":"priceType","in":"query","type":"string","required":false,"description":"Defines the method to be used when calculating the price of a trade"},{"name":"ISIN","in":"query","type":"string","required":false,"description":"The international securities identification number of the instrument"},{"name":"stockExchange","in":"query","type":"string","required":false,"description":"Contains the stock exchange details where a particular security is usually dealt"},{"name":"depositoryId","in":"query","type":"string","required":false,"description":"Id of the securities depository."},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"InstrumentSharesResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"POST","path":"/reference/instruments/shares","fullPath":"/api/v3.0.0/reference/instruments/shares","operationId":"createSecurityShare","name":"Creates the share skeleton instrument","summary":"Creates the share skeleton instrument","tags":["WEALTH"],"parameters":[{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"alternateInstrumentDetails":[{}],"minimumInvestmentDetails":[{}],"displayName":"string","mnemonic":"string","ISIN":"string","subAssetType":0.0,"currencyId":"string","depositoryId":0.0,"priceType":"string","lastPrice":0.0,"companyDomicile":"string","instrumentDomicile":"string","priceUpdateCode":"string","industryId":0.0,"stockExchange":"string"}},"responses":{"200":"SecurityShareResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/reference/instruments/futures","fullPath":"/api/v3.0.0/reference/instruments/futures","operationId":"getFutureContracts","name":"Retrieves the future type contracts filtered based on the contract code","summary":"Retrieves the derivatives futures","tags":["WEALTH"],"parameters":[{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"FutureContractsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/reference/instruments/options","fullPath":"/api/v3.0.0/reference/instruments/options","operationId":"getOptionContracts","name":"Retrieves the option type contracts filtered based on the contract code","summary":"Retrieves the derivatives options","tags":["WEALTH"],"parameters":[{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"OptionContractsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/reference/instruments/{instrumentId}/bonds","fullPath":"/api/v3.0.0/reference/instruments/{instrumentId}/bonds","operationId":"getSecurityBond","name":"Retrieves the bond skeleton instrument","summary":"Retrieves the bond skeleton instrument","tags":["WEALTH"],"parameters":[{"name":"instrumentId","in":"path","type":"string","required":true,"description":"The identifier of the instrument"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"SecurityBondResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/reference/instruments/{instrumentId}/shares","fullPath":"/api/v3.0.0/reference/instruments/{instrumentId}/shares","operationId":"getSecurityShare","name":"Retrieves the share skeleton instrument","summary":"Retrieves the share skeleton instrument","tags":["WEALTH"],"parameters":[{"name":"instrumentId","in":"path","type":"string","required":true,"description":"The identifier of the instrument"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"SecurityShareResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"POST","path":"/reference/instruments/structuredNotes","fullPath":"/api/v3.0.0/reference/instruments/structuredNotes","operationId":"createStructuredNotes","name":"Creates the structured notes instruments","summary":"Creates the structured notes instruments","tags":["WEALTH"],"parameters":[{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"alternateInstrumentDetails":[{}],"interestRates":[{}],"instrumentName":"string","ISIN":"string","structureNote":true,"subAssetTypeId":0.0,"currencyId":"string","priceType":"string","lastPrice":0.0,"companyDomicile":"string","instrumentDomicile":"string","priceUpdateCode":"string","industryId":0.0,"stockExchange":"string","issueDate":"2024-01-01"}},"responses":{"200":"StructuredNotesResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/reference/instruments/{instrumentId}/structuredNotes","fullPath":"/api/v3.0.0/reference/instruments/{instrumentId}/structuredNotes","operationId":"getStructuredNote","name":"Retrieves the structured notes instruments","summary":"Retrieves the structured notes instruments","tags":["WEALTH"],"parameters":[{"name":"instrumentId","in":"path","type":"string","required":true,"description":"The identifier of the instrument"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"StructuredNoteResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/reference/instruments/{instrumentId}/funds","fullPath":"/api/v3.0.0/reference/instruments/{instrumentId}/funds","operationId":"getFundInstrument","name":"Retrieves the fund security","summary":"Retrieves the fund security","tags":["WEALTH"],"parameters":[{"name":"instrumentId","in":"path","type":"string","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"FundInstrumentResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"POST","path":"/reference/instruments/funds","fullPath":"/api/v3.0.0/reference/instruments/funds","operationId":"createFundInstrument","name":"Creates the mutual fund instrument","summary":"Creates the fund security","tags":["WEALTH"],"parameters":[{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"alternateInstrumentDetails":[{}],"interestRates":[{}],"instrumentName":"string","ISIN":"string","structureNote":true,"subAssetTypeId":0.0,"currencyId":"string","priceType":"string","lastPrice":0.0,"companyDomicile":"string","instrumentDomicile":"string","priceUpdateCode":"string","industryId":"string","stockExchange":"string","issueDate":"2024-01-01"}},"responses":{"200":"FundInstrumentResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/reference/instruments","fullPath":"/api/v3.0.0/reference/instruments","operationId":"getInstruments","name":"Retrieves security instruments filtered based on instrument id, instrument name, security currency, ISIN and stock exchange","summary":"Retrieves security instruments such as shares, bonds and funds","tags":["WEALTH"],"parameters":[{"name":"instrumentId","in":"query","type":"string","required":false,"description":"The identifier of the instrument"},{"name":"instrumentName","in":"query","type":"string","required":false,"description":"The name that is displayed for the instrument, taken from the security master"},{"name":"instrumentCurrencyId","in":"query","type":"string","required":false,"description":"The currency of the instrument"},{"name":"mnemonic","in":"query","type":"string","required":false,"description":"Shortcut code for referring an Entity/Company/Branch."},{"name":"subAssetTypeId","in":"query","type":"string","required":false,"description":"Identifies the group of like Securities, which are reported together "},{"name":"priceType","in":"query","type":"string","required":false,"description":"Defines the method to be used when calculating the price of a trade"},{"name":"ISIN","in":"query","type":"string","required":false,"description":"The international securities identification number of the instrument"},{"name":"stockExchange","in":"query","type":"string","required":false,"description":"Contains the stock exchange details where a particular security is usually dealt"},{"name":"depositoryId","in":"query","type":"string","required":false,"description":"Id of the securities depository."},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"InstrumentsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"POST","path":"/reference/instruments","fullPath":"/api/v3.0.0/reference/instruments","operationId":"createInstrumentMaster","name":"Creates instrument master","summary":"Creates instrument master","tags":["WEALTH"],"parameters":[{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"alternateInstrumentDetails":[{}],"minimumInvestmentDetails":[{}],"probabilityOfDefaults":[{}],"displayName":"string","mnemonic":"string","ISIN":"string","subAssetTypeId":0.0,"currencyId":"string","depositoryId":0.0,"priceType":"string","instrumentType":"string","lastPrice":0.0,"companyDomicile":"string","instrumentDomicile":"string","priceUpdateCode":"string"}},"responses":{"200":"InstrumentMasterResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/reference/instruments/{id}/instrumentDetails","fullPath":"/api/v3.0.0/reference/instruments/{id}/instrumentDetails","operationId":"getInstrumentMaster","name":"Get instrument details for the instrument","summary":"Get instrument details for the instrument","tags":["WEALTH"],"parameters":[{"name":"id","in":"path","type":"string","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"InstrumentMasterResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/reference/instruments/{id}/instrumentDetails","fullPath":"/api/v3.0.0/reference/instruments/{id}/instrumentDetails","operationId":"updateInstrumentMaster","name":"Update instrument master details for the instrument","summary":"Update instrument details for the instrument","tags":["WEALTH"],"parameters":[{"name":"id","in":"path","type":"string","required":true,"description":"Contains the daily position class id."},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"alternateInstrumentDetails":[{}],"minimumInvestmentDetails":[{}],"probabilityOfDefaults":[{}],"displayName":"string","mnemonic":"string","ISIN":"string","subAssetTypeId":0.0,"currencyId":"string","depositoryId":0.0,"priceType":"string","instrumentType":"string","lastPrice":0.0,"companyDomicile":"string","instrumentDomicile":"string","priceUpdateCode":"string"}},"responses":{"200":"InstrumentMasterResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/reference/instruments/derivativeInstrument","fullPath":"/api/v3.0.0/reference/instruments/derivativeInstrument","operationId":"getDerivativesInstrument","name":"Retrieves derivative instruments filtered based on contract code, instrument name, maturity date,strike price and option type","summary":"Retrieves derivative instruments","tags":["WEALTH"],"parameters":[{"name":"instrumentId","in":"query","type":"string","required":false,"description":"The identifier of the instrument"},{"name":"contractId","in":"query","type":"string","required":false,"description":"Identifies the unique identifier of the transaction or contract."},{"name":"instrumentName","in":"query","type":"string","required":false,"description":"The name that is displayed for the instrument, taken from the security master"},{"name":"maturityDate","in":"query","type":"string","required":false,"description":"Indicates maturity date of the contract"},{"name":"strikePrice","in":"query","type":"string","required":false,"description":"The price at which the option holder has the right to buy (Call Options) or sell (Put Options) the underlying instrument, or to cash-settle the option if appropriate"},{"name":"callOrPut","in":"query","type":"string","required":false,"description":"Indicates whether the transaction is a call or put.  Allowed values: - CALL  - PUT"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"DerivativesInstrumentResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/reference/instruments/derivativeContractMaster","fullPath":"/api/v3.0.0/reference/instruments/derivativeContractMaster","operationId":"getDXContracts","name":"Retrieves derivative contracts filtered based on contract code, name and type of contract","summary":"Retrieves derivative contracts","tags":["WEALTH"],"parameters":[{"name":"contractId","in":"query","type":"string","required":false,"description":"Identifies the unique identifier of the transaction or contract."},{"name":"instrumentName","in":"query","type":"string","required":false,"description":"The name that is displayed for the instrument, taken from the security master"},{"name":"tradeType","in":"query","type":"string","required":false,"description":"The trade type"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"DXContractsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"POST","path":"/reference/instruments/cryptoAssets","fullPath":"/api/v3.0.0/reference/instruments/cryptoAssets","operationId":"createCryptoAsset","name":"Creates the crypto asset instrument","summary":"Creates the crypto asset instrument","tags":["WEALTH"],"parameters":[{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"alternateInstrumentDetails":[{}],"displayName":"string","mnemonic":"string","ISIN":"string","currencyId":"string","blockChainId":"string","lastPrice":0.0,"companyDomicile":"string","instrumentDomicile":"string","priceUpdateCode":"string","industryId":"string","stockExchange":"string","parValue":0.0,"tradingUnits":0.0,"brokerTradingUnits":0.0}},"responses":{"200":"CryptoAssetResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/reference/instruments/{id}/cryptoAssets","fullPath":"/api/v3.0.0/reference/instruments/{id}/cryptoAssets","operationId":"getCryptoAsset","name":"Retrieves instrument details of crypto asset","summary":"Retrieves instrument details for the  crypto asset","tags":["WEALTH"],"parameters":[{"name":"id","in":"path","type":"string","required":true,"description":"Contains the daily position class id."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"CryptoAssetResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/reference/instruments/{id}/cryptoAssets","fullPath":"/api/v3.0.0/reference/instruments/{id}/cryptoAssets","operationId":"updateCryptoAsset","name":"Update instrument details for the cryptoasset or blacklisting crypto asset","summary":"Update instrument details for the cryptoasset","tags":["WEALTH"],"parameters":[{"name":"id","in":"path","type":"string","required":true,"description":"Contains the daily position class id."},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"alternateInstrumentDetails":[{}],"displayName":"string","mnemonic":"string","ISIN":"string","currencyId":"string","blockChainId":"string","lastPrice":0.0,"companyDomicile":"string","instrumentDomicile":"string","priceUpdateCode":"string","industryId":"string","stockExchange":"string","parValue":0.0,"tradingUnits":0.0,"brokerTradingUnits":0.0}},"responses":{"200":"CryptoAssetResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}}]},{"key":"reference-interestBases-service-v1.0.0","title":"Interest Bases","version":"v1.0.0","description":"API to manage the interest day count bases that are available in the system to calculate or accrue Interest for asset or liability related transactions. For example A - 360/360, B - 366/360 or C - 366/366","endpointCount":5,"endpoints":[{"method":"GET","path":"/reference/interestBases","fullPath":"/api/v1.0.0/reference/interestBases","operationId":"getInterestBases","name":"Retrieves the interest bases information that is defined in the system","summary":"Retrieves the interest bases","tags":[],"parameters":[{"name":"interestBasisId","in":"query","type":"string","required":false,"description":"Interest basis identifier used in interest amount calculation. "},{"name":"displayName","in":"query","type":"string","required":false,"description":"Contains the name used for display or enrichment purposes"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from t24 on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"The identifier of the underlying Entity/Company/Branch."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"InterestBasesResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/reference/interestBases/{interestBasisId}","fullPath":"/api/v1.0.0/reference/interestBases/{interestBasisId}","operationId":"getInterestDayBasisDetails","name":"Retrieves the details such as description, interest componenets of the specified interest basis record ","summary":"Retrieves interest basis details","tags":[],"parameters":[{"name":"interestBasisId","in":"path","type":"string","required":true,"description":"Interest basis identifier used in interest amount calculation. "},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from t24 on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"The identifier of the underlying Entity/Company/Branch."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"InterestDayBasisDetailsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"POST","path":"/reference/interestBases/{interestBasisId}","fullPath":"/api/v1.0.0/reference/interestBases/{interestBasisId}","operationId":"createInterestDayBasis","name":"Creates the details such as description, interest components of the specified interest basis record ","summary":"Creates interest basis details","tags":[],"parameters":[{"name":"interestBasisId","in":"path","type":"string","required":true,"description":"Interest basis identifier used in interest amount calculation. "},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"The identifier of the underlying Entity/Company/Branch."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"interestBasisName":"string","interestBasis":"string"}},"responses":{"200":"InterestDayBasisResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/reference/interestBases/{interestBasisId}","fullPath":"/api/v1.0.0/reference/interestBases/{interestBasisId}","operationId":"updateInterestDayBasis","name":"Updates the details such as description, interest components of the specified interest basis record ","summary":"Updates interest basis details","tags":[],"parameters":[{"name":"interestBasisId","in":"path","type":"string","required":true,"description":"Interest basis identifier used in interest amount calculation. "},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"The identifier of the underlying Entity/Company/Branch."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"interestBasisName":"string","interestBasis":"string"}},"responses":{"200":"InterestDayBasisResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"DELETE","path":"/reference/interestBases/{interestBasisId}","fullPath":"/api/v1.0.0/reference/interestBases/{interestBasisId}","operationId":"deleteInterestDayBasis","name":"Deletes the details such as description, interest components of the specified interest basis record ","summary":"Deletes interest basis details","tags":[],"parameters":[{"name":"interestBasisId","in":"path","type":"string","required":true,"description":"Interest basis identifier used in interest amount calculation. "},{"name":"payload","in":"body","type":"object","required":false,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"The identifier of the underlying Entity/Company/Branch."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}}},"responses":{"200":"InterestDayBasisResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}}]},{"key":"reference-interestRates-service-v1.0.0","title":"Interest Rates","version":"v1.0.0","description":"API to retrieve the details of  Basic and Periodic Interest Rates, history of interest rate changes and base rate identifiers and associated descriptions available in the system.","endpointCount":17,"endpoints":[{"method":"GET","path":"/reference/rateTexts","fullPath":"/api/v1.0.0/reference/rateTexts","operationId":"getRateTexts","name":"Retrieves descriptions of the interest conditions","summary":"Retrieves details of interest conditions","tags":[],"parameters":[{"name":"rateTextId","in":"query","type":"string","required":false,"description":"The basic interest rate ID / name."},{"name":"displayName","in":"query","type":"string","required":false,"description":"Contains the name used for display or enrichment purposes"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from t24 on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"The identifier of the underlying Entity/Company/Branch."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"RateTextsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/reference/interestRates/{rateId}/floatingRates","fullPath":"/api/v1.0.0/reference/interestRates/{rateId}/floatingRates","operationId":"getBasicInterest","name":"Retrieves Interest rate and negative interest rate. Input rate Id format example - 1USD20001025; 1USD20101025 ","summary":"Retrieves basic interest rate","tags":[],"parameters":[{"name":"rateId","in":"path","type":"string","required":true,"description":"Identifies the periodic or floating interest rates"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"The identifier of the underlying Entity/Company/Branch."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"BasicInterestResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"POST","path":"/reference/interestRates/{rateId}/floatingRates","fullPath":"/api/v1.0.0/reference/interestRates/{rateId}/floatingRates","operationId":"createBasicInterest","name":"Creates basic interest rate record. Input rate Id format example - 1USD20001025; 1USD20101025 ","summary":"Creates basic interest rate record","tags":[],"parameters":[{"name":"rateId","in":"path","type":"string","required":true,"description":"Identifies the periodic or floating interest rates"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"The identifier of the underlying Entity/Company/Branch."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"interestRate":"string","negativeInterestRate":"string"}},"responses":{"200":"BasicInterestResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/reference/interestRates/{rateId}/floatingRates","fullPath":"/api/v1.0.0/reference/interestRates/{rateId}/floatingRates","operationId":"updateBasicInterest","name":"Updates Interest rate and negative interest rate. Input rate Id format example - 1USD20001025; 1USD20101025 ","summary":"Updates basic interest rate","tags":[],"parameters":[{"name":"rateId","in":"path","type":"string","required":true,"description":"Identifies the periodic or floating interest rates"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"The identifier of the underlying Entity/Company/Branch."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"interestRate":"string","negativeInterestRate":"string"}},"responses":{"200":"BasicInterestResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/reference/interestRates/{rateId}/floatingRates/dates","fullPath":"/api/v1.0.0/reference/interestRates/{rateId}/floatingRates/dates","operationId":"getBasicInterestChangeDates","name":"Retrieves the effective date of the floating rate interest. Input rate Id format example - 1USD; 2USD; 1EUR ","summary":"Retrieves effective date of floating rates","tags":[],"parameters":[{"name":"rateId","in":"path","type":"string","required":true,"description":"Identifies the periodic or floating interest rates"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from t24 on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"The identifier of the underlying Entity/Company/Branch."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"BasicInterestChangeDatesResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/reference/interestRates/dates/{date}/floatingRates","fullPath":"/api/v1.0.0/reference/interestRates/dates/{date}/floatingRates","operationId":"getBasicInterestRateChanges","name":"Retrieves currency, date and rates for the specified date ","summary":"Retrieves floating rates for a specified date","tags":[],"parameters":[{"name":"date","in":"path","type":"string","required":true,"description":"Indicates the date on which activity was performed"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"The identifier of the underlying Entity/Company/Branch."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"BasicInterestRateChangesResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/reference/interestRates/{rateId}/periodicRates","fullPath":"/api/v1.0.0/reference/interestRates/{rateId}/periodicRates","operationId":"getPeriodicInterest","name":"Retrieves details such as description, rest period,  rates, amount and history details. Input rate of format example - 01USD20091101; 01CAD20091101","summary":"Retrieves periodic interest details","tags":[],"parameters":[{"name":"rateId","in":"path","type":"string","required":true,"description":"Identifies the periodic or floating interest rates"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"The identifier of the underlying Entity/Company/Branch."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"PeriodicInterestResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"POST","path":"/reference/interestRates/{rateId}/periodicRates","fullPath":"/api/v1.0.0/reference/interestRates/{rateId}/periodicRates","operationId":"createPeriodicInterest","name":"Creates details such as description, rest period,  rates, amount and history details. Input rate of format example - 01USD20091101; 01CAD20091101","summary":"Creates periodic interest details","tags":[],"parameters":[{"name":"rateId","in":"path","type":"string","required":true,"description":"Identifies the periodic or floating interest rates"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"The identifier of the underlying Entity/Company/Branch."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"rateNames":[{}],"interestCondition":[{}],"spreadCalcuationRoutines":[{}],"negativeRateApplications":[{}],"updateHistory":[{}],"defaultMisRateId":"string","buildForwardRate":"string","tolerancePercentage":"string","maximumInterestRate":"string","useLastWorkingDay":"string","versionNumber":"string","allowAmount":"string"}},"responses":{"200":"PeriodicInterestResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/reference/interestRates/{rateId}/periodicRates","fullPath":"/api/v1.0.0/reference/interestRates/{rateId}/periodicRates","operationId":"updatePeriodicInterest","name":"Updates details such as description, rest period,  rates, amount and history details. Input rate of format example - 01USD20091101; 01CAD20091101","summary":"Updates periodic interest details","tags":[],"parameters":[{"name":"rateId","in":"path","type":"string","required":true,"description":"Identifies the periodic or floating interest rates"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"The identifier of the underlying Entity/Company/Branch."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"rateNames":[{}],"interestCondition":[{}],"spreadCalcuationRoutines":[{}],"negativeRateApplications":[{}],"updateHistory":[{}],"defaultMisRateId":"string","buildForwardRate":"string","tolerancePercentage":"string","maximumInterestRate":"string","useLastWorkingDay":"string","versionNumber":"string","allowAmount":"string"}},"responses":{"200":"PeriodicInterestResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/reference/interestRates/dates/{date}/periodicRates","fullPath":"/api/v1.0.0/reference/interestRates/dates/{date}/periodicRates","operationId":"getPeriodicRateChanges","name":"Retrieves periodic rate changes for a specified date","summary":"Retrieves periodic rates for a specified date","tags":[],"parameters":[{"name":"date","in":"path","type":"string","required":true,"description":"Indicates the date on which activity was performed"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from t24 on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"The identifier of the underlying Entity/Company/Branch."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"PeriodicRateChangesResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/reference/interestRates/{rateId}/floatingRates/names","fullPath":"/api/v1.0.0/reference/interestRates/{rateId}/floatingRates/names","operationId":"getBasicInterestName","name":"Retrieves floating rate description","summary":"Retrieves floating rate name","tags":[],"parameters":[{"name":"rateId","in":"path","type":"string","required":true,"description":"Identifies the periodic or floating interest rates"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"The identifier of the underlying Entity/Company/Branch."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"BasicInterestNameResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"POST","path":"/reference/interestRates/{rateId}/floatingRates/names","fullPath":"/api/v1.0.0/reference/interestRates/{rateId}/floatingRates/names","operationId":"createBasicInterestName","name":"Creates floating rate description","summary":"Creates floating rate name","tags":[],"parameters":[{"name":"rateId","in":"path","type":"string","required":true,"description":"Identifies the periodic or floating interest rates"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"The identifier of the underlying Entity/Company/Branch."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"rateNames":[{}]}},"responses":{"200":"BasicInterestNameResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/reference/interestRates/{rateId}/floatingRates/names","fullPath":"/api/v1.0.0/reference/interestRates/{rateId}/floatingRates/names","operationId":"updateBasicInterestName","name":"Updates floating rate description","summary":"Updates floating rate name","tags":[],"parameters":[{"name":"rateId","in":"path","type":"string","required":true,"description":"Identifies the periodic or floating interest rates"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"The identifier of the underlying Entity/Company/Branch."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"rateNames":[{}]}},"responses":{"200":"BasicInterestNameResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/reference/interestRates/{rateId}/periodicRates/names","fullPath":"/api/v1.0.0/reference/interestRates/{rateId}/periodicRates/names","operationId":"getPeriodicRateName","name":"Retrieves periodic rate description","summary":"Retrieves periodic rate name","tags":[],"parameters":[{"name":"rateId","in":"path","type":"string","required":true,"description":"Identifies the periodic or floating interest rates"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"The identifier of the underlying Entity/Company/Branch."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"PeriodicRateNameResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"POST","path":"/reference/interestRates/{rateId}/periodicRates/names","fullPath":"/api/v1.0.0/reference/interestRates/{rateId}/periodicRates/names","operationId":"createPeriodicRateName","name":"Creates periodic rate description","summary":"Creates periodic rate name","tags":[],"parameters":[{"name":"rateId","in":"path","type":"string","required":true,"description":"Identifies the periodic or floating interest rates"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"The identifier of the underlying Entity/Company/Branch."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"rateNames":[{}]}},"responses":{"200":"PeriodicRateNameResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/reference/interestRates/{rateId}/periodicRates/names","fullPath":"/api/v1.0.0/reference/interestRates/{rateId}/periodicRates/names","operationId":"updatePeriodicRateName","name":"Updates periodic rate description","summary":"Updates periodic rate name","tags":[],"parameters":[{"name":"rateId","in":"path","type":"string","required":true,"description":"Identifies the periodic or floating interest rates"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"The identifier of the underlying Entity/Company/Branch."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"rateNames":[{}]}},"responses":{"200":"PeriodicRateNameResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"DELETE","path":"/reference/interestRates/{rateId}/periodicRates/names","fullPath":"/api/v1.0.0/reference/interestRates/{rateId}/periodicRates/names","operationId":"deletePeriodicRateName","name":"Deletes periodic rate description","summary":"Deletes periodic rate name","tags":[],"parameters":[{"name":"rateId","in":"path","type":"string","required":true,"description":"Identifies the periodic or floating interest rates"},{"name":"payload","in":"body","type":"object","required":false,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"The identifier of the underlying Entity/Company/Branch."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}}},"responses":{"200":"PeriodicInterestResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}}]},{"key":"reference-interestRates-service-v1.1.0","title":"Interest Rates","version":"v1.1.0","description":"API to retrieve the details of  Basic and Periodic Interest Rates, history of interest rate changes and base rate identifiers and associated descriptions available in the system.","endpointCount":21,"endpoints":[{"method":"GET","path":"/reference/rateTexts","fullPath":"/api/v1.1.0/reference/rateTexts","operationId":"getRateTexts","name":"Retrieves descriptions of the interest conditions","summary":"Retrieves details of interest conditions","tags":[],"parameters":[{"name":"rateTextId","in":"query","type":"string","required":false,"description":"The basic interest rate ID / name."},{"name":"displayName","in":"query","type":"string","required":false,"description":"Contains the name used for display or enrichment purposes"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from t24 on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"The identifier of the underlying Entity/Company/Branch."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"RateTextsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/reference/interestRates/{rateId}/floatingRates","fullPath":"/api/v1.1.0/reference/interestRates/{rateId}/floatingRates","operationId":"getBasicInterest","name":"Retrieves Interest rate and negative interest rate. Input rate Id format example - 1USD20001025; 1USD20101025 ","summary":"Retrieves basic interest rate","tags":[],"parameters":[{"name":"rateId","in":"path","type":"string","required":true,"description":"Identifies the periodic or floating interest rates"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"The identifier of the underlying Entity/Company/Branch."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"BasicInterestResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"POST","path":"/reference/interestRates/{rateId}/floatingRates","fullPath":"/api/v1.1.0/reference/interestRates/{rateId}/floatingRates","operationId":"createBasicInterest","name":"Creates basic interest rate record. Input rate Id format example - 1USD20001025; 1USD20101025 ","summary":"Creates basic interest rate record","tags":[],"parameters":[{"name":"rateId","in":"path","type":"string","required":true,"description":"Identifies the periodic or floating interest rates"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"The identifier of the underlying Entity/Company/Branch."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"interestRate":"string","negativeInterestRate":"string"}},"responses":{"200":"BasicInterestResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/reference/interestRates/{rateId}/floatingRates","fullPath":"/api/v1.1.0/reference/interestRates/{rateId}/floatingRates","operationId":"updateBasicInterest","name":"Updates Interest rate and negative interest rate. Input rate Id format example - 1USD20001025; 1USD20101025 ","summary":"Updates basic interest rate","tags":[],"parameters":[{"name":"rateId","in":"path","type":"string","required":true,"description":"Identifies the periodic or floating interest rates"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"The identifier of the underlying Entity/Company/Branch."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"interestRate":"string","negativeInterestRate":"string"}},"responses":{"200":"BasicInterestResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/reference/interestRates/{rateId}/floatingRates/dates","fullPath":"/api/v1.1.0/reference/interestRates/{rateId}/floatingRates/dates","operationId":"getBasicInterestChangeDates","name":"Retrieves the effective date of the floating rate interest. Input rate Id format example - 1USD; 2USD; 1EUR ","summary":"Retrieves effective date of floating rates","tags":[],"parameters":[{"name":"rateId","in":"path","type":"string","required":true,"description":"Identifies the periodic or floating interest rates"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from t24 on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"The identifier of the underlying Entity/Company/Branch."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"BasicInterestChangeDatesResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/reference/interestRates/dates/{date}/floatingRates","fullPath":"/api/v1.1.0/reference/interestRates/dates/{date}/floatingRates","operationId":"getBasicInterestRateChanges","name":"Retrieves currency, date and rates for the specified date ","summary":"Retrieves floating rates for a specified date","tags":[],"parameters":[{"name":"date","in":"path","type":"string","required":true,"description":"Indicates the date on which activity was performed"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"The identifier of the underlying Entity/Company/Branch."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"BasicInterestRateChangesResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/reference/interestRates/{rateId}/periodicRates","fullPath":"/api/v1.1.0/reference/interestRates/{rateId}/periodicRates","operationId":"getPeriodicInterest","name":"Retrieves details such as description, rest period,  rates, amount and history details. Input rate of format example - 01USD20091101; 01CAD20091101","summary":"Retrieves periodic interest details","tags":[],"parameters":[{"name":"rateId","in":"path","type":"string","required":true,"description":"Identifies the periodic or floating interest rates"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"The identifier of the underlying Entity/Company/Branch."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"PeriodicInterestResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"POST","path":"/reference/interestRates/{rateId}/periodicRates","fullPath":"/api/v1.1.0/reference/interestRates/{rateId}/periodicRates","operationId":"createPeriodicInterest","name":"Creates details such as description, rest period,  rates, amount and history details. Input rate of format example - 01USD20091101; 01CAD20091101","summary":"Creates periodic interest details","tags":[],"parameters":[{"name":"rateId","in":"path","type":"string","required":true,"description":"Identifies the periodic or floating interest rates"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"The identifier of the underlying Entity/Company/Branch."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"rateNames":[{}],"interestCondition":[{}],"spreadCalcuationRoutines":[{}],"negativeRateApplications":[{}],"updateHistory":[{}],"defaultMisRateId":"string","buildForwardRate":"string","tolerancePercentage":"string","maximumInterestRate":"string","useLastWorkingDay":"string","versionNumber":"string","riskFreeRate":"string","receivedDate":"string"}},"responses":{"200":"PeriodicInterestResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/reference/interestRates/{rateId}/periodicRates","fullPath":"/api/v1.1.0/reference/interestRates/{rateId}/periodicRates","operationId":"updatePeriodicInterest","name":"Updates details such as description, rest period,  rates, amount and history details. Input rate of format example - 01USD20091101; 01CAD20091101","summary":"Updates periodic interest details","tags":[],"parameters":[{"name":"rateId","in":"path","type":"string","required":true,"description":"Identifies the periodic or floating interest rates"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"The identifier of the underlying Entity/Company/Branch."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"rateNames":[{}],"interestCondition":[{}],"spreadCalcuationRoutines":[{}],"negativeRateApplications":[{}],"updateHistory":[{}],"defaultMisRateId":"string","buildForwardRate":"string","tolerancePercentage":"string","maximumInterestRate":"string","useLastWorkingDay":"string","versionNumber":"string","riskFreeRate":"string","receivedDate":"string"}},"responses":{"200":"PeriodicInterestResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/reference/interestRates/dates/{date}/periodicRates","fullPath":"/api/v1.1.0/reference/interestRates/dates/{date}/periodicRates","operationId":"getPeriodicRateChanges","name":"Retrieves periodic rate changes for a specified date","summary":"Retrieves periodic rates for a specified date","tags":[],"parameters":[{"name":"date","in":"path","type":"string","required":true,"description":"Indicates the date on which activity was performed"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from t24 on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"The identifier of the underlying Entity/Company/Branch."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"PeriodicRateChangesResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/reference/interestRates/{rateId}/floatingRates/names","fullPath":"/api/v1.1.0/reference/interestRates/{rateId}/floatingRates/names","operationId":"getBasicInterestName","name":"Retrieves floating rate description","summary":"Retrieves floating rate name","tags":[],"parameters":[{"name":"rateId","in":"path","type":"string","required":true,"description":"Identifies the periodic or floating interest rates"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"The identifier of the underlying Entity/Company/Branch."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"BasicInterestNameResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"POST","path":"/reference/interestRates/{rateId}/floatingRates/names","fullPath":"/api/v1.1.0/reference/interestRates/{rateId}/floatingRates/names","operationId":"createBasicInterestName","name":"Creates floating rate description","summary":"Creates floating rate name","tags":[],"parameters":[{"name":"rateId","in":"path","type":"string","required":true,"description":"Identifies the periodic or floating interest rates"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"The identifier of the underlying Entity/Company/Branch."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"rateNames":[{}]}},"responses":{"200":"BasicInterestNameResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/reference/interestRates/{rateId}/floatingRates/names","fullPath":"/api/v1.1.0/reference/interestRates/{rateId}/floatingRates/names","operationId":"updateBasicInterestName","name":"Updates floating rate description","summary":"Updates floating rate name","tags":[],"parameters":[{"name":"rateId","in":"path","type":"string","required":true,"description":"Identifies the periodic or floating interest rates"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"The identifier of the underlying Entity/Company/Branch."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"rateNames":[{}]}},"responses":{"200":"BasicInterestNameResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/reference/interestRates/{rateId}/periodicRates/names","fullPath":"/api/v1.1.0/reference/interestRates/{rateId}/periodicRates/names","operationId":"getPeriodicRateName","name":"Retrieves periodic rate description","summary":"Retrieves periodic rate name","tags":[],"parameters":[{"name":"rateId","in":"path","type":"string","required":true,"description":"Identifies the periodic or floating interest rates"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"The identifier of the underlying Entity/Company/Branch."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"PeriodicRateNameResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"POST","path":"/reference/interestRates/{rateId}/periodicRates/names","fullPath":"/api/v1.1.0/reference/interestRates/{rateId}/periodicRates/names","operationId":"createPeriodicRateName","name":"Creates periodic rate description","summary":"Creates periodic rate name","tags":[],"parameters":[{"name":"rateId","in":"path","type":"string","required":true,"description":"Identifies the periodic or floating interest rates"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"The identifier of the underlying Entity/Company/Branch."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"rateNames":[{}],"allowAmount":"string"}},"responses":{"200":"PeriodicRateNameResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/reference/interestRates/{rateId}/periodicRates/names","fullPath":"/api/v1.1.0/reference/interestRates/{rateId}/periodicRates/names","operationId":"updatePeriodicRateName","name":"Updates periodic rate description","summary":"Updates periodic rate name","tags":[],"parameters":[{"name":"rateId","in":"path","type":"string","required":true,"description":"Identifies the periodic or floating interest rates"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"The identifier of the underlying Entity/Company/Branch."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"rateNames":[{}],"allowAmount":"string"}},"responses":{"200":"PeriodicRateNameResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"DELETE","path":"/reference/interestRates/{rateId}/periodicRates/names","fullPath":"/api/v1.1.0/reference/interestRates/{rateId}/periodicRates/names","operationId":"deletePeriodicRateName","name":"Deletes periodic rate description","summary":"Deletes periodic rate name","tags":[],"parameters":[{"name":"rateId","in":"path","type":"string","required":true,"description":"Identifies the periodic or floating interest rates"},{"name":"payload","in":"body","type":"object","required":false,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"The identifier of the underlying Entity/Company/Branch."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}}},"responses":{"200":"PeriodicInterestResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/reference/interestRates/{rateId}/marketRates/names","fullPath":"/api/v1.1.0/reference/interestRates/{rateId}/marketRates/names","operationId":"getMarketRateName","name":"The description of the tradeable interest rates, like LIBOR, SOFR etc. can be created and linked to the respective floating rate. The rate text/description should be a SWIFT code word. The endpoint is used to retrieve the Market rate text for the requested interest rate.","summary":"Retrieve the details of tradeable interest rates recognised by SWIFT","tags":[],"parameters":[{"name":"rateId","in":"path","type":"string","required":true,"description":"Identifies the periodic or floating interest rates"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"The identifier of the underlying Entity/Company/Branch."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"MarketRateNameResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"POST","path":"/reference/interestRates/{rateId}/marketRates/names","fullPath":"/api/v1.1.0/reference/interestRates/{rateId}/marketRates/names","operationId":"createMarketRateName","name":"The description of the tradeable interest rates, like LIBOR, SOFR etc. can be created and linked to the respective floating rate. The rate text/description should be a SWIFT code word. The endpoint is used to create the Market rate text for the tradeable interest rates recognized by SWIFT.","summary":"Create the description of tradeable interest rates recognized by SWIFT","tags":[],"parameters":[{"name":"rateId","in":"path","type":"string","required":true,"description":"Identifies the periodic or floating interest rates"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"The identifier of the underlying Entity/Company/Branch."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"displayNames":[{}],"rateTextName":"string","rateKey":"string","swiftCodeWord":"string"}},"responses":{"200":"MarketRateNameResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/reference/interestRates/{rateId}/marketRates/names","fullPath":"/api/v1.1.0/reference/interestRates/{rateId}/marketRates/names","operationId":"updateMarketRateName","name":"The description of the tradeable interest rates, like LIBOR, SOFR etc. can be created and linked to the respective floating rate. The rate text/description should be a SWIFT code word. The endpoint is used to update the Market rate text for the tradeable interest rates recognised by SWIFT.","summary":"Update the description of tradeable interest rates recognised by SWIFT","tags":[],"parameters":[{"name":"rateId","in":"path","type":"string","required":true,"description":"Identifies the periodic or floating interest rates"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"The identifier of the underlying Entity/Company/Branch."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"displayNames":[{}],"rateTextName":"string","rateKey":"string","swiftCodeWord":"string"}},"responses":{"200":"MarketRateNameResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"DELETE","path":"/reference/interestRates/{rateId}/marketRates/names","fullPath":"/api/v1.1.0/reference/interestRates/{rateId}/marketRates/names","operationId":"deleteMarketRateText","name":"Delete the details of tradeable interest rates recognized by SWIFT","summary":"Delete the details of tradeable interest rates recognized by SWIFT","tags":[],"parameters":[{"name":"rateId","in":"path","type":"string","required":true,"description":"Identifies the periodic or floating interest rates"},{"name":"payload","in":"body","type":"object","required":false,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"The identifier of the underlying Entity/Company/Branch."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}}},"responses":{"200":"MarketRateTextResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}}]},{"key":"reference-interestRates-service-v1.2.0","title":"Interest Rates","version":"v1.2.0","description":"API to retrieve the details of  Basic and Periodic Interest Rates, history of interest rate changes and base rate identifiers and associated descriptions available in the system.","endpointCount":21,"endpoints":[{"method":"GET","path":"/reference/rateTexts","fullPath":"/api/v1.2.0/reference/rateTexts","operationId":"getRateTexts","name":"Retrieves descriptions of the interest conditions","summary":"Retrieves details of interest conditions","tags":[],"parameters":[{"name":"rateTextId","in":"query","type":"string","required":false,"description":"The basic interest rate ID / name."},{"name":"displayName","in":"query","type":"string","required":false,"description":"Contains the name used for display or enrichment purposes"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from t24 on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"The identifier of the underlying Entity/Company/Branch."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"RateTextsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/reference/interestRates/{rateId}/floatingRates","fullPath":"/api/v1.2.0/reference/interestRates/{rateId}/floatingRates","operationId":"getBasicInterest","name":"Retrieves interest rate and negative interest rate. Input rate Id format example - 1USD20001025; 1USD20101025 ","summary":"Retrieves basic interest rate","tags":[],"parameters":[{"name":"rateId","in":"path","type":"string","required":true,"description":"Identifies the periodic or floating interest rates"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"The identifier of the underlying Entity/Company/Branch."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"BasicInterestResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"POST","path":"/reference/interestRates/{rateId}/floatingRates","fullPath":"/api/v1.2.0/reference/interestRates/{rateId}/floatingRates","operationId":"createBasicInterest","name":"Creates basic interest rate definitions. Input rate Id format example - 1USD20001025; 1USD20101025 ","summary":"Creates basic interest rate definitions","tags":[],"parameters":[{"name":"rateId","in":"path","type":"string","required":true,"description":"Identifies the periodic or floating interest rates"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"The identifier of the underlying Entity/Company/Branch."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"interestRate":"string","negativeInterestRate":"string"}},"responses":{"200":"BasicInterestResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/reference/interestRates/{rateId}/floatingRates","fullPath":"/api/v1.2.0/reference/interestRates/{rateId}/floatingRates","operationId":"updateBasicInterest","name":"Updates interest rate and negative interest rate. Input rate Id format example - 1USD20001025; 1USD20101025 ","summary":"Updates basic interest rate","tags":[],"parameters":[{"name":"rateId","in":"path","type":"string","required":true,"description":"Identifies the periodic or floating interest rates"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"The identifier of the underlying Entity/Company/Branch."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"interestRate":"string","negativeInterestRate":"string"}},"responses":{"200":"BasicInterestResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/reference/interestRates/dates/{date}/floatingRates","fullPath":"/api/v1.2.0/reference/interestRates/dates/{date}/floatingRates","operationId":"getBasicInterestRateChanges","name":"Retrieves currency, date and rates for the specified date ","summary":"Retrieves floating rates for a specified date","tags":[],"parameters":[{"name":"date","in":"path","type":"string","required":true,"description":"Indicates the date on which activity was performed"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"The identifier of the underlying Entity/Company/Branch."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"BasicInterestRateChangesResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/reference/interestRates/{rateId}/periodicRates","fullPath":"/api/v1.2.0/reference/interestRates/{rateId}/periodicRates","operationId":"getPeriodicInterest","name":"Retrieves details such as description, rest period,  rates, amount and history details. Input rate of format example - 01USD20091101; 01CAD20091101","summary":"Retrieves periodic interest details","tags":[],"parameters":[{"name":"rateId","in":"path","type":"string","required":true,"description":"Identifies the periodic or floating interest rates"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"The identifier of the underlying Entity/Company/Branch."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"PeriodicInterestResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"POST","path":"/reference/interestRates/{rateId}/periodicRates","fullPath":"/api/v1.2.0/reference/interestRates/{rateId}/periodicRates","operationId":"createPeriodicInterest","name":"Creates details such as description, rest period,  rates, amount and history details. Input rate of format example - 01USD20091101; 01CAD20091101","summary":"Creates periodic interest details","tags":[],"parameters":[{"name":"rateId","in":"path","type":"string","required":true,"description":"Identifies the periodic or floating interest rates"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"The identifier of the underlying Entity/Company/Branch."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"rateNames":[{}],"interestCondition":[{}],"spreadCalcuationRoutines":[{}],"negativeRateApplications":[{}],"updateHistory":[{}],"defaultMisRateId":"string","buildForwardRate":"string","tolerancePercentage":"string","maximumInterestRate":"string","useLastWorkingDay":"string","versionNumber":"string","riskFreeRate":"string","receivedDate":"string"}},"responses":{"200":"PeriodicInterestResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/reference/interestRates/{rateId}/periodicRates","fullPath":"/api/v1.2.0/reference/interestRates/{rateId}/periodicRates","operationId":"updatePeriodicInterest","name":"Updates details such as description, rest period,  rates, amount and history details. Input rate of format example - 01USD20091101; 01CAD20091101","summary":"Updates periodic interest details","tags":[],"parameters":[{"name":"rateId","in":"path","type":"string","required":true,"description":"Identifies the periodic or floating interest rates"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"The identifier of the underlying Entity/Company/Branch."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"rateNames":[{}],"interestCondition":[{}],"spreadCalcuationRoutines":[{}],"negativeRateApplications":[{}],"updateHistory":[{}],"defaultMisRateId":"string","buildForwardRate":"string","tolerancePercentage":"string","maximumInterestRate":"string","useLastWorkingDay":"string","versionNumber":"string","riskFreeRate":"string","receivedDate":"string"}},"responses":{"200":"PeriodicInterestResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/reference/interestRates/{rateId}/floatingRates/names","fullPath":"/api/v1.2.0/reference/interestRates/{rateId}/floatingRates/names","operationId":"getBasicInterestName","name":"Retrieves floating rate description","summary":"Retrieves floating rate name","tags":[],"parameters":[{"name":"rateId","in":"path","type":"string","required":true,"description":"Identifies the periodic or floating interest rates"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"The identifier of the underlying Entity/Company/Branch."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"BasicInterestNameResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"POST","path":"/reference/interestRates/{rateId}/floatingRates/names","fullPath":"/api/v1.2.0/reference/interestRates/{rateId}/floatingRates/names","operationId":"createBasicInterestName","name":"Creates floating rate description","summary":"Creates floating rate name","tags":[],"parameters":[{"name":"rateId","in":"path","type":"string","required":true,"description":"Identifies the periodic or floating interest rates"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"The identifier of the underlying Entity/Company/Branch."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"rateNames":[{}]}},"responses":{"200":"BasicInterestNameResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/reference/interestRates/{rateId}/floatingRates/names","fullPath":"/api/v1.2.0/reference/interestRates/{rateId}/floatingRates/names","operationId":"updateBasicInterestName","name":"Updates floating rate description","summary":"Updates floating rate name","tags":[],"parameters":[{"name":"rateId","in":"path","type":"string","required":true,"description":"Identifies the periodic or floating interest rates"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"The identifier of the underlying Entity/Company/Branch."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"rateNames":[{}]}},"responses":{"200":"BasicInterestNameResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/reference/interestRates/{rateId}/periodicRates/names","fullPath":"/api/v1.2.0/reference/interestRates/{rateId}/periodicRates/names","operationId":"getPeriodicRateName","name":"Retrieves periodic rate description","summary":"Retrieves periodic rate name","tags":[],"parameters":[{"name":"rateId","in":"path","type":"string","required":true,"description":"Identifies the periodic or floating interest rates"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"The identifier of the underlying Entity/Company/Branch."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"PeriodicRateNameResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"POST","path":"/reference/interestRates/{rateId}/periodicRates/names","fullPath":"/api/v1.2.0/reference/interestRates/{rateId}/periodicRates/names","operationId":"createPeriodicRateName","name":"Creates periodic rate description","summary":"Creates periodic rate name","tags":[],"parameters":[{"name":"rateId","in":"path","type":"string","required":true,"description":"Identifies the periodic or floating interest rates"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"The identifier of the underlying Entity/Company/Branch."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"rateNames":[{}],"allowAmount":"string"}},"responses":{"200":"PeriodicRateNameResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/reference/interestRates/{rateId}/periodicRates/names","fullPath":"/api/v1.2.0/reference/interestRates/{rateId}/periodicRates/names","operationId":"updatePeriodicRateName","name":"Updates periodic rate description","summary":"Updates periodic rate name","tags":[],"parameters":[{"name":"rateId","in":"path","type":"string","required":true,"description":"Identifies the periodic or floating interest rates"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"The identifier of the underlying Entity/Company/Branch."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"rateNames":[{}],"allowAmount":"string"}},"responses":{"200":"PeriodicRateNameResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"DELETE","path":"/reference/interestRates/{rateId}/periodicRates/names","fullPath":"/api/v1.2.0/reference/interestRates/{rateId}/periodicRates/names","operationId":"deletePeriodicRateName","name":"Deletes periodic rate description","summary":"Deletes periodic rate name","tags":[],"parameters":[{"name":"rateId","in":"path","type":"string","required":true,"description":"Identifies the periodic or floating interest rates"},{"name":"payload","in":"body","type":"object","required":false,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"The identifier of the underlying Entity/Company/Branch."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}}},"responses":{"200":"PeriodicRateNameResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/reference/interestRates/{rateId}/marketRates/names","fullPath":"/api/v1.2.0/reference/interestRates/{rateId}/marketRates/names","operationId":"getMarketRateName","name":"The description of the tradeable interest rates, like LIBOR, SOFR etc. can be created and linked to the respective floating rate. The rate text/description should be a SWIFT code word. The endpoint is used to retrieve the market rate text for the requested interest rate.","summary":"Retrieve the details of tradeable interest rates recognised by SWIFT","tags":[],"parameters":[{"name":"rateId","in":"path","type":"string","required":true,"description":"Identifies the periodic or floating interest rates"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"The identifier of the underlying Entity/Company/Branch."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"MarketRateNameResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"POST","path":"/reference/interestRates/{rateId}/marketRates/names","fullPath":"/api/v1.2.0/reference/interestRates/{rateId}/marketRates/names","operationId":"createMarketRateName","name":"The description of the tradeable interest rates, like LIBOR, SOFR etc. can be created and linked to the respective floating rate. The rate text/description should be a SWIFT code word. The endpoint is used to create the market rate text for the tradeable interest rates recognized by SWIFT.","summary":"Create the description of tradeable interest rates recognized by SWIFT","tags":[],"parameters":[{"name":"rateId","in":"path","type":"string","required":true,"description":"Identifies the periodic or floating interest rates"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"The identifier of the underlying Entity/Company/Branch."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"displayNames":[{}],"rateTextName":"string","rateKey":"string","swiftCodeWord":"string"}},"responses":{"200":"MarketRateNameResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/reference/interestRates/{rateId}/marketRates/names","fullPath":"/api/v1.2.0/reference/interestRates/{rateId}/marketRates/names","operationId":"updateMarketRateName","name":"The description of the tradeable interest rates, like LIBOR, SOFR etc. can be created and linked to the respective floating rate. The rate text/description should be a SWIFT code word. The endpoint is used to update the market rate text for the tradeable interest rates recognised by SWIFT.","summary":"Update the description of tradeable interest rates recognised by SWIFT","tags":[],"parameters":[{"name":"rateId","in":"path","type":"string","required":true,"description":"Identifies the periodic or floating interest rates"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"The identifier of the underlying Entity/Company/Branch."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"displayNames":[{}],"rateTextName":"string","rateKey":"string","swiftCodeWord":"string"}},"responses":{"200":"MarketRateNameResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"DELETE","path":"/reference/interestRates/{rateId}/marketRates/names","fullPath":"/api/v1.2.0/reference/interestRates/{rateId}/marketRates/names","operationId":"deleteMarketRateText","name":"Delete the details of tradeable interest rates recognized by SWIFT","summary":"Delete the details of tradeable interest rates recognized by SWIFT","tags":[],"parameters":[{"name":"rateId","in":"path","type":"string","required":true,"description":"Identifies the periodic or floating interest rates"},{"name":"payload","in":"body","type":"object","required":false,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"The identifier of the underlying Entity/Company/Branch."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}}},"responses":{"200":"MarketRateTextResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/reference/interestRates/{rateId}/floatingRates/dates","fullPath":"/api/v1.2.0/reference/interestRates/{rateId}/floatingRates/dates","operationId":"getBasicInterestChangeDates","name":"Retrieves the effective date of the floating rate interest. Input rate Id format example - 1USD; 2USD; 1EUR ","summary":"Retrieves effective date of floating rates","tags":[],"parameters":[{"name":"rateId","in":"path","type":"string","required":true,"description":"Identifies the periodic or floating interest rates"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"The identifier of the underlying Entity/Company/Branch."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"BasicInterestChangeDatesResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/reference/interestRates/dates/{date}/periodicRates","fullPath":"/api/v1.2.0/reference/interestRates/dates/{date}/periodicRates","operationId":"getPeriodicRateChanges","name":"Retrieves periodic rate changes for a specified date","summary":"Retrieves periodic rates for a specified date","tags":[],"parameters":[{"name":"date","in":"path","type":"string","required":true,"description":"Indicates the date on which activity was performed"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"The identifier of the underlying Entity/Company/Branch."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"PeriodicRateChangesResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}}]},{"key":"reference-interestRates-service-v1.3.0","title":"Interest Rates","version":"v1.3.0","description":"API to retrieve the details of  Basic and Periodic Interest Rates, history of interest rate changes and base rate identifiers and associated descriptions available in the system.","endpointCount":22,"endpoints":[{"method":"GET","path":"/reference/rateTexts","fullPath":"/api/v1.3.0/reference/rateTexts","operationId":"getRateTexts","name":"Retrieves descriptions of the interest conditions","summary":"Retrieves details of interest conditions","tags":[],"parameters":[{"name":"rateTextId","in":"query","type":"string","required":false,"description":"The basic interest rate ID / name."},{"name":"displayName","in":"query","type":"string","required":false,"description":"Contains the name used for display or enrichment purposes"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from t24 on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"RateTextsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/reference/interestRates/{rateId}/floatingRates","fullPath":"/api/v1.3.0/reference/interestRates/{rateId}/floatingRates","operationId":"getBasicInterest","name":"Retrieves interest rate and negative interest rate. Input rate Id format example - 1USD20001025; 1USD20101025 ","summary":"Retrieves basic interest rate","tags":[],"parameters":[{"name":"rateId","in":"path","type":"string","required":true,"description":"Identifies the periodic or floating interest rates"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"BasicInterestResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"POST","path":"/reference/interestRates/{rateId}/floatingRates","fullPath":"/api/v1.3.0/reference/interestRates/{rateId}/floatingRates","operationId":"createBasicInterest","name":"Creates basic interest rate definitions. Input rate Id format example - 1USD20001025; 1USD20101025 ","summary":"Creates basic interest rate definitions","tags":[],"parameters":[{"name":"rateId","in":"path","type":"string","required":true,"description":"Identifies the periodic or floating interest rates"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"interestRate":"string","negativeInterestRate":"string","extensions":{}}},"responses":{"200":"BasicInterestResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/reference/interestRates/{rateId}/floatingRates","fullPath":"/api/v1.3.0/reference/interestRates/{rateId}/floatingRates","operationId":"updateBasicInterest","name":"Updates interest rate and negative interest rate. Input rate Id format example - 1USD20001025; 1USD20101025 ","summary":"Updates basic interest rate","tags":[],"parameters":[{"name":"rateId","in":"path","type":"string","required":true,"description":"Identifies the periodic or floating interest rates"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"interestRate":"string","negativeInterestRate":"string","extensions":{}}},"responses":{"200":"BasicInterestResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/reference/interestRates/dates/{date}/floatingRates","fullPath":"/api/v1.3.0/reference/interestRates/dates/{date}/floatingRates","operationId":"getBasicInterestRateChanges","name":"Retrieves currency, date and rates for the specified date ","summary":"Retrieves floating rates for a specified date","tags":[],"parameters":[{"name":"date","in":"path","type":"string","required":true,"description":"Indicates the date on which activity was performed"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"BasicInterestRateChangesResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/reference/interestRates/{rateId}/periodicRates","fullPath":"/api/v1.3.0/reference/interestRates/{rateId}/periodicRates","operationId":"getPeriodicInterest","name":"Retrieves details such as description, rest period,  rates, amount and history details. Input rate of format example - 01USD20091101; 01CAD20091101","summary":"Retrieves periodic interest details","tags":[],"parameters":[{"name":"rateId","in":"path","type":"string","required":true,"description":"Identifies the periodic or floating interest rates"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"PeriodicInterestResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"POST","path":"/reference/interestRates/{rateId}/periodicRates","fullPath":"/api/v1.3.0/reference/interestRates/{rateId}/periodicRates","operationId":"createPeriodicInterest","name":"Creates details such as description, rest period,  rates, amount and history details. Input rate of format example - 01USD20091101; 01CAD20091101","summary":"Creates periodic interest details","tags":[],"parameters":[{"name":"rateId","in":"path","type":"string","required":true,"description":"Identifies the periodic or floating interest rates"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"rateNames":[{}],"interestCondition":[{}],"spreadCalcuationRoutines":[{}],"negativeRateApplications":[{}],"updateHistory":[{}],"defaultMisRateId":"string","buildForwardRate":"string","tolerancePercentage":"string","maximumInterestRate":"string","useLastWorkingDay":"string","versionNumber":"string","riskFreeRate":"string","receivedDate":"string","extensions":{}}},"responses":{"200":"PeriodicInterestResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/reference/interestRates/{rateId}/periodicRates","fullPath":"/api/v1.3.0/reference/interestRates/{rateId}/periodicRates","operationId":"updatePeriodicInterest","name":"Updates details such as description, rest period,  rates, amount and history details. Input rate of format example - 01USD20091101; 01CAD20091101","summary":"Updates periodic interest details","tags":[],"parameters":[{"name":"rateId","in":"path","type":"string","required":true,"description":"Identifies the periodic or floating interest rates"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"rateNames":[{}],"interestCondition":[{}],"spreadCalcuationRoutines":[{}],"negativeRateApplications":[{}],"updateHistory":[{}],"defaultMisRateId":"string","buildForwardRate":"string","tolerancePercentage":"string","maximumInterestRate":"string","useLastWorkingDay":"string","versionNumber":"string","riskFreeRate":"string","receivedDate":"string","extensions":{}}},"responses":{"200":"PeriodicInterestResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/reference/interestRates/{rateId}/floatingRates/names","fullPath":"/api/v1.3.0/reference/interestRates/{rateId}/floatingRates/names","operationId":"getBasicInterestName","name":"Retrieves the floating rate name for a basic interest rate with detail such as rate name.","summary":"Retrieves floating rate name of a basic interest rate","tags":[],"parameters":[{"name":"rateId","in":"path","type":"string","required":true,"description":"Identifies the periodic or floating interest rates"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"BasicInterestNameResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"POST","path":"/reference/interestRates/{rateId}/floatingRates/names","fullPath":"/api/v1.3.0/reference/interestRates/{rateId}/floatingRates/names","operationId":"createBasicInterestName","name":"Creates the floating rate name for a basic interest rate with detail such as rate name.","summary":"Creates floating rate name of a basic interest rate","tags":[],"parameters":[{"name":"rateId","in":"path","type":"string","required":true,"description":"Identifies the periodic or floating interest rates"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"rateNames":[{}],"extensions":{}}},"responses":{"200":"BasicInterestNameResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/reference/interestRates/{rateId}/floatingRates/names","fullPath":"/api/v1.3.0/reference/interestRates/{rateId}/floatingRates/names","operationId":"updateBasicInterestName","name":"Updates the floating rate name for a basic interest rate with detail such as rate name.","summary":"Updates floating rate name","tags":[],"parameters":[{"name":"rateId","in":"path","type":"string","required":true,"description":"Identifies the periodic or floating interest rates"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"rateNames":[{}],"extensions":{}}},"responses":{"200":"BasicInterestNameResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/reference/interestRates/{rateId}/periodicRates/names","fullPath":"/api/v1.3.0/reference/interestRates/{rateId}/periodicRates/names","operationId":"getPeriodicRateName","name":"Retrieves the periodic rate name for a periodic interest rate with details such as rate name and allow amount indicator.","summary":"Retrieves periodic rate name of a periodic interest rate","tags":[],"parameters":[{"name":"rateId","in":"path","type":"string","required":true,"description":"Identifies the periodic or floating interest rates"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"PeriodicRateNameResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"POST","path":"/reference/interestRates/{rateId}/periodicRates/names","fullPath":"/api/v1.3.0/reference/interestRates/{rateId}/periodicRates/names","operationId":"createPeriodicRateName","name":"Creates the periodic rate name for a periodic interest rate with details such as rate name and allow amount indicator.","summary":"Creates periodic rate name of a periodic interest rate","tags":[],"parameters":[{"name":"rateId","in":"path","type":"string","required":true,"description":"Identifies the periodic or floating interest rates"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"rateNames":[{}],"allowAmount":"string","extensions":{}}},"responses":{"200":"PeriodicRateNameResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/reference/interestRates/{rateId}/periodicRates/names","fullPath":"/api/v1.3.0/reference/interestRates/{rateId}/periodicRates/names","operationId":"updatePeriodicRateName","name":"Updates the periodic rate name for a periodic interest rate with details such as rate name and allow amount indicator.","summary":"Updates periodic rate name of a periodic interest rate.","tags":[],"parameters":[{"name":"rateId","in":"path","type":"string","required":true,"description":"Identifies the periodic or floating interest rates"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"rateNames":[{}],"allowAmount":"string","extensions":{}}},"responses":{"200":"PeriodicRateNameResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"DELETE","path":"/reference/interestRates/{rateId}/periodicRates/names","fullPath":"/api/v1.3.0/reference/interestRates/{rateId}/periodicRates/names","operationId":"deletePeriodicRateName","name":"Deletes the periodic rate name of a periodic interest rate.","summary":"Deletes periodic rate name","tags":[],"parameters":[{"name":"rateId","in":"path","type":"string","required":true,"description":"Identifies the periodic or floating interest rates"},{"name":"payload","in":"body","type":"object","required":false,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}}},"responses":{"200":"PeriodicRateNameResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/reference/interestRates/{rateId}/marketRates/names","fullPath":"/api/v1.3.0/reference/interestRates/{rateId}/marketRates/names","operationId":"getMarketRateName","name":"The description of the tradeable interest rates, like LIBOR, SOFR etc. can be created and linked to the respective floating rate. The rate text/description should be a SWIFT code word. The endpoint is used to retrieve the market rate text for the requested interest rate.","summary":"Retrieve the details of tradeable interest rates recognised by SWIFT","tags":[],"parameters":[{"name":"rateId","in":"path","type":"string","required":true,"description":"Identifies the periodic or floating interest rates"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"MarketRateNameResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"POST","path":"/reference/interestRates/{rateId}/marketRates/names","fullPath":"/api/v1.3.0/reference/interestRates/{rateId}/marketRates/names","operationId":"createMarketRateName","name":"The description of the tradeable interest rates, like LIBOR, SOFR etc. can be created and linked to the respective floating rate. The rate text/description should be a SWIFT code word. The endpoint is used to create the market rate text for the tradeable interest rates recognized by SWIFT.","summary":"Create the description of tradeable interest rates recognized by SWIFT","tags":[],"parameters":[{"name":"rateId","in":"path","type":"string","required":true,"description":"Identifies the periodic or floating interest rates"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"displayNames":[{}],"rateTextName":"string","rateKey":"string","swiftCodeWord":"string","extensions":{}}},"responses":{"200":"MarketRateNameResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/reference/interestRates/{rateId}/marketRates/names","fullPath":"/api/v1.3.0/reference/interestRates/{rateId}/marketRates/names","operationId":"updateMarketRateName","name":"The description of the tradeable interest rates, like LIBOR, SOFR etc. can be created and linked to the respective floating rate. The rate text/description should be a SWIFT code word. The endpoint is used to update the market rate text for the tradeable interest rates recognised by SWIFT.","summary":"Update the description of tradeable interest rates recognised by SWIFT","tags":[],"parameters":[{"name":"rateId","in":"path","type":"string","required":true,"description":"Identifies the periodic or floating interest rates"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"displayNames":[{}],"rateTextName":"string","rateKey":"string","swiftCodeWord":"string","extensions":{}}},"responses":{"200":"MarketRateNameResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"DELETE","path":"/reference/interestRates/{rateId}/marketRates/names","fullPath":"/api/v1.3.0/reference/interestRates/{rateId}/marketRates/names","operationId":"deleteMarketRateText","name":"Delete the details of tradeable interest rates recognised by SWIFT","summary":"Delete the details of tradeable interest rates recognised by SWIFT","tags":[],"parameters":[{"name":"rateId","in":"path","type":"string","required":true,"description":"Identifies the periodic or floating interest rates"},{"name":"payload","in":"body","type":"object","required":false,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}}},"responses":{"200":"MarketRateTextResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/reference/interestRates/{rateId}/floatingRates/dates","fullPath":"/api/v1.3.0/reference/interestRates/{rateId}/floatingRates/dates","operationId":"getBasicInterestChangeDates","name":"Retrieves the effective date of the floating rate interest. Input rate Id format example - 1USD; 2USD; 1EUR ","summary":"Retrieves effective date of floating rates","tags":[],"parameters":[{"name":"rateId","in":"path","type":"string","required":true,"description":"Identifies the periodic or floating interest rates"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"BasicInterestChangeDatesResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/reference/interestRates/dates/{date}/periodicRates","fullPath":"/api/v1.3.0/reference/interestRates/dates/{date}/periodicRates","operationId":"getPeriodicRateChanges","name":"Retrieves periodic rate changes for a specified date","summary":"Retrieves periodic rates for a specified date","tags":[],"parameters":[{"name":"date","in":"path","type":"string","required":true,"description":"Indicates the date on which activity was performed"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"PeriodicRateChangesResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/reference/interestRates/periodicRates","fullPath":"/api/v1.3.0/reference/interestRates/periodicRates","operationId":"getPeriodicRateNames","name":"Retrieves list of the periodic interests with details such as description, rest period, rates, amount and history details. Input rate of format example - 01USD20091101; 01CAD20091101","summary":"Retrieves list of the periodic interests","tags":[],"parameters":[{"name":"rateId","in":"query","type":"string","required":false,"description":"Identifies the periodic or floating interest rates"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"PeriodicRateNamesResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}}]},{"key":"reference-lookups-service-v1.0.0","title":"Lookup tables","version":"v1.0.0","description":"Retrieval of lookup tables","endpointCount":1,"endpoints":[{"method":"GET","path":"/reference/lookups","fullPath":"/api/v1.0.0/reference/lookups","operationId":"getEbLookups","name":"Retrieves system reference table details","summary":"Retrieves the list of records/attributes from system reference tables","tags":[],"parameters":[{"name":"virtualTableName","in":"query","type":"string","required":false,"description":"Contains the name of the virtual table used to retrieve lookup details."},{"name":"otherInfo","in":"query","type":"string","required":false,"description":"Contains the other information about the lookup."},{"name":"otherInfoNE","in":"query","type":"string","required":false,"description":"Specifies the not equals selection for other information."},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"EbLookupsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}}]},{"key":"reference-nationalIds-v1.0.0","title":"Swift Reference Data","version":"v1.0.0","description":"API to retrieve variety of information in relation to financial institutions such as the National Identifier (nationalId) codes, Legal Entity Identifier (LEI) details and Global Payment Initiative (GPI) participant details. LEIs are identification codes that enable consistent and accurate identifica","endpointCount":6,"endpoints":[{"method":"GET","path":"/reference/bankCodes/leis/{leiId}/bic","fullPath":"/api/v1.0.0/reference/bankCodes/leis/{leiId}/bic","operationId":"getBICFromLEI","name":"Retrieves the Bank Identifier Code (BIC) of the requested Bank's legal entity identifier. The BIC is the SWIFT Address assigned to a bank in order to send automated payments to the banks concerned. It uniquely identifies the name and country of the bank and consists of 8-11 characters. Example format AAAABBCCDDD, where AAAA: 4 character bank code, BB: 2 character country code, CC: 2 character location code, DDD: optional 3 character branch code.","summary":"Retrieves the BIC code of the requested Bank's legal entity identifier","tags":[],"parameters":[{"name":"leiId","in":"path","type":"string","required":true,"description":""},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from t24 on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"The identifier of the underlying Entity/Company/Branch."}],"requestBodyExample":null,"responses":{"200":"BICFromLEIResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/reference/bankCodes/nationalIds/{nationalIdRef}/bics","fullPath":"/api/v1.0.0/reference/bankCodes/nationalIds/{nationalIdRef}/bics","operationId":"getBICsFromNationalId","name":"Retrieves the Bank Identifier Code (BIC) or BICs for a given national ID with its country code or scheme. The BIC is the SWIFT Address assigned to a bank in order to send automated payments to the banks concerned. It uniquely identifies the name and country of the bank and consists of 8-11 characters. Example format AAAABBCCDDD, where AAAA: 4 character bank code, BB: 2 character country code, CC: 2 character location code, DDD: optional 3 character branch code.","summary":"Retrieves the BIC or BICs for a given national ID with its country code or scheme.","tags":[],"parameters":[{"name":"nationalIdRef","in":"path","type":"string","required":true,"description":""},{"name":"countryId","in":"query","type":"string","required":false,"description":"ISO country code of the financial institution. "},{"name":"scheme","in":"query","type":"string","required":false,"description":"Represents the scheme (a synonym for the National ID type) under which the National ID is defined"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from t24 on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"The identifier of the underlying Entity/Company/Branch."}],"requestBodyExample":null,"responses":{"200":"BICsFromNationalIdResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/reference/bankCodes/nationalIds/{nationalIdRef}","fullPath":"/api/v1.0.0/reference/bankCodes/nationalIds/{nationalIdRef}","operationId":"getNationalIdDetails","name":"Retrieves the details of the given national ID, that is the bank name or business name, and the address.","summary":"Retrieves the details of the given national ID","tags":[],"parameters":[{"name":"nationalIdRef","in":"path","type":"string","required":true,"description":""},{"name":"countryId","in":"query","type":"string","required":false,"description":"ISO country code of the financial institution. "},{"name":"scheme","in":"query","type":"string","required":false,"description":"Represents the scheme (a synonym for the National ID type) under which the National ID is defined"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from t24 on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"The identifier of the underlying Entity/Company/Branch."}],"requestBodyExample":null,"responses":{"200":"NationalIdDetailsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/reference/bankCodes/bics/{bicId}/nationalIds","fullPath":"/api/v1.0.0/reference/bankCodes/bics/{bicId}/nationalIds","operationId":"getNationalIdsFromBic","name":"Retrieves the national ID, the country code, and the code type for the specified Bank Identifier Code (BIC). If the BIC is linked to multiple national IDs, then multiple results can be returned. The BIC is the SWIFT Address assigned to a bank in order to send automated payments to the banks concerned. It uniquely identifies the name and country of the bank and consists of 8-11 characters. Example format AAAABBCCDDD, where AAAA: 4 character bank code, BB: 2 character country code, CC: 2 character","summary":"Retrieves national IDs for a BIC","tags":[],"parameters":[{"name":"bicId","in":"path","type":"string","required":true,"description":"Bank Identifier Code (BIC) of the Beneficiary bank."},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from t24 on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"The identifier of the underlying Entity/Company/Branch."}],"requestBodyExample":null,"responses":{"200":"NationalIdsFromBicResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/reference/bankCodes/nationalIds/{nationalIdRef}/validity","fullPath":"/api/v1.0.0/reference/bankCodes/nationalIds/{nationalIdRef}/validity","operationId":"validateNationalId","name":"Retrieves the status on the validity of the national ID, returns YES if the given national ID is valid","summary":"Retrieves the status on the validity of the given national ID","tags":[],"parameters":[{"name":"nationalIdRef","in":"path","type":"string","required":true,"description":""},{"name":"countryId","in":"query","type":"string","required":false,"description":"ISO country code of the financial institution. "},{"name":"scheme","in":"query","type":"string","required":false,"description":"Represents the scheme (a synonym for the National ID type) under which the National ID is defined"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from t24 on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"The identifier of the underlying Entity/Company/Branch."}],"requestBodyExample":null,"responses":{"200":"NationalIdResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/reference/bankCodes/gpi/participants/{participantId}","fullPath":"/api/v1.0.0/reference/bankCodes/gpi/participants/{participantId}","operationId":"getParticipantDetails","name":"Retrieves the details of the participant from the Swift Global Payment Initiative (GPI) participant directory","summary":"Retrieves GPI participant information","tags":[],"parameters":[{"name":"participantId","in":"path","type":"string","required":true,"description":"Process Workflow Participant ID"},{"name":"countryId","in":"query","type":"string","required":true,"description":"ISO country code of the financial institution. "},{"name":"currencyCode","in":"query","type":"string","required":true,"description":"ISO Currency code, accepted in field 32A of incoming gpi MT 103 payment by the participant ID or by the gpi intermediary through which the participant can be reached for this currency"},{"name":"requestDate","in":"query","type":"string","required":false,"description":"Date on which the client's request to be classified as professional has been received."},{"name":"channelType","in":"query","type":"string","required":false,"description":"Indicates the type of the Reachable Through channel"},{"name":"reachableThrough","in":"query","type":"string","required":false,"description":"Channel through which the participant is reachable for Global Payment Initiative (GPI) payment instructions for one of its GPI currencies"},{"name":"actAsIntermediary","in":"query","type":"string","required":false,"description":"Flag specifying whether the participant acts as the Global Payment Initiative (GPI) Intermediary Agent for GPI payments in a given currency and over a given REACHABLE THROUGH channel. Y indicates that"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from t24 on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"The identifier of the underlying Entity/Company/Branch."}],"requestBodyExample":null,"responses":{"200":"ParticipantDetailsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}}]},{"key":"reference-nationalIds-v1.1.0","title":"Swift Reference Data","version":"v1.1.0","description":"API to retrieve variety of information in relation to financial institutions such as the National Identifier (nationalId) codes, Legal Entity Identifier (LEI) details and Global Payment Initiative (GPI) participant details. LEIs are identification codes that enable consistent and accurate identifica","endpointCount":10,"endpoints":[{"method":"GET","path":"/reference/bankCodes/leis/{leiId}/bic","fullPath":"/api/v1.1.0/reference/bankCodes/leis/{leiId}/bic","operationId":"getBICFromLEI","name":"Retrieves the Bank Identifier Code (BIC) of the requested Bank's legal entity identifier. The BIC is the SWIFT Address assigned to a bank in order to send automated payments to the banks concerned. It uniquely identifies the name and country of the bank and consists of 8-11 characters. Example format AAAABBCCDDD, where AAAA: 4 character bank code, BB: 2 character country code, CC: 2 character location code, DDD: optional 3 character branch code.","summary":"Retrieves the BIC code of the requested Bank's legal entity identifier","tags":[],"parameters":[{"name":"leiId","in":"path","type":"string","required":true,"description":"Identifier of the legal entity reference"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from t24 on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"The identifier of the underlying Entity/Company/Branch."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"BICFromLEIResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/reference/bankCodes/nationalIds/{nationalIdRef}/bics","fullPath":"/api/v1.1.0/reference/bankCodes/nationalIds/{nationalIdRef}/bics","operationId":"getBICsFromNationalId","name":"Retrieves the Bank Identifier Code (BIC) or BICs for a given national ID with its country code or scheme. The BIC is the SWIFT Address assigned to a bank in order to send automated payments to the banks concerned. It uniquely identifies the name and country of the bank and consists of 8-11 characters. Example format AAAABBCCDDD, where AAAA: 4 character bank code, BB: 2 character country code, CC: 2 character location code, DDD: optional 3 character branch code.","summary":"Retrieves the BIC or BICs for a given national ID with its country code or scheme.","tags":[],"parameters":[{"name":"nationalIdRef","in":"path","type":"string","required":true,"description":"Indicates national indentifier reference"},{"name":"countryId","in":"query","type":"string","required":false,"description":"ISO country code of the financial institution. "},{"name":"scheme","in":"query","type":"string","required":false,"description":"Represents the scheme (a synonym for the National ID type) under which the National ID is defined"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from t24 on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"The identifier of the underlying Entity/Company/Branch."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"BICsFromNationalIdResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/reference/bankCodes/nationalIds/{nationalIdRef}","fullPath":"/api/v1.1.0/reference/bankCodes/nationalIds/{nationalIdRef}","operationId":"getNationalIdDetails","name":"Retrieves the details of the given national ID, that is the bank name or business name, and the address.","summary":"Retrieves the details of the given national ID","tags":[],"parameters":[{"name":"nationalIdRef","in":"path","type":"string","required":true,"description":"Indicates national indentifier reference"},{"name":"countryId","in":"query","type":"string","required":false,"description":"ISO country code of the financial institution. "},{"name":"scheme","in":"query","type":"string","required":false,"description":"Represents the scheme (a synonym for the National ID type) under which the National ID is defined"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from t24 on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"The identifier of the underlying Entity/Company/Branch."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"NationalIdDetailsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/reference/bankCodes/bics/{bicId}/nationalIds","fullPath":"/api/v1.1.0/reference/bankCodes/bics/{bicId}/nationalIds","operationId":"getNationalIdsFromBic","name":"Retrieves the national ID, the country code, and the code type for the specified Bank Identifier Code (BIC). If the BIC is linked to multiple national IDs, then multiple results can be returned. The BIC is the SWIFT Address assigned to a bank in order to send automated payments to the banks concerned. It uniquely identifies the name and country of the bank and consists of 8-11 characters. Example format AAAABBCCDDD, where AAAA: 4 character bank code, BB: 2 character country code, CC: 2 character","summary":"Retrieves national IDs for a BIC","tags":[],"parameters":[{"name":"bicId","in":"path","type":"string","required":true,"description":"Bank Identifier Code (BIC) of the Beneficiary bank."},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from t24 on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"The identifier of the underlying Entity/Company/Branch."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"NationalIdsFromBicResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/reference/bankCodes/nationalIds/{nationalIdRef}/validity","fullPath":"/api/v1.1.0/reference/bankCodes/nationalIds/{nationalIdRef}/validity","operationId":"validateNationalId","name":"Retrieves the status on the validity of the national ID, returns YES if the given national ID is valid","summary":"Retrieves the status on the validity of the given national ID","tags":[],"parameters":[{"name":"nationalIdRef","in":"path","type":"string","required":true,"description":"Indicates national indentifier reference"},{"name":"countryId","in":"query","type":"string","required":false,"description":"ISO country code of the financial institution. "},{"name":"scheme","in":"query","type":"string","required":false,"description":"Represents the scheme (a synonym for the National ID type) under which the National ID is defined"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from t24 on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"The identifier of the underlying Entity/Company/Branch."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"NationalIdResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/reference/bankCodes/gpi/participants/{participantId}","fullPath":"/api/v1.1.0/reference/bankCodes/gpi/participants/{participantId}","operationId":"getParticipantDetails","name":"Retrieves the details of the participant from the Swift Global Payment Initiative (GPI) participant directory","summary":"Retrieves GPI participant information","tags":[],"parameters":[{"name":"participantId","in":"path","type":"string","required":true,"description":"Process Workflow Participant ID"},{"name":"countryId","in":"query","type":"string","required":true,"description":"ISO country code of the financial institution. "},{"name":"currencyCode","in":"query","type":"string","required":true,"description":"ISO Currency code, accepted in field 32A of incoming gpi MT 103 payment by the participant ID or by the gpi intermediary through which the participant can be reached for this currency"},{"name":"requestDate","in":"query","type":"string","required":false,"description":"Date on which the client's request to be classified as professional has been received."},{"name":"channelType","in":"query","type":"string","required":false,"description":"Indicates the type of the Reachable Through channel"},{"name":"reachableThrough","in":"query","type":"string","required":false,"description":"Channel through which the participant is reachable for Global Payment Initiative (GPI) payment instructions for one of its GPI currencies"},{"name":"actAsIntermediary","in":"query","type":"string","required":false,"description":"Flag specifying whether the participant acts as the Global Payment Initiative (GPI) Intermediary Agent for GPI payments in a given currency and over a given REACHABLE THROUGH channel. Y indicates that"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from t24 on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"The identifier of the underlying Entity/Company/Branch."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"ParticipantDetailsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"PUT","path":"/reference/bankCodes/gpi/participants/{participantId}","fullPath":"/api/v1.1.0/reference/bankCodes/gpi/participants/{participantId}","operationId":"updateSwiftGpiParticipant","name":"The SWIFT global payments innovation (SWIFT gpi) is a SWIFT service that addresses the cross-border payments with the purpose of increasing their speed, transparency and end-to-end tracking. The gpi directory provided by SWIFT contains the complete list of financial institutions that act as gpi participants. The list of participants can either be downloaded from the official SWIFT site or created manually. This endpoint is used to update the SWIFT gpi participant details.The SWIFT global payment","summary":"Update the participant details in Temenos SWIFT gpi directory. ","tags":[],"parameters":[{"name":"participantId","in":"path","type":"string","required":true,"description":""},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"The identifier of the underlying Entity/Company/Branch."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"resourceId":"string","participantId":"string","countryCode":"string","currencyId":"string","status":"string","participantName":"string"}},"responses":{"200":"SwiftGpiParticipantResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"POST","path":"/reference/bankCodes/centralBankDirectories","fullPath":"/api/v1.1.0/reference/bankCodes/centralBankDirectories","operationId":"createCentralBankDirectory","name":"The centralised bank directory contains the BIC and national ID related data for the financial institutions. It is also referred as bank directory plus as it is uploaded from SWIFTRef bank directory plus file. It can also be created manually. This endpoint is used to create the central bank directory details.","summary":"Creates the\u00c2\u00a0BIC and national ID related data for the financial institutions","tags":[],"parameters":[{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"The identifier of the underlying Entity/Company/Branch."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"beneficiaryInstituteNames":[{}],"beneficiaryInstituteBranchNames":[{}],"beneficiaryInstituteCity":"string","status":"string","nationalId":"string","bicId":"string"}},"responses":{"200":"CentralBankDirectoryResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/reference/bankCodes/centralBankDirectories/{centralBankDirectoryId}","fullPath":"/api/v1.1.0/reference/bankCodes/centralBankDirectories/{centralBankDirectoryId}","operationId":"updateCentralBankDirectory","name":"The centralised bank directory contains the BIC and national ID related data for the financial institutions. It is also referred as bank directory plus as it is uploaded from SWIFTRef bank directory plus file. It can also be created manually. This endpoint is used to update the central bank directory details.","summary":"Update the\u00c2\u00a0BIC and national ID related data for the financial institutions","tags":[],"parameters":[{"name":"centralBankDirectoryId","in":"path","type":"string","required":true,"description":""},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"The identifier of the underlying Entity/Company/Branch."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"beneficiaryInstituteNames":[{}],"beneficiaryInstituteBranchNames":[{}],"beneficiaryInstituteCity":"string","status":"string","nationalId":"string","bicId":"string"}},"responses":{"200":"CentralBankDirectoryResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"POST","path":"/reference/bankCodes/gpi/participants","fullPath":"/api/v1.1.0/reference/bankCodes/gpi/participants","operationId":"createSwiftGpiParticipant","name":"Creates the participant details in Temenos SWIFT gpi directory. ","summary":"The SWIFT global payments innovation (SWIFT gpi) is a SWIFT service that addresses the cross-border payments with the purpose of increasing their speed, transparency and end-to-end tracking. The gpi directory provided by SWIFT contains the complete list of financial institutions that act as gpi participants. The list of participants can either be downloaded from the official SWIFT site or created manually. This endpoint is used to create the SWIFT gpi participant details.","tags":[],"parameters":[{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"The identifier of the underlying Entity/Company/Branch."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"resourceId":"string","participantId":"string","countryCode":"string","currencyId":"string","status":"string","participantName":"string"}},"responses":{"200":"SwiftGpiParticipantResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}}]},{"key":"reference-nationalIds-v1.2.0","title":"Swift Reference Data","version":"v1.2.0","description":"API to retrieve variety of information in relation to financial institutions such as the National Identifier (nationalId) codes, Legal Entity Identifier (LEI) details and Global Payment Initiative (GPI) participant details. LEIs are identification codes that enable consistent and accurate identifica","endpointCount":10,"endpoints":[{"method":"GET","path":"/reference/bankCodes/nationalIds/{nationalIdRef}/bics","fullPath":"/api/v1.2.0/reference/bankCodes/nationalIds/{nationalIdRef}/bics","operationId":"getBICsFromNationalId","name":"Retrieves the Bank Identifier Code (BIC) or BICs for a given national ID with its country code or scheme. The BIC is the SWIFT Address assigned to a bank in order to send automated payments to the banks concerned. It uniquely identifies the name and country of the bank and consists of 8-11 characters. Example format AAAABBCCDDD, where AAAA: 4 character bank code, BB: 2 character country code, CC: 2 character location code, DDD: optional 3 character branch code.","summary":"Retrieves the BIC or BICs for a given national ID with its country code or scheme.","tags":[],"parameters":[{"name":"nationalIdRef","in":"path","type":"string","required":true,"description":"Indicates national indentifier reference"},{"name":"countryId","in":"query","type":"string","required":false,"description":"ISO country code of the financial institution. "},{"name":"scheme","in":"query","type":"string","required":false,"description":"Represents the scheme (a synonym for the National ID type) under which the National ID is defined"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"BICsFromNationalIdResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/reference/bankCodes/nationalIds/{nationalIdRef}","fullPath":"/api/v1.2.0/reference/bankCodes/nationalIds/{nationalIdRef}","operationId":"getNationalIdDetails","name":"Retrieves the details of the given national ID, that is the bank name or business name, and the address.","summary":"Retrieves the details of the given national ID","tags":[],"parameters":[{"name":"nationalIdRef","in":"path","type":"string","required":true,"description":"Indicates national indentifier reference"},{"name":"countryId","in":"query","type":"string","required":false,"description":"ISO country code of the financial institution. "},{"name":"scheme","in":"query","type":"string","required":false,"description":"Represents the scheme (a synonym for the National ID type) under which the National ID is defined"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"NationalIdDetailsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/reference/bankCodes/bics/{bicId}/nationalIds","fullPath":"/api/v1.2.0/reference/bankCodes/bics/{bicId}/nationalIds","operationId":"getNationalIdsFromBic","name":"Retrieves the national ID, the country code, and the code type for the specified Bank Identifier Code (BIC). If the BIC is linked to multiple national IDs, then multiple results can be returned. The BIC is the SWIFT Address assigned to a bank in order to send automated payments to the banks concerned. It uniquely identifies the name and country of the bank and consists of 8-11 characters. Example format AAAABBCCDDD, where AAAA: 4 character bank code, BB: 2 character country code, CC: 2 character","summary":"Retrieves national IDs for a BIC","tags":[],"parameters":[{"name":"bicId","in":"path","type":"string","required":true,"description":"Bank Identifier Code (BIC) of the Beneficiary bank."},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"NationalIdsFromBicResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"POST","path":"/reference/bankCodes/gpi/participants","fullPath":"/api/v1.2.0/reference/bankCodes/gpi/participants","operationId":"createSwiftGpiParticipant","name":"Creates the participant details in Temenos SWIFT gpi directory. ","summary":"The SWIFT global payments innovation (SWIFT gpi) is a SWIFT service that addresses the cross-border payments with the purpose of increasing their speed, transparency and end-to-end tracking. The gpi directory provided by SWIFT contains the complete list of financial institutions that act as gpi participants. The list of participants can either be downloaded from the official SWIFT site or created manually. This endpoint is used to create the SWIFT gpi participant details.","tags":[],"parameters":[{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"resourceId":"string","participantId":"string","countryCode":"string","currencyId":"string","status":"string","participantName":"string","extensions":{}}},"responses":{"200":"SwiftGpiParticipantResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/reference/bankCodes/gpi/participants/{participantId}","fullPath":"/api/v1.2.0/reference/bankCodes/gpi/participants/{participantId}","operationId":"getParticipantDetails","name":"Retrieves the details of the participant from the Swift Global Payment Initiative (GPI) participant directory for the  participant id and company id provided","summary":"Retrieves GPI participant information","tags":[],"parameters":[{"name":"participantId","in":"path","type":"string","required":true,"description":"Process Workflow Participant ID"},{"name":"countryId","in":"query","type":"string","required":true,"description":"ISO country code of the financial institution. "},{"name":"currencyCode","in":"query","type":"string","required":true,"description":"ISO Currency code, accepted in field 32A of incoming gpi MT 103 payment by the participant ID or by the gpi intermediary through which the participant can be reached for this currency"},{"name":"requestDate","in":"query","type":"string","required":false,"description":"Date on which the client's request to be classified as professional has been received."},{"name":"channelType","in":"query","type":"string","required":false,"description":"Indicates the type of the Reachable Through channel"},{"name":"reachableThrough","in":"query","type":"string","required":false,"description":"Channel through which the participant is reachable for Global Payment Initiative (GPI) payment instructions for one of its GPI currencies"},{"name":"company","in":"query","type":"string","required":false,"description":"The company code"},{"name":"actAsIntermediary","in":"query","type":"string","required":false,"description":"Flag specifying whether the participant acts as the Global Payment Initiative (GPI) Intermediary Agent for GPI payments in a given currency and over a given REACHABLE THROUGH channel. Y indicates that"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"ParticipantDetailsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"PUT","path":"/reference/bankCodes/gpi/participants/{participantId}","fullPath":"/api/v1.2.0/reference/bankCodes/gpi/participants/{participantId}","operationId":"updateSwiftGpiParticipant","name":"The SWIFT global payments innovation (SWIFT gpi) is a SWIFT service that addresses the cross-border payments with the purpose of increasing their speed, transparency and end-to-end tracking. The gpi directory provided by SWIFT contains the complete list of financial institutions that act as gpi participants. The list of participants can either be downloaded from the official SWIFT site or created manually. This endpoint is used to update the SWIFT gpi participant details.The SWIFT global payment","summary":"Update the participant details in Temenos SWIFT gpi directory. ","tags":[],"parameters":[{"name":"participantId","in":"path","type":"string","required":true,"description":""},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"resourceId":"string","participantId":"string","countryCode":"string","currencyId":"string","status":"string","participantName":"string","extensions":{}}},"responses":{"200":"SwiftGpiParticipantResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/reference/bankCodes/nationalIds/{nationalIdRef}/validity","fullPath":"/api/v1.2.0/reference/bankCodes/nationalIds/{nationalIdRef}/validity","operationId":"ValidateNationalID","name":"Retrieves the status on the validity of the national ID for the company code and date,returns YES if the given national ID is valid","summary":"Retrieves the status on the validity of the given national ID","tags":[],"parameters":[{"name":"nationalIdRef","in":"path","type":"string","required":true,"description":"Indicates national indentifier reference"},{"name":"countryId","in":"query","type":"string","required":false,"description":"ISO country code of the financial institution. "},{"name":"scheme","in":"query","type":"string","required":false,"description":"Represents the scheme (a synonym for the National ID type) under which the National ID is defined"},{"name":"company","in":"query","type":"string","required":false,"description":"The company code"},{"name":"date","in":"query","type":"string","required":false,"description":"Indicates the date on which activity was performed"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"ValidateNationalIDResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/reference/bankCodes/leis/{leiId}/bic","fullPath":"/api/v1.2.0/reference/bankCodes/leis/{leiId}/bic","operationId":"getBicFromLei","name":"Retrieves the Bank Identifier Code (BIC) of the requested Bank's legal entity identifier for the request date.The BIC is the SWIFT Address assigned to a bank in order to send automated payments to the banks concerned. It uniquely identifies the name and country of the bank and consists of 8-11 characters. Example format AAAABBCCDDD, where AAAA: 4 character bank code, BB: 2 character country code, CC: 2 character location code, DDD: optional 3 character branch code.","summary":"Retrieves the BIC code of the requested Bank's legal entity identifier","tags":[],"parameters":[{"name":"leiId","in":"path","type":"string","required":true,"description":"Identifier of the legal entity reference"},{"name":"date","in":"query","type":"string","required":false,"description":"Indicates the date on which activity was performed"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"BicFromLeiResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"POST","path":"/reference/bankCodes/centralBankDirectories","fullPath":"/api/v1.2.0/reference/bankCodes/centralBankDirectories","operationId":"createCentralBankDirectory","name":"The centralised bank directory contains the BIC and national ID related data for the financial institutions. It is also referred as bank directory plus as it is uploaded from SWIFTRef bank directory plus file. It can also be created manually. This endpoint is used to create the central bank directory details.","summary":"Creates the BIC and national ID related data for the financial institutions","tags":[],"parameters":[{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"beneficiaryInstituteNames":[{}],"beneficiaryInstituteBranchNames":[{}],"beneficiaryInstituteCity":"string","status":"string","nationalId":"string","bicId":"string","countryCode":"string","bankLegalEntityIdentifier":"string","extensions":{}}},"responses":{"200":"CentralBankDirectoryResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/reference/bankCodes/centralBankDirectories/{centralBankDirectoryId}","fullPath":"/api/v1.2.0/reference/bankCodes/centralBankDirectories/{centralBankDirectoryId}","operationId":"updateCentralBankDirectory","name":"The centralised bank directory contains the BIC and national ID related data for the financial institutions. It is also referred as bank directory plus as it is uploaded from SWIFTRef bank directory plus file. It can also be created manually. This endpoint is used to update the central bank directory details.","summary":"Update the BIC and national ID related data for the financial institutions","tags":[],"parameters":[{"name":"centralBankDirectoryId","in":"path","type":"string","required":true,"description":"Indicates the central bank directory identifier."},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"beneficiaryInstituteNames":[{}],"beneficiaryInstituteBranchNames":[{}],"beneficiaryInstituteCity":"string","status":"string","nationalId":"string","bicId":"string","countryCode":"string","bankLegalEntityIdentifier":"string","extensions":{}}},"responses":{"200":"CentralBankDirectoryResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}}]},{"key":"reference-nationalIds-v1.3.0","title":"Swift Reference Data","version":"v1.3.0","description":"API to retrieve variety of information in relation to financial institutions such as the National Identifier (nationalId) codes, Legal Entity Identifier (LEI) details and Global Payment Initiative (GPI) participant details. LEIs are identification codes that enable consistent and accurate identifica","endpointCount":16,"endpoints":[{"method":"GET","path":"/reference/bankCodes/leis/{leiId}/bic","fullPath":"/api/v1.3.0/reference/bankCodes/leis/{leiId}/bic","operationId":"getBICFromLEI","name":"Retrieves the Bank Identifier Code (BIC) of the requested Bank's legal entity identifier. The BIC is the SWIFT address assigned to a bank in order to send automated payments to the banks concerned. It uniquely identifies the name and country of the bank and consists of 8-11 characters. Example format AAAABBCCDDD, where AAAA: 4 character bank code, BB: 2 character country code, CC: 2 character location code, DDD: optional 3 character branch code.","summary":"Retrieves the BIC code of the requested Bank's legal entity identifier","tags":[],"parameters":[{"name":"leiId","in":"path","type":"string","required":true,"description":"Identifier of the legal entity reference"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"BICFromLEIResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/reference/bankCodes/nationalIds/{nationalIdRef}","fullPath":"/api/v1.3.0/reference/bankCodes/nationalIds/{nationalIdRef}","operationId":"getNationalIdDetails","name":"Retrieves the details of the given national ID, that is the bank name or business name, and the address.","summary":"Retrieves the details of the given national ID","tags":[],"parameters":[{"name":"nationalIdRef","in":"path","type":"string","required":true,"description":"Indicates national indentifier reference"},{"name":"countryId","in":"query","type":"string","required":false,"description":"ISO country code of the financial institution. "},{"name":"scheme","in":"query","type":"string","required":false,"description":"Represents the scheme (a synonym for the National ID type) under which the National ID is defined"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"NationalIdDetailsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/reference/bankCodes/nationalIds/{nationalIdRef}/validity","fullPath":"/api/v1.3.0/reference/bankCodes/nationalIds/{nationalIdRef}/validity","operationId":"validateNationalId","name":"Retrieves the status on the validity of the national ID, returns YES if the given national ID is valid","summary":"Retrieves the status on the validity of the given national ID","tags":[],"parameters":[{"name":"nationalIdRef","in":"path","type":"string","required":true,"description":"Indicates national indentifier reference"},{"name":"countryId","in":"query","type":"string","required":false,"description":"ISO country code of the financial institution. "},{"name":"scheme","in":"query","type":"string","required":false,"description":"Represents the scheme (a synonym for the National ID type) under which the National ID is defined"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"NationalIdResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/reference/bankCodes/gpi/participants/{participantId}","fullPath":"/api/v1.3.0/reference/bankCodes/gpi/participants/{participantId}","operationId":"getParticipantDetails","name":"Retrieves the details of the participant from the Swift Global Payment Initiative (GPI) participant directory","summary":"Retrieves GPI participant information","tags":[],"parameters":[{"name":"participantId","in":"path","type":"string","required":true,"description":"Process Workflow Participant ID"},{"name":"countryId","in":"query","type":"string","required":true,"description":"ISO country code of the financial institution. "},{"name":"currencyCode","in":"query","type":"string","required":true,"description":"ISO Currency code, accepted in field 32A of incoming gpi MT 103 payment by the participant ID or by the gpi intermediary through which the participant can be reached for this currency"},{"name":"requestDate","in":"query","type":"string","required":false,"description":"Date on which the client's request to be classified as professional has been received."},{"name":"channelType","in":"query","type":"string","required":false,"description":"Indicates the type of the Reachable Through channel"},{"name":"reachableThrough","in":"query","type":"string","required":false,"description":"Channel through which the participant is reachable for Global Payment Initiative (GPI) payment instructions for one of its GPI currencies"},{"name":"actAsIntermediary","in":"query","type":"string","required":false,"description":"Flag specifying whether the participant acts as the Global Payment Initiative (GPI) Intermediary Agent for GPI payments in a given currency and over a given REACHABLE THROUGH channel. Y indicates that"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"ParticipantDetailsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"PUT","path":"/reference/bankCodes/gpi/participants/{participantId}","fullPath":"/api/v1.3.0/reference/bankCodes/gpi/participants/{participantId}","operationId":"updateSwiftGpiParticipant","name":"The SWIFT global payments innovation (SWIFT gpi) is a SWIFT service that addresses the cross-border payments with the purpose of increasing their speed, transparency and end-to-end tracking. The gpi directory provided by SWIFT contains the complete list of financial institutions that act as gpi participants. The list of participants can either be downloaded from the official SWIFT site or created manually. This endpoint is used to update the SWIFT gpi participant details.The SWIFT global payment","summary":"Update the participant details in Temenos SWIFT gpi directory. ","tags":[],"parameters":[{"name":"participantId","in":"path","type":"string","required":true,"description":""},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"resourceId":"string","participantId":"string","countryCode":"string","currencyId":"string","status":"string","participantName":"string","extensions":{}}},"responses":{"200":"SwiftGpiParticipantResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"POST","path":"/reference/bankCodes/gpi/participants","fullPath":"/api/v1.3.0/reference/bankCodes/gpi/participants","operationId":"createSwiftGpiParticipant","name":"The SWIFT global payments innovation (SWIFT gpi) is a SWIFT service that addresses the cross-border payments with the purpose of increasing their speed, transparency and end-to-end tracking. The gpi directory provided by SWIFT contains the complete list of financial institutions that act as gpi participants. The list of participants can either be downloaded from the official SWIFT site or created manually. This endpoint is used to create the SWIFT gpi participant details.","summary":"Creates the participant details in Temenos SWIFT gpi directory.","tags":[],"parameters":[{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"resourceId":"string","participantId":"string","countryCode":"string","currencyId":"string","status":"string","participantName":"string","extensions":{}}},"responses":{"200":"SwiftGpiParticipantResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/reference/bankCodes/centralBankDirectoryRules/{centralBankDirectoryRulesId}","fullPath":"/api/v1.3.0/reference/bankCodes/centralBankDirectoryRules/{centralBankDirectoryRulesId}","operationId":"getReferenceDataRules","name":"Retrieves the definition indicating if central bank directory is the BIC reference data and if the validation of the BIC against the directory is enabled","summary":"Retrieves the validation information for central bank directory","tags":[],"parameters":[{"name":"centralBankDirectoryRulesId","in":"path","type":"string","required":true,"description":"Specifies the identifier of central bank directory rules. The allowed value is SYSTEM"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"ReferenceDataRulesResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"POST","path":"/reference/bankCodes/centralBankDirectoryRules/{centralBankDirectoryRulesId}","fullPath":"/api/v1.3.0/reference/bankCodes/centralBankDirectoryRules/{centralBankDirectoryRulesId}","operationId":"createReferenceDataRules","name":"Create the central bank directory rules with details on BIC validation and if the system has central bank directory enabled for BIC and national clearing code validation","summary":"Create the central bank directory rules","tags":[],"parameters":[{"name":"centralBankDirectoryRulesId","in":"path","type":"string","required":true,"description":"Specifies the identifier of central bank directory rules. The allowed value is SYSTEM"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"BICValidation":"string","isMainReferenceData":"string","extensions":{}}},"responses":{"200":"ReferenceDataRulesResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/reference/bankCodes/centralBankDirectoryRules/{centralBankDirectoryRulesId}","fullPath":"/api/v1.3.0/reference/bankCodes/centralBankDirectoryRules/{centralBankDirectoryRulesId}","operationId":"updateReferenceDataRules","name":"Update the central bank directory rules with details on BIC validation and if the system has central bank directory enabled for BIC and national clearing code validation","summary":"Update the central bank directory rules","tags":[],"parameters":[{"name":"centralBankDirectoryRulesId","in":"path","type":"string","required":true,"description":"Specifies the identifier of central bank directory rules. The allowed value is SYSTEM"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"BICValidation":"string","isMainReferenceData":"string","extensions":{}}},"responses":{"200":"ReferenceDataRulesResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/reference/bankCodes/nationalIds/{nationalIdRef}/bics","fullPath":"/api/v1.3.0/reference/bankCodes/nationalIds/{nationalIdRef}/bics","operationId":"getBICFromNationalId","name":"Retrieves the Bank Identifier Code (BIC) or BICs for a given national ID with its country code or scheme along with address details associated with the BIC. The BIC is the SWIFT address assigned to a bank in order to send automated payments to the banks concerned. It uniquely identifies the name and country of the bank and consists of 8-11 characters. Example format AAAABBCCDDD, where AAAA: 4 character bank code, BB: 2 character country code, CC: 2 character location code, DDD: optional 3 charac","summary":"Retrieves the BIC or BICs for a given national ID with its country code or scheme along with BIC details","tags":[],"parameters":[{"name":"nationalIdRef","in":"path","type":"string","required":true,"description":"Indicates national indentifier reference"},{"name":"countryId","in":"query","type":"string","required":false,"description":"ISO country code of the financial institution. "},{"name":"scheme","in":"query","type":"string","required":false,"description":"Represents the scheme (a synonym for the National ID type) under which the National ID is defined"},{"name":"date","in":"query","type":"string","required":false,"description":"Indicates the date on which activity was performed"},{"name":"company","in":"query","type":"string","required":false,"description":"The company code"},{"name":"isoClearingCode","in":"query","type":"string","required":false,"description":"Specifies the ISO identifier of the clearing system"},{"name":"swiftPrefix","in":"query","type":"string","required":false,"description":"Prefix of country specific details in payments method"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"BICFromNationalIdResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/reference/bankCodes/nationalSystemIdentifiers/{nationalSystemIdType}/{nationalSystemId}","fullPath":"/api/v1.3.0/reference/bankCodes/nationalSystemIdentifiers/{nationalSystemIdType}/{nationalSystemId}","operationId":"getNationalSystemIdentifiers","name":"Retrieves the country national system identifiers for national system identifier reference provided.  Allowed values for national system identifier reference are be COUNTRYCODE,SWIFTPREFIX or ISOCLEARINGID and national system id can be  of values such as US (for COUNTRYCODE) or SC (for SWIFTPREFIX) or GBDSC (for ISOCLEARINGID)","summary":"Retrieves the national system identifiers.","tags":[],"parameters":[{"name":"nationalSystemIdType","in":"path","type":"string","required":true,"description":"Specifies the type of national system id. Values can be COUNTRYCODE,SWIFTPREFIX or ISOCLEARINGID"},{"name":"nationalSystemId","in":"path","type":"string","required":true,"description":"Specifies the national system clearing system id. Sample values are US (for COUNTRYCODE) or SC (for SWIFTPREFIX) or GBDSC (for ISOCLEARINGID)"},{"name":"nationalId","in":"query","type":"string","required":false,"description":"Indicates the national id of a financial institution under national clearing system"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"NationalSystemIdentifiersResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/reference/bankCodes/bics/{bicId}/nationalIds","fullPath":"/api/v1.3.0/reference/bankCodes/bics/{bicId}/nationalIds","operationId":"getNationalIDFromBIC","name":"Retrieves the national ID, the country code, address details and the code type for the specified Bank Identifier Code (BIC). If the BIC is linked to multiple national IDs, then multiple results can be returned. The BIC is the SWIFT address assigned to a bank in order to send automated payments to the banks concerned. It uniquely identifies the name and country of the bank and consists of 8-11 characters. Example format AAAABBCCDDD, where AAAA: 4 character bank code, BB: 2 character country code,","summary":"Retrieves national IDs and details for a BIC","tags":[],"parameters":[{"name":"bicId","in":"path","type":"string","required":true,"description":"Bank Identifier Code (BIC) of the financial institution"},{"name":"date","in":"query","type":"string","required":false,"description":"Indicates the date on which activity was performed"},{"name":"companyId","in":"query","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"NationalIDFromBICResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"POST","path":"/reference/bankCodes/centralBankDirectories","fullPath":"/api/v1.3.0/reference/bankCodes/centralBankDirectories","operationId":"createCentralBankDirectory","name":"The centralised bank directory contains the BIC and national ID related data for the financial institutions. It is also referred as bank directory plus as it is uploaded from SWIFTRef bank directory plus file. It can also be created manually. This endpoint is used to create the central bank directory details.","summary":"Creates the\u00c2\u00a0BIC and national ID related data for the financial institutions","tags":[],"parameters":[{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"beneficiaryInstituteNames":[{}],"beneficiaryInstituteBranchNames":[{}],"address":[{}],"bicLocations":[{}],"countryNames":[{}],"beneficiaryInstituteCity":"string","status":"string","nationalId":"string","bicId":"string","countryCode":"string","bankLegalEntityIdentifier":"string","scheme":"string","zip":"string","postCode":"string","officeType":"string"}},"responses":{"200":"CentralBankDirectoryResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/reference/bankCodes/nationalSystemIdentifiers/{nationalSystemIdentifierId}","fullPath":"/api/v1.3.0/reference/bankCodes/nationalSystemIdentifiers/{nationalSystemIdentifierId}","operationId":"getNationalSystemIdentifierDetails","name":"Retrieves the national system identifier details such as iso clearing code, swift prefix, national id, national id format for national system identifier reference provided.","summary":"Retrieves the national system identifiers for the national system identifier reference provided.","tags":[],"parameters":[{"name":"nationalSystemIdentifierId","in":"path","type":"string","required":true,"description":"Contains the nationalSystemIdentifierId."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"NationalSystemIdentifierDetailsResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"POST","path":"/reference/bankCodes/nationalSystemIdentifiers/{nationalSystemIdentifierId}","fullPath":"/api/v1.3.0/reference/bankCodes/nationalSystemIdentifiers/{nationalSystemIdentifierId}","operationId":"createNationalSystemIdentifierDetails","name":"Creates the national system identifiers with details such as iso clearing code, swift prefix, national id, national id format for national system identifier reference provided.","summary":"Creates the national system identifiers for national system identifier reference provided.","tags":[],"parameters":[{"name":"nationalSystemIdentifierId","in":"path","type":"string","required":true,"description":"Contains the nationalSystemIdentifierId."},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"countryId":"string","isoClearingCode":"string","swiftPrefix":"string","nationalIdFormat":"string","nationalIdType":"string","extensions":{}}},"responses":{"200":"NationalSystemIdentifierDetailsResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/reference/bankCodes/nationalSystemIdentifiers/{nationalSystemIdentifierId}","fullPath":"/api/v1.3.0/reference/bankCodes/nationalSystemIdentifiers/{nationalSystemIdentifierId}","operationId":"updateNationalSystemIdentifierDetails","name":"Updates the national system identifiers with details such as iso clearing code, swift prefix, national id,national id format for national system identifier reference provided .","summary":"Updates the national system identifiers for the national system identifier reference provided.","tags":[],"parameters":[{"name":"nationalSystemIdentifierId","in":"path","type":"string","required":true,"description":"Contains the nationalSystemIdentifierId."},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"countryId":"string","isoClearingCode":"string","swiftPrefix":"string","nationalIdFormat":"string","nationalIdType":"string","extensions":{}}},"responses":{"200":"NationalSystemIdentifierDetailsResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}}]},{"key":"reference-nationalIds-v1.4.0","title":"Swift Reference Data","version":"v1.4.0","description":"API to retrieve variety of information in relation to financial institutions such as the national identifier (national id) codes, Legal Entity Identifier (LEI) details and Global Payment Initiative (GPI) participant details. LEIs are identification codes that enable consistent and accurate identific","endpointCount":16,"endpoints":[{"method":"GET","path":"/reference/bankCodes/leis/{leiId}/bic","fullPath":"/api/v1.4.0/reference/bankCodes/leis/{leiId}/bic","operationId":"getBICFromLEI","name":"Retrieves the Bank Identifier Code (BIC) of the requested bank's legal entity identifier. The BIC is the SWIFT address assigned to a bank in order to send automated payments to the banks concerned. It uniquely identifies the name and country of the bank and consists of 8-11 characters. Example format AAAABBCCDDD, where AAAA: 4 character bank code, BB: 2 character country code, CC: 2 character location code, DDD: optional 3 character branch code.","summary":"Retrieves the BIC code of the requested bank's legal entity identifier","tags":[],"parameters":[{"name":"leiId","in":"path","type":"string","required":true,"description":"Identifier of the legal entity reference"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"BICFromLEIResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/reference/bankCodes/nationalIds/{nationalIdRef}","fullPath":"/api/v1.4.0/reference/bankCodes/nationalIds/{nationalIdRef}","operationId":"getNationalIdDetails","name":"Retrieves the details of the given national id, that is the bank name or business name, and the address.","summary":"Retrieves the details of the given national id","tags":[],"parameters":[{"name":"nationalIdRef","in":"path","type":"string","required":true,"description":"Indicates national indentifier reference"},{"name":"countryId","in":"query","type":"string","required":false,"description":"ISO country code of the financial institution. "},{"name":"scheme","in":"query","type":"string","required":false,"description":"Represents the scheme (a synonym for the national id type) under which the national id is defined"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"NationalIdDetailsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/reference/bankCodes/nationalIds/{nationalIdRef}/validity","fullPath":"/api/v1.4.0/reference/bankCodes/nationalIds/{nationalIdRef}/validity","operationId":"validateNationalId","name":"Retrieves the status on the validity of the national id, returns YES if the given national id is valid","summary":"Retrieves the status on the validity of the given national id","tags":[],"parameters":[{"name":"nationalIdRef","in":"path","type":"string","required":true,"description":"Indicates national indentifier reference"},{"name":"countryId","in":"query","type":"string","required":false,"description":"ISO country code of the financial institution. "},{"name":"scheme","in":"query","type":"string","required":false,"description":"Represents the scheme (a synonym for the national id type) under which the national id is defined"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"NationalIdResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/reference/bankCodes/gpi/participants/{participantId}","fullPath":"/api/v1.4.0/reference/bankCodes/gpi/participants/{participantId}","operationId":"getParticipantDetails","name":"Retrieves the details of the participant from the Swift Global Payment Initiative (GPI) participant directory","summary":"Retrieves GPI participant information","tags":[],"parameters":[{"name":"participantId","in":"path","type":"string","required":true,"description":"Process Workflow Participant ID"},{"name":"countryId","in":"query","type":"string","required":true,"description":"ISO country code of the financial institution. "},{"name":"currencyCode","in":"query","type":"string","required":true,"description":"ISO Currency code, accepted in field 32A of incoming gpi MT 103 payment by the participant ID or by the gpi intermediary through which the participant can be reached for this currency"},{"name":"requestDate","in":"query","type":"string","required":false,"description":"Date on which the client's request to be classified as professional has been received."},{"name":"channelType","in":"query","type":"string","required":false,"description":"Indicates the type of the Reachable Through channel"},{"name":"reachableThrough","in":"query","type":"string","required":false,"description":"Channel through which the participant is reachable for Global Payment Initiative (GPI) payment instructions for one of its GPI currencies"},{"name":"actAsIntermediary","in":"query","type":"string","required":false,"description":"Flag specifying whether the participant acts as the Global Payment Initiative (GPI) Intermediary Agent for GPI payments in a given currency and over a given REACHABLE THROUGH channel. Y indicates that"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"ParticipantDetailsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"PUT","path":"/reference/bankCodes/gpi/participants/{participantId}","fullPath":"/api/v1.4.0/reference/bankCodes/gpi/participants/{participantId}","operationId":"updateSwiftGpiParticipant","name":"The SWIFT global payments innovation (SWIFT gpi) is a SWIFT service that addresses the cross-border payments with the purpose of increasing their speed, transparency and end-to-end tracking. The gpi directory provided by SWIFT contains the complete list of financial institutions that act as gpi participants. The list of participants can either be downloaded from the official SWIFT site or created manually. This endpoint is used to update the SWIFT gpi participant details.The SWIFT global payment","summary":"Update the participant details in Temenos SWIFT gpi directory. ","tags":[],"parameters":[{"name":"participantId","in":"path","type":"string","required":true,"description":""},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"resourceId":"string","participantId":"string","countryCode":"string","currencyId":"string","status":"string","participantName":"string","extensions":{}}},"responses":{"200":"SwiftGpiParticipantResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"POST","path":"/reference/bankCodes/gpi/participants","fullPath":"/api/v1.4.0/reference/bankCodes/gpi/participants","operationId":"createSwiftGpiParticipant","name":"The SWIFT global payments innovation (SWIFT gpi) is a SWIFT service that addresses the cross-border payments with the purpose of increasing their speed, transparency and end-to-end tracking. The gpi directory provided by SWIFT contains the complete list of financial institutions that act as gpi participants. The list of participants can either be downloaded from the official SWIFT site or created manually. This endpoint is used to create the SWIFT gpi participant details.","summary":"Creates the participant details in Temenos SWIFT gpi directory.","tags":[],"parameters":[{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"resourceId":"string","participantId":"string","countryCode":"string","currencyId":"string","status":"string","participantName":"string","extensions":{}}},"responses":{"200":"SwiftGpiParticipantResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/reference/bankCodes/centralBankDirectoryRules/{centralBankDirectoryRulesId}","fullPath":"/api/v1.4.0/reference/bankCodes/centralBankDirectoryRules/{centralBankDirectoryRulesId}","operationId":"getReferenceDataRules","name":"Retrieves the definition indicating if central bank directory is the BIC reference data and if the validation of the BIC against the directory is enabled","summary":"Retrieves the validation information for central bank directory","tags":[],"parameters":[{"name":"centralBankDirectoryRulesId","in":"path","type":"string","required":true,"description":"Specifies the identifier of central bank directory rules. The allowed value is SYSTEM"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"ReferenceDataRulesResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"POST","path":"/reference/bankCodes/centralBankDirectoryRules/{centralBankDirectoryRulesId}","fullPath":"/api/v1.4.0/reference/bankCodes/centralBankDirectoryRules/{centralBankDirectoryRulesId}","operationId":"createReferenceDataRules","name":"Create the central bank directory rules with details on BIC validation and if the system has central bank directory enabled for BIC and national clearing code validation","summary":"Create the central bank directory rules","tags":[],"parameters":[{"name":"centralBankDirectoryRulesId","in":"path","type":"string","required":true,"description":"Specifies the identifier of central bank directory rules. The allowed value is SYSTEM"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"BICValidation":"string","isMainReferenceData":"string","extensions":{}}},"responses":{"200":"ReferenceDataRulesResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/reference/bankCodes/centralBankDirectoryRules/{centralBankDirectoryRulesId}","fullPath":"/api/v1.4.0/reference/bankCodes/centralBankDirectoryRules/{centralBankDirectoryRulesId}","operationId":"updateReferenceDataRules","name":"Update the central bank directory rules with details on BIC validation and if the system has central bank directory enabled for BIC and national clearing code validation","summary":"Update the central bank directory rules","tags":[],"parameters":[{"name":"centralBankDirectoryRulesId","in":"path","type":"string","required":true,"description":"Specifies the identifier of central bank directory rules. The allowed value is SYSTEM"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"BICValidation":"string","isMainReferenceData":"string","extensions":{}}},"responses":{"200":"ReferenceDataRulesResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/reference/bankCodes/nationalIds/{nationalIdRef}/bics","fullPath":"/api/v1.4.0/reference/bankCodes/nationalIds/{nationalIdRef}/bics","operationId":"getBICFromNationalId","name":"Retrieves the Bank Identifier Code (BIC) or BICs for a given national id with its country code or scheme along with address details associated with the BIC. The BIC is the SWIFT address assigned to a bank in order to send automated payments to the banks concerned. It uniquely identifies the name and country of the bank and consists of 8-11 characters. Example format AAAABBCCDDD, where AAAA: 4 character bank code, BB: 2 character country code, CC: 2 character location code, DDD: optional 3 charac","summary":"Retrieves the BIC or BICs for a given national id with its country code or scheme along with BIC details","tags":[],"parameters":[{"name":"nationalIdRef","in":"path","type":"string","required":true,"description":"Indicates national indentifier reference"},{"name":"countryId","in":"query","type":"string","required":false,"description":"ISO country code of the financial institution. "},{"name":"scheme","in":"query","type":"string","required":false,"description":"Represents the scheme (a synonym for the national id type) under which the national id is defined"},{"name":"date","in":"query","type":"string","required":false,"description":"Indicates the date on which activity was performed"},{"name":"company","in":"query","type":"string","required":false,"description":"The company code"},{"name":"isoClearingCode","in":"query","type":"string","required":false,"description":"Specifies the ISO identifier of the clearing system"},{"name":"swiftPrefix","in":"query","type":"string","required":false,"description":"Prefix of country specific details in payments method"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"BICFromNationalIdResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/reference/bankCodes/nationalSystemIdentifiers/{nationalSystemIdType}/{nationalSystemId}","fullPath":"/api/v1.4.0/reference/bankCodes/nationalSystemIdentifiers/{nationalSystemIdType}/{nationalSystemId}","operationId":"getNationalSystemIdentifiers","name":"Retrieves the country national system identifiers for national system identifier reference provided.  Allowed values for  national system identifier reference are be COUNTRYCODE,SWIFTPREFIX or ISOCLEARINGID and nationalSystemId can be  of values such as US (for COUNTRYCODE) or SC (for SWIFTPREFIX) or GBDSC (for ISOCLEARINGID)","summary":"Retrieves the national system identifiers.","tags":[],"parameters":[{"name":"nationalSystemIdType","in":"path","type":"string","required":true,"description":"Specifies the type of national system id. Values can be COUNTRYCODE,SWIFTPREFIX or ISOCLEARINGID"},{"name":"nationalSystemId","in":"path","type":"string","required":true,"description":"Specifies the national system clearing system id. Sample values are US (for COUNTRYCODE) or SC (for SWIFTPREFIX) or GBDSC (for ISOCLEARINGID)"},{"name":"nationalId","in":"query","type":"string","required":false,"description":"Indicates the national id of a financial institution under national clearing system"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"NationalSystemIdentifiersResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/reference/bankCodes/bics/{bicId}/nationalIds","fullPath":"/api/v1.4.0/reference/bankCodes/bics/{bicId}/nationalIds","operationId":"getNationalIDFromBIC","name":"Retrieves the national id, the country code, address details and the code type for the specified Bank Identifier Code (BIC). If the BIC is linked to multiple national ids, then multiple results can be returned. The BIC is the SWIFT address assigned to a bank in order to send automated payments to the banks concerned. It uniquely identifies the name and country of the bank and consists of 8-11 characters. Example format AAAABBCCDDD, where AAAA: 4 character bank code, BB: 2 character country code,","summary":"Retrieves national ids and details for a BIC","tags":[],"parameters":[{"name":"bicId","in":"path","type":"string","required":true,"description":"Bank Identifier Code (BIC) of the financial institution"},{"name":"date","in":"query","type":"string","required":false,"description":"Indicates the date on which activity was performed"},{"name":"companyId","in":"query","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"NationalIDFromBICResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/reference/bankCodes/nationalSystemIdentifiers/{nationalSystemIdentifierId}","fullPath":"/api/v1.4.0/reference/bankCodes/nationalSystemIdentifiers/{nationalSystemIdentifierId}","operationId":"getNationalSystemIdentifierDetails","name":"Retrieves the national system identifier details such as iso clearing code, swift prefix, national id, national id format for national system identifier reference provided.","summary":"Retrieves the national system identifiers for the national system identifier reference provided.","tags":[],"parameters":[{"name":"nationalSystemIdentifierId","in":"path","type":"string","required":true,"description":"Contains the nationalSystemIdentifierId."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"NationalSystemIdentifierDetailsResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"POST","path":"/reference/bankCodes/nationalSystemIdentifiers/{nationalSystemIdentifierId}","fullPath":"/api/v1.4.0/reference/bankCodes/nationalSystemIdentifiers/{nationalSystemIdentifierId}","operationId":"createNationalSystemIdentifierDetails","name":"Creates the national system identifiers with details such as iso clearing code, swift prefix, national id,  national id format for national system identifier reference provided.","summary":"Creates the national system identifiers for national system identifier reference provided.","tags":[],"parameters":[{"name":"nationalSystemIdentifierId","in":"path","type":"string","required":true,"description":"Contains the nationalSystemIdentifierId."},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"countryId":"string","isoClearingCode":"string","swiftPrefix":"string","nationalIdFormat":"string","nationalIdType":"string","extensions":{}}},"responses":{"200":"NationalSystemIdentifierDetailsResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/reference/bankCodes/nationalSystemIdentifiers/{nationalSystemIdentifierId}","fullPath":"/api/v1.4.0/reference/bankCodes/nationalSystemIdentifiers/{nationalSystemIdentifierId}","operationId":"updateNationalSystemIdentifierDetails","name":"Updates the national system identifiers with details such as iso clearing code, swift prefix, national id,  national id format for national system identifier reference provided.","summary":"Updates the national system identifiers for the national system identifier reference provided.","tags":[],"parameters":[{"name":"nationalSystemIdentifierId","in":"path","type":"string","required":true,"description":"Contains the nationalSystemIdentifierId."},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"countryId":"string","isoClearingCode":"string","swiftPrefix":"string","nationalIdFormat":"string","nationalIdType":"string","extensions":{}}},"responses":{"200":"NationalSystemIdentifierDetailsResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"POST","path":"/reference/bankCodes/centralBankDirectories","fullPath":"/api/v1.4.0/reference/bankCodes/centralBankDirectories","operationId":"createCentralBankDirectory","name":"The centralised bank directory contains the BIC and national id related data for the financial institutions. It is also referred as bank directory plus as it is uploaded from SWIFTRef bank directory plus file. It can also be created manually. This endpoint is used to create the central bank directory details.","summary":"Creates the\u00c2\u00a0BIC and national id related data for the financial institutions","tags":[],"parameters":[{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"beneficiaryInstituteNames":[{}],"beneficiaryInstituteBranchNames":[{}],"address":[{}],"bicLocations":[{}],"countryNames":[{}],"beneficiaryInstituteCity":"string","status":"string","nationalId":"string","bicId":"string","countryCode":"string","bankLegalEntityIdentifier":"string","scheme":"string","zip":"string","postCode":"string","officeType":"string"}},"responses":{"200":"CentralBankDirectoryResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}}]},{"key":"reference-nationalIds-v1.5.0","title":"Swift Reference Data","version":"v1.5.0","description":"API to retrieve variety of information in relation to financial institutions such as the National Identifier (nationalId) codes, Legal Entity Identifier (LEI) details and Global Payment Initiative (GPI) participant details. LEIs are identification codes that enable consistent and accurate identifica","endpointCount":16,"endpoints":[{"method":"GET","path":"/reference/bankCodes/leis/{leiId}/bic","fullPath":"/api/v1.5.0/reference/bankCodes/leis/{leiId}/bic","operationId":"getBICFromLEI","name":"Retrieves the Bank Identifier Code (BIC) of the requested bank's legal entity identifier. The BIC is the SWIFT address assigned to a bank in order to send automated payments to the banks concerned. It uniquely identifies the name and country of the bank and consists of 8-11 characters. Example format AAAABBCCDDD, where AAAA: 4 character bank code, BB: 2 character country code, CC: 2 character location code, DDD: optional 3 character branch code.","summary":"Retrieves the BIC code of the requested bank's legal entity identifier","tags":[],"parameters":[{"name":"leiId","in":"path","type":"string","required":true,"description":"Identifier of the legal entity reference"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"BICFromLEIResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse","default":"QueryErrorResponse"}},{"method":"GET","path":"/reference/bankCodes/nationalIds/{nationalIdRef}","fullPath":"/api/v1.5.0/reference/bankCodes/nationalIds/{nationalIdRef}","operationId":"getNationalIdDetails","name":"Retrieves the details of the given national id, that is the bank name or business name, and the address.","summary":"Retrieves the details of the given national id","tags":[],"parameters":[{"name":"nationalIdRef","in":"path","type":"string","required":true,"description":"Indicates national indentifier reference"},{"name":"countryId","in":"query","type":"string","required":false,"description":"ISO country code of the financial institution. "},{"name":"scheme","in":"query","type":"string","required":false,"description":"Represents the scheme (a synonym for the national id type) under which the national id is defined"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"NationalIdDetailsResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse","default":"QueryErrorResponse"}},{"method":"GET","path":"/reference/bankCodes/nationalIds/{nationalIdRef}/validity","fullPath":"/api/v1.5.0/reference/bankCodes/nationalIds/{nationalIdRef}/validity","operationId":"validateNationalId","name":"Retrieves the status on the validity of the national id, returns YES if the given national id is valid","summary":"Retrieves the status on the validity of the given national id","tags":[],"parameters":[{"name":"nationalIdRef","in":"path","type":"string","required":true,"description":"Indicates national indentifier reference"},{"name":"countryId","in":"query","type":"string","required":false,"description":"ISO country code of the financial institution. "},{"name":"scheme","in":"query","type":"string","required":false,"description":"Represents the scheme (a synonym for the national id type) under which the national id is defined"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"NationalIdResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse","default":"QueryErrorResponse"}},{"method":"GET","path":"/reference/bankCodes/gpi/participants/{participantId}","fullPath":"/api/v1.5.0/reference/bankCodes/gpi/participants/{participantId}","operationId":"getParticipantDetails","name":"Retrieves the details of the participant from the Swift Global Payment Initiative (GPI) participant directory","summary":"Retrieves GPI participant information","tags":[],"parameters":[{"name":"participantId","in":"path","type":"string","required":true,"description":"Process Workflow Participant ID"},{"name":"countryId","in":"query","type":"string","required":true,"description":"ISO country code of the financial institution. "},{"name":"currencyCode","in":"query","type":"string","required":true,"description":"ISO Currency code, accepted in field 32A of incoming gpi MT 103 payment by the participant ID or by the gpi intermediary through which the participant can be reached for this currency"},{"name":"requestDate","in":"query","type":"string","required":false,"description":"Date on which the client's request to be classified as professional has been received."},{"name":"channelType","in":"query","type":"string","required":false,"description":"Indicates the type of the Reachable Through channel"},{"name":"reachableThrough","in":"query","type":"string","required":false,"description":"Channel through which the participant is reachable for Global Payment Initiative (GPI) payment instructions for one of its GPI currencies"},{"name":"company","in":"query","type":"string","required":false,"description":"The company code"},{"name":"actAsIntermediary","in":"query","type":"string","required":false,"description":"Flag specifying whether the participant acts as the Global Payment Initiative (GPI) Intermediary Agent for GPI payments in a given currency and over a given REACHABLE THROUGH channel. Y indicates that"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"ParticipantDetailsResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse","default":"QueryErrorResponse"}},{"method":"PUT","path":"/reference/bankCodes/gpi/participants/{participantId}","fullPath":"/api/v1.5.0/reference/bankCodes/gpi/participants/{participantId}","operationId":"updateSwiftGpiParticipant","name":"The SWIFT global payments initiation (SWIFT gpi) is a SWIFT service that addresses the cross-border payments with the purpose of increasing their speed, transparency and end-to-end tracking. The gpi directory provided by SWIFT contains the complete list of financial institutions that act as gpi participants. The list of participants can either be downloaded from the official SWIFT site or created manually. This endpoint is used to update the SWIFT gpi participant details.The SWIFT global payment","summary":"Update the participant details in Temenos SWIFT gpi directory. ","tags":[],"parameters":[{"name":"participantId","in":"path","type":"string","required":true,"description":""},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"resourceId":"string","participantId":"string","countryCode":"string","currencyId":"string","maximumAmount":"string","status":"string","participantName":"string","extensions":{}}},"responses":{"200":"SwiftGpiParticipantResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse","default":"ScreenErrorResponse"}},{"method":"POST","path":"/reference/bankCodes/gpi/participants","fullPath":"/api/v1.5.0/reference/bankCodes/gpi/participants","operationId":"createSwiftGpiParticipant","name":"The SWIFT global payments initiation (SWIFT gpi) is a SWIFT service that addresses the cross-border payments with the purpose of increasing their speed, transparency and end-to-end tracking. The gpi directory provided by SWIFT contains the complete list of financial institutions that act as gpi participants. The list of participants can either be downloaded from the official SWIFT site or created manually. This endpoint is used to create the SWIFT gpi participant details.","summary":"Creates the participant details in Temenos SWIFT gpi directory.","tags":[],"parameters":[{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"resourceId":"string","participantId":"string","countryCode":"string","currencyId":"string","maximumAmount":"string","status":"string","participantName":"string","extensions":{}}},"responses":{"200":"SwiftGpiParticipantResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse","default":"ScreenErrorResponse"}},{"method":"GET","path":"/reference/bankCodes/centralBankDirectoryRules/{centralBankDirectoryRulesId}","fullPath":"/api/v1.5.0/reference/bankCodes/centralBankDirectoryRules/{centralBankDirectoryRulesId}","operationId":"getReferenceDataRules","name":"Retrieves the definition indicating if central bank directory is the BIC reference data and if the validation of the BIC against the directory is enabled","summary":"Retrieves the validation information for central bank directory","tags":[],"parameters":[{"name":"centralBankDirectoryRulesId","in":"path","type":"string","required":true,"description":"Specifies the identifier of central bank directory rules. The allowed value is SYSTEM"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"ReferenceDataRulesResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse","default":"ScreenErrorResponse"}},{"method":"POST","path":"/reference/bankCodes/centralBankDirectoryRules/{centralBankDirectoryRulesId}","fullPath":"/api/v1.5.0/reference/bankCodes/centralBankDirectoryRules/{centralBankDirectoryRulesId}","operationId":"createReferenceDataRules","name":"Create the central bank directory rules with details on BIC validation and if the system has central bank directory enabled for BIC and national clearing code validation","summary":"Create the central bank directory rules","tags":[],"parameters":[{"name":"centralBankDirectoryRulesId","in":"path","type":"string","required":true,"description":"Specifies the identifier of central bank directory rules. The allowed value is SYSTEM"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"BICValidation":"string","isMainReferenceData":"string","extensions":{}}},"responses":{"200":"ReferenceDataRulesResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse","default":"ScreenErrorResponse"}},{"method":"PUT","path":"/reference/bankCodes/centralBankDirectoryRules/{centralBankDirectoryRulesId}","fullPath":"/api/v1.5.0/reference/bankCodes/centralBankDirectoryRules/{centralBankDirectoryRulesId}","operationId":"updateReferenceDataRules","name":"Update the central bank directory rules with details on BIC validation and if the system has central bank directory enabled for BIC and national clearing code validation","summary":"Update the central bank directory rules","tags":[],"parameters":[{"name":"centralBankDirectoryRulesId","in":"path","type":"string","required":true,"description":"Specifies the identifier of central bank directory rules. The allowed value is SYSTEM"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"BICValidation":"string","isMainReferenceData":"string","extensions":{}}},"responses":{"200":"ReferenceDataRulesResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse","default":"ScreenErrorResponse"}},{"method":"GET","path":"/reference/bankCodes/nationalIds/{nationalIdRef}/bics","fullPath":"/api/v1.5.0/reference/bankCodes/nationalIds/{nationalIdRef}/bics","operationId":"getBICFromNationalId","name":"Retrieves the Bank Identifier Code (BIC) or BICs for a given national id with its country code or scheme along with address details associated with the BIC. The BIC is the SWIFT address assigned to a bank in order to send automated payments to the banks concerned. It uniquely identifies the name and country of the bank and consists of 8-11 characters. Example format AAAABBCCDDD, where AAAA: 4 character bank code, BB: 2 character country code, CC: 2 character location code, DDD: optional 3 charac","summary":"Retrieves the BIC or BICs for a given national id with its country code or scheme along with BIC details","tags":[],"parameters":[{"name":"nationalIdRef","in":"path","type":"string","required":true,"description":"Indicates national indentifier reference"},{"name":"countryId","in":"query","type":"string","required":false,"description":"ISO country code of the financial institution. "},{"name":"scheme","in":"query","type":"string","required":false,"description":"Represents the scheme (a synonym for the national id type) under which the national id is defined"},{"name":"date","in":"query","type":"string","required":false,"description":"Indicates the date on which activity was performed"},{"name":"company","in":"query","type":"string","required":false,"description":"The company code"},{"name":"isoClearingCode","in":"query","type":"string","required":false,"description":"Specifies the ISO identifier of the clearing system"},{"name":"swiftPrefix","in":"query","type":"string","required":false,"description":"Prefix of country specific details in payments method"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"BICFromNationalIdResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse","default":"QueryErrorResponse"}},{"method":"GET","path":"/reference/bankCodes/nationalSystemIdentifiers/{nationalSystemIdType}/{nationalSystemId}","fullPath":"/api/v1.5.0/reference/bankCodes/nationalSystemIdentifiers/{nationalSystemIdType}/{nationalSystemId}","operationId":"getNationalSystemIdentifiers","name":"Retrieves the country national system identifiers for national system identifier reference provided.  Allowed values for  national system identifier reference are be COUNTRYCODE,SWIFTPREFIX or ISOCLEARINGID and nationalSystemId can be  of values such as US (for COUNTRYCODE) or SC (for SWIFTPREFIX) or GBDSC (for ISOCLEARINGID)","summary":"Retrieves the national system identifiers.","tags":[],"parameters":[{"name":"nationalSystemIdType","in":"path","type":"string","required":true,"description":"Specifies the type of national system id. Values can be COUNTRYCODE,SWIFTPREFIX or ISOCLEARINGID"},{"name":"nationalSystemId","in":"path","type":"string","required":true,"description":"Specifies the national system clearing system id. Sample values are US (for COUNTRYCODE) or SC (for SWIFTPREFIX) or GBDSC (for ISOCLEARINGID)"},{"name":"nationalId","in":"query","type":"string","required":false,"description":"Indicates the national id of a financial institution under national clearing system"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"NationalSystemIdentifiersResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse","default":"QueryErrorResponse"}},{"method":"GET","path":"/reference/bankCodes/bics/{bicId}/nationalIds","fullPath":"/api/v1.5.0/reference/bankCodes/bics/{bicId}/nationalIds","operationId":"getNationalIDFromBIC","name":"Retrieves the national id, the country code, address details and the code type for the specified Bank Identifier Code (BIC). If the BIC is linked to multiple national ids, then multiple results can be returned. The BIC is the SWIFT address assigned to a bank in order to send automated payments to the banks concerned. It uniquely identifies the name and country of the bank and consists of 8-11 characters. Example format AAAABBCCDDD, where AAAA: 4 character bank code, BB: 2 character country code,","summary":"Retrieves national ids and details for a BIC","tags":[],"parameters":[{"name":"bicId","in":"path","type":"string","required":true,"description":"Bank Identifier Code (BIC) of the financial institution"},{"name":"date","in":"query","type":"string","required":false,"description":"Indicates the date on which activity was performed"},{"name":"companyId","in":"query","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"NationalIDFromBICResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse","default":"QueryErrorResponse"}},{"method":"GET","path":"/reference/bankCodes/nationalSystemIdentifiers/{nationalSystemIdentifierId}","fullPath":"/api/v1.5.0/reference/bankCodes/nationalSystemIdentifiers/{nationalSystemIdentifierId}","operationId":"getNationalSystemIdentifierDetails","name":"Retrieves the national system identifier details such as iso clearing code, swift prefix, national id, national id format for national system identifier reference provided.","summary":"Retrieves the national system identifiers for the national system identifier reference provided.","tags":[],"parameters":[{"name":"nationalSystemIdentifierId","in":"path","type":"string","required":true,"description":"Contains the nationalSystemIdentifierId."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"NationalSystemIdentifierDetailsResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse","default":"ScreenErrorResponse"}},{"method":"POST","path":"/reference/bankCodes/nationalSystemIdentifiers/{nationalSystemIdentifierId}","fullPath":"/api/v1.5.0/reference/bankCodes/nationalSystemIdentifiers/{nationalSystemIdentifierId}","operationId":"createNationalSystemIdentifierDetails","name":"Creates the national system identifiers with details such as iso clearing code, swift prefix, national id,  national id format for national system identifier reference provided.","summary":"Creates the national system identifiers for national system identifier reference provided.","tags":[],"parameters":[{"name":"nationalSystemIdentifierId","in":"path","type":"string","required":true,"description":"Contains the nationalSystemIdentifierId."},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"countryId":"string","isoClearingCode":"string","swiftPrefix":"string","nationalIdFormat":"string","nationalIdType":"string","extensions":{}}},"responses":{"200":"NationalSystemIdentifierDetailsResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse","default":"ScreenErrorResponse"}},{"method":"PUT","path":"/reference/bankCodes/nationalSystemIdentifiers/{nationalSystemIdentifierId}","fullPath":"/api/v1.5.0/reference/bankCodes/nationalSystemIdentifiers/{nationalSystemIdentifierId}","operationId":"updateNationalSystemIdentifierDetails","name":"Updates the national system identifiers with details such as iso clearing code, swift prefix, national id,  national id format for national system identifier reference provided.","summary":"Updates the national system identifiers for the national system identifier reference provided.","tags":[],"parameters":[{"name":"nationalSystemIdentifierId","in":"path","type":"string","required":true,"description":"Contains the nationalSystemIdentifierId."},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"countryId":"string","isoClearingCode":"string","swiftPrefix":"string","nationalIdFormat":"string","nationalIdType":"string","extensions":{}}},"responses":{"200":"NationalSystemIdentifierDetailsResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse","default":"ScreenErrorResponse"}},{"method":"POST","path":"/reference/bankCodes/centralBankDirectories","fullPath":"/api/v1.5.0/reference/bankCodes/centralBankDirectories","operationId":"createCentralBankDirectory","name":"The centralised bank directory contains the BIC and national id related data for the financial institutions. It is also referred as bank directory plus as it is uploaded from SWIFTRef bank directory plus file. It can also be created manually. This endpoint is used to create the central bank directory details.","summary":"Creates the\u00c2\u00a0BIC and national id related data for the financial institutions","tags":[],"parameters":[{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"beneficiaryInstituteNames":[{}],"beneficiaryInstituteBranchNames":[{}],"address":[{}],"bicLocations":[{}],"countryNames":[{}],"beneficiaryInstituteCity":"string","status":"string","nationalId":"string","bicId":"string","countryCode":"string","bankLegalEntityIdentifier":"string","scheme":"string","zip":"string","postCode":"string","officeType":"string"}},"responses":{"200":"CentralBankDirectoryResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse","default":"ScreenErrorResponse"}}]},{"key":"reference-organizationStructures-services-v1.0.0","title":"Organization Structure","version":"v1.0.0","description":"API retrieves the organization structure details defined in the system","endpointCount":6,"endpoints":[{"method":"GET","path":"/reference/organizationStructures/{organizationId}","fullPath":"/api/v1.0.0/reference/organizationStructures/{organizationId}","operationId":"getOrganizationHierarchy","name":"Retrieve the name, immediate parent organization and hierarchy defined for the specified organization","summary":"Retrieve the Organization code details","tags":[],"parameters":[{"name":"organizationId","in":"path","type":"string","required":true,"description":"Identifier of Organization Code "},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"The identifier of the underlying Entity/Company/Branch."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"OrganizationHierarchyResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"POST","path":"/reference/organizationStructures/{organizationId}","fullPath":"/api/v1.0.0/reference/organizationStructures/{organizationId}","operationId":"createOrganizationHierarchy","name":"Create the name, immediate parent organization and hierarchy defined for the specified organization","summary":"Create the Organization code details","tags":[],"parameters":[{"name":"organizationId","in":"path","type":"string","required":true,"description":"Identifier of Organization Code"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"The identifier of the underlying Entity/Company/Branch."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"organizationNames":[{}],"parent":"string","level":0.0}},"responses":{"200":"OrganizationHierarchyResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/reference/organizationStructures/{organizationId}","fullPath":"/api/v1.0.0/reference/organizationStructures/{organizationId}","operationId":"updateOrganizationHierarchy","name":"Update the name, immediate parent organization and hierarchy defined for the specified organization","summary":"Update the Organization code details","tags":[],"parameters":[{"name":"organizationId","in":"path","type":"string","required":true,"description":"Identifier of Organization Code"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"The identifier of the underlying Entity/Company/Branch."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"organizationNames":[{}],"parent":"string","level":0.0}},"responses":{"200":"OrganizationHierarchyResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/reference/organizationStructures/{organizationId}/childOrganizations","fullPath":"/api/v1.0.0/reference/organizationStructures/{organizationId}/childOrganizations","operationId":"getChildOrganizations","name":"Retrieves the list of all child organization reference associated with the specified organization","summary":"Retrieves the child organizations","tags":[],"parameters":[{"name":"organizationId","in":"path","type":"string","required":true,"description":"Identifier of Organization Code"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from t24 on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"The identifier of the underlying Entity/Company/Branch."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"ChildOrganizationsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/reference/organizationStructures/branches/{branchId}","fullPath":"/api/v1.0.0/reference/organizationStructures/branches/{branchId}","operationId":"getOrganizationBranchName","name":"Retrieve the name of branch that can be used as branch enrichment by any application","summary":"Retrieve the branch name","tags":[],"parameters":[{"name":"branchId","in":"path","type":"string","required":true,"description":"Unique and unambiguous identification of a branch of a financial institution."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"The identifier of the underlying Entity/Company/Branch."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"OrganizationBranchNameResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/reference/organizationStructures/lineOfBusiness/{lineOfBusinessId}","fullPath":"/api/v1.0.0/reference/organizationStructures/lineOfBusiness/{lineOfBusinessId}","operationId":"getLineOfBusinessName","name":"Retrieves the line of business name defined for the specified organization.","summary":"Retrieves the line of business","tags":[],"parameters":[{"name":"lineOfBusinessId","in":"path","type":"string","required":true,"description":"Identifier of the line of business provided by the branch"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"The identifier of the underlying Entity/Company/Branch."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"LineOfBusinessNameResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}}]},{"key":"reference-organizationStructures-services-v1.1.0","title":"Organization Structure","version":"v1.1.0","description":"API retrieves the organization structure details defined in the system","endpointCount":12,"endpoints":[{"method":"GET","path":"/reference/organizationStructures/{organizationId}","fullPath":"/api/v1.1.0/reference/organizationStructures/{organizationId}","operationId":"getOrganizationHierarchy","name":"Retrieve the name, immediate parent organization and hierarchy defined for the specified organization","summary":"Retrieve the Organization code details","tags":[],"parameters":[{"name":"organizationId","in":"path","type":"string","required":true,"description":"Identifier of Organization Code "},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"The identifier of the underlying Entity/Company/Branch."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"OrganizationHierarchyResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"POST","path":"/reference/organizationStructures/{organizationId}","fullPath":"/api/v1.1.0/reference/organizationStructures/{organizationId}","operationId":"createOrganizationHierarchy","name":"Create the name, immediate parent organization and hierarchy defined for the specified organization","summary":"Create the Organization code details","tags":[],"parameters":[{"name":"organizationId","in":"path","type":"string","required":true,"description":"Identifier of Organization Code"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"The identifier of the underlying Entity/Company/Branch."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"organizationNames":[{}],"parent":"string","level":0.0}},"responses":{"200":"OrganizationHierarchyResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/reference/organizationStructures/{organizationId}","fullPath":"/api/v1.1.0/reference/organizationStructures/{organizationId}","operationId":"updateOrganizationHierarchy","name":"Update the name, immediate parent organization and hierarchy defined for the specified organization","summary":"Update the Organization code details","tags":[],"parameters":[{"name":"organizationId","in":"path","type":"string","required":true,"description":"Identifier of Organization Code"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"The identifier of the underlying Entity/Company/Branch."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"organizationNames":[{}],"parent":"string","level":0.0}},"responses":{"200":"OrganizationHierarchyResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/reference/organizationStructures/{organizationId}/childOrganizations","fullPath":"/api/v1.1.0/reference/organizationStructures/{organizationId}/childOrganizations","operationId":"getChildOrganizations","name":"Retrieves the list of all child organization reference associated with the specified organization","summary":"Retrieves the child organizations","tags":[],"parameters":[{"name":"organizationId","in":"path","type":"string","required":true,"description":"Identifier of Organization Code"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from t24 on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"The identifier of the underlying Entity/Company/Branch."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"ChildOrganizationsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/reference/organizationStructures/branches/{branchId}","fullPath":"/api/v1.1.0/reference/organizationStructures/branches/{branchId}","operationId":"getOrganizationBranchName","name":"Retrieve the name of branch that can be used as branch enrichment by any application","summary":"Retrieve the branch name","tags":[],"parameters":[{"name":"branchId","in":"path","type":"string","required":true,"description":"Unique and unambiguous identification of a branch of a financial institution."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"The identifier of the underlying Entity/Company/Branch."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"OrganizationBranchNameResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/reference/organizationStructures/branches/{branchId}","fullPath":"/api/v1.1.0/reference/organizationStructures/branches/{branchId}","operationId":"updateBranchName","name":"The branch is one of the entity in the organization hierarchy. The branch details get created automatically when the organization code for the branch is created. This endpoint is used to update the branch name","summary":"Update the branch name which is a part of organization structure.","tags":[],"parameters":[{"name":"branchId","in":"path","type":"string","required":true,"description":"Unique and unambiguous identification of a branch of a financial institution."},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"The identifier of the underlying Entity/Company/Branch."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"branchNames":[{}]}},"responses":{"200":"BranchNameResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/reference/organizationStructures/lineOfBusiness/{lineOfBusinessId}","fullPath":"/api/v1.1.0/reference/organizationStructures/lineOfBusiness/{lineOfBusinessId}","operationId":"getLineOfBusinessName","name":"Retrieves the line of business name defined for the specified organization.","summary":"Retrieves the line of business","tags":[],"parameters":[{"name":"lineOfBusinessId","in":"path","type":"string","required":true,"description":"Identifier of the line of business provided by the branch"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"The identifier of the underlying Entity/Company/Branch."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"LineOfBusinessNameResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"POST","path":"/reference/organizationStructures/lineOfBusiness/{lineOfBusinessId}","fullPath":"/api/v1.1.0/reference/organizationStructures/lineOfBusiness/{lineOfBusinessId}","operationId":"createLineOfBusiness","name":"In the organization hierarchy, the line of business is defined to distinctly define different cost centres for bank, and align them later to a particular branch depending on its construct and requirement. This endpoint is used to create the line of business","summary":"Create the line of business to define the cost centres in the organization hierarchy","tags":[],"parameters":[{"name":"lineOfBusinessId","in":"path","type":"string","required":true,"description":"Identifier of the line of business provided by the branch"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"The identifier of the underlying Entity/Company/Branch."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"displayNames":[{}]}},"responses":{"200":"LineOfBusinessResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/reference/organizationStructures/lineOfBusiness/{lineOfBusinessId}","fullPath":"/api/v1.1.0/reference/organizationStructures/lineOfBusiness/{lineOfBusinessId}","operationId":"updateLineOfBusiness","name":"In the Organization hierarchy, the Line Of Business is defined to distinctly define different Cost Centres for bank, and align them later to a particular branch depending on its construct and requirement. This endpoint is used to update the Line of Business","summary":"Update the Line of Business to define the Cost centres in the Organization Hierarchy","tags":[],"parameters":[{"name":"lineOfBusinessId","in":"path","type":"string","required":true,"description":"Identifier of the line of business provided by the branch"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"The identifier of the underlying Entity/Company/Branch."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"displayNames":[{}]}},"responses":{"200":"LineOfBusinessResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/reference/organizationStructures/hierarchies/{hierarchyId}","fullPath":"/api/v1.1.0/reference/organizationStructures/hierarchies/{hierarchyId}","operationId":"getOraganizationStructureHierarchy","name":"The user can define the organization structure with appropriate hierarchy of the bank. For example, Bank>Region>Division>Branch This is a system wide configuration for the bank. So, the @ID as SYSTEM This endpoint is used to retrieve the details in organization hierarchy details","summary":"Retrieves the child organization reference associated with the specified organization. ","tags":[],"parameters":[{"name":"hierarchyId","in":"path","type":"string","required":true,"description":"Indicates the organization hierarchy. The allowed value is SYSTEM."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"The identifier of the underlying Entity/Company/Branch."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"OraganizationStructureHierarchyResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"POST","path":"/reference/organizationStructures/hierarchies/{hierarchyId}","fullPath":"/api/v1.1.0/reference/organizationStructures/hierarchies/{hierarchyId}","operationId":"createOrganizationStructureHierarchy","name":"The user can define the organization structure with appropriate hierarchy of the bank. For example, Bank>Region>Division>Branch This is a system wide configuration for the bank. So, the @ID as SYSTEM This endpoint is used to update the organization hierarchy details as appropriate for the SYSTEM.","summary":"Creates the child organization reference associated with the specified organization. ","tags":[],"parameters":[{"name":"hierarchyId","in":"path","type":"string","required":true,"description":"Indicates the organization hierarchy. The allowed value is SYSTEM."},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"The identifier of the underlying Entity/Company/Branch."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"organizationStructureDetails":[{}]}},"responses":{"200":"OrganizationStructureHierarchyResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/reference/organizationStructures/hierarchies/{hierarchyId}","fullPath":"/api/v1.1.0/reference/organizationStructures/hierarchies/{hierarchyId}","operationId":"updateOrganizationStructureHierarchy","name":"The user can define the organization structure with appropriate hierarchy of the bank. For example, Bank>Region>Division>Branch This is a system wide configuration for the bank. So, the @ID as SYSTEM This endpoint is used to update the organization hierarchy details as appropriate for the SYSTEM.","summary":"Update the child organization reference associated with the specified organization. ","tags":[],"parameters":[{"name":"hierarchyId","in":"path","type":"string","required":true,"description":"Indicates the organization hierarchy. The allowed value is SYSTEM."},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"The identifier of the underlying Entity/Company/Branch."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"organizationStructureDetails":[{}]}},"responses":{"200":"OrganizationStructureHierarchyResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}}]},{"key":"reference-organizationStructures-services-v1.2.0","title":"Organization Structure","version":"v1.2.0","description":"API retrieves the organization structure details defined in the system","endpointCount":13,"endpoints":[{"method":"GET","path":"/reference/organizationStructures/{organizationId}","fullPath":"/api/v1.2.0/reference/organizationStructures/{organizationId}","operationId":"getOrganizationHierarchy","name":"Retrieve the name, immediate parent organization and hierarchy defined for the specified organization","summary":"Retrieve the organization code details","tags":[],"parameters":[{"name":"organizationId","in":"path","type":"string","required":true,"description":"Identifier of Organization Code "},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"The identifier of the underlying Entity/Company/Branch."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"OrganizationHierarchyResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"POST","path":"/reference/organizationStructures/{organizationId}","fullPath":"/api/v1.2.0/reference/organizationStructures/{organizationId}","operationId":"createOrganizationHierarchy","name":"Create the name, immediate parent organization and hierarchy defined for the specified organization","summary":"Create the organization code details","tags":[],"parameters":[{"name":"organizationId","in":"path","type":"string","required":true,"description":"Identifier of Organization Code"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"The identifier of the underlying Entity/Company/Branch."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"organizationNames":[{}],"parent":"string","level":0.0,"extensionData":{}}},"responses":{"200":"OrganizationHierarchyResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/reference/organizationStructures/{organizationId}","fullPath":"/api/v1.2.0/reference/organizationStructures/{organizationId}","operationId":"updateOrganizationHierarchy","name":"Update the name, immediate parent organization and hierarchy defined for the specified organization","summary":"Update the organization code details","tags":[],"parameters":[{"name":"organizationId","in":"path","type":"string","required":true,"description":"Identifier of Organization Code"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"The identifier of the underlying Entity/Company/Branch."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"organizationNames":[{}],"parent":"string","level":0.0,"extensionData":{}}},"responses":{"200":"OrganizationHierarchyResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/reference/organizationStructures/branches/{branchId}","fullPath":"/api/v1.2.0/reference/organizationStructures/branches/{branchId}","operationId":"getOrganizationBranchName","name":"Retrieve the name of branch that can be used as branch enrichment by any application","summary":"Retrieve the branch name","tags":[],"parameters":[{"name":"branchId","in":"path","type":"string","required":true,"description":"Unique and unambiguous identification of a branch of a financial institution."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"The identifier of the underlying Entity/Company/Branch."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"OrganizationBranchNameResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/reference/organizationStructures/branches/{branchId}","fullPath":"/api/v1.2.0/reference/organizationStructures/branches/{branchId}","operationId":"updateBranchName","name":"The branch is one of the entity in the organization hierarchy. The branch details get created automatically when the organization code for the branch is created. This endpoint is used to update the branch name","summary":"Update the branch name which is a part of organization structure.","tags":[],"parameters":[{"name":"branchId","in":"path","type":"string","required":true,"description":"Unique and unambiguous identification of a branch of a financial institution."},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"The identifier of the underlying Entity/Company/Branch."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"branchNames":[{}],"extensionData":{}}},"responses":{"200":"BranchNameResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/reference/organizationStructures/lineOfBusiness/{lineOfBusinessId}","fullPath":"/api/v1.2.0/reference/organizationStructures/lineOfBusiness/{lineOfBusinessId}","operationId":"getLineOfBusinessName","name":"Retrieves the line of business name defined for the specified organization.","summary":"Retrieves the line of business","tags":[],"parameters":[{"name":"lineOfBusinessId","in":"path","type":"string","required":true,"description":"Identifier of the line of business provided by the branch"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"The identifier of the underlying Entity/Company/Branch."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"LineOfBusinessNameResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"POST","path":"/reference/organizationStructures/lineOfBusiness/{lineOfBusinessId}","fullPath":"/api/v1.2.0/reference/organizationStructures/lineOfBusiness/{lineOfBusinessId}","operationId":"createLineOfBusiness","name":"In the organization hierarchy, the line of business is defined to distinctly define different cost centres for bank, and align them later to a particular branch depending on its construct and requirement. This endpoint is used to create the line of business","summary":"Create the line of business to define the cost centres in the organization hierarchy","tags":[],"parameters":[{"name":"lineOfBusinessId","in":"path","type":"string","required":true,"description":"Identifier of the line of business provided by the branch"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"The identifier of the underlying Entity/Company/Branch."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"displayNames":[{}],"extensionData":{}}},"responses":{"200":"LineOfBusinessResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/reference/organizationStructures/lineOfBusiness/{lineOfBusinessId}","fullPath":"/api/v1.2.0/reference/organizationStructures/lineOfBusiness/{lineOfBusinessId}","operationId":"updateLineOfBusiness","name":"In the organization hierarchy, the line of business is defined to distinctly define different cost centres for bank, and align them later to a particular branch depending on its construct and requirement. This endpoint is used to update the line of business","summary":"Update the line of business to define the cost centres in the organization hierarchy","tags":[],"parameters":[{"name":"lineOfBusinessId","in":"path","type":"string","required":true,"description":"Identifier of the line of business provided by the branch"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"The identifier of the underlying Entity/Company/Branch."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"displayNames":[{}],"extensionData":{}}},"responses":{"200":"LineOfBusinessResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/reference/organizationStructures/hierarchies/{hierarchyId}","fullPath":"/api/v1.2.0/reference/organizationStructures/hierarchies/{hierarchyId}","operationId":"getOraganizationStructureHierarchy","name":"The user can define the organization structure with appropriate hierarchy of the bank. For example, Bank>Region>Division>Branch. This is a system wide configuration for the bank, so the primary key hierarchyId has to be SYSTEM. This endpoint is used to retrieve the details in organization hierarchy details","summary":"Retrieves the child organization reference associated with the specified organization. ","tags":[],"parameters":[{"name":"hierarchyId","in":"path","type":"string","required":true,"description":"Indicates the organization hierarchy. The allowed value is SYSTEM."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"The identifier of the underlying Entity/Company/Branch."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"OraganizationStructureHierarchyResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"POST","path":"/reference/organizationStructures/hierarchies/{hierarchyId}","fullPath":"/api/v1.2.0/reference/organizationStructures/hierarchies/{hierarchyId}","operationId":"createOrganizationStructureHierarchy","name":"The user can define the organization structure with appropriate hierarchy of the bank. For example, Bank>Region>Division>Branch. This is a system wide configuration for the bank, so the primary key hierarchyId has to be SYSTEM. This endpoint is used to update the organization hierarchy details as appropriate for the SYSTEM.","summary":"Creates the child organization reference associated with the specified organization. ","tags":[],"parameters":[{"name":"hierarchyId","in":"path","type":"string","required":true,"description":"Indicates the organization hierarchy. The allowed value is SYSTEM."},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"The identifier of the underlying Entity/Company/Branch."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"organizationStructureDetails":[{}],"extensionData":{}}},"responses":{"200":"OrganizationStructureHierarchyResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/reference/organizationStructures/hierarchies/{hierarchyId}","fullPath":"/api/v1.2.0/reference/organizationStructures/hierarchies/{hierarchyId}","operationId":"updateOrganizationStructureHierarchy","name":"The user can define the organization structure with appropriate hierarchy of the bank. For example, Bank>Region>Division>Branch. This is a system wide configuration for the bank, so the primary key hierarchyId has to be SYSTEM. This endpoint is used to update the organization hierarchy details as appropriate for the SYSTEM.","summary":"Update the child organization reference associated with the specified organization. ","tags":[],"parameters":[{"name":"hierarchyId","in":"path","type":"string","required":true,"description":"Indicates the organization hierarchy. The allowed value is SYSTEM."},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"The identifier of the underlying Entity/Company/Branch."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"organizationStructureDetails":[{}],"extensionData":{}}},"responses":{"200":"OrganizationStructureHierarchyResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/reference/organizationStructures/{organizationId}/childOrganizations","fullPath":"/api/v1.2.0/reference/organizationStructures/{organizationId}/childOrganizations","operationId":"getChildOrganizations","name":"Retrieves the list of all child organization reference associated with the specified organization","summary":"Retrieves the child organizations","tags":[],"parameters":[{"name":"organizationId","in":"path","type":"string","required":true,"description":"Identifier of organization code"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"The identifier of the underlying Entity/Company/Branch."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"ChildOrganizationsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/reference/organizationStructures","fullPath":"/api/v1.2.0/reference/organizationStructures","operationId":"getOrganizationHierarchies","name":"Retrieves the organization name, immediate parent organization and hierarchies of all the organizations in the system","summary":"Retrieves the list of organization code details","tags":[],"parameters":[{"name":"organizationId","in":"query","type":"string","required":false,"description":"Identifier of organization Code "},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"The identifier of the underlying Entity/Company/Branch."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"OrganizationHierarchiesResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}}]},{"key":"reference-periodDates-service-v1.0.0","title":"Treasury time buckets","version":"v1.0.0","description":"API to retrieve periods and dates for defined time buckets TOM (tomorrow), Spot, Spot next etc.","endpointCount":1,"endpoints":[{"method":"GET","path":"/reference/periodDates/{currencyOrPair}","fullPath":"/api/v1.0.0/reference/periodDates/{currencyOrPair}","operationId":"getPeriodDates","name":"Retrieves reference period dates under different time buckets for a currency or currency pair ","summary":"Retrieves reference period dates","tags":[],"parameters":[{"name":"currencyOrPair","in":"path","type":"string","required":true,"description":"A single currency or a currency pair."},{"name":"fromDate","in":"query","type":"string","required":false,"description":"Indicates the business date from when the balance reservation event is active."},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from t24 on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"The identifier of the underlying Entity/Company/Branch."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"PeriodDatesResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}}]},{"key":"reference-portfolioAccounts-service-v1.0.0","title":"Portfolio Accounts","version":"v1.0.0","description":"Allows to view the accounts of portfolios","endpointCount":1,"endpoints":[{"method":"GET","path":"/reference/portfolios/{portfolioId}/accounts","fullPath":"/api/v1.0.0/reference/portfolios/{portfolioId}/accounts","operationId":"getPortfolioAccounts","name":"","summary":"","tags":[],"parameters":[{"name":"portfolioId","in":"path","type":"string","required":true,"description":"Id of the portfolio or security account"},{"name":"customerId","in":"query","type":"string","required":false,"description":"The identifier of the customer"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from t24 on every enquiry request."},{"name":"credentials","in":"query","type":"string","required":false,"description":""},{"name":"companyId","in":"query","type":"string","required":false,"description":""}],"requestBodyExample":null,"responses":{"200":"PortfolioAccountsResponse","default":"QueryErrorResponse"}}]},{"key":"reference-portfolioFacilities-service-v1.0.0","title":"Credit facility products","version":"v1.0.0","description":"Allows retriving the facility products available in the system to enable part pledging of security positions as collateral.","endpointCount":1,"endpoints":[{"method":"GET","path":"/reference/portfolios/facilities/settings","fullPath":"/api/v1.0.0/reference/portfolios/facilities/settings","operationId":"getPortfolioFacilitiesSettings","name":"Retrieves the share facility products available in the system","summary":"Retrieves the share facility products available in the system","tags":[],"parameters":[{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"PortfolioFacilitiesSettingsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}}]},{"key":"reference-portfolioInvestmentProgram-service-v1.0.0","title":"Investment program","version":"v1.0.0","description":"Allows the management of investment profile details","endpointCount":3,"endpoints":[{"method":"GET","path":"/reference/investmentProgram/{id}","fullPath":"/api/v1.0.0/reference/investmentProgram/{id}","operationId":"getInvestmentProgram","name":"Retrieves details of investment profile for the given investment program","summary":"Retrieves investment profile","tags":["WEALTH"],"parameters":[{"name":"id","in":"path","type":"string","required":true,"description":"Contains the daily position class id."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"InvestmentProgramResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"POST","path":"/reference/investmentProgram/{id}","fullPath":"/api/v1.0.0/reference/investmentProgram/{id}","operationId":"createInvestmentProgram","name":"Creates investment profile for the given investment program","summary":"Creates investment profile","tags":["WEALTH"],"parameters":[{"name":"id","in":"path","type":"string","required":true,"description":"Contains the daily position class id."},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"descriptionDetails":[{}],"displayNameDetails":[{}],"creditPolicy":"string","extensions":{}}},"responses":{"200":"InvestmentProgramResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/reference/investmentProgram/{id}","fullPath":"/api/v1.0.0/reference/investmentProgram/{id}","operationId":"updateInvestmentProgram","name":"Updates details  of investment profile for the given investment program","summary":"Updates investment profile","tags":["WEALTH"],"parameters":[{"name":"id","in":"path","type":"string","required":true,"description":"Contains the daily position class id."},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"descriptionDetails":[{}],"displayNameDetails":[{}],"creditPolicy":"string","extensions":{}}},"responses":{"200":"InvestmentProgramResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}}]},{"key":"reference-postingRestrictions-service-v1.0.0","title":"Posting restriction details","version":"v1.0.0","description":"API to define any type of posting restrictions which may be imposed on Accounts or Customers. Posting restriction determines whether specific transaction should be approved or restricted based on the definition. It manages the details such as restriction type, restriction reason, restriction removal","endpointCount":3,"endpoints":[{"method":"GET","path":"/reference/postingRestrictions/{postingRestrictId}","fullPath":"/api/v1.0.0/reference/postingRestrictions/{postingRestrictId}","operationId":"getPostingRestriction","name":"Retrieve the posting restriction details such as restriction type, restriction reason, restriction removal reason, allow transaction and transaction code.","summary":"Retrieves posting restriction details","tags":[],"parameters":[{"name":"postingRestrictId","in":"path","type":"string","required":true,"description":"Identifies any restrictions for posting entries that are imposed on a Customer"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"PostingRestrictionResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"POST","path":"/reference/postingRestrictions/{postingRestrictId}","fullPath":"/api/v1.0.0/reference/postingRestrictions/{postingRestrictId}","operationId":"createPostingRestriction","name":"Create the posting restriction with details such as restriction type, restriction reason, restriction removal reason, allow transaction and transaction code.","summary":"Creates posting restriction details.","tags":[],"parameters":[{"name":"postingRestrictId","in":"path","type":"string","required":true,"description":"Identifies any restrictions for posting entries that are imposed on a Customer"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"transactionCodes":[{}],"restrictionReasons":[{}],"restrictionRemovalReasons":[{}],"displayName":"string","restrictType":"string","creditRiskOfficer":"string","allowTransaction":"string","override":"string","extensions":{}}},"responses":{"200":"PostingRestrictionResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/reference/postingRestrictions/{postingRestrictId}","fullPath":"/api/v1.0.0/reference/postingRestrictions/{postingRestrictId}","operationId":"updatePostingRestriction","name":"Update the posting restriction with details such as restriction type, restriction reason, restriction removal reason, allow transaction and transaction code.","summary":"Updates posting restriction details.","tags":[],"parameters":[{"name":"postingRestrictId","in":"path","type":"string","required":true,"description":"Identifies any restrictions for posting entries that are imposed on a Customer"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"transactionCodes":[{}],"restrictionReasons":[{}],"restrictionRemovalReasons":[{}],"displayName":"string","restrictType":"string","creditRiskOfficer":"string","allowTransaction":"string","override":"string","extensions":{}}},"responses":{"200":"PostingRestrictionResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}}]},{"key":"reference-postingRestrictions-service-v1.1.0","title":"Posting Restrictions","version":"v1.1.0","description":"API to define any type of posting restrictions which may be imposed on accounts or customers. Posting restriction determines whether specific transaction should be approved or restricted based on the definition. It manages the details such as restriction type, restriction reason, restriction removal","endpointCount":4,"endpoints":[{"method":"GET","path":"/reference/postingRestrictions/{postingRestrictId}","fullPath":"/api/v1.1.0/reference/postingRestrictions/{postingRestrictId}","operationId":"getPostingRestriction","name":"Retrieve the specified posting restriction details such as restriction type, restriction reason, restriction removal reason, allowed or excluded transaction codes.","summary":"Retrieves posting restriction type","tags":["RETAIL"],"parameters":[{"name":"postingRestrictId","in":"path","type":"string","required":true,"description":"Identifies any restrictions for posting entries that are imposed on a Customer"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"PostingRestrictionResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"POST","path":"/reference/postingRestrictions/{postingRestrictId}","fullPath":"/api/v1.1.0/reference/postingRestrictions/{postingRestrictId}","operationId":"createPostingRestriction","name":"Create the posting restriction with details such as restriction type, restriction reason, restriction removal reason, allowed or excluded transaction codes.","summary":"Creates posting restriction type","tags":["RETAIL"],"parameters":[{"name":"postingRestrictId","in":"path","type":"string","required":true,"description":"Identifies any restrictions for posting entries that are imposed on a Customer"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"transactionCodes":[{}],"restrictionReasons":[{}],"restrictionRemovalReasons":[{}],"displayName":"string","restrictType":"string","creditRiskOfficer":"string","allowTransaction":"string","override":"string","extensions":{}}},"responses":{"200":"PostingRestrictionResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/reference/postingRestrictions/{postingRestrictId}","fullPath":"/api/v1.1.0/reference/postingRestrictions/{postingRestrictId}","operationId":"updatePostingRestriction","name":"Update the posting restriction with details such as restriction type, restriction reason, restriction removal reason, allowed or excluded transaction codes.","summary":"Updates posting restriction type","tags":["RETAIL"],"parameters":[{"name":"postingRestrictId","in":"path","type":"string","required":true,"description":"Identifies any restrictions for posting entries that are imposed on a Customer"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"transactionCodes":[{}],"restrictionReasons":[{}],"restrictionRemovalReasons":[{}],"displayName":"string","restrictType":"string","creditRiskOfficer":"string","allowTransaction":"string","override":"string","extensions":{}}},"responses":{"200":"PostingRestrictionResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/reference/postingRestrictions","fullPath":"/api/v1.1.0/reference/postingRestrictions","operationId":"getPostingRestrictions","name":"Retrieve the posting restriction details such as restriction type, restriction reason, restriction removal reason, allowed or excluded transaction codes..","summary":"Retrieves the list of posting restriction types","tags":["RETAIL"],"parameters":[{"name":"postingRestrictId","in":"query","type":"string","required":false,"description":"Identifies any restrictions for posting entries that are imposed on a Customer"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"PostingRestrictionsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}}]},{"key":"reference-product-v1.0.0","title":"Product Rules","version":"v1.0.0","description":"API to retrieve the detail of various rules associated with products","endpointCount":1,"endpoints":[{"method":"GET","path":"/reference/products/rules/{ruleId}/periodic","fullPath":"/api/v1.0.0/reference/products/rules/{ruleId}/periodic","operationId":"getPeriodicRule","name":"Retrieves the details of periodic rule associated with the product for the given rule Id","summary":"Retrieves the details of  periodic rule for the given rule Id","tags":["RETAIL"],"parameters":[{"name":"ruleId","in":"path","type":"string","required":true,"description":"Used to provide the rule for non-financial transaction, for identified related signatory groups and Minimum number of signatories"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from t24 on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"The identifier of the underlying Entity/Company/Branch."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"PeriodicRuleResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}}]},{"key":"reference-relations-service-v1.0.0","title":"Relationship Type","version":"v1.0.0","description":"API to retrieve the details of relationship types that are used to specify various types of relations that could exist between customers","endpointCount":4,"endpoints":[{"method":"GET","path":"/reference/relationships","fullPath":"/api/v1.0.0/reference/relationships","operationId":"getRelationships","name":"Retrieve all the relationships","summary":"Retrieve the relationships","tags":[],"parameters":[{"name":"relationshipId","in":"query","type":"string","required":false,"description":"Indicates the nature of the relationship between the two parties"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"RelationshipsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/reference/relationships/{relationshipId}","fullPath":"/api/v1.0.0/reference/relationships/{relationshipId}","operationId":"getRelationshipDetails","name":"Retrieve the relationship details such as the relationship name, associated relationship type and associated relationship name","summary":"Retrieve the relationship details","tags":[],"parameters":[{"name":"relationshipId","in":"path","type":"string","required":true,"description":"Indicates the nature of the relationship between the two parties"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"RelationshipDetailsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"POST","path":"/reference/relationships/{relationshipId}","fullPath":"/api/v1.0.0/reference/relationships/{relationshipId}","operationId":"createRelationship","name":"Creates the relationship type with details such as the relationship name, associated relationship and group relationship details","summary":"Create the relationship  ","tags":[],"parameters":[{"name":"relationshipId","in":"path","type":"string","required":true,"description":"Indicates the nature of the relationship between the two parties"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"reverseRelations":[{}],"relationIds":[{}],"sectorIds":[{}],"relationshipName":"string","isGroupRelation":"string","isOwner":"string","isChildRelation":"string","isParentRelation":"string","isCustomerRelation":"string","aggregateCustomerRelation":"string","extensions":{}}},"responses":{"200":"RelationshipResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/reference/relationships/{relationshipId}","fullPath":"/api/v1.0.0/reference/relationships/{relationshipId}","operationId":"updateRelationship","name":"Updates the relationship type with details such as the relationship name, associated relationship and group relationship details","summary":"Update the relationship","tags":[],"parameters":[{"name":"relationshipId","in":"path","type":"string","required":true,"description":"Indicates the nature of the relationship between the two parties"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"reverseRelations":[{}],"relationIds":[{}],"sectorIds":[{}],"relationshipName":"string","isGroupRelation":"string","isOwner":"string","isChildRelation":"string","isParentRelation":"string","isCustomerRelation":"string","aggregateCustomerRelation":"string","extensions":{}}},"responses":{"200":"RelationshipResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}}]},{"key":"reference-reserveFunds-service-v1.0.0","title":"Reserve Funds Types","version":"v1.0.0","description":"API to create, update, retrieve and delete funds reservation type which indicates whether funds blocked or reserved using this type must be applied to single account or group of accounts in a cash pooling facility","endpointCount":4,"endpoints":[{"method":"GET","path":"/reference/reservedFunds/reservationTypes/{reservationTypeId}","fullPath":"/api/v1.0.0/reference/reservedFunds/reservationTypes/{reservationTypeId}","operationId":"getFundsReservationType","name":"Retrieves funds reservation types that indicates whether funds blocked or reserved using those type must be applied to single account or group of accounts in a cash pooling facility","summary":"Retrieves the type of funds reservation","tags":[],"parameters":[{"name":"reservationTypeId","in":"path","type":"string","required":true,"description":"Identifier of locked event type"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"FundsReservationTypeResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"POST","path":"/reference/reservedFunds/reservationTypes/{reservationTypeId}","fullPath":"/api/v1.0.0/reference/reservedFunds/reservationTypes/{reservationTypeId}","operationId":"createFundsReservationType","name":"Create funds reservation type to indicate whether funds blocked or reserved using this type must be applied to single account or group of accounts in a cash pooling facility","summary":"Create type of funds reservation","tags":[],"parameters":[{"name":"reservationTypeId","in":"path","type":"string","required":true,"description":"Identifier of locked event type"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"displayNames":[{}],"accountLink":"string"}},"responses":{"200":"FundsReservationTypeResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/reference/reservedFunds/reservationTypes/{reservationTypeId}","fullPath":"/api/v1.0.0/reference/reservedFunds/reservationTypes/{reservationTypeId}","operationId":"updateFundsReservationType","name":"Update funds reservation type to indicate whether funds blocked or reserved using this type must be applied to single account or group of accounts in a cash pooling facility","summary":"Update type of funds reservation","tags":[],"parameters":[{"name":"reservationTypeId","in":"path","type":"string","required":true,"description":"Identifier of locked event type"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"displayNames":[{}],"accountLink":"string"}},"responses":{"200":"FundsReservationTypeResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"DELETE","path":"/reference/reservedFunds/reservationTypes/{reservationTypeId}","fullPath":"/api/v1.0.0/reference/reservedFunds/reservationTypes/{reservationTypeId}","operationId":"deleteFundsReservationType","name":"Deletes funds reservation type that indicates whether funds blocked or reserved using this type must be applied to single account or group of accounts in a cash pooling facility","summary":"Delete funds reservation type","tags":[],"parameters":[{"name":"reservationTypeId","in":"path","type":"string","required":true,"description":"Identifier of locked event type"},{"name":"payload","in":"body","type":"object","required":false,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}}},"responses":{"200":"FundsReservationTypeResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}}]},{"key":"reference-roundingRule-service-v1.0.0","title":"Rounding rules","version":"v1.0.0","description":"API to retrieve rounding rule details defined in the system","endpointCount":4,"endpoints":[{"method":"GET","path":"/reference/roundingRules/{ruleId}","fullPath":"/api/v1.0.0/reference/roundingRules/{ruleId}","operationId":"getRoundingRuleDetails","name":"Retrieve the details of rounding rule such as rounding type, description, no of decimals, lowest unit and rounding fractions.","summary":"Retrieve the details of rounding rule","tags":[],"parameters":[{"name":"ruleId","in":"path","type":"string","required":true,"description":"Identifier of rounding rule"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"The identifier of the underlying Entity/Company/Branch."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"RoundingRuleDetailsResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"POST","path":"/reference/roundingRules/{ruleId}","fullPath":"/api/v1.0.0/reference/roundingRules/{ruleId}","operationId":"createRoundingRuleDetails","name":"Create the details of rounding rule such as rounding type, description, no of decimals, lowest unit and rounding fractions.","summary":"Create the details of rounding rule","tags":[],"parameters":[{"name":"ruleId","in":"path","type":"string","required":true,"description":"Used to provide the rule for non-financial transaction, for identified related signatory groups and Minimum number of signatories"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"The identifier of the underlying Entity/Company/Branch."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"ruleNames":[{}],"rounding":"string","minimumAmount":"string","numberOfDecimals":"string","fractionalOrder":"string","preRoundToSixDecimal":"string"}},"responses":{"200":"RoundingRuleDetailsResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/reference/roundingRules/{ruleId}","fullPath":"/api/v1.0.0/reference/roundingRules/{ruleId}","operationId":"updateRoundingRuleDetails","name":"Update the details of rounding rule such as rounding type, description, no of decimals, lowest unit and rounding fractions.","summary":"Update the details of rounding rule","tags":[],"parameters":[{"name":"ruleId","in":"path","type":"string","required":true,"description":"Used to provide the rule for non-financial transaction, for identified related signatory groups and Minimum number of signatories"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"The identifier of the underlying Entity/Company/Branch."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"ruleNames":[{}],"rounding":"string","minimumAmount":"string","numberOfDecimals":"string","fractionalOrder":"string","preRoundToSixDecimal":"string"}},"responses":{"200":"RoundingRuleDetailsResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"DELETE","path":"/reference/roundingRules/{ruleId}","fullPath":"/api/v1.0.0/reference/roundingRules/{ruleId}","operationId":"deleteRoundingRuleDetails","name":"Delete the details of rounding rule such as rounding type, description, no of decimals, lowest unit and rounding fractions.","summary":"Delete the details of rounding rule","tags":[],"parameters":[{"name":"ruleId","in":"path","type":"string","required":true,"description":"Used to provide the rule for non-financial transaction, for identified related signatory groups and Minimum number of signatories"},{"name":"payload","in":"body","type":"object","required":false,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"The identifier of the underlying Entity/Company/Branch."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}}},"responses":{"200":"RoundingRuleDetailsResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}}]},{"key":"reference-transactionCodes-services-v1.0.0","title":"Transaction Codes","version":"v1.0.0","description":"API retrieves the transaction code details defined in the system","endpointCount":4,"endpoints":[{"method":"GET","path":"/reference/transactionCodes/{transactionCode}","fullPath":"/api/v1.0.0/reference/transactionCodes/{transactionCode}","operationId":"getTransactionCode","name":"API to retrieve information on transaction code such as transaction narrative, type,  initiation type and charges associated with code.","summary":"Retrieves the transaction code details","tags":[],"parameters":[{"name":"transactionCode","in":"path","type":"string","required":true,"description":"Identifies the system internal transaction code applicable to the transaction"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"The identifier of the underlying Entity/Company/Branch."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"TransactionCodeResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"POST","path":"/reference/transactionCodes/{transactionCode}","fullPath":"/api/v1.0.0/reference/transactionCodes/{transactionCode}","operationId":"createTransactionCode","name":"API to create information on transaction code such as transaction narrative, type,  initiation type and charges associated with code.","summary":"Creates the transaction code details","tags":[],"parameters":[{"name":"transactionCode","in":"path","type":"string","required":true,"description":"Identifies the system internal transaction code applicable to the transaction"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"The identifier of the underlying Entity/Company/Branch."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"transactionNames":[{}],"chargeIds":[{}],"entryNetting":[{}],"chequeTransaction":"string","chequeTypeId":"string","chequeIdRequired":"string","debitCreditIndicator":"string","includeInTurnoverCharge":"string","swiftNarrative":"string","transactionInitiationType":"string","statementReferenceField":"string","statementNarrativeFormatId":"string","exemptDispoProcessing":"string","exposureDateConditionId":"string","transactionType":"string"}},"responses":{"200":"TransactionCodeResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/reference/transactionCodes/{transactionCode}","fullPath":"/api/v1.0.0/reference/transactionCodes/{transactionCode}","operationId":"updateTransactionCode","name":"API to update information on transaction code such as transaction narrative, type,  initiation type and charges associated with code.","summary":"Updates the transaction code details","tags":[],"parameters":[{"name":"transactionCode","in":"path","type":"string","required":true,"description":"Identifies the system internal transaction code applicable to the transaction"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"The identifier of the underlying Entity/Company/Branch."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"transactionNames":[{}],"chargeIds":[{}],"entryNetting":[{}],"chequeTransaction":"string","chequeTypeId":"string","chequeIdRequired":"string","debitCreditIndicator":"string","includeInTurnoverCharge":"string","swiftNarrative":"string","transactionInitiationType":"string","statementReferenceField":"string","statementNarrativeFormatId":"string","exemptDispoProcessing":"string","exposureDateConditionId":"string","transactionType":"string"}},"responses":{"200":"TransactionCodeResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/reference/transactionCodes","fullPath":"/api/v1.0.0/reference/transactionCodes","operationId":"getTransactionCodeList","name":"Retrieves all transaction codes defined in the system with details such as transaction narrative, type,  initiation type and charges associated with code. ","summary":"Retrieves all the transaction codes","tags":[],"parameters":[{"name":"transactionCode","in":"query","type":"string","required":false,"description":"Identifies the system internal transaction code applicable to the transaction"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from t24 on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"The identifier of the underlying Entity/Company/Branch."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"TransactionCodeListResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}}]},{"key":"reference-transactionCodes-services-v1.1.0","title":"Transaction Codes","version":"v1.1.0","description":"APIs to manage transaction code details. Transaction codes or types are unique identifiers indicating the type of transaction carried out in the system.","endpointCount":4,"endpoints":[{"method":"GET","path":"/reference/transactionCodes/{transactionCode}","fullPath":"/api/v1.1.0/reference/transactionCodes/{transactionCode}","operationId":"getTransactionCode","name":"Retrieve information on transaction code such as transaction narrative, type, initiation type and charges associated with code.","summary":"Retrieves the transaction code details","tags":[],"parameters":[{"name":"transactionCode","in":"path","type":"string","required":true,"description":"Identifies the system internal transaction code applicable to the transaction"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"TransactionCodeResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"POST","path":"/reference/transactionCodes/{transactionCode}","fullPath":"/api/v1.1.0/reference/transactionCodes/{transactionCode}","operationId":"createTransactionCode","name":"Create information on transaction code such as transaction narrative, type, initiation type and charges associated with code.","summary":"Creates the transaction code details","tags":[],"parameters":[{"name":"transactionCode","in":"path","type":"string","required":true,"description":"Identifies the system internal transaction code applicable to the transaction"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"transactionNames":[{}],"chargeIds":[{}],"entryNetting":[{}],"chequeTransaction":"string","chequeTypeId":"string","chequeIdRequired":"string","debitCreditIndicator":"string","includeInTurnoverCharge":"string","swiftNarrative":"string","transactionInitiationType":"string","statementReferenceField":"string","statementNarrativeFormatId":"string","exemptDispoProcessing":"string","exposureDateConditionId":"string","transactionType":"string"}},"responses":{"200":"TransactionCodeResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/reference/transactionCodes/{transactionCode}","fullPath":"/api/v1.1.0/reference/transactionCodes/{transactionCode}","operationId":"updateTransactionCode","name":"Update information on transaction code such as transaction narrative, type, initiation type and charges associated with code.","summary":"Updates the transaction code details","tags":[],"parameters":[{"name":"transactionCode","in":"path","type":"string","required":true,"description":"Identifies the system internal transaction code applicable to the transaction"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"transactionNames":[{}],"chargeIds":[{}],"entryNetting":[{}],"chequeTransaction":"string","chequeTypeId":"string","chequeIdRequired":"string","debitCreditIndicator":"string","includeInTurnoverCharge":"string","swiftNarrative":"string","transactionInitiationType":"string","statementReferenceField":"string","statementNarrativeFormatId":"string","exemptDispoProcessing":"string","exposureDateConditionId":"string","transactionType":"string"}},"responses":{"200":"TransactionCodeResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/reference/transactionCodes","fullPath":"/api/v1.1.0/reference/transactionCodes","operationId":"getTransactionCodeList","name":"Retrieves all transaction codes defined in the system with details such as transaction narrative, type, initiation type and charges associated with code. ","summary":"Retrieves all the transaction codes","tags":[],"parameters":[{"name":"transactionCode","in":"query","type":"string","required":false,"description":"Identifies the system internal transaction code applicable to the transaction"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"TransactionCodeListResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}}]},{"key":"reference-treasury-service-v1.0.0","title":"Treasury configurations","version":"v1.0.0","description":"API to retrieve configuration of parameter setup of the treasury module such as deal methods, agreement type, currency revaluation methods, calendar details to consolidate the positions, description of floating interest rates configured by the institution and also configuration of all the applicatio","endpointCount":11,"endpoints":[{"method":"GET","path":"/reference/treasury/forex/agreementTypes","fullPath":"/api/v1.0.0/reference/treasury/forex/agreementTypes","operationId":"getForexAgreementTypes","name":"Retrieves description of all forex agreement types and displays default agreement(if any) set by the institution","summary":"Retrieves description of all forex agreement types","tags":[],"parameters":[{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from t24 on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"The identifier of the underlying Entity/Company/Branch."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"ForexAgreementTypesResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/reference/treasury/forex/agreementTypes/{agreementTypeId}","fullPath":"/api/v1.0.0/reference/treasury/forex/agreementTypes/{agreementTypeId}","operationId":"getForexAgreementType","name":"Retrieves description of the given forex agreement type and displays default agreement(if any) set by the institution","summary":"Retrieves description of the given forex agreement type ","tags":[],"parameters":[{"name":"agreementTypeId","in":"path","type":"string","required":true,"description":"Identifier of the agreement type, e.g. ISDA."},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from t24 on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"The identifier of the underlying Entity/Company/Branch."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"ForexAgreementTypeResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/reference/treasury/forex/dealMethods","fullPath":"/api/v1.0.0/reference/treasury/forex/dealMethods","operationId":"getForexDealMethods","name":"Retrieves list of forex deal methods like Mail,Reuters etc. as configured by the institution","summary":"Retrieves list of foreign exchange deal methods","tags":[],"parameters":[{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from t24 on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"The identifier of the underlying Entity/Company/Branch."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"ForexDealMethodsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/reference/treasury/forex/dealMethods/{dealMethodId}","fullPath":"/api/v1.0.0/reference/treasury/forex/dealMethods/{dealMethodId}","operationId":"getForexDealMethod","name":"Retrieves description of a given forex deal method","summary":"Retrieves description of forex deal method","tags":[],"parameters":[{"name":"dealMethodId","in":"path","type":"string","required":true,"description":"Deal method identifier as defined by the institution, e.g. RE for Reuters, TL for Telex etc."},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from t24 on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"The identifier of the underlying Entity/Company/Branch."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"ForexDealMethodResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/reference/treasury/forex/revaluationTypes","fullPath":"/api/v1.0.0/reference/treasury/forex/revaluationTypes","operationId":"getForexRevaluationTypes","name":"Retrieves different revaluation methods for foreign exchange deals configured by the bank","summary":"Retrieves different revaluation methods ","tags":[],"parameters":[{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from t24 on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"The identifier of the underlying Entity/Company/Branch."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"ForexRevaluationTypesResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/reference/treasury/forex/revaluationTypes/{revaluationTypeId}","fullPath":"/api/v1.0.0/reference/treasury/forex/revaluationTypes/{revaluationTypeId}","operationId":"getForexRevaluationType","name":"Retrieves information of a given revaluation method available for foreign exchange deals ","summary":"Retrieves information of a given revaluation method","tags":[],"parameters":[{"name":"revaluationTypeId","in":"path","type":"string","required":true,"description":"Identifies the revaluation type. Possible values are RB,SL,IN,IH,SF"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from t24 on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"The identifier of the underlying Entity/Company/Branch."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"ForexRevaluationTypeResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/reference/treasury/settings","fullPath":"/api/v1.0.0/reference/treasury/settings","operationId":"getTreasurySettings","name":"Retrieves general treasury settings of all the companies such as the local currency, current and the next working dates, rate provider and the revaluation currency","summary":"Retrieves generic treasury settings of all the companies","tags":[],"parameters":[{"name":"companyId","in":"query","type":"string","required":false,"description":"The identifier of the underlying Entity/Company/Branch."},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from t24 on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"The identifier of the underlying Entity/Company/Branch."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"TreasurySettingsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/reference/treasury/dates/{currencyOrPair}","fullPath":"/api/v1.0.0/reference/treasury/dates/{currencyOrPair}","operationId":"getPeriodDates","name":"Retrieves reference period dates under different time buckets for a currency or currency pair ","summary":"Retrieves reference period dates","tags":[],"parameters":[{"name":"currencyOrPair","in":"path","type":"string","required":true,"description":"A single currency or a currency pair."},{"name":"startDate","in":"query","type":"string","required":false,"description":"Beginning Date of IPO Subscription"},{"name":"period","in":"query","type":"string","required":false,"description":"Indicates spread of time buckets.Ex: 3M,6M,9M,10Y etc."},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from t24 on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"The identifier of the underlying Entity/Company/Branch."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"PeriodDatesResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/reference/treasury/agreementTypes","fullPath":"/api/v1.0.0/reference/treasury/agreementTypes","operationId":"getAgreementTypes","name":"Retrieves description of all the treasury agreement types and displays default agreement(if any) set by the institution","summary":"Retrieves description of all the agreement types ","tags":[],"parameters":[{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from t24 on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"The identifier of the underlying Entity/Company/Branch."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"AgreementTypesResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/reference/treasury/agreementTypes/{agreementTypeId}","fullPath":"/api/v1.0.0/reference/treasury/agreementTypes/{agreementTypeId}","operationId":"getAgreementType","name":"Retrieves description of the given treasury agreement type and displays default agreement(if any) set by the institution","summary":"Retrieves description of the given agreement type ","tags":[],"parameters":[{"name":"agreementTypeId","in":"path","type":"string","required":true,"description":"Identifier of the agreement type, e.g. ISDA."},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from t24 on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"The identifier of the underlying Entity/Company/Branch."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"AgreementTypeResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/reference/treasury/dealMethods","fullPath":"/api/v1.0.0/reference/treasury/dealMethods","operationId":"getDealMethods","name":"Retrieves description of forex deal methods and also broker settlement details.","summary":"Retrieves description of forex deal methods along with broker details","tags":[],"parameters":[{"name":"fileName","in":"query","type":"string","required":false,"description":"Identifies the type of methods to be listed. Possible values are FX.DEAL.METHOD, BROKER or blank."},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from t24 on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"The identifier of the underlying Entity/Company/Branch."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"DealMethodsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}}]},{"key":"reference-treasury-service-v2.0.0","title":"Treasury configurations","version":"v2.0.0","description":"API to retrieve configuration of parameter setup of the treasury module such as deal methods, agreement type, currency revaluation methods, calendar details to consolidate the positions, description of floating interest rates configured by the institution and also involves configuration of all the a","endpointCount":11,"endpoints":[{"method":"GET","path":"/reference/treasury/forex/agreementTypes","fullPath":"/api/v2.0.0/reference/treasury/forex/agreementTypes","operationId":"getForexAgreementTypes","name":"Retrieves description of all forex agreement types and displays default agreement(if any) set by the institution","summary":"Retrieves description of all forex agreement types","tags":[],"parameters":[{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from t24 on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"The identifier of the underlying Entity/Company/Branch."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"ForexAgreementTypesResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/reference/treasury/forex/agreementTypes/{agreementTypeId}","fullPath":"/api/v2.0.0/reference/treasury/forex/agreementTypes/{agreementTypeId}","operationId":"getForexAgreementType","name":"Retrieves description of the given forex agreement type and displays default agreement(if any) set by the institution","summary":"Retrieves description of the given forex agreement type ","tags":[],"parameters":[{"name":"agreementTypeId","in":"path","type":"string","required":true,"description":"Identifier of the agreement type, e.g. ISDA."},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from t24 on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"The identifier of the underlying Entity/Company/Branch."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"ForexAgreementTypeResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/reference/treasury/forex/dealMethods","fullPath":"/api/v2.0.0/reference/treasury/forex/dealMethods","operationId":"getForexDealMethods","name":"Retrieves list of forex deal methods like Mail,Reuters etc. as configured by the institution","summary":"Retrieves list of foreign exchange deal methods","tags":[],"parameters":[{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from t24 on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"The identifier of the underlying Entity/Company/Branch."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"ForexDealMethodsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/reference/treasury/forex/dealMethods/{dealMethodId}","fullPath":"/api/v2.0.0/reference/treasury/forex/dealMethods/{dealMethodId}","operationId":"getForexDealMethod","name":"Retrieves description of a given forex deal method","summary":"Retrieves description of forex deal method","tags":[],"parameters":[{"name":"dealMethodId","in":"path","type":"string","required":true,"description":"Deal method identifier as defined by the institution, e.g. RE for Reuters, TL for Telex etc."},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from t24 on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"The identifier of the underlying Entity/Company/Branch."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"ForexDealMethodResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/reference/treasury/forex/revaluationTypes","fullPath":"/api/v2.0.0/reference/treasury/forex/revaluationTypes","operationId":"getForexRevaluationTypes","name":"Retrieves different revaluation methods for foreign exchange deals configured by the bank","summary":"Retrieves different revaluation methods ","tags":[],"parameters":[{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from t24 on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"The identifier of the underlying Entity/Company/Branch."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"ForexRevaluationTypesResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/reference/treasury/forex/revaluationTypes/{revaluationTypeId}","fullPath":"/api/v2.0.0/reference/treasury/forex/revaluationTypes/{revaluationTypeId}","operationId":"getForexRevaluationType","name":"Retrieves information of a given revaluation method available for foreign exchange deals ","summary":"Retrieves information of a given revaluation method","tags":[],"parameters":[{"name":"revaluationTypeId","in":"path","type":"string","required":true,"description":"Identifies the revaluation type. Possible values are RB,SL,IN,IH,SF"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from t24 on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"The identifier of the underlying Entity/Company/Branch."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"ForexRevaluationTypeResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/reference/treasury/settings","fullPath":"/api/v2.0.0/reference/treasury/settings","operationId":"getTreasurySettings","name":"Retrieves general treasury settings of all the companies such as the local currency, current and the next working dates, rate provider and the revaluation currency","summary":"Retrieves generic treasury settings of all the companies","tags":[],"parameters":[{"name":"companyId","in":"query","type":"string","required":false,"description":"The identifier of the underlying Entity/Company/Branch."},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from t24 on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"The identifier of the underlying Entity/Company/Branch."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"TreasurySettingsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/reference/treasury/dates/{currencyOrPair}","fullPath":"/api/v2.0.0/reference/treasury/dates/{currencyOrPair}","operationId":"getPeriodDates","name":"Retrieves reference period dates under different time buckets for a currency or currency pair ","summary":"Retrieves reference period dates","tags":[],"parameters":[{"name":"currencyOrPair","in":"path","type":"string","required":true,"description":"A single currency or a currency pair."},{"name":"startDate","in":"query","type":"string","required":false,"description":"Beginning Date of IPO Subscription"},{"name":"period","in":"query","type":"string","required":false,"description":"Indicates spread of time buckets.Ex: 3M,6M,9M,10Y etc."},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from t24 on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"The identifier of the underlying Entity/Company/Branch."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"PeriodDatesResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/reference/treasury/dealMethods","fullPath":"/api/v2.0.0/reference/treasury/dealMethods","operationId":"getDealMethods","name":"Retrieves description of forex deal methods and also broker settlement details.","summary":"Retrieves description of forex deal methods along with broker details","tags":[],"parameters":[{"name":"fileName","in":"query","type":"string","required":false,"description":"Identifies the type of methods to be listed. Possible values are FX.DEAL.METHOD, BROKER or blank."},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from t24 on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"The identifier of the underlying Entity/Company/Branch."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"DealMethodsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/reference/treasury/agreementTypes","fullPath":"/api/v2.0.0/reference/treasury/agreementTypes","operationId":"getAgreementTypes","name":"Retrieves description of all the treasury agreement types and displays default agreement(if any) set by the institution","summary":"Retrieves description of all the agreement types ","tags":[],"parameters":[{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from t24 on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"The identifier of the underlying Entity/Company/Branch."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"AgreementTypesResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/reference/treasury/agreementTypes/{agreementTypeId}","fullPath":"/api/v2.0.0/reference/treasury/agreementTypes/{agreementTypeId}","operationId":"getAgreementType","name":"Retrieves description of the given treasury agreement type and displays default agreement(if any) set by the institution","summary":"Retrieves description of the given agreement type ","tags":[],"parameters":[{"name":"agreementTypeId","in":"path","type":"string","required":true,"description":"Identifier of the agreement type, e.g. ISDA."},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from t24 on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"The identifier of the underlying Entity/Company/Branch."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"AgreementTypeResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}}]},{"key":"reference-treasury-service-v3.0.0","title":"Treasury configurations","version":"v3.0.0","description":"API to retrieve configuration of parameter setup of the treasury module such as deal methods, agreement type, currency revaluation methods, calendar details to consolidate the positions, description of floating interest rates configured by the institution and also involves configuration of all the a","endpointCount":11,"endpoints":[{"method":"GET","path":"/reference/treasury/forex/agreementTypes","fullPath":"/api/v3.0.0/reference/treasury/forex/agreementTypes","operationId":"getForexAgreementTypes","name":"Retrieves description of all forex agreement types and displays default agreement(if any) set by the institution","summary":"Retrieves description of all forex agreement types","tags":[],"parameters":[{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"ForexAgreementTypesResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/reference/treasury/forex/agreementTypes/{agreementTypeId}","fullPath":"/api/v3.0.0/reference/treasury/forex/agreementTypes/{agreementTypeId}","operationId":"getForexAgreementType","name":"Retrieves description of the given forex agreement type and displays default agreement(if any) set by the institution","summary":"Retrieves description of the given forex agreement type ","tags":[],"parameters":[{"name":"agreementTypeId","in":"path","type":"string","required":true,"description":"Identifier of the agreement type, e.g. ISDA."},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"ForexAgreementTypeResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/reference/treasury/forex/dealMethods","fullPath":"/api/v3.0.0/reference/treasury/forex/dealMethods","operationId":"getForexDealMethods","name":"Retrieves list of forex deal methods like Mail,Reuters etc. as configured by the institution","summary":"Retrieves list of foreign exchange deal methods","tags":[],"parameters":[{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"ForexDealMethodsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/reference/treasury/forex/dealMethods/{dealMethodId}","fullPath":"/api/v3.0.0/reference/treasury/forex/dealMethods/{dealMethodId}","operationId":"getForexDealMethod","name":"Retrieves description of a given forex deal method","summary":"Retrieves description of forex deal method","tags":[],"parameters":[{"name":"dealMethodId","in":"path","type":"string","required":true,"description":"Deal method identifier as defined by the institution, e.g. RE for Reuters, TL for Telex etc."},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"ForexDealMethodResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/reference/treasury/forex/revaluationTypes","fullPath":"/api/v3.0.0/reference/treasury/forex/revaluationTypes","operationId":"getForexRevaluationTypes","name":"Retrieves different revaluation methods for foreign exchange deals configured by the bank","summary":"Retrieves different revaluation methods ","tags":[],"parameters":[{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"ForexRevaluationTypesResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/reference/treasury/forex/revaluationTypes/{revaluationTypeId}","fullPath":"/api/v3.0.0/reference/treasury/forex/revaluationTypes/{revaluationTypeId}","operationId":"getForexRevaluationType","name":"Retrieves information of a given revaluation method available for foreign exchange deals ","summary":"Retrieves information of a given revaluation method","tags":[],"parameters":[{"name":"revaluationTypeId","in":"path","type":"string","required":true,"description":"Identifies the revaluation type. Possible values are RB,SL,IN,IH,SF"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"ForexRevaluationTypeResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/reference/treasury/dates/{currencyOrPair}","fullPath":"/api/v3.0.0/reference/treasury/dates/{currencyOrPair}","operationId":"getPeriodDates","name":"Retrieves reference period dates under different time buckets for a currency or currency pair ","summary":"Retrieves reference period dates","tags":[],"parameters":[{"name":"currencyOrPair","in":"path","type":"string","required":true,"description":"A single currency or a currency pair."},{"name":"startDate","in":"query","type":"string","required":false,"description":"Beginning Date of IPO Subscription"},{"name":"period","in":"query","type":"string","required":false,"description":"Indicates spread of time buckets.Ex: 3M,6M,9M,10Y etc."},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"PeriodDatesResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/reference/treasury/dealMethods","fullPath":"/api/v3.0.0/reference/treasury/dealMethods","operationId":"getDealMethods","name":"Retrieves description of forex deal methods and also broker settlement details.","summary":"Retrieves description of forex deal methods along with broker details","tags":[],"parameters":[{"name":"fileName","in":"query","type":"string","required":false,"description":"Identifies the type of methods to be listed. Possible values are FX.DEAL.METHOD, BROKER or blank."},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"DealMethodsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/reference/treasury/agreementTypes","fullPath":"/api/v3.0.0/reference/treasury/agreementTypes","operationId":"getAgreementTypes","name":"Retrieves description of all the treasury agreement types and displays default agreement(if any) set by the institution","summary":"Retrieves description of all the agreement types ","tags":[],"parameters":[{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"AgreementTypesResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/reference/treasury/agreementTypes/{agreementTypeId}","fullPath":"/api/v3.0.0/reference/treasury/agreementTypes/{agreementTypeId}","operationId":"getAgreementType","name":"Retrieves description of the given treasury agreement type and displays default agreement(if any) set by the institution","summary":"Retrieves description of the given agreement type ","tags":[],"parameters":[{"name":"agreementTypeId","in":"path","type":"string","required":true,"description":"Identifier of the agreement type, e.g. ISDA."},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"AgreementTypeResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/reference/treasury/settings","fullPath":"/api/v3.0.0/reference/treasury/settings","operationId":"getTreasurySettings","name":"Retrieves general treasury settings of all the companies such as the local currency, current and the next working dates, rate provider and the revaluation currency","summary":"Retrieves generic treasury settings of all the companies","tags":[],"parameters":[{"name":"companyId","in":"query","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"TreasurySettingsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}}]},{"key":"reference-treasuryLimits-service-v1.0.0","title":"Treasury Limit","version":"v1.0.0","description":"Allows the configuration of the Treasury limits. The user can set Intraday, Overnight and Stop loss limit. Limits can be set to monitor transaction size and also at product level.","endpointCount":4,"endpoints":[{"method":"POST","path":"/reference/limits/dealers/{dealerId}/transactionLimits","fullPath":"/api/v1.0.0/reference/limits/dealers/{dealerId}/transactionLimits","operationId":"createDealerTransactionLimit","name":"Create the treasury limits for the transaction amounts for each dealer.","summary":"Create the treasury limits for the transaction amounts for each dealer.","tags":[],"parameters":[{"name":"dealerId","in":"path","type":"string","required":true,"description":"Identifies the dealer/ desk responsible for monitoring and managing currency positions."},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"limitProducts":[{}],"description":"string","transactionLimitCurrency":"string","transactionLimitAmount":"string","extensions":{}}},"responses":{"200":"DealerTransactionLimitResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/reference/limits/dealers/{dealerId}/transactionLimits","fullPath":"/api/v1.0.0/reference/limits/dealers/{dealerId}/transactionLimits","operationId":"updateDealerTransactionLimit","name":"Define the treasury limits for a dealer desk where in user can key in the limit amounts for the deal currency and the limit product and based on which the exceptions will be raised at the transaction level.","summary":"Define the treasury limits for a dealer desk where in user can key in the limit amounts for the deal currency and the limit product.","tags":[],"parameters":[{"name":"dealerId","in":"path","type":"string","required":true,"description":""},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"limitProducts":[{}],"description":"string","transactionLimitCurrency":"string","transactionLimitAmount":"string","extensions":{}}},"responses":{"200":"DealerTransactionLimitResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"POST","path":"/reference/limits/dealerLimits/{dealerLimitId}","fullPath":"/api/v1.0.0/reference/limits/dealerLimits/{dealerLimitId}","operationId":"createPositionLimits","name":"Create the treasury position limits for the company and dealers.ID will be GB0010001.CCY.POSITION.dealerdesk. Eg: GB0010001.CCY.POSITION.00","summary":"Create the treasury position limits for the company and dealers.","tags":[],"parameters":[{"name":"dealerLimitId","in":"path","type":"string","required":true,"description":"Defines the dealer limit id in which the position limits will be monitored. ID will be GB0010001.CCY.POSITION.dealerdesk. Eg: GB0010001.CCY.POSITION.00"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"limitCurrencies":[{}],"aggregateOvernightTimeBands":[{}],"description":"string","aggregateLimitCurrency":"string","aggregateIntradayLimitAmount":"string","aggregareOvernightLimitAmount":"string","stopLossCurrency":"string","stopLossAmount":"string","includeOvernightToIntraday":"string","extensions":{}}},"responses":{"200":"PositionLimitsResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/reference/limits/dealerLimits/{dealerLimitId}","fullPath":"/api/v1.0.0/reference/limits/dealerLimits/{dealerLimitId}","operationId":"updatePositionLimits","name":"Define the treasury position limits such as Intraday,Overnight,Aggregate limits for the company and at the dealer level. ID will be GB0010001.CCY.POSITION.dealerdesk. Eg: GB0010001.CCY.POSITION.00","summary":"Define the treasury position limits such as Intraday,Overnight,Aggregate limits for the company and at the dealer level","tags":[],"parameters":[{"name":"dealerLimitId","in":"path","type":"string","required":true,"description":""},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"limitCurrencies":[{}],"aggregateOvernightTimeBands":[{}],"description":"string","aggregateLimitCurrency":"string","aggregateIntradayLimitAmount":"string","aggregareOvernightLimitAmount":"string","stopLossCurrency":"string","stopLossAmount":"string","includeOvernightToIntraday":"string","extensions":{}}},"responses":{"200":"PositionLimitsResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}}]},{"key":"reference-us-benOwnerTypes-service-v1.0.0","title":"US Model Bank - Beneficiary roles","version":"v1.0.0","description":"Retrieves Beneficiary Role type definitions and the information that is mandatory for the role definition.","endpointCount":1,"endpoints":[{"method":"GET","path":"/reference/us/beneficialOwnerTypes","fullPath":"/api/v1.0.0/reference/us/beneficialOwnerTypes","operationId":"getUsBeneficialOwnerTypes","name":"Fincen Beneficiary Rules","summary":"Retrieves list of Beneficiary Role type definitions and the information that is mandatory for the definition.","tags":[],"parameters":[{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from t24 on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"The identifier of the underlying Entity/Company/Branch."}],"requestBodyExample":null,"responses":{"200":"UsBeneficialOwnerTypesResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}}]},{"key":"reference-us-companies-service-v1.0.0","title":"Fetch Company Details","version":"v1.0.0","description":"Retrieve company details","endpointCount":1,"endpoints":[{"method":"GET","path":"/reference/us/companies/{id}","fullPath":"/api/v1.0.0/reference/us/companies/{id}","operationId":"getUsCompanyDetails","name":"Retrieve company details such as entity location information, tax number, routing number and state of incorporation","summary":"Retrieve company details","tags":["RETAIL"],"parameters":[{"name":"id","in":"path","type":"string","required":true,"description":"Contains the daily position class id."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"UsCompanyDetailsResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}}]},{"key":"reference-us-county-service-v1.0.0","title":"US Model Bank - US Counties","version":"v1.0.0","description":"Retrieves US county information for a given state","endpointCount":1,"endpoints":[{"method":"GET","path":"/reference/us/states/{stateId}/counties","fullPath":"/api/v1.0.0/reference/us/states/{stateId}/counties","operationId":"getUsCountyList","name":"Retrieves County information","summary":"Retrieves US county information for a given state","tags":[],"parameters":[{"name":"stateId","in":"path","type":"string","required":true,"description":"Represents the US State to which the address belongs to."},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from t24 on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"The identifier of the underlying Entity/Company/Branch."}],"requestBodyExample":null,"responses":{"200":"UsCountyListResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}}]},{"key":"reference-us-covenant-service-v1.0.0","title":"US Model Bank - Loan covenants","version":"v1.0.0","description":"Retrieves the available convenants that can be associated with a loan based on the terms agreed for the loan","endpointCount":1,"endpoints":[{"method":"GET","path":"/reference/us/covenants","fullPath":"/api/v1.0.0/reference/us/covenants","operationId":"getUsCovenantList","name":"Covenants list","summary":"Retrives the available list of convenants that can be associated with a loan based on the terms agreed for the loan","tags":[],"parameters":[{"name":"covenantPlan","in":"query","type":"string","required":false,"description":"Indicates the covenant plan that are linked to a loan. Covenants are conditions based on which a commercial loan has been lent to a borrower. These covenants are are periodically evaluated and if the "},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from t24 on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"The identifier of the underlying Entity/Company/Branch."}],"requestBodyExample":null,"responses":{"200":"UsCovenantListResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}}]},{"key":"reference-us-customerrating-service-v1.0.0","title":"US Model Bank - Customer risk rating","version":"v1.0.0","description":"Retrieves customer risk rating for classification of US customer. A rating of 100 to 109 is allowed for a Customer","endpointCount":1,"endpoints":[{"method":"GET","path":"/reference/us/customerRatings","fullPath":"/api/v1.0.0/reference/us/customerRatings","operationId":"getUsCustomerRatinglist","name":"Retrieves Rating information","summary":"Retrieves avaliable list of customer risk rating available for a US customer. A rating of 100 to 109 is allowed for a Customer","tags":[],"parameters":[{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from t24 on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"The identifier of the underlying Entity/Company/Branch."}],"requestBodyExample":null,"responses":{"200":"UsCustomerRatinglistResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}}]},{"key":"reference-us-customersuffix-service-v1.0.0","title":"US Model Bank - Customer designatory titles","version":"v1.0.0","description":"Retrieves the of post-nominal or designatory titles allowed for a customer.","endpointCount":1,"endpoints":[{"method":"GET","path":"/reference/us/customerSuffixes","fullPath":"/api/v1.0.0/reference/us/customerSuffixes","operationId":"getUsSuffixList","name":"Post-nominal titles","summary":"Retrieves the of post-nominal or designatory titles allowed for a customer.","tags":[],"parameters":[{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from t24 on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"The identifier of the underlying Entity/Company/Branch."}],"requestBodyExample":null,"responses":{"200":"UsSuffixListResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}}]},{"key":"reference-us-customertitle-service-v1.0.0","title":"US Model Bank - Customer titles","version":"v1.0.0","description":"Retrieves available customer titles allowed for US customers","endpointCount":1,"endpoints":[{"method":"GET","path":"/reference/us/customerTitles","fullPath":"/api/v1.0.0/reference/us/customerTitles","operationId":"getUsCustomerTitles","name":"Pre-nominal titles","summary":"Retrieves available list of customer Titles allowed for US customers","tags":[],"parameters":[{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from t24 on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"The identifier of the underlying Entity/Company/Branch."}],"requestBodyExample":null,"responses":{"200":"UsCustomerTitlesResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}}]},{"key":"reference-us-fdicClassCodes-service-v1.0.0","title":"US Model Bank - FDIC sub-classification codes","version":"v1.0.0","description":"Retrieve the deposit sub-classification codes provied by FDIC","endpointCount":1,"endpoints":[{"method":"GET","path":"/reference/us/fdicClasscodes","fullPath":"/api/v1.0.0/reference/us/fdicClasscodes","operationId":"getFdicClassCode","name":"FDIC Class codes","summary":"Lists the deposit sub-classification codes provied by FDIC","tags":[],"parameters":[{"name":"fdicDepositClassCode","in":"query","type":"string","required":false,"description":"Classification codes define an account or deposits specific sub-classification within the fdic deposit classification type as to the nature of the account such as Payable on death, living trust, busin"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from t24 on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"The identifier of the underlying Entity/Company/Branch."}],"requestBodyExample":null,"responses":{"200":"FdicClassCodeResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}}]},{"key":"reference-us-holdTypes-v1.0.0","title":"US Model Bank - Hold types","version":"v1.0.0","description":"Retrieve the available hold types in the system","endpointCount":1,"endpoints":[{"method":"GET","path":"/reference/us/holdtypes","fullPath":"/api/v1.0.0/reference/us/holdtypes","operationId":"getHoldTypes","name":"Hold types","summary":"Lists the available hold types in the system","tags":[],"parameters":[{"name":"holdTypeId","in":"query","type":"string","required":false,"description":"Purpose or the type of hold placed on the account  The available list of hold types can be retrieved through getHoldTypes"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from t24 on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"The identifier of the underlying Entity/Company/Branch."}],"requestBodyExample":null,"responses":{"200":"HoldTypesResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}}]},{"key":"reference-us-iddocuments-service-v1.0.0","title":"US Model Bank - Document types","version":"v1.0.0","description":"Retrieves available identification document types","endpointCount":1,"endpoints":[{"method":"GET","path":"/reference/us/documents","fullPath":"/api/v1.0.0/reference/us/documents","operationId":"getUsIdDoclist","name":"Allowed identity verification document types","summary":"Retrieves available list of document types supported","tags":[],"parameters":[{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from t24 on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"The identifier of the underlying Entity/Company/Branch."}],"requestBodyExample":null,"responses":{"200":"UsIdDoclistResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}}]},{"key":"reference-us-industry-service-v1.0.0","title":"US Model Bank - US Industry classifications","version":"v1.0.0","description":"Retrieves US industry classification or NAICS codes","endpointCount":1,"endpoints":[{"method":"GET","path":"/reference/us/industries","fullPath":"/api/v1.0.0/reference/us/industries","operationId":"getUsIndustrylist","name":"NAICS codes","summary":"Retrieves US industry classification or NAICS codes","tags":[],"parameters":[{"name":"naicsCode","in":"query","type":"string","required":false,"description":"NAICS Code linked to the occupation or type of business of the Customer"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from t24 on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"The identifier of the underlying Entity/Company/Branch."}],"requestBodyExample":null,"responses":{"200":"UsIndustrylistResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}}]},{"key":"reference-us-overdraftProcessing-service-v1.0.0","title":"Overdraft Coverage Codes","version":"v1.0.0","description":"API to get the  overdraft protection options offered by the financial institutions","endpointCount":1,"endpoints":[{"method":"GET","path":"/reference/us/overdrafts/coverages","fullPath":"/api/v1.0.0/reference/us/overdrafts/coverages","operationId":"getUsOverdraftCoverageCodes","name":"Retrieves the overdraft protection options offered by the financial institutions and their definition regarding the type of balances that can be used to cover the overdraft(shared account balance, overdraft limit etc.) and the type of transactions that can be considered for overdraft coverage (ATM/Check/point of sale transactions etc.).","summary":"Retrieves the overdraft protection codes and their definition","tags":["RETAIL"],"parameters":[{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"UsOverdraftCoverageCodesResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}}]},{"key":"reference-us-sector-service-v1.0.0","title":"US Model Bank - Corporate Customer groups","version":"v1.0.0","description":"Retrieves customer types available for corporates and individuals","endpointCount":1,"endpoints":[{"method":"GET","path":"/reference/us/sectors/{customerType}","fullPath":"/api/v1.0.0/reference/us/sectors/{customerType}","operationId":"getUsSectorlist","name":"Corporate and Individual customer groups","summary":"Retrieves list of customer groups available for corporates","tags":[],"parameters":[{"name":"customerType","in":"path","type":"string","required":true,"description":""},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from t24 on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"The identifier of the underlying Entity/Company/Branch."}],"requestBodyExample":null,"responses":{"200":"UsSectorlistResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}}]},{"key":"reference-us-sortcodes-services-v1.0.0","title":"US Model Bank Bank sort codes","version":"v1.0.0","description":"US Model Bank API for Sort codes","endpointCount":1,"endpoints":[{"method":"GET","path":"/reference/us/bankSortCodes","fullPath":"/api/v1.0.0/reference/us/bankSortCodes","operationId":"getUsRouting","name":"API to search and  retrieve the bank sort code details","summary":"API to retreive the list of all Financial institutions routing numbers and the respective  details or a to retreive the routing number details of a specific FI using the routing number or institute name","tags":[],"parameters":[{"name":"instituteDirectoryId","in":"query","type":"string","required":false,"description":"Identifier of the internal reference to financial institute directories where routing number or BIC codes and address information are held"},{"name":"routingBiccode","in":"query","type":"string","required":false,"description":"Indicates the routing number of BIC code used to identify the financial institution"},{"name":"beneficiaryInstituteName","in":"query","type":"string","required":false,"description":"Indicates the name of financial institution where the beneficiary account is held"},{"name":"beneficiaryInstituteBranchName","in":"query","type":"string","required":false,"description":"Indicates the Branch name of the financial institution where the beneficiary account is held"},{"name":"beneficiaryInstituteCity","in":"query","type":"string","required":false,"description":"Indicates the City of financial institution where the beneficiary account is held"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from t24 on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"UsRoutingResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}}]},{"key":"reference-us-state-service-v1.0.0","title":"US Model Bank - US States","version":"v1.0.0","description":"Retrieves available US States","endpointCount":1,"endpoints":[{"method":"GET","path":"/reference/us/states","fullPath":"/api/v1.0.0/reference/us/states","operationId":"getUsStateList","name":"US States","summary":"Retrieves list of US States","tags":[],"parameters":[{"name":"countryId","in":"query","type":"string","required":false,"description":"ISO country code of the financial institution. "},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from t24 on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"The identifier of the underlying Entity/Company/Branch."}],"requestBodyExample":null,"responses":{"200":"UsStateListResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}}]},{"key":"reference-userAdmin-service-v1.0.0","title":"Static reference APIs for User Administration","version":"v1.0.0","description":"User Administration","endpointCount":2,"endpoints":[{"method":"GET","path":"/reference/companies","fullPath":"/api/v1.0.0/v1.0.0/reference/companies","operationId":"getCompanies","name":"Retrieves the company details, such as company's name, the mnemonic the file classification details, the applications to be run and company level defaults and parameters.","summary":"Retrieves Company Details","tags":[],"parameters":[{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"CompaniesResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/reference/lookupTables","fullPath":"/api/v1.0.0/v1.0.0/reference/lookupTables","operationId":"getLookups","name":"Retrieves Lookup Details based on application id","summary":"Retrieves Lookup Details","tags":[],"parameters":[{"name":"applicationId","in":"query","type":"string","required":false,"description":"Contains the application id of the service that has crashed due to error."},{"name":"selection","in":"query","type":"string","required":false,"description":""},{"name":"prefixId","in":"query","type":"string","required":false,"description":""},{"name":"customId","in":"query","type":"string","required":false,"description":""},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"LookupsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}}]},{"key":"reference-virtualaccounts-service-v1.0.0","title":"Cash Management Reference","version":"v1.0.0","description":"Cash management API","endpointCount":1,"endpoints":[{"method":"POST","path":"/reference/sweeps/sweepTypes/{sweepType}","fullPath":"/api/v1.0.0/reference/sweeps/sweepTypes/{sweepType}","operationId":"createVirtualAccountsSweepType","name":"Creates sweep type for virtual accounts.","summary":"Creates sweep type","tags":["CORPORATE"],"parameters":[{"name":"sweepType","in":"path","type":"string","required":true,"description":"Sweep types defined to the user"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"description":"string","displayName":"string","sweepTypes":"string","zeroBalancing":"Select the Balance to Use","creditTransactionCode":"string","debitTransactionCode":"string","creditReturnTransactionCode":"string","debitReturnTransactionCode":"string","amtSweepRoutine":"string","limits":"string","prioritiseOd":"string","returnAtSod":"string","balanceTypeBalance":"string","accountMode":"string","reversalTxnCode":"string"}},"responses":{"200":"VirtualAccountsSweepTypeResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}}]}]},{"name":"References","serviceCount":5,"endpointCount":5,"services":[{"key":"references-industries-service-v1.0.0","title":"Industries","version":"v1.0.0","description":"API to manage the different industry definition available in the system. Industries are categorized based on type or nature of work like health care, sports, non-profit institutions, etc.","endpointCount":1,"endpoints":[{"method":"GET","path":"/reference/industries/","fullPath":"/api/v1.0.0/reference/industries/","operationId":"getIndustryList","name":"Retrieves the list of industries with details such as industry type or code and the descriptive name of the industry.","summary":"Retrieves list of industries","tags":[],"parameters":[{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"IndustryListResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}}]},{"key":"references-jobTitles-service-v1.0.0","title":"Job Titles","version":"v1.0.0","description":"API to manage the different job titles available in the system. Job title identifies the role or nature of the job like accountant, professor, manager, etc.","endpointCount":1,"endpoints":[{"method":"GET","path":"/reference/jobTitles/","fullPath":"/api/v1.0.0/reference/jobTitles/","operationId":"getJobTitles","name":"Retrieves the list of job titles with details such as job title type or code and the descriptive name of the job title.","summary":"Retrieves list of  job titles","tags":[],"parameters":[{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"JobTitlesResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}}]},{"key":"references-languages-service-v1.0.0","title":"Languages","version":"v1.0.0","description":"API to manage the different languages defined the system.","endpointCount":1,"endpoints":[{"method":"GET","path":"/reference/languages/","fullPath":"/api/v1.0.0/reference/languages/","operationId":"getLanguageList","name":"Retrieves the list of language codes available in the system along with the name of language corresponding to each language code","summary":"Retrieves list of languages","tags":[],"parameters":[{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"LanguageListResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}}]},{"key":"references-purposes-service-v1.0.0","title":"List of Purposes","version":"v1.0.0","description":"API to retrieves the list of Purposes available in the system","endpointCount":1,"endpoints":[{"method":"GET","path":"/reference/purposes/","fullPath":"/api/v1.0.0/v1.0.0/reference/purposes/","operationId":"getAAPurposeList","name":"Retrieves the list of Purposes available","summary":"Retrieves the list of Purposes available","tags":[],"parameters":[{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from t24 on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":""},{"name":"companyId","in":"header","type":"string","required":false,"description":""}],"requestBodyExample":null,"responses":{"200":"AAPurposeListResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}}]},{"key":"references-sectors-service-v1.0.0","title":"Sectors","version":"v1.0.0","description":"API to manage the different sectors available in the system. Sectors are used to categorize a customer or entity as individual, agency, financial corporations, banks, etc.","endpointCount":1,"endpoints":[{"method":"GET","path":"/reference/sectors/","fullPath":"/api/v1.0.0/reference/sectors/","operationId":"getSectorList","name":"Retrieves the list of sectors with details such as sector type or code and the descriptive name of each sector.","summary":"Retrieves list of sectors","tags":[],"parameters":[{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"SectorListResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}}]}]},{"name":"Rights","serviceCount":1,"endpointCount":4,"services":[{"key":"rights-v1.0.0","title":"Customer Data Protection Data Rights Management","version":"v1.0.0","description":"Create and manage customer data Rights - Deprecated. Use party-dataProtection-customers-v1.3.0 instead","endpointCount":4,"endpoints":[{"method":"POST","path":"/party/dataProtection/customers/dataRightsInitiation","fullPath":"/api/v1.0.0/party/dataProtection/customers/dataRightsInitiation","operationId":"createDataRightsRequest","name":"Creates data Rights details for a customer on how associated data should be managed.","summary":"Creates data Rights details","tags":[],"parameters":[{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001"},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"purposeDetails":[{}],"partyId":"string","partyType":"string","requestType":"string","newExpiryDate":"string","status":"string","requestNewAction":"string","newAmendmentNotes":"string","approveRequest":"string","channelId":"string","accountOfficer":"string","applicationName":"string","contractId":"string","companyId":"string"}},"responses":{"200":"DataRightsRequestResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/party/dataProtection/customers/dataRightsApprovals/{dataRightsId}","fullPath":"/api/v1.0.0/party/dataProtection/customers/dataRightsApprovals/{dataRightsId}","operationId":"approveDataRightsRequest","name":"Approves data Rights details for a customer.","summary":"Approves data Rights details","tags":[],"parameters":[{"name":"dataRightsId","in":"path","type":"string","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001"},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"DataRightsRequestResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/party/dataProtection/customers/dataRights/{dataRightsId}","fullPath":"/api/v1.0.0/party/dataProtection/customers/dataRights/{dataRightsId}","operationId":"updateDataRightsRequest","name":"Updates data Rights details for a customer.","summary":"Updates data Rights details","tags":[],"parameters":[{"name":"dataRightsId","in":"path","type":"string","required":true,"description":""},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001"},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"purposeDetails":[{}],"partyId":"string","partyType":"string","requestType":"string","newExpiryDate":"string","status":"string","requestNewAction":"string","newAmendmentNotes":"string","accountOfficer":"string","isReqComplete":"string","approveRequest":"string","channelId":"string","internalAction":"string","applicationName":"string","contractId":"string"}},"responses":{"200":"DataRightsRequestResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/party/dataProtection/customers/dataRights","fullPath":"/api/v1.0.0/party/dataProtection/customers/dataRights","operationId":"getDataRightsRequest","name":"Retrieves data Rights details for a customer.","summary":"Retrieves data Rights details","tags":[],"parameters":[{"name":"dataRightsId","in":"query","type":"string","required":false,"description":""},{"name":"partyId","in":"query","type":"string","required":false,"description":"Allows capturing of customers or person entities to be part of the relationship. If partyType is selected as Customer, then the system will allow only customer Ids to be captured into this field. If p"},{"name":"requestStatus","in":"query","type":"string","required":false,"description":"The current status of the request. The possible values includes New, send to printer, cancelled and processed."},{"name":"currExpiryDate","in":"query","type":"string","required":false,"description":"Contains the current expiry date of the data rights request."},{"name":"requestType","in":"query","type":"string","required":false,"description":"Contains customer data rights request type. Example: ERASURE/DATAPORTABILITY."},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from t24 on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001"},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"DataRightsRequestResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}}]}]},{"name":"Settings","serviceCount":7,"endpointCount":82,"services":[{"key":"settings-arrangements-configuration-v1.0.0","title":"Pricing Assessment configuration","version":"v1.0.0","description":"Pricing assessment configuration for a set of related parties","endpointCount":2,"endpoints":[{"method":"POST","path":"/settings/configurations/relatedPartySettings/{relatedPartySettingId}","fullPath":"/api/v1.0.0/settings/configurations/relatedPartySettings/{relatedPartySettingId}","operationId":"createPartyRelationParameters","name":"Creates a configuration that defines a set of related parties and assigns the pricing assessment method for the arrangements of each relation","summary":"Creates a new pricing assessment configuration for a set of related parties","tags":["RETAIL"],"parameters":[{"name":"relatedPartySettingId","in":"path","type":"string","required":true,"description":""},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"relations":[{}],"nonRelationMethod":"string","extensionData":{}}},"responses":{"200":"PartyRelationParametersResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/settings/configurations/relatedPartySettings/{relatedPartySettingId}","fullPath":"/api/v1.0.0/settings/configurations/relatedPartySettings/{relatedPartySettingId}","operationId":"updatePartyRelationParameters","name":"Updates the pricing assessment configuration for a set of related parties","summary":"Updates an existing configuration of related parties and redefines the pricing assessment method for the arrangements of each related party","tags":["RETAIL"],"parameters":[{"name":"relatedPartySettingId","in":"path","type":"string","required":true,"description":""},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"relations":[{}],"nonRelationMethod":"string","extensionData":{}}},"responses":{"200":"PartyRelationParametersResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}}]},{"key":"settings-customer-service-v1.0.0","title":"Customer configurations","version":"v1.0.0","description":"Creates customer closure parameter with properties such as enabling new customer closure process at SYSTEM level, and application specific checks for presence of customer data at the level of Id/Field/Api.","endpointCount":3,"endpoints":[{"method":"GET","path":"/settings/customerClosures/parameters/{parameterId}","fullPath":"/api/v1.0.0/settings/customerClosures/parameters/{parameterId}","operationId":"getCustomerClosureParameter","name":"Retrieves customer closure parameter with properties such as enabling new customer closure process at SYSTEM level, and application specific checks for presence of customer data at the level of Id/Field/Api.","summary":"Retrieves customer closure parameter","tags":["OTHERS"],"parameters":[{"name":"parameterId","in":"path","type":"string","required":true,"description":"Identifies the record key of a Parameter table,that acts as a key to access the information specific to them. This holds system or a company as its value."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"CustomerClosureParameterResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"POST","path":"/settings/customerClosures/parameters/{parameterId}","fullPath":"/api/v1.0.0/settings/customerClosures/parameters/{parameterId}","operationId":"createCustomerClosureParameter","name":"Creates customer closure parameter with properties such as enabling new customer closure process at SYSTEM level, and application specific checks for presence of customer data at the level of Id/Field/Api.","summary":"Creates customer closure parameter with properties such as enabling new customer closure process at SYSTEM level, and application specific checks for presence of customer data at the level of Id/Field/Api.","tags":["OTHERS"],"parameters":[{"name":"parameterId","in":"path","type":"string","required":true,"description":"Identifies the record key of a Parameter table,that acts as a key to access the information specific to them. This holds system or a company as its value."},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"applicationAccessLinks":[{}],"enableCustomerClosure":"string","applicationAccessType":"string","applicationCheckApi":"string","extensions":{}}},"responses":{"200":"CustomerClosureParameterResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/settings/customerClosures/parameters/{parameterId}","fullPath":"/api/v1.0.0/settings/customerClosures/parameters/{parameterId}","operationId":"updateCustomerClosureParameter","name":"Updates customer closure parameter with properties such as enabling new customer closure process at SYSTEM level, and application specific checks for presence of customer data at the level of Id/Field/Api.","summary":"Allows amendment of customer closure parameter","tags":["OTHERS"],"parameters":[{"name":"parameterId","in":"path","type":"string","required":true,"description":"Identifies the record key of a Parameter table,that acts as a key to access the information specific to them. This holds system or a company as its value."},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"applicationAccessLinks":[{}],"enableCustomerClosure":"string","applicationAccessType":"string","applicationCheckApi":"string","extensions":{}}},"responses":{"200":"CustomerClosureParameterResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}}]},{"key":"settings-customer-service-v1.1.0","title":"Customer configurations","version":"v1.1.0","description":"Creates customer closure parameter with properties such as enabling new customer closure process at SYSTEM level, and application specific checks for presence of customer data at the level of Id/Field/Api.","endpointCount":3,"endpoints":[{"method":"GET","path":"/settings/customerClosures/parameters/{parameterId}","fullPath":"/api/v1.1.0/settings/customerClosures/parameters/{parameterId}","operationId":"getCustomerClosureParameter","name":"Retrieves customer closure parameter with properties such as enabling new customer closure process at SYSTEM level, and application specific checks for presence of customer data at the level of Id/Field/Api.","summary":"Retrieves customer closure parameter","tags":["OTHERS"],"parameters":[{"name":"parameterId","in":"path","type":"string","required":true,"description":"Identifies the record key of a Parameter table,that acts as a key to access the information specific to them. This holds system or a company as its value."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"CustomerClosureParameterResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"POST","path":"/settings/customerClosures/parameters/{parameterId}","fullPath":"/api/v1.1.0/settings/customerClosures/parameters/{parameterId}","operationId":"createCustomerClosureParameter","name":"Creates customer closure parameter with properties such as enabling new customer closure process at SYSTEM level, and application specific checks for presence of customer data at the level of Id/Field/Api.","summary":"Creates customer closure parameter with properties such as enabling new customer closure process at SYSTEM level, and application specific checks for presence of customer data at the level of Id/Field/Api.","tags":["OTHERS"],"parameters":[{"name":"parameterId","in":"path","type":"string","required":true,"description":"Identifies the record key of a Parameter table,that acts as a key to access the information specific to them. This holds system or a company as its value."},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"applicationAccessLinks":[{}],"applicationAccessType":"string","applicationCheckApi":"string","extensions":{}}},"responses":{"200":"CustomerClosureParameterResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/settings/customerClosures/parameters/{parameterId}","fullPath":"/api/v1.1.0/settings/customerClosures/parameters/{parameterId}","operationId":"updateCustomerClosureParameter","name":"Updates customer closure parameter with properties such as enabling new customer closure process at SYSTEM level, and application specific checks for presence of customer data at the level of Id/Field/Api.","summary":"Allows amendment of customer closure parameter","tags":["OTHERS"],"parameters":[{"name":"parameterId","in":"path","type":"string","required":true,"description":"Identifies the record key of a Parameter table,that acts as a key to access the information specific to them. This holds system or a company as its value."},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"applicationAccessLinks":[{}],"applicationAccessType":"string","applicationCheckApi":"string","extensions":{}}},"responses":{"200":"CustomerClosureParameterResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}}]},{"key":"settings-customer-service-v1.2.0","title":"Customer configurations","version":"v1.2.0","description":"Creates customer closure parameter with properties such as enabling new customer closure process at SYSTEM level, and application specific checks for presence of customer data at the level of Id/Field/Api.","endpointCount":3,"endpoints":[{"method":"POST","path":"/settings/customerClosures/parameters/{parameterId}","fullPath":"/api/v1.2.0/settings/customerClosures/parameters/{parameterId}","operationId":"createCustomerClosureParameter","name":"Creates customer closure parameter with properties such as enabling new customer closure process at SYSTEM level, and application specific checks for presence of customer data at the level of Id/Field/Api.","summary":"Creates customer closure parameter with properties such as enabling new customer closure process at SYSTEM level, and application specific checks for presence of customer data at the level of Id/Field/Api.","tags":["OTHERS"],"parameters":[{"name":"parameterId","in":"path","type":"string","required":true,"description":"Identifies the record key of a Parameter table,that acts as a key to access the information specific to them. This holds system or a company as its value."},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"applicationAccessLinks":[{}],"enableCustomerClosure":"string","applicationAccessType":"string","applicationCheckApi":"string","extensions":{}}},"responses":{"200":"CustomerClosureParameterResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/settings/customerClosures/parameters/{parameterId}","fullPath":"/api/v1.2.0/settings/customerClosures/parameters/{parameterId}","operationId":"updateCustomerClosureParameter","name":"Updates customer closure parameter with properties such as enabling new customer closure process at SYSTEM level, and application specific checks for presence of customer data at the level of Id/Field/Api.","summary":"Allows amendment of customer closure parameter","tags":["OTHERS"],"parameters":[{"name":"parameterId","in":"path","type":"string","required":true,"description":"Identifies the record key of a Parameter table,that acts as a key to access the information specific to them. This holds system or a company as its value."},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"applicationAccessLinks":[{}],"enableCustomerClosure":"string","applicationAccessType":"string","applicationCheckApi":"string","extensions":{}}},"responses":{"200":"CustomerClosureParameterResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/settings/customerClosures/parameters","fullPath":"/api/v1.2.0/settings/customerClosures/parameters","operationId":"getCustomerClosureParameter","name":"Retrieves customer closure parameter with properties such as enabling new customer closure process at SYSTEM level, and application specific checks for presence of customer data at the level of Id/Field/Api.","summary":"Retrieves customer closure parameter","tags":["OTHERS"],"parameters":[{"name":"parameterId","in":"query","type":"string","required":false,"description":"Identifies the record key of a Parameter table,that acts as a key to access the information specific to them. This holds system or a company as its value."},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"CustomerClosureParameterResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}}]},{"key":"settings-paymentsConfiguration-v1.0.0","title":"Static table APIs","version":"v1.0.0","description":"Configuration of static tables","endpointCount":67,"endpoints":[{"method":"PUT","path":"/settings/configuration/payments/channelCutoffs/{channelCutoffId}","fullPath":"/api/v1.0.0/settings/configuration/payments/channelCutoffs/{channelCutoffId}","operationId":"amendPaymentChannelCutoffConfiguration","name":"Update the cut-off configurations for an existing payment channel","summary":"Update the existing payment channel","tags":[],"parameters":[{"name":"channelCutoffId","in":"path","type":"string","required":true,"description":"Identifies the channel cutoff record. ID Format: <channelId>.<currency>.<paymentDirection>.<messageType>-<recordCreationDate>. For example: TIPS.EUR.O.TIPSCTI-20160723"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"clearingNature":[{}],"currencyCode":[{}],"companyId":"string","channel":"channel","paymentCurrency":"paymentCurrency","customerOrBankTransfer":"customerOrBankTransfer","paymentDirection":"paymentDirection","priority":"priority","messageType":"messageType","paymentSource":"paymentSource","cutOffTime":"cutOffTime","fxCutOffTime":"fxCutOffTime","repairCutOffTime":"repairCutOffTime","fxRepairCutOffTime":"fxRepairCutOffTime","settlementShift":"settlementShift"}},"responses":{"200":"PaymentChannelCutoffConfigurationResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/settings/configuration/payments/clearings","fullPath":"/api/v1.0.0/settings/configuration/payments/clearings","operationId":"getPaymentClearingConfigurations","name":"Retrieve the existing payment clearing systems","summary":"Retrieve payment clearing systems","tags":[],"parameters":[{"name":"clearingId","in":"query","type":"string","required":false,"description":"Identifies the clearing system. For example: TIPS"},{"name":"companyId","in":"query","type":"string","required":false,"description":"The identifier of the underlying Entity/Company/Branch."},{"name":"currencyId","in":"query","type":"string","required":false,"description":"Identifier of the currency. This is the 3-letter ISO 4217 code of the currency."},{"name":"countryCode","in":"query","type":"string","required":false,"description":"ISO Country code, IBAN number will be generated based on the structure of this country."},{"name":"clearingName","in":"query","type":"string","required":false,"description":"Describes the clearing that is defined."},{"name":"clearingTransactionIndicator","in":"query","type":"string","required":false,"description":"Indicates whether the clearing is file-based or transaction-based."},{"name":"clearingType","in":"query","type":"string","required":false,"description":"Defines the clearing type. Values can be RTGS,  non-RTGS and instant payments."},{"name":"senderBankBic","in":"query","type":"string","required":false,"description":"Indicates the sending bank BIC Code"},{"name":"rmaCheckIndicator","in":"query","type":"string","required":false,"description":"Indicates if RMA reachability checks need to be performed."},{"name":"clearingBic","in":"query","type":"string","required":false,"description":"BIC code of the clearing institution"},{"name":"bulkingCriteriaApi","in":"query","type":"string","required":false,"description":"Specifies the name of the routine to determine the criteria to bulk transactions together."},{"name":"fileGenerationIndicator","in":"query","type":"string","required":false,"description":"Indicates if a clearing file must be generated by the outgoing settlement process."},{"name":"outMessageFormatApi","in":"query","type":"string","required":false,"description":"Specifies the name of the API that will be invoked to determine the outgoing message type (format) of the payment to be sent to the clearing."},{"name":"maximumTransactionsPerBulk","in":"query","type":"string","required":false,"description":"Indicates the maximum number of transactions that can be settled within a bulk."},{"name":"maximumBulksPerFile","in":"query","type":"string","required":false,"description":"Indicates the maximum number of bulks that can be added in a clearing file."},{"name":"maximumFilesPerCycle","in":"query","type":"string","required":false,"description":"Indicates the maximum number of files that can be sent during a clearing cycle."},{"name":"fileTransferIndicator","in":"query","type":"string","required":false,"description":"Indicates if the file transfer is enabled or not."},{"name":"outboundMessageGenerationApi","in":"query","type":"string","required":false,"description":"API to generate outbound payment messages"},{"name":"outgoingMessageFormat","in":"query","type":"string","required":false,"description":"Indicates the format in which the outgoing message must be sent"},{"name":"nationalClearingCode","in":"query","type":"string","required":false,"description":"National Clearing Code of the company"},{"name":"bulkingMode","in":"query","type":"string","required":false,"description":"Indicates the mode of bulking. Eg: ESB, NonESB"},{"name":"queueName","in":"query","type":"string","required":false,"description":"For queue to queue configuration this field can be used to specify appropriate queue name with a prefix as CFNAME-queueName."},{"name":"schemaXsdFolder","in":"query","type":"string","required":false,"description":"Indicates the directory location of path to the xsd's."},{"name":"styleSheetFolder","in":"query","type":"string","required":false,"description":"Indicates the directory location of path to the StyleSheet folder where xslt's are available."},{"name":"outMessageValidateApi","in":"query","type":"string","required":false,"description":"Holds the name of the ValidateAPI for the validation of the outgoing message."},{"name":"bulkingApi","in":"query","type":"string","required":false,"description":"Holds the name of the BulkingAPI that does the Bulking of one or more Outgoing messages."},{"name":"settlementMethod","in":"query","type":"string","required":false,"description":"Indicates the type or method of settlement."},{"name":"applyInterbankSettlementDate","in":"query","type":"string","required":false,"description":"Indicates if the InterbankSettlementDate received in the positive Settlement Confirmation message (pacs.002) will be used as the 'Value Date' of the payment."},{"name":"outFileValidateApi","in":"query","type":"string","required":false,"description":"Holds the name of the file API that validates the outward file being sent to clearing."},{"name":"interfaceApi","in":"query","type":"string","required":false,"description":"Stores the routine to achieve additional functionality on top of the product functionality."},{"name":"criteriaConfigurationApi","in":"query","type":"string","required":false,"description":"API that stores criteria configuration"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"PaymentClearingConfigurationsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"PUT","path":"/settings/configuration/payments/clearings/{clearingId}","fullPath":"/api/v1.0.0/settings/configuration/payments/clearings/{clearingId}","operationId":"amendPaymentClearingConfiguration","name":"Update an existing payment clearing system","summary":"Update payment clearing systems","tags":[],"parameters":[{"name":"clearingId","in":"path","type":"string","required":true,"description":"Clearing channel specific details"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"clearingCurrency":[{}],"clearingTxnType":[{}],"recall":[{}],"timeOutTransactionTypes":[{}],"countryCode":"countryCode","clearingName":"clearingName","clearingTransactionIndicator":"clearingTransactionIndicator","clearingType":"clearingType","senderBankBic":"senderBankBic","rmaCheckIndicator":"rmaCheckIndicator","clearingBic":"clearingBic","allowUtf8Character":"allowUtf8Character","bulkingCriteriaApi":"bulkingCriteriaApi","fileGenerationIndicator":"fileGenerationIndicator","outMessageFormatApi":"outMessageFormatApi"}},"responses":{"200":"PaymentClearingConfigurationResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/settings/configuration/payments/clearings/clearingSettings/{clearingSettingId}","fullPath":"/api/v1.0.0/settings/configuration/payments/clearings/clearingSettings/{clearingSettingId}","operationId":"amendPaymentClearingSetting","name":"Update configuration for payment clearing systems setting","summary":"Update the payment clearing systems setting ","tags":[],"parameters":[{"name":"clearingSettingId","in":"path","type":"string","required":true,"description":"Identifies the clearing settings record. ID Format: <clearingId>.<currency>.<natureCode>.<messageDirection>.<messageType>-<recordCreationDate>. For example: STEP2.EUR.*.R.pacs.002-20160723"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"clearingSetting":[{}],"clearingId":"clearingId","currencyId":"currencyId","clearingNatureCode":"clearingNatureCode","clearingTransactionType":"clearingTransactionType","paymentDirection":"paymentDirection","messageType":"messageType","clearingAccountNumber":"clearingAccountNumber","suspenseAccountNumber":"suspenseAccountNumber","settlementTransactionIndicator":"settlementTransactionIndicator","manualVerificationIndicator":"manualVerificationIndicator","scheduledForReleaseIndicator":"scheduledForReleaseIndicator","settlementShift":"settlementShift","clearingValidationIndicator":"clearingValidationIndicator","autoReturnIndicator":"autoReturnIndicator"}},"responses":{"200":"PaymentClearingSettingResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"POST","path":"/settings/configuration/payments/customers/conditions/{conditionId}","fullPath":"/api/v1.0.0/settings/configuration/payments/customers/conditions/{conditionId}","operationId":"createPaymentCustomerCondition","name":"Create a new payment related customer condition configuration","summary":"Create new customer specific configuration for payments","tags":[],"parameters":[{"name":"conditionId","in":"path","type":"string","required":true,"description":"Identifier for the associated element conditions. For example: SEPA_NOACK-20200723, PPHPC150224FTKY-20200723"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"currencyCode":[{}],"debitCreditAdvice":[{}],"transactionCurrency":[{}],"debitCreditIndicator":[{}],"clientConditionProduct":"clientConditionProduct","sourceProduct":"sourceProduct","businessLine":"businessLine","customerId":"customerId","accountId":"accountId","accountCurrency":"accountCurrency","accountCompany":"accountCompany","endDate":"endDate","language":"language","debitStatementFormat":"debitStatementFormat","creditStatementFormat":"creditStatementFormat"}},"responses":{"200":"PaymentCustomerConditionResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/settings/configuration/payments/customers/conditions/{conditionId}","fullPath":"/api/v1.0.0/settings/configuration/payments/customers/conditions/{conditionId}","operationId":"amendPaymentCustomerCondition","name":"Update the existing configuration of a payment related customer condition","summary":"Update customer specific configuration for payments","tags":[],"parameters":[{"name":"conditionId","in":"path","type":"string","required":true,"description":"Identifier for the associated element conditions. For example: SEPA_NOACK-20200723, PPHPC150224FTKY-20200723"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"currencyCode":[{}],"debitCreditAdvice":[{}],"transactionCurrency":[{}],"debitCreditIndicator":[{}],"clientConditionProduct":"clientConditionProduct","sourceProduct":"sourceProduct","businessLine":"businessLine","customerId":"customerId","accountId":"accountId","accountCurrency":"accountCurrency","accountCompany":"accountCompany","endDate":"endDate","language":"language","debitStatementFormat":"debitStatementFormat","creditStatementFormat":"creditStatementFormat"}},"responses":{"200":"PaymentCustomerConditionResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"DELETE","path":"/settings/configuration/payments/customers/conditions/{conditionId}","fullPath":"/api/v1.0.0/settings/configuration/payments/customers/conditions/{conditionId}","operationId":"deletePaymentCustomerCondition","name":"Delete an existing payment related customer condition configuration","summary":"Delete existing customer specific configuration for payments","tags":[],"parameters":[{"name":"conditionId","in":"path","type":"string","required":true,"description":"Identifier for the associated element conditions. For example: SEPA_NOACK-20200723, PPHPC150224FTKY-20200723"},{"name":"payload","in":"body","type":"object","required":false,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}}},"responses":{"200":"PaymentCustomerConditionResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/settings/configuration/payments/customers/conditions","fullPath":"/api/v1.0.0/settings/configuration/payments/customers/conditions","operationId":"getPaymentCustomerConditions","name":"Retrieve the existing payment related customer configurations","summary":"Retrieve customer specific configuration for payments","tags":[],"parameters":[{"name":"conditionId","in":"query","type":"string","required":false,"description":"Identifier for the associated element conditions. For example: SEPA_NOACK-20200723, PPHPC150224FTKY-20200723"},{"name":"companyId","in":"query","type":"string","required":false,"description":"The identifier of the underlying Entity/Company/Branch."},{"name":"clientConditionProduct","in":"query","type":"string","required":false,"description":"Identifier for the client condition product"},{"name":"sourceProduct","in":"query","type":"string","required":false,"description":"Indicates the source group from where payments are originated."},{"name":"businessLine","in":"query","type":"string","required":false,"description":"Indicates the business line to which the client belongs."},{"name":"customerId","in":"query","type":"string","required":false,"description":"Identifier of the customer"},{"name":"accountCompany","in":"query","type":"string","required":false,"description":"Company of the account to be created"},{"name":"accountId","in":"query","type":"string","required":false,"description":"Identifier of the account. Often referred to as the account number, yet for consistency this is always referred to as accountId. Accepts both IBAN & BBAN"},{"name":"accountCurrency","in":"query","type":"string","required":false,"description":"Currency of the account. For example: USD, GBP."},{"name":"chargeAccountBalanceCheck","in":"query","type":"string","required":false,"description":"Specifies whether balance check needs to be done on a charge account."},{"name":"recordEndDate","in":"query","type":"string","required":false,"description":"Specifies the date until which the config record is to be considered active"},{"name":"batchConfirmationIndicator","in":"query","type":"string","required":false,"description":"Indicates Acknowledgement and Non Acknowledgement for customer status report at bulk level."},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"PaymentCustomerConditionsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"POST","path":"/settings/configuration/payments/customers/charges/{chargeId}","fullPath":"/api/v1.0.0/settings/configuration/payments/customers/charges/{chargeId}","operationId":"createPaymentCustomerChargeConfiguration","name":"Create a new payment related customer charge configuration","summary":"Create new customer charge configuration for payments","tags":[],"parameters":[{"name":"chargeId","in":"path","type":"string","required":true,"description":"This indicates the charge code which will be triggered for payment stop instruction. Applicable when financial institutions would like to charge for stop payment of cheque etc. "},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"feeTypes":[{}],"feeProduct":"feeProduct","sourceProduct":"sourceProduct","businessLine":"businessLine","customerId":"customerId","accountCompany":"accountCompany","accountId":"accountId","accountCurrency":"accountCurrency","residenceStatus":"residenceStatus","feeCurrency":"feeCurrency","endDate":"endDate"}},"responses":{"200":"PaymentCustomerChargeConfigurationResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/settings/configuration/payments/customers/charges/{chargeId}","fullPath":"/api/v1.0.0/settings/configuration/payments/customers/charges/{chargeId}","operationId":"amendPaymentCustomerChargeConfiguration","name":"Update an existing payment related customer charge configuration","summary":"Update customer charge configuration for payments","tags":[],"parameters":[{"name":"chargeId","in":"path","type":"string","required":true,"description":"This indicates the charge code which will be triggered for payment stop instruction. Applicable when financial institutions would like to charge for stop payment of cheque etc. "},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"feeTypes":[{}],"feeProduct":"feeProduct","sourceProduct":"sourceProduct","businessLine":"businessLine","customerId":"customerId","accountCompany":"accountCompany","accountId":"accountId","accountCurrency":"accountCurrency","residenceStatus":"residenceStatus","feeCurrency":"feeCurrency","endDate":"endDate"}},"responses":{"200":"PaymentCustomerChargeConfigurationResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"DELETE","path":"/settings/configuration/payments/customers/charges/{chargeId}","fullPath":"/api/v1.0.0/settings/configuration/payments/customers/charges/{chargeId}","operationId":"deletePaymentCustomerChargeConfiguration","name":"Delete an existing payment related customer charge configuration","summary":"Delete existing customer charge configuration","tags":[],"parameters":[{"name":"chargeId","in":"path","type":"string","required":true,"description":"This indicates the charge code which will be triggered for payment stop instruction. Applicable when financial institutions would like to charge for stop payment of cheque etc. "},{"name":"payload","in":"body","type":"object","required":false,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}}},"responses":{"200":"PaymentCustomerChargeConfigurationResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"POST","path":"/settings/configuration/payments/customers/conditions/products/{productId}","fullPath":"/api/v1.0.0/settings/configuration/payments/customers/conditions/products/{productId}","operationId":"createPaymentCustomerConditionProductConfiguration","name":"Create a new payment related customer condition product","summary":"Create new customer condition configuration for payments","tags":[],"parameters":[{"name":"productId","in":"path","type":"string","required":true,"description":"Contains the unique identifier of the product, e.g. the product id of the arrangement account."},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"clientCondProduct":[{}]}},"responses":{"200":"PaymentCustomerConditionProductConfigurationResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/settings/configuration/payments/customers/conditions/products/{productId}","fullPath":"/api/v1.0.0/settings/configuration/payments/customers/conditions/products/{productId}","operationId":"amendPaymentCustomerConditionProductConfiguration","name":"Update an existing payment related customer condition product","summary":"Update customer condition configuration for payments","tags":[],"parameters":[{"name":"productId","in":"path","type":"string","required":true,"description":"Contains the unique identifier of the product, e.g. the product id of the arrangement account."},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"clientCondProduct":[{}]}},"responses":{"200":"PaymentCustomerConditionProductConfigurationResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"DELETE","path":"/settings/configuration/payments/customers/conditions/products/{productId}","fullPath":"/api/v1.0.0/settings/configuration/payments/customers/conditions/products/{productId}","operationId":"deletePaymentCustomerConditionProductConfiguration","name":"Delete an existing payment related customer condition product","summary":"Delete existing customer condition configuration for payments","tags":[],"parameters":[{"name":"productId","in":"path","type":"string","required":true,"description":"Contains the unique identifier of the product, e.g. the product id of the arrangement account."},{"name":"payload","in":"body","type":"object","required":false,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}}},"responses":{"200":"PaymentCustomerConditionProductConfigurationResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/settings/configuration/payments/customers/conditions/products","fullPath":"/api/v1.0.0/settings/configuration/payments/customers/conditions/products","operationId":"getPaymentCustomerConditionProductConfigurations","name":"Retrieve existing payment related customer condition products","summary":"Retrieve customer condition configuration for payments","tags":[],"parameters":[{"name":"productId","in":"query","type":"string","required":false,"description":"Contains the unique identifier of the product, e.g. the product id of the arrangement account."},{"name":"companyId","in":"query","type":"string","required":false,"description":"The identifier of the underlying Entity/Company/Branch."},{"name":"description","in":"query","type":"string","required":false,"description":"Contains the description of purpose of the payment."},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"PaymentCustomerConditionProductConfigurationsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/settings/configuration/payments/fees/products","fullPath":"/api/v1.0.0/settings/configuration/payments/fees/products","operationId":"getPaymentFeeProductConfigurations","name":"Retrieve the existing configurations of payment fee products","summary":"Retrieve payment fee product configurations","tags":[],"parameters":[{"name":"productId","in":"query","type":"string","required":false,"description":"Contains the unique identifier of the product, e.g. the product id of the arrangement account."},{"name":"companyId","in":"query","type":"string","required":false,"description":"The identifier of the underlying Entity/Company/Branch."},{"name":"feeProduct","in":"query","type":"string","required":false,"description":"Contains the unique identifier of the fee product"},{"name":"description","in":"query","type":"string","required":false,"description":"Contains the description of purpose of the payment."},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"PaymentFeeProductConfigurationsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"POST","path":"/settings/configuration/payments/fees/products/{productId}","fullPath":"/api/v1.0.0/settings/configuration/payments/fees/products/{productId}","operationId":"createPaymentFeeProductConfiguration","name":"Create and configure a new payment fee product","summary":"Create new payment fee products","tags":[],"parameters":[{"name":"productId","in":"path","type":"string","required":true,"description":"Contains the unique identifier of the product, e.g. the product id of the arrangement account."},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"fee":[{}]}},"responses":{"200":"PaymentFeeProductConfigurationResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/settings/configuration/payments/fees/products/{productId}","fullPath":"/api/v1.0.0/settings/configuration/payments/fees/products/{productId}","operationId":"amendPaymentFeeProductConfiguration","name":"Update the configuration of an existing payment fee product","summary":"Update payment fee product configuration","tags":[],"parameters":[{"name":"productId","in":"path","type":"string","required":true,"description":"Contains the unique identifier of the product, e.g. the product id of the arrangement account."},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"fee":[{}]}},"responses":{"200":"PaymentFeeProductConfigurationResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"DELETE","path":"/settings/configuration/payments/fees/products/{productId}","fullPath":"/api/v1.0.0/settings/configuration/payments/fees/products/{productId}","operationId":"deletePaymentFeeProductConfiguration","name":"Delete an existing payment fee product","summary":"Delete an existing payment fee product","tags":[],"parameters":[{"name":"productId","in":"path","type":"string","required":true,"description":"Contains the unique identifier of the product, e.g. the product id of the arrangement account."},{"name":"payload","in":"body","type":"object","required":false,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}}},"responses":{"200":"PaymentFeeProductConfigurationResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"POST","path":"/settings/configuration/payments/fees/feeTypes/{feeTypeId}","fullPath":"/api/v1.0.0/settings/configuration/payments/fees/feeTypes/{feeTypeId}","operationId":"createPaymentFeeTypeConfiguration","name":"Create and configure a new payment fee type","summary":"Create new payment fee types","tags":[],"parameters":[{"name":"feeTypeId","in":"path","type":"string","required":true,"description":"Identifier of the fee type. For example: REDIRECTFEE and FXFEE"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"fee":[{}],"conditionalIndicator":"conditionalIndicator","allowBeneficiaryCharge":"allowBeneficiaryCharge","taxPercentOnCharge":"taxPercentOnCharge","taxId":"taxId","taxIdType":"taxIdType","feeApi":"feeApi"}},"responses":{"200":"PaymentFeeTypeConfigurationResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/settings/configuration/payments/fees/feeTypes/{feeTypeId}","fullPath":"/api/v1.0.0/settings/configuration/payments/fees/feeTypes/{feeTypeId}","operationId":"amendPaymentFeeTypeConfiguration","name":"Update the configuration of an existing payment fee type","summary":"Update payment fee type configuration","tags":[],"parameters":[{"name":"feeTypeId","in":"path","type":"string","required":true,"description":"Identifier of the fee type. For example: REDIRECTFEE and FXFEE"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"fee":[{}],"conditionalIndicator":"conditionalIndicator","allowBeneficiaryCharge":"allowBeneficiaryCharge","taxPercentOnCharge":"taxPercentOnCharge","taxId":"taxId","taxIdType":"taxIdType","feeApi":"feeApi"}},"responses":{"200":"PaymentFeeTypeConfigurationResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"DELETE","path":"/settings/configuration/payments/fees/feeTypes/{feeTypeId}","fullPath":"/api/v1.0.0/settings/configuration/payments/fees/feeTypes/{feeTypeId}","operationId":"deletePaymentFeeTypeConfiguration","name":"Delete an existing payment fee type","summary":"Delete an existing payment fee types","tags":[],"parameters":[{"name":"feeTypeId","in":"path","type":"string","required":true,"description":"Identifier of the fee type. For example: REDIRECTFEE and FXFEE"},{"name":"payload","in":"body","type":"object","required":false,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}}},"responses":{"200":"PaymentFeeTypeConfigurationResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/settings/configuration/payments/fees/feeTypes","fullPath":"/api/v1.0.0/settings/configuration/payments/fees/feeTypes","operationId":"getPaymentFeeTypeConfigurations","name":"Retrieve existing payment fee type configurations","summary":"Retrieve payment fee type configurations","tags":[],"parameters":[{"name":"feeTypeId","in":"query","type":"string","required":false,"description":"Identifier of the fee type. For example: REDIRECTFEE and FXFEE"},{"name":"conditionalIndicator","in":"query","type":"string","required":false,"description":"Differentiates if the fee type is conditional or unconditional."},{"name":"allowBeneficiaryCharge","in":"query","type":"string","required":false,"description":"Indicates if a beneficiary party can be charged in case of OUR payment."},{"name":"taxPercentOnCharge","in":"query","type":"string","required":false,"description":"Tax in percent to be applied on charges."},{"name":"feeApi","in":"query","type":"string","required":false,"description":"Holds the API to be used to calculate the fee"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"PaymentFeeTypeConfigurationsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/settings/configuration/payments/products/conditions/lightWeightProducts","fullPath":"/api/v1.0.0/settings/configuration/payments/products/conditions/lightWeightProducts","operationId":"getPaymentLightWeightProductConfigurations","name":"Retrieve the existing configurations for light weight payment products","summary":"Retrieve light weight payment product configuration","tags":[],"parameters":[{"name":"lightWeightProductId","in":"query","type":"string","required":false,"description":"Identifier of the light weight product. For example: USACH.ACHDDST-20200723"},{"name":"companyId","in":"query","type":"string","required":false,"description":"The identifier of the underlying Entity/Company/Branch."},{"name":"paymentSource","in":"query","type":"string","required":false,"description":"Indicates the source from where the payment is originated"},{"name":"messageType","in":"query","type":"string","required":false,"description":"Defines the type of swift messages that are sent or received for a transaction"},{"name":"clearingNatureCode","in":"query","type":"string","required":false,"description":"Contains the nature of the payment transaction"},{"name":"settlementIndicator","in":"query","type":"string","required":false,"description":"Contains if the settlement is manual or automatic. It will be set to \u00e2\u20ac\u02dcY\u00e2\u20ac\u2122 if settlement is done automatically"},{"name":"rateFix","in":"query","type":"string","required":false,"description":"Indicates if Rate Fixing Functionality must be enabled. If enabled, the system will park the transaction in a new Status code for Awaiting rate fixing."},{"name":"forwardEntryFlag","in":"query","type":"string","required":false,"description":"Defines if forward entries needs to be raised for a payment"},{"name":"paymentOrderStpIndicator","in":"query","type":"string","required":false,"description":"Identifies if payments from Payment Order application or any other external application should be routed to repair or processed via STP."},{"name":"recordEndDate","in":"query","type":"string","required":false,"description":"Specifies the date until which the config record is to be considered active"},{"name":"currencyMarket","in":"query","type":"string","required":false,"description":"Identifies the currency market to be used to get the correct exchange and revaluation rates to be applied to each currency"},{"name":"transactionStopMapRule","in":"query","type":"string","required":false,"description":"Indicates if Debit Account Validation using Transaction Stop Module must be performed"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"PaymentLightWeightProductConfigurationsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"POST","path":"/settings/configuration/payments/products/conditions/lightWeightProducts/{lightWeightProductId}","fullPath":"/api/v1.0.0/settings/configuration/payments/products/conditions/lightWeightProducts/{lightWeightProductId}","operationId":"createPaymentLightWeightProductConfiguration","name":"Create and configure a new light weight payment product","summary":"Create new light weight payment products","tags":[],"parameters":[{"name":"lightWeightProductId","in":"path","type":"string","required":true,"description":"Identifier of the light weight product. For example: USACH.ACHDDST-20200723"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"paymentSource":"paymentSource","messageType":"messageType","domesticOrInternational":"domesticOrInternational","clearingTransactionType":"clearingTransactionType","clearingNatureCode":"clearingNatureCode","settlementIndicator":"settlementIndicator","paymentDirection":"paymentDirection","endDate":"endDate","clientConditionProduct":"clientConditionProduct","sourceProduct":"sourceProduct","routingProduct":"routingProduct","feeProduct":"feeProduct","postingProduct":"postingProduct","debitBookCode":"debitBookCode","debitChargeBookCode":"debitChargeBookCode"}},"responses":{"200":"PaymentLightWeightProductConfigurationResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/settings/configuration/payments/products/conditions/lightWeightProducts/{lightWeightProductId}","fullPath":"/api/v1.0.0/settings/configuration/payments/products/conditions/lightWeightProducts/{lightWeightProductId}","operationId":"amendPaymentLightWeightProductConfiguration","name":"Update the configuration of an existing light weight payment product","summary":"Update light weight payment product configuration","tags":[],"parameters":[{"name":"lightWeightProductId","in":"path","type":"string","required":true,"description":"Identifier of the light weight product. For example: USACH.ACHDDST-20200723"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"paymentSource":"paymentSource","messageType":"messageType","domesticOrInternational":"domesticOrInternational","clearingTransactionType":"clearingTransactionType","clearingNatureCode":"clearingNatureCode","settlementIndicator":"settlementIndicator","paymentDirection":"paymentDirection","endDate":"endDate","clientConditionProduct":"clientConditionProduct","sourceProduct":"sourceProduct","routingProduct":"routingProduct","feeProduct":"feeProduct","postingProduct":"postingProduct","debitBookCode":"debitBookCode","debitChargeBookCode":"debitChargeBookCode"}},"responses":{"200":"PaymentLightWeightProductConfigurationResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"DELETE","path":"/settings/configuration/payments/products/conditions/lightWeightProducts/{lightWeightProductId}","fullPath":"/api/v1.0.0/settings/configuration/payments/products/conditions/lightWeightProducts/{lightWeightProductId}","operationId":"deletePaymentLightWeightProductConfiguration","name":"Delete an existing light weight payment product","summary":"Delete an existing light weight payment products","tags":[],"parameters":[{"name":"lightWeightProductId","in":"path","type":"string","required":true,"description":"Identifier of the light weight product. For example: USACH.ACHDDST-20200723"},{"name":"payload","in":"body","type":"object","required":false,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}}},"responses":{"200":"PaymentLightWeightProductConfigurationResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"POST","path":"/settings/configuration/payments/products/conditions/mediumWeightProducts/{mediumWeightProductId}","fullPath":"/api/v1.0.0/settings/configuration/payments/products/conditions/mediumWeightProducts/{mediumWeightProductId}","operationId":"createPaymentMediumWeightProductConfiguration","name":"Create and configure a new medium weight payment product","summary":"Create new medium weight payment products","tags":[],"parameters":[{"name":"mediumWeightProductId","in":"path","type":"string","required":true,"description":"Identifier of the medium weight product. For example: PPMPC161130P7VG-20190723"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"mediumWeight":[{}],"paymentDirection":"paymentDirection","clearingTransactionType":"clearingTransactionType","singleOrBatchClearing":"singleOrBatchClearing","chargeType":"chargeType","currency":"currency","paymentSource":"paymentSource","messageType":"messageType","clearingNatureCode":"clearingNatureCode","beneficiaryCountryId":"beneficiaryCountryId","orderingPartyCountry":"orderingPartyCountry","beneficiaryIbanPresent":"beneficiaryIbanPresent","orderingIbanPresent":"orderingIbanPresent","beneficiaryBicPresent":"beneficiaryBicPresent","orderingBicPresent":"orderingBicPresent"}},"responses":{"200":"PaymentMediumWeightProductConfigurationResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/settings/configuration/payments/products/conditions/mediumWeightProducts/{mediumWeightProductId}","fullPath":"/api/v1.0.0/settings/configuration/payments/products/conditions/mediumWeightProducts/{mediumWeightProductId}","operationId":"amendPaymentMediumWeightProductConfiguration","name":"Update the configuration of an existing medium weight payment product","summary":"Update medium weight payment product configuration","tags":[],"parameters":[{"name":"mediumWeightProductId","in":"path","type":"string","required":true,"description":"Identifier of the medium weight product. For example: PPMPC161130P7VG-20190723"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"mediumWeight":[{}],"paymentDirection":"paymentDirection","clearingTransactionType":"clearingTransactionType","singleOrBatchClearing":"singleOrBatchClearing","chargeType":"chargeType","currency":"currency","paymentSource":"paymentSource","messageType":"messageType","clearingNatureCode":"clearingNatureCode","beneficiaryCountryId":"beneficiaryCountryId","orderingPartyCountry":"orderingPartyCountry","beneficiaryIbanPresent":"beneficiaryIbanPresent","orderingIbanPresent":"orderingIbanPresent","beneficiaryBicPresent":"beneficiaryBicPresent","orderingBicPresent":"orderingBicPresent"}},"responses":{"200":"PaymentMediumWeightProductConfigurationResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"DELETE","path":"/settings/configuration/payments/products/conditions/mediumWeightProducts/{mediumWeightProductId}","fullPath":"/api/v1.0.0/settings/configuration/payments/products/conditions/mediumWeightProducts/{mediumWeightProductId}","operationId":"deletePaymentMediumWeightProductConfiguration","name":"Delete an existing medium weight payment product","summary":"Delete an existing medium weight payment products","tags":[],"parameters":[{"name":"mediumWeightProductId","in":"path","type":"string","required":true,"description":""},{"name":"payload","in":"body","type":"object","required":false,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}}},"responses":{"200":"PaymentMediumWeightProductConfigurationResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"POST","path":"/settings/configuration/payments/paymentOrders/{paymentOrderId}","fullPath":"/api/v1.0.0/settings/configuration/payments/paymentOrders/{paymentOrderId}","operationId":"createPaymentOrderConfiguration","name":"Create a new default configuration for payment orders","summary":"Create new parameter which connects payment order and payment system","tags":[],"parameters":[{"name":"paymentOrderId","in":"path","type":"string","required":true,"description":"The unique reference number of payment"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"poParam":[{}],"paymentConnectionMethod":"string","warehouseRequired":"string","archiveDays":"archiveDays","mappingRoutine":"mappingRoutine","mappingRecord":"mappingRecord","connectionRule":"connectionRule","connectionApi":"connectionApi","simulationExpiryTime":"simulationExpiryTime","purgeAwaitSubmitPrd":"purgeAwaitSubmitPrd","defaultProductRule":"defaultProductRule","defaultProductApi":"defaultProductApi","fraudRoutine":"fraudRoutine","accountLocatorApi":"accountLocatorApi","accountLocatorRule":"accountLocatorRule"}},"responses":{"200":"PaymentOrderConfigurationResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/settings/configuration/payments/paymentOrders/{paymentOrderId}","fullPath":"/api/v1.0.0/settings/configuration/payments/paymentOrders/{paymentOrderId}","operationId":"amendPaymentOrderConfiguration","name":"Update the default configuration for payment orders","summary":"Update the parameter which connects payment order and payment system","tags":[],"parameters":[{"name":"paymentOrderId","in":"path","type":"string","required":true,"description":"The unique reference number of payment"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"poParam":[{}],"paymentConnectionMethod":"string","warehouseRequired":"string","archiveDays":"archiveDays","mappingRoutine":"mappingRoutine","mappingRecord":"mappingRecord","connectionRule":"connectionRule","connectionApi":"connectionApi","simulationExpiryTime":"simulationExpiryTime","purgeAwaitSubmitPrd":"purgeAwaitSubmitPrd","defaultProductRule":"defaultProductRule","defaultProductApi":"defaultProductApi","fraudRoutine":"fraudRoutine","accountLocatorApi":"accountLocatorApi","accountLocatorRule":"accountLocatorRule"}},"responses":{"200":"PaymentOrderConfigurationResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"POST","path":"/settings/configuration/payments/accounting/postingSets/{postingSetId}","fullPath":"/api/v1.0.0/settings/configuration/payments/accounting/postingSets/{postingSetId}","operationId":"createPaymentPostingSetConfiguration","name":"Create and configure a new payment posting set","summary":"Create new payment posting sets","tags":[],"parameters":[{"name":"postingSetId","in":"path","type":"string","required":true,"description":"Posting set identifier. ID Format: <postingProduct>.<rank>-<recordCreationDate>. For example: SEPA_OUTDD.2-20160723"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"postingSet":[{}],"postingProduct":"postingProduct","rank":"rank","separateChargeBooking":"separateChargeBooking","chargePostingInDetail":"chargePostingInDetail","taxOnPrincipal":"taxOnPrincipal","taxOnCharge":"taxOnCharge","ocpPostingFlag":"ocpPostingFlag","endDate":"endDate"}},"responses":{"200":"PaymentPostingSetConfigurationResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/settings/configuration/payments/accounting/postingSets/{postingSetId}","fullPath":"/api/v1.0.0/settings/configuration/payments/accounting/postingSets/{postingSetId}","operationId":"amendPaymentPostingSetConfiguration","name":"Update the configuration of an existing payment posting set","summary":"Update payment posting set configuration","tags":[],"parameters":[{"name":"postingSetId","in":"path","type":"string","required":true,"description":"Posting set identifier. ID Format: <postingProduct>.<rank>-<recordCreationDate>. For example: SEPA_OUTDD.2-20160723"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"postingSet":[{}],"postingProduct":"postingProduct","rank":"rank","separateChargeBooking":"separateChargeBooking","chargePostingInDetail":"chargePostingInDetail","taxOnPrincipal":"taxOnPrincipal","taxOnCharge":"taxOnCharge","ocpPostingFlag":"ocpPostingFlag","endDate":"endDate"}},"responses":{"200":"PaymentPostingSetConfigurationResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"DELETE","path":"/settings/configuration/payments/accounting/postingSets/{postingSetId}","fullPath":"/api/v1.0.0/settings/configuration/payments/accounting/postingSets/{postingSetId}","operationId":"deletePaymentPostingSetConfiguration","name":"Delete an existing payment posting set","summary":"Delete an existing payment posting sets","tags":[],"parameters":[{"name":"postingSetId","in":"path","type":"string","required":true,"description":"Posting set identifier. ID Format: <postingProduct>.<rank>-<recordCreationDate>. For example: SEPA_OUTDD.2-20160723"},{"name":"payload","in":"body","type":"object","required":false,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}}},"responses":{"200":"PaymentPostingSetConfigurationResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/settings/configuration/payments/accounting/postingSets","fullPath":"/api/v1.0.0/settings/configuration/payments/accounting/postingSets","operationId":"getPaymentPostingSetConfigurations","name":"Retrieve configurations of existing payment posting sets","summary":"Retrieve payment posting set configuration","tags":[],"parameters":[{"name":"postingSetId","in":"query","type":"string","required":false,"description":"Posting set identifier. ID Format: <postingProduct>.<rank>-<recordCreationDate>. For example: SEPA_OUTDD.2-20160723"},{"name":"companyId","in":"query","type":"string","required":false,"description":"The identifier of the underlying Entity/Company/Branch."},{"name":"postingProduct","in":"query","type":"string","required":false,"description":"Indicates the posting Product to be used for the payment."},{"name":"rank","in":"query","type":"string","required":false,"description":"Indicates the rank of the payment order product within the group."},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"PaymentPostingSetConfigurationsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/settings/configuration/payments/programs/weightAssignments","fullPath":"/api/v1.0.0/settings/configuration/payments/programs/weightAssignments","operationId":"getPaymentProgramWeightAssignments","name":"Retrieve configurations of existing payment program weight assignments","summary":"Retrieve payment program weight assignments","tags":[],"parameters":[{"name":"weightAssignmentId","in":"query","type":"string","required":false,"description":"Weight assignment identifier. For example: BalanceCheckWithChg."},{"name":"companyId","in":"query","type":"string","required":false,"description":"The identifier of the underlying Entity/Company/Branch."},{"name":"weightCode","in":"query","type":"string","required":false,"description":"Indicates the specific product condition weight code."},{"name":"rank","in":"query","type":"string","required":false,"description":"Indicates the rank of the payment order product within the group."},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"PaymentProgramWeightAssignmentsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"PUT","path":"/settings/configuration/payments/programs/weightAssignments/{weightAssignmentId}","fullPath":"/api/v1.0.0/settings/configuration/payments/programs/weightAssignments/{weightAssignmentId}","operationId":"amendPaymentProgramWeightAssignment","name":"Update the configuration of an existing payment program weight assignment","summary":"Update payment program weight assignments","tags":[],"parameters":[{"name":"weightAssignmentId","in":"path","type":"string","required":true,"description":"Weight assignment identifier. For example: BalanceCheckWithChg."},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"weight":[{}]}},"responses":{"200":"PaymentProgramWeightAssignmentResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"POST","path":"/settings/configuration/payments/accounting/postingSets/statementFormats/{statementFormatId}","fullPath":"/api/v1.0.0/settings/configuration/payments/accounting/postingSets/statementFormats/{statementFormatId}","operationId":"createPaymentStatementFormat","name":"Create and configure a new payment statement format","summary":"Create new payment status formats","tags":[],"parameters":[{"name":"statementFormatId","in":"path","type":"string","required":true,"description":"Statement format identifier. For example: BankClaim, CustCreditBook"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"statement":[{}]}},"responses":{"200":"PaymentStatementFormatResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/settings/configuration/payments/accounting/postingSets/statementFormats/{statementFormatId}","fullPath":"/api/v1.0.0/settings/configuration/payments/accounting/postingSets/statementFormats/{statementFormatId}","operationId":"amendPaymentStatementFormat","name":"Update the configuration of an existing payment statement format","summary":"Update payment status format configuration","tags":[],"parameters":[{"name":"statementFormatId","in":"path","type":"string","required":true,"description":"Statement format identifier. For example: BankClaim, CustCreditBook"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"statement":[{}]}},"responses":{"200":"PaymentStatementFormatResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"DELETE","path":"/settings/configuration/payments/accounting/postingSets/statementFormats/{statementFormatId}","fullPath":"/api/v1.0.0/settings/configuration/payments/accounting/postingSets/statementFormats/{statementFormatId}","operationId":"deletePaymentStatementFormat","name":"Delete an existing payment statement format","summary":"Delete an existing payment status formats","tags":[],"parameters":[{"name":"statementFormatId","in":"path","type":"string","required":true,"description":"Statement format identifier. For example: BankClaim, CustCreditBook"},{"name":"payload","in":"body","type":"object","required":false,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}}},"responses":{"200":"PaymentStatementFormatResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/settings/configuration/payments/accounting/postingSets/statementFormats","fullPath":"/api/v1.0.0/settings/configuration/payments/accounting/postingSets/statementFormats","operationId":"getPaymentStatementFormats","name":"Retrieve configurations of existing payment statement formats","summary":"Retrieve payment status format configurations","tags":[],"parameters":[{"name":"statementFormatId","in":"query","type":"string","required":false,"description":"Statement format identifier. For example: BankClaim, CustCreditBook"},{"name":"companyId","in":"query","type":"string","required":false,"description":"The identifier of the underlying Entity/Company/Branch."},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"PaymentStatementFormatsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"POST","path":"/settings/configuration/payments/status/statusActions/{statusActionId}","fullPath":"/api/v1.0.0/settings/configuration/payments/status/statusActions/{statusActionId}","operationId":"createPaymentStatusActionConfiguration","name":"Create and configure a new payment status action","summary":"Create new payment status actions","tags":[],"parameters":[{"name":"statusActionId","in":"path","type":"string","required":true,"description":"Status action identifier. For example: 999.ACCLM"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"status":[{}],"statusEvent":[{}],"statusExclusionApi":"statusExclusionApi"}},"responses":{"200":"PaymentStatusActionConfigurationResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/settings/configuration/payments/status/statusActions/{statusActionId}","fullPath":"/api/v1.0.0/settings/configuration/payments/status/statusActions/{statusActionId}","operationId":"amendPaymentStatusActionConfiguration","name":"Update the configuration of an existing payment status action","summary":"Update payment status actions","tags":[],"parameters":[{"name":"statusActionId","in":"path","type":"string","required":true,"description":"Status action identifier. For example: 999.ACCLM"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"status":[{}],"statusEvent":[{}],"statusExclusionApi":"statusExclusionApi"}},"responses":{"200":"PaymentStatusActionConfigurationResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"DELETE","path":"/settings/configuration/payments/status/statusActions/{statusActionId}","fullPath":"/api/v1.0.0/settings/configuration/payments/status/statusActions/{statusActionId}","operationId":"deletePaymentStatusActionConfiguration","name":"Delete an existing payment status action","summary":"Delete an existing payment status actions","tags":[],"parameters":[{"name":"statusActionId","in":"path","type":"string","required":true,"description":"Status action identifier. For example: 999.ACCLM"},{"name":"payload","in":"body","type":"object","required":false,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}}},"responses":{"200":"PaymentStatusActionConfigurationResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/settings/configuration/payments/status/statusActions","fullPath":"/api/v1.0.0/settings/configuration/payments/status/statusActions","operationId":"getPaymentStatusActionConfigurations","name":"Retrieve the existing configurations of payment status actions","summary":"Retrieve payment status actions","tags":[],"parameters":[{"name":"statusActionId","in":"query","type":"string","required":false,"description":"Status action identifier. For example: 999.ACCLM"},{"name":"companyId","in":"query","type":"string","required":false,"description":"The identifier of the underlying Entity/Company/Branch."},{"name":"programName","in":"query","type":"string","required":false,"description":"Holds the name of the extensible program that can handle various stages of STP processing like Dates Calculation ,  Account Validation etc.."},{"name":"statusDescription","in":"query","type":"string","required":false,"description":"Specifies status description to be sent to the monitoring system in case of non succesful event."},{"name":"statusRouterExpectedErrorCode","in":"query","type":"string","required":false,"description":"Specifies the error code expected by the monitoring system in case of non-successful event."},{"name":"statusEventType","in":"query","type":"string","required":false,"description":"Indicates the event that needs to be triggered when the payment is parked in specific business state."},{"name":"statusExclusionApi","in":"query","type":"string","required":false,"description":"Specifies the API that decides whether an event trigger needs to be excluded or not."},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"PaymentStatusActionConfigurationsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"POST","path":"/settings/configuration/payments/paymentRegions/{countryCode}","fullPath":"/api/v1.0.0/settings/configuration/payments/paymentRegions/{countryCode}","operationId":"createPaymentRegionConfiguration","name":"Create the new payment region configuration","summary":"Create new payment region","tags":[],"parameters":[{"name":"countryCode","in":"path","type":"string","required":true,"description":"ISO Country code, IBAN number will be generated based on the structure of this country."},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"regions":[{}]}},"responses":{"200":"PaymentRegionConfigurationResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/settings/configuration/payments/paymentRegions/{countryCode}","fullPath":"/api/v1.0.0/settings/configuration/payments/paymentRegions/{countryCode}","operationId":"amendPaymentRegionConfiguration","name":"Update the existing payment region configuration","summary":"Update payment region","tags":[],"parameters":[{"name":"countryCode","in":"path","type":"string","required":true,"description":"ISO Country code, IBAN number will be generated based on the structure of this country."},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"regions":[{}]}},"responses":{"200":"PaymentRegionConfigurationResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"DELETE","path":"/settings/configuration/payments/paymentRegions/{countryCode}","fullPath":"/api/v1.0.0/settings/configuration/payments/paymentRegions/{countryCode}","operationId":"deletePaymentRegionConfiguration","name":"Delete the existing payment region configuration","summary":"Delete an existing payment region","tags":[],"parameters":[{"name":"countryCode","in":"path","type":"string","required":true,"description":"ISO Country code, IBAN number will be generated based on the structure of this country."},{"name":"payload","in":"body","type":"object","required":false,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}}},"responses":{"200":"PaymentRegionConfigurationResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/settings/configuration/payments/paymentRegions","fullPath":"/api/v1.0.0/settings/configuration/payments/paymentRegions","operationId":"getPaymentRegionConfigurations","name":"Retrieve the existing payment region configuration","summary":"Retrieve payment regions","tags":[],"parameters":[{"name":"countryCode","in":"query","type":"string","required":false,"description":"ISO Country code, IBAN number will be generated based on the structure of this country."},{"name":"region","in":"query","type":"string","required":false,"description":"Name of the region used for display or enrichment"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"PaymentRegionConfigurationsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"POST","path":"/settings/configuration/payments/filterings/{filteringId}","fullPath":"/api/v1.0.0/settings/configuration/payments/filterings/{filteringId}","operationId":"createFilteringPaymentConfiguration","name":"Create a new filtering payment configuration","summary":"Create new filtering payment","tags":[],"parameters":[{"name":"filteringId","in":"path","type":"string","required":true,"description":"Indicates the filtering product of a payment. Examples: BKINCSKIP, AMTLT1000, INCOMING"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"ranks":[{}],"detailLevelToEmit":"detailLevelToEmit"}},"responses":{"200":"FilteringPaymentConfigurationResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/settings/configuration/payments/filterings/{filteringId}","fullPath":"/api/v1.0.0/settings/configuration/payments/filterings/{filteringId}","operationId":"amendFilteringPaymentConfiguration","name":"Update the existing filtering payment configuration","summary":"Update filtering payment","tags":[],"parameters":[{"name":"filteringId","in":"path","type":"string","required":true,"description":"Indicates the filtering product of a payment. Examples: BKINCSKIP, AMTLT1000, INCOMING"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"ranks":[{}],"detailLevelToEmit":"detailLevelToEmit"}},"responses":{"200":"FilteringPaymentConfigurationResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"DELETE","path":"/settings/configuration/payments/filterings/{filteringId}","fullPath":"/api/v1.0.0/settings/configuration/payments/filterings/{filteringId}","operationId":"deleteFilteringPaymentConfiguration","name":"Delete the existing filtering payment configuration","summary":"Delete an existing filtering payment","tags":[],"parameters":[{"name":"filteringId","in":"path","type":"string","required":true,"description":"Indicates the filtering product of a payment. Examples: BKINCSKIP, AMTLT1000, INCOMING"},{"name":"payload","in":"body","type":"object","required":false,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}}},"responses":{"200":"FilteringPaymentConfigurationResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"POST","path":"/settings/configuration/payments/extensibilityHooks/{extensibilityHookId}","fullPath":"/api/v1.0.0/settings/configuration/payments/extensibilityHooks/{extensibilityHookId}","operationId":"createPaymentExtensibilityHookConfiguration","name":"Create new payment extensibility hooks configuration","summary":"Create new payment extensibility hooks configuration","tags":[],"parameters":[{"name":"extensibilityHookId","in":"path","type":"string","required":true,"description":"Holds the name of the component for which extensible program can be configured."},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"programNames":[{}]}},"responses":{"200":"PaymentExtensibilityHookConfigurationResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/settings/configuration/payments/extensibilityHooks/{extensibilityHookId}","fullPath":"/api/v1.0.0/settings/configuration/payments/extensibilityHooks/{extensibilityHookId}","operationId":"amendPaymentExtensibilityHookConfiguration","name":"Update existing payment extensibility hooks configuration","summary":"Update existing payment extensibility hooks configuration","tags":[],"parameters":[{"name":"extensibilityHookId","in":"path","type":"string","required":true,"description":"Holds the name of the component for which extensible program can be configured."},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"programNames":[{}]}},"responses":{"200":"PaymentExtensibilityHookConfigurationResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"DELETE","path":"/settings/configuration/payments/extensibilityHooks/{extensibilityHookId}","fullPath":"/api/v1.0.0/settings/configuration/payments/extensibilityHooks/{extensibilityHookId}","operationId":"deletePaymentExtensibilityHookConfiguration","name":"Delete existing payment extensibility hooks configuration","summary":"Delete existing payment extensibility hooks configuration","tags":[],"parameters":[{"name":"extensibilityHookId","in":"path","type":"string","required":true,"description":"Holds the name of the component for which extensible program can be configured."},{"name":"payload","in":"body","type":"object","required":false,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}}},"responses":{"200":"PaymentExtensibilityHookConfigurationResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/settings/configuration/payments/extensibilityHooks","fullPath":"/api/v1.0.0/settings/configuration/payments/extensibilityHooks","operationId":"getPaymentExtensibilityHookConfigurations","name":"Retrieve existing payment extensibility hooks configuration","summary":"Retrieve existing payment extensibility hooks configuration","tags":[],"parameters":[{"name":"extensibilityHookId","in":"query","type":"string","required":false,"description":"Holds the name of the component for which extensible program can be configured."},{"name":"programName","in":"query","type":"string","required":false,"description":"Holds the name of the extensible program that can handle various stages of STP processing like Dates Calculation ,  Account Validation etc.."},{"name":"programInvokeStage","in":"query","type":"string","required":false,"description":"Indicates when the extensibility program should be called. Possible values: beginning (PRE), end (POST) and if value is null then considered as 'POST'."},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"PaymentExtensibilityHookConfigurationsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/settings/configuration/payments/channelCutoffs","fullPath":"/api/v1.0.0/settings/configuration/payments/channelCutoffs","operationId":"getPaymentChannelCutoffConfigurations","name":"Retrieve the cut-off configurations for existing payment channels","summary":"Retrieve the existing channel cutoff details","tags":[],"parameters":[{"name":"channelCutoffId","in":"query","type":"string","required":false,"description":"Identifies the channel cutoff record. ID Format: <channelId>.<currency>.<paymentDirection>.<messageType>-<recordCreationDate>. For example: TIPS.EUR.O.TIPSCTI-20160723"},{"name":"companyId","in":"query","type":"string","required":false,"description":"The identifier of the underlying Entity/Company/Branch."},{"name":"channel","in":"query","type":"string","required":false,"description":"Contains the channel in which the activity was performed. If pricing is not determined based on channel, then this is not significant"},{"name":"paymentCurrency","in":"query","type":"string","required":false,"description":"This field holds the transaction currency or currency in which payment is initiated. "},{"name":"customerOrBankTransfer","in":"query","type":"string","required":false,"description":"Indicates if the payment was initiated by Customer or the financial institution"},{"name":"paymentDirection","in":"query","type":"string","required":false,"description":"Indicates the direction of payment i.e. incoming, outgoing, book or redirect"},{"name":"priority","in":"query","type":"string","required":false,"description":"Defines the Campaign priority"},{"name":"messageType","in":"query","type":"string","required":false,"description":"Defines the type of swift messages that are sent or received for a transaction"},{"name":"paymentSource","in":"query","type":"string","required":false,"description":"Indicates the source from where the payment is originated"},{"name":"recordEndDate","in":"query","type":"string","required":false,"description":"Specifies the date until which the config record is to be considered active"},{"name":"repairCutOffTime","in":"query","type":"string","required":false,"description":"Indicates the cut-off time for processing transactions in repair queue."},{"name":"fxRepairCutOffTime","in":"query","type":"string","required":false,"description":"Indicates the cut-off time for processing cross currency transactions in repair queue."},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"PaymentChannelCutoffConfigurationsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"POST","path":"/settings/configuration/payments/companies/{companyCode}","fullPath":"/api/v1.0.0/settings/configuration/payments/companies/{companyCode}","operationId":"createPaymentCompanyConfiguration","name":"Create and configure a new payment company","summary":"Create new payment company configurations","tags":[],"parameters":[{"name":"companyCode","in":"path","type":"string","required":true,"description":"Specifies the company code which will be the master company for this institution. E.g. GB0010001, US0010001."},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"companyBic":[{}],"expiryTimeoutAction":[{}],"enterprise":[{}],"method":[{}],"domesticHome":[{}],"homecountryCode":"homecountryCode","homecurrencyCode":"homecurrencyCode","glHomeCurrency":"glHomeCurrency","applicationUserId":"applicationUserId","region":"region","dealerDesk":"dealerDesk","sodRunTime":"string","cobRunTime":"cobRunTime","daysActivePayment":"daysActivePayment","claimBeneficiaryBic":"claimBeneficiaryBIC"}},"responses":{"200":"PaymentCompanyConfigurationResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/settings/configuration/payments/companies/{companyCode}","fullPath":"/api/v1.0.0/settings/configuration/payments/companies/{companyCode}","operationId":"amendPaymentCompanyConfiguration","name":"Update the configuration of an existing payment company","summary":"Update payment company configurations","tags":[],"parameters":[{"name":"companyCode","in":"path","type":"string","required":true,"description":"Specifies the company code which will be the master company for this institution. E.g. GB0010001, US0010001."},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"companyBic":[{}],"expiryTimeoutAction":[{}],"enterprise":[{}],"method":[{}],"domesticHome":[{}],"homecountryCode":"homecountryCode","homecurrencyCode":"homecurrencyCode","glHomeCurrency":"glHomeCurrency","applicationUserId":"applicationUserId","region":"region","dealerDesk":"dealerDesk","sodRunTime":"string","cobRunTime":"cobRunTime","daysActivePayment":"daysActivePayment","claimBeneficiaryBic":"claimBeneficiaryBIC"}},"responses":{"200":"PaymentCompanyConfigurationResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/settings/configuration/payments/products/{productId}","fullPath":"/api/v1.0.0/settings/configuration/payments/products/{productId}","operationId":"amendPaymentOrderProduct","name":"Update the Payment features that are specific to a product","summary":"Update the payment order product","tags":[],"parameters":[{"name":"productId","in":"path","type":"string","required":true,"description":"Contains the unique identifier of the product, e.g. the product id of the arrangement account."},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"payments":[{}],"orders":[{}],"chargeOptions":[{}],"clearingChannelIds":[{}],"additionalInformations":[{}],"weblinks":[{}],"payThroughBeneficiary":"string","futureDate":"string","defaultChargeOption":"string","allowFx":"string","FXRate":"string","IBAN":"string","BIC":"string","sortCode":"string","warehouseRequired":"string"}},"responses":{"200":"PaymentOrderProductResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/settings/configuration/payments/products/conditions/mediumWeightProducts","fullPath":"/api/v1.0.0/settings/configuration/payments/products/conditions/mediumWeightProducts","operationId":"getPaymentMediumWeightProductConfigurations","name":"Retrieve the existing configurations for medium weight payment products","summary":"Retrieve medium weight payment product configuration","tags":[],"parameters":[{"name":"mediumWeightProductId","in":"query","type":"string","required":false,"description":"Identifier of the medium weight product. For example: PPMPC161130P7VG-20190723"},{"name":"companyId","in":"query","type":"string","required":false,"description":"The identifier of the underlying Entity/Company/Branch."},{"name":"paymentDirection","in":"query","type":"string","required":false,"description":"Indicates the direction of payment i.e. incoming, outgoing, book or redirect"},{"name":"clearingTransactionType","in":"query","type":"string","required":false,"description":"Indicates the Clearing transaction type."},{"name":"singleOrBatchClearing","in":"query","type":"string","required":false,"description":"Indicates payment type based on Single, Batch and Clearing payment."},{"name":"chargeType","in":"query","type":"string","required":false,"description":"Indicates the charge types which are applicable for the transaction. Example: CORRBKCHG"},{"name":"currency","in":"query","type":"string","required":false,"description":"Identifies the currency. E.g. USD, GBP etc"},{"name":"rateFix","in":"query","type":"string","required":false,"description":"Indicates if Rate Fixing Functionality must be enabled. If enabled, the system will park the transaction in a new Status code for Awaiting rate fixing."},{"name":"fromAmount","in":"query","type":"string","required":false,"description":"Holds the starting amount range."},{"name":"toAmount","in":"query","type":"string","required":false,"description":"Holds the ending amount range."},{"name":"paymentSource","in":"query","type":"string","required":false,"description":"Indicates the source from where the payment is originated"},{"name":"messageType","in":"query","type":"string","required":false,"description":"Defines the type of swift messages that are sent or received for a transaction"},{"name":"clearingNatureCode","in":"query","type":"string","required":false,"description":"Contains the nature of the payment transaction"},{"name":"beneficiaryCountryId","in":"query","type":"string","required":false,"description":"Country of the beneficiary account number. For example: US, IN, EU"},{"name":"orderingPartyCountry","in":"query","type":"string","required":false,"description":"Contains the country of the ordering party"},{"name":"beneficiaryIbanPresent","in":"query","type":"string","required":false,"description":"Indicates Presence of Beneficiary IBAN"},{"name":"orderingIbanPresent","in":"query","type":"string","required":false,"description":"Indicates Presence of Ordering Party IBAN."},{"name":"beneficiaryBicPresent","in":"query","type":"string","required":false,"description":"Indicates Presence of Beneficiary institution BIC."},{"name":"orderingBicPresent","in":"query","type":"string","required":false,"description":"Indicates Presence of Ordering institution BIC."},{"name":"orderingPartyResidentType","in":"query","type":"string","required":false,"description":"Indicates the Resident type of the Ordering party."},{"name":"codeWord","in":"query","type":"string","required":false,"description":"Holds the bilaterally agreed code words between the banks."},{"name":"recordEndDate","in":"query","type":"string","required":false,"description":"Specifies the date until which the config record is to be considered active"},{"name":"clientConditionProduct","in":"query","type":"string","required":false,"description":"Identifier for the client condition product"},{"name":"sourceIndicator","in":"query","type":"string","required":false,"description":"Identifies if the output of Product Determination is an Originating Source or a Source Group."},{"name":"routingProduct","in":"query","type":"string","required":false,"description":"Indicates the product used for routing the payment."},{"name":"imposeRoutingFlag","in":"query","type":"string","required":false,"description":"Flag which is used to impose the appropriate Routing Group for outgoing payments to be routed via local clearing. "},{"name":"feeProduct","in":"query","type":"string","required":false,"description":"Contains the unique identifier of the fee product"},{"name":"postingProduct","in":"query","type":"string","required":false,"description":"Indicates the posting Product to be used for the payment."},{"name":"fliteringProduct","in":"query","type":"string","required":false,"description":"Indicates Filtering Product for the payment."},{"name":"ledgerProductCode","in":"query","type":"string","required":false,"description":"Enables identification of the Product for description line/narrative purposes, even if the Posting Group and resulting Posting Lines are same for two different products."},{"name":"debitBookCode","in":"query","type":"string","required":false,"description":"Identifies the booking code for the debit entry on the payment transaction amount."},{"name":"creditBookCode","in":"query","type":"string","required":false,"description":"Identifies the booking code for the credit entry on the payment transaction amount."},{"name":"debitChargeBookCode","in":"query","type":"string","required":false,"description":"Identifies the booking code for the Charge Debit. It will be used by the Posting Scheme."},{"name":"creditChargeBookCode","in":"query","type":"string","required":false,"description":"Identifies the booking code for the Charge Credit. It will be used by the Posting Scheme."},{"name":"debitVatBookCode","in":"query","type":"string","required":false,"description":"Identifies the booking code for VAT Debit. It will be used by the Posting Scheme."},{"name":"creditVatBookCode","in":"query","type":"string","required":false,"description":"Identifies the booking code for VAT Credit. It will be used by the Posting Scheme."},{"name":"regulatoryReportingIndicator","in":"query","type":"string","required":false,"description":"Identifies whether the Payment has to fulfill Regulatory Reporting requirements."},{"name":"newPriority","in":"query","type":"string","required":false,"description":"Identifies the new priority of the payment. User can choose to ignore the incoming priority and define a new priority."},{"name":"nonStpFlag","in":"query","type":"string","required":false,"description":"Indicates if STP process has to be followed for all credit transactions, debit transactions, all transactions or none of the transactions."},{"name":"PSDCompliant","in":"query","type":"string","required":false,"description":"Defines whether the transaction is PSD (Payment Services Directive) compliant or not."},{"name":"euroCommissionCompliant","in":"query","type":"string","required":false,"description":"Identifies if the Payment is EC Compliant."},{"name":"currencyMarket","in":"query","type":"string","required":false,"description":"Identifies the currency market to be used to get the correct exchange and revaluation rates to be applied to each currency"},{"name":"transactionStopMapRule","in":"query","type":"string","required":false,"description":"Indicates if Debit Account Validation using Transaction Stop Module must be performed"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"PaymentMediumWeightProductConfigurationsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/settings/configuration/payments/paymentOrders","fullPath":"/api/v1.0.0/settings/configuration/payments/paymentOrders","operationId":"getPaymentOrderConfigurations","name":"Retrieve the existing default parameters of payment orders","summary":"Retrieve the parameter which connects payment order and payment system","tags":[],"parameters":[{"name":"paymentOrderId","in":"query","type":"string","required":false,"description":"The unique reference number of payment"},{"name":"paymentConnectionMethod","in":"query","type":"string","required":false,"description":"Groups the payment currency and country details"},{"name":"warehouseRequired","in":"query","type":"string","required":false,"description":"To define if warehouse is required at Payment order level or not"},{"name":"archiveDays","in":"query","type":"string","required":false,"description":"Indicates the number of days that an order will remain in live status before moving to history"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"PaymentOrderConfigurationsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/settings/configuration/payments/companies","fullPath":"/api/v1.0.0/settings/configuration/payments/companies","operationId":"getPaymentCompanyConfigurations","name":"Retrieve the configurations of existing payment companies","summary":"Retrieve payment company configurations","tags":[],"parameters":[{"name":"companyCode","in":"query","type":"string","required":false,"description":"Specifies the company code which will be the master company for this institution. E.g. GB0010001, US0010001."},{"name":"homecountryCode","in":"query","type":"string","required":false,"description":"Indicates the country code in ISO format."},{"name":"homecurrencyCode","in":"query","type":"string","required":false,"description":"Indicates the currency code in ISO format."},{"name":"region","in":"query","type":"string","required":false,"description":"Name of the region used for display or enrichment"},{"name":"timeZone","in":"query","type":"string","required":false,"description":"Defines the time zone of the entity"},{"name":"recordEndDate","in":"query","type":"string","required":false,"description":"Specifies the date until which the config record is to be considered active"},{"name":"enableFatfRegulation","in":"query","type":"string","required":false,"description":"Indicates if FATF(Financial Action Task Force) regulation is to be applied for payment transactions"},{"name":"rateFix","in":"query","type":"string","required":false,"description":"Indicates if Rate Fixing Functionality must be enabled. If enabled, the system will park the transaction in a new Status code for Awaiting rate fixing."},{"name":"fxMarginType","in":"query","type":"string","required":false,"description":"Holds the Forex margin type."},{"name":"fxMarginPercentage","in":"query","type":"string","required":false,"description":"Holds the Forex margin in percentage"},{"name":"enterpriseDescription","in":"query","type":"string","required":false,"description":"Indicates the description of the legal entity under which the company resides"},{"name":"enterpriseId","in":"query","type":"string","required":false,"description":"Indicates the legal entity under which the company resides"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"PaymentCompanyConfigurationsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/settings/configuration/payments/customers/charges","fullPath":"/api/v1.0.0/settings/configuration/payments/customers/charges","operationId":"getPaymentCustomerChargeConfigurations","name":"Retrieve existing customer charge configurations for payments","summary":"Retrieve customer charge configuration for payments","tags":[],"parameters":[{"name":"chargeId","in":"query","type":"string","required":false,"description":"This indicates the charge code which will be triggered for payment stop instruction. Applicable when financial institutions would like to charge for stop payment of cheque etc. "},{"name":"companyId","in":"query","type":"string","required":false,"description":"The identifier of the underlying Entity/Company/Branch."},{"name":"feeProduct","in":"query","type":"string","required":false,"description":"Contains the unique identifier of the fee product"},{"name":"sourceProduct","in":"query","type":"string","required":false,"description":"Indicates the source group from where payments are originated."},{"name":"businessLine","in":"query","type":"string","required":false,"description":"Indicates the business line to which the client belongs."},{"name":"customerId","in":"query","type":"string","required":false,"description":"Identifier of the customer"},{"name":"accountCompany","in":"query","type":"string","required":false,"description":"Company of the account to be created"},{"name":"accountId","in":"query","type":"string","required":false,"description":"Identifier of the account. Often referred to as the account number, yet for consistency this is always referred to as accountId. Accepts both IBAN & BBAN"},{"name":"accountCurrency","in":"query","type":"string","required":false,"description":"Currency of the account. For example: USD, GBP."},{"name":"residenceStatus","in":"query","type":"string","required":false,"description":"Residence Status of the Customer for CRM purpose like Owner, Tenant, Householder, Nester etc."},{"name":"recordEndDate","in":"query","type":"string","required":false,"description":"Specifies the date until which the config record is to be considered active"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"PaymentCustomerChargeConfigurationsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/settings/configuration/payments/clearings/clearingSettings","fullPath":"/api/v1.0.0/settings/configuration/payments/clearings/clearingSettings","operationId":"getPaymentClearingSettings","name":"Retrieve the existing payment clearing system configurations","summary":"Retrieve payment clearing setting lists","tags":[],"parameters":[{"name":"clearingSettingId","in":"query","type":"string","required":false,"description":"Identifies the clearing settings record. ID Format: <clearingId>.<currency>.<natureCode>.<messageDirection>.<messageType>-<recordCreationDate>. For example: STEP2.EUR.*.R.pacs.002-20160723"},{"name":"companyId","in":"query","type":"string","required":false,"description":"The identifier of the underlying Entity/Company/Branch."},{"name":"clearingId","in":"query","type":"string","required":false,"description":"Identifies the clearing system. For example: TIPS"},{"name":"currencyId","in":"query","type":"string","required":false,"description":"Identifier of the currency. This is the 3-letter ISO 4217 code of the currency."},{"name":"clearingNatureCode","in":"query","type":"string","required":false,"description":"Contains the nature of the payment transaction"},{"name":"paymentDirection","in":"query","type":"string","required":false,"description":"Indicates the direction of payment i.e. incoming, outgoing, book or redirect"},{"name":"messageType","in":"query","type":"string","required":false,"description":"Defines the type of swift messages that are sent or received for a transaction"},{"name":"clearingTransactionType","in":"query","type":"string","required":false,"description":"Indicates the Clearing transaction type."},{"name":"autoNegativeResponseIndicator","in":"query","type":"string","required":false,"description":"Indicates that if a negative response to an incoming cancellation request can be processed automatically without manual intervention."},{"name":"originalTransactionLookupApi","in":"query","type":"string","required":false,"description":"Defines the API that must be used for retrieving the original transaction related to the incoming message."},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"PaymentClearingSettingsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/settings/configuration/payments/filterings","fullPath":"/api/v1.0.0/settings/configuration/payments/filterings","operationId":"getFilteringPaymentConfigurations","name":"Retrieve the existing filtering payment configurations","summary":"Retrieve filtering payments list","tags":[],"parameters":[{"name":"filteringId","in":"query","type":"string","required":false,"description":"Indicates the filtering product of a payment. Examples: BKINCSKIP, AMTLT1000, INCOMING"},{"name":"companyId","in":"query","type":"string","required":false,"description":"The identifier of the underlying Entity/Company/Branch."},{"name":"rank","in":"query","type":"string","required":false,"description":"Indicates the rank of the payment order product within the group."},{"name":"outputChannel","in":"query","type":"string","required":false,"description":"Contains the channel that will be used to send the outward payment message"},{"name":"outgoingMessageType","in":"query","type":"string","required":false,"description":"Indicates the message type to be used when sending the payment to the clearing house or the direct participant."},{"name":"skipFilterIndicator","in":"query","type":"string","required":false,"description":"Indicates if filtering  should be skipped for a payment. Possible values: Y(Yes) or N(No)"},{"name":"detailLevelToEmit","in":"query","type":"string","required":false,"description":"Defines the information to be emitted. Possible Values: Complete or Blank"},{"name":"actionOnHit","in":"query","type":"string","required":false,"description":"Determines the action to be taken when the filtering system returns a Hit response. Possible Values: CancelOrReturn, ManualAction"},{"name":"actionOnPossibleHit","in":"query","type":"string","required":false,"description":"Determines the action to be taken when the filtering system returns a Possible Hit response. Possible Values : Cancelorreturn, Manualaction and Sendpendingconfirmation"},{"name":"actionOnSeizeFund","in":"query","type":"string","required":false,"description":"Determines the action to be taken when the filtering system returns a Seize Fund response . Possible Values: Automatic, ManualAction"},{"name":"actionOnTimeOut","in":"query","type":"string","required":false,"description":"Determines the action to be taken when there is no response with in configured time from the filtering system. Possible Values: CancelOrReturn, ManualAction"},{"name":"cutOffOptionForTimeOut","in":"query","type":"string","required":false,"description":"Defines the cutoff used for calculating the timeout. Possible Values: ChannelCutoff, RejectCutoff"},{"name":"timeOutBaseDate","in":"query","type":"string","required":false,"description":"Defines the configuration to calculate the timeout. For example timeout can be setup based on the day in which the amount is deducted from the Debtor (DVD),when the amount available with the Creditor "},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"FilteringPaymentConfigurationsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}}]},{"key":"settings-system-internal-v1.0.0","title":"System Configuration","version":"v1.0.0","description":"API to update the system configuration settings and the settings related to the initial Transact system build.","endpointCount":2,"endpoints":[{"method":"PUT","path":"/settings/configuration/systemParameters/{systemParameterId}","fullPath":"/api/v1.0.0/settings/configuration/systemParameters/{systemParameterId}","operationId":"updateSystemParameters","name":"Update the system parameters such as the products, productCode, siteName, enquiryPageLimit etc.","summary":"Update the system parameters","tags":[],"parameters":[{"name":"systemParameterId","in":"path","type":"string","required":true,"description":"The unique identifier of system parameter."},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"mainAccounts":[{}],"unixBackups":[{}],"unixRestores":[{}],"productAccounts":[{}],"products":[{}],"preBatchRoutines":[{}],"runDate":"2024-01-01","siteName":"string","exceptionLogHistoryDay":"string","cacheExpiry":"string","enquiryPageLimit":"string","systemBackupMode":"string","holdBatchOutput":"string","reportRetentionDay":"string","restrictReportView":"string"}},"responses":{"200":"SystemParametersResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/settings/installation/initialSystemBuilds/{initialSystemBuildId}","fullPath":"/api/v1.0.0/settings/installation/initialSystemBuilds/{initialSystemBuildId}","operationId":"updateInitialSystemBuildSettings","name":"Update initial system build configuration parameters such as the bank name, local currency, license code, maintainance date etc","summary":"Update the initial system build configuration parameters.","tags":[],"parameters":[{"name":"initialSystemBuildId","in":"path","type":"string","required":true,"description":"The unique identifier of initial system build settings."},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"institutionalAddresses":[{}],"languages":[{}],"products":[{}],"implementationChoiceOverrideTableNames":[{}],"institutionName":"string","localCountryCode":"string","localCurrency":"string","masterCompanyDate":"2024-01-01","swiftCode":"string","telexCode":"string","financialYearEnd":"2024-01-01","checkdigitType":"string","accountMask":"string","licenseCode":"string","maintenanceDate":"2024-01-01"}},"responses":{"200":"InitialSystemBuildSettingsResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}}]},{"key":"settings-system-internal-v1.1.0","title":"System Configuration","version":"v1.1.0","description":"API to update the system configuration settings and the settings related to the initial Transact system build.It is deprecated please refer the swagger, system-internal-v1.0.0-swagger","endpointCount":2,"endpoints":[{"method":"PUT","path":"/settings/configuration/systemParameters/{systemParameterId}","fullPath":"/api/v1.1.0/settings/configuration/systemParameters/{systemParameterId}","operationId":"updateSystemParameters","name":"Update the system parameters such as the products, productCode, siteName, enquiryPageLimit etc.","summary":"Update the system parameters","tags":[],"parameters":[{"name":"systemParameterId","in":"path","type":"string","required":true,"description":"The unique identifier of system parameter."},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"mainAccounts":[{}],"unixBackups":[{}],"unixRestores":[{}],"productAccounts":[{}],"products":[{}],"preBatchRoutines":[{}],"runDate":"2024-01-01","siteName":"string","exceptionLogHistoryDay":"string","cacheExpiry":"string","enquiryPageLimit":"string","systemBackupMode":"string","holdBatchOutput":"string","reportRetentionDay":"string","restrictReportView":"string"}},"responses":{"200":"SystemParametersResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/settings/installation/initialSystemBuilds/{initialSystemBuildId}","fullPath":"/api/v1.1.0/settings/installation/initialSystemBuilds/{initialSystemBuildId}","operationId":"updateInitialSystemBuildSettings","name":"Update initial system build configuration parameters such as the bank name, local currency, license code, maintainance date etc","summary":"Update the initial system build configuration parameters.","tags":[],"parameters":[{"name":"initialSystemBuildId","in":"path","type":"string","required":true,"description":"The unique identifier of initial system build settings."},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"institutionalAddresses":[{}],"languages":[{}],"products":[{}],"implementationChoiceOverrideTableNames":[{}],"institutionName":"string","localCountryCode":"string","localCurrency":"string","masterCompanyDate":"2024-01-01","swiftCode":"string","telexCode":"string","financialYearEnd":"2024-01-01","checkdigitType":"string","accountMask":"string","licenseCode":"string","maintenanceDate":"2024-01-01"}},"responses":{"200":"InitialSystemBuildSettingsResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}}]}]},{"name":"Switch","serviceCount":1,"endpointCount":1,"services":[{"key":"switch-Order-v1.0.0","title":"Switch Order","version":"v1.0.0","description":"Switch Order","endpointCount":1,"endpoints":[{"method":"POST","path":"/order/messages/switchTrade","fullPath":"/api/v1.0.0/order/messages/switchTrade","operationId":"switchOrder","name":"use URI \"/holdings/messages/securityTrades/switchOrders\"","summary":"Switch Order","tags":[],"parameters":[{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"swtchOrdrDtlsLegTypeGroup":[{}],"finInstrmDtlsISINGroup":[{}],"finInstrmDtlsSEPOLGroup":[{}],"finInstrmDtlsCUSIPGroup":[{}],"finInstrmDtlsRICGroup":[{}],"finInstrmDtlsTckrSymbGroup":[{}],"finInstrmDtlsBlmbrgGroup":[{}],"finInstrmDtlsCTAGroup":[{}],"finInstrmDtlsQUICKGroup":[{}],"finInstrmDtlsWrtpprGroup":[{}],"finInstrmDtlsDtchGroup":[{}],"finInstrmDtlsVlrnGroup":[{}],"finInstrmDtlsSCVMGroup":[{}],"finInstrmDtlsBelgnGroup":[{}],"finInstrmDtlsCmonGroup":[{}]}},"responses":{"200":"OrderResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}}]}]},{"name":"System","serviceCount":34,"endpointCount":168,"services":[{"key":"system-OnlineUpgrade-v1.0.0","title":"Online Upgrade","version":"v1.0.0","description":"API to create,update and retrieve details for Online Upgrades.This allows the viewing of Online Upgrade's Critical Records, Non-Critical Records, Restructure File List, Feeder Drill Down, Feeder Drill Down Channel, Primary and Secondary Job times.","endpointCount":13,"endpoints":[{"method":"PUT","path":"/system/onlineupgrade/addServers","fullPath":"/api/v1.0.0/system/onlineupgrade/addServers","operationId":"addServerOnlineupgrade","name":"To add server for online upgrade","summary":"To add server for online upgrade","tags":[],"parameters":[{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"The identifier of the underlying Entity/Company/Branch."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"servergroup":[{}]}},"responses":{"200":"ServerOnlineupgradeResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/system/onlineupgrade/stopRestructureService","fullPath":"/api/v1.0.0/system/onlineupgrade/stopRestructureService","operationId":"stopRestructureService","name":"To STOP the restructure service","summary":"To STOP the restructure service","tags":[],"parameters":[{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"The identifier of the underlying Entity/Company/Branch."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{}},"responses":{"200":"RestructureServiceResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/system/onlineupgrade/startRestructureFeeder","fullPath":"/api/v1.0.0/system/onlineupgrade/startRestructureFeeder","operationId":"startRestructureFeeder","name":"To START restructure feeder service","summary":"To START restructure feeder service","tags":[],"parameters":[{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"The identifier of the underlying Entity/Company/Branch."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{}},"responses":{"200":"RestructureFeederResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/system/onlineupgrade/stopRestructureFeeder","fullPath":"/api/v1.0.0/system/onlineupgrade/stopRestructureFeeder","operationId":"stopRestructureFeeder","name":"To STOP restructure feeder service","summary":"To STOP restructure feeder service","tags":[],"parameters":[{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"The identifier of the underlying Entity/Company/Branch."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{}},"responses":{"200":"RestructureFeederResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/system/onlineupgrade/startPrimaryDatarelease","fullPath":"/api/v1.0.0/system/onlineupgrade/startPrimaryDatarelease","operationId":"startPrimaryDatarelease","name":"To START primary data release","summary":"To START primary data release","tags":[],"parameters":[{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"The identifier of the underlying Entity/Company/Branch."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{}},"responses":{"200":"PrimaryDatareleaseResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/system/onlineupgrade/startSecondaryDatarelease","fullPath":"/api/v1.0.0/system/onlineupgrade/startSecondaryDatarelease","operationId":"startSecondaryDatarelease","name":"To START secondary data release","summary":"To START secondary data release","tags":[],"parameters":[{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"The identifier of the underlying Entity/Company/Branch."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{}},"responses":{"200":"SecondaryDatareleaseResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/system/upgrades/criticalRecords","fullPath":"/api/v1.0.0/system/upgrades/criticalRecords","operationId":"getOnlineUpgradeCriticalRecord","name":"To GET online upgrade critical records","summary":"To GET online upgrade critical records by scanning temp.release","tags":[],"parameters":[{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from t24 on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"The identifier of the underlying Entity/Company/Branch."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"OnlineUpgradeCriticalRecordResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/system/upgrades/nonCriticalRecords","fullPath":"/api/v1.0.0/system/upgrades/nonCriticalRecords","operationId":"getOnlineUpgradeNonCriticalRecords","name":"To GET online upgrade NON critical records","summary":"To GET online upgrade NON critical records by scanning temp.release","tags":[],"parameters":[{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from t24 on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"The identifier of the underlying Entity/Company/Branch."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"OnlineUpgradeNonCriticalRecordsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/system/upgrades/restructureFiles","fullPath":"/api/v1.0.0/system/upgrades/restructureFiles","operationId":"getOnlineUpgradeRestructureFilelist","name":"To GET online upgrade restructure file List","summary":"To GET online upgrade restructure file List","tags":[],"parameters":[{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from t24 on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"The identifier of the underlying Entity/Company/Branch."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"OnlineUpgradeRestructureFilelistResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/system/upgrades/feederDrilldowns","fullPath":"/api/v1.0.0/system/upgrades/feederDrilldowns","operationId":"getOnlineUpgradeFeederDrilldown","name":"To GET online upgrade feeder drill down","summary":"To GET online upgrade feeder drill down","tags":[],"parameters":[{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from t24 on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"The identifier of the underlying Entity/Company/Branch."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"OnlineUpgradeFeederDrilldownResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/system/upgrades/feederDrilldownChannels","fullPath":"/api/v1.0.0/system/upgrades/feederDrilldownChannels","operationId":"getOnlineUpgradeFeederDrilldownChannel","name":"To GET online upgrade feeder drill down channel","summary":"To GET online upgrade feeder drill down channel","tags":[],"parameters":[{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from t24 on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"The identifier of the underlying Entity/Company/Branch."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"OnlineUpgradeFeederDrilldownChannelResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/system/upgrades/jobTimes/primary","fullPath":"/api/v1.0.0/system/upgrades/jobTimes/primary","operationId":"getOnlineUpgradeJobTimesPrimary","name":"To GET online upgrade Job Times for primary","summary":"To GET online upgrade Job Times for primary","tags":[],"parameters":[{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from t24 on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"The identifier of the underlying Entity/Company/Branch."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"OnlineUpgradeJobTimesPrimaryResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/system/upgrades/jobTimes/secondary","fullPath":"/api/v1.0.0/system/upgrades/jobTimes/secondary","operationId":"getOnlineUpgradeJobTimesSecondary","name":"To GET online upgrade Job Times for secondary","summary":"To GET online upgrade Job Times for secondary","tags":[],"parameters":[{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from t24 on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"The identifier of the underlying Entity/Company/Branch."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"OnlineUpgradeJobTimesSecondaryResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}}]},{"key":"system-PAPUIServices-v1.0.0","title":"System Application Resources","version":"v1.0.0","description":"API to retrieve all the resources from the system such as applications, enquiries and screens and corresponding resource attribute details(Deprecated- A newer version V2.0.0 available)","endpointCount":2,"endpoints":[{"method":"GET","path":"/system/resources/{resourceType}/{resourceId}/attributes","fullPath":"/ra/api/v1.0.0/system/resources/{resourceType}/{resourceId}/attributes","operationId":"getAttributeDetails","name":"Get a particular resource attributes","summary":"Get a particular resource attributes(Deprecated- A newer version V2.0.0 available)","tags":[],"parameters":[{"name":"resourceType","in":"path","type":"string","required":true,"description":"Denotes the type of resource i.e whether an application, Version or an Enquiry"},{"name":"resourceId","in":"path","type":"string","required":true,"description":"Denotes the identifier of the resource"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from t24 on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"The identifier of the underlying Entity/Company/Branch."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"AttributeDetailsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/system/resourceManagers/{resourceManagerId}/resources","fullPath":"/ra/api/v1.0.0/system/resourceManagers/{resourceManagerId}/resources","operationId":"getDetailsForResources","name":"To get Details of all the resources in t24","summary":"To get Details of all the resources in t24(Deprecated- A newer version V2.0.0 available)","tags":[],"parameters":[{"name":"resourceManagerId","in":"path","type":"string","required":true,"description":"Denotes the Identifier of the resource manager for example:T24 ,TAP etc"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from t24 on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"The identifier of the underlying Entity/Company/Branch."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"DetailsForResourcesResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}}]},{"key":"system-PAPUIServices-v2.1.0","title":"Policy Administration Point User Interface services","version":"v2.1.0","description":"API to retrieve details of the system resources for the Policy Administration Point User Interface (PAP UI) that is used to create the eXtensible Access Control Markup Language (XACML) policies","endpointCount":4,"endpoints":[{"method":"GET","path":"/system/resources/{resourceType}/{resourceId}/attributes","fullPath":"/api/v2.1.0/system/resources/{resourceType}/{resourceId}/attributes","operationId":"getAttributeDetails","name":"Retrieves the details of the resource such as fieldname, field type, possible values etc","summary":"Retrieves the details of the resource such as fieldname, field type, possible values etc","tags":[],"parameters":[{"name":"resourceType","in":"path","type":"string","required":true,"description":"Denotes the type of resource i.e whether an application, Version or an Enquiry"},{"name":"resourceId","in":"path","type":"string","required":true,"description":"Denotes the identifier of the resource"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"AttributeDetailsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/system/resourceManagers/{resourceManagerId}/resources","fullPath":"/api/v2.1.0/system/resourceManagers/{resourceManagerId}/resources","operationId":"getDetailsForResources","name":"Retrieves the details of all the resources in the system which includes field names, type etc","summary":"Retrieves the details of all the resources in the system which includes field names, type etc","tags":[],"parameters":[{"name":"resourceManagerId","in":"path","type":"string","required":true,"description":"Denotes the Identifier of the resource manager for example:T24 ,TAP etc"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"DetailsForResourcesResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/system/settings/resourceDownloads","fullPath":"/api/v2.1.0/system/settings/resourceDownloads","operationId":"getResourceDownload","name":"Retrieve details of the date and time when the last resource download was executed","summary":"Retrieve last resource download details","tags":[],"parameters":[{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"ResourceDownloadResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/system/settings/resourceDownloads","fullPath":"/api/v2.1.0/system/settings/resourceDownloads","operationId":"configureResourceDownload","name":"Update setting to enable the full download of resource schema from the system","summary":"Enable full resource download","tags":[],"parameters":[{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"lastUpdateDate":"string"}},"responses":{"200":"ResourceDownloadResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}}]},{"key":"system-ServiceAutomation-v2.0.2","title":"Service Automation","version":"v2.0.2","description":"API to create, update and manage various types of system services and processes including the Close of Business process","endpointCount":17,"endpoints":[{"method":"POST","path":"/system/services/processes/{processId}","fullPath":"/api/v2.0.2/system/services/processes/{processId}","operationId":"createNewProcess","name":"Create new process in system with details such as process identifier , environment, frequency ,stage and operator which runs the process.","summary":"Create new process in system","tags":[],"parameters":[{"name":"processId","in":"path","type":"string","required":true,"description":"Contains the process identifier"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"The identifier of the underlying Entity/Company/Branch."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"processStage":"string","processEnvironment":"B","jobId":"string","verificationJobId":"string","jobFrequency":"string","nextRunDate":"2024-01-01","data":"string","operatorName":"string"}},"responses":{"200":"NewProcessResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/system/services/processes/{processId}","fullPath":"/api/v2.0.2/system/services/processes/{processId}","operationId":"amendNewProcess","name":"Updates process information such as process identifier , environment, frequency ,stage and operator which runs the process in the system","summary":"Update process in system","tags":[],"parameters":[{"name":"processId","in":"path","type":"string","required":true,"description":"Contains the process identifier"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"The identifier of the underlying Entity/Company/Branch."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"processStage":"string","processEnvironment":"B","jobId":"string","verificationJobId":"string","jobFrequency":"string","nextRunDate":"2024-01-01","data":"string","operatorName":"string"}},"responses":{"200":"NewProcessResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/system/services/{serviceId}","fullPath":"/api/v2.0.2/system/services/{serviceId}","operationId":"getService","name":"Retrieves the details of a specific service with details of status of the process, identifier for the job, verification job identifier, service control status and the time at which the job started and stopped.","summary":"Retrieves the details of a specific service ","tags":[],"parameters":[{"name":"serviceId","in":"path","type":"string","required":true,"description":"Contains the identifier name of the service that has to be executed."},{"name":"serverName","in":"query","type":"string","required":false,"description":"Contains the name of the Server on which the service will run."},{"name":"serverStatus","in":"query","type":"string","required":false,"description":"Status of Server  POSSIBLE VALUES: ACTIVE: To set the server as active INACTIVE: To set the server as inactive"},{"name":"workProfileId","in":"query","type":"string","required":false,"description":"Contains the reference to the record in service workload profiles for services."},{"name":"processStatus","in":"query","type":"string","required":false,"description":"Contains the current process status. Allowed values: - 0: Ready - 1: Running - 2: Completed successfully - 3: On hold or in error"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from t24 on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"The identifier of the underlying Entity/Company/Branch."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"ServiceResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"POST","path":"/system/services/{serviceId}","fullPath":"/api/v2.0.2/system/services/{serviceId}","operationId":"createNewService","name":"Create new service in system with information such as service identifier, the work profile for the service, the server details on which the service is run including the operator and the service control for the service.","summary":"Create new service in system","tags":[],"parameters":[{"name":"serviceId","in":"path","type":"string","required":true,"description":"Contains the identifier name of the service that has to be executed."},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"The identifier of the underlying Entity/Company/Branch."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"jobServerProfiles":[{}],"serviceDescription":"string","operatorName":"string","instruction":"START","correlationId":"string"}},"responses":{"200":"NewServiceResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/system/services/{serviceId}","fullPath":"/api/v2.0.2/system/services/{serviceId}","operationId":"amendService","name":"Update a service with information such as service identifier, the work profile for the service, the server details on which the service is run including the operator and the service control for the service in the system.","summary":"Update a service in the system ","tags":[],"parameters":[{"name":"serviceId","in":"path","type":"string","required":true,"description":"Contains the identifier name of the service that has to be executed."},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"The identifier of the underlying Entity/Company/Branch."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"jobServerProfiles":[{}],"serviceDescription":"string","operatorName":"string","instruction":"START","correlationId":"string"}},"responses":{"200":"ServiceResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/system/services/workProfiles/{workProfileId}","fullPath":"/api/v2.0.2/system/services/workProfiles/{workProfileId}","operationId":"getServiceWorkProfile","name":"Retrieves a specific workload profile with details such as identifier ,number of agents and time of all the work profile.","summary":"Retrieves a specific workload profile ","tags":[],"parameters":[{"name":"workProfileId","in":"path","type":"string","required":true,"description":"Contains the reference to the record in service workload profiles for services."},{"name":"agentsRequired","in":"query","type":"string","required":false,"description":"Contains the number of agents required"},{"name":"workProfileTime","in":"query","type":"string","required":false,"description":"Contains the time a multithreaded process takes."},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from t24 on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"The identifier of the underlying Entity/Company/Branch."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"ServiceWorkProfileResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"POST","path":"/system/services/workProfiles/{workProfileId}","fullPath":"/api/v2.0.2/system/services/workProfiles/{workProfileId}","operationId":"createServiceWorkProfile","name":"Create service work load profile with information such as identifier for work profile, the number of agents when using this work profile and the start time of the work profile.","summary":"Create service work load profile","tags":[],"parameters":[{"name":"workProfileId","in":"path","type":"string","required":true,"description":"Contains the reference to the record in service workload profiles for services."},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"The identifier of the underlying Entity/Company/Branch."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"displayName":"string","startTime":"string","agentsRequired":"string"}},"responses":{"200":"ServiceWorkProfileResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/system/services/workProfiles/{workProfileId}","fullPath":"/api/v2.0.2/system/services/workProfiles/{workProfileId}","operationId":"amendServiceWorkProfile","name":"Update a service work load profile with information such as identifier for work profile, the number of agents when using this work profile and the start time of the work profile in the system.","summary":"Update a service work load profile","tags":[],"parameters":[{"name":"workProfileId","in":"path","type":"string","required":true,"description":"Contains the reference to the record in service workload profiles for services."},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"The identifier of the underlying Entity/Company/Branch."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"displayName":"string","startTime":"string","agentsRequired":"string"}},"responses":{"200":"ServiceWorkProfileResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/system/services","fullPath":"/api/v2.0.2/system/services","operationId":"getAvailableServices","name":"Retrieves a list of all available services in system including details of status of the process, identifier for the job, verification job identifier, service control status and the time at which the job started and stopped.","summary":"Retrieves a list of all available services in system.","tags":[],"parameters":[{"name":"serviceId","in":"query","type":"string","required":false,"description":"Contains the identifier name of the service that has to be executed."},{"name":"serverName","in":"query","type":"string","required":false,"description":"Contains the name of the Server on which the service will run."},{"name":"serverStatus","in":"query","type":"string","required":false,"description":"Status of Server  POSSIBLE VALUES: ACTIVE: To set the server as active INACTIVE: To set the server as inactive"},{"name":"workProfileId","in":"query","type":"string","required":false,"description":"Contains the reference to the record in service workload profiles for services."},{"name":"processStatus","in":"query","type":"string","required":false,"description":"Contains the current process status. Allowed values: - 0: Ready - 1: Running - 2: Completed successfully - 3: On hold or in error"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from t24 on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"The identifier of the underlying Entity/Company/Branch."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"AvailableServicesResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/system/services/{serviceId}/status","fullPath":"/api/v2.0.2/system/services/{serviceId}/status","operationId":"getServiceStatus","name":"Retrieves a detailed status of the specified service including details such as status, reference of the agent,port identifier , session number and the last contact time of the agent.","summary":"Retrieves a detailed status of the specified service","tags":[],"parameters":[{"name":"serviceId","in":"path","type":"string","required":true,"description":"Contains the identifier name of the service that has to be executed."},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from t24 on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"The identifier of the underlying Entity/Company/Branch."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"ServiceStatusResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/system/services/status","fullPath":"/api/v2.0.2/system/services/status","operationId":"getAllServicesStatus","name":"Retrieves status of all the services with details including details such as status, reference of the agent,port identifier , session number and the last contact time of the agent.","summary":"Retrieves  status of all the services","tags":[],"parameters":[{"name":"serviceId","in":"query","type":"string","required":false,"description":"Contains the identifier name of the service that has to be executed."},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from t24 on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"The identifier of the underlying Entity/Company/Branch."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"AllServicesStatusResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/system/services/processTimes","fullPath":"/api/v2.0.2/system/services/processTimes","operationId":"getServiceProcessTimes","name":"Retrieves aRetrieves a list of all available executed process times in system with details including the job start end time and elapsed time. the throughput, the status of the job  and the control list details list of all available executed process times in system","summary":"Retrieves a list of all available executed process times in system","tags":[],"parameters":[{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from t24 on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"The identifier of the underlying Entity/Company/Branch."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"ServiceProcessTimesResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/system/reports/{businessClosureDate}/elapsedTimes","fullPath":"/api/v2.0.2/system/reports/{businessClosureDate}/elapsedTimes","operationId":"getReportTimes","name":"Retrieves a list of elapsed times for reports generated during close of business processing with information such as name of the report process, time taken to process the report and session number details.","summary":"Retrieves a list of elapsed times for reports generated during close of business processing","tags":[],"parameters":[{"name":"businessClosureDate","in":"path","type":"string","required":true,"description":"Contains the business closure time and date on which the error occurred."},{"name":"reportName","in":"query","type":"string","required":false,"description":"Contains the name of the process that produces the report"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from t24 on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"The identifier of the underlying Entity/Company/Branch."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"ReportTimesResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/system/services/workProfiles","fullPath":"/api/v2.0.2/system/services/workProfiles","operationId":"getAllServiceWorkProfiles","name":"Retrieves list of all service workload profiles available in system with details such as identifier ,number of agents and time of all the work profile","summary":"Retrieves list of all service workload profiles available in system","tags":[],"parameters":[{"name":"workProfileId","in":"query","type":"string","required":false,"description":"Contains the reference to the record in service workload profiles for services."},{"name":"agentsRequired","in":"query","type":"string","required":false,"description":"Contains the number of agents required"},{"name":"workProfileTime","in":"query","type":"string","required":false,"description":"Contains the time a multithreaded process takes."},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from t24 on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"The identifier of the underlying Entity/Company/Branch."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"AllServiceWorkProfilesResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/system/companies/{companyId}/errorMessages","fullPath":"/api/v2.0.2/system/companies/{companyId}/errorMessages","operationId":"getBusinessClosureErrorForCompany","name":"Retrieves any logged error messages for a company during the Close of Business processing with detailed information on the error message, the date on which the error occurred, whether a fix is required for the error faced, if fix is resolved the date on which fix is resolved etc.","summary":"Retrieves any logged error messages for a company during the Close of Business processing","tags":[],"parameters":[{"name":"companyId","in":"path","type":"string","required":true,"description":"The identifier of the underlying Entity/Company/Branch."},{"name":"businessClosureDate","in":"query","type":"string","required":false,"description":"Contains the business closure time and date on which the error occurred."},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from t24 on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"The identifier of the underlying Entity/Company/Branch."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"BusinessClosureErrorForCompanyResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/system/metrics/closeOfBusiness/status","fullPath":"/api/v2.0.2/system/metrics/closeOfBusiness/status","operationId":"getCobProgress","name":"Retrieves the status metrics of the Close of Business process, total number of jobs to be executed and percentage completed","summary":"Retrieves the status metrics of the Close of Business process","tags":[],"parameters":[{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from t24 on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"The identifier of the underlying Entity/Company/Branch."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"CobProgressResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"PUT","path":"/system/companies/{errorDetailId}/errorMessages","fullPath":"/api/v2.0.2/system/companies/{errorDetailId}/errorMessages","operationId":"amendBusinessClosureError","name":"Update the logged error messages for the  Close of Business processing","summary":"Update the resolution date of the logged error messages for the  Close of Business processing to continue","tags":[],"parameters":[{"name":"errorDetailId","in":"path","type":"string","required":true,"description":"Contains the unique identifier to the records on the table which logs the error messages for the close of business processing"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"The identifier of the underlying Entity/Company/Branch."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"fatalError":[{}]}},"responses":{"200":"BusinessClosureErrorResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}}]},{"key":"system-ServiceAutomation-v2.1.0","title":"Service Automation","version":"v2.1.0","description":"API to create, update and manage various types of system services and processes including the Close of Business process","endpointCount":18,"endpoints":[{"method":"POST","path":"/system/services/processes/{processId}","fullPath":"/api/v2.1.0/system/services/processes/{processId}","operationId":"createNewProcess","name":"Create new process in system with details such as process identifier , environment, frequency ,stage and operator which runs the process.","summary":"Create new process in system","tags":[],"parameters":[{"name":"processId","in":"path","type":"string","required":true,"description":"Contains the process identifier"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"processStage":"string","processEnvironment":"B","jobId":"string","verificationJobId":"string","jobFrequency":"string","nextRunDate":"2024-01-01","data":"string","operatorName":"string"}},"responses":{"200":"NewProcessResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/system/services/processes/{processId}","fullPath":"/api/v2.1.0/system/services/processes/{processId}","operationId":"amendNewProcess","name":"Updates process information such as process identifier , environment, frequency ,stage and operator which runs the process in the system","summary":"Update process in system","tags":[],"parameters":[{"name":"processId","in":"path","type":"string","required":true,"description":"Contains the process identifier"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"processStage":"string","processEnvironment":"B","jobId":"string","verificationJobId":"string","jobFrequency":"string","nextRunDate":"2024-01-01","data":"string","operatorName":"string"}},"responses":{"200":"NewProcessResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/system/services/{serviceId}","fullPath":"/api/v2.1.0/system/services/{serviceId}","operationId":"getService","name":"Retrieves the details of a specific service with details of status of the process, identifier for the job, verification job identifier, service control status and the time at which the job started and stopped.","summary":"Retrieves the details of a specific service ","tags":[],"parameters":[{"name":"serviceId","in":"path","type":"string","required":true,"description":"Contains the identifier name of the service that has to be executed."},{"name":"serverName","in":"query","type":"string","required":false,"description":"Contains the name of the server on which the service will run.  In cloud mode, it refers to pod or container."},{"name":"serverStatus","in":"query","type":"string","required":false,"description":"Status of Server  POSSIBLE VALUES: ACTIVE: To set the server as active INACTIVE: To set the server as inactive"},{"name":"workProfileId","in":"query","type":"string","required":false,"description":"Contains the reference to the record in service workload profiles for services."},{"name":"processStatus","in":"query","type":"string","required":false,"description":"Contains the current process status. Allowed values: - 0: Ready - 1: Running - 2: Completed successfully - 3: On hold or in error"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"ServiceResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"POST","path":"/system/services/{serviceId}","fullPath":"/api/v2.1.0/system/services/{serviceId}","operationId":"createNewService","name":"Create new service in system with information such as service identifier, the work profile for the service, the server details on which the service is run including the operator and the service control for the service.","summary":"Create new service in system","tags":[],"parameters":[{"name":"serviceId","in":"path","type":"string","required":true,"description":"Contains the identifier name of the service that has to be executed."},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"jobServerProfiles":[{}],"serviceDescription":"string","operatorName":"string","instruction":"START","correlationId":"string"}},"responses":{"200":"NewServiceResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/system/services/{serviceId}","fullPath":"/api/v2.1.0/system/services/{serviceId}","operationId":"amendService","name":"Update a service with information such as service identifier, the work profile for the service, the server details on which the service is run including the operator and the service control for the service in the system.","summary":"Update a service in the system ","tags":[],"parameters":[{"name":"serviceId","in":"path","type":"string","required":true,"description":"Contains the identifier name of the service that has to be executed."},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"jobServerProfiles":[{}],"serviceDescription":"string","operatorName":"string","instruction":"START","correlationId":"string"}},"responses":{"200":"ServiceResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/system/services/workProfiles/{workProfileId}","fullPath":"/api/v2.1.0/system/services/workProfiles/{workProfileId}","operationId":"getServiceWorkProfile","name":"Retrieves a specific workload profile with details such as identifier ,number of agents and time of all the work profile.","summary":"Retrieves a specific workload profile ","tags":[],"parameters":[{"name":"workProfileId","in":"path","type":"string","required":true,"description":"Contains the reference to the record in service workload profiles for services."},{"name":"agentsRequired","in":"query","type":"string","required":false,"description":"Contains the number of agents required"},{"name":"workProfileTime","in":"query","type":"string","required":false,"description":"Contains the time a multithreaded process takes."},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"ServiceWorkProfileResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"POST","path":"/system/services/workProfiles/{workProfileId}","fullPath":"/api/v2.1.0/system/services/workProfiles/{workProfileId}","operationId":"createServiceWorkProfile","name":"Create service work load profile with information such as identifier for work profile, the number of agents when using this work profile and the start time of the work profile.","summary":"Create service work load profile","tags":[],"parameters":[{"name":"workProfileId","in":"path","type":"string","required":true,"description":"Contains the reference to the record in service workload profiles for services."},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"displayName":"string","startTime":"string","agentsRequired":"string"}},"responses":{"200":"ServiceWorkProfileResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/system/services/workProfiles/{workProfileId}","fullPath":"/api/v2.1.0/system/services/workProfiles/{workProfileId}","operationId":"amendServiceWorkProfile","name":"Update a service work load profile with information such as identifier for work profile, the number of agents when using this work profile and the start time of the work profile in the system.","summary":"Update a service work load profile","tags":[],"parameters":[{"name":"workProfileId","in":"path","type":"string","required":true,"description":"Contains the reference to the record in service workload profiles for services."},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"displayName":"string","startTime":"string","agentsRequired":"string"}},"responses":{"200":"ServiceWorkProfileResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/system/services","fullPath":"/api/v2.1.0/system/services","operationId":"getAvailableServices","name":"Retrieves a list of all available services in system including details of status of the process, identifier for the job, verification job identifier, service control status and the time at which the job started and stopped.","summary":"Retrieves a list of all available services in system.","tags":[],"parameters":[{"name":"serviceId","in":"query","type":"string","required":false,"description":"Contains the identifier name of the service that has to be executed."},{"name":"serverName","in":"query","type":"string","required":false,"description":"Contains the name of the server on which the service will run.  In cloud mode, it refers to pod or container."},{"name":"serverStatus","in":"query","type":"string","required":false,"description":"Status of Server  POSSIBLE VALUES: ACTIVE: To set the server as active INACTIVE: To set the server as inactive"},{"name":"workProfileId","in":"query","type":"string","required":false,"description":"Contains the reference to the record in service workload profiles for services."},{"name":"processStatus","in":"query","type":"string","required":false,"description":"Contains the current process status. Allowed values: - 0: Ready - 1: Running - 2: Completed successfully - 3: On hold or in error"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"AvailableServicesResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/system/services/processTimes","fullPath":"/api/v2.1.0/system/services/processTimes","operationId":"getServiceProcessTimes","name":"Retrieves a list of all available executed process times in system with details including the job start end time and elapsed time, the throughput, the status of the job and the control list details list of all available executed process times in system.","summary":"Retrieves a list of all available executed process times in system","tags":[],"parameters":[{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"ServiceProcessTimesResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/system/reports/{businessClosureDate}/elapsedTimes","fullPath":"/api/v2.1.0/system/reports/{businessClosureDate}/elapsedTimes","operationId":"getReportTimes","name":"Retrieves a list of elapsed times for reports generated during close of business processing with information such as name of the report process, time taken to process the report and session number details.","summary":"Retrieves a list of elapsed times for reports generated during close of business processing","tags":[],"parameters":[{"name":"businessClosureDate","in":"path","type":"string","required":true,"description":"Contains the business closure time and date on which the error occurred."},{"name":"reportName","in":"query","type":"string","required":false,"description":"Contains the name of the process that produces the report"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"ReportTimesResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/system/services/workProfiles","fullPath":"/api/v2.1.0/system/services/workProfiles","operationId":"getAllServiceWorkProfiles","name":"Retrieves list of all service workload profiles available in system with details such as identifier ,number of agents and time of all the work profile","summary":"Retrieves list of all service workload profiles available in system","tags":[],"parameters":[{"name":"workProfileId","in":"query","type":"string","required":false,"description":"Contains the reference to the record in service workload profiles for services."},{"name":"agentsRequired","in":"query","type":"string","required":false,"description":"Contains the number of agents required"},{"name":"workProfileTime","in":"query","type":"string","required":false,"description":"Contains the time a multithreaded process takes."},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"AllServiceWorkProfilesResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/system/companies/{companyId}/errorMessages","fullPath":"/api/v2.1.0/system/companies/{companyId}/errorMessages","operationId":"getBusinessClosureErrorForCompany","name":"Retrieves any logged error messages for a company during the Close of Business processing with detailed information on the error message, the date on which the error occurred, whether a fix is required for the error faced, if fix is resolved the date on which fix is resolved etc.","summary":"Retrieves any logged error messages for a company during the Close of Business processing","tags":[],"parameters":[{"name":"companyId","in":"path","type":"string","required":true,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"businessClosureDate","in":"query","type":"string","required":false,"description":"Contains the business closure time and date on which the error occurred."},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"BusinessClosureErrorForCompanyResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/system/metrics/closeOfBusiness/status","fullPath":"/api/v2.1.0/system/metrics/closeOfBusiness/status","operationId":"getCobProgress","name":"Retrieves the status metrics of the Close of Business process, total number of jobs to be executed and percentage completed","summary":"Retrieves the status metrics of the Close of Business process","tags":[],"parameters":[{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"CobProgressResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"PUT","path":"/system/companies/{errorDetailId}/errorMessages","fullPath":"/api/v2.1.0/system/companies/{errorDetailId}/errorMessages","operationId":"amendBusinessClosureError","name":"Update the logged error messages for the  Close of Business processing","summary":"Update the resolution date of the logged error messages for the  Close of Business processing to continue","tags":[],"parameters":[{"name":"errorDetailId","in":"path","type":"string","required":true,"description":"Contains the unique identifier to the records on the table which logs the error messages for the close of business processing"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"fatalError":[{}]}},"responses":{"200":"BusinessClosureErrorResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/system/metrics/closeOfBusiness/stages/status","fullPath":"/api/v2.1.0/system/metrics/closeOfBusiness/stages/status","operationId":"showCobMonitor","name":"Returns the status of the Close of Business stages, the percentage of completion and current status of each stage","summary":"Returns the status of the Close of Business stages","tags":[],"parameters":[{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"CobMonitorResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/system/services/{serviceId}/status","fullPath":"/api/v2.1.0/system/services/{serviceId}/status","operationId":"getServiceStatus","name":"Retrieves a detailed status of the specified service including details such as status, reference of the agent,port identifier , session number and the last contact time of the agent.","summary":"Retrieves a detailed status of the specified service","tags":[],"parameters":[{"name":"serviceId","in":"path","type":"string","required":true,"description":"Contains the identifier name of the service that has to be executed."},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"ServiceStatusResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/system/services/status","fullPath":"/api/v2.1.0/system/services/status","operationId":"getAllServicesStatus","name":"Retrieves status of all the services with details including details such as status, reference of the agent,port identifier , session number and the last contact time of the agent.","summary":"Retrieves  status of all the services","tags":[],"parameters":[{"name":"serviceId","in":"query","type":"string","required":false,"description":"Contains the identifier name of the service that has to be executed."},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"AllServicesStatusResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}}]},{"key":"system-ServiceAutomation-v2.2.0","title":"Service Automation","version":"v2.2.0","description":"API to create, update and manage various types of system services and processes including the Close of Business process","endpointCount":18,"endpoints":[{"method":"POST","path":"/system/services/processes/{processId}","fullPath":"/api/v2.2.0/system/services/processes/{processId}","operationId":"createNewProcess","name":"Create new process in system with details such as process identifier , environment, frequency ,stage and operator which runs the process.","summary":"Create new process in system","tags":[],"parameters":[{"name":"processId","in":"path","type":"string","required":true,"description":"Contains the process identifier"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"processStage":"string","processEnvironment":"B","jobId":"string","verificationJobId":"string","jobFrequency":"string","nextRunDate":"2024-01-01","data":"string","operatorName":"string","extensions":{}}},"responses":{"200":"NewProcessResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/system/services/processes/{processId}","fullPath":"/api/v2.2.0/system/services/processes/{processId}","operationId":"amendNewProcess","name":"Updates process information such as process identifier , environment, frequency ,stage and operator which runs the process in the system","summary":"Update process in system","tags":[],"parameters":[{"name":"processId","in":"path","type":"string","required":true,"description":"Contains the process identifier"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"processStage":"string","processEnvironment":"B","jobId":"string","verificationJobId":"string","jobFrequency":"string","nextRunDate":"2024-01-01","data":"string","operatorName":"string","extensions":{}}},"responses":{"200":"NewProcessResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/system/services/{serviceId}","fullPath":"/api/v2.2.0/system/services/{serviceId}","operationId":"getService","name":"Retrieves the details of a specific service or list of services based on the service identifier/identifiers provided with details of status of the process, identifier for the job, verification job identifier, service control status, contact details including last contact date and time, close of business action and the time at which the job started and stopped. Also retrieves the details of the services which are configured to be executed in any of the following modes, queried based on the mode, ","summary":"Retrieves the details of a specific service ","tags":[],"parameters":[{"name":"serviceId","in":"path","type":"string","required":true,"description":"Contains the identifier name of the service that has to be executed."},{"name":"serverName","in":"query","type":"string","required":false,"description":"Name of the servers."},{"name":"serverStatus","in":"query","type":"string","required":false,"description":"Status of Server  POSSIBLE VALUES: ACTIVE: To set the server as active INACTIVE: To set the server as inactive"},{"name":"workProfileId","in":"query","type":"string","required":false,"description":"Contains the reference to the record in service workload profiles for services."},{"name":"processStatus","in":"query","type":"string","required":false,"description":"Contains the current process status. Allowed values: - 0: Ready - 1: Running - 2: Completed successfully - 3: On hold or in error"},{"name":"instruction","in":"query","type":"string","required":false,"description":"Contains the instruction control for the current service. Allowed values: - START: to start the current service. - STOP: to stop the current service - AUTO: to start the current service automatically "},{"name":"actionByCloseOfBusiness","in":"query","type":"string","required":false,"description":"Indicates whether the AUTO service is being altered during a close of business run."},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"ServiceResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"POST","path":"/system/services/{serviceId}","fullPath":"/api/v2.2.0/system/services/{serviceId}","operationId":"createNewService","name":"Create new service in system with information such as service identifier, the work profile for the service, the server details on which the service is run including the operator and the service control for the service.","summary":"Create new service in system","tags":[],"parameters":[{"name":"serviceId","in":"path","type":"string","required":true,"description":"Contains the identifier name of the service that has to be executed."},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"jobServerProfiles":[{}],"serviceDescription":"string","operatorName":"string","instruction":"START","correlationId":"string","extensions":{}}},"responses":{"200":"NewServiceResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/system/services/{serviceId}","fullPath":"/api/v2.2.0/system/services/{serviceId}","operationId":"amendService","name":"Update a service with information such as service identifier, the work profile for the service, the server details on which the service is run including the operator and the service control for the service in the system.","summary":"Update a service in the system ","tags":[],"parameters":[{"name":"serviceId","in":"path","type":"string","required":true,"description":"Contains the identifier name of the service that has to be executed."},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"jobServerProfiles":[{}],"serviceDescription":"string","operatorName":"string","instruction":"START","correlationId":"string","extensions":{}}},"responses":{"200":"ServiceResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/system/services/workProfiles/{workProfileId}","fullPath":"/api/v2.2.0/system/services/workProfiles/{workProfileId}","operationId":"getServiceWorkProfile","name":"Retrieves a specific workload profile with details such as identifier ,number of agents and time of all the work profile.","summary":"Retrieves a specific workload profile ","tags":[],"parameters":[{"name":"workProfileId","in":"path","type":"string","required":true,"description":"Contains the reference to the record in service workload profiles for services."},{"name":"agentsRequired","in":"query","type":"string","required":false,"description":"Contains the number of agents required"},{"name":"workProfileTime","in":"query","type":"string","required":false,"description":"Contains the time a multithreaded process takes."},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"ServiceWorkProfileResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"POST","path":"/system/services/workProfiles/{workProfileId}","fullPath":"/api/v2.2.0/system/services/workProfiles/{workProfileId}","operationId":"createServiceWorkProfile","name":"Create service work load profile with information such as identifier for work profile, the number of agents when using this work profile and the start time of the work profile.","summary":"Create service work load profile","tags":[],"parameters":[{"name":"workProfileId","in":"path","type":"string","required":true,"description":"Contains the reference to the record in service workload profiles for services."},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"displayName":"string","startTime":"string","agentsRequired":"string","extensions":{}}},"responses":{"200":"ServiceWorkProfileResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/system/services/workProfiles/{workProfileId}","fullPath":"/api/v2.2.0/system/services/workProfiles/{workProfileId}","operationId":"amendServiceWorkProfile","name":"Update a service work load profile with information such as identifier for work profile, the number of agents when using this work profile and the start time of the work profile in the system.","summary":"Update a service work load profile","tags":[],"parameters":[{"name":"workProfileId","in":"path","type":"string","required":true,"description":"Contains the reference to the record in service workload profiles for services."},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"displayName":"string","startTime":"string","agentsRequired":"string","extensions":{}}},"responses":{"200":"ServiceWorkProfileResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/system/services/processTimes","fullPath":"/api/v2.2.0/system/services/processTimes","operationId":"getServiceProcessTimes","name":"Retrieves a list of all available executed process times in system with details including the job start end time and elapsed time, the throughput, the status of the job and the control list details list of all available executed process times in system.","summary":"Retrieves a list of all available executed process times in system","tags":[],"parameters":[{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"ServiceProcessTimesResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/system/reports/{businessClosureDate}/elapsedTimes","fullPath":"/api/v2.2.0/system/reports/{businessClosureDate}/elapsedTimes","operationId":"getReportTimes","name":"Retrieves a list of elapsed times for reports generated during close of business processing with information such as name of the report process, time taken to process the report and session number details.","summary":"Retrieves a list of elapsed times for reports generated during close of business processing","tags":[],"parameters":[{"name":"businessClosureDate","in":"path","type":"string","required":true,"description":"Contains the business closure time and date on which the error occurred."},{"name":"reportName","in":"query","type":"string","required":false,"description":"Contains the name of the process that produces the report"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"ReportTimesResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/system/services/workProfiles","fullPath":"/api/v2.2.0/system/services/workProfiles","operationId":"getAllServiceWorkProfiles","name":"Retrieves list of all service workload profiles available in system with details such as identifier ,number of agents and time of all the work profile","summary":"Retrieves list of all service workload profiles available in system","tags":[],"parameters":[{"name":"workProfileId","in":"query","type":"string","required":false,"description":"Contains the reference to the record in service workload profiles for services."},{"name":"agentsRequired","in":"query","type":"string","required":false,"description":"Contains the number of agents required"},{"name":"workProfileTime","in":"query","type":"string","required":false,"description":"Contains the time a multithreaded process takes."},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"AllServiceWorkProfilesResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/system/companies/{companyId}/errorMessages","fullPath":"/api/v2.2.0/system/companies/{companyId}/errorMessages","operationId":"getBusinessClosureErrorForCompany","name":"Retrieves any logged error messages for a company during the Close of Business processing with detailed information on the error message, the date on which the error occurred, whether a fix is required for the error faced, if fix is resolved the date on which fix is resolved etc.","summary":"Retrieves any logged error messages for a company during the Close of Business processing","tags":[],"parameters":[{"name":"companyId","in":"path","type":"string","required":true,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"businessClosureDate","in":"query","type":"string","required":false,"description":"Contains the business closure time and date on which the error occurred."},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"BusinessClosureErrorForCompanyResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/system/metrics/closeOfBusiness/status","fullPath":"/api/v2.2.0/system/metrics/closeOfBusiness/status","operationId":"getCobProgress","name":"Retrieves the status metrics of the Close of Business process, total number of jobs to be executed and percentage completed","summary":"Retrieves the status metrics of the Close of Business process","tags":[],"parameters":[{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"CobProgressResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"PUT","path":"/system/companies/{errorDetailId}/errorMessages","fullPath":"/api/v2.2.0/system/companies/{errorDetailId}/errorMessages","operationId":"amendBusinessClosureError","name":"Update the logged error messages for the  Close of Business processing","summary":"Update the resolution date of the logged error messages for the  Close of Business processing to continue","tags":[],"parameters":[{"name":"errorDetailId","in":"path","type":"string","required":true,"description":"Contains the unique identifier to the records on the table which logs the error messages for the close of business processing"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"fatalError":[{}],"extensions":{}}},"responses":{"200":"BusinessClosureErrorResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/system/metrics/closeOfBusiness/stages/status","fullPath":"/api/v2.2.0/system/metrics/closeOfBusiness/stages/status","operationId":"showCobMonitor","name":"Returns the status of the Close of Business stages, the percentage of completion and current status of each stage","summary":"Returns the status of the Close of Business stages","tags":[],"parameters":[{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"CobMonitorResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/system/services/{serviceId}/status","fullPath":"/api/v2.2.0/system/services/{serviceId}/status","operationId":"getServiceStatus","name":"Retrieves a detailed status of the specified service including details such as status, reference of the agent,port identifier , session number and the last contact time of the agent.","summary":"Retrieves a detailed status of the specified service","tags":[],"parameters":[{"name":"serviceId","in":"path","type":"string","required":true,"description":"Contains the identifier name of the service that has to be executed."},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"ServiceStatusResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/system/services/status","fullPath":"/api/v2.2.0/system/services/status","operationId":"getAllServicesStatus","name":"Retrieves status of all the services with details like status, reference of the agent,port identifier , session number and the last contact time of the agent.","summary":"Retrieves  status of all the services","tags":[],"parameters":[{"name":"serviceId","in":"query","type":"string","required":false,"description":"Contains the identifier name of the service that has to be executed."},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"AllServicesStatusResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/system/services","fullPath":"/api/v2.2.0/system/services","operationId":"getAvailableServices","name":"Retrieves a list of all available services in system including details of status of the process, identifier for the job, verification job identifier, service control status and the time at which the job started and stopped.","summary":"Retrieves a list of all available services in system.","tags":[],"parameters":[{"name":"serviceId","in":"query","type":"string","required":false,"description":"Contains the identifier name of the service that has to be executed."},{"name":"serverName","in":"query","type":"string","required":false,"description":"Name of the servers."},{"name":"serverStatus","in":"query","type":"string","required":false,"description":"Status of Server  POSSIBLE VALUES: ACTIVE: To set the server as active INACTIVE: To set the server as inactive"},{"name":"workProfileId","in":"query","type":"string","required":false,"description":"Contains the reference to the record in service workload profiles for services."},{"name":"processStatus","in":"query","type":"string","required":false,"description":"Contains the current process status. Allowed values: - 0: Ready - 1: Running - 2: Completed successfully - 3: On hold or in error"},{"name":"instruction","in":"query","type":"string","required":false,"description":"Contains the instruction control for the current service. Allowed values: - START: to start the current service. - STOP: to stop the current service - AUTO: to start the current service automatically "},{"name":"actionByCloseOfBusiness","in":"query","type":"string","required":false,"description":"Indicates whether the AUTO service is being altered during a close of business run."},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"AvailableServicesResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}}]},{"key":"system-channels-service-v1.0.0","title":"Channels system APIs","version":"v1.0.0","description":"Management of channels system APIs","endpointCount":1,"endpoints":[{"method":"PUT","path":"/system/channels/parameters/{systemId}","fullPath":"/api/v1.0.0/system/channels/parameters/{systemId}","operationId":"updateChannelParameter","name":"Update Channel Parameter","summary":"Update the existing Channel Parameter","tags":[],"parameters":[{"name":"systemId","in":"path","type":"string","required":true,"description":"The system application identifier from which the entry was generated"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":""},{"name":"companyId","in":"header","type":"string","required":false,"description":""}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"cacheExpiry":"string","privilegesCheck":"string","genericUserSmsGroup":"string"}},"responses":{"200":"ChannelParameterResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}}]},{"key":"system-cloudServiceElasticity-v1.0.0","title":"Service Elasticity","version":"v1.0.0","description":"API to Create , amend and retrieve the service profile elasticity features including upscaling and downscaling of processing agents, enabling dynamic provisioning and cleaning up inactive pods","endpointCount":7,"endpoints":[{"method":"POST","path":"/system/services/elasticity/servers/{serverId}/serviceCleanups","fullPath":"/api/v1.0.0/system/services/elasticity/servers/{serverId}/serviceCleanups","operationId":"createServiceElasticCleanup","name":"Create cleanup instruction for the particular server (pod) where services have been killed during downscaling phase","summary":"Create cleanup instruction to initiate cleanup of downscaled servers","tags":[],"parameters":[{"name":"serverId","in":"path","type":"string","required":true,"description":""},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"The identifier of the underlying Entity/Company/Branch."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"cleanupTime":"string"}},"responses":{"200":"ServiceElasticCleanupResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/system/services/settings/{settingId}/elasticity","fullPath":"/api/v1.0.0/system/services/settings/{settingId}/elasticity","operationId":"amendServiceElasticParameter","name":"Update dynamic provisioning for system deployed in cloud","summary":"Update dynamic provisioning for system deployed in cloud","tags":[],"parameters":[{"name":"settingId","in":"path","type":"string","required":true,"description":"Contains the particular parameter record setting identifier."},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"The identifier of the underlying Entity/Company/Branch."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"dynamicProvisioning":"string","queueJobs":"string"}},"responses":{"200":"ServiceElasticParameterResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"POST","path":"/system/services/workProfiles/{workProfileId}/elasticity","fullPath":"/api/v1.0.0/system/services/workProfiles/{workProfileId}/elasticity","operationId":"createServiceElasticProfile","name":"Create number of agents for elastic scaling by inputting the queue details and minimum and maximum number of agents for elasticity","summary":"Create number of agents for elastic scaling","tags":[],"parameters":[{"name":"workProfileId","in":"path","type":"string","required":true,"description":"Contains the reference to the record in service workload profiles for services."},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"The identifier of the underlying Entity/Company/Branch."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"elasticity":[{}],"displayName":"string","startTime":"string","agentsRequired":"string"}},"responses":{"200":"ServiceElasticProfileResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/system/services/workProfiles/{workProfileId}/elasticity","fullPath":"/api/v1.0.0/system/services/workProfiles/{workProfileId}/elasticity","operationId":"amendServiceElasticProfile","name":"Update number of agents for elastic scaling","summary":"Update number of agents for elastic scaling","tags":[],"parameters":[{"name":"workProfileId","in":"path","type":"string","required":true,"description":"Contains the reference to the record in service workload profiles for services."},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"The identifier of the underlying Entity/Company/Branch."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"elasticity":[{}],"displayName":"string","startTime":"string","agentsRequired":"string"}},"responses":{"200":"ServiceElasticProfileResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/system/settings/{settingId}/deploymentModes","fullPath":"/api/v1.0.0/system/settings/{settingId}/deploymentModes","operationId":"amendSystemParameterElastic","name":"Update the system deployment mode by enabling whether in cloud or Not","summary":"Update the system deployment mode","tags":[],"parameters":[{"name":"settingId","in":"path","type":"string","required":true,"description":"Contains the particular parameter record setting identifier."},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"The identifier of the underlying Entity/Company/Branch."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"deploymentMode":"string"}},"responses":{"200":"SystemParameterElasticResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/system/metrics/elasticity/agents/itemCount","fullPath":"/api/v1.0.0/system/metrics/elasticity/agents/itemCount","operationId":"getAgentElasticCheck","name":"Retrieves the total number of agents required for cloud deploymentment","summary":"Retrieves the total number of agents required for cloud deployment","tags":[],"parameters":[{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from t24 on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"The identifier of the underlying Entity/Company/Branch."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"AgentElasticCheckResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/system/services/elasticity/agents","fullPath":"/api/v1.0.0/system/services/elasticity/agents","operationId":"getAgentElasticCheckDetails","name":"Retrieves the agent details for active services in cloud deployment including minimum agents , maximum agents, total agents, service details , date and time of running agents etc","summary":"Retrieves the agent details for active services in cloud deployment","tags":[],"parameters":[{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from t24 on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"The identifier of the underlying Entity/Company/Branch."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"AgentElasticCheckDetailsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}}]},{"key":"system-cloudServiceElasticity-v1.1.0","title":"APIs to control service elasticity for system deployed in Cloud","version":"v1.1.0","description":"Creates , amends and retrieves the service profile elasticity features including upscaling and downscaling of processing agents, enabling dynamic provisioning and cleaning up inactive pods","endpointCount":8,"endpoints":[{"method":"POST","path":"/system/services/elasticity/servers/{serverName}/serviceCleanups","fullPath":"/api/v1.1.0/system/services/elasticity/servers/{serverName}/serviceCleanups","operationId":"createServiceElasticCleanup","name":"Create cleanup instruction for the particular server (pod) where services have been killed during downscaling phase","summary":"Create cleanup instruction to initiate cleanup of downscaled servers","tags":[],"parameters":[{"name":"serverName","in":"path","type":"string","required":true,"description":"Contains the name of the server on which the service will run.  In cloud mode, it refers to pod or container."},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"cleanupTime":"string","extensionData":{}}},"responses":{"200":"ServiceElasticCleanupResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/system/services/settings/{settingId}/elasticity","fullPath":"/api/v1.1.0/system/services/settings/{settingId}/elasticity","operationId":"amendServiceElasticParameter","name":"Update dynamic provisioning for system deployed in cloud","summary":"Update dynamic provisioning for system deployed in cloud","tags":[],"parameters":[{"name":"settingId","in":"path","type":"string","required":true,"description":"Contains the particular parameter record setting identifier."},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"dynamicProvisioning":"string","queueJobs":"string","extensionData":{}}},"responses":{"200":"ServiceElasticParameterResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"POST","path":"/system/services/workProfiles/{workProfileId}/elasticity","fullPath":"/api/v1.1.0/system/services/workProfiles/{workProfileId}/elasticity","operationId":"createServiceElasticProfile","name":"Create number of agents for elastic scaling by inputting the queue details and minimum and maximum number of agents for elasticity","summary":"Create number of agents for elastic scaling","tags":[],"parameters":[{"name":"workProfileId","in":"path","type":"string","required":true,"description":"Contains the reference to the record in service workload profiles for services."},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"elasticity":[{}],"displayName":"string","startTime":"string","agentsRequired":"string","extensionData":{}}},"responses":{"200":"ServiceElasticProfileResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/system/services/workProfiles/{workProfileId}/elasticity","fullPath":"/api/v1.1.0/system/services/workProfiles/{workProfileId}/elasticity","operationId":"amendServiceElasticProfile","name":"Update number of agents for elastic scaling","summary":"Update number of agents for elastic scaling","tags":[],"parameters":[{"name":"workProfileId","in":"path","type":"string","required":true,"description":"Contains the reference to the record in service workload profiles for services."},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"elasticity":[{}],"displayName":"string","startTime":"string","agentsRequired":"string","extensionData":{}}},"responses":{"200":"ServiceElasticProfileResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/system/settings/{settingId}/deploymentModes","fullPath":"/api/v1.1.0/system/settings/{settingId}/deploymentModes","operationId":"amendSystemParameterElastic","name":"Update the system deployment mode by enabling whether in cloud or Not","summary":"Update the system deployment mode","tags":[],"parameters":[{"name":"settingId","in":"path","type":"string","required":true,"description":"Contains the particular parameter record setting identifier."},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"deploymentMode":"string","extensionData":{}}},"responses":{"200":"SystemParameterElasticResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/system/metrics/elasticity/agents/itemCount","fullPath":"/api/v1.1.0/system/metrics/elasticity/agents/itemCount","operationId":"getAgentElasticCheck","name":"Retrieves the total number of agents required for cloud deploymentment","summary":"Retrieves the total number of agents required for cloud deployment","tags":[],"parameters":[{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"AgentElasticCheckResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/system/services/elasticity/agents","fullPath":"/api/v1.1.0/system/services/elasticity/agents","operationId":"getAgentElasticCheckDetails","name":"Retrieves the agent details for active services in cloud deployment including minimum agents , maximum agents, total agents, service details , date and time of running agents etc","summary":"Retrieves the agent details for active services in cloud deployment","tags":[],"parameters":[{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"AgentElasticCheckDetailsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/system/services/elasticity/servers","fullPath":"/api/v1.1.0/system/services/elasticity/servers","operationId":"getElasticityServersDetails","name":"Retrieves last contact and server details for cloud mode","summary":"Retrieves last contact and server details for cloud mode","tags":[],"parameters":[{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"ElasticityServersDetailsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}}]},{"key":"system-dataEventStreaming-v1.0.0","title":"Data Event Streaming","version":"v1.0.0","description":"APIs to create and retrieve event streaming configuration data. These APIs can also be used to capture the Data Replications enabled records from memory when a transaction is committed to the system.","endpointCount":5,"endpoints":[{"method":"GET","path":"/system/tableNames","fullPath":"/api/v1.0.0/system/tableNames","operationId":"getFileNames","name":"Retrieves all the table Names in the system available under a particular company requested.This API also has the option to filter the table Names using specific pattern types like starts with, ends with and equal to so that the user is able to view the output more clearly.","summary":"Retrieves the table Names available under a specific company in the system","tags":[],"parameters":[{"name":"companyMnemonic","in":"query","type":"string","required":true,"description":"Shortcut code for referring an Entity/Company/Branch related to the image record"},{"name":"applicationName","in":"query","type":"string","required":true,"description":"Application name for NOFILE (an enquiry does not exist in a single file) enquiry for online upgrade"},{"name":"patternType","in":"query","type":"string","required":true,"description":"Specifies the pattern to match in the filter criteria"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"FileNamesResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"POST","path":"/system/settings/{settingId}/dataEventStreams","fullPath":"/api/v1.0.0/system/settings/{settingId}/dataEventStreams","operationId":"configureDES","name":"Updates the configurations required for Data Event Streaming (DES) as key value pair properties. For Example:  If the property key is one of the event streaming configuration like 'temn.des.stream.producer.client.id' then its corresponding property value could be 'des-schema'.","summary":"Updates the configurations required for streaming events","tags":[],"parameters":[{"name":"settingId","in":"path","type":"string","required":true,"description":"Contains the particular parameter record setting identifier."},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"KeyValue":[{}]}},"responses":{"200":"DESResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"POST","path":"/system/settings/{settingId}/dataReplications","fullPath":"/api/v1.0.0/system/settings/{settingId}/dataReplications","operationId":"enableCommitCapture","name":"The commit Capture feature is an option that can be used to capture the Data Replication enabled data records from memory when a transaction is committed to the system. This API can be used to enable that commit Capture feature for event streaming data.","summary":"Updates commit Capture option for Data Replication","tags":[],"parameters":[{"name":"settingId","in":"path","type":"string","required":true,"description":"Contains the particular parameter record setting identifier."},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"ilpRequired":"string","applicationId":"string"}},"responses":{"200":"CommitCaptureResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/system/settings/dataReplications","fullPath":"/api/v1.0.0/system/settings/dataReplications","operationId":"getCommitCaptureEnabled","name":"Retrieves the commit Capture feature enabled records separately which are required for the data lake functionalities in event streaming from memory when a transaction is committed in the system. ","summary":"Retrieves the commit Capture enabled records for Data Replication","tags":[],"parameters":[{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"CommitCaptureEnabledResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/system/metrics/dataEvents/pendings/itemCount","fullPath":"/api/v1.0.0/system/metrics/dataEvents/pendings/itemCount","operationId":"getUnprocessedCount","name":"Get the count of unprocessed records in DES","summary":"Get the count of unprocessed records in DES","tags":[],"parameters":[{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"UnprocessedCountResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}}]},{"key":"system-deliveryChannels-services-v1.0.0","title":"Delivery Channels","version":"v1.0.0","description":"API to manage delivery channels or services with definitions of interface used by the services , protocol details, message transformation, formatting module, address rules and local authentication details. These definitions allows the institutions or banks to predefine the delivery service settings ","endpointCount":2,"endpoints":[{"method":"GET","path":"/system/messages/channels/{channelId}","fullPath":"/api/v1.0.0/system/messages/channels/{channelId}","operationId":"getDeliveryCarrierServices","name":"Retrieves delivery services with details such as requestor name, membership reference, purge definitions and time interval for overdue delivery notifications","summary":"Retrieves delivery channel or services details","tags":[],"parameters":[{"name":"channelId","in":"path","type":"string","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"DeliveryCarrierServicesResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/system/messages/channels/{channelId}","fullPath":"/api/v1.0.0/system/messages/channels/{channelId}","operationId":"updateDeliveryCarrierServices","name":"Update delivery services with details such as requestor name, membership reference, purge definitions and time interval for overdue delivery notifications","summary":"Update delivery channel or services details","tags":[],"parameters":[{"name":"channelId","in":"path","type":"string","required":true,"description":""},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"requestorDistinguishedName":"string","membershipId":"string","senderPrefix":"string","purgeDays":"string","deliveryNotificationRequested":"string","overdueDeliveryTimeInterval":"string"}},"responses":{"200":"DeliveryCarrierServicesResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}}]},{"key":"system-dwExportSettings-v1.0.0","title":"Data warehouse exports","version":"v1.0.0","description":"Data warehouse exports","endpointCount":5,"endpoints":[{"method":"GET","path":"/system/settings/{settingId}/dataWarehouseExports","fullPath":"/api/v1.0.0/system/settings/{settingId}/dataWarehouseExports","operationId":"getDWExportSettings","name":"API to get data warehouse exports settings for an application","summary":"Get data warehouse exports settings for an application","tags":[],"parameters":[{"name":"settingId","in":"path","type":"string","required":true,"description":"Contains the particular parameter record setting identifier."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"DWExportSettingsResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"POST","path":"/system/settings/{settingId}/dataWarehouseExports","fullPath":"/api/v1.0.0/system/settings/{settingId}/dataWarehouseExports","operationId":"createDWExportSettings","name":"API to create data warehouse exports","summary":"Create data warehouse exports","tags":[],"parameters":[{"name":"settingId","in":"path","type":"string","required":true,"description":"Contains the particular parameter record setting identifier."},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"takeover":"string"}},"responses":{"200":"DWExportSettingsResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/system/settings/{settingId}/dataWarehouseExports","fullPath":"/api/v1.0.0/system/settings/{settingId}/dataWarehouseExports","operationId":"updateDWExportSettings","name":"API to update data warehouse exports settings","summary":"Update data warehouse exports settings","tags":[],"parameters":[{"name":"settingId","in":"path","type":"string","required":true,"description":"Contains the particular parameter record setting identifier."},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"takeover":"string"}},"responses":{"200":"DWExportSettingsResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/system/dataWarehouseExports/tableNames","fullPath":"/api/v1.0.0/system/dataWarehouseExports/tableNames","operationId":"getDWExportTableNames","name":"API to get data warehouse exports table names.","summary":" Get data warehouse exports table names.","tags":[],"parameters":[{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"DWExportTableNamesResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/system/dataWarehouseExports/schemaIdentifiers","fullPath":"/api/v1.0.0/system/dataWarehouseExports/schemaIdentifiers","operationId":"getDWExportSchemaIdentifier","name":"API to get data warehouse exports schema identifier","summary":"Get data warehouse exports schema identifier","tags":[],"parameters":[{"name":"applicationName","in":"query","type":"string","required":true,"description":"Application name for NOFILE (an enquiry does not exist in a single file) enquiry for online upgrade"},{"name":"mnemonic","in":"query","type":"string","required":true,"description":"Shortcut code for referring an Entity/Company/Branch."},{"name":"streamMode","in":"query","type":"string","required":true,"description":"Indicates the streaming mode. Available options are BATCH - for batch streaming or ONLINE - for real time streaming."},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"DWExportSchemaIdentifierResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}}]},{"key":"system-eventTransactionLog-v1.0.0","title":"Event Transaction Log","version":"v1.0.0","description":"API to create,view and modify event transaction log in Transact. The log is updated with details of  configured transactions which triggered the event in the system.","endpointCount":3,"endpoints":[{"method":"GET","path":"/system/logs/{logName}/transactions/events","fullPath":"/api/v1.0.0/system/logs/{logName}/transactions/events","operationId":"getEventTransactionLogs","name":"Retrieves the details of the event transaction log. The details include the name of the business application raising the transaction event, the operation for the transaction, the company where the transaction was done, user who initiated the transaction and status of the transaction amongst other information. ","summary":"Retrieves event transaction log information","tags":[],"parameters":[{"name":"logName","in":"path","type":"string","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"EventTransactionLogsResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"POST","path":"/system/logs/{logName}/transactions/events","fullPath":"/api/v1.0.0/system/logs/{logName}/transactions/events","operationId":"createEventTransactionLog","name":"Creates the details of the event transaction log . The details include the name of the business application raising the transaction event, the operation for the transaction, the company where the transaction was done, user who initiated the transaction and status of the transaction amongst other information.","summary":"Creates event transaction log information","tags":[],"parameters":[{"name":"logName","in":"path","type":"string","required":true,"description":"Contains the name of the log file which holds the information on the event transaction log"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"context":[{}],"eventLogDescription":"string","parentApplication":"string","parentTransactionId":"string","parentFunction":"A","transactionUser":"string","company":"string","serviceOrchestratorEventResponse":"string","overallStatus":"PENDING","compensatoryTransactionStatus":"SUCCESS"}},"responses":{"200":"EventTransactionLogResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/system/logs/{logName}/transactions/events","fullPath":"/api/v1.0.0/system/logs/{logName}/transactions/events","operationId":"amendEventTransactionLog","name":"Modifies the details of the event transaction log . The details include the name of the business application raising the transaction event, the operation for the transaction, the company where the transaction was done, user who initiated the transaction and status of the transaction amongst other information. ","summary":"Amends event transaction log information","tags":[],"parameters":[{"name":"logName","in":"path","type":"string","required":true,"description":"Contains the name of the log file which holds the information on the event transaction log"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"context":[{}],"eventLogDescription":"string","parentApplication":"string","parentTransactionId":"string","parentFunction":"A","transactionUser":"string","company":"string","serviceOrchestratorEventResponse":"string","overallStatus":"PENDING","compensatoryTransactionStatus":"SUCCESS"}},"responses":{"200":"EventTransactionLogResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}}]},{"key":"system-exceptionManagement-service-v1.0.0","title":"Exception Management API","version":"v1.0.0","description":"Allows the configuration and initiation of exception workflow. Under the configuration, the user can enable the exception workflow, setup the necessary exceptions and update the participant details.","endpointCount":5,"endpoints":[{"method":"POST","path":"/system/exceptions/workflows","fullPath":"/api/v1.0.0/system/exceptions/workflows","operationId":"initiateProcessWorkflow","name":"Initiate the process workflow which contains the process definition key.","summary":"Initiate the exception process workflow.","tags":[],"parameters":[{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"productId":"string","startDate":"string","customerId":"string","participant":"string","extensions":{}}},"responses":{"200":"ProcessWorkflowResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/system/exceptions/settings/{companyId}","fullPath":"/api/v1.0.0/system/exceptions/settings/{companyId}","operationId":"updateExceptionParameters","name":"Enable the exception workflow process.","summary":"Enable the exception workflow process.","tags":[],"parameters":[{"name":"companyId","in":"path","type":"string","required":true,"description":""},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"exceptionWorkflow":"string","dealerEquivalent":"string","chiefDealerEquivalent":"string","extensions":{}}},"responses":{"200":"ExceptionParametersResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/system/exceptions/participants/{participantId}","fullPath":"/api/v1.0.0/system/exceptions/participants/{participantId}","operationId":"updateParticipants","name":"Define the participant which are required for the exception workflow.","summary":"Define the predefined participants (DEALER, CHIEFDEALER, SUPERVISOR) of exception workflow.","tags":[],"parameters":[{"name":"participantId","in":"path","type":"string","required":true,"description":""},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"description":"string","shortDescription":"string","accountOfficer":"string","allowExternalUser":"string","extensions":{}}},"responses":{"200":"ParticipantsResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"POST","path":"/system/exceptions/{applicationId}","fullPath":"/api/v1.0.0/system/exceptions/{applicationId}","operationId":"createExceptions","name":"Create the exceptions for the application which are assigned to the logged in user.","summary":"Create the exceptions for the application which are assigned to the logged in user.","tags":[],"parameters":[{"name":"applicationId","in":"path","type":"string","required":true,"description":"Contains the application id of the service that has crashed due to error."},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"exceptions":[{}],"description":"string","extensions":{}}},"responses":{"200":"ExceptionsResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/system/exceptions/{applicationId}","fullPath":"/api/v1.0.0/system/exceptions/{applicationId}","operationId":"updateExceptions","name":"Authorise the transactions which are assigned to the logged in user.","summary":"Authorise the transactions from the worklist which are assigned to the logged in user.","tags":[],"parameters":[{"name":"applicationId","in":"path","type":"string","required":true,"description":""},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"exceptions":[{}],"description":"string","extensions":{}}},"responses":{"200":"ExceptionsResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}}]},{"key":"system-externalaccounting-service-v1.0.0","title":"Management of external accounting system settings","version":"v1.0.0","description":"API to create and manage external accounting system settings in order to externalize accounting and general ledger system.","endpointCount":2,"endpoints":[{"method":"GET","path":"/system/settings/{settingId}/externalAccountingSystems","fullPath":"/api/v1.0.0/system/settings/{settingId}/externalAccountingSystems","operationId":"getExternalAccountingSystemSettings","name":"Retrieves settings such as accounting modes, system  identifiers and entry movement details. The {settingId} must be SYSTEM.","summary":"Retrieves external accounting system settings.","tags":[],"parameters":[{"name":"settingId","in":"path","type":"string","required":true,"description":"Contains the particular parameter record setting identifier."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"The identifier of the underlying Entity/Company/Branch."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"ExternalAccountingSystemSettingsResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"POST","path":"/system/settings/{settingId}/externalAccountingSystems","fullPath":"/api/v1.0.0/system/settings/{settingId}/externalAccountingSystems","operationId":"createExternalAccountingSystemSettings","name":"Creates settings such as accounting modes, system identifiers and entry movement details. The {settingId} must be SYSTEM. Once the settings are created in the system, they cannot be amended/modified.","summary":"Creates external accounting system settings.","tags":[],"parameters":[{"name":"settingId","in":"path","type":"string","required":true,"description":"Contains the particular parameter record setting identifier."},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"The identifier of the underlying Entity/Company/Branch."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"accountingMode":"string","movementSuppress":"string","systemId":"string","arrangementMicroservice":"string"}},"responses":{"200":"ExternalAccountingSystemSettingsResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}}]},{"key":"system-fileTypes-v1.0.0","title":"File Classification","version":"v1.0.0","description":"API to get the file classification of Transact applications","endpointCount":1,"endpoints":[{"method":"GET","path":"/system/settings/{applicationName}/classification","fullPath":"/api/v1.0.0/system/settings/{applicationName}/classification","operationId":"getFileTypes","name":"Retrieves the file classification of Transact applications. This API accepts application name as mandatory parameter.","summary":"To get the file classifications ","tags":[],"parameters":[{"name":"applicationName","in":"path","type":"string","required":true,"description":"Specifies the name of the application to be considered for erasure of details for customer data protection purposes"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"FileTypesResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}}]},{"key":"system-fundsauthorisationstatus-v1.0.0","title":"System Funds Authorisation Status","version":"v1.0.0","description":"API to manage the Funds Authorisation settings in Transact. The switching between online and Limited Service Mode(LSM) is done in phases by changing the value of the fundsAuthorisationStatus parameter. a) Online Phase is when Transact is in the normal service mode and Funds Authorisation Microservic","endpointCount":2,"endpoints":[{"method":"GET","path":"/system/settings/{settingId}/fundsAuthorisation/status","fullPath":"/api/v1.0.0/system/settings/{settingId}/fundsAuthorisation/status","operationId":"getFundsAuthorisationStatus","name":"Retrieve status of Funds Authorisation system","summary":"Retrieve Funds Authorisation Status","tags":[],"parameters":[{"name":"settingId","in":"path","type":"string","required":true,"description":"Contains the particular parameter record setting identifier."},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from t24 on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"FundsAuthorisationStatusResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"PUT","path":"/system/settings/{settingId}/fundsAuthorisation/status","fullPath":"/api/v1.0.0/system/settings/{settingId}/fundsAuthorisation/status","operationId":"updateFundAuthorisationStatus","name":"Update status of Funds Authorisation system","summary":"Update Funds Authorisation Status","tags":[],"parameters":[{"name":"settingId","in":"path","type":"string","required":true,"description":""},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"faStatus":"string"}},"responses":{"200":"FundAuthorisationStatusResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}}]},{"key":"system-getDocumentRequired-v1.0.0","title":"Document Management Settings","version":"v1.0.0","description":"API to retrieve the settings related to document management such as document name, document type and whether it is mandatory","endpointCount":1,"endpoints":[{"method":"GET","path":"/system/settings/requiredDocuments","fullPath":"/api/v1.0.0/system/settings/requiredDocuments","operationId":"getRequiredDocumentsSettings","name":"Retrieves the system defined settings for list of required documents","summary":"Retrieves the system defined settings for list of required documents","tags":[],"parameters":[{"name":"documentRequired","in":"query","type":"string","required":false,"description":"Free textfield used to describe the documents to be presented under the letter of credit, in addition to the predefined documents associated with documentCode."},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from t24 on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"The identifier of the underlying Entity/Company/Branch."}],"requestBodyExample":null,"responses":{"200":"RequiredDocumentsSettingsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}}]},{"key":"system-getSPFInformation-v1.0.0","title":"Transact Release Number","version":"v1.0.0","description":"API to retrieve the System Parameters such as run date and current release of the System ","endpointCount":1,"endpoints":[{"method":"GET","path":"/system/settings/versionNumber","fullPath":"/api/v1.0.0/v1.0.0/system/settings/versionNumber","operationId":"getSystemParameters","name":"Retrieves SPF information","summary":"Retrieves SPF information such as current release etc","tags":[],"parameters":[{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from t24 on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"The identifier of the underlying Entity/Company/Branch."}],"requestBodyExample":null,"responses":{"200":"SystemParametersResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}}]},{"key":"system-getSPFInformation-v1.1.0","title":"Transact Release Number","version":"v1.1.0","description":"API to retrieve the System Parameter such as run date and current release of the system ","endpointCount":2,"endpoints":[{"method":"GET","path":"/system/settings/versionNumber","fullPath":"/api/v1.1.0/system/settings/versionNumber","operationId":"getSystemParameter","name":"Retrieves system parameter information such as current release etc","summary":"Retrieves system parameter information","tags":[],"parameters":[{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"SystemParameterResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/system/settings/definitions","fullPath":"/api/v1.1.0/system/settings/definitions","operationId":"getSystemDefinitions","name":"Retrieves the current software definitions from Transact and stores the xml file generated at a physical location.","summary":"Retrieves the current software definitions from Transact.","tags":[],"parameters":[{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"SystemDefinitionsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}}]},{"key":"system-getUsageStatistics-v1.0.0","title":"Transaction Usage Statistics","version":"v1.0.0","description":"API to retrieve the usage count of metrics of various channels and business transactions for a particular date","endpointCount":1,"endpoints":[{"method":"GET","path":"/system/metrics/transactions/itemCount","fullPath":"/api/v1.0.0/system/metrics/transactions/itemCount","operationId":"getUsageStats","name":"To get Usage statistics","summary":"To get Usage statistics by date","tags":[],"parameters":[{"name":"resourceReference","in":"query","type":"string","required":false,"description":"Contains the resource name. This is a broader classification of the grouped records. Example: Arrangements are displayed as CONTRACTS, PAYMENT.ORDER records as PAYMENT.ORDER, POR.TRANSACTION records a"},{"name":"metricType","in":"query","type":"string","required":false,"description":"Contains the type of metering metric that are to be displayed. Example: ENTRIES, QUERIES, PAYMENTS etc.  For Arrangements, it will contain product line DEPOSITS#<<each product group under the product "},{"name":"metricTypeMatches","in":"query","type":"string","required":false,"description":"Contains the strings that the metricType of a record has to match for the record to be selected"},{"name":"meteredDate","in":"query","type":"string","required":false,"description":"Contains the metering date stored in the recorded profile"},{"name":"meteredDateLessThan","in":"query","type":"string","required":false,"description":"Indicates the meteredDate value below which selection has to be made"},{"name":"meteredDateLessThanOrEquals","in":"query","type":"string","required":false,"description":"Indicates the meteredDate value below or equal to which selection has to be made"},{"name":"meteredDateGreaterThan","in":"query","type":"string","required":false,"description":"Indicates the meteredDate value above which selection has to be made"},{"name":"meteredDateGreaterThanOrEquals","in":"query","type":"string","required":false,"description":"Indicates the meteredDate value above or equal to which selection has to be made"},{"name":"meteredDateBetween","in":"query","type":"string","required":false,"description":"Indicates the range in which meteredDate has to be in for the record to be selected"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from t24 on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"UsageStatsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}}]},{"key":"system-internal-v1.0.0","title":"System Configuration","version":"v1.0.0","description":"API to update the system configuration settings and the settings related to the initial Transact system build.","endpointCount":2,"endpoints":[{"method":"PUT","path":"/system/configuration/systemParameters/{systemParameterId}","fullPath":"/api/v1.0.0/system/configuration/systemParameters/{systemParameterId}","operationId":"updateSystemParameters","name":"Update the system parameters such as the products, product code, site name, enquiry page limit, etc.","summary":"Update the system parameters","tags":[],"parameters":[{"name":"systemParameterId","in":"path","type":"string","required":true,"description":"The unique identifier of system parameter."},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"mainAccounts":[{}],"unixBackups":[{}],"unixRestores":[{}],"productAccounts":[{}],"products":[{}],"preBatchRoutines":[{}],"runDate":"2024-01-01","siteName":"string","exceptionLogHistoryDay":"string","cacheExpiry":"string","enquiryPageLimit":"string","systemBackupMode":"string","holdBatchOutput":"string","reportRetentionDay":"string","restrictReportView":"string"}},"responses":{"200":"SystemParametersResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/system/installation/initialSystemBuilds/{initialSystemBuildId}","fullPath":"/api/v1.0.0/system/installation/initialSystemBuilds/{initialSystemBuildId}","operationId":"updateInitialSystemBuildSettings","name":"Update initial system build configuration parameters such as the bank name, local currency, license code, maintainance date etc","summary":"Update the initial system build configuration parameters.","tags":[],"parameters":[{"name":"initialSystemBuildId","in":"path","type":"string","required":true,"description":"The unique identifier of initial system build settings."},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"institutionalAddresses":[{}],"languages":[{}],"products":[{}],"implementationChoiceOverrideTableNames":[{}],"institutionName":"string","localCountryCode":"string","localCurrency":"string","masterCompanyDate":"2024-01-01","swiftCode":"string","telexCode":"string","financialYearEnd":"2024-01-01","checkdigitType":"string","accountMask":"string","licenseCode":"string","maintenanceDate":"2024-01-01"}},"responses":{"200":"InitialSystemBuildSettingsResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}}]},{"key":"system-masterDataAccess-v1.0.0","title":"Master Data Access","version":"v1.0.0","description":"API to manage configuration of Master Data Access. Master Data Access allows  retrieval of data required for Transact from external systems i.e Party data, Reference data such as currency, sector.","endpointCount":3,"endpoints":[{"method":"GET","path":"/system/settings/masterDataAccess/externalSystems","fullPath":"/api/v1.0.0/system/settings/masterDataAccess/externalSystems","operationId":"getMasterDataAccess","name":"Retrieve details of Master Data entities which are external to Transact","summary":"Retrieves external Master Data entities","tags":[],"parameters":[{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"MasterDataAccessResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"POST","path":"/system/settings/masterDataAccess/externalSystems","fullPath":"/api/v1.0.0/system/settings/masterDataAccess/externalSystems","operationId":"configureMasterDataAccess","name":"Configure Master Data entities which are external to Transact","summary":"Configure external Master Data entities","tags":[],"parameters":[{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"externalEntities":[{}],"entities":[{}],"masterDataAccessLogDirectory":"string"}},"responses":{"200":"MasterDataAccessResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/system/settings/masterDataAccess/externalSystems","fullPath":"/api/v1.0.0/system/settings/masterDataAccess/externalSystems","operationId":"amendMasterDataAccess","name":"Amend Master Data entities which are external to Transact","summary":"Amend external Master Data entities","tags":[],"parameters":[{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"externalEntities":[{}],"entities":[{}],"masterDataAccessLogDirectory":"string"}},"responses":{"200":"MasterDataAccessResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}}]},{"key":"system-messageServices-v1.0.0","title":"Transact Message Services","version":"v1.0.0","description":"API to manage the configuration settings of the Transact message service component (aka OFS). OFS provides a messaging interface that allows the system to process transaction and query requests. Before any requests can be processed the necessary parameters for the particular service have to be confi","endpointCount":4,"endpoints":[{"method":"GET","path":"/system/settings/messageServices/{messageServiceId}","fullPath":"/api/v1.0.0/system/settings/messageServices/{messageServiceId}","operationId":"getMessageService","name":"Retrieves the details of the specified message service in Transact.","summary":"Retrieve details of specified message service.","tags":[],"parameters":[{"name":"messageServiceId","in":"path","type":"string","required":true,"description":"Identifier of the message service."},{"name":"description","in":"query","type":"string","required":false,"description":"Contains the description of the message service."},{"name":"communicationType","in":"query","type":"string","required":false,"description":"Specifies the mode of communication used to exchange data with the message service. Possible values are TELNET, BATCH, SESSION. TELNET - The telnet connection will only accept OFS syntax messages. Eac"},{"name":"logPath","in":"query","type":"string","required":false,"description":"Specifies the name of the directory path where every access to Transact is logged using message service."},{"name":"logLevel","in":"query","type":"string","required":false,"description":"Specifies the log detail level of communication to be logged. Possible values are  NONE - No message logging, OPEN - Only initial start and stop for processes are logged, EXCEPT - Only exceptions such"},{"name":"maintainMessage","in":"query","type":"string","required":false,"description":"Specifies whether the audit details are to be maintained for each message service communication. Possible values are 'Y' or null."},{"name":"syntaxType","in":"query","type":"string","required":false,"description":"Specifies the syntax type of the message in the communication. Possible values are OFS or GTS or XML."},{"name":"userId","in":"query","type":"string","required":false,"description":"Specifies the  Transact user to be used by message service."},{"name":"attribute","in":"query","type":"string","required":false,"description":"Specifies the special attributes for processing the message."},{"name":"channelName","in":"query","type":"string","required":false,"description":"Specifies the channel name for which the message service is used, for example internet,  mobile etc."},{"name":"backgroundProcessUserId","in":"query","type":"string","required":false,"description":"Specifies the user login id used in the background process that will automatically initiate the communication with the external source."},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"MessageServiceResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"POST","path":"/system/settings/messageServices/{messageServiceId}","fullPath":"/api/v1.0.0/system/settings/messageServices/{messageServiceId}","operationId":"configureMessageService","name":"Configure message service . The configuration of the message service involves setting the necessary parameters required for the connection with Transact such as the type of message service, the log details and message features.","summary":"Configure message service","tags":[],"parameters":[{"name":"messageServiceId","in":"path","type":"string","required":true,"description":"Identifier of the message service."},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"attributes":[{}],"backgroundProcessUserIds":[{}],"backgroundProcessIds":[{}],"description":"string","communicationType":"string","logPath":"string","logLevel":"string","maintainMessage":"string","prefixId":"string","syntaxType":"string","userId":"string","sameAuthoriser":"string","channelName":"string","inQueueDirectory":"string","outQueueDirectory":"string"}},"responses":{"200":"MessageServiceResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/system/settings/messageServices/{messageServiceId}","fullPath":"/api/v1.0.0/system/settings/messageServices/{messageServiceId}","operationId":"updateMessageService","name":"Update the configuration settings of the message service such as the log level, type of service etc.","summary":"Update message service settings","tags":[],"parameters":[{"name":"messageServiceId","in":"path","type":"string","required":true,"description":"Identifier of the message service."},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"attributes":[{}],"backgroundProcessUserIds":[{}],"backgroundProcessIds":[{}],"description":"string","communicationType":"string","logPath":"string","logLevel":"string","maintainMessage":"string","prefixId":"string","syntaxType":"string","userId":"string","sameAuthoriser":"string","channelName":"string","inQueueDirectory":"string","outQueueDirectory":"string"}},"responses":{"200":"MessageServiceResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/system/settings/messageServices","fullPath":"/api/v1.0.0/system/settings/messageServices","operationId":"getMessageServices","name":"Retrieves the details of all available message services in Transact.","summary":"Retrieve a list of available message services.","tags":[],"parameters":[{"name":"messageServiceId","in":"query","type":"string","required":false,"description":"Identifier of the message service."},{"name":"description","in":"query","type":"string","required":false,"description":"Contains the description of the message service."},{"name":"communicationType","in":"query","type":"string","required":false,"description":"Specifies the mode of communication used to exchange data with the message service. Possible values are TELNET, BATCH, SESSION. TELNET - The telnet connection will only accept OFS syntax messages. Eac"},{"name":"logPath","in":"query","type":"string","required":false,"description":"Specifies the name of the directory path where every access to Transact is logged using message service."},{"name":"logLevel","in":"query","type":"string","required":false,"description":"Specifies the log detail level of communication to be logged. Possible values are  NONE - No message logging, OPEN - Only initial start and stop for processes are logged, EXCEPT - Only exceptions such"},{"name":"maintainMessage","in":"query","type":"string","required":false,"description":"Specifies whether the audit details are to be maintained for each message service communication. Possible values are 'Y' or null."},{"name":"syntaxType","in":"query","type":"string","required":false,"description":"Specifies the syntax type of the message in the communication. Possible values are OFS or GTS or XML."},{"name":"userId","in":"query","type":"string","required":false,"description":"Specifies the  Transact user to be used by message service."},{"name":"attribute","in":"query","type":"string","required":false,"description":"Specifies the special attributes for processing the message."},{"name":"channelName","in":"query","type":"string","required":false,"description":"Specifies the channel name for which the message service is used, for example internet,  mobile etc."},{"name":"backgroundProcessUserId","in":"query","type":"string","required":false,"description":"Specifies the user login id used in the background process that will automatically initiate the communication with the external source."},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"MessageServicesResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}}]},{"key":"system-methodDefinition-v1.0.0","title":"APIs to create, update and retrieve the signature of a method","version":"v1.0.0","description":"Create, update and retrieve the signature of a method such as parameter name, data type and other options which is used to invoke.","endpointCount":4,"endpoints":[{"method":"GET","path":"/system/methods/{methodId}","fullPath":"/api/v1.0.0/system/methods/{methodId}","operationId":"getMethodDefinition","name":"Retrieves the method details of the requested method such as parameter name, data type, options provided for the custom method.","summary":"Retrieves the method details of the requested method.","tags":["SYSTEM"],"parameters":[{"name":"methodId","in":"path","type":"string","required":true,"description":"The method used to enter into a deal, e.g. telephone, Reuters, email and etc."},{"name":"purpose","in":"query","type":"string","required":false,"description":"Specifies the purpose of the user defined method. This can be classified as CHARGE and INTEREST."},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"MethodDefinitionResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"POST","path":"/system/methods/{methodId}","fullPath":"/api/v1.0.0/system/methods/{methodId}","operationId":"createMethodDefinition","name":"Create the signature of a method such as parameter name, data type and other options which is used to invoke.","summary":"Create the signature of a method which is used to invoke.","tags":["SYSTEM"],"parameters":[{"name":"methodId","in":"path","type":"string","required":true,"description":"The method used to enter into a deal, e.g. telephone, Reuters, email and etc."},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"parameters":[{}],"allowedCompanies":[{}],"displayName":"string","purpose":"string","extensions":{}}},"responses":{"200":"MethodDefinitionResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/system/methods/{methodId}","fullPath":"/api/v1.0.0/system/methods/{methodId}","operationId":"updateMethodDefinition","name":"Update the signature of a method such as parameter name, data type and other options which is used to invoke.","summary":"Update the signature of a method which is used to invoke.","tags":["SYSTEM"],"parameters":[{"name":"methodId","in":"path","type":"string","required":true,"description":"The method used to enter into a deal, e.g. telephone, Reuters, email and etc."},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"parameters":[{}],"allowedCompanies":[{}],"displayName":"string","purpose":"string","extensions":{}}},"responses":{"200":"MethodDefinitionResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/system/methods","fullPath":"/api/v1.0.0/system/methods","operationId":"getMethodDefinitions","name":"Retrieves the list of method details such as parameter name, data type, options provided for the custom method.","summary":"Retrieves the list of method details.","tags":["SYSTEM"],"parameters":[{"name":"purpose","in":"query","type":"string","required":false,"description":"Specifies the purpose of the user defined method. This can be classified as CHARGE and INTEREST."},{"name":"methodId","in":"query","type":"string","required":false,"description":"Indicates the identifier of a user defined method."},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"MethodDefinitionsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}}]},{"key":"system-processWorkFlow-service-v1.0.0","title":"Process workflows","version":"v1.0.0","description":"API to retrieve the information related to process work flow details such as work item assigned to the user, on which participant\u00e2\u20ac\u2122s work list the activity is residing, details on parent process which contains a sequence of workflow steps associated with it and also the role-less transactions for t","endpointCount":5,"endpoints":[{"method":"GET","path":"/system/workflows/processes","fullPath":"/api/v1.0.0/v1.0.0/system/workflows/processes","operationId":"getPendingWorkflows","name":"Retrieves information on work item assigned to the logged in user like approval or reassigning of the work item.","summary":"Retrieves information on work item assigned to the logged in user. ","tags":[],"parameters":[{"name":"data","in":"query","type":"string","required":false,"description":"Contains any input parameters/data required for the job"},{"name":"processNumber","in":"query","type":"string","required":false,"description":"Identifies the process which involves multiple task for Ex: Enrolling the new customer"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from t24 on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"The identifier of the underlying Entity/Company/Branch."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"PendingWorkflowsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/system/workflows/activities","fullPath":"/api/v1.0.0/v1.0.0/system/workflows/activities","operationId":"getWorkflowPendingActivities","name":"Retrieve information on which participant's work list the activity is residing currently. It also specifies status of the activity.","summary":"Retrieve information on which participant's work list the activity is residing currently.","tags":[],"parameters":[{"name":"activityTransaction","in":"query","type":"string","required":false,"description":"Process Workflow Activity Transactions"},{"name":"user","in":"query","type":"string","required":false,"description":"The user who created the project"},{"name":"transactionReference","in":"query","type":"string","required":false,"description":"Transaction reference identifier."},{"name":"process","in":"query","type":"string","required":false,"description":"Process"},{"name":"pwActivityStatus","in":"query","type":"string","required":false,"description":"Process workflow activity status  POSSIBLE VALUES: COMPLETED APPROVED AUTHORISED"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from t24 on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"The identifier of the underlying Entity/Company/Branch."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"WorkflowPendingActivitiesResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/system/workflows/transactions","fullPath":"/api/v1.0.0/v1.0.0/system/workflows/transactions","operationId":"getTransactions","name":"Process workflow transactions initiated by a parent process which contains a sequence of workflow steps associated with it. This Api returns all the role associated transactions for the provided originate process. ","summary":"Process workflow transactions associated to a role","tags":[],"parameters":[{"name":"userRole","in":"query","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"originateProcess","in":"query","type":"string","required":false,"description":"Process Id who initiated the entire workflow of transactions"},{"name":"processId","in":"query","type":"string","required":false,"description":"Contains the process identifier"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from t24 on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"The identifier of the underlying Entity/Company/Branch."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"TransactionsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/system/workflows/roleless/transactions","fullPath":"/api/v1.0.0/v1.0.0/system/workflows/roleless/transactions","operationId":"getRolelessTransactions","name":"Process workflow transactions initiated by a parent process which contains a sequence of workflow steps associated with it. This Api returns all the roleless transactions for the provided originate process.","summary":"Process workflow transactions not associated to a role ","tags":[],"parameters":[{"name":"processId","in":"query","type":"string","required":false,"description":"Contains the process identifier"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from t24 on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"The identifier of the underlying Entity/Company/Branch."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"RolelessTransactionsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/system/workflows/participants","fullPath":"/api/v1.0.0/v1.0.0/system/workflows/participants","operationId":"getWorkflowParticipants","name":"Retrieves information related to different participants like Dealer, Chief dealer,etc. and the users attached to those participants.","summary":"Retrieves information related to different participants and the users attached those participants.","tags":[],"parameters":[{"name":"participantId","in":"query","type":"string","required":false,"description":"Process Workflow Participant ID"},{"name":"accountOfficer","in":"query","type":"string","required":false,"description":"Identifier of Department Account Officer"},{"name":"user","in":"query","type":"string","required":false,"description":"The user who created the project"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from t24 on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"The identifier of the underlying Entity/Company/Branch."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"WorkflowParticipantsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}}]},{"key":"system-processWorkFlow-service-v1.0.1","title":"Process workflows","version":"v1.0.1","description":"API to retrieve the information related to process work flow details such as work item assigned to the user, on which participant's work list the activity is residing, details on parent process which contains a sequence of workflow steps associated with it and also the role-less transactions for the","endpointCount":5,"endpoints":[{"method":"GET","path":"/system/workflows/activities","fullPath":"/api/v1.0.1/system/workflows/activities","operationId":"getWorkflowPendingActivities","name":"Retrieve information on which participant's work list the activity is residing currently. It also specifies status of the activity.","summary":"Retrieve information on which participant's work list the activity is residing currently.","tags":[],"parameters":[{"name":"activityTransaction","in":"query","type":"string","required":false,"description":"Process Workflow Activity Transactions"},{"name":"user","in":"query","type":"string","required":false,"description":"The user who created the project"},{"name":"transactionReference","in":"query","type":"string","required":false,"description":"Contains the identifier for the transaction in the core system"},{"name":"process","in":"query","type":"string","required":false,"description":"Process"},{"name":"pwActivityStatus","in":"query","type":"string","required":false,"description":"Process workflow activity status  POSSIBLE VALUES: COMPLETED APPROVED AUTHORISED"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"WorkflowPendingActivitiesResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/system/workflows/transactions","fullPath":"/api/v1.0.1/system/workflows/transactions","operationId":"getTransactions","name":"Process workflow transactions initiated by a parent process which contains a sequence of workflow steps associated with it. This Api returns all the role associated transactions for the provided originate process. ","summary":"Process workflow transactions associated to a role","tags":[],"parameters":[{"name":"userRole","in":"query","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"originateProcess","in":"query","type":"string","required":false,"description":"Process Id who initiated the entire workflow of transactions"},{"name":"processId","in":"query","type":"string","required":false,"description":"Contains the process identifier"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"TransactionsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/system/workflows/roleless/transactions","fullPath":"/api/v1.0.1/system/workflows/roleless/transactions","operationId":"getRolelessTransactions","name":"Process workflow transactions initiated by a parent process which contains a sequence of workflow steps associated with it. This Api returns all the roleless transactions for the provided originate process.","summary":"Process workflow transactions not associated to a role ","tags":[],"parameters":[{"name":"processId","in":"query","type":"string","required":false,"description":"Contains the process identifier"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"RolelessTransactionsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/system/workflows/participants","fullPath":"/api/v1.0.1/system/workflows/participants","operationId":"getWorkflowParticipants","name":"Retrieves information related to different participants like Dealer, Chief dealer,etc. and the users attached to those participants.","summary":"Retrieves information related to different participants and the users attached those participants.","tags":[],"parameters":[{"name":"participantId","in":"query","type":"string","required":false,"description":"Process Workflow Participant ID"},{"name":"accountOfficer","in":"query","type":"string","required":false,"description":"Identifier of Department Account Officer"},{"name":"user","in":"query","type":"string","required":false,"description":"The user who created the project"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"WorkflowParticipantsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/system/workflows/processes","fullPath":"/api/v1.0.1/system/workflows/processes","operationId":"getPendingWorkflows","name":"Retrieves information on work item assigned to the logged in user like approval or reassigning of the work item.","summary":"Retrieves information on work item assigned to the logged in user. ","tags":[],"parameters":[{"name":"data","in":"query","type":"string","required":false,"description":"Contains any input parameters/data required for the job"},{"name":"processNumber","in":"query","type":"string","required":false,"description":"Identifies the process which involves multiple task for Ex: Enrolling the new customer"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"PendingWorkflowsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}}]},{"key":"system-queryExtension-v1.0.0","title":"Enquiry Extensions","version":"v1.0.0","description":"Creates, Amends, Deletes and Queries the query extensions, which stores the generic field definitions, for query processing.","endpointCount":4,"endpoints":[{"method":"GET","path":"/system/settings/configuration/queryExtensions/{queryExtensionId}","fullPath":"/api/v1.0.0/system/settings/configuration/queryExtensions/{queryExtensionId}","operationId":"getEnquiryParameter","name":"Fetches the extensions details for the query, such as generic field definition etc from Transact.","summary":"Fetches the extensions details for the queries in Transact.","tags":[],"parameters":[{"name":"queryExtensionId","in":"path","type":"string","required":true,"description":"The identifier for the query extension."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"EnquiryParameterResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"POST","path":"/system/settings/configuration/queryExtensions/{queryExtensionId}","fullPath":"/api/v1.0.0/system/settings/configuration/queryExtensions/{queryExtensionId}","operationId":"createEnquiryParameter","name":"Define the extensions for the query, which stores the generic field definitions, for query processing in Transact.","summary":"Defines the extensions for the queries in Transact.","tags":[],"parameters":[{"name":"queryExtensionId","in":"path","type":"string","required":true,"description":"The identifier for the query extension."},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"apiGenericFields":[{}],"queryExtensionDescription":"string","extensions":{}}},"responses":{"200":"EnquiryParameterResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/system/settings/configuration/queryExtensions/{queryExtensionId}","fullPath":"/api/v1.0.0/system/settings/configuration/queryExtensions/{queryExtensionId}","operationId":"amendEnquiryParameter","name":"Amends the extensions for the query, which stores the generic field definitions, for query processing in Transact.","summary":"Amends the extensions for the queries in Transact.","tags":[],"parameters":[{"name":"queryExtensionId","in":"path","type":"string","required":true,"description":"The identifier for the query extension."},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"apiGenericFields":[{}],"queryExtensionDescription":"string","extensions":{}}},"responses":{"200":"EnquiryParameterResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"DELETE","path":"/system/settings/configuration/queryExtensions/{queryExtensionId}","fullPath":"/api/v1.0.0/system/settings/configuration/queryExtensions/{queryExtensionId}","operationId":"deleteEnquiryParameter","name":"Delete the extensions for the query, which stores the generic field definitions, for query processing in Transact.","summary":"Deletes the extensions for the queries in Transact.","tags":[],"parameters":[{"name":"queryExtensionId","in":"path","type":"string","required":true,"description":"The identifier for the query extension."},{"name":"payload","in":"body","type":"object","required":false,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}}},"responses":{"200":"EnquiryParameterResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}}]},{"key":"system-softwareUpdateRollBack-v1.0.0","title":"Software Update Roll Back","version":"v1.0.0","description":"API to manage configuration of software update roll back . The purpose of update roll back is to revert to the previous state of the system before the update .","endpointCount":3,"endpoints":[{"method":"GET","path":"/system/settings/softwareUpdates/rollBacks","fullPath":"/api/v1.0.0/system/settings/softwareUpdates/rollBacks","operationId":"getSoftwareUpdateRollBack","name":"Retrieve details of software update roll back which includes the original version of the update and the current version installed in the system","summary":"Retrieves software update roll back details","tags":[],"parameters":[{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":null,"responses":{"200":"SoftwareUpdateRollBackResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"POST","path":"/system/settings/softwareUpdates/rollBacks","fullPath":"/api/v1.0.0/system/settings/softwareUpdates/rollBacks","operationId":"configureSoftwareUpdateRollBack","name":"Configure software update roll back details which rolls back current update to the previous version of the update installed in the system","summary":"Configure software update roll back details","tags":[],"parameters":[{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"updates":[{}]}},"responses":{"200":"SoftwareUpdateRollBackResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/system/settings/softwareUpdates/{softwareUpdateId}/rollBacks","fullPath":"/api/v1.0.0/system/settings/softwareUpdates/{softwareUpdateId}/rollBacks","operationId":"amendSoftwareUpdateRollBack","name":"Amend  software update roll back details which rolls back current update to the previous version of the update installed in the system","summary":"Amend software update roll back details","tags":[],"parameters":[{"name":"softwareUpdateId","in":"path","type":"string","required":true,"description":"Contains the identifier for the software update roll back settings"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"updates":[{}]}},"responses":{"200":"SoftwareUpdateRollBackResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}}]},{"key":"system-updateServiceListDetails-v1.0.0","title":"Serviceautomation","version":"v1.0.0","description":"Service Automation Phase 2(Deprecated- A newer version V2.0.2 available)","endpointCount":3,"endpoints":[{"method":"PUT","path":"/system/tsaservice/{serviceId}/jobs","fullPath":"/api/v1.0.0/system/tsaservice/{serviceId}/jobs","operationId":"updateService","name":"start or stop service with correlation id","summary":"start or stop service with correlation id(Deprecated- A newer version V2.0.2 available)","tags":[],"parameters":[{"name":"serviceId","in":"path","type":"string","required":true,"description":""},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"The identifier of the underlying Entity/Company/Branch."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"jobServerProfiles":[{}],"userId":"string","jobOperation":"START","correlationId":"string"}},"responses":{"200":"ServiceResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/system/jobtimes","fullPath":"/api/v1.0.0/system/jobtimes","operationId":"getAllJobTimes","name":"Get all job times report","summary":"Get all job times report(Deprecated- A newer version V2.0.2 available)","tags":[],"parameters":[{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from t24 on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"The identifier of the underlying Entity/Company/Branch."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"AllJobTimesResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"GET","path":"/system/reportTimes/{batchDate}","fullPath":"/api/v1.0.0/system/reportTimes/{batchDate}","operationId":"getAllReportTimes","name":"Get all report times","summary":"Get all report times(Deprecated- A newer version V2.0.2 available)","tags":[],"parameters":[{"name":"batchDate","in":"path","type":"string","required":true,"description":"The bank date on which the particular report was generated."},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from t24 on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"The identifier of the underlying Entity/Company/Branch."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"AllReportTimesResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}}]},{"key":"system-us-nsfApprovers-v1.0.0","title":"US Model Bank NSF approver management","version":"v1.0.0","description":"The NSF(Non-Sufficient Funds) approver service API allows to create, update and manage NSF approvers and approval limits.","endpointCount":4,"endpoints":[{"method":"POST","path":"/system/us/nsf/users/{userId}","fullPath":"/api/v1.0.0/system/us/nsf/users/{userId}","operationId":"createUsNsfApprover","name":"Creates a profile for the financial institute's user who reviews the overdraft exceptions and make decisions on approving or rejecting the transaction and also set the approval limits for overdraft transactions","summary":"Creates non-sufficient funds reviewer profile","tags":["SYSTEM"],"parameters":[{"name":"userId","in":"path","type":"string","required":true,"description":"Identifies the reference of user profiles of non-sufficient fund transactions reviewer or approver"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"approvedAmount":"string","extensions":{}}},"responses":{"200":"UsNsfApproverResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/system/us/nsf/users/{userId}","fullPath":"/api/v1.0.0/system/us/nsf/users/{userId}","operationId":"updateUsNsfApprover","name":"Allows changes to be made to non-sufficient funds reviewers approval limits","summary":"Allows changes to be made to non-sufficient funds reviewer profile","tags":["SYSTEM"],"parameters":[{"name":"userId","in":"path","type":"string","required":true,"description":"Identifies the reference of user profiles of non-sufficient fund transactions reviewer or approver"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"approvedAmount":"string","extensions":{}}},"responses":{"200":"UsNsfApproverResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"DELETE","path":"/system/us/nsf/users/{userId}","fullPath":"/api/v1.0.0/system/us/nsf/users/{userId}","operationId":"deleteUsNsfApprover","name":"Removes the non-sufficient funds reviewer profile","summary":"Removes the non-sufficient funds reviewer profile","tags":["SYSTEM"],"parameters":[{"name":"userId","in":"path","type":"string","required":true,"description":"Identifies the reference of user profiles of non-sufficient fund transactions reviewer or approver"},{"name":"payload","in":"body","type":"object","required":false,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}}},"responses":{"200":"UsNsfApproverResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"GET","path":"/system/us/nsf/users","fullPath":"/api/v1.0.0/system/us/nsf/users","operationId":"getUsNsfApproverDetails","name":"Retrieves non-sufficient funds reviewer profile and approval limit","summary":"Retrieves non-sufficient funds reviewer profile","tags":["SYSTEM"],"parameters":[{"name":"userId","in":"query","type":"string","required":false,"description":"Identifies the reference of user profiles of non-sufficient fund transactions reviewer or approver"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"UsNsfApproverDetailsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}}]},{"key":"system-us-nsfApprovers-v2.0.0","title":"US Model Bank NSF approver management","version":"v2.0.0","description":"The NSF(Non-Sufficient Funds) approver service API allows to create, update and manage NSF approvers and approval limits.","endpointCount":7,"endpoints":[{"method":"POST","path":"/system/us/nsf/users/{userId}","fullPath":"/api/v2.0.0/system/us/nsf/users/{userId}","operationId":"createUsNsfApprover","name":"Creates a profile for the financial institute's user who reviews the overdraft exceptions and make decisions on approving or rejecting the transaction and also set the approval limits for overdraft transactions.","summary":"Creates  non-sufficient funds reviewer profile.","tags":["SYSTEM"],"parameters":[{"name":"userId","in":"path","type":"string","required":true,"description":"The user name to be loaded for reporting jobs during Close of Business If no user name is entered in this field then the default profile for the user 'operator' is used."},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"reviewDesks":[{}],"groups":[{}],"userId":"string","userName":"string","email":"string","approvedAmount":"string","extensions":{}}},"responses":{"200":"UsNsfApproverResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse","default":"ScreenErrorResponse"}},{"method":"PUT","path":"/system/us/nsf/users/{userId}","fullPath":"/api/v2.0.0/system/us/nsf/users/{userId}","operationId":"updateUsNsfApprover","name":"Allows changes to be made to non-sufficient funds reviewer's approval limits.","summary":"Allows changes to be made to non-sufficient funds reviewer profile.","tags":["SYSTEM"],"parameters":[{"name":"userId","in":"path","type":"string","required":true,"description":"The user name to be loaded for reporting jobs during Close of Business If no user name is entered in this field then the default profile for the user 'operator' is used."},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"reviewDesks":[{}],"groups":[{}],"userId":"string","userName":"string","email":"string","approvedAmount":"string","extensions":{}}},"responses":{"200":"UsNsfApproverResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse","default":"ScreenErrorResponse"}},{"method":"DELETE","path":"/system/us/nsf/users/{userId}","fullPath":"/api/v2.0.0/system/us/nsf/users/{userId}","operationId":"deleteUsNsfApprover","name":"Removes the non-sufficient funds reviewer profile.","summary":"Removes the non-sufficient funds reviewer profile.","tags":["SYSTEM"],"parameters":[{"name":"userId","in":"path","type":"string","required":true,"description":"The user name to be loaded for reporting jobs during Close of Business If no user name is entered in this field then the default profile for the user 'operator' is used."},{"name":"payload","in":"body","type":"object","required":false,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}}},"responses":{"200":"UsNsfApproverResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse","default":"ScreenErrorResponse"}},{"method":"GET","path":"/system/us/nsf/users","fullPath":"/api/v2.0.0/system/us/nsf/users","operationId":"getUsNsfApproverDetails","name":"Retrieves non-sufficient funds reviewer profile and approval limit.","summary":"Retrieves non-sufficient funds reviewer profile.","tags":["SYSTEM"],"parameters":[{"name":"userId","in":"query","type":"string","required":false,"description":"Identifier for the user"},{"name":"reviewDesk","in":"query","type":"string","required":false,"description":"Indicates the NSF (Non-Sufficient Funds) desk assigned to the NSF officer. NSF exceptions from accounts that are processed by the NSF officer can be reviewed by them."},{"name":"group","in":"query","type":"string","required":false,"description":""},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"UsNsfApproverDetailsResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse","default":"QueryErrorResponse"}},{"method":"POST","path":"/system/us/nsf/users","fullPath":"/api/v2.0.0/system/us/nsf/users","operationId":"createBulkUsNsApprover","name":"Allows creating the profiles for the financial institute's non-sufficient funds reviewer profiles in bulk. The profiles created are for those users who review the overdraft exceptions and make decisions on approving or rejecting the transactions. The approval limits for overdraft transactions are also set in their profile.","summary":"Allows creating non-sufficient funds reviewer profiles in bulk.","tags":["SYSTEM"],"parameters":[{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"reviewDesks":[{}],"groups":[{}],"userId":"string","userName":"string","email":"string","approvedAmount":"string","extensions":{}}},"responses":{"200":"BulkUsNsApproverResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse","default":"ScreenErrorResponse"}},{"method":"PUT","path":"/system/us/nsf/users","fullPath":"/api/v2.0.0/system/us/nsf/users","operationId":"updateBulkUsNsfApprover","name":"Allows bulk changes to be made to non-sufficient funds reviewer's profiles and approval limits.","summary":"Allows bulk changes to be made to non-sufficient funds reviewer profiles.","tags":["SYSTEM"],"parameters":[{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"reviewDesks":[{}],"groups":[{}],"userId":"string","userName":"string","email":"string","approvedAmount":"string","extensions":{}}},"responses":{"200":"BulkUsNsfApproverResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse","default":"ScreenErrorResponse"}},{"method":"DELETE","path":"/system/us/nsf/users","fullPath":"/api/v2.0.0/system/us/nsf/users","operationId":"deleteBulkUsNsfApprover","name":"Allows removal of non-sufficient funds reviewer profiles in bulk.","summary":"Allows removal of non-sufficient funds reviewer profiles in bulk.","tags":["SYSTEM"],"parameters":[{"name":"payload","in":"body","type":"object","required":false,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"userId":"string","extensions":{}}},"responses":{"200":"BulkUsNsfApproverResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse","default":"ScreenErrorResponse"}}]},{"key":"system-userProfiles-v1.0.0","title":"User profiles","version":"v1.0.0","description":"API to create,view and modify details associated with user login profiles. The information is used by the Security Management System (SMS) to control who has access to the system,  the login time periods and to what information and functions.","endpointCount":3,"endpoints":[{"method":"GET","path":"/system/users/{userId}","fullPath":"/api/v1.0.0/system/users/{userId}","operationId":"getUserDetails","name":"Retrieves the user profile details. The details include information such as the login user id, user name, classification, company or branch to which the user is associated, permitted activity and permitted time etc","summary":"Retrieve  user profile details","tags":[],"parameters":[{"name":"userId","in":"path","type":"string","required":true,"description":"The user name to be loaded for reporting jobs during Close of Business If no user name is entered in this field then the default profile for the user 'operator' is used."},{"name":"userSignOnName","in":"query","type":"string","required":false,"description":"This is the name entered by the User to sign on to the System. It is used by the System as an alternative key to access User details"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"UserDetailsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"POST","path":"/system/users/{userId}","fullPath":"/api/v1.0.0/system/users/{userId}","operationId":"createUser","name":"Creates the user profile in the system. The details include the login user id, user name, classification, company or branch to which the user is associated, permitted activity and permitted time etc.","summary":"Create user profile","tags":[],"parameters":[{"name":"userId","in":"path","type":"string","required":true,"description":"The user name to be loaded for reporting jobs during Close of Business If no user name is entered in this field then the default profile for the user 'operator' is used."},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"profileDate":[{}],"accessDetails":[{}],"userName":"string","userSignOnName":"string","language":"string","departmentId":"string","passwordResetFrequency":"string","extensionData":{}}},"responses":{"200":"UserResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/system/users/{userId}","fullPath":"/api/v1.0.0/system/users/{userId}","operationId":"amendUser","name":"Update the user profile. The details that can be modified include user name, classification, company or branch to which the user is associated, permitted activity and permitted time etc.","summary":"Amend user profile","tags":[],"parameters":[{"name":"userId","in":"path","type":"string","required":true,"description":"The user name to be loaded for reporting jobs during Close of Business If no user name is entered in this field then the default profile for the user 'operator' is used."},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"profileDate":[{}],"accessDetails":[{}],"userName":"string","userSignOnName":"string","language":"string","departmentId":"string","passwordResetFrequency":"string","extensionData":{}}},"responses":{"200":"UserResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}}]},{"key":"system-userProfiles-v1.1.0","title":"User profiles","version":"v1.1.0","description":"API to create,view and modify details associated with user login profiles. The information is used by the Security Management System (SMS) to control who has access to the system, the login time periods and to what information and functions.","endpointCount":3,"endpoints":[{"method":"GET","path":"/system/users/{userId}","fullPath":"/api/v1.1.0/system/users/{userId}","operationId":"getUserDetails","name":"Retrieves the user profile details. The details include information such as the login user id, user name, classification, company or branch to which the user is associated, permitted activity and permitted time etc.","summary":"Retrieve user profile details","tags":["SYSTEM"],"parameters":[{"name":"userId","in":"path","type":"string","required":true,"description":"The user name to be loaded for reporting jobs during Close of Business If no user name is entered in this field then the default profile for the user 'operator' is used."},{"name":"userSignOnName","in":"query","type":"string","required":false,"description":"This is the name entered by the User to sign on to the System. It is used by the System as an alternative key to access User details"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"UserDetailsResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}},{"method":"POST","path":"/system/users/{userId}","fullPath":"/api/v1.1.0/system/users/{userId}","operationId":"createUser","name":"Creates the user profile in the system. The details include the login user id, user name, classification, company or branch to which the user is associated, permitted activity and permitted time etc.","summary":"Create user profile","tags":["SYSTEM"],"parameters":[{"name":"userId","in":"path","type":"string","required":true,"description":"The user name to be loaded for reporting jobs during Close of Business If no user name is entered in this field then the default profile for the user 'operator' is used."},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"profileDate":[{}],"accessDetails":[{}],"definedCompanies":[{}],"userName":"string","userSignOnName":"string","language":"string","departmentId":"string","passwordResetFrequency":"string","extensions":{}}},"responses":{"200":"UserResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}},{"method":"PUT","path":"/system/users/{userId}","fullPath":"/api/v1.1.0/system/users/{userId}","operationId":"amendUser","name":"Update the user profile. The details that can be modified include user name, classification, company or branch to which the user is associated, permitted activity and permitted time etc.","summary":"Amend user profile","tags":["SYSTEM"],"parameters":[{"name":"userId","in":"path","type":"string","required":true,"description":"The user name to be loaded for reporting jobs during Close of Business If no user name is entered in this field then the default profile for the user 'operator' is used."},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"profileDate":[{}],"accessDetails":[{}],"definedCompanies":[{}],"userName":"string","userSignOnName":"string","language":"string","departmentId":"string","passwordResetFrequency":"string","extensions":{}}},"responses":{"200":"UserResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}}]}]},{"name":"Tc","serviceCount":1,"endpointCount":4,"services":[{"key":"tc-userAdmin-service-v1.0.0","title":"UserAdministration","version":"v1.0.0","description":"UserAdministration","endpointCount":4,"endpoints":[{"method":"GET","path":"/userAdministration/onlineServices/masterApprovals","fullPath":"/api/v1.0.0/v1.0.0/userAdministration/onlineServices/masterApprovals","operationId":"getOnlineServiceMasterApprovals","name":"","summary":"","tags":[],"parameters":[{"name":"customerId","in":"query","type":"string","required":false,"description":"The identifier of the customer"},{"name":"arrangementId","in":"query","type":"string","required":false,"description":"The identifier of the arrangement"},{"name":"masterOnly","in":"query","type":"string","required":false,"description":""},{"name":"roleOnly","in":"query","type":"string","required":false,"description":""},{"name":"masterArrangementId","in":"query","type":"string","required":false,"description":""},{"name":"productId","in":"query","type":"string","required":false,"description":"Id of the product."},{"name":"arrangementStatus","in":"query","type":"string","required":false,"description":"Status of the arrangement: UNAUTH - input but not authorised yet. AUTH - authorised. AUTH-FWD (Forward) - authorised, will become active on a future date. CURRENT - the arrangement has begun full or p"},{"name":"productGroupId","in":"query","type":"string","required":false,"description":"The group, as defined by the institution, that the product belongs to."},{"name":"subArrangementName","in":"query","type":"string","required":false,"description":""},{"name":"inputter","in":"query","type":"string","required":false,"description":"The user identifier who input the transaction"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from t24 on every enquiry request."},{"name":"credentials","in":"query","type":"string","required":false,"description":""},{"name":"companyId","in":"query","type":"string","required":false,"description":""}],"requestBodyExample":null,"responses":{"200":"OnlineServiceApprovalsResponse","default":"QueryErrorResponse"}},{"method":"GET","path":"/userAdministration/onlineServices/roleApprovals","fullPath":"/api/v1.0.0/v1.0.0/userAdministration/onlineServices/roleApprovals","operationId":"getOnlineServiceRoleApprovals","name":"","summary":"","tags":[],"parameters":[{"name":"customerId","in":"query","type":"string","required":false,"description":"The identifier of the customer"},{"name":"arrangementId","in":"query","type":"string","required":false,"description":"The identifier of the arrangement"},{"name":"masterOnly","in":"query","type":"string","required":false,"description":""},{"name":"roleOnly","in":"query","type":"string","required":false,"description":""},{"name":"masterArrangementId","in":"query","type":"string","required":false,"description":""},{"name":"productId","in":"query","type":"string","required":false,"description":"Id of the product."},{"name":"arrangementStatus","in":"query","type":"string","required":false,"description":"Status of the arrangement: UNAUTH - input but not authorised yet. AUTH - authorised. AUTH-FWD (Forward) - authorised, will become active on a future date. CURRENT - the arrangement has begun full or p"},{"name":"productGroupId","in":"query","type":"string","required":false,"description":"The group, as defined by the institution, that the product belongs to."},{"name":"subArrangementName","in":"query","type":"string","required":false,"description":""},{"name":"inputter","in":"query","type":"string","required":false,"description":"The user identifier who input the transaction"},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from t24 on every enquiry request."},{"name":"credentials","in":"query","type":"string","required":false,"description":""},{"name":"companyId","in":"query","type":"string","required":false,"description":""}],"requestBodyExample":null,"responses":{"200":"OnlineServiceApprovalsResponse","default":"QueryErrorResponse"}},{"method":"GET","path":"/userAdministration/onlineServices/masters","fullPath":"/api/v1.0.0/v1.0.0/userAdministration/onlineServices/masters","operationId":"getOnlineServiceMasters","name":"","summary":"","tags":[],"parameters":[{"name":"arrangementId","in":"query","type":"string","required":false,"description":"The identifier of the arrangement"},{"name":"arrangementStatus","in":"query","type":"string","required":false,"description":"Status of the arrangement: UNAUTH - input but not authorised yet. AUTH - authorised. AUTH-FWD (Forward) - authorised, will become active on a future date. CURRENT - the arrangement has begun full or p"},{"name":"masterOnly","in":"query","type":"string","required":false,"description":""},{"name":"roleOnly","in":"query","type":"string","required":false,"description":""},{"name":"masterArrangementId","in":"query","type":"string","required":false,"description":""},{"name":"productGroupId","in":"query","type":"string","required":false,"description":"The group, as defined by the institution, that the product belongs to."},{"name":"productId","in":"query","type":"string","required":false,"description":"Id of the product."},{"name":"customerId","in":"query","type":"string","required":false,"description":"The identifier of the customer"},{"name":"subArrangementName","in":"query","type":"string","required":false,"description":""},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from t24 on every enquiry request."},{"name":"credentials","in":"query","type":"string","required":false,"description":""},{"name":"companyId","in":"query","type":"string","required":false,"description":""}],"requestBodyExample":null,"responses":{"200":"OnlineServicesResponse","default":"QueryErrorResponse"}},{"method":"GET","path":"/userAdministration/onlineServices/roles","fullPath":"/api/v1.0.0/v1.0.0/userAdministration/onlineServices/roles","operationId":"getOnlineServiceRoles","name":"","summary":"","tags":[],"parameters":[{"name":"arrangementId","in":"query","type":"string","required":false,"description":"The identifier of the arrangement"},{"name":"arrangementStatus","in":"query","type":"string","required":false,"description":"Status of the arrangement: UNAUTH - input but not authorised yet. AUTH - authorised. AUTH-FWD (Forward) - authorised, will become active on a future date. CURRENT - the arrangement has begun full or p"},{"name":"masterOnly","in":"query","type":"string","required":false,"description":""},{"name":"roleOnly","in":"query","type":"string","required":false,"description":""},{"name":"masterArrangementId","in":"query","type":"string","required":false,"description":""},{"name":"productGroupId","in":"query","type":"string","required":false,"description":"The group, as defined by the institution, that the product belongs to."},{"name":"productId","in":"query","type":"string","required":false,"description":"Id of the product."},{"name":"customerId","in":"query","type":"string","required":false,"description":"The identifier of the customer"},{"name":"subArrangementName","in":"query","type":"string","required":false,"description":""},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from t24 on every enquiry request."},{"name":"credentials","in":"query","type":"string","required":false,"description":""},{"name":"companyId","in":"query","type":"string","required":false,"description":""}],"requestBodyExample":null,"responses":{"200":"OnlineServicesResponse","default":"QueryErrorResponse"}}]}]},{"name":"Tdl","serviceCount":1,"endpointCount":1,"services":[{"key":"tdl-getMasterCompany-api-v1.0.0","title":"Master companies","version":"v1.0.0","description":"Retrieves the master company information that is used by the organization.(Deprecated- A newer version V1.1.0 available)","endpointCount":1,"endpoints":[{"method":"GET","path":"/reference/master/company","fullPath":"/api/v1.0.0/reference/master/company","operationId":"getMasterCompany","name":"Retrieves the master company information that is used by the organization","summary":"Retrieves the master company","tags":[],"parameters":[{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"MasterCompanyResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}}]}]},{"name":"Update","serviceCount":1,"endpointCount":1,"services":[{"key":"update-MessageStatus-v1.0.0","title":"Update Message Status","version":"v1.0.0","description":"Update Message Status","endpointCount":1,"endpoints":[{"method":"PUT","path":"/order/messageStatus/{headerId}/inward","fullPath":"/api/v1.0.0/order/messageStatus/{headerId}/inward","operationId":"updateMessageStatus","name":"use URI \"/holdings/messages/inwards/{headerId}/status\"","summary":"Update Message Status","tags":[],"parameters":[{"name":"headerId","in":"path","type":"string","required":true,"description":"Identifier of the inward header"},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"transactionReferenceGroup":[{}],"messageDisposition":"string","errorMessage":"string"}},"responses":{"200":"MessageStatusResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}}]}]},{"name":"Updateppsotransactionapi","serviceCount":1,"endpointCount":1,"services":[{"key":"updatePpSoTransactionApi-v1.0.0","title":"PP SO TRANSACTION api","version":"v1.0.0","description":"Update PP.SO.TRANSACTION api","endpointCount":1,"endpoints":[{"method":"PUT","path":"/order/ppsotransaction/{paymentId}/transaction/update","fullPath":"/api/v1.0.0/order/ppsotransaction/{paymentId}/transaction/update","operationId":"updatePPSoTransaction","name":"Update PP.SO.TRANSACTION api - This API is deprecated and moved to the following URL : /payments/swiftPayments/{swiftPaymentId}/acknowledgements","summary":"Update PP.SO.TRANSACTION api","tags":[],"parameters":[{"name":"paymentId","in":"path","type":"string","required":true,"description":""},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"override":{"overrideDetails":{}},"audit":{"versionNumber":{}}},"body":{"company":"string","paymentReference":"string","paymentStatus":"string","pymtStatus":"string","statusChangeReason":"string","override":"string"}},"responses":{"200":"PPSoTransactionResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}}]}]},{"name":"MSDOHBContainer","serviceCount":8,"endpointCount":11,"services":[{"key":"MSDOHBContainer__API-v1.0.0","title":"Payment Salary","version":"v1.0.0","description":"Payment Salary","endpointCount":1,"endpoints":[{"method":"POST","path":"/party/payments/salary/post","fullPath":"/api/v1.0.0/party/payments/salary/post","operationId":"postSalaryPayment","name":"postSalaryPayment","summary":"postSalaryPayment","tags":["OTHERS"],"parameters":[{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"debitAccountId":"string","debitCurrency":"string","debitAmount":"string","debitValueDate":"string","debitReference":"string","employeeName":"string","employeeCode":"string","orderingCustomerId":"string","creditAccountId":"string","creditCurrency":"Defines the Currency of the Account being Credited","creditAmount":"Defines the Transfer amount.","creditValueDate":"Date when the Credit entry is to be given value","creditReference":"Specifies info to be printed on the credit advice","Override":"string","recordStatus":"string"}},"responses":{"200":"SalaryPaymentResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}}]},{"key":"MSDOHBContainer__getTransactBranchCodeAPI-v1.0.0","title":"getTransactBranchCode","version":"v1.0.0","description":"getTransactBranchCode","endpointCount":1,"endpoints":[{"method":"GET","path":"/party/comp","fullPath":"/api/v1.0.0/party/comp","operationId":"getTransactBranchCode","name":"getTransactBranchCode","summary":"getTransactBranchCode","tags":["OTHERS"],"parameters":[{"name":"MSDBranchCode","in":"query","type":"string","required":false,"description":""},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"TransactBranchCodeResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}}]},{"key":"MSDOHBContainer__meta-apis-service-v1.0.0","title":"Meta - APIs about APIs","version":"v1.0.0","description":"Retrieves information about the API ecosystem, both reference information and runtime metrics","endpointCount":4,"endpoints":[{"method":"GET","path":"/meta/apidocs","fullPath":"/api/v1.0.0/meta/apidocs","operationId":"getApiDocs","name":"","summary":"","tags":[],"parameters":[],"requestBodyExample":null,"responses":{"200":"getApiDocsResponse","default":"getApiDocsErrorResponse"}},{"method":"GET","path":"/meta/apis","fullPath":"/api/v1.0.0/meta/apis","operationId":"getApis","name":"","summary":"","tags":[],"parameters":[],"requestBodyExample":null,"responses":{"200":"getApisResponse","default":"getApisResponse"}},{"method":"GET","path":"/meta/internal/apis","fullPath":"/api/v1.0.0/meta/internal/apis","operationId":"getInternalApis","name":"","summary":"","tags":[],"parameters":[],"requestBodyExample":null,"responses":{"200":"getInternalApisResponse","default":"getInternalApisResponse"}},{"method":"GET","path":"/meta/apis/operationIds","fullPath":"/api/v1.0.0/meta/apis/operationIds","operationId":"getApis","name":"","summary":"","tags":[],"parameters":[],"requestBodyExample":null,"responses":{"200":"getApisResponse","default":"getApisResponse"}}]},{"key":"MSDOHBContainer__meta-statistics-v1.0.0","title":"Statistics Provider APIs","version":"v1.0.0","description":"","endpointCount":1,"endpoints":[{"method":"GET","path":"/meta/statistics","fullPath":"/v1.0.0/meta/statistics","operationId":"getUsageStatistics","name":"","summary":"","tags":[],"parameters":[{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Random and unique string for each page. Used for security purpose"},{"name":"apiId","in":"query","type":"string","required":false,"description":"Domain Id of the resource record"},{"name":"operationId","in":"query","type":"string","required":false,"description":"IRIS Service Id"},{"name":"fromDate","in":"query","type":"string","required":false,"description":"Start Date"},{"name":"toDate","in":"query","type":"string","required":false,"description":"End Date"}],"requestBodyExample":null,"responses":{"200":"getUsageStatisticsResponse","default":"getUsageStatisticsErrorResponse"}}]},{"key":"MSDOHBContainer__order-clearing-service-v1.0.0","title":"Clearing Orders","version":"v1.0.0","description":"API to manage clearing order requests. Clearing order requests are created as part of cheque exchanges between banks and central clearing houses. The process begins when a drawee deposits a cheque for clearing in the drawer bank, the banks will pass it on to the clearing house which verifies the che","endpointCount":1,"endpoints":[{"method":"POST","path":"/order/clearingEntries","fullPath":"/api/v1.0.0/order/clearingEntries","operationId":"createORValidateFR","name":"Creates or validates clearing order request of type COVER or RESERVE or BOOK with details such as payee or drawee account number, currency, amount, clearing type - debit or credit, date of clearing and other payment references. COVER requests can be initiated to verify the validity of account and availability of funds in case of debit clearing. RESERVE requests can be initiated to hold the funds in the payee account before the cheques are cleared for collections. BOOK requests can be initiated t","summary":"","tags":[],"parameters":[{"name":"companyId","in":"header","type":"string","required":false,"description":"The identifier of the underlying entity/company/branch."},{"name":"channelName","in":"header","type":"string","required":false,"description":"Name of the (digital) channel registered by the Customer used for the clearing request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"payload","in":"body","type":"object","required":true,"description":"Contains the fields and its values to be input for the clearing request in the specific order"}],"requestBodyExample":{"header":{},"body":{"operation":"string","target":"string","payload":"string"}},"responses":{"200":"createORValidateFRResponse"}}]},{"key":"MSDOHBContainer__postCOBMSDPaymentAPI-v1.0.0","title":"postCOBMSDPayment","version":"v1.0.0","description":"postCOBMSDPayment","endpointCount":1,"endpoints":[{"method":"POST","path":"/party/payments/cob/posting","fullPath":"/api/v1.0.0/party/payments/cob/posting","operationId":"postCOBMSDPayment","name":"postCOBMSDPayment","summary":"postCOBMSDPayment","tags":["OTHERS"],"parameters":[{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"debitAccountId":"A/c being debited in respect of the transfer","debitCurrency":"Defines the Currency of the Account being debited.","debitAmount":"Defines the Transfer amount.","debitValueDate":"Date when the Debit entry is to be given value","debitReference":"Specifies info to be printed on the debit advice.","chequeTypeId":"string","chequeNumber":"string","orderingCustomerId":"Customer who is ordering the transaction","creditAccountId":"A/c being credited in respect of the transfer","creditCurrency":"Defines the Currency of the Account being Credited","creditAmount":"Defines the Transfer amount.","creditValueDate":"Date when the Credit entry is to be given value","creditReference":"Specifies info to be printed on the credit advice","Narration1":"string","Narration2":"string"}},"responses":{"200":"COBMSDPaymentResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}}]},{"key":"MSDOHBContainer__postMOEMSDPaymentAPI-v1.0.0","title":"postMOEMSDPayment","version":"v1.0.0","description":"postMOEMSDPayment","endpointCount":1,"endpoints":[{"method":"POST","path":"/party/payments/moe/posting","fullPath":"/api/v1.0.0/party/payments/moe/posting","operationId":"postMOEMSDPayment","name":"postMOEMSDPayment","summary":"postMOEMSDPayment","tags":["OTHERS"],"parameters":[{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"DebitAccount":"string","DebitCurrency":"string","DebitAmount":"string","DebValueDate":"string","DebitTheirRef":"string","Orderedby":"string","TotalDebitAmount":"string","CreditAccount":"string","CreditCurrency":"string","CreditAmount":"string","CredValueDate":"string","CredTheirRef":"string","TotalCreditAmnt":"string","TreasuryRate":"string","AccountingDate":"string"}},"responses":{"200":"MOEMSDPaymentResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}}]},{"key":"MSDOHBContainer__postVendorSwiftPaymentAPI-v1.0.0","title":"postVendorSwiftPayment","version":"v1.0.0","description":"postVendorSwiftPayment","endpointCount":1,"endpoints":[{"method":"POST","path":"/party/paymentorder/post","fullPath":"/api/v1.0.0/party/paymentorder/post","operationId":"postVendorSwiftPayment","name":"postVendorSwiftPayment","summary":"postVendorSwiftPayment","tags":["OTHERS"],"parameters":[{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"orderingCompany":"string","accountType":"string","debitAccountId":"string","debitCurrency":"string","debitAccountIBAN":"string","debitValueDate":"string","paymentCurrency":"string","paymentAmount":"string","orderingPaymentFxCustomerRate":"string","requestedAmount":"string","requestedCurrency":"string","creditAccountId":"string","creditAmount":"string","totalDebitAmount":"string","paymentExecutionDate":"string"}},"responses":{"200":"VendorSwiftPaymentResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}}]}]},{"name":"CardIssuanceOHBContainer","serviceCount":12,"endpointCount":17,"services":[{"key":"CardIssuanceOHBContainer__api-v1.0.0","title":"getFTReversalNum","version":"v1.0.0","description":"getFTReversalNum","endpointCount":1,"endpoints":[{"method":"GET","path":"/holdings/fT/card/txnReversal/","fullPath":"/api/v1.0.0/holdings/fT/card/txnReversal/","operationId":"getFTReversalNum","name":"getFTReversalNum","summary":"getFTReversalNum","tags":["OTHERS"],"parameters":[{"name":"RRN","in":"query","type":"string","required":true,"description":""},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"FTReversalNumResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}}]},{"key":"CardIssuanceOHBContainer__createCardDetailsAPI-v1.0.0","title":"createCardDetails","version":"v1.0.0","description":"createCardDetails","endpointCount":1,"endpoints":[{"method":"POST","path":"/party/cardissue/cardDetails/{id}","fullPath":"/api/v1.0.0/party/cardissue/cardDetails/{id}","operationId":"createCardDetails","name":"createCardDetails","summary":"createCardDetails","tags":["OTHERS"],"parameters":[{"name":"id","in":"path","type":"string","required":true,"description":"Contains the daily position class id."},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"cardStatus":"Denotes card status for the record","Account":"A/c to which the cheques are being issued.","Ccy":"string","issueDate":"Defines the date of issue of cards","expiryDate":"string","Name":"Specifies Name that needs to be printed on card","cancellationDate":"string","cancellationReason":"string","Charges":"Defines the charges due for the issued of cheques.","chargeDate":"Value date for online charges raised by the issue","Customer":"Customer ID","altCardNumber":"Alternate Card Number","maskedCardNumber":"Masked Card Number for Cust.","cardType":"Type of Card","customerType":"string"}},"responses":{"200":"CardDetailsResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}}]},{"key":"CardIssuanceOHBContainer__getAccountCustomerIDAPI-v1.0.0","title":"getAccountCustomerID","version":"v1.0.0","description":"getAccountCustomerID","endpointCount":1,"endpoints":[{"method":"GET","path":"/party/accountlist/{id}","fullPath":"/api/v1.0.0/party/accountlist/{id}","operationId":"getAccountCustomerID","name":"getAccountCustomerID","summary":"getAccountCustomerID","tags":["OTHERS"],"parameters":[{"name":"id","in":"path","type":"string","required":true,"description":"Contains the daily position class id."},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"AccountCustomerIDResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}}]},{"key":"CardIssuanceOHBContainer__getCustAccountBalanceAPI-v1.0.0","title":"getCustAccountBalance","version":"v1.0.0","description":"getCustAccountBalance","endpointCount":1,"endpoints":[{"method":"GET","path":"/party/accountbalance/{id}","fullPath":"/api/v1.0.0/party/accountbalance/{id}","operationId":"getCustAccountBalance","name":"getCustAccountBalance","summary":"getCustAccountBalance","tags":["OTHERS"],"parameters":[{"name":"id","in":"path","type":"string","required":true,"description":"Contains the daily position class id."},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"CustAccountBalanceResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}}]},{"key":"CardIssuanceOHBContainer__getCustAcctStatementAPI-v1.0.0","title":"getCustAcctStatement","version":"v1.0.0","description":"getCustAcctStatement","endpointCount":1,"endpoints":[{"method":"GET","path":"/party/stmt/","fullPath":"/api/v1.0.0/party/stmt/","operationId":"getCustAcctStatement","name":"getCustAcctStatement","summary":"getCustAcctStatement","tags":["OTHERS"],"parameters":[{"name":"accountId","in":"query","type":"string","required":false,"description":"Identifier of the account. Often referred to as the account number, yet for consistency this is always referred to as accountId. Accepts both IBAN & BBAN"},{"name":"fromDate","in":"query","type":"string","required":false,"description":"Indicates the business date from when the balance reservation event is active."},{"name":"toDate","in":"query","type":"string","required":false,"description":"Indicates the business date until when the balance reservation event is active."},{"name":"transactionReference","in":"query","type":"string","required":false,"description":"Contains the identifier for the transaction in the core system"},{"name":"period","in":"query","type":"string","required":false,"description":"Indicates spread of time buckets.Ex: 3M,6M,9M,10Y etc."},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"CustAcctStatementResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}}]},{"key":"CardIssuanceOHBContainer__getCustomerInfoAPI-v1.0.0","title":"getCustomerInfo","version":"v1.0.0","description":"getCustomerInfo","endpointCount":1,"endpoints":[{"method":"GET","path":"/party/customerDetails/{id}","fullPath":"/api/v1.0.0/party/customerDetails/{id}","operationId":"getCustomerInfo","name":"getCustomerInfo","summary":"getCustomerInfo","tags":["OTHERS"],"parameters":[{"name":"id","in":"path","type":"string","required":true,"description":"Contains the daily position class id."},{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Unique id expected to get as part of response from Transact on every enquiry request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"},{"name":"disablePagination","in":"header","type":"boolean","required":false,"description":"Indicates the pagination header attributes availability. If set to 'true', it fetches all the data"}],"requestBodyExample":null,"responses":{"200":"CustomerInfoResponse","default":"QueryErrorResponse","400":"BusinessQueryErrorResponse","500":"SystemQueryErrorResponse"}}]},{"key":"CardIssuanceOHBContainer__meta-apis-service-v1.0.0","title":"Meta - APIs about APIs","version":"v1.0.0","description":"Retrieves information about the API ecosystem, both reference information and runtime metrics","endpointCount":4,"endpoints":[{"method":"GET","path":"/meta/apidocs","fullPath":"/api/v1.0.0/meta/apidocs","operationId":"getApiDocs","name":"","summary":"","tags":[],"parameters":[],"requestBodyExample":null,"responses":{"200":"getApiDocsResponse","default":"getApiDocsErrorResponse"}},{"method":"GET","path":"/meta/apis","fullPath":"/api/v1.0.0/meta/apis","operationId":"getApis","name":"","summary":"","tags":[],"parameters":[],"requestBodyExample":null,"responses":{"200":"getApisResponse","default":"getApisResponse"}},{"method":"GET","path":"/meta/internal/apis","fullPath":"/api/v1.0.0/meta/internal/apis","operationId":"getInternalApis","name":"","summary":"","tags":[],"parameters":[],"requestBodyExample":null,"responses":{"200":"getInternalApisResponse","default":"getInternalApisResponse"}},{"method":"GET","path":"/meta/apis/operationIds","fullPath":"/api/v1.0.0/meta/apis/operationIds","operationId":"getApis","name":"","summary":"","tags":[],"parameters":[],"requestBodyExample":null,"responses":{"200":"getApisResponse","default":"getApisResponse"}}]},{"key":"CardIssuanceOHBContainer__meta-statistics-v1.0.0","title":"Statistics Provider APIs","version":"v1.0.0","description":"","endpointCount":1,"endpoints":[{"method":"GET","path":"/meta/statistics","fullPath":"/v1.0.0/meta/statistics","operationId":"getUsageStatistics","name":"","summary":"","tags":[],"parameters":[{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Random and unique string for each page. Used for security purpose"},{"name":"apiId","in":"query","type":"string","required":false,"description":"Domain Id of the resource record"},{"name":"operationId","in":"query","type":"string","required":false,"description":"IRIS Service Id"},{"name":"fromDate","in":"query","type":"string","required":false,"description":"Start Date"},{"name":"toDate","in":"query","type":"string","required":false,"description":"End Date"}],"requestBodyExample":null,"responses":{"200":"getUsageStatisticsResponse","default":"getUsageStatisticsErrorResponse"}}]},{"key":"CardIssuanceOHBContainer__order-clearing-service-v1.0.0","title":"Clearing Orders","version":"v1.0.0","description":"API to manage clearing order requests. Clearing order requests are created as part of cheque exchanges between banks and central clearing houses. The process begins when a drawee deposits a cheque for clearing in the drawer bank, the banks will pass it on to the clearing house which verifies the che","endpointCount":1,"endpoints":[{"method":"POST","path":"/order/clearingEntries","fullPath":"/api/v1.0.0/order/clearingEntries","operationId":"createORValidateFR","name":"Creates or validates clearing order request of type COVER or RESERVE or BOOK with details such as payee or drawee account number, currency, amount, clearing type - debit or credit, date of clearing and other payment references. COVER requests can be initiated to verify the validity of account and availability of funds in case of debit clearing. RESERVE requests can be initiated to hold the funds in the payee account before the cheques are cleared for collections. BOOK requests can be initiated t","summary":"","tags":[],"parameters":[{"name":"companyId","in":"header","type":"string","required":false,"description":"The identifier of the underlying entity/company/branch."},{"name":"channelName","in":"header","type":"string","required":false,"description":"Name of the (digital) channel registered by the Customer used for the clearing request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"payload","in":"body","type":"object","required":true,"description":"Contains the fields and its values to be input for the clearing request in the specific order"}],"requestBodyExample":{"header":{},"body":{"operation":"string","target":"string","payload":"string"}},"responses":{"200":"createORValidateFRResponse"}}]},{"key":"CardIssuanceOHBContainer__published-fundTransfer-v1.0.0","title":"Funds Transfer Published APIs","version":"v1.0.0","description":"These APIs are used to create and get FundsTransfer records.","endpointCount":3,"endpoints":[{"method":"GET","path":"/published/payments/{accountid}/statusreport","fullPath":"/api/v1.0.0/published/payments/{accountid}/statusreport","operationId":"PublishedPaymentStatusReport","name":"Used to get the Funds Transfer records list of a particular account.","summary":"","tags":[],"parameters":[{"name":"accountid","in":"path","type":"string","required":true,"description":"The field holds the reference of the underlying ACCOUNT application. This should just be the same as trying a new input on ACCOUNT application."},{"name":"startDate","in":"query","type":"string","required":false,"description":"The start date from which records in response should be displayed."},{"name":"endDate","in":"query","type":"string","required":false,"description":"The end date upto which records in response should be displayed."},{"name":"noOfOrders","in":"query","type":"string","required":false,"description":"The total number of records per page"},{"name":"listType","in":"query","type":"string","required":false,"description":"Indicates the summary or detail of account. S-Summary, D-Detail."}],"requestBodyExample":null,"responses":{"200":"PublishedPaymentStatusReport","404":"PublishedPaymentStatusReportError"}},{"method":"POST","path":"/published/payments/transfer/initiation","fullPath":"/api/v1.0.0/published/payments/transfer/initiation","operationId":"PublishedPaymentTransferInitiation","name":"Used to create an unauthorized Funds Transfer record.To authorize, please use updatePaymentTransfer API","summary":"","tags":[],"parameters":[{"name":"payload","in":"body","type":"object","required":true,"description":"payload to create payment"},{"name":"function","in":"query","type":"string","required":false,"description":"validate the payment"}],"requestBodyExample":{"body":{"published_benAddressLine":[{}],"published_chargeBearer":"string","published_debitAccount":"string","published_creditorAgentNationalCode":"string","published_acctWithBk":[{}],"published_creditReference":"string","published_beneficiaryIBAN":"string","published_executionDate":"string","published_debitReference":"string","published_paymentAmount":"string","published_benTown":[{}],"published_inwardPayType":"string","published_beneficiaryCountry":"string","published_remittanceInformation":[{}],"published_beneficiaryAccount":"string"}},"responses":{"200":"PublishedPaymentTransferInitiation Response","400":"PublishedPaymentTransferInitiation error response"}},{"method":"POST","path":"/published/payments/transfer/{id}/submission","fullPath":"/api/v1.0.0/published/payments/transfer/{id}/submission","operationId":"PublishedPaymentTransferSubmission","name":"Used to authorize a Funds Transfer record.","summary":"","tags":[],"parameters":[{"name":"id","in":"path","type":"string","required":true,"description":"Identifies uniquely each Funds Transfer transaction. 12 character standard id. Explanation of Reference Number format: FTYYDDDNNNNN where FT-Application indicator - FT for the Funds Transfer Applicati"}],"requestBodyExample":null,"responses":{"200":"PublishedPaymentTransferSubmission Response","400":"PublishedPaymentTransferSubmission 400 error response","404":"PublishedPaymentTransferSubmission 404 error response"}}]},{"key":"CardIssuanceOHBContainer__updateCardDetailsAPI-v1.0.0","title":"updateCardDetails","version":"v1.0.0","description":"updateCardDetails","endpointCount":1,"endpoints":[{"method":"PUT","path":"/party/cardissue/update/{id}","fullPath":"/api/v1.0.0/party/cardissue/update/{id}","operationId":"updateCardDetails","name":"updateCardDetails","summary":"updateCardDetails","tags":["OTHERS"],"parameters":[{"name":"id","in":"path","type":"string","required":true,"description":"Contains the daily position class id."},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"SupplementCards":[{}],"cardStatus":"Denotes card status for the record","Account":"A/c to which the cheques are being issued.","Ccy":"string","issueDate":"Defines the date of issue of cards","expiryDate":"string","Name":"Specifies Name that needs to be printed on card","cancellationDate":"string","cancellationReason":"string","Charges":"Defines the charges due for the issued of cheques.","chargeDate":"Value date for online charges raised by the issue","Customer":"Customer ID","altCardNumber":"Alternate Card Number","maskedCardNumber":"Masked Card Number for Cust.","cardType":"Type of Card"}},"responses":{"200":"CardDetailsResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}}]},{"key":"CardIssuanceOHBContainer__updateCustomerDetailsAPI-v1.0.0","title":"updateCustomerDetails","version":"v1.0.0","description":"updateCustomerDetails","endpointCount":1,"endpoints":[{"method":"PUT","path":"/party/customers/updateInfo/{id}","fullPath":"/api/v1.0.0/party/customers/updateInfo/{id}","operationId":"updateCustomerDetails","name":"updateCustomerDetails","summary":"updateCustomerDetails","tags":["OTHERS"],"parameters":[{"name":"id","in":"path","type":"string","required":true,"description":"Contains the daily position class id."},{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"Area":[{}],"City":"string","Wilayat":"string","Country":[{}],"Village":"string","Street":[{}],"Way":[{}],"Residential":[{}],"Previous":[{}],"CHANGE.DATE":[{}],"CHANGE.REASON":[{}],"CUSTOMER.SINCE":[{}],"DOMICILE":[{}],"OTHER.NATIONALITY":[{}],"FURTHER.DETAILS":[{}]}},"responses":{"200":"CustomerDetailsResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}}]}]},{"name":"postSalaryPayment","serviceCount":4,"endpointCount":7,"services":[{"key":"postSalaryPayment__API-v1.0.0","title":"Payment Salary","version":"v1.0.0","description":"Payment Salary","endpointCount":1,"endpoints":[{"method":"POST","path":"/party/payments/salary/post","fullPath":"/api/v1.0.0/party/payments/salary/post","operationId":"postSalaryPayment","name":"postSalaryPayment","summary":"postSalaryPayment","tags":["OTHERS"],"parameters":[{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"debitAccountId":"string","debitCurrency":"string","debitAmount":"string","debitValueDate":"string","debitReference":"string","employeeName":"string","employeeCode":"string","orderingCustomerId":"string","creditAccountId":"string","creditCurrency":"Defines the Currency of the Account being Credited","creditAmount":"Defines the Transfer amount.","creditValueDate":"Date when the Credit entry is to be given value","creditReference":"Specifies info to be printed on the credit advice","Override":"string","recordStatus":"string"}},"responses":{"200":"SalaryPaymentResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}}]},{"key":"postSalaryPayment__meta-apis-service-v1.0.0","title":"Meta - APIs about APIs","version":"v1.0.0","description":"Retrieves information about the API ecosystem, both reference information and runtime metrics","endpointCount":4,"endpoints":[{"method":"GET","path":"/meta/apidocs","fullPath":"/api/v1.0.0/meta/apidocs","operationId":"getApiDocs","name":"","summary":"","tags":[],"parameters":[],"requestBodyExample":null,"responses":{"200":"getApiDocsResponse","default":"getApiDocsErrorResponse"}},{"method":"GET","path":"/meta/apis","fullPath":"/api/v1.0.0/meta/apis","operationId":"getApis","name":"","summary":"","tags":[],"parameters":[],"requestBodyExample":null,"responses":{"200":"getApisResponse","default":"getApisResponse"}},{"method":"GET","path":"/meta/internal/apis","fullPath":"/api/v1.0.0/meta/internal/apis","operationId":"getInternalApis","name":"","summary":"","tags":[],"parameters":[],"requestBodyExample":null,"responses":{"200":"getInternalApisResponse","default":"getInternalApisResponse"}},{"method":"GET","path":"/meta/apis/operationIds","fullPath":"/api/v1.0.0/meta/apis/operationIds","operationId":"getApis","name":"","summary":"","tags":[],"parameters":[],"requestBodyExample":null,"responses":{"200":"getApisResponse","default":"getApisResponse"}}]},{"key":"postSalaryPayment__meta-statistics-v1.0.0","title":"Statistics Provider APIs","version":"v1.0.0","description":"","endpointCount":1,"endpoints":[{"method":"GET","path":"/meta/statistics","fullPath":"/v1.0.0/meta/statistics","operationId":"getUsageStatistics","name":"","summary":"","tags":[],"parameters":[{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Random and unique string for each page. Used for security purpose"},{"name":"apiId","in":"query","type":"string","required":false,"description":"Domain Id of the resource record"},{"name":"operationId","in":"query","type":"string","required":false,"description":"IRIS Service Id"},{"name":"fromDate","in":"query","type":"string","required":false,"description":"Start Date"},{"name":"toDate","in":"query","type":"string","required":false,"description":"End Date"}],"requestBodyExample":null,"responses":{"200":"getUsageStatisticsResponse","default":"getUsageStatisticsErrorResponse"}}]},{"key":"postSalaryPayment__order-clearing-service-v1.0.0","title":"Clearing Orders","version":"v1.0.0","description":"API to manage clearing order requests. Clearing order requests are created as part of cheque exchanges between banks and central clearing houses. The process begins when a drawee deposits a cheque for clearing in the drawer bank, the banks will pass it on to the clearing house which verifies the che","endpointCount":1,"endpoints":[{"method":"POST","path":"/order/clearingEntries","fullPath":"/api/v1.0.0/order/clearingEntries","operationId":"createORValidateFR","name":"Creates or validates clearing order request of type COVER or RESERVE or BOOK with details such as payee or drawee account number, currency, amount, clearing type - debit or credit, date of clearing and other payment references. COVER requests can be initiated to verify the validity of account and availability of funds in case of debit clearing. RESERVE requests can be initiated to hold the funds in the payee account before the cheques are cleared for collections. BOOK requests can be initiated t","summary":"","tags":[],"parameters":[{"name":"companyId","in":"header","type":"string","required":false,"description":"The identifier of the underlying entity/company/branch."},{"name":"channelName","in":"header","type":"string","required":false,"description":"Name of the (digital) channel registered by the Customer used for the clearing request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"payload","in":"body","type":"object","required":true,"description":"Contains the fields and its values to be input for the clearing request in the specific order"}],"requestBodyExample":{"header":{},"body":{"operation":"string","target":"string","payload":"string"}},"responses":{"200":"createORValidateFRResponse"}}]}]},{"name":"postVendorACHPayment","serviceCount":4,"endpointCount":7,"services":[{"key":"postVendorACHPayment__API-v1.0.0","title":"Vendor Payment ACH","version":"v1.0.0","description":"Vendor Payment ACH","endpointCount":1,"endpoints":[{"method":"POST","path":"/party/paymentorder/vendorACH/post","fullPath":"/api/v1.0.0/party/paymentorder/vendorACH/post","operationId":"postVendorACHPayment","name":"postVendorACHPayment","summary":"postVendorACHPayment","tags":["OTHERS"],"parameters":[{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"paymentOrderProduct":"string","beneficiaryId":"string","debitAccountId":"string","beneficiaryAccountNumber":"string","debitCurrency":"string","beneficiaryBIC":"string","debitAccountIBAN":"string","beneficiaryIBAN":"string","debitValueDate":"string","beneficiaryName":"string","paymentCurrency":"string","beneficiaryCountryCode":"string","paymentAmount":"string","accountWithBankBIC":"string","creditCurrency":"string"}},"responses":{"200":"VendorACHPaymentResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}}]},{"key":"postVendorACHPayment__meta-apis-service-v1.0.0","title":"Meta - APIs about APIs","version":"v1.0.0","description":"Retrieves information about the API ecosystem, both reference information and runtime metrics","endpointCount":4,"endpoints":[{"method":"GET","path":"/meta/apidocs","fullPath":"/api/v1.0.0/meta/apidocs","operationId":"getApiDocs","name":"","summary":"","tags":[],"parameters":[],"requestBodyExample":null,"responses":{"200":"getApiDocsResponse","default":"getApiDocsErrorResponse"}},{"method":"GET","path":"/meta/apis","fullPath":"/api/v1.0.0/meta/apis","operationId":"getApis","name":"","summary":"","tags":[],"parameters":[],"requestBodyExample":null,"responses":{"200":"getApisResponse","default":"getApisResponse"}},{"method":"GET","path":"/meta/internal/apis","fullPath":"/api/v1.0.0/meta/internal/apis","operationId":"getInternalApis","name":"","summary":"","tags":[],"parameters":[],"requestBodyExample":null,"responses":{"200":"getInternalApisResponse","default":"getInternalApisResponse"}},{"method":"GET","path":"/meta/apis/operationIds","fullPath":"/api/v1.0.0/meta/apis/operationIds","operationId":"getApis","name":"","summary":"","tags":[],"parameters":[],"requestBodyExample":null,"responses":{"200":"getApisResponse","default":"getApisResponse"}}]},{"key":"postVendorACHPayment__meta-statistics-v1.0.0","title":"Statistics Provider APIs","version":"v1.0.0","description":"","endpointCount":1,"endpoints":[{"method":"GET","path":"/meta/statistics","fullPath":"/v1.0.0/meta/statistics","operationId":"getUsageStatistics","name":"","summary":"","tags":[],"parameters":[{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Random and unique string for each page. Used for security purpose"},{"name":"apiId","in":"query","type":"string","required":false,"description":"Domain Id of the resource record"},{"name":"operationId","in":"query","type":"string","required":false,"description":"IRIS Service Id"},{"name":"fromDate","in":"query","type":"string","required":false,"description":"Start Date"},{"name":"toDate","in":"query","type":"string","required":false,"description":"End Date"}],"requestBodyExample":null,"responses":{"200":"getUsageStatisticsResponse","default":"getUsageStatisticsErrorResponse"}}]},{"key":"postVendorACHPayment__order-clearing-service-v1.0.0","title":"Clearing Orders","version":"v1.0.0","description":"API to manage clearing order requests. Clearing order requests are created as part of cheque exchanges between banks and central clearing houses. The process begins when a drawee deposits a cheque for clearing in the drawer bank, the banks will pass it on to the clearing house which verifies the che","endpointCount":1,"endpoints":[{"method":"POST","path":"/order/clearingEntries","fullPath":"/api/v1.0.0/order/clearingEntries","operationId":"createORValidateFR","name":"Creates or validates clearing order request of type COVER or RESERVE or BOOK with details such as payee or drawee account number, currency, amount, clearing type - debit or credit, date of clearing and other payment references. COVER requests can be initiated to verify the validity of account and availability of funds in case of debit clearing. RESERVE requests can be initiated to hold the funds in the payee account before the cheques are cleared for collections. BOOK requests can be initiated t","summary":"","tags":[],"parameters":[{"name":"companyId","in":"header","type":"string","required":false,"description":"The identifier of the underlying entity/company/branch."},{"name":"channelName","in":"header","type":"string","required":false,"description":"Name of the (digital) channel registered by the Customer used for the clearing request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"payload","in":"body","type":"object","required":true,"description":"Contains the fields and its values to be input for the clearing request in the specific order"}],"requestBodyExample":{"header":{},"body":{"operation":"string","target":"string","payload":"string"}},"responses":{"200":"createORValidateFRResponse"}}]}]},{"name":"postChargeNFT","serviceCount":4,"endpointCount":7,"services":[{"key":"postChargeNFT__api-v1.0.0","title":"postChargesNonFinancialTrans","version":"v1.0.0","description":"postChargesNonFinancialTrans","endpointCount":1,"endpoints":[{"method":"POST","path":"/party/acchargerequest","fullPath":"/api/v1.0.0/party/acchargerequest","operationId":"postChargesNonFinancialTrans","name":"","summary":"","tags":["OTHERS"],"parameters":[{"name":"payload","in":"body","type":"object","required":true,"description":"body Payload"},{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"debitAccount":"A/c which the charge is to be raised against.","customerNo":"Customer to whom the charge is to be requested","chargeDate":"Enter the date of the charge","chargeCurrency":"Enter charge currency","chargeCode":"Enter charge code","chargeAmount":"Enter charge amount","chargeStatus":"Enter charge status","sendNotice":"Send Notice Dets","extraDetails":"Extra Details","Override":"string","recordStatus":"string","currNo":"string","inputterId":"string","inputDate_Time":"string","authoriserId":"string"}},"responses":{"200":"ChargesNonFinancialTransResponse","default":"ScreenErrorResponse","400":"BusinessScreenErrorResponse","500":"SystemScreenErrorResponse"}}]},{"key":"postChargeNFT__meta-apis-service-v1.0.0","title":"Meta - APIs about APIs","version":"v1.0.0","description":"Retrieves information about the API ecosystem, both reference information and runtime metrics","endpointCount":4,"endpoints":[{"method":"GET","path":"/meta/apidocs","fullPath":"/api/v1.0.0/meta/apidocs","operationId":"getApiDocs","name":"","summary":"","tags":[],"parameters":[],"requestBodyExample":null,"responses":{"200":"getApiDocsResponse","default":"getApiDocsErrorResponse"}},{"method":"GET","path":"/meta/apis","fullPath":"/api/v1.0.0/meta/apis","operationId":"getApis","name":"","summary":"","tags":[],"parameters":[],"requestBodyExample":null,"responses":{"200":"getApisResponse","default":"getApisResponse"}},{"method":"GET","path":"/meta/internal/apis","fullPath":"/api/v1.0.0/meta/internal/apis","operationId":"getInternalApis","name":"","summary":"","tags":[],"parameters":[],"requestBodyExample":null,"responses":{"200":"getInternalApisResponse","default":"getInternalApisResponse"}},{"method":"GET","path":"/meta/apis/operationIds","fullPath":"/api/v1.0.0/meta/apis/operationIds","operationId":"getApis","name":"","summary":"","tags":[],"parameters":[],"requestBodyExample":null,"responses":{"200":"getApisResponse","default":"getApisResponse"}}]},{"key":"postChargeNFT__meta-statistics-v1.0.0","title":"Statistics Provider APIs","version":"v1.0.0","description":"","endpointCount":1,"endpoints":[{"method":"GET","path":"/meta/statistics","fullPath":"/v1.0.0/meta/statistics","operationId":"getUsageStatistics","name":"","summary":"","tags":[],"parameters":[{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Random and unique string for each page. Used for security purpose"},{"name":"apiId","in":"query","type":"string","required":false,"description":"Domain Id of the resource record"},{"name":"operationId","in":"query","type":"string","required":false,"description":"IRIS Service Id"},{"name":"fromDate","in":"query","type":"string","required":false,"description":"Start Date"},{"name":"toDate","in":"query","type":"string","required":false,"description":"End Date"}],"requestBodyExample":null,"responses":{"200":"getUsageStatisticsResponse","default":"getUsageStatisticsErrorResponse"}}]},{"key":"postChargeNFT__order-clearing-service-v1.0.0","title":"Clearing Orders","version":"v1.0.0","description":"API to manage clearing order requests. Clearing order requests are created as part of cheque exchanges between banks and central clearing houses. The process begins when a drawee deposits a cheque for clearing in the drawer bank, the banks will pass it on to the clearing house which verifies the che","endpointCount":1,"endpoints":[{"method":"POST","path":"/order/clearingEntries","fullPath":"/api/v1.0.0/order/clearingEntries","operationId":"createORValidateFR","name":"Creates or validates clearing order request of type COVER or RESERVE or BOOK with details such as payee or drawee account number, currency, amount, clearing type - debit or credit, date of clearing and other payment references. COVER requests can be initiated to verify the validity of account and availability of funds in case of debit clearing. RESERVE requests can be initiated to hold the funds in the payee account before the cheques are cleared for collections. BOOK requests can be initiated t","summary":"","tags":[],"parameters":[{"name":"companyId","in":"header","type":"string","required":false,"description":"The identifier of the underlying entity/company/branch."},{"name":"channelName","in":"header","type":"string","required":false,"description":"Name of the (digital) channel registered by the Customer used for the clearing request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"payload","in":"body","type":"object","required":true,"description":"Contains the fields and its values to be input for the clearing request in the specific order"}],"requestBodyExample":{"header":{},"body":{"operation":"string","target":"string","payload":"string"}},"responses":{"200":"createORValidateFRResponse"}}]}]},{"name":"createNewLoanReq","serviceCount":4,"endpointCount":7,"services":[{"key":"createNewLoanReq__createNewLoanRecAPI-v1.0.0","title":"createNewLoanRec","version":"v1.0.0","description":"createNewLoanRec","endpointCount":1,"endpoints":[{"method":"POST","path":"/party/products/createNewLoanReq","fullPath":"/api/v1.0.0/party/products/createNewLoanReq","operationId":"OHB Mortgage Loan","name":"createNewLoanRec","summary":"createNewLoanRec","tags":["OTHERS"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"parties":[{}],"activityId":"string","effectiveDate":"string","productId":"string","currencyId":"string","simulationId":"string","extensions":{},"limit":[{}],"settlement":[{}],"commitment":[{}]}},"responses":{"200":"OHB Mortgage LoanResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}}]},{"key":"createNewLoanReq__meta-apis-service-v1.0.0","title":"Meta - APIs about APIs","version":"v1.0.0","description":"Retrieves information about the API ecosystem, both reference information and runtime metrics","endpointCount":4,"endpoints":[{"method":"GET","path":"/meta/apidocs","fullPath":"/api/v1.0.0/meta/apidocs","operationId":"getApiDocs","name":"","summary":"","tags":[],"parameters":[],"requestBodyExample":null,"responses":{"200":"getApiDocsResponse","default":"getApiDocsErrorResponse"}},{"method":"GET","path":"/meta/apis","fullPath":"/api/v1.0.0/meta/apis","operationId":"getApis","name":"","summary":"","tags":[],"parameters":[],"requestBodyExample":null,"responses":{"200":"getApisResponse","default":"getApisResponse"}},{"method":"GET","path":"/meta/internal/apis","fullPath":"/api/v1.0.0/meta/internal/apis","operationId":"getInternalApis","name":"","summary":"","tags":[],"parameters":[],"requestBodyExample":null,"responses":{"200":"getInternalApisResponse","default":"getInternalApisResponse"}},{"method":"GET","path":"/meta/apis/operationIds","fullPath":"/api/v1.0.0/meta/apis/operationIds","operationId":"getApis","name":"","summary":"","tags":[],"parameters":[],"requestBodyExample":null,"responses":{"200":"getApisResponse","default":"getApisResponse"}}]},{"key":"createNewLoanReq__meta-statistics-v1.0.0","title":"Statistics Provider APIs","version":"v1.0.0","description":"","endpointCount":1,"endpoints":[{"method":"GET","path":"/meta/statistics","fullPath":"/v1.0.0/meta/statistics","operationId":"getUsageStatistics","name":"","summary":"","tags":[],"parameters":[{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Random and unique string for each page. Used for security purpose"},{"name":"apiId","in":"query","type":"string","required":false,"description":"Domain Id of the resource record"},{"name":"operationId","in":"query","type":"string","required":false,"description":"IRIS Service Id"},{"name":"fromDate","in":"query","type":"string","required":false,"description":"Start Date"},{"name":"toDate","in":"query","type":"string","required":false,"description":"End Date"}],"requestBodyExample":null,"responses":{"200":"getUsageStatisticsResponse","default":"getUsageStatisticsErrorResponse"}}]},{"key":"createNewLoanReq__order-clearing-service-v1.0.0","title":"Clearing Orders","version":"v1.0.0","description":"API to manage clearing order requests. Clearing order requests are created as part of cheque exchanges between banks and central clearing houses. The process begins when a drawee deposits a cheque for clearing in the drawer bank, the banks will pass it on to the clearing house which verifies the che","endpointCount":1,"endpoints":[{"method":"POST","path":"/order/clearingEntries","fullPath":"/api/v1.0.0/order/clearingEntries","operationId":"createORValidateFR","name":"Creates or validates clearing order request of type COVER or RESERVE or BOOK with details such as payee or drawee account number, currency, amount, clearing type - debit or credit, date of clearing and other payment references. COVER requests can be initiated to verify the validity of account and availability of funds in case of debit clearing. RESERVE requests can be initiated to hold the funds in the payee account before the cheques are cleared for collections. BOOK requests can be initiated t","summary":"","tags":[],"parameters":[{"name":"companyId","in":"header","type":"string","required":false,"description":"The identifier of the underlying entity/company/branch."},{"name":"channelName","in":"header","type":"string","required":false,"description":"Name of the (digital) channel registered by the Customer used for the clearing request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"payload","in":"body","type":"object","required":true,"description":"Contains the fields and its values to be input for the clearing request in the specific order"}],"requestBodyExample":{"header":{},"body":{"operation":"string","target":"string","payload":"string"}},"responses":{"200":"createORValidateFRResponse"}}]}]},{"name":"createNewLoan","serviceCount":4,"endpointCount":7,"services":[{"key":"createNewLoan__api-v1.0.0","title":"OHB Mortgage Loan","version":"v1.0.0","description":"OHB Mortgage Loan","endpointCount":1,"endpoints":[{"method":"POST","path":"/product/products/loan","fullPath":"/api/v1.0.0/product/products/loan","operationId":"OHB Mortgage Loan","name":"OHB Mortgage Loan","summary":"","tags":["OTHERS"],"parameters":[{"name":"validate_only","in":"query","type":"boolean","required":false,"description":"The identifier to indicate if it is set to only validate or not."},{"name":"payload","in":"body","type":"object","required":true,"description":""},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"companyId","in":"header","type":"string","required":false,"description":"Identifier of the lead company of the underlying Entity/Company/Branch for the respective contract for customer data protection purposes. Example US0010001."},{"name":"deviceId","in":"header","type":"string","required":false,"description":"Identifies the device type"},{"name":"userRole","in":"header","type":"string","required":false,"description":"User who initiated the transaction"}],"requestBodyExample":{"header":{"audit":{"versionNumber":{}}},"body":{"parties":[{}],"activityId":"string","effectiveDate":"string","productId":"string","currencyId":"string","simulationId":"string","extensions":{},"limit":[{}],"settlement":[{}],"commitment":[{}]}},"responses":{"200":"OHB Mortgage LoanResponse","default":"ArrangementErrorResponse","400":"BusinessArrangementErrorResponse","500":"SystemArrangementErrorResponse"}}]},{"key":"createNewLoan__meta-apis-service-v1.0.0","title":"Meta - APIs about APIs","version":"v1.0.0","description":"Retrieves information about the API ecosystem, both reference information and runtime metrics","endpointCount":4,"endpoints":[{"method":"GET","path":"/meta/apidocs","fullPath":"/api/v1.0.0/meta/apidocs","operationId":"getApiDocs","name":"","summary":"","tags":[],"parameters":[],"requestBodyExample":null,"responses":{"200":"getApiDocsResponse","default":"getApiDocsErrorResponse"}},{"method":"GET","path":"/meta/apis","fullPath":"/api/v1.0.0/meta/apis","operationId":"getApis","name":"","summary":"","tags":[],"parameters":[],"requestBodyExample":null,"responses":{"200":"getApisResponse","default":"getApisResponse"}},{"method":"GET","path":"/meta/internal/apis","fullPath":"/api/v1.0.0/meta/internal/apis","operationId":"getInternalApis","name":"","summary":"","tags":[],"parameters":[],"requestBodyExample":null,"responses":{"200":"getInternalApisResponse","default":"getInternalApisResponse"}},{"method":"GET","path":"/meta/apis/operationIds","fullPath":"/api/v1.0.0/meta/apis/operationIds","operationId":"getApis","name":"","summary":"","tags":[],"parameters":[],"requestBodyExample":null,"responses":{"200":"getApisResponse","default":"getApisResponse"}}]},{"key":"createNewLoan__meta-statistics-v1.0.0","title":"Statistics Provider APIs","version":"v1.0.0","description":"","endpointCount":1,"endpoints":[{"method":"GET","path":"/meta/statistics","fullPath":"/v1.0.0/meta/statistics","operationId":"getUsageStatistics","name":"","summary":"","tags":[],"parameters":[{"name":"page_size","in":"query","type":"integer","required":false,"description":"The total number of records per page"},{"name":"page_start","in":"query","type":"integer","required":false,"description":"The record from which the response should be displayed"},{"name":"page_token","in":"query","type":"string","required":false,"description":"Random and unique string for each page. Used for security purpose"},{"name":"apiId","in":"query","type":"string","required":false,"description":"Domain Id of the resource record"},{"name":"operationId","in":"query","type":"string","required":false,"description":"IRIS Service Id"},{"name":"fromDate","in":"query","type":"string","required":false,"description":"Start Date"},{"name":"toDate","in":"query","type":"string","required":false,"description":"End Date"}],"requestBodyExample":null,"responses":{"200":"getUsageStatisticsResponse","default":"getUsageStatisticsErrorResponse"}}]},{"key":"createNewLoan__order-clearing-service-v1.0.0","title":"Clearing Orders","version":"v1.0.0","description":"API to manage clearing order requests. Clearing order requests are created as part of cheque exchanges between banks and central clearing houses. The process begins when a drawee deposits a cheque for clearing in the drawer bank, the banks will pass it on to the clearing house which verifies the che","endpointCount":1,"endpoints":[{"method":"POST","path":"/order/clearingEntries","fullPath":"/api/v1.0.0/order/clearingEntries","operationId":"createORValidateFR","name":"Creates or validates clearing order request of type COVER or RESERVE or BOOK with details such as payee or drawee account number, currency, amount, clearing type - debit or credit, date of clearing and other payment references. COVER requests can be initiated to verify the validity of account and availability of funds in case of debit clearing. RESERVE requests can be initiated to hold the funds in the payee account before the cheques are cleared for collections. BOOK requests can be initiated t","summary":"","tags":[],"parameters":[{"name":"companyId","in":"header","type":"string","required":false,"description":"The identifier of the underlying entity/company/branch."},{"name":"channelName","in":"header","type":"string","required":false,"description":"Name of the (digital) channel registered by the Customer used for the clearing request"},{"name":"credentials","in":"header","type":"string","required":false,"description":"Username and password to authenticate the API against core-banking."},{"name":"payload","in":"body","type":"object","required":true,"description":"Contains the fields and its values to be input for the clearing request in the specific order"}],"requestBodyExample":{"header":{},"body":{"operation":"string","target":"string","payload":"string"}},"responses":{"200":"createORValidateFRResponse"}}]}]}]}